Merge pull request #81833 from bignaux/appimage-run

appimage-run: unify appimageTools and appimage-run

pkgs/build-support/appimage/appimage-exec.sh

@@ -0,0 +1,142 @@
+#!@shell@
+if [ -n "$DEBUG" ] ; then
+  set -x
+fi
+
+PATH="@path@:$PATH"
+apprun_opt=true
+
+#DEBUG=0
+
+# src : AppImage
+# dest : let's unpack() create the directory
+unpack() {
+  local src=$1
+  local out=$2
+  local appimageSignature=""
+  local appimageType=0
+
+  # https://github.com/AppImage/libappimage/blob/ca8d4b53bed5cbc0f3d0398e30806e0d3adeaaab/src/libappimage/utils/MagicBytesChecker.cpp#L45-L63
+  eval "$(r2 "$src" -nn -Nqc "p8j 3 @ 8" |
+    jq -r '{appimageSignature: (.[:-1]|implode), appimageType: .[-1]}|
+      @sh "appimageSignature=\(.appimageSignature) appimageType=\(.appimageType)"')"
+
+  # check AppImage signature
+  if [[ "$appimageSignature" != "AI" ]]; then
+    echo "Not an appimage."
+    exit
+  fi
+
+  case "$appimageType" in
+    1 ) echo "Uncompress $(basename "$src") of type $appimageType."
+        mkdir "$out"
+        pv "$src" | bsdtar -x -C "$out" -f -
+        ;;
+    2)
+        # This method avoid issues with non executable appimages,
+        # non-native packer, packer patching and squashfs-root destination prefix.
+
+        # multiarch offset one-liner using same method as AppImage
+        # see https://gist.github.com/probonopd/a490ba3401b5ef7b881d5e603fa20c93
+        offset=$(r2 "$src" -nn -Nqc "pfj.elf_header @ 0" |\
+          jq 'map({(.name): .value}) | add | .shoff + (.shnum * .shentsize)')
+
+        echo "Uncompress $(basename "$src") of type $appimageType @ offset $offset."
+        unsquashfs -q -d "$out" -o "$offset" "$src"
+        chmod go-w "$out"
+        ;;
+
+    # 3) get ready, https://github.com/TheAssassin/type3-runtime
+    *)  echo Unsupported AppImage Type: "$appimageType"
+        exit
+        ;;
+  esac
+  echo "$(basename "$src") is now installed in $out"
+}
+
+apprun() {
+
+  eval "$(rahash2 "$APPIMAGE" -j | jq -r '.[] | @sh "SHA256=\(.hash)"')"
+  echo sha256 = \""$SHA256"\"\;
+  export APPDIR="${XDG_CACHE_HOME:-$HOME/.cache}/appimage-run/$SHA256"
+
+  #compatibility
+  if [ -x "$APPDIR/squashfs-root" ]; then APPDIR="$APPDIR/squashfs-root"; fi
+
+  if [ ! -x "$APPDIR" ]; then
+    mkdir -p "$(dirname "$APPDIR")"
+    unpack "$APPIMAGE" "$APPDIR"
+  else echo "$(basename "$APPIMAGE")" installed in "$APPDIR"
+  fi
+
+  export PATH="$PATH:$PWD/usr/bin"
+}
+
+wrap() {
+
+  cd "$APPDIR" || exit
+  # quite same in appimageTools
+  export APPIMAGE_SILENT_INSTALL=1
+
+  if [ -n "$APPIMAGE_DEBUG_EXEC" ]; then
+    exec "$APPIMAGE_DEBUG_EXEC"
+  fi
+
+  exec ./AppRun "$@"
+}
+
+usage() {
+  cat <<EOF
+Usage: appimage-run [appimage-run options] <AppImage> [AppImage options]
+
+-h      show this message
+-d      debug mode
+-x      <directory> : extract appimage in the directory then exit.
+-w      <directory> : run uncompressed appimage directory (used in appimageTools)
+
+[AppImage options]: Options are passed on to the appimage.
+If you want to execute a custom command in the appimage's environment, set the APPIMAGE_DEBUG_EXEC environment variable.
+
+EOF
+  exit 1
+}
+
+while getopts "x:w:dh" option; do
+    case "${option}" in
+        d)  set -x
+            ;;
+        x)  # eXtract
+            unpack_opt=true
+            APPDIR=${OPTARG}
+            ;;
+        w)  # WrapAppImage
+            export APPDIR=${OPTARG}
+            wrap_opt=true
+            ;;
+        h)  usage
+            ;;
+        *)
+            usage
+            ;;
+    esac
+done
+shift $((OPTIND-1))
+
+if [[ $wrap_opt = true ]] && [[ -d "$APPDIR" ]]; then
+  wrap "$@"
+  exit
+else
+  APPIMAGE="$(realpath "$1")" || usage
+  shift
+fi
+
+if [[ $unpack_opt = true ]] && [[ -f "$APPIMAGE" ]]; then
+  unpack "$APPIMAGE" "$APPDIR"
+  exit
+fi
+
+if [[ $apprun_opt = true ]] && [[ -f "$APPIMAGE" ]]; then
+  apprun
+  wrap "$@"
+  exit
+fi

pkgs/build-support/appimage/default.nix

@@ -1,71 +1,39 @@
-{ stdenv, libarchive, radare2, jq, buildFHSUserEnv, squashfsTools, writeScript }:
+{ stdenv, buildFHSUserEnv, writeScript, pkgs
+, bash, radare2, jq, squashfsTools, ripgrep
+, coreutils, libarchive, file, runtimeShell, pv
+, lib, runCommand }:
 
 rec {
-
+  appimage-exec = pkgs.substituteAll {
-  extract = { name, src }: stdenv.mkDerivation {
+    src = ./appimage-exec.sh;
-    name = "${name}-extracted";
+    isExecutable = true;
-    inherit src;
+    dir = "bin";
-    nativeBuildInputs = [ radare2 libarchive jq squashfsTools ];
+    path = with pkgs; lib.makeBinPath [ pv ripgrep file radare2 libarchive jq squashfsTools coreutils bash ];
-    buildCommand = ''
-      # https://github.com/AppImage/libappimage/blob/ca8d4b53bed5cbc0f3d0398e30806e0d3adeaaab/src/libappimage/utils/MagicBytesChecker.cpp#L45-L63
-      eval $(r2 $src -nn -Nqc "p8j 3 @ 8" |
-        jq -r '{appimageSignature: (.[:-1]|implode), appimageType: .[-1]}|
-          @sh "appimageSignature=\(.appimageSignature) appimageType=\(.appimageType)"')
-
-      # check AppImage signature
-      if [[ "$appimageSignature" != "AI" ]]; then
-        echo "Not an appimage."
-        exit
-      fi
-
-      case "$appimageType" in
-        1)
-          mkdir $out
-          bsdtar -x -C $out -f $src
-          ;;
-
-        2)
-          # multiarch offset one-liner using same method as AppImage
-          # see https://gist.github.com/probonopd/a490ba3401b5ef7b881d5e603fa20c93
-          offset=$(r2 $src -nn -Nqc "pfj.elf_header @ 0" |\
-            jq 'map({(.name): .value}) | add | .shoff + (.shnum * .shentsize)')
-
-          unsquashfs -q -d $out -o $offset $src
-          chmod go-w $out
-          ;;
-
-        # 3) get ready, https://github.com/TheAssassin/type3-runtime
-        *) echo "Unsupported AppImage Type: $appimageType";;
-      esac
-    '';
   };
 
+  extract = { name, src }: runCommand "${name}-extracted" {
+    buildInputs = [ appimage-exec ];
+  } ''
+    appimage-exec.sh -x $out ${src}
+  '';
+
+  # for compatibility, deprecated
   extractType1 = extract;
   extractType2 = extract;
+  wrapType1 = wrapType2;
 
   wrapAppImage = args@{ name, src, extraPkgs, ... }: buildFHSUserEnv (defaultFhsEnvArgs // {
     inherit name;
 
-    targetPkgs = pkgs: defaultFhsEnvArgs.targetPkgs pkgs ++ extraPkgs pkgs;
+    targetPkgs = pkgs: [ appimage-exec ]
+      ++ defaultFhsEnvArgs.targetPkgs pkgs ++ extraPkgs pkgs;
 
-    runScript = writeScript "run" ''
+    runScript = "appimage-exec.sh -w ${src}";
-      #!${stdenv.shell}
-
-      export APPDIR=${src}
-      export APPIMAGE_SILENT_INSTALL=1
-      cd $APPDIR
-      exec ./AppRun "$@"
-    '';
   } // (removeAttrs args (builtins.attrNames (builtins.functionArgs wrapAppImage))));
 
-  wrapType1 = args@{ name, src, extraPkgs ? pkgs: [], ... }: wrapAppImage (args // {
-    inherit name extraPkgs;
-    src = extractType1 { inherit name src; };
-  });
-
   wrapType2 = args@{ name, src, extraPkgs ? pkgs: [], ... }: wrapAppImage (args // {
     inherit name extraPkgs;
-    src = extractType2 { inherit name src; };
+    src = extract { inherit name src; };
   });
 
   defaultFhsEnvArgs = {

pkgs/tools/package-management/appimage-run/default.nix

@@ -1,56 +1,11 @@
-{ writeScript, buildFHSUserEnv, coreutils, file, libarchive, runtimeShell
+{ appimageTools, buildFHSUserEnv, extraPkgs ? pkgs: [] }:
-, extraPkgs ? pkgs: [], appimageTools }:
 
 let
   fhsArgs = appimageTools.defaultFhsEnvArgs;
 in buildFHSUserEnv (fhsArgs // {
   name = "appimage-run";
 
-  targetPkgs = pkgs: fhsArgs.targetPkgs pkgs ++ extraPkgs pkgs;
+  targetPkgs = pkgs: [ appimageTools.appimage-exec ]
-
+    ++ fhsArgs.targetPkgs pkgs ++ extraPkgs pkgs;
-  runScript = writeScript "appimage-exec" ''
+  runScript = "appimage-exec.sh";
-    #!${runtimeShell}
-    if [ $# -eq 0 ]; then 
-      echo "Usage: $0 FILE [OPTION...]"
-      echo
-      echo 'Options are passed on to the appimage.'
-      echo "If you want to execute a custom command in the appimage's environment, set the APPIMAGE_DEBUG_EXEC environment variable."
-      exit 1
-    fi
-    APPIMAGE="$(realpath "$1")"
-    shift
-
-    if [ ! -x "$APPIMAGE" ]; then
-      echo "fatal: $APPIMAGE is not executable"
-      exit 1
-    fi
-
-    SHA256="$(${coreutils}/bin/sha256sum "$APPIMAGE" | cut -d ' ' -f 1)"
-    SQUASHFS_ROOT="''${XDG_CACHE_HOME:-$HOME/.cache}/appimage-run/$SHA256/"
-    mkdir -p "$SQUASHFS_ROOT"
-
-    export APPDIR="$SQUASHFS_ROOT/squashfs-root"
-    if [ ! -x "$APPDIR" ]; then
-      cd "$SQUASHFS_ROOT"
-
-      if ${file}/bin/file --mime-type --brief --keep-going "$APPIMAGE" | grep -q iso; then
-        # is type-1 appimage
-        mkdir "$APPDIR"
-        ${libarchive}/bin/bsdtar -x -C "$APPDIR" -f "$APPIMAGE"
-      else
-        # is type-2 appimage
-        "$APPIMAGE" --appimage-extract 2>/dev/null
-      fi
-    fi
-
-    cd "$APPDIR"
-    export PATH="$PATH:$PWD/usr/bin"
-    export APPIMAGE_SILENT_INSTALL=1
-
-    if [ -n "$APPIMAGE_DEBUG_EXEC" ]; then
-      exec "$APPIMAGE_DEBUG_EXEC"
-    fi
-
-    exec ./AppRun "$@"
-  '';
 })