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 "support/convert.h"
  27 #include "support/debug.h"
  28 #include "support/environment.h"
  29 #include "support/gettext.h"
  30 #include "support/lstrings.h"
  31 #include "support/os.h"
  32 #include "support/Package.h"
  33 #include "support/Path.h"
  34 #include "support/Systemcall.h"
  35 #include "support/qstring_helpers.h"
  36
  37 #include <QDir>
  38
  39 #include <boost/assert.hpp>
  40 #include <boost/regex.hpp>
  41
  42 #include <fcntl.h>
  43
  44 #include <cerrno>
  45 #include <cstdlib>
  46 #include <cstdio>
  47
  48 #include <utility>
  49 #include <fstream>
  50 #include <sstream>
  51
  52 using namespace std;
  53
  54 namespace lyx {
  55 namespace support {
  56
  57 bool isLyXFilename(string const & filename)
  58 {
  59         return suffixIs(ascii_lowercase(filename), ".lyx");
  60 }
  61
  62
  63 bool isSGMLFilename(string const & filename)
  64 {
  65         return suffixIs(ascii_lowercase(filename), ".sgml");
  66 }
  67
  68
  69 bool isValidLaTeXFilename(string const & filename)
  70 {
  71         string const invalid_chars("#$%{}()[]\"^");
  72         return filename.find_first_of(invalid_chars) == string::npos;
  73 }
  74
  75
  76 string const latex_path(string const & original_path,
  77                 latex_path_extension extension,
  78                 latex_path_dots dots)
  79 {
  80         // On cygwin, we may need windows or posix style paths.
  81         string path = os::latex_path(original_path);
  82         path = subst(path, "~", "\\string~");
  83         if (path.find(' ') != string::npos) {
  84                 // We can't use '"' because " is sometimes active (e.g. if
  85                 // babel is loaded with the "german" option)
  86                 if (extension == EXCLUDE_EXTENSION) {
  87                         // ChangeExtension calls os::internal_path internally
  88                         // so don't use it to remove the extension.
  89                         string const ext = getExtension(path);
  90                         string const base = ext.empty() ?
  91                                 path :
  92                                 path.substr(0, path.length() - ext.length() - 1);
  93                         // ChangeExtension calls os::internal_path internally
  94                         // so don't use it to re-add the extension.
  95                         path = "\\string\"" + base + "\\string\"." + ext;
  96                 } else {
  97                         path = "\\string\"" + path + "\\string\"";
  98                 }
  99         }
 100
 101         return dots == ESCAPE_DOTS ? subst(path, ".", "\\lyxdot ") : path;
 102 }
 103
 104
 105 // Substitutes spaces with underscores in filename (and path)
 106 FileName const makeLatexName(FileName const & file)
 107 {
 108         string name = file.onlyFileName();
 109         string const path = file.onlyPath().absFilename() + "/";
 110
 111         // ok so we scan through the string twice, but who cares.
 112         // FIXME: in Unicode time this will break for sure! There is
 113         // a non-latin world out there...
 114         string const keep = "abcdefghijklmnopqrstuvwxyz"
 115                 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
 116                 "@!'()*+,-./0123456789:;<=>?[]`|";
 117
 118         string::size_type pos = 0;
 119         while ((pos = name.find_first_not_of(keep, pos)) != string::npos)
 120                 name[pos++] = '_';
 121
 122         FileName latex_name(path + name);
 123         latex_name.changeExtension(".tex");
 124         return latex_name;
 125 }
 126
 127
 128 string const quoteName(string const & name, quote_style style)
 129 {
 130         switch(style) {
 131         case quote_shell:
 132                 // This does not work for filenames containing " (windows)
 133                 // or ' (all other OSes). This can't be changed easily, since
 134                 // we would need to adapt the command line parser in
 135                 // Forkedcall::generateChild. Therefore we don't pass user
 136                 // filenames to child processes if possible. We store them in
 137                 // a python script instead, where we don't have these
 138                 // limitations.
 139                 return (os::shell() == os::UNIX) ?
 140                         '\'' + name + '\'':
 141                         '"' + name + '"';
 142         case quote_python:
 143                 return "\"" + subst(subst(name, "\\", "\\\\"), "\"", "\\\"")
 144                      + "\"";
 145         }
 146         // shut up stupid compiler
 147         return string();
 148 }
 149
 150
 151 #if 0
 152 // Uses a string of paths separated by ";"s to find a file to open.
 153 // Can't cope with pathnames with a ';' in them. Returns full path to file.
 154 // If path entry begins with $$LyX/, use system_lyxdir
 155 // If path entry begins with $$User/, use user_lyxdir
 156 // Example: "$$User/doc;$$LyX/doc"
 157 FileName const fileOpenSearch(string const & path, string const & name,
 158                              string const & ext)
 159 {
 160         FileName real_file;
 161         string path_element;
 162         bool notfound = true;
 163         string tmppath = split(path, path_element, ';');
 164
 165         while (notfound && !path_element.empty()) {
 166                 path_element = os::internal_path(path_element);
 167                 if (!suffixIs(path_element, '/'))
 168                         path_element += '/';
 169                 path_element = subst(path_element, "$$LyX",
 170                                      package().system_support().absFilename());
 171                 path_element = subst(path_element, "$$User",
 172                                      package().user_support().absFilename());
 173
 174                 real_file = fileSearch(path_element, name, ext);
 175
 176                 if (real_file.empty()) {
 177                         do {
 178                                 tmppath = split(tmppath, path_element, ';');
 179                         } while (!tmppath.empty() && path_element.empty());
 180                 } else {
 181                         notfound = false;
 182                 }
 183         }
 184         return real_file;
 185 }
 186 #endif
 187
 188
 189 // Returns the real name of file name in directory path, with optional
 190 // extension ext.
 191 FileName const fileSearch(string const & path, string const & name,
 192                           string const & ext, search_mode mode)
 193 {
 194         // if `name' is an absolute path, we ignore the setting of `path'
 195         // Expand Environmentvariables in 'name'
 196         string const tmpname = replaceEnvironmentPath(name);
 197         FileName fullname(makeAbsPath(tmpname, path));
 198         // search first without extension, then with it.
 199         if (fullname.isReadableFile())
 200                 return fullname;
 201         if (ext.empty())
 202                 // We are done.
 203                 return mode == may_not_exist ? fullname : FileName();
 204         // Only add the extension if it is not already the extension of
 205         // fullname.
 206         if (getExtension(fullname.absFilename()) != ext)
 207                 fullname = FileName(addExtension(fullname.absFilename(), ext));
 208         if (fullname.isReadableFile() || mode == may_not_exist)
 209                 return fullname;
 210         return FileName();
 211 }
 212
 213
 214 // Search the file name.ext in the subdirectory dir of
 215 //   1) user_lyxdir
 216 //   2) build_lyxdir (if not empty)
 217 //   3) system_lyxdir
 218 FileName const libFileSearch(string const & dir, string const & name,
 219                            string const & ext)
 220 {
 221         FileName fullname = fileSearch(addPath(package().user_support().absFilename(), dir),
 222                                      name, ext);
 223         if (!fullname.empty())
 224                 return fullname;
 225
 226         if (!package().build_support().empty())
 227                 fullname = fileSearch(addPath(package().build_support().absFilename(), dir),
 228                                       name, ext);
 229         if (!fullname.empty())
 230                 return fullname;
 231
 232         return fileSearch(addPath(package().system_support().absFilename(), dir), name, ext);
 233 }
 234
 235
 236 FileName const i18nLibFileSearch(string const & dir, string const & name,
 237                   string const & ext)
 238 {
 239         /* The highest priority value is the `LANGUAGE' environment
 240            variable. But we don't use the value if the currently
 241            selected locale is the C locale. This is a GNU extension.
 242
 243            Otherwise, w use a trick to guess what support/gettext.has done:
 244            each po file is able to tell us its name. (JMarc)
 245         */
 246
 247         string lang = to_ascii(_("[[Replace with the code of your language]]"));
 248         string const language = getEnv("LANGUAGE");
 249         if (!lang.empty() && !language.empty())
 250                 lang = language;
 251
 252         string l;
 253         lang = split(lang, l, ':');
 254         while (!l.empty()) {
 255                 FileName tmp;
 256                 // First try with the full name
 257                 tmp = libFileSearch(addPath(dir, l), name, ext);
 258                 if (!tmp.empty())
 259                         return tmp;
 260
 261                 // Then the name without country code
 262                 string const shortl = token(l, '_', 0);
 263                 if (shortl != l) {
 264                         tmp = libFileSearch(addPath(dir, shortl), name, ext);
 265                         if (!tmp.empty())
 266                                 return tmp;
 267                 }
 268
 269 #if 1
 270                 // For compatibility, to be removed later (JMarc)
 271                 tmp = libFileSearch(dir, token(l, '_', 0) + '_' + name,
 272                                     ext);
 273                 if (!tmp.empty()) {
 274                         lyxerr << "i18nLibFileSearch: File `" << tmp
 275                                << "' has been found by the old method" <<endl;
 276                         return tmp;
 277                 }
 278 #endif
 279                 lang = split(lang, l, ':');
 280         }
 281
 282         return libFileSearch(dir, name, ext);
 283 }
 284
 285
 286 string const libScriptSearch(string const & command_in, quote_style style)
 287 {
 288         static string const token_scriptpath = "$$s/";
 289
 290         string command = command_in;
 291         // Find the starting position of "$$s/"
 292         string::size_type const pos1 = command.find(token_scriptpath);
 293         if (pos1 == string::npos)
 294                 return command;
 295         // Find the end of the "$$s/some_subdir/some_script" word within
 296         // command. Assumes that the script name does not contain spaces.
 297         string::size_type const start_script = pos1 + 4;
 298         string::size_type const pos2 = command.find(' ', start_script);
 299         string::size_type const size_script = pos2 == string::npos?
 300                 (command.size() - start_script) : pos2 - start_script;
 301
 302         // Does this script file exist?
 303         string const script =
 304                 libFileSearch(".", command.substr(start_script, size_script)).absFilename();
 305
 306         if (script.empty()) {
 307                 // Replace "$$s/" with ""
 308                 command.erase(pos1, 4);
 309         } else {
 310                 // Replace "$$s/foo/some_script" with "<path to>/some_script".
 311                 string::size_type const size_replace = size_script + 4;
 312                 command.replace(pos1, size_replace, quoteName(script, style));
 313         }
 314
 315         return command;
 316 }
 317
 318
 319 static FileName createTmpDir(FileName const & tempdir, string const & mask)
 320 {
 321         LYXERR(Debug::FILES, "createTmpDir: tempdir=`" << tempdir << "'\n"
 322                 << "createTmpDir:    mask=`" << mask << '\'');
 323
 324         FileName const tmpfl = FileName::tempName(tempdir.absFilename()
 325                 + "/" + mask);
 326         // FileName::tempName actually creates a file to make sure that it
 327         // stays unique. So we have to delete it before we can create
 328         // a dir with the same name. Note also that we are not thread
 329         // safe because of the gap between unlink and mkdir. (Lgb)
 330         tmpfl.removeFile();
 331
 332         if (tmpfl.empty() || !tmpfl.createDirectory(0700)) {
 333                 lyxerr << "LyX could not create the temporary directory '"
 334                        << tmpfl << "'" << endl;
 335                 return FileName();
 336         }
 337
 338         return tmpfl;
 339 }
 340
 341
 342 FileName const createLyXTmpDir(FileName const & deflt)
 343 {
 344         if (deflt.empty() || deflt.absFilename() == "/tmp")
 345                 return createTmpDir(FileName("/tmp"), "lyx_tmpdir");
 346
 347         if (deflt.createDirectory(0777))
 348                 return deflt;
 349
 350         if (deflt.isDirWritable()) {
 351                 // deflt could not be created because it
 352                 // did exist already, so let's create our own
 353                 // dir inside deflt.
 354                 return createTmpDir(deflt, "lyx_tmpdir");
 355         } else {
 356                 // some other error occured.
 357                 return createTmpDir(FileName("/tmp"), "lyx_tmpdir");
 358         }
 359 }
 360
 361
 362 // Strip filename from path name
 363 string const onlyPath(string const & filename)
 364 {
 365         // If empty filename, return empty
 366         if (filename.empty())
 367                 return filename;
 368
 369         // Find last / or start of filename
 370         size_t j = filename.rfind('/');
 371         return j == string::npos ? "./" : filename.substr(0, j + 1);
 372 }
 373
 374
 375 // Convert relative path into absolute path based on a basepath.
 376 // If relpath is absolute, just use that.
 377 // If basepath is empty, use CWD as base.
 378 // Note that basePath can be a relative path, in the sense that it may
 379 // not begin with "/" (e.g.), but it should NOT contain such constructs
 380 // as "/../".
 381 // FIXME It might be nice if the code didn't simply assume that.
 382 FileName const makeAbsPath(string const & relPath, string const & basePath)
 383 {
 384         FileName relative_path(relPath);
 385         // checks for already absolute path
 386         if (relative_path.isAbsolute())
 387                 return relative_path;
 388
 389         // Copies given paths
 390         string tempRel = os::internal_path(relPath);
 391         // Since TempRel is NOT absolute, we can safely replace "//" with "/"
 392         tempRel = subst(tempRel, "//", "/");
 393
 394         string tempBase;
 395
 396         FileName base_path(basePath);
 397         if (base_path.isAbsolute())
 398                 tempBase = basePath;
 399         else
 400                 tempBase = addPath(FileName::getcwd().absFilename(), basePath);
 401
 402         // Handle /./ at the end of the path
 403         while (suffixIs(tempBase, "/./"))
 404                 tempBase.erase(tempBase.length() - 2);
 405
 406         // processes relative path
 407         string rTemp = tempRel;
 408         string temp;
 409
 410         while (!rTemp.empty()) {
 411                 // Split by next /
 412                 rTemp = split(rTemp, temp, '/');
 413
 414                 if (temp == ".") continue;
 415                 if (temp == "..") {
 416                         // Remove one level of TempBase
 417                         string::difference_type i = tempBase.length() - 2;
 418                         if (i < 0)
 419                                 i = 0;
 420                         while (i > 0 && tempBase[i] != '/')
 421                                 --i;
 422                         if (i > 0)
 423                                 tempBase.erase(i, string::npos);
 424                         else
 425                                 tempBase += '/';
 426                 } else if (temp.empty() && !rTemp.empty()) {
 427                                 tempBase = os::current_root() + rTemp;
 428                                 rTemp.erase();
 429                 } else {
 430                         // Add this piece to TempBase
 431                         if (!suffixIs(tempBase, '/'))
 432                                 tempBase += '/';
 433                         tempBase += temp;
 434                 }
 435         }
 436
 437         // returns absolute path
 438         return FileName(tempBase);
 439 }
 440
 441
 442 // Correctly append filename to the pathname.
 443 // If pathname is '.', then don't use pathname.
 444 // Chops any path of filename.
 445 string const addName(string const & path, string const & fname)
 446 {
 447         string const basename = onlyFilename(fname);
 448         string buf;
 449
 450         if (path != "." && path != "./" && !path.empty()) {
 451                 buf = os::internal_path(path);
 452                 if (!suffixIs(path, '/'))
 453                         buf += '/';
 454         }
 455
 456         return buf + basename;
 457 }
 458
 459
 460 // Strips path from filename
 461 string const onlyFilename(string const & fname)
 462 {
 463         if (fname.empty())
 464                 return fname;
 465
 466         string::size_type j = fname.rfind('/');
 467         if (j == string::npos) // no '/' in fname
 468                 return fname;
 469
 470         // Strip to basename
 471         return fname.substr(j + 1);
 472 }
 473
 474
 475 // Create absolute path. If impossible, don't do anything
 476 // Supports ./ and ~/. Later we can add support for ~logname/. (Asger)
 477 string const expandPath(string const & path)
 478 {
 479         // checks for already absolute path
 480         string rTemp = replaceEnvironmentPath(path);
 481         FileName abs_path(rTemp);
 482         if (abs_path.isAbsolute())
 483                 return rTemp;
 484
 485         string temp;
 486         string const copy = rTemp;
 487
 488         // Split by next /
 489         rTemp = split(rTemp, temp, '/');
 490
 491         if (temp == ".")
 492                 return FileName::getcwd().absFilename() + '/' + rTemp;
 493
 494         if (temp == "~")
 495                 return package().home_dir().absFilename() + '/' + rTemp;
 496
 497         if (temp == "..")
 498                 return makeAbsPath(copy).absFilename();
 499
 500         // Don't know how to handle this
 501         return copy;
 502 }
 503
 504
 505 // Search the string for ${VAR} and $VAR and replace VAR using getenv.
 506 string const replaceEnvironmentPath(string const & path)
 507 {
 508         // ${VAR} is defined as
 509         // $\{[A-Za-z_][A-Za-z_0-9]*\}
 510         static string const envvar_br = "[$]\\{([A-Za-z_][A-Za-z_0-9]*)\\}";
 511
 512         // $VAR is defined as:
 513         // $\{[A-Za-z_][A-Za-z_0-9]*\}
 514         static string const envvar = "[$]([A-Za-z_][A-Za-z_0-9]*)";
 515
 516         static boost::regex envvar_br_re("(.*)" + envvar_br + "(.*)");
 517         static boost::regex envvar_re("(.*)" + envvar + "(.*)");
 518         boost::smatch what;
 519
 520         string result = path;
 521         while (1) {
 522                 regex_match(result, what, envvar_br_re);
 523                 if (!what[0].matched) {
 524                         regex_match(result, what, envvar_re);
 525                         if (!what[0].matched)
 526                                 break;
 527                 }
 528                 result = what.str(1) + getEnv(what.str(2)) + what.str(3);
 529         }
 530         return result;
 531 }
 532
 533
 534 // Make relative path out of two absolute paths
 535 docstring const makeRelPath(docstring const & abspath, docstring const & basepath)
 536 // Makes relative path out of absolute path. If it is deeper than basepath,
 537 // it's easy. If basepath and abspath share something (they are all deeper
 538 // than some directory), it'll be rendered using ..'s. If they are completely
 539 // different, then the absolute path will be used as relative path.
 540 {
 541         docstring::size_type const abslen = abspath.length();
 542         docstring::size_type const baselen = basepath.length();
 543
 544         docstring::size_type i = os::common_path(abspath, basepath);
 545
 546         if (i == 0) {
 547                 // actually no match - cannot make it relative
 548                 return abspath;
 549         }
 550
 551         // Count how many dirs there are in basepath above match
 552         // and append as many '..''s into relpath
 553         docstring buf;
 554         docstring::size_type j = i;
 555         while (j < baselen) {
 556                 if (basepath[j] == '/') {
 557                         if (j + 1 == baselen)
 558                                 break;
 559                         buf += "../";
 560                 }
 561                 ++j;
 562         }
 563
 564         // Append relative stuff from common directory to abspath
 565         if (abspath[i] == '/')
 566                 ++i;
 567         for (; i < abslen; ++i)
 568                 buf += abspath[i];
 569         // Remove trailing /
 570         if (suffixIs(buf, '/'))
 571                 buf.erase(buf.length() - 1);
 572         // Substitute empty with .
 573         if (buf.empty())
 574                 buf = '.';
 575         return buf;
 576 }
 577
 578
 579 // Append sub-directory(ies) to a path in an intelligent way
 580 string const addPath(string const & path, string const & path_2)
 581 {
 582         string buf;
 583         string const path2 = os::internal_path(path_2);
 584
 585         if (!path.empty() && path != "." && path != "./") {
 586                 buf = os::internal_path(path);
 587                 if (path[path.length() - 1] != '/')
 588                         buf += '/';
 589         }
 590
 591         if (!path2.empty()) {
 592                 string::size_type const p2start = path2.find_first_not_of('/');
 593                 string::size_type const p2end = path2.find_last_not_of('/');
 594                 string const tmp = path2.substr(p2start, p2end - p2start + 1);
 595                 buf += tmp + '/';
 596         }
 597         return buf;
 598 }
 599
 600
 601 string const changeExtension(string const & oldname, string const & extension)
 602 {
 603         string::size_type const last_slash = oldname.rfind('/');
 604         string::size_type last_dot = oldname.rfind('.');
 605         if (last_dot < last_slash && last_slash != string::npos)
 606                 last_dot = string::npos;
 607
 608         string ext;
 609         // Make sure the extension starts with a dot
 610         if (!extension.empty() && extension[0] != '.')
 611                 ext= '.' + extension;
 612         else
 613                 ext = extension;
 614
 615         return os::internal_path(oldname.substr(0, last_dot) + ext);
 616 }
 617
 618
 619 string const removeExtension(string const & name)
 620 {
 621         return changeExtension(name, string());
 622 }
 623
 624
 625 string const addExtension(string const & name, string const & extension)
 626 {
 627         if (!extension.empty() && extension[0] != '.')
 628                 return name + '.' + extension;
 629         return name + extension;
 630 }
 631
 632
 633 /// Return the extension of the file (not including the .)
 634 string const getExtension(string const & name)
 635 {
 636         string::size_type const last_slash = name.rfind('/');
 637         string::size_type const last_dot = name.rfind('.');
 638         if (last_dot != string::npos &&
 639             (last_slash == string::npos || last_dot > last_slash))
 640                 return name.substr(last_dot + 1,
 641                                    name.length() - (last_dot + 1));
 642         else
 643                 return string();
 644 }
 645
 646
 647 string const unzippedFileName(string const & zipped_file)
 648 {
 649         string const ext = getExtension(zipped_file);
 650         if (ext == "gz" || ext == "z" || ext == "Z")
 651                 return changeExtension(zipped_file, string());
 652         return "unzipped_" + zipped_file;
 653 }
 654
 655
 656 FileName const unzipFile(FileName const & zipped_file, string const & unzipped_file)
 657 {
 658         FileName const tempfile = FileName(unzipped_file.empty() ?
 659                 unzippedFileName(zipped_file.toFilesystemEncoding()) :
 660                 unzipped_file);
 661         // Run gunzip
 662         string const command = "gunzip -c " +
 663                 zipped_file.toFilesystemEncoding() + " > " +
 664                 tempfile.toFilesystemEncoding();
 665         Systemcall one;
 666         one.startscript(Systemcall::Wait, command);
 667         // test that command was executed successfully (anon)
 668         // yes, please do. (Lgb)
 669         return tempfile;
 670 }
 671
 672
 673 docstring const makeDisplayPath(string const & path, unsigned int threshold)
 674 {
 675         string str = path;
 676
 677         // If file is from LyXDir, display it as if it were relative.
 678         string const system = package().system_support().absFilename();
 679         if (prefixIs(str, system) && str != system)
 680                 return from_utf8("[" + str.erase(0, system.length()) + "]");
 681
 682         // replace /home/blah with ~/
 683         string const home = package().home_dir().absFilename();
 684         if (!home.empty() && prefixIs(str, home))
 685                 str = subst(str, home, "~");
 686
 687         if (str.length() <= threshold)
 688                 return from_utf8(os::external_path(str));
 689
 690         string const prefix = ".../";
 691         string temp;
 692
 693         while (str.length() > threshold)
 694                 str = split(str, temp, '/');
 695
 696         // Did we shorten everything away?
 697         if (str.empty()) {
 698                 // Yes, filename itself is too long.
 699                 // Pick the start and the end of the filename.
 700                 str = onlyFilename(path);
 701                 string const head = str.substr(0, threshold / 2 - 3);
 702
 703                 string::size_type len = str.length();
 704                 string const tail =
 705                         str.substr(len - threshold / 2 - 2, len - 1);
 706                 str = head + "..." + tail;
 707         }
 708
 709         return from_utf8(os::external_path(prefix + str));
 710 }
 711
 712
 713 bool readLink(FileName const & file, FileName & link)
 714 {
 715 #ifdef HAVE_READLINK
 716         char linkbuffer[512];
 717         // Should be PATH_MAX but that needs autconf support
 718         string const encoded = file.toFilesystemEncoding();
 719         int const nRead = ::readlink(encoded.c_str(),
 720                                      linkbuffer, sizeof(linkbuffer) - 1);
 721         if (nRead <= 0)
 722                 return false;
 723         linkbuffer[nRead] = '\0'; // terminator
 724         link = makeAbsPath(linkbuffer, onlyPath(file.absFilename()));
 725         return true;
 726 #else
 727         return false;
 728 #endif
 729 }
 730
 731
 732 cmd_ret const runCommand(string const & cmd)
 733 {
 734         // FIXME: replace all calls to RunCommand with ForkedCall
 735         // (if the output is not needed) or the code in ISpell.cpp
 736         // (if the output is needed).
 737
 738         // One question is if we should use popen or
 739         // create our own popen based on fork, exec, pipe
 740         // of course the best would be to have a
 741         // pstream (process stream), with the
 742         // variants ipstream, opstream
 743
 744 #if defined (HAVE_POPEN)
 745         FILE * inf = ::popen(cmd.c_str(), os::popen_read_mode());
 746 #elif defined (HAVE__POPEN)
 747         FILE * inf = ::_popen(cmd.c_str(), os::popen_read_mode());
 748 #else
 749 #error No popen() function.
 750 #endif
 751
 752         // (Claus Hentschel) Check if popen was succesful ;-)
 753         if (!inf) {
 754                 lyxerr << "RunCommand:: could not start child process" << endl;
 755                 return make_pair(-1, string());
 756         }
 757
 758         string ret;
 759         int c = fgetc(inf);
 760         while (c != EOF) {
 761                 ret += static_cast<char>(c);
 762                 c = fgetc(inf);
 763         }
 764
 765 #if defined (HAVE_PCLOSE)
 766         int const pret = pclose(inf);
 767 #elif defined (HAVE__PCLOSE)
 768         int const pret = _pclose(inf);
 769 #else
 770 #error No pclose() function.
 771 #endif
 772
 773         if (pret == -1)
 774                 perror("RunCommand:: could not terminate child process");
 775
 776         return make_pair(pret, ret);
 777 }
 778
 779
 780 FileName const findtexfile(string const & fil, string const & /*format*/)
 781 {
 782         /* There is no problem to extend this function too use other
 783            methods to look for files. It could be setup to look
 784            in environment paths and also if wanted as a last resort
 785            to a recursive find. One of the easier extensions would
 786            perhaps be to use the LyX file lookup methods. But! I am
 787            going to implement this until I see some demand for it.
 788            Lgb
 789         */
 790
 791         // If the file can be found directly, we just return a
 792         // absolute path version of it.
 793         FileName const absfile(makeAbsPath(fil));
 794         if (absfile.exists())
 795                 return absfile;
 796
 797         // No we try to find it using kpsewhich.
 798         // It seems from the kpsewhich manual page that it is safe to use
 799         // kpsewhich without --format: "When the --format option is not
 800         // given, the search path used when looking for a file is inferred
 801         // from the name given, by looking for a known extension. If no
 802         // known extension is found, the search path for TeX source files
 803         // is used."
 804         // However, we want to take advantage of the format sine almost all
 805         // the different formats has environment variables that can be used
 806         // to controll which paths to search. f.ex. bib looks in
 807         // BIBINPUTS and TEXBIB. Small list follows:
 808         // bib - BIBINPUTS, TEXBIB
 809         // bst - BSTINPUTS
 810         // graphic/figure - TEXPICTS, TEXINPUTS
 811         // ist - TEXINDEXSTYLE, INDEXSTYLE
 812         // pk - PROGRAMFONTS, PKFONTS, TEXPKS, GLYPHFONTS, TEXFONTS
 813         // tex - TEXINPUTS
 814         // tfm - TFMFONTS, TEXFONTS
 815         // This means that to use kpsewhich in the best possible way we
 816         // should help it by setting additional path in the approp. envir.var.
 817         string const kpsecmd = "kpsewhich " + fil;
 818
 819         cmd_ret const c = runCommand(kpsecmd);
 820
 821         LYXERR(Debug::LATEX, "kpse status = " << c.first << '\n'
 822                  << "kpse result = `" << rtrim(c.second, "\n\r") << '\'');
 823         if (c.first != -1)
 824                 return FileName(rtrim(to_utf8(from_filesystem8bit(c.second)), "\n\r"));
 825         else
 826                 return FileName();
 827 }
 828
 829
 830 void removeAutosaveFile(string const & filename)
 831 {
 832         string a = onlyPath(filename);
 833         a += '#';
 834         a += onlyFilename(filename);
 835         a += '#';
 836         FileName const autosave(a);
 837         if (autosave.exists())
 838                 autosave.removeFile();
 839 }
 840
 841
 842 void readBB_lyxerrMessage(FileName const & file, bool & zipped,
 843         string const & message)
 844 {
 845         LYXERR(Debug::GRAPHICS, "[readBB_from_PSFile] " << message);
 846         // FIXME: Why is this func deleting a file? (Lgb)
 847         if (zipped)
 848                 file.removeFile();
 849 }
 850
 851
 852 string const readBB_from_PSFile(FileName const & file)
 853 {
 854         // in a (e)ps-file it's an entry like %%BoundingBox:23 45 321 345
 855         // It seems that every command in the header has an own line,
 856         // getline() should work for all files.
 857         // On the other hand some plot programs write the bb at the
 858         // end of the file. Than we have in the header:
 859         // %%BoundingBox: (atend)
 860         // In this case we must check the end.
 861         bool zipped = file.isZippedFile();
 862         FileName const file_ = zipped ? unzipFile(file) : file;
 863         string const format = file_.guessFormatFromContents();
 864
 865         if (format != "eps" && format != "ps") {
 866                 readBB_lyxerrMessage(file_, zipped,"no(e)ps-format");
 867                 return string();
 868         }
 869
 870         static boost::regex bbox_re(
 871                 "^%%BoundingBox:\\s*([[:digit:]]+)\\s+([[:digit:]]+)\\s+([[:digit:]]+)\\s+([[:digit:]]+)");
 872         ifstream is(file_.toFilesystemEncoding().c_str());
 873         while (is) {
 874                 string s;
 875                 getline(is,s);
 876                 boost::smatch what;
 877                 if (regex_match(s, what, bbox_re)) {
 878                         // Our callers expect the tokens in the string
 879                         // separated by single spaces.
 880                         // FIXME: change return type from string to something
 881                         // sensible
 882                         ostringstream os;
 883                         os << what.str(1) << ' ' << what.str(2) << ' '
 884                            << what.str(3) << ' ' << what.str(4);
 885                         string const bb = os.str();
 886                         readBB_lyxerrMessage(file_, zipped, bb);
 887                         return bb;
 888                 }
 889         }
 890         readBB_lyxerrMessage(file_, zipped, "no bb found");
 891         return string();
 892 }
 893
 894
 895 int compare_timestamps(FileName const & file1, FileName const & file2)
 896 {
 897         // If the original is newer than the copy, then copy the original
 898         // to the new directory.
 899
 900         int cmp = 0;
 901         if (file1.exists() && file2.exists()) {
 902                 double const tmp = difftime(file1.lastModified(), file2.lastModified());
 903                 if (tmp != 0)
 904                         cmp = tmp > 0 ? 1 : -1;
 905
 906         } else if (file1.exists()) {
 907                 cmp = 1;
 908         } else if (file2.exists()) {
 909                 cmp = -1;
 910         }
 911
 912         return cmp;
 913 }
 914
 915
 916 } //namespace support
 917 } // namespace lyx