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 c41803c161cab573ffffab9409bcedcf260fbafe..f6c74fb5fe4de9eee2e1b8560142b4cab93a1ecb 100644 (file)
--- a/src/views/versioncontrol/versioncontrolobserver.cpp
+++ b/src/views/versioncontrol/versioncontrolobserver.cpp
@@ -20,18 +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 <KService>

-#include <KDebug>

 #include <KServiceTypeTrader>
 #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) :


@@ -39,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


@@ -60,7 +59,7 @@ VersionControlObserver::~VersionControlObserver()
 {
     if (m_plugin) {
         m_plugin->disconnect(this);
 {
     if (m_plugin) {
         m_plugin->disconnect(this);

-        m_plugin = 0;
+        m_plugin = nullptr;

     }
 }
 
     }
 }
 


@@ -70,7 +69,7 @@ void VersionControlObserver::setModel(KFileItemModel* model)
         disconnect(m_model, &KFileItemModel::itemsInserted,
                    this, &VersionControlObserver::delayedDirectoryVerification);
         disconnect(m_model, &KFileItemModel::itemsChanged,
         disconnect(m_model, &KFileItemModel::itemsInserted,
                    this, &VersionControlObserver::delayedDirectoryVerification);
         disconnect(m_model, &KFileItemModel::itemsChanged,

-                   this, &VersionControlObserver::delayedDirectoryVerification);
+                   this, &VersionControlObserver::slotItemsChanged);

     }
 
     m_model = model;
     }
 
     m_model = model;


@@ -79,7 +78,7 @@ void VersionControlObserver::setModel(KFileItemModel* model)
         connect(m_model, &KFileItemModel::itemsInserted,
                 this, &VersionControlObserver::delayedDirectoryVerification);
         connect(m_model, &KFileItemModel::itemsChanged,
         connect(m_model, &KFileItemModel::itemsInserted,
                 this, &VersionControlObserver::delayedDirectoryVerification);
         connect(m_model, &KFileItemModel::itemsChanged,

-                this, &VersionControlObserver::delayedDirectoryVerification);
+                this, &VersionControlObserver::slotItemsChanged);

     }
 }
 
     }
 }
 


@@ -88,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();
-            }
+    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()


@@ -140,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) {


@@ -157,14 +174,8 @@ 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, &KVersionControlPlugin2::itemVersionsChanged,
-                    this, &VersionControlObserver::silentDirectoryVerification);
-        } else {
-            connect(m_plugin, &KVersionControlPlugin::versionStatesChanged,
-                    this, &VersionControlObserver::silentDirectoryVerification);
-        }
+        connect(m_plugin, &KVersionControlPlugin::itemVersionsChanged,
+                this, &VersionControlObserver::silentDirectoryVerification);

         connect(m_plugin, &KVersionControlPlugin::infoMessage,
                 this, &VersionControlObserver::infoMessage);
         connect(m_plugin, &KVersionControlPlugin::errorMessage,
         connect(m_plugin, &KVersionControlPlugin::infoMessage,
                 this, &VersionControlObserver::infoMessage);
         connect(m_plugin, &KVersionControlPlugin::errorMessage,


@@ -193,7 +204,7 @@ 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;


@@ -205,9 +216,11 @@ void VersionControlObserver::slotThreadFinished()
         const QVector<ItemState>& items = it.value();
 
         foreach (const ItemState& item, items) {
         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;
             QHash<QByteArray, QVariant> 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);

         }
     }
 
         }
     }
 


@@ -266,8 +279,8 @@ int VersionControlObserver::createItemStatesList(QMap<QString, QVector<ItemState
 
         if (expansionLevel == currentExpansionLevel) {
             ItemState itemState;
 
         if (expansionLevel == currentExpansionLevel) {
             ItemState itemState;

-            itemState.item = m_model->fileItem(index);
-            itemState.version = KVersionControlPlugin2::UnversionedVersion;
+            itemState.first = m_model->fileItem(index);
+            itemState.second = KVersionControlPlugin::UnversionedVersion;

 
             items.append(itemState);
         } else if (expansionLevel > currentExpansionLevel) {
 
             items.append(itemState);
         } else if (expansionLevel > currentExpansionLevel) {


@@ -278,58 +291,52 @@ int VersionControlObserver::createItemStatesList(QMap<QString, QVector<ItemState
         }
     }
 
         }
     }
 

-    if (items.count() > 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
 }
 
     }
 
     return index - firstIndex; // number of processed items
 }
 

-KVersionControlPlugin* VersionControlObserver::searchPlugin(const KUrl& directory) const
+KVersionControlPlugin* VersionControlObserver::searchPlugin(const QUrl& directory)

 {
 {

-    static bool pluginsAvailable = true;
-    static QList<KVersionControlPlugin*> plugins;
-
-    if (!pluginsAvailable) {
-        // A searching for plugins has already been done, but no
-        // plugins are installed
-        return 0;
-    }
-
-    if (plugins.isEmpty()) {
+    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).
     }
 
     // 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;
+    KVersionControlPlugin* bestPlugin = nullptr;

     int bestScore = INT_MAX;
 
     // Verify whether the current directory contains revision information
     // like .svn, .git, ...
     int bestScore = INT_MAX;
 
     // 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)) {
             // 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 ;)
         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 plugin;
+            return it.first;

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


@@ -339,20 +346,20 @@ 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();
+            QUrl dirUrl(directory);
+            QUrl upUrl = KIO::upUrl(dirUrl);

             int upUrlCounter = 1;
             while ((upUrlCounter < bestScore) && (upUrl != dirUrl)) {
             int upUrlCounter = 1;
             while ((upUrlCounter < bestScore) && (upUrl != dirUrl)) {

-                const QString fileName = dirUrl.path(KUrl::AddTrailingSlash) + plugin->fileName();
+                const QString fileName = dirUrl.path() + '/' + it.second;

                 if (QFile::exists(fileName)) {
                     if (upUrlCounter < bestScore) {
                 if (QFile::exists(fileName)) {
                     if (upUrlCounter < bestScore) {

-                        bestPlugin = plugin;
+                        bestPlugin = it.first;

                         bestScore = upUrlCounter;
                     }
                     break;
                 }
                 dirUrl = upUrl;
                         bestScore = upUrlCounter;
                     }
                     break;
                 }
                 dirUrl = upUrl;

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

                 ++upUrlCounter;
             }
         }
                 ++upUrlCounter;
             }
         }


@@ -361,7 +368,7 @@ KVersionControlPlugin* VersionControlObserver::searchPlugin(const KUrl& director
     return bestPlugin;
 }
 
     return bestPlugin;
 }
 

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

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