3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Angus Leeming
8 * Full author contact details are available in file CREDITS.
13 #include "support/FileName.h"
14 #include "support/FileNameList.h"
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"
30 #include <QTemporaryFile>
31 #include <QElapsedTimer>
37 #include "support/checksum.h"
46 #ifdef HAVE_SYS_TYPES_H
47 # include <sys/types.h>
49 #ifdef HAVE_SYS_STAT_H
50 # include <sys/stat.h>
65 // Three implementations of checksum(), depending on having mmap support or not.
66 #if defined(HAVE_MMAP) && defined(HAVE_MUNMAP)
69 #endif // SUM_WITH_MMAP
72 using namespace lyx::support;
77 /////////////////////////////////////////////////////////////////////
81 /////////////////////////////////////////////////////////////////////
83 struct FileName::Private
87 explicit Private(string const & abs_filename)
88 : fi(toqstr(handleTildeName(abs_filename)))
90 name = fromqstr(fi.absoluteFilePath());
91 fi.setCaching(fi.exists());
100 bool isFilesystemEqual(QString const & lhs, QString const & rhs)
102 return QString::compare(lhs, rhs, os::isFilesystemCaseSensitive() ?
103 Qt::CaseSensitive : Qt::CaseInsensitive) == 0;
107 string const handleTildeName(string const & name)
111 resname = Package::get_home_dir().absFileName();
112 else if ( prefixIs(name, "~/"))
113 resname = Package::get_home_dir().absFileName() + name.substr(1);
114 else if ( prefixIs(name, "~:s/"))
115 resname = package().system_support().absFileName() + name.substr(3);
121 /// The absolute file name in UTF-8 encoding.
127 /////////////////////////////////////////////////////////////////////
131 /////////////////////////////////////////////////////////////////////
134 FileName::FileName() : d(new Private)
139 FileName::FileName(string const & abs_filename)
140 : d(abs_filename.empty() ? new Private : new Private(abs_filename))
142 //LYXERR(Debug::FILES, "FileName(" << abs_filename << ')');
143 LATTEST(empty() || isAbsolute(d->name));
147 FileName::~FileName()
153 FileName::FileName(FileName const & rhs) : d(new Private)
155 d->name = rhs.d->name;
160 FileName::FileName(FileName const & rhs, string const & suffix) : d(new Private)
166 FileName & FileName::operator=(FileName const & rhs)
170 d->name = rhs.d->name;
176 bool FileName::empty() const
178 return d->name.empty();
182 bool FileName::isAbsolute(string const & name)
184 QFileInfo fi(toqstr(Private::handleTildeName(name)));
185 return fi.isAbsolute();
189 string FileName::absFileName() const
195 string FileName::realPath() const
197 return os::real_path(absFileName());
201 void FileName::set(string const & name)
203 d->fi.setFile(toqstr(Private::handleTildeName(name)));
204 d->name = fromqstr(d->fi.absoluteFilePath());
205 //LYXERR(Debug::FILES, "FileName::set(" << name << ')');
206 LATTEST(empty() || isAbsolute(d->name));
210 void FileName::set(FileName const & rhs, string const & suffix)
212 if (!rhs.d->fi.isDir())
213 d->fi.setFile(rhs.d->fi.filePath() + toqstr(suffix));
215 d->fi.setFile(QDir(rhs.d->fi.absoluteFilePath()), toqstr(suffix));
216 d->name = fromqstr(d->fi.absoluteFilePath());
217 //LYXERR(Debug::FILES, "FileName::set(" << d->name << ')');
218 LATTEST(empty() || isAbsolute(d->name));
222 void FileName::erase()
229 bool FileName::copyTo(FileName const & name, bool keepsymlink) const
232 return copyTo(name, keepsymlink, visited);
236 bool FileName::copyTo(FileName const & name, bool keepsymlink,
237 FileName::FileNameSet & visited) const
239 LYXERR(Debug::FILES, "Copying " << name << " keep symlink: " << keepsymlink);
240 if (keepsymlink && name.isSymLink()) {
241 visited.insert(*this);
242 FileName const target(fromqstr(name.d->fi.symLinkTarget()));
243 if (visited.find(target) != visited.end()) {
244 LYXERR(Debug::FILES, "Found circular symlink: " << target);
247 return copyTo(target, true);
249 QFile::remove(name.d->fi.absoluteFilePath());
250 bool success = QFile::copy(d->fi.absoluteFilePath(), name.d->fi.absoluteFilePath());
252 LYXERR0("FileName::copyTo(): Could not copy file "
253 << *this << " to " << name);
258 bool FileName::renameTo(FileName const & name) const
260 LYXERR(Debug::FILES, "Renaming " << name << " as " << *this);
261 bool success = QFile::rename(d->fi.absoluteFilePath(), name.d->fi.absoluteFilePath());
264 LYXERR0("Could not rename file " << *this << " to " << name);
269 bool FileName::moveTo(FileName const & name) const
271 LYXERR(Debug::FILES, "Moving " << *this << " to " << name);
273 // there's a locking problem on Windows sometimes, so
274 // we will keep trying for five seconds, in the hope
278 bool removed = name.removeFile();
280 while (!removed && tries < 6) {
282 removed = name.removeFile();
287 QFile::remove(name.d->fi.absoluteFilePath());
290 bool const success = renameTo(name);
292 LYXERR0("Could not move file " << *this << " to " << name);
297 bool FileName::changePermission(unsigned long int mode) const
299 #if defined (HAVE_CHMOD) && defined (HAVE_MODE_T)
300 if (::chmod(toFilesystemEncoding().c_str(), mode_t(mode)) != 0) {
301 LYXERR0("File " << *this << ": cannot change permission to "
312 bool FileName::clonePermissions(FileName const & source)
314 QFile fin(toqstr(source.absFileName()));
315 QFile f(toqstr(absFileName()));
317 return f.setPermissions(fin.permissions());
320 string FileName::toFilesystemEncoding() const
322 // This doesn't work on Windows for non ascii file names.
323 QByteArray const encoded = QFile::encodeName(d->fi.absoluteFilePath());
324 return string(encoded.begin(), encoded.end());
328 string FileName::toSafeFilesystemEncoding(os::file_access how) const
330 // This will work on Windows for non ascii file names.
331 QString const safe_path =
332 toqstr(os::safe_internal_path(absFileName(), how));
333 QByteArray const encoded = QFile::encodeName(safe_path);
334 return string(encoded.begin(), encoded.end());
338 FileName FileName::fromFilesystemEncoding(string const & name)
340 QByteArray const encoded(name.c_str(), name.length());
341 return FileName(fromqstr(QFile::decodeName(encoded)));
345 bool FileName::exists() const
347 return !empty() && d->fi.exists();
351 bool FileName::isSymLink() const
353 return !empty() && d->fi.isSymLink();
357 //QFileInfo caching info might fool this test if file was changed meanwhile.
358 //refresh() helps, but we don't want to put it blindly here, because it might
359 //trigger slowdown on networked file systems.
360 bool FileName::isFileEmpty() const
362 LASSERT(!empty(), return true);
363 return d->fi.size() == 0;
367 bool FileName::isDirectory() const
369 return !empty() && d->fi.isDir();
373 bool FileName::isReadOnly() const
375 LASSERT(!empty(), return true);
376 return d->fi.isReadable() && !d->fi.isWritable();
380 bool FileName::isReadableDirectory() const
382 return isDirectory() && d->fi.isReadable();
386 string FileName::onlyFileName() const
388 return fromqstr(d->fi.fileName());
392 string FileName::onlyFileNameWithoutExt() const
394 return fromqstr(d->fi.completeBaseName());
398 string FileName::extension() const
400 return fromqstr(d->fi.suffix());
404 bool FileName::hasExtension(const string & ext)
406 return Private::isFilesystemEqual(d->fi.suffix(), toqstr(ext));
410 FileName FileName::onlyPath() const
415 path.d->fi.setFile(d->fi.path());
416 path.d->name = fromqstr(path.d->fi.absoluteFilePath());
421 FileName FileName::parentPath() const
424 // return empty path for parent of root dir
425 // parent of empty path is empty too
426 if (empty() || d->fi.isRoot())
428 path.d->fi.setFile(d->fi.path());
429 path.d->name = fromqstr(path.d->fi.absoluteFilePath());
434 bool FileName::isReadableFile() const
436 return !empty() && d->fi.isFile() && d->fi.isReadable();
440 bool FileName::isWritable() const
442 return !empty() && d->fi.isWritable();
446 bool FileName::isDirWritable() const
448 LASSERT(isDirectory(), return false);
449 QFileInfo tmp(QDir(d->fi.absoluteFilePath()), "lyxwritetest");
450 QTemporaryFile qt_tmp(tmp.absoluteFilePath());
452 LYXERR(Debug::FILES, "Directory " << *this << " is writable");
455 LYXERR(Debug::FILES, "Directory " << *this << " is not writable");
460 FileNameList FileName::dirList(string const & ext) const
462 FileNameList dirlist;
463 if (!isDirectory()) {
464 LYXERR0("Directory '" << *this << "' does not exist!");
468 // If the directory is specified without a trailing '/', absoluteDir()
469 // would return the parent dir, so we must use absoluteFilePath() here.
470 QDir dir = d->fi.absoluteFilePath();
475 case '.': filter = "*" + toqstr(ext); break;
476 case '*': filter = toqstr(ext); break;
477 default: filter = "*." + toqstr(ext);
479 dir.setNameFilters(QStringList(filter));
480 LYXERR(Debug::FILES, "filtering on extension "
481 << fromqstr(filter) << " is requested.");
484 QFileInfoList list = dir.entryInfoList();
485 for (int i = 0; i != list.size(); ++i) {
486 FileName fi(fromqstr(list.at(i).absoluteFilePath()));
487 dirlist.push_back(fi);
488 LYXERR(Debug::FILES, "found file " << fi);
495 FileName FileName::getcwd()
497 // return makeAbsPath("."); would create an infinite loop
499 return FileName(fromqstr(fi.absoluteFilePath()));
503 FileName FileName::tempPath()
505 return FileName(os::internal_path(fromqstr(QDir::tempPath())));
509 void FileName::refresh() const
515 time_t FileName::lastModified() const
517 // QFileInfo caches information about the file. So, in case this file has
518 // been touched between the object creation and now, we refresh the file
521 #if (QT_VERSION >= QT_VERSION_CHECK(5, 8, 0))
522 return d->fi.lastModified().toSecsSinceEpoch();
524 return d->fi.lastModified().toTime_t();
530 bool FileName::chdir() const
532 return QDir::setCurrent(d->fi.absoluteFilePath());
536 bool FileName::link(FileName const & name) const
538 return QFile::link(toqstr(absFileName()), toqstr(name.absFileName()));
542 unsigned long checksum_ifstream_fallback(char const * file)
544 //LYXERR(Debug::FILES, "lyx::sum() using istreambuf_iterator (fast)");
545 ifstream ifs(file, ios_base::in | ios_base::binary);
548 return support::checksum(ifs);
552 unsigned long FileName::checksum() const
555 //LYXERR0("File \"" << absFileName() << "\" does not exist!");
558 // a directory may be passed here so we need to test it. (bug 3622)
560 LYXERR0('"' << absFileName() << "\" is a directory!");
564 // This is used in the debug output at the end of the method.
565 static QElapsedTimer t;
566 if (lyxerr.debugging(Debug::FILES))
569 unsigned long result = 0;
571 #if QT_VERSION >= 0x999999
572 // First version of checksum uses Qt4.4 mmap support.
573 // FIXME: This code is not ready with Qt4.4.2,
574 // see http://www.lyx.org/trac/ticket/5293
575 // FIXME: should we check if the MapExtension extension is supported?
576 // see QAbstractFileEngine::supportsExtension() and
577 // QAbstractFileEngine::MapExtension)
578 QFile qf(fi.filePath());
579 if (!qf.open(QIODevice::ReadOnly))
581 qint64 size = fi.size();
582 uchar * ubeg = qf.map(0, size);
583 uchar * uend = ubeg + size;
584 result = support::checksum(ubeg, uend);
590 string const encoded = toSafeFilesystemEncoding();
591 char const * file = encoded.c_str();
594 //LYXERR(Debug::FILES, "using mmap (lightning fast)");
596 int fd = open(file, O_RDONLY);
601 if (fstat(fd, &info)){
602 // fstat fails on samba shares (bug 5891)
604 return checksum_ifstream_fallback(file);
607 void * mm = mmap(0, info.st_size, PROT_READ,
609 // Some platforms have the wrong type for MAP_FAILED (compaq cxx).
610 if (mm == reinterpret_cast<void*>(MAP_FAILED)) {
615 unsigned char * beg = static_cast<unsigned char*>(mm);
616 unsigned char * end = beg + info.st_size;
618 result = support::checksum(beg, end);
620 munmap(mm, info.st_size);
623 #else // no SUM_WITH_MMAP
624 result = checksum_ifstream_fallback(file);
625 #endif // SUM_WITH_MMAP
628 LYXERR(Debug::FILES, "Checksumming \"" << absFileName() << "\" "
629 << result << " lasted " << t.elapsed() << " ms.");
634 bool FileName::removeFile() const
636 bool const success = QFile::remove(d->fi.absoluteFilePath());
638 if (!success && exists())
639 LYXERR0("Could not delete file " << *this);
644 static bool rmdir(QFileInfo const & fi)
646 QDir dir(fi.absoluteFilePath());
647 QFileInfoList list = dir.entryInfoList();
649 for (int i = 0; i != list.size(); ++i) {
650 if (list.at(i).fileName() == ".")
652 if (list.at(i).fileName() == "..")
655 if (list.at(i).isDir()) {
656 LYXERR(Debug::FILES, "Removing dir "
657 << fromqstr(list.at(i).absoluteFilePath()));
658 removed = rmdir(list.at(i));
661 LYXERR(Debug::FILES, "Removing file "
662 << fromqstr(list.at(i).absoluteFilePath()));
663 removed = dir.remove(list.at(i).fileName());
667 LYXERR0("Could not delete "
668 << fromqstr(list.at(i).absoluteFilePath()));
671 QDir parent = fi.absolutePath();
672 success &= parent.rmdir(fi.fileName());
677 bool FileName::destroyDirectory() const
679 bool const success = rmdir(d->fi);
681 LYXERR0("Could not delete " << *this);
687 // Only used in non Win32 platforms
689 static int mymkdir(char const * pathname, unsigned long int mode)
691 // FIXME: why don't we have mode_t in lyx::mkdir prototype ??
693 # if MKDIR_TAKES_ONE_ARG
695 return ::mkdir(pathname);
696 // FIXME: "Permissions of created directories are ignored on this system."
699 return ::mkdir(pathname, mode_t(mode));
701 # elif defined(_WIN32)
703 return CreateDirectory(pathname, 0) != 0 ? 0 : -1;
704 // FIXME: "Permissions of created directories are ignored on this system."
706 return ::_mkdir(pathname);
707 // FIXME: "Permissions of created directories are ignored on this system."
709 # error "Don't know how to create a directory on this system."
715 bool FileName::createDirectory(int permission) const
717 LASSERT(!empty(), return false);
719 // FIXME: "Permissions of created directories are ignored on this system."
723 return mymkdir(toFilesystemEncoding().c_str(), permission) == 0;
728 bool FileName::createPath() const
730 LASSERT(!empty(), return false);
731 LYXERR(Debug::FILES, "creating path '" << *this << "'.");
736 bool success = dir.mkpath(d->fi.absoluteFilePath());
738 LYXERR0("Cannot create path '" << *this << "'!");
743 docstring const FileName::absoluteFilePath() const
745 return qstring_to_ucs4(d->fi.absoluteFilePath());
749 docstring FileName::displayName(int threshold) const
751 return from_utf8(onlyFileName()) + " ("
752 + makeDisplayPath(onlyPath().absFileName(), threshold) + ")";
756 docstring FileName::fileContents(string const & encoding) const
758 if (!isReadableFile()) {
759 LYXERR0("File '" << *this << "' is not readable!");
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!");
769 QByteArray contents = file.readAll();
772 if (contents.isEmpty()) {
773 LYXERR(Debug::FILES, "File '" << *this
774 << "' is either empty or some error happened while reading it.");
779 if (encoding.empty() || encoding == "UTF-8")
780 s = QString::fromUtf8(contents.data());
781 else if (encoding == "ascii")
782 s = QString::fromLatin1(contents.data());
783 else if (encoding == "local8bit")
784 s = QString::fromLocal8Bit(contents.data());
785 else if (encoding == "latin1")
786 s = QString::fromLatin1(contents.data());
788 return qstring_to_ucs4(s);
792 void FileName::changeExtension(string const & extension)
794 // FIXME: use Qt native methods...
795 string const oldname = absFileName();
796 string::size_type const last_slash = oldname.rfind('/');
797 string::size_type last_dot = oldname.rfind('.');
798 if (last_dot < last_slash && last_slash != string::npos)
799 last_dot = string::npos;
802 // Make sure the extension starts with a dot
803 if (!extension.empty() && extension[0] != '.')
804 ext= '.' + extension;
808 set(oldname.substr(0, last_dot) + ext);
812 void FileName::ensureExtension(string const & extension)
815 // Make sure the extension starts with a dot
816 if (!extension.empty() && extension[0] != '.')
817 ext= '.' + extension;
820 if (!suffixIs(ascii_lowercase(absFileName()), ext))
821 set(absFileName() + ext);
825 docstring const FileName::relPath(string const & path) const
828 return makeRelPath(absoluteFilePath(), from_utf8(path));
832 // Note: According to Qt, QFileInfo::operator== is undefined when
833 // both files do not exist (Qt4.5 gives true for all non-existent
834 // files, while Qt4.4 compares the filenames).
836 // http://www.qtsoftware.com/developer/task-tracker/
837 // index_html?id=248471&method=entry.
838 bool equivalent(FileName const & l, FileName const & r)
840 // FIXME: In future use Qt.
841 // Qt 4.4: We need to solve this warning from Qt documentation:
842 // * Long and short file names that refer to the same file on Windows are
843 // treated as if they referred to different files.
844 // This is supposed to be fixed for Qt5.
845 FileName const lhs(os::internal_path(l.absFileName()));
846 FileName const rhs(os::internal_path(r.absFileName()));
849 // QFileInfo::operator==() returns false if the two QFileInfo are empty.
853 // Avoid unnecessary checks below.
859 if (!lhs.d->fi.isSymLink() && !rhs.d->fi.isSymLink()) {
860 // Qt already checks if the filesystem is case sensitive or not.
861 // see note above why the extra check with fileName is needed.
862 return lhs.d->fi == rhs.d->fi
863 && lhs.d->fi.fileName() == rhs.d->fi.fileName();
866 // FIXME: When/if QFileInfo support symlink comparison, remove this code.
867 QFileInfo fi1(lhs.d->fi);
869 fi1 = QFileInfo(fi1.symLinkTarget());
870 QFileInfo fi2(rhs.d->fi);
872 fi2 = QFileInfo(fi2.symLinkTarget());
873 // see note above why the extra check with fileName is needed.
874 return fi1 == fi2 && fi1.fileName() == fi2.fileName();
878 bool operator==(FileName const & lhs, FileName const & rhs)
880 return os::isFilesystemCaseSensitive()
881 ? lhs.absFileName() == rhs.absFileName()
882 : !QString::compare(toqstr(lhs.absFileName()),
883 toqstr(rhs.absFileName()), Qt::CaseInsensitive);
887 bool operator!=(FileName const & lhs, FileName const & rhs)
889 return !(operator==(lhs, rhs));
893 bool operator<(FileName const & lhs, FileName const & rhs)
895 return lhs.absFileName() < rhs.absFileName();
899 bool operator>(FileName const & lhs, FileName const & rhs)
901 return lhs.absFileName() > rhs.absFileName();
905 ostream & operator<<(ostream & os, FileName const & filename)
907 return os << filename.absFileName();
911 /////////////////////////////////////////////////////////////////////
915 /////////////////////////////////////////////////////////////////////
918 DocFileName::DocFileName()
919 : save_abs_path_(true)
923 DocFileName::DocFileName(string const & abs_filename, bool save_abs)
924 : FileName(abs_filename), save_abs_path_(save_abs)
928 DocFileName::DocFileName(FileName const & abs_filename, bool save_abs)
929 : FileName(abs_filename), save_abs_path_(save_abs)
933 void DocFileName::set(string const & name, string const & buffer_path)
935 save_abs_path_ = isAbsolute(name);
939 FileName::set(makeAbsPath(name, buffer_path).absFileName());
943 void DocFileName::erase()
949 string DocFileName::relFileName(string const & path) const
952 return to_utf8(relPath(path));
956 string DocFileName::outputFileName(string const & path) const
958 return save_abs_path_ ? absFileName() : relFileName(path);
961 // check for an existing value in a map
962 bool collision_exists(map<string, string> const & db, string const & value)
964 for (auto it = db.begin(); it != db.end(); ++it)
965 if (it->second == value)
969 /* replace the above, once we support C++17
970 for (const auto& [key, val] : db)
976 string DocFileName::mangledFileName(string const & dir, bool encrypt_path) const
978 // Concurrent access to these variables is possible.
980 // We need to make sure that every DocFileName instance for a given
981 // filename returns the same mangled name.
982 typedef map<string, string> MangledMap;
983 static MangledMap mangledPlainNames;
984 static MangledMap mangledEncryptNames; //separate table for xhtml() route
985 static Mutex mangledMutex;
986 // this locks both access to mangledNames and counter below
987 Mutex::Locker lock(&mangledMutex);
988 MangledMap * mangledNames = encrypt_path ? &mangledEncryptNames : &mangledPlainNames;
989 MangledMap::const_iterator const it = mangledNames->find(absFileName());
990 if (it != mangledNames->end())
993 string const name = absFileName();
997 // we use hash instead of counter to get stable filenames in export directory
999 // sanitization probably not neccessary for xhtml, but won't harm
1000 string sanfn = support::changeExtension(onlyFileName(), string());
1001 sanfn = sanitizeFileName(sanfn);
1002 // Add the extension back on
1003 sanfn = support::changeExtension(sanfn, getExtension(onlyFileName()));
1005 //various filesystems have filename limit around 2^8
1006 if (sanfn.length() > 230)
1009 string enc_name = "e_" + toHexHash(name, true) + "_" + sanfn;
1011 while (collision_exists(mangledEncryptNames, enc_name))
1012 enc_name = "e_" + toHexHash(enc_name, true) + "_" + sanfn;
1018 if (!encrypt_path) {
1019 // Now the real work. Remove the extension.
1020 mname = support::changeExtension(name, string());
1021 // The mangled name must be a valid LaTeX name.
1022 mname = sanitizeFileName(mname);
1023 // Add the extension back on
1024 mname = support::changeExtension(mname, getExtension(name));
1026 // Prepend a counter to the filename. This is necessary to make
1027 // the mangled name unique, see truncation below.
1029 static int counter = 0;
1032 s << counter++ << mname;
1036 // MiKTeX's YAP (version 2.4.1803) crashes if the file name
1037 // is longer than about 160 characters. MiKTeX's pdflatex
1038 // is even pickier. A maximum length of 100 has been proven to work.
1039 // If dir.size() > max length, all bets are off for YAP. We truncate
1040 // the filename nevertheless, keeping a minimum of 10 chars.
1042 string::size_type max_length = max(100 - ((int)dir.size() + 1), 10);
1044 // If the mangled file name is too long, hack it to fit.
1045 // We know we're guaranteed to have a unique file name because
1047 if (mname.size() > max_length) {
1048 int const half = (int(max_length) / 2) - 2;
1050 mname = mname.substr(0, half) + "___" +
1051 mname.substr(mname.size() - half);
1056 (*mangledNames)[absFileName()] = mname;
1061 string DocFileName::unzippedFileName() const
1063 return support::unzippedFileName(absFileName());
1067 bool operator==(DocFileName const & lhs, DocFileName const & rhs)
1069 return static_cast<FileName const &>(lhs)
1070 == static_cast<FileName const &>(rhs)
1071 && lhs.saveAbsPath() == rhs.saveAbsPath();
1075 bool operator!=(DocFileName const & lhs, DocFileName const & rhs)
1077 return !(lhs == rhs);
1080 } // namespace support