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 LAPPERR(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 in_build_dir_ = inBuildDir(abs_binary, build_support_dir_, system_support_dir_);
124 if (!in_build_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() + " --binary-dir=" +
145 quoteName(FileName(binary_dir().absFileName()).toFilesystemEncoding());
147 LYXERR(Debug::INIT, "<package>\n"
148 << "\tbinary_dir " << binary_dir().absFileName() << '\n'
149 << "\tsystem_support " << system_support().absFileName() << '\n'
150 << "\tbuild_support " << build_support().absFileName() << '\n'
151 << "\tuser_support " << user_support().absFileName() << '\n'
152 << "\tlocale_dir " << locale_dir().absFileName() << '\n'
153 << "\tdocument_dir " << document_dir().absFileName() << '\n'
154 << "\ttemp_dir " << temp_dir().absFileName() << '\n'
155 << "\thome_dir " << get_home_dir().absFileName() << '\n'
160 void Package::set_temp_dir(FileName const & temp_dir) const
162 if (temp_dir.empty())
163 temp_dir_ = system_temp_dir_;
165 temp_dir_ = temp_dir;
169 FileName Package::messages_file(string const & c) const
172 FileName res = FileName(lyx_dir().absFileName() + "/po/"
174 if (!res.isReadableFile())
175 res = FileName(top_srcdir().absFileName() + "/po/"
181 return FileName(locale_dir_.absFileName() + "/" + c
182 + "/LC_MESSAGES/" PACKAGE ".mo");
186 // The specification of home_dir_ is fixed for a given OS.
187 // A typical example on Windows: "C:/Documents and Settings/USERNAME"
188 // and on a Posix-like machine: "/home/USERNAME".
189 FileName const & Package::get_home_dir()
191 #if defined (USE_WINDOWS_PACKAGING)
192 static FileName const home_dir(getEnv("USERPROFILE"));
193 #elif defined (USE_MACOSX_PACKAGING)
194 static FileName const home_dir(fromqstr(QDir::homePath()));
196 static FileName const home_dir(getEnv("HOME"));
204 // These next functions contain the stuff that is substituted at
205 // configuration-time.
206 FileName const hardcoded_localedir()
209 // The build system needs to make sure that this is in utf8 encoding.
210 return FileName(LYX_ABS_INSTALLED_LOCALEDIR);
214 FileName const hardcoded_system_support_dir()
217 // The build system needs to make sure that this is in utf8 encoding.
218 return FileName(LYX_ABS_INSTALLED_DATADIR);
222 string const & with_version_suffix()
224 static string const program_suffix = PROGRAM_SUFFIX;
225 static string const with_version_suffix =
226 " --with-version-suffix=" PROGRAM_SUFFIX;
227 return program_suffix.empty() ? program_suffix : with_version_suffix;
233 FileName const & Package::top_srcdir()
236 // The build system needs to make sure that this is in utf8 encoding.
237 static FileName const dir(LYX_ABS_TOP_SRCDIR);
244 bool check_command_line_dir(string const & dir,
246 string const & command_line_switch);
248 FileName const extract_env_var_dir(string const & env_var);
250 bool check_env_var_dir(FileName const & dir,
251 string const & env_var);
253 bool check_env_var_dir(FileName const & dir,
255 string const & env_var);
257 string const relative_locale_dir();
259 string const relative_system_support_dir();
263 * Convert \p name to internal path and strip a trailing slash, since it
264 * comes from user input (commandline or environment).
265 * \p name is encoded in utf8.
267 string const fix_dir_name(string const & name)
269 return rtrim(os::internal_path(name), "/");
274 bool isBuildDir(FileName const & abs_binary, string const & dir_location,
275 FileName & build_support_dir)
277 string search_dir = onlyPath(abs_binary.absFileName()) + dir_location;
279 // Makefile by automake
280 build_support_dir = FileName(addPath(search_dir, "lib"));
281 if (!fileSearch(build_support_dir.absFileName(), "Makefile").empty()) {
284 // cmake file, no Makefile in lib
285 FileName build_boost_dir = FileName(addPath(search_dir, "boost"));
286 if (!fileSearch(build_boost_dir.absFileName(), "cmake_install.cmake").empty()) {
293 bool inBuildDir(FileName const & abs_binary,
294 FileName & build_support_dir, FileName & system_support_dir)
296 string const check_text = "Checking whether LyX is run in place...";
298 // We're looking for "Makefile" in a directory
300 // We're also looking for "chkconfig.ltx" in a directory
302 // If both are found, then we're running LyX in-place.
304 // Note that the name of the lyx binary may be a symbolic link.
305 // If that is the case, then we follow the links too.
306 FileName binary = abs_binary;
308 // Try and find "lyxrc.defaults".
309 if( isBuildDir(binary, "../", build_support_dir) ||
310 isBuildDir(binary, "../../", build_support_dir))
312 // Try and find "chkconfig.ltx".
314 FileName(addPath(Package::top_srcdir().absFileName(), "lib"));
316 if (!fileSearch(system_support_dir.absFileName(), "chkconfig.ltx").empty()) {
317 LYXERR(Debug::INIT, check_text << " yes");
322 // Check whether binary is a symbolic link.
323 // If so, resolve it and repeat the exercise.
324 if (!binary.isSymLink())
328 if (readLink(binary, link)) {
331 // Unable to resolve the link.
336 LYXERR(Debug::INIT, check_text << " no");
337 system_support_dir = FileName();
338 build_support_dir = FileName();
344 bool doesFileExist(FileName & result, string const & search_dir, string const & name)
346 result = fileSearch(search_dir, name);
347 if (!result.empty()) {
354 bool lyxBinaryPath(FileName & lyx_binary, string const & search_dir, string const & ext)
356 lyx_binary = FileName();
358 } else if (doesFileExist(lyx_binary, search_dir, "lyx" + ext)) {
359 } else if (doesFileExist(lyx_binary, search_dir, "LyX" + ext)) {
360 } else if (doesFileExist(lyx_binary, search_dir, "lyx" + string(PROGRAM_SUFFIX) + ext)) {
361 } else if (doesFileExist(lyx_binary, search_dir, "LyX" + string(PROGRAM_SUFFIX) + ext)){
363 return !lyx_binary.empty() ? true : false;
367 FileName findLyxBinary(FileName const & abs_binary)
370 string checkname = abs_binary.toFilesystemEncoding();
371 int check_len = checkname.length();
372 int prgsuffixlen = string(PROGRAM_SUFFIX).length();
373 if ((prgsuffixlen > 0) && (check_len > prgsuffixlen) &&
374 (checkname.substr(check_len-prgsuffixlen) == string(PROGRAM_SUFFIX))) {
377 else if (!abs_binary.extension().empty()) {
378 ext = "." + abs_binary.extension();
381 string binary_dir = onlyPath(abs_binary.absFileName());
384 if (lyxBinaryPath(lyx_binary, binary_dir, ext))
387 string search_dir = onlyPath(FileName(addPath(binary_dir, "/../")).absFileName());
388 if (lyxBinaryPath(lyx_binary, search_dir, ext))
395 // Specification of document_dir_ may be reset by LyXRC,
396 // but the default is fixed for a given OS.
397 FileName const get_document_dir(FileName const & home_dir)
399 #if defined (USE_WINDOWS_PACKAGING)
400 (void)home_dir; // Silence warning about unused variable.
401 os::GetFolderPath win32_folder_path;
402 return FileName(win32_folder_path(os::GetFolderPath::PERSONAL));
403 #elif defined (USE_MACOSX_PACKAGING) && (QT_VERSION >= 0x050000)
404 (void)home_dir; // Silence warning about unused variable.
405 return FileName(fromqstr(QStandardPaths::writableLocation(QStandardPaths::DocumentsLocation)));
406 #elif defined (USE_MACOSX_PACKAGING)
407 (void)home_dir; // Silence warning about unused variable.
408 return FileName(fromqstr(QDesktopServices::storageLocation(QDesktopServices::DocumentsLocation)));
416 // Several sources are probed to ascertain the locale directory.
417 // The only requirement is that the result is indeed a directory.
418 FileName const get_locale_dir(FileName const & system_support_dir)
420 // 1. Use the "LYX_LOCALEDIR" environment variable.
421 FileName const path_env = extract_env_var_dir("LYX_LOCALEDIR");
422 if (!path_env.empty() && check_env_var_dir(path_env, "LYX_LOCALEDIR"))
425 // 2. Search for system_support_dir / <relative locale dir>
426 // The <relative locale dir> is OS-dependent. (On Unix, it will
428 FileName path(addPath(system_support_dir.absFileName(),
429 relative_locale_dir()));
431 if (path.exists() && path.isDirectory())
434 // 3. Fall back to the hard-coded LOCALEDIR.
435 path = hardcoded_localedir();
436 if (path.exists() && path.isDirectory())
443 // Extracts the absolute path from the foo of "-sysdir foo" or "-userdir foo"
444 FileName const abs_path_from_command_line(string const & command_line)
446 if (command_line.empty())
449 string const str_path = fix_dir_name(command_line);
450 return makeAbsPath(str_path);
454 // Does the grunt work for abs_path_from_binary_name()
455 FileName const get_binary_path(string const & exe)
457 #if defined (USE_WINDOWS_PACKAGING)
458 // The executable may have been invoked either with or
459 // without the .exe extension.
460 // Ensure that it is present.
461 string const as_internal_path = os::internal_path(exe);
462 string const exe_path = suffixIs(as_internal_path, ".exe") ?
463 as_internal_path : as_internal_path + ".exe";
465 string const exe_path = os::internal_path(exe);
467 if (FileName::isAbsolute(exe_path))
468 return FileName(exe_path);
470 // Two possibilities present themselves.
471 // 1. The binary is relative to the CWD.
472 FileName const abs_exe_path = makeAbsPath(exe_path);
473 if (abs_exe_path.exists())
476 // 2. exe must be the name of the binary only and it
477 // can be found on the PATH.
478 string const exe_name = onlyFileName(exe_path);
479 if (exe_name != exe_path)
482 vector<string> const path = getEnvPath("PATH");
483 vector<string>::const_iterator it = path.begin();
484 vector<string>::const_iterator const end = path.end();
485 for (; it != end; ++it) {
486 // This will do nothing if *it is already absolute.
487 string const exe_dir = makeAbsPath(*it).absFileName();
489 FileName const exe_path(addName(exe_dir, exe_name));
490 if (exe_path.exists())
494 // Didn't find anything.
499 // Extracts the absolute path to the binary name received as argv[0].
500 FileName const abs_path_from_binary_name(string const & exe)
502 FileName const abs_binary = get_binary_path(exe);
503 if (abs_binary.empty()) {
505 throw ExceptionMessage(ErrorException,
506 _("LyX binary not found"),
507 bformat(_("Unable to determine the path to the LyX binary from the command line %1$s"),
514 // A plethora of directories is searched to ascertain the system
515 // lyxdir which is defined as the first directory to contain
518 get_system_support_dir(FileName const & abs_binary,
519 string const & command_line_system_support_dir)
521 string const chkconfig_ltx = "chkconfig.ltx";
523 // searched_dirs is used for diagnostic purposes only in the case
524 // that "chkconfig.ltx" is not found.
525 list<FileName> searched_dirs;
527 // 1. Use the -sysdir command line parameter.
528 FileName path = abs_path_from_command_line(command_line_system_support_dir);
530 searched_dirs.push_back(path);
531 if (check_command_line_dir(path.absFileName(), chkconfig_ltx, "-sysdir"))
535 // 2. Use the "LYX_DIR_${major}${minor}x" environment variable.
536 path = extract_env_var_dir(LYX_DIR_VER);
538 searched_dirs.push_back(path);
539 if (check_env_var_dir(path, chkconfig_ltx, LYX_DIR_VER))
543 // 3. Search relative to the lyx binary.
544 // We're looking for "chkconfig.ltx" in a directory
545 // OnlyPath(abs_binary) / <relative dir> / PACKAGE /
546 // PACKAGE is hardcoded in config.h. Eg "lyx" or "lyx-1.3.6cvs".
547 // <relative dir> is OS-dependent; on Unix, it will be "../share/".
548 string const relative_lyxdir = relative_system_support_dir();
550 // One subtlety to be aware of. The name of the lyx binary may be
551 // a symbolic link. If that is the case, then we follow the links too.
552 FileName binary = abs_binary;
554 // Try and find "chkconfig.ltx".
555 string const binary_dir = onlyPath(binary.absFileName());
557 FileName const lyxdir(addPath(binary_dir, relative_lyxdir));
558 searched_dirs.push_back(lyxdir);
560 if (!fileSearch(lyxdir.absFileName(), chkconfig_ltx).empty()) {
561 // Success! "chkconfig.ltx" has been found.
565 // Check whether binary is a symbolic link.
566 // If so, resolve it and repeat the exercise.
567 if (!binary.isSymLink())
571 if (readLink(binary, link)) {
574 // Unable to resolve the link.
579 // 4. Repeat the exercise on the directory itself.
580 FileName binary_dir(onlyPath(abs_binary.absFileName()));
582 // This time test whether the directory is a symbolic link
583 // *before* looking for "chkconfig.ltx".
584 // (We've looked relative to the original already.)
585 if (!binary.isSymLink())
589 if (readLink(binary_dir, link)) {
592 // Unable to resolve the link.
596 // Try and find "chkconfig.ltx".
597 FileName const lyxdir(addPath(binary_dir.absFileName(),
599 searched_dirs.push_back(lyxdir);
601 if (!fileSearch(lyxdir.absFileName(), chkconfig_ltx).empty()) {
602 // Success! "chkconfig.ltx" has been found.
607 // 5. In desparation, try the hard-coded system support dir.
608 path = hardcoded_system_support_dir();
609 if (!fileSearch(path.absFileName(), chkconfig_ltx).empty())
612 // Everything has failed :-(
613 // So inform the user and exit.
614 string searched_dirs_str;
615 typedef list<FileName>::const_iterator iterator;
616 iterator const begin = searched_dirs.begin();
617 iterator const end = searched_dirs.end();
618 for (iterator it = begin; it != end; ++it) {
620 searched_dirs_str += "\n\t";
621 searched_dirs_str += it->absFileName();
625 throw ExceptionMessage(ErrorException, _("No system directory"),
626 bformat(_("Unable to determine the system directory "
629 "Use the '-sysdir' command line parameter or "
630 "set the environment variable\n%2$s "
631 "to the LyX system directory containing the "
632 "file `chkconfig.ltx'."),
633 from_utf8(searched_dirs_str), from_ascii(LYX_DIR_VER)));
635 // Keep the compiler happy.
640 // Returns the absolute path to the user lyxdir, together with a flag
641 // indicating whether this directory was specified explicitly (as -userdir
642 // or through an environment variable) or whether it was deduced.
643 bool userSupportDir(FileName const & default_user_support_dir,
644 string const & command_line_user_support_dir, FileName & result)
646 // 1. Use the -userdir command line parameter.
647 result = abs_path_from_command_line(command_line_user_support_dir);
651 // 2. Use the LYX_USERDIR_${major}${minor}x environment variable.
652 result = extract_env_var_dir(LYX_USERDIR_VER);
656 // 3. Use the OS-dependent default_user_support_dir
657 result = default_user_support_dir;
662 // $HOME/.lyx on POSIX but on Win32 it will be something like
663 // "C:/Documents and Settings/USERNAME/Application Data/LyX"
664 FileName const get_default_user_support_dir(FileName const & home_dir)
666 #if defined (USE_WINDOWS_PACKAGING)
667 (void)home_dir; // Silence warning about unused variable.
669 os::GetFolderPath win32_folder_path;
670 return FileName(addPath(win32_folder_path(os::GetFolderPath::APPDATA), PACKAGE));
672 #elif defined (USE_MACOSX_PACKAGING) && (QT_VERSION >= 0x050000)
673 (void)home_dir; // Silence warning about unused variable.
674 return FileName(addPath(fromqstr(QStandardPaths::writableLocation(QStandardPaths::DataLocation)), PACKAGE));
676 #elif defined (USE_MACOSX_PACKAGING)
677 (void)home_dir; // Silence warning about unused variable.
678 return FileName(addPath(fromqstr(QDesktopServices::storageLocation(QDesktopServices::DataLocation)), PACKAGE));
680 #else // USE_POSIX_PACKAGING
681 return FileName(addPath(home_dir.absFileName(), string(".") + PACKAGE));
686 // Check that directory @c dir contains @c file.
687 // Else emit an error message about an invalid @c command_line_switch.
688 bool check_command_line_dir(string const & dir,
690 string const & command_line_switch)
692 FileName const abs_path = fileSearch(dir, file);
693 if (abs_path.empty()) {
695 throw ExceptionMessage(ErrorException, _("File not found"), bformat(
696 _("Invalid %1$s switch.\nDirectory %2$s does not contain %3$s."),
697 from_utf8(command_line_switch), from_utf8(dir),
701 return !abs_path.empty();
705 // The environment variable @c env_var expands to a (single) file path.
706 FileName const extract_env_var_dir(string const & env_var)
708 string const dir = fix_dir_name(getEnv(env_var));
709 return dir.empty() ? FileName() : makeAbsPath(dir);
713 // Check that directory @c dir contains @c file.
714 // Else emit a warning about an invalid @c env_var.
715 bool check_env_var_dir(FileName const & dir,
717 string const & env_var)
719 FileName const abs_path = fileSearch(dir.absFileName(), file);
720 if (abs_path.empty()) {
722 throw ExceptionMessage(WarningException, _("File not found"), bformat(
723 _("Invalid %1$s environment variable.\n"
724 "Directory %2$s does not contain %3$s."),
725 from_utf8(env_var), from_utf8(dir.absFileName()),
729 return !abs_path.empty();
733 // Check that directory @c dir is indeed a directory.
734 // Else emit a warning about an invalid @c env_var.
735 bool check_env_var_dir(FileName const & dir,
736 string const & env_var)
738 bool const success = dir.exists() && dir.isDirectory();
741 // Put this string on a single line so that the gettext
742 // search mechanism in po/Makefile.in.in will register
743 // Package.cpp.in as a file containing strings that need
746 docstring const fmt =
747 _("Invalid %1$s environment variable.\n%2$s is not a directory.");
749 throw ExceptionMessage(WarningException, _("Directory not found"), bformat(
750 fmt, from_utf8(env_var), from_utf8(dir.absFileName())));
757 // The locale directory relative to the LyX system directory.
758 string const relative_locale_dir()
760 #if defined (USE_WINDOWS_PACKAGING) || defined (USE_MACOSX_PACKAGING)
768 // The system lyxdir is relative to the directory containing the LyX binary.
769 string const relative_system_support_dir()
773 #if defined (USE_WINDOWS_PACKAGING) || defined (USE_MACOSX_PACKAGING)
774 result = "../Resources/";
776 result = addPath("../share/", PACKAGE);
784 } // namespace support