no Mac App Bundle and better AppImage support

Author: ddmitov

.gitattributes

@@ -1,4 +1,3 @@
 src/resources/icon/* linguist-vendored
 resources/app/bootstrap/* linguist-vendored
 resources/app/jquery/* linguist-vendored
-sdk/lib/* linguist-vendored

CREDITS.md

@@ -25,12 +25,6 @@ karaman, sisvenvet and all other members of Hackafe, the hackerspace of Plovdiv,
 for being welcoming host of the first public presentation of Perl Executing Browser  
 on the 2nd of March 2014 and for their helpful proposals.  
 
-Thanks to Roderich Schupp and all contributors of the Module::ScanDeps CPAN module.
-https://metacpan.org/pod/Module::ScanDeps  
-
-Thanks to Daniel Muey and all contributors of the File::Copy::Recursive CPAN module.
-https://metacpan.org/pod/File::Copy::Recursive  
-
 Thanks to [probonopd](https://github.com/probonopd) for his  
 knowledgeable instructions and patient cooperation  
 in the preparation and testing of Perl Executing Browser AppImages  
@@ -74,7 +68,6 @@ https://forum.qt.io/topic/3314/qwebelement-set-and-get-attribute
 
 http://www.qtcentre.org/threads/46016-Place-QMessageBox-on-middle-of-screen  
 http://www.qtcentre.org/threads/18146-String-operations-printing-to-stdout  
-http://www.qtcentre.org/threads/29363-Problem-with-QDir-cdUp()  
 http://www.qtcentre.org/threads/10661-QByteArray-to-QString  
 http://www.qtcentre.org/threads/29104-QMake-DEFINES  
 http://www.qtcentre.org/threads/48238-Call-a-JavaScript-function-from-C-using-QtWebkit  
@@ -172,25 +165,17 @@ https://meta.stackexchange.com/questions/70356/key-stroke-combination-markdown
 
 ## Bash
 
-http://tldp.org/LDP/abs/html/fto.html  
-http://tldp.org/LDP/abs/html/functions.html  
-
 https://www.shellcheck.net/  
 
 https://stackoverflow.com/questions/13210880/replace-one-substring-for-another-string-in-shell-script  
 https://stackoverflow.com/questions/4181703/how-to-concatenate-string-variables-in-bash  
 https://stackoverflow.com/questions/638975/how-do-i-tell-if-a-regular-file-does-not-exist-in-bash  
 https://stackoverflow.com/questions/10319652/check-if-a-file-is-executable  
 https://stackoverflow.com/questions/10376206/what-is-the-preferred-bash-shebang  
-https://stackoverflow.com/questions/192249/how-do-i-parse-command-line-arguments-in-bash  
 https://stackoverflow.com/questions/2664740/extract-file-basename-without-path-and-extension-in-bash  
 
-https://unix.stackexchange.com/questions/312280/split-string-by-delimiter-and-get-n-th-element  
 https://unix.stackexchange.com/questions/12453/how-to-determine-linux-kernel-architecture  
 
-https://www.cyberciti.biz/faq/unix-linux-bsd-appleosx-bash-assign-variable-command-output/  
-https://www.tutorialspoint.com/unix/unix-regular-expressions.htm  
-
 ## AppImage
 
 https://standards.freedesktop.org/menu-spec/latest/apa.html  

README.md

@@ -17,7 +17,6 @@ Perl Executing Browser (PEB) is an HTML5 user interface for [Perl 5](https://www
 * [Limitations](#limitations)
 * [REQUIREMENTS](./doc/REQUIREMENTS.md)
   * [Compile-Time Requirements](./doc/REQUIREMENTS.md#compile-time-requirements)
-  * [Compile-Time Settings](./doc/REQUIREMENTS.md#compile-time-settings)
   * [Runtime Requirements](./doc/REQUIREMENTS.md#runtime-requirements)
 * [CONSTANTS](./doc/CONSTANTS.md)
   * [Files and Folders](./doc/CONSTANTS.md#files-and-folders)
@@ -30,7 +29,7 @@ Perl Executing Browser (PEB) is an HTML5 user interface for [Perl 5](https://www
   * [Requirements for Interactive Perl Scripts](./doc/INTERACTIVE.md#requirements-for-interactive-perl-scripts)
   * [Examples of Interactive Perl Scripts](./doc/INTERACTIVE.md#examples-of-interactive-perl-scripts)
 * [APPIMAGE SUPPORT](./doc/APPIMAGE.md)
-  * [PEB AppImage Maker](./doc/APPIMAGE.md#peb-appimage-maker)
+  * [PEB AppImager](./doc/APPIMAGE.md#peb-appimager)
   * [PEB AppImage Configuration Files](./doc/APPIMAGE.md#peb-appimage-configuration-files)
   * [PEB AppImage Builder Docker Container](./doc/APPIMAGE.md#peb-appimage-builder-docker-container)
   * [AppImageHub](./doc/APPIMAGE.md#appimagehub)

appimager.sh

@@ -0,0 +1,92 @@
+#!/usr/bin/env bash
+
+# Version:
+export VERSION="1.0.0"
+
+# Architecture check:
+if [ ! "$(arch)" == "x86_64" ]; then
+  printf "\\nAppImage executable can be created only on and for 64-bit Linux distributions.\\n"
+  exit 1
+fi
+
+# Go to to PEB source directory:
+cd "$(pwd)/src" || exit
+
+# Remove temporary files:
+rm -rf tmp
+rm -f .qmake.stash
+rm -f Makefile
+
+# Compile PEB:
+qmake -qt=qt5
+make
+
+# Go back to the PEB root directory:
+cd .. || exit
+
+# If no 'linuxdeployqt' is found, it is downloaded from the web:
+linuxdeployqt="linuxdeployqt-continuous-$(arch).AppImage"
+if [ ! -x "$linuxdeployqt" ]; then
+  wget --tries=5 --unlink "https://github.com/probonopd/linuxdeployqt/releases/download/continuous/linuxdeployqt-continuous-x86_64.AppImage"
+  chmod -v a+x "$linuxdeployqt"
+fi
+
+# AppImage desktop file is mandatory:
+package_desktop_file="$(ls ./resources/app/appimage/*.desktop)"
+if [ ! -e "$package_desktop_file" ]; then
+  printf "\\nPackage .desktop file is missing!\\n"
+  exit 1
+fi
+
+# AppImage name:
+appimage_name="$(basename "$package_desktop_file" .desktop)"
+
+# Temporary directory for the creation of the AppImage:
+rm -rf "$(pwd)/$appimage_name.app"
+mkdir "$(pwd)/$appimage_name.app"
+
+# Main executable:
+cp -f "$(pwd)/peb" "$(pwd)/$appimage_name.app/$appimage_name"
+
+# Desktop file:
+cp -f "$package_desktop_file" "$(pwd)/$appimage_name.app/$appimage_name.desktop"
+
+# AppImage icon:
+if [ -e "$(pwd)/resources/app.png" ]; then
+  cp -f "$(pwd)/resources/app.png" "$(pwd)/$appimage_name.app/app.png"
+fi
+
+# AppImage metadata file:
+if [ -e "$(pwd)/resources/app/appimage/$appimage_name.appdata.xml" ]; then
+  mkdir -p "$(pwd)/$appimage_name.app/usr/share/metainfo"
+  cp -f "$(pwd)/resources/app/appimage/$appimage_name.appdata.xml" "$(pwd)/$appimage_name.app/usr/share/metainfo/$appimage_name.appdata.xml"
+fi
+
+# Documentation:
+cp -r "$(pwd)/doc" "$(pwd)/$appimage_name.app/doc"
+cp "$(pwd)/CREDITS.md" "$(pwd)/$appimage_name.app/CREDITS.md"
+cp "$(pwd)/LICENSE.md" "$(pwd)/$appimage_name.app/LICENSE.md"
+cp "$(pwd)/README.md" "$(pwd)/$appimage_name.app/README.md"
+
+# Resources:
+cp -r "$(pwd)/resources" "$(pwd)/$appimage_name.app/resources"
+
+# File cleaning:
+rm -f "$(pwd)/$appimage_name.app/resources/app/$appimage_name.desktop"
+rm -f "$(pwd)/$appimage_name.app/resources/app/$appimage_name.appdata.xml"
+
+# Extraction of the contents of 'linuxdeployqt' tool -
+# it is necessary for operation inside the PEB AppImage Builder Docker Container:
+if [ -x "$linuxdeployqt" ]; then
+  "$(pwd)/$linuxdeployqt" "--appimage-extract"
+else
+  printf "\\n$linuxdeployqt is missing!\\n"
+  exit 1
+fi
+
+# AppImage generation:
+"$(pwd)/squashfs-root/AppRun" "$(pwd)/$appimage_name.app/$appimage_name" -qmake='qmake -qt=qt5' -no-translations -appimage
+
+# Removal of the temporary directories:
+rm -rf "$(pwd)/squashfs-root"
+rm -rf "$(pwd)/$appimage_name.app"

doc/APPIMAGE.md

@@ -1,79 +1,43 @@
 # Perl Executing Browser - AppImage Support
 
-## PEB AppImage Maker
+## PEB AppImager
 
-PEB and any PEB-based application can be easily packed as a 64-bit single-file Linux [AppImage](https://appimage.org/) executable by the [PEB AppImage Maker](https://github.com/ddmitov/perl-executing-browser/blob/master/sdk/appimage-maker.sh) script, which has two modes of operation:  
+Any PEB-based application with a PEB executable, Qt libraries and a relocatable Perl distribution can be easily packed as a 64-bit single-file Linux [AppImage](https://appimage.org/) executable by the [PEB AppImager](https://github.com/ddmitov/perl-executing-browser/blob/master/appimager.sh) script, which uses the [linuxdeployqt](https://github.com/probonopd/linuxdeployqt/releases/) tool to detect all Qt dependencies of PEB and build an AppImage.  
 
-* packing a Perl application together with a PEB executable, Qt libraries and a relocatable Perl distribution:  
-
-  ```bash
-  ./appimage-maker.sh --include-resources
-  ```
-
-* packing only a PEB executable and its Qt libraries:  
-
-  ```bash
-  ./appimage-maker.sh --no-resources
-  ```
-
-  In this case, a PEB executable from an AppImage will try to find its application files and folders in the directory of the AppImage.  
-
-In both modes of operation, the PEB AppImage uses the [linuxdeployqt](https://github.com/probonopd/linuxdeployqt/releases/) tool to detect all Qt dependencies of PEB and build the final image.  
-
-The PEB AppImage Maker script must be started from the ``{PEB_executable_directory}/sdk`` directory.  
+The PEB AppImager must be started from the ``{PEB_executable_directory}``.
 
 ## PEB AppImage Configuration Files
 
 ``{PEB_executable_directory}/resources/app/appimage/{application_name}.desktop``  
 ``{PEB_executable_directory}/resources/app/appimage/{application_name}.appdata.xml``  
 
 ``{PEB_executable_directory}/resources/app/{application_name}.desktop``  
-is mandatory for any PEB-based application which is to be packed by the PEB AppImage Maker.  
-A minimal example of а ``.desktop`` file is available [here](https://github.com/ddmitov/perl-executing-browser/blob/master/resources/app/peb-demo.desktop).  
+is mandatory for any PEB-based application which is to be packed by the PEB AppImager.  
+A minimal example of а ``.desktop`` file is available [here](https://github.com/ddmitov/perl-executing-browser/blob/master/resources/app/appimage/peb-demo.desktop).  
 ``Icon=app`` in the ``.desktop`` file must not be changed for the proper display of the application icon.  
 All registered categories in a ``.desktop`` file are available [here](https://standards.freedesktop.org/menu-spec/latest/apa.html).  
 Any ``.desktop`` file can be validated using the ``desktop-file-validate`` tool from the  ``desktop-file-utils`` package in all major Linux distributions.  
 
-The [AppStream Generator](http://output.jsbin.com/qoqukof) of [probonopd](https://github.com/probonopd) is the recommended tool for generating AppStream ``.appdata.xml`` files for PEB-based applications. An example AppStream file is available [here](https://github.com/ddmitov/perl-executing-browser/blob/master/resources/app/peb-demo.appdata.xml). An AppStream file is not mandatory, but is highly recommended.  
+The [AppStream Generator](http://output.jsbin.com/qoqukof) of [probonopd](https://github.com/probonopd) is the recommended tool for generating AppStream ``.appdata.xml`` files for PEB-based applications. An example AppStream file is available [here](https://github.com/ddmitov/perl-executing-browser/blob/master/resources/app/appimage/peb-demo.appdata.xml). An AppStream file is not mandatory, but is highly recommended.  
 
-Both PEB AppImage configuration files are put on their places in the AppImage directory tree structure by the [PEB AppImage Maker](https://github.com/ddmitov/perl-executing-browser/blob/master/sdk/appimage-maker.sh) script.  
+Both PEB AppImage configuration files are put on their places in the AppImage directory tree structure by the [PEB AppImager](https://github.com/ddmitov/perl-executing-browser/blob/master/appimager.sh) script.  
 
 ## PEB AppImage Builder Docker Container
 
 An easy building environment for PEB AppImage executables is the [PEB AppImage Builder Docker Container](https://github.com/ddmitov/perl-executing-browser/blob/master/sdk/Dockerfile).  
-To build it, type the following command in the PEB project root directory (the directory of the README.md):  
+To start it, type the following commands in the ``{PEB_executable_directory}``:  
 
 ```bash
 sudo docker build -t peb-appimage-builder .
-```
-
-To start the PEB AppImage Builder Docker Container, type the following command in the PEB project root directory:  
-
-```bash
 sudo docker container run --rm -it -v $(pwd):/opt --user $(id -u):$(id -g) peb-appimage-builder
 ```
 
 When PEB AppImage Builder Docker Container is running, type:
 
 ```bash
-cd /opt/sdk
+cd /opt/ && ./appimager.sh && exit
 ```
 
-To start the PEB AppImage Maker, type either:
-
-```bash
-./appimage-maker.sh --no-resources
-```
-
-or
-
-```bash
-./appimage-maker.sh --include-resources
-```
-
-To stop the PEB AppImage Builder Docker Container when AppImage building is complete:  
-<kbd>Ctrl</kbd> + <kbd>D</kbd>
-
 ## AppImageHub
 
 Perl Executing Browser is also listed at the [AppImageHub](https://appimage.github.io/perl-executing-browser/).  

doc/CONSTANTS.md

@@ -2,7 +2,7 @@
 
 ## Files and Folders
 
-PEB is created to work from any directory without installation and all paths used by PEB are relative to the directory of the PEB executable, labeled as ``{PEB_executable_directory}`` within this documentation. ``{PEB_executable_directory}`` may contain a C++ PEB executable or a Linux [AppImage](https://appimage.org/) with a PEB executable and its Qt libraries all packed in a single file. All names of PEB files and folders are hard-coded in C++ code and they are case-sensitive.  
+PEB is created to work from any directory without installation and all paths used by PEB are relative to the directory of the PEB executable, labeled as ``{PEB_executable_directory}`` within this documentation. All names of PEB files and folders are hard-coded in C++ code.  
 
 A typical ``{PEB_executable_directory}`` looks like this:
 

doc/INTERACTIVE.md

@@ -1,11 +1,11 @@
 # Perl Executing Browser - Interactive Perl Scripts
 
-PEB interactive Perl scripts are able to receive user input multiple times after the script is already started thus forming a bidirectional connection with PEB. Many interactive scripts can be started simultaneously in one PEB instance. One script may be started in many instances, provided that each of them has a JavaScript settings object with an unique name.  
+PEB interactive Perl scripts are able to receive user input multiple times after the script is started by waiting for new data coming either on STDIN or in a temporary file. Many interactive scripts can be started simultaneously in one PEB instance. One script may be started in many instances, provided that each of them has a JavaScript settings object with an unique name.
 
 ## Requirements for Interactive Perl Scripts
 
 * **Event Loop**  
-  Each PEB interactive Perl script must have its own event loop waiting constantly for new data on STDIN or in a temporary file for a bidirectional connection with PEB. ``AnyEvent`` is a popular Perl framework for building different types of event loops.
+  Each PEB interactive Perl script must have its own event loop waiting constantly for new data on STDIN or in a temporary file. ``AnyEvent`` is a popular Perl framework for building different types of event loops.
 
 * **No Buffering**  
   PEB interactive scripts must run without output buffering, which may prevent output before the script has ended.
@@ -32,44 +32,6 @@ PEB interactive Perl scripts are able to receive user input multiple times after
 
 ## Examples of Interactive Perl Scripts
 
-The following code shows how to start a PEB interactive Perl script right after the PEB index page is loaded:
-
-```html
-<!DOCTYPE html>
-<html>
-  <head>
-    <title>Interactive Script Demo</title>
-    <meta name="viewport" content="width=device-width, initial-scale=1">
-    <meta charset="utf-8">
-
-    <script>
-      var pebSettings = {};
-      pebSettings.autoStartScripts = ['interactive_script'];
-
-      var interactive_script = {};
-      interactive_script.scriptRelativePath = 'perl/interactive.pl';
-      interactive_script.inputData = function() {
-        return document.getElementById('interactive-script-input').value;
-      }
-
-      interactive_script.stdoutFunction = function (stdout) {
-        var container = document.getElementById('interactive-script-output');
-        container.innerText = stdout;
-      }
-    </script>
-  </head>
-
-  <body>
-    <form action="interactive_script.script">
-      <input type="text" name="input" id="interactive-script-input">
-      <input type="submit" value="Submit">
-    </form>
-
-    <div id="interactive-script-output"></div>
-  </body>
-</html>
-```
-
 The [index.htm of the demo package](https://github.com/ddmitov/perl-executing-browser/blob/master/resources/app/index.html) demonstrates how to start automatically one Perl interactive script based on STDIN input in two instances.  
 
 The [interactive.pl script of the demo package](https://github.com/ddmitov/perl-executing-browser/blob/master/resources/app/perl-scripts/interactive.pl) is an example of a Perl interactive script based on STDIN input.

doc/REQUIREMENTS.md

@@ -3,7 +3,6 @@
 ## Compile-Time Requirements
 
 The only Linux and Mac compile-time requirement of PEB is a Qt development bundle version 5.2 or higher.  
-
 PEB on Windows can be compiled only with a GCC-based MinGW Qt versions 5.2 to 5.6.
 
 Compiled and tested successfully using:
@@ -25,27 +24,6 @@ make
 
 Please note that PEB builds using the standard ``QtWebKit`` web engine are single-process applications and they consume less memory than PEB builds using the multiprocess ``QtWebEngine``.  
 
-## Compile-Time Settings
-
-PEB compile-time settings can be changed by editing the ``src/peb.pro`` project file according to the following instructions.  
-
-* Mac Bundle  
-  To make a bundle-less binary, which is the default setting:  
-
-  ```QMake
-  BUNDLE = 0
-  CONFIG -= app_bundle
-  ```
-
-  To make a bundled binary (peb.app):  
-
-  ```QMake
-  BUNDLE = 1
-  CONFIG += app_bundle
-  ```
-
-  To make automatically a bundled binary (peb.app) use the [dmg-maker.sh](sdk/dmg-maker.sh) script by Valcho Nedelchev.
-
 ## Runtime Requirements
 
 * Qt 5 libraries.  
@@ -56,12 +34,8 @@ PEB compile-time settings can be changed by editing the ``src/peb.pro`` project
 
   Tested successfully using:  
   Linux 64-bit [Relocatable Perl](https://github.com/skaji/relocatable-perl) versions 5.24.1, 5.26.1  
-  Linux 64-bit [Perlbrew](https://perlbrew.pl/) Perl versions 5.18.4, 5.23.7  
   Linux 64-bit Perl version 5.22.1  
   Windows 32-bit [Strawberry Perl](http://strawberryperl.com/) PortableZIP versions 5.12.2.0, 5.16.1.1, 5.20.2.1, 5.30.0.1  
 
-  To use a Perlbrew Perl with PEB create a symlink at:  
-  ``{PEB_executable_directory}/resources/perl/bin/perl``  
-
   PEB will use the first Perl on PATH if a relocatable Perl distribution is not found in the  
   ``{PEB_executable_directory}/resources/app/perl`` folder.

doc/SETTINGS.md

@@ -2,7 +2,7 @@
 
 ## Application Filename
 
-The executable binary file of the browser, ``peb``, ``peb.app``, ``peb.dmg`` or ``peb.exe`` by default, can be renamed with no restrictions or additional adjustments. It can take the name of the PEB-based application it is going to run.
+The executable binary file of the browser, ``peb`` or ``peb.exe`` by default, can be renamed with no restrictions or additional adjustments. It can take the name of the PEB-based application it is going to run.
 
 ## Global Settings API
 

resources/app/perl-scripts/interactive-windows.pl

@@ -6,10 +6,17 @@
 use Encode qw(decode);
 use English;
 
-use AnyEvent;
 use File::Temp;
 use JSON::PP;
 
+if (eval("require AnyEvent;")) {
+  require AnyEvent;
+  AnyEvent->import();
+} else {
+  print "AnyEvent module is missing in this Perl distribution.";
+  exit 1;
+}
+
 # Disable output buffering:
 $OUTPUT_AUTOFLUSH = 1;