123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408 |
- /*
- * Copyright (C) 2011 Google Inc. All rights reserved.
- *
- * 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 Google Inc. 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.
- */
- /**
- * @constructor
- */
- function InspectorBackendClass()
- {
- this._lastCallbackId = 1;
- this._pendingResponsesCount = 0;
- this._callbacks = {};
- this._domainDispatchers = {};
- this._eventArgs = {};
- this._replyArgs = {};
- this._hasErrorData = {};
- this.dumpInspectorTimeStats = false;
- this.dumpInspectorProtocolMessages = false;
- this._initialized = false;
- }
- InspectorBackendClass.prototype = {
- /**
- * @return {number}
- */
- nextCallbackId: function()
- {
- return this._lastCallbackId++;
- },
- _wrap: function(callback, method)
- {
- var callbackId = this.nextCallbackId();
- if (!callback)
- callback = function() {};
- this._callbacks[callbackId] = callback;
- callback.methodName = method;
- if (this.dumpInspectorTimeStats)
- callback.sendRequestTime = Date.now();
- return callbackId;
- },
- _getAgent: function(domain)
- {
- var agentName = domain + "Agent";
- if (!window[agentName])
- window[agentName] = {};
- return window[agentName];
- },
- registerCommand: function(method, signature, replyArgs, hasErrorData)
- {
- var domainAndMethod = method.split(".");
- var agent = this._getAgent(domainAndMethod[0]);
- agent[domainAndMethod[1]] = this._sendMessageToBackend.bind(this, method, signature);
- agent[domainAndMethod[1]]["invoke"] = this._invoke.bind(this, method, signature);
- this._replyArgs[method] = replyArgs;
- if (hasErrorData)
- this._hasErrorData[method] = true;
- this._initialized = true;
- },
- registerEnum: function(type, values)
- {
- var domainAndMethod = type.split(".");
- var agent = this._getAgent(domainAndMethod[0]);
- agent[domainAndMethod[1]] = values;
- this._initialized = true;
- },
- registerEvent: function(eventName, params)
- {
- this._eventArgs[eventName] = params;
- this._initialized = true;
- },
- _invoke: function(method, signature, args, callback)
- {
- this._wrapCallbackAndSendMessageObject(method, args, callback);
- },
- _sendMessageToBackend: function(method, signature, vararg)
- {
- var args = Array.prototype.slice.call(arguments, 2);
- var callback = (args.length && typeof args[args.length - 1] === "function") ? args.pop() : null;
- var params = {};
- var hasParams = false;
- for (var i = 0; i < signature.length; ++i) {
- var param = signature[i];
- var paramName = param["name"];
- var typeName = param["type"];
- var optionalFlag = param["optional"];
- if (!args.length && !optionalFlag) {
- console.error("Protocol Error: Invalid number of arguments for method '" + method + "' call. It must have the following arguments '" + JSON.stringify(signature) + "'.");
- return;
- }
- var value = args.shift();
- if (optionalFlag && typeof value === "undefined") {
- continue;
- }
- if (typeof value !== typeName) {
- console.error("Protocol Error: Invalid type of argument '" + paramName + "' for method '" + method + "' call. It must be '" + typeName + "' but it is '" + typeof value + "'.");
- return;
- }
- params[paramName] = value;
- hasParams = true;
- }
- if (args.length === 1 && !callback) {
- if (typeof args[0] !== "undefined") {
- console.error("Protocol Error: Optional callback argument for method '" + method + "' call must be a function but its type is '" + typeof args[0] + "'.");
- return;
- }
- }
- this._wrapCallbackAndSendMessageObject(method, hasParams ? params : null, callback);
- },
- _wrapCallbackAndSendMessageObject: function(method, params, callback)
- {
- var messageObject = {};
- messageObject.method = method;
- if (params)
- messageObject.params = params;
- messageObject.id = this._wrap(callback, method);
- if (this.dumpInspectorProtocolMessages)
- console.log("frontend: " + JSON.stringify(messageObject));
- ++this._pendingResponsesCount;
- this.sendMessageObjectToBackend(messageObject);
- },
- sendMessageObjectToBackend: function(messageObject)
- {
- var message = JSON.stringify(messageObject);
- InspectorFrontendHost.sendMessageToBackend(message);
- },
- registerDomainDispatcher: function(domain, dispatcher)
- {
- this._domainDispatchers[domain] = dispatcher;
- },
- dispatch: function(message)
- {
- if (this.dumpInspectorProtocolMessages)
- console.log("backend: " + ((typeof message === "string") ? message : JSON.stringify(message)));
- var messageObject = (typeof message === "string") ? JSON.parse(message) : message;
- if ("id" in messageObject) { // just a response for some request
- if (messageObject.error) {
- if (messageObject.error.code !== -32000)
- this.reportProtocolError(messageObject);
- }
- var callback = this._callbacks[messageObject.id];
- if (callback) {
- var argumentsArray = [ null ];
- if (messageObject.error) {
- argumentsArray[0] = messageObject.error.message;
- }
- if (this._hasErrorData[callback.methodName]) {
- argumentsArray.push(null);
- if (messageObject.error)
- argumentsArray[1] = messageObject.error.data;
- }
- if (messageObject.result) {
- var paramNames = this._replyArgs[callback.methodName];
- if (paramNames) {
- for (var i = 0; i < paramNames.length; ++i)
- argumentsArray.push(messageObject.result[paramNames[i]]);
- }
- }
- var processingStartTime;
- if (this.dumpInspectorTimeStats && callback.methodName)
- processingStartTime = Date.now();
- callback.apply(null, argumentsArray);
- --this._pendingResponsesCount;
- delete this._callbacks[messageObject.id];
- if (this.dumpInspectorTimeStats && callback.methodName)
- console.log("time-stats: " + callback.methodName + " = " + (processingStartTime - callback.sendRequestTime) + " + " + (Date.now() - processingStartTime));
- }
- if (this._scripts && !this._pendingResponsesCount)
- this.runAfterPendingDispatches();
- return;
- } else {
- var method = messageObject.method.split(".");
- var domainName = method[0];
- var functionName = method[1];
- if (!(domainName in this._domainDispatchers)) {
- console.error("Protocol Error: the message is for non-existing domain '" + domainName + "'");
- return;
- }
- var dispatcher = this._domainDispatchers[domainName];
- if (!(functionName in dispatcher)) {
- console.error("Protocol Error: Attempted to dispatch an unimplemented method '" + messageObject.method + "'");
- return;
- }
- if (!this._eventArgs[messageObject.method]) {
- console.error("Protocol Error: Attempted to dispatch an unspecified method '" + messageObject.method + "'");
- return;
- }
- var params = [];
- if (messageObject.params) {
- var paramNames = this._eventArgs[messageObject.method];
- for (var i = 0; i < paramNames.length; ++i)
- params.push(messageObject.params[paramNames[i]]);
- }
- var processingStartTime;
- if (this.dumpInspectorTimeStats)
- processingStartTime = Date.now();
- dispatcher[functionName].apply(dispatcher, params);
- if (this.dumpInspectorTimeStats)
- console.log("time-stats: " + messageObject.method + " = " + (Date.now() - processingStartTime));
- }
- },
- reportProtocolError: function(messageObject)
- {
- console.error("Request with id = " + messageObject.id + " failed. " + messageObject.error);
- },
- /**
- * @param {string=} script
- */
- runAfterPendingDispatches: function(script)
- {
- if (!this._scripts)
- this._scripts = [];
- if (script)
- this._scripts.push(script);
- if (!this._pendingResponsesCount) {
- var scripts = this._scripts;
- this._scripts = []
- for (var id = 0; id < scripts.length; ++id)
- scripts[id].call(this);
- }
- },
- loadFromJSONIfNeeded: function(jsonUrl)
- {
- if (this._initialized)
- return;
- var xhr = new XMLHttpRequest();
- xhr.open("GET", jsonUrl, false);
- xhr.send(null);
- var schema = JSON.parse(xhr.responseText);
- var code = InspectorBackendClass._generateCommands(schema);
- eval(code);
- }
- }
- /**
- * @param {*} schema
- * @return {string}
- */
- InspectorBackendClass._generateCommands = function(schema) {
- var jsTypes = { integer: "number", array: "object" };
- var rawTypes = {};
- var result = [];
- var domains = schema["domains"] || [];
- for (var i = 0; i < domains.length; ++i) {
- var domain = domains[i];
- for (var j = 0; domain.types && j < domain.types.length; ++j) {
- var type = domain.types[j];
- rawTypes[domain.domain + "." + type.id] = jsTypes[type.type] || type.type;
- }
- }
- function toUpperCase(groupIndex, group0, group1)
- {
- return [group0, group1][groupIndex].toUpperCase();
- }
- function generateEnum(enumName, items)
- {
- var members = []
- for (var m = 0; m < items.length; ++m) {
- var value = items[m];
- var name = value.replace(/-(\w)/g, toUpperCase.bind(null, 1)).toTitleCase();
- name = name.replace(/HTML|XML|WML|API/ig, toUpperCase.bind(null, 0));
- members.push(name + ": \"" + value +"\"");
- }
- return "InspectorBackend.registerEnum(\"" + enumName + "\", {" + members.join(", ") + "});";
- }
- for (var i = 0; i < domains.length; ++i) {
- var domain = domains[i];
- var types = domain["types"] || [];
- for (var j = 0; j < types.length; ++j) {
- var type = types[j];
- if ((type["type"] === "string") && type["enum"])
- result.push(generateEnum(domain.domain + "." + type.id, type["enum"]));
- else if (type["type"] === "object") {
- var properties = type["properties"] || [];
- for (var k = 0; k < properties.length; ++k) {
- var property = properties[k];
- if ((property["type"] === "string") && property["enum"])
- result.push(generateEnum(domain.domain + "." + type.id + property["name"].toTitleCase(), property["enum"]));
- }
- }
- }
- var commands = domain["commands"] || [];
- for (var j = 0; j < commands.length; ++j) {
- var command = commands[j];
- var parameters = command["parameters"];
- var paramsText = [];
- for (var k = 0; parameters && k < parameters.length; ++k) {
- var parameter = parameters[k];
- var type;
- if (parameter.type)
- type = jsTypes[parameter.type] || parameter.type;
- else {
- var ref = parameter["$ref"];
- if (ref.indexOf(".") !== -1)
- type = rawTypes[ref];
- else
- type = rawTypes[domain.domain + "." + ref];
- }
- var text = "{\"name\": \"" + parameter.name + "\", \"type\": \"" + type + "\", \"optional\": " + (parameter.optional ? "true" : "false") + "}";
- paramsText.push(text);
- }
- var returnsText = [];
- var returns = command["returns"] || [];
- for (var k = 0; k < returns.length; ++k) {
- var parameter = returns[k];
- returnsText.push("\"" + parameter.name + "\"");
- }
- var hasErrorData = String(Boolean(command.error));
- result.push("InspectorBackend.registerCommand(\"" + domain.domain + "." + command.name + "\", [" + paramsText.join(", ") + "], [" + returnsText.join(", ") + "], " + hasErrorData + ");");
- }
- for (var j = 0; domain.events && j < domain.events.length; ++j) {
- var event = domain.events[j];
- var paramsText = [];
- for (var k = 0; event.parameters && k < event.parameters.length; ++k) {
- var parameter = event.parameters[k];
- paramsText.push("\"" + parameter.name + "\"");
- }
- result.push("InspectorBackend.registerEvent(\"" + domain.domain + "." + event.name + "\", [" + paramsText.join(", ") + "]);");
- }
- result.push("InspectorBackend.register" + domain.domain + "Dispatcher = InspectorBackend.registerDomainDispatcher.bind(InspectorBackend, \"" + domain.domain + "\");");
- }
- return result.join("\n");
- }
- InspectorBackend = new InspectorBackendClass();
|