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_utils.h"
  54 #include "pbd/debug.h"
  55 #include "pbd/error.h"
  56 #include "pbd/pathexpand.h"
  57 #include "pbd/stl_delete.h"
  58
  59 #include "i18n.h"
  60
  61 using namespace std;
  62
  63 namespace PBD {
  64
  65 void
  66 run_functor_for_paths (vector<string>& result,
  67                        const Searchpath& paths,
  68                        bool (*functor)(const string &, void *),
  69                        void *arg,
  70                        bool pass_files_only,
  71                        bool pass_fullpath, bool return_fullpath,
  72                        bool recurse)
  73 {
  74         for (vector<string>::const_iterator i = paths.begin(); i != paths.end(); ++i) {
  75                 string expanded_path = path_expand (*i);
  76                 DEBUG_TRACE (DEBUG::FileUtils,
  77                                 string_compose("Find files in expanded path: %1\n", expanded_path));
  78
  79                 if (!Glib::file_test (expanded_path, Glib::FILE_TEST_IS_DIR)) continue;
  80
  81                 try
  82                 {
  83                         Glib::Dir dir(expanded_path);
  84
  85                         for (Glib::DirIterator di = dir.begin(); di != dir.end(); di++) {
  86
  87                                 string fullpath = Glib::build_filename (expanded_path, *di);
  88                                 string basename = *di;
  89
  90                                 bool is_dir = Glib::file_test (fullpath, Glib::FILE_TEST_IS_DIR);
  91
  92                                 if (is_dir && recurse) {
  93                                         DEBUG_TRACE (DEBUG::FileUtils,
  94                                                         string_compose("Descending into directory:  %1\n",
  95                                                                 fullpath));
  96                                         run_functor_for_paths (result, fullpath, functor, arg, pass_files_only,
  97                                                                pass_fullpath, return_fullpath, recurse);
  98                                 }
  99
 100                                 if (is_dir && pass_files_only) {
 101                                         continue;
 102                                 }
 103
 104                                 string functor_str;
 105
 106                                 if (pass_fullpath) {
 107                                         functor_str = fullpath;
 108                                 } else {
 109                                         functor_str = basename;
 110                                 }
 111
 112                                 DEBUG_TRACE (DEBUG::FileUtils,
 113                                                 string_compose("Run Functor using string: %1\n", functor_str));
 114
 115                                 if (!functor(functor_str, arg)) {
 116                                         continue;
 117                                 }
 118
 119                                 DEBUG_TRACE (DEBUG::FileUtils,
 120                                                 string_compose("Found file %1 matching functor\n", functor_str));
 121
 122                                 if (return_fullpath) {
 123                                         result.push_back(fullpath);
 124                                 } else {
 125                                         result.push_back(basename);
 126                                 }
 127                         }
 128                 }
 129                 catch (Glib::FileError& err)
 130                 {
 131                         warning << err.what() << endmsg;
 132                 }
 133         }
 134 }
 135
 136 void
 137 get_directory_contents (const std::string& directory_path,
 138                        vector<string>& result,
 139                        bool files_only,
 140                        bool recurse)
 141 {
 142         // perhaps we don't need this check assuming an exception is thrown
 143         // as it would save checking that the path is a directory twice when
 144         // recursing
 145         if (!Glib::file_test (directory_path, Glib::FILE_TEST_IS_DIR)) return;
 146
 147         try
 148         {
 149                 Glib::Dir dir(directory_path);
 150                 Glib::DirIterator i = dir.begin();
 151
 152                 while (i != dir.end()) {
 153
 154                         string fullpath = Glib::build_filename (directory_path, *i);
 155
 156                         bool is_dir = Glib::file_test (fullpath, Glib::FILE_TEST_IS_DIR);
 157
 158                         if (is_dir && recurse) {
 159                                 DEBUG_TRACE (DEBUG::FileUtils,
 160                                                 string_compose("Descending into directory:  %1\n",
 161                                                 fullpath));
 162                                 get_directory_contents (fullpath, result, files_only, recurse);
 163                         }
 164
 165                         i++;
 166
 167                         if (is_dir && files_only) {
 168                                 continue;
 169                         }
 170                         result.push_back (fullpath);
 171                 }
 172         }
 173         catch (Glib::FileError& err)
 174         {
 175                 warning << err.what() << endmsg;
 176         }
 177 }
 178
 179 void
 180 get_files_in_directory (const std::string& directory_path, vector<string>& result)
 181 {
 182         return get_directory_contents (directory_path, result, true, false);
 183 }
 184
 185 void
 186 find_files_matching_pattern (vector<string>& result,
 187                              const Searchpath& paths,
 188                              const Glib::PatternSpec& pattern)
 189 {
 190         vector<string> tmp_files;
 191
 192         for (vector<string>::const_iterator i = paths.begin(); i != paths.end(); ++i) {
 193                 get_files_in_directory (*i, tmp_files);
 194         }
 195
 196         for (vector<string>::iterator file_iter = tmp_files.begin();
 197                         file_iter != tmp_files.end();
 198                         ++file_iter)
 199         {
 200                 string filename = Glib::path_get_basename (*file_iter);
 201                 if (!pattern.match(filename)) continue;
 202
 203                 DEBUG_TRACE (DEBUG::FileUtils,
 204                              string_compose("Found file %1\n", *file_iter));
 205
 206                 result.push_back(*file_iter);
 207         }
 208
 209 }
 210
 211 void
 212 find_files_matching_pattern (vector<string>& result,
 213                              const Searchpath& paths,
 214                              const string& pattern)
 215 {
 216         Glib::PatternSpec tmp(pattern);
 217         find_files_matching_pattern (result, paths, tmp);
 218 }
 219
 220 bool
 221 find_file (const Searchpath& search_path,
 222            const string& filename,
 223            std::string& result)
 224 {
 225         vector<std::string> tmp;
 226
 227         find_files_matching_pattern (tmp, search_path, filename);
 228
 229         if (tmp.size() == 0) {
 230                 DEBUG_TRACE (DEBUG::FileUtils,
 231                              string_compose("No file matching %1 found in Path: %2\n",
 232                              filename, search_path.to_string()));
 233                 return false;
 234         }
 235
 236         if (tmp.size() != 1) {
 237                 DEBUG_TRACE (DEBUG::FileUtils,
 238                              string_compose("Found more that one file matching %1 in Path: %2\n",
 239                              filename, search_path.to_string()));
 240         }
 241
 242         result = tmp.front();
 243
 244         DEBUG_TRACE (DEBUG::FileUtils,
 245                      string_compose("Found file %1 in Path: %2\n",
 246                      filename, search_path.to_string()));
 247
 248         return true;
 249 }
 250
 251 static
 252 bool
 253 regexp_filter (const string& str, void *arg)
 254 {
 255         regex_t* pattern = (regex_t*)arg;
 256         return regexec (pattern, str.c_str(), 0, 0, 0) == 0;
 257 }
 258
 259 void
 260 find_files_matching_regex (vector<string>& result,
 261                            const Searchpath& paths,
 262                            const std::string& regexp)
 263 {
 264         int err;
 265         char msg[256];
 266         regex_t compiled_pattern;
 267
 268         if ((err = regcomp (&compiled_pattern, regexp.c_str(),
 269                             REG_EXTENDED|REG_NOSUB))) {
 270
 271                 regerror (err, &compiled_pattern,
 272                           msg, sizeof (msg));
 273
 274                 error << "Cannot compile soundfile regexp for use ("
 275                       << msg
 276                       << ")"
 277                       << endmsg;
 278
 279                 return;
 280         }
 281
 282         DEBUG_TRACE (DEBUG::FileUtils,
 283                         string_compose("Matching files using regexp: %1\n", regexp));
 284
 285         find_files_matching_filter (result, paths,
 286                                     regexp_filter, &compiled_pattern,
 287                                     true, true, false);
 288
 289         regfree (&compiled_pattern);
 290 }
 291
 292 void
 293 find_files_matching_filter (vector<string>& result,
 294                             const Searchpath& paths,
 295                             bool (*filter)(const string &, void *),
 296                             void *arg,
 297                             bool match_fullpath, bool return_fullpath,
 298                             bool recurse)
 299 {
 300         run_functor_for_paths (result, paths, filter, arg, true, match_fullpath, return_fullpath, recurse);
 301 }
 302
 303 bool
 304 copy_file(const std::string & from_path, const std::string & to_path)
 305 {
 306         if (!Glib::file_test (from_path, Glib::FILE_TEST_EXISTS)) return false;
 307
 308         int fd_from = -1;
 309         int fd_to = -1;
 310         char buf[4096]; // BUFSIZ  ??
 311         ssize_t nread;
 312
 313         fd_from = ::open(from_path.c_str(), O_RDONLY);
 314         if (fd_from < 0) {
 315                 goto copy_error;
 316         }
 317
 318         fd_to = ::open(to_path.c_str(), O_WRONLY | O_CREAT, 0666);
 319         if (fd_to < 0) {
 320                 goto copy_error;
 321         }
 322
 323         while (nread = ::read(fd_from, buf, sizeof(buf)), nread > 0) {
 324                 char *out_ptr = buf;
 325                 do {
 326                         ssize_t nwritten = ::write(fd_to, out_ptr, nread);
 327                         if (nwritten >= 0) {
 328                                 nread -= nwritten;
 329                                 out_ptr += nwritten;
 330                         } else if (errno != EINTR) {
 331                                 goto copy_error;
 332                         }
 333                 } while (nread > 0);
 334         }
 335
 336         if (nread == 0) {
 337                 if (::close(fd_to)) {
 338                         fd_to = -1;
 339                         goto copy_error;
 340                 }
 341                 ::close(fd_from);
 342                 return true;
 343         }
 344
 345 copy_error:
 346         int saved_errno = errno;
 347
 348         if (fd_from >= 0) {
 349                 ::close(fd_from);
 350         }
 351         if (fd_to >= 0) {
 352                 ::close(fd_to);
 353         }
 354
 355         error << string_compose (_("Unable to Copy file %1 to %2 (%3)"),
 356                         from_path, to_path, strerror(saved_errno))
 357                 << endmsg;
 358         return false;
 359 }
 360
 361 static
 362 bool accept_all_files (string const &, void *)
 363 {
 364         return true;
 365 }
 366
 367 void
 368 copy_files(const std::string & from_path, const std::string & to_dir)
 369 {
 370         vector<string> files;
 371         find_files_matching_filter (files, from_path, accept_all_files, 0, true, false);
 372
 373         for (vector<string>::iterator i = files.begin(); i != files.end(); ++i) {
 374                 std::string from = Glib::build_filename (from_path, *i);
 375                 std::string to = Glib::build_filename (to_dir, *i);
 376                 copy_file (from, to);
 377         }
 378 }
 379
 380 std::string
 381 get_absolute_path (const std::string & p)
 382 {
 383         if (Glib::path_is_absolute(p)) return p;
 384         return Glib::build_filename (Glib::get_current_dir(), p);
 385 }
 386
 387 bool
 388 equivalent_paths (const std::string& a, const std::string& b)
 389 {
 390         GStatBuf bA;
 391         int const rA = g_stat (a.c_str(), &bA);
 392         GStatBuf bB;
 393         int const rB = g_stat (b.c_str(), &bB);
 394
 395         return (rA == 0 && rB == 0 && bA.st_dev == bB.st_dev && bA.st_ino == bB.st_ino);
 396 }
 397
 398 bool
 399 path_is_within (std::string const & haystack, std::string needle)
 400 {
 401         while (1) {
 402                 if (equivalent_paths (haystack, needle)) {
 403                         return true;
 404                 }
 405
 406                 needle = Glib::path_get_dirname (needle);
 407                 if (needle == "." || needle == "/") {
 408                         break;
 409                 }
 410         }
 411
 412         return false;
 413 }
 414
 415 bool
 416 exists_and_writable (const std::string & p)
 417 {
 418         /* writable() really reflects the whole folder, but if for any
 419            reason the session state file can't be written to, still
 420            make us unwritable.
 421         */
 422
 423         GStatBuf statbuf;
 424
 425         if (g_stat (p.c_str(), &statbuf) != 0) {
 426                 /* doesn't exist - not writable */
 427                 return false;
 428         } else {
 429                 if (!(statbuf.st_mode & S_IWUSR)) {
 430                         /* exists and is not writable */
 431                         return false;
 432                 }
 433                 /* filesystem may be mounted read-only, so even though file
 434                  * permissions permit access, the mount status does not.
 435                  * access(2) seems like the best test for this.
 436                  */
 437                 if (g_access (p.c_str(), W_OK) != 0) {
 438                         return false;
 439                 }
 440         }
 441
 442         return true;
 443 }
 444
 445 int
 446 remove_directory_internal (const string& dir, size_t* size, vector<string>* paths,
 447                            bool just_remove_files)
 448 {
 449         vector<string> tmp_paths;
 450         struct stat statbuf;
 451         int ret = 0;
 452
 453         get_directory_contents (dir, tmp_paths, just_remove_files, true);
 454
 455         for (vector<string>::const_iterator i = tmp_paths.begin();
 456              i != tmp_paths.end(); ++i) {
 457
 458                 if (g_stat (i->c_str(), &statbuf)) {
 459                         continue;
 460                 }
 461
 462                 if (::g_remove (i->c_str())) {
 463                         error << string_compose (_("cannot remove path %1 (%2)"), *i, strerror (errno))
 464                               << endmsg;
 465                         ret = 1;
 466                 }
 467
 468                 if (paths) {
 469                         paths->push_back (Glib::path_get_basename(*i));
 470                 }
 471
 472                 if (size) {
 473                         *size += statbuf.st_size;
 474                 }
 475
 476         }
 477
 478         return ret;
 479 }
 480
 481 int
 482 clear_directory (const string& dir, size_t* size, vector<string>* paths)
 483 {
 484         return remove_directory_internal (dir, size, paths, true);
 485 }
 486
 487 // rm -rf <dir> -- used to remove saved plugin state
 488 void
 489 remove_directory (const std::string& dir)
 490 {
 491         remove_directory_internal (dir, 0, 0, false);
 492 }
 493
 494 } // namespace PBD