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 DWORD attr = GetFileAttributes(path.c_str());
131 bool is_directory = (attr != INVALID_FILE_ATTRIBUTES &&
132 (attr & FILE_ATTRIBUTE_DIRECTORY));
135 infostream<<"RecursiveDelete: Deleting file "<<path<<std::endl;
136 //bool did = DeleteFile(path.c_str());
139 errorstream<<"RecursiveDelete: Failed to delete file "
146 infostream<<"RecursiveDelete: Deleting content of directory "
148 std::vector<DirListNode> content = GetDirListing(path);
149 for(size_t i=0; i<content.size(); i++){
150 const DirListNode &n = content[i];
151 std::string fullpath = path + DIR_DELIM + n.name;
152 bool did = RecursiveDelete(fullpath);
154 errorstream<<"RecursiveDelete: Failed to recurse to "
155 <<fullpath<<std::endl;
159 infostream<<"RecursiveDelete: Deleting directory "<<path<<std::endl;
160 //bool did = RemoveDirectory(path.c_str();
163 errorstream<<"Failed to recursively delete directory "
171 bool DeleteSingleFileOrEmptyDirectory(const std::string &path)
173 DWORD attr = GetFileAttributes(path.c_str());
174 bool is_directory = (attr != INVALID_FILE_ATTRIBUTES &&
175 (attr & FILE_ATTRIBUTE_DIRECTORY));
178 bool did = DeleteFile(path.c_str());
183 bool did = RemoveDirectory(path.c_str());
188 std::string TempPath()
190 DWORD bufsize = GetTempPath(0, NULL);
192 errorstream<<"GetTempPath failed, error = "<<GetLastError()<<std::endl;
195 std::vector<char> buf(bufsize);
196 DWORD len = GetTempPath(bufsize, &buf[0]);
197 if(len == 0 || len > bufsize){
198 errorstream<<"GetTempPath failed, error = "<<GetLastError()<<std::endl;
201 return std::string(buf.begin(), buf.begin() + len);
206 #include <sys/types.h>
208 #include <sys/stat.h>
209 #include <sys/wait.h>
212 std::vector<DirListNode> GetDirListing(const std::string &pathstring)
214 std::vector<DirListNode> listing;
218 if((dp = opendir(pathstring.c_str())) == NULL) {
219 //infostream<<"Error("<<errno<<") opening "<<pathstring<<std::endl;
223 while ((dirp = readdir(dp)) != NULL) {
225 // Be very sure to not include '..' in the results, it will
226 // result in an epic failure when deleting stuff.
227 if(strcmp(dirp->d_name, ".") == 0 || strcmp(dirp->d_name, "..") == 0)
231 node.name = dirp->d_name;
233 int isdir = -1; // -1 means unknown
236 POSIX doesn't define d_type member of struct dirent and
237 certain filesystems on glibc/Linux will only return
238 DT_UNKNOWN for the d_type member.
240 Also we don't know whether symlinks are directories or not.
242 #ifdef _DIRENT_HAVE_D_TYPE
243 if(dirp->d_type != DT_UNKNOWN && dirp->d_type != DT_LNK)
244 isdir = (dirp->d_type == DT_DIR);
245 #endif /* _DIRENT_HAVE_D_TYPE */
248 Was d_type DT_UNKNOWN, DT_LNK or nonexistent?
252 struct stat statbuf{};
253 if (stat((pathstring + "/" + node.name).c_str(), &statbuf))
255 isdir = ((statbuf.st_mode & S_IFDIR) == S_IFDIR);
258 listing.push_back(node);
265 bool CreateDir(const std::string &path)
267 int r = mkdir(path.c_str(), S_IRWXU | S_IRWXG | S_IROTH | S_IXOTH);
272 // If already exists, return true
279 bool PathExists(const std::string &path)
282 return (stat(path.c_str(),&st) == 0);
285 bool IsPathAbsolute(const std::string &path)
287 return path[0] == '/';
290 bool IsDir(const std::string &path)
292 struct stat statbuf{};
293 if(stat(path.c_str(), &statbuf))
294 return false; // Actually error; but certainly not a directory
295 return ((statbuf.st_mode & S_IFDIR) == S_IFDIR);
298 bool IsDirDelimiter(char c)
303 bool RecursiveDelete(const std::string &path)
306 Execute the 'rm' command directly, by fork() and execve()
309 infostream<<"Removing \""<<path<<"\""<<std::endl;
313 pid_t child_pid = fork();
318 char argv_data[3][10000];
319 strcpy(argv_data[0], "/bin/rm");
320 strcpy(argv_data[1], "-rf");
321 strncpy(argv_data[2], path.c_str(), 10000);
323 argv[0] = argv_data[0];
324 argv[1] = argv_data[1];
325 argv[2] = argv_data[2];
328 verbosestream<<"Executing '"<<argv[0]<<"' '"<<argv[1]<<"' '"
329 <<argv[2]<<"'"<<std::endl;
331 execv(argv[0], argv);
333 // Execv shouldn't return. Failed.
342 tpid = wait(&child_status);
343 //if(tpid != child_pid) process_terminated(tpid);
344 }while(tpid != child_pid);
345 return (child_status == 0);
349 bool DeleteSingleFileOrEmptyDirectory(const std::string &path)
352 bool did = (rmdir(path.c_str()) == 0);
354 errorstream << "rmdir errno: " << errno << ": " << strerror(errno)
359 bool did = (unlink(path.c_str()) == 0);
361 errorstream << "unlink errno: " << errno << ": " << strerror(errno)
366 std::string TempPath()
369 Should the environment variables TMPDIR, TMP and TEMP
370 and the macro P_tmpdir (if defined by stdio.h) be checked
371 before falling back on /tmp?
373 Probably not, because this function is intended to be
374 compatible with lua's os.tmpname which under the default
375 configuration hardcodes mkstemp("/tmp/lua_XXXXXX").
378 return g_settings->get("TMPFolder");
380 return DIR_DELIM "tmp";
386 void GetRecursiveDirs(std::vector<std::string> &dirs, const std::string &dir)
388 static const std::set<char> chars_to_ignore = { '_', '.' };
389 if (dir.empty() || !IsDir(dir))
392 fs::GetRecursiveSubPaths(dir, dirs, false, chars_to_ignore);
395 std::vector<std::string> GetRecursiveDirs(const std::string &dir)
397 std::vector<std::string> result;
398 GetRecursiveDirs(result, dir);
402 void GetRecursiveSubPaths(const std::string &path,
403 std::vector<std::string> &dst,
405 const std::set<char> &ignore)
407 std::vector<DirListNode> content = GetDirListing(path);
408 for (const auto &n : content) {
409 std::string fullpath = path + DIR_DELIM + n.name;
410 if (ignore.count(n.name[0]))
412 if (list_files || n.dir)
413 dst.push_back(fullpath);
415 GetRecursiveSubPaths(fullpath, dst, list_files, ignore);
419 bool DeletePaths(const std::vector<std::string> &paths)
422 // Go backwards to succesfully delete the output of GetRecursiveSubPaths
423 for(int i=paths.size()-1; i>=0; i--){
424 const std::string &path = paths[i];
425 bool did = DeleteSingleFileOrEmptyDirectory(path);
427 errorstream<<"Failed to delete "<<path<<std::endl;
434 bool RecursiveDeleteContent(const std::string &path)
436 infostream<<"Removing content of \""<<path<<"\""<<std::endl;
437 std::vector<DirListNode> list = GetDirListing(path);
438 for (const DirListNode &dln : list) {
439 if(trim(dln.name) == "." || trim(dln.name) == "..")
441 std::string childpath = path + DIR_DELIM + dln.name;
442 bool r = RecursiveDelete(childpath);
444 errorstream << "Removing \"" << childpath << "\" failed" << std::endl;
451 bool CreateAllDirs(const std::string &path)
454 std::vector<std::string> tocreate;
455 std::string basepath = path;
456 while(!PathExists(basepath))
458 tocreate.push_back(basepath);
459 basepath = RemoveLastPathComponent(basepath);
463 for(int i=tocreate.size()-1;i>=0;i--)
464 if(!CreateDir(tocreate[i]))
469 bool CopyFileContents(const std::string &source, const std::string &target)
471 FILE *sourcefile = fopen(source.c_str(), "rb");
472 if(sourcefile == NULL){
473 errorstream<<source<<": can't open for reading: "
474 <<strerror(errno)<<std::endl;
478 FILE *targetfile = fopen(target.c_str(), "wb");
479 if(targetfile == NULL){
480 errorstream<<target<<": can't open for writing: "
481 <<strerror(errno)<<std::endl;
489 char readbuffer[BUFSIZ];
491 size_t readbytes = fread(readbuffer, 1,
492 sizeof(readbuffer), sourcefile);
494 if(ferror(sourcefile)){
495 errorstream<<source<<": IO error: "
496 <<strerror(errno)<<std::endl;
501 fwrite(readbuffer, 1, readbytes, targetfile);
503 if(feof(sourcefile) || ferror(sourcefile)){
504 // flush destination file to catch write errors
509 if(ferror(targetfile)){
510 errorstream<<target<<": IO error: "
511 <<strerror(errno)<<std::endl;
516 infostream<<"copied "<<total<<" bytes from "
517 <<source<<" to "<<target<<std::endl;
523 bool CopyDir(const std::string &source, const std::string &target)
525 if(PathExists(source)){
526 if(!PathExists(target)){
527 fs::CreateAllDirs(target);
530 std::vector<DirListNode> content = fs::GetDirListing(source);
532 for (const auto &dln : content) {
533 std::string sourcechild = source + DIR_DELIM + dln.name;
534 std::string targetchild = target + DIR_DELIM + dln.name;
536 if(!fs::CopyDir(sourcechild, targetchild)){
541 if(!fs::CopyFileContents(sourcechild, targetchild)){
552 bool PathStartsWith(const std::string &path, const std::string &prefix)
554 size_t pathsize = path.size();
556 size_t prefixsize = prefix.size();
557 size_t prefixpos = 0;
559 bool delim1 = pathpos == pathsize
560 || IsDirDelimiter(path[pathpos]);
561 bool delim2 = prefixpos == prefixsize
562 || IsDirDelimiter(prefix[prefixpos]);
568 while(pathpos < pathsize &&
569 IsDirDelimiter(path[pathpos]))
571 while(prefixpos < prefixsize &&
572 IsDirDelimiter(prefix[prefixpos]))
574 if(prefixpos == prefixsize)
576 if(pathpos == pathsize)
582 char pathchar = path[pathpos+len];
583 char prefixchar = prefix[prefixpos+len];
584 if(FILESYS_CASE_INSENSITIVE){
585 pathchar = tolower(pathchar);
586 prefixchar = tolower(prefixchar);
588 if(pathchar != prefixchar)
591 } while(pathpos+len < pathsize
592 && !IsDirDelimiter(path[pathpos+len])
593 && prefixpos+len < prefixsize
595 prefix[prefixpos+len]));
602 std::string RemoveLastPathComponent(const std::string &path,
603 std::string *removed, int count)
608 size_t remaining = path.size();
610 for(int i = 0; i < count; ++i){
611 // strip a dir delimiter
612 while(remaining != 0 && IsDirDelimiter(path[remaining-1]))
614 // strip a path component
615 size_t component_end = remaining;
616 while(remaining != 0 && !IsDirDelimiter(path[remaining-1]))
618 size_t component_start = remaining;
619 // strip a dir delimiter
620 while(remaining != 0 && IsDirDelimiter(path[remaining-1]))
623 std::string component = path.substr(component_start,
624 component_end - component_start);
626 *removed = component + DIR_DELIM + *removed;
628 *removed = component;
631 return path.substr(0, remaining);
634 std::string RemoveRelativePathComponents(std::string path)
636 size_t pos = path.size();
637 size_t dotdot_count = 0;
639 size_t component_with_delim_end = pos;
640 // skip a dir delimiter
641 while (pos != 0 && IsDirDelimiter(path[pos-1]))
643 // strip a path component
644 size_t component_end = pos;
645 while (pos != 0 && !IsDirDelimiter(path[pos-1]))
647 size_t component_start = pos;
649 std::string component = path.substr(component_start,
650 component_end - component_start);
651 bool remove_this_component = false;
652 if (component == ".") {
653 remove_this_component = true;
654 } else if (component == "..") {
655 remove_this_component = true;
657 } else if (dotdot_count != 0) {
658 remove_this_component = true;
662 if (remove_this_component) {
663 while (pos != 0 && IsDirDelimiter(path[pos-1]))
665 if (component_start == 0) {
666 // We need to remove the delemiter too
667 path = path.substr(component_with_delim_end, std::string::npos);
669 path = path.substr(0, pos) + DIR_DELIM +
670 path.substr(component_with_delim_end, std::string::npos);
677 if (dotdot_count > 0)
680 // remove trailing dir delimiters
682 while (pos != 0 && IsDirDelimiter(path[pos-1]))
684 return path.substr(0, pos);
687 std::string AbsolutePath(const std::string &path)
690 char *abs_path = _fullpath(NULL, path.c_str(), MAX_PATH);
692 char *abs_path = realpath(path.c_str(), NULL);
694 if (!abs_path) return "";
695 std::string abs_path_str(abs_path);
700 const char *GetFilenameFromPath(const char *path)
702 const char *filename = strrchr(path, DIR_DELIM_CHAR);
703 return filename ? filename + 1 : path;
706 bool safeWriteToFile(const std::string &path, const std::string &content)
708 std::string tmp_file = path + ".~mt";
710 // Write to a tmp file
711 std::ofstream os(tmp_file.c_str(), std::ios::binary);
718 // Remove the temporary file because writing it failed and it's useless.
719 remove(tmp_file.c_str());
723 bool rename_success = false;
725 // Move the finished temporary file over the real file
727 // When creating the file, it can cause Windows Search indexer, virus scanners and other apps
728 // to query the file. This can make the move file call below fail.
729 // We retry up to 5 times, with a 1ms sleep between, before we consider the whole operation failed
730 int number_attempts = 0;
731 while (number_attempts < 5) {
732 rename_success = MoveFileEx(tmp_file.c_str(), path.c_str(),
733 MOVEFILE_REPLACE_EXISTING | MOVEFILE_WRITE_THROUGH);
740 // On POSIX compliant systems rename() is specified to be able to swap the
741 // file in place of the destination file, making this a truly error-proof
743 rename_success = rename(tmp_file.c_str(), path.c_str()) == 0;
745 if (!rename_success) {
746 warningstream << "Failed to write to file: " << path.c_str() << std::endl;
747 // Remove the temporary file because moving it over the target file
749 remove(tmp_file.c_str());
756 bool Rename(const std::string &from, const std::string &to)
758 return rename(from.c_str(), to.c_str()) == 0;