file_access.cpp 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909
  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 than 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. uint8_t FileAccess::get_8() const {
  192. uint8_t data = 0;
  193. get_buffer(&data, sizeof(uint8_t));
  194. return data;
  195. }
  196. uint16_t FileAccess::get_16() const {
  197. uint16_t data = 0;
  198. get_buffer(reinterpret_cast<uint8_t *>(&data), sizeof(uint16_t));
  199. if (big_endian) {
  200. data = BSWAP16(data);
  201. }
  202. return data;
  203. }
  204. uint32_t FileAccess::get_32() const {
  205. uint32_t data = 0;
  206. get_buffer(reinterpret_cast<uint8_t *>(&data), sizeof(uint32_t));
  207. if (big_endian) {
  208. data = BSWAP32(data);
  209. }
  210. return data;
  211. }
  212. uint64_t FileAccess::get_64() const {
  213. uint64_t data = 0;
  214. get_buffer(reinterpret_cast<uint8_t *>(&data), sizeof(uint64_t));
  215. if (big_endian) {
  216. data = BSWAP64(data);
  217. }
  218. return data;
  219. }
  220. float FileAccess::get_half() const {
  221. return Math::half_to_float(get_16());
  222. }
  223. float FileAccess::get_float() const {
  224. MarshallFloat m;
  225. m.i = get_32();
  226. return m.f;
  227. }
  228. real_t FileAccess::get_real() const {
  229. if (real_is_double) {
  230. return get_double();
  231. } else {
  232. return get_float();
  233. }
  234. }
  235. Variant FileAccess::get_var(bool p_allow_objects) const {
  236. uint32_t len = get_32();
  237. Vector<uint8_t> buff = get_buffer(len);
  238. ERR_FAIL_COND_V((uint32_t)buff.size() != len, Variant());
  239. const uint8_t *r = buff.ptr();
  240. Variant v;
  241. Error err = decode_variant(v, &r[0], len, nullptr, p_allow_objects);
  242. ERR_FAIL_COND_V_MSG(err != OK, Variant(), "Error when trying to encode Variant.");
  243. return v;
  244. }
  245. double FileAccess::get_double() const {
  246. MarshallDouble m;
  247. m.l = get_64();
  248. return m.d;
  249. }
  250. String FileAccess::get_token() const {
  251. CharString token;
  252. char32_t c = get_8();
  253. while (!eof_reached()) {
  254. if (c <= ' ') {
  255. if (token.length()) {
  256. break;
  257. }
  258. } else {
  259. token += c;
  260. }
  261. c = get_8();
  262. }
  263. return String::utf8(token.get_data());
  264. }
  265. class CharBuffer {
  266. Vector<char> vector;
  267. char stack_buffer[256];
  268. char *buffer = nullptr;
  269. int capacity = 0;
  270. int written = 0;
  271. bool grow() {
  272. if (vector.resize(next_power_of_2(1 + written)) != OK) {
  273. return false;
  274. }
  275. if (buffer == stack_buffer) { // first chunk?
  276. for (int i = 0; i < written; i++) {
  277. vector.write[i] = stack_buffer[i];
  278. }
  279. }
  280. buffer = vector.ptrw();
  281. capacity = vector.size();
  282. ERR_FAIL_COND_V(written >= capacity, false);
  283. return true;
  284. }
  285. public:
  286. _FORCE_INLINE_ CharBuffer() :
  287. buffer(stack_buffer),
  288. capacity(sizeof(stack_buffer) / sizeof(char)) {
  289. }
  290. _FORCE_INLINE_ void push_back(char c) {
  291. if (written >= capacity) {
  292. ERR_FAIL_COND(!grow());
  293. }
  294. buffer[written++] = c;
  295. }
  296. _FORCE_INLINE_ const char *get_data() const {
  297. return buffer;
  298. }
  299. };
  300. String FileAccess::get_line() const {
  301. CharBuffer line;
  302. char32_t c = get_8();
  303. while (!eof_reached()) {
  304. if (c == '\n' || c == '\0') {
  305. line.push_back(0);
  306. return String::utf8(line.get_data());
  307. } else if (c != '\r') {
  308. line.push_back(c);
  309. }
  310. c = get_8();
  311. }
  312. line.push_back(0);
  313. return String::utf8(line.get_data());
  314. }
  315. Vector<String> FileAccess::get_csv_line(const String &p_delim) const {
  316. ERR_FAIL_COND_V_MSG(p_delim.length() != 1, Vector<String>(), "Only single character delimiters are supported to parse CSV lines.");
  317. ERR_FAIL_COND_V_MSG(p_delim[0] == '"', Vector<String>(), "The double quotation mark character (\") is not supported as a delimiter for CSV lines.");
  318. String line;
  319. // CSV can support entries with line breaks as long as they are enclosed
  320. // in double quotes. So our "line" might be more than a single line in the
  321. // text file.
  322. int qc = 0;
  323. do {
  324. if (eof_reached()) {
  325. break;
  326. }
  327. line += get_line() + "\n";
  328. qc = 0;
  329. for (int i = 0; i < line.length(); i++) {
  330. if (line[i] == '"') {
  331. qc++;
  332. }
  333. }
  334. } while (qc % 2);
  335. // Remove the extraneous newline we've added above.
  336. line = line.substr(0, line.length() - 1);
  337. Vector<String> strings;
  338. bool in_quote = false;
  339. String current;
  340. for (int i = 0; i < line.length(); i++) {
  341. char32_t c = line[i];
  342. // A delimiter ends the current entry, unless it's in a quoted string.
  343. if (!in_quote && c == p_delim[0]) {
  344. strings.push_back(current);
  345. current = String();
  346. } else if (c == '"') {
  347. // Doubled quotes are escapes for intentional quotes in the string.
  348. if (line[i + 1] == '"' && in_quote) {
  349. current += '"';
  350. i++;
  351. } else {
  352. in_quote = !in_quote;
  353. }
  354. } else {
  355. current += c;
  356. }
  357. }
  358. if (in_quote) {
  359. WARN_PRINT(vformat("Reached end of file before closing '\"' in CSV file '%s'.", get_path()));
  360. }
  361. strings.push_back(current);
  362. return strings;
  363. }
  364. String FileAccess::get_as_text(bool p_skip_cr) const {
  365. uint64_t original_pos = get_position();
  366. const_cast<FileAccess *>(this)->seek(0);
  367. String text = get_as_utf8_string(p_skip_cr);
  368. const_cast<FileAccess *>(this)->seek(original_pos);
  369. return text;
  370. }
  371. Vector<uint8_t> FileAccess::get_buffer(int64_t p_length) const {
  372. Vector<uint8_t> data;
  373. ERR_FAIL_COND_V_MSG(p_length < 0, data, "Length of buffer cannot be smaller than 0.");
  374. if (p_length == 0) {
  375. return data;
  376. }
  377. Error err = data.resize(p_length);
  378. ERR_FAIL_COND_V_MSG(err != OK, data, vformat("Can't resize data to %d elements.", p_length));
  379. uint8_t *w = data.ptrw();
  380. int64_t len = get_buffer(w, p_length);
  381. if (len < p_length) {
  382. data.resize(len);
  383. }
  384. return data;
  385. }
  386. String FileAccess::get_as_utf8_string(bool p_skip_cr) const {
  387. Vector<uint8_t> sourcef;
  388. uint64_t len = get_length();
  389. sourcef.resize(len + 1);
  390. uint8_t *w = sourcef.ptrw();
  391. uint64_t r = get_buffer(w, len);
  392. ERR_FAIL_COND_V(r != len, String());
  393. w[len] = 0;
  394. String s;
  395. s.parse_utf8((const char *)w, -1, p_skip_cr);
  396. return s;
  397. }
  398. void FileAccess::store_8(uint8_t p_dest) {
  399. store_buffer(&p_dest, sizeof(uint8_t));
  400. }
  401. void FileAccess::store_16(uint16_t p_dest) {
  402. if (big_endian) {
  403. p_dest = BSWAP16(p_dest);
  404. }
  405. store_buffer(reinterpret_cast<uint8_t *>(&p_dest), sizeof(uint16_t));
  406. }
  407. void FileAccess::store_32(uint32_t p_dest) {
  408. if (big_endian) {
  409. p_dest = BSWAP32(p_dest);
  410. }
  411. store_buffer(reinterpret_cast<uint8_t *>(&p_dest), sizeof(uint32_t));
  412. }
  413. void FileAccess::store_64(uint64_t p_dest) {
  414. if (big_endian) {
  415. p_dest = BSWAP64(p_dest);
  416. }
  417. store_buffer(reinterpret_cast<uint8_t *>(&p_dest), sizeof(uint64_t));
  418. }
  419. void FileAccess::store_real(real_t p_real) {
  420. if constexpr (sizeof(real_t) == 4) {
  421. store_float(p_real);
  422. } else {
  423. store_double(p_real);
  424. }
  425. }
  426. void FileAccess::store_half(float p_dest) {
  427. store_16(Math::make_half_float(p_dest));
  428. }
  429. void FileAccess::store_float(float p_dest) {
  430. MarshallFloat m;
  431. m.f = p_dest;
  432. store_32(m.i);
  433. }
  434. void FileAccess::store_double(double p_dest) {
  435. MarshallDouble m;
  436. m.d = p_dest;
  437. store_64(m.l);
  438. }
  439. uint64_t FileAccess::get_modified_time(const String &p_file) {
  440. if (PackedData::get_singleton() && !PackedData::get_singleton()->is_disabled() && (PackedData::get_singleton()->has_path(p_file) || PackedData::get_singleton()->has_directory(p_file))) {
  441. return 0;
  442. }
  443. Ref<FileAccess> fa = create_for_path(p_file);
  444. ERR_FAIL_COND_V_MSG(fa.is_null(), 0, vformat("Cannot create FileAccess for path '%s'.", p_file));
  445. uint64_t mt = fa->_get_modified_time(p_file);
  446. return mt;
  447. }
  448. BitField<FileAccess::UnixPermissionFlags> FileAccess::get_unix_permissions(const String &p_file) {
  449. if (PackedData::get_singleton() && !PackedData::get_singleton()->is_disabled() && (PackedData::get_singleton()->has_path(p_file) || PackedData::get_singleton()->has_directory(p_file))) {
  450. return 0;
  451. }
  452. Ref<FileAccess> fa = create_for_path(p_file);
  453. ERR_FAIL_COND_V_MSG(fa.is_null(), 0, vformat("Cannot create FileAccess for path '%s'.", p_file));
  454. return fa->_get_unix_permissions(p_file);
  455. }
  456. Error FileAccess::set_unix_permissions(const String &p_file, BitField<FileAccess::UnixPermissionFlags> p_permissions) {
  457. if (PackedData::get_singleton() && !PackedData::get_singleton()->is_disabled() && (PackedData::get_singleton()->has_path(p_file) || PackedData::get_singleton()->has_directory(p_file))) {
  458. return ERR_UNAVAILABLE;
  459. }
  460. Ref<FileAccess> fa = create_for_path(p_file);
  461. ERR_FAIL_COND_V_MSG(fa.is_null(), ERR_CANT_CREATE, vformat("Cannot create FileAccess for path '%s'.", p_file));
  462. Error err = fa->_set_unix_permissions(p_file, p_permissions);
  463. return err;
  464. }
  465. bool FileAccess::get_hidden_attribute(const String &p_file) {
  466. if (PackedData::get_singleton() && !PackedData::get_singleton()->is_disabled() && (PackedData::get_singleton()->has_path(p_file) || PackedData::get_singleton()->has_directory(p_file))) {
  467. return false;
  468. }
  469. Ref<FileAccess> fa = create_for_path(p_file);
  470. ERR_FAIL_COND_V_MSG(fa.is_null(), false, vformat("Cannot create FileAccess for path '%s'.", p_file));
  471. return fa->_get_hidden_attribute(p_file);
  472. }
  473. Error FileAccess::set_hidden_attribute(const String &p_file, bool p_hidden) {
  474. if (PackedData::get_singleton() && !PackedData::get_singleton()->is_disabled() && (PackedData::get_singleton()->has_path(p_file) || PackedData::get_singleton()->has_directory(p_file))) {
  475. return ERR_UNAVAILABLE;
  476. }
  477. Ref<FileAccess> fa = create_for_path(p_file);
  478. ERR_FAIL_COND_V_MSG(fa.is_null(), ERR_CANT_CREATE, vformat("Cannot create FileAccess for path '%s'.", p_file));
  479. Error err = fa->_set_hidden_attribute(p_file, p_hidden);
  480. return err;
  481. }
  482. bool FileAccess::get_read_only_attribute(const String &p_file) {
  483. if (PackedData::get_singleton() && !PackedData::get_singleton()->is_disabled() && (PackedData::get_singleton()->has_path(p_file) || PackedData::get_singleton()->has_directory(p_file))) {
  484. return false;
  485. }
  486. Ref<FileAccess> fa = create_for_path(p_file);
  487. ERR_FAIL_COND_V_MSG(fa.is_null(), false, vformat("Cannot create FileAccess for path '%s'.", p_file));
  488. return fa->_get_read_only_attribute(p_file);
  489. }
  490. Error FileAccess::set_read_only_attribute(const String &p_file, bool p_ro) {
  491. if (PackedData::get_singleton() && !PackedData::get_singleton()->is_disabled() && (PackedData::get_singleton()->has_path(p_file) || PackedData::get_singleton()->has_directory(p_file))) {
  492. return ERR_UNAVAILABLE;
  493. }
  494. Ref<FileAccess> fa = create_for_path(p_file);
  495. ERR_FAIL_COND_V_MSG(fa.is_null(), ERR_CANT_CREATE, vformat("Cannot create FileAccess for path '%s'.", p_file));
  496. Error err = fa->_set_read_only_attribute(p_file, p_ro);
  497. return err;
  498. }
  499. void FileAccess::store_string(const String &p_string) {
  500. if (p_string.length() == 0) {
  501. return;
  502. }
  503. CharString cs = p_string.utf8();
  504. store_buffer((uint8_t *)&cs[0], cs.length());
  505. }
  506. void FileAccess::store_pascal_string(const String &p_string) {
  507. CharString cs = p_string.utf8();
  508. store_32(cs.length());
  509. store_buffer((uint8_t *)&cs[0], cs.length());
  510. }
  511. String FileAccess::get_pascal_string() {
  512. uint32_t sl = get_32();
  513. CharString cs;
  514. cs.resize(sl + 1);
  515. get_buffer((uint8_t *)cs.ptr(), sl);
  516. cs[sl] = 0;
  517. String ret;
  518. ret.parse_utf8(cs.ptr());
  519. return ret;
  520. }
  521. void FileAccess::store_line(const String &p_line) {
  522. store_string(p_line);
  523. store_8('\n');
  524. }
  525. void FileAccess::store_csv_line(const Vector<String> &p_values, const String &p_delim) {
  526. ERR_FAIL_COND(p_delim.length() != 1);
  527. String line = "";
  528. int size = p_values.size();
  529. for (int i = 0; i < size; ++i) {
  530. String value = p_values[i];
  531. if (value.contains("\"") || value.contains(p_delim) || value.contains("\n")) {
  532. value = "\"" + value.replace("\"", "\"\"") + "\"";
  533. }
  534. if (i < size - 1) {
  535. value += p_delim;
  536. }
  537. line += value;
  538. }
  539. store_line(line);
  540. }
  541. void FileAccess::store_buffer(const Vector<uint8_t> &p_buffer) {
  542. uint64_t len = p_buffer.size();
  543. const uint8_t *r = p_buffer.ptr();
  544. store_buffer(r, len);
  545. }
  546. void FileAccess::store_var(const Variant &p_var, bool p_full_objects) {
  547. int len;
  548. Error err = encode_variant(p_var, nullptr, len, p_full_objects);
  549. ERR_FAIL_COND_MSG(err != OK, "Error when trying to encode Variant.");
  550. Vector<uint8_t> buff;
  551. buff.resize(len);
  552. uint8_t *w = buff.ptrw();
  553. err = encode_variant(p_var, &w[0], len, p_full_objects);
  554. ERR_FAIL_COND_MSG(err != OK, "Error when trying to encode Variant.");
  555. store_32(len);
  556. store_buffer(buff);
  557. }
  558. Vector<uint8_t> FileAccess::get_file_as_bytes(const String &p_path, Error *r_error) {
  559. Ref<FileAccess> f = FileAccess::open(p_path, READ, r_error);
  560. if (f.is_null()) {
  561. if (r_error) { // if error requested, do not throw error
  562. return Vector<uint8_t>();
  563. }
  564. ERR_FAIL_V_MSG(Vector<uint8_t>(), vformat("Can't open file from path '%s'.", String(p_path)));
  565. }
  566. Vector<uint8_t> data;
  567. data.resize(f->get_length());
  568. f->get_buffer(data.ptrw(), data.size());
  569. return data;
  570. }
  571. String FileAccess::get_file_as_string(const String &p_path, Error *r_error) {
  572. Error err;
  573. Vector<uint8_t> array = get_file_as_bytes(p_path, &err);
  574. if (r_error) {
  575. *r_error = err;
  576. }
  577. if (err != OK) {
  578. if (r_error) {
  579. return String();
  580. }
  581. ERR_FAIL_V_MSG(String(), vformat("Can't get file as string from path '%s'.", String(p_path)));
  582. }
  583. String ret;
  584. ret.parse_utf8((const char *)array.ptr(), array.size());
  585. return ret;
  586. }
  587. String FileAccess::get_md5(const String &p_file) {
  588. Ref<FileAccess> f = FileAccess::open(p_file, READ);
  589. if (f.is_null()) {
  590. return String();
  591. }
  592. CryptoCore::MD5Context ctx;
  593. ctx.start();
  594. unsigned char step[32768];
  595. while (true) {
  596. uint64_t br = f->get_buffer(step, 32768);
  597. if (br > 0) {
  598. ctx.update(step, br);
  599. }
  600. if (br < 4096) {
  601. break;
  602. }
  603. }
  604. unsigned char hash[16];
  605. ctx.finish(hash);
  606. return String::md5(hash);
  607. }
  608. String FileAccess::get_multiple_md5(const Vector<String> &p_file) {
  609. CryptoCore::MD5Context ctx;
  610. ctx.start();
  611. for (int i = 0; i < p_file.size(); i++) {
  612. Ref<FileAccess> f = FileAccess::open(p_file[i], READ);
  613. ERR_CONTINUE(f.is_null());
  614. unsigned char step[32768];
  615. while (true) {
  616. uint64_t br = f->get_buffer(step, 32768);
  617. if (br > 0) {
  618. ctx.update(step, br);
  619. }
  620. if (br < 4096) {
  621. break;
  622. }
  623. }
  624. }
  625. unsigned char hash[16];
  626. ctx.finish(hash);
  627. return String::md5(hash);
  628. }
  629. String FileAccess::get_sha256(const String &p_file) {
  630. Ref<FileAccess> f = FileAccess::open(p_file, READ);
  631. if (f.is_null()) {
  632. return String();
  633. }
  634. CryptoCore::SHA256Context ctx;
  635. ctx.start();
  636. unsigned char step[32768];
  637. while (true) {
  638. uint64_t br = f->get_buffer(step, 32768);
  639. if (br > 0) {
  640. ctx.update(step, br);
  641. }
  642. if (br < 4096) {
  643. break;
  644. }
  645. }
  646. unsigned char hash[32];
  647. ctx.finish(hash);
  648. return String::hex_encode_buffer(hash, 32);
  649. }
  650. void FileAccess::_bind_methods() {
  651. ClassDB::bind_static_method("FileAccess", D_METHOD("open", "path", "flags"), &FileAccess::_open);
  652. ClassDB::bind_static_method("FileAccess", D_METHOD("open_encrypted", "path", "mode_flags", "key"), &FileAccess::open_encrypted);
  653. ClassDB::bind_static_method("FileAccess", D_METHOD("open_encrypted_with_pass", "path", "mode_flags", "pass"), &FileAccess::open_encrypted_pass);
  654. ClassDB::bind_static_method("FileAccess", D_METHOD("open_compressed", "path", "mode_flags", "compression_mode"), &FileAccess::open_compressed, DEFVAL(0));
  655. ClassDB::bind_static_method("FileAccess", D_METHOD("get_open_error"), &FileAccess::get_open_error);
  656. ClassDB::bind_static_method("FileAccess", D_METHOD("get_file_as_bytes", "path"), &FileAccess::_get_file_as_bytes);
  657. ClassDB::bind_static_method("FileAccess", D_METHOD("get_file_as_string", "path"), &FileAccess::_get_file_as_string);
  658. ClassDB::bind_method(D_METHOD("resize", "length"), &FileAccess::resize);
  659. ClassDB::bind_method(D_METHOD("flush"), &FileAccess::flush);
  660. ClassDB::bind_method(D_METHOD("get_path"), &FileAccess::get_path);
  661. ClassDB::bind_method(D_METHOD("get_path_absolute"), &FileAccess::get_path_absolute);
  662. ClassDB::bind_method(D_METHOD("is_open"), &FileAccess::is_open);
  663. ClassDB::bind_method(D_METHOD("seek", "position"), &FileAccess::seek);
  664. ClassDB::bind_method(D_METHOD("seek_end", "position"), &FileAccess::seek_end, DEFVAL(0));
  665. ClassDB::bind_method(D_METHOD("get_position"), &FileAccess::get_position);
  666. ClassDB::bind_method(D_METHOD("get_length"), &FileAccess::get_length);
  667. ClassDB::bind_method(D_METHOD("eof_reached"), &FileAccess::eof_reached);
  668. ClassDB::bind_method(D_METHOD("get_8"), &FileAccess::get_8);
  669. ClassDB::bind_method(D_METHOD("get_16"), &FileAccess::get_16);
  670. ClassDB::bind_method(D_METHOD("get_32"), &FileAccess::get_32);
  671. ClassDB::bind_method(D_METHOD("get_64"), &FileAccess::get_64);
  672. ClassDB::bind_method(D_METHOD("get_half"), &FileAccess::get_half);
  673. ClassDB::bind_method(D_METHOD("get_float"), &FileAccess::get_float);
  674. ClassDB::bind_method(D_METHOD("get_double"), &FileAccess::get_double);
  675. ClassDB::bind_method(D_METHOD("get_real"), &FileAccess::get_real);
  676. ClassDB::bind_method(D_METHOD("get_buffer", "length"), (Vector<uint8_t>(FileAccess::*)(int64_t) const) & FileAccess::get_buffer);
  677. ClassDB::bind_method(D_METHOD("get_line"), &FileAccess::get_line);
  678. ClassDB::bind_method(D_METHOD("get_csv_line", "delim"), &FileAccess::get_csv_line, DEFVAL(","));
  679. ClassDB::bind_method(D_METHOD("get_as_text", "skip_cr"), &FileAccess::get_as_text, DEFVAL(false));
  680. ClassDB::bind_static_method("FileAccess", D_METHOD("get_md5", "path"), &FileAccess::get_md5);
  681. ClassDB::bind_static_method("FileAccess", D_METHOD("get_sha256", "path"), &FileAccess::get_sha256);
  682. ClassDB::bind_method(D_METHOD("is_big_endian"), &FileAccess::is_big_endian);
  683. ClassDB::bind_method(D_METHOD("set_big_endian", "big_endian"), &FileAccess::set_big_endian);
  684. ClassDB::bind_method(D_METHOD("get_error"), &FileAccess::get_error);
  685. ClassDB::bind_method(D_METHOD("get_var", "allow_objects"), &FileAccess::get_var, DEFVAL(false));
  686. ClassDB::bind_method(D_METHOD("store_8", "value"), &FileAccess::store_8);
  687. ClassDB::bind_method(D_METHOD("store_16", "value"), &FileAccess::store_16);
  688. ClassDB::bind_method(D_METHOD("store_32", "value"), &FileAccess::store_32);
  689. ClassDB::bind_method(D_METHOD("store_64", "value"), &FileAccess::store_64);
  690. ClassDB::bind_method(D_METHOD("store_half", "value"), &FileAccess::store_half);
  691. ClassDB::bind_method(D_METHOD("store_float", "value"), &FileAccess::store_float);
  692. ClassDB::bind_method(D_METHOD("store_double", "value"), &FileAccess::store_double);
  693. ClassDB::bind_method(D_METHOD("store_real", "value"), &FileAccess::store_real);
  694. ClassDB::bind_method(D_METHOD("store_buffer", "buffer"), (void(FileAccess::*)(const Vector<uint8_t> &)) & FileAccess::store_buffer);
  695. ClassDB::bind_method(D_METHOD("store_line", "line"), &FileAccess::store_line);
  696. ClassDB::bind_method(D_METHOD("store_csv_line", "values", "delim"), &FileAccess::store_csv_line, DEFVAL(","));
  697. ClassDB::bind_method(D_METHOD("store_string", "string"), &FileAccess::store_string);
  698. ClassDB::bind_method(D_METHOD("store_var", "value", "full_objects"), &FileAccess::store_var, DEFVAL(false));
  699. ClassDB::bind_method(D_METHOD("store_pascal_string", "string"), &FileAccess::store_pascal_string);
  700. ClassDB::bind_method(D_METHOD("get_pascal_string"), &FileAccess::get_pascal_string);
  701. ClassDB::bind_method(D_METHOD("close"), &FileAccess::close);
  702. ClassDB::bind_static_method("FileAccess", D_METHOD("file_exists", "path"), &FileAccess::exists);
  703. ClassDB::bind_static_method("FileAccess", D_METHOD("get_modified_time", "file"), &FileAccess::get_modified_time);
  704. ClassDB::bind_static_method("FileAccess", D_METHOD("get_unix_permissions", "file"), &FileAccess::get_unix_permissions);
  705. ClassDB::bind_static_method("FileAccess", D_METHOD("set_unix_permissions", "file", "permissions"), &FileAccess::set_unix_permissions);
  706. ClassDB::bind_static_method("FileAccess", D_METHOD("get_hidden_attribute", "file"), &FileAccess::get_hidden_attribute);
  707. ClassDB::bind_static_method("FileAccess", D_METHOD("set_hidden_attribute", "file", "hidden"), &FileAccess::set_hidden_attribute);
  708. ClassDB::bind_static_method("FileAccess", D_METHOD("set_read_only_attribute", "file", "ro"), &FileAccess::set_read_only_attribute);
  709. ClassDB::bind_static_method("FileAccess", D_METHOD("get_read_only_attribute", "file"), &FileAccess::get_read_only_attribute);
  710. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "big_endian"), "set_big_endian", "is_big_endian");
  711. BIND_ENUM_CONSTANT(READ);
  712. BIND_ENUM_CONSTANT(WRITE);
  713. BIND_ENUM_CONSTANT(READ_WRITE);
  714. BIND_ENUM_CONSTANT(WRITE_READ);
  715. BIND_ENUM_CONSTANT(COMPRESSION_FASTLZ);
  716. BIND_ENUM_CONSTANT(COMPRESSION_DEFLATE);
  717. BIND_ENUM_CONSTANT(COMPRESSION_ZSTD);
  718. BIND_ENUM_CONSTANT(COMPRESSION_GZIP);
  719. BIND_ENUM_CONSTANT(COMPRESSION_BROTLI);
  720. BIND_BITFIELD_FLAG(UNIX_READ_OWNER);
  721. BIND_BITFIELD_FLAG(UNIX_WRITE_OWNER);
  722. BIND_BITFIELD_FLAG(UNIX_EXECUTE_OWNER);
  723. BIND_BITFIELD_FLAG(UNIX_READ_GROUP);
  724. BIND_BITFIELD_FLAG(UNIX_WRITE_GROUP);
  725. BIND_BITFIELD_FLAG(UNIX_EXECUTE_GROUP);
  726. BIND_BITFIELD_FLAG(UNIX_READ_OTHER);
  727. BIND_BITFIELD_FLAG(UNIX_WRITE_OTHER);
  728. BIND_BITFIELD_FLAG(UNIX_EXECUTE_OTHER);
  729. BIND_BITFIELD_FLAG(UNIX_SET_USER_ID);
  730. BIND_BITFIELD_FLAG(UNIX_SET_GROUP_ID);
  731. BIND_BITFIELD_FLAG(UNIX_RESTRICTED_DELETE);
  732. }