1117 lines
41 KiB
JavaScript
1117 lines
41 KiB
JavaScript
// qwebchannel.js
|
|
/****************************************************************************
|
|
**
|
|
** Copyright (C) 2016 The Qt Company Ltd.
|
|
** Copyright (C) 2014 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com, author Milian Wolff <milian.wolff@kdab.com>
|
|
** Contact: https://www.qt.io/licensing/
|
|
**
|
|
** This file is part of the QtWebChannel module of the Qt Toolkit.
|
|
**
|
|
** $QT_BEGIN_LICENSE:BSD$
|
|
** 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.
|
|
**
|
|
** BSD License Usage
|
|
** Alternatively, you may use this file under the terms of the BSD license
|
|
** as follows:
|
|
**
|
|
** "Redistribution and use in source and binary forms, with or without
|
|
** modification, are permitted provided that the following conditions are
|
|
** met:
|
|
** * Redistributions of source code must retain the above copyright
|
|
** notice, this list of conditions and the following disclaimer.
|
|
** * Redistributions in binary form must reproduce the above copyright
|
|
** notice, this list of conditions and the following disclaimer in
|
|
** the documentation and/or other materials provided with the
|
|
** distribution.
|
|
** * Neither the name of The Qt Company Ltd nor the names of its
|
|
** contributors may be used to endorse or promote products derived
|
|
** from this software without specific prior written permission.
|
|
**
|
|
**
|
|
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
|
|
**
|
|
** $QT_END_LICENSE$
|
|
**
|
|
****************************************************************************/
|
|
|
|
"use strict";
|
|
|
|
var QWebChannelMessageTypes = {
|
|
signal: 1,
|
|
propertyUpdate: 2,
|
|
init: 3,
|
|
idle: 4,
|
|
debug: 5,
|
|
invokeMethod: 6,
|
|
connectToSignal: 7,
|
|
disconnectFromSignal: 8,
|
|
setProperty: 9,
|
|
response: 10,
|
|
};
|
|
|
|
var QWebChannel = function(transport, initCallback)
|
|
{
|
|
if (typeof transport !== "object" || typeof transport.send !== "function") {
|
|
console.error("The QWebChannel expects a transport object with a send function and onmessage callback property." +
|
|
" Given is: transport: " + typeof(transport) + ", transport.send: " + typeof(transport.send));
|
|
return;
|
|
}
|
|
|
|
var channel = this;
|
|
this.transport = transport;
|
|
|
|
this.send = function(data)
|
|
{
|
|
if (typeof(data) !== "string") {
|
|
data = JSON.stringify(data);
|
|
}
|
|
channel.transport.send(data);
|
|
}
|
|
|
|
this.transport.onmessage = function(message)
|
|
{
|
|
var data = message.data;
|
|
if (typeof data === "string") {
|
|
data = JSON.parse(data);
|
|
}
|
|
switch (data.type) {
|
|
case QWebChannelMessageTypes.signal:
|
|
channel.handleSignal(data);
|
|
break;
|
|
case QWebChannelMessageTypes.response:
|
|
channel.handleResponse(data);
|
|
break;
|
|
case QWebChannelMessageTypes.propertyUpdate:
|
|
channel.handlePropertyUpdate(data);
|
|
break;
|
|
default:
|
|
console.error("invalid message received:", message.data);
|
|
break;
|
|
}
|
|
}
|
|
|
|
this.execCallbacks = {};
|
|
this.execId = 0;
|
|
this.exec = function(data, callback)
|
|
{
|
|
if (!callback) {
|
|
// if no callback is given, send directly
|
|
channel.send(data);
|
|
return;
|
|
}
|
|
if (channel.execId === Number.MAX_VALUE) {
|
|
// wrap
|
|
channel.execId = Number.MIN_VALUE;
|
|
}
|
|
if (data.hasOwnProperty("id")) {
|
|
console.error("Cannot exec message with property id: " + JSON.stringify(data));
|
|
return;
|
|
}
|
|
data.id = channel.execId++;
|
|
channel.execCallbacks[data.id] = callback;
|
|
channel.send(data);
|
|
};
|
|
|
|
this.objects = {};
|
|
|
|
this.handleSignal = function(message)
|
|
{
|
|
var object = channel.objects[message.object];
|
|
if (object) {
|
|
object.signalEmitted(message.signal, message.args);
|
|
} else {
|
|
console.warn("Unhandled signal: " + message.object + "::" + message.signal);
|
|
}
|
|
}
|
|
|
|
this.handleResponse = function(message)
|
|
{
|
|
if (!message.hasOwnProperty("id")) {
|
|
console.error("Invalid response message received: ", JSON.stringify(message));
|
|
return;
|
|
}
|
|
channel.execCallbacks[message.id](message.data);
|
|
delete channel.execCallbacks[message.id];
|
|
}
|
|
|
|
this.handlePropertyUpdate = function(message)
|
|
{
|
|
for (var i in message.data) {
|
|
var data = message.data[i];
|
|
var object = channel.objects[data.object];
|
|
if (object) {
|
|
object.propertyUpdate(data.signals, data.properties);
|
|
} else {
|
|
console.warn("Unhandled property update: " + data.object + "::" + data.signal);
|
|
}
|
|
}
|
|
channel.exec({type: QWebChannelMessageTypes.idle});
|
|
}
|
|
|
|
this.debug = function(message)
|
|
{
|
|
channel.send({type: QWebChannelMessageTypes.debug, data: message});
|
|
};
|
|
|
|
channel.exec({type: QWebChannelMessageTypes.init}, function(data) {
|
|
for (var objectName in data) {
|
|
var object = new QObject(objectName, data[objectName], channel);
|
|
}
|
|
// now unwrap properties, which might reference other registered objects
|
|
for (var objectName in channel.objects) {
|
|
channel.objects[objectName].unwrapProperties();
|
|
}
|
|
if (initCallback) {
|
|
initCallback(channel);
|
|
}
|
|
channel.exec({type: QWebChannelMessageTypes.idle});
|
|
});
|
|
};
|
|
|
|
function QObject(name, data, webChannel)
|
|
{
|
|
this.__id__ = name;
|
|
webChannel.objects[name] = this;
|
|
|
|
// List of callbacks that get invoked upon signal emission
|
|
this.__objectSignals__ = {};
|
|
|
|
// Cache of all properties, updated when a notify signal is emitted
|
|
this.__propertyCache__ = {};
|
|
|
|
var object = this;
|
|
|
|
// ----------------------------------------------------------------------
|
|
|
|
this.unwrapQObject = function(response)
|
|
{
|
|
if (response instanceof Array) {
|
|
// support list of objects
|
|
var ret = new Array(response.length);
|
|
for (var i = 0; i < response.length; ++i) {
|
|
ret[i] = object.unwrapQObject(response[i]);
|
|
}
|
|
return ret;
|
|
}
|
|
if (!response
|
|
|| !response["__QObject*__"]
|
|
|| response.id === undefined) {
|
|
return response;
|
|
}
|
|
|
|
var objectId = response.id;
|
|
if (webChannel.objects[objectId])
|
|
return webChannel.objects[objectId];
|
|
|
|
if (!response.data) {
|
|
console.error("Cannot unwrap unknown QObject " + objectId + " without data.");
|
|
return;
|
|
}
|
|
|
|
var qObject = new QObject( objectId, response.data, webChannel );
|
|
qObject.destroyed.connect(function() {
|
|
if (webChannel.objects[objectId] === qObject) {
|
|
delete webChannel.objects[objectId];
|
|
// reset the now deleted QObject to an empty {} object
|
|
// just assigning {} though would not have the desired effect, but the
|
|
// below also ensures all external references will see the empty map
|
|
// NOTE: this detour is necessary to workaround QTBUG-40021
|
|
var propertyNames = [];
|
|
for (var propertyName in qObject) {
|
|
propertyNames.push(propertyName);
|
|
}
|
|
for (var idx in propertyNames) {
|
|
delete qObject[propertyNames[idx]];
|
|
}
|
|
}
|
|
});
|
|
// here we are already initialized, and thus must directly unwrap the properties
|
|
qObject.unwrapProperties();
|
|
return qObject;
|
|
}
|
|
|
|
this.unwrapProperties = function()
|
|
{
|
|
for (var propertyIdx in object.__propertyCache__) {
|
|
object.__propertyCache__[propertyIdx] = object.unwrapQObject(object.__propertyCache__[propertyIdx]);
|
|
}
|
|
}
|
|
|
|
function addSignal(signalData, isPropertyNotifySignal)
|
|
{
|
|
var signalName = signalData[0];
|
|
var signalIndex = signalData[1];
|
|
object[signalName] = {
|
|
connect: function(callback) {
|
|
if (typeof(callback) !== "function") {
|
|
console.error("Bad callback given to connect to signal " + signalName);
|
|
return;
|
|
}
|
|
|
|
object.__objectSignals__[signalIndex] = object.__objectSignals__[signalIndex] || [];
|
|
object.__objectSignals__[signalIndex].push(callback);
|
|
|
|
if (!isPropertyNotifySignal && signalName !== "destroyed") {
|
|
// only required for "pure" signals, handled separately for properties in propertyUpdate
|
|
// also note that we always get notified about the destroyed signal
|
|
webChannel.exec({
|
|
type: QWebChannelMessageTypes.connectToSignal,
|
|
object: object.__id__,
|
|
signal: signalIndex
|
|
});
|
|
}
|
|
},
|
|
disconnect: function(callback) {
|
|
if (typeof(callback) !== "function") {
|
|
console.error("Bad callback given to disconnect from signal " + signalName);
|
|
return;
|
|
}
|
|
object.__objectSignals__[signalIndex] = object.__objectSignals__[signalIndex] || [];
|
|
var idx = object.__objectSignals__[signalIndex].indexOf(callback);
|
|
if (idx === -1) {
|
|
console.error("Cannot find connection of signal " + signalName + " to " + callback.name);
|
|
return;
|
|
}
|
|
object.__objectSignals__[signalIndex].splice(idx, 1);
|
|
if (!isPropertyNotifySignal && object.__objectSignals__[signalIndex].length === 0) {
|
|
// only required for "pure" signals, handled separately for properties in propertyUpdate
|
|
webChannel.exec({
|
|
type: QWebChannelMessageTypes.disconnectFromSignal,
|
|
object: object.__id__,
|
|
signal: signalIndex
|
|
});
|
|
}
|
|
}
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Invokes all callbacks for the given signalname. Also works for property notify callbacks.
|
|
*/
|
|
function invokeSignalCallbacks(signalName, signalArgs)
|
|
{
|
|
var connections = object.__objectSignals__[signalName];
|
|
if (connections) {
|
|
connections.forEach(function(callback) {
|
|
callback.apply(callback, signalArgs);
|
|
});
|
|
}
|
|
}
|
|
|
|
this.propertyUpdate = function(signals, propertyMap)
|
|
{
|
|
// update property cache
|
|
for (var propertyIndex in propertyMap) {
|
|
var propertyValue = propertyMap[propertyIndex];
|
|
object.__propertyCache__[propertyIndex] = propertyValue;
|
|
}
|
|
|
|
for (var signalName in signals) {
|
|
// Invoke all callbacks, as signalEmitted() does not. This ensures the
|
|
// property cache is updated before the callbacks are invoked.
|
|
invokeSignalCallbacks(signalName, signals[signalName]);
|
|
}
|
|
}
|
|
|
|
this.signalEmitted = function(signalName, signalArgs)
|
|
{
|
|
invokeSignalCallbacks(signalName, signalArgs);
|
|
}
|
|
|
|
function addMethod(methodData)
|
|
{
|
|
var methodName = methodData[0];
|
|
var methodIdx = methodData[1];
|
|
object[methodName] = function() {
|
|
var args = [];
|
|
var callback;
|
|
for (var i = 0; i < arguments.length; ++i) {
|
|
if (typeof arguments[i] === "function")
|
|
callback = arguments[i];
|
|
else
|
|
args.push(arguments[i]);
|
|
}
|
|
|
|
webChannel.exec({
|
|
"type": QWebChannelMessageTypes.invokeMethod,
|
|
"object": object.__id__,
|
|
"method": methodIdx,
|
|
"args": args
|
|
}, function(response) {
|
|
if (response !== undefined) {
|
|
var result = object.unwrapQObject(response);
|
|
if (callback) {
|
|
(callback)(result);
|
|
}
|
|
}
|
|
});
|
|
};
|
|
}
|
|
|
|
function bindGetterSetter(propertyInfo)
|
|
{
|
|
var propertyIndex = propertyInfo[0];
|
|
var propertyName = propertyInfo[1];
|
|
var notifySignalData = propertyInfo[2];
|
|
// initialize property cache with current value
|
|
// NOTE: if this is an object, it is not directly unwrapped as it might
|
|
// reference other QObject that we do not know yet
|
|
object.__propertyCache__[propertyIndex] = propertyInfo[3];
|
|
|
|
if (notifySignalData) {
|
|
if (notifySignalData[0] === 1) {
|
|
// signal name is optimized away, reconstruct the actual name
|
|
notifySignalData[0] = propertyName + "Changed";
|
|
}
|
|
addSignal(notifySignalData, true);
|
|
}
|
|
|
|
Object.defineProperty(object, propertyName, {
|
|
configurable: true,
|
|
get: function () {
|
|
var propertyValue = object.__propertyCache__[propertyIndex];
|
|
if (propertyValue === undefined) {
|
|
// This shouldn't happen
|
|
console.warn("Undefined value in property cache for property \"" + propertyName + "\" in object " + object.__id__);
|
|
}
|
|
|
|
return propertyValue;
|
|
},
|
|
set: function(value) {
|
|
if (value === undefined) {
|
|
console.warn("Property setter for " + propertyName + " called with undefined value!");
|
|
return;
|
|
}
|
|
object.__propertyCache__[propertyIndex] = value;
|
|
webChannel.exec({
|
|
"type": QWebChannelMessageTypes.setProperty,
|
|
"object": object.__id__,
|
|
"property": propertyIndex,
|
|
"value": value
|
|
});
|
|
}
|
|
});
|
|
|
|
}
|
|
|
|
// ----------------------------------------------------------------------
|
|
|
|
data.methods.forEach(addMethod);
|
|
|
|
data.properties.forEach(bindGetterSetter);
|
|
|
|
data.signals.forEach(function(signal) { addSignal(signal, false); });
|
|
|
|
for (var name in data.enums) {
|
|
object[name] = data.enums[name];
|
|
}
|
|
}
|
|
|
|
//required for use with nodejs
|
|
if (typeof module === 'object') {
|
|
module.exports = {
|
|
QWebChannel: QWebChannel
|
|
};
|
|
}
|
|
|
|
|
|
|
|
// provider.js
|
|
/******************************************************************************
|
|
Mozilla Public License Version 2.0
|
|
==================================
|
|
|
|
### 1. Definitions
|
|
|
|
**1.1. “Contributor”**
|
|
means each individual or legal entity that creates, contributes to
|
|
the creation of, or owns Covered Software.
|
|
|
|
**1.2. “Contributor Version”**
|
|
means the combination of the Contributions of others (if any) used
|
|
by a Contributor and that particular Contributor's Contribution.
|
|
|
|
**1.3. “Contribution”**
|
|
means Covered Software of a particular Contributor.
|
|
|
|
**1.4. “Covered Software”**
|
|
means Source Code Form to which the initial Contributor has attached
|
|
the notice in Exhibit A, the Executable Form of such Source Code
|
|
Form, and Modifications of such Source Code Form, in each case
|
|
including portions thereof.
|
|
|
|
**1.5. “Incompatible With Secondary Licenses”**
|
|
means
|
|
|
|
* **(a)** that the initial Contributor has attached the notice described
|
|
in Exhibit B to the Covered Software; or
|
|
* **(b)** that the Covered Software was made available under the terms of
|
|
version 1.1 or earlier of the License, but not also under the
|
|
terms of a Secondary License.
|
|
|
|
**1.6. “Executable Form”**
|
|
means any form of the work other than Source Code Form.
|
|
|
|
**1.7. “Larger Work”**
|
|
means a work that combines Covered Software with other material, in
|
|
a separate file or files, that is not Covered Software.
|
|
|
|
**1.8. “License”**
|
|
means this document.
|
|
|
|
**1.9. “Licensable”**
|
|
means having the right to grant, to the maximum extent possible,
|
|
whether at the time of the initial grant or subsequently, any and
|
|
all of the rights conveyed by this License.
|
|
|
|
**1.10. “Modifications”**
|
|
means any of the following:
|
|
|
|
* **(a)** any file in Source Code Form that results from an addition to,
|
|
deletion from, or modification of the contents of Covered
|
|
Software; or
|
|
* **(b)** any new file in Source Code Form that contains any Covered
|
|
Software.
|
|
|
|
**1.11. “Patent Claims” of a Contributor**
|
|
means any patent claim(s), including without limitation, method,
|
|
process, and apparatus claims, in any patent Licensable by such
|
|
Contributor that would be infringed, but for the grant of the
|
|
License, by the making, using, selling, offering for sale, having
|
|
made, import, or transfer of either its Contributions or its
|
|
Contributor Version.
|
|
|
|
**1.12. “Secondary License”**
|
|
means either the GNU General Public License, Version 2.0, the GNU
|
|
Lesser General Public License, Version 2.1, the GNU Affero General
|
|
Public License, Version 3.0, or any later versions of those
|
|
licenses.
|
|
|
|
**1.13. “Source Code Form”**
|
|
means the form of the work preferred for making modifications.
|
|
|
|
**1.14. “You” (or “Your”)**
|
|
means an individual or a legal entity exercising rights under this
|
|
License. For legal entities, “You” includes any entity that
|
|
controls, is controlled by, or is under common control with You. For
|
|
purposes of this definition, “control” means **(a)** the power, direct
|
|
or indirect, to cause the direction or management of such entity,
|
|
whether by contract or otherwise, or **(b)** ownership of more than
|
|
fifty percent (50%) of the outstanding shares or beneficial
|
|
ownership of such entity.
|
|
|
|
|
|
### 2. License Grants and Conditions
|
|
|
|
#### 2.1. Grants
|
|
|
|
Each Contributor hereby grants You a world-wide, royalty-free,
|
|
non-exclusive license:
|
|
|
|
* **(a)** under intellectual property rights (other than patent or trademark)
|
|
Licensable by such Contributor to use, reproduce, make available,
|
|
modify, display, perform, distribute, and otherwise exploit its
|
|
Contributions, either on an unmodified basis, with Modifications, or
|
|
as part of a Larger Work; and
|
|
* **(b)** under Patent Claims of such Contributor to make, use, sell, offer
|
|
for sale, have made, import, and otherwise transfer either its
|
|
Contributions or its Contributor Version.
|
|
|
|
#### 2.2. Effective Date
|
|
|
|
The licenses granted in Section 2.1 with respect to any Contribution
|
|
become effective for each Contribution on the date the Contributor first
|
|
distributes such Contribution.
|
|
|
|
#### 2.3. Limitations on Grant Scope
|
|
|
|
The licenses granted in this Section 2 are the only rights granted under
|
|
this License. No additional rights or licenses will be implied from the
|
|
distribution or licensing of Covered Software under this License.
|
|
Notwithstanding Section 2.1(b) above, no patent license is granted by a
|
|
Contributor:
|
|
|
|
* **(a)** for any code that a Contributor has removed from Covered Software;
|
|
or
|
|
* **(b)** for infringements caused by: **(i)** Your and any other third party's
|
|
modifications of Covered Software, or **(ii)** the combination of its
|
|
Contributions with other software (except as part of its Contributor
|
|
Version); or
|
|
* **(c)** under Patent Claims infringed by Covered Software in the absence of
|
|
its Contributions.
|
|
|
|
This License does not grant any rights in the trademarks, service marks,
|
|
or logos of any Contributor (except as may be necessary to comply with
|
|
the notice requirements in Section 3.4).
|
|
|
|
#### 2.4. Subsequent Licenses
|
|
|
|
No Contributor makes additional grants as a result of Your choice to
|
|
distribute the Covered Software under a subsequent version of this
|
|
License (see Section 10.2) or under the terms of a Secondary License (if
|
|
permitted under the terms of Section 3.3).
|
|
|
|
#### 2.5. Representation
|
|
|
|
Each Contributor represents that the Contributor believes its
|
|
Contributions are its original creation(s) or it has sufficient rights
|
|
to grant the rights to its Contributions conveyed by this License.
|
|
|
|
#### 2.6. Fair Use
|
|
|
|
This License is not intended to limit any rights You have under
|
|
applicable copyright doctrines of fair use, fair dealing, or other
|
|
equivalents.
|
|
|
|
#### 2.7. Conditions
|
|
|
|
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
|
|
in Section 2.1.
|
|
|
|
|
|
### 3. Responsibilities
|
|
|
|
#### 3.1. Distribution of Source Form
|
|
|
|
All distribution of Covered Software in Source Code Form, including any
|
|
Modifications that You create or to which You contribute, must be under
|
|
the terms of this License. You must inform recipients that the Source
|
|
Code Form of the Covered Software is governed by the terms of this
|
|
License, and how they can obtain a copy of this License. You may not
|
|
attempt to alter or restrict the recipients' rights in the Source Code
|
|
Form.
|
|
|
|
#### 3.2. Distribution of Executable Form
|
|
|
|
If You distribute Covered Software in Executable Form then:
|
|
|
|
* **(a)** such Covered Software must also be made available in Source Code
|
|
Form, as described in Section 3.1, and You must inform recipients of
|
|
the Executable Form how they can obtain a copy of such Source Code
|
|
Form by reasonable means in a timely manner, at a charge no more
|
|
than the cost of distribution to the recipient; and
|
|
|
|
* **(b)** You may distribute such Executable Form under the terms of this
|
|
License, or sublicense it under different terms, provided that the
|
|
license for the Executable Form does not attempt to limit or alter
|
|
the recipients' rights in the Source Code Form under this License.
|
|
|
|
#### 3.3. Distribution of a Larger Work
|
|
|
|
You may create and distribute a Larger Work under terms of Your choice,
|
|
provided that You also comply with the requirements of this License for
|
|
the Covered Software. If the Larger Work is a combination of Covered
|
|
Software with a work governed by one or more Secondary Licenses, and the
|
|
Covered Software is not Incompatible With Secondary Licenses, this
|
|
License permits You to additionally distribute such Covered Software
|
|
under the terms of such Secondary License(s), so that the recipient of
|
|
the Larger Work may, at their option, further distribute the Covered
|
|
Software under the terms of either this License or such Secondary
|
|
License(s).
|
|
|
|
#### 3.4. Notices
|
|
|
|
You may not remove or alter the substance of any license notices
|
|
(including copyright notices, patent notices, disclaimers of warranty,
|
|
or limitations of liability) contained within the Source Code Form of
|
|
the Covered Software, except that You may alter any license notices to
|
|
the extent required to remedy known factual inaccuracies.
|
|
|
|
#### 3.5. Application of Additional Terms
|
|
|
|
You may choose to offer, and to charge a fee for, warranty, support,
|
|
indemnity or liability obligations to one or more recipients of Covered
|
|
Software. However, You may do so only on Your own behalf, and not on
|
|
behalf of any Contributor. You must make it absolutely clear that any
|
|
such warranty, support, indemnity, or liability obligation is offered by
|
|
You alone, and You hereby agree to indemnify every Contributor for any
|
|
liability incurred by such Contributor as a result of warranty, support,
|
|
indemnity or liability terms You offer. You may include additional
|
|
disclaimers of warranty and limitations of liability specific to any
|
|
jurisdiction.
|
|
|
|
|
|
### 4. Inability to Comply Due to Statute or Regulation
|
|
|
|
If it is impossible for You to comply with any of the terms of this
|
|
License with respect to some or all of the Covered Software due to
|
|
statute, judicial order, or regulation then You must: **(a)** comply with
|
|
the terms of this License to the maximum extent possible; and **(b)**
|
|
describe the limitations and the code they affect. Such description must
|
|
be placed in a text file included with all distributions of the Covered
|
|
Software under this License. Except to the extent prohibited by statute
|
|
or regulation, such description must be sufficiently detailed for a
|
|
recipient of ordinary skill to be able to understand it.
|
|
|
|
|
|
### 5. Termination
|
|
|
|
**5.1.** The rights granted under this License will terminate automatically
|
|
if You fail to comply with any of its terms. However, if You become
|
|
compliant, then the rights granted under this License from a particular
|
|
Contributor are reinstated **(a)** provisionally, unless and until such
|
|
Contributor explicitly and finally terminates Your grants, and **(b)** on an
|
|
ongoing basis, if such Contributor fails to notify You of the
|
|
non-compliance by some reasonable means prior to 60 days after You have
|
|
come back into compliance. Moreover, Your grants from a particular
|
|
Contributor are reinstated on an ongoing basis if such Contributor
|
|
notifies You of the non-compliance by some reasonable means, this is the
|
|
first time You have received notice of non-compliance with this License
|
|
from such Contributor, and You become compliant prior to 30 days after
|
|
Your receipt of the notice.
|
|
|
|
**5.2.** If You initiate litigation against any entity by asserting a patent
|
|
infringement claim (excluding declaratory judgment actions,
|
|
counter-claims, and cross-claims) alleging that a Contributor Version
|
|
directly or indirectly infringes any patent, then the rights granted to
|
|
You by any and all Contributors for the Covered Software under Section
|
|
2.1 of this License shall terminate.
|
|
|
|
**5.3.** In the event of termination under Sections 5.1 or 5.2 above, all
|
|
end user license agreements (excluding distributors and resellers) which
|
|
have been validly granted by You or Your distributors under this License
|
|
prior to termination shall survive termination.
|
|
|
|
|
|
### 6. Disclaimer of Warranty
|
|
|
|
> Covered Software is provided under this License on an “as is”
|
|
> basis, without warranty of any kind, either expressed, implied, or
|
|
> statutory, including, without limitation, warranties that the
|
|
> Covered Software is free of defects, merchantable, fit for a
|
|
> particular purpose or non-infringing. The entire risk as to the
|
|
> quality and performance of the Covered Software is with You.
|
|
> Should any Covered Software prove defective in any respect, You
|
|
> (not any Contributor) assume the cost of any necessary servicing,
|
|
> repair, or correction. This disclaimer of warranty constitutes an
|
|
> essential part of this License. No use of any Covered Software is
|
|
> authorized under this License except under this disclaimer.
|
|
|
|
### 7. Limitation of Liability
|
|
|
|
> Under no circumstances and under no legal theory, whether tort
|
|
> (including negligence), contract, or otherwise, shall any
|
|
> Contributor, or anyone who distributes Covered Software as
|
|
> permitted above, be liable to You for any direct, indirect,
|
|
> special, incidental, or consequential damages of any character
|
|
> including, without limitation, damages for lost profits, loss of
|
|
> goodwill, work stoppage, computer failure or malfunction, or any
|
|
> and all other commercial damages or losses, even if such party
|
|
> shall have been informed of the possibility of such damages. This
|
|
> limitation of liability shall not apply to liability for death or
|
|
> personal injury resulting from such party's negligence to the
|
|
> extent applicable law prohibits such limitation. Some
|
|
> jurisdictions do not allow the exclusion or limitation of
|
|
> incidental or consequential damages, so this exclusion and
|
|
> limitation may not apply to You.
|
|
|
|
|
|
### 8. Litigation
|
|
|
|
Any litigation relating to this License may be brought only in the
|
|
courts of a jurisdiction where the defendant maintains its principal
|
|
place of business and such litigation shall be governed by laws of that
|
|
jurisdiction, without reference to its conflict-of-law provisions.
|
|
Nothing in this Section shall prevent a party's ability to bring
|
|
cross-claims or counter-claims.
|
|
|
|
|
|
### 9. Miscellaneous
|
|
|
|
This License represents the complete agreement concerning the subject
|
|
matter hereof. If any provision of this License is held to be
|
|
unenforceable, such provision shall be reformed only to the extent
|
|
necessary to make it enforceable. Any law or regulation which provides
|
|
that the language of a contract shall be construed against the drafter
|
|
shall not be used to construe this License against a Contributor.
|
|
|
|
|
|
### 10. Versions of the License
|
|
|
|
#### 10.1. New Versions
|
|
|
|
Mozilla Foundation is the license steward. Except as provided in Section
|
|
10.3, no one other than the license steward has the right to modify or
|
|
publish new versions of this License. Each version will be given a
|
|
distinguishing version number.
|
|
|
|
#### 10.2. Effect of New Versions
|
|
|
|
You may distribute the Covered Software under the terms of the version
|
|
of the License under which You originally received the Covered Software,
|
|
or under the terms of any subsequent version published by the license
|
|
steward.
|
|
|
|
#### 10.3. Modified Versions
|
|
|
|
If you create software not governed by this License, and you want to
|
|
create a new license for such software, you may create and use a
|
|
modified version of this License if you rename the license and remove
|
|
any references to the name of the license steward (except to note that
|
|
such modified license differs from this License).
|
|
|
|
#### 10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses
|
|
|
|
If You choose to distribute Source Code Form that is Incompatible With
|
|
Secondary Licenses under the terms of this version of the License, the
|
|
notice described in Exhibit B of this License must be attached.
|
|
|
|
## Exhibit A - Source Code Form License Notice
|
|
|
|
This Source Code Form is subject to the terms of the Mozilla Public
|
|
License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
|
|
If it is not possible or desirable to put the notice in a particular
|
|
file, then You may include the notice in a location (such as a LICENSE
|
|
file in a relevant directory) where a recipient would be likely to look
|
|
for such a notice.
|
|
|
|
You may add additional accurate notices of copyright ownership.
|
|
|
|
## Exhibit B - “Incompatible With Secondary Licenses” Notice
|
|
|
|
This Source Code Form is "Incompatible With Secondary Licenses", as
|
|
defined by the Mozilla Public License, v. 2.0.
|
|
|
|
*/
|
|
|
|
(function(){
|
|
// Based on
|
|
// https://github.com/status-im/status-react/blob/f9fb4d6974138a276b0cdcc6e4ea1611063e70ca/resources/js/provider.js
|
|
if(typeof EthereumProvider === "undefined"){
|
|
let callbackId = 0;
|
|
let callbacks = {};
|
|
|
|
const onMessage = function(message){
|
|
try {
|
|
const data = JSON.parse(message);
|
|
const id = data.messageId;
|
|
const callback = callbacks[id];
|
|
|
|
if(data.type === "web3-disconnect-account") {
|
|
window.statusAppcurrentAccountAddress = "";
|
|
window.ethereum.emit("accountsChanged", []);
|
|
return;
|
|
}
|
|
|
|
if (callback) {
|
|
if (data.type === "api-response") {
|
|
if (data.permission == "qr-code") {
|
|
qrCodeResponse(data, callback); // TODO: are we going to support the qr-code permission?
|
|
} else if (data.isAllowed) {
|
|
if (data.permission == "web3") {
|
|
window.statusAppcurrentAccountAddress = data.data[0];
|
|
}
|
|
callback.resolve(data.data);
|
|
} else {
|
|
callback.reject(new UserRejectedRequest());
|
|
}
|
|
} else if (data.type === "web3-send-async-callback") {
|
|
if (callback.beta) {
|
|
if (data.error) {
|
|
if (data.error.code == 4100) {
|
|
callback.reject(new Unauthorized());
|
|
} else {
|
|
callback.reject(data.error);
|
|
}
|
|
} else {
|
|
callback.resolve(data.result.result);
|
|
}
|
|
} else if (callback.results) {
|
|
callback.results.push(data.error || data.result);
|
|
if (callback.results.length == callback.num)
|
|
callback.callback(undefined, callback.results);
|
|
} else {
|
|
callback.callback(data.error, data.result);
|
|
}
|
|
}
|
|
}
|
|
} catch(e) {
|
|
console.error(e)
|
|
}
|
|
}
|
|
|
|
let backend;
|
|
new QWebChannel(qt.webChannelTransport, function(channel) {
|
|
backend = channel.objects.backend;
|
|
backend.web3Response.connect(onMessage);
|
|
|
|
window.ethereum.on("connected", () => {}); // TODO: Dummy event. Will need to be replaced once connecte/disconnected provider logic is implemented in status-go
|
|
window.ethereum.emit("connected", {"chainId": backend.networkId.toString()});
|
|
window.ethereum.on("accountsChanged", () => {});
|
|
});
|
|
|
|
const bridgeSend = data => {
|
|
data.hostname = new URL(document.location).host;
|
|
data.title = document.title;
|
|
backend.postMessage(JSON.stringify(data));
|
|
}
|
|
|
|
let history = window.history;
|
|
let pushState = history.pushState;
|
|
history.pushState = function(state) {
|
|
setTimeout(function () {
|
|
bridgeSend({
|
|
type: "history-state-changed",
|
|
navState: { url: location.href, title: document.title },
|
|
});
|
|
}, 100);
|
|
return pushState.apply(history, arguments);
|
|
};
|
|
|
|
function sendAPIrequest(permission, params) {
|
|
const messageId = callbackId++;
|
|
params = params || {};
|
|
|
|
bridgeSend({
|
|
type: 'api-request',
|
|
permission: permission,
|
|
messageId: messageId,
|
|
params: params
|
|
});
|
|
|
|
return new Promise(function (resolve, reject) {
|
|
params['resolve'] = resolve;
|
|
params['reject'] = reject;
|
|
callbacks[messageId] = params;
|
|
});
|
|
}
|
|
|
|
function qrCodeResponse(data, callback){
|
|
const result = data.data;
|
|
const regex = new RegExp(callback.regex);
|
|
if (!result) {
|
|
if (callback.reject) {
|
|
callback.reject(new Error("Cancelled"));
|
|
}
|
|
} else if (regex.test(result)) {
|
|
if (callback.resolve) {
|
|
callback.resolve(result);
|
|
}
|
|
} else {
|
|
if (callback.reject) {
|
|
callback.reject(new Error("Doesn't match"));
|
|
}
|
|
}
|
|
}
|
|
|
|
function Unauthorized() {
|
|
this.name = "Unauthorized";
|
|
this.id = 4100;
|
|
this.code = 4100;
|
|
this.message = "The requested method and/or account has not been authorized by the user.";
|
|
}
|
|
Unauthorized.prototype = Object.create(Error.prototype);
|
|
|
|
function UserRejectedRequest() {
|
|
this.name = "UserRejectedRequest";
|
|
this.id = 4001;
|
|
this.code = 4001;
|
|
this.message = "The user rejected the request.";
|
|
}
|
|
UserRejectedRequest.prototype = Object.create(Error.prototype);
|
|
|
|
function UnsupportedMethod() {
|
|
this.name = "Unsupported Method";
|
|
this.id = 4200;
|
|
this.code = 4200;
|
|
this.message = "The Provider does not support the requested method.";
|
|
}
|
|
UnsupportedMethod.prototype = Object.create(Error.prototype);
|
|
|
|
function Disconnected() {
|
|
this.name = "Disconnected";
|
|
this.id = 4900;
|
|
this.code = 4900;
|
|
this.message = "The Provider is disconnected from all chains.";
|
|
}
|
|
Disconnected.prototype = Object.create(Error.prototype);
|
|
|
|
//
|
|
function ChainDisconnected() {
|
|
this.name = "Chain Disconnected";
|
|
this.id = 4901;
|
|
this.code = 4901;
|
|
this.message = "The Provider is not connected to the requested chain.";
|
|
}
|
|
ChainDisconnected.prototype = Object.create(ChainDisconnected.prototype);
|
|
|
|
|
|
// NOTE: chainChanged is not implemented because we do not support switching networks without disconnecting from Status
|
|
// Provider.on('chainChanged', listener: (chainId: string) => void): Provider;
|
|
|
|
function web3Response (payload, result){
|
|
return {
|
|
id: payload.id,
|
|
jsonrpc: "2.0",
|
|
result: result
|
|
};
|
|
}
|
|
|
|
function getSyncResponse (payload) {
|
|
if (payload.method == "eth_accounts" && (typeof window.statusAppcurrentAccountAddress !== "undefined")) {
|
|
return web3Response(payload, [window.statusAppcurrentAccountAddress])
|
|
} else if (payload.method == "eth_coinbase" && (typeof window.statusAppcurrentAccountAddress !== "undefined")) {
|
|
return web3Response(payload, window.statusAppcurrentAccountAddress)
|
|
} else if (payload.method == "net_version" || payload.method == "eth_chainId"){
|
|
return web3Response(payload, backend.networkId.toString())
|
|
} else if (payload.method == "eth_uninstallFilter"){
|
|
return web3Response(payload, true);
|
|
} else {
|
|
return null;
|
|
}
|
|
}
|
|
|
|
var StatusAPI = function () {};
|
|
|
|
StatusAPI.prototype.getContactCode = function () {
|
|
return sendAPIrequest('contact-code');
|
|
};
|
|
|
|
var EthereumProvider = function () {};
|
|
|
|
EthereumProvider.prototype.isStatus = true;
|
|
EthereumProvider.prototype.status = new StatusAPI();
|
|
EthereumProvider.prototype.isConnected = function () { return true; };
|
|
EthereumProvider.prototype._events = {};
|
|
|
|
EthereumProvider.prototype.on = function(name, listener) {
|
|
if (!this._events[name]) {
|
|
this._events[name] = [];
|
|
}
|
|
this._events[name].push(listener);
|
|
}
|
|
|
|
EthereumProvider.prototype.removeListener = function (name, listenerToRemove) {
|
|
if (!this._events[name]) throw new Error(`event "${name}" does not exist`);
|
|
const filterListeners = (listener) => listener !== listenerToRemove;
|
|
this._events[name] = this._events[name].filter(filterListeners);
|
|
}
|
|
|
|
EthereumProvider.prototype.emit = function (name, data) {
|
|
if (!this._events[name]) throw new Error(`event "${name}" does not exist`);
|
|
this._events[name].forEach(cb => cb(data));
|
|
}
|
|
|
|
EthereumProvider.prototype.enable = function () {
|
|
return sendAPIrequest('web3');
|
|
};
|
|
|
|
EthereumProvider.prototype.scanQRCode = function (regex) {
|
|
return sendAPIrequest('qr-code', {regex: regex});
|
|
};
|
|
|
|
EthereumProvider.prototype.request = function (requestArguments) {
|
|
if (!requestArguments) return new Error("Request is not valid.");
|
|
|
|
const method = requestArguments.method;
|
|
|
|
if (!method) return new Error("Request is not valid.");
|
|
|
|
//Support for legacy send method
|
|
if (typeof method !== "string") return this.sendSync(method);
|
|
|
|
if (method == "eth_requestAccounts") return sendAPIrequest("web3");
|
|
|
|
const syncResponse = getSyncResponse({ method: method });
|
|
if (syncResponse) {
|
|
return new Promise(function (resolve, reject) {
|
|
resolve(syncResponse.result);
|
|
});
|
|
}
|
|
|
|
const messageId = callbackId++;
|
|
const payload = {
|
|
id: messageId,
|
|
jsonrpc: "2.0",
|
|
method: method,
|
|
params: requestArguments.params,
|
|
};
|
|
|
|
bridgeSend({
|
|
type: "web3-send-async-read-only",
|
|
messageId: messageId,
|
|
payload: payload,
|
|
});
|
|
|
|
return new Promise(function (resolve, reject) {
|
|
callbacks[messageId] = {
|
|
beta: true,
|
|
resolve: resolve,
|
|
reject: reject,
|
|
};
|
|
});
|
|
};
|
|
|
|
// (DEPRECATED) Support for legacy send method
|
|
EthereumProvider.prototype.send = function (method, params = []) {
|
|
return this.request({method: method, params: params});
|
|
}
|
|
|
|
// (DEPRECATED) Support for legacy sendSync method
|
|
EthereumProvider.prototype.sendSync = function (payload) {
|
|
if (payload.method == "eth_uninstallFilter") {
|
|
this.sendAsync(payload, function (res, err) {});
|
|
}
|
|
const syncResponse = getSyncResponse(payload);
|
|
if (syncResponse) return syncResponse;
|
|
|
|
return web3Response(payload, null);
|
|
};
|
|
|
|
// (DEPRECATED) Support for legacy sendAsync method
|
|
EthereumProvider.prototype.sendAsync = function (payload, callback) {
|
|
const syncResponse = getSyncResponse(payload);
|
|
if (syncResponse && callback) {
|
|
callback(null, syncResponse);
|
|
} else {
|
|
const messageId = callbackId++;
|
|
|
|
if (Array.isArray(payload)) {
|
|
callbacks[messageId] = {
|
|
num: payload.length,
|
|
results: [],
|
|
callback: callback,
|
|
};
|
|
|
|
for (let i in payload) {
|
|
bridgeSend({
|
|
type: "web3-send-async-read-only",
|
|
messageId: messageId,
|
|
payload: payload[i],
|
|
});
|
|
}
|
|
} else {
|
|
callbacks[messageId] = { callback: callback };
|
|
bridgeSend({
|
|
type: "web3-send-async-read-only",
|
|
messageId: messageId,
|
|
payload: payload,
|
|
});
|
|
}
|
|
}
|
|
};
|
|
}
|
|
|
|
window.ethereum = new EthereumProvider();
|
|
|
|
// TODO: connected/disconnected must be emitted if we lose connection to infura. Verify if status-go emits events for that
|
|
|
|
})(); |