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 <Nepomuk2/ResourceWatcher>
  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     Q_ASSERT(model);
  97
  98     const KConfigGroup globalConfig(KGlobal::config(), "PreviewSettings");
  99     m_enabledPlugins = globalConfig.readEntry("Plugins", QStringList()
 100                                                          << "directorythumbnail"
 101                                                          << "imagethumbnail"
 102                                                          << "jpegthumbnail");
 103
 104     connect(m_model, SIGNAL(itemsInserted(KItemRangeList)),
 105             this,    SLOT(slotItemsInserted(KItemRangeList)));
 106     connect(m_model, SIGNAL(itemsRemoved(KItemRangeList)),
 107             this,    SLOT(slotItemsRemoved(KItemRangeList)));
 108     connect(m_model, SIGNAL(itemsChanged(KItemRangeList,QSet<QByteArray>)),
 109             this,    SLOT(slotItemsChanged(KItemRangeList,QSet<QByteArray>)));
 110     connect(m_model, SIGNAL(sortRoleChanged(QByteArray,QByteArray)),
 111             this,    SLOT(slotSortRoleChanged(QByteArray,QByteArray)));
 112
 113     // Use a timer to prevent that each call of slotItemsChanged() results in a synchronous
 114     // resolving of the roles. Postpone the resolving until no update has been done for 1 second.
 115     m_changedItemsTimer = new QTimer(this);
 116     m_changedItemsTimer->setInterval(1000);
 117     m_changedItemsTimer->setSingleShot(true);
 118     connect(m_changedItemsTimer, SIGNAL(timeout()), this, SLOT(resolveChangedItems()));
 119
 120     m_resolvableRoles.insert("size");
 121     m_resolvableRoles.insert("type");
 122     m_resolvableRoles.insert("isExpandable");
 123 #ifdef HAVE_NEPOMUK
 124     m_resolvableRoles += KNepomukRolesProvider::instance().roles();
 125 #endif
 126
 127     // When folders are expandable or the item-count is shown for folders, it is necessary
 128     // to watch the number of items of the sub-folder to be able to react on changes.
 129     m_dirWatcher = new KDirWatch(this);
 130     connect(m_dirWatcher, SIGNAL(dirty(QString)), this, SLOT(slotDirWatchDirty(QString)));
 131 }
 132
 133 KFileItemModelRolesUpdater::~KFileItemModelRolesUpdater()
 134 {
 135     resetPendingRoles();
 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 Nepomuk2::ResourceWatcher(this);
 280             connect(m_nepomukResourceWatcher, SIGNAL(propertyChanged(Nepomuk2::Resource,Nepomuk2::Types::Property,QVariantList,QVariantList)),
 281                     this, SLOT(applyChangedNepomukRoles(Nepomuk2::Resource)));
 282             connect(m_nepomukResourceWatcher, SIGNAL(propertyRemoved(Nepomuk2::Resource,Nepomuk2::Types::Property,QVariant)),
 283                     this, SLOT(applyChangedNepomukRoles(Nepomuk2::Resource)));
 284             connect(m_nepomukResourceWatcher, SIGNAL(propertyAdded(Nepomuk2::Resource,Nepomuk2::Types::Property,QVariant)),
 285                     this, SLOT(applyChangedNepomukRoles(Nepomuk2::Resource)));
 286             connect(m_nepomukResourceWatcher, SIGNAL(resourceCreated(Nepomuk2::Resource,QList<QUrl>)),
 287                     this, SLOT(applyChangedNepomukRoles(Nepomuk2::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<Nepomuk2::Resource>());
 355             m_nepomukResourceWatcher->stop();
 356             m_nepomukUriItems.clear();
 357         } else {
 358             QList<Nepomuk2::Resource> newResources;
 359             const QList<Nepomuk2::Resource> oldResources = m_nepomukResourceWatcher->resources();
 360             foreach (const Nepomuk2::Resource& resource, oldResources) {
 361                 const QUrl uri = resource.uri();
 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         QSet<KFileItem>::iterator it = pendingItems.begin();
 545         while (it != pendingItems.end() && !changed && resolvedCount < MaxResolveItemsCount) {
 546             changed = applyResolvedRoles(*it, ResolveAll);
 547             it = pendingItems.erase(it);
 548             ++resolvedCount;
 549         }
 550     }
 551
 552     if (hasPendingRoles()) {
 553         QTimer::singleShot(0, this, SLOT(resolveNextPendingRoles()));
 554     } else {
 555         m_clearPreviews = false;
 556     }
 557
 558     applySortProgressToModel();
 559
 560 #ifdef KFILEITEMMODELROLESUPDATER_DEBUG
 561     static int callCount = 0;
 562     ++callCount;
 563     if (callCount % 100 == 0) {
 564         kDebug() << "Remaining visible roles to resolve:" << m_pendingVisibleItems.count()
 565                  << "invisible:" << m_pendingInvisibleItems.count();
 566     }
 567 #endif
 568 }
 569
 570 void KFileItemModelRolesUpdater::resolveChangedItems()
 571 {
 572     if (m_changedItems.isEmpty()) {
 573         return;
 574     }
 575
 576     KItemRangeList itemRanges;
 577
 578     QSetIterator<KFileItem> it(m_changedItems);
 579     while (it.hasNext()) {
 580         const KFileItem& item = it.next();
 581         const int index = m_model->index(item);
 582         if (index >= 0) {
 583             itemRanges.append(KItemRange(index, 1));
 584         }
 585     }
 586     m_changedItems.clear();
 587
 588     startUpdating(itemRanges);
 589 }
 590
 591 void KFileItemModelRolesUpdater::applyChangedNepomukRoles(const Nepomuk2::Resource& resource)
 592 {
 593 #ifdef HAVE_NEPOMUK
 594     const KUrl itemUrl = m_nepomukUriItems.value(resource.uri());
 595     const KFileItem item = m_model->fileItem(itemUrl);
 596
 597     if (item.isNull()) {
 598         // itemUrl is not in the model anymore, probably because
 599         // the corresponding file has been deleted in the meantime.
 600         return;
 601     }
 602
 603     QHash<QByteArray, QVariant> data = rolesData(item);
 604
 605     const KNepomukRolesProvider& rolesProvider = KNepomukRolesProvider::instance();
 606     QHashIterator<QByteArray, QVariant> it(rolesProvider.roleValues(resource, m_roles));
 607     while (it.hasNext()) {
 608         it.next();
 609         data.insert(it.key(), it.value());
 610     }
 611
 612     disconnect(m_model, SIGNAL(itemsChanged(KItemRangeList,QSet<QByteArray>)),
 613                this,    SLOT(slotItemsChanged(KItemRangeList,QSet<QByteArray>)));
 614     const int index = m_model->index(item);
 615     m_model->setData(index, data);
 616     connect(m_model, SIGNAL(itemsChanged(KItemRangeList,QSet<QByteArray>)),
 617             this,    SLOT(slotItemsChanged(KItemRangeList,QSet<QByteArray>)));
 618 #else
 619 #ifndef Q_CC_MSVC
 620     Q_UNUSED(resource);
 621 #endif
 622 #endif
 623 }
 624
 625 void KFileItemModelRolesUpdater::slotDirWatchDirty(const QString& path)
 626 {
 627     const bool getSizeRole = m_roles.contains("size");
 628     const bool getIsExpandableRole = m_roles.contains("isExpandable");
 629
 630     if (getSizeRole || getIsExpandableRole) {
 631         const int index = m_model->index(KUrl(path));
 632         if (index >= 0) {
 633             QHash<QByteArray, QVariant> data;
 634
 635             const int count = subItemsCount(path);
 636             if (getSizeRole) {
 637                 data.insert("size", count);
 638             }
 639             if (getIsExpandableRole) {
 640                 data.insert("isExpandable", count > 0);
 641             }
 642
 643             m_model->setData(index, data);
 644         }
 645     }
 646 }
 647
 648 void KFileItemModelRolesUpdater::startUpdating(const KItemRangeList& itemRanges)
 649 {
 650     // If no valid index range is given assume that all items are visible.
 651     // A cleanup will be done later as soon as the index range has been set.
 652     const bool hasValidIndexRange = (m_lastVisibleIndex >= 0);
 653
 654     if (hasValidIndexRange) {
 655         // Move all current pending visible items that are not visible anymore
 656         // to the pending invisible items.
 657         QSet<KFileItem>::iterator it = m_pendingVisibleItems.begin();
 658         while (it != m_pendingVisibleItems.end()) {
 659             const KFileItem item = *it;
 660             const int index = m_model->index(item);
 661             if (index < m_firstVisibleIndex || index > m_lastVisibleIndex) {
 662                 it = m_pendingVisibleItems.erase(it);
 663                 m_pendingInvisibleItems.insert(item);
 664             } else {
 665                 ++it;
 666             }
 667         }
 668     }
 669
 670     int rangesCount = 0;
 671
 672     foreach (const KItemRange& range, itemRanges) {
 673         rangesCount += range.count;
 674
 675         // Add the inserted items to the pending visible and invisible items
 676         const int lastIndex = range.index + range.count - 1;
 677         for (int i = range.index; i <= lastIndex; ++i) {
 678             const KFileItem item = m_model->fileItem(i);
 679             if (!hasValidIndexRange || (i >= m_firstVisibleIndex && i <= m_lastVisibleIndex)) {
 680                 m_pendingVisibleItems.insert(item);
 681             } else {
 682                 m_pendingInvisibleItems.insert(item);
 683             }
 684         }
 685     }
 686
 687     resolvePendingRoles();
 688 }
 689
 690 void KFileItemModelRolesUpdater::startPreviewJob(const KFileItemList& items)
 691 {
 692     if (items.isEmpty() || m_paused) {
 693         return;
 694     }
 695
 696     // PreviewJob internally caches items always with the size of
 697     // 128 x 128 pixels or 256 x 256 pixels. A (slow) downscaling is done
 698     // by PreviewJob if a smaller size is requested. For images KFileItemModelRolesUpdater must
 699     // do a downscaling anyhow because of the frame, so in this case only the provided
 700     // cache sizes are requested.
 701     const QSize cacheSize = (m_iconSize.width() > 128) || (m_iconSize.height() > 128)
 702                             ? QSize(256, 256) : QSize(128, 128);
 703
 704     // KIO::filePreview() will request the MIME-type of all passed items, which (in the
 705     // worst case) might block the application for several seconds. To prevent such
 706     // a blocking the MIME-type of the items will determined until the MaxBlockTimeout
 707     // has been reached and only those items will get passed. As soon as the MIME-type
 708     // has been resolved once KIO::PreviewJob() can already access the resolved
 709     // MIME-type in a fast way.
 710     QElapsedTimer timer;
 711     timer.start();
 712
 713     KFileItemList itemSubSet;
 714     const int count = items.count();
 715     itemSubSet.reserve(count);
 716     for (int i = 0; i < count; ++i) {
 717         KFileItem item = items.at(i);
 718         item.determineMimeType();
 719         itemSubSet.append(item);
 720         if (timer.elapsed() > MaxBlockTimeout) {
 721 #ifdef KFILEITEMMODELROLESUPDATER_DEBUG
 722             kDebug() << "Maximum time of" << MaxBlockTimeout << "ms exceeded, creating only previews for"
 723                      << (i + 1) << "items," << (items.count() - (i + 1)) << "will be resolved later";
 724 #endif
 725             break;
 726         }
 727     }
 728     KIO::PreviewJob* job = new KIO::PreviewJob(itemSubSet, cacheSize, &m_enabledPlugins);
 729     job->setIgnoreMaximumSize(items.first().isLocalFile());
 730     if (job->ui()) {
 731         job->ui()->setWindow(qApp->activeWindow());
 732     }
 733
 734     connect(job,  SIGNAL(gotPreview(KFileItem,QPixmap)),
 735             this, SLOT(slotGotPreview(KFileItem,QPixmap)));
 736     connect(job,  SIGNAL(failed(KFileItem)),
 737             this, SLOT(slotPreviewFailed(KFileItem)));
 738     connect(job,  SIGNAL(finished(KJob*)),
 739             this, SLOT(slotPreviewJobFinished(KJob*)));
 740
 741     m_previewJobs.append(job);
 742 }
 743
 744
 745 bool KFileItemModelRolesUpdater::hasPendingRoles() const
 746 {
 747     return !m_pendingVisibleItems.isEmpty() || !m_pendingInvisibleItems.isEmpty();
 748 }
 749
 750 void KFileItemModelRolesUpdater::resolvePendingRoles()
 751 {
 752     int resolvedCount = 0;
 753
 754     bool hasSlowRoles = m_previewShown;
 755     if (!hasSlowRoles) {
 756         QSetIterator<QByteArray> it(m_roles);
 757         while (it.hasNext()) {
 758             if (m_resolvableRoles.contains(it.next())) {
 759                 hasSlowRoles = true;
 760                 break;
 761             }
 762         }
 763     }
 764
 765     const ResolveHint resolveHint = hasSlowRoles ? ResolveFast : ResolveAll;
 766
 767     // Resolving the MIME type can be expensive. Assure that not more than MaxBlockTimeout ms are
 768     // spend for resolving them synchronously. Usually this is more than enough to determine
 769     // all visible items, but there are corner cases where this limit gets easily exceeded.
 770     QElapsedTimer timer;
 771     timer.start();
 772
 773     // Resolve the MIME type of all visible items
 774     QSet<KFileItem>::iterator visibleIt = m_pendingVisibleItems.begin();
 775     while (visibleIt != m_pendingVisibleItems.end()) {
 776         const KFileItem item = *visibleIt;
 777         if (!hasSlowRoles) {
 778             Q_ASSERT(!m_pendingInvisibleItems.contains(item));
 779             // All roles will be resolved by applyResolvedRoles()
 780             visibleIt = m_pendingVisibleItems.erase(visibleIt);
 781         } else {
 782             ++visibleIt;
 783         }
 784         applyResolvedRoles(item, resolveHint);
 785         ++resolvedCount;
 786
 787         if (timer.elapsed() > MaxBlockTimeout) {
 788             break;
 789         }
 790     }
 791
 792     // Resolve the MIME type of the invisible items at least until the timeout
 793     // has been exceeded or the maximum number of items has been reached
 794     KFileItemList invisibleItems;
 795     if (m_lastVisibleIndex >= 0) {
 796         // The visible range is valid, don't care about the order how the MIME
 797         // type of invisible items get resolved
 798         invisibleItems = m_pendingInvisibleItems.toList();
 799     } else {
 800         // The visible range is temporary invalid (e.g. happens when loading
 801         // a directory) so take care to sort the currently invisible items where
 802         // a part will get visible later
 803         invisibleItems = sortedItems(m_pendingInvisibleItems);
 804     }
 805
 806     int index = 0;
 807     while (resolvedCount < MaxResolveItemsCount && index < invisibleItems.count() && timer.elapsed() <= MaxBlockTimeout) {
 808         const KFileItem item = invisibleItems.at(index);
 809         applyResolvedRoles(item, resolveHint);
 810
 811         if (!hasSlowRoles) {
 812             // All roles have been resolved already by applyResolvedRoles()
 813             m_pendingInvisibleItems.remove(item);
 814         }
 815         ++index;
 816         ++resolvedCount;
 817     }
 818
 819     if (m_previewShown) {
 820         KFileItemList items = sortedItems(m_pendingVisibleItems);
 821         items += invisibleItems;
 822         startPreviewJob(items);
 823     } else {
 824         QTimer::singleShot(0, this, SLOT(resolveNextPendingRoles()));
 825     }
 826
 827 #ifdef KFILEITEMMODELROLESUPDATER_DEBUG
 828     if (timer.elapsed() > MaxBlockTimeout) {
 829         kDebug() << "Maximum time of" << MaxBlockTimeout
 830                  << "ms exceeded, skipping items... Remaining visible:" << m_pendingVisibleItems.count()
 831                  << "invisible:" << m_pendingInvisibleItems.count();
 832     }
 833     kDebug() << "[TIME] Resolved pending roles:" << timer.elapsed();
 834 #endif
 835
 836     applySortProgressToModel();
 837 }
 838
 839 void KFileItemModelRolesUpdater::resetPendingRoles()
 840 {
 841     m_pendingVisibleItems.clear();
 842     m_pendingInvisibleItems.clear();
 843
 844     foreach (KJob* job, m_previewJobs) {
 845         job->kill();
 846     }
 847     Q_ASSERT(m_previewJobs.isEmpty());
 848 }
 849
 850 void KFileItemModelRolesUpdater::sortAndResolveAllRoles()
 851 {
 852     if (m_paused) {
 853         return;
 854     }
 855
 856     resetPendingRoles();
 857     Q_ASSERT(m_pendingVisibleItems.isEmpty());
 858     Q_ASSERT(m_pendingInvisibleItems.isEmpty());
 859
 860     if (m_model->count() == 0) {
 861         return;
 862     }
 863
 864     // Determine all visible items
 865     Q_ASSERT(m_firstVisibleIndex >= 0);
 866     for (int i = m_firstVisibleIndex; i <= m_lastVisibleIndex; ++i) {
 867         const KFileItem item = m_model->fileItem(i);
 868         if (!item.isNull()) {
 869             m_pendingVisibleItems.insert(item);
 870         }
 871     }
 872
 873     // Determine all invisible items
 874     for (int i = 0; i < m_firstVisibleIndex; ++i) {
 875         const KFileItem item = m_model->fileItem(i);
 876         if (!item.isNull()) {
 877             m_pendingInvisibleItems.insert(item);
 878         }
 879     }
 880     const int count = m_model->count();
 881     for (int i = m_lastVisibleIndex + 1; i < count; ++i) {
 882         const KFileItem item = m_model->fileItem(i);
 883         if (!item.isNull()) {
 884             m_pendingInvisibleItems.insert(item);
 885         }
 886     }
 887
 888     resolvePendingRoles();
 889 }
 890
 891 void KFileItemModelRolesUpdater::sortAndResolvePendingRoles()
 892 {
 893     Q_ASSERT(!m_paused);
 894     if (m_model->count() == 0) {
 895         return;
 896     }
 897
 898     // If no valid index range is given assume that all items are visible.
 899     // A cleanup will be done later as soon as the index range has been set.
 900     const bool hasValidIndexRange = (m_lastVisibleIndex >= 0);
 901
 902     // Trigger a preview generation of all pending items. Assure that the visible
 903     // pending items get generated first.
 904
 905     // Step 1: Check if any items in m_pendingVisibleItems are not visible any more
 906     //         and move them to m_pendingInvisibleItems.
 907     QSet<KFileItem>::iterator itVisible = m_pendingVisibleItems.begin();
 908     while (itVisible != m_pendingVisibleItems.end()) {
 909         const KFileItem item = *itVisible;
 910         if (item.isNull()) {
 911             itVisible = m_pendingVisibleItems.erase(itVisible);
 912             continue;
 913         }
 914
 915         const int index = m_model->index(item);
 916         if (!hasValidIndexRange || (index >= m_firstVisibleIndex && index <= m_lastVisibleIndex)) {
 917             ++itVisible;
 918         } else {
 919             itVisible = m_pendingVisibleItems.erase(itVisible);
 920             m_pendingInvisibleItems.insert(item);
 921         }
 922     }
 923
 924     // Step 2: Check if any items in m_pendingInvisibleItems have become visible
 925     //         and move them to m_pendingVisibleItems.
 926     QSet<KFileItem>::iterator itInvisible = m_pendingInvisibleItems.begin();
 927     while (itInvisible != m_pendingInvisibleItems.end()) {
 928         const KFileItem item = *itInvisible;
 929         if (item.isNull()) {
 930             itInvisible = m_pendingInvisibleItems.erase(itInvisible);
 931             continue;
 932         }
 933
 934         const int index = m_model->index(item);
 935         if (!hasValidIndexRange || (index >= m_firstVisibleIndex && index <= m_lastVisibleIndex)) {
 936             itInvisible = m_pendingInvisibleItems.erase(itInvisible);
 937             m_pendingVisibleItems.insert(item);
 938         } else {
 939             ++itInvisible;
 940         }
 941     }
 942
 943     resolvePendingRoles();
 944 }
 945
 946 void KFileItemModelRolesUpdater::applySortProgressToModel()
 947 {
 948     if (m_sortingProgress < 0) {
 949         return;
 950     }
 951
 952     // Inform the model about the progress of the resolved items,
 953     // so that it can give an indication when the sorting has been finished.
 954     const int resolvedCount = m_model->count()
 955                               - m_pendingVisibleItems.count()
 956                               - m_pendingInvisibleItems.count();
 957     if (resolvedCount > 0) {
 958         m_model->emitSortProgress(resolvedCount);
 959         if (resolvedCount == m_model->count()) {
 960             m_sortingProgress = -1;
 961         }
 962     }
 963 }
 964
 965 void KFileItemModelRolesUpdater::updateSortProgress()
 966 {
 967     const QByteArray sortRole = m_model->sortRole();
 968
 969     // Optimization if the sorting is done by type: In case if all MIME-types
 970     // are known, the types have been resolved already by KFileItemModel and
 971     // no sort-progress feedback is required.
 972     const bool showProgress = (sortRole == "type")
 973                               ? hasUnknownMimeTypes()
 974                               : m_resolvableRoles.contains(sortRole);
 975
 976     if (m_sortingProgress >= 0) {
 977         // Mark the current sorting as finished
 978         m_model->emitSortProgress(m_model->count());
 979     }
 980     m_sortingProgress = showProgress ? 0 : -1;
 981 }
 982
 983 bool KFileItemModelRolesUpdater::hasUnknownMimeTypes() const
 984 {
 985     const int count = m_model->count();
 986     for (int i = 0; i < count; ++i) {
 987         const KFileItem item = m_model->fileItem(i);
 988         if (!item.isMimeTypeKnown()) {
 989             return true;
 990         }
 991     }
 992
 993     return false;
 994 }
 995
 996 bool KFileItemModelRolesUpdater::applyResolvedRoles(const KFileItem& item, ResolveHint hint)
 997 {
 998     if (item.isNull()) {
 999         return false;
1000     }
1001
1002     const bool resolveAll = (hint == ResolveAll);
1003
1004     bool mimeTypeChanged = false;
1005     if (!item.isMimeTypeKnown()) {
1006         item.determineMimeType();
1007         mimeTypeChanged = true;
1008     }
1009
1010     if (mimeTypeChanged || resolveAll || m_clearPreviews) {
1011         const int index = m_model->index(item);
1012         if (index < 0) {
1013             return false;
1014         }
1015
1016         QHash<QByteArray, QVariant> data;
1017         if (resolveAll) {
1018             data = rolesData(item);
1019         }
1020
1021         data.insert("iconName", item.iconName());
1022
1023         if (m_clearPreviews) {
1024             data.insert("iconPixmap", QPixmap());
1025         }
1026
1027         disconnect(m_model, SIGNAL(itemsChanged(KItemRangeList,QSet<QByteArray>)),
1028                    this,    SLOT(slotItemsChanged(KItemRangeList,QSet<QByteArray>)));
1029         m_model->setData(index, data);
1030         connect(m_model, SIGNAL(itemsChanged(KItemRangeList,QSet<QByteArray>)),
1031                 this,    SLOT(slotItemsChanged(KItemRangeList,QSet<QByteArray>)));
1032         return true;
1033     }
1034
1035     return false;
1036 }
1037
1038 QHash<QByteArray, QVariant> KFileItemModelRolesUpdater::rolesData(const KFileItem& item) const
1039 {
1040     QHash<QByteArray, QVariant> data;
1041
1042     const bool getSizeRole = m_roles.contains("size");
1043     const bool getIsExpandableRole = m_roles.contains("isExpandable");
1044
1045     if ((getSizeRole || getIsExpandableRole) && item.isDir()) {
1046         if (item.isLocalFile()) {
1047             const QString path = item.localPath();
1048             const int count = subItemsCount(path);
1049             if (getSizeRole) {
1050                 data.insert("size", count);
1051             }
1052             if (getIsExpandableRole) {
1053                 data.insert("isExpandable", count > 0);
1054             }
1055
1056             if (!m_dirWatcher->contains(path)) {
1057                 m_dirWatcher->addDir(path);
1058                 m_watchedDirs.insert(path);
1059             }
1060         } else if (getSizeRole) {
1061             data.insert("size", -1); // -1 indicates an unknown number of items
1062         }
1063     }
1064
1065     if (m_roles.contains("type")) {
1066         data.insert("type", item.mimeComment());
1067     }
1068
1069     data.insert("iconOverlays", item.overlays());
1070
1071 #ifdef HAVE_NEPOMUK
1072     if (m_nepomukResourceWatcher) {
1073         const KNepomukRolesProvider& rolesProvider = KNepomukRolesProvider::instance();
1074         Nepomuk2::Resource resource(item.nepomukUri());
1075         QHashIterator<QByteArray, QVariant> it(rolesProvider.roleValues(resource, m_roles));
1076         while (it.hasNext()) {
1077             it.next();
1078             data.insert(it.key(), it.value());
1079         }
1080
1081         QUrl uri = resource.uri();
1082         if (uri.isEmpty()) {
1083             // TODO: Is there another way to explicitly create a resource?
1084             // We need a resource to be able to track it for changes.
1085             resource.setRating(0);
1086             uri = resource.uri();
1087         }
1088         if (!uri.isEmpty() && !m_nepomukUriItems.contains(uri)) {
1089             m_nepomukResourceWatcher->addResource(resource);
1090
1091             if (m_nepomukUriItems.isEmpty()) {
1092                 m_nepomukResourceWatcher->start();
1093             }
1094
1095             m_nepomukUriItems.insert(uri, item.url());
1096         }
1097     }
1098 #endif
1099
1100     return data;
1101 }
1102
1103 KFileItemList KFileItemModelRolesUpdater::sortedItems(const QSet<KFileItem>& items) const
1104 {
1105     KFileItemList itemList;
1106     if (items.isEmpty()) {
1107         return itemList;
1108     }
1109
1110 #ifdef KFILEITEMMODELROLESUPDATER_DEBUG
1111     QElapsedTimer timer;
1112     timer.start();
1113 #endif
1114
1115     QList<int> indexes;
1116     indexes.reserve(items.count());
1117
1118     QSetIterator<KFileItem> it(items);
1119     while (it.hasNext()) {
1120         const KFileItem item = it.next();
1121         const int index = m_model->index(item);
1122         if (index >= 0) {
1123             indexes.append(index);
1124         }
1125     }
1126     qSort(indexes);
1127
1128     itemList.reserve(items.count());
1129     foreach (int index, indexes) {
1130         itemList.append(m_model->fileItem(index));
1131     }
1132
1133 #ifdef KFILEITEMMODELROLESUPDATER_DEBUG
1134     kDebug() << "[TIME] Sorting of items:" << timer.elapsed();
1135 #endif
1136     return itemList;
1137 }
1138
1139 int KFileItemModelRolesUpdater::subItemsCount(const QString& path) const
1140 {
1141     const bool countHiddenFiles = m_model->showHiddenFiles();
1142     const bool showFoldersOnly  = m_model->showDirectoriesOnly();
1143
1144 #ifdef Q_WS_WIN
1145     QDir dir(path);
1146     QDir::Filters filters = QDir::NoDotAndDotDot | QDir::System;
1147     if (countHiddenFiles) {
1148         filters |= QDir::Hidden;
1149     }
1150     if (showFoldersOnly) {
1151         filters |= QDir::Dirs;
1152     } else {
1153         filters |= QDir::AllEntries;
1154     }
1155     return dir.entryList(filters).count();
1156 #else
1157     // Taken from kdelibs/kio/kio/kdirmodel.cpp
1158     // Copyright (C) 2006 David Faure <faure@kde.org>
1159
1160     int count = -1;
1161     DIR* dir = ::opendir(QFile::encodeName(path));
1162     if (dir) {  // krazy:exclude=syscalls
1163         count = 0;
1164         struct dirent *dirEntry = 0;
1165         while ((dirEntry = ::readdir(dir))) {
1166             if (dirEntry->d_name[0] == '.') {
1167                 if (dirEntry->d_name[1] == '\0' || !countHiddenFiles) {
1168                     // Skip "." or hidden files
1169                     continue;
1170                 }
1171                 if (dirEntry->d_name[1] == '.' && dirEntry->d_name[2] == '\0') {
1172                     // Skip ".."
1173                     continue;
1174                 }
1175             }
1176
1177             // If only directories are counted, consider an unknown file type and links also
1178             // as directory instead of trying to do an expensive stat()
1179             // (see bugs 292642 and 299997).
1180             const bool countEntry = !showFoldersOnly ||
1181                                     dirEntry->d_type == DT_DIR ||
1182                                     dirEntry->d_type == DT_LNK ||
1183                                     dirEntry->d_type == DT_UNKNOWN;
1184             if (countEntry) {
1185                 ++count;
1186             }
1187         }
1188         ::closedir(dir);
1189     }
1190     return count;
1191 #endif
1192 }
1193
1194 void KFileItemModelRolesUpdater::updateAllPreviews()
1195 {
1196     if (m_paused) {
1197         m_previewChangedDuringPausing = true;
1198     } else {
1199         sortAndResolveAllRoles();
1200     }
1201 }
1202
1203 #include "kfileitemmodelrolesupdater.moc"