src/support/filetools.cpp

   1 /**
   2  * \file filetools.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * parts Copyright 1985, 1990, 1993 Free Software Foundation, Inc.
   7  *
   8  * \author Ivan Schreter
   9  * \author Dirk Niggemann
  10  * \author Asger Alstrup
  11  * \author Lars Gullik Bjønnes
  12  * \author Jean-Marc Lasgouttes
  13  * \author Angus Leeming
  14  * \author John Levon
  15  * \author Herbert Voß
  16  *
  17  * Full author contact details are available in file CREDITS.
  18  *
  19  * General path-mangling functions
  20  */
  21
  22 #include <config.h>
  23
  24 #include "support/filetools.h"
  25
  26 #include "LyX.h"
  27 #include "LyXRC.h"
  28
  29 #include "support/convert.h"
  30 #include "support/debug.h"
  31 #include "support/environment.h"
  32 #include "support/gettext.h"
  33 #include "support/lstrings.h"
  34 #include "support/os.h"
  35 #include "support/Messages.h"
  36 #include "support/Package.h"
  37 #include "support/PathChanger.h"
  38 #include "support/Systemcall.h"
  39 #include "support/qstring_helpers.h"
  40 #include "support/TempFile.h"
  41
  42 #include <QDir>
  43
  44 #include "support/lassert.h"
  45
  46 #include <fcntl.h>
  47 #ifdef HAVE_MAGIC_H
  48 #include <magic.h>
  49 #endif
  50 #ifdef HAVE_UNISTD_H
  51 #include <unistd.h>
  52 #endif
  53
  54 #include <cerrno>
  55 #include <climits>
  56 #include <cstdlib>
  57 #include <cstdio>
  58
  59 #include <utility>
  60 #include <fstream>
  61 #include <regex>
  62 #include <sstream>
  63 #include <vector>
  64
  65 #if defined (_WIN32)
  66 #include <io.h>
  67 #include <windows.h>
  68 #endif
  69
  70 using namespace std;
  71
  72 #define USE_QPROCESS
  73
  74 namespace lyx {
  75 namespace support {
  76
  77 bool isLyXFileName(string const & filename)
  78 {
  79         return suffixIs(ascii_lowercase(filename), ".lyx");
  80 }
  81
  82
  83 bool isSGMLFileName(string const & filename)
  84 {
  85         return suffixIs(ascii_lowercase(filename), ".sgml");
  86 }
  87
  88
  89 bool isValidLaTeXFileName(string const & filename)
  90 {
  91         string const invalid_chars("#%\"");
  92         return filename.find_first_of(invalid_chars) == string::npos;
  93 }
  94
  95
  96 bool isValidDVIFileName(string const & filename)
  97 {
  98         string const invalid_chars("${}()[]^");
  99         return filename.find_first_of(invalid_chars) == string::npos;
 100 }
 101
 102
 103 bool isBinaryFile(FileName const & filename)
 104 {
 105         bool isbinary = false;
 106         if (filename.empty() || !filename.exists())
 107                 return isbinary;
 108
 109 #ifdef HAVE_MAGIC_H
 110         magic_t magic_cookie = magic_open(MAGIC_MIME_ENCODING);
 111         if (magic_cookie) {
 112                 bool detected = true;
 113                 if (magic_load(magic_cookie, nullptr) != 0) {
 114                         LYXERR(Debug::FILES, "isBinaryFile: "
 115                                 "Could not load magic database - "
 116                                 << magic_error(magic_cookie));
 117                         detected = false;
 118                 } else {
 119                         char const *charset = magic_file(magic_cookie,
 120                                         filename.toFilesystemEncoding().c_str());
 121                         isbinary = contains(charset, "binary");
 122                 }
 123                 magic_close(magic_cookie);
 124                 if (detected)
 125                         return isbinary;
 126         }
 127 #endif
 128         // Try by looking for binary chars at the beginning of the file.
 129         // Note that this is formally not correct, since count_bin_chars
 130         // expects utf8, and the passed string can be anything: plain text
 131         // in any encoding, or really binary data. In practice it works,
 132         // since QString::fromUtf8() drops invalid utf8 sequences, and
 133         // while the exact number may not be correct, we still get a high
 134         // number for truly binary files.
 135
 136         ifstream ifs(filename.toFilesystemEncoding().c_str());
 137         if (!ifs)
 138                 return isbinary;
 139
 140         // Maximum strings to read
 141         int const max_count = 50;
 142
 143         // Maximum number of binary chars allowed
 144         int const max_bin = 5;
 145
 146         int count = 0;
 147         int binchars = 0;
 148         string str;
 149         while (count++ < max_count && !ifs.eof()) {
 150                 getline(ifs, str);
 151                 binchars += count_bin_chars(str);
 152         }
 153         return binchars > max_bin;
 154 }
 155
 156
 157 string const latex_path(string const & original_path,
 158                 latex_path_extension extension,
 159                 latex_path_dots dots)
 160 {
 161         // On cygwin, we may need windows or posix style paths.
 162         string path = os::latex_path(original_path);
 163         path = subst(path, "~", "\\string~");
 164         if (path.find(' ') != string::npos) {
 165                 // We can't use '"' because " is sometimes active (e.g. if
 166                 // babel is loaded with the "german" option)
 167                 if (extension == EXCLUDE_EXTENSION) {
 168                         // changeExtension calls os::internal_path internally
 169                         // so don't use it to remove the extension.
 170                         string const ext = getExtension(path);
 171                         string const base = ext.empty() ?
 172                                 path :
 173                                 path.substr(0, path.length() - ext.length() - 1);
 174                         // changeExtension calls os::internal_path internally
 175                         // so don't use it to re-add the extension.
 176                         path = "\\string\"" + base + "\\string\"." + ext;
 177                 } else {
 178                         path = "\\string\"" + path + "\\string\"";
 179                 }
 180         }
 181
 182         if (dots != ESCAPE_DOTS)
 183                 return path;
 184
 185         // Replace dots with the lyxdot macro, but only in the file name,
 186         // not the directory part.
 187         // addName etc call os::internal_path internally
 188         // so don't use them for path manipulation
 189         // The directory separator is always '/' for LaTeX.
 190         string::size_type pos = path.rfind('/');
 191         if (pos == string::npos)
 192                 return subst(path, ".", "\\lyxdot ");
 193         return path.substr(0, pos) + subst(path.substr(pos), ".", "\\lyxdot ");
 194 }
 195
 196
 197 // Substitutes spaces with underscores in filename (and path)
 198 FileName const makeLatexName(FileName const & file)
 199 {
 200         string name = file.onlyFileName();
 201         string const path = file.onlyPath().absFileName() + "/";
 202
 203         // ok so we scan through the string twice, but who cares.
 204         // FIXME: in Unicode time this will break for sure! There is
 205         // a non-latin world out there...
 206         string const keep = "abcdefghijklmnopqrstuvwxyz"
 207                 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
 208                 "@!'()*+,-./0123456789:;<=>?[]`|";
 209
 210         string::size_type pos = 0;
 211         while ((pos = name.find_first_not_of(keep, pos)) != string::npos)
 212                 name[pos++] = '_';
 213
 214         FileName latex_name(path + name);
 215         latex_name.changeExtension(".tex");
 216         return latex_name;
 217 }
 218
 219
 220 string const quoteName(string const & name, quote_style style)
 221 {
 222         switch(style) {
 223         case quote_shell:
 224                 // This does not work on native Windows for filenames
 225                 // containing the following characters < > : " / \ | ? *
 226                 // Moreover, it can't be made to work, as, according to
 227                 // http://msdn.microsoft.com/en-us/library/aa365247(VS.85).aspx
 228                 // those are reserved characters, and thus are forbidden.
 229                 // Please, also note that the command-line parser in
 230                 // ForkedCall::generateChild cannot deal with filenames
 231                 // containing " or ', therefore we don't pass user filenames
 232                 // to child processes if possible. We store them in a python
 233                 // script instead, where we don't have these limitations.
 234 #ifndef USE_QPROCESS
 235                 return (os::shell() == os::UNIX) ?
 236                         '\'' + subst(name, "'", "\'\\\'\'") + '\'' :
 237                         '"' + name + '"';
 238 #else
 239                 // According to the QProcess parser, a single double
 240                 // quote is represented by three consecutive ones.
 241                 // Here we simply escape the double quote and let our
 242                 // simple parser in Systemcall.cpp do the substitution.
 243                 return '"' + subst(name, "\"", "\\\"") + '"';
 244 #endif
 245         case quote_shell_filename:
 246                 return quoteName(os::external_path(name), quote_shell);
 247         case quote_python:
 248                 return "\"" + subst(subst(name, "\\", "\\\\"), "\"", "\\\"")
 249                      + "\"";
 250         }
 251         // shut up stupid compiler
 252         return string();
 253 }
 254
 255
 256 #if 0
 257 // Uses a string of paths separated by ";"s to find a file to open.
 258 // Can't cope with pathnames with a ';' in them. Returns full path to file.
 259 // If path entry begins with $$LyX/, use system_lyxdir
 260 // If path entry begins with $$User/, use user_lyxdir
 261 // Example: "$$User/doc;$$LyX/doc"
 262 FileName const fileOpenSearch(string const & path, string const & name,
 263                              string const & ext)
 264 {
 265         FileName real_file;
 266         string path_element;
 267         bool notfound = true;
 268         string tmppath = split(path, path_element, ';');
 269
 270         while (notfound && !path_element.empty()) {
 271                 path_element = os::internal_path(path_element);
 272                 if (!suffixIs(path_element, '/'))
 273                         path_element += '/';
 274                 path_element = subst(path_element, "$$LyX",
 275                                      package().system_support().absFileName());
 276                 path_element = subst(path_element, "$$User",
 277                                      package().user_support().absFileName());
 278
 279                 real_file = fileSearch(path_element, name, ext);
 280
 281                 if (real_file.empty()) {
 282                         do {
 283                                 tmppath = split(tmppath, path_element, ';');
 284                         } while (!tmppath.empty() && path_element.empty());
 285                 } else {
 286                         notfound = false;
 287                 }
 288         }
 289         return real_file;
 290 }
 291 #endif
 292
 293
 294 // Returns the real name of file name in directory path, with optional
 295 // extension ext.
 296 FileName const fileSearch(string const & path, string const & name,
 297                           string const & exts, search_mode mode)
 298 {
 299         // if `name' is an absolute path, we ignore the setting of `path'
 300         // Expand Environmentvariables in 'name'
 301         string const tmpname = replaceEnvironmentPath(name);
 302         FileName fullname(makeAbsPath(tmpname, path));
 303         // search first without extension, then with it.
 304         if (fullname.isReadableFile())
 305                 return fullname;
 306         if (exts.empty())
 307                 // We are done.
 308                 return mode == may_not_exist ? fullname : FileName();
 309         int n = 0;
 310         string ext = token(exts, ',', n);
 311         while (!ext.empty()) {
 312                 // Only add the extension if it is not already the extension of
 313                 // fullname.
 314                 bool addext = getExtension(fullname.absFileName()) != ext;
 315                 if (addext) {
 316                         if (mode == check_hidpi) {
 317                                 FileName fullname2x = FileName(addExtension(fullname.absFileName() + "@2x", ext));
 318                                 if (fullname2x.isReadableFile())
 319                                         return fullname2x;
 320                         }
 321                         fullname = FileName(addExtension(fullname.absFileName(), ext));
 322                 }
 323                 if (fullname.isReadableFile() || mode == may_not_exist)
 324                         return fullname;
 325                 if (addext)
 326                         fullname.changeExtension("");
 327                 ext = token(exts, ',', ++n);
 328         }
 329         return FileName();
 330 }
 331
 332
 333 // Search the file name.ext in the subdirectory dir of
 334 //   1) user_lyxdir
 335 //   2) build_lyxdir (if not empty)
 336 //   3) system_lyxdir
 337 FileName const libFileSearch(string const & dir, string const & name,
 338                            string const & ext, search_mode mode)
 339 {
 340         FileName fullname = fileSearch(addPath(package().user_support().absFileName(), dir),
 341                                      name, ext, mode);
 342         if (!fullname.empty())
 343                 return fullname;
 344
 345         if (!package().build_support().empty())
 346                 fullname = fileSearch(addPath(package().build_support().absFileName(), dir),
 347                                       name, ext, mode);
 348         if (!fullname.empty())
 349                 return fullname;
 350
 351         return fileSearch(addPath(package().system_support().absFileName(), dir),
 352                                       name, ext, mode);
 353 }
 354
 355
 356 FileName const i18nLibFileSearch(string const & dir, string const & name,
 357                   string const & ext)
 358 {
 359         // if the LANGUAGE variable is set, use it as a fallback for searching for files.
 360         string lang = getGuiMessages().language();
 361         string const language = getEnv("LANGUAGE");
 362         if (!language.empty())
 363                 lang += ":" + language;
 364
 365         for (auto const & l : getVectorFromString(lang, ":")) {
 366                 FileName tmp;
 367                 // First try with the full name
 368                 // `en' files are not in a subdirectory
 369                 if (l == "en")
 370                         tmp = libFileSearch(dir, name, ext);
 371                 else
 372                         tmp = libFileSearch(addPath(dir, l), name, ext);
 373                 if (!tmp.empty())
 374                         return tmp;
 375
 376                 // Then the name without country code
 377                 string const shortl = token(l, '_', 0);
 378                 if (shortl != l) {
 379                         tmp = libFileSearch(addPath(dir, shortl), name, ext);
 380                         if (!tmp.empty())
 381                                 return tmp;
 382                 }
 383         }
 384
 385         return libFileSearch(dir, name, ext);
 386 }
 387
 388
 389 FileName const imageLibFileSearch(string & dir, string const & name,
 390                   string const & ext, search_mode mode)
 391 {
 392         if (!lyx::lyxrc.icon_set.empty()) {
 393                 string const imagedir = addPath(dir, lyx::lyxrc.icon_set);
 394                 FileName const fn = libFileSearch(imagedir, name, ext, mode);
 395                 if (fn.exists()) {
 396                         dir = imagedir;
 397                         return fn;
 398                 }
 399         }
 400         return libFileSearch(dir, name, ext, mode);
 401 }
 402
 403
 404 string const commandPrep(string const & command_in)
 405 {
 406         static string const token_scriptpath = "$$s/";
 407         string const python_call = "python -tt";
 408
 409         string command = command_in;
 410         if (prefixIs(command_in, python_call))
 411                 command = os::python() + command_in.substr(python_call.length());
 412
 413         // Find the starting position of "$$s/"
 414         string::size_type const pos1 = command.find(token_scriptpath);
 415         if (pos1 == string::npos)
 416                 return command;
 417         // Find the end of the "$$s/some_subdir/some_script" word within
 418         // command. Assumes that the script name does not contain spaces.
 419         string::size_type const start_script = pos1 + 4;
 420         string::size_type const pos2 = command.find(' ', start_script);
 421         string::size_type const size_script = pos2 == string::npos?
 422                 (command.size() - start_script) : pos2 - start_script;
 423
 424         // Does this script file exist?
 425         string const script =
 426                 libFileSearch(".", command.substr(start_script, size_script)).absFileName();
 427
 428         if (script.empty()) {
 429                 // Replace "$$s/" with ""
 430                 command.erase(pos1, 4);
 431         } else {
 432                 quote_style style = quote_shell;
 433                 if (prefixIs(command, os::python()))
 434                         style = quote_python;
 435
 436                 // Replace "$$s/foo/some_script" with "<path to>/some_script".
 437                 string::size_type const size_replace = size_script + 4;
 438                 command.replace(pos1, size_replace, quoteName(script, style));
 439         }
 440
 441         return command;
 442 }
 443
 444
 445 FileName const tempFileName(FileName const & tempdir, string const & mask, bool const dir)
 446 {
 447         return tempFileName(TempFile(tempdir, mask).name(), dir);
 448 }
 449
 450
 451 FileName const tempFileName(string const & mask, bool const dir)
 452 {
 453         return tempFileName(TempFile(mask).name(), dir);
 454 }
 455
 456
 457 FileName const tempFileName(FileName tempfile, bool const dir)
 458 {
 459         // Since the QTemporaryFile object is destroyed at function return
 460         // (which is what is intended here), the next call to this function
 461         // may return the same file name again.
 462         // Thus, in order to prevent race conditions, we track returned names
 463         // and create our own unique names if QTemporaryFile returns a name again.
 464         if (tmp_names_.find(tempfile.absFileName()) == tmp_names_.end()) {
 465                 tmp_names_.insert(tempfile.absFileName());
 466                 return tempfile;
 467         }
 468
 469         // OK, we need another name. Simply append digits.
 470         FileName tmp = tempfile;
 471         string ext;
 472         if (!dir) {
 473                 // Store and remove extensions
 474                 ext = "." + tempfile.extension();
 475                 tmp.changeExtension("");
 476         }
 477         for (int i = 1; i < INT_MAX ;++i) {
 478                 // Append digit to filename and re-add extension
 479                 string const new_fn =
 480                         tmp.absFileName() + convert<string>(i) + ext;
 481                 if (tmp_names_.find(new_fn) == tmp_names_.end()) {
 482                         tmp_names_.insert(new_fn);
 483                         tempfile.set(new_fn);
 484                         return tempfile;
 485                 }
 486         }
 487
 488         // This should not happen!
 489         LYXERR0("tempFileName(): Could not create unique temp file name!");
 490         return tempfile;
 491 }
 492
 493
 494 void removeTempFile(FileName const & fn)
 495 {
 496         if (!fn.exists())
 497                 return;
 498
 499         string const abs = fn.absFileName();
 500         tmp_names_.erase(abs);
 501         fn.removeFile();
 502 }
 503
 504
 505 static FileName createTmpDir(FileName const & tempdir, string const & mask)
 506 {
 507         LYXERR(Debug::FILES, "createTmpDir: tempdir=`" << tempdir << "'\n"
 508                 << "createTmpDir:    mask=`" << mask << '\'');
 509
 510         QFileInfo tmp_fi(QDir(toqstr(tempdir.absFileName())), toqstr(mask));
 511         FileName const tmpfl =
 512                 tempFileName(FileName(fromqstr(tmp_fi.absolutePath())),
 513                              fromqstr(tmp_fi.fileName()) + ".XXXXXXXXXXXX", true);
 514
 515         if (tmpfl.empty() || !tmpfl.createDirectory(0700)) {
 516                 LYXERR0("LyX could not create temporary directory in " << tempdir
 517                         << "'");
 518                 return FileName();
 519         }
 520
 521         return tmpfl;
 522 }
 523
 524
 525 FileName const createLyXTmpDir(FileName const & deflt)
 526 {
 527         if (deflt.empty() || deflt == package().system_temp_dir())
 528                 return createTmpDir(package().system_temp_dir(), "lyx_tmpdir");
 529
 530         if (deflt.createDirectory(0777))
 531                 return deflt;
 532
 533         if (deflt.isDirWritable()) {
 534                 // deflt could not be created because it
 535                 // did exist already, so let's create our own
 536                 // dir inside deflt.
 537                 return createTmpDir(deflt, "lyx_tmpdir");
 538         } else {
 539                 // some other error occurred.
 540                 return createTmpDir(package().system_temp_dir(), "lyx_tmpdir");
 541         }
 542 }
 543
 544
 545 // Strip filename from path name
 546 string const onlyPath(string const & filename)
 547 {
 548         // If empty filename, return empty
 549         if (filename.empty())
 550                 return filename;
 551
 552         // Find last / or start of filename
 553         size_t j = filename.rfind('/');
 554         return j == string::npos ? "./" : filename.substr(0, j + 1);
 555 }
 556
 557
 558 // Convert relative path into absolute path based on a basepath.
 559 // If relpath is absolute, just use that.
 560 // If basepath is empty, use CWD as base.
 561 // Note that basePath can be a relative path, in the sense that it may
 562 // not begin with "/" (e.g.), but it should NOT contain such constructs
 563 // as "/../".
 564 // FIXME It might be nice if the code didn't simply assume that.
 565 FileName const makeAbsPath(string const & relPath, string const & basePath)
 566 {
 567         // checks for already absolute path
 568         if (FileName::isAbsolute(relPath))
 569                 return FileName(relPath);
 570
 571         // Copies given paths
 572         string tempRel = os::internal_path(relPath);
 573         // Since TempRel is NOT absolute, we can safely replace "//" with "/"
 574         tempRel = subst(tempRel, "//", "/");
 575
 576         string tempBase;
 577
 578         if (FileName::isAbsolute(basePath))
 579                 tempBase = basePath;
 580         else
 581                 tempBase = addPath(FileName::getcwd().absFileName(), basePath);
 582
 583         // Handle /./ at the end of the path
 584         while (suffixIs(tempBase, "/./"))
 585                 tempBase.erase(tempBase.length() - 2);
 586
 587         // processes relative path
 588         string rTemp = tempRel;
 589         string temp;
 590
 591         // Check for a leading "~"
 592         // Split by first /
 593         rTemp = split(rTemp, temp, '/');
 594         if (temp == "~") {
 595                 tempBase = Package::get_home_dir().absFileName();
 596                 tempRel = rTemp;
 597         }
 598
 599         rTemp = tempRel;
 600         while (!rTemp.empty()) {
 601                 // Split by next /
 602                 rTemp = split(rTemp, temp, '/');
 603
 604                 if (temp == ".") continue;
 605                 if (temp == "..") {
 606                         // Remove one level of TempBase
 607                         if (tempBase.length() <= 1) {
 608                                 //this is supposed to be an absolute path, so...
 609                                 tempBase = "/";
 610                                 continue;
 611                         }
 612                         //erase a trailing slash if there is one
 613                         if (suffixIs(tempBase, "/"))
 614                                 tempBase.erase(tempBase.length() - 1, string::npos);
 615
 616                         string::size_type i = tempBase.length() - 1;
 617                         while (i > 0 && tempBase[i] != '/')
 618                                 --i;
 619                         if (i > 0)
 620                                 tempBase.erase(i, string::npos);
 621                         else
 622                                 tempBase = '/';
 623                 } else if (temp.empty() && !rTemp.empty()) {
 624                                 tempBase = os::current_root() + rTemp;
 625                                 rTemp.erase();
 626                 } else {
 627                         // Add this piece to TempBase
 628                         if (!suffixIs(tempBase, '/'))
 629                                 tempBase += '/';
 630                         tempBase += temp;
 631                 }
 632         }
 633
 634         // returns absolute path
 635         return FileName(tempBase);
 636 }
 637
 638
 639 // Correctly append filename to the pathname.
 640 // If pathname is '.', then don't use pathname.
 641 // Chops any path of filename.
 642 string const addName(string const & path, string const & fname)
 643 {
 644         string const basename = onlyFileName(fname);
 645         string buf;
 646
 647         if (path != "." && path != "./" && !path.empty()) {
 648                 buf = os::internal_path(path);
 649                 if (!suffixIs(buf, '/'))
 650                         buf += '/';
 651         }
 652
 653         return buf + basename;
 654 }
 655
 656
 657 string const addPathName(std::string const & path, std::string const & fname)
 658 {
 659         string const pathpart = onlyPath(fname);
 660         string const namepart = onlyFileName(fname);
 661         string newpath = path;
 662         if (!pathpart.empty())
 663                 newpath = addPath(newpath, pathpart);
 664         if (!namepart.empty())
 665                 newpath = addName(newpath, namepart);
 666         return newpath;
 667 }
 668
 669
 670 // Strips path from filename
 671 string const onlyFileName(string const & fname)
 672 {
 673         if (fname.empty())
 674                 return fname;
 675
 676         string::size_type j = fname.rfind('/');
 677         if (j == string::npos) // no '/' in fname
 678                 return fname;
 679
 680         // Strip to basename
 681         return fname.substr(j + 1);
 682 }
 683
 684
 685 // Search the string for ${VAR} and $VAR and replace VAR using getenv.
 686 string const replaceEnvironmentPath(string const & path)
 687 {
 688         // ${VAR} is defined as
 689         // $\{[A-Za-z_][A-Za-z_0-9]*\}
 690         static string const envvar_br = "[$]\\{([A-Za-z_][A-Za-z_0-9]*)\\}";
 691
 692         // $VAR is defined as:
 693         // $[A-Za-z_][A-Za-z_0-9]*
 694         static string const envvar = "[$]([A-Za-z_][A-Za-z_0-9]*)";
 695
 696         // Coverity thinks that the regex constructor can return an
 697         // exception. We know that it is not true since our regex are
 698         // hardcoded, but we have to protect against that nevertheless.
 699         try {
 700                 static regex const envvar_br_re("(.*)" + envvar_br + "(.*)");
 701                 static regex const envvar_re("(.*)" + envvar + "(.*)");
 702                 string result = path;
 703                 while (1) {
 704                         smatch what;
 705                         if (!regex_match(result, what, envvar_br_re)) {
 706                                 if (!regex_match(result, what, envvar_re))
 707                                         break;
 708                         }
 709                         string env_var = getEnv(what.str(2));
 710                         result = what.str(1) + env_var + what.str(3);
 711                 }
 712                 return result;
 713         } catch (exception const & e) {
 714                 LYXERR0("Something is very wrong: " << e.what());
 715                 return path;
 716         }
 717 }
 718
 719
 720 // Return a command prefix for setting the environment of the TeX engine.
 721 string latexEnvCmdPrefix(string const & path, string const & lpath)
 722 {
 723         bool use_lpath = !(lpath.empty() || lpath == "." || lpath == "./");
 724
 725         if (path.empty() || (lyxrc.texinputs_prefix.empty() && !use_lpath))
 726                 return string();
 727
 728         string texinputs_prefix = lyxrc.texinputs_prefix.empty() ? string()
 729                 : os::latex_path_list(
 730                         replaceCurdirPath(path, lyxrc.texinputs_prefix));
 731         string const allother_prefix = os::latex_path_list(path);
 732         string const sep = string(1, os::path_separator(os::TEXENGINE));
 733         string const texinputs = getEnv("TEXINPUTS");
 734         string const bibinputs = getEnv("BIBINPUTS");
 735         string const bstinputs = getEnv("BSTINPUTS");
 736         string const texfonts = getEnv("TEXFONTS");
 737
 738         if (use_lpath) {
 739                 string const abslpath = FileName::isAbsolute(lpath)
 740                         ? os::latex_path(lpath)
 741                         : os::latex_path(FileName(path + "/" + lpath).realPath());
 742                 if (texinputs_prefix.empty())
 743                         texinputs_prefix = abslpath;
 744                 else if (suffixIs(texinputs_prefix, sep))
 745                         texinputs_prefix.append(abslpath + sep);
 746                 else
 747                         texinputs_prefix.append(sep + abslpath);
 748         }
 749
 750         if (os::shell() == os::UNIX)
 751                 return "env TEXINPUTS=\"." + sep + texinputs_prefix
 752                                            + sep + texinputs + "\" "
 753                          + "BIBINPUTS=\"." + sep + allother_prefix
 754                                            + sep + bibinputs + "\" "
 755                          + "BSTINPUTS=\"." + sep + allother_prefix
 756                                            + sep + bstinputs + "\" "
 757                          + "TEXFONTS=\"."  + sep + allother_prefix
 758                                            + sep + texfonts + "\" ";
 759         else
 760                 // NOTE: the dummy blank dirs are necessary to force the
 761                 //       QProcess parser to quote the argument (see bug 9453)
 762                 return "cmd /d /c set \"TEXINPUTS=." + sep + " "
 763                                                 + sep + texinputs_prefix
 764                                                 + sep + texinputs + "\" & "
 765                                + "set \"BIBINPUTS=." + sep + " "
 766                                                 + sep + allother_prefix
 767                                                 + sep + bibinputs + "\" & "
 768                                + "set \"BSTINPUTS=." + sep + " "
 769                                                 + sep + allother_prefix
 770                                                 + sep + bstinputs + "\" & "
 771                                + "set \"TEXFONTS=."  + sep + " "
 772                                                 + sep + allother_prefix
 773                                                 + sep + texfonts + "\" & ";
 774 }
 775
 776
 777 // Replace current directory in all elements of a path list with a given path.
 778 string const replaceCurdirPath(string const & path, string const & pathlist)
 779 {
 780         string const oldpathlist = replaceEnvironmentPath(pathlist);
 781         char const sep = os::path_separator();
 782         string newpathlist;
 783
 784         for (size_t i = 0, k = 0; i != string::npos; k = i) {
 785                 i = oldpathlist.find(sep, i);
 786                 string p = oldpathlist.substr(k, i - k);
 787                 if (FileName::isAbsolute(p)) {
 788                         newpathlist += p;
 789                 } else if (i > k) {
 790                         size_t offset = 0;
 791                         if (p == ".") {
 792                                 offset = 1;
 793                         } else if (prefixIs(p, "./")) {
 794                                 offset = 2;
 795                                 while (p[offset] == '/')
 796                                         ++offset;
 797                         }
 798                         newpathlist += addPath(path, p.substr(offset));
 799                         if (suffixIs(p, "//"))
 800                                 newpathlist += '/';
 801                 }
 802                 if (i != string::npos) {
 803                         newpathlist += sep;
 804                         // Stop here if the last element is empty
 805                         if (++i == oldpathlist.length())
 806                                 break;
 807                 }
 808         }
 809         return newpathlist;
 810 }
 811
 812
 813 // Make relative path out of two absolute paths
 814 docstring const makeRelPath(docstring const & abspath, docstring const & basepath)
 815 // Makes relative path out of absolute path. If it is deeper than basepath,
 816 // it's easy. If basepath and abspath share something (they are all deeper
 817 // than some directory), it'll be rendered using ..'s. If they are completely
 818 // different, then the absolute path will be used as relative path.
 819 {
 820         docstring::size_type const abslen = abspath.length();
 821         docstring::size_type const baselen = basepath.length();
 822
 823         docstring::size_type i = os::common_path(abspath, basepath);
 824
 825         if (i == 0) {
 826                 // actually no match - cannot make it relative
 827                 return abspath;
 828         }
 829
 830         // Count how many dirs there are in basepath above match
 831         // and append as many '..''s into relpath
 832         docstring buf;
 833         docstring::size_type j = i;
 834         while (j < baselen) {
 835                 if (basepath[j] == '/') {
 836                         if (j + 1 == baselen)
 837                                 break;
 838                         buf += "../";
 839                 }
 840                 ++j;
 841         }
 842
 843         // Append relative stuff from common directory to abspath
 844         if (abspath[i] == '/')
 845                 ++i;
 846         for (; i < abslen; ++i)
 847                 buf += abspath[i];
 848         // Remove trailing /
 849         if (suffixIs(buf, '/'))
 850                 buf.erase(buf.length() - 1);
 851         // Substitute empty with .
 852         if (buf.empty())
 853                 buf = '.';
 854         return buf;
 855 }
 856
 857
 858 // Append sub-directory(ies) to a path in an intelligent way
 859 string const addPath(string const & path, string const & path_2)
 860 {
 861         string buf;
 862         string const path2 = os::internal_path(path_2);
 863
 864         if (!path.empty() && path != "." && path != "./") {
 865                 buf = os::internal_path(path);
 866                 if (path[path.length() - 1] != '/')
 867                         buf += '/';
 868         }
 869
 870         if (!path2.empty()) {
 871                 string::size_type const p2start = path2.find_first_not_of('/');
 872                 string::size_type const p2end = path2.find_last_not_of('/');
 873                 string const tmp = path2.substr(p2start, p2end - p2start + 1);
 874                 buf += tmp + '/';
 875         }
 876         return buf;
 877 }
 878
 879
 880 string const changeExtension(string const & oldname, string const & extension)
 881 {
 882         string::size_type const last_slash = oldname.rfind('/');
 883         string::size_type last_dot = oldname.rfind('.');
 884         if (last_dot < last_slash && last_slash != string::npos)
 885                 last_dot = string::npos;
 886
 887         string ext;
 888         // Make sure the extension starts with a dot
 889         if (!extension.empty() && extension[0] != '.')
 890                 ext= '.' + extension;
 891         else
 892                 ext = extension;
 893
 894         return os::internal_path(oldname.substr(0, last_dot) + ext);
 895 }
 896
 897
 898 string const removeExtension(string const & name)
 899 {
 900         return changeExtension(name, string());
 901 }
 902
 903
 904 string const addExtension(string const & name, string const & extension)
 905 {
 906         if (!extension.empty() && extension[0] != '.')
 907                 return name + '.' + extension;
 908         return name + extension;
 909 }
 910
 911
 912 /// Return the extension of the file (not including the .)
 913 string const getExtension(string const & name)
 914 {
 915         string::size_type const last_slash = name.rfind('/');
 916         string::size_type const last_dot = name.rfind('.');
 917         if (last_dot != string::npos &&
 918             (last_slash == string::npos || last_dot > last_slash))
 919                 return name.substr(last_dot + 1,
 920                                    name.length() - (last_dot + 1));
 921         else
 922                 return string();
 923 }
 924
 925
 926 string const unzippedFileName(string const & zipped_file)
 927 {
 928         string const ext = getExtension(zipped_file);
 929         if (ext == "gz" || ext == "z" || ext == "Z")
 930                 return changeExtension(zipped_file, string());
 931         else if (ext == "svgz")
 932                 return changeExtension(zipped_file, "svg");
 933         return onlyPath(zipped_file) + "unzipped_" + onlyFileName(zipped_file);
 934 }
 935
 936
 937 FileName const unzipFile(FileName const & zipped_file, string const & unzipped_file)
 938 {
 939         FileName const tempfile = FileName(unzipped_file.empty() ?
 940                 unzippedFileName(zipped_file.toFilesystemEncoding()) :
 941                 unzipped_file);
 942         // Run gunzip
 943         string const command = "gunzip -c \"" +
 944                 zipped_file.toFilesystemEncoding() + "\" > \"" +
 945                 tempfile.toFilesystemEncoding() + "\"";
 946         Systemcall one;
 947         one.startscript(Systemcall::Wait, command);
 948         // test that command was executed successfully (anon)
 949         // yes, please do. (Lgb)
 950         return tempfile;
 951 }
 952
 953
 954 docstring const makeDisplayPath(string const & path, unsigned int threshold)
 955 {
 956         string str = path;
 957
 958         // Recode URL encoded chars.
 959         str = from_percent_encoding(str);
 960
 961         // If file is from LyXDir, display it as if it were relative.
 962         string const system = package().system_support().absFileName();
 963         if (prefixIs(str, system) && str != system)
 964                 return from_utf8("[" + str.erase(0, system.length()) + "]");
 965
 966         // replace /home/blah with ~/
 967         string const home = Package::get_home_dir().absFileName();
 968         if (!home.empty() && prefixIs(str, home))
 969                 str = subst(str, home, "~");
 970
 971         if (str.length() <= threshold)
 972                 return from_utf8(os::external_path(str));
 973
 974         string const prefix = ".../";
 975         docstring dstr = from_utf8(str);
 976         docstring temp;
 977
 978         while (dstr.length() > threshold)
 979                 dstr = split(dstr, temp, '/');
 980
 981         // Did we shorten everything away?
 982         if (dstr.empty()) {
 983                 // Yes, filename itself is too long.
 984                 // Pick the start and the end of the filename.
 985                 docstring fstr = from_utf8(onlyFileName(path));
 986                 dstr = fstr;
 987                 if (support::truncateWithEllipsis(dstr, threshold / 2))
 988                         dstr += fstr.substr(fstr.length() - threshold / 2 - 2,
 989                                                                 docstring::npos);
 990         }
 991
 992         return from_utf8(os::external_path(prefix + to_utf8(dstr)));
 993 }
 994
 995
 996 #ifdef HAVE_READLINK
 997 bool readLink(FileName const & file, FileName & link)
 998 {
 999         string const encoded = file.toFilesystemEncoding();
1000 #ifdef HAVE_DEF_PATH_MAX
1001         char linkbuffer[PATH_MAX + 1];
1002         ssize_t const nRead = ::readlink(encoded.c_str(),
1003                                      linkbuffer, sizeof(linkbuffer) - 1);
1004         if (nRead <= 0)
1005                 return false;
1006         linkbuffer[nRead] = '\0'; // terminator
1007 #else
1008         vector<char> buf(1024);
1009         int nRead = -1;
1010
1011         while (true) {
1012                 nRead = ::readlink(encoded.c_str(), &buf[0], buf.size() - 1);
1013                 if (nRead < 0) {
1014                         return false;
1015                 }
1016                 if (static_cast<size_t>(nRead) < buf.size() - 1) {
1017                         break;
1018                 }
1019                 buf.resize(buf.size() * 2);
1020         }
1021         buf[nRead] = '\0'; // terminator
1022         const char * linkbuffer = &buf[0];
1023 #endif
1024         link = makeAbsPath(linkbuffer, onlyPath(file.absFileName()));
1025         return true;
1026 }
1027 #else
1028 bool readLink(FileName const &, FileName &)
1029 {
1030         return false;
1031 }
1032 #endif
1033
1034
1035 cmd_ret const runCommand(string const & cmd)
1036 {
1037         // FIXME: replace all calls to RunCommand with ForkedCall
1038         // (if the output is not needed) or the code in ISpell.cpp
1039         // (if the output is needed).
1040
1041         // One question is if we should use popen or
1042         // create our own popen based on fork, exec, pipe
1043         // of course the best would be to have a
1044         // pstream (process stream), with the
1045         // variants ipstream, opstream
1046
1047         if (verbose)
1048                 lyxerr << "\nRunning: " << cmd << endl;
1049         else
1050                 LYXERR(Debug::INFO,"Running: " << cmd);
1051
1052 #if defined (_WIN32)
1053         STARTUPINFO startup;
1054         PROCESS_INFORMATION process;
1055         SECURITY_ATTRIBUTES security;
1056         HANDLE in, out;
1057         FILE * inf = 0;
1058         bool err2out = false;
1059         string command;
1060         string const infile = trim(split(cmd, command, '<'), " \"");
1061         command = rtrim(command);
1062         if (suffixIs(command, "2>&1")) {
1063                 command = rtrim(command, "2>&1");
1064                 err2out = true;
1065         }
1066         string const cmdarg = "/d /c \"" + command + "\"";
1067         string const comspec = getEnv("COMSPEC");
1068
1069         security.nLength = sizeof(SECURITY_ATTRIBUTES);
1070         security.bInheritHandle = TRUE;
1071         security.lpSecurityDescriptor = NULL;
1072
1073         if (CreatePipe(&in, &out, &security, 0)) {
1074                 memset(&startup, 0, sizeof(STARTUPINFO));
1075                 memset(&process, 0, sizeof(PROCESS_INFORMATION));
1076
1077                 startup.cb = sizeof(STARTUPINFO);
1078                 startup.dwFlags = STARTF_USESTDHANDLES;
1079
1080                 startup.hStdError = err2out ? out : GetStdHandle(STD_ERROR_HANDLE);
1081                 startup.hStdInput = infile.empty()
1082                         ? GetStdHandle(STD_INPUT_HANDLE)
1083                         : CreateFile(infile.c_str(), GENERIC_READ,
1084                                 FILE_SHARE_READ, &security, OPEN_EXISTING,
1085                                 FILE_ATTRIBUTE_NORMAL, NULL);
1086                 startup.hStdOutput = out;
1087
1088                 if (startup.hStdInput != INVALID_HANDLE_VALUE &&
1089                         CreateProcess(comspec.c_str(), (LPTSTR)cmdarg.c_str(),
1090                                 &security, &security, TRUE, CREATE_NO_WINDOW,
1091                                 0, 0, &startup, &process)) {
1092
1093                         CloseHandle(process.hThread);
1094                         int fno = _open_osfhandle((intptr_t)in, _O_RDONLY);
1095                         CloseHandle(out);
1096                         inf = _fdopen(fno, "r");
1097                 }
1098         }
1099 #elif defined (HAVE_POPEN)
1100         FILE * inf = ::popen(cmd.c_str(), os::popen_read_mode());
1101 #elif defined (HAVE__POPEN)
1102         FILE * inf = ::_popen(cmd.c_str(), os::popen_read_mode());
1103 #else
1104 #error No popen() function.
1105 #endif
1106
1107         // (Claus Hentschel) Check if popen was successful ;-)
1108         if (!inf) {
1109                 lyxerr << "RunCommand: could not start child process" << endl;
1110                 return { false, string() };
1111         }
1112
1113         string result;
1114         int c = fgetc(inf);
1115         while (c != EOF) {
1116                 result += static_cast<char>(c);
1117                 c = fgetc(inf);
1118         }
1119
1120 #if defined (_WIN32)
1121         WaitForSingleObject(process.hProcess, INFINITE);
1122         DWORD pret;
1123         BOOL success = GetExitCodeProcess(process.hProcess, &pret);
1124         bool valid = (pret == 0) && success;
1125         if (!infile.empty())
1126                 CloseHandle(startup.hStdInput);
1127         CloseHandle(process.hProcess);
1128         if (fclose(inf) != 0)
1129                 valid = false;
1130 #elif defined (HAVE_PCLOSE)
1131         int const pret = pclose(inf);
1132         bool const valid = (pret != -1);
1133 #elif defined (HAVE__PCLOSE)
1134         int const pret = _pclose(inf);
1135         bool const valid = (pret != -1);
1136 #else
1137 #error No pclose() function.
1138 #endif
1139
1140         if (!valid)
1141                 perror("RunCommand: could not terminate child process");
1142
1143         return { valid, result };
1144 }
1145
1146
1147 FileName const findtexfile(string const & fil, string const & /*format*/,
1148                                                    bool const onlykpse)
1149 {
1150         /* There is no problem to extend this function to use other
1151            methods to look for files. It could be setup to look
1152            in environment paths and also if wanted as a last resort
1153            to a recursive find. One of the easier extensions would
1154            perhaps be to use the LyX file lookup methods. But! I am
1155            going to implement this until I see some demand for it.
1156            Lgb
1157         */
1158
1159         // If the file can be found directly, we just return a
1160         // absolute path version of it.
1161         if (!onlykpse) {
1162                 FileName const absfile(makeAbsPath(fil));
1163                 if (absfile.exists())
1164                         return absfile;
1165         }
1166
1167         // Now we try to find it using kpsewhich.
1168         // It seems from the kpsewhich manual page that it is safe to use
1169         // kpsewhich without --format: "When the --format option is not
1170         // given, the search path used when looking for a file is inferred
1171         // from the name given, by looking for a known extension. If no
1172         // known extension is found, the search path for TeX source files
1173         // is used."
1174         // However, we want to take advantage of the format sine almost all
1175         // the different formats has environment variables that can be used
1176         // to control which paths to search. f.ex. bib looks in
1177         // BIBINPUTS and TEXBIB. Small list follows:
1178         // bib - BIBINPUTS, TEXBIB
1179         // bst - BSTINPUTS
1180         // graphic/figure - TEXPICTS, TEXINPUTS
1181         // ist - TEXINDEXSTYLE, INDEXSTYLE
1182         // pk - PROGRAMFONTS, PKFONTS, TEXPKS, GLYPHFONTS, TEXFONTS
1183         // tex - TEXINPUTS
1184         // tfm - TFMFONTS, TEXFONTS
1185         // This means that to use kpsewhich in the best possible way we
1186         // should help it by setting additional path in the approp. envir.var.
1187         string const kpsecmd = "kpsewhich " + fil;
1188
1189         cmd_ret const c = runCommand(kpsecmd);
1190
1191         LYXERR(Debug::LATEX, "kpse status = " << c.valid << '\n'
1192                  << "kpse result = `" << rtrim(c.result, "\n\r") << '\'');
1193         if (c.valid)
1194                 return FileName(rtrim(to_utf8(from_filesystem8bit(c.result)), "\n\r"));
1195         else
1196                 return FileName();
1197 }
1198
1199
1200 int compare_timestamps(FileName const & file1, FileName const & file2)
1201 {
1202         // If the original is newer than the copy, then copy the original
1203         // to the new directory.
1204
1205         int cmp = 0;
1206         if (file1.exists() && file2.exists()) {
1207                 double const tmp = difftime(file1.lastModified(), file2.lastModified());
1208                 if (tmp != 0)
1209                         cmp = tmp > 0 ? 1 : -1;
1210
1211         } else if (file1.exists()) {
1212                 cmp = 1;
1213         } else if (file2.exists()) {
1214                 cmp = -1;
1215         }
1216
1217         return cmp;
1218 }
1219
1220
1221 bool prefs2prefs(FileName const & filename, FileName const & tempfile, bool lfuns)
1222 {
1223         FileName const script = libFileSearch("scripts", "prefs2prefs.py");
1224         if (script.empty()) {
1225                 LYXERR0("Could not find bind file conversion "
1226                                 "script prefs2prefs.py.");
1227                 return false;
1228         }
1229
1230         ostringstream command;
1231         command << os::python() << ' ' << quoteName(script.toFilesystemEncoding())
1232           << ' ' << (lfuns ? "-l" : "-p") << ' '
1233                 << quoteName(filename.toFilesystemEncoding())
1234                 << ' ' << quoteName(tempfile.toFilesystemEncoding());
1235         string const command_str = command.str();
1236
1237         LYXERR(Debug::FILES, "Running `" << command_str << '\'');
1238
1239         cmd_ret const ret = runCommand(command_str);
1240         if (!ret.valid) {
1241                 LYXERR0("Could not run file conversion script prefs2prefs.py.");
1242                 return false;
1243         }
1244         return true;
1245 }
1246
1247
1248 bool configFileNeedsUpdate(string const & file)
1249 {
1250         // We cannot initialize configure_script directly because the package
1251         // is not initialized yet when static objects are constructed.
1252         static FileName configure_script;
1253         static bool firstrun = true;
1254         if (firstrun) {
1255                 configure_script =
1256                         FileName(addName(package().system_support().absFileName(),
1257                                 "configure.py"));
1258                 firstrun = false;
1259         }
1260
1261         FileName absfile =
1262                 FileName(addName(package().user_support().absFileName(), file));
1263         return !absfile.exists()
1264                 || configure_script.lastModified() > absfile.lastModified();
1265 }
1266
1267
1268 int fileLock(const char * lock_file)
1269 {
1270         int fd = -1;
1271 #if defined(HAVE_LOCKF)
1272         fd = open(lock_file, O_CREAT|O_APPEND|O_SYNC|O_RDWR, 0666);
1273         if (fd == -1)
1274                 return -1;
1275         if (lockf(fd, F_LOCK, 0) != 0) {
1276                 close(fd);
1277                 return -1;
1278         }
1279 #endif
1280         return fd;
1281 }
1282
1283
1284 void fileUnlock(int fd, const char * /* lock_file*/)
1285 {
1286 #if defined(HAVE_LOCKF)
1287         if (fd >= 0) {
1288                 if (lockf(fd, F_ULOCK, 0))
1289                         LYXERR0("Can't unlock the file.");
1290                 close(fd);
1291         }
1292 #endif
1293 }
1294
1295 } //namespace support
1296 } // namespace lyx