Support Flatpak < 1.15.6 for permissions (#992)

Author: sonnyp

src/Extensions/Extensions.js

@@ -6,7 +6,8 @@ import Interface from "./Extensions.blp" with { type: "uri" };
 import illustration from "./extensions.svg";
 
 import "./Extension.js";
-import { getFlatpakInfo, settings } from "../util.js";
+import { settings } from "../util.js";
+import { getFlatpakInfo } from "../flatpak.js";
 
 export const action_extensions = new Gio.SimpleAction({
   name: "extensions",

src/Permissions/Permissions.blp

@@ -42,7 +42,7 @@ Adw.Dialog dialog {
           }
 
           Label {
-            label: _("Workbench needs additional permissions. Please run the following command in a terminal and restart the app.");
+            label: _("Workbench needs additional permissions. Please run the following command in a terminal and restart Workbench.");
             wrap: true;
             justify: center;
           }
@@ -133,13 +133,13 @@ Adw.Dialog dialog {
                 ]
               }
 
-              Adw.ActionRow {
+              Adw.ActionRow action_row_device {
                 [prefix]
                 Image {
                   icon-name: "re.sonny.Workbench-gamepad-symbolic";
                 }
 
-                title: _("--device=input");
+                // title: _("--device=input");
                 subtitle: _("Access to input device such as gamepads");
 
                 styles [

src/Permissions/Permissions.js

@@ -1,5 +1,4 @@
 import Gio from "gi://Gio";
-import GLib from "gi://GLib";
 import Gtk from "gi://Gtk";
 
 import { build } from "../../troll/src/main.js";
@@ -8,21 +7,31 @@ import Interface from "./Permissions.blp" with { type: "uri" };
 
 import illustration from "./permissions.svg";
 
-import { getFlatpakInfo } from "../util.js";
+import {
+  getFlatpakId,
+  getFlatpakInfo,
+  isDeviceInputOverrideAvailable,
+} from "../flatpak.js";
 
 const action_permissions = new Gio.SimpleAction({
   name: "permissions",
   parameter_type: null,
 });
 
 export function Permissions({ window }) {
-  const { dialog, picture_illustration, label_command, button_info } =
-    build(Interface);
+  const {
+    dialog,
+    picture_illustration,
+    label_command,
+    button_info,
+    action_row_device,
+  } = build(Interface);
 
   picture_illustration.set_resource(illustration);
-  label_command.label = `flatpak override --user --share=network --socket=pulseaudio --device=input ${GLib.getenv(
-    "FLATPAK_ID",
-  )}`;
+
+  const device = isDeviceInputOverrideAvailable() ? "input" : "all";
+  label_command.label = `flatpak override --user --share=network --socket=pulseaudio --device=${device} ${getFlatpakId()}`;
+  action_row_device.title = `--input=${device}`;
 
   button_info.connect("clicked", () => {
     new Gtk.UriLauncher({

src/about.js

@@ -8,7 +8,7 @@ import {
   getGjsVersion,
   getGLibVersion,
 } from "../troll/src/util.js";
-import { getFlatpakInfo } from "./util.js";
+import { getFlatpakInfo } from "./flatpak.js";
 
 export default function About({ application }) {
   const flatpak_info = getFlatpakInfo();

src/flatpak.js

@@ -0,0 +1,36 @@
+import GLib from "gi://GLib";
+
+let flatpak_info;
+export function getFlatpakInfo() {
+  if (flatpak_info) return flatpak_info;
+  flatpak_info = new GLib.KeyFile();
+  try {
+    flatpak_info.load_from_file("/.flatpak-info", GLib.KeyFileFlags.NONE);
+  } catch (err) {
+    if (!err.matches(GLib.FileError, GLib.FileError.NOENT)) {
+      console.error(err);
+    }
+    return null;
+  }
+  return flatpak_info;
+}
+
+export function getFlatpakId() {
+  return getFlatpakInfo().get_string("Application", "name");
+}
+
+// https://repology.org/project/flatpak/versions
+export function isDeviceInputOverrideAvailable(flatpak_version) {
+  flatpak_version ??= getFlatpakInfo().get_string(
+    "Instance",
+    "flatpak-version",
+  );
+
+  // https://github.com/flatpak/flatpak/releases/tag/1.15.6
+  return (
+    flatpak_version.localeCompare("1.15.6", undefined, {
+      numeric: true,
+      sensitivity: "base",
+    }) > -1
+  );
+}

src/util.js

@@ -3,6 +3,7 @@ import Gio from "gi://Gio";
 import Xdp from "gi://Xdp";
 import GObject from "gi://GObject";
 import { getLanguage } from "./common.js";
+import { getFlatpakId } from "./flatpak.js";
 
 export const portal = new Xdp.Portal();
 
@@ -25,21 +26,6 @@ export function ensureDir(file) {
   }
 }
 
-let flatpak_info;
-export function getFlatpakInfo() {
-  if (flatpak_info) return flatpak_info;
-  flatpak_info = new GLib.KeyFile();
-  try {
-    flatpak_info.load_from_file("/.flatpak-info", GLib.KeyFileFlags.NONE);
-  } catch (err) {
-    if (!err.matches(GLib.FileError, GLib.FileError.NOENT)) {
-      console.error(err);
-    }
-    return null;
-  }
-  return flatpak_info;
-}
-
 export { getLanguage };
 
 export function listenProperty(object, property, fn, { initial = false } = {}) {
@@ -158,8 +144,8 @@ export function makeDropdownFlat(dropdown) {
 
 export function buildRuntimePath(...args) {
   return GLib.build_filenamev([
-    GLib.getenv("XDG_RUNTIME_DIR"),
-    GLib.getenv("FLATPAK_ID"),
+    GLib.get_user_runtime_dir(),
+    getFlatpakId(),
     ...args,
   ]);
 }

test/isDeviceInputOverrideAvailable.test.js

@@ -0,0 +1,29 @@
+import "../src/init.js";
+
+import tst, { assert } from "../troll/tst/tst.js";
+
+import { isDeviceInputOverrideAvailable } from "../src/flatpak.js";
+
+const test = tst("isDeviceInputOverrideAvailable");
+
+test("returns a boolean", () => {
+  assert.equal(typeof isDeviceInputOverrideAvailable(), "boolean");
+});
+
+test("returns true if Flatpak version is equal to 1.15.6", () => {
+  assert.equal(isDeviceInputOverrideAvailable("1.15.6"), true);
+});
+
+test("returns true if Flatpak version is higher than 1.15.6", () => {
+  assert.equal(isDeviceInputOverrideAvailable("1.15.7"), true);
+  assert.equal(isDeviceInputOverrideAvailable("1.16.5"), true);
+  assert.equal(isDeviceInputOverrideAvailable("2.15.4"), true);
+});
+
+test("returns false if Flatpak version is lower than 1.15.6", () => {
+  assert.equal(isDeviceInputOverrideAvailable("1.15.5"), false);
+  assert.equal(isDeviceInputOverrideAvailable("1.14.7"), false);
+  assert.equal(isDeviceInputOverrideAvailable("0.16.7"), false);
+});
+
+export default test;