Bläddra i källkod

Add JSONRPC-2.0 implementation as a module

geequlim 6 år sedan
förälder
incheckning
61ed6efa5b

+ 7 - 0
modules/jsonrpc/SCsub

@@ -0,0 +1,7 @@
+#!/usr/bin/env python
+
+Import('env')
+Import('env_modules')
+
+env_jsonrpc = env_modules.Clone()
+env_jsonrpc.add_source_files(env.modules_sources, "*.cpp")

+ 5 - 0
modules/jsonrpc/config.py

@@ -0,0 +1,5 @@
+def can_build(env, platform):
+	return True
+
+def configure(env):
+	pass

+ 171 - 0
modules/jsonrpc/jsonrpc.cpp

@@ -0,0 +1,171 @@
+/*************************************************************************/
+/*  jsonrpc.cpp                                                          */
+/*************************************************************************/
+/*                       This file is part of:                           */
+/*                           GODOT ENGINE                                */
+/*                      https://godotengine.org                          */
+/*************************************************************************/
+/* Copyright (c) 2007-2019 Juan Linietsky, Ariel Manzur.                 */
+/* Copyright (c) 2014-2019 Godot Engine contributors (cf. AUTHORS.md)    */
+/*                                                                       */
+/* Permission is hereby granted, free of charge, to any person obtaining */
+/* a copy of this software and associated documentation files (the       */
+/* "Software"), to deal in the Software without restriction, including   */
+/* without limitation the rights to use, copy, modify, merge, publish,   */
+/* distribute, sublicense, and/or sell copies of the Software, and to    */
+/* permit persons to whom the Software is furnished to do so, subject to */
+/* the following conditions:                                             */
+/*                                                                       */
+/* The above copyright notice and this permission notice shall be        */
+/* included in all copies or substantial portions of the Software.       */
+/*                                                                       */
+/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,       */
+/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF    */
+/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
+/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY  */
+/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,  */
+/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE     */
+/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                */
+/*************************************************************************/
+
+#include "jsonrpc.h"
+#include "core/io/json.h"
+
+JSONRPC::JSONRPC() {
+}
+
+JSONRPC::~JSONRPC() {
+}
+
+void JSONRPC::_bind_methods() {
+	ClassDB::bind_method(D_METHOD("set_scope", "scope", "target"), &JSONRPC::set_scope);
+	ClassDB::bind_method(D_METHOD("process_action", "action", "recurse"), &JSONRPC::process_action, DEFVAL(false));
+	ClassDB::bind_method(D_METHOD("process_string", "action"), &JSONRPC::process_string);
+
+	ClassDB::bind_method(D_METHOD("make_request", "method", "params", "id"), &JSONRPC::make_request);
+	ClassDB::bind_method(D_METHOD("make_response", "result", "id"), &JSONRPC::make_response);
+	ClassDB::bind_method(D_METHOD("make_notification", "method", "params"), &JSONRPC::make_notification);
+	ClassDB::bind_method(D_METHOD("make_response_error", "code", "message", "id"), &JSONRPC::make_response_error, DEFVAL(Variant()));
+
+	BIND_ENUM_CONSTANT(ParseError)
+	BIND_ENUM_CONSTANT(InvalidRequest)
+	BIND_ENUM_CONSTANT(MethodNotFound)
+	BIND_ENUM_CONSTANT(InvalidParams)
+	BIND_ENUM_CONSTANT(InternalError)
+}
+
+Dictionary JSONRPC::make_response_error(int p_code, const String &p_message, const Variant &p_id) const {
+	Dictionary dict;
+	dict["jsonrpc"] = "2.0";
+
+	Dictionary err;
+	err["code"] = p_code;
+	err["message"] = p_message;
+
+	dict["error"] = err;
+	dict["id"] = p_id;
+
+	return dict;
+}
+
+Dictionary JSONRPC::make_response(const Variant &p_value, const Variant &p_id) {
+	Dictionary dict;
+	dict["jsonrpc"] = "2.0";
+	dict["id"] = p_id;
+	dict["result"] = p_value;
+	return dict;
+}
+
+Dictionary JSONRPC::make_notification(const String &p_method, const Variant &p_params) {
+	Dictionary dict;
+	dict["jsonrpc"] = "2.0";
+	dict["method"] = p_method;
+	dict["params"] = p_params;
+	return dict;
+}
+
+Dictionary JSONRPC::make_request(const String &p_method, const Variant &p_params, const Variant &p_id) {
+	Dictionary dict;
+	dict["jsonrpc"] = "2.0";
+	dict["method"] = p_method;
+	dict["params"] = p_params;
+	dict["id"] = p_id;
+	return dict;
+}
+
+Variant JSONRPC::process_action(const Variant &p_action, bool p_process_arr_elements) {
+	Variant ret;
+	if (p_action.get_type() == Variant::DICTIONARY) {
+		Dictionary dict = p_action;
+		String method = dict.get("method", "");
+		Array args;
+		if (dict.has("params")) {
+			Variant params = dict.get("params", Variant());
+			if (params.get_type() == Variant::ARRAY) {
+				args = params;
+			} else {
+				args.push_back(params);
+			}
+		}
+
+		Object *object = this;
+		if (method_scopes.has(method.get_base_dir())) {
+			object = method_scopes[method.get_base_dir()];
+			method = method.get_file();
+		}
+
+		Variant id;
+		if (dict.has("id")) {
+			id = dict["id"];
+		}
+
+		if (object == NULL || !object->has_method(method)) {
+			ret = make_response_error(JSONRPC::MethodNotFound, "Method not found", id);
+		} else {
+			Variant call_ret = object->callv(method, args);
+			if (id.get_type() != Variant::NIL) {
+				ret = make_response(call_ret, id);
+			}
+		}
+	} else if (p_action.get_type() == Variant::ARRAY && p_process_arr_elements) {
+		Array arr = p_action;
+		int size = arr.size();
+		if (size) {
+			Array arr_ret;
+			for (int i = 0; i < size; i++) {
+				const Variant &var = arr.get(i);
+				arr_ret.push_back(process_action(var));
+			}
+			ret = arr_ret;
+		} else {
+			ret = make_response_error(JSONRPC::InvalidRequest, "Invalid Request");
+		}
+	} else {
+		ret = make_response_error(JSONRPC::InvalidRequest, "Invalid Request");
+	}
+	return ret;
+}
+
+String JSONRPC::process_string(const String &p_input) {
+
+	if (p_input.empty()) return String();
+
+	Variant ret;
+	Variant input;
+	String err_message;
+	int err_line;
+	if (OK != JSON::parse(p_input, input, err_message, err_line)) {
+		ret = make_response_error(JSONRPC::ParseError, "Parse error");
+	} else {
+		ret = process_action(input, true);
+	}
+
+	if (ret.get_type() == Variant::NIL) {
+		return "";
+	}
+	return JSON::print(ret);
+}
+
+void JSONRPC::set_scope(const String &p_scope, Object *p_obj) {
+	method_scopes[p_scope] = p_obj;
+}

+ 70 - 0
modules/jsonrpc/jsonrpc.h

@@ -0,0 +1,70 @@
+/*************************************************************************/
+/*  jsonrpc.h                                                            */
+/*************************************************************************/
+/*                       This file is part of:                           */
+/*                           GODOT ENGINE                                */
+/*                      https://godotengine.org                          */
+/*************************************************************************/
+/* Copyright (c) 2007-2019 Juan Linietsky, Ariel Manzur.                 */
+/* Copyright (c) 2014-2019 Godot Engine contributors (cf. AUTHORS.md)    */
+/*                                                                       */
+/* Permission is hereby granted, free of charge, to any person obtaining */
+/* a copy of this software and associated documentation files (the       */
+/* "Software"), to deal in the Software without restriction, including   */
+/* without limitation the rights to use, copy, modify, merge, publish,   */
+/* distribute, sublicense, and/or sell copies of the Software, and to    */
+/* permit persons to whom the Software is furnished to do so, subject to */
+/* the following conditions:                                             */
+/*                                                                       */
+/* The above copyright notice and this permission notice shall be        */
+/* included in all copies or substantial portions of the Software.       */
+/*                                                                       */
+/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,       */
+/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF    */
+/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
+/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY  */
+/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,  */
+/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE     */
+/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                */
+/*************************************************************************/
+
+#ifndef GODOT_JSON_RPC_H
+#define GODOT_JSON_RPC_H
+
+#include "core/object.h"
+#include "core/variant.h"
+
+class JSONRPC : public Object {
+	GDCLASS(JSONRPC, Object)
+
+	Map<String, Object *> method_scopes;
+
+protected:
+	static void _bind_methods();
+
+public:
+	JSONRPC();
+	~JSONRPC();
+
+	enum ErrorCode {
+		ParseError = -32700,
+		InvalidRequest = -32600,
+		MethodNotFound = -32601,
+		InvalidParams = -32602,
+		InternalError = -32603,
+	};
+
+	Dictionary make_response_error(int p_code, const String &p_message, const Variant &p_id = Variant()) const;
+	Dictionary make_response(const Variant &p_value, const Variant &p_id);
+	Dictionary make_notification(const String &p_method, const Variant &p_params);
+	Dictionary make_request(const String &p_method, const Variant &p_params, const Variant &p_id);
+
+	Variant process_action(const Variant &p_action, bool p_process_arr_elements = false);
+	String process_string(const String &p_input);
+
+	void set_scope(const String &p_scope, Object *p_obj);
+};
+
+VARIANT_ENUM_CAST(JSONRPC::ErrorCode);
+
+#endif

+ 40 - 0
modules/jsonrpc/register_types.cpp

@@ -0,0 +1,40 @@
+/*************************************************************************/
+/*  register_types.cpp                                                   */
+/*************************************************************************/
+/*                       This file is part of:                           */
+/*                           GODOT ENGINE                                */
+/*                      https://godotengine.org                          */
+/*************************************************************************/
+/* Copyright (c) 2007-2019 Juan Linietsky, Ariel Manzur.                 */
+/* Copyright (c) 2014-2019 Godot Engine contributors (cf. AUTHORS.md)    */
+/*                                                                       */
+/* Permission is hereby granted, free of charge, to any person obtaining */
+/* a copy of this software and associated documentation files (the       */
+/* "Software"), to deal in the Software without restriction, including   */
+/* without limitation the rights to use, copy, modify, merge, publish,   */
+/* distribute, sublicense, and/or sell copies of the Software, and to    */
+/* permit persons to whom the Software is furnished to do so, subject to */
+/* the following conditions:                                             */
+/*                                                                       */
+/* The above copyright notice and this permission notice shall be        */
+/* included in all copies or substantial portions of the Software.       */
+/*                                                                       */
+/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,       */
+/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF    */
+/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
+/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY  */
+/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,  */
+/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE     */
+/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                */
+/*************************************************************************/
+
+#include "register_types.h"
+#include "core/class_db.h"
+#include "jsonrpc.h"
+
+void register_jsonrpc_types() {
+	ClassDB::register_class<JSONRPC>();
+}
+
+void unregister_jsonrpc_types() {
+}

+ 32 - 0
modules/jsonrpc/register_types.h

@@ -0,0 +1,32 @@
+/*************************************************************************/
+/*  register_types.h                                                     */
+/*************************************************************************/
+/*                       This file is part of:                           */
+/*                           GODOT ENGINE                                */
+/*                      https://godotengine.org                          */
+/*************************************************************************/
+/* Copyright (c) 2007-2019 Juan Linietsky, Ariel Manzur.                 */
+/* Copyright (c) 2014-2019 Godot Engine contributors (cf. AUTHORS.md)    */
+/*                                                                       */
+/* Permission is hereby granted, free of charge, to any person obtaining */
+/* a copy of this software and associated documentation files (the       */
+/* "Software"), to deal in the Software without restriction, including   */
+/* without limitation the rights to use, copy, modify, merge, publish,   */
+/* distribute, sublicense, and/or sell copies of the Software, and to    */
+/* permit persons to whom the Software is furnished to do so, subject to */
+/* the following conditions:                                             */
+/*                                                                       */
+/* The above copyright notice and this permission notice shall be        */
+/* included in all copies or substantial portions of the Software.       */
+/*                                                                       */
+/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,       */
+/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF    */
+/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
+/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY  */
+/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,  */
+/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE     */
+/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                */
+/*************************************************************************/
+
+void register_jsonrpc_types();
+void unregister_jsonrpc_types();