]> cloud.milkyroute.net Git - dolphin.git/blobdiff - src/revisioncontrolobserver.cpp
Assure that no empty error message is shown in the statusbar. This should not happen...
[dolphin.git] / src / revisioncontrolobserver.cpp
index d6c2cb675d78ed7691001253186e428bb28661e4..87f0a3aa7dcd2435ca7fe2bfa7fdd386aec5cd31 100644 (file)
 #include "revisioncontrolplugin.h"
 
 #include <kdirlister.h>
+#include <klocale.h>
 
 #include <QAbstractProxyModel>
 #include <QAbstractItemView>
+#include <QMutexLocker>
 #include <QTimer>
 
 /**
 class UpdateItemStatesThread : public QThread
 {
 public:
-    UpdateItemStatesThread(QObject* parent);
+    UpdateItemStatesThread(QObject* parent, QMutex* pluginMutex);
     void setData(RevisionControlPlugin* plugin,
                  const QList<RevisionControlObserver::ItemState>& itemStates);
     QList<RevisionControlObserver::ItemState> itemStates() const;
-    
+    bool retrievedItems() const;
+
 protected:
     virtual void run();
     
 private:
+    bool m_retrievedItems;
     RevisionControlPlugin* m_plugin;
+    QMutex* m_pluginMutex;
     QList<RevisionControlObserver::ItemState> m_itemStates;
 };
 
-UpdateItemStatesThread::UpdateItemStatesThread(QObject* parent) :
-    QThread(parent)
+UpdateItemStatesThread::UpdateItemStatesThread(QObject* parent, QMutex* pluginMutex) :
+    QThread(parent),
+    m_retrievedItems(false),
+    m_pluginMutex(pluginMutex),
+    m_itemStates()
 {
 }
 
@@ -63,18 +71,24 @@ void UpdateItemStatesThread::setData(RevisionControlPlugin* plugin,
 
 void UpdateItemStatesThread::run()
 {
-    Q_ASSERT(m_itemStates.count() > 0);
+    Q_ASSERT(!m_itemStates.isEmpty());
     Q_ASSERT(m_plugin != 0);
-    
-    // it is assumed that all items have the same parent directory
-    const QString directory = m_itemStates.first().item.url().directory(KUrl::AppendTrailingSlash);
-    
+
+    // The items from m_itemStates may be located in different directory levels. The revision
+    // plugin requires the root directory for RevisionControlPlugin::beginRetrieval(). Instead
+    // of doing an expensive search, we utilize the knowledge of the implementation of
+    // RevisionControlObserver::addDirectory() to be sure that the last item contains the root.
+    const QString directory = m_itemStates.last().item.url().directory(KUrl::AppendTrailingSlash);
+
+    QMutexLocker locker(m_pluginMutex);
+    m_retrievedItems = false;
     if (m_plugin->beginRetrieval(directory)) {
         const int count = m_itemStates.count();
         for (int i = 0; i < count; ++i) {
             m_itemStates[i].revision = m_plugin->revisionState(m_itemStates[i].item);
         }
         m_plugin->endRetrieval();
+        m_retrievedItems = true;
     }
 }
 
@@ -83,16 +97,23 @@ QList<RevisionControlObserver::ItemState> UpdateItemStatesThread::itemStates() c
     return m_itemStates;
 }
 
-// ---
+bool UpdateItemStatesThread::retrievedItems() const
+{
+    return m_retrievedItems;
+}
+
+// ------------------------------------------------------------------------------------------------
 
 RevisionControlObserver::RevisionControlObserver(QAbstractItemView* view) :
     QObject(view),
     m_pendingItemStatesUpdate(false),
     m_revisionedDirectory(false),
+    m_silentUpdate(false),
     m_view(view),
     m_dirLister(0),
     m_dolphinModel(0),
     m_dirVerificationTimer(0),
+    m_pluginMutex(QMutex::Recursive),
     m_plugin(0),
     m_updateItemStatesThread(0)
 {
@@ -100,8 +121,8 @@ RevisionControlObserver::RevisionControlObserver(QAbstractItemView* view) :
 
     QAbstractProxyModel* proxyModel = qobject_cast<QAbstractProxyModel*>(view->model());
     m_dolphinModel = (proxyModel == 0) ?
-                 qobject_cast<DolphinModel*>(view->model()) :
-                 qobject_cast<DolphinModel*>(proxyModel->sourceModel());
+                     qobject_cast<DolphinModel*>(view->model()) :
+                     qobject_cast<DolphinModel*>(proxyModel->sourceModel());
     if (m_dolphinModel != 0) {
         m_dirLister = m_dolphinModel->dirLister();
         connect(m_dirLister, SIGNAL(completed()),
@@ -122,6 +143,10 @@ RevisionControlObserver::RevisionControlObserver(QAbstractItemView* view) :
 
 RevisionControlObserver::~RevisionControlObserver()
 {
+    if (m_updateItemStatesThread != 0) {
+        m_updateItemStatesThread->terminate();
+        m_updateItemStatesThread->wait();
+    }
     delete m_plugin;
     m_plugin = 0;
 }
@@ -129,14 +154,31 @@ RevisionControlObserver::~RevisionControlObserver()
 QList<QAction*> RevisionControlObserver::contextMenuActions(const KFileItemList& items) const
 {
     if (m_dolphinModel->hasRevisionData() && (m_plugin != 0)) {
+        QMutexLocker locker(&m_pluginMutex);
         return m_plugin->contextMenuActions(items);
     }
+    return QList<QAction*>();
+}
+
+QList<QAction*> RevisionControlObserver::contextMenuActions(const QString& directory) const
+{
+    if (m_dolphinModel->hasRevisionData() && (m_plugin != 0)) {
+        QMutexLocker locker(&m_pluginMutex);
+        return m_plugin->contextMenuActions(directory);
+    }
 
     return QList<QAction*>();
 }
 
 void RevisionControlObserver::delayedDirectoryVerification()
 {
+    m_silentUpdate = false;
+    m_dirVerificationTimer->start();
+}
+
+void RevisionControlObserver::silentDirectoryVerification()
+{
+    m_silentUpdate = true;
     m_dirVerificationTimer->start();
 }
 
@@ -150,37 +192,65 @@ void RevisionControlObserver::verifyDirectory()
     if (m_plugin == 0) {
         // TODO: just for testing purposes. A plugin approach will be used later.
         m_plugin = new SubversionPlugin();
+        connect(m_plugin, SIGNAL(infoMessage(const QString&)),
+                this, SIGNAL(infoMessage(const QString&)));
+        connect(m_plugin, SIGNAL(errorMessage(const QString&)),
+                this, SIGNAL(errorMessage(const QString&)));
+        connect(m_plugin, SIGNAL(operationCompletedMessage(const QString&)),
+                this, SIGNAL(operationCompletedMessage(const QString&)));
     }
 
     revisionControlUrl.addPath(m_plugin->fileName());
     const KFileItem item = m_dirLister->findByUrl(revisionControlUrl);
-    if (item.isNull() && m_revisionedDirectory) {
-        // 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);
-        m_revisionedDirectory = false;
-        disconnect(m_dirLister, SIGNAL(refreshItems(const QList<QPair<KFileItem,KFileItem>>&)),
-                   this, SLOT(delayedDirectoryVerification()));
-        disconnect(m_dirLister, SIGNAL(newItems(const KFileItemList&)),
-                   this, SLOT(delayedDirectoryVerification()));
-    } else if (!item.isNull()) {
+
+    bool foundRevisionInfo = !item.isNull();
+    if (!foundRevisionInfo && m_revisionedDirectory) {
+        // Revision control systems like Git provide the revision information
+        // file only in the root directory. Check whether the revision information file can
+        // be found in one of the parent directories.
+
+        // TODO...
+    }
+
+    if (foundRevisionInfo) {
         if (!m_revisionedDirectory) {
+            m_revisionedDirectory = true;
+
             // The directory is versioned. Assume that the user will further browse through
             // versioned directories and decrease the verification timer.
             m_dirVerificationTimer->setInterval(100);
-            m_revisionedDirectory = true;
             connect(m_dirLister, SIGNAL(refreshItems(const QList<QPair<KFileItem,KFileItem>>&)),
                     this, SLOT(delayedDirectoryVerification()));
             connect(m_dirLister, SIGNAL(newItems(const KFileItemList&)),
                     this, SLOT(delayedDirectoryVerification()));
+            connect(m_plugin, SIGNAL(revisionStatesChanged()),
+                    this, SLOT(silentDirectoryVerification()));
         }
         updateItemStates();
+    } else if (m_revisionedDirectory) {
+        m_revisionedDirectory = 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);
+        disconnect(m_dirLister, SIGNAL(refreshItems(const QList<QPair<KFileItem,KFileItem>>&)),
+                   this, SLOT(delayedDirectoryVerification()));
+        disconnect(m_dirLister, SIGNAL(newItems(const KFileItemList&)),
+                   this, SLOT(delayedDirectoryVerification()));
+        disconnect(m_plugin, SIGNAL(revisionStatesChanged()),
+                   this, SLOT(silentDirectoryVerification()));
     }
 }
 
 void RevisionControlObserver::applyUpdatedItemStates()
 {
+    if (!m_updateItemStatesThread->retrievedItems()) {
+        // ignore m_silentUpdate for an error message
+        emit errorMessage(i18nc("@info:status", "Update of revision information failed."));
+        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.
@@ -197,6 +267,13 @@ void RevisionControlObserver::applyUpdatedItemStates()
 
     m_dolphinModel->blockSignals(signalsBlocked);
     m_view->viewport()->repaint();
+
+    if (!m_silentUpdate) {
+        // 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());
+    }
     
     if (m_pendingItemStatesUpdate) {
         m_pendingItemStatesUpdate = false;
@@ -208,7 +285,7 @@ void RevisionControlObserver::updateItemStates()
 {
     Q_ASSERT(m_plugin != 0);
     if (m_updateItemStatesThread == 0) {
-        m_updateItemStatesThread = new UpdateItemStatesThread(this);
+        m_updateItemStatesThread = new UpdateItemStatesThread(this, &m_pluginMutex);
         connect(m_updateItemStatesThread, SIGNAL(finished()),
                 this, SLOT(applyUpdatedItemStates()));
     }
@@ -219,25 +296,31 @@ void RevisionControlObserver::updateItemStates()
         return;
     }
     
-    const int rowCount = m_dolphinModel->rowCount();
-    if (rowCount > 0) {
-        // Build a list of all items in the current directory and delegate
-        // this list to the thread, which adjusts the revision states.
-        QList<ItemState> itemStates;
-        for (int row = 0; row < rowCount; ++row) {
-            const QModelIndex index = m_dolphinModel->index(row, DolphinModel::Revision);
-            
-            ItemState itemState;
-            itemState.index = index;
-            itemState.item = m_dolphinModel->itemForIndex(index);
-            itemState.revision = RevisionControlPlugin::LocalRevision;
-            
-            itemStates.append(itemState);
+    QList<ItemState> itemStates;
+    addDirectory(QModelIndex(), itemStates);
+    if (!itemStates.isEmpty()) {
+        if (!m_silentUpdate) {
+            emit infoMessage(i18nc("@info:status", "Updating revision information..."));
         }
-        
         m_updateItemStatesThread->setData(m_plugin, itemStates);
         m_updateItemStatesThread->start(); // applyUpdatedItemStates() is called when finished
     }
 }
 
+void RevisionControlObserver::addDirectory(const QModelIndex& parentIndex, QList<ItemState>& itemStates)
+{
+    const int rowCount = m_dolphinModel->rowCount(parentIndex);
+    for (int row = 0; row < rowCount; ++row) {
+        const QModelIndex index = m_dolphinModel->index(row, DolphinModel::Revision, parentIndex);
+        addDirectory(index, itemStates);
+        
+        ItemState itemState;
+        itemState.index = index;
+        itemState.item = m_dolphinModel->itemForIndex(index);
+        itemState.revision = RevisionControlPlugin::UnversionedRevision;
+
+        itemStates.append(itemState);
+    }
+}
+
 #include "revisioncontrolobserver.moc"