export_plugin.cpp 69 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622
  1. /*************************************************************************/
  2. /* export_plugin.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2022 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_plugin.h"
  31. #include "codesign.h"
  32. #include "editor/editor_node.h"
  33. #include "editor/editor_paths.h"
  34. #include "modules/modules_enabled.gen.h" // For regex.
  35. void EditorExportPlatformOSX::get_preset_features(const Ref<EditorExportPreset> &p_preset, List<String> *r_features) {
  36. if (p_preset->get("texture_format/s3tc")) {
  37. r_features->push_back("s3tc");
  38. }
  39. if (p_preset->get("texture_format/etc")) {
  40. r_features->push_back("etc");
  41. }
  42. if (p_preset->get("texture_format/etc2")) {
  43. r_features->push_back("etc2");
  44. }
  45. r_features->push_back("64");
  46. }
  47. bool EditorExportPlatformOSX::get_export_option_visibility(const String &p_option, const Map<StringName, Variant> &p_options) const {
  48. // These options are not supported by built-in codesign, used on non macOS host.
  49. if (!OS::get_singleton()->has_feature("macos")) {
  50. if (p_option == "codesign/identity" || p_option == "codesign/timestamp" || p_option == "codesign/hardened_runtime" || p_option == "codesign/custom_options" || p_option.begins_with("notarization/")) {
  51. return false;
  52. }
  53. }
  54. // These entitlements are required to run managed code, and are always enabled in Mono builds.
  55. if (Engine::get_singleton()->has_singleton("GodotSharp")) {
  56. if (p_option == "codesign/entitlements/allow_jit_code_execution" || p_option == "codesign/entitlements/allow_unsigned_executable_memory" || p_option == "codesign/entitlements/allow_dyld_environment_variables") {
  57. return false;
  58. }
  59. }
  60. return true;
  61. }
  62. void EditorExportPlatformOSX::get_export_options(List<ExportOption> *r_options) {
  63. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "custom_template/debug", PROPERTY_HINT_GLOBAL_FILE, "*.zip"), ""));
  64. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "custom_template/release", PROPERTY_HINT_GLOBAL_FILE, "*.zip"), ""));
  65. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "debug/export_console_script", PROPERTY_HINT_ENUM, "No,Debug Only,Debug and Release"), 1));
  66. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/icon", PROPERTY_HINT_FILE, "*.png,*.icns"), ""));
  67. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/bundle_identifier", PROPERTY_HINT_PLACEHOLDER_TEXT, "com.example.game"), ""));
  68. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/signature"), ""));
  69. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/app_category", PROPERTY_HINT_ENUM, "Business,Developer-tools,Education,Entertainment,Finance,Games,Action-games,Adventure-games,Arcade-games,Board-games,Card-games,Casino-games,Dice-games,Educational-games,Family-games,Kids-games,Music-games,Puzzle-games,Racing-games,Role-playing-games,Simulation-games,Sports-games,Strategy-games,Trivia-games,Word-games,Graphics-design,Healthcare-fitness,Lifestyle,Medical,Music,News,Photography,Productivity,Reference,Social-networking,Sports,Travel,Utilities,Video,Weather"), "Games"));
  70. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/short_version"), "1.0"));
  71. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/version"), "1.0"));
  72. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/copyright"), ""));
  73. r_options->push_back(ExportOption(PropertyInfo(Variant::DICTIONARY, "application/copyright_localized", PROPERTY_HINT_LOCALIZABLE_STRING), Dictionary()));
  74. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "display/high_res"), false));
  75. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "privacy/microphone_usage_description", PROPERTY_HINT_PLACEHOLDER_TEXT, "Provide a message if you need to use the microphone"), ""));
  76. r_options->push_back(ExportOption(PropertyInfo(Variant::DICTIONARY, "privacy/microphone_usage_description_localized", PROPERTY_HINT_LOCALIZABLE_STRING), Dictionary()));
  77. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "privacy/camera_usage_description", PROPERTY_HINT_PLACEHOLDER_TEXT, "Provide a message if you need to use the camera"), ""));
  78. r_options->push_back(ExportOption(PropertyInfo(Variant::DICTIONARY, "privacy/camera_usage_description_localized", PROPERTY_HINT_LOCALIZABLE_STRING), Dictionary()));
  79. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "privacy/location_usage_description", PROPERTY_HINT_PLACEHOLDER_TEXT, "Provide a message if you need to use the location information"), ""));
  80. r_options->push_back(ExportOption(PropertyInfo(Variant::DICTIONARY, "privacy/location_usage_description_localized", PROPERTY_HINT_LOCALIZABLE_STRING), Dictionary()));
  81. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "privacy/address_book_usage_description", PROPERTY_HINT_PLACEHOLDER_TEXT, "Provide a message if you need to use the address book"), ""));
  82. r_options->push_back(ExportOption(PropertyInfo(Variant::DICTIONARY, "privacy/address_book_usage_description_localized", PROPERTY_HINT_LOCALIZABLE_STRING), Dictionary()));
  83. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "privacy/calendar_usage_description", PROPERTY_HINT_PLACEHOLDER_TEXT, "Provide a message if you need to use the calendar"), ""));
  84. r_options->push_back(ExportOption(PropertyInfo(Variant::DICTIONARY, "privacy/calendar_usage_description_localized", PROPERTY_HINT_LOCALIZABLE_STRING), Dictionary()));
  85. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "privacy/photos_library_usage_description", PROPERTY_HINT_PLACEHOLDER_TEXT, "Provide a message if you need to use the photo library"), ""));
  86. r_options->push_back(ExportOption(PropertyInfo(Variant::DICTIONARY, "privacy/photos_library_usage_description_localized", PROPERTY_HINT_LOCALIZABLE_STRING), Dictionary()));
  87. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "privacy/desktop_folder_usage_description", PROPERTY_HINT_PLACEHOLDER_TEXT, "Provide a message if you need to use Desktop folder"), ""));
  88. r_options->push_back(ExportOption(PropertyInfo(Variant::DICTIONARY, "privacy/desktop_folder_usage_description_localized", PROPERTY_HINT_LOCALIZABLE_STRING), Dictionary()));
  89. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "privacy/documents_folder_usage_description", PROPERTY_HINT_PLACEHOLDER_TEXT, "Provide a message if you need to use Documents folder"), ""));
  90. r_options->push_back(ExportOption(PropertyInfo(Variant::DICTIONARY, "privacy/documents_folder_usage_description_localized", PROPERTY_HINT_LOCALIZABLE_STRING), Dictionary()));
  91. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "privacy/downloads_folder_usage_description", PROPERTY_HINT_PLACEHOLDER_TEXT, "Provide a message if you need to use Downloads folder"), ""));
  92. r_options->push_back(ExportOption(PropertyInfo(Variant::DICTIONARY, "privacy/downloads_folder_usage_description_localized", PROPERTY_HINT_LOCALIZABLE_STRING), Dictionary()));
  93. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "privacy/network_volumes_usage_description", PROPERTY_HINT_PLACEHOLDER_TEXT, "Provide a message if you need to use network volumes"), ""));
  94. r_options->push_back(ExportOption(PropertyInfo(Variant::DICTIONARY, "privacy/network_volumes_usage_description_localized", PROPERTY_HINT_LOCALIZABLE_STRING), Dictionary()));
  95. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "privacy/removable_volumes_usage_description", PROPERTY_HINT_PLACEHOLDER_TEXT, "Provide a message if you need to use removable volumes"), ""));
  96. r_options->push_back(ExportOption(PropertyInfo(Variant::DICTIONARY, "privacy/removable_volumes_usage_description_localized", PROPERTY_HINT_LOCALIZABLE_STRING), Dictionary()));
  97. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/enable"), true));
  98. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "codesign/identity", PROPERTY_HINT_PLACEHOLDER_TEXT, "Type: Name (ID)"), ""));
  99. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/timestamp"), true));
  100. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/replace_existing_signature"), true));
  101. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/hardened_runtime"), true));
  102. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "codesign/entitlements/custom_file", PROPERTY_HINT_GLOBAL_FILE, "*.plist"), ""));
  103. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/allow_jit_code_execution"), false));
  104. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/allow_unsigned_executable_memory"), false));
  105. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/allow_dyld_environment_variables"), false));
  106. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/disable_library_validation"), false));
  107. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/audio_input"), false));
  108. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/camera"), false));
  109. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/location"), false));
  110. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/address_book"), false));
  111. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/calendars"), false));
  112. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/photos_library"), false));
  113. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/apple_events"), false));
  114. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/debugging"), false));
  115. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/app_sandbox/enabled"), false));
  116. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/app_sandbox/network_server"), false));
  117. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/app_sandbox/network_client"), false));
  118. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/app_sandbox/device_usb"), false));
  119. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/app_sandbox/device_bluetooth"), false));
  120. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "codesign/entitlements/app_sandbox/files_downloads", PROPERTY_HINT_ENUM, "No,Read-only,Read-write"), 0));
  121. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "codesign/entitlements/app_sandbox/files_pictures", PROPERTY_HINT_ENUM, "No,Read-only,Read-write"), 0));
  122. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "codesign/entitlements/app_sandbox/files_music", PROPERTY_HINT_ENUM, "No,Read-only,Read-write"), 0));
  123. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "codesign/entitlements/app_sandbox/files_movies", PROPERTY_HINT_ENUM, "No,Read-only,Read-write"), 0));
  124. r_options->push_back(ExportOption(PropertyInfo(Variant::ARRAY, "codesign/entitlements/app_sandbox/helper_executables", PROPERTY_HINT_ARRAY_TYPE, itos(Variant::STRING) + "/" + itos(PROPERTY_HINT_GLOBAL_FILE) + ":"), Array()));
  125. r_options->push_back(ExportOption(PropertyInfo(Variant::PACKED_STRING_ARRAY, "codesign/custom_options"), PackedStringArray()));
  126. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "notarization/enable"), false));
  127. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "notarization/apple_id_name", PROPERTY_HINT_PLACEHOLDER_TEXT, "Apple ID email"), ""));
  128. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "notarization/apple_id_password", PROPERTY_HINT_PLACEHOLDER_TEXT, "Enable two-factor authentication and provide app-specific password"), ""));
  129. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "notarization/apple_team_id", PROPERTY_HINT_PLACEHOLDER_TEXT, "Provide team ID if your Apple ID belongs to multiple teams"), ""));
  130. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "texture_format/s3tc"), true));
  131. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "texture_format/etc"), false));
  132. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "texture_format/etc2"), false));
  133. }
  134. void _rgba8_to_packbits_encode(int p_ch, int p_size, Vector<uint8_t> &p_source, Vector<uint8_t> &p_dest) {
  135. int src_len = p_size * p_size;
  136. Vector<uint8_t> result;
  137. result.resize(src_len * 1.25); //temp vector for rle encoded data, make it 25% larger for worst case scenario
  138. int res_size = 0;
  139. uint8_t buf[128];
  140. int buf_size = 0;
  141. int i = 0;
  142. while (i < src_len) {
  143. uint8_t cur = p_source.ptr()[i * 4 + p_ch];
  144. if (i < src_len - 2) {
  145. if ((p_source.ptr()[(i + 1) * 4 + p_ch] == cur) && (p_source.ptr()[(i + 2) * 4 + p_ch] == cur)) {
  146. if (buf_size > 0) {
  147. result.write[res_size++] = (uint8_t)(buf_size - 1);
  148. memcpy(&result.write[res_size], &buf, buf_size);
  149. res_size += buf_size;
  150. buf_size = 0;
  151. }
  152. uint8_t lim = i + 130 >= src_len ? src_len - i - 1 : 130;
  153. bool hit_lim = true;
  154. for (int j = 3; j <= lim; j++) {
  155. if (p_source.ptr()[(i + j) * 4 + p_ch] != cur) {
  156. hit_lim = false;
  157. i = i + j - 1;
  158. result.write[res_size++] = (uint8_t)(j - 3 + 0x80);
  159. result.write[res_size++] = cur;
  160. break;
  161. }
  162. }
  163. if (hit_lim) {
  164. result.write[res_size++] = (uint8_t)(lim - 3 + 0x80);
  165. result.write[res_size++] = cur;
  166. i = i + lim;
  167. }
  168. } else {
  169. buf[buf_size++] = cur;
  170. if (buf_size == 128) {
  171. result.write[res_size++] = (uint8_t)(buf_size - 1);
  172. memcpy(&result.write[res_size], &buf, buf_size);
  173. res_size += buf_size;
  174. buf_size = 0;
  175. }
  176. }
  177. } else {
  178. buf[buf_size++] = cur;
  179. result.write[res_size++] = (uint8_t)(buf_size - 1);
  180. memcpy(&result.write[res_size], &buf, buf_size);
  181. res_size += buf_size;
  182. buf_size = 0;
  183. }
  184. i++;
  185. }
  186. int ofs = p_dest.size();
  187. p_dest.resize(p_dest.size() + res_size);
  188. memcpy(&p_dest.write[ofs], result.ptr(), res_size);
  189. }
  190. void EditorExportPlatformOSX::_make_icon(const Ref<Image> &p_icon, Vector<uint8_t> &p_data) {
  191. Ref<ImageTexture> it = memnew(ImageTexture);
  192. Vector<uint8_t> data;
  193. data.resize(8);
  194. data.write[0] = 'i';
  195. data.write[1] = 'c';
  196. data.write[2] = 'n';
  197. data.write[3] = 's';
  198. struct MacOSIconInfo {
  199. const char *name;
  200. const char *mask_name;
  201. bool is_png;
  202. int size;
  203. };
  204. static const MacOSIconInfo icon_infos[] = {
  205. { "ic10", "", true, 1024 }, //1024×1024 32-bit PNG and 512×512@2x 32-bit "retina" PNG
  206. { "ic09", "", true, 512 }, //512×512 32-bit PNG
  207. { "ic14", "", true, 512 }, //256×256@2x 32-bit "retina" PNG
  208. { "ic08", "", true, 256 }, //256×256 32-bit PNG
  209. { "ic13", "", true, 256 }, //128×128@2x 32-bit "retina" PNG
  210. { "ic07", "", true, 128 }, //128×128 32-bit PNG
  211. { "ic12", "", true, 64 }, //32×32@2× 32-bit "retina" PNG
  212. { "ic11", "", true, 32 }, //16×16@2× 32-bit "retina" PNG
  213. { "il32", "l8mk", false, 32 }, //32×32 24-bit RLE + 8-bit uncompressed mask
  214. { "is32", "s8mk", false, 16 } //16×16 24-bit RLE + 8-bit uncompressed mask
  215. };
  216. for (uint64_t i = 0; i < (sizeof(icon_infos) / sizeof(icon_infos[0])); ++i) {
  217. Ref<Image> copy = p_icon; // does this make sense? doesn't this just increase the reference count instead of making a copy? Do we even need a copy?
  218. copy->convert(Image::FORMAT_RGBA8);
  219. copy->resize(icon_infos[i].size, icon_infos[i].size);
  220. if (icon_infos[i].is_png) {
  221. // Encode PNG icon.
  222. it->create_from_image(copy);
  223. String path = EditorPaths::get_singleton()->get_cache_dir().plus_file("icon.png");
  224. ResourceSaver::save(path, it);
  225. FileAccess *f = FileAccess::open(path, FileAccess::READ);
  226. if (!f) {
  227. // Clean up generated file.
  228. DirAccess::remove_file_or_error(path);
  229. ERR_FAIL();
  230. }
  231. int ofs = data.size();
  232. uint64_t len = f->get_length();
  233. data.resize(data.size() + len + 8);
  234. f->get_buffer(&data.write[ofs + 8], len);
  235. memdelete(f);
  236. len += 8;
  237. len = BSWAP32(len);
  238. memcpy(&data.write[ofs], icon_infos[i].name, 4);
  239. encode_uint32(len, &data.write[ofs + 4]);
  240. // Clean up generated file.
  241. DirAccess::remove_file_or_error(path);
  242. } else {
  243. Vector<uint8_t> src_data = copy->get_data();
  244. //encode 24bit RGB RLE icon
  245. {
  246. int ofs = data.size();
  247. data.resize(data.size() + 8);
  248. _rgba8_to_packbits_encode(0, icon_infos[i].size, src_data, data); // encode R
  249. _rgba8_to_packbits_encode(1, icon_infos[i].size, src_data, data); // encode G
  250. _rgba8_to_packbits_encode(2, icon_infos[i].size, src_data, data); // encode B
  251. int len = data.size() - ofs;
  252. len = BSWAP32(len);
  253. memcpy(&data.write[ofs], icon_infos[i].name, 4);
  254. encode_uint32(len, &data.write[ofs + 4]);
  255. }
  256. //encode 8bit mask uncompressed icon
  257. {
  258. int ofs = data.size();
  259. int len = copy->get_width() * copy->get_height();
  260. data.resize(data.size() + len + 8);
  261. for (int j = 0; j < len; j++) {
  262. data.write[ofs + 8 + j] = src_data.ptr()[j * 4 + 3];
  263. }
  264. len += 8;
  265. len = BSWAP32(len);
  266. memcpy(&data.write[ofs], icon_infos[i].mask_name, 4);
  267. encode_uint32(len, &data.write[ofs + 4]);
  268. }
  269. }
  270. }
  271. uint32_t total_len = data.size();
  272. total_len = BSWAP32(total_len);
  273. encode_uint32(total_len, &data.write[4]);
  274. p_data = data;
  275. }
  276. void EditorExportPlatformOSX::_fix_plist(const Ref<EditorExportPreset> &p_preset, Vector<uint8_t> &plist, const String &p_binary) {
  277. String str;
  278. String strnew;
  279. str.parse_utf8((const char *)plist.ptr(), plist.size());
  280. Vector<String> lines = str.split("\n");
  281. for (int i = 0; i < lines.size(); i++) {
  282. if (lines[i].find("$binary") != -1) {
  283. strnew += lines[i].replace("$binary", p_binary) + "\n";
  284. } else if (lines[i].find("$name") != -1) {
  285. strnew += lines[i].replace("$name", ProjectSettings::get_singleton()->get("application/config/name")) + "\n";
  286. } else if (lines[i].find("$bundle_identifier") != -1) {
  287. strnew += lines[i].replace("$bundle_identifier", p_preset->get("application/bundle_identifier")) + "\n";
  288. } else if (lines[i].find("$short_version") != -1) {
  289. strnew += lines[i].replace("$short_version", p_preset->get("application/short_version")) + "\n";
  290. } else if (lines[i].find("$version") != -1) {
  291. strnew += lines[i].replace("$version", p_preset->get("application/version")) + "\n";
  292. } else if (lines[i].find("$signature") != -1) {
  293. strnew += lines[i].replace("$signature", p_preset->get("application/signature")) + "\n";
  294. } else if (lines[i].find("$app_category") != -1) {
  295. String cat = p_preset->get("application/app_category");
  296. strnew += lines[i].replace("$app_category", cat.to_lower()) + "\n";
  297. } else if (lines[i].find("$copyright") != -1) {
  298. strnew += lines[i].replace("$copyright", p_preset->get("application/copyright")) + "\n";
  299. } else if (lines[i].find("$highres") != -1) {
  300. strnew += lines[i].replace("$highres", p_preset->get("display/high_res") ? "\t<true/>" : "\t<false/>") + "\n";
  301. } else if (lines[i].find("$usage_descriptions") != -1) {
  302. String descriptions;
  303. if (!((String)p_preset->get("privacy/microphone_usage_description")).is_empty()) {
  304. descriptions += "\t<key>NSMicrophoneUsageDescription</key>\n";
  305. descriptions += "\t<string>" + (String)p_preset->get("privacy/microphone_usage_description") + "</string>\n";
  306. }
  307. if (!((String)p_preset->get("privacy/camera_usage_description")).is_empty()) {
  308. descriptions += "\t<key>NSCameraUsageDescription</key>\n";
  309. descriptions += "\t<string>" + (String)p_preset->get("privacy/camera_usage_description") + "</string>\n";
  310. }
  311. if (!((String)p_preset->get("privacy/location_usage_description")).is_empty()) {
  312. descriptions += "\t<key>NSLocationUsageDescription</key>\n";
  313. descriptions += "\t<string>" + (String)p_preset->get("privacy/location_usage_description") + "</string>\n";
  314. }
  315. if (!((String)p_preset->get("privacy/address_book_usage_description")).is_empty()) {
  316. descriptions += "\t<key>NSContactsUsageDescription</key>\n";
  317. descriptions += "\t<string>" + (String)p_preset->get("privacy/address_book_usage_description") + "</string>\n";
  318. }
  319. if (!((String)p_preset->get("privacy/calendar_usage_description")).is_empty()) {
  320. descriptions += "\t<key>NSCalendarsUsageDescription</key>\n";
  321. descriptions += "\t<string>" + (String)p_preset->get("privacy/calendar_usage_description") + "</string>\n";
  322. }
  323. if (!((String)p_preset->get("privacy/photos_library_usage_description")).is_empty()) {
  324. descriptions += "\t<key>NSPhotoLibraryUsageDescription</key>\n";
  325. descriptions += "\t<string>" + (String)p_preset->get("privacy/photos_library_usage_description") + "</string>\n";
  326. }
  327. if (!((String)p_preset->get("privacy/desktop_folder_usage_description")).is_empty()) {
  328. descriptions += "\t<key>NSDesktopFolderUsageDescription</key>\n";
  329. descriptions += "\t<string>" + (String)p_preset->get("privacy/desktop_folder_usage_description") + "</string>\n";
  330. }
  331. if (!((String)p_preset->get("privacy/documents_folder_usage_description")).is_empty()) {
  332. descriptions += "\t<key>NSDocumentsFolderUsageDescription</key>\n";
  333. descriptions += "\t<string>" + (String)p_preset->get("privacy/documents_folder_usage_description") + "</string>\n";
  334. }
  335. if (!((String)p_preset->get("privacy/downloads_folder_usage_description")).is_empty()) {
  336. descriptions += "\t<key>NSDownloadsFolderUsageDescription</key>\n";
  337. descriptions += "\t<string>" + (String)p_preset->get("privacy/downloads_folder_usage_description") + "</string>\n";
  338. }
  339. if (!((String)p_preset->get("privacy/network_volumes_usage_description")).is_empty()) {
  340. descriptions += "\t<key>NSNetworkVolumesUsageDescription</key>\n";
  341. descriptions += "\t<string>" + (String)p_preset->get("privacy/network_volumes_usage_description") + "</string>\n";
  342. }
  343. if (!((String)p_preset->get("privacy/removable_volumes_usage_description")).is_empty()) {
  344. descriptions += "\t<key>NSRemovableVolumesUsageDescription</key>\n";
  345. descriptions += "\t<string>" + (String)p_preset->get("privacy/removable_volumes_usage_description") + "</string>\n";
  346. }
  347. if (!descriptions.is_empty()) {
  348. strnew += lines[i].replace("$usage_descriptions", descriptions);
  349. }
  350. } else {
  351. strnew += lines[i] + "\n";
  352. }
  353. }
  354. CharString cs = strnew.utf8();
  355. plist.resize(cs.size() - 1);
  356. for (int i = 0; i < cs.size() - 1; i++) {
  357. plist.write[i] = cs[i];
  358. }
  359. }
  360. /**
  361. * If we're running the OSX version of the Godot editor we'll:
  362. * - export our application bundle to a temporary folder
  363. * - attempt to code sign it
  364. * - and then wrap it up in a DMG
  365. */
  366. Error EditorExportPlatformOSX::_notarize(const Ref<EditorExportPreset> &p_preset, const String &p_path) {
  367. #ifdef OSX_ENABLED
  368. List<String> args;
  369. args.push_back("altool");
  370. args.push_back("--notarize-app");
  371. args.push_back("--primary-bundle-id");
  372. args.push_back(p_preset->get("application/bundle_identifier"));
  373. args.push_back("--username");
  374. args.push_back(p_preset->get("notarization/apple_id_name"));
  375. args.push_back("--password");
  376. args.push_back(p_preset->get("notarization/apple_id_password"));
  377. args.push_back("--type");
  378. args.push_back("osx");
  379. if (p_preset->get("notarization/apple_team_id")) {
  380. args.push_back("--asc-provider");
  381. args.push_back(p_preset->get("notarization/apple_team_id"));
  382. }
  383. args.push_back("--file");
  384. args.push_back(p_path);
  385. String str;
  386. Error err = OS::get_singleton()->execute("xcrun", args, &str, nullptr, true);
  387. ERR_FAIL_COND_V(err != OK, err);
  388. print_verbose("altool (" + p_path + "):\n" + str);
  389. if (str.find("RequestUUID") == -1) {
  390. EditorNode::add_io_error("altool: " + str);
  391. return FAILED;
  392. } else {
  393. print_line(TTR("Note: The notarization process generally takes less than an hour. When the process is completed, you'll receive an email."));
  394. print_line(" " + TTR("You can check progress manually by opening a Terminal and running the following command:"));
  395. print_line(" \"xcrun altool --notarization-history 0 -u <your email> -p <app-specific pwd>\"");
  396. print_line(" " + TTR("Run the following command to staple the notarization ticket to the exported application (optional):"));
  397. print_line(" \"xcrun stapler staple <app path>\"");
  398. }
  399. #endif
  400. return OK;
  401. }
  402. Error EditorExportPlatformOSX::_code_sign(const Ref<EditorExportPreset> &p_preset, const String &p_path, const String &p_ent_path) {
  403. bool force_builtin_codesign = EditorSettings::get_singleton()->get("export/macos/force_builtin_codesign");
  404. bool ad_hoc = (p_preset->get("codesign/identity") == "" || p_preset->get("codesign/identity") == "-");
  405. if ((!FileAccess::exists("/usr/bin/codesign") && !FileAccess::exists("/bin/codesign")) || force_builtin_codesign) {
  406. print_verbose("using built-in codesign...");
  407. #ifdef MODULE_REGEX_ENABLED
  408. #ifdef OSX_ENABLED
  409. if (p_preset->get("codesign/timestamp")) {
  410. WARN_PRINT("Timestamping is not compatible with ad-hoc signature, and was disabled!");
  411. }
  412. if (p_preset->get("codesign/hardened_runtime")) {
  413. WARN_PRINT("Hardened Runtime is not compatible with ad-hoc signature, and was disabled!");
  414. }
  415. #endif
  416. String error_msg;
  417. Error err = CodeSign::codesign(false, p_preset->get("codesign/replace_existing_signature"), p_path, p_ent_path, error_msg);
  418. if (err != OK) {
  419. EditorNode::add_io_error("Built-in CodeSign: " + error_msg);
  420. return FAILED;
  421. }
  422. #else
  423. ERR_FAIL_V_MSG(FAILED, "Built-in CodeSign require regex module");
  424. #endif
  425. return OK;
  426. } else {
  427. print_verbose("using external codesign...");
  428. List<String> args;
  429. if (p_preset->get("codesign/timestamp")) {
  430. if (ad_hoc) {
  431. WARN_PRINT("Timestamping is not compatible with ad-hoc signature, and was disabled!");
  432. } else {
  433. args.push_back("--timestamp");
  434. }
  435. }
  436. if (p_preset->get("codesign/hardened_runtime")) {
  437. if (ad_hoc) {
  438. WARN_PRINT("Hardened Runtime is not compatible with ad-hoc signature, and was disabled!");
  439. } else {
  440. args.push_back("--options");
  441. args.push_back("runtime");
  442. }
  443. }
  444. if (p_path.get_extension() != "dmg") {
  445. args.push_back("--entitlements");
  446. args.push_back(p_ent_path);
  447. }
  448. PackedStringArray user_args = p_preset->get("codesign/custom_options");
  449. for (int i = 0; i < user_args.size(); i++) {
  450. String user_arg = user_args[i].strip_edges();
  451. if (!user_arg.is_empty()) {
  452. args.push_back(user_arg);
  453. }
  454. }
  455. args.push_back("-s");
  456. if (ad_hoc) {
  457. args.push_back("-");
  458. } else {
  459. args.push_back(p_preset->get("codesign/identity"));
  460. }
  461. args.push_back("-v"); /* provide some more feedback */
  462. if (p_preset->get("codesign/replace_existing_signature")) {
  463. args.push_back("-f");
  464. }
  465. args.push_back(p_path);
  466. String str;
  467. Error err = OS::get_singleton()->execute("codesign", args, &str, nullptr, true);
  468. ERR_FAIL_COND_V(err != OK, err);
  469. print_verbose("codesign (" + p_path + "):\n" + str);
  470. if (str.find("no identity found") != -1) {
  471. EditorNode::add_io_error("CodeSign: " + TTR("No identity found."));
  472. return FAILED;
  473. }
  474. if ((str.find("unrecognized blob type") != -1) || (str.find("cannot read entitlement data") != -1)) {
  475. EditorNode::add_io_error("CodeSign: " + TTR("Invalid entitlements file."));
  476. return FAILED;
  477. }
  478. return OK;
  479. }
  480. }
  481. Error EditorExportPlatformOSX::_code_sign_directory(const Ref<EditorExportPreset> &p_preset, const String &p_path,
  482. const String &p_ent_path, bool p_should_error_on_non_code) {
  483. #ifdef OSX_ENABLED
  484. static Vector<String> extensions_to_sign;
  485. if (extensions_to_sign.is_empty()) {
  486. extensions_to_sign.push_back("dylib");
  487. extensions_to_sign.push_back("framework");
  488. }
  489. Error dir_access_error;
  490. DirAccessRef dir_access{ DirAccess::open(p_path, &dir_access_error) };
  491. if (dir_access_error != OK) {
  492. return dir_access_error;
  493. }
  494. dir_access->list_dir_begin();
  495. String current_file{ dir_access->get_next() };
  496. while (!current_file.is_empty()) {
  497. String current_file_path{ p_path.plus_file(current_file) };
  498. if (current_file == ".." || current_file == ".") {
  499. current_file = dir_access->get_next();
  500. continue;
  501. }
  502. if (extensions_to_sign.find(current_file.get_extension()) > -1) {
  503. Error code_sign_error{ _code_sign(p_preset, current_file_path, p_ent_path) };
  504. if (code_sign_error != OK) {
  505. return code_sign_error;
  506. }
  507. } else if (dir_access->current_is_dir()) {
  508. Error code_sign_error{ _code_sign_directory(p_preset, current_file_path, p_ent_path, p_should_error_on_non_code) };
  509. if (code_sign_error != OK) {
  510. return code_sign_error;
  511. }
  512. } else if (p_should_error_on_non_code) {
  513. ERR_PRINT(vformat("Cannot sign file %s.", current_file));
  514. return Error::FAILED;
  515. }
  516. current_file = dir_access->get_next();
  517. }
  518. #endif
  519. return OK;
  520. }
  521. Error EditorExportPlatformOSX::_copy_and_sign_files(DirAccessRef &dir_access, const String &p_src_path,
  522. const String &p_in_app_path, bool p_sign_enabled,
  523. const Ref<EditorExportPreset> &p_preset, const String &p_ent_path,
  524. bool p_should_error_on_non_code_sign) {
  525. Error err{ OK };
  526. if (dir_access->dir_exists(p_src_path)) {
  527. #ifndef UNIX_ENABLED
  528. WARN_PRINT("Relative symlinks are not supported, exported " + p_src_path.get_file() + " might be broken!");
  529. #endif
  530. print_verbose("export framework: " + p_src_path + " -> " + p_in_app_path);
  531. err = dir_access->make_dir_recursive(p_in_app_path);
  532. if (err == OK) {
  533. err = dir_access->copy_dir(p_src_path, p_in_app_path, -1, true);
  534. }
  535. } else {
  536. print_verbose("export dylib: " + p_src_path + " -> " + p_in_app_path);
  537. err = dir_access->copy(p_src_path, p_in_app_path);
  538. }
  539. if (err == OK && p_sign_enabled) {
  540. if (dir_access->dir_exists(p_src_path) && p_src_path.get_extension().is_empty()) {
  541. // If it is a directory, find and sign all dynamic libraries.
  542. err = _code_sign_directory(p_preset, p_in_app_path, p_ent_path, p_should_error_on_non_code_sign);
  543. } else {
  544. err = _code_sign(p_preset, p_in_app_path, p_ent_path);
  545. }
  546. }
  547. return err;
  548. }
  549. Error EditorExportPlatformOSX::_export_osx_plugins_for(Ref<EditorExportPlugin> p_editor_export_plugin,
  550. const String &p_app_path_name, DirAccessRef &dir_access,
  551. bool p_sign_enabled, const Ref<EditorExportPreset> &p_preset,
  552. const String &p_ent_path) {
  553. Error error{ OK };
  554. const Vector<String> &osx_plugins{ p_editor_export_plugin->get_osx_plugin_files() };
  555. for (int i = 0; i < osx_plugins.size(); ++i) {
  556. String src_path{ ProjectSettings::get_singleton()->globalize_path(osx_plugins[i]) };
  557. String path_in_app{ p_app_path_name + "/Contents/PlugIns/" + src_path.get_file() };
  558. error = _copy_and_sign_files(dir_access, src_path, path_in_app, p_sign_enabled, p_preset, p_ent_path, false);
  559. if (error != OK) {
  560. break;
  561. }
  562. }
  563. return error;
  564. }
  565. Error EditorExportPlatformOSX::_create_dmg(const String &p_dmg_path, const String &p_pkg_name, const String &p_app_path_name) {
  566. List<String> args;
  567. if (FileAccess::exists(p_dmg_path)) {
  568. OS::get_singleton()->move_to_trash(p_dmg_path);
  569. }
  570. args.push_back("create");
  571. args.push_back(p_dmg_path);
  572. args.push_back("-volname");
  573. args.push_back(p_pkg_name);
  574. args.push_back("-fs");
  575. args.push_back("HFS+");
  576. args.push_back("-srcfolder");
  577. args.push_back(p_app_path_name);
  578. String str;
  579. Error err = OS::get_singleton()->execute("hdiutil", args, &str, nullptr, true);
  580. ERR_FAIL_COND_V(err != OK, err);
  581. print_verbose("hdiutil returned: " + str);
  582. if (str.find("create failed") != -1) {
  583. if (str.find("File exists") != -1) {
  584. EditorNode::add_io_error("hdiutil: " + TTR("DMG creation failed, file already exists."));
  585. } else {
  586. EditorNode::add_io_error("hdiutil: " + TTR("DMG create failed."));
  587. }
  588. return FAILED;
  589. }
  590. return OK;
  591. }
  592. Error EditorExportPlatformOSX::_export_debug_script(const Ref<EditorExportPreset> &p_preset, const String &p_app_name, const String &p_pkg_name, const String &p_path) {
  593. FileAccessRef f = FileAccess::open(p_path, FileAccess::WRITE);
  594. ERR_FAIL_COND_V(!f, ERR_CANT_CREATE);
  595. f->store_line("#!/bin/sh");
  596. f->store_line("echo -ne '\\033c\\033]0;" + p_app_name + "\\a'");
  597. f->store_line("function realpath() { python -c \"import os,sys; print(os.path.realpath(sys.argv[1]))\" \"$0\"; }");
  598. f->store_line("base_path=\"$(dirname \"$(realpath \"$0\")\")\"");
  599. f->store_line("\"$base_path/" + p_pkg_name + "\" \"$@\"");
  600. return OK;
  601. }
  602. Error EditorExportPlatformOSX::export_project(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, int p_flags) {
  603. ExportNotifier notifier(*this, p_preset, p_debug, p_path, p_flags);
  604. String src_pkg_name;
  605. EditorProgress ep("export", "Exporting for OSX", 3, true);
  606. if (p_debug) {
  607. src_pkg_name = p_preset->get("custom_template/debug");
  608. } else {
  609. src_pkg_name = p_preset->get("custom_template/release");
  610. }
  611. if (src_pkg_name.is_empty()) {
  612. String err;
  613. src_pkg_name = find_export_template("osx.zip", &err);
  614. if (src_pkg_name.is_empty()) {
  615. EditorNode::add_io_error(err);
  616. return ERR_FILE_NOT_FOUND;
  617. }
  618. }
  619. if (!DirAccess::exists(p_path.get_base_dir())) {
  620. return ERR_FILE_BAD_PATH;
  621. }
  622. FileAccess *src_f = nullptr;
  623. zlib_filefunc_def io = zipio_create_io_from_file(&src_f);
  624. if (ep.step(TTR("Creating app bundle"), 0)) {
  625. return ERR_SKIP;
  626. }
  627. unzFile src_pkg_zip = unzOpen2(src_pkg_name.utf8().get_data(), &io);
  628. if (!src_pkg_zip) {
  629. EditorNode::add_io_error(TTR("Could not find template app to export:") + "\n" + src_pkg_name);
  630. return ERR_FILE_NOT_FOUND;
  631. }
  632. int ret = unzGoToFirstFile(src_pkg_zip);
  633. String binary_to_use = "godot_osx_" + String(p_debug ? "debug" : "release") + ".64";
  634. String pkg_name;
  635. if (String(ProjectSettings::get_singleton()->get("application/config/name")) != "") {
  636. pkg_name = String(ProjectSettings::get_singleton()->get("application/config/name"));
  637. } else {
  638. pkg_name = "Unnamed";
  639. }
  640. pkg_name = OS::get_singleton()->get_safe_dir_name(pkg_name);
  641. String export_format;
  642. if (use_dmg() && p_path.ends_with("dmg")) {
  643. export_format = "dmg";
  644. } else if (p_path.ends_with("zip")) {
  645. export_format = "zip";
  646. } else if (p_path.ends_with("app")) {
  647. export_format = "app";
  648. } else {
  649. EditorNode::add_io_error("Invalid export format");
  650. return ERR_CANT_CREATE;
  651. }
  652. // Create our application bundle.
  653. String tmp_app_dir_name = pkg_name + ".app";
  654. String tmp_base_path_name;
  655. String tmp_app_path_name;
  656. String scr_path;
  657. if (export_format == "app") {
  658. tmp_base_path_name = p_path.get_base_dir();
  659. tmp_app_path_name = p_path;
  660. scr_path = p_path.get_basename() + ".command";
  661. } else {
  662. tmp_base_path_name = EditorPaths::get_singleton()->get_cache_dir().plus_file(pkg_name);
  663. tmp_app_path_name = tmp_base_path_name.plus_file(tmp_app_dir_name);
  664. scr_path = tmp_base_path_name.plus_file(pkg_name + ".command");
  665. }
  666. print_verbose("Exporting to " + tmp_app_path_name);
  667. Error err = OK;
  668. DirAccessRef tmp_app_dir = DirAccess::create_for_path(tmp_base_path_name);
  669. if (!tmp_app_dir) {
  670. err = ERR_CANT_CREATE;
  671. }
  672. DirAccess::remove_file_or_error(scr_path);
  673. if (DirAccess::exists(tmp_app_path_name)) {
  674. if (tmp_app_dir->change_dir(tmp_app_path_name) == OK) {
  675. tmp_app_dir->erase_contents_recursive();
  676. }
  677. }
  678. Array helpers = p_preset->get("codesign/entitlements/app_sandbox/helper_executables");
  679. // Create our folder structure.
  680. if (err == OK) {
  681. print_verbose("Creating " + tmp_app_path_name + "/Contents/MacOS");
  682. err = tmp_app_dir->make_dir_recursive(tmp_app_path_name + "/Contents/MacOS");
  683. }
  684. if (err == OK) {
  685. print_verbose("Creating " + tmp_app_path_name + "/Contents/Frameworks");
  686. err = tmp_app_dir->make_dir_recursive(tmp_app_path_name + "/Contents/Frameworks");
  687. }
  688. if ((err == OK) && helpers.size() > 0) {
  689. print_line("Creating " + tmp_app_path_name + "/Contents/Helpers");
  690. err = tmp_app_dir->make_dir_recursive(tmp_app_path_name + "/Contents/Helpers");
  691. }
  692. if (err == OK) {
  693. print_verbose("Creating " + tmp_app_path_name + "/Contents/Resources");
  694. err = tmp_app_dir->make_dir_recursive(tmp_app_path_name + "/Contents/Resources");
  695. }
  696. Dictionary appnames = ProjectSettings::get_singleton()->get("application/config/name_localized");
  697. Dictionary microphone_usage_descriptions = p_preset->get("privacy/microphone_usage_description_localized");
  698. Dictionary camera_usage_descriptions = p_preset->get("privacy/camera_usage_description_localized");
  699. Dictionary location_usage_descriptions = p_preset->get("privacy/location_usage_description_localized");
  700. Dictionary address_book_usage_descriptions = p_preset->get("privacy/address_book_usage_description_localized");
  701. Dictionary calendar_usage_descriptions = p_preset->get("privacy/calendar_usage_description_localized");
  702. Dictionary photos_library_usage_descriptions = p_preset->get("privacy/photos_library_usage_description_localized");
  703. Dictionary desktop_folder_usage_descriptions = p_preset->get("privacy/desktop_folder_usage_description_localized");
  704. Dictionary documents_folder_usage_descriptions = p_preset->get("privacy/documents_folder_usage_description_localized");
  705. Dictionary downloads_folder_usage_descriptions = p_preset->get("privacy/downloads_folder_usage_description_localized");
  706. Dictionary network_volumes_usage_descriptions = p_preset->get("privacy/network_volumes_usage_description_localized");
  707. Dictionary removable_volumes_usage_descriptions = p_preset->get("privacy/removable_volumes_usage_description_localized");
  708. Dictionary copyrights = p_preset->get("application/copyright_localized");
  709. Vector<String> translations = ProjectSettings::get_singleton()->get("internationalization/locale/translations");
  710. if (translations.size() > 0) {
  711. {
  712. String fname = tmp_app_path_name + "/Contents/Resources/en.lproj";
  713. tmp_app_dir->make_dir_recursive(fname);
  714. FileAccessRef f = FileAccess::open(fname + "/InfoPlist.strings", FileAccess::WRITE);
  715. f->store_line("/* Localized versions of Info.plist keys */");
  716. f->store_line("");
  717. f->store_line("CFBundleDisplayName = \"" + ProjectSettings::get_singleton()->get("application/config/name").operator String() + "\";");
  718. if (!((String)p_preset->get("privacy/microphone_usage_description")).is_empty()) {
  719. f->store_line("NSMicrophoneUsageDescription = \"" + p_preset->get("privacy/microphone_usage_description").operator String() + "\";");
  720. }
  721. if (!((String)p_preset->get("privacy/camera_usage_description")).is_empty()) {
  722. f->store_line("NSCameraUsageDescription = \"" + p_preset->get("privacy/camera_usage_description").operator String() + "\";");
  723. }
  724. if (!((String)p_preset->get("privacy/location_usage_description")).is_empty()) {
  725. f->store_line("NSLocationUsageDescription = \"" + p_preset->get("privacy/location_usage_description").operator String() + "\";");
  726. }
  727. if (!((String)p_preset->get("privacy/address_book_usage_description")).is_empty()) {
  728. f->store_line("NSContactsUsageDescription = \"" + p_preset->get("privacy/address_book_usage_description").operator String() + "\";");
  729. }
  730. if (!((String)p_preset->get("privacy/calendar_usage_description")).is_empty()) {
  731. f->store_line("NSCalendarsUsageDescription = \"" + p_preset->get("privacy/calendar_usage_description").operator String() + "\";");
  732. }
  733. if (!((String)p_preset->get("privacy/photos_library_usage_description")).is_empty()) {
  734. f->store_line("NSPhotoLibraryUsageDescription = \"" + p_preset->get("privacy/photos_library_usage_description").operator String() + "\";");
  735. }
  736. if (!((String)p_preset->get("privacy/desktop_folder_usage_description")).is_empty()) {
  737. f->store_line("NSDesktopFolderUsageDescription = \"" + p_preset->get("privacy/desktop_folder_usage_description").operator String() + "\";");
  738. }
  739. if (!((String)p_preset->get("privacy/documents_folder_usage_description")).is_empty()) {
  740. f->store_line("NSDocumentsFolderUsageDescription = \"" + p_preset->get("privacy/documents_folder_usage_description").operator String() + "\";");
  741. }
  742. if (!((String)p_preset->get("privacy/downloads_folder_usage_description")).is_empty()) {
  743. f->store_line("NSDownloadsFolderUsageDescription = \"" + p_preset->get("privacy/downloads_folder_usage_description").operator String() + "\";");
  744. }
  745. if (!((String)p_preset->get("privacy/network_volumes_usage_description")).is_empty()) {
  746. f->store_line("NSNetworkVolumesUsageDescription = \"" + p_preset->get("privacy/network_volumes_usage_description").operator String() + "\";");
  747. }
  748. if (!((String)p_preset->get("privacy/removable_volumes_usage_description")).is_empty()) {
  749. f->store_line("NSRemovableVolumesUsageDescription = \"" + p_preset->get("privacy/removable_volumes_usage_description").operator String() + "\";");
  750. }
  751. f->store_line("NSHumanReadableCopyright = \"" + p_preset->get("application/copyright").operator String() + "\";");
  752. }
  753. for (const String &E : translations) {
  754. Ref<Translation> tr = ResourceLoader::load(E);
  755. if (tr.is_valid()) {
  756. String lang = tr->get_locale();
  757. String fname = tmp_app_path_name + "/Contents/Resources/" + lang + ".lproj";
  758. tmp_app_dir->make_dir_recursive(fname);
  759. FileAccessRef f = FileAccess::open(fname + "/InfoPlist.strings", FileAccess::WRITE);
  760. f->store_line("/* Localized versions of Info.plist keys */");
  761. f->store_line("");
  762. if (appnames.has(lang)) {
  763. f->store_line("CFBundleDisplayName = \"" + appnames[lang].operator String() + "\";");
  764. }
  765. if (microphone_usage_descriptions.has(lang)) {
  766. f->store_line("NSMicrophoneUsageDescription = \"" + microphone_usage_descriptions[lang].operator String() + "\";");
  767. }
  768. if (camera_usage_descriptions.has(lang)) {
  769. f->store_line("NSCameraUsageDescription = \"" + camera_usage_descriptions[lang].operator String() + "\";");
  770. }
  771. if (location_usage_descriptions.has(lang)) {
  772. f->store_line("NSLocationUsageDescription = \"" + location_usage_descriptions[lang].operator String() + "\";");
  773. }
  774. if (address_book_usage_descriptions.has(lang)) {
  775. f->store_line("NSContactsUsageDescription = \"" + address_book_usage_descriptions[lang].operator String() + "\";");
  776. }
  777. if (calendar_usage_descriptions.has(lang)) {
  778. f->store_line("NSCalendarsUsageDescription = \"" + calendar_usage_descriptions[lang].operator String() + "\";");
  779. }
  780. if (photos_library_usage_descriptions.has(lang)) {
  781. f->store_line("NSPhotoLibraryUsageDescription = \"" + photos_library_usage_descriptions[lang].operator String() + "\";");
  782. }
  783. if (desktop_folder_usage_descriptions.has(lang)) {
  784. f->store_line("NSDesktopFolderUsageDescription = \"" + desktop_folder_usage_descriptions[lang].operator String() + "\";");
  785. }
  786. if (documents_folder_usage_descriptions.has(lang)) {
  787. f->store_line("NSDocumentsFolderUsageDescription = \"" + documents_folder_usage_descriptions[lang].operator String() + "\";");
  788. }
  789. if (downloads_folder_usage_descriptions.has(lang)) {
  790. f->store_line("NSDownloadsFolderUsageDescription = \"" + downloads_folder_usage_descriptions[lang].operator String() + "\";");
  791. }
  792. if (network_volumes_usage_descriptions.has(lang)) {
  793. f->store_line("NSNetworkVolumesUsageDescription = \"" + network_volumes_usage_descriptions[lang].operator String() + "\";");
  794. }
  795. if (removable_volumes_usage_descriptions.has(lang)) {
  796. f->store_line("NSRemovableVolumesUsageDescription = \"" + removable_volumes_usage_descriptions[lang].operator String() + "\";");
  797. }
  798. if (copyrights.has(lang)) {
  799. f->store_line("NSHumanReadableCopyright = \"" + copyrights[lang].operator String() + "\";");
  800. }
  801. }
  802. }
  803. }
  804. // Now process our template.
  805. bool found_binary = false;
  806. Vector<String> dylibs_found;
  807. while (ret == UNZ_OK && err == OK) {
  808. bool is_execute = false;
  809. // Get filename.
  810. unz_file_info info;
  811. char fname[16384];
  812. ret = unzGetCurrentFileInfo(src_pkg_zip, &info, fname, 16384, nullptr, 0, nullptr, 0);
  813. String file = String::utf8(fname);
  814. Vector<uint8_t> data;
  815. data.resize(info.uncompressed_size);
  816. // Read.
  817. unzOpenCurrentFile(src_pkg_zip);
  818. unzReadCurrentFile(src_pkg_zip, data.ptrw(), data.size());
  819. unzCloseCurrentFile(src_pkg_zip);
  820. // Write.
  821. file = file.replace_first("osx_template.app/", "");
  822. if (((info.external_fa >> 16L) & 0120000) == 0120000) {
  823. #ifndef UNIX_ENABLED
  824. WARN_PRINT(vformat("Relative symlinks are not supported on this OS, the exported project might be broken!"));
  825. #endif
  826. // Handle symlinks in the archive.
  827. file = tmp_app_path_name.plus_file(file);
  828. if (err == OK) {
  829. err = tmp_app_dir->make_dir_recursive(file.get_base_dir());
  830. }
  831. if (err == OK) {
  832. String lnk_data = String::utf8((const char *)data.ptr(), data.size());
  833. err = tmp_app_dir->create_link(lnk_data, file);
  834. print_verbose(vformat("ADDING SYMLINK %s => %s\n", file, lnk_data));
  835. }
  836. ret = unzGoToNextFile(src_pkg_zip);
  837. continue; // next
  838. }
  839. if (file == "Contents/Info.plist") {
  840. _fix_plist(p_preset, data, pkg_name);
  841. }
  842. if (file.begins_with("Contents/MacOS/godot_")) {
  843. if (file != "Contents/MacOS/" + binary_to_use) {
  844. ret = unzGoToNextFile(src_pkg_zip);
  845. continue; // skip
  846. }
  847. found_binary = true;
  848. is_execute = true;
  849. file = "Contents/MacOS/" + pkg_name;
  850. }
  851. if (file == "Contents/Resources/icon.icns") {
  852. // See if there is an icon.
  853. String iconpath;
  854. if (p_preset->get("application/icon") != "") {
  855. iconpath = p_preset->get("application/icon");
  856. } else {
  857. iconpath = ProjectSettings::get_singleton()->get("application/config/icon");
  858. }
  859. if (!iconpath.is_empty()) {
  860. if (iconpath.get_extension() == "icns") {
  861. FileAccess *icon = FileAccess::open(iconpath, FileAccess::READ);
  862. if (icon) {
  863. data.resize(icon->get_length());
  864. icon->get_buffer(&data.write[0], icon->get_length());
  865. icon->close();
  866. memdelete(icon);
  867. }
  868. } else {
  869. Ref<Image> icon;
  870. icon.instantiate();
  871. icon->load(iconpath);
  872. if (!icon->is_empty()) {
  873. _make_icon(icon, data);
  874. }
  875. }
  876. }
  877. }
  878. if (data.size() > 0) {
  879. if (file.find("/data.mono.osx.64.release_debug/") != -1) {
  880. if (!p_debug) {
  881. ret = unzGoToNextFile(src_pkg_zip);
  882. continue; // skip
  883. }
  884. file = file.replace("/data.mono.osx.64.release_debug/", "/GodotSharp/");
  885. }
  886. if (file.find("/data.mono.osx.64.release/") != -1) {
  887. if (p_debug) {
  888. ret = unzGoToNextFile(src_pkg_zip);
  889. continue; // skip
  890. }
  891. file = file.replace("/data.mono.osx.64.release/", "/GodotSharp/");
  892. }
  893. if (file.ends_with(".dylib")) {
  894. dylibs_found.push_back(file);
  895. }
  896. print_verbose("ADDING: " + file + " size: " + itos(data.size()));
  897. // Write it into our application bundle.
  898. file = tmp_app_path_name.plus_file(file);
  899. if (err == OK) {
  900. err = tmp_app_dir->make_dir_recursive(file.get_base_dir());
  901. }
  902. if (err == OK) {
  903. FileAccess *f = FileAccess::open(file, FileAccess::WRITE);
  904. if (f) {
  905. f->store_buffer(data.ptr(), data.size());
  906. f->close();
  907. if (is_execute) {
  908. // chmod with 0755 if the file is executable.
  909. FileAccess::set_unix_permissions(file, 0755);
  910. }
  911. memdelete(f);
  912. } else {
  913. err = ERR_CANT_CREATE;
  914. }
  915. }
  916. }
  917. ret = unzGoToNextFile(src_pkg_zip);
  918. }
  919. // We're done with our source zip.
  920. unzClose(src_pkg_zip);
  921. if (!found_binary) {
  922. ERR_PRINT(vformat("Requested template binary '%s' not found. It might be missing from your template archive.", binary_to_use));
  923. err = ERR_FILE_NOT_FOUND;
  924. }
  925. // Save console script.
  926. if (err == OK) {
  927. int con_scr = p_preset->get("debug/export_console_script");
  928. if ((con_scr == 1 && p_debug) || (con_scr == 2)) {
  929. err = _export_debug_script(p_preset, pkg_name, tmp_app_path_name.get_file() + "/Contents/MacOS/" + pkg_name, scr_path);
  930. FileAccess::set_unix_permissions(scr_path, 0755);
  931. }
  932. }
  933. if (err == OK) {
  934. if (ep.step(TTR("Making PKG"), 1)) {
  935. return ERR_SKIP;
  936. }
  937. String pack_path = tmp_app_path_name + "/Contents/Resources/" + pkg_name + ".pck";
  938. Vector<SharedObject> shared_objects;
  939. err = save_pack(p_preset, pack_path, &shared_objects);
  940. // See if we can code sign our new package.
  941. bool sign_enabled = p_preset->get("codesign/enable");
  942. String ent_path = p_preset->get("codesign/entitlements/custom_file");
  943. String hlp_ent_path = EditorPaths::get_singleton()->get_cache_dir().plus_file(pkg_name + "_helper.entitlements");
  944. if (sign_enabled && (ent_path.is_empty())) {
  945. ent_path = EditorPaths::get_singleton()->get_cache_dir().plus_file(pkg_name + ".entitlements");
  946. FileAccess *ent_f = FileAccess::open(ent_path, FileAccess::WRITE);
  947. if (ent_f) {
  948. ent_f->store_line("<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
  949. ent_f->store_line("<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">");
  950. ent_f->store_line("<plist version=\"1.0\">");
  951. ent_f->store_line("<dict>");
  952. if (Engine::get_singleton()->has_singleton("GodotSharp")) {
  953. // These entitlements are required to run managed code, and are always enabled in Mono builds.
  954. ent_f->store_line("<key>com.apple.security.cs.allow-jit</key>");
  955. ent_f->store_line("<true/>");
  956. ent_f->store_line("<key>com.apple.security.cs.allow-unsigned-executable-memory</key>");
  957. ent_f->store_line("<true/>");
  958. ent_f->store_line("<key>com.apple.security.cs.allow-dyld-environment-variables</key>");
  959. ent_f->store_line("<true/>");
  960. } else {
  961. if ((bool)p_preset->get("codesign/entitlements/allow_jit_code_execution")) {
  962. ent_f->store_line("<key>com.apple.security.cs.allow-jit</key>");
  963. ent_f->store_line("<true/>");
  964. }
  965. if ((bool)p_preset->get("codesign/entitlements/allow_unsigned_executable_memory")) {
  966. ent_f->store_line("<key>com.apple.security.cs.allow-unsigned-executable-memory</key>");
  967. ent_f->store_line("<true/>");
  968. }
  969. if ((bool)p_preset->get("codesign/entitlements/allow_dyld_environment_variables")) {
  970. ent_f->store_line("<key>com.apple.security.cs.allow-dyld-environment-variables</key>");
  971. ent_f->store_line("<true/>");
  972. }
  973. }
  974. if ((bool)p_preset->get("codesign/entitlements/disable_library_validation")) {
  975. ent_f->store_line("<key>com.apple.security.cs.disable-library-validation</key>");
  976. ent_f->store_line("<true/>");
  977. }
  978. if ((bool)p_preset->get("codesign/entitlements/audio_input")) {
  979. ent_f->store_line("<key>com.apple.security.device.audio-input</key>");
  980. ent_f->store_line("<true/>");
  981. }
  982. if ((bool)p_preset->get("codesign/entitlements/camera")) {
  983. ent_f->store_line("<key>com.apple.security.device.camera</key>");
  984. ent_f->store_line("<true/>");
  985. }
  986. if ((bool)p_preset->get("codesign/entitlements/location")) {
  987. ent_f->store_line("<key>com.apple.security.personal-information.location</key>");
  988. ent_f->store_line("<true/>");
  989. }
  990. if ((bool)p_preset->get("codesign/entitlements/address_book")) {
  991. ent_f->store_line("<key>com.apple.security.personal-information.addressbook</key>");
  992. ent_f->store_line("<true/>");
  993. }
  994. if ((bool)p_preset->get("codesign/entitlements/calendars")) {
  995. ent_f->store_line("<key>com.apple.security.personal-information.calendars</key>");
  996. ent_f->store_line("<true/>");
  997. }
  998. if ((bool)p_preset->get("codesign/entitlements/photos_library")) {
  999. ent_f->store_line("<key>com.apple.security.personal-information.photos-library</key>");
  1000. ent_f->store_line("<true/>");
  1001. }
  1002. if ((bool)p_preset->get("codesign/entitlements/apple_events")) {
  1003. ent_f->store_line("<key>com.apple.security.automation.apple-events</key>");
  1004. ent_f->store_line("<true/>");
  1005. }
  1006. if ((bool)p_preset->get("codesign/entitlements/debugging")) {
  1007. ent_f->store_line("<key>com.apple.security.get-task-allow</key>");
  1008. ent_f->store_line("<true/>");
  1009. }
  1010. if ((bool)p_preset->get("codesign/entitlements/app_sandbox/enabled")) {
  1011. ent_f->store_line("<key>com.apple.security.app-sandbox</key>");
  1012. ent_f->store_line("<true/>");
  1013. if ((bool)p_preset->get("codesign/entitlements/app_sandbox/network_server")) {
  1014. ent_f->store_line("<key>com.apple.security.network.server</key>");
  1015. ent_f->store_line("<true/>");
  1016. }
  1017. if ((bool)p_preset->get("codesign/entitlements/app_sandbox/network_client")) {
  1018. ent_f->store_line("<key>com.apple.security.network.client</key>");
  1019. ent_f->store_line("<true/>");
  1020. }
  1021. if ((bool)p_preset->get("codesign/entitlements/app_sandbox/device_usb")) {
  1022. ent_f->store_line("<key>com.apple.security.device.usb</key>");
  1023. ent_f->store_line("<true/>");
  1024. }
  1025. if ((bool)p_preset->get("codesign/entitlements/app_sandbox/device_bluetooth")) {
  1026. ent_f->store_line("<key>com.apple.security.device.bluetooth</key>");
  1027. ent_f->store_line("<true/>");
  1028. }
  1029. if ((int)p_preset->get("codesign/entitlements/app_sandbox/files_downloads") == 1) {
  1030. ent_f->store_line("<key>com.apple.security.files.downloads.read-only</key>");
  1031. ent_f->store_line("<true/>");
  1032. }
  1033. if ((int)p_preset->get("codesign/entitlements/app_sandbox/files_downloads") == 2) {
  1034. ent_f->store_line("<key>com.apple.security.files.downloads.read-write</key>");
  1035. ent_f->store_line("<true/>");
  1036. }
  1037. if ((int)p_preset->get("codesign/entitlements/app_sandbox/files_pictures") == 1) {
  1038. ent_f->store_line("<key>com.apple.security.files.pictures.read-only</key>");
  1039. ent_f->store_line("<true/>");
  1040. }
  1041. if ((int)p_preset->get("codesign/entitlements/app_sandbox/files_pictures") == 2) {
  1042. ent_f->store_line("<key>com.apple.security.files.pictures.read-write</key>");
  1043. ent_f->store_line("<true/>");
  1044. }
  1045. if ((int)p_preset->get("codesign/entitlements/app_sandbox/files_music") == 1) {
  1046. ent_f->store_line("<key>com.apple.security.files.music.read-only</key>");
  1047. ent_f->store_line("<true/>");
  1048. }
  1049. if ((int)p_preset->get("codesign/entitlements/app_sandbox/files_music") == 2) {
  1050. ent_f->store_line("<key>com.apple.security.files.music.read-write</key>");
  1051. ent_f->store_line("<true/>");
  1052. }
  1053. if ((int)p_preset->get("codesign/entitlements/app_sandbox/files_movies") == 1) {
  1054. ent_f->store_line("<key>com.apple.security.files.movies.read-only</key>");
  1055. ent_f->store_line("<true/>");
  1056. }
  1057. if ((int)p_preset->get("codesign/entitlements/app_sandbox/files_movies") == 2) {
  1058. ent_f->store_line("<key>com.apple.security.files.movies.read-write</key>");
  1059. ent_f->store_line("<true/>");
  1060. }
  1061. }
  1062. ent_f->store_line("</dict>");
  1063. ent_f->store_line("</plist>");
  1064. ent_f->close();
  1065. memdelete(ent_f);
  1066. } else {
  1067. err = ERR_CANT_CREATE;
  1068. }
  1069. if ((err == OK) && helpers.size() > 0) {
  1070. ent_f = FileAccess::open(hlp_ent_path, FileAccess::WRITE);
  1071. if (ent_f) {
  1072. ent_f->store_line("<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
  1073. ent_f->store_line("<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">");
  1074. ent_f->store_line("<plist version=\"1.0\">");
  1075. ent_f->store_line("<dict>");
  1076. ent_f->store_line("<key>com.apple.security.app-sandbox</key>");
  1077. ent_f->store_line("<true/>");
  1078. ent_f->store_line("<key>com.apple.security.inherit</key>");
  1079. ent_f->store_line("<true/>");
  1080. ent_f->store_line("</dict>");
  1081. ent_f->store_line("</plist>");
  1082. ent_f->close();
  1083. memdelete(ent_f);
  1084. } else {
  1085. err = ERR_CANT_CREATE;
  1086. }
  1087. }
  1088. }
  1089. if ((err == OK) && helpers.size() > 0) {
  1090. DirAccessRef da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  1091. for (int i = 0; i < helpers.size(); i++) {
  1092. String hlp_path = helpers[i];
  1093. err = da->copy(hlp_path, tmp_app_path_name + "/Contents/Helpers/" + hlp_path.get_file());
  1094. if (err == OK && sign_enabled) {
  1095. err = _code_sign(p_preset, tmp_app_path_name + "/Contents/Helpers/" + hlp_path.get_file(), hlp_ent_path);
  1096. }
  1097. FileAccess::set_unix_permissions(tmp_app_path_name + "/Contents/Helpers/" + hlp_path.get_file(), 0755);
  1098. }
  1099. }
  1100. bool ad_hoc = true;
  1101. if (err == OK) {
  1102. #ifdef OSX_ENABLED
  1103. String sign_identity = p_preset->get("codesign/identity");
  1104. #else
  1105. String sign_identity = "-";
  1106. #endif
  1107. ad_hoc = (sign_identity == "" || sign_identity == "-");
  1108. bool lib_validation = p_preset->get("codesign/entitlements/disable_library_validation");
  1109. if ((!dylibs_found.is_empty() || !shared_objects.is_empty()) && sign_enabled && ad_hoc && !lib_validation) {
  1110. ERR_PRINT("Ad-hoc signed applications require the 'Disable Library Validation' entitlement to load dynamic libraries.");
  1111. err = ERR_CANT_CREATE;
  1112. }
  1113. }
  1114. if (err == OK) {
  1115. DirAccessRef da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  1116. for (int i = 0; i < shared_objects.size(); i++) {
  1117. String src_path = ProjectSettings::get_singleton()->globalize_path(shared_objects[i].path);
  1118. String path_in_app{ tmp_app_path_name + "/Contents/Frameworks/" + src_path.get_file() };
  1119. err = _copy_and_sign_files(da, src_path, path_in_app, sign_enabled, p_preset, ent_path, true);
  1120. if (err != OK) {
  1121. break;
  1122. }
  1123. }
  1124. Vector<Ref<EditorExportPlugin>> export_plugins{ EditorExport::get_singleton()->get_export_plugins() };
  1125. for (int i = 0; i < export_plugins.size(); ++i) {
  1126. err = _export_osx_plugins_for(export_plugins[i], tmp_app_path_name, da, sign_enabled, p_preset, ent_path);
  1127. if (err != OK) {
  1128. break;
  1129. }
  1130. }
  1131. }
  1132. if (sign_enabled) {
  1133. for (int i = 0; i < dylibs_found.size(); i++) {
  1134. if (err == OK) {
  1135. err = _code_sign(p_preset, tmp_app_path_name + "/" + dylibs_found[i], ent_path);
  1136. }
  1137. }
  1138. }
  1139. if (err == OK && sign_enabled) {
  1140. if (ep.step(TTR("Code signing bundle"), 2)) {
  1141. return ERR_SKIP;
  1142. }
  1143. err = _code_sign(p_preset, tmp_app_path_name, ent_path);
  1144. }
  1145. if (export_format == "dmg") {
  1146. // Create a DMG.
  1147. if (err == OK) {
  1148. if (ep.step(TTR("Making DMG"), 3)) {
  1149. return ERR_SKIP;
  1150. }
  1151. err = _create_dmg(p_path, pkg_name, tmp_base_path_name);
  1152. }
  1153. // Sign DMG.
  1154. if (err == OK && sign_enabled && !ad_hoc) {
  1155. if (ep.step(TTR("Code signing DMG"), 3)) {
  1156. return ERR_SKIP;
  1157. }
  1158. err = _code_sign(p_preset, p_path, ent_path);
  1159. }
  1160. } else if (export_format == "zip") {
  1161. // Create ZIP.
  1162. if (err == OK) {
  1163. if (ep.step(TTR("Making ZIP"), 3)) {
  1164. return ERR_SKIP;
  1165. }
  1166. if (FileAccess::exists(p_path)) {
  1167. OS::get_singleton()->move_to_trash(p_path);
  1168. }
  1169. FileAccess *dst_f = nullptr;
  1170. zlib_filefunc_def io_dst = zipio_create_io_from_file(&dst_f);
  1171. zipFile zip = zipOpen2(p_path.utf8().get_data(), APPEND_STATUS_CREATE, nullptr, &io_dst);
  1172. _zip_folder_recursive(zip, tmp_base_path_name, "", pkg_name);
  1173. zipClose(zip, nullptr);
  1174. }
  1175. }
  1176. #ifdef OSX_ENABLED
  1177. bool noto_enabled = p_preset->get("notarization/enable");
  1178. if (err == OK && noto_enabled) {
  1179. if (export_format == "app") {
  1180. WARN_PRINT("Notarization requires the app to be archived first, select the DMG or ZIP export format instead.");
  1181. } else {
  1182. if (ep.step(TTR("Sending archive for notarization"), 4)) {
  1183. return ERR_SKIP;
  1184. }
  1185. err = _notarize(p_preset, p_path);
  1186. }
  1187. }
  1188. #endif
  1189. // Clean up temporary entitlements files.
  1190. DirAccess::remove_file_or_error(hlp_ent_path);
  1191. // Clean up temporary .app dir and generated entitlements.
  1192. if ((String)(p_preset->get("codesign/entitlements/custom_file")) == "") {
  1193. tmp_app_dir->remove(ent_path);
  1194. }
  1195. if (export_format != "app") {
  1196. if (tmp_app_dir->change_dir(tmp_base_path_name) == OK) {
  1197. tmp_app_dir->erase_contents_recursive();
  1198. tmp_app_dir->change_dir("..");
  1199. tmp_app_dir->remove(pkg_name);
  1200. }
  1201. }
  1202. }
  1203. return err;
  1204. }
  1205. void EditorExportPlatformOSX::_zip_folder_recursive(zipFile &p_zip, const String &p_root_path, const String &p_folder, const String &p_pkg_name) {
  1206. String dir = p_folder.is_empty() ? p_root_path : p_root_path.plus_file(p_folder);
  1207. DirAccessRef da = DirAccess::open(dir);
  1208. da->list_dir_begin();
  1209. String f = da->get_next();
  1210. while (!f.is_empty()) {
  1211. if (f == "." || f == "..") {
  1212. f = da->get_next();
  1213. continue;
  1214. }
  1215. if (da->is_link(f)) {
  1216. OS::Time time = OS::get_singleton()->get_time();
  1217. OS::Date date = OS::get_singleton()->get_date();
  1218. zip_fileinfo zipfi;
  1219. zipfi.tmz_date.tm_hour = time.hour;
  1220. zipfi.tmz_date.tm_mday = date.day;
  1221. zipfi.tmz_date.tm_min = time.minute;
  1222. zipfi.tmz_date.tm_mon = date.month - 1; // Note: "tm" month range - 0..11, Godot month range - 1..12, https://www.cplusplus.com/reference/ctime/tm/
  1223. zipfi.tmz_date.tm_sec = time.second;
  1224. zipfi.tmz_date.tm_year = date.year;
  1225. zipfi.dosDate = 0;
  1226. // 0120000: symbolic link type
  1227. // 0000755: permissions rwxr-xr-x
  1228. // 0000644: permissions rw-r--r--
  1229. uint32_t _mode = 0120644;
  1230. zipfi.external_fa = (_mode << 16L) | !(_mode & 0200);
  1231. zipfi.internal_fa = 0;
  1232. zipOpenNewFileInZip4(p_zip,
  1233. p_folder.plus_file(f).utf8().get_data(),
  1234. &zipfi,
  1235. nullptr,
  1236. 0,
  1237. nullptr,
  1238. 0,
  1239. nullptr,
  1240. Z_DEFLATED,
  1241. Z_DEFAULT_COMPRESSION,
  1242. 0,
  1243. -MAX_WBITS,
  1244. DEF_MEM_LEVEL,
  1245. Z_DEFAULT_STRATEGY,
  1246. nullptr,
  1247. 0,
  1248. 0x0314, // "version made by", 0x03 - Unix, 0x14 - ZIP specification version 2.0, required to store Unix file permissions
  1249. 0);
  1250. String target = da->read_link(f);
  1251. zipWriteInFileInZip(p_zip, target.utf8().get_data(), target.utf8().size());
  1252. zipCloseFileInZip(p_zip);
  1253. } else if (da->current_is_dir()) {
  1254. _zip_folder_recursive(p_zip, p_root_path, p_folder.plus_file(f), p_pkg_name);
  1255. } else {
  1256. bool is_executable = (p_folder.ends_with("MacOS") && (f == p_pkg_name)) || p_folder.ends_with("Helpers") || f.ends_with(".command");
  1257. OS::Time time = OS::get_singleton()->get_time();
  1258. OS::Date date = OS::get_singleton()->get_date();
  1259. zip_fileinfo zipfi;
  1260. zipfi.tmz_date.tm_hour = time.hour;
  1261. zipfi.tmz_date.tm_mday = date.day;
  1262. zipfi.tmz_date.tm_min = time.minute;
  1263. zipfi.tmz_date.tm_mon = date.month - 1; // Note: "tm" month range - 0..11, Godot month range - 1..12, https://www.cplusplus.com/reference/ctime/tm/
  1264. zipfi.tmz_date.tm_sec = time.second;
  1265. zipfi.tmz_date.tm_year = date.year;
  1266. zipfi.dosDate = 0;
  1267. // 0100000: regular file type
  1268. // 0000755: permissions rwxr-xr-x
  1269. // 0000644: permissions rw-r--r--
  1270. uint32_t _mode = (is_executable ? 0100755 : 0100644);
  1271. zipfi.external_fa = (_mode << 16L) | !(_mode & 0200);
  1272. zipfi.internal_fa = 0;
  1273. zipOpenNewFileInZip4(p_zip,
  1274. p_folder.plus_file(f).utf8().get_data(),
  1275. &zipfi,
  1276. nullptr,
  1277. 0,
  1278. nullptr,
  1279. 0,
  1280. nullptr,
  1281. Z_DEFLATED,
  1282. Z_DEFAULT_COMPRESSION,
  1283. 0,
  1284. -MAX_WBITS,
  1285. DEF_MEM_LEVEL,
  1286. Z_DEFAULT_STRATEGY,
  1287. nullptr,
  1288. 0,
  1289. 0x0314, // "version made by", 0x03 - Unix, 0x14 - ZIP specification version 2.0, required to store Unix file permissions
  1290. 0);
  1291. FileAccessRef fa = FileAccess::open(dir.plus_file(f), FileAccess::READ);
  1292. if (!fa) {
  1293. ERR_FAIL_MSG(vformat("Can't open file to read from path \"%s\".", dir.plus_file(f)));
  1294. }
  1295. const int bufsize = 16384;
  1296. uint8_t buf[bufsize];
  1297. while (true) {
  1298. uint64_t got = fa->get_buffer(buf, bufsize);
  1299. if (got == 0) {
  1300. break;
  1301. }
  1302. zipWriteInFileInZip(p_zip, buf, got);
  1303. }
  1304. zipCloseFileInZip(p_zip);
  1305. }
  1306. f = da->get_next();
  1307. }
  1308. da->list_dir_end();
  1309. }
  1310. bool EditorExportPlatformOSX::can_export(const Ref<EditorExportPreset> &p_preset, String &r_error, bool &r_missing_templates) const {
  1311. String err;
  1312. bool valid = false;
  1313. // Look for export templates (custom templates).
  1314. bool dvalid = false;
  1315. bool rvalid = false;
  1316. if (p_preset->get("custom_template/debug") != "") {
  1317. dvalid = FileAccess::exists(p_preset->get("custom_template/debug"));
  1318. if (!dvalid) {
  1319. err += TTR("Custom debug template not found.") + "\n";
  1320. }
  1321. }
  1322. if (p_preset->get("custom_template/release") != "") {
  1323. rvalid = FileAccess::exists(p_preset->get("custom_template/release"));
  1324. if (!rvalid) {
  1325. err += TTR("Custom release template not found.") + "\n";
  1326. }
  1327. }
  1328. // Look for export templates (official templates, check only is custom templates are not set).
  1329. if (!dvalid || !rvalid) {
  1330. dvalid = exists_export_template("osx.zip", &err);
  1331. rvalid = dvalid; // Both in the same ZIP.
  1332. }
  1333. valid = dvalid || rvalid;
  1334. r_missing_templates = !valid;
  1335. String identifier = p_preset->get("application/bundle_identifier");
  1336. String pn_err;
  1337. if (!is_package_name_valid(identifier, &pn_err)) {
  1338. err += TTR("Invalid bundle identifier:") + " " + pn_err + "\n";
  1339. valid = false;
  1340. }
  1341. bool sign_enabled = p_preset->get("codesign/enable");
  1342. #ifdef OSX_ENABLED
  1343. bool noto_enabled = p_preset->get("notarization/enable");
  1344. bool ad_hoc = ((p_preset->get("codesign/identity") == "") || (p_preset->get("codesign/identity") == "-"));
  1345. if (!ad_hoc && (bool)EditorSettings::get_singleton()->get("export/macos/force_builtin_codesign")) {
  1346. err += TTR("Warning: Built-in \"codesign\" is selected in the Editor Settings. Code signing is limited to ad-hoc signature only.") + "\n";
  1347. }
  1348. if (!ad_hoc && !FileAccess::exists("/usr/bin/codesign") && !FileAccess::exists("/bin/codesign")) {
  1349. err += TTR("Warning: Xcode command line tools are not installed, using built-in \"codesign\". Code signing is limited to ad-hoc signature only.") + "\n";
  1350. }
  1351. if (noto_enabled) {
  1352. if (ad_hoc) {
  1353. err += TTR("Notarization: Notarization with an ad-hoc signature is not supported.") + "\n";
  1354. valid = false;
  1355. }
  1356. if (!sign_enabled) {
  1357. err += TTR("Notarization: Code signing is required for notarization.") + "\n";
  1358. valid = false;
  1359. }
  1360. if (!(bool)p_preset->get("codesign/hardened_runtime")) {
  1361. err += TTR("Notarization: Hardened runtime is required for notarization.") + "\n";
  1362. valid = false;
  1363. }
  1364. if (!(bool)p_preset->get("codesign/timestamp")) {
  1365. err += TTR("Notarization: Timestamping is required for notarization.") + "\n";
  1366. valid = false;
  1367. }
  1368. if (p_preset->get("notarization/apple_id_name") == "") {
  1369. err += TTR("Notarization: Apple ID name not specified.") + "\n";
  1370. valid = false;
  1371. }
  1372. if (p_preset->get("notarization/apple_id_password") == "") {
  1373. err += TTR("Notarization: Apple ID password not specified.") + "\n";
  1374. valid = false;
  1375. }
  1376. } else {
  1377. err += TTR("Warning: Notarization is disabled. The exported project will be blocked by Gatekeeper if it's downloaded from an unknown source.") + "\n";
  1378. if (!sign_enabled) {
  1379. err += TTR("Code signing is disabled. The exported project will not run on Macs with enabled Gatekeeper and Apple Silicon powered Macs.") + "\n";
  1380. } else {
  1381. if ((bool)p_preset->get("codesign/hardened_runtime") && ad_hoc) {
  1382. err += TTR("Hardened Runtime is not compatible with ad-hoc signature, and will be disabled!") + "\n";
  1383. }
  1384. if ((bool)p_preset->get("codesign/timestamp") && ad_hoc) {
  1385. err += TTR("Timestamping is not compatible with ad-hoc signature, and will be disabled!") + "\n";
  1386. }
  1387. }
  1388. }
  1389. #else
  1390. err += TTR("Warning: Notarization is not supported from this OS. The exported project will be blocked by Gatekeeper if it's downloaded from an unknown source.") + "\n";
  1391. if (!sign_enabled) {
  1392. err += TTR("Code signing is disabled. The exported project will not run on Macs with enabled Gatekeeper and Apple Silicon powered Macs.") + "\n";
  1393. }
  1394. #endif
  1395. if (sign_enabled) {
  1396. if ((bool)p_preset->get("codesign/entitlements/audio_input") && ((String)p_preset->get("privacy/microphone_usage_description")).is_empty()) {
  1397. err += TTR("Privacy: Microphone access is enabled, but usage description is not specified.") + "\n";
  1398. valid = false;
  1399. }
  1400. if ((bool)p_preset->get("codesign/entitlements/camera") && ((String)p_preset->get("privacy/camera_usage_description")).is_empty()) {
  1401. err += TTR("Privacy: Camera access is enabled, but usage description is not specified.") + "\n";
  1402. valid = false;
  1403. }
  1404. if ((bool)p_preset->get("codesign/entitlements/location") && ((String)p_preset->get("privacy/location_usage_description")).is_empty()) {
  1405. err += TTR("Privacy: Location information access is enabled, but usage description is not specified.") + "\n";
  1406. valid = false;
  1407. }
  1408. if ((bool)p_preset->get("codesign/entitlements/address_book") && ((String)p_preset->get("privacy/address_book_usage_description")).is_empty()) {
  1409. err += TTR("Privacy: Address book access is enabled, but usage description is not specified.") + "\n";
  1410. valid = false;
  1411. }
  1412. if ((bool)p_preset->get("codesign/entitlements/calendars") && ((String)p_preset->get("privacy/calendar_usage_description")).is_empty()) {
  1413. err += TTR("Privacy: Calendar access is enabled, but usage description is not specified.") + "\n";
  1414. valid = false;
  1415. }
  1416. if ((bool)p_preset->get("codesign/entitlements/photos_library") && ((String)p_preset->get("privacy/photos_library_usage_description")).is_empty()) {
  1417. err += TTR("Privacy: Photo library access is enabled, but usage description is not specified.") + "\n";
  1418. valid = false;
  1419. }
  1420. }
  1421. if (!err.is_empty()) {
  1422. r_error = err;
  1423. }
  1424. return valid;
  1425. }
  1426. EditorExportPlatformOSX::EditorExportPlatformOSX() {
  1427. Ref<Image> img = memnew(Image(_osx_logo));
  1428. logo.instantiate();
  1429. logo->create_from_image(img);
  1430. }
  1431. EditorExportPlatformOSX::~EditorExportPlatformOSX() {
  1432. }