* Copyright (C) 2015 Ivan Cukic <ivan.cukic(at)kde.org>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2,
* or (at your option) any later version, as published by the Free
* Software Foundation
*
* 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 "resultset.h"
#include <QSqlQuery>
#include <QSqlError>
#include <QCoreApplication>
#include <common/database/Database.h>
#include <utils/debug_and_return.h>
#include <boost/range/algorithm/transform.hpp>
#include <iterator>
#include <functional>
#include <mutex>
#include "activitiessync_p.h"
namespace KActivities {
namespace Experimental {
namespace Stats {
using namespace Terms;
class ResultSet_ResultPrivate {
public:
QString resource;
QString title;
QString mimetype;
double score;
uint lastUpdate;
uint firstUpdate;
ResultSet::Result::LinkStatus linkStatus;
};
ResultSet::Result::Result()
: d(new ResultSet_ResultPrivate())
{
}
ResultSet::Result::Result(Result &&result)
: d(result.d)
{
result.d = Q_NULLPTR;
}
ResultSet::Result::Result(const Result &result)
: d(new ResultSet_ResultPrivate(*result.d))
{
}
ResultSet::Result &ResultSet::Result::operator=(Result result)
{
std::swap(d, result.d);
return *this;
}
ResultSet::Result::~Result()
{
delete d;
}
#define CREATE_GETTER_AND_SETTER(Type, Name, Set) \
Type ResultSet::Result::Name() const \
{ \
return d->Name; \
} \
\
void ResultSet::Result::Set(Type Name) \
{ \
d->Name = Name; \
}
CREATE_GETTER_AND_SETTER(QString, resource, setResource)
CREATE_GETTER_AND_SETTER(QString, title, setTitle)
CREATE_GETTER_AND_SETTER(QString, mimetype, setMimetype)
CREATE_GETTER_AND_SETTER(double, score, setScore)
CREATE_GETTER_AND_SETTER(uint, lastUpdate, setLastUpdate)
CREATE_GETTER_AND_SETTER(uint, firstUpdate, setFirstUpdate)
CREATE_GETTER_AND_SETTER(ResultSet::Result::LinkStatus, linkStatus, setLinkStatus)
#undef CREATE_GETTER_AND_SETTER
class ResultSetPrivate {
public:
Common::Database::Ptr database;
QSqlQuery query;
Query queryDefinition;
mutable ActivitiesSync::ConsumerPtr activities;
void initQuery()
{
if (!database || query.isActive()) {
return;
}
auto selection = queryDefinition.selection();
query = database->execQuery(replaceQueryParameters(
selection == LinkedResources ? linkedResourcesQuery()
: selection == UsedResources ? usedResourcesQuery()
: selection == AllResources ? allResourcesQuery()
: QString()));
if (query.lastError().isValid()) {
qDebug() << "Error: " << query.lastError();
}
Q_ASSERT_X(query.isActive(), "ResultSet initQuery", "Query is not valid");
}
QString agentClause(const QString &agent) const
{
if (agent == QLatin1String(":any")) return QStringLiteral("1");
return "agent = '" + (
agent == QLatin1String(":current") ? QCoreApplication::instance()->applicationName() :
agent
) + "'";
}
QString activityClause(const QString &activity) const
{
if (activity == QLatin1String(":any")) return QStringLiteral("1");
return "activity = '" + (
activity == QLatin1String(":current") ? ActivitiesSync::currentActivity(activities) :
activity
) + "'";
}
inline QString starPattern(const QString &pattern) const
{
return Common::parseStarPattern(pattern, QStringLiteral("%"), [] (QString str) {
return str.replace(QLatin1String("%"), QLatin1String("\\%")).replace(QLatin1String("_"), QLatin1String("\\_"));
});
}
QString urlFilterClause(const QString &urlFilter) const
{
if (urlFilter == QLatin1String("*")) return QStringLiteral("1");
return "resource LIKE '" + Common::starPatternToLike(urlFilter) + "' ESCAPE '\\'";
}
QString mimetypeClause(const QString &mimetype) const
{
if (mimetype == QLatin1String(":any") || mimetype == QLatin1String("*")) return QStringLiteral("1");
return "mimetype LIKE '" + Common::starPatternToLike(mimetype) + "' ESCAPE '\\'";
}
* Transforms the input list's elements with the f member method,
* and returns the resulting list
*/
template <typename F>
inline
QStringList transformedList(const QStringList &input, F f) const
{
using namespace std::placeholders;
QStringList result;
boost::transform(input,
std::back_inserter(result),
std::bind(f, this, _1));
return result;
}
QString limitOffsetSuffix() const
{
QString result;
const int limit = queryDefinition.limit();
if (limit > 0) {
result += " LIMIT " + QString::number(limit);
const int offset = queryDefinition.offset();
if (offset > 0) {
result += " OFFSET " + QString::number(offset);
}
}
return result;
}
inline QString replaceQueryParameters(const QString &_query) const
{
auto ordering = queryDefinition.ordering();
QString orderingColumn = QStringLiteral("linkStatus DESC, ") + (
ordering == HighScoredFirst ? QStringLiteral("score DESC,")
: ordering == RecentlyCreatedFirst ? QStringLiteral("firstUpdate DESC,")
: ordering == RecentlyUsedFirst ? QStringLiteral("lastUpdate DESC,")
: ordering == OrderByTitle ? QStringLiteral("title ASC,")
: QString()
);
QStringList agentsFilter = transformedList(
queryDefinition.agents(), &ResultSetPrivate::agentClause);
QStringList activitiesFilter = transformedList(
queryDefinition.activities(), &ResultSetPrivate::activityClause);
QStringList urlFilter = transformedList(
queryDefinition.urlFilters(), &ResultSetPrivate::urlFilterClause);
QStringList mimetypeFilter = transformedList(
queryDefinition.types(), &ResultSetPrivate::mimetypeClause);
auto query = _query
+ "\nORDER BY $orderingColumn resource ASC\n"
+ limitOffsetSuffix();
return kamd::utils::debug_and_return("Query: ",
query
.replace(QLatin1String("$orderingColumn"), orderingColumn)
.replace(QLatin1String("$agentsFilter"), agentsFilter.join(QStringLiteral(" OR ")))
.replace(QLatin1String("$activitiesFilter"), activitiesFilter.join(QStringLiteral(" OR ")))
.replace(QLatin1String("$urlFilter"), urlFilter.join(QStringLiteral(" OR ")))
.replace(QLatin1String("$mimetypeFilter"), mimetypeFilter.join(QStringLiteral(" OR ")))
);
}
const QString &linkedResourcesQuery() const
{
static const QString query =
QStringLiteral("\n"
"SELECT \n"
" rl.targettedResource as resource \n"
" , SUM(rsc.cachedScore) as score \n"
" , MIN(rsc.firstUpdate) as firstUpdate \n"
" , MAX(rsc.lastUpdate) as lastUpdate \n"
" , rl.usedActivity as activity \n"
" , rl.initiatingAgent as agent \n"
" , COALESCE(ri.title, rl.targettedResource) as title \n"
" , ri.mimetype as mimetype \n"
" , 2 as linkStatus \n"
"FROM \n"
" ResourceLink rl \n"
"LEFT JOIN \n"
" ResourceScoreCache rsc \n"
" ON rl.targettedResource = rsc.targettedResource \n"
" AND rl.usedActivity = rsc.usedActivity \n"
" AND rl.initiatingAgent = rsc.initiatingAgent \n"
"LEFT JOIN \n"
" ResourceInfo ri \n"
" ON rl.targettedResource = ri.targettedResource \n"
"WHERE \n"
" ($agentsFilter) \n"
" AND ($activitiesFilter) \n"
" AND ($urlFilter)\n"
" AND ($mimetypeFilter)\n"
"GROUP BY resource, title \n")
;
return query;
}
const QString &usedResourcesQuery() const
{
static const QString query =
QStringLiteral("\n"
"SELECT \n"
" rsc.targettedResource as resource \n"
" , SUM(rsc.cachedScore) as score \n"
" , MIN(rsc.firstUpdate) as firstUpdate \n"
" , MAX(rsc.lastUpdate) as lastUpdate \n"
" , rsc.usedActivity as activity \n"
" , rsc.initiatingAgent as agent \n"
" , COALESCE(ri.title, rsc.targettedResource) as title \n"
" , ri.mimetype as mimetype \n"
" , 1 as linkStatus \n"
"FROM \n"
" ResourceScoreCache rsc \n"
"LEFT JOIN \n"
" ResourceInfo ri \n"
" ON rsc.targettedResource = ri.targettedResource \n"
"WHERE \n"
" ($agentsFilter) \n"
" AND ($activitiesFilter) \n"
" AND ($urlFilter)\n"
" AND ($mimetypeFilter)\n"
"GROUP BY resource, title \n")
;
return query;
}
const QString &allResourcesQuery() const
{
static QString usedResourcesQuery_ = usedResourcesQuery();
static const QString query =
"WITH LinkedResourcesResults as (\n" +
linkedResourcesQuery() +
"\n)\n" +
"SELECT * FROM LinkedResourcesResults \n" +
"UNION \n" +
usedResourcesQuery_
.replace(QLatin1String("WHERE "),
QLatin1String("WHERE rsc.targettedResource NOT IN "
"(SELECT resource FROM LinkedResourcesResults) AND "))
.replace(QLatin1String("1 as linkStatus"), QLatin1String("0 as linkStatus"));
return query;
}
ResultSet::Result currentResult() const
{
ResultSet::Result result;
result.setResource(query.value(QStringLiteral("resource")).toString());
result.setTitle(query.value(QStringLiteral("title")).toString());
result.setMimetype(query.value(QStringLiteral("mimetype")).toString());
result.setScore(query.value(QStringLiteral("score")).toDouble());
result.setLastUpdate(query.value(QStringLiteral("lastUpdate")).toInt());
result.setFirstUpdate(query.value(QStringLiteral("firstUpdate")).toInt());
result.setLinkStatus(
(ResultSet::Result::LinkStatus)query.value(QStringLiteral("linkStatus")).toInt());
return result;
}
};
ResultSet::ResultSet(Query query)
: d(new ResultSetPrivate())
{
using namespace Common;
d->database = Database::instance(Database::ResourcesDatabase, Database::ReadOnly);
if (!(d->database)) {
qWarning() << "KActivities ERROR: There is no database. This probably means "
"that you do not have the Activity Manager running, or that "
"something else is broken on your system. Recent documents and "
"alike will not work!";
Q_ASSERT_X((bool)d->database, "ResultSet constructor", "Database is NULL");
}
d->queryDefinition = query;
d->initQuery();
}
ResultSet::ResultSet(ResultSet &&source)
: d(nullptr)
{
std::swap(d, source.d);
}
ResultSet::ResultSet(const ResultSet &source)
: d(new ResultSetPrivate(*source.d))
{
}
ResultSet &ResultSet::operator= (ResultSet source)
{
std::swap(d, source.d);
return *this;
}
ResultSet::~ResultSet()
{
delete d;
}
ResultSet::Result ResultSet::at(int index) const
{
Q_ASSERT_X(d->query.isActive(), "ResultSet::at", "Query is not active");
d->query.seek(index);
return d->currentResult();
}
}
}
}
#include "resultset_iterator.cpp"
