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