2 Copyright (C) 2006-2009 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 #include <stdio.h> // for rename(), sigh
29 #include "pbd/convert.h"
30 #include "pbd/basename.h"
31 #include "pbd/mountpoint.h"
32 #include "pbd/stl_delete.h"
33 #include "pbd/strsplit.h"
34 #include "pbd/shortpath.h"
35 #include "pbd/enumwriter.h"
37 #include <glibmm/miscutils.h>
38 #include <glibmm/fileutils.h>
39 #include <glibmm/thread.h>
41 #include "ardour/file_source.h"
42 #include "ardour/directory_names.h"
43 #include "ardour/session.h"
44 #include "ardour/session_directory.h"
45 #include "ardour/source_factory.h"
46 #include "ardour/filename_extensions.h"
51 using namespace ARDOUR;
55 PBD::Signal3<int,std::string,std::string,std::vector<std::string> > FileSource::AmbiguousFileName;
57 FileSource::FileSource (Session& session, DataType type, const string& path, const string& origin, Source::Flag flag)
58 : Source(session, type, path, flag)
65 set_within_session_from_path (path);
70 FileSource::FileSource (Session& session, const XMLNode& node, bool /*must_exist*/)
71 : Source(session, node)
72 , _file_is_new (false)
74 /* this setting of _path is temporary - we expect derived classes
75 to call ::init() which will actually locate the file
76 and reset _path and _within_session correctly.
80 _within_session = true;
86 FileSource::prevent_deletion ()
88 /* if this file already exists, it cannot be removed, ever
91 if (Glib::file_test (_path, Glib::FILE_TEST_EXISTS)) {
92 if (!(_flags & Destructive)) {
95 _flags = Flag (_flags & ~(Removable|RemovableIfEmpty|RemoveAtDestroy));
101 FileSource::removable () const
103 bool r = ((_flags & Removable)
104 && ((_flags & RemoveAtDestroy) ||
105 ((_flags & RemovableIfEmpty) && empty() == 0)));
111 FileSource::init (const string& pathstr, bool must_exist)
113 _timeline_position = 0;
115 if (Stateful::loading_state_version < 3000) {
116 if (!find_2X (_session, _type, pathstr, must_exist, _file_is_new, _channel, _path)) {
117 throw MissingSource (pathstr, _type);
120 if (!find (_session, _type, pathstr, must_exist, _file_is_new, _channel, _path)) {
121 throw MissingSource (pathstr, _type);
125 set_within_session_from_path (_path);
127 if (!within_session()) {
128 _session.ensure_search_path_includes (Glib::path_get_dirname (_path), _type);
131 _name = Glib::path_get_basename (_path);
133 if (_file_is_new && must_exist) {
141 FileSource::set_state (const XMLNode& node, int /*version*/)
143 const XMLProperty* prop;
145 if ((prop = node.property (X_("channel"))) != 0) {
146 _channel = atoi (prop->value());
151 if ((prop = node.property (X_("origin"))) != 0) {
152 _origin = prop->value();
159 FileSource::mark_take (const string& id)
167 FileSource::move_to_trash (const string& trash_dir_name)
169 if (!within_session() || !writable()) {
173 /* don't move the file across filesystems, just stick it in the
174 trash_dir_name directory on whichever filesystem it was already on
178 v.push_back (Glib::path_get_dirname (Glib::path_get_dirname (_path)));
179 v.push_back (trash_dir_name);
180 v.push_back (Glib::path_get_basename (_path));
182 string newpath = Glib::build_filename (v);
184 /* the new path already exists, try versioning */
186 if (Glib::file_test (newpath.c_str(), Glib::FILE_TEST_EXISTS)) {
187 char buf[PATH_MAX+1];
191 snprintf (buf, sizeof (buf), "%s.%d", newpath.c_str(), version);
194 while (access (newpath_v.c_str(), F_OK) == 0 && version < 999) {
195 snprintf (buf, sizeof (buf), "%s.%d", newpath.c_str(), ++version);
199 if (version == 999) {
200 PBD::error << string_compose (
201 _("there are already 1000 files with names like %1; versioning discontinued"),
208 if (::rename (_path.c_str(), newpath.c_str()) != 0) {
209 PBD::error << string_compose (
210 _("cannot rename file source from %1 to %2 (%3)"),
211 _path, newpath, strerror (errno)) << endmsg;
215 if (move_dependents_to_trash() != 0) {
216 /* try to back out */
217 rename (newpath.c_str(), _path.c_str());
223 /* file can not be removed twice, since the operation is not idempotent */
224 _flags = Flag (_flags & ~(RemoveAtDestroy|Removable|RemovableIfEmpty));
229 /** Find the actual source file based on \a filename.
231 * If the source is within the session tree, \a filename should be a simple filename (no slashes).
232 * If the source is external, \a filename should be a full path.
233 * In either case, found_path is set to the complete absolute path of the source file.
234 * \return true iff the file was found.
237 FileSource::find (Session& s, DataType type, const string& path, bool must_exist,
238 bool& isnew, uint16_t& chan, string& found_path)
245 if (!Glib::path_is_absolute (path)) {
251 string search_path = s.source_search_path (type);
253 if (search_path.length() == 0) {
254 error << _("FileSource: search path not set") << endmsg;
258 split (search_path, dirs, ':');
263 for (vector<string>::iterator i = dirs.begin(); i != dirs.end(); ++i) {
265 fullpath = Glib::build_filename (*i, path);
267 if (Glib::file_test (fullpath, Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_REGULAR)) {
269 hits.push_back (fullpath);
276 int which = FileSource::AmbiguousFileName (path, search_path, hits).get_value_or (-1);
281 keeppath = hits[which];
284 } else if (cnt == 0) {
287 error << string_compose(
288 _("Filesource: cannot find required file (%1): while searching %2"),
289 path, search_path) << endmsg;
299 /* Current find() is unable to parse relative path names to yet non-existant
300 sources. QuickFix(tm)
302 if (keeppath == "") {
304 error << "FileSource::find(), keeppath = \"\", but the file must exist" << endl;
310 found_path = keeppath;
318 /** Find the actual source file based on \a filename.
320 * If the source is within the session tree, \a filename should be a simple filename (no slashes).
321 * If the source is external, \a filename should be a full path.
322 * In either case, found_path is set to the complete absolute path of the source file.
323 * \return true iff the file was found.
326 FileSource::find_2X (Session& s, DataType type, const string& path, bool must_exist,
327 bool& isnew, uint16_t& chan, string& found_path)
329 string search_path = s.source_search_path (type);
331 string pathstr = path;
332 string::size_type pos;
337 if (!Glib::path_is_absolute (pathstr)) {
339 /* non-absolute pathname: find pathstr in search path */
346 if (search_path.length() == 0) {
347 error << _("FileSource: search path not set") << endmsg;
351 split (search_path, dirs, ':');
355 for (vector<string>::iterator i = dirs.begin(); i != dirs.end(); ++i) {
357 fullpath = Glib::build_filename (*i, pathstr);
359 /* i (paul) made a nasty design error by using ':' as a special character in
360 Ardour 0.99 .. this hack tries to make things sort of work.
363 if ((pos = pathstr.find_last_of (':')) != string::npos) {
365 if (Glib::file_test (fullpath, Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_REGULAR)) {
367 /* its a real file, no problem */
376 /* might be an older session using file:channel syntax. see if the version
377 without the :suffix exists
380 string shorter = pathstr.substr (0, pos);
381 fullpath = Glib::build_filename (*i, shorter);
383 if (Glib::file_test (pathstr, Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_REGULAR)) {
384 chan = atoi (pathstr.substr (pos+1));
392 /* new derived file (e.g. for timefx) being created in a newer session */
399 if (Glib::file_test (fullpath, Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_REGULAR)) {
408 error << string_compose (
409 _("FileSource: \"%1\" is ambigous when searching %2\n\t"),
410 pathstr, search_path) << endmsg;
413 } else if (cnt == 0) {
416 error << string_compose(
417 _("Filesource: cannot find required file (%1): while searching %2"),
418 pathstr, search_path) << endmsg;
425 /* Current find() is unable to parse relative path names to yet non-existant
426 sources. QuickFix(tm) */
427 if (keeppath == "") {
429 error << "FileSource::find(), keeppath = \"\", but the file must exist" << endl;
435 found_path = keeppath;
441 /* external files and/or very very old style sessions include full paths */
443 /* ugh, handle ':' situation */
445 if ((pos = pathstr.find_last_of (':')) != string::npos) {
447 string shorter = pathstr.substr (0, pos);
449 if (Glib::file_test (shorter, Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_REGULAR)) {
450 chan = atoi (pathstr.substr (pos+1));
455 found_path = pathstr;
457 if (!Glib::file_test (pathstr, Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_REGULAR)) {
459 /* file does not exist or we cannot read it */
462 error << string_compose(
463 _("Filesource: cannot find required file (%1): %2"),
464 path, strerror (errno)) << endmsg;
468 if (errno != ENOENT) {
469 error << string_compose(
470 _("Filesource: cannot check for existing file (%1): %2"),
471 path, strerror (errno)) << endmsg;
491 FileSource::set_source_name (const string& newname, bool destructive)
493 Glib::Mutex::Lock lm (_lock);
494 string oldpath = _path;
495 string newpath = _session.change_source_path_by_name (oldpath, _name, newname, destructive);
497 if (newpath.empty()) {
498 error << string_compose (_("programming error: %1"), "cannot generate a changed file path") << endmsg;
502 // Test whether newpath exists, if yes notify the user but continue.
503 if (Glib::file_test (newpath, Glib::FILE_TEST_EXISTS)) {
504 error << string_compose (_("Programming error! %1 tried to rename a file over another file! It's safe to continue working, but please report this to the developers."), PROGRAM_NAME) << endmsg;
508 if (::rename (oldpath.c_str(), newpath.c_str()) != 0) {
509 error << string_compose (_("cannot rename file %1 to %2 (%3)"), oldpath, newpath, strerror(errno)) << endmsg;
513 _name = Glib::path_get_basename (newpath);
520 FileSource::mark_immutable ()
522 /* destructive sources stay writable, and their other flags don't change. */
523 if (!(_flags & Destructive)) {
524 _flags = Flag (_flags & ~(Writable|Removable|RemovableIfEmpty|RemoveAtDestroy|CanRename));
529 FileSource::mark_nonremovable ()
531 _flags = Flag (_flags & ~(Removable|RemovableIfEmpty|RemoveAtDestroy));
535 FileSource::set_within_session_from_path (const std::string& path)
537 _within_session = _session.path_is_within_session (path);
541 FileSource::set_path (const std::string& newpath)
547 FileSource::inc_use_count ()
549 Source::inc_use_count ();