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?
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);
271 // If already exists, return true
278 bool PathExists(const std::string &path)
281 return (stat(path.c_str(),&st) == 0);
284 bool IsPathAbsolute(const std::string &path)
286 return path[0] == '/';
289 bool IsDir(const std::string &path)
292 if(stat(path.c_str(), &statbuf))
293 return false; // Actually error; but certainly not a directory
294 return ((statbuf.st_mode & S_IFDIR) == S_IFDIR);
297 bool IsDirDelimiter(char c)
302 bool RecursiveDelete(const std::string &path)
305 Execute the 'rm' command directly, by fork() and execve()
308 infostream<<"Removing \""<<path<<"\""<<std::endl;
312 pid_t child_pid = fork();
317 char argv_data[3][10000];
318 strcpy(argv_data[0], "/bin/rm");
319 strcpy(argv_data[1], "-rf");
320 strncpy(argv_data[2], path.c_str(), 10000);
322 argv[0] = argv_data[0];
323 argv[1] = argv_data[1];
324 argv[2] = argv_data[2];
327 verbosestream<<"Executing '"<<argv[0]<<"' '"<<argv[1]<<"' '"
328 <<argv[2]<<"'"<<std::endl;
330 execv(argv[0], argv);
332 // Execv shouldn't return. Failed.
341 tpid = wait(&child_status);
342 //if(tpid != child_pid) process_terminated(tpid);
343 }while(tpid != child_pid);
344 return (child_status == 0);
348 bool DeleteSingleFileOrEmptyDirectory(const std::string &path)
351 bool did = (rmdir(path.c_str()) == 0);
353 errorstream<<"rmdir errno: "<<errno<<": "<<strerror(errno)
357 bool did = (unlink(path.c_str()) == 0);
359 errorstream<<"unlink errno: "<<errno<<": "<<strerror(errno)
365 std::string TempPath()
368 Should the environment variables TMPDIR, TMP and TEMP
369 and the macro P_tmpdir (if defined by stdio.h) be checked
370 before falling back on /tmp?
372 Probably not, because this function is intended to be
373 compatible with lua's os.tmpname which under the default
374 configuration hardcodes mkstemp("/tmp/lua_XXXXXX").
377 return DIR_DELIM "sdcard" DIR_DELIM PROJECT_NAME DIR_DELIM "tmp";
379 return DIR_DELIM "tmp";
385 void GetRecursiveSubPaths(const std::string &path, std::vector<std::string> &dst)
387 std::vector<DirListNode> content = GetDirListing(path);
388 for(unsigned int i=0; i<content.size(); i++){
389 const DirListNode &n = content[i];
390 std::string fullpath = path + DIR_DELIM + n.name;
391 dst.push_back(fullpath);
393 GetRecursiveSubPaths(fullpath, dst);
398 bool DeletePaths(const std::vector<std::string> &paths)
401 // Go backwards to succesfully delete the output of GetRecursiveSubPaths
402 for(int i=paths.size()-1; i>=0; i--){
403 const std::string &path = paths[i];
404 bool did = DeleteSingleFileOrEmptyDirectory(path);
406 errorstream<<"Failed to delete "<<path<<std::endl;
413 bool RecursiveDeleteContent(const std::string &path)
415 infostream<<"Removing content of \""<<path<<"\""<<std::endl;
416 std::vector<DirListNode> list = GetDirListing(path);
417 for(unsigned int i=0; i<list.size(); i++)
419 if(trim(list[i].name) == "." || trim(list[i].name) == "..")
421 std::string childpath = path + DIR_DELIM + list[i].name;
422 bool r = RecursiveDelete(childpath);
425 errorstream<<"Removing \""<<childpath<<"\" failed"<<std::endl;
432 bool CreateAllDirs(const std::string &path)
435 std::vector<std::string> tocreate;
436 std::string basepath = path;
437 while(!PathExists(basepath))
439 tocreate.push_back(basepath);
440 basepath = RemoveLastPathComponent(basepath);
444 for(int i=tocreate.size()-1;i>=0;i--)
445 if(!CreateDir(tocreate[i]))
450 bool CopyFileContents(const std::string &source, const std::string &target)
452 FILE *sourcefile = fopen(source.c_str(), "rb");
453 if(sourcefile == NULL){
454 errorstream<<source<<": can't open for reading: "
455 <<strerror(errno)<<std::endl;
459 FILE *targetfile = fopen(target.c_str(), "wb");
460 if(targetfile == NULL){
461 errorstream<<target<<": can't open for writing: "
462 <<strerror(errno)<<std::endl;
470 char readbuffer[BUFSIZ];
472 size_t readbytes = fread(readbuffer, 1,
473 sizeof(readbuffer), sourcefile);
475 if(ferror(sourcefile)){
476 errorstream<<source<<": IO error: "
477 <<strerror(errno)<<std::endl;
482 fwrite(readbuffer, 1, readbytes, targetfile);
484 if(feof(sourcefile) || ferror(sourcefile)){
485 // flush destination file to catch write errors
490 if(ferror(targetfile)){
491 errorstream<<target<<": IO error: "
492 <<strerror(errno)<<std::endl;
497 infostream<<"copied "<<total<<" bytes from "
498 <<source<<" to "<<target<<std::endl;
504 bool CopyDir(const std::string &source, const std::string &target)
506 if(PathExists(source)){
507 if(!PathExists(target)){
508 fs::CreateAllDirs(target);
511 std::vector<DirListNode> content = fs::GetDirListing(source);
513 for(unsigned int i=0; i < content.size(); i++){
514 std::string sourcechild = source + DIR_DELIM + content[i].name;
515 std::string targetchild = target + DIR_DELIM + content[i].name;
517 if(!fs::CopyDir(sourcechild, targetchild)){
522 if(!fs::CopyFileContents(sourcechild, targetchild)){
534 bool PathStartsWith(const std::string &path, const std::string &prefix)
536 size_t pathsize = path.size();
538 size_t prefixsize = prefix.size();
539 size_t prefixpos = 0;
541 bool delim1 = pathpos == pathsize
542 || IsDirDelimiter(path[pathpos]);
543 bool delim2 = prefixpos == prefixsize
544 || IsDirDelimiter(prefix[prefixpos]);
550 while(pathpos < pathsize &&
551 IsDirDelimiter(path[pathpos]))
553 while(prefixpos < prefixsize &&
554 IsDirDelimiter(prefix[prefixpos]))
556 if(prefixpos == prefixsize)
558 if(pathpos == pathsize)
564 char pathchar = path[pathpos+len];
565 char prefixchar = prefix[prefixpos+len];
566 if(FILESYS_CASE_INSENSITIVE){
567 pathchar = tolower(pathchar);
568 prefixchar = tolower(prefixchar);
570 if(pathchar != prefixchar)
573 } while(pathpos+len < pathsize
574 && !IsDirDelimiter(path[pathpos+len])
575 && prefixpos+len < prefixsize
577 prefix[prefixpos+len]));
584 std::string RemoveLastPathComponent(const std::string &path,
585 std::string *removed, int count)
590 size_t remaining = path.size();
592 for(int i = 0; i < count; ++i){
593 // strip a dir delimiter
594 while(remaining != 0 && IsDirDelimiter(path[remaining-1]))
596 // strip a path component
597 size_t component_end = remaining;
598 while(remaining != 0 && !IsDirDelimiter(path[remaining-1]))
600 size_t component_start = remaining;
601 // strip a dir delimiter
602 while(remaining != 0 && IsDirDelimiter(path[remaining-1]))
605 std::string component = path.substr(component_start,
606 component_end - component_start);
608 *removed = component + DIR_DELIM + *removed;
610 *removed = component;
613 return path.substr(0, remaining);
616 std::string RemoveRelativePathComponents(std::string path)
618 size_t pos = path.size();
619 size_t dotdot_count = 0;
621 size_t component_with_delim_end = pos;
622 // skip a dir delimiter
623 while (pos != 0 && IsDirDelimiter(path[pos-1]))
625 // strip a path component
626 size_t component_end = pos;
627 while (pos != 0 && !IsDirDelimiter(path[pos-1]))
629 size_t component_start = pos;
631 std::string component = path.substr(component_start,
632 component_end - component_start);
633 bool remove_this_component = false;
634 if (component == ".") {
635 remove_this_component = true;
636 } else if (component == "..") {
637 remove_this_component = true;
639 } else if (dotdot_count != 0) {
640 remove_this_component = true;
644 if (remove_this_component) {
645 while (pos != 0 && IsDirDelimiter(path[pos-1]))
647 if (component_start == 0) {
648 // We need to remove the delemiter too
649 path = path.substr(component_with_delim_end, std::string::npos);
651 path = path.substr(0, pos) + DIR_DELIM +
652 path.substr(component_with_delim_end, std::string::npos);
659 if (dotdot_count > 0)
662 // remove trailing dir delimiters
664 while (pos != 0 && IsDirDelimiter(path[pos-1]))
666 return path.substr(0, pos);
669 std::string AbsolutePath(const std::string &path)
672 char *abs_path = _fullpath(NULL, path.c_str(), MAX_PATH);
674 char *abs_path = realpath(path.c_str(), NULL);
676 if (!abs_path) return "";
677 std::string abs_path_str(abs_path);
682 const char *GetFilenameFromPath(const char *path)
684 const char *filename = strrchr(path, DIR_DELIM_CHAR);
685 return filename ? filename + 1 : path;
688 bool safeWriteToFile(const std::string &path, const std::string &content)
690 std::string tmp_file = path + ".~mt";
692 // Write to a tmp file
693 std::ofstream os(tmp_file.c_str(), std::ios::binary);
700 // Remove the temporary file because writing it failed and it's useless.
701 remove(tmp_file.c_str());
705 bool rename_success = false;
707 // Move the finished temporary file over the real file
709 // When creating the file, it can cause Windows Search indexer, virus scanners and other apps
710 // to query the file. This can make the move file call below fail.
711 // We retry up to 5 times, with a 1ms sleep between, before we consider the whole operation failed
712 int number_attempts = 0;
713 while (number_attempts < 5) {
714 rename_success = MoveFileEx(tmp_file.c_str(), path.c_str(),
715 MOVEFILE_REPLACE_EXISTING | MOVEFILE_WRITE_THROUGH);
722 // On POSIX compliant systems rename() is specified to be able to swap the
723 // file in place of the destination file, making this a truly error-proof
725 rename_success = rename(tmp_file.c_str(), path.c_str()) == 0;
727 if (!rename_success) {
728 warningstream << "Failed to write to file: " << path.c_str() << std::endl;
729 // Remove the temporary file because moving it over the target file
731 remove(tmp_file.c_str());
738 bool Rename(const std::string &from, const std::string &to)
740 return rename(from.c_str(), to.c_str()) == 0;