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