src/kitemviews/kfileitemmodel.cpp

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