]> cloud.milkyroute.net Git - dolphin.git/blobdiff - src/search/dolphinquery.cpp
GIT_SILENT made messages (after extraction)
[dolphin.git] / src / search / dolphinquery.cpp
index 95efe9162a773b3951543e20786fdbb6017e951c..ed2a6a766b98a6d988aa23b721629e5e5c73654f 100644 (file)
-/***************************************************************************
- *   Copyright (C) 2019 by Ismael Asensio <isma.af@mgmail.com>             *
- *                                                                         *
- *   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            *
- ***************************************************************************/
+/*
+ * SPDX-FileCopyrightText: 2019 Ismael Asensio <isma.af@mgmail.com>
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
 
 #include "dolphinquery.h"
 
 #include <QRegularExpression>
 
-#include <config-baloo.h>
-#ifdef HAVE_BALOO
+#include "config-dolphin.h"
+#if HAVE_BALOO
 #include <Baloo/Query>
 #endif
 
-namespace {
-    /** Checks if a given term in the Baloo::Query::searchString() is a special search term.
-     * This is a copy of `DolphinFacetsWidget::isSearchTerm()` method.
-     */
-    bool isSearchTerm(const QString& term)
-    {
-        static const QLatin1String searchTokens[] {
-            QLatin1String("modified>="),
-            QLatin1String("rating>="),
-            QLatin1String("tag:"), QLatin1String("tag=")
-        };
-
-        for (const auto &searchToken : searchTokens) {
-            if (term.startsWith(searchToken)) {
-                return true;
-            }
+namespace
+{
+#if 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
+ */
+QString searchTermToken(const QString &term)
+{
+    static const QLatin1String searchTokens[]{QLatin1String("filename:"),
+                                              QLatin1String("modified>="),
+                                              QLatin1String("rating>="),
+                                              QLatin1String("tag:"),
+                                              QLatin1String("tag=")};
+
+    for (const auto &searchToken : searchTokens) {
+        if (term.startsWith(searchToken)) {
+            return searchToken;
         }
-        return false;
     }
+    return QString();
+}
 
-    QString stripQuotes(const QString& text)
-    {
-        QString cleanedText = text;
-        if (!cleanedText.isEmpty() && cleanedText.at(0) == QLatin1Char('"')) {
-            cleanedText = cleanedText.mid(1);
-        }
-        if (!cleanedText.isEmpty() && cleanedText.back() == QLatin1Char('"')) {
-            cleanedText = cleanedText.mid(0, cleanedText.size() - 1);
-        }
-        return cleanedText;
+QString stripQuotes(const QString &text)
+{
+    if (text.length() >= 2 && text.at(0) == QLatin1Char('"') && text.back() == QLatin1Char('"')) {
+        return text.mid(1, text.size() - 2);
     }
+    return text;
+}
 
-    QStringList splitOutsideQuotes(const QString& text)
-    {
-        const QRegularExpression subTermsRegExp("([^ ]*\"[^\"]*\"|(?<= |^)[^ ]+(?= |$))");
-        auto subTermsMatchIterator = subTermsRegExp.globalMatch(text);
+QStringList splitOutsideQuotes(const QString &text)
+{
+    // Match groups on 3 possible conditions:
+    //   - Groups with two leading quotes must close both on them (filename:""abc xyz" tuv")
+    //   - Groups enclosed in quotes
+    //   - Words separated by spaces
+    static const QRegularExpression subTermsRegExp("(\\S*?\"\"[^\"]+\"[^\"]+\"+|\\S*?\"[^\"]+\"+|(?<=\\s|^)\\S+(?=\\s|$))");
+    auto subTermsMatchIterator = subTermsRegExp.globalMatch(text);
 
-        QStringList textParts;
-        while (subTermsMatchIterator.hasNext()) {
-            textParts << subTermsMatchIterator.next().captured(0);
-        }
-        return textParts;
+    QStringList textParts;
+    while (subTermsMatchIterator.hasNext()) {
+        textParts << subTermsMatchIterator.next().captured(0);
     }
+    return textParts;
 }
+#endif
 
-DolphinQuery DolphinQuery::fromBalooSearchUrl(const QUrl& searchUrl)
+QString trimChar(const QString &text, const QLatin1Char aChar)
+{
+    const int start = text.startsWith(aChar) ? 1 : 0;
+    const int end = (text.length() > 1 && text.endsWith(aChar)) ? 1 : 0;
+
+    return text.mid(start, text.length() - start - end);
+}
+}
+
+DolphinQuery DolphinQuery::fromSearchUrl(const QUrl &searchUrl)
 {
     DolphinQuery model;
     model.m_searchUrl = searchUrl;
 
-#ifdef HAVE_BALOO
-    const Baloo::Query query = Baloo::Query::fromSearchUrl(searchUrl);
+    if (searchUrl.scheme() == QLatin1String("baloosearch")) {
+        model.parseBalooQuery();
+    } else if (searchUrl.scheme() == QLatin1String("tags")) {
+        // tags can contain # symbols or slashes within the Url
+        QString tag = trimChar(searchUrl.toString(QUrl::RemoveScheme), QLatin1Char('/'));
+        model.m_searchTerms << QStringLiteral("tag:%1").arg(tag);
+    }
+
+    return model;
+}
+
+bool DolphinQuery::supportsScheme(const QString &urlScheme)
+{
+    static const QStringList supportedSchemes = {
+        QStringLiteral("baloosearch"),
+        QStringLiteral("tags"),
+    };
 
-    model.m_includeFolder = query.includeFolder();
+    return supportedSchemes.contains(urlScheme);
+}
+
+void DolphinQuery::parseBalooQuery()
+{
+#if HAVE_BALOO
+    const Baloo::Query query = Baloo::Query::fromSearchUrl(m_searchUrl);
+
+    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;
 
     const QStringList subTerms = splitOutsideQuotes(query.searchString());
-    foreach (const QString& subTerm, subTerms) {
-        if (subTerm.startsWith(QLatin1String("filename:"))) {
-            fileName = stripQuotes(subTerm.mid(9));
-            if (!fileName.isEmpty()) {
-                model.m_hasFileName = true;
+    for (const QString &subTerm : subTerms) {
+        const QString token = searchTermToken(subTerm);
+        const QString value = stripQuotes(subTerm.mid(token.length()));
+
+        if (token == QLatin1String("filename:")) {
+            if (!value.isEmpty()) {
+                fileName = value;
+                m_hasFileName = true;
             }
             continue;
-        } else if (isSearchTerm(subTerm)) {
-            model.m_searchTerms << subTerm;
+        } else if (!token.isEmpty()) {
+            m_searchTerms << token + value;
             continue;
         } else if (subTerm == QLatin1String("AND") && subTerm != subTerms.at(0) && subTerm != subTerms.back()) {
             continue;
-        } else {
-            const QString cleanedTerm = stripQuotes(subTerm);
-            if (!cleanedTerm.isEmpty()) {
-                textParts << cleanedTerm;
-                model.m_hasContentSearch = true;
-            }
+        } else if (!value.isEmpty()) {
+            textParts << value;
+            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