File: inhibitioncontrol.cpp

package info (click to toggle)
powerdevil 4%3A6.5.4-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 10,680 kB
  • sloc: cpp: 13,284; xml: 1,911; python: 1,204; sh: 19; makefile: 10
file content (356 lines) | stat: -rw-r--r-- 16,787 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
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
/*
 * SPDX-FileCopyrightText: 2024 Bohdan Onofriichuk <bogdan.onofriuchuk@gmail.com>
 * SPDX-FileCopyrightText: 2024 Natalie Clarius <natalie.clarius@kde.org>
 * SPDX-FileCopyrightText: 2025 Jakob Petsovits <jpetso@petsovits.com>

 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 */

#include "inhibitioncontrol.h"

#include "batterymonitor_debug.h"

#include <QDBusConnectionInterface>
#include <QDBusInterface>
#include <QDBusMetaType>
#include <QDBusReply>
#include <QDBusServiceWatcher>
#include <QDBusVariant>
#include <QString>
#include <QVariant>

#include <KService>

#include "inhibitmonitor_p.h"

using namespace Qt::Literals::StringLiterals;

static constexpr QLatin1StringView SOLID_POWERMANAGEMENT_SERVICE("org.kde.Solid.PowerManagement");
static constexpr QLatin1StringView FDO_POWERMANAGEMENT_SERVICE("org.freedesktop.PowerManagement");

static constexpr QLatin1StringView POLICY_AGENT_PATH("/org/kde/Solid/PowerManagement/PolicyAgent");
static constexpr QLatin1StringView POLICY_AGENT_IFACE("org.kde.Solid.PowerManagement.PolicyAgent");

Q_DECLARE_METATYPE(PolicyAgentInhibition)
Q_DECLARE_METATYPE(QList<PolicyAgentInhibition>)

QDBusArgument &operator<<(QDBusArgument &argument, const PolicyAgentInhibition &inhibition)
{
    argument.beginStructure();
    argument << inhibition.what << inhibition.who << inhibition.why << inhibition.mode << inhibition.flags;
    argument.endStructure();
    return argument;
}

const QDBusArgument &operator>>(const QDBusArgument &argument, PolicyAgentInhibition &inhibition)
{
    argument.beginStructure();
    argument >> inhibition.what >> inhibition.who >> inhibition.why >> inhibition.mode >> inhibition.flags;
    argument.endStructure();
    return argument;
}

InhibitionControl::InhibitionControl(QObject *parent)
    : QObject(parent)
    , m_solidWatcher(new QDBusServiceWatcher)
    , m_fdoWatcher(new QDBusServiceWatcher)
{
    qDBusRegisterMetaType<PolicyAgentInhibition>();
    qDBusRegisterMetaType<QList<PolicyAgentInhibition>>();

    // Watch for PowerDevil's power management service
    m_solidWatcher->setConnection(QDBusConnection::sessionBus());
    m_solidWatcher->setWatchMode(QDBusServiceWatcher::WatchForRegistration | QDBusServiceWatcher::WatchForUnregistration);
    m_solidWatcher->addWatchedService(SOLID_POWERMANAGEMENT_SERVICE);

    connect(m_solidWatcher.get(), &QDBusServiceWatcher::serviceRegistered, this, &InhibitionControl::onServiceRegistered);
    connect(m_solidWatcher.get(), &QDBusServiceWatcher::serviceUnregistered, this, &InhibitionControl::onServiceUnregistered);
    // If it's up and running already, let's cache it
    if (QDBusConnection::sessionBus().interface()->isServiceRegistered(SOLID_POWERMANAGEMENT_SERVICE)) {
        onServiceRegistered(SOLID_POWERMANAGEMENT_SERVICE);
    }

    // Watch for the freedesktop.org power management service
    m_fdoWatcher->setConnection(QDBusConnection::sessionBus());
    m_fdoWatcher->setWatchMode(QDBusServiceWatcher::WatchForRegistration | QDBusServiceWatcher::WatchForUnregistration);
    m_fdoWatcher->addWatchedService(FDO_POWERMANAGEMENT_SERVICE);

    connect(m_fdoWatcher.get(), &QDBusServiceWatcher::serviceRegistered, this, &InhibitionControl::onServiceRegistered);
    connect(m_fdoWatcher.get(), &QDBusServiceWatcher::serviceUnregistered, this, &InhibitionControl::onServiceUnregistered);
    // If it's up and running already, let's cache it
    if (QDBusConnection::sessionBus().interface()->isServiceRegistered(FDO_POWERMANAGEMENT_SERVICE)) {
        onServiceRegistered(FDO_POWERMANAGEMENT_SERVICE);
    }
}

InhibitionControl::~InhibitionControl()
{
}

void InhibitionControl::onServiceRegistered(const QString &serviceName)
{
    if (serviceName == FDO_POWERMANAGEMENT_SERVICE) {
        if (!QDBusConnection::sessionBus().connect(FDO_POWERMANAGEMENT_SERVICE,
                                                   QStringLiteral("/org/freedesktop/PowerManagement"),
                                                   QStringLiteral("org.freedesktop.PowerManagement.Inhibit"),
                                                   QStringLiteral("HasInhibitChanged"),
                                                   this,
                                                   SLOT(onHasInhibitionChanged(bool)))) {
            qCDebug(APPLETS::BATTERYMONITOR) << "Error connecting to fdo inhibition changes via dbus";
        }
    } else if (serviceName == SOLID_POWERMANAGEMENT_SERVICE) {
        m_isManuallyInhibited = InhibitMonitor::self().getInhibit();
        connect(&InhibitMonitor::self(), &InhibitMonitor::isManuallyInhibitedChanged, this, &InhibitionControl::onIsManuallyInhibitedChanged);
        connect(&InhibitMonitor::self(), &InhibitMonitor::isManuallyInhibitedChangeError, this, &InhibitionControl::onisManuallyInhibitedErrorChanged);

        QDBusMessage isLidPresentMessage = QDBusMessage::createMethodCall(SOLID_POWERMANAGEMENT_SERVICE,
                                                                          QStringLiteral("/org/kde/Solid/PowerManagement"),
                                                                          SOLID_POWERMANAGEMENT_SERVICE,
                                                                          QStringLiteral("isLidPresent"));
        QDBusPendingCall isLidPresentCall = QDBusConnection::sessionBus().asyncCall(isLidPresentMessage);
        auto isLidPresentWatcher = new QDBusPendingCallWatcher(isLidPresentCall, this);
        connect(isLidPresentWatcher, &QDBusPendingCallWatcher::finished, this, [this](QDBusPendingCallWatcher *watcher) {
            QDBusReply<bool> reply = *watcher;
            if (reply.isValid()) {
                m_isLidPresent = reply.value();

                QDBusMessage triggersLidActionMessage =
                    QDBusMessage::createMethodCall(SOLID_POWERMANAGEMENT_SERVICE,
                                                   QStringLiteral("/org/kde/Solid/PowerManagement/Actions/HandleButtonEvents"),
                                                   QStringLiteral("org.kde.Solid.PowerManagement.Actions.HandleButtonEvents"),
                                                   QStringLiteral("triggersLidAction"));
                QDBusPendingCall triggersLidActionCall = QDBusConnection::sessionBus().asyncCall(triggersLidActionMessage);
                auto triggersLidActionWatcher = new QDBusPendingCallWatcher(triggersLidActionCall, this);
                connect(triggersLidActionWatcher, &QDBusPendingCallWatcher::finished, this, [this](QDBusPendingCallWatcher *watcher) {
                    QDBusReply<bool> reply = *watcher;
                    if (reply.isValid()) {
                        m_triggersLidAction = reply.value();
                    }
                    watcher->deleteLater();
                });
                if (!QDBusConnection::sessionBus().connect(SOLID_POWERMANAGEMENT_SERVICE,
                                                           QStringLiteral("/org/kde/Solid/PowerManagement/Actions/HandleButtonEvents"),
                                                           QStringLiteral("org.kde.Solid.PowerManagement.Actions.HandleButtonEvents"),
                                                           QStringLiteral("triggersLidActionChanged"),
                                                           this,
                                                           SLOT(triggersLidActionChanged(bool)))) {
                    qCDebug(APPLETS::BATTERYMONITOR) << "error connecting to lid action trigger changes via dbus";
                }
            } else {
                qCDebug(APPLETS::BATTERYMONITOR) << "Lid is not present";
            }
            watcher->deleteLater();
        });

        checkInhibitions();

        QDBusMessage hasInhibitMessage = QDBusMessage::createMethodCall(SOLID_POWERMANAGEMENT_SERVICE,
                                                                        QStringLiteral("/org/freedesktop/PowerManagement"),
                                                                        QStringLiteral("org.freedesktop.PowerManagement.Inhibit"),
                                                                        QStringLiteral("HasInhibit"));
        QDBusPendingCall hasInhibitReply = QDBusConnection::sessionBus().asyncCall(hasInhibitMessage);
        auto *hasInhibitWatcher = new QDBusPendingCallWatcher(hasInhibitReply, this);
        connect(hasInhibitWatcher, &QDBusPendingCallWatcher::finished, this, [this](QDBusPendingCallWatcher *watcher) {
            QDBusReply<bool> reply = *watcher;
            if (reply.isValid()) {
                m_hasInhibition = reply.value();
            } else {
                qCDebug(APPLETS::BATTERYMONITOR) << "Failed to retrive has inhibit";
            }
            watcher->deleteLater();
        });

        if (!QDBusConnection::sessionBus().connect(SOLID_POWERMANAGEMENT_SERVICE,
                                                   POLICY_AGENT_PATH,
                                                   u"org.freedesktop.DBus.Properties"_s,
                                                   u"PropertiesChanged"_s,
                                                   this,
                                                   // clang-format off
                                                   SLOT(onPolicyAgentPropertiesChanged(QString,QVariantMap,QStringList))
                                                   // clang-format on
                                                   )) {
            qCDebug(APPLETS::BATTERYMONITOR) << "Error connecting to PolicyAgent inhibition changes via dbus";
        }
    }
}

void InhibitionControl::onServiceUnregistered(const QString &serviceName)
{
    if (serviceName == FDO_POWERMANAGEMENT_SERVICE) {
        QDBusConnection::sessionBus().disconnect(FDO_POWERMANAGEMENT_SERVICE,
                                                 QStringLiteral("/org/freedesktop/PowerManagement"),
                                                 QStringLiteral("org.freedesktop.PowerManagement.Inhibit"),
                                                 QStringLiteral("HasInhibitChanged"),
                                                 this,
                                                 SLOT(onHasInhibitionChanged(bool)));
    } else if (serviceName == SOLID_POWERMANAGEMENT_SERVICE) {
        disconnect(&InhibitMonitor::self(), &InhibitMonitor::isManuallyInhibitedChanged, this, &InhibitionControl::onIsManuallyInhibitedChanged);
        disconnect(&InhibitMonitor::self(), &InhibitMonitor::isManuallyInhibitedChangeError, this, &InhibitionControl::onisManuallyInhibitedErrorChanged);

        QDBusConnection::sessionBus().disconnect(SOLID_POWERMANAGEMENT_SERVICE,
                                                 QStringLiteral("/org/kde/Solid/PowerManagement/Actions/HandleButtonEvents"),
                                                 QStringLiteral("org.kde.Solid.PowerManagement.Actions.HandleButtonEvents"),
                                                 QStringLiteral("triggersLidActionChanged"),
                                                 this,
                                                 SLOT(triggersLidActionChanged(bool)));
        QDBusConnection::sessionBus().disconnect(SOLID_POWERMANAGEMENT_SERVICE,
                                                 POLICY_AGENT_PATH,
                                                 u"org.freedesktop.DBus.Properties"_s,
                                                 u"PropertiesChanged"_s,
                                                 this,
                                                 SLOT(onPolicyAgentPropertiesChanged(QString, QVariantMap, QStringList)));

        m_requestedInhibitions = QList<RequestedInhibition>{};
        m_hasInhibition = false;
        m_isManuallyInhibited = false;
        m_isManuallyInhibitedError = false;
        m_isLidPresent = false;
        m_triggersLidAction = false;
    }
}

void InhibitionControl::inhibit(const QString &reason)
{
    InhibitMonitor::self().inhibit(reason, m_isSilent);
}

void InhibitionControl::uninhibit()
{
    InhibitMonitor::self().uninhibit(m_isSilent);
}

void InhibitionControl::setInhibitionAllowed(const QString &appName, const QString &reason, bool allowed)
{
    if (allowed) {
        qCDebug(APPLETS::BATTERYMONITOR) << "Allowing inhibition for" << appName << "with reason" << reason;
    } else {
        qCDebug(APPLETS::BATTERYMONITOR) << "Suppressing inhibition for" << appName << "with reason" << reason;
    }
    QDBusMessage msg = QDBusMessage::createMethodCall(SOLID_POWERMANAGEMENT_SERVICE, POLICY_AGENT_PATH, POLICY_AGENT_IFACE, u"SetInhibitionAllowed"_s);
    msg << appName << reason << allowed;
    QDBusPendingCall call = QDBusConnection::sessionBus().asyncCall(msg);
}

bool InhibitionControl::isSilent()
{
    return m_isSilent;
}

void InhibitionControl::setIsSilent(bool status)
{
    m_isSilent = status;
}

QBindable<QList<RequestedInhibition>> InhibitionControl::bindableRequestedInhibitions()
{
    return &m_requestedInhibitions;
}

QBindable<bool> InhibitionControl::bindableHasInhibition()
{
    return &m_hasInhibition;
}

QBindable<bool> InhibitionControl::bindableIsLidPresent()
{
    return &m_isLidPresent;
}

QBindable<bool> InhibitionControl::bindableTriggersLidAction()
{
    return &m_triggersLidAction;
}

QBindable<bool> InhibitionControl::bindableIsManuallyInhibited()
{
    return &m_isManuallyInhibited;
}

QBindable<bool> InhibitionControl::bindableIsManuallyInhibitedError()
{
    return &m_isManuallyInhibitedError;
}

void InhibitionControl::onHasInhibitionChanged(bool status)
{
    m_hasInhibition = status;
}

void InhibitionControl::onIsManuallyInhibitedChanged(bool status)
{
    m_isManuallyInhibited = status;
}

void InhibitionControl::onisManuallyInhibitedErrorChanged(bool status)
{
    m_isManuallyInhibitedError = status;
}

void InhibitionControl::onPolicyAgentPropertiesChanged(const QString &ifaceName, const QVariantMap &changedProps, const QStringList &invalidatedProps)
{
    const QString inhibitions = u"RequestedInhibitions"_s;

    if (ifaceName == POLICY_AGENT_IFACE) {
        if (changedProps.contains(inhibitions) || invalidatedProps.contains(inhibitions)) {
            checkInhibitions();
        }
    }
}

void InhibitionControl::checkInhibitions()
{
    QDBusMessage msg = QDBusMessage::createMethodCall(SOLID_POWERMANAGEMENT_SERVICE, POLICY_AGENT_PATH, u"org.freedesktop.DBus.Properties"_s, u"Get"_s);
    msg << POLICY_AGENT_IFACE << u"RequestedInhibitions"_s;
    QDBusPendingCall call = QDBusConnection::sessionBus().asyncCall(msg);

    auto watcher = new QDBusPendingCallWatcher(call, this);
    connect(watcher, &QDBusPendingCallWatcher::finished, this, [this](QDBusPendingCallWatcher *watcher) {
        QDBusReply<QDBusVariant> reply = *watcher;
        if (reply.isValid()) {
            // "Get" returns a D-Bus VARIANT of an array of structures that contain PolicyAgentInhibition data.
            // But the variant doesn't know that this is a QList<PolicyAgentInhibition>, so instead
            // get the untyped value of the VARIANT and use our custom D-Bus operator>>() to convert it.
            m_requestedInhibitions = updatedInhibitions(qdbus_cast<QList<PolicyAgentInhibition>>(reply.value().variant().value<QDBusArgument>()));
        } else {
            qCWarning(APPLETS::BATTERYMONITOR) << "Failed to retrieve inhibitions:" << reply.error().message();
        }
        watcher->deleteLater();
    });
}

QList<RequestedInhibition> InhibitionControl::updatedInhibitions(const QList<PolicyAgentInhibition> &inhibitions)
{
    QList<RequestedInhibition> result;

    for (const PolicyAgentInhibition &inhibition : inhibitions) {
        if (inhibition.who == "plasmashell"_L1 || inhibition.who == "org.kde.plasmashell"_L1) {
            continue;
        }
        if (inhibition.mode != "block"_L1) {
            continue;
        }
        const QStringList whats = inhibition.what.split(":"_L1);
        if (!whats.contains(u"sleep"_s) && !whats.contains(u"idle"_s)) {
            continue; // maybe we'll support other inhibition types at a later point
        }

        QString prettyName;
        QString icon;
        m_data.populateApplicationData(inhibition.who, &prettyName, &icon);

        result.append(RequestedInhibition{
            .appName = inhibition.who,
            .prettyName = prettyName,
            .icon = icon,
            .reason = inhibition.why,
            .what = whats,
            .active = static_cast<bool>(inhibition.flags & PolicyAgentInhibition::Active),
            .allowed = static_cast<bool>(inhibition.flags & PolicyAgentInhibition::Allowed),
        });
    }

    return result;
}

#include "moc_inhibitioncontrol.cpp"