remove file manager LRU cache from code.
[ardour.git] / libs / pbd / file_utils.cc
index 9db71c25c0c550a0dba4a809b76ef63bf9fcba97..89f6818704c9d8c05d0ad2dc7c668cadc8e2d05d 100644 (file)
@@ -26,7 +26,6 @@
 
 #ifdef COMPILER_MINGW
 #include <io.h> // For W_OK
-#define strtok_r strtok_s
 #endif
 
 #include <glibmm/fileutils.h>
@@ -64,49 +63,104 @@ using namespace std;
 namespace PBD {
 
 void
-get_directory_contents (const std::string& directory_path,
-                       vector<string>& result,
-                       bool files_only,
+run_functor_for_paths (vector<string>& result,
+                       const Searchpath& paths,
+                       bool (*functor)(const string &, void *),
+                       void *arg,
+                       bool pass_files_only,
+                       bool pass_fullpath, bool return_fullpath,
                        bool recurse)
 {
-       // perhaps we don't need this check assuming an exception is thrown
-       // as it would save checking that the path is a directory twice when
-       // recursing
-       if (!Glib::file_test (directory_path, Glib::FILE_TEST_IS_DIR)) return;
+       for (vector<string>::const_iterator i = paths.begin(); i != paths.end(); ++i) {
+               string expanded_path = path_expand (*i);
+               DEBUG_TRACE (DEBUG::FileUtils,
+                               string_compose("Find files in expanded path: %1\n", expanded_path));
 
-       try
-       {
-               Glib::Dir dir(directory_path);
-               Glib::DirIterator i = dir.begin();
+               if (!Glib::file_test (expanded_path, Glib::FILE_TEST_IS_DIR)) continue;
 
-               while (i != dir.end()) {
+               try
+               {
+                       Glib::Dir dir(expanded_path);
 
-                       string fullpath = Glib::build_filename (directory_path, *i);
+                       for (Glib::DirIterator di = dir.begin(); di != dir.end(); di++) {
 
-                       bool is_dir = Glib::file_test (fullpath, Glib::FILE_TEST_IS_DIR);
+                               string fullpath = Glib::build_filename (expanded_path, *di);
+                               string basename = *di;
 
-                       if (is_dir && recurse) {
-                               get_directory_contents (fullpath, result, files_only, recurse);
-                       }
+                               bool is_dir = Glib::file_test (fullpath, Glib::FILE_TEST_IS_DIR);
+
+                               if (is_dir && recurse) {
+                                       DEBUG_TRACE (DEBUG::FileUtils,
+                                                       string_compose("Descending into directory:  %1\n",
+                                                               fullpath));
+                                       run_functor_for_paths (result, fullpath, functor, arg, pass_files_only,
+                                                              pass_fullpath, return_fullpath, recurse);
+                               }
+
+                               if (is_dir && pass_files_only) {
+                                       continue;
+                               }
+
+                               string functor_str;
+
+                               if (pass_fullpath) {
+                                       functor_str = fullpath;
+                               } else {
+                                       functor_str = basename;
+                               }
 
-                       i++;
+                               DEBUG_TRACE (DEBUG::FileUtils,
+                                               string_compose("Run Functor using string: %1\n", functor_str));
 
-                       if (is_dir && files_only) {
-                               continue;
+                               if (!functor(functor_str, arg)) {
+                                       continue;
+                               }
+
+                               DEBUG_TRACE (DEBUG::FileUtils,
+                                               string_compose("Found file %1 matching functor\n", functor_str));
+
+                               if (return_fullpath) {
+                                       result.push_back(fullpath);
+                               } else {
+                                       result.push_back(basename);
+                               }
                        }
-                       result.push_back (fullpath);
+               }
+               catch (Glib::FileError& err)
+               {
+                       warning << err.what() << endmsg;
                }
        }
-       catch (Glib::FileError& err)
-       {
-               warning << err.what() << endmsg;
-       }
+}
+
+static
+bool accept_all_files (string const &, void *)
+{
+       return true;
 }
 
 void
-get_files_in_directory (const std::string& directory_path, vector<string>& result)
+get_paths (vector<string>& result,
+           const Searchpath& paths,
+           bool files_only,
+           bool recurse)
 {
-       return get_directory_contents (directory_path, result, true, false);
+       run_functor_for_paths (result, paths, accept_all_files, 0,
+                              files_only, true, true, recurse);
+}
+
+void
+get_files (vector<string>& result, const Searchpath& paths)
+{
+       return get_paths (result, paths, true, false);
+}
+
+static
+bool
+pattern_filter (const string& str, void *arg)
+{
+       Glib::PatternSpec* pattern = (Glib::PatternSpec*)arg;
+       return pattern->match(str);
 }
 
 void
@@ -114,27 +168,9 @@ find_files_matching_pattern (vector<string>& result,
                              const Searchpath& paths,
                              const Glib::PatternSpec& pattern)
 {
-       vector<string> tmp_files;
-
-       for (vector<string>::const_iterator i = paths.begin(); i != paths.end(); ++i) {
-               get_files_in_directory (*i, tmp_files);
-       }
-
-       for (vector<string>::iterator file_iter = tmp_files.begin();
-                       file_iter != tmp_files.end();
-                       ++file_iter)
-       {
-               string filename = Glib::path_get_basename (*file_iter);
-               if (!pattern.match(filename)) continue;
-
-               DEBUG_TRACE (
-                       DEBUG::FileUtils,
-                       string_compose("Found file %1\n", *file_iter)
-                       );
-
-               result.push_back(*file_iter);
-       }
-
+       run_functor_for_paths (result, paths, pattern_filter,
+                              const_cast<Glib::PatternSpec*>(&pattern),
+                              true, false, true, false);
 }
 
 void
@@ -155,29 +191,24 @@ find_file (const Searchpath& search_path,
 
        find_files_matching_pattern (tmp, search_path, filename);
 
-       if (tmp.size() == 0)
-       {
-               DEBUG_TRACE (
-                       DEBUG::FileUtils,
-                       string_compose("No file matching %1 found in Path: %2\n", filename, search_path.to_string())
-                           );
+       if (tmp.size() == 0) {
+               DEBUG_TRACE (DEBUG::FileUtils,
+                            string_compose("No file matching %1 found in Path: %2\n",
+                            filename, search_path.to_string()));
                return false;
        }
 
-       if (tmp.size() != 1)
-       {
-               DEBUG_TRACE (
-                       DEBUG::FileUtils,
-                       string_compose("Found more that one file matching %1 in Path: %2\n", filename, search_path.to_string())
-                           );
+       if (tmp.size() != 1) {
+               DEBUG_TRACE (DEBUG::FileUtils,
+                            string_compose("Found more that one file matching %1 in Path: %2\n",
+                            filename, search_path.to_string()));
        }
 
        result = tmp.front();
 
-       DEBUG_TRACE (
-               DEBUG::FileUtils,
-               string_compose("Found file %1 in Path: %2\n", filename, search_path.to_string())
-                   );
+       DEBUG_TRACE (DEBUG::FileUtils,
+                    string_compose("Found file %1 in Path: %2\n",
+                    filename, search_path.to_string()));
 
        return true;
 }
@@ -213,6 +244,9 @@ find_files_matching_regex (vector<string>& result,
                return;
        }
 
+       DEBUG_TRACE (DEBUG::FileUtils,
+                       string_compose("Matching files using regexp: %1\n", regexp));
+
        find_files_matching_filter (result, paths,
                                    regexp_filter, &compiled_pattern,
                                    true, true, false);
@@ -221,45 +255,25 @@ find_files_matching_regex (vector<string>& result,
 }
 
 void
-find_files_matching_filter (vector<string>& result,
+find_paths_matching_filter (vector<string>& result,
                             const Searchpath& paths,
                             bool (*filter)(const string &, void *),
                             void *arg,
-                            bool match_fullpath, bool return_fullpath,
+                            bool pass_fullpath, bool return_fullpath,
                             bool recurse)
 {
-       vector<string> all_files;
-
-       for (vector<string>::const_iterator i = paths.begin(); i != paths.end(); ++i) {
-               string expanded_path = path_expand (*i);
-               get_directory_contents (expanded_path, all_files, true, recurse);
-       }
-
-       for (vector<string>::iterator i = all_files.begin(); i != all_files.end(); ++i) {
-
-               string fullpath = *i;
-               string filename = Glib::path_get_basename (*i);
-               string search_str;
-
-               if (match_fullpath) {
-                       search_str = *i;
-               } else {
-                       search_str = filename;
-               }
-
-               if (!filter(search_str, arg)) {
-                       continue;
-               }
-
-               DEBUG_TRACE (DEBUG::FileUtils,
-                            string_compose("Found file %1 matching filter\n", search_str));
+       run_functor_for_paths (result, paths, filter, arg, false, pass_fullpath, return_fullpath, recurse);
+}
 
-               if (return_fullpath) {
-                       result.push_back(fullpath);
-               } else {
-                       result.push_back(filename);
-               }
-       }
+void
+find_files_matching_filter (vector<string>& result,
+                            const Searchpath& paths,
+                            bool (*filter)(const string &, void *),
+                            void *arg,
+                            bool pass_fullpath, bool return_fullpath,
+                            bool recurse)
+{
+       run_functor_for_paths (result, paths, filter, arg, true, pass_fullpath, return_fullpath, recurse);
 }
 
 bool
@@ -267,19 +281,17 @@ copy_file(const std::string & from_path, const std::string & to_path)
 {
        if (!Glib::file_test (from_path, Glib::FILE_TEST_EXISTS)) return false;
 
-       int fd_from = -1;
-       int fd_to = -1;
+       int fd_from (::open (from_path.c_str(), O_RDONLY));
+       int fd_to (::open (to_path.c_str(), O_CREAT|O_TRUNC|O_RDWR, 0666));
+
        char buf[4096]; // BUFSIZ  ??
        ssize_t nread;
 
-       fd_from = ::open(from_path.c_str(), O_RDONLY);
-       if (fd_from < 0) {
-               goto copy_error;
-       }
-
-       fd_to = ::open(to_path.c_str(), O_WRONLY | O_CREAT, 0666);
-       if (fd_to < 0) {
-               goto copy_error;
+       if ((fd_from < 0) || (fd_to < 0)) {
+               error << string_compose (_("Unable to Open files %1 to %2 for Copying(%3)"),
+                               from_path, to_path, g_strerror(errno))
+                     << endmsg;
+               return false;
        }
 
        while (nread = ::read(fd_from, buf, sizeof(buf)), nread > 0) {
@@ -290,39 +302,14 @@ copy_file(const std::string & from_path, const std::string & to_path)
                                nread -= nwritten;
                                out_ptr += nwritten;
                        } else if (errno != EINTR) {
-                               goto copy_error;
+                               error << string_compose (_("Unable to Copy files %1 to %2(%3)"),
+                                               from_path, to_path, g_strerror(errno))
+                                       << endmsg;
+                               return false;
                        }
                } while (nread > 0);
        }
 
-       if (nread == 0) {
-               if (::close(fd_to)) {
-                       fd_to = -1;
-                       goto copy_error;
-               }
-               ::close(fd_from);
-               return true;
-       }
-
-copy_error:
-       int saved_errno = errno;
-
-       if (fd_from >= 0) {
-               ::close(fd_from);
-       }
-       if (fd_to >= 0) {
-               ::close(fd_to);
-       }
-
-       error << string_compose (_("Unable to Copy file %1 to %2 (%3)"),
-                       from_path, to_path, strerror(saved_errno))
-               << endmsg;
-       return false;
-}
-
-static
-bool accept_all_files (string const &, void *)
-{
        return true;
 }
 
@@ -339,6 +326,21 @@ copy_files(const std::string & from_path, const std::string & to_dir)
        }
 }
 
+void
+copy_recurse(const std::string & from_path, const std::string & to_dir)
+{
+       vector<string> files;
+       find_files_matching_filter (files, from_path, accept_all_files, 0, false, true, true);
+
+       const size_t prefix_len = from_path.size();
+       for (vector<string>::iterator i = files.begin(); i != files.end(); ++i) {
+               std::string from = *i;
+               std::string to = Glib::build_filename (to_dir, (*i).substr(prefix_len));
+               g_mkdir_with_parents (Glib::path_get_dirname (to).c_str(), 0755);
+               copy_file (from, to);
+       }
+}
+
 std::string
 get_absolute_path (const std::string & p)
 {
@@ -346,6 +348,16 @@ get_absolute_path (const std::string & p)
        return Glib::build_filename (Glib::get_current_dir(), p);
 }
 
+std::string
+get_suffix (const std::string & p)
+{
+       string::size_type period = p.find_last_of ('.');
+       if (period == string::npos || period == p.length() - 1) {
+               return string();
+       }
+       return p.substr (period+1);
+}
+
 bool
 equivalent_paths (const std::string& a, const std::string& b)
 {
@@ -404,4 +416,70 @@ exists_and_writable (const std::string & p)
        return true;
 }
 
+int
+remove_directory_internal (const string& dir, size_t* size, vector<string>* paths,
+                           bool just_remove_files)
+{
+       vector<string> tmp_paths;
+       GStatBuf statbuf;
+       int ret = 0;
+
+       get_paths (tmp_paths, dir, just_remove_files, true);
+
+       for (vector<string>::const_iterator i = tmp_paths.begin();
+            i != tmp_paths.end(); ++i) {
+
+                if (g_stat (i->c_str(), &statbuf)) {
+                       continue;
+               }
+
+                if (::g_remove (i->c_str())) {
+                        error << string_compose (_("cannot remove path %1 (%2)"), *i, strerror (errno))
+                              << endmsg;
+                        ret = 1;
+                }
+
+                if (paths) {
+                        paths->push_back (Glib::path_get_basename(*i));
+                }
+
+                if (size) {
+                        *size += statbuf.st_size;
+                }
+
+       }
+
+        return ret;
+}
+
+int
+clear_directory (const string& dir, size_t* size, vector<string>* paths)
+{
+       return remove_directory_internal (dir, size, paths, true);
+}
+
+// rm -rf <dir> -- used to remove saved plugin state
+void
+remove_directory (const std::string& dir)
+{
+       remove_directory_internal (dir, 0, 0, false);
+}
+
+string
+tmp_writable_directory (const char* domain, const string& prefix)
+{
+       std::string tmp_dir = Glib::build_filename (g_get_tmp_dir(), domain);
+       std::string dir_name;
+       std::string new_test_dir;
+       do {
+               ostringstream oss;
+               oss << prefix;
+               oss << g_random_int ();
+               dir_name = oss.str();
+               new_test_dir = Glib::build_filename (tmp_dir, dir_name);
+               if (Glib::file_test (new_test_dir, Glib::FILE_TEST_EXISTS)) continue;
+       } while (g_mkdir_with_parents (new_test_dir.c_str(), 0755) != 0);
+       return new_test_dir;
+}
+
 } // namespace PBD