]> cloud.milkyroute.net Git - dolphin.git/blobdiff - src/views/viewproperties.cpp
Update e-mail address from peter.penz@gmx.at to peter.penz19@gmail.com
[dolphin.git] / src / views / viewproperties.cpp
index 11b2404a9cdae37c4220bf987edb341e88f6bc49..d0c6fcf1e50fe44064db279409c74bf63a916afb 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::additionalInfoV2() for more information.
+    const char* CustomizedDetailsString = "CustomizedDetails";
+}
+
 ViewProperties::ViewProperties(const KUrl& url) :
     m_changedProps(false),
     m_autoSave(true),
@@ -42,19 +49,23 @@ ViewProperties::ViewProperties(const KUrl& url) :
 {
     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.
-    const bool isSearchUrl = url.protocol().contains("search");
-    if (isSearchUrl) {
-        m_filePath = destinationDir("search");
-    } else if (useGlobalViewProps) {
+    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 {
@@ -66,11 +77,11 @@ 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 || isSearchUrl) &&
+    const bool useDefaultProps = (!useGlobalViewProps || useDetailsViewWithPath) &&
                                  (!QFileInfo(file).exists() ||
                                   (m_node->timestamp() < settings->viewPropsTimestamp()));
     if (useDefaultProps) {
-        if (isSearchUrl) {
+        if (useDetailsViewWithPath) {
             setViewMode(DolphinView::DetailsView);
             setAdditionalInfo(KFileItemDelegate::InformationList() << KFileItemDelegate::LocalPathOrUrl);
         } else {
@@ -101,7 +112,7 @@ void ViewProperties::setViewMode(DolphinView::Mode mode)
 {
     if (m_node->viewMode() != mode) {
         m_node->setViewMode(mode);
-        updateTimeStamp();
+        update();
     }
 }
 
@@ -114,7 +125,7 @@ void ViewProperties::setShowPreview(bool show)
 {
     if (m_node->showPreview() != show) {
         m_node->setShowPreview(show);
-        updateTimeStamp();
+        update();
     }
 }
 
@@ -127,7 +138,7 @@ void ViewProperties::setShowHiddenFiles(bool show)
 {
     if (m_node->showHiddenFiles() != show) {
         m_node->setShowHiddenFiles(show);
-        updateTimeStamp();
+        update();
     }
 }
 
@@ -135,7 +146,7 @@ void ViewProperties::setCategorizedSorting(bool categorized)
 {
     if (m_node->categorizedSorting() != categorized) {
         m_node->setCategorizedSorting(categorized);
-        updateTimeStamp();
+        update();
     }
 }
 
@@ -153,7 +164,7 @@ void ViewProperties::setSorting(DolphinView::Sorting sorting)
 {
     if (m_node->sorting() != sorting) {
         m_node->setSorting(sorting);
-        updateTimeStamp();
+        update();
     }
 }
 
@@ -166,7 +177,7 @@ void ViewProperties::setSortOrder(Qt::SortOrder sortOrder)
 {
     if (m_node->sortOrder() != sortOrder) {
         m_node->setSortOrder(sortOrder);
-        updateTimeStamp();
+        update();
     }
 }
 
@@ -179,7 +190,7 @@ void ViewProperties::setSortFoldersFirst(bool foldersFirst)
 {
     if (m_node->sortFoldersFirst() != foldersFirst) {
         m_node->setSortFoldersFirst(foldersFirst);
-        updateTimeStamp();
+        update();
     }
 }
 
@@ -190,36 +201,67 @@ bool ViewProperties::sortFoldersFirst() const
 
 void ViewProperties::setAdditionalInfo(const KFileItemDelegate::InformationList& list)
 {
+    // See ViewProperties::additionalInfoV2() for the storage format
+    // of the additional information.
+
+    // Remove the old values stored for the current view-mode
+    const QStringList oldInfoStringList = m_node->additionalInfoV2();
+    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 (KFileItemDelegate::Information 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) {
+        if (m_node->version() < 2) {
+            m_node->setVersion(2);
+        }
+
+        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->setAdditionalInfoV2(newInfoStringList);
+        update();
     }
 }
 
 KFileItemDelegate::InformationList ViewProperties::additionalInfo() const
 {
-    KFileItemDelegate::InformationList usedInfos;
-
-    const int decodedInfo = decodedAdditionalInfo();
-
-    AdditionalInfoAccessor& infoAccessor = AdditionalInfoAccessor::instance();
-    const KFileItemDelegate::InformationList infoKeys = infoAccessor.keys();
+    KFileItemDelegate::InformationList usedInfo;
 
-    foreach (const KFileItemDelegate::Information info, infoKeys) {
-        if (decodedInfo & infoAccessor.bitValue(info)) {
-            usedInfos.append(info);
-        }
+    switch (m_node->version()) {
+    case 1: usedInfo = additionalInfoV1(); break;
+    case 2: usedInfo = additionalInfoV2(); break;
+    default: kWarning() << "Unknown version of the view properties";
     }
 
-    return usedInfos;
+    return usedInfo;
 }
 
 
@@ -245,10 +287,26 @@ bool ViewProperties::isAutoSaveEnabled() const
     return m_autoSave;
 }
 
-void ViewProperties::updateTimeStamp()
+void ViewProperties::update()
 {
     m_changedProps = true;
     m_node->setTimestamp(QDateTime::currentDateTime());
+
+    // If the view-properties are stored in an older format, take
+    // care to update them to the current format.
+    switch (m_node->version()) {
+    case 1: {
+        const KFileItemDelegate::InformationList infoList = additionalInfoV1();
+        m_node->setVersion(2);
+        setAdditionalInfo(infoList);
+        break;
+    }
+    case 2:
+        // Current version. Nothing needs to get converted.
+        break;
+    default:
+        kWarning() << "Unknown version of the view properties";
+    }
 }
 
 void ViewProperties::save()
@@ -272,28 +330,10 @@ QString ViewProperties::destinationDir(const QString& subDir) const
     return KStandardDirs::locateLocal("data", basePath);
 }
 
-int ViewProperties::encodedAdditionalInfo(int info) const
+KFileItemDelegate::InformationList ViewProperties::additionalInfoV1() 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;
-    }
-
-    return encodedInfo;
-}
+    KFileItemDelegate::InformationList usedInfo;
 
-int ViewProperties::decodedAdditionalInfo() const
-{
     int decodedInfo = m_node->additionalInfo();
 
     switch (viewMode()) {
@@ -316,5 +356,96 @@ int ViewProperties::decodedAdditionalInfo() const
     default: break;
     }
 
-    return decodedInfo;
+    AdditionalInfoAccessor& infoAccessor = AdditionalInfoAccessor::instance();
+    const KFileItemDelegate::InformationList infoKeys = infoAccessor.keys();
+
+    foreach (const KFileItemDelegate::Information info, infoKeys) {
+        if (decodedInfo & infoAccessor.bitValue(info)) {
+            usedInfo.append(info);
+        }
+    }
+
+    return usedInfo;
+}
+
+KFileItemDelegate::InformationList ViewProperties::additionalInfoV2() const
+{
+    // The shown additional information is stored for each view-mode separately as
+    // string with the view-mode as prefix. Example:
+    //
+    // AdditionalInfoV2=Details_Size,Details_Date,Details_Owner,Icon_Size
+    //
+    // To get the representation as KFileItemDelegate::InformationList, 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.
+
+    KFileItemDelegate::InformationList usedInfo;
+
+    // infoHash allows to get the mapped KFileItemDelegate::Information value
+    // for a stored string-value in a fast way
+    static QHash<QString, KFileItemDelegate::Information> infoHash;
+    if (infoHash.isEmpty()) {
+        AdditionalInfoAccessor& infoAccessor = AdditionalInfoAccessor::instance();
+        const KFileItemDelegate::InformationList keys = infoAccessor.keys();
+        foreach (const KFileItemDelegate::Information key, keys) {
+            infoHash.insert(infoAccessor.value(key), key);
+        }
+    }
+
+    // Iterate through all stored keys stored as strings and map them to
+    // the corresponding KFileItemDelegate::Information values.
+    const QString prefix = viewModePrefix();
+    const int prefixLength = prefix.length();
+    const QStringList infoStringList = m_node->additionalInfoV2();
+    foreach (const QString& infoString, infoStringList) {
+        if (infoString.startsWith(prefix)) {
+            const QString key = infoString.right(infoString.length() - prefixLength);
+            Q_ASSERT(infoHash.contains(key));
+            usedInfo.append(infoHash.value(key));
+        }
+    }
+
+    // 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);
+    if (useDefaultValues) {
+        usedInfo.append(KFileItemDelegate::Size);
+        usedInfo.append(KFileItemDelegate::ModificationTime);
+    }
+
+    return usedInfo;
+}
+
+QString ViewProperties::viewModePrefix() const
+{
+    QString prefix;
+
+    switch (m_node->viewMode()) {
+    case DolphinView::DetailsView: prefix = "Details_"; break;
+    case DolphinView::IconsView:   prefix = "Icons_"; break;
+    case DolphinView::ColumnView:  prefix = "Column_"; break;
+    default: kWarning() << "Unknown view-mode of the view properties";
+    }
+
+    return prefix;
+}
+
+bool ViewProperties::isPartOfHome(const QString& filePath)
+{
+    // 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 filePath.startsWith(homePath);
 }