export.cpp 48 KB

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