Really delete things in fs::RecursiveDelete (#7433)
[oweals/minetest.git] / src / filesys.cpp
1 /*
2 Minetest
3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
4
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.
9
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.
14
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.
18 */
19
20 #include "filesys.h"
21 #include "util/string.h"
22 #include <iostream>
23 #include <cstdio>
24 #include <cstring>
25 #include <cerrno>
26 #include <fstream>
27 #include "log.h"
28 #include "config.h"
29 #include "porting.h"
30 #ifdef __ANDROID__
31 #include "settings.h" // For g_settings
32 #endif
33
34 namespace fs
35 {
36
37 #ifdef _WIN32 // WINDOWS
38
39 #define _WIN32_WINNT 0x0501
40 #include <windows.h>
41 #include <shlwapi.h>
42
43 std::vector<DirListNode> GetDirListing(const std::string &pathstring)
44 {
45         std::vector<DirListNode> listing;
46
47         WIN32_FIND_DATA FindFileData;
48         HANDLE hFind = INVALID_HANDLE_VALUE;
49         DWORD dwError;
50
51         std::string dirSpec = pathstring + "\\*";
52
53         // Find the first file in the directory.
54         hFind = FindFirstFile(dirSpec.c_str(), &FindFileData);
55
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;
61                 }
62         } else {
63                 // NOTE:
64                 // Be very sure to not include '..' in the results, it will
65                 // result in an epic failure when deleting stuff.
66
67                 DirListNode node;
68                 node.name = FindFileData.cFileName;
69                 node.dir = FindFileData.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY;
70                 if (node.name != "." && node.name != "..")
71                         listing.push_back(node);
72
73                 // List all the other files in the directory.
74                 while (FindNextFile(hFind, &FindFileData) != 0) {
75                         DirListNode node;
76                         node.name = FindFileData.cFileName;
77                         node.dir = FindFileData.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY;
78                         if(node.name != "." && node.name != "..")
79                                 listing.push_back(node);
80                 }
81
82                 dwError = GetLastError();
83                 FindClose(hFind);
84                 if (dwError != ERROR_NO_MORE_FILES) {
85                         errorstream << "GetDirListing: FindNextFile error."
86                                         << " Error is " << dwError << std::endl;
87                         listing.clear();
88                         return listing;
89                 }
90         }
91         return listing;
92 }
93
94 bool CreateDir(const std::string &path)
95 {
96         bool r = CreateDirectory(path.c_str(), NULL);
97         if(r == true)
98                 return true;
99         if(GetLastError() == ERROR_ALREADY_EXISTS)
100                 return true;
101         return false;
102 }
103
104 bool PathExists(const std::string &path)
105 {
106         return (GetFileAttributes(path.c_str()) != INVALID_FILE_ATTRIBUTES);
107 }
108
109 bool IsPathAbsolute(const std::string &path)
110 {
111         return !PathIsRelative(path.c_str());
112 }
113
114 bool IsDir(const std::string &path)
115 {
116         DWORD attr = GetFileAttributes(path.c_str());
117         return (attr != INVALID_FILE_ATTRIBUTES &&
118                         (attr & FILE_ATTRIBUTE_DIRECTORY));
119 }
120
121 bool IsDirDelimiter(char c)
122 {
123         return c == '/' || c == '\\';
124 }
125
126 bool RecursiveDelete(const std::string &path)
127 {
128         infostream << "Recursively deleting \"" << path << "\"" << std::endl;
129         if (!IsDir(path)) {
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;
134                         return false;
135                 }
136                 return true;
137         }
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;
146                         return false;
147                 }
148         }
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;
153                 return false;
154         }
155         return true;
156 }
157
158 bool DeleteSingleFileOrEmptyDirectory(const std::string &path)
159 {
160         DWORD attr = GetFileAttributes(path.c_str());
161         bool is_directory = (attr != INVALID_FILE_ATTRIBUTES &&
162                         (attr & FILE_ATTRIBUTE_DIRECTORY));
163         if(!is_directory)
164         {
165                 bool did = DeleteFile(path.c_str());
166                 return did;
167         }
168         else
169         {
170                 bool did = RemoveDirectory(path.c_str());
171                 return did;
172         }
173 }
174
175 std::string TempPath()
176 {
177         DWORD bufsize = GetTempPath(0, NULL);
178         if(bufsize == 0){
179                 errorstream<<"GetTempPath failed, error = "<<GetLastError()<<std::endl;
180                 return "";
181         }
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;
186                 return "";
187         }
188         return std::string(buf.begin(), buf.begin() + len);
189 }
190
191 #else // POSIX
192
193 #include <sys/types.h>
194 #include <dirent.h>
195 #include <sys/stat.h>
196 #include <sys/wait.h>
197 #include <unistd.h>
198
199 std::vector<DirListNode> GetDirListing(const std::string &pathstring)
200 {
201         std::vector<DirListNode> listing;
202
203         DIR *dp;
204         struct dirent *dirp;
205         if((dp = opendir(pathstring.c_str())) == NULL) {
206                 //infostream<<"Error("<<errno<<") opening "<<pathstring<<std::endl;
207                 return listing;
208         }
209
210         while ((dirp = readdir(dp)) != NULL) {
211                 // NOTE:
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)
215                         continue;
216
217                 DirListNode node;
218                 node.name = dirp->d_name;
219
220                 int isdir = -1; // -1 means unknown
221
222                 /*
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.
226
227                         Also we don't know whether symlinks are directories or not.
228                 */
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 */
233
234                 /*
235                         Was d_type DT_UNKNOWN, DT_LNK or nonexistent?
236                         If so, try stat().
237                 */
238                 if(isdir == -1) {
239                         struct stat statbuf{};
240                         if (stat((pathstring + "/" + node.name).c_str(), &statbuf))
241                                 continue;
242                         isdir = ((statbuf.st_mode & S_IFDIR) == S_IFDIR);
243                 }
244                 node.dir = isdir;
245                 listing.push_back(node);
246         }
247         closedir(dp);
248
249         return listing;
250 }
251
252 bool CreateDir(const std::string &path)
253 {
254         int r = mkdir(path.c_str(), S_IRWXU | S_IRWXG | S_IROTH | S_IXOTH);
255         if (r == 0) {
256                 return true;
257         }
258
259         // If already exists, return true
260         if (errno == EEXIST)
261                 return true;
262         return false;
263
264 }
265
266 bool PathExists(const std::string &path)
267 {
268         struct stat st{};
269         return (stat(path.c_str(),&st) == 0);
270 }
271
272 bool IsPathAbsolute(const std::string &path)
273 {
274         return path[0] == '/';
275 }
276
277 bool IsDir(const std::string &path)
278 {
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);
283 }
284
285 bool IsDirDelimiter(char c)
286 {
287         return c == '/';
288 }
289
290 bool RecursiveDelete(const std::string &path)
291 {
292         /*
293                 Execute the 'rm' command directly, by fork() and execve()
294         */
295
296         infostream<<"Removing \""<<path<<"\""<<std::endl;
297
298         //return false;
299
300         pid_t child_pid = fork();
301
302         if(child_pid == 0)
303         {
304                 // Child
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);
309                 char *argv[4];
310                 argv[0] = argv_data[0];
311                 argv[1] = argv_data[1];
312                 argv[2] = argv_data[2];
313                 argv[3] = NULL;
314
315                 verbosestream<<"Executing '"<<argv[0]<<"' '"<<argv[1]<<"' '"
316                                 <<argv[2]<<"'"<<std::endl;
317
318                 execv(argv[0], argv);
319
320                 // Execv shouldn't return. Failed.
321                 _exit(1);
322         }
323         else
324         {
325                 // Parent
326                 int child_status;
327                 pid_t tpid;
328                 do{
329                         tpid = wait(&child_status);
330                         //if(tpid != child_pid) process_terminated(tpid);
331                 }while(tpid != child_pid);
332                 return (child_status == 0);
333         }
334 }
335
336 bool DeleteSingleFileOrEmptyDirectory(const std::string &path)
337 {
338         if (IsDir(path)) {
339                 bool did = (rmdir(path.c_str()) == 0);
340                 if (!did)
341                         errorstream << "rmdir errno: " << errno << ": " << strerror(errno)
342                                         << std::endl;
343                 return did;
344         }
345
346         bool did = (unlink(path.c_str()) == 0);
347         if (!did)
348                 errorstream << "unlink errno: " << errno << ": " << strerror(errno)
349                                 << std::endl;
350         return did;
351 }
352
353 std::string TempPath()
354 {
355         /*
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?
359
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").
363         */
364 #ifdef __ANDROID__
365         return g_settings->get("TMPFolder");
366 #else
367         return DIR_DELIM "tmp";
368 #endif
369 }
370
371 #endif
372
373 void GetRecursiveDirs(std::vector<std::string> &dirs, const std::string &dir)
374 {
375         static const std::set<char> chars_to_ignore = { '_', '.' };
376         if (dir.empty() || !IsDir(dir))
377                 return;
378         dirs.push_back(dir);
379         fs::GetRecursiveSubPaths(dir, dirs, false, chars_to_ignore);
380 }
381
382 std::vector<std::string> GetRecursiveDirs(const std::string &dir)
383 {
384         std::vector<std::string> result;
385         GetRecursiveDirs(result, dir);
386         return result;
387 }
388
389 void GetRecursiveSubPaths(const std::string &path,
390                   std::vector<std::string> &dst,
391                   bool list_files,
392                   const std::set<char> &ignore)
393 {
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]))
398                         continue;
399                 if (list_files || n.dir)
400                         dst.push_back(fullpath);
401                 if (n.dir)
402                         GetRecursiveSubPaths(fullpath, dst, list_files, ignore);
403         }
404 }
405
406 bool DeletePaths(const std::vector<std::string> &paths)
407 {
408         bool success = true;
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);
413                 if(!did){
414                         errorstream<<"Failed to delete "<<path<<std::endl;
415                         success = false;
416                 }
417         }
418         return success;
419 }
420
421 bool RecursiveDeleteContent(const std::string &path)
422 {
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) == "..")
427                         continue;
428                 std::string childpath = path + DIR_DELIM + dln.name;
429                 bool r = RecursiveDelete(childpath);
430                 if(!r) {
431                         errorstream << "Removing \"" << childpath << "\" failed" << std::endl;
432                         return false;
433                 }
434         }
435         return true;
436 }
437
438 bool CreateAllDirs(const std::string &path)
439 {
440
441         std::vector<std::string> tocreate;
442         std::string basepath = path;
443         while(!PathExists(basepath))
444         {
445                 tocreate.push_back(basepath);
446                 basepath = RemoveLastPathComponent(basepath);
447                 if(basepath.empty())
448                         break;
449         }
450         for(int i=tocreate.size()-1;i>=0;i--)
451                 if(!CreateDir(tocreate[i]))
452                         return false;
453         return true;
454 }
455
456 bool CopyFileContents(const std::string &source, const std::string &target)
457 {
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;
462                 return false;
463         }
464
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;
469                 fclose(sourcefile);
470                 return false;
471         }
472
473         size_t total = 0;
474         bool retval = true;
475         bool done = false;
476         char readbuffer[BUFSIZ];
477         while(!done){
478                 size_t readbytes = fread(readbuffer, 1,
479                                 sizeof(readbuffer), sourcefile);
480                 total += readbytes;
481                 if(ferror(sourcefile)){
482                         errorstream<<source<<": IO error: "
483                                 <<strerror(errno)<<std::endl;
484                         retval = false;
485                         done = true;
486                 }
487                 if(readbytes > 0){
488                         fwrite(readbuffer, 1, readbytes, targetfile);
489                 }
490                 if(feof(sourcefile) || ferror(sourcefile)){
491                         // flush destination file to catch write errors
492                         // (e.g. disk full)
493                         fflush(targetfile);
494                         done = true;
495                 }
496                 if(ferror(targetfile)){
497                         errorstream<<target<<": IO error: "
498                                         <<strerror(errno)<<std::endl;
499                         retval = false;
500                         done = true;
501                 }
502         }
503         infostream<<"copied "<<total<<" bytes from "
504                 <<source<<" to "<<target<<std::endl;
505         fclose(sourcefile);
506         fclose(targetfile);
507         return retval;
508 }
509
510 bool CopyDir(const std::string &source, const std::string &target)
511 {
512         if(PathExists(source)){
513                 if(!PathExists(target)){
514                         fs::CreateAllDirs(target);
515                 }
516                 bool retval = true;
517                 std::vector<DirListNode> content = fs::GetDirListing(source);
518
519                 for (const auto &dln : content) {
520                         std::string sourcechild = source + DIR_DELIM + dln.name;
521                         std::string targetchild = target + DIR_DELIM + dln.name;
522                         if(dln.dir){
523                                 if(!fs::CopyDir(sourcechild, targetchild)){
524                                         retval = false;
525                                 }
526                         }
527                         else {
528                                 if(!fs::CopyFileContents(sourcechild, targetchild)){
529                                         retval = false;
530                                 }
531                         }
532                 }
533                 return retval;
534         }
535
536         return false;
537 }
538
539 bool PathStartsWith(const std::string &path, const std::string &prefix)
540 {
541         size_t pathsize = path.size();
542         size_t pathpos = 0;
543         size_t prefixsize = prefix.size();
544         size_t prefixpos = 0;
545         for(;;){
546                 bool delim1 = pathpos == pathsize
547                         || IsDirDelimiter(path[pathpos]);
548                 bool delim2 = prefixpos == prefixsize
549                         || IsDirDelimiter(prefix[prefixpos]);
550
551                 if(delim1 != delim2)
552                         return false;
553
554                 if(delim1){
555                         while(pathpos < pathsize &&
556                                         IsDirDelimiter(path[pathpos]))
557                                 ++pathpos;
558                         while(prefixpos < prefixsize &&
559                                         IsDirDelimiter(prefix[prefixpos]))
560                                 ++prefixpos;
561                         if(prefixpos == prefixsize)
562                                 return true;
563                         if(pathpos == pathsize)
564                                 return false;
565                 }
566                 else{
567                         size_t len = 0;
568                         do{
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);
574                                 }
575                                 if(pathchar != prefixchar)
576                                         return false;
577                                 ++len;
578                         } while(pathpos+len < pathsize
579                                         && !IsDirDelimiter(path[pathpos+len])
580                                         && prefixpos+len < prefixsize
581                                         && !IsDirDelimiter(
582                                                 prefix[prefixpos+len]));
583                         pathpos += len;
584                         prefixpos += len;
585                 }
586         }
587 }
588
589 std::string RemoveLastPathComponent(const std::string &path,
590                 std::string *removed, int count)
591 {
592         if(removed)
593                 *removed = "";
594
595         size_t remaining = path.size();
596
597         for(int i = 0; i < count; ++i){
598                 // strip a dir delimiter
599                 while(remaining != 0 && IsDirDelimiter(path[remaining-1]))
600                         remaining--;
601                 // strip a path component
602                 size_t component_end = remaining;
603                 while(remaining != 0 && !IsDirDelimiter(path[remaining-1]))
604                         remaining--;
605                 size_t component_start = remaining;
606                 // strip a dir delimiter
607                 while(remaining != 0 && IsDirDelimiter(path[remaining-1]))
608                         remaining--;
609                 if(removed){
610                         std::string component = path.substr(component_start,
611                                         component_end - component_start);
612                         if(i)
613                                 *removed = component + DIR_DELIM + *removed;
614                         else
615                                 *removed = component;
616                 }
617         }
618         return path.substr(0, remaining);
619 }
620
621 std::string RemoveRelativePathComponents(std::string path)
622 {
623         size_t pos = path.size();
624         size_t dotdot_count = 0;
625         while (pos != 0) {
626                 size_t component_with_delim_end = pos;
627                 // skip a dir delimiter
628                 while (pos != 0 && IsDirDelimiter(path[pos-1]))
629                         pos--;
630                 // strip a path component
631                 size_t component_end = pos;
632                 while (pos != 0 && !IsDirDelimiter(path[pos-1]))
633                         pos--;
634                 size_t component_start = pos;
635
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;
643                         dotdot_count += 1;
644                 } else if (dotdot_count != 0) {
645                         remove_this_component = true;
646                         dotdot_count -= 1;
647                 }
648
649                 if (remove_this_component) {
650                         while (pos != 0 && IsDirDelimiter(path[pos-1]))
651                                 pos--;
652                         if (component_start == 0) {
653                                 // We need to remove the delemiter too
654                                 path = path.substr(component_with_delim_end, std::string::npos);
655                         } else {
656                                 path = path.substr(0, pos) + DIR_DELIM +
657                                         path.substr(component_with_delim_end, std::string::npos);
658                         }
659                         if (pos > 0)
660                                 pos++;
661                 }
662         }
663
664         if (dotdot_count > 0)
665                 return "";
666
667         // remove trailing dir delimiters
668         pos = path.size();
669         while (pos != 0 && IsDirDelimiter(path[pos-1]))
670                 pos--;
671         return path.substr(0, pos);
672 }
673
674 std::string AbsolutePath(const std::string &path)
675 {
676 #ifdef _WIN32
677         char *abs_path = _fullpath(NULL, path.c_str(), MAX_PATH);
678 #else
679         char *abs_path = realpath(path.c_str(), NULL);
680 #endif
681         if (!abs_path) return "";
682         std::string abs_path_str(abs_path);
683         free(abs_path);
684         return abs_path_str;
685 }
686
687 const char *GetFilenameFromPath(const char *path)
688 {
689         const char *filename = strrchr(path, DIR_DELIM_CHAR);
690         return filename ? filename + 1 : path;
691 }
692
693 bool safeWriteToFile(const std::string &path, const std::string &content)
694 {
695         std::string tmp_file = path + ".~mt";
696
697         // Write to a tmp file
698         std::ofstream os(tmp_file.c_str(), std::ios::binary);
699         if (!os.good())
700                 return false;
701         os << content;
702         os.flush();
703         os.close();
704         if (os.fail()) {
705                 // Remove the temporary file because writing it failed and it's useless.
706                 remove(tmp_file.c_str());
707                 return false;
708         }
709
710         bool rename_success = false;
711
712         // Move the finished temporary file over the real file
713 #ifdef _WIN32
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);
721                 if (rename_success)
722                         break;
723                 sleep_ms(1);
724                 ++number_attempts;
725         }
726 #else
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
729         // transaction.
730         rename_success = rename(tmp_file.c_str(), path.c_str()) == 0;
731 #endif
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
735                 // failed.
736                 remove(tmp_file.c_str());
737                 return false;
738         }
739
740         return true;
741 }
742
743 bool Rename(const std::string &from, const std::string &to)
744 {
745         return rename(from.c_str(), to.c_str()) == 0;
746 }
747
748 } // namespace fs
749