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