better tempfile handling for interactive scripts

Author: ddmitov

README.md

@@ -17,9 +17,10 @@ Perl Executing Browser (PEB) is an HTML5 user interface for [Perl 5](https://www
 * REQUIREMENTS
   * [Compile-Time Requirements](./doc/REQUIREMENTS.md#compile-time-requirements)
   * [Runtime Requirements](./doc/REQUIREMENTS.md#runtime-requirements)
-* [Files and Folders](./doc/FILES.md)
+* FILES AND FOLDERS
+  * [Application Filename](./doc/FILES.md#application-filename)
+  * [Application Files and Folders](./doc/FILES.md#application-files-and-folders)
 * SETTINGS
-  * [Application Filename](./doc/SETTINGS.md#application-filename)
   * [Global Settings API](./doc/SETTINGS.md#global-settings-api)
   * [Perl Scripts API](./doc/SETTINGS.md#perl-scripts-api)
   * [Files and Folders Dialogs API](./doc/SETTINGS.md#files-and-folders-dialogs-api)

doc/FILES.md

@@ -1,6 +1,14 @@
 # Perl Executing Browser - 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. Only one folder and two file names are hard-coded in C++ code for compatibility with the [Electron](http://electron.atom.io/) framework.  
+PEB is created to work from any directory without installation and all file paths used by PEB are relative to the directory of the PEB executable, labeled as ``{PEB_executable_directory}`` within this documentation.
+
+## Application Executable
+
+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.
+
+## Application Files and Folders
+
+The following PEB files and folders are hard-coded in C++ code for faster application startup. The PEB application directory is compatible with the application directory of the [Electron](http://electron.atom.io/) framework.  
 
 A minimal ``{PEB_executable_directory}`` looks like this:
 

doc/INTERACTIVE.md

@@ -1,6 +1,6 @@
 # Perl Executing Browser - Interactive Perl Scripts
 
-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.
+PEB interactive Perl scripts are able to receive user input multiple times after the script is started by waiting for new data 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
 
@@ -32,10 +32,14 @@ PEB interactive Perl scripts are able to receive user input multiple times after
 
 ## Examples of Interactive Perl Scripts
 
-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 using STDIN input in two instances.  
+The [index.htm](https://github.com/ddmitov/perl-executing-browser/blob/master/resources/app/index.html) file of the demo package demonstrates how to start automatically one Perl interactive script 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 using STDIN input.
+The [interactive.pl](https://github.com/ddmitov/perl-executing-browser/blob/master/resources/app/perl-scripts/interactive.pl) script of the demo package is an example of a Perl interactive script using STDIN input.
 
-The [index-windows.htm of the demo package](https://github.com/ddmitov/perl-executing-browser/blob/master/resources/app/index-windows.html) demonstrates how to start automatically one Perl interactive script using a temporary file in two instances.  
+The [interactive-tempfile.pl](https://github.com/ddmitov/perl-executing-browser/blob/master/resources/app/perl-scripts/interactive-tempfile.pl) script of the demo package is an example of a Perl interactive script using a temporary file. This script creates a temporary file on startup and sends to PEB its full path in the following JSON format:  
 
-The [interactive-windows.pl](https://github.com/ddmitov/perl-executing-browser/blob/master/resources/app/perl-scripts/interactive-windows.pl) script of the demo package is an example of a Perl interactive script using a temporary file. This script creates a temporary file on startup and sends back to PEB its full path. PEB sends data to the interactive script by forwarding this path and a message text to the STDIN of a helper script, [messenger.pl](https://github.com/ddmitov/perl-executing-browser/blob/master/resources/app/perl-scripts/messenger.pl). The helper script writes all data received from PEB in the temporary file. The interactive script checks periodically its temporary file for any new messages.
+```json
+{"tempfile":"/path/to/tempfile"}
+```
+
+PEB sends data to the script by writing in its temporary file and the script checks periodically its temporary file for new messages.

doc/SETTINGS.md

@@ -1,17 +1,13 @@
 # Perl Executing Browser - Settings
 
-## Application Filename
-
-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
 
 All global PEB settings are stored in a single JavaScript object named ``pebSettings``. This name is mandatory and hard-coded in C++ code. If ``pebSettings`` JavaScript object is not found, no Perl scripts can be started.
 
 ```javascript
 var pebSettings = {};
 pebSettings.perlInterpreter = 'perl/bin/perl';
-pebSettings.onStartScripts = ['interactive_one', 'interactive_two'];
+pebSettings.autoStartScripts = ['interactive_one', 'interactive_two'];
 pebSettings.cutLabel = "Custom Cut Label";
 pebSettings.copyLabel = "Custom Copy Label";
 pebSettings.pasteLabel = "Custom Paste Label";
@@ -23,7 +19,6 @@ pebSettings.noLabel = "Custom No Label";
 pebSettings.closeConfirmation =
   'Text was entered in a form and it is going to be lost!\n' +
   'Are you sure you want to close the window?';
-pebSettings.onExitScripts = ['messenger_one', 'messenger_two'];
 ```
 
 The ``pebSettings`` JavaScript object may have the following properties:
@@ -34,7 +29,7 @@ The ``pebSettings`` JavaScript object may have the following properties:
   ``{PEB_executable_directory}/resources/app`` as a root folder.  
   If a relocatable Perl interpreter is not configured, PEB will use the first Perl interpreter on PATH.  
 
-* **onStartScripts**  
+* **autoStartScripts**  
   ``Array`` of Perl scripts that are started immediately after a local page is loaded  
 
 * **cutLabel**  
@@ -64,9 +59,6 @@ The ``pebSettings`` JavaScript object may have the following properties:
 * **closeConfirmation**  
   ``String`` displayed in a JavaScript Confirm popup box when the close button is pressed, but unsaved data in local HTML forms is detected. If no ``closeConfirmation`` object property is found, PEB shuts down all running Perl scripts and exits.  
 
-* **onExitScripts**  
-  ``Array`` of Perl scripts that are invoked before application exit  
-
 ## Perl Scripts API
 
 Every Perl script run by PEB has a JavaScript settings object with an arbitrary name and fixed object properties. The name of the JavaScript settings object with a ``.script`` extension forms a pseudo link used to start the Perl script.  
@@ -138,7 +130,7 @@ A JavaScript settings object for a Perl script run by PEB has the following prop
 
 * **inputData**  
   ``String`` or ``Function`` supplying user data as its return value  
-  ``inputData`` is written on script STDIN.  
+  ``inputData`` is written on script STDIN or in temporary file.  
 
   ``inputData`` function with no dependencies:  
 
@@ -151,7 +143,7 @@ A JavaScript settings object for a Perl script run by PEB has the following prop
 
 * **exitData**  
   ``String`` or ``Function`` supplying script exit command as its return value  
-  ``exitData`` is written on script STDIN.  
+  ``exitData`` is written on script STDIN or in temporary file.  
 
 ## Files and Folders Dialogs API
 

resources/app/index-windows.html

@@ -26,7 +26,7 @@
       // PEB page settings:
       var pebSettings = {}; // 'pebSettings' object name is hard-coded.
       pebSettings.perlInterpreter = 'perl/bin/perl';
-      pebSettings.onStartScripts = ['interactive_one', 'interactive_two'];
+      pebSettings.autoStartScripts = ['interactive_one', 'interactive_two'];
       pebSettings.cutLabel = '- Cut -';
       pebSettings.copyLabel = '- Copy -';
       pebSettings.pasteLabel = '- Paste -';
@@ -38,15 +38,14 @@
       pebSettings.closeConfirmation =
         'Text was entered in a form and it is going to be lost!\n' +
         'Are you sure you want to close the application?';
-      pebSettings.onExitScripts = ['interactive_one', 'interactive_two'];
 
       // PEB settings objects for auto-started Perl interactive scripts:
       var interactive_one = {};
-      interactive_one.scriptRelativePath = 'perl-scripts/interactive.pl';
+      interactive_one.scriptRelativePath = 'perl-scripts/interactive-tempfile.pl';
 
       interactive_one.inputData = function() {
         var data = {}
-        data.mode = "unix-epoch";
+        data.mode = "unix_epoch";
         data.user_input = document.getElementById("interactive-one-input").value;
         $('#form-one').trigger('reset');
         return JSON.stringify(data);
@@ -66,17 +65,16 @@
 
       interactive_one.exitData = function() {
         var data = {}
-        data.mode = "unix-epoch";
-        data.user_input = "peb-exit";
+        data.user_input = "exit";
         return JSON.stringify(data);
       }
 
       var interactive_two = {};
-      interactive_two.scriptRelativePath = 'perl-scripts/interactive.pl';
+      interactive_two.scriptRelativePath = 'perl-scripts/interactive-tempfile.pl';
 
       interactive_two.inputData = function() {
         var data = {}
-        data.mode = "local-time";
+        data.mode = "local_time";
         data.user_input = document.getElementById("interactive-two-input").value;
         $('#form-two').trigger('reset');
         return JSON.stringify(data);
@@ -96,8 +94,7 @@
 
       interactive_two.exitData = function() {
         var data = {}
-        data.mode = "unix-epoch";
-        data.user_input = "peb-exit";
+        data.user_input = "exit";
         return JSON.stringify(data);
       }
     </script>