src/panels/places/placesitem.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2012 by Peter Penz <peter.penz19@gmail.com>             *
   3  *                                                                         *
   4  *   Based on KFilePlacesItem from kdelibs:                                *
   5  *   Copyright (C) 2007 Kevin Ottens <ervin@kde.org>                       *
   6  *                                                                         *
   7  *   This program is free software; you can redistribute it and/or modify  *
   8  *   it under the terms of the GNU General Public License as published by  *
   9  *   the Free Software Foundation; either version 2 of the License, or     *
  10  *   (at your option) any later version.                                   *
  11  *                                                                         *
  12  *   This program is distributed in the hope that it will be useful,       *
  13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  15  *   GNU General Public License for more details.                          *
  16  *                                                                         *
  17  *   You should have received a copy of the GNU General Public License     *
  18  *   along with this program; if not, write to the                         *
  19  *   Free Software Foundation, Inc.,                                       *
  20  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  21  ***************************************************************************/
  22
  23 #include "placesitem.h"
  24 #include "trash/dolphintrash.h"
  25
  26 #include "dolphindebug.h"
  27 #include "placesitemsignalhandler.h"
  28
  29 #include <KDirLister>
  30 #include <KLocalizedString>
  31 #include <Solid/Block>
  32
  33 PlacesItem::PlacesItem(const KBookmark& bookmark, PlacesItem* parent) :
  34     KStandardItem(parent),
  35     m_device(),
  36     m_access(),
  37     m_volume(),
  38     m_disc(),
  39     m_mtp(),
  40     m_signalHandler(nullptr),
  41     m_trashDirLister(nullptr),
  42     m_bookmark()
  43 {
  44     m_signalHandler = new PlacesItemSignalHandler(this);
  45     setBookmark(bookmark);
  46 }
  47
  48 PlacesItem::~PlacesItem()
  49 {
  50     delete m_signalHandler;
  51     delete m_trashDirLister;
  52 }
  53
  54 void PlacesItem::setUrl(const QUrl &url)
  55 {
  56     // The default check in KStandardItem::setDataValue()
  57     // for equal values does not work with a custom value
  58     // like QUrl. Hence do a manual check to prevent that
  59     // setting an equal URL results in an itemsChanged()
  60     // signal.
  61     if (dataValue("url").toUrl() != url) {
  62         delete m_trashDirLister;
  63         if (url.scheme() == QLatin1String("trash")) {
  64             QObject::connect(&Trash::instance(), &Trash::emptinessChanged, m_signalHandler.data(), &PlacesItemSignalHandler::onTrashEmptinessChanged);
  65         }
  66
  67         setDataValue("url", url);
  68     }
  69 }
  70
  71 QUrl PlacesItem::url() const
  72 {
  73     return dataValue("url").toUrl();
  74 }
  75
  76 void PlacesItem::setUdi(const QString& udi)
  77 {
  78     setDataValue("udi", udi);
  79 }
  80
  81 QString PlacesItem::udi() const
  82 {
  83     return dataValue("udi").toString();
  84 }
  85
  86 void PlacesItem::setHidden(bool hidden)
  87 {
  88     setDataValue("isHidden", hidden);
  89 }
  90
  91 bool PlacesItem::isHidden() const
  92 {
  93     return dataValue("isHidden").toBool();
  94 }
  95
  96 bool PlacesItem::isGroupHidden() const
  97 {
  98     return dataValue("isGroupHidden").toBool();
  99 }
 100
 101 void PlacesItem::setGroupHidden(bool hidden)
 102 {
 103     setDataValue("isGroupHidden", hidden);
 104 }
 105
 106 void PlacesItem::setSystemItem(bool isSystemItem)
 107 {
 108     setDataValue("isSystemItem", isSystemItem);
 109 }
 110
 111 bool PlacesItem::isSystemItem() const
 112 {
 113     return dataValue("isSystemItem").toBool();
 114 }
 115
 116 Solid::Device PlacesItem::device() const
 117 {
 118     return m_device;
 119 }
 120
 121 void PlacesItem::setBookmark(const KBookmark& bookmark)
 122 {
 123     const bool bookmarkDataChanged = !(bookmark == m_bookmark);
 124
 125     // bookmark object must be updated to keep in sync with source model
 126     m_bookmark = bookmark;
 127
 128     if (!bookmarkDataChanged) {
 129         return;
 130     }
 131
 132     delete m_access;
 133     delete m_volume;
 134     delete m_disc;
 135     delete m_mtp;
 136
 137     const QString udi = bookmark.metaDataItem(QStringLiteral("UDI"));
 138     if (udi.isEmpty()) {
 139         setIcon(bookmark.icon());
 140         setText(i18ndc("kio5", "KFile System Bookmarks", bookmark.text().toUtf8().constData()));
 141         setUrl(bookmark.url());
 142         setSystemItem(bookmark.metaDataItem(QStringLiteral("isSystemItem")) == QLatin1String("true"));
 143     } else {
 144         initializeDevice(udi);
 145     }
 146
 147     setHidden(bookmark.metaDataItem(QStringLiteral("IsHidden")) == QLatin1String("true"));
 148 }
 149
 150 KBookmark PlacesItem::bookmark() const
 151 {
 152     return m_bookmark;
 153 }
 154
 155 bool PlacesItem::storageSetupNeeded() const
 156 {
 157     return m_access ? !m_access->isAccessible() : false;
 158 }
 159
 160 bool PlacesItem::isSearchOrTimelineUrl() const
 161 {
 162     const QString urlScheme = url().scheme();
 163     return (urlScheme.contains("search") || urlScheme.contains("timeline"));
 164 }
 165
 166 void PlacesItem::onDataValueChanged(const QByteArray& role,
 167                                     const QVariant& current,
 168                                     const QVariant& previous)
 169 {
 170     Q_UNUSED(current);
 171     Q_UNUSED(previous);
 172
 173     if (!m_bookmark.isNull()) {
 174         updateBookmarkForRole(role);
 175     }
 176 }
 177
 178 void PlacesItem::onDataChanged(const QHash<QByteArray, QVariant>& current,
 179                                const QHash<QByteArray, QVariant>& previous)
 180 {
 181     Q_UNUSED(previous);
 182
 183     if (!m_bookmark.isNull()) {
 184         QHashIterator<QByteArray, QVariant> it(current);
 185         while (it.hasNext()) {
 186             it.next();
 187             updateBookmarkForRole(it.key());
 188         }
 189     }
 190 }
 191
 192 void PlacesItem::initializeDevice(const QString& udi)
 193 {
 194     m_device = Solid::Device(udi);
 195     if (!m_device.isValid()) {
 196         return;
 197     }
 198
 199     m_access = m_device.as<Solid::StorageAccess>();
 200     m_volume = m_device.as<Solid::StorageVolume>();
 201     m_disc = m_device.as<Solid::OpticalDisc>();
 202     m_mtp = m_device.as<Solid::PortableMediaPlayer>();
 203
 204     setText(m_device.description());
 205     setIcon(m_device.icon());
 206     setIconOverlays(m_device.emblems());
 207     setUdi(udi);
 208
 209     if (m_access) {
 210         setUrl(QUrl::fromLocalFile(m_access->filePath()));
 211         QObject::connect(m_access.data(), &Solid::StorageAccess::accessibilityChanged,
 212                          m_signalHandler.data(), &PlacesItemSignalHandler::onAccessibilityChanged);
 213         QObject::connect(m_access.data(), &Solid::StorageAccess::teardownRequested,
 214                          m_signalHandler.data(), &PlacesItemSignalHandler::onTearDownRequested);
 215     } else if (m_disc && (m_disc->availableContent() & Solid::OpticalDisc::Audio) != 0) {
 216         Solid::Block *block = m_device.as<Solid::Block>();
 217         if (block) {
 218             const QString device = block->device();
 219             setUrl(QUrl(QStringLiteral("audiocd:/?device=%1").arg(device)));
 220         } else {
 221             setUrl(QUrl(QStringLiteral("audiocd:/")));
 222         }
 223     } else if (m_mtp) {
 224         setUrl(QUrl(QStringLiteral("mtp:udi=%1").arg(m_device.udi())));
 225     }
 226 }
 227
 228 void PlacesItem::onAccessibilityChanged()
 229 {
 230     setIconOverlays(m_device.emblems());
 231     setUrl(QUrl::fromLocalFile(m_access->filePath()));
 232 }
 233
 234 void PlacesItem::updateBookmarkForRole(const QByteArray& role)
 235 {
 236     Q_ASSERT(!m_bookmark.isNull());
 237     if (role == "iconName") {
 238         m_bookmark.setIcon(icon());
 239     } else if (role == "text") {
 240         // Only store the text in the KBookmark if it is not the translation of
 241         // the current text. This makes sure that the text is re-translated if
 242         // the user chooses another language, or the translation itself changes.
 243         //
 244         // NOTE: It is important to use "KFile System Bookmarks" as context
 245         // (see PlacesItemModel::createSystemBookmarks()).
 246         if (text() != i18ndc("kio5", "KFile System Bookmarks", m_bookmark.text().toUtf8().data())) {
 247             m_bookmark.setFullText(text());
 248         }
 249     } else if (role == "url") {
 250         m_bookmark.setUrl(url());
 251     } else if (role == "udi") {
 252         m_bookmark.setMetaDataItem(QStringLiteral("UDI"), udi());
 253     } else if (role == "isSystemItem") {
 254         m_bookmark.setMetaDataItem(QStringLiteral("isSystemItem"), isSystemItem() ? QStringLiteral("true") : QStringLiteral("false"));
 255     } else if (role == "isHidden") {
 256         m_bookmark.setMetaDataItem(QStringLiteral("IsHidden"), isHidden() ? QStringLiteral("true") : QStringLiteral("false"));
 257     }
 258 }
 259
 260 QString PlacesItem::generateNewId()
 261 {
 262     // The ID-generation must be different as done in KFilePlacesItem from kdelibs
 263     // to prevent identical IDs, because 'count' is of course not shared. We append a
 264     // " (V2)" to indicate that the ID has been generated by
 265     // a new version of the places view.
 266     static int count = 0;
 267     return QString::number(QDateTime::currentDateTimeUtc().toTime_t()) +
 268             '/' + QString::number(count++) + " (V2)";
 269 }
 270
 271 PlacesItemSignalHandler *PlacesItem::signalHandler() const
 272 {
 273     return m_signalHandler.data();
 274 }