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     /**
 112      * @return Converts the URL, which contains "virtual" URLs for system-items like
 113      *         "search:/documents" into a Nepomuk-Query-URL that will be handled by
 114      *         the corresponding IO-slave. Virtual URLs for bookmarks are used to
 115      *         be independent from internal format changes.
 116      */
 117     static KUrl convertedUrl(const KUrl& url);
 118
 119 signals:
 120     void errorMessage(const QString& message);
 121
 122 protected:
 123     virtual void onItemInserted(int index);
 124     virtual void onItemRemoved(int index, KStandardItem* removedItem);
 125     virtual void onItemChanged(int index, const QSet<QByteArray>& changedRoles);
 126
 127 private slots:
 128     void slotDeviceAdded(const QString& udi);
 129     void slotDeviceRemoved(const QString& udi);
 130     void slotStorageTeardownDone(Solid::ErrorType error, const QVariant& errorData);
 131     void hideItem();
 132
 133     /**
 134      * Updates the bookmarks from the model corresponding to the changed
 135      * bookmarks stored by the bookmark-manager. Is called whenever the bookmarks
 136      * have been changed by another application.
 137      */
 138     void updateBookmarks();
 139
 140     /**
 141      * Saves the bookmarks and indicates to other applications that the
 142      * state of the bookmarks has been changed. Is only called by the
 143      * timeout of m_saveBookmarksTimer to prevent unnecessary savings.
 144      */
 145     void saveBookmarks();
 146
 147 private:
 148     struct SystemBookmarkData;
 149
 150     /**
 151      * Loads the bookmarks from the bookmark-manager and creates items for
 152      * the model or moves hidden items to m_bookmarkedItems.
 153      */
 154     void loadBookmarks();
 155
 156     /**
 157      * @return True, if the bookmark can be accepted in the context of the
 158      *         current application (e.g. bookmarks from other applications
 159      *         will be ignored).
 160      */
 161     bool acceptBookmark(const KBookmark& bookmark) const;
 162
 163     /**
 164      * Creates a PlacesItem for a system-bookmark:
 165      * - PlacesItem::isSystemItem() will return true
 166      * - Default view-properties will be created for "Search For" items
 167      * The item is not inserted to the model yet.
 168      */
 169     PlacesItem* createSystemPlacesItem(const SystemBookmarkData& data);
 170
 171     /**
 172      * Creates system bookmarks that are shown per default and can
 173      * only be hidden but not removed. The result will be stored
 174      * in m_systemBookmarks.
 175      */
 176     void createSystemBookmarks();
 177
 178     void initializeAvailableDevices();
 179
 180     /**
 181      * @param index Item index related to the model.
 182      * @return      Corresponding index related to m_bookmarkedItems.
 183      */
 184     int bookmarkIndex(int index) const;
 185
 186     /**
 187      * Marks the item with the index \a index as hidden and
 188      * removes it from the model so that it gets invisible.
 189      */
 190     void hideItem(int index);
 191
 192     /**
 193      * Triggers a delayed saving of bookmarks by starting
 194      * m_saveBookmarksTimer.
 195      */
 196     void triggerBookmarksSaving();
 197
 198     /**
 199      * @return True if the bookmarks have the same identifiers. The identifier
 200      *         is the unique "ID"-property in case if no UDI is set, otherwise
 201      *         the UDI is used as identifier.
 202      */
 203     static bool equalBookmarkIdentifiers(const KBookmark& b1, const KBookmark& b2);
 204
 205     /**
 206      * @return URL using the timeline-protocol for searching (see convertedUrl()).
 207      */
 208     static KUrl createTimelineUrl(const KUrl& url);
 209
 210     /**
 211      * Helper method for createTimelineUrl().
 212      * @return String that represents a date-path in the format that
 213      *         the timeline-protocol expects.
 214      */
 215     static QString timelineDateString(int year, int month, int day = 0);
 216
 217     /**
 218      * @return URL that can be listed by KIO and results in searching
 219      *         for a given term. The URL \a url represents a places-internal
 220      *         URL like e.g. "search:/documents" (see convertedUrl()).
 221      */
 222     static KUrl createSearchUrl(const KUrl& url);
 223
 224 #ifdef HAVE_NEPOMUK
 225     /**
 226      * Helper method for createSearchUrl().
 227      * @return URL that can be listed by KIO and results in searching
 228      *         for the given term.
 229      */
 230     static KUrl searchUrlForTerm(const Nepomuk::Query::Term& term);
 231 #endif
 232
 233 #ifdef PLACESITEMMODEL_DEBUG
 234     void showModelState();
 235 #endif
 236
 237 private:
 238     bool m_nepomukRunning;
 239     bool m_hiddenItemsShown;
 240
 241     QSet<QString> m_availableDevices;
 242     Solid::Predicate m_predicate;
 243     KBookmarkManager* m_bookmarkManager;
 244
 245     struct SystemBookmarkData
 246     {
 247         SystemBookmarkData(const KUrl& url,
 248                            const QString& icon,
 249                            const QString& text) :
 250             url(url), icon(icon), text(text) {}
 251         KUrl url;
 252         QString icon;
 253         QString text;
 254     };
 255
 256     QList<SystemBookmarkData> m_systemBookmarks;
 257     QHash<KUrl, int> m_systemBookmarksIndexes;
 258
 259     // Contains hidden and unhidden items that are stored as
 260     // bookmark (the model itself only contains items that
 261     // are shown in the view). If an entry is 0, then the
 262     // places-item is part of the model. If an entry is not
 263     // 0, the item is hidden and not part of the model.
 264     QList<PlacesItem*> m_bookmarkedItems;
 265
 266     // Index of the hidden item that should be removed in
 267     // removeHiddenItem(). The removing must be done
 268     // asynchronously as in the scope of onItemChanged()
 269     // removing an item is not allowed.
 270     int m_hiddenItemToRemove;
 271
 272     QTimer* m_saveBookmarksTimer;
 273     QTimer* m_updateBookmarksTimer;
 274 };
 275
 276 #endif
 277
 278