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
  25 #include <KBookmarkManager>
  26 #include <KDebug>
  27 #include <KDirLister>
  28 #include <KIcon>
  29 #include <KLocale>
  30 #include "placesitemsignalhandler.h"
  31 #include <QDateTime>
  32 #include <Solid/Block>
  33
  34 PlacesItem::PlacesItem(const KBookmark& bookmark, PlacesItem* parent) :
  35     KStandardItem(parent),
  36     m_device(),
  37     m_access(),
  38     m_volume(),
  39     m_disc(),
  40     m_mtp(),
  41     m_signalHandler(0),
  42     m_trashDirLister(0),
  43     m_bookmark()
  44 {
  45     m_signalHandler = new PlacesItemSignalHandler(this);
  46     setBookmark(bookmark);
  47 }
  48
  49 PlacesItem::~PlacesItem()
  50 {
  51     delete m_signalHandler;
  52     delete m_trashDirLister;
  53 }
  54
  55 void PlacesItem::setUrl(const KUrl& url)
  56 {
  57     // The default check in KStandardItem::setDataValue()
  58     // for equal values does not work with a custom value
  59     // like KUrl. Hence do a manual check to prevent that
  60     // setting an equal URL results in an itemsChanged()
  61     // signal.
  62     if (dataValue("url").value<KUrl>() != url) {
  63         delete m_trashDirLister;
  64         if (url.protocol() == QLatin1String("trash")) {
  65             // The trash icon must always be updated dependent on whether
  66             // the trash is empty or not. We use a KDirLister that automatically
  67             // watches for changes if the number of items has been changed.
  68             // The update of the icon is handled in onTrashDirListerCompleted().
  69             m_trashDirLister = new KDirLister();
  70             m_trashDirLister->setAutoErrorHandlingEnabled(false, 0);
  71             m_trashDirLister->setDelayedMimeTypes(true);
  72             QObject::connect(m_trashDirLister, SIGNAL(completed()),
  73                              m_signalHandler, SLOT(onTrashDirListerCompleted()));
  74             m_trashDirLister->openUrl(url);
  75         }
  76
  77         setDataValue("url", url);
  78     }
  79 }
  80
  81 KUrl PlacesItem::url() const
  82 {
  83     return dataValue("url").value<KUrl>();
  84 }
  85
  86 void PlacesItem::setUdi(const QString& udi)
  87 {
  88     setDataValue("udi", udi);
  89 }
  90
  91 QString PlacesItem::udi() const
  92 {
  93     return dataValue("udi").toString();
  94 }
  95
  96 void PlacesItem::setHidden(bool hidden)
  97 {
  98     setDataValue("isHidden", hidden);
  99 }
 100
 101 bool PlacesItem::isHidden() const
 102 {
 103     return dataValue("isHidden").toBool();
 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     m_bookmark = bookmark;
 124
 125     delete m_access;
 126     delete m_volume;
 127     delete m_disc;
 128     delete m_mtp;
 129
 130
 131     const QString udi = bookmark.metaDataItem("UDI");
 132     if (udi.isEmpty()) {
 133         setIcon(bookmark.icon());
 134         setText(bookmark.text());
 135         setUrl(bookmark.url());
 136     } else {
 137         initializeDevice(udi);
 138     }
 139
 140     const GroupType type = groupType();
 141     if (icon().isEmpty()) {
 142         switch (type) {
 143         case RecentlyAccessedType: setIcon("chronometer"); break;
 144         case SearchForType:        setIcon("nepomuk"); break;
 145         case PlacesType:
 146         default:                   setIcon("folder");
 147         }
 148
 149     }
 150
 151     switch (type) {
 152     case PlacesType:           setGroup(i18nc("@item", "Places")); break;
 153     case RecentlyAccessedType: setGroup(i18nc("@item", "Recently Accessed")); break;
 154     case SearchForType:        setGroup(i18nc("@item", "Search For")); break;
 155     case DevicesType:          setGroup(i18nc("@item", "Devices")); break;
 156     default:                   Q_ASSERT(false); break;
 157     }
 158
 159     setHidden(bookmark.metaDataItem("IsHidden") == QLatin1String("true"));
 160 }
 161
 162 KBookmark PlacesItem::bookmark() const
 163 {
 164     return m_bookmark;
 165 }
 166
 167 PlacesItem::GroupType PlacesItem::groupType() const
 168 {
 169     if (udi().isEmpty()) {
 170         const QString protocol = url().protocol();
 171         if (protocol == QLatin1String("timeline")) {
 172             return RecentlyAccessedType;
 173         }
 174
 175         if (protocol.contains(QLatin1String("search"))) {
 176             return SearchForType;
 177         }
 178
 179         if (protocol == QLatin1String("bluetooth")) {
 180             return DevicesType;
 181         }
 182
 183         return PlacesType;
 184     }
 185
 186     return DevicesType;
 187 }
 188
 189 bool PlacesItem::storageSetupNeeded() const
 190 {
 191     return m_access ? !m_access->isAccessible() : false;
 192 }
 193
 194 KBookmark PlacesItem::createBookmark(KBookmarkManager* manager,
 195                                      const QString& text,
 196                                      const KUrl& url,
 197                                      const QString& iconName)
 198 {
 199     KBookmarkGroup root = manager->root();
 200     if (root.isNull()) {
 201         return KBookmark();
 202     }
 203
 204     KBookmark bookmark = root.addBookmark(text, url, iconName);
 205     bookmark.setFullText(text);
 206     bookmark.setMetaDataItem("ID", generateNewId());
 207
 208     return bookmark;
 209 }
 210
 211 KBookmark PlacesItem::createDeviceBookmark(KBookmarkManager* manager,
 212                                            const QString& udi)
 213 {
 214     KBookmarkGroup root = manager->root();
 215     if (root.isNull()) {
 216         return KBookmark();
 217     }
 218
 219     KBookmark bookmark = root.createNewSeparator();
 220     bookmark.setMetaDataItem("UDI", udi);
 221     bookmark.setMetaDataItem("isSystemItem", "true");
 222     return bookmark;
 223 }
 224
 225 void PlacesItem::onDataValueChanged(const QByteArray& role,
 226                                     const QVariant& current,
 227                                     const QVariant& previous)
 228 {
 229     Q_UNUSED(current);
 230     Q_UNUSED(previous);
 231
 232     if (!m_bookmark.isNull()) {
 233         updateBookmarkForRole(role);
 234     }
 235 }
 236
 237 void PlacesItem::onDataChanged(const QHash<QByteArray, QVariant>& current,
 238                                const QHash<QByteArray, QVariant>& previous)
 239 {
 240     Q_UNUSED(previous);
 241
 242     if (!m_bookmark.isNull()) {
 243         QHashIterator<QByteArray, QVariant> it(current);
 244         while (it.hasNext()) {
 245             it.next();
 246             updateBookmarkForRole(it.key());
 247         }
 248     }
 249 }
 250
 251 void PlacesItem::initializeDevice(const QString& udi)
 252 {
 253     m_device = Solid::Device(udi);
 254     if (!m_device.isValid()) {
 255         return;
 256     }
 257
 258     m_access = m_device.as<Solid::StorageAccess>();
 259     m_volume = m_device.as<Solid::StorageVolume>();
 260     m_disc = m_device.as<Solid::OpticalDisc>();
 261     m_mtp = m_device.as<Solid::PortableMediaPlayer>();
 262
 263     setText(m_device.description());
 264     setIcon(m_device.icon());
 265     setIconOverlays(m_device.emblems());
 266     setUdi(udi);
 267
 268     if (m_access) {
 269         setUrl(m_access->filePath());
 270         QObject::connect(m_access, SIGNAL(accessibilityChanged(bool,QString)),
 271                          m_signalHandler, SLOT(onAccessibilityChanged()));
 272     } else if (m_disc && (m_disc->availableContent() & Solid::OpticalDisc::Audio) != 0) {
 273         const QString device = m_device.as<Solid::Block>()->device();
 274         setUrl(QString("audiocd:/?device=%1").arg(device));
 275     } else if (m_mtp) {
 276         setUrl(QString("mtp:udi=%1").arg(m_device.udi()));
 277     }
 278 }
 279
 280 void PlacesItem::onAccessibilityChanged()
 281 {
 282     setIconOverlays(m_device.emblems());
 283     setUrl(m_access->filePath());
 284 }
 285
 286 void PlacesItem::onTrashDirListerCompleted()
 287 {
 288     Q_ASSERT(url().protocol() == QLatin1String("trash"));
 289
 290     const bool isTrashEmpty = m_trashDirLister->items().isEmpty();
 291     setIcon(isTrashEmpty ? "user-trash" : "user-trash-full");
 292 }
 293
 294 void PlacesItem::updateBookmarkForRole(const QByteArray& role)
 295 {
 296     Q_ASSERT(!m_bookmark.isNull());
 297     if (role == "iconName") {
 298         m_bookmark.setIcon(icon());
 299     } else if (role == "text") {
 300         m_bookmark.setFullText(text());
 301     } else if (role == "url") {
 302         m_bookmark.setUrl(url());
 303     } else if (role == "udi)") {
 304         m_bookmark.setMetaDataItem("UDI", udi());
 305     } else if (role == "isSystemItem") {
 306         m_bookmark.setMetaDataItem("isSystemItem", isSystemItem() ? "true" : "false");
 307     } else if (role == "isHidden") {
 308         m_bookmark.setMetaDataItem("IsHidden", isHidden() ? "true" : "false");
 309     }
 310 }
 311
 312 QString PlacesItem::generateNewId()
 313 {
 314     // The ID-generation must be different as done in KFilePlacesItem from kdelibs
 315     // to prevent identical IDs, because 'count' is of course not shared. We append a
 316     // " (V2)" to indicate that the ID has been generated by
 317     // a new version of the places view.
 318     static int count = 0;
 319     return QString::number(QDateTime::currentDateTime().toTime_t()) +
 320             '/' + QString::number(count++) + " (V2)";
 321 }