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