3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 #include "util/string.h"
31 #include "settings.h" // For g_settings
37 #ifdef _WIN32 // WINDOWS
39 #define _WIN32_WINNT 0x0501
43 std::vector<DirListNode> GetDirListing(const std::string &pathstring)
45 std::vector<DirListNode> listing;
47 WIN32_FIND_DATA FindFileData;
48 HANDLE hFind = INVALID_HANDLE_VALUE;
51 std::string dirSpec = pathstring + "\\*";
53 // Find the first file in the directory.
54 hFind = FindFirstFile(dirSpec.c_str(), &FindFileData);
56 if (hFind == INVALID_HANDLE_VALUE) {
57 dwError = GetLastError();
58 if (dwError != ERROR_FILE_NOT_FOUND && dwError != ERROR_PATH_NOT_FOUND) {
59 errorstream << "GetDirListing: FindFirstFile error."
60 << " Error is " << dwError << std::endl;
64 // Be very sure to not include '..' in the results, it will
65 // result in an epic failure when deleting stuff.
68 node.name = FindFileData.cFileName;
69 node.dir = FindFileData.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY;
70 if (node.name != "." && node.name != "..")
71 listing.push_back(node);
73 // List all the other files in the directory.
74 while (FindNextFile(hFind, &FindFileData) != 0) {
76 node.name = FindFileData.cFileName;
77 node.dir = FindFileData.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY;
78 if(node.name != "." && node.name != "..")
79 listing.push_back(node);
82 dwError = GetLastError();
84 if (dwError != ERROR_NO_MORE_FILES) {
85 errorstream << "GetDirListing: FindNextFile error."
86 << " Error is " << dwError << std::endl;
94 bool CreateDir(const std::string &path)
96 bool r = CreateDirectory(path.c_str(), NULL);
99 if(GetLastError() == ERROR_ALREADY_EXISTS)
104 bool PathExists(const std::string &path)
106 return (GetFileAttributes(path.c_str()) != INVALID_FILE_ATTRIBUTES);
109 bool IsPathAbsolute(const std::string &path)
111 return !PathIsRelative(path.c_str());
114 bool IsDir(const std::string &path)
116 DWORD attr = GetFileAttributes(path.c_str());
117 return (attr != INVALID_FILE_ATTRIBUTES &&
118 (attr & FILE_ATTRIBUTE_DIRECTORY));
121 bool IsDirDelimiter(char c)
123 return c == '/' || c == '\\';
126 bool RecursiveDelete(const std::string &path)
128 infostream << "Recursively deleting \"" << path << "\"" << std::endl;
130 infostream << "RecursiveDelete: Deleting file " << path << std::endl;
131 if (!DeleteFile(path.c_str())) {
132 errorstream << "RecursiveDelete: Failed to delete file "
133 << path << std::endl;
138 infostream << "RecursiveDelete: Deleting content of directory "
139 << path << std::endl;
140 std::vector<DirListNode> content = GetDirListing(path);
141 for (const DirListNode &n: content) {
142 std::string fullpath = path + DIR_DELIM + n.name;
143 if (!RecursiveDelete(fullpath)) {
144 errorstream << "RecursiveDelete: Failed to recurse to "
145 << fullpath << std::endl;
149 infostream << "RecursiveDelete: Deleting directory " << path << std::endl;
150 if (!RemoveDirectory(path.c_str())) {
151 errorstream << "Failed to recursively delete directory "
152 << path << std::endl;
158 bool DeleteSingleFileOrEmptyDirectory(const std::string &path)
160 DWORD attr = GetFileAttributes(path.c_str());
161 bool is_directory = (attr != INVALID_FILE_ATTRIBUTES &&
162 (attr & FILE_ATTRIBUTE_DIRECTORY));
165 bool did = DeleteFile(path.c_str());
170 bool did = RemoveDirectory(path.c_str());
175 std::string TempPath()
177 DWORD bufsize = GetTempPath(0, NULL);
179 errorstream<<"GetTempPath failed, error = "<<GetLastError()<<std::endl;
182 std::vector<char> buf(bufsize);
183 DWORD len = GetTempPath(bufsize, &buf[0]);
184 if(len == 0 || len > bufsize){
185 errorstream<<"GetTempPath failed, error = "<<GetLastError()<<std::endl;
188 return std::string(buf.begin(), buf.begin() + len);
193 #include <sys/types.h>
195 #include <sys/stat.h>
196 #include <sys/wait.h>
199 std::vector<DirListNode> GetDirListing(const std::string &pathstring)
201 std::vector<DirListNode> listing;
205 if((dp = opendir(pathstring.c_str())) == NULL) {
206 //infostream<<"Error("<<errno<<") opening "<<pathstring<<std::endl;
210 while ((dirp = readdir(dp)) != NULL) {
212 // Be very sure to not include '..' in the results, it will
213 // result in an epic failure when deleting stuff.
214 if(strcmp(dirp->d_name, ".") == 0 || strcmp(dirp->d_name, "..") == 0)
218 node.name = dirp->d_name;
220 int isdir = -1; // -1 means unknown
223 POSIX doesn't define d_type member of struct dirent and
224 certain filesystems on glibc/Linux will only return
225 DT_UNKNOWN for the d_type member.
227 Also we don't know whether symlinks are directories or not.
229 #ifdef _DIRENT_HAVE_D_TYPE
230 if(dirp->d_type != DT_UNKNOWN && dirp->d_type != DT_LNK)
231 isdir = (dirp->d_type == DT_DIR);
232 #endif /* _DIRENT_HAVE_D_TYPE */
235 Was d_type DT_UNKNOWN, DT_LNK or nonexistent?
239 struct stat statbuf{};
240 if (stat((pathstring + "/" + node.name).c_str(), &statbuf))
242 isdir = ((statbuf.st_mode & S_IFDIR) == S_IFDIR);
245 listing.push_back(node);
252 bool CreateDir(const std::string &path)
254 int r = mkdir(path.c_str(), S_IRWXU | S_IRWXG | S_IROTH | S_IXOTH);
259 // If already exists, return true
266 bool PathExists(const std::string &path)
269 return (stat(path.c_str(),&st) == 0);
272 bool IsPathAbsolute(const std::string &path)
274 return path[0] == '/';
277 bool IsDir(const std::string &path)
279 struct stat statbuf{};
280 if(stat(path.c_str(), &statbuf))
281 return false; // Actually error; but certainly not a directory
282 return ((statbuf.st_mode & S_IFDIR) == S_IFDIR);
285 bool IsDirDelimiter(char c)
290 bool RecursiveDelete(const std::string &path)
293 Execute the 'rm' command directly, by fork() and execve()
296 infostream<<"Removing \""<<path<<"\""<<std::endl;
300 pid_t child_pid = fork();
305 char argv_data[3][10000];
306 strcpy(argv_data[0], "/bin/rm");
307 strcpy(argv_data[1], "-rf");
308 strncpy(argv_data[2], path.c_str(), 10000);
310 argv[0] = argv_data[0];
311 argv[1] = argv_data[1];
312 argv[2] = argv_data[2];
315 verbosestream<<"Executing '"<<argv[0]<<"' '"<<argv[1]<<"' '"
316 <<argv[2]<<"'"<<std::endl;
318 execv(argv[0], argv);
320 // Execv shouldn't return. Failed.
329 tpid = wait(&child_status);
330 //if(tpid != child_pid) process_terminated(tpid);
331 }while(tpid != child_pid);
332 return (child_status == 0);
336 bool DeleteSingleFileOrEmptyDirectory(const std::string &path)
339 bool did = (rmdir(path.c_str()) == 0);
341 errorstream << "rmdir errno: " << errno << ": " << strerror(errno)
346 bool did = (unlink(path.c_str()) == 0);
348 errorstream << "unlink errno: " << errno << ": " << strerror(errno)
353 std::string TempPath()
356 Should the environment variables TMPDIR, TMP and TEMP
357 and the macro P_tmpdir (if defined by stdio.h) be checked
358 before falling back on /tmp?
360 Probably not, because this function is intended to be
361 compatible with lua's os.tmpname which under the default
362 configuration hardcodes mkstemp("/tmp/lua_XXXXXX").
365 return g_settings->get("TMPFolder");
367 return DIR_DELIM "tmp";
373 void GetRecursiveDirs(std::vector<std::string> &dirs, const std::string &dir)
375 static const std::set<char> chars_to_ignore = { '_', '.' };
376 if (dir.empty() || !IsDir(dir))
379 fs::GetRecursiveSubPaths(dir, dirs, false, chars_to_ignore);
382 std::vector<std::string> GetRecursiveDirs(const std::string &dir)
384 std::vector<std::string> result;
385 GetRecursiveDirs(result, dir);
389 void GetRecursiveSubPaths(const std::string &path,
390 std::vector<std::string> &dst,
392 const std::set<char> &ignore)
394 std::vector<DirListNode> content = GetDirListing(path);
395 for (const auto &n : content) {
396 std::string fullpath = path + DIR_DELIM + n.name;
397 if (ignore.count(n.name[0]))
399 if (list_files || n.dir)
400 dst.push_back(fullpath);
402 GetRecursiveSubPaths(fullpath, dst, list_files, ignore);
406 bool DeletePaths(const std::vector<std::string> &paths)
409 // Go backwards to succesfully delete the output of GetRecursiveSubPaths
410 for(int i=paths.size()-1; i>=0; i--){
411 const std::string &path = paths[i];
412 bool did = DeleteSingleFileOrEmptyDirectory(path);
414 errorstream<<"Failed to delete "<<path<<std::endl;
421 bool RecursiveDeleteContent(const std::string &path)
423 infostream<<"Removing content of \""<<path<<"\""<<std::endl;
424 std::vector<DirListNode> list = GetDirListing(path);
425 for (const DirListNode &dln : list) {
426 if(trim(dln.name) == "." || trim(dln.name) == "..")
428 std::string childpath = path + DIR_DELIM + dln.name;
429 bool r = RecursiveDelete(childpath);
431 errorstream << "Removing \"" << childpath << "\" failed" << std::endl;
438 bool CreateAllDirs(const std::string &path)
441 std::vector<std::string> tocreate;
442 std::string basepath = path;
443 while(!PathExists(basepath))
445 tocreate.push_back(basepath);
446 basepath = RemoveLastPathComponent(basepath);
450 for(int i=tocreate.size()-1;i>=0;i--)
451 if(!CreateDir(tocreate[i]))
456 bool CopyFileContents(const std::string &source, const std::string &target)
458 FILE *sourcefile = fopen(source.c_str(), "rb");
459 if(sourcefile == NULL){
460 errorstream<<source<<": can't open for reading: "
461 <<strerror(errno)<<std::endl;
465 FILE *targetfile = fopen(target.c_str(), "wb");
466 if(targetfile == NULL){
467 errorstream<<target<<": can't open for writing: "
468 <<strerror(errno)<<std::endl;
476 char readbuffer[BUFSIZ];
478 size_t readbytes = fread(readbuffer, 1,
479 sizeof(readbuffer), sourcefile);
481 if(ferror(sourcefile)){
482 errorstream<<source<<": IO error: "
483 <<strerror(errno)<<std::endl;
488 fwrite(readbuffer, 1, readbytes, targetfile);
490 if(feof(sourcefile) || ferror(sourcefile)){
491 // flush destination file to catch write errors
496 if(ferror(targetfile)){
497 errorstream<<target<<": IO error: "
498 <<strerror(errno)<<std::endl;
503 infostream<<"copied "<<total<<" bytes from "
504 <<source<<" to "<<target<<std::endl;
510 bool CopyDir(const std::string &source, const std::string &target)
512 if(PathExists(source)){
513 if(!PathExists(target)){
514 fs::CreateAllDirs(target);
517 std::vector<DirListNode> content = fs::GetDirListing(source);
519 for (const auto &dln : content) {
520 std::string sourcechild = source + DIR_DELIM + dln.name;
521 std::string targetchild = target + DIR_DELIM + dln.name;
523 if(!fs::CopyDir(sourcechild, targetchild)){
528 if(!fs::CopyFileContents(sourcechild, targetchild)){
539 bool PathStartsWith(const std::string &path, const std::string &prefix)
541 size_t pathsize = path.size();
543 size_t prefixsize = prefix.size();
544 size_t prefixpos = 0;
546 bool delim1 = pathpos == pathsize
547 || IsDirDelimiter(path[pathpos]);
548 bool delim2 = prefixpos == prefixsize
549 || IsDirDelimiter(prefix[prefixpos]);
555 while(pathpos < pathsize &&
556 IsDirDelimiter(path[pathpos]))
558 while(prefixpos < prefixsize &&
559 IsDirDelimiter(prefix[prefixpos]))
561 if(prefixpos == prefixsize)
563 if(pathpos == pathsize)
569 char pathchar = path[pathpos+len];
570 char prefixchar = prefix[prefixpos+len];
571 if(FILESYS_CASE_INSENSITIVE){
572 pathchar = tolower(pathchar);
573 prefixchar = tolower(prefixchar);
575 if(pathchar != prefixchar)
578 } while(pathpos+len < pathsize
579 && !IsDirDelimiter(path[pathpos+len])
580 && prefixpos+len < prefixsize
582 prefix[prefixpos+len]));
589 std::string RemoveLastPathComponent(const std::string &path,
590 std::string *removed, int count)
595 size_t remaining = path.size();
597 for(int i = 0; i < count; ++i){
598 // strip a dir delimiter
599 while(remaining != 0 && IsDirDelimiter(path[remaining-1]))
601 // strip a path component
602 size_t component_end = remaining;
603 while(remaining != 0 && !IsDirDelimiter(path[remaining-1]))
605 size_t component_start = remaining;
606 // strip a dir delimiter
607 while(remaining != 0 && IsDirDelimiter(path[remaining-1]))
610 std::string component = path.substr(component_start,
611 component_end - component_start);
613 *removed = component + DIR_DELIM + *removed;
615 *removed = component;
618 return path.substr(0, remaining);
621 std::string RemoveRelativePathComponents(std::string path)
623 size_t pos = path.size();
624 size_t dotdot_count = 0;
626 size_t component_with_delim_end = pos;
627 // skip a dir delimiter
628 while (pos != 0 && IsDirDelimiter(path[pos-1]))
630 // strip a path component
631 size_t component_end = pos;
632 while (pos != 0 && !IsDirDelimiter(path[pos-1]))
634 size_t component_start = pos;
636 std::string component = path.substr(component_start,
637 component_end - component_start);
638 bool remove_this_component = false;
639 if (component == ".") {
640 remove_this_component = true;
641 } else if (component == "..") {
642 remove_this_component = true;
644 } else if (dotdot_count != 0) {
645 remove_this_component = true;
649 if (remove_this_component) {
650 while (pos != 0 && IsDirDelimiter(path[pos-1]))
652 if (component_start == 0) {
653 // We need to remove the delemiter too
654 path = path.substr(component_with_delim_end, std::string::npos);
656 path = path.substr(0, pos) + DIR_DELIM +
657 path.substr(component_with_delim_end, std::string::npos);
664 if (dotdot_count > 0)
667 // remove trailing dir delimiters
669 while (pos != 0 && IsDirDelimiter(path[pos-1]))
671 return path.substr(0, pos);
674 std::string AbsolutePath(const std::string &path)
677 char *abs_path = _fullpath(NULL, path.c_str(), MAX_PATH);
679 char *abs_path = realpath(path.c_str(), NULL);
681 if (!abs_path) return "";
682 std::string abs_path_str(abs_path);
687 const char *GetFilenameFromPath(const char *path)
689 const char *filename = strrchr(path, DIR_DELIM_CHAR);
690 return filename ? filename + 1 : path;
693 bool safeWriteToFile(const std::string &path, const std::string &content)
695 std::string tmp_file = path + ".~mt";
697 // Write to a tmp file
698 std::ofstream os(tmp_file.c_str(), std::ios::binary);
705 // Remove the temporary file because writing it failed and it's useless.
706 remove(tmp_file.c_str());
710 bool rename_success = false;
712 // Move the finished temporary file over the real file
714 // When creating the file, it can cause Windows Search indexer, virus scanners and other apps
715 // to query the file. This can make the move file call below fail.
716 // We retry up to 5 times, with a 1ms sleep between, before we consider the whole operation failed
717 int number_attempts = 0;
718 while (number_attempts < 5) {
719 rename_success = MoveFileEx(tmp_file.c_str(), path.c_str(),
720 MOVEFILE_REPLACE_EXISTING | MOVEFILE_WRITE_THROUGH);
727 // On POSIX compliant systems rename() is specified to be able to swap the
728 // file in place of the destination file, making this a truly error-proof
730 rename_success = rename(tmp_file.c_str(), path.c_str()) == 0;
732 if (!rename_success) {
733 warningstream << "Failed to write to file: " << path.c_str() << std::endl;
734 // Remove the temporary file because moving it over the target file
736 remove(tmp_file.c_str());
743 bool Rename(const std::string &from, const std::string &to)
745 return rename(from.c_str(), to.c_str()) == 0;