-/***************************************************************************
- * Copyright (C) 2009 by Peter Penz <peter.penz19@gmail.com> *
- * *
- * This program is free software; you can redistribute it and/or modify *
- * it under the terms of the GNU General Public License as published by *
- * the Free Software Foundation; either version 2 of the License, or *
- * (at your option) any later version. *
- * *
- * This program is distributed in the hope that it will be useful, *
- * but WITHOUT ANY WARRANTY; without even the implied warranty of *
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
- * GNU General Public License for more details. *
- * *
- * You should have received a copy of the GNU General Public License *
- * along with this program; if not, write to the *
- * Free Software Foundation, Inc., *
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
- ***************************************************************************/
+/*
+ * SPDX-FileCopyrightText: 2009 Peter Penz <peter.penz19@gmail.com>
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
#include "versioncontrolobserver.h"
#include "dolphin_versioncontrolsettings.h"
-
-#include <KDirLister>
-#include <KLocale>
-#include <KService>
-#include <KServiceTypeTrader>
-#include <kversioncontrolplugin.h>
-
-#include "pendingthreadsmaintainer.h"
+#include "dolphindebug.h"
+#include "views/dolphinview.h"
+#include "kitemviews/kfileitemmodel.h"
#include "updateitemstatesthread.h"
-#include <QAbstractProxyModel>
-#include <QAbstractItemView>
-#include <QMutexLocker>
-#include <QTimer>
+#include <KLocalizedString>
+#include <KPluginFactory>
+#include <KPluginMetaData>
-#include <views/dolphinmodel.h>
+#include <QTimer>
-VersionControlObserver::VersionControlObserver(QAbstractItemView* view) :
- QObject(view),
+VersionControlObserver::VersionControlObserver(QObject* parent) :
+ QObject(parent),
m_pendingItemStatesUpdate(false),
- m_versionedDirectory(false),
m_silentUpdate(false),
- m_view(view),
- m_dirLister(0),
- m_dolphinModel(0),
- m_dirVerificationTimer(0),
- m_plugin(0),
- m_updateItemStatesThread(0)
+ m_view(nullptr),
+ m_model(nullptr),
+ m_dirVerificationTimer(nullptr),
+ m_pluginsInitialized(false),
+ m_plugin(nullptr),
+ m_updateItemStatesThread(nullptr)
{
- Q_ASSERT(view);
-
- QAbstractProxyModel* proxyModel = qobject_cast<QAbstractProxyModel*>(view->model());
- m_dolphinModel = proxyModel ?
- qobject_cast<DolphinModel*>(proxyModel->sourceModel()) :
- qobject_cast<DolphinModel*>(view->model());
-
- if (m_dolphinModel) {
- m_dirLister = m_dolphinModel->dirLister();
- connect(m_dirLister, SIGNAL(completed()),
- this, SLOT(delayedDirectoryVerification()));
-
- // The verification timer specifies the timeout until the shown directory
- // is checked whether it is versioned. Per default it is assumed that users
- // don't iterate through versioned directories and a high timeout is used
- // The timeout will be decreased as soon as a versioned directory has been
- // found (see verifyDirectory()).
- m_dirVerificationTimer = new QTimer(this);
- m_dirVerificationTimer->setSingleShot(true);
- m_dirVerificationTimer->setInterval(500);
- connect(m_dirVerificationTimer, SIGNAL(timeout()),
- this, SLOT(verifyDirectory()));
- }
+ // The verification timer specifies the timeout until the shown directory
+ // is checked whether it is versioned. Per default it is assumed that users
+ // don't iterate through versioned directories and a high timeout is used
+ // The timeout will be decreased as soon as a versioned directory has been
+ // found (see verifyDirectory()).
+ m_dirVerificationTimer = new QTimer(this);
+ m_dirVerificationTimer->setSingleShot(true);
+ m_dirVerificationTimer->setInterval(500);
+ connect(m_dirVerificationTimer, &QTimer::timeout,
+ this, &VersionControlObserver::verifyDirectory);
}
VersionControlObserver::~VersionControlObserver()
{
- if (m_updateItemStatesThread) {
- if (m_updateItemStatesThread->isFinished()) {
- delete m_updateItemStatesThread;
- m_updateItemStatesThread = 0;
- } else {
- // The version controller gets deleted, while a thread still
- // is working to get the version information. To avoid a blocking
- // user interface, the thread will be forwarded to the
- // PendingThreadsMaintainer, which will delete the thread later.
- disconnect(m_updateItemStatesThread, SIGNAL(finished()),
- this, SLOT(slotThreadFinished()));
- PendingThreadsMaintainer::instance().append(m_updateItemStatesThread);
- m_updateItemStatesThread = 0;
- }
+ if (m_plugin) {
+ m_plugin->disconnect(this);
+ m_plugin = nullptr;
}
+}
- if (m_plugin) {
- m_plugin->disconnect();
- m_plugin = 0;
+void VersionControlObserver::setModel(KFileItemModel* model)
+{
+ if (m_model) {
+ disconnect(m_model, &KFileItemModel::itemsInserted,
+ this, &VersionControlObserver::delayedDirectoryVerification);
+ disconnect(m_model, &KFileItemModel::itemsChanged,
+ this, &VersionControlObserver::slotItemsChanged);
}
+
+ m_model = model;
+
+ if (model) {
+ connect(m_model, &KFileItemModel::itemsInserted,
+ this, &VersionControlObserver::delayedDirectoryVerification);
+ connect(m_model, &KFileItemModel::itemsChanged,
+ this, &VersionControlObserver::slotItemsChanged);
+ }
+}
+
+KFileItemModel* VersionControlObserver::model() const
+{
+ return m_model;
}
-QList<QAction*> VersionControlObserver::contextMenuActions(const KFileItemList& items) const
+void VersionControlObserver::setView(DolphinView* view)
{
- QList<QAction*> actions;
- if (isVersioned() && m_updateItemStatesThread->lockPlugin()) {
- actions = m_plugin->contextMenuActions(items);
- m_updateItemStatesThread->unlockPlugin();
+ if (m_view) {
+ disconnect(m_view, &DolphinView::activated,
+ this, &VersionControlObserver::delayedDirectoryVerification);
+ }
+
+ m_view = view;
+
+ if (m_view) {
+ connect(m_view, &DolphinView::activated,
+ this, &VersionControlObserver::delayedDirectoryVerification);
}
- return actions;
}
-QList<QAction*> VersionControlObserver::contextMenuActions(const QString& directory) const
+DolphinView* VersionControlObserver::view() const
{
- QList<QAction*> actions;
- if (isVersioned() && m_updateItemStatesThread->lockPlugin()) {
- actions = m_plugin->contextMenuActions(directory);
- m_updateItemStatesThread->unlockPlugin();
+ return m_view;
+}
+
+QList<QAction*> VersionControlObserver::actions(const KFileItemList& items) const
+{
+ bool hasNullItems = false;
+ for (const KFileItem& item : items) {
+ if (item.isNull()) {
+ qCWarning(DolphinDebug) << "Requesting version-control-actions for empty items";
+ hasNullItems = true;
+ break;
+ }
+ }
+
+ if (!m_model || hasNullItems) {
+ return {};
}
- return actions;
+ if (isVersionControlled()) {
+ return m_plugin->versionControlActions(items);
+ } else {
+ QList<QAction*> actions;
+ for (const QPointer<KVersionControlPlugin> &plugin : qAsConst(m_plugins)) {
+ actions << plugin->outOfVersionControlActions(items);
+ }
+ return actions;
+ }
}
void VersionControlObserver::delayedDirectoryVerification()
m_dirVerificationTimer->start();
}
+void VersionControlObserver::slotItemsChanged(const KItemRangeList& itemRanges, const QSet<QByteArray>& roles)
+{
+ Q_UNUSED(itemRanges)
+
+ // Because "version" role is emitted by VCS plugin (ourselfs) we don't need to
+ // analyze it and update directory item states information. So lets check if
+ // there is only "version".
+ if ( !(roles.count() == 1 && roles.contains("version")) ) {
+ delayedDirectoryVerification();
+ }
+}
+
void VersionControlObserver::verifyDirectory()
{
- const KUrl versionControlUrl = m_dirLister->url();
- if (!versionControlUrl.isLocalFile()) {
+ if (!m_model) {
return;
}
- if (m_plugin) {
- m_plugin->disconnect();
+ const KFileItem rootItem = m_model->rootItem();
+ if (rootItem.isNull() || !rootItem.url().isLocalFile()) {
+ return;
}
- m_plugin = searchPlugin(versionControlUrl);
- if (m_plugin) {
- connect(m_plugin, SIGNAL(versionStatesChanged()),
- this, SLOT(silentDirectoryVerification()));
- connect(m_plugin, SIGNAL(infoMessage(QString)),
- this, SIGNAL(infoMessage(QString)));
- connect(m_plugin, SIGNAL(errorMessage(QString)),
- this, SIGNAL(errorMessage(QString)));
- connect(m_plugin, SIGNAL(operationCompletedMessage(QString)),
- this, SIGNAL(operationCompletedMessage(QString)));
-
- if (!m_versionedDirectory) {
- m_versionedDirectory = true;
-
- // The directory is versioned. Assume that the user will further browse through
- // versioned directories and decrease the verification timer.
- m_dirVerificationTimer->setInterval(100);
- connect(m_dirLister, SIGNAL(refreshItems(const QList<QPair<KFileItem,KFileItem>>&)),
- this, SLOT(delayedDirectoryVerification()));
- connect(m_dirLister, SIGNAL(newItems(const KFileItemList&)),
- this, SLOT(delayedDirectoryVerification()));
+ if (m_plugin != nullptr) {
+ if (!rootItem.url().path().startsWith(m_localRepoRoot) || !QFile::exists(m_localRepoRoot + '/' + m_plugin->fileName())) {
+ m_plugin = nullptr;
+
+ // The directory is not versioned. Reset the verification timer to a higher
+ // value, so that browsing through non-versioned directories is not slown down
+ // by an immediate verification.
+ m_dirVerificationTimer->setInterval(500);
+ } else {
+ // View was versionned but should not be anymore
+ updateItemStates();
}
+ } else if ((m_plugin = searchPlugin(rootItem.url()))) {
+ // The directory is versioned. Assume that the user will further browse through
+ // versioned directories and decrease the verification timer.
+ m_dirVerificationTimer->setInterval(100);
updateItemStates();
- } else if (m_versionedDirectory) {
- m_versionedDirectory = false;
-
- // The directory is not versioned. Reset the verification timer to a higher
- // value, so that browsing through non-versioned directories is not slown down
- // by an immediate verification.
- m_dirVerificationTimer->setInterval(500);
- disconnect(m_dirLister, SIGNAL(refreshItems(const QList<QPair<KFileItem,KFileItem>>&)),
- this, SLOT(delayedDirectoryVerification()));
- disconnect(m_dirLister, SIGNAL(newItems(const KFileItemList&)),
- this, SLOT(delayedDirectoryVerification()));
}
}
void VersionControlObserver::slotThreadFinished()
{
- if (!m_plugin) {
- return;
- }
+ UpdateItemStatesThread* thread = m_updateItemStatesThread;
+ m_updateItemStatesThread = nullptr; // The thread deletes itself automatically (see updateItemStates())
- if (!m_updateItemStatesThread->retrievedItems()) {
- // ignore m_silentUpdate for an error message
- emit errorMessage(i18nc("@info:status", "Update of version information failed."));
+ if (!m_plugin || !thread) {
return;
}
- // QAbstractItemModel::setData() triggers a bottleneck in combination with QListView
- // (a detailed description of the root cause is given in the class KFilePreviewGenerator
- // from kdelibs). To bypass this bottleneck, the signals of the model are temporary blocked.
- // This works as the update of the data does not require a relayout of the views used in Dolphin.
- const bool signalsBlocked = m_dolphinModel->signalsBlocked();
- m_dolphinModel->blockSignals(true);
-
- const QList<ItemState> itemStates = m_updateItemStatesThread->itemStates();
- foreach (const ItemState& itemState, itemStates) {
- m_dolphinModel->setData(itemState.index,
- QVariant(static_cast<int>(itemState.version)),
- Qt::DecorationRole);
+ const QMap<QString, QVector<ItemState> >& itemStates = thread->itemStates();
+ QMap<QString, QVector<ItemState> >::const_iterator it = itemStates.constBegin();
+ for (; it != itemStates.constEnd(); ++it) {
+ const QVector<ItemState>& items = it.value();
+
+ for (const ItemState& item : items) {
+ const KFileItem& fileItem = item.first;
+ const KVersionControlPlugin::ItemVersion version = item.second;
+ QHash<QByteArray, QVariant> values;
+ values.insert("version", QVariant(version));
+ m_model->setData(m_model->index(fileItem), values);
+ }
}
- m_dolphinModel->blockSignals(signalsBlocked);
- m_view->viewport()->repaint();
-
if (!m_silentUpdate) {
// Using an empty message results in clearing the previously shown information message and showing
// the default status bar information. This is useful as the user already gets feedback that the
// operation has been completed because of the icon emblems.
- emit operationCompletedMessage(QString());
+ Q_EMIT operationCompletedMessage(QString());
}
if (m_pendingItemStatesUpdate) {
void VersionControlObserver::updateItemStates()
{
Q_ASSERT(m_plugin);
- if (!m_updateItemStatesThread) {
- m_updateItemStatesThread = new UpdateItemStatesThread();
- connect(m_updateItemStatesThread, SIGNAL(finished()),
- this, SLOT(slotThreadFinished()));
- }
- if (m_updateItemStatesThread->isRunning()) {
+ if (m_updateItemStatesThread) {
// An update is currently ongoing. Wait until the thread has finished
// the update (see slotThreadFinished()).
m_pendingItemStatesUpdate = true;
return;
}
- QList<ItemState> itemStates;
- addDirectory(QModelIndex(), itemStates);
+ QMap<QString, QVector<ItemState> > itemStates;
+ createItemStatesList(itemStates);
+
if (!itemStates.isEmpty()) {
if (!m_silentUpdate) {
- emit infoMessage(i18nc("@info:status", "Updating version information..."));
+ Q_EMIT infoMessage(i18nc("@info:status", "Updating version information..."));
}
- m_updateItemStatesThread->setData(m_plugin, itemStates);
+ m_updateItemStatesThread = new UpdateItemStatesThread(m_plugin, itemStates);
+ connect(m_updateItemStatesThread, &UpdateItemStatesThread::finished,
+ this, &VersionControlObserver::slotThreadFinished);
+ connect(m_updateItemStatesThread, &UpdateItemStatesThread::finished,
+ m_updateItemStatesThread, &UpdateItemStatesThread::deleteLater);
+
m_updateItemStatesThread->start(); // slotThreadFinished() is called when finished
}
}
-void VersionControlObserver::addDirectory(const QModelIndex& parentIndex, QList<ItemState>& itemStates)
+int VersionControlObserver::createItemStatesList(QMap<QString, QVector<ItemState> >& itemStates,
+ const int firstIndex)
{
- const int rowCount = m_dolphinModel->rowCount(parentIndex);
- for (int row = 0; row < rowCount; ++row) {
- const QModelIndex index = m_dolphinModel->index(row, DolphinModel::Version, parentIndex);
- addDirectory(index, itemStates);
+ const int itemCount = m_model->count();
+ const int currentExpansionLevel = m_model->expandedParentsCount(firstIndex);
- ItemState itemState;
- itemState.index = index;
- itemState.item = m_dolphinModel->itemForIndex(index);
- itemState.version = KVersionControlPlugin::UnversionedVersion;
+ QVector<ItemState> items;
+ items.reserve(itemCount - firstIndex);
- itemStates.append(itemState);
- }
-}
+ int index;
+ for (index = firstIndex; index < itemCount; ++index) {
+ const int expansionLevel = m_model->expandedParentsCount(index);
-KVersionControlPlugin* VersionControlObserver::searchPlugin(const KUrl& directory) const
-{
- static bool pluginsAvailable = true;
- static QList<KVersionControlPlugin*> plugins;
+ if (expansionLevel == currentExpansionLevel) {
+ ItemState itemState;
+ itemState.first = m_model->fileItem(index);
+ itemState.second = KVersionControlPlugin::UnversionedVersion;
+
+ items.append(itemState);
+ } else if (expansionLevel > currentExpansionLevel) {
+ // Sub folder
+ index += createItemStatesList(itemStates, index) - 1;
+ } else {
+ break;
+ }
+ }
- if (!pluginsAvailable) {
- // A searching for plugins has already been done, but no
- // plugins are installed
- return 0;
+ if (!items.isEmpty()) {
+ const QUrl& url = items.first().first.url();
+ itemStates.insert(url.adjusted(QUrl::RemoveFilename).path(), items);
}
- if (plugins.isEmpty()) {
+ return index - firstIndex; // number of processed items
+}
+
+void VersionControlObserver::initPlugins()
+{
+ if (!m_pluginsInitialized) {
// No searching for plugins has been done yet. Query the KServiceTypeTrader for
// all fileview version control plugins and remember them in 'plugins'.
const QStringList enabledPlugins = VersionControlSettings::enabledPlugins();
- const KService::List pluginServices = KServiceTypeTrader::self()->query("FileViewVersionControlPlugin");
- for (KService::List::ConstIterator it = pluginServices.constBegin(); it != pluginServices.constEnd(); ++it) {
- if (enabledPlugins.contains((*it)->name())) {
- KVersionControlPlugin* plugin = (*it)->createInstance<KVersionControlPlugin>();
+ const QVector<KPluginMetaData> plugins = KPluginMetaData::findPlugins(QStringLiteral("dolphin/vcs"));
+
+ QSet<QString> loadedPlugins;
+
+ for (const auto &p : plugins) {
+ if (enabledPlugins.contains(p.name())) {
+ auto plugin = KPluginFactory::instantiatePlugin<KVersionControlPlugin>(p).plugin;
if (plugin) {
- plugins.append(plugin);
+ m_plugins.append(plugin);
+ loadedPlugins += p.name();
}
}
}
- if (plugins.isEmpty()) {
- pluginsAvailable = false;
- return 0;
+
+ for (auto &plugin : qAsConst(m_plugins)) {
+ connect(plugin, &KVersionControlPlugin::itemVersionsChanged,
+ this, &VersionControlObserver::silentDirectoryVerification);
+ connect(plugin, &KVersionControlPlugin::infoMessage,
+ this, &VersionControlObserver::infoMessage);
+ connect(plugin, &KVersionControlPlugin::errorMessage,
+ this, &VersionControlObserver::errorMessage);
+ connect(plugin, &KVersionControlPlugin::operationCompletedMessage,
+ this, &VersionControlObserver::operationCompletedMessage);
}
+
+ m_pluginsInitialized = true;
}
+}
- // Verify whether the current directory contains revision information
- // like .svn, .git, ...
- foreach (KVersionControlPlugin* plugin, plugins) {
- // Use the KDirLister cache to check for .svn, .git, ... files
- KUrl dirUrl(directory);
- KUrl fileUrl = dirUrl;
- fileUrl.addPath(plugin->fileName());
- const KFileItem item = m_dirLister->findByUrl(fileUrl);
- if (!item.isNull()) {
- return plugin;
+KVersionControlPlugin* VersionControlObserver::searchPlugin(const QUrl& directory)
+{
+ initPlugins();
+
+ // Verify whether the current directory is under a version system
+ for (const QPointer<KVersionControlPlugin> &plugin : qAsConst(m_plugins)) {
+ if (!plugin) {
+ continue;
}
- // Version control systems like Git provide the version information
- // file only in the root directory. Check whether the version information file can
- // be found in one of the parent directories. For performance reasons this
- // step is only done, if the previous directory was marked as versioned by
- // m_versionedDirectory. Drawback: Until e. g. Git is recognized, the root directory
- // must be shown at least once.
- if (m_versionedDirectory) {
- KUrl upUrl = dirUrl.upUrl();
- while (upUrl != dirUrl) {
- const QString filePath = dirUrl.pathOrUrl(KUrl::AddTrailingSlash) + plugin->fileName();
- QFileInfo file(filePath);
- if (file.exists()) {
- return plugin;
- }
- dirUrl = upUrl;
- upUrl = dirUrl.upUrl();
- }
+ // first naively check if we are at working copy root
+ const QString fileName = directory.path() + '/' + plugin->fileName();
+ if (QFile::exists(fileName)) {
+ m_localRepoRoot = directory.path();
+ return plugin;
+ }
+ const QString root = plugin->localRepositoryRoot(directory.path());
+ if (!root.isEmpty()) {
+ m_localRepoRoot = root;
+ return plugin;
}
}
-
- return 0;
+ return nullptr;
}
-bool VersionControlObserver::isVersioned() const
+bool VersionControlObserver::isVersionControlled() const
{
- return m_dolphinModel->hasVersionData() && m_plugin;
+ return m_plugin != nullptr;
}
-#include "versioncontrolobserver.moc"
projects / dolphin.git / blobdiff