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/os.h"
21 #include "support/Package.h"
22 #include "support/qstring_helpers.h"
31 #include "support/assert.h"
32 #include <boost/scoped_array.hpp>
39 #ifdef HAVE_SYS_TYPES_H
40 # include <sys/types.h>
42 #ifdef HAVE_SYS_STAT_H
43 # include <sys/stat.h>
63 #if defined(HAVE_MKSTEMP) && ! defined(HAVE_DECL_MKSTEMP)
64 extern "C" int mkstemp(char *);
67 #if !defined(HAVE_MKSTEMP) && defined(HAVE_MKTEMP)
71 # ifdef HAVE_PROCESS_H
82 /////////////////////////////////////////////////////////////////////
86 /////////////////////////////////////////////////////////////////////
88 struct FileName::Private
92 Private(string const & abs_filename) : fi(toqstr(abs_filename))
94 fi.setCaching(fi.exists() ? true : false);
100 /////////////////////////////////////////////////////////////////////
104 /////////////////////////////////////////////////////////////////////
107 FileName::FileName() : d(new Private)
112 FileName::FileName(string const & abs_filename)
113 : d(abs_filename.empty() ? new Private : new Private(abs_filename))
118 FileName::~FileName()
124 FileName::FileName(FileName const & rhs) : d(new Private)
130 FileName & FileName::operator=(FileName const & rhs)
137 bool FileName::empty() const
139 return d->fi.absoluteFilePath().isEmpty();
143 bool FileName::isAbsolute() const
145 return d->fi.isAbsolute();
149 string FileName::absFilename() const
151 return fromqstr(d->fi.absoluteFilePath());
155 void FileName::set(string const & name)
157 d->fi.setFile(toqstr(name));
161 void FileName::erase()
167 bool FileName::copyTo(FileName const & name) const
169 QFile::remove(name.d->fi.absoluteFilePath());
170 bool success = QFile::copy(d->fi.absoluteFilePath(), name.d->fi.absoluteFilePath());
172 lyxerr << "FileName::copyTo(): Could not copy file "
173 << *this << " to " << name << endl;
178 bool FileName::renameTo(FileName const & name) const
180 bool success = QFile::rename(d->fi.absoluteFilePath(), name.d->fi.absoluteFilePath());
182 LYXERR0("Could not rename file " << *this << " to " << name);
187 bool FileName::moveTo(FileName const & name) const
189 QFile::remove(name.d->fi.absoluteFilePath());
191 bool success = QFile::rename(d->fi.absoluteFilePath(),
192 name.d->fi.absoluteFilePath());
194 LYXERR0("Could not move file " << *this << " to " << name);
199 bool FileName::changePermission(unsigned long int mode) const
201 #if defined (HAVE_CHMOD) && defined (HAVE_MODE_T)
202 if (::chmod(toFilesystemEncoding().c_str(), mode_t(mode)) != 0) {
203 LYXERR0("File " << *this << ": cannot change permission to "
212 string FileName::toFilesystemEncoding() const
214 QByteArray const encoded = QFile::encodeName(d->fi.absoluteFilePath());
215 return string(encoded.begin(), encoded.end());
219 FileName FileName::fromFilesystemEncoding(string const & name)
221 QByteArray const encoded(name.c_str(), name.length());
222 return FileName(fromqstr(QFile::decodeName(encoded)));
226 bool FileName::exists() const
228 return d->fi.exists();
232 bool FileName::isSymLink() const
234 return d->fi.isSymLink();
238 bool FileName::isFileEmpty() const
240 return d->fi.size() == 0;
244 bool FileName::isDirectory() const
246 return d->fi.isDir();
250 bool FileName::isReadOnly() const
252 return d->fi.isReadable() && !d->fi.isWritable();
256 bool FileName::isReadableDirectory() const
258 return d->fi.isDir() && d->fi.isReadable();
262 string FileName::onlyFileName() const
264 return fromqstr(d->fi.fileName());
268 FileName FileName::onlyPath() const
271 path.d->fi.setFile(d->fi.path());
276 bool FileName::isReadableFile() const
278 return d->fi.isFile() && d->fi.isReadable();
282 bool FileName::isWritable() const
284 return d->fi.isWritable();
288 bool FileName::isDirWritable() const
290 LYXERR(Debug::FILES, "isDirWriteable: " << *this);
292 FileName const tmpfl = FileName::tempName(absFilename() + "/lyxwritetest");
302 FileNameList FileName::dirList(string const & ext) const
304 FileNameList dirlist;
305 if (!isDirectory()) {
306 LYXERR0("Directory '" << *this << "' does not exist!");
310 QDir dir = d->fi.absoluteDir();
315 case '.': filter = "*" + toqstr(ext); break;
316 case '*': filter = toqstr(ext); break;
317 default: filter = "*." + toqstr(ext);
319 dir.setNameFilters(QStringList(filter));
320 LYXERR(Debug::FILES, "filtering on extension "
321 << fromqstr(filter) << " is requested.");
324 QFileInfoList list = dir.entryInfoList();
325 for (int i = 0; i != list.size(); ++i) {
326 FileName fi(fromqstr(list.at(i).absoluteFilePath()));
327 dirlist.push_back(fi);
328 LYXERR(Debug::FILES, "found file " << fi);
335 static int make_tempfile(char * templ)
337 #if defined(HAVE_MKSTEMP)
338 return ::mkstemp(templ);
339 #elif defined(HAVE_MKTEMP)
340 // This probably just barely works...
342 # if defined (HAVE_OPEN)
343 # if (!defined S_IRUSR)
344 # define S_IRUSR S_IREAD
345 # define S_IWUSR S_IWRITE
347 return ::open(templ, O_RDWR | O_CREAT | O_EXCL, S_IRUSR | S_IWUSR);
348 # elif defined (HAVE__OPEN)
349 return ::_open(templ,
350 _O_RDWR | _O_CREAT | _O_EXCL,
351 _S_IREAD | _S_IWRITE);
353 # error No open() function.
361 FileName FileName::tempName(string const & mask)
363 FileName tmp_name(mask);
365 if (tmp_name.d->fi.isAbsolute())
368 tmpfl = package().temp_dir().absFilename() + "/" + mask;
370 #if defined (HAVE_GETPID)
371 tmpfl += convert<string>(getpid());
372 #elif defined (HAVE__GETPID)
373 tmpfl += convert<string>(_getpid());
375 # error No getpid() function
379 // The supposedly safe mkstemp version
380 // FIXME: why not using std::string directly?
381 boost::scoped_array<char> tmpl(new char[tmpfl.length() + 1]); // + 1 for '\0'
382 tmpfl.copy(tmpl.get(), string::npos);
383 tmpl[tmpfl.length()] = '\0'; // terminator
385 int const tmpf = make_tempfile(tmpl.get());
387 string const t(to_utf8(from_filesystem8bit(tmpl.get())));
388 #if defined (HAVE_CLOSE)
390 #elif defined (HAVE__CLOSE)
393 # error No x() function.
395 LYXERR(Debug::FILES, "Temporary file `" << t << "' created.");
398 LYXERR(Debug::FILES, "LyX Error: Unable to create temporary file.");
403 FileName FileName::getcwd()
405 return FileName(".");
409 time_t FileName::lastModified() const
411 return d->fi.lastModified().toTime_t();
415 bool FileName::chdir() const
417 return QDir::setCurrent(d->fi.absoluteFilePath());
421 extern unsigned long sum(char const * file);
423 unsigned long FileName::checksum() const
426 //LYXERR0("File \"" << absFilename() << "\" does not exist!");
429 // a directory may be passed here so we need to test it. (bug 3622)
431 LYXERR0('"' << absFilename() << "\" is a directory!");
434 if (!lyxerr.debugging(Debug::FILES))
435 return sum(absFilename().c_str());
439 unsigned long r = sum(absFilename().c_str());
440 lyxerr << "Checksumming \"" << absFilename() << "\" lasted "
441 << t.elapsed() << " ms." << endl;
446 bool FileName::removeFile() const
448 bool const success = QFile::remove(d->fi.absoluteFilePath());
449 if (!success && exists())
450 LYXERR0("Could not delete file " << *this);
455 static bool rmdir(QFileInfo const & fi)
457 QDir dir(fi.absoluteFilePath());
458 QFileInfoList list = dir.entryInfoList();
460 for (int i = 0; i != list.size(); ++i) {
461 if (list.at(i).fileName() == ".")
463 if (list.at(i).fileName() == "..")
466 if (list.at(i).isDir()) {
467 LYXERR(Debug::FILES, "Removing dir "
468 << fromqstr(list.at(i).absoluteFilePath()));
469 removed = rmdir(list.at(i));
472 LYXERR(Debug::FILES, "Removing file "
473 << fromqstr(list.at(i).absoluteFilePath()));
474 removed = dir.remove(list.at(i).fileName());
478 LYXERR0("Could not delete "
479 << fromqstr(list.at(i).absoluteFilePath()));
482 QDir parent = fi.absolutePath();
483 success &= parent.rmdir(fi.fileName());
488 bool FileName::destroyDirectory() const
490 bool const success = rmdir(d->fi);
492 LYXERR0("Could not delete " << *this);
498 static int mymkdir(char const * pathname, unsigned long int mode)
500 // FIXME: why don't we have mode_t in lyx::mkdir prototype ??
502 # if MKDIR_TAKES_ONE_ARG
504 return ::mkdir(pathname);
505 // FIXME: "Permissions of created directories are ignored on this system."
508 return ::mkdir(pathname, mode_t(mode));
510 #elif defined(_WIN32)
512 return CreateDirectory(pathname, 0) != 0 ? 0 : -1;
513 // FIXME: "Permissions of created directories are ignored on this system."
515 return ::_mkdir(pathname);
516 // FIXME: "Permissions of created directories are ignored on this system."
518 # error "Don't know how to create a directory on this system."
524 bool FileName::createDirectory(int permission) const
526 LASSERT(!empty(), /**/);
527 return mymkdir(toFilesystemEncoding().c_str(), permission) == 0;
531 bool FileName::createPath() const
533 LASSERT(!empty(), /**/);
538 bool success = dir.mkpath(d->fi.absoluteFilePath());
540 LYXERR0("Cannot create path '" << *this << "'!");
545 docstring const FileName::absoluteFilePath() const
547 return qstring_to_ucs4(d->fi.absoluteFilePath());
551 docstring FileName::displayName(int threshold) const
553 return makeDisplayPath(absFilename(), threshold);
557 docstring FileName::fileContents(string const & encoding) const
559 if (!isReadableFile()) {
560 LYXERR0("File '" << *this << "' is not redable!");
564 QFile file(d->fi.absoluteFilePath());
565 if (!file.open(QIODevice::ReadOnly)) {
566 LYXERR0("File '" << *this
567 << "' could not be opened in read only mode!");
570 QByteArray contents = file.readAll();
573 if (contents.isEmpty()) {
574 LYXERR(Debug::FILES, "File '" << *this
575 << "' is either empty or some error happened while reading it.");
580 if (encoding.empty() || encoding == "UTF-8")
581 s = QString::fromUtf8(contents.data());
582 else if (encoding == "ascii")
583 s = QString::fromAscii(contents.data());
584 else if (encoding == "local8bit")
585 s = QString::fromLocal8Bit(contents.data());
586 else if (encoding == "latin1")
587 s = QString::fromLatin1(contents.data());
589 return qstring_to_ucs4(s);
593 void FileName::changeExtension(string const & extension)
595 // FIXME: use Qt native methods...
596 string const oldname = absFilename();
597 string::size_type const last_slash = oldname.rfind('/');
598 string::size_type last_dot = oldname.rfind('.');
599 if (last_dot < last_slash && last_slash != string::npos)
600 last_dot = string::npos;
603 // Make sure the extension starts with a dot
604 if (!extension.empty() && extension[0] != '.')
605 ext= '.' + extension;
609 set(oldname.substr(0, last_dot) + ext);
613 string FileName::guessFormatFromContents() const
615 // the different filetypes and what they contain in one of the first lines
616 // (dots are any characters). (Herbert 20020131)
619 // EPS %!PS-Adobe-3.0 EPSF...
626 // PBM P1... or P4 (B/W)
627 // PGM P2... or P5 (Grayscale)
628 // PPM P3... or P6 (color)
629 // PS %!PS-Adobe-2.0 or 1.0, no "EPSF"!
630 // SGI \001\332... (decimal 474)
632 // TIFF II... or MM...
634 // XPM /* XPM */ sometimes missing (f.ex. tgif-export)
635 // ...static char *...
636 // XWD \000\000\000\151 (0x00006900) decimal 105
638 // GZIP \037\213 http://www.ietf.org/rfc/rfc1952.txt
639 // ZIP PK... http://www.halyava.ru/document/ind_arch.htm
640 // Z \037\235 UNIX compress
643 if (empty() || !isReadableFile())
646 ifstream ifs(toFilesystemEncoding().c_str());
648 // Couldn't open file...
652 static string const gzipStamp = "\037\213";
655 static string const zipStamp = "PK";
658 static string const compressStamp = "\037\235";
660 // Maximum strings to read
661 int const max_count = 50;
666 bool firstLine = true;
667 while ((count++ < max_count) && format.empty()) {
669 LYXERR(Debug::GRAPHICS, "filetools(getFormatFromContents)\n"
670 << "\tFile type not recognised before EOF!");
675 string const stamp = str.substr(0, 2);
676 if (firstLine && str.size() >= 2) {
677 // at first we check for a zipped file, because this
678 // information is saved in the first bytes of the file!
679 // also some graphic formats which save the information
680 // in the first line, too.
681 if (prefixIs(str, gzipStamp)) {
684 } else if (stamp == zipStamp) {
687 } else if (stamp == compressStamp) {
691 } else if (stamp == "BM") {
694 } else if (stamp == "\001\332") {
698 // Don't need to use str.at(0), str.at(1) because
699 // we already know that str.size() >= 2
700 } else if (str[0] == 'P') {
716 } else if ((stamp == "II") || (stamp == "MM")) {
719 } else if (prefixIs(str,"%TGIF")) {
722 } else if (prefixIs(str,"#FIG")) {
725 } else if (prefixIs(str,"GIF")) {
728 } else if (str.size() > 3) {
729 int const c = ((str[0] << 24) & (str[1] << 16) &
730 (str[2] << 8) & str[3]);
741 else if (contains(str,"EPSF"))
742 // dummy, if we have wrong file description like
743 // %!PS-Adobe-2.0EPSF"
746 else if (contains(str, "Grace"))
749 else if (contains(str, "JFIF"))
752 else if (contains(str, "%PDF"))
755 else if (contains(str, "PNG"))
758 else if (contains(str, "%!PS-Adobe")) {
761 if (contains(str,"EPSF"))
767 else if (contains(str, "_bits[]"))
770 else if (contains(str, "XPM") || contains(str, "static char *"))
773 else if (contains(str, "BITPIX"))
777 if (!format.empty()) {
778 LYXERR(Debug::GRAPHICS, "Recognised Fileformat: " << format);
782 LYXERR(Debug::GRAPHICS, "filetools(getFormatFromContents)\n"
783 << "\tCouldn't find a known format!");
788 bool FileName::isZippedFile() const
790 string const type = guessFormatFromContents();
791 return contains("gzip zip compress", type) && !type.empty();
795 docstring const FileName::relPath(string const & path) const
798 return makeRelPath(absoluteFilePath(), from_utf8(path));
802 bool operator==(FileName const & lhs, FileName const & rhs)
804 return lhs.absFilename() == rhs.absFilename();
808 bool operator!=(FileName const & lhs, FileName const & rhs)
810 return lhs.absFilename() != rhs.absFilename();
814 bool operator<(FileName const & lhs, FileName const & rhs)
816 return lhs.absFilename() < rhs.absFilename();
820 bool operator>(FileName const & lhs, FileName const & rhs)
822 return lhs.absFilename() > rhs.absFilename();
826 ostream & operator<<(ostream & os, FileName const & filename)
828 return os << filename.absFilename();
832 /////////////////////////////////////////////////////////////////////
836 /////////////////////////////////////////////////////////////////////
839 DocFileName::DocFileName()
840 : save_abs_path_(true)
844 DocFileName::DocFileName(string const & abs_filename, bool save_abs)
845 : FileName(abs_filename), save_abs_path_(save_abs), zipped_valid_(false)
849 DocFileName::DocFileName(FileName const & abs_filename, bool save_abs)
850 : FileName(abs_filename), save_abs_path_(save_abs), zipped_valid_(false)
854 void DocFileName::set(string const & name, string const & buffer_path)
858 FileName::set(makeAbsPath(name, buffer_path).absFilename());
859 zipped_valid_ = false;
863 void DocFileName::erase()
866 zipped_valid_ = false;
870 string DocFileName::relFilename(string const & path) const
873 return to_utf8(relPath(path));
877 string DocFileName::outputFilename(string const & path) const
879 return save_abs_path_ ? absFilename() : relFilename(path);
883 string DocFileName::mangledFilename(string const & dir) const
885 // We need to make sure that every DocFileName instance for a given
886 // filename returns the same mangled name.
887 typedef map<string, string> MangledMap;
888 static MangledMap mangledNames;
889 MangledMap::const_iterator const it = mangledNames.find(absFilename());
890 if (it != mangledNames.end())
893 string const name = absFilename();
895 string mname = os::internal_path(name);
896 // Remove the extension.
897 mname = support::changeExtension(name, string());
898 // The mangled name must be a valid LaTeX name.
899 // The list of characters to keep is probably over-restrictive,
900 // but it is not really a problem.
901 // Apart from non-ASCII characters, at least the following characters
902 // are forbidden: '/', '.', ' ', and ':'.
903 // On windows it is not possible to create files with '<', '>' or '?'
905 static string const keep = "abcdefghijklmnopqrstuvwxyz"
906 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
908 string::size_type pos = 0;
909 while ((pos = mname.find_first_not_of(keep, pos)) != string::npos)
911 // Add the extension back on
912 mname = support::changeExtension(mname, getExtension(name));
914 // Prepend a counter to the filename. This is necessary to make
915 // the mangled name unique.
916 static int counter = 0;
918 s << counter++ << mname;
921 // MiKTeX's YAP (version 2.4.1803) crashes if the file name
922 // is longer than about 160 characters. MiKTeX's pdflatex
923 // is even pickier. A maximum length of 100 has been proven to work.
924 // If dir.size() > max length, all bets are off for YAP. We truncate
925 // the filename nevertheless, keeping a minimum of 10 chars.
927 string::size_type max_length = max(100 - ((int)dir.size() + 1), 10);
929 // If the mangled file name is too long, hack it to fit.
930 // We know we're guaranteed to have a unique file name because
932 if (mname.size() > max_length) {
933 int const half = (int(max_length) / 2) - 2;
935 mname = mname.substr(0, half) + "___" +
936 mname.substr(mname.size() - half);
940 mangledNames[absFilename()] = mname;
945 bool DocFileName::isZipped() const
947 if (!zipped_valid_) {
948 zipped_ = isZippedFile();
949 zipped_valid_ = true;
955 string DocFileName::unzippedFilename() const
957 return unzippedFileName(absFilename());
961 bool operator==(DocFileName const & lhs, DocFileName const & rhs)
963 return lhs.absFilename() == rhs.absFilename()
964 && lhs.saveAbsPath() == rhs.saveAbsPath();
968 bool operator!=(DocFileName const & lhs, DocFileName const & rhs)
970 return !(lhs == rhs);
973 } // namespace support