src/search/dolphinfacetswidget.cpp

   1 /***************************************************************************
   2 *    Copyright (C) 2012 by Peter Penz <peter.penz19@gmail.com>            *
   3 *                                                                         *
   4 *    This program is free software; you can redistribute it and/or modify *
   5 *    it under the terms of the GNU General Public License as published by *
   6 *    the Free Software Foundation; either version 2 of the License, or    *
   7 *    (at your option) any later version.                                  *
   8 *                                                                         *
   9 *    This program is distributed in the hope that it will be useful,      *
  10 *    but WITHOUT ANY WARRANTY; without even the implied warranty of       *
  11 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
  12 *    GNU General Public License for more details.                         *
  13 *                                                                         *
  14 *    You should have received a copy of the GNU General Public License    *
  15 *    along with this program; if not, write to the                        *
  16 *    Free Software Foundation, Inc.,                                      *
  17 *    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA           *
  18 * **************************************************************************/
  19
  20 #include "dolphinfacetswidget.h"
  21
  22 #include <KLocalizedString>
  23 #include <QButtonGroup>
  24 #include <QCheckBox>
  25 #include <QDate>
  26 #include <QRadioButton>
  27 #include <QHBoxLayout>
  28 #include <QVBoxLayout>
  29
  30 DolphinFacetsWidget::DolphinFacetsWidget(QWidget* parent) :
  31     QWidget(parent),
  32     m_documents(0),
  33     m_images(0),
  34     m_audio(0),
  35     m_videos(0),
  36     m_anytime(0),
  37     m_today(0),
  38     m_yesterday(0),
  39     m_thisWeek(0),
  40     m_thisMonth(0),
  41     m_thisYear(0),
  42     m_anyRating(0),
  43     m_oneOrMore(0),
  44     m_twoOrMore(0),
  45     m_threeOrMore(0),
  46     m_fourOrMore(0),
  47     m_maxRating(0)
  48 {
  49     QButtonGroup* filetypeGroup = new QButtonGroup(this);
  50     m_anyType   = createRadioButton(i18nc("@option:check", "Any"), filetypeGroup);
  51     m_documents = createRadioButton(i18nc("@option:check", "Documents"), filetypeGroup);
  52     m_images    = createRadioButton(i18nc("@option:check", "Images"), filetypeGroup);
  53     m_audio     = createRadioButton(i18nc("@option:check", "Audio Files"), filetypeGroup);
  54     m_videos    = createRadioButton(i18nc("@option:check", "Videos"), filetypeGroup);
  55
  56     QVBoxLayout* typeLayout = new QVBoxLayout();
  57     typeLayout->setSpacing(0);
  58     typeLayout->addWidget(m_anyType);
  59     typeLayout->addWidget(m_documents);
  60     typeLayout->addWidget(m_images);
  61     typeLayout->addWidget(m_audio);
  62     typeLayout->addWidget(m_videos);
  63     typeLayout->addStretch();
  64
  65     QButtonGroup* timespanGroup = new QButtonGroup(this);
  66     m_anytime   = createRadioButton(i18nc("@option:option", "Anytime"), timespanGroup);
  67     m_today     = createRadioButton(i18nc("@option:option", "Today"), timespanGroup);
  68     m_yesterday = createRadioButton(i18nc("@option:option", "Yesterday"), timespanGroup);
  69     m_thisWeek  = createRadioButton(i18nc("@option:option", "This Week"), timespanGroup);
  70     m_thisMonth = createRadioButton(i18nc("@option:option", "This Month"), timespanGroup);
  71     m_thisYear  = createRadioButton(i18nc("@option:option", "This Year"), timespanGroup);
  72
  73     QVBoxLayout* timespanLayout = new QVBoxLayout();
  74     timespanLayout->setSpacing(0);
  75     timespanLayout->addWidget(m_anytime);
  76     timespanLayout->addWidget(m_today);
  77     timespanLayout->addWidget(m_yesterday);
  78     timespanLayout->addWidget(m_thisWeek);
  79     timespanLayout->addWidget(m_thisMonth);
  80     timespanLayout->addWidget(m_thisYear);
  81     timespanLayout->addStretch();
  82
  83     QButtonGroup* ratingGroup = new QButtonGroup(this);
  84     m_anyRating   = createRadioButton(i18nc("@option:option", "Any Rating"), ratingGroup);
  85     m_oneOrMore   = createRadioButton(i18nc("@option:option", "1 or more"), ratingGroup);
  86     m_twoOrMore   = createRadioButton(i18nc("@option:option", "2 or more"), ratingGroup);
  87     m_threeOrMore = createRadioButton(i18nc("@option:option", "3 or more"), ratingGroup);
  88     m_fourOrMore  = createRadioButton(i18nc("@option:option", "4 or more"), ratingGroup);
  89     m_maxRating   = createRadioButton(i18nc("@option:option", "Highest Rating"), ratingGroup);
  90
  91     QVBoxLayout* ratingLayout = new QVBoxLayout();
  92     ratingLayout->setSpacing(0);
  93     ratingLayout->addWidget(m_anyRating);
  94     ratingLayout->addWidget(m_oneOrMore);
  95     ratingLayout->addWidget(m_twoOrMore);
  96     ratingLayout->addWidget(m_threeOrMore);
  97     ratingLayout->addWidget(m_fourOrMore);
  98     ratingLayout->addWidget(m_maxRating);
  99
 100     QHBoxLayout* topLayout = new QHBoxLayout(this);
 101     topLayout->addLayout(typeLayout);
 102     topLayout->addLayout(timespanLayout);
 103     topLayout->addLayout(ratingLayout);
 104     topLayout->addStretch();
 105
 106     m_anyType->setChecked(true);
 107     m_anytime->setChecked(true);
 108     m_anyRating->setChecked(true);
 109 }
 110
 111 DolphinFacetsWidget::~DolphinFacetsWidget()
 112 {
 113 }
 114
 115 QString DolphinFacetsWidget::ratingTerm() const
 116 {
 117     QStringList terms;
 118
 119     if (!m_anyRating->isChecked()) {
 120         int stars = 1; // represents m_oneOrMore
 121         if (m_twoOrMore->isChecked()) {
 122             stars = 2;
 123         } else if (m_threeOrMore->isChecked()) {
 124             stars = 3;
 125         } else if (m_fourOrMore->isChecked()) {
 126             stars = 4;
 127         } else if (m_maxRating->isChecked()) {
 128             stars = 5;
 129         }
 130
 131         const int rating = stars * 2;
 132         terms << QStringLiteral("rating>=%1").arg(rating);
 133     }
 134
 135     if (!m_anytime->isChecked()) {
 136         QDate date = QDate::currentDate(); // represents m_today
 137         if (m_yesterday->isChecked()) {
 138             date = date.addDays(-1);
 139         } else if (m_thisWeek->isChecked()) {
 140             date = date.addDays(1 - date.dayOfWeek());
 141         } else if (m_thisMonth->isChecked()) {
 142             date = date.addDays(1 - date.day());
 143         } else if (m_thisYear->isChecked()) {
 144             date = date.addDays(1 - date.dayOfYear());
 145         }
 146
 147         terms << QStringLiteral("modified>=%1").arg(date.toString(Qt::ISODate));
 148     }
 149
 150     return terms.join(QStringLiteral(" AND "));
 151 }
 152
 153 QString DolphinFacetsWidget::facetType() const
 154 {
 155     if (m_documents->isChecked()) {
 156         return QStringLiteral("Document");
 157     } else if (m_images->isChecked()) {
 158         return QStringLiteral("Image");
 159     } else if (m_audio->isChecked()) {
 160         return QStringLiteral("Audio");
 161     } else if (m_videos->isChecked()) {
 162         return QStringLiteral("Video");
 163     }
 164
 165     return QString();
 166 }
 167
 168 bool DolphinFacetsWidget::isRatingTerm(const QString& term) const
 169 {
 170     const QStringList subTerms = term.split(' ', QString::SkipEmptyParts);
 171
 172     // If term has sub terms, then sone of the sub terms are always "rating" and "modified" terms.
 173     bool containsRating = false;
 174     bool containsModified = false;
 175
 176     foreach (const QString& subTerm, subTerms) {
 177         if (subTerm.startsWith(QLatin1String("rating>="))) {
 178             containsRating = true;
 179         } else if (subTerm.startsWith(QLatin1String("modified>="))) {
 180             containsModified = true;
 181         }
 182     }
 183
 184     return containsModified || containsRating;
 185 }
 186
 187 void DolphinFacetsWidget::setRatingTerm(const QString& term)
 188 {
 189     // If term has sub terms, then the sub terms are always "rating" and "modified" terms.
 190     // If term has no sub terms, then the term itself is either a "rating" term or a "modified"
 191     // term. To avoid code duplication we add term to subTerms list, if the list is empty.
 192     QStringList subTerms = term.split(' ', QString::SkipEmptyParts);
 193
 194     foreach (const QString& subTerm, subTerms) {
 195         if (subTerm.startsWith(QLatin1String("modified>="))) {
 196             const QString value = subTerm.mid(10);
 197             const QDate date = QDate::fromString(value, Qt::ISODate);
 198             setTimespan(date);
 199         } else if (subTerm.startsWith(QLatin1String("rating>="))) {
 200             const QString value = subTerm.mid(8);
 201             const int stars = value.toInt() / 2;
 202             setRating(stars);
 203         }
 204     }
 205 }
 206
 207 void DolphinFacetsWidget::setFacetType(const QString& type)
 208 {
 209     if (type == QLatin1String("Document")) {
 210         m_documents->setChecked(true);
 211     } else if (type == QLatin1String("Image")) {
 212         m_images->setChecked(true);
 213     } else if (type == QLatin1String("Audio")) {
 214         m_audio->setChecked(true);
 215     } else if (type == QLatin1String("Video")) {
 216         m_videos->setChecked(true);
 217     } else {
 218         m_anyType->setChecked(true);
 219     }
 220 }
 221
 222 void DolphinFacetsWidget::setRating(const int stars)
 223 {
 224     switch (stars) {
 225     case 5:
 226         m_maxRating->setChecked(true);
 227         break;
 228
 229     case 4:
 230         m_fourOrMore->setChecked(true);
 231         break;
 232
 233     case 3:
 234         m_threeOrMore->setChecked(true);
 235         break;
 236
 237     case 2:
 238         m_twoOrMore->setChecked(true);
 239         break;
 240
 241     case 1:
 242         m_oneOrMore->setChecked(true);
 243         break;
 244
 245     default:
 246         m_anyRating->setChecked(true);
 247     }
 248 }
 249
 250 void DolphinFacetsWidget::setTimespan(const QDate& date)
 251 {
 252     const QDate currentDate = QDate::currentDate();
 253     const int days = date.daysTo(currentDate);
 254
 255     if (days <= 0) {
 256         m_today->setChecked(true);
 257     } else if (days <= 1) {
 258         m_yesterday->setChecked(true);
 259     } else if (days <= currentDate.dayOfWeek()) {
 260         m_thisWeek->setChecked(true);
 261     } else if (days <= currentDate.day()) {
 262         m_thisMonth->setChecked(true);
 263     } else if (days <= currentDate.dayOfYear()) {
 264         m_thisYear->setChecked(true);
 265     } else {
 266         m_anytime->setChecked(true);
 267     }
 268 }
 269
 270 QRadioButton* DolphinFacetsWidget::createRadioButton(const QString& text,
 271                                                      QButtonGroup* group)
 272 {
 273     QRadioButton* button = new QRadioButton(text);
 274     connect(button, &QRadioButton::clicked, this, &DolphinFacetsWidget::facetChanged);
 275     group->addButton(button);
 276     return button;
 277 }
 278