Remove unused #include

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

diff --git a/src/views/viewproperties.cpp b/src/views/viewproperties.cpp
index 8dadf4e49300404767e8dabdd5e458ecbb98f3e6..e5d636cd1e1626a51b421da2dbf51e49e34c5bd0 100644 (file)
--- a/src/views/viewproperties.cpp
+++ b/src/views/viewproperties.cpp
@@ -22,86 +22,109 @@
 
 #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 "dolphindebug.h"

 
 #include <QCryptographicHash>
 
 #include <QCryptographicHash>

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

 
 namespace {
     const int AdditionalInfoViewPropertiesVersion = 1;
     const int NameRolePropertiesVersion = 2;
 
 namespace {
     const int AdditionalInfoViewPropertiesVersion = 1;
     const int NameRolePropertiesVersion = 2;

-    const int CurrentViewPropertiesVersion = 3;
+    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.
 
     // 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";
+    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_changedProps(false),
     m_autoSave(true),

-    m_node(0)
+    m_node(nullptr)

 {
     GeneralSettings* settings = GeneralSettings::self();
 {
     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.
     // 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) {
     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.
     if (useGlobalViewProps) {

-        m_filePath = destinationDir("global");
-    } else if (url.protocol().contains("search")) {
-        m_filePath = destinationDir("search/") + directoryHashForUrl(url);
+        m_filePath = destinationDir(QStringLiteral("global"));
+    } else if (url.scheme().contains(QStringLiteral("search"))) {
+        m_filePath = destinationDir(QStringLiteral("search/")) + directoryHashForUrl(url);

         useDetailsViewWithPath = true;
         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.isLocalFile()) {
         m_filePath = url.toLocalFile();
         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
 #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;
+            m_filePath = destinationDir(QStringLiteral("local")) + m_filePath;

         }
     } else {
         }
     } 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) &&
     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);

-            setVisibleRoles(QList<QByteArray>() << "path");
+            setVisibleRoles({"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);
+        }
+
+        if (m_node->version() < DateRolePropertiesVersion) {
+            convertDateRoleToModificationTimeRole();
+            Q_ASSERT(m_node->version() == DateRolePropertiesVersion);
+        }
+
+        m_node->setVersion(CurrentViewPropertiesVersion);
+    }

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


@@ -111,7 +134,7 @@ ViewProperties::~ViewProperties()
     }
 
     delete m_node;
     }
 
     delete m_node;

-    m_node = 0;
+    m_node = nullptr;

 }
 
 void ViewProperties::setViewMode(DolphinView::Mode mode)
 }
 
 void ViewProperties::setViewMode(DolphinView::Mode mode)


@@ -208,6 +231,10 @@ bool ViewProperties::sortFoldersFirst() const
 
 void ViewProperties::setVisibleRoles(const QList<QByteArray>& roles)
 {
 
 void ViewProperties::setVisibleRoles(const QList<QByteArray>& roles)
 {

+    if (roles == visibleRoles()) {
+        return;
+    }
+

     // See ViewProperties::visibleRoles() for the storage format
     // of the additional information.
 
     // See ViewProperties::visibleRoles() for the storage format
     // of the additional information.
 


@@ -222,6 +249,7 @@ void ViewProperties::setVisibleRoles(const QList<QByteArray>& roles)
     }
 
     // Add the updated values for the current view-mode
     }
 
     // Add the updated values for the current view-mode

+    newVisibleRoles.reserve(roles.count());

     foreach (const QByteArray& role, roles) {
         newVisibleRoles.append(prefix + role);
     }
     foreach (const QByteArray& role, roles) {
         newVisibleRoles.append(prefix + role);
     }


@@ -257,24 +285,14 @@ QList<QByteArray> ViewProperties::visibleRoles() 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<QByteArray> roles;
-    roles.append("text");
+    QList<QByteArray> roles{"text"};

 
     // Iterate through all stored keys and append all roles that match to
 
     // Iterate through all stored keys and append all roles that match to

-    // the curren view mode.
+    // the current view mode.

     const QString prefix = viewModePrefix();
     const int prefixLength = prefix.length();
 
     const QString prefix = viewModePrefix();
     const int prefixLength = prefix.length();
 

-    QStringList visibleRoles = m_node->visibleRoles();
-    const int version = m_node->version();
-    if (visibleRoles.isEmpty() && version <= AdditionalInfoViewPropertiesVersion) {
-        // Convert the obsolete additionalInfo-property from older versions into the
-        // visibleRoles-property
-        visibleRoles = const_cast<ViewProperties*>(this)->convertAdditionalInfo();
-    } else if (version <= NameRolePropertiesVersion) {
-        visibleRoles = const_cast<ViewProperties*>(this)->convertNameRole();
-    }
-
+    const QStringList visibleRoles = m_node->visibleRoles();

     foreach (const QString& visibleRole, visibleRoles) {
         if (visibleRole.startsWith(prefix)) {
             const QByteArray role = visibleRole.right(visibleRole.length() - prefixLength).toLatin1();
     foreach (const QString& visibleRole, visibleRoles) {
         if (visibleRole.startsWith(prefix)) {
             const QByteArray role = visibleRole.right(visibleRole.length() - prefixLength).toLatin1();


@@ -291,7 +309,7 @@ QList<QByteArray> ViewProperties::visibleRoles() const
                                   && !visibleRoles.contains(CustomizedDetailsString);
     if (useDefaultValues) {
         roles.append("size");
                                   && !visibleRoles.contains(CustomizedDetailsString);
     if (useDefaultValues) {
         roles.append("size");

-        roles.append("date");
+        roles.append("modificationtime");

     }
 
     return roles;
     }
 
     return roles;


@@ -321,6 +339,7 @@ void ViewProperties::setDirProperties(const ViewProperties& props)
     setSortFoldersFirst(props.sortFoldersFirst());
     setVisibleRoles(props.visibleRoles());
     setHeaderColumnWidths(props.headerColumnWidths());
     setSortFoldersFirst(props.sortFoldersFirst());
     setVisibleRoles(props.visibleRoles());
     setHeaderColumnWidths(props.headerColumnWidths());

+    m_node->setVersion(props.m_node->version());

 }
 
 void ViewProperties::setAutoSaveEnabled(bool autoSave)
 }
 
 void ViewProperties::setAutoSaveEnabled(bool autoSave)


@@ -341,24 +360,25 @@ void ViewProperties::update()
 
 void ViewProperties::save()
 {
 
 void ViewProperties::save()
 {

-    KStandardDirs::makeDir(m_filePath);
+    qCDebug(DolphinDebug) << "Saving view-properties to" << m_filePath;
+    QDir dir;
+    dir.mkpath(m_filePath);

     m_node->setVersion(CurrentViewPropertiesVersion);
     m_node->setVersion(CurrentViewPropertiesVersion);

-    m_node->writeConfig();
+    m_node->save();

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

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


@@ -366,16 +386,16 @@ QString ViewProperties::viewModePrefix() const
     QString prefix;
 
     switch (m_node->viewMode()) {
     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;
 }
 
     }
 
     return prefix;
 }
 

-QStringList ViewProperties::convertAdditionalInfo()
+void ViewProperties::convertAdditionalInfo()

 {
     QStringList visibleRoles;
 
 {
     QStringList visibleRoles;
 


@@ -392,7 +412,7 @@ QStringList ViewProperties::convertAdditionalInfo()
             if (index >= 0 && index + 1 < visibleRole.length()) {
                 ++index;
                 if (visibleRole[index] == QLatin1Char('L')) {
             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();
                 }
                 } else {
                     visibleRole[index] = visibleRole[index].toLower();
                 }


@@ -403,27 +423,51 @@ QStringList ViewProperties::convertAdditionalInfo()
 
     m_node->setAdditionalInfo(QStringList());
     m_node->setVisibleRoles(visibleRoles);
 
     m_node->setAdditionalInfo(QStringList());
     m_node->setVisibleRoles(visibleRoles);

+    m_node->setVersion(AdditionalInfoViewPropertiesVersion);

     update();
     update();

-
-    return visibleRoles;

 }
 
 }
 

-QStringList ViewProperties::convertNameRole()
+void ViewProperties::convertNameRoleToTextRole()

 {
     QStringList visibleRoles = m_node->visibleRoles();
     for (int i = 0; i < visibleRoles.count(); ++i) {
 {
     QStringList visibleRoles = m_node->visibleRoles();
     for (int i = 0; i < visibleRoles.count(); ++i) {

-        if (visibleRoles[i].endsWith("_name")) {
+        if (visibleRoles[i].endsWith(QLatin1String("_name"))) {

             const int leftLength = visibleRoles[i].length() - 5;
             visibleRoles[i] = visibleRoles[i].left(leftLength) + "_text";
         }
     }
 
             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->setVisibleRoles(visibleRoles);

+    m_node->setSortRole(sortRole);
+    m_node->setVersion(NameRolePropertiesVersion);

     update();
     update();

-
-    return visibleRoles;

 }
 
 }
 

+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)
 {
 
 bool ViewProperties::isPartOfHome(const QString& filePath)
 {


@@ -438,10 +482,9 @@ bool ViewProperties::isPartOfHome(const QString& filePath)
     return filePath.startsWith(homePath);
 }
 
     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;
     QString hashString = hashValue.toBase64();
     hashString.replace('/', '-');
     return hashString;