src/support/Package.cpp

   1 // -*- C++ -*-
   2 /**
   3  * \file package.cpp
   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
  12 #include <config.h>
  13
  14 #include "support/Package.h"
  15
  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"
  24 #include "support/PathChanger.h"
  25 #include "support/Systemcall.h"
  26
  27 #if defined (USE_WINDOWS_PACKAGING)
  28 # include "support/os_win32.h"
  29 #endif
  30
  31
  32 #include <iostream>
  33 #include <list>
  34
  35 #if !defined (USE_WINDOWS_PACKAGING) && \
  36     !defined (USE_MACOSX_PACKAGING) && \
  37     !defined (USE_HAIKU_PACKAGING) && \
  38     !defined (USE_POSIX_PACKAGING)
  39 #error USE_FOO_PACKAGING must be defined for FOO = WINDOWS, MACOSX, HAIKU or POSIX.
  40 #endif
  41
  42 #if defined (USE_MACOSX_PACKAGING)
  43 # include "support/qstring_helpers.h"
  44 # include <QDir>
  45 # include <QDesktopServices>
  46 #endif
  47
  48 using namespace std;
  49
  50 namespace lyx {
  51 namespace support {
  52
  53 namespace {
  54
  55 Package package_;
  56 bool initialised_ = false;
  57
  58 } // namespace
  59
  60
  61 void init_package(string const & command_line_arg0,
  62                   string const & command_line_system_support_dir,
  63                   string const & command_line_user_support_dir)
  64 {
  65         package_ = Package(command_line_arg0,
  66                            command_line_system_support_dir,
  67                            command_line_user_support_dir);
  68         initialised_ = true;
  69 }
  70
  71
  72 Package const & package()
  73 {
  74         LAPPERR(initialised_);
  75         return package_;
  76 }
  77
  78
  79 namespace {
  80
  81 FileName const abs_path_from_binary_name(string const & exe);
  82
  83
  84 bool inBuildDir(FileName const & abs_binary, FileName &, FileName &);
  85
  86 FileName findLyxBinary(FileName const & abs_binary);
  87
  88 FileName const get_document_dir(FileName const & home_dir);
  89
  90 FileName const get_locale_dir(FileName const & system_support_dir);
  91
  92 FileName const get_system_support_dir(FileName const & abs_binary,
  93                                     string const & command_line_system_support_dir);
  94
  95 FileName const get_default_user_support_dir(FileName const & home_dir);
  96
  97 bool userSupportDir(FileName const & default_user_support_dir,
  98                      string const & command_line_user_support_dir, FileName & result);
  99
 100 string const & with_version_suffix();
 101
 102 string const fix_dir_name(string const & name);
 103
 104 } // namespace
 105
 106
 107 Package::Package(string const & command_line_arg0,
 108                  string const & command_line_system_support_dir,
 109                  string const & command_line_user_support_dir)
 110         : explicit_user_support_dir_(false)
 111 {
 112         // Specification of temp_dir_ may be reset by LyXRC,
 113         // but the default is fixed for a given OS.
 114         system_temp_dir_ = FileName::tempPath();
 115         temp_dir_ = system_temp_dir_;
 116         document_dir_ = get_document_dir(get_home_dir());
 117
 118         FileName const abs_binary = abs_path_from_binary_name(command_line_arg0);
 119         binary_dir_ = FileName(onlyPath(abs_binary.absFileName()));
 120
 121         // the LyX package directory
 122         lyx_dir_ = FileName(addPath(binary_dir_.absFileName(), "../"));
 123         lyx_dir_ = FileName(lyx_dir_.realPath());
 124
 125         // Is LyX being run in-place from the build tree?
 126         in_build_dir_ = inBuildDir(abs_binary, build_support_dir_, system_support_dir_);
 127
 128         if (!in_build_dir_) {
 129                 system_support_dir_ =
 130                         get_system_support_dir(abs_binary,
 131                                                command_line_system_support_dir);
 132         }
 133
 134         // Find the LyX executable
 135         lyx_binary_ = findLyxBinary(abs_binary);
 136
 137         locale_dir_ = get_locale_dir(system_support_dir_);
 138
 139         FileName const default_user_support_dir =
 140                 get_default_user_support_dir(get_home_dir());
 141
 142         explicit_user_support_dir_ = userSupportDir(default_user_support_dir,
 143                                      command_line_user_support_dir, user_support_dir_);
 144
 145
 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'
 155                 << "</package>\n");
 156 }
 157
 158
 159 int Package::reconfigureUserLyXDir(string const & option) const
 160 {
 161         if (configure_command_.empty()) {
 162                 FileName const configure_script(addName(system_support().absFileName(), "configure.py"));
 163                 configure_command_ = os::python() + ' ' +
 164                         quoteName(configure_script.toFilesystemEncoding()) +
 165                         with_version_suffix() + " --binary-dir=" +
 166                         quoteName(FileName(binary_dir().absFileName()).toFilesystemEncoding());
 167         }
 168
 169         lyxerr << to_utf8(_("LyX: reconfiguring user directory")) << endl;
 170         PathChanger p(user_support());
 171         Systemcall one;
 172         int const ret = one.startscript(Systemcall::Wait, configure_command_ + option);
 173         lyxerr << "LyX: " << to_utf8(_("Done!")) << endl;
 174         return ret;
 175 }
 176
 177
 178 string Package::getConfigureLockName() const
 179 {
 180         return addName(user_support().absFileName(), ".lyx_configure_lock");
 181 }
 182
 183
 184 void Package::set_temp_dir(FileName const & temp_dir) const
 185 {
 186         if (temp_dir.empty())
 187                 temp_dir_ = system_temp_dir_;
 188         else
 189                 temp_dir_ = temp_dir;
 190 }
 191
 192
 193 FileName Package::messages_file(string const & c) const
 194 {
 195         if (in_build_dir_) {
 196                 FileName res = FileName(lyx_dir().absFileName() + "/po/" + c + ".gmo");
 197                 if (!res.isReadableFile())
 198                         res = FileName(lyx_dir().absFileName() + "../po/" + c + ".gmo");
 199                 if (!res.isReadableFile())
 200                         res = FileName(top_srcdir().absFileName() + "/po/" + c + ".gmo");
 201                 return res;
 202         } else
 203                 return FileName(locale_dir_.absFileName() + "/" + c
 204                         + "/LC_MESSAGES/" PACKAGE ".mo");
 205 }
 206
 207
 208 // The specification of home_dir_ is fixed for a given OS.
 209 // A typical example on Windows: "C:/Documents and Settings/USERNAME"
 210 // and on a Posix-like machine: "/home/USERNAME".
 211 FileName const & Package::get_home_dir()
 212 {
 213 #if defined (USE_WINDOWS_PACKAGING)
 214         static FileName const home_dir(getEnv("USERPROFILE"));
 215 #elif defined (USE_MACOSX_PACKAGING)
 216         static FileName const home_dir(fromqstr(QDir::homePath()));
 217 #else // Posix-like.
 218         static FileName const home_dir(getEnv("HOME"));
 219 #endif
 220         return home_dir;
 221 }
 222
 223
 224 namespace {
 225
 226 // These next functions contain the stuff that is substituted at
 227 // configuration-time.
 228 FileName const hardcoded_localedir()
 229 {
 230         // FIXME UNICODE
 231         // The build system needs to make sure that this is in utf8 encoding.
 232         return FileName(LYX_ABS_INSTALLED_LOCALEDIR);
 233 }
 234
 235
 236 FileName const hardcoded_system_support_dir()
 237 {
 238         // FIXME UNICODE
 239         // The build system needs to make sure that this is in utf8 encoding.
 240         return FileName(LYX_ABS_INSTALLED_DATADIR);
 241 }
 242
 243
 244 string const & with_version_suffix()
 245 {
 246         static string const program_suffix = PROGRAM_SUFFIX;
 247         static string const with_version_suffix =
 248                 " --with-version-suffix=" PROGRAM_SUFFIX;
 249         return program_suffix.empty() ? program_suffix : with_version_suffix;
 250 }
 251
 252 } // namespace
 253
 254
 255 FileName const & Package::top_srcdir()
 256 {
 257         // FIXME UNICODE
 258         // The build system needs to make sure that this is in utf8 encoding.
 259         static FileName const dir(LYX_ABS_TOP_SRCDIR);
 260         return dir;
 261 }
 262
 263
 264 namespace {
 265
 266 bool check_command_line_dir(string const & dir,
 267                             string const & file,
 268                             string const & command_line_switch);
 269
 270 FileName const extract_env_var_dir(string const & env_var);
 271
 272 bool check_env_var_dir(FileName const & dir,
 273                        string const & env_var);
 274
 275 bool check_env_var_dir(FileName const & dir,
 276                        string const & file,
 277                        string const & env_var);
 278
 279 string const relative_locale_dir();
 280
 281 string const relative_system_support_dir();
 282
 283
 284 /**
 285  * Convert \p name to internal path and strip a trailing slash, since it
 286  * comes from user input (commandline or environment).
 287  * \p name is encoded in utf8.
 288  */
 289 string const fix_dir_name(string const & name)
 290 {
 291         return rtrim(os::internal_path(name), "/");
 292 }
 293
 294
 295
 296 bool isBuildDir(FileName const & abs_binary, string const & dir_location,
 297         FileName & build_support_dir)
 298 {
 299     string search_dir = onlyPath(abs_binary.absFileName()) + dir_location;
 300
 301     // Makefile by automake
 302     build_support_dir = FileName(addPath(search_dir, "lib"));
 303     if (!fileSearch(build_support_dir.absFileName(), "Makefile").empty()) {
 304         return true;
 305     }
 306     //  cmake file, no Makefile in lib
 307     FileName build_src_dir = FileName(addPath(search_dir, "src"));
 308     if (!fileSearch(build_src_dir.absFileName(), "cmake_install.cmake").empty()) {
 309         return true;
 310     }
 311
 312     return false;
 313 }
 314
 315 bool inBuildDir(FileName const & abs_binary,
 316         FileName & build_support_dir, FileName & system_support_dir)
 317 {
 318         string const check_text = "Checking whether LyX is run in place...";
 319
 320         // We're looking for "Makefile" in a directory
 321         //   binary_dir/../lib
 322         // We're also looking for "chkconfig.ltx" in a directory
 323         //   top_srcdir()/lib
 324         // If both are found, then we're running LyX in-place.
 325
 326         // Note that the name of the lyx binary may be a symbolic link.
 327         // If that is the case, then we follow the links too.
 328         FileName binary = abs_binary;
 329         while (true) {
 330                 // Try and find "lyxrc.defaults".
 331                 if ( isBuildDir(binary, "../", build_support_dir)
 332                     || isBuildDir(binary, "../../", build_support_dir))
 333                 {
 334                         // Try and find "chkconfig.ltx".
 335                         system_support_dir =
 336                                 FileName(addPath(Package::top_srcdir().absFileName(), "lib"));
 337
 338                         if (!fileSearch(system_support_dir.absFileName(), "chkconfig.ltx").empty()) {
 339                                 LYXERR(Debug::INIT, check_text << " yes");
 340                                 return true;
 341                         }
 342                 }
 343
 344                 // Check whether binary is a symbolic link.
 345                 // If so, resolve it and repeat the exercise.
 346                 if (!binary.isSymLink())
 347                         break;
 348
 349                 FileName link;
 350                 if (readLink(binary, link)) {
 351                         binary = link;
 352                 } else {
 353                         // Unable to resolve the link.
 354                         break;
 355                 }
 356         }
 357
 358         LYXERR(Debug::INIT, check_text << " no");
 359         system_support_dir = FileName();
 360         build_support_dir = FileName();
 361
 362         return false;
 363 }
 364
 365
 366 bool doesFileExist(FileName & result, string const & search_dir, string const & name)
 367 {
 368     result = fileSearch(search_dir, name);
 369     return !result.empty();
 370 }
 371
 372
 373 bool lyxBinaryPath(FileName & lyx_binary, string const & search_dir, string const & ext)
 374 {
 375     lyx_binary = FileName();
 376     if(false) {
 377     } else if (doesFileExist(lyx_binary, search_dir, "lyx" + ext)) {
 378     } else if (doesFileExist(lyx_binary, search_dir, "LyX" + ext)) {
 379     } else if (doesFileExist(lyx_binary, search_dir, "lyx" + string(PROGRAM_SUFFIX) + ext)) {
 380     } else if (doesFileExist(lyx_binary, search_dir, "LyX" + string(PROGRAM_SUFFIX) + ext)){
 381     }
 382     return !lyx_binary.empty();
 383 }
 384
 385
 386 FileName findLyxBinary(FileName const & abs_binary)
 387 {
 388     string ext;
 389     string checkname = abs_binary.toFilesystemEncoding();
 390     int check_len = checkname.length();
 391     int prgsuffixlen = string(PROGRAM_SUFFIX).length();
 392     if ((prgsuffixlen > 0) && (check_len > prgsuffixlen) &&
 393        (checkname.substr(check_len-prgsuffixlen) == string(PROGRAM_SUFFIX))) {
 394         ext = "";
 395     }
 396     else if (!abs_binary.extension().empty()) {
 397         ext = "." + abs_binary.extension();
 398     }
 399
 400     string binary_dir = onlyPath(abs_binary.absFileName());
 401
 402     FileName lyx_binary;
 403     if (lyxBinaryPath(lyx_binary, binary_dir, ext))
 404         return lyx_binary;
 405
 406     string search_dir = onlyPath(FileName(addPath(binary_dir, "/../")).absFileName());
 407     if (lyxBinaryPath(lyx_binary, search_dir, ext))
 408         return lyx_binary;
 409
 410     return FileName();
 411 }
 412
 413
 414 // Specification of document_dir_ may be reset by LyXRC,
 415 // but the default is fixed for a given OS.
 416 FileName const get_document_dir(FileName const & home_dir)
 417 {
 418 #if defined (USE_WINDOWS_PACKAGING)
 419         (void)home_dir; // Silence warning about unused variable.
 420         os::GetFolderPath win32_folder_path;
 421         return FileName(win32_folder_path(os::GetFolderPath::PERSONAL));
 422 #elif defined (USE_MACOSX_PACKAGING) && (QT_VERSION >= 0x050000)
 423         (void)home_dir; // Silence warning about unused variable.
 424         return FileName(fromqstr(QStandardPaths::writableLocation(QStandardPaths::DocumentsLocation)));
 425 #elif defined (USE_MACOSX_PACKAGING)
 426         (void)home_dir; // Silence warning about unused variable.
 427         return FileName(fromqstr(QDesktopServices::storageLocation(QDesktopServices::DocumentsLocation)));
 428 #else // Posix-like.
 429         return home_dir;
 430 #endif
 431 }
 432
 433
 434
 435 // Several sources are probed to ascertain the locale directory.
 436 // The only requirement is that the result is indeed a directory.
 437 FileName const get_locale_dir(FileName const & system_support_dir)
 438 {
 439         // 1. Use the "LYX_LOCALEDIR" environment variable.
 440         FileName const path_env = extract_env_var_dir("LYX_LOCALEDIR");
 441         if (!path_env.empty() && check_env_var_dir(path_env, "LYX_LOCALEDIR"))
 442                 return path_env;
 443
 444         // 2. Search for system_support_dir / <relative locale dir>
 445         // The <relative locale dir> is OS-dependent. (On Unix, it will
 446         // be "../locale/".)
 447         FileName path(addPath(system_support_dir.absFileName(),
 448                 relative_locale_dir()));
 449
 450         if (path.exists() && path.isDirectory())
 451                 return path;
 452
 453         // 3. Fall back to the hard-coded LOCALEDIR.
 454         path = hardcoded_localedir();
 455         if (path.exists() && path.isDirectory())
 456                 return path;
 457
 458         return FileName();
 459 }
 460
 461
 462 // Extracts the absolute path from the foo of "-sysdir foo" or "-userdir foo"
 463 FileName const abs_path_from_command_line(string const & command_line)
 464 {
 465         if (command_line.empty())
 466                 return FileName();
 467
 468         string const str_path = fix_dir_name(command_line);
 469         return makeAbsPath(str_path);
 470 }
 471
 472
 473 // Does the grunt work for abs_path_from_binary_name()
 474 FileName const get_binary_path(string const & exe)
 475 {
 476 #if defined (USE_WINDOWS_PACKAGING)
 477         // The executable may have been invoked either with or
 478         // without the .exe extension.
 479         // Ensure that it is present.
 480         string const as_internal_path = os::internal_path(exe);
 481         string const exe_path = suffixIs(as_internal_path, ".exe") ?
 482                 as_internal_path : as_internal_path + ".exe";
 483 #else
 484         string const exe_path = os::internal_path(exe);
 485 #endif
 486         if (FileName::isAbsolute(exe_path))
 487                 return FileName(exe_path);
 488
 489         // Two possibilities present themselves.
 490         // 1. The binary is relative to the CWD.
 491         FileName const abs_exe_path = makeAbsPath(exe_path);
 492         if (abs_exe_path.exists())
 493                 return abs_exe_path;
 494
 495         // 2. exe must be the name of the binary only and it
 496         // can be found on the PATH.
 497         string const exe_name = onlyFileName(exe_path);
 498         if (exe_name != exe_path)
 499                 return FileName();
 500
 501         vector<string> const path = getEnvPath("PATH");
 502         vector<string>::const_iterator it = path.begin();
 503         vector<string>::const_iterator const end = path.end();
 504         for (; it != end; ++it) {
 505                 // This will do nothing if *it is already absolute.
 506                 string const exe_dir = makeAbsPath(*it).absFileName();
 507
 508                 FileName const exe_path2(addName(exe_dir, exe_name));
 509                 if (exe_path2.exists())
 510                         return exe_path2;
 511         }
 512
 513         // Didn't find anything.
 514         return FileName();
 515 }
 516
 517
 518 // Extracts the absolute path to the binary name received as argv[0].
 519 FileName const abs_path_from_binary_name(string const & exe)
 520 {
 521         FileName const abs_binary = get_binary_path(exe);
 522         if (abs_binary.empty()) {
 523                 // FIXME UNICODE
 524                 throw ExceptionMessage(ErrorException,
 525                         _("LyX binary not found"),
 526                         bformat(_("Unable to determine the path to the LyX binary from the command line %1$s"),
 527                                 from_utf8(exe)));
 528         }
 529         return abs_binary;
 530 }
 531
 532
 533 // A plethora of directories is searched to ascertain the system
 534 // lyxdir which is defined as the first directory to contain
 535 // "chkconfig.ltx".
 536 FileName const
 537 get_system_support_dir(FileName const & abs_binary,
 538                   string const & command_line_system_support_dir)
 539 {
 540         string const chkconfig_ltx = "chkconfig.ltx";
 541
 542         // searched_dirs is used for diagnostic purposes only in the case
 543         // that "chkconfig.ltx" is not found.
 544         list<FileName> searched_dirs;
 545
 546         // 1. Use the -sysdir command line parameter.
 547         FileName path = abs_path_from_command_line(command_line_system_support_dir);
 548         if (!path.empty()) {
 549                 searched_dirs.push_back(path);
 550                 if (check_command_line_dir(path.absFileName(), chkconfig_ltx, "-sysdir"))
 551                         return path;
 552         }
 553
 554         // 2. Use the "LYX_DIR_${major}${minor}x" environment variable.
 555         path = extract_env_var_dir(LYX_DIR_VER);
 556         if (!path.empty()) {
 557                 searched_dirs.push_back(path);
 558                 if (check_env_var_dir(path, chkconfig_ltx, LYX_DIR_VER))
 559                         return path;
 560         }
 561
 562         // 3. Search relative to the lyx binary.
 563         // We're looking for "chkconfig.ltx" in a directory
 564         //   OnlyPath(abs_binary) / <relative dir> / PACKAGE /
 565         // PACKAGE is hardcoded in config.h. Eg "lyx" or "lyx-1.3.6cvs".
 566         // <relative dir> is OS-dependent; on Unix, it will be "../share/".
 567         string const relative_lyxdir = relative_system_support_dir();
 568
 569         // One subtlety to be aware of. The name of the lyx binary may be
 570         // a symbolic link. If that is the case, then we follow the links too.
 571         FileName binary = abs_binary;
 572         while (true) {
 573                 // Try and find "chkconfig.ltx".
 574                 string const binary_dir = onlyPath(binary.absFileName());
 575
 576                 FileName const lyxdir(addPath(binary_dir, relative_lyxdir));
 577                 searched_dirs.push_back(lyxdir);
 578
 579                 if (!fileSearch(lyxdir.absFileName(), chkconfig_ltx).empty()) {
 580                         // Success! "chkconfig.ltx" has been found.
 581                         return lyxdir;
 582                 }
 583
 584                 // Check whether binary is a symbolic link.
 585                 // If so, resolve it and repeat the exercise.
 586                 if (!binary.isSymLink())
 587                         break;
 588
 589                 FileName link;
 590                 if (readLink(binary, link)) {
 591                         binary = link;
 592                 } else {
 593                         // Unable to resolve the link.
 594                         break;
 595                 }
 596         }
 597
 598         // 4. Repeat the exercise on the directory itself.
 599         FileName binary_dir(onlyPath(abs_binary.absFileName()));
 600         while (true) {
 601                 // This time test whether the directory is a symbolic link
 602                 // *before* looking for "chkconfig.ltx".
 603                 // (We've looked relative to the original already.)
 604                 if (!binary.isSymLink())
 605                         break;
 606
 607                 FileName link;
 608                 if (readLink(binary_dir, link)) {
 609                         binary_dir = link;
 610                 } else {
 611                         // Unable to resolve the link.
 612                         break;
 613                 }
 614
 615                 // Try and find "chkconfig.ltx".
 616                 FileName const lyxdir(addPath(binary_dir.absFileName(),
 617                         relative_lyxdir));
 618                 searched_dirs.push_back(lyxdir);
 619
 620                 if (!fileSearch(lyxdir.absFileName(), chkconfig_ltx).empty()) {
 621                         // Success! "chkconfig.ltx" has been found.
 622                         return lyxdir;
 623                 }
 624         }
 625
 626         // 5. In desparation, try the hard-coded system support dir.
 627         path = hardcoded_system_support_dir();
 628         if (!fileSearch(path.absFileName(), chkconfig_ltx).empty())
 629                 return path;
 630
 631         // Everything has failed :-(
 632         // So inform the user and exit.
 633         string searched_dirs_str;
 634         typedef list<FileName>::const_iterator iterator;
 635         iterator const begin = searched_dirs.begin();
 636         iterator const end = searched_dirs.end();
 637         for (iterator it = begin; it != end; ++it) {
 638                 if (it != begin)
 639                         searched_dirs_str += "\n\t";
 640                 searched_dirs_str += it->absFileName();
 641         }
 642
 643         // FIXME UNICODE
 644         throw ExceptionMessage(ErrorException, _("No system directory"),
 645                 bformat(_("Unable to determine the system directory "
 646                                 "having searched\n"
 647                                 "\t%1$s\n"
 648                                 "Use the '-sysdir' command line parameter or "
 649                                 "set the environment variable\n%2$s "
 650                                 "to the LyX system directory containing the "
 651                                 "file `chkconfig.ltx'."),
 652                           from_utf8(searched_dirs_str), from_ascii(LYX_DIR_VER)));
 653 }
 654
 655
 656 // Returns the absolute path to the user lyxdir, together with a flag
 657 // indicating whether this directory was specified explicitly (as -userdir
 658 // or through an environment variable) or whether it was deduced.
 659 bool userSupportDir(FileName const & default_user_support_dir,
 660         string const & command_line_user_support_dir, FileName & result)
 661 {
 662         // 1. Use the -userdir command line parameter.
 663         result = abs_path_from_command_line(command_line_user_support_dir);
 664         if (!result.empty())
 665                 return true;
 666
 667         // 2. Use the LYX_USERDIR_${major}${minor}x environment variable.
 668         result = extract_env_var_dir(LYX_USERDIR_VER);
 669         if (!result.empty())
 670                 return true;
 671
 672         // 3. Use the OS-dependent default_user_support_dir
 673         result = default_user_support_dir;
 674         return false;
 675 }
 676
 677
 678 // $HOME/.lyx on POSIX but on Win32 it will be something like
 679 // "C:/Documents and Settings/USERNAME/Application Data/LyX"
 680 FileName const get_default_user_support_dir(FileName const & home_dir)
 681 {
 682 #if defined (USE_WINDOWS_PACKAGING)
 683         (void)home_dir; // Silence warning about unused variable.
 684
 685         os::GetFolderPath win32_folder_path;
 686         return FileName(addPath(win32_folder_path(os::GetFolderPath::APPDATA), PACKAGE));
 687
 688 #elif defined (USE_MACOSX_PACKAGING) && (QT_VERSION >= 0x050000)
 689         (void)home_dir; // Silence warning about unused variable.
 690         return FileName(addPath(fromqstr(QStandardPaths::writableLocation(QStandardPaths::GenericDataLocation)), PACKAGE));
 691
 692 #elif defined (USE_MACOSX_PACKAGING)
 693         (void)home_dir; // Silence warning about unused variable.
 694         return FileName(addPath(fromqstr(QDesktopServices::storageLocation(QDesktopServices::DataLocation)), PACKAGE));
 695
 696 #elif defined (USE_HAIKU_PACKAGING)
 697         return FileName(addPath(home_dir.absFileName(), string("/config/settings/") + PACKAGE));
 698
 699 #else // USE_POSIX_PACKAGING
 700         return FileName(addPath(home_dir.absFileName(), string(".") + PACKAGE));
 701 #endif
 702 }
 703
 704
 705 // Check that directory @c dir contains @c file.
 706 // Else emit an error message about an invalid @c command_line_switch.
 707 bool check_command_line_dir(string const & dir,
 708                             string const & file,
 709                             string const & command_line_switch)
 710 {
 711         FileName const abs_path = fileSearch(dir, file);
 712         if (abs_path.empty()) {
 713                 // FIXME UNICODE
 714                 throw ExceptionMessage(ErrorException, _("File not found"), bformat(
 715                         _("Invalid %1$s switch.\nDirectory %2$s does not contain %3$s."),
 716                         from_utf8(command_line_switch), from_utf8(dir),
 717                         from_utf8(file)));
 718         }
 719
 720         return !abs_path.empty();
 721 }
 722
 723
 724 // The environment variable @c env_var expands to a (single) file path.
 725 FileName const extract_env_var_dir(string const & env_var)
 726 {
 727         string const dir = fix_dir_name(getEnv(env_var));
 728         return dir.empty() ? FileName() : makeAbsPath(dir);
 729 }
 730
 731
 732 // Check that directory @c dir contains @c file.
 733 // Else emit a warning about an invalid @c env_var.
 734 bool check_env_var_dir(FileName const & dir,
 735                        string const & file,
 736                        string const & env_var)
 737 {
 738         FileName const abs_path = fileSearch(dir.absFileName(), file);
 739         if (abs_path.empty()) {
 740                 // FIXME UNICODE
 741                 throw ExceptionMessage(WarningException, _("File not found"), bformat(
 742                         _("Invalid %1$s environment variable.\n"
 743                                 "Directory %2$s does not contain %3$s."),
 744                         from_utf8(env_var), from_utf8(dir.absFileName()),
 745                         from_utf8(file)));
 746         }
 747
 748         return !abs_path.empty();
 749 }
 750
 751
 752 // Check that directory @c dir is indeed a directory.
 753 // Else emit a warning about an invalid @c env_var.
 754 bool check_env_var_dir(FileName const & dir,
 755                        string const & env_var)
 756 {
 757         bool const success = dir.exists() && dir.isDirectory();
 758
 759         if (!success) {
 760                 // Put this string on a single line so that the gettext
 761                 // search mechanism in po/Makefile.in.in will register
 762                 // Package.cpp.in as a file containing strings that need
 763                 // translation.
 764                 // FIXME UNICODE
 765                 docstring const fmt =
 766                         _("Invalid %1$s environment variable.\n%2$s is not a directory.");
 767
 768                 throw ExceptionMessage(WarningException, _("Directory not found"), bformat(
 769                         fmt, from_utf8(env_var), from_utf8(dir.absFileName())));
 770         }
 771
 772         return success;
 773 }
 774
 775
 776 // The locale directory relative to the LyX system directory.
 777 string const relative_locale_dir()
 778 {
 779 #if defined (USE_WINDOWS_PACKAGING) || defined (USE_MACOSX_PACKAGING)
 780         return "locale/";
 781 #else
 782         return "../locale/";
 783 #endif
 784 }
 785
 786
 787 // The system lyxdir is relative to the directory containing the LyX binary.
 788 string const relative_system_support_dir()
 789 {
 790         string result;
 791
 792 #if defined (USE_WINDOWS_PACKAGING) || defined (USE_MACOSX_PACKAGING)
 793         result = "../Resources/";
 794 #else // Posix-like.
 795         result = addPath("../share/", PACKAGE);
 796 #endif
 797
 798         return result;
 799 }
 800
 801 } // namespace
 802
 803 } // namespace support
 804 } // namespace lyx