Add automatic checking for engine updates

1 files changed, 344 insertions, 0 deletions

diff --git a/editor/engine_update_label.cpp b/editor/engine_update_label.cpp
new file mode 100644
index 0000000000..0b20738e99
--- /dev/null
+++ b/editor/engine_update_label.cpp
@@ -0,0 +1,344 @@
+/**************************************************************************/
+/*  engine_update_label.cpp                                               */
+/**************************************************************************/
+/*                         This file is part of:                          */
+/*                             GODOT ENGINE                               */
+/*                        https://godotengine.org                         */
+/**************************************************************************/
+/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
+/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur.                  */
+/*                                                                        */
+/* 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 "engine_update_label.h"
+
+#include "core/os/time.h"
+#include "editor/editor_settings.h"
+#include "editor/editor_string_names.h"
+#include "editor/themes/editor_scale.h"
+#include "scene/gui/box_container.h"
+#include "scene/gui/button.h"
+#include "scene/main/http_request.h"
+
+bool EngineUpdateLabel::_can_check_updates() const {
+	return int(EDITOR_GET("network/connection/network_mode")) == EditorSettings::NETWORK_ONLINE &&
+			UpdateMode(int(EDITOR_GET("network/connection/engine_version_update_mode"))) != UpdateMode::DISABLED;
+}
+
+void EngineUpdateLabel::_check_update() {
+	checked_update = true;
+	_set_status(UpdateStatus::BUSY);
+	http->request("https://raw.githubusercontent.com/godotengine/godot-website/master/_data/versions.yml");
+}
+
+void EngineUpdateLabel::_http_request_completed(int p_result, int p_response_code, const PackedStringArray &p_headers, const PackedByteArray &p_body) {
+	if (p_result != OK) {
+		_set_status(UpdateStatus::ERROR);
+		_set_message(vformat(TTR("Failed to check for updates. Error: %d."), p_result), theme_cache.error_color);
+		return;
+	}
+
+	if (p_response_code != 200) {
+		_set_status(UpdateStatus::ERROR);
+		_set_message(vformat(TTR("Failed to check for updates. Response code: %d."), p_response_code), theme_cache.error_color);
+		return;
+	}
+
+	PackedStringArray lines;
+	{
+		String s;
+		const uint8_t *r = p_body.ptr();
+		s.parse_utf8((const char *)r, p_body.size());
+		lines = s.split("\n");
+	}
+
+	UpdateMode update_mode = UpdateMode(int(EDITOR_GET("network/connection/engine_version_update_mode")));
+	bool stable_only = update_mode == UpdateMode::NEWEST_STABLE || update_mode == UpdateMode::NEWEST_PATCH;
+
+	const Dictionary version_info = Engine::get_singleton()->get_version_info();
+	int current_major = version_info["major"];
+	int current_minor = version_info["minor"];
+	int current_patch = version_info["patch"];
+
+	int current_version_line = -1;
+	for (int i = 0; i < lines.size(); i++) {
+		const String &line = lines[i];
+		if (!line.begins_with("- name")) {
+			continue;
+		}
+
+		const String version_string = _extract_sub_string(line);
+		const PackedStringArray version_bits = version_string.split(".");
+
+		if (version_bits.size() < 2) {
+			continue;
+		}
+
+		int minor = version_bits[1].to_int();
+		if (version_bits[0].to_int() != current_major || minor < current_minor) {
+			continue;
+		}
+
+		int patch = 0;
+		if (version_bits.size() >= 3) {
+			patch = version_bits[2].to_int();
+		}
+
+		if (minor == current_minor && patch < current_patch) {
+			continue;
+		}
+
+		if (update_mode == UpdateMode::NEWEST_PATCH && minor > current_minor) {
+			continue;
+		}
+
+		if (minor > current_minor || patch > current_patch) {
+			String version_type = _extract_sub_string(lines[i + 1]);
+			if (stable_only && _get_version_type(version_type, nullptr) != VersionType::STABLE) {
+				continue;
+			}
+
+			found_version = version_string;
+			found_version += "-" + version_type;
+			break;
+		} else if (minor == current_minor && patch == current_patch) {
+			current_version_line = i;
+			found_version = version_string;
+			break;
+		}
+	}
+
+	if (current_version_line == -1 && !found_version.is_empty()) {
+		_set_status(UpdateStatus::UPDATE_AVAILABLE);
+		_set_message(vformat(TTR("Update available: %s."), found_version), theme_cache.update_color);
+		return;
+	} else if (current_version_line == -1 || stable_only) {
+		_set_status(UpdateStatus::UP_TO_DATE);
+		return;
+	}
+
+	int current_version_index;
+	VersionType current_version_type = _get_version_type(version_info["status"], &current_version_index);
+
+	for (int i = current_version_line + 1; i < lines.size(); i++) {
+		const String &line = lines[i];
+		if (line.begins_with("- name")) {
+			break;
+		}
+
+		if (!line.begins_with("    - name") && !line.begins_with("  flavor")) {
+			continue;
+		}
+
+		const String version_string = _extract_sub_string(line);
+		int version_index;
+		VersionType version_type = _get_version_type(version_string, &version_index);
+
+		if (int(version_type) < int(current_version_type) || version_index > current_version_index) {
+			found_version += "-" + version_string;
+
+			_set_status(UpdateStatus::UPDATE_AVAILABLE);
+			_set_message(vformat(TTR("Update available: %s."), found_version), theme_cache.update_color);
+			return;
+		}
+	}
+
+	if (current_version_index == DEV_VERSION) {
+		// Since version index can't be determined and no strictly newer version exists, display a different status.
+		_set_status(UpdateStatus::DEV);
+	} else {
+		_set_status(UpdateStatus::UP_TO_DATE);
+	}
+}
+
+void EngineUpdateLabel::_set_message(const String &p_message, const Color &p_color) {
+	if (is_disabled()) {
+		add_theme_color_override("font_disabled_color", p_color);
+	} else {
+		add_theme_color_override("font_color", p_color);
+	}
+	set_text(p_message);
+}
+
+void EngineUpdateLabel::_set_status(UpdateStatus p_status) {
+	status = p_status;
+	if (compact_mode) {
+		if (status != UpdateStatus::BUSY && status != UpdateStatus::UPDATE_AVAILABLE) {
+			hide();
+			return;
+		} else {
+			show();
+		}
+	}
+
+	switch (status) {
+		case UpdateStatus::DEV: {
+			set_disabled(true);
+			_set_message(TTR("Running a development build."), theme_cache.disabled_color);
+			set_tooltip_text(TTR("Exact version can't be determined for update checking."));
+			break;
+		}
+		case UpdateStatus::OFFLINE: {
+			set_disabled(false);
+			if (int(EDITOR_GET("network/connection/network_mode")) == EditorSettings::NETWORK_OFFLINE) {
+				_set_message(TTR("Offline mode, update checks disabled."), theme_cache.disabled_color);
+			} else {
+				_set_message(TTR("Update checks disabled."), theme_cache.disabled_color);
+			}
+			set_tooltip_text("");
+			break;
+		}
+		case UpdateStatus::BUSY: {
+			set_disabled(true);
+			_set_message(TTR("Checking for updates..."), theme_cache.default_color);
+			set_tooltip_text("");
+		} break;
+
+		case UpdateStatus::ERROR: {
+			set_disabled(false);
+			set_tooltip_text(TTR("An error has occurred. Click to try again."));
+		} break;
+
+		case UpdateStatus::UP_TO_DATE: {
+			set_disabled(false);
+			_set_message(TTR("Current version up to date."), theme_cache.disabled_color);
+			set_tooltip_text(TTR("Click to check again."));
+		} break;
+
+		case UpdateStatus::UPDATE_AVAILABLE: {
+			set_disabled(false);
+			set_tooltip_text(TTR("Click to open download page."));
+		} break;
+
+		default: {
+		}
+	}
+}
+
+EngineUpdateLabel::VersionType EngineUpdateLabel::_get_version_type(const String &p_string, int *r_index) const {
+	VersionType type = VersionType::UNKNOWN;
+	String index_string;
+
+	static HashMap<String, VersionType> type_map;
+	if (type_map.is_empty()) {
+		type_map["stable"] = VersionType::STABLE;
+		type_map["rc"] = VersionType::RC;
+		type_map["beta"] = VersionType::BETA;
+		type_map["alpha"] = VersionType::ALPHA;
+		type_map["dev"] = VersionType::DEV;
+	}
+
+	for (const KeyValue<String, VersionType> &kv : type_map) {
+		if (p_string.begins_with(kv.key)) {
+			index_string = p_string.trim_prefix(kv.key);
+			type = kv.value;
+			break;
+		}
+	}
+
+	if (r_index) {
+		if (index_string.is_empty()) {
+			*r_index = DEV_VERSION;
+		} else {
+			*r_index = index_string.to_int();
+		}
+	}
+	return type;
+}
+
+String EngineUpdateLabel::_extract_sub_string(const String &p_line) const {
+	int j = p_line.find("\"") + 1;
+	return p_line.substr(j, p_line.find("\"", j) - j);
+}
+
+void EngineUpdateLabel::_notification(int p_what) {
+	switch (p_what) {
+		case EditorSettings::NOTIFICATION_EDITOR_SETTINGS_CHANGED: {
+			if (!EditorSettings::get_singleton()->check_changed_settings_in_group("network/connection")) {
+				break;
+			}
+
+			if (_can_check_updates()) {
+				if (!checked_update) {
+					_check_update();
+				} else {
+					// This will be wrong when user toggles online mode twice when update is available, but it's not worth handling.
+					_set_status(UpdateStatus::UP_TO_DATE);
+				}
+			} else {
+				_set_status(UpdateStatus::OFFLINE);
+			}
+		} break;
+
+		case NOTIFICATION_THEME_CHANGED: {
+			theme_cache.default_color = get_theme_color("font_color", "Button");
+			theme_cache.disabled_color = get_theme_color("font_disabled_color", "Button");
+			theme_cache.error_color = get_theme_color("error_color", EditorStringName(Editor));
+			theme_cache.update_color = get_theme_color("warning_color", EditorStringName(Editor));
+		} break;
+
+		case NOTIFICATION_READY: {
+			if (_can_check_updates()) {
+				_check_update();
+			} else {
+				_set_status(UpdateStatus::OFFLINE);
+			}
+		} break;
+	}
+}
+
+void EngineUpdateLabel::_bind_methods() {
+	ADD_SIGNAL(MethodInfo("offline_clicked"));
+}
+
+void EngineUpdateLabel::pressed() {
+	switch (status) {
+		case UpdateStatus::OFFLINE: {
+			emit_signal("offline_clicked");
+		} break;
+
+		case UpdateStatus::ERROR:
+		case UpdateStatus::UP_TO_DATE: {
+			_check_update();
+		} break;
+
+		case UpdateStatus::UPDATE_AVAILABLE: {
+			OS::get_singleton()->shell_open("https://godotengine.org/download/archive/" + found_version);
+		} break;
+
+		default: {
+		}
+	}
+}
+
+void EngineUpdateLabel::enable_compact_mode() {
+	compact_mode = true;
+}
+
+EngineUpdateLabel::EngineUpdateLabel() {
+	set_underline_mode(UNDERLINE_MODE_ON_HOVER);
+
+	http = memnew(HTTPRequest);
+	http->set_https_proxy(EDITOR_GET("network/http_proxy/host"), EDITOR_GET("network/http_proxy/port"));
+	http->set_timeout(10.0);
+	add_child(http);
+	http->connect("request_completed", callable_mp(this, &EngineUpdateLabel::_http_request_completed));
+}