4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Angus Leeming
9 * Full author contact details are available in file CREDITS.
14 #include "support/Package.h"
16 #include "support/debug.h"
17 #include "support/environment.h"
18 #include "support/ExceptionMessage.h"
19 #include "support/filetools.h"
20 #include "support/gettext.h"
21 #include "support/lstrings.h"
22 #include "support/os.h"
24 #if defined (USE_WINDOWS_PACKAGING)
25 # include "support/os_win32.h"
31 #if !defined (USE_WINDOWS_PACKAGING) && \
32 !defined (USE_MACOSX_PACKAGING) && \
33 !defined (USE_POSIX_PACKAGING)
34 #error USE_FOO_PACKAGING must be defined for FOO = WINDOWS, MACOSX or POSIX.
37 #if defined (USE_MACOSX_PACKAGING)
38 # include <CoreServices/CoreServices.h> // FSFindFolder, FSRefMakePath
49 bool initialised_ = false;
54 void init_package(string const & command_line_arg0,
55 string const & command_line_system_support_dir,
56 string const & command_line_user_support_dir,
57 exe_build_dir_to_top_build_dir top_build_dir_location)
59 // Can do so only once.
63 package_ = Package(command_line_arg0,
64 command_line_system_support_dir,
65 command_line_user_support_dir,
66 top_build_dir_location);
71 Package const & package()
73 // Commented out because package().locale_dir() can be called
74 // from the message translation code in Messages.cpp before
75 // init_package() is called. Lars is on the case...
76 // LASSERT(initialised_, /**/);
83 FileName const abs_path_from_binary_name(string const & exe);
85 void buildDirs(FileName const & abs_binary,
86 exe_build_dir_to_top_build_dir top_build_dir_location,
87 FileName &, FileName &);
89 FileName const get_document_dir(FileName const & home_dir);
91 FileName const get_home_dir();
93 FileName const get_locale_dir(FileName const & system_support_dir);
95 FileName const get_system_support_dir(FileName const & abs_binary,
96 string const & command_line_system_support_dir);
98 FileName const get_temp_dir();
100 FileName const get_default_user_support_dir(FileName const & home_dir);
102 bool userSupportDir(FileName const & default_user_support_dir,
103 string const & command_line_user_support_dir, FileName & result);
106 string const & with_version_suffix();
111 Package::Package(string const & command_line_arg0,
112 string const & command_line_system_support_dir,
113 string const & command_line_user_support_dir,
114 exe_build_dir_to_top_build_dir top_build_dir_location)
115 : explicit_user_support_dir_(false)
117 home_dir_ = get_home_dir();
118 system_temp_dir_ = get_temp_dir();
119 temp_dir_ = system_temp_dir_;
120 document_dir_ = get_document_dir(home_dir_);
122 FileName const abs_binary = abs_path_from_binary_name(command_line_arg0);
123 string const bdir = onlyPath(abs_binary.absFilename());
124 // We may be using libtools
125 if (suffixIs(bdir, ".libs/"))
126 binary_dir_ = FileName(addPath(bdir, "../"));
128 binary_dir_ = FileName(bdir);
130 // Is LyX being run in-place from the build tree?
131 buildDirs(abs_binary, top_build_dir_location,
132 build_support_dir_, system_support_dir_);
134 if (build_support_dir_.empty())
135 system_support_dir_ =
136 get_system_support_dir(abs_binary,
137 command_line_system_support_dir);
139 locale_dir_ = get_locale_dir(system_support_dir_);
141 FileName const default_user_support_dir =
142 get_default_user_support_dir(home_dir_);
144 explicit_user_support_dir_ = userSupportDir(default_user_support_dir,
145 command_line_user_support_dir, user_support_dir_);
147 FileName const configure_script(addName(system_support().absFilename(), "configure.py"));
148 configure_command_ = os::python() + ' ' +
149 quoteName(configure_script.toFilesystemEncoding()) +
150 with_version_suffix();
152 LYXERR(Debug::INIT, "<package>\n"
153 << "\tbinary_dir " << binary_dir().absFilename() << '\n'
154 << "\tsystem_support " << system_support().absFilename() << '\n'
155 << "\tbuild_support " << build_support().absFilename() << '\n'
156 << "\tuser_support " << user_support().absFilename() << '\n'
157 << "\tlocale_dir " << locale_dir().absFilename() << '\n'
158 << "\tdocument_dir " << document_dir().absFilename() << '\n'
159 << "\ttemp_dir " << temp_dir().absFilename() << '\n'
160 << "\thome_dir " << home_dir().absFilename() << '\n'
165 void Package::set_temp_dir(FileName const & temp_dir) const
167 if (temp_dir.empty())
168 temp_dir_ = system_temp_dir_;
170 temp_dir_ = temp_dir;
176 // These next functions contain the stuff that is substituted at
177 // configuration-time.
178 FileName const hardcoded_localedir()
181 // The build system needs to make sure that this is in utf8 encoding.
182 return FileName(LYX_ABS_INSTALLED_LOCALEDIR);
186 FileName const hardcoded_system_support_dir()
189 // The build system needs to make sure that this is in utf8 encoding.
190 return FileName(LYX_ABS_INSTALLED_DATADIR);
194 string const & with_version_suffix()
196 static string const program_suffix = PROGRAM_SUFFIX;
197 static string const with_version_suffix =
198 " --with-version-suffix=" PROGRAM_SUFFIX;
199 return program_suffix.empty() ? program_suffix : with_version_suffix;
205 FileName const & Package::top_srcdir()
208 // The build system needs to make sure that this is in utf8 encoding.
209 static FileName const dir(LYX_ABS_TOP_SRCDIR);
216 bool check_command_line_dir(string const & dir,
218 string const & command_line_switch);
220 FileName const extract_env_var_dir(string const & env_var);
222 bool check_env_var_dir(FileName const & dir,
223 string const & env_var);
225 bool check_env_var_dir(FileName const & dir,
227 string const & env_var);
229 string const relative_locale_dir();
231 string const relative_system_support_dir();
235 * Convert \p name to internal path and strip a trailing slash, since it
236 * comes from user input (commandline or environment).
237 * \p name is encoded in utf8.
239 string const fix_dir_name(string const & name)
241 return rtrim(os::internal_path(name), "/");
245 FileName buildSupportDir(string const & binary_dir,
246 exe_build_dir_to_top_build_dir top_build_dir_location)
249 switch (top_build_dir_location) {
250 case top_build_dir_is_one_level_up:
251 indirection = "../lib";
253 case top_build_dir_is_two_levels_up:
254 indirection = "../../lib";
257 return FileName(addPath(binary_dir, indirection));
261 void buildDirs(FileName const & abs_binary,
262 exe_build_dir_to_top_build_dir top_build_dir_location,
263 FileName & build_support_dir, FileName & system_support_dir)
265 string const check_text = "Checking whether LyX is run in place...";
267 // We're looking for "Makefile" in a directory
269 // We're also looking for "chkconfig.ltx" in a directory
271 // If both are found, then we're running LyX in-place.
273 // Note that the name of the lyx binary may be a symbolic link.
274 // If that is the case, then we follow the links too.
275 FileName binary = abs_binary;
277 // Try and find "lyxrc.defaults".
278 string binary_dir = onlyPath(binary.absFilename());
279 // We may be using libtools with static linking.
280 if (suffixIs(binary_dir, ".libs/"))
281 binary_dir = addPath(binary_dir, "../");
282 build_support_dir = buildSupportDir(binary_dir, top_build_dir_location);
283 if (!fileSearch(build_support_dir.absFilename(), "Makefile").empty()) {
284 // Try and find "chkconfig.ltx".
286 FileName(addPath(Package::top_srcdir().absFilename(), "lib"));
288 if (!fileSearch(system_support_dir.absFilename(), "chkconfig.ltx").empty()) {
289 LYXERR(Debug::INIT, check_text << " yes");
294 // Check whether binary is a symbolic link.
295 // If so, resolve it and repeat the exercise.
296 if (!binary.isSymLink())
300 if (readLink(binary, link)) {
303 // Unable to resolve the link.
308 LYXERR(Debug::INIT, check_text << " no");
309 system_support_dir = FileName();
310 build_support_dir = FileName();
314 // Specification of document_dir_ may be reset by LyXRC,
315 // but the default is fixed for a given OS.
316 FileName const get_document_dir(FileName const & home_dir)
318 #if defined (USE_WINDOWS_PACKAGING)
319 (void)home_dir; // Silence warning about unused variable.
320 os::GetFolderPath win32_folder_path;
321 return FileName(win32_folder_path(os::GetFolderPath::PERSONAL));
328 // The specification of home_dir_ is fixed for a given OS.
329 // A typical example on Windows: "C:/Documents and Settings/USERNAME"
330 // and on a Posix-like machine: "/home/USERNAME".
331 FileName const get_home_dir()
333 #if defined (USE_WINDOWS_PACKAGING)
334 string const home_dir = getEnv("USERPROFILE");
336 string const home_dir = getEnv("HOME");
339 return FileName(fix_dir_name(home_dir));
343 // Several sources are probed to ascertain the locale directory.
344 // The only requirement is that the result is indeed a directory.
345 FileName const get_locale_dir(FileName const & system_support_dir)
347 // 1. Use the "LYX_LOCALEDIR" environment variable.
348 FileName const path_env = extract_env_var_dir("LYX_LOCALEDIR");
349 if (!path_env.empty() && check_env_var_dir(path_env, "LYX_LOCALEDIR"))
352 // 2. Search for system_support_dir / <relative locale dir>
353 // The <relative locale dir> is OS-dependent. (On Unix, it will
355 FileName path(addPath(system_support_dir.absFilename(),
356 relative_locale_dir()));
358 if (path.exists() && path.isDirectory())
361 // 3. Fall back to the hard-coded LOCALEDIR.
362 path = hardcoded_localedir();
363 if (path.exists() && path.isDirectory())
370 // Specification of temp_dir_ may be reset by LyXRC,
371 // but the default is fixed for a given OS.
372 FileName const get_temp_dir()
374 #if defined (USE_WINDOWS_PACKAGING)
375 // Typical example: C:/TEMP/.
377 GetTempPath(MAX_PATH, path);
378 // Remove trailing backslash if any.
379 return FileName(rtrim(to_utf8(from_local8bit(path)), "\\"));
381 return FileName("/tmp");
386 // Extracts the absolute path from the foo of "-sysdir foo" or "-userdir foo"
387 FileName const abs_path_from_command_line(string const & command_line)
389 if (command_line.empty())
392 string const str_path = fix_dir_name(command_line);
393 FileName path(str_path);
394 return path.isAbsolute() ? path : makeAbsPath(str_path);
398 // Does the grunt work for abs_path_from_binary_name()
399 FileName const get_binary_path(string const & exe)
401 #if defined (USE_WINDOWS_PACKAGING)
402 // The executable may have been invoked either with or
403 // without the .exe extension.
404 // Ensure that it is present.
405 string const as_internal_path = os::internal_path(exe);
406 string const exe_path = suffixIs(as_internal_path, ".exe") ?
407 as_internal_path : as_internal_path + ".exe";
409 string const exe_path = os::internal_path(exe);
411 FileName exepath(exe_path);
412 if (exepath.isAbsolute())
415 // Two possibilities present themselves.
416 // 1. The binary is relative to the CWD.
417 FileName const abs_exe_path = makeAbsPath(exe_path);
418 if (abs_exe_path.exists())
421 // 2. exe must be the name of the binary only and it
422 // can be found on the PATH.
423 string const exe_name = onlyFilename(exe_path);
424 if (exe_name != exe_path)
427 vector<string> const path = getEnvPath("PATH");
428 vector<string>::const_iterator it = path.begin();
429 vector<string>::const_iterator const end = path.end();
430 for (; it != end; ++it) {
431 // This will do nothing if *it is already absolute.
432 string const exe_dir = makeAbsPath(*it).absFilename();
434 FileName const exe_path(addName(exe_dir, exe_name));
435 if (exe_path.exists())
439 // Didn't find anything.
444 // Extracts the absolute path to the binary name received as argv[0].
445 FileName const abs_path_from_binary_name(string const & exe)
447 FileName const abs_binary = get_binary_path(exe);
448 if (abs_binary.empty()) {
450 throw ExceptionMessage(ErrorException,
451 _("LyX binary not found"),
452 bformat(_("Unable to determine the path to the LyX binary from the command line %1$s"),
459 // A plethora of directories is searched to ascertain the system
460 // lyxdir which is defined as the first directory to contain
463 get_system_support_dir(FileName const & abs_binary,
464 string const & command_line_system_support_dir)
466 string const chkconfig_ltx = "chkconfig.ltx";
468 // searched_dirs is used for diagnostic purposes only in the case
469 // that "chkconfig.ltx" is not found.
470 list<FileName> searched_dirs;
472 // 1. Use the -sysdir command line parameter.
473 FileName path = abs_path_from_command_line(command_line_system_support_dir);
475 searched_dirs.push_back(path);
476 if (check_command_line_dir(path.absFilename(), chkconfig_ltx, "-sysdir"))
480 // 2. Use the "LYX_DIR_15x" environment variable.
481 path = extract_env_var_dir("LYX_DIR_15x");
483 searched_dirs.push_back(path);
484 if (check_env_var_dir(path, chkconfig_ltx, "LYX_DIR_15x"))
488 // 3. Search relative to the lyx binary.
489 // We're looking for "chkconfig.ltx" in a directory
490 // OnlyPath(abs_binary) / <relative dir> / PACKAGE /
491 // PACKAGE is hardcoded in config.h. Eg "lyx" or "lyx-1.3.6cvs".
492 // <relative dir> is OS-dependent; on Unix, it will be "../share/".
493 string const relative_lyxdir = relative_system_support_dir();
495 // One subtlety to be aware of. The name of the lyx binary may be
496 // a symbolic link. If that is the case, then we follow the links too.
497 FileName binary = abs_binary;
499 // Try and find "chkconfig.ltx".
500 string const binary_dir = onlyPath(binary.absFilename());
502 FileName const lyxdir(addPath(binary_dir, relative_lyxdir));
503 searched_dirs.push_back(lyxdir);
505 if (!fileSearch(lyxdir.absFilename(), chkconfig_ltx).empty()) {
506 // Success! "chkconfig.ltx" has been found.
510 // Check whether binary is a symbolic link.
511 // If so, resolve it and repeat the exercise.
512 if (!binary.isSymLink())
516 if (readLink(binary, link)) {
519 // Unable to resolve the link.
524 // 4. Repeat the exercise on the directory itself.
525 FileName binary_dir(onlyPath(abs_binary.absFilename()));
527 // This time test whether the directory is a symbolic link
528 // *before* looking for "chkconfig.ltx".
529 // (We've looked relative to the original already.)
530 if (!binary.isSymLink())
534 if (readLink(binary_dir, link)) {
537 // Unable to resolve the link.
541 // Try and find "chkconfig.ltx".
542 FileName const lyxdir(addPath(binary_dir.absFilename(),
544 searched_dirs.push_back(lyxdir);
546 if (!fileSearch(lyxdir.absFilename(), chkconfig_ltx).empty()) {
547 // Success! "chkconfig.ltx" has been found.
552 // 5. In desparation, try the hard-coded system support dir.
553 path = hardcoded_system_support_dir();
554 if (!fileSearch(path.absFilename(), chkconfig_ltx).empty())
557 // Everything has failed :-(
558 // So inform the user and exit.
559 string searched_dirs_str;
560 typedef list<FileName>::const_iterator iterator;
561 iterator const begin = searched_dirs.begin();
562 iterator const end = searched_dirs.end();
563 for (iterator it = begin; it != end; ++it) {
565 searched_dirs_str += "\n\t";
566 searched_dirs_str += it->absFilename();
570 throw ExceptionMessage(ErrorException, _("No system directory"),
571 bformat(_("Unable to determine the system directory "
574 "Use the '-sysdir' command line parameter or "
575 "set the environment variable LYX_DIR_15x to "
576 "the LyX system directory containing the file "
578 from_utf8(searched_dirs_str)));
580 // Keep the compiler happy.
585 // Returns the absolute path to the user lyxdir, together with a flag
586 // indicating whether this directory was specified explicitly (as -userdir
587 // or through an environment variable) or whether it was deduced.
588 bool userSupportDir(FileName const & default_user_support_dir,
589 string const & command_line_user_support_dir, FileName & result)
591 // 1. Use the -userdir command line parameter.
592 result = abs_path_from_command_line(command_line_user_support_dir);
596 // 2. Use the LYX_USERDIR_15x environment variable.
597 result = extract_env_var_dir("LYX_USERDIR_15x");
601 // 3. Use the OS-dependent default_user_support_dir
602 result = default_user_support_dir;
607 // $HOME/.lyx on POSIX but on Win32 it will be something like
608 // "C:/Documents and Settings/USERNAME/Application Data/LyX"
609 FileName const get_default_user_support_dir(FileName const & home_dir)
611 #if defined (USE_WINDOWS_PACKAGING)
612 (void)home_dir; // Silence warning about unused variable.
614 os::GetFolderPath win32_folder_path;
615 return FileName(addPath(win32_folder_path(os::GetFolderPath::APPDATA), PACKAGE));
617 #elif defined (USE_MACOSX_PACKAGING)
618 (void)home_dir; // Silence warning about unused variable.
621 OSErr const error_code =
622 FSFindFolder(kUserDomain, kApplicationSupportFolderType,
623 kDontCreateFolder, &fsref);
627 // FSRefMakePath returns the result in utf8
628 char store[PATH_MAX + 1];
629 OSStatus const status_code =
630 FSRefMakePath(&fsref,
631 reinterpret_cast<UInt8*>(store), PATH_MAX);
632 if (status_code != 0)
635 return FileName(addPath(reinterpret_cast<char const *>(store), PACKAGE));
637 #else // USE_POSIX_PACKAGING
638 return FileName(addPath(home_dir.absFilename(), string(".") + PACKAGE));
643 // Check that directory @c dir contains @c file.
644 // Else emit an error message about an invalid @c command_line_switch.
645 bool check_command_line_dir(string const & dir,
647 string const & command_line_switch)
649 FileName const abs_path = fileSearch(dir, file);
650 if (abs_path.empty()) {
652 throw ExceptionMessage(ErrorException, _("File not found"), bformat(
653 _("Invalid %1$s switch.\nDirectory %2$s does not contain %3$s."),
654 from_utf8(command_line_switch), from_utf8(dir),
658 return !abs_path.empty();
662 // The environment variable @c env_var expands to a (single) file path.
663 FileName const extract_env_var_dir(string const & env_var)
665 string const dir = fix_dir_name(getEnv(env_var));
666 return dir.empty() ? FileName() : makeAbsPath(dir);
670 // Check that directory @c dir contains @c file.
671 // Else emit a warning about an invalid @c env_var.
672 bool check_env_var_dir(FileName const & dir,
674 string const & env_var)
676 FileName const abs_path = fileSearch(dir.absFilename(), file);
677 if (abs_path.empty()) {
679 throw ExceptionMessage(WarningException, _("File not found"), bformat(
680 _("Invalid %1$s environment variable.\n"
681 "Directory %2$s does not contain %3$s."),
682 from_utf8(env_var), from_utf8(dir.absFilename()),
686 return !abs_path.empty();
690 // Check that directory @c dir is indeed a directory.
691 // Else emit a warning about an invalid @c env_var.
692 bool check_env_var_dir(FileName const & dir,
693 string const & env_var)
695 bool const success = dir.exists() && dir.isDirectory();
698 // Put this string on a single line so that the gettext
699 // search mechanism in po/Makefile.in.in will register
700 // Package.cpp.in as a file containing strings that need
703 docstring const fmt =
704 _("Invalid %1$s environment variable.\n%2$s is not a directory.");
706 throw ExceptionMessage(WarningException, _("Directory not found"), bformat(
707 fmt, from_utf8(env_var), from_utf8(dir.absFilename())));
714 // The locale directory relative to the LyX system directory.
715 string const relative_locale_dir()
717 #if defined (USE_WINDOWS_PACKAGING) || defined (USE_MACOSX_PACKAGING)
725 // The system lyxdir is relative to the directory containing the LyX binary.
726 string const relative_system_support_dir()
730 #if defined (USE_WINDOWS_PACKAGING) || defined (USE_MACOSX_PACKAGING)
731 result = "../Resources/";
733 result = addPath("../share/", PACKAGE);
741 } // namespace support