export_template_manager.cpp 35 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003
  1. /**************************************************************************/
  2. /* export_template_manager.cpp */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #include "export_template_manager.h"
  31. #include "core/io/dir_access.h"
  32. #include "core/io/json.h"
  33. #include "core/io/zip_io.h"
  34. #include "core/version.h"
  35. #include "editor/editor_node.h"
  36. #include "editor/editor_paths.h"
  37. #include "editor/editor_scale.h"
  38. #include "editor/editor_settings.h"
  39. #include "editor/editor_string_names.h"
  40. #include "editor/progress_dialog.h"
  41. #include "scene/gui/file_dialog.h"
  42. #include "scene/gui/menu_button.h"
  43. #include "scene/gui/separator.h"
  44. #include "scene/gui/tree.h"
  45. #include "scene/main/http_request.h"
  46. void ExportTemplateManager::_update_template_status() {
  47. // Fetch installed templates from the file system.
  48. Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  49. const String &templates_dir = EditorPaths::get_singleton()->get_export_templates_dir();
  50. Error err = da->change_dir(templates_dir);
  51. ERR_FAIL_COND_MSG(err != OK, "Could not access templates directory at '" + templates_dir + "'.");
  52. RBSet<String> templates;
  53. da->list_dir_begin();
  54. if (err == OK) {
  55. String c = da->get_next();
  56. while (!c.is_empty()) {
  57. if (da->current_is_dir() && !c.begins_with(".")) {
  58. templates.insert(c);
  59. }
  60. c = da->get_next();
  61. }
  62. }
  63. da->list_dir_end();
  64. // Update the state of the current version.
  65. String current_version = VERSION_FULL_CONFIG;
  66. current_value->set_text(current_version);
  67. if (templates.has(current_version)) {
  68. current_missing_label->hide();
  69. current_installed_label->show();
  70. current_installed_hb->show();
  71. current_version_exists = true;
  72. } else {
  73. current_installed_label->hide();
  74. current_missing_label->show();
  75. current_installed_hb->hide();
  76. current_version_exists = false;
  77. }
  78. if (is_downloading_templates) {
  79. install_options_vb->hide();
  80. download_progress_hb->show();
  81. } else {
  82. download_progress_hb->hide();
  83. install_options_vb->show();
  84. if (templates.has(current_version)) {
  85. current_installed_path->set_text(templates_dir.path_join(current_version));
  86. }
  87. }
  88. // Update the list of other installed versions.
  89. installed_table->clear();
  90. TreeItem *installed_root = installed_table->create_item();
  91. for (RBSet<String>::Element *E = templates.back(); E; E = E->prev()) {
  92. String version_string = E->get();
  93. if (version_string == current_version) {
  94. continue;
  95. }
  96. TreeItem *ti = installed_table->create_item(installed_root);
  97. ti->set_text(0, version_string);
  98. ti->add_button(0, get_editor_theme_icon(SNAME("Folder")), OPEN_TEMPLATE_FOLDER, false, TTR("Open the folder containing these templates."));
  99. ti->add_button(0, get_editor_theme_icon(SNAME("Remove")), UNINSTALL_TEMPLATE, false, TTR("Uninstall these templates."));
  100. }
  101. }
  102. void ExportTemplateManager::_download_current() {
  103. if (is_downloading_templates) {
  104. return;
  105. }
  106. is_downloading_templates = true;
  107. install_options_vb->hide();
  108. download_progress_hb->show();
  109. if (mirrors_available) {
  110. String mirror_url = _get_selected_mirror();
  111. if (mirror_url.is_empty()) {
  112. _set_current_progress_status(TTR("There are no mirrors available."), true);
  113. return;
  114. }
  115. _download_template(mirror_url, true);
  116. } else if (!is_refreshing_mirrors) {
  117. _set_current_progress_status(TTR("Retrieving the mirror list..."));
  118. _refresh_mirrors();
  119. }
  120. }
  121. void ExportTemplateManager::_download_template(const String &p_url, bool p_skip_check) {
  122. if (!p_skip_check && is_downloading_templates) {
  123. return;
  124. }
  125. is_downloading_templates = true;
  126. install_options_vb->hide();
  127. download_progress_hb->show();
  128. _set_current_progress_status(TTR("Starting the download..."));
  129. download_templates->set_download_file(EditorPaths::get_singleton()->get_cache_dir().path_join("tmp_templates.tpz"));
  130. download_templates->set_use_threads(true);
  131. const String proxy_host = EDITOR_GET("network/http_proxy/host");
  132. const int proxy_port = EDITOR_GET("network/http_proxy/port");
  133. download_templates->set_http_proxy(proxy_host, proxy_port);
  134. download_templates->set_https_proxy(proxy_host, proxy_port);
  135. Error err = download_templates->request(p_url);
  136. if (err != OK) {
  137. _set_current_progress_status(TTR("Error requesting URL:") + " " + p_url, true);
  138. return;
  139. }
  140. set_process(true);
  141. _set_current_progress_status(TTR("Connecting to the mirror..."));
  142. }
  143. void ExportTemplateManager::_download_template_completed(int p_status, int p_code, const PackedStringArray &headers, const PackedByteArray &p_data) {
  144. switch (p_status) {
  145. case HTTPRequest::RESULT_CANT_RESOLVE: {
  146. _set_current_progress_status(TTR("Can't resolve the requested address."), true);
  147. } break;
  148. case HTTPRequest::RESULT_BODY_SIZE_LIMIT_EXCEEDED:
  149. case HTTPRequest::RESULT_CONNECTION_ERROR:
  150. case HTTPRequest::RESULT_CHUNKED_BODY_SIZE_MISMATCH:
  151. case HTTPRequest::RESULT_TLS_HANDSHAKE_ERROR:
  152. case HTTPRequest::RESULT_CANT_CONNECT: {
  153. _set_current_progress_status(TTR("Can't connect to the mirror."), true);
  154. } break;
  155. case HTTPRequest::RESULT_NO_RESPONSE: {
  156. _set_current_progress_status(TTR("No response from the mirror."), true);
  157. } break;
  158. case HTTPRequest::RESULT_REQUEST_FAILED: {
  159. _set_current_progress_status(TTR("Request failed."), true);
  160. } break;
  161. case HTTPRequest::RESULT_REDIRECT_LIMIT_REACHED: {
  162. _set_current_progress_status(TTR("Request ended up in a redirect loop."), true);
  163. } break;
  164. default: {
  165. if (p_code != 200) {
  166. _set_current_progress_status(TTR("Request failed:") + " " + itos(p_code), true);
  167. } else {
  168. _set_current_progress_status(TTR("Download complete; extracting templates..."));
  169. String path = download_templates->get_download_file();
  170. is_downloading_templates = false;
  171. bool ret = _install_file_selected(path, true);
  172. if (ret) {
  173. // Clean up downloaded file.
  174. Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  175. Error err = da->remove(path);
  176. if (err != OK) {
  177. EditorNode::get_singleton()->add_io_error(TTR("Cannot remove temporary file:") + "\n" + path + "\n");
  178. }
  179. } else {
  180. EditorNode::get_singleton()->add_io_error(vformat(TTR("Templates installation failed.\nThe problematic templates archives can be found at '%s'."), path));
  181. }
  182. }
  183. } break;
  184. }
  185. set_process(false);
  186. }
  187. void ExportTemplateManager::_cancel_template_download() {
  188. if (!is_downloading_templates) {
  189. return;
  190. }
  191. download_templates->cancel_request();
  192. download_progress_hb->hide();
  193. install_options_vb->show();
  194. is_downloading_templates = false;
  195. }
  196. void ExportTemplateManager::_refresh_mirrors() {
  197. if (is_refreshing_mirrors) {
  198. return;
  199. }
  200. is_refreshing_mirrors = true;
  201. String current_version = VERSION_FULL_CONFIG;
  202. const String mirrors_metadata_url = "https://godotengine.org/mirrorlist/" + current_version + ".json";
  203. request_mirrors->request(mirrors_metadata_url);
  204. }
  205. void ExportTemplateManager::_refresh_mirrors_completed(int p_status, int p_code, const PackedStringArray &headers, const PackedByteArray &p_data) {
  206. if (p_status != HTTPRequest::RESULT_SUCCESS || p_code != 200) {
  207. EditorNode::get_singleton()->show_warning(TTR("Error getting the list of mirrors."));
  208. is_refreshing_mirrors = false;
  209. if (is_downloading_templates) {
  210. _cancel_template_download();
  211. }
  212. return;
  213. }
  214. String response_json;
  215. {
  216. const uint8_t *r = p_data.ptr();
  217. response_json.parse_utf8((const char *)r, p_data.size());
  218. }
  219. JSON json;
  220. Error err = json.parse(response_json);
  221. if (err != OK) {
  222. EditorNode::get_singleton()->show_warning(TTR("Error parsing JSON with the list of mirrors. Please report this issue!"));
  223. is_refreshing_mirrors = false;
  224. if (is_downloading_templates) {
  225. _cancel_template_download();
  226. }
  227. return;
  228. }
  229. mirrors_list->clear();
  230. mirrors_list->add_item(TTR("Best available mirror"), 0);
  231. mirrors_available = false;
  232. Dictionary mirror_data = json.get_data();
  233. if (mirror_data.has("mirrors")) {
  234. Array mirrors = mirror_data["mirrors"];
  235. for (int i = 0; i < mirrors.size(); i++) {
  236. Dictionary m = mirrors[i];
  237. ERR_CONTINUE(!m.has("url") || !m.has("name"));
  238. mirrors_list->add_item(m["name"]);
  239. mirrors_list->set_item_metadata(i + 1, m["url"]);
  240. mirrors_available = true;
  241. }
  242. }
  243. if (!mirrors_available) {
  244. EditorNode::get_singleton()->show_warning(TTR("No download links found for this version. Direct download is only available for official releases."));
  245. if (is_downloading_templates) {
  246. _cancel_template_download();
  247. }
  248. }
  249. is_refreshing_mirrors = false;
  250. if (is_downloading_templates) {
  251. String mirror_url = _get_selected_mirror();
  252. if (mirror_url.is_empty()) {
  253. _set_current_progress_status(TTR("There are no mirrors available."), true);
  254. return;
  255. }
  256. _download_template(mirror_url, true);
  257. }
  258. }
  259. bool ExportTemplateManager::_humanize_http_status(HTTPRequest *p_request, String *r_status, int *r_downloaded_bytes, int *r_total_bytes) {
  260. *r_status = "";
  261. *r_downloaded_bytes = -1;
  262. *r_total_bytes = -1;
  263. bool success = true;
  264. switch (p_request->get_http_client_status()) {
  265. case HTTPClient::STATUS_DISCONNECTED:
  266. *r_status = TTR("Disconnected");
  267. success = false;
  268. break;
  269. case HTTPClient::STATUS_RESOLVING:
  270. *r_status = TTR("Resolving");
  271. break;
  272. case HTTPClient::STATUS_CANT_RESOLVE:
  273. *r_status = TTR("Can't Resolve");
  274. success = false;
  275. break;
  276. case HTTPClient::STATUS_CONNECTING:
  277. *r_status = TTR("Connecting...");
  278. break;
  279. case HTTPClient::STATUS_CANT_CONNECT:
  280. *r_status = TTR("Can't Connect");
  281. success = false;
  282. break;
  283. case HTTPClient::STATUS_CONNECTED:
  284. *r_status = TTR("Connected");
  285. break;
  286. case HTTPClient::STATUS_REQUESTING:
  287. *r_status = TTR("Requesting...");
  288. break;
  289. case HTTPClient::STATUS_BODY:
  290. *r_status = TTR("Downloading");
  291. *r_downloaded_bytes = p_request->get_downloaded_bytes();
  292. *r_total_bytes = p_request->get_body_size();
  293. if (p_request->get_body_size() > 0) {
  294. *r_status += " " + String::humanize_size(p_request->get_downloaded_bytes()) + "/" + String::humanize_size(p_request->get_body_size());
  295. } else {
  296. *r_status += " " + String::humanize_size(p_request->get_downloaded_bytes());
  297. }
  298. break;
  299. case HTTPClient::STATUS_CONNECTION_ERROR:
  300. *r_status = TTR("Connection Error");
  301. success = false;
  302. break;
  303. case HTTPClient::STATUS_TLS_HANDSHAKE_ERROR:
  304. *r_status = TTR("TLS Handshake Error");
  305. success = false;
  306. break;
  307. }
  308. return success;
  309. }
  310. void ExportTemplateManager::_set_current_progress_status(const String &p_status, bool p_error) {
  311. download_progress_bar->hide();
  312. download_progress_label->set_text(p_status);
  313. if (p_error) {
  314. download_progress_label->add_theme_color_override("font_color", get_theme_color(SNAME("error_color"), EditorStringName(Editor)));
  315. } else {
  316. download_progress_label->add_theme_color_override("font_color", get_theme_color(SNAME("font_color"), SNAME("Label")));
  317. }
  318. }
  319. void ExportTemplateManager::_set_current_progress_value(float p_value, const String &p_status) {
  320. download_progress_bar->show();
  321. download_progress_bar->set_value(p_value);
  322. download_progress_label->set_text(p_status);
  323. }
  324. void ExportTemplateManager::_install_file() {
  325. install_file_dialog->popup_file_dialog();
  326. }
  327. bool ExportTemplateManager::_install_file_selected(const String &p_file, bool p_skip_progress) {
  328. Ref<FileAccess> io_fa;
  329. zlib_filefunc_def io = zipio_create_io(&io_fa);
  330. unzFile pkg = unzOpen2(p_file.utf8().get_data(), &io);
  331. if (!pkg) {
  332. EditorNode::get_singleton()->show_warning(TTR("Can't open the export templates file."));
  333. return false;
  334. }
  335. int ret = unzGoToFirstFile(pkg);
  336. // Count them and find version.
  337. int fc = 0;
  338. String version;
  339. String contents_dir;
  340. while (ret == UNZ_OK) {
  341. unz_file_info info;
  342. char fname[16384];
  343. ret = unzGetCurrentFileInfo(pkg, &info, fname, 16384, nullptr, 0, nullptr, 0);
  344. if (ret != UNZ_OK) {
  345. break;
  346. }
  347. String file = String::utf8(fname);
  348. if (file.ends_with("version.txt")) {
  349. Vector<uint8_t> uncomp_data;
  350. uncomp_data.resize(info.uncompressed_size);
  351. // Read.
  352. unzOpenCurrentFile(pkg);
  353. ret = unzReadCurrentFile(pkg, uncomp_data.ptrw(), uncomp_data.size());
  354. ERR_BREAK_MSG(ret < 0, vformat("An error occurred while attempting to read from file: %s. This file will not be used.", file));
  355. unzCloseCurrentFile(pkg);
  356. String data_str;
  357. data_str.parse_utf8((const char *)uncomp_data.ptr(), uncomp_data.size());
  358. data_str = data_str.strip_edges();
  359. // Version number should be of the form major.minor[.patch].status[.module_config]
  360. // so it can in theory have 3 or more slices.
  361. if (data_str.get_slice_count(".") < 3) {
  362. EditorNode::get_singleton()->show_warning(vformat(TTR("Invalid version.txt format inside the export templates file: %s."), data_str));
  363. unzClose(pkg);
  364. return false;
  365. }
  366. version = data_str;
  367. contents_dir = file.get_base_dir().trim_suffix("/").trim_suffix("\\");
  368. }
  369. if (file.get_file().size() != 0) {
  370. fc++;
  371. }
  372. ret = unzGoToNextFile(pkg);
  373. }
  374. if (version.is_empty()) {
  375. EditorNode::get_singleton()->show_warning(TTR("No version.txt found inside the export templates file."));
  376. unzClose(pkg);
  377. return false;
  378. }
  379. Ref<DirAccess> d = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  380. String template_path = EditorPaths::get_singleton()->get_export_templates_dir().path_join(version);
  381. Error err = d->make_dir_recursive(template_path);
  382. if (err != OK) {
  383. EditorNode::get_singleton()->show_warning(TTR("Error creating path for extracting templates:") + "\n" + template_path);
  384. unzClose(pkg);
  385. return false;
  386. }
  387. EditorProgress *p = nullptr;
  388. if (!p_skip_progress) {
  389. p = memnew(EditorProgress("ltask", TTR("Extracting Export Templates"), fc));
  390. }
  391. fc = 0;
  392. ret = unzGoToFirstFile(pkg);
  393. while (ret == UNZ_OK) {
  394. // Get filename.
  395. unz_file_info info;
  396. char fname[16384];
  397. ret = unzGetCurrentFileInfo(pkg, &info, fname, 16384, nullptr, 0, nullptr, 0);
  398. if (ret != UNZ_OK) {
  399. break;
  400. }
  401. String file_path(String::utf8(fname).simplify_path());
  402. String file = file_path.get_file();
  403. if (file.size() == 0) {
  404. ret = unzGoToNextFile(pkg);
  405. continue;
  406. }
  407. Vector<uint8_t> uncomp_data;
  408. uncomp_data.resize(info.uncompressed_size);
  409. // Read
  410. unzOpenCurrentFile(pkg);
  411. ret = unzReadCurrentFile(pkg, uncomp_data.ptrw(), uncomp_data.size());
  412. ERR_BREAK_MSG(ret < 0, vformat("An error occurred while attempting to read from file: %s. This file will not be used.", file));
  413. unzCloseCurrentFile(pkg);
  414. String base_dir = file_path.get_base_dir().trim_suffix("/");
  415. if (base_dir != contents_dir && base_dir.begins_with(contents_dir)) {
  416. base_dir = base_dir.substr(contents_dir.length(), file_path.length()).trim_prefix("/");
  417. file = base_dir.path_join(file);
  418. Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  419. ERR_CONTINUE(da.is_null());
  420. String output_dir = template_path.path_join(base_dir);
  421. if (!DirAccess::exists(output_dir)) {
  422. Error mkdir_err = da->make_dir_recursive(output_dir);
  423. ERR_CONTINUE(mkdir_err != OK);
  424. }
  425. }
  426. if (p) {
  427. p->step(TTR("Importing:") + " " + file, fc);
  428. }
  429. String to_write = template_path.path_join(file);
  430. Ref<FileAccess> f = FileAccess::open(to_write, FileAccess::WRITE);
  431. if (f.is_null()) {
  432. ret = unzGoToNextFile(pkg);
  433. fc++;
  434. ERR_CONTINUE_MSG(true, "Can't open file from path '" + String(to_write) + "'.");
  435. }
  436. f->store_buffer(uncomp_data.ptr(), uncomp_data.size());
  437. f.unref(); // close file.
  438. #ifndef WINDOWS_ENABLED
  439. FileAccess::set_unix_permissions(to_write, (info.external_fa >> 16) & 0x01FF);
  440. #endif
  441. ret = unzGoToNextFile(pkg);
  442. fc++;
  443. }
  444. if (p) {
  445. memdelete(p);
  446. }
  447. unzClose(pkg);
  448. _update_template_status();
  449. EditorSettings::get_singleton()->set_meta("export_template_download_directory", p_file.get_base_dir());
  450. return true;
  451. }
  452. void ExportTemplateManager::_uninstall_template(const String &p_version) {
  453. uninstall_confirm->set_text(vformat(TTR("Remove templates for the version '%s'?"), p_version));
  454. uninstall_confirm->popup_centered();
  455. uninstall_version = p_version;
  456. }
  457. void ExportTemplateManager::_uninstall_template_confirmed() {
  458. Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  459. const String &templates_dir = EditorPaths::get_singleton()->get_export_templates_dir();
  460. Error err = da->change_dir(templates_dir);
  461. ERR_FAIL_COND_MSG(err != OK, "Could not access templates directory at '" + templates_dir + "'.");
  462. err = da->change_dir(uninstall_version);
  463. ERR_FAIL_COND_MSG(err != OK, "Could not access templates directory at '" + templates_dir.path_join(uninstall_version) + "'.");
  464. err = da->erase_contents_recursive();
  465. ERR_FAIL_COND_MSG(err != OK, "Could not remove all templates in '" + templates_dir.path_join(uninstall_version) + "'.");
  466. da->change_dir("..");
  467. err = da->remove(uninstall_version);
  468. ERR_FAIL_COND_MSG(err != OK, "Could not remove templates directory at '" + templates_dir.path_join(uninstall_version) + "'.");
  469. _update_template_status();
  470. }
  471. String ExportTemplateManager::_get_selected_mirror() const {
  472. if (mirrors_list->get_item_count() == 1) {
  473. return "";
  474. }
  475. int selected = mirrors_list->get_selected_id();
  476. if (selected == 0) {
  477. // This is a special "best available" value; so pick the first available mirror from the rest of the list.
  478. selected = 1;
  479. }
  480. return mirrors_list->get_item_metadata(selected);
  481. }
  482. void ExportTemplateManager::_mirror_options_button_cbk(int p_id) {
  483. switch (p_id) {
  484. case VISIT_WEB_MIRROR: {
  485. String mirror_url = _get_selected_mirror();
  486. if (mirror_url.is_empty()) {
  487. EditorNode::get_singleton()->show_warning(TTR("There are no mirrors available."));
  488. return;
  489. }
  490. OS::get_singleton()->shell_open(mirror_url);
  491. } break;
  492. case COPY_MIRROR_URL: {
  493. String mirror_url = _get_selected_mirror();
  494. if (mirror_url.is_empty()) {
  495. EditorNode::get_singleton()->show_warning(TTR("There are no mirrors available."));
  496. return;
  497. }
  498. DisplayServer::get_singleton()->clipboard_set(mirror_url);
  499. } break;
  500. }
  501. }
  502. void ExportTemplateManager::_installed_table_button_cbk(Object *p_item, int p_column, int p_id, MouseButton p_button) {
  503. if (p_button != MouseButton::LEFT) {
  504. return;
  505. }
  506. TreeItem *ti = Object::cast_to<TreeItem>(p_item);
  507. if (!ti) {
  508. return;
  509. }
  510. switch (p_id) {
  511. case OPEN_TEMPLATE_FOLDER: {
  512. String version_string = ti->get_text(0);
  513. _open_template_folder(version_string);
  514. } break;
  515. case UNINSTALL_TEMPLATE: {
  516. String version_string = ti->get_text(0);
  517. _uninstall_template(version_string);
  518. } break;
  519. }
  520. }
  521. void ExportTemplateManager::_open_template_folder(const String &p_version) {
  522. const String &templates_dir = EditorPaths::get_singleton()->get_export_templates_dir();
  523. OS::get_singleton()->shell_show_in_file_manager(templates_dir.path_join(p_version), true);
  524. }
  525. void ExportTemplateManager::popup_manager() {
  526. _update_template_status();
  527. _refresh_mirrors();
  528. popup_centered(Size2(720, 280) * EDSCALE);
  529. }
  530. void ExportTemplateManager::ok_pressed() {
  531. if (!is_downloading_templates) {
  532. hide();
  533. return;
  534. }
  535. hide_dialog_accept->popup_centered();
  536. }
  537. void ExportTemplateManager::_hide_dialog() {
  538. hide();
  539. }
  540. bool ExportTemplateManager::can_install_android_template() {
  541. const String templates_dir = EditorPaths::get_singleton()->get_export_templates_dir().path_join(VERSION_FULL_CONFIG);
  542. return FileAccess::exists(templates_dir.path_join("android_source.zip"));
  543. }
  544. Error ExportTemplateManager::install_android_template() {
  545. const String &templates_path = EditorPaths::get_singleton()->get_export_templates_dir().path_join(VERSION_FULL_CONFIG);
  546. const String &source_zip = templates_path.path_join("android_source.zip");
  547. ERR_FAIL_COND_V(!FileAccess::exists(source_zip), ERR_CANT_OPEN);
  548. return install_android_template_from_file(source_zip);
  549. }
  550. Error ExportTemplateManager::install_android_template_from_file(const String &p_file) {
  551. // To support custom Android builds, we install the Java source code and buildsystem
  552. // from android_source.zip to the project's res://android folder.
  553. Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  554. ERR_FAIL_COND_V(da.is_null(), ERR_CANT_CREATE);
  555. // Make res://android dir (if it does not exist).
  556. da->make_dir("android");
  557. {
  558. // Add version, to ensure building won't work if template and Godot version don't match.
  559. Ref<FileAccess> f = FileAccess::open("res://android/.build_version", FileAccess::WRITE);
  560. ERR_FAIL_COND_V(f.is_null(), ERR_CANT_CREATE);
  561. f->store_line(VERSION_FULL_CONFIG);
  562. }
  563. // Create the android build directory.
  564. Error err = da->make_dir_recursive("android/build");
  565. ERR_FAIL_COND_V(err != OK, err);
  566. {
  567. // Add an empty .gdignore file to avoid scan.
  568. Ref<FileAccess> f = FileAccess::open("res://android/build/.gdignore", FileAccess::WRITE);
  569. ERR_FAIL_COND_V(f.is_null(), ERR_CANT_CREATE);
  570. f->store_line("");
  571. }
  572. // Uncompress source template.
  573. Ref<FileAccess> io_fa;
  574. zlib_filefunc_def io = zipio_create_io(&io_fa);
  575. unzFile pkg = unzOpen2(p_file.utf8().get_data(), &io);
  576. ERR_FAIL_NULL_V_MSG(pkg, ERR_CANT_OPEN, "Android sources not in ZIP format.");
  577. int ret = unzGoToFirstFile(pkg);
  578. int total_files = 0;
  579. // Count files to unzip.
  580. while (ret == UNZ_OK) {
  581. total_files++;
  582. ret = unzGoToNextFile(pkg);
  583. }
  584. ret = unzGoToFirstFile(pkg);
  585. ProgressDialog::get_singleton()->add_task("uncompress_src", TTR("Uncompressing Android Build Sources"), total_files);
  586. HashSet<String> dirs_tested;
  587. int idx = 0;
  588. while (ret == UNZ_OK) {
  589. // Get file path.
  590. unz_file_info info;
  591. char fpath[16384];
  592. ret = unzGetCurrentFileInfo(pkg, &info, fpath, 16384, nullptr, 0, nullptr, 0);
  593. if (ret != UNZ_OK) {
  594. break;
  595. }
  596. String path = String::utf8(fpath);
  597. String base_dir = path.get_base_dir();
  598. if (!path.ends_with("/")) {
  599. Vector<uint8_t> uncomp_data;
  600. uncomp_data.resize(info.uncompressed_size);
  601. // Read.
  602. unzOpenCurrentFile(pkg);
  603. unzReadCurrentFile(pkg, uncomp_data.ptrw(), uncomp_data.size());
  604. unzCloseCurrentFile(pkg);
  605. if (!dirs_tested.has(base_dir)) {
  606. da->make_dir_recursive(String("android/build").path_join(base_dir));
  607. dirs_tested.insert(base_dir);
  608. }
  609. String to_write = String("res://android/build").path_join(path);
  610. Ref<FileAccess> f = FileAccess::open(to_write, FileAccess::WRITE);
  611. if (f.is_valid()) {
  612. f->store_buffer(uncomp_data.ptr(), uncomp_data.size());
  613. f.unref(); // close file.
  614. #ifndef WINDOWS_ENABLED
  615. FileAccess::set_unix_permissions(to_write, (info.external_fa >> 16) & 0x01FF);
  616. #endif
  617. } else {
  618. ERR_PRINT("Can't uncompress file: " + to_write);
  619. }
  620. }
  621. ProgressDialog::get_singleton()->task_step("uncompress_src", path, idx);
  622. idx++;
  623. ret = unzGoToNextFile(pkg);
  624. }
  625. ProgressDialog::get_singleton()->end_task("uncompress_src");
  626. unzClose(pkg);
  627. return OK;
  628. }
  629. void ExportTemplateManager::_notification(int p_what) {
  630. switch (p_what) {
  631. case NOTIFICATION_ENTER_TREE:
  632. case NOTIFICATION_THEME_CHANGED: {
  633. current_value->add_theme_font_override("font", get_theme_font(SNAME("main"), EditorStringName(EditorFonts)));
  634. current_missing_label->add_theme_color_override("font_color", get_theme_color(SNAME("error_color"), EditorStringName(Editor)));
  635. current_installed_label->add_theme_color_override("font_color", get_theme_color(SNAME("disabled_font_color"), EditorStringName(Editor)));
  636. mirror_options_button->set_icon(get_editor_theme_icon(SNAME("GuiTabMenuHl")));
  637. } break;
  638. case NOTIFICATION_VISIBILITY_CHANGED: {
  639. if (!is_visible()) {
  640. set_process(false);
  641. } else if (is_visible() && is_downloading_templates) {
  642. set_process(true);
  643. }
  644. } break;
  645. case NOTIFICATION_PROCESS: {
  646. update_countdown -= get_process_delta_time();
  647. if (update_countdown > 0) {
  648. return;
  649. }
  650. update_countdown = 0.5;
  651. String status;
  652. int downloaded_bytes;
  653. int total_bytes;
  654. bool success = _humanize_http_status(download_templates, &status, &downloaded_bytes, &total_bytes);
  655. if (downloaded_bytes >= 0) {
  656. if (total_bytes > 0) {
  657. _set_current_progress_value(float(downloaded_bytes) / total_bytes, status);
  658. } else {
  659. _set_current_progress_value(0, status);
  660. }
  661. } else {
  662. _set_current_progress_status(status);
  663. }
  664. if (!success) {
  665. set_process(false);
  666. }
  667. } break;
  668. case NOTIFICATION_WM_CLOSE_REQUEST: {
  669. // This won't stop the window from closing, but will show the alert if the download is active.
  670. ok_pressed();
  671. } break;
  672. }
  673. }
  674. void ExportTemplateManager::_bind_methods() {
  675. }
  676. ExportTemplateManager::ExportTemplateManager() {
  677. set_title(TTR("Export Template Manager"));
  678. set_hide_on_ok(false);
  679. set_ok_button_text(TTR("Close"));
  680. // Downloadable export templates are only available for stable and official alpha/beta/RC builds
  681. // (which always have a number following their status, e.g. "alpha1").
  682. // Therefore, don't display download-related features when using a development version
  683. // (whose builds aren't numbered).
  684. downloads_available =
  685. String(VERSION_STATUS) != String("dev") &&
  686. String(VERSION_STATUS) != String("alpha") &&
  687. String(VERSION_STATUS) != String("beta") &&
  688. String(VERSION_STATUS) != String("rc");
  689. VBoxContainer *main_vb = memnew(VBoxContainer);
  690. add_child(main_vb);
  691. // Current version controls.
  692. HBoxContainer *current_hb = memnew(HBoxContainer);
  693. main_vb->add_child(current_hb);
  694. Label *current_label = memnew(Label);
  695. current_label->set_theme_type_variation("HeaderSmall");
  696. current_label->set_text(TTR("Current Version:"));
  697. current_hb->add_child(current_label);
  698. current_value = memnew(Label);
  699. current_hb->add_child(current_value);
  700. // Current version statuses.
  701. // Status: Current version is missing.
  702. current_missing_label = memnew(Label);
  703. current_missing_label->set_theme_type_variation("HeaderSmall");
  704. current_missing_label->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  705. current_missing_label->set_horizontal_alignment(HORIZONTAL_ALIGNMENT_RIGHT);
  706. current_missing_label->set_text(TTR("Export templates are missing. Download them or install from a file."));
  707. current_hb->add_child(current_missing_label);
  708. // Status: Current version is installed.
  709. current_installed_label = memnew(Label);
  710. current_installed_label->set_theme_type_variation("HeaderSmall");
  711. current_installed_label->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  712. current_installed_label->set_horizontal_alignment(HORIZONTAL_ALIGNMENT_RIGHT);
  713. current_installed_label->set_text(TTR("Export templates are installed and ready to be used."));
  714. current_hb->add_child(current_installed_label);
  715. current_installed_label->hide();
  716. // Currently installed template.
  717. current_installed_hb = memnew(HBoxContainer);
  718. main_vb->add_child(current_installed_hb);
  719. current_installed_path = memnew(LineEdit);
  720. current_installed_path->set_editable(false);
  721. current_installed_path->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  722. current_installed_hb->add_child(current_installed_path);
  723. current_open_button = memnew(Button);
  724. current_open_button->set_text(TTR("Open Folder"));
  725. current_open_button->set_tooltip_text(TTR("Open the folder containing installed templates for the current version."));
  726. current_installed_hb->add_child(current_open_button);
  727. current_open_button->connect("pressed", callable_mp(this, &ExportTemplateManager::_open_template_folder).bind(VERSION_FULL_CONFIG));
  728. current_uninstall_button = memnew(Button);
  729. current_uninstall_button->set_text(TTR("Uninstall"));
  730. current_uninstall_button->set_tooltip_text(TTR("Uninstall templates for the current version."));
  731. current_installed_hb->add_child(current_uninstall_button);
  732. current_uninstall_button->connect("pressed", callable_mp(this, &ExportTemplateManager::_uninstall_template).bind(VERSION_FULL_CONFIG));
  733. main_vb->add_child(memnew(HSeparator));
  734. // Download and install section.
  735. HBoxContainer *install_templates_hb = memnew(HBoxContainer);
  736. main_vb->add_child(install_templates_hb);
  737. // Download and install buttons are available.
  738. install_options_vb = memnew(VBoxContainer);
  739. install_options_vb->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  740. install_templates_hb->add_child(install_options_vb);
  741. HBoxContainer *download_install_hb = memnew(HBoxContainer);
  742. install_options_vb->add_child(download_install_hb);
  743. Label *mirrors_label = memnew(Label);
  744. mirrors_label->set_text(TTR("Download from:"));
  745. download_install_hb->add_child(mirrors_label);
  746. mirrors_list = memnew(OptionButton);
  747. mirrors_list->set_custom_minimum_size(Size2(280, 0) * EDSCALE);
  748. download_install_hb->add_child(mirrors_list);
  749. mirrors_list->add_item(TTR("Best available mirror"), 0);
  750. request_mirrors = memnew(HTTPRequest);
  751. mirrors_list->add_child(request_mirrors);
  752. request_mirrors->connect("request_completed", callable_mp(this, &ExportTemplateManager::_refresh_mirrors_completed));
  753. mirror_options_button = memnew(MenuButton);
  754. mirror_options_button->get_popup()->add_item(TTR("Open in Web Browser"), VISIT_WEB_MIRROR);
  755. mirror_options_button->get_popup()->add_item(TTR("Copy Mirror URL"), COPY_MIRROR_URL);
  756. download_install_hb->add_child(mirror_options_button);
  757. mirror_options_button->get_popup()->connect("id_pressed", callable_mp(this, &ExportTemplateManager::_mirror_options_button_cbk));
  758. download_install_hb->add_spacer();
  759. Button *download_current_button = memnew(Button);
  760. download_current_button->set_text(TTR("Download and Install"));
  761. download_current_button->set_tooltip_text(TTR("Download and install templates for the current version from the best possible mirror."));
  762. download_install_hb->add_child(download_current_button);
  763. download_current_button->connect("pressed", callable_mp(this, &ExportTemplateManager::_download_current));
  764. // Update downloads buttons to prevent unsupported downloads.
  765. if (!downloads_available) {
  766. download_current_button->set_disabled(true);
  767. download_current_button->set_tooltip_text(TTR("Official export templates aren't available for development builds."));
  768. }
  769. HBoxContainer *install_file_hb = memnew(HBoxContainer);
  770. install_file_hb->set_alignment(BoxContainer::ALIGNMENT_END);
  771. install_options_vb->add_child(install_file_hb);
  772. install_file_button = memnew(Button);
  773. install_file_button->set_text(TTR("Install from File"));
  774. install_file_button->set_tooltip_text(TTR("Install templates from a local file."));
  775. install_file_hb->add_child(install_file_button);
  776. install_file_button->connect("pressed", callable_mp(this, &ExportTemplateManager::_install_file));
  777. // Templates are being downloaded; buttons unavailable.
  778. download_progress_hb = memnew(HBoxContainer);
  779. download_progress_hb->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  780. install_templates_hb->add_child(download_progress_hb);
  781. download_progress_hb->hide();
  782. download_progress_bar = memnew(ProgressBar);
  783. download_progress_bar->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  784. download_progress_bar->set_v_size_flags(Control::SIZE_SHRINK_CENTER);
  785. download_progress_bar->set_min(0);
  786. download_progress_bar->set_max(1);
  787. download_progress_bar->set_value(0);
  788. download_progress_bar->set_step(0.01);
  789. download_progress_hb->add_child(download_progress_bar);
  790. download_progress_label = memnew(Label);
  791. download_progress_label->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  792. download_progress_hb->add_child(download_progress_label);
  793. Button *download_cancel_button = memnew(Button);
  794. download_cancel_button->set_text(TTR("Cancel"));
  795. download_cancel_button->set_tooltip_text(TTR("Cancel the download of the templates."));
  796. download_progress_hb->add_child(download_cancel_button);
  797. download_cancel_button->connect("pressed", callable_mp(this, &ExportTemplateManager::_cancel_template_download));
  798. download_templates = memnew(HTTPRequest);
  799. install_templates_hb->add_child(download_templates);
  800. download_templates->connect("request_completed", callable_mp(this, &ExportTemplateManager::_download_template_completed));
  801. main_vb->add_child(memnew(HSeparator));
  802. // Other installed templates table.
  803. HBoxContainer *installed_versions_hb = memnew(HBoxContainer);
  804. main_vb->add_child(installed_versions_hb);
  805. Label *installed_label = memnew(Label);
  806. installed_label->set_theme_type_variation("HeaderSmall");
  807. installed_label->set_text(TTR("Other Installed Versions:"));
  808. installed_versions_hb->add_child(installed_label);
  809. installed_table = memnew(Tree);
  810. installed_table->set_hide_root(true);
  811. installed_table->set_custom_minimum_size(Size2(0, 100) * EDSCALE);
  812. installed_table->set_v_size_flags(Control::SIZE_EXPAND_FILL);
  813. main_vb->add_child(installed_table);
  814. installed_table->connect("button_clicked", callable_mp(this, &ExportTemplateManager::_installed_table_button_cbk));
  815. // Dialogs.
  816. uninstall_confirm = memnew(ConfirmationDialog);
  817. uninstall_confirm->set_title(TTR("Uninstall Template"));
  818. add_child(uninstall_confirm);
  819. uninstall_confirm->connect("confirmed", callable_mp(this, &ExportTemplateManager::_uninstall_template_confirmed));
  820. install_file_dialog = memnew(FileDialog);
  821. install_file_dialog->set_title(TTR("Select Template File"));
  822. install_file_dialog->set_access(FileDialog::ACCESS_FILESYSTEM);
  823. install_file_dialog->set_file_mode(FileDialog::FILE_MODE_OPEN_FILE);
  824. install_file_dialog->set_current_dir(EditorSettings::get_singleton()->get_meta("export_template_download_directory", ""));
  825. install_file_dialog->add_filter("*.tpz", TTR("Godot Export Templates"));
  826. install_file_dialog->connect("file_selected", callable_mp(this, &ExportTemplateManager::_install_file_selected).bind(false));
  827. add_child(install_file_dialog);
  828. hide_dialog_accept = memnew(AcceptDialog);
  829. hide_dialog_accept->set_text(TTR("The templates will continue to download.\nYou may experience a short editor freeze when they finish."));
  830. add_child(hide_dialog_accept);
  831. hide_dialog_accept->connect("confirmed", callable_mp(this, &ExportTemplateManager::_hide_dialog));
  832. }