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/lassert.h"
22 #include "support/lstrings.h"
23 #include "support/os.h"
25 #if defined (USE_WINDOWS_PACKAGING)
26 # include "support/os_win32.h"
32 #if !defined (USE_WINDOWS_PACKAGING) && \
33 !defined (USE_MACOSX_PACKAGING) && \
34 !defined (USE_POSIX_PACKAGING)
35 #error USE_FOO_PACKAGING must be defined for FOO = WINDOWS, MACOSX or POSIX.
38 #if defined (USE_MACOSX_PACKAGING)
39 # include "support/qstring_helpers.h"
41 # include <QDesktopServices>
52 bool initialised_ = false;
57 void init_package(string const & command_line_arg0,
58 string const & command_line_system_support_dir,
59 string const & command_line_user_support_dir)
61 package_ = Package(command_line_arg0,
62 command_line_system_support_dir,
63 command_line_user_support_dir);
68 Package const & package()
70 LASSERT(initialised_, /**/);
77 FileName const abs_path_from_binary_name(string const & exe);
80 bool inBuildDir(FileName const & abs_binary, FileName &, FileName &);
82 FileName findLyxBinary(FileName const & abs_binary);
84 FileName const get_document_dir(FileName const & home_dir);
86 FileName const get_locale_dir(FileName const & system_support_dir);
88 FileName const get_system_support_dir(FileName const & abs_binary,
89 string const & command_line_system_support_dir);
91 FileName const get_default_user_support_dir(FileName const & home_dir);
93 bool userSupportDir(FileName const & default_user_support_dir,
94 string const & command_line_user_support_dir, FileName & result);
96 string const & with_version_suffix();
98 string const fix_dir_name(string const & name);
103 Package::Package(string const & command_line_arg0,
104 string const & command_line_system_support_dir,
105 string const & command_line_user_support_dir)
106 : explicit_user_support_dir_(false)
108 // Specification of temp_dir_ may be reset by LyXRC,
109 // but the default is fixed for a given OS.
110 system_temp_dir_ = FileName::tempPath();
111 temp_dir_ = system_temp_dir_;
112 document_dir_ = get_document_dir(get_home_dir());
114 FileName const abs_binary = abs_path_from_binary_name(command_line_arg0);
115 binary_dir_ = FileName(onlyPath(abs_binary.absFileName()));
117 // the LyX package directory
118 lyx_dir_ = FileName(addPath(binary_dir_.absFileName(), "../"));
119 lyx_dir_ = FileName(lyx_dir_.realPath());
121 // Is LyX being run in-place from the build tree?
122 bool in_build_dir = inBuildDir(abs_binary, build_support_dir_, system_support_dir_);
125 system_support_dir_ =
126 get_system_support_dir(abs_binary,
127 command_line_system_support_dir);
130 // Find the LyX executable
131 lyx_binary_ = findLyxBinary(abs_binary);
133 locale_dir_ = get_locale_dir(system_support_dir_);
135 FileName const default_user_support_dir =
136 get_default_user_support_dir(get_home_dir());
138 explicit_user_support_dir_ = userSupportDir(default_user_support_dir,
139 command_line_user_support_dir, user_support_dir_);
141 FileName const configure_script(addName(system_support().absFileName(), "configure.py"));
142 configure_command_ = os::python() + ' ' +
143 quoteName(configure_script.toFilesystemEncoding(), quote_python) +
144 with_version_suffix();
146 LYXERR(Debug::INIT, "<package>\n"
147 << "\tbinary_dir " << binary_dir().absFileName() << '\n'
148 << "\tsystem_support " << system_support().absFileName() << '\n'
149 << "\tbuild_support " << build_support().absFileName() << '\n'
150 << "\tuser_support " << user_support().absFileName() << '\n'
151 << "\tlocale_dir " << locale_dir().absFileName() << '\n'
152 << "\tdocument_dir " << document_dir().absFileName() << '\n'
153 << "\ttemp_dir " << temp_dir().absFileName() << '\n'
154 << "\thome_dir " << get_home_dir().absFileName() << '\n'
159 void Package::set_temp_dir(FileName const & temp_dir) const
161 if (temp_dir.empty())
162 temp_dir_ = system_temp_dir_;
164 temp_dir_ = temp_dir;
167 // The specification of home_dir_ is fixed for a given OS.
168 // A typical example on Windows: "C:/Documents and Settings/USERNAME"
169 // and on a Posix-like machine: "/home/USERNAME".
170 FileName const & Package::get_home_dir()
172 #if defined (USE_WINDOWS_PACKAGING)
173 static FileName const home_dir(getEnv("USERPROFILE"));
174 #elif defined (USE_MACOSX_PACKAGING)
175 static FileName const home_dir(fromqstr(QDir::homePath()));
177 static FileName const home_dir(getEnv("HOME"));
185 // These next functions contain the stuff that is substituted at
186 // configuration-time.
187 FileName const hardcoded_localedir()
190 // The build system needs to make sure that this is in utf8 encoding.
191 return FileName(LYX_ABS_INSTALLED_LOCALEDIR);
195 FileName const hardcoded_system_support_dir()
198 // The build system needs to make sure that this is in utf8 encoding.
199 return FileName(LYX_ABS_INSTALLED_DATADIR);
203 string const & with_version_suffix()
205 static string const program_suffix = PROGRAM_SUFFIX;
206 static string const with_version_suffix =
207 " --with-version-suffix=" PROGRAM_SUFFIX;
208 return program_suffix.empty() ? program_suffix : with_version_suffix;
214 FileName const & Package::top_srcdir()
217 // The build system needs to make sure that this is in utf8 encoding.
218 static FileName const dir(LYX_ABS_TOP_SRCDIR);
225 bool check_command_line_dir(string const & dir,
227 string const & command_line_switch);
229 FileName const extract_env_var_dir(string const & env_var);
231 bool check_env_var_dir(FileName const & dir,
232 string const & env_var);
234 bool check_env_var_dir(FileName const & dir,
236 string const & env_var);
238 string const relative_locale_dir();
240 string const relative_system_support_dir();
244 * Convert \p name to internal path and strip a trailing slash, since it
245 * comes from user input (commandline or environment).
246 * \p name is encoded in utf8.
248 string const fix_dir_name(string const & name)
250 return rtrim(os::internal_path(name), "/");
255 bool isBuildDir(FileName const & abs_binary, string const & dir_location,
256 FileName & build_support_dir)
258 string search_dir = onlyPath(abs_binary.absFileName()) + dir_location;
260 // Makefile by automake
261 build_support_dir = FileName(addPath(search_dir, "lib"));
262 if (!fileSearch(build_support_dir.absFileName(), "Makefile").empty()) {
265 // cmake file, no Makefile in lib
266 FileName build_boost_dir = FileName(addPath(search_dir, "boost"));
267 if (!fileSearch(build_boost_dir.absFileName(), "cmake_install.cmake").empty()) {
274 bool inBuildDir(FileName const & abs_binary,
275 FileName & build_support_dir, FileName & system_support_dir)
277 string const check_text = "Checking whether LyX is run in place...";
279 // We're looking for "Makefile" in a directory
281 // We're also looking for "chkconfig.ltx" in a directory
283 // If both are found, then we're running LyX in-place.
285 // Note that the name of the lyx binary may be a symbolic link.
286 // If that is the case, then we follow the links too.
287 FileName binary = abs_binary;
289 // Try and find "lyxrc.defaults".
290 if( isBuildDir(binary, "../", build_support_dir) ||
291 isBuildDir(binary, "../../", build_support_dir))
293 // Try and find "chkconfig.ltx".
295 FileName(addPath(Package::top_srcdir().absFileName(), "lib"));
297 if (!fileSearch(system_support_dir.absFileName(), "chkconfig.ltx").empty()) {
298 LYXERR(Debug::INIT, check_text << " yes");
303 // Check whether binary is a symbolic link.
304 // If so, resolve it and repeat the exercise.
305 if (!binary.isSymLink())
309 if (readLink(binary, link)) {
312 // Unable to resolve the link.
317 LYXERR(Debug::INIT, check_text << " no");
318 system_support_dir = FileName();
319 build_support_dir = FileName();
325 bool doesFileExist(FileName & result, string const & search_dir, string const & name)
327 result = fileSearch(search_dir, name);
328 if (!result.empty()) {
335 bool lyxBinaryPath(FileName & lyx_binary, string const & search_dir, string const & ext)
337 lyx_binary = FileName();
339 } else if (doesFileExist(lyx_binary, search_dir, "lyx" + ext)) {
340 } else if (doesFileExist(lyx_binary, search_dir, "LyX" + ext)) {
341 } else if (doesFileExist(lyx_binary, search_dir, "lyx" + string(PROGRAM_SUFFIX) + ext)) {
342 } else if (doesFileExist(lyx_binary, search_dir, "LyX" + string(PROGRAM_SUFFIX) + ext)){
344 return !lyx_binary.empty() ? true : false;
348 FileName findLyxBinary(FileName const & abs_binary)
351 if (!abs_binary.extension().empty()) {
352 ext = "." + abs_binary.extension();
355 string binary_dir = onlyPath(abs_binary.absFileName());
358 if (lyxBinaryPath(lyx_binary, binary_dir, ext))
361 string search_dir = onlyPath(FileName(addPath(binary_dir, "/../")).absFileName());
362 if (lyxBinaryPath(lyx_binary, search_dir, ext))
369 // Specification of document_dir_ may be reset by LyXRC,
370 // but the default is fixed for a given OS.
371 FileName const get_document_dir(FileName const & home_dir)
373 #if defined (USE_WINDOWS_PACKAGING)
374 (void)home_dir; // Silence warning about unused variable.
375 os::GetFolderPath win32_folder_path;
376 return FileName(win32_folder_path(os::GetFolderPath::PERSONAL));
377 #elif defined (USE_MACOSX_PACKAGING)
378 (void)home_dir; // Silence warning about unused variable.
379 return FileName(fromqstr(QDesktopServices::storageLocation(QDesktopServices::DocumentsLocation)));
387 // Several sources are probed to ascertain the locale directory.
388 // The only requirement is that the result is indeed a directory.
389 FileName const get_locale_dir(FileName const & system_support_dir)
391 // 1. Use the "LYX_LOCALEDIR" environment variable.
392 FileName const path_env = extract_env_var_dir("LYX_LOCALEDIR");
393 if (!path_env.empty() && check_env_var_dir(path_env, "LYX_LOCALEDIR"))
396 // 2. Search for system_support_dir / <relative locale dir>
397 // The <relative locale dir> is OS-dependent. (On Unix, it will
399 FileName path(addPath(system_support_dir.absFileName(),
400 relative_locale_dir()));
402 if (path.exists() && path.isDirectory())
405 // 3. Fall back to the hard-coded LOCALEDIR.
406 path = hardcoded_localedir();
407 if (path.exists() && path.isDirectory())
414 // Extracts the absolute path from the foo of "-sysdir foo" or "-userdir foo"
415 FileName const abs_path_from_command_line(string const & command_line)
417 if (command_line.empty())
420 string const str_path = fix_dir_name(command_line);
421 return makeAbsPath(str_path);
425 // Does the grunt work for abs_path_from_binary_name()
426 FileName const get_binary_path(string const & exe)
428 #if defined (USE_WINDOWS_PACKAGING)
429 // The executable may have been invoked either with or
430 // without the .exe extension.
431 // Ensure that it is present.
432 string const as_internal_path = os::internal_path(exe);
433 string const exe_path = suffixIs(as_internal_path, ".exe") ?
434 as_internal_path : as_internal_path + ".exe";
436 string const exe_path = os::internal_path(exe);
438 if (FileName::isAbsolute(exe_path))
439 return FileName(exe_path);
441 // Two possibilities present themselves.
442 // 1. The binary is relative to the CWD.
443 FileName const abs_exe_path = makeAbsPath(exe_path);
444 if (abs_exe_path.exists())
447 // 2. exe must be the name of the binary only and it
448 // can be found on the PATH.
449 string const exe_name = onlyFileName(exe_path);
450 if (exe_name != exe_path)
453 vector<string> const path = getEnvPath("PATH");
454 vector<string>::const_iterator it = path.begin();
455 vector<string>::const_iterator const end = path.end();
456 for (; it != end; ++it) {
457 // This will do nothing if *it is already absolute.
458 string const exe_dir = makeAbsPath(*it).absFileName();
460 FileName const exe_path(addName(exe_dir, exe_name));
461 if (exe_path.exists())
465 // Didn't find anything.
470 // Extracts the absolute path to the binary name received as argv[0].
471 FileName const abs_path_from_binary_name(string const & exe)
473 FileName const abs_binary = get_binary_path(exe);
474 if (abs_binary.empty()) {
476 throw ExceptionMessage(ErrorException,
477 _("LyX binary not found"),
478 bformat(_("Unable to determine the path to the LyX binary from the command line %1$s"),
485 // A plethora of directories is searched to ascertain the system
486 // lyxdir which is defined as the first directory to contain
489 get_system_support_dir(FileName const & abs_binary,
490 string const & command_line_system_support_dir)
492 string const chkconfig_ltx = "chkconfig.ltx";
494 // searched_dirs is used for diagnostic purposes only in the case
495 // that "chkconfig.ltx" is not found.
496 list<FileName> searched_dirs;
498 // 1. Use the -sysdir command line parameter.
499 FileName path = abs_path_from_command_line(command_line_system_support_dir);
501 searched_dirs.push_back(path);
502 if (check_command_line_dir(path.absFileName(), chkconfig_ltx, "-sysdir"))
506 // 2. Use the "LYX_DIR_${major}${minor}x" environment variable.
507 path = extract_env_var_dir(LYX_DIR_VER);
509 searched_dirs.push_back(path);
510 if (check_env_var_dir(path, chkconfig_ltx, LYX_DIR_VER))
514 // 3. Search relative to the lyx binary.
515 // We're looking for "chkconfig.ltx" in a directory
516 // OnlyPath(abs_binary) / <relative dir> / PACKAGE /
517 // PACKAGE is hardcoded in config.h. Eg "lyx" or "lyx-1.3.6cvs".
518 // <relative dir> is OS-dependent; on Unix, it will be "../share/".
519 string const relative_lyxdir = relative_system_support_dir();
521 // One subtlety to be aware of. The name of the lyx binary may be
522 // a symbolic link. If that is the case, then we follow the links too.
523 FileName binary = abs_binary;
525 // Try and find "chkconfig.ltx".
526 string const binary_dir = onlyPath(binary.absFileName());
528 FileName const lyxdir(addPath(binary_dir, relative_lyxdir));
529 searched_dirs.push_back(lyxdir);
531 if (!fileSearch(lyxdir.absFileName(), chkconfig_ltx).empty()) {
532 // Success! "chkconfig.ltx" has been found.
536 // Check whether binary is a symbolic link.
537 // If so, resolve it and repeat the exercise.
538 if (!binary.isSymLink())
542 if (readLink(binary, link)) {
545 // Unable to resolve the link.
550 // 4. Repeat the exercise on the directory itself.
551 FileName binary_dir(onlyPath(abs_binary.absFileName()));
553 // This time test whether the directory is a symbolic link
554 // *before* looking for "chkconfig.ltx".
555 // (We've looked relative to the original already.)
556 if (!binary.isSymLink())
560 if (readLink(binary_dir, link)) {
563 // Unable to resolve the link.
567 // Try and find "chkconfig.ltx".
568 FileName const lyxdir(addPath(binary_dir.absFileName(),
570 searched_dirs.push_back(lyxdir);
572 if (!fileSearch(lyxdir.absFileName(), chkconfig_ltx).empty()) {
573 // Success! "chkconfig.ltx" has been found.
578 // 5. In desparation, try the hard-coded system support dir.
579 path = hardcoded_system_support_dir();
580 if (!fileSearch(path.absFileName(), chkconfig_ltx).empty())
583 // Everything has failed :-(
584 // So inform the user and exit.
585 string searched_dirs_str;
586 typedef list<FileName>::const_iterator iterator;
587 iterator const begin = searched_dirs.begin();
588 iterator const end = searched_dirs.end();
589 for (iterator it = begin; it != end; ++it) {
591 searched_dirs_str += "\n\t";
592 searched_dirs_str += it->absFileName();
596 throw ExceptionMessage(ErrorException, _("No system directory"),
597 bformat(_("Unable to determine the system directory "
600 "Use the '-sysdir' command line parameter or "
601 "set the environment variable\n%2$s "
602 "to the LyX system directory containing the "
603 "file `chkconfig.ltx'."),
604 from_utf8(searched_dirs_str), from_ascii(LYX_DIR_VER)));
606 // Keep the compiler happy.
611 // Returns the absolute path to the user lyxdir, together with a flag
612 // indicating whether this directory was specified explicitly (as -userdir
613 // or through an environment variable) or whether it was deduced.
614 bool userSupportDir(FileName const & default_user_support_dir,
615 string const & command_line_user_support_dir, FileName & result)
617 // 1. Use the -userdir command line parameter.
618 result = abs_path_from_command_line(command_line_user_support_dir);
622 // 2. Use the LYX_USERDIR_${major}${minor}x environment variable.
623 result = extract_env_var_dir(LYX_USERDIR_VER);
627 // 3. Use the OS-dependent default_user_support_dir
628 result = default_user_support_dir;
633 // $HOME/.lyx on POSIX but on Win32 it will be something like
634 // "C:/Documents and Settings/USERNAME/Application Data/LyX"
635 FileName const get_default_user_support_dir(FileName const & home_dir)
637 #if defined (USE_WINDOWS_PACKAGING)
638 (void)home_dir; // Silence warning about unused variable.
640 os::GetFolderPath win32_folder_path;
641 return FileName(addPath(win32_folder_path(os::GetFolderPath::APPDATA), PACKAGE));
643 #elif defined (USE_MACOSX_PACKAGING)
644 (void)home_dir; // Silence warning about unused variable.
645 return FileName(addPath(fromqstr(QDesktopServices::storageLocation(QDesktopServices::DataLocation)), PACKAGE));
647 #else // USE_POSIX_PACKAGING
648 return FileName(addPath(home_dir.absFileName(), string(".") + PACKAGE));
653 // Check that directory @c dir contains @c file.
654 // Else emit an error message about an invalid @c command_line_switch.
655 bool check_command_line_dir(string const & dir,
657 string const & command_line_switch)
659 FileName const abs_path = fileSearch(dir, file);
660 if (abs_path.empty()) {
662 throw ExceptionMessage(ErrorException, _("File not found"), bformat(
663 _("Invalid %1$s switch.\nDirectory %2$s does not contain %3$s."),
664 from_utf8(command_line_switch), from_utf8(dir),
668 return !abs_path.empty();
672 // The environment variable @c env_var expands to a (single) file path.
673 FileName const extract_env_var_dir(string const & env_var)
675 string const dir = fix_dir_name(getEnv(env_var));
676 return dir.empty() ? FileName() : makeAbsPath(dir);
680 // Check that directory @c dir contains @c file.
681 // Else emit a warning about an invalid @c env_var.
682 bool check_env_var_dir(FileName const & dir,
684 string const & env_var)
686 FileName const abs_path = fileSearch(dir.absFileName(), file);
687 if (abs_path.empty()) {
689 throw ExceptionMessage(WarningException, _("File not found"), bformat(
690 _("Invalid %1$s environment variable.\n"
691 "Directory %2$s does not contain %3$s."),
692 from_utf8(env_var), from_utf8(dir.absFileName()),
696 return !abs_path.empty();
700 // Check that directory @c dir is indeed a directory.
701 // Else emit a warning about an invalid @c env_var.
702 bool check_env_var_dir(FileName const & dir,
703 string const & env_var)
705 bool const success = dir.exists() && dir.isDirectory();
708 // Put this string on a single line so that the gettext
709 // search mechanism in po/Makefile.in.in will register
710 // Package.cpp.in as a file containing strings that need
713 docstring const fmt =
714 _("Invalid %1$s environment variable.\n%2$s is not a directory.");
716 throw ExceptionMessage(WarningException, _("Directory not found"), bformat(
717 fmt, from_utf8(env_var), from_utf8(dir.absFileName())));
724 // The locale directory relative to the LyX system directory.
725 string const relative_locale_dir()
727 #if defined (USE_WINDOWS_PACKAGING) || defined (USE_MACOSX_PACKAGING)
735 // The system lyxdir is relative to the directory containing the LyX binary.
736 string const relative_system_support_dir()
740 #if defined (USE_WINDOWS_PACKAGING) || defined (USE_MACOSX_PACKAGING)
741 result = "../Resources/";
743 result = addPath("../share/", PACKAGE);
751 } // namespace support