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     Q_ASSERT(!items.isEmpty());
 678
 679     if (m_requestRole[ExpansionLevelRole] && m_rootExpansionLevel >= 0) {
 680         const KFileItem item = items.first();
 681
 682         // If the expanding of items is enabled, the call
 683         // dirLister->openUrl(url, KDirLister::Keep) in KFileItemModel::setExpanded()
 684         // might result in emitting the same items twice due to the Keep-parameter.
 685         // This case happens if an item gets expanded, collapsed and expanded again
 686         // before the items could be loaded for the first expansion.
 687         const int index = m_items.value(item.url(), -1);
 688         if (index >= 0) {
 689             // The items are already part of the model.
 690             return;
 691         }
 692
 693         // KDirLister keeps the children of items that got expanded once even if
 694         // they got collapsed again with KFileItemModel::setExpanded(false). So it must be
 695         // checked whether the parent for new items is still expanded.
 696         KUrl parentUrl = item.url().upUrl();
 697         parentUrl.adjustPath(KUrl::RemoveTrailingSlash);
 698         const int parentIndex = m_items.value(parentUrl, -1);
 699         if (parentIndex >= 0 && !m_itemData[parentIndex]->values.value("isExpanded").toBool()) {
 700             // The parent is not expanded.
 701             return;
 702         }
 703     }
 704
 705     if (m_filter.pattern().isEmpty()) {
 706         m_pendingItemsToInsert.append(items);
 707     } else {
 708         // The name-filter is active. Hide filtered items
 709         // before inserting them into the model and remember
 710         // the filtered items in m_filteredItems.
 711         KFileItemList filteredItems;
 712         foreach (const KFileItem& item, items) {
 713             if (m_filter.matches(item)) {
 714                 filteredItems.append(item);
 715             } else {
 716                 m_filteredItems.insert(item);
 717             }
 718         }
 719
 720         m_pendingItemsToInsert.append(filteredItems);
 721     }
 722
 723     if (useMaximumUpdateInterval() && !m_maximumUpdateIntervalTimer->isActive()) {
 724         // Assure that items get dispatched if no completed() or canceled() signal is
 725         // emitted during the maximum update interval.
 726         m_maximumUpdateIntervalTimer->start();
 727     }
 728 }
 729
 730 void KFileItemModel::slotItemsDeleted(const KFileItemList& items)
 731 {
 732     dispatchPendingItemsToInsert();
 733
 734     KFileItemList itemsToRemove = items;
 735     if (m_requestRole[ExpansionLevelRole] && m_rootExpansionLevel >= 0) {
 736         // Assure that removing a parent item also results in removing all children
 737         foreach (const KFileItem& item, items) {
 738             itemsToRemove.append(childItems(item));
 739         }
 740     }
 741
 742     if (!m_filteredItems.isEmpty()) {
 743         foreach (const KFileItem& item, itemsToRemove) {
 744             m_filteredItems.remove(item);
 745         }
 746     }
 747
 748     removeItems(itemsToRemove);
 749 }
 750
 751 void KFileItemModel::slotRefreshItems(const QList<QPair<KFileItem, KFileItem> >& items)
 752 {
 753     Q_ASSERT(!items.isEmpty());
 754 #ifdef KFILEITEMMODEL_DEBUG
 755     kDebug() << "Refreshing" << items.count() << "items";
 756 #endif
 757
 758     m_groups.clear();
 759
 760     // Get the indexes of all items that have been refreshed
 761     QList<int> indexes;
 762     indexes.reserve(items.count());
 763
 764     QListIterator<QPair<KFileItem, KFileItem> > it(items);
 765     while (it.hasNext()) {
 766         const QPair<KFileItem, KFileItem>& itemPair = it.next();
 767         const KFileItem& oldItem = itemPair.first;
 768         const KFileItem& newItem = itemPair.second;
 769         const int index = m_items.value(oldItem.url(), -1);
 770         if (index >= 0) {
 771             m_itemData[index]->item = newItem;
 772             m_itemData[index]->values = retrieveData(newItem);
 773             m_items.remove(oldItem.url());
 774             m_items.insert(newItem.url(), index);
 775             indexes.append(index);
 776         }
 777     }
 778
 779     // If the changed items have been created recently, they might not be in m_items yet.
 780     // In that case, the list 'indexes' might be empty.
 781     if (indexes.isEmpty()) {
 782         return;
 783     }
 784
 785     // Extract the item-ranges out of the changed indexes
 786     qSort(indexes);
 787
 788     KItemRangeList itemRangeList;
 789     int previousIndex = indexes.at(0);
 790     int rangeIndex = previousIndex;
 791     int rangeCount = 1;
 792
 793     const int maxIndex = indexes.count() - 1;
 794     for (int i = 1; i <= maxIndex; ++i) {
 795         const int currentIndex = indexes.at(i);
 796         if (currentIndex == previousIndex + 1) {
 797             ++rangeCount;
 798         } else {
 799             itemRangeList.append(KItemRange(rangeIndex, rangeCount));
 800
 801             rangeIndex = currentIndex;
 802             rangeCount = 1;
 803         }
 804         previousIndex = currentIndex;
 805     }
 806
 807     if (rangeCount > 0) {
 808         itemRangeList.append(KItemRange(rangeIndex, rangeCount));
 809     }
 810
 811     emit itemsChanged(itemRangeList, m_roles);
 812
 813     resortAllItems();
 814 }
 815
 816 void KFileItemModel::slotClear()
 817 {
 818 #ifdef KFILEITEMMODEL_DEBUG
 819     kDebug() << "Clearing all items";
 820 #endif
 821
 822     m_filteredItems.clear();
 823     m_groups.clear();
 824
 825     m_minimumUpdateIntervalTimer->stop();
 826     m_maximumUpdateIntervalTimer->stop();
 827     m_resortAllItemsTimer->stop();
 828     m_pendingItemsToInsert.clear();
 829
 830     m_rootExpansionLevel = UninitializedRootExpansionLevel;
 831
 832     const int removedCount = m_itemData.count();
 833     if (removedCount > 0) {
 834         qDeleteAll(m_itemData);
 835         m_itemData.clear();
 836         m_items.clear();
 837         emit itemsRemoved(KItemRangeList() << KItemRange(0, removedCount));
 838     }
 839
 840     m_expandedUrls.clear();
 841 }
 842
 843 void KFileItemModel::slotClear(const KUrl& url)
 844 {
 845     Q_UNUSED(url);
 846 }
 847
 848 void KFileItemModel::dispatchPendingItemsToInsert()
 849 {
 850     if (!m_pendingItemsToInsert.isEmpty()) {
 851         insertItems(m_pendingItemsToInsert);
 852         m_pendingItemsToInsert.clear();
 853     }
 854
 855     if (m_pendingEmitLoadingCompleted) {
 856         emit loadingCompleted();
 857     }
 858 }
 859
 860 void KFileItemModel::insertItems(const KFileItemList& items)
 861 {
 862     if (items.isEmpty()) {
 863         return;
 864     }
 865
 866 #ifdef KFILEITEMMODEL_DEBUG
 867     QElapsedTimer timer;
 868     timer.start();
 869     kDebug() << "===========================================================";
 870     kDebug() << "Inserting" << items.count() << "items";
 871 #endif
 872
 873     m_groups.clear();
 874
 875     QList<ItemData*> sortedItems = createItemDataList(items);
 876     sort(sortedItems.begin(), sortedItems.end());
 877
 878 #ifdef KFILEITEMMODEL_DEBUG
 879     kDebug() << "[TIME] Sorting:" << timer.elapsed();
 880 #endif
 881
 882     KItemRangeList itemRanges;
 883     int targetIndex = 0;
 884     int sourceIndex = 0;
 885     int insertedAtIndex = -1;        // Index for the current item-range
 886     int insertedCount = 0;           // Count for the current item-range
 887     int previouslyInsertedCount = 0; // Sum of previously inserted items for all ranges
 888     while (sourceIndex < sortedItems.count()) {
 889         // Find target index from m_items to insert the current item
 890         // in a sorted order
 891         const int previousTargetIndex = targetIndex;
 892         while (targetIndex < m_itemData.count()) {
 893             if (!lessThan(m_itemData.at(targetIndex), sortedItems.at(sourceIndex))) {
 894                 break;
 895             }
 896             ++targetIndex;
 897         }
 898
 899         if (targetIndex - previousTargetIndex > 0 && insertedAtIndex >= 0) {
 900             itemRanges << KItemRange(insertedAtIndex, insertedCount);
 901             previouslyInsertedCount += insertedCount;
 902             insertedAtIndex = targetIndex - previouslyInsertedCount;
 903             insertedCount = 0;
 904         }
 905
 906         // Insert item at the position targetIndex by transfering
 907         // the ownership of the item-data from sortedItems to m_itemData.
 908         // m_items will be inserted after the loop (see comment below)
 909         m_itemData.insert(targetIndex, sortedItems.at(sourceIndex));
 910         ++insertedCount;
 911
 912         if (insertedAtIndex < 0) {
 913             insertedAtIndex = targetIndex;
 914             Q_ASSERT(previouslyInsertedCount == 0);
 915         }
 916         ++targetIndex;
 917         ++sourceIndex;
 918     }
 919
 920     // The indexes of all m_items must be adjusted, not only the index
 921     // of the new items
 922     const int itemDataCount = m_itemData.count();
 923     for (int i = 0; i < itemDataCount; ++i) {
 924         m_items.insert(m_itemData.at(i)->item.url(), i);
 925     }
 926
 927     itemRanges << KItemRange(insertedAtIndex, insertedCount);
 928     emit itemsInserted(itemRanges);
 929
 930 #ifdef KFILEITEMMODEL_DEBUG
 931     kDebug() << "[TIME] Inserting of" << items.count() << "items:" << timer.elapsed();
 932 #endif
 933 }
 934
 935 void KFileItemModel::removeItems(const KFileItemList& items)
 936 {
 937     if (items.isEmpty()) {
 938         return;
 939     }
 940
 941 #ifdef KFILEITEMMODEL_DEBUG
 942     kDebug() << "Removing " << items.count() << "items";
 943 #endif
 944
 945     m_groups.clear();
 946
 947     QList<ItemData*> sortedItems;
 948     sortedItems.reserve(items.count());
 949     foreach (const KFileItem& item, items) {
 950         const int index = m_items.value(item.url(), -1);
 951         if (index >= 0) {
 952             sortedItems.append(m_itemData.at(index));
 953         }
 954     }
 955     sort(sortedItems.begin(), sortedItems.end());
 956
 957     QList<int> indexesToRemove;
 958     indexesToRemove.reserve(items.count());
 959
 960     // Calculate the item ranges that will get deleted
 961     KItemRangeList itemRanges;
 962     int removedAtIndex = -1;
 963     int removedCount = 0;
 964     int targetIndex = 0;
 965     foreach (const ItemData* itemData, sortedItems) {
 966         const KFileItem& itemToRemove = itemData->item;
 967
 968         const int previousTargetIndex = targetIndex;
 969         while (targetIndex < m_itemData.count()) {
 970             if (m_itemData.at(targetIndex)->item.url() == itemToRemove.url()) {
 971                 break;
 972             }
 973             ++targetIndex;
 974         }
 975         if (targetIndex >= m_itemData.count()) {
 976             kWarning() << "Item that should be deleted has not been found!";
 977             return;
 978         }
 979
 980         if (targetIndex - previousTargetIndex > 0 && removedAtIndex >= 0) {
 981             itemRanges << KItemRange(removedAtIndex, removedCount);
 982             removedAtIndex = targetIndex;
 983             removedCount = 0;
 984         }
 985
 986         indexesToRemove.append(targetIndex);
 987         if (removedAtIndex < 0) {
 988             removedAtIndex = targetIndex;
 989         }
 990         ++removedCount;
 991         ++targetIndex;
 992     }
 993
 994     // Delete the items
 995     for (int i = indexesToRemove.count() - 1; i >= 0; --i) {
 996         const int indexToRemove = indexesToRemove.at(i);
 997         ItemData* data = m_itemData.at(indexToRemove);
 998
 999         m_items.remove(data->item.url());
1000
1001         delete data;
1002         m_itemData.removeAt(indexToRemove);
1003     }
1004
1005     // The indexes of all m_items must be adjusted, not only the index
1006     // of the removed items
1007     const int itemDataCount = m_itemData.count();
1008     for (int i = 0; i < itemDataCount; ++i) {
1009         m_items.insert(m_itemData.at(i)->item.url(), i);
1010     }
1011
1012     if (count() <= 0) {
1013         m_rootExpansionLevel = UninitializedRootExpansionLevel;
1014     }
1015
1016     itemRanges << KItemRange(removedAtIndex, removedCount);
1017     emit itemsRemoved(itemRanges);
1018 }
1019
1020 QList<KFileItemModel::ItemData*> KFileItemModel::createItemDataList(const KFileItemList& items) const
1021 {
1022     QList<ItemData*> itemDataList;
1023     itemDataList.reserve(items.count());
1024
1025     foreach (const KFileItem& item, items) {
1026         ItemData* itemData = new ItemData();
1027         itemData->item = item;
1028         itemData->values = retrieveData(item);
1029         itemData->parent = 0;
1030
1031         const bool determineParent = m_requestRole[ExpansionLevelRole]
1032                                      && itemData->values["expansionLevel"].toInt() > 0;
1033         if (determineParent) {
1034             KUrl parentUrl = item.url().upUrl();
1035             parentUrl.adjustPath(KUrl::RemoveTrailingSlash);
1036             const int parentIndex = m_items.value(parentUrl, -1);
1037             if (parentIndex >= 0) {
1038                 itemData->parent = m_itemData.at(parentIndex);
1039             } else {
1040                 kWarning() << "Parent item not found for" << item.url();
1041             }
1042         }
1043
1044         itemDataList.append(itemData);
1045     }
1046
1047     return itemDataList;
1048 }
1049
1050 void KFileItemModel::removeExpandedItems()
1051 {
1052     KFileItemList expandedItems;
1053
1054     const int maxIndex = m_itemData.count() - 1;
1055     for (int i = 0; i <= maxIndex; ++i) {
1056         const ItemData* itemData = m_itemData.at(i);
1057         if (itemData->values.value("expansionLevel").toInt() > 0) {
1058             expandedItems.append(itemData->item);
1059         }
1060     }
1061
1062     // The m_rootExpansionLevel may not get reset before all items with
1063     // a bigger expansionLevel have been removed.
1064     Q_ASSERT(m_rootExpansionLevel >= 0);
1065     removeItems(expandedItems);
1066
1067     m_rootExpansionLevel = UninitializedRootExpansionLevel;
1068     m_expandedUrls.clear();
1069 }
1070
1071 void KFileItemModel::resetRoles()
1072 {
1073     for (int i = 0; i < RolesCount; ++i) {
1074         m_requestRole[i] = false;
1075     }
1076 }
1077
1078 KFileItemModel::Role KFileItemModel::roleIndex(const QByteArray& role) const
1079 {
1080     static QHash<QByteArray, Role> rolesHash;
1081     if (rolesHash.isEmpty()) {
1082         rolesHash.insert("name", NameRole);
1083         rolesHash.insert("size", SizeRole);
1084         rolesHash.insert("date", DateRole);
1085         rolesHash.insert("permissions", PermissionsRole);
1086         rolesHash.insert("owner", OwnerRole);
1087         rolesHash.insert("group", GroupRole);
1088         rolesHash.insert("type", TypeRole);
1089         rolesHash.insert("destination", DestinationRole);
1090         rolesHash.insert("path", PathRole);
1091         rolesHash.insert("comment", CommentRole);
1092         rolesHash.insert("tags", TagsRole);
1093         rolesHash.insert("rating", RatingRole);
1094         rolesHash.insert("isDir", IsDirRole);
1095         rolesHash.insert("isExpanded", IsExpandedRole);
1096         rolesHash.insert("expansionLevel", ExpansionLevelRole);
1097     }
1098     return rolesHash.value(role, NoRole);
1099 }
1100
1101 QHash<QByteArray, QVariant> KFileItemModel::retrieveData(const KFileItem& item) const
1102 {
1103     // It is important to insert only roles that are fast to retrieve. E.g.
1104     // KFileItem::iconName() can be very expensive if the MIME-type is unknown
1105     // and hence will be retrieved asynchronously by KFileItemModelRolesUpdater.
1106     QHash<QByteArray, QVariant> data;
1107     data.insert("iconPixmap", QPixmap());
1108     data.insert("url", item.url());
1109
1110     const bool isDir = item.isDir();
1111     if (m_requestRole[IsDirRole]) {
1112         data.insert("isDir", isDir);
1113     }
1114
1115     if (m_requestRole[NameRole]) {
1116         data.insert("name", item.text());
1117     }
1118
1119     if (m_requestRole[SizeRole]) {
1120         if (isDir) {
1121             data.insert("size", QVariant());
1122         } else {
1123             data.insert("size", item.size());
1124         }
1125     }
1126
1127     if (m_requestRole[DateRole]) {
1128         // Don't use KFileItem::timeString() as this is too expensive when
1129         // having several thousands of items. Instead the formatting of the
1130         // date-time will be done on-demand by the view when the date will be shown.
1131         const KDateTime dateTime = item.time(KFileItem::ModificationTime);
1132         data.insert("date", dateTime.dateTime());
1133     }
1134
1135     if (m_requestRole[PermissionsRole]) {
1136         data.insert("permissions", item.permissionsString());
1137     }
1138
1139     if (m_requestRole[OwnerRole]) {
1140         data.insert("owner", item.user());
1141     }
1142
1143     if (m_requestRole[GroupRole]) {
1144         data.insert("group", item.group());
1145     }
1146
1147     if (m_requestRole[DestinationRole]) {
1148         QString destination = item.linkDest();
1149         if (destination.isEmpty()) {
1150             destination = i18nc("@item:intable", "No destination");
1151         }
1152         data.insert("destination", destination);
1153     }
1154
1155     if (m_requestRole[PathRole]) {
1156         if (item.url().protocol() == QLatin1String("trash")) {
1157             const KIO::UDSEntry udsEntry = item.entry();
1158             data.insert("path", udsEntry.stringValue(KIO::UDSEntry::UDS_EXTRA));
1159         } else {
1160             data.insert("path", item.localPath());
1161         }
1162     }
1163
1164     if (m_requestRole[IsExpandedRole]) {
1165         data.insert("isExpanded", false);
1166     }
1167
1168     if (m_requestRole[ExpansionLevelRole]) {
1169         if (m_rootExpansionLevel == UninitializedRootExpansionLevel && m_dirLister.data()) {
1170             const KUrl rootUrl = m_dirLister.data()->url();
1171             const QString protocol = rootUrl.protocol();
1172             const bool forceRootExpansionLevel = (protocol == QLatin1String("trash") ||
1173                                                   protocol == QLatin1String("nepomuk") ||
1174                                                   protocol.contains(QLatin1String("search")));
1175             if (forceRootExpansionLevel) {
1176                 m_rootExpansionLevel = ForceRootExpansionLevel;
1177             } else {
1178                 const QString rootDir = rootUrl.directory(KUrl::AppendTrailingSlash);
1179                 m_rootExpansionLevel = rootDir.count('/');
1180                 if (m_rootExpansionLevel == 1) {
1181                     // Special case: The root is already reached and no parent is available
1182                     --m_rootExpansionLevel;
1183                 }
1184             }
1185         }
1186
1187         if (m_rootExpansionLevel == ForceRootExpansionLevel) {
1188             data.insert("expansionLevel", -1);
1189         } else {
1190             const QString dir = item.url().directory(KUrl::AppendTrailingSlash);
1191             const int level = dir.count('/') - m_rootExpansionLevel - 1;
1192             data.insert("expansionLevel", level);
1193         }
1194     }
1195
1196     if (item.isMimeTypeKnown()) {
1197         data.insert("iconName", item.iconName());
1198
1199         if (m_requestRole[TypeRole]) {
1200             data.insert("type", item.mimeComment());
1201         }
1202     }
1203
1204     return data;
1205 }
1206
1207 bool KFileItemModel::lessThan(const ItemData* a, const ItemData* b) const
1208 {
1209     int result = 0;
1210
1211     if (m_rootExpansionLevel >= 0) {
1212         result = expansionLevelsCompare(a, b);
1213         if (result != 0) {
1214             // The items have parents with different expansion levels
1215             return (sortOrder() == Qt::AscendingOrder) ? result < 0 : result > 0;
1216         }
1217     }
1218
1219     if (m_sortFoldersFirst || m_sortRole == SizeRole) {
1220         const bool isDirA = a->item.isDir();
1221         const bool isDirB = b->item.isDir();
1222         if (isDirA && !isDirB) {
1223             return true;
1224         } else if (!isDirA && isDirB) {
1225             return false;
1226         }
1227     }
1228
1229     result = sortRoleCompare(a, b);
1230
1231     return (sortOrder() == Qt::AscendingOrder) ? result < 0 : result > 0;
1232 }
1233
1234 int KFileItemModel::sortRoleCompare(const ItemData* a, const ItemData* b) const
1235 {
1236     const KFileItem& itemA = a->item;
1237     const KFileItem& itemB = b->item;
1238
1239     int result = 0;
1240
1241     switch (m_sortRole) {
1242     case NameRole:
1243         // The name role is handled as default fallback after the switch
1244         break;
1245
1246     case DateRole: {
1247         const KDateTime dateTimeA = itemA.time(KFileItem::ModificationTime);
1248         const KDateTime dateTimeB = itemB.time(KFileItem::ModificationTime);
1249         if (dateTimeA < dateTimeB) {
1250             result = -1;
1251         } else if (dateTimeA > dateTimeB) {
1252             result = +1;
1253         }
1254         break;
1255     }
1256
1257     case SizeRole: {
1258         if (itemA.isDir()) {
1259             Q_ASSERT(itemB.isDir()); // see "if (m_sortFoldersFirst || m_sortRole == SizeRole)" above
1260
1261             const QVariant valueA = a->values.value("size");
1262             const QVariant valueB = b->values.value("size");
1263
1264             if (valueA.isNull()) {
1265                 result = -1;
1266             } else if (valueB.isNull()) {
1267                 result = +1;
1268             } else {
1269                 result = valueA.value<KIO::filesize_t>() - valueB.value<KIO::filesize_t>();
1270             }
1271         } else {
1272             Q_ASSERT(!itemB.isDir()); // see "if (m_sortFoldersFirst || m_sortRole == SizeRole)" above
1273             result = itemA.size() - itemB.size();
1274         }
1275         break;
1276     }
1277
1278     case TypeRole: {
1279         result = QString::compare(a->values.value("type").toString(),
1280                                   b->values.value("type").toString());
1281         break;
1282     }
1283
1284     case CommentRole: {
1285         result = QString::compare(a->values.value("comment").toString(),
1286                                   b->values.value("comment").toString());
1287         break;
1288     }
1289
1290     case TagsRole: {
1291         result = QString::compare(a->values.value("tags").toString(),
1292                                   b->values.value("tags").toString());
1293         break;
1294     }
1295
1296     case RatingRole: {
1297         result = a->values.value("rating").toInt() - b->values.value("rating").toInt();
1298         break;
1299     }
1300
1301     default:
1302         break;
1303     }
1304
1305     if (result != 0) {
1306         // The current sort role was sufficient to define an order
1307         return result;
1308     }
1309
1310     // Fallback #1: Compare the text of the items
1311     result = stringCompare(itemA.text(), itemB.text());
1312     if (result != 0) {
1313         return result;
1314     }
1315
1316     // Fallback #2: KFileItem::text() may not be unique in case UDS_DISPLAY_NAME is used
1317     result = stringCompare(itemA.name(m_caseSensitivity == Qt::CaseInsensitive),
1318                            itemB.name(m_caseSensitivity == Qt::CaseInsensitive));
1319     if (result != 0) {
1320         return result;
1321     }
1322
1323     // Fallback #3: It must be assured that the sort order is always unique even if two values have been
1324     // equal. In this case a comparison of the URL is done which is unique in all cases
1325     // within KDirLister.
1326     return QString::compare(itemA.url().url(), itemB.url().url(), Qt::CaseSensitive);
1327 }
1328
1329 void KFileItemModel::sort(QList<ItemData*>::iterator begin,
1330                           QList<ItemData*>::iterator end)
1331 {
1332     // The implementation is based on qStableSortHelper() from qalgorithms.h
1333     // Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
1334     // In opposite to qStableSort() it allows to use a member-function for the comparison of elements.
1335
1336     const int span = end - begin;
1337     if (span < 2) {
1338         return;
1339     }
1340
1341     const QList<ItemData*>::iterator middle = begin + span / 2;
1342     sort(begin, middle);
1343     sort(middle, end);
1344     merge(begin, middle, end);
1345 }
1346
1347 void KFileItemModel::merge(QList<ItemData*>::iterator begin,
1348                            QList<ItemData*>::iterator pivot,
1349                            QList<ItemData*>::iterator end)
1350 {
1351     // The implementation is based on qMerge() from qalgorithms.h
1352     // Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
1353
1354     const int len1 = pivot - begin;
1355     const int len2 = end - pivot;
1356
1357     if (len1 == 0 || len2 == 0) {
1358         return;
1359     }
1360
1361     if (len1 + len2 == 2) {
1362         if (lessThan(*(begin + 1), *(begin))) {
1363             qSwap(*begin, *(begin + 1));
1364         }
1365         return;
1366     }
1367
1368     QList<ItemData*>::iterator firstCut;
1369     QList<ItemData*>::iterator secondCut;
1370     int len2Half;
1371     if (len1 > len2) {
1372         const int len1Half = len1 / 2;
1373         firstCut = begin + len1Half;
1374         secondCut = lowerBound(pivot, end, *firstCut);
1375         len2Half = secondCut - pivot;
1376     } else {
1377         len2Half = len2 / 2;
1378         secondCut = pivot + len2Half;
1379         firstCut = upperBound(begin, pivot, *secondCut);
1380     }
1381
1382     reverse(firstCut, pivot);
1383     reverse(pivot, secondCut);
1384     reverse(firstCut, secondCut);
1385
1386     const QList<ItemData*>::iterator newPivot = firstCut + len2Half;
1387     merge(begin, firstCut, newPivot);
1388     merge(newPivot, secondCut, end);
1389 }
1390
1391 QList<KFileItemModel::ItemData*>::iterator KFileItemModel::lowerBound(QList<ItemData*>::iterator begin,
1392                                                                       QList<ItemData*>::iterator end,
1393                                                                       const ItemData* value)
1394 {
1395     // The implementation is based on qLowerBound() from qalgorithms.h
1396     // Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
1397
1398     QList<ItemData*>::iterator middle;
1399     int n = int(end - begin);
1400     int half;
1401
1402     while (n > 0) {
1403         half = n >> 1;
1404         middle = begin + half;
1405         if (lessThan(*middle, value)) {
1406             begin = middle + 1;
1407             n -= half + 1;
1408         } else {
1409             n = half;
1410         }
1411     }
1412     return begin;
1413 }
1414
1415 QList<KFileItemModel::ItemData*>::iterator KFileItemModel::upperBound(QList<ItemData*>::iterator begin,
1416                                                                       QList<ItemData*>::iterator end,
1417                                                                       const ItemData* value)
1418 {
1419     // The implementation is based on qUpperBound() from qalgorithms.h
1420     // Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
1421
1422     QList<ItemData*>::iterator middle;
1423     int n = end - begin;
1424     int half;
1425
1426     while (n > 0) {
1427         half = n >> 1;
1428         middle = begin + half;
1429         if (lessThan(value, *middle)) {
1430             n = half;
1431         } else {
1432             begin = middle + 1;
1433             n -= half + 1;
1434         }
1435     }
1436     return begin;
1437 }
1438
1439 void KFileItemModel::reverse(QList<ItemData*>::iterator begin,
1440                              QList<ItemData*>::iterator end)
1441 {
1442     // The implementation is based on qReverse() from qalgorithms.h
1443     // Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
1444
1445     --end;
1446     while (begin < end) {
1447         qSwap(*begin++, *end--);
1448     }
1449 }
1450
1451 int KFileItemModel::stringCompare(const QString& a, const QString& b) const
1452 {
1453     // Taken from KDirSortFilterProxyModel (kdelibs/kfile/kdirsortfilterproxymodel.*)
1454     // Copyright (C) 2006 by Peter Penz <peter.penz@gmx.at>
1455     // Copyright (C) 2006 by Dominic Battre <dominic@battre.de>
1456     // Copyright (C) 2006 by Martin Pool <mbp@canonical.com>
1457
1458     if (m_caseSensitivity == Qt::CaseInsensitive) {
1459         const int result = m_naturalSorting ? KStringHandler::naturalCompare(a, b, Qt::CaseInsensitive)
1460                                             : QString::compare(a, b, Qt::CaseInsensitive);
1461         if (result != 0) {
1462             // Only return the result, if the strings are not equal. If they are equal by a case insensitive
1463             // comparison, still a deterministic sort order is required. A case sensitive
1464             // comparison is done as fallback.
1465             return result;
1466         }
1467     }
1468
1469     return m_naturalSorting ? KStringHandler::naturalCompare(a, b, Qt::CaseSensitive)
1470                             : QString::compare(a, b, Qt::CaseSensitive);
1471 }
1472
1473 int KFileItemModel::expansionLevelsCompare(const ItemData* a, const ItemData* b) const
1474 {
1475     const KUrl urlA = a->item.url();
1476     const KUrl urlB = b->item.url();
1477     if (urlA.directory() == urlB.directory()) {
1478         // Both items have the same directory as parent
1479         return 0;
1480     }
1481
1482     // Check whether one item is the parent of the other item
1483     if (urlA.isParentOf(urlB)) {
1484         return (sortOrder() == Qt::AscendingOrder) ? -1 : +1;
1485     } else if (urlB.isParentOf(urlA)) {
1486         return (sortOrder() == Qt::AscendingOrder) ? +1 : -1;
1487     }
1488
1489     // Determine the maximum common path of both items and
1490     // remember the index in 'index'
1491     const QString pathA = urlA.path();
1492     const QString pathB = urlB.path();
1493
1494     const int maxIndex = qMin(pathA.length(), pathB.length()) - 1;
1495     int index = 0;
1496     while (index <= maxIndex && pathA.at(index) == pathB.at(index)) {
1497         ++index;
1498     }
1499     if (index > maxIndex) {
1500         index = maxIndex;
1501     }
1502     while ((pathA.at(index) != QLatin1Char('/') || pathB.at(index) != QLatin1Char('/')) && index > 0) {
1503         --index;
1504     }
1505
1506     // Determine the first sub-path after the common path and
1507     // check whether it represents a directory or already a file
1508     bool isDirA = true;
1509     const QString subPathA = subPath(a->item, pathA, index, &isDirA);
1510     bool isDirB = true;
1511     const QString subPathB = subPath(b->item, pathB, index, &isDirB);
1512
1513     if (isDirA && !isDirB) {
1514         return (sortOrder() == Qt::AscendingOrder) ? -1 : +1;
1515     } else if (!isDirA && isDirB) {
1516         return (sortOrder() == Qt::AscendingOrder) ? +1 : -1;
1517     }
1518
1519     // Compare the items of the parents that represent the first
1520     // different path after the common path.
1521     const KUrl parentUrlA(pathA.left(index) + subPathA);
1522     const KUrl parentUrlB(pathB.left(index) + subPathB);
1523
1524     const ItemData* parentA = a;
1525     while (parentA && parentA->item.url() != parentUrlA) {
1526         parentA = parentA->parent;
1527     }
1528
1529     const ItemData* parentB = b;
1530     while (parentB && parentB->item.url() != parentUrlB) {
1531         parentB = parentB->parent;
1532     }
1533
1534     if (parentA && parentB) {
1535         return sortRoleCompare(parentA, parentB);
1536     }
1537
1538     kWarning() << "Child items without parent detected:" << a->item.url() << b->item.url();
1539     return QString::compare(urlA.url(), urlB.url(), Qt::CaseSensitive);
1540 }
1541
1542 QString KFileItemModel::subPath(const KFileItem& item,
1543                                 const QString& itemPath,
1544                                 int start,
1545                                 bool* isDir) const
1546 {
1547     Q_ASSERT(isDir);
1548     const int pathIndex = itemPath.indexOf('/', start + 1);
1549     *isDir = (pathIndex > 0) || item.isDir();
1550     return itemPath.mid(start, pathIndex - start);
1551 }
1552
1553 bool KFileItemModel::useMaximumUpdateInterval() const
1554 {
1555     const KDirLister* dirLister = m_dirLister.data();
1556     return dirLister && !dirLister->url().isLocalFile();
1557 }
1558
1559 QList<QPair<int, QVariant> > KFileItemModel::nameRoleGroups() const
1560 {
1561     Q_ASSERT(!m_itemData.isEmpty());
1562
1563     const int maxIndex = count() - 1;
1564     QList<QPair<int, QVariant> > groups;
1565
1566     QString groupValue;
1567     QChar firstChar;
1568     bool isLetter = false;
1569     for (int i = 0; i <= maxIndex; ++i) {
1570         if (isChildItem(i)) {
1571             continue;
1572         }
1573
1574         const QString name = m_itemData.at(i)->values.value("name").toString();
1575
1576         // Use the first character of the name as group indication
1577         QChar newFirstChar = name.at(0).toUpper();
1578         if (newFirstChar == QLatin1Char('~') && name.length() > 1) {
1579             newFirstChar = name.at(1).toUpper();
1580         }
1581
1582         if (firstChar != newFirstChar) {
1583             QString newGroupValue;
1584             if (newFirstChar >= QLatin1Char('A') && newFirstChar <= QLatin1Char('Z')) {
1585                 // Apply group 'A' - 'Z'
1586                 newGroupValue = newFirstChar;
1587                 isLetter = true;
1588             } else if (newFirstChar >= QLatin1Char('0') && newFirstChar <= QLatin1Char('9')) {
1589                 // Apply group '0 - 9' for any name that starts with a digit
1590                 newGroupValue = i18nc("@title:group Groups that start with a digit", "0 - 9");
1591                 isLetter = false;
1592             } else {
1593                 if (isLetter) {
1594                     // If the current group is 'A' - 'Z' check whether a locale character
1595                     // fits into the existing group.
1596                     // TODO: This does not work in the case if e.g. the group 'O' starts with
1597                     // an umlaut 'O' -> provide unit-test to document this known issue
1598                     const QChar prevChar(firstChar.unicode() - ushort(1));
1599                     const QChar nextChar(firstChar.unicode() + ushort(1));
1600                     const QString currChar(newFirstChar);
1601                     const bool partOfCurrentGroup = currChar.localeAwareCompare(prevChar) > 0 &&
1602                                                     currChar.localeAwareCompare(nextChar) < 0;
1603                     if (partOfCurrentGroup) {
1604                         continue;
1605                     }
1606                 }
1607                 newGroupValue = i18nc("@title:group", "Others");
1608                 isLetter = false;
1609             }
1610
1611             if (newGroupValue != groupValue) {
1612                 groupValue = newGroupValue;
1613                 groups.append(QPair<int, QVariant>(i, newGroupValue));
1614             }
1615
1616             firstChar = newFirstChar;
1617         }
1618     }
1619     return groups;
1620 }
1621
1622 QList<QPair<int, QVariant> > KFileItemModel::sizeRoleGroups() const
1623 {
1624     Q_ASSERT(!m_itemData.isEmpty());
1625
1626     const int maxIndex = count() - 1;
1627     QList<QPair<int, QVariant> > groups;
1628
1629     QString groupValue;
1630     for (int i = 0; i <= maxIndex; ++i) {
1631         if (isChildItem(i)) {
1632             continue;
1633         }
1634
1635         const KFileItem& item = m_itemData.at(i)->item;
1636         const KIO::filesize_t fileSize = !item.isNull() ? item.size() : ~0U;
1637         QString newGroupValue;
1638         if (!item.isNull() && item.isDir()) {
1639             newGroupValue = i18nc("@title:group Size", "Folders");
1640         } else if (fileSize < 5 * 1024 * 1024) {
1641             newGroupValue = i18nc("@title:group Size", "Small");
1642         } else if (fileSize < 10 * 1024 * 1024) {
1643             newGroupValue = i18nc("@title:group Size", "Medium");
1644         } else {
1645             newGroupValue = i18nc("@title:group Size", "Big");
1646         }
1647
1648         if (newGroupValue != groupValue) {
1649             groupValue = newGroupValue;
1650             groups.append(QPair<int, QVariant>(i, newGroupValue));
1651         }
1652     }
1653
1654     return groups;
1655 }
1656
1657 QList<QPair<int, QVariant> > KFileItemModel::dateRoleGroups() const
1658 {
1659     Q_ASSERT(!m_itemData.isEmpty());
1660
1661     const int maxIndex = count() - 1;
1662     QList<QPair<int, QVariant> > groups;
1663
1664     const QDate currentDate = KDateTime::currentLocalDateTime().date();
1665
1666     int yearForCurrentWeek = 0;
1667     int currentWeek = currentDate.weekNumber(&yearForCurrentWeek);
1668     if (yearForCurrentWeek == currentDate.year() + 1) {
1669         currentWeek = 53;
1670     }
1671
1672     QDate previousModifiedDate;
1673     QString groupValue;
1674     for (int i = 0; i <= maxIndex; ++i) {
1675         if (isChildItem(i)) {
1676             continue;
1677         }
1678
1679         const KDateTime modifiedTime = m_itemData.at(i)->item.time(KFileItem::ModificationTime);
1680         const QDate modifiedDate = modifiedTime.date();
1681         if (modifiedDate == previousModifiedDate) {
1682             // The current item is in the same group as the previous item
1683             continue;
1684         }
1685         previousModifiedDate = modifiedDate;
1686
1687         const int daysDistance = modifiedDate.daysTo(currentDate);
1688
1689         int yearForModifiedWeek = 0;
1690         int modifiedWeek = modifiedDate.weekNumber(&yearForModifiedWeek);
1691         if (yearForModifiedWeek == modifiedDate.year() + 1) {
1692             modifiedWeek = 53;
1693         }
1694
1695         QString newGroupValue;
1696         if (currentDate.year() == modifiedDate.year() && currentDate.month() == modifiedDate.month()) {
1697             if (modifiedWeek > currentWeek) {
1698                 // Usecase: modified date = 2010-01-01, current date = 2010-01-22
1699                 //          modified week = 53,         current week = 3
1700                 modifiedWeek = 0;
1701             }
1702             switch (currentWeek - modifiedWeek) {
1703             case 0:
1704                 switch (daysDistance) {
1705                 case 0:  newGroupValue = i18nc("@title:group Date", "Today"); break;
1706                 case 1:  newGroupValue = i18nc("@title:group Date", "Yesterday"); break;
1707                 default: newGroupValue = modifiedTime.toString(i18nc("@title:group The week day name: %A", "%A"));
1708                 }
1709                 break;
1710             case 1:
1711                 newGroupValue = i18nc("@title:group Date", "Last Week");
1712                 break;
1713             case 2:
1714                 newGroupValue = i18nc("@title:group Date", "Two Weeks Ago");
1715                 break;
1716             case 3:
1717                 newGroupValue = i18nc("@title:group Date", "Three Weeks Ago");
1718                 break;
1719             case 4:
1720             case 5:
1721                 newGroupValue = i18nc("@title:group Date", "Earlier this Month");
1722                 break;
1723             default:
1724                 Q_ASSERT(false);
1725             }
1726         } else {
1727             const QDate lastMonthDate = currentDate.addMonths(-1);
1728             if  (lastMonthDate.year() == modifiedDate.year() && lastMonthDate.month() == modifiedDate.month()) {
1729                 if (daysDistance == 1) {
1730                     newGroupValue = modifiedTime.toString(i18nc("@title:group Date: %B is full month name in current locale, and %Y is full year number", "Yesterday (%B, %Y)"));
1731                 } else if (daysDistance <= 7) {
1732                     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)"));
1733                 } else if (daysDistance <= 7 * 2) {
1734                     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)"));
1735                 } else if (daysDistance <= 7 * 3) {
1736                     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)"));
1737                 } else if (daysDistance <= 7 * 4) {
1738                     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)"));
1739                 } else {
1740                     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"));
1741                 }
1742             } else {
1743                 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"));
1744             }
1745         }
1746
1747         if (newGroupValue != groupValue) {
1748             groupValue = newGroupValue;
1749             groups.append(QPair<int, QVariant>(i, newGroupValue));
1750         }
1751     }
1752
1753     return groups;
1754 }
1755
1756 QList<QPair<int, QVariant> > KFileItemModel::permissionRoleGroups() const
1757 {
1758     Q_ASSERT(!m_itemData.isEmpty());
1759
1760     const int maxIndex = count() - 1;
1761     QList<QPair<int, QVariant> > groups;
1762
1763     QString permissionsString;
1764     QString groupValue;
1765     for (int i = 0; i <= maxIndex; ++i) {
1766         if (isChildItem(i)) {
1767             continue;
1768         }
1769
1770         const ItemData* itemData = m_itemData.at(i);
1771         const QString newPermissionsString = itemData->values.value("permissions").toString();
1772         if (newPermissionsString == permissionsString) {
1773             continue;
1774         }
1775         permissionsString = newPermissionsString;
1776
1777         const QFileInfo info(itemData->item.url().pathOrUrl());
1778
1779         // Set user string
1780         QString user;
1781         if (info.permission(QFile::ReadUser)) {
1782             user = i18nc("@item:intext Access permission, concatenated", "Read, ");
1783         }
1784         if (info.permission(QFile::WriteUser)) {
1785             user += i18nc("@item:intext Access permission, concatenated", "Write, ");
1786         }
1787         if (info.permission(QFile::ExeUser)) {
1788             user += i18nc("@item:intext Access permission, concatenated", "Execute, ");
1789         }
1790         user = user.isEmpty() ? i18nc("@item:intext Access permission, concatenated", "Forbidden") : user.mid(0, user.count() - 2);
1791
1792         // Set group string
1793         QString group;
1794         if (info.permission(QFile::ReadGroup)) {
1795             group = i18nc("@item:intext Access permission, concatenated", "Read, ");
1796         }
1797         if (info.permission(QFile::WriteGroup)) {
1798             group += i18nc("@item:intext Access permission, concatenated", "Write, ");
1799         }
1800         if (info.permission(QFile::ExeGroup)) {
1801             group += i18nc("@item:intext Access permission, concatenated", "Execute, ");
1802         }
1803         group = group.isEmpty() ? i18nc("@item:intext Access permission, concatenated", "Forbidden") : group.mid(0, group.count() - 2);
1804
1805         // Set others string
1806         QString others;
1807         if (info.permission(QFile::ReadOther)) {
1808             others = i18nc("@item:intext Access permission, concatenated", "Read, ");
1809         }
1810         if (info.permission(QFile::WriteOther)) {
1811             others += i18nc("@item:intext Access permission, concatenated", "Write, ");
1812         }
1813         if (info.permission(QFile::ExeOther)) {
1814             others += i18nc("@item:intext Access permission, concatenated", "Execute, ");
1815         }
1816         others = others.isEmpty() ? i18nc("@item:intext Access permission, concatenated", "Forbidden") : others.mid(0, others.count() - 2);
1817
1818         const QString newGroupValue = i18nc("@title:group Files and folders by permissions", "User: %1 | Group: %2 | Others: %3", user, group, others);
1819         if (newGroupValue != groupValue) {
1820             groupValue = newGroupValue;
1821             groups.append(QPair<int, QVariant>(i, newGroupValue));
1822         }
1823     }
1824
1825     return groups;
1826 }
1827
1828 QList<QPair<int, QVariant> > KFileItemModel::ratingRoleGroups() const
1829 {
1830     Q_ASSERT(!m_itemData.isEmpty());
1831
1832     const int maxIndex = count() - 1;
1833     QList<QPair<int, QVariant> > groups;
1834
1835     int groupValue;
1836     for (int i = 0; i <= maxIndex; ++i) {
1837         if (isChildItem(i)) {
1838             continue;
1839         }
1840         const int newGroupValue = m_itemData.at(i)->values.value("rating").toInt();
1841         if (newGroupValue != groupValue) {
1842             groupValue = newGroupValue;
1843             groups.append(QPair<int, QVariant>(i, newGroupValue));
1844         }
1845     }
1846
1847     return groups;
1848 }
1849
1850 QList<QPair<int, QVariant> > KFileItemModel::genericStringRoleGroups(const QByteArray& role) const
1851 {
1852     Q_ASSERT(!m_itemData.isEmpty());
1853
1854     const int maxIndex = count() - 1;
1855     QList<QPair<int, QVariant> > groups;
1856
1857     QString groupValue;
1858     for (int i = 0; i <= maxIndex; ++i) {
1859         if (isChildItem(i)) {
1860             continue;
1861         }
1862         const QString newGroupValue = m_itemData.at(i)->values.value(role).toString();
1863         if (newGroupValue != groupValue) {
1864             groupValue = newGroupValue;
1865             groups.append(QPair<int, QVariant>(i, newGroupValue));
1866         }
1867     }
1868
1869     return groups;
1870 }
1871
1872 KFileItemList KFileItemModel::childItems(const KFileItem& item) const
1873 {
1874     KFileItemList items;
1875
1876     int index = m_items.value(item.url(), -1);
1877     if (index >= 0) {
1878         const int parentLevel = m_itemData.at(index)->values.value("expansionLevel").toInt();
1879         ++index;
1880         while (index < m_itemData.count() && m_itemData.at(index)->values.value("expansionLevel").toInt() > parentLevel) {
1881             items.append(m_itemData.at(index)->item);
1882             ++index;
1883         }
1884     }
1885
1886     return items;
1887 }
1888
1889 #include "kfileitemmodel.moc"