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 string FileName::extension() const
307 return fromqstr(d->fi.suffix());
311 FileName FileName::onlyPath() const
314 path.d->fi.setFile(d->fi.path());
319 bool FileName::isReadableFile() const
321 return d->fi.isFile() && d->fi.isReadable();
325 bool FileName::isWritable() const
327 return d->fi.isWritable();
331 bool FileName::isDirWritable() const
333 LASSERT(d->fi.isDir(), return false);
334 QFileInfo tmp(d->fi.absoluteDir(), "lyxwritetest");
335 QTemporaryFile qt_tmp(tmp.absoluteFilePath());
337 LYXERR(Debug::FILES, "Directory " << *this << " is writable");
340 LYXERR(Debug::FILES, "Directory " << *this << " is not writable");
345 FileNameList FileName::dirList(string const & ext) const
347 FileNameList dirlist;
348 if (!isDirectory()) {
349 LYXERR0("Directory '" << *this << "' does not exist!");
353 QDir dir = d->fi.absoluteDir();
358 case '.': filter = "*" + toqstr(ext); break;
359 case '*': filter = toqstr(ext); break;
360 default: filter = "*." + toqstr(ext);
362 dir.setNameFilters(QStringList(filter));
363 LYXERR(Debug::FILES, "filtering on extension "
364 << fromqstr(filter) << " is requested.");
367 QFileInfoList list = dir.entryInfoList();
368 for (int i = 0; i != list.size(); ++i) {
369 FileName fi(fromqstr(list.at(i).absoluteFilePath()));
370 dirlist.push_back(fi);
371 LYXERR(Debug::FILES, "found file " << fi);
378 static string createTempFile(QString const & mask)
380 QTemporaryFile qt_tmp(mask);
382 string const temp_file = fromqstr(qt_tmp.fileName());
383 LYXERR(Debug::FILES, "Temporary file `" << temp_file << "' created.");
386 LYXERR(Debug::FILES, "Unable to create temporary file with following template: "
387 << qt_tmp.fileTemplate());
392 FileName FileName::tempName(FileName const & temp_dir, string const & mask)
394 QFileInfo tmp_fi(QDir(temp_dir.d->fi.absoluteFilePath()), toqstr(mask));
395 LYXERR(Debug::FILES, "Temporary file in " << tmp_fi.absoluteFilePath());
396 return FileName(createTempFile(tmp_fi.absoluteFilePath()));
400 FileName FileName::tempName(string const & mask)
402 return tempName(package().temp_dir(), mask);
406 FileName FileName::getcwd()
408 return FileName(".");
412 FileName FileName::tempPath()
414 return FileName(fromqstr(QDir::tempPath()));
418 time_t FileName::lastModified() const
420 // QFileInfo caches information about the file. So, in case this file has
421 // been touched between the object creation and now, we refresh the file
424 return d->fi.lastModified().toTime_t();
428 bool FileName::chdir() const
430 return QDir::setCurrent(d->fi.absoluteFilePath());
434 extern unsigned long sum(char const * file);
436 unsigned long FileName::checksum() const
439 //LYXERR0("File \"" << absFilename() << "\" does not exist!");
442 // a directory may be passed here so we need to test it. (bug 3622)
444 LYXERR0('"' << absFilename() << "\" is a directory!");
447 if (!lyxerr.debugging(Debug::FILES))
448 return sum(absFilename().c_str());
452 unsigned long r = sum(absFilename().c_str());
453 lyxerr << "Checksumming \"" << absFilename() << "\" lasted "
454 << t.elapsed() << " ms." << endl;
459 bool FileName::removeFile() const
461 bool const success = QFile::remove(d->fi.absoluteFilePath());
462 if (!success && exists())
463 LYXERR0("Could not delete file " << *this);
468 static bool rmdir(QFileInfo const & fi)
470 QDir dir(fi.absoluteFilePath());
471 QFileInfoList list = dir.entryInfoList();
473 for (int i = 0; i != list.size(); ++i) {
474 if (list.at(i).fileName() == ".")
476 if (list.at(i).fileName() == "..")
479 if (list.at(i).isDir()) {
480 LYXERR(Debug::FILES, "Removing dir "
481 << fromqstr(list.at(i).absoluteFilePath()));
482 removed = rmdir(list.at(i));
485 LYXERR(Debug::FILES, "Removing file "
486 << fromqstr(list.at(i).absoluteFilePath()));
487 removed = dir.remove(list.at(i).fileName());
491 LYXERR0("Could not delete "
492 << fromqstr(list.at(i).absoluteFilePath()));
495 QDir parent = fi.absolutePath();
496 success &= parent.rmdir(fi.fileName());
501 bool FileName::destroyDirectory() const
503 bool const success = rmdir(d->fi);
505 LYXERR0("Could not delete " << *this);
511 static int mymkdir(char const * pathname, unsigned long int mode)
513 // FIXME: why don't we have mode_t in lyx::mkdir prototype ??
515 # if MKDIR_TAKES_ONE_ARG
517 return ::mkdir(pathname);
518 // FIXME: "Permissions of created directories are ignored on this system."
521 return ::mkdir(pathname, mode_t(mode));
523 #elif defined(_WIN32)
525 return CreateDirectory(pathname, 0) != 0 ? 0 : -1;
526 // FIXME: "Permissions of created directories are ignored on this system."
528 return ::_mkdir(pathname);
529 // FIXME: "Permissions of created directories are ignored on this system."
531 # error "Don't know how to create a directory on this system."
537 bool FileName::createDirectory(int permission) const
539 LASSERT(!empty(), /**/);
540 return mymkdir(toFilesystemEncoding().c_str(), permission) == 0;
544 bool FileName::createPath() const
546 LASSERT(!empty(), /**/);
551 bool success = dir.mkpath(d->fi.absoluteFilePath());
553 LYXERR0("Cannot create path '" << *this << "'!");
558 docstring const FileName::absoluteFilePath() const
560 return qstring_to_ucs4(d->fi.absoluteFilePath());
564 docstring FileName::displayName(int threshold) const
566 return makeDisplayPath(absFilename(), threshold);
570 docstring FileName::fileContents(string const & encoding) const
572 if (!isReadableFile()) {
573 LYXERR0("File '" << *this << "' is not redable!");
577 QFile file(d->fi.absoluteFilePath());
578 if (!file.open(QIODevice::ReadOnly)) {
579 LYXERR0("File '" << *this
580 << "' could not be opened in read only mode!");
583 QByteArray contents = file.readAll();
586 if (contents.isEmpty()) {
587 LYXERR(Debug::FILES, "File '" << *this
588 << "' is either empty or some error happened while reading it.");
593 if (encoding.empty() || encoding == "UTF-8")
594 s = QString::fromUtf8(contents.data());
595 else if (encoding == "ascii")
596 s = QString::fromAscii(contents.data());
597 else if (encoding == "local8bit")
598 s = QString::fromLocal8Bit(contents.data());
599 else if (encoding == "latin1")
600 s = QString::fromLatin1(contents.data());
602 return qstring_to_ucs4(s);
606 void FileName::changeExtension(string const & extension)
608 // FIXME: use Qt native methods...
609 string const oldname = absFilename();
610 string::size_type const last_slash = oldname.rfind('/');
611 string::size_type last_dot = oldname.rfind('.');
612 if (last_dot < last_slash && last_slash != string::npos)
613 last_dot = string::npos;
616 // Make sure the extension starts with a dot
617 if (!extension.empty() && extension[0] != '.')
618 ext= '.' + extension;
622 set(oldname.substr(0, last_dot) + ext);
626 string FileName::guessFormatFromContents() const
628 // the different filetypes and what they contain in one of the first lines
629 // (dots are any characters). (Herbert 20020131)
632 // EPS %!PS-Adobe-3.0 EPSF...
639 // PBM P1... or P4 (B/W)
640 // PGM P2... or P5 (Grayscale)
641 // PPM P3... or P6 (color)
642 // PS %!PS-Adobe-2.0 or 1.0, no "EPSF"!
643 // SGI \001\332... (decimal 474)
645 // TIFF II... or MM...
647 // XPM /* XPM */ sometimes missing (f.ex. tgif-export)
648 // ...static char *...
649 // XWD \000\000\000\151 (0x00006900) decimal 105
651 // GZIP \037\213 http://www.ietf.org/rfc/rfc1952.txt
652 // ZIP PK... http://www.halyava.ru/document/ind_arch.htm
653 // Z \037\235 UNIX compress
656 if (empty() || !isReadableFile())
659 ifstream ifs(toFilesystemEncoding().c_str());
661 // Couldn't open file...
665 static string const gzipStamp = "\037\213";
668 static string const zipStamp = "PK";
671 static string const compressStamp = "\037\235";
673 // Maximum strings to read
674 int const max_count = 50;
679 bool firstLine = true;
680 while ((count++ < max_count) && format.empty()) {
682 LYXERR(Debug::GRAPHICS, "filetools(getFormatFromContents)\n"
683 << "\tFile type not recognised before EOF!");
688 string const stamp = str.substr(0, 2);
689 if (firstLine && str.size() >= 2) {
690 // at first we check for a zipped file, because this
691 // information is saved in the first bytes of the file!
692 // also some graphic formats which save the information
693 // in the first line, too.
694 if (prefixIs(str, gzipStamp)) {
697 } else if (stamp == zipStamp) {
700 } else if (stamp == compressStamp) {
704 } else if (stamp == "BM") {
707 } else if (stamp == "\001\332") {
711 // Don't need to use str.at(0), str.at(1) because
712 // we already know that str.size() >= 2
713 } else if (str[0] == 'P') {
729 } else if ((stamp == "II") || (stamp == "MM")) {
732 } else if (prefixIs(str,"%TGIF")) {
735 } else if (prefixIs(str,"#FIG")) {
738 } else if (prefixIs(str,"GIF")) {
741 } else if (str.size() > 3) {
742 int const c = ((str[0] << 24) & (str[1] << 16) &
743 (str[2] << 8) & str[3]);
754 else if (contains(str,"EPSF"))
755 // dummy, if we have wrong file description like
756 // %!PS-Adobe-2.0EPSF"
759 else if (contains(str, "Grace"))
762 else if (contains(str, "JFIF"))
765 else if (contains(str, "%PDF"))
768 else if (contains(str, "PNG"))
771 else if (contains(str, "%!PS-Adobe")) {
774 if (contains(str,"EPSF"))
780 else if (contains(str, "_bits[]"))
783 else if (contains(str, "XPM") || contains(str, "static char *"))
786 else if (contains(str, "BITPIX"))
790 if (!format.empty()) {
791 LYXERR(Debug::GRAPHICS, "Recognised Fileformat: " << format);
795 LYXERR(Debug::GRAPHICS, "filetools(getFormatFromContents)\n"
796 << "\tCouldn't find a known format!");
801 bool FileName::isZippedFile() const
803 string const type = guessFormatFromContents();
804 return contains("gzip zip compress", type) && !type.empty();
808 docstring const FileName::relPath(string const & path) const
811 return makeRelPath(absoluteFilePath(), from_utf8(path));
815 bool operator==(FileName const & lhs, FileName const & rhs)
817 // FIXME: We need to solve this warning from Qt documentation:
818 // * Long and short file names that refer to the same file on Windows are
819 // treated as if they referred to different files.
820 // This is supposed to be fixed for Qt5.
823 // QFileInfo::operator==() returns false if the two QFileInfo are empty.
827 // Avoid unnecessary checks below.
833 if (!lhs.d->fi.isSymLink() && !rhs.d->fi.isSymLink())
834 return lhs.d->fi == rhs.d->fi;
836 // FIXME: When/if QFileInfo support symlink comparison, remove this code.
837 QFileInfo fi1(lhs.d->fi);
839 fi1 = QFileInfo(fi1.symLinkTarget());
840 QFileInfo fi2(rhs.d->fi);
842 fi2 = QFileInfo(fi2.symLinkTarget());
847 bool operator!=(FileName const & lhs, FileName const & rhs)
849 return !(operator==(lhs, rhs));
853 bool operator<(FileName const & lhs, FileName const & rhs)
855 return lhs.absFilename() < rhs.absFilename();
859 bool operator>(FileName const & lhs, FileName const & rhs)
861 return lhs.absFilename() > rhs.absFilename();
865 ostream & operator<<(ostream & os, FileName const & filename)
867 return os << filename.absFilename();
871 /////////////////////////////////////////////////////////////////////
875 /////////////////////////////////////////////////////////////////////
878 DocFileName::DocFileName()
879 : save_abs_path_(true)
883 DocFileName::DocFileName(string const & abs_filename, bool save_abs)
884 : FileName(abs_filename), save_abs_path_(save_abs), zipped_valid_(false)
888 DocFileName::DocFileName(FileName const & abs_filename, bool save_abs)
889 : FileName(abs_filename), save_abs_path_(save_abs), zipped_valid_(false)
893 void DocFileName::set(string const & name, string const & buffer_path)
896 bool const nameIsAbsolute = isAbsolute();
897 save_abs_path_ = nameIsAbsolute;
899 FileName::set(makeAbsPath(name, buffer_path).absFilename());
900 zipped_valid_ = false;
904 void DocFileName::erase()
907 zipped_valid_ = false;
911 string DocFileName::relFilename(string const & path) const
914 return to_utf8(relPath(path));
918 string DocFileName::outputFilename(string const & path) const
920 return save_abs_path_ ? absFilename() : relFilename(path);
924 string DocFileName::mangledFilename(string const & dir) const
926 // We need to make sure that every DocFileName instance for a given
927 // filename returns the same mangled name.
928 typedef map<string, string> MangledMap;
929 static MangledMap mangledNames;
930 MangledMap::const_iterator const it = mangledNames.find(absFilename());
931 if (it != mangledNames.end())
934 string const name = absFilename();
936 string mname = os::internal_path(name);
937 // Remove the extension.
938 mname = support::changeExtension(name, string());
939 // The mangled name must be a valid LaTeX name.
940 // The list of characters to keep is probably over-restrictive,
941 // but it is not really a problem.
942 // Apart from non-ASCII characters, at least the following characters
943 // are forbidden: '/', '.', ' ', and ':'.
944 // On windows it is not possible to create files with '<', '>' or '?'
946 static string const keep = "abcdefghijklmnopqrstuvwxyz"
947 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
949 string::size_type pos = 0;
950 while ((pos = mname.find_first_not_of(keep, pos)) != string::npos)
952 // Add the extension back on
953 mname = support::changeExtension(mname, getExtension(name));
955 // Prepend a counter to the filename. This is necessary to make
956 // the mangled name unique.
957 static int counter = 0;
959 s << counter++ << mname;
962 // MiKTeX's YAP (version 2.4.1803) crashes if the file name
963 // is longer than about 160 characters. MiKTeX's pdflatex
964 // is even pickier. A maximum length of 100 has been proven to work.
965 // If dir.size() > max length, all bets are off for YAP. We truncate
966 // the filename nevertheless, keeping a minimum of 10 chars.
968 string::size_type max_length = max(100 - ((int)dir.size() + 1), 10);
970 // If the mangled file name is too long, hack it to fit.
971 // We know we're guaranteed to have a unique file name because
973 if (mname.size() > max_length) {
974 int const half = (int(max_length) / 2) - 2;
976 mname = mname.substr(0, half) + "___" +
977 mname.substr(mname.size() - half);
981 mangledNames[absFilename()] = mname;
986 bool DocFileName::isZipped() const
988 if (!zipped_valid_) {
989 zipped_ = isZippedFile();
990 zipped_valid_ = true;
996 string DocFileName::unzippedFilename() const
998 return unzippedFileName(absFilename());
1002 bool operator==(DocFileName const & lhs, DocFileName const & rhs)
1004 return static_cast<FileName const &>(lhs)
1005 == static_cast<FileName const &>(rhs)
1006 && lhs.saveAbsPath() == rhs.saveAbsPath();
1010 bool operator!=(DocFileName const & lhs, DocFileName const & rhs)
1012 return !(lhs == rhs);
1015 } // namespace support