NO-OP: whitespace
[ardour.git] / libs / pbd / file_utils.cc
index 618dccf4ddc60e3786102b61a829a0d73ed37acc..3fc3cdf99edb814b6d304915c3748d984be512f1 100644 (file)
 #include <vector>
 
 #include <glib.h>
-#include <glib/gstdio.h>
+#include "pbd/gstdio_compat.h"
 
 #ifdef COMPILER_MINGW
 #include <io.h> // For W_OK
-#define strtok_r strtok_s
 #endif
 
 #include <glibmm/fileutils.h>
 #include "pbd/debug.h"
 #include "pbd/error.h"
 #include "pbd/pathexpand.h"
+#include "pbd/scoped_file_descriptor.h"
 #include "pbd/stl_delete.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace std;
 
 namespace PBD {
 
-void
-get_directory_contents (const std::string& directory_path,
-                       vector<string>& result,
-                       bool files_only,
+static void
+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 const& 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_paths (vector<string>& result,
+           const Searchpath& paths,
+           bool files_only,
+           bool recurse)
+{
+       run_functor_for_paths (result, paths, accept_all_files, 0,
+                              files_only, true, true, recurse);
 }
 
 void
-get_files_in_directory (const std::string& directory_path, vector<string>& result)
+get_files (vector<string>& result, const Searchpath& paths)
+{
+       return get_paths (result, paths, true, false);
+}
+
+static
+bool
+pattern_filter (const string& str, void *arg)
 {
-       return get_directory_contents (directory_path, result, true, false);
+       Glib::PatternSpec* pattern = (Glib::PatternSpec*)arg;
+       return pattern->match(str);
 }
 
 void
@@ -114,25 +169,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
@@ -186,7 +225,8 @@ regexp_filter (const string& str, void *arg)
 void
 find_files_matching_regex (vector<string>& result,
                            const Searchpath& paths,
-                           const std::string& regexp)
+                           const std::string& regexp,
+                           bool recurse)
 {
        int err;
        char msg[256];
@@ -206,53 +246,36 @@ 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);
+                                   true, true, recurse);
 
        regfree (&compiled_pattern);
 }
 
 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
@@ -260,19 +283,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;
+       PBD::ScopedFileDescriptor fd_from (g_open (from_path.c_str(), O_RDONLY, 0444));
+       PBD::ScopedFileDescriptor fd_to (g_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) {
@@ -283,39 +304,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;
 }
 
@@ -332,6 +328,32 @@ 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);
+       }
+}
+
+bool
+touch_file (const std::string& path)
+{
+       int fd = g_open (path.c_str(), O_RDWR|O_CREAT, 0660);
+       if (fd >= 0) {
+               close (fd);
+               return true;
+       }
+       return false;
+}
+
 std::string
 get_absolute_path (const std::string & p)
 {
@@ -339,6 +361,75 @@ get_absolute_path (const std::string & p)
        return Glib::build_filename (Glib::get_current_dir(), p);
 }
 
+string
+canonical_path (const std::string& path)
+{
+#ifdef PLATFORM_WINDOWS
+       wchar_t resolved_wpath[_MAX_PATH];
+
+       // sizeof(wchar_t) is 2 bytes using gcc/mingw and VC++ but 4 bytes using gcc/linux
+       assert (sizeof(wchar_t) == 2);
+
+       wchar_t* wfilepath = (wchar_t*)g_utf8_to_utf16 (path.c_str(), -1, NULL, NULL, NULL);
+
+       if (wfilepath == NULL) {
+               DEBUG_TRACE (
+                   DEBUG::FileUtils,
+                   string_compose ("PBD::canonical_path: Unable to convert path from utf8 to utf16 : %1\n",
+                                   path));
+               return path;
+       }
+
+       if (_wfullpath (resolved_wpath, wfilepath, _MAX_PATH) == NULL) {
+               DEBUG_TRACE (DEBUG::FileUtils,
+                            string_compose ("PBD::canonical_path: Unable to resolve %1\n", wfilepath));
+               return path;
+       }
+
+       gchar* resolved_utf8_path =
+           g_utf16_to_utf8 (reinterpret_cast<const gunichar2*>(resolved_wpath), -1, NULL, NULL, NULL);
+
+       if (resolved_utf8_path == NULL) {
+               DEBUG_TRACE (
+                   DEBUG::FileUtils,
+                   string_compose ("PBD::canonical_path: Unable to convert path from utf16 to utf8 : %1\n",
+                                   resolved_wpath));
+               return path;
+       }
+
+       const string retval(resolved_utf8_path);
+
+       g_free (wfilepath);
+       g_free (resolved_utf8_path);
+
+       return retval;
+
+#else
+       char buf[PATH_MAX+1];
+
+       if (realpath (path.c_str(), buf) == NULL) {
+               DEBUG_TRACE (DEBUG::FileUtils,
+                            string_compose ("PBD::canonical_path: Unable to resolve %1: %2\n", path,
+                                            g_strerror (errno)));
+               return path;
+       }
+       DEBUG_TRACE (DEBUG::FileUtils,
+                    string_compose ("PBD::canonical_path %1 resolved to: %2\n", path, string (buf)));
+
+       return string (buf);
+#endif
+}
+
+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)
 {
@@ -359,7 +450,7 @@ path_is_within (std::string const & haystack, std::string needle)
                }
 
                needle = Glib::path_get_dirname (needle);
-               if (needle == "." || needle == "/") {
+               if (needle == "." || needle == "/" || Glib::path_skip_root(needle).empty()) {
                        break;
                }
        }
@@ -402,35 +493,37 @@ remove_directory_internal (const string& dir, size_t* size, vector<string>* path
                            bool just_remove_files)
 {
        vector<string> tmp_paths;
-       struct stat statbuf;
+       GStatBuf statbuf;
        int ret = 0;
 
-       get_directory_contents (dir, tmp_paths, just_remove_files, true);
+       get_paths (tmp_paths, dir, just_remove_files, true);
 
        for (vector<string>::const_iterator i = tmp_paths.begin();
-            i != tmp_paths.end(); ++i) {
+                       i != tmp_paths.end(); ++i) {
 
-                if (g_stat (i->c_str(), &statbuf)) {
+               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 (::g_remove (i->c_str())) {
+                       error << string_compose (_("cannot remove path %1 (%2)"), *i, strerror (errno))
+                               << endmsg;
+                       ret = 1;
+                       continue;
+               }
 
-                if (paths) {
-                        paths->push_back (Glib::path_get_basename(*i));
-                }
+               if (paths) {
+                       paths->push_back (Glib::path_get_basename(*i));
+               }
 
-                if (size) {
-                        *size += statbuf.st_size;
-                }
+               // statbuf.st_size is off_t
+               if (size && statbuf.st_size > 0) {
+                       *size += statbuf.st_size;
+               }
 
        }
 
-        return ret;
+       return ret;
 }
 
 int
@@ -444,6 +537,35 @@ void
 remove_directory (const std::string& dir)
 {
        remove_directory_internal (dir, 0, 0, false);
+       g_rmdir (dir.c_str());
+}
+
+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;
+}
+
+int
+toggle_file_existence (string const & path)
+{
+       if (Glib::file_test (path, Glib::FILE_TEST_IS_REGULAR)) {
+               return g_unlink (path.c_str());
+       }
+
+       PBD::ScopedFileDescriptor fd = g_open (path.c_str(), O_CREAT|O_TRUNC|O_RDWR, 0666);
+       return !((int) fd >= 0);
 }
 
 } // namespace PBD