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 static
 137 bool accept_all_files (string const &, void *)
 138 {
 139         return true;
 140 }
 141
 142 void
 143 get_paths (vector<string>& result,
 144            const Searchpath& paths,
 145            bool files_only,
 146            bool recurse)
 147 {
 148         run_functor_for_paths (result, paths, accept_all_files, 0,
 149                                files_only, true, true, recurse);
 150 }
 151
 152 void
 153 get_files (vector<string>& result, const Searchpath& paths)
 154 {
 155         return get_paths (result, paths, true, false);
 156 }
 157
 158 static
 159 bool
 160 pattern_filter (const string& str, void *arg)
 161 {
 162         Glib::PatternSpec* pattern = (Glib::PatternSpec*)arg;
 163         return pattern->match(str);
 164 }
 165
 166 void
 167 find_files_matching_pattern (vector<string>& result,
 168                              const Searchpath& paths,
 169                              const Glib::PatternSpec& pattern)
 170 {
 171         run_functor_for_paths (result, paths, pattern_filter,
 172                                const_cast<Glib::PatternSpec*>(&pattern),
 173                                true, false, true, false);
 174 }
 175
 176 void
 177 find_files_matching_pattern (vector<string>& result,
 178                              const Searchpath& paths,
 179                              const string& pattern)
 180 {
 181         Glib::PatternSpec tmp(pattern);
 182         find_files_matching_pattern (result, paths, tmp);
 183 }
 184
 185 bool
 186 find_file (const Searchpath& search_path,
 187            const string& filename,
 188            std::string& result)
 189 {
 190         vector<std::string> tmp;
 191
 192         find_files_matching_pattern (tmp, search_path, filename);
 193
 194         if (tmp.size() == 0) {
 195                 DEBUG_TRACE (DEBUG::FileUtils,
 196                              string_compose("No file matching %1 found in Path: %2\n",
 197                              filename, search_path.to_string()));
 198                 return false;
 199         }
 200
 201         if (tmp.size() != 1) {
 202                 DEBUG_TRACE (DEBUG::FileUtils,
 203                              string_compose("Found more that one file matching %1 in Path: %2\n",
 204                              filename, search_path.to_string()));
 205         }
 206
 207         result = tmp.front();
 208
 209         DEBUG_TRACE (DEBUG::FileUtils,
 210                      string_compose("Found file %1 in Path: %2\n",
 211                      filename, search_path.to_string()));
 212
 213         return true;
 214 }
 215
 216 static
 217 bool
 218 regexp_filter (const string& str, void *arg)
 219 {
 220         regex_t* pattern = (regex_t*)arg;
 221         return regexec (pattern, str.c_str(), 0, 0, 0) == 0;
 222 }
 223
 224 void
 225 find_files_matching_regex (vector<string>& result,
 226                            const Searchpath& paths,
 227                            const std::string& regexp)
 228 {
 229         int err;
 230         char msg[256];
 231         regex_t compiled_pattern;
 232
 233         if ((err = regcomp (&compiled_pattern, regexp.c_str(),
 234                             REG_EXTENDED|REG_NOSUB))) {
 235
 236                 regerror (err, &compiled_pattern,
 237                           msg, sizeof (msg));
 238
 239                 error << "Cannot compile soundfile regexp for use ("
 240                       << msg
 241                       << ")"
 242                       << endmsg;
 243
 244                 return;
 245         }
 246
 247         DEBUG_TRACE (DEBUG::FileUtils,
 248                         string_compose("Matching files using regexp: %1\n", regexp));
 249
 250         find_files_matching_filter (result, paths,
 251                                     regexp_filter, &compiled_pattern,
 252                                     true, true, false);
 253
 254         regfree (&compiled_pattern);
 255 }
 256
 257 void
 258 find_paths_matching_filter (vector<string>& result,
 259                             const Searchpath& paths,
 260                             bool (*filter)(const string &, void *),
 261                             void *arg,
 262                             bool pass_fullpath, bool return_fullpath,
 263                             bool recurse)
 264 {
 265         run_functor_for_paths (result, paths, filter, arg, false, pass_fullpath, return_fullpath, recurse);
 266 }
 267
 268 void
 269 find_files_matching_filter (vector<string>& result,
 270                             const Searchpath& paths,
 271                             bool (*filter)(const string &, void *),
 272                             void *arg,
 273                             bool pass_fullpath, bool return_fullpath,
 274                             bool recurse)
 275 {
 276         run_functor_for_paths (result, paths, filter, arg, true, pass_fullpath, return_fullpath, recurse);
 277 }
 278
 279 #ifdef PLATFORM_WINDOWS
 280 #define WRITE_FLAGS O_RDWR | O_CREAT | O_BINARY
 281 #define READ_FLAGS O_RDONLY | O_BINARY
 282 #else
 283 #define WRITE_FLAGS O_RDWR | O_CREAT
 284 #define READ_FLAGS O_RDONLY
 285 #endif
 286
 287 bool
 288 copy_file(const std::string & from_path, const std::string & to_path)
 289 {
 290         if (!Glib::file_test (from_path, Glib::FILE_TEST_EXISTS)) return false;
 291
 292         int fd_from = -1;
 293         int fd_to = -1;
 294         char buf[4096]; // BUFSIZ  ??
 295         ssize_t nread;
 296
 297         fd_from = ::open(from_path.c_str(), READ_FLAGS);
 298         if (fd_from < 0) {
 299                 goto copy_error;
 300         }
 301
 302         fd_to = ::open(to_path.c_str(), WRITE_FLAGS, 0666);
 303         if (fd_to < 0) {
 304                 goto copy_error;
 305         }
 306
 307         while (nread = ::read(fd_from, buf, sizeof(buf)), nread > 0) {
 308                 char *out_ptr = buf;
 309                 do {
 310                         ssize_t nwritten = ::write(fd_to, out_ptr, nread);
 311                         if (nwritten >= 0) {
 312                                 nread -= nwritten;
 313                                 out_ptr += nwritten;
 314                         } else if (errno != EINTR) {
 315                                 goto copy_error;
 316                         }
 317                 } while (nread > 0);
 318         }
 319
 320         if (nread == 0) {
 321                 if (::close(fd_to)) {
 322                         fd_to = -1;
 323                         goto copy_error;
 324                 }
 325                 ::close(fd_from);
 326                 return true;
 327         }
 328
 329 copy_error:
 330         int saved_errno = errno;
 331
 332         if (fd_from >= 0) {
 333                 ::close(fd_from);
 334         }
 335         if (fd_to >= 0) {
 336                 ::close(fd_to);
 337         }
 338
 339         error << string_compose (_("Unable to Copy file %1 to %2 (%3)"),
 340                         from_path, to_path, strerror(saved_errno))
 341                 << endmsg;
 342         return false;
 343 }
 344
 345 void
 346 copy_files(const std::string & from_path, const std::string & to_dir)
 347 {
 348         vector<string> files;
 349         find_files_matching_filter (files, from_path, accept_all_files, 0, true, false);
 350
 351         for (vector<string>::iterator i = files.begin(); i != files.end(); ++i) {
 352                 std::string from = Glib::build_filename (from_path, *i);
 353                 std::string to = Glib::build_filename (to_dir, *i);
 354                 copy_file (from, to);
 355         }
 356 }
 357
 358 std::string
 359 get_absolute_path (const std::string & p)
 360 {
 361         if (Glib::path_is_absolute(p)) return p;
 362         return Glib::build_filename (Glib::get_current_dir(), p);
 363 }
 364
 365 bool
 366 equivalent_paths (const std::string& a, const std::string& b)
 367 {
 368         GStatBuf bA;
 369         int const rA = g_stat (a.c_str(), &bA);
 370         GStatBuf bB;
 371         int const rB = g_stat (b.c_str(), &bB);
 372
 373         return (rA == 0 && rB == 0 && bA.st_dev == bB.st_dev && bA.st_ino == bB.st_ino);
 374 }
 375
 376 bool
 377 path_is_within (std::string const & haystack, std::string needle)
 378 {
 379         while (1) {
 380                 if (equivalent_paths (haystack, needle)) {
 381                         return true;
 382                 }
 383
 384                 needle = Glib::path_get_dirname (needle);
 385                 if (needle == "." || needle == "/") {
 386                         break;
 387                 }
 388         }
 389
 390         return false;
 391 }
 392
 393 bool
 394 exists_and_writable (const std::string & p)
 395 {
 396         /* writable() really reflects the whole folder, but if for any
 397            reason the session state file can't be written to, still
 398            make us unwritable.
 399         */
 400
 401         GStatBuf statbuf;
 402
 403         if (g_stat (p.c_str(), &statbuf) != 0) {
 404                 /* doesn't exist - not writable */
 405                 return false;
 406         } else {
 407                 if (!(statbuf.st_mode & S_IWUSR)) {
 408                         /* exists and is not writable */
 409                         return false;
 410                 }
 411                 /* filesystem may be mounted read-only, so even though file
 412                  * permissions permit access, the mount status does not.
 413                  * access(2) seems like the best test for this.
 414                  */
 415                 if (g_access (p.c_str(), W_OK) != 0) {
 416                         return false;
 417                 }
 418         }
 419
 420         return true;
 421 }
 422
 423 int
 424 remove_directory_internal (const string& dir, size_t* size, vector<string>* paths,
 425                            bool just_remove_files)
 426 {
 427         vector<string> tmp_paths;
 428         struct stat statbuf;
 429         int ret = 0;
 430
 431         get_paths (tmp_paths, dir, just_remove_files, true);
 432
 433         for (vector<string>::const_iterator i = tmp_paths.begin();
 434              i != tmp_paths.end(); ++i) {
 435
 436                 if (g_stat (i->c_str(), &statbuf)) {
 437                         continue;
 438                 }
 439
 440                 if (::g_remove (i->c_str())) {
 441                         error << string_compose (_("cannot remove path %1 (%2)"), *i, strerror (errno))
 442                               << endmsg;
 443                         ret = 1;
 444                 }
 445
 446                 if (paths) {
 447                         paths->push_back (Glib::path_get_basename(*i));
 448                 }
 449
 450                 if (size) {
 451                         *size += statbuf.st_size;
 452                 }
 453
 454         }
 455
 456         return ret;
 457 }
 458
 459 int
 460 clear_directory (const string& dir, size_t* size, vector<string>* paths)
 461 {
 462         return remove_directory_internal (dir, size, paths, true);
 463 }
 464
 465 // rm -rf <dir> -- used to remove saved plugin state
 466 void
 467 remove_directory (const std::string& dir)
 468 {
 469         remove_directory_internal (dir, 0, 0, false);
 470 }
 471
 472 } // namespace PBD