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