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/session.h"
43 #include "ardour/session_directory.h"
44 #include "ardour/source_factory.h"
45 #include "ardour/filename_extensions.h"
49 using namespace ARDOUR;
53 static const std::string PATH_SEP = "/"; // I don't do windows
55 map<DataType, ustring> FileSource::search_paths;
57 FileSource::FileSource (Session& session, DataType type,
58 const ustring& path, bool embedded, Source::Flag flag)
59 : Source(session, type, path, flag)
63 , _is_embedded(embedded)
67 FileSource::FileSource (Session& session, const XMLNode& node, bool must_exist)
68 : Source(session, node)
72 _is_embedded = (_path.find(PATH_SEP) != string::npos);
76 FileSource::removable () const
78 return (_flags & Removable)
79 && ( (_flags & RemoveAtDestroy)
80 || ((_flags & RemovableIfEmpty) && length(timeline_position()) == 0));
84 FileSource::init (const ustring& pathstr, bool must_exist)
86 _timeline_position = 0;
88 if (!find (_type, pathstr, must_exist, _file_is_new, _channel)) {
89 throw MissingSource ();
92 if (_file_is_new && must_exist) {
100 FileSource::set_state (const XMLNode& node)
102 const XMLProperty* prop;
104 if ((prop = node.property (X_("channel"))) != 0) {
105 _channel = atoi (prop->value());
110 _is_embedded = (_name.find(PATH_SEP) == string::npos);
116 FileSource::mark_take (const ustring& id)
124 FileSource::move_to_trash (const ustring& trash_dir_name)
127 cerr << "tried to move an embedded region to trash" << endl;
135 /* don't move the file across filesystems, just stick it in the
136 trash_dir_name directory on whichever filesystem it was already on
140 newpath = Glib::path_get_dirname (_path);
141 newpath = Glib::path_get_dirname (newpath);
143 newpath += string(PATH_SEP) + trash_dir_name + PATH_SEP;
144 newpath += Glib::path_get_basename (_path);
146 /* the new path already exists, try versioning */
147 if (access (newpath.c_str(), F_OK) == 0) {
148 char buf[PATH_MAX+1];
152 snprintf (buf, sizeof (buf), "%s.%d", newpath.c_str(), version);
155 while (access (newpath_v.c_str(), F_OK) == 0 && version < 999) {
156 snprintf (buf, sizeof (buf), "%s.%d", newpath.c_str(), ++version);
160 if (version == 999) {
161 PBD::error << string_compose (
162 _("there are already 1000 files with names like %1; versioning discontinued"),
169 if (::rename (_path.c_str(), newpath.c_str()) != 0) {
170 PBD::error << string_compose (
171 _("cannot rename file source from %1 to %2 (%3)"),
172 _path, newpath, strerror (errno)) << endmsg;
176 if (move_dependents_to_trash() != 0) {
177 /* try to back out */
178 rename (newpath.c_str(), _path.c_str());
184 /* file can not be removed twice, since the operation is not idempotent */
185 _flags = Flag (_flags & ~(RemoveAtDestroy|Removable|RemovableIfEmpty));
190 /** Find the actual source file based on \a path.
192 * If the source is embedded, \a path should be a filename (no slashes).
193 * If the source is external, \a path should be a full path.
194 * In either case, _path is set to the complete absolute path of the source file.
195 * \return true iff the file was found.
198 FileSource::find (DataType type, const ustring& path, bool must_exist, bool& isnew, uint16_t& chan)
200 Glib::ustring search_path = search_paths[type];
202 ustring pathstr = path;
203 ustring::size_type pos;
208 if (pathstr[0] != '/') {
210 /* non-absolute pathname: find pathstr in search path */
212 vector<ustring> dirs;
217 if (search_path.length() == 0) {
218 error << _("FileSource: search path not set") << endmsg;
222 split (search_path, dirs, ':');
226 for (vector<ustring>::iterator i = dirs.begin(); i != dirs.end(); ++i) {
228 if (fullpath[fullpath.length()-1] != '/') {
234 /* i (paul) made a nasty design error by using ':' as a special character in
235 Ardour 0.99 .. this hack tries to make things sort of work.
238 if ((pos = pathstr.find_last_of (':')) != ustring::npos) {
240 if (Glib::file_test (fullpath, Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_REGULAR)) {
242 /* its a real file, no problem */
251 /* might be an older session using file:channel syntax. see if the version
252 without the :suffix exists
255 ustring shorter = pathstr.substr (0, pos);
258 if (fullpath[fullpath.length()-1] != '/') {
264 if (Glib::file_test (pathstr, Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_REGULAR)) {
265 chan = atoi (pathstr.substr (pos+1));
273 /* new derived file (e.g. for timefx) being created in a newer session */
280 if (Glib::file_test (fullpath, Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_REGULAR)) {
289 error << string_compose (
290 _("FileSource: \"%1\" is ambigous when searching %2\n\t"),
291 pathstr, search_path) << endmsg;
294 } else if (cnt == 0) {
297 error << string_compose(
298 _("Filesource: cannot find required file (%1): while searching %2"),
299 pathstr, search_path) << endmsg;
306 /* Current find() is unable to parse relative path names to yet non-existant
307 sources. QuickFix(tm) */
308 if (keeppath == "") {
310 error << "FileSource::find(), keeppath = \"\", but the file must exist" << endl;
322 /* external files and/or very very old style sessions include full paths */
324 /* ugh, handle ':' situation */
326 if ((pos = pathstr.find_last_of (':')) != ustring::npos) {
328 ustring shorter = pathstr.substr (0, pos);
330 if (Glib::file_test (shorter, Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_REGULAR)) {
331 chan = atoi (pathstr.substr (pos+1));
338 if (!Glib::file_test (pathstr, Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_REGULAR)) {
340 /* file does not exist or we cannot read it */
343 error << string_compose(
344 _("Filesource: cannot find required file (%1): %2"),
345 _path, strerror (errno)) << endmsg;
349 if (errno != ENOENT) {
350 error << string_compose(
351 _("Filesource: cannot check for existing file (%1): %2"),
352 _path, strerror (errno)) << endmsg;
368 _name = Glib::path_get_basename (_name);
376 FileSource::set_source_name (const ustring& newname, bool destructive)
378 Glib::Mutex::Lock lm (_lock);
379 ustring oldpath = _path;
380 ustring newpath = Session::change_source_path_by_name (oldpath, _name, newname, destructive);
382 if (newpath.empty()) {
383 error << string_compose (_("programming error: %1"), "cannot generate a changed file path") << endmsg;
387 // Test whether newpath exists, if yes notify the user but continue.
388 if (access(newpath.c_str(),F_OK) == 0) {
389 error << _("Programming error! Ardour tried to rename a file over another file! It's safe to continue working, but please report this to the developers.") << endmsg;
393 if (rename (oldpath.c_str(), newpath.c_str()) != 0) {
394 error << string_compose (_("cannot rename audio file %1 to %2"), _name, newpath) << endmsg;
398 _name = Glib::path_get_basename (newpath);
405 FileSource::set_search_path (DataType type, const ustring& p)
407 search_paths[type] = p;
411 FileSource::mark_immutable ()
413 /* destructive sources stay writable, and their other flags don't change. */
414 if (!(_flags & Destructive)) {
415 _flags = Flag (_flags & ~(Writable|Removable|RemovableIfEmpty|RemoveAtDestroy|CanRename));