graceful exit for all interactive scripts

Author: ddmitov

doc/SETTINGS.md

@@ -10,7 +10,7 @@ All local HTML page settings are stored in a single JavaScript object named ``pe
 
 ```javascript
 var pebSettings = {};
-pebSettings.autoStartScripts = ['interactive_one', 'interactive_two'];
+pebSettings.onStartScripts = ['interactive_one', 'interactive_two'];
 pebSettings.cutLabel = "Custom Cut Label";
 pebSettings.copyLabel = "Custom Copy Label";
 pebSettings.pasteLabel = "Custom Paste Label";
@@ -22,11 +22,12 @@ 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 = ['interactive_one', 'interactive_two'];
 ```
 
 The ``pebSettings`` JavaScript object may have the following properties:
 
-* **autoStartScripts**  
+* **onStartScripts**  
   ``Array`` of Perl scripts that are started immediately after a local page is loaded  
 
 * **cutLabel**  
@@ -54,7 +55,10 @@ The ``pebSettings`` JavaScript object may have the following properties:
   ``String`` displayed as a label for the 'No' button on JavaScript Confirm popup box.
 
 * **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.
+  ``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
 
@@ -114,7 +118,7 @@ A JavaScript settings object for a Perl script run by PEB has the following prop
   ```
 
   Please note that many Perl scripts do not give their STDOUT data in a single shot.  
-  If several chunks of output have to be combined, this should also be done at JavaScript level:  
+  If several chunks of output have to be combined, this should be done at JavaScript level:  
 
   ```javascript
   var accumulatedOutput;
@@ -138,6 +142,11 @@ 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.  
+
+
 ## Interactive Perl Scripts
 
 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. 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.  

resources/app/index-windows.html

@@ -9,7 +9,7 @@
     <script>
       // PEB page settings:
       var pebSettings = {}; // 'pebSettings' object name is hard-coded.
-      pebSettings.autoStartScripts = ['interactive_one', 'interactive_two'];
+      pebSettings.onStartScripts = ['interactive_one', 'interactive_two'];
       pebSettings.cutLabel = '- Cut -';
       pebSettings.copyLabel = '- Copy -';
       pebSettings.pasteLabel = '- Paste -';
@@ -21,6 +21,7 @@
       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 = ['messenger_one', 'messenger_two'];
 
       // PEB settings objects for auto-started Perl interactive scripts:
       var messenger_one = {};
@@ -34,6 +35,11 @@
         return JSON.stringify(messenger_one.message);
       }
 
+      messenger_one.exitData = function() {
+        messenger_one.message.user_input = "peb-exit";
+        return JSON.stringify(messenger_one.message);
+      }
+
       var messenger_two = {};
       messenger_two.scriptRelativePath = 'perl-scripts/messenger.pl';
       messenger_two.message = {};
@@ -45,6 +51,11 @@
         return JSON.stringify(messenger_two.message);
       }
 
+      messenger_two.exitData = function() {
+        messenger_two.message.user_input = "peb-exit";
+        return JSON.stringify(messenger_two.message);
+      }
+
       var interactive_one = {};
       interactive_one.scriptRelativePath = 'perl-scripts/interactive-windows.pl';
 
@@ -156,11 +167,13 @@
                 <li>
                   <a href="javascript:location.reload();">Reload</a>
                 </li>
+
+                <li>
+                  <a href="https://www.google.com/">Google</a>
+                </li>
               </ul>
             </li>
 
-            <li><a href="https://www.google.com/">Google</a></li>
-
             <li><a href="about.function">About</a></li>
           </ul>
         </div>

resources/app/index.html

@@ -9,7 +9,7 @@
     <script>
       // PEB page settings:
       var pebSettings = {}; // 'pebSettings' object name is hard-coded.
-      pebSettings.autoStartScripts = ['interactive_one', 'interactive_two'];
+      pebSettings.onStartScripts = ['interactive_one', 'interactive_two'];
       pebSettings.cutLabel = '- Cut -';
       pebSettings.copyLabel = '- Copy -';
       pebSettings.pasteLabel = '- Paste -';
@@ -21,17 +21,18 @@
       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.inputData = function() {
-        var input = {}
-        input.mode = "unix-epoch";
-        input.user_input = document.getElementById("interactive-one-input").value;
+        var data = {}
+        data.mode = "unix-epoch";
+        data.user_input = document.getElementById("interactive-one-input").value;
         $('#form-one').trigger('reset');
-        return JSON.stringify(input);
+        return JSON.stringify(data);
       }
 
       interactive_one.stdoutFunction = function (stdout) {
@@ -46,15 +47,22 @@
         target.innerHTML = html;
       }
 
+      interactive_one.exitData = function() {
+        var data = {}
+        data.mode = "unix-epoch";
+        data.user_input = "peb-exit";
+        return JSON.stringify(data);
+      }
+
       var interactive_two = {};
       interactive_two.scriptRelativePath = 'perl-scripts/interactive.pl';
 
       interactive_two.inputData = function() {
-        var input = {}
-        input.mode = "local-time";
-        input.user_input = document.getElementById("interactive-two-input").value;
-        $('#form-one').trigger('reset');
-        return JSON.stringify(input);
+        var data = {}
+        data.mode = "local-time";
+        data.user_input = document.getElementById("interactive-two-input").value;
+        $('#form-two').trigger('reset');
+        return JSON.stringify(data);
       }
 
       interactive_two.stdoutFunction = function (stdout) {
@@ -68,6 +76,13 @@
         };
         target.innerHTML = html;
       }
+
+      interactive_two.exitData = function() {
+        var data = {}
+        data.mode = "unix-epoch";
+        data.user_input = "peb-exit";
+        return JSON.stringify(data);
+      }
     </script>
 
     <script src="jquery/jquery-1.12.4.min.js"></script>
@@ -132,11 +147,13 @@
                 <li>
                   <a href="javascript:location.reload();">Reload</a>
                 </li>
+
+                <li>
+                  <a href="https://www.google.com/">Google</a>
+                </li>
               </ul>
             </li>
 
-            <li><a href="https://www.google.com/">Google</a></li>
-
             <li><a href="about.function">About</a></li>
           </ul>
         </div>

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

@@ -60,6 +60,10 @@
       1;
     };
 
+    if ($user_input =~ "peb-exit") {
+      shutdown_procedure();
+    }
+
     my $time;
 
     if ($mode =~ "unix-epoch") {

resources/app/perl-scripts/interactive.pl

@@ -35,6 +35,10 @@
 
     my $input = get_input($stdin);
     $user_input  = decode('UTF-8', $input->{user_input});
+
+    if ($user_input =~ "peb-exit") {
+      shutdown_procedure();
+    }
   }
 );
 

src/resources/peb.js

@@ -2,54 +2,60 @@
 var peb = {};
 
 peb.getPageSettings = function() {
-  if (window[pebSettings] !== null) {
-    return JSON.stringify(pebSettings);
-  }
+    if (window[pebSettings] !== null) {
+        return JSON.stringify(pebSettings);
+    }
 }
 
 peb.getDialogSettings = function(dialogSettings) {
-  if (window[dialogSettings] !== null) {
-    return JSON.stringify(dialogSettings);
-  }
+    if (window[dialogSettings] !== null) {
+        return JSON.stringify(dialogSettings);
+    }
 }
 
 peb.getScriptSettings = function(scriptSettings) {
-  if (window[scriptSettings] !== null) {
-    if (typeof scriptSettings.inputData === 'function') {
-      scriptSettings.scriptInput = scriptSettings.inputData();
-    } else {
-      scriptSettings.scriptInput = scriptSettings.inputData;
+    if (window[scriptSettings] !== null) {
+        if (typeof scriptSettings.inputData === 'function') {
+            scriptSettings.scriptInput = scriptSettings.inputData();
+        } else {
+            scriptSettings.scriptInput = scriptSettings.inputData;
+        }
+
+        if (typeof scriptSettings.exitData === 'function') {
+            scriptSettings.exitCommand = scriptSettings.exitData();
+        } else {
+            scriptSettings.exitCommand = scriptSettings.exitData;
+        }
+
+        return JSON.stringify(scriptSettings);
     }
-
-    return JSON.stringify(scriptSettings);
-  }
 }
 
 peb.checkUserInputBeforeClose = function() {
-  var textEntered = false;
-  var close = true;
+    var textEntered = false;
+    var close = true;
 
-  var textFields = [];
-  textFields = document.getElementsByTagName('textarea');
+    var textFields = [];
+    textFields = document.getElementsByTagName('textarea');
 
-  for (index = 0; index < textFields.length; index++) {
-    if (textFields[index].value.length > 0) {
-      textEntered = true;
+    for (index = 0; index < textFields.length; index++) {
+        if (textFields[index].value.length > 0) {
+            textEntered = true;
+        }
     }
-  }
 
-  var inputBoxes = [];
-  inputBoxes = document.querySelectorAll('input[type=text]');
+    var inputBoxes = [];
+    inputBoxes = document.querySelectorAll('input[type=text]');
 
-  for (index = 0; index < inputBoxes.length; index++) {
-    if (inputBoxes[index].value.length > 0) {
-      textEntered = true;
+    for (index = 0; index < inputBoxes.length; index++) {
+        if (inputBoxes[index].value.length > 0) {
+            textEntered = true;
+        }
     }
-  }
 
-  if (textEntered === true && pebSettings.closeConfirmation !== null) {
-      close = confirm(pebSettings.closeConfirmation);
-  }
+    if (textEntered === true && pebSettings.closeConfirmation !== null) {
+        close = confirm(pebSettings.closeConfirmation);
+    }
 
-  return close;
+    return close;
 }

src/webengine-page.cpp

@@ -52,10 +52,6 @@ QPage::QPage()
     QObject::connect(this, SIGNAL(loadFinished(bool)),
                      this, SLOT(qPageLoadedSlot(bool)));
 
-    // Signal and slot for closing window from JavaScript:
-    QObject::connect(this, SIGNAL(windowCloseRequested()),
-                     this, SLOT(qCloseAllScriptsSlot()));
-
     // Default dialog and context menu labels:
     okLabel = "Ok";
     cancelLabel = "Cancel";
@@ -95,7 +91,7 @@ bool QPage::acceptNavigationRequest(const QUrl &url,
 
                 aboutText.replace("APPLICATION_VERSION",
                                   QApplication::applicationVersion());
-                aboutText.replace("QT_VERSION", QT_VERSION_STR, QT_);
+                aboutText.replace("QT_VERSION", QT_VERSION_STR);
 
                 QPixmap icon(32, 32);
                 icon.load(":/icon/camel.png");