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