Web Notifications API

Implements API for end-user notifications.

Co-authored by Allan Sandfeld Jensen

[ChangeLog][Profile] Support for Web Notifications API
for end-user notifications through QWebEngineNotification

Task-number: QTBUG-50995
Fixes: QTBUG-51191
Change-Id: Icebaaa05275a713e801f1f8ecdaaec725fa264c8
Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>

3 files changed, 389 insertions, 0 deletions

diff --git a/src/core/api/core_api.pro b/src/core/api/core_api.pro
index b5bb93847..d6ef81add 100644
--- a/src/core/api/core_api.pro
+++ b/src/core/api/core_api.pro
@@ -38,6 +38,7 @@ HEADERS = \
     qwebenginecookiestore.h \
     qwebenginecookiestore_p.h \
     qwebenginehttprequest.h \
+    qwebenginenotification.h \
     qwebenginequotarequest.h \
     qwebengineregisterprotocolhandlerrequest.h \
     qwebengineurlrequestinterceptor.h \
@@ -51,6 +52,7 @@ SOURCES = \
     qtwebenginecoreglobal.cpp \
     qwebenginecookiestore.cpp \
     qwebenginehttprequest.cpp \
+    qwebenginenotification.cpp \
     qwebenginequotarequest.cpp \
     qwebengineregisterprotocolhandlerrequest.cpp \
     qwebengineurlrequestinfo.cpp \
diff --git a/src/core/api/qwebenginenotification.cpp b/src/core/api/qwebenginenotification.cpp
new file mode 100644
index 000000000..0b91cf273
--- /dev/null
+++ b/src/core/api/qwebenginenotification.cpp
@@ -0,0 +1,275 @@
+/****************************************************************************
+**
+** Copyright (C) 2017 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the QtWebEngine module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or (at your option) the GNU General
+** Public license version 3 or any later version approved by the KDE Free
+** Qt Foundation. The licenses are as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-2.0.html and
+** https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "qwebenginenotification.h"
+
+#include "user_notification_controller.h"
+
+#include <QExplicitlySharedDataPointer>
+
+QT_BEGIN_NAMESPACE
+
+using QtWebEngineCore::UserNotificationController;
+
+/*!
+    \class QWebEngineNotification
+    \brief The QWebEngineNotification class encapsulates the data of an HTML5 web notification.
+    \since 5.13
+
+    \inmodule QtWebEngineCore
+
+    This class contains the information and API for HTML5 desktop and push notifications.
+*/
+
+class QWebEngineNotificationPrivate : public UserNotificationController::Client {
+public:
+    QWebEngineNotificationPrivate(QWebEngineNotification *q, const QSharedPointer<UserNotificationController> &controller)
+        : controller(controller)
+        , q(q)
+    {
+        controller->setClient(this);
+    }
+    ~QWebEngineNotificationPrivate() override
+    {
+        if (controller->client() == this)
+            controller->setClient(0);
+    }
+
+    // UserNotificationController::Client:
+    virtual void notificationClosed(const UserNotificationController *) Q_DECL_OVERRIDE
+    {
+        Q_EMIT q->closed();
+    }
+
+    QSharedPointer<UserNotificationController> controller;
+    QWebEngineNotification *q;
+};
+
+
+/*!
+    Creates a null QWebEngineNotification.
+
+    \sa isNull()
+*/
+QWebEngineNotification::QWebEngineNotification() { }
+
+/*! \internal
+*/
+QWebEngineNotification::QWebEngineNotification(const QSharedPointer<UserNotificationController> &controller)
+    : d_ptr(new QWebEngineNotificationPrivate(this, controller))
+{ }
+
+/*! \internal
+*/
+QWebEngineNotification::QWebEngineNotification(const QWebEngineNotification &other)
+    : QObject()
+    , d_ptr(new QWebEngineNotificationPrivate(this, other.d_ptr->controller))
+{ }
+
+/*! \internal
+*/
+QWebEngineNotification::~QWebEngineNotification()
+{
+}
+
+/*! \internal
+*/
+const QWebEngineNotification &QWebEngineNotification::operator=(const QWebEngineNotification &other)
+{
+    d_ptr.reset(new QWebEngineNotificationPrivate(this, other.d_ptr->controller));
+    return *this;
+}
+
+/*!
+    Returns \c true if the two notifications belong to the same message chain.
+    That is, if their tag() and origin() are the same. This means one is
+    a replacement or an update of the \a other.
+
+    \sa tag(), origin()
+*/
+bool QWebEngineNotification::matches(const QWebEngineNotification &other) const
+{
+    if (!d_ptr)
+        return !other.d_ptr;
+    if (!other.d_ptr)
+        return false;
+    return tag() == other.tag() && origin() == other.origin();
+}
+
+/*!
+    \property QWebEngineNotification::title
+    \brief The title of the notification.
+    \sa message()
+*/
+QString QWebEngineNotification::title() const
+{
+    Q_D(const QWebEngineNotification);
+    return d ? d->controller->title() : QString();
+}
+
+/*!
+    \property QWebEngineNotification::message
+    \brief The body of the notification message.
+    \sa title()
+*/
+
+QString QWebEngineNotification::message() const
+{
+    Q_D(const QWebEngineNotification);
+    return d ? d->controller->body() : QString();
+}
+
+/*!
+    \property QWebEngineNotification::tag
+    \brief The tag of the notification message.
+
+    New notifications that have the same tag and origin URL as an existing
+    one should replace or update the old notification with the same tag.
+
+    \sa matches()
+*/
+QString QWebEngineNotification::tag() const
+{
+    Q_D(const QWebEngineNotification);
+    return d ? d->controller->tag() : QString();
+}
+
+/*!
+    \property QWebEngineNotification::origin
+    \brief The URL of the page sending the notification.
+*/
+
+QUrl QWebEngineNotification::origin() const
+{
+    Q_D(const QWebEngineNotification);
+    return d ? d->controller->origin() : QUrl();
+}
+
+/*!
+    \property QWebEngineNotification::icon
+    \brief The icon to be shown with the notification.
+
+    If no icon is set by the sender, an null QIcon is returned.
+*/
+QIcon QWebEngineNotification::icon() const
+{
+    Q_D(const QWebEngineNotification);
+    return d ? d->controller->icon() : QIcon();
+}
+
+/*!
+    \property QWebEngineNotification::language
+    \brief The primary language for the notification's title and body.
+
+    Its value is a valid BCP 47 language tag, or the empty string.
+
+    \sa title(), message()
+*/
+QString QWebEngineNotification::language() const
+{
+    Q_D(const QWebEngineNotification);
+    return d ? d->controller->language() : QString();
+}
+
+/*!
+    \property QWebEngineNotification::direction
+    \brief The text direction for the notification's title and body.
+    \sa title(), message()
+*/
+QWebEngineNotification::Direction QWebEngineNotification::direction() const
+{
+    Q_D(const QWebEngineNotification);
+    return d ? static_cast<Direction>(d->controller->direction()) : DirectionAuto;
+}
+
+/*!
+    Returns \c true if the notification is a default constructed null notification.
+*/
+bool QWebEngineNotification::isNull() const
+{
+    return d_ptr.isNull();
+}
+
+/*!
+    Creates and dispatches a JavaScript \e {show event} on notification.
+
+    Should be called by the notification platform when the notification has been shown to user.
+*/
+void QWebEngineNotification::show() const
+{
+    Q_D(const QWebEngineNotification);
+    if (d)
+        d->controller->notificationDisplayed();
+}
+
+/*!
+    Creates and dispatches a JavaScript \e {click event} on notification.
+
+    Should be called by the notification platform when the notification is activated by the user.
+*/
+void QWebEngineNotification::click() const
+{
+    Q_D(const QWebEngineNotification);
+    if (d)
+        d->controller->notificationClicked();
+}
+
+/*!
+    Creates and dispatches a JavaScript \e {close event} on notification.
+
+    Should be called by the notification platform when the notification is closed,
+    either by the underlying platform or by the user.
+*/
+void QWebEngineNotification::close() const
+{
+    Q_D(const QWebEngineNotification);
+    if (d)
+        d->controller->notificationClosed();
+}
+
+/*!
+    \fn void QWebEngineNotification::closed()
+
+    This signal is emitted when the web page calls close steps for the notification,
+    and it no longer needs to be shown.
+*/
+
+QT_END_NAMESPACE
+
+#include "moc_qwebenginenotification.cpp"
diff --git a/src/core/api/qwebenginenotification.h b/src/core/api/qwebenginenotification.h
new file mode 100644
index 000000000..b6b7414f9
--- /dev/null
+++ b/src/core/api/qwebenginenotification.h
@@ -0,0 +1,112 @@
+/****************************************************************************
+**
+** Copyright (C) 2017 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the QtWebEngine module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or (at your option) the GNU General
+** Public license version 3 or any later version approved by the KDE Free
+** Qt Foundation. The licenses are as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-2.0.html and
+** https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QWEBENGINENOTIFICATION_H
+#define QWEBENGINENOTIFICATION_H
+
+#include <QtWebEngineCore/qtwebenginecoreglobal.h>
+
+#include <QtCore/QObject>
+#include <QtCore/QScopedPointer>
+#include <QtCore/QSharedPointer>
+#include <QtCore/QUrl>
+#include <QtGui/QIcon>
+
+namespace QtWebEngineCore {
+class UserNotificationController;
+}
+
+QT_BEGIN_NAMESPACE
+
+class QWebEngineNotificationPrivate;
+
+class QWEBENGINECORE_EXPORT QWebEngineNotification : public QObject {
+    Q_OBJECT
+    Q_PROPERTY(QUrl origin READ origin CONSTANT FINAL)
+    Q_PROPERTY(QIcon icon READ icon CONSTANT FINAL)
+    Q_PROPERTY(QString title READ title CONSTANT FINAL)
+    Q_PROPERTY(QString message READ message CONSTANT FINAL)
+    Q_PROPERTY(QString tag READ tag CONSTANT FINAL)
+    Q_PROPERTY(QString language READ language CONSTANT FINAL)
+    Q_PROPERTY(Direction direction READ direction CONSTANT FINAL)
+
+public:
+    QWebEngineNotification();
+    QWebEngineNotification(const QWebEngineNotification &);
+    virtual ~QWebEngineNotification();
+    const QWebEngineNotification &operator=(const QWebEngineNotification &);
+
+    enum Direction {
+        LeftToRight = Qt::LeftToRight,
+        RightToLeft = Qt::RightToLeft,
+        DirectionAuto = Qt::LayoutDirectionAuto
+    };
+    Q_ENUM(Direction)
+
+    bool matches(const QWebEngineNotification &) const;
+
+    QUrl origin() const;
+    QIcon icon() const;
+    QString title() const;
+    QString message() const;
+    QString tag() const;
+    QString language() const;
+    Direction direction() const;
+
+    bool isNull() const;
+
+public Q_SLOTS:
+    void show() const;
+    void click() const;
+    void close() const;
+
+Q_SIGNALS:
+    void closed();
+
+private:
+    QWebEngineNotification(const QSharedPointer<QtWebEngineCore::UserNotificationController> &);
+    Q_DECLARE_PRIVATE(QWebEngineNotification)
+    QScopedPointer<QWebEngineNotificationPrivate> d_ptr;
+    friend class QQuickWebEngineProfilePrivate;
+    friend class QWebEngineProfilePrivate;
+};
+
+QT_END_NAMESPACE
+
+#endif // QWEBENGINENOTIFICATION_H