godot/drivers/unix/file_access_unix.cpp

346 lines
8.6 KiB
C++
Raw Normal View History

2014-02-10 01:10:30 +00:00
/*************************************************************************/
/* file_access_unix.cpp */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
2014-02-10 01:10:30 +00:00
/*************************************************************************/
/* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md). */
2014-02-10 01:10:30 +00:00
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/*************************************************************************/
2014-02-10 01:10:30 +00:00
#include "file_access_unix.h"
#if defined(UNIX_ENABLED) || defined(LIBC_FILEIO_ENABLED)
#include "core/os/os.h"
#include "core/print_string.h"
#include <sys/stat.h>
#include <sys/types.h>
2014-02-10 01:10:30 +00:00
#include <errno.h>
#if defined(UNIX_ENABLED)
#include <unistd.h>
#endif
2014-02-10 01:10:30 +00:00
#ifndef ANDROID_ENABLED
#include <sys/statvfs.h>
#endif
#ifdef MSVC
#define S_ISREG(m) ((m)&_S_IFREG)
#include <io.h>
2014-02-10 01:10:30 +00:00
#endif
#ifndef S_ISREG
#define S_ISREG(m) ((m)&S_IFREG)
2014-02-10 01:10:30 +00:00
#endif
#ifndef NO_FCNTL
#include <fcntl.h>
#else
#include <sys/ioctl.h>
#endif
2014-02-10 01:10:30 +00:00
void FileAccessUnix::check_errors() const {
2019-09-25 08:28:50 +00:00
ERR_FAIL_COND_MSG(!f, "File must be opened before use.");
2014-02-10 01:10:30 +00:00
if (feof(f)) {
last_error = ERR_FILE_EOF;
2014-02-10 01:10:30 +00:00
}
}
Error FileAccessUnix::_open(const String &p_path, int p_mode_flags) {
if (f) {
2014-02-10 01:10:30 +00:00
fclose(f);
}
2020-04-01 23:20:12 +00:00
f = nullptr;
2014-02-10 01:10:30 +00:00
path_src = p_path;
path = fix_path(p_path);
//printf("opening %ls, %i\n", path.c_str(), Memory::get_static_mem_usage());
2014-02-10 01:10:30 +00:00
2019-09-25 08:28:50 +00:00
ERR_FAIL_COND_V_MSG(f, ERR_ALREADY_IN_USE, "File is already in use.");
const char *mode_string;
if (p_mode_flags == READ) {
mode_string = "rb";
} else if (p_mode_flags == WRITE) {
mode_string = "wb";
} else if (p_mode_flags == READ_WRITE) {
mode_string = "rb+";
} else if (p_mode_flags == WRITE_READ) {
mode_string = "wb+";
} else {
2014-02-10 01:10:30 +00:00
return ERR_INVALID_PARAMETER;
}
2014-02-10 01:10:30 +00:00
/* pretty much every implementation that uses fopen as primary
backend (unix-compatible mostly) supports utf8 encoding */
//printf("opening %s as %s\n", p_path.utf8().get_data(), path.utf8().get_data());
struct stat st;
int err = stat(path.utf8().get_data(), &st);
if (!err) {
switch (st.st_mode & S_IFMT) {
case S_IFLNK:
case S_IFREG:
break;
default:
return ERR_FILE_CANT_OPEN;
}
}
2014-02-10 01:10:30 +00:00
if (is_backup_save_enabled() && (p_mode_flags & WRITE) && !(p_mode_flags & READ)) {
save_path = path;
path = path + ".tmp";
2014-02-10 01:10:30 +00:00
}
f = fopen(path.utf8().get_data(), mode_string);
2014-02-10 01:10:30 +00:00
2020-04-01 23:20:12 +00:00
if (f == nullptr) {
switch (errno) {
case ENOENT: {
last_error = ERR_FILE_NOT_FOUND;
} break;
default: {
last_error = ERR_FILE_CANT_OPEN;
} break;
}
return last_error;
2014-02-10 01:10:30 +00:00
}
// Set close on exec to avoid leaking it to subprocesses.
int fd = fileno(f);
if (fd != -1) {
#if defined(NO_FCNTL)
unsigned long par = 0;
ioctl(fd, FIOCLEX, &par);
#else
int opts = fcntl(fd, F_GETFD);
fcntl(fd, F_SETFD, opts | FD_CLOEXEC);
#endif
}
last_error = OK;
flags = p_mode_flags;
return OK;
2014-02-10 01:10:30 +00:00
}
2014-02-10 01:10:30 +00:00
void FileAccessUnix::close() {
if (!f) {
2014-02-10 01:10:30 +00:00
return;
}
2014-02-10 01:10:30 +00:00
fclose(f);
2020-04-01 23:20:12 +00:00
f = nullptr;
if (close_notification_func) {
close_notification_func(path, flags);
}
if (save_path != "") {
int rename_error = rename((save_path + ".tmp").utf8().get_data(), save_path.utf8().get_data());
if (rename_error && close_fail_notify) {
close_fail_notify(save_path);
}
save_path = "";
ERR_FAIL_COND(rename_error != 0);
2014-02-10 01:10:30 +00:00
}
}
bool FileAccessUnix::is_open() const {
2020-04-01 23:20:12 +00:00
return (f != nullptr);
2014-02-10 01:10:30 +00:00
}
String FileAccessUnix::get_path() const {
return path_src;
}
String FileAccessUnix::get_path_absolute() const {
return path;
}
2014-02-10 01:10:30 +00:00
void FileAccessUnix::seek(size_t p_position) {
2019-09-25 08:28:50 +00:00
ERR_FAIL_COND_MSG(!f, "File must be opened before use.");
2014-02-10 01:10:30 +00:00
last_error = OK;
if (fseek(f, p_position, SEEK_SET)) {
2014-02-10 01:10:30 +00:00
check_errors();
}
2014-02-10 01:10:30 +00:00
}
void FileAccessUnix::seek_end(int64_t p_position) {
2019-09-25 08:28:50 +00:00
ERR_FAIL_COND_MSG(!f, "File must be opened before use.");
if (fseek(f, p_position, SEEK_END)) {
2014-02-10 01:10:30 +00:00
check_errors();
}
2014-02-10 01:10:30 +00:00
}
size_t FileAccessUnix::get_position() const {
2019-09-25 08:28:50 +00:00
ERR_FAIL_COND_V_MSG(!f, 0, "File must be opened before use.");
long pos = ftell(f);
if (pos < 0) {
2014-02-10 01:10:30 +00:00
check_errors();
ERR_FAIL_V(0);
}
return pos;
2014-02-10 01:10:30 +00:00
}
size_t FileAccessUnix::get_len() const {
2019-09-25 08:28:50 +00:00
ERR_FAIL_COND_V_MSG(!f, 0, "File must be opened before use.");
2014-02-10 01:10:30 +00:00
long pos = ftell(f);
ERR_FAIL_COND_V(pos < 0, 0);
ERR_FAIL_COND_V(fseek(f, 0, SEEK_END), 0);
long size = ftell(f);
ERR_FAIL_COND_V(size < 0, 0);
ERR_FAIL_COND_V(fseek(f, pos, SEEK_SET), 0);
2014-02-10 01:10:30 +00:00
return size;
}
bool FileAccessUnix::eof_reached() const {
return last_error == ERR_FILE_EOF;
2014-02-10 01:10:30 +00:00
}
uint8_t FileAccessUnix::get_8() const {
2019-09-25 08:28:50 +00:00
ERR_FAIL_COND_V_MSG(!f, 0, "File must be opened before use.");
2014-02-10 01:10:30 +00:00
uint8_t b;
if (fread(&b, 1, 1, f) == 0) {
2014-02-10 01:10:30 +00:00
check_errors();
b = '\0';
}
2014-02-10 01:10:30 +00:00
return b;
}
int FileAccessUnix::get_buffer(uint8_t *p_dst, int p_length) const {
2019-09-25 08:28:50 +00:00
ERR_FAIL_COND_V_MSG(!f, -1, "File must be opened before use.");
2014-02-10 01:10:30 +00:00
int read = fread(p_dst, 1, p_length, f);
check_errors();
return read;
};
Error FileAccessUnix::get_error() const {
2014-02-10 01:10:30 +00:00
return last_error;
}
void FileAccessUnix::flush() {
2019-09-25 08:28:50 +00:00
ERR_FAIL_COND_MSG(!f, "File must be opened before use.");
fflush(f);
}
2014-02-10 01:10:30 +00:00
void FileAccessUnix::store_8(uint8_t p_dest) {
2019-09-25 08:28:50 +00:00
ERR_FAIL_COND_MSG(!f, "File must be opened before use.");
ERR_FAIL_COND(fwrite(&p_dest, 1, 1, f) != 1);
2014-02-10 01:10:30 +00:00
}
void FileAccessUnix::store_buffer(const uint8_t *p_src, int p_length) {
2019-09-25 08:28:50 +00:00
ERR_FAIL_COND_MSG(!f, "File must be opened before use.");
ERR_FAIL_COND(!p_src);
ERR_FAIL_COND((int)fwrite(p_src, 1, p_length, f) != p_length);
}
2014-02-10 01:10:30 +00:00
bool FileAccessUnix::file_exists(const String &p_path) {
int err;
struct stat st;
String filename = fix_path(p_path);
2014-02-10 01:10:30 +00:00
// Does the name exist at all?
err = stat(filename.utf8().get_data(), &st);
if (err) {
2014-02-10 01:10:30 +00:00
return false;
}
2014-02-10 01:10:30 +00:00
#ifdef UNIX_ENABLED
// See if we have access to the file
if (access(filename.utf8().get_data(), F_OK)) {
return false;
}
#else
if (_access(filename.utf8().get_data(), 4) == -1)
return false;
#endif
// See if this is a regular file
switch (st.st_mode & S_IFMT) {
case S_IFLNK:
case S_IFREG:
return true;
default:
return false;
2014-02-10 01:10:30 +00:00
}
}
uint64_t FileAccessUnix::_get_modified_time(const String &p_file) {
String file = fix_path(p_file);
2014-02-10 01:10:30 +00:00
struct stat flags;
int err = stat(file.utf8().get_data(), &flags);
2014-02-10 01:10:30 +00:00
if (!err) {
2014-02-10 01:10:30 +00:00
return flags.st_mtime;
} else {
ERR_FAIL_V_MSG(0, "Failed to get modified time for: " + p_file + ".");
2014-02-10 01:10:30 +00:00
};
}
uint32_t FileAccessUnix::_get_unix_permissions(const String &p_file) {
String file = fix_path(p_file);
struct stat flags;
int err = stat(file.utf8().get_data(), &flags);
if (!err) {
return flags.st_mode & 0x7FF; //only permissions
} else {
ERR_FAIL_V_MSG(0, "Failed to get unix permissions for: " + p_file + ".");
};
}
Error FileAccessUnix::_set_unix_permissions(const String &p_file, uint32_t p_permissions) {
String file = fix_path(p_file);
int err = chmod(file.utf8().get_data(), p_permissions);
if (!err) {
return OK;
}
return FAILED;
}
FileAccess *FileAccessUnix::create_libc() {
return memnew(FileAccessUnix);
2014-02-10 01:10:30 +00:00
}
2020-04-01 23:20:12 +00:00
CloseNotificationFunc FileAccessUnix::close_notification_func = nullptr;
2014-02-10 01:10:30 +00:00
FileAccessUnix::~FileAccessUnix() {
close();
}
#endif