X-Git-Url: https://cloud.milkyroute.net/gitweb/dolphin.git/blobdiff_plain/f23e9496f303995557b744c03178f5dbd9b35016..b2b913c84423313c39227050d886376650c48cf3:/src/views/viewproperties.cpp

diff --git a/src/views/viewproperties.cpp b/src/views/viewproperties.cpp
index aeea67428..eddc7225d 100644
--- a/src/views/viewproperties.cpp
+++ b/src/views/viewproperties.cpp
@@ -20,82 +20,133 @@
 
 #include "viewproperties.h"
 
-#include "additionalinfoaccessor.h"
 #include "dolphin_directoryviewpropertysettings.h"
 #include "dolphin_generalsettings.h"
+#include "dolphindebug.h"
 
-#include <KComponentData>
-#include <KLocale>
-#include <KStandardDirs>
-#include <KUrl>
-
-#include <QDate>
-#include <QFile>
-#include <QFileInfo>
-
-#include "settings/dolphinsettings.h"
+#include <QCryptographicHash>
 
 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::additionalInfoList() for more information.
-    const char* CustomizedDetailsString = "CustomizedDetails";
+    // ViewProperties::visibleRoles() for more information.
+    const char CustomizedDetailsString[] = "CustomizedDetails";
+
+    // Filename that is used for storing the properties
+    const char ViewPropertiesFileName[] = ".directory";
 }
 
-ViewProperties::ViewProperties(const KUrl& url) :
+ViewProperties::ViewProperties(const QUrl& url) :
     m_changedProps(false),
     m_autoSave(true),
-    m_node(0)
+    m_node(nullptr)
 {
-    GeneralSettings* settings = DolphinSettings::instance().generalSettings();
-    const bool useGlobalViewProps = settings->globalViewProps();
+    GeneralSettings* settings = GeneralSettings::self();
+    const bool useGlobalViewProps = settings->globalViewProps() || url.isEmpty();
     bool useDetailsViewWithPath = 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");
+        m_filePath = destinationDir(QStringLiteral("global"));
+    } else if (url.scheme().contains(QStringLiteral("search"))) {
+        m_filePath = destinationDir(QStringLiteral("search/")) + directoryHashForUrl(url);
         useDetailsViewWithPath = true;
-    } else if (url.protocol() == QLatin1String("trash")) {
-        m_filePath = destinationDir("trash");
+    } else if (url.scheme() == QLatin1String("trash")) {
+        m_filePath = destinationDir(QStringLiteral("trash"));
         useDetailsViewWithPath = true;
+    } else if (url.scheme() == QLatin1String("recentdocuments")) {
+        m_filePath = destinationDir(QStringLiteral("recentdocuments"));
+        useRecentDocumentsView = true;
     } else if (url.isLocalFile()) {
         m_filePath = url.toLocalFile();
-        const QFileInfo info(m_filePath);
-        if (!info.isWritable() || !isPartOfHome(m_filePath)) {
-            m_filePath = destinationDir("local") + m_filePath;
+
+        bool useDestinationDir = !isPartOfHome(m_filePath);
+        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(':'));
+    #endif
+            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() + QLatin1String(".directory");
+    const QString file = m_filePath + QDir::separator() + ViewPropertiesFileName;
     m_node = new ViewPropertySettings(KSharedConfig::openConfig(file));
 
     // If the .directory file does not exist or the timestamp is too old,
     // use default values instead.
     const bool useDefaultProps = (!useGlobalViewProps || useDetailsViewWithPath) &&
-                                 (!QFileInfo(file).exists() ||
+                                 (!QFile::exists(file) ||
                                   (m_node->timestamp() < settings->viewPropsTimestamp()));
     if (useDefaultProps) {
         if (useDetailsViewWithPath) {
             setViewMode(DolphinView::DetailsView);
-            setAdditionalInfoList(QList<DolphinView::AdditionalInfo>() << DolphinView::PathInfo);
+            setVisibleRoles({"path"});
+        } else if (useRecentDocumentsView || useDownloadsView) {
+            setSortRole(QByteArrayLiteral("modificationtime"));
+            setSortOrder(Qt::DescendingOrder);
+
+            if (useRecentDocumentsView) {
+                setViewMode(DolphinView::DetailsView);
+                setVisibleRoles({QByteArrayLiteral("path")});
+            } else if (useDownloadsView) {
+                setSortFoldersFirst(false);
+                setGroupedSorting(true);
+            }
         } else {
             // The global view-properties act as default for directories without
-            // any view-property configuration
-            settings->setGlobalViewProps(true);
-
-            ViewProperties defaultProps(url);
+            // any view-property configuration. Constructing a ViewProperties 
+            // instance for an empty QUrl ensures that the global view-properties
+            // are loaded.
+            QUrl emptyUrl;
+            ViewProperties defaultProps(emptyUrl);
             setDirProperties(defaultProps);
 
-            settings->setGlobalViewProps(false);
             m_changedProps = false;
         }
     }
+
+    if (m_node->version() < CurrentViewPropertiesVersion) {
+        // The view-properties have an outdated version. Convert the properties
+        // to the changes of the current version.
+        if (m_node->version() < AdditionalInfoViewPropertiesVersion) {
+            convertAdditionalInfo();
+            Q_ASSERT(m_node->version() == AdditionalInfoViewPropertiesVersion);
+        }
+
+        if (m_node->version() < NameRolePropertiesVersion) {
+            convertNameRoleToTextRole();
+            Q_ASSERT(m_node->version() == NameRolePropertiesVersion);
+        }
+
+        if (m_node->version() < DateRolePropertiesVersion) {
+            convertDateRoleToModificationTimeRole();
+            Q_ASSERT(m_node->version() == DateRolePropertiesVersion);
+        }
+
+        m_node->setVersion(CurrentViewPropertiesVersion);
+    }
 }
 
 ViewProperties::~ViewProperties()
@@ -105,7 +156,7 @@ ViewProperties::~ViewProperties()
     }
 
     delete m_node;
-    m_node = 0;
+    m_node = nullptr;
 }
 
 void ViewProperties::setViewMode(DolphinView::Mode mode)
@@ -118,7 +169,8 @@ void ViewProperties::setViewMode(DolphinView::Mode mode)
 
 DolphinView::Mode ViewProperties::viewMode() const
 {
-    return static_cast<DolphinView::Mode>(m_node->viewMode());
+    const int mode = qBound(0, m_node->viewMode(), 2);
+    return static_cast<DolphinView::Mode>(mode);
 }
 
 void ViewProperties::setPreviewsShown(bool show)
@@ -142,17 +194,17 @@ void ViewProperties::setHiddenFilesShown(bool show)
     }
 }
 
-void ViewProperties::setCategorizedSorting(bool categorized)
+void ViewProperties::setGroupedSorting(bool grouped)
 {
-    if (m_node->categorizedSorting() != categorized) {
-        m_node->setCategorizedSorting(categorized);
+    if (m_node->groupedSorting() != grouped) {
+        m_node->setGroupedSorting(grouped);
         update();
     }
 }
 
-bool ViewProperties::categorizedSorting() const
+bool ViewProperties::groupedSorting() const
 {
-    return m_node->categorizedSorting();
+    return m_node->groupedSorting();
 }
 
 bool ViewProperties::hiddenFilesShown() const
@@ -160,17 +212,17 @@ bool ViewProperties::hiddenFilesShown() const
     return m_node->hiddenFilesShown();
 }
 
-void ViewProperties::setSorting(DolphinView::Sorting sorting)
+void ViewProperties::setSortRole(const QByteArray& role)
 {
-    if (m_node->sorting() != sorting) {
-        m_node->setSorting(sorting);
+    if (m_node->sortRole() != role) {
+        m_node->setSortRole(role);
         update();
     }
 }
 
-DolphinView::Sorting ViewProperties::sorting() const
+QByteArray ViewProperties::sortRole() const
 {
-    return static_cast<DolphinView::Sorting>(m_node->sorting());
+    return m_node->sortRole().toLatin1();
 }
 
 void ViewProperties::setSortOrder(Qt::SortOrder sortOrder)
@@ -199,111 +251,103 @@ bool ViewProperties::sortFoldersFirst() const
     return m_node->sortFoldersFirst();
 }
 
-void ViewProperties::setAdditionalInfoList(const QList<DolphinView::AdditionalInfo>& list)
+void ViewProperties::setVisibleRoles(const QList<QByteArray>& roles)
 {
-    // See ViewProperties::additionalInfoList() for the storage format
+    if (roles == visibleRoles()) {
+        return;
+    }
+
+    // See ViewProperties::visibleRoles() for the storage format
     // of the additional information.
 
     // Remove the old values stored for the current view-mode
-    const QStringList oldInfoStringList = m_node->additionalInfo();
+    const QStringList oldVisibleRoles = m_node->visibleRoles();
     const QString prefix = viewModePrefix();
-    QStringList newInfoStringList = oldInfoStringList;
-    for (int i = newInfoStringList.count() - 1; i >= 0; --i) {
-        if (newInfoStringList.at(i).startsWith(prefix)) {
-            newInfoStringList.removeAt(i);
+    QStringList newVisibleRoles = oldVisibleRoles;
+    for (int i = newVisibleRoles.count() - 1; i >= 0; --i) {
+        if (newVisibleRoles[i].startsWith(prefix)) {
+            newVisibleRoles.removeAt(i);
         }
     }
 
     // Add the updated values for the current view-mode
-    AdditionalInfoAccessor& infoAccessor = AdditionalInfoAccessor::instance();
-    foreach (DolphinView::AdditionalInfo info, list) {
-        newInfoStringList.append(prefix + infoAccessor.value(info));
-    }
-
-    // Only update the information if it has been changed
-    bool changed = oldInfoStringList.count() != newInfoStringList.count();
-    if (!changed) {
-        foreach (const QString& oldInfoString, oldInfoStringList) {
-            if (!newInfoStringList.contains(oldInfoString)) {
-                changed = true;
-                break;
-            }
-        }
+    newVisibleRoles.reserve(roles.count());
+    foreach (const QByteArray& role, roles) {
+        newVisibleRoles.append(prefix + role);
     }
 
-    if (changed) {
+    if (oldVisibleRoles != newVisibleRoles) {
         const bool markCustomizedDetails = (m_node->viewMode() == DolphinView::DetailsView)
-                                           && !newInfoStringList.contains(CustomizedDetailsString);
+                                           && !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
-            // (see fallback in ViewProperties::additionalInfoV2, if no additional information is
-            // available).
-            newInfoStringList.append(CustomizedDetailsString);
+            // so that it is allowed to also show no additional information without doing the
+            // fallback to show the size and date per default.
+            newVisibleRoles.append(CustomizedDetailsString);
         }
 
-        m_node->setAdditionalInfo(newInfoStringList);
+        m_node->setVisibleRoles(newVisibleRoles);
         update();
     }
 }
 
-QList<DolphinView::AdditionalInfo> ViewProperties::additionalInfoList() const
+QList<QByteArray> ViewProperties::visibleRoles() const
 {
     // The shown additional information is stored for each view-mode separately as
     // string with the view-mode as prefix. Example:
     //
-    // AdditionalInfo=Details_Size,Details_Date,Details_Owner,Icon_Size
+    // AdditionalInfo=Details_size,Details_date,Details_owner,Icons_size
     //
-    // To get the representation as QList<DolphinView::AdditionalInfo>, the current
+    // To get the representation as QList<QByteArray>, the current
     // view-mode must be checked and the values of this mode added to the list.
     //
     // 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<DolphinView::AdditionalInfo> usedInfo;
-
-    // infoHash allows to get the mapped DolphinView::AdditionalInfo value
-    // for a stored string-value in a fast way
-    static QHash<QString, DolphinView::AdditionalInfo> infoHash;
-    if (infoHash.isEmpty()) {
-        AdditionalInfoAccessor& infoAccessor = AdditionalInfoAccessor::instance();
-        const QList<DolphinView::AdditionalInfo> keys = infoAccessor.keys();
-        foreach (DolphinView::AdditionalInfo key, keys) {
-            infoHash.insert(infoAccessor.value(key), key);
-        }
-    }
+    QList<QByteArray> roles{"text"};
 
-    // Iterate through all stored keys stored as strings and map them to
-    // the corresponding DolphinView::AdditionalInfo values.
+    // Iterate through all stored keys and append all roles that match to
+    // the current view mode.
     const QString prefix = viewModePrefix();
     const int prefixLength = prefix.length();
-    const QStringList infoStringList = m_node->additionalInfo();
-    foreach (const QString& infoString, infoStringList) {
-        if (infoString.startsWith(prefix)) {
-            const QString key = infoString.right(infoString.length() - prefixLength);
-            if (infoHash.contains(key)) {
-                usedInfo.append(infoHash.value(key));
-            } else {
-                kWarning() << "Did not find the key" << key << "in the information string";
+
+    const QStringList visibleRoles = m_node->visibleRoles();
+    foreach (const QString& visibleRole, visibleRoles) {
+        if (visibleRole.startsWith(prefix)) {
+            const QByteArray role = visibleRole.right(visibleRole.length() - prefixLength).toLatin1();
+            if (role != "text") {
+                roles.append(role);
             }
         }
     }
 
     // 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 = usedInfo.isEmpty()
+    const bool useDefaultValues = roles.count() == 1 // "text"
                                   && (m_node->viewMode() == DolphinView::DetailsView)
-                                  && !infoStringList.contains(CustomizedDetailsString);
-    Q_UNUSED(useDefaultValues);
+                                  && !visibleRoles.contains(CustomizedDetailsString);
     if (useDefaultValues) {
-        usedInfo.append(DolphinView::SizeInfo);
-        usedInfo.append(DolphinView::DateInfo);
+        roles.append("size");
+        roles.append("modificationtime");
     }
 
-    return usedInfo;
+    return roles;
+}
+
+void ViewProperties::setHeaderColumnWidths(const QList<int>& widths)
+{
+    if (m_node->headerColumnWidths() != widths) {
+        m_node->setHeaderColumnWidths(widths);
+        update();
+    }
+}
+
+QList<int> ViewProperties::headerColumnWidths() const
+{
+    return m_node->headerColumnWidths();
 }
 
 void ViewProperties::setDirProperties(const ViewProperties& props)
@@ -311,11 +355,13 @@ void ViewProperties::setDirProperties(const ViewProperties& props)
     setViewMode(props.viewMode());
     setPreviewsShown(props.previewsShown());
     setHiddenFilesShown(props.hiddenFilesShown());
-    setCategorizedSorting(props.categorizedSorting());
-    setSorting(props.sorting());
+    setGroupedSorting(props.groupedSorting());
+    setSortRole(props.sortRole());
     setSortOrder(props.sortOrder());
     setSortFoldersFirst(props.sortFoldersFirst());
-    setAdditionalInfoList(props.additionalInfoList());
+    setVisibleRoles(props.visibleRoles());
+    setHeaderColumnWidths(props.headerColumnWidths());
+    m_node->setVersion(props.m_node->version());
 }
 
 void ViewProperties::setAutoSaveEnabled(bool autoSave)
@@ -336,23 +382,25 @@ void ViewProperties::update()
 
 void ViewProperties::save()
 {
-    KStandardDirs::makeDir(m_filePath);
-    m_node->writeConfig();
+    qCDebug(DolphinDebug) << "Saving view-properties to" << m_filePath;
+    QDir dir;
+    dir.mkpath(m_filePath);
+    m_node->setVersion(CurrentViewPropertiesVersion);
+    m_node->save();
     m_changedProps = false;
 }
 
-KUrl ViewProperties::mirroredDirectory()
+bool ViewProperties::exist() const
 {
-    QString basePath = KGlobal::mainComponent().componentName();
-    basePath.append("/view_properties/");
-    return KUrl(KStandardDirs::locateLocal("data", basePath));
+    const QString file = m_filePath + QDir::separator() + ViewPropertiesFileName;
+    return QFile::exists(file);
 }
 
 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::DataLocation);
+    path.append("/view_properties/").append(subDir);
+    return path;
 }
 
 QString ViewProperties::viewModePrefix() const
@@ -360,15 +408,89 @@ 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;
 }
 
+void ViewProperties::convertAdditionalInfo()
+{
+    QStringList visibleRoles;
+
+    const QStringList additionalInfo = m_node->additionalInfo();
+    if (!additionalInfo.isEmpty()) {
+        // Convert the obsolete values like Icons_Size, Details_Date, ...
+        // 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) {
+            QString visibleRole = info;
+            int index = visibleRole.indexOf('_');
+            if (index >= 0 && index + 1 < visibleRole.length()) {
+                ++index;
+                if (visibleRole[index] == QLatin1Char('L')) {
+                    visibleRole.replace(QLatin1String("LinkDestination"), QLatin1String("destination"));
+                } else {
+                    visibleRole[index] = visibleRole[index].toLower();
+                }
+            }
+            visibleRoles.append(visibleRole);
+        }
+    }
+
+    m_node->setAdditionalInfo(QStringList());
+    m_node->setVisibleRoles(visibleRoles);
+    m_node->setVersion(AdditionalInfoViewPropertiesVersion);
+    update();
+}
+
+void ViewProperties::convertNameRoleToTextRole()
+{
+    QStringList visibleRoles = m_node->visibleRoles();
+    for (int i = 0; i < visibleRoles.count(); ++i) {
+        if (visibleRoles[i].endsWith(QLatin1String("_name"))) {
+            const int leftLength = visibleRoles[i].length() - 5;
+            visibleRoles[i] = visibleRoles[i].left(leftLength) + "_text";
+        }
+    }
+
+    QString sortRole = m_node->sortRole();
+    if (sortRole == QLatin1String("name")) {
+        sortRole = QStringLiteral("text");
+    }
+
+    m_node->setVisibleRoles(visibleRoles);
+    m_node->setSortRole(sortRole);
+    m_node->setVersion(NameRolePropertiesVersion);
+    update();
+}
+
+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
@@ -381,3 +503,11 @@ bool ViewProperties::isPartOfHome(const QString& filePath)
 
     return filePath.startsWith(homePath);
 }
+
+QString ViewProperties::directoryHashForUrl(const QUrl& url)
+{
+    const QByteArray hashValue = QCryptographicHash::hash(url.toEncoded(), QCryptographicHash::Sha1);
+    QString hashString = hashValue.toBase64();
+    hashString.replace('/', '-');
+    return hashString;
+}