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/filetools.h"
15 #include "support/lstrings.h"
16 #include "support/os.h"
17 #include "support/qstring_helpers.h"
28 #include <boost/assert.hpp>
35 #ifdef HAVE_SYS_TYPES_H
36 # include <sys/types.h>
38 #ifdef HAVE_SYS_STAT_H
39 # include <sys/stat.h>
48 using std::ostringstream;
55 /////////////////////////////////////////////////////////////////////
59 /////////////////////////////////////////////////////////////////////
61 struct FileName::Private
65 Private(string const & abs_filename) : fi(toqstr(abs_filename))
71 /////////////////////////////////////////////////////////////////////
75 /////////////////////////////////////////////////////////////////////
78 FileName::FileName() : d(new Private)
81 FileName::FileName(string const & abs_filename)
82 : d(abs_filename.empty() ? new Private : new Private(abs_filename))
84 BOOST_ASSERT(empty() || d->fi.isAbsolute());
86 BOOST_ASSERT(!contains(abs_filename, '\\'));
91 FileName::FileName(FileName const & rhs) : d(new Private)
97 FileName & FileName::operator=(FileName const & rhs)
104 bool FileName::empty() const
106 lyxerr << "FileName::empty() '" << absFilename() << "'" << endl;
107 return d->fi.absoluteFilePath().isEmpty();
111 string FileName::absFilename() const
113 return fromqstr(d->fi.absoluteFilePath());
117 void FileName::set(string const & name)
119 d->fi.setFile(toqstr(name));
120 BOOST_ASSERT(d->fi.isAbsolute());
122 BOOST_ASSERT(!contains(name, '\\'));
127 void FileName::erase()
133 bool FileName::copyTo(FileName const & name) const
135 return QFile::copy(d->fi.absoluteFilePath(), name.d->fi.absoluteFilePath());
139 string FileName::toFilesystemEncoding() const
141 QByteArray const encoded = QFile::encodeName(d->fi.absoluteFilePath());
142 return string(encoded.begin(), encoded.end());
146 FileName FileName::fromFilesystemEncoding(string const & name)
148 QByteArray const encoded(name.c_str(), name.length());
149 return FileName(fromqstr(QFile::decodeName(encoded)));
153 bool FileName::exists() const
155 return d->fi.exists();
159 bool FileName::isSymLink() const
161 return d->fi.isSymLink();
165 bool FileName::isFileEmpty() const
167 return d->fi.size() == 0;
171 bool FileName::isDirectory() const
173 return d->fi.isDir();
177 bool FileName::isReadOnly() const
179 return d->fi.isReadable() && !d->fi.isWritable();
183 bool FileName::isReadableDirectory() const
185 return d->fi.isDir() && d->fi.isReadable();
189 std::string FileName::onlyFileName() const
191 return support::onlyFilename(absFilename());
195 FileName FileName::onlyPath() const
197 return FileName(support::onlyPath(absFilename()));
201 bool FileName::isReadableFile() const
203 return d->fi.isFile() && d->fi.isReadable();
207 bool FileName::isWritable() const
209 return d->fi.isWritable();
213 bool FileName::isDirWritable() const
215 LYXERR(Debug::FILES, "isDirWriteable: " << *this);
217 FileName const tmpfl(tempName(*this, "lyxwritetest"));
227 FileName FileName::tempName(FileName const & dir, std::string const & mask)
229 return support::tempName(dir, mask);
233 std::time_t FileName::lastModified() const
235 return d->fi.lastModified().toTime_t();
239 static bool rmdir(QFileInfo const & fi)
241 QDir dir(fi.absoluteFilePath());
242 QFileInfoList list = dir.entryInfoList();
243 for (int i = 0; i < list.size(); ++i) {
244 if (list.at(i).fileName() == ".")
246 if (list.at(i).fileName() == "..")
248 if (list.at(i).isDir()) {
249 LYXERR(Debug::FILES, "Erasing dir "
250 << fromqstr(list.at(i).absoluteFilePath()) << endl);
251 if (!rmdir(list.at(i)))
255 LYXERR(Debug::FILES, "Erasing file "
256 << fromqstr(list.at(i).absoluteFilePath()) << endl);
257 dir.remove(list.at(i).fileName());
260 QDir parent = fi.absolutePath();
261 return parent.rmdir(fi.fileName());
265 bool FileName::destroyDirectory() const
267 bool const success = rmdir(d->fi);
269 lyxerr << "Could not delete " << *this << "." << endl;
275 bool FileName::createDirectory(int permission) const
277 BOOST_ASSERT(!empty());
278 return mkdir(*this, permission) == 0;
282 docstring FileName::displayName(int threshold) const
284 return makeDisplayPath(absFilename(), threshold);
288 string FileName::fileContents() const
291 string const encodedname = toFilesystemEncoding();
292 ifstream ifs(encodedname.c_str());
300 lyxerr << "LyX was not able to read file '" << *this << '\'' << std::endl;
305 string FileName::guessFormatFromContents() const
307 // the different filetypes and what they contain in one of the first lines
308 // (dots are any characters). (Herbert 20020131)
311 // EPS %!PS-Adobe-3.0 EPSF...
318 // PBM P1... or P4 (B/W)
319 // PGM P2... or P5 (Grayscale)
320 // PPM P3... or P6 (color)
321 // PS %!PS-Adobe-2.0 or 1.0, no "EPSF"!
322 // SGI \001\332... (decimal 474)
324 // TIFF II... or MM...
326 // XPM /* XPM */ sometimes missing (f.ex. tgif-export)
327 // ...static char *...
328 // XWD \000\000\000\151 (0x00006900) decimal 105
330 // GZIP \037\213 http://www.ietf.org/rfc/rfc1952.txt
331 // ZIP PK... http://www.halyava.ru/document/ind_arch.htm
332 // Z \037\235 UNIX compress
335 if (empty() || !isReadableFile())
338 ifstream ifs(toFilesystemEncoding().c_str());
340 // Couldn't open file...
344 static string const gzipStamp = "\037\213";
347 static string const zipStamp = "PK";
350 static string const compressStamp = "\037\235";
352 // Maximum strings to read
353 int const max_count = 50;
358 bool firstLine = true;
359 while ((count++ < max_count) && format.empty()) {
361 LYXERR(Debug::GRAPHICS, "filetools(getFormatFromContents)\n"
362 << "\tFile type not recognised before EOF!");
367 string const stamp = str.substr(0, 2);
368 if (firstLine && str.size() >= 2) {
369 // at first we check for a zipped file, because this
370 // information is saved in the first bytes of the file!
371 // also some graphic formats which save the information
372 // in the first line, too.
373 if (prefixIs(str, gzipStamp)) {
376 } else if (stamp == zipStamp) {
379 } else if (stamp == compressStamp) {
383 } else if (stamp == "BM") {
386 } else if (stamp == "\001\332") {
390 // Don't need to use str.at(0), str.at(1) because
391 // we already know that str.size() >= 2
392 } else if (str[0] == 'P') {
408 } else if ((stamp == "II") || (stamp == "MM")) {
411 } else if (prefixIs(str,"%TGIF")) {
414 } else if (prefixIs(str,"#FIG")) {
417 } else if (prefixIs(str,"GIF")) {
420 } else if (str.size() > 3) {
421 int const c = ((str[0] << 24) & (str[1] << 16) &
422 (str[2] << 8) & str[3]);
433 else if (contains(str,"EPSF"))
434 // dummy, if we have wrong file description like
435 // %!PS-Adobe-2.0EPSF"
438 else if (contains(str, "Grace"))
441 else if (contains(str, "JFIF"))
444 else if (contains(str, "%PDF"))
447 else if (contains(str, "PNG"))
450 else if (contains(str, "%!PS-Adobe")) {
453 if (contains(str,"EPSF"))
459 else if (contains(str, "_bits[]"))
462 else if (contains(str, "XPM") || contains(str, "static char *"))
465 else if (contains(str, "BITPIX"))
469 if (!format.empty()) {
470 LYXERR(Debug::GRAPHICS, "Recognised Fileformat: " << format);
474 LYXERR(Debug::GRAPHICS, "filetools(getFormatFromContents)\n"
475 << "\tCouldn't find a known format!");
480 bool FileName::isZippedFile() const
482 string const type = guessFormatFromContents();
483 return contains("gzip zip compress", type) && !type.empty();
487 bool operator==(FileName const & lhs, FileName const & rhs)
489 return lhs.absFilename() == rhs.absFilename();
493 bool operator!=(FileName const & lhs, FileName const & rhs)
495 return lhs.absFilename() != rhs.absFilename();
499 bool operator<(FileName const & lhs, FileName const & rhs)
501 return lhs.absFilename() < rhs.absFilename();
505 bool operator>(FileName const & lhs, FileName const & rhs)
507 return lhs.absFilename() > rhs.absFilename();
511 std::ostream & operator<<(std::ostream & os, FileName const & filename)
513 return os << filename.absFilename();
517 /////////////////////////////////////////////////////////////////////
521 /////////////////////////////////////////////////////////////////////
524 DocFileName::DocFileName()
525 : save_abs_path_(true)
529 DocFileName::DocFileName(string const & abs_filename, bool save_abs)
530 : FileName(abs_filename), save_abs_path_(save_abs), zipped_valid_(false)
534 DocFileName::DocFileName(FileName const & abs_filename, bool save_abs)
535 : FileName(abs_filename), save_abs_path_(save_abs), zipped_valid_(false)
539 void DocFileName::set(string const & name, string const & buffer_path)
541 save_abs_path_ = absolutePath(name);
542 FileName::set(save_abs_path_ ? name : makeAbsPath(name, buffer_path).absFilename());
543 zipped_valid_ = false;
547 void DocFileName::erase()
550 zipped_valid_ = false;
554 string const DocFileName::relFilename(string const & path) const
557 return to_utf8(makeRelPath(qstring_to_ucs4(d->fi.absoluteFilePath()), from_utf8(path)));
561 string const DocFileName::outputFilename(string const & path) const
563 return save_abs_path_ ? absFilename() : relFilename(path);
567 string const DocFileName::mangledFilename(std::string const & dir) const
569 // We need to make sure that every DocFileName instance for a given
570 // filename returns the same mangled name.
571 typedef map<string, string> MangledMap;
572 static MangledMap mangledNames;
573 MangledMap::const_iterator const it = mangledNames.find(absFilename());
574 if (it != mangledNames.end())
577 string const name = absFilename();
579 string mname = os::internal_path(name);
580 // Remove the extension.
581 mname = changeExtension(name, string());
582 // The mangled name must be a valid LaTeX name.
583 // The list of characters to keep is probably over-restrictive,
584 // but it is not really a problem.
585 // Apart from non-ASCII characters, at least the following characters
586 // are forbidden: '/', '.', ' ', and ':'.
587 // On windows it is not possible to create files with '<', '>' or '?'
589 static string const keep = "abcdefghijklmnopqrstuvwxyz"
590 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
592 string::size_type pos = 0;
593 while ((pos = mname.find_first_not_of(keep, pos)) != string::npos)
595 // Add the extension back on
596 mname = changeExtension(mname, getExtension(name));
598 // Prepend a counter to the filename. This is necessary to make
599 // the mangled name unique.
600 static int counter = 0;
601 std::ostringstream s;
602 s << counter++ << mname;
605 // MiKTeX's YAP (version 2.4.1803) crashes if the file name
606 // is longer than about 160 characters. MiKTeX's pdflatex
607 // is even pickier. A maximum length of 100 has been proven to work.
608 // If dir.size() > max length, all bets are off for YAP. We truncate
609 // the filename nevertheless, keeping a minimum of 10 chars.
611 string::size_type max_length = std::max(100 - ((int)dir.size() + 1), 10);
613 // If the mangled file name is too long, hack it to fit.
614 // We know we're guaranteed to have a unique file name because
616 if (mname.size() > max_length) {
617 int const half = (int(max_length) / 2) - 2;
619 mname = mname.substr(0, half) + "___" +
620 mname.substr(mname.size() - half);
624 mangledNames[absFilename()] = mname;
629 bool DocFileName::isZipped() const
631 if (!zipped_valid_) {
632 zipped_ = isZippedFile();
633 zipped_valid_ = true;
639 string const DocFileName::unzippedFilename() const
641 return unzippedFileName(absFilename());
645 bool operator==(DocFileName const & lhs, DocFileName const & rhs)
647 return lhs.absFilename() == rhs.absFilename()
648 && lhs.saveAbsPath() == rhs.saveAbsPath();
652 bool operator!=(DocFileName const & lhs, DocFileName const & rhs)
654 return !(lhs == rhs);
657 } // namespace support