Simplify usage of QWebChannel on the server side.

This is achieved by hiding the MetaObjectPublisher completely as
private API. The QWebChannel is the only publisher API and now handles
both the socket as well as the publisher internally.

This now allows us to create a proper QML api in the new QmlWebChannel.

Change-Id: I3096364af8485353ca9bc19df4a81a8e4552c3d7
Reviewed-by: Simon Hausmann <simon.hausmann@digia.com>

4 files changed, 149 insertions, 6 deletions

diff --git a/src/imports/webchannel/plugin.cpp b/src/imports/webchannel/plugin.cpp
index a5e9895..0835c2b 100644
--- a/src/imports/webchannel/plugin.cpp
+++ b/src/imports/webchannel/plugin.cpp
@@ -43,8 +43,7 @@
 #include <qqml.h>
 #include <QtQml/QQmlExtensionPlugin>
 
-#include "qwebchannel.h"
-#include "qmetaobjectpublisher.h"
+#include "qmlwebchannel.h"
 
 QT_USE_NAMESPACE
 
@@ -61,8 +60,7 @@ void QWebChannelPlugin::registerTypes(const char *uri)
 {
     int major = 1;
     int minor = 0;
-    qmlRegisterType<QWebChannel>(uri, major, minor, "WebChannel");
-    qmlRegisterType<QMetaObjectPublisher>(uri, major, minor, "MetaObjectPublisher");
+    qmlRegisterType<QmlWebChannel>(uri, major, minor, "WebChannel");
 
 }
 
diff --git a/src/imports/webchannel/qmlwebchannel.cpp b/src/imports/webchannel/qmlwebchannel.cpp
new file mode 100644
index 0000000..a7a6db0
--- /dev/null
+++ b/src/imports/webchannel/qmlwebchannel.cpp
@@ -0,0 +1,75 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Copyright (C) 2013 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com, author Milian Wolff <milian.wolff@kdab.com>
+** Contact: http://www.qt-project.org/legal
+*
+** This file is part of the QtWebChannel 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 Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3.0 as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU General Public License version 3.0 requirements will be
+** met: http://www.gnu.org/copyleft/gpl.html.
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "qmlwebchannel.h"
+
+#include "qwebchannel_p.h"
+#include "qmetaobjectpublisher_p.h"
+
+QmlWebChannel::QmlWebChannel(QObject *parent)
+    : QWebChannel(parent)
+{
+
+}
+
+QmlWebChannel::~QmlWebChannel()
+{
+
+}
+
+void QmlWebChannel::registerObjects(const QVariantMap &objects)
+{
+    QMap<QString, QVariant>::const_iterator it = objects.constBegin();
+    for (; it != objects.constEnd(); ++it) {
+        QObject *object = it.value().value<QObject*>();
+        if (!object) {
+            qWarning("Invalid QObject given to register under name %s", qPrintable(it.key()));
+            continue;
+        }
+        d->publisher->registerObject(it.key(), object);
+    }
+}
+
+bool QmlWebChannel::test_clientIsIdle() const
+{
+    return d->publisher->clientIsIdle;
+}
diff --git a/src/imports/webchannel/qmlwebchannel.h b/src/imports/webchannel/qmlwebchannel.h
new file mode 100644
index 0000000..b52bc8b
--- /dev/null
+++ b/src/imports/webchannel/qmlwebchannel.h
@@ -0,0 +1,63 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Copyright (C) 2013 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com, author Milian Wolff <milian.wolff@kdab.com>
+** Contact: http://www.qt-project.org/legal
+*
+** This file is part of the QtWebChannel 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 Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3.0 as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU General Public License version 3.0 requirements will be
+** met: http://www.gnu.org/copyleft/gpl.html.
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QMLWEBCHANNEL_H
+#define QMLWEBCHANNEL_H
+
+#include <qwebchannel.h>
+
+class QmlWebChannel : public QWebChannel
+{
+    Q_OBJECT
+
+public:
+    QmlWebChannel(QObject *parent = 0);
+    virtual ~QmlWebChannel();
+
+    // TODO: replace by list property
+    Q_INVOKABLE void registerObjects(const QVariantMap &objects);
+
+    // TODO: remove this by replacing QML with C++ tests
+    Q_INVOKABLE bool test_clientIsIdle() const;
+};
+
+#endif // QMLWEBCHANNEL_H
diff --git a/src/imports/webchannel/webchannel.pro b/src/imports/webchannel/webchannel.pro
index 1753cee..3051077 100644
--- a/src/imports/webchannel/webchannel.pro
+++ b/src/imports/webchannel/webchannel.pro
@@ -1,6 +1,13 @@
-QT = core quick webchannel
+QT = core quick webchannel-private
+
+INCLUDEPATH += ../../webchannel
+VPATH += ../../webchannel
 
 SOURCES += \
-    plugin.cpp
+    plugin.cpp \
+    qmlwebchannel.cpp
+
+HEADERS += \
+    qmlwebchannel.h
 
 load(qml_plugin)