2
0

export_template_manager.cpp 35 KB

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