Start of a notifications framework

8 files changed, 232 insertions, 0 deletions

diff --git a/components/mail/contents/ui/Mail.qml b/components/mail/contents/ui/Mail.qml
index ff0e8c5c..334e5a96 100644
--- a/components/mail/contents/ui/Mail.qml
+++ b/components/mail/contents/ui/Mail.qml
@@ -27,6 +27,7 @@ import org.kde.kirigami 1.0 as Kirigami
 import org.kube.framework.actions 1.0 as KubeAction
 import org.kube.framework.settings 1.0 as KubeSettings
 import org.kube.framework.domain 1.0 as KubeFramework
+import org.kube.framework.notifications 1.0 as KubeNotifications
 import org.kube.components 1.0 as KubeComponents
 import org.kube.components.accounts 1.0 as KubeAccounts
 
@@ -40,6 +41,16 @@ Controls2.ApplicationWindow {
 
     visible: true
 
+    KubeNotifications.NotificationHandler {
+        id: notificationHandler
+        function handler(n) {
+            console.warn("We got a notification: ", n.message)
+            if (n.type == KubeNotifications.Notification.Warning) {
+                console.warn("And it's a warning!", n.type)
+            }
+        }
+    }
+
     //BEGIN Actions
     KubeAction.Context {
         id: maillistcontext
diff --git a/framework/CMakeLists.txt b/framework/CMakeLists.txt
index aa2362f1..d14360b4 100644
--- a/framework/CMakeLists.txt
+++ b/framework/CMakeLists.txt
@@ -41,5 +41,7 @@ add_subdirectory(settings)
 add_subdirectory(domain)
 # The accounts framework
 add_subdirectory(accounts)
+# The notifications framework
+add_subdirectory(notifications)
 
 feature_summary(WHAT ALL FATAL_ON_MISSING_REQUIRED_PACKAGES)
diff --git a/framework/notifications/CMakeLists.txt b/framework/notifications/CMakeLists.txt
new file mode 100644
index 00000000..ec2f52c2
--- /dev/null
+++ b/framework/notifications/CMakeLists.txt
@@ -0,0 +1,12 @@
+set(SRCS
+    notificationplugin.cpp
+    notificationhandler.cpp
+)
+
+add_library(notificationplugin SHARED ${SRCS})
+
+target_link_libraries(notificationplugin sink)
+qt5_use_modules(notificationplugin Core Quick Qml)
+
+install(TARGETS notificationplugin DESTINATION ${QML_INSTALL_DIR}/org/kube/framework/notifications)
+install(FILES qmldir DESTINATION ${QML_INSTALL_DIR}/org/kube/framework/notifications)
diff --git a/framework/notifications/notificationhandler.cpp b/framework/notifications/notificationhandler.cpp
new file mode 100644
index 00000000..23aa3da1
--- /dev/null
+++ b/framework/notifications/notificationhandler.cpp
@@ -0,0 +1,63 @@
+/*
+    Copyright (c) 2016 Christian Mollekopf <mollekopf@kolabsys.com>
+
+    This library is free software; you can redistribute it and/or modify it
+    under the terms of the GNU Library General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or (at your
+    option) any later version.
+
+    This library 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 Library General Public
+    License for more details.
+
+    You should have received a copy of the GNU Library General Public License
+    along with this library; see the file COPYING.LIB.  If not, write to the
+    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+    02110-1301, USA.
+*/
+
+#include "notificationhandler.h"
+
+#include <QDebug>
+
+#include <sink/notifier.h>
+#include <sink/notification.h>
+#include <sink/query.h>
+
+using namespace Kube;
+
+NotificationHandler::NotificationHandler(QObject *parent)
+    : QObject(parent)
+{
+    Sink::Query query{Sink::Query::LiveQuery};
+    mNotifier.reset(new Sink::Notifier{query});
+    mNotifier->registerHandler([this] (const Sink::Notification &notification) {
+        notify(notification);
+    });
+
+}
+
+void NotificationHandler::notify(const Sink::Notification &notification)
+{
+    Notification n;
+    qWarning() << "Received notification: " << notification;
+    if (notification.type == Sink::Notification::Warning) {
+        n.mType = Notification::Warning;
+        n.mMessage = notification.message;
+    } else if (notification.type == Sink::Notification::Status) {
+        if (notification.code == Sink::ApplicationDomain::ErrorStatus) {
+            //A resource entered error status
+            n.mType = Notification::Warning;
+            n.mMessage = notification.message;
+        }
+    } else if (notification.type == Sink::Notification::Info) {
+        n.mType = Notification::Info;
+        n.mMessage = notification.message;
+    } else {
+        return;
+    }
+    //The base implementation to call the handler in QML
+    QMetaObject::invokeMethod(this, "handler", Q_ARG(QVariant, QVariant::fromValue(&n)));
+}
+
diff --git a/framework/notifications/notificationhandler.h b/framework/notifications/notificationhandler.h
new file mode 100644
index 00000000..fa992e87
--- /dev/null
+++ b/framework/notifications/notificationhandler.h
@@ -0,0 +1,80 @@
+/*
+    Copyright (c) 2016 Christian Mollekopf <mollekopf@kolabsys.com>
+
+    This library is free software; you can redistribute it and/or modify it
+    under the terms of the GNU Library General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or (at your
+    option) any later version.
+
+    This library 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 Library General Public
+    License for more details.
+
+    You should have received a copy of the GNU Library General Public License
+    along with this library; see the file COPYING.LIB.  If not, write to the
+    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+    02110-1301, USA.
+*/
+#pragma once
+
+#include <QObject>
+#include <QVariant>
+#include <functional>
+#include <sink/notifier.h>
+
+namespace Sink {
+    class Notification;
+}
+
+namespace Kube {
+
+class Notification : public QObject
+{
+    Q_OBJECT
+
+public:
+    enum Type {
+        Info,
+        Warning
+    };
+    Q_ENUMS(Type)
+
+    Q_PROPERTY(Type type MEMBER mType CONSTANT)
+    Q_PROPERTY(QString message MEMBER mMessage CONSTANT)
+
+    Notification() = default;
+    ~Notification() = default;
+
+    Type mType;
+    QString mMessage;
+};
+
+/**
+ * A notification handler.
+ *
+ * Can beinstantiated from QML like so:
+ * NotificationHandler {
+ *   function handler(notification) {
+ *      ...do something
+ *   }
+ * }
+ *
+ * The handler will listen for all notifications by default.
+ */
+class NotificationHandler : public QObject
+{
+    Q_OBJECT
+
+public:
+    NotificationHandler(QObject *parent = 0);
+
+    virtual void notify(const Sink::Notification &notification);
+
+private:
+    QScopedPointer<Sink::Notifier> mNotifier;
+};
+
+}
+
+Q_DECLARE_METATYPE(Kube::Notification*);
diff --git a/framework/notifications/notificationplugin.cpp b/framework/notifications/notificationplugin.cpp
new file mode 100644
index 00000000..a7a9aa5b
--- /dev/null
+++ b/framework/notifications/notificationplugin.cpp
@@ -0,0 +1,30 @@
+/*
+    Copyright (c) 2016 Christian Mollekopf <mollekopf@kolabsys.com>
+
+    This library is free software; you can redistribute it and/or modify it
+    under the terms of the GNU Library General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or (at your
+    option) any later version.
+
+    This library 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 Library General Public
+    License for more details.
+
+    You should have received a copy of the GNU Library General Public License
+    along with this library; see the file COPYING.LIB.  If not, write to the
+    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+    02110-1301, USA.
+*/
+#include "notificationplugin.h"
+
+#include "notificationhandler.h"
+
+#include <QtQml>
+
+void NotificationPlugin::registerTypes (const char *uri)
+{
+    Q_ASSERT(uri == QLatin1String("org.kube.framework.notifications"));
+    qmlRegisterType<Kube::NotificationHandler>(uri, 1, 0, "NotificationHandler");
+    qmlRegisterType<Kube::Notification>(uri, 1, 0, "Notification");
+}
diff --git a/framework/notifications/notificationplugin.h b/framework/notifications/notificationplugin.h
new file mode 100644
index 00000000..9aa0e033
--- /dev/null
+++ b/framework/notifications/notificationplugin.h
@@ -0,0 +1,31 @@
+/*
+    Copyright (c) 2016 Christian Mollekopf <mollekopf@kolabsys.com>
+
+    This library is free software; you can redistribute it and/or modify it
+    under the terms of the GNU Library General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or (at your
+    option) any later version.
+
+    This library 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 Library General Public
+    License for more details.
+
+    You should have received a copy of the GNU Library General Public License
+    along with this library; see the file COPYING.LIB.  If not, write to the
+    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+    02110-1301, USA.
+*/
+#pragma once
+
+#include <QQmlEngine>
+#include <QQmlExtensionPlugin>
+
+class NotificationPlugin : public QQmlExtensionPlugin
+{
+    Q_OBJECT
+    Q_PLUGIN_METADATA(IID "org.qt-project.Qt.QQmlExtensionInterface")
+
+public:
+    virtual void registerTypes(const char *uri);
+};
diff --git a/framework/notifications/qmldir b/framework/notifications/qmldir
new file mode 100644
index 00000000..4eaad10c
--- /dev/null
+++ b/framework/notifications/qmldir
@@ -0,0 +1,3 @@
+module org.kube.framework.notifications
+
+plugin notificationplugin