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>
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());
263 LYXERR0("Could not rename file " << *this << " to " << name);
268 bool FileName::moveTo(FileName const & name) const
270 LYXERR(Debug::FILES, "Moving " << *this << " to " << name);
272 // there's a locking problem on Windows sometimes, so
273 // we will keep trying for five seconds, in the hope
275 bool removed = QFile::remove(name.d->fi.absoluteFilePath());
277 while (!removed && tries < 6) {
279 removed = QFile::remove(name.d->fi.absoluteFilePath());
283 QFile::remove(name.d->fi.absoluteFilePath());
286 bool const success = QFile::rename(d->fi.absoluteFilePath(),
287 name.d->fi.absoluteFilePath());
289 LYXERR0("Could not move file " << *this << " to " << name);
294 bool FileName::changePermission(unsigned long int mode) const
296 #if defined (HAVE_CHMOD) && defined (HAVE_MODE_T)
297 if (::chmod(toFilesystemEncoding().c_str(), mode_t(mode)) != 0) {
298 LYXERR0("File " << *this << ": cannot change permission to "
309 bool FileName::clonePermissions(FileName const & source)
311 QFile fin(toqstr(source.absFileName()));
312 QFile f(toqstr(absFileName()));
314 return f.setPermissions(fin.permissions());
317 string FileName::toFilesystemEncoding() const
319 // This doesn't work on Windows for non ascii file names.
320 QByteArray const encoded = QFile::encodeName(d->fi.absoluteFilePath());
321 return string(encoded.begin(), encoded.end());
325 string FileName::toSafeFilesystemEncoding(os::file_access how) const
327 // This will work on Windows for non ascii file names.
328 QString const safe_path =
329 toqstr(os::safe_internal_path(absFileName(), how));
330 QByteArray const encoded = QFile::encodeName(safe_path);
331 return string(encoded.begin(), encoded.end());
335 FileName FileName::fromFilesystemEncoding(string const & name)
337 QByteArray const encoded(name.c_str(), name.length());
338 return FileName(fromqstr(QFile::decodeName(encoded)));
342 bool FileName::exists() const
344 return !empty() && d->fi.exists();
348 bool FileName::isSymLink() const
350 return !empty() && d->fi.isSymLink();
354 //QFileInfo caching info might fool this test if file was changed meanwhile.
355 //refresh() helps, but we don't want to put it blindly here, because it might
356 //trigger slowdown on networked file systems.
357 bool FileName::isFileEmpty() const
359 LASSERT(!empty(), return true);
360 return d->fi.size() == 0;
364 bool FileName::isDirectory() const
366 return !empty() && d->fi.isDir();
370 bool FileName::isReadOnly() const
372 LASSERT(!empty(), return true);
373 return d->fi.isReadable() && !d->fi.isWritable();
377 bool FileName::isReadableDirectory() const
379 return isDirectory() && d->fi.isReadable();
383 string FileName::onlyFileName() const
385 return fromqstr(d->fi.fileName());
389 string FileName::onlyFileNameWithoutExt() const
391 return fromqstr(d->fi.completeBaseName());
395 string FileName::extension() const
397 return fromqstr(d->fi.suffix());
401 bool FileName::hasExtension(const string & ext)
403 return Private::isFilesystemEqual(d->fi.suffix(), toqstr(ext));
407 FileName FileName::onlyPath() const
412 path.d->fi.setFile(d->fi.path());
413 path.d->name = fromqstr(path.d->fi.absoluteFilePath());
418 FileName FileName::parentPath() const
421 // return empty path for parent of root dir
422 // parent of empty path is empty too
423 if (empty() || d->fi.isRoot())
425 path.d->fi.setFile(d->fi.path());
426 path.d->name = fromqstr(path.d->fi.absoluteFilePath());
431 bool FileName::isReadableFile() const
433 return !empty() && d->fi.isFile() && d->fi.isReadable();
437 bool FileName::isWritable() const
439 return !empty() && d->fi.isWritable();
443 bool FileName::isDirWritable() const
445 LASSERT(isDirectory(), return false);
446 QFileInfo tmp(QDir(d->fi.absoluteFilePath()), "lyxwritetest");
447 QTemporaryFile qt_tmp(tmp.absoluteFilePath());
449 LYXERR(Debug::FILES, "Directory " << *this << " is writable");
452 LYXERR(Debug::FILES, "Directory " << *this << " is not writable");
457 FileNameList FileName::dirList(string const & ext) const
459 FileNameList dirlist;
460 if (!isDirectory()) {
461 LYXERR0("Directory '" << *this << "' does not exist!");
465 // If the directory is specified without a trailing '/', absoluteDir()
466 // would return the parent dir, so we must use absoluteFilePath() here.
467 QDir dir = d->fi.absoluteFilePath();
472 case '.': filter = "*" + toqstr(ext); break;
473 case '*': filter = toqstr(ext); break;
474 default: filter = "*." + toqstr(ext);
476 dir.setNameFilters(QStringList(filter));
477 LYXERR(Debug::FILES, "filtering on extension "
478 << fromqstr(filter) << " is requested.");
481 QFileInfoList list = dir.entryInfoList();
482 for (int i = 0; i != list.size(); ++i) {
483 FileName fi(fromqstr(list.at(i).absoluteFilePath()));
484 dirlist.push_back(fi);
485 LYXERR(Debug::FILES, "found file " << fi);
492 FileName FileName::getcwd()
494 // return makeAbsPath("."); would create an infinite loop
496 return FileName(fromqstr(fi.absoluteFilePath()));
500 FileName FileName::tempPath()
502 return FileName(os::internal_path(fromqstr(QDir::tempPath())));
506 void FileName::refresh() const
512 time_t FileName::lastModified() const
514 // QFileInfo caches information about the file. So, in case this file has
515 // been touched between the object creation and now, we refresh the file
518 return d->fi.lastModified().toTime_t();
522 bool FileName::chdir() const
524 return QDir::setCurrent(d->fi.absoluteFilePath());
528 bool FileName::link(FileName const & name) const
530 return QFile::link(toqstr(absFileName()), toqstr(name.absFileName()));
534 unsigned long checksum_ifstream_fallback(char const * file)
536 unsigned long result = 0;
537 //LYXERR(Debug::FILES, "lyx::sum() using istreambuf_iterator (fast)");
538 ifstream ifs(file, ios_base::in | ios_base::binary);
542 istreambuf_iterator<char> beg(ifs);
543 istreambuf_iterator<char> end;
544 boost::crc_32_type crc;
545 crc = for_each(beg, end, crc);
546 result = crc.checksum();
550 unsigned long FileName::checksum() const
553 //LYXERR0("File \"" << absFileName() << "\" does not exist!");
556 // a directory may be passed here so we need to test it. (bug 3622)
558 LYXERR0('"' << absFileName() << "\" is a directory!");
562 // This is used in the debug output at the end of the method.
564 if (lyxerr.debugging(Debug::FILES))
567 unsigned long result = 0;
569 #if QT_VERSION >= 0x999999
570 // First version of checksum uses Qt4.4 mmap support.
571 // FIXME: This code is not ready with Qt4.4.2,
572 // see http://www.lyx.org/trac/ticket/5293
573 // FIXME: should we check if the MapExtension extension is supported?
574 // see QAbstractFileEngine::supportsExtension() and
575 // QAbstractFileEngine::MapExtension)
576 QFile qf(fi.filePath());
577 if (!qf.open(QIODevice::ReadOnly))
579 qint64 size = fi.size();
580 uchar * ubeg = qf.map(0, size);
581 uchar * uend = ubeg + size;
582 boost::crc_32_type ucrc;
583 ucrc.process_block(ubeg, uend);
586 result = ucrc.checksum();
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 char * beg = static_cast<char*>(mm);
616 char * end = beg + info.st_size;
618 boost::crc_32_type crc;
619 crc.process_block(beg, end);
620 result = crc.checksum();
622 munmap(mm, info.st_size);
625 #else // no SUM_WITH_MMAP
626 result = checksum_ifstream_fallback(file);
627 #endif // SUM_WITH_MMAP
630 LYXERR(Debug::FILES, "Checksumming \"" << absFileName() << "\" "
631 << result << " lasted " << t.elapsed() << " ms.");
636 bool FileName::removeFile() const
638 bool const success = QFile::remove(d->fi.absoluteFilePath());
640 if (!success && exists())
641 LYXERR0("Could not delete file " << *this);
646 static bool rmdir(QFileInfo const & fi)
648 QDir dir(fi.absoluteFilePath());
649 QFileInfoList list = dir.entryInfoList();
651 for (int i = 0; i != list.size(); ++i) {
652 if (list.at(i).fileName() == ".")
654 if (list.at(i).fileName() == "..")
657 if (list.at(i).isDir()) {
658 LYXERR(Debug::FILES, "Removing dir "
659 << fromqstr(list.at(i).absoluteFilePath()));
660 removed = rmdir(list.at(i));
663 LYXERR(Debug::FILES, "Removing file "
664 << fromqstr(list.at(i).absoluteFilePath()));
665 removed = dir.remove(list.at(i).fileName());
669 LYXERR0("Could not delete "
670 << fromqstr(list.at(i).absoluteFilePath()));
673 QDir parent = fi.absolutePath();
674 success &= parent.rmdir(fi.fileName());
679 bool FileName::destroyDirectory() const
681 bool const success = rmdir(d->fi);
683 LYXERR0("Could not delete " << *this);
689 // Only used in non Win32 platforms
691 static int mymkdir(char const * pathname, unsigned long int mode)
693 // FIXME: why don't we have mode_t in lyx::mkdir prototype ??
695 # if MKDIR_TAKES_ONE_ARG
697 return ::mkdir(pathname);
698 // FIXME: "Permissions of created directories are ignored on this system."
701 return ::mkdir(pathname, mode_t(mode));
703 # elif defined(_WIN32)
705 return CreateDirectory(pathname, 0) != 0 ? 0 : -1;
706 // FIXME: "Permissions of created directories are ignored on this system."
708 return ::_mkdir(pathname);
709 // FIXME: "Permissions of created directories are ignored on this system."
711 # error "Don't know how to create a directory on this system."
717 bool FileName::createDirectory(int permission) const
719 LASSERT(!empty(), return false);
721 // FIXME: "Permissions of created directories are ignored on this system."
725 return mymkdir(toFilesystemEncoding().c_str(), permission) == 0;
730 bool FileName::createPath() const
732 LASSERT(!empty(), return false);
733 LYXERR(Debug::FILES, "creating path '" << *this << "'.");
738 bool success = dir.mkpath(d->fi.absoluteFilePath());
740 LYXERR0("Cannot create path '" << *this << "'!");
745 docstring const FileName::absoluteFilePath() const
747 return qstring_to_ucs4(d->fi.absoluteFilePath());
751 docstring FileName::displayName(int threshold) const
753 return makeDisplayPath(absFileName(), threshold);
757 docstring FileName::fileContents(string const & encoding) const
759 if (!isReadableFile()) {
760 LYXERR0("File '" << *this << "' is not readable!");
764 QFile file(d->fi.absoluteFilePath());
765 if (!file.open(QIODevice::ReadOnly)) {
766 LYXERR0("File '" << *this
767 << "' could not be opened in read only mode!");
770 QByteArray contents = file.readAll();
773 if (contents.isEmpty()) {
774 LYXERR(Debug::FILES, "File '" << *this
775 << "' is either empty or some error happened while reading it.");
780 if (encoding.empty() || encoding == "UTF-8")
781 s = QString::fromUtf8(contents.data());
782 else if (encoding == "ascii")
783 #if (QT_VERSION < 0x050000)
784 s = QString::fromAscii(contents.data());
786 s = QString::fromLatin1(contents.data());
788 else if (encoding == "local8bit")
789 s = QString::fromLocal8Bit(contents.data());
790 else if (encoding == "latin1")
791 s = QString::fromLatin1(contents.data());
793 return qstring_to_ucs4(s);
797 void FileName::changeExtension(string const & extension)
799 // FIXME: use Qt native methods...
800 string const oldname = absFileName();
801 string::size_type const last_slash = oldname.rfind('/');
802 string::size_type last_dot = oldname.rfind('.');
803 if (last_dot < last_slash && last_slash != string::npos)
804 last_dot = string::npos;
807 // Make sure the extension starts with a dot
808 if (!extension.empty() && extension[0] != '.')
809 ext= '.' + extension;
813 set(oldname.substr(0, last_dot) + ext);
817 docstring const FileName::relPath(string const & path) const
820 return makeRelPath(absoluteFilePath(), from_utf8(path));
824 // Note: According to Qt, QFileInfo::operator== is undefined when
825 // both files do not exist (Qt4.5 gives true for all non-existent
826 // files, while Qt4.4 compares the filenames).
828 // http://www.qtsoftware.com/developer/task-tracker/
829 // index_html?id=248471&method=entry.
830 bool equivalent(FileName const & l, FileName const & r)
832 // FIXME: In future use Qt.
833 // Qt 4.4: We need to solve this warning from Qt documentation:
834 // * Long and short file names that refer to the same file on Windows are
835 // treated as if they referred to different files.
836 // This is supposed to be fixed for Qt5.
837 FileName const lhs(os::internal_path(l.absFileName()));
838 FileName const rhs(os::internal_path(r.absFileName()));
841 // QFileInfo::operator==() returns false if the two QFileInfo are empty.
845 // Avoid unnecessary checks below.
851 if (!lhs.d->fi.isSymLink() && !rhs.d->fi.isSymLink()) {
852 // Qt already checks if the filesystem is case sensitive or not.
853 // see note above why the extra check with fileName is needed.
854 return lhs.d->fi == rhs.d->fi
855 && lhs.d->fi.fileName() == rhs.d->fi.fileName();
858 // FIXME: When/if QFileInfo support symlink comparison, remove this code.
859 QFileInfo fi1(lhs.d->fi);
861 fi1 = QFileInfo(fi1.symLinkTarget());
862 QFileInfo fi2(rhs.d->fi);
864 fi2 = QFileInfo(fi2.symLinkTarget());
865 // see note above why the extra check with fileName is needed.
866 return fi1 == fi2 && fi1.fileName() == fi2.fileName();
870 bool operator==(FileName const & lhs, FileName const & rhs)
872 return os::isFilesystemCaseSensitive()
873 ? lhs.absFileName() == rhs.absFileName()
874 : !QString::compare(toqstr(lhs.absFileName()),
875 toqstr(rhs.absFileName()), Qt::CaseInsensitive);
879 bool operator!=(FileName const & lhs, FileName const & rhs)
881 return !(operator==(lhs, rhs));
885 bool operator<(FileName const & lhs, FileName const & rhs)
887 return lhs.absFileName() < rhs.absFileName();
891 bool operator>(FileName const & lhs, FileName const & rhs)
893 return lhs.absFileName() > rhs.absFileName();
897 ostream & operator<<(ostream & os, FileName const & filename)
899 return os << filename.absFileName();
903 /////////////////////////////////////////////////////////////////////
907 /////////////////////////////////////////////////////////////////////
910 DocFileName::DocFileName()
911 : save_abs_path_(true)
915 DocFileName::DocFileName(string const & abs_filename, bool save_abs)
916 : FileName(abs_filename), save_abs_path_(save_abs)
920 DocFileName::DocFileName(FileName const & abs_filename, bool save_abs)
921 : FileName(abs_filename), save_abs_path_(save_abs)
925 void DocFileName::set(string const & name, string const & buffer_path)
927 save_abs_path_ = isAbsolute(name);
931 FileName::set(makeAbsPath(name, buffer_path).absFileName());
935 void DocFileName::erase()
941 string DocFileName::relFileName(string const & path) const
944 return to_utf8(relPath(path));
948 string DocFileName::outputFileName(string const & path) const
950 return save_abs_path_ ? absFileName() : relFileName(path);
954 string DocFileName::mangledFileName(string const & dir) const
956 // Concurrent access to these variables is possible.
958 // We need to make sure that every DocFileName instance for a given
959 // filename returns the same mangled name.
960 typedef map<string, string> MangledMap;
961 static MangledMap mangledNames;
962 static Mutex mangledMutex;
963 // this locks both access to mangledNames and counter below
964 Mutex::Locker lock(&mangledMutex);
965 MangledMap::const_iterator const it = mangledNames.find(absFileName());
966 if (it != mangledNames.end())
969 string const name = absFileName();
970 // Now the real work. Remove the extension.
971 string mname = support::changeExtension(name, string());
972 // The mangled name must be a valid LaTeX name.
973 // The list of characters to keep is probably over-restrictive,
974 // but it is not really a problem.
975 // Apart from non-ASCII characters, at least the following characters
976 // are forbidden: '/', '.', ' ', and ':'.
977 // On windows it is not possible to create files with '<', '>' or '?'
979 static string const keep = "abcdefghijklmnopqrstuvwxyz"
980 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
982 string::size_type pos = 0;
983 while ((pos = mname.find_first_not_of(keep, pos)) != string::npos)
985 // Add the extension back on
986 mname = support::changeExtension(mname, getExtension(name));
988 // Prepend a counter to the filename. This is necessary to make
989 // the mangled name unique.
990 static int counter = 0;
992 s << counter++ << mname;
995 // MiKTeX's YAP (version 2.4.1803) crashes if the file name
996 // is longer than about 160 characters. MiKTeX's pdflatex
997 // is even pickier. A maximum length of 100 has been proven to work.
998 // If dir.size() > max length, all bets are off for YAP. We truncate
999 // the filename nevertheless, keeping a minimum of 10 chars.
1001 string::size_type max_length = max(100 - ((int)dir.size() + 1), 10);
1003 // If the mangled file name is too long, hack it to fit.
1004 // We know we're guaranteed to have a unique file name because
1006 if (mname.size() > max_length) {
1007 int const half = (int(max_length) / 2) - 2;
1009 mname = mname.substr(0, half) + "___" +
1010 mname.substr(mname.size() - half);
1014 mangledNames[absFileName()] = mname;
1019 string DocFileName::unzippedFileName() const
1021 return support::unzippedFileName(absFileName());
1025 bool operator==(DocFileName const & lhs, DocFileName const & rhs)
1027 return static_cast<FileName const &>(lhs)
1028 == static_cast<FileName const &>(rhs)
1029 && lhs.saveAbsPath() == rhs.saveAbsPath();
1033 bool operator!=(DocFileName const & lhs, DocFileName const & rhs)
1035 return !(lhs == rhs);
1038 } // namespace support