Show login window when Linux tray has no visible icon

README.md

@@ -186,6 +186,8 @@ or run it with `--appimage-extract-and-run`.
 
 ## Open the app
 
+**Optional: open at login.** In the installed desktop app, choose **Frame → Open at Login**. It is off by default. When on, a login launch starts in the tray or menu bar if that control is available; click its icon to open the window, or use its **Quit Frame Control** menu item. Closing the window keeps the app in the tray while this option is on. Turn the same menu option off to remove its OS login item. On Linux this creates or removes only Frame Control's own file in `~/.config/autostart/` (or `$XDG_CONFIG_HOME/autostart/`). If the desktop has no working tray, the window opens at login instead. A source checkout does not offer this setting.
+
 - **macOS:** open the `.dmg`, drag **Frame Control** to **Applications**, then
   open it from Applications. For the unsigned-app warning, use the macOS steps
   above. Allow local network access and control of Terminal when prompted.

app/login-item.js

@@ -0,0 +1,53 @@
+// Opt-in OS login item. Linux owns only its marked autostart file; an existing
+// custom entry is never overwritten or removed.
+const fs = require("node:fs");
+const os = require("node:os");
+const path = require("node:path");
+
+const MARKER = "# Managed by Frame Control; use Frame > Open at Login to remove.\n";
+const FILE = "com.saphid.frame-control.desktop";
+
+function quoteExec(value) {
+  return `"${value.replace(/\\/g, "\\\\").replace(/"/g, '\\"').replace(/\$/g, "\\$").replace(/`/g, "\\`").replace(/%/g, "%%")}"`;
+}
+
+function createLoginItem({ platform = process.platform, electronApp, env = process.env,
+                           executable = process.execPath, filesystem = fs,
+                           home = os.homedir() }) {
+  const config = env.XDG_CONFIG_HOME && path.isAbsolute(env.XDG_CONFIG_HOME)
+    ? env.XDG_CONFIG_HOME : path.join(home, ".config");
+  const file = path.join(config, "autostart", FILE);
+  const command = platform === "linux" && env.APPIMAGE && path.isAbsolute(env.APPIMAGE)
+    ? env.APPIMAGE : executable;
+  function owned() {
+    try { return filesystem.readFileSync(file, "utf8").startsWith(MARKER); }
+    catch (err) { if (err.code === "ENOENT") return false; throw err; }
+  }
+  function enabled() {
+    if (platform === "linux") return owned();
+    return !!electronApp.getLoginItemSettings().openAtLogin;
+  }
+  function set(enabledNow) {
+    if (platform !== "linux") {
+      electronApp.setLoginItemSettings({ openAtLogin: !!enabledNow, openAsHidden: !!enabledNow,
+                                        args: enabledNow ? ["--hidden"] : [] });
+      if (enabled() !== !!enabledNow) throw new Error("The operating system did not save the login item.");
+      return enabled();
+    }
+    if (enabledNow) {
+      if (filesystem.existsSync(file) && !owned()) throw new Error(`A different autostart entry already exists: ${file}`);
+      filesystem.mkdirSync(path.dirname(file), { recursive: true });
+      const body = MARKER + "[Desktop Entry]\nType=Application\nName=Frame Control\n" +
+        `Exec=${quoteExec(command)} --hidden\nTerminal=false\nX-GNOME-Autostart-enabled=true\n`;
+      const tmp = file + `.tmp-${process.pid}`;
+      try { filesystem.writeFileSync(tmp, body, { mode: 0o600 }); filesystem.renameSync(tmp, file); }
+      finally { try { filesystem.unlinkSync(tmp); } catch (err) { if (err.code !== "ENOENT") throw err; } }
+    } else if (owned()) {
+      filesystem.unlinkSync(file);
+    }
+    return enabled();
+  }
+  return { enabled, set, file };
+}
+
+module.exports = { createLoginItem, quoteExec };

app/main.js

@@ -1,7 +1,7 @@
 // Frame Control as a desktop app (macOS, Windows, Linux): starts ui/server.py on
 // a free loopback port and shows it in a native window. The server does all the
 // work over the `frame` SSH alias; this file only hosts it.
-const { app, BrowserWindow, Menu, Notification, clipboard, dialog, ipcMain, nativeImage, session, shell } = require("electron");
+const { app, BrowserWindow, Menu, Notification, Tray, clipboard, dialog, ipcMain, nativeImage, session, shell } = require("electron");
 const { execFile, spawn } = require("child_process");
 const { promisify } = require("util");
 const fs = require("fs");
@@ -12,6 +12,7 @@ const path = require("path");
 const { SCHEME, parseInstallLink, linkFromArgv } = require("./install-link");
 const updater = require("./updater");
 const { preferenceStore } = require("./preferences");
+const { createLoginItem } = require("./login-item");
 const { createMetaSignIn } = require("./meta-signin");
 
 const run = promisify(execFile);
@@ -30,10 +31,12 @@ const LOG = path.join(LOG_DIR, "server.log");
 const BG = "#0d1117";
 const FRAME = process.env.FRAME_ALIAS || "frame";
 const preferences = preferenceStore(path.join(app.getPath("userData"), "client-preferences.json"));
+const loginItem = createLoginItem({ electronApp: app });
 
 let server = null;
 let url = null;
 let win = null;
+let tray = null;
 let quitting = false;
 let python = null;
 
@@ -573,7 +576,60 @@ function registerScheme() {
   }
 }
 
-function createWindow() {
+function showWindow() {
+  if (!win) return createWindow(true);
+  if (win.isMinimized()) win.restore();
+  win.show();
+  win.focus();
+}
+
+function ensureTray() {
+  if (tray) return true;
+  try {
+    const icon = nativeImage.createFromPath(path.join(__dirname, "build", "icon.png"));
+    if (icon.isEmpty()) return false;
+    tray = new Tray(icon);
+    // Some Linux desktops accept the Tray object but expose no status icon.
+    // Keep a visible login window rather than hiding the only way back in.
+    if (process.platform === "linux") {
+      const bounds = tray.getBounds();
+      if (!bounds.width || !bounds.height) { tray.destroy(); tray = null; return false; }
+    }
+    tray.setToolTip("Frame Control");
+    tray.on("click", showWindow);
+    updateTrayMenu();
+    return true;
+  } catch {
+    if (tray) { try { tray.destroy(); } catch {} tray = null; }
+    return false;
+  }
+}
+
+function updateTrayMenu() {
+  if (!tray) return;
+  tray.setContextMenu(Menu.buildFromTemplate([
+    { label: "Open Frame Control", click: showWindow },
+    { label: "Open at Login", type: "checkbox", checked: loginItem.enabled(), click: toggleLoginItem },
+    { type: "separator" },
+    { label: "Quit Frame Control", click: () => app.quit() },
+  ]));
+}
+
+function toggleLoginItem() {
+  try {
+    const on = loginItem.set(!loginItem.enabled());
+    if (on) ensureTray();
+    else if (tray) { tray.destroy(); tray = null; }
+    buildMenu();
+    updateTrayMenu();
+  } catch (err) {
+    dialog.showErrorBox("Open at Login", String(err.message || err));
+    buildMenu();
+    updateTrayMenu();
+  }
+}
+
+function createWindow(showOnReady = !process.argv.includes("--hidden") || !tray) {
   win = new BrowserWindow({
     width: 1400, height: 950, minWidth: 760, minHeight: 560,
     title: "Frame Control", backgroundColor: BG, show: false,
@@ -582,7 +638,10 @@ function createWindow() {
     webPreferences: { contextIsolation: true, nodeIntegration: false, sandbox: true, backgroundThrottling: false,
                       preload: path.join(__dirname, "preload.js") },
   });
-  win.once("ready-to-show", () => win.show());
+  win.once("ready-to-show", () => { if (showOnReady) win.show(); });
+  win.on("close", (event) => {
+    if (!quitting && tray && loginItem.enabled()) { event.preventDefault(); win.hide(); }
+  });
   if (CHROME_CSS) win.webContents.on("did-finish-load", () => win.webContents.insertCSS(CHROME_CSS));
   // External links open in the default browser; the app never navigates away.
   win.webContents.setWindowOpenHandler(({ url: target }) => {
@@ -636,6 +695,8 @@ function buildMenu() {
       label: "Frame",
       submenu: [
         { label: "Set Up Connection…", click: () => setUpConnection() },
+        { label: "Open at Login", type: "checkbox", checked: loginItem.enabled(),
+          enabled: app.isPackaged, click: toggleLoginItem },
         { label: IS_MAC ? "Open SSH in Terminal" : "Open SSH in a Terminal", click: openSsh },
         { type: "separator" },
         ...(devices.length > 1 ? [{
@@ -684,7 +745,7 @@ if (!app.requestSingleInstanceLock()) {
   app.on("open-url", (e, link) => { e.preventDefault(); openInstallLink(link); });
   // Windows and Linux start a second instance with the link as an argument.
   app.on("second-instance", (_e, argv) => {
-    if (win) { if (win.isMinimized()) win.restore(); win.focus(); }
+    if (!argv.includes("--hidden")) showWindow();
     const link = linkFromArgv(argv);
     if (link) openInstallLink(link);
   });
@@ -692,11 +753,12 @@ if (!app.requestSingleInstanceLock()) {
   if (firstLink) openInstallLink(firstLink);
   app.whenReady().then(() => {
     registerScheme();
+    if (loginItem.enabled()) ensureTray();
     buildMenu();
     createWindow();
     scheduleUpdateChecks();
   });
-  app.on("activate", () => { if (!win) createWindow(); });
+  app.on("activate", showWindow);
   app.on("window-all-closed", () => app.quit());
   let obsQuitWaiting = false;
   let obsQuitReady = false;

app/package.json

@@ -40,6 +40,7 @@
       "install-link.js",
       "updater.js",
       "preferences.js",
+      "login-item.js",
       "meta-signin.js",
       "package.json",
       "build/icon.png"

app/test/login-item.test.js

@@ -0,0 +1,57 @@
+const { test } = require("node:test");
+const assert = require("node:assert/strict");
+const fs = require("node:fs");
+const os = require("node:os");
+const path = require("node:path");
+const { createLoginItem } = require("../login-item");
+
+test("Linux login toggle creates and removes only its own desktop entry", () => {
+  const root = fs.mkdtempSync(path.join(os.tmpdir(), "frame-login-test-"));
+  try {
+    const login = createLoginItem({ platform: "linux", env: { XDG_CONFIG_HOME: root },
+                                    executable: "/opt/Frame Control/frame-control" });
+    assert.equal(login.enabled(), false);
+    assert.equal(login.set(true), true);
+    const body = fs.readFileSync(login.file, "utf8");
+    assert.match(body, /^# Managed by Frame Control;/);
+    assert.match(body, /Exec="\/opt\/Frame Control\/frame-control" --hidden/);
+    assert.equal(fs.statSync(login.file).mode & 0o777, 0o600);
+    assert.equal(login.set(false), false);
+    assert.equal(fs.existsSync(login.file), false);
+    fs.mkdirSync(path.dirname(login.file), { recursive: true });
+    fs.writeFileSync(login.file, "[Desktop Entry]\nName=My custom launcher\n");
+    assert.throws(() => login.set(true), /different autostart entry/);
+    assert.equal(login.set(false), false);
+    assert.match(fs.readFileSync(login.file, "utf8"), /My custom launcher/);
+  } finally { fs.rmSync(root, { recursive: true, force: true }); }
+});
+
+test("AppImage autostart launches the AppImage, with safe desktop escaping", () => {
+  const root = fs.mkdtempSync(path.join(os.tmpdir(), "frame-appimage-test-"));
+  try {
+    const login = createLoginItem({ platform: "linux", env: { XDG_CONFIG_HOME: root,
+                                    APPIMAGE: '/home/user/Frame Control 100%.AppImage' },
+                                    executable: "/tmp/.mount_extracted/AppRun" });
+    login.set(true);
+    assert.match(fs.readFileSync(login.file, "utf8"), /Exec="\/home\/user\/Frame Control 100%%\.AppImage" --hidden/);
+    login.set(false);
+  } finally { fs.rmSync(root, { recursive: true, force: true }); }
+});
+
+for (const platform of ["win32", "darwin"]) {
+  test(`${platform} login toggle uses the OS API and starts hidden`, () => {
+    let openAtLogin = false;
+    const calls = [];
+    const electronApp = {
+      getLoginItemSettings: () => ({ openAtLogin }),
+      setLoginItemSettings: opts => { calls.push(opts); openAtLogin = opts.openAtLogin; },
+    };
+    const login = createLoginItem({ platform, electronApp });
+    assert.equal(login.enabled(), false);
+    assert.equal(login.set(true), true);
+    assert.deepEqual(calls.at(-1).args, ["--hidden"]);
+    assert.equal(calls.at(-1).openAsHidden, true);
+    assert.equal(login.set(false), false);
+    assert.deepEqual(calls.at(-1).args, []);
+  });
+}