unified logging of Perl scripts and JavaScript in the JavaScript console

Author: ddmitov

.gitignore

@@ -3,7 +3,6 @@ build-peb-*/
 perl/bin
 perl/lib
 src/tmp
-resources/logs/
 
 *.autosave
 Makefile

CREDITS.md

@@ -241,6 +241,7 @@ https://superuser.com/questions/188058/which-ports-are-considered-unsafe-on-chro
 https://github.com/github/linguist#overrides  
 
 ## Travis CI
+https://docs.travis-ci.com/user/reference/xenial/  
 https://stackoverflow.com/questions/25737062/travis-ci-for-a-qt5-project  
 
 ## AppImage

README.md

@@ -35,6 +35,7 @@ Perl Executing Browser (PEB) is an HTML5 user interface for [Perl 5](https://www
 * [PACKAGING](./doc/PACKAGING.md)
   * [Minimal Relocatable Perl Distribution for PEB](./doc/PACKAGING.md#minimal-relocatable-perl-distribution-for-peb)
   * [AppImage Support](./doc/PACKAGING.md#appimage-support)
+* [DEBUGGING](./doc/DEBUGGING.md)
 * [History](#history)
 * [License](./LICENSE.md)
 * [Thanks and Credits](./doc/CREDITS.md)
@@ -82,10 +83,10 @@ These are the basic steps for building your first PEB-based application using a
 * [Perl local servers can be started.](./doc/SETTINGS.md#starting-local-server)
 * [Any version of Perl 5 can be used.](./doc/REQUIREMENTS.md#runtime-requirements)
 * [Single file or multiple files, new filename, existing or new directory can be selected by user.](./doc/SETTINGS.md#selecting-files-and-folders)  
-* [Custom labels for all JavaScript popup boxes and context menus](./doc/SETTINGS.md#html-page-api)
-* [Custom icon for the main window and all dialog boxes](./doc/CONSTANTS.md#icon)
+* Unified logging of Perl scripts and JavaScript in the JavaScript console  
+* [Optional labels for all JavaScript popup boxes and context menus](./doc/SETTINGS.md#html-page-api)
+* [Optional icon for the main window and all dialog boxes](./doc/CONSTANTS.md#icon)
 * [Optional warning for unsaved data in HTML forms](./doc/SETTINGS.md#html-page-api)
-* [Optional Perl scripts error logging](./doc/CONSTANTS.md#log-files-directory)
 
 ## Security
 * PEB does not need administrative privileges, but will not refuse to use them if needed.

doc/CONSTANTS.md

@@ -30,60 +30,53 @@ A typical ``{PEB_executable_directory}`` looks like this:
   The ``bin`` subdirectory must contain the Perl interpreter.  
   The ``lib`` subdirectory must contain all Perl modules used by PEB Perl applications.  
 
-* **Perl Interpreter:**  
-  Relocatable Perl interpreter, if present, must be located in the ``{PEB_executable_directory}/perl/bin`` folder.  
-  The Perl interpreter must be named ``perl`` on Linux and Mac machines and ``wperl.exe`` on Windows machines.  
-  If a relocatable Perl interpreter is not found, PEB will use the first Perl interpreter on PATH.  
+  * **Perl Interpreter:**  
+    Relocatable Perl interpreter, if present, must be located in the ``{PEB_executable_directory}/perl/bin`` folder.  
+    The Perl interpreter must be named ``perl`` on Linux and Mac machines and ``wperl.exe`` on Windows machines.  
+    If a relocatable Perl interpreter is not found, PEB will use the first Perl interpreter on PATH.  
 
-* **Perl Modules Directory:**  
-  All Perl modules found in the ``{PEB_executable_directory}/perl/lib`` folder are accessible via the ``PERL5LIB`` environment variable for all Perl applications executed by PEB.  
+  * **Perl Modules Directory:**  
+    All Perl modules found in the ``{PEB_executable_directory}/perl/lib`` folder are accessible via the ``PERL5LIB`` environment variable for all Perl applications executed by PEB.  
 
 * **Resources Directory:**  
   The resources directory must contain the ``app`` subdirectory with all necessary application files.  
-  ``data`` and ``logs`` subdirectories are optional, as well as the application icon file: ``app.png``  
+  ``data`` subdirectory and the application icon file ``app.png`` are optional.  
   The resources directory path must be: ``{PEB_executable_directory}/resources``  
 
-* **Application Directory:**  
-  All Perl application files must be located within this folder.  
-  The application directory path must be: ``{PEB_executable_directory}/resources/app``  
-  PEB application directory is labeled as ``{PEB_app_directory}`` within this documentation.  
-  By default the working directory of all Perl scripts run by PEB is the application directory.  
-
-  PEB application directory pathname is compatible with the [Electron](http://electron.atom.io/) framework.  
-  [Epigraphista](https://github.com/ddmitov/epigraphista) is an application which is runnable by both PEB and [Electron](http://electron.atom.io/).  
-
-* **Start File:**  
-  PEB starts with one of the following files:  
-  * ``{PEB_executable_directory}/resources/app/index.html``  
-  * ``{PEB_executable_directory}/resources/app/local-server.json``  
-
-  If both files are present, ``index.html`` takes precedence.  
-  If ``index.html`` is missing, ``local-server.json`` is used if available.  
-  If both entry files are missing, an error message is displayed.  
-
-<a name="icon"></a>
-* **Icon:**
-  A PEB-based application may have its own icon and the pathname must be:  
-  ``{PEB_executable_directory}/resources/app.png``  
-
-  If this file is found during application startup, it is used as the icon of the application and all dialog boxes.  
-  If this file is not found, the default icon embedded in the resources of the browser binary is used.
-
-* **Data Directory:**  
-  Data directory may contain any writable files used or produced by a PEB-based application.  
-  The data directory path must be: ``{PEB_executable_directory}/resources/data``  
-  Perl scripts can access this folder using the environment variable ``PEB_DATA_DIR``:
-
-  ```perl
-  my $data_directory = $ENV{'PEB_DATA_DIR'};
-  ```
-<a name="log-files-directory"></a>
-* **Log Files Directory:**  
-  When log files directory is found during application startup, PEB assumes that logging is required and a separate log file is created for every browser session following the naming convention:  
-  ``{executable_name}-started-at-{four_digit_year}-{month}-{day}--{hour}-{minute}-{second}.log``  
-
-  The log files directory path must be: ``{PEB_executable_directory}/resources/logs``  
-  PEB will not create log files directory on its own and if it is missing, no logs will be written.
+  * **Application Directory:**  
+    All Perl application files must be located within this folder.  
+    The application directory path must be: ``{PEB_executable_directory}/resources/app``  
+    PEB application directory is labeled as ``{PEB_app_directory}`` within this documentation.  
+    By default the working directory of all Perl scripts run by PEB is the application directory.  
+
+    PEB application directory pathname is compatible with the [Electron](http://electron.atom.io/) framework.  
+    [Epigraphista](https://github.com/ddmitov/epigraphista) is an application which is runnable by both PEB and [Electron](http://electron.atom.io/).  
+
+  * **Start File:**  
+    PEB starts with one of the following files:  
+    * ``{PEB_executable_directory}/resources/app/index.html``  
+    * ``{PEB_executable_directory}/resources/app/local-server.json``  
+
+    If both files are present, ``index.html`` takes precedence.  
+    If ``index.html`` is missing, ``local-server.json`` is used if available.  
+    If both entry files are missing, an error message is displayed.  
+
+  <a name="icon"></a>
+  * **Icon:**
+    A PEB-based application may have its own icon and the pathname must be:  
+    ``{PEB_executable_directory}/resources/app.png``  
+
+    If this file is found during application startup, it is used as the icon of the application and all dialog boxes.  
+    If this file is not found, the default icon embedded in the resources of the browser binary is used.
+
+  * **Data Directory:**  
+    Data directory may contain any writable files used or produced by a PEB-based application.  
+    The data directory path must be: ``{PEB_executable_directory}/resources/data``  
+    Perl scripts can access this folder using the environment variable ``PEB_DATA_DIR``:
+
+    ```perl
+    my $data_directory = $ENV{'PEB_DATA_DIR'};
+    ```
 
 ## Functional Pseudo Filenames
 * **About PEB dialog:** ``about-browser.function``

src/main.cpp

@@ -16,8 +16,6 @@
 */
 
 #include <QtWidgets/QApplication>
-#include <QDateTime>
-#include <QDebug>
 #include <QTextCodec>
 #include <QtGlobal>
 
@@ -37,54 +35,6 @@
 #endif
 #endif
 
-// ==============================
-// MESSAGE HANDLER FOR REDIRECTING
-// PROGRAM MESSAGES TO A LOG FILE:
-// ==============================
-// Implementation of an idea proposed by Valcho Nedelchev.
-void customMessageHandler(QtMsgType type,
-                          const QMessageLogContext &context,
-                          const QString &message)
-{
-    Q_UNUSED(context);
-    QString dateAndTime =
-            QDateTime::currentDateTime().toString("dd/MM/yyyy hh:mm:ss");
-    QString text = QString("[%1] ").arg(dateAndTime);
-
-    switch (type) {
-#if QT_VERSION >= 0x050500
-    case QtInfoMsg:
-        text += QString("{Log} %1").arg(message);
-        break;
-#endif
-    case QtDebugMsg:
-        text += QString("{Log} %1").arg(message);
-        break;
-    case QtWarningMsg:
-        text += QString("{Warning} %1").arg(message);
-        break;
-    case QtCriticalMsg:
-        text += QString("{Critical} %1").arg(message);
-        break;
-    case QtFatalMsg:
-        text += QString("{Fatal} %1").arg(message);
-        abort();
-        break;
-    }
-
-    // A separate log file is created for every browser session.
-    // Application start date and time are appended to the binary file name.
-    QFile logFile(qApp->property("logDirFullPath").toString()
-                  + "/"
-                  + QFileInfo(QApplication::applicationFilePath()).baseName()
-                  + "-started-at-"
-                  + qApp->property("applicationStartDateAndTime").toString()
-                  + ".log");
-    logFile.open(QIODevice::WriteOnly | QIODevice::Append | QIODevice::Text);
-    QTextStream textStream(&logFile);
-    textStream << text << endl;
-}
-
 // ==============================
 // MAIN APPLICATION DEFINITION:
 // ==============================
@@ -238,40 +188,19 @@ int main(int argc, char **argv)
         QApplication::setWindowIcon(icon);
     }
 
-    // ==============================
-    // Logging:
-    // ==============================
-    // 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 may be seen inside Qt Creator during development.
-
-    QString logDirFullPath = resourcesDirectory + "/logs";
-
-    QDir logDir(logDirFullPath);
-    if (logDir.exists()) {
-        application.setProperty("logDirFullPath", logDirFullPath);
-
-        // Application start date and time for logging:
-        QString applicationStartDateAndTime =
-                QDateTime::currentDateTime().toString("yyyy-MM-dd--hh-mm-ss");
-        application.setProperty("applicationStartDateAndTime",
-                                applicationStartDateAndTime);
-
-        // Install message handler for redirecting all messages to a log file:
-        qInstallMessageHandler(customMessageHandler);
-    }
-
     // ==============================
     // MAIN WINDOW INITIALIZATION:
     // ==============================
     QMainBrowserWindow mainWindow;
+    mainWindow.setWindowIcon(icon);
+    mainWindow.setCentralWidget(mainWindow.webViewWidget);
 
-    // Application property necessary when
-    // closing the browser window is requested using
-    // the special window closing URL.
+    // Application property used when closing the browser window is requested:
     qApp->setProperty("windowCloseRequested", false);
 
+    // ==============================
+    // Signals and slots:
+    // ==============================
     // Signal and slot for setting the main window title:
     QObject::connect(mainWindow.webViewWidget,
                      SIGNAL(titleChanged(QString)),
@@ -298,20 +227,6 @@ int main(int argc, char **argv)
     QObject::connect(qApp, SIGNAL(aboutToQuit()),
                      &mainWindow, SLOT(qExitApplicationSlot()));
 
-    // ==============================
-    // Basic program information:
-    // ==============================
-    qDebug() << "Application version:"
-             << application.applicationVersion().toLatin1().constData();
-    qDebug() << "Qt version:" << QT_VERSION_STR;
-    qDebug() << "Perl interpreter:" << perlInterpreter;
-
-    // ==============================
-    // Window initialization:
-    // ==============================
-    mainWindow.setWindowIcon(icon);
-    mainWindow.setCentralWidget(mainWindow.webViewWidget);
-
     // ==============================
     // Start file:
     // ==============================
@@ -374,7 +289,6 @@ int main(int argc, char **argv)
             } else {
                 mainWindow.qDisplayError(
                             QString("Local server file is not found."));
-                qDebug() << "Local server file is not found.";
             }
 
             // Local server port:
@@ -387,7 +301,6 @@ int main(int argc, char **argv)
                 localServerSettingsCorrect = false;
                 mainWindow.qDisplayError(
                             QString("No local server port is set."));
-                qDebug() << "No local server port is set.";
             }
 
             if (firstPort > 0) {
@@ -406,8 +319,6 @@ int main(int argc, char **argv)
                 if (portScanner->portScannerError.length() > 0) {
                     mainWindow.qDisplayError(
                                 portScanner->portScannerError);
-                    qDebug() << "Port error:"
-                             << portScanner->portScannerError;
                 }
             }
 
@@ -433,8 +344,6 @@ int main(int argc, char **argv)
             mainWindow.qDisplayError(
                         localServerSettingsFilePath + "<br>" +
                         "is empty or malformed.");
-            qDebug() << localServerSettingsFilePath
-                     << " is empty or malformed.";
         }
 
         // Local server has to be started as
@@ -461,7 +370,6 @@ int main(int argc, char **argv)
     if (startFileFound == false) {
         mainWindow.qDisplayError(
                     QString("No start page or local server is found."));
-        qDebug() << "No start page or local server is found.";
     }
 
     return application.exec();

src/script-handler.cpp

@@ -16,8 +16,6 @@
 */
 
 #include <QJsonObject>
-#include <QDebug>
-#include <QDir>
 
 #include "script-handler.h"
 
@@ -27,10 +25,6 @@
 QScriptHandler::QScriptHandler(QJsonObject scriptJsonObject)
     : QObject(0)
 {
-    if (scriptJsonObject.length() == 1) {
-        qDebug() << "No script settings!";
-        return;
-    }
 
     scriptId = scriptJsonObject["id"].toString();
 
@@ -40,12 +34,6 @@ QScriptHandler::QScriptHandler(QJsonObject scriptJsonObject)
                 scriptJsonObject["scriptRelativePath"].toString();
     }
 
-    QFile file(scriptFullFilePath);
-    if (!file.exists()) {
-        qDebug() << "File not found:" << scriptFullFilePath;
-        return;
-    }
-
     QString scriptInput;
     if (scriptJsonObject["scriptInput"].toString().length() > 0) {
         scriptInput = scriptJsonObject["scriptInput"].toString();

src/script-handler.h

@@ -32,7 +32,6 @@ class QScriptHandler : public QObject
     void displayScriptOutputSignal(QString scriptId,
                                    QString output);
     void scriptFinishedSignal(QString scriptId,
-                              QString scriptFullFilePath,
                               QString scriptAccumulatedErrors);
 
 public slots:
@@ -48,13 +47,11 @@ public slots:
     {
         QString scriptErrors = scriptProcess.readAllStandardError();
         scriptAccumulatedErrors.append(scriptErrors);
-        scriptAccumulatedErrors.append("\n");
     }
 
     void qScriptFinishedSlot()
     {
         emit scriptFinishedSignal(scriptId,
-                                  scriptFullFilePath,
                                   scriptAccumulatedErrors);
 
         scriptProcess.close();

src/webengine-main-window.h

@@ -70,7 +70,6 @@ public slots:
             localServerTester->stop();
 
             qDisplayError(QString("Local server timed out."));
-            qDebug() << "Local server timed out.";
         }
     }
 
@@ -105,8 +104,6 @@ public slots:
 
     void qExitApplicationSlot()
     {
-        qDebug() << "Application exited normally.";
-
         QApplication::exit();
     }