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 <boost/crc.hpp>
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() ? true : false);
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 return d->fi.lastModified().toTime_t();
525 bool FileName::chdir() const
527 return QDir::setCurrent(d->fi.absoluteFilePath());
531 bool FileName::link(FileName const & name) const
533 return QFile::link(toqstr(absFileName()), toqstr(name.absFileName()));
537 unsigned long checksum_ifstream_fallback(char const * file)
539 unsigned long result = 0;
540 //LYXERR(Debug::FILES, "lyx::sum() using istreambuf_iterator (fast)");
541 ifstream ifs(file, ios_base::in | ios_base::binary);
545 istreambuf_iterator<char> beg(ifs);
546 istreambuf_iterator<char> end;
547 boost::crc_32_type crc;
548 crc = for_each(beg, end, crc);
549 result = crc.checksum();
553 unsigned long FileName::checksum() const
556 //LYXERR0("File \"" << absFileName() << "\" does not exist!");
559 // a directory may be passed here so we need to test it. (bug 3622)
561 LYXERR0('"' << absFileName() << "\" is a directory!");
565 // This is used in the debug output at the end of the method.
566 static QElapsedTimer t;
567 if (lyxerr.debugging(Debug::FILES))
570 unsigned long result = 0;
572 #if QT_VERSION >= 0x999999
573 // First version of checksum uses Qt4.4 mmap support.
574 // FIXME: This code is not ready with Qt4.4.2,
575 // see http://www.lyx.org/trac/ticket/5293
576 // FIXME: should we check if the MapExtension extension is supported?
577 // see QAbstractFileEngine::supportsExtension() and
578 // QAbstractFileEngine::MapExtension)
579 QFile qf(fi.filePath());
580 if (!qf.open(QIODevice::ReadOnly))
582 qint64 size = fi.size();
583 uchar * ubeg = qf.map(0, size);
584 uchar * uend = ubeg + size;
585 boost::crc_32_type ucrc;
586 ucrc.process_block(ubeg, uend);
589 result = ucrc.checksum();
593 string const encoded = toSafeFilesystemEncoding();
594 char const * file = encoded.c_str();
597 //LYXERR(Debug::FILES, "using mmap (lightning fast)");
599 int fd = open(file, O_RDONLY);
604 if (fstat(fd, &info)){
605 // fstat fails on samba shares (bug 5891)
607 return checksum_ifstream_fallback(file);
610 void * mm = mmap(0, info.st_size, PROT_READ,
612 // Some platforms have the wrong type for MAP_FAILED (compaq cxx).
613 if (mm == reinterpret_cast<void*>(MAP_FAILED)) {
618 char * beg = static_cast<char*>(mm);
619 char * end = beg + info.st_size;
621 boost::crc_32_type crc;
622 crc.process_block(beg, end);
623 result = crc.checksum();
625 munmap(mm, info.st_size);
628 #else // no SUM_WITH_MMAP
629 result = checksum_ifstream_fallback(file);
630 #endif // SUM_WITH_MMAP
633 LYXERR(Debug::FILES, "Checksumming \"" << absFileName() << "\" "
634 << result << " lasted " << t.elapsed() << " ms.");
639 bool FileName::removeFile() const
641 bool const success = QFile::remove(d->fi.absoluteFilePath());
643 if (!success && exists())
644 LYXERR0("Could not delete file " << *this);
649 static bool rmdir(QFileInfo const & fi)
651 QDir dir(fi.absoluteFilePath());
652 QFileInfoList list = dir.entryInfoList();
654 for (int i = 0; i != list.size(); ++i) {
655 if (list.at(i).fileName() == ".")
657 if (list.at(i).fileName() == "..")
660 if (list.at(i).isDir()) {
661 LYXERR(Debug::FILES, "Removing dir "
662 << fromqstr(list.at(i).absoluteFilePath()));
663 removed = rmdir(list.at(i));
666 LYXERR(Debug::FILES, "Removing file "
667 << fromqstr(list.at(i).absoluteFilePath()));
668 removed = dir.remove(list.at(i).fileName());
672 LYXERR0("Could not delete "
673 << fromqstr(list.at(i).absoluteFilePath()));
676 QDir parent = fi.absolutePath();
677 success &= parent.rmdir(fi.fileName());
682 bool FileName::destroyDirectory() const
684 bool const success = rmdir(d->fi);
686 LYXERR0("Could not delete " << *this);
692 // Only used in non Win32 platforms
694 static int mymkdir(char const * pathname, unsigned long int mode)
696 // FIXME: why don't we have mode_t in lyx::mkdir prototype ??
698 # if MKDIR_TAKES_ONE_ARG
700 return ::mkdir(pathname);
701 // FIXME: "Permissions of created directories are ignored on this system."
704 return ::mkdir(pathname, mode_t(mode));
706 # elif defined(_WIN32)
708 return CreateDirectory(pathname, 0) != 0 ? 0 : -1;
709 // FIXME: "Permissions of created directories are ignored on this system."
711 return ::_mkdir(pathname);
712 // FIXME: "Permissions of created directories are ignored on this system."
714 # error "Don't know how to create a directory on this system."
720 bool FileName::createDirectory(int permission) const
722 LASSERT(!empty(), return false);
724 // FIXME: "Permissions of created directories are ignored on this system."
728 return mymkdir(toFilesystemEncoding().c_str(), permission) == 0;
733 bool FileName::createPath() const
735 LASSERT(!empty(), return false);
736 LYXERR(Debug::FILES, "creating path '" << *this << "'.");
741 bool success = dir.mkpath(d->fi.absoluteFilePath());
743 LYXERR0("Cannot create path '" << *this << "'!");
748 docstring const FileName::absoluteFilePath() const
750 return qstring_to_ucs4(d->fi.absoluteFilePath());
754 docstring FileName::displayName(int threshold) const
756 return makeDisplayPath(absFileName(), threshold);
760 docstring FileName::fileContents(string const & encoding) const
762 if (!isReadableFile()) {
763 LYXERR0("File '" << *this << "' is not readable!");
767 QFile file(d->fi.absoluteFilePath());
768 if (!file.open(QIODevice::ReadOnly)) {
769 LYXERR0("File '" << *this
770 << "' could not be opened in read only mode!");
773 QByteArray contents = file.readAll();
776 if (contents.isEmpty()) {
777 LYXERR(Debug::FILES, "File '" << *this
778 << "' is either empty or some error happened while reading it.");
783 if (encoding.empty() || encoding == "UTF-8")
784 s = QString::fromUtf8(contents.data());
785 else if (encoding == "ascii")
786 #if (QT_VERSION < 0x050000)
787 s = QString::fromAscii(contents.data());
789 s = QString::fromLatin1(contents.data());
791 else if (encoding == "local8bit")
792 s = QString::fromLocal8Bit(contents.data());
793 else if (encoding == "latin1")
794 s = QString::fromLatin1(contents.data());
796 return qstring_to_ucs4(s);
800 void FileName::changeExtension(string const & extension)
802 // FIXME: use Qt native methods...
803 string const oldname = absFileName();
804 string::size_type const last_slash = oldname.rfind('/');
805 string::size_type last_dot = oldname.rfind('.');
806 if (last_dot < last_slash && last_slash != string::npos)
807 last_dot = string::npos;
810 // Make sure the extension starts with a dot
811 if (!extension.empty() && extension[0] != '.')
812 ext= '.' + extension;
816 set(oldname.substr(0, last_dot) + ext);
820 docstring const FileName::relPath(string const & path) const
823 return makeRelPath(absoluteFilePath(), from_utf8(path));
827 // Note: According to Qt, QFileInfo::operator== is undefined when
828 // both files do not exist (Qt4.5 gives true for all non-existent
829 // files, while Qt4.4 compares the filenames).
831 // http://www.qtsoftware.com/developer/task-tracker/
832 // index_html?id=248471&method=entry.
833 bool equivalent(FileName const & l, FileName const & r)
835 // FIXME: In future use Qt.
836 // Qt 4.4: We need to solve this warning from Qt documentation:
837 // * Long and short file names that refer to the same file on Windows are
838 // treated as if they referred to different files.
839 // This is supposed to be fixed for Qt5.
840 FileName const lhs(os::internal_path(l.absFileName()));
841 FileName const rhs(os::internal_path(r.absFileName()));
844 // QFileInfo::operator==() returns false if the two QFileInfo are empty.
848 // Avoid unnecessary checks below.
854 if (!lhs.d->fi.isSymLink() && !rhs.d->fi.isSymLink()) {
855 // Qt already checks if the filesystem is case sensitive or not.
856 // see note above why the extra check with fileName is needed.
857 return lhs.d->fi == rhs.d->fi
858 && lhs.d->fi.fileName() == rhs.d->fi.fileName();
861 // FIXME: When/if QFileInfo support symlink comparison, remove this code.
862 QFileInfo fi1(lhs.d->fi);
864 fi1 = QFileInfo(fi1.symLinkTarget());
865 QFileInfo fi2(rhs.d->fi);
867 fi2 = QFileInfo(fi2.symLinkTarget());
868 // see note above why the extra check with fileName is needed.
869 return fi1 == fi2 && fi1.fileName() == fi2.fileName();
873 bool operator==(FileName const & lhs, FileName const & rhs)
875 return os::isFilesystemCaseSensitive()
876 ? lhs.absFileName() == rhs.absFileName()
877 : !QString::compare(toqstr(lhs.absFileName()),
878 toqstr(rhs.absFileName()), Qt::CaseInsensitive);
882 bool operator!=(FileName const & lhs, FileName const & rhs)
884 return !(operator==(lhs, rhs));
888 bool operator<(FileName const & lhs, FileName const & rhs)
890 return lhs.absFileName() < rhs.absFileName();
894 bool operator>(FileName const & lhs, FileName const & rhs)
896 return lhs.absFileName() > rhs.absFileName();
900 ostream & operator<<(ostream & os, FileName const & filename)
902 return os << filename.absFileName();
906 /////////////////////////////////////////////////////////////////////
910 /////////////////////////////////////////////////////////////////////
913 DocFileName::DocFileName()
914 : save_abs_path_(true)
918 DocFileName::DocFileName(string const & abs_filename, bool save_abs)
919 : FileName(abs_filename), save_abs_path_(save_abs)
923 DocFileName::DocFileName(FileName const & abs_filename, bool save_abs)
924 : FileName(abs_filename), save_abs_path_(save_abs)
928 void DocFileName::set(string const & name, string const & buffer_path)
930 save_abs_path_ = isAbsolute(name);
934 FileName::set(makeAbsPath(name, buffer_path).absFileName());
938 void DocFileName::erase()
944 string DocFileName::relFileName(string const & path) const
947 return to_utf8(relPath(path));
951 string DocFileName::outputFileName(string const & path) const
953 return save_abs_path_ ? absFileName() : relFileName(path);
957 string DocFileName::mangledFileName(string const & dir) const
959 // Concurrent access to these variables is possible.
961 // We need to make sure that every DocFileName instance for a given
962 // filename returns the same mangled name.
963 typedef map<string, string> MangledMap;
964 static MangledMap mangledNames;
965 static Mutex mangledMutex;
966 // this locks both access to mangledNames and counter below
967 Mutex::Locker lock(&mangledMutex);
968 MangledMap::const_iterator const it = mangledNames.find(absFileName());
969 if (it != mangledNames.end())
972 string const name = absFileName();
973 // Now the real work. Remove the extension.
974 string mname = support::changeExtension(name, string());
975 // The mangled name must be a valid LaTeX name.
976 // The list of characters to keep is probably over-restrictive,
977 // but it is not really a problem.
978 // Apart from non-ASCII characters, at least the following characters
979 // are forbidden: '/', '.', ' ', and ':'.
980 // On windows it is not possible to create files with '<', '>' or '?'
982 static string const keep = "abcdefghijklmnopqrstuvwxyz"
983 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
985 string::size_type pos = 0;
986 while ((pos = mname.find_first_not_of(keep, pos)) != string::npos)
988 // Add the extension back on
989 mname = support::changeExtension(mname, getExtension(name));
991 // Prepend a counter to the filename. This is necessary to make
992 // the mangled name unique.
993 static int counter = 0;
995 s << counter++ << mname;
998 // MiKTeX's YAP (version 2.4.1803) crashes if the file name
999 // is longer than about 160 characters. MiKTeX's pdflatex
1000 // is even pickier. A maximum length of 100 has been proven to work.
1001 // If dir.size() > max length, all bets are off for YAP. We truncate
1002 // the filename nevertheless, keeping a minimum of 10 chars.
1004 string::size_type max_length = max(100 - ((int)dir.size() + 1), 10);
1006 // If the mangled file name is too long, hack it to fit.
1007 // We know we're guaranteed to have a unique file name because
1009 if (mname.size() > max_length) {
1010 int const half = (int(max_length) / 2) - 2;
1012 mname = mname.substr(0, half) + "___" +
1013 mname.substr(mname.size() - half);
1017 mangledNames[absFileName()] = mname;
1022 string DocFileName::unzippedFileName() const
1024 return support::unzippedFileName(absFileName());
1028 bool operator==(DocFileName const & lhs, DocFileName const & rhs)
1030 return static_cast<FileName const &>(lhs)
1031 == static_cast<FileName const &>(rhs)
1032 && lhs.saveAbsPath() == rhs.saveAbsPath();
1036 bool operator!=(DocFileName const & lhs, DocFileName const & rhs)
1038 return !(lhs == rhs);
1041 } // namespace support