src/search/dolphinfacetswidget.cpp

   1 /***************************************************************************
   2 *    Copyright (C) 2012 by Peter Penz <peter.penz19@gmail.com>            *
   3 *    Copyright (C) 2019 by Ismael Asensio <isma.af@mgmail.com>            *
   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 "dolphinfacetswidget.h"
  22
  23 #include <KLocalizedString>
  24
  25 #include <QComboBox>
  26 #include <QDate>
  27 #include <QEvent>
  28 #include <QHBoxLayout>
  29 #include <QIcon>
  30 #include <QMenu>
  31 #include <QToolButton>
  32
  33 DolphinFacetsWidget::DolphinFacetsWidget(QWidget* parent) :
  34     QWidget(parent),
  35     m_typeSelector(nullptr),
  36     m_dateSelector(nullptr),
  37     m_ratingSelector(nullptr),
  38     m_tagsSelector(nullptr)
  39 {
  40     m_typeSelector = new QComboBox(this);
  41     m_typeSelector->addItem(QIcon::fromTheme(QStringLiteral("none")), i18nc("@item:inlistbox", "Any Type"), QString());
  42     m_typeSelector->addItem(QIcon::fromTheme(QStringLiteral("inode-directory")), i18nc("@item:inlistbox", "Folders") , QStringLiteral("Folder"));
  43     m_typeSelector->addItem(QIcon::fromTheme(QStringLiteral("text-x-generic")), i18nc("@item:inlistbox", "Documents") , QStringLiteral("Document"));
  44     m_typeSelector->addItem(QIcon::fromTheme(QStringLiteral("image-x-generic")), i18nc("@item:inlistbox", "Images") , QStringLiteral("Image"));
  45     m_typeSelector->addItem(QIcon::fromTheme(QStringLiteral("audio-x-generic")), i18nc("@item:inlistbox", "Audio Files"), QStringLiteral("Audio"));
  46     m_typeSelector->addItem(QIcon::fromTheme(QStringLiteral("video-x-generic")), i18nc("@item:inlistbox", "Videos") , QStringLiteral("Video"));
  47     initComboBox(m_typeSelector);
  48
  49     const QDate currentDate = QDate::currentDate();
  50
  51     m_dateSelector = new QComboBox(this);
  52     m_dateSelector->addItem(QIcon::fromTheme(QStringLiteral("view-calendar")), i18nc("@item:inlistbox", "Any Date"), QDate());
  53     m_dateSelector->addItem(QIcon::fromTheme(QStringLiteral("go-jump-today")), i18nc("@item:inlistbox", "Today") , currentDate);
  54     m_dateSelector->addItem(QIcon::fromTheme(QStringLiteral("go-jump-today")), i18nc("@item:inlistbox", "Yesterday") , currentDate.addDays(-1));
  55     m_dateSelector->addItem(QIcon::fromTheme(QStringLiteral("view-calendar-week")), i18nc("@item:inlistbox", "This Week") , currentDate.addDays(1 - currentDate.dayOfWeek()));
  56     m_dateSelector->addItem(QIcon::fromTheme(QStringLiteral("view-calendar-month")), i18nc("@item:inlistbox", "This Month"), currentDate.addDays(1 - currentDate.day()));
  57     m_dateSelector->addItem(QIcon::fromTheme(QStringLiteral("view-calendar-year")), i18nc("@item:inlistbox", "This Year") , currentDate.addDays(1 - currentDate.dayOfYear()));
  58     initComboBox(m_dateSelector);
  59
  60     m_ratingSelector = new QComboBox(this);
  61     m_ratingSelector->addItem(QIcon::fromTheme(QStringLiteral("non-starred-symbolic")), i18nc("@item:inlistbox", "Any Rating"), 0);
  62     m_ratingSelector->addItem(QIcon::fromTheme(QStringLiteral("starred-symbolic")), i18nc("@item:inlistbox", "1 or more"), 1);
  63     m_ratingSelector->addItem(QIcon::fromTheme(QStringLiteral("starred-symbolic")), i18nc("@item:inlistbox", "2 or more"), 2);
  64     m_ratingSelector->addItem(QIcon::fromTheme(QStringLiteral("starred-symbolic")), i18nc("@item:inlistbox", "3 or more"), 3);
  65     m_ratingSelector->addItem(QIcon::fromTheme(QStringLiteral("starred-symbolic")), i18nc("@item:inlistbox", "4 or more"), 4);
  66     m_ratingSelector->addItem(QIcon::fromTheme(QStringLiteral("starred-symbolic")), i18nc("@item:inlistbox", "Highest Rating"), 5);
  67     initComboBox(m_ratingSelector);
  68
  69     m_tagsSelector = new QToolButton(this);
  70     m_tagsSelector->setIcon(QIcon::fromTheme(QStringLiteral("tag")));
  71     m_tagsSelector->setMenu(new QMenu(this));
  72     m_tagsSelector->setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
  73     m_tagsSelector->setPopupMode(QToolButton::MenuButtonPopup);
  74     m_tagsSelector->setAutoRaise(true);
  75     updateTagsSelector();
  76
  77     connect(m_tagsSelector, &QToolButton::clicked, m_tagsSelector, &QToolButton::showMenu);
  78     connect(m_tagsSelector->menu(), &QMenu::aboutToShow, this, &DolphinFacetsWidget::updateTagsMenu);
  79     connect(&m_tagsLister, &KCoreDirLister::itemsAdded, this, &DolphinFacetsWidget::updateTagsMenuItems);
  80     updateTagsMenu();
  81
  82     QHBoxLayout* topLayout = new QHBoxLayout(this);
  83     topLayout->setContentsMargins(0, 0, 0, 0);
  84     topLayout->addWidget(m_typeSelector);
  85     topLayout->addWidget(m_dateSelector);
  86     topLayout->addWidget(m_ratingSelector);
  87     topLayout->addWidget(m_tagsSelector);
  88
  89     resetSearchTerms();
  90 }
  91
  92 DolphinFacetsWidget::~DolphinFacetsWidget()
  93 {
  94 }
  95
  96 void DolphinFacetsWidget::changeEvent(QEvent *event)
  97 {
  98     if (event->type() == QEvent::EnabledChange) {
  99         if (isEnabled()) {
 100             updateTagsSelector();
 101         } else {
 102             resetSearchTerms();
 103         }
 104     }
 105 }
 106
 107 void DolphinFacetsWidget::resetSearchTerms()
 108 {
 109     m_typeSelector->setCurrentIndex(0);
 110     m_dateSelector->setCurrentIndex(0);
 111     m_ratingSelector->setCurrentIndex(0);
 112
 113     m_searchTags = QStringList();
 114     updateTagsSelector();
 115     updateTagsMenu();
 116 }
 117
 118 QStringList DolphinFacetsWidget::searchTerms() const
 119 {
 120     QStringList terms;
 121
 122     if (m_ratingSelector->currentIndex() > 0) {
 123         const int rating = m_ratingSelector->currentData().toInt() * 2;
 124         terms << QStringLiteral("rating>=%1").arg(rating);
 125     }
 126
 127     if (m_dateSelector->currentIndex() > 0) {
 128         const QDate date = m_dateSelector->currentData().toDate();
 129         terms << QStringLiteral("modified>=%1").arg(date.toString(Qt::ISODate));
 130     }
 131
 132     if (!m_searchTags.isEmpty()) {
 133         for (auto const &tag : m_searchTags) {
 134             terms << QStringLiteral("tag:%1").arg(tag);
 135         }
 136     }
 137
 138     return terms;
 139 }
 140
 141 QString DolphinFacetsWidget::facetType() const
 142 {
 143     return m_typeSelector->currentData().toString();
 144 }
 145
 146 bool DolphinFacetsWidget::isSearchTerm(const QString& term) const
 147 {
 148     static const QLatin1String searchTokens[] {
 149         QLatin1String("modified>="),
 150         QLatin1String("rating>="),
 151         QLatin1String("tag:"), QLatin1String("tag=")
 152     };
 153
 154     for (const auto &searchToken : searchTokens) {
 155         if (term.startsWith(searchToken)) {
 156             return true;
 157         }
 158     }
 159     return false;
 160 }
 161
 162 void DolphinFacetsWidget::setSearchTerm(const QString& term)
 163 {
 164     if (term.startsWith(QLatin1String("modified>="))) {
 165         const QString value = term.mid(10);
 166         const QDate date = QDate::fromString(value, Qt::ISODate);
 167         setTimespan(date);
 168     } else if (term.startsWith(QLatin1String("rating>="))) {
 169         const QString value = term.mid(8);
 170         const int stars = value.toInt() / 2;
 171         setRating(stars);
 172     } else if (term.startsWith(QLatin1String("tag:")) ||
 173                term.startsWith(QLatin1String("tag="))) {
 174         const QString value = term.mid(4);
 175         addSearchTag(value);
 176     }
 177 }
 178
 179 void DolphinFacetsWidget::setFacetType(const QString& type)
 180 {
 181     for (int index = 0; index <= m_typeSelector->count(); index++) {
 182         if (type == m_typeSelector->itemData(index).toString()) {
 183             m_typeSelector->setCurrentIndex(index);
 184             break;
 185         }
 186     }
 187 }
 188
 189 void DolphinFacetsWidget::setRating(const int stars)
 190 {
 191     if (stars < 0 || stars > 5) {
 192         return;
 193     }
 194     m_ratingSelector->setCurrentIndex(stars);
 195 }
 196
 197 void DolphinFacetsWidget::setTimespan(const QDate& date)
 198 {
 199     if (!date.isValid()) {
 200         return;
 201     }
 202     m_dateSelector->setCurrentIndex(0);
 203     for (int index = 1; index <= m_dateSelector->count(); index++) {
 204         if (date >= m_dateSelector->itemData(index).toDate()) {
 205             m_dateSelector->setCurrentIndex(index);
 206             break;
 207         }
 208     }
 209 }
 210
 211 void DolphinFacetsWidget::addSearchTag(const QString& tag)
 212 {
 213     if (tag.isEmpty() || m_searchTags.contains(tag)) {
 214         return;
 215     }
 216     m_searchTags.append(tag);
 217     m_searchTags.sort();
 218     updateTagsSelector();
 219 }
 220
 221 void DolphinFacetsWidget::removeSearchTag(const QString& tag)
 222 {
 223     if (tag.isEmpty() || !m_searchTags.contains(tag)) {
 224         return;
 225     }
 226     m_searchTags.removeAll(tag);
 227     updateTagsSelector();
 228 }
 229
 230 void DolphinFacetsWidget::initComboBox(QComboBox* combo)
 231 {
 232     combo->setFrame(false);
 233     combo->setMinimumHeight(parentWidget()->height());
 234     combo->setCurrentIndex(0);
 235     connect(combo, QOverload<int>::of(&QComboBox::activated), this, &DolphinFacetsWidget::facetChanged);
 236 }
 237
 238 void DolphinFacetsWidget::updateTagsSelector()
 239 {
 240     const bool hasListedTags = !m_tagsSelector->menu()->isEmpty();
 241     const bool hasSelectedTags = !m_searchTags.isEmpty();
 242
 243     if (hasSelectedTags) {
 244         const QString tagsText = m_searchTags.join(i18nc("String list separator", ", "));
 245         m_tagsSelector->setText(i18ncp("@action:button %2 is a list of tags",
 246                                        "Tag: %2", "Tags: %2",m_searchTags.count(), tagsText));
 247     } else {
 248         m_tagsSelector->setText(i18nc("@action:button", "Add Tags"));
 249     }
 250
 251     m_tagsSelector->setEnabled(isEnabled() && (hasListedTags || hasSelectedTags));
 252 }
 253
 254 void DolphinFacetsWidget::updateTagsMenu()
 255 {
 256     updateTagsMenuItems({}, {});
 257     m_tagsLister.openUrl(QUrl(QStringLiteral("tags:/")), KCoreDirLister::OpenUrlFlag::Reload);
 258 }
 259
 260 void DolphinFacetsWidget::updateTagsMenuItems(const QUrl&, const KFileItemList& items)
 261 {
 262     m_tagsSelector->menu()->clear();
 263
 264     QStringList allTags = QStringList(m_searchTags);
 265     for (const KFileItem &item: items) {
 266         allTags.append(item.name());
 267     }
 268     allTags.sort(Qt::CaseInsensitive);
 269     allTags.removeDuplicates();
 270
 271     for (const QString& tagName : qAsConst(allTags)) {
 272         QAction* action = m_tagsSelector->menu()->addAction(QIcon::fromTheme(QStringLiteral("tag")), tagName);
 273         action->setCheckable(true);
 274         action->setChecked(m_searchTags.contains(tagName));
 275
 276         connect(action, &QAction::triggered, this, [this, tagName](bool isChecked) {
 277             if (isChecked) {
 278                 addSearchTag(tagName);
 279             } else {
 280                 removeSearchTag(tagName);
 281             }
 282             emit facetChanged();
 283
 284             m_tagsSelector->menu()->show();
 285         });
 286     }
 287
 288     updateTagsSelector();
 289 }