Generalize Player protocol support

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

diff --git a/src/panels/places/placesitem.cpp b/src/panels/places/placesitem.cpp
index 41f22cce43d30aee00c3108d75a8170d4e6d7e4a..ea22700202d661e22f169204693e203f642ccaa8 100644 (file)
--- a/src/panels/places/placesitem.cpp
+++ b/src/panels/places/placesitem.cpp
@@ -1,5 +1,6 @@
 /***************************************************************************
  *   Copyright (C) 2012 by Peter Penz <peter.penz19@gmail.com>             *
 /***************************************************************************
  *   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>                       *
  *                                                                         *
  *   Based on KFilePlacesItem from kdelibs:                                *
  *   Copyright (C) 2007 Kevin Ottens <ervin@kde.org>                       *


@@ -21,14 +22,13 @@
  ***************************************************************************/
 
 #include "placesitem.h"
  ***************************************************************************/
 
 #include "placesitem.h"

+#include "trash/dolphintrash.h"

 
 

-#include <KBookmarkManager>
-#include <KDebug>
-#include <KDirLister>
-#include <KIcon>
-#include <KLocale>
+#include "dolphindebug.h"

 #include "placesitemsignalhandler.h"
 #include "placesitemsignalhandler.h"

-#include <QDateTime>
+
+#include <KDirLister>
+#include <KLocalizedString>

 #include <Solid/Block>
 
 PlacesItem::PlacesItem(const KBookmark& bookmark, PlacesItem* parent) :
 #include <Solid/Block>
 
 PlacesItem::PlacesItem(const KBookmark& bookmark, PlacesItem* parent) :


@@ -37,9 +37,8 @@ PlacesItem::PlacesItem(const KBookmark& bookmark, PlacesItem* parent) :
     m_access(),
     m_volume(),
     m_disc(),
     m_access(),
     m_volume(),
     m_disc(),

-    m_mtp(),
-    m_signalHandler(0),
-    m_trashDirLister(0),
+    m_player(),
+    m_signalHandler(nullptr),

     m_bookmark()
 {
     m_signalHandler = new PlacesItemSignalHandler(this);
     m_bookmark()
 {
     m_signalHandler = new PlacesItemSignalHandler(this);


@@ -49,38 +48,27 @@ PlacesItem::PlacesItem(const KBookmark& bookmark, PlacesItem* parent) :
 PlacesItem::~PlacesItem()
 {
     delete m_signalHandler;
 PlacesItem::~PlacesItem()
 {
     delete m_signalHandler;

-    delete m_trashDirLister;

 }
 
 }
 

-void PlacesItem::setUrl(const KUrl& url)
+void PlacesItem::setUrl(const QUrl &url)

 {
     // The default check in KStandardItem::setDataValue()
     // for equal values does not work with a custom value
 {
     // The default check in KStandardItem::setDataValue()
     // for equal values does not work with a custom value

-    // like KUrl. Hence do a manual check to prevent that
+    // like QUrl. Hence do a manual check to prevent that

     // setting an equal URL results in an itemsChanged()
     // signal.
     // setting an equal URL results in an itemsChanged()
     // signal.

-    if (dataValue("url").value<KUrl>() != url) {
-        delete m_trashDirLister;
-        if (url.protocol() == 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, SIGNAL(completed()),
-                             m_signalHandler, SLOT(onTrashDirListerCompleted()));
-            m_trashDirLister->openUrl(url);
+    if (dataValue("url").toUrl() != url) {
+        if (url.scheme() == QLatin1String("trash")) {
+            QObject::connect(&Trash::instance(), &Trash::emptinessChanged, m_signalHandler.data(), &PlacesItemSignalHandler::onTrashEmptinessChanged);

         }
 
         setDataValue("url", url);
     }
 }
 
         }
 
         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)
 }
 
 void PlacesItem::setUdi(const QString& udi)


@@ -93,6 +81,16 @@ QString PlacesItem::udi() const
     return dataValue("udi").toString();
 }
 
     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);
 void PlacesItem::setHidden(bool hidden)
 {
     setDataValue("isHidden", hidden);


@@ -103,6 +101,16 @@ bool PlacesItem::isHidden() const
     return dataValue("isHidden").toBool();
 }
 
     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);
 void PlacesItem::setSystemItem(bool isSystemItem)
 {
     setDataValue("isSystemItem", isSystemItem);


@@ -120,47 +128,31 @@ Solid::Device PlacesItem::device() const
 
 void PlacesItem::setBookmark(const KBookmark& bookmark)
 {
 
 void PlacesItem::setBookmark(const KBookmark& bookmark)
 {

-    if (bookmark == m_bookmark) {
-        return;
-    }
+    const bool bookmarkDataChanged = !(bookmark == m_bookmark);

 
 

+    // bookmark object must be updated to keep in sync with source model

     m_bookmark = bookmark;
 
     m_bookmark = bookmark;
 

+    if (!bookmarkDataChanged) {
+        return;
+    }
+

     delete m_access;
     delete m_volume;
     delete m_disc;
     delete m_access;
     delete m_volume;
     delete m_disc;

-    delete m_mtp;
-
+    delete m_player;

 
 

-    const QString udi = bookmark.metaDataItem("UDI");
+    const QString udi = bookmark.metaDataItem(QStringLiteral("UDI"));

     if (udi.isEmpty()) {
         setIcon(bookmark.icon());
     if (udi.isEmpty()) {
         setIcon(bookmark.icon());

-        setText(bookmark.text());
+        setText(i18ndc("kio5", "KFile System Bookmarks", bookmark.text().toUtf8().constData()));

         setUrl(bookmark.url());
         setUrl(bookmark.url());

+        setSystemItem(bookmark.metaDataItem(QStringLiteral("isSystemItem")) == QLatin1String("true"));

     } else {
         initializeDevice(udi);
     }
 
     } else {
         initializeDevice(udi);
     }
 

-    const GroupType type = groupType();
-    if (icon().isEmpty()) {
-        switch (type) {
-        case RecentlyAccessedType: setIcon("chronometer"); break;
-        case SearchForType:        setIcon("nepomuk"); break;
-        case PlacesType:
-        default:                   setIcon("folder");
-        }
-
-    }
-
-    switch (type) {
-    case PlacesType:           setGroup(i18nc("@item", "Places")); break;
-    case RecentlyAccessedType: setGroup(i18nc("@item", "Recently Accessed")); break;
-    case SearchForType:        setGroup(i18nc("@item", "Search For")); break;
-    case DevicesType:          setGroup(i18nc("@item", "Devices")); break;
-    default:                   Q_ASSERT(false); break;
-    }
-
-    setHidden(bookmark.metaDataItem("IsHidden") == QLatin1String("true"));
+    setHidden(bookmark.metaDataItem(QStringLiteral("IsHidden")) == QLatin1String("true"));

 }
 
 KBookmark PlacesItem::bookmark() const
 }
 
 KBookmark PlacesItem::bookmark() const


@@ -168,70 +160,23 @@ KBookmark PlacesItem::bookmark() const
     return m_bookmark;
 }
 
     return m_bookmark;
 }
 

-PlacesItem::GroupType PlacesItem::groupType() const
-{
-    if (udi().isEmpty()) {
-        const QString protocol = url().protocol();
-        if (protocol == QLatin1String("timeline")) {
-            return RecentlyAccessedType;
-        }
-
-        if (protocol.contains(QLatin1String("search"))) {
-            return SearchForType;
-        }
-
-        if (protocol == QLatin1String("bluetooth")) {
-            return DevicesType;
-        }
-
-        return PlacesType;
-    }
-
-    return DevicesType;
-}
-

 bool PlacesItem::storageSetupNeeded() const
 {
     return m_access ? !m_access->isAccessible() : false;
 }
 
 bool PlacesItem::storageSetupNeeded() const
 {
     return m_access ? !m_access->isAccessible() : false;
 }
 

-KBookmark PlacesItem::createBookmark(KBookmarkManager* manager,
-                                     const QString& text,
-                                     const KUrl& url,
-                                     const QString& iconName)
+bool PlacesItem::isSearchOrTimelineUrl() const

 {
 {

-    KBookmarkGroup root = manager->root();
-    if (root.isNull()) {
-        return KBookmark();
-    }
-
-    KBookmark bookmark = root.addBookmark(text, url, iconName);
-    bookmark.setFullText(text);
-    bookmark.setMetaDataItem("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("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)
 {
 }
 
 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);
 
     if (!m_bookmark.isNull()) {
         updateBookmarkForRole(role);


@@ -241,7 +186,7 @@ void PlacesItem::onDataValueChanged(const QByteArray& role,
 void PlacesItem::onDataChanged(const QHash<QByteArray, QVariant>& current,
                                const QHash<QByteArray, QVariant>& previous)
 {
 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);
 
     if (!m_bookmark.isNull()) {
         QHashIterator<QByteArray, QVariant> it(current);


@@ -262,7 +207,7 @@ 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>();
+    m_player = m_device.as<Solid::PortableMediaPlayer>();

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


@@ -270,34 +215,31 @@ void PlacesItem::initializeDevice(const QString& udi)
     setUdi(udi);
 
     if (m_access) {
     setUdi(udi);
 
     if (m_access) {

-        setUrl(m_access->filePath());
-        QObject::connect(m_access, SIGNAL(accessibilityChanged(bool,QString)),
-                         m_signalHandler, SLOT(onAccessibilityChanged()));
+        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) {
         Solid::Block *block = m_device.as<Solid::Block>();
         if (block) {
             const QString device = block->device();
     } else if (m_disc && (m_disc->availableContent() & Solid::OpticalDisc::Audio) != 0) {
         Solid::Block *block = m_device.as<Solid::Block>();
         if (block) {
             const QString device = block->device();

-            setUrl(QString("audiocd:/?device=%1").arg(device));
+            setUrl(QUrl(QStringLiteral("audiocd:/?device=%1").arg(device)));

         } else {
         } else {

-            setUrl(QString("audiocd:/"));
+            setUrl(QUrl(QStringLiteral("audiocd:/")));
+        }
+    } else if (m_player) {
+        const QStringList protocols = m_player->supportedProtocols();
+        if (!protocols.isEmpty()) {
+            setUrl(QUrl(QStringLiteral("%1:udi=%2").arg(protocols.first(), m_device.udi())));

         }
         }

-    } else if (m_mtp) {
-        setUrl(QString("mtp:udi=%1").arg(m_device.udi()));

     }
 }
 
 void PlacesItem::onAccessibilityChanged()
 {
     setIconOverlays(m_device.emblems());
     }
 }
 
 void PlacesItem::onAccessibilityChanged()
 {
     setIconOverlays(m_device.emblems());

-    setUrl(m_access->filePath());
-}
-
-void PlacesItem::onTrashDirListerCompleted()
-{
-    Q_ASSERT(url().protocol() == QLatin1String("trash"));
-
-    const bool isTrashEmpty = m_trashDirLister->items().isEmpty();
-    setIcon(isTrashEmpty ? "user-trash" : "user-trash-full");
+    setUrl(QUrl::fromLocalFile(m_access->filePath()));

 }
 
 void PlacesItem::updateBookmarkForRole(const QByteArray& role)
 }
 
 void PlacesItem::updateBookmarkForRole(const QByteArray& role)


@@ -312,17 +254,19 @@ void PlacesItem::updateBookmarkForRole(const QByteArray& role)
         //
         // NOTE: It is important to use "KFile System Bookmarks" as context
         // (see PlacesItemModel::createSystemBookmarks()).
         //
         // 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())) {
+        if (text() != i18ndc("kio5", "KFile System Bookmarks", m_bookmark.text().toUtf8().data())) {

             m_bookmark.setFullText(text());
         }
     } else if (role == "url") {
         m_bookmark.setUrl(url());
             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") {
     } 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") {
     } else if (role == "isHidden") {

-        m_bookmark.setMetaDataItem("IsHidden", isHidden() ? "true" : "false");
+        m_bookmark.setMetaDataItem(QStringLiteral("IsHidden"), isHidden() ? QStringLiteral("true") : QStringLiteral("false"));

     }
 }
 
     }
 }
 


@@ -333,6 +277,11 @@ QString PlacesItem::generateNewId()
     // " (V2)" to indicate that the ID has been generated by
     // a new version of the places view.
     static int count = 0;
     // " (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()) +
+    return QString::number(QDateTime::currentDateTimeUtc().toTime_t()) +

             '/' + QString::number(count++) + " (V2)";
 }
             '/' + QString::number(count++) + " (V2)";
 }

+
+PlacesItemSignalHandler *PlacesItem::signalHandler() const
+{
+    return m_signalHandler.data();
+}