X-Git-Url: https://cloud.milkyroute.net/gitweb/dolphin.git/blobdiff_plain/769d1470267247efdffe8b9a2464f21c905d195d..04e493d78cdf46e64562fe8a302426b1fd8c47df:/src/views/viewproperties.cpp diff --git a/src/views/viewproperties.cpp b/src/views/viewproperties.cpp index 2bfdfe81b..8bf3b2531 100644 --- a/src/views/viewproperties.cpp +++ b/src/views/viewproperties.cpp @@ -12,52 +12,124 @@ #include "dolphindebug.h" #include +#include #include +#include -namespace { - const int AdditionalInfoViewPropertiesVersion = 1; - const int NameRolePropertiesVersion = 2; - const int DateRolePropertiesVersion = 4; - const int CurrentViewPropertiesVersion = 4; +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"; + +// Filename that is used for storing the properties +const char ViewPropertiesFileName[] = ".directory"; +} + +ViewPropertySettings *ViewProperties::loadProperties(const QString &folderPath) const +{ + const QString settingsFile = folderPath + QDir::separator() + ViewPropertiesFileName; + + KFileMetaData::UserMetaData metadata(folderPath); + if (!metadata.isSupported()) { + return new ViewPropertySettings(KSharedConfig::openConfig(settingsFile, KConfig::SimpleConfig)); + } + + std::unique_ptr tempFile(new QTemporaryFile()); + tempFile->setAutoRemove(false); + if (!tempFile->open()) { + qCWarning(DolphinDebug) << "Could not open temp file"; + return nullptr; + } + if (QFile::exists(settingsFile)) { + // copy settings to tempfile to load them separately + QFile::remove(tempFile->fileName()); + QFile::copy(settingsFile, tempFile->fileName()); + + auto config = KConfig(tempFile->fileName(), KConfig::SimpleConfig); + // ignore settings that are outside of dolphin scope + if (config.hasGroup("Dolphin") || config.hasGroup("Settings")) { + const auto groupList = config.groupList(); + for (const auto &group : groupList) { + if (group != QStringLiteral("Dolphin") && group != QStringLiteral("Settings")) { + config.deleteGroup(group); + } + } + return new ViewPropertySettings(KSharedConfig::openConfig(tempFile->fileName(), KConfig::SimpleConfig)); + + } else if (!config.groupList().isEmpty()) { + // clear temp file content + QFile::remove(tempFile->fileName()); + } + } - // 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"; + // load from metadata + const QString viewPropertiesString = metadata.attribute(QStringLiteral("kde.fm.viewproperties#1")); + if (viewPropertiesString.isEmpty()) { + return nullptr; + } + // load view properties from xattr to temp file then loads into ViewPropertySettings + QFile outputFile(tempFile->fileName()); + outputFile.open(QIODevice::WriteOnly); + outputFile.write(viewPropertiesString.toUtf8()); + outputFile.close(); + return new ViewPropertySettings(KSharedConfig::openConfig(tempFile->fileName(), KConfig::SimpleConfig)); +} + +ViewPropertySettings *ViewProperties::defaultProperties() const +{ + auto props = loadProperties(destinationDir(QStringLiteral("global"))); + if (props == nullptr) { + qCWarning(DolphinDebug) << "Could not load default global viewproperties"; + QTemporaryFile tempFile; + tempFile.setAutoRemove(false); + if (!tempFile.open()) { + qCWarning(DolphinDebug) << "Could not open temp file"; + props = new ViewPropertySettings; + } else { + props = new ViewPropertySettings(KSharedConfig::openConfig(tempFile.fileName(), KConfig::SimpleConfig)); + } + } - // Filename that is used for storing the properties - const char ViewPropertiesFileName[] = ".directory"; + return props; } -ViewProperties::ViewProperties(const QUrl& url) : - m_changedProps(false), - m_autoSave(true), - m_node(nullptr) +ViewProperties::ViewProperties(const QUrl &url) + : m_changedProps(false) + , m_autoSave(true) + , m_node(nullptr) { - GeneralSettings* settings = GeneralSettings::self(); + GeneralSettings *settings = GeneralSettings::self(); const bool useGlobalViewProps = settings->globalViewProps() || url.isEmpty(); - bool useDetailsViewWithPath = false; + bool useSearchView = false; + bool useTrashView = 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(QStringLiteral("global")); - } else if (url.scheme().contains(QLatin1String("search"))) { + if (url.scheme().contains(QLatin1String("search"))) { m_filePath = destinationDir(QStringLiteral("search/")) + directoryHashForUrl(url); - useDetailsViewWithPath = true; + useSearchView = 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; + useTrashView = true; } else if (url.scheme() == QLatin1String("recentlyused")) { m_filePath = destinationDir(QStringLiteral("recentlyused")); useRecentDocumentsView = true; + } else if (url.scheme() == QLatin1String("timeline")) { + m_filePath = destinationDir(QStringLiteral("timeline")); + useRecentDocumentsView = true; + } else if (useGlobalViewProps) { + m_filePath = destinationDir(QStringLiteral("global")); } else if (url.isLocalFile()) { m_filePath = url.toLocalFile(); @@ -74,10 +146,10 @@ ViewProperties::ViewProperties(const QUrl& url) : } if (useDestinationDir) { - #ifdef Q_OS_WIN +#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 = QDir::separator() + m_filePath.remove(QLatin1Char(':')); +#endif m_filePath = destinationDir(QStringLiteral("local")) + m_filePath; } @@ -88,38 +160,56 @@ ViewProperties::ViewProperties(const QUrl& url) : m_filePath = destinationDir(QStringLiteral("remote")) + m_filePath; } - const QString file = m_filePath + QDir::separator() + ViewPropertiesFileName; - m_node = new ViewPropertySettings(KSharedConfig::openConfig(file)); + m_node = loadProperties(m_filePath); + + bool useDefaultSettings = useGlobalViewProps || + // If the props timestamp is too old, + // use default values instead. + (m_node != nullptr && (!useGlobalViewProps || useSearchView || useTrashView || useRecentDocumentsView || useDownloadsView) + && m_node->timestamp() < settings->viewPropsTimestamp()); + + if (m_node == nullptr) { + // no settings found for m_filepath, load defaults + m_node = defaultProperties(); + useDefaultSettings = true; + } + + // default values for special directories + if (useDefaultSettings) { + if (useSearchView) { + const QString path = url.path(); - // 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 (useDetailsViewWithPath) { + if (path == QLatin1String("/images")) { + setViewMode(DolphinView::IconsView); + setPreviewsShown(true); + setVisibleRoles({"text", "dimensions", "imageDateTime"}); + } else if (path == QLatin1String("/audio")) { + setViewMode(DolphinView::DetailsView); + setVisibleRoles({"text", "artist", "album", "duration"}); + } else if (path == QLatin1String("/videos")) { + setViewMode(DolphinView::IconsView); + setPreviewsShown(true); + setVisibleRoles({"text"}); + } else { + setViewMode(DolphinView::DetailsView); + setVisibleRoles({"text", "path", "modificationtime"}); + } + } else if (useTrashView) { setViewMode(DolphinView::DetailsView); - setVisibleRoles({"path"}); + setVisibleRoles({"text", "path", "deletiontime"}); } else if (useRecentDocumentsView || useDownloadsView) { - setSortRole(QByteArrayLiteral("modificationtime")); setSortOrder(Qt::DescendingOrder); + setSortFoldersFirst(false); + setGroupedSorting(true); if (useRecentDocumentsView) { + setSortRole(QByteArrayLiteral("accesstime")); setViewMode(DolphinView::DetailsView); - setVisibleRoles({QByteArrayLiteral("path")}); - } else if (useDownloadsView) { - setSortFoldersFirst(false); - setGroupedSorting(true); + setVisibleRoles({"text", "path", "accesstime"}); + } else { + setSortRole(QByteArrayLiteral("modificationtime")); } } else { - // The global view-properties act as default for directories without - // 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); - m_changedProps = false; } } @@ -152,6 +242,11 @@ ViewProperties::~ViewProperties() save(); } + if (!m_node->config()->name().endsWith(ViewPropertiesFileName)) { + // remove temp file + QFile::remove(m_node->config()->name()); + } + delete m_node; m_node = nullptr; } @@ -209,7 +304,7 @@ bool ViewProperties::hiddenFilesShown() const return m_node->hiddenFilesShown(); } -void ViewProperties::setSortRole(const QByteArray& role) +void ViewProperties::setSortRole(const QByteArray &role) { if (m_node->sortRole() != role) { m_node->setSortRole(role); @@ -261,7 +356,20 @@ bool ViewProperties::sortHiddenLast() const return m_node->sortHiddenLast(); } -void ViewProperties::setVisibleRoles(const QList& roles) +void ViewProperties::setDynamicViewPassed(bool dynamicViewPassed) +{ + if (m_node->dynamicViewPassed() != dynamicViewPassed) { + m_node->setDynamicViewPassed(dynamicViewPassed); + update(); + } +} + +bool ViewProperties::dynamicViewPassed() const +{ + return m_node->dynamicViewPassed(); +} + +void ViewProperties::setVisibleRoles(const QList &roles) { if (roles == visibleRoles()) { return; @@ -282,13 +390,12 @@ void ViewProperties::setVisibleRoles(const QList& roles) // Add the updated values for the current view-mode newVisibleRoles.reserve(roles.count()); - for (const QByteArray& role : roles) { + for (const QByteArray &role : roles) { newVisibleRoles.append(prefix + role); } if (oldVisibleRoles != newVisibleRoles) { - const bool markCustomizedDetails = (m_node->viewMode() == DolphinView::DetailsView) - && !newVisibleRoles.contains(CustomizedDetailsString); + 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 @@ -325,7 +432,7 @@ QList ViewProperties::visibleRoles() const const int prefixLength = prefix.length(); const QStringList visibleRoles = m_node->visibleRoles(); - for (const QString& visibleRole : visibleRoles) { + for (const QString &visibleRole : visibleRoles) { if (visibleRole.startsWith(prefix)) { const QByteArray role = visibleRole.right(visibleRole.length() - prefixLength).toLatin1(); if (role != "text") { @@ -337,8 +444,7 @@ QList ViewProperties::visibleRoles() const // 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); + && (m_node->viewMode() == DolphinView::DetailsView) && !visibleRoles.contains(CustomizedDetailsString); if (useDefaultValues) { roles.append("size"); roles.append("modificationtime"); @@ -347,7 +453,7 @@ QList ViewProperties::visibleRoles() const return roles; } -void ViewProperties::setHeaderColumnWidths(const QList& widths) +void ViewProperties::setHeaderColumnWidths(const QList &widths) { if (m_node->headerColumnWidths() != widths) { m_node->setHeaderColumnWidths(widths); @@ -360,7 +466,7 @@ QList ViewProperties::headerColumnWidths() const return m_node->headerColumnWidths(); } -void ViewProperties::setDirProperties(const ViewProperties& props) +void ViewProperties::setDirProperties(const ViewProperties &props) { setViewMode(props.viewMode()); setPreviewsShown(props.previewsShown()); @@ -394,20 +500,115 @@ void ViewProperties::update() void ViewProperties::save() { qCDebug(DolphinDebug) << "Saving view-properties to" << m_filePath; + + auto cleanDotDirectoryFile = [this]() { + const QString settingsFile = m_filePath + QDir::separator() + ViewPropertiesFileName; + if (QFile::exists(settingsFile)) { + qCDebug(DolphinDebug) << "cleaning .directory" << settingsFile; + KConfig cfg(settingsFile, KConfig::OpenFlag::SimpleConfig); + const auto groupList = cfg.groupList(); + for (const auto &group : groupList) { + if (group == QStringLiteral("Dolphin") || group == QStringLiteral("Settings")) { + cfg.deleteGroup(group); + } + } + if (cfg.groupList().isEmpty()) { + QFile::remove(settingsFile); + } else if (cfg.isDirty()) { + cfg.sync(); + } + } + }; + + // ensures the destination dir exists, in case we don't write metadata directly on the folder + QDir destinationDir(m_filePath); + if (!destinationDir.exists() && !destinationDir.mkpath(m_filePath)) { + qCWarning(DolphinDebug) << "Could not create fake directory to store metadata"; + } + + KFileMetaData::UserMetaData metaData(m_filePath); + if (metaData.isSupported()) { + const auto metaDataKey = QStringLiteral("kde.fm.viewproperties#1"); + + const auto items = m_node->items(); + const auto defaultConfig = defaultProperties(); + bool allDefault = true; + for (const auto item : items) { + if (item->name() == "Timestamp") { + continue; + } + if (item->name() == "Version") { + if (m_node->version() != CurrentViewPropertiesVersion) { + allDefault = false; + break; + } else { + continue; + } + } + auto defaultItem = defaultConfig->findItem(item->name()); + if (!defaultItem || defaultItem->property() != item->property()) { + allDefault = false; + break; + } + } + + if (allDefault) { + if (metaData.hasAttribute(metaDataKey)) { + qCDebug(DolphinDebug) << "clearing extended attributes for " << m_filePath; + const auto result = metaData.setAttribute(metaDataKey, QString()); + if (result != KFileMetaData::UserMetaData::NoError) { + qCWarning(DolphinDebug) << "could not clear extended attributes for " << m_filePath << "error:" << result; + } + } + cleanDotDirectoryFile(); + return; + } + + // save config to disk + if (!m_node->save()) { + qCWarning(DolphinDebug) << "could not save viewproperties" << m_node->config()->name(); + return; + } + + QFile configFile(m_node->config()->name()); + if (!configFile.open(QIODevice::ReadOnly)) { + qCWarning(DolphinDebug) << "Could not open readonly config file" << m_node->config()->name(); + } else { + // load config from disk + const QString viewPropertiesString = configFile.readAll(); + + // save to xattr + const auto result = metaData.setAttribute(metaDataKey, viewPropertiesString); + if (result != KFileMetaData::UserMetaData::NoError) { + if (result == KFileMetaData::UserMetaData::NoSpace) { + // copy settings to dotDirectory file as fallback + if (!configFile.copy(m_filePath + QDir::separator() + ViewPropertiesFileName)) { + qCWarning(DolphinDebug) << "could not write viewproperties to .directory for dir " << m_filePath; + } + // free the space used by viewproperties from the file metadata + metaData.setAttribute(metaDataKey, ""); + } else { + qCWarning(DolphinDebug) << "could not save viewproperties to extended attributes for dir " << m_filePath << "error:" << result; + } + // keep .directory file + return; + } + cleanDotDirectoryFile(); + } + + m_changedProps = false; + return; + } + QDir dir; dir.mkpath(m_filePath); m_node->setVersion(CurrentViewPropertiesVersion); m_node->save(); - m_changedProps = false; -} -bool ViewProperties::exist() const -{ - const QString file = m_filePath + QDir::separator() + ViewPropertiesFileName; - return QFile::exists(file); + m_changedProps = false; } -QString ViewProperties::destinationDir(const QString& subDir) const +QString ViewProperties::destinationDir(const QString &subDir) const { QString path = QStandardPaths::writableLocation(QStandardPaths::AppDataLocation); path.append("/view_properties/").append(subDir); @@ -419,10 +620,17 @@ QString ViewProperties::viewModePrefix() const QString prefix; 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"; + 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; @@ -430,7 +638,7 @@ QString ViewProperties::viewModePrefix() const void ViewProperties::convertAdditionalInfo() { - QStringList visibleRoles; + QStringList visibleRoles = m_node->visibleRoles(); const QStringList additionalInfo = m_node->additionalInfo(); if (!additionalInfo.isEmpty()) { @@ -438,8 +646,8 @@ void ViewProperties::convertAdditionalInfo() // 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()); - for (const QString& info : additionalInfo) { + visibleRoles.reserve(visibleRoles.count() + additionalInfo.count()); + for (const QString &info : additionalInfo) { QString visibleRole = info; int index = visibleRole.indexOf('_'); if (index >= 0 && index + 1 < visibleRole.length()) { @@ -450,7 +658,9 @@ void ViewProperties::convertAdditionalInfo() visibleRole[index] = visibleRole[index].toLower(); } } - visibleRoles.append(visibleRole); + if (!visibleRoles.contains(visibleRole)) { + visibleRoles.append(visibleRole); + } } } @@ -502,7 +712,7 @@ void ViewProperties::convertDateRoleToModificationTimeRole() update(); } -bool ViewProperties::isPartOfHome(const QString& filePath) +bool ViewProperties::isPartOfHome(const QString &filePath) { // For performance reasons cache the path in a static QString // (see QDir::homePath() for more details) @@ -515,7 +725,7 @@ bool ViewProperties::isPartOfHome(const QString& filePath) return filePath.startsWith(homePath); } -QString ViewProperties::directoryHashForUrl(const QUrl& url) +QString ViewProperties::directoryHashForUrl(const QUrl &url) { const QByteArray hashValue = QCryptographicHash::hash(url.toEncoded(), QCryptographicHash::Sha1); QString hashString = hashValue.toBase64();