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.
11 * Warning! This file is autogenerated from package.C.in.
12 * All changes to this file will be lost.
17 #include "support/package.h"
22 #include "support/environment.h"
23 #include "support/filetools.h"
24 #include "support/lstrings.h"
25 #include "support/os.h"
27 #if defined (USE_WINDOWS_PACKAGING)
28 # include "support/os_win32.h"
31 #include <boost/filesystem/operations.hpp>
32 #include <boost/tuple/tuple.hpp>
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.
43 #if defined (USE_MACOSX_PACKAGING)
44 # include <CoreServices/CoreServices.h> // FSFindFolder, FSRefMakePath
53 namespace fs = boost::filesystem;
61 bool initialised_ = false;
66 void init_package(string const & command_line_arg0,
67 string const & command_line_system_support_dir,
68 string const & command_line_user_support_dir,
69 exe_build_dir_to_top_build_dir top_build_dir_location)
71 // Can do so only once.
75 package_ = Package(command_line_arg0,
76 command_line_system_support_dir,
77 command_line_user_support_dir,
78 top_build_dir_location);
83 Package const & package()
85 // Commented out because package().locale_dir() can be called
86 // from the message translation code in messages.C before
87 // init_package() is called. Lars is on the case...
88 // BOOST_ASSERT(initialised_);
95 string const abs_path_from_binary_name(string const & exe);
97 std::pair<string, string> const
98 get_build_dirs(string const & abs_binary,
99 exe_build_dir_to_top_build_dir top_build_dir_location);
101 string const get_document_dir(string const & home_dir);
103 string const get_home_dir();
105 string const get_locale_dir(string const & system_support_dir);
107 string const get_system_support_dir(string const & abs_binary,
108 string const & command_line_system_support_dir);
110 string const get_temp_dir();
112 string const get_default_user_support_dir(string const & home_dir);
114 std::pair<string, bool> const
115 get_user_support_dir(string const & default_user_support_dir,
116 string const & command_line_user_support_dir);
119 string const & with_version_suffix();
124 Package::Package(string const & command_line_arg0,
125 string const & command_line_system_support_dir,
126 string const & command_line_user_support_dir,
127 exe_build_dir_to_top_build_dir top_build_dir_location)
128 : explicit_user_support_dir_(false)
130 home_dir_ = get_home_dir();
131 temp_dir_ = get_temp_dir();
132 document_dir_ = get_document_dir(home_dir_);
134 string const abs_binary = abs_path_from_binary_name(command_line_arg0);
135 binary_dir_ = onlyPath(abs_binary);
137 // Is LyX being run in-place from the build tree?
138 boost::tie(build_support_dir_, system_support_dir_) =
139 get_build_dirs(abs_binary, top_build_dir_location);
141 if (build_support_dir_.empty())
142 system_support_dir_ =
143 get_system_support_dir(abs_binary,
144 command_line_system_support_dir);
146 locale_dir_ = get_locale_dir(system_support_dir_);
148 string const default_user_support_dir =
149 get_default_user_support_dir(home_dir_);
150 boost::tie(user_support_dir_, explicit_user_support_dir_) =
151 get_user_support_dir(default_user_support_dir,
152 command_line_user_support_dir);
154 string const configure_script = addName(system_support(), "configure.py");
155 configure_command_ = "python " + quoteName(configure_script)
156 + with_version_suffix();
160 << "\tbinary_dir " << binary_dir() << '\n'
161 << "\tsystem_support " << system_support() << '\n'
162 << "\tbuild_support " << build_support() << '\n'
163 << "\tuser_support " << user_support() << '\n'
164 << "\tlocale_dir " << locale_dir() << '\n'
165 << "\tdocument_dir " << document_dir() << '\n'
166 << "\ttemp_dir " << temp_dir() << '\n'
167 << "\thome_dir " << home_dir() << '\n'
168 << "</package>\n" << std::endl;
174 // These next three functions contain the stuff that is substituted at
175 // configuration-time.
176 string const top_srcdir()
178 static string const dir("%TOP_SRCDIR%");
183 string const hardcoded_localedir()
185 return string("%LOCALEDIR%");
189 string const hardcoded_system_support_dir()
191 return string("%LYX_DIR%");
195 string const & with_version_suffix()
197 static string const program_suffix("%PROGRAM_SUFFIX%");
199 with_version_suffix(" --with-version-suffix=%PROGRAM_SUFFIX%");
200 return program_suffix.empty() ? program_suffix : with_version_suffix;
206 string const & Package::top_srcdir() const
208 static string const dir("%TOP_SRCDIR%");
215 bool check_command_line_dir(string const & dir,
217 string const & command_line_switch);
219 string const extract_env_var_dir(string const & env_var);
221 bool check_env_var_dir(string const & dir,
222 string const & env_var);
224 bool check_env_var_dir(string const & dir,
226 string const & env_var);
228 string const relative_locale_dir();
230 string const relative_system_support_dir();
234 get_build_support_dir(std::string const & binary_dir,
235 exe_build_dir_to_top_build_dir top_build_dir_location)
238 switch (top_build_dir_location) {
239 case top_build_dir_is_one_level_up:
240 indirection = "../lib";
242 case top_build_dir_is_two_levels_up:
243 indirection = "../../lib";
247 return normalizePath(addPath(binary_dir, indirection));
251 std::pair<string, string> const
252 get_build_dirs(string const & abs_binary,
253 exe_build_dir_to_top_build_dir top_build_dir_location)
255 string const check_text = "Checking whether LyX is run in place...";
257 // We're looking for "Makefile" in a directory
259 // We're also looking for "chkconfig.ltx" in a directory
261 // If both are found, then we're running LyX in-place.
263 // Note that the name of the lyx binary may be a symbolic link.
264 // If that is the case, then we follow the links too.
265 string binary = abs_binary;
267 // Try and find "lyxrc.defaults".
268 string const binary_dir = onlyPath(binary);
269 string const build_support_dir =
270 get_build_support_dir(binary_dir, top_build_dir_location);
272 if (!fileSearch(build_support_dir, "Makefile").empty()) {
273 // Try and find "chkconfig.ltx".
274 string const system_support_dir =
275 addPath(top_srcdir(), "lib");
277 if (!fileSearch(system_support_dir, "chkconfig.ltx").empty()) {
278 lyxerr[Debug::INIT] << check_text << " yes"
280 return std::make_pair(build_support_dir, system_support_dir);
284 // Check whether binary is a symbolic link.
285 // If so, resolve it and repeat the exercise.
286 if (!fs::symbolic_link_exists(binary))
290 if (readLink(binary, link, true)) {
293 // Unable to resolve the link.
298 lyxerr[Debug::INIT] << check_text << " no" << std::endl;
299 return std::make_pair(string(), string());
303 // Specification of document_dir_ may be reset by LyXRC,
304 // but the default is fixed for a given OS.
305 string const get_document_dir(string const & home_dir)
307 #if defined (USE_WINDOWS_PACKAGING)
308 (void)home_dir; // Silence warning about unused variable.
309 os::GetFolderPath win32_folder_path;
310 return win32_folder_path(os::GetFolderPath::PERSONAL);
317 // The specification of home_dir_ is fixed for a given OS.
318 // A typical example on Windows: "C:/Documents and Settings/USERNAME"
319 // and on a Posix-like machine: "/home/USERNAME".
320 string const get_home_dir()
322 #if defined (USE_WINDOWS_PACKAGING)
323 string const home_dir = getEnv("USERPROFILE");
325 string const home_dir = getEnv("HOME");
328 return os::internal_path(home_dir);
332 // Several sources are probed to ascertain the locale directory.
333 // The only requirement is that the result is indeed a directory.
334 string const get_locale_dir(string const & system_support_dir)
336 // 1. Use the "LYX_LOCALEDIR" environment variable.
337 string path = extract_env_var_dir("LYX_LOCALEDIR");
338 if (!path.empty() && check_env_var_dir(path, "LYX_LOCALEDIR"))
341 // 2. Search for system_support_dir / <relative locale dir>
342 // The <relative locale dir> is OS-dependent. (On Unix, it will
344 path = normalizePath(addPath(system_support_dir, relative_locale_dir()));
346 if (fs::exists(path) && fs::is_directory(path))
349 // 3. Fall back to the hard-coded LOCALEDIR.
350 path = hardcoded_localedir();
351 if (fs::exists(path) && fs::is_directory(path))
358 // Specification of temp_dir_ may be reset by LyXRC,
359 // but the default is fixed for a given OS.
360 string const get_temp_dir()
362 #if defined (USE_WINDOWS_PACKAGING)
363 // Typical example: C:/TEMP/.
365 GetTempPath(PATH_MAX, path);
366 return os::internal_path(path);
375 #ifndef CXX_GLOBAL_CSTD
382 // Extracts the absolute path from the foo of "-sysdir foo" or "-userdir foo"
383 string const abs_path_from_command_line(string const & command_line)
385 if (command_line.empty())
388 string const path = os::internal_path(command_line);
389 return os::is_absolute_path(path) ? path : makeAbsPath(path);
393 // Does the grunt work for abs_path_from_binary_name()
394 string const get_binary_path(string const & exe)
396 #if defined (USE_WINDOWS_PACKAGING)
397 // The executable may have been invoked either with or
398 // without the .exe extension.
399 // Ensure that it is present.
400 string const as_internal_path = os::internal_path(exe);
401 string const exe_path = suffixIs(as_internal_path, ".exe") ?
402 as_internal_path : as_internal_path + ".exe";
404 string const exe_path = os::internal_path(exe);
406 if (os::is_absolute_path(exe_path))
409 // Two possibilities present themselves.
410 // 1. The binary is relative to the CWD.
411 string const abs_exe_path = makeAbsPath(exe_path);
412 if (fs::exists(abs_exe_path))
415 // 2. exe must be the name of the binary only and it
416 // can be found on the PATH.
417 string const exe_name = onlyFilename(exe_path);
418 if (exe_name != exe_path)
421 std::vector<string> const path = getEnvPath("PATH");
422 std::vector<string>::const_iterator it = path.begin();
423 std::vector<string>::const_iterator const end = path.end();
424 for (; it != end; ++it) {
425 // This will do nothing if *it is already absolute.
426 string const exe_dir = makeAbsPath(*it);
428 string const exe_path = addName(exe_dir, exe_name);
429 if (fs::exists(exe_path))
433 // Didn't find anything.
438 // Extracts the absolute path to the binary name received as argv[0].
439 string const abs_path_from_binary_name(string const & exe)
441 string const abs_binary = get_binary_path(exe);
442 if (abs_binary.empty()) {
443 lyxerr << bformat(_("Unable to determine the path to the "
444 "LyX binary from the command line %1$s"),
453 // A plethora of directories is searched to ascertain the system
454 // lyxdir which is defined as the first directory to contain
457 get_system_support_dir(string const & abs_binary,
458 string const & command_line_system_support_dir)
460 string const chkconfig_ltx = "chkconfig.ltx";
462 // searched_dirs is used for diagnostic purposes only in the case
463 // that "chkconfig.ltx" is not found.
464 std::list<string> searched_dirs;
466 // 1. Use the -sysdir command line parameter.
467 string path = abs_path_from_command_line(command_line_system_support_dir);
469 searched_dirs.push_back(path);
470 if (check_command_line_dir(path, chkconfig_ltx, "-sysdir"))
474 // 2. Use the "LYX_DIR_14x" environment variable.
475 path = extract_env_var_dir("LYX_DIR_14x");
477 searched_dirs.push_back(path);
478 if (check_env_var_dir(path, chkconfig_ltx, "LYX_DIR_14x"))
482 // 3. Search relative to the lyx binary.
483 // We're looking for "chkconfig.ltx" in a directory
484 // OnlyPath(abs_binary) / <relative dir> / PACKAGE /
485 // PACKAGE is hardcoded in config.h. Eg "lyx" or "lyx-1.3.6cvs".
486 // <relative dir> is OS-dependent; on Unix, it will be "../share/".
487 string const relative_lyxdir = relative_system_support_dir();
489 // One subtlety to be aware of. The name of the lyx binary may be
490 // a symbolic link. If that is the case, then we follow the links too.
491 string binary = abs_binary;
493 // Try and find "chkconfig.ltx".
494 string const binary_dir = onlyPath(binary);
496 string const lyxdir =
497 normalizePath(addPath(binary_dir, relative_lyxdir));
498 searched_dirs.push_back(lyxdir);
500 if (!fileSearch(lyxdir, chkconfig_ltx).empty()) {
501 // Success! "chkconfig.ltx" has been found.
505 // Check whether binary is a symbolic link.
506 // If so, resolve it and repeat the exercise.
507 if (!fs::symbolic_link_exists(binary))
511 if (readLink(binary, link, true)) {
514 // Unable to resolve the link.
519 // 4. Repeat the exercise on the directory itself.
520 string binary_dir = onlyPath(abs_binary);
522 // This time test whether the directory is a symbolic link
523 // *before* looking for "chkconfig.ltx".
524 // (We've looked relative to the original already.)
525 if (!fs::symbolic_link_exists(binary))
529 if (readLink(binary_dir, link, true)) {
532 // Unable to resolve the link.
536 // Try and find "chkconfig.ltx".
537 string const lyxdir =
538 normalizePath(addPath(binary_dir, relative_lyxdir));
539 searched_dirs.push_back(lyxdir);
541 if (!fileSearch(lyxdir, chkconfig_ltx).empty()) {
542 // Success! "chkconfig.ltx" has been found.
547 // 5. In desparation, try the hard-coded system support dir.
548 path = hardcoded_system_support_dir();
549 if (!fileSearch(path, chkconfig_ltx).empty())
552 // Everything has failed :-(
553 // So inform the user and exit.
554 string searched_dirs_str;
555 typedef std::list<string>::const_iterator iterator;
556 iterator const begin = searched_dirs.begin();
557 iterator const end = searched_dirs.end();
558 for (iterator it = begin; it != end; ++it) {
560 searched_dirs_str += "\n\t";
561 searched_dirs_str += *it;
564 lyxerr << bformat(_("Unable to determine the system directory "
567 "Use the '-sysdir' command line parameter or "
568 "set the environment variable LYX_DIR_14x to "
569 "the LyX system directory containing the file "
575 // Keep the compiler happy.
580 // Returns the absolute path to the user lyxdir, together with a flag
581 // indicating whether this directory was specified explicitly (as -userdir
582 // or through an environment variable) or whether it was deduced.
583 std::pair<string, bool> const
584 get_user_support_dir(string const & default_user_support_dir,
585 string const & command_line_user_support_dir)
587 bool explicit_userdir = true;
589 // 1. Use the -userdir command line parameter.
591 abs_path_from_command_line(command_line_user_support_dir);
593 return std::make_pair(path, explicit_userdir);
595 // 2. Use the LYX_USERDIR_14x environment variable.
596 path = extract_env_var_dir("LYX_USERDIR_14x");
598 return std::make_pair(path, explicit_userdir);
600 // 3. Use the OS-dependent default_user_support_dir
601 explicit_userdir = false;
602 return std::make_pair(default_user_support_dir, explicit_userdir);
606 // $HOME/.lyx on POSIX but on Win32 it will be something like
607 // "C:/Documents and Settings/USERNAME/Application Data/LyX"
608 string const get_default_user_support_dir(string const & home_dir)
610 #if defined (USE_WINDOWS_PACKAGING)
611 (void)home_dir; // Silence warning about unused variable.
613 os::GetFolderPath win32_folder_path;
614 return addPath(win32_folder_path(os::GetFolderPath::APPDATA), PACKAGE);
616 #elif defined (USE_MACOSX_PACKAGING)
617 (void)home_dir; // Silence warning about unused variable.
620 OSErr const error_code =
621 FSFindFolder(kUserDomain, kApplicationSupportFolderType,
622 kDontCreateFolder, &fsref);
626 char store[PATH_MAX + 1];
627 OSStatus const status_code =
628 FSRefMakePath(&fsref,
629 reinterpret_cast<UInt8*>(store), PATH_MAX);
630 if (status_code != 0)
633 return addPath(reinterpret_cast<char const *>(store), PACKAGE);
635 #else // USE_POSIX_PACKAGING
636 return addPath(home_dir, string(".") + PACKAGE);
641 // Check that directory @c dir contains @c file.
642 // Else emit a warning about an invalid @c command_line_switch.
643 bool check_command_line_dir(string const & dir,
645 string const & command_line_switch)
647 string const abs_path = fileSearch(dir, file);
648 if (abs_path.empty()) {
649 lyxerr << bformat(_("Invalid %1$s switch.\n"
650 "Directory %2$s does not contain %3$s."),
651 command_line_switch, dir, file)
655 return !abs_path.empty();
659 // The environment variable @c env_var expands to a (single) file path.
660 string const extract_env_var_dir(string const & env_var)
662 string const dir = os::internal_path(getEnv(env_var));
663 return dir.empty() ? dir : makeAbsPath(dir);
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,
671 string const & env_var)
673 string const abs_path = fileSearch(dir, file);
674 if (abs_path.empty()) {
675 lyxerr << bformat(_("Invalid %1$s environment variable.\n"
676 "Directory %2$s does not contain %3$s."),
681 return !abs_path.empty();
685 // Check that directory @c dir is indeed a directory.
686 // Else emit a warning about an invalid @c env_var.
687 bool check_env_var_dir(string const & dir,
688 string const & env_var)
690 bool const success = (fs::exists(dir) && fs::is_directory(dir));
693 // Put this string on a single line so that the gettext
694 // search mechanism in po/Makefile.in.in will register
695 // package.C.in as a file containing strings that need
698 _("Invalid %1$s environment variable.\n%2$s is not a directory.");
700 lyxerr << bformat(fmt, env_var, dir)
708 // The locale directory relative to the LyX system directory.
709 string const relative_locale_dir()
711 #if defined (USE_WINDOWS_PACKAGING) || defined (USE_MACOSX_PACKAGING)
719 // The system lyxdir is relative to the directory containing the LyX binary.
720 string const relative_system_support_dir()
724 #if defined (USE_WINDOWS_PACKAGING) || defined (USE_MACOSX_PACKAGING)
725 result = "../Resources/";
727 result = addPath("../share/", PACKAGE);
735 } // namespace support