Merge pull request #512 from YIO-Remote/feature/logger-rewrite

Logger rewrite

Author: zehnm

.clang-format

@@ -9,3 +9,6 @@ ColumnLimit: 120
 
 AccessModifierOffset: -3
 AlignConsecutiveDeclarations: true
+
+AllowShortFunctionsOnASingleLine: Inline
+

.github/workflows/build.yml

@@ -69,7 +69,7 @@
         - name: Get artifact version
           run: |
             read -r APP_VERSION < binaries/version.txt
-            echo "::set-env name=APP_VERSION::$APP_VERSION"
+            echo "APP_VERSION=$APP_VERSION" >> $GITHUB_ENV
 
         - name: Upload build artefacts
           uses: actions/upload-artifact@v2
@@ -93,8 +93,8 @@
 
         - name: Get timestamp
           run: |
-            echo "::set-env name=TIMESTAMP::$(date +"%Y%m%d_%H%M%S")"
-  
+            echo "TIMESTAMP=$(date +"%Y%m%d_%H%M%S")" >> $GITHUB_ENV
+
         - name: Create GitHub development build archives
           if: "!contains(github.ref, 'tags/v')"
           run: |
@@ -128,4 +128,4 @@
             files: |
               *.tar
               ${{ env.HASH_FILENAME }}
-  
+  

.github/workflows/build_desktop.yml

@@ -21,7 +21,7 @@ env:
   APP_PRO: remote.pro
   APP_NAME: app
   PROJECT_NAME: remote-software
-  # Build artifact output path. Used to set project specific YIO_BIN env var in 'qt_creator' step.
+  # Build artifact output path. Used to set project specific YIO_BIN env var.
   BIN_OUTPUT_PATH: "binaries"
   DEBUG_OUTPUT: "false"
 
@@ -56,6 +56,7 @@ jobs:
         # history required to determine number of commits since last release tag
         fetch-depth: 0
         path: ${{ env.PROJECT_NAME }}
+
     - name: Fetch all tags to determine version
       run: |
         cd ${{ env.PROJECT_NAME }}
@@ -66,7 +67,11 @@ jobs:
       run: |
         YIO_INTG_LIB_VERSION=$(cat "${GITHUB_WORKSPACE}/${{ env.PROJECT_NAME }}/dependencies.cfg" | awk '/^integrations.library:/{print $2}')
         echo "Required integrations.library: $YIO_INTG_LIB_VERSION"
-        echo "::set-env name=YIO_INTG_LIB_VERSION::$YIO_INTG_LIB_VERSION"
+        echo "YIO_INTG_LIB_VERSION=$YIO_INTG_LIB_VERSION" >> $GITHUB_ENV
+
+    - name: Set build output directory
+      shell: bash
+      run: echo "YIO_BIN=${GITHUB_WORKSPACE}/${BIN_OUTPUT_PATH}" >> $GITHUB_ENV  
 
     - name: Checkout integrations.library
       uses: actions/checkout@v2
@@ -80,6 +85,8 @@ jobs:
       run: |
         sudo apt update
         sudo apt install libavahi-client-dev libgl1-mesa-dev g++-8 libstdc++-8-dev
+        # Qt Creator library path is required for Qt linguist tools. Otherwise we'll get libicui18n.so.56 not found!
+        echo "LD_LIBRARY_PATH=${GITHUB_WORKSPACE}/qtcreator/lib/Qt/lib:${LD_LIBRARY_PATH}" >> $GITHUB_ENV
 
     - name: Download Qt Creator
       id: qt_creator
@@ -95,22 +102,13 @@ jobs:
             set(qtc_platform "windows_vs2015_64")
           elseif ("${{ matrix.config.environment_script }}" MATCHES "vcvars64.bat")
             set(qtc_platform "windows_msvc2017_x64")
-          elseif ("${{ matrix.config.environment_script }}" MATCHES "vcvars32.bat")
-            set(qtc_platform "windows_msvc2017_x86")
           endif()
         elseif ("${{ runner.os }}" STREQUAL "Linux")
           set(qtc_platform "linux_gcc_64_rhel72")
         elseif ("${{ runner.os }}" STREQUAL "macOS")
           set(qtc_platform "mac_x64")
         endif()
 
-        # Set YIO_BIN env var for other steps
-        message("::set-env name=YIO_BIN::${qtc_output_directory}")
-        # Qt Creator library path is required for Qt linguist tools. Otherwise we'll get libicui18n.so.56 not found!
-        if ("${{ runner.os }}" STREQUAL "Linux")
-          message("::set-env name=LD_LIBRARY_PATH::$ENV{GITHUB_WORKSPACE}/qtcreator/lib/Qt/lib:$ENV{LD_LIBRARY_PATH}")
-        endif()
-
         file(TO_CMAKE_PATH "$ENV{GITHUB_WORKSPACE}/../downloads" download_dir)
 
         file(MAKE_DIRECTORY ${qtc_output_directory})
@@ -181,9 +179,6 @@ jobs:
           if ("${{ matrix.config.environment_script }}" MATCHES "vcvars64.bat")
             set(qt_package_name "qt.qt5.${qt_version_dotless}.win64_msvc2017_64")
             set(qt_dir_prefix "${qt_version}/msvc2017_64")
-          elseif ("${{ matrix.config.environment_script }}" MATCHES "vcvars32.bat")
-            set(qt_package_name "qt.qt5.${qt_version_dotless}.win32_msvc2017")
-            set(qt_dir_prefix "${qt_version}/msvc2017")
           else()
           endif()
         elseif ("${{ runner.os }}" STREQUAL "Linux")
@@ -223,11 +218,6 @@ jobs:
         set(package_suffix ${CMAKE_MATCH_2})
         string(REPLACE "-debug-symbols" "" package_suffix "${package_suffix}")
 
-        # Workaround for CMake's greedy regex
-        if ("${{ matrix.config.environment_script }}" MATCHES "vcvars32.bat")
-          string(REPLACE "X86_64" "X86" package_suffix "${package_suffix}")
-        endif()
-
         file(MAKE_DIRECTORY qt5)
 
         # Save the path for other steps
@@ -298,7 +288,7 @@ jobs:
     - name: Configure
       shell: cmake -P {0}
       run: |
-        if ("${{ runner.os }}" STREQUAL "Windows" AND NOT "x${{ matrix.config.environment_script }}" STREQUAL "x")
+        if ("${{ runner.os }}" STREQUAL "Windows")
           execute_process(
             COMMAND "${{ matrix.config.environment_script }}" && set
             OUTPUT_FILE environment_script_output.txt
@@ -307,9 +297,6 @@ jobs:
           foreach(line IN LISTS output_lines)
             if (line MATCHES "^([a-zA-Z0-9_-]+)=(.*)$")
               set(ENV{${CMAKE_MATCH_1}} "${CMAKE_MATCH_2}")
-
-              # Set for other steps
-              message("::set-env name=${CMAKE_MATCH_1}::${CMAKE_MATCH_2}")
             endif()
           endforeach()
         endif()
@@ -342,6 +329,12 @@ jobs:
       shell: cmake -P {0}
       run: |
         if ("${{ runner.os }}" STREQUAL "Windows")
+          file(STRINGS environment_script_output.txt output_lines)
+          foreach(line IN LISTS output_lines)
+            if (line MATCHES "^([a-zA-Z0-9_-]+)=(.*)$")
+              set(ENV{${CMAKE_MATCH_1}} "${CMAKE_MATCH_2}")
+            endif()
+          endforeach()
           set(ENV{PATH} "${{ steps.qt.outputs.qt_dir }}/bin/;$ENV{PATH}")
         else()
           set(ENV{PATH} "${{ steps.qt.outputs.qt_dir }}/bin/:$ENV{PATH}")
@@ -371,9 +364,9 @@ jobs:
     - name: Set build artifact name
       shell: bash
       run: |
-        APP_VERSION=$(cat ${{ env.YIO_BIN }}/version.txt | awk '{print $1}')
+        APP_VERSION=$(cat "${{ env.YIO_BIN }}/version.txt" | awk '{print $1}')
         echo "App version: $APP_VERSION"
-        echo "::set-env name=ARTIFACT_NAME::${{ env.APP_NAME }}-$APP_VERSION-Qt${{ env.QT_VERSION }}-${{ matrix.config.artifact }}-${{ matrix.config.build }}"
+        echo "ARTIFACT_NAME=${{ env.APP_NAME }}-$APP_VERSION-Qt${{ env.QT_VERSION }}-${{ matrix.config.artifact }}-${{ matrix.config.build }}" >> $GITHUB_ENV
 
     - uses: actions/upload-artifact@v1
       id: upload_artifact

.github/workflows/code_guidelines.yml

@@ -13,12 +13,13 @@ on:
 
 jobs:
   cpplint:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-python@v1
+      - uses: actions/setup-python@v2
+        with:
+          python-version: '3.8'
       - run: python -m pip install cpplint
-      - run: sudo update-alternatives --install /usr/bin/python python ${pythonLocation}/bin/python3.8 10
       - name: cpplint
         shell: python
         run: |

components/media_player/sources/utils_mediaplayer.cpp

@@ -22,12 +22,8 @@
 
 #include "utils_mediaplayer.h"
 
-#include <QDebug>
-#include <QLoggingCategory>
-
 #include "../sources/config.h"
-
-static Q_LOGGING_CATEGORY(CLASS_LC, "mediaplayer utils");
+#include "../sources/logging.h"
 
 MediaPlayerUtils::MediaPlayerUtils(QObject *parent) : QObject(parent) {
     // ADD IMAGE PROVIDER
@@ -36,7 +32,7 @@ MediaPlayerUtils::MediaPlayerUtils(QObject *parent) : QObject(parent) {
     m_imageProviderId = QUuid::createUuid().toString().replace("{", "").replace("}", "");
     m_imageProvider   = new MediaPlayerUtilsImageProvider();
     m_engine->addImageProvider(m_imageProviderId, m_imageProvider);
-    qCDebug(CLASS_LC()) << this << "Image provider added:" << m_imageProviderId << m_imageProvider;
+    qCDebug(lcMediaPlayer) << this << "Image provider added:" << m_imageProviderId << m_imageProvider;
 
     m_startTimer = new QTimer(this);
     m_startTimer->setSingleShot(true);
@@ -52,31 +48,31 @@ MediaPlayerUtils::MediaPlayerUtils(QObject *parent) : QObject(parent) {
 }
 
 MediaPlayerUtils::~MediaPlayerUtils() {
-    qCDebug(CLASS_LC()) << this << "Destructor called";
+    qCDebug(lcMediaPlayer) << this << "Destructor called";
     m_engine->removeImageProvider(m_imageProviderId);
-    qCDebug(CLASS_LC()) << this << "Destructor: Image provider removed:" << m_imageProviderId;
+    qCDebug(lcMediaPlayer) << this << "Destructor: Image provider removed:" << m_imageProviderId;
 
     if (m_worker != nullptr) {
-        qCDebug(CLASS_LC()) << this << "Destructor: Worker was not null";
+        qCDebug(lcMediaPlayer) << this << "Destructor: Worker was not null";
         m_worker->disconnect();
-        qCDebug(CLASS_LC()) << this << "Destructor: Signal disconnected from Worker class";
+        qCDebug(lcMediaPlayer) << this << "Destructor: Signal disconnected from Worker class";
         m_worker->deleteLater();
         m_worker = nullptr;
-        qCDebug(CLASS_LC()) << this << "Destructor: Worker deleted";
+        qCDebug(lcMediaPlayer) << this << "Destructor: Worker deleted";
     }
 
     if (m_workerThread != nullptr) {
-        qCDebug(CLASS_LC()) << this << "Destructor: WorkerThread was not null";
+        qCDebug(lcMediaPlayer) << this << "Destructor: WorkerThread was not null";
         if (m_workerThread->isRunning()) {
-            qCDebug(CLASS_LC()) << this << "Destructor: WorkerThread is running";
+            qCDebug(lcMediaPlayer) << this << "Destructor: WorkerThread is running";
             m_workerThread->quit();
-            qCDebug(CLASS_LC()) << this << "Destructor: WorkerThread exit was called";
+            qCDebug(lcMediaPlayer) << this << "Destructor: WorkerThread exit was called";
             m_workerThread->wait();
-            qCDebug(CLASS_LC()) << this << "Destructor: WorkerThread wait";
+            qCDebug(lcMediaPlayer) << this << "Destructor: WorkerThread wait";
         }
         m_workerThread->deleteLater();
         m_workerThread = nullptr;
-        qCDebug(CLASS_LC()) << this << "Destructor: WorkerThread was deleted";
+        qCDebug(lcMediaPlayer) << this << "Destructor: WorkerThread was deleted";
     }
 
     if (m_startTimer->isActive()) {
@@ -89,7 +85,7 @@ MediaPlayerUtils::~MediaPlayerUtils() {
     m_imageProvider = nullptr;
     m_imageProvider->deleteLater();
 
-    qCDebug(CLASS_LC()) << this << "Destructor end";
+    qCDebug(lcMediaPlayer) << this << "Destructor end";
 }
 
 void MediaPlayerUtils::setImageURL(QString url) {
@@ -122,12 +118,12 @@ void MediaPlayerUtils::onProcessingDone(const QColor &pixelColor, const QImage &
     m_pixelColor = pixelColor;
     emit pixelColorChanged();
 
-    qCDebug(CLASS_LC()) << this << "Processing done";
+    qCDebug(lcMediaPlayer) << this << "Processing done";
 }
 
 void MediaPlayerUtils::generateImages(const QString &url) {
     if (url != m_prevImageURL) {
-        qCDebug(CLASS_LC()) << this << "Generate images for" << url;
+        qCDebug(lcMediaPlayer) << this << "Generate images for" << url;
 
         m_prevImageURL = url;
         emit processingStarted();
@@ -141,11 +137,11 @@ MediaPlayerUtilsWorker::MediaPlayerUtilsWorker(QObject *parent) : QObject(parent
 }
 
 MediaPlayerUtilsWorker::~MediaPlayerUtilsWorker() {
-    qCDebug(CLASS_LC()) << this << "Worker destructor";
+    qCDebug(lcMediaPlayer) << this << "Worker destructor";
     if (m_manager != nullptr) {
         m_manager->deleteLater();
         m_manager = nullptr;
-        qCDebug(CLASS_LC()) << this << "Worker destructor: Manager deleted.";
+        qCDebug(lcMediaPlayer) << this << "Worker destructor: Manager deleted.";
     }
 }
 
@@ -164,7 +160,7 @@ void MediaPlayerUtilsWorker::generateImagesReply() {
             image.fill(Qt::black);
 
             if (!image.load(m_reply, nullptr)) {
-                qCWarning(CLASS_LC) << "ERROR LOADING IMAGE";
+                qCWarning(lcMediaPlayer) << "ERROR LOADING IMAGE";
                 if (m_reply) {
                     m_reply->deleteLater();
                     m_reply = nullptr;
@@ -174,7 +170,7 @@ void MediaPlayerUtilsWorker::generateImagesReply() {
                 ////////////////////////////////////////////////////////////////////
                 /// GET DOMINANT COLOR
                 ////////////////////////////////////////////////////////////////////
-                qCDebug(CLASS_LC()) << this << "Getting dominant color";
+                qCDebug(lcMediaPlayer) << this << "Getting dominant color";
                 QColor pixelColor = dominantColor(image);
 
                 // change the brightness of the color if it's too bright
@@ -190,7 +186,7 @@ void MediaPlayerUtilsWorker::generateImagesReply() {
                 ////////////////////////////////////////////////////////////////////
                 /// CREATE LARGE BACKGROUND IMAGE
                 ////////////////////////////////////////////////////////////////////
-                qCDebug(CLASS_LC()) << this << "Creating image";
+                qCDebug(lcMediaPlayer) << this << "Creating image";
                 // resize image
                 image.scaledToHeight(280, Qt::SmoothTransformation);
 
@@ -204,18 +200,18 @@ void MediaPlayerUtilsWorker::generateImagesReply() {
                 painter.drawImage(image.rect(), noise);
                 painter.end();
 
-                qCDebug(CLASS_LC()) << this << "Creating image DONE";
+                qCDebug(lcMediaPlayer) << this << "Creating image DONE";
 
                 emit processingDone(pixelColor, image);
             }
         } else {
-            qCWarning(CLASS_LC) << this << "NETWORK REPLY ERROR" << m_reply->errorString();
+            qCWarning(lcMediaPlayer) << this << "NETWORK REPLY ERROR" << m_reply->errorString();
             emit processingDone(QColor("black"), QImage());
         }
 
         m_reply->deleteLater();
         m_reply = nullptr;
-        qCDebug(CLASS_LC()) << this << "Network reply deleted";
+        qCDebug(lcMediaPlayer) << this << "Network reply deleted";
     }
 }
 

remote.pro

@@ -27,6 +27,7 @@ CONFIG += c++17 disable-desktop
 CONFIG += qtquickcompiler
 
 DEFINES += QT_DEPRECATED_WARNINGS
+DEFINES += QT_MESSAGELOGCONTEXT
 
 # === Version and build information ===========================================
 # If built in Buildroot use custom package version, otherwise Git
@@ -144,6 +145,7 @@ HEADERS += \
     sources/jsonfile.h \
     sources/launcher.h \
     sources/logger.h \
+    sources/logging.h \
     sources/softwareupdate.h \
     sources/standbycontrol.h \
     sources/translation.h \
@@ -191,6 +193,7 @@ SOURCES += \
     sources/hardware/touchdetect.cpp \
     sources/integrations/integrations.cpp \
     sources/logger.cpp \
+    sources/logging.cpp \
     sources/main.cpp \
     sources/jsonfile.cpp \
     sources/launcher.cpp \