export_plugin.h 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137
  1. /**************************************************************************/
  2. /* export_plugin.h */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #ifndef WEB_EXPORT_PLUGIN_H
  31. #define WEB_EXPORT_PLUGIN_H
  32. #include "editor_http_server.h"
  33. #include "core/config/project_settings.h"
  34. #include "core/io/image_loader.h"
  35. #include "core/io/stream_peer_tls.h"
  36. #include "core/io/tcp_server.h"
  37. #include "core/io/zip_io.h"
  38. #include "editor/editor_node.h"
  39. #include "editor/export/editor_export_platform.h"
  40. #include "main/splash.gen.h"
  41. class EditorExportPlatformWeb : public EditorExportPlatform {
  42. GDCLASS(EditorExportPlatformWeb, EditorExportPlatform);
  43. Ref<ImageTexture> logo;
  44. Ref<ImageTexture> run_icon;
  45. Ref<ImageTexture> stop_icon;
  46. int menu_options = 0;
  47. Ref<EditorHTTPServer> server;
  48. bool server_quit = false;
  49. Mutex server_lock;
  50. Thread server_thread;
  51. String _get_template_name(bool p_extension, bool p_debug) const {
  52. String name = "web";
  53. if (p_extension) {
  54. name += "_dlink";
  55. }
  56. if (p_debug) {
  57. name += "_debug.zip";
  58. } else {
  59. name += "_release.zip";
  60. }
  61. return name;
  62. }
  63. Ref<Image> _get_project_icon() const {
  64. Ref<Image> icon;
  65. icon.instantiate();
  66. const String icon_path = String(GLOBAL_GET("application/config/icon")).strip_edges();
  67. if (icon_path.is_empty() || ImageLoader::load_image(icon_path, icon) != OK) {
  68. return EditorNode::get_singleton()->get_editor_theme()->get_icon(SNAME("DefaultProjectIcon"), SNAME("EditorIcons"))->get_image();
  69. }
  70. return icon;
  71. }
  72. Ref<Image> _get_project_splash() const {
  73. Ref<Image> splash;
  74. splash.instantiate();
  75. const String splash_path = String(GLOBAL_GET("application/boot_splash/image")).strip_edges();
  76. if (splash_path.is_empty() || ImageLoader::load_image(splash_path, splash) != OK) {
  77. return Ref<Image>(memnew(Image(boot_splash_png)));
  78. }
  79. return splash;
  80. }
  81. Error _extract_template(const String &p_template, const String &p_dir, const String &p_name, bool pwa);
  82. void _replace_strings(HashMap<String, String> p_replaces, Vector<uint8_t> &r_template);
  83. void _fix_html(Vector<uint8_t> &p_html, const Ref<EditorExportPreset> &p_preset, const String &p_name, bool p_debug, int p_flags, const Vector<SharedObject> p_shared_objects, const Dictionary &p_file_sizes);
  84. Error _add_manifest_icon(const String &p_path, const String &p_icon, int p_size, Array &r_arr);
  85. Error _build_pwa(const Ref<EditorExportPreset> &p_preset, const String p_path, const Vector<SharedObject> &p_shared_objects);
  86. Error _write_or_error(const uint8_t *p_content, int p_len, String p_path);
  87. static void _server_thread_poll(void *data);
  88. public:
  89. virtual void get_preset_features(const Ref<EditorExportPreset> &p_preset, List<String> *r_features) const override;
  90. virtual void get_export_options(List<ExportOption> *r_options) const override;
  91. virtual String get_name() const override;
  92. virtual String get_os_name() const override;
  93. virtual Ref<Texture2D> get_logo() const override;
  94. virtual bool has_valid_export_configuration(const Ref<EditorExportPreset> &p_preset, String &r_error, bool &r_missing_templates, bool p_debug = false) const override;
  95. virtual bool has_valid_project_configuration(const Ref<EditorExportPreset> &p_preset, String &r_error) const override;
  96. virtual List<String> get_binary_extensions(const Ref<EditorExportPreset> &p_preset) const override;
  97. virtual Error export_project(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, int p_flags = 0) override;
  98. virtual bool poll_export() override;
  99. virtual int get_options_count() const override;
  100. virtual String get_option_label(int p_index) const override { return p_index ? TTR("Stop HTTP Server") : TTR("Run in Browser"); }
  101. virtual String get_option_tooltip(int p_index) const override { return p_index ? TTR("Stop HTTP Server") : TTR("Run exported HTML in the system's default browser."); }
  102. virtual Ref<ImageTexture> get_option_icon(int p_index) const override;
  103. virtual Error run(const Ref<EditorExportPreset> &p_preset, int p_option, int p_debug_flags) override;
  104. virtual Ref<Texture2D> get_run_icon() const override;
  105. virtual void get_platform_features(List<String> *r_features) const override {
  106. r_features->push_back("web");
  107. r_features->push_back(get_os_name().to_lower());
  108. }
  109. virtual void resolve_platform_feature_priorities(const Ref<EditorExportPreset> &p_preset, HashSet<String> &p_features) override {
  110. }
  111. String get_debug_protocol() const override { return "ws://"; }
  112. EditorExportPlatformWeb();
  113. ~EditorExportPlatformWeb();
  114. };
  115. #endif // WEB_EXPORT_PLUGIN_H