X-Git-Url: https://cloud.milkyroute.net/gitweb/dolphin.git/blobdiff_plain/d705172166c761c06b5fd1daf8cfea9315584e77..59d01e8accbfb7f31fb5ea5ef4c94e57d427994a:/src/views/viewproperties.cpp diff --git a/src/views/viewproperties.cpp b/src/views/viewproperties.cpp index dac951f09..bcea06253 100644 --- a/src/views/viewproperties.cpp +++ b/src/views/viewproperties.cpp @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2006-2010 by Peter Penz * + * Copyright (C) 2006-2010 by Peter Penz * * Copyright (C) 2006 by Aaron J. Seigo * * * * This program is free software; you can redistribute it and/or modify * @@ -20,60 +20,113 @@ #include "viewproperties.h" -#include "additionalinfoaccessor.h" #include "dolphin_directoryviewpropertysettings.h" #include "dolphin_generalsettings.h" -#include -#include -#include -#include +#include +#include +#include +#include +#include +#include +#include #include #include #include -#include "settings/dolphinsettings.h" +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 + // 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) : m_changedProps(false), m_autoSave(true), m_node(0) { + GeneralSettings* settings = GeneralSettings::self(); + 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. - GeneralSettings* settings = DolphinSettings::instance().generalSettings(); - const bool useGlobalViewProps = settings->globalViewProps(); if (useGlobalViewProps) { m_filePath = destinationDir("global"); + } else if (url.protocol().contains("search")) { + m_filePath = destinationDir("search/") + directoryHashForUrl(url); + 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()) { + 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; } - const QString file = m_filePath + QDir::separator() + QLatin1String(".directory"); + const QString file = m_filePath + QDir::separator() + ViewPropertiesFileName; m_node = new ViewPropertySettings(KSharedConfig::openConfig(file)); - const bool useDefaultProps = !useGlobalViewProps && - (!QFileInfo(file).exists() || + // If the .directory file does not exist or the timestamp is too old, + // use default values instead. + const bool useDefaultProps = (!useGlobalViewProps || useDetailsViewWithPath) && + (!QFile::exists(file) || (m_node->timestamp() < settings->viewPropsTimestamp())); if (useDefaultProps) { - // If the .directory file does not exist or the timestamp is too old, - // use the values from the global .directory file instead, which acts - // as default view for new folders in this case. - settings->setGlobalViewProps(true); + if (useDetailsViewWithPath) { + setViewMode(DolphinView::DetailsView); + setVisibleRoles(QList() << "path"); + } else { + // The global view-properties act as default for directories without + // any view-property configuration. Constructing a ViewProperties + // instance for an empty KUrl ensures that the global view-properties + // are loaded. + KUrl emptyUrl; + ViewProperties defaultProps(emptyUrl); + setDirProperties(defaultProps); + + m_changedProps = false; + } + } - ViewProperties defaultProps(url); - setDirProperties(defaultProps); + 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); + } - settings->setGlobalViewProps(false); - m_changedProps = false; + if (m_node->version() < NameRolePropertiesVersion) { + convertNameRoleToTextRole(); + Q_ASSERT(m_node->version() == NameRolePropertiesVersion); + } + + m_node->setVersion(CurrentViewPropertiesVersion); } } @@ -91,72 +144,73 @@ void ViewProperties::setViewMode(DolphinView::Mode mode) { if (m_node->viewMode() != mode) { m_node->setViewMode(mode); - updateTimeStamp(); + update(); } } DolphinView::Mode ViewProperties::viewMode() const { - return static_cast(m_node->viewMode()); + const int mode = qBound(0, m_node->viewMode(), 2); + return static_cast(mode); } -void ViewProperties::setShowPreview(bool show) +void ViewProperties::setPreviewsShown(bool show) { - if (m_node->showPreview() != show) { - m_node->setShowPreview(show); - updateTimeStamp(); + 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); - updateTimeStamp(); + 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); - updateTimeStamp(); + 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); - updateTimeStamp(); + if (m_node->sortRole() != role) { + m_node->setSortRole(role); + update(); } } -DolphinView::Sorting ViewProperties::sorting() const +QByteArray ViewProperties::sortRole() const { - return static_cast(m_node->sorting()); + return m_node->sortRole().toLatin1(); } void ViewProperties::setSortOrder(Qt::SortOrder sortOrder) { if (m_node->sortOrder() != sortOrder) { m_node->setSortOrder(sortOrder); - updateTimeStamp(); + update(); } } @@ -169,7 +223,7 @@ void ViewProperties::setSortFoldersFirst(bool foldersFirst) { if (m_node->sortFoldersFirst() != foldersFirst) { m_node->setSortFoldersFirst(foldersFirst); - updateTimeStamp(); + update(); } } @@ -178,51 +232,117 @@ bool ViewProperties::sortFoldersFirst() const return m_node->sortFoldersFirst(); } -void ViewProperties::setAdditionalInfo(const KFileItemDelegate::InformationList& list) +void ViewProperties::setVisibleRoles(const QList& roles) { - AdditionalInfoAccessor& infoAccessor = AdditionalInfoAccessor::instance(); + 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 oldVisibleRoles = m_node->visibleRoles(); + const QString prefix = viewModePrefix(); + QStringList newVisibleRoles = oldVisibleRoles; + for (int i = newVisibleRoles.count() - 1; i >= 0; --i) { + if (newVisibleRoles[i].startsWith(prefix)) { + newVisibleRoles.removeAt(i); + } + } - int infoMask = 0; - foreach (KFileItemDelegate::Information currentInfo, list) { - infoMask = infoMask | infoAccessor.bitValue(currentInfo); + // Add the updated values for the current view-mode + foreach (const QByteArray& role, roles) { + newVisibleRoles.append(prefix + role); } - const int encodedInfo = encodedAdditionalInfo(infoMask); - if (m_node->additionalInfo() != encodedInfo) { - m_node->setAdditionalInfo(encodedInfo); - updateTimeStamp(); + 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); + } + + m_node->setVisibleRoles(newVisibleRoles); + update(); } } -KFileItemDelegate::InformationList ViewProperties::additionalInfo() const +QList ViewProperties::visibleRoles() const { - KFileItemDelegate::InformationList usedInfos; + // 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, 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. + + QList roles; + roles.append("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(); + + 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); + } + } + } - const int decodedInfo = decodedAdditionalInfo(); + // 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("date"); + } - AdditionalInfoAccessor& infoAccessor = AdditionalInfoAccessor::instance(); - const KFileItemDelegate::InformationList infoKeys = infoAccessor.keys(); + return roles; +} - foreach (const KFileItemDelegate::Information info, infoKeys) { - if (decodedInfo & infoAccessor.bitValue(info)) { - usedInfos.append(info); - } +void ViewProperties::setHeaderColumnWidths(const QList& widths) +{ + if (m_node->headerColumnWidths() != widths) { + m_node->setHeaderColumnWidths(widths); + update(); } - - return usedInfos; } +QList 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) @@ -235,7 +355,7 @@ bool ViewProperties::isAutoSaveEnabled() const return m_autoSave; } -void ViewProperties::updateTimeStamp() +void ViewProperties::update() { m_changedProps = true; m_node->setTimestamp(QDateTime::currentDateTime()); @@ -243,16 +363,17 @@ void ViewProperties::updateTimeStamp() void ViewProperties::save() { + kDebug() << "Saving view-properties to" << m_filePath; KStandardDirs::makeDir(m_filePath); + m_node->setVersion(CurrentViewPropertiesVersion); 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 @@ -262,49 +383,98 @@ QString ViewProperties::destinationDir(const QString& subDir) const return KStandardDirs::locateLocal("data", basePath); } -int ViewProperties::encodedAdditionalInfo(int info) const +QString ViewProperties::viewModePrefix() const { - int encodedInfo = m_node->additionalInfo(); + QString prefix; - 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; + 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"; } - return encodedInfo; + return prefix; } -int ViewProperties::decodedAdditionalInfo() const +void ViewProperties::convertAdditionalInfo() { - int decodedInfo = m_node->additionalInfo(); + 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(); +} - 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); +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"; } - break; - case DolphinView::IconsView: - decodedInfo = (decodedInfo >> 8) & 0xFF; - break; - case DolphinView::ColumnView: - decodedInfo = (decodedInfo >> 16) & 0xFF; - break; - default: break; } - return decodedInfo; + 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 + // (see QDir::homePath() for more details) + static QString homePath; + if (homePath.isEmpty()) { + homePath = QDir::homePath(); + Q_ASSERT(!homePath.isEmpty()); + } + + return filePath.startsWith(homePath); +} + +QString ViewProperties::directoryHashForUrl(const KUrl& url) +{ + const QByteArray hashValue = QCryptographicHash::hash(url.prettyUrl().toLatin1(), + QCryptographicHash::Sha1); + QString hashString = hashValue.toBase64(); + hashString.replace('/', '-'); + return hashString; +} + +KUrl ViewProperties::mirroredDirectory() +{ + QString basePath = KGlobal::mainComponent().componentName(); + basePath.append("/view_properties/"); + return KUrl(KStandardDirs::locateLocal("data", basePath)); }