build: Allow custom app IDs

From this time onward, development flatpaks of Bottles will
be suffixed with `.Devel`. This allows us to test Bottles completely
separately from stable releases, making it easier to test without
affecting existing configurations.

Related: bottlesdevs#2921

.github/workflows/build_flatpak.yml

@@ -15,5 +15,5 @@ jobs:
     - uses: bilelmoussaoui/flatpak-github-actions/flatpak-builder@v6
       with:
         bundle: bottles.flatpak
-        manifest-path: build-aux/com.usebottles.bottles.json
+        manifest-path: build-aux/com.usebottles.bottles.Devel.json
         cache-key: flatpak-builder-${{ github.sha }}

.github/workflows/update-manifest.yml

@@ -10,7 +10,7 @@ on:
 
 env:
   PR_BRANCH: pr/ci-manifest/${{ github.ref_name }}
-  FEDC_ARGS: --update --require-important-update --commit-only --never-fork "bottles-repository/build-aux/com.usebottles.bottles.json"
+  FEDC_ARGS: --update --require-important-update --commit-only --never-fork "bottles-repository/build-aux/com.usebottles.bottles.Devel.json"
   UPDATE_PYTHON: false
 
 jobs:
@@ -69,7 +69,7 @@ jobs:
         run: |
           git checkout -B ${{ env.PR_BRANCH }}
           git push -f --set-upstream origin ${{ env.PR_BRANCH }}
-          git diff ${{ github.ref_name }} --exit-code build-aux/com.usebottles.bottles.json
+          git diff ${{ github.ref_name }} --exit-code build-aux/com.usebottles.bottles.Devel.json
           updated=$?
           if [ $updated -ne 0 ] || [ "${{ env.UPDATE_PYTHON }}" = true ]; then
             gh pr create --title ":robot:: Update manifest (important)" --body ":wrench: One or more modules marked as 'important' have been updated." --head ${{ env.PR_BRANCH }} --base ${{ github.ref_name }}

CODING_GUIDE.md

@@ -5,19 +5,19 @@
 #### Build & install
 
 ```bash
-flatpak-builder --install --user --force-clean ./.flatpak-builder/out ./build-aux/com.usebottles.bottles.json
+flatpak-builder --install --user --force-clean ./.flatpak-builder/out ./build-aux/com.usebottles.bottles.Devel.json
 ```
 
 #### Run
 
 ```bash
-flatpak run com.usebottles.bottles
+flatpak run com.usebottles.bottles.Devel
 ```
 
 #### Uninstall devel version
 
 ```bash
-flatpak uninstall com.usebottles.bottles//master
+flatpak uninstall com.usebottles.bottles.Devel
 ```
 
 ## Unit Test
@@ -51,9 +51,9 @@ cat > po/POTFILES <<EOF
 EOF
 grep -rlP "_\(['\"]" bottles | sort >> po/POTFILES
 cat >> po/POTFILES <<EOF
-data/com.usebottles.bottles.desktop.in
+data/com.usebottles.bottles.desktop.in.in
 data/com.usebottles.bottles.gschema.xml
-data/com.usebottles.bottles.metainfo.xml.in
+data/com.usebottles.bottles.metainfo.xml.in.in
 EOF
 ```
 

README.md

@@ -54,15 +54,15 @@ There are two methods to build Bottles. The first and longer method is using `or
 
 1. Install [`org.flatpak.Builder`](https://github.com/flathub/org.flatpak.Builder) from Flathub
 1. Clone `https://github.com/bottlesdevs/Bottles.git` (or your fork)
-1. Run `flatpak run org.flatpak.Builder --install --install-deps-from=flathub --default-branch=master --force-clean build-dir build-aux/com.usebottles.bottles.json` in the terminal from the root of the repository (use `--user` if necessary)
-1. Run `flatpak run com.usebottles.bottles//master` to launch it
+1. Run `flatpak run org.flatpak.Builder --install --install-deps-from=flathub --default-branch=master --force-clean build-dir build-aux/com.usebottles.bottles.Devel.json` in the terminal from the root of the repository (use `--user` if necessary)
+1. Run `flatpak run com.usebottles.bottles.Devel` to launch it
 
 ### Meson
 
 Since Bottles is primarily and officially distributed as a Flatpak, we only provide instructions to directly build it inside a Flatpak environment:
 
 1. Download and install the latest build of Bottles: [bottles-x86_64.zip](https://nightly.link/bottlesdevs/Bottles/workflows/build_flatpak/main/bottles-x86_64.zip). Unzip it, and run `flatpak install bottles.flatpak` (use `--user` if necessary)
-2. Run `flatpak run -d --filesystem=$PWD --command=bash com.usebottles.bottles//master` from the root of the repository, followed by `./utils/install.sh`. This will build Bottles and install it under the `build/` directory.
+2. Run `flatpak run -d --filesystem=$PWD --command=bash com.usebottles.bottles.Devel` from the root of the repository, followed by `./utils/install.sh`. This will build Bottles and install it under the `build/` directory.
 3. Run `./build/bin/bottles` to launch Bottles
 
 Due to GNOME Builder limitations, Builder cannot build Bottles for the time being; see [GNOME/gnome-builder#2061](https://gitlab.gnome.org/GNOME/gnome-builder/-/issues/2061) for more context. This is the best workaround we can provide.

bottles/backend/params.py

@@ -1,2 +1,3 @@
 APP_VERSION = "@APP_VERSION@"
-APP_ID = "com.usebottles.bottles"
+BASE_ID = "@BASE_ID@"
+APP_ID = "@APP_ID@"

bottles/frontend/main.py

@@ -81,7 +81,7 @@ class Bottles(Adw.Application):
 
     def __init__(self):
         super().__init__(
-            application_id="com.usebottles.bottles",
+            application_id=APP_ID,
             flags=Gio.ApplicationFlags.HANDLES_COMMAND_LINE,
             register_session=True,
         )

bottles/frontend/params.py

@@ -1,7 +1,8 @@
 # Application details
 APP_NAME = "@APP_NAME@"
 APP_NAME_LOWER = APP_NAME.lower()
-APP_ID = "com.usebottles.bottles"
+BASE_ID = "@BASE_ID@"
+APP_ID = "@APP_ID@"
 APP_VERSION = "@APP_VERSION@"
 APP_ICON = "@APP_ID@"
 PROFILE = "@PROFILE@"

bottles/frontend/ui/list.blp

@@ -39,7 +39,6 @@ template $BottleView: Adw.Bin {
       }
 
       Adw.StatusPage bottle_status {
-        icon-name: "com.usebottles.bottles-symbolic";
         title: _("Bottles");
         hexpand: true;
         vexpand: true;

bottles/frontend/ui/loading.blp

@@ -9,8 +9,7 @@ template $LoadingView: Adw.Bin {
     Box {
       orientation: vertical;
 
-      Adw.StatusPage {
-        icon-name: "com.usebottles.bottles";
+      Adw.StatusPage loading_status_page {
         title: _("Starting up…");
         hexpand: true;
         vexpand: true;

bottles/frontend/ui/window.blp

@@ -3,7 +3,6 @@ using Adw 1;
 
 template $MainWindow: Adw.ApplicationWindow {
   title: "Bottles";
-  icon-name: "com.usebottles.bottles";
   close-request => $on_close_request();
 
   Adw.ToastOverlay toasts {

bottles/frontend/views/list.py

@@ -26,6 +26,7 @@
 from bottles.backend.utils.threading import RunAsync
 from bottles.backend.wine.executor import WineExecutor
 from bottles.frontend.utils.filters import add_executable_filters, add_all_filters
+from bottles.frontend.params import APP_ID
 
 
 @Gtk.Template(resource_path="/com/usebottles/bottles/list-entry.ui")
@@ -182,6 +183,8 @@ def __init__(self, window, arg_bottle=None, **kwargs):
             Signals.ManagerLocalBottlesLoaded, self.backend_local_bottle_loaded
         )
 
+        self.bottle_status.set_icon_name(f"{APP_ID}-symbolic")
+
         self.update_bottles()
 
     def __search_bottles(self, widget, event=None, data=None):

bottles/frontend/views/loading.py

@@ -22,6 +22,7 @@
 from bottles.backend.models.result import Result
 from bottles.backend.state import SignalManager, Signals
 from bottles.frontend.utils.gtk import GtkUtils
+from bottles.frontend.params import APP_ID
 
 
 @Gtk.Template(resource_path="/com/usebottles/bottles/loading.ui")
@@ -33,10 +34,12 @@ class LoadingView(Adw.Bin):
     label_fetched = Gtk.Template.Child()
     label_downloading = Gtk.Template.Child()
     btn_go_offline = Gtk.Template.Child()
+    loading_status_page = Gtk.Template.Child()
     # endregion
 
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
+        self.loading_status_page.set_icon_name(APP_ID)
         self.btn_go_offline.connect("clicked", self.go_offline)
 
     @GtkUtils.run_in_main_loop

bottles/frontend/windows/bottlepicker.py

@@ -21,7 +21,7 @@
 
 from bottles.backend.managers.manager import Manager
 from bottles.backend.models.config import BottleConfig
-from bottles.frontend.params import APP_ID
+from bottles.frontend.params import BASE_ID
 
 
 class BottleEntry(Adw.ActionRow):
@@ -36,7 +36,7 @@ class BottlePickerDialog(Adw.ApplicationWindow):
     """This class should not be called from the application GUI, only from CLI."""
 
     __gtype_name__ = "BottlePickerDialog"
-    settings = Gio.Settings.new(APP_ID)
+    settings = Gio.Settings.new(BASE_ID)
     Adw.init()
 
     # region Widgets

bottles/frontend/windows/main_window.py

@@ -69,7 +69,7 @@ class MainWindow(Adw.ApplicationWindow):
 
     # Common variables
     previous_page = ""
-    settings = Gio.Settings.new(APP_ID)
+    settings = Gio.Settings.new(BASE_ID)
     argument_executed = False
 
     def __init__(self, arg_bottle, **kwargs):
@@ -86,6 +86,7 @@ def __init__(self, arg_bottle, **kwargs):
         self.manager = None
         self.arg_bottle = arg_bottle
         self.app = kwargs.get("application")
+        self.set_icon_name(APP_ID)
 
         if PROFILE == "development":
             self.add_css_class("devel")
@@ -219,7 +220,7 @@ def set_manager(result: Manager, error=None):
 
             self.stack_main.add_titled(
                 child=self.page_list, name="page_list", title=_("Bottles")
-            ).set_icon_name("com.usebottles.bottles-symbolic")
+            ).set_icon_name(f"{APP_ID}-symbolic")
             self.stack_main.add_titled(
                 child=self.page_library, name="page_library", title=_("Library")
             ).set_icon_name("library-symbolic")

bottles/meson.build

@@ -5,6 +5,7 @@ python = import('python')
 
 conf = configuration_data()
 conf.set('PYTHON', python.find_installation('python3').full_path())
+conf.set('BASE_ID', BASE_ID)
 conf.set('APP_ID', APP_ID)
 conf.set('APP_NAME', APP_NAME)
 conf.set('APP_VERSION', APP_VERSION)

build-aux/com.usebottles.bottles.json → build-aux/com.usebottles.bottles.Devel.json

@@ -1,5 +1,5 @@
 {
-    "id": "com.usebottles.bottles",
+    "id": "com.usebottles.bottles.Devel",
     "sdk": "org.gnome.Sdk",
     "runtime": "org.gnome.Platform",
     "base": "org.winehq.Wine",

build.sh

@@ -1,15 +1,15 @@
 #!/bin/sh
 
 run_flatpak() {
-  flatpak-spawn --host flatpak-builder -v build build-aux/com.usebottles.bottles.json --user --install --force-clean && flatpak-spawn --host flatpak run com.usebottles.bottles
+  flatpak-spawn --host flatpak-builder -v build build-aux/com.usebottles.bottles.Devel.json --user --install --force-clean && flatpak-spawn --host flatpak run com.usebottles.bottles.Devel
 }
 
 run_host() {
-  flatpak-builder build -v build-aux/com.usebottles.bottles.json --user --install --force-clean && flatpak run com.usebottles.bottles
+  flatpak-builder build -v build-aux/com.usebottles.bottles.Devel.json --user --install --force-clean && flatpak run com.usebottles.bottles.Devel
 }
 
 run_container() {
-  host-spawn flatpak-builder build -v build-aux/com.usebottles.bottles.json --user --install --force-clean && host-spawn flatpak run com.usebottles.bottles
+  host-spawn flatpak-builder build -v build-aux/com.usebottles.bottles.Devel.json --user --install --force-clean && host-spawn flatpak run com.usebottles.bottles.Devel
 }
 
 if [ -x "$(command -v flatpak-spawn)" ]; then

data/com.usebottles.bottles.metainfo.xml.in → data/com.usebottles.bottles.metainfo.xml.in.in

@@ -2,12 +2,12 @@
 <component type="desktop">
   <metadata_license>CC0-1.0</metadata_license>
   <project_license>GPL-3.0-only</project_license>
-  <id>com.usebottles.bottles</id>
-  <launchable type="desktop-id">com.usebottles.bottles.desktop</launchable>
+  <id>@APP_ID@</id>
+  <launchable type="desktop-id">@APP_ID@.desktop</launchable>
   <name>Bottles</name>
   <summary>Run Windows Software</summary>
   <developer_name translatable="no">Bottles Contributors</developer_name>
-  <developer id="com.usebottles">
+  <developer id="@DEVELOPER_ID@">
     <name translatable="no">Bottles Contributors</name>
   </developer>
   <description>
@@ -49,7 +49,7 @@
       <image>https://raw.githubusercontent.com/bottlesdevs/Bottles/main/data/appstream/5.png</image>
     </screenshot>
   </screenshots>
-  <translation type="gettext">com.usebottles.bottles</translation>
+  <translation type="gettext">@APP_ID@</translation>
   <content_rating type="oars-1.1"/>
   <url type="homepage">https://usebottles.com</url>
   <url type="bugtracker">https://github.com/bottlesdevs/Bottles/issues</url>

data/meson.build

@@ -1,15 +1,16 @@
 conf = configuration_data()
 conf.set('APP_ID', APP_ID)
+conf.set('BASE_ID', BASE_ID)
 conf.set('APP_NAME', APP_NAME)
-
-desktop_file = configure_file(
-        input:  'com.usebottles.bottles.desktop.in.in',
-       output:  'com.usebottles.bottles.desktop.in',
-    configuration: conf)
+conf.set('DEVELOPER_ID', DEVELOPER_ID)
 
 desktop = i18n.merge_file(
-  input: desktop_file,
-  output: 'com.usebottles.bottles.desktop',
+  input: configure_file(
+    input:  BASE_ID + '.desktop.in.in',
+    output:  BASE_ID + '.desktop.in',
+    configuration: conf
+  ),
+  output: APP_ID + '.desktop',
   type: 'desktop',
   po_dir: '../po',
   install: true,
@@ -24,11 +25,15 @@ if desktop_utils.found()
 endif
 
 appstream_file = i18n.merge_file(
-  input: 'com.usebottles.bottles.metainfo.xml.in',
-  output: 'com.usebottles.bottles.metainfo.xml',
+  input: configure_file(
+    input: BASE_ID + '.' + 'metainfo.xml.in.in',
+    output: BASE_ID + '.' + 'metainfo.xml.in',
+    configuration: conf
+  ),
+  output: APP_ID + '.' + 'metainfo.xml',
   po_dir: '../po',
   install: true,
-  install_dir: join_paths(get_option('datadir'), 'metainfo')
+  install_dir: get_option('datadir') / 'metainfo'
 )
 
 appstream_util = find_program('appstream-util', required: false)

meson.build

@@ -10,7 +10,9 @@ project(
 
 
 APP_NAME = 'Bottles'
-APP_ID = 'com.usebottles.bottles'
+DEVELOPER_ID = 'com.usebottles'
+BASE_ID = DEVELOPER_ID + '.' + meson.project_name()
+APP_ID = BASE_ID
 APP_VERSION = meson.project_version()
 PROFILE = get_option('profile')