Fix save/load of MIDI automation state. Fixes #3354.
[ardour.git] / libs / ardour / file_source.cc
index 649fc6156b5bf641f33ae3a4e74120c2e58ae98f..512d37a10b5745195131fa62c6c0a3bce80d3237 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2006-2009 Paul Davis 
+    Copyright (C) 2006-2009 Paul Davis
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 #include <fcntl.h>
 #include <errno.h>
 
-#include <pbd/convert.h>
-#include <pbd/basename.h>
-#include <pbd/mountpoint.h>
-#include <pbd/stl_delete.h>
-#include <pbd/strsplit.h>
-#include <pbd/shortpath.h>
-#include <pbd/enumwriter.h>
+#include "pbd/convert.h"
+#include "pbd/basename.h"
+#include "pbd/mountpoint.h"
+#include "pbd/stl_delete.h"
+#include "pbd/strsplit.h"
+#include "pbd/shortpath.h"
+#include "pbd/enumwriter.h"
 
 #include <glibmm/miscutils.h>
 #include <glibmm/fileutils.h>
 #include <glibmm/thread.h>
 
-#include <ardour/file_source.h>
-#include <ardour/session.h>
-#include <ardour/session_directory.h>
-#include <ardour/source_factory.h>
-#include <ardour/filename_extensions.h>
+#include "ardour/file_source.h"
+#include "ardour/directory_names.h"
+#include "ardour/session.h"
+#include "ardour/session_directory.h"
+#include "ardour/source_factory.h"
+#include "ardour/filename_extensions.h"
 
 #include "i18n.h"
 
+using namespace std;
 using namespace ARDOUR;
 using namespace PBD;
 using namespace Glib;
 
-static const std::string PATH_SEP = "/"; // I don't do windows
-
 map<DataType, ustring> FileSource::search_paths;
 
-FileSource::FileSource (Session& session, DataType type,
-               const ustring& path, bool embedded, Source::Flag flag)
+FileSource::FileSource (Session& session, DataType type, const ustring& path, Source::Flag flag)
        : Source(session, type, path, flag)
        , _path(path)
        , _file_is_new(true)
        , _channel (0)
-       , _is_embedded(embedded)
 {
+       set_within_session_from_path (path);
 }
 
-FileSource::FileSource (Session& session, const XMLNode& node, bool must_exist)
+FileSource::FileSource (Session& session, const XMLNode& node, bool /*must_exist*/)
        : Source(session, node)
-       , _file_is_new(false)
+       , _file_is_new (false)
 {
+       /* this setting of _path is temporary - we expect derived classes
+          to call ::init() which will actually locate the file
+          and reset _path and _within_session correctly.
+       */
+
        _path = _name;
-       _is_embedded = (_path.find(PATH_SEP) != string::npos);
+       _within_session = true;
 }
 
 bool
 FileSource::removable () const
 {
-       return (_flags & Removable)
-               && (   (_flags & RemoveAtDestroy)
-                       || ((_flags & RemovableIfEmpty) && length(timeline_position()) == 0));
+        bool r = (_path.find (stub_dir_name) != string::npos) ||
+                ((_flags & Removable)
+                 && ((_flags & RemoveAtDestroy) || 
+                     ((_flags & RemovableIfEmpty) && empty() == 0)));
+
+        cerr << "is " << _path << " removable ? " << r << endl;
+
+        return r;
 }
 
 int
@@ -85,19 +94,25 @@ FileSource::init (const ustring& pathstr, bool must_exist)
 {
        _timeline_position = 0;
 
-       if (!find (_type, pathstr, must_exist, _file_is_new, _channel)) {
+       if (!find (_type, pathstr, must_exist, _file_is_new, _channel, _path)) {
                throw MissingSource ();
        }
 
+       set_within_session_from_path (pathstr);
+
+       if (_within_session) {
+               _name = Glib::path_get_basename (_name);
+       }
+
        if (_file_is_new && must_exist) {
                return -1;
        }
-       
+
        return 0;
 }
 
 int
-FileSource::set_state (const XMLNode& node)
+FileSource::set_state (const XMLNode& node, int /*version*/)
 {
        const XMLProperty* prop;
 
@@ -107,8 +122,6 @@ FileSource::set_state (const XMLNode& node)
                _channel = 0;
        }
 
-       _is_embedded = (_name.find(PATH_SEP) == string::npos);
-
        return 0;
 }
 
@@ -123,28 +136,24 @@ FileSource::mark_take (const ustring& id)
 int
 FileSource::move_to_trash (const ustring& trash_dir_name)
 {
-       if (is_embedded()) {
-               cerr << "tried to move an embedded region to trash" << endl;
-               return -1;
-       }
-
-       if (!writable()) {
+       if (!within_session() || !writable()) {
                return -1;
        }
 
        /* don't move the file across filesystems, just stick it in the
           trash_dir_name directory on whichever filesystem it was already on
        */
-       
-       ustring newpath;
-       newpath = Glib::path_get_dirname (_path);
-       newpath = Glib::path_get_dirname (newpath); 
 
-       newpath += string(PATH_SEP) + trash_dir_name + PATH_SEP;
-       newpath += Glib::path_get_basename (_path);
+        vector<string> v;
+       v.push_back (Glib::path_get_dirname (Glib::path_get_dirname (_path)));
+        v.push_back (trash_dir_name);
+       v.push_back (Glib::path_get_basename (_path));
+
+       string newpath = Glib::build_filename (v);
 
        /* the new path already exists, try versioning */
-       if (access (newpath.c_str(), F_OK) == 0) {
+
+       if (Glib::file_test (newpath.c_str(), Glib::FILE_TEST_EXISTS)) {
                char buf[PATH_MAX+1];
                int version = 1;
                ustring newpath_v;
@@ -156,7 +165,7 @@ FileSource::move_to_trash (const ustring& trash_dir_name)
                        snprintf (buf, sizeof (buf), "%s.%d", newpath.c_str(), ++version);
                        newpath_v = buf;
                }
-               
+
                if (version == 999) {
                        PBD::error << string_compose (
                                        _("there are already 1000 files with names like %1; versioning discontinued"),
@@ -178,24 +187,25 @@ FileSource::move_to_trash (const ustring& trash_dir_name)
                rename (newpath.c_str(), _path.c_str());
                return -1;
        }
-           
+
        _path = newpath;
-       
+
        /* file can not be removed twice, since the operation is not idempotent */
        _flags = Flag (_flags & ~(RemoveAtDestroy|Removable|RemovableIfEmpty));
 
        return 0;
 }
 
-/** Find the actual source file based on \a path.
- * 
- * If the source is embedded, \a path should be a filename (no slashes).
- * If the source is external, \a path should be a full path.
- * In either case, _path is set to the complete absolute path of the source file.
+/** Find the actual source file based on \a filename.
+ *
+ * If the source is within the session tree, \a filename should be a simple filename (no slashes).
+ * If the source is external, \a filename should be a full path.
+ * In either case, found_path is set to the complete absolute path of the source file.
  * \return true iff the file was found.
  */
 bool
-FileSource::find (DataType type, const ustring& path, bool must_exist, bool& isnew, uint16_t& chan)
+FileSource::find (DataType type, const ustring& path, bool must_exist,
+                 bool& isnew, uint16_t& chan, ustring& found_path)
 {
        Glib::ustring search_path = search_paths[type];
 
@@ -222,7 +232,7 @@ FileSource::find (DataType type, const ustring& path, bool must_exist, bool& isn
                split (search_path, dirs, ':');
 
                cnt = 0;
-               
+
                for (vector<ustring>::iterator i = dirs.begin(); i != dirs.end(); ++i) {
                        fullpath = *i;
                        if (fullpath[fullpath.length()-1] != '/') {
@@ -234,24 +244,24 @@ FileSource::find (DataType type, const ustring& path, bool must_exist, bool& isn
                        /* i (paul) made a nasty design error by using ':' as a special character in
                           Ardour 0.99 .. this hack tries to make things sort of work.
                        */
-                       
+
                        if ((pos = pathstr.find_last_of (':')) != ustring::npos) {
-                               
+
                                if (Glib::file_test (fullpath, Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_REGULAR)) {
 
                                        /* its a real file, no problem */
-                                       
+
                                        keeppath = fullpath;
                                        ++cnt;
 
                                } else {
-                                       
+
                                        if (must_exist) {
-                                               
+
                                                /* might be an older session using file:channel syntax. see if the version
                                                   without the :suffix exists
                                                 */
-                                               
+
                                                ustring shorter = pathstr.substr (0, pos);
                                                fullpath = *i;
 
@@ -266,12 +276,12 @@ FileSource::find (DataType type, const ustring& path, bool must_exist, bool& isn
                                                        pathstr = shorter;
                                                        keeppath = fullpath;
                                                        ++cnt;
-                                               } 
-                                               
+                                               }
+
                                        } else {
-                                               
+
                                                /* new derived file (e.g. for timefx) being created in a newer session */
-                                               
+
                                        }
                                }
 
@@ -280,7 +290,7 @@ FileSource::find (DataType type, const ustring& path, bool must_exist, bool& isn
                                if (Glib::file_test (fullpath, Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_REGULAR)) {
                                        keeppath = fullpath;
                                        ++cnt;
-                               } 
+                               }
                        }
                }
 
@@ -313,18 +323,18 @@ FileSource::find (DataType type, const ustring& path, bool must_exist, bool& isn
                        }
                }
 
-               _path = keeppath;
-               
+               found_path = keeppath;
+
                ret = true;
 
        } else {
-               
+
                /* external files and/or very very old style sessions include full paths */
 
                /* ugh, handle ':' situation */
 
                if ((pos = pathstr.find_last_of (':')) != ustring::npos) {
-                       
+
                        ustring shorter = pathstr.substr (0, pos);
 
                        if (Glib::file_test (shorter, Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_REGULAR)) {
@@ -332,42 +342,38 @@ FileSource::find (DataType type, const ustring& path, bool must_exist, bool& isn
                                pathstr = shorter;
                        }
                }
-               
-               _path = pathstr;
+
+               found_path = pathstr;
 
                if (!Glib::file_test (pathstr, Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_REGULAR)) {
 
                        /* file does not exist or we cannot read it */
-                       
+
                        if (must_exist) {
                                error << string_compose(
                                                _("Filesource: cannot find required file (%1): %2"),
-                                               _path, strerror (errno)) << endmsg;
+                                               path, strerror (errno)) << endmsg;
                                goto out;
                        }
-                       
+
                        if (errno != ENOENT) {
                                error << string_compose(
                                                _("Filesource: cannot check for existing file (%1): %2"),
-                                               _path, strerror (errno)) << endmsg;
+                                               path, strerror (errno)) << endmsg;
                                goto out;
                        }
-                       
+
                        /* a new file */
                        isnew = true;
                        ret = true;
 
                } else {
-                       
+
                        /* already exists */
                        ret = true;
                }
        }
-       
-       if (_is_embedded) {
-               _name = Glib::path_get_basename (_name);
-       }
-       
+
 out:
        return ret;
 }
@@ -377,23 +383,23 @@ FileSource::set_source_name (const ustring& newname, bool destructive)
 {
        Glib::Mutex::Lock lm (_lock);
        ustring oldpath = _path;
-       ustring newpath = Session::change_source_path_by_name (oldpath, _name, newname, destructive);
-       
+       ustring newpath = _session.change_source_path_by_name (oldpath, _name, newname, destructive);
+
        if (newpath.empty()) {
                error << string_compose (_("programming error: %1"), "cannot generate a changed file path") << endmsg;
                return -1;
        }
 
-       // Test whether newpath exists, if yes notify the user but continue. 
-       if (access(newpath.c_str(),F_OK) == 0) {
-               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;
-               return -1;
-       }
-
-       if (rename (oldpath.c_str(), newpath.c_str()) != 0) {
-               error << string_compose (_("cannot rename audio file %1 to %2"), _name, newpath) << endmsg;
+       // Test whether newpath exists, if yes notify the user but continue.
+       if (Glib::file_test (newpath, Glib::FILE_TEST_EXISTS)) {
+               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;
                return -1;
        }
+        
+        if (::rename (oldpath.c_str(), newpath.c_str()) != 0) {
+                error << string_compose (_("cannot rename file %1 to %2 (%3)"), oldpath, newpath, strerror(errno)) << endmsg;
+                return -1;
+        }
 
        _name = Glib::path_get_basename (newpath);
        _path = newpath;
@@ -416,3 +422,53 @@ FileSource::mark_immutable ()
        }
 }
 
+void
+FileSource::mark_nonremovable ()
+{
+        _flags = Flag (_flags & ~(Removable|RemovableIfEmpty|RemoveAtDestroy));
+}
+
+void
+FileSource::set_within_session_from_path (const std::string& path)
+{
+       _within_session = _session.path_is_within_session (path);
+}
+
+int
+FileSource::unstubify ()
+{
+        string::size_type pos = _path.find (stub_dir_name);
+
+        if (pos == string::npos || (_flags & Destructive)) {
+                return 0;
+        }
+
+        vector<string> v;
+
+        v.push_back (Glib::path_get_dirname (Glib::path_get_dirname (_path)));
+       v.push_back (Glib::path_get_basename(_path));
+        
+        string newpath = Glib::build_filename (v);
+
+        if (::rename (_path.c_str(), newpath.c_str()) != 0) {
+                error << string_compose (_("rename from %1 to %2 failed: %3)"), _path, newpath, strerror (errno)) << endmsg;
+                return -1;
+        }
+
+        set_path (newpath);
+
+        return 0;
+}
+
+void
+FileSource::set_path (const std::string& newpath)
+{
+        _path = newpath;
+}
+
+void 
+FileSource::inc_use_count ()
+{
+        Source::inc_use_count ();
+}