diff options
| author | Peter Penz <[email protected]> | 2010-07-24 22:17:01 +0000 |
|---|---|---|
| committer | Peter Penz <[email protected]> | 2010-07-24 22:17:01 +0000 |
| commit | 1cb5a202e4c861025d4eda5813848cdb7d5f350d (patch) | |
| tree | 3f9696104b3c666f2a66c23c06b9427c759a012d /src/views/versioncontrol | |
| parent | a5cf21ff06aff44cde563eaceae3c6cef452ee48 (diff) | |
Sourcecode hierarchy cleanup: Move folders "tooltips" and "versioncontrol" into "views"
svn path=/trunk/KDE/kdebase/apps/; revision=1154151
Diffstat (limited to 'src/views/versioncontrol')
| -rw-r--r-- | src/views/versioncontrol/fileviewversioncontrolplugin.desktop | 60 | ||||
| -rw-r--r-- | src/views/versioncontrol/pendingthreadsmaintainer.cpp | 77 | ||||
| -rw-r--r-- | src/views/versioncontrol/pendingthreadsmaintainer.h | 83 | ||||
| -rw-r--r-- | src/views/versioncontrol/updateitemstatesthread.cpp | 101 | ||||
| -rw-r--r-- | src/views/versioncontrol/updateitemstatesthread.h | 84 | ||||
| -rw-r--r-- | src/views/versioncontrol/versioncontrolobserver.cpp | 335 | ||||
| -rw-r--r-- | src/views/versioncontrol/versioncontrolobserver.h | 149 |
7 files changed, 889 insertions, 0 deletions
diff --git a/src/views/versioncontrol/fileviewversioncontrolplugin.desktop b/src/views/versioncontrol/fileviewversioncontrolplugin.desktop new file mode 100644 index 000000000..4239d4ddc --- /dev/null +++ b/src/views/versioncontrol/fileviewversioncontrolplugin.desktop @@ -0,0 +1,60 @@ +[Desktop Entry] +Type=ServiceType +X-KDE-ServiceType=FileViewVersionControlPlugin +Comment=Version Control Plugin for File Views +Comment[ca]=Connector de control de versions per a les vistes de fitxers +Comment[ca@valencia]=Connector de control de versions per a les vistes de fitxers +Comment[cs]=Modul pro správu verzí pro pohledy na soubory +Comment[csb]=Wtëkôcz kòntrolë wersëji dlô pòdzerków lopków +Comment[da]=Versionsstyringsplugin til filvisninger +Comment[de]=Versionskontroll-Modul für Dateiansichten +Comment[el]=Έλεγχος εκδόσεων πρόσθετων για την προβολή των αρχείων +Comment[en_GB]=Version Control Plugin for File Views +Comment[eo]=Kromprogramo de versia kontrolo por dosiervidilo +Comment[es]=Complemento de control de versiones para vistas de archivos +Comment[et]=Failivaadete versioonikontrolli plugin +Comment[eu]=Bertsio kontrol plugina fitxategi ikuspegietarako +Comment[fi]=Versionhallintaliitännäinen tiedostonäkymille +Comment[fr]=Module externe de contrôle de révision pour la vue de fichiers +Comment[fy]=Ferzje kontrôle plugin foar triem werjeften +Comment[hr]=Priključak sustava kontrole inačica za prikaz datoteka +Comment[hu]=Verziókövető modul fájlnézetekhez +Comment[ia]=Plugin de Controlo de Version pro vistas de file +Comment[id]=Plugin Kontrol Versi untuk Tampilan Berkas +Comment[is]=Útgáfustýringar-íforrit fyrir skráasýnir +Comment[it]=Estensione di controllo delle versioni per le viste dei file +Comment[ja]=ファイルビューのためのバージョン管理プラグイン +Comment[kk]=Файл көрнісіне арналған Нұсқаларды басқару плагины +Comment[km]=កំណែកម្មវិធីជំនួយវត្ថុបញ្ជាសម្រាប់មើលឯកសារ +Comment[kn]=ಕಡತ ನೋಟಗಳಿಗಾಗಿ ಆವೃತ್ತಿ ನಿಯಂತ್ರಣಾ ವ್ಯವಸ್ಥೆ ಪ್ಲಗ್ಗಿನ್ (ಮಿಳಿತಾನ್ವಯ) +Comment[ko]=파일 보기를 위한 버전 관리 플러그인 +Comment[lt]=Versijų kontrolės priedas failų tvarkyklėms +Comment[lv]=Versiju kontroles spraudnis Failu skatiem +Comment[mk]=Приклучок за „Преглед на датотеки“ за контрола на верзии +Comment[ml]=ഫയല് അവതരണത്തിനുള്ള വേര്ഷന് കണ്ട്രോള് സംയോജകം +Comment[nb]=Versjonskontrollmodul for filvisninger +Comment[nds]=Verschoonkuntrull-Moduul för Dateiansichten +Comment[nl]=Plugin voor versiecontrole op bestandoverzichten +Comment[nn]=Versjonskontroll-tillegg for filvisingar +Comment[pa]=ਫਾਇਲ ਝਲਕ ਲਈ ਵਰਜਨ ਕੰਟਰੋਲ ਪਲੱਗਇਨ +Comment[pl]=Wtyczka kontroli wersji dla widoku plików +Comment[pt]='Plugin' de Controlo de Versões para as Áreas de Ficheiros +Comment[pt_BR]=Extensão de controle de versões para as visualizações de arquivos +Comment[ro]=Modul de control al versiunii pentru Vizualizări fișiere +Comment[ru]=Расширение для управления версиями для компонента просмотра папки +Comment[si]=ගොනු දැකුම් සඳහා අනුවාද පාලන ප්ලගින +Comment[sk]=Modul pre správu verzií v súborovom zobrazení +Comment[sl]=Vstavek za delo z nadzorom različic za prikaz datotek +Comment[sr]=Прикључак управљања верзијама за фајл приказе +Comment[sr@ijekavian]=Прикључак управљања верзијама за фајл приказе +Comment[sr@ijekavianlatin]=Priključak upravljanja verzijama za fajl prikaze +Comment[sr@latin]=Priključak upravljanja verzijama za fajl prikaze +Comment[sv]=Insticksprogram för versionskontroll i filvyer +Comment[tg]=Модули идоракунӣ барои намоиши файлҳо +Comment[th]=ส่วนเสริมการควบคุมเวอร์ชันสำหรับมุมมองแฟ้มต่าง ๆ +Comment[tr]=Dosya Görünümleri için Sürüm Kontrol Eklentisi +Comment[uk]=Додаток керування версіями для панелей перегляду файлів +Comment[wa]=Tchôke-divins di controle del modêye po les Vuwes des fitchîs +Comment[x-test]=xxVersion Control Plugin for File Viewsxx +Comment[zh_CN]=文件视图的版本控制插件 +Comment[zh_TW]=檔案檢視的版本控制外掛程式 diff --git a/src/views/versioncontrol/pendingthreadsmaintainer.cpp b/src/views/versioncontrol/pendingthreadsmaintainer.cpp new file mode 100644 index 000000000..f61c79975 --- /dev/null +++ b/src/views/versioncontrol/pendingthreadsmaintainer.cpp @@ -0,0 +1,77 @@ +/*************************************************************************** + * Copyright (C) 2010 by Peter Penz <[email protected]> * + * * + * 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 * + ***************************************************************************/ + +#include "pendingthreadsmaintainer.h" + +#include <kglobal.h> +#include <QThread> +#include <QTimer> + +struct PendingThreadsMaintainerSingleton +{ + PendingThreadsMaintainer instance; +}; +K_GLOBAL_STATIC(PendingThreadsMaintainerSingleton, s_pendingThreadsMaintainer) + + +PendingThreadsMaintainer& PendingThreadsMaintainer::instance() +{ + return s_pendingThreadsMaintainer->instance; +} + +PendingThreadsMaintainer::~PendingThreadsMaintainer() +{ +} + +void PendingThreadsMaintainer::append(QThread* thread) +{ + Q_ASSERT(thread != 0); + m_threads.append(thread); + m_timer->start(); +} + +PendingThreadsMaintainer::PendingThreadsMaintainer() : + QObject(), + m_threads(), + m_timer(0) +{ + m_timer = new QTimer(this); + m_timer->setSingleShot(true); + m_timer->setInterval(5000); // 5 seconds + connect(m_timer, SIGNAL(timeout()), this, SLOT(cleanup())); +} + +void PendingThreadsMaintainer::cleanup() +{ + QList<QThread*>::iterator it = m_threads.begin(); + while (it != m_threads.end()) { + if ((*it)->isFinished()) { + (*it)->deleteLater(); + it = m_threads.erase(it); + } else { + ++it; + } + } + + if (!m_threads.isEmpty()) { + m_timer->start(); + } +} + +#include "pendingthreadsmaintainer.moc" diff --git a/src/views/versioncontrol/pendingthreadsmaintainer.h b/src/views/versioncontrol/pendingthreadsmaintainer.h new file mode 100644 index 000000000..342cb421d --- /dev/null +++ b/src/views/versioncontrol/pendingthreadsmaintainer.h @@ -0,0 +1,83 @@ +/*************************************************************************** + * Copyright (C) 2010 by Peter Penz <[email protected]> * + * * + * 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 * + ***************************************************************************/ + +#ifndef PENDINGTHREADSMAINTAINER_H +#define PENDINGTHREADSMAINTAINER_H + +#include <libdolphin_export.h> + +#include <QObject> + +class QTimer; + +/** + * If the creator of a thread gets deleted, although the thread is still + * working, usually QThread::wait() is invoked. The drawback of this + * approach is that the user interface gets blocked for an undefined amount + * of time. If the thread does not contain references to the creator, the + * deleting can be forwarded to the PendingThreadsMaintainer. In the following + * example it is assumed, that m_thread will be 0, if it has been deleted by the + * creator after receiving the signal QThread::finished(): + * + * \code + * ThreadCreator::~ThreadCreator() + * { + * if (m_thread != 0) { + * PendingThreadsMaintainer::instance().append(m_thread); + * m_thread = 0; + * } + * } + * \endcode + * + * The thread will get automatically deleted after it (or has already) been finished. + * + * Implementation note: Connecting to the signal QThread::finished() is + * not sufficient, as it is possible that the thread has already emitted + * the signal, but the signal has not been received yet by the thread creator. + * Because of this a polling is done each 5 seconds to check, whether the + * thread has been finished. + */ +class LIBDOLPHINPRIVATE_EXPORT PendingThreadsMaintainer : public QObject +{ + Q_OBJECT + +public: + static PendingThreadsMaintainer& instance(); + virtual ~PendingThreadsMaintainer(); + + /** + * Appends the thread \p thread to the maintainer. The thread + * will be deleted by the maintainer after it has been finished. + */ + void append(QThread* thread); + +protected: + PendingThreadsMaintainer(); + +private slots: + void cleanup(); + +private: + QList<QThread*> m_threads; + QTimer* m_timer; + + friend class PendingThreadsMaintainerSingleton; +}; + +#endif diff --git a/src/views/versioncontrol/updateitemstatesthread.cpp b/src/views/versioncontrol/updateitemstatesthread.cpp new file mode 100644 index 000000000..57c4481c3 --- /dev/null +++ b/src/views/versioncontrol/updateitemstatesthread.cpp @@ -0,0 +1,101 @@ +/*************************************************************************** + * Copyright (C) 2009 by Peter Penz <[email protected]> * + * * + * 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 * + ***************************************************************************/ + +#include "updateitemstatesthread.h" + +#include <QMutexLocker> + +UpdateItemStatesThread::UpdateItemStatesThread() : + QThread(), + m_globalPluginMutex(0), + m_plugin(0), + m_itemMutex(), + m_retrievedItems(false), + m_itemStates() +{ + // Several threads may share one instance of a plugin. A global + // mutex is required to serialize the retrieval of version control + // states inside run(). + static QMutex globalMutex; + m_globalPluginMutex = &globalMutex; +} + +UpdateItemStatesThread::~UpdateItemStatesThread() +{ +} + +void UpdateItemStatesThread::setData(KVersionControlPlugin* plugin, + const QList<VersionControlObserver::ItemState>& itemStates) +{ + QMutexLocker itemLocker(&m_itemMutex); + m_itemStates = itemStates; + + QMutexLocker pluginLocker(m_globalPluginMutex); + m_plugin = plugin; +} + +void UpdateItemStatesThread::run() +{ + Q_ASSERT(!m_itemStates.isEmpty()); + Q_ASSERT(m_plugin != 0); + + // The items from m_itemStates may be located in different directory levels. The version + // plugin requires the root directory for KVersionControlPlugin::beginRetrieval(). Instead + // of doing an expensive search, we utilize the knowledge of the implementation of + // VersionControlObserver::addDirectory() to be sure that the last item contains the root. + QMutexLocker itemLocker(&m_itemMutex); + const QString directory = m_itemStates.last().item.url().directory(KUrl::AppendTrailingSlash); + itemLocker.unlock(); + + QMutexLocker pluginLocker(m_globalPluginMutex); + m_retrievedItems = false; + if (m_plugin->beginRetrieval(directory)) { + itemLocker.relock(); + const int count = m_itemStates.count(); + for (int i = 0; i < count; ++i) { + m_itemStates[i].version = m_plugin->versionState(m_itemStates[i].item); + } + m_plugin->endRetrieval(); + m_retrievedItems = true; + } +} + +bool UpdateItemStatesThread::lockPlugin() +{ + return m_globalPluginMutex->tryLock(300); +} + +void UpdateItemStatesThread::unlockPlugin() +{ + m_globalPluginMutex->unlock(); +} + +QList<VersionControlObserver::ItemState> UpdateItemStatesThread::itemStates() const +{ + QMutexLocker locker(&m_itemMutex); + return m_itemStates; +} + +bool UpdateItemStatesThread::retrievedItems() const +{ + QMutexLocker locker(&m_itemMutex); + return m_retrievedItems; +} + +#include "updateitemstatesthread.moc" diff --git a/src/views/versioncontrol/updateitemstatesthread.h b/src/views/versioncontrol/updateitemstatesthread.h new file mode 100644 index 000000000..9fac6192c --- /dev/null +++ b/src/views/versioncontrol/updateitemstatesthread.h @@ -0,0 +1,84 @@ +/*************************************************************************** + * Copyright (C) 2009 by Peter Penz <[email protected]> * + * * + * 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 * + ***************************************************************************/ + +#ifndef UPDATEITEMSTATESTHREAD_H +#define UPDATEITEMSTATESTHREAD_H + +#include <libdolphin_export.h> +#include <views/versioncontrol/versioncontrolobserver.h> + +#include <QMutex> +#include <QThread> + +class KVersionControlPlugin; + +/** + * The performance of updating the version state of items depends + * on the used plugin. To prevent that Dolphin gets blocked by a + * slow plugin, the updating is delegated to a thread. + */ +class LIBDOLPHINPRIVATE_EXPORT UpdateItemStatesThread : public QThread +{ + Q_OBJECT + +public: + UpdateItemStatesThread(); + virtual ~UpdateItemStatesThread(); + + /** + * @param plugin Version control plugin that is used to update the + * state of the items. Whenever the plugin is accessed + * from the thread creator after starting the thread, + * UpdateItemStatesThread::lockPlugin() and + * UpdateItemStatesThread::unlockPlugin() must be used. + * @param itemStates List of items, where the states get updated. + */ + void setData(KVersionControlPlugin* plugin, + const QList<VersionControlObserver::ItemState>& itemStates); + + /** + * Whenever the plugin is accessed by the thread creator, lockPlugin() must + * be invoked. True is returned, if the plugin could be locked within 300 + * milliseconds. + */ + bool lockPlugin(); + + /** + * Must be invoked if lockPlugin() returned true and plugin has been accessed + * by the thread creator. + */ + void unlockPlugin(); + + QList<VersionControlObserver::ItemState> itemStates() const; + + bool retrievedItems() const; + +protected: + virtual void run(); + +private: + QMutex* m_globalPluginMutex; // Protects the m_plugin globally + KVersionControlPlugin* m_plugin; + + mutable QMutex m_itemMutex; // Protects m_retrievedItems and m_itemStates + bool m_retrievedItems; + QList<VersionControlObserver::ItemState> m_itemStates; +}; + +#endif // UPDATEITEMSTATESTHREAD_H diff --git a/src/views/versioncontrol/versioncontrolobserver.cpp b/src/views/versioncontrol/versioncontrolobserver.cpp new file mode 100644 index 000000000..51337e097 --- /dev/null +++ b/src/views/versioncontrol/versioncontrolobserver.cpp @@ -0,0 +1,335 @@ +/*************************************************************************** + * Copyright (C) 2009 by Peter Penz <[email protected]> * + * * + * 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 * + ***************************************************************************/ + +#include "versioncontrolobserver.h" + +#include "dolphin_versioncontrolsettings.h" + +#include <kdirlister.h> +#include <klocale.h> +#include <kservice.h> +#include <kservicetypetrader.h> +#include <kversioncontrolplugin.h> + +#include "pendingthreadsmaintainer.h" +#include "updateitemstatesthread.h" + +#include <QAbstractProxyModel> +#include <QAbstractItemView> +#include <QMutexLocker> +#include <QTimer> + +#include <views/dolphinmodel.h> + +VersionControlObserver::VersionControlObserver(QAbstractItemView* view) : + QObject(view), + m_pendingItemStatesUpdate(false), + m_versionedDirectory(false), + m_silentUpdate(false), + m_view(view), + m_dirLister(0), + m_dolphinModel(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())); + } +} + +VersionControlObserver::~VersionControlObserver() +{ + 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_plugin != 0) { + m_plugin->disconnect(); + m_plugin = 0; + } +} + +QList<QAction*> VersionControlObserver::contextMenuActions(const KFileItemList& items) const +{ + QList<QAction*> actions; + if (isVersioned() && m_updateItemStatesThread->lockPlugin()) { + actions = m_plugin->contextMenuActions(items); + m_updateItemStatesThread->unlockPlugin(); + } + return actions; +} + +QList<QAction*> VersionControlObserver::contextMenuActions(const QString& directory) const +{ + QList<QAction*> actions; + if (isVersioned() && m_updateItemStatesThread->lockPlugin()) { + actions = m_plugin->contextMenuActions(directory); + m_updateItemStatesThread->unlockPlugin(); + } + + return actions; +} + +void VersionControlObserver::delayedDirectoryVerification() +{ + m_silentUpdate = false; + m_dirVerificationTimer->start(); +} + +void VersionControlObserver::silentDirectoryVerification() +{ + m_silentUpdate = true; + m_dirVerificationTimer->start(); +} + +void VersionControlObserver::verifyDirectory() +{ + const KUrl versionControlUrl = m_dirLister->url(); + if (!versionControlUrl.isLocalFile()) { + return; + } + + if (m_plugin != 0) { + m_plugin->disconnect(); + } + + m_plugin = searchPlugin(versionControlUrl); + if (m_plugin != 0) { + 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))); + + 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); + 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) { + 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); + 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; + } + + if (!m_updateItemStatesThread->retrievedItems()) { + // ignore m_silentUpdate for an error message + emit errorMessage(i18nc("@info:status", "Update of version 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. + // 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); + } + + 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; + updateItemStates(); + } +} + +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()) { + // 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); + if (!itemStates.isEmpty()) { + if (!m_silentUpdate) { + emit infoMessage(i18nc("@info:status", "Updating version information...")); + } + m_updateItemStatesThread->setData(m_plugin, itemStates); + m_updateItemStatesThread->start(); // slotThreadFinished() is called when finished + } +} + +void VersionControlObserver::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::Version, parentIndex); + addDirectory(index, itemStates); + + ItemState itemState; + itemState.index = index; + itemState.item = m_dolphinModel->itemForIndex(index); + itemState.version = KVersionControlPlugin::UnversionedVersion; + + itemStates.append(itemState); + } +} + +KVersionControlPlugin* VersionControlObserver::searchPlugin(const KUrl& directory) const +{ + 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()) { + // 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"); + for (KService::List::ConstIterator it = pluginServices.constBegin(); it != pluginServices.constEnd(); ++it) { + if (enabledPlugins.contains((*it)->name())) { + KVersionControlPlugin* plugin = (*it)->createInstance<KVersionControlPlugin>(); + Q_ASSERT(plugin != 0); + plugins.append(plugin); + } + } + if (plugins.isEmpty()) { + pluginsAvailable = false; + return 0; + } + } + + // 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()) { + 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) { + KUrl upUrl = dirUrl.upUrl(); + while (upUrl != dirUrl) { + const QString filePath = dirUrl.pathOrUrl(KUrl::AddTrailingSlash) + plugin->fileName(); + QFileInfo file(filePath); + if (file.exists()) { + return plugin; + } + dirUrl = upUrl; + upUrl = dirUrl.upUrl(); + } + } + } + + return 0; +} + +bool VersionControlObserver::isVersioned() const +{ + return m_dolphinModel->hasVersionData() && (m_plugin != 0); +} + +#include "versioncontrolobserver.moc" diff --git a/src/views/versioncontrol/versioncontrolobserver.h b/src/views/versioncontrol/versioncontrolobserver.h new file mode 100644 index 000000000..08bb234b3 --- /dev/null +++ b/src/views/versioncontrol/versioncontrolobserver.h @@ -0,0 +1,149 @@ +/*************************************************************************** + * Copyright (C) 2009 by Peter Penz <[email protected]> * + * * + * 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 * + ***************************************************************************/ + +#ifndef REVISIONCONTROLOBSERVER_H +#define REVISIONCONTROLOBSERVER_H + +#include <libdolphin_export.h> + +#include <kfileitem.h> +#include <kversioncontrolplugin.h> +#include <QList> +#include <QMutex> +#include <QObject> +#include <QPersistentModelIndex> +#include <QString> + +class DolphinModel; +class KDirLister; +class KFileItemList; +class QAbstractItemView; +class QAction; +class QTimer; +class UpdateItemStatesThread; + +/** + * @brief Observes all version control plugins. + * + * The item view gets updated automatically if the currently shown + * directory is under version control. + * + * @see VersionControlPlugin + */ +class LIBDOLPHINPRIVATE_EXPORT VersionControlObserver : public QObject +{ + Q_OBJECT + +public: + VersionControlObserver(QAbstractItemView* view); + virtual ~VersionControlObserver(); + + QList<QAction*> contextMenuActions(const KFileItemList& items) const; + QList<QAction*> contextMenuActions(const QString& directory) const; + +signals: + /** + * Is emitted if an information message with the content \a msg + * should be shown. + */ + void infoMessage(const QString& msg); + + /** + * Is emitted if an error message with the content \a msg + * should be shown. + */ + void errorMessage(const QString& msg); + + /** + * Is emitted if an "operation completed" message with the content \a msg + * should be shown. + */ + void operationCompletedMessage(const QString& msg); + +private slots: + /** + * Invokes verifyDirectory() with a small delay. If delayedDirectoryVerification() + * is invoked before the delay has been exceeded, the delay will be reset. This + * assures that a lot of short requests for directory verification only result + * in one (expensive) call. + */ + void delayedDirectoryVerification(); + + /** + * Invokes verifyDirectory() with a small delay. In opposite to + * delayedDirectoryVerification() it and assures that the verification of + * the directory is done silently without information messages. + */ + void silentDirectoryVerification(); + + void verifyDirectory(); + + /** + * Is invoked if the thread m_updateItemStatesThread has been finished + * and applys the item states. + */ + void slotThreadFinished(); + +private: + struct ItemState + { + QPersistentModelIndex index; + KFileItem item; + KVersionControlPlugin::VersionState version; + }; + + void updateItemStates(); + + /** + * Adds recursively all items from the directory \p parentIndex into + * the list \p itemStates. + */ + void addDirectory(const QModelIndex& parentIndex, QList<ItemState>& itemStates); + + /** + * Returns a matching plugin for the given directory. + * 0 is returned, if no matching plugin has been found. + */ + KVersionControlPlugin* searchPlugin(const KUrl& directory) const; + + /** + * Returns true, if the directory contains a version control information. + */ + bool isVersioned() const; + +private: + bool m_pendingItemStatesUpdate; + bool m_versionedDirectory; + bool m_silentUpdate; // if true, no messages will be send during the update + // of version states + + QAbstractItemView* m_view; + KDirLister* m_dirLister; + DolphinModel* m_dolphinModel; + + QTimer* m_dirVerificationTimer; + + KVersionControlPlugin* m_plugin; + UpdateItemStatesThread* m_updateItemStatesThread; + + friend class UpdateItemStatesThread; +}; + +#endif // REVISIONCONTROLOBSERVER_H + |
