Differential D11285 Diff 29684 src/engine/databasesanitizer.cpp

Changeset View

Standalone View

src/engine/databasesanitizer.cpp

This file was added.

1		/*
2		* This file is part of the KDE Baloo project.
3		* Copyright 2018 Michael Heidelbach <ottwolt@gmail.com>
4		*
5		* This program is free software; you can redistribute it and/or
6		* modify it under the terms of the GNU General Public License as
7		* published by the Free Software Foundation; either version 2 of
8		* the License or (at your option) version 3 or any later version
9		* accepted by the membership of KDE e.V. (or its successor approved
10		* by the membership of KDE e.V.), which shall act as a proxy
11		* defined in Section 14 of version 3 of the license.
12		*
13		* This program is distributed in the hope that it will be useful,
14		* but WITHOUT ANY WARRANTY; without even the implied warranty of
15		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16		* GNU General Public License for more details.
17		*
18		* You should have received a copy of the GNU General Public License
19		* along with this program. If not, see <http://www.gnu.org/licenses/>.
20		*/
21
22		#include "databasesanitizer.h"
23		#include "documenturldb.h"
24		#include "baloodebug.h"
25
26		#include <KLocalizedString>
27		#include <QFileInfo>
28
29		using namespace Baloo;
30
31
32		class DatabaseSanitizerImpl {
33		public:
34		DatabaseSanitizerImpl(const Database& db, Baloo::Transaction::TransactionType type, DatabaseSanitizer* q)
35		: q_ptr(q)
36		, m_transaction(new Transaction(db, type))
37		{
38		}
39
40		public:
41		/**
42		* \brief Basic info about database items
43		*/
44		struct FileInfo {
45		quint32 deviceId = 0;
	mlaurentUnsubmitted Done initialize value by default please mlaurent: initialize value by default please
46		quint32 inode = 0;
47		QString url = QString();
	mlaurentUnsubmitted Done you can replace this constructor by initialize directly variable > bool accessible = true; etc. > it avoids to create this constructor mlaurent: you can replace this constructor by initialize directly variable => bool accessible = true…
48		bool accessible = true;
49		};
50
51		void printProgress(QTextStream& out, uint& cur, const uint max, const uint step) const
52		{
53		if (cur % step == 0) {
54		out << QStringLiteral("%1%2\r").arg(100 * cur / max, 6).arg("%", -16);
55		out.flush();
56		}
57		cur++;
58		}
59
60		/**
61		* Create a list of \a FileInfo items.
62		*
63		* \p deviceIDs filter by device ids. If the vector is empty no filtering is done
64		* and every item is collected.
65		* Positive numbers are including filters collecting only the mentioned device ids.
66		* Negative numbers are excluding filters collecting everything but the mentioned device ids.
67		*
68		* \p missingOnly Only inaccessible items are collected.
69		*
70		* \p urlFilter Filter result urls. Default is null = Collect everything.
71		*/
72		QVector<FileInfo> createList(
73		const QVector<qint64>& deviceIds,
74		const bool purging,
75		const QSharedPointer<QRegularExpression>& urlFilter
76		) const
77		{
78		Q_ASSERT(m_transaction);
79
80		const auto docUrlDb = q_ptr->getDocuments(m_transaction);
81		const auto map = docUrlDb.toTestMap();
82		const auto keys = map.keys();
83		QVector<FileInfo> result;
84		result.reserve(keys.count());
85		uint i = 0;
86		uint max = keys.count();
87		QVector<quint32> includeIds;
88		QVector<quint32> excludeIds;
89		for (qint64 deviceId : deviceIds) {
90		if (deviceId > 0) {
91		includeIds.append(deviceId);
92		} else if (deviceId < 0) {
93		excludeIds.append(-deviceId);
94		}
95		}
96
97		QTextStream err(stderr);
98		for (quint64 id: keys) {
99		printProgress(err, i, max, 100);
100
	mlaurentUnsubmitted Done const auto & for a quint32 it's better to use directly quint32 without const'ref mlaurent: const auto & for a quint32 it's better to use directly quint32 without const'ref
101		const quint32* arr = reinterpret_cast<quint32*>(&id);
102		const auto url = docUrlDb.get(id);
103		FileInfo info;
104		info.deviceId = arr[0];
105		info.inode = arr[1];
106		info.url = url;
107		info.accessible = !url.isEmpty() && QFileInfo::exists(url);
108		if ((!includeIds.isEmpty() && !includeIds.contains(info.deviceId))
	mlaurentUnsubmitted Done includeIds.count() > 0 => use !isEmpty mlaurent: includeIds.count() > 0 => use !isEmpty
109		\|\| (!excludeIds.isEmpty() && excludeIds.contains(info.deviceId))
110		\|\| (purging && info.accessible)
111		\|\| (urlFilter && !urlFilter->match(info.url).hasMatch())
112		) {
113		continue;
114		}
115		result.append(info);
116		}
117		return result;
118		}
119
120		QMultiHash<quint32, FileInfo> createDeviceList(const QVector<qint64>& deviceIds)
121		{
122		auto infos = createList(deviceIds, false, nullptr);
123		QMultiHash<quint32, FileInfo> usedDevices;
124		for (const auto& info: infos) {
125		usedDevices.insert(info.deviceId, info);
126		}
127		return usedDevices;
128		}
129
130		private:
131		DatabaseSanitizer* q_ptr;
132		Transaction* m_transaction;
133		};
134
135		DatabaseSanitizer::DatabaseSanitizer(const Database& db, Baloo::Transaction::TransactionType type)
136		: m_pimpl(new DatabaseSanitizerImpl(db, type, this))
137		{
138		}
139
140		DatabaseSanitizer::DatabaseSanitizer(Database* db, Transaction::TransactionType type)
141		: DatabaseSanitizer(*db, type)
142		{
143		}
144
145		DatabaseSanitizer::~DatabaseSanitizer()
146		{
147		delete m_pimpl;
148		m_pimpl = nullptr;
149		}
150
151		/**
152		* Create a list of \a FileInfo items and print it to stdout.
153		*
154		* \p deviceIDs filter by device ids. If the vector is empty no filtering is done
	mlaurentUnsubmitted Done const QSharedPointer<QRegularExpression> & ------------------------------------------------------^ mlaurent: const QSharedPointer<QRegularExpression> &…
155		* and everything is printed.
156		* Positive numbers are including filters printing only the mentioned device ids.
157		* Negative numbers are excluding filters printing everything but the mentioned device ids.
158		*
159		* \p missingOnly Simulate purging operation. Only inaccessible items are printed.
160		*
161		* \p urlFilter Filter result urls. Default is null = Print everything.
162		*/
163		void DatabaseSanitizer::printList(
164		const QVector<qint64>& deviceIds,
	michaelhAuthorUnsubmitted Done Before landing this will become Create a list of \a FileInfo items and print it to stdout. michaelh: Before landing this will become ``` Create a list of \a FileInfo items and print it to stdout.
165		const bool missingOnly,
166		const QSharedPointer<QRegularExpression>& urlFilter)
	mlaurentUnsubmitted Not Done use qCDebug(BALOO) mlaurent: use qCDebug(BALOO)
	michaelhAuthorUnsubmitted Not Done I get a linker error `databasesanitizer.cpp:189: undefined reference to` BALOO()'` Currently its not worth the trouble fixing it, because that method is going to change anyway. Also I don't like to mix debug statement and printing to stderr. michaelh: I get a linker error `databasesanitizer.cpp:189: undefined reference to `BALOO()'` Currently…
167		{
168		auto infos = m_pimpl->createList(deviceIds, missingOnly, urlFilter);
169		const auto sep = QLatin1Char(' ');
170		QTextStream out(stdout);
171		QTextStream err(stderr);
172		for (const auto& info: infos) {
173		if (!missingOnly) {
174		out << QStringLiteral("%1").arg(info.accessible ? "+" : "!") << sep;
175		} else if (!info.accessible) {
	mlaurentUnsubmitted Done as you add a i18n in engine directory you need to extract them. you missed to add a Message.sh in this subdirectory and loading message file. mlaurent: as you add a i18n in engine directory you need to extract them. you missed to add a Message.sh…
176		out << i18n("Missing:") << sep;
177		} else {
178		Q_ASSERT(false);
179		continue;
180		}
181		out << QStringLiteral("device: %1").arg(info.deviceId)
182		<< sep << QStringLiteral("inode: %1").arg(info.inode)
183		<< sep << QStringLiteral("url: %1").arg(info.url)
184		<< endl;
185		}
186		err << i18n("Found %1 matching items", infos.count()) << endl;
187
188		}
189
190		void DatabaseSanitizer::printDevices(const QVector<qint64>& deviceIds, const bool missingOnly)
191		{
192		Q_UNUSED(missingOnly)
193		/*
194		* TODO: Implement missingOnly filter. Checking for file existence
195		* will not work. We need to read /etc/mtab or so.
196		*/
197		auto usedDevices = m_pimpl->createDeviceList(deviceIds);
198
199		const auto sep = QLatin1Char(' ');
200		QTextStream out(stdout);
201		QTextStream err(stderr);
	michaelhAuthorUnsubmitted Not Done This is the best I could think of to make `getDocuments` accessible to DatabaseSanitizerImpl. But I don't like it. This method definitely should not be part of the interface. michaelh: This is the best I could think of to make `getDocuments` accessible to DatabaseSanitizerImpl.
202
203		for (const auto& dev: usedDevices.uniqueKeys()) {
204		out << "Device:" << dev
205		<< sep << usedDevices.values(dev).count() << sep << "items"
206		<< endl;
207		}
208
209		err << i18n("Found %1 matching items", usedDevices.count()) << endl;
210		}
211
212		DocumentUrlDB DatabaseSanitizer::getDocuments(Transaction* txn)
213		{
214		return DocumentUrlDB(txn->m_dbis.idTreeDbi, txn->m_dbis.idFilenameDbi, txn->m_txn);
215		}
216
217

Changeset View

Standalone View

src/engine/databasesanitizer.cpp

> bool accessible = true;

> it avoids to create this constructor