Merge branch 'master' into feature/added_missing_include

Author: probonopd

AppDirAssistant.AppDir/usr/bin/AppImageKit/AppImage.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 
 
-# probono 11-2010
+# probono 11-2010, 04-2013, 07-2016
 
 
 import os, sys, subprocess, hashlib, urllib, tempfile, shutil
@@ -40,9 +40,9 @@ def __init__(self, path):
         self.path = os.path.normpath(os.path.abspath(path))
         self.path_md5 = hashlib.md5('file://' + urllib.quote(self.path)).hexdigest()
         self.is_appimage = False
-        self.iconfile_path = os.path.expanduser('~/.thumbnails/normal/') + self.path_md5 + '.png'
-        desktopfiles_location = xxdg.BaseDirectory.xdg_data_home + "/applications/appimage/"
-        self.desktopfile_path = desktopfiles_location + self.path_md5 + ".desktop" # TODO: factor out
+        self.iconfile_path = os.path.expanduser('~/.cache/thumbnails/normal/') + self.path_md5 + '.png'
+        desktopfiles_location = xxdg.BaseDirectory.xdg_data_home + "/applications/" # Subdirectory does not work on GNOME 3
+        self.desktopfile_path = desktopfiles_location + "appimage-" + self.path_md5 + ".desktop" # TODO: factor out
 
     def check_whether_is_appimage(self):
         "Checks whether the file is an AppImage. TODO: Speed up by not using file"
@@ -91,10 +91,14 @@ def install_desktop_integration(self, parentifthreaded=None):
             print "* Installing %s" % (self.desktopfile_path)
             #f = open(desktopfile_path, "w")
             f = tempfile.NamedTemporaryFile(delete=False)
-            f.write(self.get_file(self.get_desktop_filename()))
+            string = self.get_file(self.get_desktop_filename()).replace("X-GNOME-FullName", "X-AppImage-Original-GNOME-FullName").replace("Name[", "X-AppImage-Original-Name[") # Don't use localized names, since we want the filename as the name
+            print string
+            f.write(string)
             f.close()
             desktop = xxdg.DesktopEntry.DesktopEntry()
             desktop.parse(f.name)
+            desktop.set("X-AppImage-Original-Name", desktop.get("Name")) 
+            desktop.set("Name", os.path.basename(self.path)) 
             desktop.set("X-AppImage-Original-Exec", desktop.get("Exec")) 
             desktop.set("X-AppImage-Original-Icon", desktop.get("Icon"))
             try: 
@@ -112,8 +116,9 @@ def install_desktop_integration(self, parentifthreaded=None):
             os.chmod(f.name, 0755)
             print self.desktopfile_path
             shutil.move(f.name, self.desktopfile_path) # os.rename fails when tmpfs is mounted at /tmp
-            if os.env("KDE_SESSION_VERSION") == "4":
-	        timesavers.run_shell_command("kbuildsycoca4") # Otherwise KDE4 ignores the menu
+            if "KDE_SESSION_VERSION" in os.environ:
+                if os.environ["KDE_SESSION_VERSION"] == "4":
+	            timesavers.run_shell_command("kbuildsycoca4") # Otherwise KDE4 ignores the menu
 
     def uninstall_desktop_integration(self):
         if os.path.isfile(self.desktopfile_path):

AppImageAssistant.AppDir/package

@@ -89,6 +89,10 @@ elf = os.path.realpath(os.path.dirname(__file__)) + "/runtime"
 s = open(elf, 'rb')
 f = open(destinationfile, 'rb+')
 f.write(bytes(s.read()))
+print("ok")
+print("Embedding magic number 0x414901 at offset 8...")
+f.seek(8)
+f.write('\x41\x49\x01')
 f.close()
 s.close()
 print("ok")

AppImageAssistant.AppDir/testappimage

@@ -1,7 +1,7 @@
 #!/bin/bash
 
 #
-# Test an AppDir or AppImage on a given ISO or squashfs base system
+# Test an AppDir or AppImage on a given ISO or squashfs or ext3 base system
 # TODO: Check https://github.com/FGrose/livecd-tools/blob/liveimage-mount/tools/liveimage-mount
 #
 
@@ -51,6 +51,13 @@ if [ ${1: -4} == ".sfs" ] ; then
     mount -o loop,ro "$ISO" /tmp/$PREF/unionfs/root
 fi
 
+# If ext3 was provided, then assume it contains a rootfs use just that
+THEFS="$1"
+if [ ${1: -4} == "ext3" ] ; then
+    ISO="$1"
+    mount -o loop,ro "$ISO" /tmp/$PREF/unionfs/root
+fi
+
 echo ""
 echo "===================================================="
 echo ""
@@ -81,6 +88,12 @@ if [ -e /tmp/$PREF/iso/*-read-only.* ] ; then
   mount "$THEFS" /tmp/$PREF/unionfs/root -o loop,ro || exit 1
 fi
 
+# In case of puppy-like ISOs
+if [ -e /tmp/$PREF/iso/puppy_*.sfs ] ; then
+  THEFS=$(ls /tmp/$PREF/iso/puppy_*.sfs | head -n 1)
+  mount "$THEFS" /tmp/$PREF/unionfs/root -o loop,ro || exit 1
+fi
+
 trap atexit EXIT
 
 atexit()
@@ -142,7 +155,7 @@ rm -rf /etc/pango
 mkdir -p /etc/pango
 pango-querymodules > '/etc/pango/pango.modules' 2>/dev/null # otherwise only squares instead of text
 [ -f /si-chroot ] && ln -s /lib/ld-lsb.so.3 /lib/ld-linux.so.2
-LD_LIBRARY_PATH=$MNT/usr/lib:$MNT/usr/lib32:$MNT/usr/lib64:$MNT/lib/:$LD_LIBRARY_PATH ldd $MNT/usr/bin/*  $MNT/usr/lib/* 2>/dev/null | grep "not found" | sort | uniq
+# LD_LIBRARY_PATH=$MNT/usr/lib:$MNT/usr/lib32:$MNT/usr/lib64:$MNT/lib/:$LD_LIBRARY_PATH ldd $MNT/usr/bin/*  $MNT/usr/lib/* 2>/dev/null | grep "not found" | sort | uniq
 export HOME="/root"
 export LANG="en_EN.UTF-8"
 # export QT_PLUGIN_PATH=./lib/qt4/plugins ###################### !!!
@@ -152,9 +165,9 @@ export QT_DEBUG_PLUGINS=1
 dbus-uuidgen --ensure ; dbus-launch # Needed for CentOS 6.7 to launch apps that talk to dbus
 if [ -f $MNT/usr/lib/qt5/plugins/platforms/libqxcb.so ] ; then
   export LD_LIBRARY_PATH=$MNT/usr/lib/:$LD_LIBRARY_PATH
-  ldd $MNT/usr/lib/qt5/plugins/platforms/libqxcb.so | grep not
+  ##ldd $MNT/usr/lib/qt5/plugins/platforms/libqxcb.so | grep not
 fi
-find $MNT/usr/lib -type f -exec sh -c 'ldd {} | grep "not found"'  2>/dev/null \;
+##find $MNT/usr/lib -type f -exec sh -c 'ldd {} | grep "not found"'  2>/dev/null \;
 if [ $(which $RUN_COMMAND) ] ; then
     exec $RUN_INSIDE
 else

AppImageUpdate.AppDir/README.md

@@ -132,12 +132,43 @@ echo "zsync|https://resin-production-downloads.s3.amazonaws.com/etcher/latest/Et
 
 **Step 2: Upload the AppImage and the AppImage.zsync to an URL that matches the URL specified in the update information**
 
-You would have to copy both `Etcher-linux-x64.AppImage.zsync` and `Etcher-linux-x64.AppImage.zsync` to `https://resin-production-downloads.s3.amazonaws.com/etcher/latest/` for this to work.
+You would have to copy both `Etcher-linux-x64.AppImage` and `Etcher-linux-x64.AppImage.zsync` to `https://resin-production-downloads.s3.amazonaws.com/etcher/latest/` for this to work.
 
-When you have a new version, simply put the updated  `Etcher-linux-x64.AppImage.zsync` and `Etcher-linux-x64.AppImage.zsync` at the *same* location.
+When you have a new version, simply put the updated  `Etcher-linux-x64.AppImage` and `Etcher-linux-x64.AppImage.zsync` at the *same* location.
 
 At this point, AppImageUpdate should work. AppImageUpdate is really just an example GUI around the (work-in-progress but useable) [appimageupdate](https://github.com/probonopd/AppImageKit/blob/master/AppImageUpdate.AppDir/usr/bin/appimageupdate) bash script. You could put `appimageupdate` (and its dependency [zsync_curl](https://github.com/probonopd/zsync-curl)) inside `usr/bin` of the AppImage, and call `appimageupdate` from within your app and even have a little GUI around it; or reimplement it in the language of your app.
 
+## Other example
+
+```
+# Let's use ".AppImage" as the standard suffix
+mv krita-3.0-x86_64.appimage Krita-3.0-x86_64.AppImage
+
+# Note that there is no "3" in the URL and no "3.0"
+# as this URL must always point to the latest/current zsync file
+URL="zsync|http://files.kde.org/krita/linux/Krita-latest-x86_64.AppImage.zsync"
+
+wget https://github.com/probonopd/AppImageKit/raw/master/AppImageUpdate.AppDir/usr/bin/appimageupdate
+wget https://github.com/probonopd/zsync-curl/releases/download/_binaries/zsync_curl
+chmod a+x zsync_curl
+PATH=.:$PATH bash appimageupdate Krita-3.0-x86_64.AppImage set $URL
+
+# Should say:
+# "Changed to zsync|http://files.kde.org/krita/linux/Krita-latest-x86_64.AppImage.zsync"
+
+sudo apt install zsync
+zsyncmake Krita-3.0-x86_64.AppImage
+mv Krita-3.0-x86_64.AppImage.zsync Krita-latest-x86_64.AppImage.zsync
+
+# Now upload Krita-3.0-x86_64.AppImage and Krita-latest-x86_64.AppImage.zsync to
+# http://files.kde.org/krita/linux/
+
+# Check whether appimageupdate finds the stuff on the server by running on the client:
+PATH=.:$PATH bash appimageupdate ./Krita-3.0-x86_64.AppImage
+
+# Assuming that 3.0.1 comes out, repeat the steps with 3.0.1
+```
+
 ## TODO
 
  * Implement a GUI

AppImageUpdate.AppDir/usr/bin/appimageupdate

@@ -140,9 +140,9 @@ if [ "$TYPE" == "zsync" ] ; then
   # downloads and reuse the data already downloaded.
   ZSYNC_URL=$(echo "${APPLICATION_USED}" | cut -d "|" -f 2) # Get the URL of the zsync file
   # Get the file with zsync using $1 as an input file
-  zsync_curl -# -I -i "${ISO}" "${ZSYNC_URL}" 2>&1 | tee >(sed -e 's/#/#\n/g') && finished 
+  zsync_curl -I -i "${ISO}" "${ZSYNC_URL}" 2>&1 | tee >(sed -e 's/#/#\n/g') && finished
   NEWFILE=$(basename "${ZSYNC_URL}" | sed -e 's|.zsync||g' ) # FIXME: Use the file that zsync has written!!!
-  chmod --reference="${ISO}" "${NEWFILE}"* # Set the same permissions as for the original file
+  chmod --reference="${ISO}.zs-old" "${NEWFILE}" # Set the same permissions as for the original file
   gpg_check
 elif [ "$TYPE" == "bintray-zsync" ] ; then
   cd $(dirname "${ISO}") 
@@ -172,7 +172,7 @@ elif [ "$TYPE" == "bintray-zsync" ] ; then
   # Get the file with zsync using $1 as an input file
   zsync_curl -I -i "${ISO}" "${ZSYNC_URL}" 2>&1 | tee >(sed -e 's/#/#\n/g') && finished
   NEWFILE=$(basename "${ZSYNC_URL}" | sed -e 's|.zsync||g' ) # FIXME: Use the file that zsync has written!!!
-  chmod --reference="${ISO}" "${NEWFILE}"* # Set the same permissions as for the original file
+  chmod --reference="${ISO}.zs-old" "${NEWFILE}" # Set the same permissions as for the original file
   gpg_check
 
 elif [ "$TYPE" == "" ] ; then
@@ -187,6 +187,6 @@ else
   exit 1
 fi
 
-rm *.zs-old 2>/dev/null || true
+rm "${ISO}.zs-old" "${ISO}.asc" 2>/dev/null || true
 
 echo "Successfully updated to version ${VERSION}"

README.md

@@ -1,4 +1,4 @@
-# AppImageKit [![Build Status](https://travis-ci.org/probonopd/AppImageKit.svg?branch=master)](https://travis-ci.org/probonopd/AppImageKit) [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/probonopd/AppImageKit?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+# AppImageKit [![discourse](https://img.shields.io/badge/forum-discourse-orange.svg)](http://discourse.appimage.org) [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/probonopd/AppImageKit?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [![irc](https://img.shields.io/badge/IRC-%23AppImage%20on%20freenode-blue.svg)](https://webchat.freenode.net/?channels=AppImage)
 
 Copyright (c) 2004-16 Simon Peter <probono@puredarwin.org> and contributors.
 
@@ -12,7 +12,7 @@ conveniently handling AppImages.
 
 https://en.wikipedia.org/wiki/AppImage
 
-This document describes the AppImage format and AppImageKit. It is intended to describe the philosophy behind the AppImage format and the concrete implementation. This document is not a formal specification, since the AppImage format is not frozen yet but in the process of being specified more formally. Contributors are encouraged to comment on this document and propose formal format descriptions.
+This document describes the AppImage format and AppImageKit. It is intended to describe the philosophy behind the AppImage format and the concrete implementation. This document is not a formal specification, since the AppImage format is not frozen yet but in the process of being specified more formally at https://github.com/AppImage/AppImageSpec. Contributors are encouraged to comment.
 
 Significant upstream projects have started providing AppImages of releases and/or nightly/continuous builds, see this [list of upstream-provided AppImages](https://github.com/probonopd/AppImageKit/wiki/AppImages#upstream-appimages).
 
@@ -37,7 +37,7 @@ With the introduction of Mac OS X, arguably the first UNIX-based operating syste
 
 Open Source operating systems, such as the most prominent Linux distributions, mostly use package managers for everything. While this is perceived superior to Windows and the Mac by many Linux enthusiasts, it also creates a number of disadvantages:
 
- 1. __Centralization__ Some organization decides what is "in" a distribution and what is not. By definition, software "in" a distribution is easier to install and manage that software that is not.
+ 1. __Centralization__ Some organization decides what is "in" a distribution and what is not. By definition, software "in" a distribution is easier to install and manage than software that is not.
  2. __Duplication of effort__ In traditional systems, each application is compiled specifically for each target operating system. This means that one piece of software has to be compiled many, many times on many, many systems using much, much power and time
  3. __Need to be online__ Most package managers are created with connected computers in the mind, making it really cumbersome to "just fetch an app" on an online system, and copy it over to another system that is not connected to the Internet.
 
@@ -65,7 +65,7 @@ The AppImage format has been created with specific objectives in mind.
 
  1. __Be Simple__. AppImage is intended to be a very simple format that is easy to understand, create, and manage.
  2. __Maintain binary compatibility__. AppImage is a format for binary software distribution. Software packaged as AppImage is intended to be as binary-compatible as possible with as many systems as possible. The need for (re-)compilation of software should be greatly reduced.
- 3. __Be distribution-agostic__. An AppImage should run on all base operating systems (distributions) that it was created for (and later versions). For example, you could target Ubuntu 9.10, openSUSE 11.2, and Fedora 13 (and later versions) at the same time, without having to create and maintain separate packages for each target system.
+ 3. __Be distribution-agnostic__. An AppImage should run on all base operating systems (distributions) that it was created for (and later versions). For example, you could target Ubuntu 9.10, openSUSE 11.2, and Fedora 13 (and later versions) at the same time, without having to create and maintain separate packages for each target system.
  4. __Remove the need for installation__. AppImages contain the app in a format that allows it to run directly from the archive, without having to be installed first. This is comparable to a Live CD. Before Live CDs, operating systems had to be installed first before they could be used.
  5. __Keep apps compressed all the time__. Since the application remains packaged all the time, it is never uncompressed on the hard disk. The computer uncompresses the application on-the-fly while accessing it. Since decompression is faster than reading from hard disk on most systems, this has a speed advantage in addition to saving space. Also, the time needed for installation is entirely removed.
  6. __Allow to put apps anywhere__. AppImages are "relocatable", thus allowing the user to store and execute them from any location (including CD-ROMs, DVDs, removable disks, USB sticks).
@@ -196,6 +196,32 @@ AppImages can be updated using [AppImageUpdate](https://github.com/probonopd/App
 
 For the full story, read [this](https://github.com/probonopd/AppImageKit/blob/master/AppImageUpdate.AppDir/README.md).
 
+## Sandboxing
+
+[Firejail](https://github.com/netblue30/firejail/) is a low-overhead sandbox that provides native support for the AppImage format. Written in C with virtually no dependencies, Firejail runs on any Linux computer with a 3.x kernel version or newer. 
+
+To run an AppImage inside a Firejail sandbox, run it like this:
+
+```
+$ firejail --appimage Krita-3.0-x86_64.AppImage
+```
+
+or with some basic X11 and network sandboxing:
+
+```
+$ firejail --appimage --net=none --x11 Krita-3.0-x86_64.AppImage
+```
+
+These are the main features of AppImage/Firejail combination ([source](https://firejail.wordpress.com/documentation-2/appimage-support/)):
+* State of the art software packaging and sandboxing technology
+* The only requirement to run the sandboxed application is a Linux kernel version 3 or newer – there are no dependencies, no 200MB runtimes to download and install
+* Network and X11 sandboxing available today!
+* Graphical user interface and auditing capabilities
+* Low runtime overhead – we do not increase the attack surface of the software environment by running daemons in the background
+* It can be used in parallel with other security frameworks such as Grsecurity, AppArmor, SELinux
+
+It is also possible to use the [Bubblewrap](https://github.com/probonopd/AppImageKit/blob/master/sandbox/README.md) sandbox to run AppImages.
+
 ## Support
 
 I support open source projects that wish to distribute their software as an AppImage. For closed source applications, I offer AppImage packaging and testing as a service.

ROADMAP.md

@@ -0,0 +1,32 @@
+# AppImageKit roadmap
+
+Volunteers wanted for the following topics. Feel free to send a PR that adds your name to list item(s).
+
+## Downloading appimages from some kind of software catalog websites and app centers
+
+* Define formal AppImage spec (probonopd)
+* Work on tool that lets one extract metadata like application name, author, license, etc. from an AppImage hosted somewhere without having to download it (think "Google for AppImages")
+* Get AppImage downloads into KDE Discover
+* Write GNOME Software plugin for AppImage
+
+## Running  appimage and browsing its content  via file roller/ark or any other archive tool
+
+* Follow up with upstream projects and/or send PRs
+* file-roller
+* ark (DONE)
+
+## Upgrading appimage via right click
+
+* Make zsync_curl use subsequent range requests rather than requesting multiple ranges at once; otherwise Akamai is broken
+* Make AppImageUpdate not need the curl binary but expand zsync_curl to include the required curl functionality
+* Possibly replace the AppImageUpdate bash script by C code, e.g., in zsync_curl
+* Qt GUI in addition to the Vala/GTK 3 one
+
+## Desktop integration
+
+* Resurrect appimaged (probonopd; contact me if you want to take this over)
+* Sandbox using firejail (see the sandbox GUI integration experiments in this repository)
+* Test/use GNOME portals
+
+## IDE/build tool integration
+* Someone familiar with Qt (= not me, probono) should have a deep look at http://code.qt.io/cgit/qt/qttools.git/tree/src/macdeployqt/ and see if the same can be done to generate an AppImage

depgraph/README.md

@@ -0,0 +1,5 @@
+# depgraph
+
+Draws a chart of dependencies based on the information in debian repositories.
+
+[Example](https://github.com/probonopd/AppImageKit/blob/master/depgraph/marble.svg)