port Dolphin from KUrl to QUrl

[dolphin.git] / src / views / viewproperties.cpp

diff --git a/src/views/viewproperties.cpp b/src/views/viewproperties.cpp
index 36ec6bdb087857531147b613cf115f0a5925cf7c..018f42d2b65c70ed8eb1c46017cfcb64c7e028c1 100644 (file)
--- a/src/views/viewproperties.cpp
+++ b/src/views/viewproperties.cpp
@@ -20,33 +20,41 @@
 
 #include "viewproperties.h"
 
 
 #include "viewproperties.h"
 

-#include "additionalinfoaccessor.h"

 #include "dolphin_directoryviewpropertysettings.h"
 #include "dolphin_generalsettings.h"
 
 #include "dolphin_directoryviewpropertysettings.h"
 #include "dolphin_generalsettings.h"
 

-#include <KComponentData>
-#include <KLocale>
-#include <KStandardDirs>
-#include <KUrl>
+#include <QUrl>
+#include <KDebug>
+#include <KGlobal>

 
 

+#include <KComponentData>
+#include <QCryptographicHash>

 #include <QDate>
 #include <QFile>
 #include <QFileInfo>
 #include <QDate>
 #include <QFile>
 #include <QFileInfo>

+#include <QStandardPaths>

 
 namespace {
 
 namespace {

+    const int AdditionalInfoViewPropertiesVersion = 1;
+    const int NameRolePropertiesVersion = 2;
+    const int CurrentViewPropertiesVersion = 3;
+

     // String representation to mark the additional properties of
     // the details view as customized by the user. See
     // 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)
 {
     GeneralSettings* settings = GeneralSettings::self();
     m_changedProps(false),
     m_autoSave(true),
     m_node(0)
 {
     GeneralSettings* settings = GeneralSettings::self();

-    const bool useGlobalViewProps = settings->globalViewProps();
+    const bool useGlobalViewProps = settings->globalViewProps() || url.isEmpty();

     bool useDetailsViewWithPath = false;
 
     // We try and save it to the file .directory in the directory being viewed.
     bool useDetailsViewWithPath = false;
 
     // We try and save it to the file .directory in the directory being viewed.


@@ -54,46 +62,71 @@ ViewProperties::ViewProperties(const KUrl& url) :
     // we store the properties information in a local file.
     if (useGlobalViewProps) {
         m_filePath = destinationDir("global");
     // 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");
+    } else if (url.scheme().contains("search")) {
+        m_filePath = destinationDir("search/") + directoryHashForUrl(url);

         useDetailsViewWithPath = true;
         useDetailsViewWithPath = true;

-    } else if (url.protocol() == QLatin1String("trash")) {
+    } else if (url.scheme() == QLatin1String("trash")) {

         m_filePath = destinationDir("trash");
         useDetailsViewWithPath = true;
     } else if (url.isLocalFile()) {
         m_filePath = url.toLocalFile();
         m_filePath = destinationDir("trash");
         useDetailsViewWithPath = true;
     } else if (url.isLocalFile()) {
         m_filePath = url.toLocalFile();

-        const QFileInfo info(m_filePath);
-        if (!info.isWritable() || !isPartOfHome(m_filePath)) {
+        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)) {
+#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("local") + m_filePath;
         }
     } else {
         m_filePath = destinationDir("remote") + m_filePath;
     }
 
             m_filePath = destinationDir("local") + m_filePath;
         }
     } else {
         m_filePath = destinationDir("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) &&
     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);
                                   (m_node->timestamp() < settings->viewPropsTimestamp()));
     if (useDefaultProps) {
         if (useDetailsViewWithPath) {
             setViewMode(DolphinView::DetailsView);

-            setAdditionalInfoList(QList<DolphinView::AdditionalInfo>() << DolphinView::PathInfo);
+            setVisibleRoles(QList<QByteArray>() << "path");

         } else {
             // The global view-properties act as default for directories without
         } 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);
 
             setDirProperties(defaultProps);
 

-            settings->setGlobalViewProps(false);

             m_changedProps = 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);
+        }
+
+        m_node->setVersion(CurrentViewPropertiesVersion);
+    }

 }
 
 ViewProperties::~ViewProperties()
 }
 
 ViewProperties::~ViewProperties()


@@ -159,17 +192,17 @@ bool ViewProperties::hiddenFilesShown() const
     return m_node->hiddenFilesShown();
 }
 
     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();
     }
 }
 
         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)
 }
 
 void ViewProperties::setSortOrder(Qt::SortOrder sortOrder)


@@ -198,51 +231,53 @@ bool ViewProperties::sortFoldersFirst() const
     return m_node->sortFoldersFirst();
 }
 
     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
     // 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();
     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
         }
     }
 
     // Add the updated values for the current view-mode

-    AdditionalInfoAccessor& infoAccessor = AdditionalInfoAccessor::instance();
-    foreach (DolphinView::AdditionalInfo info, list) {
-        newInfoStringList.append(prefix + infoAccessor.value(info));
+    foreach (const QByteArray& role, roles) {
+        newVisibleRoles.append(prefix + role);

     }
 
     }
 

-    if (oldInfoStringList != newInfoStringList) {
+    if (oldVisibleRoles != newVisibleRoles) {

         const bool markCustomizedDetails = (m_node->viewMode() == DolphinView::DetailsView)
         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,
         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();
     }
 }
 
         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:
     //
 {
     // 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
     // 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


@@ -251,47 +286,48 @@ QList<DolphinView::AdditionalInfo> ViewProperties::additionalInfoList() const
     // by "CustomizedDetails"), also a details-view with no additional information
     // is accepted.
 
     // 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;
+    roles.append("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 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
             }
         }
     }
 
     // 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)
                                   && (m_node->viewMode() == DolphinView::DetailsView)

-                                  && !infoStringList.contains(CustomizedDetailsString);
-    Q_UNUSED(useDefaultValues);
+                                  && !visibleRoles.contains(CustomizedDetailsString);

     if (useDefaultValues) {
     if (useDefaultValues) {

-        usedInfo.append(DolphinView::SizeInfo);
-        usedInfo.append(DolphinView::DateInfo);
+        roles.append("size");
+        roles.append("date");

     }
 
     }
 

-    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)
 }
 
 void ViewProperties::setDirProperties(const ViewProperties& props)


@@ -300,10 +336,12 @@ void ViewProperties::setDirProperties(const ViewProperties& props)
     setPreviewsShown(props.previewsShown());
     setHiddenFilesShown(props.hiddenFilesShown());
     setGroupedSorting(props.groupedSorting());
     setPreviewsShown(props.previewsShown());
     setHiddenFilesShown(props.hiddenFilesShown());
     setGroupedSorting(props.groupedSorting());

-    setSorting(props.sorting());
+    setSortRole(props.sortRole());

     setSortOrder(props.sortOrder());
     setSortFoldersFirst(props.sortFoldersFirst());
     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)
 }
 
 void ViewProperties::setAutoSaveEnabled(bool autoSave)


@@ -324,23 +362,26 @@ void ViewProperties::update()
 
 void ViewProperties::save()
 {
 
 void ViewProperties::save()
 {

-    KStandardDirs::makeDir(m_filePath);
+    kDebug() << "Saving view-properties to" << m_filePath;
+    QDir dir;
+    dir.mkpath(m_filePath);
+    m_node->setVersion(CurrentViewPropertiesVersion);

     m_node->writeConfig();
     m_changedProps = false;
 }
 
     m_node->writeConfig();
     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 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(KGlobal::mainComponent().componentName());
+    path.append("/view_properties/").append(subDir);
+    return path;

 }
 
 QString ViewProperties::viewModePrefix() const
 }
 
 QString ViewProperties::viewModePrefix() const


@@ -357,6 +398,59 @@ QString ViewProperties::viewModePrefix() const
     return prefix;
 }
 
     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("LinkDestination", "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 = QLatin1String("text");
+    }
+
+    m_node->setVisibleRoles(visibleRoles);
+    m_node->setSortRole(sortRole);
+    m_node->setVersion(NameRolePropertiesVersion);
+    update();
+}
+

 bool ViewProperties::isPartOfHome(const QString& filePath)
 {
     // For performance reasons cache the path in a static QString
 bool ViewProperties::isPartOfHome(const QString& filePath)
 {
     // For performance reasons cache the path in a static QString


@@ -369,3 +463,11 @@ bool ViewProperties::isPartOfHome(const QString& filePath)
 
     return filePath.startsWith(homePath);
 }
 
     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;
+}