merge (w/fix) with master
[ardour.git] / libs / ardour / file_source.cc
index 7eac1a23ea2a10fa52845b109ad99536154f6aa2..e06b3d624ef09adadc3b7f3131be8074d9fbe4bf 100644 (file)
 
 #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/file_utils.h"
 
 #include <glibmm/miscutils.h>
 #include <glibmm/fileutils.h>
-#include <glibmm/thread.h>
+#include <glibmm/threads.h>
 
+#include "ardour/data_type.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 "ardour/source.h"
+#include "ardour/utils.h"
 
 #include "i18n.h"
 
@@ -52,19 +51,23 @@ using namespace ARDOUR;
 using namespace PBD;
 using namespace Glib;
 
-PBD::Signal3<int,std::string,std::string,std::vector<std::string> > FileSource::AmbiguousFileName;
+PBD::Signal2<int,std::string,std::vector<std::string> > FileSource::AmbiguousFileName;
 
-FileSource::FileSource (Session& session, DataType type, const string& path, Source::Flag flag)
+FileSource::FileSource (Session& session, DataType type, const string& path, const string& origin, Source::Flag flag)
        : Source(session, type, path, flag)
-       , _path(path)
-       , _file_is_new(true)
+       , _path (path)
+       , _file_is_new (!origin.empty()) // origin empty => new file VS. origin !empty => new file
        , _channel (0)
+        , _origin (origin)
+        , _open (false)
 {
        set_within_session_from_path (path);
+
+        prevent_deletion ();
 }
 
 FileSource::FileSource (Session& session, const XMLNode& node, bool /*must_exist*/)
-       : Source(session, node)
+       : Source (session, node)
        , _file_is_new (false)
 {
        /* this setting of _path is temporary - we expect derived classes
@@ -74,15 +77,31 @@ FileSource::FileSource (Session& session, const XMLNode& node, bool /*must_exist
 
        _path = _name;
        _within_session = true;
+
+        prevent_deletion ();
+}
+
+void
+FileSource::prevent_deletion ()
+{
+        /* if this file already exists, it cannot be removed, ever
+         */
+
+        if (Glib::file_test (_path, Glib::FILE_TEST_EXISTS)) {
+                if (!(_flags & Destructive)) {
+                        mark_immutable ();
+                } else {
+                        _flags = Flag (_flags & ~(Removable|RemovableIfEmpty|RemoveAtDestroy));
+                }
+        }
 }
 
 bool
 FileSource::removable () const
 {
-        bool r = (_path.find (stub_dir_name) != string::npos) ||
-                ((_flags & Removable)
-                 && ((_flags & RemoveAtDestroy) || 
-                     ((_flags & RemovableIfEmpty) && empty() == 0)));
+        bool r = ((_flags & Removable)
+                  && ((_flags & RemoveAtDestroy) ||
+                      ((_flags & RemovableIfEmpty) && empty() == 0)));
 
         return r;
 }
@@ -92,26 +111,24 @@ FileSource::init (const string& pathstr, bool must_exist)
 {
        _timeline_position = 0;
 
-        if (Stateful::loading_state_version < 3000) {
-                if (!find_2X (_session, _type, pathstr, must_exist, _file_is_new, _channel, _path)) {
-                        throw MissingSource (pathstr, _type);
-                }
-        } else {
-                if (!find (_session, _type, pathstr, must_exist, _file_is_new, _channel, _path)) {
-                        throw MissingSource (pathstr, _type);
-                }
-        }
-
-       set_within_session_from_path (pathstr);
+       if (Stateful::loading_state_version < 3000) {
+               if (!find_2X (_session, _type, pathstr, must_exist, _file_is_new, _channel, _path)) {
+                       throw MissingSource (pathstr, _type);
+               }
+       } else {
+               if (!find (_session, _type, pathstr, must_exist, _file_is_new, _channel, _path)) {
+                       throw MissingSource (pathstr, _type);
+               }
+       }
 
-        if (!within_session()) {
-                _session.ensure_search_path_includes (Glib::path_get_dirname (pathstr), _type);
-        }
+       set_within_session_from_path (_path);
 
-        _name = Glib::path_get_basename (pathstr);
+        _name = Glib::path_get_basename (_path);
 
-       if (_file_is_new && must_exist) {
-               return -1;
+       if (must_exist) {
+               if (!Glib::file_test (_path, Glib::FILE_TEST_EXISTS)) {
+                       throw MissingSource (pathstr, _type);
+               }
        }
 
        return 0;
@@ -128,6 +145,10 @@ FileSource::set_state (const XMLNode& node, int /*version*/)
                _channel = 0;
        }
 
+        if ((prop = node.property (X_("origin"))) != 0) {
+                _origin = prop->value();
+        }
+
        return 0;
 }
 
@@ -167,7 +188,7 @@ FileSource::move_to_trash (const string& trash_dir_name)
                snprintf (buf, sizeof (buf), "%s.%d", newpath.c_str(), version);
                newpath_v = buf;
 
-               while (access (newpath_v.c_str(), F_OK) == 0 && version < 999) {
+               while (Glib::file_test (newpath_v, Glib::FILE_TEST_EXISTS) && version < 999) {
                        snprintf (buf, sizeof (buf), "%s.%d", newpath.c_str(), ++version);
                        newpath_v = buf;
                }
@@ -211,69 +232,98 @@ FileSource::move_to_trash (const string& trash_dir_name)
  */
 bool
 FileSource::find (Session& s, DataType type, const string& path, bool must_exist,
-                 bool& isnew, uint16_t& chan, string& found_path)
+                 bool& isnew, uint16_t& /* chan */, string& found_path)
 {
        bool ret = false;
         string keeppath;
 
        isnew = false;
-        
+
         if (!Glib::path_is_absolute (path)) {
-                vector<string> dirs;
                 vector<string> hits;
-                int cnt;
                 string fullpath;
+               std::vector<std::string> dirs = s.source_search_path (type);
 
-                string search_path = s.source_search_path (type);
-
-                if (search_path.length() == 0) {
+                if (dirs.size() == 0) {
                         error << _("FileSource: search path not set") << endmsg;
                         goto out;
                 }
 
-                split (search_path, dirs, ':');
-                
-                cnt = 0;
                 hits.clear ();
-                
+
                 for (vector<string>::iterator i = dirs.begin(); i != dirs.end(); ++i) {
-                        
+
                         fullpath = Glib::build_filename (*i, path);
-                        
+
                         if (Glib::file_test (fullpath, Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_REGULAR)) {
                                 keeppath = fullpath;
                                 hits.push_back (fullpath);
-                                ++cnt;
                         }
                 }
-                
-                if (cnt > 1) {
-                        
-                        int which = FileSource::AmbiguousFileName (path, search_path, hits).get_value_or (-1);
-                        
+
+               /* Remove duplicate inodes from the list of ambiguous files, since if there are symlinks
+                  in the session path it is possible to arrive at the same file via more than one path.
+
+                  I suppose this is not necessary on Windows.
+               */
+
+               vector<string> de_duped_hits;
+
+               for (vector<string>::iterator i = hits.begin(); i != hits.end(); ++i) {
+
+                       vector<string>::iterator j = i;
+                       ++j;
+                       
+                       while (j != hits.end()) {
+                               if (PBD::equivalent_paths (*i, *j)) {
+                                       /* *i and *j are the same file; break out of the loop early */
+                                       break;
+                               }
+
+                               ++j;
+                       }
+
+                       if (j == hits.end ()) {
+                               de_duped_hits.push_back (*i);
+                       }
+               }
+
+                if (de_duped_hits.size() > 1) {
+
+                       /* more than one match: ask the user */
+
+                        int which = FileSource::AmbiguousFileName (path, de_duped_hits).get_value_or (-1);
+
                         if (which < 0) {
                                 goto out;
                         } else {
-                                keeppath = hits[which];
+                                keeppath = de_duped_hits[which];
                         }
-                        
-                } else if (cnt == 0) {
-                        
+
+                } else if (de_duped_hits.size() == 0) {
+
+                       /* no match: error */
+
                         if (must_exist) {
                                 error << string_compose(
-                                        _("Filesource: cannot find required file (%1): while searching %2"),
-                                        path, search_path) << endmsg;
+                                        _("Filesource: cannot find required file (%1)"), path) << endmsg;
                                 goto out;
                         } else {
                                 isnew = true;
                         }
-                }
+                } else {
+
+                       /* only one match: happy days */
+                       
+                       keeppath = de_duped_hits[0];
+               }
+                                                 
         } else {
                 keeppath = path;
         }
-        
+
         /* Current find() is unable to parse relative path names to yet non-existant
-           sources. QuickFix(tm) 
+           sources. QuickFix(tm)
         */
         if (keeppath == "") {
                 if (must_exist) {
@@ -282,11 +332,11 @@ FileSource::find (Session& s, DataType type, const string& path, bool must_exist
                         keeppath = path;
                 }
         }
-        
+
         found_path = keeppath;
-        
+
         ret = true;
-        
+
   out:
        return ret;
 }
@@ -302,8 +352,6 @@ bool
 FileSource::find_2X (Session& s, DataType type, const string& path, bool must_exist,
                      bool& isnew, uint16_t& chan, string& found_path)
 {
-       string search_path = s.source_search_path (type);
-
        string pathstr = path;
        string::size_type pos;
        bool ret = false;
@@ -314,22 +362,21 @@ FileSource::find_2X (Session& s, DataType type, const string& path, bool must_ex
 
                /* non-absolute pathname: find pathstr in search path */
 
-               vector<string> dirs;
+               vector<string> dirs = s.source_search_path (type);
+
                int cnt;
                string fullpath;
                string keeppath;
 
-               if (search_path.length() == 0) {
+               if (dirs.size() == 0) {
                        error << _("FileSource: search path not set") << endmsg;
                        goto out;
                }
 
-               split (search_path, dirs, ':');
-
                cnt = 0;
 
                for (vector<string>::iterator i = dirs.begin(); i != dirs.end(); ++i) {
-                        
+
                         fullpath = Glib::build_filename (*i, pathstr);
 
                        /* i (paul) made a nasty design error by using ':' as a special character in
@@ -382,16 +429,15 @@ FileSource::find_2X (Session& s, DataType type, const string& path, bool must_ex
                if (cnt > 1) {
 
                        error << string_compose (
-                                       _("FileSource: \"%1\" is ambigous when searching %2\n\t"),
-                                       pathstr, search_path) << endmsg;
+                                       _("FileSource: \"%1\" is ambigous when searching\n\t"), pathstr) << endmsg;
                        goto out;
 
                } else if (cnt == 0) {
 
                        if (must_exist) {
                                error << string_compose(
-                                               _("Filesource: cannot find required file (%1): while searching %2"),
-                                               pathstr, search_path) << endmsg;
+                                               _("Filesource: cannot find required file (%1): while searching")
+                                               , pathstr) << endmsg;
                                goto out;
                        } else {
                                isnew = true;
@@ -441,13 +487,14 @@ FileSource::find_2X (Session& s, DataType type, const string& path, bool must_ex
                                goto out;
                        }
 
+#ifndef PLATFORM_WINDOWS
                        if (errno != ENOENT) {
                                error << string_compose(
                                                _("Filesource: cannot check for existing file (%1): %2"),
                                                path, strerror (errno)) << endmsg;
                                goto out;
                        }
-
+#endif
                        /* a new file */
                        isnew = true;
                        ret = true;
@@ -466,7 +513,7 @@ out:
 int
 FileSource::set_source_name (const string& newname, bool destructive)
 {
-       Glib::Mutex::Lock lm (_lock);
+       Glib::Threads::Mutex::Lock lm (_lock);
        string oldpath = _path;
        string newpath = _session.change_source_path_by_name (oldpath, _name, newname, destructive);
 
@@ -480,7 +527,7 @@ FileSource::set_source_name (const string& newname, bool destructive)
                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;
@@ -501,6 +548,15 @@ FileSource::mark_immutable ()
        }
 }
 
+void
+FileSource::mark_immutable_except_write ()
+{
+       /* destructive sources stay writable, and their other flags don't change.  */
+       if (!(_flags & Destructive)) {
+               _flags = Flag (_flags & ~(Removable|RemovableIfEmpty|RemoveAtDestroy|CanRename));
+       }
+}
+
 void
 FileSource::mark_nonremovable ()
 {
@@ -513,41 +569,15 @@ 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 
+void
 FileSource::inc_use_count ()
 {
         Source::inc_use_count ();
 }
+