X-Git-Url: https://cloud.milkyroute.net/gitweb/dolphin.git/blobdiff_plain/d4fb129710d7fadf8e21f2cfd2588a794f774e41..e018ecafca79a73f1e9d76c577b9529fc3a7ae03:/src/views/versioncontrol/versioncontrolobserver.cpp diff --git a/src/views/versioncontrol/versioncontrolobserver.cpp b/src/views/versioncontrol/versioncontrolobserver.cpp index c41803c16..521ff8b90 100644 --- a/src/views/versioncontrol/versioncontrolobserver.cpp +++ b/src/views/versioncontrol/versioncontrolobserver.cpp @@ -1,48 +1,33 @@ -/*************************************************************************** - * Copyright (C) 2009 by Peter Penz * - * * - * 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 + * + * SPDX-License-Identifier: GPL-2.0-or-later + */ #include "versioncontrolobserver.h" #include "dolphin_versioncontrolsettings.h" - -#include -#include -#include -#include -#include -#include - +#include "dolphindebug.h" +#include "kitemviews/kfileitemmodel.h" #include "updateitemstatesthread.h" +#include "views/dolphinview.h" + +#include +#include +#include -#include -#include #include -VersionControlObserver::VersionControlObserver(QObject* parent) : - QObject(parent), - m_pendingItemStatesUpdate(false), - m_versionedDirectory(false), - m_silentUpdate(false), - m_model(0), - m_dirVerificationTimer(0), - m_plugin(0), - m_updateItemStatesThread(0) +VersionControlObserver::VersionControlObserver(QObject *parent) + : QObject(parent) + , m_pendingItemStatesUpdate(false) + , m_silentUpdate(false) + , m_view(nullptr) + , m_model(nullptr) + , m_dirVerificationTimer(nullptr) + , m_pluginsInitialized(false) + , m_currentPlugin(nullptr) + , m_updateItemStatesThread(nullptr) { // The verification timer specifies the timeout until the shown directory // is checked whether it is versioned. Per default it is assumed that users @@ -52,94 +37,134 @@ VersionControlObserver::VersionControlObserver(QObject* parent) : m_dirVerificationTimer = new QTimer(this); m_dirVerificationTimer->setSingleShot(true); m_dirVerificationTimer->setInterval(500); - connect(m_dirVerificationTimer, &QTimer::timeout, - this, &VersionControlObserver::verifyDirectory); + connect(m_dirVerificationTimer, &QTimer::timeout, this, &VersionControlObserver::verifyDirectory); } VersionControlObserver::~VersionControlObserver() { - if (m_plugin) { - m_plugin->disconnect(this); - m_plugin = 0; + if (m_currentPlugin) { + m_currentPlugin->disconnect(this); + } + if (m_updateItemStatesThread) { + m_updateItemStatesThread->requestInterruption(); + m_updateItemStatesThread->wait(); + m_updateItemStatesThread->deleteLater(); + } + + if (m_currentPlugin) { + delete m_currentPlugin; + m_currentPlugin = nullptr; } + m_plugins.clear(); } -void VersionControlObserver::setModel(KFileItemModel* model) +void VersionControlObserver::setModel(KFileItemModel *model) { if (m_model) { - disconnect(m_model, &KFileItemModel::itemsInserted, - this, &VersionControlObserver::delayedDirectoryVerification); - disconnect(m_model, &KFileItemModel::itemsChanged, - this, &VersionControlObserver::delayedDirectoryVerification); + if (m_currentPlugin) { + delete m_currentPlugin; + m_currentPlugin = nullptr; + } + if (m_updateItemStatesThread) { + m_updateItemStatesThread->requestInterruption(); + } + disconnect(m_model, &KFileItemModel::itemsInserted, this, &VersionControlObserver::delayedDirectoryVerification); + disconnect(m_model, &KFileItemModel::itemsChanged, this, &VersionControlObserver::slotItemsChanged); + disconnect(m_model, &KFileItemModel::directoryLoadingCompleted, this, &VersionControlObserver::verifyDirectory); } m_model = model; if (model) { - connect(m_model, &KFileItemModel::itemsInserted, - this, &VersionControlObserver::delayedDirectoryVerification); - connect(m_model, &KFileItemModel::itemsChanged, - this, &VersionControlObserver::delayedDirectoryVerification); + connect(m_model, &KFileItemModel::itemsInserted, this, &VersionControlObserver::delayedDirectoryVerification); + connect(m_model, &KFileItemModel::itemsChanged, this, &VersionControlObserver::slotItemsChanged); + connect(m_model, &KFileItemModel::directoryLoadingCompleted, this, &VersionControlObserver::verifyDirectory); } } -KFileItemModel* VersionControlObserver::model() const +KFileItemModel *VersionControlObserver::model() const { return m_model; } -QList VersionControlObserver::actions(const KFileItemList& items) const +void VersionControlObserver::setView(DolphinView *view) +{ + 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); + } +} + +DolphinView *VersionControlObserver::view() const { - QList actions; + return m_view; +} +QList VersionControlObserver::actions(const KFileItemList &items) const +{ bool hasNullItems = false; - foreach (const KFileItem& item, items) { + for (const KFileItem &item : items) { if (item.isNull()) { - kWarning() << "Requesting version-control-actions for empty items"; + qCWarning(DolphinDebug) << "Requesting version-control-actions for empty items"; hasNullItems = true; break; } } if (!m_model || hasNullItems) { - return actions; + return {}; } - KVersionControlPlugin2* pluginV2 = qobject_cast(m_plugin); - if (pluginV2) { - // Use version 2 of the KVersionControlPlugin which allows providing actions - // also for non-versioned directories. - actions = pluginV2->actions(items); - } else if (isVersioned()) { - // Support deprecated interfaces from KVersionControlPlugin version 1. - // Context menu actions where only available for versioned directories. - QString directory; - if (items.count() == 1) { - const KFileItem rootItem = m_model->rootItem(); - if (!rootItem.isNull() && items.first().url() == rootItem.url()) { - directory = rootItem.url().path(); - } + if (isVersionControlled()) { + return m_currentPlugin->versionControlActions(items); + } else { + QList actions; + for (const KVersionControlPlugin *plugin : std::as_const(m_plugins)) { + actions << plugin->outOfVersionControlActions(items); } - - actions = directory.isEmpty() ? m_plugin->contextMenuActions(items) - : m_plugin->contextMenuActions(directory); + return actions; } - - return actions; } void VersionControlObserver::delayedDirectoryVerification() { + if (!isVersionControlled()) { + m_dirVerificationTimer->stop(); + return; + } + m_silentUpdate = false; m_dirVerificationTimer->start(); } void VersionControlObserver::silentDirectoryVerification() { + if (!isVersionControlled()) { + m_dirVerificationTimer->stop(); + return; + } + m_silentUpdate = true; m_dirVerificationTimer->start(); } +void VersionControlObserver::slotItemsChanged(const KItemRangeList &itemRanges, const QSet &roles) +{ + Q_UNUSED(itemRanges) + + // Because "version" role is emitted by VCS plugin (ourselves) 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() { if (!m_model) { @@ -151,63 +176,46 @@ void VersionControlObserver::verifyDirectory() return; } - if (m_plugin) { - m_plugin->disconnect(this); + if (m_currentPlugin && rootItem.url().path().startsWith(m_localRepoRoot) && QFile::exists(m_localRepoRoot + '/' + m_currentPlugin->fileName())) { + // current directory is still versionned + updateItemStates(); + return; } - m_plugin = searchPlugin(rootItem.url()); - if (m_plugin) { - KVersionControlPlugin2* pluginV2 = qobject_cast(m_plugin); - if (pluginV2) { - connect(pluginV2, &KVersionControlPlugin2::itemVersionsChanged, - this, &VersionControlObserver::silentDirectoryVerification); - } else { - connect(m_plugin, &KVersionControlPlugin::versionStatesChanged, - this, &VersionControlObserver::silentDirectoryVerification); - } - connect(m_plugin, &KVersionControlPlugin::infoMessage, - this, &VersionControlObserver::infoMessage); - connect(m_plugin, &KVersionControlPlugin::errorMessage, - this, &VersionControlObserver::errorMessage); - connect(m_plugin, &KVersionControlPlugin::operationCompletedMessage, - this, &VersionControlObserver::operationCompletedMessage); - - 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); - } + if ((m_currentPlugin = 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); + return; } + + // 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); } void VersionControlObserver::slotThreadFinished() { - UpdateItemStatesThread* thread = m_updateItemStatesThread; - m_updateItemStatesThread = 0; // The thread deletes itself automatically (see updateItemStates()) + UpdateItemStatesThread *thread = m_updateItemStatesThread; + m_updateItemStatesThread = nullptr; // The thread deletes itself automatically (see updateItemStates()) - if (!m_plugin || !thread) { + if (!m_currentPlugin || !thread) { return; } - const QMap >& itemStates = thread->itemStates(); - QMap >::const_iterator it = itemStates.constBegin(); + const QMap> &itemStates = thread->itemStates(); + QMap>::const_iterator it = itemStates.constBegin(); for (; it != itemStates.constEnd(); ++it) { - const QVector& items = it.value(); + const QVector &items = it.value(); - foreach (const ItemState& item, items) { + for (const ItemState &item : items) { + const KFileItem &fileItem = item.first; + const KVersionControlPlugin::ItemVersion version = item.second; QHash values; - values.insert("version", QVariant(item.version)); - m_model->setData(m_model->index(item.item), values); + values.insert("version", QVariant(version)); + m_model->setData(m_model->index(fileItem), values); } } @@ -215,7 +223,7 @@ void VersionControlObserver::slotThreadFinished() // 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) { @@ -226,7 +234,7 @@ void VersionControlObserver::slotThreadFinished() void VersionControlObserver::updateItemStates() { - Q_ASSERT(m_plugin); + Q_ASSERT(m_currentPlugin); if (m_updateItemStatesThread) { // An update is currently ongoing. Wait until the thread has finished // the update (see slotThreadFinished()). @@ -234,25 +242,22 @@ void VersionControlObserver::updateItemStates() return; } - QMap > itemStates; + QMap> 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 = new UpdateItemStatesThread(m_plugin, itemStates); - connect(m_updateItemStatesThread, &UpdateItemStatesThread::finished, - this, &VersionControlObserver::slotThreadFinished); - connect(m_updateItemStatesThread, &UpdateItemStatesThread::finished, - m_updateItemStatesThread, &UpdateItemStatesThread::deleteLater); + m_updateItemStatesThread = new UpdateItemStatesThread(m_currentPlugin, 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 } } -int VersionControlObserver::createItemStatesList(QMap >& itemStates, - const int firstIndex) +int VersionControlObserver::createItemStatesList(QMap> &itemStates, const int firstIndex) { const int itemCount = m_model->count(); const int currentExpansionLevel = m_model->expandedParentsCount(firstIndex); @@ -266,8 +271,8 @@ int VersionControlObserver::createItemStatesList(QMapfileItem(index); - itemState.version = KVersionControlPlugin2::UnversionedVersion; + itemState.first = m_model->fileItem(index); + itemState.second = KVersionControlPlugin::UnversionedVersion; items.append(itemState); } else if (expansionLevel > currentExpansionLevel) { @@ -278,91 +283,68 @@ int VersionControlObserver::createItemStatesList(QMap 0) { - const KUrl& url = items.first().item.url(); - itemStates.insert(url.directory(KUrl::AppendTrailingSlash), items); + if (!items.isEmpty()) { + const QUrl &url = items.first().first.url(); + itemStates.insert(url.adjusted(QUrl::RemoveFilename).path(), items); } return index - firstIndex; // number of processed items } -KVersionControlPlugin* VersionControlObserver::searchPlugin(const KUrl& directory) const +void VersionControlObserver::initPlugins() { - static bool pluginsAvailable = true; - static QList plugins; - - if (!pluginsAvailable) { - // A searching for plugins has already been done, but no - // plugins are installed - return 0; - } - - if (plugins.isEmpty()) { - // No searching for plugins has been done yet. Query the KServiceTypeTrader for - // all fileview version control plugins and remember them in 'plugins'. + if (!m_pluginsInitialized) { + // No searching for plugins has been done yet. Query 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(); + const QVector plugins = KPluginMetaData::findPlugins(QStringLiteral("dolphin/vcs")); + + for (const auto &p : plugins) { + if (enabledPlugins.contains(p.name())) { + auto plugin = KPluginFactory::instantiatePlugin(p, parent()).plugin; if (plugin) { - plugins.append(plugin); + m_plugins.append(plugin); } } } - if (plugins.isEmpty()) { - pluginsAvailable = false; - return 0; + + for (const auto *plugin : std::as_const(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; } +} - // We use the number of upUrl() calls to find the best matching plugin - // for the given directory. The smaller value, the better it is (0 is best). - KVersionControlPlugin* bestPlugin = 0; - int bestScore = INT_MAX; +KVersionControlPlugin *VersionControlObserver::searchPlugin(const QUrl &directory) +{ + initPlugins(); - // Verify whether the current directory contains revision information - // like .svn, .git, ... - foreach (KVersionControlPlugin* plugin, plugins) { - const QString fileName = directory.path(KUrl::AddTrailingSlash) + plugin->fileName(); + // Verify whether the current directory is under a version system + for (KVersionControlPlugin *plugin : std::as_const(m_plugins)) { + // first naively check if we are at working copy root + const QString fileName = directory.path() + '/' + plugin->fileName(); if (QFile::exists(fileName)) { - // The score of this plugin is 0 (best), so we can just return this plugin, - // instead of going through the plugin scoring procedure, we can't find a better one ;) + m_localRepoRoot = directory.path(); return plugin; } - // 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 dirUrl(directory); - KUrl upUrl = dirUrl.upUrl(); - int upUrlCounter = 1; - while ((upUrlCounter < bestScore) && (upUrl != dirUrl)) { - const QString fileName = dirUrl.path(KUrl::AddTrailingSlash) + plugin->fileName(); - if (QFile::exists(fileName)) { - if (upUrlCounter < bestScore) { - bestPlugin = plugin; - bestScore = upUrlCounter; - } - break; - } - dirUrl = upUrl; - upUrl = dirUrl.upUrl(); - ++upUrlCounter; - } + const QString root = plugin->localRepositoryRoot(directory.path()); + if (!root.isEmpty()) { + m_localRepoRoot = root; + return plugin; } } - - return bestPlugin; + return nullptr; } -bool VersionControlObserver::isVersioned() const +bool VersionControlObserver::isVersionControlled() const { - return m_versionedDirectory && m_plugin; + return m_currentPlugin != nullptr; } +#include "moc_versioncontrolobserver.cpp"