src/support/filetools.C

   1 /**
   2  * \file filetools.C
   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  *
  14  * Full author contact details are available in file CREDITS
  15  *
  16  * General path-mangling functions
  17  */
  18
  19 #include <config.h>
  20
  21 #include "debug.h"
  22 #include "support/lstrings.h"
  23 #include "support/systemcall.h"
  24
  25 #include "filetools.h"
  26 #include "lstrings.h"
  27 #include "frontends/Alert.h"
  28 #include "FileInfo.h"
  29 #include "support/path.h"        // I know it's OS/2 specific (SMiyata)
  30 #include "gettext.h"
  31 #include "lyxlib.h"
  32 #include "os.h"
  33
  34 #include "Lsstream.h"
  35
  36 #include <cctype>
  37 #include <cstdlib>
  38 #include <cstdio>
  39 #include <fcntl.h>
  40 #include <cerrno>
  41
  42 #include <utility>
  43 #include <fstream>
  44
  45
  46 // Which part of this is still necessary? (JMarc).
  47 #if HAVE_DIRENT_H
  48 # include <dirent.h>
  49 # define NAMLEN(dirent) strlen((dirent)->d_name)
  50 #else
  51 # define dirent direct
  52 # define NAMLEN(dirent) (dirent)->d_namlen
  53 # if HAVE_SYS_NDIR_H
  54 #  include <sys/ndir.h>
  55 # endif
  56 # if HAVE_SYS_DIR_H
  57 #  include <sys/dir.h>
  58 # endif
  59 # if HAVE_NDIR_H
  60 #  include <ndir.h>
  61 # endif
  62 #endif
  63
  64 #ifndef CXX_GLOBAL_CSTD
  65 using std::fgetc;
  66 using std::isalpha;
  67 using std::isalnum;
  68 #endif
  69
  70 using std::make_pair;
  71 using std::pair;
  72 using std::endl;
  73 using std::ifstream;
  74 using std::vector;
  75 using std::getline;
  76
  77 extern string system_lyxdir;
  78 extern string build_lyxdir;
  79 extern string user_lyxdir;
  80
  81
  82 bool IsLyXFilename(string const & filename)
  83 {
  84         return suffixIs(ascii_lowercase(filename), ".lyx");
  85 }
  86
  87
  88 bool IsSGMLFilename(string const & filename)
  89 {
  90         return suffixIs(ascii_lowercase(filename), ".sgml");
  91 }
  92
  93
  94 // Substitutes spaces with underscores in filename (and path)
  95 string const MakeLatexName(string const & file)
  96 {
  97         string name = OnlyFilename(file);
  98         string const path = OnlyPath(file);
  99
 100         for (string::size_type i = 0; i < name.length(); ++i) {
 101                 name[i] &= 0x7f; // set 8th bit to 0
 102         };
 103
 104         // ok so we scan through the string twice, but who cares.
 105         string const keep("abcdefghijklmnopqrstuvwxyz"
 106                 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
 107                 "@!\"'()*+,-./0123456789:;<=>?[]`|");
 108
 109         string::size_type pos = 0;
 110         while ((pos = name.find_first_not_of(keep, pos)) != string::npos) {
 111                 name[pos++] = '_';
 112         }
 113         return AddName(path, name);
 114 }
 115
 116
 117 // Substitutes spaces with underscores in filename (and path)
 118 string const QuoteName(string const & name)
 119 {
 120         return (os::shell() == os::UNIX) ?
 121                 '\'' + name + '\'':
 122                 '"' + name + '"';
 123 }
 124
 125
 126 // Is a file readable ?
 127 bool IsFileReadable(string const & path)
 128 {
 129         FileInfo file(path);
 130         return file.isOK() && file.isRegular() && file.readable();
 131 }
 132
 133
 134 // Is a file read_only?
 135 // return 1 read-write
 136 //        0 read_only
 137 //       -1 error (doesn't exist, no access, anything else)
 138 int IsFileWriteable(string const & path)
 139 {
 140         FileInfo fi(path);
 141
 142         if (fi.access(FileInfo::wperm|FileInfo::rperm)) // read-write
 143                 return 1;
 144         if (fi.readable()) // read-only
 145                 return 0;
 146         return -1; // everything else.
 147 }
 148
 149
 150 //returns true: dir writeable
 151 //        false: not writeable
 152 bool IsDirWriteable(string const & path)
 153 {
 154         lyxerr[Debug::FILES] << "IsDirWriteable: " << path << endl;
 155
 156         string const tmpfl(lyx::tempName(path, "lyxwritetest"));
 157
 158         if (tmpfl.empty())
 159                 return false;
 160
 161         lyx::unlink(tmpfl);
 162         return true;
 163 }
 164
 165
 166 // Uses a string of paths separated by ";"s to find a file to open.
 167 // Can't cope with pathnames with a ';' in them. Returns full path to file.
 168 // If path entry begins with $$LyX/, use system_lyxdir
 169 // If path entry begins with $$User/, use user_lyxdir
 170 // Example: "$$User/doc;$$LyX/doc"
 171 string const FileOpenSearch(string const & path, string const & name,
 172                              string const & ext)
 173 {
 174         string real_file;
 175         string path_element;
 176         bool notfound = true;
 177         string tmppath = split(path, path_element, ';');
 178
 179         while (notfound && !path_element.empty()) {
 180                 path_element = os::slashify_path(path_element);
 181                 if (!suffixIs(path_element, '/'))
 182                         path_element+= '/';
 183                 path_element = subst(path_element, "$$LyX", system_lyxdir);
 184                 path_element = subst(path_element, "$$User", user_lyxdir);
 185
 186                 real_file = FileSearch(path_element, name, ext);
 187
 188                 if (real_file.empty()) {
 189                         do {
 190                                 tmppath = split(tmppath, path_element, ';');
 191                         } while (!tmppath.empty() && path_element.empty());
 192                 } else {
 193                         notfound = false;
 194                 }
 195         }
 196 #ifdef __EMX__
 197         if (ext.empty() && notfound) {
 198                 real_file = FileOpenSearch(path, name, "exe");
 199                 if (notfound) real_file = FileOpenSearch(path, name, "cmd");
 200         }
 201 #endif
 202         return real_file;
 203 }
 204
 205
 206 /// Returns a vector of all files in directory dir having extension ext.
 207 vector<string> const DirList(string const & dir, string const & ext)
 208 {
 209         // This is a non-error checking C/system implementation
 210         string extension;
 211         if (!ext.empty() && ext[0] != '.')
 212                 extension += '.';
 213         extension += ext;
 214
 215         vector<string> dirlist;
 216         DIR * dirp = ::opendir(dir.c_str());
 217         if (!dirp) {
 218                 lyxerr[Debug::FILES]
 219                         << "Directory \"" << dir
 220                         << "\" does not exist to DirList." << endl;
 221                 return dirlist;
 222         }
 223
 224         dirent * dire;
 225         while ((dire = ::readdir(dirp))) {
 226                 string const fil = dire->d_name;
 227                 if (suffixIs(fil, extension)) {
 228                         dirlist.push_back(fil);
 229                 }
 230         }
 231         ::closedir(dirp);
 232         return dirlist;
 233         /* I would have prefered to take a vector<string>& as parameter so
 234            that we could avoid the copy of the vector when returning.
 235            Then we would use:
 236            dirlist.swap(argvec);
 237            to avoid the copy. (Lgb)
 238         */
 239         /* A C++ implementaion will look like this:
 240            string extension(ext);
 241            if (extension[0] != '.') extension.insert(0, 1, '.');
 242            vector<string> dirlist;
 243            directory_iterator dit("dir");
 244            while (dit != directory_iterator()) {
 245                    string fil = dit->filename;
 246                    if (prefixIs(fil, extension)) {
 247                            dirlist.push_back(fil);
 248                    }
 249                    ++dit;
 250            }
 251            dirlist.swap(argvec);
 252            return;
 253         */
 254 }
 255
 256
 257 // Returns the real name of file name in directory path, with optional
 258 // extension ext.
 259 string const FileSearch(string const & path, string const & name,
 260                         string const & ext)
 261 {
 262         // if `name' is an absolute path, we ignore the setting of `path'
 263         // Expand Environmentvariables in 'name'
 264         string const tmpname = ReplaceEnvironmentPath(name);
 265         string fullname = MakeAbsPath(tmpname, path);
 266         // search first without extension, then with it.
 267         if (IsFileReadable(fullname))
 268                 return fullname;
 269         else if (ext.empty())
 270                 return string();
 271         else { // Is it not more reasonable to use ChangeExtension()? (SMiyata)
 272                 fullname += '.';
 273                 fullname += ext;
 274                 if (IsFileReadable(fullname))
 275                         return fullname;
 276                 else
 277                         return string();
 278         }
 279 }
 280
 281
 282 // Search the file name.ext in the subdirectory dir of
 283 //   1) user_lyxdir
 284 //   2) build_lyxdir (if not empty)
 285 //   3) system_lyxdir
 286 string const LibFileSearch(string const & dir, string const & name,
 287                            string const & ext)
 288 {
 289         string fullname = FileSearch(AddPath(user_lyxdir, dir), name, ext);
 290         if (!fullname.empty())
 291                 return fullname;
 292
 293         if (!build_lyxdir.empty())
 294                 fullname = FileSearch(AddPath(build_lyxdir, dir), name, ext);
 295         if (!fullname.empty())
 296                 return fullname;
 297
 298         return FileSearch(AddPath(system_lyxdir, dir), name, ext);
 299 }
 300
 301
 302 string const
 303 i18nLibFileSearch(string const & dir, string const & name,
 304                   string const & ext)
 305 {
 306         // this comment is from intl/dcigettext.c. We try to mimick this
 307         // behaviour here.
 308         /* The highest priority value is the `LANGUAGE' environment
 309            variable. But we don't use the value if the currently
 310            selected locale is the C locale. This is a GNU extension. */
 311
 312         string const lc_all = GetEnv("LC_ALL");
 313         string lang = GetEnv("LANGUAGE");
 314         if (lang.empty() || lc_all == "C") {
 315                 lang = lc_all;
 316                 if (lang.empty()) {
 317                         lang = GetEnv("LANG");
 318                 }
 319         }
 320
 321         lang = token(lang, '_', 0);
 322
 323         if (lang.empty() || lang == "C")
 324                 return LibFileSearch(dir, name, ext);
 325         else {
 326                 string const tmp = LibFileSearch(dir, lang + '_' + name,
 327                                                  ext);
 328                 if (!tmp.empty())
 329                         return tmp;
 330                 else
 331                         return LibFileSearch(dir, name, ext);
 332         }
 333 }
 334
 335
 336 string const LibScriptSearch(string const & command)
 337 {
 338         string script;
 339         string args = command;
 340         args = split(args, script, ' ');
 341         script = LibFileSearch("scripts", script);
 342         if (script.empty())
 343                 return command;
 344         else if (args.empty())
 345                 return script;
 346         else
 347                 return script + ' ' + args;
 348 }
 349
 350
 351 string const GetEnv(string const & envname)
 352 {
 353         // f.ex. what about error checking?
 354         char const * const ch = getenv(envname.c_str());
 355         string const envstr = !ch ? "" : ch;
 356         return envstr;
 357 }
 358
 359
 360 string const GetEnvPath(string const & name)
 361 {
 362 #ifndef __EMX__
 363         string const pathlist = subst(GetEnv(name), ':', ';');
 364 #else
 365         string const pathlist = os::slashify_path(GetEnv(name));
 366 #endif
 367         return rtrim(pathlist, ";");
 368 }
 369
 370
 371 bool PutEnv(string const & envstr)
 372 {
 373         // CHECK Look at and fix this.
 374         // f.ex. what about error checking?
 375
 376 #if HAVE_PUTENV
 377         // this leaks, but what can we do about it?
 378         //   Is doing a getenv() and a free() of the older value
 379         //   a good idea? (JMarc)
 380         // Actually we don't have to leak...calling putenv like this
 381         // should be enough: ... and this is obviously not enough if putenv
 382         // does not make a copy of the string. It is also not very wise to
 383         // put a string on the free store. If we have to leak we should do it
 384         // like this:
 385         char * leaker = new char[envstr.length() + 1];
 386         envstr.copy(leaker, envstr.length());
 387         leaker[envstr.length()] = '\0';
 388         int const retval = lyx::putenv(leaker);
 389
 390         // If putenv does not make a copy of the char const * this
 391         // is very dangerous. OTOH if it does take a copy this is the
 392         // best solution.
 393         // The  only implementation of putenv that I have seen does not
 394         // allocate memory. _And_ after testing the putenv in glibc it
 395         // seems that we need to make a copy of the string contents.
 396         // I will enable the above.
 397         //int retval = lyx::putenv(envstr.c_str());
 398 #else
 399 #ifdef HAVE_SETENV
 400         string varname;
 401         string const str = envstr.split(varname,'=');
 402         int const retval = ::setenv(varname.c_str(), str.c_str(), true);
 403 #else
 404         // No environment setting function. Can this happen?
 405         int const retval = 1; //return an error condition.
 406 #endif
 407 #endif
 408         return retval == 0;
 409 }
 410
 411
 412 bool PutEnvPath(string const & envstr)
 413 {
 414         return PutEnv(envstr);
 415 }
 416
 417
 418 namespace {
 419
 420 int DeleteAllFilesInDir(string const & path)
 421 {
 422         // I have decided that we will be using parts from the boost
 423         // library. Check out http://www.boost.org/
 424         // For directory access we will then use the directory_iterator.
 425         // Then the code will be something like:
 426         // directory_iterator dit(path);
 427         // directory_iterator dend;
 428         // if (dit == dend) {
 429         //         Alert::err_alert(_("Error! Cannot open directory:"), path);
 430         //         return -1;
 431         // }
 432         // for (; dit != dend; ++dit) {
 433         //         string filename(*dit);
 434         //         if (filename == "." || filename == "..")
 435         //                 continue;
 436         //         string unlinkpath(AddName(path, filename));
 437         //         if (lyx::unlink(unlinkpath))
 438         //                 Alert::err_alert(_("Error! Could not remove file:"),
 439         //                              unlinkpath);
 440         // }
 441         // return 0;
 442         DIR * dir = ::opendir(path.c_str());
 443         if (!dir) {
 444                 Alert::err_alert (_("Error! Cannot open directory:"), path);
 445                 return -1;
 446         }
 447         struct dirent * de;
 448         int return_value = 0;
 449         while ((de = readdir(dir))) {
 450                 string const temp = de->d_name;
 451                 if (temp == "." || temp == "..")
 452                         continue;
 453                 string const unlinkpath = AddName (path, temp);
 454
 455                 lyxerr[Debug::FILES] << "Deleting file: " << unlinkpath
 456                                      << endl;
 457
 458                 bool deleted = true;
 459                 FileInfo fi(unlinkpath);
 460                 if (fi.isOK() && fi.isDir())
 461                         deleted = (DeleteAllFilesInDir(unlinkpath) == 0);
 462                 deleted &= (lyx::unlink(unlinkpath) == 0);
 463                 if (!deleted) {
 464                         Alert::err_alert(_("Error! Could not remove file:"),
 465                                 unlinkpath);
 466                         return_value = -1;
 467                 }
 468         }
 469         closedir(dir);
 470         return return_value;
 471 }
 472
 473
 474 string const CreateTmpDir(string const & tempdir, string const & mask)
 475 {
 476         lyxerr[Debug::FILES]
 477                 << "CreateTmpDir: tempdir=`" << tempdir << "'\n"
 478                 << "CreateTmpDir:    mask=`" << mask << '\'' << endl;
 479
 480         string const tmpfl(lyx::tempName(tempdir, mask));
 481         // lyx::tempName actually creates a file to make sure that it
 482         // stays unique. So we have to delete it before we can create
 483         // a dir with the same name. Note also that we are not thread
 484         // safe because of the gap between unlink and mkdir. (Lgb)
 485         lyx::unlink(tmpfl.c_str());
 486
 487         if (tmpfl.empty() || lyx::mkdir(tmpfl, 0700)) {
 488                 Alert::err_alert(_("Error! Couldn't create temporary directory:"),
 489                              tempdir);
 490                 return string();
 491         }
 492         return MakeAbsPath(tmpfl);
 493 }
 494
 495
 496 int DestroyTmpDir(string const & tmpdir, bool Allfiles)
 497 {
 498 #ifdef __EMX__
 499         Path p(user_lyxdir);
 500 #endif
 501         if (Allfiles && DeleteAllFilesInDir(tmpdir)) {
 502                 return -1;
 503         }
 504         if (lyx::rmdir(tmpdir)) {
 505                 Alert::err_alert(_("Error! Couldn't delete temporary directory:"),
 506                              tmpdir);
 507                 return -1;
 508         }
 509         return 0;
 510 }
 511
 512 } // namespace anon
 513
 514
 515 string const CreateBufferTmpDir(string const & pathfor)
 516 {
 517         static int count;
 518         static string const tmpdir(pathfor.empty() ? os::getTmpDir() : pathfor);
 519         // We are in our own directory.  Why bother to mangle name?
 520         // In fact I wrote this code to circumvent a problematic behaviour (bug?)
 521         // of EMX mkstemp().
 522         string const tmpfl = tmpdir + "/lyx_tmpbuf" + tostr(count++);
 523         if (lyx::mkdir(tmpfl, 0777)) {
 524                 Alert::err_alert(_("Error! Couldn't create temporary directory:"),
 525                              tmpdir);
 526                 return string();
 527         }
 528         return tmpfl;
 529 }
 530
 531
 532 int DestroyBufferTmpDir(string const & tmpdir)
 533 {
 534         return DestroyTmpDir(tmpdir, true);
 535 }
 536
 537
 538 string const CreateLyXTmpDir(string const & deflt)
 539 {
 540         if ((!deflt.empty()) && (deflt  != "/tmp")) {
 541                 if (lyx::mkdir(deflt, 0777)) {
 542 #ifdef __EMX__
 543                 Path p(user_lyxdir);
 544 #endif
 545                         return CreateTmpDir(deflt, "lyx_tmpdir");
 546                 } else
 547                         return deflt;
 548         } else {
 549 #ifdef __EMX__
 550                 Path p(user_lyxdir);
 551 #endif
 552                 return CreateTmpDir("/tmp", "lyx_tmpdir");
 553         }
 554 }
 555
 556
 557 // FIXME: no need for separate method like this ...
 558 int DestroyLyXTmpDir(string const & tmpdir)
 559 {
 560         return DestroyTmpDir(tmpdir, true);
 561 }
 562
 563
 564 // Creates directory. Returns true if succesfull
 565 bool createDirectory(string const & path, int permission)
 566 {
 567         string temp(rtrim(os::slashify_path(path), "/"));
 568
 569         if (temp.empty()) {
 570                 Alert::alert(_("Internal error!"),
 571                            _("Call to createDirectory with invalid name"));
 572                 return false;
 573         }
 574
 575         if (lyx::mkdir(temp, permission)) {
 576                 Alert::err_alert (_("Error! Couldn't create directory:"), temp);
 577                 return false;
 578         }
 579         return true;
 580 }
 581
 582
 583 // Strip filename from path name
 584 string const OnlyPath(string const & Filename)
 585 {
 586         // If empty filename, return empty
 587         if (Filename.empty()) return Filename;
 588
 589         // Find last / or start of filename
 590         string::size_type j = Filename.rfind('/');
 591         if (j == string::npos)
 592                 return "./";
 593         return Filename.substr(0, j + 1);
 594 }
 595
 596
 597 // Convert relative path into absolute path based on a basepath.
 598 // If relpath is absolute, just use that.
 599 // If basepath is empty, use CWD as base.
 600 string const MakeAbsPath(string const & RelPath, string const & BasePath)
 601 {
 602         // checks for already absolute path
 603         if (os::is_absolute_path(RelPath))
 604                 return RelPath;
 605
 606         // Copies given paths
 607         string TempRel(os::slashify_path(RelPath));
 608         // Since TempRel is NOT absolute, we can safely replace "//" with "/"
 609         TempRel = subst(TempRel, "//", "/");
 610
 611         string TempBase;
 612
 613         if (os::is_absolute_path(BasePath))
 614                 TempBase = BasePath;
 615         else
 616                 TempBase = AddPath(lyx::getcwd(), BasePath);
 617
 618         // Handle /./ at the end of the path
 619         while (suffixIs(TempBase, "/./"))
 620                 TempBase.erase(TempBase.length() - 2);
 621
 622         // processes relative path
 623         string RTemp(TempRel);
 624         string Temp;
 625
 626         while (!RTemp.empty()) {
 627                 // Split by next /
 628                 RTemp = split(RTemp, Temp, '/');
 629
 630                 if (Temp == ".") continue;
 631                 if (Temp == "..") {
 632                         // Remove one level of TempBase
 633                         string::difference_type i = TempBase.length() - 2;
 634 #ifndef __EMX__
 635                         if (i < 0) i = 0;
 636                         while (i > 0 && TempBase[i] != '/') --i;
 637                         if (i > 0)
 638 #else
 639                         if (i < 2) i = 2;
 640                         while (i > 2 && TempBase[i] != '/') --i;
 641                         if (i > 2)
 642 #endif
 643                                 TempBase.erase(i, string::npos);
 644                         else
 645                                 TempBase += '/';
 646                 } else if (Temp.empty() && !RTemp.empty()) {
 647                                 TempBase = os::current_root() + RTemp;
 648                                 RTemp.erase();
 649                 } else {
 650                         // Add this piece to TempBase
 651                         if (!suffixIs(TempBase, '/'))
 652                                 TempBase += '/';
 653                         TempBase += Temp;
 654                 }
 655         }
 656
 657         // returns absolute path
 658         return os::slashify_path(TempBase);
 659 }
 660
 661
 662 // Correctly append filename to the pathname.
 663 // If pathname is '.', then don't use pathname.
 664 // Chops any path of filename.
 665 string const AddName(string const & path, string const & fname)
 666 {
 667         // Get basename
 668         string const basename(OnlyFilename(fname));
 669
 670         string buf;
 671
 672         if (path != "." && path != "./" && !path.empty()) {
 673                 buf = os::slashify_path(path);
 674                 if (!suffixIs(path, '/'))
 675                         buf += '/';
 676         }
 677
 678         return buf + basename;
 679 }
 680
 681
 682 // Strips path from filename
 683 string const OnlyFilename(string const & fname)
 684 {
 685         if (fname.empty())
 686                 return fname;
 687
 688         string::size_type j = fname.rfind('/');
 689         if (j == string::npos) // no '/' in fname
 690                 return fname;
 691
 692         // Strip to basename
 693         return fname.substr(j + 1);
 694 }
 695
 696
 697 /// Returns true is path is absolute
 698 bool AbsolutePath(string const & path)
 699 {
 700         return os::is_absolute_path(path);
 701 }
 702
 703
 704
 705 // Create absolute path. If impossible, don't do anything
 706 // Supports ./ and ~/. Later we can add support for ~logname/. (Asger)
 707 string const ExpandPath(string const & path)
 708 {
 709         // checks for already absolute path
 710         string RTemp(ReplaceEnvironmentPath(path));
 711         if (os::is_absolute_path(RTemp))
 712                 return RTemp;
 713
 714         string Temp;
 715         string const copy(RTemp);
 716
 717         // Split by next /
 718         RTemp = split(RTemp, Temp, '/');
 719
 720         if (Temp == ".") {
 721                 return lyx::getcwd() /*GetCWD()*/ + '/' + RTemp;
 722         }
 723         if (Temp == "~") {
 724                 return GetEnvPath("HOME") + '/' + RTemp;
 725         }
 726         if (Temp == "..") {
 727                 return MakeAbsPath(copy);
 728         }
 729         // Don't know how to handle this
 730         return copy;
 731 }
 732
 733
 734 // Normalize a path
 735 // Constracts path/../path
 736 // Can't handle "../../" or "/../" (Asger)
 737 string const NormalizePath(string const & path)
 738 {
 739         string TempBase;
 740         string RTemp;
 741         string Temp;
 742
 743         if (os::is_absolute_path(path))
 744                 RTemp = path;
 745         else
 746                 // Make implicit current directory explicit
 747                 RTemp = "./" +path;
 748
 749         while (!RTemp.empty()) {
 750                 // Split by next /
 751                 RTemp = split(RTemp, Temp, '/');
 752
 753                 if (Temp == ".") {
 754                         TempBase = "./";
 755                 } else if (Temp == "..") {
 756                         // Remove one level of TempBase
 757                         string::difference_type i = TempBase.length() - 2;
 758                         while (i > 0 && TempBase[i] != '/')
 759                                 --i;
 760                         if (i >= 0 && TempBase[i] == '/')
 761                                 TempBase.erase(i + 1, string::npos);
 762                         else
 763                                 TempBase = "../";
 764                 } else {
 765                         TempBase += Temp + '/';
 766                 }
 767         }
 768
 769         // returns absolute path
 770         return TempBase;
 771 }
 772
 773
 774 string const GetFileContents(string const & fname)
 775 {
 776         FileInfo finfo(fname);
 777         if (finfo.exist()) {
 778                 ifstream ifs(fname.c_str());
 779                 ostringstream ofs;
 780                 if (ifs && ofs) {
 781                         ofs << ifs.rdbuf();
 782                         ifs.close();
 783                         return STRCONV(ofs.str());
 784                 }
 785         }
 786         lyxerr << "LyX was not able to read file '" << fname << '\'' << endl;
 787         return string();
 788 }
 789
 790
 791 //
 792 // Search ${...} as Variable-Name inside the string and replace it with
 793 // the denoted environmentvariable
 794 // Allow Variables according to
 795 //  variable :=  '$' '{' [A-Za-z_]{[A-Za-z_0-9]*} '}'
 796 //
 797
 798 string const ReplaceEnvironmentPath(string const & path)
 799 {
 800         //
 801         // CompareChar: Environment variables starts with this character
 802         // PathChar:    Next path component start with this character
 803         // while CompareChar found do:
 804         //       Split String with PathChar
 805         //       Search Environmentvariable
 806         //       if found: Replace Strings
 807         //
 808         char const CompareChar = '$';
 809         char const FirstChar = '{';
 810         char const EndChar = '}';
 811         char const UnderscoreChar = '_';
 812         string EndString; EndString += EndChar;
 813         string FirstString; FirstString += FirstChar;
 814         string CompareString; CompareString += CompareChar;
 815         string const RegExp("*}*"); // Exist EndChar inside a String?
 816
 817 // first: Search for a '$' - Sign.
 818         //string copy(path);
 819         string result1; //(copy);    // for split-calls
 820         string result0 = split(path, result1, CompareChar);
 821         while (!result0.empty()) {
 822                 string copy1(result0); // contains String after $
 823
 824                 // Check, if there is an EndChar inside original String.
 825
 826                 if (!regexMatch(copy1, RegExp)) {
 827                         // No EndChar inside. So we are finished
 828                         result1 += CompareString + result0;
 829                         result0.erase();
 830                         continue;
 831                 }
 832
 833                 string res1;
 834                 string res0 = split(copy1, res1, EndChar);
 835                 // Now res1 holds the environmentvariable
 836                 // First, check, if Contents is ok.
 837                 if (res1.empty()) { // No environmentvariable. Continue Loop.
 838                         result1 += CompareString + FirstString;
 839                         result0  = res0;
 840                         continue;
 841                 }
 842                 // check contents of res1
 843                 char const * res1_contents = res1.c_str();
 844                 if (*res1_contents != FirstChar) {
 845                         // Again No Environmentvariable
 846                         result1 += CompareString;
 847                         result0 = res0;
 848                 }
 849
 850                 // Check for variable names
 851                 // Situation ${} is detected as "No Environmentvariable"
 852                 char const * cp1 = res1_contents + 1;
 853                 bool result = isalpha(*cp1) || (*cp1 == UnderscoreChar);
 854                 ++cp1;
 855                 while (*cp1 && result) {
 856                         result = isalnum(*cp1) ||
 857                                 (*cp1 == UnderscoreChar);
 858                         ++cp1;
 859                 }
 860
 861                 if (!result) {
 862                         // no correct variable name
 863                         result1 += CompareString + res1 + EndString;
 864                         result0  = split(res0, res1, CompareChar);
 865                         result1 += res1;
 866                         continue;
 867                 }
 868
 869                 string env(GetEnv(res1_contents + 1));
 870                 if (!env.empty()) {
 871                         // Congratulations. Environmentvariable found
 872                         result1 += env;
 873                 } else {
 874                         result1 += CompareString + res1 + EndString;
 875                 }
 876                 // Next $-Sign?
 877                 result0  = split(res0, res1, CompareChar);
 878                 result1 += res1;
 879         }
 880         return result1;
 881 }
 882
 883
 884 // Make relative path out of two absolute paths
 885 string const MakeRelPath(string const & abspath, string const & basepath)
 886 // Makes relative path out of absolute path. If it is deeper than basepath,
 887 // it's easy. If basepath and abspath share something (they are all deeper
 888 // than some directory), it'll be rendered using ..'s. If they are completely
 889 // different, then the absolute path will be used as relative path.
 890 {
 891         string::size_type const abslen = abspath.length();
 892         string::size_type const baselen = basepath.length();
 893
 894         string::size_type i = os::common_path(abspath, basepath);
 895
 896         if (i == 0) {
 897                 // actually no match - cannot make it relative
 898                 return abspath;
 899         }
 900
 901         // Count how many dirs there are in basepath above match
 902         // and append as many '..''s into relpath
 903         string buf;
 904         string::size_type j = i;
 905         while (j < baselen) {
 906                 if (basepath[j] == '/') {
 907                         if (j + 1 == baselen)
 908                                 break;
 909                         buf += "../";
 910                 }
 911                 ++j;
 912         }
 913
 914         // Append relative stuff from common directory to abspath
 915         if (abspath[i] == '/')
 916                 ++i;
 917         for (; i < abslen; ++i)
 918                 buf += abspath[i];
 919         // Remove trailing /
 920         if (suffixIs(buf, '/'))
 921                 buf.erase(buf.length() - 1);
 922         // Substitute empty with .
 923         if (buf.empty())
 924                 buf = '.';
 925         return buf;
 926 }
 927
 928
 929 // Append sub-directory(ies) to a path in an intelligent way
 930 string const AddPath(string const & path, string const & path_2)
 931 {
 932         string buf;
 933         string const path2 = os::slashify_path(path_2);
 934
 935         if (!path.empty() && path != "." && path != "./") {
 936                 buf = os::slashify_path(path);
 937                 if (path[path.length() - 1] != '/')
 938                         buf += '/';
 939         }
 940
 941         if (!path2.empty()) {
 942                 string::size_type const p2start = path2.find_first_not_of('/');
 943                 string::size_type const p2end = path2.find_last_not_of('/');
 944                 string const tmp = path2.substr(p2start, p2end - p2start + 1);
 945                 buf += tmp + '/';
 946         }
 947         return buf;
 948 }
 949
 950
 951 /*
 952  Change extension of oldname to extension.
 953  Strips path off if no_path == true.
 954  If no extension on oldname, just appends.
 955  */
 956 string const ChangeExtension(string const & oldname, string const & extension)
 957 {
 958         string::size_type const last_slash = oldname.rfind('/');
 959         string::size_type last_dot = oldname.rfind('.');
 960         if (last_dot < last_slash && last_slash != string::npos)
 961                 last_dot = string::npos;
 962
 963         string ext;
 964         // Make sure the extension starts with a dot
 965         if (!extension.empty() && extension[0] != '.')
 966                 ext= '.' + extension;
 967         else
 968                 ext = extension;
 969
 970         return os::slashify_path(oldname.substr(0, last_dot) + ext);
 971 }
 972
 973
 974 /// Return the extension of the file (not including the .)
 975 string const GetExtension(string const & name)
 976 {
 977         string::size_type const last_slash = name.rfind('/');
 978         string::size_type const last_dot = name.rfind('.');
 979         if (last_dot != string::npos &&
 980             (last_slash == string::npos || last_dot > last_slash))
 981                 return name.substr(last_dot + 1,
 982                                    name.length() - (last_dot + 1));
 983         else
 984                 return string();
 985 }
 986
 987 // the different filetypes and what they contain in one of the first lines
 988 // (dots are any characters).           (Herbert 20020131)
 989 // AGR  Grace...
 990 // BMP  BM...
 991 // EPS  %!PS-Adobe-3.0 EPSF...
 992 // FIG  #FIG...
 993 // FITS ...BITPIX...
 994 // GIF  GIF...
 995 // JPG  JFIF
 996 // PDF  %PDF-...
 997 // PNG  .PNG...
 998 // PBM  P1... or P4     (B/W)
 999 // PGM  P2... or P5     (Grayscale)
1000 // PPM  P3... or P6     (color)
1001 // PS   %!PS-Adobe-2.0 or 1.0,  no "EPSF"!
1002 // SGI  \001\332...     (decimal 474)
1003 // TGIF %TGIF...
1004 // TIFF II... or MM...
1005 // XBM  ..._bits[]...
1006 // XPM  /* XPM */    sometimes missing (f.ex. tgif-export)
1007 //      ...static char *...
1008 // XWD  \000\000\000\151        (0x00006900) decimal 105
1009 //
1010 // GZIP \037\213\010\010...     http://www.ietf.org/rfc/rfc1952.txt
1011 // ZIP  PK...                   http://www.halyava.ru/document/ind_arch.htm
1012 // Z    \037\177                UNIX compress
1013
1014 /// return the "extension" which belongs to the contents.
1015 /// for no knowing contents return the extension. Without
1016 /// an extension and unknown contents we return "user"
1017 string const getExtFromContents(string const & filename)
1018 {
1019         // paranoia check
1020         if (filename.empty() || !IsFileReadable(filename))
1021                 return string();
1022
1023
1024         ifstream ifs(filename.c_str());
1025         if (!ifs)
1026                 // Couldn't open file...
1027                 return string();
1028
1029         // gnuzip
1030         string const gzipStamp = "\037\213\010\010";
1031
1032         // PKZIP
1033         string const zipStamp = "PK";
1034
1035         // compress
1036         string const compressStamp = "\037\177";
1037
1038         // Maximum strings to read
1039         int const max_count = 50;
1040         int count = 0;
1041
1042         string str, format;
1043         bool firstLine = true;
1044         while ((count++ < max_count) && format.empty()) {
1045                 if (ifs.eof()) {
1046                         lyxerr[Debug::GRAPHICS]
1047                                 << "filetools(getExtFromContents)\n"
1048                                 << "\tFile type not recognised before EOF!"
1049                                 << endl;
1050                         break;
1051                 }
1052
1053                 getline(ifs, str);
1054                 string const stamp = str.substr(0,2);
1055                 if (firstLine && str.size() >= 2) {
1056                         // at first we check for a zipped file, because this
1057                         // information is saved in the first bytes of the file!
1058                         // also some graphic formats which save the information
1059                         // in the first line, too.
1060                         if (prefixIs(str, gzipStamp)) {
1061                                 format =  "gzip";
1062
1063                         } else if (stamp == zipStamp) {
1064                                 format =  "zip";
1065
1066                         } else if (stamp == compressStamp) {
1067                                 format =  "compress";
1068
1069                         // the graphics part
1070                         } else if (stamp == "BM") {
1071                                 format =  "bmp";
1072
1073                         } else if (stamp == "\001\332") {
1074                                 format =  "sgi";
1075
1076                         // PBM family
1077                         // Don't need to use str.at(0), str.at(1) because
1078                         // we already know that str.size() >= 2
1079                         } else if (str[0] == 'P') {
1080                                 switch (str[1]) {
1081                                 case '1':
1082                                 case '4':
1083                                         format =  "pbm";
1084                                     break;
1085                                 case '2':
1086                                 case '5':
1087                                         format =  "pgm";
1088                                     break;
1089                                 case '3':
1090                                 case '6':
1091                                         format =  "ppm";
1092                                 }
1093                                 break;
1094
1095                         } else if ((stamp == "II") || (stamp == "MM")) {
1096                                 format =  "tiff";
1097
1098                         } else if (prefixIs(str,"%TGIF")) {
1099                                 format =  "tgif";
1100
1101                         } else if (prefixIs(str,"#FIG")) {
1102                                 format =  "fig";
1103
1104                         } else if (prefixIs(str,"GIF")) {
1105                                 format =  "gif";
1106
1107                         } else if (str.size() > 3) {
1108                                 int const c = ((str[0] << 24) & (str[1] << 16) &
1109                                                (str[2] << 8)  & str[3]);
1110                                 if (c == 105) {
1111                                         format =  "xwd";
1112                                 }
1113                         }
1114
1115                         firstLine = false;
1116                 }
1117
1118                 if (!format.empty())
1119                     break;
1120                 else if (contains(str,"EPSF"))
1121                         // dummy, if we have wrong file description like
1122                         // %!PS-Adobe-2.0EPSF"
1123                         format =  "eps";
1124
1125                 else if (contains(str,"Grace"))
1126                         format =  "agr";
1127
1128                 else if (contains(str,"JFIF"))
1129                         format =  "jpg";
1130
1131                 else if (contains(str,"%PDF"))
1132                         format =  "pdf";
1133
1134                 else if (contains(str,"PNG"))
1135                         format =  "png";
1136
1137                 else if (contains(str,"%!PS-Adobe")) {
1138                         // eps or ps
1139                         ifs >> str;
1140                         if (contains(str,"EPSF"))
1141                                 format = "eps";
1142                         else
1143                             format = "ps";
1144                 }
1145
1146                 else if (contains(str,"_bits[]"))
1147                         format = "xbm";
1148
1149                 else if (contains(str,"XPM") || contains(str, "static char *"))
1150                         format = "xpm";
1151
1152                 else if (contains(str,"BITPIX"))
1153                         format = "fits";
1154         }
1155
1156         if (!format.empty()) {
1157                 lyxerr[Debug::GRAPHICS]
1158                         << "Recognised Fileformat: " << format << endl;
1159                 return format;
1160         }
1161
1162         string const ext(GetExtension(filename));
1163         lyxerr[Debug::GRAPHICS]
1164                 << "filetools(getExtFromContents)\n"
1165                 << "\tCouldn't find a known Type!\n";
1166         if (!ext.empty()) {
1167             lyxerr[Debug::GRAPHICS]
1168                 << "\twill take the file extension -> "
1169                 << ext << endl;
1170                 return ext;
1171         } else {
1172             lyxerr[Debug::GRAPHICS]
1173                 << "\twill use ext or a \"user\" defined format" << endl;
1174             return "user";
1175         }
1176 }
1177
1178
1179 /// check for zipped file
1180 bool zippedFile(string const & name)
1181 {
1182         string const type = getExtFromContents(name);
1183         if (contains("gzip zip compress", type) && !type.empty())
1184                 return true;
1185         return false;
1186 }
1187
1188
1189 string const unzipFile(string const & zipped_file)
1190 {
1191         string const file = ChangeExtension(zipped_file, string());
1192         string  const tempfile = lyx::tempName(string(), file);
1193         // Run gunzip
1194         string const command = "gunzip -c " + zipped_file + " > " + tempfile;
1195         Systemcall one;
1196         one.startscript(Systemcall::Wait, command);
1197         // test that command was executed successfully (anon)
1198         // yes, please do. (Lgb)
1199         return tempfile;
1200 }
1201
1202
1203 // Creates a nice compact path for displaying
1204 string const
1205 MakeDisplayPath (string const & path, unsigned int threshold)
1206 {
1207         string::size_type const l1 = path.length();
1208
1209         // First, we try a relative path compared to home
1210         string const home(GetEnvPath("HOME"));
1211         string relhome = MakeRelPath(path, home);
1212
1213         string::size_type l2 = relhome.length();
1214
1215         string prefix;
1216
1217         // If we backup from home or don't have a relative path,
1218         // this try is no good
1219         if (prefixIs(relhome, "../") || os::is_absolute_path(relhome)) {
1220                 // relative path was no good, just use the original path
1221                 relhome = path;
1222                 l2 = l1;
1223         } else {
1224                 prefix = "~/";
1225         }
1226
1227         // Is the path too long?
1228         if (l2 > threshold) {
1229                 // Yes, shortend it
1230                 prefix += ".../";
1231
1232                 string temp;
1233
1234                 while (relhome.length() > threshold)
1235                         relhome = split(relhome, temp, '/');
1236
1237                 // Did we shortend everything away?
1238                 if (relhome.empty()) {
1239                         // Yes, filename in itself is too long.
1240                         // Pick the start and the end of the filename.
1241                         relhome = OnlyFilename(path);
1242                         string const head = relhome.substr(0, threshold/2 - 3);
1243
1244                         l2 = relhome.length();
1245                         string const tail =
1246                                 relhome.substr(l2 - threshold/2 - 2, l2 - 1);
1247                         relhome = head + "..." + tail;
1248                 }
1249         }
1250         return prefix + relhome;
1251 }
1252
1253
1254 bool LyXReadLink(string const & file, string & link, bool resolve)
1255 {
1256         char linkbuffer[512];
1257         // Should be PATH_MAX but that needs autconf support
1258         int const nRead = ::readlink(file.c_str(),
1259                                      linkbuffer, sizeof(linkbuffer) - 1);
1260         if (nRead <= 0)
1261                 return false;
1262         linkbuffer[nRead] = '\0'; // terminator
1263         if (resolve)
1264                 link = MakeAbsPath(linkbuffer, OnlyPath(file));
1265         else
1266                 link = linkbuffer;
1267         return true;
1268 }
1269
1270
1271 cmd_ret const RunCommand(string const & cmd)
1272 {
1273         // One question is if we should use popen or
1274         // create our own popen based on fork, exec, pipe
1275         // of course the best would be to have a
1276         // pstream (process stream), with the
1277         // variants ipstream, opstream
1278
1279         FILE * inf = ::popen(cmd.c_str(), os::popen_read_mode());
1280
1281         // (Claus Hentschel) Check if popen was succesful ;-)
1282         if (!inf)
1283                 return make_pair(-1, string());
1284
1285         string ret;
1286         int c = fgetc(inf);
1287         while (c != EOF) {
1288                 ret += static_cast<char>(c);
1289                 c = fgetc(inf);
1290         }
1291         int const pret = pclose(inf);
1292         return make_pair(pret, ret);
1293 }
1294
1295
1296 string const findtexfile(string const & fil, string const & /*format*/)
1297 {
1298         /* There is no problem to extend this function too use other
1299            methods to look for files. It could be setup to look
1300            in environment paths and also if wanted as a last resort
1301            to a recursive find. One of the easier extensions would
1302            perhaps be to use the LyX file lookup methods. But! I am
1303            going to implement this until I see some demand for it.
1304            Lgb
1305         */
1306
1307         // If the file can be found directly, we just return a
1308         // absolute path version of it.
1309         if (FileInfo(fil).exist())
1310                 return MakeAbsPath(fil);
1311
1312         // No we try to find it using kpsewhich.
1313         // It seems from the kpsewhich manual page that it is safe to use
1314         // kpsewhich without --format: "When the --format option is not
1315         // given, the search path used when looking for a file is inferred
1316         // from the name given, by looking for a known extension. If no
1317         // known extension is found, the search path for TeX source files
1318         // is used."
1319         // However, we want to take advantage of the format sine almost all
1320         // the different formats has environment variables that can be used
1321         // to controll which paths to search. f.ex. bib looks in
1322         // BIBINPUTS and TEXBIB. Small list follows:
1323         // bib - BIBINPUTS, TEXBIB
1324         // bst - BSTINPUTS
1325         // graphic/figure - TEXPICTS, TEXINPUTS
1326         // ist - TEXINDEXSTYLE, INDEXSTYLE
1327         // pk - PROGRAMFONTS, PKFONTS, TEXPKS, GLYPHFONTS, TEXFONTS
1328         // tex - TEXINPUTS
1329         // tfm - TFMFONTS, TEXFONTS
1330         // This means that to use kpsewhich in the best possible way we
1331         // should help it by setting additional path in the approp. envir.var.
1332         string const kpsecmd = "kpsewhich " + fil;
1333
1334         cmd_ret const c = RunCommand(kpsecmd);
1335
1336         lyxerr[Debug::LATEX] << "kpse status = " << c.first << '\n'
1337                  << "kpse result = `" << rtrim(c.second, "\n")
1338                  << '\'' << endl;
1339         if (c.first != -1)
1340                 return os::internal_path(rtrim(c.second, "\n\r"));
1341         else
1342                 return string();
1343 }
1344
1345
1346 void removeAutosaveFile(string const & filename)
1347 {
1348         string a = OnlyPath(filename);
1349         a += '#';
1350         a += OnlyFilename(filename);
1351         a += '#';
1352         FileInfo const fileinfo(a);
1353         if (fileinfo.exist()) {
1354                 if (lyx::unlink(a) != 0) {
1355                         Alert::err_alert(_("Could not delete auto-save file!"), a);
1356                 }
1357         }
1358 }
1359
1360
1361 void readBB_lyxerrMessage(string const & file, bool & zipped,
1362         string const & message)
1363 {
1364         lyxerr[Debug::GRAPHICS] << "[readBB_from_PSFile] "
1365                 << message << std::endl;
1366         if (zipped)
1367                 lyx::unlink(file);
1368 }
1369
1370
1371 string const readBB_from_PSFile(string const & file)
1372 {
1373         // in a (e)ps-file it's an entry like %%BoundingBox:23 45 321 345
1374         // It seems that every command in the header has an own line,
1375         // getline() should work for all files.
1376         // On the other hand some plot programs write the bb at the
1377         // end of the file. Than we have in the header:
1378         // %%BoundingBox: (atend)
1379         // In this case we must check the end.
1380         bool zipped = zippedFile(file);
1381         string const file_ = zipped ?
1382                 string(unzipFile(file)) : string(file);
1383         string const format = getExtFromContents(file_);
1384
1385         if (format != "eps" && format != "ps") {
1386                 readBB_lyxerrMessage(file_, zipped,"no(e)ps-format");
1387                 return string();
1388         }
1389
1390         std::ifstream is(file_.c_str());
1391         while (is) {
1392                 string s;
1393                 getline(is,s);
1394                 if (contains(s,"%%BoundingBox:") && !contains(s,"atend")) {
1395                         string const bb = ltrim(s.substr(14));
1396                         readBB_lyxerrMessage(file_, zipped, bb);
1397                         return bb;
1398                 }
1399         }
1400         readBB_lyxerrMessage(file_, zipped, "no bb found");
1401         return string();
1402 }