Modernize client code (#6250)
[oweals/minetest.git] / src / filesys.cpp
index 597643887c43a8365144461340a16357820c8a06..bd8b94aff98ff86ebf2ca6a0a5383c4625fd8717 100644 (file)
@@ -26,6 +26,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include <fstream>
 #include "log.h"
 #include "config.h"
+#include "porting.h"
 
 namespace fs
 {
@@ -34,8 +35,9 @@ namespace fs
 
 #define _WIN32_WINNT 0x0501
 #include <windows.h>
+#include <shlwapi.h>
 
-std::vector<DirListNode> GetDirListing(std::string pathstring)
+std::vector<DirListNode> GetDirListing(const std::string &pathstring)
 {
        std::vector<DirListNode> listing;
 
@@ -44,7 +46,7 @@ std::vector<DirListNode> GetDirListing(std::string pathstring)
        DWORD dwError;
 
        std::string dirSpec = pathstring + "\\*";
-       
+
        // Find the first file in the directory.
        hFind = FindFirstFile(dirSpec.c_str(), &FindFileData);
 
@@ -86,7 +88,7 @@ std::vector<DirListNode> GetDirListing(std::string pathstring)
        return listing;
 }
 
-bool CreateDir(std::string path)
+bool CreateDir(const std::string &path)
 {
        bool r = CreateDirectory(path.c_str(), NULL);
        if(r == true)
@@ -96,12 +98,17 @@ bool CreateDir(std::string path)
        return false;
 }
 
-bool PathExists(std::string path)
+bool PathExists(const std::string &path)
 {
        return (GetFileAttributes(path.c_str()) != INVALID_FILE_ATTRIBUTES);
 }
 
-bool IsDir(std::string path)
+bool IsPathAbsolute(const std::string &path)
+{
+       return !PathIsRelative(path.c_str());
+}
+
+bool IsDir(const std::string &path)
 {
        DWORD attr = GetFileAttributes(path.c_str());
        return (attr != INVALID_FILE_ATTRIBUTES &&
@@ -113,7 +120,7 @@ bool IsDirDelimiter(char c)
        return c == '/' || c == '\\';
 }
 
-bool RecursiveDelete(std::string path)
+bool RecursiveDelete(const std::string &path)
 {
        infostream<<"Recursively deleting \""<<path<<"\""<<std::endl;
 
@@ -136,7 +143,7 @@ bool RecursiveDelete(std::string path)
                infostream<<"RecursiveDelete: Deleting content of directory "
                                <<path<<std::endl;
                std::vector<DirListNode> content = GetDirListing(path);
-               for(int i=0; i<content.size(); i++){
+               for(size_t i=0; i<content.size(); i++){
                        const DirListNode &n = content[i];
                        std::string fullpath = path + DIR_DELIM + n.name;
                        bool did = RecursiveDelete(fullpath);
@@ -158,7 +165,7 @@ bool RecursiveDelete(std::string path)
        return true;
 }
 
-bool DeleteSingleFileOrEmptyDirectory(std::string path)
+bool DeleteSingleFileOrEmptyDirectory(const std::string &path)
 {
        DWORD attr = GetFileAttributes(path.c_str());
        bool is_directory = (attr != INVALID_FILE_ATTRIBUTES &&
@@ -177,7 +184,7 @@ bool DeleteSingleFileOrEmptyDirectory(std::string path)
 
 std::string TempPath()
 {
-       DWORD bufsize = GetTempPath(0, "");
+       DWORD bufsize = GetTempPath(0, NULL);
        if(bufsize == 0){
                errorstream<<"GetTempPath failed, error = "<<GetLastError()<<std::endl;
                return "";
@@ -199,7 +206,7 @@ std::string TempPath()
 #include <sys/wait.h>
 #include <unistd.h>
 
-std::vector<DirListNode> GetDirListing(std::string pathstring)
+std::vector<DirListNode> GetDirListing(const std::string &pathstring)
 {
        std::vector<DirListNode> listing;
 
@@ -252,7 +259,7 @@ std::vector<DirListNode> GetDirListing(std::string pathstring)
        return listing;
 }
 
-bool CreateDir(std::string path)
+bool CreateDir(const std::string &path)
 {
        int r = mkdir(path.c_str(), S_IRWXU | S_IRWXG | S_IROTH | S_IXOTH);
        if(r == 0)
@@ -268,13 +275,18 @@ bool CreateDir(std::string path)
        }
 }
 
-bool PathExists(std::string path)
+bool PathExists(const std::string &path)
 {
        struct stat st;
        return (stat(path.c_str(),&st) == 0);
 }
 
-bool IsDir(std::string path)
+bool IsPathAbsolute(const std::string &path)
+{
+       return path[0] == '/';
+}
+
+bool IsDir(const std::string &path)
 {
        struct stat statbuf;
        if(stat(path.c_str(), &statbuf))
@@ -287,16 +299,16 @@ bool IsDirDelimiter(char c)
        return c == '/';
 }
 
-bool RecursiveDelete(std::string path)
+bool RecursiveDelete(const std::string &path)
 {
        /*
                Execute the 'rm' command directly, by fork() and execve()
        */
-       
+
        infostream<<"Removing \""<<path<<"\""<<std::endl;
 
        //return false;
-       
+
        pid_t child_pid = fork();
 
        if(child_pid == 0)
@@ -314,9 +326,9 @@ bool RecursiveDelete(std::string path)
 
                verbosestream<<"Executing '"<<argv[0]<<"' '"<<argv[1]<<"' '"
                                <<argv[2]<<"'"<<std::endl;
-               
+
                execv(argv[0], argv);
-               
+
                // Execv shouldn't return. Failed.
                _exit(1);
        }
@@ -333,7 +345,7 @@ bool RecursiveDelete(std::string path)
        }
 }
 
-bool DeleteSingleFileOrEmptyDirectory(std::string path)
+bool DeleteSingleFileOrEmptyDirectory(const std::string &path)
 {
        if(IsDir(path)){
                bool did = (rmdir(path.c_str()) == 0);
@@ -370,14 +382,16 @@ std::string TempPath()
 
 #endif
 
-void GetRecursiveSubPaths(std::string path, std::vector<std::string> &dst)
+void GetRecursiveSubPaths(const std::string &path, std::vector<std::string> &dst)
 {
        std::vector<DirListNode> content = GetDirListing(path);
        for(unsigned int  i=0; i<content.size(); i++){
                const DirListNode &n = content[i];
                std::string fullpath = path + DIR_DELIM + n.name;
                dst.push_back(fullpath);
-               GetRecursiveSubPaths(fullpath, dst);
+               if (n.dir) {
+                       GetRecursiveSubPaths(fullpath, dst);
+               }
        }
 }
 
@@ -396,7 +410,7 @@ bool DeletePaths(const std::vector<std::string> &paths)
        return success;
 }
 
-bool RecursiveDeleteContent(std::string path)
+bool RecursiveDeleteContent(const std::string &path)
 {
        infostream<<"Removing content of \""<<path<<"\""<<std::endl;
        std::vector<DirListNode> list = GetDirListing(path);
@@ -415,7 +429,7 @@ bool RecursiveDeleteContent(std::string path)
        return true;
 }
 
-bool CreateAllDirs(std::string path)
+bool CreateAllDirs(const std::string &path)
 {
 
        std::vector<std::string> tocreate;
@@ -433,7 +447,7 @@ bool CreateAllDirs(std::string path)
        return true;
 }
 
-bool CopyFileContents(std::string source, std::string target)
+bool CopyFileContents(const std::string &source, const std::string &target)
 {
        FILE *sourcefile = fopen(source.c_str(), "rb");
        if(sourcefile == NULL){
@@ -487,7 +501,7 @@ bool CopyFileContents(std::string source, std::string target)
        return retval;
 }
 
-bool CopyDir(std::string source, std::string target)
+bool CopyDir(const std::string &source, const std::string &target)
 {
        if(PathExists(source)){
                if(!PathExists(target)){
@@ -517,7 +531,7 @@ bool CopyDir(std::string source, std::string target)
        }
 }
 
-bool PathStartsWith(std::string path, std::string prefix)
+bool PathStartsWith(const std::string &path, const std::string &prefix)
 {
        size_t pathsize = path.size();
        size_t pathpos = 0;
@@ -567,7 +581,7 @@ bool PathStartsWith(std::string path, std::string prefix)
        }
 }
 
-std::string RemoveLastPathComponent(std::string path,
+std::string RemoveLastPathComponent(const std::string &path,
                std::string *removed, int count)
 {
        if(removed)
@@ -603,52 +617,74 @@ std::string RemoveRelativePathComponents(std::string path)
 {
        size_t pos = path.size();
        size_t dotdot_count = 0;
-       while(pos != 0){
+       while (pos != 0) {
                size_t component_with_delim_end = pos;
                // skip a dir delimiter
-               while(pos != 0 && IsDirDelimiter(path[pos-1]))
+               while (pos != 0 && IsDirDelimiter(path[pos-1]))
                        pos--;
                // strip a path component
                size_t component_end = pos;
-               while(pos != 0 && !IsDirDelimiter(path[pos-1]))
+               while (pos != 0 && !IsDirDelimiter(path[pos-1]))
                        pos--;
                size_t component_start = pos;
 
                std::string component = path.substr(component_start,
                                component_end - component_start);
                bool remove_this_component = false;
-               if(component == "."){
+               if (component == ".") {
                        remove_this_component = true;
-               }
-               else if(component == ".."){
+               } else if (component == "..") {
                        remove_this_component = true;
                        dotdot_count += 1;
-               }
-               else if(dotdot_count != 0){
+               } else if (dotdot_count != 0) {
                        remove_this_component = true;
                        dotdot_count -= 1;
                }
 
-               if(remove_this_component){
-                       while(pos != 0 && IsDirDelimiter(path[pos-1]))
+               if (remove_this_component) {
+                       while (pos != 0 && IsDirDelimiter(path[pos-1]))
                                pos--;
-                       path = path.substr(0, pos) + DIR_DELIM +
-                               path.substr(component_with_delim_end,
-                                               std::string::npos);
-                       pos++;
+                       if (component_start == 0) {
+                               // We need to remove the delemiter too
+                               path = path.substr(component_with_delim_end, std::string::npos);
+                       } else {
+                               path = path.substr(0, pos) + DIR_DELIM +
+                                       path.substr(component_with_delim_end, std::string::npos);
+                       }
+                       if (pos > 0)
+                               pos++;
                }
        }
 
-       if(dotdot_count > 0)
+       if (dotdot_count > 0)
                return "";
 
        // remove trailing dir delimiters
        pos = path.size();
-       while(pos != 0 && IsDirDelimiter(path[pos-1]))
+       while (pos != 0 && IsDirDelimiter(path[pos-1]))
                pos--;
        return path.substr(0, pos);
 }
 
+std::string AbsolutePath(const std::string &path)
+{
+#ifdef _WIN32
+       char *abs_path = _fullpath(NULL, path.c_str(), MAX_PATH);
+#else
+       char *abs_path = realpath(path.c_str(), NULL);
+#endif
+       if (!abs_path) return "";
+       std::string abs_path_str(abs_path);
+       free(abs_path);
+       return abs_path_str;
+}
+
+const char *GetFilenameFromPath(const char *path)
+{
+       const char *filename = strrchr(path, DIR_DELIM_CHAR);
+       return filename ? filename + 1 : path;
+}
+
 bool safeWriteToFile(const std::string &path, const std::string &content)
 {
        std::string tmp_file = path + ".~mt";
@@ -661,18 +697,47 @@ bool safeWriteToFile(const std::string &path, const std::string &content)
        os.flush();
        os.close();
        if (os.fail()) {
+               // Remove the temporary file because writing it failed and it's useless.
                remove(tmp_file.c_str());
                return false;
        }
 
-       // Copy file
-       remove(path.c_str());
-       if(rename(tmp_file.c_str(), path.c_str())) {
+       bool rename_success = false;
+
+       // Move the finished temporary file over the real file
+#ifdef _WIN32
+       // When creating the file, it can cause Windows Search indexer, virus scanners and other apps
+       // to query the file. This can make the move file call below fail.
+       // We retry up to 5 times, with a 1ms sleep between, before we consider the whole operation failed
+       int number_attempts = 0;
+       while (number_attempts < 5) {
+               rename_success = MoveFileEx(tmp_file.c_str(), path.c_str(),
+                               MOVEFILE_REPLACE_EXISTING | MOVEFILE_WRITE_THROUGH);
+               if (rename_success)
+                       break;
+               sleep_ms(1);
+               ++number_attempts;
+       }
+#else
+       // On POSIX compliant systems rename() is specified to be able to swap the
+       // file in place of the destination file, making this a truly error-proof
+       // transaction.
+       rename_success = rename(tmp_file.c_str(), path.c_str()) == 0;
+#endif
+       if (!rename_success) {
+               warningstream << "Failed to write to file: " << path.c_str() << std::endl;
+               // Remove the temporary file because moving it over the target file
+               // failed.
                remove(tmp_file.c_str());
                return false;
-       } else {
-               return true;
        }
+
+       return true;
+}
+
+bool Rename(const std::string &from, const std::string &to)
+{
+       return rename(from.c_str(), to.c_str()) == 0;
 }
 
 } // namespace fs