2 Copyright (C) 2007 Tim Mayberry
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.
21 #include <glibmm/fileutils.h>
22 #include <glibmm/miscutils.h>
24 #include "pbd/error.h"
25 #include "pbd/compose.h"
26 #include "pbd/file_utils.h"
27 #include "pbd/openuri.h"
29 #include "ardour/directory_names.h"
30 #include "ardour/session_directory.h"
31 #include "ardour/utils.h"
38 using namespace PBD::sys;
41 /* keep a static cache because SessionDirectory is used in various places. */
42 std::map<std::string,std::string> SessionDirectory::root_cache;
44 SessionDirectory::SessionDirectory (const std::string& session_path)
45 : m_root_path(session_path)
51 SessionDirectory::operator= (const std::string& newpath)
53 m_root_path = newpath;
59 SessionDirectory::create ()
61 vector<std::string> sub_dirs = sub_directories ();
62 for (vector<std::string>::const_iterator i = sub_dirs.begin(); i != sub_dirs.end(); ++i)
64 if (g_mkdir_with_parents (i->c_str(), 0755) != 0) {
65 PBD::error << string_compose(_("Cannot create Session directory at path %1 Error: %2"), *i, g_strerror(errno)) << endmsg;
74 SessionDirectory::is_valid () const
76 if (!Glib::file_test (m_root_path, Glib::FILE_TEST_IS_DIR)) return false;
78 vector<std::string> sub_dirs = sub_directories ();
80 for (vector<std::string>::iterator i = sub_dirs.begin(); i != sub_dirs.end(); ++i) {
81 if (!Glib::file_test (*i, Glib::FILE_TEST_IS_DIR)) {
82 PBD::warning << string_compose(_("Session subdirectory does not exist at path %1"), *i) << endmsg;
90 SessionDirectory::old_sound_path () const
92 return Glib::build_filename (m_root_path, old_sound_dir_name);
96 SessionDirectory::sources_root () const
98 if (root_cache.find (m_root_path) != root_cache.end()) {
99 return root_cache[m_root_path];
104 std::string p = m_root_path;
106 // TODO ideally we'd use the session's name() here, and not the containing folder's name.
107 std::string filename = Glib::path_get_basename(p);
109 if (filename == ".") {
110 p = PBD::get_absolute_path (m_root_path);
113 const string legalized_root (legalize_for_path (Glib::path_get_basename(p)));
115 std::string sources_root_path = Glib::build_filename (m_root_path, interchange_dir_name);
117 /* check the interchange folder:
119 * 1) if a single subdir exists, use it, regardless of the name
120 * 2) if more than one dir is in interchange: abort, blame the user
121 * 3) if interchange does not exist or no subdir is present,
122 * use the session-name to create one.
124 * We use the name of the containing folder, not the actual
125 * session name. The latter would require some API changes and
126 * careful libardour updates:
128 * The session object is created with the "snapshot-name", only
129 * when loading the .ardour session file, the actual name is set.
131 * SessionDirectory is created with the session itself
132 * and picks up the wrong inital name.
134 * SessionDirectory is also used directly by the AudioRegionImporter,
135 * and the peak-file background thread (session.cc).
137 * There is no actual benefit to use the session-name instead of
138 * the folder-name. Under normal circumstances they are always
139 * identical. But it would be consistent to prefer the name.
142 Glib::Dir dir(sources_root_path);
144 std::list<std::string> entries;
146 for (Glib::DirIterator di = dir.begin(); di != dir.end(); di++) {
147 // ignore hidden files (eg. OS X ".DS_Store")
148 if ((*di).at(0) == '.') {
151 // and skip regular files (eg. Win Thumbs.db)
152 string fullpath = Glib::build_filename (sources_root_path, *di);
153 if (!Glib::file_test (fullpath, Glib::FILE_TEST_IS_DIR)) {
156 entries.push_back(*di);
159 if (entries.size() == 1) {
160 if (entries.front() != legalized_root) {
161 PBD::info << _("session-dir and session-name mismatch. Please use 'Menu > Session > Rename' in the future to rename sessions.") << endmsg;
163 root_cache[m_root_path] = Glib::build_filename (sources_root_path, entries.front());
165 else if (entries.size() > 1) {
166 PBD::open_folder (sources_root_path);
167 PBD::fatal << string_compose (_("The session's interchange dir is tainted.\nThere is more than one folder in '%1'.\nPlease remove extra subdirs to reduce possible filename ambiguties."), sources_root_path) << endmsg;
168 assert (0); // not reached
170 } catch (Glib::FileError) {
174 if (root_cache.find (m_root_path) == root_cache.end()) {
175 root_cache[m_root_path] = Glib::build_filename (sources_root_path, legalized_root);
178 return root_cache[m_root_path];
182 SessionDirectory::sources_root_2X () const
184 std::string p = m_root_path;
185 std::string filename = Glib::path_get_basename(p);
187 if (filename == ".") {
188 p = PBD::get_absolute_path (m_root_path);
191 const string legalized_root (legalize_for_path_2X (Glib::path_get_basename(p)));
193 std::string sources_root_path = Glib::build_filename (m_root_path, interchange_dir_name);
194 return Glib::build_filename (sources_root_path, legalized_root);
198 SessionDirectory::sound_path () const
200 if (Glib::file_test (old_sound_path (), Glib::FILE_TEST_IS_DIR)) return old_sound_path();
202 // the new style sound directory
203 return Glib::build_filename (sources_root(), sound_dir_name);
207 SessionDirectory::sound_path_2X () const
209 return Glib::build_filename (sources_root_2X(), sound_dir_name);
213 SessionDirectory::midi_path () const
215 return Glib::build_filename (sources_root(), midi_dir_name);
219 SessionDirectory::midi_patch_path () const
221 return Glib::build_filename (sources_root(), midi_patch_dir_name);
225 SessionDirectory::video_path () const
227 return Glib::build_filename (sources_root(), video_dir_name);
231 SessionDirectory::peak_path () const
233 return Glib::build_filename (m_root_path, peak_dir_name);
237 SessionDirectory::dead_path () const
239 return Glib::build_filename (m_root_path, dead_dir_name);
243 SessionDirectory::export_path () const
245 return Glib::build_filename (m_root_path, export_dir_name);
248 const vector<std::string>
249 SessionDirectory::sub_directories () const
251 vector<std::string> tmp_paths;
253 tmp_paths.push_back (sound_path ());
254 tmp_paths.push_back (midi_path ());
255 tmp_paths.push_back (video_path ());
256 tmp_paths.push_back (peak_path ());
257 tmp_paths.push_back (dead_path ());
258 tmp_paths.push_back (export_path ());
263 } // namespace ARDOUR