X-Git-Url: https://cloud.milkyroute.net/gitweb/dolphin.git/blobdiff_plain/37deaaef2c39a4c4b410cd0313a55a4072d2b2ff..1826f905d706925456763394de17294bcb6d1c35:/src/views/versioncontrol/versioncontrolobserver.cpp diff --git a/src/views/versioncontrol/versioncontrolobserver.cpp b/src/views/versioncontrol/versioncontrolobserver.cpp index f6c74fb5f..64f8843d2 100644 --- a/src/views/versioncontrol/versioncontrolobserver.cpp +++ b/src/views/versioncontrol/versioncontrolobserver.cpp @@ -1,47 +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 "dolphindebug.h" -#include "views/dolphinview.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_view(nullptr), - m_model(nullptr), - m_dirVerificationTimer(nullptr), - m_pluginsInitialized(false), - m_plugin(nullptr), - m_updateItemStatesThread(nullptr) +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_plugin(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 @@ -51,8 +37,7 @@ 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() @@ -63,54 +48,48 @@ VersionControlObserver::~VersionControlObserver() } } -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::slotItemsChanged); + 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); + connect(m_model, &KFileItemModel::itemsInserted, this, &VersionControlObserver::delayedDirectoryVerification); + connect(m_model, &KFileItemModel::itemsChanged, this, &VersionControlObserver::slotItemsChanged); } } -KFileItemModel* VersionControlObserver::model() const +KFileItemModel *VersionControlObserver::model() const { return m_model; } -void VersionControlObserver::setView(DolphinView* view) +void VersionControlObserver::setView(DolphinView *view) { if (m_view) { - disconnect(m_view, &DolphinView::activated, - this, &VersionControlObserver::delayedDirectoryVerification); + disconnect(m_view, &DolphinView::activated, this, &VersionControlObserver::delayedDirectoryVerification); } m_view = view; if (m_view) { - connect(m_view, &DolphinView::activated, - this, &VersionControlObserver::delayedDirectoryVerification); + connect(m_view, &DolphinView::activated, this, &VersionControlObserver::delayedDirectoryVerification); } } -DolphinView* VersionControlObserver::view() const +DolphinView *VersionControlObserver::view() const { return m_view; } -QList VersionControlObserver::actions(const KFileItemList& items) const +QList VersionControlObserver::actions(const KFileItemList &items) const { bool hasNullItems = false; - foreach (const KFileItem& item, items) { + for (const KFileItem &item : items) { if (item.isNull()) { qCWarning(DolphinDebug) << "Requesting version-control-actions for empty items"; hasNullItems = true; @@ -125,9 +104,9 @@ QList VersionControlObserver::actions(const KFileItemList& items) cons if (isVersionControlled()) { return m_plugin->versionControlActions(items); } else { - QList actions; - for (const auto &plugin : qAsConst(m_plugins)) { - actions << plugin.first->outOfVersionControlActions(items); + QList actions; + for (const QPointer &plugin : std::as_const(m_plugins)) { + actions << plugin->outOfVersionControlActions(items); } return actions; } @@ -145,14 +124,14 @@ void VersionControlObserver::silentDirectoryVerification() m_dirVerificationTimer->start(); } -void VersionControlObserver::slotItemsChanged(const KItemRangeList& itemRanges, const QSet& roles) +void VersionControlObserver::slotItemsChanged(const KItemRangeList &itemRanges, const QSet &roles) { Q_UNUSED(itemRanges) - // Because "version" role is emitted by VCS plugin (ourselfs) we don't need to + // 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")) ) { + if (!(roles.count() == 1 && roles.contains("version"))) { delayedDirectoryVerification(); } } @@ -168,55 +147,42 @@ void VersionControlObserver::verifyDirectory() return; } - if (m_plugin) { - m_plugin->disconnect(this); - } + if (m_plugin != nullptr) { + if (!rootItem.url().path().startsWith(m_localRepoRoot) || !QFile::exists(m_localRepoRoot + '/' + m_plugin->fileName())) { + m_plugin = nullptr; - m_plugin = searchPlugin(rootItem.url()); - if (m_plugin) { - connect(m_plugin, &KVersionControlPlugin::itemVersionsChanged, - 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); + // 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 versioned 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); } } void VersionControlObserver::slotThreadFinished() { - UpdateItemStatesThread* thread = m_updateItemStatesThread; + UpdateItemStatesThread *thread = m_updateItemStatesThread; m_updateItemStatesThread = nullptr; // The thread deletes itself automatically (see updateItemStates()) if (!m_plugin || !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) { - const KFileItem& fileItem = item.first; + for (const ItemState &item : items) { + const KFileItem &fileItem = item.first; const KVersionControlPlugin::ItemVersion version = item.second; QHash values; values.insert("version", QVariant(version)); @@ -228,7 +194,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) { @@ -247,25 +213,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); + 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); @@ -292,84 +255,73 @@ int VersionControlObserver::createItemStatesList(QMapquery(QStringLiteral("FileViewVersionControlPlugin")); - for (KService::List::ConstIterator it = pluginServices.constBegin(); it != pluginServices.constEnd(); ++it) { - if (enabledPlugins.contains((*it)->name())) { - KVersionControlPlugin* plugin = (*it)->createInstance(this); + const QVector plugins = KPluginMetaData::findPlugins(QStringLiteral("dolphin/vcs")); + + QSet loadedPlugins; + + for (const auto &p : plugins) { + if (enabledPlugins.contains(p.name())) { + auto plugin = KPluginFactory::instantiatePlugin(p, parent()).plugin; if (plugin) { - m_plugins.append( qMakePair(plugin, plugin->fileName()) ); + m_plugins.append(plugin); + loadedPlugins += p.name(); } } } + + for (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; } +} - if (m_plugins.empty()) { - // A searching for plugins has already been done, but no - // plugins are installed - return nullptr; - } +KVersionControlPlugin *VersionControlObserver::searchPlugin(const QUrl &directory) +{ + initPlugins(); - // 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 = nullptr; - int bestScore = INT_MAX; + // Verify whether the current directory is under a version system + for (const QPointer &plugin : std::as_const(m_plugins)) { + if (!plugin) { + continue; + } - // Verify whether the current directory contains revision information - // like .svn, .git, ... - for (const auto &it : qAsConst(m_plugins)) { - const QString fileName = directory.path() + '/' + it.second; + // 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 ;) - return it.first; + 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) { - QUrl dirUrl(directory); - QUrl upUrl = KIO::upUrl(dirUrl); - int upUrlCounter = 1; - while ((upUrlCounter < bestScore) && (upUrl != dirUrl)) { - const QString fileName = dirUrl.path() + '/' + it.second; - if (QFile::exists(fileName)) { - if (upUrlCounter < bestScore) { - bestPlugin = it.first; - bestScore = upUrlCounter; - } - break; - } - dirUrl = upUrl; - upUrl = KIO::upUrl(dirUrl); - ++upUrlCounter; - } + const QString root = plugin->localRepositoryRoot(directory.path()); + if (!root.isEmpty()) { + m_localRepoRoot = root; + return plugin; } } - - return bestPlugin; + return nullptr; } bool VersionControlObserver::isVersionControlled() const { - return m_versionedDirectory && m_plugin; + return m_plugin != nullptr; } +#include "moc_versioncontrolobserver.cpp"