src/support/FileName.cpp

   1 /**
   2  * \file FileName.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Angus Leeming
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "support/FileName.h"
  14 #include "support/FileNameList.h"
  15
  16 #include "support/convert.h"
  17 #include "support/debug.h"
  18 #include "support/filetools.h"
  19 #include "support/lstrings.h"
  20 #include "support/os.h"
  21 #include "support/Package.h"
  22 #include "support/qstring_helpers.h"
  23
  24 #include <QDateTime>
  25 #include <QDir>
  26 #include <QFile>
  27 #include <QFileInfo>
  28 #include <QList>
  29 #include <QTime>
  30
  31 #include "support/lassert.h"
  32 #include <boost/scoped_array.hpp>
  33
  34 #include <map>
  35 #include <sstream>
  36 #include <fstream>
  37 #include <algorithm>
  38
  39 #ifdef HAVE_SYS_TYPES_H
  40 # include <sys/types.h>
  41 #endif
  42 #ifdef HAVE_SYS_STAT_H
  43 # include <sys/stat.h>
  44 #endif
  45 #ifdef HAVE_UNISTD_H
  46 # include <unistd.h>
  47 #endif
  48 #ifdef HAVE_DIRECT_H
  49 # include <direct.h>
  50 #endif
  51 #ifdef _WIN32
  52 # include <windows.h>
  53 #endif
  54
  55 #include <cerrno>
  56 #include <fcntl.h>
  57
  58
  59 #ifdef HAVE_UNISTD_H
  60 # include <unistd.h>
  61 #endif
  62
  63 #if defined(HAVE_MKSTEMP) && ! defined(HAVE_DECL_MKSTEMP)
  64 extern "C" int mkstemp(char *);
  65 #endif
  66
  67 #if !defined(HAVE_MKSTEMP) && defined(HAVE_MKTEMP)
  68 # ifdef HAVE_IO_H
  69 #  include <io.h>
  70 # endif
  71 # ifdef HAVE_PROCESS_H
  72 #  include <process.h>
  73 # endif
  74 #endif
  75
  76 using namespace std;
  77
  78 namespace lyx {
  79 namespace support {
  80
  81
  82 /////////////////////////////////////////////////////////////////////
  83 //
  84 // FileName::Private
  85 //
  86 /////////////////////////////////////////////////////////////////////
  87
  88 struct FileName::Private
  89 {
  90         Private() {}
  91
  92         Private(string const & abs_filename) : fi(toqstr(abs_filename))
  93         {
  94                 fi.setCaching(fi.exists() ? true : false);
  95         }
  96         ///
  97         QFileInfo fi;
  98 };
  99
 100 /////////////////////////////////////////////////////////////////////
 101 //
 102 // FileName
 103 //
 104 /////////////////////////////////////////////////////////////////////
 105
 106
 107 FileName::FileName() : d(new Private)
 108 {
 109 }
 110
 111
 112 FileName::FileName(string const & abs_filename)
 113         : d(abs_filename.empty() ? new Private : new Private(abs_filename))
 114 {
 115 }
 116
 117
 118 FileName::~FileName()
 119 {
 120         delete d;
 121 }
 122
 123
 124 FileName::FileName(FileName const & rhs) : d(new Private)
 125 {
 126         d->fi = rhs.d->fi;
 127 }
 128
 129
 130 FileName & FileName::operator=(FileName const & rhs)
 131 {
 132         d->fi = rhs.d->fi;
 133         return *this;
 134 }
 135
 136
 137 bool FileName::empty() const
 138 {
 139         return d->fi.absoluteFilePath().isEmpty();
 140 }
 141
 142
 143 bool FileName::isAbsolute() const
 144 {
 145         return d->fi.isAbsolute();
 146 }
 147
 148
 149 string FileName::absFilename() const
 150 {
 151         return fromqstr(d->fi.absoluteFilePath());
 152 }
 153
 154
 155 void FileName::set(string const & name)
 156 {
 157         d->fi.setFile(toqstr(name));
 158 }
 159
 160
 161 void FileName::erase()
 162 {
 163         d->fi = QFileInfo();
 164 }
 165
 166
 167 bool FileName::copyTo(FileName const & name) const
 168 {
 169         LYXERR(Debug::FILES, "Copying " << name);
 170         QFile::remove(name.d->fi.absoluteFilePath());
 171         bool success = QFile::copy(d->fi.absoluteFilePath(), name.d->fi.absoluteFilePath());
 172         if (!success)
 173                 LYXERR0("FileName::copyTo(): Could not copy file "
 174                         << *this << " to " << name);
 175         return success;
 176 }
 177
 178
 179 bool FileName::renameTo(FileName const & name) const
 180 {
 181         bool success = QFile::rename(d->fi.absoluteFilePath(), name.d->fi.absoluteFilePath());
 182         if (!success)
 183                 LYXERR0("Could not rename file " << *this << " to " << name);
 184         return success;
 185 }
 186
 187
 188 bool FileName::moveTo(FileName const & name) const
 189 {
 190         QFile::remove(name.d->fi.absoluteFilePath());
 191
 192         bool success = QFile::rename(d->fi.absoluteFilePath(),
 193                 name.d->fi.absoluteFilePath());
 194         if (!success)
 195                 LYXERR0("Could not move file " << *this << " to " << name);
 196         return success;
 197 }
 198
 199
 200 bool FileName::changePermission(unsigned long int mode) const
 201 {
 202 #if defined (HAVE_CHMOD) && defined (HAVE_MODE_T)
 203         if (::chmod(toFilesystemEncoding().c_str(), mode_t(mode)) != 0) {
 204                 LYXERR0("File " << *this << ": cannot change permission to "
 205                         << mode << ".");
 206                 return false;
 207         }
 208 #endif
 209         return true;
 210 }
 211
 212
 213 string FileName::toFilesystemEncoding() const
 214 {
 215         QByteArray const encoded = QFile::encodeName(d->fi.absoluteFilePath());
 216         return string(encoded.begin(), encoded.end());
 217 }
 218
 219
 220 FileName FileName::fromFilesystemEncoding(string const & name)
 221 {
 222         QByteArray const encoded(name.c_str(), name.length());
 223         return FileName(fromqstr(QFile::decodeName(encoded)));
 224 }
 225
 226
 227 bool FileName::exists() const
 228 {
 229         return d->fi.exists();
 230 }
 231
 232
 233 bool FileName::isSymLink() const
 234 {
 235         return d->fi.isSymLink();
 236 }
 237
 238
 239 bool FileName::isFileEmpty() const
 240 {
 241         return d->fi.size() == 0;
 242 }
 243
 244
 245 bool FileName::isDirectory() const
 246 {
 247         return d->fi.isDir();
 248 }
 249
 250
 251 bool FileName::isReadOnly() const
 252 {
 253         return d->fi.isReadable() && !d->fi.isWritable();
 254 }
 255
 256
 257 bool FileName::isReadableDirectory() const
 258 {
 259         return d->fi.isDir() && d->fi.isReadable();
 260 }
 261
 262
 263 string FileName::onlyFileName() const
 264 {
 265         return fromqstr(d->fi.fileName());
 266 }
 267
 268
 269 string FileName::onlyFileNameWithoutExt() const
 270 {
 271        return fromqstr(d->fi.baseName());
 272 }
 273
 274
 275 FileName FileName::onlyPath() const
 276 {
 277         FileName path;
 278         path.d->fi.setFile(d->fi.path());
 279         return path;
 280 }
 281
 282
 283 bool FileName::isReadableFile() const
 284 {
 285         return d->fi.isFile() && d->fi.isReadable();
 286 }
 287
 288
 289 bool FileName::isWritable() const
 290 {
 291         return d->fi.isWritable();
 292 }
 293
 294
 295 bool FileName::isDirWritable() const
 296 {
 297         LYXERR(Debug::FILES, "isDirWriteable: " << *this);
 298
 299         FileName const tmpfl = FileName::tempName(absFilename() + "/lyxwritetest");
 300
 301         if (tmpfl.empty())
 302                 return false;
 303
 304         tmpfl.removeFile();
 305         return true;
 306 }
 307
 308
 309 FileNameList FileName::dirList(string const & ext) const
 310 {
 311         FileNameList dirlist;
 312         if (!isDirectory()) {
 313                 LYXERR0("Directory '" << *this << "' does not exist!");
 314                 return dirlist;
 315         }
 316
 317         QDir dir = d->fi.absoluteDir();
 318
 319         if (!ext.empty()) {
 320                 QString filter;
 321                 switch (ext[0]) {
 322                 case '.': filter = "*" + toqstr(ext); break;
 323                 case '*': filter = toqstr(ext); break;
 324                 default: filter = "*." + toqstr(ext);
 325                 }
 326                 dir.setNameFilters(QStringList(filter));
 327                 LYXERR(Debug::FILES, "filtering on extension "
 328                         << fromqstr(filter) << " is requested.");
 329         }
 330
 331         QFileInfoList list = dir.entryInfoList();
 332         for (int i = 0; i != list.size(); ++i) {
 333                 FileName fi(fromqstr(list.at(i).absoluteFilePath()));
 334                 dirlist.push_back(fi);
 335                 LYXERR(Debug::FILES, "found file " << fi);
 336         }
 337
 338         return dirlist;
 339 }
 340
 341
 342 static int make_tempfile(char * templ)
 343 {
 344 #if defined(HAVE_MKSTEMP)
 345         return ::mkstemp(templ);
 346 #elif defined(HAVE_MKTEMP)
 347         // This probably just barely works...
 348         ::mktemp(templ);
 349 # if defined (HAVE_OPEN)
 350 # if (!defined S_IRUSR)
 351 #   define S_IRUSR S_IREAD
 352 #   define S_IWUSR S_IWRITE
 353 # endif
 354         return ::open(templ, O_RDWR | O_CREAT | O_EXCL, S_IRUSR | S_IWUSR);
 355 # elif defined (HAVE__OPEN)
 356         return ::_open(templ,
 357                        _O_RDWR | _O_CREAT | _O_EXCL,
 358                        _S_IREAD | _S_IWRITE);
 359 # else
 360 #  error No open() function.
 361 # endif
 362 #else
 363 #error FIX FIX FIX
 364 #endif
 365 }
 366
 367
 368 FileName FileName::tempName(string const & mask)
 369 {
 370         FileName tmp_name(mask);
 371         string tmpfl;
 372         if (tmp_name.d->fi.isAbsolute())
 373                 tmpfl = mask;
 374         else
 375                 tmpfl = package().temp_dir().absFilename() + "/" + mask;
 376
 377 #if defined (HAVE_GETPID)
 378         tmpfl += convert<string>(getpid());
 379 #elif defined (HAVE__GETPID)
 380         tmpfl += convert<string>(_getpid());
 381 #else
 382 # error No getpid() function
 383 #endif
 384         tmpfl += "XXXXXX";
 385
 386         // The supposedly safe mkstemp version
 387         // FIXME: why not using std::string directly?
 388         boost::scoped_array<char> tmpl(new char[tmpfl.length() + 1]); // + 1 for '\0'
 389         tmpfl.copy(tmpl.get(), string::npos);
 390         tmpl[tmpfl.length()] = '\0'; // terminator
 391
 392         int const tmpf = make_tempfile(tmpl.get());
 393         if (tmpf != -1) {
 394                 string const t(to_utf8(from_filesystem8bit(tmpl.get())));
 395 #if defined (HAVE_CLOSE)
 396                 ::close(tmpf);
 397 #elif defined (HAVE__CLOSE)
 398                 ::_close(tmpf);
 399 #else
 400 # error No x() function.
 401 #endif
 402                 LYXERR(Debug::FILES, "Temporary file `" << t << "' created.");
 403                 return FileName(t);
 404         }
 405         LYXERR(Debug::FILES, "LyX Error: Unable to create temporary file.");
 406         return FileName();
 407 }
 408
 409
 410 FileName FileName::getcwd()
 411 {
 412         return FileName(".");
 413 }
 414
 415
 416 time_t FileName::lastModified() const
 417 {
 418         return d->fi.lastModified().toTime_t();
 419 }
 420
 421
 422 bool FileName::chdir() const
 423 {
 424         return QDir::setCurrent(d->fi.absoluteFilePath());
 425 }
 426
 427
 428 extern unsigned long sum(char const * file);
 429
 430 unsigned long FileName::checksum() const
 431 {
 432         if (!exists()) {
 433                 //LYXERR0("File \"" << absFilename() << "\" does not exist!");
 434                 return 0;
 435         }
 436         // a directory may be passed here so we need to test it. (bug 3622)
 437         if (isDirectory()) {
 438                 LYXERR0('"' << absFilename() << "\" is a directory!");
 439                 return 0;
 440         }
 441         if (!lyxerr.debugging(Debug::FILES))
 442                 return sum(absFilename().c_str());
 443
 444         QTime t;
 445         t.start();
 446         unsigned long r = sum(absFilename().c_str());
 447         lyxerr << "Checksumming \"" << absFilename() << "\" lasted "
 448                 << t.elapsed() << " ms." << endl;
 449         return r;
 450 }
 451
 452
 453 bool FileName::removeFile() const
 454 {
 455         bool const success = QFile::remove(d->fi.absoluteFilePath());
 456         if (!success && exists())
 457                 LYXERR0("Could not delete file " << *this);
 458         return success;
 459 }
 460
 461
 462 static bool rmdir(QFileInfo const & fi)
 463 {
 464         QDir dir(fi.absoluteFilePath());
 465         QFileInfoList list = dir.entryInfoList();
 466         bool success = true;
 467         for (int i = 0; i != list.size(); ++i) {
 468                 if (list.at(i).fileName() == ".")
 469                         continue;
 470                 if (list.at(i).fileName() == "..")
 471                         continue;
 472                 bool removed;
 473                 if (list.at(i).isDir()) {
 474                         LYXERR(Debug::FILES, "Removing dir "
 475                                 << fromqstr(list.at(i).absoluteFilePath()));
 476                         removed = rmdir(list.at(i));
 477                 }
 478                 else {
 479                         LYXERR(Debug::FILES, "Removing file "
 480                                 << fromqstr(list.at(i).absoluteFilePath()));
 481                         removed = dir.remove(list.at(i).fileName());
 482                 }
 483                 if (!removed) {
 484                         success = false;
 485                         LYXERR0("Could not delete "
 486                                 << fromqstr(list.at(i).absoluteFilePath()));
 487                 }
 488         }
 489         QDir parent = fi.absolutePath();
 490         success &= parent.rmdir(fi.fileName());
 491         return success;
 492 }
 493
 494
 495 bool FileName::destroyDirectory() const
 496 {
 497         bool const success = rmdir(d->fi);
 498         if (!success)
 499                 LYXERR0("Could not delete " << *this);
 500
 501         return success;
 502 }
 503
 504
 505 static int mymkdir(char const * pathname, unsigned long int mode)
 506 {
 507         // FIXME: why don't we have mode_t in lyx::mkdir prototype ??
 508 #if HAVE_MKDIR
 509 # if MKDIR_TAKES_ONE_ARG
 510         // MinGW32
 511         return ::mkdir(pathname);
 512         // FIXME: "Permissions of created directories are ignored on this system."
 513 # else
 514         // POSIX
 515         return ::mkdir(pathname, mode_t(mode));
 516 # endif
 517 #elif defined(_WIN32)
 518         // plain Windows 32
 519         return CreateDirectory(pathname, 0) != 0 ? 0 : -1;
 520         // FIXME: "Permissions of created directories are ignored on this system."
 521 #elif HAVE__MKDIR
 522         return ::_mkdir(pathname);
 523         // FIXME: "Permissions of created directories are ignored on this system."
 524 #else
 525 #   error "Don't know how to create a directory on this system."
 526 #endif
 527
 528 }
 529
 530
 531 bool FileName::createDirectory(int permission) const
 532 {
 533         LASSERT(!empty(), /**/);
 534         return mymkdir(toFilesystemEncoding().c_str(), permission) == 0;
 535 }
 536
 537
 538 bool FileName::createPath() const
 539 {
 540         LASSERT(!empty(), /**/);
 541         if (isDirectory())
 542                 return true;
 543
 544         QDir dir;
 545         bool success = dir.mkpath(d->fi.absoluteFilePath());
 546         if (!success)
 547                 LYXERR0("Cannot create path '" << *this << "'!");
 548         return success;
 549 }
 550
 551
 552 docstring const FileName::absoluteFilePath() const
 553 {
 554         return qstring_to_ucs4(d->fi.absoluteFilePath());
 555 }
 556
 557
 558 docstring FileName::displayName(int threshold) const
 559 {
 560         return makeDisplayPath(absFilename(), threshold);
 561 }
 562
 563
 564 docstring FileName::fileContents(string const & encoding) const
 565 {
 566         if (!isReadableFile()) {
 567                 LYXERR0("File '" << *this << "' is not redable!");
 568                 return docstring();
 569         }
 570
 571         QFile file(d->fi.absoluteFilePath());
 572         if (!file.open(QIODevice::ReadOnly)) {
 573                 LYXERR0("File '" << *this
 574                         << "' could not be opened in read only mode!");
 575                 return docstring();
 576         }
 577         QByteArray contents = file.readAll();
 578         file.close();
 579
 580         if (contents.isEmpty()) {
 581                 LYXERR(Debug::FILES, "File '" << *this
 582                         << "' is either empty or some error happened while reading it.");
 583                 return docstring();
 584         }
 585
 586         QString s;
 587         if (encoding.empty() || encoding == "UTF-8")
 588                 s = QString::fromUtf8(contents.data());
 589         else if (encoding == "ascii")
 590                 s = QString::fromAscii(contents.data());
 591         else if (encoding == "local8bit")
 592                 s = QString::fromLocal8Bit(contents.data());
 593         else if (encoding == "latin1")
 594                 s = QString::fromLatin1(contents.data());
 595
 596         return qstring_to_ucs4(s);
 597 }
 598
 599
 600 void FileName::changeExtension(string const & extension)
 601 {
 602         // FIXME: use Qt native methods...
 603         string const oldname = absFilename();
 604         string::size_type const last_slash = oldname.rfind('/');
 605         string::size_type last_dot = oldname.rfind('.');
 606         if (last_dot < last_slash && last_slash != string::npos)
 607                 last_dot = string::npos;
 608
 609         string ext;
 610         // Make sure the extension starts with a dot
 611         if (!extension.empty() && extension[0] != '.')
 612                 ext= '.' + extension;
 613         else
 614                 ext = extension;
 615
 616         set(oldname.substr(0, last_dot) + ext);
 617 }
 618
 619
 620 string FileName::guessFormatFromContents() const
 621 {
 622         // the different filetypes and what they contain in one of the first lines
 623         // (dots are any characters).           (Herbert 20020131)
 624         // AGR  Grace...
 625         // BMP  BM...
 626         // EPS  %!PS-Adobe-3.0 EPSF...
 627         // FIG  #FIG...
 628         // FITS ...BITPIX...
 629         // GIF  GIF...
 630         // JPG  JFIF
 631         // PDF  %PDF-...
 632         // PNG  .PNG...
 633         // PBM  P1... or P4     (B/W)
 634         // PGM  P2... or P5     (Grayscale)
 635         // PPM  P3... or P6     (color)
 636         // PS   %!PS-Adobe-2.0 or 1.0,  no "EPSF"!
 637         // SGI  \001\332...     (decimal 474)
 638         // TGIF %TGIF...
 639         // TIFF II... or MM...
 640         // XBM  ..._bits[]...
 641         // XPM  /* XPM */    sometimes missing (f.ex. tgif-export)
 642         //      ...static char *...
 643         // XWD  \000\000\000\151        (0x00006900) decimal 105
 644         //
 645         // GZIP \037\213        http://www.ietf.org/rfc/rfc1952.txt
 646         // ZIP  PK...                   http://www.halyava.ru/document/ind_arch.htm
 647         // Z    \037\235                UNIX compress
 648
 649         // paranoia check
 650         if (empty() || !isReadableFile())
 651                 return string();
 652
 653         ifstream ifs(toFilesystemEncoding().c_str());
 654         if (!ifs)
 655                 // Couldn't open file...
 656                 return string();
 657
 658         // gnuzip
 659         static string const gzipStamp = "\037\213";
 660
 661         // PKZIP
 662         static string const zipStamp = "PK";
 663
 664         // compress
 665         static string const compressStamp = "\037\235";
 666
 667         // Maximum strings to read
 668         int const max_count = 50;
 669         int count = 0;
 670
 671         string str;
 672         string format;
 673         bool firstLine = true;
 674         while ((count++ < max_count) && format.empty()) {
 675                 if (ifs.eof()) {
 676                         LYXERR(Debug::GRAPHICS, "filetools(getFormatFromContents)\n"
 677                                 << "\tFile type not recognised before EOF!");
 678                         break;
 679                 }
 680
 681                 getline(ifs, str);
 682                 string const stamp = str.substr(0, 2);
 683                 if (firstLine && str.size() >= 2) {
 684                         // at first we check for a zipped file, because this
 685                         // information is saved in the first bytes of the file!
 686                         // also some graphic formats which save the information
 687                         // in the first line, too.
 688                         if (prefixIs(str, gzipStamp)) {
 689                                 format =  "gzip";
 690
 691                         } else if (stamp == zipStamp) {
 692                                 format =  "zip";
 693
 694                         } else if (stamp == compressStamp) {
 695                                 format =  "compress";
 696
 697                         // the graphics part
 698                         } else if (stamp == "BM") {
 699                                 format =  "bmp";
 700
 701                         } else if (stamp == "\001\332") {
 702                                 format =  "sgi";
 703
 704                         // PBM family
 705                         // Don't need to use str.at(0), str.at(1) because
 706                         // we already know that str.size() >= 2
 707                         } else if (str[0] == 'P') {
 708                                 switch (str[1]) {
 709                                 case '1':
 710                                 case '4':
 711                                         format =  "pbm";
 712                                     break;
 713                                 case '2':
 714                                 case '5':
 715                                         format =  "pgm";
 716                                     break;
 717                                 case '3':
 718                                 case '6':
 719                                         format =  "ppm";
 720                                 }
 721                                 break;
 722
 723                         } else if ((stamp == "II") || (stamp == "MM")) {
 724                                 format =  "tiff";
 725
 726                         } else if (prefixIs(str,"%TGIF")) {
 727                                 format =  "tgif";
 728
 729                         } else if (prefixIs(str,"#FIG")) {
 730                                 format =  "fig";
 731
 732                         } else if (prefixIs(str,"GIF")) {
 733                                 format =  "gif";
 734
 735                         } else if (str.size() > 3) {
 736                                 int const c = ((str[0] << 24) & (str[1] << 16) &
 737                                                (str[2] << 8)  & str[3]);
 738                                 if (c == 105) {
 739                                         format =  "xwd";
 740                                 }
 741                         }
 742
 743                         firstLine = false;
 744                 }
 745
 746                 if (!format.empty())
 747                     break;
 748                 else if (contains(str,"EPSF"))
 749                         // dummy, if we have wrong file description like
 750                         // %!PS-Adobe-2.0EPSF"
 751                         format = "eps";
 752
 753                 else if (contains(str, "Grace"))
 754                         format = "agr";
 755
 756                 else if (contains(str, "JFIF"))
 757                         format = "jpg";
 758
 759                 else if (contains(str, "%PDF"))
 760                         format = "pdf";
 761
 762                 else if (contains(str, "PNG"))
 763                         format = "png";
 764
 765                 else if (contains(str, "%!PS-Adobe")) {
 766                         // eps or ps
 767                         ifs >> str;
 768                         if (contains(str,"EPSF"))
 769                                 format = "eps";
 770                         else
 771                             format = "ps";
 772                 }
 773
 774                 else if (contains(str, "_bits[]"))
 775                         format = "xbm";
 776
 777                 else if (contains(str, "XPM") || contains(str, "static char *"))
 778                         format = "xpm";
 779
 780                 else if (contains(str, "BITPIX"))
 781                         format = "fits";
 782         }
 783
 784         if (!format.empty()) {
 785                 LYXERR(Debug::GRAPHICS, "Recognised Fileformat: " << format);
 786                 return format;
 787         }
 788
 789         LYXERR(Debug::GRAPHICS, "filetools(getFormatFromContents)\n"
 790                 << "\tCouldn't find a known format!");
 791         return string();
 792 }
 793
 794
 795 bool FileName::isZippedFile() const
 796 {
 797         string const type = guessFormatFromContents();
 798         return contains("gzip zip compress", type) && !type.empty();
 799 }
 800
 801
 802 docstring const FileName::relPath(string const & path) const
 803 {
 804         // FIXME UNICODE
 805         return makeRelPath(absoluteFilePath(), from_utf8(path));
 806 }
 807
 808
 809 bool operator==(FileName const & lhs, FileName const & rhs)
 810 {
 811         return lhs.absFilename() == rhs.absFilename();
 812 }
 813
 814
 815 bool operator!=(FileName const & lhs, FileName const & rhs)
 816 {
 817         return lhs.absFilename() != rhs.absFilename();
 818 }
 819
 820
 821 bool operator<(FileName const & lhs, FileName const & rhs)
 822 {
 823         return lhs.absFilename() < rhs.absFilename();
 824 }
 825
 826
 827 bool operator>(FileName const & lhs, FileName const & rhs)
 828 {
 829         return lhs.absFilename() > rhs.absFilename();
 830 }
 831
 832
 833 ostream & operator<<(ostream & os, FileName const & filename)
 834 {
 835         return os << filename.absFilename();
 836 }
 837
 838
 839 /////////////////////////////////////////////////////////////////////
 840 //
 841 // DocFileName
 842 //
 843 /////////////////////////////////////////////////////////////////////
 844
 845
 846 DocFileName::DocFileName()
 847         : save_abs_path_(true)
 848 {}
 849
 850
 851 DocFileName::DocFileName(string const & abs_filename, bool save_abs)
 852         : FileName(abs_filename), save_abs_path_(save_abs), zipped_valid_(false)
 853 {}
 854
 855
 856 DocFileName::DocFileName(FileName const & abs_filename, bool save_abs)
 857         : FileName(abs_filename), save_abs_path_(save_abs), zipped_valid_(false)
 858 {}
 859
 860
 861 void DocFileName::set(string const & name, string const & buffer_path)
 862 {
 863         FileName::set(name);
 864         bool const nameIsAbsolute = isAbsolute();
 865         save_abs_path_ = nameIsAbsolute;
 866         if (!nameIsAbsolute)
 867                 FileName::set(makeAbsPath(name, buffer_path).absFilename());
 868         zipped_valid_ = false;
 869 }
 870
 871
 872 void DocFileName::erase()
 873 {
 874         FileName::erase();
 875         zipped_valid_ = false;
 876 }
 877
 878
 879 string DocFileName::relFilename(string const & path) const
 880 {
 881         // FIXME UNICODE
 882         return to_utf8(relPath(path));
 883 }
 884
 885
 886 string DocFileName::outputFilename(string const & path) const
 887 {
 888         return save_abs_path_ ? absFilename() : relFilename(path);
 889 }
 890
 891
 892 string DocFileName::mangledFilename(string const & dir) const
 893 {
 894         // We need to make sure that every DocFileName instance for a given
 895         // filename returns the same mangled name.
 896         typedef map<string, string> MangledMap;
 897         static MangledMap mangledNames;
 898         MangledMap::const_iterator const it = mangledNames.find(absFilename());
 899         if (it != mangledNames.end())
 900                 return (*it).second;
 901
 902         string const name = absFilename();
 903         // Now the real work
 904         string mname = os::internal_path(name);
 905         // Remove the extension.
 906         mname = support::changeExtension(name, string());
 907         // The mangled name must be a valid LaTeX name.
 908         // The list of characters to keep is probably over-restrictive,
 909         // but it is not really a problem.
 910         // Apart from non-ASCII characters, at least the following characters
 911         // are forbidden: '/', '.', ' ', and ':'.
 912         // On windows it is not possible to create files with '<', '>' or '?'
 913         // in the name.
 914         static string const keep = "abcdefghijklmnopqrstuvwxyz"
 915                                    "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
 916                                    "+,-0123456789;=";
 917         string::size_type pos = 0;
 918         while ((pos = mname.find_first_not_of(keep, pos)) != string::npos)
 919                 mname[pos++] = '_';
 920         // Add the extension back on
 921         mname = support::changeExtension(mname, getExtension(name));
 922
 923         // Prepend a counter to the filename. This is necessary to make
 924         // the mangled name unique.
 925         static int counter = 0;
 926         ostringstream s;
 927         s << counter++ << mname;
 928         mname = s.str();
 929
 930         // MiKTeX's YAP (version 2.4.1803) crashes if the file name
 931         // is longer than about 160 characters. MiKTeX's pdflatex
 932         // is even pickier. A maximum length of 100 has been proven to work.
 933         // If dir.size() > max length, all bets are off for YAP. We truncate
 934         // the filename nevertheless, keeping a minimum of 10 chars.
 935
 936         string::size_type max_length = max(100 - ((int)dir.size() + 1), 10);
 937
 938         // If the mangled file name is too long, hack it to fit.
 939         // We know we're guaranteed to have a unique file name because
 940         // of the counter.
 941         if (mname.size() > max_length) {
 942                 int const half = (int(max_length) / 2) - 2;
 943                 if (half > 0) {
 944                         mname = mname.substr(0, half) + "___" +
 945                                 mname.substr(mname.size() - half);
 946                 }
 947         }
 948
 949         mangledNames[absFilename()] = mname;
 950         return mname;
 951 }
 952
 953
 954 bool DocFileName::isZipped() const
 955 {
 956         if (!zipped_valid_) {
 957                 zipped_ = isZippedFile();
 958                 zipped_valid_ = true;
 959         }
 960         return zipped_;
 961 }
 962
 963
 964 string DocFileName::unzippedFilename() const
 965 {
 966         return unzippedFileName(absFilename());
 967 }
 968
 969
 970 bool operator==(DocFileName const & lhs, DocFileName const & rhs)
 971 {
 972         return lhs.absFilename() == rhs.absFilename()
 973                 && lhs.saveAbsPath() == rhs.saveAbsPath();
 974 }
 975
 976
 977 bool operator!=(DocFileName const & lhs, DocFileName const & rhs)
 978 {
 979         return !(lhs == rhs);
 980 }
 981
 982 } // namespace support
 983 } // namespace lyx