diff --git a/src/search/dolphinfacetswidget.cpp b/src/search/dolphinfacetswidget.cpp index ae05509e7..c0b6c5243 100644 --- a/src/search/dolphinfacetswidget.cpp +++ b/src/search/dolphinfacetswidget.cpp @@ -1,193 +1,301 @@ /*************************************************************************** * Copyright (C) 2012 by Peter Penz * * Copyright (C) 2019 by Ismael Asensio * * * * This program is free software; you can redistribute it and/or modify * * it under the terms of the GNU General Public License as published by * * the Free Software Foundation; either version 2 of the License, or * * (at your option) any later version. * * * * This program is distributed in the hope that it will be useful, * * but WITHOUT ANY WARRANTY; without even the implied warranty of * * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * * GNU General Public License for more details. * * * * You should have received a copy of the GNU General Public License * * along with this program; if not, write to the * * Free Software Foundation, Inc., * * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * * **************************************************************************/ #include "dolphinfacetswidget.h" #include #include #include #include #include #include +#include +#include DolphinFacetsWidget::DolphinFacetsWidget(QWidget* parent) : QWidget(parent), m_typeSelector(nullptr), m_dateSelector(nullptr), - m_ratingSelector(nullptr) + m_ratingSelector(nullptr), + m_tagsSelector(nullptr) { m_typeSelector = new QComboBox(this); m_typeSelector->addItem(QIcon::fromTheme(QStringLiteral("none")), i18nc("@item:inlistbox", "Any Type"), QString()); m_typeSelector->addItem(QIcon::fromTheme(QStringLiteral("inode-directory")), i18nc("@item:inlistbox", "Folders") , QStringLiteral("Folder")); m_typeSelector->addItem(QIcon::fromTheme(QStringLiteral("text-x-generic")), i18nc("@item:inlistbox", "Documents") , QStringLiteral("Document")); m_typeSelector->addItem(QIcon::fromTheme(QStringLiteral("image-x-generic")), i18nc("@item:inlistbox", "Images") , QStringLiteral("Image")); m_typeSelector->addItem(QIcon::fromTheme(QStringLiteral("audio-x-generic")), i18nc("@item:inlistbox", "Audio Files"), QStringLiteral("Audio")); m_typeSelector->addItem(QIcon::fromTheme(QStringLiteral("video-x-generic")), i18nc("@item:inlistbox", "Videos") , QStringLiteral("Video")); initComboBox(m_typeSelector); const QDate currentDate = QDate::currentDate(); m_dateSelector = new QComboBox(this); m_dateSelector->addItem(QIcon::fromTheme(QStringLiteral("view-calendar")), i18nc("@item:inlistbox", "Any Date"), QDate()); m_dateSelector->addItem(QIcon::fromTheme(QStringLiteral("go-jump-today")), i18nc("@item:inlistbox", "Today") , currentDate); m_dateSelector->addItem(QIcon::fromTheme(QStringLiteral("go-jump-today")), i18nc("@item:inlistbox", "Yesterday") , currentDate.addDays(-1)); m_dateSelector->addItem(QIcon::fromTheme(QStringLiteral("view-calendar-week")), i18nc("@item:inlistbox", "This Week") , currentDate.addDays(1 - currentDate.dayOfWeek())); m_dateSelector->addItem(QIcon::fromTheme(QStringLiteral("view-calendar-month")), i18nc("@item:inlistbox", "This Month"), currentDate.addDays(1 - currentDate.day())); m_dateSelector->addItem(QIcon::fromTheme(QStringLiteral("view-calendar-year")), i18nc("@item:inlistbox", "This Year") , currentDate.addDays(1 - currentDate.dayOfYear())); initComboBox(m_dateSelector); m_ratingSelector = new QComboBox(this); m_ratingSelector->addItem(QIcon::fromTheme(QStringLiteral("non-starred-symbolic")), i18nc("@item:inlistbox", "Any Rating"), 0); m_ratingSelector->addItem(QIcon::fromTheme(QStringLiteral("starred-symbolic")), i18nc("@item:inlistbox", "1 or more"), 1); m_ratingSelector->addItem(QIcon::fromTheme(QStringLiteral("starred-symbolic")), i18nc("@item:inlistbox", "2 or more"), 2); m_ratingSelector->addItem(QIcon::fromTheme(QStringLiteral("starred-symbolic")), i18nc("@item:inlistbox", "3 or more"), 3); m_ratingSelector->addItem(QIcon::fromTheme(QStringLiteral("starred-symbolic")), i18nc("@item:inlistbox", "4 or more"), 4); m_ratingSelector->addItem(QIcon::fromTheme(QStringLiteral("starred-symbolic")), i18nc("@item:inlistbox", "Highest Rating"), 5); initComboBox(m_ratingSelector); + m_tagsSelector = new QToolButton(this); + m_tagsSelector->setIcon(QIcon::fromTheme(QStringLiteral("tag"))); + m_tagsSelector->setMenu(new QMenu(this)); + m_tagsSelector->setToolButtonStyle(Qt::ToolButtonTextBesideIcon); + m_tagsSelector->setPopupMode(QToolButton::MenuButtonPopup); + m_tagsSelector->setAutoRaise(true); + updateTagsSelector(); + + connect(m_tagsSelector, &QToolButton::clicked, m_tagsSelector, &QToolButton::showMenu); + connect(m_tagsSelector->menu(), &QMenu::aboutToShow, this, &DolphinFacetsWidget::updateTagsMenu); + connect(&m_tagsLister, &KCoreDirLister::itemsAdded, this, &DolphinFacetsWidget::updateTagsMenuItems); + updateTagsMenu(); + QHBoxLayout* topLayout = new QHBoxLayout(this); topLayout->setContentsMargins(0, 0, 0, 0); topLayout->addWidget(m_typeSelector); topLayout->addWidget(m_dateSelector); topLayout->addWidget(m_ratingSelector); + topLayout->addWidget(m_tagsSelector); resetOptions(); } DolphinFacetsWidget::~DolphinFacetsWidget() { } void DolphinFacetsWidget::changeEvent(QEvent *event) { - if (event->type() == QEvent::EnabledChange && !isEnabled()) { - resetOptions(); + if (event->type() == QEvent::EnabledChange) { + if (isEnabled()) { + updateTagsSelector(); + } else { + resetOptions(); + } } } void DolphinFacetsWidget::resetOptions() { m_typeSelector->setCurrentIndex(0); m_dateSelector->setCurrentIndex(0); m_ratingSelector->setCurrentIndex(0); + + m_searchTags = QStringList(); + updateTagsSelector(); + updateTagsMenu(); } QString DolphinFacetsWidget::ratingTerm() const { QStringList terms; if (m_ratingSelector->currentIndex() > 0) { const int rating = m_ratingSelector->currentData().toInt() * 2; terms << QStringLiteral("rating>=%1").arg(rating); } if (m_dateSelector->currentIndex() > 0) { const QDate date = m_dateSelector->currentData().toDate(); terms << QStringLiteral("modified>=%1").arg(date.toString(Qt::ISODate)); } + if (!m_searchTags.isEmpty()) { + for (auto const &tag : m_searchTags) { + terms << QStringLiteral("tag:%1").arg(tag); + } + } + return terms.join(QLatin1String(" AND ")); } QString DolphinFacetsWidget::facetType() const { return m_typeSelector->currentData().toString(); } bool DolphinFacetsWidget::isRatingTerm(const QString& term) const { const QStringList subTerms = term.split(' ', QString::SkipEmptyParts); // If term has sub terms, then sone of the sub terms are always "rating" and "modified" terms. bool containsRating = false; bool containsModified = false; + bool containsTag = false; foreach (const QString& subTerm, subTerms) { if (subTerm.startsWith(QLatin1String("rating>="))) { containsRating = true; } else if (subTerm.startsWith(QLatin1String("modified>="))) { containsModified = true; + } else if (subTerm.startsWith(QLatin1String("tag:")) || + subTerm.startsWith(QLatin1String("tag="))) { + containsTag = true; } } - return containsModified || containsRating; + return containsModified || containsRating || containsTag; } void DolphinFacetsWidget::setRatingTerm(const QString& term) { // If term has sub terms, then the sub terms are always "rating" and "modified" terms. // If term has no sub terms, then the term itself is either a "rating" term or a "modified" // term. To avoid code duplication we add term to subTerms list, if the list is empty. QStringList subTerms = term.split(' ', QString::SkipEmptyParts); foreach (const QString& subTerm, subTerms) { if (subTerm.startsWith(QLatin1String("modified>="))) { const QString value = subTerm.mid(10); const QDate date = QDate::fromString(value, Qt::ISODate); setTimespan(date); } else if (subTerm.startsWith(QLatin1String("rating>="))) { const QString value = subTerm.mid(8); const int stars = value.toInt() / 2; setRating(stars); + } else if (subTerm.startsWith(QLatin1String("tag:")) || + subTerm.startsWith(QLatin1String("tag="))) { + const QString value = subTerm.mid(4); + addSearchTag(value); } } } void DolphinFacetsWidget::setFacetType(const QString& type) { for (int index = 0; index <= m_typeSelector->count(); index++) { if (type == m_typeSelector->itemData(index).toString()) { m_typeSelector->setCurrentIndex(index); break; } } } void DolphinFacetsWidget::setRating(const int stars) { if (stars < 0 || stars > 5) { return; } m_ratingSelector->setCurrentIndex(stars); } void DolphinFacetsWidget::setTimespan(const QDate& date) { if (!date.isValid()) { return; } m_dateSelector->setCurrentIndex(0); for (int index = 1; index <= m_dateSelector->count(); index++) { if (date >= m_dateSelector->itemData(index).toDate()) { m_dateSelector->setCurrentIndex(index); break; } } } +void DolphinFacetsWidget::addSearchTag(const QString& tag) +{ + if (tag.isEmpty() || m_searchTags.contains(tag)) { + return; + } + m_searchTags.append(tag); + m_searchTags.sort(); + updateTagsSelector(); +} + +void DolphinFacetsWidget::removeSearchTag(const QString& tag) +{ + if (tag.isEmpty() || !m_searchTags.contains(tag)) { + return; + } + m_searchTags.removeAll(tag); + updateTagsSelector(); +} + void DolphinFacetsWidget::initComboBox(QComboBox* combo) { combo->setFrame(false); combo->setMinimumHeight(parentWidget()->height()); combo->setCurrentIndex(0); connect(combo, QOverload::of(&QComboBox::activated), this, &DolphinFacetsWidget::facetChanged); } +void DolphinFacetsWidget::updateTagsSelector() +{ + const bool hasListedTags = !m_tagsSelector->menu()->isEmpty(); + const bool hasSelectedTags = !m_searchTags.isEmpty(); + + if (hasSelectedTags) { + const QString tagsText = m_searchTags.join(i18nc("String list separator", ", ")); + m_tagsSelector->setText(i18ncp("@action:button %2 is a list of tags", + "Tag: %2", "Tags: %2",m_searchTags.count(), tagsText)); + } else { + m_tagsSelector->setText(i18nc("@action:button", "Add Tags")); + } + + m_tagsSelector->setEnabled(isEnabled() && (hasListedTags || hasSelectedTags)); +} + +void DolphinFacetsWidget::updateTagsMenu() +{ + updateTagsMenuItems({}, {}); + m_tagsLister.openUrl(QUrl(QStringLiteral("tags:/")), KCoreDirLister::OpenUrlFlag::Reload); +} + +void DolphinFacetsWidget::updateTagsMenuItems(const QUrl&, const KFileItemList& items) +{ + m_tagsSelector->menu()->clear(); + + QStringList allTags = QStringList(m_searchTags); + for (const KFileItem &item: items) { + allTags.append(item.name()); + } + allTags.sort(Qt::CaseInsensitive); + allTags.removeDuplicates(); + + for (const QString& tagName : qAsConst(allTags)) { + QAction* action = m_tagsSelector->menu()->addAction(QIcon::fromTheme(QStringLiteral("tag")), tagName); + action->setCheckable(true); + action->setChecked(m_searchTags.contains(tagName)); + + connect(action, &QAction::triggered, this, [this, tagName](bool isChecked) { + if (isChecked) { + addSearchTag(tagName); + } else { + removeSearchTag(tagName); + } + emit facetChanged(); + }); + } + + updateTagsSelector(); +} diff --git a/src/search/dolphinfacetswidget.h b/src/search/dolphinfacetswidget.h index 0a8a5161f..5325074c6 100644 --- a/src/search/dolphinfacetswidget.h +++ b/src/search/dolphinfacetswidget.h @@ -1,80 +1,94 @@ /*************************************************************************** * Copyright (C) 2012 by Peter Penz * * * * This program is free software; you can redistribute it and/or modify * * it under the terms of the GNU General Public License as published by * * the Free Software Foundation; either version 2 of the License, or * * (at your option) any later version. * * * * This program is distributed in the hope that it will be useful, * * but WITHOUT ANY WARRANTY; without even the implied warranty of * * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * * GNU General Public License for more details. * * * * You should have received a copy of the GNU General Public License * * along with this program; if not, write to the * * Free Software Foundation, Inc., * * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * ***************************************************************************/ #ifndef DOLPHINFACETSWIDGET_H #define DOLPHINFACETSWIDGET_H #include +#include class QComboBox; class QDate; class QEvent; +class QToolButton; /** * @brief Allows to filter search-queries by facets. * * TODO: The current implementation is a temporary * workaround for the 4.9 release and represents no * real facets-implementation yet: There have been * some Dolphin specific user-interface and interaction * issues since 4.6 by embedding the Nepomuk facet-widget * into a QDockWidget (this is unrelated to the * Nepomuk facet-widget itself). Now in combination * with the search-shortcuts in the Places Panel some * existing issues turned into real showstoppers. * * So the longterm plan is to use the Nepomuk facets * again as soon as possible. */ class DolphinFacetsWidget : public QWidget { Q_OBJECT public: explicit DolphinFacetsWidget(QWidget* parent = nullptr); ~DolphinFacetsWidget() override; void resetOptions(); QString ratingTerm() const; QString facetType() const; bool isRatingTerm(const QString& term) const; void setRatingTerm(const QString& term); void setFacetType(const QString& type); signals: void facetChanged(); protected: void changeEvent(QEvent* event) override; +private slots: + void updateTagsMenu(); + void updateTagsMenuItems(const QUrl&, const KFileItemList& items); + private: void setRating(const int stars); void setTimespan(const QDate& date); + void addSearchTag(const QString& tag); + void removeSearchTag(const QString& tag); + void initComboBox(QComboBox* combo); + void updateTagsSelector(); private: QComboBox* m_typeSelector; QComboBox* m_dateSelector; QComboBox* m_ratingSelector; + QToolButton* m_tagsSelector; + + QStringList m_searchTags; + KCoreDirLister m_tagsLister; }; #endif diff --git a/src/search/dolphinquery.cpp b/src/search/dolphinquery.cpp index 8f8cb09ec..92694c093 100644 --- a/src/search/dolphinquery.cpp +++ b/src/search/dolphinquery.cpp @@ -1,116 +1,117 @@ /*************************************************************************** * Copyright (C) 2019 by Ismael Asensio * * * * This program is free software; you can redistribute it and/or modify * * it under the terms of the GNU General Public License as published by * * the Free Software Foundation; either version 2 of the License, or * * (at your option) any later version. * * * * This program is distributed in the hope that it will be useful, * * but WITHOUT ANY WARRANTY; without even the implied warranty of * * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * * GNU General Public License for more details. * * * * You should have received a copy of the GNU General Public License * * along with this program; if not, write to the * * Free Software Foundation, Inc., * * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * ***************************************************************************/ #include "dolphinquery.h" #include #ifdef HAVE_BALOO #include #endif namespace { /** Checks if a given term in the Baloo::Query::searchString() is a special search term. * This is a copy of `DolphinFacetsWidget::isRatingTerm()` method. */ bool isSearchTerm(const QString& term) { static const QLatin1String searchTokens[] { QLatin1String("modified>="), - QLatin1String("rating>=") + QLatin1String("rating>="), + QLatin1String("tag:"), QLatin1String("tag=") }; for (const auto &searchToken : searchTokens) { if (term.startsWith(searchToken)) { return true; } } return false; } } DolphinQuery DolphinQuery::fromBalooSearchUrl(const QUrl& searchUrl) { DolphinQuery model; model.m_searchUrl = searchUrl; #ifdef HAVE_BALOO const Baloo::Query query = Baloo::Query::fromSearchUrl(searchUrl); model.m_includeFolder = query.includeFolder(); const QStringList types = query.types(); model.m_fileType = types.isEmpty() ? QString() : types.first(); QStringList textParts; const QStringList subTerms = query.searchString().split(' ', QString::SkipEmptyParts); foreach (const QString& subTerm, subTerms) { QString value; if (subTerm.startsWith(QLatin1String("filename:"))) { value = subTerm.mid(9); } else if (isSearchTerm(subTerm)) { model.m_searchTerms << subTerm; continue; } else if (subTerm == QLatin1String("AND") && subTerm != subTerms.at(0) && subTerm != subTerms.back()) { continue; } else { value = subTerm; } if (!value.isEmpty() && value.at(0) == QLatin1Char('"')) { value = value.mid(1); } if (!value.isEmpty() && value.back() == QLatin1Char('"')) { value = value.mid(0, value.size() - 1); } if (!value.isEmpty()) { textParts << value; } } model.m_searchText = textParts.join(QLatin1Char(' ')); #endif return model; } QUrl DolphinQuery::searchUrl() const { return m_searchUrl; } QString DolphinQuery::text() const { return m_searchText; } QString DolphinQuery::type() const { return m_fileType; } QStringList DolphinQuery::searchTerms() const { return m_searchTerms; } QString DolphinQuery::includeFolder() const { return m_includeFolder; } diff --git a/src/tests/dolphinquerytest.cpp b/src/tests/dolphinquerytest.cpp index 1c6b39e26..e3c6fb8e3 100644 --- a/src/tests/dolphinquerytest.cpp +++ b/src/tests/dolphinquerytest.cpp @@ -1,129 +1,152 @@ /*************************************************************************** * Copyright (C) 2019 by Ismael Asensio * * * * This program is free software; you can redistribute it and/or modify * * it under the terms of the GNU General Public License as published by * * the Free Software Foundation; either version 2 of the License, or * * (at your option) any later version. * * * * This program is distributed in the hope that it will be useful, * * but WITHOUT ANY WARRANTY; without even the implied warranty of * * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * * GNU General Public License for more details. * * * * You should have received a copy of the GNU General Public License * * along with this program; if not, write to the * * Free Software Foundation, Inc., * * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * ***************************************************************************/ #include "search/dolphinquery.h" #include #include #include #include #include #include class DolphinSearchBoxTest : public QObject { Q_OBJECT private slots: void testBalooSearchParsing_data(); void testBalooSearchParsing(); }; /** * Defines the parameters for the test cases in testBalooSearchParsing() */ void DolphinSearchBoxTest::testBalooSearchParsing_data() { const QString text = QStringLiteral("xyz"); const QString filename = QStringLiteral("filename:\"xyz\""); const QString rating = QStringLiteral("rating>=2"); const QString modified = QString("modified>=2019-08-07"); + const QString tagA = QString("tag:tagA"); + const QString tagB = QString("tag:tagB"); QTest::addColumn("searchString"); QTest::addColumn("expectedText"); QTest::addColumn("expectedTerms"); // Test for "Content" QTest::newRow("content") << text << text << QStringList(); QTest::newRow("content/empty") << "" << "" << QStringList(); QTest::newRow("content/singleQuote") << "\"" << "" << QStringList(); QTest::newRow("content/doubleQuote") << "\"\"" << "" << QStringList(); - // Test for empty `filename` + + // Test for "Filename" QTest::newRow("filename") << filename << text << QStringList(); QTest::newRow("filename/empty") << "filename:" << "" << QStringList(); QTest::newRow("filename/singleQuote") << "filename:\"" << "" << QStringList(); QTest::newRow("filename/doubleQuote") << "filename:\"\"" << "" << QStringList(); // Test for rating QTest::newRow("rating") << rating << "" << QStringList({rating}); QTest::newRow("rating+content") << rating + " " + text << text << QStringList({rating}); QTest::newRow("rating+filename") << rating + " " + filename << text << QStringList({rating}); + // Test for modified date QTest::newRow("modified") << modified << "" << QStringList({modified}); QTest::newRow("modified+content") << modified + " " + text << text << QStringList({modified}); QTest::newRow("modified+filename") << modified + " " + filename << text << QStringList({modified}); + + // Test for tags + QTest::newRow("tag") << tagA << "" << QStringList({tagA}); + QTest::newRow("tag/double") << tagA + " " + tagB << "" << QStringList({tagA, tagB}); + QTest::newRow("tag+content") << tagA + " " + text << text << QStringList({tagA}); + QTest::newRow("tag+filename") << tagA + " " + filename << text << QStringList({tagA}); + // Combined tests - QTest::newRow("rating+modified") << rating + " AND " + modified << "" << QStringList({modified, rating}); - QTest::newRow("rating+modified+content") << rating + " AND " + modified + " " + text << text << QStringList({modified, rating}); - QTest::newRow("rating+modified+filename") << rating + " AND " + modified + " " + filename << text << QStringList({modified, rating}); + QTest::newRow("rating+modified") + << rating + " AND " + modified + << "" << QStringList({modified, rating}); + + QTest::newRow("allTerms") + << rating + " AND " + modified + " AND " + tagA + " AND " + tagB + << "" << QStringList({modified, rating, tagA, tagB}); + + QTest::newRow("allTerms+content") + << rating + " AND " + modified + " " + text + " " + tagA + " AND " + tagB + << text << QStringList({modified, rating, tagA, tagB}); + + QTest::newRow("allTerms+filename") + << rating + " AND " + modified + " " + filename + " " + tagA + " AND " + tagB + << text << QStringList({modified, rating, tagA, tagB}); } /** * Helper function to compose the baloo query URL used for searching */ QUrl composeQueryUrl(const QString& searchString) { const QJsonObject jsonObject { {"searchString", searchString} }; const QJsonDocument doc(jsonObject); const QString queryString = QString::fromUtf8(doc.toJson(QJsonDocument::Compact)); QUrlQuery urlQuery; urlQuery.addQueryItem(QStringLiteral("json"), queryString); QUrl searchUrl; searchUrl.setScheme(QLatin1String("baloosearch")); searchUrl.setQuery(urlQuery); return searchUrl; } /** * The test verifies whether the different terms of a Baloo search URL ("baloosearch:") are * properly handled by the searchbox, and only "user" or filename terms are added to the * text bar of the searchbox. */ void DolphinSearchBoxTest::testBalooSearchParsing() { QFETCH(QString, searchString); QFETCH(QString, expectedText); QFETCH(QStringList, expectedTerms); const QUrl testUrl = composeQueryUrl(searchString); const DolphinQuery query = DolphinQuery::fromBalooSearchUrl(testUrl); QStringList searchTerms = query.searchTerms(); searchTerms.sort(); // Check for parsed text (would be displayed on the input search bar) QCOMPARE(query.text(), expectedText); // Check for parsed search terms (would be displayed by the facetsWidget) QCOMPARE(searchTerms.count(), expectedTerms.count()); for (int i = 0; i < expectedTerms.count(); i++) { QCOMPARE(searchTerms.at(i), expectedTerms.at(i)); } } QTEST_MAIN(DolphinSearchBoxTest) #include "dolphinquerytest.moc"