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/convert.h"
17 #include "support/debug.h"
18 #include "support/filetools.h"
19 #include "support/lstrings.h"
20 #include "support/qstring_helpers.h"
21 #include "support/os.h"
22 #include "support/Package.h"
23 #include "support/qstring_helpers.h"
30 #include <QTemporaryFile>
33 #include "support/lassert.h"
34 #include <boost/scoped_array.hpp>
41 #ifdef HAVE_SYS_TYPES_H
42 # include <sys/types.h>
44 #ifdef HAVE_SYS_STAT_H
45 # include <sys/stat.h>
65 #if defined(HAVE_MKSTEMP) && ! defined(HAVE_DECL_MKSTEMP)
66 extern "C" int mkstemp(char *);
69 #if !defined(HAVE_MKSTEMP) && defined(HAVE_MKTEMP)
73 # ifdef HAVE_PROCESS_H
84 /////////////////////////////////////////////////////////////////////
88 /////////////////////////////////////////////////////////////////////
90 struct FileName::Private
94 Private(string const & abs_filename) : fi(toqstr(abs_filename))
96 fi.setCaching(fi.exists() ? true : false);
101 // There seems to be a bug in Qt >= 4.2.0, at least, that causes problems with
102 // QFileInfo::refresh() on *nix. So we recreate the object in that case.
103 // FIXME: When Trolltech fixes the bug, we will have to replace 0x999999 below
104 // with the actual working minimum version.
105 #if defined(_WIN32) || (QT_VERSION >= 0x999999)
108 fi = QFileInfo(fi.absoluteFilePath());
115 /////////////////////////////////////////////////////////////////////
119 /////////////////////////////////////////////////////////////////////
122 FileName::FileName() : d(new Private)
127 FileName::FileName(string const & abs_filename)
128 : d(abs_filename.empty() ? new Private : new Private(abs_filename))
133 FileName::~FileName()
139 FileName::FileName(FileName const & rhs) : d(new Private)
145 FileName::FileName(FileName const & rhs, string const & suffix) : d(new Private)
151 FileName & FileName::operator=(FileName const & rhs)
158 bool FileName::empty() const
160 return d->fi.absoluteFilePath().isEmpty();
164 bool FileName::isAbsolute() const
166 return d->fi.isAbsolute();
170 string FileName::absFilename() const
172 return fromqstr(d->fi.absoluteFilePath());
176 void FileName::set(string const & name)
178 d->fi.setFile(toqstr(name));
182 void FileName::set(FileName const & rhs, string const & suffix)
184 if (!rhs.d->fi.isDir())
185 d->fi.setFile(rhs.d->fi.filePath() + toqstr(suffix));
187 d->fi.setFile(QDir(rhs.d->fi.absoluteFilePath()), toqstr(suffix));
191 void FileName::erase()
197 bool FileName::copyTo(FileName const & name) const
199 LYXERR(Debug::FILES, "Copying " << name);
200 QFile::remove(name.d->fi.absoluteFilePath());
201 bool success = QFile::copy(d->fi.absoluteFilePath(), name.d->fi.absoluteFilePath());
203 LYXERR0("FileName::copyTo(): Could not copy file "
204 << *this << " to " << name);
209 bool FileName::renameTo(FileName const & name) const
211 bool success = QFile::rename(d->fi.absoluteFilePath(), name.d->fi.absoluteFilePath());
213 LYXERR0("Could not rename file " << *this << " to " << name);
218 bool FileName::moveTo(FileName const & name) const
220 QFile::remove(name.d->fi.absoluteFilePath());
222 bool success = QFile::rename(d->fi.absoluteFilePath(),
223 name.d->fi.absoluteFilePath());
225 LYXERR0("Could not move file " << *this << " to " << name);
230 bool FileName::changePermission(unsigned long int mode) const
232 #if defined (HAVE_CHMOD) && defined (HAVE_MODE_T)
233 if (::chmod(toFilesystemEncoding().c_str(), mode_t(mode)) != 0) {
234 LYXERR0("File " << *this << ": cannot change permission to "
243 string FileName::toFilesystemEncoding() const
245 QByteArray const encoded = QFile::encodeName(d->fi.absoluteFilePath());
246 return string(encoded.begin(), encoded.end());
250 FileName FileName::fromFilesystemEncoding(string const & name)
252 QByteArray const encoded(name.c_str(), name.length());
253 return FileName(fromqstr(QFile::decodeName(encoded)));
257 bool FileName::exists() const
259 return d->fi.exists();
263 bool FileName::isSymLink() const
265 return d->fi.isSymLink();
269 bool FileName::isFileEmpty() const
271 return d->fi.size() == 0;
275 bool FileName::isDirectory() const
277 return d->fi.isDir();
281 bool FileName::isReadOnly() const
283 return d->fi.isReadable() && !d->fi.isWritable();
287 bool FileName::isReadableDirectory() const
289 return d->fi.isDir() && d->fi.isReadable();
293 string FileName::onlyFileName() const
295 return fromqstr(d->fi.fileName());
299 string FileName::onlyFileNameWithoutExt() const
301 return fromqstr(d->fi.baseName());
305 FileName FileName::onlyPath() const
308 path.d->fi.setFile(d->fi.path());
313 bool FileName::isReadableFile() const
315 return d->fi.isFile() && d->fi.isReadable();
319 bool FileName::isWritable() const
321 return d->fi.isWritable();
325 bool FileName::isDirWritable() const
327 LASSERT(d->fi.isDir(), return false);
328 QFileInfo tmp(d->fi.absoluteDir(), "lyxwritetest");
329 QTemporaryFile qt_tmp(tmp.absoluteFilePath());
331 LYXERR(Debug::FILES, "Directory " << *this << " is writable");
334 LYXERR(Debug::FILES, "Directory " << *this << " is not writable");
339 FileNameList FileName::dirList(string const & ext) const
341 FileNameList dirlist;
342 if (!isDirectory()) {
343 LYXERR0("Directory '" << *this << "' does not exist!");
347 QDir dir = d->fi.absoluteDir();
352 case '.': filter = "*" + toqstr(ext); break;
353 case '*': filter = toqstr(ext); break;
354 default: filter = "*." + toqstr(ext);
356 dir.setNameFilters(QStringList(filter));
357 LYXERR(Debug::FILES, "filtering on extension "
358 << fromqstr(filter) << " is requested.");
361 QFileInfoList list = dir.entryInfoList();
362 for (int i = 0; i != list.size(); ++i) {
363 FileName fi(fromqstr(list.at(i).absoluteFilePath()));
364 dirlist.push_back(fi);
365 LYXERR(Debug::FILES, "found file " << fi);
372 static string createTempFile(QString const & mask)
374 QTemporaryFile qt_tmp(mask);
376 string const temp_file = fromqstr(qt_tmp.fileName());
377 LYXERR(Debug::FILES, "Temporary file `" << temp_file << "' created.");
380 LYXERR(Debug::FILES, "Unable to create temporary file with following template: "
381 << qt_tmp.fileTemplate());
386 FileName FileName::tempName(FileName const & temp_dir, string const & mask)
388 QFileInfo tmp_fi(QDir(temp_dir.d->fi.absoluteFilePath()), toqstr(mask));
389 LYXERR(Debug::FILES, "Temporary file in " << tmp_fi.absoluteFilePath());
390 return FileName(createTempFile(tmp_fi.absoluteFilePath()));
394 FileName FileName::tempName(string const & mask)
396 QFileInfo tmp_fi(toqstr(mask));
397 if (!tmp_fi.isAbsolute())
398 tmp_fi.setFile(package().temp_dir().d->fi.absoluteDir(), toqstr(mask));
399 return FileName(createTempFile(tmp_fi.absoluteFilePath()));
403 FileName FileName::getcwd()
405 return FileName(".");
409 FileName FileName::tempPath()
411 return FileName(fromqstr(QDir::tempPath()));
415 time_t FileName::lastModified() const
417 // QFileInfo caches information about the file. So, in case this file has
418 // been touched between the object creation and now, we refresh the file
421 return d->fi.lastModified().toTime_t();
425 bool FileName::chdir() const
427 return QDir::setCurrent(d->fi.absoluteFilePath());
431 extern unsigned long sum(char const * file);
433 unsigned long FileName::checksum() const
436 //LYXERR0("File \"" << absFilename() << "\" does not exist!");
439 // a directory may be passed here so we need to test it. (bug 3622)
441 LYXERR0('"' << absFilename() << "\" is a directory!");
444 if (!lyxerr.debugging(Debug::FILES))
445 return sum(absFilename().c_str());
449 unsigned long r = sum(absFilename().c_str());
450 lyxerr << "Checksumming \"" << absFilename() << "\" lasted "
451 << t.elapsed() << " ms." << endl;
456 bool FileName::removeFile() const
458 bool const success = QFile::remove(d->fi.absoluteFilePath());
459 if (!success && exists())
460 LYXERR0("Could not delete file " << *this);
465 static bool rmdir(QFileInfo const & fi)
467 QDir dir(fi.absoluteFilePath());
468 QFileInfoList list = dir.entryInfoList();
470 for (int i = 0; i != list.size(); ++i) {
471 if (list.at(i).fileName() == ".")
473 if (list.at(i).fileName() == "..")
476 if (list.at(i).isDir()) {
477 LYXERR(Debug::FILES, "Removing dir "
478 << fromqstr(list.at(i).absoluteFilePath()));
479 removed = rmdir(list.at(i));
482 LYXERR(Debug::FILES, "Removing file "
483 << fromqstr(list.at(i).absoluteFilePath()));
484 removed = dir.remove(list.at(i).fileName());
488 LYXERR0("Could not delete "
489 << fromqstr(list.at(i).absoluteFilePath()));
492 QDir parent = fi.absolutePath();
493 success &= parent.rmdir(fi.fileName());
498 bool FileName::destroyDirectory() const
500 bool const success = rmdir(d->fi);
502 LYXERR0("Could not delete " << *this);
508 static int mymkdir(char const * pathname, unsigned long int mode)
510 // FIXME: why don't we have mode_t in lyx::mkdir prototype ??
512 # if MKDIR_TAKES_ONE_ARG
514 return ::mkdir(pathname);
515 // FIXME: "Permissions of created directories are ignored on this system."
518 return ::mkdir(pathname, mode_t(mode));
520 #elif defined(_WIN32)
522 return CreateDirectory(pathname, 0) != 0 ? 0 : -1;
523 // FIXME: "Permissions of created directories are ignored on this system."
525 return ::_mkdir(pathname);
526 // FIXME: "Permissions of created directories are ignored on this system."
528 # error "Don't know how to create a directory on this system."
534 bool FileName::createDirectory(int permission) const
536 LASSERT(!empty(), /**/);
537 return mymkdir(toFilesystemEncoding().c_str(), permission) == 0;
541 bool FileName::createPath() const
543 LASSERT(!empty(), /**/);
548 bool success = dir.mkpath(d->fi.absoluteFilePath());
550 LYXERR0("Cannot create path '" << *this << "'!");
555 docstring const FileName::absoluteFilePath() const
557 return qstring_to_ucs4(d->fi.absoluteFilePath());
561 docstring FileName::displayName(int threshold) const
563 return makeDisplayPath(absFilename(), threshold);
567 docstring FileName::fileContents(string const & encoding) const
569 if (!isReadableFile()) {
570 LYXERR0("File '" << *this << "' is not redable!");
574 QFile file(d->fi.absoluteFilePath());
575 if (!file.open(QIODevice::ReadOnly)) {
576 LYXERR0("File '" << *this
577 << "' could not be opened in read only mode!");
580 QByteArray contents = file.readAll();
583 if (contents.isEmpty()) {
584 LYXERR(Debug::FILES, "File '" << *this
585 << "' is either empty or some error happened while reading it.");
590 if (encoding.empty() || encoding == "UTF-8")
591 s = QString::fromUtf8(contents.data());
592 else if (encoding == "ascii")
593 s = QString::fromAscii(contents.data());
594 else if (encoding == "local8bit")
595 s = QString::fromLocal8Bit(contents.data());
596 else if (encoding == "latin1")
597 s = QString::fromLatin1(contents.data());
599 return qstring_to_ucs4(s);
603 void FileName::changeExtension(string const & extension)
605 // FIXME: use Qt native methods...
606 string const oldname = absFilename();
607 string::size_type const last_slash = oldname.rfind('/');
608 string::size_type last_dot = oldname.rfind('.');
609 if (last_dot < last_slash && last_slash != string::npos)
610 last_dot = string::npos;
613 // Make sure the extension starts with a dot
614 if (!extension.empty() && extension[0] != '.')
615 ext= '.' + extension;
619 set(oldname.substr(0, last_dot) + ext);
623 string FileName::guessFormatFromContents() const
625 // the different filetypes and what they contain in one of the first lines
626 // (dots are any characters). (Herbert 20020131)
629 // EPS %!PS-Adobe-3.0 EPSF...
636 // PBM P1... or P4 (B/W)
637 // PGM P2... or P5 (Grayscale)
638 // PPM P3... or P6 (color)
639 // PS %!PS-Adobe-2.0 or 1.0, no "EPSF"!
640 // SGI \001\332... (decimal 474)
642 // TIFF II... or MM...
644 // XPM /* XPM */ sometimes missing (f.ex. tgif-export)
645 // ...static char *...
646 // XWD \000\000\000\151 (0x00006900) decimal 105
648 // GZIP \037\213 http://www.ietf.org/rfc/rfc1952.txt
649 // ZIP PK... http://www.halyava.ru/document/ind_arch.htm
650 // Z \037\235 UNIX compress
653 if (empty() || !isReadableFile())
656 ifstream ifs(toFilesystemEncoding().c_str());
658 // Couldn't open file...
662 static string const gzipStamp = "\037\213";
665 static string const zipStamp = "PK";
668 static string const compressStamp = "\037\235";
670 // Maximum strings to read
671 int const max_count = 50;
676 bool firstLine = true;
677 while ((count++ < max_count) && format.empty()) {
679 LYXERR(Debug::GRAPHICS, "filetools(getFormatFromContents)\n"
680 << "\tFile type not recognised before EOF!");
685 string const stamp = str.substr(0, 2);
686 if (firstLine && str.size() >= 2) {
687 // at first we check for a zipped file, because this
688 // information is saved in the first bytes of the file!
689 // also some graphic formats which save the information
690 // in the first line, too.
691 if (prefixIs(str, gzipStamp)) {
694 } else if (stamp == zipStamp) {
697 } else if (stamp == compressStamp) {
701 } else if (stamp == "BM") {
704 } else if (stamp == "\001\332") {
708 // Don't need to use str.at(0), str.at(1) because
709 // we already know that str.size() >= 2
710 } else if (str[0] == 'P') {
726 } else if ((stamp == "II") || (stamp == "MM")) {
729 } else if (prefixIs(str,"%TGIF")) {
732 } else if (prefixIs(str,"#FIG")) {
735 } else if (prefixIs(str,"GIF")) {
738 } else if (str.size() > 3) {
739 int const c = ((str[0] << 24) & (str[1] << 16) &
740 (str[2] << 8) & str[3]);
751 else if (contains(str,"EPSF"))
752 // dummy, if we have wrong file description like
753 // %!PS-Adobe-2.0EPSF"
756 else if (contains(str, "Grace"))
759 else if (contains(str, "JFIF"))
762 else if (contains(str, "%PDF"))
765 else if (contains(str, "PNG"))
768 else if (contains(str, "%!PS-Adobe")) {
771 if (contains(str,"EPSF"))
777 else if (contains(str, "_bits[]"))
780 else if (contains(str, "XPM") || contains(str, "static char *"))
783 else if (contains(str, "BITPIX"))
787 if (!format.empty()) {
788 LYXERR(Debug::GRAPHICS, "Recognised Fileformat: " << format);
792 LYXERR(Debug::GRAPHICS, "filetools(getFormatFromContents)\n"
793 << "\tCouldn't find a known format!");
798 bool FileName::isZippedFile() const
800 string const type = guessFormatFromContents();
801 return contains("gzip zip compress", type) && !type.empty();
805 docstring const FileName::relPath(string const & path) const
808 return makeRelPath(absoluteFilePath(), from_utf8(path));
812 bool operator==(FileName const & lhs, FileName const & rhs)
814 // FIXME: We need to solve this warning from Qt documentation:
815 // * Long and short file names that refer to the same file on Windows are
816 // treated as if they referred to different files.
820 if (!lhs.d->fi.isSymLink() && !rhs.d->fi.isSymLink())
821 return lhs.d->fi == rhs.d->fi;
823 QFileInfo fi1(lhs.d->fi);
825 fi1 = QFileInfo(fi1.symLinkTarget());
826 QFileInfo fi2(rhs.d->fi);
828 fi2 = QFileInfo(fi2.symLinkTarget());
833 bool operator!=(FileName const & lhs, FileName const & rhs)
835 return !(operator==(lhs, rhs));
839 bool operator<(FileName const & lhs, FileName const & rhs)
841 return lhs.absFilename() < rhs.absFilename();
845 bool operator>(FileName const & lhs, FileName const & rhs)
847 return lhs.absFilename() > rhs.absFilename();
851 ostream & operator<<(ostream & os, FileName const & filename)
853 return os << filename.absFilename();
857 /////////////////////////////////////////////////////////////////////
861 /////////////////////////////////////////////////////////////////////
864 DocFileName::DocFileName()
865 : save_abs_path_(true)
869 DocFileName::DocFileName(string const & abs_filename, bool save_abs)
870 : FileName(abs_filename), save_abs_path_(save_abs), zipped_valid_(false)
874 DocFileName::DocFileName(FileName const & abs_filename, bool save_abs)
875 : FileName(abs_filename), save_abs_path_(save_abs), zipped_valid_(false)
879 void DocFileName::set(string const & name, string const & buffer_path)
882 bool const nameIsAbsolute = isAbsolute();
883 save_abs_path_ = nameIsAbsolute;
885 FileName::set(makeAbsPath(name, buffer_path).absFilename());
886 zipped_valid_ = false;
890 void DocFileName::erase()
893 zipped_valid_ = false;
897 string DocFileName::relFilename(string const & path) const
900 return to_utf8(relPath(path));
904 string DocFileName::outputFilename(string const & path) const
906 return save_abs_path_ ? absFilename() : relFilename(path);
910 string DocFileName::mangledFilename(string const & dir) const
912 // We need to make sure that every DocFileName instance for a given
913 // filename returns the same mangled name.
914 typedef map<string, string> MangledMap;
915 static MangledMap mangledNames;
916 MangledMap::const_iterator const it = mangledNames.find(absFilename());
917 if (it != mangledNames.end())
920 string const name = absFilename();
922 string mname = os::internal_path(name);
923 // Remove the extension.
924 mname = support::changeExtension(name, string());
925 // The mangled name must be a valid LaTeX name.
926 // The list of characters to keep is probably over-restrictive,
927 // but it is not really a problem.
928 // Apart from non-ASCII characters, at least the following characters
929 // are forbidden: '/', '.', ' ', and ':'.
930 // On windows it is not possible to create files with '<', '>' or '?'
932 static string const keep = "abcdefghijklmnopqrstuvwxyz"
933 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
935 string::size_type pos = 0;
936 while ((pos = mname.find_first_not_of(keep, pos)) != string::npos)
938 // Add the extension back on
939 mname = support::changeExtension(mname, getExtension(name));
941 // Prepend a counter to the filename. This is necessary to make
942 // the mangled name unique.
943 static int counter = 0;
945 s << counter++ << mname;
948 // MiKTeX's YAP (version 2.4.1803) crashes if the file name
949 // is longer than about 160 characters. MiKTeX's pdflatex
950 // is even pickier. A maximum length of 100 has been proven to work.
951 // If dir.size() > max length, all bets are off for YAP. We truncate
952 // the filename nevertheless, keeping a minimum of 10 chars.
954 string::size_type max_length = max(100 - ((int)dir.size() + 1), 10);
956 // If the mangled file name is too long, hack it to fit.
957 // We know we're guaranteed to have a unique file name because
959 if (mname.size() > max_length) {
960 int const half = (int(max_length) / 2) - 2;
962 mname = mname.substr(0, half) + "___" +
963 mname.substr(mname.size() - half);
967 mangledNames[absFilename()] = mname;
972 bool DocFileName::isZipped() const
974 if (!zipped_valid_) {
975 zipped_ = isZippedFile();
976 zipped_valid_ = true;
982 string DocFileName::unzippedFilename() const
984 return unzippedFileName(absFilename());
988 bool operator==(DocFileName const & lhs, DocFileName const & rhs)
990 return static_cast<FileName const &>(lhs)
991 == static_cast<FileName const &>(rhs)
992 && lhs.saveAbsPath() == rhs.saveAbsPath();
996 bool operator!=(DocFileName const & lhs, DocFileName const & rhs)
998 return !(lhs == rhs);
1001 } // namespace support