libs/pbd/file_utils.cc

   1 /*
   2     Copyright (C) 2007-2014 Tim Mayberry
   3     Copyright (C) 1998-2014 Paul Davis
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 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 General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19 */
  20
  21 #include <algorithm>
  22 #include <vector>
  23
  24 #include <glib.h>
  25 #include <glib/gstdio.h>
  26
  27 #ifdef COMPILER_MINGW
  28 #include <io.h> // For W_OK
  29 #endif
  30
  31 #include <glibmm/fileutils.h>
  32 #include <glibmm/miscutils.h>
  33 #include <glibmm/pattern.h>
  34
  35 #include <errno.h>
  36 #include <string.h> /* strerror */
  37
  38 /* open() */
  39 #include <sys/types.h>
  40 #include <sys/stat.h>
  41 #include <fcntl.h>
  42
  43 /* close(), read(), write() */
  44 #ifdef COMPILER_MSVC
  45 #include <io.h> // Microsoft's nearest equivalent to <unistd.h>
  46 #include <ardourext/misc.h>
  47 #else
  48 #include <unistd.h>
  49 #include <regex.h>
  50 #endif
  51
  52 #include "pbd/compose.h"
  53 #include "pbd/file_manager.h"
  54 #include "pbd/file_utils.h"
  55 #include "pbd/debug.h"
  56 #include "pbd/error.h"
  57 #include "pbd/pathexpand.h"
  58 #include "pbd/stl_delete.h"
  59
  60 #include "i18n.h"
  61
  62 using namespace std;
  63
  64 namespace PBD {
  65
  66 void
  67 run_functor_for_paths (vector<string>& result,
  68                        const Searchpath& paths,
  69                        bool (*functor)(const string &, void *),
  70                        void *arg,
  71                        bool pass_files_only,
  72                        bool pass_fullpath, bool return_fullpath,
  73                        bool recurse)
  74 {
  75         for (vector<string>::const_iterator i = paths.begin(); i != paths.end(); ++i) {
  76                 string expanded_path = path_expand (*i);
  77                 DEBUG_TRACE (DEBUG::FileUtils,
  78                                 string_compose("Find files in expanded path: %1\n", expanded_path));
  79
  80                 if (!Glib::file_test (expanded_path, Glib::FILE_TEST_IS_DIR)) continue;
  81
  82                 try
  83                 {
  84                         Glib::Dir dir(expanded_path);
  85
  86                         for (Glib::DirIterator di = dir.begin(); di != dir.end(); di++) {
  87
  88                                 string fullpath = Glib::build_filename (expanded_path, *di);
  89                                 string basename = *di;
  90
  91                                 bool is_dir = Glib::file_test (fullpath, Glib::FILE_TEST_IS_DIR);
  92
  93                                 if (is_dir && recurse) {
  94                                         DEBUG_TRACE (DEBUG::FileUtils,
  95                                                         string_compose("Descending into directory:  %1\n",
  96                                                                 fullpath));
  97                                         run_functor_for_paths (result, fullpath, functor, arg, pass_files_only,
  98                                                                pass_fullpath, return_fullpath, recurse);
  99                                 }
 100
 101                                 if (is_dir && pass_files_only) {
 102                                         continue;
 103                                 }
 104
 105                                 string functor_str;
 106
 107                                 if (pass_fullpath) {
 108                                         functor_str = fullpath;
 109                                 } else {
 110                                         functor_str = basename;
 111                                 }
 112
 113                                 DEBUG_TRACE (DEBUG::FileUtils,
 114                                                 string_compose("Run Functor using string: %1\n", functor_str));
 115
 116                                 if (!functor(functor_str, arg)) {
 117                                         continue;
 118                                 }
 119
 120                                 DEBUG_TRACE (DEBUG::FileUtils,
 121                                                 string_compose("Found file %1 matching functor\n", functor_str));
 122
 123                                 if (return_fullpath) {
 124                                         result.push_back(fullpath);
 125                                 } else {
 126                                         result.push_back(basename);
 127                                 }
 128                         }
 129                 }
 130                 catch (Glib::FileError& err)
 131                 {
 132                         warning << err.what() << endmsg;
 133                 }
 134         }
 135 }
 136
 137 static
 138 bool accept_all_files (string const &, void *)
 139 {
 140         return true;
 141 }
 142
 143 void
 144 get_paths (vector<string>& result,
 145            const Searchpath& paths,
 146            bool files_only,
 147            bool recurse)
 148 {
 149         run_functor_for_paths (result, paths, accept_all_files, 0,
 150                                files_only, true, true, recurse);
 151 }
 152
 153 void
 154 get_files (vector<string>& result, const Searchpath& paths)
 155 {
 156         return get_paths (result, paths, true, false);
 157 }
 158
 159 static
 160 bool
 161 pattern_filter (const string& str, void *arg)
 162 {
 163         Glib::PatternSpec* pattern = (Glib::PatternSpec*)arg;
 164         return pattern->match(str);
 165 }
 166
 167 void
 168 find_files_matching_pattern (vector<string>& result,
 169                              const Searchpath& paths,
 170                              const Glib::PatternSpec& pattern)
 171 {
 172         run_functor_for_paths (result, paths, pattern_filter,
 173                                const_cast<Glib::PatternSpec*>(&pattern),
 174                                true, false, true, false);
 175 }
 176
 177 void
 178 find_files_matching_pattern (vector<string>& result,
 179                              const Searchpath& paths,
 180                              const string& pattern)
 181 {
 182         Glib::PatternSpec tmp(pattern);
 183         find_files_matching_pattern (result, paths, tmp);
 184 }
 185
 186 bool
 187 find_file (const Searchpath& search_path,
 188            const string& filename,
 189            std::string& result)
 190 {
 191         vector<std::string> tmp;
 192
 193         find_files_matching_pattern (tmp, search_path, filename);
 194
 195         if (tmp.size() == 0) {
 196                 DEBUG_TRACE (DEBUG::FileUtils,
 197                              string_compose("No file matching %1 found in Path: %2\n",
 198                              filename, search_path.to_string()));
 199                 return false;
 200         }
 201
 202         if (tmp.size() != 1) {
 203                 DEBUG_TRACE (DEBUG::FileUtils,
 204                              string_compose("Found more that one file matching %1 in Path: %2\n",
 205                              filename, search_path.to_string()));
 206         }
 207
 208         result = tmp.front();
 209
 210         DEBUG_TRACE (DEBUG::FileUtils,
 211                      string_compose("Found file %1 in Path: %2\n",
 212                      filename, search_path.to_string()));
 213
 214         return true;
 215 }
 216
 217 static
 218 bool
 219 regexp_filter (const string& str, void *arg)
 220 {
 221         regex_t* pattern = (regex_t*)arg;
 222         return regexec (pattern, str.c_str(), 0, 0, 0) == 0;
 223 }
 224
 225 void
 226 find_files_matching_regex (vector<string>& result,
 227                            const Searchpath& paths,
 228                            const std::string& regexp)
 229 {
 230         int err;
 231         char msg[256];
 232         regex_t compiled_pattern;
 233
 234         if ((err = regcomp (&compiled_pattern, regexp.c_str(),
 235                             REG_EXTENDED|REG_NOSUB))) {
 236
 237                 regerror (err, &compiled_pattern,
 238                           msg, sizeof (msg));
 239
 240                 error << "Cannot compile soundfile regexp for use ("
 241                       << msg
 242                       << ")"
 243                       << endmsg;
 244
 245                 return;
 246         }
 247
 248         DEBUG_TRACE (DEBUG::FileUtils,
 249                         string_compose("Matching files using regexp: %1\n", regexp));
 250
 251         find_files_matching_filter (result, paths,
 252                                     regexp_filter, &compiled_pattern,
 253                                     true, true, false);
 254
 255         regfree (&compiled_pattern);
 256 }
 257
 258 void
 259 find_paths_matching_filter (vector<string>& result,
 260                             const Searchpath& paths,
 261                             bool (*filter)(const string &, void *),
 262                             void *arg,
 263                             bool pass_fullpath, bool return_fullpath,
 264                             bool recurse)
 265 {
 266         run_functor_for_paths (result, paths, filter, arg, false, pass_fullpath, return_fullpath, recurse);
 267 }
 268
 269 void
 270 find_files_matching_filter (vector<string>& result,
 271                             const Searchpath& paths,
 272                             bool (*filter)(const string &, void *),
 273                             void *arg,
 274                             bool pass_fullpath, bool return_fullpath,
 275                             bool recurse)
 276 {
 277         run_functor_for_paths (result, paths, filter, arg, true, pass_fullpath, return_fullpath, recurse);
 278 }
 279
 280 bool
 281 copy_file(const std::string & from_path, const std::string & to_path)
 282 {
 283         if (!Glib::file_test (from_path, Glib::FILE_TEST_EXISTS)) return false;
 284
 285         FdFileDescriptor from_file(from_path, false, 0444);
 286         FdFileDescriptor to_file(to_path, true, 0666);
 287
 288         int fd_from = from_file.allocate ();
 289         int fd_to = to_file.allocate ();
 290         char buf[4096]; // BUFSIZ  ??
 291         ssize_t nread;
 292
 293         if ((fd_from < 0) || (fd_to < 0)) {
 294                 error << string_compose (_("Unable to Open files %1 to %2 for Copying(%3)"),
 295                                 from_path, to_path, g_strerror(errno))
 296                       << endmsg;
 297                 return false;
 298         }
 299
 300         while (nread = ::read(fd_from, buf, sizeof(buf)), nread > 0) {
 301                 char *out_ptr = buf;
 302                 do {
 303                         ssize_t nwritten = ::write(fd_to, out_ptr, nread);
 304                         if (nwritten >= 0) {
 305                                 nread -= nwritten;
 306                                 out_ptr += nwritten;
 307                         } else if (errno != EINTR) {
 308                                 error << string_compose (_("Unable to Copy files %1 to %2(%3)"),
 309                                                 from_path, to_path, g_strerror(errno))
 310                                         << endmsg;
 311                                 return false;
 312                         }
 313                 } while (nread > 0);
 314         }
 315
 316         return true;
 317 }
 318
 319 void
 320 copy_files(const std::string & from_path, const std::string & to_dir)
 321 {
 322         vector<string> files;
 323         find_files_matching_filter (files, from_path, accept_all_files, 0, true, false);
 324
 325         for (vector<string>::iterator i = files.begin(); i != files.end(); ++i) {
 326                 std::string from = Glib::build_filename (from_path, *i);
 327                 std::string to = Glib::build_filename (to_dir, *i);
 328                 copy_file (from, to);
 329         }
 330 }
 331
 332 void
 333 copy_recurse(const std::string & from_path, const std::string & to_dir)
 334 {
 335         vector<string> files;
 336         find_files_matching_filter (files, from_path, accept_all_files, 0, false, true, true);
 337
 338         const size_t prefix_len = from_path.size();
 339         for (vector<string>::iterator i = files.begin(); i != files.end(); ++i) {
 340                 std::string from = *i;
 341                 std::string to = Glib::build_filename (to_dir, (*i).substr(prefix_len));
 342                 g_mkdir_with_parents (Glib::path_get_dirname (to).c_str(), 0755);
 343                 copy_file (from, to);
 344         }
 345 }
 346
 347 std::string
 348 get_absolute_path (const std::string & p)
 349 {
 350         if (Glib::path_is_absolute(p)) return p;
 351         return Glib::build_filename (Glib::get_current_dir(), p);
 352 }
 353
 354 std::string
 355 get_suffix (const std::string & p)
 356 {
 357         string::size_type period = p.find_last_of ('.');
 358         if (period == string::npos || period == p.length() - 1) {
 359                 return string();
 360         }
 361         return p.substr (period+1);
 362 }
 363
 364 bool
 365 equivalent_paths (const std::string& a, const std::string& b)
 366 {
 367         GStatBuf bA;
 368         int const rA = g_stat (a.c_str(), &bA);
 369         GStatBuf bB;
 370         int const rB = g_stat (b.c_str(), &bB);
 371
 372         return (rA == 0 && rB == 0 && bA.st_dev == bB.st_dev && bA.st_ino == bB.st_ino);
 373 }
 374
 375 bool
 376 path_is_within (std::string const & haystack, std::string needle)
 377 {
 378         while (1) {
 379                 if (equivalent_paths (haystack, needle)) {
 380                         return true;
 381                 }
 382
 383                 needle = Glib::path_get_dirname (needle);
 384                 if (needle == "." || needle == "/") {
 385                         break;
 386                 }
 387         }
 388
 389         return false;
 390 }
 391
 392 bool
 393 exists_and_writable (const std::string & p)
 394 {
 395         /* writable() really reflects the whole folder, but if for any
 396            reason the session state file can't be written to, still
 397            make us unwritable.
 398         */
 399
 400         GStatBuf statbuf;
 401
 402         if (g_stat (p.c_str(), &statbuf) != 0) {
 403                 /* doesn't exist - not writable */
 404                 return false;
 405         } else {
 406                 if (!(statbuf.st_mode & S_IWUSR)) {
 407                         /* exists and is not writable */
 408                         return false;
 409                 }
 410                 /* filesystem may be mounted read-only, so even though file
 411                  * permissions permit access, the mount status does not.
 412                  * access(2) seems like the best test for this.
 413                  */
 414                 if (g_access (p.c_str(), W_OK) != 0) {
 415                         return false;
 416                 }
 417         }
 418
 419         return true;
 420 }
 421
 422 int
 423 remove_directory_internal (const string& dir, size_t* size, vector<string>* paths,
 424                            bool just_remove_files)
 425 {
 426         vector<string> tmp_paths;
 427         GStatBuf statbuf;
 428         int ret = 0;
 429
 430         get_paths (tmp_paths, dir, just_remove_files, true);
 431
 432         for (vector<string>::const_iterator i = tmp_paths.begin();
 433              i != tmp_paths.end(); ++i) {
 434
 435                 if (g_stat (i->c_str(), &statbuf)) {
 436                         continue;
 437                 }
 438
 439                 if (::g_remove (i->c_str())) {
 440                         error << string_compose (_("cannot remove path %1 (%2)"), *i, strerror (errno))
 441                               << endmsg;
 442                         ret = 1;
 443                 }
 444
 445                 if (paths) {
 446                         paths->push_back (Glib::path_get_basename(*i));
 447                 }
 448
 449                 if (size) {
 450                         *size += statbuf.st_size;
 451                 }
 452
 453         }
 454
 455         return ret;
 456 }
 457
 458 int
 459 clear_directory (const string& dir, size_t* size, vector<string>* paths)
 460 {
 461         return remove_directory_internal (dir, size, paths, true);
 462 }
 463
 464 // rm -rf <dir> -- used to remove saved plugin state
 465 void
 466 remove_directory (const std::string& dir)
 467 {
 468         remove_directory_internal (dir, 0, 0, false);
 469 }
 470
 471 string
 472 tmp_writable_directory (const char* domain, const string& prefix)
 473 {
 474         std::string tmp_dir = Glib::build_filename (g_get_tmp_dir(), domain);
 475         std::string dir_name;
 476         std::string new_test_dir;
 477         do {
 478                 ostringstream oss;
 479                 oss << prefix;
 480                 oss << g_random_int ();
 481                 dir_name = oss.str();
 482                 new_test_dir = Glib::build_filename (tmp_dir, dir_name);
 483                 if (Glib::file_test (new_test_dir, Glib::FILE_TEST_EXISTS)) continue;
 484         } while (g_mkdir_with_parents (new_test_dir.c_str(), 0755) != 0);
 485         return new_test_dir;
 486 }
 487
 488 } // namespace PBD