src/panels/places/placesitemmodel.h

   1 /***************************************************************************
   2  *   Copyright (C) 2012 by Peter Penz <peter.penz19@gmail.com>             *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  18  ***************************************************************************/
  19
  20 #ifndef PLACESITEMMODEL_H
  21 #define PLACESITEMMODEL_H
  22
  23 #include <config-nepomuk.h>
  24
  25 #include <kitemviews/kstandarditemmodel.h>
  26
  27 #include <KUrl>
  28 #include <QHash>
  29 #include <QList>
  30 #include <QSet>
  31 #include <Solid/Predicate>
  32 #include <Solid/StorageAccess>
  33
  34 class KBookmark;
  35 class KBookmarkManager;
  36 class PlacesItem;
  37 class QAction;
  38 class QTimer;
  39
  40 #ifdef HAVE_NEPOMUK
  41     namespace Nepomuk
  42     {
  43         namespace Query
  44         {
  45             class Term;
  46         }
  47     }
  48 #endif
  49
  50 // #define PLACESITEMMODEL_DEBUG
  51
  52 /**
  53  * @brief Model for maintaining the bookmarks of the places panel.
  54  *
  55  * It is compatible to the KFilePlacesModel from kdelibs but adds
  56  * the ability to have groups for places.
  57  */
  58 class PlacesItemModel: public KStandardItemModel
  59 {
  60     Q_OBJECT
  61
  62 public:
  63     explicit PlacesItemModel(QObject* parent = 0);
  64     virtual ~PlacesItemModel();
  65
  66     /**
  67      * @return A new instance of a places item with the given
  68      *         attributes.
  69      */
  70     PlacesItem* createPlacesItem(const QString& text,
  71                                  const KUrl& url,
  72                                  const QString& iconName);
  73
  74     PlacesItem* placesItem(int index) const;
  75
  76     /**
  77      * If set to true, all items that are marked as hidden
  78      * will be shown in the view. The items will
  79      * stay marked as hidden, which is visually indicated
  80      * by the view by desaturating the icon and the text.
  81      */
  82     void setHiddenItemsShown(bool show);
  83     bool hiddenItemsShown() const;
  84
  85     /**
  86      * @return Number of items that are marked as hidden.
  87      *         Note that this does not mean that the items
  88      *         are really hidden
  89      *         (see PlacesItemModel::setHiddenItemsShown()).
  90      */
  91     int hiddenCount() const;
  92
  93     /**
  94      * Search the item which is equal to the URL or at least
  95      * is a parent URL. If there are more than one possible
  96      * candidates, return the item which covers the biggest
  97      * range of the URL. -1 is returned if no closest item
  98      * could be found.
  99      */
 100     int closestItem(const KUrl& url) const;
 101
 102     QAction* ejectAction(int index) const;
 103     QAction* teardownAction(int index) const;
 104
 105     void requestEject(int index);
 106     void requestTeardown(int index);
 107
 108     /** @reimp */
 109     virtual QMimeData* createMimeData(const QSet<int>& indexes) const;
 110
 111     void dropMimeData(int index, const QMimeData* mimeData);
 112
 113     /**
 114      * @return Converts the URL, which contains "virtual" URLs for system-items like
 115      *         "search:/documents" into a Nepomuk-Query-URL that will be handled by
 116      *         the corresponding IO-slave. Virtual URLs for bookmarks are used to
 117      *         be independent from internal format changes.
 118      */
 119     static KUrl convertedUrl(const KUrl& url);
 120
 121 signals:
 122     void errorMessage(const QString& message);
 123
 124 protected:
 125     virtual void onItemInserted(int index);
 126     virtual void onItemRemoved(int index, KStandardItem* removedItem);
 127     virtual void onItemChanged(int index, const QSet<QByteArray>& changedRoles);
 128
 129 private slots:
 130     void slotDeviceAdded(const QString& udi);
 131     void slotDeviceRemoved(const QString& udi);
 132     void slotStorageTeardownDone(Solid::ErrorType error, const QVariant& errorData);
 133     void hideItem();
 134
 135     /**
 136      * Updates the bookmarks from the model corresponding to the changed
 137      * bookmarks stored by the bookmark-manager. Is called whenever the bookmarks
 138      * have been changed by another application.
 139      */
 140     void updateBookmarks();
 141
 142     /**
 143      * Saves the bookmarks and indicates to other applications that the
 144      * state of the bookmarks has been changed. Is only called by the
 145      * timeout of m_saveBookmarksTimer to prevent unnecessary savings.
 146      */
 147     void saveBookmarks();
 148
 149 private:
 150     struct SystemBookmarkData;
 151
 152     /**
 153      * Loads the bookmarks from the bookmark-manager and creates items for
 154      * the model or moves hidden items to m_bookmarkedItems.
 155      */
 156     void loadBookmarks();
 157
 158     /**
 159      * @return True, if the bookmark can be accepted in the context of the
 160      *         current application (e.g. bookmarks from other applications
 161      *         will be ignored).
 162      */
 163     bool acceptBookmark(const KBookmark& bookmark) const;
 164
 165     /**
 166      * Creates a PlacesItem for a system-bookmark:
 167      * - PlacesItem::isSystemItem() will return true
 168      * - Default view-properties will be created for "Search For" items
 169      * The item is not inserted to the model yet.
 170      */
 171     PlacesItem* createSystemPlacesItem(const SystemBookmarkData& data);
 172
 173     /**
 174      * Creates system bookmarks that are shown per default and can
 175      * only be hidden but not removed. The result will be stored
 176      * in m_systemBookmarks.
 177      */
 178     void createSystemBookmarks();
 179
 180     void initializeAvailableDevices();
 181
 182     /**
 183      * @param index Item index related to the model.
 184      * @return      Corresponding index related to m_bookmarkedItems.
 185      */
 186     int bookmarkIndex(int index) const;
 187
 188     /**
 189      * Marks the item with the index \a index as hidden and
 190      * removes it from the model so that it gets invisible.
 191      */
 192     void hideItem(int index);
 193
 194     /**
 195      * Triggers a delayed saving of bookmarks by starting
 196      * m_saveBookmarksTimer.
 197      */
 198     void triggerBookmarksSaving();
 199
 200     QString internalMimeType() const;
 201
 202     /**
 203      * @return Adjusted drop index which assures that the item is aligned
 204      *         into the same group as specified by PlacesItem::groupType().
 205      */
 206     int groupedDropIndex(int index, const PlacesItem* item) const;
 207
 208     /**
 209      * @return True if the bookmarks have the same identifiers. The identifier
 210      *         is the unique "ID"-property in case if no UDI is set, otherwise
 211      *         the UDI is used as identifier.
 212      */
 213     static bool equalBookmarkIdentifiers(const KBookmark& b1, const KBookmark& b2);
 214
 215     /**
 216      * @return URL using the timeline-protocol for searching (see convertedUrl()).
 217      */
 218     static KUrl createTimelineUrl(const KUrl& url);
 219
 220     /**
 221      * Helper method for createTimelineUrl().
 222      * @return String that represents a date-path in the format that
 223      *         the timeline-protocol expects.
 224      */
 225     static QString timelineDateString(int year, int month, int day = 0);
 226
 227     /**
 228      * @return URL that can be listed by KIO and results in searching
 229      *         for a given term. The URL \a url represents a places-internal
 230      *         URL like e.g. "search:/documents" (see convertedUrl()).
 231      */
 232     static KUrl createSearchUrl(const KUrl& url);
 233
 234 #ifdef HAVE_NEPOMUK
 235     /**
 236      * Helper method for createSearchUrl().
 237      * @return URL that can be listed by KIO and results in searching
 238      *         for the given term.
 239      */
 240     static KUrl searchUrlForTerm(const Nepomuk::Query::Term& term);
 241 #endif
 242
 243 #ifdef PLACESITEMMODEL_DEBUG
 244     void showModelState();
 245 #endif
 246
 247 private:
 248     bool m_nepomukRunning;
 249     bool m_hiddenItemsShown;
 250
 251     QSet<QString> m_availableDevices;
 252     Solid::Predicate m_predicate;
 253     KBookmarkManager* m_bookmarkManager;
 254
 255     struct SystemBookmarkData
 256     {
 257         SystemBookmarkData(const KUrl& url,
 258                            const QString& icon,
 259                            const QString& text) :
 260             url(url), icon(icon), text(text) {}
 261         KUrl url;
 262         QString icon;
 263         QString text;
 264     };
 265
 266     QList<SystemBookmarkData> m_systemBookmarks;
 267     QHash<KUrl, int> m_systemBookmarksIndexes;
 268
 269     // Contains hidden and unhidden items that are stored as
 270     // bookmark (the model itself only contains items that
 271     // are shown in the view). If an entry is 0, then the
 272     // places-item is part of the model. If an entry is not
 273     // 0, the item is hidden and not part of the model.
 274     QList<PlacesItem*> m_bookmarkedItems;
 275
 276     // Index of the hidden item that should be removed in
 277     // removeHiddenItem(). The removing must be done
 278     // asynchronously as in the scope of onItemChanged()
 279     // removing an item is not allowed.
 280     int m_hiddenItemToRemove;
 281
 282     QTimer* m_saveBookmarksTimer;
 283     QTimer* m_updateBookmarksTimer;
 284 };
 285
 286 #endif
 287
 288