summaryrefslogtreecommitdiffstats
path: root/src/libs/installer/loggingutils.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/libs/installer/loggingutils.h')
-rw-r--r--src/libs/installer/loggingutils.h129
1 files changed, 129 insertions, 0 deletions
diff --git a/src/libs/installer/loggingutils.h b/src/libs/installer/loggingutils.h
new file mode 100644
index 000000000..a997a6d60
--- /dev/null
+++ b/src/libs/installer/loggingutils.h
@@ -0,0 +1,129 @@
+/**************************************************************************
+**
+** Copyright (C) 2021 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the Qt Installer Framework.
+**
+** $QT_BEGIN_LICENSE:GPL-EXCEPT$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3 as published by the Free Software
+** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+**************************************************************************/
+
+#ifndef LOGGINGUTILS_H
+#define LOGGINGUTILS_H
+
+#include "component.h"
+
+#include <QObject>
+
+namespace QInstaller {
+
+class INSTALLER_EXPORT LoggingHandler
+{
+ Q_DISABLE_COPY(LoggingHandler)
+ Q_ENUMS(VerbosityLevel)
+
+public:
+ enum VerbosityLevel {
+ Silent = 0,
+ Normal = 1,
+ Detailed = 2,
+ Minimum = Silent,
+ Maximum = Detailed
+ };
+
+ static LoggingHandler &instance();
+ void messageHandler(QtMsgType type, const QMessageLogContext &context, const QString &msg);
+
+ void setVerbose(bool v);
+ bool isVerbose() const;
+ VerbosityLevel verboseLevel() const;
+ bool outputRedirected() const;
+
+ void printComponentInfo(const QList<Component *> components) const;
+ void printLocalPackageInformation(const QList<KDUpdater::LocalPackage> &packages) const;
+ void printPackageInformation(const PackagesList &matchedPackages, const LocalPackagesHash &installedPackages) const;
+
+ friend VerbosityLevel &operator++(VerbosityLevel &level, int);
+ friend VerbosityLevel &operator--(VerbosityLevel &level, int);
+
+private:
+ LoggingHandler();
+ ~LoggingHandler();
+
+ QString trimAndPrepend(QtMsgType type, const QString &msg) const;
+
+private:
+ VerbosityLevel m_verbLevel;
+ bool m_outputRedirected;
+};
+
+class INSTALLER_EXPORT VerboseWriterOutput
+{
+public:
+ virtual bool write(const QString &fileName, QIODevice::OpenMode openMode, const QByteArray &data) = 0;
+
+protected:
+ ~VerboseWriterOutput();
+};
+
+class INSTALLER_EXPORT PlainVerboseWriterOutput : public VerboseWriterOutput
+{
+public:
+ virtual bool write(const QString &fileName, QIODevice::OpenMode openMode, const QByteArray &data) override;
+};
+
+class INSTALLER_EXPORT VerboseWriterAdminOutput : public VerboseWriterOutput
+{
+public:
+ VerboseWriterAdminOutput(PackageManagerCore *core) : m_core(core) {}
+
+ virtual bool write(const QString &fileName, QIODevice::OpenMode openMode, const QByteArray &data) override;
+
+private:
+ PackageManagerCore *m_core;
+};
+
+class INSTALLER_EXPORT VerboseWriter
+{
+public:
+ VerboseWriter();
+ ~VerboseWriter();
+
+ static VerboseWriter *instance();
+
+ bool flush(VerboseWriterOutput *output);
+
+ void appendLine(const QString &msg);
+ void setFileName(const QString &fileName);
+
+private:
+ QTextStream m_stream;
+ QBuffer m_preFileBuffer;
+ QString m_logFileName;
+ QString m_currentDateTimeAsString;
+};
+
+LoggingHandler::VerbosityLevel &operator++(LoggingHandler::VerbosityLevel &level, int);
+LoggingHandler::VerbosityLevel &operator--(LoggingHandler::VerbosityLevel &level, int);
+
+} // namespace QInstaller
+
+#endif // LOGGINGUTILS_H