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 == allow_unreadable ? 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 == allow_unreadable)
 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 string const createBufferTmpDir()
 342 {
 343         static int count;
 344         // We are in our own directory.  Why bother to mangle name?
 345         // In fact I wrote this code to circumvent a problematic behaviour
 346         // (bug?) of EMX mkstemp().
 347         string const tmpfl =
 348                 package().temp_dir().absFilename() + "/lyx_tmpbuf" +
 349                 convert<string>(count++);
 350
 351         if (!FileName(tmpfl).createDirectory(0777)) {
 352                 lyxerr << "LyX could not create the temporary directory '"
 353                        << tmpfl << "'" << endl;
 354                 return string();
 355         }
 356         return tmpfl;
 357 }
 358
 359
 360 FileName const createLyXTmpDir(FileName const & deflt)
 361 {
 362         if (deflt.empty() || deflt.absFilename() == "/tmp")
 363                 return createTmpDir(FileName("/tmp"), "lyx_tmpdir");
 364
 365         if (deflt.createDirectory(0777))
 366                 return deflt;
 367
 368         if (deflt.isDirWritable()) {
 369                 // deflt could not be created because it
 370                 // did exist already, so let's create our own
 371                 // dir inside deflt.
 372                 return createTmpDir(deflt, "lyx_tmpdir");
 373         } else {
 374                 // some other error occured.
 375                 return createTmpDir(FileName("/tmp"), "lyx_tmpdir");
 376         }
 377 }
 378
 379
 380 // Strip filename from path name
 381 string const onlyPath(string const & filename)
 382 {
 383         // If empty filename, return empty
 384         if (filename.empty())
 385                 return filename;
 386
 387         // Find last / or start of filename
 388         size_t j = filename.rfind('/');
 389         return j == string::npos ? "./" : filename.substr(0, j + 1);
 390 }
 391
 392
 393 // Convert relative path into absolute path based on a basepath.
 394 // If relpath is absolute, just use that.
 395 // If basepath is empty, use CWD as base.
 396 FileName const makeAbsPath(string const & relPath, string const & basePath)
 397 {
 398         // checks for already absolute path
 399         if (os::is_absolute_path(relPath))
 400                 return FileName(relPath);
 401
 402         // Copies given paths
 403         string tempRel = os::internal_path(relPath);
 404         // Since TempRel is NOT absolute, we can safely replace "//" with "/"
 405         tempRel = subst(tempRel, "//", "/");
 406
 407         string tempBase;
 408
 409         if (os::is_absolute_path(basePath))
 410                 tempBase = basePath;
 411         else
 412                 tempBase = addPath(FileName::getcwd().absFilename(), basePath);
 413
 414         // Handle /./ at the end of the path
 415         while (suffixIs(tempBase, "/./"))
 416                 tempBase.erase(tempBase.length() - 2);
 417
 418         // processes relative path
 419         string rTemp = tempRel;
 420         string temp;
 421
 422         while (!rTemp.empty()) {
 423                 // Split by next /
 424                 rTemp = split(rTemp, temp, '/');
 425
 426                 if (temp == ".") continue;
 427                 if (temp == "..") {
 428                         // Remove one level of TempBase
 429                         string::difference_type i = tempBase.length() - 2;
 430                         if (i < 0)
 431                                 i = 0;
 432                         while (i > 0 && tempBase[i] != '/')
 433                                 --i;
 434                         if (i > 0)
 435                                 tempBase.erase(i, string::npos);
 436                         else
 437                                 tempBase += '/';
 438                 } else if (temp.empty() && !rTemp.empty()) {
 439                                 tempBase = os::current_root() + rTemp;
 440                                 rTemp.erase();
 441                 } else {
 442                         // Add this piece to TempBase
 443                         if (!suffixIs(tempBase, '/'))
 444                                 tempBase += '/';
 445                         tempBase += temp;
 446                 }
 447         }
 448
 449         // returns absolute path
 450         return FileName(tempBase);
 451 }
 452
 453
 454 // Correctly append filename to the pathname.
 455 // If pathname is '.', then don't use pathname.
 456 // Chops any path of filename.
 457 string const addName(string const & path, string const & fname)
 458 {
 459         string const basename = onlyFilename(fname);
 460         string buf;
 461
 462         if (path != "." && path != "./" && !path.empty()) {
 463                 buf = os::internal_path(path);
 464                 if (!suffixIs(path, '/'))
 465                         buf += '/';
 466         }
 467
 468         return buf + basename;
 469 }
 470
 471
 472 // Strips path from filename
 473 string const onlyFilename(string const & fname)
 474 {
 475         if (fname.empty())
 476                 return fname;
 477
 478         string::size_type j = fname.rfind('/');
 479         if (j == string::npos) // no '/' in fname
 480                 return fname;
 481
 482         // Strip to basename
 483         return fname.substr(j + 1);
 484 }
 485
 486
 487 /// Returns true is path is absolute
 488 bool absolutePath(string const & path)
 489 {
 490         return os::is_absolute_path(path);
 491 }
 492
 493
 494 // Create absolute path. If impossible, don't do anything
 495 // Supports ./ and ~/. Later we can add support for ~logname/. (Asger)
 496 string const expandPath(string const & path)
 497 {
 498         // checks for already absolute path
 499         string rTemp = replaceEnvironmentPath(path);
 500         if (os::is_absolute_path(rTemp))
 501                 return rTemp;
 502
 503         string temp;
 504         string const copy = rTemp;
 505
 506         // Split by next /
 507         rTemp = split(rTemp, temp, '/');
 508
 509         if (temp == ".")
 510                 return FileName::getcwd().absFilename() + '/' + rTemp;
 511
 512         if (temp == "~")
 513                 return package().home_dir().absFilename() + '/' + rTemp;
 514
 515         if (temp == "..")
 516                 return makeAbsPath(copy).absFilename();
 517
 518         // Don't know how to handle this
 519         return copy;
 520 }
 521
 522
 523 // Search the string for ${VAR} and $VAR and replace VAR using getenv.
 524 string const replaceEnvironmentPath(string const & path)
 525 {
 526         // ${VAR} is defined as
 527         // $\{[A-Za-z_][A-Za-z_0-9]*\}
 528         static string const envvar_br = "[$]\\{([A-Za-z_][A-Za-z_0-9]*)\\}";
 529
 530         // $VAR is defined as:
 531         // $\{[A-Za-z_][A-Za-z_0-9]*\}
 532         static string const envvar = "[$]([A-Za-z_][A-Za-z_0-9]*)";
 533
 534         static boost::regex envvar_br_re("(.*)" + envvar_br + "(.*)");
 535         static boost::regex envvar_re("(.*)" + envvar + "(.*)");
 536         boost::smatch what;
 537
 538         string result = path;
 539         while (1) {
 540                 regex_match(result, what, envvar_br_re);
 541                 if (!what[0].matched) {
 542                         regex_match(result, what, envvar_re);
 543                         if (!what[0].matched)
 544                                 break;
 545                 }
 546                 result = what.str(1) + getEnv(what.str(2)) + what.str(3);
 547         }
 548         return result;
 549 }
 550
 551
 552 // Make relative path out of two absolute paths
 553 docstring const makeRelPath(docstring const & abspath, docstring const & basepath)
 554 // Makes relative path out of absolute path. If it is deeper than basepath,
 555 // it's easy. If basepath and abspath share something (they are all deeper
 556 // than some directory), it'll be rendered using ..'s. If they are completely
 557 // different, then the absolute path will be used as relative path.
 558 {
 559         docstring::size_type const abslen = abspath.length();
 560         docstring::size_type const baselen = basepath.length();
 561
 562         docstring::size_type i = os::common_path(abspath, basepath);
 563
 564         if (i == 0) {
 565                 // actually no match - cannot make it relative
 566                 return abspath;
 567         }
 568
 569         // Count how many dirs there are in basepath above match
 570         // and append as many '..''s into relpath
 571         docstring buf;
 572         docstring::size_type j = i;
 573         while (j < baselen) {
 574                 if (basepath[j] == '/') {
 575                         if (j + 1 == baselen)
 576                                 break;
 577                         buf += "../";
 578                 }
 579                 ++j;
 580         }
 581
 582         // Append relative stuff from common directory to abspath
 583         if (abspath[i] == '/')
 584                 ++i;
 585         for (; i < abslen; ++i)
 586                 buf += abspath[i];
 587         // Remove trailing /
 588         if (suffixIs(buf, '/'))
 589                 buf.erase(buf.length() - 1);
 590         // Substitute empty with .
 591         if (buf.empty())
 592                 buf = '.';
 593         return buf;
 594 }
 595
 596
 597 // Append sub-directory(ies) to a path in an intelligent way
 598 string const addPath(string const & path, string const & path_2)
 599 {
 600         string buf;
 601         string const path2 = os::internal_path(path_2);
 602
 603         if (!path.empty() && path != "." && path != "./") {
 604                 buf = os::internal_path(path);
 605                 if (path[path.length() - 1] != '/')
 606                         buf += '/';
 607         }
 608
 609         if (!path2.empty()) {
 610                 string::size_type const p2start = path2.find_first_not_of('/');
 611                 string::size_type const p2end = path2.find_last_not_of('/');
 612                 string const tmp = path2.substr(p2start, p2end - p2start + 1);
 613                 buf += tmp + '/';
 614         }
 615         return buf;
 616 }
 617
 618
 619 string const changeExtension(string const & oldname, string const & extension)
 620 {
 621         string::size_type const last_slash = oldname.rfind('/');
 622         string::size_type last_dot = oldname.rfind('.');
 623         if (last_dot < last_slash && last_slash != string::npos)
 624                 last_dot = string::npos;
 625
 626         string ext;
 627         // Make sure the extension starts with a dot
 628         if (!extension.empty() && extension[0] != '.')
 629                 ext= '.' + extension;
 630         else
 631                 ext = extension;
 632
 633         return os::internal_path(oldname.substr(0, last_dot) + ext);
 634 }
 635
 636
 637 string const removeExtension(string const & name)
 638 {
 639         return changeExtension(name, string());
 640 }
 641
 642
 643 string const addExtension(string const & name, string const & extension)
 644 {
 645         if (!extension.empty() && extension[0] != '.')
 646                 return name + '.' + extension;
 647         return name + extension;
 648 }
 649
 650
 651 /// Return the extension of the file (not including the .)
 652 string const getExtension(string const & name)
 653 {
 654         string::size_type const last_slash = name.rfind('/');
 655         string::size_type const last_dot = name.rfind('.');
 656         if (last_dot != string::npos &&
 657             (last_slash == string::npos || last_dot > last_slash))
 658                 return name.substr(last_dot + 1,
 659                                    name.length() - (last_dot + 1));
 660         else
 661                 return string();
 662 }
 663
 664
 665 string const unzippedFileName(string const & zipped_file)
 666 {
 667         string const ext = getExtension(zipped_file);
 668         if (ext == "gz" || ext == "z" || ext == "Z")
 669                 return changeExtension(zipped_file, string());
 670         return "unzipped_" + zipped_file;
 671 }
 672
 673
 674 FileName const unzipFile(FileName const & zipped_file, string const & unzipped_file)
 675 {
 676         FileName const tempfile = FileName(unzipped_file.empty() ?
 677                 unzippedFileName(zipped_file.toFilesystemEncoding()) :
 678                 unzipped_file);
 679         // Run gunzip
 680         string const command = "gunzip -c " +
 681                 zipped_file.toFilesystemEncoding() + " > " +
 682                 tempfile.toFilesystemEncoding();
 683         Systemcall one;
 684         one.startscript(Systemcall::Wait, command);
 685         // test that command was executed successfully (anon)
 686         // yes, please do. (Lgb)
 687         return tempfile;
 688 }
 689
 690
 691 docstring const makeDisplayPath(string const & path, unsigned int threshold)
 692 {
 693         string str = path;
 694
 695         // If file is from LyXDir, display it as if it were relative.
 696         string const system = package().system_support().absFilename();
 697         if (prefixIs(str, system) && str != system)
 698                 return from_utf8("[" + str.erase(0, system.length()) + "]");
 699
 700         // replace /home/blah with ~/
 701         string const home = package().home_dir().absFilename();
 702         if (!home.empty() && prefixIs(str, home))
 703                 str = subst(str, home, "~");
 704
 705         if (str.length() <= threshold)
 706                 return from_utf8(os::external_path(str));
 707
 708         string const prefix = ".../";
 709         string temp;
 710
 711         while (str.length() > threshold)
 712                 str = split(str, temp, '/');
 713
 714         // Did we shorten everything away?
 715         if (str.empty()) {
 716                 // Yes, filename itself is too long.
 717                 // Pick the start and the end of the filename.
 718                 str = onlyFilename(path);
 719                 string const head = str.substr(0, threshold / 2 - 3);
 720
 721                 string::size_type len = str.length();
 722                 string const tail =
 723                         str.substr(len - threshold / 2 - 2, len - 1);
 724                 str = head + "..." + tail;
 725         }
 726
 727         return from_utf8(os::external_path(prefix + str));
 728 }
 729
 730
 731 bool readLink(FileName const & file, FileName & link)
 732 {
 733 #ifdef HAVE_READLINK
 734         char linkbuffer[512];
 735         // Should be PATH_MAX but that needs autconf support
 736         string const encoded = file.toFilesystemEncoding();
 737         int const nRead = ::readlink(encoded.c_str(),
 738                                      linkbuffer, sizeof(linkbuffer) - 1);
 739         if (nRead <= 0)
 740                 return false;
 741         linkbuffer[nRead] = '\0'; // terminator
 742         link = makeAbsPath(linkbuffer, onlyPath(file.absFilename()));
 743         return true;
 744 #else
 745         return false;
 746 #endif
 747 }
 748
 749
 750 cmd_ret const runCommand(string const & cmd)
 751 {
 752         // FIXME: replace all calls to RunCommand with ForkedCall
 753         // (if the output is not needed) or the code in ISpell.cpp
 754         // (if the output is needed).
 755
 756         // One question is if we should use popen or
 757         // create our own popen based on fork, exec, pipe
 758         // of course the best would be to have a
 759         // pstream (process stream), with the
 760         // variants ipstream, opstream
 761
 762 #if defined (HAVE_POPEN)
 763         FILE * inf = ::popen(cmd.c_str(), os::popen_read_mode());
 764 #elif defined (HAVE__POPEN)
 765         FILE * inf = ::_popen(cmd.c_str(), os::popen_read_mode());
 766 #else
 767 #error No popen() function.
 768 #endif
 769
 770         // (Claus Hentschel) Check if popen was succesful ;-)
 771         if (!inf) {
 772                 lyxerr << "RunCommand:: could not start child process" << endl;
 773                 return make_pair(-1, string());
 774         }
 775
 776         string ret;
 777         int c = fgetc(inf);
 778         while (c != EOF) {
 779                 ret += static_cast<char>(c);
 780                 c = fgetc(inf);
 781         }
 782
 783 #if defined (HAVE_PCLOSE)
 784         int const pret = pclose(inf);
 785 #elif defined (HAVE__PCLOSE)
 786         int const pret = _pclose(inf);
 787 #else
 788 #error No pclose() function.
 789 #endif
 790
 791         if (pret == -1)
 792                 perror("RunCommand:: could not terminate child process");
 793
 794         return make_pair(pret, ret);
 795 }
 796
 797
 798 FileName const findtexfile(string const & fil, string const & /*format*/)
 799 {
 800         /* There is no problem to extend this function too use other
 801            methods to look for files. It could be setup to look
 802            in environment paths and also if wanted as a last resort
 803            to a recursive find. One of the easier extensions would
 804            perhaps be to use the LyX file lookup methods. But! I am
 805            going to implement this until I see some demand for it.
 806            Lgb
 807         */
 808
 809         // If the file can be found directly, we just return a
 810         // absolute path version of it.
 811         FileName const absfile(makeAbsPath(fil));
 812         if (absfile.exists())
 813                 return absfile;
 814
 815         // No we try to find it using kpsewhich.
 816         // It seems from the kpsewhich manual page that it is safe to use
 817         // kpsewhich without --format: "When the --format option is not
 818         // given, the search path used when looking for a file is inferred
 819         // from the name given, by looking for a known extension. If no
 820         // known extension is found, the search path for TeX source files
 821         // is used."
 822         // However, we want to take advantage of the format sine almost all
 823         // the different formats has environment variables that can be used
 824         // to controll which paths to search. f.ex. bib looks in
 825         // BIBINPUTS and TEXBIB. Small list follows:
 826         // bib - BIBINPUTS, TEXBIB
 827         // bst - BSTINPUTS
 828         // graphic/figure - TEXPICTS, TEXINPUTS
 829         // ist - TEXINDEXSTYLE, INDEXSTYLE
 830         // pk - PROGRAMFONTS, PKFONTS, TEXPKS, GLYPHFONTS, TEXFONTS
 831         // tex - TEXINPUTS
 832         // tfm - TFMFONTS, TEXFONTS
 833         // This means that to use kpsewhich in the best possible way we
 834         // should help it by setting additional path in the approp. envir.var.
 835         string const kpsecmd = "kpsewhich " + fil;
 836
 837         cmd_ret const c = runCommand(kpsecmd);
 838
 839         LYXERR(Debug::LATEX, "kpse status = " << c.first << '\n'
 840                  << "kpse result = `" << rtrim(c.second, "\n\r") << '\'');
 841         if (c.first != -1)
 842                 return FileName(rtrim(to_utf8(from_filesystem8bit(c.second)), "\n\r"));
 843         else
 844                 return FileName();
 845 }
 846
 847
 848 void removeAutosaveFile(string const & filename)
 849 {
 850         string a = onlyPath(filename);
 851         a += '#';
 852         a += onlyFilename(filename);
 853         a += '#';
 854         FileName const autosave(a);
 855         if (autosave.exists())
 856                 autosave.removeFile();
 857 }
 858
 859
 860 void readBB_lyxerrMessage(FileName const & file, bool & zipped,
 861         string const & message)
 862 {
 863         LYXERR(Debug::GRAPHICS, "[readBB_from_PSFile] " << message);
 864         // FIXME: Why is this func deleting a file? (Lgb)
 865         if (zipped)
 866                 file.removeFile();
 867 }
 868
 869
 870 string const readBB_from_PSFile(FileName const & file)
 871 {
 872         // in a (e)ps-file it's an entry like %%BoundingBox:23 45 321 345
 873         // It seems that every command in the header has an own line,
 874         // getline() should work for all files.
 875         // On the other hand some plot programs write the bb at the
 876         // end of the file. Than we have in the header:
 877         // %%BoundingBox: (atend)
 878         // In this case we must check the end.
 879         bool zipped = file.isZippedFile();
 880         FileName const file_ = zipped ? unzipFile(file) : file;
 881         string const format = file_.guessFormatFromContents();
 882
 883         if (format != "eps" && format != "ps") {
 884                 readBB_lyxerrMessage(file_, zipped,"no(e)ps-format");
 885                 return string();
 886         }
 887
 888         static boost::regex bbox_re(
 889                 "^%%BoundingBox:\\s*([[:digit:]]+)\\s+([[:digit:]]+)\\s+([[:digit:]]+)\\s+([[:digit:]]+)");
 890         ifstream is(file_.toFilesystemEncoding().c_str());
 891         while (is) {
 892                 string s;
 893                 getline(is,s);
 894                 boost::smatch what;
 895                 if (regex_match(s, what, bbox_re)) {
 896                         // Our callers expect the tokens in the string
 897                         // separated by single spaces.
 898                         // FIXME: change return type from string to something
 899                         // sensible
 900                         ostringstream os;
 901                         os << what.str(1) << ' ' << what.str(2) << ' '
 902                            << what.str(3) << ' ' << what.str(4);
 903                         string const bb = os.str();
 904                         readBB_lyxerrMessage(file_, zipped, bb);
 905                         return bb;
 906                 }
 907         }
 908         readBB_lyxerrMessage(file_, zipped, "no bb found");
 909         return string();
 910 }
 911
 912
 913 int compare_timestamps(FileName const & file1, FileName const & file2)
 914 {
 915         // If the original is newer than the copy, then copy the original
 916         // to the new directory.
 917
 918         int cmp = 0;
 919         if (file1.exists() && file2.exists()) {
 920                 double const tmp = difftime(file1.lastModified(), file2.lastModified());
 921                 if (tmp != 0)
 922                         cmp = tmp > 0 ? 1 : -1;
 923
 924         } else if (file1.exists()) {
 925                 cmp = 1;
 926         } else if (file2.exists()) {
 927                 cmp = -1;
 928         }
 929
 930         return cmp;
 931 }
 932
 933
 934 } //namespace support
 935 } // namespace lyx