e1a0ce5af9
* Add bind_ip property to WebSocketServer defaulting to "*" (listen to everyone) * Set default for GDscript Language Server to listen only to localhost Fixes potential security issue with GDScript language server being exposed to the broad net by default. Since it is the server which primary usage is to provide utility to the local editor there is no need to expose it.
236 lines
9 KiB
C++
236 lines
9 KiB
C++
/*************************************************************************/
|
|
/* gdscript_language_protocol.cpp */
|
|
/*************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/*************************************************************************/
|
|
/* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
|
|
/* Copyright (c) 2014-2020 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 "gdscript_language_protocol.h"
|
|
#include "core/io/json.h"
|
|
#include "core/os/copymem.h"
|
|
#include "core/project_settings.h"
|
|
#include "editor/editor_node.h"
|
|
|
|
GDScriptLanguageProtocol *GDScriptLanguageProtocol::singleton = NULL;
|
|
|
|
void GDScriptLanguageProtocol::on_data_received(int p_id) {
|
|
lastest_client_id = p_id;
|
|
Ref<WebSocketPeer> peer = server->get_peer(p_id);
|
|
PoolByteArray data;
|
|
if (OK == peer->get_packet_buffer(data)) {
|
|
String message;
|
|
message.parse_utf8((const char *)data.read().ptr(), data.size());
|
|
if (message.begins_with("Content-Length:")) return;
|
|
String output = process_message(message);
|
|
if (!output.empty()) {
|
|
CharString charstr = output.utf8();
|
|
peer->put_packet((const uint8_t *)charstr.ptr(), charstr.length());
|
|
}
|
|
}
|
|
}
|
|
|
|
void GDScriptLanguageProtocol::on_client_connected(int p_id, const String &p_protocal) {
|
|
clients.set(p_id, server->get_peer(p_id));
|
|
}
|
|
|
|
void GDScriptLanguageProtocol::on_client_disconnected(int p_id, bool p_was_clean_close) {
|
|
clients.erase(p_id);
|
|
}
|
|
|
|
String GDScriptLanguageProtocol::process_message(const String &p_text) {
|
|
String ret = process_string(p_text);
|
|
if (ret.empty()) {
|
|
return ret;
|
|
} else {
|
|
return format_output(ret);
|
|
}
|
|
}
|
|
|
|
String GDScriptLanguageProtocol::format_output(const String &p_text) {
|
|
|
|
String header = "Content-Length: ";
|
|
CharString charstr = p_text.utf8();
|
|
size_t len = charstr.length();
|
|
header += itos(len);
|
|
header += "\r\n\r\n";
|
|
|
|
return header + p_text;
|
|
}
|
|
|
|
void GDScriptLanguageProtocol::_bind_methods() {
|
|
ClassDB::bind_method(D_METHOD("initialize", "params"), &GDScriptLanguageProtocol::initialize);
|
|
ClassDB::bind_method(D_METHOD("initialized", "params"), &GDScriptLanguageProtocol::initialized);
|
|
ClassDB::bind_method(D_METHOD("on_data_received"), &GDScriptLanguageProtocol::on_data_received);
|
|
ClassDB::bind_method(D_METHOD("on_client_connected"), &GDScriptLanguageProtocol::on_client_connected);
|
|
ClassDB::bind_method(D_METHOD("on_client_disconnected"), &GDScriptLanguageProtocol::on_client_disconnected);
|
|
ClassDB::bind_method(D_METHOD("notify_all_clients", "p_method", "p_params"), &GDScriptLanguageProtocol::notify_all_clients, DEFVAL(Variant()));
|
|
ClassDB::bind_method(D_METHOD("notify_client", "p_method", "p_params", "p_client"), &GDScriptLanguageProtocol::notify_client, DEFVAL(Variant()), DEFVAL(-1));
|
|
ClassDB::bind_method(D_METHOD("is_smart_resolve_enabled"), &GDScriptLanguageProtocol::is_smart_resolve_enabled);
|
|
ClassDB::bind_method(D_METHOD("get_text_document"), &GDScriptLanguageProtocol::get_text_document);
|
|
ClassDB::bind_method(D_METHOD("get_workspace"), &GDScriptLanguageProtocol::get_workspace);
|
|
ClassDB::bind_method(D_METHOD("is_initialized"), &GDScriptLanguageProtocol::is_initialized);
|
|
}
|
|
|
|
Dictionary GDScriptLanguageProtocol::initialize(const Dictionary &p_params) {
|
|
|
|
lsp::InitializeResult ret;
|
|
|
|
String root_uri = p_params["rootUri"];
|
|
String root = p_params["rootPath"];
|
|
bool is_same_workspace;
|
|
#ifndef WINDOWS_ENABLED
|
|
is_same_workspace = root.to_lower() == workspace->root.to_lower();
|
|
#else
|
|
is_same_workspace = root.replace("\\", "/").to_lower() == workspace->root.to_lower();
|
|
#endif
|
|
|
|
if (root_uri.length() && is_same_workspace) {
|
|
workspace->root_uri = root_uri;
|
|
} else {
|
|
|
|
workspace->root_uri = "file://" + workspace->root;
|
|
|
|
Dictionary params;
|
|
params["path"] = workspace->root;
|
|
Dictionary request = make_notification("gdscrip_client/changeWorkspace", params);
|
|
if (Ref<WebSocketPeer> *peer = clients.getptr(lastest_client_id)) {
|
|
String msg = JSON::print(request);
|
|
msg = format_output(msg);
|
|
CharString charstr = msg.utf8();
|
|
(*peer)->put_packet((const uint8_t *)charstr.ptr(), charstr.length());
|
|
}
|
|
}
|
|
|
|
if (!_initialized) {
|
|
workspace->initialize();
|
|
text_document->initialize();
|
|
_initialized = true;
|
|
}
|
|
|
|
return ret.to_json();
|
|
}
|
|
|
|
void GDScriptLanguageProtocol::initialized(const Variant &p_params) {
|
|
|
|
lsp::GodotCapabilities capabilities;
|
|
|
|
DocData *doc = EditorHelp::get_doc_data();
|
|
for (Map<String, DocData::ClassDoc>::Element *E = doc->class_list.front(); E; E = E->next()) {
|
|
|
|
lsp::GodotNativeClassInfo gdclass;
|
|
gdclass.name = E->get().name;
|
|
gdclass.class_doc = &(E->get());
|
|
if (ClassDB::ClassInfo *ptr = ClassDB::classes.getptr(StringName(E->get().name))) {
|
|
gdclass.class_info = ptr;
|
|
}
|
|
capabilities.native_classes.push_back(gdclass);
|
|
}
|
|
|
|
notify_client("gdscript/capabilities", capabilities.to_json());
|
|
}
|
|
|
|
void GDScriptLanguageProtocol::poll() {
|
|
server->poll();
|
|
}
|
|
|
|
Error GDScriptLanguageProtocol::start(int p_port, const IP_Address &p_bind_ip) {
|
|
if (server == NULL) {
|
|
server = dynamic_cast<WebSocketServer *>(ClassDB::instance("WebSocketServer"));
|
|
ERR_FAIL_COND_V(!server, FAILED);
|
|
server->set_buffers(8192, 1024, 8192, 1024); // 8mb should be way more than enough
|
|
server->connect("data_received", this, "on_data_received");
|
|
server->connect("client_connected", this, "on_client_connected");
|
|
server->connect("client_disconnected", this, "on_client_disconnected");
|
|
}
|
|
server->set_bind_ip(p_bind_ip);
|
|
return server->listen(p_port);
|
|
}
|
|
|
|
void GDScriptLanguageProtocol::stop() {
|
|
const int *ptr = clients.next(NULL);
|
|
while (ptr) {
|
|
clients.get(*ptr)->close();
|
|
ptr = clients.next(ptr);
|
|
}
|
|
server->stop();
|
|
clients.clear();
|
|
}
|
|
|
|
void GDScriptLanguageProtocol::notify_all_clients(const String &p_method, const Variant &p_params) {
|
|
|
|
Dictionary message = make_notification(p_method, p_params);
|
|
String msg = JSON::print(message);
|
|
msg = format_output(msg);
|
|
CharString charstr = msg.utf8();
|
|
const int *p_id = clients.next(NULL);
|
|
while (p_id != NULL) {
|
|
Ref<WebSocketPeer> peer = clients.get(*p_id);
|
|
(*peer)->put_packet((const uint8_t *)charstr.ptr(), charstr.length());
|
|
p_id = clients.next(p_id);
|
|
}
|
|
}
|
|
|
|
void GDScriptLanguageProtocol::notify_client(const String &p_method, const Variant &p_params, int p_client) {
|
|
|
|
if (p_client == -1) {
|
|
p_client = lastest_client_id;
|
|
}
|
|
|
|
Ref<WebSocketPeer> *peer = clients.getptr(p_client);
|
|
ERR_FAIL_COND(peer == NULL);
|
|
|
|
Dictionary message = make_notification(p_method, p_params);
|
|
String msg = JSON::print(message);
|
|
msg = format_output(msg);
|
|
CharString charstr = msg.utf8();
|
|
|
|
(*peer)->put_packet((const uint8_t *)charstr.ptr(), charstr.length());
|
|
}
|
|
|
|
bool GDScriptLanguageProtocol::is_smart_resolve_enabled() const {
|
|
return bool(_EDITOR_GET("network/language_server/enable_smart_resolve"));
|
|
}
|
|
|
|
bool GDScriptLanguageProtocol::is_goto_native_symbols_enabled() const {
|
|
return bool(_EDITOR_GET("network/language_server/show_native_symbols_in_editor"));
|
|
}
|
|
|
|
GDScriptLanguageProtocol::GDScriptLanguageProtocol() {
|
|
server = NULL;
|
|
singleton = this;
|
|
_initialized = false;
|
|
workspace.instance();
|
|
text_document.instance();
|
|
set_scope("textDocument", text_document.ptr());
|
|
set_scope("completionItem", text_document.ptr());
|
|
set_scope("workspace", workspace.ptr());
|
|
workspace->root = ProjectSettings::get_singleton()->get_resource_path();
|
|
}
|
|
|
|
GDScriptLanguageProtocol::~GDScriptLanguageProtocol() {
|
|
memdelete(server);
|
|
server = NULL;
|
|
}
|