editor_export.cpp 50 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731
  1. /*************************************************************************/
  2. /* editor_export.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md). */
  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 "editor_export.h"
  31. #include "core/crypto/crypto_core.h"
  32. #include "core/io/config_file.h"
  33. #include "core/io/file_access_pack.h" // PACK_HEADER_MAGIC, PACK_FORMAT_VERSION
  34. #include "core/io/resource_loader.h"
  35. #include "core/io/resource_saver.h"
  36. #include "core/io/zip_io.h"
  37. #include "core/os/dir_access.h"
  38. #include "core/os/file_access.h"
  39. #include "core/project_settings.h"
  40. #include "core/script_language.h"
  41. #include "core/version.h"
  42. #include "editor/editor_file_system.h"
  43. #include "editor/plugins/script_editor_plugin.h"
  44. #include "editor_node.h"
  45. #include "editor_settings.h"
  46. #include "scene/resources/resource_format_text.h"
  47. static int _get_pad(int p_alignment, int p_n) {
  48. int rest = p_n % p_alignment;
  49. int pad = 0;
  50. if (rest > 0) {
  51. pad = p_alignment - rest;
  52. };
  53. return pad;
  54. }
  55. #define PCK_PADDING 16
  56. bool EditorExportPreset::_set(const StringName &p_name, const Variant &p_value) {
  57. if (values.has(p_name)) {
  58. values[p_name] = p_value;
  59. EditorExport::singleton->save_presets();
  60. return true;
  61. }
  62. return false;
  63. }
  64. bool EditorExportPreset::_get(const StringName &p_name, Variant &r_ret) const {
  65. if (values.has(p_name)) {
  66. r_ret = values[p_name];
  67. return true;
  68. }
  69. return false;
  70. }
  71. void EditorExportPreset::_get_property_list(List<PropertyInfo> *p_list) const {
  72. for (const List<PropertyInfo>::Element *E = properties.front(); E; E = E->next()) {
  73. if (platform->get_option_visibility(E->get().name, values)) {
  74. p_list->push_back(E->get());
  75. }
  76. }
  77. }
  78. Ref<EditorExportPlatform> EditorExportPreset::get_platform() const {
  79. return platform;
  80. }
  81. Vector<String> EditorExportPreset::get_files_to_export() const {
  82. Vector<String> files;
  83. for (Set<String>::Element *E = selected_files.front(); E; E = E->next()) {
  84. files.push_back(E->get());
  85. }
  86. return files;
  87. }
  88. void EditorExportPreset::set_name(const String &p_name) {
  89. name = p_name;
  90. EditorExport::singleton->save_presets();
  91. }
  92. String EditorExportPreset::get_name() const {
  93. return name;
  94. }
  95. void EditorExportPreset::set_runnable(bool p_enable) {
  96. runnable = p_enable;
  97. EditorExport::singleton->save_presets();
  98. }
  99. bool EditorExportPreset::is_runnable() const {
  100. return runnable;
  101. }
  102. void EditorExportPreset::set_export_filter(ExportFilter p_filter) {
  103. export_filter = p_filter;
  104. EditorExport::singleton->save_presets();
  105. }
  106. EditorExportPreset::ExportFilter EditorExportPreset::get_export_filter() const {
  107. return export_filter;
  108. }
  109. void EditorExportPreset::set_include_filter(const String &p_include) {
  110. include_filter = p_include;
  111. EditorExport::singleton->save_presets();
  112. }
  113. String EditorExportPreset::get_include_filter() const {
  114. return include_filter;
  115. }
  116. void EditorExportPreset::set_export_path(const String &p_path) {
  117. export_path = p_path;
  118. /* NOTE(SonerSound): if there is a need to implement a PropertyHint that specifically indicates a relative path,
  119. * this should be removed. */
  120. if (export_path.is_abs_path()) {
  121. String res_path = OS::get_singleton()->get_resource_dir();
  122. export_path = res_path.path_to_file(export_path);
  123. }
  124. EditorExport::singleton->save_presets();
  125. }
  126. String EditorExportPreset::get_export_path() const {
  127. return export_path;
  128. }
  129. void EditorExportPreset::set_exclude_filter(const String &p_exclude) {
  130. exclude_filter = p_exclude;
  131. EditorExport::singleton->save_presets();
  132. }
  133. String EditorExportPreset::get_exclude_filter() const {
  134. return exclude_filter;
  135. }
  136. void EditorExportPreset::add_export_file(const String &p_path) {
  137. selected_files.insert(p_path);
  138. EditorExport::singleton->save_presets();
  139. }
  140. void EditorExportPreset::remove_export_file(const String &p_path) {
  141. selected_files.erase(p_path);
  142. EditorExport::singleton->save_presets();
  143. }
  144. bool EditorExportPreset::has_export_file(const String &p_path) {
  145. return selected_files.has(p_path);
  146. }
  147. void EditorExportPreset::add_patch(const String &p_path, int p_at_pos) {
  148. if (p_at_pos < 0)
  149. patches.push_back(p_path);
  150. else
  151. patches.insert(p_at_pos, p_path);
  152. EditorExport::singleton->save_presets();
  153. }
  154. void EditorExportPreset::remove_patch(int p_idx) {
  155. patches.remove(p_idx);
  156. EditorExport::singleton->save_presets();
  157. }
  158. void EditorExportPreset::set_patch(int p_index, const String &p_path) {
  159. ERR_FAIL_INDEX(p_index, patches.size());
  160. patches.write[p_index] = p_path;
  161. EditorExport::singleton->save_presets();
  162. }
  163. String EditorExportPreset::get_patch(int p_index) {
  164. ERR_FAIL_INDEX_V(p_index, patches.size(), String());
  165. return patches[p_index];
  166. }
  167. Vector<String> EditorExportPreset::get_patches() const {
  168. return patches;
  169. }
  170. void EditorExportPreset::set_custom_features(const String &p_custom_features) {
  171. custom_features = p_custom_features;
  172. EditorExport::singleton->save_presets();
  173. }
  174. String EditorExportPreset::get_custom_features() const {
  175. return custom_features;
  176. }
  177. void EditorExportPreset::set_script_export_mode(int p_mode) {
  178. script_mode = p_mode;
  179. EditorExport::singleton->save_presets();
  180. }
  181. int EditorExportPreset::get_script_export_mode() const {
  182. return script_mode;
  183. }
  184. void EditorExportPreset::set_script_encryption_key(const String &p_key) {
  185. script_key = p_key;
  186. EditorExport::singleton->save_presets();
  187. }
  188. String EditorExportPreset::get_script_encryption_key() const {
  189. return script_key;
  190. }
  191. EditorExportPreset::EditorExportPreset() :
  192. export_filter(EXPORT_ALL_RESOURCES),
  193. export_path(""),
  194. runnable(false),
  195. script_mode(MODE_SCRIPT_COMPILED) {
  196. }
  197. ///////////////////////////////////
  198. void EditorExportPlatform::gen_debug_flags(Vector<String> &r_flags, int p_flags) {
  199. String host = EditorSettings::get_singleton()->get("network/debug/remote_host");
  200. int remote_port = (int)EditorSettings::get_singleton()->get("network/debug/remote_port");
  201. if (p_flags & DEBUG_FLAG_REMOTE_DEBUG_LOCALHOST)
  202. host = "localhost";
  203. if (p_flags & DEBUG_FLAG_DUMB_CLIENT) {
  204. int port = EditorSettings::get_singleton()->get("filesystem/file_server/port");
  205. String passwd = EditorSettings::get_singleton()->get("filesystem/file_server/password");
  206. r_flags.push_back("--remote-fs");
  207. r_flags.push_back(host + ":" + itos(port));
  208. if (passwd != "") {
  209. r_flags.push_back("--remote-fs-password");
  210. r_flags.push_back(passwd);
  211. }
  212. }
  213. if (p_flags & DEBUG_FLAG_REMOTE_DEBUG) {
  214. r_flags.push_back("--remote-debug");
  215. r_flags.push_back(host + ":" + String::num(remote_port));
  216. List<String> breakpoints;
  217. ScriptEditor::get_singleton()->get_breakpoints(&breakpoints);
  218. if (breakpoints.size()) {
  219. r_flags.push_back("--breakpoints");
  220. String bpoints;
  221. for (const List<String>::Element *E = breakpoints.front(); E; E = E->next()) {
  222. bpoints += E->get().replace(" ", "%20");
  223. if (E->next())
  224. bpoints += ",";
  225. }
  226. r_flags.push_back(bpoints);
  227. }
  228. }
  229. if (p_flags & DEBUG_FLAG_VIEW_COLLISONS) {
  230. r_flags.push_back("--debug-collisions");
  231. }
  232. if (p_flags & DEBUG_FLAG_VIEW_NAVIGATION) {
  233. r_flags.push_back("--debug-navigation");
  234. }
  235. }
  236. Error EditorExportPlatform::_save_pack_file(void *p_userdata, const String &p_path, const Vector<uint8_t> &p_data, int p_file, int p_total) {
  237. PackData *pd = (PackData *)p_userdata;
  238. SavedData sd;
  239. sd.path_utf8 = p_path.utf8();
  240. sd.ofs = pd->f->get_position();
  241. sd.size = p_data.size();
  242. pd->f->store_buffer(p_data.ptr(), p_data.size());
  243. int pad = _get_pad(PCK_PADDING, sd.size);
  244. for (int i = 0; i < pad; i++) {
  245. pd->f->store_8(0);
  246. }
  247. {
  248. unsigned char hash[16];
  249. CryptoCore::md5(p_data.ptr(), p_data.size(), hash);
  250. sd.md5.resize(16);
  251. for (int i = 0; i < 16; i++) {
  252. sd.md5.write[i] = hash[i];
  253. }
  254. }
  255. pd->file_ofs.push_back(sd);
  256. if (pd->ep->step(TTR("Storing File:") + " " + p_path, 2 + p_file * 100 / p_total, false)) {
  257. return ERR_SKIP;
  258. }
  259. return OK;
  260. }
  261. Error EditorExportPlatform::_save_zip_file(void *p_userdata, const String &p_path, const Vector<uint8_t> &p_data, int p_file, int p_total) {
  262. String path = p_path.replace_first("res://", "");
  263. ZipData *zd = (ZipData *)p_userdata;
  264. zipFile zip = (zipFile)zd->zip;
  265. zipOpenNewFileInZip(zip,
  266. path.utf8().get_data(),
  267. nullptr,
  268. nullptr,
  269. 0,
  270. nullptr,
  271. 0,
  272. nullptr,
  273. Z_DEFLATED,
  274. Z_DEFAULT_COMPRESSION);
  275. zipWriteInFileInZip(zip, p_data.ptr(), p_data.size());
  276. zipCloseFileInZip(zip);
  277. if (zd->ep->step(TTR("Storing File:") + " " + p_path, 2 + p_file * 100 / p_total, false)) {
  278. return ERR_SKIP;
  279. }
  280. return OK;
  281. }
  282. Ref<ImageTexture> EditorExportPlatform::get_option_icon(int p_index) const {
  283. Ref<Theme> theme = EditorNode::get_singleton()->get_editor_theme();
  284. ERR_FAIL_COND_V(theme.is_null(), Ref<ImageTexture>());
  285. return theme->get_icon("Play", "EditorIcons");
  286. }
  287. String EditorExportPlatform::find_export_template(String template_file_name, String *err) const {
  288. String current_version = VERSION_FULL_CONFIG;
  289. String template_path = EditorSettings::get_singleton()->get_templates_dir().plus_file(current_version).plus_file(template_file_name);
  290. if (FileAccess::exists(template_path)) {
  291. return template_path;
  292. }
  293. // Not found
  294. if (err) {
  295. *err += TTR("No export template found at the expected path:") + "\n" + template_path + "\n";
  296. }
  297. return String();
  298. }
  299. bool EditorExportPlatform::exists_export_template(String template_file_name, String *err) const {
  300. return find_export_template(template_file_name, err) != "";
  301. }
  302. Ref<EditorExportPreset> EditorExportPlatform::create_preset() {
  303. Ref<EditorExportPreset> preset;
  304. preset.instance();
  305. preset->platform = Ref<EditorExportPlatform>(this);
  306. List<ExportOption> options;
  307. get_export_options(&options);
  308. for (List<ExportOption>::Element *E = options.front(); E; E = E->next()) {
  309. preset->properties.push_back(E->get().option);
  310. preset->values[E->get().option.name] = E->get().default_value;
  311. }
  312. return preset;
  313. }
  314. void EditorExportPlatform::_export_find_resources(EditorFileSystemDirectory *p_dir, Set<String> &p_paths) {
  315. for (int i = 0; i < p_dir->get_subdir_count(); i++) {
  316. _export_find_resources(p_dir->get_subdir(i), p_paths);
  317. }
  318. for (int i = 0; i < p_dir->get_file_count(); i++) {
  319. p_paths.insert(p_dir->get_file_path(i));
  320. }
  321. }
  322. void EditorExportPlatform::_export_find_dependencies(const String &p_path, Set<String> &p_paths) {
  323. if (p_paths.has(p_path))
  324. return;
  325. p_paths.insert(p_path);
  326. EditorFileSystemDirectory *dir;
  327. int file_idx;
  328. dir = EditorFileSystem::get_singleton()->find_file(p_path, &file_idx);
  329. if (!dir)
  330. return;
  331. Vector<String> deps = dir->get_file_deps(file_idx);
  332. for (int i = 0; i < deps.size(); i++) {
  333. _export_find_dependencies(deps[i], p_paths);
  334. }
  335. }
  336. void EditorExportPlatform::_edit_files_with_filter(DirAccess *da, const Vector<String> &p_filters, Set<String> &r_list, bool exclude) {
  337. da->list_dir_begin();
  338. String cur_dir = da->get_current_dir().replace("\\", "/");
  339. if (!cur_dir.ends_with("/"))
  340. cur_dir += "/";
  341. String cur_dir_no_prefix = cur_dir.replace("res://", "");
  342. Vector<String> dirs;
  343. String f;
  344. while ((f = da->get_next()) != "") {
  345. if (da->current_is_dir())
  346. dirs.push_back(f);
  347. else {
  348. String fullpath = cur_dir + f;
  349. // Test also against path without res:// so that filters like `file.txt` can work.
  350. String fullpath_no_prefix = cur_dir_no_prefix + f;
  351. for (int i = 0; i < p_filters.size(); ++i) {
  352. if (fullpath.matchn(p_filters[i]) || fullpath_no_prefix.matchn(p_filters[i])) {
  353. if (!exclude) {
  354. r_list.insert(fullpath);
  355. } else {
  356. r_list.erase(fullpath);
  357. }
  358. }
  359. }
  360. }
  361. }
  362. da->list_dir_end();
  363. for (int i = 0; i < dirs.size(); ++i) {
  364. String dir = dirs[i];
  365. if (dir.begins_with("."))
  366. continue;
  367. da->change_dir(dir);
  368. _edit_files_with_filter(da, p_filters, r_list, exclude);
  369. da->change_dir("..");
  370. }
  371. }
  372. void EditorExportPlatform::_edit_filter_list(Set<String> &r_list, const String &p_filter, bool exclude) {
  373. if (p_filter == "")
  374. return;
  375. Vector<String> split = p_filter.split(",");
  376. Vector<String> filters;
  377. for (int i = 0; i < split.size(); i++) {
  378. String f = split[i].strip_edges();
  379. if (f.empty())
  380. continue;
  381. filters.push_back(f);
  382. }
  383. DirAccess *da = DirAccess::open("res://");
  384. ERR_FAIL_NULL(da);
  385. _edit_files_with_filter(da, filters, r_list, exclude);
  386. memdelete(da);
  387. }
  388. void EditorExportPlugin::set_export_preset(const Ref<EditorExportPreset> &p_preset) {
  389. if (p_preset.is_valid()) {
  390. export_preset = p_preset;
  391. }
  392. }
  393. Ref<EditorExportPreset> EditorExportPlugin::get_export_preset() const {
  394. return export_preset;
  395. }
  396. void EditorExportPlugin::add_file(const String &p_path, const Vector<uint8_t> &p_file, bool p_remap) {
  397. ExtraFile ef;
  398. ef.data = p_file;
  399. ef.path = p_path;
  400. ef.remap = p_remap;
  401. extra_files.push_back(ef);
  402. }
  403. void EditorExportPlugin::add_shared_object(const String &p_path, const Vector<String> &tags) {
  404. shared_objects.push_back(SharedObject(p_path, tags));
  405. }
  406. void EditorExportPlugin::add_ios_framework(const String &p_path) {
  407. ios_frameworks.push_back(p_path);
  408. }
  409. Vector<String> EditorExportPlugin::get_ios_frameworks() const {
  410. return ios_frameworks;
  411. }
  412. void EditorExportPlugin::add_ios_plist_content(const String &p_plist_content) {
  413. ios_plist_content += p_plist_content + "\n";
  414. }
  415. String EditorExportPlugin::get_ios_plist_content() const {
  416. return ios_plist_content;
  417. }
  418. void EditorExportPlugin::add_ios_linker_flags(const String &p_flags) {
  419. if (ios_linker_flags.length() > 0) {
  420. ios_linker_flags += ' ';
  421. }
  422. ios_linker_flags += p_flags;
  423. }
  424. String EditorExportPlugin::get_ios_linker_flags() const {
  425. return ios_linker_flags;
  426. }
  427. void EditorExportPlugin::add_ios_bundle_file(const String &p_path) {
  428. ios_bundle_files.push_back(p_path);
  429. }
  430. Vector<String> EditorExportPlugin::get_ios_bundle_files() const {
  431. return ios_bundle_files;
  432. }
  433. void EditorExportPlugin::add_ios_cpp_code(const String &p_code) {
  434. ios_cpp_code += p_code;
  435. }
  436. String EditorExportPlugin::get_ios_cpp_code() const {
  437. return ios_cpp_code;
  438. }
  439. void EditorExportPlugin::add_ios_project_static_lib(const String &p_path) {
  440. ios_project_static_libs.push_back(p_path);
  441. }
  442. Vector<String> EditorExportPlugin::get_ios_project_static_libs() const {
  443. return ios_project_static_libs;
  444. }
  445. void EditorExportPlugin::_export_file_script(const String &p_path, const String &p_type, const Vector<String> &p_features) {
  446. if (get_script_instance()) {
  447. get_script_instance()->call("_export_file", p_path, p_type, p_features);
  448. }
  449. }
  450. void EditorExportPlugin::_export_begin_script(const Vector<String> &p_features, bool p_debug, const String &p_path, int p_flags) {
  451. if (get_script_instance()) {
  452. get_script_instance()->call("_export_begin", p_features, p_debug, p_path, p_flags);
  453. }
  454. }
  455. void EditorExportPlugin::_export_end_script() {
  456. if (get_script_instance()) {
  457. get_script_instance()->call("_export_end");
  458. }
  459. }
  460. void EditorExportPlugin::_export_file(const String &p_path, const String &p_type, const Set<String> &p_features) {
  461. }
  462. void EditorExportPlugin::_export_begin(const Set<String> &p_features, bool p_debug, const String &p_path, int p_flags) {
  463. }
  464. void EditorExportPlugin::skip() {
  465. skipped = true;
  466. }
  467. void EditorExportPlugin::_bind_methods() {
  468. ClassDB::bind_method(D_METHOD("add_shared_object", "path", "tags"), &EditorExportPlugin::add_shared_object);
  469. ClassDB::bind_method(D_METHOD("add_ios_project_static_lib", "path"), &EditorExportPlugin::add_ios_project_static_lib);
  470. ClassDB::bind_method(D_METHOD("add_file", "path", "file", "remap"), &EditorExportPlugin::add_file);
  471. ClassDB::bind_method(D_METHOD("add_ios_framework", "path"), &EditorExportPlugin::add_ios_framework);
  472. ClassDB::bind_method(D_METHOD("add_ios_plist_content", "plist_content"), &EditorExportPlugin::add_ios_plist_content);
  473. ClassDB::bind_method(D_METHOD("add_ios_linker_flags", "flags"), &EditorExportPlugin::add_ios_linker_flags);
  474. ClassDB::bind_method(D_METHOD("add_ios_bundle_file", "path"), &EditorExportPlugin::add_ios_bundle_file);
  475. ClassDB::bind_method(D_METHOD("add_ios_cpp_code", "code"), &EditorExportPlugin::add_ios_cpp_code);
  476. ClassDB::bind_method(D_METHOD("skip"), &EditorExportPlugin::skip);
  477. BIND_VMETHOD(MethodInfo("_export_file", PropertyInfo(Variant::STRING, "path"), PropertyInfo(Variant::STRING, "type"), PropertyInfo(Variant::PACKED_STRING_ARRAY, "features")));
  478. BIND_VMETHOD(MethodInfo("_export_begin", PropertyInfo(Variant::PACKED_STRING_ARRAY, "features"), PropertyInfo(Variant::BOOL, "is_debug"), PropertyInfo(Variant::STRING, "path"), PropertyInfo(Variant::INT, "flags")));
  479. BIND_VMETHOD(MethodInfo("_export_end"));
  480. }
  481. EditorExportPlugin::EditorExportPlugin() {
  482. skipped = false;
  483. }
  484. EditorExportPlatform::FeatureContainers EditorExportPlatform::get_feature_containers(const Ref<EditorExportPreset> &p_preset) {
  485. Ref<EditorExportPlatform> platform = p_preset->get_platform();
  486. List<String> feature_list;
  487. platform->get_platform_features(&feature_list);
  488. platform->get_preset_features(p_preset, &feature_list);
  489. FeatureContainers result;
  490. for (List<String>::Element *E = feature_list.front(); E; E = E->next()) {
  491. result.features.insert(E->get());
  492. result.features_pv.push_back(E->get());
  493. }
  494. if (p_preset->get_custom_features() != String()) {
  495. Vector<String> tmp_custom_list = p_preset->get_custom_features().split(",");
  496. for (int i = 0; i < tmp_custom_list.size(); i++) {
  497. String f = tmp_custom_list[i].strip_edges();
  498. if (f != String()) {
  499. result.features.insert(f);
  500. result.features_pv.push_back(f);
  501. }
  502. }
  503. }
  504. return result;
  505. }
  506. EditorExportPlatform::ExportNotifier::ExportNotifier(EditorExportPlatform &p_platform, const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, int p_flags) {
  507. FeatureContainers features = p_platform.get_feature_containers(p_preset);
  508. Vector<Ref<EditorExportPlugin>> export_plugins = EditorExport::get_singleton()->get_export_plugins();
  509. //initial export plugin callback
  510. for (int i = 0; i < export_plugins.size(); i++) {
  511. if (export_plugins[i]->get_script_instance()) { //script based
  512. export_plugins.write[i]->_export_begin_script(features.features_pv, p_debug, p_path, p_flags);
  513. } else {
  514. export_plugins.write[i]->_export_begin(features.features, p_debug, p_path, p_flags);
  515. }
  516. }
  517. }
  518. EditorExportPlatform::ExportNotifier::~ExportNotifier() {
  519. Vector<Ref<EditorExportPlugin>> export_plugins = EditorExport::get_singleton()->get_export_plugins();
  520. for (int i = 0; i < export_plugins.size(); i++) {
  521. if (export_plugins[i]->get_script_instance()) {
  522. export_plugins.write[i]->_export_end_script();
  523. }
  524. export_plugins.write[i]->_export_end();
  525. }
  526. }
  527. Error EditorExportPlatform::export_project_files(const Ref<EditorExportPreset> &p_preset, EditorExportSaveFunction p_func, void *p_udata, EditorExportSaveSharedObject p_so_func) {
  528. //figure out paths of files that will be exported
  529. Set<String> paths;
  530. Vector<String> path_remaps;
  531. if (p_preset->get_export_filter() == EditorExportPreset::EXPORT_ALL_RESOURCES) {
  532. //find stuff
  533. _export_find_resources(EditorFileSystem::get_singleton()->get_filesystem(), paths);
  534. } else {
  535. bool scenes_only = p_preset->get_export_filter() == EditorExportPreset::EXPORT_SELECTED_SCENES;
  536. Vector<String> files = p_preset->get_files_to_export();
  537. for (int i = 0; i < files.size(); i++) {
  538. if (scenes_only && ResourceLoader::get_resource_type(files[i]) != "PackedScene")
  539. continue;
  540. _export_find_dependencies(files[i], paths);
  541. }
  542. }
  543. //add native icons to non-resource include list
  544. _edit_filter_list(paths, String("*.icns"), false);
  545. _edit_filter_list(paths, String("*.ico"), false);
  546. _edit_filter_list(paths, p_preset->get_include_filter(), false);
  547. _edit_filter_list(paths, p_preset->get_exclude_filter(), true);
  548. Vector<Ref<EditorExportPlugin>> export_plugins = EditorExport::get_singleton()->get_export_plugins();
  549. for (int i = 0; i < export_plugins.size(); i++) {
  550. export_plugins.write[i]->set_export_preset(p_preset);
  551. if (p_so_func) {
  552. for (int j = 0; j < export_plugins[i]->shared_objects.size(); j++) {
  553. p_so_func(p_udata, export_plugins[i]->shared_objects[j]);
  554. }
  555. }
  556. for (int j = 0; j < export_plugins[i]->extra_files.size(); j++) {
  557. p_func(p_udata, export_plugins[i]->extra_files[j].path, export_plugins[i]->extra_files[j].data, 0, paths.size());
  558. }
  559. export_plugins.write[i]->_clear();
  560. }
  561. FeatureContainers feature_containers = get_feature_containers(p_preset);
  562. Set<String> &features = feature_containers.features;
  563. Vector<String> &features_pv = feature_containers.features_pv;
  564. //store everything in the export medium
  565. int idx = 0;
  566. int total = paths.size();
  567. for (Set<String>::Element *E = paths.front(); E; E = E->next()) {
  568. String path = E->get();
  569. String type = ResourceLoader::get_resource_type(path);
  570. if (FileAccess::exists(path + ".import")) {
  571. //file is imported, replace by what it imports
  572. Ref<ConfigFile> config;
  573. config.instance();
  574. Error err = config->load(path + ".import");
  575. if (err != OK) {
  576. ERR_PRINT("Could not parse: '" + path + "', not exported.");
  577. continue;
  578. }
  579. List<String> remaps;
  580. config->get_section_keys("remap", &remaps);
  581. Set<String> remap_features;
  582. for (List<String>::Element *F = remaps.front(); F; F = F->next()) {
  583. String remap = F->get();
  584. String feature = remap.get_slice(".", 1);
  585. if (features.has(feature)) {
  586. remap_features.insert(feature);
  587. }
  588. }
  589. if (remap_features.size() > 1) {
  590. this->resolve_platform_feature_priorities(p_preset, remap_features);
  591. }
  592. err = OK;
  593. for (List<String>::Element *F = remaps.front(); F; F = F->next()) {
  594. String remap = F->get();
  595. if (remap == "path") {
  596. String remapped_path = config->get_value("remap", remap);
  597. Vector<uint8_t> array = FileAccess::get_file_as_array(remapped_path);
  598. err = p_func(p_udata, remapped_path, array, idx, total);
  599. } else if (remap.begins_with("path.")) {
  600. String feature = remap.get_slice(".", 1);
  601. if (remap_features.has(feature)) {
  602. String remapped_path = config->get_value("remap", remap);
  603. Vector<uint8_t> array = FileAccess::get_file_as_array(remapped_path);
  604. err = p_func(p_udata, remapped_path, array, idx, total);
  605. }
  606. }
  607. }
  608. if (err != OK) {
  609. return err;
  610. }
  611. //also save the .import file
  612. Vector<uint8_t> array = FileAccess::get_file_as_array(path + ".import");
  613. err = p_func(p_udata, path + ".import", array, idx, total);
  614. if (err != OK) {
  615. return err;
  616. }
  617. } else {
  618. bool do_export = true;
  619. for (int i = 0; i < export_plugins.size(); i++) {
  620. if (export_plugins[i]->get_script_instance()) { //script based
  621. export_plugins.write[i]->_export_file_script(path, type, features_pv);
  622. } else {
  623. export_plugins.write[i]->_export_file(path, type, features);
  624. }
  625. if (p_so_func) {
  626. for (int j = 0; j < export_plugins[i]->shared_objects.size(); j++) {
  627. p_so_func(p_udata, export_plugins[i]->shared_objects[j]);
  628. }
  629. }
  630. for (int j = 0; j < export_plugins[i]->extra_files.size(); j++) {
  631. p_func(p_udata, export_plugins[i]->extra_files[j].path, export_plugins[i]->extra_files[j].data, idx, total);
  632. if (export_plugins[i]->extra_files[j].remap) {
  633. do_export = false; //if remap, do not
  634. path_remaps.push_back(path);
  635. path_remaps.push_back(export_plugins[i]->extra_files[j].path);
  636. }
  637. }
  638. if (export_plugins[i]->skipped) {
  639. do_export = false;
  640. }
  641. export_plugins.write[i]->_clear();
  642. if (!do_export)
  643. break; //apologies, not exporting
  644. }
  645. //just store it as it comes
  646. if (do_export) {
  647. Vector<uint8_t> array = FileAccess::get_file_as_array(path);
  648. p_func(p_udata, path, array, idx, total);
  649. }
  650. }
  651. idx++;
  652. }
  653. //save config!
  654. Vector<String> custom_list;
  655. if (p_preset->get_custom_features() != String()) {
  656. Vector<String> tmp_custom_list = p_preset->get_custom_features().split(",");
  657. for (int i = 0; i < tmp_custom_list.size(); i++) {
  658. String f = tmp_custom_list[i].strip_edges();
  659. if (f != String()) {
  660. custom_list.push_back(f);
  661. }
  662. }
  663. }
  664. ProjectSettings::CustomMap custom_map;
  665. if (path_remaps.size()) {
  666. if (1) { //new remap mode, use always as it's friendlier with multiple .pck exports
  667. for (int i = 0; i < path_remaps.size(); i += 2) {
  668. String from = path_remaps[i];
  669. String to = path_remaps[i + 1];
  670. String remap_file = "[remap]\n\npath=\"" + to.c_escape() + "\"\n";
  671. CharString utf8 = remap_file.utf8();
  672. Vector<uint8_t> new_file;
  673. new_file.resize(utf8.length());
  674. for (int j = 0; j < utf8.length(); j++) {
  675. new_file.write[j] = utf8[j];
  676. }
  677. p_func(p_udata, from + ".remap", new_file, idx, total);
  678. }
  679. } else {
  680. //old remap mode, will still work, but it's unused because it's not multiple pck export friendly
  681. custom_map["path_remap/remapped_paths"] = path_remaps;
  682. }
  683. }
  684. // Store icon and splash images directly, they need to bypass the import system and be loaded as images
  685. String icon = ProjectSettings::get_singleton()->get("application/config/icon");
  686. String splash = ProjectSettings::get_singleton()->get("application/boot_splash/image");
  687. if (icon != String() && FileAccess::exists(icon)) {
  688. Vector<uint8_t> array = FileAccess::get_file_as_array(icon);
  689. p_func(p_udata, icon, array, idx, total);
  690. }
  691. if (splash != String() && FileAccess::exists(splash) && icon != splash) {
  692. Vector<uint8_t> array = FileAccess::get_file_as_array(splash);
  693. p_func(p_udata, splash, array, idx, total);
  694. }
  695. String config_file = "project.binary";
  696. String engine_cfb = EditorSettings::get_singleton()->get_cache_dir().plus_file("tmp" + config_file);
  697. ProjectSettings::get_singleton()->save_custom(engine_cfb, custom_map, custom_list);
  698. Vector<uint8_t> data = FileAccess::get_file_as_array(engine_cfb);
  699. DirAccess::remove_file_or_error(engine_cfb);
  700. p_func(p_udata, "res://" + config_file, data, idx, total);
  701. return OK;
  702. }
  703. Error EditorExportPlatform::_add_shared_object(void *p_userdata, const SharedObject &p_so) {
  704. PackData *pack_data = (PackData *)p_userdata;
  705. if (pack_data->so_files) {
  706. pack_data->so_files->push_back(p_so);
  707. }
  708. return OK;
  709. }
  710. Error EditorExportPlatform::save_pack(const Ref<EditorExportPreset> &p_preset, const String &p_path, Vector<SharedObject> *p_so_files, bool p_embed, int64_t *r_embedded_start, int64_t *r_embedded_size) {
  711. EditorProgress ep("savepack", TTR("Packing"), 102, true);
  712. String tmppath = EditorSettings::get_singleton()->get_cache_dir().plus_file("packtmp");
  713. FileAccess *ftmp = FileAccess::open(tmppath, FileAccess::WRITE);
  714. ERR_FAIL_COND_V_MSG(!ftmp, ERR_CANT_CREATE, "Cannot create file '" + tmppath + "'.");
  715. PackData pd;
  716. pd.ep = &ep;
  717. pd.f = ftmp;
  718. pd.so_files = p_so_files;
  719. Error err = export_project_files(p_preset, _save_pack_file, &pd, _add_shared_object);
  720. memdelete(ftmp); //close tmp file
  721. if (err != OK) {
  722. DirAccess::remove_file_or_error(tmppath);
  723. return err;
  724. }
  725. pd.file_ofs.sort(); //do sort, so we can do binary search later
  726. FileAccess *f;
  727. int64_t embed_pos = 0;
  728. if (!p_embed) {
  729. // Regular output to separate PCK file
  730. f = FileAccess::open(p_path, FileAccess::WRITE);
  731. if (!f) {
  732. DirAccess::remove_file_or_error(tmppath);
  733. ERR_FAIL_V(ERR_CANT_CREATE);
  734. }
  735. } else {
  736. // Append to executable
  737. f = FileAccess::open(p_path, FileAccess::READ_WRITE);
  738. if (!f) {
  739. DirAccess::remove_file_or_error(tmppath);
  740. ERR_FAIL_V(ERR_FILE_CANT_OPEN);
  741. }
  742. f->seek_end();
  743. embed_pos = f->get_position();
  744. if (r_embedded_start) {
  745. *r_embedded_start = embed_pos;
  746. }
  747. // Ensure embedded PCK starts at a 64-bit multiple
  748. int pad = f->get_position() % 8;
  749. for (int i = 0; i < pad; i++) {
  750. f->store_8(0);
  751. }
  752. }
  753. int64_t pck_start_pos = f->get_position();
  754. f->store_32(PACK_HEADER_MAGIC);
  755. f->store_32(PACK_FORMAT_VERSION);
  756. f->store_32(VERSION_MAJOR);
  757. f->store_32(VERSION_MINOR);
  758. f->store_32(VERSION_PATCH);
  759. for (int i = 0; i < 16; i++) {
  760. //reserved
  761. f->store_32(0);
  762. }
  763. f->store_32(pd.file_ofs.size()); //amount of files
  764. int64_t header_size = f->get_position();
  765. //precalculate header size
  766. for (int i = 0; i < pd.file_ofs.size(); i++) {
  767. header_size += 4; // size of path string (32 bits is enough)
  768. int string_len = pd.file_ofs[i].path_utf8.length();
  769. header_size += string_len + _get_pad(4, string_len); ///size of path string
  770. header_size += 8; // offset to file _with_ header size included
  771. header_size += 8; // size of file
  772. header_size += 16; // md5
  773. }
  774. int header_padding = _get_pad(PCK_PADDING, header_size);
  775. for (int i = 0; i < pd.file_ofs.size(); i++) {
  776. int string_len = pd.file_ofs[i].path_utf8.length();
  777. int pad = _get_pad(4, string_len);
  778. f->store_32(string_len + pad);
  779. f->store_buffer((const uint8_t *)pd.file_ofs[i].path_utf8.get_data(), string_len);
  780. for (int j = 0; j < pad; j++) {
  781. f->store_8(0);
  782. }
  783. f->store_64(pd.file_ofs[i].ofs + header_padding + header_size);
  784. f->store_64(pd.file_ofs[i].size); // pay attention here, this is where file is
  785. f->store_buffer(pd.file_ofs[i].md5.ptr(), 16); //also save md5 for file
  786. }
  787. for (int i = 0; i < header_padding; i++) {
  788. f->store_8(0);
  789. }
  790. // Save the rest of the data.
  791. ftmp = FileAccess::open(tmppath, FileAccess::READ);
  792. if (!ftmp) {
  793. memdelete(f);
  794. DirAccess::remove_file_or_error(tmppath);
  795. ERR_FAIL_V_MSG(ERR_CANT_CREATE, "Can't open file to read from path '" + String(tmppath) + "'.");
  796. }
  797. const int bufsize = 16384;
  798. uint8_t buf[bufsize];
  799. while (true) {
  800. int got = ftmp->get_buffer(buf, bufsize);
  801. if (got <= 0)
  802. break;
  803. f->store_buffer(buf, got);
  804. }
  805. memdelete(ftmp);
  806. if (p_embed) {
  807. // Ensure embedded data ends at a 64-bit multiple
  808. int64_t embed_end = f->get_position() - embed_pos + 12;
  809. int pad = embed_end % 8;
  810. for (int i = 0; i < pad; i++) {
  811. f->store_8(0);
  812. }
  813. int64_t pck_size = f->get_position() - pck_start_pos;
  814. f->store_64(pck_size);
  815. f->store_32(PACK_HEADER_MAGIC);
  816. if (r_embedded_size) {
  817. *r_embedded_size = f->get_position() - embed_pos;
  818. }
  819. }
  820. memdelete(f);
  821. DirAccess::remove_file_or_error(tmppath);
  822. return OK;
  823. }
  824. Error EditorExportPlatform::save_zip(const Ref<EditorExportPreset> &p_preset, const String &p_path) {
  825. EditorProgress ep("savezip", TTR("Packing"), 102, true);
  826. FileAccess *src_f;
  827. zlib_filefunc_def io = zipio_create_io_from_file(&src_f);
  828. zipFile zip = zipOpen2(p_path.utf8().get_data(), APPEND_STATUS_CREATE, nullptr, &io);
  829. ZipData zd;
  830. zd.ep = &ep;
  831. zd.zip = zip;
  832. Error err = export_project_files(p_preset, _save_zip_file, &zd);
  833. if (err != OK && err != ERR_SKIP)
  834. ERR_PRINT("Failed to export project files");
  835. zipClose(zip, nullptr);
  836. return OK;
  837. }
  838. Error EditorExportPlatform::export_pack(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, int p_flags) {
  839. ExportNotifier notifier(*this, p_preset, p_debug, p_path, p_flags);
  840. return save_pack(p_preset, p_path);
  841. }
  842. Error EditorExportPlatform::export_zip(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, int p_flags) {
  843. ExportNotifier notifier(*this, p_preset, p_debug, p_path, p_flags);
  844. return save_zip(p_preset, p_path);
  845. }
  846. void EditorExportPlatform::gen_export_flags(Vector<String> &r_flags, int p_flags) {
  847. String host = EditorSettings::get_singleton()->get("network/debug/remote_host");
  848. int remote_port = (int)EditorSettings::get_singleton()->get("network/debug/remote_port");
  849. if (p_flags & DEBUG_FLAG_REMOTE_DEBUG_LOCALHOST)
  850. host = "localhost";
  851. if (p_flags & DEBUG_FLAG_DUMB_CLIENT) {
  852. int port = EditorSettings::get_singleton()->get("filesystem/file_server/port");
  853. String passwd = EditorSettings::get_singleton()->get("filesystem/file_server/password");
  854. r_flags.push_back("--remote-fs");
  855. r_flags.push_back(host + ":" + itos(port));
  856. if (passwd != "") {
  857. r_flags.push_back("--remote-fs-password");
  858. r_flags.push_back(passwd);
  859. }
  860. }
  861. if (p_flags & DEBUG_FLAG_REMOTE_DEBUG) {
  862. r_flags.push_back("--remote-debug");
  863. r_flags.push_back(host + ":" + String::num(remote_port));
  864. List<String> breakpoints;
  865. ScriptEditor::get_singleton()->get_breakpoints(&breakpoints);
  866. if (breakpoints.size()) {
  867. r_flags.push_back("--breakpoints");
  868. String bpoints;
  869. for (const List<String>::Element *E = breakpoints.front(); E; E = E->next()) {
  870. bpoints += E->get().replace(" ", "%20");
  871. if (E->next())
  872. bpoints += ",";
  873. }
  874. r_flags.push_back(bpoints);
  875. }
  876. }
  877. if (p_flags & DEBUG_FLAG_VIEW_COLLISONS) {
  878. r_flags.push_back("--debug-collisions");
  879. }
  880. if (p_flags & DEBUG_FLAG_VIEW_NAVIGATION) {
  881. r_flags.push_back("--debug-navigation");
  882. }
  883. }
  884. EditorExportPlatform::EditorExportPlatform() {
  885. }
  886. ////
  887. EditorExport *EditorExport::singleton = nullptr;
  888. void EditorExport::_save() {
  889. Ref<ConfigFile> config;
  890. config.instance();
  891. for (int i = 0; i < export_presets.size(); i++) {
  892. Ref<EditorExportPreset> preset = export_presets[i];
  893. String section = "preset." + itos(i);
  894. config->set_value(section, "name", preset->get_name());
  895. config->set_value(section, "platform", preset->get_platform()->get_name());
  896. config->set_value(section, "runnable", preset->is_runnable());
  897. config->set_value(section, "custom_features", preset->get_custom_features());
  898. bool save_files = false;
  899. switch (preset->get_export_filter()) {
  900. case EditorExportPreset::EXPORT_ALL_RESOURCES: {
  901. config->set_value(section, "export_filter", "all_resources");
  902. } break;
  903. case EditorExportPreset::EXPORT_SELECTED_SCENES: {
  904. config->set_value(section, "export_filter", "scenes");
  905. save_files = true;
  906. } break;
  907. case EditorExportPreset::EXPORT_SELECTED_RESOURCES: {
  908. config->set_value(section, "export_filter", "resources");
  909. save_files = true;
  910. } break;
  911. }
  912. if (save_files) {
  913. Vector<String> export_files = preset->get_files_to_export();
  914. config->set_value(section, "export_files", export_files);
  915. }
  916. config->set_value(section, "include_filter", preset->get_include_filter());
  917. config->set_value(section, "exclude_filter", preset->get_exclude_filter());
  918. config->set_value(section, "export_path", preset->get_export_path());
  919. config->set_value(section, "patch_list", preset->get_patches());
  920. config->set_value(section, "script_export_mode", preset->get_script_export_mode());
  921. config->set_value(section, "script_encryption_key", preset->get_script_encryption_key());
  922. String option_section = "preset." + itos(i) + ".options";
  923. for (const List<PropertyInfo>::Element *E = preset->get_properties().front(); E; E = E->next()) {
  924. config->set_value(option_section, E->get().name, preset->get(E->get().name));
  925. }
  926. }
  927. config->save("res://export_presets.cfg");
  928. }
  929. void EditorExport::save_presets() {
  930. if (block_save)
  931. return;
  932. save_timer->start();
  933. }
  934. void EditorExport::_bind_methods() {
  935. }
  936. void EditorExport::add_export_platform(const Ref<EditorExportPlatform> &p_platform) {
  937. export_platforms.push_back(p_platform);
  938. }
  939. int EditorExport::get_export_platform_count() {
  940. return export_platforms.size();
  941. }
  942. Ref<EditorExportPlatform> EditorExport::get_export_platform(int p_idx) {
  943. ERR_FAIL_INDEX_V(p_idx, export_platforms.size(), Ref<EditorExportPlatform>());
  944. return export_platforms[p_idx];
  945. }
  946. void EditorExport::add_export_preset(const Ref<EditorExportPreset> &p_preset, int p_at_pos) {
  947. if (p_at_pos < 0)
  948. export_presets.push_back(p_preset);
  949. else
  950. export_presets.insert(p_at_pos, p_preset);
  951. }
  952. String EditorExportPlatform::test_etc2() const {
  953. String driver = ProjectSettings::get_singleton()->get("rendering/quality/driver/driver_name");
  954. bool etc_supported = ProjectSettings::get_singleton()->get("rendering/vram_compression/import_etc");
  955. bool etc2_supported = ProjectSettings::get_singleton()->get("rendering/vram_compression/import_etc2");
  956. if (driver == "GLES2" && !etc_supported) {
  957. return TTR("Target platform requires 'ETC' texture compression for GLES2. Enable 'Import Etc' in Project Settings.");
  958. } else if (driver == "Vulkan" && !etc2_supported) {
  959. // FIXME: Review if this is true for Vulkan.
  960. return TTR("Target platform requires 'ETC2' texture compression for Vulkan. Enable 'Import Etc 2' in Project Settings.");
  961. }
  962. return String();
  963. }
  964. int EditorExport::get_export_preset_count() const {
  965. return export_presets.size();
  966. }
  967. Ref<EditorExportPreset> EditorExport::get_export_preset(int p_idx) {
  968. ERR_FAIL_INDEX_V(p_idx, export_presets.size(), Ref<EditorExportPreset>());
  969. return export_presets[p_idx];
  970. }
  971. void EditorExport::remove_export_preset(int p_idx) {
  972. export_presets.remove(p_idx);
  973. save_presets();
  974. }
  975. void EditorExport::add_export_plugin(const Ref<EditorExportPlugin> &p_plugin) {
  976. if (export_plugins.find(p_plugin) == -1) {
  977. export_plugins.push_back(p_plugin);
  978. }
  979. }
  980. void EditorExport::remove_export_plugin(const Ref<EditorExportPlugin> &p_plugin) {
  981. export_plugins.erase(p_plugin);
  982. }
  983. Vector<Ref<EditorExportPlugin>> EditorExport::get_export_plugins() {
  984. return export_plugins;
  985. }
  986. void EditorExport::_notification(int p_what) {
  987. if (p_what == NOTIFICATION_ENTER_TREE) {
  988. load_config();
  989. }
  990. }
  991. void EditorExport::load_config() {
  992. Ref<ConfigFile> config;
  993. config.instance();
  994. Error err = config->load("res://export_presets.cfg");
  995. if (err != OK)
  996. return;
  997. block_save = true;
  998. int index = 0;
  999. while (true) {
  1000. String section = "preset." + itos(index);
  1001. if (!config->has_section(section))
  1002. break;
  1003. String platform = config->get_value(section, "platform");
  1004. Ref<EditorExportPreset> preset;
  1005. for (int i = 0; i < export_platforms.size(); i++) {
  1006. if (export_platforms[i]->get_name() == platform) {
  1007. preset = export_platforms.write[i]->create_preset();
  1008. break;
  1009. }
  1010. }
  1011. if (!preset.is_valid()) {
  1012. index++;
  1013. ERR_CONTINUE(!preset.is_valid());
  1014. }
  1015. preset->set_name(config->get_value(section, "name"));
  1016. preset->set_runnable(config->get_value(section, "runnable"));
  1017. if (config->has_section_key(section, "custom_features")) {
  1018. preset->set_custom_features(config->get_value(section, "custom_features"));
  1019. }
  1020. String export_filter = config->get_value(section, "export_filter");
  1021. bool get_files = false;
  1022. if (export_filter == "all_resources") {
  1023. preset->set_export_filter(EditorExportPreset::EXPORT_ALL_RESOURCES);
  1024. } else if (export_filter == "scenes") {
  1025. preset->set_export_filter(EditorExportPreset::EXPORT_SELECTED_SCENES);
  1026. get_files = true;
  1027. } else if (export_filter == "resources") {
  1028. preset->set_export_filter(EditorExportPreset::EXPORT_SELECTED_RESOURCES);
  1029. get_files = true;
  1030. }
  1031. if (get_files) {
  1032. Vector<String> files = config->get_value(section, "export_files");
  1033. for (int i = 0; i < files.size(); i++) {
  1034. preset->add_export_file(files[i]);
  1035. }
  1036. }
  1037. preset->set_include_filter(config->get_value(section, "include_filter"));
  1038. preset->set_exclude_filter(config->get_value(section, "exclude_filter"));
  1039. preset->set_export_path(config->get_value(section, "export_path", ""));
  1040. Vector<String> patch_list = config->get_value(section, "patch_list");
  1041. for (int i = 0; i < patch_list.size(); i++) {
  1042. preset->add_patch(patch_list[i]);
  1043. }
  1044. if (config->has_section_key(section, "script_export_mode")) {
  1045. preset->set_script_export_mode(config->get_value(section, "script_export_mode"));
  1046. }
  1047. if (config->has_section_key(section, "script_encryption_key")) {
  1048. preset->set_script_encryption_key(config->get_value(section, "script_encryption_key"));
  1049. }
  1050. String option_section = "preset." + itos(index) + ".options";
  1051. List<String> options;
  1052. config->get_section_keys(option_section, &options);
  1053. for (List<String>::Element *E = options.front(); E; E = E->next()) {
  1054. Variant value = config->get_value(option_section, E->get());
  1055. preset->set(E->get(), value);
  1056. }
  1057. add_export_preset(preset);
  1058. index++;
  1059. }
  1060. block_save = false;
  1061. }
  1062. bool EditorExport::poll_export_platforms() {
  1063. bool changed = false;
  1064. for (int i = 0; i < export_platforms.size(); i++) {
  1065. if (export_platforms.write[i]->poll_export()) {
  1066. changed = true;
  1067. }
  1068. }
  1069. return changed;
  1070. }
  1071. EditorExport::EditorExport() {
  1072. save_timer = memnew(Timer);
  1073. add_child(save_timer);
  1074. save_timer->set_wait_time(0.8);
  1075. save_timer->set_one_shot(true);
  1076. save_timer->connect("timeout", callable_mp(this, &EditorExport::_save));
  1077. block_save = false;
  1078. singleton = this;
  1079. }
  1080. EditorExport::~EditorExport() {
  1081. }
  1082. //////////
  1083. void EditorExportPlatformPC::get_preset_features(const Ref<EditorExportPreset> &p_preset, List<String> *r_features) {
  1084. if (p_preset->get("texture_format/s3tc")) {
  1085. r_features->push_back("s3tc");
  1086. }
  1087. if (p_preset->get("texture_format/etc")) {
  1088. r_features->push_back("etc");
  1089. }
  1090. if (p_preset->get("texture_format/etc2")) {
  1091. r_features->push_back("etc2");
  1092. }
  1093. if (p_preset->get("binary_format/64_bits")) {
  1094. r_features->push_back("64");
  1095. } else {
  1096. r_features->push_back("32");
  1097. }
  1098. }
  1099. void EditorExportPlatformPC::get_export_options(List<ExportOption> *r_options) {
  1100. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "texture_format/bptc"), false));
  1101. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "texture_format/s3tc"), true));
  1102. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "texture_format/etc"), false));
  1103. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "texture_format/etc2"), false));
  1104. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "texture_format/no_bptc_fallbacks"), true));
  1105. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "binary_format/64_bits"), true));
  1106. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "binary_format/embed_pck"), false));
  1107. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "custom_template/release", PROPERTY_HINT_GLOBAL_FILE), ""));
  1108. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "custom_template/debug", PROPERTY_HINT_GLOBAL_FILE), ""));
  1109. }
  1110. String EditorExportPlatformPC::get_name() const {
  1111. return name;
  1112. }
  1113. String EditorExportPlatformPC::get_os_name() const {
  1114. return os_name;
  1115. }
  1116. Ref<Texture2D> EditorExportPlatformPC::get_logo() const {
  1117. return logo;
  1118. }
  1119. bool EditorExportPlatformPC::can_export(const Ref<EditorExportPreset> &p_preset, String &r_error, bool &r_missing_templates) const {
  1120. String err;
  1121. bool valid = false;
  1122. // Look for export templates (first official, and if defined custom templates).
  1123. bool use64 = p_preset->get("binary_format/64_bits");
  1124. bool dvalid = exists_export_template(use64 ? debug_file_64 : debug_file_32, &err);
  1125. bool rvalid = exists_export_template(use64 ? release_file_64 : release_file_32, &err);
  1126. if (p_preset->get("custom_template/debug") != "") {
  1127. dvalid = FileAccess::exists(p_preset->get("custom_template/debug"));
  1128. if (!dvalid) {
  1129. err += TTR("Custom debug template not found.") + "\n";
  1130. }
  1131. }
  1132. if (p_preset->get("custom_template/release") != "") {
  1133. rvalid = FileAccess::exists(p_preset->get("custom_template/release"));
  1134. if (!rvalid) {
  1135. err += TTR("Custom release template not found.") + "\n";
  1136. }
  1137. }
  1138. valid = dvalid || rvalid;
  1139. r_missing_templates = !valid;
  1140. if (!err.empty())
  1141. r_error = err;
  1142. return valid;
  1143. }
  1144. List<String> EditorExportPlatformPC::get_binary_extensions(const Ref<EditorExportPreset> &p_preset) const {
  1145. List<String> list;
  1146. for (Map<String, String>::Element *E = extensions.front(); E; E = E->next()) {
  1147. if (p_preset->get(E->key())) {
  1148. list.push_back(extensions[E->key()]);
  1149. return list;
  1150. }
  1151. }
  1152. if (extensions.has("default")) {
  1153. list.push_back(extensions["default"]);
  1154. return list;
  1155. }
  1156. return list;
  1157. }
  1158. Error EditorExportPlatformPC::export_project(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, int p_flags) {
  1159. ExportNotifier notifier(*this, p_preset, p_debug, p_path, p_flags);
  1160. if (!DirAccess::exists(p_path.get_base_dir())) {
  1161. return ERR_FILE_BAD_PATH;
  1162. }
  1163. String custom_debug = p_preset->get("custom_template/debug");
  1164. String custom_release = p_preset->get("custom_template/release");
  1165. String template_path = p_debug ? custom_debug : custom_release;
  1166. template_path = template_path.strip_edges();
  1167. if (template_path == String()) {
  1168. if (p_preset->get("binary_format/64_bits")) {
  1169. if (p_debug) {
  1170. template_path = find_export_template(debug_file_64);
  1171. } else {
  1172. template_path = find_export_template(release_file_64);
  1173. }
  1174. } else {
  1175. if (p_debug) {
  1176. template_path = find_export_template(debug_file_32);
  1177. } else {
  1178. template_path = find_export_template(release_file_32);
  1179. }
  1180. }
  1181. }
  1182. if (template_path != String() && !FileAccess::exists(template_path)) {
  1183. EditorNode::get_singleton()->show_warning(TTR("Template file not found:") + "\n" + template_path);
  1184. return ERR_FILE_NOT_FOUND;
  1185. }
  1186. DirAccess *da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  1187. Error err = da->copy(template_path, p_path, get_chmod_flags());
  1188. memdelete(da);
  1189. if (err == OK) {
  1190. String pck_path;
  1191. if (p_preset->get("binary_format/embed_pck")) {
  1192. pck_path = p_path;
  1193. } else {
  1194. pck_path = p_path.get_basename() + ".pck";
  1195. }
  1196. Vector<SharedObject> so_files;
  1197. int64_t embedded_pos;
  1198. int64_t embedded_size;
  1199. err = save_pack(p_preset, pck_path, &so_files, p_preset->get("binary_format/embed_pck"), &embedded_pos, &embedded_size);
  1200. if (err == OK && p_preset->get("binary_format/embed_pck")) {
  1201. if (embedded_size >= 0x100000000 && !p_preset->get("binary_format/64_bits")) {
  1202. EditorNode::get_singleton()->show_warning(TTR("On 32-bit exports the embedded PCK cannot be bigger than 4 GiB."));
  1203. return ERR_INVALID_PARAMETER;
  1204. }
  1205. FixUpEmbeddedPckFunc fixup_func = get_fixup_embedded_pck_func();
  1206. if (fixup_func) {
  1207. err = fixup_func(p_path, embedded_pos, embedded_size);
  1208. }
  1209. }
  1210. if (err == OK && !so_files.empty()) {
  1211. //if shared object files, copy them
  1212. da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  1213. for (int i = 0; i < so_files.size() && err == OK; i++) {
  1214. err = da->copy(so_files[i].path, p_path.get_base_dir().plus_file(so_files[i].path.get_file()));
  1215. if (err == OK) {
  1216. err = sign_shared_object(p_preset, p_debug, p_path.get_base_dir().plus_file(so_files[i].path.get_file()));
  1217. }
  1218. }
  1219. memdelete(da);
  1220. }
  1221. }
  1222. return err;
  1223. }
  1224. Error EditorExportPlatformPC::sign_shared_object(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path) {
  1225. return OK;
  1226. }
  1227. void EditorExportPlatformPC::set_extension(const String &p_extension, const String &p_feature_key) {
  1228. extensions[p_feature_key] = p_extension;
  1229. }
  1230. void EditorExportPlatformPC::set_name(const String &p_name) {
  1231. name = p_name;
  1232. }
  1233. void EditorExportPlatformPC::set_os_name(const String &p_name) {
  1234. os_name = p_name;
  1235. }
  1236. void EditorExportPlatformPC::set_logo(const Ref<Texture2D> &p_logo) {
  1237. logo = p_logo;
  1238. }
  1239. void EditorExportPlatformPC::set_release_64(const String &p_file) {
  1240. release_file_64 = p_file;
  1241. }
  1242. void EditorExportPlatformPC::set_release_32(const String &p_file) {
  1243. release_file_32 = p_file;
  1244. }
  1245. void EditorExportPlatformPC::set_debug_64(const String &p_file) {
  1246. debug_file_64 = p_file;
  1247. }
  1248. void EditorExportPlatformPC::set_debug_32(const String &p_file) {
  1249. debug_file_32 = p_file;
  1250. }
  1251. void EditorExportPlatformPC::add_platform_feature(const String &p_feature) {
  1252. extra_features.insert(p_feature);
  1253. }
  1254. void EditorExportPlatformPC::get_platform_features(List<String> *r_features) {
  1255. r_features->push_back("pc"); //all pcs support "pc"
  1256. r_features->push_back("s3tc"); //all pcs support "s3tc" compression
  1257. r_features->push_back(get_os_name()); //OS name is a feature
  1258. for (Set<String>::Element *E = extra_features.front(); E; E = E->next()) {
  1259. r_features->push_back(E->get());
  1260. }
  1261. }
  1262. void EditorExportPlatformPC::resolve_platform_feature_priorities(const Ref<EditorExportPreset> &p_preset, Set<String> &p_features) {
  1263. if (p_features.has("bptc")) {
  1264. if (p_preset->has("texture_format/no_bptc_fallbacks")) {
  1265. p_features.erase("s3tc");
  1266. }
  1267. }
  1268. }
  1269. int EditorExportPlatformPC::get_chmod_flags() const {
  1270. return chmod_flags;
  1271. }
  1272. void EditorExportPlatformPC::set_chmod_flags(int p_flags) {
  1273. chmod_flags = p_flags;
  1274. }
  1275. EditorExportPlatformPC::FixUpEmbeddedPckFunc EditorExportPlatformPC::get_fixup_embedded_pck_func() const {
  1276. return fixup_embedded_pck_func;
  1277. }
  1278. void EditorExportPlatformPC::set_fixup_embedded_pck_func(FixUpEmbeddedPckFunc p_fixup_embedded_pck_func) {
  1279. fixup_embedded_pck_func = p_fixup_embedded_pck_func;
  1280. }
  1281. EditorExportPlatformPC::EditorExportPlatformPC() {
  1282. chmod_flags = -1;
  1283. fixup_embedded_pck_func = nullptr;
  1284. }
  1285. ///////////////////////
  1286. void EditorExportTextSceneToBinaryPlugin::_export_file(const String &p_path, const String &p_type, const Set<String> &p_features) {
  1287. String extension = p_path.get_extension().to_lower();
  1288. if (extension != "tres" && extension != "tscn") {
  1289. return;
  1290. }
  1291. bool convert = GLOBAL_GET("editor/convert_text_resources_to_binary_on_export");
  1292. if (!convert)
  1293. return;
  1294. String tmp_path = EditorSettings::get_singleton()->get_cache_dir().plus_file("tmpfile.res");
  1295. Error err = ResourceFormatLoaderText::convert_file_to_binary(p_path, tmp_path);
  1296. if (err != OK) {
  1297. DirAccess::remove_file_or_error(tmp_path);
  1298. ERR_FAIL();
  1299. }
  1300. Vector<uint8_t> data = FileAccess::get_file_as_array(tmp_path);
  1301. if (data.size() == 0) {
  1302. DirAccess::remove_file_or_error(tmp_path);
  1303. ERR_FAIL();
  1304. }
  1305. DirAccess::remove_file_or_error(tmp_path);
  1306. add_file(p_path + ".converted.res", data, true);
  1307. }
  1308. EditorExportTextSceneToBinaryPlugin::EditorExportTextSceneToBinaryPlugin() {
  1309. GLOBAL_DEF("editor/convert_text_resources_to_binary_on_export", false);
  1310. }