-/***************************************************************************
- * 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 *
- * it under the terms of the GNU General Public License as published by *
- * the Free Software Foundation; either version 2 of the License, or *
- * (at your option) any later version. *
- * *
- * This program is distributed in the hope that it will be useful, *
- * but WITHOUT ANY WARRANTY; without even the implied warranty of *
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
- * GNU General Public License for more details. *
- * *
- * You should have received a copy of the GNU General Public License *
- * along with this program; if not, write to the *
- * Free Software Foundation, Inc., *
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
- ***************************************************************************/
+/*
+ * SPDX-FileCopyrightText: 2006-2010 Peter Penz <peter.penz19@gmail.com>
+ * SPDX-FileCopyrightText: 2006 Aaron J. Seigo <aseigo@kde.org>
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
#include "viewproperties.h"
-#include "rolesaccessor.h"
#include "dolphin_directoryviewpropertysettings.h"
#include "dolphin_generalsettings.h"
+#include "dolphindebug.h"
-#include <KComponentData>
-#include <KLocale>
-#include <KStandardDirs>
-#include <KUrl>
+#include <QCryptographicHash>
-#include <QDate>
-#include <QFile>
-#include <QFileInfo>
+#include <KFileItem>
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::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_node(0)
+ m_node(nullptr)
{
GeneralSettings* settings = GeneralSettings::self();
- const bool useGlobalViewProps = settings->globalViewProps();
+ 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(QLatin1String("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 KFileItem fileItem(url);
+ useDestinationDir = fileItem.isSlow();
+ }
+
+ 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);
- setVisibleRoles(QList<QByteArray>() << "path");
+ 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()
}
delete m_node;
- m_node = 0;
+ m_node = nullptr;
}
void ViewProperties::setViewMode(DolphinView::Mode mode)
void ViewProperties::setVisibleRoles(const QList<QByteArray>& roles)
{
+ if (roles == visibleRoles()) {
+ return;
+ }
+
// See ViewProperties::visibleRoles() for the storage format
// of the additional information.
}
// Add the updated values for the current view-mode
+ newVisibleRoles.reserve(roles.count());
foreach (const QByteArray& role, roles) {
newVisibleRoles.append(prefix + role);
}
//
// 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<QByteArray> roles;
- roles.append("name");
+ QList<QByteArray> roles{"text"};
// 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 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 != "name") {
+ 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 = roles.count() == 1 // "name"
+ const bool useDefaultValues = roles.count() == 1 // "text"
&& (m_node->viewMode() == DolphinView::DetailsView)
&& !visibleRoles.contains(CustomizedDetailsString);
if (useDefaultValues) {
roles.append("size");
- roles.append("date");
+ roles.append("modificationtime");
}
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)
{
setViewMode(props.viewMode());
setSortOrder(props.sortOrder());
setSortFoldersFirst(props.sortFoldersFirst());
setVisibleRoles(props.visibleRoles());
+ setHeaderColumnWidths(props.headerColumnWidths());
+ m_node->setVersion(props.m_node->version());
}
void ViewProperties::setAutoSaveEnabled(bool autoSave)
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
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
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;
+}
projects / dolphin.git / blobdiff