file_access.cpp 28 KB

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