1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629 |
- /**************************************************************************/
- /* editor_file_system.cpp */
- /**************************************************************************/
- /* This file is part of: */
- /* GODOT ENGINE */
- /* https://godotengine.org */
- /**************************************************************************/
- /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
- /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
- /* */
- /* 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 "editor_file_system.h"
- #include "core/config/project_settings.h"
- #include "core/extension/gdextension_manager.h"
- #include "core/io/file_access.h"
- #include "core/io/resource_importer.h"
- #include "core/io/resource_loader.h"
- #include "core/io/resource_saver.h"
- #include "core/object/worker_thread_pool.h"
- #include "core/os/os.h"
- #include "core/variant/variant_parser.h"
- #include "editor/editor_help.h"
- #include "editor/editor_node.h"
- #include "editor/editor_paths.h"
- #include "editor/editor_resource_preview.h"
- #include "editor/editor_settings.h"
- EditorFileSystem *EditorFileSystem::singleton = nullptr;
- //the name is the version, to keep compatibility with different versions of Godot
- #define CACHE_FILE_NAME "filesystem_cache8"
- void EditorFileSystemDirectory::sort_files() {
- files.sort_custom<FileInfoSort>();
- }
- int EditorFileSystemDirectory::find_file_index(const String &p_file) const {
- for (int i = 0; i < files.size(); i++) {
- if (files[i]->file == p_file) {
- return i;
- }
- }
- return -1;
- }
- int EditorFileSystemDirectory::find_dir_index(const String &p_dir) const {
- for (int i = 0; i < subdirs.size(); i++) {
- if (subdirs[i]->name == p_dir) {
- return i;
- }
- }
- return -1;
- }
- void EditorFileSystemDirectory::force_update() {
- // We set modified_time to 0 to force `EditorFileSystem::_scan_fs_changes` to search changes in the directory
- modified_time = 0;
- }
- int EditorFileSystemDirectory::get_subdir_count() const {
- return subdirs.size();
- }
- EditorFileSystemDirectory *EditorFileSystemDirectory::get_subdir(int p_idx) {
- ERR_FAIL_INDEX_V(p_idx, subdirs.size(), nullptr);
- return subdirs[p_idx];
- }
- int EditorFileSystemDirectory::get_file_count() const {
- return files.size();
- }
- String EditorFileSystemDirectory::get_file(int p_idx) const {
- ERR_FAIL_INDEX_V(p_idx, files.size(), "");
- return files[p_idx]->file;
- }
- String EditorFileSystemDirectory::get_path() const {
- String p;
- const EditorFileSystemDirectory *d = this;
- while (d->parent) {
- p = d->name.path_join(p);
- d = d->parent;
- }
- return "res://" + p;
- }
- String EditorFileSystemDirectory::get_file_path(int p_idx) const {
- String file = get_file(p_idx);
- const EditorFileSystemDirectory *d = this;
- while (d->parent) {
- file = d->name.path_join(file);
- d = d->parent;
- }
- return "res://" + file;
- }
- Vector<String> EditorFileSystemDirectory::get_file_deps(int p_idx) const {
- ERR_FAIL_INDEX_V(p_idx, files.size(), Vector<String>());
- Vector<String> deps;
- for (int i = 0; i < files[p_idx]->deps.size(); i++) {
- String dep = files[p_idx]->deps[i];
- int sep_idx = dep.find("::"); //may contain type information, unwanted
- if (sep_idx != -1) {
- dep = dep.substr(0, sep_idx);
- }
- ResourceUID::ID uid = ResourceUID::get_singleton()->text_to_id(dep);
- if (uid != ResourceUID::INVALID_ID) {
- //return proper dependency resource from uid
- if (ResourceUID::get_singleton()->has_id(uid)) {
- dep = ResourceUID::get_singleton()->get_id_path(uid);
- } else {
- continue;
- }
- }
- deps.push_back(dep);
- }
- return deps;
- }
- bool EditorFileSystemDirectory::get_file_import_is_valid(int p_idx) const {
- ERR_FAIL_INDEX_V(p_idx, files.size(), false);
- return files[p_idx]->import_valid;
- }
- uint64_t EditorFileSystemDirectory::get_file_modified_time(int p_idx) const {
- ERR_FAIL_INDEX_V(p_idx, files.size(), 0);
- return files[p_idx]->modified_time;
- }
- String EditorFileSystemDirectory::get_file_script_class_name(int p_idx) const {
- return files[p_idx]->script_class_name;
- }
- String EditorFileSystemDirectory::get_file_script_class_extends(int p_idx) const {
- return files[p_idx]->script_class_extends;
- }
- String EditorFileSystemDirectory::get_file_script_class_icon_path(int p_idx) const {
- return files[p_idx]->script_class_icon_path;
- }
- StringName EditorFileSystemDirectory::get_file_type(int p_idx) const {
- ERR_FAIL_INDEX_V(p_idx, files.size(), "");
- return files[p_idx]->type;
- }
- StringName EditorFileSystemDirectory::get_file_resource_script_class(int p_idx) const {
- ERR_FAIL_INDEX_V(p_idx, files.size(), "");
- return files[p_idx]->resource_script_class;
- }
- String EditorFileSystemDirectory::get_name() {
- return name;
- }
- EditorFileSystemDirectory *EditorFileSystemDirectory::get_parent() {
- return parent;
- }
- void EditorFileSystemDirectory::_bind_methods() {
- ClassDB::bind_method(D_METHOD("get_subdir_count"), &EditorFileSystemDirectory::get_subdir_count);
- ClassDB::bind_method(D_METHOD("get_subdir", "idx"), &EditorFileSystemDirectory::get_subdir);
- ClassDB::bind_method(D_METHOD("get_file_count"), &EditorFileSystemDirectory::get_file_count);
- ClassDB::bind_method(D_METHOD("get_file", "idx"), &EditorFileSystemDirectory::get_file);
- ClassDB::bind_method(D_METHOD("get_file_path", "idx"), &EditorFileSystemDirectory::get_file_path);
- ClassDB::bind_method(D_METHOD("get_file_type", "idx"), &EditorFileSystemDirectory::get_file_type);
- ClassDB::bind_method(D_METHOD("get_file_script_class_name", "idx"), &EditorFileSystemDirectory::get_file_script_class_name);
- ClassDB::bind_method(D_METHOD("get_file_script_class_extends", "idx"), &EditorFileSystemDirectory::get_file_script_class_extends);
- ClassDB::bind_method(D_METHOD("get_file_import_is_valid", "idx"), &EditorFileSystemDirectory::get_file_import_is_valid);
- ClassDB::bind_method(D_METHOD("get_name"), &EditorFileSystemDirectory::get_name);
- ClassDB::bind_method(D_METHOD("get_path"), &EditorFileSystemDirectory::get_path);
- ClassDB::bind_method(D_METHOD("get_parent"), &EditorFileSystemDirectory::get_parent);
- ClassDB::bind_method(D_METHOD("find_file_index", "name"), &EditorFileSystemDirectory::find_file_index);
- ClassDB::bind_method(D_METHOD("find_dir_index", "name"), &EditorFileSystemDirectory::find_dir_index);
- }
- EditorFileSystemDirectory::EditorFileSystemDirectory() {
- modified_time = 0;
- parent = nullptr;
- }
- EditorFileSystemDirectory::~EditorFileSystemDirectory() {
- for (int i = 0; i < files.size(); i++) {
- memdelete(files[i]);
- }
- for (int i = 0; i < subdirs.size(); i++) {
- memdelete(subdirs[i]);
- }
- }
- void EditorFileSystem::_scan_filesystem() {
- ERR_FAIL_COND(!scanning || new_filesystem);
- //read .fscache
- String cpath;
- sources_changed.clear();
- file_cache.clear();
- String project = ProjectSettings::get_singleton()->get_resource_path();
- String fscache = EditorPaths::get_singleton()->get_project_settings_dir().path_join(CACHE_FILE_NAME);
- {
- Ref<FileAccess> f = FileAccess::open(fscache, FileAccess::READ);
- bool first = true;
- if (f.is_valid()) {
- //read the disk cache
- while (!f->eof_reached()) {
- String l = f->get_line().strip_edges();
- if (first) {
- if (first_scan) {
- // only use this on first scan, afterwards it gets ignored
- // this is so on first reimport we synchronize versions, then
- // we don't care until editor restart. This is for usability mainly so
- // your workflow is not killed after changing a setting by forceful reimporting
- // everything there is.
- filesystem_settings_version_for_import = l.strip_edges();
- if (filesystem_settings_version_for_import != ResourceFormatImporter::get_singleton()->get_import_settings_hash()) {
- revalidate_import_files = true;
- }
- }
- first = false;
- continue;
- }
- if (l.is_empty()) {
- continue;
- }
- if (l.begins_with("::")) {
- Vector<String> split = l.split("::");
- ERR_CONTINUE(split.size() != 3);
- String name = split[1];
- cpath = name;
- } else {
- // The last section (deps) may contain the same splitter, so limit the maxsplit to 8 to get the complete deps.
- Vector<String> split = l.split("::", true, 8);
- ERR_CONTINUE(split.size() < 9);
- String name = split[0];
- String file;
- file = name;
- name = cpath.path_join(name);
- FileCache fc;
- fc.type = split[1];
- if (fc.type.find("/") != -1) {
- fc.type = fc.type.get_slice("/", 0);
- fc.resource_script_class = fc.type.get_slice("/", 1);
- }
- fc.uid = split[2].to_int();
- fc.modification_time = split[3].to_int();
- fc.import_modification_time = split[4].to_int();
- fc.import_valid = split[5].to_int() != 0;
- fc.import_group_file = split[6].strip_edges();
- fc.script_class_name = split[7].get_slice("<>", 0);
- fc.script_class_extends = split[7].get_slice("<>", 1);
- fc.script_class_icon_path = split[7].get_slice("<>", 2);
- String deps = split[8].strip_edges();
- if (deps.length()) {
- Vector<String> dp = deps.split("<>");
- for (int i = 0; i < dp.size(); i++) {
- String path = dp[i];
- fc.deps.push_back(path);
- }
- }
- file_cache[name] = fc;
- }
- }
- }
- }
- String update_cache = EditorPaths::get_singleton()->get_project_settings_dir().path_join("filesystem_update4");
- if (FileAccess::exists(update_cache)) {
- {
- Ref<FileAccess> f2 = FileAccess::open(update_cache, FileAccess::READ);
- String l = f2->get_line().strip_edges();
- while (!l.is_empty()) {
- file_cache.erase(l); //erase cache for this, so it gets updated
- l = f2->get_line().strip_edges();
- }
- }
- Ref<DirAccess> d = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
- d->remove(update_cache); //bye bye update cache
- }
- EditorProgressBG scan_progress("efs", "ScanFS", 1000);
- ScanProgress sp;
- sp.low = 0;
- sp.hi = 1;
- sp.progress = &scan_progress;
- new_filesystem = memnew(EditorFileSystemDirectory);
- new_filesystem->parent = nullptr;
- Ref<DirAccess> d = DirAccess::create(DirAccess::ACCESS_RESOURCES);
- d->change_dir("res://");
- _scan_new_dir(new_filesystem, d, sp);
- file_cache.clear(); //clear caches, no longer needed
- if (!first_scan) {
- //on the first scan this is done from the main thread after re-importing
- _save_filesystem_cache();
- }
- scanning = false;
- }
- void EditorFileSystem::_save_filesystem_cache() {
- group_file_cache.clear();
- String fscache = EditorPaths::get_singleton()->get_project_settings_dir().path_join(CACHE_FILE_NAME);
- Ref<FileAccess> f = FileAccess::open(fscache, FileAccess::WRITE);
- ERR_FAIL_COND_MSG(f.is_null(), "Cannot create file '" + fscache + "'. Check user write permissions.");
- f->store_line(filesystem_settings_version_for_import);
- _save_filesystem_cache(filesystem, f);
- }
- void EditorFileSystem::_thread_func(void *_userdata) {
- EditorFileSystem *sd = (EditorFileSystem *)_userdata;
- sd->_scan_filesystem();
- }
- bool EditorFileSystem::_test_for_reimport(const String &p_path, bool p_only_imported_files) {
- if (!reimport_on_missing_imported_files && p_only_imported_files) {
- return false;
- }
- if (!FileAccess::exists(p_path + ".import")) {
- return true;
- }
- if (!ResourceFormatImporter::get_singleton()->are_import_settings_valid(p_path)) {
- //reimport settings are not valid, reimport
- return true;
- }
- Error err;
- Ref<FileAccess> f = FileAccess::open(p_path + ".import", FileAccess::READ, &err);
- if (f.is_null()) { //no import file, do reimport
- return true;
- }
- VariantParser::StreamFile stream;
- stream.f = f;
- String assign;
- Variant value;
- VariantParser::Tag next_tag;
- int lines = 0;
- String error_text;
- List<String> to_check;
- String importer_name;
- String source_file = "";
- String source_md5 = "";
- Vector<String> dest_files;
- String dest_md5 = "";
- int version = 0;
- bool found_uid = false;
- while (true) {
- assign = Variant();
- next_tag.fields.clear();
- next_tag.name = String();
- err = VariantParser::parse_tag_assign_eof(&stream, lines, error_text, next_tag, assign, value, nullptr, true);
- if (err == ERR_FILE_EOF) {
- break;
- } else if (err != OK) {
- ERR_PRINT("ResourceFormatImporter::load - '" + p_path + ".import:" + itos(lines) + "' error '" + error_text + "'.");
- return false; //parse error, try reimport manually (Avoid reimport loop on broken file)
- }
- if (!assign.is_empty()) {
- if (assign.begins_with("path")) {
- to_check.push_back(value);
- } else if (assign == "files") {
- Array fa = value;
- for (int i = 0; i < fa.size(); i++) {
- to_check.push_back(fa[i]);
- }
- } else if (assign == "importer_version") {
- version = value;
- } else if (assign == "importer") {
- importer_name = value;
- } else if (assign == "uid") {
- found_uid = true;
- } else if (!p_only_imported_files) {
- if (assign == "source_file") {
- source_file = value;
- } else if (assign == "dest_files") {
- dest_files = value;
- }
- }
- } else if (next_tag.name != "remap" && next_tag.name != "deps") {
- break;
- }
- }
- if (importer_name == "keep") {
- return false; //keep mode, do not reimport
- }
- if (!found_uid) {
- return true; //UID not found, old format, reimport.
- }
- Ref<ResourceImporter> importer = ResourceFormatImporter::get_singleton()->get_importer_by_name(importer_name);
- if (importer.is_null()) {
- return true; // the importer has possibly changed, try to reimport.
- }
- if (importer->get_format_version() > version) {
- return true; // version changed, reimport
- }
- // Read the md5's from a separate file (so the import parameters aren't dependent on the file version
- String base_path = ResourceFormatImporter::get_singleton()->get_import_base_path(p_path);
- Ref<FileAccess> md5s = FileAccess::open(base_path + ".md5", FileAccess::READ, &err);
- if (md5s.is_null()) { // No md5's stored for this resource
- return true;
- }
- VariantParser::StreamFile md5_stream;
- md5_stream.f = md5s;
- while (true) {
- assign = Variant();
- next_tag.fields.clear();
- next_tag.name = String();
- err = VariantParser::parse_tag_assign_eof(&md5_stream, lines, error_text, next_tag, assign, value, nullptr, true);
- if (err == ERR_FILE_EOF) {
- break;
- } else if (err != OK) {
- ERR_PRINT("ResourceFormatImporter::load - '" + p_path + ".import.md5:" + itos(lines) + "' error '" + error_text + "'.");
- return false; // parse error
- }
- if (!assign.is_empty()) {
- if (!p_only_imported_files) {
- if (assign == "source_md5") {
- source_md5 = value;
- } else if (assign == "dest_md5") {
- dest_md5 = value;
- }
- }
- }
- }
- //imported files are gone, reimport
- for (const String &E : to_check) {
- if (!FileAccess::exists(E)) {
- return true;
- }
- }
- //check source md5 matching
- if (!p_only_imported_files) {
- if (!source_file.is_empty() && source_file != p_path) {
- return true; //file was moved, reimport
- }
- if (source_md5.is_empty()) {
- return true; //lacks md5, so just reimport
- }
- String md5 = FileAccess::get_md5(p_path);
- if (md5 != source_md5) {
- return true;
- }
- if (dest_files.size() && !dest_md5.is_empty()) {
- md5 = FileAccess::get_multiple_md5(dest_files);
- if (md5 != dest_md5) {
- return true;
- }
- }
- }
- return false; //nothing changed
- }
- bool EditorFileSystem::_scan_import_support(Vector<String> reimports) {
- if (import_support_queries.size() == 0) {
- return false;
- }
- HashMap<String, int> import_support_test;
- Vector<bool> import_support_tested;
- import_support_tested.resize(import_support_queries.size());
- for (int i = 0; i < import_support_queries.size(); i++) {
- import_support_tested.write[i] = false;
- if (import_support_queries[i]->is_active()) {
- Vector<String> extensions = import_support_queries[i]->get_file_extensions();
- for (int j = 0; j < extensions.size(); j++) {
- import_support_test.insert(extensions[j], i);
- }
- }
- }
- if (import_support_test.size() == 0) {
- return false; //well nothing to do
- }
- for (int i = 0; i < reimports.size(); i++) {
- HashMap<String, int>::Iterator E = import_support_test.find(reimports[i].get_extension().to_lower());
- if (E) {
- import_support_tested.write[E->value] = true;
- }
- }
- for (int i = 0; i < import_support_tested.size(); i++) {
- if (import_support_tested[i]) {
- if (import_support_queries.write[i]->query()) {
- return true;
- }
- }
- }
- return false;
- }
- bool EditorFileSystem::_update_scan_actions() {
- sources_changed.clear();
- bool fs_changed = false;
- Vector<String> reimports;
- Vector<String> reloads;
- for (const ItemAction &ia : scan_actions) {
- switch (ia.action) {
- case ItemAction::ACTION_NONE: {
- } break;
- case ItemAction::ACTION_DIR_ADD: {
- int idx = 0;
- for (int i = 0; i < ia.dir->subdirs.size(); i++) {
- if (ia.new_dir->name.naturalnocasecmp_to(ia.dir->subdirs[i]->name) < 0) {
- break;
- }
- idx++;
- }
- if (idx == ia.dir->subdirs.size()) {
- ia.dir->subdirs.push_back(ia.new_dir);
- } else {
- ia.dir->subdirs.insert(idx, ia.new_dir);
- }
- fs_changed = true;
- } break;
- case ItemAction::ACTION_DIR_REMOVE: {
- ERR_CONTINUE(!ia.dir->parent);
- ia.dir->parent->subdirs.erase(ia.dir);
- memdelete(ia.dir);
- fs_changed = true;
- } break;
- case ItemAction::ACTION_FILE_ADD: {
- int idx = 0;
- for (int i = 0; i < ia.dir->files.size(); i++) {
- if (ia.new_file->file.naturalnocasecmp_to(ia.dir->files[i]->file) < 0) {
- break;
- }
- idx++;
- }
- if (idx == ia.dir->files.size()) {
- ia.dir->files.push_back(ia.new_file);
- } else {
- ia.dir->files.insert(idx, ia.new_file);
- }
- fs_changed = true;
- if (ClassDB::is_parent_class(ia.new_file->type, SNAME("Script"))) {
- _queue_update_script_class(ia.dir->get_file_path(idx));
- }
- } break;
- case ItemAction::ACTION_FILE_REMOVE: {
- int idx = ia.dir->find_file_index(ia.file);
- ERR_CONTINUE(idx == -1);
- if (ClassDB::is_parent_class(ia.dir->files[idx]->type, SNAME("Script"))) {
- _queue_update_script_class(ia.dir->get_file_path(idx));
- }
- _delete_internal_files(ia.dir->files[idx]->file);
- memdelete(ia.dir->files[idx]);
- ia.dir->files.remove_at(idx);
- fs_changed = true;
- } break;
- case ItemAction::ACTION_FILE_TEST_REIMPORT: {
- int idx = ia.dir->find_file_index(ia.file);
- ERR_CONTINUE(idx == -1);
- String full_path = ia.dir->get_file_path(idx);
- if (_test_for_reimport(full_path, false)) {
- //must reimport
- reimports.push_back(full_path);
- Vector<String> dependencies = _get_dependencies(full_path);
- for (const String &dependency_path : dependencies) {
- if (import_extensions.has(dependency_path.get_extension())) {
- reimports.push_back(dependency_path);
- }
- }
- } else {
- //must not reimport, all was good
- //update modified times, to avoid reimport
- ia.dir->files[idx]->modified_time = FileAccess::get_modified_time(full_path);
- ia.dir->files[idx]->import_modified_time = FileAccess::get_modified_time(full_path + ".import");
- }
- fs_changed = true;
- } break;
- case ItemAction::ACTION_FILE_RELOAD: {
- int idx = ia.dir->find_file_index(ia.file);
- ERR_CONTINUE(idx == -1);
- String full_path = ia.dir->get_file_path(idx);
- if (ClassDB::is_parent_class(ia.dir->files[idx]->type, SNAME("Script"))) {
- _queue_update_script_class(full_path);
- }
- reloads.push_back(full_path);
- } break;
- }
- }
- if (_scan_extensions()) {
- //needs editor restart
- //extensions also may provide filetypes to be imported, so they must run before importing
- if (EditorNode::immediate_confirmation_dialog(TTR("Some extensions need the editor to restart to take effect."), first_scan ? TTR("Restart") : TTR("Save & Restart"), TTR("Continue"))) {
- if (!first_scan) {
- EditorNode::get_singleton()->save_all_scenes();
- }
- EditorNode::get_singleton()->restart_editor();
- //do not import
- return true;
- }
- }
- if (reimports.size()) {
- if (_scan_import_support(reimports)) {
- return true;
- }
- reimport_files(reimports);
- } else {
- //reimport files will update the uid cache file so if nothing was reimported, update it manually
- ResourceUID::get_singleton()->update_cache();
- }
- if (first_scan) {
- //only on first scan this is valid and updated, then settings changed.
- revalidate_import_files = false;
- filesystem_settings_version_for_import = ResourceFormatImporter::get_singleton()->get_import_settings_hash();
- _save_filesystem_cache();
- }
- if (reloads.size()) {
- emit_signal(SNAME("resources_reload"), reloads);
- }
- scan_actions.clear();
- return fs_changed;
- }
- void EditorFileSystem::scan() {
- if (false /*&& bool(Globals::get_singleton()->get("debug/disable_scan"))*/) {
- return;
- }
- if (scanning || scanning_changes || thread.is_started()) {
- return;
- }
- _update_extensions();
- if (!use_threads) {
- scanning = true;
- scan_total = 0;
- _scan_filesystem();
- if (filesystem) {
- memdelete(filesystem);
- }
- //file_type_cache.clear();
- filesystem = new_filesystem;
- new_filesystem = nullptr;
- _update_scan_actions();
- scanning = false;
- _update_pending_script_classes();
- emit_signal(SNAME("filesystem_changed"));
- emit_signal(SNAME("sources_changed"), sources_changed.size() > 0);
- first_scan = false;
- } else {
- ERR_FAIL_COND(thread.is_started());
- set_process(true);
- Thread::Settings s;
- scanning = true;
- scan_total = 0;
- s.priority = Thread::PRIORITY_LOW;
- thread.start(_thread_func, this, s);
- //tree->hide();
- //progress->show();
- }
- }
- void EditorFileSystem::ScanProgress::update(int p_current, int p_total) const {
- float ratio = low + ((hi - low) / p_total) * p_current;
- progress->step(ratio * 1000);
- EditorFileSystem::singleton->scan_total = ratio;
- }
- EditorFileSystem::ScanProgress EditorFileSystem::ScanProgress::get_sub(int p_current, int p_total) const {
- ScanProgress sp = *this;
- float slice = (sp.hi - sp.low) / p_total;
- sp.low += slice * p_current;
- sp.hi = slice;
- return sp;
- }
- void EditorFileSystem::_scan_new_dir(EditorFileSystemDirectory *p_dir, Ref<DirAccess> &da, const ScanProgress &p_progress) {
- List<String> dirs;
- List<String> files;
- String cd = da->get_current_dir();
- p_dir->modified_time = FileAccess::get_modified_time(cd);
- da->list_dir_begin();
- while (true) {
- String f = da->get_next();
- if (f.is_empty()) {
- break;
- }
- if (da->current_is_hidden()) {
- continue;
- }
- if (da->current_is_dir()) {
- if (f.begins_with(".")) { // Ignore special and . / ..
- continue;
- }
- if (_should_skip_directory(cd.path_join(f))) {
- continue;
- }
- dirs.push_back(f);
- } else {
- files.push_back(f);
- }
- }
- da->list_dir_end();
- dirs.sort_custom<NaturalNoCaseComparator>();
- files.sort_custom<NaturalNoCaseComparator>();
- int total = dirs.size() + files.size();
- int idx = 0;
- for (List<String>::Element *E = dirs.front(); E; E = E->next(), idx++) {
- if (da->change_dir(E->get()) == OK) {
- String d = da->get_current_dir();
- if (d == cd || !d.begins_with(cd)) {
- da->change_dir(cd); //avoid recursion
- } else {
- EditorFileSystemDirectory *efd = memnew(EditorFileSystemDirectory);
- efd->parent = p_dir;
- efd->name = E->get();
- _scan_new_dir(efd, da, p_progress.get_sub(idx, total));
- int idx2 = 0;
- for (int i = 0; i < p_dir->subdirs.size(); i++) {
- if (efd->name.naturalnocasecmp_to(p_dir->subdirs[i]->name) < 0) {
- break;
- }
- idx2++;
- }
- if (idx2 == p_dir->subdirs.size()) {
- p_dir->subdirs.push_back(efd);
- } else {
- p_dir->subdirs.insert(idx2, efd);
- }
- da->change_dir("..");
- }
- } else {
- ERR_PRINT("Cannot go into subdir '" + E->get() + "'.");
- }
- p_progress.update(idx, total);
- }
- for (List<String>::Element *E = files.front(); E; E = E->next(), idx++) {
- String ext = E->get().get_extension().to_lower();
- if (!valid_extensions.has(ext)) {
- continue; //invalid
- }
- EditorFileSystemDirectory::FileInfo *fi = memnew(EditorFileSystemDirectory::FileInfo);
- fi->file = E->get();
- String path = cd.path_join(fi->file);
- FileCache *fc = file_cache.getptr(path);
- uint64_t mt = FileAccess::get_modified_time(path);
- if (import_extensions.has(ext)) {
- //is imported
- uint64_t import_mt = 0;
- if (FileAccess::exists(path + ".import")) {
- import_mt = FileAccess::get_modified_time(path + ".import");
- }
- if (fc && fc->modification_time == mt && fc->import_modification_time == import_mt && !_test_for_reimport(path, true)) {
- fi->type = fc->type;
- fi->resource_script_class = fc->resource_script_class;
- fi->uid = fc->uid;
- fi->deps = fc->deps;
- fi->modified_time = fc->modification_time;
- fi->import_modified_time = fc->import_modification_time;
- fi->import_valid = fc->import_valid;
- fi->script_class_name = fc->script_class_name;
- fi->import_group_file = fc->import_group_file;
- fi->script_class_extends = fc->script_class_extends;
- fi->script_class_icon_path = fc->script_class_icon_path;
- if (revalidate_import_files && !ResourceFormatImporter::get_singleton()->are_import_settings_valid(path)) {
- ItemAction ia;
- ia.action = ItemAction::ACTION_FILE_TEST_REIMPORT;
- ia.dir = p_dir;
- ia.file = E->get();
- scan_actions.push_back(ia);
- }
- if (fc->type.is_empty()) {
- fi->type = ResourceLoader::get_resource_type(path);
- fi->resource_script_class = ResourceLoader::get_resource_script_class(path);
- fi->import_group_file = ResourceLoader::get_import_group_file(path);
- //there is also the chance that file type changed due to reimport, must probably check this somehow here (or kind of note it for next time in another file?)
- //note: I think this should not happen any longer..
- }
- if (fc->uid == ResourceUID::INVALID_ID) {
- // imported files should always have a UID, so attempt to fetch it.
- fi->uid = ResourceLoader::get_resource_uid(path);
- }
- } else {
- fi->type = ResourceFormatImporter::get_singleton()->get_resource_type(path);
- fi->uid = ResourceFormatImporter::get_singleton()->get_resource_uid(path);
- fi->import_group_file = ResourceFormatImporter::get_singleton()->get_import_group_file(path);
- fi->script_class_name = _get_global_script_class(fi->type, path, &fi->script_class_extends, &fi->script_class_icon_path);
- fi->modified_time = 0;
- fi->import_modified_time = 0;
- fi->import_valid = fi->type == "TextFile" ? true : ResourceLoader::is_import_valid(path);
- ItemAction ia;
- ia.action = ItemAction::ACTION_FILE_TEST_REIMPORT;
- ia.dir = p_dir;
- ia.file = E->get();
- scan_actions.push_back(ia);
- }
- } else {
- if (fc && fc->modification_time == mt) {
- //not imported, so just update type if changed
- fi->type = fc->type;
- fi->resource_script_class = fc->resource_script_class;
- fi->uid = fc->uid;
- fi->modified_time = fc->modification_time;
- fi->deps = fc->deps;
- fi->import_modified_time = 0;
- fi->import_valid = true;
- fi->script_class_name = fc->script_class_name;
- fi->script_class_extends = fc->script_class_extends;
- fi->script_class_icon_path = fc->script_class_icon_path;
- } else {
- //new or modified time
- fi->type = ResourceLoader::get_resource_type(path);
- fi->resource_script_class = ResourceLoader::get_resource_script_class(path);
- if (fi->type == "" && textfile_extensions.has(ext)) {
- fi->type = "TextFile";
- }
- fi->uid = ResourceLoader::get_resource_uid(path);
- fi->script_class_name = _get_global_script_class(fi->type, path, &fi->script_class_extends, &fi->script_class_icon_path);
- fi->deps = _get_dependencies(path);
- fi->modified_time = mt;
- fi->import_modified_time = 0;
- fi->import_valid = true;
- if (ClassDB::is_parent_class(fi->type, SNAME("Script"))) {
- _queue_update_script_class(path);
- }
- }
- }
- if (fi->uid != ResourceUID::INVALID_ID) {
- if (ResourceUID::get_singleton()->has_id(fi->uid)) {
- ResourceUID::get_singleton()->set_id(fi->uid, path);
- } else {
- ResourceUID::get_singleton()->add_id(fi->uid, path);
- }
- }
- p_dir->files.push_back(fi);
- p_progress.update(idx, total);
- }
- }
- void EditorFileSystem::_scan_fs_changes(EditorFileSystemDirectory *p_dir, const ScanProgress &p_progress) {
- uint64_t current_mtime = FileAccess::get_modified_time(p_dir->get_path());
- bool updated_dir = false;
- String cd = p_dir->get_path();
- if (current_mtime != p_dir->modified_time || using_fat32_or_exfat) {
- updated_dir = true;
- p_dir->modified_time = current_mtime;
- //ooooops, dir changed, see what's going on
- //first mark everything as verified
- for (int i = 0; i < p_dir->files.size(); i++) {
- p_dir->files[i]->verified = false;
- }
- for (int i = 0; i < p_dir->subdirs.size(); i++) {
- p_dir->get_subdir(i)->verified = false;
- }
- //then scan files and directories and check what's different
- Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_RESOURCES);
- Error ret = da->change_dir(cd);
- ERR_FAIL_COND_MSG(ret != OK, "Cannot change to '" + cd + "' folder.");
- da->list_dir_begin();
- while (true) {
- String f = da->get_next();
- if (f.is_empty()) {
- break;
- }
- if (da->current_is_hidden()) {
- continue;
- }
- if (da->current_is_dir()) {
- if (f.begins_with(".")) { // Ignore special and . / ..
- continue;
- }
- int idx = p_dir->find_dir_index(f);
- if (idx == -1) {
- if (_should_skip_directory(cd.path_join(f))) {
- continue;
- }
- EditorFileSystemDirectory *efd = memnew(EditorFileSystemDirectory);
- efd->parent = p_dir;
- efd->name = f;
- Ref<DirAccess> d = DirAccess::create(DirAccess::ACCESS_RESOURCES);
- d->change_dir(cd.path_join(f));
- _scan_new_dir(efd, d, p_progress.get_sub(1, 1));
- ItemAction ia;
- ia.action = ItemAction::ACTION_DIR_ADD;
- ia.dir = p_dir;
- ia.file = f;
- ia.new_dir = efd;
- scan_actions.push_back(ia);
- } else {
- p_dir->subdirs[idx]->verified = true;
- }
- } else {
- String ext = f.get_extension().to_lower();
- if (!valid_extensions.has(ext)) {
- continue; //invalid
- }
- int idx = p_dir->find_file_index(f);
- if (idx == -1) {
- //never seen this file, add actition to add it
- EditorFileSystemDirectory::FileInfo *fi = memnew(EditorFileSystemDirectory::FileInfo);
- fi->file = f;
- String path = cd.path_join(fi->file);
- fi->modified_time = FileAccess::get_modified_time(path);
- fi->import_modified_time = 0;
- fi->type = ResourceLoader::get_resource_type(path);
- fi->resource_script_class = ResourceLoader::get_resource_script_class(path);
- if (fi->type == "" && textfile_extensions.has(ext)) {
- fi->type = "TextFile";
- }
- fi->script_class_name = _get_global_script_class(fi->type, path, &fi->script_class_extends, &fi->script_class_icon_path);
- fi->import_valid = fi->type == "TextFile" ? true : ResourceLoader::is_import_valid(path);
- fi->import_group_file = ResourceLoader::get_import_group_file(path);
- {
- ItemAction ia;
- ia.action = ItemAction::ACTION_FILE_ADD;
- ia.dir = p_dir;
- ia.file = f;
- ia.new_file = fi;
- scan_actions.push_back(ia);
- }
- if (import_extensions.has(ext)) {
- //if it can be imported, and it was added, it needs to be reimported
- ItemAction ia;
- ia.action = ItemAction::ACTION_FILE_TEST_REIMPORT;
- ia.dir = p_dir;
- ia.file = f;
- scan_actions.push_back(ia);
- }
- } else {
- p_dir->files[idx]->verified = true;
- }
- }
- }
- da->list_dir_end();
- }
- for (int i = 0; i < p_dir->files.size(); i++) {
- if (updated_dir && !p_dir->files[i]->verified) {
- //this file was removed, add action to remove it
- ItemAction ia;
- ia.action = ItemAction::ACTION_FILE_REMOVE;
- ia.dir = p_dir;
- ia.file = p_dir->files[i]->file;
- scan_actions.push_back(ia);
- continue;
- }
- String path = cd.path_join(p_dir->files[i]->file);
- if (import_extensions.has(p_dir->files[i]->file.get_extension().to_lower())) {
- //check here if file must be imported or not
- uint64_t mt = FileAccess::get_modified_time(path);
- bool reimport = false;
- if (mt != p_dir->files[i]->modified_time) {
- reimport = true; //it was modified, must be reimported.
- } else if (!FileAccess::exists(path + ".import")) {
- reimport = true; //no .import file, obviously reimport
- } else {
- uint64_t import_mt = FileAccess::get_modified_time(path + ".import");
- if (import_mt != p_dir->files[i]->import_modified_time) {
- reimport = true;
- } else if (_test_for_reimport(path, true)) {
- reimport = true;
- }
- }
- if (reimport) {
- ItemAction ia;
- ia.action = ItemAction::ACTION_FILE_TEST_REIMPORT;
- ia.dir = p_dir;
- ia.file = p_dir->files[i]->file;
- scan_actions.push_back(ia);
- }
- } else if (ResourceCache::has(path)) { //test for potential reload
- uint64_t mt = FileAccess::get_modified_time(path);
- if (mt != p_dir->files[i]->modified_time) {
- p_dir->files[i]->modified_time = mt; //save new time, but test for reload
- ItemAction ia;
- ia.action = ItemAction::ACTION_FILE_RELOAD;
- ia.dir = p_dir;
- ia.file = p_dir->files[i]->file;
- scan_actions.push_back(ia);
- }
- }
- }
- for (int i = 0; i < p_dir->subdirs.size(); i++) {
- if ((updated_dir && !p_dir->subdirs[i]->verified) || _should_skip_directory(p_dir->subdirs[i]->get_path())) {
- //this directory was removed or ignored, add action to remove it
- ItemAction ia;
- ia.action = ItemAction::ACTION_DIR_REMOVE;
- ia.dir = p_dir->subdirs[i];
- scan_actions.push_back(ia);
- continue;
- }
- _scan_fs_changes(p_dir->get_subdir(i), p_progress);
- }
- }
- void EditorFileSystem::_delete_internal_files(String p_file) {
- if (FileAccess::exists(p_file + ".import")) {
- List<String> paths;
- ResourceFormatImporter::get_singleton()->get_internal_resource_path_list(p_file, &paths);
- Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_RESOURCES);
- for (const String &E : paths) {
- da->remove(E);
- }
- da->remove(p_file + ".import");
- }
- }
- void EditorFileSystem::_thread_func_sources(void *_userdata) {
- EditorFileSystem *efs = (EditorFileSystem *)_userdata;
- if (efs->filesystem) {
- EditorProgressBG pr("sources", TTR("ScanSources"), 1000);
- ScanProgress sp;
- sp.progress = ≺
- sp.hi = 1;
- sp.low = 0;
- efs->_scan_fs_changes(efs->filesystem, sp);
- }
- efs->scanning_changes_done = true;
- }
- void EditorFileSystem::scan_changes() {
- if (first_scan || // Prevent a premature changes scan from inhibiting the first full scan
- scanning || scanning_changes || thread.is_started()) {
- scan_changes_pending = true;
- set_process(true);
- return;
- }
- _update_extensions();
- sources_changed.clear();
- scanning_changes = true;
- scanning_changes_done = false;
- if (!use_threads) {
- if (filesystem) {
- EditorProgressBG pr("sources", TTR("ScanSources"), 1000);
- ScanProgress sp;
- sp.progress = ≺
- sp.hi = 1;
- sp.low = 0;
- scan_total = 0;
- _scan_fs_changes(filesystem, sp);
- bool changed = _update_scan_actions();
- _update_pending_script_classes();
- if (changed) {
- emit_signal(SNAME("filesystem_changed"));
- }
- }
- scanning_changes = false;
- scanning_changes_done = true;
- emit_signal(SNAME("sources_changed"), sources_changed.size() > 0);
- } else {
- ERR_FAIL_COND(thread_sources.is_started());
- set_process(true);
- scan_total = 0;
- Thread::Settings s;
- s.priority = Thread::PRIORITY_LOW;
- thread_sources.start(_thread_func_sources, this, s);
- }
- }
- void EditorFileSystem::_notification(int p_what) {
- switch (p_what) {
- case NOTIFICATION_EXIT_TREE: {
- Thread &active_thread = thread.is_started() ? thread : thread_sources;
- if (use_threads && active_thread.is_started()) {
- while (scanning) {
- OS::get_singleton()->delay_usec(1000);
- }
- active_thread.wait_to_finish();
- WARN_PRINT("Scan thread aborted...");
- set_process(false);
- }
- if (filesystem) {
- memdelete(filesystem);
- }
- if (new_filesystem) {
- memdelete(new_filesystem);
- }
- filesystem = nullptr;
- new_filesystem = nullptr;
- } break;
- case NOTIFICATION_PROCESS: {
- if (use_threads) {
- /** This hack exists because of the EditorProgress nature
- * of processing events recursively. This needs to be rewritten
- * at some point entirely, but in the meantime the following
- * hack prevents deadlock on import.
- */
- static bool prevent_recursive_process_hack = false;
- if (prevent_recursive_process_hack) {
- break;
- }
- prevent_recursive_process_hack = true;
- bool done_importing = false;
- if (scanning_changes) {
- if (scanning_changes_done) {
- set_process(false);
- if (thread_sources.is_started()) {
- thread_sources.wait_to_finish();
- }
- bool changed = _update_scan_actions();
- _update_pending_script_classes();
- if (changed) {
- emit_signal(SNAME("filesystem_changed"));
- }
- emit_signal(SNAME("sources_changed"), sources_changed.size() > 0);
- first_scan = false;
- scanning_changes = false; // Changed to false here to prevent recursive triggering of scan thread.
- done_importing = true;
- }
- } else if (!scanning && thread.is_started()) {
- set_process(false);
- if (filesystem) {
- memdelete(filesystem);
- }
- filesystem = new_filesystem;
- new_filesystem = nullptr;
- thread.wait_to_finish();
- _update_scan_actions();
- _update_pending_script_classes();
- emit_signal(SNAME("filesystem_changed"));
- emit_signal(SNAME("sources_changed"), sources_changed.size() > 0);
- first_scan = false;
- }
- if (done_importing && scan_changes_pending) {
- scan_changes_pending = false;
- scan_changes();
- }
- prevent_recursive_process_hack = false;
- }
- } break;
- }
- }
- bool EditorFileSystem::is_scanning() const {
- return scanning || scanning_changes;
- }
- float EditorFileSystem::get_scanning_progress() const {
- return scan_total;
- }
- EditorFileSystemDirectory *EditorFileSystem::get_filesystem() {
- return filesystem;
- }
- void EditorFileSystem::_save_filesystem_cache(EditorFileSystemDirectory *p_dir, Ref<FileAccess> p_file) {
- if (!p_dir) {
- return; //none
- }
- p_file->store_line("::" + p_dir->get_path() + "::" + String::num(p_dir->modified_time));
- for (int i = 0; i < p_dir->files.size(); i++) {
- if (!p_dir->files[i]->import_group_file.is_empty()) {
- group_file_cache.insert(p_dir->files[i]->import_group_file);
- }
- String type = p_dir->files[i]->type;
- if (p_dir->files[i]->resource_script_class) {
- type += "/" + String(p_dir->files[i]->resource_script_class);
- }
- String s = p_dir->files[i]->file + "::" + type + "::" + itos(p_dir->files[i]->uid) + "::" + itos(p_dir->files[i]->modified_time) + "::" + itos(p_dir->files[i]->import_modified_time) + "::" + itos(p_dir->files[i]->import_valid) + "::" + p_dir->files[i]->import_group_file + "::" + p_dir->files[i]->script_class_name + "<>" + p_dir->files[i]->script_class_extends + "<>" + p_dir->files[i]->script_class_icon_path;
- s += "::";
- for (int j = 0; j < p_dir->files[i]->deps.size(); j++) {
- if (j > 0) {
- s += "<>";
- }
- s += p_dir->files[i]->deps[j];
- }
- p_file->store_line(s);
- }
- for (int i = 0; i < p_dir->subdirs.size(); i++) {
- _save_filesystem_cache(p_dir->subdirs[i], p_file);
- }
- }
- bool EditorFileSystem::_find_file(const String &p_file, EditorFileSystemDirectory **r_d, int &r_file_pos) const {
- //todo make faster
- if (!filesystem || scanning) {
- return false;
- }
- String f = ProjectSettings::get_singleton()->localize_path(p_file);
- // Note: Only checks if base directory is case sensitive.
- Ref<DirAccess> dir = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
- bool fs_case_sensitive = dir->is_case_sensitive("res://");
- if (!f.begins_with("res://")) {
- return false;
- }
- f = f.substr(6, f.length());
- f = f.replace("\\", "/");
- Vector<String> path = f.split("/");
- if (path.size() == 0) {
- return false;
- }
- String file = path[path.size() - 1];
- path.resize(path.size() - 1);
- EditorFileSystemDirectory *fs = filesystem;
- for (int i = 0; i < path.size(); i++) {
- if (path[i].begins_with(".")) {
- return false;
- }
- int idx = -1;
- for (int j = 0; j < fs->get_subdir_count(); j++) {
- if (fs_case_sensitive) {
- if (fs->get_subdir(j)->get_name() == path[i]) {
- idx = j;
- break;
- }
- } else {
- if (fs->get_subdir(j)->get_name().to_lower() == path[i].to_lower()) {
- idx = j;
- break;
- }
- }
- }
- if (idx == -1) {
- //does not exist, create i guess?
- EditorFileSystemDirectory *efsd = memnew(EditorFileSystemDirectory);
- efsd->name = path[i];
- efsd->parent = fs;
- int idx2 = 0;
- for (int j = 0; j < fs->get_subdir_count(); j++) {
- if (efsd->name.naturalnocasecmp_to(fs->get_subdir(j)->get_name()) < 0) {
- break;
- }
- idx2++;
- }
- if (idx2 == fs->get_subdir_count()) {
- fs->subdirs.push_back(efsd);
- } else {
- fs->subdirs.insert(idx2, efsd);
- }
- fs = efsd;
- } else {
- fs = fs->get_subdir(idx);
- }
- }
- int cpos = -1;
- for (int i = 0; i < fs->files.size(); i++) {
- if (fs->files[i]->file == file) {
- cpos = i;
- break;
- }
- }
- r_file_pos = cpos;
- *r_d = fs;
- return cpos != -1;
- }
- String EditorFileSystem::get_file_type(const String &p_file) const {
- EditorFileSystemDirectory *fs = nullptr;
- int cpos = -1;
- if (!_find_file(p_file, &fs, cpos)) {
- return "";
- }
- return fs->files[cpos]->type;
- }
- EditorFileSystemDirectory *EditorFileSystem::find_file(const String &p_file, int *r_index) const {
- if (!filesystem || scanning) {
- return nullptr;
- }
- EditorFileSystemDirectory *fs = nullptr;
- int cpos = -1;
- if (!_find_file(p_file, &fs, cpos)) {
- return nullptr;
- }
- if (r_index) {
- *r_index = cpos;
- }
- return fs;
- }
- EditorFileSystemDirectory *EditorFileSystem::get_filesystem_path(const String &p_path) {
- if (!filesystem || scanning) {
- return nullptr;
- }
- String f = ProjectSettings::get_singleton()->localize_path(p_path);
- if (!f.begins_with("res://")) {
- return nullptr;
- }
- f = f.substr(6, f.length());
- f = f.replace("\\", "/");
- if (f.is_empty()) {
- return filesystem;
- }
- if (f.ends_with("/")) {
- f = f.substr(0, f.length() - 1);
- }
- Vector<String> path = f.split("/");
- if (path.size() == 0) {
- return nullptr;
- }
- EditorFileSystemDirectory *fs = filesystem;
- for (int i = 0; i < path.size(); i++) {
- int idx = -1;
- for (int j = 0; j < fs->get_subdir_count(); j++) {
- if (fs->get_subdir(j)->get_name() == path[i]) {
- idx = j;
- break;
- }
- }
- if (idx == -1) {
- return nullptr;
- } else {
- fs = fs->get_subdir(idx);
- }
- }
- return fs;
- }
- void EditorFileSystem::_save_late_updated_files() {
- //files that already existed, and were modified, need re-scanning for dependencies upon project restart. This is done via saving this special file
- String fscache = EditorPaths::get_singleton()->get_project_settings_dir().path_join("filesystem_update4");
- Ref<FileAccess> f = FileAccess::open(fscache, FileAccess::WRITE);
- ERR_FAIL_COND_MSG(f.is_null(), "Cannot create file '" + fscache + "'. Check user write permissions.");
- for (const String &E : late_update_files) {
- f->store_line(E);
- }
- }
- Vector<String> EditorFileSystem::_get_dependencies(const String &p_path) {
- // Avoid error spam on first opening of a not yet imported project by treating the following situation
- // as a benign one, not letting the file open error happen: the resource is of an importable type but
- // it has not been imported yet.
- if (ResourceFormatImporter::get_singleton()->recognize_path(p_path)) {
- const String &internal_path = ResourceFormatImporter::get_singleton()->get_internal_resource_path(p_path);
- if (!internal_path.is_empty() && !FileAccess::exists(internal_path)) { // If path is empty (error), keep the code flow to the error.
- return Vector<String>();
- }
- }
- List<String> deps;
- ResourceLoader::get_dependencies(p_path, &deps);
- Vector<String> ret;
- for (const String &E : deps) {
- ret.push_back(E);
- }
- return ret;
- }
- String EditorFileSystem::_get_global_script_class(const String &p_type, const String &p_path, String *r_extends, String *r_icon_path) const {
- for (int i = 0; i < ScriptServer::get_language_count(); i++) {
- if (ScriptServer::get_language(i)->handles_global_class_type(p_type)) {
- String global_name;
- String extends;
- String icon_path;
- global_name = ScriptServer::get_language(i)->get_global_class_name(p_path, &extends, &icon_path);
- *r_extends = extends;
- *r_icon_path = icon_path;
- return global_name;
- }
- }
- *r_extends = String();
- *r_icon_path = String();
- return String();
- }
- void EditorFileSystem::_update_script_classes() {
- update_script_mutex.lock();
- for (const String &path : update_script_paths) {
- ScriptServer::remove_global_class_by_path(path); // First remove, just in case it changed
- int index = -1;
- EditorFileSystemDirectory *efd = find_file(path, &index);
- if (!efd || index < 0) {
- // The file was removed
- continue;
- }
- if (!efd->files[index]->script_class_name.is_empty()) {
- String lang;
- for (int j = 0; j < ScriptServer::get_language_count(); j++) {
- if (ScriptServer::get_language(j)->handles_global_class_type(efd->files[index]->type)) {
- lang = ScriptServer::get_language(j)->get_name();
- }
- }
- if (lang.is_empty()) {
- continue; // No lang found that can handle this global class
- }
- ScriptServer::add_global_class(efd->files[index]->script_class_name, efd->files[index]->script_class_extends, lang, path);
- EditorNode::get_editor_data().script_class_set_icon_path(efd->files[index]->script_class_name, efd->files[index]->script_class_icon_path);
- EditorNode::get_editor_data().script_class_set_name(path, efd->files[index]->script_class_name);
- }
- }
- // Parse documentation second, as it requires the class names to be correct and registered
- for (const String &path : update_script_paths) {
- int index = -1;
- EditorFileSystemDirectory *efd = find_file(path, &index);
- if (!efd || index < 0) {
- // The file was removed
- continue;
- }
- for (int i = 0; i < ScriptServer::get_language_count(); i++) {
- ScriptLanguage *lang = ScriptServer::get_language(i);
- if (lang->supports_documentation() && efd->files[index]->type == lang->get_type()) {
- Ref<Script> scr = ResourceLoader::load(path);
- if (scr.is_null()) {
- continue;
- }
- Vector<DocData::ClassDoc> docs = scr->get_documentation();
- for (int j = 0; j < docs.size(); j++) {
- EditorHelp::get_doc_data()->add_doc(docs[j]);
- }
- }
- }
- }
- update_script_paths.clear();
- update_script_mutex.unlock();
- ScriptServer::save_global_classes();
- EditorNode::get_editor_data().script_class_save_icon_paths();
- emit_signal("script_classes_updated");
- // Rescan custom loaders and savers.
- // Doing the following here because the `filesystem_changed` signal fires multiple times and isn't always followed by script classes update.
- // So I thought it's better to do this when script classes really get updated
- ResourceLoader::remove_custom_loaders();
- ResourceLoader::add_custom_loaders();
- ResourceSaver::remove_custom_savers();
- ResourceSaver::add_custom_savers();
- }
- void EditorFileSystem::_update_pending_script_classes() {
- if (!update_script_paths.is_empty()) {
- _update_script_classes();
- } else {
- // In case the class cache file was removed somehow, regenerate it.
- if (!FileAccess::exists(ScriptServer::get_global_class_cache_file_path())) {
- ScriptServer::save_global_classes();
- }
- }
- }
- void EditorFileSystem::_queue_update_script_class(const String &p_path) {
- update_script_mutex.lock();
- update_script_paths.insert(p_path);
- update_script_mutex.unlock();
- }
- void EditorFileSystem::update_file(const String &p_file) {
- ERR_FAIL_COND(p_file.is_empty());
- EditorFileSystemDirectory *fs = nullptr;
- int cpos = -1;
- if (!_find_file(p_file, &fs, cpos)) {
- if (!fs) {
- return;
- }
- }
- if (!FileAccess::exists(p_file)) {
- //was removed
- _delete_internal_files(p_file);
- if (cpos != -1) { // Might've never been part of the editor file system (*.* files deleted in Open dialog).
- if (fs->files[cpos]->uid != ResourceUID::INVALID_ID) {
- if (ResourceUID::get_singleton()->has_id(fs->files[cpos]->uid)) {
- ResourceUID::get_singleton()->remove_id(fs->files[cpos]->uid);
- }
- }
- if (ClassDB::is_parent_class(fs->files[cpos]->type, SNAME("Script"))) {
- _queue_update_script_class(p_file);
- }
- memdelete(fs->files[cpos]);
- fs->files.remove_at(cpos);
- }
- _update_pending_script_classes();
- call_deferred(SNAME("emit_signal"), "filesystem_changed"); //update later
- return;
- }
- String type = ResourceLoader::get_resource_type(p_file);
- if (type.is_empty() && textfile_extensions.has(p_file.get_extension())) {
- type = "TextFile";
- }
- String script_class = ResourceLoader::get_resource_script_class(p_file);
- ResourceUID::ID uid = ResourceLoader::get_resource_uid(p_file);
- if (cpos == -1) {
- // The file did not exist, it was added.
- int idx = 0;
- String file_name = p_file.get_file();
- for (int i = 0; i < fs->files.size(); i++) {
- if (p_file.naturalnocasecmp_to(fs->files[i]->file) < 0) {
- break;
- }
- idx++;
- }
- EditorFileSystemDirectory::FileInfo *fi = memnew(EditorFileSystemDirectory::FileInfo);
- fi->file = file_name;
- fi->import_modified_time = 0;
- fi->import_valid = type == "TextFile" ? true : ResourceLoader::is_import_valid(p_file);
- if (idx == fs->files.size()) {
- fs->files.push_back(fi);
- } else {
- fs->files.insert(idx, fi);
- }
- cpos = idx;
- } else {
- //the file exists and it was updated, and was not added in this step.
- //this means we must force upon next restart to scan it again, to get proper type and dependencies
- late_update_files.insert(p_file);
- _save_late_updated_files(); //files need to be updated in the re-scan
- }
- fs->files[cpos]->type = type;
- fs->files[cpos]->resource_script_class = script_class;
- fs->files[cpos]->uid = uid;
- fs->files[cpos]->script_class_name = _get_global_script_class(type, p_file, &fs->files[cpos]->script_class_extends, &fs->files[cpos]->script_class_icon_path);
- fs->files[cpos]->import_group_file = ResourceLoader::get_import_group_file(p_file);
- fs->files[cpos]->modified_time = FileAccess::get_modified_time(p_file);
- fs->files[cpos]->deps = _get_dependencies(p_file);
- fs->files[cpos]->import_valid = type == "TextFile" ? true : ResourceLoader::is_import_valid(p_file);
- if (uid != ResourceUID::INVALID_ID) {
- if (ResourceUID::get_singleton()->has_id(uid)) {
- ResourceUID::get_singleton()->set_id(uid, p_file);
- } else {
- ResourceUID::get_singleton()->add_id(uid, p_file);
- }
- ResourceUID::get_singleton()->update_cache();
- }
- // Update preview
- EditorResourcePreview::get_singleton()->check_for_invalidation(p_file);
- if (ClassDB::is_parent_class(fs->files[cpos]->type, SNAME("Script"))) {
- _queue_update_script_class(p_file);
- }
- _update_pending_script_classes();
- call_deferred(SNAME("emit_signal"), "filesystem_changed"); //update later
- }
- HashSet<String> EditorFileSystem::get_valid_extensions() const {
- return valid_extensions;
- }
- Error EditorFileSystem::_reimport_group(const String &p_group_file, const Vector<String> &p_files) {
- String importer_name;
- HashMap<String, HashMap<StringName, Variant>> source_file_options;
- HashMap<String, ResourceUID::ID> uids;
- HashMap<String, String> base_paths;
- for (int i = 0; i < p_files.size(); i++) {
- Ref<ConfigFile> config;
- config.instantiate();
- Error err = config->load(p_files[i] + ".import");
- ERR_CONTINUE(err != OK);
- ERR_CONTINUE(!config->has_section_key("remap", "importer"));
- String file_importer_name = config->get_value("remap", "importer");
- ERR_CONTINUE(file_importer_name.is_empty());
- if (!importer_name.is_empty() && importer_name != file_importer_name) {
- EditorNode::get_singleton()->show_warning(vformat(TTR("There are multiple importers for different types pointing to file %s, import aborted"), p_group_file));
- ERR_FAIL_V(ERR_FILE_CORRUPT);
- }
- ResourceUID::ID uid = ResourceUID::INVALID_ID;
- if (config->has_section_key("remap", "uid")) {
- String uidt = config->get_value("remap", "uid");
- uid = ResourceUID::get_singleton()->text_to_id(uidt);
- }
- uids[p_files[i]] = uid;
- source_file_options[p_files[i]] = HashMap<StringName, Variant>();
- importer_name = file_importer_name;
- if (importer_name == "keep") {
- continue; //do nothing
- }
- Ref<ResourceImporter> importer = ResourceFormatImporter::get_singleton()->get_importer_by_name(importer_name);
- ERR_FAIL_COND_V(!importer.is_valid(), ERR_FILE_CORRUPT);
- List<ResourceImporter::ImportOption> options;
- importer->get_import_options(p_files[i], &options);
- //set default values
- for (const ResourceImporter::ImportOption &E : options) {
- source_file_options[p_files[i]][E.option.name] = E.default_value;
- }
- if (config->has_section("params")) {
- List<String> sk;
- config->get_section_keys("params", &sk);
- for (const String ¶m : sk) {
- Variant value = config->get_value("params", param);
- //override with whatever is in file
- source_file_options[p_files[i]][param] = value;
- }
- }
- base_paths[p_files[i]] = ResourceFormatImporter::get_singleton()->get_import_base_path(p_files[i]);
- }
- if (importer_name == "keep") {
- return OK; // (do nothing)
- }
- ERR_FAIL_COND_V(importer_name.is_empty(), ERR_UNCONFIGURED);
- Ref<ResourceImporter> importer = ResourceFormatImporter::get_singleton()->get_importer_by_name(importer_name);
- Error err = importer->import_group_file(p_group_file, source_file_options, base_paths);
- //all went well, overwrite config files with proper remaps and md5s
- for (const KeyValue<String, HashMap<StringName, Variant>> &E : source_file_options) {
- const String &file = E.key;
- String base_path = ResourceFormatImporter::get_singleton()->get_import_base_path(file);
- Vector<String> dest_paths;
- ResourceUID::ID uid = uids[file];
- {
- Ref<FileAccess> f = FileAccess::open(file + ".import", FileAccess::WRITE);
- ERR_FAIL_COND_V_MSG(f.is_null(), ERR_FILE_CANT_OPEN, "Cannot open import file '" + file + ".import'.");
- //write manually, as order matters ([remap] has to go first for performance).
- f->store_line("[remap]");
- f->store_line("");
- f->store_line("importer=\"" + importer->get_importer_name() + "\"");
- int version = importer->get_format_version();
- if (version > 0) {
- f->store_line("importer_version=" + itos(version));
- }
- if (!importer->get_resource_type().is_empty()) {
- f->store_line("type=\"" + importer->get_resource_type() + "\"");
- }
- if (uid == ResourceUID::INVALID_ID) {
- uid = ResourceUID::get_singleton()->create_id();
- }
- f->store_line("uid=\"" + ResourceUID::get_singleton()->id_to_text(uid) + "\""); // Store in readable format.
- if (err == OK) {
- String path = base_path + "." + importer->get_save_extension();
- f->store_line("path=\"" + path + "\"");
- dest_paths.push_back(path);
- }
- f->store_line("group_file=" + Variant(p_group_file).get_construct_string());
- if (err == OK) {
- f->store_line("valid=true");
- } else {
- f->store_line("valid=false");
- }
- f->store_line("[deps]\n");
- f->store_line("");
- f->store_line("source_file=" + Variant(file).get_construct_string());
- if (dest_paths.size()) {
- Array dp;
- for (int i = 0; i < dest_paths.size(); i++) {
- dp.push_back(dest_paths[i]);
- }
- f->store_line("dest_files=" + Variant(dp).get_construct_string() + "\n");
- }
- f->store_line("[params]");
- f->store_line("");
- //store options in provided order, to avoid file changing. Order is also important because first match is accepted first.
- List<ResourceImporter::ImportOption> options;
- importer->get_import_options(file, &options);
- //set default values
- for (const ResourceImporter::ImportOption &F : options) {
- String base = F.option.name;
- Variant v = F.default_value;
- if (source_file_options[file].has(base)) {
- v = source_file_options[file][base];
- }
- String value;
- VariantWriter::write_to_string(v, value);
- f->store_line(base + "=" + value);
- }
- }
- // Store the md5's of the various files. These are stored separately so that the .import files can be version controlled.
- {
- Ref<FileAccess> md5s = FileAccess::open(base_path + ".md5", FileAccess::WRITE);
- ERR_FAIL_COND_V_MSG(md5s.is_null(), ERR_FILE_CANT_OPEN, "Cannot open MD5 file '" + base_path + ".md5'.");
- md5s->store_line("source_md5=\"" + FileAccess::get_md5(file) + "\"");
- if (dest_paths.size()) {
- md5s->store_line("dest_md5=\"" + FileAccess::get_multiple_md5(dest_paths) + "\"\n");
- }
- }
- EditorFileSystemDirectory *fs = nullptr;
- int cpos = -1;
- bool found = _find_file(file, &fs, cpos);
- ERR_FAIL_COND_V_MSG(!found, ERR_UNCONFIGURED, "Can't find file '" + file + "'.");
- //update modified times, to avoid reimport
- fs->files[cpos]->modified_time = FileAccess::get_modified_time(file);
- fs->files[cpos]->import_modified_time = FileAccess::get_modified_time(file + ".import");
- fs->files[cpos]->deps = _get_dependencies(file);
- fs->files[cpos]->uid = uid;
- fs->files[cpos]->type = importer->get_resource_type();
- if (fs->files[cpos]->type == "" && textfile_extensions.has(file.get_extension())) {
- fs->files[cpos]->type = "TextFile";
- }
- fs->files[cpos]->import_valid = err == OK;
- if (ResourceUID::get_singleton()->has_id(uid)) {
- ResourceUID::get_singleton()->set_id(uid, file);
- } else {
- ResourceUID::get_singleton()->add_id(uid, file);
- }
- //if file is currently up, maybe the source it was loaded from changed, so import math must be updated for it
- //to reload properly
- Ref<Resource> r = ResourceCache::get_ref(file);
- if (r.is_valid()) {
- if (!r->get_import_path().is_empty()) {
- String dst_path = ResourceFormatImporter::get_singleton()->get_internal_resource_path(file);
- r->set_import_path(dst_path);
- r->set_import_last_modified_time(0);
- }
- }
- EditorResourcePreview::get_singleton()->check_for_invalidation(file);
- }
- return err;
- }
- Error EditorFileSystem::_reimport_file(const String &p_file, const HashMap<StringName, Variant> &p_custom_options, const String &p_custom_importer, Variant *p_generator_parameters) {
- EditorFileSystemDirectory *fs = nullptr;
- int cpos = -1;
- bool found = _find_file(p_file, &fs, cpos);
- ERR_FAIL_COND_V_MSG(!found, ERR_FILE_NOT_FOUND, "Can't find file '" + p_file + "'.");
- //try to obtain existing params
- HashMap<StringName, Variant> params = p_custom_options;
- String importer_name; //empty by default though
- if (!p_custom_importer.is_empty()) {
- importer_name = p_custom_importer;
- }
- ResourceUID::ID uid = ResourceUID::INVALID_ID;
- Variant generator_parameters;
- if (p_generator_parameters) {
- generator_parameters = *p_generator_parameters;
- }
- if (FileAccess::exists(p_file + ".import")) {
- //use existing
- Ref<ConfigFile> cf;
- cf.instantiate();
- Error err = cf->load(p_file + ".import");
- if (err == OK) {
- if (cf->has_section("params")) {
- List<String> sk;
- cf->get_section_keys("params", &sk);
- for (const String &E : sk) {
- if (!params.has(E)) {
- params[E] = cf->get_value("params", E);
- }
- }
- }
- if (cf->has_section("remap")) {
- if (p_custom_importer.is_empty()) {
- importer_name = cf->get_value("remap", "importer");
- }
- if (cf->has_section_key("remap", "uid")) {
- String uidt = cf->get_value("remap", "uid");
- uid = ResourceUID::get_singleton()->text_to_id(uidt);
- }
- if (!p_generator_parameters) {
- if (cf->has_section_key("remap", "generator_parameters")) {
- generator_parameters = cf->get_value("remap", "generator_parameters");
- }
- }
- }
- }
- }
- if (importer_name == "keep") {
- //keep files, do nothing.
- fs->files[cpos]->modified_time = FileAccess::get_modified_time(p_file);
- fs->files[cpos]->import_modified_time = FileAccess::get_modified_time(p_file + ".import");
- fs->files[cpos]->deps.clear();
- fs->files[cpos]->type = "";
- fs->files[cpos]->import_valid = false;
- EditorResourcePreview::get_singleton()->check_for_invalidation(p_file);
- return OK;
- }
- Ref<ResourceImporter> importer;
- bool load_default = false;
- //find the importer
- if (!importer_name.is_empty()) {
- importer = ResourceFormatImporter::get_singleton()->get_importer_by_name(importer_name);
- }
- if (importer.is_null()) {
- //not found by name, find by extension
- importer = ResourceFormatImporter::get_singleton()->get_importer_by_extension(p_file.get_extension());
- load_default = true;
- if (importer.is_null()) {
- ERR_FAIL_V_MSG(ERR_FILE_CANT_OPEN, "BUG: File queued for import, but can't be imported, importer for type '" + importer_name + "' not found.");
- }
- }
- if (FileAccess::exists(p_file + ".import")) {
- // We only want to handle compat for existing files, not new ones.
- importer->handle_compatibility_options(params);
- }
- //mix with default params, in case a parameter is missing
- List<ResourceImporter::ImportOption> opts;
- importer->get_import_options(p_file, &opts);
- for (const ResourceImporter::ImportOption &E : opts) {
- if (!params.has(E.option.name)) { //this one is not present
- params[E.option.name] = E.default_value;
- }
- }
- if (load_default && ProjectSettings::get_singleton()->has_setting("importer_defaults/" + importer->get_importer_name())) {
- //use defaults if exist
- Dictionary d = GLOBAL_GET("importer_defaults/" + importer->get_importer_name());
- List<Variant> v;
- d.get_key_list(&v);
- for (const Variant &E : v) {
- params[E] = d[E];
- }
- }
- //finally, perform import!!
- String base_path = ResourceFormatImporter::get_singleton()->get_import_base_path(p_file);
- List<String> import_variants;
- List<String> gen_files;
- Variant meta;
- Error err = importer->import(p_file, base_path, params, &import_variants, &gen_files, &meta);
- ERR_FAIL_COND_V_MSG(err != OK, ERR_FILE_UNRECOGNIZED, "Error importing '" + p_file + "'.");
- //as import is complete, save the .import file
- Vector<String> dest_paths;
- {
- Ref<FileAccess> f = FileAccess::open(p_file + ".import", FileAccess::WRITE);
- ERR_FAIL_COND_V_MSG(f.is_null(), ERR_FILE_CANT_OPEN, "Cannot open file from path '" + p_file + ".import'.");
- //write manually, as order matters ([remap] has to go first for performance).
- f->store_line("[remap]");
- f->store_line("");
- f->store_line("importer=\"" + importer->get_importer_name() + "\"");
- int version = importer->get_format_version();
- if (version > 0) {
- f->store_line("importer_version=" + itos(version));
- }
- if (!importer->get_resource_type().is_empty()) {
- f->store_line("type=\"" + importer->get_resource_type() + "\"");
- }
- if (uid == ResourceUID::INVALID_ID) {
- uid = ResourceUID::get_singleton()->create_id();
- }
- f->store_line("uid=\"" + ResourceUID::get_singleton()->id_to_text(uid) + "\""); //store in readable format
- if (err == OK) {
- if (importer->get_save_extension().is_empty()) {
- //no path
- } else if (import_variants.size()) {
- //import with variants
- for (const String &E : import_variants) {
- String path = base_path.c_escape() + "." + E + "." + importer->get_save_extension();
- f->store_line("path." + E + "=\"" + path + "\"");
- dest_paths.push_back(path);
- }
- } else {
- String path = base_path + "." + importer->get_save_extension();
- f->store_line("path=\"" + path + "\"");
- dest_paths.push_back(path);
- }
- } else {
- f->store_line("valid=false");
- }
- if (meta != Variant()) {
- f->store_line("metadata=" + meta.get_construct_string());
- }
- if (generator_parameters != Variant()) {
- f->store_line("generator_parameters=" + generator_parameters.get_construct_string());
- }
- f->store_line("");
- f->store_line("[deps]\n");
- if (gen_files.size()) {
- Array genf;
- for (const String &E : gen_files) {
- genf.push_back(E);
- dest_paths.push_back(E);
- }
- String value;
- VariantWriter::write_to_string(genf, value);
- f->store_line("files=" + value);
- f->store_line("");
- }
- f->store_line("source_file=" + Variant(p_file).get_construct_string());
- if (dest_paths.size()) {
- Array dp;
- for (int i = 0; i < dest_paths.size(); i++) {
- dp.push_back(dest_paths[i]);
- }
- f->store_line("dest_files=" + Variant(dp).get_construct_string() + "\n");
- }
- f->store_line("[params]");
- f->store_line("");
- //store options in provided order, to avoid file changing. Order is also important because first match is accepted first.
- for (const ResourceImporter::ImportOption &E : opts) {
- String base = E.option.name;
- String value;
- VariantWriter::write_to_string(params[base], value);
- f->store_line(base + "=" + value);
- }
- }
- // Store the md5's of the various files. These are stored separately so that the .import files can be version controlled.
- {
- Ref<FileAccess> md5s = FileAccess::open(base_path + ".md5", FileAccess::WRITE);
- ERR_FAIL_COND_V_MSG(md5s.is_null(), ERR_FILE_CANT_OPEN, "Cannot open MD5 file '" + base_path + ".md5'.");
- md5s->store_line("source_md5=\"" + FileAccess::get_md5(p_file) + "\"");
- if (dest_paths.size()) {
- md5s->store_line("dest_md5=\"" + FileAccess::get_multiple_md5(dest_paths) + "\"\n");
- }
- }
- // Update cpos, newly created files could've changed the index of the reimported p_file.
- _find_file(p_file, &fs, cpos);
- //update modified times, to avoid reimport
- fs->files[cpos]->modified_time = FileAccess::get_modified_time(p_file);
- fs->files[cpos]->import_modified_time = FileAccess::get_modified_time(p_file + ".import");
- fs->files[cpos]->deps = _get_dependencies(p_file);
- fs->files[cpos]->type = importer->get_resource_type();
- fs->files[cpos]->uid = uid;
- fs->files[cpos]->import_valid = fs->files[cpos]->type == "TextFile" ? true : ResourceLoader::is_import_valid(p_file);
- if (ResourceUID::get_singleton()->has_id(uid)) {
- ResourceUID::get_singleton()->set_id(uid, p_file);
- } else {
- ResourceUID::get_singleton()->add_id(uid, p_file);
- }
- //if file is currently up, maybe the source it was loaded from changed, so import math must be updated for it
- //to reload properly
- Ref<Resource> r = ResourceCache::get_ref(p_file);
- if (r.is_valid()) {
- if (!r->get_import_path().is_empty()) {
- String dst_path = ResourceFormatImporter::get_singleton()->get_internal_resource_path(p_file);
- r->set_import_path(dst_path);
- r->set_import_last_modified_time(0);
- }
- }
- EditorResourcePreview::get_singleton()->check_for_invalidation(p_file);
- return OK;
- }
- void EditorFileSystem::_find_group_files(EditorFileSystemDirectory *efd, HashMap<String, Vector<String>> &group_files, HashSet<String> &groups_to_reimport) {
- int fc = efd->files.size();
- const EditorFileSystemDirectory::FileInfo *const *files = efd->files.ptr();
- for (int i = 0; i < fc; i++) {
- if (groups_to_reimport.has(files[i]->import_group_file)) {
- if (!group_files.has(files[i]->import_group_file)) {
- group_files[files[i]->import_group_file] = Vector<String>();
- }
- group_files[files[i]->import_group_file].push_back(efd->get_file_path(i));
- }
- }
- for (int i = 0; i < efd->get_subdir_count(); i++) {
- _find_group_files(efd->get_subdir(i), group_files, groups_to_reimport);
- }
- }
- void EditorFileSystem::reimport_file_with_custom_parameters(const String &p_file, const String &p_importer, const HashMap<StringName, Variant> &p_custom_params) {
- _reimport_file(p_file, p_custom_params, p_importer);
- // Emit the resource_reimported signal for the single file we just reimported.
- Vector<String> reloads;
- reloads.append(p_file);
- emit_signal(SNAME("resources_reimported"), reloads);
- }
- void EditorFileSystem::_reimport_thread(uint32_t p_index, ImportThreadData *p_import_data) {
- p_import_data->max_index = MAX(p_import_data->reimport_from + int(p_index), p_import_data->max_index);
- _reimport_file(p_import_data->reimport_files[p_import_data->reimport_from + p_index].path);
- }
- void EditorFileSystem::reimport_files(const Vector<String> &p_files) {
- ERR_FAIL_COND_MSG(importing, "Attempted to call reimport_files() recursively, this is not allowed.");
- importing = true;
- Vector<String> reloads;
- EditorProgress pr("reimport", TTR("(Re)Importing Assets"), p_files.size());
- Vector<ImportFile> reimport_files;
- HashSet<String> groups_to_reimport;
- for (int i = 0; i < p_files.size(); i++) {
- String file = p_files[i];
- ResourceUID::ID uid = ResourceUID::get_singleton()->text_to_id(file);
- if (uid != ResourceUID::INVALID_ID && ResourceUID::get_singleton()->has_id(uid)) {
- file = ResourceUID::get_singleton()->get_id_path(uid);
- }
- String group_file = ResourceFormatImporter::get_singleton()->get_import_group_file(file);
- if (group_file_cache.has(file)) {
- // Maybe the file itself is a group!
- groups_to_reimport.insert(file);
- // Groups do not belong to groups.
- group_file = String();
- } else if (groups_to_reimport.has(file)) {
- // Groups do not belong to groups.
- group_file = String();
- } else if (!group_file.is_empty()) {
- // It's a group file, add group to import and skip this file.
- groups_to_reimport.insert(group_file);
- } else {
- // It's a regular file.
- ImportFile ifile;
- ifile.path = file;
- ResourceFormatImporter::get_singleton()->get_import_order_threads_and_importer(file, ifile.order, ifile.threaded, ifile.importer);
- reloads.push_back(file);
- reimport_files.push_back(ifile);
- }
- // Group may have changed, so also update group reference.
- EditorFileSystemDirectory *fs = nullptr;
- int cpos = -1;
- if (_find_file(file, &fs, cpos)) {
- fs->files.write[cpos]->import_group_file = group_file;
- }
- }
- reimport_files.sort();
- bool use_multiple_threads = GLOBAL_GET("editor/import/use_multiple_threads");
- int from = 0;
- for (int i = 0; i < reimport_files.size(); i++) {
- if (groups_to_reimport.has(reimport_files[i].path)) {
- continue;
- }
- if (use_multiple_threads && reimport_files[i].threaded) {
- if (i + 1 == reimport_files.size() || reimport_files[i + 1].importer != reimport_files[from].importer) {
- if (from - i == 0) {
- // Single file, do not use threads.
- pr.step(reimport_files[i].path.get_file(), i);
- _reimport_file(reimport_files[i].path);
- } else {
- Ref<ResourceImporter> importer = ResourceFormatImporter::get_singleton()->get_importer_by_name(reimport_files[from].importer);
- ERR_CONTINUE(!importer.is_valid());
- importer->import_threaded_begin();
- ImportThreadData tdata;
- tdata.max_index = from;
- tdata.reimport_from = from;
- tdata.reimport_files = reimport_files.ptr();
- WorkerThreadPool::GroupID group_task = WorkerThreadPool::get_singleton()->add_template_group_task(this, &EditorFileSystem::_reimport_thread, &tdata, i - from + 1, -1, false, vformat(TTR("Import resources of type: %s"), reimport_files[from].importer));
- int current_index = from - 1;
- do {
- if (current_index < tdata.max_index) {
- current_index = tdata.max_index;
- pr.step(reimport_files[current_index].path.get_file(), current_index);
- }
- OS::get_singleton()->delay_usec(1);
- } while (!WorkerThreadPool::get_singleton()->is_group_task_completed(group_task));
- WorkerThreadPool::get_singleton()->wait_for_group_task_completion(group_task);
- importer->import_threaded_end();
- }
- from = i + 1;
- }
- } else {
- pr.step(reimport_files[i].path.get_file(), i);
- _reimport_file(reimport_files[i].path);
- }
- }
- // Reimport groups.
- from = reimport_files.size();
- if (groups_to_reimport.size()) {
- HashMap<String, Vector<String>> group_files;
- _find_group_files(filesystem, group_files, groups_to_reimport);
- for (const KeyValue<String, Vector<String>> &E : group_files) {
- pr.step(E.key.get_file(), from++);
- Error err = _reimport_group(E.key, E.value);
- reloads.push_back(E.key);
- reloads.append_array(E.value);
- if (err == OK) {
- _reimport_file(E.key);
- }
- }
- }
- ResourceUID::get_singleton()->update_cache(); // After reimporting, update the cache.
- _save_filesystem_cache();
- _update_pending_script_classes();
- importing = false;
- if (!is_scanning()) {
- emit_signal(SNAME("filesystem_changed"));
- }
- emit_signal(SNAME("resources_reimported"), reloads);
- }
- Error EditorFileSystem::reimport_append(const String &p_file, const HashMap<StringName, Variant> &p_custom_options, const String &p_custom_importer, Variant p_generator_parameters) {
- ERR_FAIL_COND_V_MSG(!importing, ERR_INVALID_PARAMETER, "Can only append files to import during a current reimport process.");
- Error ret = _reimport_file(p_file, p_custom_options, p_custom_importer, &p_generator_parameters);
- // Emit the resource_reimported signal for the single file we just reimported.
- Vector<String> reloads;
- reloads.append(p_file);
- emit_signal(SNAME("resources_reimported"), reloads);
- return ret;
- }
- Error EditorFileSystem::_resource_import(const String &p_path) {
- Vector<String> files;
- files.push_back(p_path);
- singleton->update_file(p_path);
- singleton->reimport_files(files);
- return OK;
- }
- bool EditorFileSystem::_should_skip_directory(const String &p_path) {
- String project_data_path = ProjectSettings::get_singleton()->get_project_data_path();
- if (p_path == project_data_path || p_path.begins_with(project_data_path + "/")) {
- return true;
- }
- if (FileAccess::exists(p_path.path_join("project.godot"))) {
- // Skip if another project inside this.
- if (EditorFileSystem::get_singleton()->first_scan) {
- WARN_PRINT_ONCE(vformat("Detected another project.godot at %s. The folder will be ignored.", p_path));
- }
- return true;
- }
- if (FileAccess::exists(p_path.path_join(".gdignore"))) {
- // Skip if a `.gdignore` file is inside this.
- return true;
- }
- return false;
- }
- bool EditorFileSystem::is_group_file(const String &p_path) const {
- return group_file_cache.has(p_path);
- }
- void EditorFileSystem::_move_group_files(EditorFileSystemDirectory *efd, const String &p_group_file, const String &p_new_location) {
- int fc = efd->files.size();
- EditorFileSystemDirectory::FileInfo *const *files = efd->files.ptrw();
- for (int i = 0; i < fc; i++) {
- if (files[i]->import_group_file == p_group_file) {
- files[i]->import_group_file = p_new_location;
- Ref<ConfigFile> config;
- config.instantiate();
- String path = efd->get_file_path(i) + ".import";
- Error err = config->load(path);
- if (err != OK) {
- continue;
- }
- if (config->has_section_key("remap", "group_file")) {
- config->set_value("remap", "group_file", p_new_location);
- }
- List<String> sk;
- config->get_section_keys("params", &sk);
- for (const String ¶m : sk) {
- //not very clean, but should work
- String value = config->get_value("params", param);
- if (value == p_group_file) {
- config->set_value("params", param, p_new_location);
- }
- }
- config->save(path);
- }
- }
- for (int i = 0; i < efd->get_subdir_count(); i++) {
- _move_group_files(efd->get_subdir(i), p_group_file, p_new_location);
- }
- }
- void EditorFileSystem::move_group_file(const String &p_path, const String &p_new_path) {
- if (get_filesystem()) {
- _move_group_files(get_filesystem(), p_path, p_new_path);
- if (group_file_cache.has(p_path)) {
- group_file_cache.erase(p_path);
- group_file_cache.insert(p_new_path);
- }
- }
- }
- ResourceUID::ID EditorFileSystem::_resource_saver_get_resource_id_for_path(const String &p_path, bool p_generate) {
- if (!p_path.is_resource_file() || p_path.begins_with(ProjectSettings::get_singleton()->get_project_data_path())) {
- // Saved externally (configuration file) or internal file, do not assign an ID.
- return ResourceUID::INVALID_ID;
- }
- EditorFileSystemDirectory *fs = nullptr;
- int cpos = -1;
- if (!singleton->_find_file(p_path, &fs, cpos)) {
- // Fallback to ResourceLoader if filesystem cache fails (can happen during scanning etc.).
- ResourceUID::ID fallback = ResourceLoader::get_resource_uid(p_path);
- if (fallback != ResourceUID::INVALID_ID) {
- return fallback;
- }
- if (p_generate) {
- return ResourceUID::get_singleton()->create_id(); // Just create a new one, we will be notified of save anyway and fetch the right UID at that time, to keep things simple.
- } else {
- return ResourceUID::INVALID_ID;
- }
- } else if (fs->files[cpos]->uid != ResourceUID::INVALID_ID) {
- return fs->files[cpos]->uid;
- } else if (p_generate) {
- return ResourceUID::get_singleton()->create_id(); // Just create a new one, we will be notified of save anyway and fetch the right UID at that time, to keep things simple.
- } else {
- return ResourceUID::INVALID_ID;
- }
- }
- static void _scan_extensions_dir(EditorFileSystemDirectory *d, HashSet<String> &extensions) {
- int fc = d->get_file_count();
- for (int i = 0; i < fc; i++) {
- if (d->get_file_type(i) == SNAME("GDExtension")) {
- extensions.insert(d->get_file_path(i));
- }
- }
- int dc = d->get_subdir_count();
- for (int i = 0; i < dc; i++) {
- _scan_extensions_dir(d->get_subdir(i), extensions);
- }
- }
- bool EditorFileSystem::_scan_extensions() {
- EditorFileSystemDirectory *d = get_filesystem();
- HashSet<String> extensions;
- _scan_extensions_dir(d, extensions);
- //verify against loaded extensions
- Vector<String> extensions_added;
- Vector<String> extensions_removed;
- for (const String &E : extensions) {
- if (!GDExtensionManager::get_singleton()->is_extension_loaded(E)) {
- extensions_added.push_back(E);
- }
- }
- Vector<String> loaded_extensions = GDExtensionManager::get_singleton()->get_loaded_extensions();
- for (int i = 0; i < loaded_extensions.size(); i++) {
- if (!extensions.has(loaded_extensions[i])) {
- extensions_removed.push_back(loaded_extensions[i]);
- }
- }
- String extension_list_config_file = GDExtension::get_extension_list_config_file();
- if (extensions.size()) {
- if (extensions_added.size() || extensions_removed.size()) { //extensions were added or removed
- Ref<FileAccess> f = FileAccess::open(extension_list_config_file, FileAccess::WRITE);
- for (const String &E : extensions) {
- f->store_line(E);
- }
- }
- } else {
- if (loaded_extensions.size() || FileAccess::exists(extension_list_config_file)) { //extensions were removed
- Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_RESOURCES);
- da->remove(extension_list_config_file);
- }
- }
- bool needs_restart = false;
- for (int i = 0; i < extensions_added.size(); i++) {
- GDExtensionManager::LoadStatus st = GDExtensionManager::get_singleton()->load_extension(extensions_added[i]);
- if (st == GDExtensionManager::LOAD_STATUS_NEEDS_RESTART) {
- needs_restart = true;
- }
- }
- for (int i = 0; i < extensions_removed.size(); i++) {
- GDExtensionManager::LoadStatus st = GDExtensionManager::get_singleton()->unload_extension(extensions_removed[i]);
- if (st == GDExtensionManager::LOAD_STATUS_NEEDS_RESTART) {
- needs_restart = true;
- }
- }
- return needs_restart;
- }
- void EditorFileSystem::_bind_methods() {
- ClassDB::bind_method(D_METHOD("get_filesystem"), &EditorFileSystem::get_filesystem);
- ClassDB::bind_method(D_METHOD("is_scanning"), &EditorFileSystem::is_scanning);
- ClassDB::bind_method(D_METHOD("get_scanning_progress"), &EditorFileSystem::get_scanning_progress);
- ClassDB::bind_method(D_METHOD("scan"), &EditorFileSystem::scan);
- ClassDB::bind_method(D_METHOD("scan_sources"), &EditorFileSystem::scan_changes);
- ClassDB::bind_method(D_METHOD("update_file", "path"), &EditorFileSystem::update_file);
- ClassDB::bind_method(D_METHOD("get_filesystem_path", "path"), &EditorFileSystem::get_filesystem_path);
- ClassDB::bind_method(D_METHOD("get_file_type", "path"), &EditorFileSystem::get_file_type);
- ClassDB::bind_method(D_METHOD("reimport_files", "files"), &EditorFileSystem::reimport_files);
- ADD_SIGNAL(MethodInfo("filesystem_changed"));
- ADD_SIGNAL(MethodInfo("script_classes_updated"));
- ADD_SIGNAL(MethodInfo("sources_changed", PropertyInfo(Variant::BOOL, "exist")));
- ADD_SIGNAL(MethodInfo("resources_reimported", PropertyInfo(Variant::PACKED_STRING_ARRAY, "resources")));
- ADD_SIGNAL(MethodInfo("resources_reload", PropertyInfo(Variant::PACKED_STRING_ARRAY, "resources")));
- }
- void EditorFileSystem::_update_extensions() {
- valid_extensions.clear();
- import_extensions.clear();
- textfile_extensions.clear();
- List<String> extensionsl;
- ResourceLoader::get_recognized_extensions_for_type("", &extensionsl);
- for (const String &E : extensionsl) {
- valid_extensions.insert(E);
- }
- const Vector<String> textfile_ext = ((String)(EDITOR_GET("docks/filesystem/textfile_extensions"))).split(",", false);
- for (const String &E : textfile_ext) {
- if (valid_extensions.has(E)) {
- continue;
- }
- valid_extensions.insert(E);
- textfile_extensions.insert(E);
- }
- extensionsl.clear();
- ResourceFormatImporter::get_singleton()->get_recognized_extensions(&extensionsl);
- for (const String &E : extensionsl) {
- import_extensions.insert(E);
- }
- }
- void EditorFileSystem::add_import_format_support_query(Ref<EditorFileSystemImportFormatSupportQuery> p_query) {
- ERR_FAIL_COND(import_support_queries.find(p_query) != -1);
- import_support_queries.push_back(p_query);
- }
- void EditorFileSystem::remove_import_format_support_query(Ref<EditorFileSystemImportFormatSupportQuery> p_query) {
- import_support_queries.erase(p_query);
- }
- EditorFileSystem::EditorFileSystem() {
- ResourceLoader::import = _resource_import;
- reimport_on_missing_imported_files = GLOBAL_GET("editor/import/reimport_missing_imported_files");
- singleton = this;
- filesystem = memnew(EditorFileSystemDirectory); //like, empty
- filesystem->parent = nullptr;
- new_filesystem = nullptr;
- // This should probably also work on Unix and use the string it returns for FAT32 or exFAT
- Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_RESOURCES);
- using_fat32_or_exfat = (da->get_filesystem_type() == "FAT32" || da->get_filesystem_type() == "exFAT");
- scan_total = 0;
- MessageQueue::get_singleton()->push_callable(callable_mp(ResourceUID::get_singleton(), &ResourceUID::clear)); // Will be updated on scan.
- ResourceSaver::set_get_resource_id_for_path(_resource_saver_get_resource_id_for_path);
- }
- EditorFileSystem::~EditorFileSystem() {
- ResourceSaver::set_get_resource_id_for_path(nullptr);
- }
|