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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qbs.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** 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-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "artifactcleaner.h"
#include "artifact.h"
#include "artifactvisitor.h"
#include "productbuilddata.h"
#include "projectbuilddata.h"
#include "transformer.h"
#include <language/language.h>
#include <logging/translator.h>
#include <tools/cleanoptions.h>
#include <tools/error.h>
#include <tools/fileinfo.h>
#include <tools/progressobserver.h>
#include <tools/qbsassert.h>
#include <QtCore/qcoreapplication.h>
#include <QtCore/qdir.h>
#include <QtCore/qdiriterator.h>
#include <QtCore/qfileinfo.h>
#include <QtCore/qstring.h>
namespace qbs {
namespace Internal {
static void printRemovalMessage(const QString &path, bool dryRun, const Logger &logger)
{
if (dryRun)
logger.qbsInfo() << Tr::tr("Would remove '%1'.").arg(path);
else
logger.qbsDebug() << "Removing '" << path << "'.";
}
static void invalidateArtifactTimestamp(Artifact *artifact)
{
if (artifact->timestamp().isValid()) {
artifact->clearTimestamp();
artifact->product->topLevelProject()->buildData->isDirty = true;
}
}
static void removeArtifactFromDisk(Artifact *artifact, bool dryRun, const Logger &logger)
{
QFileInfo fileInfo(artifact->filePath());
if (!FileInfo::fileExists(fileInfo)) {
if (!dryRun)
invalidateArtifactTimestamp(artifact);
return;
}
printRemovalMessage(fileInfo.filePath(), dryRun, logger);
if (dryRun)
return;
invalidateArtifactTimestamp(artifact);
QString errorMessage;
if (!removeFileRecursion(fileInfo, &errorMessage))
throw ErrorInfo(errorMessage);
}
class CleanupVisitor : public ArtifactVisitor
{
public:
CleanupVisitor(const CleanOptions &options, const ProgressObserver *observer,
const Logger &logger)
: ArtifactVisitor(Artifact::Generated)
, m_options(options)
, m_observer(observer)
, m_logger(logger)
, m_hasError(false)
{
}
void visitProduct(const ResolvedProductPtr &product)
{
m_product = product;
ArtifactVisitor::visitProduct(product);
auto it = product->buildData->rescuableArtifactData.begin();
while (it != product->buildData->rescuableArtifactData.end()) {
Artifact tmp;
tmp.product = product;
tmp.setFilePath(it.key());
tmp.setTimestamp(it.value().timeStamp);
removeArtifactFromDisk(&tmp, m_options.dryRun(), m_logger);
it = product->buildData->rescuableArtifactData.erase(it);
}
}
const Set<QString> &directories() const { return m_directories; }
bool hasError() const { return m_hasError; }
private:
void doVisit(Artifact *artifact)
{
if (m_observer->canceled())
throw ErrorInfo(Tr::tr("Cleaning up was canceled."));
if (artifact->product != m_product)
return;
try {
removeArtifactFromDisk(artifact, m_options.dryRun(), m_logger);
} catch (const ErrorInfo &error) {
if (!m_options.keepGoing())
throw;
m_logger.printWarning(error);
m_hasError = true;
}
m_directories << artifact->dirPath();
}
const CleanOptions m_options;
const ProgressObserver * const m_observer;
Logger m_logger;
bool m_hasError;
ResolvedProductConstPtr m_product;
Set<QString> m_directories;
};
ArtifactCleaner::ArtifactCleaner(const Logger &logger, ProgressObserver *observer)
: m_logger(logger), m_observer(observer)
{
}
void ArtifactCleaner::cleanup(const TopLevelProjectPtr &project,
const QList<ResolvedProductPtr> &products, const CleanOptions &options)
{
m_hasError = false;
const QString configString = Tr::tr(" for configuration %1").arg(project->id());
m_observer->initialize(Tr::tr("Cleaning up%1").arg(configString), products.count() + 1);
Set<QString> directories;
for (const ResolvedProductPtr &product : products) {
CleanupVisitor visitor(options, m_observer, m_logger);
visitor.visitProduct(product);
directories.unite(visitor.directories());
if (visitor.hasError())
m_hasError = true;
m_observer->incrementProgressValue();
}
// Directories created during the build are not artifacts (TODO: should they be?),
// so we have to clean them up manually.
QList<QString> dirList = directories.toList();
for (int i = 0; i < dirList.count(); ++i) {
const QString &dir = dirList.at(i);
if (!dir.startsWith(project->buildDirectory))
continue;
if (FileInfo(dir).exists())
removeEmptyDirectories(dir, options);
if (dir != project->buildDirectory) {
const QString parentDir = QDir::cleanPath(dir + QLatin1String("/.."));
if (parentDir != project->buildDirectory && !dirList.contains(parentDir))
dirList << parentDir;
}
}
m_observer->incrementProgressValue();
if (m_hasError)
throw ErrorInfo(Tr::tr("Failed to remove some files."));
m_observer->setFinished();
}
void ArtifactCleaner::removeEmptyDirectories(const QString &rootDir, const CleanOptions &options,
bool *isEmpty)
{
bool subTreeIsEmpty = true;
QDirIterator it(rootDir, QDir::Files | QDir::Dirs | QDir::Hidden | QDir::NoDotAndDotDot);
while (it.hasNext()) {
it.next();
if (!it.fileInfo().isSymLink() && it.fileInfo().isDir())
removeEmptyDirectories(it.filePath(), options, &subTreeIsEmpty);
else
subTreeIsEmpty = false;
}
if (subTreeIsEmpty) {
printRemovalMessage(rootDir, options.dryRun(), m_logger);
if (!QDir::root().rmdir(rootDir)) {
ErrorInfo error(Tr::tr("Failure to remove empty directory '%1'.").arg(rootDir));
if (!options.keepGoing())
throw error;
m_logger.printWarning(error);
m_hasError = true;
subTreeIsEmpty = false;
}
}
if (!subTreeIsEmpty && isEmpty)
*isEmpty = false;
}
} // namespace Internal
} // namespace qbs
|
