Differential D23112 Diff 63724 src/service/plugins/gtk-eventspy/GtkEventSpy.cpp

Changeset View

Standalone View

View Options

src/service/plugins/gtk-eventspy/GtkEventSpy.cpp

  • This file was added.
1​/*
2​ * Copyright (C) 2019 Méven Car (meven.car@kdemail.net)
3​ *
4​ * This program is free software; you can redistribute it and/or
5​ * modify it under the terms of the GNU General Public License as
6​ * published by the Free Software Foundation; either version 2 of
7​ * the License, or (at your option) any later version.
8​ *
9​ * This program is distributed in the hope that it will be useful,
10​ * but WITHOUT ANY WARRANTY; without even the implied warranty of
11​ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12​ * GNU General Public License for more details.
13​ *
14​ * You should have received a copy of the GNU General Public License
15​ * along with this program. If not, see <http://www.gnu.org/licenses/>.
16​ */
17​
18​#include "GtkEventSpy.h"
19​
20​#include <QStringList>
21​#include <QString>
22​#include <QFileInfo>
23​#include <QXmlSimpleReader>
24​#include <QXmlInputSource>
25​#include <QDebug>
26​
27​#include <KIOCore/KRecentDocument>
28​#include <KCoreAddons/KDirWatch>
29​#include <KConfigCore/KDesktopFile>
30​#include <KConfigCore/KConfigGroup>
31​#include <KServiceTypeTrader>
32​
33​#include "DebugPluginGtkEventSpy.h"
34​
35​KAMD_EXPORT_PLUGIN(GtkEventSpyPlugin, GtkEventSpyPlugin, "kactivitymanagerd-plugin-gtk-eventspy.json")
36​
37​GtkEventSpyPlugin::GtkEventSpyPlugin(QObject *parent, const QVariantList &args)
38​ : Plugin(parent)
39​ , m_resources(nullptr)
40​ , m_dirWatcher(new KDirWatch(this))
41​ , m_lastUpdate(QDateTime::currentDateTime())
42​{
43​ Q_UNUSED(args);
44​
45​ // gtk xml history file
46​ // usually $HOME/.local/share/recently-used.xbel
47​ QString filename = QStandardPaths::writableLocation(QStandardPaths::GenericDataLocation) + QLatin1String("/recently-used.xbel");
48​
49​ m_dirWatcher->addFile(filename);
50​ connect(m_dirWatcher.get(), &KDirWatch::dirty,
51​ this, &GtkEventSpyPlugin::fileUpdated);
52​ connect(m_dirWatcher.get(), &KDirWatch::created,
53​ this, &GtkEventSpyPlugin::fileUpdated);
54​}
55​
56​struct Application {
57​ QString name;
58​ QDateTime modified;
59​};
60​
61​class Bookmark {
62​
63​public:
64​ QUrl href;
65​ QDateTime added;
66​ QDateTime modified;
67​ QDateTime visited;
68​ QList<Application> *applications;
ivanUnsubmitted
Done

No need for this to be a pointer to a list. Make it just QList<Application> applications.

ivan: No need for this to be a pointer to a list. Make it just `QList<Application> applications`.
69​
70​ Bookmark(){
ivanUnsubmitted
Done

The constructor will not be needed once applications stops being a pointer.

ivan: The constructor will not be needed once `applications` stops being a pointer.
71​ applications = new QList<Application>();
72​ }
73​ QString latestApplication() const;
74​};
75​
76​QString Bookmark::latestApplication() const {
ivanUnsubmitted
Done

{ which starts a function should be on a new line (I don't care much about this, but let's follow the KF5 style)

ivan: `{` which starts a function should be on a new line (I don't care much about this, but let's…
77​ Application current = applications->first();
78​ for (const Application &app : qAsConst(*applications)) {
ivanUnsubmitted
Done

When you make applications not to be a pointer qAsConst will not be needed as this is a const member function.

ivan: When you make `applications` not to be a pointer `qAsConst` will not be needed as this is a…
79​ if (app.modified > current.modified) {
80​ current = app;
81​ }
82​ }
83​ return current.name;
84​}
85​
86​class BookmarkHandler : public QXmlDefaultHandler
87​{
88​public:
89​ BookmarkHandler(){
ivanUnsubmitted
Done

Replace with:

BookmarkHandler()
    : current(nullptr)
{
}
ivan: Replace with: BookmarkHandler() : current(nullptr) { }
90​ current = nullptr;
91​ marks = QList<Bookmark>();
ivanUnsubmitted
Done

No need for this - marks are already default-constructed.

ivan: No need for this - marks are already default-constructed.
92​ }
93​
94​ bool startElement(const QString &namespaceURI, const QString &localName,
95​ const QString &qName, const QXmlAttributes &attributes) override;
96​ bool endElement(const QString &namespaceURI, const QString &localName, const QString &qName) override;
97​
98​ QList<Bookmark> bookmarks() const;
99​private:
100​ QList<Bookmark> marks;
101​ Bookmark* current;
102​};
103​
104​QList<Bookmark> BookmarkHandler::bookmarks() const {
105​ return marks;
106​}
107​
108​bool BookmarkHandler::startElement(const QString &/*namespaceURI*/, const QString &/*localName*/,
109​ const QString &qName, const QXmlAttributes &attributes)
110​{
111​ // new bookmark
112​ if (qName == QStringLiteral("bookmark")) {
113​ current = new Bookmark();
ivanUnsubmitted
Done

No need for dynamic allocation. Make it a normal variable instead of a pointer.

ivan: No need for dynamic allocation. Make it a normal variable instead of a pointer.
114​ current->href = QUrl(attributes.value("href"));
115​ QString added = attributes.value("added");
116​ QString modified = attributes.value("modified");
117​ QString visited = attributes.value("visited");
118​ current->added = QDateTime::fromString(added, Qt::ISODate);
119​ current->modified = QDateTime::fromString(modified, Qt::ISODate);
120​ current->visited = QDateTime::fromString(visited, Qt::ISODate);
121​
122​ // application for the current bookmark
123​ } else if (qName == QStringLiteral("bookmark:application")) {
124​ Application app;
125​
126​ QString exec = attributes.value("exec");
broulikUnsubmitted
Done

It stores the full Exec line of the desktop file, including the %u.
What you probably want do to is use KServiceTypeTrader to find the application with said Exec line.

auto services = KServiceTypeTrader::self()->query(QStringLiteral("Application"), QStringLiteral("exist Exec and ('%1' == Exec)").arg(cmd));

and then operate on the KService desktop file name, e.g. org.gnome.evince instead of the executable.

broulik: It stores the full `Exec` line of the desktop file, including the `%u`. What you probably want…
127​
ivanUnsubmitted
Done

No need to compare chars with strings:

if (!exec.isEmpty() && exec[0] == '\'' && exec.back() == '\'')
ivan: No need to compare chars with strings: ``` if (!exec.isEmpty() && exec[0] == '\'' && exec.back…
brunsUnsubmitted
Done

missing QChar('\''), otherwise it breaks with QT_NO_CAST_FROM_ASCII

-> if (exec.startsWith(QChar('\'') && exec.endsWith(QChar('\'')) {...

bruns: missing `QChar('\'')`, otherwise it breaks with QT_NO_CAST_FROM_ASCII -> `if (exec.startsWith…
128​ if (exec.at(0) == QStringLiteral("'") && exec.at(exec.size() - 1) == QStringLiteral("'")) {
129​ // remove "'" caracters wrapping the command
130​ exec = exec.mid(1, exec.size() -2 );
ivanUnsubmitted
Done

It might be dangerous to assume that the command is wrapped with single quotes

ivan: It might be dangerous to assume that the command is wrapped with single quotes
131​ }
132​
133​ // Search for applications which are executable and case-insensitively match the search term
134​ // See https://techbase.kde.org/Development/Tutorials/Services/Traders#The_KTrader_Query_Language
ivanUnsubmitted
Done

const auto query

ivan: const auto query
135​ const auto query = QString("exist Exec and Exec ~~ '%1'").arg(exec);
ivanUnsubmitted
Done

This should also be const, other local variables as well

ivan: This should also be `const`, other local variables as well
136​ const KService::List services = KServiceTypeTrader::self()->query(QStringLiteral("Application"), query);
broulikUnsubmitted
Done

Isn't that a bit coarse? Doesn't matching the Exec line exactly work?

broulik: Isn't that a bit coarse? Doesn't matching the `Exec` line exactly work?
137​
138​ if (!services.isEmpty()) {
139​ // use the first item matching
140​ const auto service = services.first();
141​ app.name = service->desktopEntryName();
142​ } else {
143​ // when no services are found, sanitize a little the exec
144​ // remove space and any caracter after
ivanUnsubmitted
Done

Let's hope commands will never have spaces in them :)

ivan: Let's hope commands will never have spaces in them :)
mevenAuthorUnsubmitted
Done

It is to just extract the executable name, we don't want to have an exploding number of initiatingAgent for every argument and parameter that might come through here.

meven: It is to just extract the executable name, we don't want to have an exploding number of…
ivanUnsubmitted
Done

I meant it will be a problem if someone decides to have a space in the executable like my\ aweomse\ binary. But this should not be an issue at the moment.

ivan: I meant it will be a problem if someone decides to have a space in the executable like `my\…
145​ const int spaceIdex = exec.indexOf(" ");
brunsUnsubmitted
Done

spaceI_n_dex

bruns: `spaceI_n_dex`
146​ if (spaceIdex != -1) {
147​ exec = exec.mid(0, spaceIdex);
148​ }
149​ app.name = exec;
150​ }
151​
152​ app.modified = QDateTime::fromString(attributes.value("modified"), Qt::ISODate);
153​
154​ current->applications->append(app);
155​ }
156​ return true;
157​}
158​
159​bool BookmarkHandler::endElement(const QString &namespaceURI, const QString &localName, const QString &qName) {
160​ Q_UNUSED(namespaceURI);
161​ Q_UNUSED(localName);
162​
163​ if (qName == QStringLiteral("bookmark")) {
164​ // keep track of the finished parsed bookmark
165​ marks << *current;
166​ }
167​
168​ return true;
169​}
170​
171​void GtkEventSpyPlugin::fileUpdated(const QString &filename)
172​{
173​ QFile file(filename);
174​ if ( ! file.open(QFile::ReadOnly | QFile::Text) ) {
175​ qCWarning(KAMD_PLUGIN_GTK_EVENTSPY) << "Could not read" << filename;
176​ return;
177​ }
178​
179​ // must parse the xbel xml file
180​ BookmarkHandler bookmarkHandler;
181​
182​ QXmlSimpleReader reader;
183​ reader.setContentHandler(&bookmarkHandler);
184​ reader.setErrorHandler(&bookmarkHandler);
185​ QXmlInputSource *source = new QXmlInputSource(&file);
ivanUnsubmitted
Done

No need for dynamic allocation. Make it a normal variable instead of a pointer.

ivan: No need for dynamic allocation. Make it a normal variable instead of a pointer.
186​
187​ if ( ! reader.parse(source) ) {
188​ qCWarning(KAMD_PLUGIN_GTK_EVENTSPY) << "could not parse" << file << "error was " << bookmarkHandler.errorString();
189​ return ;
190​ }
191​
192​ // then find the files that were accessed since last run
193​ const QList<Bookmark> bookmarks = bookmarkHandler.bookmarks();
194​ for (const Bookmark &mark : bookmarks) {
195​ if (mark.added > m_lastUpdate || mark.modified > m_lastUpdate || mark.visited > m_lastUpdate) {
196​ addDocument(mark.href, mark.latestApplication());
197​ }
198​ }
199​
200​ m_lastUpdate = QDateTime::currentDateTime();
201​}
202​
203​void GtkEventSpyPlugin::addDocument(const QUrl &url, const QString &application)
204​{
205​ const QString name = url.fileName();
206​
207​ Plugin::invoke<Qt::QueuedConnection>(
208​ m_resources, "RegisterResourceEvent",
209​ Q_ARG(QString, application), // Application
210​ Q_ARG(uint, 0), // Window ID
211​ Q_ARG(QString, url.toString()), // URI
212​ Q_ARG(uint, 0) // Event Activities::Accessed
213​ );
214​}
215​
216​GtkEventSpyPlugin::~GtkEventSpyPlugin()
217​{
218​}
219​
220​bool GtkEventSpyPlugin::init(QHash<QString, QObject *> &modules)
221​{
222​ Plugin::init(modules);
223​
224​ m_resources = modules["resources"];
225​
226​ return true;
227​}
228​
229​#include "GtkEventSpy.moc"
230​