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 = sharedValue(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.targetUrl();
 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(sharedValue("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     if (!m_requestRole[m_sortRole]) {
 648         QSet<QByteArray> newRoles = m_roles;
 649         newRoles << current;
 650         setRoles(newRoles);
 651     }
 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         KFileItem item = items.first();
 763
 764         // If the expanding of items is enabled, the call
 765         // dirLister->openUrl(url, KDirLister::Keep) in KFileItemModel::setExpanded()
 766         // might result in emitting the same items twice due to the Keep-parameter.
 767         // This case happens if an item gets expanded, collapsed and expanded again
 768         // before the items could be loaded for the first expansion.
 769         const int index = m_items.value(item.url(), -1);
 770         if (index >= 0) {
 771             // The items are already part of the model.
 772             return;
 773         }
 774
 775         if (directoryUrl != directory()) {
 776             // To be able to compare whether the new items may be inserted as children
 777             // of a parent item the pending items must be added to the model first.
 778             dispatchPendingItemsToInsert();
 779         }
 780
 781         // KDirLister keeps the children of items that got expanded once even if
 782         // they got collapsed again with KFileItemModel::setExpanded(false). So it must be
 783         // checked whether the parent for new items is still expanded.
 784         const int parentIndex = m_items.value(parentUrl, -1);
 785         if (parentIndex >= 0 && !m_itemData[parentIndex]->values.value("isExpanded").toBool()) {
 786             // The parent is not expanded.
 787             return;
 788         }
 789     }
 790
 791     QList<ItemData*> itemDataList = createItemDataList(parentUrl, items);
 792
 793     if (!m_filter.hasSetFilters()) {
 794         m_pendingItemsToInsert.append(itemDataList);
 795     } else {
 796         // The name or type filter is active. Hide filtered items
 797         // before inserting them into the model and remember
 798         // the filtered items in m_filteredItems.
 799         foreach (ItemData* itemData, itemDataList) {
 800             if (m_filter.matches(itemData->item)) {
 801                 m_pendingItemsToInsert.append(itemData);
 802             } else {
 803                 m_filteredItems.insert(itemData->item, itemData);
 804             }
 805         }
 806     }
 807
 808     if (useMaximumUpdateInterval() && !m_maximumUpdateIntervalTimer->isActive()) {
 809         // Assure that items get dispatched if no completed() or canceled() signal is
 810         // emitted during the maximum update interval.
 811         m_maximumUpdateIntervalTimer->start();
 812     }
 813 }
 814
 815 void KFileItemModel::slotItemsDeleted(const KFileItemList& items)
 816 {
 817     dispatchPendingItemsToInsert();
 818
 819     KFileItemList itemsToRemove = items;
 820     if (m_requestRole[ExpandedParentsCountRole]) {
 821         // Assure that removing a parent item also results in removing all children
 822         foreach (const KFileItem& item, items) {
 823             itemsToRemove.append(childItems(item));
 824         }
 825     }
 826
 827     if (!m_filteredItems.isEmpty()) {
 828         foreach (const KFileItem& item, itemsToRemove) {
 829             QHash<KFileItem, ItemData*>::iterator it = m_filteredItems.find(item);
 830             if (it != m_filteredItems.end()) {
 831                 delete it.value();
 832                 m_filteredItems.erase(it);
 833             }
 834         }
 835
 836         if (m_requestRole[ExpandedParentsCountRole]) {
 837             removeFilteredChildren(itemsToRemove);
 838         }
 839     }
 840
 841     removeItems(itemsToRemove, DeleteItemData);
 842 }
 843
 844 void KFileItemModel::slotRefreshItems(const QList<QPair<KFileItem, KFileItem> >& items)
 845 {
 846     Q_ASSERT(!items.isEmpty());
 847 #ifdef KFILEITEMMODEL_DEBUG
 848     kDebug() << "Refreshing" << items.count() << "items";
 849 #endif
 850
 851     // Get the indexes of all items that have been refreshed
 852     QList<int> indexes;
 853     indexes.reserve(items.count());
 854
 855     QSet<QByteArray> changedRoles;
 856
 857     QListIterator<QPair<KFileItem, KFileItem> > it(items);
 858     while (it.hasNext()) {
 859         const QPair<KFileItem, KFileItem>& itemPair = it.next();
 860         const KFileItem& oldItem = itemPair.first;
 861         const KFileItem& newItem = itemPair.second;
 862         const int index = m_items.value(oldItem.url(), -1);
 863         if (index >= 0) {
 864             m_itemData[index]->item = newItem;
 865
 866             // Keep old values as long as possible if they could not retrieved synchronously yet.
 867             // The update of the values will be done asynchronously by KFileItemModelRolesUpdater.
 868             QHashIterator<QByteArray, QVariant> it(retrieveData(newItem, m_itemData.at(index)->parent));
 869             QHash<QByteArray, QVariant>& values = m_itemData[index]->values;
 870             while (it.hasNext()) {
 871                 it.next();
 872                 const QByteArray& role = it.key();
 873                 if (values.value(role) != it.value()) {
 874                     values.insert(role, it.value());
 875                     changedRoles.insert(role);
 876                 }
 877             }
 878
 879             m_items.remove(oldItem.url());
 880             m_items.insert(newItem.url(), index);
 881             indexes.append(index);
 882         }
 883     }
 884
 885     // If the changed items have been created recently, they might not be in m_items yet.
 886     // In that case, the list 'indexes' might be empty.
 887     if (indexes.isEmpty()) {
 888         return;
 889     }
 890
 891     // Extract the item-ranges out of the changed indexes
 892     qSort(indexes);
 893
 894     KItemRangeList itemRangeList;
 895     int previousIndex = indexes.at(0);
 896     int rangeIndex = previousIndex;
 897     int rangeCount = 1;
 898
 899     const int maxIndex = indexes.count() - 1;
 900     for (int i = 1; i <= maxIndex; ++i) {
 901         const int currentIndex = indexes.at(i);
 902         if (currentIndex == previousIndex + 1) {
 903             ++rangeCount;
 904         } else {
 905             itemRangeList.append(KItemRange(rangeIndex, rangeCount));
 906
 907             rangeIndex = currentIndex;
 908             rangeCount = 1;
 909         }
 910         previousIndex = currentIndex;
 911     }
 912
 913     if (rangeCount > 0) {
 914         itemRangeList.append(KItemRange(rangeIndex, rangeCount));
 915     }
 916
 917     emit itemsChanged(itemRangeList, changedRoles);
 918
 919     if (changedRoles.contains(sortRole())) {
 920         resortAllItems();
 921     }
 922 }
 923
 924 void KFileItemModel::slotClear()
 925 {
 926 #ifdef KFILEITEMMODEL_DEBUG
 927     kDebug() << "Clearing all items";
 928 #endif
 929
 930     qDeleteAll(m_filteredItems.values());
 931     m_filteredItems.clear();
 932     m_groups.clear();
 933
 934     m_maximumUpdateIntervalTimer->stop();
 935     m_resortAllItemsTimer->stop();
 936     m_pendingItemsToInsert.clear();
 937
 938     const int removedCount = m_itemData.count();
 939     if (removedCount > 0) {
 940         qDeleteAll(m_itemData);
 941         m_itemData.clear();
 942         m_items.clear();
 943         emit itemsRemoved(KItemRangeList() << KItemRange(0, removedCount));
 944     }
 945
 946     m_expandedDirs.clear();
 947 }
 948
 949 void KFileItemModel::slotClear(const KUrl& url)
 950 {
 951     Q_UNUSED(url);
 952 }
 953
 954 void KFileItemModel::slotNaturalSortingChanged()
 955 {
 956     m_naturalSorting = KGlobalSettings::naturalSorting();
 957     resortAllItems();
 958 }
 959
 960 void KFileItemModel::dispatchPendingItemsToInsert()
 961 {
 962     if (!m_pendingItemsToInsert.isEmpty()) {
 963         insertItems(m_pendingItemsToInsert);
 964         m_pendingItemsToInsert.clear();
 965     }
 966 }
 967
 968 void KFileItemModel::insertItems(QList<ItemData*>& newItems)
 969 {
 970     if (newItems.isEmpty()) {
 971         return;
 972     }
 973
 974 #ifdef KFILEITEMMODEL_DEBUG
 975     QElapsedTimer timer;
 976     timer.start();
 977     kDebug() << "===========================================================";
 978     kDebug() << "Inserting" << newItems.count() << "items";
 979 #endif
 980
 981     m_groups.clear();
 982
 983     sort(newItems.begin(), newItems.end());
 984
 985 #ifdef KFILEITEMMODEL_DEBUG
 986     kDebug() << "[TIME] Sorting:" << timer.elapsed();
 987 #endif
 988
 989     KItemRangeList itemRanges;
 990     const int existingItemCount = m_itemData.count();
 991     const int newItemCount = newItems.count();
 992     const int totalItemCount = existingItemCount + newItemCount;
 993
 994     if (existingItemCount == 0) {
 995         // Optimization for the common special case that there are no
 996         // items in the model yet. Happens, e.g., when entering a folder.
 997         m_itemData = newItems;
 998         itemRanges << KItemRange(0, newItemCount);
 999     } else {
1000         m_itemData.reserve(totalItemCount);
1001         for (int i = existingItemCount; i < totalItemCount; ++i) {
1002             m_itemData.append(0);
1003         }
1004
1005         // We build the new list m_items in reverse order to minimize
1006         // the number of moves and guarantee O(N) complexity.
1007         int targetIndex = totalItemCount - 1;
1008         int sourceIndexExistingItems = existingItemCount - 1;
1009         int sourceIndexNewItems = newItemCount - 1;
1010
1011         int rangeCount = 0;
1012
1013         while (sourceIndexNewItems >= 0) {
1014             ItemData* newItem = newItems.at(sourceIndexNewItems);
1015             if (sourceIndexExistingItems >= 0 && lessThan(newItem, m_itemData.at(sourceIndexExistingItems))) {
1016                 // Move an existing item to its new position. If any new items
1017                 // are behind it, push the item range to itemRanges.
1018                 if (rangeCount > 0) {
1019                     itemRanges << KItemRange(sourceIndexExistingItems + 1, rangeCount);
1020                     rangeCount = 0;
1021                 }
1022
1023                 m_itemData[targetIndex] = m_itemData.at(sourceIndexExistingItems);
1024                 --sourceIndexExistingItems;
1025             } else {
1026                 // Insert a new item into the list.
1027                 ++rangeCount;
1028                 m_itemData[targetIndex] = newItem;
1029                 --sourceIndexNewItems;
1030             }
1031             --targetIndex;
1032         }
1033
1034         // Push the final item range to itemRanges.
1035         if (rangeCount > 0) {
1036             itemRanges << KItemRange(sourceIndexExistingItems + 1, rangeCount);
1037         }
1038
1039         // Note that itemRanges is still sorted in reverse order.
1040         std::reverse(itemRanges.begin(), itemRanges.end());
1041     }
1042
1043     // The indexes starting from the first inserted item must be adjusted.
1044     m_items.reserve(totalItemCount);
1045     for (int i = itemRanges.front().index; i < totalItemCount; ++i) {
1046         m_items.insert(m_itemData.at(i)->item.url(), i);
1047     }
1048
1049     emit itemsInserted(itemRanges);
1050
1051 #ifdef KFILEITEMMODEL_DEBUG
1052     kDebug() << "[TIME] Inserting of" << newItems.count() << "items:" << timer.elapsed();
1053 #endif
1054 }
1055
1056 static KItemRangeList sortedIndexesToKItemRangeList(const QList<int>& sortedNumbers)
1057 {
1058     if (sortedNumbers.empty()) {
1059         return KItemRangeList();
1060     }
1061
1062     KItemRangeList result;
1063
1064     QList<int>::const_iterator it = sortedNumbers.begin();
1065     int index = *it;
1066     int count = 1;
1067
1068     ++it;
1069
1070     QList<int>::const_iterator end = sortedNumbers.end();
1071     while (it != end) {
1072         if (*it == index + count) {
1073             ++count;
1074         } else {
1075             result << KItemRange(index, count);
1076             index = *it;
1077             count = 1;
1078         }
1079         ++it;
1080     }
1081
1082     result << KItemRange(index, count);
1083     return result;
1084 }
1085
1086 void KFileItemModel::removeItems(const KFileItemList& items, RemoveItemsBehavior behavior)
1087 {
1088 #ifdef KFILEITEMMODEL_DEBUG
1089     kDebug() << "Removing " << items.count() << "items";
1090 #endif
1091
1092     m_groups.clear();
1093
1094     // Step 1: Determine the indexes of the removed items, remove them from
1095     //         the hash m_items, and free the ItemData.
1096     QList<int> indexesToRemove;
1097     indexesToRemove.reserve(items.count());
1098     foreach (const KFileItem& item, items) {
1099         const KUrl url = item.url();
1100         const int index = m_items.value(url, -1);
1101         if (index >= 0) {
1102             indexesToRemove.append(index);
1103
1104             // Prevent repeated expensive rehashing by using QHash::erase(),
1105             // rather than QHash::remove().
1106             QHash<KUrl, int>::iterator it = m_items.find(url);
1107             m_items.erase(it);
1108
1109             if (behavior == DeleteItemData) {
1110                 delete m_itemData.at(index);
1111             }
1112
1113             m_itemData[index] = 0;
1114         }
1115     }
1116
1117     if (indexesToRemove.isEmpty()) {
1118         return;
1119     }
1120
1121     std::sort(indexesToRemove.begin(), indexesToRemove.end());
1122
1123     // Step 2: Remove the ItemData pointers from the list m_itemData.
1124     const KItemRangeList itemRanges = sortedIndexesToKItemRangeList(indexesToRemove);
1125     int target = itemRanges.at(0).index;
1126     int source = itemRanges.at(0).index + itemRanges.at(0).count;
1127     int nextRange = 1;
1128
1129     const int oldItemDataCount = m_itemData.count();
1130     while (source < oldItemDataCount) {
1131         m_itemData[target] = m_itemData[source];
1132         ++target;
1133         ++source;
1134
1135         if (nextRange < itemRanges.count() && source == itemRanges.at(nextRange).index) {
1136             // Skip the items in the next removed range.
1137             source += itemRanges.at(nextRange).count;
1138             ++nextRange;
1139         }
1140     }
1141
1142     m_itemData.erase(m_itemData.end() - indexesToRemove.count(), m_itemData.end());
1143
1144     // Step 3: Adjust indexes in the hash m_items, starting from the
1145     //         index of the first removed item.
1146     const int newItemDataCount = m_itemData.count();
1147     for (int i = itemRanges.front().index; i < newItemDataCount; ++i) {
1148         m_items.insert(m_itemData.at(i)->item.url(), i);
1149     }
1150
1151     emit itemsRemoved(itemRanges);
1152 }
1153
1154 QList<KFileItemModel::ItemData*> KFileItemModel::createItemDataList(const KUrl& parentUrl, const KFileItemList& items) const
1155 {
1156     if (m_sortRole == TypeRole) {
1157         // Try to resolve the MIME-types synchronously to prevent a reordering of
1158         // the items when sorting by type (per default MIME-types are resolved
1159         // asynchronously by KFileItemModelRolesUpdater).
1160         determineMimeTypes(items, 200);
1161     }
1162
1163     const int parentIndex = m_items.value(parentUrl, -1);
1164     ItemData* parentItem = parentIndex < 0 ? 0 : m_itemData.at(parentIndex);
1165
1166     QList<ItemData*> itemDataList;
1167     itemDataList.reserve(items.count());
1168
1169     foreach (const KFileItem& item, items) {
1170         ItemData* itemData = new ItemData();
1171         itemData->item = item;
1172         itemData->values = retrieveData(item, parentItem);
1173         itemData->parent = parentItem;
1174         itemDataList.append(itemData);
1175     }
1176
1177     return itemDataList;
1178 }
1179
1180 void KFileItemModel::removeExpandedItems()
1181 {
1182     KFileItemList expandedItems;
1183
1184     const int maxIndex = m_itemData.count() - 1;
1185     for (int i = 0; i <= maxIndex; ++i) {
1186         const ItemData* itemData = m_itemData.at(i);
1187         if (itemData->values.value("expandedParentsCount").toInt() > 0) {
1188             expandedItems.append(itemData->item);
1189         }
1190     }
1191
1192     // The m_expandedParentsCountRoot may not get reset before all items with
1193     // a bigger count have been removed.
1194     removeItems(expandedItems, DeleteItemData);
1195
1196     m_expandedDirs.clear();
1197 }
1198
1199 void KFileItemModel::resetRoles()
1200 {
1201     for (int i = 0; i < RolesCount; ++i) {
1202         m_requestRole[i] = false;
1203     }
1204 }
1205
1206 KFileItemModel::RoleType KFileItemModel::typeForRole(const QByteArray& role) const
1207 {
1208     static QHash<QByteArray, RoleType> roles;
1209     if (roles.isEmpty()) {
1210         // Insert user visible roles that can be accessed with
1211         // KFileItemModel::roleInformation()
1212         int count = 0;
1213         const RoleInfoMap* map = rolesInfoMap(count);
1214         for (int i = 0; i < count; ++i) {
1215             roles.insert(map[i].role, map[i].roleType);
1216         }
1217
1218         // Insert internal roles (take care to synchronize the implementation
1219         // with KFileItemModel::roleForType() in case if a change is done).
1220         roles.insert("isDir", IsDirRole);
1221         roles.insert("isLink", IsLinkRole);
1222         roles.insert("isExpanded", IsExpandedRole);
1223         roles.insert("isExpandable", IsExpandableRole);
1224         roles.insert("expandedParentsCount", ExpandedParentsCountRole);
1225
1226         Q_ASSERT(roles.count() == RolesCount);
1227     }
1228
1229     return roles.value(role, NoRole);
1230 }
1231
1232 QByteArray KFileItemModel::roleForType(RoleType roleType) const
1233 {
1234     static QHash<RoleType, QByteArray> roles;
1235     if (roles.isEmpty()) {
1236         // Insert user visible roles that can be accessed with
1237         // KFileItemModel::roleInformation()
1238         int count = 0;
1239         const RoleInfoMap* map = rolesInfoMap(count);
1240         for (int i = 0; i < count; ++i) {
1241             roles.insert(map[i].roleType, map[i].role);
1242         }
1243
1244         // Insert internal roles (take care to synchronize the implementation
1245         // with KFileItemModel::typeForRole() in case if a change is done).
1246         roles.insert(IsDirRole, "isDir");
1247         roles.insert(IsLinkRole, "isLink");
1248         roles.insert(IsExpandedRole, "isExpanded");
1249         roles.insert(IsExpandableRole, "isExpandable");
1250         roles.insert(ExpandedParentsCountRole, "expandedParentsCount");
1251
1252         Q_ASSERT(roles.count() == RolesCount);
1253     };
1254
1255     return roles.value(roleType);
1256 }
1257
1258 QHash<QByteArray, QVariant> KFileItemModel::retrieveData(const KFileItem& item, const ItemData* parent) const
1259 {
1260     // It is important to insert only roles that are fast to retrieve. E.g.
1261     // KFileItem::iconName() can be very expensive if the MIME-type is unknown
1262     // and hence will be retrieved asynchronously by KFileItemModelRolesUpdater.
1263     QHash<QByteArray, QVariant> data;
1264     data.insert(sharedValue("url"), item.url());
1265
1266     const bool isDir = item.isDir();
1267     if (m_requestRole[IsDirRole]) {
1268         data.insert(sharedValue("isDir"), isDir);
1269     }
1270
1271     if (m_requestRole[IsLinkRole]) {
1272         const bool isLink = item.isLink();
1273         data.insert(sharedValue("isLink"), isLink);
1274     }
1275
1276     if (m_requestRole[NameRole]) {
1277         data.insert(sharedValue("text"), item.text());
1278     }
1279
1280     if (m_requestRole[SizeRole]) {
1281         if (isDir) {
1282             data.insert(sharedValue("size"), QVariant());
1283         } else {
1284             data.insert(sharedValue("size"), item.size());
1285         }
1286     }
1287
1288     if (m_requestRole[DateRole]) {
1289         // Don't use KFileItem::timeString() as this is too expensive when
1290         // having several thousands of items. Instead the formatting of the
1291         // date-time will be done on-demand by the view when the date will be shown.
1292         const KDateTime dateTime = item.time(KFileItem::ModificationTime);
1293         data.insert(sharedValue("date"), dateTime.dateTime());
1294     }
1295
1296     if (m_requestRole[PermissionsRole]) {
1297         data.insert(sharedValue("permissions"), item.permissionsString());
1298     }
1299
1300     if (m_requestRole[OwnerRole]) {
1301         data.insert(sharedValue("owner"), item.user());
1302     }
1303
1304     if (m_requestRole[GroupRole]) {
1305         data.insert(sharedValue("group"), item.group());
1306     }
1307
1308     if (m_requestRole[DestinationRole]) {
1309         QString destination = item.linkDest();
1310         if (destination.isEmpty()) {
1311             destination = QLatin1String("-");
1312         }
1313         data.insert(sharedValue("destination"), destination);
1314     }
1315
1316     if (m_requestRole[PathRole]) {
1317         QString path;
1318         if (item.url().protocol() == QLatin1String("trash")) {
1319             path = item.entry().stringValue(KIO::UDSEntry::UDS_EXTRA);
1320         } else {
1321             // For performance reasons cache the home-path in a static QString
1322             // (see QDir::homePath() for more details)
1323             static QString homePath;
1324             if (homePath.isEmpty()) {
1325                 homePath = QDir::homePath();
1326             }
1327
1328             path = item.localPath();
1329             if (path.startsWith(homePath)) {
1330                 path.replace(0, homePath.length(), QLatin1Char('~'));
1331             }
1332         }
1333
1334         const int index = path.lastIndexOf(item.text());
1335         path = path.mid(0, index - 1);
1336         data.insert(sharedValue("path"), path);
1337     }
1338
1339     if (m_requestRole[IsExpandableRole]) {
1340         data.insert(sharedValue("isExpandable"), item.isDir() && item.url() == item.targetUrl());
1341     }
1342
1343     if (m_requestRole[ExpandedParentsCountRole]) {
1344         int level = 0;
1345         if (parent) {
1346             level = parent->values["expandedParentsCount"].toInt() + 1;
1347         }
1348
1349         data.insert(sharedValue("expandedParentsCount"), level);
1350     }
1351
1352     if (item.isMimeTypeKnown()) {
1353         data.insert(sharedValue("iconName"), item.iconName());
1354
1355         if (m_requestRole[TypeRole]) {
1356             data.insert(sharedValue("type"), item.mimeComment());
1357         }
1358     }
1359
1360     return data;
1361 }
1362
1363 bool KFileItemModel::lessThan(const ItemData* a, const ItemData* b) const
1364 {
1365     int result = 0;
1366
1367     if (a->parent != b->parent) {
1368         const int expansionLevelA = a->values.value("expandedParentsCount").toInt();
1369         const int expansionLevelB = b->values.value("expandedParentsCount").toInt();
1370
1371         // If b has a higher expansion level than a, check if a is a parent
1372         // of b, and make sure that both expansion levels are equal otherwise.
1373         for (int i = expansionLevelB; i > expansionLevelA; --i) {
1374             if (b->parent == a) {
1375                 return true;
1376             }
1377             b = b->parent;
1378         }
1379
1380         // If a has a higher expansion level than a, check if b is a parent
1381         // of a, and make sure that both expansion levels are equal otherwise.
1382         for (int i = expansionLevelA; i > expansionLevelB; --i) {
1383             if (a->parent == b) {
1384                 return false;
1385             }
1386             a = a->parent;
1387         }
1388
1389         Q_ASSERT(a->values.value("expandedParentsCount").toInt() == b->values.value("expandedParentsCount").toInt());
1390
1391         // Compare the last parents of a and b which are different.
1392         while (a->parent != b->parent) {
1393             a = a->parent;
1394             b = b->parent;
1395         }
1396     }
1397
1398     if (m_sortDirsFirst || m_sortRole == SizeRole) {
1399         const bool isDirA = a->item.isDir();
1400         const bool isDirB = b->item.isDir();
1401         if (isDirA && !isDirB) {
1402             return true;
1403         } else if (!isDirA && isDirB) {
1404             return false;
1405         }
1406     }
1407
1408     result = sortRoleCompare(a, b);
1409
1410     return (sortOrder() == Qt::AscendingOrder) ? result < 0 : result > 0;
1411 }
1412
1413 /**
1414  * Helper class for KFileItemModel::sort().
1415  */
1416 class KFileItemModelLessThan
1417 {
1418 public:
1419     KFileItemModelLessThan(const KFileItemModel* model) :
1420         m_model(model)
1421     {
1422     }
1423
1424     bool operator()(const KFileItemModel::ItemData* a, const KFileItemModel::ItemData* b) const
1425     {
1426         return m_model->lessThan(a, b);
1427     }
1428
1429 private:
1430     const KFileItemModel* m_model;
1431 };
1432
1433 void KFileItemModel::sort(QList<KFileItemModel::ItemData*>::iterator begin,
1434                           QList<KFileItemModel::ItemData*>::iterator end) const
1435 {
1436     KFileItemModelLessThan lessThan(this);
1437
1438     if (m_sortRole == NameRole) {
1439         // Sorting by name can be expensive, in particular if natural sorting is
1440         // enabled. Use all CPU cores to speed up the sorting process.
1441         static const int numberOfThreads = QThread::idealThreadCount();
1442         parallelMergeSort(begin, end, lessThan, numberOfThreads);
1443     } else {
1444         // Sorting by other roles is quite fast. Use only one thread to prevent
1445         // problems caused by non-reentrant comparison functions, see
1446         // https://bugs.kde.org/show_bug.cgi?id=312679
1447         mergeSort(begin, end, lessThan);
1448     }
1449 }
1450
1451 int KFileItemModel::sortRoleCompare(const ItemData* a, const ItemData* b) const
1452 {
1453     const KFileItem& itemA = a->item;
1454     const KFileItem& itemB = b->item;
1455
1456     int result = 0;
1457
1458     switch (m_sortRole) {
1459     case NameRole:
1460         // The name role is handled as default fallback after the switch
1461         break;
1462
1463     case SizeRole: {
1464         if (itemA.isDir()) {
1465             // See "if (m_sortFoldersFirst || m_sortRole == SizeRole)" in KFileItemModel::lessThan():
1466             Q_ASSERT(itemB.isDir());
1467
1468             const QVariant valueA = a->values.value("size");
1469             const QVariant valueB = b->values.value("size");
1470             if (valueA.isNull() && valueB.isNull()) {
1471                 result = 0;
1472             } else if (valueA.isNull()) {
1473                 result = -1;
1474             } else if (valueB.isNull()) {
1475                 result = +1;
1476             } else {
1477                 result = valueA.toInt() - valueB.toInt();
1478             }
1479         } else {
1480             // See "if (m_sortFoldersFirst || m_sortRole == SizeRole)" in KFileItemModel::lessThan():
1481             Q_ASSERT(!itemB.isDir());
1482             const KIO::filesize_t sizeA = itemA.size();
1483             const KIO::filesize_t sizeB = itemB.size();
1484             if (sizeA > sizeB) {
1485                 result = +1;
1486             } else if (sizeA < sizeB) {
1487                 result = -1;
1488             } else {
1489                 result = 0;
1490             }
1491         }
1492         break;
1493     }
1494
1495     case DateRole: {
1496         const KDateTime dateTimeA = itemA.time(KFileItem::ModificationTime);
1497         const KDateTime dateTimeB = itemB.time(KFileItem::ModificationTime);
1498         if (dateTimeA < dateTimeB) {
1499             result = -1;
1500         } else if (dateTimeA > dateTimeB) {
1501             result = +1;
1502         }
1503         break;
1504     }
1505
1506     case RatingRole: {
1507         result = a->values.value("rating").toInt() - b->values.value("rating").toInt();
1508         break;
1509     }
1510
1511     case ImageSizeRole: {
1512         // Alway use a natural comparing to interpret the numbers of a string like
1513         // "1600 x 1200" for having a correct sorting.
1514         result = KStringHandler::naturalCompare(a->values.value("imageSize").toString(),
1515                                                 b->values.value("imageSize").toString(),
1516                                                 Qt::CaseSensitive);
1517         break;
1518     }
1519
1520     default: {
1521         const QByteArray role = roleForType(m_sortRole);
1522         result = QString::compare(a->values.value(role).toString(),
1523                                   b->values.value(role).toString());
1524         break;
1525     }
1526
1527     }
1528
1529     if (result != 0) {
1530         // The current sort role was sufficient to define an order
1531         return result;
1532     }
1533
1534     // Fallback #1: Compare the text of the items
1535     result = stringCompare(itemA.text(), itemB.text());
1536     if (result != 0) {
1537         return result;
1538     }
1539
1540     // Fallback #2: KFileItem::text() may not be unique in case UDS_DISPLAY_NAME is used
1541     result = stringCompare(itemA.name(m_caseSensitivity == Qt::CaseInsensitive),
1542                            itemB.name(m_caseSensitivity == Qt::CaseInsensitive));
1543     if (result != 0) {
1544         return result;
1545     }
1546
1547     // Fallback #3: It must be assured that the sort order is always unique even if two values have been
1548     // equal. In this case a comparison of the URL is done which is unique in all cases
1549     // within KDirLister.
1550     return QString::compare(itemA.url().url(), itemB.url().url(), Qt::CaseSensitive);
1551 }
1552
1553 int KFileItemModel::stringCompare(const QString& a, const QString& b) const
1554 {
1555     // Taken from KDirSortFilterProxyModel (kdelibs/kfile/kdirsortfilterproxymodel.*)
1556     // Copyright (C) 2006 by Peter Penz <peter.penz@gmx.at>
1557     // Copyright (C) 2006 by Dominic Battre <dominic@battre.de>
1558     // Copyright (C) 2006 by Martin Pool <mbp@canonical.com>
1559
1560     if (m_caseSensitivity == Qt::CaseInsensitive) {
1561         const int result = m_naturalSorting ? KStringHandler::naturalCompare(a, b, Qt::CaseInsensitive)
1562                                             : QString::compare(a, b, Qt::CaseInsensitive);
1563         if (result != 0) {
1564             // Only return the result, if the strings are not equal. If they are equal by a case insensitive
1565             // comparison, still a deterministic sort order is required. A case sensitive
1566             // comparison is done as fallback.
1567             return result;
1568         }
1569     }
1570
1571     return m_naturalSorting ? KStringHandler::naturalCompare(a, b, Qt::CaseSensitive)
1572                             : QString::compare(a, b, Qt::CaseSensitive);
1573 }
1574
1575 bool KFileItemModel::useMaximumUpdateInterval() const
1576 {
1577     return !m_dirLister->url().isLocalFile();
1578 }
1579
1580 static bool localeAwareLessThan(const QChar& c1, const QChar& c2)
1581 {
1582     return QString::localeAwareCompare(c1, c2) < 0;
1583 }
1584
1585 QList<QPair<int, QVariant> > KFileItemModel::nameRoleGroups() const
1586 {
1587     Q_ASSERT(!m_itemData.isEmpty());
1588
1589     const int maxIndex = count() - 1;
1590     QList<QPair<int, QVariant> > groups;
1591
1592     QString groupValue;
1593     QChar firstChar;
1594     for (int i = 0; i <= maxIndex; ++i) {
1595         if (isChildItem(i)) {
1596             continue;
1597         }
1598
1599         const QString name = m_itemData.at(i)->values.value("text").toString();
1600
1601         // Use the first character of the name as group indication
1602         QChar newFirstChar = name.at(0).toUpper();
1603         if (newFirstChar == QLatin1Char('~') && name.length() > 1) {
1604             newFirstChar = name.at(1).toUpper();
1605         }
1606
1607         if (firstChar != newFirstChar) {
1608             QString newGroupValue;
1609             if (newFirstChar.isLetter()) {
1610                 // Try to find a matching group in the range 'A' to 'Z'.
1611                 static std::vector<QChar> lettersAtoZ;
1612                 if (lettersAtoZ.empty()) {
1613                     for (char c = 'A'; c <= 'Z'; ++c) {
1614                         lettersAtoZ.push_back(QLatin1Char(c));
1615                     }
1616                 }
1617
1618                 std::vector<QChar>::iterator it = std::lower_bound(lettersAtoZ.begin(), lettersAtoZ.end(), newFirstChar, localeAwareLessThan);
1619                 if (it != lettersAtoZ.end()) {
1620                     if (localeAwareLessThan(newFirstChar, *it) && it != lettersAtoZ.begin()) {
1621                         // newFirstChar belongs to the group preceding *it.
1622                         // Example: for an umlaut 'A' in the German locale, *it would be 'B' now.
1623                         --it;
1624                     }
1625                     newGroupValue = *it;
1626                 } else {
1627                     newGroupValue = newFirstChar;
1628                 }
1629             } else if (newFirstChar >= QLatin1Char('0') && newFirstChar <= QLatin1Char('9')) {
1630                 // Apply group '0 - 9' for any name that starts with a digit
1631                 newGroupValue = i18nc("@title:group Groups that start with a digit", "0 - 9");
1632             } else {
1633                 newGroupValue = i18nc("@title:group", "Others");
1634             }
1635
1636             if (newGroupValue != groupValue) {
1637                 groupValue = newGroupValue;
1638                 groups.append(QPair<int, QVariant>(i, newGroupValue));
1639             }
1640
1641             firstChar = newFirstChar;
1642         }
1643     }
1644     return groups;
1645 }
1646
1647 QList<QPair<int, QVariant> > KFileItemModel::sizeRoleGroups() const
1648 {
1649     Q_ASSERT(!m_itemData.isEmpty());
1650
1651     const int maxIndex = count() - 1;
1652     QList<QPair<int, QVariant> > groups;
1653
1654     QString groupValue;
1655     for (int i = 0; i <= maxIndex; ++i) {
1656         if (isChildItem(i)) {
1657             continue;
1658         }
1659
1660         const KFileItem& item = m_itemData.at(i)->item;
1661         const KIO::filesize_t fileSize = !item.isNull() ? item.size() : ~0U;
1662         QString newGroupValue;
1663         if (!item.isNull() && item.isDir()) {
1664             newGroupValue = i18nc("@title:group Size", "Folders");
1665         } else if (fileSize < 5 * 1024 * 1024) {
1666             newGroupValue = i18nc("@title:group Size", "Small");
1667         } else if (fileSize < 10 * 1024 * 1024) {
1668             newGroupValue = i18nc("@title:group Size", "Medium");
1669         } else {
1670             newGroupValue = i18nc("@title:group Size", "Big");
1671         }
1672
1673         if (newGroupValue != groupValue) {
1674             groupValue = newGroupValue;
1675             groups.append(QPair<int, QVariant>(i, newGroupValue));
1676         }
1677     }
1678
1679     return groups;
1680 }
1681
1682 QList<QPair<int, QVariant> > KFileItemModel::dateRoleGroups() const
1683 {
1684     Q_ASSERT(!m_itemData.isEmpty());
1685
1686     const int maxIndex = count() - 1;
1687     QList<QPair<int, QVariant> > groups;
1688
1689     const QDate currentDate = KDateTime::currentLocalDateTime().date();
1690
1691     QDate previousModifiedDate;
1692     QString groupValue;
1693     for (int i = 0; i <= maxIndex; ++i) {
1694         if (isChildItem(i)) {
1695             continue;
1696         }
1697
1698         const KDateTime modifiedTime = m_itemData.at(i)->item.time(KFileItem::ModificationTime);
1699         const QDate modifiedDate = modifiedTime.date();
1700         if (modifiedDate == previousModifiedDate) {
1701             // The current item is in the same group as the previous item
1702             continue;
1703         }
1704         previousModifiedDate = modifiedDate;
1705
1706         const int daysDistance = modifiedDate.daysTo(currentDate);
1707
1708         QString newGroupValue;
1709         if (currentDate.year() == modifiedDate.year() && currentDate.month() == modifiedDate.month()) {
1710             switch (daysDistance / 7) {
1711             case 0:
1712                 switch (daysDistance) {
1713                 case 0:  newGroupValue = i18nc("@title:group Date", "Today"); break;
1714                 case 1:  newGroupValue = i18nc("@title:group Date", "Yesterday"); break;
1715                 default: newGroupValue = modifiedTime.toString(i18nc("@title:group The week day name: %A", "%A"));
1716                 }
1717                 break;
1718             case 1:
1719                 newGroupValue = i18nc("@title:group Date", "One Week Ago");
1720                 break;
1721             case 2:
1722                 newGroupValue = i18nc("@title:group Date", "Two Weeks Ago");
1723                 break;
1724             case 3:
1725                 newGroupValue = i18nc("@title:group Date", "Three Weeks Ago");
1726                 break;
1727             case 4:
1728             case 5:
1729                 newGroupValue = i18nc("@title:group Date", "Earlier this Month");
1730                 break;
1731             default:
1732                 Q_ASSERT(false);
1733             }
1734         } else {
1735             const QDate lastMonthDate = currentDate.addMonths(-1);
1736             if  (lastMonthDate.year() == modifiedDate.year() && lastMonthDate.month() == modifiedDate.month()) {
1737                 if (daysDistance == 1) {
1738                     newGroupValue = modifiedTime.toString(i18nc("@title:group Date: %B is full month name in current locale, and %Y is full year number", "Yesterday (%B, %Y)"));
1739                 } else if (daysDistance <= 7) {
1740                     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)"));
1741                 } else if (daysDistance <= 7 * 2) {
1742                     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)"));
1743                 } else if (daysDistance <= 7 * 3) {
1744                     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)"));
1745                 } else if (daysDistance <= 7 * 4) {
1746                     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)"));
1747                 } else {
1748                     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"));
1749                 }
1750             } else {
1751                 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"));
1752             }
1753         }
1754
1755         if (newGroupValue != groupValue) {
1756             groupValue = newGroupValue;
1757             groups.append(QPair<int, QVariant>(i, newGroupValue));
1758         }
1759     }
1760
1761     return groups;
1762 }
1763
1764 QList<QPair<int, QVariant> > KFileItemModel::permissionRoleGroups() const
1765 {
1766     Q_ASSERT(!m_itemData.isEmpty());
1767
1768     const int maxIndex = count() - 1;
1769     QList<QPair<int, QVariant> > groups;
1770
1771     QString permissionsString;
1772     QString groupValue;
1773     for (int i = 0; i <= maxIndex; ++i) {
1774         if (isChildItem(i)) {
1775             continue;
1776         }
1777
1778         const ItemData* itemData = m_itemData.at(i);
1779         const QString newPermissionsString = itemData->values.value("permissions").toString();
1780         if (newPermissionsString == permissionsString) {
1781             continue;
1782         }
1783         permissionsString = newPermissionsString;
1784
1785         const QFileInfo info(itemData->item.url().pathOrUrl());
1786
1787         // Set user string
1788         QString user;
1789         if (info.permission(QFile::ReadUser)) {
1790             user = i18nc("@item:intext Access permission, concatenated", "Read, ");
1791         }
1792         if (info.permission(QFile::WriteUser)) {
1793             user += i18nc("@item:intext Access permission, concatenated", "Write, ");
1794         }
1795         if (info.permission(QFile::ExeUser)) {
1796             user += i18nc("@item:intext Access permission, concatenated", "Execute, ");
1797         }
1798         user = user.isEmpty() ? i18nc("@item:intext Access permission, concatenated", "Forbidden") : user.mid(0, user.count() - 2);
1799
1800         // Set group string
1801         QString group;
1802         if (info.permission(QFile::ReadGroup)) {
1803             group = i18nc("@item:intext Access permission, concatenated", "Read, ");
1804         }
1805         if (info.permission(QFile::WriteGroup)) {
1806             group += i18nc("@item:intext Access permission, concatenated", "Write, ");
1807         }
1808         if (info.permission(QFile::ExeGroup)) {
1809             group += i18nc("@item:intext Access permission, concatenated", "Execute, ");
1810         }
1811         group = group.isEmpty() ? i18nc("@item:intext Access permission, concatenated", "Forbidden") : group.mid(0, group.count() - 2);
1812
1813         // Set others string
1814         QString others;
1815         if (info.permission(QFile::ReadOther)) {
1816             others = i18nc("@item:intext Access permission, concatenated", "Read, ");
1817         }
1818         if (info.permission(QFile::WriteOther)) {
1819             others += i18nc("@item:intext Access permission, concatenated", "Write, ");
1820         }
1821         if (info.permission(QFile::ExeOther)) {
1822             others += i18nc("@item:intext Access permission, concatenated", "Execute, ");
1823         }
1824         others = others.isEmpty() ? i18nc("@item:intext Access permission, concatenated", "Forbidden") : others.mid(0, others.count() - 2);
1825
1826         const QString newGroupValue = i18nc("@title:group Files and folders by permissions", "User: %1 | Group: %2 | Others: %3", user, group, others);
1827         if (newGroupValue != groupValue) {
1828             groupValue = newGroupValue;
1829             groups.append(QPair<int, QVariant>(i, newGroupValue));
1830         }
1831     }
1832
1833     return groups;
1834 }
1835
1836 QList<QPair<int, QVariant> > KFileItemModel::ratingRoleGroups() const
1837 {
1838     Q_ASSERT(!m_itemData.isEmpty());
1839
1840     const int maxIndex = count() - 1;
1841     QList<QPair<int, QVariant> > groups;
1842
1843     int groupValue = -1;
1844     for (int i = 0; i <= maxIndex; ++i) {
1845         if (isChildItem(i)) {
1846             continue;
1847         }
1848         const int newGroupValue = m_itemData.at(i)->values.value("rating", 0).toInt();
1849         if (newGroupValue != groupValue) {
1850             groupValue = newGroupValue;
1851             groups.append(QPair<int, QVariant>(i, newGroupValue));
1852         }
1853     }
1854
1855     return groups;
1856 }
1857
1858 QList<QPair<int, QVariant> > KFileItemModel::genericStringRoleGroups(const QByteArray& role) const
1859 {
1860     Q_ASSERT(!m_itemData.isEmpty());
1861
1862     const int maxIndex = count() - 1;
1863     QList<QPair<int, QVariant> > groups;
1864
1865     bool isFirstGroupValue = true;
1866     QString groupValue;
1867     for (int i = 0; i <= maxIndex; ++i) {
1868         if (isChildItem(i)) {
1869             continue;
1870         }
1871         const QString newGroupValue = m_itemData.at(i)->values.value(role).toString();
1872         if (newGroupValue != groupValue || isFirstGroupValue) {
1873             groupValue = newGroupValue;
1874             groups.append(QPair<int, QVariant>(i, newGroupValue));
1875             isFirstGroupValue = false;
1876         }
1877     }
1878
1879     return groups;
1880 }
1881
1882 KFileItemList KFileItemModel::childItems(const KFileItem& item) const
1883 {
1884     KFileItemList items;
1885
1886     int index = m_items.value(item.url(), -1);
1887     if (index >= 0) {
1888         const int parentLevel = m_itemData.at(index)->values.value("expandedParentsCount").toInt();
1889         ++index;
1890         while (index < m_itemData.count() && m_itemData.at(index)->values.value("expandedParentsCount").toInt() > parentLevel) {
1891             items.append(m_itemData.at(index)->item);
1892             ++index;
1893         }
1894     }
1895
1896     return items;
1897 }
1898
1899 void KFileItemModel::emitSortProgress(int resolvedCount)
1900 {
1901     // Be tolerant against a resolvedCount with a wrong range.
1902     // Although there should not be a case where KFileItemModelRolesUpdater
1903     // (= caller) provides a wrong range, it is important to emit
1904     // a useful progress information even if there is an unexpected
1905     // implementation issue.
1906
1907     const int itemCount = count();
1908     if (resolvedCount >= itemCount) {
1909         m_sortingProgressPercent = -1;
1910         if (m_resortAllItemsTimer->isActive()) {
1911             m_resortAllItemsTimer->stop();
1912             resortAllItems();
1913         }
1914
1915         emit directorySortingProgress(100);
1916     } else if (itemCount > 0) {
1917         resolvedCount = qBound(0, resolvedCount, itemCount);
1918
1919         const int progress = resolvedCount * 100 / itemCount;
1920         if (m_sortingProgressPercent != progress) {
1921             m_sortingProgressPercent = progress;
1922             emit directorySortingProgress(progress);
1923         }
1924     }
1925 }
1926
1927 const KFileItemModel::RoleInfoMap* KFileItemModel::rolesInfoMap(int& count)
1928 {
1929     static const RoleInfoMap rolesInfoMap[] = {
1930     //  | role         | roleType       | role translation                                | group translation           | requires Nepomuk | requires indexer
1931         { 0,             NoRole,          0, 0,                                             0, 0,                                     false, false },
1932         { "text",        NameRole,        I18N_NOOP2_NOSTRIP("@label", "Name"),             0, 0,                                     false, false },
1933         { "size",        SizeRole,        I18N_NOOP2_NOSTRIP("@label", "Size"),             0, 0,                                     false, false },
1934         { "date",        DateRole,        I18N_NOOP2_NOSTRIP("@label", "Date"),             0, 0,                                     false, false },
1935         { "type",        TypeRole,        I18N_NOOP2_NOSTRIP("@label", "Type"),             0, 0,                                     false, false },
1936         { "rating",      RatingRole,      I18N_NOOP2_NOSTRIP("@label", "Rating"),           0, 0,                                     true,  false },
1937         { "tags",        TagsRole,        I18N_NOOP2_NOSTRIP("@label", "Tags"),             0, 0,                                     true,  false },
1938         { "comment",     CommentRole,     I18N_NOOP2_NOSTRIP("@label", "Comment"),          0, 0,                                     true,  false },
1939         { "wordCount",   WordCountRole,   I18N_NOOP2_NOSTRIP("@label", "Word Count"),       I18N_NOOP2_NOSTRIP("@label", "Document"), true,  true  },
1940         { "lineCount",   LineCountRole,   I18N_NOOP2_NOSTRIP("@label", "Line Count"),       I18N_NOOP2_NOSTRIP("@label", "Document"), true,  true  },
1941         { "imageSize",   ImageSizeRole,   I18N_NOOP2_NOSTRIP("@label", "Image Size"),       I18N_NOOP2_NOSTRIP("@label", "Image"),    true,  true  },
1942         { "orientation", OrientationRole, I18N_NOOP2_NOSTRIP("@label", "Orientation"),      I18N_NOOP2_NOSTRIP("@label", "Image"),    true,  true  },
1943         { "artist",      ArtistRole,      I18N_NOOP2_NOSTRIP("@label", "Artist"),           I18N_NOOP2_NOSTRIP("@label", "Audio"),    true,  true  },
1944         { "album",       AlbumRole,       I18N_NOOP2_NOSTRIP("@label", "Album"),            I18N_NOOP2_NOSTRIP("@label", "Audio"),    true,  true  },
1945         { "duration",    DurationRole,    I18N_NOOP2_NOSTRIP("@label", "Duration"),         I18N_NOOP2_NOSTRIP("@label", "Audio"),    true,  true  },
1946         { "track",       TrackRole,       I18N_NOOP2_NOSTRIP("@label", "Track"),            I18N_NOOP2_NOSTRIP("@label", "Audio"),    true,  true  },
1947         { "path",        PathRole,        I18N_NOOP2_NOSTRIP("@label", "Path"),             I18N_NOOP2_NOSTRIP("@label", "Other"),    false, false },
1948         { "destination", DestinationRole, I18N_NOOP2_NOSTRIP("@label", "Link Destination"), I18N_NOOP2_NOSTRIP("@label", "Other"),    false, false },
1949         { "copiedFrom",  CopiedFromRole,  I18N_NOOP2_NOSTRIP("@label", "Copied From"),      I18N_NOOP2_NOSTRIP("@label", "Other"),    true,  false },
1950         { "permissions", PermissionsRole, I18N_NOOP2_NOSTRIP("@label", "Permissions"),      I18N_NOOP2_NOSTRIP("@label", "Other"),    false, false },
1951         { "owner",       OwnerRole,       I18N_NOOP2_NOSTRIP("@label", "Owner"),            I18N_NOOP2_NOSTRIP("@label", "Other"),    false, false },
1952         { "group",       GroupRole,       I18N_NOOP2_NOSTRIP("@label", "User Group"),       I18N_NOOP2_NOSTRIP("@label", "Other"),    false, false },
1953     };
1954
1955     count = sizeof(rolesInfoMap) / sizeof(RoleInfoMap);
1956     return rolesInfoMap;
1957 }
1958
1959 void KFileItemModel::determineMimeTypes(const KFileItemList& items, int timeout)
1960 {
1961     QElapsedTimer timer;
1962     timer.start();
1963     foreach (const KFileItem& item, items) { // krazy:exclude=foreach
1964         item.determineMimeType();
1965         if (timer.elapsed() > timeout) {
1966             // Don't block the user interface, let the remaining items
1967             // be resolved asynchronously.
1968             return;
1969         }
1970     }
1971 }
1972
1973 QByteArray KFileItemModel::sharedValue(const QByteArray& value)
1974 {
1975     static QSet<QByteArray> pool;
1976     const QSet<QByteArray>::const_iterator it = pool.constFind(value);
1977
1978     if (it != pool.constEnd()) {
1979         return *it;
1980     } else {
1981         pool.insert(value);
1982         return value;
1983     }
1984 }
1985
1986 bool KFileItemModel::isConsistent() const
1987 {
1988     if (m_items.count() != m_itemData.count()) {
1989         return false;
1990     }
1991
1992     for (int i = 0; i < count(); ++i) {
1993         // Check if m_items and m_itemData are consistent.
1994         const KFileItem item = fileItem(i);
1995         if (item.isNull()) {
1996             qWarning() << "Item" << i << "is null";
1997             return false;
1998         }
1999
2000         const int itemIndex = index(item);
2001         if (itemIndex != i) {
2002             qWarning() << "Item" << i << "has a wrong index:" << itemIndex;
2003             return false;
2004         }
2005
2006         // Check if the items are sorted correctly.
2007         if (i > 0 && !lessThan(m_itemData.at(i - 1), m_itemData.at(i))) {
2008             qWarning() << "The order of items" << i - 1 << "and" << i << "is wrong:"
2009                 << fileItem(i - 1) << fileItem(i);
2010             return false;
2011         }
2012
2013         // Check if all parent-child relationships are consistent.
2014         const ItemData* data = m_itemData.at(i);
2015         const ItemData* parent = data->parent;
2016         if (parent) {
2017             if (data->values.value("expandedParentsCount").toInt() != parent->values.value("expandedParentsCount").toInt() + 1) {
2018                 qWarning() << "expandedParentsCount is inconsistent for parent" << parent->item << "and child" << data->item;
2019                 return false;
2020             }
2021
2022             const int parentIndex = index(parent->item);
2023             if (parentIndex >= i) {
2024                 qWarning() << "Index" << parentIndex << "of parent" << parent->item << "is not smaller than index" << i << "of child" << data->item;
2025                 return false;
2026             }
2027         }
2028     }
2029
2030     return true;
2031 }
2032
2033 #include "kfileitemmodel.moc"