mirror of
https://github.com/godotengine/godot
synced 2024-11-02 08:18:44 +00:00
d95794ec8a
As many open source projects have started doing it, we're removing the current year from the copyright notice, so that we don't need to bump it every year. It seems like only the first year of publication is technically relevant for copyright notices, and even that seems to be something that many companies stopped listing altogether (in a version controlled codebase, the commits are a much better source of date of publication than a hardcoded copyright statement). We also now list Godot Engine contributors first as we're collectively the current maintainers of the project, and we clarify that the "exclusive" copyright of the co-founders covers the timespan before opensourcing (their further contributions are included as part of Godot Engine contributors). Also fixed "cf." Frenchism - it's meant as "refer to / see".
511 lines
13 KiB
C++
511 lines
13 KiB
C++
/**************************************************************************/
|
|
/* dir_access_unix.cpp */
|
|
/**************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/**************************************************************************/
|
|
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
|
|
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
|
|
/* */
|
|
/* Permission is hereby granted, free of charge, to any person obtaining */
|
|
/* a copy of this software and associated documentation files (the */
|
|
/* "Software"), to deal in the Software without restriction, including */
|
|
/* without limitation the rights to use, copy, modify, merge, publish, */
|
|
/* distribute, sublicense, and/or sell copies of the Software, and to */
|
|
/* permit persons to whom the Software is furnished to do so, subject to */
|
|
/* the following conditions: */
|
|
/* */
|
|
/* The above copyright notice and this permission notice shall be */
|
|
/* included in all copies or substantial portions of the Software. */
|
|
/* */
|
|
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
|
|
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
|
|
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
|
|
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
|
|
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
|
|
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
|
|
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
|
|
/**************************************************************************/
|
|
|
|
#include "dir_access_unix.h"
|
|
|
|
#if defined(UNIX_ENABLED)
|
|
|
|
#include "core/os/memory.h"
|
|
#include "core/os/os.h"
|
|
#include "core/string/print_string.h"
|
|
#include "core/templates/list.h"
|
|
|
|
#include <errno.h>
|
|
#include <stdio.h>
|
|
#include <stdlib.h>
|
|
#include <string.h>
|
|
#include <sys/statvfs.h>
|
|
|
|
#ifdef HAVE_MNTENT
|
|
#include <mntent.h>
|
|
#endif
|
|
|
|
Error DirAccessUnix::list_dir_begin() {
|
|
list_dir_end(); //close any previous dir opening!
|
|
|
|
//char real_current_dir_name[2048]; //is this enough?!
|
|
//getcwd(real_current_dir_name,2048);
|
|
//chdir(current_path.utf8().get_data());
|
|
dir_stream = opendir(current_dir.utf8().get_data());
|
|
//chdir(real_current_dir_name);
|
|
if (!dir_stream) {
|
|
return ERR_CANT_OPEN; //error!
|
|
}
|
|
|
|
return OK;
|
|
}
|
|
|
|
bool DirAccessUnix::file_exists(String p_file) {
|
|
GLOBAL_LOCK_FUNCTION
|
|
|
|
if (p_file.is_relative_path()) {
|
|
p_file = current_dir.path_join(p_file);
|
|
}
|
|
|
|
p_file = fix_path(p_file);
|
|
|
|
struct stat flags = {};
|
|
bool success = (stat(p_file.utf8().get_data(), &flags) == 0);
|
|
|
|
if (success && S_ISDIR(flags.st_mode)) {
|
|
success = false;
|
|
}
|
|
|
|
return success;
|
|
}
|
|
|
|
bool DirAccessUnix::dir_exists(String p_dir) {
|
|
GLOBAL_LOCK_FUNCTION
|
|
|
|
if (p_dir.is_relative_path()) {
|
|
p_dir = get_current_dir().path_join(p_dir);
|
|
}
|
|
|
|
p_dir = fix_path(p_dir);
|
|
|
|
struct stat flags = {};
|
|
bool success = (stat(p_dir.utf8().get_data(), &flags) == 0);
|
|
|
|
return (success && S_ISDIR(flags.st_mode));
|
|
}
|
|
|
|
bool DirAccessUnix::is_readable(String p_dir) {
|
|
GLOBAL_LOCK_FUNCTION
|
|
|
|
if (p_dir.is_relative_path()) {
|
|
p_dir = get_current_dir().path_join(p_dir);
|
|
}
|
|
|
|
p_dir = fix_path(p_dir);
|
|
return (access(p_dir.utf8().get_data(), R_OK) == 0);
|
|
}
|
|
|
|
bool DirAccessUnix::is_writable(String p_dir) {
|
|
GLOBAL_LOCK_FUNCTION
|
|
|
|
if (p_dir.is_relative_path()) {
|
|
p_dir = get_current_dir().path_join(p_dir);
|
|
}
|
|
|
|
p_dir = fix_path(p_dir);
|
|
return (access(p_dir.utf8().get_data(), W_OK) == 0);
|
|
}
|
|
|
|
uint64_t DirAccessUnix::get_modified_time(String p_file) {
|
|
if (p_file.is_relative_path()) {
|
|
p_file = current_dir.path_join(p_file);
|
|
}
|
|
|
|
p_file = fix_path(p_file);
|
|
|
|
struct stat flags = {};
|
|
bool success = (stat(p_file.utf8().get_data(), &flags) == 0);
|
|
|
|
if (success) {
|
|
return flags.st_mtime;
|
|
} else {
|
|
ERR_FAIL_V(0);
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
String DirAccessUnix::get_next() {
|
|
if (!dir_stream) {
|
|
return "";
|
|
}
|
|
|
|
dirent *entry = readdir(dir_stream);
|
|
|
|
if (entry == nullptr) {
|
|
list_dir_end();
|
|
return "";
|
|
}
|
|
|
|
String fname = fix_unicode_name(entry->d_name);
|
|
|
|
// Look at d_type to determine if the entry is a directory, unless
|
|
// its type is unknown (the file system does not support it) or if
|
|
// the type is a link, in that case we want to resolve the link to
|
|
// known if it points to a directory. stat() will resolve the link
|
|
// for us.
|
|
if (entry->d_type == DT_UNKNOWN || entry->d_type == DT_LNK) {
|
|
String f = current_dir.path_join(fname);
|
|
|
|
struct stat flags = {};
|
|
if (stat(f.utf8().get_data(), &flags) == 0) {
|
|
_cisdir = S_ISDIR(flags.st_mode);
|
|
} else {
|
|
_cisdir = false;
|
|
}
|
|
} else {
|
|
_cisdir = (entry->d_type == DT_DIR);
|
|
}
|
|
|
|
_cishidden = is_hidden(fname);
|
|
|
|
return fname;
|
|
}
|
|
|
|
bool DirAccessUnix::current_is_dir() const {
|
|
return _cisdir;
|
|
}
|
|
|
|
bool DirAccessUnix::current_is_hidden() const {
|
|
return _cishidden;
|
|
}
|
|
|
|
void DirAccessUnix::list_dir_end() {
|
|
if (dir_stream) {
|
|
closedir(dir_stream);
|
|
}
|
|
dir_stream = nullptr;
|
|
_cisdir = false;
|
|
}
|
|
|
|
#if defined(HAVE_MNTENT) && defined(X11_ENABLED)
|
|
static bool _filter_drive(struct mntent *mnt) {
|
|
// Ignore devices that don't point to /dev
|
|
if (strncmp(mnt->mnt_fsname, "/dev", 4) != 0) {
|
|
return false;
|
|
}
|
|
|
|
// Accept devices mounted at common locations
|
|
if (strncmp(mnt->mnt_dir, "/media", 6) == 0 ||
|
|
strncmp(mnt->mnt_dir, "/mnt", 4) == 0 ||
|
|
strncmp(mnt->mnt_dir, "/home", 5) == 0 ||
|
|
strncmp(mnt->mnt_dir, "/run/media", 10) == 0) {
|
|
return true;
|
|
}
|
|
|
|
// Ignore everything else
|
|
return false;
|
|
}
|
|
#endif
|
|
|
|
static void _get_drives(List<String> *list) {
|
|
// Add root.
|
|
list->push_back("/");
|
|
|
|
#if defined(HAVE_MNTENT) && defined(X11_ENABLED)
|
|
// Check /etc/mtab for the list of mounted partitions.
|
|
FILE *mtab = setmntent("/etc/mtab", "r");
|
|
if (mtab) {
|
|
struct mntent mnt;
|
|
char strings[4096];
|
|
|
|
while (getmntent_r(mtab, &mnt, strings, sizeof(strings))) {
|
|
if (mnt.mnt_dir != nullptr && _filter_drive(&mnt)) {
|
|
// Avoid duplicates
|
|
String name = String::utf8(mnt.mnt_dir);
|
|
if (!list->find(name)) {
|
|
list->push_back(name);
|
|
}
|
|
}
|
|
}
|
|
|
|
endmntent(mtab);
|
|
}
|
|
#endif
|
|
|
|
// Add $HOME.
|
|
const char *home = getenv("HOME");
|
|
if (home) {
|
|
// Only add if it's not a duplicate
|
|
String home_name = String::utf8(home);
|
|
if (!list->find(home_name)) {
|
|
list->push_back(home_name);
|
|
}
|
|
|
|
// Check GTK+3 bookmarks for both XDG locations (Documents, Downloads, etc.)
|
|
// and potential user-defined bookmarks.
|
|
char path[1024];
|
|
snprintf(path, 1024, "%s/.config/gtk-3.0/bookmarks", home);
|
|
FILE *fd = fopen(path, "r");
|
|
if (fd) {
|
|
char string[1024];
|
|
while (fgets(string, 1024, fd)) {
|
|
// Parse only file:// links
|
|
if (strncmp(string, "file://", 7) == 0) {
|
|
// Strip any unwanted edges on the strings and push_back if it's not a duplicate.
|
|
String fpath = String::utf8(string + 7).strip_edges().split_spaces()[0].uri_decode();
|
|
if (!list->find(fpath)) {
|
|
list->push_back(fpath);
|
|
}
|
|
}
|
|
}
|
|
|
|
fclose(fd);
|
|
}
|
|
|
|
// Add Desktop dir.
|
|
String dpath = OS::get_singleton()->get_system_dir(OS::SystemDir::SYSTEM_DIR_DESKTOP);
|
|
if (dpath.length() > 0 && !list->find(dpath)) {
|
|
list->push_back(dpath);
|
|
}
|
|
}
|
|
|
|
list->sort();
|
|
}
|
|
|
|
int DirAccessUnix::get_drive_count() {
|
|
List<String> list;
|
|
_get_drives(&list);
|
|
|
|
return list.size();
|
|
}
|
|
|
|
String DirAccessUnix::get_drive(int p_drive) {
|
|
List<String> list;
|
|
_get_drives(&list);
|
|
|
|
ERR_FAIL_INDEX_V(p_drive, list.size(), "");
|
|
|
|
return list[p_drive];
|
|
}
|
|
|
|
int DirAccessUnix::get_current_drive() {
|
|
int drive = 0;
|
|
int max_length = -1;
|
|
const String path = get_current_dir().to_lower();
|
|
for (int i = 0; i < get_drive_count(); i++) {
|
|
const String d = get_drive(i).to_lower();
|
|
if (max_length < d.length() && path.begins_with(d)) {
|
|
max_length = d.length();
|
|
drive = i;
|
|
}
|
|
}
|
|
return drive;
|
|
}
|
|
|
|
bool DirAccessUnix::drives_are_shortcuts() {
|
|
return true;
|
|
}
|
|
|
|
Error DirAccessUnix::make_dir(String p_dir) {
|
|
GLOBAL_LOCK_FUNCTION
|
|
|
|
if (p_dir.is_relative_path()) {
|
|
p_dir = get_current_dir().path_join(p_dir);
|
|
}
|
|
|
|
p_dir = fix_path(p_dir);
|
|
|
|
bool success = (mkdir(p_dir.utf8().get_data(), S_IRWXU | S_IRWXG | S_IROTH | S_IXOTH) == 0);
|
|
int err = errno;
|
|
|
|
if (success) {
|
|
return OK;
|
|
}
|
|
|
|
if (err == EEXIST) {
|
|
return ERR_ALREADY_EXISTS;
|
|
}
|
|
|
|
return ERR_CANT_CREATE;
|
|
}
|
|
|
|
Error DirAccessUnix::change_dir(String p_dir) {
|
|
GLOBAL_LOCK_FUNCTION
|
|
|
|
p_dir = fix_path(p_dir);
|
|
|
|
// prev_dir is the directory we are changing out of
|
|
String prev_dir;
|
|
char real_current_dir_name[2048];
|
|
ERR_FAIL_COND_V(getcwd(real_current_dir_name, 2048) == nullptr, ERR_BUG);
|
|
if (prev_dir.parse_utf8(real_current_dir_name) != OK) {
|
|
prev_dir = real_current_dir_name; //no utf8, maybe latin?
|
|
}
|
|
|
|
// try_dir is the directory we are trying to change into
|
|
String try_dir = "";
|
|
if (p_dir.is_relative_path()) {
|
|
String next_dir = current_dir.path_join(p_dir);
|
|
next_dir = next_dir.simplify_path();
|
|
try_dir = next_dir;
|
|
} else {
|
|
try_dir = p_dir;
|
|
}
|
|
|
|
bool worked = (chdir(try_dir.utf8().get_data()) == 0); // we can only give this utf8
|
|
if (!worked) {
|
|
return ERR_INVALID_PARAMETER;
|
|
}
|
|
|
|
String base = _get_root_path();
|
|
if (!base.is_empty() && !try_dir.begins_with(base)) {
|
|
ERR_FAIL_COND_V(getcwd(real_current_dir_name, 2048) == nullptr, ERR_BUG);
|
|
String new_dir;
|
|
new_dir.parse_utf8(real_current_dir_name);
|
|
|
|
if (!new_dir.begins_with(base)) {
|
|
try_dir = current_dir; //revert
|
|
}
|
|
}
|
|
|
|
// the directory exists, so set current_dir to try_dir
|
|
current_dir = try_dir;
|
|
ERR_FAIL_COND_V(chdir(prev_dir.utf8().get_data()) != 0, ERR_BUG);
|
|
return OK;
|
|
}
|
|
|
|
String DirAccessUnix::get_current_dir(bool p_include_drive) const {
|
|
String base = _get_root_path();
|
|
if (!base.is_empty()) {
|
|
String bd = current_dir.replace_first(base, "");
|
|
if (bd.begins_with("/")) {
|
|
return _get_root_string() + bd.substr(1, bd.length());
|
|
} else {
|
|
return _get_root_string() + bd;
|
|
}
|
|
}
|
|
return current_dir;
|
|
}
|
|
|
|
Error DirAccessUnix::rename(String p_path, String p_new_path) {
|
|
if (p_path.is_relative_path()) {
|
|
p_path = get_current_dir().path_join(p_path);
|
|
}
|
|
|
|
p_path = fix_path(p_path);
|
|
|
|
if (p_new_path.is_relative_path()) {
|
|
p_new_path = get_current_dir().path_join(p_new_path);
|
|
}
|
|
|
|
p_new_path = fix_path(p_new_path);
|
|
|
|
return ::rename(p_path.utf8().get_data(), p_new_path.utf8().get_data()) == 0 ? OK : FAILED;
|
|
}
|
|
|
|
Error DirAccessUnix::remove(String p_path) {
|
|
if (p_path.is_relative_path()) {
|
|
p_path = get_current_dir().path_join(p_path);
|
|
}
|
|
|
|
p_path = fix_path(p_path);
|
|
|
|
struct stat flags = {};
|
|
if ((stat(p_path.utf8().get_data(), &flags) != 0)) {
|
|
return FAILED;
|
|
}
|
|
|
|
if (S_ISDIR(flags.st_mode)) {
|
|
return ::rmdir(p_path.utf8().get_data()) == 0 ? OK : FAILED;
|
|
} else {
|
|
return ::unlink(p_path.utf8().get_data()) == 0 ? OK : FAILED;
|
|
}
|
|
}
|
|
|
|
bool DirAccessUnix::is_link(String p_file) {
|
|
if (p_file.is_relative_path()) {
|
|
p_file = get_current_dir().path_join(p_file);
|
|
}
|
|
|
|
p_file = fix_path(p_file);
|
|
|
|
struct stat flags = {};
|
|
if ((lstat(p_file.utf8().get_data(), &flags) != 0)) {
|
|
return FAILED;
|
|
}
|
|
|
|
return S_ISLNK(flags.st_mode);
|
|
}
|
|
|
|
String DirAccessUnix::read_link(String p_file) {
|
|
if (p_file.is_relative_path()) {
|
|
p_file = get_current_dir().path_join(p_file);
|
|
}
|
|
|
|
p_file = fix_path(p_file);
|
|
|
|
char buf[256];
|
|
memset(buf, 0, 256);
|
|
ssize_t len = readlink(p_file.utf8().get_data(), buf, sizeof(buf));
|
|
String link;
|
|
if (len > 0) {
|
|
link.parse_utf8(buf, len);
|
|
}
|
|
return link;
|
|
}
|
|
|
|
Error DirAccessUnix::create_link(String p_source, String p_target) {
|
|
if (p_target.is_relative_path()) {
|
|
p_target = get_current_dir().path_join(p_target);
|
|
}
|
|
|
|
p_source = fix_path(p_source);
|
|
p_target = fix_path(p_target);
|
|
|
|
if (symlink(p_source.utf8().get_data(), p_target.utf8().get_data()) == 0) {
|
|
return OK;
|
|
} else {
|
|
return FAILED;
|
|
}
|
|
}
|
|
|
|
uint64_t DirAccessUnix::get_space_left() {
|
|
struct statvfs vfs;
|
|
if (statvfs(current_dir.utf8().get_data(), &vfs) != 0) {
|
|
return 0;
|
|
}
|
|
|
|
return (uint64_t)vfs.f_bavail * (uint64_t)vfs.f_frsize;
|
|
}
|
|
|
|
String DirAccessUnix::get_filesystem_type() const {
|
|
return ""; //TODO this should be implemented
|
|
}
|
|
|
|
bool DirAccessUnix::is_hidden(const String &p_name) {
|
|
return p_name != "." && p_name != ".." && p_name.begins_with(".");
|
|
}
|
|
|
|
DirAccessUnix::DirAccessUnix() {
|
|
dir_stream = nullptr;
|
|
_cisdir = false;
|
|
|
|
/* determine drive count */
|
|
|
|
// set current directory to an absolute path of the current directory
|
|
char real_current_dir_name[2048];
|
|
ERR_FAIL_COND(getcwd(real_current_dir_name, 2048) == nullptr);
|
|
if (current_dir.parse_utf8(real_current_dir_name) != OK) {
|
|
current_dir = real_current_dir_name;
|
|
}
|
|
|
|
change_dir(current_dir);
|
|
}
|
|
|
|
DirAccessUnix::~DirAccessUnix() {
|
|
list_dir_end();
|
|
}
|
|
|
|
#endif // UNIX_ENABLED
|