godot/platform/osx/export/export.cpp
est31 15f6d3cebf Add way to look for templates at system wide level too
Useful for everybody wanting to package godot.
Fixes #1026.

-> Retain the old behaviour: path in error msg only when exporting.
-> User templates override system templates
2015-11-30 01:36:08 +01:00

508 lines
12 KiB
C++

#include "version.h"
#include "export.h"
#include "tools/editor/editor_settings.h"
#include "tools/editor/editor_import_export.h"
#include "tools/editor/editor_node.h"
#include "io/zip_io.h"
#include "io/marshalls.h"
#include "io/resource_saver.h"
#include "globals.h"
#include "os/file_access.h"
#include "os/os.h"
#include "platform/osx/logo.h"
#include "string.h"
class EditorExportPlatformOSX : public EditorExportPlatform {
OBJ_TYPE( EditorExportPlatformOSX,EditorExportPlatform );
String custom_release_package;
String custom_debug_package;
int version_code;
String app_name;
String info;
String icon;
String identifier;
String short_version;
String version;
String signature;
String copyright;
bool use64;
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);
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;
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(); }
virtual String get_device_info(int p_device) const { return String(); }
virtual Error run(int p_device,int p_flags=0);
virtual bool requieres_password(bool p_debug) const { return false; }
virtual String get_binary_extension() const { return "zip"; }
virtual Error export_project(const String& p_path,bool p_debug,int p_flags=0);
virtual bool can_export(String *r_error=NULL) const;
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/64_bits")
use64=p_value;
else if (n=="display/high_res")
high_resolution=p_value;
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/64_bits")
r_ret=use64;
else if (n=="display/high_res")
r_ret=high_resolution;
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::BOOL, "application/64_bits") );
p_list->push_back( PropertyInfo( Variant::BOOL, "display/high_res") );
//p_list->push_back( PropertyInfo( Variant::INT, "resources/pack_mode", PROPERTY_HINT_ENUM,"Copy,Single Exec.,Pack (.pck),Bundles (Optical)"));
}
void EditorExportPlatformOSX::_make_icon(const Image& p_icon,Vector<uint8_t>& icon) {
Ref<ImageTexture> it = memnew( ImageTexture );
int size=512;
Vector<uint8_t> data;
data.resize(8);
data[0]='i';
data[1]='c';
data[2]='n';
data[3]='s';
const char *name[]={"ic09","ic08","ic07","icp6","icp5","icp4"};
int index=0;
while(size>=16) {
Image copy = p_icon;
copy.convert(Image::FORMAT_RGBA);
copy.resize(size,size);
it->create_from_image(copy);
String path = EditorSettings::get_singleton()->get_settings_path()+"/tmp/icon.png";
ResourceSaver::save(path,it);
FileAccess *f = FileAccess::open(path,FileAccess::READ);
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);
memdelete(f);
len+=8;
len=BSWAP32(len);
copymem(&data[ofs],name[index],4);
encode_uint32(len,&data[ofs+4]);
index++;
size/=2;
}
uint32_t total_len = data.size();
total_len = BSWAP32(total_len);
encode_uint32(total_len,&data[4]);
icon=data;
}
void EditorExportPlatformOSX::_fix_plist(Vector<uint8_t>& plist,const String& p_binary) {
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";
} else {
strnew+=lines[i]+"\n";
}
}
CharString cs = strnew.utf8();
plist.resize(cs.size());
for(int i=9;i<cs.size();i++) {
plist[i]=cs[i];
}
}
Error EditorExportPlatformOSX::export_project(const String& p_path, bool p_debug, int p_flags) {
String src_pkg;
EditorProgress ep("export","Exporting for OSX",104);
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;
}
}
FileAccess *src_f=NULL;
zlib_filefunc_def io = zipio_create_io_from_file(&src_f);
ep.step("Creating app",0);
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);
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);
String binary_to_use="godot_osx_"+String(p_debug?"debug":"release")+"."+String(use64?"64":"32");
print_line("binary: "+binary_to_use);
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"));
else
pkg_name="Unnamed";
while(ret==UNZ_OK) {
//get filename
unz_file_info info;
char fname[16384];
ret = unzGetCurrentFileInfo(pkg,&info,fname,16384,NULL,0,NULL,0);
String file=fname;
print_line("READ: "+file);
Vector<uint8_t> data;
data.resize(info.uncompressed_size);
//read
unzOpenCurrentFile(pkg);
unzReadCurrentFile(pkg,data.ptr(),data.size());
unzCloseCurrentFile(pkg);
//write
file = file.replace_first("osx_template.app/","");
if (file=="Contents/Info.plist") {
print_line("parse plist");
_fix_plist(data,pkg_name);
}
if (file.begins_with("Contents/MacOS/godot_")) {
if (file!="Contents/MacOS/"+binary_to_use) {
ret = unzGoToNextFile(pkg);
continue; //ignore!
}
file="Contents/MacOS/"+pkg_name;
}
if (file=="Contents/Resources/icon.icns") {
//see if there is an icon
String iconpath = Globals::get_singleton()->get("application/icon");
print_line("icon? "+iconpath);
if (iconpath!="") {
Image icon;
icon.load(iconpath);
if (!icon.empty()) {
print_line("loaded?");
_make_icon(icon,data);
}
}
//bleh?
}
file=pkg_name+".app/"+file;
if (data.size()>0) {
print_line("ADDING: "+file+" size: "+itos(data.size()));
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;
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));
zipCloseFileInZip(dpkg);
}
ret = unzGoToNextFile(pkg);
}
ep.step("Making PKG",1);
String pack_path=EditorSettings::get_singleton()->get_settings_path()+"/tmp/data.pck";
FileAccess *pfs = FileAccess::open(pack_path,FileAccess::WRITE);
Error err = save_pack(pfs);
memdelete(pfs);
if (err) {
zipClose(dpkg,NULL);
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);
const int BSIZE = 16384;
uint8_t buf[BSIZE];
while(true) {
int r = pf->get_buffer(buf,BSIZE);
if (r<=0)
break;
zipWriteInFileInZip(dpkg,buf,r);
}
zipCloseFileInZip(dpkg);
memdelete(pf);
}
zipClose(dpkg,NULL);
unzClose(pkg);
return OK;
}
Error EditorExportPlatformOSX::run(int p_device, int p_flags) {
return OK;
}
EditorExportPlatformOSX::EditorExportPlatformOSX() {
Image img( _osx_logo );
logo = Ref<ImageTexture>( memnew( ImageTexture ));
logo->create_from_image(img);
info="This Game is Nice";
identifier="com.godot.macgame";
signature="godotmacgame";
short_version="1.0";
version="1.0";
use64=false;
high_resolution=false;
}
bool EditorExportPlatformOSX::can_export(String *r_error) const {
bool valid=true;
String err;
if (!exists_export_template("osx.zip")) {
valid=false;
err+="No export templates found.\nDownload and install export templates.\n";
}
if (custom_debug_package!="" && !FileAccess::exists(custom_debug_package)) {
valid=false;
err+="Custom debug package not found.\n";
}
if (custom_release_package!="" && !FileAccess::exists(custom_release_package)) {
valid=false;
err+="Custom release package not found.\n";
}
if (r_error)
*r_error=err;
return valid;
}
EditorExportPlatformOSX::~EditorExportPlatformOSX() {
}
void register_osx_exporter() {
Ref<EditorExportPlatformOSX> exporter = Ref<EditorExportPlatformOSX>( memnew(EditorExportPlatformOSX) );
EditorImportExport::get_singleton()->add_export_platform(exporter);
}