export.cpp 48 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485
  1. /*************************************************************************/
  2. /* export.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2019 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2019 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 "export.h"
  31. #include "core/bind/core_bind.h"
  32. #include "core/io/marshalls.h"
  33. #include "core/io/zip_io.h"
  34. #include "core/object.h"
  35. #include "core/os/file_access.h"
  36. #include "core/project_settings.h"
  37. #include "core/version.h"
  38. #include "editor/editor_export.h"
  39. #include "editor/editor_node.h"
  40. #include "platform/uwp/logo.gen.h"
  41. #include "thirdparty/minizip/unzip.h"
  42. #include "thirdparty/minizip/zip.h"
  43. #include "thirdparty/misc/base64.h"
  44. #include "thirdparty/misc/sha256.h"
  45. #include <zlib.h>
  46. // Capabilities
  47. static const char *uwp_capabilities[] = {
  48. "allJoyn",
  49. "codeGeneration",
  50. "internetClient",
  51. "internetClientServer",
  52. "privateNetworkClientServer",
  53. NULL
  54. };
  55. static const char *uwp_uap_capabilities[] = {
  56. "appointments",
  57. "blockedChatMessages",
  58. "chat",
  59. "contacts",
  60. "enterpriseAuthentication",
  61. "musicLibrary",
  62. "objects3D",
  63. "picturesLibrary",
  64. "phoneCall",
  65. "removableStorage",
  66. "sharedUserCertificates",
  67. "userAccountInformation",
  68. "videosLibrary",
  69. "voipCall",
  70. NULL
  71. };
  72. static const char *uwp_device_capabilites[] = {
  73. "bluetooth",
  74. "location",
  75. "microphone",
  76. "proximity",
  77. "webcam",
  78. NULL
  79. };
  80. class AppxPackager {
  81. enum {
  82. FILE_HEADER_MAGIC = 0x04034b50,
  83. DATA_DESCRIPTOR_MAGIC = 0x08074b50,
  84. CENTRAL_DIR_MAGIC = 0x02014b50,
  85. END_OF_CENTRAL_DIR_MAGIC = 0x06054b50,
  86. ZIP64_END_OF_CENTRAL_DIR_MAGIC = 0x06064b50,
  87. ZIP64_END_DIR_LOCATOR_MAGIC = 0x07064b50,
  88. P7X_SIGNATURE = 0x58434b50,
  89. ZIP64_HEADER_ID = 0x0001,
  90. ZIP_VERSION = 20,
  91. ZIP_ARCHIVE_VERSION = 45,
  92. GENERAL_PURPOSE = 0x00,
  93. BASE_FILE_HEADER_SIZE = 30,
  94. DATA_DESCRIPTOR_SIZE = 24,
  95. BASE_CENTRAL_DIR_SIZE = 46,
  96. EXTRA_FIELD_LENGTH = 28,
  97. ZIP64_HEADER_SIZE = 24,
  98. ZIP64_END_OF_CENTRAL_DIR_SIZE = (56 - 12),
  99. END_OF_CENTRAL_DIR_SIZE = 42,
  100. BLOCK_SIZE = 65536,
  101. };
  102. struct BlockHash {
  103. String base64_hash;
  104. size_t compressed_size;
  105. };
  106. struct FileMeta {
  107. String name;
  108. int lfh_size;
  109. bool compressed;
  110. size_t compressed_size;
  111. size_t uncompressed_size;
  112. Vector<BlockHash> hashes;
  113. uLong file_crc32;
  114. ZPOS64_T zip_offset;
  115. FileMeta() :
  116. lfh_size(0),
  117. compressed(false),
  118. compressed_size(0),
  119. uncompressed_size(0),
  120. file_crc32(0),
  121. zip_offset(0) {}
  122. };
  123. String progress_task;
  124. FileAccess *package;
  125. String tmp_blockmap_file_path;
  126. String tmp_content_types_file_path;
  127. Set<String> mime_types;
  128. Vector<FileMeta> file_metadata;
  129. ZPOS64_T central_dir_offset;
  130. ZPOS64_T end_of_central_dir_offset;
  131. Vector<uint8_t> central_dir_data;
  132. String hash_block(const uint8_t *p_block_data, size_t p_block_len);
  133. void make_block_map();
  134. void make_content_types();
  135. _FORCE_INLINE_ unsigned int buf_put_int16(uint16_t p_val, uint8_t *p_buf) {
  136. for (int i = 0; i < 2; i++) {
  137. *p_buf++ = (p_val >> (i * 8)) & 0xFF;
  138. }
  139. return 2;
  140. }
  141. _FORCE_INLINE_ unsigned int buf_put_int32(uint32_t p_val, uint8_t *p_buf) {
  142. for (int i = 0; i < 4; i++) {
  143. *p_buf++ = (p_val >> (i * 8)) & 0xFF;
  144. }
  145. return 4;
  146. }
  147. _FORCE_INLINE_ unsigned int buf_put_int64(uint64_t p_val, uint8_t *p_buf) {
  148. for (int i = 0; i < 8; i++) {
  149. *p_buf++ = (p_val >> (i * 8)) & 0xFF;
  150. }
  151. return 8;
  152. }
  153. _FORCE_INLINE_ unsigned int buf_put_string(String p_val, uint8_t *p_buf) {
  154. for (int i = 0; i < p_val.length(); i++) {
  155. *p_buf++ = p_val.utf8().get(i);
  156. }
  157. return p_val.length();
  158. }
  159. Vector<uint8_t> make_file_header(FileMeta p_file_meta);
  160. void store_central_dir_header(const FileMeta &p_file, bool p_do_hash = true);
  161. Vector<uint8_t> make_end_of_central_record();
  162. String content_type(String p_extension);
  163. public:
  164. void set_progress_task(String p_task) { progress_task = p_task; }
  165. void init(FileAccess *p_fa);
  166. void add_file(String p_file_name, const uint8_t *p_buffer, size_t p_len, int p_file_no, int p_total_files, bool p_compress = false);
  167. void finish();
  168. AppxPackager();
  169. ~AppxPackager();
  170. };
  171. ///////////////////////////////////////////////////////////////////////////
  172. String AppxPackager::hash_block(const uint8_t *p_block_data, size_t p_block_len) {
  173. char hash[32];
  174. char base64[45];
  175. sha256_context ctx;
  176. sha256_init(&ctx);
  177. sha256_hash(&ctx, (uint8_t *)p_block_data, p_block_len);
  178. sha256_done(&ctx, (uint8_t *)hash);
  179. base64_encode(base64, hash, 32);
  180. base64[44] = '\0';
  181. return String(base64);
  182. }
  183. void AppxPackager::make_block_map() {
  184. FileAccess *tmp_file = FileAccess::open(tmp_blockmap_file_path, FileAccess::WRITE);
  185. tmp_file->store_string("<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>");
  186. tmp_file->store_string("<BlockMap xmlns=\"http://schemas.microsoft.com/appx/2010/blockmap\" HashMethod=\"http://www.w3.org/2001/04/xmlenc#sha256\">");
  187. for (int i = 0; i < file_metadata.size(); i++) {
  188. FileMeta file = file_metadata[i];
  189. tmp_file->store_string(
  190. "<File Name=\"" + file.name.replace("/", "\\") + "\" Size=\"" + itos(file.uncompressed_size) + "\" LfhSize=\"" + itos(file.lfh_size) + "\">");
  191. for (int j = 0; j < file.hashes.size(); j++) {
  192. tmp_file->store_string("<Block Hash=\"" + file.hashes[j].base64_hash + "\" ");
  193. if (file.compressed)
  194. tmp_file->store_string("Size=\"" + itos(file.hashes[j].compressed_size) + "\" ");
  195. tmp_file->store_string("/>");
  196. }
  197. tmp_file->store_string("</File>");
  198. }
  199. tmp_file->store_string("</BlockMap>");
  200. tmp_file->close();
  201. memdelete(tmp_file);
  202. tmp_file = NULL;
  203. }
  204. String AppxPackager::content_type(String p_extension) {
  205. if (p_extension == "png")
  206. return "image/png";
  207. else if (p_extension == "jpg")
  208. return "image/jpg";
  209. else if (p_extension == "xml")
  210. return "application/xml";
  211. else if (p_extension == "exe" || p_extension == "dll")
  212. return "application/x-msdownload";
  213. else
  214. return "application/octet-stream";
  215. }
  216. void AppxPackager::make_content_types() {
  217. FileAccess *tmp_file = FileAccess::open(tmp_content_types_file_path, FileAccess::WRITE);
  218. tmp_file->store_string("<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
  219. tmp_file->store_string("<Types xmlns=\"http://schemas.openxmlformats.org/package/2006/content-types\">");
  220. Map<String, String> types;
  221. for (int i = 0; i < file_metadata.size(); i++) {
  222. String ext = file_metadata[i].name.get_extension();
  223. if (types.has(ext)) continue;
  224. types[ext] = content_type(ext);
  225. tmp_file->store_string("<Default Extension=\"" + ext + "\" ContentType=\"" + types[ext] + "\" />");
  226. }
  227. // Appx signature file
  228. tmp_file->store_string("<Default Extension=\"p7x\" ContentType=\"application/octet-stream\" />");
  229. // Override for package files
  230. tmp_file->store_string("<Override PartName=\"/AppxManifest.xml\" ContentType=\"application/vnd.ms-appx.manifest+xml\" />");
  231. tmp_file->store_string("<Override PartName=\"/AppxBlockMap.xml\" ContentType=\"application/vnd.ms-appx.blockmap+xml\" />");
  232. tmp_file->store_string("<Override PartName=\"/AppxSignature.p7x\" ContentType=\"application/vnd.ms-appx.signature\" />");
  233. tmp_file->store_string("<Override PartName=\"/AppxMetadata/CodeIntegrity.cat\" ContentType=\"application/vnd.ms-pkiseccat\" />");
  234. tmp_file->store_string("</Types>");
  235. tmp_file->close();
  236. memdelete(tmp_file);
  237. tmp_file = NULL;
  238. }
  239. Vector<uint8_t> AppxPackager::make_file_header(FileMeta p_file_meta) {
  240. Vector<uint8_t> buf;
  241. buf.resize(BASE_FILE_HEADER_SIZE + p_file_meta.name.length());
  242. int offs = 0;
  243. // Write magic
  244. offs += buf_put_int32(FILE_HEADER_MAGIC, &buf.write[offs]);
  245. // Version
  246. offs += buf_put_int16(ZIP_VERSION, &buf.write[offs]);
  247. // Special flag
  248. offs += buf_put_int16(GENERAL_PURPOSE, &buf.write[offs]);
  249. // Compression
  250. offs += buf_put_int16(p_file_meta.compressed ? Z_DEFLATED : 0, &buf.write[offs]);
  251. // File date and time
  252. offs += buf_put_int32(0, &buf.write[offs]);
  253. // CRC-32
  254. offs += buf_put_int32(p_file_meta.file_crc32, &buf.write[offs]);
  255. // Compressed size
  256. offs += buf_put_int32(p_file_meta.compressed_size, &buf.write[offs]);
  257. // Uncompressed size
  258. offs += buf_put_int32(p_file_meta.uncompressed_size, &buf.write[offs]);
  259. // File name length
  260. offs += buf_put_int16(p_file_meta.name.length(), &buf.write[offs]);
  261. // Extra data length
  262. offs += buf_put_int16(0, &buf.write[offs]);
  263. // File name
  264. offs += buf_put_string(p_file_meta.name, &buf.write[offs]);
  265. // Done!
  266. return buf;
  267. }
  268. void AppxPackager::store_central_dir_header(const FileMeta &p_file, bool p_do_hash) {
  269. Vector<uint8_t> &buf = central_dir_data;
  270. int offs = buf.size();
  271. buf.resize(buf.size() + BASE_CENTRAL_DIR_SIZE + p_file.name.length());
  272. // Write magic
  273. offs += buf_put_int32(CENTRAL_DIR_MAGIC, &buf.write[offs]);
  274. // ZIP versions
  275. offs += buf_put_int16(ZIP_ARCHIVE_VERSION, &buf.write[offs]);
  276. offs += buf_put_int16(ZIP_VERSION, &buf.write[offs]);
  277. // General purpose flag
  278. offs += buf_put_int16(GENERAL_PURPOSE, &buf.write[offs]);
  279. // Compression
  280. offs += buf_put_int16(p_file.compressed ? Z_DEFLATED : 0, &buf.write[offs]);
  281. // Modification date/time
  282. offs += buf_put_int32(0, &buf.write[offs]);
  283. // Crc-32
  284. offs += buf_put_int32(p_file.file_crc32, &buf.write[offs]);
  285. // File sizes
  286. offs += buf_put_int32(p_file.compressed_size, &buf.write[offs]);
  287. offs += buf_put_int32(p_file.uncompressed_size, &buf.write[offs]);
  288. // File name length
  289. offs += buf_put_int16(p_file.name.length(), &buf.write[offs]);
  290. // Extra field length
  291. offs += buf_put_int16(0, &buf.write[offs]);
  292. // Comment length
  293. offs += buf_put_int16(0, &buf.write[offs]);
  294. // Disk number start, internal/external file attributes
  295. for (int i = 0; i < 8; i++) {
  296. buf.write[offs++] = 0;
  297. }
  298. // Relative offset
  299. offs += buf_put_int32(p_file.zip_offset, &buf.write[offs]);
  300. // File name
  301. offs += buf_put_string(p_file.name, &buf.write[offs]);
  302. // Done!
  303. }
  304. Vector<uint8_t> AppxPackager::make_end_of_central_record() {
  305. Vector<uint8_t> buf;
  306. buf.resize(ZIP64_END_OF_CENTRAL_DIR_SIZE + 12 + END_OF_CENTRAL_DIR_SIZE); // Size plus magic
  307. int offs = 0;
  308. // Write magic
  309. offs += buf_put_int32(ZIP64_END_OF_CENTRAL_DIR_MAGIC, &buf.write[offs]);
  310. // Size of this record
  311. offs += buf_put_int64(ZIP64_END_OF_CENTRAL_DIR_SIZE, &buf.write[offs]);
  312. // Version (yes, twice)
  313. offs += buf_put_int16(ZIP_ARCHIVE_VERSION, &buf.write[offs]);
  314. offs += buf_put_int16(ZIP_ARCHIVE_VERSION, &buf.write[offs]);
  315. // Disk number
  316. for (int i = 0; i < 8; i++) {
  317. buf.write[offs++] = 0;
  318. }
  319. // Number of entries (total and per disk)
  320. offs += buf_put_int64(file_metadata.size(), &buf.write[offs]);
  321. offs += buf_put_int64(file_metadata.size(), &buf.write[offs]);
  322. // Size of central dir
  323. offs += buf_put_int64(central_dir_data.size(), &buf.write[offs]);
  324. // Central dir offset
  325. offs += buf_put_int64(central_dir_offset, &buf.write[offs]);
  326. ////// ZIP64 locator
  327. // Write magic for zip64 central dir locator
  328. offs += buf_put_int32(ZIP64_END_DIR_LOCATOR_MAGIC, &buf.write[offs]);
  329. // Disk number
  330. for (int i = 0; i < 4; i++) {
  331. buf.write[offs++] = 0;
  332. }
  333. // Relative offset
  334. offs += buf_put_int64(end_of_central_dir_offset, &buf.write[offs]);
  335. // Number of disks
  336. offs += buf_put_int32(1, &buf.write[offs]);
  337. /////// End of zip directory
  338. // Write magic for end central dir
  339. offs += buf_put_int32(END_OF_CENTRAL_DIR_MAGIC, &buf.write[offs]);
  340. // Dummy stuff for Zip64
  341. for (int i = 0; i < 4; i++) {
  342. buf.write[offs++] = 0x0;
  343. }
  344. for (int i = 0; i < 12; i++) {
  345. buf.write[offs++] = 0xFF;
  346. }
  347. // Size of comments
  348. for (int i = 0; i < 2; i++) {
  349. buf.write[offs++] = 0;
  350. }
  351. // Done!
  352. return buf;
  353. }
  354. void AppxPackager::init(FileAccess *p_fa) {
  355. package = p_fa;
  356. central_dir_offset = 0;
  357. end_of_central_dir_offset = 0;
  358. tmp_blockmap_file_path = EditorSettings::get_singleton()->get_cache_dir().plus_file("tmpblockmap.xml");
  359. tmp_content_types_file_path = EditorSettings::get_singleton()->get_cache_dir().plus_file("tmpcontenttypes.xml");
  360. }
  361. void AppxPackager::add_file(String p_file_name, const uint8_t *p_buffer, size_t p_len, int p_file_no, int p_total_files, bool p_compress) {
  362. if (p_file_no >= 1 && p_total_files >= 1) {
  363. EditorNode::progress_task_step(progress_task, "File: " + p_file_name, (p_file_no * 100) / p_total_files);
  364. }
  365. FileMeta meta;
  366. meta.name = p_file_name;
  367. meta.uncompressed_size = p_len;
  368. meta.compressed_size = p_len;
  369. meta.compressed = p_compress;
  370. meta.zip_offset = package->get_position();
  371. Vector<uint8_t> file_buffer;
  372. // Data for compression
  373. z_stream strm;
  374. FileAccess *strm_f = NULL;
  375. Vector<uint8_t> strm_in;
  376. strm_in.resize(BLOCK_SIZE);
  377. Vector<uint8_t> strm_out;
  378. if (p_compress) {
  379. strm.zalloc = zipio_alloc;
  380. strm.zfree = zipio_free;
  381. strm.opaque = &strm_f;
  382. strm_out.resize(BLOCK_SIZE + 8);
  383. deflateInit2(&strm, Z_DEFAULT_COMPRESSION, Z_DEFLATED, -15, 8, Z_DEFAULT_STRATEGY);
  384. }
  385. int step = 0;
  386. while (p_len - step > 0) {
  387. size_t block_size = (p_len - step) > BLOCK_SIZE ? BLOCK_SIZE : (p_len - step);
  388. for (uint32_t i = 0; i < block_size; i++) {
  389. strm_in.write[i] = p_buffer[step + i];
  390. }
  391. BlockHash bh;
  392. bh.base64_hash = hash_block(strm_in.ptr(), block_size);
  393. if (p_compress) {
  394. strm.avail_in = block_size;
  395. strm.avail_out = strm_out.size();
  396. strm.next_in = (uint8_t *)strm_in.ptr();
  397. strm.next_out = strm_out.ptrw();
  398. int total_out_before = strm.total_out;
  399. deflate(&strm, Z_FULL_FLUSH);
  400. bh.compressed_size = strm.total_out - total_out_before;
  401. //package->store_buffer(strm_out.ptr(), strm.total_out - total_out_before);
  402. int start = file_buffer.size();
  403. file_buffer.resize(file_buffer.size() + bh.compressed_size);
  404. for (uint32_t i = 0; i < bh.compressed_size; i++)
  405. file_buffer.write[start + i] = strm_out[i];
  406. } else {
  407. bh.compressed_size = block_size;
  408. //package->store_buffer(strm_in.ptr(), block_size);
  409. int start = file_buffer.size();
  410. file_buffer.resize(file_buffer.size() + block_size);
  411. for (uint32_t i = 0; i < bh.compressed_size; i++)
  412. file_buffer.write[start + i] = strm_in[i];
  413. }
  414. meta.hashes.push_back(bh);
  415. step += block_size;
  416. }
  417. if (p_compress) {
  418. strm.avail_in = 0;
  419. strm.avail_out = strm_out.size();
  420. strm.next_in = (uint8_t *)strm_in.ptr();
  421. strm.next_out = strm_out.ptrw();
  422. int total_out_before = strm.total_out;
  423. deflate(&strm, Z_FINISH);
  424. //package->store_buffer(strm_out.ptr(), strm.total_out - total_out_before);
  425. int start = file_buffer.size();
  426. file_buffer.resize(file_buffer.size() + (strm.total_out - total_out_before));
  427. for (uint32_t i = 0; i < (strm.total_out - total_out_before); i++)
  428. file_buffer.write[start + i] = strm_out[i];
  429. deflateEnd(&strm);
  430. meta.compressed_size = strm.total_out;
  431. } else {
  432. meta.compressed_size = p_len;
  433. }
  434. // Calculate file CRC-32
  435. uLong crc = crc32(0L, Z_NULL, 0);
  436. crc = crc32(crc, p_buffer, p_len);
  437. meta.file_crc32 = crc;
  438. // Create file header
  439. Vector<uint8_t> file_header = make_file_header(meta);
  440. meta.lfh_size = file_header.size();
  441. // Store the header and file;
  442. package->store_buffer(file_header.ptr(), file_header.size());
  443. package->store_buffer(file_buffer.ptr(), file_buffer.size());
  444. file_metadata.push_back(meta);
  445. }
  446. void AppxPackager::finish() {
  447. // Create and add block map file
  448. EditorNode::progress_task_step("export", "Creating block map...", 4);
  449. make_block_map();
  450. FileAccess *blockmap_file = FileAccess::open(tmp_blockmap_file_path, FileAccess::READ);
  451. Vector<uint8_t> blockmap_buffer;
  452. blockmap_buffer.resize(blockmap_file->get_len());
  453. blockmap_file->get_buffer(blockmap_buffer.ptrw(), blockmap_buffer.size());
  454. add_file("AppxBlockMap.xml", blockmap_buffer.ptr(), blockmap_buffer.size(), -1, -1, true);
  455. blockmap_file->close();
  456. memdelete(blockmap_file);
  457. blockmap_file = NULL;
  458. // Add content types
  459. EditorNode::progress_task_step("export", "Setting content types...", 5);
  460. make_content_types();
  461. FileAccess *types_file = FileAccess::open(tmp_content_types_file_path, FileAccess::READ);
  462. Vector<uint8_t> types_buffer;
  463. types_buffer.resize(types_file->get_len());
  464. types_file->get_buffer(types_buffer.ptrw(), types_buffer.size());
  465. add_file("[Content_Types].xml", types_buffer.ptr(), types_buffer.size(), -1, -1, true);
  466. types_file->close();
  467. memdelete(types_file);
  468. types_file = NULL;
  469. // Pre-process central directory before signing
  470. for (int i = 0; i < file_metadata.size(); i++) {
  471. store_central_dir_header(file_metadata[i]);
  472. }
  473. // Write central directory
  474. EditorNode::progress_task_step("export", "Finishing package...", 6);
  475. central_dir_offset = package->get_position();
  476. package->store_buffer(central_dir_data.ptr(), central_dir_data.size());
  477. // End record
  478. end_of_central_dir_offset = package->get_position();
  479. Vector<uint8_t> end_record = make_end_of_central_record();
  480. package->store_buffer(end_record.ptr(), end_record.size());
  481. package->close();
  482. memdelete(package);
  483. package = NULL;
  484. }
  485. AppxPackager::AppxPackager() {}
  486. AppxPackager::~AppxPackager() {}
  487. ////////////////////////////////////////////////////////////////////
  488. class EditorExportUWP : public EditorExportPlatform {
  489. GDCLASS(EditorExportUWP, EditorExportPlatform);
  490. Ref<ImageTexture> logo;
  491. enum Platform {
  492. ARM,
  493. X86,
  494. X64
  495. };
  496. bool _valid_resource_name(const String &p_name) const {
  497. if (p_name.empty()) return false;
  498. if (p_name.ends_with(".")) return false;
  499. static const char *invalid_names[] = {
  500. "CON", "PRN", "AUX", "NUL", "COM1", "COM2", "COM3", "COM4", "COM5", "COM6", "COM7",
  501. "COM8", "COM9", "LPT1", "LPT2", "LPT3", "LPT4", "LPT5", "LPT6", "LPT7", "LPT8", "LPT9",
  502. NULL
  503. };
  504. const char **t = invalid_names;
  505. while (*t) {
  506. if (p_name == *t) return false;
  507. t++;
  508. }
  509. return true;
  510. }
  511. bool _valid_guid(const String &p_guid) const {
  512. Vector<String> parts = p_guid.split("-");
  513. if (parts.size() != 5) return false;
  514. if (parts[0].length() != 8) return false;
  515. for (int i = 1; i < 4; i++)
  516. if (parts[i].length() != 4) return false;
  517. if (parts[4].length() != 12) return false;
  518. return true;
  519. }
  520. bool _valid_bgcolor(const String &p_color) const {
  521. if (p_color.empty()) return true;
  522. if (p_color.begins_with("#") && p_color.is_valid_html_color()) return true;
  523. // Colors from https://msdn.microsoft.com/en-us/library/windows/apps/dn934817.aspx
  524. static const char *valid_colors[] = {
  525. "aliceBlue", "antiqueWhite", "aqua", "aquamarine", "azure", "beige",
  526. "bisque", "black", "blanchedAlmond", "blue", "blueViolet", "brown",
  527. "burlyWood", "cadetBlue", "chartreuse", "chocolate", "coral", "cornflowerBlue",
  528. "cornsilk", "crimson", "cyan", "darkBlue", "darkCyan", "darkGoldenrod",
  529. "darkGray", "darkGreen", "darkKhaki", "darkMagenta", "darkOliveGreen", "darkOrange",
  530. "darkOrchid", "darkRed", "darkSalmon", "darkSeaGreen", "darkSlateBlue", "darkSlateGray",
  531. "darkTurquoise", "darkViolet", "deepPink", "deepSkyBlue", "dimGray", "dodgerBlue",
  532. "firebrick", "floralWhite", "forestGreen", "fuchsia", "gainsboro", "ghostWhite",
  533. "gold", "goldenrod", "gray", "green", "greenYellow", "honeydew",
  534. "hotPink", "indianRed", "indigo", "ivory", "khaki", "lavender",
  535. "lavenderBlush", "lawnGreen", "lemonChiffon", "lightBlue", "lightCoral", "lightCyan",
  536. "lightGoldenrodYellow", "lightGreen", "lightGray", "lightPink", "lightSalmon", "lightSeaGreen",
  537. "lightSkyBlue", "lightSlateGray", "lightSteelBlue", "lightYellow", "lime", "limeGreen",
  538. "linen", "magenta", "maroon", "mediumAquamarine", "mediumBlue", "mediumOrchid",
  539. "mediumPurple", "mediumSeaGreen", "mediumSlateBlue", "mediumSpringGreen", "mediumTurquoise", "mediumVioletRed",
  540. "midnightBlue", "mintCream", "mistyRose", "moccasin", "navajoWhite", "navy",
  541. "oldLace", "olive", "oliveDrab", "orange", "orangeRed", "orchid",
  542. "paleGoldenrod", "paleGreen", "paleTurquoise", "paleVioletRed", "papayaWhip", "peachPuff",
  543. "peru", "pink", "plum", "powderBlue", "purple", "red",
  544. "rosyBrown", "royalBlue", "saddleBrown", "salmon", "sandyBrown", "seaGreen",
  545. "seaShell", "sienna", "silver", "skyBlue", "slateBlue", "slateGray",
  546. "snow", "springGreen", "steelBlue", "tan", "teal", "thistle",
  547. "tomato", "transparent", "turquoise", "violet", "wheat", "white",
  548. "whiteSmoke", "yellow", "yellowGreen",
  549. NULL
  550. };
  551. const char **color = valid_colors;
  552. while (*color) {
  553. if (p_color == *color) return true;
  554. color++;
  555. }
  556. return false;
  557. }
  558. bool _valid_image(const StreamTexture *p_image, int p_width, int p_height) const {
  559. if (!p_image) {
  560. return false;
  561. }
  562. // TODO: Add resource creation or image rescaling to enable other scales:
  563. // 1.25, 1.5, 2.0
  564. real_t scales[] = { 1.0 };
  565. bool valid_w = false;
  566. bool valid_h = false;
  567. for (int i = 0; i < 1; i++) {
  568. int w = ceil(p_width * scales[i]);
  569. int h = ceil(p_height * scales[i]);
  570. if (w == p_image->get_width())
  571. valid_w = true;
  572. if (h == p_image->get_height())
  573. valid_h = true;
  574. }
  575. return valid_w && valid_h;
  576. }
  577. Vector<uint8_t> _fix_manifest(const Ref<EditorExportPreset> &p_preset, const Vector<uint8_t> &p_template, bool p_give_internet) const {
  578. String result = String::utf8((const char *)p_template.ptr(), p_template.size());
  579. result = result.replace("$godot_version$", VERSION_FULL_NAME);
  580. result = result.replace("$identity_name$", p_preset->get("package/unique_name"));
  581. result = result.replace("$publisher$", p_preset->get("package/publisher"));
  582. result = result.replace("$product_guid$", p_preset->get("identity/product_guid"));
  583. result = result.replace("$publisher_guid$", p_preset->get("identity/publisher_guid"));
  584. String version = itos(p_preset->get("version/major")) + "." + itos(p_preset->get("version/minor")) + "." + itos(p_preset->get("version/build")) + "." + itos(p_preset->get("version/revision"));
  585. result = result.replace("$version_string$", version);
  586. Platform arch = (Platform)(int)p_preset->get("architecture/target");
  587. String architecture = arch == ARM ? "arm" : arch == X86 ? "x86" : "x64";
  588. result = result.replace("$architecture$", architecture);
  589. result = result.replace("$display_name$", String(p_preset->get("package/display_name")).empty() ? (String)ProjectSettings::get_singleton()->get("application/config/name") : String(p_preset->get("package/display_name")));
  590. result = result.replace("$publisher_display_name$", p_preset->get("package/publisher_display_name"));
  591. result = result.replace("$app_description$", p_preset->get("package/description"));
  592. result = result.replace("$bg_color$", p_preset->get("images/background_color"));
  593. result = result.replace("$short_name$", p_preset->get("package/short_name"));
  594. String name_on_tiles = "";
  595. if ((bool)p_preset->get("tiles/show_name_on_square150x150")) {
  596. name_on_tiles += " <uap:ShowOn Tile=\"square150x150Logo\" />\n";
  597. }
  598. if ((bool)p_preset->get("tiles/show_name_on_wide310x150")) {
  599. name_on_tiles += " <uap:ShowOn Tile=\"wide310x150Logo\" />\n";
  600. }
  601. if ((bool)p_preset->get("tiles/show_name_on_square310x310")) {
  602. name_on_tiles += " <uap:ShowOn Tile=\"square310x310Logo\" />\n";
  603. }
  604. String show_name_on_tiles = "";
  605. if (!name_on_tiles.empty()) {
  606. show_name_on_tiles = "<uap:ShowNameOnTiles>\n" + name_on_tiles + " </uap:ShowNameOnTiles>";
  607. }
  608. result = result.replace("$name_on_tiles$", name_on_tiles);
  609. String rotations = "";
  610. if ((bool)p_preset->get("orientation/landscape")) {
  611. rotations += " <uap:Rotation Preference=\"landscape\" />\n";
  612. }
  613. if ((bool)p_preset->get("orientation/portrait")) {
  614. rotations += " <uap:Rotation Preference=\"portrait\" />\n";
  615. }
  616. if ((bool)p_preset->get("orientation/landscape_flipped")) {
  617. rotations += " <uap:Rotation Preference=\"landscapeFlipped\" />\n";
  618. }
  619. if ((bool)p_preset->get("orientation/portrait_flipped")) {
  620. rotations += " <uap:Rotation Preference=\"portraitFlipped\" />\n";
  621. }
  622. String rotation_preference = "";
  623. if (!rotations.empty()) {
  624. rotation_preference = "<uap:InitialRotationPreference>\n" + rotations + " </uap:InitialRotationPreference>";
  625. }
  626. result = result.replace("$rotation_preference$", rotation_preference);
  627. String capabilities_elements = "";
  628. const char **basic = uwp_capabilities;
  629. while (*basic) {
  630. if ((bool)p_preset->get("capabilities/" + String(*basic))) {
  631. capabilities_elements += " <Capability Name=\"" + String(*basic) + "\" />\n";
  632. }
  633. basic++;
  634. }
  635. const char **uap = uwp_uap_capabilities;
  636. while (*uap) {
  637. if ((bool)p_preset->get("capabilities/" + String(*uap))) {
  638. capabilities_elements += " <uap:Capability Name=\"" + String(*uap) + "\" />\n";
  639. }
  640. uap++;
  641. }
  642. const char **device = uwp_device_capabilites;
  643. while (*device) {
  644. if ((bool)p_preset->get("capabilities/" + String(*device))) {
  645. capabilities_elements += " <DeviceCapability Name=\"" + String(*device) + "\" />\n";
  646. }
  647. device++;
  648. }
  649. if (!((bool)p_preset->get("capabilities/internetClient")) && p_give_internet) {
  650. capabilities_elements += " <Capability Name=\"internetClient\" />\n";
  651. }
  652. String capabilities_string = "<Capabilities />";
  653. if (!capabilities_elements.empty()) {
  654. capabilities_string = "<Capabilities>\n" + capabilities_elements + " </Capabilities>";
  655. }
  656. result = result.replace("$capabilities_place$", capabilities_string);
  657. Vector<uint8_t> r_ret;
  658. r_ret.resize(result.length());
  659. for (int i = 0; i < result.length(); i++)
  660. r_ret.write[i] = result.utf8().get(i);
  661. return r_ret;
  662. }
  663. Vector<uint8_t> _get_image_data(const Ref<EditorExportPreset> &p_preset, const String &p_path) {
  664. Vector<uint8_t> data;
  665. StreamTexture *image = NULL;
  666. if (p_path.find("StoreLogo") != -1) {
  667. image = p_preset->get("images/store_logo").is_zero() ? NULL : Object::cast_to<StreamTexture>(((Object *)p_preset->get("images/store_logo")));
  668. } else if (p_path.find("Square44x44Logo") != -1) {
  669. image = p_preset->get("images/square44x44_logo").is_zero() ? NULL : Object::cast_to<StreamTexture>(((Object *)p_preset->get("images/square44x44_logo")));
  670. } else if (p_path.find("Square71x71Logo") != -1) {
  671. image = p_preset->get("images/square71x71_logo").is_zero() ? NULL : Object::cast_to<StreamTexture>(((Object *)p_preset->get("images/square71x71_logo")));
  672. } else if (p_path.find("Square150x150Logo") != -1) {
  673. image = p_preset->get("images/square150x150_logo").is_zero() ? NULL : Object::cast_to<StreamTexture>(((Object *)p_preset->get("images/square150x150_logo")));
  674. } else if (p_path.find("Square310x310Logo") != -1) {
  675. image = p_preset->get("images/square310x310_logo").is_zero() ? NULL : Object::cast_to<StreamTexture>(((Object *)p_preset->get("images/square310x310_logo")));
  676. } else if (p_path.find("Wide310x150Logo") != -1) {
  677. image = p_preset->get("images/wide310x150_logo").is_zero() ? NULL : Object::cast_to<StreamTexture>(((Object *)p_preset->get("images/wide310x150_logo")));
  678. } else if (p_path.find("SplashScreen") != -1) {
  679. image = p_preset->get("images/splash_screen").is_zero() ? NULL : Object::cast_to<StreamTexture>(((Object *)p_preset->get("images/splash_screen")));
  680. } else {
  681. ERR_PRINT("Unable to load logo");
  682. }
  683. if (!image) return data;
  684. String tmp_path = EditorSettings::get_singleton()->get_cache_dir().plus_file("uwp_tmp_logo.png");
  685. Error err = image->get_data()->save_png(tmp_path);
  686. if (err != OK) {
  687. String err_string = "Couldn't save temp logo file.";
  688. EditorNode::add_io_error(err_string);
  689. ERR_EXPLAIN(err_string);
  690. ERR_FAIL_V(data);
  691. }
  692. FileAccess *f = FileAccess::open(tmp_path, FileAccess::READ, &err);
  693. if (err != OK) {
  694. String err_string = "Couldn't open temp logo file.";
  695. EditorNode::add_io_error(err_string);
  696. ERR_EXPLAIN(err_string);
  697. ERR_FAIL_V(data);
  698. }
  699. data.resize(f->get_len());
  700. f->get_buffer(data.ptrw(), data.size());
  701. f->close();
  702. memdelete(f);
  703. // Delete temp file
  704. DirAccess *dir = DirAccess::open(tmp_path.get_base_dir(), &err);
  705. if (err != OK) {
  706. String err_string = "Couldn't open temp path to remove temp logo file.";
  707. EditorNode::add_io_error(err_string);
  708. ERR_EXPLAIN(err_string);
  709. ERR_FAIL_V(data);
  710. }
  711. err = dir->remove(tmp_path);
  712. memdelete(dir);
  713. if (err != OK) {
  714. String err_string = "Couldn't remove temp logo file.";
  715. EditorNode::add_io_error(err_string);
  716. ERR_EXPLAIN(err_string);
  717. ERR_FAIL_V(data);
  718. }
  719. return data;
  720. }
  721. static bool _should_compress_asset(const String &p_path, const Vector<uint8_t> &p_data) {
  722. /* TODO: This was copied verbatim from Android export. It should be
  723. * refactored to the parent class and also be used for .zip export.
  724. */
  725. /*
  726. * By not compressing files with little or not benefit in doing so,
  727. * a performance gain is expected at runtime. Moreover, if the APK is
  728. * zip-aligned, assets stored as they are can be efficiently read by
  729. * Android by memory-mapping them.
  730. */
  731. // -- Unconditional uncompress to mimic AAPT plus some other
  732. static const char *unconditional_compress_ext[] = {
  733. // From https://github.com/android/platform_frameworks_base/blob/master/tools/aapt/Package.cpp
  734. // These formats are already compressed, or don't compress well:
  735. ".jpg", ".jpeg", ".png", ".gif",
  736. ".wav", ".mp2", ".mp3", ".ogg", ".aac",
  737. ".mpg", ".mpeg", ".mid", ".midi", ".smf", ".jet",
  738. ".rtttl", ".imy", ".xmf", ".mp4", ".m4a",
  739. ".m4v", ".3gp", ".3gpp", ".3g2", ".3gpp2",
  740. ".amr", ".awb", ".wma", ".wmv",
  741. // Godot-specific:
  742. ".webp", // Same reasoning as .png
  743. ".cfb", // Don't let small config files slow-down startup
  744. ".scn", // Binary scenes are usually already compressed
  745. ".stex", // Streamable textures are usually already compressed
  746. // Trailer for easier processing
  747. NULL
  748. };
  749. for (const char **ext = unconditional_compress_ext; *ext; ++ext) {
  750. if (p_path.to_lower().ends_with(String(*ext))) {
  751. return false;
  752. }
  753. }
  754. // -- Compressed resource?
  755. if (p_data.size() >= 4 && p_data[0] == 'R' && p_data[1] == 'S' && p_data[2] == 'C' && p_data[3] == 'C') {
  756. // Already compressed
  757. return false;
  758. }
  759. // --- TODO: Decide on texture resources according to their image compression setting
  760. return true;
  761. }
  762. static Error save_appx_file(void *p_userdata, const String &p_path, const Vector<uint8_t> &p_data, int p_file, int p_total) {
  763. AppxPackager *packager = (AppxPackager *)p_userdata;
  764. String dst_path = p_path.replace_first("res://", "game/");
  765. packager->add_file(dst_path, p_data.ptr(), p_data.size(), p_file, p_total, _should_compress_asset(p_path, p_data));
  766. return OK;
  767. }
  768. public:
  769. virtual String get_name() const {
  770. return "Windows Universal";
  771. }
  772. virtual String get_os_name() const {
  773. return "UWP";
  774. }
  775. virtual List<String> get_binary_extensions(const Ref<EditorExportPreset> &p_preset) const {
  776. List<String> list;
  777. list.push_back("appx");
  778. return list;
  779. }
  780. virtual Ref<Texture> get_logo() const {
  781. return logo;
  782. }
  783. virtual void get_preset_features(const Ref<EditorExportPreset> &p_preset, List<String> *r_features) {
  784. r_features->push_back("s3tc");
  785. r_features->push_back("etc");
  786. switch ((int)p_preset->get("architecture/target")) {
  787. case EditorExportUWP::ARM: {
  788. r_features->push_back("arm");
  789. } break;
  790. case EditorExportUWP::X86: {
  791. r_features->push_back("32");
  792. } break;
  793. case EditorExportUWP::X64: {
  794. r_features->push_back("64");
  795. } break;
  796. }
  797. }
  798. virtual void get_export_options(List<ExportOption> *r_options) {
  799. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "architecture/target", PROPERTY_HINT_ENUM, "arm,x86,x64"), 1));
  800. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "command_line/extra_args"), ""));
  801. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "package/display_name", PROPERTY_HINT_PLACEHOLDER_TEXT, "Game Name"), ""));
  802. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "package/short_name", PROPERTY_HINT_PLACEHOLDER_TEXT, "Game Name"), ""));
  803. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "package/unique_name", PROPERTY_HINT_PLACEHOLDER_TEXT, "Game.Name"), ""));
  804. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "package/description"), ""));
  805. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "package/publisher", PROPERTY_HINT_PLACEHOLDER_TEXT, "CN=CompanyName"), ""));
  806. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "package/publisher_display_name", PROPERTY_HINT_PLACEHOLDER_TEXT, "Company Name"), ""));
  807. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "identity/product_guid", PROPERTY_HINT_PLACEHOLDER_TEXT, "00000000-0000-0000-0000-000000000000"), ""));
  808. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "identity/publisher_guid", PROPERTY_HINT_PLACEHOLDER_TEXT, "00000000-0000-0000-0000-000000000000"), ""));
  809. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "signing/certificate", PROPERTY_HINT_GLOBAL_FILE, "*.pfx"), ""));
  810. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "signing/password"), ""));
  811. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "signing/algorithm", PROPERTY_HINT_ENUM, "MD5,SHA1,SHA256"), 2));
  812. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "version/major"), 1));
  813. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "version/minor"), 0));
  814. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "version/build"), 0));
  815. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "version/revision"), 0));
  816. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "orientation/landscape"), true));
  817. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "orientation/portrait"), true));
  818. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "orientation/landscape_flipped"), true));
  819. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "orientation/portrait_flipped"), true));
  820. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "images/background_color"), "transparent"));
  821. r_options->push_back(ExportOption(PropertyInfo(Variant::OBJECT, "images/store_logo", PROPERTY_HINT_RESOURCE_TYPE, "StreamTexture"), Variant()));
  822. r_options->push_back(ExportOption(PropertyInfo(Variant::OBJECT, "images/square44x44_logo", PROPERTY_HINT_RESOURCE_TYPE, "StreamTexture"), Variant()));
  823. r_options->push_back(ExportOption(PropertyInfo(Variant::OBJECT, "images/square71x71_logo", PROPERTY_HINT_RESOURCE_TYPE, "StreamTexture"), Variant()));
  824. r_options->push_back(ExportOption(PropertyInfo(Variant::OBJECT, "images/square150x150_logo", PROPERTY_HINT_RESOURCE_TYPE, "StreamTexture"), Variant()));
  825. r_options->push_back(ExportOption(PropertyInfo(Variant::OBJECT, "images/square310x310_logo", PROPERTY_HINT_RESOURCE_TYPE, "StreamTexture"), Variant()));
  826. r_options->push_back(ExportOption(PropertyInfo(Variant::OBJECT, "images/wide310x150_logo", PROPERTY_HINT_RESOURCE_TYPE, "StreamTexture"), Variant()));
  827. r_options->push_back(ExportOption(PropertyInfo(Variant::OBJECT, "images/splash_screen", PROPERTY_HINT_RESOURCE_TYPE, "StreamTexture"), Variant()));
  828. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "tiles/show_name_on_square150x150"), false));
  829. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "tiles/show_name_on_wide310x150"), false));
  830. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "tiles/show_name_on_square310x310"), false));
  831. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "custom_template/debug", PROPERTY_HINT_GLOBAL_FILE, "*.zip"), ""));
  832. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "custom_template/release", PROPERTY_HINT_GLOBAL_FILE, "*.zip"), ""));
  833. // Capabilities
  834. const char **basic = uwp_capabilities;
  835. while (*basic) {
  836. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "capabilities/" + String(*basic).camelcase_to_underscore(false)), false));
  837. basic++;
  838. }
  839. const char **uap = uwp_uap_capabilities;
  840. while (*uap) {
  841. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "capabilities/" + String(*uap).camelcase_to_underscore(false)), false));
  842. uap++;
  843. }
  844. const char **device = uwp_device_capabilites;
  845. while (*device) {
  846. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "capabilities/" + String(*device).camelcase_to_underscore(false)), false));
  847. device++;
  848. }
  849. }
  850. virtual bool can_export(const Ref<EditorExportPreset> &p_preset, String &r_error, bool &r_missing_templates) const {
  851. String err;
  852. bool valid = true;
  853. Platform arch = (Platform)(int)(p_preset->get("architecture/target"));
  854. String custom_debug_binary = p_preset->get("custom_template/debug");
  855. String custom_release_binary = p_preset->get("custom_template/release");
  856. String platform_infix;
  857. switch (arch) {
  858. case EditorExportUWP::ARM: {
  859. platform_infix = "arm";
  860. } break;
  861. case EditorExportUWP::X86: {
  862. platform_infix = "x86";
  863. } break;
  864. case EditorExportUWP::X64: {
  865. platform_infix = "x64";
  866. } break;
  867. }
  868. if (!exists_export_template("uwp_" + platform_infix + "_debug.zip", &err) || !exists_export_template("uwp_" + platform_infix + "_release.zip", &err)) {
  869. valid = false;
  870. r_missing_templates = true;
  871. }
  872. if (!valid && custom_debug_binary == "" && custom_release_binary == "") {
  873. if (!err.empty()) {
  874. r_error = err;
  875. }
  876. return valid;
  877. }
  878. bool dvalid = true;
  879. bool rvalid = true;
  880. if (!FileAccess::exists(custom_debug_binary)) {
  881. dvalid = false;
  882. err = "\nCustom debug binary not found.";
  883. }
  884. if (!FileAccess::exists(custom_release_binary)) {
  885. rvalid = false;
  886. err += "\nCustom release binary not found.";
  887. }
  888. if (dvalid || rvalid)
  889. valid = true;
  890. if (!valid) {
  891. r_error = err;
  892. return valid;
  893. }
  894. if (!_valid_resource_name(p_preset->get("package/unique_name"))) {
  895. valid = false;
  896. err += "\nInvalid unique name.";
  897. }
  898. if (!_valid_guid(p_preset->get("identity/product_guid"))) {
  899. valid = false;
  900. err += "\nInvalid product GUID.";
  901. }
  902. if (!_valid_guid(p_preset->get("identity/publisher_guid"))) {
  903. valid = false;
  904. err += "\nInvalid publisher GUID.";
  905. }
  906. if (!_valid_bgcolor(p_preset->get("images/background_color"))) {
  907. valid = false;
  908. err += "\nInvalid background color.";
  909. }
  910. if (!p_preset->get("images/store_logo").is_zero() && !_valid_image((Object::cast_to<StreamTexture>((Object *)p_preset->get("images/store_logo"))), 50, 50)) {
  911. valid = false;
  912. err += "\nInvalid Store Logo image dimensions (should be 50x50).";
  913. }
  914. if (!p_preset->get("images/square44x44_logo").is_zero() && !_valid_image((Object::cast_to<StreamTexture>((Object *)p_preset->get("images/square44x44_logo"))), 44, 44)) {
  915. valid = false;
  916. err += "\nInvalid square 44x44 logo image dimensions (should be 44x44).";
  917. }
  918. if (!p_preset->get("images/square71x71_logo").is_zero() && !_valid_image((Object::cast_to<StreamTexture>((Object *)p_preset->get("images/square71x71_logo"))), 71, 71)) {
  919. valid = false;
  920. err += "\nInvalid square 71x71 logo image dimensions (should be 71x71).";
  921. }
  922. if (!p_preset->get("images/square150x150_logo").is_zero() && !_valid_image((Object::cast_to<StreamTexture>((Object *)p_preset->get("images/square150x150_logo"))), 150, 0)) {
  923. valid = false;
  924. err += "\nInvalid square 150x150 logo image dimensions (should be 150x150).";
  925. }
  926. if (!p_preset->get("images/square310x310_logo").is_zero() && !_valid_image((Object::cast_to<StreamTexture>((Object *)p_preset->get("images/square310x310_logo"))), 310, 310)) {
  927. valid = false;
  928. err += "\nInvalid square 310x310 logo image dimensions (should be 310x310).";
  929. }
  930. if (!p_preset->get("images/wide310x150_logo").is_zero() && !_valid_image((Object::cast_to<StreamTexture>((Object *)p_preset->get("images/wide310x150_logo"))), 310, 150)) {
  931. valid = false;
  932. err += "\nInvalid wide 310x150 logo image dimensions (should be 310x150).";
  933. }
  934. if (!p_preset->get("images/splash_screen").is_zero() && !_valid_image((Object::cast_to<StreamTexture>((Object *)p_preset->get("images/splash_screen"))), 620, 300)) {
  935. valid = false;
  936. err += "\nInvalid splash screen image dimensions (should be 620x300).";
  937. }
  938. r_error = err;
  939. return valid;
  940. }
  941. virtual Error export_project(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, int p_flags = 0) {
  942. String src_appx;
  943. EditorProgress ep("export", "Exporting for Windows Universal", 7);
  944. if (p_debug)
  945. src_appx = p_preset->get("custom_template/debug");
  946. else
  947. src_appx = p_preset->get("custom_template/release");
  948. src_appx = src_appx.strip_edges();
  949. Platform arch = (Platform)(int)p_preset->get("architecture/target");
  950. if (src_appx == "") {
  951. String err, infix;
  952. switch (arch) {
  953. case ARM: {
  954. infix = "_arm_";
  955. } break;
  956. case X86: {
  957. infix = "_x86_";
  958. } break;
  959. case X64: {
  960. infix = "_x64_";
  961. } break;
  962. }
  963. if (p_debug) {
  964. src_appx = find_export_template("uwp" + infix + "debug.zip", &err);
  965. } else {
  966. src_appx = find_export_template("uwp" + infix + "release.zip", &err);
  967. }
  968. if (src_appx == "") {
  969. EditorNode::add_io_error(err);
  970. return ERR_FILE_NOT_FOUND;
  971. }
  972. }
  973. Error err = OK;
  974. FileAccess *fa_pack = FileAccess::open(p_path, FileAccess::WRITE, &err);
  975. ERR_FAIL_COND_V(err != OK, ERR_CANT_CREATE);
  976. AppxPackager packager;
  977. packager.init(fa_pack);
  978. FileAccess *src_f = NULL;
  979. zlib_filefunc_def io = zipio_create_io_from_file(&src_f);
  980. ep.step("Creating package...", 0);
  981. unzFile pkg = unzOpen2(src_appx.utf8().get_data(), &io);
  982. if (!pkg) {
  983. EditorNode::add_io_error("Could not find template appx to export:\n" + src_appx);
  984. return ERR_FILE_NOT_FOUND;
  985. }
  986. int ret = unzGoToFirstFile(pkg);
  987. ep.step("Copying template files...", 1);
  988. EditorNode::progress_add_task("template_files", "Template files", 100);
  989. packager.set_progress_task("template_files");
  990. int template_files_amount = 9;
  991. int template_file_no = 1;
  992. while (ret == UNZ_OK) {
  993. // get file name
  994. unz_file_info info;
  995. char fname[16834];
  996. ret = unzGetCurrentFileInfo(pkg, &info, fname, 16834, NULL, 0, NULL, 0);
  997. String path = fname;
  998. if (path.ends_with("/")) {
  999. // Ignore directories
  1000. ret = unzGoToNextFile(pkg);
  1001. continue;
  1002. }
  1003. Vector<uint8_t> data;
  1004. bool do_read = true;
  1005. if (path.begins_with("Assets/")) {
  1006. path = path.replace(".scale-100", "");
  1007. data = _get_image_data(p_preset, path);
  1008. if (data.size() > 0) do_read = false;
  1009. }
  1010. //read
  1011. if (do_read) {
  1012. data.resize(info.uncompressed_size);
  1013. unzOpenCurrentFile(pkg);
  1014. unzReadCurrentFile(pkg, data.ptrw(), data.size());
  1015. unzCloseCurrentFile(pkg);
  1016. }
  1017. if (path == "AppxManifest.xml") {
  1018. data = _fix_manifest(p_preset, data, p_flags & (DEBUG_FLAG_DUMB_CLIENT | DEBUG_FLAG_REMOTE_DEBUG));
  1019. }
  1020. print_line("ADDING: " + path);
  1021. packager.add_file(path, data.ptr(), data.size(), template_file_no++, template_files_amount, _should_compress_asset(path, data));
  1022. ret = unzGoToNextFile(pkg);
  1023. }
  1024. EditorNode::progress_end_task("template_files");
  1025. ep.step("Creating command line...", 2);
  1026. Vector<String> cl = ((String)p_preset->get("command_line/extra_args")).strip_edges().split(" ");
  1027. for (int i = 0; i < cl.size(); i++) {
  1028. if (cl[i].strip_edges().length() == 0) {
  1029. cl.remove(i);
  1030. i--;
  1031. }
  1032. }
  1033. if (!(p_flags & DEBUG_FLAG_DUMB_CLIENT)) {
  1034. cl.push_back("--path");
  1035. cl.push_back("game");
  1036. }
  1037. gen_export_flags(cl, p_flags);
  1038. // Command line file
  1039. Vector<uint8_t> clf;
  1040. // Argc
  1041. clf.resize(4);
  1042. encode_uint32(cl.size(), clf.ptrw());
  1043. for (int i = 0; i < cl.size(); i++) {
  1044. CharString txt = cl[i].utf8();
  1045. int base = clf.size();
  1046. clf.resize(base + 4 + txt.length());
  1047. encode_uint32(txt.length(), &clf.write[base]);
  1048. copymem(&clf.write[base + 4], txt.ptr(), txt.length());
  1049. print_line(itos(i) + " param: " + cl[i]);
  1050. }
  1051. packager.add_file("__cl__.cl", clf.ptr(), clf.size(), -1, -1, false);
  1052. ep.step("Adding project files...", 3);
  1053. EditorNode::progress_add_task("project_files", "Project Files", 100);
  1054. packager.set_progress_task("project_files");
  1055. err = export_project_files(p_preset, save_appx_file, &packager);
  1056. EditorNode::progress_end_task("project_files");
  1057. ep.step("Closing package...", 7);
  1058. unzClose(pkg);
  1059. packager.finish();
  1060. #ifdef WINDOWS_ENABLED
  1061. // Sign with signtool
  1062. String signtool_path = EditorSettings::get_singleton()->get("export/uwp/signtool");
  1063. if (signtool_path == String()) {
  1064. return OK;
  1065. }
  1066. if (!FileAccess::exists(signtool_path)) {
  1067. ERR_PRINTS("Could not find signtool executable at " + signtool_path + ", aborting.");
  1068. return ERR_FILE_NOT_FOUND;
  1069. }
  1070. static String algs[] = { "MD5", "SHA1", "SHA256" };
  1071. String cert_path = EditorSettings::get_singleton()->get("export/uwp/debug_certificate");
  1072. String cert_pass = EditorSettings::get_singleton()->get("export/uwp/debug_password");
  1073. int cert_alg = EditorSettings::get_singleton()->get("export/uwp/debug_algorithm");
  1074. if (!p_debug) {
  1075. cert_path = p_preset->get("signing/certificate");
  1076. cert_pass = p_preset->get("signing/password");
  1077. cert_alg = p_preset->get("signing/algorithm");
  1078. }
  1079. if (cert_path == String()) {
  1080. return OK; // Certificate missing, don't try to sign
  1081. }
  1082. if (!FileAccess::exists(cert_path)) {
  1083. ERR_PRINTS("Could not find certificate file at " + cert_path + ", aborting.");
  1084. return ERR_FILE_NOT_FOUND;
  1085. }
  1086. if (cert_alg < 0 || cert_alg > 2) {
  1087. ERR_PRINTS("Invalid certificate algorithm " + itos(cert_alg) + ", aborting.");
  1088. return ERR_INVALID_DATA;
  1089. }
  1090. List<String> args;
  1091. args.push_back("sign");
  1092. args.push_back("/fd");
  1093. args.push_back(algs[cert_alg]);
  1094. args.push_back("/a");
  1095. args.push_back("/f");
  1096. args.push_back(cert_path);
  1097. args.push_back("/p");
  1098. args.push_back(cert_pass);
  1099. args.push_back(p_path);
  1100. OS::get_singleton()->execute(signtool_path, args, true);
  1101. #endif // WINDOWS_ENABLED
  1102. return OK;
  1103. }
  1104. virtual void get_platform_features(List<String> *r_features) {
  1105. r_features->push_back("pc");
  1106. r_features->push_back("UWP");
  1107. }
  1108. virtual void resolve_platform_feature_priorities(const Ref<EditorExportPreset> &p_preset, Set<String> &p_features) {
  1109. }
  1110. EditorExportUWP() {
  1111. Ref<Image> img = memnew(Image(_uwp_logo));
  1112. logo.instance();
  1113. logo->create_from_image(img);
  1114. }
  1115. };
  1116. void register_uwp_exporter() {
  1117. #ifdef WINDOWS_ENABLED
  1118. EDITOR_DEF("export/uwp/signtool", "");
  1119. EditorSettings::get_singleton()->add_property_hint(PropertyInfo(Variant::STRING, "export/uwp/signtool", PROPERTY_HINT_GLOBAL_FILE, "*.exe"));
  1120. EDITOR_DEF("export/uwp/debug_certificate", "");
  1121. EditorSettings::get_singleton()->add_property_hint(PropertyInfo(Variant::STRING, "export/uwp/debug_certificate", PROPERTY_HINT_GLOBAL_FILE, "*.pfx"));
  1122. EDITOR_DEF("export/uwp/debug_password", "");
  1123. EDITOR_DEF("export/uwp/debug_algorithm", 2); // SHA256 is the default
  1124. EditorSettings::get_singleton()->add_property_hint(PropertyInfo(Variant::INT, "export/uwp/debug_algorithm", PROPERTY_HINT_ENUM, "MD5,SHA1,SHA256"));
  1125. #endif // WINDOWS_ENABLED
  1126. Ref<EditorExportUWP> exporter;
  1127. exporter.instance();
  1128. EditorExport::get_singleton()->add_export_platform(exporter);
  1129. }