Add persistent logging functionality

.gitignore

@@ -2,6 +2,7 @@
 __pycache__
 /QgisModelBaker/libili2db/bin
 /QgisModelBaker/libs/
+/QgisModelBaker/logs/
 *.orig
 i18n
 .DS_Store

QgisModelBaker/gui/export.py

@@ -17,6 +17,7 @@
  ***************************************************************************/
 """
 
+import logging
 import os
 import os.path
 import re
@@ -480,11 +481,13 @@ def accepted(self, edited_command=None):
  def print_info(self, text):
  self.txtStdout.setTextColor(QColor(LogColor.COLOR_INFO))
  self.txtStdout.append(text)
+ logging.info(text)
  QCoreApplication.processEvents()
 
  def on_stderr(self, text):
  color_log_text(text, self.txtStdout)
  self.advance_progress_bar_by_text(text)
+ logging.error(text)
  QCoreApplication.processEvents()
 
  def show_message(self, level, message):

QgisModelBaker/gui/generate_project.py

@@ -17,6 +17,7 @@
  ***************************************************************************/
 """
 import configparser
+import logging
 import os
 import re
 import webbrowser
@@ -693,11 +694,13 @@ def accepted(self, edited_command=None):
  def print_info(self, text, text_color=LogColor.COLOR_INFO):
  self.txtStdout.setTextColor(QColor(text_color))
  self.txtStdout.append(text)
+ logging.info(text)
  QCoreApplication.processEvents()
 
  def on_stderr(self, text):
  color_log_text(text, self.txtStdout)
  self.advance_progress_bar_by_text(text)
+ logging.error(text)
  QCoreApplication.processEvents()
 
  def on_process_started(self, command):

QgisModelBaker/gui/panel/log_panel.py

@@ -17,6 +17,8 @@
  ***************************************************************************/
 """
 
+import logging
+
 from PyQt5.QtWidgets import QGridLayout
 from qgis.core import Qgis
 from qgis.gui import QgsMessageBar
@@ -52,6 +54,17 @@ def print_info(self, text, text_color=LogColor.COLOR_INFO):
  self.txtStdout.setTextColor(QColor(text_color))
  self.txtStdout.append(text)
 
+ if text_color == LogColor.COLOR_INFO:
+ logging.info(text)
+ elif text_color == LogColor.COLOR_SUCCESS:
+ logging.info(text)
+ elif text_color == LogColor.COLOR_WARNING:
+ logging.warning(text)
+ elif text_color == LogColor.COLOR_FAIL:
+ logging.error(text)
+ elif text_color == LogColor.COLOR_TOPPING:
+ logging.info(text)
+
  def on_stderr(self, text):
  color_log_text(text, self.txtStdout)
 

QgisModelBaker/qgismodelbaker.py

@@ -19,6 +19,8 @@
 import configparser
 import datetime
 import locale
+import logging
+import logging.handlers
 import os
 import pathlib
 import webbrowser
@@ -27,15 +29,18 @@
 from qgis.core import QgsProject
 from qgis.PyQt.QtCore import (
  QCoreApplication,
+ QDir,
  QEvent,
+ QFileInfo,
  QLocale,
  QObject,
  QSettings,
  QStandardPaths,
  Qt,
  QTranslator,
+ QUrl,
 )
-from qgis.PyQt.QtGui import QIcon
+from qgis.PyQt.QtGui import QDesktopServices, QIcon
 from qgis.PyQt.QtWidgets import QAction, QMessageBox
 from qgis.utils import available_plugins
 
@@ -76,6 +81,7 @@ def __init__(self, iface):
  self.__validate_action = None
  self.__topping_wizard_action = None
  self.__configure_action = None
+ self.__show_logs_folder_action = None
  self.__help_action = None
  self.__about_action = None
  self.__dataset_selector_action = None
@@ -101,6 +107,9 @@ def __init__(self, iface):
  settings.beginGroup("QgisModelBaker/ili2db")
  self.ili2db_configuration.restore(settings)
 
+ self.logsDirectory = "{}/logs".format(basepath)
+ self._initLogger()
+
  self.event_filter = DropFileFilter(self)
 
  def register_event_filter(self):
@@ -194,6 +203,7 @@ def initGui(self):
  self.__configure_action = QAction(self.tr("Settings"), None)
  self.__infoseparator = QAction(None)
  self.__infoseparator.setSeparator(True)
+ self.__show_logs_folder_action = QAction(self.tr("Show log folder"), None)
  self.__help_action = QAction(self.tr("Help"), None)
  self.__about_action = QAction(self.tr("About"), None)
 
@@ -216,6 +226,7 @@ def initGui(self):
  self.show_workflow_wizard_dialog
  )
  self.__topping_wizard_action.triggered.connect(self.show_topping_wizard_dialog)
+ self.__show_logs_folder_action.triggered.connect(self.show_logs_folder)
  self.__help_action.triggered.connect(self.show_help_documentation)
  self.__about_action.triggered.connect(self.show_about_dialog)
 
@@ -238,6 +249,9 @@ def initGui(self):
  self.tr("Model Baker"), self.__configure_action
  )
  self.iface.addPluginToDatabaseMenu(self.tr("Model Baker"), self.__infoseparator)
+ self.iface.addPluginToDatabaseMenu(
+ self.tr("Model Baker"), self.__show_logs_folder_action
+ )
  self.iface.addPluginToDatabaseMenu(self.tr("Model Baker"), self.__help_action)
  self.iface.addPluginToDatabaseMenu(self.tr("Model Baker"), self.__about_action)
 
@@ -268,6 +282,9 @@ def unload(self):
  )
  self.iface.removePluginDatabaseMenu(self.tr("Model Baker"), self.__help_action)
  self.iface.removePluginDatabaseMenu(self.tr("Model Baker"), self.__about_action)
+ self.iface.removePluginDatabaseMenu(
+ self.tr("Model Baker"), self.__show_logs_folder_action
+ )
  self.toolbar.removeAction(self.__dataset_selector_action)
 
  self.iface.layerTreeView().currentLayerChanged.disconnect(
@@ -282,6 +299,7 @@ def unload(self):
  del self.__configure_action
  del self.__help_action
  del self.__about_action
+ del self.__show_logs_folder_action
  del self.__dataset_selector_action
  del self.__dataset_selector
  del self.__topping_wizard_action
@@ -417,6 +435,9 @@ def show_options_dialog(self):
  settings.beginGroup("QgisModelBaker/ili2db")
  self.ili2db_configuration.save(settings)
 
+ def show_logs_folder(self):
+ QDesktopServices.openUrl(QUrl.fromLocalFile(self.logsDirectory))
+
  def show_help_documentation(self):
  os_language = QLocale(QSettings().value("locale/userLocale")).name()[:2]
  if os_language in ["es", "de"]:
@@ -546,6 +567,33 @@ def _set_dropped_file_configuration(self):
  ),
  )
 
+ def _initLogger(self):
+ directory = QDir(self.logsDirectory)
+ if not directory.exists():
+ directory.mkpath(self.logsDirectory)
+
+ if directory.exists():
+ logfile = QFileInfo(directory, "ModelBaker.log")
+
+ # Handler for files rotation, create one log per day
+ rotationHandler = logging.handlers.TimedRotatingFileHandler(
+ logfile.filePath(), when="midnight", backupCount=10
+ )
+
+ # Configure logging
+ logging.basicConfig(
+ level=logging.DEBUG,
+ format="%(asctime)s %(levelname)-7s %(message)s",
+ handlers=[rotationHandler],
+ )
+ else:
+ logging.error(
+ "Can't create log files directory '{}'.".format(self.logsDirectory)
+ )
+
+ logging.info("")
+ logging.info("Starting Model Baker plugin version {}".format(self.__version__))
+
 
 class DropFileFilter(QObject):
  def __init__(self, parent=None):