libs/ardour/filesystem_paths.cc

   1 /*
   2     Copyright (C) 2007 Tim Mayberry
   3
   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.
   8
   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.
  13
  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.
  17
  18 */
  19 #include <cstdlib>
  20 #include <iostream>
  21
  22 #include "pbd/error.h"
  23 #include "pbd/compose.h"
  24
  25 #include <glibmm/miscutils.h>
  26 #include <glibmm/fileutils.h>
  27
  28 #include "ardour/directory_names.h"
  29 #include "ardour/filesystem_paths.h"
  30
  31 #include "i18n.h"
  32
  33 #ifdef PLATFORM_WINDOWS
  34 #include "shlobj.h"
  35 #include "pbd/windows_special_dirs.h"
  36 #endif
  37
  38 using namespace PBD;
  39
  40 namespace ARDOUR {
  41
  42 using std::string;
  43
  44 std::string
  45 user_config_directory ()
  46 {
  47         static std::string p;
  48
  49         if (!p.empty()) return p;
  50
  51 #ifdef __APPLE__
  52         p = Glib::build_filename (Glib::get_home_dir(), "Library/Preferences");
  53 #else
  54         const char* c = 0;
  55
  56         /* adopt freedesktop standards, and put .ardour3 into $XDG_CONFIG_HOME or ~/.config
  57          */
  58
  59         if ((c = getenv ("XDG_CONFIG_HOME")) != 0) {
  60                 p = c;
  61         } else {
  62 #ifdef PLATFORM_WINDOWS
  63                 // Not technically the home dir (since it needs to be a writable folder)
  64                 const string home_dir = Glib::build_filename (Glib::get_user_config_dir(), user_config_dir_name);
  65 #else
  66                 const string home_dir = Glib::get_home_dir();
  67 #endif
  68                 if (home_dir.empty ()) {
  69                         error << "Unable to determine home directory" << endmsg;
  70                         exit (1);
  71                 }
  72
  73 #ifndef PLATFORM_WINDOWS
  74                 p = home_dir;
  75                 p = Glib::build_filename (p, ".config");
  76 #endif
  77         }
  78 #endif
  79
  80 #ifndef PLATFORM_WINDOWS
  81         p = Glib::build_filename (p, user_config_dir_name);
  82 #endif
  83
  84         if (!Glib::file_test (p, Glib::FILE_TEST_EXISTS)) {
  85                 if (g_mkdir_with_parents (p.c_str(), 0755)) {
  86                         error << string_compose (_("Cannot create Configuration directory %1 - cannot run"),
  87                                                    p) << endmsg;
  88                         exit (1);
  89                 }
  90         } else if (!Glib::file_test (p, Glib::FILE_TEST_IS_DIR)) {
  91                 error << string_compose (_("Configuration directory %1 already exists and is not a directory/folder - cannot run"),
  92                                            p) << endmsg;
  93                 exit (1);
  94         }
  95
  96         return p;
  97 }
  98
  99 std::string
 100 user_cache_directory ()
 101 {
 102         static std::string p;
 103
 104         if (!p.empty()) return p;
 105
 106 #ifdef __APPLE__
 107         p = Glib::build_filename (Glib::get_home_dir(), "Library/Caches");
 108 #else
 109         const char* c = 0;
 110
 111         /* adopt freedesktop standards, and put .ardour3 into $XDG_CACHE_HOME
 112          * defaulting to or ~/.config
 113          */
 114         if ((c = getenv ("XDG_CACHE_HOME")) != 0) {
 115                 p = c;
 116         } else {
 117 #ifdef PLATFORM_WINDOWS
 118                 // Not technically the home dir (since it needs to be a writable folder)
 119                 const string home_dir = Glib::build_filename (Glib::get_user_data_dir(), user_config_dir_name);
 120 #else
 121                 const string home_dir = Glib::get_home_dir();
 122 #endif
 123                 if (home_dir.empty ()) {
 124                         error << "Unable to determine home directory" << endmsg;
 125                         exit (1);
 126                 }
 127
 128                 p = home_dir;
 129                 p = Glib::build_filename (p, ".cache");
 130         }
 131 #endif
 132
 133 #ifndef PLATFORM_WINDOWS
 134         p = Glib::build_filename (p, user_config_dir_name);
 135 #endif
 136
 137         if (!Glib::file_test (p, Glib::FILE_TEST_EXISTS)) {
 138                 if (g_mkdir_with_parents (p.c_str(), 0755)) {
 139                         error << string_compose (_("Cannot create cache directory %1 - cannot run"),
 140                                                    p) << endmsg;
 141                         exit (1);
 142                 }
 143         } else if (!Glib::file_test (p, Glib::FILE_TEST_IS_DIR)) {
 144                 error << string_compose (_("Cache directory %1 already exists and is not a directory/folder - cannot run"),
 145                                            p) << endmsg;
 146                 exit (1);
 147         }
 148
 149         return p;
 150 }
 151
 152 std::string
 153 ardour_dll_directory ()
 154 {
 155 #ifdef PLATFORM_WINDOWS
 156         std::string dll_dir_path(g_win32_get_package_installation_directory_of_module(NULL));
 157         dll_dir_path = Glib::build_filename (dll_dir_path, "lib");
 158         return Glib::build_filename (dll_dir_path, "ardour3");
 159 #else
 160         std::string s = Glib::getenv("ARDOUR_DLL_PATH");
 161         if (s.empty()) {
 162                 std::cerr << _("ARDOUR_DLL_PATH not set in environment - exiting\n");
 163                 ::exit (1);
 164         }
 165         return s;
 166 #endif
 167 }
 168
 169 #ifdef PLATFORM_WINDOWS
 170 Searchpath
 171 windows_search_path ()
 172 {
 173         std::string dll_dir_path(g_win32_get_package_installation_directory_of_module(NULL));
 174         dll_dir_path = Glib::build_filename (dll_dir_path, "share");
 175         return Glib::build_filename (dll_dir_path, "ardour3");
 176 }
 177 #endif
 178
 179 Searchpath
 180 ardour_config_search_path ()
 181 {
 182         static Searchpath search_path;
 183
 184         if (search_path.empty()) {
 185                 // Start by adding the user's personal config folder
 186                 search_path += user_config_directory();
 187 #ifdef PLATFORM_WINDOWS
 188                 // On Windows, add am intermediate configuration folder
 189                 // (one that's guaranteed to be writable by all users).
 190                 const gchar* const *all_users_folder = g_get_system_config_dirs();
 191                 // Despite its slightly odd name, the above returns a single entry which
 192                 // corresponds to 'All Users' on Windows (according to the documentation)
 193
 194                 if (all_users_folder) {
 195                         std::string writable_all_users_path = all_users_folder[0];
 196                         writable_all_users_path += "\\";
 197                         writable_all_users_path += PROGRAM_NAME;
 198                         writable_all_users_path += "\\.config";
 199 #ifdef _WIN64
 200                         writable_all_users_path += "\\win64";
 201 #else
 202                         writable_all_users_path += "\\win32";
 203 #endif
 204                         search_path += writable_all_users_path;
 205                 }
 206
 207                 // now add a suitable config path from the bundle
 208                 search_path += windows_search_path ();
 209 #endif
 210                 // finally, add any paths from ARDOUR_CONFIG_PATH if it exists
 211                 std::string s = Glib::getenv("ARDOUR_CONFIG_PATH");
 212                 if (s.empty()) {
 213                         std::cerr << _("ARDOUR_CONFIG_PATH not set in environment\n");
 214                 } else {
 215                         search_path += Searchpath (s);
 216                 }
 217         }
 218
 219         return search_path;
 220 }
 221
 222 Searchpath
 223 ardour_data_search_path ()
 224 {
 225         static Searchpath search_path;
 226
 227         if (search_path.empty()) {
 228                 search_path += user_config_directory();
 229 #ifdef PLATFORM_WINDOWS
 230                 search_path += windows_search_path ();
 231 #endif
 232                 std::string s = Glib::getenv("ARDOUR_DATA_PATH");
 233                 if (s.empty()) {
 234                         std::cerr << _("ARDOUR_DATA_PATH not set in environment\n");
 235                 } else {
 236                         search_path += Searchpath (s);
 237                 }
 238         }
 239
 240         return search_path;
 241 }
 242
 243 } // namespace ARDOUR