]> cloud.milkyroute.net Git - dolphin.git/blobdiff - src/views/viewproperties.cpp
Interface cleanups to prepare the return of "grouped sorting"
[dolphin.git] / src / views / viewproperties.cpp
index dac951f0956b9014d14eff6e0c5ccd5c8314165d..bb747139f93412c6f60649e7d610d45f0799dfd5 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2006-2010 by Peter Penz <peter.penz@gmx.at>             *
+ *   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  *
 #include "dolphin_directoryviewpropertysettings.h"
 #include "dolphin_generalsettings.h"
 
-#include <kcomponentdata.h>
-#include <klocale.h>
-#include <kstandarddirs.h>
-#include <kurl.h>
+#include <KComponentData>
+#include <KLocale>
+#include <KStandardDirs>
+#include <KUrl>
 
 #include <QDate>
 #include <QFile>
 
 #include "settings/dolphinsettings.h"
 
+namespace {
+    // 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::ViewProperties(const KUrl& url) :
     m_changedProps(false),
     m_autoSave(true),
     m_node(0)
 {
+    GeneralSettings* settings = DolphinSettings::instance().generalSettings();
+    const bool useGlobalViewProps = settings->globalViewProps();
+    bool useDetailsViewWithPath = 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.
-    GeneralSettings* settings = DolphinSettings::instance().generalSettings();
-    const bool useGlobalViewProps = settings->globalViewProps();
     if (useGlobalViewProps) {
         m_filePath = destinationDir("global");
+    } else if (url.protocol().contains("search")) {
+        m_filePath = destinationDir("search");
+        useDetailsViewWithPath = true;
+    } else if (url.protocol() == QLatin1String("trash")) {
+        m_filePath = destinationDir("trash");
+        useDetailsViewWithPath = true;
     } else if (url.isLocalFile()) {
         m_filePath = url.toLocalFile();
         const QFileInfo info(m_filePath);
-        if (!info.isWritable()) {
+        if (!info.isWritable() || !isPartOfHome(m_filePath)) {
             m_filePath = destinationDir("local") + m_filePath;
         }
     } else {
@@ -60,20 +75,26 @@ ViewProperties::ViewProperties(const KUrl& url) :
     const QString file = m_filePath + QDir::separator() + QLatin1String(".directory");
     m_node = new ViewPropertySettings(KSharedConfig::openConfig(file));
 
-    const bool useDefaultProps = !useGlobalViewProps &&
+    // 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() ||
                                   (m_node->timestamp() < settings->viewPropsTimestamp()));
     if (useDefaultProps) {
-        // If the .directory file does not exist or the timestamp is too old,
-        // use the values from the global .directory file instead, which acts
-        // as default view for new folders in this case.
-        settings->setGlobalViewProps(true);
-
-        ViewProperties defaultProps(url);
-        setDirProperties(defaultProps);
-
-        settings->setGlobalViewProps(false);
-        m_changedProps = false;
+        if (useDetailsViewWithPath) {
+            setViewMode(DolphinView::DetailsView);
+            setAdditionalInfoList(QList<DolphinView::AdditionalInfo>() << DolphinView::PathInfo);
+        } else {
+            // The global view-properties act as default for directories without
+            // any view-property configuration
+            settings->setGlobalViewProps(true);
+
+            ViewProperties defaultProps(url);
+            setDirProperties(defaultProps);
+
+            settings->setGlobalViewProps(false);
+            m_changedProps = false;
+        }
     }
 }
 
@@ -91,59 +112,60 @@ void ViewProperties::setViewMode(DolphinView::Mode mode)
 {
     if (m_node->viewMode() != mode) {
         m_node->setViewMode(mode);
-        updateTimeStamp();
+        update();
     }
 }
 
 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::setShowPreview(bool show)
+void ViewProperties::setPreviewsShown(bool show)
 {
-    if (m_node->showPreview() != show) {
-        m_node->setShowPreview(show);
-        updateTimeStamp();
+    if (m_node->previewsShown() != show) {
+        m_node->setPreviewsShown(show);
+        update();
     }
 }
 
-bool ViewProperties::showPreview() const
+bool ViewProperties::previewsShown() const
 {
-    return m_node->showPreview();
+    return m_node->previewsShown();
 }
 
-void ViewProperties::setShowHiddenFiles(bool show)
+void ViewProperties::setHiddenFilesShown(bool show)
 {
-    if (m_node->showHiddenFiles() != show) {
-        m_node->setShowHiddenFiles(show);
-        updateTimeStamp();
+    if (m_node->hiddenFilesShown() != show) {
+        m_node->setHiddenFilesShown(show);
+        update();
     }
 }
 
-void ViewProperties::setCategorizedSorting(bool categorized)
+void ViewProperties::setGroupedSorting(bool grouped)
 {
-    if (m_node->categorizedSorting() != categorized) {
-        m_node->setCategorizedSorting(categorized);
-        updateTimeStamp();
+    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::showHiddenFiles() const
+bool ViewProperties::hiddenFilesShown() const
 {
-    return m_node->showHiddenFiles();
+    return m_node->hiddenFilesShown();
 }
 
 void ViewProperties::setSorting(DolphinView::Sorting sorting)
 {
     if (m_node->sorting() != sorting) {
         m_node->setSorting(sorting);
-        updateTimeStamp();
+        update();
     }
 }
 
@@ -156,7 +178,7 @@ void ViewProperties::setSortOrder(Qt::SortOrder sortOrder)
 {
     if (m_node->sortOrder() != sortOrder) {
         m_node->setSortOrder(sortOrder);
-        updateTimeStamp();
+        update();
     }
 }
 
@@ -169,7 +191,7 @@ void ViewProperties::setSortFoldersFirst(bool foldersFirst)
 {
     if (m_node->sortFoldersFirst() != foldersFirst) {
         m_node->setSortFoldersFirst(foldersFirst);
-        updateTimeStamp();
+        update();
     }
 }
 
@@ -178,51 +200,123 @@ bool ViewProperties::sortFoldersFirst() const
     return m_node->sortFoldersFirst();
 }
 
-void ViewProperties::setAdditionalInfo(const KFileItemDelegate::InformationList& list)
+void ViewProperties::setAdditionalInfoList(const QList<DolphinView::AdditionalInfo>& list)
 {
+    // See ViewProperties::additionalInfoList() 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 QString prefix = viewModePrefix();
+    QStringList newInfoStringList = oldInfoStringList;
+    for (int i = newInfoStringList.count() - 1; i >= 0; --i) {
+        if (newInfoStringList.at(i).startsWith(prefix)) {
+            newInfoStringList.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));
+    }
 
-    int infoMask = 0;
-    foreach (KFileItemDelegate::Information currentInfo, list) {
-        infoMask = infoMask | infoAccessor.bitValue(currentInfo);
+    // 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;
+            }
+        }
     }
 
-    const int encodedInfo = encodedAdditionalInfo(infoMask);
-    if (m_node->additionalInfo() != encodedInfo) {
-        m_node->setAdditionalInfo(encodedInfo);
-        updateTimeStamp();
+    if (changed) {
+        const bool markCustomizedDetails = (m_node->viewMode() == DolphinView::DetailsView)
+                                           && !newInfoStringList.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);
+        }
+
+        m_node->setAdditionalInfo(newInfoStringList);
+        update();
     }
 }
 
-KFileItemDelegate::InformationList ViewProperties::additionalInfo() const
+QList<DolphinView::AdditionalInfo> ViewProperties::additionalInfoList() const
 {
-    KFileItemDelegate::InformationList usedInfos;
-
-    const int decodedInfo = decodedAdditionalInfo();
-
-    AdditionalInfoAccessor& infoAccessor = AdditionalInfoAccessor::instance();
-    const KFileItemDelegate::InformationList infoKeys = infoAccessor.keys();
+    // 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
+    //
+    // To get the representation as QList<DolphinView::AdditionalInfo>, 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
+    // 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);
+        }
+    }
 
-    foreach (const KFileItemDelegate::Information info, infoKeys) {
-        if (decodedInfo & infoAccessor.bitValue(info)) {
-            usedInfos.append(info);
+    // Iterate through all stored keys stored as strings and map them to
+    // the corresponding DolphinView::AdditionalInfo values.
+    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";
+            }
         }
     }
 
-    return usedInfos;
-}
+    // 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()
+                                  && (m_node->viewMode() == DolphinView::DetailsView)
+                                  && !infoStringList.contains(CustomizedDetailsString);
+    Q_UNUSED(useDefaultValues);
+    if (useDefaultValues) {
+        usedInfo.append(DolphinView::SizeInfo);
+        usedInfo.append(DolphinView::DateInfo);
+    }
 
+    return usedInfo;
+}
 
 void ViewProperties::setDirProperties(const ViewProperties& props)
 {
     setViewMode(props.viewMode());
-    setShowPreview(props.showPreview());
-    setShowHiddenFiles(props.showHiddenFiles());
-    setCategorizedSorting(props.categorizedSorting());
+    setPreviewsShown(props.previewsShown());
+    setHiddenFilesShown(props.hiddenFilesShown());
+    setGroupedSorting(props.groupedSorting());
     setSorting(props.sorting());
     setSortOrder(props.sortOrder());
     setSortFoldersFirst(props.sortFoldersFirst());
-    setAdditionalInfo(props.additionalInfo());
+    setAdditionalInfoList(props.additionalInfoList());
 }
 
 void ViewProperties::setAutoSaveEnabled(bool autoSave)
@@ -235,7 +329,7 @@ bool ViewProperties::isAutoSaveEnabled() const
     return m_autoSave;
 }
 
-void ViewProperties::updateTimeStamp()
+void ViewProperties::update()
 {
     m_changedProps = true;
     m_node->setTimestamp(QDateTime::currentDateTime());
@@ -262,49 +356,29 @@ QString ViewProperties::destinationDir(const QString& subDir) const
     return KStandardDirs::locateLocal("data", basePath);
 }
 
-int ViewProperties::encodedAdditionalInfo(int info) const
+QString ViewProperties::viewModePrefix() const
 {
-    int encodedInfo = m_node->additionalInfo();
-
-    switch (viewMode()) {
-    case DolphinView::DetailsView:
-        encodedInfo = (encodedInfo & 0xFFFF00) | info;
-        break;
-    case DolphinView::IconsView:
-        encodedInfo = (encodedInfo & 0xFF00FF) | (info << 8);
-        break;
-    case DolphinView::ColumnView:
-        encodedInfo = (encodedInfo & 0x00FFFF) | (info << 16);
-        break;
-    default: break;
+    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";
     }
 
-    return encodedInfo;
+    return prefix;
 }
 
-int ViewProperties::decodedAdditionalInfo() const
+bool ViewProperties::isPartOfHome(const QString& filePath)
 {
-    int decodedInfo = m_node->additionalInfo();
-
-    switch (viewMode()) {
-    case DolphinView::DetailsView:
-        decodedInfo = decodedInfo & 0xFF;
-        if (decodedInfo == 0) {
-            // A details view without any additional info makes no sense, hence
-            // provide at least a size-info and date-info as fallback
-            AdditionalInfoAccessor& infoAccessor = AdditionalInfoAccessor::instance();
-            decodedInfo = infoAccessor.bitValue(KFileItemDelegate::Size) |
-                          infoAccessor.bitValue(KFileItemDelegate::ModificationTime);
-        }
-        break;
-    case DolphinView::IconsView:
-        decodedInfo = (decodedInfo >> 8) & 0xFF;
-        break;
-    case DolphinView::ColumnView:
-        decodedInfo = (decodedInfo >> 16) & 0xFF;
-        break;
-    default: break;
+    // For performance reasons cache the path in a static QString
+    // (see QDir::homePath() for more details)
+    static QString homePath;
+    if (homePath.isEmpty()) {
+        homePath = QDir::homePath();
+        Q_ASSERT(!homePath.isEmpty());
     }
 
-    return decodedInfo;
+    return filePath.startsWith(homePath);
 }