feat: macOS auto start (#1604)

* feat: macOS auto start

* refactor: reword cmake auto start option name

* fix: typo

Author: aurelleb

CMakeLists.txt

@@ -53,6 +53,7 @@ option(ENABLE_SANITIZERS "Enable ASan + UBSan for debug builds" OFF)
 option(ENABLE_CLANG_TIDY "Run clang-tidy during compilation" OFF)
 option(INSTALL_MODULES_LOAD_CONFIG "Install config files to auto load required kernel modules" ON)
 option(AUTO_INSTALL_BROWSER_MANIFESTS "Install per-user browser native messaging host manifests at server startup" ON)
+option(AUTO_ENABLE_AUTOSTART "Register the app to start at login on first launch (currently macOS only)" ON)
 
 set(VICINAE_BUNDLE_ID "com.vicinaehq.Vicinae" CACHE STRING "macOS app bundle identifier")
 

nix/vicinae.nix

@@ -75,6 +75,7 @@ in
       "CMAKE_INSTALL_BINDIR" = "bin";
       "CMAKE_INSTALL_LIBDIR" = "lib";
       "AUTO_INSTALL_BROWSER_MANIFESTS" = "OFF";
+      "AUTO_ENABLE_AUTOSTART" = "OFF";
     };
 
     strictDeps = true;

src/server/CMakeLists.txt

@@ -664,6 +664,17 @@ if (APPLE)
 		src/services/snippet/macos-snippet-server.mm
 		src/services/update/macos-update-installer.mm
 		PROPERTIES COMPILE_OPTIONS "-fobjc-arc")
+
+	if (AUTO_ENABLE_AUTOSTART)
+		add_compile_definitions(AUTO_ENABLE_AUTOSTART)
+		list(APPEND SRCS
+			src/services/autostart/macos-login-item.hpp
+			src/services/autostart/macos-login-item.mm
+		)
+		set_source_files_properties(src/services/autostart/macos-login-item.mm
+			PROPERTIES COMPILE_OPTIONS "-fobjc-arc")
+		list(APPEND LIBS "-framework ServiceManagement")
+	endif()
 else()
 	list(APPEND SRCS
 		src/services/app-runtime/linux/linux-app-runtime.hpp

src/server/src/server.cpp

@@ -99,6 +99,10 @@
 #include <QFileOpenEvent>
 #endif
 
+#ifdef AUTO_ENABLE_AUTOSTART
+#include "services/autostart/macos-login-item.hpp"
+#endif
+
 #ifdef Q_OS_MACOS
 class UrlSchemeOpenFilter : public QObject {
 public:
@@ -199,6 +203,10 @@ int startServer(const ServerLaunchOptions &launchOpts) {
 
   Omnicast::ensureDirectories();
 
+#ifdef AUTO_ENABLE_AUTOSTART
+  vicinae::macos::registerLoginItemOnce();
+#endif
+
   {
     auto registry = ServiceRegistry::instance();
 

src/server/src/services/autostart/macos-login-item.hpp

@@ -0,0 +1,7 @@
+#pragma once
+
+namespace vicinae::macos {
+
+void registerLoginItemOnce();
+
+}

src/server/src/services/autostart/macos-login-item.mm

@@ -0,0 +1,32 @@
+#include "macos-login-item.hpp"
+#include "vicinae.hpp"
+#include <filesystem>
+#include <fstream>
+#include <qlogging.h>
+#import <Foundation/Foundation.h>
+#import <ServiceManagement/ServiceManagement.h>
+
+namespace vicinae::macos {
+
+// we only set it once, otherwise we would end up overriding the user preference
+// every single time
+void registerLoginItemOnce() {
+  if (!NSBundle.mainBundle.bundleIdentifier) return;
+
+  const auto marker = Omnicast::stateDir() / "login-item-registered";
+  if (std::filesystem::exists(marker)) return;
+
+  SMAppService *service = SMAppService.mainAppService;
+
+  if (service.status != SMAppServiceStatusEnabled) {
+    NSError *error = nil;
+    if (![service registerAndReturnError:&error]) {
+      qWarning() << "Failed to register login item:" << error.localizedDescription.UTF8String;
+      return;
+    }
+  }
+
+  std::ofstream{marker};
+}
+
+} // namespace vicinae::macos