[Notifications] Add support for global do not disturb toggle shortcut

It enables do not disturb until turned off and allows disabling it.

Differential Revision: https://phabricator.kde.org/D25910

applets/notifications/CMakeLists.txt

@@ -3,6 +3,7 @@ add_definitions(-DTRANSLATION_DOMAIN=\"plasma_applet_org.kde.plasma.notification
 set(notificationapplet_SRCS
     notificationapplet.cpp
     filemenu.cpp
+    globalshortcuts.cpp
     thumbnailer.cpp
 )
 
@@ -16,6 +17,7 @@ target_link_libraries(plasma_applet_notifications
                       KF5::I18n
                       KF5::Plasma
                       KF5::PlasmaQuick
+                      KF5::GlobalAccel
                       KF5::KIOWidgets # for PreviewJob
                       )
 

applets/notifications/globalshortcuts.cpp

@@ -0,0 +1,63 @@
+/*
+ * Copyright 2019 Kai Uwe Broulik <kde@broulik.de>
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 3 of
+ * the License or any later version accepted by the membership of
+ * KDE e.V. (or its successor approved by the membership of KDE
+ * e.V.), which shall act as a proxy defined in Section 14 of
+ * version 3 of the license.
+ *
+ * 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, see <https://www.gnu.org/licenses/>.
+ */
+
+#include "globalshortcuts.h"
+
+#include <QAction>
+#include <QDBusConnection>
+#include <QDBusMessage>
+
+#include <KLocalizedString>
+
+#include <KGlobalAccel>
+
+GlobalShortcuts::GlobalShortcuts(QObject *parent)
+    : QObject(parent)
+    , m_toggleDoNotDisturbAction(new QAction(this))
+{
+    m_toggleDoNotDisturbAction->setObjectName(QStringLiteral("toggle do not disturb"));
+    m_toggleDoNotDisturbAction->setProperty("componentName", QStringLiteral("plasmashell"));
+    m_toggleDoNotDisturbAction->setText(i18n("Toggle do not disturb"));
+    m_toggleDoNotDisturbAction->setIcon(QIcon::fromTheme(QStringLiteral("notifications-disabled")));
+    m_toggleDoNotDisturbAction->setShortcutContext(Qt::ApplicationShortcut);
+    connect(m_toggleDoNotDisturbAction, &QAction::triggered, this, &GlobalShortcuts::toggleDoNotDisturbTriggered);
+
+    KGlobalAccel::self()->setGlobalShortcut(m_toggleDoNotDisturbAction, QKeySequence());
+}
+
+GlobalShortcuts::~GlobalShortcuts() = default;
+
+void GlobalShortcuts::showDoNotDisturbOsd(bool doNotDisturb) const
+{
+    QDBusMessage msg = QDBusMessage::createMethodCall(
+        QStringLiteral("org.kde.plasmashell"),
+        QStringLiteral("/org/kde/osdService"),
+        QStringLiteral("org.kde.osdService"),
+        QStringLiteral("showText")
+    );
+
+    const QString iconName = doNotDisturb ? QStringLiteral("notifications-disabled") : QStringLiteral("notifications");
+    const QString text = doNotDisturb ? i18nc("OSD popup, keep short", "Notifications Off")
+                                      : i18nc("OSD popup, keep short", "Notifications On");
+
+    msg.setArguments({iconName, text});
+
+    QDBusConnection::sessionBus().call(msg, QDBus::NoBlock);
+}

applets/notifications/notificationapplet.cpp

@@ -33,6 +33,7 @@
 #include <PlasmaQuick/Dialog>
 
 #include "filemenu.h"
+#include "globalshortcuts.h"
 #include "thumbnailer.h"
 
 NotificationApplet::NotificationApplet(QObject *parent, const QVariantList &data)
@@ -42,6 +43,7 @@ NotificationApplet::NotificationApplet(QObject *parent, const QVariantList &data
     if (!s_typesRegistered) {
         const char uri[] = "org.kde.plasma.private.notifications";
         qmlRegisterType<FileMenu>(uri, 2, 0, "FileMenu");
+        qmlRegisterType<GlobalShortcuts>(uri, 2, 0, "GlobalShortcuts");
         qmlRegisterType<Thumbnailer>(uri, 2, 0, "Thumbnailer");
         qmlProtectModule(uri, 2);
         s_typesRegistered = true;

applets/notifications/package/contents/ui/FullRepresentation.qml

@@ -99,12 +99,7 @@ ColumnLayout{
                     // but disable only on click
                     onClicked: {
                         if (Globals.inhibited) {
-                            notificationSettings.notificationsInhibitedUntil = undefined;
-                            notificationSettings.revokeApplicationInhibitions();
-                            // overrules current mirrored screen setup, updates again when screen configuration changes
-                            notificationSettings.screensMirrored = false;
-
-                            notificationSettings.save();
+                            Globals.revokeInhibitions();
                         }
                     }
 

applets/notifications/package/contents/ui/global/Globals.qml

@@ -29,6 +29,8 @@ import org.kde.kquickcontrolsaddons 2.0
 
 import org.kde.notificationmanager 1.0 as NotificationManager
 
+import org.kde.plasma.private.notifications 2.0 as Notifications
+
 import ".."
 
 // This singleton object contains stuff shared between all notification plasmoids, namely:
@@ -215,6 +217,15 @@ QtObject {
         });
     }
 
+    function revokeInhibitions() {
+        notificationSettings.notificationsInhibitedUntil = undefined;
+        notificationSettings.revokeApplicationInhibitions();
+        // overrules current mirrored screen setup, updates again when screen configuration changes
+        notificationSettings.screensMirrored = false;
+
+        notificationSettings.save();
+    }
+
     function rectIntersect(rect1 /*dialog*/, rect2 /*popup*/) {
         return rect1.x < rect2.x + rect2.width
                 && rect2.x < rect1.x + rect1.width
@@ -476,4 +487,21 @@ QtObject {
         property: "inhibited"
         value: globals.inhibited
     }
+
+    property Notifications.GlobalShortcuts shortcuts: Notifications.GlobalShortcuts {
+        onToggleDoNotDisturbTriggered: {
+            if (globals.inhibited) {
+                globals.revokeInhibitions();
+            } else {
+                // Effectively "in a year" is "until turned off"
+                var d = new Date();
+                d.setFullYear(d.getFullYear() + 1);
+                notificationSettings.notificationsInhibitedUntil = d;
+                notificationSettings.save();
+            }
+
+            checkInhibition();
+            showDoNotDisturbOsd(globals.inhibited);
+        }
+    }
 }