src/viewproperties.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2006 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 "settings/dolphinsettings.h"
  24 #include "dolphin_directoryviewpropertysettings.h"
  25 #include "dolphin_generalsettings.h"
  26
  27 #include <kcomponentdata.h>
  28 #include <klocale.h>
  29 #include <kstandarddirs.h>
  30 #include <kurl.h>
  31
  32 #ifdef HAVE_NEPOMUK
  33     #include <nepomuk/resourcemanager.h>
  34 #endif
  35
  36 #include <QDate>
  37 #include <QFile>
  38 #include <QFileInfo>
  39
  40 bool ViewProperties::m_nepomukSupport = false;
  41
  42 #define FILE_NAME "/.directory"
  43
  44 ViewProperties::ViewProperties(const KUrl& url) :
  45     m_changedProps(false),
  46     m_autoSave(true),
  47     m_node(0)
  48 {
  49 #ifdef HAVE_NEPOMUK
  50     static bool checkedNepomukSupport = false;
  51     if (!checkedNepomukSupport) {
  52         m_nepomukSupport = !Nepomuk::ResourceManager::instance()->init();
  53         checkedNepomukSupport = true;
  54     }
  55 #endif
  56
  57     KUrl cleanUrl(url);
  58     cleanUrl.cleanPath();
  59     m_filepath = cleanUrl.toLocalFile();
  60
  61     if ((m_filepath.length() < 1) || (!QDir::isAbsolutePath(m_filepath))) {
  62         const QString file = destinationDir("global") + FILE_NAME;
  63         m_node = new ViewPropertySettings(KSharedConfig::openConfig(file));
  64         return;
  65     }
  66
  67     // We try and save it to a file in the directory being viewed.
  68     // If the directory is not writable by the user or the directory is not local,
  69     // we store the properties information in a local file.
  70     GeneralSettings* settings = DolphinSettings::instance().generalSettings();
  71     const bool useGlobalViewProps = settings->globalViewProps();
  72     if (useGlobalViewProps) {
  73         m_filepath = destinationDir("global");
  74     } else if (cleanUrl.isLocalFile()) {
  75         const QFileInfo info(m_filepath);
  76         if (!info.isWritable()) {
  77             m_filepath = destinationDir("local") + m_filepath;
  78         }
  79     } else {
  80         m_filepath = destinationDir("remote") + m_filepath;
  81     }
  82
  83     const QString file = m_filepath + FILE_NAME;
  84     m_node = new ViewPropertySettings(KSharedConfig::openConfig(file));
  85
  86     const bool useDefaultProps = !useGlobalViewProps &&
  87                                  (!QFileInfo(file).exists() ||
  88                                   (m_node->timestamp() < settings->viewPropsTimestamp()));
  89     if (useDefaultProps) {
  90         // If the .directory file does not exist or the timestamp is too old,
  91         // use the values from the global .directory file instead, which acts
  92         // as default view for new folders in this case.
  93         settings->setGlobalViewProps(true);
  94
  95         ViewProperties defaultProps(url);
  96         setDirProperties(defaultProps);
  97
  98         settings->setGlobalViewProps(false);
  99         m_changedProps = false;
 100     }
 101 }
 102
 103 ViewProperties::~ViewProperties()
 104 {
 105     if (m_changedProps && m_autoSave) {
 106         save();
 107     }
 108
 109     delete m_node;
 110     m_node = 0;
 111 }
 112
 113 void ViewProperties::setViewMode(DolphinView::Mode mode)
 114 {
 115     if (m_node->viewMode() != mode) {
 116         m_node->setViewMode(mode);
 117         updateTimeStamp();
 118     }
 119 }
 120
 121 DolphinView::Mode ViewProperties::viewMode() const
 122 {
 123     return static_cast<DolphinView::Mode>(m_node->viewMode());
 124 }
 125
 126 void ViewProperties::setShowPreview(bool show)
 127 {
 128     if (m_node->showPreview() != show) {
 129         m_node->setShowPreview(show);
 130         updateTimeStamp();
 131     }
 132 }
 133
 134 bool ViewProperties::showPreview() const
 135 {
 136     return m_node->showPreview();
 137 }
 138
 139
 140 void ViewProperties::setShowHiddenFiles(bool show)
 141 {
 142     if (m_node->showHiddenFiles() != show) {
 143         m_node->setShowHiddenFiles(show);
 144         updateTimeStamp();
 145     }
 146 }
 147
 148 void ViewProperties::setCategorizedSorting(bool categorized)
 149 {
 150     if (m_node->categorizedSorting() != categorized) {
 151         m_node->setCategorizedSorting(categorized);
 152         updateTimeStamp();
 153     }
 154 }
 155
 156 bool ViewProperties::categorizedSorting() const
 157 {
 158     return m_node->categorizedSorting();
 159 }
 160
 161
 162 bool ViewProperties::showHiddenFiles() const
 163 {
 164     return m_node->showHiddenFiles();
 165 }
 166
 167 void ViewProperties::setSorting(DolphinView::Sorting sorting)
 168 {
 169     if (m_node->sorting() != sorting) {
 170         m_node->setSorting(sorting);
 171         updateTimeStamp();
 172     }
 173 }
 174
 175 DolphinView::Sorting ViewProperties::sorting() const
 176 {
 177     // If Nepomuk is not available, return SortByName as fallback if SortByRating
 178     // or SortByTags is stored.
 179     DolphinView::Sorting sorting = static_cast<DolphinView::Sorting>(m_node->sorting());
 180     const bool sortByName = !m_nepomukSupport &&
 181                             ((sorting == DolphinView::SortByRating) || (sorting == DolphinView::SortByTags));
 182     if (sortByName) {
 183         sorting = DolphinView::SortByName;
 184     }
 185     return sorting;
 186 }
 187
 188 void ViewProperties::setSortOrder(Qt::SortOrder sortOrder)
 189 {
 190     if (m_node->sortOrder() != sortOrder) {
 191         m_node->setSortOrder(sortOrder);
 192         updateTimeStamp();
 193     }
 194 }
 195
 196 Qt::SortOrder ViewProperties::sortOrder() const
 197 {
 198     return static_cast<Qt::SortOrder>(m_node->sortOrder());
 199 }
 200
 201 void ViewProperties::setSortFoldersFirst(bool foldersFirst)
 202 {
 203     if (m_node->sortFoldersFirst() != foldersFirst) {
 204         m_node->setSortFoldersFirst(foldersFirst);
 205         updateTimeStamp();
 206     }
 207 }
 208
 209 bool ViewProperties::sortFoldersFirst() const
 210 {
 211     return m_node->sortFoldersFirst();
 212 }
 213
 214 void ViewProperties::setAdditionalInfo(KFileItemDelegate::InformationList list)
 215 {
 216     int info = NoInfo;
 217     foreach (KFileItemDelegate::Information currentInfo, list) {
 218         switch (currentInfo) {
 219         case KFileItemDelegate::Size:
 220             info = info | SizeInfo;
 221             break;
 222         case KFileItemDelegate::ModificationTime:
 223             info = info | DateInfo;
 224             break;
 225         case KFileItemDelegate::Permissions:
 226             info = info | PermissionsInfo;
 227             break;
 228         case KFileItemDelegate::Owner:
 229             info = info | OwnerInfo;
 230             break;
 231         case KFileItemDelegate::OwnerAndGroup:
 232             info = info | GroupInfo;
 233             break;
 234         case KFileItemDelegate::FriendlyMimeType:
 235             info = info | TypeInfo;
 236             break;
 237         default:
 238             break;
 239         }
 240     }
 241
 242     const int encodedInfo = encodedAdditionalInfo(info);
 243     if (m_node->additionalInfo() != encodedInfo) {
 244         m_node->setAdditionalInfo(encodedInfo);
 245         updateTimeStamp();
 246     }
 247 }
 248
 249 KFileItemDelegate::InformationList ViewProperties::additionalInfo() const
 250 {
 251     const int info = decodedAdditionalInfo();
 252
 253     KFileItemDelegate::InformationList list;
 254     if (info & SizeInfo) {
 255         list.append(KFileItemDelegate::Size);
 256     }
 257     if (info & DateInfo) {
 258         list.append(KFileItemDelegate::ModificationTime);
 259     }
 260     if (info & PermissionsInfo) {
 261         list.append(KFileItemDelegate::Permissions);
 262     }
 263     if (info & OwnerInfo) {
 264         list.append(KFileItemDelegate::Owner);
 265     }
 266     if (info & GroupInfo) {
 267         list.append(KFileItemDelegate::OwnerAndGroup);
 268     }
 269     if (info & TypeInfo) {
 270         list.append(KFileItemDelegate::FriendlyMimeType);
 271     }
 272
 273     return list;
 274 }
 275
 276
 277 void ViewProperties::setDirProperties(const ViewProperties& props)
 278 {
 279     setViewMode(props.viewMode());
 280     setShowPreview(props.showPreview());
 281     setShowHiddenFiles(props.showHiddenFiles());
 282     setCategorizedSorting(props.categorizedSorting());
 283     setSorting(props.sorting());
 284     setSortOrder(props.sortOrder());
 285     setAdditionalInfo(props.additionalInfo());
 286 }
 287
 288 void ViewProperties::setAutoSaveEnabled(bool autoSave)
 289 {
 290     m_autoSave = autoSave;
 291 }
 292
 293 bool ViewProperties::isAutoSaveEnabled() const
 294 {
 295     return m_autoSave;
 296 }
 297
 298 void ViewProperties::updateTimeStamp()
 299 {
 300     m_changedProps = true;
 301     m_node->setTimestamp(QDateTime::currentDateTime());
 302 }
 303
 304 void ViewProperties::save()
 305 {
 306     KStandardDirs::makeDir(m_filepath);
 307     m_node->writeConfig();
 308     m_changedProps = false;
 309 }
 310
 311 KUrl ViewProperties::mirroredDirectory()
 312 {
 313     QString basePath = KGlobal::mainComponent().componentName();
 314     basePath.append("/view_properties/");
 315     return KUrl(KStandardDirs::locateLocal("data", basePath));
 316 }
 317
 318 QString ViewProperties::destinationDir(const QString& subDir) const
 319 {
 320     QString basePath = KGlobal::mainComponent().componentName();
 321     basePath.append("/view_properties/").append(subDir);
 322     return KStandardDirs::locateLocal("data", basePath);
 323 }
 324
 325 int ViewProperties::encodedAdditionalInfo(int info) const
 326 {
 327     int encodedInfo = m_node->additionalInfo();
 328
 329     switch (viewMode()) {
 330     case DolphinView::DetailsView:
 331         encodedInfo = (encodedInfo & 0xFFFF00) | info;
 332         break;
 333     case DolphinView::IconsView:
 334         encodedInfo = (encodedInfo & 0xFF00FF) | (info << 8);
 335         break;
 336     case DolphinView::ColumnView:
 337         encodedInfo = (encodedInfo & 0x00FFFF) | (info << 16);
 338         break;
 339     default: break;
 340     }
 341
 342     return encodedInfo;
 343 }
 344
 345 int ViewProperties::decodedAdditionalInfo() const
 346 {
 347     int decodedInfo = m_node->additionalInfo();
 348
 349     switch (viewMode()) {
 350     case DolphinView::DetailsView:
 351         decodedInfo = decodedInfo & 0xFF;
 352         if (decodedInfo == NoInfo) {
 353             // a details view without any additional info makes no sense, hence
 354             // provide at least a size-info and date-info as fallback
 355             decodedInfo = SizeInfo | DateInfo;
 356         }
 357         break;
 358     case DolphinView::IconsView:
 359         decodedInfo = (decodedInfo >> 8) & 0xFF;
 360         break;
 361     case DolphinView::ColumnView:
 362         decodedInfo = (decodedInfo >> 16) & 0xFF;
 363         break;
 364     default: break;
 365     }
 366
 367     return decodedInfo;
 368 }