]> cloud.milkyroute.net Git - dolphin.git/blobdiff - src/views/viewproperties.cpp
Clean obsolete ifdefs since dolphin requires KF 5.101+
[dolphin.git] / src / views / viewproperties.cpp
index bcea0625348213eaa065a4c123e57a7a3616c17b..f42adbce7aa7a2004f185b3fe31642d2993a6fdd 100644 (file)
@@ -1,91 +1,96 @@
-/***************************************************************************
- *   Copyright (C) 2006-2010 by Peter Penz <peter.penz19@gmail.com>        *
- *   Copyright (C) 2006 by Aaron J. Seigo <aseigo@kde.org>                 *
- *                                                                         *
- *   This program is free software; you can redistribute it and/or modify  *
- *   it under the terms of the GNU General Public License as published by  *
- *   the Free Software Foundation; either version 2 of the License, or     *
- *   (at your option) any later version.                                   *
- *                                                                         *
- *   This program is distributed in the hope that it will be useful,       *
- *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
- *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
- *   GNU General Public License for more details.                          *
- *                                                                         *
- *   You should have received a copy of the GNU General Public License     *
- *   along with this program; if not, write to the                         *
- *   Free Software Foundation, Inc.,                                       *
- *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
- ***************************************************************************/
+/*
+ * SPDX-FileCopyrightText: 2006-2010 Peter Penz <peter.penz19@gmail.com>
+ * SPDX-FileCopyrightText: 2006 Aaron J. Seigo <aseigo@kde.org>
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
 
 #include "viewproperties.h"
 
 #include "dolphin_directoryviewpropertysettings.h"
 #include "dolphin_generalsettings.h"
-
-#include <KComponentData>
-#include <KLocale>
-#include <KStandardDirs>
-#include <KUrl>
-#include <KDebug>
-#include <KGlobal>
+#include "dolphindebug.h"
 
 #include <QCryptographicHash>
-#include <QDate>
-#include <QFile>
-#include <QFileInfo>
 
-namespace {
-    const int AdditionalInfoViewPropertiesVersion = 1;
-    const int NameRolePropertiesVersion = 2;
-    const int CurrentViewPropertiesVersion = 3;
+#include <KFileItem>
+
+namespace
+{
+const int AdditionalInfoViewPropertiesVersion = 1;
+const int NameRolePropertiesVersion = 2;
+const int DateRolePropertiesVersion = 4;
+const int CurrentViewPropertiesVersion = 4;
 
-    // String representation to mark the additional properties of
-    // the details view as customized by the user. See
-    // ViewProperties::visibleRoles() for more information.
-    const char* CustomizedDetailsString = "CustomizedDetails";
+// String representation to mark the additional properties of
+// the details view as customized by the user. See
+// ViewProperties::visibleRoles() for more information.
+const char CustomizedDetailsString[] = "CustomizedDetails";
 
-    // Filename that is used for storing the properties
-    const char* ViewPropertiesFileName = ".directory";
+// Filename that is used for storing the properties
+const char ViewPropertiesFileName[] = ".directory";
 }
 
-ViewProperties::ViewProperties(const KUrl& url) :
-    m_changedProps(false),
-    m_autoSave(true),
-    m_node(0)
+ViewProperties::ViewProperties(const QUrl &url)
+    : m_changedProps(false)
+    , m_autoSave(true)
+    , m_node(nullptr)
 {
-    GeneralSettingssettings = GeneralSettings::self();
+    GeneralSettings *settings = GeneralSettings::self();
     const bool useGlobalViewProps = settings->globalViewProps() || url.isEmpty();
-    bool useDetailsViewWithPath = false;
+    bool useSearchView = false;
+    bool useTrashView = false;
+    bool useRecentDocumentsView = false;
+    bool useDownloadsView = false;
 
     // We try and save it to the file .directory in the directory being viewed.
     // If the directory is not writable by the user or the directory is not local,
     // we store the properties information in a local file.
     if (useGlobalViewProps) {
-        m_filePath = destinationDir("global");
-    } else if (url.protocol().contains("search")) {
-        m_filePath = destinationDir("search/") + directoryHashForUrl(url);
-        useDetailsViewWithPath = true;
-    } else if (url.protocol() == QLatin1String("trash")) {
-        m_filePath = destinationDir("trash");
-        useDetailsViewWithPath = true;
+        m_filePath = destinationDir(QStringLiteral("global"));
+    } else if (url.scheme().contains(QLatin1String("search"))) {
+        m_filePath = destinationDir(QStringLiteral("search/")) + directoryHashForUrl(url);
+        useSearchView = true;
+    } else if (url.scheme() == QLatin1String("trash")) {
+        m_filePath = destinationDir(QStringLiteral("trash"));
+        useTrashView = true;
+    } else if (url.scheme() == QLatin1String("recentdocuments")) {
+        m_filePath = destinationDir(QStringLiteral("recentdocuments"));
+        useRecentDocumentsView = true;
+    } else if (url.scheme() == QLatin1String("recentlyused")) {
+        m_filePath = destinationDir(QStringLiteral("recentlyused"));
+        useRecentDocumentsView = true;
+    } else if (url.scheme() == QLatin1String("timeline")) {
+        m_filePath = destinationDir(QStringLiteral("timeline"));
+        useRecentDocumentsView = true;
     } else if (url.isLocalFile()) {
         m_filePath = url.toLocalFile();
-        const QFileInfo dirInfo(m_filePath);
-        const QFileInfo fileInfo(m_filePath + QDir::separator() + ViewPropertiesFileName);
-        // Check if the directory is writable and check if the ".directory" file exists and
-        // is read- and writable.
-        if (!dirInfo.isWritable()
-                || (fileInfo.exists() && !(fileInfo.isReadable() && fileInfo.isWritable()))
-                || !isPartOfHome(m_filePath)) {
+
+        bool useDestinationDir = !isPartOfHome(m_filePath);
+        if (!useDestinationDir) {
+            const KFileItem fileItem(url);
+            useDestinationDir = fileItem.isSlow();
+        }
+
+        if (!useDestinationDir) {
+            const QFileInfo dirInfo(m_filePath);
+            const QFileInfo fileInfo(m_filePath + QDir::separator() + ViewPropertiesFileName);
+            useDestinationDir = !dirInfo.isWritable() || (dirInfo.size() > 0 && fileInfo.exists() && !(fileInfo.isReadable() && fileInfo.isWritable()));
+        }
+
+        if (useDestinationDir) {
 #ifdef Q_OS_WIN
-                       // m_filePath probably begins with C:/ - the colon is not a valid character for paths though
-                       m_filePath =  QDir::separator() + m_filePath.remove(QLatin1Char(':'));
+            // m_filePath probably begins with C:/ - the colon is not a valid character for paths though
+            m_filePath = QDir::separator() + m_filePath.remove(QLatin1Char(':'));
 #endif
-            m_filePath = destinationDir("local") + m_filePath;
+            m_filePath = destinationDir(QStringLiteral("local")) + m_filePath;
+        }
+
+        if (m_filePath == QStandardPaths::writableLocation(QStandardPaths::DownloadLocation)) {
+            useDownloadsView = true;
         }
     } else {
-        m_filePath = destinationDir("remote") + m_filePath;
+        m_filePath = destinationDir(QStringLiteral("remote")) + m_filePath;
     }
 
     const QString file = m_filePath + QDir::separator() + ViewPropertiesFileName;
@@ -93,19 +98,46 @@ ViewProperties::ViewProperties(const KUrl& url) :
 
     // If the .directory file does not exist or the timestamp is too old,
     // use default values instead.
-    const bool useDefaultProps = (!useGlobalViewProps || useDetailsViewWithPath) &&
-                                 (!QFile::exists(file) ||
-                                  (m_node->timestamp() < settings->viewPropsTimestamp()));
+    const bool useDefaultProps = (!useGlobalViewProps || useSearchView || useTrashView || useRecentDocumentsView || useDownloadsView)
+        && (!QFile::exists(file) || (m_node->timestamp() < settings->viewPropsTimestamp()));
     if (useDefaultProps) {
-        if (useDetailsViewWithPath) {
+        if (useSearchView) {
+            const QString path = url.path();
+
+            if (path == QLatin1String("/images")) {
+                setViewMode(DolphinView::IconsView);
+                setPreviewsShown(true);
+                setVisibleRoles({"text", "dimensions", "imageDateTime"});
+            } else if (path == QLatin1String("/audio")) {
+                setViewMode(DolphinView::DetailsView);
+                setVisibleRoles({"text", "artist", "album", "duration"});
+            } else if (path == QLatin1String("/videos")) {
+                setViewMode(DolphinView::IconsView);
+                setPreviewsShown(true);
+                setVisibleRoles({"text"});
+            } else {
+                setViewMode(DolphinView::DetailsView);
+                setVisibleRoles({"text", "path", "modificationtime"});
+            }
+        } else if (useTrashView) {
             setViewMode(DolphinView::DetailsView);
-            setVisibleRoles(QList<QByteArray>() << "path");
+            setVisibleRoles({"text", "path", "deletiontime"});
+        } else if (useRecentDocumentsView || useDownloadsView) {
+            setSortRole(QByteArrayLiteral("modificationtime"));
+            setSortOrder(Qt::DescendingOrder);
+            setSortFoldersFirst(false);
+            setGroupedSorting(true);
+
+            if (useRecentDocumentsView) {
+                setViewMode(DolphinView::DetailsView);
+                setVisibleRoles({"text", "path", "modificationtime"});
+            }
         } else {
             // The global view-properties act as default for directories without
-            // any view-property configuration. Constructing a ViewProperties 
-            // instance for an empty KUrl ensures that the global view-properties
+            // any view-property configuration. Constructing a ViewProperties
+            // instance for an empty QUrl ensures that the global view-properties
             // are loaded.
-            KUrl emptyUrl;
+            QUrl emptyUrl;
             ViewProperties defaultProps(emptyUrl);
             setDirProperties(defaultProps);
 
@@ -126,6 +158,11 @@ ViewProperties::ViewProperties(const KUrl& url) :
             Q_ASSERT(m_node->version() == NameRolePropertiesVersion);
         }
 
+        if (m_node->version() < DateRolePropertiesVersion) {
+            convertDateRoleToModificationTimeRole();
+            Q_ASSERT(m_node->version() == DateRolePropertiesVersion);
+        }
+
         m_node->setVersion(CurrentViewPropertiesVersion);
     }
 }
@@ -137,7 +174,7 @@ ViewProperties::~ViewProperties()
     }
 
     delete m_node;
-    m_node = 0;
+    m_node = nullptr;
 }
 
 void ViewProperties::setViewMode(DolphinView::Mode mode)
@@ -193,7 +230,7 @@ bool ViewProperties::hiddenFilesShown() const
     return m_node->hiddenFilesShown();
 }
 
-void ViewProperties::setSortRole(const QByteArrayrole)
+void ViewProperties::setSortRole(const QByteArray &role)
 {
     if (m_node->sortRole() != role) {
         m_node->setSortRole(role);
@@ -232,7 +269,20 @@ bool ViewProperties::sortFoldersFirst() const
     return m_node->sortFoldersFirst();
 }
 
-void ViewProperties::setVisibleRoles(const QList<QByteArray>& roles)
+void ViewProperties::setSortHiddenLast(bool hiddenLast)
+{
+    if (m_node->sortHiddenLast() != hiddenLast) {
+        m_node->setSortHiddenLast(hiddenLast);
+        update();
+    }
+}
+
+bool ViewProperties::sortHiddenLast() const
+{
+    return m_node->sortHiddenLast();
+}
+
+void ViewProperties::setVisibleRoles(const QList<QByteArray> &roles)
 {
     if (roles == visibleRoles()) {
         return;
@@ -252,13 +302,13 @@ void ViewProperties::setVisibleRoles(const QList<QByteArray>& roles)
     }
 
     // Add the updated values for the current view-mode
-    foreach (const QByteArray& role, roles) {
+    newVisibleRoles.reserve(roles.count());
+    for (const QByteArray &role : roles) {
         newVisibleRoles.append(prefix + role);
     }
 
     if (oldVisibleRoles != newVisibleRoles) {
-        const bool markCustomizedDetails = (m_node->viewMode() == DolphinView::DetailsView)
-                                           && !newVisibleRoles.contains(CustomizedDetailsString);
+        const bool markCustomizedDetails = (m_node->viewMode() == DolphinView::DetailsView) && !newVisibleRoles.contains(CustomizedDetailsString);
         if (markCustomizedDetails) {
             // The additional information of the details-view has been modified. Set a marker,
             // so that it is allowed to also show no additional information without doing the
@@ -283,12 +333,11 @@ QList<QByteArray> ViewProperties::visibleRoles() const
     //
     // For the details-view a special case must be respected: Per default the size
     // and date should be shown without creating a .directory file. Only if
-    // the user explictly has modified the properties of the details view (marked
+    // the user explicitly has modified the properties of the details view (marked
     // by "CustomizedDetails"), also a details-view with no additional information
     // is accepted.
 
-    QList<QByteArray> roles;
-    roles.append("text");
+    QList<QByteArray> roles{"text"};
 
     // Iterate through all stored keys and append all roles that match to
     // the current view mode.
@@ -296,7 +345,7 @@ QList<QByteArray> ViewProperties::visibleRoles() const
     const int prefixLength = prefix.length();
 
     const QStringList visibleRoles = m_node->visibleRoles();
-    foreach (const QString& visibleRole, visibleRoles) {
+    for (const QString &visibleRole : visibleRoles) {
         if (visibleRole.startsWith(prefix)) {
             const QByteArray role = visibleRole.right(visibleRole.length() - prefixLength).toLatin1();
             if (role != "text") {
@@ -308,17 +357,16 @@ QList<QByteArray> ViewProperties::visibleRoles() const
     // For the details view the size and date should be shown per default
     // until the additional information has been explicitly changed by the user
     const bool useDefaultValues = roles.count() == 1 // "text"
-                                  && (m_node->viewMode() == DolphinView::DetailsView)
-                                  && !visibleRoles.contains(CustomizedDetailsString);
+        && (m_node->viewMode() == DolphinView::DetailsView) && !visibleRoles.contains(CustomizedDetailsString);
     if (useDefaultValues) {
         roles.append("size");
-        roles.append("date");
+        roles.append("modificationtime");
     }
 
     return roles;
 }
 
-void ViewProperties::setHeaderColumnWidths(const QList<int>widths)
+void ViewProperties::setHeaderColumnWidths(const QList<int> &widths)
 {
     if (m_node->headerColumnWidths() != widths) {
         m_node->setHeaderColumnWidths(widths);
@@ -331,7 +379,7 @@ QList<int> ViewProperties::headerColumnWidths() const
     return m_node->headerColumnWidths();
 }
 
-void ViewProperties::setDirProperties(const ViewPropertiesprops)
+void ViewProperties::setDirProperties(const ViewProperties &props)
 {
     setViewMode(props.viewMode());
     setPreviewsShown(props.previewsShown());
@@ -340,6 +388,7 @@ void ViewProperties::setDirProperties(const ViewProperties& props)
     setSortRole(props.sortRole());
     setSortOrder(props.sortOrder());
     setSortFoldersFirst(props.sortFoldersFirst());
+    setSortHiddenLast(props.sortHiddenLast());
     setVisibleRoles(props.visibleRoles());
     setHeaderColumnWidths(props.headerColumnWidths());
     m_node->setVersion(props.m_node->version());
@@ -363,10 +412,11 @@ void ViewProperties::update()
 
 void ViewProperties::save()
 {
-    kDebug() << "Saving view-properties to" << m_filePath;
-    KStandardDirs::makeDir(m_filePath);
+    qCDebug(DolphinDebug) << "Saving view-properties to" << m_filePath;
+    QDir dir;
+    dir.mkpath(m_filePath);
     m_node->setVersion(CurrentViewPropertiesVersion);
-    m_node->writeConfig();
+    m_node->save();
     m_changedProps = false;
 }
 
@@ -376,11 +426,11 @@ bool ViewProperties::exist() const
     return QFile::exists(file);
 }
 
-QString ViewProperties::destinationDir(const QStringsubDir) const
+QString ViewProperties::destinationDir(const QString &subDir) const
 {
-    QString basePath = KGlobal::mainComponent().componentName();
-    basePath.append("/view_properties/").append(subDir);
-    return KStandardDirs::locateLocal("data", basePath);
+    QString path = QStandardPaths::writableLocation(QStandardPaths::AppDataLocation);
+    path.append("/view_properties/").append(subDir);
+    return path;
 }
 
 QString ViewProperties::viewModePrefix() const
@@ -388,10 +438,17 @@ QString ViewProperties::viewModePrefix() const
     QString prefix;
 
     switch (m_node->viewMode()) {
-    case DolphinView::IconsView:   prefix = "Icons_"; break;
-    case DolphinView::CompactView: prefix = "Compact_"; break;
-    case DolphinView::DetailsView: prefix = "Details_"; break;
-    default: kWarning() << "Unknown view-mode of the view properties";
+    case DolphinView::IconsView:
+        prefix = QStringLiteral("Icons_");
+        break;
+    case DolphinView::CompactView:
+        prefix = QStringLiteral("Compact_");
+        break;
+    case DolphinView::DetailsView:
+        prefix = QStringLiteral("Details_");
+        break;
+    default:
+        qCWarning(DolphinDebug) << "Unknown view-mode of the view properties";
     }
 
     return prefix;
@@ -399,7 +456,7 @@ QString ViewProperties::viewModePrefix() const
 
 void ViewProperties::convertAdditionalInfo()
 {
-    QStringList visibleRoles;
+    QStringList visibleRoles = m_node->visibleRoles();
 
     const QStringList additionalInfo = m_node->additionalInfo();
     if (!additionalInfo.isEmpty()) {
@@ -407,19 +464,21 @@ void ViewProperties::convertAdditionalInfo()
         // to Icons_size, Details_date, ... where the suffix just represents
         // the internal role. One special-case must be handled: "LinkDestination"
         // has been used for "destination".
-        visibleRoles.reserve(additionalInfo.count());
-        foreach (const QString& info, additionalInfo) {
+        visibleRoles.reserve(visibleRoles.count() + additionalInfo.count());
+        for (const QString &info : additionalInfo) {
             QString visibleRole = info;
             int index = visibleRole.indexOf('_');
             if (index >= 0 && index + 1 < visibleRole.length()) {
                 ++index;
                 if (visibleRole[index] == QLatin1Char('L')) {
-                    visibleRole.replace("LinkDestination", "destination");
+                    visibleRole.replace(QLatin1String("LinkDestination"), QLatin1String("destination"));
                 } else {
                     visibleRole[index] = visibleRole[index].toLower();
                 }
             }
-            visibleRoles.append(visibleRole);
+            if (!visibleRoles.contains(visibleRole)) {
+                visibleRoles.append(visibleRole);
+            }
         }
     }
 
@@ -441,7 +500,7 @@ void ViewProperties::convertNameRoleToTextRole()
 
     QString sortRole = m_node->sortRole();
     if (sortRole == QLatin1String("name")) {
-        sortRole = QLatin1String("text");
+        sortRole = QStringLiteral("text");
     }
 
     m_node->setVisibleRoles(visibleRoles);
@@ -450,7 +509,28 @@ void ViewProperties::convertNameRoleToTextRole()
     update();
 }
 
-bool ViewProperties::isPartOfHome(const QString& filePath)
+void ViewProperties::convertDateRoleToModificationTimeRole()
+{
+    QStringList visibleRoles = m_node->visibleRoles();
+    for (int i = 0; i < visibleRoles.count(); ++i) {
+        if (visibleRoles[i].endsWith(QLatin1String("_date"))) {
+            const int leftLength = visibleRoles[i].length() - 5;
+            visibleRoles[i] = visibleRoles[i].left(leftLength) + "_modificationtime";
+        }
+    }
+
+    QString sortRole = m_node->sortRole();
+    if (sortRole == QLatin1String("date")) {
+        sortRole = QStringLiteral("modificationtime");
+    }
+
+    m_node->setVisibleRoles(visibleRoles);
+    m_node->setSortRole(sortRole);
+    m_node->setVersion(DateRolePropertiesVersion);
+    update();
+}
+
+bool ViewProperties::isPartOfHome(const QString &filePath)
 {
     // For performance reasons cache the path in a static QString
     // (see QDir::homePath() for more details)
@@ -463,18 +543,10 @@ bool ViewProperties::isPartOfHome(const QString& filePath)
     return filePath.startsWith(homePath);
 }
 
-QString ViewProperties::directoryHashForUrl(const KUrl& url)
+QString ViewProperties::directoryHashForUrl(const QUrl &url)
 {
-    const QByteArray hashValue = QCryptographicHash::hash(url.prettyUrl().toLatin1(),
-                                                     QCryptographicHash::Sha1);
+    const QByteArray hashValue = QCryptographicHash::hash(url.toEncoded(), QCryptographicHash::Sha1);
     QString hashString = hashValue.toBase64();
     hashString.replace('/', '-');
     return hashString;
 }
-
-KUrl ViewProperties::mirroredDirectory()
-{
-    QString basePath = KGlobal::mainComponent().componentName();
-    basePath.append("/view_properties/");
-    return KUrl(KStandardDirs::locateLocal("data", basePath));
-}