Load KFileItemAction plugins with json metadata

[dolphin.git] / src / panels / places / placesitem.cpp

diff --git a/src/panels/places/placesitem.cpp b/src/panels/places/placesitem.cpp
index 33af8a820f27381bf4ed0ea3c53b10870cc9887a..a04064d0b3762622d815fadc4fb4a495e302c793 100644 (file)
--- a/src/panels/places/placesitem.cpp
+++ b/src/panels/places/placesitem.cpp
@@ -22,68 +22,74 @@
 
 #include "placesitem.h"
 
 
 #include "placesitem.h"
 

-#include <KBookmark>
-#include <KIcon>
-#include <KLocale>
+#include <KBookmarkManager>
+#include "dolphindebug.h"
+#include <KDirLister>
+#include <KLocalizedString>
+#include "placesitemsignalhandler.h"
+#include <QDateTime>

 #include <Solid/Block>
 
 #include <Solid/Block>
 

-PlacesItem::PlacesItem(PlacesItem* parent) :
-    KStandardItem(parent)
-{
-}
-

 PlacesItem::PlacesItem(const KBookmark& bookmark, PlacesItem* parent) :
     KStandardItem(parent),
     m_device(),
     m_access(),
     m_volume(),
 PlacesItem::PlacesItem(const KBookmark& bookmark, PlacesItem* parent) :
     KStandardItem(parent),
     m_device(),
     m_access(),
     m_volume(),

-    m_disc()
+    m_disc(),
+    m_mtp(),
+    m_signalHandler(0),
+    m_trashDirLister(0),
+    m_bookmark()

 {
 {

-    setHidden(bookmark.metaDataItem("IsHidden") == QLatin1String("true"));
-
-    const QString udi = bookmark.metaDataItem("UDI");
-    if (udi.isEmpty()) {
-        setIcon(bookmark.icon());
-        setText(bookmark.text());
-        setUrl(bookmark.url());
-        setDataValue("address", bookmark.address());
-        setGroup(i18nc("@item", "Places"));
-    } else {
-        initializeDevice(udi);
-    }
+    m_signalHandler = new PlacesItemSignalHandler(this);
+    setBookmark(bookmark);

 }
 
 }
 

-PlacesItem::PlacesItem(const QString& udi, PlacesItem* parent) :
-    KStandardItem(parent),
-    m_device(),
-    m_access(),
-    m_volume(),
-    m_disc()
+PlacesItem::~PlacesItem()

 {
 {

-    initializeDevice(udi);
+    delete m_signalHandler;
+    delete m_trashDirLister;

 }
 
 }
 

-PlacesItem::PlacesItem(const PlacesItem& item) :
-    KStandardItem(item),
-    m_device(),
-    m_access(),
-    m_volume(),
-    m_disc()
+void PlacesItem::setUrl(const QUrl &url)

 {
 {

+    // The default check in KStandardItem::setDataValue()
+    // for equal values does not work with a custom value
+    // like QUrl. Hence do a manual check to prevent that
+    // setting an equal URL results in an itemsChanged()
+    // signal.
+    if (dataValue("url").toUrl() != url) {
+        delete m_trashDirLister;
+        if (url.scheme() == QLatin1String("trash")) {
+            // The trash icon must always be updated dependent on whether
+            // the trash is empty or not. We use a KDirLister that automatically
+            // watches for changes if the number of items has been changed.
+            // The update of the icon is handled in onTrashDirListerCompleted().
+            m_trashDirLister = new KDirLister();
+            m_trashDirLister->setAutoErrorHandlingEnabled(false, 0);
+            m_trashDirLister->setDelayedMimeTypes(true);
+            QObject::connect(m_trashDirLister.data(), static_cast<void(KDirLister::*)()>(&KDirLister::completed),
+                             m_signalHandler.data(), &PlacesItemSignalHandler::onTrashDirListerCompleted);
+            m_trashDirLister->openUrl(url);
+        }
+
+        setDataValue("url", url);
+    }

 }
 
 }
 

-PlacesItem::~PlacesItem()
+QUrl PlacesItem::url() const

 {
 {

+    return dataValue("url").toUrl();

 }
 
 }
 

-void PlacesItem::setUrl(const KUrl& url)
+void PlacesItem::setUdi(const QString& udi)

 {
 {

-    setDataValue("url", url);
+    setDataValue("udi", udi);

 }
 
 }
 

-KUrl PlacesItem::url() const
+QString PlacesItem::udi() const

 {
 {

-    return dataValue("url").value<KUrl>();
+    return dataValue("udi").toString();

 }
 
 void PlacesItem::setHidden(bool hidden)
 }
 
 void PlacesItem::setHidden(bool hidden)


@@ -96,11 +102,155 @@ bool PlacesItem::isHidden() const
     return dataValue("isHidden").toBool();
 }
 
     return dataValue("isHidden").toBool();
 }
 

+void PlacesItem::setSystemItem(bool isSystemItem)
+{
+    setDataValue("isSystemItem", isSystemItem);
+}
+
+bool PlacesItem::isSystemItem() const
+{
+    return dataValue("isSystemItem").toBool();
+}
+

 Solid::Device PlacesItem::device() const
 {
     return m_device;
 }
 
 Solid::Device PlacesItem::device() const
 {
     return m_device;
 }
 

+void PlacesItem::setBookmark(const KBookmark& bookmark)
+{
+    if (bookmark == m_bookmark) {
+        return;
+    }
+
+    m_bookmark = bookmark;
+
+    delete m_access;
+    delete m_volume;
+    delete m_disc;
+    delete m_mtp;
+
+
+    const QString udi = bookmark.metaDataItem(QStringLiteral("UDI"));
+    if (udi.isEmpty()) {
+        setIcon(bookmark.icon());
+        setText(i18nc("KFile System Bookmarks", bookmark.text().toUtf8().constData()));
+        setUrl(bookmark.url());
+    } else {
+        initializeDevice(udi);
+    }
+
+    const GroupType type = groupType();
+    if (icon().isEmpty()) {
+        switch (type) {
+        case RecentlySavedType: setIcon(QStringLiteral("chronometer")); break;
+        case SearchForType:     setIcon(QStringLiteral("system-search")); break;
+        case PlacesType:
+        default:                setIcon(QStringLiteral("folder"));
+        }
+
+    }
+
+    switch (type) {
+    case PlacesType:        setGroup(i18nc("@item", "Places")); break;
+    case RecentlySavedType: setGroup(i18nc("@item", "Recently Saved")); break;
+    case SearchForType:     setGroup(i18nc("@item", "Search For")); break;
+    case DevicesType:       setGroup(i18nc("@item", "Devices")); break;
+    default:                Q_ASSERT(false); break;
+    }
+
+    setHidden(bookmark.metaDataItem(QStringLiteral("IsHidden")) == QLatin1String("true"));
+}
+
+KBookmark PlacesItem::bookmark() const
+{
+    return m_bookmark;
+}
+
+PlacesItem::GroupType PlacesItem::groupType() const
+{
+    if (udi().isEmpty()) {
+        const QString protocol = url().scheme();
+        if (protocol == QLatin1String("timeline")) {
+            return RecentlySavedType;
+        }
+
+        if (protocol.contains(QLatin1String("search"))) {
+            return SearchForType;
+        }
+
+        if (protocol == QLatin1String("bluetooth") || protocol == QLatin1String("obexftp") || protocol == QLatin1String("kdeconnect")) {
+            return DevicesType;
+        }
+
+        return PlacesType;
+    }
+
+    return DevicesType;
+}
+
+bool PlacesItem::storageSetupNeeded() const
+{
+    return m_access ? !m_access->isAccessible() : false;
+}
+
+KBookmark PlacesItem::createBookmark(KBookmarkManager* manager,
+                                     const QString& text,
+                                     const QUrl& url,
+                                     const QString& iconName)
+{
+    KBookmarkGroup root = manager->root();
+    if (root.isNull()) {
+        return KBookmark();
+    }
+
+    KBookmark bookmark = root.addBookmark(text, url, iconName);
+    bookmark.setFullText(text);
+    bookmark.setMetaDataItem(QStringLiteral("ID"), generateNewId());
+
+    return bookmark;
+}
+
+KBookmark PlacesItem::createDeviceBookmark(KBookmarkManager* manager,
+                                           const QString& udi)
+{
+    KBookmarkGroup root = manager->root();
+    if (root.isNull()) {
+        return KBookmark();
+    }
+
+    KBookmark bookmark = root.createNewSeparator();
+    bookmark.setMetaDataItem(QStringLiteral("UDI"), udi);
+    bookmark.setMetaDataItem(QStringLiteral("isSystemItem"), QStringLiteral("true"));
+    return bookmark;
+}
+
+void PlacesItem::onDataValueChanged(const QByteArray& role,
+                                    const QVariant& current,
+                                    const QVariant& previous)
+{
+    Q_UNUSED(current);
+    Q_UNUSED(previous);
+
+    if (!m_bookmark.isNull()) {
+        updateBookmarkForRole(role);
+    }
+}
+
+void PlacesItem::onDataChanged(const QHash<QByteArray, QVariant>& current,
+                               const QHash<QByteArray, QVariant>& previous)
+{
+    Q_UNUSED(previous);
+
+    if (!m_bookmark.isNull()) {
+        QHashIterator<QByteArray, QVariant> it(current);
+        while (it.hasNext()) {
+            it.next();
+            updateBookmarkForRole(it.key());
+        }
+    }
+}
+

 void PlacesItem::initializeDevice(const QString& udi)
 {
     m_device = Solid::Device(udi);
 void PlacesItem::initializeDevice(const QString& udi)
 {
     m_device = Solid::Device(udi);


@@ -111,18 +261,77 @@ void PlacesItem::initializeDevice(const QString& udi)
     m_access = m_device.as<Solid::StorageAccess>();
     m_volume = m_device.as<Solid::StorageVolume>();
     m_disc = m_device.as<Solid::OpticalDisc>();
     m_access = m_device.as<Solid::StorageAccess>();
     m_volume = m_device.as<Solid::StorageVolume>();
     m_disc = m_device.as<Solid::OpticalDisc>();

+    m_mtp = m_device.as<Solid::PortableMediaPlayer>();

 
     setText(m_device.description());
     setIcon(m_device.icon());
     setIconOverlays(m_device.emblems());
 
     setText(m_device.description());
     setIcon(m_device.icon());
     setIconOverlays(m_device.emblems());

-    setDataValue("udi", udi);
-    setGroup(i18nc("@item", "Devices"));
+    setUdi(udi);

 
     if (m_access) {
 
     if (m_access) {

-        setUrl(m_access->filePath());
+        setUrl(QUrl::fromLocalFile(m_access->filePath()));
+        QObject::connect(m_access.data(), &Solid::StorageAccess::accessibilityChanged,
+                         m_signalHandler.data(), &PlacesItemSignalHandler::onAccessibilityChanged);

     } else if (m_disc && (m_disc->availableContent() & Solid::OpticalDisc::Audio) != 0) {
     } else if (m_disc && (m_disc->availableContent() & Solid::OpticalDisc::Audio) != 0) {

-        const QString device = m_device.as<Solid::Block>()->device();
-        setUrl(QString("audiocd:/?device=%1").arg(device));
+        Solid::Block *block = m_device.as<Solid::Block>();
+        if (block) {
+            const QString device = block->device();
+            setUrl(QStringLiteral("audiocd:/?device=%1").arg(device));
+        } else {
+            setUrl(QStringLiteral("audiocd:/"));
+        }
+    } else if (m_mtp) {
+        setUrl(QStringLiteral("mtp:udi=%1").arg(m_device.udi()));
+    }
+}
+
+void PlacesItem::onAccessibilityChanged()
+{
+    setIconOverlays(m_device.emblems());
+    setUrl(QUrl::fromLocalFile(m_access->filePath()));
+}
+
+void PlacesItem::onTrashDirListerCompleted()
+{
+    Q_ASSERT(url().scheme() == QLatin1String("trash"));
+
+    const bool isTrashEmpty = m_trashDirLister->items().isEmpty();
+    setIcon(isTrashEmpty ? QStringLiteral("user-trash") : QStringLiteral("user-trash-full"));
+}
+
+void PlacesItem::updateBookmarkForRole(const QByteArray& role)
+{
+    Q_ASSERT(!m_bookmark.isNull());
+    if (role == "iconName") {
+        m_bookmark.setIcon(icon());
+    } else if (role == "text") {
+        // Only store the text in the KBookmark if it is not the translation of
+        // the current text. This makes sure that the text is re-translated if
+        // the user chooses another language, or the translation itself changes.
+        //
+        // NOTE: It is important to use "KFile System Bookmarks" as context
+        // (see PlacesItemModel::createSystemBookmarks()).
+        if (text() != i18nc("KFile System Bookmarks", m_bookmark.text().toUtf8().data())) {
+            m_bookmark.setFullText(text());
+        }
+    } else if (role == "url") {
+        m_bookmark.setUrl(url());
+    } else if (role == "udi)") {
+        m_bookmark.setMetaDataItem(QStringLiteral("UDI"), udi());
+    } else if (role == "isSystemItem") {
+        m_bookmark.setMetaDataItem(QStringLiteral("isSystemItem"), isSystemItem() ? QStringLiteral("true") : QStringLiteral("false"));
+    } else if (role == "isHidden") {
+        m_bookmark.setMetaDataItem(QStringLiteral("IsHidden"), isHidden() ? QStringLiteral("true") : QStringLiteral("false"));

     }
 }
 
     }
 }
 

+QString PlacesItem::generateNewId()
+{
+    // The ID-generation must be different as done in KFilePlacesItem from kdelibs
+    // to prevent identical IDs, because 'count' is of course not shared. We append a
+    // " (V2)" to indicate that the ID has been generated by
+    // a new version of the places view.
+    static int count = 0;
+    return QString::number(QDateTime::currentDateTimeUtc().toTime_t()) +
+            '/' + QString::number(count++) + " (V2)";
+}