src/views/viewproperties.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2006-2010 by Peter Penz <peter.penz@gmx.at>             *
   3  *   Copyright (C) 2006 by Aaron J. Seigo <aseigo@kde.org>                 *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
  19  ***************************************************************************/
  20
  21 #include "viewproperties.h"
  22
  23 #include "additionalinfoaccessor.h"
  24 #include "dolphin_directoryviewpropertysettings.h"
  25 #include "dolphin_generalsettings.h"
  26
  27 #include <KComponentData>
  28 #include <KLocale>
  29 #include <KStandardDirs>
  30 #include <KUrl>
  31
  32 #include <QDate>
  33 #include <QFile>
  34 #include <QFileInfo>
  35
  36 #include "settings/dolphinsettings.h"
  37
  38 namespace {
  39     // String representation to mark the additional properties of
  40     // the details view as customized by the user. See
  41     // ViewProperties::additionalInfoV2() for more information.
  42     const char* CustomizedDetailsString = "CustomizedDetails";
  43 }
  44
  45 ViewProperties::ViewProperties(const KUrl& url) :
  46     m_changedProps(false),
  47     m_autoSave(true),
  48     m_node(0)
  49 {
  50     GeneralSettings* settings = DolphinSettings::instance().generalSettings();
  51     const bool useGlobalViewProps = settings->globalViewProps();
  52     bool useDetailsViewWithPath = false;
  53
  54     // We try and save it to the file .directory in the directory being viewed.
  55     // If the directory is not writable by the user or the directory is not local,
  56     // we store the properties information in a local file.
  57     if (useGlobalViewProps) {
  58         m_filePath = destinationDir("global");
  59     } else if (url.protocol().contains("search")) {
  60         m_filePath = destinationDir("search");
  61         useDetailsViewWithPath = true;
  62     } else if (url.protocol() == QLatin1String("trash")) {
  63         m_filePath = destinationDir("trash");
  64         useDetailsViewWithPath = true;
  65     } else if (url.isLocalFile()) {
  66         m_filePath = url.toLocalFile();
  67         const QFileInfo info(m_filePath);
  68         if (!info.isWritable() || !isPartOfHome(m_filePath)) {
  69             m_filePath = destinationDir("local") + m_filePath;
  70         }
  71     } else {
  72         m_filePath = destinationDir("remote") + m_filePath;
  73     }
  74
  75     const QString file = m_filePath + QDir::separator() + QLatin1String(".directory");
  76     m_node = new ViewPropertySettings(KSharedConfig::openConfig(file));
  77
  78     // If the .directory file does not exist or the timestamp is too old,
  79     // use default values instead.
  80     const bool useDefaultProps = (!useGlobalViewProps || useDetailsViewWithPath) &&
  81                                  (!QFileInfo(file).exists() ||
  82                                   (m_node->timestamp() < settings->viewPropsTimestamp()));
  83     if (useDefaultProps) {
  84         if (useDetailsViewWithPath) {
  85             setViewMode(DolphinView::DetailsView);
  86             setAdditionalInfo(KFileItemDelegate::InformationList() << KFileItemDelegate::LocalPathOrUrl);
  87         } else {
  88             // The global view-properties act as default for directories without
  89             // any view-property configuration
  90             settings->setGlobalViewProps(true);
  91
  92             ViewProperties defaultProps(url);
  93             setDirProperties(defaultProps);
  94
  95             settings->setGlobalViewProps(false);
  96             m_changedProps = false;
  97         }
  98     }
  99 }
 100
 101 ViewProperties::~ViewProperties()
 102 {
 103     if (m_changedProps && m_autoSave) {
 104         save();
 105     }
 106
 107     delete m_node;
 108     m_node = 0;
 109 }
 110
 111 void ViewProperties::setViewMode(DolphinView::Mode mode)
 112 {
 113     if (m_node->viewMode() != mode) {
 114         m_node->setViewMode(mode);
 115         update();
 116     }
 117 }
 118
 119 DolphinView::Mode ViewProperties::viewMode() const
 120 {
 121     return static_cast<DolphinView::Mode>(m_node->viewMode());
 122 }
 123
 124 void ViewProperties::setShowPreview(bool show)
 125 {
 126     if (m_node->showPreview() != show) {
 127         m_node->setShowPreview(show);
 128         update();
 129     }
 130 }
 131
 132 bool ViewProperties::showPreview() const
 133 {
 134     return m_node->showPreview();
 135 }
 136
 137 void ViewProperties::setShowHiddenFiles(bool show)
 138 {
 139     if (m_node->showHiddenFiles() != show) {
 140         m_node->setShowHiddenFiles(show);
 141         update();
 142     }
 143 }
 144
 145 void ViewProperties::setCategorizedSorting(bool categorized)
 146 {
 147     if (m_node->categorizedSorting() != categorized) {
 148         m_node->setCategorizedSorting(categorized);
 149         update();
 150     }
 151 }
 152
 153 bool ViewProperties::categorizedSorting() const
 154 {
 155     return m_node->categorizedSorting();
 156 }
 157
 158 bool ViewProperties::showHiddenFiles() const
 159 {
 160     return m_node->showHiddenFiles();
 161 }
 162
 163 void ViewProperties::setSorting(DolphinView::Sorting sorting)
 164 {
 165     if (m_node->sorting() != sorting) {
 166         m_node->setSorting(sorting);
 167         update();
 168     }
 169 }
 170
 171 DolphinView::Sorting ViewProperties::sorting() const
 172 {
 173     return static_cast<DolphinView::Sorting>(m_node->sorting());
 174 }
 175
 176 void ViewProperties::setSortOrder(Qt::SortOrder sortOrder)
 177 {
 178     if (m_node->sortOrder() != sortOrder) {
 179         m_node->setSortOrder(sortOrder);
 180         update();
 181     }
 182 }
 183
 184 Qt::SortOrder ViewProperties::sortOrder() const
 185 {
 186     return static_cast<Qt::SortOrder>(m_node->sortOrder());
 187 }
 188
 189 void ViewProperties::setSortFoldersFirst(bool foldersFirst)
 190 {
 191     if (m_node->sortFoldersFirst() != foldersFirst) {
 192         m_node->setSortFoldersFirst(foldersFirst);
 193         update();
 194     }
 195 }
 196
 197 bool ViewProperties::sortFoldersFirst() const
 198 {
 199     return m_node->sortFoldersFirst();
 200 }
 201
 202 void ViewProperties::setAdditionalInfo(const KFileItemDelegate::InformationList& list)
 203 {
 204     // See ViewProperties::additionalInfoV2() for the storage format
 205     // of the additional information.
 206
 207     // Remove the old values stored for the current view-mode
 208     const QStringList oldInfoStringList = m_node->additionalInfoV2();
 209     const QString prefix = viewModePrefix();
 210     QStringList newInfoStringList = oldInfoStringList;
 211     for (int i = newInfoStringList.count() - 1; i >= 0; --i) {
 212         if (newInfoStringList.at(i).startsWith(prefix)) {
 213             newInfoStringList.removeAt(i);
 214         }
 215     }
 216
 217     // Add the updated values for the current view-mode
 218     AdditionalInfoAccessor& infoAccessor = AdditionalInfoAccessor::instance();
 219     foreach (KFileItemDelegate::Information info, list) {
 220         newInfoStringList.append(prefix + infoAccessor.value(info));
 221     }
 222
 223     // Only update the information if it has been changed
 224     bool changed = oldInfoStringList.count() != newInfoStringList.count();
 225     if (!changed) {
 226         foreach (const QString& oldInfoString, oldInfoStringList) {
 227             if (!newInfoStringList.contains(oldInfoString)) {
 228                 changed = true;
 229                 break;
 230             }
 231         }
 232     }
 233
 234     if (changed) {
 235         if (m_node->version() < 2) {
 236             m_node->setVersion(2);
 237         }
 238
 239         const bool markCustomizedDetails = (m_node->viewMode() == DolphinView::DetailsView)
 240                                            && !newInfoStringList.contains(CustomizedDetailsString);
 241         if (markCustomizedDetails) {
 242             // The additional information of the details-view has been modified. Set a marker,
 243             // so that it is allowed to also show no additional information
 244             // (see fallback in ViewProperties::additionalInfoV2, if no additional information is
 245             // available).
 246             newInfoStringList.append(CustomizedDetailsString);
 247         }
 248
 249         m_node->setAdditionalInfoV2(newInfoStringList);
 250         update();
 251     }
 252 }
 253
 254 KFileItemDelegate::InformationList ViewProperties::additionalInfo() const
 255 {
 256     KFileItemDelegate::InformationList usedInfo;
 257
 258     switch (m_node->version()) {
 259     case 1: usedInfo = additionalInfoV1(); break;
 260     case 2: usedInfo = additionalInfoV2(); break;
 261     default: kWarning() << "Unknown version of the view properties";
 262     }
 263
 264     return usedInfo;
 265 }
 266
 267
 268 void ViewProperties::setDirProperties(const ViewProperties& props)
 269 {
 270     setViewMode(props.viewMode());
 271     setShowPreview(props.showPreview());
 272     setShowHiddenFiles(props.showHiddenFiles());
 273     setCategorizedSorting(props.categorizedSorting());
 274     setSorting(props.sorting());
 275     setSortOrder(props.sortOrder());
 276     setSortFoldersFirst(props.sortFoldersFirst());
 277     setAdditionalInfo(props.additionalInfo());
 278 }
 279
 280 void ViewProperties::setAutoSaveEnabled(bool autoSave)
 281 {
 282     m_autoSave = autoSave;
 283 }
 284
 285 bool ViewProperties::isAutoSaveEnabled() const
 286 {
 287     return m_autoSave;
 288 }
 289
 290 void ViewProperties::update()
 291 {
 292     m_changedProps = true;
 293     m_node->setTimestamp(QDateTime::currentDateTime());
 294
 295     // If the view-properties are stored in an older format, take
 296     // care to update them to the current format.
 297     switch (m_node->version()) {
 298     case 1: {
 299         const KFileItemDelegate::InformationList infoList = additionalInfoV1();
 300         m_node->setVersion(2);
 301         setAdditionalInfo(infoList);
 302         break;
 303     }
 304     case 2:
 305         // Current version. Nothing needs to get converted.
 306         break;
 307     default:
 308         kWarning() << "Unknown version of the view properties";
 309     }
 310 }
 311
 312 void ViewProperties::save()
 313 {
 314     KStandardDirs::makeDir(m_filePath);
 315     m_node->writeConfig();
 316     m_changedProps = false;
 317 }
 318
 319 KUrl ViewProperties::mirroredDirectory()
 320 {
 321     QString basePath = KGlobal::mainComponent().componentName();
 322     basePath.append("/view_properties/");
 323     return KUrl(KStandardDirs::locateLocal("data", basePath));
 324 }
 325
 326 QString ViewProperties::destinationDir(const QString& subDir) const
 327 {
 328     QString basePath = KGlobal::mainComponent().componentName();
 329     basePath.append("/view_properties/").append(subDir);
 330     return KStandardDirs::locateLocal("data", basePath);
 331 }
 332
 333 KFileItemDelegate::InformationList ViewProperties::additionalInfoV1() const
 334 {
 335     KFileItemDelegate::InformationList usedInfo;
 336
 337     int decodedInfo = m_node->additionalInfo();
 338
 339     switch (viewMode()) {
 340     case DolphinView::DetailsView:
 341         decodedInfo = decodedInfo & 0xFF;
 342         if (decodedInfo == 0) {
 343             // A details view without any additional info makes no sense, hence
 344             // provide at least a size-info and date-info as fallback
 345             AdditionalInfoAccessor& infoAccessor = AdditionalInfoAccessor::instance();
 346             decodedInfo = infoAccessor.bitValue(KFileItemDelegate::Size) |
 347                           infoAccessor.bitValue(KFileItemDelegate::ModificationTime);
 348         }
 349         break;
 350     case DolphinView::IconsView:
 351         decodedInfo = (decodedInfo >> 8) & 0xFF;
 352         break;
 353     case DolphinView::ColumnView:
 354         decodedInfo = (decodedInfo >> 16) & 0xFF;
 355         break;
 356     default: break;
 357     }
 358
 359     AdditionalInfoAccessor& infoAccessor = AdditionalInfoAccessor::instance();
 360     const KFileItemDelegate::InformationList infoKeys = infoAccessor.keys();
 361
 362     foreach (const KFileItemDelegate::Information info, infoKeys) {
 363         if (decodedInfo & infoAccessor.bitValue(info)) {
 364             usedInfo.append(info);
 365         }
 366     }
 367
 368     return usedInfo;
 369 }
 370
 371 KFileItemDelegate::InformationList ViewProperties::additionalInfoV2() const
 372 {
 373     // The shown additional information is stored for each view-mode separately as
 374     // string with the view-mode as prefix. Example:
 375     //
 376     // AdditionalInfoV2=Details_Size,Details_Date,Details_Owner,Icon_Size
 377     //
 378     // To get the representation as KFileItemDelegate::InformationList, the current
 379     // view-mode must be checked and the values of this mode added to the list.
 380     //
 381     // For the details-view a special case must be respected: Per default the size
 382     // and date should be shown without creating a .directory file. Only if
 383     // the user explictly has modified the properties of the details view (marked
 384     // by "CustomizedDetails"), also a details-view with no additional information
 385     // is accepted.
 386
 387     KFileItemDelegate::InformationList usedInfo;
 388
 389     // infoHash allows to get the mapped KFileItemDelegate::Information value
 390     // for a stored string-value in a fast way
 391     static QHash<QString, KFileItemDelegate::Information> infoHash;
 392     if (infoHash.isEmpty()) {
 393         AdditionalInfoAccessor& infoAccessor = AdditionalInfoAccessor::instance();
 394         const KFileItemDelegate::InformationList keys = infoAccessor.keys();
 395         foreach (const KFileItemDelegate::Information key, keys) {
 396             infoHash.insert(infoAccessor.value(key), key);
 397         }
 398     }
 399
 400     // Iterate through all stored keys stored as strings and map them to
 401     // the corresponding KFileItemDelegate::Information values.
 402     const QString prefix = viewModePrefix();
 403     const int prefixLength = prefix.length();
 404     const QStringList infoStringList = m_node->additionalInfoV2();
 405     foreach (const QString& infoString, infoStringList) {
 406         if (infoString.startsWith(prefix)) {
 407             const QString key = infoString.right(infoString.length() - prefixLength);
 408             Q_ASSERT(infoHash.contains(key));
 409             usedInfo.append(infoHash.value(key));
 410         }
 411     }
 412
 413     // For the details view the size and date should be shown per default
 414     // until the additional information has been explicitly changed by the user
 415     const bool useDefaultValues = usedInfo.isEmpty()
 416                                   && (m_node->viewMode() == DolphinView::DetailsView)
 417                                   && !infoStringList.contains(CustomizedDetailsString);
 418     if (useDefaultValues) {
 419         usedInfo.append(KFileItemDelegate::Size);
 420         usedInfo.append(KFileItemDelegate::ModificationTime);
 421     }
 422
 423     return usedInfo;
 424 }
 425
 426 QString ViewProperties::viewModePrefix() const
 427 {
 428     QString prefix;
 429
 430     switch (m_node->viewMode()) {
 431     case DolphinView::DetailsView: prefix = "Details_"; break;
 432     case DolphinView::IconsView:   prefix = "Icons_"; break;
 433     case DolphinView::ColumnView:  prefix = "Column_"; break;
 434     default: kWarning() << "Unknown view-mode of the view properties";
 435     }
 436
 437     return prefix;
 438 }
 439
 440 bool ViewProperties::isPartOfHome(const QString& filePath)
 441 {
 442     // For performance reasons cache the path in a static QString
 443     // (see QDir::homePath() for more details)
 444     static QString homePath;
 445     if (homePath.isEmpty()) {
 446         homePath = QDir::homePath();
 447         Q_ASSERT(!homePath.isEmpty());
 448     }
 449
 450     return filePath.startsWith(homePath);
 451 }