]> git.lyx.org Git - lyx.git/blob - src/support/package.C.in
remove unused stuff
[lyx.git] / src / support / package.C.in
1 // -*- C++ -*-
2 /**
3  * \file package.C
4  * This file is part of LyX, the document processor.
5  * Licence details can be found in the file COPYING.
6  *
7  * \author Angus Leeming
8  *
9  * Full author contact details are available in file CREDITS.
10  *
11  * Warning! This file is autogenerated from package.C.in.
12  * All changes to this file will be lost.
13  */
14
15 #include <config.h>
16
17 #include "support/package.h"
18
19 #include "debug.h"
20 #include "gettext.h"
21
22 #include "support/environment.h"
23 #include "support/filetools.h"
24 #include "support/lstrings.h"
25 #include "support/os.h"
26
27 #if defined (USE_WINDOWS_PACKAGING)
28 # include "support/os_win32.h"
29 #endif
30
31 #include <boost/filesystem/operations.hpp>
32 #include <boost/tuple/tuple.hpp>
33
34 #include <list>
35 #include <utility>
36
37 #if !defined (USE_WINDOWS_PACKAGING) && \
38     !defined (USE_MACOSX_PACKAGING) && \
39     !defined (USE_POSIX_PACKAGING)
40 #error USE_FOO_PACKAGING must be defined for FOO = WINDOWS, MACOSX or POSIX.
41 #endif
42
43 #if defined (USE_MACOSX_PACKAGING)
44 # include <CoreServices/CoreServices.h> // FSFindFolder, FSRefMakePath
45 #endif
46
47 using std::string;
48
49 namespace fs = boost::filesystem;
50
51 namespace lyx {
52 namespace support {
53
54 namespace {
55
56 Package package_;
57 bool initialised_ = false;
58
59 } // namespace anon
60
61
62 void init_package(string const & command_line_arg0,
63                   string const & command_line_system_support_dir,
64                   string const & command_line_user_support_dir,
65                   exe_build_dir_to_top_build_dir top_build_dir_location)
66 {
67         // Can do so only once.
68         if (initialised_)
69                 return;
70
71         package_ = Package(command_line_arg0,
72                            command_line_system_support_dir,
73                            command_line_user_support_dir,
74                            top_build_dir_location);
75         initialised_ = true;
76 }
77
78
79 Package const & package()
80 {
81         // Commented out because package().locale_dir() can be called
82         // from the message translation code in messages.C before
83         // init_package() is called. Lars is on the case...
84         // BOOST_ASSERT(initialised_);
85         return package_;
86 }
87
88
89 namespace {
90
91 string const abs_path_from_binary_name(string const & exe);
92
93 std::pair<string, string> const
94 get_build_dirs(string const & abs_binary,
95                exe_build_dir_to_top_build_dir top_build_dir_location);
96
97 string const get_document_dir(string const & home_dir);
98
99 string const get_home_dir();
100
101 string const get_locale_dir(string const & system_support_dir);
102
103 string const get_system_support_dir(string const & abs_binary,
104                                     string const & command_line_system_support_dir);
105
106 string const get_temp_dir();
107
108 string const get_default_user_support_dir(string const & home_dir);
109
110 std::pair<string, bool> const
111 get_user_support_dir(string const & default_user_support_dir,
112                      string const & command_line_user_support_dir);
113
114
115 string const & with_version_suffix();
116
117 } // namespace anon
118
119
120 Package::Package(string const & command_line_arg0,
121                  string const & command_line_system_support_dir,
122                  string const & command_line_user_support_dir,
123                  exe_build_dir_to_top_build_dir top_build_dir_location)
124         : explicit_user_support_dir_(false)
125 {
126         home_dir_ = get_home_dir();
127         temp_dir_ = get_temp_dir();
128         document_dir_ = get_document_dir(home_dir_);
129
130         string const abs_binary = abs_path_from_binary_name(command_line_arg0);
131         binary_dir_ = onlyPath(abs_binary);
132
133         // Is LyX being run in-place from the build tree?
134         boost::tie(build_support_dir_, system_support_dir_) =
135                 get_build_dirs(abs_binary, top_build_dir_location);
136
137         if (build_support_dir_.empty())
138                 system_support_dir_ =
139                         get_system_support_dir(abs_binary,
140                                                command_line_system_support_dir);
141
142         locale_dir_ = get_locale_dir(system_support_dir_);
143
144         string const default_user_support_dir =
145                 get_default_user_support_dir(home_dir_);
146         boost::tie(user_support_dir_, explicit_user_support_dir_) =
147                 get_user_support_dir(default_user_support_dir,
148                                      command_line_user_support_dir);
149
150         string const configure_script = addName(system_support(), "configure.py");
151         configure_command_ = os::python() + ' ' + quoteName(configure_script)
152                                        + with_version_suffix();
153
154         lyxerr[Debug::INIT]
155                 << "<package>\n"
156                 << "\tbinary_dir " << binary_dir() << '\n'
157                 << "\tsystem_support " << system_support() << '\n'
158                 << "\tbuild_support " << build_support() << '\n'
159                 << "\tuser_support " << user_support() << '\n'
160                 << "\tlocale_dir " << locale_dir() << '\n'
161                 << "\tdocument_dir " << document_dir() << '\n'
162                 << "\ttemp_dir " << temp_dir() << '\n'
163                 << "\thome_dir " << home_dir() << '\n'
164                 << "</package>\n" << std::endl;
165 }
166
167
168 namespace {
169
170 // These next three functions contain the stuff that is substituted at
171 // configuration-time.
172 string const top_srcdir()
173 {
174         static string const dir("%TOP_SRCDIR%");
175         return dir;
176 }
177
178
179 string const hardcoded_localedir()
180 {
181         return string("%LOCALEDIR%");
182 }
183
184
185 string const hardcoded_system_support_dir()
186 {
187         return string("%LYX_DIR%");
188 }
189
190
191 string const & with_version_suffix()
192 {
193         static string const program_suffix("%PROGRAM_SUFFIX%");
194         static string const
195                 with_version_suffix(" --with-version-suffix=%PROGRAM_SUFFIX%");
196         return program_suffix.empty() ? program_suffix : with_version_suffix;
197 }
198
199 } // namespace anon
200
201
202 string const & Package::top_srcdir() const
203 {
204         static string const dir("%TOP_SRCDIR%");
205         return dir;
206 }
207
208
209 namespace {
210
211 bool check_command_line_dir(string const & dir,
212                             string const & file,
213                             string const & command_line_switch);
214
215 string const extract_env_var_dir(string const & env_var);
216
217 bool check_env_var_dir(string const & dir,
218                        string const & env_var);
219
220 bool check_env_var_dir(string const & dir,
221                        string const & file,
222                        string const & env_var);
223
224 string const relative_locale_dir();
225
226 string const relative_system_support_dir();
227
228
229 std::string const
230 get_build_support_dir(std::string const & binary_dir,
231                       exe_build_dir_to_top_build_dir top_build_dir_location)
232 {
233         string indirection;
234         switch (top_build_dir_location) {
235         case top_build_dir_is_one_level_up:
236                 indirection = "../lib";
237                 break;
238         case top_build_dir_is_two_levels_up:
239                 indirection = "../../lib";
240                 break;
241         }
242
243         return normalizePath(addPath(binary_dir, indirection));
244 }
245
246
247 std::pair<string, string> const
248 get_build_dirs(string const & abs_binary,
249                exe_build_dir_to_top_build_dir top_build_dir_location)
250 {
251         string const check_text = "Checking whether LyX is run in place...";
252
253         // We're looking for "Makefile" in a directory
254         //   binary_dir/../lib
255         // We're also looking for "chkconfig.ltx" in a directory
256         //   top_srcdir()/lib
257         // If both are found, then we're running LyX in-place.
258
259         // Note that the name of the lyx binary may be a symbolic link.
260         // If that is the case, then we follow the links too.
261         string binary = abs_binary;
262         while (true) {
263                 // Try and find "lyxrc.defaults".
264                 string const binary_dir = onlyPath(binary);
265                 string const build_support_dir =
266                         get_build_support_dir(binary_dir, top_build_dir_location);
267
268                 if (!fileSearch(build_support_dir, "Makefile").empty()) {
269                         // Try and find "chkconfig.ltx".
270                         string const system_support_dir =
271                                 addPath(top_srcdir(), "lib");
272
273                         if (!fileSearch(system_support_dir, "chkconfig.ltx").empty()) {
274                                 lyxerr[Debug::INIT] << check_text << " yes"
275                                                     << std::endl;
276                                 return std::make_pair(build_support_dir, system_support_dir);
277                         }
278                 }
279
280                 // Check whether binary is a symbolic link.
281                 // If so, resolve it and repeat the exercise.
282                 if (!fs::symbolic_link_exists(binary))
283                         break;
284
285                 string link;
286                 if (readLink(binary, link, true)) {
287                         binary = link;
288                 } else {
289                         // Unable to resolve the link.
290                         break;
291                 }
292         }
293
294         lyxerr[Debug::INIT] << check_text << " no" << std::endl;
295         return std::make_pair(string(), string());
296 }
297
298
299 // Specification of document_dir_ may be reset by LyXRC,
300 // but the default is fixed for a given OS.
301 string const get_document_dir(string const & home_dir)
302 {
303 #if defined (USE_WINDOWS_PACKAGING)
304         (void)home_dir; // Silence warning about unused variable.
305         os::GetFolderPath win32_folder_path;
306         return win32_folder_path(os::GetFolderPath::PERSONAL);
307 #else // Posix-like.
308         return home_dir;
309 #endif
310 }
311
312
313 // The specification of home_dir_ is fixed for a given OS.
314 // A typical example on Windows: "C:/Documents and Settings/USERNAME"
315 // and on a Posix-like machine: "/home/USERNAME".
316 string const get_home_dir()
317 {
318 #if defined (USE_WINDOWS_PACKAGING)
319         string const home_dir = getEnv("USERPROFILE");
320 #else // Posix-like.
321         string const home_dir = getEnv("HOME");
322 #endif
323
324         return os::internal_path(home_dir);
325 }
326
327
328 // Several sources are probed to ascertain the locale directory.
329 // The only requirement is that the result is indeed a directory.
330 string const get_locale_dir(string const & system_support_dir)
331 {
332         // 1. Use the "LYX_LOCALEDIR" environment variable.
333         string path = extract_env_var_dir("LYX_LOCALEDIR");
334         if (!path.empty() && check_env_var_dir(path, "LYX_LOCALEDIR"))
335                 return path;
336
337         // 2. Search for system_support_dir / <relative locale dir>
338         // The <relative locale dir> is OS-dependent. (On Unix, it will
339         // be "../locale/".)
340         path = normalizePath(addPath(system_support_dir, relative_locale_dir()));
341
342         if (fs::exists(path) && fs::is_directory(path))
343                 return path;
344
345         // 3. Fall back to the hard-coded LOCALEDIR.
346         path = hardcoded_localedir();
347         if (fs::exists(path) && fs::is_directory(path))
348                 return path;
349
350         return string();
351 }
352
353
354 // Specification of temp_dir_ may be reset by LyXRC,
355 // but the default is fixed for a given OS.
356 string const get_temp_dir()
357 {
358 #if defined (USE_WINDOWS_PACKAGING)
359         // Typical example: C:/TEMP/.
360         char path[MAX_PATH];
361         GetTempPath(MAX_PATH, path);
362         return os::internal_path(path);
363 #else // Posix-like.
364         return "/tmp";
365 #endif
366 }
367
368
369 void bail_out()
370 {
371 #ifndef CXX_GLOBAL_CSTD
372         using std::exit;
373 #endif
374         exit(1);
375 }
376
377
378 // Extracts the absolute path from the foo of "-sysdir foo" or "-userdir foo"
379 string const abs_path_from_command_line(string const & command_line)
380 {
381         if (command_line.empty())
382                 return string();
383
384         string const path = os::internal_path(command_line);
385         return os::is_absolute_path(path) ? path : makeAbsPath(path);
386 }
387
388
389 // Does the grunt work for abs_path_from_binary_name()
390 string const get_binary_path(string const & exe)
391 {
392 #if defined (USE_WINDOWS_PACKAGING)
393         // The executable may have been invoked either with or
394         // without the .exe extension.
395         // Ensure that it is present.
396         string const as_internal_path = os::internal_path(exe);
397         string const exe_path = suffixIs(as_internal_path, ".exe") ?
398                 as_internal_path : as_internal_path + ".exe";
399 #else
400         string const exe_path = os::internal_path(exe);
401 #endif
402         if (os::is_absolute_path(exe_path))
403                 return exe_path;
404
405         // Two possibilities present themselves.
406         // 1. The binary is relative to the CWD.
407         string const abs_exe_path = makeAbsPath(exe_path);
408         if (fs::exists(abs_exe_path))
409                 return abs_exe_path;
410
411         // 2. exe must be the name of the binary only and it
412         // can be found on the PATH.
413         string const exe_name = onlyFilename(exe_path);
414         if (exe_name != exe_path)
415                 return string();
416
417         std::vector<string> const path = getEnvPath("PATH");
418         std::vector<string>::const_iterator it = path.begin();
419         std::vector<string>::const_iterator const end = path.end();
420         for (; it != end; ++it) {
421                 // This will do nothing if *it is already absolute.
422                 string const exe_dir = makeAbsPath(*it);
423
424                 string const exe_path = addName(exe_dir, exe_name);
425                 if (fs::exists(exe_path))
426                         return exe_path;
427         }
428
429         // Didn't find anything.
430         return string();
431 }
432
433
434 // Extracts the absolute path to the binary name received as argv[0].
435 string const abs_path_from_binary_name(string const & exe)
436 {
437         string const abs_binary = get_binary_path(exe);
438         if (abs_binary.empty()) {
439                 // FIXME UNICODE
440                 lyxerr << lyx::to_utf8(bformat(_("Unable to determine the path to the "
441                                                  "LyX binary from the command line %1$s"),
442                                                  lyx::from_utf8(exe)))
443                        << std::endl;
444                 bail_out();
445         }
446         return abs_binary;
447 }
448
449
450 // A plethora of directories is searched to ascertain the system
451 // lyxdir which is defined as the first directory to contain
452 // "chkconfig.ltx".
453 string const
454 get_system_support_dir(string const & abs_binary,
455                   string const & command_line_system_support_dir)
456 {
457         string const chkconfig_ltx = "chkconfig.ltx";
458
459         // searched_dirs is used for diagnostic purposes only in the case
460         // that "chkconfig.ltx" is not found.
461         std::list<string> searched_dirs;
462
463         // 1. Use the -sysdir command line parameter.
464         string path = abs_path_from_command_line(command_line_system_support_dir);
465         if (!path.empty()) {
466                 searched_dirs.push_back(path);
467                 if (check_command_line_dir(path, chkconfig_ltx, "-sysdir"))
468                         return path;
469         }
470
471         // 2. Use the "LYX_DIR_14x" environment variable.
472         path = extract_env_var_dir("LYX_DIR_14x");
473         if (!path.empty()) {
474                 searched_dirs.push_back(path);
475                 if (check_env_var_dir(path, chkconfig_ltx, "LYX_DIR_14x"))
476                         return path;
477         }
478
479         // 3. Search relative to the lyx binary.
480         // We're looking for "chkconfig.ltx" in a directory
481         //   OnlyPath(abs_binary) / <relative dir> / PACKAGE /
482         // PACKAGE is hardcoded in config.h. Eg "lyx" or "lyx-1.3.6cvs".
483         // <relative dir> is OS-dependent; on Unix, it will be "../share/".
484         string const relative_lyxdir = relative_system_support_dir();
485
486         // One subtlety to be aware of. The name of the lyx binary may be
487         // a symbolic link. If that is the case, then we follow the links too.
488         string binary = abs_binary;
489         while (true) {
490                 // Try and find "chkconfig.ltx".
491                 string const binary_dir = onlyPath(binary);
492
493                 string const lyxdir =
494                         normalizePath(addPath(binary_dir, relative_lyxdir));
495                 searched_dirs.push_back(lyxdir);
496
497                 if (!fileSearch(lyxdir, chkconfig_ltx).empty()) {
498                         // Success! "chkconfig.ltx" has been found.
499                         return lyxdir;
500                 }
501
502                 // Check whether binary is a symbolic link.
503                 // If so, resolve it and repeat the exercise.
504                 if (!fs::symbolic_link_exists(binary))
505                         break;
506
507                 string link;
508                 if (readLink(binary, link, true)) {
509                         binary = link;
510                 } else {
511                         // Unable to resolve the link.
512                         break;
513                 }
514         }
515
516         // 4. Repeat the exercise on the directory itself.
517         string binary_dir = onlyPath(abs_binary);
518         while (true) {
519                 // This time test whether the directory is a symbolic link
520                 // *before* looking for "chkconfig.ltx".
521                 // (We've looked relative to the original already.)
522                 if (!fs::symbolic_link_exists(binary))
523                         break;
524
525                 string link;
526                 if (readLink(binary_dir, link, true)) {
527                         binary_dir = link;
528                 } else {
529                         // Unable to resolve the link.
530                         break;
531                 }
532
533                 // Try and find "chkconfig.ltx".
534                 string const lyxdir =
535                         normalizePath(addPath(binary_dir, relative_lyxdir));
536                 searched_dirs.push_back(lyxdir);
537
538                 if (!fileSearch(lyxdir, chkconfig_ltx).empty()) {
539                         // Success! "chkconfig.ltx" has been found.
540                         return lyxdir;
541                 }
542         }
543
544         // 5. In desparation, try the hard-coded system support dir.
545         path = hardcoded_system_support_dir();
546         if (!fileSearch(path, chkconfig_ltx).empty())
547                 return path;
548
549         // Everything has failed :-(
550         // So inform the user and exit.
551         string searched_dirs_str;
552         typedef std::list<string>::const_iterator iterator;
553         iterator const begin = searched_dirs.begin();
554         iterator const end = searched_dirs.end();
555         for (iterator it = begin; it != end; ++it) {
556                 if (it != begin)
557                         searched_dirs_str += "\n\t";
558                 searched_dirs_str += *it;
559         }
560
561         // FIXME UNICODE
562         lyxerr << lyx::to_utf8(bformat(_("Unable to determine the system directory "
563                                          "having searched\n"
564                                          "\t%1$s\n"
565                                          "Use the '-sysdir' command line parameter or "
566                                          "set the environment variable LYX_DIR_14x to "
567                                          "the LyX system directory containing the file "
568                                          "`chkconfig.ltx'."),
569                           lyx::from_utf8(searched_dirs_str)))
570                << std::endl;
571
572         bail_out();
573         // Keep the compiler happy.
574         return string();
575 }
576
577
578 // Returns the absolute path to the user lyxdir, together with a flag
579 // indicating whether this directory was specified explicitly (as -userdir
580 // or through an environment variable) or whether it was deduced.
581 std::pair<string, bool> const
582 get_user_support_dir(string const & default_user_support_dir,
583                      string const & command_line_user_support_dir)
584 {
585         bool explicit_userdir = true;
586
587         // 1. Use the -userdir command line parameter.
588         string path =
589                 abs_path_from_command_line(command_line_user_support_dir);
590         if (!path.empty())
591                 return std::make_pair(path, explicit_userdir);
592
593         // 2. Use the LYX_USERDIR_14x environment variable.
594         path = extract_env_var_dir("LYX_USERDIR_14x");
595         if (!path.empty())
596                 return std::make_pair(path, explicit_userdir);
597
598         // 3. Use the OS-dependent default_user_support_dir
599         explicit_userdir = false;
600         return std::make_pair(default_user_support_dir, explicit_userdir);
601 }
602
603
604 // $HOME/.lyx on POSIX but on Win32 it will be something like
605 // "C:/Documents and Settings/USERNAME/Application Data/LyX"
606 string const get_default_user_support_dir(string const & home_dir)
607 {
608 #if defined (USE_WINDOWS_PACKAGING)
609         (void)home_dir; // Silence warning about unused variable.
610
611         os::GetFolderPath win32_folder_path;
612         return addPath(win32_folder_path(os::GetFolderPath::APPDATA), PACKAGE);
613
614 #elif defined (USE_MACOSX_PACKAGING)
615         (void)home_dir; // Silence warning about unused variable.
616
617         FSRef fsref;
618         OSErr const error_code =
619                 FSFindFolder(kUserDomain, kApplicationSupportFolderType,
620                              kDontCreateFolder, &fsref);
621         if (error_code != 0)
622                 return string();
623
624         char store[PATH_MAX + 1];
625         OSStatus const status_code =
626                 FSRefMakePath(&fsref,
627                               reinterpret_cast<UInt8*>(store), PATH_MAX);
628         if (status_code != 0)
629                 return string();
630
631         return addPath(reinterpret_cast<char const *>(store), PACKAGE);
632
633 #else // USE_POSIX_PACKAGING
634         return addPath(home_dir, string(".") + PACKAGE);
635 #endif
636 }
637
638
639 // Check that directory @c dir contains @c file.
640 // Else emit a warning about an invalid @c command_line_switch.
641 bool check_command_line_dir(string const & dir,
642                             string const & file,
643                             string const & command_line_switch)
644 {
645         FileName const abs_path = fileSearch(dir, file);
646         if (abs_path.empty()) {
647                 // FIXME UNICODE
648                 lyxerr << lyx::to_utf8(bformat(_("Invalid %1$s switch.\n"
649                                                  "Directory %2$s does not contain %3$s."),
650                                   lyx::from_utf8(command_line_switch), lyx::from_utf8(dir),
651                                   lyx::from_utf8(file)))
652                        << std::endl;
653         }
654
655         return !abs_path.empty();
656 }
657
658
659 // The environment variable @c env_var expands to a (single) file path.
660 string const extract_env_var_dir(string const & env_var)
661 {
662         string const dir = os::internal_path(getEnv(env_var));
663         return dir.empty() ? dir : makeAbsPath(dir);
664 }
665
666
667 // Check that directory @c dir contains @c file.
668 // Else emit a warning about an invalid @c env_var.
669 bool check_env_var_dir(string const & dir,
670                        string const & file,
671                        string const & env_var)
672 {
673         FileName const abs_path = fileSearch(dir, file);
674         if (abs_path.empty()) {
675                 // FIXME UNICODE
676                 lyxerr << lyx::to_utf8(bformat(_("Invalid %1$s environment variable.\n"
677                                                  "Directory %2$s does not contain %3$s."),
678                                   lyx::from_utf8(env_var), lyx::from_utf8(dir), lyx::from_utf8(file)))
679                        << std::endl;
680         }
681
682         return !abs_path.empty();
683 }
684
685
686 // Check that directory @c dir is indeed a directory.
687 // Else emit a warning about an invalid @c env_var.
688 bool check_env_var_dir(string const & dir,
689                        string const & env_var)
690 {
691         bool const success = (fs::exists(dir) && fs::is_directory(dir));
692
693         if (!success) {
694                 // Put this string on a single line so that the gettext
695                 // search mechanism in po/Makefile.in.in will register
696                 // package.C.in as a file containing strings that need
697                 // translation.
698                 // FIXME UNICODE
699                 docstring const fmt =
700                         _("Invalid %1$s environment variable.\n%2$s is not a directory.");
701
702                 lyxerr << lyx::to_utf8(bformat(fmt, lyx::from_utf8(env_var), lyx::from_utf8(dir)))
703                        << std::endl;
704         }
705
706         return success;
707 }
708
709
710 // The locale directory relative to the LyX system directory.
711 string const relative_locale_dir()
712 {
713 #if defined (USE_WINDOWS_PACKAGING) || defined (USE_MACOSX_PACKAGING)
714         return "locale/";
715 #else
716         return "../locale/";
717 #endif
718 }
719
720
721 // The system lyxdir is relative to the directory containing the LyX binary.
722 string const relative_system_support_dir()
723 {
724         string result;
725
726 #if defined (USE_WINDOWS_PACKAGING) || defined (USE_MACOSX_PACKAGING)
727         result = "../Resources/";
728 #else // Posix-like.
729         result = addPath("../share/", PACKAGE);
730 #endif
731
732         return result;
733 }
734
735 } // namespace anon
736
737 } // namespace support
738 } // namespace lyx