src/support/filetools.C

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