common/loggingutil: Add LoggingUtil class for enhanced logging functionality

Introduced the LoggingUtil class to provide structured logging with
support for different log levels (Info, Warning, Debug). This
functionality is being utilized in the package manager for improved
debugging and status updates.

Signed-off-by: andreidanila1 <[email protected]>

Author: andreidanila1

common/include/common/loggingutil.h

@@ -0,0 +1,70 @@
+/*
+ * Copyright (c) 2025 Analog Devices Inc.
+ *
+ * This file is part of Scopy
+ * (see https://www.github.com/analogdevicesinc/scopy).
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
+
+#ifndef LOGGINGUTIL_H
+#define LOGGINGUTIL_H
+
+#include <QLoggingCategory>
+#include <QString>
+#include <pluginbase/statusbarmanager.h>
+#include "scopy-common_export.h"
+
+namespace scopy {
+
+class SCOPY_COMMON_EXPORT LoggingUtil
+{
+public:
+	enum LogLevel
+	{
+		Info,
+		Warning,
+		Debug
+	};
+
+	static inline void logMessage(const QLoggingCategory &category(), const QString &message,
+				      LogLevel level = LogLevel::Debug, bool pushToStatusBar = false,
+				      bool urgent = false, int ms = DEFAULT_DISPLAY_TIME)
+	{
+		if(pushToStatusBar) {
+			if(urgent) {
+				StatusBarManager::pushUrgentMessage(message, ms);
+			} else {
+				StatusBarManager::pushMessage(message, ms);
+			}
+		}
+
+		switch(level) {
+		case Info:
+			qInfo(category) << message;
+			break;
+		case Warning:
+			qWarning(category) << message;
+			break;
+		case Debug:
+			qDebug(category) << message;
+			break;
+		}
+	}
+};
+
+} // namespace scopy
+
+#endif // LOGGINGUTIL_H

core/include/core/pkgmanager/pkgutil.h

@@ -27,6 +27,7 @@
 #include <kzip.h>
 
 #define METADATA_FILE "MANIFEST.json"
+#define STATUS_BAR_MS 3000
 
 namespace scopy {
 class SCOPY_CORE_EXPORT PkgUtil

core/src/pkgmanager/pkgmanager.cpp

@@ -27,6 +27,7 @@
 #include <QDir>
 #include <QFile>
 #include <QJsonObject>
+#include <common/loggingutil.h>
 #include <common/scopyconfig.h>
 #include <QFileSystemModel>
 #include <QLoggingCategory>
@@ -83,6 +84,9 @@ bool PkgManager::_install(const QString &zipPath, bool performRestart)
 	}
 	QJsonObject metadata = PkgUtil::extractJsonMetadata(zipPath);
 	if(!PkgUtil::validatePkg(metadata)) {
+		LoggingUtil::logMessage(CAT_PKGMANAGER,
+					"Could not install the package. The file appears to be invalid or corrupted.",
+					LoggingUtil::Warning, true, false, STATUS_BAR_MS);
 		return false;
 	}
 
@@ -96,7 +100,8 @@ bool PkgManager::_install(const QString &zipPath, bool performRestart)
 	if(installed) {
 		Q_EMIT pkgInstalled(performRestart);
 	} else {
-		qWarning(CAT_PKGMANAGER) << "Couldn't install:" << metadata[PkgManifest::PKG_ID];
+		LoggingUtil::logMessage(CAT_PKGMANAGER, "Couldn't install: " + metadata[PkgManifest::PKG_ID].toString(),
+					LoggingUtil::Warning, true, false, STATUS_BAR_MS);
 	}
 
 	return installed;
@@ -111,7 +116,8 @@ bool PkgManager::_uninstall(const QString &pkgId, bool performRestart)
 {
 	QString pkgPath = validPackages_[pkgId].value(PkgManifest::PKG_PATH).toString();
 	if(pkgPath.isEmpty()) {
-		qWarning(CAT_PKGMANAGER) << "There is no package:" << pkgId;
+		LoggingUtil::logMessage(CAT_PKGMANAGER, "Couldn't find the path for package " + pkgId,
+					LoggingUtil::Warning, true, false, STATUS_BAR_MS);
 		return false;
 	}
 	bool removed = PkgUtil::removePkg(pkgPath);

core/src/pkgmanager/pkgutil.cpp

@@ -28,8 +28,7 @@
 #include <QLoggingCategory>
 #include <plot_utils.hpp>
 #include <qjsonarray.h>
-#include <common/scopyconfig.h>
-
+#include <common/loggingutil.h>
 #include <common/scopyconfig.h>
 
 Q_LOGGING_CATEGORY(CAT_PKGUTIL, "PkgUtil")
@@ -86,12 +85,14 @@ QJsonObject PkgUtil::extractJsonMetadata(const QString &zipPath)
 	const KArchiveDirectory *zipDir = static_cast<const KArchiveDirectory *>(zip.directory()->entry(entryName));
 	const KArchiveFile *manifestFile = zipDir->file(METADATA_FILE);
 	if(!manifestFile) {
-		qWarning(CAT_PKGUTIL) << METADATA_FILE << "not found in package!";
+		LoggingUtil::logMessage(CAT_PKGUTIL, QString(METADATA_FILE) + " not found in package!",
+					LoggingUtil::Warning, true, true, STATUS_BAR_MS);
 		return {};
 	}
 	QJsonDocument doc = QJsonDocument::fromJson(manifestFile->data());
 	if(!doc.isObject()) {
-		qWarning(CAT_PKGUTIL) << "QJsonDocument parsing failed:" << METADATA_FILE;
+		LoggingUtil::logMessage(CAT_PKGUTIL, "QJsonDocument parsing failed: " + QString(METADATA_FILE),
+					LoggingUtil::Warning, true, true, STATUS_BAR_MS);
 		return {};
 	}
 	QJsonObject obj = doc.object();
@@ -116,7 +117,8 @@ QJsonObject PkgUtil::getMetadata(const QString &path)
 	return obj;
 }
 
-// In this method we also can make another checks
+// This method validates the package metadata by checking required fields.
+// Additional checks could include verifying field formats or ensuring compatibility with specific versions.
 bool PkgUtil::validatePkg(QJsonObject &metadata)
 {
 	if(metadata.isEmpty()) {
@@ -128,13 +130,15 @@ bool PkgUtil::validatePkg(QJsonObject &metadata)
 		QJsonValue value = metadata.value(field);
 		// Check if field is missing or null
 		if(value.isNull() || value.isUndefined()) {
-			qWarning(CAT_PKGUTIL) << "Missing required field:" << field;
+			LoggingUtil::logMessage(CAT_PKGUTIL, "Missing required field: " + field, LoggingUtil::Warning,
+						true, true, STATUS_BAR_MS);
 			return false;
 		}
 		// Check if field is empty (string or array)
 		if((value.isString() && value.toString().trimmed().isEmpty()) ||
 		   (value.isArray() && value.toArray().isEmpty())) {
-			qWarning(CAT_PKGUTIL) << "Empty required field:" << field;
+			LoggingUtil::logMessage(CAT_PKGUTIL, "Empty required field: " + field, LoggingUtil::Warning,
+						true, true, STATUS_BAR_MS);
 			return false;
 		}
 	}
@@ -161,12 +165,14 @@ QString PkgUtil::validateArchiveEntry(const KZip &zip)
 	}
 	QStringList zipEntries = zipDir->entries();
 	if(zipEntries.size() != 1) {
-		qWarning(CAT_PKGUTIL) << "There must be a single entry in the archive!";
+		LoggingUtil::logMessage(CAT_PKGUTIL, "There must be a single entry in the archive! (a directory)",
+					LoggingUtil::Warning, true, false, STATUS_BAR_MS);
 		return "";
 	}
 	QString entryName = zipEntries.first();
 	if(!zipDir->entry(entryName)->isDirectory()) {
-		qWarning(CAT_PKGUTIL) << "The archive entry must be a directory!!";
+		LoggingUtil::logMessage(CAT_PKGUTIL, "The archive entry must be a directory!", LoggingUtil::Warning,
+					true, false, STATUS_BAR_MS);
 		return "";
 	}
 	return entryName;