]> cloud.milkyroute.net Git - dolphin.git/blobdiff - src/views/versioncontrol/versioncontrolobserver.cpp
Allow compiling Dolphin with KF5
[dolphin.git] / src / views / versioncontrol / versioncontrolobserver.cpp
index 9c3939632d6d10a77262807868161cd8ea781c48..51502398cffb6e9a806ba494e6c4417a858bd640 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2009 by Peter Penz <peter.penz@gmx.at>                  *
+ *   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  *
 
 #include "dolphin_versioncontrolsettings.h"
 
-#include <kdirlister.h>
-#include <klocale.h>
-#include <kservice.h>
-#include <kservicetypetrader.h>
-#include <kversioncontrolplugin.h>
+#include <KLocale>
+#include <KService>
+#include <KDebug>
+#include <KServiceTypeTrader>
+#include <kitemviews/kfileitemmodel.h>
+#include <kversioncontrolplugin2.h>
 
-#include "pendingthreadsmaintainer.h"
 #include "updateitemstatesthread.h"
 
-#include <QAbstractProxyModel>
-#include <QAbstractItemView>
+#include <QFile>
 #include <QMutexLocker>
 #include <QTimer>
 
-#include <views/dolphinmodel.h>
-
-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_model(0),
     m_dirVerificationTimer(0),
     m_plugin(0),
     m_updateItemStatesThread(0)
 {
-    Q_ASSERT(view != 0);
-
-    QAbstractProxyModel* proxyModel = qobject_cast<QAbstractProxyModel*>(view->model());
-    m_dolphinModel = (proxyModel == 0) ?
-                     qobject_cast<DolphinModel*>(view->model()) :
-                     qobject_cast<DolphinModel*>(proxyModel->sourceModel());
-    if (m_dolphinModel != 0) {
-        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, SIGNAL(timeout()),
-                this, SLOT(verifyDirectory()));
+VersionControlObserver::~VersionControlObserver()
+{
+    if (m_plugin) {
+        m_plugin->disconnect(this);
+        m_plugin = 0;
     }
 }
 
-VersionControlObserver::~VersionControlObserver()
+void VersionControlObserver::setModel(KFileItemModel* model)
 {
-    if (m_updateItemStatesThread != 0) {
-        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_model) {
+        disconnect(m_model, SIGNAL(itemsInserted(KItemRangeList)),
+                   this, SLOT(delayedDirectoryVerification()));
+        disconnect(m_model, SIGNAL(itemsChanged(KItemRangeList,QSet<QByteArray>)),
+                   this, SLOT(delayedDirectoryVerification()));
     }
 
-    if (m_plugin != 0) {
-        m_plugin->disconnect();
-        m_plugin = 0;
+    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()));
     }
 }
 
-QList<QAction*> VersionControlObserver::contextMenuActions(const KFileItemList& items) const
+KFileItemModel* VersionControlObserver::model() const
 {
-    QList<QAction*> actions;
-    if (isVersioned() && m_updateItemStatesThread->lockPlugin()) {
-        actions = m_plugin->contextMenuActions(items);
-        m_updateItemStatesThread->unlockPlugin();
-    }
-    return actions;
+    return m_model;
 }
 
-QList<QAction*> VersionControlObserver::contextMenuActions(const QString& directory) const
+QList<QAction*> VersionControlObserver::actions(const KFileItemList& items) const
 {
     QList<QAction*> actions;
-    if (isVersioned() && m_updateItemStatesThread->lockPlugin()) {
-        actions = m_plugin->contextMenuActions(directory);
-        m_updateItemStatesThread->unlockPlugin();
+
+    bool hasNullItems = false;
+    foreach (const KFileItem& item, items) {
+        if (item.isNull()) {
+            kWarning() << "Requesting version-control-actions for empty items";
+            hasNullItems = true;
+            break;
+        }
+    }
+
+    if (!m_model || hasNullItems) {
+        return actions;
+    }
+
+    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();
+            }
+        }
+
+        actions = directory.isEmpty() ? m_plugin->contextMenuActions(items)
+                                      : m_plugin->contextMenuActions(directory);
     }
 
     return actions;
@@ -132,19 +142,29 @@ void VersionControlObserver::silentDirectoryVerification()
 
 void VersionControlObserver::verifyDirectory()
 {
-    const KUrl versionControlUrl = m_dirLister->url();
-    if (!versionControlUrl.isLocalFile()) {
+    if (!m_model) {
         return;
     }
 
-    if (m_plugin != 0) {
-        m_plugin->disconnect();
+    const KFileItem rootItem = m_model->rootItem();
+    if (rootItem.isNull() || !rootItem.url().isLocalFile()) {
+        return;
+    }
+
+    if (m_plugin) {
+        m_plugin->disconnect(this);
     }
 
-    m_plugin = searchPlugin(versionControlUrl);
-    if (m_plugin != 0) {
-        connect(m_plugin, SIGNAL(versionStatesChanged()),
-                this, SLOT(silentDirectoryVerification()));
+    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)),
@@ -158,10 +178,6 @@ void VersionControlObserver::verifyDirectory()
             // 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()));
         }
         updateItemStates();
     } else if (m_versionedDirectory) {
@@ -171,41 +187,29 @@ void VersionControlObserver::verifyDirectory()
         // 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 == 0) {
-        return;
-    }
+    UpdateItemStatesThread* thread = m_updateItemStatesThread;
+    m_updateItemStatesThread = 0; // 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();
 
-    m_dolphinModel->blockSignals(signalsBlocked);
-    m_view->viewport()->repaint();
+        foreach (const ItemState& item, items) {
+            QHash<QByteArray, QVariant> values;
+            values.insert("version", QVariant(item.version));
+            m_model->setData(m_model->index(item.item), values);
+        }
+    }
 
     if (!m_silentUpdate) {
         // Using an empty message results in clearing the previously shown information message and showing
@@ -222,44 +226,64 @@ void VersionControlObserver::slotThreadFinished()
 
 void VersionControlObserver::updateItemStates()
 {
-    Q_ASSERT(m_plugin != 0);
-    if (m_updateItemStatesThread == 0) {
-        m_updateItemStatesThread = new UpdateItemStatesThread();
-        connect(m_updateItemStatesThread, SIGNAL(finished()),
-                this, SLOT(slotThreadFinished()));
-    }
-    if (m_updateItemStatesThread->isRunning()) {
+    Q_ASSERT(m_plugin);
+    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..."));
         }
-        m_updateItemStatesThread->setData(m_plugin, itemStates);
+        m_updateItemStatesThread = new UpdateItemStatesThread(m_plugin, itemStates);
+        connect(m_updateItemStatesThread, SIGNAL(finished()),
+                this, SLOT(slotThreadFinished()));
+        connect(m_updateItemStatesThread, SIGNAL(finished()),
+                m_updateItemStatesThread, SLOT(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);
+
+    QVector<ItemState> items;
+    items.reserve(itemCount - firstIndex);
 
-        ItemState itemState;
-        itemState.index = index;
-        itemState.item = m_dolphinModel->itemForIndex(index);
-        itemState.version = KVersionControlPlugin::UnversionedVersion;
+    int index;
+    for (index = firstIndex; index < itemCount; ++index) {
+        const int expansionLevel = m_model->expandedParentsCount(index);
 
-        itemStates.append(itemState);
+        if (expansionLevel == currentExpansionLevel) {
+            ItemState itemState;
+            itemState.item = m_model->fileItem(index);
+            itemState.version = KVersionControlPlugin2::UnversionedVersion;
+
+            items.append(itemState);
+        } else if (expansionLevel > currentExpansionLevel) {
+            // Sub folder
+            index += createItemStatesList(itemStates, index) - 1;
+        } else {
+            break;
+        }
     }
+
+    if (items.count() > 0) {
+        const KUrl& url = items.first().item.url();
+        itemStates.insert(url.directory(KUrl::AppendTrailingSlash), items);
+    }
+
+    return index - firstIndex; // number of processed items
 }
 
 KVersionControlPlugin* VersionControlObserver::searchPlugin(const KUrl& directory) const
@@ -282,7 +306,7 @@ KVersionControlPlugin* VersionControlObserver::searchPlugin(const KUrl& director
         for (KService::List::ConstIterator it = pluginServices.constBegin(); it != pluginServices.constEnd(); ++it) {
             if (enabledPlugins.contains((*it)->name())) {
                 KVersionControlPlugin* plugin = (*it)->createInstance<KVersionControlPlugin>();
-                if (plugin != 0) {
+                if (plugin) {
                     plugins.append(plugin);
                 }
             }
@@ -296,12 +320,8 @@ KVersionControlPlugin* VersionControlObserver::searchPlugin(const KUrl& director
     // 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()) {
+        const QString fileName = directory.path(KUrl::AddTrailingSlash) + plugin->fileName();
+        if (QFile::exists(fileName)) {
             return plugin;
         }
 
@@ -312,11 +332,11 @@ 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) {
+            KUrl dirUrl(directory);
             KUrl upUrl = dirUrl.upUrl();
             while (upUrl != dirUrl) {
-                const QString filePath = dirUrl.pathOrUrl(KUrl::AddTrailingSlash) + plugin->fileName();
-                QFileInfo file(filePath);
-                if (file.exists()) {
+                const QString fileName = dirUrl.path(KUrl::AddTrailingSlash) + plugin->fileName();
+                if (QFile::exists(fileName)) {
                     return plugin;
                 }
                 dirUrl = upUrl;
@@ -330,7 +350,7 @@ KVersionControlPlugin* VersionControlObserver::searchPlugin(const KUrl& director
 
 bool VersionControlObserver::isVersioned() const
 {
-    return m_dolphinModel->hasVersionData() && (m_plugin != 0);
+    return m_versionedDirectory && m_plugin;
 }
 
 #include "versioncontrolobserver.moc"