Expand DolphinQuery to support different Url schemes

diff --git a/src/search/dolphinquery.cpp b/src/search/dolphinquery.cpp
index ab107f43fab736e3a39407017dd5a7dd28f2abbf..0581a02ece041fcc242ca13388d72131ca5e44d4 100644 (file)
--- a/src/search/dolphinquery.cpp
+++ b/src/search/dolphinquery.cpp
@@ -27,6 +27,7 @@
 #endif
 
 namespace {
+#ifdef HAVE_BALOO
     /** Checks if a given term in the Baloo::Query::searchString() is a special search term
      * @return: the specific search token of the term, or an empty QString() if none is found
      */
@@ -67,20 +68,40 @@ namespace {
         }
         return textParts;
     }
+#endif
 }
 
-DolphinQuery DolphinQuery::fromBalooSearchUrl(const QUrl& searchUrl)
+
+DolphinQuery DolphinQuery::fromSearchUrl(const QUrl& searchUrl)
 {
     DolphinQuery model;
     model.m_searchUrl = searchUrl;
 
+    if (searchUrl.scheme() == QLatin1String("baloosearch")) {
+        model.parseBalooQuery();
+    }
+
+    return model;
+}
+
+bool DolphinQuery::supportsScheme(const QString& urlScheme)
+{
+    static const QStringList supportedSchemes = {
+        QStringLiteral("baloosearch"),
+    };
+
+    return supportedSchemes.contains(urlScheme);
+}
+
+void DolphinQuery::parseBalooQuery()
+{
 #ifdef HAVE_BALOO
-    const Baloo::Query query = Baloo::Query::fromSearchUrl(searchUrl);
+    const Baloo::Query query = Baloo::Query::fromSearchUrl(m_searchUrl);
 
-    model.m_includeFolder = query.includeFolder();
+    m_includeFolder = query.includeFolder();
 
     const QStringList types = query.types();
-    model.m_fileType = types.isEmpty() ? QString() : types.first();
+    m_fileType = types.isEmpty() ? QString() : types.first();
 
     QStringList textParts;
     QString fileName;
@@ -93,34 +114,33 @@ DolphinQuery DolphinQuery::fromBalooSearchUrl(const QUrl& searchUrl)
         if (token == QLatin1String("filename:")) {
             if (!value.isEmpty()) {
                 fileName = value;
-                model.m_hasFileName = true;
+                m_hasFileName = true;
             }
             continue;
         } else if (!token.isEmpty()) {
-            model.m_searchTerms << token + value;
+            m_searchTerms << token + value;
             continue;
         } else if (subTerm == QLatin1String("AND") && subTerm != subTerms.at(0) && subTerm != subTerms.back()) {
             continue;
         } else if (!value.isEmpty()) {
             textParts << value;
-            model.m_hasContentSearch = true;
+            m_hasContentSearch = true;
         }
     }
 
-    if (model.m_hasFileName) {
-        if (model.m_hasContentSearch) {
+    if (m_hasFileName) {
+        if (m_hasContentSearch) {
             textParts << QStringLiteral("filename:\"%1\"").arg(fileName);
         } else {
             textParts << fileName;
         }
     }
 
-    model.m_searchText = textParts.join(QLatin1Char(' '));
-
+    m_searchText = textParts.join(QLatin1Char(' '));
 #endif
-    return model;
 }
 
+
 QUrl DolphinQuery::searchUrl() const
 {
     return m_searchUrl;

diff --git a/src/search/dolphinquery.h b/src/search/dolphinquery.h
index 544f246bcfe6bea0b184c982fead5df359d011c6..5032621a9e1d9569ae5f328f750dd5fd3d637a5c 100644 (file)
--- a/src/search/dolphinquery.h
+++ b/src/search/dolphinquery.h
@@ -32,9 +32,10 @@
 class DolphinQuery
 {
 public:
-    /** Calls Baloo::Query::fromSearchUrl() with the given @p searchUrl
-     * and parses the result to extract its separate components */
-    static DolphinQuery fromBalooSearchUrl(const QUrl& searchUrl);
+    /** Parses the components of @p searchUrl for the supported schemes */
+    static DolphinQuery fromSearchUrl(const QUrl& searchUrl);
+    /** Checks whether the DolphinQuery supports the given @p urlScheme */
+    static bool supportsScheme(const QString& urlScheme);
 
     /** @return the \a searchUrl passed to Baloo::Query::fromSearchUrl() */
     QUrl searchUrl() const;
@@ -53,6 +54,11 @@ public:
     /** @return whether the query includes a filter by fileName */
     bool hasFileName() const;
 
+private:
+    /** Calls Baloo::Query::fromSearchUrl() on the current searchUrl
+     * and parses the result to extract its separate components */
+    void parseBalooQuery();
+
 private:
     QUrl m_searchUrl;
     QString m_searchText;

diff --git a/src/search/dolphinsearchbox.cpp b/src/search/dolphinsearchbox.cpp
index f0d8c541653478c3b71f18cc0df3a2548baeea54..239280280253f01e490fc98e7b6c87cbd0518046 100644 (file)
--- a/src/search/dolphinsearchbox.cpp
+++ b/src/search/dolphinsearchbox.cpp
@@ -146,8 +146,8 @@ QUrl DolphinSearchBox::urlForSearching() const
 
 void DolphinSearchBox::fromSearchUrl(const QUrl& url)
 {
-    if (url.scheme() == QLatin1String("baloosearch")) {
-        const DolphinQuery query = DolphinQuery::fromBalooSearchUrl(url);
+    if (DolphinQuery::supportsScheme(url.scheme())) {
+        const DolphinQuery query = DolphinQuery::fromSearchUrl(url);
         updateFromQuery(query);
     } else if (url.scheme() == QLatin1String("filenamesearch")) {
         const QUrlQuery query(url);

diff --git a/src/tests/dolphinquerytest.cpp b/src/tests/dolphinquerytest.cpp
index b65ee037fdcc343c6fc3af31589f074574fc0603..a0774e88c8f63a4a682ad06a72eda36ae228ce3d 100644 (file)
--- a/src/tests/dolphinquerytest.cpp
+++ b/src/tests/dolphinquerytest.cpp
@@ -36,11 +36,40 @@ private slots:
     void testBalooSearchParsing();
 };
 
+/**
+ * Helper function to compose the baloo query URL used for searching
+ */
+QUrl balooQueryUrl(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;
+}
+
 /**
  * Defines the parameters for the test cases in testBalooSearchParsing()
  */
 void DolphinSearchBoxTest::testBalooSearchParsing_data()
 {
+
+    QTest::addColumn<QUrl>("searchUrl");
+    QTest::addColumn<QString>("expectedText");
+    QTest::addColumn<QStringList>("expectedTerms");
+    QTest::addColumn<bool>("hasContent");
+    QTest::addColumn<bool>("hasFileName");
+
     const QString text = QStringLiteral("abc");
     const QString textS = QStringLiteral("abc xyz");
     const QString filename = QStringLiteral("filename:\"%1\"").arg(text);
@@ -53,115 +82,89 @@ void DolphinSearchBoxTest::testBalooSearchParsing_data()
     const QString tagS = QStringLiteral("tag:\"tagB with spaces\"");  // in search url
     const QString tagR = QStringLiteral("tag:tagB with spaces");      // in result term
 
-    QTest::addColumn<QString>("searchString");
-    QTest::addColumn<QString>("expectedText");
-    QTest::addColumn<QStringList>("expectedTerms");
-    QTest::addColumn<bool>("hasContent");
-    QTest::addColumn<bool>("hasFileName");
-
     // Test for "Content"
-    QTest::newRow("content")              << text    << text  << QStringList() << true  << false;
-    QTest::newRow("content/space")        << textS   << textS << QStringList() << true  << false;
-    QTest::newRow("content/empty")        << ""      << ""    << QStringList() << false << false;
-    QTest::newRow("content/single_quote") << "\""    << "\""  << QStringList() << true  << false;
-    QTest::newRow("content/double_quote") << "\"\""  << ""    << QStringList() << false << false;
+    QTest::newRow("content")              << balooQueryUrl(text)   << text  << QStringList() << true  << false;
+    QTest::newRow("content/space")        << balooQueryUrl(textS)  << textS << QStringList() << true  << false;
+    QTest::newRow("content/empty")        << balooQueryUrl("")     << ""    << QStringList() << false << false;
+    QTest::newRow("content/single_quote") << balooQueryUrl("\"")   << "\""  << QStringList() << true  << false;
+    QTest::newRow("content/double_quote") << balooQueryUrl("\"\"") << ""    << QStringList() << false << false;
 
     // Test for "FileName"
-    QTest::newRow("filename")              << filename        << text  << QStringList() << false << true;
-    QTest::newRow("filename/space")        << filenameS       << textS << QStringList() << false << true;
-    QTest::newRow("filename/empty")        << "filename:"     << ""    << QStringList() << false << false;
-    QTest::newRow("filename/single_quote") << "filename:\""   << "\""  << QStringList() << false << true;
-    QTest::newRow("filename/double_quote") << "filename:\"\"" << ""    << QStringList() << false << false;
+    QTest::newRow("filename")              << balooQueryUrl(filename)        << text  << QStringList() << false << true;
+    QTest::newRow("filename/space")        << balooQueryUrl(filenameS)       << textS << QStringList() << false << true;
+    QTest::newRow("filename/empty")        << balooQueryUrl("filename:")     << ""    << QStringList() << false << false;
+    QTest::newRow("filename/single_quote") << balooQueryUrl("filename:\"")   << "\""  << QStringList() << false << true;
+    QTest::newRow("filename/double_quote") << balooQueryUrl("filename:\"\"") << ""    << QStringList() << false << false;
 
     // Combined content and filename search
     QTest::newRow("content+filename")
-        << text + " " + filename
+        << balooQueryUrl(text + " " + filename)
         << text + " " + filename << QStringList() << true << true;
 
     // Test for rating
-    QTest::newRow("rating")          << rating                  << ""   << QStringList({rating}) << false << false;
-    QTest::newRow("rating+content")  << rating + " " + text     << text << QStringList({rating}) << true  << false;
-    QTest::newRow("rating+filename") << rating + " " + filename << text << QStringList({rating}) << false << true;
+    QTest::newRow("rating")          << balooQueryUrl(rating)                  << ""   << QStringList({rating}) << false << false;
+    QTest::newRow("rating+content")  << balooQueryUrl(rating + " " + text)     << text << QStringList({rating}) << true  << false;
+    QTest::newRow("rating+filename") << balooQueryUrl(rating + " " + filename) << text << QStringList({rating}) << false << true;
 
     // Test for modified date
-    QTest::newRow("modified")          << modified                  << ""   << QStringList({modified}) << false << false;
-    QTest::newRow("modified+content")  << modified + " " + text     << text << QStringList({modified}) << true  << false;
-    QTest::newRow("modified+filename") << modified + " " + filename << text << QStringList({modified}) << false << true;
+    QTest::newRow("modified")          << balooQueryUrl(modified)                  << ""   << QStringList({modified}) << false << false;
+    QTest::newRow("modified+content")  << balooQueryUrl(modified + " " + text)     << text << QStringList({modified}) << true  << false;
+    QTest::newRow("modified+filename") << balooQueryUrl(modified + " " + filename) << text << QStringList({modified}) << false << true;
 
     // Test for tags
-    QTest::newRow("tag")          << tag                  << ""   << QStringList({tag})       << false << false;
-    QTest::newRow("tag/space" )   << tagS                 << ""   << QStringList({tagR})      << false << false;
-    QTest::newRow("tag/double")   << tag + " " + tagS     << ""   << QStringList({tag, tagR}) << false << false;
-    QTest::newRow("tag+content")  << tag + " " + text     << text << QStringList({tag})       << true  << false;
-    QTest::newRow("tag+filename") << tag + " " + filename << text << QStringList({tag})       << false << true;
+    QTest::newRow("tag")          << balooQueryUrl(tag)                  << ""   << QStringList({tag})       << false << false;
+    QTest::newRow("tag/space" )   << balooQueryUrl(tagS)                 << ""   << QStringList({tagR})      << false << false;
+    QTest::newRow("tag/double")   << balooQueryUrl(tag + " " + tagS)     << ""   << QStringList({tag, tagR}) << false << false;
+    QTest::newRow("tag+content")  << balooQueryUrl(tag + " " + text)     << text << QStringList({tag})       << true  << false;
+    QTest::newRow("tag+filename") << balooQueryUrl(tag + " " + filename) << text << QStringList({tag})       << false << true;
 
     // Combined search terms
     QTest::newRow("searchTerms")
-        << rating + " AND " + modified + " AND " + tag + " AND " + tagS
+        << balooQueryUrl(rating + " AND " + modified + " AND " + tag + " AND " + tagS)
         << "" << QStringList({modified, rating, tag, tagR}) << false << false;
 
     QTest::newRow("searchTerms+content")
-        << rating + " AND " + modified + " " + text + " " + tag + " AND " + tagS
+        << balooQueryUrl(rating + " AND " + modified + " " + text + " " + tag + " AND " + tagS)
         << text << QStringList({modified, rating, tag, tagR}) << true << false;
 
     QTest::newRow("searchTerms+filename")
-        << rating + " AND " + modified + " " + filename + " " + tag + " AND " + tagS
+        << balooQueryUrl(rating + " AND " + modified + " " + filename + " " + tag + " AND " + tagS)
         << text << QStringList({modified, rating, tag, tagR}) << false << true;
 
     QTest::newRow("allTerms")
-        << text + " " + filename + " " + rating + " AND " + modified + " AND " + tag
+        << balooQueryUrl(text + " " + filename + " " + rating + " AND " + modified + " AND " + tag)
         << text + " " + filename << QStringList({modified, rating, tag}) << true << true;
 
     QTest::newRow("allTerms/space")
-        << textS + " " + filenameS + " " + rating + " AND " + modified + " AND " + tagS
+        << balooQueryUrl(textS + " " + filenameS + " " + rating + " AND " + modified + " AND " + tagS)
         << textS + " " + filenameS << QStringList({modified, rating, tagR}) << true << true;
 }
 
 /**
- * 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
+ * The test verifies whether the different terms search URL (e.g. "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(QUrl, searchUrl);
     QFETCH(QString, expectedText);
     QFETCH(QStringList, expectedTerms);
     QFETCH(bool, hasContent);
     QFETCH(bool, hasFileName);
 
-    const QUrl testUrl = composeQueryUrl(searchString);
-    const DolphinQuery query = DolphinQuery::fromBalooSearchUrl(testUrl);
+    const DolphinQuery query = DolphinQuery::fromSearchUrl(searchUrl);
 
-    QStringList searchTerms = query.searchTerms();
-    searchTerms.sort();
+    // Checkt that the URL is supported
+    QVERIFY(DolphinQuery::supportsScheme(searchUrl.scheme()));
 
     // 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)
+    QStringList searchTerms = query.searchTerms();
+    searchTerms.sort();
+
     QCOMPARE(searchTerms.count(), expectedTerms.count());
     for (int i = 0; i < expectedTerms.count(); i++) {
         QCOMPARE(searchTerms.at(i), expectedTerms.at(i));