]> cloud.milkyroute.net Git - dolphin.git/blob - src/kitemviews/kfileitemmodel.cpp
Update the roles for filtered items if necessary
[dolphin.git] / src / kitemviews / kfileitemmodel.cpp
1 /*****************************************************************************
2 * Copyright (C) 2011 by Peter Penz <peter.penz19@gmail.com> *
3 * Copyright (C) 2013 by Frank Reininghaus <frank78ac@googlemail.com> *
4 * Copyright (C) 2013 by Emmanuel Pescosta <emmanuelpescosta099@gmail.com> *
5 * *
6 * This program is free software; you can redistribute it and/or modify *
7 * it under the terms of the GNU General Public License as published by *
8 * the Free Software Foundation; either version 2 of the License, or *
9 * (at your option) any later version. *
10 * *
11 * This program is distributed in the hope that it will be useful, *
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
14 * GNU General Public License for more details. *
15 * *
16 * You should have received a copy of the GNU General Public License *
17 * along with this program; if not, write to the *
18 * Free Software Foundation, Inc., *
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
20 *****************************************************************************/
21
22 #include "kfileitemmodel.h"
23
24 #include <KDirModel>
25 #include <KGlobalSettings>
26 #include <KLocale>
27 #include <KStringHandler>
28 #include <KDebug>
29
30 #include "private/kfileitemmodelsortalgorithm.h"
31 #include "private/kfileitemmodeldirlister.h"
32
33 #include <QApplication>
34 #include <QMimeData>
35 #include <QTimer>
36 #include <QWidget>
37
38 #include <algorithm>
39 #include <vector>
40
41 // #define KFILEITEMMODEL_DEBUG
42
43 KFileItemModel::KFileItemModel(QObject* parent) :
44 KItemModelBase("text", parent),
45 m_dirLister(0),
46 m_naturalSorting(KGlobalSettings::naturalSorting()),
47 m_sortDirsFirst(true),
48 m_sortRole(NameRole),
49 m_sortingProgressPercent(-1),
50 m_roles(),
51 m_caseSensitivity(Qt::CaseInsensitive),
52 m_itemData(),
53 m_items(),
54 m_filter(),
55 m_filteredItems(),
56 m_requestRole(),
57 m_maximumUpdateIntervalTimer(0),
58 m_resortAllItemsTimer(0),
59 m_pendingItemsToInsert(),
60 m_groups(),
61 m_expandedDirs(),
62 m_urlsToExpand()
63 {
64 m_dirLister = new KFileItemModelDirLister(this);
65 m_dirLister->setDelayedMimeTypes(true);
66
67 const QWidget* parentWidget = qobject_cast<QWidget*>(parent);
68 if (parentWidget) {
69 m_dirLister->setMainWindow(parentWidget->window());
70 }
71
72 connect(m_dirLister, SIGNAL(started(KUrl)), this, SIGNAL(directoryLoadingStarted()));
73 connect(m_dirLister, SIGNAL(canceled()), this, SLOT(slotCanceled()));
74 connect(m_dirLister, SIGNAL(completed(KUrl)), this, SLOT(slotCompleted()));
75 connect(m_dirLister, SIGNAL(itemsAdded(KUrl,KFileItemList)), this, SLOT(slotItemsAdded(KUrl,KFileItemList)));
76 connect(m_dirLister, SIGNAL(itemsDeleted(KFileItemList)), this, SLOT(slotItemsDeleted(KFileItemList)));
77 connect(m_dirLister, SIGNAL(refreshItems(QList<QPair<KFileItem,KFileItem> >)), this, SLOT(slotRefreshItems(QList<QPair<KFileItem,KFileItem> >)));
78 connect(m_dirLister, SIGNAL(clear()), this, SLOT(slotClear()));
79 connect(m_dirLister, SIGNAL(clear(KUrl)), this, SLOT(slotClear(KUrl)));
80 connect(m_dirLister, SIGNAL(infoMessage(QString)), this, SIGNAL(infoMessage(QString)));
81 connect(m_dirLister, SIGNAL(errorMessage(QString)), this, SIGNAL(errorMessage(QString)));
82 connect(m_dirLister, SIGNAL(redirection(KUrl,KUrl)), this, SIGNAL(directoryRedirection(KUrl,KUrl)));
83 connect(m_dirLister, SIGNAL(urlIsFileError(KUrl)), this, SIGNAL(urlIsFileError(KUrl)));
84
85 // Apply default roles that should be determined
86 resetRoles();
87 m_requestRole[NameRole] = true;
88 m_requestRole[IsDirRole] = true;
89 m_requestRole[IsLinkRole] = true;
90 m_roles.insert("text");
91 m_roles.insert("isDir");
92 m_roles.insert("isLink");
93
94 // For slow KIO-slaves like used for searching it makes sense to show results periodically even
95 // before the completed() or canceled() signal has been emitted.
96 m_maximumUpdateIntervalTimer = new QTimer(this);
97 m_maximumUpdateIntervalTimer->setInterval(2000);
98 m_maximumUpdateIntervalTimer->setSingleShot(true);
99 connect(m_maximumUpdateIntervalTimer, SIGNAL(timeout()), this, SLOT(dispatchPendingItemsToInsert()));
100
101 // When changing the value of an item which represents the sort-role a resorting must be
102 // triggered. Especially in combination with KFileItemModelRolesUpdater this might be done
103 // for a lot of items within a quite small timeslot. To prevent expensive resortings the
104 // resorting is postponed until the timer has been exceeded.
105 m_resortAllItemsTimer = new QTimer(this);
106 m_resortAllItemsTimer->setInterval(500);
107 m_resortAllItemsTimer->setSingleShot(true);
108 connect(m_resortAllItemsTimer, SIGNAL(timeout()), this, SLOT(resortAllItems()));
109
110 connect(KGlobalSettings::self(), SIGNAL(naturalSortingChanged()), this, SLOT(slotNaturalSortingChanged()));
111 }
112
113 KFileItemModel::~KFileItemModel()
114 {
115 qDeleteAll(m_itemData);
116 qDeleteAll(m_filteredItems.values());
117 qDeleteAll(m_pendingItemsToInsert);
118 }
119
120 void KFileItemModel::loadDirectory(const KUrl& url)
121 {
122 m_dirLister->openUrl(url);
123 }
124
125 void KFileItemModel::refreshDirectory(const KUrl& url)
126 {
127 // Refresh all expanded directories first (Bug 295300)
128 QHashIterator<KUrl, KUrl> expandedDirs(m_expandedDirs);
129 while (expandedDirs.hasNext()) {
130 expandedDirs.next();
131 m_dirLister->openUrl(expandedDirs.value(), KDirLister::Reload);
132 }
133
134 m_dirLister->openUrl(url, KDirLister::Reload);
135 }
136
137 KUrl KFileItemModel::directory() const
138 {
139 return m_dirLister->url();
140 }
141
142 void KFileItemModel::cancelDirectoryLoading()
143 {
144 m_dirLister->stop();
145 }
146
147 int KFileItemModel::count() const
148 {
149 return m_itemData.count();
150 }
151
152 QHash<QByteArray, QVariant> KFileItemModel::data(int index) const
153 {
154 if (index >= 0 && index < count()) {
155 ItemData* data = m_itemData.at(index);
156 if (data->values.isEmpty()) {
157 data->values = retrieveData(data->item, data->parent);
158 }
159
160 return data->values;
161 }
162 return QHash<QByteArray, QVariant>();
163 }
164
165 bool KFileItemModel::setData(int index, const QHash<QByteArray, QVariant>& values)
166 {
167 if (index < 0 || index >= count()) {
168 return false;
169 }
170
171 QHash<QByteArray, QVariant> currentValues = data(index);
172
173 // Determine which roles have been changed
174 QSet<QByteArray> changedRoles;
175 QHashIterator<QByteArray, QVariant> it(values);
176 while (it.hasNext()) {
177 it.next();
178 const QByteArray role = sharedValue(it.key());
179 const QVariant value = it.value();
180
181 if (currentValues[role] != value) {
182 currentValues[role] = value;
183 changedRoles.insert(role);
184 }
185 }
186
187 if (changedRoles.isEmpty()) {
188 return false;
189 }
190
191 m_itemData[index]->values = currentValues;
192 if (changedRoles.contains("text")) {
193 KUrl url = m_itemData[index]->item.url();
194 url.setFileName(currentValues["text"].toString());
195 m_itemData[index]->item.setUrl(url);
196 }
197
198 emitItemsChangedAndTriggerResorting(KItemRangeList() << KItemRange(index, 1), changedRoles);
199
200 return true;
201 }
202
203 void KFileItemModel::setSortDirectoriesFirst(bool dirsFirst)
204 {
205 if (dirsFirst != m_sortDirsFirst) {
206 m_sortDirsFirst = dirsFirst;
207 resortAllItems();
208 }
209 }
210
211 bool KFileItemModel::sortDirectoriesFirst() const
212 {
213 return m_sortDirsFirst;
214 }
215
216 void KFileItemModel::setShowHiddenFiles(bool show)
217 {
218 m_dirLister->setShowingDotFiles(show);
219 m_dirLister->emitChanges();
220 if (show) {
221 slotCompleted();
222 }
223 }
224
225 bool KFileItemModel::showHiddenFiles() const
226 {
227 return m_dirLister->showingDotFiles();
228 }
229
230 void KFileItemModel::setShowDirectoriesOnly(bool enabled)
231 {
232 m_dirLister->setDirOnlyMode(enabled);
233 }
234
235 bool KFileItemModel::showDirectoriesOnly() const
236 {
237 return m_dirLister->dirOnlyMode();
238 }
239
240 QMimeData* KFileItemModel::createMimeData(const KItemSet& indexes) const
241 {
242 QMimeData* data = new QMimeData();
243
244 // The following code has been taken from KDirModel::mimeData()
245 // (kdelibs/kio/kio/kdirmodel.cpp)
246 // Copyright (C) 2006 David Faure <faure@kde.org>
247 KUrl::List urls;
248 KUrl::List mostLocalUrls;
249 bool canUseMostLocalUrls = true;
250
251 foreach (int index, indexes) {
252 const KFileItem item = fileItem(index);
253 if (!item.isNull()) {
254 urls << item.targetUrl();
255
256 bool isLocal;
257 mostLocalUrls << item.mostLocalUrl(isLocal);
258 if (!isLocal) {
259 canUseMostLocalUrls = false;
260 }
261 }
262 }
263
264 const bool different = canUseMostLocalUrls && mostLocalUrls != urls;
265 urls = KDirModel::simplifiedUrlList(urls); // TODO: Check if we still need KDirModel for this in KDE 5.0
266 if (different) {
267 mostLocalUrls = KDirModel::simplifiedUrlList(mostLocalUrls);
268 urls.populateMimeData(mostLocalUrls, data);
269 } else {
270 urls.populateMimeData(data);
271 }
272
273 return data;
274 }
275
276 int KFileItemModel::indexForKeyboardSearch(const QString& text, int startFromIndex) const
277 {
278 startFromIndex = qMax(0, startFromIndex);
279 for (int i = startFromIndex; i < count(); ++i) {
280 if (fileItem(i).text().startsWith(text, Qt::CaseInsensitive)) {
281 return i;
282 }
283 }
284 for (int i = 0; i < startFromIndex; ++i) {
285 if (fileItem(i).text().startsWith(text, Qt::CaseInsensitive)) {
286 return i;
287 }
288 }
289 return -1;
290 }
291
292 bool KFileItemModel::supportsDropping(int index) const
293 {
294 const KFileItem item = fileItem(index);
295 return !item.isNull() && (item.isDir() || item.isDesktopFile());
296 }
297
298 QString KFileItemModel::roleDescription(const QByteArray& role) const
299 {
300 static QHash<QByteArray, QString> description;
301 if (description.isEmpty()) {
302 int count = 0;
303 const RoleInfoMap* map = rolesInfoMap(count);
304 for (int i = 0; i < count; ++i) {
305 description.insert(map[i].role, i18nc(map[i].roleTranslationContext, map[i].roleTranslation));
306 }
307 }
308
309 return description.value(role);
310 }
311
312 QList<QPair<int, QVariant> > KFileItemModel::groups() const
313 {
314 if (!m_itemData.isEmpty() && m_groups.isEmpty()) {
315 #ifdef KFILEITEMMODEL_DEBUG
316 QElapsedTimer timer;
317 timer.start();
318 #endif
319 switch (typeForRole(sortRole())) {
320 case NameRole: m_groups = nameRoleGroups(); break;
321 case SizeRole: m_groups = sizeRoleGroups(); break;
322 case DateRole: m_groups = dateRoleGroups(); break;
323 case PermissionsRole: m_groups = permissionRoleGroups(); break;
324 case RatingRole: m_groups = ratingRoleGroups(); break;
325 default: m_groups = genericStringRoleGroups(sortRole()); break;
326 }
327
328 #ifdef KFILEITEMMODEL_DEBUG
329 kDebug() << "[TIME] Calculating groups for" << count() << "items:" << timer.elapsed();
330 #endif
331 }
332
333 return m_groups;
334 }
335
336 KFileItem KFileItemModel::fileItem(int index) const
337 {
338 if (index >= 0 && index < count()) {
339 return m_itemData.at(index)->item;
340 }
341
342 return KFileItem();
343 }
344
345 KFileItem KFileItemModel::fileItem(const KUrl& url) const
346 {
347 const int index = m_items.value(url, -1);
348 if (index >= 0) {
349 return m_itemData.at(index)->item;
350 }
351 return KFileItem();
352 }
353
354 int KFileItemModel::index(const KFileItem& item) const
355 {
356 if (item.isNull()) {
357 return -1;
358 }
359
360 return m_items.value(item.url(), -1);
361 }
362
363 int KFileItemModel::index(const KUrl& url) const
364 {
365 KUrl urlToFind = url;
366 urlToFind.adjustPath(KUrl::RemoveTrailingSlash);
367 return m_items.value(urlToFind, -1);
368 }
369
370 KFileItem KFileItemModel::rootItem() const
371 {
372 return m_dirLister->rootItem();
373 }
374
375 void KFileItemModel::clear()
376 {
377 slotClear();
378 }
379
380 void KFileItemModel::setRoles(const QSet<QByteArray>& roles)
381 {
382 if (m_roles == roles) {
383 return;
384 }
385 m_roles = roles;
386
387 if (count() > 0) {
388 const bool supportedExpanding = m_requestRole[ExpandedParentsCountRole];
389 const bool willSupportExpanding = roles.contains("expandedParentsCount");
390 if (supportedExpanding && !willSupportExpanding) {
391 // No expanding is supported anymore. Take care to delete all items that have an expansion level
392 // that is not 0 (and hence are part of an expanded item).
393 removeExpandedItems();
394 }
395 }
396
397 m_groups.clear();
398 resetRoles();
399
400 QSetIterator<QByteArray> it(roles);
401 while (it.hasNext()) {
402 const QByteArray& role = it.next();
403 m_requestRole[typeForRole(role)] = true;
404 }
405
406 if (count() > 0) {
407 // Update m_data with the changed requested roles
408 const int maxIndex = count() - 1;
409 for (int i = 0; i <= maxIndex; ++i) {
410 m_itemData[i]->values = retrieveData(m_itemData.at(i)->item, m_itemData.at(i)->parent);
411 }
412
413 kWarning() << "TODO: Emitting itemsChanged() with no information what has changed!";
414 emit itemsChanged(KItemRangeList() << KItemRange(0, count()), QSet<QByteArray>());
415 }
416
417 // Clear the 'values' of all filtered items. They will be re-populated with the
418 // correct roles the next time 'values' will be accessed via data(int).
419 QHash<KFileItem, ItemData*>::iterator filteredIt = m_filteredItems.begin();
420 const QHash<KFileItem, ItemData*>::iterator filteredEnd = m_filteredItems.end();
421 while (filteredIt != filteredEnd) {
422 (*filteredIt)->values.clear();
423 ++filteredIt;
424 }
425 }
426
427 QSet<QByteArray> KFileItemModel::roles() const
428 {
429 return m_roles;
430 }
431
432 bool KFileItemModel::setExpanded(int index, bool expanded)
433 {
434 if (!isExpandable(index) || isExpanded(index) == expanded) {
435 return false;
436 }
437
438 QHash<QByteArray, QVariant> values;
439 values.insert(sharedValue("isExpanded"), expanded);
440 if (!setData(index, values)) {
441 return false;
442 }
443
444 const KFileItem item = m_itemData.at(index)->item;
445 const KUrl url = item.url();
446 const KUrl targetUrl = item.targetUrl();
447 if (expanded) {
448 m_expandedDirs.insert(targetUrl, url);
449 m_dirLister->openUrl(url, KDirLister::Keep);
450
451 const KUrl::List previouslyExpandedChildren = m_itemData.at(index)->values.value("previouslyExpandedChildren").value<KUrl::List>();
452 foreach (const KUrl& url, previouslyExpandedChildren) {
453 m_urlsToExpand.insert(url);
454 }
455 } else {
456 m_expandedDirs.remove(targetUrl);
457 m_dirLister->stop(url);
458
459 const int parentLevel = expandedParentsCount(index);
460 const int itemCount = m_itemData.count();
461 const int firstChildIndex = index + 1;
462
463 KUrl::List expandedChildren;
464
465 int childIndex = firstChildIndex;
466 while (childIndex < itemCount && expandedParentsCount(childIndex) > parentLevel) {
467 ItemData* itemData = m_itemData.at(childIndex);
468 if (itemData->values.value("isExpanded").toBool()) {
469 const KUrl targetUrl = itemData->item.targetUrl();
470 m_expandedDirs.remove(targetUrl);
471 expandedChildren.append(targetUrl);
472 }
473 ++childIndex;
474 }
475 const int childrenCount = childIndex - firstChildIndex;
476
477 removeFilteredChildren(KItemRangeList() << KItemRange(index, 1 + childrenCount));
478 removeItems(KItemRangeList() << KItemRange(firstChildIndex, childrenCount), DeleteItemData);
479
480 m_itemData.at(index)->values.insert("previouslyExpandedChildren", expandedChildren);
481 }
482
483 return true;
484 }
485
486 bool KFileItemModel::isExpanded(int index) const
487 {
488 if (index >= 0 && index < count()) {
489 return m_itemData.at(index)->values.value("isExpanded").toBool();
490 }
491 return false;
492 }
493
494 bool KFileItemModel::isExpandable(int index) const
495 {
496 if (index >= 0 && index < count()) {
497 // Call data (instead of accessing m_itemData directly)
498 // to ensure that the value is initialized.
499 return data(index).value("isExpandable").toBool();
500 }
501 return false;
502 }
503
504 int KFileItemModel::expandedParentsCount(int index) const
505 {
506 if (index >= 0 && index < count()) {
507 return expandedParentsCount(m_itemData.at(index));
508 }
509 return 0;
510 }
511
512 QSet<KUrl> KFileItemModel::expandedDirectories() const
513 {
514 return m_expandedDirs.values().toSet();
515 }
516
517 void KFileItemModel::restoreExpandedDirectories(const QSet<KUrl>& urls)
518 {
519 m_urlsToExpand = urls;
520 }
521
522 void KFileItemModel::expandParentDirectories(const KUrl& url)
523 {
524 const int pos = m_dirLister->url().path().length();
525
526 // Assure that each sub-path of the URL that should be
527 // expanded is added to m_urlsToExpand. KDirLister
528 // does not care whether the parent-URL has already been
529 // expanded.
530 KUrl urlToExpand = m_dirLister->url();
531 const QStringList subDirs = url.path().mid(pos).split(QDir::separator());
532 for (int i = 0; i < subDirs.count() - 1; ++i) {
533 urlToExpand.addPath(subDirs.at(i));
534 m_urlsToExpand.insert(urlToExpand);
535 }
536
537 // KDirLister::open() must called at least once to trigger an initial
538 // loading. The pending URLs that must be restored are handled
539 // in slotCompleted().
540 QSetIterator<KUrl> it2(m_urlsToExpand);
541 while (it2.hasNext()) {
542 const int idx = index(it2.next());
543 if (idx >= 0 && !isExpanded(idx)) {
544 setExpanded(idx, true);
545 break;
546 }
547 }
548 }
549
550 void KFileItemModel::setNameFilter(const QString& nameFilter)
551 {
552 if (m_filter.pattern() != nameFilter) {
553 dispatchPendingItemsToInsert();
554 m_filter.setPattern(nameFilter);
555 applyFilters();
556 }
557 }
558
559 QString KFileItemModel::nameFilter() const
560 {
561 return m_filter.pattern();
562 }
563
564 void KFileItemModel::setMimeTypeFilters(const QStringList& filters)
565 {
566 if (m_filter.mimeTypes() != filters) {
567 dispatchPendingItemsToInsert();
568 m_filter.setMimeTypes(filters);
569 applyFilters();
570 }
571 }
572
573 QStringList KFileItemModel::mimeTypeFilters() const
574 {
575 return m_filter.mimeTypes();
576 }
577
578
579 void KFileItemModel::applyFilters()
580 {
581 // Check which shown items from m_itemData must get
582 // hidden and hence moved to m_filteredItems.
583 QVector<int> newFilteredIndexes;
584
585 const int itemCount = m_itemData.count();
586 for (int index = 0; index < itemCount; ++index) {
587 ItemData* itemData = m_itemData.at(index);
588
589 // Only filter non-expanded items as child items may never
590 // exist without a parent item
591 if (!itemData->values.value("isExpanded").toBool()) {
592 const KFileItem item = itemData->item;
593 if (!m_filter.matches(item)) {
594 newFilteredIndexes.append(index);
595 m_filteredItems.insert(item, itemData);
596 }
597 }
598 }
599
600 const KItemRangeList removedRanges = KItemRangeList::fromSortedContainer(newFilteredIndexes);
601 removeItems(removedRanges, KeepItemData);
602
603 // Check which hidden items from m_filteredItems should
604 // get visible again and hence removed from m_filteredItems.
605 QList<ItemData*> newVisibleItems;
606
607 QHash<KFileItem, ItemData*>::iterator it = m_filteredItems.begin();
608 while (it != m_filteredItems.end()) {
609 if (m_filter.matches(it.key())) {
610 newVisibleItems.append(it.value());
611 it = m_filteredItems.erase(it);
612 } else {
613 ++it;
614 }
615 }
616
617 insertItems(newVisibleItems);
618 }
619
620 void KFileItemModel::removeFilteredChildren(const KItemRangeList& itemRanges)
621 {
622 if (m_filteredItems.isEmpty() || !m_requestRole[ExpandedParentsCountRole]) {
623 // There are either no filtered items, or it is not possible to expand
624 // folders -> there cannot be any filtered children.
625 return;
626 }
627
628 QSet<ItemData*> parents;
629 foreach (const KItemRange& range, itemRanges) {
630 for (int index = range.index; index < range.index + range.count; ++index) {
631 parents.insert(m_itemData.at(index));
632 }
633 }
634
635 QHash<KFileItem, ItemData*>::iterator it = m_filteredItems.begin();
636 while (it != m_filteredItems.end()) {
637 if (parents.contains(it.value()->parent)) {
638 delete it.value();
639 it = m_filteredItems.erase(it);
640 } else {
641 ++it;
642 }
643 }
644 }
645
646 QList<KFileItemModel::RoleInfo> KFileItemModel::rolesInformation()
647 {
648 static QList<RoleInfo> rolesInfo;
649 if (rolesInfo.isEmpty()) {
650 int count = 0;
651 const RoleInfoMap* map = rolesInfoMap(count);
652 for (int i = 0; i < count; ++i) {
653 if (map[i].roleType != NoRole) {
654 RoleInfo info;
655 info.role = map[i].role;
656 info.translation = i18nc(map[i].roleTranslationContext, map[i].roleTranslation);
657 if (map[i].groupTranslation) {
658 info.group = i18nc(map[i].groupTranslationContext, map[i].groupTranslation);
659 } else {
660 // For top level roles, groupTranslation is 0. We must make sure that
661 // info.group is an empty string then because the code that generates
662 // menus tries to put the actions into sub menus otherwise.
663 info.group = QString();
664 }
665 info.requiresNepomuk = map[i].requiresNepomuk;
666 info.requiresIndexer = map[i].requiresIndexer;
667 rolesInfo.append(info);
668 }
669 }
670 }
671
672 return rolesInfo;
673 }
674
675 void KFileItemModel::onGroupedSortingChanged(bool current)
676 {
677 Q_UNUSED(current);
678 m_groups.clear();
679 }
680
681 void KFileItemModel::onSortRoleChanged(const QByteArray& current, const QByteArray& previous)
682 {
683 Q_UNUSED(previous);
684 m_sortRole = typeForRole(current);
685
686 if (!m_requestRole[m_sortRole]) {
687 QSet<QByteArray> newRoles = m_roles;
688 newRoles << current;
689 setRoles(newRoles);
690 }
691
692 resortAllItems();
693 }
694
695 void KFileItemModel::onSortOrderChanged(Qt::SortOrder current, Qt::SortOrder previous)
696 {
697 Q_UNUSED(current);
698 Q_UNUSED(previous);
699 resortAllItems();
700 }
701
702 void KFileItemModel::resortAllItems()
703 {
704 m_resortAllItemsTimer->stop();
705
706 const int itemCount = count();
707 if (itemCount <= 0) {
708 return;
709 }
710
711 #ifdef KFILEITEMMODEL_DEBUG
712 QElapsedTimer timer;
713 timer.start();
714 kDebug() << "===========================================================";
715 kDebug() << "Resorting" << itemCount << "items";
716 #endif
717
718 // Remember the order of the current URLs so
719 // that it can be determined which indexes have
720 // been moved because of the resorting.
721 QList<KUrl> oldUrls;
722 oldUrls.reserve(itemCount);
723 foreach (const ItemData* itemData, m_itemData) {
724 oldUrls.append(itemData->item.url());
725 }
726
727 m_items.clear();
728
729 // Resort the items
730 sort(m_itemData.begin(), m_itemData.end());
731 for (int i = 0; i < itemCount; ++i) {
732 m_items.insert(m_itemData.at(i)->item.url(), i);
733 }
734
735 // Determine the first index that has been moved.
736 int firstMovedIndex = 0;
737 while (firstMovedIndex < itemCount
738 && firstMovedIndex == m_items.value(oldUrls.at(firstMovedIndex))) {
739 ++firstMovedIndex;
740 }
741
742 const bool itemsHaveMoved = firstMovedIndex < itemCount;
743 if (itemsHaveMoved) {
744 m_groups.clear();
745
746 int lastMovedIndex = itemCount - 1;
747 while (lastMovedIndex > firstMovedIndex
748 && lastMovedIndex == m_items.value(oldUrls.at(lastMovedIndex))) {
749 --lastMovedIndex;
750 }
751
752 Q_ASSERT(firstMovedIndex <= lastMovedIndex);
753
754 // Create a list movedToIndexes, which has the property that
755 // movedToIndexes[i] is the new index of the item with the old index
756 // firstMovedIndex + i.
757 const int movedItemsCount = lastMovedIndex - firstMovedIndex + 1;
758 QList<int> movedToIndexes;
759 movedToIndexes.reserve(movedItemsCount);
760 for (int i = firstMovedIndex; i <= lastMovedIndex; ++i) {
761 const int newIndex = m_items.value(oldUrls.at(i));
762 movedToIndexes.append(newIndex);
763 }
764
765 emit itemsMoved(KItemRange(firstMovedIndex, movedItemsCount), movedToIndexes);
766 } else if (groupedSorting()) {
767 // The groups might have changed even if the order of the items has not.
768 const QList<QPair<int, QVariant> > oldGroups = m_groups;
769 m_groups.clear();
770 if (groups() != oldGroups) {
771 emit groupsChanged();
772 }
773 }
774
775 #ifdef KFILEITEMMODEL_DEBUG
776 kDebug() << "[TIME] Resorting of" << itemCount << "items:" << timer.elapsed();
777 #endif
778 }
779
780 void KFileItemModel::slotCompleted()
781 {
782 dispatchPendingItemsToInsert();
783
784 if (!m_urlsToExpand.isEmpty()) {
785 // Try to find a URL that can be expanded.
786 // Note that the parent folder must be expanded before any of its subfolders become visible.
787 // Therefore, some URLs in m_restoredExpandedUrls might not be visible yet
788 // -> we expand the first visible URL we find in m_restoredExpandedUrls.
789 foreach (const KUrl& url, m_urlsToExpand) {
790 const int index = m_items.value(url, -1);
791 if (index >= 0) {
792 m_urlsToExpand.remove(url);
793 if (setExpanded(index, true)) {
794 // The dir lister has been triggered. This slot will be called
795 // again after the directory has been expanded.
796 return;
797 }
798 }
799 }
800
801 // None of the URLs in m_restoredExpandedUrls could be found in the model. This can happen
802 // if these URLs have been deleted in the meantime.
803 m_urlsToExpand.clear();
804 }
805
806 emit directoryLoadingCompleted();
807 }
808
809 void KFileItemModel::slotCanceled()
810 {
811 m_maximumUpdateIntervalTimer->stop();
812 dispatchPendingItemsToInsert();
813
814 emit directoryLoadingCanceled();
815 }
816
817 void KFileItemModel::slotItemsAdded(const KUrl& directoryUrl, const KFileItemList& items)
818 {
819 Q_ASSERT(!items.isEmpty());
820
821 KUrl parentUrl;
822 if (m_expandedDirs.contains(directoryUrl)) {
823 parentUrl = m_expandedDirs.value(directoryUrl);
824 } else {
825 parentUrl = directoryUrl;
826 parentUrl.adjustPath(KUrl::RemoveTrailingSlash);
827 }
828
829 if (m_requestRole[ExpandedParentsCountRole]) {
830 KFileItem item = items.first();
831
832 // If the expanding of items is enabled, the call
833 // dirLister->openUrl(url, KDirLister::Keep) in KFileItemModel::setExpanded()
834 // might result in emitting the same items twice due to the Keep-parameter.
835 // This case happens if an item gets expanded, collapsed and expanded again
836 // before the items could be loaded for the first expansion.
837 const int index = m_items.value(item.url(), -1);
838 if (index >= 0) {
839 // The items are already part of the model.
840 return;
841 }
842
843 if (directoryUrl != directory()) {
844 // To be able to compare whether the new items may be inserted as children
845 // of a parent item the pending items must be added to the model first.
846 dispatchPendingItemsToInsert();
847 }
848
849 // KDirLister keeps the children of items that got expanded once even if
850 // they got collapsed again with KFileItemModel::setExpanded(false). So it must be
851 // checked whether the parent for new items is still expanded.
852 const int parentIndex = m_items.value(parentUrl, -1);
853 if (parentIndex >= 0 && !m_itemData[parentIndex]->values.value("isExpanded").toBool()) {
854 // The parent is not expanded.
855 return;
856 }
857 }
858
859 QList<ItemData*> itemDataList = createItemDataList(parentUrl, items);
860
861 if (!m_filter.hasSetFilters()) {
862 m_pendingItemsToInsert.append(itemDataList);
863 } else {
864 // The name or type filter is active. Hide filtered items
865 // before inserting them into the model and remember
866 // the filtered items in m_filteredItems.
867 foreach (ItemData* itemData, itemDataList) {
868 if (m_filter.matches(itemData->item)) {
869 m_pendingItemsToInsert.append(itemData);
870 } else {
871 m_filteredItems.insert(itemData->item, itemData);
872 }
873 }
874 }
875
876 if (useMaximumUpdateInterval() && !m_maximumUpdateIntervalTimer->isActive()) {
877 // Assure that items get dispatched if no completed() or canceled() signal is
878 // emitted during the maximum update interval.
879 m_maximumUpdateIntervalTimer->start();
880 }
881 }
882
883 void KFileItemModel::slotItemsDeleted(const KFileItemList& items)
884 {
885 dispatchPendingItemsToInsert();
886
887 QVector<int> indexesToRemove;
888 indexesToRemove.reserve(items.count());
889
890 foreach (const KFileItem& item, items) {
891 const KUrl url = item.url();
892 const int index = m_items.value(url, -1);
893 if (index >= 0) {
894 indexesToRemove.append(index);
895 } else {
896 // Probably the item has been filtered.
897 QHash<KFileItem, ItemData*>::iterator it = m_filteredItems.find(item);
898 if (it != m_filteredItems.end()) {
899 delete it.value();
900 m_filteredItems.erase(it);
901 }
902 }
903 }
904
905 std::sort(indexesToRemove.begin(), indexesToRemove.end());
906
907 if (m_requestRole[ExpandedParentsCountRole] && !m_expandedDirs.isEmpty()) {
908 // Assure that removing a parent item also results in removing all children
909 QVector<int> indexesToRemoveWithChildren;
910 indexesToRemoveWithChildren.reserve(m_items.count());
911
912 const int itemCount = m_itemData.count();
913 foreach (int index, indexesToRemove) {
914 indexesToRemoveWithChildren.append(index);
915
916 const int parentLevel = expandedParentsCount(index);
917 int childIndex = index + 1;
918 while (childIndex < itemCount && expandedParentsCount(childIndex) > parentLevel) {
919 indexesToRemoveWithChildren.append(childIndex);
920 ++childIndex;
921 }
922 }
923
924 indexesToRemove = indexesToRemoveWithChildren;
925 }
926
927 const KItemRangeList itemRanges = KItemRangeList::fromSortedContainer(indexesToRemove);
928 removeFilteredChildren(itemRanges);
929 removeItems(itemRanges, DeleteItemData);
930 }
931
932 void KFileItemModel::slotRefreshItems(const QList<QPair<KFileItem, KFileItem> >& items)
933 {
934 Q_ASSERT(!items.isEmpty());
935 #ifdef KFILEITEMMODEL_DEBUG
936 kDebug() << "Refreshing" << items.count() << "items";
937 #endif
938
939 // Get the indexes of all items that have been refreshed
940 QList<int> indexes;
941 indexes.reserve(items.count());
942
943 QSet<QByteArray> changedRoles;
944
945 QListIterator<QPair<KFileItem, KFileItem> > it(items);
946 while (it.hasNext()) {
947 const QPair<KFileItem, KFileItem>& itemPair = it.next();
948 const KFileItem& oldItem = itemPair.first;
949 const KFileItem& newItem = itemPair.second;
950 const int index = m_items.value(oldItem.url(), -1);
951 if (index >= 0) {
952 m_itemData[index]->item = newItem;
953
954 // Keep old values as long as possible if they could not retrieved synchronously yet.
955 // The update of the values will be done asynchronously by KFileItemModelRolesUpdater.
956 QHashIterator<QByteArray, QVariant> it(retrieveData(newItem, m_itemData.at(index)->parent));
957 QHash<QByteArray, QVariant>& values = m_itemData[index]->values;
958 while (it.hasNext()) {
959 it.next();
960 const QByteArray& role = it.key();
961 if (values.value(role) != it.value()) {
962 values.insert(role, it.value());
963 changedRoles.insert(role);
964 }
965 }
966
967 m_items.remove(oldItem.url());
968 m_items.insert(newItem.url(), index);
969 indexes.append(index);
970 }
971 }
972
973 // If the changed items have been created recently, they might not be in m_items yet.
974 // In that case, the list 'indexes' might be empty.
975 if (indexes.isEmpty()) {
976 return;
977 }
978
979 // Extract the item-ranges out of the changed indexes
980 qSort(indexes);
981 const KItemRangeList itemRangeList = KItemRangeList::fromSortedContainer(indexes);
982 emitItemsChangedAndTriggerResorting(itemRangeList, changedRoles);
983 }
984
985 void KFileItemModel::slotClear()
986 {
987 #ifdef KFILEITEMMODEL_DEBUG
988 kDebug() << "Clearing all items";
989 #endif
990
991 qDeleteAll(m_filteredItems.values());
992 m_filteredItems.clear();
993 m_groups.clear();
994
995 m_maximumUpdateIntervalTimer->stop();
996 m_resortAllItemsTimer->stop();
997
998 qDeleteAll(m_pendingItemsToInsert);
999 m_pendingItemsToInsert.clear();
1000
1001 const int removedCount = m_itemData.count();
1002 if (removedCount > 0) {
1003 qDeleteAll(m_itemData);
1004 m_itemData.clear();
1005 m_items.clear();
1006 emit itemsRemoved(KItemRangeList() << KItemRange(0, removedCount));
1007 }
1008
1009 m_expandedDirs.clear();
1010 }
1011
1012 void KFileItemModel::slotClear(const KUrl& url)
1013 {
1014 Q_UNUSED(url);
1015 }
1016
1017 void KFileItemModel::slotNaturalSortingChanged()
1018 {
1019 m_naturalSorting = KGlobalSettings::naturalSorting();
1020 resortAllItems();
1021 }
1022
1023 void KFileItemModel::dispatchPendingItemsToInsert()
1024 {
1025 if (!m_pendingItemsToInsert.isEmpty()) {
1026 insertItems(m_pendingItemsToInsert);
1027 m_pendingItemsToInsert.clear();
1028 }
1029 }
1030
1031 void KFileItemModel::insertItems(QList<ItemData*>& newItems)
1032 {
1033 if (newItems.isEmpty()) {
1034 return;
1035 }
1036
1037 #ifdef KFILEITEMMODEL_DEBUG
1038 QElapsedTimer timer;
1039 timer.start();
1040 kDebug() << "===========================================================";
1041 kDebug() << "Inserting" << newItems.count() << "items";
1042 #endif
1043
1044 m_groups.clear();
1045 prepareItemsForSorting(newItems);
1046
1047 if (m_sortRole == NameRole && m_naturalSorting) {
1048 // Natural sorting of items can be very slow. However, it becomes much
1049 // faster if the input sequence is already mostly sorted. Therefore, we
1050 // first sort 'newItems' according to the QStrings returned by
1051 // KFileItem::text() using QString::operator<(), which is quite fast.
1052 parallelMergeSort(newItems.begin(), newItems.end(), nameLessThan, QThread::idealThreadCount());
1053 }
1054
1055 sort(newItems.begin(), newItems.end());
1056
1057 #ifdef KFILEITEMMODEL_DEBUG
1058 kDebug() << "[TIME] Sorting:" << timer.elapsed();
1059 #endif
1060
1061 KItemRangeList itemRanges;
1062 const int existingItemCount = m_itemData.count();
1063 const int newItemCount = newItems.count();
1064 const int totalItemCount = existingItemCount + newItemCount;
1065
1066 if (existingItemCount == 0) {
1067 // Optimization for the common special case that there are no
1068 // items in the model yet. Happens, e.g., when entering a folder.
1069 m_itemData = newItems;
1070 itemRanges << KItemRange(0, newItemCount);
1071 } else {
1072 m_itemData.reserve(totalItemCount);
1073 for (int i = existingItemCount; i < totalItemCount; ++i) {
1074 m_itemData.append(0);
1075 }
1076
1077 // We build the new list m_items in reverse order to minimize
1078 // the number of moves and guarantee O(N) complexity.
1079 int targetIndex = totalItemCount - 1;
1080 int sourceIndexExistingItems = existingItemCount - 1;
1081 int sourceIndexNewItems = newItemCount - 1;
1082
1083 int rangeCount = 0;
1084
1085 while (sourceIndexNewItems >= 0) {
1086 ItemData* newItem = newItems.at(sourceIndexNewItems);
1087 if (sourceIndexExistingItems >= 0 && lessThan(newItem, m_itemData.at(sourceIndexExistingItems))) {
1088 // Move an existing item to its new position. If any new items
1089 // are behind it, push the item range to itemRanges.
1090 if (rangeCount > 0) {
1091 itemRanges << KItemRange(sourceIndexExistingItems + 1, rangeCount);
1092 rangeCount = 0;
1093 }
1094
1095 m_itemData[targetIndex] = m_itemData.at(sourceIndexExistingItems);
1096 --sourceIndexExistingItems;
1097 } else {
1098 // Insert a new item into the list.
1099 ++rangeCount;
1100 m_itemData[targetIndex] = newItem;
1101 --sourceIndexNewItems;
1102 }
1103 --targetIndex;
1104 }
1105
1106 // Push the final item range to itemRanges.
1107 if (rangeCount > 0) {
1108 itemRanges << KItemRange(sourceIndexExistingItems + 1, rangeCount);
1109 }
1110
1111 // Note that itemRanges is still sorted in reverse order.
1112 std::reverse(itemRanges.begin(), itemRanges.end());
1113 }
1114
1115 // The indexes starting from the first inserted item must be adjusted.
1116 m_items.reserve(totalItemCount);
1117 for (int i = itemRanges.front().index; i < totalItemCount; ++i) {
1118 m_items.insert(m_itemData.at(i)->item.url(), i);
1119 }
1120
1121 emit itemsInserted(itemRanges);
1122
1123 #ifdef KFILEITEMMODEL_DEBUG
1124 kDebug() << "[TIME] Inserting of" << newItems.count() << "items:" << timer.elapsed();
1125 #endif
1126 }
1127
1128 void KFileItemModel::removeItems(const KItemRangeList& itemRanges, RemoveItemsBehavior behavior)
1129 {
1130 if (itemRanges.isEmpty()) {
1131 return;
1132 }
1133
1134 m_groups.clear();
1135
1136 // Step 1: Remove the items from the hash m_items, and free the ItemData.
1137 int removedItemsCount = 0;
1138 foreach (const KItemRange& range, itemRanges) {
1139 removedItemsCount += range.count;
1140
1141 for (int index = range.index; index < range.index + range.count; ++index) {
1142 const KUrl url = m_itemData.at(index)->item.url();
1143
1144 // Prevent repeated expensive rehashing by using QHash::erase(),
1145 // rather than QHash::remove().
1146 QHash<KUrl, int>::iterator it = m_items.find(url);
1147 m_items.erase(it);
1148
1149 if (behavior == DeleteItemData) {
1150 delete m_itemData.at(index);
1151 }
1152
1153 m_itemData[index] = 0;
1154 }
1155 }
1156
1157 // Step 2: Remove the ItemData pointers from the list m_itemData.
1158 int target = itemRanges.at(0).index;
1159 int source = itemRanges.at(0).index + itemRanges.at(0).count;
1160 int nextRange = 1;
1161
1162 const int oldItemDataCount = m_itemData.count();
1163 while (source < oldItemDataCount) {
1164 m_itemData[target] = m_itemData[source];
1165 ++target;
1166 ++source;
1167
1168 if (nextRange < itemRanges.count() && source == itemRanges.at(nextRange).index) {
1169 // Skip the items in the next removed range.
1170 source += itemRanges.at(nextRange).count;
1171 ++nextRange;
1172 }
1173 }
1174
1175 m_itemData.erase(m_itemData.end() - removedItemsCount, m_itemData.end());
1176
1177 // Step 3: Adjust indexes in the hash m_items, starting from the
1178 // index of the first removed item.
1179 const int newItemDataCount = m_itemData.count();
1180 for (int i = itemRanges.front().index; i < newItemDataCount; ++i) {
1181 m_items.insert(m_itemData.at(i)->item.url(), i);
1182 }
1183
1184 emit itemsRemoved(itemRanges);
1185 }
1186
1187 QList<KFileItemModel::ItemData*> KFileItemModel::createItemDataList(const KUrl& parentUrl, const KFileItemList& items) const
1188 {
1189 if (m_sortRole == TypeRole) {
1190 // Try to resolve the MIME-types synchronously to prevent a reordering of
1191 // the items when sorting by type (per default MIME-types are resolved
1192 // asynchronously by KFileItemModelRolesUpdater).
1193 determineMimeTypes(items, 200);
1194 }
1195
1196 const int parentIndex = m_items.value(parentUrl, -1);
1197 ItemData* parentItem = parentIndex < 0 ? 0 : m_itemData.at(parentIndex);
1198
1199 QList<ItemData*> itemDataList;
1200 itemDataList.reserve(items.count());
1201
1202 foreach (const KFileItem& item, items) {
1203 ItemData* itemData = new ItemData();
1204 itemData->item = item;
1205 itemData->parent = parentItem;
1206 itemDataList.append(itemData);
1207 }
1208
1209 return itemDataList;
1210 }
1211
1212 void KFileItemModel::prepareItemsForSorting(QList<ItemData*>& itemDataList)
1213 {
1214 switch (m_sortRole) {
1215 case PermissionsRole:
1216 case OwnerRole:
1217 case GroupRole:
1218 case DestinationRole:
1219 case PathRole:
1220 // These roles can be determined with retrieveData, and they have to be stored
1221 // in the QHash "values" for the sorting.
1222 foreach (ItemData* itemData, itemDataList) {
1223 if (itemData->values.isEmpty()) {
1224 itemData->values = retrieveData(itemData->item, itemData->parent);
1225 }
1226 }
1227 break;
1228
1229 case TypeRole:
1230 // At least store the data including the file type for items with known MIME type.
1231 foreach (ItemData* itemData, itemDataList) {
1232 if (itemData->values.isEmpty()) {
1233 const KFileItem item = itemData->item;
1234 if (item.isDir() || item.isMimeTypeKnown()) {
1235 itemData->values = retrieveData(itemData->item, itemData->parent);
1236 }
1237 }
1238 }
1239 break;
1240
1241 default:
1242 // The other roles are either resolved by KFileItemModelRolesUpdater
1243 // (this includes the SizeRole for directories), or they do not need
1244 // to be stored in the QHash "values" for sorting because the data can
1245 // be retrieved directly from the KFileItem (NameRole, SizeRole for files,
1246 // DateRole).
1247 break;
1248 }
1249 }
1250
1251 int KFileItemModel::expandedParentsCount(const ItemData* data)
1252 {
1253 // The hash 'values' is only guaranteed to contain the key "expandedParentsCount"
1254 // if the corresponding item is expanded, and it is not a top-level item.
1255 const ItemData* parent = data->parent;
1256 if (parent) {
1257 if (parent->parent) {
1258 Q_ASSERT(parent->values.contains("expandedParentsCount"));
1259 return parent->values.value("expandedParentsCount").toInt() + 1;
1260 } else {
1261 return 1;
1262 }
1263 } else {
1264 return 0;
1265 }
1266 }
1267
1268 void KFileItemModel::removeExpandedItems()
1269 {
1270 QVector<int> indexesToRemove;
1271
1272 const int maxIndex = m_itemData.count() - 1;
1273 for (int i = 0; i <= maxIndex; ++i) {
1274 const ItemData* itemData = m_itemData.at(i);
1275 if (itemData->parent) {
1276 indexesToRemove.append(i);
1277 }
1278 }
1279
1280 removeItems(KItemRangeList::fromSortedContainer(indexesToRemove), DeleteItemData);
1281 m_expandedDirs.clear();
1282
1283 // Also remove all filtered items which have a parent.
1284 QHash<KFileItem, ItemData*>::iterator it = m_filteredItems.begin();
1285 const QHash<KFileItem, ItemData*>::iterator end = m_filteredItems.end();
1286
1287 while (it != end) {
1288 if (it.value()->parent) {
1289 delete it.value();
1290 it = m_filteredItems.erase(it);
1291 } else {
1292 ++it;
1293 }
1294 }
1295 }
1296
1297 void KFileItemModel::emitItemsChangedAndTriggerResorting(const KItemRangeList& itemRanges, const QSet<QByteArray>& changedRoles)
1298 {
1299 emit itemsChanged(itemRanges, changedRoles);
1300
1301 // Trigger a resorting if necessary. Note that this can happen even if the sort
1302 // role has not changed at all because the file name can be used as a fallback.
1303 if (changedRoles.contains(sortRole()) || changedRoles.contains(roleForType(NameRole))) {
1304 foreach (const KItemRange& range, itemRanges) {
1305 bool needsResorting = false;
1306
1307 const int first = range.index;
1308 const int last = range.index + range.count - 1;
1309
1310 // Resorting the model is necessary if
1311 // (a) The first item in the range is "lessThan" its predecessor,
1312 // (b) the successor of the last item is "lessThan" the last item, or
1313 // (c) the internal order of the items in the range is incorrect.
1314 if (first > 0
1315 && lessThan(m_itemData.at(first), m_itemData.at(first - 1))) {
1316 needsResorting = true;
1317 } else if (last < count() - 1
1318 && lessThan(m_itemData.at(last + 1), m_itemData.at(last))) {
1319 needsResorting = true;
1320 } else {
1321 for (int index = first; index < last; ++index) {
1322 if (lessThan(m_itemData.at(index + 1), m_itemData.at(index))) {
1323 needsResorting = true;
1324 break;
1325 }
1326 }
1327 }
1328
1329 if (needsResorting) {
1330 m_resortAllItemsTimer->start();
1331 return;
1332 }
1333 }
1334 }
1335
1336 if (groupedSorting() && changedRoles.contains(sortRole())) {
1337 // The position is still correct, but the groups might have changed
1338 // if the changed item is either the first or the last item in a
1339 // group.
1340 // In principle, we could try to find out if the item really is the
1341 // first or last one in its group and then update the groups
1342 // (possibly with a delayed timer to make sure that we don't
1343 // re-calculate the groups very often if items are updated one by
1344 // one), but starting m_resortAllItemsTimer is easier.
1345 m_resortAllItemsTimer->start();
1346 }
1347 }
1348
1349 void KFileItemModel::resetRoles()
1350 {
1351 for (int i = 0; i < RolesCount; ++i) {
1352 m_requestRole[i] = false;
1353 }
1354 }
1355
1356 KFileItemModel::RoleType KFileItemModel::typeForRole(const QByteArray& role) const
1357 {
1358 static QHash<QByteArray, RoleType> roles;
1359 if (roles.isEmpty()) {
1360 // Insert user visible roles that can be accessed with
1361 // KFileItemModel::roleInformation()
1362 int count = 0;
1363 const RoleInfoMap* map = rolesInfoMap(count);
1364 for (int i = 0; i < count; ++i) {
1365 roles.insert(map[i].role, map[i].roleType);
1366 }
1367
1368 // Insert internal roles (take care to synchronize the implementation
1369 // with KFileItemModel::roleForType() in case if a change is done).
1370 roles.insert("isDir", IsDirRole);
1371 roles.insert("isLink", IsLinkRole);
1372 roles.insert("isExpanded", IsExpandedRole);
1373 roles.insert("isExpandable", IsExpandableRole);
1374 roles.insert("expandedParentsCount", ExpandedParentsCountRole);
1375
1376 Q_ASSERT(roles.count() == RolesCount);
1377 }
1378
1379 return roles.value(role, NoRole);
1380 }
1381
1382 QByteArray KFileItemModel::roleForType(RoleType roleType) const
1383 {
1384 static QHash<RoleType, QByteArray> roles;
1385 if (roles.isEmpty()) {
1386 // Insert user visible roles that can be accessed with
1387 // KFileItemModel::roleInformation()
1388 int count = 0;
1389 const RoleInfoMap* map = rolesInfoMap(count);
1390 for (int i = 0; i < count; ++i) {
1391 roles.insert(map[i].roleType, map[i].role);
1392 }
1393
1394 // Insert internal roles (take care to synchronize the implementation
1395 // with KFileItemModel::typeForRole() in case if a change is done).
1396 roles.insert(IsDirRole, "isDir");
1397 roles.insert(IsLinkRole, "isLink");
1398 roles.insert(IsExpandedRole, "isExpanded");
1399 roles.insert(IsExpandableRole, "isExpandable");
1400 roles.insert(ExpandedParentsCountRole, "expandedParentsCount");
1401
1402 Q_ASSERT(roles.count() == RolesCount);
1403 };
1404
1405 return roles.value(roleType);
1406 }
1407
1408 QHash<QByteArray, QVariant> KFileItemModel::retrieveData(const KFileItem& item, const ItemData* parent) const
1409 {
1410 // It is important to insert only roles that are fast to retrieve. E.g.
1411 // KFileItem::iconName() can be very expensive if the MIME-type is unknown
1412 // and hence will be retrieved asynchronously by KFileItemModelRolesUpdater.
1413 QHash<QByteArray, QVariant> data;
1414 data.insert(sharedValue("url"), item.url());
1415
1416 const bool isDir = item.isDir();
1417 if (m_requestRole[IsDirRole] && isDir) {
1418 data.insert(sharedValue("isDir"), true);
1419 }
1420
1421 if (m_requestRole[IsLinkRole] && item.isLink()) {
1422 data.insert(sharedValue("isLink"), true);
1423 }
1424
1425 if (m_requestRole[NameRole]) {
1426 data.insert(sharedValue("text"), item.text());
1427 }
1428
1429 if (m_requestRole[SizeRole] && !isDir) {
1430 data.insert(sharedValue("size"), item.size());
1431 }
1432
1433 if (m_requestRole[DateRole]) {
1434 // Don't use KFileItem::timeString() as this is too expensive when
1435 // having several thousands of items. Instead the formatting of the
1436 // date-time will be done on-demand by the view when the date will be shown.
1437 const KDateTime dateTime = item.time(KFileItem::ModificationTime);
1438 data.insert(sharedValue("date"), dateTime.dateTime());
1439 }
1440
1441 if (m_requestRole[PermissionsRole]) {
1442 data.insert(sharedValue("permissions"), item.permissionsString());
1443 }
1444
1445 if (m_requestRole[OwnerRole]) {
1446 data.insert(sharedValue("owner"), item.user());
1447 }
1448
1449 if (m_requestRole[GroupRole]) {
1450 data.insert(sharedValue("group"), item.group());
1451 }
1452
1453 if (m_requestRole[DestinationRole]) {
1454 QString destination = item.linkDest();
1455 if (destination.isEmpty()) {
1456 destination = QLatin1String("-");
1457 }
1458 data.insert(sharedValue("destination"), destination);
1459 }
1460
1461 if (m_requestRole[PathRole]) {
1462 QString path;
1463 if (item.url().protocol() == QLatin1String("trash")) {
1464 path = item.entry().stringValue(KIO::UDSEntry::UDS_EXTRA);
1465 } else {
1466 // For performance reasons cache the home-path in a static QString
1467 // (see QDir::homePath() for more details)
1468 static QString homePath;
1469 if (homePath.isEmpty()) {
1470 homePath = QDir::homePath();
1471 }
1472
1473 path = item.localPath();
1474 if (path.startsWith(homePath)) {
1475 path.replace(0, homePath.length(), QLatin1Char('~'));
1476 }
1477 }
1478
1479 const int index = path.lastIndexOf(item.text());
1480 path = path.mid(0, index - 1);
1481 data.insert(sharedValue("path"), path);
1482 }
1483
1484 if (m_requestRole[IsExpandableRole] && isDir) {
1485 data.insert(sharedValue("isExpandable"), true);
1486 }
1487
1488 if (m_requestRole[ExpandedParentsCountRole]) {
1489 if (parent) {
1490 const int level = expandedParentsCount(parent) + 1;
1491 data.insert(sharedValue("expandedParentsCount"), level);
1492 }
1493 }
1494
1495 if (item.isMimeTypeKnown()) {
1496 data.insert(sharedValue("iconName"), item.iconName());
1497
1498 if (m_requestRole[TypeRole]) {
1499 data.insert(sharedValue("type"), item.mimeComment());
1500 }
1501 } else if (m_requestRole[TypeRole] && isDir) {
1502 static const QString folderMimeType = item.mimeComment();
1503 data.insert(sharedValue("type"), folderMimeType);
1504 }
1505
1506 return data;
1507 }
1508
1509 bool KFileItemModel::lessThan(const ItemData* a, const ItemData* b) const
1510 {
1511 int result = 0;
1512
1513 if (a->parent != b->parent) {
1514 const int expansionLevelA = expandedParentsCount(a);
1515 const int expansionLevelB = expandedParentsCount(b);
1516
1517 // If b has a higher expansion level than a, check if a is a parent
1518 // of b, and make sure that both expansion levels are equal otherwise.
1519 for (int i = expansionLevelB; i > expansionLevelA; --i) {
1520 if (b->parent == a) {
1521 return true;
1522 }
1523 b = b->parent;
1524 }
1525
1526 // If a has a higher expansion level than a, check if b is a parent
1527 // of a, and make sure that both expansion levels are equal otherwise.
1528 for (int i = expansionLevelA; i > expansionLevelB; --i) {
1529 if (a->parent == b) {
1530 return false;
1531 }
1532 a = a->parent;
1533 }
1534
1535 Q_ASSERT(expandedParentsCount(a) == expandedParentsCount(b));
1536
1537 // Compare the last parents of a and b which are different.
1538 while (a->parent != b->parent) {
1539 a = a->parent;
1540 b = b->parent;
1541 }
1542 }
1543
1544 if (m_sortDirsFirst || m_sortRole == SizeRole) {
1545 const bool isDirA = a->item.isDir();
1546 const bool isDirB = b->item.isDir();
1547 if (isDirA && !isDirB) {
1548 return true;
1549 } else if (!isDirA && isDirB) {
1550 return false;
1551 }
1552 }
1553
1554 result = sortRoleCompare(a, b);
1555
1556 return (sortOrder() == Qt::AscendingOrder) ? result < 0 : result > 0;
1557 }
1558
1559 /**
1560 * Helper class for KFileItemModel::sort().
1561 */
1562 class KFileItemModelLessThan
1563 {
1564 public:
1565 KFileItemModelLessThan(const KFileItemModel* model) :
1566 m_model(model)
1567 {
1568 }
1569
1570 bool operator()(const KFileItemModel::ItemData* a, const KFileItemModel::ItemData* b) const
1571 {
1572 return m_model->lessThan(a, b);
1573 }
1574
1575 private:
1576 const KFileItemModel* m_model;
1577 };
1578
1579 void KFileItemModel::sort(QList<KFileItemModel::ItemData*>::iterator begin,
1580 QList<KFileItemModel::ItemData*>::iterator end) const
1581 {
1582 KFileItemModelLessThan lessThan(this);
1583
1584 if (m_sortRole == NameRole) {
1585 // Sorting by name can be expensive, in particular if natural sorting is
1586 // enabled. Use all CPU cores to speed up the sorting process.
1587 static const int numberOfThreads = QThread::idealThreadCount();
1588 parallelMergeSort(begin, end, lessThan, numberOfThreads);
1589 } else {
1590 // Sorting by other roles is quite fast. Use only one thread to prevent
1591 // problems caused by non-reentrant comparison functions, see
1592 // https://bugs.kde.org/show_bug.cgi?id=312679
1593 mergeSort(begin, end, lessThan);
1594 }
1595 }
1596
1597 int KFileItemModel::sortRoleCompare(const ItemData* a, const ItemData* b) const
1598 {
1599 const KFileItem& itemA = a->item;
1600 const KFileItem& itemB = b->item;
1601
1602 int result = 0;
1603
1604 switch (m_sortRole) {
1605 case NameRole:
1606 // The name role is handled as default fallback after the switch
1607 break;
1608
1609 case SizeRole: {
1610 if (itemA.isDir()) {
1611 // See "if (m_sortFoldersFirst || m_sortRole == SizeRole)" in KFileItemModel::lessThan():
1612 Q_ASSERT(itemB.isDir());
1613
1614 const QVariant valueA = a->values.value("size");
1615 const QVariant valueB = b->values.value("size");
1616 if (valueA.isNull() && valueB.isNull()) {
1617 result = 0;
1618 } else if (valueA.isNull()) {
1619 result = -1;
1620 } else if (valueB.isNull()) {
1621 result = +1;
1622 } else {
1623 result = valueA.toInt() - valueB.toInt();
1624 }
1625 } else {
1626 // See "if (m_sortFoldersFirst || m_sortRole == SizeRole)" in KFileItemModel::lessThan():
1627 Q_ASSERT(!itemB.isDir());
1628 const KIO::filesize_t sizeA = itemA.size();
1629 const KIO::filesize_t sizeB = itemB.size();
1630 if (sizeA > sizeB) {
1631 result = +1;
1632 } else if (sizeA < sizeB) {
1633 result = -1;
1634 } else {
1635 result = 0;
1636 }
1637 }
1638 break;
1639 }
1640
1641 case DateRole: {
1642 const KDateTime dateTimeA = itemA.time(KFileItem::ModificationTime);
1643 const KDateTime dateTimeB = itemB.time(KFileItem::ModificationTime);
1644 if (dateTimeA < dateTimeB) {
1645 result = -1;
1646 } else if (dateTimeA > dateTimeB) {
1647 result = +1;
1648 }
1649 break;
1650 }
1651
1652 case RatingRole: {
1653 result = a->values.value("rating").toInt() - b->values.value("rating").toInt();
1654 break;
1655 }
1656
1657 case ImageSizeRole: {
1658 // Alway use a natural comparing to interpret the numbers of a string like
1659 // "1600 x 1200" for having a correct sorting.
1660 result = KStringHandler::naturalCompare(a->values.value("imageSize").toString(),
1661 b->values.value("imageSize").toString(),
1662 Qt::CaseSensitive);
1663 break;
1664 }
1665
1666 default: {
1667 const QByteArray role = roleForType(m_sortRole);
1668 result = QString::compare(a->values.value(role).toString(),
1669 b->values.value(role).toString());
1670 break;
1671 }
1672
1673 }
1674
1675 if (result != 0) {
1676 // The current sort role was sufficient to define an order
1677 return result;
1678 }
1679
1680 // Fallback #1: Compare the text of the items
1681 result = stringCompare(itemA.text(), itemB.text());
1682 if (result != 0) {
1683 return result;
1684 }
1685
1686 // Fallback #2: KFileItem::text() may not be unique in case UDS_DISPLAY_NAME is used
1687 result = stringCompare(itemA.name(m_caseSensitivity == Qt::CaseInsensitive),
1688 itemB.name(m_caseSensitivity == Qt::CaseInsensitive));
1689 if (result != 0) {
1690 return result;
1691 }
1692
1693 // Fallback #3: It must be assured that the sort order is always unique even if two values have been
1694 // equal. In this case a comparison of the URL is done which is unique in all cases
1695 // within KDirLister.
1696 return QString::compare(itemA.url().url(), itemB.url().url(), Qt::CaseSensitive);
1697 }
1698
1699 int KFileItemModel::stringCompare(const QString& a, const QString& b) const
1700 {
1701 // Taken from KDirSortFilterProxyModel (kdelibs/kfile/kdirsortfilterproxymodel.*)
1702 // Copyright (C) 2006 by Peter Penz <peter.penz@gmx.at>
1703 // Copyright (C) 2006 by Dominic Battre <dominic@battre.de>
1704 // Copyright (C) 2006 by Martin Pool <mbp@canonical.com>
1705
1706 if (m_caseSensitivity == Qt::CaseInsensitive) {
1707 const int result = m_naturalSorting ? KStringHandler::naturalCompare(a, b, Qt::CaseInsensitive)
1708 : QString::compare(a, b, Qt::CaseInsensitive);
1709 if (result != 0) {
1710 // Only return the result, if the strings are not equal. If they are equal by a case insensitive
1711 // comparison, still a deterministic sort order is required. A case sensitive
1712 // comparison is done as fallback.
1713 return result;
1714 }
1715 }
1716
1717 return m_naturalSorting ? KStringHandler::naturalCompare(a, b, Qt::CaseSensitive)
1718 : QString::compare(a, b, Qt::CaseSensitive);
1719 }
1720
1721 bool KFileItemModel::useMaximumUpdateInterval() const
1722 {
1723 return !m_dirLister->url().isLocalFile();
1724 }
1725
1726 static bool localeAwareLessThan(const QChar& c1, const QChar& c2)
1727 {
1728 return QString::localeAwareCompare(c1, c2) < 0;
1729 }
1730
1731 QList<QPair<int, QVariant> > KFileItemModel::nameRoleGroups() const
1732 {
1733 Q_ASSERT(!m_itemData.isEmpty());
1734
1735 const int maxIndex = count() - 1;
1736 QList<QPair<int, QVariant> > groups;
1737
1738 QString groupValue;
1739 QChar firstChar;
1740 for (int i = 0; i <= maxIndex; ++i) {
1741 if (isChildItem(i)) {
1742 continue;
1743 }
1744
1745 const QString name = m_itemData.at(i)->item.text();
1746
1747 // Use the first character of the name as group indication
1748 QChar newFirstChar = name.at(0).toUpper();
1749 if (newFirstChar == QLatin1Char('~') && name.length() > 1) {
1750 newFirstChar = name.at(1).toUpper();
1751 }
1752
1753 if (firstChar != newFirstChar) {
1754 QString newGroupValue;
1755 if (newFirstChar.isLetter()) {
1756 // Try to find a matching group in the range 'A' to 'Z'.
1757 static std::vector<QChar> lettersAtoZ;
1758 if (lettersAtoZ.empty()) {
1759 for (char c = 'A'; c <= 'Z'; ++c) {
1760 lettersAtoZ.push_back(QLatin1Char(c));
1761 }
1762 }
1763
1764 std::vector<QChar>::iterator it = std::lower_bound(lettersAtoZ.begin(), lettersAtoZ.end(), newFirstChar, localeAwareLessThan);
1765 if (it != lettersAtoZ.end()) {
1766 if (localeAwareLessThan(newFirstChar, *it) && it != lettersAtoZ.begin()) {
1767 // newFirstChar belongs to the group preceding *it.
1768 // Example: for an umlaut 'A' in the German locale, *it would be 'B' now.
1769 --it;
1770 }
1771 newGroupValue = *it;
1772 } else {
1773 newGroupValue = newFirstChar;
1774 }
1775 } else if (newFirstChar >= QLatin1Char('0') && newFirstChar <= QLatin1Char('9')) {
1776 // Apply group '0 - 9' for any name that starts with a digit
1777 newGroupValue = i18nc("@title:group Groups that start with a digit", "0 - 9");
1778 } else {
1779 newGroupValue = i18nc("@title:group", "Others");
1780 }
1781
1782 if (newGroupValue != groupValue) {
1783 groupValue = newGroupValue;
1784 groups.append(QPair<int, QVariant>(i, newGroupValue));
1785 }
1786
1787 firstChar = newFirstChar;
1788 }
1789 }
1790 return groups;
1791 }
1792
1793 QList<QPair<int, QVariant> > KFileItemModel::sizeRoleGroups() const
1794 {
1795 Q_ASSERT(!m_itemData.isEmpty());
1796
1797 const int maxIndex = count() - 1;
1798 QList<QPair<int, QVariant> > groups;
1799
1800 QString groupValue;
1801 for (int i = 0; i <= maxIndex; ++i) {
1802 if (isChildItem(i)) {
1803 continue;
1804 }
1805
1806 const KFileItem& item = m_itemData.at(i)->item;
1807 const KIO::filesize_t fileSize = !item.isNull() ? item.size() : ~0U;
1808 QString newGroupValue;
1809 if (!item.isNull() && item.isDir()) {
1810 newGroupValue = i18nc("@title:group Size", "Folders");
1811 } else if (fileSize < 5 * 1024 * 1024) {
1812 newGroupValue = i18nc("@title:group Size", "Small");
1813 } else if (fileSize < 10 * 1024 * 1024) {
1814 newGroupValue = i18nc("@title:group Size", "Medium");
1815 } else {
1816 newGroupValue = i18nc("@title:group Size", "Big");
1817 }
1818
1819 if (newGroupValue != groupValue) {
1820 groupValue = newGroupValue;
1821 groups.append(QPair<int, QVariant>(i, newGroupValue));
1822 }
1823 }
1824
1825 return groups;
1826 }
1827
1828 QList<QPair<int, QVariant> > KFileItemModel::dateRoleGroups() const
1829 {
1830 Q_ASSERT(!m_itemData.isEmpty());
1831
1832 const int maxIndex = count() - 1;
1833 QList<QPair<int, QVariant> > groups;
1834
1835 const QDate currentDate = KDateTime::currentLocalDateTime().date();
1836
1837 QDate previousModifiedDate;
1838 QString groupValue;
1839 for (int i = 0; i <= maxIndex; ++i) {
1840 if (isChildItem(i)) {
1841 continue;
1842 }
1843
1844 const KDateTime modifiedTime = m_itemData.at(i)->item.time(KFileItem::ModificationTime);
1845 const QDate modifiedDate = modifiedTime.date();
1846 if (modifiedDate == previousModifiedDate) {
1847 // The current item is in the same group as the previous item
1848 continue;
1849 }
1850 previousModifiedDate = modifiedDate;
1851
1852 const int daysDistance = modifiedDate.daysTo(currentDate);
1853
1854 QString newGroupValue;
1855 if (currentDate.year() == modifiedDate.year() && currentDate.month() == modifiedDate.month()) {
1856 switch (daysDistance / 7) {
1857 case 0:
1858 switch (daysDistance) {
1859 case 0: newGroupValue = i18nc("@title:group Date", "Today"); break;
1860 case 1: newGroupValue = i18nc("@title:group Date", "Yesterday"); break;
1861 default: newGroupValue = modifiedTime.toString(i18nc("@title:group The week day name: %A", "%A"));
1862 }
1863 break;
1864 case 1:
1865 newGroupValue = i18nc("@title:group Date", "One Week Ago");
1866 break;
1867 case 2:
1868 newGroupValue = i18nc("@title:group Date", "Two Weeks Ago");
1869 break;
1870 case 3:
1871 newGroupValue = i18nc("@title:group Date", "Three Weeks Ago");
1872 break;
1873 case 4:
1874 case 5:
1875 newGroupValue = i18nc("@title:group Date", "Earlier this Month");
1876 break;
1877 default:
1878 Q_ASSERT(false);
1879 }
1880 } else {
1881 const QDate lastMonthDate = currentDate.addMonths(-1);
1882 if (lastMonthDate.year() == modifiedDate.year() && lastMonthDate.month() == modifiedDate.month()) {
1883 if (daysDistance == 1) {
1884 newGroupValue = modifiedTime.toString(i18nc("@title:group Date: %B is full month name in current locale, and %Y is full year number", "Yesterday (%B, %Y)"));
1885 } else if (daysDistance <= 7) {
1886 newGroupValue = modifiedTime.toString(i18nc("@title:group The week day name: %A, %B is full month name in current locale, and %Y is full year number", "%A (%B, %Y)"));
1887 } else if (daysDistance <= 7 * 2) {
1888 newGroupValue = modifiedTime.toString(i18nc("@title:group Date: %B is full month name in current locale, and %Y is full year number", "One Week Ago (%B, %Y)"));
1889 } else if (daysDistance <= 7 * 3) {
1890 newGroupValue = modifiedTime.toString(i18nc("@title:group Date: %B is full month name in current locale, and %Y is full year number", "Two Weeks Ago (%B, %Y)"));
1891 } else if (daysDistance <= 7 * 4) {
1892 newGroupValue = modifiedTime.toString(i18nc("@title:group Date: %B is full month name in current locale, and %Y is full year number", "Three Weeks Ago (%B, %Y)"));
1893 } else {
1894 newGroupValue = modifiedTime.toString(i18nc("@title:group Date: %B is full month name in current locale, and %Y is full year number", "Earlier on %B, %Y"));
1895 }
1896 } else {
1897 newGroupValue = modifiedTime.toString(i18nc("@title:group The month and year: %B is full month name in current locale, and %Y is full year number", "%B, %Y"));
1898 }
1899 }
1900
1901 if (newGroupValue != groupValue) {
1902 groupValue = newGroupValue;
1903 groups.append(QPair<int, QVariant>(i, newGroupValue));
1904 }
1905 }
1906
1907 return groups;
1908 }
1909
1910 QList<QPair<int, QVariant> > KFileItemModel::permissionRoleGroups() const
1911 {
1912 Q_ASSERT(!m_itemData.isEmpty());
1913
1914 const int maxIndex = count() - 1;
1915 QList<QPair<int, QVariant> > groups;
1916
1917 QString permissionsString;
1918 QString groupValue;
1919 for (int i = 0; i <= maxIndex; ++i) {
1920 if (isChildItem(i)) {
1921 continue;
1922 }
1923
1924 const ItemData* itemData = m_itemData.at(i);
1925 const QString newPermissionsString = itemData->values.value("permissions").toString();
1926 if (newPermissionsString == permissionsString) {
1927 continue;
1928 }
1929 permissionsString = newPermissionsString;
1930
1931 const QFileInfo info(itemData->item.url().pathOrUrl());
1932
1933 // Set user string
1934 QString user;
1935 if (info.permission(QFile::ReadUser)) {
1936 user = i18nc("@item:intext Access permission, concatenated", "Read, ");
1937 }
1938 if (info.permission(QFile::WriteUser)) {
1939 user += i18nc("@item:intext Access permission, concatenated", "Write, ");
1940 }
1941 if (info.permission(QFile::ExeUser)) {
1942 user += i18nc("@item:intext Access permission, concatenated", "Execute, ");
1943 }
1944 user = user.isEmpty() ? i18nc("@item:intext Access permission, concatenated", "Forbidden") : user.mid(0, user.count() - 2);
1945
1946 // Set group string
1947 QString group;
1948 if (info.permission(QFile::ReadGroup)) {
1949 group = i18nc("@item:intext Access permission, concatenated", "Read, ");
1950 }
1951 if (info.permission(QFile::WriteGroup)) {
1952 group += i18nc("@item:intext Access permission, concatenated", "Write, ");
1953 }
1954 if (info.permission(QFile::ExeGroup)) {
1955 group += i18nc("@item:intext Access permission, concatenated", "Execute, ");
1956 }
1957 group = group.isEmpty() ? i18nc("@item:intext Access permission, concatenated", "Forbidden") : group.mid(0, group.count() - 2);
1958
1959 // Set others string
1960 QString others;
1961 if (info.permission(QFile::ReadOther)) {
1962 others = i18nc("@item:intext Access permission, concatenated", "Read, ");
1963 }
1964 if (info.permission(QFile::WriteOther)) {
1965 others += i18nc("@item:intext Access permission, concatenated", "Write, ");
1966 }
1967 if (info.permission(QFile::ExeOther)) {
1968 others += i18nc("@item:intext Access permission, concatenated", "Execute, ");
1969 }
1970 others = others.isEmpty() ? i18nc("@item:intext Access permission, concatenated", "Forbidden") : others.mid(0, others.count() - 2);
1971
1972 const QString newGroupValue = i18nc("@title:group Files and folders by permissions", "User: %1 | Group: %2 | Others: %3", user, group, others);
1973 if (newGroupValue != groupValue) {
1974 groupValue = newGroupValue;
1975 groups.append(QPair<int, QVariant>(i, newGroupValue));
1976 }
1977 }
1978
1979 return groups;
1980 }
1981
1982 QList<QPair<int, QVariant> > KFileItemModel::ratingRoleGroups() const
1983 {
1984 Q_ASSERT(!m_itemData.isEmpty());
1985
1986 const int maxIndex = count() - 1;
1987 QList<QPair<int, QVariant> > groups;
1988
1989 int groupValue = -1;
1990 for (int i = 0; i <= maxIndex; ++i) {
1991 if (isChildItem(i)) {
1992 continue;
1993 }
1994 const int newGroupValue = m_itemData.at(i)->values.value("rating", 0).toInt();
1995 if (newGroupValue != groupValue) {
1996 groupValue = newGroupValue;
1997 groups.append(QPair<int, QVariant>(i, newGroupValue));
1998 }
1999 }
2000
2001 return groups;
2002 }
2003
2004 QList<QPair<int, QVariant> > KFileItemModel::genericStringRoleGroups(const QByteArray& role) const
2005 {
2006 Q_ASSERT(!m_itemData.isEmpty());
2007
2008 const int maxIndex = count() - 1;
2009 QList<QPair<int, QVariant> > groups;
2010
2011 bool isFirstGroupValue = true;
2012 QString groupValue;
2013 for (int i = 0; i <= maxIndex; ++i) {
2014 if (isChildItem(i)) {
2015 continue;
2016 }
2017 const QString newGroupValue = m_itemData.at(i)->values.value(role).toString();
2018 if (newGroupValue != groupValue || isFirstGroupValue) {
2019 groupValue = newGroupValue;
2020 groups.append(QPair<int, QVariant>(i, newGroupValue));
2021 isFirstGroupValue = false;
2022 }
2023 }
2024
2025 return groups;
2026 }
2027
2028 void KFileItemModel::emitSortProgress(int resolvedCount)
2029 {
2030 // Be tolerant against a resolvedCount with a wrong range.
2031 // Although there should not be a case where KFileItemModelRolesUpdater
2032 // (= caller) provides a wrong range, it is important to emit
2033 // a useful progress information even if there is an unexpected
2034 // implementation issue.
2035
2036 const int itemCount = count();
2037 if (resolvedCount >= itemCount) {
2038 m_sortingProgressPercent = -1;
2039 if (m_resortAllItemsTimer->isActive()) {
2040 m_resortAllItemsTimer->stop();
2041 resortAllItems();
2042 }
2043
2044 emit directorySortingProgress(100);
2045 } else if (itemCount > 0) {
2046 resolvedCount = qBound(0, resolvedCount, itemCount);
2047
2048 const int progress = resolvedCount * 100 / itemCount;
2049 if (m_sortingProgressPercent != progress) {
2050 m_sortingProgressPercent = progress;
2051 emit directorySortingProgress(progress);
2052 }
2053 }
2054 }
2055
2056 const KFileItemModel::RoleInfoMap* KFileItemModel::rolesInfoMap(int& count)
2057 {
2058 static const RoleInfoMap rolesInfoMap[] = {
2059 // | role | roleType | role translation | group translation | requires Nepomuk | requires indexer
2060 { 0, NoRole, 0, 0, 0, 0, false, false },
2061 { "text", NameRole, I18N_NOOP2_NOSTRIP("@label", "Name"), 0, 0, false, false },
2062 { "size", SizeRole, I18N_NOOP2_NOSTRIP("@label", "Size"), 0, 0, false, false },
2063 { "date", DateRole, I18N_NOOP2_NOSTRIP("@label", "Date"), 0, 0, false, false },
2064 { "type", TypeRole, I18N_NOOP2_NOSTRIP("@label", "Type"), 0, 0, false, false },
2065 { "rating", RatingRole, I18N_NOOP2_NOSTRIP("@label", "Rating"), 0, 0, true, false },
2066 { "tags", TagsRole, I18N_NOOP2_NOSTRIP("@label", "Tags"), 0, 0, true, false },
2067 { "comment", CommentRole, I18N_NOOP2_NOSTRIP("@label", "Comment"), 0, 0, true, false },
2068 { "wordCount", WordCountRole, I18N_NOOP2_NOSTRIP("@label", "Word Count"), I18N_NOOP2_NOSTRIP("@label", "Document"), true, true },
2069 { "lineCount", LineCountRole, I18N_NOOP2_NOSTRIP("@label", "Line Count"), I18N_NOOP2_NOSTRIP("@label", "Document"), true, true },
2070 { "imageSize", ImageSizeRole, I18N_NOOP2_NOSTRIP("@label", "Image Size"), I18N_NOOP2_NOSTRIP("@label", "Image"), true, true },
2071 { "orientation", OrientationRole, I18N_NOOP2_NOSTRIP("@label", "Orientation"), I18N_NOOP2_NOSTRIP("@label", "Image"), true, true },
2072 { "artist", ArtistRole, I18N_NOOP2_NOSTRIP("@label", "Artist"), I18N_NOOP2_NOSTRIP("@label", "Audio"), true, true },
2073 { "album", AlbumRole, I18N_NOOP2_NOSTRIP("@label", "Album"), I18N_NOOP2_NOSTRIP("@label", "Audio"), true, true },
2074 { "duration", DurationRole, I18N_NOOP2_NOSTRIP("@label", "Duration"), I18N_NOOP2_NOSTRIP("@label", "Audio"), true, true },
2075 { "track", TrackRole, I18N_NOOP2_NOSTRIP("@label", "Track"), I18N_NOOP2_NOSTRIP("@label", "Audio"), true, true },
2076 { "path", PathRole, I18N_NOOP2_NOSTRIP("@label", "Path"), I18N_NOOP2_NOSTRIP("@label", "Other"), false, false },
2077 { "destination", DestinationRole, I18N_NOOP2_NOSTRIP("@label", "Link Destination"), I18N_NOOP2_NOSTRIP("@label", "Other"), false, false },
2078 { "copiedFrom", CopiedFromRole, I18N_NOOP2_NOSTRIP("@label", "Copied From"), I18N_NOOP2_NOSTRIP("@label", "Other"), true, false },
2079 { "permissions", PermissionsRole, I18N_NOOP2_NOSTRIP("@label", "Permissions"), I18N_NOOP2_NOSTRIP("@label", "Other"), false, false },
2080 { "owner", OwnerRole, I18N_NOOP2_NOSTRIP("@label", "Owner"), I18N_NOOP2_NOSTRIP("@label", "Other"), false, false },
2081 { "group", GroupRole, I18N_NOOP2_NOSTRIP("@label", "User Group"), I18N_NOOP2_NOSTRIP("@label", "Other"), false, false },
2082 };
2083
2084 count = sizeof(rolesInfoMap) / sizeof(RoleInfoMap);
2085 return rolesInfoMap;
2086 }
2087
2088 void KFileItemModel::determineMimeTypes(const KFileItemList& items, int timeout)
2089 {
2090 QElapsedTimer timer;
2091 timer.start();
2092 foreach (const KFileItem& item, items) { // krazy:exclude=foreach
2093 // Only determine mime types for files here. For directories,
2094 // KFileItem::determineMimeType() reads the .directory file inside to
2095 // load the icon, but this is not necessary at all if we just need the
2096 // type. Some special code for setting the correct mime type for
2097 // directories is in retrieveData().
2098 if (!item.isDir()) {
2099 item.determineMimeType();
2100 }
2101
2102 if (timer.elapsed() > timeout) {
2103 // Don't block the user interface, let the remaining items
2104 // be resolved asynchronously.
2105 return;
2106 }
2107 }
2108 }
2109
2110 QByteArray KFileItemModel::sharedValue(const QByteArray& value)
2111 {
2112 static QSet<QByteArray> pool;
2113 const QSet<QByteArray>::const_iterator it = pool.constFind(value);
2114
2115 if (it != pool.constEnd()) {
2116 return *it;
2117 } else {
2118 pool.insert(value);
2119 return value;
2120 }
2121 }
2122
2123 bool KFileItemModel::isConsistent() const
2124 {
2125 if (m_items.count() != m_itemData.count()) {
2126 return false;
2127 }
2128
2129 for (int i = 0; i < count(); ++i) {
2130 // Check if m_items and m_itemData are consistent.
2131 const KFileItem item = fileItem(i);
2132 if (item.isNull()) {
2133 qWarning() << "Item" << i << "is null";
2134 return false;
2135 }
2136
2137 const int itemIndex = index(item);
2138 if (itemIndex != i) {
2139 qWarning() << "Item" << i << "has a wrong index:" << itemIndex;
2140 return false;
2141 }
2142
2143 // Check if the items are sorted correctly.
2144 if (i > 0 && !lessThan(m_itemData.at(i - 1), m_itemData.at(i))) {
2145 qWarning() << "The order of items" << i - 1 << "and" << i << "is wrong:"
2146 << fileItem(i - 1) << fileItem(i);
2147 return false;
2148 }
2149
2150 // Check if all parent-child relationships are consistent.
2151 const ItemData* data = m_itemData.at(i);
2152 const ItemData* parent = data->parent;
2153 if (parent) {
2154 if (expandedParentsCount(data) != expandedParentsCount(parent) + 1) {
2155 qWarning() << "expandedParentsCount is inconsistent for parent" << parent->item << "and child" << data->item;
2156 return false;
2157 }
2158
2159 const int parentIndex = index(parent->item);
2160 if (parentIndex >= i) {
2161 qWarning() << "Index" << parentIndex << "of parent" << parent->item << "is not smaller than index" << i << "of child" << data->item;
2162 return false;
2163 }
2164 }
2165 }
2166
2167 return true;
2168 }
2169
2170 #include "kfileitemmodel.moc"