summaryrefslogtreecommitdiffstats
path: root/src/libs/installer/operationtracer.cpp
blob: b09c08d2e360647b4aa02bb6ee7874187c19badb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
/**************************************************************************
**
** Copyright (C) 2022 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$
**
**************************************************************************/

#include "operationtracer.h"

#include "packagemanagercore.h"

namespace QInstaller {

/*!
    \inmodule QtInstallerFramework
    \class QInstaller::AbstractOperationTracer
    \brief The AbstractOperationTracer is a pure virtual base class for classes
           tracing starting and finishing of installer operations.
*/

/*!
    \fn QInstaller::AbstractOperationTracer::~AbstractOperationTracer()

    Destructs object. A subclass may override this method.
*/

/*!
    \fn QInstaller::AbstractOperationTracer::trace(const QString &state)

    Prints trace output for starting operation in \a state.
    A subclass should implement this method.
*/

/*!
    Constructs tracer for \a operation. Objects of this class cannot
    be constructed directly, but the derived classes should explicitly call
    the base class constructor in their constructors.
*/
AbstractOperationTracer::AbstractOperationTracer(Operation *operation)
    : m_operation(nullptr)
{
    // don't create output for that hacky pseudo operation
    if (operation->name() != QLatin1String("MinimumProgress"))
        m_operation = operation;
}


/*!
    \inmodule QtInstallerFramework
    \class QInstaller::OperationTracer
    \brief The OperationTracer prints trace output for starting of operations
           and automatically indicates finish on destruction.
*/

/*!
    Constructs tracer for \a operation.
*/
OperationTracer::OperationTracer(Operation *operation)
    : AbstractOperationTracer(operation)
{
}

/*!
    Destructs object and prints message indicating finished operation.
*/
OperationTracer::~OperationTracer()
{
    if (!m_operation)
        return;

    qCDebug(QInstaller::lcInstallerInstallLog) << "Done";
}

/*!
    Prints trace output for starting operation in \a state.
*/
void OperationTracer::trace(const QString &state)
{
    if (!m_operation)
        return;

    qCDebug(lcInstallerInstallLog).noquote() << QString::fromLatin1("%1 %2 operation: %3")
        .arg(state, m_operation->value(QLatin1String("component")).toString(), m_operation->name());

    QStringList args = m_operation->arguments();
    if (m_operation->requiresUnreplacedVariables())
        args = m_operation->packageManager()->replaceVariables(m_operation->arguments());

    qCDebug(lcInstallerInstallLog).noquote() << QString::fromLatin1("\t- arguments: %1")
        .arg(args.join(QLatin1String(", ")));
}


/*!
    \inmodule QtInstallerFramework
    \class QInstaller::ConcurrentOperationTracer
    \brief The ConcurrentOperationTracer prints trace output for starting of
           asynchronous operations.
*/

/*!
    Constructs tracer for \a operation.
*/
ConcurrentOperationTracer::ConcurrentOperationTracer(Operation *operation)
    : AbstractOperationTracer(operation)
{
}

/*!
    Prints trace output for starting operation in \a state.
*/
void ConcurrentOperationTracer::trace(const QString &state)
{
    if (!m_operation)
        return;

    qCDebug(lcInstallerInstallLog).noquote() << QString::fromLatin1("%1 %2 concurrent operation: %3")
        .arg(state, m_operation->value(QLatin1String("component")).toString(), m_operation->name());

    QStringList args = m_operation->arguments();
    if (m_operation->requiresUnreplacedVariables())
        args = m_operation->packageManager()->replaceVariables(m_operation->arguments());

    qCDebug(lcInstallerInstallLog).noquote() << QString::fromLatin1("\t- arguments: %1")
        .arg(args.join(QLatin1String(", ")));

    qCDebug(QInstaller::lcInstallerInstallLog) << "Started";
}

} // namespace QInstaller