]> git.donarmstrong.com Git - lilypond.git/blob - lily/main.cc
clarify --safe.
[lilypond.git] / lily / main.cc
1 /*
2   main.cc -- implement main () entrypoint.
3
4   source file of the GNU LilyPond music typesetter
5
6   (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
7 */
8
9 #include "main.hh"
10
11 #include <cassert>
12 #include <clocale>
13 #include <cstring>
14 #include <cerrno>
15 using namespace std;
16
17 #include <unistd.h>
18 #include <sys/types.h>
19 #include <sys/stat.h>
20
21 #include "config.hh"
22
23 #if HAVE_GRP_H
24 #include <grp.h>
25 #endif
26 #if HAVE_PWD_H
27 #include <pwd.h>
28 #endif
29 #if HAVE_GETTEXT
30 #include <libintl.h>
31 #endif
32
33 #include "all-font-metrics.hh"
34 #include "file-name.hh"
35 #include "freetype.hh"
36 #include "getopt-long.hh"
37 #include "global-ctor.hh"
38 #include "lily-guile.hh"
39 #include "lily-version.hh"
40 #include "misc.hh"
41 #include "output-def.hh"
42 #include "string-convert.hh"
43 #include "version.hh"
44 #include "warn.hh"
45 #include "program-option.hh"
46
47 /*
48  * Global options that can be overridden through command line.
49  */
50
51 /* Names of header fields to be dumped to a separate file. */
52 Array<String> dump_header_fieldnames_global;
53
54 /* Name of initialisation file. */
55 String init_name_global;
56
57 /* Selected output backend
58    One of (gnome, ps [default], scm, svg, tex, texstr)") */
59 String output_backend_global = "ps";
60 /* Output formats to generate.  */
61 String output_format_global = "";
62
63 bool is_pango_format_global;
64 bool is_TeX_format_global;
65
66 /* Current output name. */
67 String output_name_global;
68
69 /* Run in safe mode? */
70 bool be_safe_global = false;
71
72 /* Provide URI links to the original file */
73 bool point_and_click_global = true;
74
75 /* Verbose progress indication? */
76 bool be_verbose_global = false;
77
78 /* Scheme code to execute before parsing, after .scm init.
79    This is where -e arguments are appended to.  */
80 String init_scheme_code_string;
81 String init_scheme_variables;
82
83 /* Generate preview of first system.  */
84 bool make_preview = false;
85
86 /* Generate printed output.  */
87 bool make_print = true;
88
89 /*
90  * Miscellaneous global stuff.
91  */
92 File_path global_path;
93
94 /*
95  * File globals.
96  */
97
98 static char const *AUTHORS
99 = "  Han-Wen Nienhuys <hanwen@cs.uu.nl>\n"
100   "  Jan Nieuwenhuizen <janneke@gnu.org>\n";
101
102 static char const *PROGRAM_NAME = "lilypond";
103 static char const *PROGRAM_URL = "http://lilypond.org";
104
105 static char const *NOTICE
106 = _i ("This program is free software.  It is covered by the GNU General Public\n"
107       "License and you are welcome to change it and/or distribute copies of it\n"
108       "under certain conditions.  Invoke as `%s --warranty' for more\n"
109       "information.\n");
110
111 static char const *WARRANTY
112 = _i ("    This program is free software; you can redistribute it and/or\n"
113       "modify it under the terms of the GNU General Public License version 2\n"
114       "as published by the Free Software Foundation.\n"
115       "\n"
116       "    This program is distributed in the hope that it will be useful,\n"
117       "but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
118       "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU\n"
119       "General Public License for more details.\n"
120       "\n"
121       "    You should have received a copy (refer to the file COPYING) of the\n"
122       "GNU General Public License along with this program; if not, write to\n"
123       "the Free Software Foundation, Inc., 59 Temple Place - Suite 330,\n"
124       "Boston, MA 02111-1307, USA.\n");
125
126 /* Where the init files live.  Typically:
127    LILYPOND_DATADIR = /usr/share/lilypond
128 */
129 String prefix_directory;
130
131 /* The jail specification: USER,GROUP,JAIL,DIR. */
132 String jail_spec;
133
134 /*  The option parser */
135 static Getopt_long *option_parser = 0;
136
137 /* Internationalisation kludge in two steps:
138  * use _i () to get entry in POT file
139  * call gettext () explicitely for actual "translation"  */
140
141 static Long_option_init options_static[]
142 = {
143   {_i ("BACK"), "backend", 'b', _i ("use backend BACK (gnome, ps [default],\nscm, svg, tex, texstr)")},
144
145   {_i ("SYM=VAL"), "define-default", 'd',
146    _i ("set a Scheme program option. Uses #t if VAL is not specified\n"
147        "Try -dhelp for help.")},
148
149   {_i ("EXPR"), "evaluate", 'e', _i ("evaluate scheme code")},
150   /* Bug in option parser: --output =foe is taken as an abbreviation
151      for --output-format.  */
152   {_i ("FORMATs"), "formats", 'f', _i ("dump FORMAT,...  Also as separate options:")},
153   {0, "dvi", 0, _i ("generate DVI (tex backend only)")},
154   {0, "pdf", 0, _i ("generate PDF (default)")},
155   {0, "png", 0, _i ("generate PNG")},
156   {0, "ps", 0, _i ("generate PostScript")},
157   {0, "tex", 0, _i ("generate TeX (tex backend only)")},
158   {0, "help", 'h',  _i ("print this help")},
159   {_i ("FIELD"), "header", 'H',  _i ("dump a header field to file BASENAME.FIELD")},
160   {_i ("DIR"), "include", 'I',  _i ("add DIR to search path")},
161   {_i ("FILE"), "init", 'i',  _i ("use FILE as init file")},
162   {_i ("FILE"), "output", 'o',  _i ("write output to FILE (suffix will be added)")},
163 #if HAVE_CHROOT
164   {_i ("USER,GROUP,JAIL,DIR"), "jail", 'j', _i ("chroot to JAIL, become USER:GROUP\n"
165                                                 "and cd into DIR")},
166 #endif
167   {0, "no-print", 0, _i ("do not generate printed output")},
168   {0, "preview", 'p',  _i ("generate a preview of the first system")},
169   {0, "safe-mode", 's',  _i ("disallow unsafe Scheme and PostScript operations")},
170   {0, "version", 'v',  _i ("print version number")},
171   {0, "verbose", 'V', _i ("be verbose")},
172   {0, "warranty", 'w',  _i ("show warranty and copyright")},
173   {0, 0, 0, 0}
174 };
175
176 #define LILYPOND_DATADIR PACKAGE_DATADIR "/" TOPLEVEL_VERSION
177
178 static void
179 env_var_info (FILE *out, char const *key)
180 {
181   if (char const *value = getenv (key))
182     fprintf (out, "%s=\"%s\"\n", key, value);
183 }
184
185 static void
186 dir_info (FILE *out)
187 {
188   fputs ("\n", out);
189   fprintf (out, "LILYPOND_DATADIR=\"%s\"\n", LILYPOND_DATADIR);
190   env_var_info (out, "LILYPONDPREFIX");
191   fprintf (out, "LOCALEDIR=\"%s\"\n", LOCALEDIR);
192
193   fprintf (out, "\nEffective prefix: \"%s\"\n", prefix_directory.to_str0 ());
194
195 #if ARGV0_RELOCATION
196   env_var_info (out, "FONTCONFIG_FILE");
197   env_var_info (out, "FONTCONFIG_PATH");
198   env_var_info (out, "GS_FONTPATH");
199   env_var_info (out, "GS_LIB");
200   env_var_info (out, "GUILE_LOAD_PATH");
201   env_var_info (out, "PANGO_RC_FILE");
202   env_var_info (out, "PATH");
203 #endif
204 }
205
206 static void
207 copyright ()
208 {
209   printf (_f ("Copyright (c) %s by\n%s  and others.",
210               "1996--2005",
211               AUTHORS).to_str0 ());
212   printf ("\n");
213 }
214
215 static void
216 identify (FILE *out)
217 {
218   fputs (gnu_lilypond_version_string ().to_str0 (), out);
219   fputs ("\n", out);
220 }
221
222 static void
223 notice ()
224 {
225   identify (stdout);
226   puts (_f (NOTICE, PROGRAM_NAME).to_str0 ());
227   printf ("\n");
228   copyright ();
229 }
230
231 LY_DEFINE (ly_usage, "ly:usage",
232            0, 0, 0, (),
233            "Print usage message.")
234 {
235   /* No version number or newline here.  It confuses help2man.  */
236   printf (_f ("Usage: %s [OPTION]... FILE...", PROGRAM_NAME).to_str0 ());
237   printf ("\n\n");
238   printf (_ ("Typeset music and/or produce MIDI from FILE.").to_str0 ());
239   printf ("\n\n");
240   printf (_ ("LilyPond produces beautiful music notation.").to_str0 ());
241   printf ("\n");
242   printf (_f ("For more information, see %s", PROGRAM_URL).to_str0 ());
243   printf ("\n\n");
244   printf (_ ("Options:").to_str0 ());
245   printf ("\n");
246   printf (Long_option_init::table_string (options_static).to_str0 ());
247   printf ("\n");
248   printf (_f ("Report bugs to %s.", "bug-lilypond@gnu.org").to_str0 ());
249   printf ("\n");
250   printf ("\n");
251   return SCM_UNSPECIFIED;
252 }
253
254 static void
255 warranty ()
256 {
257   identify (stdout);
258   printf ("\n");
259   copyright ();
260   printf ("\n");
261   printf (_ (WARRANTY).to_str0 ());
262 }
263
264 static int
265 sane_putenv (char const *key, String value, bool overwrite = true)
266 {
267   if (overwrite || !getenv (key))
268     {
269       String combine = String (key) + "=" + value;
270       char *s = strdup (combine.to_str0 ());
271       return putenv (s);
272     }
273   return -1;
274 }
275
276 #if ARGV0_RELOCATION
277 static int
278 set_env_file (char const *key, String value)
279 {
280   if (is_file (value))
281     return sane_putenv (key, value, false);
282   else if (be_verbose_global)
283     warning (_f ("no such file: %s", value));
284   return -1;
285 }
286
287 static int
288 prepend_env_path (char const *key, String value)
289 {
290   if (is_dir (value))
291     {
292       if (char const *cur = getenv (key))
293         value += to_string (PATHSEP) + cur;
294       return sane_putenv (key, value.to_str0 ());
295     }
296   else if (be_verbose_global)
297     warning (_f ("no such directory: %s", value));
298   return -1;
299 }
300
301 String
302 dir_name (String const file_name)
303 {
304   String s = file_name;
305   s.substitute ('\\', '/');
306   s = s.left_string (s.index_last ('/'));
307   return s;
308 }
309 #endif
310
311 #ifdef __MINGW32__
312 #include <winbase.h>
313 #endif
314
315 static void
316 setup_paths (char const *argv0)
317 {
318   prefix_directory = LILYPOND_DATADIR;
319
320 #if ARGV0_RELOCATION
321
322   if (getenv ("LILYPOND_VERBOSE"))
323     be_verbose_global = true;
324
325   String bindir = dir_name (argv0);
326   String argv0_prefix = dir_name (bindir);
327   if (argv0_prefix != dir_name (dir_name (dir_name (prefix_directory))))
328     {
329       if (be_verbose_global)
330         warning (_f ("argv0 relocation: argv0=%s, prefix=%s", argv0,
331                      prefix_directory));
332       String datadir = argv0_prefix + "/share";
333       String libdir = argv0_prefix + "/lib";
334       String localedir = datadir + "/locale";
335       String sysconfdir = argv0_prefix + "/etc";
336       String argv0_lilypond_datadir = datadir + "/lilypond/" TOPLEVEL_VERSION;
337
338       if (is_dir (argv0_lilypond_datadir))
339         prefix_directory = argv0_lilypond_datadir;
340
341 #if HAVE_GETTEXT
342       if (is_dir (localedir))
343         bindtextdomain ("lilypond", localedir.to_str0 ());
344 #endif
345
346       set_env_file ("FONTCONFIG_FILE", sysconfdir + "/fonts/fonts.conf");
347 #ifdef __MINGW32__
348       char font_dir[PATH_MAX];
349       ExpandEnvironmentStrings ("%windir%/fonts", font_dir, sizeof (font_dir));
350       prepend_env_path ("GS_FONTPATH", font_dir);
351 #endif
352
353       /* FIXME: *cough* 8.15 *cough* */
354       prepend_env_path ("GS_FONTPATH", datadir + "/ghostscript/8.15/fonts");
355       prepend_env_path ("GS_LIB", datadir + "/ghostscript/8.15/Resource");
356       prepend_env_path ("GS_LIB", datadir + "/ghostscript/8.15/lib");
357
358       prepend_env_path ("GS_FONTPATH", datadir + "/gs/fonts");
359       prepend_env_path ("GS_LIB", datadir + "/gs/Resource");
360       prepend_env_path ("GS_LIB", datadir + "/gs/lib");
361
362       prepend_env_path ("GUILE_LOAD_PATH", datadir
363                         + to_string ("/guile/%d.%d",
364                                      SCM_MAJOR_VERSION, SCM_MINOR_VERSION));
365       set_env_file ("PANGO_RC_FILE", sysconfdir + "/pango/pangorc");
366       prepend_env_path ("PATH", bindir);
367     }
368 #else
369   (void) argv0;
370 #endif /* ARGV0_RELOCATION */
371
372   /* FIXME: use LILYPOND_DATADIR.  */
373   if (char const *env = getenv ("LILYPONDPREFIX"))
374     {
375 #ifdef __MINGW32__
376       /* Normalize file name.  */
377       env = File_name (env).to_string ().get_copy_str0 ();
378 #endif
379       prefix_directory = env;
380     }
381
382   global_path.append ("");
383
384
385   /*
386     When running from build dir, a full LILYPOND_PREFIX is set-up at
387
388         $(OUTBASE)/share/lilypond/TOPLEVEL_VERSION
389
390      This historical hack will allow the shorthand
391
392         LILYPONDPREFIX=out lily/out/lilypond ...
393
394   */
395   
396   struct stat statbuf;
397   String build_prefix = prefix_directory + "/share/lilypond/" TOPLEVEL_VERSION;
398   if (stat (build_prefix.to_str0 (), &statbuf) == 0)
399     prefix_directory = build_prefix;
400
401   
402   /* Adding mf/out make lilypond unchanged source directory, when setting
403      LILYPONDPREFIX to lilypond-x.y.z */
404   char *suffixes[] = {"ly", "ps", "scm", 0 };
405
406   
407   Array<String> dirs;
408   for (char **s = suffixes; *s; s++)
409     {
410       String path = prefix_directory + to_string ('/') + String (*s);
411       dirs.push (path);
412     }
413
414
415   dirs.push (prefix_directory + "/fonts/otf/");
416   dirs.push (prefix_directory + "/fonts/type1/");
417   dirs.push (prefix_directory + "/fonts/svg/");
418   
419   for (int i = 0; i < dirs.size (); i++)
420     global_path.prepend (dirs[i]);
421 }
422
423 static void
424 prepend_load_path (String dir)
425 {
426   String s = "(set! %load-path (cons \"" + dir + "\" %load-path))";
427   scm_c_eval_string (s.to_str0 ());
428 }
429
430 void init_global_tweak_registry ();
431 void init_fontconfig ();
432
433 #if HAVE_CHROOT
434 static void
435 do_chroot_jail ()
436 {
437   /* Now we chroot, setuid/setgrp and chdir.  If something goes wrong,
438      we exit (this is a security-sensitive area).  First we split
439      jail_spec into its components, then we retrieve the user/group id
440      (necessarily *before* chroot'ing) and finally we perform the
441      actual actions.  */
442
443   enum Jail
444     {
445       USER_NAME, GROUP_NAME, JAIL, DIR, JAIL_MAX
446     };
447
448   Array<String> components = String_convert::split (jail_spec, ',');
449   if (components.size () != JAIL_MAX)
450     {
451       error (_f ("expected %d arguments with jail, found: %d", JAIL_MAX,
452                  components.size ()));
453       exit (2);
454     }
455
456   /* Hmm.  */
457   errno = 0;
458
459   int uid;
460   if (passwd * passwd = getpwnam (components[USER_NAME].to_str0 ()))
461     uid = passwd->pw_uid;
462   else
463     {
464       if (errno == 0)
465         error (_f ("no such user: %s", components[USER_NAME]));
466       else
467         error (_f ("can't get user id from user name: %s: %s",
468                    components[USER_NAME],
469                    strerror (errno)));
470       exit (3);
471     }
472
473   /* Hmm.  */
474   errno = 0;
475
476   int gid;
477   if (group * group = getgrnam (components[GROUP_NAME].to_str0 ()))
478     gid = group->gr_gid;
479   else
480     {
481       if (errno == 0)
482         error (_f ("no such group: %s", components[GROUP_NAME]));
483       else
484         error (_f ("can't get group id from group name: %s: %s",
485                    components[GROUP_NAME],
486                    strerror (errno)));
487       exit (3);
488     }
489
490   if (chroot (components[JAIL].to_str0 ()))
491     {
492       error (_f ("can't chroot to: %s: %s", components[JAIL],
493                  strerror (errno)));
494       exit (3);
495     }
496
497   if (setgid (gid))
498     {
499       error (_f ("can't change group id to: %d: %s", gid, strerror (errno)));
500       exit (3);
501     }
502
503   if (setuid (uid))
504     {
505       error (_f ("can't change user id to: %d: %s", uid, strerror (errno)));
506       exit (3);
507     }
508
509   if (chdir (components[DIR].to_str0 ()))
510     {
511       error (_f ("can't change working directory to: %s: %s", components[DIR],
512                  strerror (errno)));
513       exit (3);
514     }
515 }
516 #endif
517
518 static void
519 main_with_guile (void *, int, char **)
520 {
521   /* Engravers use lily.scm contents, need to make Guile find it.
522      Prepend onto GUILE %load-path, very ugh. */
523
524   prepend_load_path (prefix_directory);
525   prepend_load_path (prefix_directory + "/scm");
526
527   if (be_verbose_global)
528     dir_info (stderr);
529   is_TeX_format_global = (output_backend_global == "tex"
530                           || output_backend_global == "texstr");
531
532   is_pango_format_global = !is_TeX_format_global;
533
534   ly_c_init_guile ();
535   call_constructors ();
536   ly_set_option (ly_symbol2scm ("verbose"), scm_from_bool (be_verbose_global));
537
538   init_global_tweak_registry ();
539   init_fontconfig ();
540
541   init_freetype ();
542
543   all_fonts_global = new All_font_metrics (global_path.to_string ());
544
545   if (!init_scheme_variables.is_empty ()
546       || !init_scheme_code_string.is_empty ())
547     {
548       init_scheme_variables = "(map (lambda (x) (ly:set-option (car x) (cdr x))) (list "
549         + init_scheme_variables + "))";
550
551       init_scheme_code_string
552         += "(begin #t "
553         + init_scheme_variables
554         + init_scheme_code_string
555         + ")";
556
557       char const *str0 = init_scheme_code_string.to_str0 ();
558
559       if (be_verbose_global)
560         progress_indication (_f ("Evaluating %s", str0));
561       scm_c_eval_string ((char *) str0);
562     }
563
564   /* We accept multiple independent music files on the command line to
565      reduce compile time when processing lots of small files.
566      Starting the GUILE engine is very time consuming.  */
567
568   SCM files = SCM_EOL;
569   SCM *tail = &files;
570   while (char const *arg = option_parser->get_next_arg ())
571     {
572       *tail = scm_cons (scm_makfrom0str (arg), SCM_EOL);
573       tail = SCM_CDRLOC (*tail);
574     }
575   delete option_parser;
576   option_parser = 0;
577
578 #if HAVE_CHROOT
579   if (!jail_spec.is_empty ())
580     do_chroot_jail ();
581 #endif
582
583   SCM result = scm_call_1 (ly_lily_module_constant ("lilypond-main"), files);
584   (void) result;
585
586   /* Unreachable.  */
587   exit (0);
588 }
589
590 static void
591 setup_localisation ()
592 {
593 #if HAVE_GETTEXT
594   /* Enable locales */
595   setlocale (LC_ALL, "");
596
597   /* FIXME: check if this is still true.
598      Disable localisation of float values.  This breaks TeX output.  */
599   setlocale (LC_NUMERIC, "C");
600
601   String localedir = LOCALEDIR;
602   if (char const *env = getenv ("LILYPOND_LOCALEDIR"))
603     localedir = env;
604
605   bindtextdomain ("lilypond", localedir.to_str0 ());
606   textdomain ("lilypond");
607 #endif
608 }
609
610 static void
611 add_output_format (String format)
612 {
613   if (output_format_global != "")
614     output_format_global += ",";
615   output_format_global += format;
616 }
617
618 static void
619 parse_argv (int argc, char **argv)
620 {
621   bool show_help = false;
622   option_parser = new Getopt_long (argc, argv, options_static);
623   while (Long_option_init const *opt = (*option_parser) ())
624     {
625       switch (opt->shortname_char_)
626         {
627         case 0:
628           if (String (opt->longname_str0_) == "dvi"
629               || String (opt->longname_str0_) == "pdf"
630               || String (opt->longname_str0_) == "png"
631               || String (opt->longname_str0_) == "ps"
632               || String (opt->longname_str0_) == "tex")
633             add_output_format (opt->longname_str0_);
634           else if (String (opt->longname_str0_) == "preview")
635             make_preview = true;
636           else if (String (opt->longname_str0_) == "no-pages")
637             make_print = false;
638           break;
639
640         case 'd':
641           {
642             String arg (option_parser->optional_argument_str0_);
643             int eq = arg.index ('=');
644
645             String key = arg;
646             String val = "#t";
647
648             if (eq >= 0)
649               {
650                 key = arg.left_string (eq);
651                 val = arg.right_string (arg.length () - eq - 1);
652               }
653
654             init_scheme_variables
655               += "(cons \'" + key + "  " + val + ")\n";
656           }
657           break;
658
659         case 'v':
660           notice ();
661           exit (0);
662           break;
663         case 'o':
664           {
665             String s = option_parser->optional_argument_str0_;
666             File_name file_name (s);
667             output_name_global = file_name.to_string ();
668           }
669           break;
670         case 'j':
671           jail_spec = option_parser->optional_argument_str0_;
672           break;
673         case 'e':
674           init_scheme_code_string += option_parser->optional_argument_str0_;
675           break;
676         case 'w':
677           warranty ();
678           exit (0);
679           break;
680
681         case 'b':
682           output_backend_global = option_parser->optional_argument_str0_;
683           break;
684
685         case 'f':
686           output_format_global = option_parser->optional_argument_str0_;
687           break;
688
689         case 'H':
690           dump_header_fieldnames_global
691             .push (option_parser->optional_argument_str0_);
692           break;
693         case 'I':
694           global_path.append (option_parser->optional_argument_str0_);
695           break;
696         case 'i':
697           init_name_global = option_parser->optional_argument_str0_;
698           break;
699         case 'h':
700           show_help = true;
701           break;
702         case 'V':
703           be_verbose_global = true;
704           break;
705         case 's':
706           be_safe_global = true;
707           break;
708         case 'p':
709           make_preview = true;
710           break;
711         default:
712           programming_error (to_string ("unhandled short option: %c",
713                                         opt->shortname_char_));
714           assert (false);
715           break;
716         }
717     }
718
719   if (output_format_global == "")
720     output_format_global = "pdf";
721
722   if (show_help)
723     {
724       identify (stdout);
725       ly_usage ();
726       if (be_verbose_global)
727         dir_info (stdout);
728       exit (0);
729     }
730 }
731
732 void
733 setup_guile_env ()
734 {
735   char *yield = getenv ("LILYPOND_GC_YIELD");
736   bool overwrite = true;
737   if (!yield)
738     {
739       yield = "70";
740       overwrite = false;
741     }
742
743   sane_putenv ("GUILE_MIN_YIELD_1", yield, overwrite);
744   sane_putenv ("GUILE_MIN_YIELD_2", yield, overwrite);
745   sane_putenv ("GUILE_MIN_YIELD_MALLOC", yield, overwrite);
746 }
747
748 int
749 main (int argc, char **argv)
750 {
751   setup_localisation ();
752   setup_paths (argv[0]);
753   setup_guile_env ();
754   parse_argv (argc, argv);
755   if (isatty (STDIN_FILENO))
756     identify (stderr);
757
758   scm_boot_guile (argc, argv, main_with_guile, 0);
759
760   /* Only reachable if GUILE exits.  That is an error.  */
761   return 1;
762 }