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"
34 #ifdef _WIN32 // WINDOWS
36 #define _WIN32_WINNT 0x0501
40 std::vector<DirListNode> GetDirListing(const std::string &pathstring)
42 std::vector<DirListNode> listing;
44 WIN32_FIND_DATA FindFileData;
45 HANDLE hFind = INVALID_HANDLE_VALUE;
48 std::string dirSpec = pathstring + "\\*";
50 // Find the first file in the directory.
51 hFind = FindFirstFile(dirSpec.c_str(), &FindFileData);
53 if (hFind == INVALID_HANDLE_VALUE) {
54 dwError = GetLastError();
55 if (dwError != ERROR_FILE_NOT_FOUND && dwError != ERROR_PATH_NOT_FOUND) {
56 errorstream << "GetDirListing: FindFirstFile error."
57 << " Error is " << dwError << std::endl;
61 // Be very sure to not include '..' in the results, it will
62 // result in an epic failure when deleting stuff.
65 node.name = FindFileData.cFileName;
66 node.dir = FindFileData.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY;
67 if (node.name != "." && node.name != "..")
68 listing.push_back(node);
70 // List all the other files in the directory.
71 while (FindNextFile(hFind, &FindFileData) != 0) {
73 node.name = FindFileData.cFileName;
74 node.dir = FindFileData.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY;
75 if(node.name != "." && node.name != "..")
76 listing.push_back(node);
79 dwError = GetLastError();
81 if (dwError != ERROR_NO_MORE_FILES) {
82 errorstream << "GetDirListing: FindNextFile error."
83 << " Error is " << dwError << std::endl;
91 bool CreateDir(const std::string &path)
93 bool r = CreateDirectory(path.c_str(), NULL);
96 if(GetLastError() == ERROR_ALREADY_EXISTS)
101 bool PathExists(const std::string &path)
103 return (GetFileAttributes(path.c_str()) != INVALID_FILE_ATTRIBUTES);
106 bool IsPathAbsolute(const std::string &path)
108 return !PathIsRelative(path.c_str());
111 bool IsDir(const std::string &path)
113 DWORD attr = GetFileAttributes(path.c_str());
114 return (attr != INVALID_FILE_ATTRIBUTES &&
115 (attr & FILE_ATTRIBUTE_DIRECTORY));
118 bool IsDirDelimiter(char c)
120 return c == '/' || c == '\\';
123 bool RecursiveDelete(const std::string &path)
125 infostream<<"Recursively deleting \""<<path<<"\""<<std::endl;
127 DWORD attr = GetFileAttributes(path.c_str());
128 bool is_directory = (attr != INVALID_FILE_ATTRIBUTES &&
129 (attr & FILE_ATTRIBUTE_DIRECTORY));
132 infostream<<"RecursiveDelete: Deleting file "<<path<<std::endl;
133 //bool did = DeleteFile(path.c_str());
136 errorstream<<"RecursiveDelete: Failed to delete file "
143 infostream<<"RecursiveDelete: Deleting content of directory "
145 std::vector<DirListNode> content = GetDirListing(path);
146 for(size_t i=0; i<content.size(); i++){
147 const DirListNode &n = content[i];
148 std::string fullpath = path + DIR_DELIM + n.name;
149 bool did = RecursiveDelete(fullpath);
151 errorstream<<"RecursiveDelete: Failed to recurse to "
152 <<fullpath<<std::endl;
156 infostream<<"RecursiveDelete: Deleting directory "<<path<<std::endl;
157 //bool did = RemoveDirectory(path.c_str();
160 errorstream<<"Failed to recursively delete directory "
168 bool DeleteSingleFileOrEmptyDirectory(const std::string &path)
170 DWORD attr = GetFileAttributes(path.c_str());
171 bool is_directory = (attr != INVALID_FILE_ATTRIBUTES &&
172 (attr & FILE_ATTRIBUTE_DIRECTORY));
175 bool did = DeleteFile(path.c_str());
180 bool did = RemoveDirectory(path.c_str());
185 std::string TempPath()
187 DWORD bufsize = GetTempPath(0, NULL);
189 errorstream<<"GetTempPath failed, error = "<<GetLastError()<<std::endl;
192 std::vector<char> buf(bufsize);
193 DWORD len = GetTempPath(bufsize, &buf[0]);
194 if(len == 0 || len > bufsize){
195 errorstream<<"GetTempPath failed, error = "<<GetLastError()<<std::endl;
198 return std::string(buf.begin(), buf.begin() + len);
203 #include <sys/types.h>
205 #include <sys/stat.h>
206 #include <sys/wait.h>
209 std::vector<DirListNode> GetDirListing(const std::string &pathstring)
211 std::vector<DirListNode> listing;
215 if((dp = opendir(pathstring.c_str())) == NULL) {
216 //infostream<<"Error("<<errno<<") opening "<<pathstring<<std::endl;
220 while ((dirp = readdir(dp)) != NULL) {
222 // Be very sure to not include '..' in the results, it will
223 // result in an epic failure when deleting stuff.
224 if(strcmp(dirp->d_name, ".") == 0 || strcmp(dirp->d_name, "..") == 0)
228 node.name = dirp->d_name;
230 int isdir = -1; // -1 means unknown
233 POSIX doesn't define d_type member of struct dirent and
234 certain filesystems on glibc/Linux will only return
235 DT_UNKNOWN for the d_type member.
237 Also we don't know whether symlinks are directories or not.
239 #ifdef _DIRENT_HAVE_D_TYPE
240 if(dirp->d_type != DT_UNKNOWN && dirp->d_type != DT_LNK)
241 isdir = (dirp->d_type == DT_DIR);
242 #endif /* _DIRENT_HAVE_D_TYPE */
245 Was d_type DT_UNKNOWN, DT_LNK or nonexistent?
249 struct stat statbuf{};
250 if (stat((pathstring + "/" + node.name).c_str(), &statbuf))
252 isdir = ((statbuf.st_mode & S_IFDIR) == S_IFDIR);
255 listing.push_back(node);
262 bool CreateDir(const std::string &path)
264 int r = mkdir(path.c_str(), S_IRWXU | S_IRWXG | S_IROTH | S_IXOTH);
269 // If already exists, return true
276 bool PathExists(const std::string &path)
279 return (stat(path.c_str(),&st) == 0);
282 bool IsPathAbsolute(const std::string &path)
284 return path[0] == '/';
287 bool IsDir(const std::string &path)
289 struct stat statbuf{};
290 if(stat(path.c_str(), &statbuf))
291 return false; // Actually error; but certainly not a directory
292 return ((statbuf.st_mode & S_IFDIR) == S_IFDIR);
295 bool IsDirDelimiter(char c)
300 bool RecursiveDelete(const std::string &path)
303 Execute the 'rm' command directly, by fork() and execve()
306 infostream<<"Removing \""<<path<<"\""<<std::endl;
310 pid_t child_pid = fork();
315 char argv_data[3][10000];
316 strcpy(argv_data[0], "/bin/rm");
317 strcpy(argv_data[1], "-rf");
318 strncpy(argv_data[2], path.c_str(), 10000);
320 argv[0] = argv_data[0];
321 argv[1] = argv_data[1];
322 argv[2] = argv_data[2];
325 verbosestream<<"Executing '"<<argv[0]<<"' '"<<argv[1]<<"' '"
326 <<argv[2]<<"'"<<std::endl;
328 execv(argv[0], argv);
330 // Execv shouldn't return. Failed.
339 tpid = wait(&child_status);
340 //if(tpid != child_pid) process_terminated(tpid);
341 }while(tpid != child_pid);
342 return (child_status == 0);
346 bool DeleteSingleFileOrEmptyDirectory(const std::string &path)
349 bool did = (rmdir(path.c_str()) == 0);
351 errorstream << "rmdir errno: " << errno << ": " << strerror(errno)
356 bool did = (unlink(path.c_str()) == 0);
358 errorstream << "unlink errno: " << errno << ": " << strerror(errno)
363 std::string TempPath()
366 Should the environment variables TMPDIR, TMP and TEMP
367 and the macro P_tmpdir (if defined by stdio.h) be checked
368 before falling back on /tmp?
370 Probably not, because this function is intended to be
371 compatible with lua's os.tmpname which under the default
372 configuration hardcodes mkstemp("/tmp/lua_XXXXXX").
375 return DIR_DELIM "sdcard" DIR_DELIM PROJECT_NAME DIR_DELIM "tmp";
377 return DIR_DELIM "tmp";
383 void GetRecursiveDirs(std::vector<std::string> &dirs, const std::string &dir)
385 static const std::set<char> chars_to_ignore = { '_', '.' };
386 if (dir.empty() || !IsDir(dir))
389 fs::GetRecursiveSubPaths(dir, dirs, false, chars_to_ignore);
392 std::vector<std::string> GetRecursiveDirs(const std::string &dir)
394 std::vector<std::string> result;
395 GetRecursiveDirs(result, dir);
399 void GetRecursiveSubPaths(const std::string &path,
400 std::vector<std::string> &dst,
402 const std::set<char> &ignore)
404 std::vector<DirListNode> content = GetDirListing(path);
405 for (const auto &n : content) {
406 std::string fullpath = path + DIR_DELIM + n.name;
407 if (ignore.count(n.name[0]))
409 if (list_files || n.dir)
410 dst.push_back(fullpath);
412 GetRecursiveSubPaths(fullpath, dst, list_files, ignore);
416 bool DeletePaths(const std::vector<std::string> &paths)
419 // Go backwards to succesfully delete the output of GetRecursiveSubPaths
420 for(int i=paths.size()-1; i>=0; i--){
421 const std::string &path = paths[i];
422 bool did = DeleteSingleFileOrEmptyDirectory(path);
424 errorstream<<"Failed to delete "<<path<<std::endl;
431 bool RecursiveDeleteContent(const std::string &path)
433 infostream<<"Removing content of \""<<path<<"\""<<std::endl;
434 std::vector<DirListNode> list = GetDirListing(path);
435 for (const DirListNode &dln : list) {
436 if(trim(dln.name) == "." || trim(dln.name) == "..")
438 std::string childpath = path + DIR_DELIM + dln.name;
439 bool r = RecursiveDelete(childpath);
441 errorstream << "Removing \"" << childpath << "\" failed" << std::endl;
448 bool CreateAllDirs(const std::string &path)
451 std::vector<std::string> tocreate;
452 std::string basepath = path;
453 while(!PathExists(basepath))
455 tocreate.push_back(basepath);
456 basepath = RemoveLastPathComponent(basepath);
460 for(int i=tocreate.size()-1;i>=0;i--)
461 if(!CreateDir(tocreate[i]))
466 bool CopyFileContents(const std::string &source, const std::string &target)
468 FILE *sourcefile = fopen(source.c_str(), "rb");
469 if(sourcefile == NULL){
470 errorstream<<source<<": can't open for reading: "
471 <<strerror(errno)<<std::endl;
475 FILE *targetfile = fopen(target.c_str(), "wb");
476 if(targetfile == NULL){
477 errorstream<<target<<": can't open for writing: "
478 <<strerror(errno)<<std::endl;
486 char readbuffer[BUFSIZ];
488 size_t readbytes = fread(readbuffer, 1,
489 sizeof(readbuffer), sourcefile);
491 if(ferror(sourcefile)){
492 errorstream<<source<<": IO error: "
493 <<strerror(errno)<<std::endl;
498 fwrite(readbuffer, 1, readbytes, targetfile);
500 if(feof(sourcefile) || ferror(sourcefile)){
501 // flush destination file to catch write errors
506 if(ferror(targetfile)){
507 errorstream<<target<<": IO error: "
508 <<strerror(errno)<<std::endl;
513 infostream<<"copied "<<total<<" bytes from "
514 <<source<<" to "<<target<<std::endl;
520 bool CopyDir(const std::string &source, const std::string &target)
522 if(PathExists(source)){
523 if(!PathExists(target)){
524 fs::CreateAllDirs(target);
527 std::vector<DirListNode> content = fs::GetDirListing(source);
529 for (const auto &dln : content) {
530 std::string sourcechild = source + DIR_DELIM + dln.name;
531 std::string targetchild = target + DIR_DELIM + dln.name;
533 if(!fs::CopyDir(sourcechild, targetchild)){
538 if(!fs::CopyFileContents(sourcechild, targetchild)){
549 bool PathStartsWith(const std::string &path, const std::string &prefix)
551 size_t pathsize = path.size();
553 size_t prefixsize = prefix.size();
554 size_t prefixpos = 0;
556 bool delim1 = pathpos == pathsize
557 || IsDirDelimiter(path[pathpos]);
558 bool delim2 = prefixpos == prefixsize
559 || IsDirDelimiter(prefix[prefixpos]);
565 while(pathpos < pathsize &&
566 IsDirDelimiter(path[pathpos]))
568 while(prefixpos < prefixsize &&
569 IsDirDelimiter(prefix[prefixpos]))
571 if(prefixpos == prefixsize)
573 if(pathpos == pathsize)
579 char pathchar = path[pathpos+len];
580 char prefixchar = prefix[prefixpos+len];
581 if(FILESYS_CASE_INSENSITIVE){
582 pathchar = tolower(pathchar);
583 prefixchar = tolower(prefixchar);
585 if(pathchar != prefixchar)
588 } while(pathpos+len < pathsize
589 && !IsDirDelimiter(path[pathpos+len])
590 && prefixpos+len < prefixsize
592 prefix[prefixpos+len]));
599 std::string RemoveLastPathComponent(const std::string &path,
600 std::string *removed, int count)
605 size_t remaining = path.size();
607 for(int i = 0; i < count; ++i){
608 // strip a dir delimiter
609 while(remaining != 0 && IsDirDelimiter(path[remaining-1]))
611 // strip a path component
612 size_t component_end = remaining;
613 while(remaining != 0 && !IsDirDelimiter(path[remaining-1]))
615 size_t component_start = remaining;
616 // strip a dir delimiter
617 while(remaining != 0 && IsDirDelimiter(path[remaining-1]))
620 std::string component = path.substr(component_start,
621 component_end - component_start);
623 *removed = component + DIR_DELIM + *removed;
625 *removed = component;
628 return path.substr(0, remaining);
631 std::string RemoveRelativePathComponents(std::string path)
633 size_t pos = path.size();
634 size_t dotdot_count = 0;
636 size_t component_with_delim_end = pos;
637 // skip a dir delimiter
638 while (pos != 0 && IsDirDelimiter(path[pos-1]))
640 // strip a path component
641 size_t component_end = pos;
642 while (pos != 0 && !IsDirDelimiter(path[pos-1]))
644 size_t component_start = pos;
646 std::string component = path.substr(component_start,
647 component_end - component_start);
648 bool remove_this_component = false;
649 if (component == ".") {
650 remove_this_component = true;
651 } else if (component == "..") {
652 remove_this_component = true;
654 } else if (dotdot_count != 0) {
655 remove_this_component = true;
659 if (remove_this_component) {
660 while (pos != 0 && IsDirDelimiter(path[pos-1]))
662 if (component_start == 0) {
663 // We need to remove the delemiter too
664 path = path.substr(component_with_delim_end, std::string::npos);
666 path = path.substr(0, pos) + DIR_DELIM +
667 path.substr(component_with_delim_end, std::string::npos);
674 if (dotdot_count > 0)
677 // remove trailing dir delimiters
679 while (pos != 0 && IsDirDelimiter(path[pos-1]))
681 return path.substr(0, pos);
684 std::string AbsolutePath(const std::string &path)
687 char *abs_path = _fullpath(NULL, path.c_str(), MAX_PATH);
689 char *abs_path = realpath(path.c_str(), NULL);
691 if (!abs_path) return "";
692 std::string abs_path_str(abs_path);
697 const char *GetFilenameFromPath(const char *path)
699 const char *filename = strrchr(path, DIR_DELIM_CHAR);
700 return filename ? filename + 1 : path;
703 bool safeWriteToFile(const std::string &path, const std::string &content)
705 std::string tmp_file = path + ".~mt";
707 // Write to a tmp file
708 std::ofstream os(tmp_file.c_str(), std::ios::binary);
715 // Remove the temporary file because writing it failed and it's useless.
716 remove(tmp_file.c_str());
720 bool rename_success = false;
722 // Move the finished temporary file over the real file
724 // When creating the file, it can cause Windows Search indexer, virus scanners and other apps
725 // to query the file. This can make the move file call below fail.
726 // We retry up to 5 times, with a 1ms sleep between, before we consider the whole operation failed
727 int number_attempts = 0;
728 while (number_attempts < 5) {
729 rename_success = MoveFileEx(tmp_file.c_str(), path.c_str(),
730 MOVEFILE_REPLACE_EXISTING | MOVEFILE_WRITE_THROUGH);
737 // On POSIX compliant systems rename() is specified to be able to swap the
738 // file in place of the destination file, making this a truly error-proof
740 rename_success = rename(tmp_file.c_str(), path.c_str()) == 0;
742 if (!rename_success) {
743 warningstream << "Failed to write to file: " << path.c_str() << std::endl;
744 // Remove the temporary file because moving it over the target file
746 remove(tmp_file.c_str());
753 bool Rename(const std::string &from, const std::string &to)
755 return rename(from.c_str(), to.c_str()) == 0;