godot/platform/osx/export/export.cpp

521 lines
15 KiB
C++
Raw Normal View History

/*************************************************************************/
/* export.cpp */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* http://www.godotengine.org */
/*************************************************************************/
/* Copyright (c) 2007-2017 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2017 Godot Engine contributors (cf. AUTHORS.md) */
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/*************************************************************************/
2014-02-10 01:10:30 +00:00
#include "export.h"
#include "editor/editor_import_export.h"
#include "editor/editor_node.h"
#include "editor/editor_settings.h"
#include "globals.h"
2014-02-10 01:10:30 +00:00
#include "io/marshalls.h"
#include "io/resource_saver.h"
#include "io/zip_io.h"
2014-02-10 01:10:30 +00:00
#include "os/file_access.h"
#include "os/os.h"
#include "platform/osx/logo.gen.h"
2014-02-10 01:10:30 +00:00
#include "string.h"
#include "version.h"
2014-02-10 01:10:30 +00:00
class EditorExportPlatformOSX : public EditorExportPlatform {
OBJ_TYPE(EditorExportPlatformOSX, EditorExportPlatform);
2014-02-10 01:10:30 +00:00
String custom_release_package;
String custom_debug_package;
enum BitsMode {
BITS_FAT,
BITS_64,
BITS_32
};
2014-02-10 01:10:30 +00:00
int version_code;
String app_name;
String info;
String icon;
String identifier;
String short_version;
String version;
String signature;
String copyright;
BitsMode bits_mode;
2014-02-10 01:10:30 +00:00
bool high_resolution;
Ref<ImageTexture> logo;
void _fix_plist(Vector<uint8_t> &plist, const String &p_binary);
void _make_icon(const Image &p_icon, Vector<uint8_t> &data);
2014-02-10 01:10:30 +00:00
protected:
bool _set(const StringName &p_name, const Variant &p_value);
bool _get(const StringName &p_name, Variant &r_ret) const;
void _get_property_list(List<PropertyInfo> *p_list) const;
2014-02-10 01:10:30 +00:00
public:
virtual String get_name() const { return "Mac OSX"; }
virtual ImageCompression get_image_compression() const { return IMAGE_COMPRESSION_BC; }
virtual Ref<Texture> get_logo() const { return logo; }
virtual bool poll_devices() { return false; }
virtual int get_device_count() const { return 0; }
virtual String get_device_name(int p_device) const { return String(); }
2014-02-10 01:10:30 +00:00
virtual String get_device_info(int p_device) const { return String(); }
virtual Error run(int p_device, int p_flags = 0);
2014-02-10 01:10:30 +00:00
virtual bool requires_password(bool p_debug) const { return false; }
2014-02-10 01:10:30 +00:00
virtual String get_binary_extension() const { return "zip"; }
virtual Error export_project(const String &p_path, bool p_debug, int p_flags = 0);
2014-02-10 01:10:30 +00:00
virtual bool can_export(String *r_error = NULL) const;
2014-02-10 01:10:30 +00:00
EditorExportPlatformOSX();
~EditorExportPlatformOSX();
};
bool EditorExportPlatformOSX::_set(const StringName &p_name, const Variant &p_value) {
String n = p_name;
if (n == "custom_package/debug")
custom_debug_package = p_value;
else if (n == "custom_package/release")
custom_release_package = p_value;
else if (n == "application/name")
app_name = p_value;
else if (n == "application/info")
info = p_value;
else if (n == "application/icon")
icon = p_value;
else if (n == "application/identifier")
identifier = p_value;
else if (n == "application/signature")
signature = p_value;
else if (n == "application/short_version")
short_version = p_value;
else if (n == "application/version")
version = p_value;
else if (n == "application/copyright")
copyright = p_value;
else if (n == "application/bits_mode")
bits_mode = BitsMode(int(p_value));
else if (n == "display/high_res")
high_resolution = p_value;
2014-02-10 01:10:30 +00:00
else
return false;
return true;
}
bool EditorExportPlatformOSX::_get(const StringName &p_name, Variant &r_ret) const {
String n = p_name;
if (n == "custom_package/debug")
r_ret = custom_debug_package;
else if (n == "custom_package/release")
r_ret = custom_release_package;
else if (n == "application/name")
r_ret = app_name;
else if (n == "application/info")
r_ret = info;
else if (n == "application/icon")
r_ret = icon;
else if (n == "application/identifier")
r_ret = identifier;
else if (n == "application/signature")
r_ret = signature;
else if (n == "application/short_version")
r_ret = short_version;
else if (n == "application/version")
r_ret = version;
else if (n == "application/copyright")
r_ret = copyright;
else if (n == "application/bits_mode")
r_ret = bits_mode;
else if (n == "display/high_res")
r_ret = high_resolution;
2014-02-10 01:10:30 +00:00
else
return false;
return true;
}
void EditorExportPlatformOSX::_get_property_list(List<PropertyInfo> *p_list) const {
p_list->push_back(PropertyInfo(Variant::STRING, "custom_package/debug", PROPERTY_HINT_GLOBAL_FILE, "zip"));
p_list->push_back(PropertyInfo(Variant::STRING, "custom_package/release", PROPERTY_HINT_GLOBAL_FILE, "zip"));
p_list->push_back(PropertyInfo(Variant::STRING, "application/name"));
p_list->push_back(PropertyInfo(Variant::STRING, "application/info"));
p_list->push_back(PropertyInfo(Variant::STRING, "application/icon", PROPERTY_HINT_FILE, "png"));
p_list->push_back(PropertyInfo(Variant::STRING, "application/identifier"));
p_list->push_back(PropertyInfo(Variant::STRING, "application/signature"));
p_list->push_back(PropertyInfo(Variant::STRING, "application/short_version"));
p_list->push_back(PropertyInfo(Variant::STRING, "application/version"));
p_list->push_back(PropertyInfo(Variant::STRING, "application/copyright"));
p_list->push_back(PropertyInfo(Variant::INT, "application/bits_mode", PROPERTY_HINT_ENUM, "Fat (32 & 64 bits),64 bits,32 bits"));
p_list->push_back(PropertyInfo(Variant::BOOL, "display/high_res"));
2014-02-10 01:10:30 +00:00
}
void EditorExportPlatformOSX::_make_icon(const Image &p_icon, Vector<uint8_t> &icon) {
2014-02-10 01:10:30 +00:00
Ref<ImageTexture> it = memnew(ImageTexture);
int size = 512;
2014-02-10 01:10:30 +00:00
Vector<uint8_t> data;
data.resize(8);
data[0] = 'i';
data[1] = 'c';
data[2] = 'n';
data[3] = 's';
2014-02-10 01:10:30 +00:00
const char *name[] = { "ic09", "ic08", "ic07", "icp6", "icp5", "icp4" };
int index = 0;
2014-02-10 01:10:30 +00:00
while (size >= 16) {
2014-02-10 01:10:30 +00:00
Image copy = p_icon;
copy.convert(Image::FORMAT_RGBA);
copy.resize(size, size);
2014-02-10 01:10:30 +00:00
it->create_from_image(copy);
String path = EditorSettings::get_singleton()->get_settings_path() + "/tmp/icon.png";
ResourceSaver::save(path, it);
2014-02-10 01:10:30 +00:00
FileAccess *f = FileAccess::open(path, FileAccess::READ);
2014-02-10 01:10:30 +00:00
ERR_FAIL_COND(!f);
int ofs = data.size();
uint32_t len = f->get_len();
data.resize(data.size() + len + 8);
f->get_buffer(&data[ofs + 8], len);
2014-02-10 01:10:30 +00:00
memdelete(f);
len += 8;
len = BSWAP32(len);
copymem(&data[ofs], name[index], 4);
encode_uint32(len, &data[ofs + 4]);
2014-02-10 01:10:30 +00:00
index++;
size /= 2;
2014-02-10 01:10:30 +00:00
}
uint32_t total_len = data.size();
total_len = BSWAP32(total_len);
encode_uint32(total_len, &data[4]);
2014-02-10 01:10:30 +00:00
icon = data;
2014-02-10 01:10:30 +00:00
}
void EditorExportPlatformOSX::_fix_plist(Vector<uint8_t> &plist, const String &p_binary) {
2014-02-10 01:10:30 +00:00
String str;
String strnew;
str.parse_utf8((const char *)plist.ptr(), plist.size());
Vector<String> lines = str.split("\n");
for (int i = 0; i < lines.size(); i++) {
if (lines[i].find("$binary") != -1) {
strnew += lines[i].replace("$binary", p_binary) + "\n";
} else if (lines[i].find("$name") != -1) {
strnew += lines[i].replace("$name", p_binary) + "\n";
} else if (lines[i].find("$info") != -1) {
strnew += lines[i].replace("$info", info) + "\n";
} else if (lines[i].find("$identifier") != -1) {
strnew += lines[i].replace("$identifier", identifier) + "\n";
} else if (lines[i].find("$short_version") != -1) {
strnew += lines[i].replace("$short_version", short_version) + "\n";
} else if (lines[i].find("$version") != -1) {
strnew += lines[i].replace("$version", version) + "\n";
} else if (lines[i].find("$signature") != -1) {
strnew += lines[i].replace("$signature", signature) + "\n";
} else if (lines[i].find("$copyright") != -1) {
strnew += lines[i].replace("$copyright", copyright) + "\n";
} else if (lines[i].find("$highres") != -1) {
strnew += lines[i].replace("$highres", high_resolution ? "<true/>" : "<false/>") + "\n";
2014-02-10 01:10:30 +00:00
} else {
strnew += lines[i] + "\n";
2014-02-10 01:10:30 +00:00
}
}
CharString cs = strnew.utf8();
plist.resize(cs.size());
for (int i = 9; i < cs.size(); i++) {
plist[i] = cs[i];
2014-02-10 01:10:30 +00:00
}
}
Error EditorExportPlatformOSX::export_project(const String &p_path, bool p_debug, int p_flags) {
2014-02-10 01:10:30 +00:00
String src_pkg;
EditorProgress ep("export", "Exporting for OSX", 104);
2014-02-10 01:10:30 +00:00
if (p_debug)
src_pkg = custom_debug_package;
else
src_pkg = custom_release_package;
if (src_pkg == "") {
String err;
src_pkg = find_export_template("osx.zip", &err);
if (src_pkg == "") {
EditorNode::add_io_error(err);
return ERR_FILE_NOT_FOUND;
}
2014-02-10 01:10:30 +00:00
}
FileAccess *src_f = NULL;
2014-02-10 01:10:30 +00:00
zlib_filefunc_def io = zipio_create_io_from_file(&src_f);
ep.step("Creating app", 0);
2014-02-10 01:10:30 +00:00
unzFile pkg = unzOpen2(src_pkg.utf8().get_data(), &io);
if (!pkg) {
EditorNode::add_io_error("Could not find template app to export:\n" + src_pkg);
2014-02-10 01:10:30 +00:00
return ERR_FILE_NOT_FOUND;
}
ERR_FAIL_COND_V(!pkg, ERR_CANT_OPEN);
int ret = unzGoToFirstFile(pkg);
zlib_filefunc_def io2 = io;
FileAccess *dst_f = NULL;
io2.opaque = &dst_f;
zipFile dpkg = zipOpen2(p_path.utf8().get_data(), APPEND_STATUS_CREATE, NULL, &io2);
2014-02-10 01:10:30 +00:00
String binary_to_use = "godot_osx_" + String(p_debug ? "debug" : "release") + ".";
binary_to_use += String(bits_mode == BITS_FAT ? "fat" : bits_mode == BITS_64 ? "64" : "32");
2014-02-10 01:10:30 +00:00
print_line("binary: " + binary_to_use);
2014-02-10 01:10:30 +00:00
String pkg_name;
if (app_name != "")
pkg_name = app_name;
else if (String(Globals::get_singleton()->get("application/name")) != "")
pkg_name = String(Globals::get_singleton()->get("application/name"));
2014-02-10 01:10:30 +00:00
else
pkg_name = "Unnamed";
2014-02-10 01:10:30 +00:00
bool found_binary = false;
while (ret == UNZ_OK) {
2014-02-10 01:10:30 +00:00
//get filename
unz_file_info info;
char fname[16384];
ret = unzGetCurrentFileInfo(pkg, &info, fname, 16384, NULL, 0, NULL, 0);
2014-02-10 01:10:30 +00:00
String file = fname;
2014-02-10 01:10:30 +00:00
print_line("READ: " + file);
2014-02-10 01:10:30 +00:00
Vector<uint8_t> data;
data.resize(info.uncompressed_size);
//read
unzOpenCurrentFile(pkg);
unzReadCurrentFile(pkg, data.ptr(), data.size());
2014-02-10 01:10:30 +00:00
unzCloseCurrentFile(pkg);
//write
file = file.replace_first("osx_template.app/", "");
2014-02-10 01:10:30 +00:00
if (file == "Contents/Info.plist") {
2014-02-10 01:10:30 +00:00
print_line("parse plist");
_fix_plist(data, pkg_name);
2014-02-10 01:10:30 +00:00
}
if (file.begins_with("Contents/MacOS/godot_")) {
if (file != "Contents/MacOS/" + binary_to_use) {
2014-02-10 01:10:30 +00:00
ret = unzGoToNextFile(pkg);
continue; //ignore!
}
found_binary = true;
file = "Contents/MacOS/" + pkg_name;
2014-02-10 01:10:30 +00:00
}
if (file == "Contents/Resources/icon.icns") {
2014-02-10 01:10:30 +00:00
//see if there is an icon
String iconpath = Globals::get_singleton()->get("application/icon");
print_line("icon? " + iconpath);
if (iconpath != "") {
2014-02-10 01:10:30 +00:00
Image icon;
icon.load(iconpath);
if (!icon.empty()) {
print_line("loaded?");
_make_icon(icon, data);
2014-02-10 01:10:30 +00:00
}
}
//bleh?
}
file = pkg_name + ".app/" + file;
2014-02-10 01:10:30 +00:00
if (data.size() > 0) {
print_line("ADDING: " + file + " size: " + itos(data.size()));
2014-02-10 01:10:30 +00:00
zip_fileinfo fi;
fi.tmz_date.tm_hour = info.tmu_date.tm_hour;
fi.tmz_date.tm_min = info.tmu_date.tm_min;
fi.tmz_date.tm_sec = info.tmu_date.tm_sec;
fi.tmz_date.tm_mon = info.tmu_date.tm_mon;
fi.tmz_date.tm_mday = info.tmu_date.tm_mday;
fi.tmz_date.tm_year = info.tmu_date.tm_year;
fi.dosDate = info.dosDate;
fi.internal_fa = info.internal_fa;
fi.external_fa = info.external_fa;
2014-02-10 01:10:30 +00:00
int err = zipOpenNewFileInZip(dpkg,
file.utf8().get_data(),
&fi,
NULL,
0,
NULL,
0,
NULL,
Z_DEFLATED,
Z_DEFAULT_COMPRESSION);
print_line("OPEN ERR: " + itos(err));
err = zipWriteInFileInZip(dpkg, data.ptr(), data.size());
print_line("WRITE ERR: " + itos(err));
2014-02-10 01:10:30 +00:00
zipCloseFileInZip(dpkg);
}
ret = unzGoToNextFile(pkg);
}
if (!found_binary) {
ERR_PRINTS("Requested template binary '" + binary_to_use + "' not found. It might be missing from your template archive.");
zipClose(dpkg, NULL);
unzClose(pkg);
return ERR_FILE_NOT_FOUND;
}
ep.step("Making PKG", 1);
2014-02-10 01:10:30 +00:00
String pack_path = EditorSettings::get_singleton()->get_settings_path() + "/tmp/data.pck";
FileAccess *pfs = FileAccess::open(pack_path, FileAccess::WRITE);
2014-02-10 01:10:30 +00:00
Error err = save_pack(pfs);
memdelete(pfs);
if (err) {
zipClose(dpkg, NULL);
2014-02-10 01:10:30 +00:00
unzClose(pkg);
return err;
}
{
//write datapack
int err = zipOpenNewFileInZip(dpkg,
(pkg_name + ".app/Contents/Resources/data.pck").utf8().get_data(),
NULL,
NULL,
0,
NULL,
0,
NULL,
Z_DEFLATED,
Z_DEFAULT_COMPRESSION);
FileAccess *pf = FileAccess::open(pack_path, FileAccess::READ);
ERR_FAIL_COND_V(!pf, ERR_CANT_OPEN);
2014-02-10 01:10:30 +00:00
const int BSIZE = 16384;
uint8_t buf[BSIZE];
while (true) {
2014-02-10 01:10:30 +00:00
int r = pf->get_buffer(buf, BSIZE);
if (r <= 0)
2014-02-10 01:10:30 +00:00
break;
zipWriteInFileInZip(dpkg, buf, r);
2014-02-10 01:10:30 +00:00
}
zipCloseFileInZip(dpkg);
memdelete(pf);
}
zipClose(dpkg, NULL);
2014-02-10 01:10:30 +00:00
unzClose(pkg);
return OK;
}
Error EditorExportPlatformOSX::run(int p_device, int p_flags) {
2014-02-10 01:10:30 +00:00
return OK;
}
EditorExportPlatformOSX::EditorExportPlatformOSX() {
Image img(_osx_logo);
logo = Ref<ImageTexture>(memnew(ImageTexture));
2014-02-10 01:10:30 +00:00
logo->create_from_image(img);
info = "Made with Godot Engine";
identifier = "org.godotengine.macgame";
signature = "godotmacgame";
short_version = "1.0";
version = "1.0";
bits_mode = BITS_FAT;
high_resolution = false;
2014-02-10 01:10:30 +00:00
}
bool EditorExportPlatformOSX::can_export(String *r_error) const {
bool valid = true;
2014-02-10 01:10:30 +00:00
String err;
if (!exists_export_template("osx.zip")) {
valid = false;
err += "No export templates found.\nDownload and install export templates.\n";
2014-02-10 01:10:30 +00:00
}
if (custom_debug_package != "" && !FileAccess::exists(custom_debug_package)) {
valid = false;
err += "Custom debug package not found.\n";
2014-02-10 01:10:30 +00:00
}
if (custom_release_package != "" && !FileAccess::exists(custom_release_package)) {
valid = false;
err += "Custom release package not found.\n";
2014-02-10 01:10:30 +00:00
}
if (r_error)
*r_error = err;
2014-02-10 01:10:30 +00:00
return valid;
}
EditorExportPlatformOSX::~EditorExportPlatformOSX() {
}
void register_osx_exporter() {
Ref<EditorExportPlatformOSX> exporter = Ref<EditorExportPlatformOSX>(memnew(EditorExportPlatformOSX));
2014-02-10 01:10:30 +00:00
EditorImportExport::get_singleton()->add_export_platform(exporter);
}