src/kitemviews/private/kbaloorolesprovider.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2012 by Peter Penz <peter.penz19@gmail.com>             *
   3  *   Copyright (C) 2013 by Vishesh Handa <me@vhanda.in>                    *
   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 "kbaloorolesprovider.h"
  22
  23 #include <KDebug>
  24 #include <KGlobal>
  25 #include <KLocale>
  26
  27 #include <KF5/Baloo/file.h>
  28 #include <kfilemetadata/propertyinfo.h>
  29
  30 #include <QTime>
  31 #include <QMap>
  32
  33 struct KBalooRolesProviderSingleton
  34 {
  35     KBalooRolesProvider instance;
  36 };
  37 K_GLOBAL_STATIC(KBalooRolesProviderSingleton, s_balooRolesProvider)
  38
  39
  40 KBalooRolesProvider& KBalooRolesProvider::instance()
  41 {
  42     return s_balooRolesProvider->instance;
  43 }
  44
  45 KBalooRolesProvider::~KBalooRolesProvider()
  46 {
  47 }
  48
  49 QSet<QByteArray> KBalooRolesProvider::roles() const
  50 {
  51     return m_roles;
  52 }
  53
  54 QHash<QByteArray, QVariant> KBalooRolesProvider::roleValues(const Baloo::File& file,
  55                                                             const QSet<QByteArray>& roles) const
  56 {
  57     QHash<QByteArray, QVariant> values;
  58
  59     int width = -1;
  60     int height = -1;
  61
  62     QMapIterator<KFileMetaData::Property::Property, QVariant> it(file.properties());
  63     while (it.hasNext()) {
  64         it.next();
  65
  66         const KFileMetaData::PropertyInfo pi(it.key());
  67         const QString property = pi.name();
  68         const QByteArray role = roleForProperty(property);
  69         if (role.isEmpty() || !roles.contains(role)) {
  70             continue;
  71         }
  72
  73         const QVariant value = it.value();
  74
  75         if (role == "imageSize") {
  76             // Merge the two properties for width and height
  77             // as one string into the "imageSize" role
  78             if (property == QLatin1String("width")) {
  79                 width = value.toInt();
  80             }
  81             else if (property == QLatin1String("height")) {
  82                 height = value.toInt();
  83             }
  84
  85             if (width >= 0 && height >= 0) {
  86                 QString widthAndHeight = QString::number(width);
  87                 widthAndHeight += QLatin1String(" x ");
  88                 widthAndHeight += QString::number(height);
  89                 values.insert(role, widthAndHeight);
  90             }
  91         } else if (role == "orientation") {
  92             const QString orientation = orientationFromValue(value.toInt());
  93             values.insert(role, orientation);
  94         } else if (role == "duration") {
  95             const QString duration = durationFromValue(value.toInt());
  96             values.insert(role, duration);
  97         } else {
  98             values.insert(role, value.toString());
  99         }
 100     }
 101
 102     if (roles.contains("tags")) {
 103         values.insert("tags", tagsFromValues(file.tags()));
 104     }
 105     if (roles.contains("rating")) {
 106         values.insert("rating", QString::number(file.rating()));
 107     }
 108     if (roles.contains("comment")) {
 109         values.insert("comment", file.userComment());
 110     }
 111
 112     return values;
 113 }
 114
 115 QByteArray KBalooRolesProvider::roleForProperty(const QString& property) const
 116 {
 117     return m_roleForProperty.value(property);
 118 }
 119
 120 KBalooRolesProvider::KBalooRolesProvider() :
 121     m_roles(),
 122     m_roleForProperty()
 123 {
 124     struct PropertyInfo
 125     {
 126         const char* const property;
 127         const char* const role;
 128     };
 129
 130     // Mapping from the URIs to the KFileItemModel roles. Note that this must not be
 131     // a 1:1 mapping: One role may contain several URI-values (e.g. the URIs for height and
 132     // width of an image are mapped to the role "imageSize")
 133     static const PropertyInfo propertyInfoList[] = {
 134         { "rating", "rating" },
 135         { "tag",        "tags" },
 136         { "comment",   "comment" },
 137         { "wordCount",     "wordCount" },
 138         { "lineCount",     "lineCount" },
 139         { "width",         "imageSize" },
 140         { "height",        "imageSize" },
 141         { "nexif.orientation", "orientation", },
 142         { "artist",     "artist" },
 143         { "album",    "album" },
 144         { "duration",      "duration" },
 145         { "trackNumber",   "track" }
 146         // { "http://www.semanticdesktop.org/ontologies/2010/04/30/ndo#copiedFrom",    "copiedFrom" }
 147     };
 148
 149     for (unsigned int i = 0; i < sizeof(propertyInfoList) / sizeof(PropertyInfo); ++i) {
 150         m_roleForProperty.insert(propertyInfoList[i].property, propertyInfoList[i].role);
 151         m_roles.insert(propertyInfoList[i].role);
 152     }
 153 }
 154
 155 QString KBalooRolesProvider::tagsFromValues(const QStringList& values) const
 156 {
 157     return values.join(", ");
 158 }
 159
 160 QString KBalooRolesProvider::orientationFromValue(int value) const
 161 {
 162     QString string;
 163     switch (value) {
 164     case 1: string = i18nc("@item:intable Image orientation", "Unchanged"); break;
 165     case 2: string = i18nc("@item:intable Image orientation", "Horizontally flipped"); break;
 166     case 3: string = i18nc("@item:intable image orientation", "180° rotated"); break;
 167     case 4: string = i18nc("@item:intable image orientation", "Vertically flipped"); break;
 168     case 5: string = i18nc("@item:intable image orientation", "Transposed"); break;
 169     case 6: string = i18nc("@item:intable image orientation", "90° rotated"); break;
 170     case 7: string = i18nc("@item:intable image orientation", "Transversed"); break;
 171     case 8: string = i18nc("@item:intable image orientation", "270° rotated"); break;
 172     default:
 173         break;
 174     }
 175     return string;
 176 }
 177
 178 QString KBalooRolesProvider::durationFromValue(int value) const
 179 {
 180     QTime duration;
 181     duration = duration.addSecs(value);
 182     return duration.toString("hh:mm:ss");
 183 }
 184