Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2004-2023 Savoir-faire Linux Inc. |
| 3 | * |
Adrien Béraud | cb75362 | 2023-07-17 22:32:49 -0400 | [diff] [blame] | 4 | * This program is free software: you can redistribute it and/or modify |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 5 | * it under the terms of the GNU General Public License as published by |
Adrien Béraud | cb75362 | 2023-07-17 22:32:49 -0400 | [diff] [blame] | 6 | * the Free Software Foundation, either version 3 of the License, or |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 7 | * (at your option) any later version. |
| 8 | * |
| 9 | * This program is distributed in the hope that it will be useful, |
| 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
Adrien Béraud | cb75362 | 2023-07-17 22:32:49 -0400 | [diff] [blame] | 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 12 | * GNU General Public License for more details. |
| 13 | * |
| 14 | * You should have received a copy of the GNU General Public License |
Adrien Béraud | cb75362 | 2023-07-17 22:32:49 -0400 | [diff] [blame] | 15 | * along with this program. If not, see <https://www.gnu.org/licenses/>. |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 16 | */ |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 17 | #pragma once |
| 18 | |
| 19 | #include <string> |
| 20 | #include <vector> |
| 21 | #include <chrono> |
| 22 | #include <mutex> |
| 23 | #include <cstdio> |
| 24 | #include <ios> |
Adrien Béraud | 2a4e73d | 2023-08-27 12:53:55 -0400 | [diff] [blame] | 25 | #include <filesystem> |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 26 | |
Sébastien Blin | 7fbedf9 | 2023-08-30 08:44:47 -0400 | [diff] [blame] | 27 | #ifndef _WIN32 |
| 28 | #include <sys/stat.h> // mode_t |
Sébastien Blin | c453ca7 | 2023-08-30 14:00:36 -0400 | [diff] [blame] | 29 | #else |
| 30 | #define mode_t unsigned |
Sébastien Blin | 7fbedf9 | 2023-08-30 08:44:47 -0400 | [diff] [blame] | 31 | #endif |
| 32 | |
Adrien Béraud | 1ae60aa | 2023-07-07 09:55:09 -0400 | [diff] [blame] | 33 | namespace dhtnet { |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 34 | namespace fileutils { |
| 35 | |
| 36 | /** |
| 37 | * Check directory existence and create it with given mode if it doesn't. |
| 38 | * @param path to check, relative or absolute |
| 39 | * @param dir last directory creation mode |
| 40 | * @param parents default mode for all created directories except the last |
| 41 | */ |
Adrien Béraud | 2a4e73d | 2023-08-27 12:53:55 -0400 | [diff] [blame] | 42 | bool check_dir(const std::filesystem::path& path, mode_t dir = 0755, mode_t parents = 0755); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 43 | |
Adrien Béraud | 2a4e73d | 2023-08-27 12:53:55 -0400 | [diff] [blame] | 44 | bool recursive_mkdir(const std::filesystem::path& path, mode_t mode = 0755); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 45 | |
Adrien Béraud | 2a4e73d | 2023-08-27 12:53:55 -0400 | [diff] [blame] | 46 | inline bool isPathRelative(const std::filesystem::path& path) { |
| 47 | return path.is_relative(); |
| 48 | } |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 49 | |
Adrien Béraud | 2a4e73d | 2023-08-27 12:53:55 -0400 | [diff] [blame] | 50 | bool isFile(const std::filesystem::path& path, bool resolveSymlink = true); |
| 51 | bool isDirectory(const std::filesystem::path& path); |
| 52 | bool isSymLink(const std::filesystem::path& path); |
| 53 | bool hasHardLink(const std::filesystem::path& path); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 54 | |
| 55 | /** |
| 56 | * Read content of the directory. |
| 57 | * The result is a list of relative (to @param dir) paths of all entries |
| 58 | * in the directory, without "." and "..". |
| 59 | */ |
Adrien Béraud | 2a4e73d | 2023-08-27 12:53:55 -0400 | [diff] [blame] | 60 | std::vector<std::string> readDirectory(const std::filesystem::path& dir); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 61 | |
| 62 | /** |
| 63 | * Read the full content of a file at path. |
| 64 | * If path is relative, it is appended to default_dir. |
| 65 | */ |
Adrien Béraud | 2a4e73d | 2023-08-27 12:53:55 -0400 | [diff] [blame] | 66 | std::vector<uint8_t> loadFile(const std::filesystem::path& path); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 67 | |
Adrien Béraud | 2a4e73d | 2023-08-27 12:53:55 -0400 | [diff] [blame] | 68 | void saveFile(const std::filesystem::path& path, const uint8_t* data, size_t data_size, mode_t mode = 0644); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 69 | inline void |
Adrien Béraud | 2a4e73d | 2023-08-27 12:53:55 -0400 | [diff] [blame] | 70 | saveFile(const std::filesystem::path& path, const std::vector<uint8_t>& data, mode_t mode = 0644) |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 71 | { |
| 72 | saveFile(path, data.data(), data.size(), mode); |
| 73 | } |
| 74 | |
Adrien Béraud | 2a4e73d | 2023-08-27 12:53:55 -0400 | [diff] [blame] | 75 | std::mutex& getFileLock(const std::filesystem::path& path); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 76 | |
| 77 | /** |
| 78 | * Remove a file with optional erasing of content. |
| 79 | * Return the same value as std::remove(). |
| 80 | */ |
Adrien Béraud | 2a4e73d | 2023-08-27 12:53:55 -0400 | [diff] [blame] | 81 | int remove(const std::filesystem::path& path, bool erase = false); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 82 | |
| 83 | /** |
| 84 | * Prune given directory's content and remove it, symlinks are not followed. |
| 85 | * Return 0 if succeed, -1 if directory is not removed (content can be removed partially). |
| 86 | */ |
Adrien Béraud | 2a4e73d | 2023-08-27 12:53:55 -0400 | [diff] [blame] | 87 | int removeAll(const std::filesystem::path& path, bool erase = false); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 88 | |
| 89 | /** |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 90 | * Windows compatibility wrapper for checking read-only attribute |
| 91 | */ |
| 92 | int accessFile(const std::string& file, int mode); |
| 93 | |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 94 | } // namespace fileutils |
Sébastien Blin | 464bdff | 2023-07-19 08:02:53 -0400 | [diff] [blame] | 95 | } // namespace dhtnet |