File indexing completed on 2024-04-14 03:49:49

 /*
     This file is part of the KDE Baloo Project
     SPDX-FileCopyrightText: 2013 Vishesh Handa <me@vhanda.in>
 
     SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
 */
 
 #include "query.h"
 #include "term.h"
 #include "advancedqueryparser.h"
 #include "searchstore.h"
 #include "baloodebug.h"
 
 #include <QString>
 #include <QStringList>
 #include <QUrlQuery>
 
 #include <QJsonDocument>
 #include <QJsonObject>
 
 using namespace Baloo;
 
 const int defaultLimit = -1;
 
 class BALOO_CORE_NO_EXPORT Baloo::Query::Private {
 public:
     Term m_term;
 
     QStringList m_types;
     QString m_searchString;
     int m_limit = defaultLimit;
     uint m_offset = 0;
 
     int m_yearFilter = 0;
     int m_monthFilter = 0;
     int m_dayFilter = 0;
 
     SortingOption m_sortingOption = SortAuto;
     QString m_includeFolder;
 };
 
 Query::Query()
     : d(new Private)
 {
 }
 
 Query::Query(const Query& rhs)
     : d(new Private(*rhs.d))
 {
 }
 
 Query::~Query() = default;
 
 void Query::addType(const QString& type)
 {
     d->m_types << type.split(QLatin1Char('/'), Qt::SkipEmptyParts);
 }
 
 void Query::addTypes(const QStringList& typeList)
 {
     for (const QString& type : typeList) {
         addType(type);
     }
 }
 
 void Query::setType(const QString& type)
 {
     d->m_types.clear();
     addType(type);
 }
 
 void Query::setTypes(const QStringList& types)
 {
     d->m_types = types;
 }
 
 QStringList Query::types() const
 {
     return d->m_types;
 }
 
 QString Query::searchString() const
 {
     return d->m_searchString;
 }
 
 void Query::setSearchString(const QString& str)
 {
     d->m_searchString = str;
 
     d->m_term = Term();
 }
 
 uint Query::limit() const
 {
     return d->m_limit;
 }
 
 void Query::setLimit(uint limit)
 {
     d->m_limit = limit;
 }
 
 uint Query::offset() const
 {
     return d->m_offset;
 }
 
 void Query::setOffset(uint offset)
 {
     d->m_offset = offset;
 }
 
 void Query::setDateFilter(int year, int month, int day)
 {
     d->m_yearFilter = year;
     d->m_monthFilter = month;
     d->m_dayFilter = day;
 }
 
 int Query::yearFilter() const
 {
     return d->m_yearFilter;
 }
 
 int Query::monthFilter() const
 {
     return d->m_monthFilter;
 }
 
 int Query::dayFilter() const
 {
     return d->m_dayFilter;
 }
 
 void Query::setSortingOption(Query::SortingOption option)
 {
     d->m_sortingOption = option;
 }
 
 Query::SortingOption Query::sortingOption() const
 {
     return d->m_sortingOption;
 }
 
 QString Query::includeFolder() const
 {
     return d->m_includeFolder;
 }
 
 void Query::setIncludeFolder(const QString& folder)
 {
     d->m_includeFolder = folder;
 }
 
 ResultIterator Query::exec()
 {
     if (!d->m_searchString.isEmpty()) {
         if (d->m_term.isValid()) {
             qCDebug(BALOO) << "Term already set";
         }
         AdvancedQueryParser parser;
         d->m_term = parser.parse(d->m_searchString);
     }
 
     Term term(d->m_term);
     if (!d->m_types.isEmpty()) {
         for (const QString& type : std::as_const(d->m_types)) {
             term = term && Term(QStringLiteral("type"), type);
         }
     }
 
     if (!d->m_includeFolder.isEmpty()) {
         term = term && Term(QStringLiteral("includefolder"), d->m_includeFolder);
     }
 
     if (d->m_yearFilter || d->m_monthFilter || d->m_dayFilter) {
         QByteArray ba = QByteArray::number(d->m_yearFilter);
         if (d->m_monthFilter < 10) {
             ba += '0';
         }
         ba += QByteArray::number(d->m_monthFilter);
         if (d->m_dayFilter < 10) {
             ba += '0';
         }
         ba += QByteArray::number(d->m_dayFilter);
 
         term = term && Term(QStringLiteral("modified"), ba, Term::Equal);
     }
 
     SearchStore searchStore;
     auto results = searchStore.exec(term, d->m_offset, d->m_limit, d->m_sortingOption == SortAuto);
     return ResultIterator(std::move(results));
 }
 
 QByteArray Query::toJSON()
 {
     QVariantMap map;
 
     if (!d->m_types.isEmpty()) {
         map[QStringLiteral("type")] = d->m_types;
     }
 
     if (d->m_limit != defaultLimit) {
         map[QStringLiteral("limit")] = d->m_limit;
     }
 
     if (d->m_offset) {
         map[QStringLiteral("offset")] = d->m_offset;
     }
 
     if (!d->m_searchString.isEmpty()) {
         map[QStringLiteral("searchString")] = d->m_searchString;
     }
 
     if (d->m_term.isValid()) {
         map[QStringLiteral("term")] = QVariant(d->m_term.toVariantMap());
     }
 
     if (d->m_yearFilter > 0) {
         map[QStringLiteral("yearFilter")] = d->m_yearFilter;
     }
     if (d->m_monthFilter > 0) {
         map[QStringLiteral("monthFilter")] = d->m_monthFilter;
     }
     if (d->m_dayFilter > 0) {
         map[QStringLiteral("dayFilter")] = d->m_dayFilter;
     }
 
     if (d->m_sortingOption != SortAuto) {
         map[QStringLiteral("sortingOption")] = static_cast<int>(d->m_sortingOption);
     }
 
     if (!d->m_includeFolder.isEmpty()) {
         map[QStringLiteral("includeFolder")] = d->m_includeFolder;
     }
 
     QJsonObject jo = QJsonObject::fromVariantMap(map);
     QJsonDocument jdoc;
     jdoc.setObject(jo);
     return jdoc.toJson(QJsonDocument::JsonFormat::Compact);
 }
 
 // static
 Query Query::fromJSON(const QByteArray& arr)
 {
     QJsonDocument jdoc = QJsonDocument::fromJson(arr);
     const QVariantMap map = jdoc.object().toVariantMap();
 
     Query query;
     query.d->m_types = map[QStringLiteral("type")].toStringList();
 
     if (map.contains(QStringLiteral("limit"))) {
         query.d->m_limit = map[QStringLiteral("limit")].toUInt();
     } else {
         query.d->m_limit = defaultLimit;
     }
 
     query.d->m_offset = map[QStringLiteral("offset")].toUInt();
     query.d->m_searchString = map[QStringLiteral("searchString")].toString();
     query.d->m_term = Term::fromVariantMap(map[QStringLiteral("term")].toMap());
 
     if (map.contains(QStringLiteral("yearFilter"))) {
         query.d->m_yearFilter = map[QStringLiteral("yearFilter")].toInt();
     }
     if (map.contains(QStringLiteral("monthFilter"))) {
         query.d->m_monthFilter = map[QStringLiteral("monthFilter")].toInt();
     }
     if (map.contains(QStringLiteral("dayFilter"))) {
         query.d->m_dayFilter = map[QStringLiteral("dayFilter")].toInt();
     }
 
     if (map.contains(QStringLiteral("sortingOption"))) {
         int option = map.value(QStringLiteral("sortingOption")).toInt();
         query.d->m_sortingOption = static_cast<SortingOption>(option);
     }
 
     if (map.contains(QStringLiteral("includeFolder"))) {
         query.d->m_includeFolder = map.value(QStringLiteral("includeFolder")).toString();
     }
 
     if (!query.d->m_searchString.isEmpty() && query.d->m_term.isValid()) {
         qCWarning(BALOO) << "Only one of 'searchString' and 'term' should be set:" << arr;
     }
     return query;
 }
 
 QUrl Query::toSearchUrl(const QString& title)
 {
     QUrl url;
     url.setScheme(QStringLiteral("baloosearch"));
 
     QUrlQuery urlQuery;
     urlQuery.addQueryItem(QStringLiteral("json"), QString::fromUtf8(toJSON()));
 
     if (!title.isEmpty()) {
         urlQuery.addQueryItem(QStringLiteral("title"), title);
     }
 
     url.setQuery(urlQuery);
     return url;
 }
 
 static QString jsonQueryFromUrl(const QUrl &url)
 {
     const QString path = url.path();
 
     if (path == QLatin1String("/documents")) {
         return QStringLiteral("{\"type\":[\"Document\"]}");
     } else if (path.endsWith(QLatin1String("/images"))) {
         return QStringLiteral("{\"type\":[\"Image\"]}");
     } else if (path.endsWith(QLatin1String("/audio"))) {
         return QStringLiteral("{\"type\":[\"Audio\"]}");
     } else if (path.endsWith(QLatin1String("/videos"))) {
         return QStringLiteral("{\"type\":[\"Video\"]}");
     }
 
     return QString();
 }
 
 Query Query::fromSearchUrl(const QUrl& url)
 {
     if (url.scheme() != QLatin1String("baloosearch")) {
         return Query();
     }
 
     QUrlQuery urlQuery(url);
 
     if (urlQuery.hasQueryItem(QStringLiteral("json"))) {
         QString jsonString = urlQuery.queryItemValue(QStringLiteral("json"), QUrl::FullyDecoded);
         return Query::fromJSON(jsonString.toUtf8());
     }
 
     if (urlQuery.hasQueryItem(QStringLiteral("query"))) {
         QString queryString = urlQuery.queryItemValue(QStringLiteral("query"), QUrl::FullyDecoded);
         Query q;
         q.setSearchString(queryString);
         return q;
     }
 
     const QString jsonString = jsonQueryFromUrl(url);
     if (!jsonString.isEmpty()) {
         return Query::fromJSON(jsonString.toUtf8());
     }
 
     return Query();
 }
 
 QString Query::titleFromQueryUrl(const QUrl& url)
 {
     QUrlQuery urlQuery(url);
     return urlQuery.queryItemValue(QStringLiteral("title"), QUrl::FullyDecoded);
 }
 
 bool Query::operator==(const Query& rhs) const
 {
     if (rhs.d->m_limit != d->m_limit || rhs.d->m_offset != d->m_offset ||
         rhs.d->m_dayFilter != d->m_dayFilter || rhs.d->m_monthFilter != d->m_monthFilter ||
         rhs.d->m_yearFilter != d->m_yearFilter || rhs.d->m_includeFolder != d->m_includeFolder ||
         rhs.d->m_searchString != d->m_searchString ||
         rhs.d->m_sortingOption != d->m_sortingOption)
     {
         return false;
     }
 
     if (rhs.d->m_types.size() != d->m_types.size()) {
         return false;
     }
 
     for (const QString& type : std::as_const(rhs.d->m_types)) {
         if (!d->m_types.contains(type)) {
             return false;
         }
     }
 
     return d->m_term == rhs.d->m_term;
 }
 
 bool Query::operator!=(const Query& rhs) const
 {
     return !(*this == rhs);
 }
 
 Query& Query::operator=(const Query& rhs)
 {
     *d = *rhs.d;
     return *this;
 }