/*************************************************************************/ /* project_manager.cpp */ /*************************************************************************/ /* This file is part of: */ /* GODOT ENGINE */ /* https://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. */ /*************************************************************************/ #include "project_manager.h" #include "editor_settings.h" #include "io/config_file.h" #include "os/dir_access.h" #include "os/file_access.h" #include "os/keyboard.h" #include "os/os.h" #include "scene/gui/separator.h" #include "scene/gui/tool_button.h" #include "version.h" #include "io/stream_peer_ssl.h" #include "scene/gui/center_container.h" #include "scene/gui/line_edit.h" #include "scene/gui/panel_container.h" #include "io/resource_saver.h" #include "scene/gui/margin_container.h" #include "scene/gui/texture_frame.h" #include "editor_initialize_ssl.h" #include "editor_scale.h" #include "editor_themes.h" #include "io/zip_io.h" class NewProjectDialog : public ConfirmationDialog { OBJ_TYPE(NewProjectDialog, ConfirmationDialog); public: enum Mode { MODE_NEW, MODE_IMPORT, MODE_INSTALL }; private: Mode mode; Label *pp, *pn; Label *error; LineEdit *project_path; LineEdit *project_name; FileDialog *fdialog; String zip_path; String zip_title; AcceptDialog *dialog_error; String _test_path() { error->set_text(""); get_ok()->set_disabled(true); DirAccess *d = DirAccess::create(DirAccess::ACCESS_FILESYSTEM); String valid_path; if (d->change_dir(project_path->get_text()) == OK) { valid_path = project_path->get_text(); } else if (d->change_dir(project_path->get_text().strip_edges()) == OK) { valid_path = project_path->get_text().strip_edges(); } if (valid_path == "") { error->set_text(TTR("Invalid project path, the path must exist!")); memdelete(d); return ""; } if (mode != MODE_IMPORT) { if (d->file_exists("engine.cfg")) { error->set_text(TTR("Invalid project path, engine.cfg must not exist.")); memdelete(d); return ""; } } else { if (valid_path != "" && !d->file_exists("engine.cfg")) { error->set_text(TTR("Invalid project path, engine.cfg must exist.")); memdelete(d); return ""; } } memdelete(d); get_ok()->set_disabled(false); return valid_path; } void _path_text_changed(const String &p_path) { String sp = _test_path(); if (sp != "") { sp = sp.replace("\\", "/"); int lidx = sp.find_last("/"); if (lidx != -1) { sp = sp.substr(lidx + 1, sp.length()); } if (sp == "" && mode == MODE_IMPORT) sp = TTR("Imported Project"); project_name->set_text(sp); } } void _file_selected(const String &p_path) { String p = p_path; if (mode == MODE_IMPORT) { if (p.ends_with("engine.cfg")) { p = p.get_base_dir(); } } String sp = p.simplify_path(); project_path->set_text(sp); _path_text_changed(sp); get_ok()->call_deferred("grab_focus"); } void _path_selected(const String &p_path) { String p = p_path; String sp = p.simplify_path(); project_path->set_text(sp); _path_text_changed(sp); get_ok()->call_deferred("grab_focus"); } void _browse_path() { if (mode == MODE_IMPORT) { fdialog->set_mode(FileDialog::MODE_OPEN_FILE); fdialog->clear_filters(); fdialog->add_filter("engine.cfg ; " _MKSTR(VERSION_NAME) " Project"); } else { fdialog->set_mode(FileDialog::MODE_OPEN_DIR); } fdialog->popup_centered_ratio(); } void _text_changed(const String &p_text) { _test_path(); } void ok_pressed() { String dir = _test_path(); if (dir == "") { error->set_text(TTR("Invalid project path (changed anything?).")); return; } if (mode == MODE_IMPORT) { // nothing to do } else { if (mode == MODE_NEW) { FileAccess *f = FileAccess::open(dir.plus_file("/engine.cfg"), FileAccess::WRITE); if (!f) { error->set_text(TTR("Couldn't create engine.cfg in project path.")); } else { f->store_line("; Engine configuration file."); f->store_line("; It's best edited using the editor UI and not directly,"); f->store_line("; since the parameters that go here are not all obvious."); f->store_line("; "); f->store_line("; Format: "); f->store_line("; [section] ; section goes between []"); f->store_line("; param=value ; assign values to parameters"); f->store_line("\n"); f->store_line("[application]"); f->store_line("\n"); f->store_line("name=\"" + project_name->get_text() + "\""); f->store_line("icon=\"res://icon.png\""); f->store_line("\n"); f->store_line("[physics_2d]"); f->store_line("\n"); f->store_line("motion_fix_enabled=true"); memdelete(f); ResourceSaver::save(dir.plus_file("/icon.png"), get_icon("DefaultProjectIcon", "EditorIcons")); } } else if (mode == MODE_INSTALL) { FileAccess *src_f = NULL; zlib_filefunc_def io = zipio_create_io_from_file(&src_f); unzFile pkg = unzOpen2(zip_path.utf8().get_data(), &io); if (!pkg) { dialog_error->set_text("Error opening package file, not in zip format."); return; } int ret = unzGoToFirstFile(pkg); Vector failed_files; int idx = 0; while (ret == UNZ_OK) { //get filename unz_file_info info; char fname[16384]; ret = unzGetCurrentFileInfo(pkg, &info, fname, 16384, NULL, 0, NULL, 0); String path = fname; int depth = 1; //stuff from github comes with tag bool skip = false; while (depth > 0) { int pp = path.find("/"); if (pp == -1) { skip = true; break; } path = path.substr(pp + 1, path.length()); depth--; } if (skip || path == String()) { // } else if (path.ends_with("/")) { // a dir path = path.substr(0, path.length() - 1); DirAccess *da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM); da->make_dir(dir.plus_file(path)); memdelete(da); } else { Vector data; data.resize(info.uncompressed_size); //read unzOpenCurrentFile(pkg); unzReadCurrentFile(pkg, data.ptr(), data.size()); unzCloseCurrentFile(pkg); FileAccess *f = FileAccess::open(dir.plus_file(path), FileAccess::WRITE); if (f) { f->store_buffer(data.ptr(), data.size()); memdelete(f); } else { failed_files.push_back(path); } } idx++; ret = unzGoToNextFile(pkg); } unzClose(pkg); if (failed_files.size()) { String msg = TTR("The following files failed extraction from package:") + "\n\n"; for (int i = 0; i < failed_files.size(); i++) { if (i > 15) { msg += "\nAnd " + itos(failed_files.size() - i) + " more files."; break; } msg += failed_files[i] + "\n"; } dialog_error->set_text(msg); dialog_error->popup_centered_minsize(); } else { dialog_error->set_text(TTR("Package Installed Successfully!")); dialog_error->popup_centered_minsize(); } } } dir = dir.replace("\\", "/"); if (dir.ends_with("/")) dir = dir.substr(0, dir.length() - 1); String proj = dir.replace("/", "::"); EditorSettings::get_singleton()->set("projects/" + proj, dir); EditorSettings::get_singleton()->save(); hide(); emit_signal("project_created", dir); } protected: static void _bind_methods() { ObjectTypeDB::bind_method("_browse_path", &NewProjectDialog::_browse_path); ObjectTypeDB::bind_method("_text_changed", &NewProjectDialog::_text_changed); ObjectTypeDB::bind_method("_path_text_changed", &NewProjectDialog::_path_text_changed); ObjectTypeDB::bind_method("_path_selected", &NewProjectDialog::_path_selected); ObjectTypeDB::bind_method("_file_selected", &NewProjectDialog::_file_selected); ADD_SIGNAL(MethodInfo("project_created")); } public: void set_zip_path(const String &p_path) { zip_path = p_path; } void set_zip_title(const String &p_title) { zip_title = p_title; } void set_mode(Mode p_mode) { mode = p_mode; } void show_dialog() { project_path->clear(); project_name->clear(); if (mode == MODE_IMPORT) { set_title(TTR("Import Existing Project")); get_ok()->set_text(TTR("Import")); pp->set_text(TTR("Project Path (Must Exist):")); pn->set_text(TTR("Project Name:")); pn->hide(); project_name->hide(); popup_centered(Size2(500, 125) * EDSCALE); } else if (mode == MODE_NEW) { set_title(TTR("Create New Project")); get_ok()->set_text(TTR("Create")); pp->set_text(TTR("Project Path:")); pn->set_text(TTR("Project Name:")); pn->show(); project_name->show(); popup_centered(Size2(500, 145) * EDSCALE); } else if (mode == MODE_INSTALL) { set_title(TTR("Install Project:") + " " + zip_title); get_ok()->set_text(TTR("Install")); pp->set_text(TTR("Project Path:")); pn->hide(); project_name->hide(); popup_centered(Size2(500, 125) * EDSCALE); } project_path->grab_focus(); _test_path(); } NewProjectDialog() { VBoxContainer *vb = memnew(VBoxContainer); add_child(vb); set_child_rect(vb); Label *l = memnew(Label); l->set_text(TTR("Project Path:")); vb->add_child(l); pp = l; project_path = memnew(LineEdit); MarginContainer *mc = memnew(MarginContainer); vb->add_child(mc); HBoxContainer *pphb = memnew(HBoxContainer); mc->add_child(pphb); pphb->add_child(project_path); project_path->set_h_size_flags(SIZE_EXPAND_FILL); Button *browse = memnew(Button); pphb->add_child(browse); browse->set_text(TTR("Browse")); browse->connect("pressed", this, "_browse_path"); l = memnew(Label); l->set_text(TTR("Project Name:")); l->set_pos(Point2(5, 50)); vb->add_child(l); pn = l; project_name = memnew(LineEdit); mc = memnew(MarginContainer); vb->add_child(mc); mc->add_child(project_name); project_name->set_text(TTR("New Game Project")); l = memnew(Label); l->set_text(TTR("That's a BINGO!")); vb->add_child(l); error = l; l->add_color_override("font_color", Color(1, 0.4, 0.3, 0.8)); l->set_align(Label::ALIGN_CENTER); DirAccess *d = DirAccess::create(DirAccess::ACCESS_FILESYSTEM); project_path->set_text(d->get_current_dir()); memdelete(d); fdialog = memnew(FileDialog); add_child(fdialog); fdialog->set_access(FileDialog::ACCESS_FILESYSTEM); fdialog->set_current_dir(EditorSettings::get_singleton()->get("global/default_project_path")); project_name->connect("text_changed", this, "_text_changed"); project_path->connect("text_changed", this, "_path_text_changed"); fdialog->connect("dir_selected", this, "_path_selected"); fdialog->connect("file_selected", this, "_file_selected"); set_hide_on_ok(false); mode = MODE_NEW; dialog_error = memnew(AcceptDialog); add_child(dialog_error); } }; struct ProjectItem { String project; String path; String conf; uint64_t last_modified; bool favorite; ProjectItem() {} ProjectItem(const String &p_project, const String &p_path, const String &p_conf, uint64_t p_last_modified, bool p_favorite = false) { project = p_project; path = p_path; conf = p_conf; last_modified = p_last_modified; favorite = p_favorite; } _FORCE_INLINE_ bool operator<(const ProjectItem &l) const { return last_modified > l.last_modified; } _FORCE_INLINE_ bool operator==(const ProjectItem &l) const { return project == l.project; } }; void ProjectManager::_notification(int p_what) { if (p_what == NOTIFICATION_ENTER_TREE) { get_tree()->set_editor_hint(true); } else if (p_what == NOTIFICATION_VISIBILITY_CHANGED) { set_process_unhandled_input(is_visible()); } } void ProjectManager::_panel_draw(Node *p_hb) { HBoxContainer *hb = p_hb->cast_to(); hb->draw_line(Point2(0, hb->get_size().y + 1), Point2(hb->get_size().x - 10, hb->get_size().y + 1), get_color("guide_color", "Tree")); if (selected_list.has(hb->get_meta("name"))) { hb->draw_style_box(get_stylebox("selected", "Tree"), Rect2(Point2(), hb->get_size() - Size2(10, 0))); } } void ProjectManager::_update_project_buttons() { for (int i = 0; i < scroll_childs->get_child_count(); i++) { CanvasItem *item = scroll_childs->get_child(i)->cast_to(); item->update(); } bool has_runnable_scene = false; for (Map::Element *E = selected_list.front(); E; E = E->next()) { const String &selected_main = E->get(); if (selected_main == "") continue; has_runnable_scene = true; break; } erase_btn->set_disabled(selected_list.size() < 1); open_btn->set_disabled(selected_list.size() < 1); run_btn->set_disabled(!has_runnable_scene); } void ProjectManager::_panel_input(const InputEvent &p_ev, Node *p_hb) { if (p_ev.type == InputEvent::MOUSE_BUTTON && p_ev.mouse_button.pressed && p_ev.mouse_button.button_index == BUTTON_LEFT) { String clicked = p_hb->get_meta("name"); String clicked_main_scene = p_hb->get_meta("main_scene"); if (p_ev.key.mod.shift && selected_list.size() > 0 && last_clicked != "" && clicked != last_clicked) { int clicked_id = -1; int last_clicked_id = -1; for (int i = 0; i < scroll_childs->get_child_count(); i++) { HBoxContainer *hb = scroll_childs->get_child(i)->cast_to(); if (!hb) continue; if (hb->get_meta("name") == clicked) clicked_id = i; if (hb->get_meta("name") == last_clicked) last_clicked_id = i; } if (last_clicked_id != -1 && clicked_id != -1) { int min = clicked_id < last_clicked_id ? clicked_id : last_clicked_id; int max = clicked_id > last_clicked_id ? clicked_id : last_clicked_id; for (int i = 0; i < scroll_childs->get_child_count(); ++i) { HBoxContainer *hb = scroll_childs->get_child(i)->cast_to(); if (!hb) continue; if (i != clicked_id && (i < min || i > max) && !p_ev.key.mod.control) { selected_list.erase(hb->get_meta("name")); } else if (i >= min && i <= max) { selected_list.insert(hb->get_meta("name"), hb->get_meta("main_scene")); } } } } else if (selected_list.has(clicked) && p_ev.key.mod.control) { selected_list.erase(clicked); } else { last_clicked = clicked; if (p_ev.key.mod.control || selected_list.size() == 0) { selected_list.insert(clicked, clicked_main_scene); } else { selected_list.clear(); selected_list.insert(clicked, clicked_main_scene); } } _update_project_buttons(); if (p_ev.mouse_button.doubleclick) _open_project(); //open if doubleclicked } } void ProjectManager::_unhandled_input(const InputEvent &p_ev) { if (p_ev.type == InputEvent::KEY) { const InputEventKey &k = p_ev.key; if (!k.pressed) return; bool scancode_handled = true; switch (k.scancode) { case KEY_RETURN: { _open_project(); } break; case KEY_HOME: { for (int i = 0; i < scroll_childs->get_child_count(); i++) { HBoxContainer *hb = scroll_childs->get_child(i)->cast_to(); if (hb) { selected_list.clear(); selected_list.insert(hb->get_meta("name"), hb->get_meta("main_scene")); scroll->set_v_scroll(0); _update_project_buttons(); break; } } } break; case KEY_END: { for (int i = scroll_childs->get_child_count() - 1; i >= 0; i--) { HBoxContainer *hb = scroll_childs->get_child(i)->cast_to(); if (hb) { selected_list.clear(); selected_list.insert(hb->get_meta("name"), hb->get_meta("main_scene")); scroll->set_v_scroll(scroll_childs->get_size().y); _update_project_buttons(); break; } } } break; case KEY_UP: { if (k.mod.shift) break; if (selected_list.size()) { bool found = false; for (int i = scroll_childs->get_child_count() - 1; i >= 0; i--) { HBoxContainer *hb = scroll_childs->get_child(i)->cast_to(); if (!hb) continue; String current = hb->get_meta("name"); if (found) { selected_list.clear(); selected_list.insert(current, hb->get_meta("main_scene")); int offset_diff = scroll->get_v_scroll() - hb->get_pos().y; if (offset_diff > 0) scroll->set_v_scroll(scroll->get_v_scroll() - offset_diff); _update_project_buttons(); break; } else if (current == selected_list.back()->key()) { found = true; } } break; } // else fallthrough to key_down } case KEY_DOWN: { if (k.mod.shift) break; bool found = selected_list.empty(); for (int i = 0; i < scroll_childs->get_child_count(); i++) { HBoxContainer *hb = scroll_childs->get_child(i)->cast_to(); if (!hb) continue; String current = hb->get_meta("name"); if (found) { selected_list.clear(); selected_list.insert(current, hb->get_meta("main_scene")); int last_y_visible = scroll->get_v_scroll() + scroll->get_size().y; int offset_diff = (hb->get_pos().y + hb->get_size().y) - last_y_visible; if (offset_diff > 0) scroll->set_v_scroll(scroll->get_v_scroll() + offset_diff); _update_project_buttons(); break; } else if (current == selected_list.back()->key()) { found = true; } } } break; case KEY_F: { if (k.mod.command) this->project_filter->search_box->grab_focus(); else scancode_handled = false; } break; default: { scancode_handled = false; } break; } if (scancode_handled) { accept_event(); } } } void ProjectManager::_favorite_pressed(Node *p_hb) { String clicked = p_hb->get_meta("name"); bool favorite = !p_hb->get_meta("favorite"); String proj = clicked.replace(":::", ":/"); proj = proj.replace("::", "/"); if (favorite) { EditorSettings::get_singleton()->set("favorite_projects/" + clicked, proj); } else { EditorSettings::get_singleton()->erase("favorite_projects/" + clicked); } EditorSettings::get_singleton()->save(); call_deferred("_load_recent_projects"); } void ProjectManager::_load_recent_projects() { ProjectListFilter::FilterOption filter_option = project_filter->get_filter_option(); String search_term = project_filter->get_search_term(); while (scroll_childs->get_child_count() > 0) { memdelete(scroll_childs->get_child(0)); } Map selected_list_copy = selected_list; List properties; EditorSettings::get_singleton()->get_property_list(&properties); Color font_color = get_color("font_color", "Tree"); List projects; List favorite_projects; for (List::Element *E = properties.front(); E; E = E->next()) { String _name = E->get().name; if (!_name.begins_with("projects/") && !_name.begins_with("favorite_projects/")) continue; String path = EditorSettings::get_singleton()->get(_name); if (filter_option == ProjectListFilter::FILTER_PATH && search_term != "" && path.findn(search_term) == -1) continue; String project = _name.get_slice("/", 1); String conf = path.plus_file("engine.cfg"); bool favorite = (_name.begins_with("favorite_projects/")) ? true : false; uint64_t last_modified = 0; if (FileAccess::exists(conf)) { last_modified = FileAccess::get_modified_time(conf); String fscache = path.plus_file(".fscache"); if (FileAccess::exists(fscache)) { uint64_t cache_modified = FileAccess::get_modified_time(fscache); if (cache_modified > last_modified) last_modified = cache_modified; } ProjectItem item(project, path, conf, last_modified, favorite); if (favorite) favorite_projects.push_back(item); else projects.push_back(item); } else { //project doesn't exist on disk but it's in the XML settings file EditorSettings::get_singleton()->erase(_name); //remove it } } projects.sort(); favorite_projects.sort(); for (List::Element *E = projects.front(); E;) { List::Element *next = E->next(); if (favorite_projects.find(E->get()) != NULL) projects.erase(E->get()); E = next; } for (List::Element *E = favorite_projects.back(); E; E = E->prev()) { projects.push_front(E->get()); } Ref favorite_icon = get_icon("Favorites", "EditorIcons"); for (List::Element *E = projects.front(); E; E = E->next()) { ProjectItem &item = E->get(); String project = item.project; String path = item.path; String conf = item.conf; bool is_favorite = item.favorite; Ref cf = memnew(ConfigFile); Error err = cf->load(conf); ERR_CONTINUE(err != OK); String project_name = TTR("Unnamed Project"); if (cf->has_section_key("application", "name")) { project_name = static_cast(cf->get_value("application", "name")).xml_unescape(); } if (filter_option == ProjectListFilter::FILTER_NAME && search_term != "" && project_name.findn(search_term) == -1) continue; Ref icon; if (cf->has_section_key("application", "icon")) { String appicon = cf->get_value("application", "icon"); if (appicon != "") { Image img; Error err = img.load(appicon.replace_first("res://", path + "/")); if (err == OK) { img.resize(64, 64); Ref it = memnew(ImageTexture); it->create_from_image(img); icon = it; } } } if (icon.is_null()) { icon = get_icon("DefaultProjectIcon", "EditorIcons"); } String main_scene; if (cf->has_section_key("application", "main_scene")) { main_scene = cf->get_value("application", "main_scene"); } selected_list_copy.erase(project); HBoxContainer *hb = memnew(HBoxContainer); hb->set_meta("name", project); hb->set_meta("main_scene", main_scene); hb->set_meta("favorite", is_favorite); hb->connect("draw", this, "_panel_draw", varray(hb)); hb->connect("input_event", this, "_panel_input", varray(hb)); VBoxContainer *favorite_box = memnew(VBoxContainer); TextureButton *favorite = memnew(TextureButton); favorite->set_normal_texture(favorite_icon); if (!is_favorite) favorite->set_opacity(0.2); favorite->set_v_size_flags(SIZE_EXPAND); favorite->connect("pressed", this, "_favorite_pressed", varray(hb)); favorite_box->add_child(favorite); hb->add_child(favorite_box); TextureFrame *tf = memnew(TextureFrame); tf->set_texture(icon); hb->add_child(tf); VBoxContainer *vb = memnew(VBoxContainer); vb->set_name("project"); vb->set_h_size_flags(SIZE_EXPAND_FILL); hb->add_child(vb); Control *ec = memnew(Control); ec->set_custom_minimum_size(Size2(0, 1)); vb->add_child(ec); Label *title = memnew(Label(project_name)); title->add_font_override("font", get_font("large", "Fonts")); title->add_color_override("font_color", font_color); title->set_clip_text(true); vb->add_child(title); Label *fpath = memnew(Label(path)); fpath->set_name("path"); vb->add_child(fpath); fpath->set_opacity(0.5); fpath->add_color_override("font_color", font_color); fpath->set_clip_text(true); scroll_childs->add_child(hb); } for (Map::Element *E = selected_list_copy.front(); E; E = E->next()) { String key = E->key(); selected_list.erase(key); } scroll->set_v_scroll(0); _update_project_buttons(); EditorSettings::get_singleton()->save(); tabs->set_current_tab(0); } void ProjectManager::_on_project_created(const String &dir) { bool has_already = false; for (int i = 0; i < scroll_childs->get_child_count(); i++) { HBoxContainer *hb = scroll_childs->get_child(i)->cast_to(); Label *fpath = hb->get_node(NodePath("project/path"))->cast_to