better AppImage support

Author: ddmitov

CONSTANTS.md

@@ -3,21 +3,23 @@ Perl Executing Browser - Constants
 
 ## Hard Coded Files and Folders
 * **Perl interpreter:**  
-  PEB expects to find Perl interpreter in ``{PEB_binary_directory}/perl/bin`` folder. The interpreter must be named ``perl`` on Linux and Mac machines and ``perl.exe`` on Windows machines. If Perl interpreter is not found in the above location, PEB will try to find the first Perl interpreter on PATH. If no Perl interpreter is found, an error page is displayed instead of the start page. No Perl interpreter is a showstopper for PEB.
+  PEB expects to find a Perl interpreter in the ``{PEB_binary_directory}/perl/bin`` folder. The interpreter must be named ``perl`` on Linux and Mac machines and ``perl.exe`` on Windows machines. If Perl interpreter is not found in the above location, PEB will use the first Perl interpreter on PATH.  
+
+* **Resources directory:**  
+  Resources directory is ``{PEB_binary_directory}/resources`` or ``{AppImage_binary_directory}/resources`` if a PEB-based application is packed as an [AppImage](https://appimage.org/). Application, data and logs directories, as well as icon file of a PEB application must be located in this folder.  
 
 * **Application directory:**  
   Application directory is ``{PEB_binary_directory}/resources/app``.  
-  All files used by PEB, with the exception of data files, should be located within this folder.  
+  All files used by PEB, with the exception of data files, must be located within this folder.  
 
   Application directory is hard coded in C++ code for compatibility with the [Electron](http://electron.atom.io/) framework.  
   [Epigraphista](https://github.com/ddmitov/epigraphista) is an example of a PEB-based application, that is also compatible with [Electron](http://electron.atom.io/) and [NW.js](http://nwjs.io/).  
 
   By default the working directory of all Perl scripts run by PEB is the application directory.
 
 * **Data Directory:**
-  Data directory should contain any files used or produced by a PEB-based application.  
-  The data directory path is ``{PEB_binary_directory}/resources/data``.  
-  Perl scripts can access this folder using the environment variable ``PEB_DATA_DIR``:
+  Data directory must contain any writable files used or produced by a PEB-based application.  
+  The data directory path is ``{PEB_binary_directory}/resources/data`` or ``{AppImage_binary_directory}/resources/data`` if a PEB-based application is packed as an [AppImage](https://appimage.org/). Perl scripts can access this folder using the environment variable ``PEB_DATA_DIR``:
 
   ```perl
   my $data_directory = $ENV{'PEB_DATA_DIR'};

CREDITS.md

@@ -145,6 +145,7 @@ https://stackoverflow.com/questions/23174393/parse-jsonarray
 https://stackoverflow.com/questions/24899558/how-to-check-qt-version-to-include-different-header  
 https://stackoverflow.com/questions/19822211/qt-parsing-json-using-qjsondocument-qjsonobject-qjsonarray  
 https://stackoverflow.com/questions/2241808/checking-if-a-folder-exists-and-creating-folders-in-qt-c  
+https://stackoverflow.com/questions/9641807/qdir-mkdir-with-absolutepath  
 
 http://www.java2s.com/Code/Cpp/Qt/CheckfileexistanceandfilenamewithQFile.htm  
 http://webkit.sed.hu/content/disabling-cache  

README.md

@@ -33,6 +33,7 @@ Inspired by [Electron](http://electron.atom.io/) and [NW.js](http://nwjs.io/), P
   * [Starting Local Server](./SETTINGS.md#starting-local-server)
   * [Selecting Files and Folders](./SETTINGS.md#selecting-files-and-folders)
   * [Minimal Portable Perl Distribution for PEB](./SETTINGS.md#minimal-portable-perl-distribution-for-peb)
+  * [AppImage Support](./SETTINGS.md#appimage-support)
   * [Log Files](./SETTINGS.md#log-files)
 * [History](#history)
 * [License](./LICENSE.md)

REQUIREMENTS.md

@@ -2,22 +2,25 @@ Perl Executing Browser - Requirements
 --------------------------------------------------------------------------------
 
 ## Compile-Time Requirements
-The only Linux and Macintosh compile-time requirement of PEB is a GCC-based Qt development bundle version 5.2 or any later version.  
+The only Linux and Macintosh compile-time requirement of PEB is a Qt development bundle version 5.2 or any later version.  
 
-The source code of PEB is not MSVC-compatible and PEB can not be compiled using any MSVC-based Windows version of Qt. Only applications build for a MSVC-based Qt version 5.6.x or higher can use ```QtWebEngine``` on the Windows platform. Windows GCC-based Qt development bundles version 5.6.x or higher have neither ```QtWebEngine```, nor ```QtWebKit```.  
-This means that:  
-* Windows builds of PEB can only be compiled by a GCC-based Qt development bundle.
-* Windows builds of PEB can only use ```QtWebKit``` web engine.  
-* Updated ``QtWebKit`` have to be manually added from the  
-  [QtWebKit repository of Konstantin Tokarev (annulen)](https://github.com/annulen/webkit/releases) to all Windows GCC-based Qt development bundles version 5.6.x or higher.
+PEB Windows binary can be compiled using any MinGW (GCC-based) Qt development bundle version 5.2.x - 5.8.x.  
+
+Compiling Windows binaries of PEB is subject to the following restrictions:  
+
+* The source code of PEB is not MSVC-compatible and Windows builds of PEB can only be compiled by a MinGW (GCC-based) Qt development bundle.
+*  Only MSVC-based Qt development bundles version 5.6.x or higher include the ```QtWebEngine``` on the Windows platform and Windows builds of PEB can only use the ```QtWebKit``` web engine.
+* Windows MinGW Qt development bundles version 5.6.x - 5.8.x have neither ```QtWebEngine```, nor ```QtWebKit``` and an updated ``QtWebKit`` has to be manually added from the [QtWebKit repository of Konstantin Tokarev (annulen)](https://github.com/annulen/webkit/releases).
+* There are no MinGW Qt development bundles for any version 5.9.x or higher.
 
 Compiled and tested successfully using:
-* [Qt Creator 3.0.0 and Qt 5.2.0](http://download.qt.io/archive/qt/5.2/5.2.0/) on 32-bit Debian and 32-bit Windows XP
-* [Qt Creator 3.0.1 and Qt 5.2.1](http://download.qt.io/archive/qt/5.2/5.2.1/) on 64-bit OS X 10.9.1, i5
-* [Qt Creator 3.1.1 and Qt 5.3.0](http://download.qt.io/archive/qt/5.3/5.3.0/) on 64-bit Lubuntu 14.10
-* [Qt Creator 3.1.1 and Qt 5.4.1](http://download.qt.io/archive/qt/5.4/5.4.1/) on 64-bit Lubuntu 15.04
-* [Qt Creator 3.5.1 and Qt 5.5.1](http://download.qt.io/archive/qt/5.5/5.5.1/) on 64-bit Lubuntu 15.04 and 16.04
-* [Qt Creator 4.2.1 and Qt 5.8.0](http://download.qt.io/archive/qt/5.5/5.5.1/) on 64-bit Lubuntu 16.04
+* [Qt 5.2.0 and Qt Creator 3.0.0](http://download.qt.io/archive/qt/5.2/5.2.0/) on 32-bit Debian and 32-bit Windows XP
+* [Qt 5.2.1 and Qt Creator 3.0.1](http://download.qt.io/archive/qt/5.2/5.2.1/) on 64-bit OS X 10.9.1, i5
+* [Qt 5.3.0 and Qt Creator 3.1.1](http://download.qt.io/archive/qt/5.3/5.3.0/) on 64-bit Lubuntu 14.10
+* [Qt 5.4.1 and Qt Creator 3.1.1](http://download.qt.io/archive/qt/5.4/5.4.1/) on 64-bit Lubuntu 15.04
+* [Qt 5.5.1 and Qt Creator 3.5.1](http://download.qt.io/archive/qt/5.5/5.5.1/) on 64-bit Lubuntu 15.04 and 16.04
+* [Qt 5.8.0 and Qt Creator 4.2.1](http://download.qt.io/archive/qt/5.8/5.8.0/) on 64-bit Lubuntu 16.04
+* [Qt 5.9.1 and Qt Creator 4.3.1](http://download.qt.io/archive/qt/5.9/5.9.1/) on 64-bit Lubuntu 16.04
 
 To compile PEB type in a terminal started in the ``src`` folder:
 
@@ -62,11 +65,10 @@ All compile-time settings require editing the ``src/peb.pro`` project file accor
   CONFIG += app_bundle
   ```
 
-## Runtime Requirements
-* Qt 5 libraries.  
+  To make automatically a bundled binary (peb.app) use the [dmg-maker.sh](sdk/dmg-maker.sh) script by Valcho Nedelchev.
 
-  Their full list for a QtWebKit Linux build of PEB can be found inside the [start-peb-webkit.sh](start-peb-webkit.sh) script.  
-  Their full list for a QtWebEngine Linux build of PEB can be found inside the [start-peb-webengine.sh](start-peb-webengine.sh) script.  
+## Runtime Requirements
+* Qt 5 libraries.
 
 * Perl 5 distribution - any Linux, Mac or Windows Perl standard or relocatable distribution.  
 

SETTINGS.md

@@ -216,11 +216,14 @@ select_file.receiverFunction = function (file) {
   Any new directory will be created immediately by PEB.
 
 ## Minimal Portable Perl Distribution for PEB
-Sometimes it is important to minimize the size of the relocatable (or portable) Perl distribution used by a PEB-based application. [Perl Distribution Compactor](sdk/compactor.pl) is one solution to this problem. It finds all dependencies of all Perl scripts in the ``{PEB_binary_directory}/resources/app`` directory and copies them in a new ``{PEB_binary_directory}/perl/lib`` folder; a new ``{PEB_binary_directory}/perl/bin`` is also created. The original ``bin`` and ``lib`` folders may be saved as ``bin-original`` and ``lib-original`` respectively.  
+Sometimes it is important to minimize the size of the relocatable (or portable) Perl distribution used by a PEB-based application. [Perl Distribution Compactor](sdk/compactor.pl) is one solution for this problem. It finds all dependencies of all Perl scripts in the ``{PEB_binary_directory}/resources/app`` directory and copies them in a new ``{PEB_binary_directory}/perl/lib`` folder; a new ``{PEB_binary_directory}/perl/bin`` is also created. The original ``bin`` and ``lib`` folders may be saved as ``bin-original`` and ``lib-original`` respectively.  
 
-Perl Distribution Compactor should be started using [compactor.sh](sdk/compactor.sh) on a Linux or a Mac machine or [compactor.cmd](sdk/compactor.cmd) on a Windows machine to ensure that only the Perl distribution of PEB is used. This is necessary to avoid dependency mismatches with any other Perl on PATH.  
+Perl Distribution Compactor should be started using [compactor.sh](sdk/compactor.sh) on a Linux machine or [compactor.cmd](sdk/compactor.cmd) on a Windows machine to ensure that only the Perl distribution of PEB is used. This is necessary to avoid dependency mismatches with any other Perl on PATH.  
 
 Perl Distribution Compactor depends on [Module::ScanDeps](https://metacpan.org/pod/Module::ScanDeps) and [File::Copy::Recursive](https://metacpan.org/pod/File::Copy::Recursive) CPAN modules, which are included in the ``{PEB_binary_directory}/sdk/lib`` folder.
 
+## AppImage Support
+Any PEB-based application can be easily packed as a single executable Linux [AppImage](https://appimage.org/) file including the PEB binary, all necessary Qt libraries, relocatable Perl distribution and all application files. This can be easily achieved by the [AppImage Maker](sdk/appimage-maker.sh) script. It finds all dependencies of all Perl scripts in the ``{PEB_binary_directory}/resources/app`` directory and copies only the necessary Perl modules using the [Perl Distribution Compactor](sdk/compactor.pl). All Qt dependencies are detected and the final image is built using a special version of the [linuxdeployqt](https://github.com/probonopd/linuxdeployqt/releases/) binary.
+
 ## Log Files
-If log files are needed for debugging of PEB or a PEB-based application, they can easily be turned on by manually creating ``{PEB_binary_directory}/logs``. If this directory is found during application startup, the browser assumes that logging is required and a separate log file is created for every browser session following the naming convention: ``{application_name}-started-at-{four_digit_year}-{month}-{day}--{hour}-{minute}-{second}.log``. PEB will not create ``{PEB_binary_directory}/logs`` on its own and if this directory is missing no logs will be written.
+If log files are needed for debugging of PEB or a PEB-based application, they can easily be turned on by manually creating ``{PEB_binary_directory}/resources/logs`` or ``{AppImage_binary_directory}/resources/logs`` if a PEB-based application is packed as an [AppImage](https://appimage.org/). If this directory is found during application startup, the browser assumes that logging is required and a separate log file is created for every browser session following the naming convention: ``{application_name}-started-at-{four_digit_year}-{month}-{day}--{hour}-{minute}-{second}.log``. PEB will not create ``{PEB_binary_directory}/logs`` on its own and if this directory is missing, no logs will be written.

resources/app.png

@@ -71,7 +71,7 @@
   }
 );
 
-my $wait_one_second = AnyEvent->timer (
+my $half_second_wait = AnyEvent->timer (
   after => 0,
   interval => 0.5,
   cb => sub {

resources/app/perl/interactive.pl

@@ -19,7 +19,7 @@ else
 fi
 
 cp ./sdk/peb.desktop ./peb.app/peb.desktop
-cp ./src/resources/icon/camel.png ./peb.app/peb.png
+cp ./resources/app.png ./peb.app/peb.png
 
 cp -rf ./resources ./peb.app/resources
 

sdk/appimage-maker.sh

@@ -15,12 +15,11 @@
  https://github.com/ddmitov/perl-executing-browser
 */
 
-#include <QApplication>
+#include <QtWidgets/QApplication>
 #include <QDateTime>
 #include <QDebug>
 #include <QTextCodec>
 #include <QtGlobal>
-#include <QtWidgets>
 
 #include "port-scanner.h"
 
@@ -173,6 +172,23 @@ int main(int argc, char **argv)
             QDir::toNativeSeparators(
                 browserDirectory + QDir::separator() + "resources");
 
+#ifdef Q_OS_LINUX
+    QByteArray appImageEnvVariable = qgetenv("APPIMAGE");
+    QString appImageResourcesDirectory;
+
+    if (appImageEnvVariable.length() > 0) {
+        QFileInfo appImageFileInfo =
+                QFileInfo(QString::fromLatin1(appImageEnvVariable));
+
+        QString appImageDirectory = appImageFileInfo.path();
+        QString appImageName = appImageFileInfo.baseName();
+
+        appImageResourcesDirectory =
+                appImageDirectory + QDir::separator()
+                + appImageName + "-resources";
+    }
+#endif
+
     // ==============================
     // Application directory:
     // ==============================
@@ -185,12 +201,24 @@ int main(int argc, char **argv)
     // ==============================
     // Data directory:
     // ==============================
-    QString dataDirName = QDir::toNativeSeparators(
-                resourcesDirectory + QDir::separator()
-                + "data");
-    QByteArray dataDirNameArray = dataDirName.toLatin1();
+    QString dataDirName =
+            QDir::toNativeSeparators(
+                resourcesDirectory + QDir::separator() + "data");
 
-    qputenv("PEB_DATA_DIR", dataDirNameArray);
+#ifdef Q_OS_LINUX
+    if (appImageEnvVariable.length() > 0) {
+        dataDirName =
+                appImageResourcesDirectory + QDir::separator() + "data";
+
+        QDir dataDir(dataDirName);
+
+        if (!dataDir.exists()) {
+            dataDir.mkpath(dataDirName);
+        }
+    }
+#endif
+
+    qputenv("PEB_DATA_DIR", dataDirName.toLatin1());
 
     // ==============================
     // Application icon:
@@ -214,11 +242,20 @@ int main(int argc, char **argv)
     // ==============================
     // Logging:
     // ==============================
-    // If 'logs' directory is found in the directory of the browser binary,
+    // If 'logs' directory is found in the resources directory,
     // all program messages will be redirected to log files,
     // otherwise no log files will be created and
-    // program messages could be seen inside Qt Creator.
-    QString logDirFullPath = browserDirectory + QDir::separator() + "logs";
+    // program messages could be seen inside Qt Creator during development.
+
+    QString logDirFullPath = resourcesDirectory + QDir::separator() + "logs";
+
+#ifdef Q_OS_LINUX
+    if (appImageEnvVariable.length() > 0) {
+        logDirFullPath =
+                appImageResourcesDirectory + QDir::separator() + "logs";
+    }
+#endif
+
     QDir logDir(logDirFullPath);
     if (logDir.exists()) {
         application.setProperty("logDirFullPath", logDirFullPath);

sdk/makedmg.sh renamed to sdk/dmg-maker.sh

@@ -93,11 +93,11 @@ greaterThan (QT_MAJOR_VERSION, 4) {
     }
 
     greaterThan (QT_MINOR_VERSION, 5) {
-        equals (QTWEBKIT, 0) {
+        equals (ANNULEN_QTWEBKIT, 0) {
             QT += widgets webenginewidgets
         }
 
-        equals (QTWEBKIT, 1) {
+        equals (ANNULEN_QTWEBKIT, 1) {
             QT += widgets webkitwidgets
         }
     }
@@ -108,7 +108,7 @@ greaterThan (QT_MAJOR_VERSION, 4) {
     }
 
     greaterThan (QT_MINOR_VERSION, 5) {
-        equals (QTWEBKIT, 1) {
+        equals (ANNULEN_QTWEBKIT, 1) {
             QT += printsupport
         }
     }

src/main.cpp

@@ -18,8 +18,8 @@
 #ifndef MAINWINDOW_H
 #define MAINWINDOW_H
 
-#include <QApplication>
-#include <QMainWindow>
+#include <QtWidgets/QApplication>
+#include <QtWidgets/QMainWindow>
 #include <QWebEngineFullScreenRequest>
 
 #include "webengine-view.h"