]> cloud.milkyroute.net Git - dolphin.git/blob - src/kitemviews/kfileitemmodelrolesupdater.cpp
Merge branch 'release/21.12'
[dolphin.git] / src / kitemviews / kfileitemmodelrolesupdater.cpp
1 /*
2 * SPDX-FileCopyrightText: 2011 Peter Penz <peter.penz19@gmail.com>
3 *
4 * SPDX-License-Identifier: GPL-2.0-or-later
5 */
6
7 #include "kfileitemmodelrolesupdater.h"
8
9 #include "dolphindebug.h"
10 #include "kfileitemmodel.h"
11 #include "private/kdirectorycontentscounter.h"
12 #include "private/kpixmapmodifier.h"
13
14 #include <KConfig>
15 #include <KConfigGroup>
16 #include <KIO/JobUiDelegate>
17 #include <KIO/PreviewJob>
18 #include <KIconLoader>
19 #include <KJobWidgets>
20 #include <KOverlayIconPlugin>
21 #include <KPluginLoader>
22 #include <KSharedConfig>
23
24 #ifdef HAVE_BALOO
25 #include "private/kbaloorolesprovider.h"
26 #include <Baloo/File>
27 #include <Baloo/FileMonitor>
28 #endif
29
30 #include <QApplication>
31 #include <QIcon>
32 #include <QPainter>
33 #include <QElapsedTimer>
34 #include <QTimer>
35
36 // #define KFILEITEMMODELROLESUPDATER_DEBUG
37
38 namespace {
39 // Maximum time in ms that the KFileItemModelRolesUpdater
40 // may perform a blocking operation
41 const int MaxBlockTimeout = 200;
42
43 // If the number of items is smaller than ResolveAllItemsLimit,
44 // the roles of all items will be resolved.
45 const int ResolveAllItemsLimit = 500;
46
47 // Not only the visible area, but up to ReadAheadPages before and after
48 // this area will be resolved.
49 const int ReadAheadPages = 5;
50 }
51
52 KFileItemModelRolesUpdater::KFileItemModelRolesUpdater(KFileItemModel* model, QObject* parent) :
53 QObject(parent),
54 m_state(Idle),
55 m_previewChangedDuringPausing(false),
56 m_iconSizeChangedDuringPausing(false),
57 m_rolesChangedDuringPausing(false),
58 m_previewShown(false),
59 m_enlargeSmallPreviews(true),
60 m_clearPreviews(false),
61 m_finishedItems(),
62 m_model(model),
63 m_iconSize(),
64 m_firstVisibleIndex(0),
65 m_lastVisibleIndex(-1),
66 m_maximumVisibleItems(50),
67 m_roles(),
68 m_resolvableRoles(),
69 m_enabledPlugins(),
70 m_localFileSizePreviewLimit(0),
71 m_scanDirectories(true),
72 m_pendingSortRoleItems(),
73 m_pendingIndexes(),
74 m_pendingPreviewItems(),
75 m_previewJob(),
76 m_hoverSequenceItem(),
77 m_hoverSequenceIndex(0),
78 m_hoverSequencePreviewJob(nullptr),
79 m_hoverSequenceNumSuccessiveFailures(0),
80 m_recentlyChangedItemsTimer(nullptr),
81 m_recentlyChangedItems(),
82 m_changedItems(),
83 m_directoryContentsCounter(nullptr)
84 #ifdef HAVE_BALOO
85 , m_balooFileMonitor(nullptr)
86 #endif
87 {
88 Q_ASSERT(model);
89
90 const KConfigGroup globalConfig(KSharedConfig::openConfig(), "PreviewSettings");
91 m_enabledPlugins = globalConfig.readEntry("Plugins", KIO::PreviewJob::defaultPlugins());
92 m_localFileSizePreviewLimit = static_cast<qulonglong>(globalConfig.readEntry("MaximumSize", 0));
93
94 connect(m_model, &KFileItemModel::itemsInserted,
95 this, &KFileItemModelRolesUpdater::slotItemsInserted);
96 connect(m_model, &KFileItemModel::itemsRemoved,
97 this, &KFileItemModelRolesUpdater::slotItemsRemoved);
98 connect(m_model, &KFileItemModel::itemsChanged,
99 this, &KFileItemModelRolesUpdater::slotItemsChanged);
100 connect(m_model, &KFileItemModel::itemsMoved,
101 this, &KFileItemModelRolesUpdater::slotItemsMoved);
102 connect(m_model, &KFileItemModel::sortRoleChanged,
103 this, &KFileItemModelRolesUpdater::slotSortRoleChanged);
104
105 // Use a timer to prevent that each call of slotItemsChanged() results in a synchronous
106 // resolving of the roles. Postpone the resolving until no update has been done for 100 ms.
107 m_recentlyChangedItemsTimer = new QTimer(this);
108 m_recentlyChangedItemsTimer->setInterval(100);
109 m_recentlyChangedItemsTimer->setSingleShot(true);
110 connect(m_recentlyChangedItemsTimer, &QTimer::timeout, this, &KFileItemModelRolesUpdater::resolveRecentlyChangedItems);
111
112 m_resolvableRoles.insert("size");
113 m_resolvableRoles.insert("type");
114 m_resolvableRoles.insert("isExpandable");
115 #ifdef HAVE_BALOO
116 m_resolvableRoles += KBalooRolesProvider::instance().roles();
117 #endif
118
119 m_directoryContentsCounter = new KDirectoryContentsCounter(m_model, this);
120 connect(m_directoryContentsCounter, &KDirectoryContentsCounter::result,
121 this, &KFileItemModelRolesUpdater::slotDirectoryContentsCountReceived);
122
123 const auto plugins = KPluginLoader::instantiatePlugins(QStringLiteral("kf5/overlayicon"), nullptr, qApp);
124 for (QObject *it : plugins) {
125 auto plugin = qobject_cast<KOverlayIconPlugin*>(it);
126 if (plugin) {
127 m_overlayIconsPlugin.append(plugin);
128 connect(plugin, &KOverlayIconPlugin::overlaysChanged, this, &KFileItemModelRolesUpdater::slotOverlaysChanged);
129 } else {
130 // not our/valid plugin, so delete the created object
131 it->deleteLater();
132 }
133 }
134 }
135
136 KFileItemModelRolesUpdater::~KFileItemModelRolesUpdater()
137 {
138 killPreviewJob();
139 }
140
141 void KFileItemModelRolesUpdater::setIconSize(const QSize& size)
142 {
143 if (size != m_iconSize) {
144 m_iconSize = size;
145 if (m_state == Paused) {
146 m_iconSizeChangedDuringPausing = true;
147 } else if (m_previewShown) {
148 // An icon size change requires the regenerating of
149 // all previews
150 m_finishedItems.clear();
151 startUpdating();
152 }
153 }
154 }
155
156 QSize KFileItemModelRolesUpdater::iconSize() const
157 {
158 return m_iconSize;
159 }
160
161 void KFileItemModelRolesUpdater::setVisibleIndexRange(int index, int count)
162 {
163 if (index < 0) {
164 index = 0;
165 }
166 if (count < 0) {
167 count = 0;
168 }
169
170 if (index == m_firstVisibleIndex && count == m_lastVisibleIndex - m_firstVisibleIndex + 1) {
171 // The range has not been changed
172 return;
173 }
174
175 m_firstVisibleIndex = index;
176 m_lastVisibleIndex = qMin(index + count - 1, m_model->count() - 1);
177
178 startUpdating();
179 }
180
181 void KFileItemModelRolesUpdater::setMaximumVisibleItems(int count)
182 {
183 m_maximumVisibleItems = count;
184 }
185
186 void KFileItemModelRolesUpdater::setPreviewsShown(bool show)
187 {
188 if (show == m_previewShown) {
189 return;
190 }
191
192 m_previewShown = show;
193 if (!show) {
194 m_clearPreviews = true;
195 }
196
197 updateAllPreviews();
198 }
199
200 bool KFileItemModelRolesUpdater::previewsShown() const
201 {
202 return m_previewShown;
203 }
204
205 void KFileItemModelRolesUpdater::setEnlargeSmallPreviews(bool enlarge)
206 {
207 if (enlarge != m_enlargeSmallPreviews) {
208 m_enlargeSmallPreviews = enlarge;
209 if (m_previewShown) {
210 updateAllPreviews();
211 }
212 }
213 }
214
215 bool KFileItemModelRolesUpdater::enlargeSmallPreviews() const
216 {
217 return m_enlargeSmallPreviews;
218 }
219
220 void KFileItemModelRolesUpdater::setEnabledPlugins(const QStringList& list)
221 {
222 if (m_enabledPlugins != list) {
223 m_enabledPlugins = list;
224 if (m_previewShown) {
225 updateAllPreviews();
226 }
227 }
228 }
229
230 void KFileItemModelRolesUpdater::setPaused(bool paused)
231 {
232 if (paused == (m_state == Paused)) {
233 return;
234 }
235
236 if (paused) {
237 m_state = Paused;
238 killPreviewJob();
239 } else {
240 const bool updatePreviews = (m_iconSizeChangedDuringPausing && m_previewShown) ||
241 m_previewChangedDuringPausing;
242 const bool resolveAll = updatePreviews || m_rolesChangedDuringPausing;
243 if (resolveAll) {
244 m_finishedItems.clear();
245 }
246
247 m_iconSizeChangedDuringPausing = false;
248 m_previewChangedDuringPausing = false;
249 m_rolesChangedDuringPausing = false;
250
251 if (!m_pendingSortRoleItems.isEmpty()) {
252 m_state = ResolvingSortRole;
253 resolveNextSortRole();
254 } else {
255 m_state = Idle;
256 }
257
258 startUpdating();
259 }
260 }
261
262 void KFileItemModelRolesUpdater::setRoles(const QSet<QByteArray>& roles)
263 {
264 if (m_roles != roles) {
265 m_roles = roles;
266
267 #ifdef HAVE_BALOO
268 // Check whether there is at least one role that must be resolved
269 // with the help of Baloo. If this is the case, a (quite expensive)
270 // resolving will be done in KFileItemModelRolesUpdater::rolesData() and
271 // the role gets watched for changes.
272 const KBalooRolesProvider& rolesProvider = KBalooRolesProvider::instance();
273 bool hasBalooRole = false;
274 QSetIterator<QByteArray> it(roles);
275 while (it.hasNext()) {
276 const QByteArray& role = it.next();
277 if (rolesProvider.roles().contains(role)) {
278 hasBalooRole = true;
279 break;
280 }
281 }
282
283 if (hasBalooRole && m_balooConfig.fileIndexingEnabled() && !m_balooFileMonitor) {
284 m_balooFileMonitor = new Baloo::FileMonitor(this);
285 connect(m_balooFileMonitor, &Baloo::FileMonitor::fileMetaDataChanged,
286 this, &KFileItemModelRolesUpdater::applyChangedBalooRoles);
287 } else if (!hasBalooRole && m_balooFileMonitor) {
288 delete m_balooFileMonitor;
289 m_balooFileMonitor = nullptr;
290 }
291 #endif
292
293 if (m_state == Paused) {
294 m_rolesChangedDuringPausing = true;
295 } else {
296 startUpdating();
297 }
298 }
299 }
300
301 QSet<QByteArray> KFileItemModelRolesUpdater::roles() const
302 {
303 return m_roles;
304 }
305
306 bool KFileItemModelRolesUpdater::isPaused() const
307 {
308 return m_state == Paused;
309 }
310
311 QStringList KFileItemModelRolesUpdater::enabledPlugins() const
312 {
313 return m_enabledPlugins;
314 }
315
316 void KFileItemModelRolesUpdater::setLocalFileSizePreviewLimit(const qlonglong size)
317 {
318 m_localFileSizePreviewLimit = size;
319 }
320
321 qlonglong KFileItemModelRolesUpdater::localFileSizePreviewLimit() const
322 {
323 return m_localFileSizePreviewLimit;
324 }
325
326 void KFileItemModelRolesUpdater::setScanDirectories(bool enabled)
327 {
328 m_scanDirectories = enabled;
329 }
330
331 bool KFileItemModelRolesUpdater::scanDirectories() const
332 {
333 return m_scanDirectories;
334 }
335
336 void KFileItemModelRolesUpdater::setHoverSequenceState(const QUrl& itemUrl, int seqIdx)
337 {
338 const KFileItem item = m_model->fileItem(itemUrl);
339
340 if (item != m_hoverSequenceItem) {
341 killHoverSequencePreviewJob();
342 }
343
344 m_hoverSequenceItem = item;
345 m_hoverSequenceIndex = seqIdx;
346
347 if (!m_previewShown) {
348 return;
349 }
350
351 m_hoverSequenceNumSuccessiveFailures = 0;
352
353 loadNextHoverSequencePreview();
354 }
355
356 void KFileItemModelRolesUpdater::slotItemsInserted(const KItemRangeList& itemRanges)
357 {
358 QElapsedTimer timer;
359 timer.start();
360
361 // Determine the sort role synchronously for as many items as possible.
362 if (m_resolvableRoles.contains(m_model->sortRole())) {
363 int insertedCount = 0;
364 for (const KItemRange& range : itemRanges) {
365 const int lastIndex = insertedCount + range.index + range.count - 1;
366 for (int i = insertedCount + range.index; i <= lastIndex; ++i) {
367 if (timer.elapsed() < MaxBlockTimeout) {
368 applySortRole(i);
369 } else {
370 m_pendingSortRoleItems.insert(m_model->fileItem(i));
371 }
372 }
373 insertedCount += range.count;
374 }
375
376 applySortProgressToModel();
377
378 // If there are still items whose sort role is unknown, check if the
379 // asynchronous determination of the sort role is already in progress,
380 // and start it if that is not the case.
381 if (!m_pendingSortRoleItems.isEmpty() && m_state != ResolvingSortRole) {
382 killPreviewJob();
383 m_state = ResolvingSortRole;
384 resolveNextSortRole();
385 }
386 }
387
388 startUpdating();
389 }
390
391 void KFileItemModelRolesUpdater::slotItemsRemoved(const KItemRangeList& itemRanges)
392 {
393 Q_UNUSED(itemRanges)
394
395 const bool allItemsRemoved = (m_model->count() == 0);
396
397 #ifdef HAVE_BALOO
398 if (m_balooFileMonitor) {
399 // Don't let the FileWatcher watch for removed items
400 if (allItemsRemoved) {
401 m_balooFileMonitor->clear();
402 } else {
403 QStringList newFileList;
404 const QStringList oldFileList = m_balooFileMonitor->files();
405 for (const QString& file : oldFileList) {
406 if (m_model->index(QUrl::fromLocalFile(file)) >= 0) {
407 newFileList.append(file);
408 }
409 }
410 m_balooFileMonitor->setFiles(newFileList);
411 }
412 }
413 #endif
414
415 if (allItemsRemoved) {
416 m_state = Idle;
417
418 m_finishedItems.clear();
419 m_pendingSortRoleItems.clear();
420 m_pendingIndexes.clear();
421 m_pendingPreviewItems.clear();
422 m_recentlyChangedItems.clear();
423 m_recentlyChangedItemsTimer->stop();
424 m_changedItems.clear();
425 m_hoverSequenceLoadedItems.clear();
426
427 killPreviewJob();
428 } else {
429 // Only remove the items from m_finishedItems. They will be removed
430 // from the other sets later on.
431 QSet<KFileItem>::iterator it = m_finishedItems.begin();
432 while (it != m_finishedItems.end()) {
433 if (m_model->index(*it) < 0) {
434 it = m_finishedItems.erase(it);
435 } else {
436 ++it;
437 }
438 }
439
440 // Removed items won't have hover previews loaded anymore.
441 for (const KItemRange& itemRange : itemRanges) {
442 int index = itemRange.index;
443 for (int count = itemRange.count; count > 0; --count) {
444 const KFileItem item = m_model->fileItem(index);
445 m_hoverSequenceLoadedItems.remove(item);
446 ++index;
447 }
448 }
449
450 // The visible items might have changed.
451 startUpdating();
452 }
453 }
454
455 void KFileItemModelRolesUpdater::slotItemsMoved(const KItemRange& itemRange, const QList<int> &movedToIndexes)
456 {
457 Q_UNUSED(itemRange)
458 Q_UNUSED(movedToIndexes)
459
460 // The visible items might have changed.
461 startUpdating();
462 }
463
464 void KFileItemModelRolesUpdater::slotItemsChanged(const KItemRangeList& itemRanges,
465 const QSet<QByteArray>& roles)
466 {
467 Q_UNUSED(roles)
468
469 // Find out if slotItemsChanged() has been done recently. If that is the
470 // case, resolving the roles is postponed until a timer has exceeded
471 // to prevent expensive repeated updates if files are updated frequently.
472 const bool itemsChangedRecently = m_recentlyChangedItemsTimer->isActive();
473
474 QSet<KFileItem>& targetSet = itemsChangedRecently ? m_recentlyChangedItems : m_changedItems;
475
476 for (const KItemRange& itemRange : itemRanges) {
477 int index = itemRange.index;
478 for (int count = itemRange.count; count > 0; --count) {
479 const KFileItem item = m_model->fileItem(index);
480 targetSet.insert(item);
481 ++index;
482 }
483 }
484
485 m_recentlyChangedItemsTimer->start();
486
487 if (!itemsChangedRecently) {
488 updateChangedItems();
489 }
490 }
491
492 void KFileItemModelRolesUpdater::slotSortRoleChanged(const QByteArray& current,
493 const QByteArray& previous)
494 {
495 Q_UNUSED(current)
496 Q_UNUSED(previous)
497
498 if (m_resolvableRoles.contains(current)) {
499 m_pendingSortRoleItems.clear();
500 m_finishedItems.clear();
501
502 const int count = m_model->count();
503 QElapsedTimer timer;
504 timer.start();
505
506 // Determine the sort role synchronously for as many items as possible.
507 for (int index = 0; index < count; ++index) {
508 if (timer.elapsed() < MaxBlockTimeout) {
509 applySortRole(index);
510 } else {
511 m_pendingSortRoleItems.insert(m_model->fileItem(index));
512 }
513 }
514
515 applySortProgressToModel();
516
517 if (!m_pendingSortRoleItems.isEmpty()) {
518 // Trigger the asynchronous determination of the sort role.
519 killPreviewJob();
520 m_state = ResolvingSortRole;
521 resolveNextSortRole();
522 }
523 } else {
524 m_state = Idle;
525 m_pendingSortRoleItems.clear();
526 applySortProgressToModel();
527 }
528 }
529
530 void KFileItemModelRolesUpdater::slotGotPreview(const KFileItem& item, const QPixmap& pixmap)
531 {
532 if (m_state != PreviewJobRunning) {
533 return;
534 }
535
536 m_changedItems.remove(item);
537
538 const int index = m_model->index(item);
539 if (index < 0) {
540 return;
541 }
542
543 QPixmap scaledPixmap = transformPreviewPixmap(pixmap);
544
545 QHash<QByteArray, QVariant> data = rolesData(item);
546
547 const QStringList overlays = data["iconOverlays"].toStringList();
548 // Strangely KFileItem::overlays() returns empty string-values, so
549 // we need to check first whether an overlay must be drawn at all.
550 // It is more efficient to do it here, as KIconLoader::drawOverlays()
551 // assumes that an overlay will be drawn and has some additional
552 // setup time.
553 if (!scaledPixmap.isNull()) {
554 for (const QString& overlay : overlays) {
555 if (!overlay.isEmpty()) {
556 // There is at least one overlay, draw all overlays above m_pixmap
557 // and cancel the check
558 KIconLoader::global()->drawOverlays(overlays, scaledPixmap, KIconLoader::Desktop);
559 break;
560 }
561 }
562 }
563
564 data.insert("iconPixmap", scaledPixmap);
565
566 disconnect(m_model, &KFileItemModel::itemsChanged,
567 this, &KFileItemModelRolesUpdater::slotItemsChanged);
568 m_model->setData(index, data);
569 connect(m_model, &KFileItemModel::itemsChanged,
570 this, &KFileItemModelRolesUpdater::slotItemsChanged);
571
572 m_finishedItems.insert(item);
573 }
574
575 void KFileItemModelRolesUpdater::slotPreviewFailed(const KFileItem& item)
576 {
577 if (m_state != PreviewJobRunning) {
578 return;
579 }
580
581 m_changedItems.remove(item);
582
583 const int index = m_model->index(item);
584 if (index >= 0) {
585 QHash<QByteArray, QVariant> data;
586 data.insert("iconPixmap", QPixmap());
587
588 disconnect(m_model, &KFileItemModel::itemsChanged,
589 this, &KFileItemModelRolesUpdater::slotItemsChanged);
590 m_model->setData(index, data);
591 connect(m_model, &KFileItemModel::itemsChanged,
592 this, &KFileItemModelRolesUpdater::slotItemsChanged);
593
594 applyResolvedRoles(index, ResolveAll);
595 m_finishedItems.insert(item);
596 }
597 }
598
599 void KFileItemModelRolesUpdater::slotPreviewJobFinished()
600 {
601 m_previewJob = nullptr;
602
603 if (m_state != PreviewJobRunning) {
604 return;
605 }
606
607 m_state = Idle;
608
609 if (!m_pendingPreviewItems.isEmpty()) {
610 startPreviewJob();
611 } else {
612 if (!m_changedItems.isEmpty()) {
613 updateChangedItems();
614 }
615 }
616 }
617
618 void KFileItemModelRolesUpdater::slotHoverSequenceGotPreview(const KFileItem& item, const QPixmap& pixmap)
619 {
620 const int index = m_model->index(item);
621 if (index < 0) {
622 return;
623 }
624
625 QHash<QByteArray, QVariant> data = m_model->data(index);
626 QVector<QPixmap> pixmaps = data["hoverSequencePixmaps"].value<QVector<QPixmap>>();
627 const int loadedIndex = pixmaps.size();
628
629 float wap = m_hoverSequencePreviewJob->sequenceIndexWraparoundPoint();
630 if (!m_hoverSequencePreviewJob->handlesSequences()) {
631 wap = 1.0f;
632 }
633 if (wap >= 0.0f) {
634 data["hoverSequenceWraparoundPoint"] = wap;
635 m_model->setData(index, data);
636 }
637
638 // For hover sequence previews we never load index 0, because that's just the regular preview
639 // in "iconPixmap". But that means we'll load index 1 even for thumbnailers that don't support
640 // sequences, in which case we can just throw away the preview because it's the same as for
641 // index 0. Unfortunately we can't find it out earlier :(
642 if (wap < 0.0f || loadedIndex < static_cast<int>(wap)) {
643 // Add the preview to the model data
644
645 const QPixmap scaledPixmap = transformPreviewPixmap(pixmap);
646
647 pixmaps.append(scaledPixmap);
648 data["hoverSequencePixmaps"] = QVariant::fromValue(pixmaps);
649
650 m_model->setData(index, data);
651
652 const auto loadedIt = std::find(m_hoverSequenceLoadedItems.begin(),
653 m_hoverSequenceLoadedItems.end(), item);
654 if (loadedIt == m_hoverSequenceLoadedItems.end()) {
655 m_hoverSequenceLoadedItems.push_back(item);
656 trimHoverSequenceLoadedItems();
657 }
658 }
659
660 m_hoverSequenceNumSuccessiveFailures = 0;
661 }
662
663 void KFileItemModelRolesUpdater::slotHoverSequencePreviewFailed(const KFileItem& item)
664 {
665 const int index = m_model->index(item);
666 if (index < 0) {
667 return;
668 }
669
670 static const int numRetries = 2;
671
672 QHash<QByteArray, QVariant> data = m_model->data(index);
673 QVector<QPixmap> pixmaps = data["hoverSequencePixmaps"].value<QVector<QPixmap>>();
674
675 qCDebug(DolphinDebug).nospace()
676 << "Failed to generate hover sequence preview #" << pixmaps.size()
677 << " for file " << item.url().toString()
678 << " (attempt " << (m_hoverSequenceNumSuccessiveFailures+1)
679 << "/" << (numRetries+1) << ")";
680
681 if (m_hoverSequenceNumSuccessiveFailures >= numRetries) {
682 // Give up and simply duplicate the previous sequence image (if any)
683
684 pixmaps.append(pixmaps.empty() ? QPixmap() : pixmaps.last());
685 data["hoverSequencePixmaps"] = QVariant::fromValue(pixmaps);
686
687 if (!data.contains("hoverSequenceWraparoundPoint")) {
688 // hoverSequenceWraparoundPoint is only available when PreviewJob succeeds, so unless
689 // it has previously succeeded, it's best to assume that it just doesn't handle
690 // sequences instead of trying to load the next image indefinitely.
691 data["hoverSequenceWraparoundPoint"] = 1.0f;
692 }
693
694 m_model->setData(index, data);
695
696 m_hoverSequenceNumSuccessiveFailures = 0;
697 } else {
698 // Retry
699
700 m_hoverSequenceNumSuccessiveFailures++;
701 }
702
703 // Next image in the sequence (or same one if the retry limit wasn't reached yet) will be
704 // loaded automatically, because slotHoverSequencePreviewJobFinished() will be triggered
705 // even when PreviewJob fails.
706 }
707
708 void KFileItemModelRolesUpdater::slotHoverSequencePreviewJobFinished()
709 {
710 const int index = m_model->index(m_hoverSequenceItem);
711 if (index < 0) {
712 m_hoverSequencePreviewJob = nullptr;
713 return;
714 }
715
716 // Since a PreviewJob can only have one associated sequence index, we can only generate
717 // one sequence image per job, so we have to start another one for the next index.
718
719 // Load the next image in the sequence
720 m_hoverSequencePreviewJob = nullptr;
721 loadNextHoverSequencePreview();
722 }
723
724 void KFileItemModelRolesUpdater::resolveNextSortRole()
725 {
726 if (m_state != ResolvingSortRole) {
727 return;
728 }
729
730 QSet<KFileItem>::iterator it = m_pendingSortRoleItems.begin();
731 while (it != m_pendingSortRoleItems.end()) {
732 const KFileItem item = *it;
733 const int index = m_model->index(item);
734
735 // Continue if the sort role has already been determined for the
736 // item, and the item has not been changed recently.
737 if (!m_changedItems.contains(item) && m_model->data(index).contains(m_model->sortRole())) {
738 it = m_pendingSortRoleItems.erase(it);
739 continue;
740 }
741
742 applySortRole(index);
743 m_pendingSortRoleItems.erase(it);
744 break;
745 }
746
747 if (!m_pendingSortRoleItems.isEmpty()) {
748 applySortProgressToModel();
749 QTimer::singleShot(0, this, &KFileItemModelRolesUpdater::resolveNextSortRole);
750 } else {
751 m_state = Idle;
752
753 // Prevent that we try to update the items twice.
754 disconnect(m_model, &KFileItemModel::itemsMoved,
755 this, &KFileItemModelRolesUpdater::slotItemsMoved);
756 applySortProgressToModel();
757 connect(m_model, &KFileItemModel::itemsMoved,
758 this, &KFileItemModelRolesUpdater::slotItemsMoved);
759 startUpdating();
760 }
761 }
762
763 void KFileItemModelRolesUpdater::resolveNextPendingRoles()
764 {
765 if (m_state != ResolvingAllRoles) {
766 return;
767 }
768
769 while (!m_pendingIndexes.isEmpty()) {
770 const int index = m_pendingIndexes.takeFirst();
771 const KFileItem item = m_model->fileItem(index);
772
773 if (m_finishedItems.contains(item)) {
774 continue;
775 }
776
777 applyResolvedRoles(index, ResolveAll);
778 m_finishedItems.insert(item);
779 m_changedItems.remove(item);
780 break;
781 }
782
783 if (!m_pendingIndexes.isEmpty()) {
784 QTimer::singleShot(0, this, &KFileItemModelRolesUpdater::resolveNextPendingRoles);
785 } else {
786 m_state = Idle;
787
788 if (m_clearPreviews) {
789 // Only go through the list if there are items which might still have previews.
790 if (m_finishedItems.count() != m_model->count()) {
791 QHash<QByteArray, QVariant> data;
792 data.insert("iconPixmap", QPixmap());
793 data.insert("hoverSequencePixmaps", QVariant::fromValue(QVector<QPixmap>()));
794
795 disconnect(m_model, &KFileItemModel::itemsChanged,
796 this, &KFileItemModelRolesUpdater::slotItemsChanged);
797 for (int index = 0; index <= m_model->count(); ++index) {
798 if (m_model->data(index).contains("iconPixmap") ||
799 m_model->data(index).contains("hoverSequencePixmaps"))
800 {
801 m_model->setData(index, data);
802 }
803 }
804 connect(m_model, &KFileItemModel::itemsChanged,
805 this, &KFileItemModelRolesUpdater::slotItemsChanged);
806
807 }
808 m_clearPreviews = false;
809 }
810
811 if (!m_changedItems.isEmpty()) {
812 updateChangedItems();
813 }
814 }
815 }
816
817 void KFileItemModelRolesUpdater::resolveRecentlyChangedItems()
818 {
819 m_changedItems += m_recentlyChangedItems;
820 m_recentlyChangedItems.clear();
821 updateChangedItems();
822 }
823
824 void KFileItemModelRolesUpdater::applyChangedBalooRoles(const QString& file)
825 {
826 #ifdef HAVE_BALOO
827 const KFileItem item = m_model->fileItem(QUrl::fromLocalFile(file));
828
829 if (item.isNull()) {
830 // itemUrl is not in the model anymore, probably because
831 // the corresponding file has been deleted in the meantime.
832 return;
833 }
834 applyChangedBalooRolesForItem(item);
835 #else
836 Q_UNUSED(file)
837 #endif
838 }
839
840 void KFileItemModelRolesUpdater::applyChangedBalooRolesForItem(const KFileItem &item)
841 {
842 #ifdef HAVE_BALOO
843 Baloo::File file(item.localPath());
844 file.load();
845
846 const KBalooRolesProvider& rolesProvider = KBalooRolesProvider::instance();
847 QHash<QByteArray, QVariant> data;
848
849 const auto roles = rolesProvider.roles();
850 for (const QByteArray& role : roles) {
851 // Overwrite all the role values with an empty QVariant, because the roles
852 // provider doesn't overwrite it when the property value list is empty.
853 // See bug 322348
854 data.insert(role, QVariant());
855 }
856
857 QHashIterator<QByteArray, QVariant> it(rolesProvider.roleValues(file, m_roles));
858 while (it.hasNext()) {
859 it.next();
860 data.insert(it.key(), it.value());
861 }
862
863 disconnect(m_model, &KFileItemModel::itemsChanged,
864 this, &KFileItemModelRolesUpdater::slotItemsChanged);
865 const int index = m_model->index(item);
866 m_model->setData(index, data);
867 connect(m_model, &KFileItemModel::itemsChanged,
868 this, &KFileItemModelRolesUpdater::slotItemsChanged);
869 #else
870 #ifndef Q_CC_MSVC
871 Q_UNUSED(item)
872 #endif
873 #endif
874 }
875
876 void KFileItemModelRolesUpdater::slotDirectoryContentsCountReceived(const QString& path, int count, long size)
877 {
878 const bool getSizeRole = m_roles.contains("size");
879 const bool getIsExpandableRole = m_roles.contains("isExpandable");
880
881 if (getSizeRole || getIsExpandableRole) {
882 const int index = m_model->index(QUrl::fromLocalFile(path));
883 if (index >= 0) {
884 QHash<QByteArray, QVariant> data;
885
886 if (getSizeRole) {
887 data.insert("count", count);
888 data.insert("size", QVariant::fromValue(size));
889 }
890 if (getIsExpandableRole) {
891 data.insert("isExpandable", count > 0);
892 }
893
894 disconnect(m_model, &KFileItemModel::itemsChanged,
895 this, &KFileItemModelRolesUpdater::slotItemsChanged);
896 m_model->setData(index, data);
897 connect(m_model, &KFileItemModel::itemsChanged,
898 this, &KFileItemModelRolesUpdater::slotItemsChanged);
899 }
900 }
901 }
902
903 void KFileItemModelRolesUpdater::startUpdating()
904 {
905 if (m_state == Paused) {
906 return;
907 }
908
909 if (m_finishedItems.count() == m_model->count()) {
910 // All roles have been resolved already.
911 m_state = Idle;
912 return;
913 }
914
915 // Terminate all updates that are currently active.
916 killPreviewJob();
917 m_pendingIndexes.clear();
918
919 QElapsedTimer timer;
920 timer.start();
921
922 // Determine the icons for the visible items synchronously.
923 updateVisibleIcons();
924
925 // A detailed update of the items in and near the visible area
926 // only makes sense if sorting is finished.
927 if (m_state == ResolvingSortRole) {
928 return;
929 }
930
931 // Start the preview job or the asynchronous resolving of all roles.
932 QList<int> indexes = indexesToResolve();
933
934 if (m_previewShown) {
935 m_pendingPreviewItems.clear();
936 m_pendingPreviewItems.reserve(indexes.count());
937
938 for (int index : qAsConst(indexes)) {
939 const KFileItem item = m_model->fileItem(index);
940 if (!m_finishedItems.contains(item)) {
941 m_pendingPreviewItems.append(item);
942 }
943 }
944
945 startPreviewJob();
946 } else {
947 m_pendingIndexes = indexes;
948 // Trigger the asynchronous resolving of all roles.
949 m_state = ResolvingAllRoles;
950 QTimer::singleShot(0, this, &KFileItemModelRolesUpdater::resolveNextPendingRoles);
951 }
952 }
953
954 void KFileItemModelRolesUpdater::updateVisibleIcons()
955 {
956 int lastVisibleIndex = m_lastVisibleIndex;
957 if (lastVisibleIndex <= 0) {
958 // Guess a reasonable value for the last visible index if the view
959 // has not told us about the real value yet.
960 lastVisibleIndex = qMin(m_firstVisibleIndex + m_maximumVisibleItems, m_model->count() - 1);
961 if (lastVisibleIndex <= 0) {
962 lastVisibleIndex = qMin(200, m_model->count() - 1);
963 }
964 }
965
966 QElapsedTimer timer;
967 timer.start();
968
969 // Try to determine the final icons for all visible items.
970 int index;
971 for (index = m_firstVisibleIndex; index <= lastVisibleIndex && timer.elapsed() < MaxBlockTimeout; ++index) {
972 applyResolvedRoles(index, ResolveFast);
973 }
974
975 // KFileItemListView::initializeItemListWidget(KItemListWidget*) will load
976 // preliminary icons (i.e., without mime type determination) for the
977 // remaining items.
978 }
979
980 void KFileItemModelRolesUpdater::startPreviewJob()
981 {
982 m_state = PreviewJobRunning;
983
984 if (m_pendingPreviewItems.isEmpty()) {
985 QTimer::singleShot(0, this, &KFileItemModelRolesUpdater::slotPreviewJobFinished);
986 return;
987 }
988
989 // PreviewJob internally caches items always with the size of
990 // 128 x 128 pixels or 256 x 256 pixels. A (slow) downscaling is done
991 // by PreviewJob if a smaller size is requested. For images KFileItemModelRolesUpdater must
992 // do a downscaling anyhow because of the frame, so in this case only the provided
993 // cache sizes are requested.
994 const QSize cacheSize = (m_iconSize.width() > 128) || (m_iconSize.height() > 128)
995 ? QSize(256, 256) : QSize(128, 128);
996
997 // KIO::filePreview() will request the MIME-type of all passed items, which (in the
998 // worst case) might block the application for several seconds. To prevent such
999 // a blocking, we only pass items with known mime type to the preview job.
1000 const int count = m_pendingPreviewItems.count();
1001 KFileItemList itemSubSet;
1002 itemSubSet.reserve(count);
1003
1004 if (m_pendingPreviewItems.first().isMimeTypeKnown()) {
1005 // Some mime types are known already, probably because they were
1006 // determined when loading the icons for the visible items. Start
1007 // a preview job for all items at the beginning of the list which
1008 // have a known mime type.
1009 do {
1010 itemSubSet.append(m_pendingPreviewItems.takeFirst());
1011 } while (!m_pendingPreviewItems.isEmpty() && m_pendingPreviewItems.first().isMimeTypeKnown());
1012 } else {
1013 // Determine mime types for MaxBlockTimeout ms, and start a preview
1014 // job for the corresponding items.
1015 QElapsedTimer timer;
1016 timer.start();
1017
1018 do {
1019 const KFileItem item = m_pendingPreviewItems.takeFirst();
1020 item.determineMimeType();
1021 itemSubSet.append(item);
1022 } while (!m_pendingPreviewItems.isEmpty() && timer.elapsed() < MaxBlockTimeout);
1023 }
1024
1025 KIO::PreviewJob* job = new KIO::PreviewJob(itemSubSet, cacheSize, &m_enabledPlugins);
1026
1027 job->setIgnoreMaximumSize(itemSubSet.first().isLocalFile() && m_localFileSizePreviewLimit <= 0);
1028 if (job->uiDelegate()) {
1029 KJobWidgets::setWindow(job, qApp->activeWindow());
1030 }
1031
1032 connect(job, &KIO::PreviewJob::gotPreview,
1033 this, &KFileItemModelRolesUpdater::slotGotPreview);
1034 connect(job, &KIO::PreviewJob::failed,
1035 this, &KFileItemModelRolesUpdater::slotPreviewFailed);
1036 connect(job, &KIO::PreviewJob::finished,
1037 this, &KFileItemModelRolesUpdater::slotPreviewJobFinished);
1038
1039 m_previewJob = job;
1040 }
1041
1042 QPixmap KFileItemModelRolesUpdater::transformPreviewPixmap(const QPixmap& pixmap)
1043 {
1044 QPixmap scaledPixmap = pixmap;
1045
1046 if (!pixmap.hasAlpha() && !pixmap.isNull()
1047 && m_iconSize.width() > KIconLoader::SizeSmallMedium
1048 && m_iconSize.height() > KIconLoader::SizeSmallMedium) {
1049 if (m_enlargeSmallPreviews) {
1050 KPixmapModifier::applyFrame(scaledPixmap, m_iconSize);
1051 } else {
1052 // Assure that small previews don't get enlarged. Instead they
1053 // should be shown centered within the frame.
1054 const QSize contentSize = KPixmapModifier::sizeInsideFrame(m_iconSize);
1055 const bool enlargingRequired = scaledPixmap.width() < contentSize.width() &&
1056 scaledPixmap.height() < contentSize.height();
1057 if (enlargingRequired) {
1058 QSize frameSize = scaledPixmap.size() / scaledPixmap.devicePixelRatio();
1059 frameSize.scale(m_iconSize, Qt::KeepAspectRatio);
1060
1061 QPixmap largeFrame(frameSize);
1062 largeFrame.fill(Qt::transparent);
1063
1064 KPixmapModifier::applyFrame(largeFrame, frameSize);
1065
1066 QPainter painter(&largeFrame);
1067 painter.drawPixmap((largeFrame.width() - scaledPixmap.width() / scaledPixmap.devicePixelRatio()) / 2,
1068 (largeFrame.height() - scaledPixmap.height() / scaledPixmap.devicePixelRatio()) / 2,
1069 scaledPixmap);
1070 scaledPixmap = largeFrame;
1071 } else {
1072 // The image must be shrunk as it is too large to fit into
1073 // the available icon size
1074 KPixmapModifier::applyFrame(scaledPixmap, m_iconSize);
1075 }
1076 }
1077 } else if (!pixmap.isNull()) {
1078 KPixmapModifier::scale(scaledPixmap, m_iconSize * qApp->devicePixelRatio());
1079 scaledPixmap.setDevicePixelRatio(qApp->devicePixelRatio());
1080 }
1081
1082 return scaledPixmap;
1083 }
1084
1085 void KFileItemModelRolesUpdater::loadNextHoverSequencePreview()
1086 {
1087 if (m_hoverSequenceItem.isNull() || m_hoverSequencePreviewJob) {
1088 return;
1089 }
1090
1091 const int index = m_model->index(m_hoverSequenceItem);
1092 if (index < 0) {
1093 return;
1094 }
1095
1096 // We generate the next few sequence indices in advance (buffering)
1097 const int maxSeqIdx = m_hoverSequenceIndex+5;
1098
1099 QHash<QByteArray, QVariant> data = m_model->data(index);
1100
1101 if (!data.contains("hoverSequencePixmaps")) {
1102 // The pixmap at index 0 isn't used ("iconPixmap" will be used instead)
1103 data.insert("hoverSequencePixmaps", QVariant::fromValue(QVector<QPixmap>() << QPixmap()));
1104 m_model->setData(index, data);
1105 }
1106
1107 const QVector<QPixmap> pixmaps = data["hoverSequencePixmaps"].value<QVector<QPixmap>>();
1108
1109 const int loadSeqIdx = pixmaps.size();
1110
1111 float wap = -1.0f;
1112 if (data.contains("hoverSequenceWraparoundPoint")) {
1113 wap = data["hoverSequenceWraparoundPoint"].toFloat();
1114 }
1115 if (wap >= 1.0f && loadSeqIdx >= static_cast<int>(wap)) {
1116 // Reached the wraparound point -> no more previews to load.
1117 return;
1118 }
1119
1120 if (loadSeqIdx > maxSeqIdx) {
1121 // Wait until setHoverSequenceState() is called with a higher sequence index.
1122 return;
1123 }
1124
1125 // PreviewJob internally caches items always with the size of
1126 // 128 x 128 pixels or 256 x 256 pixels. A (slow) downscaling is done
1127 // by PreviewJob if a smaller size is requested. For images KFileItemModelRolesUpdater must
1128 // do a downscaling anyhow because of the frame, so in this case only the provided
1129 // cache sizes are requested.
1130 const QSize cacheSize = (m_iconSize.width() > 128) || (m_iconSize.height() > 128)
1131 ? QSize(256, 256) : QSize(128, 128);
1132
1133 KIO::PreviewJob* job = new KIO::PreviewJob({m_hoverSequenceItem}, cacheSize, &m_enabledPlugins);
1134
1135 job->setSequenceIndex(loadSeqIdx);
1136 job->setIgnoreMaximumSize(m_hoverSequenceItem.isLocalFile() && m_localFileSizePreviewLimit <= 0);
1137 if (job->uiDelegate()) {
1138 KJobWidgets::setWindow(job, qApp->activeWindow());
1139 }
1140
1141 connect(job, &KIO::PreviewJob::gotPreview,
1142 this, &KFileItemModelRolesUpdater::slotHoverSequenceGotPreview);
1143 connect(job, &KIO::PreviewJob::failed,
1144 this, &KFileItemModelRolesUpdater::slotHoverSequencePreviewFailed);
1145 connect(job, &KIO::PreviewJob::finished,
1146 this, &KFileItemModelRolesUpdater::slotHoverSequencePreviewJobFinished);
1147
1148 m_hoverSequencePreviewJob = job;
1149 }
1150
1151 void KFileItemModelRolesUpdater::killHoverSequencePreviewJob()
1152 {
1153 if (m_hoverSequencePreviewJob) {
1154 disconnect(m_hoverSequencePreviewJob, &KIO::PreviewJob::gotPreview,
1155 this, &KFileItemModelRolesUpdater::slotHoverSequenceGotPreview);
1156 disconnect(m_hoverSequencePreviewJob, &KIO::PreviewJob::failed,
1157 this, &KFileItemModelRolesUpdater::slotHoverSequencePreviewFailed);
1158 disconnect(m_hoverSequencePreviewJob, &KIO::PreviewJob::finished,
1159 this, &KFileItemModelRolesUpdater::slotHoverSequencePreviewJobFinished);
1160 m_hoverSequencePreviewJob->kill();
1161 m_hoverSequencePreviewJob = nullptr;
1162 }
1163 }
1164
1165 void KFileItemModelRolesUpdater::updateChangedItems()
1166 {
1167 if (m_state == Paused) {
1168 return;
1169 }
1170
1171 if (m_changedItems.isEmpty()) {
1172 return;
1173 }
1174
1175 m_finishedItems -= m_changedItems;
1176
1177 if (m_resolvableRoles.contains(m_model->sortRole())) {
1178 m_pendingSortRoleItems += m_changedItems;
1179
1180 if (m_state != ResolvingSortRole) {
1181 // Stop the preview job if necessary, and trigger the
1182 // asynchronous determination of the sort role.
1183 killPreviewJob();
1184 m_state = ResolvingSortRole;
1185 QTimer::singleShot(0, this, &KFileItemModelRolesUpdater::resolveNextSortRole);
1186 }
1187
1188 return;
1189 }
1190
1191 QList<int> visibleChangedIndexes;
1192 QList<int> invisibleChangedIndexes;
1193 visibleChangedIndexes.reserve(m_changedItems.size());
1194 invisibleChangedIndexes.reserve(m_changedItems.size());
1195
1196 auto changedItemsIt = m_changedItems.begin();
1197 while (changedItemsIt != m_changedItems.end()) {
1198 const auto& item = *changedItemsIt;
1199 const int index = m_model->index(item);
1200
1201 if (index < 0) {
1202 changedItemsIt = m_changedItems.erase(changedItemsIt);
1203 continue;
1204 }
1205 ++changedItemsIt;
1206
1207 if (index >= m_firstVisibleIndex && index <= m_lastVisibleIndex) {
1208 visibleChangedIndexes.append(index);
1209 } else {
1210 invisibleChangedIndexes.append(index);
1211 }
1212 }
1213
1214 std::sort(visibleChangedIndexes.begin(), visibleChangedIndexes.end());
1215
1216 if (m_previewShown) {
1217 for (int index : qAsConst(visibleChangedIndexes)) {
1218 m_pendingPreviewItems.append(m_model->fileItem(index));
1219 }
1220
1221 for (int index : qAsConst(invisibleChangedIndexes)) {
1222 m_pendingPreviewItems.append(m_model->fileItem(index));
1223 }
1224
1225 if (!m_previewJob) {
1226 startPreviewJob();
1227 }
1228 } else {
1229 const bool resolvingInProgress = !m_pendingIndexes.isEmpty();
1230 m_pendingIndexes = visibleChangedIndexes + m_pendingIndexes + invisibleChangedIndexes;
1231 if (!resolvingInProgress) {
1232 // Trigger the asynchronous resolving of the changed roles.
1233 m_state = ResolvingAllRoles;
1234 QTimer::singleShot(0, this, &KFileItemModelRolesUpdater::resolveNextPendingRoles);
1235 }
1236 }
1237 }
1238
1239 void KFileItemModelRolesUpdater::applySortRole(int index)
1240 {
1241 QHash<QByteArray, QVariant> data;
1242 const KFileItem item = m_model->fileItem(index);
1243
1244 if (m_model->sortRole() == "type") {
1245 if (!item.isMimeTypeKnown()) {
1246 item.determineMimeType();
1247 }
1248
1249 data.insert("type", item.mimeComment());
1250 } else if (m_model->sortRole() == "size" && item.isLocalFile() && item.isDir()) {
1251 const QString path = item.localPath();
1252 if (m_scanDirectories) {
1253 m_directoryContentsCounter->scanDirectory(path);
1254 }
1255 } else {
1256 // Probably the sort role is a baloo role - just determine all roles.
1257 data = rolesData(item);
1258 }
1259
1260 disconnect(m_model, &KFileItemModel::itemsChanged,
1261 this, &KFileItemModelRolesUpdater::slotItemsChanged);
1262 m_model->setData(index, data);
1263 connect(m_model, &KFileItemModel::itemsChanged,
1264 this, &KFileItemModelRolesUpdater::slotItemsChanged);
1265 }
1266
1267 void KFileItemModelRolesUpdater::applySortProgressToModel()
1268 {
1269 // Inform the model about the progress of the resolved items,
1270 // so that it can give an indication when the sorting has been finished.
1271 const int resolvedCount = m_model->count() - m_pendingSortRoleItems.count();
1272 m_model->emitSortProgress(resolvedCount);
1273 }
1274
1275 bool KFileItemModelRolesUpdater::applyResolvedRoles(int index, ResolveHint hint)
1276 {
1277 const KFileItem item = m_model->fileItem(index);
1278 const bool resolveAll = (hint == ResolveAll);
1279
1280 bool iconChanged = false;
1281 if (!item.isMimeTypeKnown() || !item.isFinalIconKnown()) {
1282 item.determineMimeType();
1283 iconChanged = true;
1284 } else if (!m_model->data(index).contains("iconName")) {
1285 iconChanged = true;
1286 }
1287
1288 if (iconChanged || resolveAll || m_clearPreviews) {
1289 if (index < 0) {
1290 return false;
1291 }
1292
1293 QHash<QByteArray, QVariant> data;
1294 if (resolveAll) {
1295 data = rolesData(item);
1296 }
1297
1298 if (!item.iconName().isEmpty()) {
1299 data.insert("iconName", item.iconName());
1300 }
1301
1302 if (m_clearPreviews) {
1303 data.insert("iconPixmap", QPixmap());
1304 data.insert("hoverSequencePixmaps", QVariant::fromValue(QVector<QPixmap>()));
1305 }
1306
1307 disconnect(m_model, &KFileItemModel::itemsChanged,
1308 this, &KFileItemModelRolesUpdater::slotItemsChanged);
1309 m_model->setData(index, data);
1310 connect(m_model, &KFileItemModel::itemsChanged,
1311 this, &KFileItemModelRolesUpdater::slotItemsChanged);
1312 return true;
1313 }
1314
1315 return false;
1316 }
1317
1318 QHash<QByteArray, QVariant> KFileItemModelRolesUpdater::rolesData(const KFileItem& item)
1319 {
1320 QHash<QByteArray, QVariant> data;
1321
1322 const bool getSizeRole = m_roles.contains("size");
1323 const bool getIsExpandableRole = m_roles.contains("isExpandable");
1324
1325 if ((getSizeRole || getIsExpandableRole) && item.isDir()) {
1326 if (item.isLocalFile()) {
1327 // Tell m_directoryContentsCounter that we want to count the items
1328 // inside the directory. The result will be received in slotDirectoryContentsCountReceived.
1329 if (m_scanDirectories) {
1330 const QString path = item.localPath();
1331 m_directoryContentsCounter->scanDirectory(path);
1332 }
1333 } else if (getSizeRole) {
1334 data.insert("size", -1); // -1 indicates an unknown number of items
1335 }
1336 }
1337
1338 if (m_roles.contains("type")) {
1339 data.insert("type", item.mimeComment());
1340 }
1341
1342 QStringList overlays = item.overlays();
1343 for (KOverlayIconPlugin *it : qAsConst(m_overlayIconsPlugin)) {
1344 overlays.append(it->getOverlays(item.url()));
1345 }
1346 data.insert("iconOverlays", overlays);
1347
1348 #ifdef HAVE_BALOO
1349 if (m_balooFileMonitor) {
1350 m_balooFileMonitor->addFile(item.localPath());
1351 applyChangedBalooRolesForItem(item);
1352 }
1353 #endif
1354 return data;
1355 }
1356
1357 void KFileItemModelRolesUpdater::slotOverlaysChanged(const QUrl& url, const QStringList &)
1358 {
1359 const KFileItem item = m_model->fileItem(url);
1360 if (item.isNull()) {
1361 return;
1362 }
1363 const int index = m_model->index(item);
1364 QHash<QByteArray, QVariant> data = m_model->data(index);
1365 QStringList overlays = item.overlays();
1366 for (KOverlayIconPlugin *it : qAsConst(m_overlayIconsPlugin)) {
1367 overlays.append(it->getOverlays(url));
1368 }
1369 data.insert("iconOverlays", overlays);
1370 m_model->setData(index, data);
1371 }
1372
1373 void KFileItemModelRolesUpdater::updateAllPreviews()
1374 {
1375 if (m_state == Paused) {
1376 m_previewChangedDuringPausing = true;
1377 } else {
1378 m_finishedItems.clear();
1379 startUpdating();
1380 }
1381 }
1382
1383 void KFileItemModelRolesUpdater::killPreviewJob()
1384 {
1385 if (m_previewJob) {
1386 disconnect(m_previewJob, &KIO::PreviewJob::gotPreview,
1387 this, &KFileItemModelRolesUpdater::slotGotPreview);
1388 disconnect(m_previewJob, &KIO::PreviewJob::failed,
1389 this, &KFileItemModelRolesUpdater::slotPreviewFailed);
1390 disconnect(m_previewJob, &KIO::PreviewJob::finished,
1391 this, &KFileItemModelRolesUpdater::slotPreviewJobFinished);
1392 m_previewJob->kill();
1393 m_previewJob = nullptr;
1394 m_pendingPreviewItems.clear();
1395 }
1396 }
1397
1398 QList<int> KFileItemModelRolesUpdater::indexesToResolve() const
1399 {
1400 const int count = m_model->count();
1401
1402 QList<int> result;
1403 result.reserve(qMin(count, (m_lastVisibleIndex - m_firstVisibleIndex + 1) +
1404 ResolveAllItemsLimit +
1405 (2 * m_maximumVisibleItems)));
1406
1407 // Add visible items.
1408 // Resolve files first, their previews are quicker.
1409 QList<int> visibleDirs;
1410 for (int i = m_firstVisibleIndex; i <= m_lastVisibleIndex; ++i) {
1411 const KFileItem item = m_model->fileItem(i);
1412 if (item.isDir()) {
1413 visibleDirs.append(i);
1414 } else {
1415 result.append(i);
1416 }
1417 }
1418
1419 result.append(visibleDirs);
1420
1421 // We need a reasonable upper limit for number of items to resolve after
1422 // and before the visible range. m_maximumVisibleItems can be quite large
1423 // when using Compact View.
1424 const int readAheadItems = qMin(ReadAheadPages * m_maximumVisibleItems, ResolveAllItemsLimit / 2);
1425
1426 // Add items after the visible range.
1427 const int endExtendedVisibleRange = qMin(m_lastVisibleIndex + readAheadItems, count - 1);
1428 for (int i = m_lastVisibleIndex + 1; i <= endExtendedVisibleRange; ++i) {
1429 result.append(i);
1430 }
1431
1432 // Add items before the visible range in reverse order.
1433 const int beginExtendedVisibleRange = qMax(0, m_firstVisibleIndex - readAheadItems);
1434 for (int i = m_firstVisibleIndex - 1; i >= beginExtendedVisibleRange; --i) {
1435 result.append(i);
1436 }
1437
1438 // Add items on the last page.
1439 const int beginLastPage = qMax(endExtendedVisibleRange + 1, count - m_maximumVisibleItems);
1440 for (int i = beginLastPage; i < count; ++i) {
1441 result.append(i);
1442 }
1443
1444 // Add items on the first page.
1445 const int endFirstPage = qMin(beginExtendedVisibleRange, m_maximumVisibleItems);
1446 for (int i = 0; i < endFirstPage; ++i) {
1447 result.append(i);
1448 }
1449
1450 // Continue adding items until ResolveAllItemsLimit is reached.
1451 int remainingItems = ResolveAllItemsLimit - result.count();
1452
1453 for (int i = endExtendedVisibleRange + 1; i < beginLastPage && remainingItems > 0; ++i) {
1454 result.append(i);
1455 --remainingItems;
1456 }
1457
1458 for (int i = beginExtendedVisibleRange - 1; i >= endFirstPage && remainingItems > 0; --i) {
1459 result.append(i);
1460 --remainingItems;
1461 }
1462
1463 return result;
1464 }
1465
1466 void KFileItemModelRolesUpdater::trimHoverSequenceLoadedItems()
1467 {
1468 static const size_t maxLoadedItems = 20;
1469
1470 size_t loadedItems = m_hoverSequenceLoadedItems.size();
1471 while (loadedItems > maxLoadedItems) {
1472 const KFileItem item = m_hoverSequenceLoadedItems.front();
1473
1474 m_hoverSequenceLoadedItems.pop_front();
1475 loadedItems--;
1476
1477 const int index = m_model->index(item);
1478 if (index >= 0) {
1479 QHash<QByteArray, QVariant> data = m_model->data(index);
1480 data["hoverSequencePixmaps"] = QVariant::fromValue(QVector<QPixmap>() << QPixmap());
1481 m_model->setData(index, data);
1482 }
1483 }
1484 }
1485