]> cloud.milkyroute.net Git - dolphin.git/blobdiff - src/panels/places/placesitem.cpp
Places: Use Solid::Device::DisplayName for DisplayRole
[dolphin.git] / src / panels / places / placesitem.cpp
index 19b1d9e9a573021c38891b60a4c9d5e3e8d21612..16ee5cff4c2dd3d4833f07b0d03ea25925cb8f7a 100644 (file)
@@ -1,5 +1,6 @@
 /***************************************************************************
  *   Copyright (C) 2012 by Peter Penz <peter.penz19@gmail.com>             *
+ *   Copyright (C) 2018 by Elvis Angelaccio <elvis.angelaccio@kde.org>     *
  *                                                                         *
  *   Based on KFilePlacesItem from kdelibs:                                *
  *   Copyright (C) 2007 Kevin Ottens <ervin@kde.org>                       *
  ***************************************************************************/
 
 #include "placesitem.h"
+#include "trash/dolphintrash.h"
 
-#include <KBookmarkManager>
-#include <KDebug>
-#include <KIcon>
-#include <KLocale>
-#include "placesitemstorageaccesslistener.h"
-#include <QDateTime>
+#include "dolphindebug.h"
+#include "placesitemsignalhandler.h"
+
+#include <KDirLister>
+#include <KLocalizedString>
 #include <Solid/Block>
 
 PlacesItem::PlacesItem(const KBookmark& bookmark, PlacesItem* parent) :
@@ -36,39 +37,38 @@ PlacesItem::PlacesItem(const KBookmark& bookmark, PlacesItem* parent) :
     m_access(),
     m_volume(),
     m_disc(),
-    m_accessListener(0),
+    m_mtp(),
+    m_signalHandler(nullptr),
     m_bookmark()
 {
+    m_signalHandler = new PlacesItemSignalHandler(this);
     setBookmark(bookmark);
 }
 
-PlacesItem::PlacesItem(const PlacesItem& item) :
-    KStandardItem(item),
-    m_device(item.m_device),
-    m_access(item.m_access),
-    m_volume(item.m_volume),
-    m_disc(item.m_disc),
-    m_accessListener(0),
-    m_bookmark(item.m_bookmark)
-{
-    if (item.m_accessListener) {
-        m_accessListener = new PlacesItemStorageAccessListener(this);
-    }
-}
-
 PlacesItem::~PlacesItem()
 {
-    delete m_accessListener;
+    delete m_signalHandler;
 }
 
-void PlacesItem::setUrl(const KUrl& url)
+void PlacesItem::setUrl(const QUrl &url)
 {
-    setDataValue("url", 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) {
+        if (url.scheme() == QLatin1String("trash")) {
+            QObject::connect(&Trash::instance(), &Trash::emptinessChanged, m_signalHandler.data(), &PlacesItemSignalHandler::onTrashEmptinessChanged);
+        }
+
+        setDataValue("url", url);
+    }
 }
 
-KUrl PlacesItem::url() const
+QUrl PlacesItem::url() const
 {
-    return dataValue("url").value<KUrl>();
+    return dataValue("url").toUrl();
 }
 
 void PlacesItem::setUdi(const QString& udi)
@@ -81,12 +81,19 @@ QString PlacesItem::udi() const
     return dataValue("udi").toString();
 }
 
+void PlacesItem::setApplicationName(const QString &applicationName)
+{
+    setDataValue("applicationName", applicationName);
+}
+
+QString PlacesItem::applicationName() const
+{
+    return dataValue("applicationName").toString();
+}
+
 void PlacesItem::setHidden(bool hidden)
 {
     setDataValue("isHidden", hidden);
-    if (!m_bookmark.isNull()) {
-        m_bookmark.setMetaDataItem("IsHidden", hidden ? "true" : "false");
-    }
 }
 
 bool PlacesItem::isHidden() const
@@ -94,6 +101,16 @@ bool PlacesItem::isHidden() const
     return dataValue("isHidden").toBool();
 }
 
+bool PlacesItem::isGroupHidden() const
+{
+    return dataValue("isGroupHidden").toBool();
+}
+
+void PlacesItem::setGroupHidden(bool hidden)
+{
+    setDataValue("isGroupHidden", hidden);
+}
+
 void PlacesItem::setSystemItem(bool isSystemItem)
 {
     setDataValue("isSystemItem", isSystemItem);
@@ -111,24 +128,31 @@ Solid::Device PlacesItem::device() const
 
 void PlacesItem::setBookmark(const KBookmark& bookmark)
 {
+    const bool bookmarkDataChanged = !(bookmark == m_bookmark);
+
+    // bookmark object must be updated to keep in sync with source model
     m_bookmark = bookmark;
 
+    if (!bookmarkDataChanged) {
+        return;
+    }
+
     delete m_access;
     delete m_volume;
     delete m_disc;
-    delete m_accessListener;
+    delete m_mtp;
 
-    const QString udi = bookmark.metaDataItem("UDI");
+    const QString udi = bookmark.metaDataItem(QStringLiteral("UDI"));
     if (udi.isEmpty()) {
         setIcon(bookmark.icon());
-        setText(bookmark.text());
+        setText(i18ndc("kio5", "KFile System Bookmarks", bookmark.text().toUtf8().constData()));
         setUrl(bookmark.url());
-        setDataValue("address", bookmark.address());
-        setGroup(i18nc("@item", "Places"));
+        setSystemItem(bookmark.metaDataItem(QStringLiteral("isSystemItem")) == QLatin1String("true"));
     } else {
         initializeDevice(udi);
     }
-    setHidden(bookmark.metaDataItem("IsHidden") == QLatin1String("true"));
+
+    setHidden(bookmark.metaDataItem(QStringLiteral("IsHidden")) == QLatin1String("true"));
 }
 
 KBookmark PlacesItem::bookmark() const
@@ -136,47 +160,23 @@ KBookmark PlacesItem::bookmark() const
     return m_bookmark;
 }
 
-KBookmark PlacesItem::createBookmark(KBookmarkManager* manager,
-                                     const QString& text,
-                                     const KUrl& url,
-                                     const QString& iconName,
-                                     PlacesItem* after)
+bool PlacesItem::storageSetupNeeded() const
 {
-    KBookmarkGroup root = manager->root();
-    if (root.isNull()) {
-        return KBookmark();
-    }
-
-    KBookmark bookmark = root.addBookmark(text, url, iconName);
-    bookmark.setMetaDataItem("ID", generateNewId());
-
-    if (after) {
-        root.moveBookmark(bookmark, after->bookmark());
-    }
-
-    return bookmark;
+    return m_access ? !m_access->isAccessible() : false;
 }
 
-KBookmark PlacesItem::createDeviceBookmark(KBookmarkManager* manager,
-                                           const QString& udi)
+bool PlacesItem::isSearchOrTimelineUrl() const
 {
-    KBookmarkGroup root = manager->root();
-    if (root.isNull()) {
-        return KBookmark();
-    }
-
-    KBookmark bookmark = root.createNewSeparator();
-    bookmark.setMetaDataItem("UDI", udi);
-    bookmark.setMetaDataItem("isSystemItem", "true");
-    return bookmark;
+    const QString urlScheme = url().scheme();
+    return (urlScheme.contains("search") || urlScheme.contains("timeline"));
 }
 
 void PlacesItem::onDataValueChanged(const QByteArray& role,
                                     const QVariant& current,
                                     const QVariant& previous)
 {
-    Q_UNUSED(current);
-    Q_UNUSED(previous);
+    Q_UNUSED(current)
+    Q_UNUSED(previous)
 
     if (!m_bookmark.isNull()) {
         updateBookmarkForRole(role);
@@ -186,7 +186,7 @@ void PlacesItem::onDataValueChanged(const QByteArray& role,
 void PlacesItem::onDataChanged(const QHash<QByteArray, QVariant>& current,
                                const QHash<QByteArray, QVariant>& previous)
 {
-    Q_UNUSED(previous);
+    Q_UNUSED(previous)
 
     if (!m_bookmark.isNull()) {
         QHashIterator<QByteArray, QVariant> it(current);
@@ -207,29 +207,36 @@ 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_mtp = m_device.as<Solid::PortableMediaPlayer>();
 
-    setText(m_device.description());
+    setText(m_device.displayName());
     setIcon(m_device.icon());
     setIconOverlays(m_device.emblems());
     setUdi(udi);
-    setGroup(i18nc("@item", "Devices"));
 
     if (m_access) {
-        setUrl(m_access->filePath());
-        if (!m_accessListener) {
-            // The access listener takes care to call PlacesItem::onAccessibilityChanged()
-            // in case if the accessibility of m_access has been changed.
-            m_accessListener = new PlacesItemStorageAccessListener(this);
-        }
+        setUrl(QUrl::fromLocalFile(m_access->filePath()));
+        QObject::connect(m_access.data(), &Solid::StorageAccess::accessibilityChanged,
+                         m_signalHandler.data(), &PlacesItemSignalHandler::onAccessibilityChanged);
+        QObject::connect(m_access.data(), &Solid::StorageAccess::teardownRequested,
+                         m_signalHandler.data(), &PlacesItemSignalHandler::onTearDownRequested);
     } 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(QUrl(QStringLiteral("audiocd:/?device=%1").arg(device)));
+        } else {
+            setUrl(QUrl(QStringLiteral("audiocd:/")));
+        }
+    } else if (m_mtp) {
+        setUrl(QUrl(QStringLiteral("mtp:udi=%1").arg(m_device.udi())));
     }
 }
 
 void PlacesItem::onAccessibilityChanged()
 {
     setIconOverlays(m_device.emblems());
+    setUrl(QUrl::fromLocalFile(m_access->filePath()));
 }
 
 void PlacesItem::updateBookmarkForRole(const QByteArray& role)
@@ -238,20 +245,40 @@ void PlacesItem::updateBookmarkForRole(const QByteArray& role)
     if (role == "iconName") {
         m_bookmark.setIcon(icon());
     } else if (role == "text") {
-        m_bookmark.setDescription(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() != i18ndc("kio5", "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("UDI", udi());
+    } else if (role == "udi") {
+        m_bookmark.setMetaDataItem(QStringLiteral("UDI"), udi());
+    } else if (role == "applicationName") {
+        m_bookmark.setMetaDataItem(QStringLiteral("OnlyInApp"), applicationName());
     } else if (role == "isSystemItem") {
-        m_bookmark.setMetaDataItem("isSystemItem", isSystemItem() ? "true" : "false");
+        m_bookmark.setMetaDataItem(QStringLiteral("isSystemItem"), isSystemItem() ? QStringLiteral("true") : QStringLiteral("false"));
     } else if (role == "isHidden") {
-        m_bookmark.setMetaDataItem("IsHidden", isHidden() ? "true" : "false");
+        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::currentDateTime().toTime_t()) + '/' + QString::number(count++);
+    return QString::number(QDateTime::currentDateTimeUtc().toTime_t()) +
+            '/' + QString::number(count++) + " (V2)";
+}
+
+PlacesItemSignalHandler *PlacesItem::signalHandler() const
+{
+    return m_signalHandler.data();
 }