file_access.cpp 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950
  1. /**************************************************************************/
  2. /* file_access.cpp */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #include "file_access.h"
  31. #include "core/config/project_settings.h"
  32. #include "core/crypto/crypto_core.h"
  33. #include "core/io/file_access_compressed.h"
  34. #include "core/io/file_access_encrypted.h"
  35. #include "core/io/file_access_pack.h"
  36. #include "core/io/marshalls.h"
  37. #include "core/os/os.h"
  38. FileAccess::CreateFunc FileAccess::create_func[ACCESS_MAX] = {};
  39. FileAccess::FileCloseFailNotify FileAccess::close_fail_notify = nullptr;
  40. bool FileAccess::backup_save = false;
  41. thread_local Error FileAccess::last_file_open_error = OK;
  42. Ref<FileAccess> FileAccess::create(AccessType p_access) {
  43. ERR_FAIL_INDEX_V(p_access, ACCESS_MAX, nullptr);
  44. ERR_FAIL_NULL_V(create_func[p_access], nullptr);
  45. Ref<FileAccess> ret = create_func[p_access]();
  46. ret->_set_access_type(p_access);
  47. return ret;
  48. }
  49. bool FileAccess::exists(const String &p_name) {
  50. if (PackedData::get_singleton() && !PackedData::get_singleton()->is_disabled() && PackedData::get_singleton()->has_path(p_name)) {
  51. return true;
  52. }
  53. // Using file_exists because it's faster then trying to open the file.
  54. Ref<FileAccess> ret = create_for_path(p_name);
  55. return ret->file_exists(p_name);
  56. }
  57. void FileAccess::_set_access_type(AccessType p_access) {
  58. _access_type = p_access;
  59. }
  60. Ref<FileAccess> FileAccess::create_for_path(const String &p_path) {
  61. Ref<FileAccess> ret;
  62. if (p_path.begins_with("res://")) {
  63. ret = create(ACCESS_RESOURCES);
  64. } else if (p_path.begins_with("user://")) {
  65. ret = create(ACCESS_USERDATA);
  66. } else if (p_path.begins_with("pipe://")) {
  67. ret = create(ACCESS_PIPE);
  68. } else {
  69. ret = create(ACCESS_FILESYSTEM);
  70. }
  71. return ret;
  72. }
  73. Error FileAccess::reopen(const String &p_path, int p_mode_flags) {
  74. return open_internal(p_path, p_mode_flags);
  75. }
  76. Ref<FileAccess> FileAccess::open(const String &p_path, int p_mode_flags, Error *r_error) {
  77. //try packed data first
  78. Ref<FileAccess> ret;
  79. if (!(p_mode_flags & WRITE) && PackedData::get_singleton() && !PackedData::get_singleton()->is_disabled()) {
  80. ret = PackedData::get_singleton()->try_open_path(p_path);
  81. if (ret.is_valid()) {
  82. if (r_error) {
  83. *r_error = OK;
  84. }
  85. return ret;
  86. }
  87. }
  88. ret = create_for_path(p_path);
  89. Error err = ret->open_internal(p_path, p_mode_flags);
  90. if (r_error) {
  91. *r_error = err;
  92. }
  93. if (err != OK) {
  94. ret.unref();
  95. }
  96. return ret;
  97. }
  98. Ref<FileAccess> FileAccess::_open(const String &p_path, ModeFlags p_mode_flags) {
  99. Error err = OK;
  100. Ref<FileAccess> fa = open(p_path, p_mode_flags, &err);
  101. last_file_open_error = err;
  102. if (err) {
  103. return Ref<FileAccess>();
  104. }
  105. return fa;
  106. }
  107. Ref<FileAccess> FileAccess::open_encrypted(const String &p_path, ModeFlags p_mode_flags, const Vector<uint8_t> &p_key) {
  108. Ref<FileAccess> fa = _open(p_path, p_mode_flags);
  109. if (fa.is_null()) {
  110. return fa;
  111. }
  112. Ref<FileAccessEncrypted> fae;
  113. fae.instantiate();
  114. Error err = fae->open_and_parse(fa, p_key, (p_mode_flags == WRITE) ? FileAccessEncrypted::MODE_WRITE_AES256 : FileAccessEncrypted::MODE_READ);
  115. last_file_open_error = err;
  116. if (err) {
  117. return Ref<FileAccess>();
  118. }
  119. return fae;
  120. }
  121. Ref<FileAccess> FileAccess::open_encrypted_pass(const String &p_path, ModeFlags p_mode_flags, const String &p_pass) {
  122. Ref<FileAccess> fa = _open(p_path, p_mode_flags);
  123. if (fa.is_null()) {
  124. return fa;
  125. }
  126. Ref<FileAccessEncrypted> fae;
  127. fae.instantiate();
  128. Error err = fae->open_and_parse_password(fa, p_pass, (p_mode_flags == WRITE) ? FileAccessEncrypted::MODE_WRITE_AES256 : FileAccessEncrypted::MODE_READ);
  129. last_file_open_error = err;
  130. if (err) {
  131. return Ref<FileAccess>();
  132. }
  133. return fae;
  134. }
  135. Ref<FileAccess> FileAccess::open_compressed(const String &p_path, ModeFlags p_mode_flags, CompressionMode p_compress_mode) {
  136. Ref<FileAccessCompressed> fac;
  137. fac.instantiate();
  138. fac->configure("GCPF", (Compression::Mode)p_compress_mode);
  139. Error err = fac->open_internal(p_path, p_mode_flags);
  140. last_file_open_error = err;
  141. if (err) {
  142. return Ref<FileAccess>();
  143. }
  144. return fac;
  145. }
  146. Error FileAccess::get_open_error() {
  147. return last_file_open_error;
  148. }
  149. FileAccess::CreateFunc FileAccess::get_create_func(AccessType p_access) {
  150. return create_func[p_access];
  151. }
  152. FileAccess::AccessType FileAccess::get_access_type() const {
  153. return _access_type;
  154. }
  155. String FileAccess::fix_path(const String &p_path) const {
  156. //helper used by file accesses that use a single filesystem
  157. String r_path = p_path.replace("\\", "/");
  158. switch (_access_type) {
  159. case ACCESS_RESOURCES: {
  160. if (ProjectSettings::get_singleton()) {
  161. if (r_path.begins_with("res://")) {
  162. String resource_path = ProjectSettings::get_singleton()->get_resource_path();
  163. if (!resource_path.is_empty()) {
  164. return r_path.replace("res:/", resource_path);
  165. }
  166. return r_path.replace("res://", "");
  167. }
  168. }
  169. } break;
  170. case ACCESS_USERDATA: {
  171. if (r_path.begins_with("user://")) {
  172. String data_dir = OS::get_singleton()->get_user_data_dir();
  173. if (!data_dir.is_empty()) {
  174. return r_path.replace("user:/", data_dir);
  175. }
  176. return r_path.replace("user://", "");
  177. }
  178. } break;
  179. case ACCESS_PIPE: {
  180. return r_path;
  181. } break;
  182. case ACCESS_FILESYSTEM: {
  183. return r_path;
  184. } break;
  185. case ACCESS_MAX:
  186. break; // Can't happen, but silences warning
  187. }
  188. return r_path;
  189. }
  190. /* these are all implemented for ease of porting, then can later be optimized */
  191. uint16_t FileAccess::get_16() const {
  192. uint16_t res;
  193. uint8_t a, b;
  194. a = get_8();
  195. b = get_8();
  196. if (big_endian) {
  197. SWAP(a, b);
  198. }
  199. res = b;
  200. res <<= 8;
  201. res |= a;
  202. return res;
  203. }
  204. uint32_t FileAccess::get_32() const {
  205. uint32_t res;
  206. uint16_t a, b;
  207. a = get_16();
  208. b = get_16();
  209. if (big_endian) {
  210. SWAP(a, b);
  211. }
  212. res = b;
  213. res <<= 16;
  214. res |= a;
  215. return res;
  216. }
  217. uint64_t FileAccess::get_64() const {
  218. uint64_t res;
  219. uint32_t a, b;
  220. a = get_32();
  221. b = get_32();
  222. if (big_endian) {
  223. SWAP(a, b);
  224. }
  225. res = b;
  226. res <<= 32;
  227. res |= a;
  228. return res;
  229. }
  230. float FileAccess::get_float() const {
  231. MarshallFloat m;
  232. m.i = get_32();
  233. return m.f;
  234. }
  235. real_t FileAccess::get_real() const {
  236. if (real_is_double) {
  237. return get_double();
  238. } else {
  239. return get_float();
  240. }
  241. }
  242. Variant FileAccess::get_var(bool p_allow_objects) const {
  243. uint32_t len = get_32();
  244. Vector<uint8_t> buff = get_buffer(len);
  245. ERR_FAIL_COND_V((uint32_t)buff.size() != len, Variant());
  246. const uint8_t *r = buff.ptr();
  247. Variant v;
  248. Error err = decode_variant(v, &r[0], len, nullptr, p_allow_objects);
  249. ERR_FAIL_COND_V_MSG(err != OK, Variant(), "Error when trying to encode Variant.");
  250. return v;
  251. }
  252. double FileAccess::get_double() const {
  253. MarshallDouble m;
  254. m.l = get_64();
  255. return m.d;
  256. }
  257. String FileAccess::get_token() const {
  258. CharString token;
  259. char32_t c = get_8();
  260. while (!eof_reached()) {
  261. if (c <= ' ') {
  262. if (token.length()) {
  263. break;
  264. }
  265. } else {
  266. token += c;
  267. }
  268. c = get_8();
  269. }
  270. return String::utf8(token.get_data());
  271. }
  272. class CharBuffer {
  273. Vector<char> vector;
  274. char stack_buffer[256];
  275. char *buffer = nullptr;
  276. int capacity = 0;
  277. int written = 0;
  278. bool grow() {
  279. if (vector.resize(next_power_of_2(1 + written)) != OK) {
  280. return false;
  281. }
  282. if (buffer == stack_buffer) { // first chunk?
  283. for (int i = 0; i < written; i++) {
  284. vector.write[i] = stack_buffer[i];
  285. }
  286. }
  287. buffer = vector.ptrw();
  288. capacity = vector.size();
  289. ERR_FAIL_COND_V(written >= capacity, false);
  290. return true;
  291. }
  292. public:
  293. _FORCE_INLINE_ CharBuffer() :
  294. buffer(stack_buffer),
  295. capacity(sizeof(stack_buffer) / sizeof(char)) {
  296. }
  297. _FORCE_INLINE_ void push_back(char c) {
  298. if (written >= capacity) {
  299. ERR_FAIL_COND(!grow());
  300. }
  301. buffer[written++] = c;
  302. }
  303. _FORCE_INLINE_ const char *get_data() const {
  304. return buffer;
  305. }
  306. };
  307. String FileAccess::get_line() const {
  308. CharBuffer line;
  309. char32_t c = get_8();
  310. while (!eof_reached()) {
  311. if (c == '\n' || c == '\0') {
  312. line.push_back(0);
  313. return String::utf8(line.get_data());
  314. } else if (c != '\r') {
  315. line.push_back(c);
  316. }
  317. c = get_8();
  318. }
  319. line.push_back(0);
  320. return String::utf8(line.get_data());
  321. }
  322. Vector<String> FileAccess::get_csv_line(const String &p_delim) const {
  323. ERR_FAIL_COND_V_MSG(p_delim.length() != 1, Vector<String>(), "Only single character delimiters are supported to parse CSV lines.");
  324. ERR_FAIL_COND_V_MSG(p_delim[0] == '"', Vector<String>(), "The double quotation mark character (\") is not supported as a delimiter for CSV lines.");
  325. String line;
  326. // CSV can support entries with line breaks as long as they are enclosed
  327. // in double quotes. So our "line" might be more than a single line in the
  328. // text file.
  329. int qc = 0;
  330. do {
  331. if (eof_reached()) {
  332. break;
  333. }
  334. line += get_line() + "\n";
  335. qc = 0;
  336. for (int i = 0; i < line.length(); i++) {
  337. if (line[i] == '"') {
  338. qc++;
  339. }
  340. }
  341. } while (qc % 2);
  342. // Remove the extraneous newline we've added above.
  343. line = line.substr(0, line.length() - 1);
  344. Vector<String> strings;
  345. bool in_quote = false;
  346. String current;
  347. for (int i = 0; i < line.length(); i++) {
  348. char32_t c = line[i];
  349. // A delimiter ends the current entry, unless it's in a quoted string.
  350. if (!in_quote && c == p_delim[0]) {
  351. strings.push_back(current);
  352. current = String();
  353. } else if (c == '"') {
  354. // Doubled quotes are escapes for intentional quotes in the string.
  355. if (line[i + 1] == '"' && in_quote) {
  356. current += '"';
  357. i++;
  358. } else {
  359. in_quote = !in_quote;
  360. }
  361. } else {
  362. current += c;
  363. }
  364. }
  365. if (in_quote) {
  366. WARN_PRINT(vformat("Reached end of file before closing '\"' in CSV file '%s'.", get_path()));
  367. }
  368. strings.push_back(current);
  369. return strings;
  370. }
  371. String FileAccess::get_as_text(bool p_skip_cr) const {
  372. uint64_t original_pos = get_position();
  373. const_cast<FileAccess *>(this)->seek(0);
  374. String text = get_as_utf8_string(p_skip_cr);
  375. const_cast<FileAccess *>(this)->seek(original_pos);
  376. return text;
  377. }
  378. uint64_t FileAccess::get_buffer(uint8_t *p_dst, uint64_t p_length) const {
  379. ERR_FAIL_COND_V(!p_dst && p_length > 0, -1);
  380. uint64_t i = 0;
  381. for (i = 0; i < p_length && !eof_reached(); i++) {
  382. p_dst[i] = get_8();
  383. }
  384. return i;
  385. }
  386. Vector<uint8_t> FileAccess::get_buffer(int64_t p_length) const {
  387. Vector<uint8_t> data;
  388. ERR_FAIL_COND_V_MSG(p_length < 0, data, "Length of buffer cannot be smaller than 0.");
  389. if (p_length == 0) {
  390. return data;
  391. }
  392. Error err = data.resize(p_length);
  393. ERR_FAIL_COND_V_MSG(err != OK, data, "Can't resize data to " + itos(p_length) + " elements.");
  394. uint8_t *w = data.ptrw();
  395. int64_t len = get_buffer(&w[0], p_length);
  396. if (len < p_length) {
  397. data.resize(len);
  398. }
  399. return data;
  400. }
  401. String FileAccess::get_as_utf8_string(bool p_skip_cr) const {
  402. Vector<uint8_t> sourcef;
  403. uint64_t len = get_length();
  404. sourcef.resize(len + 1);
  405. uint8_t *w = sourcef.ptrw();
  406. uint64_t r = get_buffer(w, len);
  407. ERR_FAIL_COND_V(r != len, String());
  408. w[len] = 0;
  409. String s;
  410. s.parse_utf8((const char *)w, -1, p_skip_cr);
  411. return s;
  412. }
  413. void FileAccess::store_16(uint16_t p_dest) {
  414. uint8_t a, b;
  415. a = p_dest & 0xFF;
  416. b = p_dest >> 8;
  417. if (big_endian) {
  418. SWAP(a, b);
  419. }
  420. store_8(a);
  421. store_8(b);
  422. }
  423. void FileAccess::store_32(uint32_t p_dest) {
  424. uint16_t a, b;
  425. a = p_dest & 0xFFFF;
  426. b = p_dest >> 16;
  427. if (big_endian) {
  428. SWAP(a, b);
  429. }
  430. store_16(a);
  431. store_16(b);
  432. }
  433. void FileAccess::store_64(uint64_t p_dest) {
  434. uint32_t a, b;
  435. a = p_dest & 0xFFFFFFFF;
  436. b = p_dest >> 32;
  437. if (big_endian) {
  438. SWAP(a, b);
  439. }
  440. store_32(a);
  441. store_32(b);
  442. }
  443. void FileAccess::store_real(real_t p_real) {
  444. if constexpr (sizeof(real_t) == 4) {
  445. store_float(p_real);
  446. } else {
  447. store_double(p_real);
  448. }
  449. }
  450. void FileAccess::store_float(float p_dest) {
  451. MarshallFloat m;
  452. m.f = p_dest;
  453. store_32(m.i);
  454. }
  455. void FileAccess::store_double(double p_dest) {
  456. MarshallDouble m;
  457. m.d = p_dest;
  458. store_64(m.l);
  459. }
  460. uint64_t FileAccess::get_modified_time(const String &p_file) {
  461. if (PackedData::get_singleton() && !PackedData::get_singleton()->is_disabled() && (PackedData::get_singleton()->has_path(p_file) || PackedData::get_singleton()->has_directory(p_file))) {
  462. return 0;
  463. }
  464. Ref<FileAccess> fa = create_for_path(p_file);
  465. ERR_FAIL_COND_V_MSG(fa.is_null(), 0, "Cannot create FileAccess for path '" + p_file + "'.");
  466. uint64_t mt = fa->_get_modified_time(p_file);
  467. return mt;
  468. }
  469. BitField<FileAccess::UnixPermissionFlags> FileAccess::get_unix_permissions(const String &p_file) {
  470. if (PackedData::get_singleton() && !PackedData::get_singleton()->is_disabled() && (PackedData::get_singleton()->has_path(p_file) || PackedData::get_singleton()->has_directory(p_file))) {
  471. return 0;
  472. }
  473. Ref<FileAccess> fa = create_for_path(p_file);
  474. ERR_FAIL_COND_V_MSG(fa.is_null(), 0, "Cannot create FileAccess for path '" + p_file + "'.");
  475. return fa->_get_unix_permissions(p_file);
  476. }
  477. Error FileAccess::set_unix_permissions(const String &p_file, BitField<FileAccess::UnixPermissionFlags> p_permissions) {
  478. if (PackedData::get_singleton() && !PackedData::get_singleton()->is_disabled() && (PackedData::get_singleton()->has_path(p_file) || PackedData::get_singleton()->has_directory(p_file))) {
  479. return ERR_UNAVAILABLE;
  480. }
  481. Ref<FileAccess> fa = create_for_path(p_file);
  482. ERR_FAIL_COND_V_MSG(fa.is_null(), ERR_CANT_CREATE, "Cannot create FileAccess for path '" + p_file + "'.");
  483. Error err = fa->_set_unix_permissions(p_file, p_permissions);
  484. return err;
  485. }
  486. bool FileAccess::get_hidden_attribute(const String &p_file) {
  487. if (PackedData::get_singleton() && !PackedData::get_singleton()->is_disabled() && (PackedData::get_singleton()->has_path(p_file) || PackedData::get_singleton()->has_directory(p_file))) {
  488. return false;
  489. }
  490. Ref<FileAccess> fa = create_for_path(p_file);
  491. ERR_FAIL_COND_V_MSG(fa.is_null(), false, "Cannot create FileAccess for path '" + p_file + "'.");
  492. return fa->_get_hidden_attribute(p_file);
  493. }
  494. Error FileAccess::set_hidden_attribute(const String &p_file, bool p_hidden) {
  495. if (PackedData::get_singleton() && !PackedData::get_singleton()->is_disabled() && (PackedData::get_singleton()->has_path(p_file) || PackedData::get_singleton()->has_directory(p_file))) {
  496. return ERR_UNAVAILABLE;
  497. }
  498. Ref<FileAccess> fa = create_for_path(p_file);
  499. ERR_FAIL_COND_V_MSG(fa.is_null(), ERR_CANT_CREATE, "Cannot create FileAccess for path '" + p_file + "'.");
  500. Error err = fa->_set_hidden_attribute(p_file, p_hidden);
  501. return err;
  502. }
  503. bool FileAccess::get_read_only_attribute(const String &p_file) {
  504. if (PackedData::get_singleton() && !PackedData::get_singleton()->is_disabled() && (PackedData::get_singleton()->has_path(p_file) || PackedData::get_singleton()->has_directory(p_file))) {
  505. return false;
  506. }
  507. Ref<FileAccess> fa = create_for_path(p_file);
  508. ERR_FAIL_COND_V_MSG(fa.is_null(), false, "Cannot create FileAccess for path '" + p_file + "'.");
  509. return fa->_get_read_only_attribute(p_file);
  510. }
  511. Error FileAccess::set_read_only_attribute(const String &p_file, bool p_ro) {
  512. if (PackedData::get_singleton() && !PackedData::get_singleton()->is_disabled() && (PackedData::get_singleton()->has_path(p_file) || PackedData::get_singleton()->has_directory(p_file))) {
  513. return ERR_UNAVAILABLE;
  514. }
  515. Ref<FileAccess> fa = create_for_path(p_file);
  516. ERR_FAIL_COND_V_MSG(fa.is_null(), ERR_CANT_CREATE, "Cannot create FileAccess for path '" + p_file + "'.");
  517. Error err = fa->_set_read_only_attribute(p_file, p_ro);
  518. return err;
  519. }
  520. void FileAccess::store_string(const String &p_string) {
  521. if (p_string.length() == 0) {
  522. return;
  523. }
  524. CharString cs = p_string.utf8();
  525. store_buffer((uint8_t *)&cs[0], cs.length());
  526. }
  527. void FileAccess::store_pascal_string(const String &p_string) {
  528. CharString cs = p_string.utf8();
  529. store_32(cs.length());
  530. store_buffer((uint8_t *)&cs[0], cs.length());
  531. }
  532. String FileAccess::get_pascal_string() {
  533. uint32_t sl = get_32();
  534. CharString cs;
  535. cs.resize(sl + 1);
  536. get_buffer((uint8_t *)cs.ptr(), sl);
  537. cs[sl] = 0;
  538. String ret;
  539. ret.parse_utf8(cs.ptr());
  540. return ret;
  541. }
  542. void FileAccess::store_line(const String &p_line) {
  543. store_string(p_line);
  544. store_8('\n');
  545. }
  546. void FileAccess::store_csv_line(const Vector<String> &p_values, const String &p_delim) {
  547. ERR_FAIL_COND(p_delim.length() != 1);
  548. String line = "";
  549. int size = p_values.size();
  550. for (int i = 0; i < size; ++i) {
  551. String value = p_values[i];
  552. if (value.contains("\"") || value.contains(p_delim) || value.contains("\n")) {
  553. value = "\"" + value.replace("\"", "\"\"") + "\"";
  554. }
  555. if (i < size - 1) {
  556. value += p_delim;
  557. }
  558. line += value;
  559. }
  560. store_line(line);
  561. }
  562. void FileAccess::store_buffer(const uint8_t *p_src, uint64_t p_length) {
  563. ERR_FAIL_COND(!p_src && p_length > 0);
  564. for (uint64_t i = 0; i < p_length; i++) {
  565. store_8(p_src[i]);
  566. }
  567. }
  568. void FileAccess::store_buffer(const Vector<uint8_t> &p_buffer) {
  569. uint64_t len = p_buffer.size();
  570. if (len == 0) {
  571. return;
  572. }
  573. const uint8_t *r = p_buffer.ptr();
  574. store_buffer(&r[0], len);
  575. }
  576. void FileAccess::store_var(const Variant &p_var, bool p_full_objects) {
  577. int len;
  578. Error err = encode_variant(p_var, nullptr, len, p_full_objects);
  579. ERR_FAIL_COND_MSG(err != OK, "Error when trying to encode Variant.");
  580. Vector<uint8_t> buff;
  581. buff.resize(len);
  582. uint8_t *w = buff.ptrw();
  583. err = encode_variant(p_var, &w[0], len, p_full_objects);
  584. ERR_FAIL_COND_MSG(err != OK, "Error when trying to encode Variant.");
  585. store_32(len);
  586. store_buffer(buff);
  587. }
  588. Vector<uint8_t> FileAccess::get_file_as_bytes(const String &p_path, Error *r_error) {
  589. Ref<FileAccess> f = FileAccess::open(p_path, READ, r_error);
  590. if (f.is_null()) {
  591. if (r_error) { // if error requested, do not throw error
  592. return Vector<uint8_t>();
  593. }
  594. ERR_FAIL_V_MSG(Vector<uint8_t>(), "Can't open file from path '" + String(p_path) + "'.");
  595. }
  596. Vector<uint8_t> data;
  597. data.resize(f->get_length());
  598. f->get_buffer(data.ptrw(), data.size());
  599. return data;
  600. }
  601. String FileAccess::get_file_as_string(const String &p_path, Error *r_error) {
  602. Error err;
  603. Vector<uint8_t> array = get_file_as_bytes(p_path, &err);
  604. if (r_error) {
  605. *r_error = err;
  606. }
  607. if (err != OK) {
  608. if (r_error) {
  609. return String();
  610. }
  611. ERR_FAIL_V_MSG(String(), "Can't get file as string from path '" + String(p_path) + "'.");
  612. }
  613. String ret;
  614. ret.parse_utf8((const char *)array.ptr(), array.size());
  615. return ret;
  616. }
  617. String FileAccess::get_md5(const String &p_file) {
  618. Ref<FileAccess> f = FileAccess::open(p_file, READ);
  619. if (f.is_null()) {
  620. return String();
  621. }
  622. CryptoCore::MD5Context ctx;
  623. ctx.start();
  624. unsigned char step[32768];
  625. while (true) {
  626. uint64_t br = f->get_buffer(step, 32768);
  627. if (br > 0) {
  628. ctx.update(step, br);
  629. }
  630. if (br < 4096) {
  631. break;
  632. }
  633. }
  634. unsigned char hash[16];
  635. ctx.finish(hash);
  636. return String::md5(hash);
  637. }
  638. String FileAccess::get_multiple_md5(const Vector<String> &p_file) {
  639. CryptoCore::MD5Context ctx;
  640. ctx.start();
  641. for (int i = 0; i < p_file.size(); i++) {
  642. Ref<FileAccess> f = FileAccess::open(p_file[i], READ);
  643. ERR_CONTINUE(f.is_null());
  644. unsigned char step[32768];
  645. while (true) {
  646. uint64_t br = f->get_buffer(step, 32768);
  647. if (br > 0) {
  648. ctx.update(step, br);
  649. }
  650. if (br < 4096) {
  651. break;
  652. }
  653. }
  654. }
  655. unsigned char hash[16];
  656. ctx.finish(hash);
  657. return String::md5(hash);
  658. }
  659. String FileAccess::get_sha256(const String &p_file) {
  660. Ref<FileAccess> f = FileAccess::open(p_file, READ);
  661. if (f.is_null()) {
  662. return String();
  663. }
  664. CryptoCore::SHA256Context ctx;
  665. ctx.start();
  666. unsigned char step[32768];
  667. while (true) {
  668. uint64_t br = f->get_buffer(step, 32768);
  669. if (br > 0) {
  670. ctx.update(step, br);
  671. }
  672. if (br < 4096) {
  673. break;
  674. }
  675. }
  676. unsigned char hash[32];
  677. ctx.finish(hash);
  678. return String::hex_encode_buffer(hash, 32);
  679. }
  680. void FileAccess::_bind_methods() {
  681. ClassDB::bind_static_method("FileAccess", D_METHOD("open", "path", "flags"), &FileAccess::_open);
  682. ClassDB::bind_static_method("FileAccess", D_METHOD("open_encrypted", "path", "mode_flags", "key"), &FileAccess::open_encrypted);
  683. ClassDB::bind_static_method("FileAccess", D_METHOD("open_encrypted_with_pass", "path", "mode_flags", "pass"), &FileAccess::open_encrypted_pass);
  684. ClassDB::bind_static_method("FileAccess", D_METHOD("open_compressed", "path", "mode_flags", "compression_mode"), &FileAccess::open_compressed, DEFVAL(0));
  685. ClassDB::bind_static_method("FileAccess", D_METHOD("get_open_error"), &FileAccess::get_open_error);
  686. ClassDB::bind_static_method("FileAccess", D_METHOD("get_file_as_bytes", "path"), &FileAccess::_get_file_as_bytes);
  687. ClassDB::bind_static_method("FileAccess", D_METHOD("get_file_as_string", "path"), &FileAccess::_get_file_as_string);
  688. ClassDB::bind_method(D_METHOD("resize", "length"), &FileAccess::resize);
  689. ClassDB::bind_method(D_METHOD("flush"), &FileAccess::flush);
  690. ClassDB::bind_method(D_METHOD("get_path"), &FileAccess::get_path);
  691. ClassDB::bind_method(D_METHOD("get_path_absolute"), &FileAccess::get_path_absolute);
  692. ClassDB::bind_method(D_METHOD("is_open"), &FileAccess::is_open);
  693. ClassDB::bind_method(D_METHOD("seek", "position"), &FileAccess::seek);
  694. ClassDB::bind_method(D_METHOD("seek_end", "position"), &FileAccess::seek_end, DEFVAL(0));
  695. ClassDB::bind_method(D_METHOD("get_position"), &FileAccess::get_position);
  696. ClassDB::bind_method(D_METHOD("get_length"), &FileAccess::get_length);
  697. ClassDB::bind_method(D_METHOD("eof_reached"), &FileAccess::eof_reached);
  698. ClassDB::bind_method(D_METHOD("get_8"), &FileAccess::get_8);
  699. ClassDB::bind_method(D_METHOD("get_16"), &FileAccess::get_16);
  700. ClassDB::bind_method(D_METHOD("get_32"), &FileAccess::get_32);
  701. ClassDB::bind_method(D_METHOD("get_64"), &FileAccess::get_64);
  702. ClassDB::bind_method(D_METHOD("get_float"), &FileAccess::get_float);
  703. ClassDB::bind_method(D_METHOD("get_double"), &FileAccess::get_double);
  704. ClassDB::bind_method(D_METHOD("get_real"), &FileAccess::get_real);
  705. ClassDB::bind_method(D_METHOD("get_buffer", "length"), (Vector<uint8_t>(FileAccess::*)(int64_t) const) & FileAccess::get_buffer);
  706. ClassDB::bind_method(D_METHOD("get_line"), &FileAccess::get_line);
  707. ClassDB::bind_method(D_METHOD("get_csv_line", "delim"), &FileAccess::get_csv_line, DEFVAL(","));
  708. ClassDB::bind_method(D_METHOD("get_as_text", "skip_cr"), &FileAccess::get_as_text, DEFVAL(false));
  709. ClassDB::bind_static_method("FileAccess", D_METHOD("get_md5", "path"), &FileAccess::get_md5);
  710. ClassDB::bind_static_method("FileAccess", D_METHOD("get_sha256", "path"), &FileAccess::get_sha256);
  711. ClassDB::bind_method(D_METHOD("is_big_endian"), &FileAccess::is_big_endian);
  712. ClassDB::bind_method(D_METHOD("set_big_endian", "big_endian"), &FileAccess::set_big_endian);
  713. ClassDB::bind_method(D_METHOD("get_error"), &FileAccess::get_error);
  714. ClassDB::bind_method(D_METHOD("get_var", "allow_objects"), &FileAccess::get_var, DEFVAL(false));
  715. ClassDB::bind_method(D_METHOD("store_8", "value"), &FileAccess::store_8);
  716. ClassDB::bind_method(D_METHOD("store_16", "value"), &FileAccess::store_16);
  717. ClassDB::bind_method(D_METHOD("store_32", "value"), &FileAccess::store_32);
  718. ClassDB::bind_method(D_METHOD("store_64", "value"), &FileAccess::store_64);
  719. ClassDB::bind_method(D_METHOD("store_float", "value"), &FileAccess::store_float);
  720. ClassDB::bind_method(D_METHOD("store_double", "value"), &FileAccess::store_double);
  721. ClassDB::bind_method(D_METHOD("store_real", "value"), &FileAccess::store_real);
  722. ClassDB::bind_method(D_METHOD("store_buffer", "buffer"), (void(FileAccess::*)(const Vector<uint8_t> &)) & FileAccess::store_buffer);
  723. ClassDB::bind_method(D_METHOD("store_line", "line"), &FileAccess::store_line);
  724. ClassDB::bind_method(D_METHOD("store_csv_line", "values", "delim"), &FileAccess::store_csv_line, DEFVAL(","));
  725. ClassDB::bind_method(D_METHOD("store_string", "string"), &FileAccess::store_string);
  726. ClassDB::bind_method(D_METHOD("store_var", "value", "full_objects"), &FileAccess::store_var, DEFVAL(false));
  727. ClassDB::bind_method(D_METHOD("store_pascal_string", "string"), &FileAccess::store_pascal_string);
  728. ClassDB::bind_method(D_METHOD("get_pascal_string"), &FileAccess::get_pascal_string);
  729. ClassDB::bind_method(D_METHOD("close"), &FileAccess::close);
  730. ClassDB::bind_static_method("FileAccess", D_METHOD("file_exists", "path"), &FileAccess::exists);
  731. ClassDB::bind_static_method("FileAccess", D_METHOD("get_modified_time", "file"), &FileAccess::get_modified_time);
  732. ClassDB::bind_static_method("FileAccess", D_METHOD("get_unix_permissions", "file"), &FileAccess::get_unix_permissions);
  733. ClassDB::bind_static_method("FileAccess", D_METHOD("set_unix_permissions", "file", "permissions"), &FileAccess::set_unix_permissions);
  734. ClassDB::bind_static_method("FileAccess", D_METHOD("get_hidden_attribute", "file"), &FileAccess::get_hidden_attribute);
  735. ClassDB::bind_static_method("FileAccess", D_METHOD("set_hidden_attribute", "file", "hidden"), &FileAccess::set_hidden_attribute);
  736. ClassDB::bind_static_method("FileAccess", D_METHOD("set_read_only_attribute", "file", "ro"), &FileAccess::set_read_only_attribute);
  737. ClassDB::bind_static_method("FileAccess", D_METHOD("get_read_only_attribute", "file"), &FileAccess::get_read_only_attribute);
  738. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "big_endian"), "set_big_endian", "is_big_endian");
  739. BIND_ENUM_CONSTANT(READ);
  740. BIND_ENUM_CONSTANT(WRITE);
  741. BIND_ENUM_CONSTANT(READ_WRITE);
  742. BIND_ENUM_CONSTANT(WRITE_READ);
  743. BIND_ENUM_CONSTANT(COMPRESSION_FASTLZ);
  744. BIND_ENUM_CONSTANT(COMPRESSION_DEFLATE);
  745. BIND_ENUM_CONSTANT(COMPRESSION_ZSTD);
  746. BIND_ENUM_CONSTANT(COMPRESSION_GZIP);
  747. BIND_ENUM_CONSTANT(COMPRESSION_BROTLI);
  748. BIND_BITFIELD_FLAG(UNIX_READ_OWNER);
  749. BIND_BITFIELD_FLAG(UNIX_WRITE_OWNER);
  750. BIND_BITFIELD_FLAG(UNIX_EXECUTE_OWNER);
  751. BIND_BITFIELD_FLAG(UNIX_READ_GROUP);
  752. BIND_BITFIELD_FLAG(UNIX_WRITE_GROUP);
  753. BIND_BITFIELD_FLAG(UNIX_EXECUTE_GROUP);
  754. BIND_BITFIELD_FLAG(UNIX_READ_OTHER);
  755. BIND_BITFIELD_FLAG(UNIX_WRITE_OTHER);
  756. BIND_BITFIELD_FLAG(UNIX_EXECUTE_OTHER);
  757. BIND_BITFIELD_FLAG(UNIX_SET_USER_ID);
  758. BIND_BITFIELD_FLAG(UNIX_SET_GROUP_ID);
  759. BIND_BITFIELD_FLAG(UNIX_RESTRICTED_DELETE);
  760. }