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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396 | /* ============================================================
*
* This file is a part of digiKam project
* https://www.digikam.org
*
* Date : 2008-09-09
* Description : Hint data containers for the collection scanner
*
* SPDX-FileCopyrightText: 2008 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
* SPDX-FileCopyrightText: 2009-2025 by Gilles Caulier <caulier dot gilles at gmail dot com>
*
* SPDX-License-Identifier: GPL-2.0-or-later
*
* ============================================================ */
#pragma once
#include "digikam_config.h"
// Qt includes
#include <QDateTime>
#include <QList>
#include <QStringList>
#ifdef HAVE_DBUS
# include <QDBusArgument>
# include "dbenginedbusutils.h"
#endif
// Local includes
#include "digikam_export.h"
#include "digikam_globals.h"
namespace Digikam
{
class AlbumCopyMoveHint;
class CollectionLocation;
class CollectionScannerObserver;
class ItemInfo;
class ItemCopyMoveHint;
class ItemChangeHint;
class ItemMetadataAdjustmentHint;
class CollectionScannerHintContainer
{
public:
/// Note: All methods of this class must be thread-safe.
CollectionScannerHintContainer() = default;
virtual ~CollectionScannerHintContainer() = default;
virtual void recordHints(const QList<AlbumCopyMoveHint>& hints) = 0;
virtual void recordHints(const QList<ItemCopyMoveHint>& hints) = 0;
virtual void recordHints(const QList<ItemChangeHint>& hints) = 0;
virtual void recordHint(const ItemMetadataAdjustmentHint& hints) = 0;
virtual void clear() = 0;
private:
Q_DISABLE_COPY(CollectionScannerHintContainer)
};
// ------------------------------------------------------------------------------
namespace CollectionScannerHints
{
class DIGIKAM_DATABASE_EXPORT Album
{
public:
Album() = default;
Album(int albumRootId, int albumId);
bool isNull() const;
QT_HASH_TYPE qHash() const;
bool operator==(const Album& other) const;
public:
int albumRootId = 0;
int albumId = 0;
};
// ---------------------------------------------------------------------------
class DIGIKAM_DATABASE_EXPORT DstPath
{
public:
DstPath() = default;
DstPath(int albumRootId, const QString& relativePath);
bool isNull() const;
QT_HASH_TYPE qHash() const;
bool operator==(const DstPath& other) const;
public:
int albumRootId = 0;
QString relativePath;
};
// ---------------------------------------------------------------------------
class DIGIKAM_DATABASE_EXPORT Item
{
public:
Item() = default;
explicit Item(qlonglong id);
bool isNull() const;
QT_HASH_TYPE qHash() const;
bool operator==(const Item& other) const;
public:
qlonglong id = 0;
};
// ---------------------------------------------------------------------------
inline QT_HASH_TYPE qHash(const Album& src)
{
return src.qHash();
}
inline QT_HASH_TYPE qHash(const DstPath& dst)
{
return dst.qHash();
}
inline QT_HASH_TYPE qHash(const Item& item)
{
return item.qHash();
}
} // namespace CollectionScannerHints
// ---------------------------------------------------------------------------
class DIGIKAM_DATABASE_EXPORT AlbumCopyMoveHint
{
public:
/**
* An AlbumCopyMoveHint describes an existing album
* and a destination to which this album is expected to be
* copied, moved or renamed.
*/
AlbumCopyMoveHint() = default;
AlbumCopyMoveHint(int srcAlbumRootId, int srcAlbum,
int dstAlbumRootId, const QString& dstRelativePath);
int albumRootIdSrc() const;
int albumIdSrc() const;
bool isSrcAlbum(int albumRootId, int albumId) const;
CollectionScannerHints::Album src() const
{
return m_src;
}
int albumRootIdDst() const;
QString relativePathDst() const;<--- Function 'relativePathDst()' should return member 'relativePath' by const reference.
bool isDstAlbum(int albumRootId, const QString& relativePath) const;
CollectionScannerHints::DstPath dst() const<--- Function 'dst()' should return member 'm_dst' by const reference.
{
return m_dst;
}
QT_HASH_TYPE qHash() const;
bool operator==(const CollectionScannerHints::Album& src) const
{
return (src == m_src);
}
bool operator==(const CollectionScannerHints::DstPath& dst) const
{
return (dst == m_dst);
}
#ifdef HAVE_DBUS
AlbumCopyMoveHint& operator<<(const QDBusArgument& argument);
const AlbumCopyMoveHint& operator>>(QDBusArgument& argument) const;
#endif
operator const CollectionScannerHints::Album& () const
{
return m_src;
}
operator const CollectionScannerHints::DstPath& () const
{
return m_dst;
}
protected:
CollectionScannerHints::Album m_src;
CollectionScannerHints::DstPath m_dst;
};
// ---------------------------------------------------------------------------
class DIGIKAM_DATABASE_EXPORT ItemCopyMoveHint
{
public:
/**
* An ItemCopyMoveHint describes a list of existing items that will
* be copied, moved or renamed to an album given by album root id and album id.
* In the new album, the items will have the filenames given in dstNames.
*/
ItemCopyMoveHint() = default;
ItemCopyMoveHint(const QList<qlonglong>& srcIds,
int dstAlbumRootId,
int albumId,
const QStringList& dstNames);
QList<qlonglong> srcIds() const;<--- Function 'srcIds()' should return member 'm_srcIds' by const reference.
bool isSrcId(qlonglong id) const;
int albumRootIdDst() const;
int albumIdDst() const;
bool isDstAlbum(int albumRootId, int albumId) const;
CollectionScannerHints::Album dst() const
{
return m_dst;
}
QStringList dstNames() const;<--- Function 'dstNames()' should return member 'm_dstNames' by const reference.
QString dstName(qlonglong id) const;
bool operator==(const CollectionScannerHints::Album& dst) const
{
return (dst == m_dst);
}
#ifdef HAVE_DBUS
ItemCopyMoveHint& operator<<(const QDBusArgument& argument);
const ItemCopyMoveHint& operator>>(QDBusArgument& argument) const;
#endif
operator const CollectionScannerHints::Album& () const
{
return m_dst;
}
protected:
QList<qlonglong> m_srcIds;
CollectionScannerHints::Album m_dst;
QStringList m_dstNames;
};
// ---------------------------------------------------------------------------
class DIGIKAM_DATABASE_EXPORT ItemChangeHint
{
public:
/**
* An ItemCopyMoveHint describes a list of existing items that
* should be updated although the modification date may not have changed.
*/
enum ChangeType
{
ItemModified, ///< treat as if modification date changed
ItemRescan ///< reread metadata
};
public:
ItemChangeHint() = default;
explicit ItemChangeHint(const QList<qlonglong>& srcIds,
ChangeType type = ItemModified);
QList<qlonglong> ids() const;<--- Function 'ids()' should return member 'm_ids' by const reference.
bool isId(qlonglong id) const;
ChangeType changeType() const;
bool isModified() const
{
return (changeType() == ItemModified);
}
bool needsRescan() const
{
return (changeType() == ItemRescan);
}
#ifdef HAVE_DBUS
ItemChangeHint& operator<<(const QDBusArgument& argument);
const ItemChangeHint& operator>>(QDBusArgument& argument) const;
#endif
protected:
QList<qlonglong> m_ids;
ChangeType m_type = ItemModified;
};
// ---------------------------------------------------------------------------
class DIGIKAM_DATABASE_EXPORT ItemMetadataAdjustmentHint
{
public:
/**
* The file's has been edited writing out information from
* the database, i.e., the db is already guaranteed to contain
* all changed information in the file's metadata.
* There is no need for a full rescan, optimizations are possible.
*/
enum AdjustmentStatus
{
AboutToEditMetadata, ///< The file is about to be edited. Suspends scanning. The Finished hint must follow.
MetadataEditingFinished, ///< The file's metadata has been edited as described above.
MetadataEditingAborted ///< The file's metadata has not been edited, despite sending AboutToEditMedata
};
public:
ItemMetadataAdjustmentHint() = default;
explicit ItemMetadataAdjustmentHint(qlonglong id,
AdjustmentStatus status,
const QDateTime& modificationDateOnDisk,
qlonglong fileSize);
qlonglong id() const;
AdjustmentStatus adjustmentStatus() const;
QDateTime modificationDate() const;
qlonglong fileSize() const;
bool isAboutToEdit() const
{
return (adjustmentStatus() == AboutToEditMetadata);
}
bool isEditingFinished() const
{
return (adjustmentStatus() == MetadataEditingFinished);
}
bool isEditingFinishedAborted() const
{
return (adjustmentStatus() == MetadataEditingAborted);
}
#ifdef HAVE_DBUS
ItemMetadataAdjustmentHint& operator<<(const QDBusArgument& argument);
const ItemMetadataAdjustmentHint& operator>>(QDBusArgument& argument) const;
#endif
protected:
qlonglong m_id = 0;
AdjustmentStatus m_status = AboutToEditMetadata;
QDateTime m_modificationDate;
qlonglong m_fileSize = 0;
};
inline QT_HASH_TYPE qHash(const Digikam::AlbumCopyMoveHint& hint)
{
return hint.qHash();
}
} // namespace Digikam
#ifdef HAVE_DBUS
DECLARE_METATYPE_FOR_DBUS(Digikam::AlbumCopyMoveHint)
DECLARE_METATYPE_FOR_DBUS(Digikam::ItemCopyMoveHint)
DECLARE_METATYPE_FOR_DBUS(Digikam::ItemChangeHint)
#endif
|