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