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/debug.h"
  17 #include "support/filetools.h"
  18 #include "support/lassert.h"
  19 #include "support/lstrings.h"
  20 #include "support/mutex.h"
  21 #include "support/os.h"
  22 #include "support/Package.h"
  23 #include "support/qstring_helpers.h"
  24
  25 #include <QDateTime>
  26 #include <QDir>
  27 #include <QFile>
  28 #include <QFileInfo>
  29 #include <QList>
  30 #include <QTemporaryFile>
  31 #include <QTime>
  32
  33 #include <boost/crc.hpp>
  34 #include <boost/scoped_array.hpp>
  35
  36 #include <algorithm>
  37 #include <iterator>
  38 #include <fstream>
  39 #include <iomanip>
  40 #include <map>
  41 #include <sstream>
  42
  43 #ifdef HAVE_SYS_TYPES_H
  44 # include <sys/types.h>
  45 #endif
  46 #ifdef HAVE_SYS_STAT_H
  47 # include <sys/stat.h>
  48 #endif
  49 #ifdef HAVE_UNISTD_H
  50 # include <unistd.h>
  51 #endif
  52 #ifdef HAVE_DIRECT_H
  53 # include <direct.h>
  54 #endif
  55 #ifdef _WIN32
  56 # include <windows.h>
  57 #endif
  58
  59 #include <cerrno>
  60 #include <fcntl.h>
  61
  62 // Three implementations of checksum(), depending on having mmap support or not.
  63 #if defined(HAVE_MMAP) && defined(HAVE_MUNMAP)
  64 #define SUM_WITH_MMAP
  65 #include <sys/mman.h>
  66 #endif // SUM_WITH_MMAP
  67
  68 using namespace std;
  69 using namespace lyx::support;
  70
  71 // OK, this is ugly, but it is the only workaround I found to compile
  72 // with gcc (any version) on a system which uses a non-GNU toolchain.
  73 // The problem is that gcc uses a weak symbol for a particular
  74 // instantiation and that the system linker usually does not
  75 // understand those weak symbols (seen on HP-UX, tru64, AIX and
  76 // others). Thus we force an explicit instanciation of this particular
  77 // template (JMarc)
  78 template struct boost::detail::crc_table_t<32, 0x04C11DB7, true>;
  79
  80 namespace lyx {
  81 namespace support {
  82
  83 /////////////////////////////////////////////////////////////////////
  84 //
  85 // FileName::Private
  86 //
  87 /////////////////////////////////////////////////////////////////////
  88
  89 struct FileName::Private
  90 {
  91         Private() {}
  92
  93         Private(string const & abs_filename) : fi(toqstr(abs_filename))
  94         {
  95                 name = fromqstr(fi.absoluteFilePath());
  96                 fi.setCaching(fi.exists() ? true : false);
  97         }
  98         ///
  99         inline void refresh()
 100         {
 101                 fi.refresh();
 102         }
 103
 104
 105         static
 106         bool isFilesystemEqual(QString const & lhs, QString const & rhs)
 107         {
 108                 return QString::compare(lhs, rhs, os::isFilesystemCaseSensitive() ?
 109                         Qt::CaseSensitive : Qt::CaseInsensitive) == 0;
 110         }
 111
 112         /// The absolute file name in UTF-8 encoding.
 113         std::string name;
 114         ///
 115         QFileInfo fi;
 116 };
 117
 118 /////////////////////////////////////////////////////////////////////
 119 //
 120 // FileName
 121 //
 122 /////////////////////////////////////////////////////////////////////
 123
 124
 125 FileName::FileName() : d(new Private)
 126 {
 127 }
 128
 129
 130 FileName::FileName(string const & abs_filename)
 131         : d(abs_filename.empty() ? new Private : new Private(abs_filename))
 132 {
 133         //LYXERR(Debug::FILES, "FileName(" << abs_filename << ')');
 134         LATTEST(empty() || isAbsolute(d->name));
 135 }
 136
 137
 138 FileName::~FileName()
 139 {
 140         delete d;
 141 }
 142
 143
 144 FileName::FileName(FileName const & rhs) : d(new Private)
 145 {
 146         d->name = rhs.d->name;
 147         d->fi = rhs.d->fi;
 148 }
 149
 150
 151 FileName::FileName(FileName const & rhs, string const & suffix) : d(new Private)
 152 {
 153         set(rhs, suffix);
 154 }
 155
 156
 157 FileName & FileName::operator=(FileName const & rhs)
 158 {
 159         if (&rhs == this)
 160                 return *this;
 161         d->name = rhs.d->name;
 162         d->fi = rhs.d->fi;
 163         return *this;
 164 }
 165
 166
 167 bool FileName::empty() const
 168 {
 169         return d->name.empty();
 170 }
 171
 172
 173 bool FileName::isAbsolute(string const & name)
 174 {
 175         QFileInfo fi(toqstr(name));
 176         return fi.isAbsolute();
 177 }
 178
 179
 180 string FileName::absFileName() const
 181 {
 182         return d->name;
 183 }
 184
 185
 186 string FileName::realPath() const
 187 {
 188         return os::real_path(absFileName());
 189 }
 190
 191
 192 void FileName::set(string const & name)
 193 {
 194         d->fi.setFile(toqstr(name));
 195         d->name = fromqstr(d->fi.absoluteFilePath());
 196         //LYXERR(Debug::FILES, "FileName::set(" << name << ')');
 197         LATTEST(empty() || isAbsolute(d->name));
 198 }
 199
 200
 201 void FileName::set(FileName const & rhs, string const & suffix)
 202 {
 203         if (!rhs.d->fi.isDir())
 204                 d->fi.setFile(rhs.d->fi.filePath() + toqstr(suffix));
 205         else
 206                 d->fi.setFile(QDir(rhs.d->fi.absoluteFilePath()), toqstr(suffix));
 207         d->name = fromqstr(d->fi.absoluteFilePath());
 208         //LYXERR(Debug::FILES, "FileName::set(" << d->name << ')');
 209         LATTEST(empty() || isAbsolute(d->name));
 210 }
 211
 212
 213 void FileName::erase()
 214 {
 215         d->name.clear();
 216         d->fi = QFileInfo();
 217 }
 218
 219
 220 bool FileName::copyTo(FileName const & name, bool keepsymlink) const
 221 {
 222         FileNameSet visited;
 223         return copyTo(name, keepsymlink, visited);
 224 }
 225
 226
 227 bool FileName::copyTo(FileName const & name, bool keepsymlink,
 228                       FileName::FileNameSet & visited) const
 229 {
 230         LYXERR(Debug::FILES, "Copying " << name << " keep symlink: " << keepsymlink);
 231         if (keepsymlink && name.isSymLink()) {
 232                 visited.insert(*this);
 233                 FileName const target(fromqstr(name.d->fi.symLinkTarget()));
 234                 if (visited.find(target) != visited.end()) {
 235                         LYXERR(Debug::FILES, "Found circular symlink: " << target);
 236                         return false;
 237                 }
 238                 return copyTo(target, true);
 239         }
 240         QFile::remove(name.d->fi.absoluteFilePath());
 241         bool success = QFile::copy(d->fi.absoluteFilePath(), name.d->fi.absoluteFilePath());
 242         if (!success)
 243                 LYXERR0("FileName::copyTo(): Could not copy file "
 244                         << *this << " to " << name);
 245         return success;
 246 }
 247
 248
 249 bool FileName::renameTo(FileName const & name) const
 250 {
 251         LYXERR(Debug::FILES, "Renaming " << name << " as " << *this);
 252         bool success = QFile::rename(d->fi.absoluteFilePath(), name.d->fi.absoluteFilePath());
 253         if (!success)
 254                 LYXERR0("Could not rename file " << *this << " to " << name);
 255         return success;
 256 }
 257
 258
 259 bool FileName::moveTo(FileName const & name) const
 260 {
 261         LYXERR(Debug::FILES, "Moving " << name << " to " << *this);
 262         QFile::remove(name.d->fi.absoluteFilePath());
 263
 264         bool success = QFile::rename(d->fi.absoluteFilePath(),
 265                 name.d->fi.absoluteFilePath());
 266         if (!success)
 267                 LYXERR0("Could not move file " << *this << " to " << name);
 268         return success;
 269 }
 270
 271
 272 bool FileName::changePermission(unsigned long int mode) const
 273 {
 274 #if defined (HAVE_CHMOD) && defined (HAVE_MODE_T)
 275         if (::chmod(toFilesystemEncoding().c_str(), mode_t(mode)) != 0) {
 276                 LYXERR0("File " << *this << ": cannot change permission to "
 277                         << mode << ".");
 278                 return false;
 279         }
 280 #endif
 281         return true;
 282 }
 283
 284
 285 string FileName::toFilesystemEncoding() const
 286 {
 287         // This doesn't work on Windows for non ascii file names.
 288         QByteArray const encoded = QFile::encodeName(d->fi.absoluteFilePath());
 289         return string(encoded.begin(), encoded.end());
 290 }
 291
 292
 293 string FileName::toSafeFilesystemEncoding(os::file_access how) const
 294 {
 295         // This will work on Windows for non ascii file names.
 296         QString const safe_path =
 297                 toqstr(os::safe_internal_path(absFileName(), how));
 298         QByteArray const encoded = QFile::encodeName(safe_path);
 299         return string(encoded.begin(), encoded.end());
 300 }
 301
 302
 303 FileName FileName::fromFilesystemEncoding(string const & name)
 304 {
 305         QByteArray const encoded(name.c_str(), name.length());
 306         return FileName(fromqstr(QFile::decodeName(encoded)));
 307 }
 308
 309
 310 bool FileName::exists() const
 311 {
 312         return !empty() && d->fi.exists();
 313 }
 314
 315
 316 bool FileName::isSymLink() const
 317 {
 318         return !empty() && d->fi.isSymLink();
 319 }
 320
 321
 322 bool FileName::isFileEmpty() const
 323 {
 324         LASSERT(!empty(), return true);
 325         return d->fi.size() == 0;
 326 }
 327
 328
 329 bool FileName::isDirectory() const
 330 {
 331         return !empty() && d->fi.isDir();
 332 }
 333
 334
 335 bool FileName::isReadOnly() const
 336 {
 337         LASSERT(!empty(), return true);
 338         return d->fi.isReadable() && !d->fi.isWritable();
 339 }
 340
 341
 342 bool FileName::isReadableDirectory() const
 343 {
 344         return isDirectory() && d->fi.isReadable();
 345 }
 346
 347
 348 string FileName::onlyFileName() const
 349 {
 350         return fromqstr(d->fi.fileName());
 351 }
 352
 353
 354 string FileName::onlyFileNameWithoutExt() const
 355 {
 356         return fromqstr(d->fi.completeBaseName());
 357 }
 358
 359
 360 string FileName::extension() const
 361 {
 362         return fromqstr(d->fi.suffix());
 363 }
 364
 365
 366 bool FileName::hasExtension(const string & ext)
 367 {
 368         return Private::isFilesystemEqual(d->fi.suffix(), toqstr(ext));
 369 }
 370
 371
 372 FileName FileName::onlyPath() const
 373 {
 374         FileName path;
 375         if (empty())
 376                 return path;
 377         path.d->fi.setFile(d->fi.path());
 378         path.d->name = fromqstr(path.d->fi.absoluteFilePath());
 379         return path;
 380 }
 381
 382
 383 FileName FileName::parentPath() const
 384 {
 385         FileName path;
 386         // return empty path for parent of root dir
 387         // parent of empty path is empty too
 388         if (empty() || d->fi.isRoot())
 389                 return path;
 390         path.d->fi.setFile(d->fi.path());
 391         path.d->name = fromqstr(path.d->fi.absoluteFilePath());
 392         return path;
 393 }
 394
 395
 396 bool FileName::isReadableFile() const
 397 {
 398         return !empty() && d->fi.isFile() && d->fi.isReadable();
 399 }
 400
 401
 402 bool FileName::isWritable() const
 403 {
 404         return !empty() && d->fi.isWritable();
 405 }
 406
 407
 408 bool FileName::isDirWritable() const
 409 {
 410         LASSERT(isDirectory(), return false);
 411         QFileInfo tmp(QDir(d->fi.absoluteFilePath()), "lyxwritetest");
 412         QTemporaryFile qt_tmp(tmp.absoluteFilePath());
 413         if (qt_tmp.open()) {
 414                 LYXERR(Debug::FILES, "Directory " << *this << " is writable");
 415                 return true;
 416         }
 417         LYXERR(Debug::FILES, "Directory " << *this << " is not writable");
 418         return false;
 419 }
 420
 421
 422 FileNameList FileName::dirList(string const & ext) const
 423 {
 424         FileNameList dirlist;
 425         if (!isDirectory()) {
 426                 LYXERR0("Directory '" << *this << "' does not exist!");
 427                 return dirlist;
 428         }
 429
 430         // If the directory is specified without a trailing '/', absoluteDir()
 431         // would return the parent dir, so we must use absoluteFilePath() here.
 432         QDir dir = d->fi.absoluteFilePath();
 433
 434         if (!ext.empty()) {
 435                 QString filter;
 436                 switch (ext[0]) {
 437                 case '.': filter = "*" + toqstr(ext); break;
 438                 case '*': filter = toqstr(ext); break;
 439                 default: filter = "*." + toqstr(ext);
 440                 }
 441                 dir.setNameFilters(QStringList(filter));
 442                 LYXERR(Debug::FILES, "filtering on extension "
 443                         << fromqstr(filter) << " is requested.");
 444         }
 445
 446         QFileInfoList list = dir.entryInfoList();
 447         for (int i = 0; i != list.size(); ++i) {
 448                 FileName fi(fromqstr(list.at(i).absoluteFilePath()));
 449                 dirlist.push_back(fi);
 450                 LYXERR(Debug::FILES, "found file " << fi);
 451         }
 452
 453         return dirlist;
 454 }
 455
 456
 457 FileName FileName::getcwd()
 458 {
 459         // return makeAbsPath("."); would create an infinite loop
 460         QFileInfo fi(".");
 461         return FileName(fromqstr(fi.absoluteFilePath()));
 462 }
 463
 464
 465 FileName FileName::tempPath()
 466 {
 467         return FileName(os::internal_path(fromqstr(QDir::tempPath())));
 468 }
 469
 470
 471 void FileName::refresh() const
 472 {
 473         d->refresh();
 474 }
 475
 476
 477 time_t FileName::lastModified() const
 478 {
 479         // QFileInfo caches information about the file. So, in case this file has
 480         // been touched between the object creation and now, we refresh the file
 481         // information.
 482         d->refresh();
 483         return d->fi.lastModified().toTime_t();
 484 }
 485
 486
 487 bool FileName::chdir() const
 488 {
 489         return QDir::setCurrent(d->fi.absoluteFilePath());
 490 }
 491
 492
 493 unsigned long checksum_ifstream_fallback(char const * file)
 494 {
 495         unsigned long result = 0;
 496         //LYXERR(Debug::FILES, "lyx::sum() using istreambuf_iterator (fast)");
 497         ifstream ifs(file, ios_base::in | ios_base::binary);
 498         if (!ifs)
 499                 return result;
 500
 501         istreambuf_iterator<char> beg(ifs);
 502         istreambuf_iterator<char> end;
 503         boost::crc_32_type crc;
 504         crc = for_each(beg, end, crc);
 505         result = crc.checksum();
 506         return result;
 507 }
 508
 509 unsigned long FileName::checksum() const
 510 {
 511         unsigned long result = 0;
 512
 513         if (!exists()) {
 514                 //LYXERR0("File \"" << absFileName() << "\" does not exist!");
 515                 return result;
 516         }
 517         // a directory may be passed here so we need to test it. (bug 3622)
 518         if (isDirectory()) {
 519                 LYXERR0('"' << absFileName() << "\" is a directory!");
 520                 return result;
 521         }
 522
 523         // This is used in the debug output at the end of the method.
 524         static QTime t;
 525         if (lyxerr.debugging(Debug::FILES))
 526                 t.restart();
 527
 528 #if QT_VERSION >= 0x999999
 529         // First version of checksum uses Qt4.4 mmap support.
 530         // FIXME: This code is not ready with Qt4.4.2,
 531         // see http://www.lyx.org/trac/ticket/5293
 532         // FIXME: should we check if the MapExtension extension is supported?
 533         // see QAbstractFileEngine::supportsExtension() and
 534         // QAbstractFileEngine::MapExtension)
 535         QFile qf(fi.filePath());
 536         if (!qf.open(QIODevice::ReadOnly))
 537                 return result;
 538         qint64 size = fi.size();
 539         uchar * ubeg = qf.map(0, size);
 540         uchar * uend = ubeg + size;
 541         boost::crc_32_type ucrc;
 542         ucrc.process_block(ubeg, uend);
 543         qf.unmap(ubeg);
 544         qf.close();
 545         result = ucrc.checksum();
 546
 547 #else // QT_VERSION
 548
 549         string const encoded = toSafeFilesystemEncoding();
 550         char const * file = encoded.c_str();
 551
 552  #ifdef SUM_WITH_MMAP
 553         //LYXERR(Debug::FILES, "using mmap (lightning fast)");
 554
 555         int fd = open(file, O_RDONLY);
 556         if (!fd)
 557                 return result;
 558
 559         struct stat info;
 560         if (fstat(fd, &info)){
 561                 // fstat fails on samba shares (bug 5891)
 562                 close(fd);
 563                 return checksum_ifstream_fallback(file);
 564         }
 565
 566         void * mm = mmap(0, info.st_size, PROT_READ,
 567                          MAP_PRIVATE, fd, 0);
 568         // Some platforms have the wrong type for MAP_FAILED (compaq cxx).
 569         if (mm == reinterpret_cast<void*>(MAP_FAILED)) {
 570                 close(fd);
 571                 return result;
 572         }
 573
 574         char * beg = static_cast<char*>(mm);
 575         char * end = beg + info.st_size;
 576
 577         boost::crc_32_type crc;
 578         crc.process_block(beg, end);
 579         result = crc.checksum();
 580
 581         munmap(mm, info.st_size);
 582         close(fd);
 583
 584  #else // no SUM_WITH_MMAP
 585         result = checksum_ifstream_fallback(file);
 586  #endif // SUM_WITH_MMAP
 587 #endif // QT_VERSION
 588
 589         LYXERR(Debug::FILES, "Checksumming \"" << absFileName() << "\" "
 590                 << result << " lasted " << t.elapsed() << " ms.");
 591         return result;
 592 }
 593
 594
 595 bool FileName::removeFile() const
 596 {
 597         bool const success = QFile::remove(d->fi.absoluteFilePath());
 598         d->refresh();
 599         if (!success && exists())
 600                 LYXERR0("Could not delete file " << *this);
 601         return success;
 602 }
 603
 604
 605 static bool rmdir(QFileInfo const & fi)
 606 {
 607         QDir dir(fi.absoluteFilePath());
 608         QFileInfoList list = dir.entryInfoList();
 609         bool success = true;
 610         for (int i = 0; i != list.size(); ++i) {
 611                 if (list.at(i).fileName() == ".")
 612                         continue;
 613                 if (list.at(i).fileName() == "..")
 614                         continue;
 615                 bool removed;
 616                 if (list.at(i).isDir()) {
 617                         LYXERR(Debug::FILES, "Removing dir "
 618                                 << fromqstr(list.at(i).absoluteFilePath()));
 619                         removed = rmdir(list.at(i));
 620                 }
 621                 else {
 622                         LYXERR(Debug::FILES, "Removing file "
 623                                 << fromqstr(list.at(i).absoluteFilePath()));
 624                         removed = dir.remove(list.at(i).fileName());
 625                 }
 626                 if (!removed) {
 627                         success = false;
 628                         LYXERR0("Could not delete "
 629                                 << fromqstr(list.at(i).absoluteFilePath()));
 630                 }
 631         }
 632         QDir parent = fi.absolutePath();
 633         success &= parent.rmdir(fi.fileName());
 634         return success;
 635 }
 636
 637
 638 bool FileName::destroyDirectory() const
 639 {
 640         bool const success = rmdir(d->fi);
 641         if (!success)
 642                 LYXERR0("Could not delete " << *this);
 643
 644         return success;
 645 }
 646
 647
 648 // Only used in non Win32 platforms
 649 static int mymkdir(char const * pathname, unsigned long int mode)
 650 {
 651         // FIXME: why don't we have mode_t in lyx::mkdir prototype ??
 652 #if HAVE_MKDIR
 653 # if MKDIR_TAKES_ONE_ARG
 654         // MinGW32
 655         return ::mkdir(pathname);
 656         // FIXME: "Permissions of created directories are ignored on this system."
 657 # else
 658         // POSIX
 659         return ::mkdir(pathname, mode_t(mode));
 660 # endif
 661 #elif defined(_WIN32)
 662         // plain Windows 32
 663         return CreateDirectory(pathname, 0) != 0 ? 0 : -1;
 664         // FIXME: "Permissions of created directories are ignored on this system."
 665 #elif HAVE__MKDIR
 666         return ::_mkdir(pathname);
 667         // FIXME: "Permissions of created directories are ignored on this system."
 668 #else
 669 #   error "Don't know how to create a directory on this system."
 670 #endif
 671
 672 }
 673
 674
 675 bool FileName::createDirectory(int permission) const
 676 {
 677         LASSERT(!empty(), return false);
 678 #ifdef Q_OS_WIN32
 679         // FIXME: "Permissions of created directories are ignored on this system."
 680         return createPath();
 681 #else
 682         return mymkdir(toFilesystemEncoding().c_str(), permission) == 0;
 683 #endif
 684 }
 685
 686
 687 bool FileName::createPath() const
 688 {
 689         LASSERT(!empty(), return false);
 690         LYXERR(Debug::FILES, "creating path '" << *this << "'.");
 691         if (isDirectory())
 692                 return false;
 693
 694         QDir dir;
 695         bool success = dir.mkpath(d->fi.absoluteFilePath());
 696         if (!success)
 697                 LYXERR0("Cannot create path '" << *this << "'!");
 698         return success;
 699 }
 700
 701
 702 docstring const FileName::absoluteFilePath() const
 703 {
 704         return qstring_to_ucs4(d->fi.absoluteFilePath());
 705 }
 706
 707
 708 docstring FileName::displayName(int threshold) const
 709 {
 710         return makeDisplayPath(absFileName(), threshold);
 711 }
 712
 713
 714 docstring FileName::fileContents(string const & encoding) const
 715 {
 716         if (!isReadableFile()) {
 717                 LYXERR0("File '" << *this << "' is not readable!");
 718                 return docstring();
 719         }
 720
 721         QFile file(d->fi.absoluteFilePath());
 722         if (!file.open(QIODevice::ReadOnly)) {
 723                 LYXERR0("File '" << *this
 724                         << "' could not be opened in read only mode!");
 725                 return docstring();
 726         }
 727         QByteArray contents = file.readAll();
 728         file.close();
 729
 730         if (contents.isEmpty()) {
 731                 LYXERR(Debug::FILES, "File '" << *this
 732                         << "' is either empty or some error happened while reading it.");
 733                 return docstring();
 734         }
 735
 736         QString s;
 737         if (encoding.empty() || encoding == "UTF-8")
 738                 s = QString::fromUtf8(contents.data());
 739         else if (encoding == "ascii")
 740 #if (QT_VERSION < 0x050000)
 741                 s = QString::fromAscii(contents.data());
 742 #else
 743                 s = QString::fromLatin1(contents.data());
 744 #endif
 745         else if (encoding == "local8bit")
 746                 s = QString::fromLocal8Bit(contents.data());
 747         else if (encoding == "latin1")
 748                 s = QString::fromLatin1(contents.data());
 749
 750         return qstring_to_ucs4(s);
 751 }
 752
 753
 754 void FileName::changeExtension(string const & extension)
 755 {
 756         // FIXME: use Qt native methods...
 757         string const oldname = absFileName();
 758         string::size_type const last_slash = oldname.rfind('/');
 759         string::size_type last_dot = oldname.rfind('.');
 760         if (last_dot < last_slash && last_slash != string::npos)
 761                 last_dot = string::npos;
 762
 763         string ext;
 764         // Make sure the extension starts with a dot
 765         if (!extension.empty() && extension[0] != '.')
 766                 ext= '.' + extension;
 767         else
 768                 ext = extension;
 769
 770         set(oldname.substr(0, last_dot) + ext);
 771 }
 772
 773
 774 docstring const FileName::relPath(string const & path) const
 775 {
 776         // FIXME UNICODE
 777         return makeRelPath(absoluteFilePath(), from_utf8(path));
 778 }
 779
 780
 781 // Note: According to Qt, QFileInfo::operator== is undefined when
 782 // both files do not exist (Qt4.5 gives true for all non-existent
 783 // files, while Qt4.4 compares the filenames).
 784 // see:
 785 // http://www.qtsoftware.com/developer/task-tracker/
 786 //   index_html?id=248471&method=entry.
 787 bool equivalent(FileName const & l, FileName const & r)
 788 {
 789         // FIXME: In future use Qt.
 790         // Qt 4.4: We need to solve this warning from Qt documentation:
 791         // * Long and short file names that refer to the same file on Windows are
 792         //   treated as if they referred to different files.
 793         // This is supposed to be fixed for Qt5.
 794         FileName const lhs(os::internal_path(l.absFileName()));
 795         FileName const rhs(os::internal_path(r.absFileName()));
 796
 797         if (lhs.empty())
 798                 // QFileInfo::operator==() returns false if the two QFileInfo are empty.
 799                 return rhs.empty();
 800
 801         if (rhs.empty())
 802                 // Avoid unnecessary checks below.
 803                 return false;
 804
 805         lhs.d->refresh();
 806         rhs.d->refresh();
 807
 808         if (!lhs.d->fi.isSymLink() && !rhs.d->fi.isSymLink()) {
 809                 // Qt already checks if the filesystem is case sensitive or not.
 810                 // see note above why the extra check with fileName is needed.
 811                 return lhs.d->fi == rhs.d->fi
 812                         && lhs.d->fi.fileName() == rhs.d->fi.fileName();
 813         }
 814
 815         // FIXME: When/if QFileInfo support symlink comparison, remove this code.
 816         QFileInfo fi1(lhs.d->fi);
 817         if (fi1.isSymLink())
 818                 fi1 = QFileInfo(fi1.symLinkTarget());
 819         QFileInfo fi2(rhs.d->fi);
 820         if (fi2.isSymLink())
 821                 fi2 = QFileInfo(fi2.symLinkTarget());
 822         // see note above why the extra check with fileName is needed.
 823         return fi1 == fi2 && fi1.fileName() == fi2.fileName();
 824 }
 825
 826
 827 bool operator==(FileName const & lhs, FileName const & rhs)
 828 {
 829         return os::isFilesystemCaseSensitive()
 830                 ? lhs.absFileName() == rhs.absFileName()
 831                 : !QString::compare(toqstr(lhs.absFileName()),
 832                                 toqstr(rhs.absFileName()), Qt::CaseInsensitive);
 833 }
 834
 835
 836 bool operator!=(FileName const & lhs, FileName const & rhs)
 837 {
 838         return !(operator==(lhs, rhs));
 839 }
 840
 841
 842 bool operator<(FileName const & lhs, FileName const & rhs)
 843 {
 844         return lhs.absFileName() < rhs.absFileName();
 845 }
 846
 847
 848 bool operator>(FileName const & lhs, FileName const & rhs)
 849 {
 850         return lhs.absFileName() > rhs.absFileName();
 851 }
 852
 853
 854 ostream & operator<<(ostream & os, FileName const & filename)
 855 {
 856         return os << filename.absFileName();
 857 }
 858
 859
 860 /////////////////////////////////////////////////////////////////////
 861 //
 862 // DocFileName
 863 //
 864 /////////////////////////////////////////////////////////////////////
 865
 866
 867 DocFileName::DocFileName()
 868         : save_abs_path_(true)
 869 {}
 870
 871
 872 DocFileName::DocFileName(string const & abs_filename, bool save_abs)
 873         : FileName(abs_filename), save_abs_path_(save_abs)
 874 {}
 875
 876
 877 DocFileName::DocFileName(FileName const & abs_filename, bool save_abs)
 878         : FileName(abs_filename), save_abs_path_(save_abs)
 879 {}
 880
 881
 882 void DocFileName::set(string const & name, string const & buffer_path)
 883 {
 884         save_abs_path_ = isAbsolute(name);
 885         if (save_abs_path_)
 886                 FileName::set(name);
 887         else
 888                 FileName::set(makeAbsPath(name, buffer_path).absFileName());
 889 }
 890
 891
 892 void DocFileName::erase()
 893 {
 894         FileName::erase();
 895 }
 896
 897
 898 string DocFileName::relFileName(string const & path) const
 899 {
 900         // FIXME UNICODE
 901         return to_utf8(relPath(path));
 902 }
 903
 904
 905 string DocFileName::outputFileName(string const & path) const
 906 {
 907         return save_abs_path_ ? absFileName() : relFileName(path);
 908 }
 909
 910
 911 string DocFileName::mangledFileName(string const & dir) const
 912 {
 913         // Concurrent access to these variables is possible.
 914
 915         // We need to make sure that every DocFileName instance for a given
 916         // filename returns the same mangled name.
 917         typedef map<string, string> MangledMap;
 918         static MangledMap mangledNames;
 919         static Mutex mangledMutex;
 920         // this locks both access to mangledNames and counter below
 921         Mutex::Locker lock(&mangledMutex);
 922         MangledMap::const_iterator const it = mangledNames.find(absFileName());
 923         if (it != mangledNames.end())
 924                 return (*it).second;
 925
 926         string const name = absFileName();
 927         // Now the real work
 928         string mname = os::internal_path(name);
 929         // Remove the extension.
 930         mname = support::changeExtension(name, string());
 931         // The mangled name must be a valid LaTeX name.
 932         // The list of characters to keep is probably over-restrictive,
 933         // but it is not really a problem.
 934         // Apart from non-ASCII characters, at least the following characters
 935         // are forbidden: '/', '.', ' ', and ':'.
 936         // On windows it is not possible to create files with '<', '>' or '?'
 937         // in the name.
 938         static string const keep = "abcdefghijklmnopqrstuvwxyz"
 939                                    "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
 940                                    "+-0123456789;=";
 941         string::size_type pos = 0;
 942         while ((pos = mname.find_first_not_of(keep, pos)) != string::npos)
 943                 mname[pos++] = '_';
 944         // Add the extension back on
 945         mname = support::changeExtension(mname, getExtension(name));
 946
 947         // Prepend a counter to the filename. This is necessary to make
 948         // the mangled name unique.
 949         static int counter = 0;
 950         ostringstream s;
 951         s << counter++ << mname;
 952         mname = s.str();
 953
 954         // MiKTeX's YAP (version 2.4.1803) crashes if the file name
 955         // is longer than about 160 characters. MiKTeX's pdflatex
 956         // is even pickier. A maximum length of 100 has been proven to work.
 957         // If dir.size() > max length, all bets are off for YAP. We truncate
 958         // the filename nevertheless, keeping a minimum of 10 chars.
 959
 960         string::size_type max_length = max(100 - ((int)dir.size() + 1), 10);
 961
 962         // If the mangled file name is too long, hack it to fit.
 963         // We know we're guaranteed to have a unique file name because
 964         // of the counter.
 965         if (mname.size() > max_length) {
 966                 int const half = (int(max_length) / 2) - 2;
 967                 if (half > 0) {
 968                         mname = mname.substr(0, half) + "___" +
 969                                 mname.substr(mname.size() - half);
 970                 }
 971         }
 972
 973         mangledNames[absFileName()] = mname;
 974         return mname;
 975 }
 976
 977
 978 string DocFileName::unzippedFileName() const
 979 {
 980         return support::unzippedFileName(absFileName());
 981 }
 982
 983
 984 bool operator==(DocFileName const & lhs, DocFileName const & rhs)
 985 {
 986         return static_cast<FileName const &>(lhs)
 987                 == static_cast<FileName const &>(rhs)
 988                 && lhs.saveAbsPath() == rhs.saveAbsPath();
 989 }
 990
 991
 992 bool operator!=(DocFileName const & lhs, DocFileName const & rhs)
 993 {
 994         return !(lhs == rhs);
 995 }
 996
 997 } // namespace support
 998 } // namespace lyx