#include "kfileitemmodelrolesupdater.h"
+#include "dolphindebug.h"
#include "kfileitemmodel.h"
#include "private/kdirectorycontentscounter.h"
#include "private/kpixmapmodifier.h"
#include <KConfig>
#include <KConfigGroup>
-#include <KIO/JobUiDelegate>
#include <KIO/PreviewJob>
#include <KIconLoader>
#include <KJobWidgets>
#include <KOverlayIconPlugin>
-#include <KPluginLoader>
+#include <KPluginMetaData>
#include <KSharedConfig>
-#ifdef HAVE_BALOO
+#if HAVE_BALOO
#include "private/kbaloorolesprovider.h"
#include <Baloo/File>
#include <Baloo/FileMonitor>
#endif
#include <QApplication>
-#include <QIcon>
-#include <QPainter>
#include <QElapsedTimer>
+#include <QFileInfo>
+#include <QPainter>
+#include <QPluginLoader>
#include <QTimer>
// #define KFILEITEMMODELROLESUPDATER_DEBUG
m_pendingIndexes(),
m_pendingPreviewItems(),
m_previewJob(),
+ m_hoverSequenceItem(),
+ m_hoverSequenceIndex(0),
+ m_hoverSequencePreviewJob(nullptr),
+ m_hoverSequenceNumSuccessiveFailures(0),
m_recentlyChangedItemsTimer(nullptr),
m_recentlyChangedItems(),
m_changedItems(),
m_directoryContentsCounter(nullptr)
- #ifdef HAVE_BALOO
+ #if HAVE_BALOO
, m_balooFileMonitor(nullptr)
#endif
{
m_resolvableRoles.insert("size");
m_resolvableRoles.insert("type");
m_resolvableRoles.insert("isExpandable");
-#ifdef HAVE_BALOO
+#if HAVE_BALOO
m_resolvableRoles += KBalooRolesProvider::instance().roles();
#endif
connect(m_directoryContentsCounter, &KDirectoryContentsCounter::result,
this, &KFileItemModelRolesUpdater::slotDirectoryContentsCountReceived);
- const auto plugins = KPluginLoader::instantiatePlugins(QStringLiteral("kf5/overlayicon"), nullptr, qApp);
- for (QObject *it : plugins) {
- auto plugin = qobject_cast<KOverlayIconPlugin*>(it);
+ const auto plugins = KPluginMetaData::findPlugins(QStringLiteral("kf" QT_STRINGIFY(QT_VERSION_MAJOR)) + QStringLiteral("/overlayicon"));
+ for (const KPluginMetaData &data : plugins) {
+ auto instance = QPluginLoader(data.fileName()).instance();
+ auto plugin = qobject_cast<KOverlayIconPlugin *>(instance);
if (plugin) {
m_overlayIconsPlugin.append(plugin);
connect(plugin, &KOverlayIconPlugin::overlaysChanged, this, &KFileItemModelRolesUpdater::slotOverlaysChanged);
} else {
// not our/valid plugin, so delete the created object
- it->deleteLater();
+ delete instance;
}
}
}
if (m_roles != roles) {
m_roles = roles;
-#ifdef HAVE_BALOO
+#if HAVE_BALOO
// Check whether there is at least one role that must be resolved
// with the help of Baloo. If this is the case, a (quite expensive)
// resolving will be done in KFileItemModelRolesUpdater::rolesData() and
return m_scanDirectories;
}
+void KFileItemModelRolesUpdater::setHoverSequenceState(const QUrl& itemUrl, int seqIdx)
+{
+ const KFileItem item = m_model->fileItem(itemUrl);
+
+ if (item != m_hoverSequenceItem) {
+ killHoverSequencePreviewJob();
+ }
+
+ m_hoverSequenceItem = item;
+ m_hoverSequenceIndex = seqIdx;
+
+ if (!m_previewShown) {
+ return;
+ }
+
+ m_hoverSequenceNumSuccessiveFailures = 0;
+
+ loadNextHoverSequencePreview();
+}
+
void KFileItemModelRolesUpdater::slotItemsInserted(const KItemRangeList& itemRanges)
{
QElapsedTimer timer;
const bool allItemsRemoved = (m_model->count() == 0);
-#ifdef HAVE_BALOO
+#if HAVE_BALOO
if (m_balooFileMonitor) {
// Don't let the FileWatcher watch for removed items
if (allItemsRemoved) {
m_recentlyChangedItems.clear();
m_recentlyChangedItemsTimer->stop();
m_changedItems.clear();
+ m_hoverSequenceLoadedItems.clear();
killPreviewJob();
} else {
}
}
+ // Removed items won't have hover previews loaded anymore.
+ for (const KItemRange& itemRange : itemRanges) {
+ int index = itemRange.index;
+ for (int count = itemRange.count; count > 0; --count) {
+ const KFileItem item = m_model->fileItem(index);
+ m_hoverSequenceLoadedItems.remove(item);
+ ++index;
+ }
+ }
+
// The visible items might have changed.
startUpdating();
}
return;
}
- QPixmap scaledPixmap = pixmap;
-
- if (!pixmap.hasAlpha() && !pixmap.isNull()
- && m_iconSize.width() > KIconLoader::SizeSmallMedium
- && m_iconSize.height() > KIconLoader::SizeSmallMedium) {
- if (m_enlargeSmallPreviews) {
- KPixmapModifier::applyFrame(scaledPixmap, m_iconSize);
- } else {
- // Assure that small previews don't get enlarged. Instead they
- // should be shown centered within the frame.
- const QSize contentSize = KPixmapModifier::sizeInsideFrame(m_iconSize);
- const bool enlargingRequired = scaledPixmap.width() < contentSize.width() &&
- scaledPixmap.height() < contentSize.height();
- if (enlargingRequired) {
- QSize frameSize = scaledPixmap.size() / scaledPixmap.devicePixelRatio();
- frameSize.scale(m_iconSize, Qt::KeepAspectRatio);
-
- QPixmap largeFrame(frameSize);
- largeFrame.fill(Qt::transparent);
-
- KPixmapModifier::applyFrame(largeFrame, frameSize);
-
- QPainter painter(&largeFrame);
- painter.drawPixmap((largeFrame.width() - scaledPixmap.width() / scaledPixmap.devicePixelRatio()) / 2,
- (largeFrame.height() - scaledPixmap.height() / scaledPixmap.devicePixelRatio()) / 2,
- scaledPixmap);
- scaledPixmap = largeFrame;
- } else {
- // The image must be shrunk as it is too large to fit into
- // the available icon size
- KPixmapModifier::applyFrame(scaledPixmap, m_iconSize);
- }
- }
- } else if (!pixmap.isNull()) {
- KPixmapModifier::scale(scaledPixmap, m_iconSize * qApp->devicePixelRatio());
- scaledPixmap.setDevicePixelRatio(qApp->devicePixelRatio());
- }
+ QPixmap scaledPixmap = transformPreviewPixmap(pixmap);
QHash<QByteArray, QVariant> data = rolesData(item);
}
}
+void KFileItemModelRolesUpdater::slotHoverSequenceGotPreview(const KFileItem& item, const QPixmap& pixmap)
+{
+ const int index = m_model->index(item);
+ if (index < 0) {
+ return;
+ }
+
+ QHash<QByteArray, QVariant> data = m_model->data(index);
+ QVector<QPixmap> pixmaps = data["hoverSequencePixmaps"].value<QVector<QPixmap>>();
+ const int loadedIndex = pixmaps.size();
+
+ float wap = m_hoverSequencePreviewJob->sequenceIndexWraparoundPoint();
+ if (!m_hoverSequencePreviewJob->handlesSequences()) {
+ wap = 1.0f;
+ }
+ if (wap >= 0.0f) {
+ data["hoverSequenceWraparoundPoint"] = wap;
+ m_model->setData(index, data);
+ }
+
+ // For hover sequence previews we never load index 0, because that's just the regular preview
+ // in "iconPixmap". But that means we'll load index 1 even for thumbnailers that don't support
+ // sequences, in which case we can just throw away the preview because it's the same as for
+ // index 0. Unfortunately we can't find it out earlier :(
+ if (wap < 0.0f || loadedIndex < static_cast<int>(wap)) {
+ // Add the preview to the model data
+
+ const QPixmap scaledPixmap = transformPreviewPixmap(pixmap);
+
+ pixmaps.append(scaledPixmap);
+ data["hoverSequencePixmaps"] = QVariant::fromValue(pixmaps);
+
+ m_model->setData(index, data);
+
+ const auto loadedIt = std::find(m_hoverSequenceLoadedItems.begin(),
+ m_hoverSequenceLoadedItems.end(), item);
+ if (loadedIt == m_hoverSequenceLoadedItems.end()) {
+ m_hoverSequenceLoadedItems.push_back(item);
+ trimHoverSequenceLoadedItems();
+ }
+ }
+
+ m_hoverSequenceNumSuccessiveFailures = 0;
+}
+
+void KFileItemModelRolesUpdater::slotHoverSequencePreviewFailed(const KFileItem& item)
+{
+ const int index = m_model->index(item);
+ if (index < 0) {
+ return;
+ }
+
+ static const int numRetries = 2;
+
+ QHash<QByteArray, QVariant> data = m_model->data(index);
+ QVector<QPixmap> pixmaps = data["hoverSequencePixmaps"].value<QVector<QPixmap>>();
+
+ qCDebug(DolphinDebug).nospace()
+ << "Failed to generate hover sequence preview #" << pixmaps.size()
+ << " for file " << item.url().toString()
+ << " (attempt " << (m_hoverSequenceNumSuccessiveFailures+1)
+ << "/" << (numRetries+1) << ")";
+
+ if (m_hoverSequenceNumSuccessiveFailures >= numRetries) {
+ // Give up and simply duplicate the previous sequence image (if any)
+
+ pixmaps.append(pixmaps.empty() ? QPixmap() : pixmaps.last());
+ data["hoverSequencePixmaps"] = QVariant::fromValue(pixmaps);
+
+ if (!data.contains("hoverSequenceWraparoundPoint")) {
+ // hoverSequenceWraparoundPoint is only available when PreviewJob succeeds, so unless
+ // it has previously succeeded, it's best to assume that it just doesn't handle
+ // sequences instead of trying to load the next image indefinitely.
+ data["hoverSequenceWraparoundPoint"] = 1.0f;
+ }
+
+ m_model->setData(index, data);
+
+ m_hoverSequenceNumSuccessiveFailures = 0;
+ } else {
+ // Retry
+
+ m_hoverSequenceNumSuccessiveFailures++;
+ }
+
+ // Next image in the sequence (or same one if the retry limit wasn't reached yet) will be
+ // loaded automatically, because slotHoverSequencePreviewJobFinished() will be triggered
+ // even when PreviewJob fails.
+}
+
+void KFileItemModelRolesUpdater::slotHoverSequencePreviewJobFinished()
+{
+ const int index = m_model->index(m_hoverSequenceItem);
+ if (index < 0) {
+ m_hoverSequencePreviewJob = nullptr;
+ return;
+ }
+
+ // Since a PreviewJob can only have one associated sequence index, we can only generate
+ // one sequence image per job, so we have to start another one for the next index.
+
+ // Load the next image in the sequence
+ m_hoverSequencePreviewJob = nullptr;
+ loadNextHoverSequencePreview();
+}
+
void KFileItemModelRolesUpdater::resolveNextSortRole()
{
if (m_state != ResolvingSortRole) {
if (m_finishedItems.count() != m_model->count()) {
QHash<QByteArray, QVariant> data;
data.insert("iconPixmap", QPixmap());
+ data.insert("hoverSequencePixmaps", QVariant::fromValue(QVector<QPixmap>()));
disconnect(m_model, &KFileItemModel::itemsChanged,
this, &KFileItemModelRolesUpdater::slotItemsChanged);
for (int index = 0; index <= m_model->count(); ++index) {
- if (m_model->data(index).contains("iconPixmap")) {
+ if (m_model->data(index).contains("iconPixmap") ||
+ m_model->data(index).contains("hoverSequencePixmaps"))
+ {
m_model->setData(index, data);
}
}
void KFileItemModelRolesUpdater::applyChangedBalooRoles(const QString& file)
{
-#ifdef HAVE_BALOO
+#if HAVE_BALOO
const KFileItem item = m_model->fileItem(QUrl::fromLocalFile(file));
if (item.isNull()) {
void KFileItemModelRolesUpdater::applyChangedBalooRolesForItem(const KFileItem &item)
{
-#ifdef HAVE_BALOO
+#if HAVE_BALOO
Baloo::File file(item.localPath());
file.load();
if (getSizeRole) {
data.insert("count", count);
- if (size != -1) {
- data.insert("size", QVariant::fromValue(size));
- }
+ data.insert("size", QVariant::fromValue(size));
}
if (getIsExpandableRole) {
data.insert("isExpandable", count > 0);
}
+ disconnect(m_model, &KFileItemModel::itemsChanged,
+ this, &KFileItemModelRolesUpdater::slotItemsChanged);
m_model->setData(index, data);
+ connect(m_model, &KFileItemModel::itemsChanged,
+ this, &KFileItemModelRolesUpdater::slotItemsChanged);
}
}
}
KIO::PreviewJob* job = new KIO::PreviewJob(itemSubSet, cacheSize, &m_enabledPlugins);
- job->setIgnoreMaximumSize(itemSubSet.first().isLocalFile() && m_localFileSizePreviewLimit <= 0);
+ job->setIgnoreMaximumSize(itemSubSet.first().isLocalFile() && !itemSubSet.first().isSlow() && m_localFileSizePreviewLimit <= 0);
if (job->uiDelegate()) {
KJobWidgets::setWindow(job, qApp->activeWindow());
}
m_previewJob = job;
}
+QPixmap KFileItemModelRolesUpdater::transformPreviewPixmap(const QPixmap& pixmap)
+{
+ QPixmap scaledPixmap = pixmap;
+
+ if (!pixmap.hasAlpha() && !pixmap.isNull()
+ && m_iconSize.width() > KIconLoader::SizeSmallMedium
+ && m_iconSize.height() > KIconLoader::SizeSmallMedium) {
+ if (m_enlargeSmallPreviews) {
+ KPixmapModifier::applyFrame(scaledPixmap, m_iconSize);
+ } else {
+ // Assure that small previews don't get enlarged. Instead they
+ // should be shown centered within the frame.
+ const QSize contentSize = KPixmapModifier::sizeInsideFrame(m_iconSize);
+ const bool enlargingRequired = scaledPixmap.width() < contentSize.width() &&
+ scaledPixmap.height() < contentSize.height();
+ if (enlargingRequired) {
+ QSize frameSize = scaledPixmap.size() / scaledPixmap.devicePixelRatio();
+ frameSize.scale(m_iconSize, Qt::KeepAspectRatio);
+
+ QPixmap largeFrame(frameSize);
+ largeFrame.fill(Qt::transparent);
+
+ KPixmapModifier::applyFrame(largeFrame, frameSize);
+
+ QPainter painter(&largeFrame);
+ painter.drawPixmap((largeFrame.width() - scaledPixmap.width() / scaledPixmap.devicePixelRatio()) / 2,
+ (largeFrame.height() - scaledPixmap.height() / scaledPixmap.devicePixelRatio()) / 2,
+ scaledPixmap);
+ scaledPixmap = largeFrame;
+ } else {
+ // The image must be shrunk as it is too large to fit into
+ // the available icon size
+ KPixmapModifier::applyFrame(scaledPixmap, m_iconSize);
+ }
+ }
+ } else if (!pixmap.isNull()) {
+ KPixmapModifier::scale(scaledPixmap, m_iconSize * qApp->devicePixelRatio());
+ scaledPixmap.setDevicePixelRatio(qApp->devicePixelRatio());
+ }
+
+ return scaledPixmap;
+}
+
+void KFileItemModelRolesUpdater::loadNextHoverSequencePreview()
+{
+ if (m_hoverSequenceItem.isNull() || m_hoverSequencePreviewJob) {
+ return;
+ }
+
+ const int index = m_model->index(m_hoverSequenceItem);
+ if (index < 0) {
+ return;
+ }
+
+ // We generate the next few sequence indices in advance (buffering)
+ const int maxSeqIdx = m_hoverSequenceIndex+5;
+
+ QHash<QByteArray, QVariant> data = m_model->data(index);
+
+ if (!data.contains("hoverSequencePixmaps")) {
+ // The pixmap at index 0 isn't used ("iconPixmap" will be used instead)
+ data.insert("hoverSequencePixmaps", QVariant::fromValue(QVector<QPixmap>() << QPixmap()));
+ m_model->setData(index, data);
+ }
+
+ const QVector<QPixmap> pixmaps = data["hoverSequencePixmaps"].value<QVector<QPixmap>>();
+
+ const int loadSeqIdx = pixmaps.size();
+
+ float wap = -1.0f;
+ if (data.contains("hoverSequenceWraparoundPoint")) {
+ wap = data["hoverSequenceWraparoundPoint"].toFloat();
+ }
+ if (wap >= 1.0f && loadSeqIdx >= static_cast<int>(wap)) {
+ // Reached the wraparound point -> no more previews to load.
+ return;
+ }
+
+ if (loadSeqIdx > maxSeqIdx) {
+ // Wait until setHoverSequenceState() is called with a higher sequence index.
+ return;
+ }
+
+ // PreviewJob internally caches items always with the size of
+ // 128 x 128 pixels or 256 x 256 pixels. A (slow) downscaling is done
+ // by PreviewJob if a smaller size is requested. For images KFileItemModelRolesUpdater must
+ // do a downscaling anyhow because of the frame, so in this case only the provided
+ // cache sizes are requested.
+ const QSize cacheSize = (m_iconSize.width() > 128) || (m_iconSize.height() > 128)
+ ? QSize(256, 256) : QSize(128, 128);
+
+ KIO::PreviewJob* job = new KIO::PreviewJob({m_hoverSequenceItem}, cacheSize, &m_enabledPlugins);
+
+ job->setSequenceIndex(loadSeqIdx);
+ job->setIgnoreMaximumSize(m_hoverSequenceItem.isLocalFile() && !m_hoverSequenceItem.isSlow() && m_localFileSizePreviewLimit <= 0);
+ if (job->uiDelegate()) {
+ KJobWidgets::setWindow(job, qApp->activeWindow());
+ }
+
+ connect(job, &KIO::PreviewJob::gotPreview,
+ this, &KFileItemModelRolesUpdater::slotHoverSequenceGotPreview);
+ connect(job, &KIO::PreviewJob::failed,
+ this, &KFileItemModelRolesUpdater::slotHoverSequencePreviewFailed);
+ connect(job, &KIO::PreviewJob::finished,
+ this, &KFileItemModelRolesUpdater::slotHoverSequencePreviewJobFinished);
+
+ m_hoverSequencePreviewJob = job;
+}
+
+void KFileItemModelRolesUpdater::killHoverSequencePreviewJob()
+{
+ if (m_hoverSequencePreviewJob) {
+ disconnect(m_hoverSequencePreviewJob, &KIO::PreviewJob::gotPreview,
+ this, &KFileItemModelRolesUpdater::slotHoverSequenceGotPreview);
+ disconnect(m_hoverSequencePreviewJob, &KIO::PreviewJob::failed,
+ this, &KFileItemModelRolesUpdater::slotHoverSequencePreviewFailed);
+ disconnect(m_hoverSequencePreviewJob, &KIO::PreviewJob::finished,
+ this, &KFileItemModelRolesUpdater::slotHoverSequencePreviewJobFinished);
+ m_hoverSequencePreviewJob->kill();
+ m_hoverSequencePreviewJob = nullptr;
+ }
+}
+
void KFileItemModelRolesUpdater::updateChangedItems()
{
if (m_state == Paused) {
QList<int> visibleChangedIndexes;
QList<int> invisibleChangedIndexes;
+ visibleChangedIndexes.reserve(m_changedItems.size());
+ invisibleChangedIndexes.reserve(m_changedItems.size());
- // Iterate over a const copy because items are deleted within the loop
- const auto changedItems = m_changedItems;
- for (const KFileItem item : changedItems) {
+ auto changedItemsIt = m_changedItems.begin();
+ while (changedItemsIt != m_changedItems.end()) {
+ const auto& item = *changedItemsIt;
const int index = m_model->index(item);
if (index < 0) {
- m_changedItems.remove(item);
+ changedItemsIt = m_changedItems.erase(changedItemsIt);
continue;
}
+ ++changedItemsIt;
if (index >= m_firstVisibleIndex && index <= m_lastVisibleIndex) {
visibleChangedIndexes.append(index);
data = rolesData(item);
}
- if (QIcon::hasThemeIcon(item.iconName())) {
+ if (!item.iconName().isEmpty()) {
data.insert("iconName", item.iconName());
}
if (m_clearPreviews) {
data.insert("iconPixmap", QPixmap());
+ data.insert("hoverSequencePixmaps", QVariant::fromValue(QVector<QPixmap>()));
}
disconnect(m_model, &KFileItemModel::itemsChanged,
const bool getIsExpandableRole = m_roles.contains("isExpandable");
if ((getSizeRole || getIsExpandableRole) && item.isDir()) {
- if (item.isLocalFile() && !item.isSlow()) {
+ if (item.isLocalFile()) {
// Tell m_directoryContentsCounter that we want to count the items
// inside the directory. The result will be received in slotDirectoryContentsCountReceived.
if (m_scanDirectories) {
}
}
+ if (m_roles.contains("extension")) {
+ data.insert("extension", QFileInfo(item.name()).suffix());
+ }
+
if (m_roles.contains("type")) {
data.insert("type", item.mimeComment());
}
for (KOverlayIconPlugin *it : qAsConst(m_overlayIconsPlugin)) {
overlays.append(it->getOverlays(item.url()));
}
- data.insert("iconOverlays", overlays);
+ if (!overlays.isEmpty()) {
+ data.insert("iconOverlays", overlays);
+ }
-#ifdef HAVE_BALOO
+#if HAVE_BALOO
if (m_balooFileMonitor) {
m_balooFileMonitor->addFile(item.localPath());
applyChangedBalooRolesForItem(item);
const int count = m_model->count();
QList<int> result;
- result.reserve(ResolveAllItemsLimit);
+ result.reserve(qMin(count, (m_lastVisibleIndex - m_firstVisibleIndex + 1) +
+ ResolveAllItemsLimit +
+ (2 * m_maximumVisibleItems)));
// Add visible items.
+ // Resolve files first, their previews are quicker.
+ QList<int> visibleDirs;
for (int i = m_firstVisibleIndex; i <= m_lastVisibleIndex; ++i) {
- result.append(i);
+ const KFileItem item = m_model->fileItem(i);
+ if (item.isDir()) {
+ visibleDirs.append(i);
+ } else {
+ result.append(i);
+ }
}
+ result.append(visibleDirs);
+
// We need a reasonable upper limit for number of items to resolve after
// and before the visible range. m_maximumVisibleItems can be quite large
// when using Compact View.
}
// Add items on the last page.
- const int beginLastPage = qMax(qMin(endExtendedVisibleRange + 1, count - 1), count - m_maximumVisibleItems);
+ const int beginLastPage = qMax(endExtendedVisibleRange + 1, count - m_maximumVisibleItems);
for (int i = beginLastPage; i < count; ++i) {
result.append(i);
}
// Add items on the first page.
- const int endFirstPage = qMin(qMax(beginExtendedVisibleRange - 1, 0), m_maximumVisibleItems);
- for (int i = 0; i <= endFirstPage; ++i) {
+ const int endFirstPage = qMin(beginExtendedVisibleRange, m_maximumVisibleItems);
+ for (int i = 0; i < endFirstPage; ++i) {
result.append(i);
}
--remainingItems;
}
- for (int i = beginExtendedVisibleRange - 1; i > endFirstPage && remainingItems > 0; --i) {
+ for (int i = beginExtendedVisibleRange - 1; i >= endFirstPage && remainingItems > 0; --i) {
result.append(i);
--remainingItems;
}
return result;
}
+void KFileItemModelRolesUpdater::trimHoverSequenceLoadedItems()
+{
+ static const size_t maxLoadedItems = 20;
+
+ size_t loadedItems = m_hoverSequenceLoadedItems.size();
+ while (loadedItems > maxLoadedItems) {
+ const KFileItem item = m_hoverSequenceLoadedItems.front();
+
+ m_hoverSequenceLoadedItems.pop_front();
+ loadedItems--;
+
+ const int index = m_model->index(item);
+ if (index >= 0) {
+ QHash<QByteArray, QVariant> data = m_model->data(index);
+ data["hoverSequencePixmaps"] = QVariant::fromValue(QVector<QPixmap>() << QPixmap());
+ m_model->setData(index, data);
+ }
+ }
+}
+
projects / dolphin.git / blobdiff