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
276 bool removed = QFile::remove(name.d->fi.absoluteFilePath());
278 while (!removed && tries < 6) {
280 removed = QFile::remove(name.d->fi.absoluteFilePath());
285 QFile::remove(name.d->fi.absoluteFilePath());
288 bool const success = QFile::rename(d->fi.absoluteFilePath(),
289 name.d->fi.absoluteFilePath());
291 LYXERR0("Could not move file " << *this << " to " << name);
296 bool FileName::changePermission(unsigned long int mode) const
298 #if defined (HAVE_CHMOD) && defined (HAVE_MODE_T)
299 if (::chmod(toFilesystemEncoding().c_str(), mode_t(mode)) != 0) {
300 LYXERR0("File " << *this << ": cannot change permission to "
311 bool FileName::clonePermissions(FileName const & source)
313 QFile fin(toqstr(source.absFileName()));
314 QFile f(toqstr(absFileName()));
316 return f.setPermissions(fin.permissions());
319 string FileName::toFilesystemEncoding() const
321 // This doesn't work on Windows for non ascii file names.
322 QByteArray const encoded = QFile::encodeName(d->fi.absoluteFilePath());
323 return string(encoded.begin(), encoded.end());
327 string FileName::toSafeFilesystemEncoding(os::file_access how) const
329 // This will work on Windows for non ascii file names.
330 QString const safe_path =
331 toqstr(os::safe_internal_path(absFileName(), how));
332 QByteArray const encoded = QFile::encodeName(safe_path);
333 return string(encoded.begin(), encoded.end());
337 FileName FileName::fromFilesystemEncoding(string const & name)
339 QByteArray const encoded(name.c_str(), name.length());
340 return FileName(fromqstr(QFile::decodeName(encoded)));
344 bool FileName::exists() const
346 return !empty() && d->fi.exists();
350 bool FileName::isSymLink() const
352 return !empty() && d->fi.isSymLink();
356 //QFileInfo caching info might fool this test if file was changed meanwhile.
357 //refresh() helps, but we don't want to put it blindly here, because it might
358 //trigger slowdown on networked file systems.
359 bool FileName::isFileEmpty() const
361 LASSERT(!empty(), return true);
362 return d->fi.size() == 0;
366 bool FileName::isDirectory() const
368 return !empty() && d->fi.isDir();
372 bool FileName::isReadOnly() const
374 LASSERT(!empty(), return true);
375 return d->fi.isReadable() && !d->fi.isWritable();
379 bool FileName::isReadableDirectory() const
381 return isDirectory() && d->fi.isReadable();
385 string FileName::onlyFileName() const
387 return fromqstr(d->fi.fileName());
391 string FileName::onlyFileNameWithoutExt() const
393 return fromqstr(d->fi.completeBaseName());
397 string FileName::extension() const
399 return fromqstr(d->fi.suffix());
403 bool FileName::hasExtension(const string & ext)
405 return Private::isFilesystemEqual(d->fi.suffix(), toqstr(ext));
409 FileName FileName::onlyPath() const
414 path.d->fi.setFile(d->fi.path());
415 path.d->name = fromqstr(path.d->fi.absoluteFilePath());
420 FileName FileName::parentPath() const
423 // return empty path for parent of root dir
424 // parent of empty path is empty too
425 if (empty() || d->fi.isRoot())
427 path.d->fi.setFile(d->fi.path());
428 path.d->name = fromqstr(path.d->fi.absoluteFilePath());
433 bool FileName::isReadableFile() const
435 return !empty() && d->fi.isFile() && d->fi.isReadable();
439 bool FileName::isWritable() const
441 return !empty() && d->fi.isWritable();
445 bool FileName::isDirWritable() const
447 LASSERT(isDirectory(), return false);
448 QFileInfo tmp(QDir(d->fi.absoluteFilePath()), "lyxwritetest");
449 QTemporaryFile qt_tmp(tmp.absoluteFilePath());
451 LYXERR(Debug::FILES, "Directory " << *this << " is writable");
454 LYXERR(Debug::FILES, "Directory " << *this << " is not writable");
459 FileNameList FileName::dirList(string const & ext) const
461 FileNameList dirlist;
462 if (!isDirectory()) {
463 LYXERR0("Directory '" << *this << "' does not exist!");
467 // If the directory is specified without a trailing '/', absoluteDir()
468 // would return the parent dir, so we must use absoluteFilePath() here.
469 QDir dir = d->fi.absoluteFilePath();
474 case '.': filter = "*" + toqstr(ext); break;
475 case '*': filter = toqstr(ext); break;
476 default: filter = "*." + toqstr(ext);
478 dir.setNameFilters(QStringList(filter));
479 LYXERR(Debug::FILES, "filtering on extension "
480 << fromqstr(filter) << " is requested.");
483 QFileInfoList list = dir.entryInfoList();
484 for (int i = 0; i != list.size(); ++i) {
485 FileName fi(fromqstr(list.at(i).absoluteFilePath()));
486 dirlist.push_back(fi);
487 LYXERR(Debug::FILES, "found file " << fi);
494 FileName FileName::getcwd()
496 // return makeAbsPath("."); would create an infinite loop
498 return FileName(fromqstr(fi.absoluteFilePath()));
502 FileName FileName::tempPath()
504 return FileName(os::internal_path(fromqstr(QDir::tempPath())));
508 void FileName::refresh() const
514 time_t FileName::lastModified() const
516 // QFileInfo caches information about the file. So, in case this file has
517 // been touched between the object creation and now, we refresh the file
520 return d->fi.lastModified().toTime_t();
524 bool FileName::chdir() const
526 return QDir::setCurrent(d->fi.absoluteFilePath());
530 bool FileName::link(FileName const & name) const
532 return QFile::link(toqstr(absFileName()), toqstr(name.absFileName()));
536 unsigned long checksum_ifstream_fallback(char const * file)
538 unsigned long result = 0;
539 //LYXERR(Debug::FILES, "lyx::sum() using istreambuf_iterator (fast)");
540 ifstream ifs(file, ios_base::in | ios_base::binary);
544 istreambuf_iterator<char> beg(ifs);
545 istreambuf_iterator<char> end;
546 boost::crc_32_type crc;
547 crc = for_each(beg, end, crc);
548 result = crc.checksum();
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.
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 boost::crc_32_type ucrc;
585 ucrc.process_block(ubeg, uend);
588 result = ucrc.checksum();
592 string const encoded = toSafeFilesystemEncoding();
593 char const * file = encoded.c_str();
596 //LYXERR(Debug::FILES, "using mmap (lightning fast)");
598 int fd = open(file, O_RDONLY);
603 if (fstat(fd, &info)){
604 // fstat fails on samba shares (bug 5891)
606 return checksum_ifstream_fallback(file);
609 void * mm = mmap(0, info.st_size, PROT_READ,
611 // Some platforms have the wrong type for MAP_FAILED (compaq cxx).
612 if (mm == reinterpret_cast<void*>(MAP_FAILED)) {
617 char * beg = static_cast<char*>(mm);
618 char * end = beg + info.st_size;
620 boost::crc_32_type crc;
621 crc.process_block(beg, end);
622 result = crc.checksum();
624 munmap(mm, info.st_size);
627 #else // no SUM_WITH_MMAP
628 result = checksum_ifstream_fallback(file);
629 #endif // SUM_WITH_MMAP
632 LYXERR(Debug::FILES, "Checksumming \"" << absFileName() << "\" "
633 << result << " lasted " << t.elapsed() << " ms.");
638 bool FileName::removeFile() const
640 bool const success = QFile::remove(d->fi.absoluteFilePath());
642 if (!success && exists())
643 LYXERR0("Could not delete file " << *this);
648 static bool rmdir(QFileInfo const & fi)
650 QDir dir(fi.absoluteFilePath());
651 QFileInfoList list = dir.entryInfoList();
653 for (int i = 0; i != list.size(); ++i) {
654 if (list.at(i).fileName() == ".")
656 if (list.at(i).fileName() == "..")
659 if (list.at(i).isDir()) {
660 LYXERR(Debug::FILES, "Removing dir "
661 << fromqstr(list.at(i).absoluteFilePath()));
662 removed = rmdir(list.at(i));
665 LYXERR(Debug::FILES, "Removing file "
666 << fromqstr(list.at(i).absoluteFilePath()));
667 removed = dir.remove(list.at(i).fileName());
671 LYXERR0("Could not delete "
672 << fromqstr(list.at(i).absoluteFilePath()));
675 QDir parent = fi.absolutePath();
676 success &= parent.rmdir(fi.fileName());
681 bool FileName::destroyDirectory() const
683 bool const success = rmdir(d->fi);
685 LYXERR0("Could not delete " << *this);
691 // Only used in non Win32 platforms
693 static int mymkdir(char const * pathname, unsigned long int mode)
695 // FIXME: why don't we have mode_t in lyx::mkdir prototype ??
697 # if MKDIR_TAKES_ONE_ARG
699 return ::mkdir(pathname);
700 // FIXME: "Permissions of created directories are ignored on this system."
703 return ::mkdir(pathname, mode_t(mode));
705 # elif defined(_WIN32)
707 return CreateDirectory(pathname, 0) != 0 ? 0 : -1;
708 // FIXME: "Permissions of created directories are ignored on this system."
710 return ::_mkdir(pathname);
711 // FIXME: "Permissions of created directories are ignored on this system."
713 # error "Don't know how to create a directory on this system."
719 bool FileName::createDirectory(int permission) const
721 LASSERT(!empty(), return false);
723 // FIXME: "Permissions of created directories are ignored on this system."
727 return mymkdir(toFilesystemEncoding().c_str(), permission) == 0;
732 bool FileName::createPath() const
734 LASSERT(!empty(), return false);
735 LYXERR(Debug::FILES, "creating path '" << *this << "'.");
740 bool success = dir.mkpath(d->fi.absoluteFilePath());
742 LYXERR0("Cannot create path '" << *this << "'!");
747 docstring const FileName::absoluteFilePath() const
749 return qstring_to_ucs4(d->fi.absoluteFilePath());
753 docstring FileName::displayName(int threshold) const
755 return makeDisplayPath(absFileName(), threshold);
759 docstring FileName::fileContents(string const & encoding) const
761 if (!isReadableFile()) {
762 LYXERR0("File '" << *this << "' is not readable!");
766 QFile file(d->fi.absoluteFilePath());
767 if (!file.open(QIODevice::ReadOnly)) {
768 LYXERR0("File '" << *this
769 << "' could not be opened in read only mode!");
772 QByteArray contents = file.readAll();
775 if (contents.isEmpty()) {
776 LYXERR(Debug::FILES, "File '" << *this
777 << "' is either empty or some error happened while reading it.");
782 if (encoding.empty() || encoding == "UTF-8")
783 s = QString::fromUtf8(contents.data());
784 else if (encoding == "ascii")
785 #if (QT_VERSION < 0x050000)
786 s = QString::fromAscii(contents.data());
788 s = QString::fromLatin1(contents.data());
790 else if (encoding == "local8bit")
791 s = QString::fromLocal8Bit(contents.data());
792 else if (encoding == "latin1")
793 s = QString::fromLatin1(contents.data());
795 return qstring_to_ucs4(s);
799 void FileName::changeExtension(string const & extension)
801 // FIXME: use Qt native methods...
802 string const oldname = absFileName();
803 string::size_type const last_slash = oldname.rfind('/');
804 string::size_type last_dot = oldname.rfind('.');
805 if (last_dot < last_slash && last_slash != string::npos)
806 last_dot = string::npos;
809 // Make sure the extension starts with a dot
810 if (!extension.empty() && extension[0] != '.')
811 ext= '.' + extension;
815 set(oldname.substr(0, last_dot) + ext);
819 docstring const FileName::relPath(string const & path) const
822 return makeRelPath(absoluteFilePath(), from_utf8(path));
826 // Note: According to Qt, QFileInfo::operator== is undefined when
827 // both files do not exist (Qt4.5 gives true for all non-existent
828 // files, while Qt4.4 compares the filenames).
830 // http://www.qtsoftware.com/developer/task-tracker/
831 // index_html?id=248471&method=entry.
832 bool equivalent(FileName const & l, FileName const & r)
834 // FIXME: In future use Qt.
835 // Qt 4.4: We need to solve this warning from Qt documentation:
836 // * Long and short file names that refer to the same file on Windows are
837 // treated as if they referred to different files.
838 // This is supposed to be fixed for Qt5.
839 FileName const lhs(os::internal_path(l.absFileName()));
840 FileName const rhs(os::internal_path(r.absFileName()));
843 // QFileInfo::operator==() returns false if the two QFileInfo are empty.
847 // Avoid unnecessary checks below.
853 if (!lhs.d->fi.isSymLink() && !rhs.d->fi.isSymLink()) {
854 // Qt already checks if the filesystem is case sensitive or not.
855 // see note above why the extra check with fileName is needed.
856 return lhs.d->fi == rhs.d->fi
857 && lhs.d->fi.fileName() == rhs.d->fi.fileName();
860 // FIXME: When/if QFileInfo support symlink comparison, remove this code.
861 QFileInfo fi1(lhs.d->fi);
863 fi1 = QFileInfo(fi1.symLinkTarget());
864 QFileInfo fi2(rhs.d->fi);
866 fi2 = QFileInfo(fi2.symLinkTarget());
867 // see note above why the extra check with fileName is needed.
868 return fi1 == fi2 && fi1.fileName() == fi2.fileName();
872 bool operator==(FileName const & lhs, FileName const & rhs)
874 return os::isFilesystemCaseSensitive()
875 ? lhs.absFileName() == rhs.absFileName()
876 : !QString::compare(toqstr(lhs.absFileName()),
877 toqstr(rhs.absFileName()), Qt::CaseInsensitive);
881 bool operator!=(FileName const & lhs, FileName const & rhs)
883 return !(operator==(lhs, rhs));
887 bool operator<(FileName const & lhs, FileName const & rhs)
889 return lhs.absFileName() < rhs.absFileName();
893 bool operator>(FileName const & lhs, FileName const & rhs)
895 return lhs.absFileName() > rhs.absFileName();
899 ostream & operator<<(ostream & os, FileName const & filename)
901 return os << filename.absFileName();
905 /////////////////////////////////////////////////////////////////////
909 /////////////////////////////////////////////////////////////////////
912 DocFileName::DocFileName()
913 : save_abs_path_(true)
917 DocFileName::DocFileName(string const & abs_filename, bool save_abs)
918 : FileName(abs_filename), save_abs_path_(save_abs)
922 DocFileName::DocFileName(FileName const & abs_filename, bool save_abs)
923 : FileName(abs_filename), save_abs_path_(save_abs)
927 void DocFileName::set(string const & name, string const & buffer_path)
929 save_abs_path_ = isAbsolute(name);
933 FileName::set(makeAbsPath(name, buffer_path).absFileName());
937 void DocFileName::erase()
943 string DocFileName::relFileName(string const & path) const
946 return to_utf8(relPath(path));
950 string DocFileName::outputFileName(string const & path) const
952 return save_abs_path_ ? absFileName() : relFileName(path);
956 string DocFileName::mangledFileName(string const & dir) const
958 // Concurrent access to these variables is possible.
960 // We need to make sure that every DocFileName instance for a given
961 // filename returns the same mangled name.
962 typedef map<string, string> MangledMap;
963 static MangledMap mangledNames;
964 static Mutex mangledMutex;
965 // this locks both access to mangledNames and counter below
966 Mutex::Locker lock(&mangledMutex);
967 MangledMap::const_iterator const it = mangledNames.find(absFileName());
968 if (it != mangledNames.end())
971 string const name = absFileName();
972 // Now the real work. Remove the extension.
973 string mname = support::changeExtension(name, string());
974 // The mangled name must be a valid LaTeX name.
975 // The list of characters to keep is probably over-restrictive,
976 // but it is not really a problem.
977 // Apart from non-ASCII characters, at least the following characters
978 // are forbidden: '/', '.', ' ', and ':'.
979 // On windows it is not possible to create files with '<', '>' or '?'
981 static string const keep = "abcdefghijklmnopqrstuvwxyz"
982 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
984 string::size_type pos = 0;
985 while ((pos = mname.find_first_not_of(keep, pos)) != string::npos)
987 // Add the extension back on
988 mname = support::changeExtension(mname, getExtension(name));
990 // Prepend a counter to the filename. This is necessary to make
991 // the mangled name unique.
992 static int counter = 0;
994 s << counter++ << mname;
997 // MiKTeX's YAP (version 2.4.1803) crashes if the file name
998 // is longer than about 160 characters. MiKTeX's pdflatex
999 // is even pickier. A maximum length of 100 has been proven to work.
1000 // If dir.size() > max length, all bets are off for YAP. We truncate
1001 // the filename nevertheless, keeping a minimum of 10 chars.
1003 string::size_type max_length = max(100 - ((int)dir.size() + 1), 10);
1005 // If the mangled file name is too long, hack it to fit.
1006 // We know we're guaranteed to have a unique file name because
1008 if (mname.size() > max_length) {
1009 int const half = (int(max_length) / 2) - 2;
1011 mname = mname.substr(0, half) + "___" +
1012 mname.substr(mname.size() - half);
1016 mangledNames[absFileName()] = mname;
1021 string DocFileName::unzippedFileName() const
1023 return support::unzippedFileName(absFileName());
1027 bool operator==(DocFileName const & lhs, DocFileName const & rhs)
1029 return static_cast<FileName const &>(lhs)
1030 == static_cast<FileName const &>(rhs)
1031 && lhs.saveAbsPath() == rhs.saveAbsPath();
1035 bool operator!=(DocFileName const & lhs, DocFileName const & rhs)
1037 return !(lhs == rhs);
1040 } // namespace support