File: settings.cpp

package info (click to toggle)
plasma-browser-integration 6.5.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,000 kB
  • sloc: cpp: 3,195; javascript: 2,553; xml: 127; python: 77; sh: 46; makefile: 16
file content (325 lines) | stat: -rw-r--r-- 11,644 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
/*
    SPDX-FileCopyrightText: 2017 Kai Uwe Broulik <kde@privat.broulik.de>
    SPDX-FileCopyrightText: 2017 David Edmundson <davidedmundson@kde.org>
    SPDX-FileCopyrightText: 2021 Harald Sitter <sitter@kde.org>

    SPDX-License-Identifier: MIT
*/

#include "settings.h"

#include <unistd.h> // getppid

#include <QDBusConnection>
#include <QGuiApplication>
#include <QIcon>
#include <QProcess>

#include <KDesktopFile>
#include <KProcessList>
#include <KService>

#include <abstracttasksmodel.h>
#include <windowtasksmodel.h>

#include "pluginmanager.h"

#include <config-host.h>

const QMap<Settings::Environment, QString> Settings::environmentNames = {
    {Settings::Environment::Chrome, QStringLiteral("chrome")},
    {Settings::Environment::Chromium, QStringLiteral("chromium")},
    {Settings::Environment::Firefox, QStringLiteral("firefox")},
    {Settings::Environment::Opera, QStringLiteral("opera")},
    {Settings::Environment::Vivaldi, QStringLiteral("vivaldi")},
    {Settings::Environment::Brave, QStringLiteral("brave")},
    {Settings::Environment::Edge, QStringLiteral("edge")},
};

const QMap<Settings::Environment, EnvironmentDescription> Settings::environmentDescriptions = {
    {Settings::Environment::Chrome,
     {
         QStringLiteral("google-chrome"),
         QStringLiteral("Google Chrome"),
         QStringLiteral("google-chrome"),
         QStringLiteral("google.com"),
         QStringLiteral("Google"),
         QStringLiteral("google-chrome"),
     }},
    {Settings::Environment::Chromium,
     {
         QStringLiteral("chromium-browser"),
         QStringLiteral("Chromium"),
         QStringLiteral("chromium-browser"),
         QStringLiteral("google.com"),
         QStringLiteral("Google"),
         QStringLiteral("chromium-browser"),
     }},
    {Settings::Environment::Firefox,
     {
         QStringLiteral("firefox"),
         QStringLiteral("Mozilla Firefox"),
         QStringLiteral("firefox"),
         QStringLiteral("mozilla.org"),
         QStringLiteral("Mozilla"),
         QStringLiteral("firefox"),
     }},
    {Settings::Environment::Opera,
     {
         QStringLiteral("opera"),
         QStringLiteral("Opera"),
         QStringLiteral("opera"),
         QStringLiteral("opera.com"),
         QStringLiteral("Opera"),
         QStringLiteral("opera"),
     }},
    {Settings::Environment::Vivaldi,
     {
         QStringLiteral("vivaldi"),
         QStringLiteral("Vivaldi"),
         // This is what the official package on their website uses
         QStringLiteral("vivaldi-stable"),
         QStringLiteral("vivaldi.com"),
         QStringLiteral("Vivaldi"),
         QStringLiteral("vivaldi"),
     }},
    {Settings::Environment::Brave,
     {
         QStringLiteral("Brave"),
         QStringLiteral("Brave"),
         QStringLiteral("brave-browser"),
         QStringLiteral("brave.com"),
         QStringLiteral("Brave"),
         QStringLiteral("brave"),
     }},
    {Settings::Environment::Edge,
     {
         QStringLiteral("Edge"),
         QStringLiteral("Microsoft Edge"),
         QStringLiteral("microsoft-edge"),
         QStringLiteral("microsoft.com"),
         QStringLiteral("Microsoft"),
         QStringLiteral("microsoft-edge"),
     }},
};

static bool hasDesktopFileName()
{
    return !qApp->desktopFileName().isEmpty() && qApp->desktopFileName() != QLatin1String("org.kde.plasma-browser-integration-host");
}

Settings::Settings()
    : AbstractBrowserPlugin(QStringLiteral("settings"), 1, nullptr)
    // Settings is a singleton and cleaned up only in exit_handlers
    // at which point the QPA will already have cleaned up
    // leading to a crash on Wayland
    , m_tasksModel(new TaskManager::WindowTasksModel(qGuiApp))
{
    for (int i = 0; i < m_tasksModel->rowCount(); ++i) {
        if (setEnvironmentFromTasksModelIndex(m_tasksModel->index(i, 0))) {
            break;
        }
    }

    // If we didn't find the browser window yet, monitor the model for changes
    if (!hasDesktopFileName()) {
        connect(m_tasksModel, &TaskManager::WindowTasksModel::rowsInserted, this, [this](const QModelIndex &parent, int first, int last) {
            if (parent.isValid()) {
                return;
            }

            for (int i = first; i <= last; ++i) {
                if (setEnvironmentFromTasksModelIndex(m_tasksModel->index(i, 0))) {
                    break;
                }
            }
        });
        connect(m_tasksModel,
                &TaskManager::WindowTasksModel::dataChanged,
                this,
                [this](const QModelIndex &topLeft, const QModelIndex &bottomRight, const QList<int> &roles) {
                    // TODO should we bother checking this, even?
                    if (topLeft.parent().isValid() || bottomRight.parent().isValid() || topLeft.column() != 0 || bottomRight.column() != 0) {
                        return;
                    }

                    if (!roles.isEmpty() && !roles.contains(TaskManager::AbstractTasksModel::LauncherUrlWithoutIcon)
                        && !roles.contains(TaskManager::AbstractTasksModel::AppId)) {
                        return;
                    }

                    for (int i = topLeft.row(); i <= bottomRight.row(); ++i) {
                        if (setEnvironmentFromTasksModelIndex(m_tasksModel->index(i, 0))) {
                            break;
                        }
                    }
                });
    }
}

Settings &Settings::self()
{
    static Settings s_self;
    return s_self;
}

void Settings::handleData(const QString &event, const QJsonObject &data)
{
    if (event == QLatin1String("changed")) {
        m_settings = data;

        for (auto it = data.begin(), end = data.end(); it != end; ++it) {
            const QString &subsystem = it.key();
            const QJsonObject &settingsObject = it->toObject();

            const QJsonValue enabledVariant = settingsObject.value(QStringLiteral("enabled"));
            // probably protocol overhead, not a plugin setting, skip.
            if (enabledVariant.type() == QJsonValue::Undefined) {
                continue;
            }

            auto *plugin = PluginManager::self().pluginForSubsystem(subsystem);
            if (!plugin) {
                continue;
            }

            if (enabledVariant.toBool()) {
                PluginManager::self().loadPlugin(plugin);
            } else {
                PluginManager::self().unloadPlugin(plugin);
            }

            if (plugin->isLoaded()) {
                PluginManager::self().settingsChanged(plugin, settingsObject);
            }
        }

        Q_EMIT changed(data);
    } else if (event == QLatin1String("openKRunnerSettings")) {
        QProcess::startDetached(QStringLiteral("systemsettings"), {QStringLiteral("kcm_plasmasearch")});
    } else if (event == QLatin1String("setEnvironment")) {
        setEnvironmentFromExtensionMessage(data);
    }
}

bool Settings::setEnvironmentFromTasksModelIndex(const QModelIndex &idx)
{
    bool ok = false;
    const auto pid = idx.data(TaskManager::AbstractTasksModel::AppPid).toLongLong(&ok);
    if (!ok || pid != getppid()) {
        return false;
    }

    const QUrl launcherUrl = idx.data(TaskManager::AbstractTasksModel::LauncherUrlWithoutIcon).toUrl();
    if (!launcherUrl.isValid()) {
        return false;
    }

    KService::Ptr service;
    if (launcherUrl.scheme() == QLatin1String("applications")) {
        service = KService::serviceByMenuId(launcherUrl.path());
    } else if (launcherUrl.isLocalFile()) {
        const QString launcherPath = launcherUrl.toLocalFile();
        if (KDesktopFile::isDesktopFile(launcherPath)) {
            service = KService::serviceByDesktopPath(launcherUrl.toLocalFile());
        }
    } else {
        qWarning() << "Got unrecognized launcher URL" << launcherUrl;
        return false;
    }

    if (!service) {
        qWarning() << "Failed to get service from launcher URL" << launcherUrl;
        return false;
    }

    // Ignore any browser-hosted app windows.
    if (!service->categories().contains(QLatin1String("WebBrowser"))) {
        qInfo() << "Ignoring launcher URL" << launcherUrl << "which doesn't have \"WebBrowser\" category";
        return false;
    }

    qApp->setApplicationName(service->menuId());
    qApp->setApplicationDisplayName(service->name());
    qApp->setDesktopFileName(service->desktopEntryName());
    qApp->setWindowIcon(QIcon::fromTheme(service->icon()));

    m_tasksModel->disconnect(this); // prevent further signal emission to not deref a nullptr https://bugs.kde.org/show_bug.cgi?id=435811
    m_tasksModel->deleteLater();
    m_tasksModel = nullptr;

    return true;
}

void Settings::setEnvironmentFromExtensionMessage(const QJsonObject &data)
{
    QString name = data.value(QStringLiteral("browserName")).toString();

    // Most chromium-based browsers just impersonate Chromium nowadays to keep websites from locking them out
    // so we'll need to make an educated guess from our parent process
    if (name == QLatin1String("chromium") || name == QLatin1String("chrome")) {
        const auto processInfo = KProcessList::processInfo(getppid());
        if (processInfo.name().contains(QLatin1String("vivaldi"))) {
            name = QStringLiteral("vivaldi");
        } else if (processInfo.name().contains(QLatin1String("brave"))) {
            name = QStringLiteral("brave");
        } else if (processInfo.name().contains(QLatin1String("edge"))) {
            name = QStringLiteral("edge");
        }
    }

    m_environment = Settings::environmentNames.key(name, Settings::Environment::Unknown);
    m_currentEnvironment = Settings::environmentDescriptions.value(m_environment);

    if (!hasDesktopFileName()) {
        qApp->setApplicationName(m_currentEnvironment.applicationName);
        qApp->setApplicationDisplayName(m_currentEnvironment.applicationDisplayName);
        qApp->setDesktopFileName(m_currentEnvironment.desktopFileName);
        qApp->setWindowIcon(QIcon::fromTheme(m_currentEnvironment.iconName));
        // TODO remove?
        qApp->setOrganizationDomain(m_currentEnvironment.organizationDomain);
        qApp->setOrganizationName(m_currentEnvironment.organizationName);
    }
}

QJsonObject Settings::handleData(int serial, const QString &event, const QJsonObject &data)
{
    Q_UNUSED(serial)
    Q_UNUSED(data)

    QJsonObject ret;

    if (event == QLatin1String("getSubsystemStatus")) {
        // should we add a PluginManager::knownSubsystems() that returns a QList<AbstractBrowserPlugin*>?
        const QStringList subsystems = PluginManager::self().knownPluginSubsystems();
        for (const QString &subsystem : subsystems) {
            const AbstractBrowserPlugin *plugin = PluginManager::self().pluginForSubsystem(subsystem);

            QJsonObject details = plugin->status();
            details.insert(QStringLiteral("version"), plugin->protocolVersion());
            details.insert(QStringLiteral("loaded"), plugin->isLoaded());
            ret.insert(subsystem, details);
        }
    } else if (event == QLatin1String("getVersion")) {
        ret.insert(QStringLiteral("host"), QStringLiteral(HOST_VERSION_STRING));
    }

    return ret;
}

Settings::Environment Settings::environment() const
{
    return m_environment;
}

bool Settings::pluginEnabled(const QString &subsystem) const
{
    return settingsForPlugin(subsystem).value(QStringLiteral("enabled")).toBool();
}

QJsonObject Settings::settingsForPlugin(const QString &subsystem) const
{
    return m_settings.value(subsystem).toObject();
}

#include "moc_settings.cpp"