/**************************************************************************/ /* asset_library_editor_plugin.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 "asset_library_editor_plugin.h" #include "core/input/input.h" #include "core/io/json.h" #include "core/io/stream_peer_tls.h" #include "core/os/keyboard.h" #include "core/version.h" #include "editor/editor_main_screen.h" #include "editor/editor_node.h" #include "editor/editor_paths.h" #include "editor/editor_settings.h" #include "editor/editor_string_names.h" #include "editor/gui/editor_file_dialog.h" #include "editor/project_settings_editor.h" #include "editor/themes/editor_scale.h" #include "scene/gui/menu_button.h" #include "scene/resources/image_texture.h" static inline void setup_http_request(HTTPRequest *request) { request->set_use_threads(EDITOR_GET("asset_library/use_threads")); const String proxy_host = EDITOR_GET("network/http_proxy/host"); const int proxy_port = EDITOR_GET("network/http_proxy/port"); request->set_http_proxy(proxy_host, proxy_port); request->set_https_proxy(proxy_host, proxy_port); } void EditorAssetLibraryItem::configure(const String &p_title, int p_asset_id, const String &p_category, int p_category_id, const String &p_author, int p_author_id, const String &p_cost) { title_text = p_title; title->set_text(title_text); title->set_tooltip_text(title_text); asset_id = p_asset_id; category->set_text(p_category); category_id = p_category_id; author->set_text(p_author); author_id = p_author_id; price->set_text(p_cost); } // TODO: Refactor this method to use the TextServer. void EditorAssetLibraryItem::clamp_width(int p_max_width) { int text_pixel_width = title->get_button_font()->get_string_size(title_text).x * EDSCALE; if (text_pixel_width > p_max_width) { // Truncate title text to within the current column width. int max_length = p_max_width / (text_pixel_width / title_text.length()); String truncated_text = title_text.left(max_length - 3) + "..."; title->set_text(truncated_text); } else { title->set_text(title_text); } } void EditorAssetLibraryItem::set_image(int p_type, int p_index, const Ref &p_image) { ERR_FAIL_COND(p_type != EditorAssetLibrary::IMAGE_QUEUE_ICON); ERR_FAIL_COND(p_index != 0); icon->set_texture_normal(p_image); } void EditorAssetLibraryItem::_notification(int p_what) { switch (p_what) { case NOTIFICATION_ENTER_TREE: { icon->set_texture_normal(get_editor_theme_icon(SNAME("ProjectIconLoading"))); category->add_theme_color_override(SceneStringName(font_color), Color(0.5, 0.5, 0.5)); author->add_theme_color_override(SceneStringName(font_color), Color(0.5, 0.5, 0.5)); price->add_theme_color_override(SceneStringName(font_color), Color(0.5, 0.5, 0.5)); if (author->get_default_cursor_shape() == CURSOR_ARROW) { // Disable visible feedback if author link isn't clickable. author->add_theme_color_override("font_pressed_color", Color(0.5, 0.5, 0.5)); author->add_theme_color_override("font_hover_color", Color(0.5, 0.5, 0.5)); } } break; } } void EditorAssetLibraryItem::_asset_clicked() { emit_signal(SNAME("asset_selected"), asset_id); } void EditorAssetLibraryItem::_category_clicked() { emit_signal(SNAME("category_selected"), category_id); } void EditorAssetLibraryItem::_author_clicked() { emit_signal(SNAME("author_selected"), author->get_text()); } void EditorAssetLibraryItem::_bind_methods() { ClassDB::bind_method("set_image", &EditorAssetLibraryItem::set_image); ADD_SIGNAL(MethodInfo("asset_selected")); ADD_SIGNAL(MethodInfo("category_selected")); ADD_SIGNAL(MethodInfo("author_selected")); } EditorAssetLibraryItem::EditorAssetLibraryItem(bool p_clickable) { Ref border; border.instantiate(); border->set_content_margin_all(5 * EDSCALE); add_theme_style_override(SceneStringName(panel), border); HBoxContainer *hb = memnew(HBoxContainer); // Add some spacing to visually separate the icon from the asset details. hb->add_theme_constant_override("separation", 15 * EDSCALE); add_child(hb); icon = memnew(TextureButton); icon->set_custom_minimum_size(Size2(64, 64) * EDSCALE); hb->add_child(icon); VBoxContainer *vb = memnew(VBoxContainer); hb->add_child(vb); vb->set_h_size_flags(Control::SIZE_EXPAND_FILL); title = memnew(LinkButton); title->set_auto_translate_mode(AutoTranslateMode::AUTO_TRANSLATE_MODE_DISABLED); title->set_underline_mode(LinkButton::UNDERLINE_MODE_ON_HOVER); vb->add_child(title); category = memnew(LinkButton); category->set_underline_mode(LinkButton::UNDERLINE_MODE_ON_HOVER); vb->add_child(category); HBoxContainer *author_price_hbox = memnew(HBoxContainer); author_price_hbox->add_theme_constant_override("separation", 5 * EDSCALE); vb->add_child(author_price_hbox); author = memnew(LinkButton); author->set_tooltip_text(TTR("Author")); author_price_hbox->add_child(author); author_price_hbox->add_child(memnew(HSeparator)); if (p_clickable) { author->set_underline_mode(LinkButton::UNDERLINE_MODE_ON_HOVER); icon->set_default_cursor_shape(CURSOR_POINTING_HAND); icon->connect(SceneStringName(pressed), callable_mp(this, &EditorAssetLibraryItem::_asset_clicked)); title->connect(SceneStringName(pressed), callable_mp(this, &EditorAssetLibraryItem::_asset_clicked)); category->connect(SceneStringName(pressed), callable_mp(this, &EditorAssetLibraryItem::_category_clicked)); author->connect(SceneStringName(pressed), callable_mp(this, &EditorAssetLibraryItem::_author_clicked)); } else { title->set_mouse_filter(MOUSE_FILTER_IGNORE); category->set_mouse_filter(MOUSE_FILTER_IGNORE); author->set_underline_mode(LinkButton::UNDERLINE_MODE_NEVER); author->set_default_cursor_shape(CURSOR_ARROW); } Ref label_margin; label_margin.instantiate(); label_margin->set_content_margin_all(0); price = memnew(Label); price->add_theme_style_override(CoreStringName(normal), label_margin); price->set_tooltip_text(TTR("License")); price->set_mouse_filter(MOUSE_FILTER_PASS); author_price_hbox->add_child(price); set_custom_minimum_size(Size2(250, 80) * EDSCALE); set_h_size_flags(Control::SIZE_EXPAND_FILL); } ////////////////////////////////////////////////////////////////////////////// void EditorAssetLibraryItemDescription::set_image(int p_type, int p_index, const Ref &p_image) { switch (p_type) { case EditorAssetLibrary::IMAGE_QUEUE_ICON: { item->call("set_image", p_type, p_index, p_image); icon = p_image; } break; case EditorAssetLibrary::IMAGE_QUEUE_THUMBNAIL: { for (int i = 0; i < preview_images.size(); i++) { if (preview_images[i].id == p_index) { if (preview_images[i].is_video) { Ref overlay = previews->get_editor_theme_icon(SNAME("PlayOverlay"))->get_image(); Ref thumbnail = p_image->get_image(); thumbnail = thumbnail->duplicate(); Point2i overlay_pos = Point2i((thumbnail->get_width() - overlay->get_width()) / 2, (thumbnail->get_height() - overlay->get_height()) / 2); // Overlay and thumbnail need the same format for `blend_rect` to work. thumbnail->convert(Image::FORMAT_RGBA8); thumbnail->blend_rect(overlay, overlay->get_used_rect(), overlay_pos); preview_images[i].button->set_icon(ImageTexture::create_from_image(thumbnail)); // Make it clearer that clicking it will open an external link preview_images[i].button->set_default_cursor_shape(Control::CURSOR_POINTING_HAND); } else { preview_images[i].button->set_icon(p_image); } break; } } } break; case EditorAssetLibrary::IMAGE_QUEUE_SCREENSHOT: { for (int i = 0; i < preview_images.size(); i++) { if (preview_images[i].id == p_index) { preview_images.write[i].image = p_image; if (preview_images[i].button->is_pressed()) { _preview_click(p_index); } break; } } } break; } } void EditorAssetLibraryItemDescription::_notification(int p_what) { switch (p_what) { case NOTIFICATION_ENTER_TREE: case NOTIFICATION_THEME_CHANGED: { previews_bg->add_theme_style_override(SceneStringName(panel), previews->get_theme_stylebox(CoreStringName(normal), SNAME("TextEdit"))); } break; } } void EditorAssetLibraryItemDescription::_bind_methods() { ClassDB::bind_method(D_METHOD("set_image"), &EditorAssetLibraryItemDescription::set_image); } void EditorAssetLibraryItemDescription::_link_click(const String &p_url) { ERR_FAIL_COND(!p_url.begins_with("http")); OS::get_singleton()->shell_open(p_url); } void EditorAssetLibraryItemDescription::_preview_click(int p_id) { for (int i = 0; i < preview_images.size(); i++) { if (preview_images[i].id == p_id) { preview_images[i].button->set_pressed(true); if (!preview_images[i].is_video) { if (preview_images[i].image.is_valid()) { preview->set_texture(preview_images[i].image); child_controls_changed(); } } else { _link_click(preview_images[i].video_link); } } else { preview_images[i].button->set_pressed(false); } } } void EditorAssetLibraryItemDescription::configure(const String &p_title, int p_asset_id, const String &p_category, int p_category_id, const String &p_author, int p_author_id, const String &p_cost, int p_version, const String &p_version_string, const String &p_description, const String &p_download_url, const String &p_browse_url, const String &p_sha256_hash) { asset_id = p_asset_id; title = p_title; download_url = p_download_url; sha256 = p_sha256_hash; item->configure(p_title, p_asset_id, p_category, p_category_id, p_author, p_author_id, p_cost); description->clear(); description->add_text(TTR("Version:") + " " + p_version_string + "\n"); description->add_text(TTR("Contents:") + " "); description->push_meta(p_browse_url); description->add_text(TTR("View Files")); description->pop(); description->add_text("\n" + TTR("Description:") + "\n\n"); description->append_text(p_description); description->set_selection_enabled(true); description->set_context_menu_enabled(true); set_title(p_title); } void EditorAssetLibraryItemDescription::add_preview(int p_id, bool p_video, const String &p_url) { if (preview_images.is_empty()) { previews_vbox->show(); } Preview new_preview; new_preview.id = p_id; new_preview.video_link = p_url; new_preview.is_video = p_video; new_preview.button = memnew(Button); new_preview.button->set_icon(previews->get_editor_theme_icon(SNAME("ThumbnailWait"))); new_preview.button->set_toggle_mode(true); new_preview.button->connect(SceneStringName(pressed), callable_mp(this, &EditorAssetLibraryItemDescription::_preview_click).bind(p_id)); preview_hb->add_child(new_preview.button); if (!p_video) { new_preview.image = previews->get_editor_theme_icon(SNAME("ThumbnailWait")); } preview_images.push_back(new_preview); if (preview_images.size() == 1 && !p_video) { _preview_click(p_id); } } EditorAssetLibraryItemDescription::EditorAssetLibraryItemDescription() { HBoxContainer *hbox = memnew(HBoxContainer); add_child(hbox); VBoxContainer *desc_vbox = memnew(VBoxContainer); hbox->add_child(desc_vbox); hbox->add_theme_constant_override("separation", 15 * EDSCALE); item = memnew(EditorAssetLibraryItem); desc_vbox->add_child(item); desc_vbox->set_custom_minimum_size(Size2(440 * EDSCALE, 440 * EDSCALE)); description = memnew(RichTextLabel); desc_vbox->add_child(description); description->set_v_size_flags(Control::SIZE_EXPAND_FILL); description->connect("meta_clicked", callable_mp(this, &EditorAssetLibraryItemDescription::_link_click)); description->add_theme_constant_override(SceneStringName(line_separation), Math::round(5 * EDSCALE)); previews_vbox = memnew(VBoxContainer); previews_vbox->hide(); // Will be shown if we add any previews later. hbox->add_child(previews_vbox); previews_vbox->add_theme_constant_override("separation", 15 * EDSCALE); previews_vbox->set_v_size_flags(Control::SIZE_EXPAND_FILL); previews_vbox->set_h_size_flags(Control::SIZE_EXPAND_FILL); preview = memnew(TextureRect); previews_vbox->add_child(preview); preview->set_expand_mode(TextureRect::EXPAND_IGNORE_SIZE); preview->set_stretch_mode(TextureRect::STRETCH_KEEP_ASPECT_CENTERED); preview->set_custom_minimum_size(Size2(640 * EDSCALE, 345 * EDSCALE)); preview->set_v_size_flags(Control::SIZE_EXPAND_FILL); preview->set_h_size_flags(Control::SIZE_EXPAND_FILL); previews_bg = memnew(PanelContainer); previews_vbox->add_child(previews_bg); previews_bg->set_custom_minimum_size(Size2(640 * EDSCALE, 101 * EDSCALE)); previews = memnew(ScrollContainer); previews_bg->add_child(previews); previews->set_vertical_scroll_mode(ScrollContainer::SCROLL_MODE_DISABLED); preview_hb = memnew(HBoxContainer); preview_hb->set_v_size_flags(Control::SIZE_EXPAND_FILL); previews->add_child(preview_hb); set_ok_button_text(TTR("Download")); set_cancel_button_text(TTR("Close")); } /////////////////////////////////////////////////////////////////////////////////// void EditorAssetLibraryItemDownload::_http_download_completed(int p_status, int p_code, const PackedStringArray &headers, const PackedByteArray &p_data) { String error_text; switch (p_status) { case HTTPRequest::RESULT_CHUNKED_BODY_SIZE_MISMATCH: case HTTPRequest::RESULT_CONNECTION_ERROR: case HTTPRequest::RESULT_BODY_SIZE_LIMIT_EXCEEDED: { error_text = TTR("Connection error, please try again."); status->set_text(TTR("Can't connect.")); } break; case HTTPRequest::RESULT_CANT_CONNECT: case HTTPRequest::RESULT_TLS_HANDSHAKE_ERROR: { error_text = TTR("Can't connect to host:") + " " + host; status->set_text(TTR("Can't connect.")); } break; case HTTPRequest::RESULT_NO_RESPONSE: { error_text = TTR("No response from host:") + " " + host; status->set_text(TTR("No response.")); } break; case HTTPRequest::RESULT_CANT_RESOLVE: { error_text = TTR("Can't resolve hostname:") + " " + host; status->set_text(TTR("Can't resolve.")); } break; case HTTPRequest::RESULT_REQUEST_FAILED: { error_text = TTR("Request failed, return code:") + " " + itos(p_code); status->set_text(TTR("Request failed.")); } break; case HTTPRequest::RESULT_DOWNLOAD_FILE_CANT_OPEN: case HTTPRequest::RESULT_DOWNLOAD_FILE_WRITE_ERROR: { error_text = TTR("Cannot save response to:") + " " + download->get_download_file(); status->set_text(TTR("Write error.")); } break; case HTTPRequest::RESULT_REDIRECT_LIMIT_REACHED: { error_text = TTR("Request failed, too many redirects"); status->set_text(TTR("Redirect loop.")); } break; case HTTPRequest::RESULT_TIMEOUT: { error_text = TTR("Request failed, timeout"); status->set_text(TTR("Timeout.")); } break; default: { if (p_code != 200) { error_text = TTR("Request failed, return code:") + " " + itos(p_code); status->set_text(TTR("Failed:") + " " + itos(p_code)); } else if (!sha256.is_empty()) { String download_sha256 = FileAccess::get_sha256(download->get_download_file()); if (sha256 != download_sha256) { error_text = TTR("Bad download hash, assuming file has been tampered with.") + "\n"; error_text += TTR("Expected:") + " " + sha256 + "\n" + TTR("Got:") + " " + download_sha256; status->set_text(TTR("Failed SHA-256 hash check")); } } } break; } // Make the progress bar invisible but don't reflow other Controls around it. progress->set_modulate(Color(0, 0, 0, 0)); progress->set_indeterminate(false); if (!error_text.is_empty()) { download_error->set_text(TTR("Asset Download Error:") + "\n" + error_text); download_error->popup_centered(); // Let the user retry the download. retry_button->show(); return; } install_button->set_disabled(false); status->set_text(TTR("Ready to install!")); set_process(false); // Automatically prompt for installation once the download is completed. install(); } void EditorAssetLibraryItemDownload::configure(const String &p_title, int p_asset_id, const Ref &p_preview, const String &p_download_url, const String &p_sha256_hash) { title->set_text(p_title); icon->set_texture(p_preview); asset_id = p_asset_id; if (!p_preview.is_valid()) { icon->set_texture(get_editor_theme_icon(SNAME("FileBrokenBigThumb"))); } host = p_download_url; sha256 = p_sha256_hash; _make_request(); } void EditorAssetLibraryItemDownload::_notification(int p_what) { switch (p_what) { case NOTIFICATION_THEME_CHANGED: { panel->add_theme_style_override(SceneStringName(panel), get_theme_stylebox(SceneStringName(panel), SNAME("AssetLib"))); status->add_theme_color_override(SceneStringName(font_color), get_theme_color(SNAME("status_color"), SNAME("AssetLib"))); dismiss_button->set_texture_normal(get_theme_icon(SNAME("dismiss"), SNAME("AssetLib"))); } break; case NOTIFICATION_PROCESS: { // Make the progress bar visible again when retrying the download. progress->set_modulate(Color(1, 1, 1, 1)); if (download->get_downloaded_bytes() > 0) { progress->set_max(download->get_body_size()); progress->set_value(download->get_downloaded_bytes()); } int cstatus = download->get_http_client_status(); if (cstatus == HTTPClient::STATUS_BODY) { if (download->get_body_size() > 0) { progress->set_indeterminate(false); status->set_text(vformat( TTR("Downloading (%s / %s)..."), String::humanize_size(download->get_downloaded_bytes()), String::humanize_size(download->get_body_size()))); } else { progress->set_indeterminate(true); status->set_text(vformat( TTR("Downloading...") + " (%s)", String::humanize_size(download->get_downloaded_bytes()))); } } if (cstatus != prev_status) { switch (cstatus) { case HTTPClient::STATUS_RESOLVING: { status->set_text(TTR("Resolving...")); progress->set_max(1); progress->set_value(0); } break; case HTTPClient::STATUS_CONNECTING: { status->set_text(TTR("Connecting...")); progress->set_max(1); progress->set_value(0); } break; case HTTPClient::STATUS_REQUESTING: { status->set_text(TTR("Requesting...")); progress->set_max(1); progress->set_value(0); } break; default: { } } prev_status = cstatus; } } break; } } void EditorAssetLibraryItemDownload::_close() { // Clean up downloaded file. DirAccess::remove_file_or_error(download->get_download_file()); queue_free(); } bool EditorAssetLibraryItemDownload::can_install() const { return !install_button->is_disabled(); } void EditorAssetLibraryItemDownload::install() { String file = download->get_download_file(); if (external_install) { emit_signal(SNAME("install_asset"), file, title->get_text()); return; } asset_installer->set_asset_name(title->get_text()); asset_installer->open_asset(file, true); } void EditorAssetLibraryItemDownload::_make_request() { // Hide the Retry button if we've just pressed it. retry_button->hide(); download->cancel_request(); download->set_download_file(EditorPaths::get_singleton()->get_cache_dir().path_join("tmp_asset_" + itos(asset_id)) + ".zip"); Error err = download->request(host); if (err != OK) { status->set_text(TTR("Error making request")); } else { progress->set_indeterminate(true); set_process(true); } } void EditorAssetLibraryItemDownload::_bind_methods() { ADD_SIGNAL(MethodInfo("install_asset", PropertyInfo(Variant::STRING, "zip_path"), PropertyInfo(Variant::STRING, "name"))); } EditorAssetLibraryItemDownload::EditorAssetLibraryItemDownload() { panel = memnew(PanelContainer); add_child(panel); HBoxContainer *hb = memnew(HBoxContainer); panel->add_child(hb); icon = memnew(TextureRect); icon->set_stretch_mode(TextureRect::STRETCH_KEEP_ASPECT_CENTERED); icon->set_v_size_flags(0); hb->add_child(icon); VBoxContainer *vb = memnew(VBoxContainer); hb->add_child(vb); vb->set_h_size_flags(Control::SIZE_EXPAND_FILL); HBoxContainer *title_hb = memnew(HBoxContainer); vb->add_child(title_hb); title = memnew(Label); title_hb->add_child(title); title->set_h_size_flags(Control::SIZE_EXPAND_FILL); dismiss_button = memnew(TextureButton); dismiss_button->connect(SceneStringName(pressed), callable_mp(this, &EditorAssetLibraryItemDownload::_close)); title_hb->add_child(dismiss_button); title->set_clip_text(true); vb->add_spacer(); status = memnew(Label(TTR("Idle"))); vb->add_child(status); progress = memnew(ProgressBar); progress->set_editor_preview_indeterminate(true); vb->add_child(progress); HBoxContainer *hb2 = memnew(HBoxContainer); vb->add_child(hb2); hb2->add_spacer(); install_button = memnew(Button); install_button->set_text(TTR("Install...")); install_button->set_disabled(true); install_button->connect(SceneStringName(pressed), callable_mp(this, &EditorAssetLibraryItemDownload::install)); retry_button = memnew(Button); retry_button->set_text(TTR("Retry")); retry_button->connect(SceneStringName(pressed), callable_mp(this, &EditorAssetLibraryItemDownload::_make_request)); // Only show the Retry button in case of a failure. retry_button->hide(); hb2->add_child(retry_button); hb2->add_child(install_button); set_custom_minimum_size(Size2(310, 0) * EDSCALE); download = memnew(HTTPRequest); panel->add_child(download); download->connect("request_completed", callable_mp(this, &EditorAssetLibraryItemDownload::_http_download_completed)); setup_http_request(download); download_error = memnew(AcceptDialog); panel->add_child(download_error); download_error->set_title(TTR("Download Error")); asset_installer = memnew(EditorAssetInstaller); panel->add_child(asset_installer); asset_installer->connect(SceneStringName(confirmed), callable_mp(this, &EditorAssetLibraryItemDownload::_close)); prev_status = -1; external_install = false; } //////////////////////////////////////////////////////////////////////////////// void EditorAssetLibrary::_notification(int p_what) { switch (p_what) { case NOTIFICATION_READY: { add_theme_style_override(SceneStringName(panel), get_theme_stylebox(SNAME("bg"), SNAME("AssetLib"))); error_label->move_to_front(); } break; case NOTIFICATION_ENTER_TREE: case NOTIFICATION_THEME_CHANGED: { error_tr->set_texture(get_editor_theme_icon(SNAME("Error"))); filter->set_right_icon(get_editor_theme_icon(SNAME("Search"))); library_scroll_bg->add_theme_style_override(SceneStringName(panel), get_theme_stylebox(SceneStringName(panel), SNAME("Tree"))); downloads_scroll->add_theme_style_override(SceneStringName(panel), get_theme_stylebox(SceneStringName(panel), SNAME("Tree"))); error_label->add_theme_color_override("color", get_theme_color(SNAME("error_color"), EditorStringName(Editor))); } break; case NOTIFICATION_VISIBILITY_CHANGED: { if (is_visible()) { #ifndef ANDROID_ENABLED // Focus the search box automatically when switching to the Templates tab (in the Project Manager) // or switching to the AssetLib tab (in the editor). // The Project Manager's project filter box is automatically focused in the project manager code. filter->grab_focus(); #endif if (initial_loading) { _repository_changed(0); // Update when shown for the first time. } } } break; case NOTIFICATION_PROCESS: { HTTPClient::Status s = request->get_http_client_status(); const bool loading = s != HTTPClient::STATUS_DISCONNECTED; if (loading) { library_scroll->set_modulate(Color(1, 1, 1, 0.5)); } else { library_scroll->set_modulate(Color(1, 1, 1, 1)); } const bool no_downloads = downloads_hb->get_child_count() == 0; if (no_downloads == downloads_scroll->is_visible()) { downloads_scroll->set_visible(!no_downloads); } } break; case NOTIFICATION_RESIZED: { _update_asset_items_columns(); } break; case EditorSettings::NOTIFICATION_EDITOR_SETTINGS_CHANGED: { if (!EditorSettings::get_singleton()->check_changed_settings_in_group("asset_library") && !EditorSettings::get_singleton()->check_changed_settings_in_group("network")) { break; } _update_repository_options(); setup_http_request(request); const bool loading_blocked_new = ((int)EDITOR_GET("network/connection/network_mode") == EditorSettings::NETWORK_OFFLINE); if (loading_blocked_new != loading_blocked) { loading_blocked = loading_blocked_new; if (!loading_blocked && is_visible()) { _request_current_config(); // Reload config now that the network is available. } } } break; } } void EditorAssetLibrary::_update_repository_options() { // TODO: Move to editor_settings.cpp Dictionary default_urls; default_urls["godotengine.org (Official)"] = "https://godotengine.org/asset-library/api"; Dictionary available_urls = _EDITOR_DEF("asset_library/available_urls", default_urls, true); repository->clear(); Array keys = available_urls.keys(); for (int i = 0; i < keys.size(); i++) { String key = keys[i]; repository->add_item(key); repository->set_item_metadata(i, available_urls[key]); } } void EditorAssetLibrary::shortcut_input(const Ref &p_event) { ERR_FAIL_COND(p_event.is_null()); const Ref key = p_event; if (key.is_valid() && key->is_pressed()) { if (key->is_match(InputEventKey::create_reference(KeyModifierMask::CMD_OR_CTRL | Key::F)) && is_visible_in_tree()) { filter->grab_focus(); filter->select_all(); accept_event(); } } } void EditorAssetLibrary::_install_asset() { ERR_FAIL_NULL(description); EditorAssetLibraryItemDownload *d = _get_asset_in_progress(description->get_asset_id()); if (d) { d->install(); return; } EditorAssetLibraryItemDownload *download = memnew(EditorAssetLibraryItemDownload); downloads_hb->add_child(download); download->configure(description->get_title(), description->get_asset_id(), description->get_preview_icon(), description->get_download_url(), description->get_sha256()); if (templates_only) { download->set_external_install(true); download->connect("install_asset", callable_mp(this, &EditorAssetLibrary::_install_external_asset)); } } const char *EditorAssetLibrary::sort_key[SORT_MAX] = { "updated", "updated", "name", "name", "cost", "cost", }; const char *EditorAssetLibrary::sort_text[SORT_MAX] = { TTRC("Recently Updated"), TTRC("Least Recently Updated"), TTRC("Name (A-Z)"), TTRC("Name (Z-A)"), TTRC("License (A-Z)"), // "cost" stores the SPDX license name in the Godot Asset Library. TTRC("License (Z-A)"), // "cost" stores the SPDX license name in the Godot Asset Library. }; const char *EditorAssetLibrary::support_key[SUPPORT_MAX] = { "official", // Former name for the Featured support level (still used on the API backend). "community", "testing", }; const char *EditorAssetLibrary::support_text[SUPPORT_MAX] = { TTRC("Featured"), TTRC("Community"), TTRC("Testing"), }; void EditorAssetLibrary::_select_author(const String &p_author) { if (!host.contains("godotengine.org")) { // Don't open the link for alternative repositories. return; } OS::get_singleton()->shell_open("https://godotengine.org/asset-library/asset?user=" + p_author.uri_encode()); } void EditorAssetLibrary::_select_category(int p_id) { for (int i = 0; i < categories->get_item_count(); i++) { if (i == 0) { continue; } int id = categories->get_item_metadata(i); if (id == p_id) { categories->select(i); _search(); break; } } } void EditorAssetLibrary::_select_asset(int p_id) { _api_request("asset/" + itos(p_id), REQUESTING_ASSET); } void EditorAssetLibrary::_image_update(bool p_use_cache, bool p_final, const PackedByteArray &p_data, int p_queue_id) { Object *obj = ObjectDB::get_instance(image_queue[p_queue_id].target); if (!obj) { return; } bool image_set = false; PackedByteArray image_data = p_data; if (p_use_cache) { String cache_filename_base = EditorPaths::get_singleton()->get_cache_dir().path_join("assetimage_" + image_queue[p_queue_id].image_url.md5_text()); Ref file = FileAccess::open(cache_filename_base + ".data", FileAccess::READ); if (file.is_valid()) { PackedByteArray cached_data; int len = file->get_32(); cached_data.resize(len); uint8_t *w = cached_data.ptrw(); file->get_buffer(w, len); image_data = cached_data; } } int len = image_data.size(); const uint8_t *r = image_data.ptr(); Ref image = memnew(Image); uint8_t png_signature[8] = { 137, 80, 78, 71, 13, 10, 26, 10 }; uint8_t jpg_signature[3] = { 255, 216, 255 }; uint8_t webp_signature[4] = { 82, 73, 70, 70 }; uint8_t bmp_signature[2] = { 66, 77 }; if (r) { Ref parsed_image; if ((memcmp(&r[0], &png_signature[0], 8) == 0) && Image::_png_mem_loader_func) { parsed_image = Image::_png_mem_loader_func(r, len); } else if ((memcmp(&r[0], &jpg_signature[0], 3) == 0) && Image::_jpg_mem_loader_func) { parsed_image = Image::_jpg_mem_loader_func(r, len); } else if ((memcmp(&r[0], &webp_signature[0], 4) == 0) && Image::_webp_mem_loader_func) { parsed_image = Image::_webp_mem_loader_func(r, len); } else if ((memcmp(&r[0], &bmp_signature[0], 2) == 0) && Image::_bmp_mem_loader_func) { parsed_image = Image::_bmp_mem_loader_func(r, len); } else if (Image::_svg_scalable_mem_loader_func) { parsed_image = Image::_svg_scalable_mem_loader_func(r, len, 1.0); } if (parsed_image.is_null()) { if (is_print_verbose_enabled()) { ERR_PRINT(vformat("Asset Library: Invalid image downloaded from '%s' for asset # %d", image_queue[p_queue_id].image_url, image_queue[p_queue_id].asset_id)); } } else { image->copy_internals_from(parsed_image); } } if (!image->is_empty()) { switch (image_queue[p_queue_id].image_type) { case IMAGE_QUEUE_ICON: image->resize(64 * EDSCALE, 64 * EDSCALE, Image::INTERPOLATE_LANCZOS); break; case IMAGE_QUEUE_THUMBNAIL: { float max_height = 85 * EDSCALE; float scale_ratio = max_height / (image->get_height() * EDSCALE); if (scale_ratio < 1) { image->resize(image->get_width() * EDSCALE * scale_ratio, image->get_height() * EDSCALE * scale_ratio, Image::INTERPOLATE_LANCZOS); } } break; case IMAGE_QUEUE_SCREENSHOT: { float max_height = 397 * EDSCALE; float scale_ratio = max_height / (image->get_height() * EDSCALE); if (scale_ratio < 1) { image->resize(image->get_width() * EDSCALE * scale_ratio, image->get_height() * EDSCALE * scale_ratio, Image::INTERPOLATE_LANCZOS); } } break; } Ref tex = ImageTexture::create_from_image(image); obj->call("set_image", image_queue[p_queue_id].image_type, image_queue[p_queue_id].image_index, tex); image_set = true; } if (!image_set && p_final) { obj->call("set_image", image_queue[p_queue_id].image_type, image_queue[p_queue_id].image_index, get_editor_theme_icon(SNAME("FileBrokenBigThumb"))); } } void EditorAssetLibrary::_image_request_completed(int p_status, int p_code, const PackedStringArray &headers, const PackedByteArray &p_data, int p_queue_id) { ERR_FAIL_COND(!image_queue.has(p_queue_id)); if (p_status == HTTPRequest::RESULT_SUCCESS && p_code < HTTPClient::RESPONSE_BAD_REQUEST) { if (p_code != HTTPClient::RESPONSE_NOT_MODIFIED) { for (int i = 0; i < headers.size(); i++) { if (headers[i].findn("ETag:") == 0) { // Save etag String cache_filename_base = EditorPaths::get_singleton()->get_cache_dir().path_join("assetimage_" + image_queue[p_queue_id].image_url.md5_text()); String new_etag = headers[i].substr(headers[i].find(":") + 1, headers[i].length()).strip_edges(); Ref file = FileAccess::open(cache_filename_base + ".etag", FileAccess::WRITE); if (file.is_valid()) { file->store_line(new_etag); } int len = p_data.size(); const uint8_t *r = p_data.ptr(); file = FileAccess::open(cache_filename_base + ".data", FileAccess::WRITE); if (file.is_valid()) { file->store_32(len); file->store_buffer(r, len); } break; } } } _image_update(p_code == HTTPClient::RESPONSE_NOT_MODIFIED, true, p_data, p_queue_id); } else { if (is_print_verbose_enabled()) { WARN_PRINT(vformat("Asset Library: Error getting image from '%s' for asset # %d.", image_queue[p_queue_id].image_url, image_queue[p_queue_id].asset_id)); } Object *obj = ObjectDB::get_instance(image_queue[p_queue_id].target); if (obj) { obj->call("set_image", image_queue[p_queue_id].image_type, image_queue[p_queue_id].image_index, get_editor_theme_icon(SNAME("FileBrokenBigThumb"))); } } image_queue[p_queue_id].request->queue_free(); image_queue.erase(p_queue_id); _update_image_queue(); } void EditorAssetLibrary::_update_image_queue() { const int max_images = 6; int current_images = 0; List to_delete; for (KeyValue &E : image_queue) { if (!E.value.active && current_images < max_images) { String cache_filename_base = EditorPaths::get_singleton()->get_cache_dir().path_join("assetimage_" + E.value.image_url.md5_text()); Vector headers; if (FileAccess::exists(cache_filename_base + ".etag") && FileAccess::exists(cache_filename_base + ".data")) { Ref file = FileAccess::open(cache_filename_base + ".etag", FileAccess::READ); if (file.is_valid()) { headers.push_back("If-None-Match: " + file->get_line()); } } Error err = E.value.request->request(E.value.image_url, headers); if (err != OK) { to_delete.push_back(E.key); } else { E.value.active = true; } current_images++; } else if (E.value.active) { current_images++; } } while (to_delete.size()) { image_queue[to_delete.front()->get()].request->queue_free(); image_queue.erase(to_delete.front()->get()); to_delete.pop_front(); } } void EditorAssetLibrary::_request_image(ObjectID p_for, int p_asset_id, String p_image_url, ImageType p_type, int p_image_index) { // Remove extra spaces around the URL. This isn't strictly valid, but recoverable. String trimmed_url = p_image_url.strip_edges(); if (trimmed_url != p_image_url && is_print_verbose_enabled()) { WARN_PRINT(vformat("Asset Library: Badly formatted image URL '%s' for asset # %d.", p_image_url, p_asset_id)); } // Validate the image URL first. { String url_scheme; String url_host; int url_port; String url_path; String url_fragment; Error err = trimmed_url.parse_url(url_scheme, url_host, url_port, url_path, url_fragment); if (err != OK) { if (is_print_verbose_enabled()) { ERR_PRINT(vformat("Asset Library: Invalid image URL '%s' for asset # %d.", trimmed_url, p_asset_id)); } Object *obj = ObjectDB::get_instance(p_for); if (obj) { obj->call("set_image", p_type, p_image_index, get_editor_theme_icon(SNAME("FileBrokenBigThumb"))); } return; } } ImageQueue iq; iq.image_url = trimmed_url; iq.image_index = p_image_index; iq.image_type = p_type; iq.request = memnew(HTTPRequest); setup_http_request(iq.request); iq.target = p_for; iq.asset_id = p_asset_id; iq.queue_id = ++last_queue_id; iq.active = false; iq.request->connect("request_completed", callable_mp(this, &EditorAssetLibrary::_image_request_completed).bind(iq.queue_id)); image_queue[iq.queue_id] = iq; add_child(iq.request); _image_update(true, false, PackedByteArray(), iq.queue_id); _update_image_queue(); } void EditorAssetLibrary::_repository_changed(int p_repository_id) { _set_library_message(TTR("Loading...")); asset_top_page->hide(); asset_bottom_page->hide(); asset_items->hide(); filter->set_editable(false); sort->set_disabled(true); categories->set_disabled(true); support->set_disabled(true); host = repository->get_item_metadata(p_repository_id); if (templates_only) { _api_request("configure", REQUESTING_CONFIG, "?type=project"); } else { _api_request("configure", REQUESTING_CONFIG); } } void EditorAssetLibrary::_support_toggled(int p_support) { support->get_popup()->set_item_checked(p_support, !support->get_popup()->is_item_checked(p_support)); _search(); } void EditorAssetLibrary::_rerun_search(int p_ignore) { _search(); } void EditorAssetLibrary::_search(int p_page) { String args; if (templates_only) { args += "?type=project&"; } else { args += "?"; } args += String() + "sort=" + sort_key[sort->get_selected()]; // We use the "branch" version, i.e. major.minor, as patch releases should be compatible args += "&godot_version=" + String(VERSION_BRANCH); String support_list; for (int i = 0; i < SUPPORT_MAX; i++) { if (support->get_popup()->is_item_checked(i)) { support_list += String(support_key[i]) + "+"; } } if (!support_list.is_empty()) { args += "&support=" + support_list.substr(0, support_list.length() - 1); } if (categories->get_selected() > 0) { args += "&category=" + itos(categories->get_item_metadata(categories->get_selected())); } // Sorting options with an odd index are always the reverse of the previous one if (sort->get_selected() % 2 == 1) { args += "&reverse=true"; } if (!filter->get_text().is_empty()) { args += "&filter=" + filter->get_text().uri_encode(); } if (p_page > 0) { args += "&page=" + itos(p_page); } _api_request("asset", REQUESTING_SEARCH, args); } void EditorAssetLibrary::_search_text_changed(const String &p_text) { filter_debounce_timer->start(); } void EditorAssetLibrary::_filter_debounce_timer_timeout() { _search(); } void EditorAssetLibrary::_request_current_config() { _repository_changed(repository->get_selected()); } HBoxContainer *EditorAssetLibrary::_make_pages(int p_page, int p_page_count, int p_page_len, int p_total_items, int p_current_items) { HBoxContainer *hbc = memnew(HBoxContainer); if (p_page_count < 2) { return hbc; } //do the mario int from = p_page - (5 / EDSCALE); if (from < 0) { from = 0; } int to = from + (10 / EDSCALE); if (to > p_page_count) { to = p_page_count; } hbc->add_spacer(); hbc->add_theme_constant_override("separation", 5 * EDSCALE); Button *first = memnew(Button); first->set_text(TTR("First", "Pagination")); first->set_theme_type_variation("PanelBackgroundButton"); if (p_page != 0) { first->connect(SceneStringName(pressed), callable_mp(this, &EditorAssetLibrary::_search).bind(0)); } else { first->set_disabled(true); first->set_focus_mode(Control::FOCUS_NONE); } hbc->add_child(first); Button *prev = memnew(Button); prev->set_text(TTR("Previous", "Pagination")); prev->set_theme_type_variation("PanelBackgroundButton"); if (p_page > 0) { prev->connect(SceneStringName(pressed), callable_mp(this, &EditorAssetLibrary::_search).bind(p_page - 1)); } else { prev->set_disabled(true); prev->set_focus_mode(Control::FOCUS_NONE); } hbc->add_child(prev); hbc->add_child(memnew(VSeparator)); for (int i = from; i < to; i++) { Button *current = memnew(Button); // Add padding to make page number buttons easier to click. current->set_text(vformat(" %d ", i + 1)); current->set_theme_type_variation("PanelBackgroundButton"); if (i == p_page) { current->set_disabled(true); current->set_focus_mode(Control::FOCUS_NONE); } else { current->connect(SceneStringName(pressed), callable_mp(this, &EditorAssetLibrary::_search).bind(i)); } hbc->add_child(current); } Button *next = memnew(Button); next->set_text(TTR("Next", "Pagination")); next->set_theme_type_variation("PanelBackgroundButton"); if (p_page < p_page_count - 1) { next->connect(SceneStringName(pressed), callable_mp(this, &EditorAssetLibrary::_search).bind(p_page + 1)); } else { next->set_disabled(true); next->set_focus_mode(Control::FOCUS_NONE); } hbc->add_child(memnew(VSeparator)); hbc->add_child(next); Button *last = memnew(Button); last->set_text(TTR("Last", "Pagination")); last->set_theme_type_variation("PanelBackgroundButton"); if (p_page != p_page_count - 1) { last->connect(SceneStringName(pressed), callable_mp(this, &EditorAssetLibrary::_search).bind(p_page_count - 1)); } else { last->set_disabled(true); last->set_focus_mode(Control::FOCUS_NONE); } hbc->add_child(last); hbc->add_spacer(); return hbc; } void EditorAssetLibrary::_api_request(const String &p_request, RequestType p_request_type, const String &p_arguments) { if (requesting != REQUESTING_NONE) { request->cancel_request(); } error_hb->hide(); if (loading_blocked) { _set_library_message_with_action(TTR("The Asset Library requires an online connection and involves sending data over the internet."), TTR("Go Online"), callable_mp(this, &EditorAssetLibrary::_force_online_mode)); return; } requesting = p_request_type; request->request(host + "/" + p_request + p_arguments); } void EditorAssetLibrary::_http_request_completed(int p_status, int p_code, const PackedStringArray &headers, const PackedByteArray &p_data) { String str; { int datalen = p_data.size(); const uint8_t *r = p_data.ptr(); str.parse_utf8((const char *)r, datalen); } bool error_abort = true; switch (p_status) { case HTTPRequest::RESULT_CANT_RESOLVE: { error_label->set_text(TTR("Can't resolve hostname:") + " " + host); } break; case HTTPRequest::RESULT_BODY_SIZE_LIMIT_EXCEEDED: case HTTPRequest::RESULT_CONNECTION_ERROR: case HTTPRequest::RESULT_CHUNKED_BODY_SIZE_MISMATCH: { error_label->set_text(TTR("Connection error, please try again.")); } break; case HTTPRequest::RESULT_TLS_HANDSHAKE_ERROR: case HTTPRequest::RESULT_CANT_CONNECT: { error_label->set_text(TTR("Can't connect to host:") + " " + host); } break; case HTTPRequest::RESULT_NO_RESPONSE: { error_label->set_text(TTR("No response from host:") + " " + host); } break; case HTTPRequest::RESULT_REQUEST_FAILED: { error_label->set_text(TTR("Request failed, return code:") + " " + itos(p_code)); } break; case HTTPRequest::RESULT_REDIRECT_LIMIT_REACHED: { error_label->set_text(TTR("Request failed, too many redirects")); } break; default: { if (p_code != 200) { error_label->set_text(TTR("Request failed, return code:") + " " + itos(p_code)); } else { error_abort = false; } } break; } if (error_abort) { if (requesting == REQUESTING_CONFIG) { _set_library_message_with_action(TTR("Failed to get repository configuration."), TTR("Retry"), callable_mp(this, &EditorAssetLibrary::_request_current_config)); } error_hb->show(); return; } Dictionary d; { JSON json; json.parse(str); d = json.get_data(); } RequestType requested = requesting; requesting = REQUESTING_NONE; switch (requested) { case REQUESTING_CONFIG: { categories->clear(); categories->add_item(TTR("All")); categories->set_item_metadata(0, 0); if (d.has("categories")) { Array clist = d["categories"]; for (int i = 0; i < clist.size(); i++) { Dictionary cat = clist[i]; if (!cat.has("name") || !cat.has("id")) { continue; } String name = cat["name"]; int id = cat["id"]; categories->add_item(name); categories->set_item_metadata(-1, id); category_map[cat["id"]] = name; } } filter->set_editable(true); sort->set_disabled(false); categories->set_disabled(false); support->set_disabled(false); _search(); } break; case REQUESTING_SEARCH: { initial_loading = false; if (asset_items) { memdelete(asset_items); } if (asset_top_page) { memdelete(asset_top_page); } if (asset_bottom_page) { memdelete(asset_bottom_page); } int page = 0; int pages = 1; int page_len = 10; int total_items = 1; Array result; if (d.has("page")) { page = d["page"]; } if (d.has("pages")) { pages = d["pages"]; } if (d.has("page_length")) { page_len = d["page_length"]; } if (d.has("total")) { total_items = d["total"]; } if (d.has("result")) { result = d["result"]; } asset_top_page = _make_pages(page, pages, page_len, total_items, result.size()); library_vb->add_child(asset_top_page); asset_items = memnew(GridContainer); _update_asset_items_columns(); asset_items->add_theme_constant_override("h_separation", 10 * EDSCALE); asset_items->add_theme_constant_override("v_separation", 10 * EDSCALE); library_vb->add_child(asset_items); asset_bottom_page = _make_pages(page, pages, page_len, total_items, result.size()); library_vb->add_child(asset_bottom_page); if (result.is_empty()) { String support_list; for (int i = 0; i < SUPPORT_MAX; i++) { if (support->get_popup()->is_item_checked(i)) { if (!support_list.is_empty()) { support_list += ", "; } support_list += TTRGET(support_text[i]); } } if (support_list.is_empty()) { support_list = "-"; } if (!filter->get_text().is_empty()) { _set_library_message( vformat(TTR("No results for \"%s\" for support level(s): %s."), filter->get_text(), support_list)); } else { // No results, even though the user didn't search for anything specific. // This is typically because the version number changed recently // and no assets compatible with the new version have been published yet. _set_library_message( vformat(TTR("No results compatible with %s %s for support level(s): %s.\nCheck the enabled support levels using the 'Support' button in the top-right corner."), String(VERSION_SHORT_NAME).capitalize(), String(VERSION_BRANCH), support_list)); } } else { library_message_box->hide(); } for (int i = 0; i < result.size(); i++) { Dictionary r = result[i]; ERR_CONTINUE(!r.has("title")); ERR_CONTINUE(!r.has("asset_id")); ERR_CONTINUE(!r.has("author")); ERR_CONTINUE(!r.has("author_id")); ERR_CONTINUE(!r.has("category_id")); ERR_FAIL_COND(!category_map.has(r["category_id"])); ERR_CONTINUE(!r.has("cost")); EditorAssetLibraryItem *item = memnew(EditorAssetLibraryItem(true)); asset_items->add_child(item); item->configure(r["title"], r["asset_id"], category_map[r["category_id"]], r["category_id"], r["author"], r["author_id"], r["cost"]); item->clamp_width(asset_items_column_width); item->connect("asset_selected", callable_mp(this, &EditorAssetLibrary::_select_asset)); item->connect("author_selected", callable_mp(this, &EditorAssetLibrary::_select_author)); item->connect("category_selected", callable_mp(this, &EditorAssetLibrary::_select_category)); if (r.has("icon_url") && !r["icon_url"].operator String().is_empty()) { _request_image(item->get_instance_id(), r["asset_id"], r["icon_url"], IMAGE_QUEUE_ICON, 0); } } if (!result.is_empty()) { library_scroll->set_v_scroll(0); } } break; case REQUESTING_ASSET: { Dictionary r = d; ERR_FAIL_COND(!r.has("title")); ERR_FAIL_COND(!r.has("asset_id")); ERR_FAIL_COND(!r.has("author")); ERR_FAIL_COND(!r.has("author_id")); ERR_FAIL_COND(!r.has("version")); ERR_FAIL_COND(!r.has("version_string")); ERR_FAIL_COND(!r.has("category_id")); ERR_FAIL_COND(!category_map.has(r["category_id"])); ERR_FAIL_COND(!r.has("cost")); ERR_FAIL_COND(!r.has("description")); ERR_FAIL_COND(!r.has("download_url")); ERR_FAIL_COND(!r.has("download_hash")); ERR_FAIL_COND(!r.has("browse_url")); if (description) { memdelete(description); } description = memnew(EditorAssetLibraryItemDescription); add_child(description); description->connect(SceneStringName(confirmed), callable_mp(this, &EditorAssetLibrary::_install_asset)); description->configure(r["title"], r["asset_id"], category_map[r["category_id"]], r["category_id"], r["author"], r["author_id"], r["cost"], r["version"], r["version_string"], r["description"], r["download_url"], r["browse_url"], r["download_hash"]); EditorAssetLibraryItemDownload *download_item = _get_asset_in_progress(description->get_asset_id()); if (download_item) { if (download_item->can_install()) { description->set_ok_button_text(TTR("Install")); description->get_ok_button()->set_disabled(false); } else { description->set_ok_button_text(TTR("Downloading...")); description->get_ok_button()->set_disabled(true); } } else { description->set_ok_button_text(TTR("Download")); description->get_ok_button()->set_disabled(false); } if (r.has("icon_url") && !r["icon_url"].operator String().is_empty()) { _request_image(description->get_instance_id(), r["asset_id"], r["icon_url"], IMAGE_QUEUE_ICON, 0); } if (d.has("previews")) { Array previews = d["previews"]; for (int i = 0; i < previews.size(); i++) { Dictionary p = previews[i]; ERR_CONTINUE(!p.has("type")); ERR_CONTINUE(!p.has("link")); bool is_video = p.has("type") && String(p["type"]) == "video"; String video_url; if (is_video && p.has("link")) { video_url = p["link"]; } description->add_preview(i, is_video, video_url); if (p.has("thumbnail")) { _request_image(description->get_instance_id(), r["asset_id"], p["thumbnail"], IMAGE_QUEUE_THUMBNAIL, i); } if (!is_video) { _request_image(description->get_instance_id(), r["asset_id"], p["link"], IMAGE_QUEUE_SCREENSHOT, i); } } } description->popup_centered(); } break; default: break; } } void EditorAssetLibrary::_asset_file_selected(const String &p_file) { if (asset_installer) { memdelete(asset_installer); asset_installer = nullptr; } asset_installer = memnew(EditorAssetInstaller); asset_installer->set_asset_name(p_file); add_child(asset_installer); asset_installer->open_asset(p_file); } void EditorAssetLibrary::_asset_open() { asset_open->popup_file_dialog(); } void EditorAssetLibrary::_manage_plugins() { ProjectSettingsEditor::get_singleton()->popup_project_settings(true); ProjectSettingsEditor::get_singleton()->set_plugins_page(); } EditorAssetLibraryItemDownload *EditorAssetLibrary::_get_asset_in_progress(int p_asset_id) const { for (int i = 0; i < downloads_hb->get_child_count(); i++) { EditorAssetLibraryItemDownload *d = Object::cast_to(downloads_hb->get_child(i)); if (d && d->get_asset_id() == p_asset_id) { return d; } } return nullptr; } void EditorAssetLibrary::_install_external_asset(String p_zip_path, String p_title) { emit_signal(SNAME("install_asset"), p_zip_path, p_title); } void EditorAssetLibrary::_update_asset_items_columns() { int new_columns = get_size().x / (450.0 * EDSCALE); new_columns = MAX(1, new_columns); if (new_columns != asset_items->get_columns()) { asset_items->set_columns(new_columns); } asset_items_column_width = (get_size().x / new_columns) - (120 * EDSCALE); for (int i = 0; i < asset_items->get_child_count(); i++) { EditorAssetLibraryItem *item = Object::cast_to(asset_items->get_child(i)); if (!item || !item->is_visible()) { continue; } item->clamp_width(asset_items_column_width); } } void EditorAssetLibrary::_set_library_message(const String &p_message) { library_message->set_text(p_message); if (library_message_action.is_valid()) { library_message_button->disconnect(SceneStringName(pressed), library_message_action); library_message_action = Callable(); } library_message_button->hide(); library_message_box->show(); } void EditorAssetLibrary::_set_library_message_with_action(const String &p_message, const String &p_action_text, const Callable &p_action) { library_message->set_text(p_message); library_message_button->set_text(p_action_text); if (library_message_action.is_valid()) { library_message_button->disconnect(SceneStringName(pressed), library_message_action); library_message_action = Callable(); } library_message_action = p_action; library_message_button->connect(SceneStringName(pressed), library_message_action); library_message_button->show(); library_message_box->show(); } void EditorAssetLibrary::_force_online_mode() { EditorSettings::get_singleton()->set_setting("network/connection/network_mode", EditorSettings::NETWORK_ONLINE); EditorSettings::get_singleton()->notify_changes(); EditorSettings::get_singleton()->save(); } void EditorAssetLibrary::disable_community_support() { support->get_popup()->set_item_checked(SUPPORT_COMMUNITY, false); } void EditorAssetLibrary::_bind_methods() { ADD_SIGNAL(MethodInfo("install_asset", PropertyInfo(Variant::STRING, "zip_path"), PropertyInfo(Variant::STRING, "name"))); } EditorAssetLibrary::EditorAssetLibrary(bool p_templates_only) { requesting = REQUESTING_NONE; templates_only = p_templates_only; loading_blocked = ((int)EDITOR_GET("network/connection/network_mode") == EditorSettings::NETWORK_OFFLINE); VBoxContainer *library_main = memnew(VBoxContainer); add_child(library_main); HBoxContainer *search_hb = memnew(HBoxContainer); library_main->add_child(search_hb); library_main->add_theme_constant_override("separation", 10 * EDSCALE); filter = memnew(LineEdit); if (templates_only) { filter->set_placeholder(TTR("Search Templates, Projects, and Demos")); } else { filter->set_placeholder(TTR("Search Assets (Excluding Templates, Projects, and Demos)")); } filter->set_clear_button_enabled(true); search_hb->add_child(filter); filter->set_h_size_flags(Control::SIZE_EXPAND_FILL); filter->connect(SceneStringName(text_changed), callable_mp(this, &EditorAssetLibrary::_search_text_changed)); // Perform a search automatically if the user hasn't entered any text for a certain duration. // This way, the user doesn't need to press Enter to initiate their search. filter_debounce_timer = memnew(Timer); filter_debounce_timer->set_one_shot(true); filter_debounce_timer->set_wait_time(0.25); filter_debounce_timer->connect("timeout", callable_mp(this, &EditorAssetLibrary::_filter_debounce_timer_timeout)); search_hb->add_child(filter_debounce_timer); if (!p_templates_only) { search_hb->add_child(memnew(VSeparator)); } Button *open_asset = memnew(Button); open_asset->set_text(TTR("Import...")); search_hb->add_child(open_asset); open_asset->connect(SceneStringName(pressed), callable_mp(this, &EditorAssetLibrary::_asset_open)); Button *plugins = memnew(Button); plugins->set_text(TTR("Plugins...")); search_hb->add_child(plugins); plugins->connect(SceneStringName(pressed), callable_mp(this, &EditorAssetLibrary::_manage_plugins)); if (p_templates_only) { open_asset->hide(); plugins->hide(); } HBoxContainer *search_hb2 = memnew(HBoxContainer); library_main->add_child(search_hb2); search_hb2->add_child(memnew(Label(TTR("Sort:") + " "))); sort = memnew(OptionButton); for (int i = 0; i < SORT_MAX; i++) { sort->add_item(TTRGET(sort_text[i])); } search_hb2->add_child(sort); sort->set_h_size_flags(Control::SIZE_EXPAND_FILL); sort->set_clip_text(true); sort->connect(SceneStringName(item_selected), callable_mp(this, &EditorAssetLibrary::_rerun_search)); search_hb2->add_child(memnew(VSeparator)); search_hb2->add_child(memnew(Label(TTR("Category:") + " "))); categories = memnew(OptionButton); categories->add_item(TTR("All")); search_hb2->add_child(categories); categories->set_h_size_flags(Control::SIZE_EXPAND_FILL); categories->set_clip_text(true); categories->connect(SceneStringName(item_selected), callable_mp(this, &EditorAssetLibrary::_rerun_search)); search_hb2->add_child(memnew(VSeparator)); search_hb2->add_child(memnew(Label(TTR("Site:") + " "))); repository = memnew(OptionButton); _update_repository_options(); repository->connect(SceneStringName(item_selected), callable_mp(this, &EditorAssetLibrary::_repository_changed)); search_hb2->add_child(repository); repository->set_h_size_flags(Control::SIZE_EXPAND_FILL); repository->set_clip_text(true); search_hb2->add_child(memnew(VSeparator)); support = memnew(MenuButton); search_hb2->add_child(support); support->set_text(TTR("Support")); support->get_popup()->set_hide_on_checkable_item_selection(false); support->get_popup()->add_check_item(TTRGET(support_text[SUPPORT_FEATURED]), SUPPORT_FEATURED); support->get_popup()->add_check_item(TTRGET(support_text[SUPPORT_COMMUNITY]), SUPPORT_COMMUNITY); support->get_popup()->add_check_item(TTRGET(support_text[SUPPORT_TESTING]), SUPPORT_TESTING); support->get_popup()->set_item_checked(SUPPORT_FEATURED, true); support->get_popup()->set_item_checked(SUPPORT_COMMUNITY, true); support->get_popup()->connect(SceneStringName(id_pressed), callable_mp(this, &EditorAssetLibrary::_support_toggled)); ///////// library_scroll_bg = memnew(PanelContainer); library_main->add_child(library_scroll_bg); library_scroll_bg->set_v_size_flags(Control::SIZE_EXPAND_FILL); library_scroll = memnew(ScrollContainer); library_scroll->set_horizontal_scroll_mode(ScrollContainer::SCROLL_MODE_DISABLED); library_scroll_bg->add_child(library_scroll); Ref border2; border2.instantiate(); border2->set_content_margin_individual(15 * EDSCALE, 15 * EDSCALE, 35 * EDSCALE, 15 * EDSCALE); PanelContainer *library_vb_border = memnew(PanelContainer); library_scroll->add_child(library_vb_border); library_vb_border->add_theme_style_override(SceneStringName(panel), border2); library_vb_border->set_h_size_flags(Control::SIZE_EXPAND_FILL); library_vb = memnew(VBoxContainer); library_vb->set_h_size_flags(Control::SIZE_EXPAND_FILL); library_vb_border->add_child(library_vb); library_message_box = memnew(VBoxContainer); library_message_box->hide(); library_vb->add_child(library_message_box); library_message = memnew(Label); library_message->set_horizontal_alignment(HORIZONTAL_ALIGNMENT_CENTER); library_message_box->add_child(library_message); library_message_button = memnew(Button); library_message_button->set_h_size_flags(SIZE_SHRINK_CENTER); library_message_button->set_theme_type_variation("PanelBackgroundButton"); library_message_box->add_child(library_message_button); asset_top_page = memnew(HBoxContainer); library_vb->add_child(asset_top_page); asset_items = memnew(GridContainer); _update_asset_items_columns(); asset_items->add_theme_constant_override("h_separation", 10 * EDSCALE); asset_items->add_theme_constant_override("v_separation", 10 * EDSCALE); library_vb->add_child(asset_items); asset_bottom_page = memnew(HBoxContainer); library_vb->add_child(asset_bottom_page); request = memnew(HTTPRequest); add_child(request); setup_http_request(request); request->connect("request_completed", callable_mp(this, &EditorAssetLibrary::_http_request_completed)); last_queue_id = 0; library_vb->add_theme_constant_override("separation", 20 * EDSCALE); error_hb = memnew(HBoxContainer); library_main->add_child(error_hb); error_label = memnew(Label); error_hb->add_child(error_label); error_tr = memnew(TextureRect); error_tr->set_v_size_flags(Control::SIZE_SHRINK_CENTER); error_hb->add_child(error_tr); description = nullptr; set_process(true); set_process_shortcut_input(true); // Global shortcuts since there is no main element to be focused. downloads_scroll = memnew(ScrollContainer); downloads_scroll->set_vertical_scroll_mode(ScrollContainer::SCROLL_MODE_DISABLED); library_main->add_child(downloads_scroll); downloads_hb = memnew(HBoxContainer); downloads_scroll->add_child(downloads_hb); asset_open = memnew(EditorFileDialog); asset_open->set_access(EditorFileDialog::ACCESS_FILESYSTEM); asset_open->add_filter("*.zip", TTR("Assets ZIP File")); asset_open->set_file_mode(EditorFileDialog::FILE_MODE_OPEN_FILE); add_child(asset_open); asset_open->connect("file_selected", callable_mp(this, &EditorAssetLibrary::_asset_file_selected)); asset_installer = nullptr; } /////// bool AssetLibraryEditorPlugin::is_available() { #ifdef WEB_ENABLED // Asset Library can't work on Web editor for now as most assets are sourced // directly from GitHub which does not set CORS. return false; #else return StreamPeerTLS::is_available(); #endif } void AssetLibraryEditorPlugin::make_visible(bool p_visible) { if (p_visible) { addon_library->show(); } else { addon_library->hide(); } } AssetLibraryEditorPlugin::AssetLibraryEditorPlugin() { addon_library = memnew(EditorAssetLibrary); addon_library->set_v_size_flags(Control::SIZE_EXPAND_FILL); EditorNode::get_singleton()->get_editor_main_screen()->get_control()->add_child(addon_library); addon_library->set_anchors_and_offsets_preset(Control::PRESET_FULL_RECT); addon_library->hide(); } AssetLibraryEditorPlugin::~AssetLibraryEditorPlugin() { }