feat: default-flatpaks module

files/usr/bin/system-flatpak-setup

@@ -0,0 +1,72 @@
+#!/usr/bin/env bash
+
+# Script Version
+VER=1
+VER_FILE="/etc/ublue-os/system-flatpak-configured"
+VER_RAN=$(cat $VER_FILE)
+
+# Run script if updated
+if [[ -f $VER_FILE && $VER = $VER_RAN ]]; then
+  echo "Flatpak setup v$VER has already ran. Exiting..."
+  exit 0
+fi
+
+# Opt out of and remove Fedora's flatpak repo
+if grep -qz 'fedora' <<< $(flatpak remotes); then
+  /usr/lib/fedora-third-party/fedora-third-party-opt-out
+  /usr/bin/fedora-third-party disable
+  flatpak remote-delete fedora --force
+  flatpak remote-delete fedora-testing --force
+fi
+
+REPO_INFO="/etc/flatpak/system/repo-info.yml"
+REPO_URL=$(yq '.repo-url' $REPO_INFO)
+REPO_NAME=$(yq '.repo-name' $REPO_INFO)
+REPO_TITLE=$(yq '.repo-title' $REPO_INFO)
+
+# Set up system-wide Flatpak repository
+if [[ ! $REPO_URL == "null" && ! $REPO_NAME == "null" ]]; then
+    echo "Adding system-wide remote $REPO_NAME from $REPO_URL"
+    flatpak remote-add --if-not-exists --system $REPO_NAME $REPO_URL
+fi
+
+# If configured remote is flathub, enable it here.
+# Flathub is already installed on Fedora, but not enabled by default,
+# so the above command won't add it again
+if [[ $REPO_NAME == "flathub" ]]; then
+    flatpak remote-modify --system $REPO_NAME --enable
+fi
+
+# Change repository title to configured title, if not null
+if [[ ! $REPO_TITLE == "null" ]]; then
+    echo "Setting title $REPO_TITLE for remote $REPO_NAME"
+    flatpak remote-modify --system $REPO_NAME --title="$REPO_TITLE"
+fi
+
+# Lists of flatpaks
+FLATPAK_LIST=$(flatpak list --columns=application)
+INSTALL_LIST=$(cat /etc/flatpak/system/install)
+REMOVE_LIST=$(cat /etc/flatpak/system/remove)
+
+# Install flatpaks in list
+if [[ -n $INSTALL_LIST ]]; then
+  for flatpak in $INSTALL_LIST; do
+    if grep -qvz $flatpak <<< $FLATPAK_LIST; then
+      flatpak install --system --noninteractive $REPO_NAME $flatpak
+    fi
+  done
+fi
+
+# Remove flatpaks in list
+if [[ -n $REMOVE_LIST ]]; then
+  for flatpak in $REMOVE_LIST; do
+    if grep -qz $flatpak <<< $FLATPAK_LIST; then
+      flatpak remove --system --noninteractive $flatpak
+    fi
+  done
+fi
+
+# Prevent future executions
+echo "Writing state file"
+mkdir -p /etc/ublue-os
+echo $VER > $VER_FILE

files/usr/bin/user-flatpak-setup

@@ -0,0 +1,63 @@
+#!/usr/bin/env bash
+
+# Script Version
+VER=1
+VER_FILE="$HOME/.config/ublue-os/user-flatpak-configured"
+VER_RAN=$(cat $VER_FILE)
+
+# Run script if updated
+if [[ -f $VER_FILE && $VER = $VER_RAN ]]; then
+  echo "Flatpak setup v$VER has already ran. Exiting..."
+  exit 0
+fi
+
+# Remove Fedora's flatpak repo, if it exists
+if grep -qz 'fedora' <<< $(flatpak remotes); then
+  flatpak remote-delete --user fedora --force
+  flatpak remote-delete --user fedora-testing --force
+fi
+
+REPO_INFO="/etc/flatpak/user/repo-info.yml"
+REPO_URL=$(yq '.repo-url' $REPO_INFO)
+REPO_NAME=$(yq '.repo-name' $REPO_INFO)
+REPO_TITLE=$(yq '.repo-title' $REPO_INFO)
+
+# Set up per-user Flatpak repository
+if [[ ! $REPO_URL == "null" && ! $REPO_NAME == "null" ]]; then
+    echo "Adding remote $REPO_NAME from $REPO_URL"
+    flatpak remote-add --if-not-exists --user $REPO_NAME $REPO_URL
+fi
+
+# Change repository title to configured title, if not null
+if [[ ! $REPO_TITLE == "null" ]]; then
+    echo "Setting title $REPO_TITLE for remote $REPO_NAME"
+    flatpak remote-modify --user $REPO_NAME --title="$REPO_TITLE"
+fi
+
+# Lists of flatpaks
+FLATPAK_LIST=$(flatpak list --columns=application)
+INSTALL_LIST=$(cat /etc/flatpak/user/install)
+REMOVE_LIST=$(cat /etc/flatpak/user/remove)
+
+# Install flatpaks in list
+if [[ -n $INSTALL_LIST ]]; then
+  for flatpak in $INSTALL_LIST; do
+    if grep -qvz $flatpak <<< $FLATPAK_LIST; then
+      flatpak install --user --noninteractive $REPO_NAME $flatpak
+    fi
+  done
+fi
+
+# Remove flatpaks in list
+if [[ -n $REMOVE_LIST ]]; then
+  for flatpak in $REMOVE_LIST; do
+    if grep -qz $flatpak <<< $FLATPAK_LIST; then
+      flatpak remove --user --noninteractive $flatpak
+    fi
+  done
+fi
+
+# Prevent future executions
+echo "Writing state file"
+mkdir -p $HOME/.config/ublue-os/
+echo $VER > $VER_FILE

files/usr/lib/systemd/system/system-flatpak-setup.service

@@ -0,0 +1,13 @@
+[Unit]
+Description=Manage system flatpaks
+Documentation=https://github.com/ublue-os/endlish-oesque/issues/10
+Wants=network-online.target
+After=network-online.target
+
+[Service]
+Type=oneshot
+ExecStart=/usr/bin/system-flatpak-setup
+Restart=on-failure
+
+[Install]
+WantedBy=multi-user.target

files/usr/lib/systemd/user/user-flatpak-setup.service

@@ -0,0 +1,10 @@
+[Unit]
+Description=Configure Flatpaks for current user
+Requires=xdg-desktop-autostart.target
+
+[Service]
+Type=simple
+ExecStart=/usr/bin/user-flatpak-setup
+
+[Install]
+WantedBy=default.target

modules/default-flatpaks/README.md

@@ -0,0 +1,35 @@
+# `default-flatpaks` module for startingpoint
+
+The `default-flatpaks` module removes the Fedora Flatpaks remote that comes pre-installed by Fedora, and can be used to install flatpaks from a configurable remote on first boot. Flatpaks can either be installed system-wide or per-user, though per-user flatpaks will be installed for every user on a system. Previously-installed flatpaks can also be removed.
+
+The module uses the following scripts to handle flatpak setup:
+
+- `/usr/bin/system-flatpak-setup`
+- `/usr/bin/user-flatpak-setup`
+
+The scripts are run on first boot and login by these services:
+
+- `/usr/lib/systemd/system/system-flatpak-setup.service`
+- `/usr/lib/systemd/user/user-flatpak-setup-service`
+
+`system-flatpak-setup` checks the flatpak repo information and install/remove lists created by the module. It also checks for the existence of `/etc/ublue-os/system-flatpak-configured` before running. `user-flatpak-setup` functions the same for user flatpaks, but checks for `$HOME/.config/ublue-os/user-flatpak-configured` instead.
+
+Flatpak setup can be run again by removing `/etc/ublue-os/system-flatpak-configured` for system-wide flatpaks, or `$HOME/.config/ublue-os/user-flatpak-configured` for user flatpaks.
+
+## Example configuration
+
+```yaml
+- type: default-flatpaks
+  system:
+    repo-url: https://dl.flathub.org/repo/flathub.flatpakrepo
+    repo-name: flathub
+    repo-title: "Flathub (system-wide)" # Optional; this sets the remote's user-facing name in graphical frontends like GNOME Software
+    install:
+    - org.gnome.Loupe
+    remove:
+    - org.gnome.eog
+  user:
+    # A flatpak repo can also be added without having to install flatpaks
+    repo-url: https://dl.flathub.org/repo/flathub.flatpakrepo
+    repo-name: flathub
+```

modules/default-flatpaks/default-flatpaks.sh

@@ -0,0 +1,64 @@
+#!/usr/bin/env bash
+
+# Tell build process to exit if there are any errors.
+set -oue pipefail
+
+cp -r "$BLING_DIRECTORY"/files/usr/bin/system-flatpak-setup /usr/bin/system-flatpak-setup
+cp -r "$BLING_DIRECTORY"/files/usr/bin/user-flatpak-setup /usr/bin/user-flatpak-setup
+cp -r "$BLING_DIRECTORY"/files/usr/lib/systemd/system/system-flatpak-setup.service /usr/lib/systemd/system/system-flatpak-setup.service
+cp -r "$BLING_DIRECTORY"/files/usr/lib/systemd/user/user-flatpak-setup.service /usr/lib/systemd/user/user-flatpak-setup.service
+
+echo "Enabling flatpaks module"
+systemctl enable system-flatpak-setup.service
+systemctl enable --global user-flatpak-setup.service
+mkdir -p /usr/etc/flatpak/{system,user}
+
+# $1, $repo_location
+configure_flatpak_repo () {
+    repo_info="/usr/etc/flatpak/$2/repo-info.yml"
+    echo "Configuring $2 repo in $repo_info"
+    repo_url=$(echo "$1" | yq -I=0 ".$2.repo-url")
+    repo_name=$(echo "$1" | yq -I=0 ".$2.repo-name")
+    repo_title=$(echo "$1" | yq -I=0 ".$2.repo-title")
+
+    touch $repo_info
+    # EOF breaks if the contents are indented,
+    # so the below lines are intentionally un-indented
+    cat > $repo_info <<EOF
+repo-url: "$repo_url"
+repo-name: "$repo_name"
+repo-title: "$repo_title"
+EOF
+}
+
+# $1, $repo_location
+configure_lists () {
+    install_list="/usr/etc/flatpak/$2/install"
+    remove_list="/usr/etc/flatpak/$2/remove"
+    get_yaml_array INSTALL ".$2.install[]" "$1"
+    get_yaml_array REMOVE ".$2.remove[]" "$1"
+
+    echo "Creating $2 Flatpak install list at $install_list"
+    if [[ ${#INSTALL[@]} -gt 0 ]]; then
+        touch $install_list
+        for flatpak in "${INSTALL[@]}"; do
+            echo "Adding to $2 flatpak installs: $(printf ${flatpak})"
+            echo $flatpak >> $install_list
+        done
+    fi
+
+    echo "Creating $2 Flatpak removals list $remove_list"
+    if [[ ${#REMOVE[@]} -gt 0 ]]; then
+        touch $remove_list
+        for flatpak in "${REMOVE[@]}"; do
+            echo "Adding to $2 flatpak removals: $(printf ${flatpak})"
+            echo $flatpak >> $remove_list
+        done
+    fi
+}
+
+configure_flatpak_repo "$1" "system"
+configure_flatpak_repo "$1" "user"
+
+configure_lists "$1" "system"
+configure_lists "$1" "user"