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