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"
15 #include "support/debug.h"
16 #include "support/filetools.h"
17 #include "support/lstrings.h"
18 #include "support/lyxlib.h"
19 #include "support/os.h"
20 #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)
83 FileName::FileName(string const & abs_filename)
84 : d(abs_filename.empty() ? new Private : new Private(abs_filename))
89 FileName::FileName(FileName const & rhs) : d(new Private)
95 FileName & FileName::operator=(FileName const & rhs)
102 bool FileName::empty() const
104 return d->fi.absoluteFilePath().isEmpty();
108 string FileName::absFilename() const
110 return fromqstr(d->fi.absoluteFilePath());
114 void FileName::set(string const & name)
116 d->fi.setFile(toqstr(name));
117 BOOST_ASSERT(d->fi.isAbsolute());
121 void FileName::erase()
127 bool FileName::copyTo(FileName const & name, bool overwrite) const
130 QFile::remove(name.d->fi.absoluteFilePath());
131 bool success = QFile::copy(d->fi.absoluteFilePath(), name.d->fi.absoluteFilePath());
133 lyxerr << "FileName::copyTo(): Could not copy file "
134 << *this << " to " << name << endl;
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 extern unsigned long sum(char const * file);
241 unsigned long FileName::checksum() const
244 LYXERR0("File \"" << absFilename() << "\" does not exist!");
247 // a directory may be passed here so we need to test it. (bug 3622)
249 LYXERR0('\\' << absFilename() << "\" is a directory!");
252 return sum(absFilename().c_str());
256 bool FileName::removeFile() const
258 bool const success = QFile::remove(d->fi.absoluteFilePath());
260 lyxerr << "FileName::removeFile(): Could not delete file "
261 << *this << "." << endl;
266 static bool rmdir(QFileInfo const & fi)
268 QDir dir(fi.absoluteFilePath());
269 QFileInfoList list = dir.entryInfoList();
270 bool global_success = true;
271 for (int i = 0; i < list.size(); ++i) {
272 if (list.at(i).fileName() == ".")
274 if (list.at(i).fileName() == "..")
277 if (list.at(i).isDir()) {
278 LYXERR(Debug::FILES, "Erasing dir "
279 << fromqstr(list.at(i).absoluteFilePath()));
280 success = rmdir(list.at(i));
283 LYXERR(Debug::FILES, "Erasing file "
284 << fromqstr(list.at(i).absoluteFilePath()));
285 success = dir.remove(list.at(i).fileName());
288 global_success = false;
289 lyxerr << "Could not delete "
290 << fromqstr(list.at(i).absoluteFilePath()) << "." << endl;
293 QDir parent = fi.absolutePath();
294 global_success |= parent.rmdir(fi.fileName());
295 return global_success;
299 bool FileName::destroyDirectory() const
301 bool const success = rmdir(d->fi);
303 lyxerr << "Could not delete " << *this << "." << endl;
309 bool FileName::createDirectory(int permission) const
311 BOOST_ASSERT(!empty());
312 return mkdir(*this, permission) == 0;
316 std::vector<FileName> FileName::dirList(std::string const & ext)
318 std::vector<FileName> dirlist;
319 if (!exists() || !isDirectory()) {
320 lyxerr << "FileName::dirList(): Directory \"" << absFilename()
321 << "\" does not exist!" << endl;
325 QDir dir(d->fi.absoluteFilePath());
330 case '.': filter = "*" + toqstr(ext); break;
331 case '*': filter = toqstr(ext); break;
332 default: filter = "*." + toqstr(ext);
334 dir.setNameFilters(QStringList(filter));
335 LYXERR(Debug::FILES, "FileName::dirList(): filtering on extension "
336 << fromqstr(filter) << " is requested." << endl);
339 QFileInfoList list = dir.entryInfoList();
340 for (int i = 0; i < list.size(); ++i) {
342 fi.d->fi = list.at(i);
343 dirlist.push_back(fi);
344 LYXERR(Debug::FILES, "FileName::dirList(): found file "
345 << fi.absFilename() << endl);
352 docstring FileName::displayName(int threshold) const
354 return makeDisplayPath(absFilename(), threshold);
358 string FileName::fileContents() const
361 string const encodedname = toFilesystemEncoding();
362 ifstream ifs(encodedname.c_str());
370 lyxerr << "LyX was not able to read file '" << *this << '\'' << std::endl;
375 void FileName::changeExtension(std::string const & extension)
377 // FIXME: use Qt native methods...
378 string const oldname = absFilename();
379 string::size_type const last_slash = oldname.rfind('/');
380 string::size_type last_dot = oldname.rfind('.');
381 if (last_dot < last_slash && last_slash != string::npos)
382 last_dot = string::npos;
385 // Make sure the extension starts with a dot
386 if (!extension.empty() && extension[0] != '.')
387 ext= '.' + extension;
391 set(oldname.substr(0, last_dot) + ext);
395 string FileName::guessFormatFromContents() const
397 // the different filetypes and what they contain in one of the first lines
398 // (dots are any characters). (Herbert 20020131)
401 // EPS %!PS-Adobe-3.0 EPSF...
408 // PBM P1... or P4 (B/W)
409 // PGM P2... or P5 (Grayscale)
410 // PPM P3... or P6 (color)
411 // PS %!PS-Adobe-2.0 or 1.0, no "EPSF"!
412 // SGI \001\332... (decimal 474)
414 // TIFF II... or MM...
416 // XPM /* XPM */ sometimes missing (f.ex. tgif-export)
417 // ...static char *...
418 // XWD \000\000\000\151 (0x00006900) decimal 105
420 // GZIP \037\213 http://www.ietf.org/rfc/rfc1952.txt
421 // ZIP PK... http://www.halyava.ru/document/ind_arch.htm
422 // Z \037\235 UNIX compress
425 if (empty() || !isReadableFile())
428 ifstream ifs(toFilesystemEncoding().c_str());
430 // Couldn't open file...
434 static string const gzipStamp = "\037\213";
437 static string const zipStamp = "PK";
440 static string const compressStamp = "\037\235";
442 // Maximum strings to read
443 int const max_count = 50;
448 bool firstLine = true;
449 while ((count++ < max_count) && format.empty()) {
451 LYXERR(Debug::GRAPHICS, "filetools(getFormatFromContents)\n"
452 << "\tFile type not recognised before EOF!");
457 string const stamp = str.substr(0, 2);
458 if (firstLine && str.size() >= 2) {
459 // at first we check for a zipped file, because this
460 // information is saved in the first bytes of the file!
461 // also some graphic formats which save the information
462 // in the first line, too.
463 if (prefixIs(str, gzipStamp)) {
466 } else if (stamp == zipStamp) {
469 } else if (stamp == compressStamp) {
473 } else if (stamp == "BM") {
476 } else if (stamp == "\001\332") {
480 // Don't need to use str.at(0), str.at(1) because
481 // we already know that str.size() >= 2
482 } else if (str[0] == 'P') {
498 } else if ((stamp == "II") || (stamp == "MM")) {
501 } else if (prefixIs(str,"%TGIF")) {
504 } else if (prefixIs(str,"#FIG")) {
507 } else if (prefixIs(str,"GIF")) {
510 } else if (str.size() > 3) {
511 int const c = ((str[0] << 24) & (str[1] << 16) &
512 (str[2] << 8) & str[3]);
523 else if (contains(str,"EPSF"))
524 // dummy, if we have wrong file description like
525 // %!PS-Adobe-2.0EPSF"
528 else if (contains(str, "Grace"))
531 else if (contains(str, "JFIF"))
534 else if (contains(str, "%PDF"))
537 else if (contains(str, "PNG"))
540 else if (contains(str, "%!PS-Adobe")) {
543 if (contains(str,"EPSF"))
549 else if (contains(str, "_bits[]"))
552 else if (contains(str, "XPM") || contains(str, "static char *"))
555 else if (contains(str, "BITPIX"))
559 if (!format.empty()) {
560 LYXERR(Debug::GRAPHICS, "Recognised Fileformat: " << format);
564 LYXERR(Debug::GRAPHICS, "filetools(getFormatFromContents)\n"
565 << "\tCouldn't find a known format!");
570 bool FileName::isZippedFile() const
572 string const type = guessFormatFromContents();
573 return contains("gzip zip compress", type) && !type.empty();
577 bool operator==(FileName const & lhs, FileName const & rhs)
579 return lhs.absFilename() == rhs.absFilename();
583 bool operator!=(FileName const & lhs, FileName const & rhs)
585 return lhs.absFilename() != rhs.absFilename();
589 bool operator<(FileName const & lhs, FileName const & rhs)
591 return lhs.absFilename() < rhs.absFilename();
595 bool operator>(FileName const & lhs, FileName const & rhs)
597 return lhs.absFilename() > rhs.absFilename();
601 std::ostream & operator<<(std::ostream & os, FileName const & filename)
603 return os << filename.absFilename();
607 /////////////////////////////////////////////////////////////////////
611 /////////////////////////////////////////////////////////////////////
614 DocFileName::DocFileName()
615 : save_abs_path_(true)
619 DocFileName::DocFileName(string const & abs_filename, bool save_abs)
620 : FileName(abs_filename), save_abs_path_(save_abs), zipped_valid_(false)
624 DocFileName::DocFileName(FileName const & abs_filename, bool save_abs)
625 : FileName(abs_filename), save_abs_path_(save_abs), zipped_valid_(false)
629 void DocFileName::set(string const & name, string const & buffer_path)
631 save_abs_path_ = absolutePath(name);
632 FileName::set(save_abs_path_ ? name : makeAbsPath(name, buffer_path).absFilename());
633 zipped_valid_ = false;
637 void DocFileName::erase()
640 zipped_valid_ = false;
644 string const DocFileName::relFilename(string const & path) const
647 return to_utf8(makeRelPath(qstring_to_ucs4(d->fi.absoluteFilePath()), from_utf8(path)));
651 string const DocFileName::outputFilename(string const & path) const
653 return save_abs_path_ ? absFilename() : relFilename(path);
657 string const DocFileName::mangledFilename(std::string const & dir) const
659 // We need to make sure that every DocFileName instance for a given
660 // filename returns the same mangled name.
661 typedef map<string, string> MangledMap;
662 static MangledMap mangledNames;
663 MangledMap::const_iterator const it = mangledNames.find(absFilename());
664 if (it != mangledNames.end())
667 string const name = absFilename();
669 string mname = os::internal_path(name);
670 // Remove the extension.
671 mname = support::changeExtension(name, string());
672 // The mangled name must be a valid LaTeX name.
673 // The list of characters to keep is probably over-restrictive,
674 // but it is not really a problem.
675 // Apart from non-ASCII characters, at least the following characters
676 // are forbidden: '/', '.', ' ', and ':'.
677 // On windows it is not possible to create files with '<', '>' or '?'
679 static string const keep = "abcdefghijklmnopqrstuvwxyz"
680 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
682 string::size_type pos = 0;
683 while ((pos = mname.find_first_not_of(keep, pos)) != string::npos)
685 // Add the extension back on
686 mname = support::changeExtension(mname, getExtension(name));
688 // Prepend a counter to the filename. This is necessary to make
689 // the mangled name unique.
690 static int counter = 0;
691 std::ostringstream s;
692 s << counter++ << mname;
695 // MiKTeX's YAP (version 2.4.1803) crashes if the file name
696 // is longer than about 160 characters. MiKTeX's pdflatex
697 // is even pickier. A maximum length of 100 has been proven to work.
698 // If dir.size() > max length, all bets are off for YAP. We truncate
699 // the filename nevertheless, keeping a minimum of 10 chars.
701 string::size_type max_length = std::max(100 - ((int)dir.size() + 1), 10);
703 // If the mangled file name is too long, hack it to fit.
704 // We know we're guaranteed to have a unique file name because
706 if (mname.size() > max_length) {
707 int const half = (int(max_length) / 2) - 2;
709 mname = mname.substr(0, half) + "___" +
710 mname.substr(mname.size() - half);
714 mangledNames[absFilename()] = mname;
719 bool DocFileName::isZipped() const
721 if (!zipped_valid_) {
722 zipped_ = isZippedFile();
723 zipped_valid_ = true;
729 string const DocFileName::unzippedFilename() const
731 return unzippedFileName(absFilename());
735 bool operator==(DocFileName const & lhs, DocFileName const & rhs)
737 return lhs.absFilename() == rhs.absFilename()
738 && lhs.saveAbsPath() == rhs.saveAbsPath();
742 bool operator!=(DocFileName const & lhs, DocFileName const & rhs)
744 return !(lhs == rhs);
747 } // namespace support