For VCS-plugin interface added pure virtual function outOfVersionControlActions()

[dolphin.git] / src / views / versioncontrol / versioncontrolobserver.cpp

diff --git a/src/views/versioncontrol/versioncontrolobserver.cpp b/src/views/versioncontrol/versioncontrolobserver.cpp
index 402a2de54c1644169ceae455486050015461ff7e..f6c74fb5fe4de9eee2e1b8560142b4cab93a1ecb 100644 (file)
--- a/src/views/versioncontrol/versioncontrolobserver.cpp
+++ b/src/views/versioncontrol/versioncontrolobserver.cpp
@@ -20,17 +20,15 @@
 #include "versioncontrolobserver.h"
 
 #include "dolphin_versioncontrolsettings.h"
 #include "versioncontrolobserver.h"
 
 #include "dolphin_versioncontrolsettings.h"

+#include "dolphindebug.h"
+#include "views/dolphinview.h"
+#include "kitemviews/kfileitemmodel.h"
+#include "updateitemstatesthread.h"

 
 

-#include <KLocale>
+#include <KLocalizedString>

 #include <KService>
 #include <KServiceTypeTrader>
 #include <KService>
 #include <KServiceTypeTrader>

-#include <kitemviews/kfileitemmodel.h>
-#include <kversioncontrolplugin2.h>
-
-#include "updateitemstatesthread.h"

 
 

-#include <QFile>
-#include <QMutexLocker>

 #include <QTimer>
 
 VersionControlObserver::VersionControlObserver(QObject* parent) :
 #include <QTimer>
 
 VersionControlObserver::VersionControlObserver(QObject* parent) :


@@ -38,10 +36,12 @@ VersionControlObserver::VersionControlObserver(QObject* parent) :
     m_pendingItemStatesUpdate(false),
     m_versionedDirectory(false),
     m_silentUpdate(false),
     m_pendingItemStatesUpdate(false),
     m_versionedDirectory(false),
     m_silentUpdate(false),

-    m_model(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)

 {
     // The verification timer specifies the timeout until the shown directory
     // is checked whether it is versioned. Per default it is assumed that users
 {
     // The verification timer specifies the timeout until the shown directory
     // is checked whether it is versioned. Per default it is assumed that users


@@ -51,34 +51,34 @@ VersionControlObserver::VersionControlObserver(QObject* parent) :
     m_dirVerificationTimer = new QTimer(this);
     m_dirVerificationTimer->setSingleShot(true);
     m_dirVerificationTimer->setInterval(500);
     m_dirVerificationTimer = new QTimer(this);
     m_dirVerificationTimer->setSingleShot(true);
     m_dirVerificationTimer->setInterval(500);

-    connect(m_dirVerificationTimer, SIGNAL(timeout()),
-            this, SLOT(verifyDirectory()));
+    connect(m_dirVerificationTimer, &QTimer::timeout,
+            this, &VersionControlObserver::verifyDirectory);

 }
 
 VersionControlObserver::~VersionControlObserver()
 {
     if (m_plugin) {
         m_plugin->disconnect(this);
 }
 
 VersionControlObserver::~VersionControlObserver()
 {
     if (m_plugin) {
         m_plugin->disconnect(this);

-        m_plugin = 0;
+        m_plugin = nullptr;

     }
 }
 
 void VersionControlObserver::setModel(KFileItemModel* model)
 {
     if (m_model) {
     }
 }
 
 void VersionControlObserver::setModel(KFileItemModel* model)
 {
     if (m_model) {

-        disconnect(m_model, SIGNAL(itemsInserted(KItemRangeList)),
-                   this, SLOT(delayedDirectoryVerification()));
-        disconnect(m_model, SIGNAL(itemsChanged(KItemRangeList,QSet<QByteArray>)),
-                   this, SLOT(delayedDirectoryVerification()));
+        disconnect(m_model, &KFileItemModel::itemsInserted,
+                   this, &VersionControlObserver::delayedDirectoryVerification);
+        disconnect(m_model, &KFileItemModel::itemsChanged,
+                   this, &VersionControlObserver::slotItemsChanged);

     }
 
     m_model = model;
 
     if (model) {
     }
 
     m_model = model;
 
     if (model) {

-        connect(m_model, SIGNAL(itemsInserted(KItemRangeList)),
-                this, SLOT(delayedDirectoryVerification()));
-        connect(m_model, SIGNAL(itemsChanged(KItemRangeList,QSet<QByteArray>)),
-                this, SLOT(delayedDirectoryVerification()));
+        connect(m_model, &KFileItemModel::itemsInserted,
+                this, &VersionControlObserver::delayedDirectoryVerification);
+        connect(m_model, &KFileItemModel::itemsChanged,
+                this, &VersionControlObserver::slotItemsChanged);

     }
 }
 
     }
 }
 


@@ -87,44 +87,50 @@ KFileItemModel* VersionControlObserver::model() const
     return m_model;
 }
 
     return m_model;
 }
 

-QList<QAction*> 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<QAction*> actions;
+    return m_view;
+}

 
 

+QList<QAction*> VersionControlObserver::actions(const KFileItemList& items) const
+{

     bool hasNullItems = false;
     foreach (const KFileItem& item, items) {
         if (item.isNull()) {
     bool hasNullItems = false;
     foreach (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) {
             hasNullItems = true;
             break;
         }
     }
 
     if (!m_model || hasNullItems) {

-        return actions;
+        return {};

     }
 
     }
 

-    KVersionControlPlugin2* pluginV2 = qobject_cast<KVersionControlPlugin2*>(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(KUrl::AddTrailingSlash);
-            }
+    if (isVersionControlled()) {
+        return m_plugin->versionControlActions(items);
+    } else {
+        QList<QAction*> actions;
+        for (const auto &plugin : qAsConst(m_plugins)) {
+            actions << plugin.first->outOfVersionControlActions(items);

         }
         }

-
-        actions = directory.isEmpty() ? m_plugin->contextMenuActions(items)
-                                      : m_plugin->contextMenuActions(directory);
+        return actions;

     }
     }

-
-    return actions;

 }
 
 void VersionControlObserver::delayedDirectoryVerification()
 }
 
 void VersionControlObserver::delayedDirectoryVerification()


@@ -139,6 +145,18 @@ void VersionControlObserver::silentDirectoryVerification()
     m_dirVerificationTimer->start();
 }
 
     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()
 {
     if (!m_model) {
 void VersionControlObserver::verifyDirectory()
 {
     if (!m_model) {


@@ -156,20 +174,14 @@ void VersionControlObserver::verifyDirectory()
 
     m_plugin = searchPlugin(rootItem.url());
     if (m_plugin) {
 
     m_plugin = searchPlugin(rootItem.url());
     if (m_plugin) {

-        KVersionControlPlugin2* pluginV2 = qobject_cast<KVersionControlPlugin2*>(m_plugin);
-        if (pluginV2) {
-            connect(pluginV2, SIGNAL(itemVersionsChanged()),
-                    this, SLOT(silentDirectoryVerification()));
-        } else {
-            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)));
+        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;
 
         if (!m_versionedDirectory) {
             m_versionedDirectory = true;


@@ -192,23 +204,24 @@ void VersionControlObserver::verifyDirectory()
 void VersionControlObserver::slotThreadFinished()
 {
     UpdateItemStatesThread* thread = m_updateItemStatesThread;
 void VersionControlObserver::slotThreadFinished()
 {
     UpdateItemStatesThread* thread = m_updateItemStatesThread;

-    m_updateItemStatesThread = 0; // The thread deletes itself automatically (see updateItemStates())
+    m_updateItemStatesThread = nullptr; // The thread deletes itself automatically (see updateItemStates())

 
     if (!m_plugin || !thread) {
         return;
     }
 
 
     if (!m_plugin || !thread) {
         return;
     }
 

-    if (!thread->retrievedItems()) {
-        // Ignore m_silentUpdate for an error message
-        emit errorMessage(i18nc("@info:status", "Update of version information failed."));
-        return;
-    }
-
-    const QList<ItemState> itemStates = thread->itemStates();
-    foreach (const ItemState& itemState, itemStates) {
-        QHash<QByteArray, QVariant> values;
-        values.insert("version", QVariant(itemState.version));
-        m_model->setData(itemState.index, values);
+    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();
+
+        foreach (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);
+        }

     }
 
     if (!m_silentUpdate) {
     }
 
     if (!m_silentUpdate) {


@@ -233,70 +246,97 @@ void VersionControlObserver::updateItemStates()
         m_pendingItemStatesUpdate = true;
         return;
     }
         m_pendingItemStatesUpdate = true;
         return;
     }

-    QList<ItemState> itemStates;
-    const int itemCount = m_model->count();
-    itemStates.reserve(itemCount);

 
 

-    for (int i = 0; i < itemCount; ++i) {
-        ItemState itemState;
-        itemState.index = i;
-        itemState.item = m_model->fileItem(i);
-        itemState.version = KVersionControlPlugin2::UnversionedVersion;
-
-        itemStates.append(itemState);
-    }
+    QMap<QString, QVector<ItemState> > itemStates;
+    createItemStatesList(itemStates);

 
     if (!itemStates.isEmpty()) {
         if (!m_silentUpdate) {
             emit infoMessage(i18nc("@info:status", "Updating version information..."));
         }
         m_updateItemStatesThread = new UpdateItemStatesThread(m_plugin, itemStates);
 
     if (!itemStates.isEmpty()) {
         if (!m_silentUpdate) {
             emit infoMessage(i18nc("@info:status", "Updating version information..."));
         }
         m_updateItemStatesThread = new UpdateItemStatesThread(m_plugin, itemStates);

-        connect(m_updateItemStatesThread, SIGNAL(finished()),
-                this, SLOT(slotThreadFinished()));
-        connect(m_updateItemStatesThread, SIGNAL(finished()),
-                m_updateItemStatesThread, SLOT(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
     }
 }
 
 
         m_updateItemStatesThread->start(); // slotThreadFinished() is called when finished
     }
 }
 

-KVersionControlPlugin* VersionControlObserver::searchPlugin(const KUrl& directory) const
+int VersionControlObserver::createItemStatesList(QMap<QString, QVector<ItemState> >& itemStates,
+                                                 const int firstIndex)

 {
 {

-    static bool pluginsAvailable = true;
-    static QList<KVersionControlPlugin*> plugins;
+    const int itemCount = m_model->count();
+    const int currentExpansionLevel = m_model->expandedParentsCount(firstIndex);

 
 

-    if (!pluginsAvailable) {
-        // A searching for plugins has already been done, but no
-        // plugins are installed
-        return 0;
+    QVector<ItemState> items;
+    items.reserve(itemCount - firstIndex);
+
+    int index;
+    for (index = firstIndex; index < itemCount; ++index) {
+        const int expansionLevel = m_model->expandedParentsCount(index);
+
+        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 (!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
+}
+
+KVersionControlPlugin* VersionControlObserver::searchPlugin(const QUrl& directory)
+{
+    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();
 
         // 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");
+        const KService::List pluginServices = KServiceTypeTrader::self()->query(QStringLiteral("FileViewVersionControlPlugin"));

         for (KService::List::ConstIterator it = pluginServices.constBegin(); it != pluginServices.constEnd(); ++it) {
             if (enabledPlugins.contains((*it)->name())) {
         for (KService::List::ConstIterator it = pluginServices.constBegin(); it != pluginServices.constEnd(); ++it) {
             if (enabledPlugins.contains((*it)->name())) {

-                KVersionControlPlugin* plugin = (*it)->createInstance<KVersionControlPlugin>();
+                KVersionControlPlugin* plugin = (*it)->createInstance<KVersionControlPlugin>(this);

                 if (plugin) {
                 if (plugin) {

-                    plugins.append(plugin);
+                    m_plugins.append( qMakePair(plugin, plugin->fileName()) );

                 }
             }
         }
                 }
             }
         }

-        if (plugins.isEmpty()) {
-            pluginsAvailable = false;
-            return 0;
-        }
+        m_pluginsInitialized = true;
+    }
+
+    if (m_plugins.empty()) {
+        // A searching for plugins has already been done, but no
+        // plugins are installed
+        return nullptr;

     }
 
     }
 

+    // 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 contains revision information
     // like .svn, .git, ...
     // Verify whether the current directory contains revision information
     // like .svn, .git, ...

-    foreach (KVersionControlPlugin* plugin, plugins) {
-        const QString fileName = directory.path(KUrl::AddTrailingSlash) + plugin->fileName();
+    for (const auto &it : qAsConst(m_plugins)) {
+        const QString fileName = directory.path() + '/' + it.second;

         if (QFile::exists(fileName)) {
         if (QFile::exists(fileName)) {

-            return plugin;
+            // 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;

         }
 
         // Version control systems like Git provide the version information
         }
 
         // Version control systems like Git provide the version information


@@ -306,25 +346,30 @@ KVersionControlPlugin* VersionControlObserver::searchPlugin(const KUrl& director
         // m_versionedDirectory. Drawback: Until e. g. Git is recognized, the root directory
         // must be shown at least once.
         if (m_versionedDirectory) {
         // 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();
-            while (upUrl != dirUrl) {
-                const QString fileName = dirUrl.path(KUrl::AddTrailingSlash) + plugin->fileName();
+            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 (QFile::exists(fileName)) {

-                    return plugin;
+                    if (upUrlCounter < bestScore) {
+                        bestPlugin = it.first;
+                        bestScore = upUrlCounter;
+                    }
+                    break;

                 }
                 dirUrl = upUrl;
                 }
                 dirUrl = upUrl;

-                upUrl = dirUrl.upUrl();
+                upUrl = KIO::upUrl(dirUrl);
+                ++upUrlCounter;

             }
         }
     }
 
             }
         }
     }
 

-    return 0;
+    return bestPlugin;

 }
 
 }
 

-bool VersionControlObserver::isVersioned() const
+bool VersionControlObserver::isVersionControlled() const

 {
     return m_versionedDirectory && m_plugin;
 }
 
 {
     return m_versionedDirectory && m_plugin;
 }
 

-#include "versioncontrolobserver.moc"