src/kitemviews/kfileitemmodel.h

   1 /*
   2  * SPDX-FileCopyrightText: 2011 Peter Penz <peter.penz19@gmail.com>
   3  *
   4  * SPDX-License-Identifier: GPL-2.0-or-later
   5  */
   6
   7 #ifndef KFILEITEMMODEL_H
   8 #define KFILEITEMMODEL_H
   9
  10 #include "dolphin_export.h"
  11 #include "kitemviews/kitemmodelbase.h"
  12 #include "kitemviews/private/kfileitemmodelfilter.h"
  13
  14 #include <KFileItem>
  15
  16 #include <QCollator>
  17 #include <QHash>
  18 #include <QSet>
  19 #include <QUrl>
  20
  21 #include <functional>
  22
  23 class KDirLister;
  24
  25 class QTimer;
  26
  27 namespace KIO {
  28     class Job;
  29 }
  30
  31 /**
  32  * @brief KItemModelBase implementation for KFileItems.
  33  *
  34  * Allows to load items of a directory. Sorting and grouping of
  35  * items are supported. Roles that are not part of KFileItem can
  36  * be added with KFileItemModel::setData().
  37  *
  38  * Recursive expansion of sub-directories is supported by
  39  * KFileItemModel::setExpanded().
  40  */
  41 class DOLPHIN_EXPORT KFileItemModel : public KItemModelBase
  42 {
  43     Q_OBJECT
  44
  45 public:
  46     explicit KFileItemModel(QObject* parent = nullptr);
  47     ~KFileItemModel() override;
  48
  49     /**
  50      * Loads the directory specified by \a url. The signals
  51      * directoryLoadingStarted(), directoryLoadingProgress() and directoryLoadingCompleted()
  52      * indicate the current state of the loading process. The items
  53      * of the directory are added after the loading has been completed.
  54      */
  55     void loadDirectory(const QUrl& url);
  56
  57     /**
  58      * Throws away all currently loaded items and refreshes the directory
  59      * by reloading all items again.
  60      */
  61     void refreshDirectory(const QUrl& url);
  62
  63     /**
  64      * @return Parent directory of the items that are shown. In case
  65      *         if a directory tree is shown, KFileItemModel::dir() returns
  66      *         the root-parent of all items.
  67      * @see rootItem()
  68      */
  69     QUrl directory() const override;
  70
  71     /**
  72      * Cancels the loading of a directory which has been started by either
  73      * loadDirectory() or refreshDirectory().
  74      */
  75     void cancelDirectoryLoading();
  76
  77     int count() const override;
  78     QHash<QByteArray, QVariant> data(int index) const override;
  79     bool setData(int index, const QHash<QByteArray, QVariant>& values) override;
  80
  81     /**
  82      * Sets a separate sorting with directories first (true) or a mixed
  83      * sorting of files and directories (false).
  84      */
  85     void setSortDirectoriesFirst(bool dirsFirst);
  86     bool sortDirectoriesFirst() const;
  87
  88     void setShowHiddenFiles(bool show);
  89     bool showHiddenFiles() const;
  90
  91     /**
  92      * If set to true, only directories are shown as items of the model. Files
  93      * are ignored.
  94      */
  95     void setShowDirectoriesOnly(bool enabled);
  96     bool showDirectoriesOnly() const;
  97
  98     QMimeData* createMimeData(const KItemSet& indexes) const override;
  99
 100     int indexForKeyboardSearch(const QString& text, int startFromIndex = 0) const override;
 101
 102     bool supportsDropping(int index) const override;
 103
 104     QString roleDescription(const QByteArray& role) const override;
 105
 106     QList<QPair<int, QVariant> > groups() const override;
 107
 108     /**
 109      * @return The file-item for the index \a index. If the index is in a valid
 110      *         range it is assured that the file-item is not null. The runtime
 111      *         complexity of this call is O(1).
 112      */
 113     KFileItem fileItem(int index) const;
 114
 115     /**
 116      * @return The file-item for the url \a url. If no file-item with the given
 117      *         URL is found KFileItem::isNull() will be true for the returned
 118      *         file-item. The runtime complexity of this call is O(1).
 119      */
 120     KFileItem fileItem(const QUrl& url) const;
 121
 122     /**
 123      * @return The index for the file-item \a item. -1 is returned if no file-item
 124      *         is found or if the file-item is null. The amortized runtime
 125      *         complexity of this call is O(1).
 126      */
 127     int index(const KFileItem& item) const;
 128
 129     /**
 130      * @return The index for the URL \a url. -1 is returned if no file-item
 131      *         is found. The amortized runtime complexity of this call is O(1).
 132      */
 133     int index(const QUrl &url) const;
 134
 135     /**
 136      * @return Root item of all items representing the item
 137      *         for KFileItemModel::dir().
 138      */
 139     KFileItem rootItem() const;
 140
 141     /**
 142      * Clears all items of the model.
 143      */
 144     void clear();
 145
 146     /**
 147      * Sets the roles that should be shown for each item.
 148      */
 149     void setRoles(const QSet<QByteArray>& roles);
 150     QSet<QByteArray> roles() const;
 151
 152     bool setExpanded(int index, bool expanded) override;
 153     bool isExpanded(int index) const override;
 154     bool isExpandable(int index) const override;
 155     int expandedParentsCount(int index) const override;
 156
 157     QSet<QUrl> expandedDirectories() const;
 158
 159     /**
 160      * Marks the URLs in \a urls as sub-directories which were expanded previously.
 161      * After calling loadDirectory() or refreshDirectory() the marked sub-directories
 162      * will be expanded step-by-step.
 163      */
 164     void restoreExpandedDirectories(const QSet<QUrl>& urls);
 165
 166     /**
 167      * Expands all parent-directories of the item \a url.
 168      */
 169     void expandParentDirectories(const QUrl& url);
 170
 171     void setNameFilter(const QString& nameFilter);
 172     QString nameFilter() const;
 173
 174     void setMimeTypeFilters(const QStringList& filters);
 175     QStringList mimeTypeFilters() const;
 176
 177     struct RoleInfo
 178     {   QByteArray role;
 179         QString translation;
 180         QString group;
 181         bool requiresBaloo;
 182         bool requiresIndexer;
 183     };
 184
 185     /**
 186      * @return Provides static information for all available roles that
 187      *         are supported by KFileItemModel. Some roles can only be
 188      *         determined if Baloo is enabled and/or the Baloo
 189      *         indexing is enabled.
 190      */
 191     static QList<RoleInfo> rolesInformation();
 192
 193 Q_SIGNALS:
 194     /**
 195      * Is emitted if the loading of a directory has been started. It is
 196      * assured that a signal directoryLoadingCompleted() will be send after
 197      * the loading has been finished. For tracking the loading progress
 198      * the signal directoryLoadingProgress() gets emitted in between.
 199      */
 200     void directoryLoadingStarted();
 201
 202     /**
 203      * Is emitted after the loading of a directory has been completed or new
 204      * items have been inserted to an already loaded directory. Usually
 205      * one or more itemsInserted() signals are emitted before loadingCompleted()
 206      * (the only exception is loading an empty directory, where only a
 207      * loadingCompleted() signal gets emitted).
 208      */
 209     void directoryLoadingCompleted();
 210
 211     /**
 212      * Is emitted after the loading of a directory has been canceled.
 213      */
 214     void directoryLoadingCanceled();
 215
 216     /**
 217      * Informs about the progress in percent when loading a directory. It is assured
 218      * that the signal directoryLoadingStarted() has been emitted before.
 219      */
 220     void directoryLoadingProgress(int percent);
 221
 222     /**
 223      * Is emitted if the sort-role gets resolved asynchronously and provides
 224      * the progress-information of the sorting in percent. It is assured
 225      * that the last sortProgress-signal contains 100 as value.
 226      */
 227     void directorySortingProgress(int percent);
 228
 229     /**
 230      * Is emitted if an information message (e.g. "Connecting to host...")
 231      * should be shown.
 232      */
 233     void infoMessage(const QString& message);
 234
 235     /**
 236      * Is emitted if an error message (e.g. "Unknown location")
 237      * should be shown.
 238      */
 239     void errorMessage(const QString& message);
 240
 241     /**
 242      * Is emitted if a redirection from the current URL \a oldUrl
 243      * to the new URL \a newUrl has been done.
 244      */
 245     void directoryRedirection(const QUrl& oldUrl, const QUrl& newUrl);
 246
 247     /**
 248      * Is emitted when the URL passed by KFileItemModel::setUrl() represents a file.
 249      * In this case no signal errorMessage() will be emitted.
 250      */
 251     void urlIsFileError(const QUrl& url);
 252
 253     /**
 254      * It is emitted for files when they change and
 255      * for dirs when files are added or removed.
 256      */
 257     void fileItemsChanged(const KFileItemList &changedFileItems);
 258
 259 protected:
 260     void onGroupedSortingChanged(bool current) override;
 261     void onSortRoleChanged(const QByteArray& current, const QByteArray& previous, bool resortItems = true) override;
 262     void onSortOrderChanged(Qt::SortOrder current, Qt::SortOrder previous) override;
 263
 264 private Q_SLOTS:
 265     /**
 266      * Resorts all items dependent on the set sortRole(), sortOrder()
 267      * and foldersFirst() settings.
 268      */
 269     void resortAllItems();
 270
 271     void slotCompleted();
 272     void slotCanceled();
 273     void slotItemsAdded(const QUrl& directoryUrl, const KFileItemList& items);
 274     void slotItemsDeleted(const KFileItemList& items);
 275     void slotRefreshItems(const QList<QPair<KFileItem, KFileItem> >& items);
 276     void slotClear();
 277     void slotSortingChoiceChanged();
 278     void slotListerError(KIO::Job *job);
 279
 280     void dispatchPendingItemsToInsert();
 281
 282 private:
 283     enum RoleType {
 284         // User visible roles:
 285         NoRole, NameRole, SizeRole, ModificationTimeRole, CreationTimeRole, AccessTimeRole, PermissionsRole, OwnerRole,
 286         GroupRole, TypeRole, DestinationRole, PathRole, DeletionTimeRole,
 287         // User visible roles available with Baloo:
 288         CommentRole, TagsRole, RatingRole, WidthRole, HeightRole, ImageDateTimeRole, OrientationRole,
 289         WordCountRole, TitleRole, LineCountRole, ArtistRole, GenreRole, AlbumRole, DurationRole, TrackRole, ReleaseYearRole,
 290         BitrateRole, OriginUrlRole, AspectRatioRole, FrameRateRole,
 291         // Non-visible roles:
 292         IsDirRole, IsLinkRole, IsHiddenRole, IsExpandedRole, IsExpandableRole, ExpandedParentsCountRole,
 293         // Mandatory last entry:
 294         RolesCount
 295     };
 296
 297     struct ItemData
 298     {
 299         KFileItem item;
 300         QHash<QByteArray, QVariant> values;
 301         ItemData* parent;
 302     };
 303
 304     enum RemoveItemsBehavior {
 305         KeepItemData,
 306         DeleteItemData
 307     };
 308
 309     void insertItems(QList<ItemData*>& items);
 310     void removeItems(const KItemRangeList& itemRanges, RemoveItemsBehavior behavior);
 311
 312     /**
 313      * Helper method for insertItems() and removeItems(): Creates
 314      * a list of ItemData elements based on the given items.
 315      * Note that the ItemData instances are created dynamically and
 316      * must be deleted by the caller.
 317      */
 318     QList<ItemData*> createItemDataList(const QUrl& parentUrl, const KFileItemList& items) const;
 319
 320     /**
 321      * Prepares the items for sorting. Normally, the hash 'values' in ItemData is filled
 322      * lazily to save time and memory, but for some sort roles, it is expected that the
 323      * sort role data is stored in 'values'.
 324      */
 325     void prepareItemsForSorting(QList<ItemData*>& itemDataList);
 326
 327     static int expandedParentsCount(const ItemData* data);
 328
 329     void removeExpandedItems();
 330
 331     /**
 332      * This function is called by setData() and slotRefreshItems(). It emits
 333      * the itemsChanged() signal, checks if the sort order is still correct,
 334      * and starts m_resortAllItemsTimer if that is not the case.
 335      */
 336     void emitItemsChangedAndTriggerResorting(const KItemRangeList& itemRanges, const QSet<QByteArray>& changedRoles);
 337
 338     /**
 339      * Resets all values from m_requestRole to false.
 340      */
 341     void resetRoles();
 342
 343     /**
 344      * @return Role-type for the given role.
 345      *         Runtime complexity is O(1).
 346      */
 347     RoleType typeForRole(const QByteArray& role) const;
 348
 349     /**
 350      * @return Role-byte-array for the given role-type.
 351      *         Runtime complexity is O(1).
 352      */
 353     QByteArray roleForType(RoleType roleType) const;
 354
 355     QHash<QByteArray, QVariant> retrieveData(const KFileItem& item, const ItemData* parent) const;
 356
 357     /**
 358      * @return True if role values benefit from natural or case insensitive sorting.
 359      */
 360     static bool isRoleValueNatural(const RoleType roleType);
 361
 362     /**
 363      * @return True if \a a has a KFileItem whose text is 'less than' the one
 364      *         of \a b according to QString::operator<(const QString&).
 365      */
 366     static bool nameLessThan(const ItemData* a, const ItemData* b);
 367
 368     /**
 369      * @return True if the item-data \a a should be ordered before the item-data
 370      *         \b. The item-data may have different parent-items.
 371      */
 372     bool lessThan(const ItemData* a, const ItemData* b, const QCollator& collator) const;
 373
 374     /**
 375      * Sorts the items between \a begin and \a end using the comparison
 376      * function lessThan().
 377      */
 378     void sort(const QList<ItemData*>::iterator &begin, const QList<ItemData*>::iterator &end) const;
 379
 380     /**
 381      * Helper method for lessThan() and expandedParentsCountCompare(): Compares
 382      * the passed item-data using m_sortRole as criteria. Both items must
 383      * have the same parent item, otherwise the comparison will be wrong.
 384      */
 385     int sortRoleCompare(const ItemData* a, const ItemData* b, const QCollator& collator) const;
 386
 387     int stringCompare(const QString& a, const QString& b, const QCollator& collator) const;
 388
 389     QList<QPair<int, QVariant> > nameRoleGroups() const;
 390     QList<QPair<int, QVariant> > sizeRoleGroups() const;
 391     QList<QPair<int, QVariant> > timeRoleGroups(const std::function<QDateTime(const ItemData *)> &fileTimeCb) const;
 392     QList<QPair<int, QVariant> > permissionRoleGroups() const;
 393     QList<QPair<int, QVariant> > ratingRoleGroups() const;
 394     QList<QPair<int, QVariant> > genericStringRoleGroups(const QByteArray& typeForRole) const;
 395
 396     /**
 397      * Helper method for all xxxRoleGroups() methods to check whether the
 398      * item with the given index is a child-item. A child-item is defined
 399      * as item having an expansion-level > 0. All xxxRoleGroups() methods
 400      * should skip the grouping if the item is a child-item (although
 401      * KItemListView would be capable to show sub-groups in groups this
 402      * results in visual clutter for most usecases).
 403      */
 404     bool isChildItem(int index) const;
 405
 406     /**
 407      * Is invoked by KFileItemModelRolesUpdater and results in emitting the
 408      * sortProgress signal with a percent-value of the progress.
 409      */
 410     void emitSortProgress(int resolvedCount);
 411
 412     /**
 413      * Applies the filters set through @ref setNameFilter and @ref setMimeTypeFilters.
 414      */
 415     void applyFilters();
 416
 417     /**
 418      * Removes filtered items whose expanded parents have been deleted
 419      * or collapsed via setExpanded(parentIndex, false).
 420      */
 421     void removeFilteredChildren(const KItemRangeList& parents);
 422
 423     /**
 424      * Loads the selected choice of sorting method from Dolphin General Settings
 425      */
 426     void loadSortingSettings();
 427
 428     /**
 429      * Maps the QByteArray-roles to RoleTypes and provides translation- and
 430      * group-contexts.
 431      */
 432     struct RoleInfoMap
 433     {
 434         const char* const role;
 435         const RoleType roleType;
 436         const char* const roleTranslationContext;
 437         const char* const roleTranslation;
 438         const char* const groupTranslationContext;
 439         const char* const groupTranslation;
 440         const bool requiresBaloo;
 441         const bool requiresIndexer;
 442     };
 443
 444     /**
 445      * @return Map of user visible roles that are accessible by KFileItemModel::rolesInformation().
 446      */
 447     static const RoleInfoMap* rolesInfoMap(int& count);
 448
 449     /**
 450      * Determines the MIME-types of all items that can be done within
 451      * the given timeout.
 452      */
 453     static void determineMimeTypes(const KFileItemList& items, int timeout);
 454
 455     /**
 456      * @return Returns a copy of \a value that is implicitly shared
 457      * with other users to save memory.
 458      */
 459     static QByteArray sharedValue(const QByteArray& value);
 460
 461     /**
 462      * Checks if the model's internal data structures are consistent.
 463      */
 464     bool isConsistent() const;
 465
 466 private:
 467     KDirLister *m_dirLister = nullptr;
 468
 469     QCollator m_collator;
 470     bool m_naturalSorting;
 471     bool m_sortDirsFirst;
 472
 473     RoleType m_sortRole;
 474     int m_sortingProgressPercent; // Value of directorySortingProgress() signal
 475     QSet<QByteArray> m_roles;
 476
 477     QList<ItemData*> m_itemData;
 478
 479     // m_items is a cache for the method index(const QUrl&). If it contains N
 480     // entries, it is guaranteed that these correspond to the first N items in
 481     // the model, i.e., that (for every i between 0 and N - 1)
 482     // m_items.value(fileItem(i).url()) == i
 483     mutable QHash<QUrl, int> m_items;
 484
 485     KFileItemModelFilter m_filter;
 486     QHash<KFileItem, ItemData*> m_filteredItems; // Items that got hidden by KFileItemModel::setNameFilter()
 487
 488     bool m_requestRole[RolesCount];
 489
 490     QTimer* m_maximumUpdateIntervalTimer;
 491     QTimer* m_resortAllItemsTimer;
 492     QList<ItemData*> m_pendingItemsToInsert;
 493
 494     // Cache for KFileItemModel::groups()
 495     mutable QList<QPair<int, QVariant> > m_groups;
 496
 497     // Stores the URLs (key: target url, value: url) of the expanded directories.
 498     QHash<QUrl, QUrl> m_expandedDirs;
 499
 500     // URLs that must be expanded. The expanding is initially triggered in setExpanded()
 501     // and done step after step in slotCompleted().
 502     QSet<QUrl> m_urlsToExpand;
 503
 504     friend class KFileItemModelRolesUpdater;   // Accesses emitSortProgress() method
 505     friend class KFileItemModelTest;           // For unit testing
 506     friend class KFileItemModelBenchmark;      // For unit testing
 507     friend class KFileItemListViewTest;        // For unit testing
 508     friend class DolphinPart;                  // Accesses m_dirLister
 509 };
 510
 511 inline bool KFileItemModel::isRoleValueNatural(RoleType roleType)
 512 {
 513     return (roleType == TypeRole ||
 514             roleType == TagsRole ||
 515             roleType == CommentRole ||
 516             roleType == TitleRole ||
 517             roleType == ArtistRole ||
 518             roleType == GenreRole ||
 519             roleType == AlbumRole ||
 520             roleType == PathRole ||
 521             roleType == DestinationRole ||
 522             roleType == OriginUrlRole ||
 523             roleType == OwnerRole ||
 524             roleType == GroupRole);
 525 }
 526
 527 inline bool KFileItemModel::nameLessThan(const ItemData* a, const ItemData* b)
 528 {
 529     return a->item.text() < b->item.text();
 530 }
 531
 532 inline bool KFileItemModel::isChildItem(int index) const
 533 {
 534     if (m_itemData.at(index)->parent) {
 535         return true;
 536     } else {
 537         return false;
 538     }
 539 }
 540
 541 #endif
 542
 543