/***************************************************************************
- * 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 "viewproperties.h"
-#include "additionalinfoaccessor.h"
#include "dolphin_directoryviewpropertysettings.h"
#include "dolphin_generalsettings.h"
+#include "dolphindebug.h"
-#include <kcomponentdata.h>
-#include <klocale.h>
-#include <kstandarddirs.h>
-#include <kurl.h>
+#include <QCryptographicHash>
-#include <QDate>
-#include <QFile>
-#include <QFileInfo>
+#include <KFileItem>
-#include "settings/dolphinsettings.h"
+namespace {
+ const int AdditionalInfoViewPropertiesVersion = 1;
+ const int NameRolePropertiesVersion = 2;
+ const int DateRolePropertiesVersion = 4;
+ const int CurrentViewPropertiesVersion = 4;
-ViewProperties::ViewProperties(const KUrl& url) :
+ // 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";
+
+ // Filename that is used for storing the properties
+ const char ViewPropertiesFileName[] = ".directory";
+}
+
+ViewProperties::ViewProperties(const QUrl& url) :
m_changedProps(false),
m_autoSave(true),
- m_node(0)
+ m_node(nullptr)
{
- GeneralSettings* settings = DolphinSettings::instance().generalSettings();
- const bool useGlobalViewProps = settings->globalViewProps();
+ GeneralSettings* settings = GeneralSettings::self();
+ 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.
- const bool isSearchUrl = url.protocol().contains("search");
- if (isSearchUrl) {
- m_filePath = destinationDir("search");
- } else if (useGlobalViewProps) {
- m_filePath = destinationDir("global");
+ if (useGlobalViewProps) {
+ m_filePath = destinationDir(QStringLiteral("global"));
+ } else if (url.scheme().contains(QLatin1String("search"))) {
+ m_filePath = destinationDir(QStringLiteral("search/")) + directoryHashForUrl(url);
+ useDetailsViewWithPath = true;
+ } 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()) {
- 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 || isSearchUrl) &&
- (!QFileInfo(file).exists() ||
+ const bool useDefaultProps = (!useGlobalViewProps || useDetailsViewWithPath) &&
+ (!QFile::exists(file) ||
(m_node->timestamp() < settings->viewPropsTimestamp()));
if (useDefaultProps) {
- if (isSearchUrl) {
+ if (useDetailsViewWithPath) {
setViewMode(DolphinView::DetailsView);
- setAdditionalInfo(KFileItemDelegate::InformationList() << KFileItemDelegate::LocalPathOrUrl);
+ 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)
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);
+ 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);
+ 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);
+ 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)
+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();
}
}
-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)
return m_node->sortFoldersFirst();
}
-void ViewProperties::setAdditionalInfo(const KFileItemDelegate::InformationList& list)
+void ViewProperties::setVisibleRoles(const QList<QByteArray>& roles)
{
- // See ViewProperties::additionalInfoV2() 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
- const QStringList oldInfoStringList = m_node->additionalInfoV2();
+ const QStringList oldVisibleRoles = m_node->visibleRoles();
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
- AdditionalInfoAccessor& infoAccessor = AdditionalInfoAccessor::instance();
- foreach (KFileItemDelegate::Information info, list) {
- newInfoStringList.append(prefix + infoAccessor.value(info));
+ newVisibleRoles.reserve(roles.count());
+ foreach (const QByteArray& role, roles) {
+ newVisibleRoles.append(prefix + role);
}
- // 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;
- }
+ if (oldVisibleRoles != newVisibleRoles) {
+ const bool markCustomizedDetails = (m_node->viewMode() == DolphinView::DetailsView)
+ && !newVisibleRoles.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 without doing the
+ // fallback to show the size and date per default.
+ newVisibleRoles.append(CustomizedDetailsString);
}
- }
- if (changed) {
- if (m_node->version() < 2) {
- m_node->setVersion(2);
- }
- m_node->setAdditionalInfoV2(newInfoStringList);
+ m_node->setVisibleRoles(newVisibleRoles);
update();
}
}
-KFileItemDelegate::InformationList ViewProperties::additionalInfo() const
+QList<QByteArray> ViewProperties::visibleRoles() const
{
- KFileItemDelegate::InformationList usedInfo;
+ // 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,Icons_size
+ //
+ // 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
+ // and date should be shown without creating a .directory file. Only if
+ // 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{"text"};
+
+ // 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();
- switch (m_node->version()) {
- case 1: usedInfo = additionalInfoV1(); break;
- case 2: usedInfo = additionalInfoV2(); break;
- default: kWarning() << "Unknown version of the view properties";
+ 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);
+ }
+ }
}
- return usedInfo;
+ // 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 // "text"
+ && (m_node->viewMode() == DolphinView::DetailsView)
+ && !visibleRoles.contains(CustomizedDetailsString);
+ if (useDefaultValues) {
+ roles.append("size");
+ 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());
- setShowPreview(props.showPreview());
- setShowHiddenFiles(props.showHiddenFiles());
- setCategorizedSorting(props.categorizedSorting());
- setSorting(props.sorting());
+ setPreviewsShown(props.previewsShown());
+ setHiddenFilesShown(props.hiddenFilesShown());
+ setGroupedSorting(props.groupedSorting());
+ setSortRole(props.sortRole());
setSortOrder(props.sortOrder());
setSortFoldersFirst(props.sortFoldersFirst());
- setAdditionalInfo(props.additionalInfo());
+ setVisibleRoles(props.visibleRoles());
+ setHeaderColumnWidths(props.headerColumnWidths());
+ m_node->setVersion(props.m_node->version());
}
void ViewProperties::setAutoSaveEnabled(bool autoSave)
{
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()
{
- 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;
}
-KFileItemDelegate::InformationList ViewProperties::additionalInfoV1() const
+QString ViewProperties::viewModePrefix() const
{
- KFileItemDelegate::InformationList usedInfo;
-
- int decodedInfo = m_node->additionalInfo();
+ QString prefix;
- 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;
+ switch (m_node->viewMode()) {
+ 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";
}
- AdditionalInfoAccessor& infoAccessor = AdditionalInfoAccessor::instance();
- const KFileItemDelegate::InformationList infoKeys = infoAccessor.keys();
+ return prefix;
+}
- foreach (const KFileItemDelegate::Information info, infoKeys) {
- if (decodedInfo & infoAccessor.bitValue(info)) {
- usedInfo.append(info);
+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);
}
}
- return usedInfo;
+ m_node->setAdditionalInfo(QStringList());
+ m_node->setVisibleRoles(visibleRoles);
+ m_node->setVersion(AdditionalInfoViewPropertiesVersion);
+ update();
}
-KFileItemDelegate::InformationList ViewProperties::additionalInfoV2() const
+void ViewProperties::convertNameRoleToTextRole()
{
- // 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.
+ 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";
+ }
+ }
- KFileItemDelegate::InformationList usedInfo;
+ 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();
+}
- // 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);
+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";
}
}
- // 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));
- }
+ QString sortRole = m_node->sortRole();
+ if (sortRole == QLatin1String("date")) {
+ sortRole = QStringLiteral("modificationtime");
}
- return usedInfo;
+ m_node->setVisibleRoles(visibleRoles);
+ m_node->setSortRole(sortRole);
+ m_node->setVersion(DateRolePropertiesVersion);
+ update();
}
-QString ViewProperties::viewModePrefix() const
+bool ViewProperties::isPartOfHome(const QString& filePath)
{
- 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";
+ // 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 prefix;
+ 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