Move functions in pbd/clear_dir.h/cc into pbd/file_utils.h/cc
[ardour.git] / libs / pbd / file_utils.cc
index 311a3948efd132d29bd97cba67bde7ee787a7706..1101ba650458d42889ffea8fc63114fd7ac21f43 100644 (file)
@@ -1,5 +1,6 @@
 /*
-    Copyright (C) 2007 Tim Mayberry 
+    Copyright (C) 2007-2014 Tim Mayberry
+    Copyright (C) 1998-2014 Paul Davis
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 
 #ifdef COMPILER_MINGW
 #include <io.h> // For W_OK
+#define strtok_r strtok_s
 #endif
 
 #include <glibmm/fileutils.h>
 #include <glibmm/miscutils.h>
 #include <glibmm/pattern.h>
 
-#include <giomm/file.h>
+#include <errno.h>
+#include <string.h> /* strerror */
+
+/* open() */
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <fcntl.h>
+
+/* close(), read(), write() */
+#ifdef COMPILER_MSVC
+#include <io.h> // Microsoft's nearest equivalent to <unistd.h>
+#include <ardourext/misc.h>
+#else
+#include <unistd.h>
+#include <regex.h>
+#endif
 
 #include "pbd/compose.h"
 #include "pbd/file_utils.h"
+#include "pbd/debug.h"
 #include "pbd/error.h"
-#include "pbd/pathscanner.h"
+#include "pbd/pathexpand.h"
 #include "pbd/stl_delete.h"
 
 #include "i18n.h"
@@ -46,14 +64,38 @@ using namespace std;
 namespace PBD {
 
 void
-get_files_in_directory (const std::string& directory_path, vector<string>& result)
+get_directory_contents (const std::string& directory_path,
+                       vector<string>& result,
+                       bool files_only,
+                       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;
 
        try
        {
                Glib::Dir dir(directory_path);
-               std::copy(dir.begin(), dir.end(), std::back_inserter(result));
+               Glib::DirIterator i = dir.begin();
+
+               while (i != dir.end()) {
+
+                       string fullpath = Glib::build_filename (directory_path, *i);
+
+                       bool is_dir = Glib::file_test (fullpath, Glib::FILE_TEST_IS_DIR);
+
+                       if (is_dir && recurse) {
+                               get_directory_contents (fullpath, result, files_only, recurse);
+                       }
+
+                       i++;
+
+                       if (is_dir && files_only) {
+                               continue;
+                       }
+                       result.push_back (fullpath);
+               }
        }
        catch (Glib::FileError& err)
        {
@@ -62,102 +104,220 @@ get_files_in_directory (const std::string& directory_path, vector<string>& resul
 }
 
 void
-find_matching_files_in_directory (const std::string& directory,
-                                  const Glib::PatternSpec& pattern,
-                                  vector<std::string>& result)
+get_files_in_directory (const std::string& directory_path, vector<string>& result)
+{
+       return get_directory_contents (directory_path, result, true, false);
+}
+
+void
+find_files_matching_pattern (vector<string>& result,
+                             const Searchpath& paths,
+                             const Glib::PatternSpec& pattern)
 {
        vector<string> tmp_files;
 
-       get_files_in_directory (directory, tmp_files);
-       result.reserve(tmp_files.size());
+       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)
        {
-               if (!pattern.match(*file_iter)) continue;
+               string filename = Glib::path_get_basename (*file_iter);
+               if (!pattern.match(filename)) continue;
 
-               std::string full_path(directory);
-               full_path = Glib::build_filename (full_path, *file_iter);
+               DEBUG_TRACE (
+                       DEBUG::FileUtils,
+                       string_compose("Found file %1\n", *file_iter)
+                       );
 
-               result.push_back(full_path);
+               result.push_back(*file_iter);
        }
-}
 
-void
-find_matching_files_in_directories (const vector<std::string>& paths,
-                                    const Glib::PatternSpec& pattern,
-                                    vector<std::string>& result)
-{
-       for (vector<std::string>::const_iterator path_iter = paths.begin();
-                       path_iter != paths.end();
-                       ++path_iter)
-       {
-               find_matching_files_in_directory (*path_iter, pattern, result);
-       }               
 }
 
 void
-find_matching_files_in_search_path (const SearchPath& search_path,
-                                    const Glib::PatternSpec& pattern,
-                                    vector<std::string>& result)
+find_files_matching_pattern (vector<string>& result,
+                             const Searchpath& paths,
+                             const string& pattern)
 {
-       find_matching_files_in_directories (search_path, pattern, result);    
+       Glib::PatternSpec tmp(pattern);
+       find_files_matching_pattern (result, paths, tmp);
 }
 
 bool
-find_file_in_search_path(const SearchPath& search_path,
-                         const string& filename,
-                         std::string& result)
+find_file (const Searchpath& search_path,
+           const string& filename,
+           std::string& result)
 {
        vector<std::string> tmp;
-       Glib::PatternSpec tmp_pattern(filename);
 
-       find_matching_files_in_search_path (search_path, tmp_pattern, tmp);
+       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())
+                           );
                return false;
        }
 
-#if 0
        if (tmp.size() != 1)
        {
-               info << string_compose
-                       (
-                        "Found more than one file matching %1 in search path %2",
-                        filename,
-                        search_path ()
-                       )
-                       << endmsg;
+               DEBUG_TRACE (
+                       DEBUG::FileUtils,
+                       string_compose("Found more that one file matching %1 in Path: %2\n", filename, search_path.to_string())
+                           );
        }
-#endif
 
        result = tmp.front();
 
+       DEBUG_TRACE (
+               DEBUG::FileUtils,
+               string_compose("Found file %1 in Path: %2\n", filename, search_path.to_string())
+                   );
+
        return true;
 }
 
+static
+bool
+regexp_filter (const string& str, void *arg)
+{
+       regex_t* pattern = (regex_t*)arg;
+       return regexec (pattern, str.c_str(), 0, 0, 0) == 0;
+}
+
+void
+find_files_matching_regex (vector<string>& result,
+                           const Searchpath& paths,
+                           const std::string& regexp)
+{
+       int err;
+       char msg[256];
+       regex_t compiled_pattern;
+
+       if ((err = regcomp (&compiled_pattern, regexp.c_str(),
+                           REG_EXTENDED|REG_NOSUB))) {
+
+               regerror (err, &compiled_pattern,
+                         msg, sizeof (msg));
+
+               error << "Cannot compile soundfile regexp for use ("
+                     << msg
+                     << ")"
+                     << endmsg;
+
+               return;
+       }
+
+       find_files_matching_filter (result, paths,
+                                   regexp_filter, &compiled_pattern,
+                                   true, true, false);
+
+       regfree (&compiled_pattern);
+}
+
+void
+find_files_matching_filter (vector<string>& result,
+                            const Searchpath& paths,
+                            bool (*filter)(const string &, void *),
+                            void *arg,
+                            bool match_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));
+
+               if (return_fullpath) {
+                       result.push_back(fullpath);
+               } else {
+                       result.push_back(filename);
+               }
+       }
+}
+
 bool
 copy_file(const std::string & from_path, const std::string & to_path)
 {
        if (!Glib::file_test (from_path, Glib::FILE_TEST_EXISTS)) return false;
 
-       Glib::RefPtr<Gio::File> from_file = Gio::File::create_for_path(from_path);
-       Glib::RefPtr<Gio::File> to_file = Gio::File::create_for_path(to_path);
+       int fd_from = -1;
+       int fd_to = -1;
+       char buf[4096]; // BUFSIZ  ??
+       ssize_t nread;
 
-       try
-       {
-               from_file->copy (to_file, Gio::FILE_COPY_OVERWRITE);
+       fd_from = ::open(from_path.c_str(), O_RDONLY);
+       if (fd_from < 0) {
+               goto copy_error;
        }
-       catch(const Glib::Exception& ex)
-       {
-               error << string_compose (_("Unable to Copy file %1 to %2 (%3)"),
-                               from_path, to_path, ex.what())
-                       << endmsg;
-               return false;
+
+       fd_to = ::open(to_path.c_str(), O_WRONLY | O_CREAT, 0666);
+       if (fd_to < 0) {
+               goto copy_error;
        }
-       return true;
+
+       while (nread = ::read(fd_from, buf, sizeof(buf)), nread > 0) {
+               char *out_ptr = buf;
+               do {
+                       ssize_t nwritten = ::write(fd_to, out_ptr, nread);
+                       if (nwritten >= 0) {
+                               nread -= nwritten;
+                               out_ptr += nwritten;
+                       } else if (errno != EINTR) {
+                               goto copy_error;
+                       }
+               } 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
@@ -169,32 +329,29 @@ bool accept_all_files (string const &, void *)
 void
 copy_files(const std::string & from_path, const std::string & to_dir)
 {
-       PathScanner scanner;
-       vector<string*>* files = scanner (from_path, accept_all_files, 0, true, false);
+       vector<string> files;
+       find_files_matching_filter (files, from_path, accept_all_files, 0, true, false);
 
-       if (files) {
-               for (vector<string*>::iterator i = files->begin(); i != files->end(); ++i) {
-                       std::string from = Glib::build_filename (from_path, **i);
-                       std::string to = Glib::build_filename (to_dir, **i);
-                       copy_file (from, to);
-               }
-               vector_delete (files);
+       for (vector<string>::iterator i = files.begin(); i != files.end(); ++i) {
+               std::string from = Glib::build_filename (from_path, *i);
+               std::string to = Glib::build_filename (to_dir, *i);
+               copy_file (from, to);
        }
 }
 
 std::string
 get_absolute_path (const std::string & p)
 {
-       Glib::RefPtr<Gio::File> f = Gio::File::create_for_path (p);
-       return f->get_path ();
+       if (Glib::path_is_absolute(p)) return p;
+       return Glib::build_filename (Glib::get_current_dir(), p);
 }
 
 bool
 equivalent_paths (const std::string& a, const std::string& b)
 {
-       struct stat bA;
+       GStatBuf bA;
        int const rA = g_stat (a.c_str(), &bA);
-       struct stat bB;
+       GStatBuf bB;
        int const rB = g_stat (b.c_str(), &bB);
 
        return (rA == 0 && rB == 0 && bA.st_dev == bB.st_dev && bA.st_ino == bB.st_ino);
@@ -225,7 +382,7 @@ exists_and_writable (const std::string & p)
           make us unwritable.
        */
 
-       struct stat statbuf;
+       GStatBuf statbuf;
 
        if (g_stat (p.c_str(), &statbuf) != 0) {
                /* doesn't exist - not writable */
@@ -247,4 +404,53 @@ 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;
+       struct stat statbuf;
+       int ret = 0;
+
+       get_directory_contents (dir, tmp_paths, 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);
+}
+
 } // namespace PBD