src/kitemviews/kfileitemmodelrolesupdater.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 "kfileitemmodelrolesupdater.h"
  21
  22 #include "kfileitemmodel.h"
  23
  24 #include <KConfig>
  25 #include <KConfigGroup>
  26 #include <KDebug>
  27 #include <KDirWatch>
  28 #include <KFileItem>
  29 #include <KGlobal>
  30 #include <KIO/JobUiDelegate>
  31 #include <KIO/PreviewJob>
  32
  33 #include "private/kpixmapmodifier.h"
  34
  35 #include <QApplication>
  36 #include <QPainter>
  37 #include <QPixmap>
  38 #include <QElapsedTimer>
  39 #include <QTimer>
  40
  41 #include <algorithm>
  42
  43 #ifdef HAVE_NEPOMUK
  44     #include "private/knepomukrolesprovider.h"
  45     #include <Nepomuk2/ResourceWatcher>
  46     #include <Nepomuk2/ResourceManager>
  47 #endif
  48
  49 // Required includes for subItemsCount():
  50 #ifdef Q_WS_WIN
  51     #include <QDir>
  52 #else
  53     #include <dirent.h>
  54     #include <QFile>
  55 #endif
  56
  57 // #define KFILEITEMMODELROLESUPDATER_DEBUG
  58
  59 namespace {
  60     // Maximum time in ms that the KFileItemModelRolesUpdater
  61     // may perform a blocking operation
  62     const int MaxBlockTimeout = 200;
  63
  64     // If the number of items is smaller than ResolveAllItemsLimit,
  65     // the roles of all items will be resolved.
  66     const int ResolveAllItemsLimit = 500;
  67
  68     // Not only the visible area, but up to ReadAheadPages before and after
  69     // this area will be resolved.
  70     const int ReadAheadPages = 5;
  71 }
  72
  73 KFileItemModelRolesUpdater::KFileItemModelRolesUpdater(KFileItemModel* model, QObject* parent) :
  74     QObject(parent),
  75     m_state(Idle),
  76     m_previewChangedDuringPausing(false),
  77     m_iconSizeChangedDuringPausing(false),
  78     m_rolesChangedDuringPausing(false),
  79     m_previewShown(false),
  80     m_enlargeSmallPreviews(true),
  81     m_clearPreviews(false),
  82     m_finishedItems(),
  83     m_model(model),
  84     m_iconSize(),
  85     m_firstVisibleIndex(0),
  86     m_lastVisibleIndex(-1),
  87     m_maximumVisibleItems(50),
  88     m_roles(),
  89     m_resolvableRoles(),
  90     m_enabledPlugins(),
  91     m_pendingSortRoleItems(),
  92     m_pendingIndexes(),
  93     m_pendingPreviewItems(),
  94     m_previewJob(),
  95     m_recentlyChangedItemsTimer(0),
  96     m_recentlyChangedItems(),
  97     m_changedItems(),
  98     m_dirWatcher(0),
  99     m_watchedDirs()
 100   #ifdef HAVE_NEPOMUK
 101   , m_nepomukResourceWatcher(0),
 102     m_nepomukUriItems()
 103   #endif
 104 {
 105     Q_ASSERT(model);
 106
 107     const KConfigGroup globalConfig(KGlobal::config(), "PreviewSettings");
 108     m_enabledPlugins = globalConfig.readEntry("Plugins", QStringList()
 109                                                          << "directorythumbnail"
 110                                                          << "imagethumbnail"
 111                                                          << "jpegthumbnail");
 112
 113     connect(m_model, SIGNAL(itemsInserted(KItemRangeList)),
 114             this,    SLOT(slotItemsInserted(KItemRangeList)));
 115     connect(m_model, SIGNAL(itemsRemoved(KItemRangeList)),
 116             this,    SLOT(slotItemsRemoved(KItemRangeList)));
 117     connect(m_model, SIGNAL(itemsChanged(KItemRangeList,QSet<QByteArray>)),
 118             this,    SLOT(slotItemsChanged(KItemRangeList,QSet<QByteArray>)));
 119     connect(m_model, SIGNAL(itemsMoved(KItemRange,QList<int>)),
 120             this,    SLOT(slotItemsMoved(KItemRange,QList<int>)));
 121     connect(m_model, SIGNAL(sortRoleChanged(QByteArray,QByteArray)),
 122             this,    SLOT(slotSortRoleChanged(QByteArray,QByteArray)));
 123
 124     // Use a timer to prevent that each call of slotItemsChanged() results in a synchronous
 125     // resolving of the roles. Postpone the resolving until no update has been done for 1 second.
 126     m_recentlyChangedItemsTimer = new QTimer(this);
 127     m_recentlyChangedItemsTimer->setInterval(1000);
 128     m_recentlyChangedItemsTimer->setSingleShot(true);
 129     connect(m_recentlyChangedItemsTimer, SIGNAL(timeout()), this, SLOT(resolveRecentlyChangedItems()));
 130
 131     m_resolvableRoles.insert("size");
 132     m_resolvableRoles.insert("type");
 133     m_resolvableRoles.insert("isExpandable");
 134 #ifdef HAVE_NEPOMUK
 135     m_resolvableRoles += KNepomukRolesProvider::instance().roles();
 136 #endif
 137
 138     // When folders are expandable or the item-count is shown for folders, it is necessary
 139     // to watch the number of items of the sub-folder to be able to react on changes.
 140     m_dirWatcher = new KDirWatch(this);
 141     connect(m_dirWatcher, SIGNAL(dirty(QString)), this, SLOT(slotDirWatchDirty(QString)));
 142 }
 143
 144 KFileItemModelRolesUpdater::~KFileItemModelRolesUpdater()
 145 {
 146     killPreviewJob();
 147 }
 148
 149 void KFileItemModelRolesUpdater::setIconSize(const QSize& size)
 150 {
 151     if (size != m_iconSize) {
 152         m_iconSize = size;
 153         if (m_state == Paused) {
 154             m_iconSizeChangedDuringPausing = true;
 155         } else if (m_previewShown) {
 156             // An icon size change requires the regenerating of
 157             // all previews
 158             m_finishedItems.clear();
 159             startUpdating();
 160         }
 161     }
 162 }
 163
 164 QSize KFileItemModelRolesUpdater::iconSize() const
 165 {
 166     return m_iconSize;
 167 }
 168
 169 void KFileItemModelRolesUpdater::setVisibleIndexRange(int index, int count)
 170 {
 171     if (index < 0) {
 172         index = 0;
 173     }
 174     if (count < 0) {
 175         count = 0;
 176     }
 177
 178     if (index == m_firstVisibleIndex && count == m_lastVisibleIndex - m_firstVisibleIndex + 1) {
 179         // The range has not been changed
 180         return;
 181     }
 182
 183     m_firstVisibleIndex = index;
 184     m_lastVisibleIndex = qMin(index + count - 1, m_model->count() - 1);
 185
 186     startUpdating();
 187 }
 188
 189 void KFileItemModelRolesUpdater::setMaximumVisibleItems(int count)
 190 {
 191     m_maximumVisibleItems = count;
 192 }
 193
 194 void KFileItemModelRolesUpdater::setPreviewsShown(bool show)
 195 {
 196     if (show == m_previewShown) {
 197         return;
 198     }
 199
 200     m_previewShown = show;
 201     if (!show) {
 202         m_clearPreviews = true;
 203     }
 204
 205     updateAllPreviews();
 206 }
 207
 208 bool KFileItemModelRolesUpdater::previewsShown() const
 209 {
 210     return m_previewShown;
 211 }
 212
 213 void KFileItemModelRolesUpdater::setEnlargeSmallPreviews(bool enlarge)
 214 {
 215     if (enlarge != m_enlargeSmallPreviews) {
 216         m_enlargeSmallPreviews = enlarge;
 217         if (m_previewShown) {
 218             updateAllPreviews();
 219         }
 220     }
 221 }
 222
 223 bool KFileItemModelRolesUpdater::enlargeSmallPreviews() const
 224 {
 225     return m_enlargeSmallPreviews;
 226 }
 227
 228 void KFileItemModelRolesUpdater::setEnabledPlugins(const QStringList& list)
 229 {
 230     if (m_enabledPlugins != list) {
 231         m_enabledPlugins = list;
 232         if (m_previewShown) {
 233             updateAllPreviews();
 234         }
 235     }
 236 }
 237
 238 void KFileItemModelRolesUpdater::setPaused(bool paused)
 239 {
 240     if (paused == (m_state == Paused)) {
 241         return;
 242     }
 243
 244     if (paused) {
 245         m_state = Paused;
 246         killPreviewJob();
 247     } else {
 248         const bool updatePreviews = (m_iconSizeChangedDuringPausing && m_previewShown) ||
 249                                     m_previewChangedDuringPausing;
 250         const bool resolveAll = updatePreviews || m_rolesChangedDuringPausing;
 251         if (resolveAll) {
 252             m_finishedItems.clear();
 253         }
 254
 255         m_iconSizeChangedDuringPausing = false;
 256         m_previewChangedDuringPausing = false;
 257         m_rolesChangedDuringPausing = false;
 258
 259         if (!m_pendingSortRoleItems.isEmpty()) {
 260             m_state = ResolvingSortRole;
 261             resolveNextSortRole();
 262         } else {
 263             m_state = Idle;
 264         }
 265
 266         startUpdating();
 267     }
 268 }
 269
 270 void KFileItemModelRolesUpdater::setRoles(const QSet<QByteArray>& roles)
 271 {
 272     if (m_roles != roles) {
 273         m_roles = roles;
 274
 275 #ifdef HAVE_NEPOMUK
 276         if (Nepomuk2::ResourceManager::instance()->initialized()) {
 277             // Check whether there is at least one role that must be resolved
 278             // with the help of Nepomuk. If this is the case, a (quite expensive)
 279             // resolving will be done in KFileItemModelRolesUpdater::rolesData() and
 280             // the role gets watched for changes.
 281             const KNepomukRolesProvider& rolesProvider = KNepomukRolesProvider::instance();
 282             bool hasNepomukRole = false;
 283             QSetIterator<QByteArray> it(roles);
 284             while (it.hasNext()) {
 285                 const QByteArray& role = it.next();
 286                 if (rolesProvider.roles().contains(role)) {
 287                     hasNepomukRole = true;
 288                     break;
 289                 }
 290             }
 291
 292             if (hasNepomukRole && !m_nepomukResourceWatcher) {
 293                 Q_ASSERT(m_nepomukUriItems.isEmpty());
 294
 295                 m_nepomukResourceWatcher = new Nepomuk2::ResourceWatcher(this);
 296                 connect(m_nepomukResourceWatcher, SIGNAL(propertyChanged(Nepomuk2::Resource,Nepomuk2::Types::Property,QVariantList,QVariantList)),
 297                         this, SLOT(applyChangedNepomukRoles(Nepomuk2::Resource)));
 298             } else if (!hasNepomukRole && m_nepomukResourceWatcher) {
 299                 delete m_nepomukResourceWatcher;
 300                 m_nepomukResourceWatcher = 0;
 301                 m_nepomukUriItems.clear();
 302             }
 303         }
 304 #endif
 305
 306         if (m_state == Paused) {
 307             m_rolesChangedDuringPausing = true;
 308         } else {
 309             startUpdating();
 310         }
 311     }
 312 }
 313
 314 QSet<QByteArray> KFileItemModelRolesUpdater::roles() const
 315 {
 316     return m_roles;
 317 }
 318
 319 bool KFileItemModelRolesUpdater::isPaused() const
 320 {
 321     return m_state == Paused;
 322 }
 323
 324 QStringList KFileItemModelRolesUpdater::enabledPlugins() const
 325 {
 326     return m_enabledPlugins;
 327 }
 328
 329 void KFileItemModelRolesUpdater::slotItemsInserted(const KItemRangeList& itemRanges)
 330 {
 331     QElapsedTimer timer;
 332     timer.start();
 333
 334     // Determine the sort role synchronously for as many items as possible.
 335     if (m_resolvableRoles.contains(m_model->sortRole())) {
 336         int insertedCount = 0;
 337         foreach (const KItemRange& range, itemRanges) {
 338             const int lastIndex = insertedCount + range.index + range.count - 1;
 339             for (int i = insertedCount + range.index; i <= lastIndex; ++i) {
 340                 if (timer.elapsed() < MaxBlockTimeout) {
 341                     applySortRole(i);
 342                 } else {
 343                     m_pendingSortRoleItems.insert(m_model->fileItem(i));
 344                 }
 345             }
 346             insertedCount += range.count;
 347         }
 348
 349         applySortProgressToModel();
 350
 351         // If there are still items whose sort role is unknown, check if the
 352         // asynchronous determination of the sort role is already in progress,
 353         // and start it if that is not the case.
 354         if (!m_pendingSortRoleItems.isEmpty() && m_state != ResolvingSortRole) {
 355             killPreviewJob();
 356             m_state = ResolvingSortRole;
 357             resolveNextSortRole();
 358         }
 359     }
 360
 361     startUpdating();
 362 }
 363
 364 void KFileItemModelRolesUpdater::slotItemsRemoved(const KItemRangeList& itemRanges)
 365 {
 366     Q_UNUSED(itemRanges);
 367
 368     const bool allItemsRemoved = (m_model->count() == 0);
 369
 370     if (!m_watchedDirs.isEmpty()) {
 371         // Don't let KDirWatch watch for removed items
 372         if (allItemsRemoved) {
 373             foreach (const QString& path, m_watchedDirs) {
 374                 m_dirWatcher->removeDir(path);
 375             }
 376             m_watchedDirs.clear();
 377         } else {
 378             QMutableSetIterator<QString> it(m_watchedDirs);
 379             while (it.hasNext()) {
 380                 const QString& path = it.next();
 381                 if (m_model->index(KUrl(path)) < 0) {
 382                     m_dirWatcher->removeDir(path);
 383                     it.remove();
 384                 }
 385             }
 386         }
 387     }
 388
 389 #ifdef HAVE_NEPOMUK
 390     if (m_nepomukResourceWatcher) {
 391         // Don't let the ResourceWatcher watch for removed items
 392         if (allItemsRemoved) {
 393             m_nepomukResourceWatcher->setResources(QList<Nepomuk2::Resource>());
 394             m_nepomukResourceWatcher->stop();
 395             m_nepomukUriItems.clear();
 396         } else {
 397             QList<Nepomuk2::Resource> newResources;
 398             const QList<Nepomuk2::Resource> oldResources = m_nepomukResourceWatcher->resources();
 399             foreach (const Nepomuk2::Resource& resource, oldResources) {
 400                 const QUrl uri = resource.uri();
 401                 const KUrl itemUrl = m_nepomukUriItems.value(uri);
 402                 if (m_model->index(itemUrl) >= 0) {
 403                     newResources.append(resource);
 404                 } else {
 405                     m_nepomukUriItems.remove(uri);
 406                 }
 407             }
 408             m_nepomukResourceWatcher->setResources(newResources);
 409             if (newResources.isEmpty()) {
 410                 Q_ASSERT(m_nepomukUriItems.isEmpty());
 411                 m_nepomukResourceWatcher->stop();
 412             }
 413         }
 414     }
 415 #endif
 416
 417     if (allItemsRemoved) {
 418         m_state = Idle;
 419
 420         m_finishedItems.clear();
 421         m_pendingSortRoleItems.clear();
 422         m_pendingIndexes.clear();
 423         m_pendingPreviewItems.clear();
 424         m_recentlyChangedItems.clear();
 425         m_recentlyChangedItemsTimer->stop();
 426         m_changedItems.clear();
 427
 428         killPreviewJob();
 429     } else {
 430         // Only remove the items from m_finishedItems. They will be removed
 431         // from the other sets later on.
 432         QSet<KFileItem>::iterator it = m_finishedItems.begin();
 433         while (it != m_finishedItems.end()) {
 434             if (m_model->index(*it) < 0) {
 435                 it = m_finishedItems.erase(it);
 436             } else {
 437                 ++it;
 438             }
 439         }
 440
 441         // The visible items might have changed.
 442         startUpdating();
 443     }
 444 }
 445
 446 void KFileItemModelRolesUpdater::slotItemsMoved(const KItemRange& itemRange, QList<int> movedToIndexes)
 447 {
 448     Q_UNUSED(itemRange);
 449     Q_UNUSED(movedToIndexes);
 450
 451     // The visible items might have changed.
 452     startUpdating();
 453 }
 454
 455 void KFileItemModelRolesUpdater::slotItemsChanged(const KItemRangeList& itemRanges,
 456                                                   const QSet<QByteArray>& roles)
 457 {
 458     Q_UNUSED(roles);
 459
 460     // Find out if slotItemsChanged() has been done recently. If that is the
 461     // case, resolving the roles is postponed until a timer has exceeded
 462     // to prevent expensive repeated updates if files are updated frequently.
 463     const bool itemsChangedRecently = m_recentlyChangedItemsTimer->isActive();
 464
 465     QSet<KFileItem>& targetSet = itemsChangedRecently ? m_recentlyChangedItems : m_changedItems;
 466
 467     foreach (const KItemRange& itemRange, itemRanges) {
 468         int index = itemRange.index;
 469         for (int count = itemRange.count; count > 0; --count) {
 470             const KFileItem item = m_model->fileItem(index);
 471             targetSet.insert(item);
 472             ++index;
 473         }
 474     }
 475
 476     m_recentlyChangedItemsTimer->start();
 477
 478     if (!itemsChangedRecently) {
 479         updateChangedItems();
 480     }
 481 }
 482
 483 void KFileItemModelRolesUpdater::slotSortRoleChanged(const QByteArray& current,
 484                                                      const QByteArray& previous)
 485 {
 486     Q_UNUSED(current);
 487     Q_UNUSED(previous);
 488
 489     if (m_resolvableRoles.contains(current)) {
 490         m_pendingSortRoleItems.clear();
 491         m_finishedItems.clear();
 492
 493         const int count = m_model->count();
 494         QElapsedTimer timer;
 495         timer.start();
 496
 497         // Determine the sort role synchronously for as many items as possible.
 498         for (int index = 0; index < count; ++index) {
 499             if (timer.elapsed() < MaxBlockTimeout) {
 500                 applySortRole(index);
 501             } else {
 502                 m_pendingSortRoleItems.insert(m_model->fileItem(index));
 503             }
 504         }
 505
 506         applySortProgressToModel();
 507
 508         if (!m_pendingSortRoleItems.isEmpty()) {
 509             // Trigger the asynchronous determination of the sort role.
 510             killPreviewJob();
 511             m_state = ResolvingSortRole;
 512             resolveNextSortRole();
 513         }
 514     } else {
 515         m_state = Idle;
 516         m_pendingSortRoleItems.clear();
 517         applySortProgressToModel();
 518     }
 519 }
 520
 521 void KFileItemModelRolesUpdater::slotGotPreview(const KFileItem& item, const QPixmap& pixmap)
 522 {
 523     if (m_state != PreviewJobRunning) {
 524         return;
 525     }
 526
 527     m_changedItems.remove(item);
 528
 529     const int index = m_model->index(item);
 530     if (index < 0) {
 531         return;
 532     }
 533
 534     QPixmap scaledPixmap = pixmap;
 535
 536     const QString mimeType = item.mimetype();
 537     const int slashIndex = mimeType.indexOf(QLatin1Char('/'));
 538     const QString mimeTypeGroup = mimeType.left(slashIndex);
 539     if (mimeTypeGroup == QLatin1String("image")) {
 540         if (m_enlargeSmallPreviews) {
 541             KPixmapModifier::applyFrame(scaledPixmap, m_iconSize);
 542         } else {
 543             // Assure that small previews don't get enlarged. Instead they
 544             // should be shown centered within the frame.
 545             const QSize contentSize = KPixmapModifier::sizeInsideFrame(m_iconSize);
 546             const bool enlargingRequired = scaledPixmap.width()  < contentSize.width() &&
 547                                            scaledPixmap.height() < contentSize.height();
 548             if (enlargingRequired) {
 549                 QSize frameSize = scaledPixmap.size();
 550                 frameSize.scale(m_iconSize, Qt::KeepAspectRatio);
 551
 552                 QPixmap largeFrame(frameSize);
 553                 largeFrame.fill(Qt::transparent);
 554
 555                 KPixmapModifier::applyFrame(largeFrame, frameSize);
 556
 557                 QPainter painter(&largeFrame);
 558                 painter.drawPixmap((largeFrame.width()  - scaledPixmap.width()) / 2,
 559                                    (largeFrame.height() - scaledPixmap.height()) / 2,
 560                                    scaledPixmap);
 561                 scaledPixmap = largeFrame;
 562             } else {
 563                 // The image must be shrinked as it is too large to fit into
 564                 // the available icon size
 565                 KPixmapModifier::applyFrame(scaledPixmap, m_iconSize);
 566             }
 567         }
 568     } else {
 569         KPixmapModifier::scale(scaledPixmap, m_iconSize);
 570     }
 571
 572     QHash<QByteArray, QVariant> data = rolesData(item);
 573     data.insert("iconPixmap", scaledPixmap);
 574
 575     disconnect(m_model, SIGNAL(itemsChanged(KItemRangeList,QSet<QByteArray>)),
 576                this,    SLOT(slotItemsChanged(KItemRangeList,QSet<QByteArray>)));
 577     m_model->setData(index, data);
 578     connect(m_model, SIGNAL(itemsChanged(KItemRangeList,QSet<QByteArray>)),
 579             this,    SLOT(slotItemsChanged(KItemRangeList,QSet<QByteArray>)));
 580
 581     m_finishedItems.insert(item);
 582 }
 583
 584 void KFileItemModelRolesUpdater::slotPreviewFailed(const KFileItem& item)
 585 {
 586     if (m_state != PreviewJobRunning) {
 587         return;
 588     }
 589
 590     m_changedItems.remove(item);
 591
 592     const int index = m_model->index(item);
 593     if (index >= 0) {
 594         QHash<QByteArray, QVariant> data;
 595         data.insert("iconPixmap", QPixmap());
 596
 597         disconnect(m_model, SIGNAL(itemsChanged(KItemRangeList,QSet<QByteArray>)),
 598                    this,    SLOT(slotItemsChanged(KItemRangeList,QSet<QByteArray>)));
 599         m_model->setData(index, data);
 600         connect(m_model, SIGNAL(itemsChanged(KItemRangeList,QSet<QByteArray>)),
 601                 this,    SLOT(slotItemsChanged(KItemRangeList,QSet<QByteArray>)));
 602
 603         applyResolvedRoles(item, ResolveAll);
 604         m_finishedItems.insert(item);
 605     }
 606 }
 607
 608 void KFileItemModelRolesUpdater::slotPreviewJobFinished()
 609 {
 610     m_previewJob = 0;
 611
 612     if (m_state != PreviewJobRunning) {
 613         return;
 614     }
 615
 616     m_state = Idle;
 617
 618     if (!m_pendingPreviewItems.isEmpty()) {
 619         startPreviewJob();
 620     } else {
 621         if (!m_changedItems.isEmpty()) {
 622             updateChangedItems();
 623         }
 624     }
 625 }
 626
 627 void KFileItemModelRolesUpdater::resolveNextSortRole()
 628 {
 629     if (m_state != ResolvingSortRole) {
 630         return;
 631     }
 632
 633     QSet<KFileItem>::iterator it = m_pendingSortRoleItems.begin();
 634     while (it != m_pendingSortRoleItems.end()) {
 635         const KFileItem item = *it;
 636         const int index = m_model->index(item);
 637
 638         // Continue if the sort role has already been determined for the
 639         // item, and the item has not been changed recently.
 640         if (!m_changedItems.contains(item) && m_model->data(index).contains(m_model->sortRole())) {
 641             it = m_pendingSortRoleItems.erase(it);
 642             continue;
 643         }
 644
 645         applySortRole(index);
 646         m_pendingSortRoleItems.erase(it);
 647         break;
 648     }
 649
 650     if (!m_pendingSortRoleItems.isEmpty()) {
 651         applySortProgressToModel();
 652         QTimer::singleShot(0, this, SLOT(resolveNextSortRole()));
 653     } else {
 654         m_state = Idle;
 655
 656         // Prevent that we try to update the items twice.
 657         disconnect(m_model, SIGNAL(itemsMoved(KItemRange,QList<int>)),
 658                    this,    SLOT(slotItemsMoved(KItemRange,QList<int>)));
 659         applySortProgressToModel();
 660         connect(m_model, SIGNAL(itemsMoved(KItemRange,QList<int>)),
 661                 this,    SLOT(slotItemsMoved(KItemRange,QList<int>)));
 662         startUpdating();
 663     }
 664 }
 665
 666 void KFileItemModelRolesUpdater::resolveNextPendingRoles()
 667 {
 668     if (m_state != ResolvingAllRoles) {
 669         return;
 670     }
 671
 672     while (!m_pendingIndexes.isEmpty()) {
 673         const int index = m_pendingIndexes.takeFirst();
 674         const KFileItem item = m_model->fileItem(index);
 675
 676         if (m_finishedItems.contains(item)) {
 677             continue;
 678         }
 679
 680         applyResolvedRoles(item, ResolveAll);
 681         m_finishedItems.insert(item);
 682         m_changedItems.remove(item);
 683         break;
 684     }
 685
 686     if (!m_pendingIndexes.isEmpty()) {
 687         QTimer::singleShot(0, this, SLOT(resolveNextPendingRoles()));
 688     } else {
 689         m_state = Idle;
 690
 691         if (m_clearPreviews) {
 692             // Only go through the list if there are items which might still have previews.
 693             if (m_finishedItems.count() != m_model->count()) {
 694                 QHash<QByteArray, QVariant> data;
 695                 data.insert("iconPixmap", QPixmap());
 696
 697                 disconnect(m_model, SIGNAL(itemsChanged(KItemRangeList,QSet<QByteArray>)),
 698                            this,    SLOT(slotItemsChanged(KItemRangeList,QSet<QByteArray>)));
 699                 for (int index = 0; index <= m_model->count(); ++index) {
 700                     if (m_model->data(index).contains("iconPixmap")) {
 701                         m_model->setData(index, data);
 702                     }
 703                 }
 704                 connect(m_model, SIGNAL(itemsChanged(KItemRangeList,QSet<QByteArray>)),
 705                         this,    SLOT(slotItemsChanged(KItemRangeList,QSet<QByteArray>)));
 706
 707             }
 708             m_clearPreviews = false;
 709         }
 710
 711         if (!m_changedItems.isEmpty()) {
 712             updateChangedItems();
 713         }
 714     }
 715 }
 716
 717 void KFileItemModelRolesUpdater::resolveRecentlyChangedItems()
 718 {
 719     m_changedItems += m_recentlyChangedItems;
 720     m_recentlyChangedItems.clear();
 721     updateChangedItems();
 722 }
 723
 724 void KFileItemModelRolesUpdater::applyChangedNepomukRoles(const Nepomuk2::Resource& resource)
 725 {
 726 #ifdef HAVE_NEPOMUK
 727     if (!Nepomuk2::ResourceManager::instance()->initialized()) {
 728         return;
 729     }
 730
 731     const KUrl itemUrl = m_nepomukUriItems.value(resource.uri());
 732     const KFileItem item = m_model->fileItem(itemUrl);
 733
 734     if (item.isNull()) {
 735         // itemUrl is not in the model anymore, probably because
 736         // the corresponding file has been deleted in the meantime.
 737         return;
 738     }
 739
 740     QHash<QByteArray, QVariant> data = rolesData(item);
 741
 742     const KNepomukRolesProvider& rolesProvider = KNepomukRolesProvider::instance();
 743     QHashIterator<QByteArray, QVariant> it(rolesProvider.roleValues(resource, m_roles));
 744     while (it.hasNext()) {
 745         it.next();
 746         data.insert(it.key(), it.value());
 747     }
 748
 749     disconnect(m_model, SIGNAL(itemsChanged(KItemRangeList,QSet<QByteArray>)),
 750                this,    SLOT(slotItemsChanged(KItemRangeList,QSet<QByteArray>)));
 751     const int index = m_model->index(item);
 752     m_model->setData(index, data);
 753     connect(m_model, SIGNAL(itemsChanged(KItemRangeList,QSet<QByteArray>)),
 754             this,    SLOT(slotItemsChanged(KItemRangeList,QSet<QByteArray>)));
 755 #else
 756 #ifndef Q_CC_MSVC
 757     Q_UNUSED(resource);
 758 #endif
 759 #endif
 760 }
 761
 762 void KFileItemModelRolesUpdater::slotDirWatchDirty(const QString& path)
 763 {
 764     const bool getSizeRole = m_roles.contains("size");
 765     const bool getIsExpandableRole = m_roles.contains("isExpandable");
 766
 767     if (getSizeRole || getIsExpandableRole) {
 768         const int index = m_model->index(KUrl(path));
 769         if (index >= 0) {
 770             if (!m_model->fileItem(index).isDir()) {
 771                 // If INotify is used, KDirWatch issues the dirty() signal
 772                 // also for changed files inside the directory, even if we
 773                 // don't enable this behavior explicitly (see bug 309740).
 774                 return;
 775             }
 776
 777             QHash<QByteArray, QVariant> data;
 778
 779             const int count = subItemsCount(path);
 780             if (getSizeRole) {
 781                 data.insert("size", count);
 782             }
 783             if (getIsExpandableRole) {
 784                 data.insert("isExpandable", count > 0);
 785             }
 786
 787             // Note that we do not block the itemsChanged signal here.
 788             // This ensures that a new preview will be generated.
 789             m_model->setData(index, data);
 790         }
 791     }
 792 }
 793
 794 void KFileItemModelRolesUpdater::startUpdating()
 795 {
 796     if (m_state == Paused) {
 797         return;
 798     }
 799
 800     if (m_finishedItems.count() == m_model->count()) {
 801         // All roles have been resolved already.
 802         m_state = Idle;
 803         return;
 804     }
 805
 806     // Terminate all updates that are currently active.
 807     killPreviewJob();
 808     m_pendingIndexes.clear();
 809
 810     QElapsedTimer timer;
 811     timer.start();
 812
 813     // Determine the icons for the visible items synchronously.
 814     updateVisibleIcons();
 815
 816     // A detailed update of the items in and near the visible area
 817     // only makes sense if sorting is finished.
 818     if (m_state == ResolvingSortRole) {
 819         return;
 820     }
 821
 822     // Start the preview job or the asynchronous resolving of all roles.
 823     QList<int> indexes = indexesToResolve();
 824
 825     if (m_previewShown) {
 826         m_pendingPreviewItems.clear();
 827         m_pendingPreviewItems.reserve(indexes.count());
 828
 829         foreach (int index, indexes) {
 830             const KFileItem item = m_model->fileItem(index);
 831             if (!m_finishedItems.contains(item)) {
 832                 m_pendingPreviewItems.append(item);
 833             }
 834         }
 835
 836         startPreviewJob();
 837     } else {
 838         m_pendingIndexes = indexes;
 839         // Trigger the asynchronous resolving of all roles.
 840         m_state = ResolvingAllRoles;
 841         QTimer::singleShot(0, this, SLOT(resolveNextPendingRoles()));
 842     }
 843 }
 844
 845 void KFileItemModelRolesUpdater::updateVisibleIcons()
 846 {
 847     int lastVisibleIndex = m_lastVisibleIndex;
 848     if (lastVisibleIndex <= 0) {
 849         // Guess a reasonable value for the last visible index if the view
 850         // has not told us about the real value yet.
 851         lastVisibleIndex = qMin(m_firstVisibleIndex + m_maximumVisibleItems, m_model->count() - 1);
 852         if (lastVisibleIndex <= 0) {
 853             lastVisibleIndex = qMin(200, m_model->count() - 1);
 854         }
 855     }
 856
 857     QElapsedTimer timer;
 858     timer.start();
 859
 860     // Try to determine the final icons for all visible items.
 861     int index;
 862     for (index = m_firstVisibleIndex; index <= lastVisibleIndex && timer.elapsed() < MaxBlockTimeout; ++index) {
 863         const KFileItem item = m_model->fileItem(index);
 864         applyResolvedRoles(item, ResolveFast);
 865     }
 866
 867     // KFileItemListView::initializeItemListWidget(KItemListWidget*) will load
 868     // preliminary icons (i.e., without mime type determination) for the
 869     // remaining items.
 870 }
 871
 872 void KFileItemModelRolesUpdater::startPreviewJob()
 873 {
 874     m_state = PreviewJobRunning;
 875
 876     if (m_pendingPreviewItems.isEmpty()) {
 877         QTimer::singleShot(0, this, SLOT(slotPreviewJobFinished()));
 878         return;
 879     }
 880
 881     // PreviewJob internally caches items always with the size of
 882     // 128 x 128 pixels or 256 x 256 pixels. A (slow) downscaling is done
 883     // by PreviewJob if a smaller size is requested. For images KFileItemModelRolesUpdater must
 884     // do a downscaling anyhow because of the frame, so in this case only the provided
 885     // cache sizes are requested.
 886     const QSize cacheSize = (m_iconSize.width() > 128) || (m_iconSize.height() > 128)
 887                              ? QSize(256, 256) : QSize(128, 128);
 888
 889     // KIO::filePreview() will request the MIME-type of all passed items, which (in the
 890     // worst case) might block the application for several seconds. To prevent such
 891     // a blocking, we only pass items with known mime type to the preview job.
 892     const int count = m_pendingPreviewItems.count();
 893     KFileItemList itemSubSet;
 894     itemSubSet.reserve(count);
 895
 896     if (m_pendingPreviewItems.first().isMimeTypeKnown()) {
 897         // Some mime types are known already, probably because they were
 898         // determined when loading the icons for the visible items. Start
 899         // a preview job for all items at the beginning of the list which
 900         // have a known mime type.
 901         do {
 902             itemSubSet.append(m_pendingPreviewItems.takeFirst());
 903         } while (!m_pendingPreviewItems.isEmpty() && m_pendingPreviewItems.first().isMimeTypeKnown());
 904     } else {
 905         // Determine mime types for MaxBlockTimeout ms, and start a preview
 906         // job for the corresponding items.
 907         QElapsedTimer timer;
 908         timer.start();
 909
 910         do {
 911             const KFileItem item = m_pendingPreviewItems.takeFirst();
 912             item.determineMimeType();
 913             itemSubSet.append(item);
 914         } while (!m_pendingPreviewItems.isEmpty() && timer.elapsed() < MaxBlockTimeout);
 915     }
 916
 917     KIO::PreviewJob* job = new KIO::PreviewJob(itemSubSet, cacheSize, &m_enabledPlugins);
 918
 919     job->setIgnoreMaximumSize(itemSubSet.first().isLocalFile());
 920     if (job->ui()) {
 921         job->ui()->setWindow(qApp->activeWindow());
 922     }
 923
 924     connect(job,  SIGNAL(gotPreview(KFileItem,QPixmap)),
 925             this, SLOT(slotGotPreview(KFileItem,QPixmap)));
 926     connect(job,  SIGNAL(failed(KFileItem)),
 927             this, SLOT(slotPreviewFailed(KFileItem)));
 928     connect(job,  SIGNAL(finished(KJob*)),
 929             this, SLOT(slotPreviewJobFinished()));
 930
 931     m_previewJob = job;
 932 }
 933
 934 void KFileItemModelRolesUpdater::updateChangedItems()
 935 {
 936     if (m_state == Paused) {
 937         return;
 938     }
 939
 940     if (m_changedItems.isEmpty()) {
 941         return;
 942     }
 943
 944     m_finishedItems -= m_changedItems;
 945
 946     if (m_resolvableRoles.contains(m_model->sortRole())) {
 947         m_pendingSortRoleItems += m_changedItems;
 948
 949         if (m_state != ResolvingSortRole) {
 950             // Stop the preview job if necessary, and trigger the
 951             // asynchronous determination of the sort role.
 952             killPreviewJob();
 953             m_state = ResolvingSortRole;
 954             QTimer::singleShot(0, this, SLOT(resolveNextSortRole()));
 955         }
 956
 957         return;
 958     }
 959
 960     QList<int> visibleChangedIndexes;
 961     QList<int> invisibleChangedIndexes;
 962
 963     foreach (const KFileItem& item, m_changedItems) {
 964         const int index = m_model->index(item);
 965
 966         if (index < 0) {
 967             m_changedItems.remove(item);
 968             continue;
 969         }
 970
 971         if (index >= m_firstVisibleIndex && index <= m_lastVisibleIndex) {
 972             visibleChangedIndexes.append(index);
 973         } else {
 974             invisibleChangedIndexes.append(index);
 975         }
 976     }
 977
 978     std::sort(visibleChangedIndexes.begin(), visibleChangedIndexes.end());
 979
 980     if (m_previewShown) {
 981         foreach (int index, visibleChangedIndexes) {
 982             m_pendingPreviewItems.append(m_model->fileItem(index));
 983         }
 984
 985         foreach (int index, invisibleChangedIndexes) {
 986             m_pendingPreviewItems.append(m_model->fileItem(index));
 987         }
 988
 989         if (!m_previewJob) {
 990             startPreviewJob();
 991         }
 992     } else {
 993         const bool resolvingInProgress = !m_pendingIndexes.isEmpty();
 994         m_pendingIndexes = visibleChangedIndexes + m_pendingIndexes + invisibleChangedIndexes;
 995         if (!resolvingInProgress) {
 996             // Trigger the asynchronous resolving of the changed roles.
 997             m_state = ResolvingAllRoles;
 998             QTimer::singleShot(0, this, SLOT(resolveNextPendingRoles()));
 999         }
1000     }
1001 }
1002
1003 void KFileItemModelRolesUpdater::applySortRole(int index)
1004 {
1005     QHash<QByteArray, QVariant> data;
1006     const KFileItem item = m_model->fileItem(index);
1007
1008     if (m_model->sortRole() == "type") {
1009         if (!item.isMimeTypeKnown()) {
1010             item.determineMimeType();
1011         }
1012
1013         data.insert("type", item.mimeComment());
1014     } else if (m_model->sortRole() == "size" && item.isLocalFile() && item.isDir()) {
1015         const QString path = item.localPath();
1016         data.insert("size", subItemsCount(path));
1017     } else {
1018         // Probably the sort role is a Nepomuk role - just determine all roles.
1019         data = rolesData(item);
1020     }
1021
1022     disconnect(m_model, SIGNAL(itemsChanged(KItemRangeList,QSet<QByteArray>)),
1023                this,    SLOT(slotItemsChanged(KItemRangeList,QSet<QByteArray>)));
1024     m_model->setData(index, data);
1025     connect(m_model, SIGNAL(itemsChanged(KItemRangeList,QSet<QByteArray>)),
1026             this,    SLOT(slotItemsChanged(KItemRangeList,QSet<QByteArray>)));
1027 }
1028
1029 void KFileItemModelRolesUpdater::applySortProgressToModel()
1030 {
1031     // Inform the model about the progress of the resolved items,
1032     // so that it can give an indication when the sorting has been finished.
1033     const int resolvedCount = m_model->count() - m_pendingSortRoleItems.count();
1034     m_model->emitSortProgress(resolvedCount);
1035 }
1036
1037 bool KFileItemModelRolesUpdater::applyResolvedRoles(const KFileItem& item, ResolveHint hint)
1038 {
1039     if (item.isNull()) {
1040         return false;
1041     }
1042
1043     const bool resolveAll = (hint == ResolveAll);
1044
1045     bool iconChanged = false;
1046     if (!item.isMimeTypeKnown() || !item.isFinalIconKnown()) {
1047         item.determineMimeType();
1048         iconChanged = true;
1049     } else {
1050         const int index = m_model->index(item);
1051         if (!m_model->data(index).contains("iconName")) {
1052             iconChanged = true;
1053         }
1054     }
1055
1056     if (iconChanged || resolveAll || m_clearPreviews) {
1057         const int index = m_model->index(item);
1058         if (index < 0) {
1059             return false;
1060         }
1061
1062         QHash<QByteArray, QVariant> data;
1063         if (resolveAll) {
1064             data = rolesData(item);
1065         }
1066
1067         data.insert("iconName", item.iconName());
1068
1069         if (m_clearPreviews) {
1070             data.insert("iconPixmap", QPixmap());
1071         }
1072
1073         disconnect(m_model, SIGNAL(itemsChanged(KItemRangeList,QSet<QByteArray>)),
1074                    this,    SLOT(slotItemsChanged(KItemRangeList,QSet<QByteArray>)));
1075         m_model->setData(index, data);
1076         connect(m_model, SIGNAL(itemsChanged(KItemRangeList,QSet<QByteArray>)),
1077                 this,    SLOT(slotItemsChanged(KItemRangeList,QSet<QByteArray>)));
1078         return true;
1079     }
1080
1081     return false;
1082 }
1083
1084 QHash<QByteArray, QVariant> KFileItemModelRolesUpdater::rolesData(const KFileItem& item) const
1085 {
1086     QHash<QByteArray, QVariant> data;
1087
1088     const bool getSizeRole = m_roles.contains("size");
1089     const bool getIsExpandableRole = m_roles.contains("isExpandable");
1090
1091     if ((getSizeRole || getIsExpandableRole) && item.isDir()) {
1092         if (item.isLocalFile()) {
1093             const QString path = item.localPath();
1094             const int count = subItemsCount(path);
1095             if (getSizeRole) {
1096                 data.insert("size", count);
1097             }
1098             if (getIsExpandableRole) {
1099                 data.insert("isExpandable", count > 0);
1100             }
1101
1102             if (!m_dirWatcher->contains(path)) {
1103                 m_dirWatcher->addDir(path);
1104                 m_watchedDirs.insert(path);
1105             }
1106         } else if (getSizeRole) {
1107             data.insert("size", -1); // -1 indicates an unknown number of items
1108         }
1109     }
1110
1111     if (m_roles.contains("type")) {
1112         data.insert("type", item.mimeComment());
1113     }
1114
1115     data.insert("iconOverlays", item.overlays());
1116
1117 #ifdef HAVE_NEPOMUK
1118     if (m_nepomukResourceWatcher) {
1119         const KNepomukRolesProvider& rolesProvider = KNepomukRolesProvider::instance();
1120         Nepomuk2::Resource resource(item.nepomukUri());
1121         QHashIterator<QByteArray, QVariant> it(rolesProvider.roleValues(resource, m_roles));
1122         while (it.hasNext()) {
1123             it.next();
1124             data.insert(it.key(), it.value());
1125         }
1126
1127         QUrl uri = resource.uri();
1128         if (uri.isEmpty()) {
1129             // TODO: Is there another way to explicitly create a resource?
1130             // We need a resource to be able to track it for changes.
1131             resource.setRating(0);
1132             uri = resource.uri();
1133         }
1134         if (!uri.isEmpty() && !m_nepomukUriItems.contains(uri)) {
1135             m_nepomukResourceWatcher->addResource(resource);
1136
1137             if (m_nepomukUriItems.isEmpty()) {
1138                 m_nepomukResourceWatcher->start();
1139             }
1140
1141             m_nepomukUriItems.insert(uri, item.url());
1142         }
1143     }
1144 #endif
1145
1146     return data;
1147 }
1148
1149 int KFileItemModelRolesUpdater::subItemsCount(const QString& path) const
1150 {
1151     const bool countHiddenFiles = m_model->showHiddenFiles();
1152     const bool showFoldersOnly  = m_model->showDirectoriesOnly();
1153
1154 #ifdef Q_WS_WIN
1155     QDir dir(path);
1156     QDir::Filters filters = QDir::NoDotAndDotDot | QDir::System;
1157     if (countHiddenFiles) {
1158         filters |= QDir::Hidden;
1159     }
1160     if (showFoldersOnly) {
1161         filters |= QDir::Dirs;
1162     } else {
1163         filters |= QDir::AllEntries;
1164     }
1165     return dir.entryList(filters).count();
1166 #else
1167     // Taken from kdelibs/kio/kio/kdirmodel.cpp
1168     // Copyright (C) 2006 David Faure <faure@kde.org>
1169
1170     int count = -1;
1171     DIR* dir = ::opendir(QFile::encodeName(path));
1172     if (dir) {  // krazy:exclude=syscalls
1173         count = 0;
1174         struct dirent *dirEntry = 0;
1175         while ((dirEntry = ::readdir(dir))) {
1176             if (dirEntry->d_name[0] == '.') {
1177                 if (dirEntry->d_name[1] == '\0' || !countHiddenFiles) {
1178                     // Skip "." or hidden files
1179                     continue;
1180                 }
1181                 if (dirEntry->d_name[1] == '.' && dirEntry->d_name[2] == '\0') {
1182                     // Skip ".."
1183                     continue;
1184                 }
1185             }
1186
1187             // If only directories are counted, consider an unknown file type and links also
1188             // as directory instead of trying to do an expensive stat()
1189             // (see bugs 292642 and 299997).
1190             const bool countEntry = !showFoldersOnly ||
1191                                     dirEntry->d_type == DT_DIR ||
1192                                     dirEntry->d_type == DT_LNK ||
1193                                     dirEntry->d_type == DT_UNKNOWN;
1194             if (countEntry) {
1195                 ++count;
1196             }
1197         }
1198         ::closedir(dir);
1199     }
1200     return count;
1201 #endif
1202 }
1203
1204 void KFileItemModelRolesUpdater::updateAllPreviews()
1205 {
1206     if (m_state == Paused) {
1207         m_previewChangedDuringPausing = true;
1208     } else {
1209         m_finishedItems.clear();
1210         startUpdating();
1211     }
1212 }
1213
1214 void KFileItemModelRolesUpdater::killPreviewJob()
1215 {
1216     if (m_previewJob) {
1217         disconnect(m_previewJob,  SIGNAL(gotPreview(KFileItem,QPixmap)),
1218                    this, SLOT(slotGotPreview(KFileItem,QPixmap)));
1219         disconnect(m_previewJob,  SIGNAL(failed(KFileItem)),
1220                    this, SLOT(slotPreviewFailed(KFileItem)));
1221         disconnect(m_previewJob,  SIGNAL(finished(KJob*)),
1222                    this, SLOT(slotPreviewJobFinished()));
1223         m_previewJob->kill();
1224         m_previewJob = 0;
1225         m_pendingPreviewItems.clear();
1226     }
1227 }
1228
1229 QList<int> KFileItemModelRolesUpdater::indexesToResolve() const
1230 {
1231     const int count = m_model->count();
1232
1233     QList<int> result;
1234     result.reserve(ResolveAllItemsLimit);
1235
1236     // Add visible items.
1237     for (int i = m_firstVisibleIndex; i <= m_lastVisibleIndex; ++i) {
1238         result.append(i);
1239     }
1240
1241     // We need a reasonable upper limit for number of items to resolve after
1242     // and before the visible range. m_maximumVisibleItems can be quite large
1243     // when using Compace View.
1244     const int readAheadItems = qMin(ReadAheadPages * m_maximumVisibleItems, ResolveAllItemsLimit / 2);
1245
1246     // Add items after the visible range.
1247     const int endExtendedVisibleRange = qMin(m_lastVisibleIndex + readAheadItems, count - 1);
1248     for (int i = m_lastVisibleIndex + 1; i <= endExtendedVisibleRange; ++i) {
1249         result.append(i);
1250     }
1251
1252     // Add items before the visible range in reverse order.
1253     const int beginExtendedVisibleRange = qMax(0, m_firstVisibleIndex - readAheadItems);
1254     for (int i = m_firstVisibleIndex - 1; i >= beginExtendedVisibleRange; --i) {
1255         result.append(i);
1256     }
1257
1258     // Add items on the last page.
1259     const int beginLastPage = qMax(qMin(endExtendedVisibleRange + 1, count - 1), count - m_maximumVisibleItems);
1260     for (int i = beginLastPage; i < count; ++i) {
1261         result.append(i);
1262     }
1263
1264     // Add items on the first page.
1265     const int endFirstPage = qMin(qMax(beginExtendedVisibleRange - 1, 0), m_maximumVisibleItems);
1266     for (int i = 0; i <= endFirstPage; ++i) {
1267         result.append(i);
1268     }
1269
1270     // Continue adding items until ResolveAllItemsLimit is reached.
1271     int remainingItems = ResolveAllItemsLimit - result.count();
1272
1273     for (int i = endExtendedVisibleRange + 1; i < beginLastPage && remainingItems > 0; ++i) {
1274         result.append(i);
1275         --remainingItems;
1276     }
1277
1278     for (int i = beginExtendedVisibleRange - 1; i > endFirstPage && remainingItems > 0; --i) {
1279         result.append(i);
1280         --remainingItems;
1281     }
1282
1283     return result;
1284 }
1285
1286 #include "kfileitemmodelrolesupdater.moc"