src/search/dolphinfacetswidget.cpp

   1 /*
   2  *  SPDX-FileCopyrightText: 2012 Peter Penz <peter.penz19@gmail.com>
   3  *  SPDX-FileCopyrightText: 2019 Ismael Asensio <isma.af@mgmail.com>
   4  *
   5  *  SPDX-License-Identifier: GPL-2.0-or-later
   6  */
   7
   8 #include "dolphinfacetswidget.h"
   9
  10 #include <KLocalizedString>
  11 #include <KProtocolInfo>
  12
  13 #include <QComboBox>
  14 #include <QDate>
  15 #include <QEvent>
  16 #include <QHBoxLayout>
  17 #include <QIcon>
  18 #include <QMenu>
  19 #include <QToolButton>
  20
  21 DolphinFacetsWidget::DolphinFacetsWidget(QWidget *parent)
  22     : QWidget(parent)
  23     , m_typeSelector(nullptr)
  24     , m_dateSelector(nullptr)
  25     , m_ratingSelector(nullptr)
  26     , m_tagsSelector(nullptr)
  27 {
  28     m_typeSelector = new QComboBox(this);
  29     m_typeSelector->addItem(QIcon::fromTheme(QStringLiteral("none")), i18nc("@item:inlistbox", "Any Type"), QString());
  30     m_typeSelector->addItem(QIcon::fromTheme(QStringLiteral("inode-directory")), i18nc("@item:inlistbox", "Folders"), QStringLiteral("Folder"));
  31     m_typeSelector->addItem(QIcon::fromTheme(QStringLiteral("text-x-generic")), i18nc("@item:inlistbox", "Documents"), QStringLiteral("Document"));
  32     m_typeSelector->addItem(QIcon::fromTheme(QStringLiteral("image-x-generic")), i18nc("@item:inlistbox", "Images"), QStringLiteral("Image"));
  33     m_typeSelector->addItem(QIcon::fromTheme(QStringLiteral("audio-x-generic")), i18nc("@item:inlistbox", "Audio Files"), QStringLiteral("Audio"));
  34     m_typeSelector->addItem(QIcon::fromTheme(QStringLiteral("video-x-generic")), i18nc("@item:inlistbox", "Videos"), QStringLiteral("Video"));
  35     initComboBox(m_typeSelector);
  36
  37     const QDate currentDate = QDate::currentDate();
  38
  39     m_dateSelector = new QComboBox(this);
  40     m_dateSelector->addItem(QIcon::fromTheme(QStringLiteral("view-calendar")), i18nc("@item:inlistbox", "Any Date"), QDate());
  41     m_dateSelector->addItem(QIcon::fromTheme(QStringLiteral("go-jump-today")), i18nc("@item:inlistbox", "Today"), currentDate);
  42     m_dateSelector->addItem(QIcon::fromTheme(QStringLiteral("go-jump-today")), i18nc("@item:inlistbox", "Yesterday"), currentDate.addDays(-1));
  43     m_dateSelector->addItem(QIcon::fromTheme(QStringLiteral("view-calendar-week")),
  44                             i18nc("@item:inlistbox", "This Week"),
  45                             currentDate.addDays(1 - currentDate.dayOfWeek()));
  46     m_dateSelector->addItem(QIcon::fromTheme(QStringLiteral("view-calendar-month")),
  47                             i18nc("@item:inlistbox", "This Month"),
  48                             currentDate.addDays(1 - currentDate.day()));
  49     m_dateSelector->addItem(QIcon::fromTheme(QStringLiteral("view-calendar-year")),
  50                             i18nc("@item:inlistbox", "This Year"),
  51                             currentDate.addDays(1 - currentDate.dayOfYear()));
  52     initComboBox(m_dateSelector);
  53
  54     m_ratingSelector = new QComboBox(this);
  55     m_ratingSelector->addItem(QIcon::fromTheme(QStringLiteral("non-starred-symbolic")), i18nc("@item:inlistbox", "Any Rating"), 0);
  56     m_ratingSelector->addItem(QIcon::fromTheme(QStringLiteral("starred-symbolic")), i18nc("@item:inlistbox", "1 or more"), 1);
  57     m_ratingSelector->addItem(QIcon::fromTheme(QStringLiteral("starred-symbolic")), i18nc("@item:inlistbox", "2 or more"), 2);
  58     m_ratingSelector->addItem(QIcon::fromTheme(QStringLiteral("starred-symbolic")), i18nc("@item:inlistbox", "3 or more"), 3);
  59     m_ratingSelector->addItem(QIcon::fromTheme(QStringLiteral("starred-symbolic")), i18nc("@item:inlistbox", "4 or more"), 4);
  60     m_ratingSelector->addItem(QIcon::fromTheme(QStringLiteral("starred-symbolic")), i18nc("@item:inlistbox", "Highest Rating"), 5);
  61     initComboBox(m_ratingSelector);
  62
  63     m_clearTagsAction = new QAction(QIcon::fromTheme(QStringLiteral("edit-clear-all")), i18nc("@action:inmenu", "Clear Selection"), this);
  64     connect(m_clearTagsAction, &QAction::triggered, this, [this]() {
  65         resetSearchTags();
  66         Q_EMIT facetChanged();
  67     });
  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     resetSearchTags();
 114 }
 115
 116 QStringList DolphinFacetsWidget::searchTerms() const
 117 {
 118     QStringList terms;
 119
 120     if (m_ratingSelector->currentIndex() > 0) {
 121         const int rating = m_ratingSelector->currentData().toInt() * 2;
 122         terms << QStringLiteral("rating>=%1").arg(rating);
 123     }
 124
 125     if (m_dateSelector->currentIndex() > 0) {
 126         const QDate date = m_dateSelector->currentData().toDate();
 127         terms << QStringLiteral("modified>=%1").arg(date.toString(Qt::ISODate));
 128     }
 129
 130     if (!m_searchTags.isEmpty()) {
 131         for (auto const &tag : m_searchTags) {
 132             if (tag.contains(QLatin1Char(' '))) {
 133                 terms << QStringLiteral("tag:\"%1\"").arg(tag);
 134             } else {
 135                 terms << QStringLiteral("tag:%1").arg(tag);
 136             }
 137         }
 138     }
 139
 140     return terms;
 141 }
 142
 143 QString DolphinFacetsWidget::facetType() const
 144 {
 145     return m_typeSelector->currentData().toString();
 146 }
 147
 148 bool DolphinFacetsWidget::isSearchTerm(const QString &term) const
 149 {
 150     static const QLatin1String searchTokens[]{QLatin1String("modified>="), QLatin1String("rating>="), QLatin1String("tag:"), QLatin1String("tag=")};
 151
 152     for (const auto &searchToken : searchTokens) {
 153         if (term.startsWith(searchToken)) {
 154             return true;
 155         }
 156     }
 157     return false;
 158 }
 159
 160 void DolphinFacetsWidget::setSearchTerm(const QString &term)
 161 {
 162     if (term.startsWith(QLatin1String("modified>="))) {
 163         const QString value = term.mid(10);
 164         const QDate date = QDate::fromString(value, Qt::ISODate);
 165         setTimespan(date);
 166     } else if (term.startsWith(QLatin1String("rating>="))) {
 167         const QString value = term.mid(8);
 168         const int stars = value.toInt() / 2;
 169         setRating(stars);
 170     } else if (term.startsWith(QLatin1String("tag:")) || term.startsWith(QLatin1String("tag="))) {
 171         const QString value = term.mid(4);
 172         addSearchTag(value);
 173     }
 174 }
 175
 176 void DolphinFacetsWidget::setFacetType(const QString &type)
 177 {
 178     for (int index = 0; index <= m_typeSelector->count(); index++) {
 179         if (type == m_typeSelector->itemData(index).toString()) {
 180             m_typeSelector->setCurrentIndex(index);
 181             break;
 182         }
 183     }
 184 }
 185
 186 void DolphinFacetsWidget::setRating(const int stars)
 187 {
 188     if (stars < 0 || stars > 5) {
 189         return;
 190     }
 191     m_ratingSelector->setCurrentIndex(stars);
 192 }
 193
 194 void DolphinFacetsWidget::setTimespan(const QDate &date)
 195 {
 196     if (!date.isValid()) {
 197         return;
 198     }
 199     m_dateSelector->setCurrentIndex(0);
 200     for (int index = 1; index <= m_dateSelector->count(); index++) {
 201         if (date >= m_dateSelector->itemData(index).toDate()) {
 202             m_dateSelector->setCurrentIndex(index);
 203             break;
 204         }
 205     }
 206 }
 207
 208 void DolphinFacetsWidget::addSearchTag(const QString &tag)
 209 {
 210     if (tag.isEmpty() || m_searchTags.contains(tag)) {
 211         return;
 212     }
 213     m_searchTags.append(tag);
 214     m_searchTags.sort();
 215     updateTagsSelector();
 216 }
 217
 218 void DolphinFacetsWidget::removeSearchTag(const QString &tag)
 219 {
 220     if (tag.isEmpty() || !m_searchTags.contains(tag)) {
 221         return;
 222     }
 223     m_searchTags.removeAll(tag);
 224     updateTagsSelector();
 225 }
 226
 227 void DolphinFacetsWidget::resetSearchTags()
 228 {
 229     m_searchTags = QStringList();
 230     updateTagsSelector();
 231     updateTagsMenu();
 232 }
 233
 234 void DolphinFacetsWidget::initComboBox(QComboBox *combo)
 235 {
 236     combo->setFrame(false);
 237     combo->setMinimumHeight(parentWidget()->height());
 238     combo->setCurrentIndex(0);
 239     connect(combo, &QComboBox::activated, this, &DolphinFacetsWidget::facetChanged);
 240 }
 241
 242 void DolphinFacetsWidget::updateTagsSelector()
 243 {
 244     const bool hasListedTags = !m_tagsSelector->menu()->isEmpty();
 245     const bool hasSelectedTags = !m_searchTags.isEmpty();
 246
 247     if (hasSelectedTags) {
 248         const QString tagsText = m_searchTags.join(i18nc("String list separator", ", "));
 249         m_tagsSelector->setText(i18ncp("@action:button %2 is a list of tags", "Tag: %2", "Tags: %2", m_searchTags.count(), tagsText));
 250     } else {
 251         m_tagsSelector->setText(i18nc("@action:button", "Add Tags"));
 252     }
 253
 254     m_tagsSelector->setEnabled(isEnabled() && (hasListedTags || hasSelectedTags));
 255     m_clearTagsAction->setEnabled(hasSelectedTags);
 256 }
 257
 258 void DolphinFacetsWidget::updateTagsMenu()
 259 {
 260     updateTagsMenuItems({}, {});
 261     if (KProtocolInfo::isKnownProtocol(QStringLiteral("tags"))) {
 262         m_tagsLister.openUrl(QUrl(QStringLiteral("tags:/")), KCoreDirLister::OpenUrlFlag::Reload);
 263     }
 264 }
 265
 266 void DolphinFacetsWidget::updateTagsMenuItems(const QUrl &, const KFileItemList &items)
 267 {
 268     QMenu *tagsMenu = m_tagsSelector->menu();
 269     tagsMenu->clear();
 270
 271     QStringList allTags = QStringList(m_searchTags);
 272     for (const KFileItem &item : items) {
 273         allTags.append(item.name());
 274     }
 275     allTags.sort(Qt::CaseInsensitive);
 276     allTags.removeDuplicates();
 277
 278     const bool onlyOneTag = allTags.count() == 1;
 279
 280     for (const QString &tagName : qAsConst(allTags)) {
 281         QAction *action = tagsMenu->addAction(QIcon::fromTheme(QStringLiteral("tag")), tagName);
 282         action->setCheckable(true);
 283         action->setChecked(m_searchTags.contains(tagName));
 284
 285         connect(action, &QAction::triggered, this, [this, tagName, onlyOneTag](bool isChecked) {
 286             if (isChecked) {
 287                 addSearchTag(tagName);
 288             } else {
 289                 removeSearchTag(tagName);
 290             }
 291             Q_EMIT facetChanged();
 292
 293             if (!onlyOneTag) {
 294                 m_tagsSelector->menu()->show();
 295             }
 296         });
 297     }
 298
 299     if (allTags.count() > 1) {
 300         tagsMenu->addSeparator();
 301         tagsMenu->addAction(m_clearTagsAction);
 302     }
 303
 304     updateTagsSelector();
 305 }