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         // QFileInfo caches information about the file. So, in case this file has
 419         // been touched between the object creation and now, we refresh the file
 420         // information.
 421         LYXERR0("File: " << *this << ", " << fromqstr(d->fi.lastModified().toString("dd.MM.yyyy hh:MM")));
 422         d->fi.refresh();
 423         LYXERR0(fromqstr(d->fi.lastModified().toString("dd.MM.yyyy hh:MM")));
 424         return d->fi.lastModified().toTime_t();
 425 }
 426
 427
 428 bool FileName::chdir() const
 429 {
 430         return QDir::setCurrent(d->fi.absoluteFilePath());
 431 }
 432
 433
 434 extern unsigned long sum(char const * file);
 435
 436 unsigned long FileName::checksum() const
 437 {
 438         if (!exists()) {
 439                 //LYXERR0("File \"" << absFilename() << "\" does not exist!");
 440                 return 0;
 441         }
 442         // a directory may be passed here so we need to test it. (bug 3622)
 443         if (isDirectory()) {
 444                 LYXERR0('"' << absFilename() << "\" is a directory!");
 445                 return 0;
 446         }
 447         if (!lyxerr.debugging(Debug::FILES))
 448                 return sum(absFilename().c_str());
 449
 450         QTime t;
 451         t.start();
 452         unsigned long r = sum(absFilename().c_str());
 453         lyxerr << "Checksumming \"" << absFilename() << "\" lasted "
 454                 << t.elapsed() << " ms." << endl;
 455         return r;
 456 }
 457
 458
 459 bool FileName::removeFile() const
 460 {
 461         bool const success = QFile::remove(d->fi.absoluteFilePath());
 462         if (!success && exists())
 463                 LYXERR0("Could not delete file " << *this);
 464         return success;
 465 }
 466
 467
 468 static bool rmdir(QFileInfo const & fi)
 469 {
 470         QDir dir(fi.absoluteFilePath());
 471         QFileInfoList list = dir.entryInfoList();
 472         bool success = true;
 473         for (int i = 0; i != list.size(); ++i) {
 474                 if (list.at(i).fileName() == ".")
 475                         continue;
 476                 if (list.at(i).fileName() == "..")
 477                         continue;
 478                 bool removed;
 479                 if (list.at(i).isDir()) {
 480                         LYXERR(Debug::FILES, "Removing dir "
 481                                 << fromqstr(list.at(i).absoluteFilePath()));
 482                         removed = rmdir(list.at(i));
 483                 }
 484                 else {
 485                         LYXERR(Debug::FILES, "Removing file "
 486                                 << fromqstr(list.at(i).absoluteFilePath()));
 487                         removed = dir.remove(list.at(i).fileName());
 488                 }
 489                 if (!removed) {
 490                         success = false;
 491                         LYXERR0("Could not delete "
 492                                 << fromqstr(list.at(i).absoluteFilePath()));
 493                 }
 494         }
 495         QDir parent = fi.absolutePath();
 496         success &= parent.rmdir(fi.fileName());
 497         return success;
 498 }
 499
 500
 501 bool FileName::destroyDirectory() const
 502 {
 503         bool const success = rmdir(d->fi);
 504         if (!success)
 505                 LYXERR0("Could not delete " << *this);
 506
 507         return success;
 508 }
 509
 510
 511 static int mymkdir(char const * pathname, unsigned long int mode)
 512 {
 513         // FIXME: why don't we have mode_t in lyx::mkdir prototype ??
 514 #if HAVE_MKDIR
 515 # if MKDIR_TAKES_ONE_ARG
 516         // MinGW32
 517         return ::mkdir(pathname);
 518         // FIXME: "Permissions of created directories are ignored on this system."
 519 # else
 520         // POSIX
 521         return ::mkdir(pathname, mode_t(mode));
 522 # endif
 523 #elif defined(_WIN32)
 524         // plain Windows 32
 525         return CreateDirectory(pathname, 0) != 0 ? 0 : -1;
 526         // FIXME: "Permissions of created directories are ignored on this system."
 527 #elif HAVE__MKDIR
 528         return ::_mkdir(pathname);
 529         // FIXME: "Permissions of created directories are ignored on this system."
 530 #else
 531 #   error "Don't know how to create a directory on this system."
 532 #endif
 533
 534 }
 535
 536
 537 bool FileName::createDirectory(int permission) const
 538 {
 539         LASSERT(!empty(), /**/);
 540         return mymkdir(toFilesystemEncoding().c_str(), permission) == 0;
 541 }
 542
 543
 544 bool FileName::createPath() const
 545 {
 546         LASSERT(!empty(), /**/);
 547         if (isDirectory())
 548                 return true;
 549
 550         QDir dir;
 551         bool success = dir.mkpath(d->fi.absoluteFilePath());
 552         if (!success)
 553                 LYXERR0("Cannot create path '" << *this << "'!");
 554         return success;
 555 }
 556
 557
 558 docstring const FileName::absoluteFilePath() const
 559 {
 560         return qstring_to_ucs4(d->fi.absoluteFilePath());
 561 }
 562
 563
 564 docstring FileName::displayName(int threshold) const
 565 {
 566         return makeDisplayPath(absFilename(), threshold);
 567 }
 568
 569
 570 docstring FileName::fileContents(string const & encoding) const
 571 {
 572         if (!isReadableFile()) {
 573                 LYXERR0("File '" << *this << "' is not redable!");
 574                 return docstring();
 575         }
 576
 577         QFile file(d->fi.absoluteFilePath());
 578         if (!file.open(QIODevice::ReadOnly)) {
 579                 LYXERR0("File '" << *this
 580                         << "' could not be opened in read only mode!");
 581                 return docstring();
 582         }
 583         QByteArray contents = file.readAll();
 584         file.close();
 585
 586         if (contents.isEmpty()) {
 587                 LYXERR(Debug::FILES, "File '" << *this
 588                         << "' is either empty or some error happened while reading it.");
 589                 return docstring();
 590         }
 591
 592         QString s;
 593         if (encoding.empty() || encoding == "UTF-8")
 594                 s = QString::fromUtf8(contents.data());
 595         else if (encoding == "ascii")
 596                 s = QString::fromAscii(contents.data());
 597         else if (encoding == "local8bit")
 598                 s = QString::fromLocal8Bit(contents.data());
 599         else if (encoding == "latin1")
 600                 s = QString::fromLatin1(contents.data());
 601
 602         return qstring_to_ucs4(s);
 603 }
 604
 605
 606 void FileName::changeExtension(string const & extension)
 607 {
 608         // FIXME: use Qt native methods...
 609         string const oldname = absFilename();
 610         string::size_type const last_slash = oldname.rfind('/');
 611         string::size_type last_dot = oldname.rfind('.');
 612         if (last_dot < last_slash && last_slash != string::npos)
 613                 last_dot = string::npos;
 614
 615         string ext;
 616         // Make sure the extension starts with a dot
 617         if (!extension.empty() && extension[0] != '.')
 618                 ext= '.' + extension;
 619         else
 620                 ext = extension;
 621
 622         set(oldname.substr(0, last_dot) + ext);
 623 }
 624
 625
 626 string FileName::guessFormatFromContents() const
 627 {
 628         // the different filetypes and what they contain in one of the first lines
 629         // (dots are any characters).           (Herbert 20020131)
 630         // AGR  Grace...
 631         // BMP  BM...
 632         // EPS  %!PS-Adobe-3.0 EPSF...
 633         // FIG  #FIG...
 634         // FITS ...BITPIX...
 635         // GIF  GIF...
 636         // JPG  JFIF
 637         // PDF  %PDF-...
 638         // PNG  .PNG...
 639         // PBM  P1... or P4     (B/W)
 640         // PGM  P2... or P5     (Grayscale)
 641         // PPM  P3... or P6     (color)
 642         // PS   %!PS-Adobe-2.0 or 1.0,  no "EPSF"!
 643         // SGI  \001\332...     (decimal 474)
 644         // TGIF %TGIF...
 645         // TIFF II... or MM...
 646         // XBM  ..._bits[]...
 647         // XPM  /* XPM */    sometimes missing (f.ex. tgif-export)
 648         //      ...static char *...
 649         // XWD  \000\000\000\151        (0x00006900) decimal 105
 650         //
 651         // GZIP \037\213        http://www.ietf.org/rfc/rfc1952.txt
 652         // ZIP  PK...                   http://www.halyava.ru/document/ind_arch.htm
 653         // Z    \037\235                UNIX compress
 654
 655         // paranoia check
 656         if (empty() || !isReadableFile())
 657                 return string();
 658
 659         ifstream ifs(toFilesystemEncoding().c_str());
 660         if (!ifs)
 661                 // Couldn't open file...
 662                 return string();
 663
 664         // gnuzip
 665         static string const gzipStamp = "\037\213";
 666
 667         // PKZIP
 668         static string const zipStamp = "PK";
 669
 670         // compress
 671         static string const compressStamp = "\037\235";
 672
 673         // Maximum strings to read
 674         int const max_count = 50;
 675         int count = 0;
 676
 677         string str;
 678         string format;
 679         bool firstLine = true;
 680         while ((count++ < max_count) && format.empty()) {
 681                 if (ifs.eof()) {
 682                         LYXERR(Debug::GRAPHICS, "filetools(getFormatFromContents)\n"
 683                                 << "\tFile type not recognised before EOF!");
 684                         break;
 685                 }
 686
 687                 getline(ifs, str);
 688                 string const stamp = str.substr(0, 2);
 689                 if (firstLine && str.size() >= 2) {
 690                         // at first we check for a zipped file, because this
 691                         // information is saved in the first bytes of the file!
 692                         // also some graphic formats which save the information
 693                         // in the first line, too.
 694                         if (prefixIs(str, gzipStamp)) {
 695                                 format =  "gzip";
 696
 697                         } else if (stamp == zipStamp) {
 698                                 format =  "zip";
 699
 700                         } else if (stamp == compressStamp) {
 701                                 format =  "compress";
 702
 703                         // the graphics part
 704                         } else if (stamp == "BM") {
 705                                 format =  "bmp";
 706
 707                         } else if (stamp == "\001\332") {
 708                                 format =  "sgi";
 709
 710                         // PBM family
 711                         // Don't need to use str.at(0), str.at(1) because
 712                         // we already know that str.size() >= 2
 713                         } else if (str[0] == 'P') {
 714                                 switch (str[1]) {
 715                                 case '1':
 716                                 case '4':
 717                                         format =  "pbm";
 718                                     break;
 719                                 case '2':
 720                                 case '5':
 721                                         format =  "pgm";
 722                                     break;
 723                                 case '3':
 724                                 case '6':
 725                                         format =  "ppm";
 726                                 }
 727                                 break;
 728
 729                         } else if ((stamp == "II") || (stamp == "MM")) {
 730                                 format =  "tiff";
 731
 732                         } else if (prefixIs(str,"%TGIF")) {
 733                                 format =  "tgif";
 734
 735                         } else if (prefixIs(str,"#FIG")) {
 736                                 format =  "fig";
 737
 738                         } else if (prefixIs(str,"GIF")) {
 739                                 format =  "gif";
 740
 741                         } else if (str.size() > 3) {
 742                                 int const c = ((str[0] << 24) & (str[1] << 16) &
 743                                                (str[2] << 8)  & str[3]);
 744                                 if (c == 105) {
 745                                         format =  "xwd";
 746                                 }
 747                         }
 748
 749                         firstLine = false;
 750                 }
 751
 752                 if (!format.empty())
 753                     break;
 754                 else if (contains(str,"EPSF"))
 755                         // dummy, if we have wrong file description like
 756                         // %!PS-Adobe-2.0EPSF"
 757                         format = "eps";
 758
 759                 else if (contains(str, "Grace"))
 760                         format = "agr";
 761
 762                 else if (contains(str, "JFIF"))
 763                         format = "jpg";
 764
 765                 else if (contains(str, "%PDF"))
 766                         format = "pdf";
 767
 768                 else if (contains(str, "PNG"))
 769                         format = "png";
 770
 771                 else if (contains(str, "%!PS-Adobe")) {
 772                         // eps or ps
 773                         ifs >> str;
 774                         if (contains(str,"EPSF"))
 775                                 format = "eps";
 776                         else
 777                             format = "ps";
 778                 }
 779
 780                 else if (contains(str, "_bits[]"))
 781                         format = "xbm";
 782
 783                 else if (contains(str, "XPM") || contains(str, "static char *"))
 784                         format = "xpm";
 785
 786                 else if (contains(str, "BITPIX"))
 787                         format = "fits";
 788         }
 789
 790         if (!format.empty()) {
 791                 LYXERR(Debug::GRAPHICS, "Recognised Fileformat: " << format);
 792                 return format;
 793         }
 794
 795         LYXERR(Debug::GRAPHICS, "filetools(getFormatFromContents)\n"
 796                 << "\tCouldn't find a known format!");
 797         return string();
 798 }
 799
 800
 801 bool FileName::isZippedFile() const
 802 {
 803         string const type = guessFormatFromContents();
 804         return contains("gzip zip compress", type) && !type.empty();
 805 }
 806
 807
 808 docstring const FileName::relPath(string const & path) const
 809 {
 810         // FIXME UNICODE
 811         return makeRelPath(absoluteFilePath(), from_utf8(path));
 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 bool operator>(FileName const & lhs, FileName const & rhs)
 834 {
 835         return lhs.absFilename() > rhs.absFilename();
 836 }
 837
 838
 839 ostream & operator<<(ostream & os, FileName const & filename)
 840 {
 841         return os << filename.absFilename();
 842 }
 843
 844
 845 /////////////////////////////////////////////////////////////////////
 846 //
 847 // DocFileName
 848 //
 849 /////////////////////////////////////////////////////////////////////
 850
 851
 852 DocFileName::DocFileName()
 853         : save_abs_path_(true)
 854 {}
 855
 856
 857 DocFileName::DocFileName(string const & abs_filename, bool save_abs)
 858         : FileName(abs_filename), save_abs_path_(save_abs), zipped_valid_(false)
 859 {}
 860
 861
 862 DocFileName::DocFileName(FileName const & abs_filename, bool save_abs)
 863         : FileName(abs_filename), save_abs_path_(save_abs), zipped_valid_(false)
 864 {}
 865
 866
 867 void DocFileName::set(string const & name, string const & buffer_path)
 868 {
 869         FileName::set(name);
 870         bool const nameIsAbsolute = isAbsolute();
 871         save_abs_path_ = nameIsAbsolute;
 872         if (!nameIsAbsolute)
 873                 FileName::set(makeAbsPath(name, buffer_path).absFilename());
 874         zipped_valid_ = false;
 875 }
 876
 877
 878 void DocFileName::erase()
 879 {
 880         FileName::erase();
 881         zipped_valid_ = false;
 882 }
 883
 884
 885 string DocFileName::relFilename(string const & path) const
 886 {
 887         // FIXME UNICODE
 888         return to_utf8(relPath(path));
 889 }
 890
 891
 892 string DocFileName::outputFilename(string const & path) const
 893 {
 894         return save_abs_path_ ? absFilename() : relFilename(path);
 895 }
 896
 897
 898 string DocFileName::mangledFilename(string const & dir) const
 899 {
 900         // We need to make sure that every DocFileName instance for a given
 901         // filename returns the same mangled name.
 902         typedef map<string, string> MangledMap;
 903         static MangledMap mangledNames;
 904         MangledMap::const_iterator const it = mangledNames.find(absFilename());
 905         if (it != mangledNames.end())
 906                 return (*it).second;
 907
 908         string const name = absFilename();
 909         // Now the real work
 910         string mname = os::internal_path(name);
 911         // Remove the extension.
 912         mname = support::changeExtension(name, string());
 913         // The mangled name must be a valid LaTeX name.
 914         // The list of characters to keep is probably over-restrictive,
 915         // but it is not really a problem.
 916         // Apart from non-ASCII characters, at least the following characters
 917         // are forbidden: '/', '.', ' ', and ':'.
 918         // On windows it is not possible to create files with '<', '>' or '?'
 919         // in the name.
 920         static string const keep = "abcdefghijklmnopqrstuvwxyz"
 921                                    "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
 922                                    "+,-0123456789;=";
 923         string::size_type pos = 0;
 924         while ((pos = mname.find_first_not_of(keep, pos)) != string::npos)
 925                 mname[pos++] = '_';
 926         // Add the extension back on
 927         mname = support::changeExtension(mname, getExtension(name));
 928
 929         // Prepend a counter to the filename. This is necessary to make
 930         // the mangled name unique.
 931         static int counter = 0;
 932         ostringstream s;
 933         s << counter++ << mname;
 934         mname = s.str();
 935
 936         // MiKTeX's YAP (version 2.4.1803) crashes if the file name
 937         // is longer than about 160 characters. MiKTeX's pdflatex
 938         // is even pickier. A maximum length of 100 has been proven to work.
 939         // If dir.size() > max length, all bets are off for YAP. We truncate
 940         // the filename nevertheless, keeping a minimum of 10 chars.
 941
 942         string::size_type max_length = max(100 - ((int)dir.size() + 1), 10);
 943
 944         // If the mangled file name is too long, hack it to fit.
 945         // We know we're guaranteed to have a unique file name because
 946         // of the counter.
 947         if (mname.size() > max_length) {
 948                 int const half = (int(max_length) / 2) - 2;
 949                 if (half > 0) {
 950                         mname = mname.substr(0, half) + "___" +
 951                                 mname.substr(mname.size() - half);
 952                 }
 953         }
 954
 955         mangledNames[absFilename()] = mname;
 956         return mname;
 957 }
 958
 959
 960 bool DocFileName::isZipped() const
 961 {
 962         if (!zipped_valid_) {
 963                 zipped_ = isZippedFile();
 964                 zipped_valid_ = true;
 965         }
 966         return zipped_;
 967 }
 968
 969
 970 string DocFileName::unzippedFilename() const
 971 {
 972         return unzippedFileName(absFilename());
 973 }
 974
 975
 976 bool operator==(DocFileName const & lhs, DocFileName const & rhs)
 977 {
 978         return lhs.absFilename() == rhs.absFilename()
 979                 && lhs.saveAbsPath() == rhs.saveAbsPath();
 980 }
 981
 982
 983 bool operator!=(DocFileName const & lhs, DocFileName const & rhs)
 984 {
 985         return !(lhs == rhs);
 986 }
 987
 988 } // namespace support
 989 } // namespace lyx