]> git.donarmstrong.com Git - lilypond.git/blob - lily/relocate.cc
Merge branch 'master' of git+ssh://jneem@git.sv.gnu.org/srv/git/lilypond into jneeman
[lilypond.git] / lily / relocate.cc
1 /*
2   relocate.cc -- implement relocation based on argv0
3
4   source file of the GNU LilyPond music typesetter
5
6   (c) 2005--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
7
8 */
9
10 #include "relocate.hh"
11
12 #include "config.hh"
13
14
15 /* TODO: autoconf support */
16
17 #include <sys/types.h>
18 #include <dirent.h>
19
20 #if HAVE_GETTEXT
21 #include <libintl.h>
22 #endif
23
24 #include "file-name.hh"
25 #include "file-path.hh"
26 #include "international.hh"
27 #include "lily-guile.hh"
28 #include "lily-version.hh"
29 #include "main.hh"
30 #include "version.hh"
31 #include "warn.hh"
32
33 #define FRAMEWORKDIR ".."
34
35 int
36 sane_putenv (char const *key, string value, bool overwrite)
37 {
38   if (overwrite || !getenv (key))
39     {
40       string combine = string (key) + "=" + value;
41       char *s = strdup (combine.c_str ());
42
43       if (be_verbose_global)
44         progress_indication (_f ("Setting %s to %s" , key, value.c_str ())
45                              + "\n");
46                              
47       int retval =  putenv (s);
48       /*
49         unfortunately, we can't portably free S here,
50         due to various bugs in glibc prior to 2.1.1
51       */ 
52       return retval;
53     }
54   
55   return -1;
56 }
57
58 static int
59 set_env_file (char const *key, string value, bool overwrite = false)
60 {
61   if (is_file (value))
62     return sane_putenv (key, value, overwrite);
63   else if (be_verbose_global)
64     warning (_f ("no such file: %s for %s", value, key));
65   return -1;
66 }
67
68 static int
69 set_env_dir (char const *key, string value)
70 {
71   if (is_dir (value))
72     return sane_putenv (key, value, false);
73   else if (be_verbose_global)
74     warning (_f ("no such directory: %s for %s", value, key));
75   return -1;
76 }
77
78 static int
79 prepend_env_path (char const *key, string value)
80 {
81   if (is_dir (value))
82     {
83       if (be_verbose_global)
84         progress_indication (_f ("%s=%s (prepend)\n", key, value.c_str ())); 
85
86       if (char const *cur = getenv (key))
87         value += to_string (PATHSEP) + cur;
88
89       return sane_putenv (key, value.c_str (), true);
90     }
91   else if (be_verbose_global)
92     warning (_f ("no such directory: %s for %s", value, key));
93   return -1;
94 }
95
96 #ifdef __MINGW32__
97 #include <winbase.h>
98 #endif
99
100 static void
101 prefix_relocation (string prefix)
102 {
103   string bindir = prefix + "/bin";
104   string datadir = prefix + "/share";
105   string localedir = datadir + "/locale";
106   string package_datadir = datadir + "/lilypond/";
107   string old_lilypond_datadir = lilypond_datadir;
108
109   if (is_dir (package_datadir + "/" + TOPLEVEL_VERSION))
110     lilypond_datadir = package_datadir + "/" + TOPLEVEL_VERSION;
111   else if (is_dir (package_datadir + "/current"))
112     lilypond_datadir = package_datadir + "/current";
113   else
114     warning (_f ("not relocating, no %s/ or current/ found under %s",
115                  TOPLEVEL_VERSION, package_datadir.c_str ()));
116   
117 #if HAVE_GETTEXT
118   if (is_dir (localedir))
119     bindtextdomain ("lilypond", localedir.c_str ());
120 #endif
121
122   prepend_env_path ("PATH", bindir);
123
124   if (be_verbose_global)
125     warning (_f ("Relocation: compile datadir=%s, new datadir=%s",
126                  old_lilypond_datadir.c_str (),
127                  lilypond_datadir.c_str ()));
128 }
129
130 /*
131   UGH : this is a complete mess.
132 */
133
134 static void
135 framework_relocation (string prefix)
136 {
137   if (be_verbose_global)
138     warning (_f ("Relocation: framework_prefix=%s", prefix));
139
140   sane_putenv ("INSTALLER_PREFIX", prefix, true);
141                
142   read_relocation_dir (prefix + "/etc/relocate/");
143
144   string bindir = prefix + "/bin";
145   
146   prepend_env_path ("PATH", bindir);
147 }
148
149 /*
150   UGH : this is a complete mess.
151 */
152 void
153 setup_paths (char const *argv0_ptr)
154 {
155   File_name argv0_filename (argv0_ptr);
156   
157   if (relocate_binary)
158     {
159       string prefix_directory;
160       if (getenv ("LILYPOND_RELOCATE_PREFIX"))
161         {
162           prefix_directory = getenv ("LILYPOND_RELOCATE_PREFIX");
163 #ifdef __MINGW32__
164           /* Normalize file name.  */
165           prefix_directory = File_name (prefix_directory).to_string ();
166 #endif /* __MINGW32__ */
167       
168           prefix_relocation (prefix_directory);
169           string bindir = prefix_directory + "/bin";
170           framework_relocation (bindir);
171         }
172       else if (relocate_binary)
173         {
174           string argv0_abs;
175           if (argv0_filename.is_absolute ())
176             {
177               argv0_abs = argv0_filename.to_string ();
178               if (be_verbose_global)
179                 warning (_f ("Relocation: is absolute: argv0=%s", argv0_ptr));
180             }
181           else if (argv0_filename.dir_.length ())
182             {
183               argv0_abs = get_working_directory ()
184                 + "/" + string (argv0_filename.to_string ());
185               if (be_verbose_global)
186                 warning (_f ("Relocation: from cwd: argv0=%s", argv0_ptr));
187             }
188           else
189             {
190               /* Find absolute ARGV0 name, using PATH.  */
191               File_path path;
192               path.parse_path (getenv ("PATH"));
193
194               if (be_verbose_global)
195                 warning (_f ("Relocation: from PATH=%s\nargv0=%s",
196                              path.to_string ().c_str (), argv0_ptr));
197
198 #ifndef __MINGW32__
199               argv0_abs = path.find (argv0_filename.to_string ());
200 #else /* __MINGW32__ */
201               char const *ext[] = {"exe", "", 0 };
202               argv0_abs = path.find (argv0_filename.to_string (), ext);
203 #endif /* __MINGW32__ */
204
205               if (argv0_abs.empty ())
206                 programming_error ("cannot find absolute argv0");
207             }
208
209           string bindir = dir_name (argv0_abs);
210           string argv0_prefix = dir_name (bindir);
211           string compile_prefix = dir_name (dir_name (dir_name (lilypond_datadir)));
212           if (argv0_prefix != compile_prefix)
213             {
214               prefix_relocation (argv0_prefix);
215               prefix_directory = argv0_prefix;
216             }
217           if (argv0_prefix != compile_prefix || string (FRAMEWORKDIR) != "..")
218             {
219               framework_relocation (bindir + "/" + FRAMEWORKDIR);
220               prefix_directory = bindir + "/" + FRAMEWORKDIR;
221             }
222         }
223
224       lilypond_datadir = prefix_directory
225         + "/share/lilypond/" TOPLEVEL_VERSION;
226     }
227
228   if (getenv ("LILYPONDPREFIX"))
229     error (_ ("LILYPONDPREFIX is obsolete, use LILYPOND_DATADIR"));
230
231   if (char const *env = getenv ("LILYPOND_DATADIR"))
232     {
233 #ifdef __MINGW32__
234       /* Normalize file name.  */
235       lilypond_datadir = File_name (env).to_string ();
236 #else
237       lilypond_datadir = env;
238 #endif
239     }
240
241   /* When running from build dir, a full LILYPOND_DATADIR is set-up at
242      $(OUTBASE)/{share, lib}/lilypond/current.  Configure lily using
243      ./configure --prefix=$(pwd)/out */
244   string build_datadir_current = dir_name (lilypond_datadir) + "/current";
245   if (!is_dir (lilypond_datadir.c_str ())
246       && is_dir (build_datadir_current.c_str ()))
247     lilypond_datadir = build_datadir_current;
248   
249   global_path.append ("");
250
251   /* Adding mf/out make lilypond unchanged source directory, when setting
252      LILYPONDPREFIX to lilypond-x.y.z */
253   char const *suffixes[] = {"ly", "ps", "scm", 0 };
254   
255   vector<string> dirs;
256   for (char const **s = suffixes; *s; s++)
257     {
258       string path = lilypond_datadir + to_string ('/') + string (*s);
259       dirs.push_back (path);
260     }
261   
262   dirs.push_back (lilypond_datadir + "/fonts/otf/");
263   dirs.push_back (lilypond_datadir + "/fonts/type1/");
264   dirs.push_back (lilypond_datadir + "/fonts/svg/");
265   
266   for (vsize i = 0; i < dirs.size (); i++)
267     global_path.prepend (dirs[i]);
268 }
269
270 string
271 expand_environment_variables (string orig)
272 {
273   const char *start_ptr = orig.c_str ();
274   const char *ptr = orig.c_str ();
275   size_t len = orig.length ();
276
277   string out;
278   while (ptr < start_ptr + len)
279     {
280       char *dollar = strchr (ptr, '$');
281       
282       if (dollar != NULL)
283         {
284           char *start_var = dollar + 1;
285           char *end_var = start_var;
286           char *start_next = end_var;
287           
288           out += string (ptr, dollar - ptr);
289           ptr = dollar;
290
291           if (*start_var == '{')
292             {
293               start_var ++;
294               
295               end_var = strchr (start_var, '}');
296               
297               if (end_var == NULL)
298                 {
299                   end_var = start_var + len;
300                   start_next = end_var;
301                 }
302               else
303                 {
304                   start_next = end_var + 1; 
305                 }
306             }
307           else 
308             {
309               /*
310                 Hmm. what to do for $1 , $~ etc.?
311               */
312               do
313                 {
314                   end_var ++;
315                 }
316               while (isalnum (*end_var) || *end_var == '_');
317               start_next = end_var;
318             }
319
320           if (start_var < end_var)
321             {
322               string var_name (start_var, end_var - start_var);
323               const char *value = getenv (var_name.c_str ());
324               if (value != NULL)
325                 out += string (value);
326
327               ptr = start_next;
328             }
329         }
330       else
331         break;
332
333     }
334
335   out += ptr;
336
337   return out;
338 }
339
340
341 static string
342 read_line (FILE *f)
343 {
344   string out;
345   
346   int c = 0;
347   while ((c = fgetc (f)) != EOF && c != '\n')
348     out += c;
349
350   return out;
351 }
352
353 void
354 read_relocation_file (string filename)
355 {
356   if (be_verbose_global)
357     progress_indication (_f ("Relocation file: %s", filename.c_str ())
358                          + "\n");
359       
360   char const *cname = filename.c_str ();
361   FILE *f = fopen (cname, "r");
362   if (!f)
363     error (_f ("cannot open file: `%s'", cname));
364
365   while (!feof (f))
366     {
367       string line = read_line (f);
368       size_t idx = line.find (' ');
369       if (idx == NPOS)
370         continue;
371       
372       string command = line.substr (0, idx);
373       line = line.substr (idx + 1);
374       
375       if (idx == NPOS)
376         continue;
377       idx = line.find ('=');
378
379       string variable = line.substr (0, idx);
380       string value = line.substr (idx + 1);
381
382       value = expand_environment_variables (value);
383
384       if (command == "set")
385         sane_putenv (variable.c_str (), value, true);
386       else if (command == "setdir")
387         set_env_dir (variable.c_str (), value);
388       else if (command == "setfile")
389         set_env_file (variable.c_str (), value);
390       else if (command == "prependdir")
391         prepend_env_path (variable.c_str (), value);
392       else
393         error (_f ("Unknown relocation command %s", command));
394     }
395
396   fclose (f);
397 }
398
399 void
400 read_relocation_dir (string dirname)
401 {
402   if (DIR *dir = opendir (dirname.c_str ()))
403     while (struct dirent *ent = readdir (dir))
404       {
405         File_name name (ent->d_name);
406         if (name.ext_ == "reloc")
407           read_relocation_file (dirname + "/" + name.to_string ());
408       }
409 }