Differential D22144 Diff 62298 recentlyused/recentlyused.h

Changeset View

Standalone View

View Options

recentlyused/recentlyused.h

  • This file was added.
1​/*
2​ * Copyright (C) 2019 Méven Car <meven.car@kdemail.net>
3​ *
4​ * This library is free software; you can redistribute it and/or
5​ * modify it under the terms of the GNU Lesser General Public
6​ * License as published by the Free Software Foundation; either
7​ * version 2.1 of the License, or (at your option) version 3, or any
8​ * later version accepted by the membership of KDE e.V. (or its
9​ * successor approved by the membership of KDE e.V.), which shall
10​ * act as a proxy defined in Section 6 of version 3 of the license.
11​ *
12​ * This library is distributed in the hope that it will be useful,
13​ * but WITHOUT ANY WARRANTY; without even the implied warranty of
14​ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15​ * Lesser General Public License for more details.
16​ *
17​ * You should have received a copy of the GNU Lesser General Public
18​ * License along with this library.
19​ * If not, see <http://www.gnu.org/licenses/>.
20​ */
21​
22​#ifndef RECENTLYUSED_H
23​#define RECENTLYUSED_H
24​
25​#include <KActivities/Stats/ResultModel>
26​#include <KIO/ForwardingSlaveBase>
27​
28​/**
29​ * Implements recentlyused:/ ioslave
30​ * It uses KActivitiesStats as a backend (as kickoff/kicker do).
31​ *
ngrahamUnsubmitted
Done

KAcitivitiesStats -> KActivitiesStats

ngraham: `KAcitivitiesStats` -> `KActivitiesStats`
32​ * It supports options to filter what is returned through url parameters:
33​ *
34​ * ?activity=[activity UUID|any]
35​ *
36​ * Allows to filter the resources based on the activity there were used in.
37​ * Defaults to the current user activity.
dfaureUnsubmitted
Done

s/there/they/

dfaure: s/there/they/
38​ * Any option means include resources from any activity.
39​ * Example: recentlyused:/?activity=428fa590-1920-4b3c-a7e1-1842e6164707
dfaureUnsubmitted
Done

You mean: the "any" value means...
Right?

dfaure: You mean: the "any" value means... Right?
40​ *
41​ * ?agent=[agentName1[,agentName*]*|current]
42​ * Filter on the name or names of the application that used the resource.
43​ * Current option filters on the current application
44​ * Default to any, meaning no agent filtering
45​ * Example: recentlyused:/?agent=kate,dolphin
dfaureUnsubmitted
Done

typo: yesterday

dfaure: typo: yesterday
46​ *
dfaureUnsubmitted
Done

you mean "YYYY is year"

dfaure: you mean "YYYY is year"
47​ * ?url=path
dhaumannUnsubmitted
Done

NN should be MM.

I would suggest to remove the additional explanation in brackes: YYYY-MM-DD is already clear enough.

dhaumann: NN should be MM. I would suggest to remove the additional explanation in brackes: YYYY-MM-DD…
48​ *
dfaureUnsubmitted
Done

typo: first

dfaure: typo: first
49​ * Filters resources based on the url of the resource, can contain schemes.
50​ * Path can contain '*', defaults to no filtering.
ngrahamUnsubmitted
Done

resourcess -> resources
cantain -> contain

ngraham: `resourcess` -> `resources` `cantain` -> `contain`
51​ * Example: recentlyused:/?url=/home/meven/projects/*
52​ *
53​ * ?type=mimetype[,mimetype]*
dfaureUnsubmitted
Done

The help on this option doesn't mention an "any" value.

dfaure: The help on this option doesn't mention an "any" value.
54​ *
55​ * Filters resources based on the mimetype of files.
56​ * Defaults to no filtering
57​ * Example: recentlyused:/?type=video/*,audio/*
58​ *
dfaureUnsubmitted
Done

That's ambiguous. Is it a path or a URL?

A "path that can contain schemes" is an invalid mixture of two different things.
If it's a path, a '#' will mean an actual '#' in the filename.
If it's a URL, a '#' in the filename will require encoding as %23, since a '#' in the URL would actually mean a fragment.

dfaure: That's ambiguous. Is it a path or a URL? A "path that can contain schemes" is an invalid…
mevenAuthorUnsubmitted
Done

It is path currently due to limitation in RecentlyUsed::udsEntryFromResource being able to create valid UDS::Entry only for files.
But it could evolve later to support any url that the sqlite database ~/.local/share/kactivitymanagerd/resources/database stores in its targettedResource column, including ioslave urls, kcm urls, applications desktop files...

meven: It is path currently due to limitation in RecentlyUsed::udsEntryFromResource being able to…
dfaureUnsubmitted
Done

If you want this to support non-local URLs one day then it should probably take URLs already now.

Alternatively call the argument "path" and leave "url" for later.

dfaure: If you want this to support non-local URLs one day then it should probably take URLs already…
59​ * ?limit=number
60​ *
61​ * Specify the number of resources to return.
62​ * Defaults to 30
63​ *
64​ * ?order=(HighScoredFirst|RecentlyCreatedFirst|OrderByUrl|OrderByTitle)
65​ * Allow to modify the order of the returned resources.
66​ * Defaults to RecentlyUsedFirst
67​ * See KActivities::Stats::Terms::Order
68​ *
69​ * Examples:
70​ *
71​ * - recentlyused:/?type=video/*,audio/*&order=HighScoredFirst : recently used video or audio files ordered by their scoring descending
72​ * - recentlyused:/?url=/home/meven/kde/src/*&type=text/plain : recently used text files located in a subdir of /home/meven/kde/src/
73​ *
74​ * @brief The RecentlyUsed implements an ioslave to access recently used resources
75​ */
76​class RecentlyUsed: public KIO::ForwardingSlaveBase
77​{
78​public:
79​ RecentlyUsed(const QByteArray &pool, const QByteArray &app);
80​ ~RecentlyUsed() override;
81​
82​protected:
83​ bool rewriteUrl(const QUrl &url, QUrl &newUrl) override;
dfaureUnsubmitted
Done

resources is such a generic word. We're talking about files here, and only files, aren't we? Or maybe files and directories. But not emails, contacts, databases, servers and whatever else, right?

dfaure: resources is such a generic word. We're talking about files here, and only files, aren't we? Or…
84​ void listDir(const QUrl &url) override;
85​ void stat(const QUrl& url) override;
86​ void mimetype(const QUrl& url) override;
87​
88​private:
ngrahamUnsubmitted
Done

Don't commit commented-out code. If this really needs to be commented out, it needs a comment explaining why.

ngraham: Don't commit commented-out code. If this really needs to be commented out, it needs a comment…
89​
90​ KIO::UDSEntry udsEntryFromResource(const QString& resource);
91​};
92​
93​#endif