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 bool FileName::link(FileName const & name) const
 494 {
 495         return QFile::link(toqstr(absFileName()), toqstr(name.absFileName()));
 496 }
 497
 498
 499 unsigned long checksum_ifstream_fallback(char const * file)
 500 {
 501         unsigned long result = 0;
 502         //LYXERR(Debug::FILES, "lyx::sum() using istreambuf_iterator (fast)");
 503         ifstream ifs(file, ios_base::in | ios_base::binary);
 504         if (!ifs)
 505                 return result;
 506
 507         istreambuf_iterator<char> beg(ifs);
 508         istreambuf_iterator<char> end;
 509         boost::crc_32_type crc;
 510         crc = for_each(beg, end, crc);
 511         result = crc.checksum();
 512         return result;
 513 }
 514
 515 unsigned long FileName::checksum() const
 516 {
 517         unsigned long result = 0;
 518
 519         if (!exists()) {
 520                 //LYXERR0("File \"" << absFileName() << "\" does not exist!");
 521                 return result;
 522         }
 523         // a directory may be passed here so we need to test it. (bug 3622)
 524         if (isDirectory()) {
 525                 LYXERR0('"' << absFileName() << "\" is a directory!");
 526                 return result;
 527         }
 528
 529         // This is used in the debug output at the end of the method.
 530         static QTime t;
 531         if (lyxerr.debugging(Debug::FILES))
 532                 t.restart();
 533
 534 #if QT_VERSION >= 0x999999
 535         // First version of checksum uses Qt4.4 mmap support.
 536         // FIXME: This code is not ready with Qt4.4.2,
 537         // see http://www.lyx.org/trac/ticket/5293
 538         // FIXME: should we check if the MapExtension extension is supported?
 539         // see QAbstractFileEngine::supportsExtension() and
 540         // QAbstractFileEngine::MapExtension)
 541         QFile qf(fi.filePath());
 542         if (!qf.open(QIODevice::ReadOnly))
 543                 return result;
 544         qint64 size = fi.size();
 545         uchar * ubeg = qf.map(0, size);
 546         uchar * uend = ubeg + size;
 547         boost::crc_32_type ucrc;
 548         ucrc.process_block(ubeg, uend);
 549         qf.unmap(ubeg);
 550         qf.close();
 551         result = ucrc.checksum();
 552
 553 #else // QT_VERSION
 554
 555         string const encoded = toSafeFilesystemEncoding();
 556         char const * file = encoded.c_str();
 557
 558  #ifdef SUM_WITH_MMAP
 559         //LYXERR(Debug::FILES, "using mmap (lightning fast)");
 560
 561         int fd = open(file, O_RDONLY);
 562         if (!fd)
 563                 return result;
 564
 565         struct stat info;
 566         if (fstat(fd, &info)){
 567                 // fstat fails on samba shares (bug 5891)
 568                 close(fd);
 569                 return checksum_ifstream_fallback(file);
 570         }
 571
 572         void * mm = mmap(0, info.st_size, PROT_READ,
 573                          MAP_PRIVATE, fd, 0);
 574         // Some platforms have the wrong type for MAP_FAILED (compaq cxx).
 575         if (mm == reinterpret_cast<void*>(MAP_FAILED)) {
 576                 close(fd);
 577                 return result;
 578         }
 579
 580         char * beg = static_cast<char*>(mm);
 581         char * end = beg + info.st_size;
 582
 583         boost::crc_32_type crc;
 584         crc.process_block(beg, end);
 585         result = crc.checksum();
 586
 587         munmap(mm, info.st_size);
 588         close(fd);
 589
 590  #else // no SUM_WITH_MMAP
 591         result = checksum_ifstream_fallback(file);
 592  #endif // SUM_WITH_MMAP
 593 #endif // QT_VERSION
 594
 595         LYXERR(Debug::FILES, "Checksumming \"" << absFileName() << "\" "
 596                 << result << " lasted " << t.elapsed() << " ms.");
 597         return result;
 598 }
 599
 600
 601 bool FileName::removeFile() const
 602 {
 603         bool const success = QFile::remove(d->fi.absoluteFilePath());
 604         d->refresh();
 605         if (!success && exists())
 606                 LYXERR0("Could not delete file " << *this);
 607         return success;
 608 }
 609
 610
 611 static bool rmdir(QFileInfo const & fi)
 612 {
 613         QDir dir(fi.absoluteFilePath());
 614         QFileInfoList list = dir.entryInfoList();
 615         bool success = true;
 616         for (int i = 0; i != list.size(); ++i) {
 617                 if (list.at(i).fileName() == ".")
 618                         continue;
 619                 if (list.at(i).fileName() == "..")
 620                         continue;
 621                 bool removed;
 622                 if (list.at(i).isDir()) {
 623                         LYXERR(Debug::FILES, "Removing dir "
 624                                 << fromqstr(list.at(i).absoluteFilePath()));
 625                         removed = rmdir(list.at(i));
 626                 }
 627                 else {
 628                         LYXERR(Debug::FILES, "Removing file "
 629                                 << fromqstr(list.at(i).absoluteFilePath()));
 630                         removed = dir.remove(list.at(i).fileName());
 631                 }
 632                 if (!removed) {
 633                         success = false;
 634                         LYXERR0("Could not delete "
 635                                 << fromqstr(list.at(i).absoluteFilePath()));
 636                 }
 637         }
 638         QDir parent = fi.absolutePath();
 639         success &= parent.rmdir(fi.fileName());
 640         return success;
 641 }
 642
 643
 644 bool FileName::destroyDirectory() const
 645 {
 646         bool const success = rmdir(d->fi);
 647         if (!success)
 648                 LYXERR0("Could not delete " << *this);
 649
 650         return success;
 651 }
 652
 653
 654 // Only used in non Win32 platforms
 655 static int mymkdir(char const * pathname, unsigned long int mode)
 656 {
 657         // FIXME: why don't we have mode_t in lyx::mkdir prototype ??
 658 #if HAVE_MKDIR
 659 # if MKDIR_TAKES_ONE_ARG
 660         // MinGW32
 661         return ::mkdir(pathname);
 662         // FIXME: "Permissions of created directories are ignored on this system."
 663 # else
 664         // POSIX
 665         return ::mkdir(pathname, mode_t(mode));
 666 # endif
 667 #elif defined(_WIN32)
 668         // plain Windows 32
 669         return CreateDirectory(pathname, 0) != 0 ? 0 : -1;
 670         // FIXME: "Permissions of created directories are ignored on this system."
 671 #elif HAVE__MKDIR
 672         return ::_mkdir(pathname);
 673         // FIXME: "Permissions of created directories are ignored on this system."
 674 #else
 675 #   error "Don't know how to create a directory on this system."
 676 #endif
 677
 678 }
 679
 680
 681 bool FileName::createDirectory(int permission) const
 682 {
 683         LASSERT(!empty(), return false);
 684 #ifdef Q_OS_WIN32
 685         // FIXME: "Permissions of created directories are ignored on this system."
 686         return createPath();
 687 #else
 688         return mymkdir(toFilesystemEncoding().c_str(), permission) == 0;
 689 #endif
 690 }
 691
 692
 693 bool FileName::createPath() const
 694 {
 695         LASSERT(!empty(), return false);
 696         LYXERR(Debug::FILES, "creating path '" << *this << "'.");
 697         if (isDirectory())
 698                 return false;
 699
 700         QDir dir;
 701         bool success = dir.mkpath(d->fi.absoluteFilePath());
 702         if (!success)
 703                 LYXERR0("Cannot create path '" << *this << "'!");
 704         return success;
 705 }
 706
 707
 708 docstring const FileName::absoluteFilePath() const
 709 {
 710         return qstring_to_ucs4(d->fi.absoluteFilePath());
 711 }
 712
 713
 714 docstring FileName::displayName(int threshold) const
 715 {
 716         return makeDisplayPath(absFileName(), threshold);
 717 }
 718
 719
 720 docstring FileName::fileContents(string const & encoding) const
 721 {
 722         if (!isReadableFile()) {
 723                 LYXERR0("File '" << *this << "' is not readable!");
 724                 return docstring();
 725         }
 726
 727         QFile file(d->fi.absoluteFilePath());
 728         if (!file.open(QIODevice::ReadOnly)) {
 729                 LYXERR0("File '" << *this
 730                         << "' could not be opened in read only mode!");
 731                 return docstring();
 732         }
 733         QByteArray contents = file.readAll();
 734         file.close();
 735
 736         if (contents.isEmpty()) {
 737                 LYXERR(Debug::FILES, "File '" << *this
 738                         << "' is either empty or some error happened while reading it.");
 739                 return docstring();
 740         }
 741
 742         QString s;
 743         if (encoding.empty() || encoding == "UTF-8")
 744                 s = QString::fromUtf8(contents.data());
 745         else if (encoding == "ascii")
 746 #if (QT_VERSION < 0x050000)
 747                 s = QString::fromAscii(contents.data());
 748 #else
 749                 s = QString::fromLatin1(contents.data());
 750 #endif
 751         else if (encoding == "local8bit")
 752                 s = QString::fromLocal8Bit(contents.data());
 753         else if (encoding == "latin1")
 754                 s = QString::fromLatin1(contents.data());
 755
 756         return qstring_to_ucs4(s);
 757 }
 758
 759
 760 void FileName::changeExtension(string const & extension)
 761 {
 762         // FIXME: use Qt native methods...
 763         string const oldname = absFileName();
 764         string::size_type const last_slash = oldname.rfind('/');
 765         string::size_type last_dot = oldname.rfind('.');
 766         if (last_dot < last_slash && last_slash != string::npos)
 767                 last_dot = string::npos;
 768
 769         string ext;
 770         // Make sure the extension starts with a dot
 771         if (!extension.empty() && extension[0] != '.')
 772                 ext= '.' + extension;
 773         else
 774                 ext = extension;
 775
 776         set(oldname.substr(0, last_dot) + ext);
 777 }
 778
 779
 780 docstring const FileName::relPath(string const & path) const
 781 {
 782         // FIXME UNICODE
 783         return makeRelPath(absoluteFilePath(), from_utf8(path));
 784 }
 785
 786
 787 // Note: According to Qt, QFileInfo::operator== is undefined when
 788 // both files do not exist (Qt4.5 gives true for all non-existent
 789 // files, while Qt4.4 compares the filenames).
 790 // see:
 791 // http://www.qtsoftware.com/developer/task-tracker/
 792 //   index_html?id=248471&method=entry.
 793 bool equivalent(FileName const & l, FileName const & r)
 794 {
 795         // FIXME: In future use Qt.
 796         // Qt 4.4: We need to solve this warning from Qt documentation:
 797         // * Long and short file names that refer to the same file on Windows are
 798         //   treated as if they referred to different files.
 799         // This is supposed to be fixed for Qt5.
 800         FileName const lhs(os::internal_path(l.absFileName()));
 801         FileName const rhs(os::internal_path(r.absFileName()));
 802
 803         if (lhs.empty())
 804                 // QFileInfo::operator==() returns false if the two QFileInfo are empty.
 805                 return rhs.empty();
 806
 807         if (rhs.empty())
 808                 // Avoid unnecessary checks below.
 809                 return false;
 810
 811         lhs.d->refresh();
 812         rhs.d->refresh();
 813
 814         if (!lhs.d->fi.isSymLink() && !rhs.d->fi.isSymLink()) {
 815                 // Qt already checks if the filesystem is case sensitive or not.
 816                 // see note above why the extra check with fileName is needed.
 817                 return lhs.d->fi == rhs.d->fi
 818                         && lhs.d->fi.fileName() == rhs.d->fi.fileName();
 819         }
 820
 821         // FIXME: When/if QFileInfo support symlink comparison, remove this code.
 822         QFileInfo fi1(lhs.d->fi);
 823         if (fi1.isSymLink())
 824                 fi1 = QFileInfo(fi1.symLinkTarget());
 825         QFileInfo fi2(rhs.d->fi);
 826         if (fi2.isSymLink())
 827                 fi2 = QFileInfo(fi2.symLinkTarget());
 828         // see note above why the extra check with fileName is needed.
 829         return fi1 == fi2 && fi1.fileName() == fi2.fileName();
 830 }
 831
 832
 833 bool operator==(FileName const & lhs, FileName const & rhs)
 834 {
 835         return os::isFilesystemCaseSensitive()
 836                 ? lhs.absFileName() == rhs.absFileName()
 837                 : !QString::compare(toqstr(lhs.absFileName()),
 838                                 toqstr(rhs.absFileName()), Qt::CaseInsensitive);
 839 }
 840
 841
 842 bool operator!=(FileName const & lhs, FileName const & rhs)
 843 {
 844         return !(operator==(lhs, rhs));
 845 }
 846
 847
 848 bool operator<(FileName const & lhs, FileName const & rhs)
 849 {
 850         return lhs.absFileName() < rhs.absFileName();
 851 }
 852
 853
 854 bool operator>(FileName const & lhs, FileName const & rhs)
 855 {
 856         return lhs.absFileName() > rhs.absFileName();
 857 }
 858
 859
 860 ostream & operator<<(ostream & os, FileName const & filename)
 861 {
 862         return os << filename.absFileName();
 863 }
 864
 865
 866 /////////////////////////////////////////////////////////////////////
 867 //
 868 // DocFileName
 869 //
 870 /////////////////////////////////////////////////////////////////////
 871
 872
 873 DocFileName::DocFileName()
 874         : save_abs_path_(true)
 875 {}
 876
 877
 878 DocFileName::DocFileName(string const & abs_filename, bool save_abs)
 879         : FileName(abs_filename), save_abs_path_(save_abs)
 880 {}
 881
 882
 883 DocFileName::DocFileName(FileName const & abs_filename, bool save_abs)
 884         : FileName(abs_filename), save_abs_path_(save_abs)
 885 {}
 886
 887
 888 void DocFileName::set(string const & name, string const & buffer_path)
 889 {
 890         save_abs_path_ = isAbsolute(name);
 891         if (save_abs_path_)
 892                 FileName::set(name);
 893         else
 894                 FileName::set(makeAbsPath(name, buffer_path).absFileName());
 895 }
 896
 897
 898 void DocFileName::erase()
 899 {
 900         FileName::erase();
 901 }
 902
 903
 904 string DocFileName::relFileName(string const & path) const
 905 {
 906         // FIXME UNICODE
 907         return to_utf8(relPath(path));
 908 }
 909
 910
 911 string DocFileName::outputFileName(string const & path) const
 912 {
 913         return save_abs_path_ ? absFileName() : relFileName(path);
 914 }
 915
 916
 917 string DocFileName::mangledFileName(string const & dir) const
 918 {
 919         // Concurrent access to these variables is possible.
 920
 921         // We need to make sure that every DocFileName instance for a given
 922         // filename returns the same mangled name.
 923         typedef map<string, string> MangledMap;
 924         static MangledMap mangledNames;
 925         static Mutex mangledMutex;
 926         // this locks both access to mangledNames and counter below
 927         Mutex::Locker lock(&mangledMutex);
 928         MangledMap::const_iterator const it = mangledNames.find(absFileName());
 929         if (it != mangledNames.end())
 930                 return (*it).second;
 931
 932         string const name = absFileName();
 933         // Now the real work
 934         string mname = os::internal_path(name);
 935         // Remove the extension.
 936         mname = support::changeExtension(name, string());
 937         // The mangled name must be a valid LaTeX name.
 938         // The list of characters to keep is probably over-restrictive,
 939         // but it is not really a problem.
 940         // Apart from non-ASCII characters, at least the following characters
 941         // are forbidden: '/', '.', ' ', and ':'.
 942         // On windows it is not possible to create files with '<', '>' or '?'
 943         // in the name.
 944         static string const keep = "abcdefghijklmnopqrstuvwxyz"
 945                                    "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
 946                                    "+-0123456789;=";
 947         string::size_type pos = 0;
 948         while ((pos = mname.find_first_not_of(keep, pos)) != string::npos)
 949                 mname[pos++] = '_';
 950         // Add the extension back on
 951         mname = support::changeExtension(mname, getExtension(name));
 952
 953         // Prepend a counter to the filename. This is necessary to make
 954         // the mangled name unique.
 955         static int counter = 0;
 956         ostringstream s;
 957         s << counter++ << mname;
 958         mname = s.str();
 959
 960         // MiKTeX's YAP (version 2.4.1803) crashes if the file name
 961         // is longer than about 160 characters. MiKTeX's pdflatex
 962         // is even pickier. A maximum length of 100 has been proven to work.
 963         // If dir.size() > max length, all bets are off for YAP. We truncate
 964         // the filename nevertheless, keeping a minimum of 10 chars.
 965
 966         string::size_type max_length = max(100 - ((int)dir.size() + 1), 10);
 967
 968         // If the mangled file name is too long, hack it to fit.
 969         // We know we're guaranteed to have a unique file name because
 970         // of the counter.
 971         if (mname.size() > max_length) {
 972                 int const half = (int(max_length) / 2) - 2;
 973                 if (half > 0) {
 974                         mname = mname.substr(0, half) + "___" +
 975                                 mname.substr(mname.size() - half);
 976                 }
 977         }
 978
 979         mangledNames[absFileName()] = mname;
 980         return mname;
 981 }
 982
 983
 984 string DocFileName::unzippedFileName() const
 985 {
 986         return support::unzippedFileName(absFileName());
 987 }
 988
 989
 990 bool operator==(DocFileName const & lhs, DocFileName const & rhs)
 991 {
 992         return static_cast<FileName const &>(lhs)
 993                 == static_cast<FileName const &>(rhs)
 994                 && lhs.saveAbsPath() == rhs.saveAbsPath();
 995 }
 996
 997
 998 bool operator!=(DocFileName const & lhs, DocFileName const & rhs)
 999 {
1000         return !(lhs == rhs);
1001 }
1002
1003 } // namespace support
1004 } // namespace lyx