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)
82 FileName::FileName(string const & abs_filename)
83 : d(abs_filename.empty() ? new Private : new Private(abs_filename))
85 BOOST_ASSERT(empty() || d->fi.isAbsolute());
87 BOOST_ASSERT(!contains(abs_filename, '\\'));
92 FileName::FileName(FileName const & rhs) : d(new Private)
98 FileName & FileName::operator=(FileName const & rhs)
105 bool FileName::empty() const
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 bool global_success = true;
244 for (int i = 0; i < list.size(); ++i) {
245 if (list.at(i).fileName() == ".")
247 if (list.at(i).fileName() == "..")
250 if (list.at(i).isDir()) {
251 LYXERR(Debug::FILES, "Erasing dir "
252 << fromqstr(list.at(i).absoluteFilePath()));
253 success = rmdir(list.at(i));
256 LYXERR(Debug::FILES, "Erasing file "
257 << fromqstr(list.at(i).absoluteFilePath()));
258 success = dir.remove(list.at(i).fileName());
261 global_success = false;
262 lyxerr << "Could not delete "
263 << fromqstr(list.at(i).absoluteFilePath()) << "." << endl;
266 QDir parent = fi.absolutePath();
267 global_success |= parent.rmdir(fi.fileName());
268 return global_success;
272 bool FileName::destroyDirectory() const
274 bool const success = rmdir(d->fi);
276 lyxerr << "Could not delete " << *this << "." << endl;
282 bool FileName::createDirectory(int permission) const
284 BOOST_ASSERT(!empty());
285 return mkdir(*this, permission) == 0;
289 std::vector<FileName> FileName::dirList(std::string const & ext)
291 std::vector<FileName> dirlist;
292 if (!exists() || !isDirectory()) {
293 lyxerr << "FileName::dirList(): Directory \"" << absFilename()
294 << "\" does not exist!" << endl;
298 QDir dir(d->fi.absoluteFilePath());
303 case '.': filter = "*" + toqstr(ext); break;
304 case '*': filter = toqstr(ext); break;
305 default: filter = "*." + toqstr(ext);
307 dir.setNameFilters(QStringList(filter));
308 LYXERR(Debug::FILES, "FileName::dirList(): filtering on extension "
309 << fromqstr(filter) << " is requested." << endl);
312 QFileInfoList list = dir.entryInfoList();
313 for (int i = 0; i < list.size(); ++i) {
315 fi.d->fi = list.at(i);
316 dirlist.push_back(fi);
317 LYXERR(Debug::FILES, "FileName::dirList(): found file "
318 << fi.absFilename() << endl);
325 docstring FileName::displayName(int threshold) const
327 return makeDisplayPath(absFilename(), threshold);
331 string FileName::fileContents() const
334 string const encodedname = toFilesystemEncoding();
335 ifstream ifs(encodedname.c_str());
343 lyxerr << "LyX was not able to read file '" << *this << '\'' << std::endl;
348 string FileName::guessFormatFromContents() const
350 // the different filetypes and what they contain in one of the first lines
351 // (dots are any characters). (Herbert 20020131)
354 // EPS %!PS-Adobe-3.0 EPSF...
361 // PBM P1... or P4 (B/W)
362 // PGM P2... or P5 (Grayscale)
363 // PPM P3... or P6 (color)
364 // PS %!PS-Adobe-2.0 or 1.0, no "EPSF"!
365 // SGI \001\332... (decimal 474)
367 // TIFF II... or MM...
369 // XPM /* XPM */ sometimes missing (f.ex. tgif-export)
370 // ...static char *...
371 // XWD \000\000\000\151 (0x00006900) decimal 105
373 // GZIP \037\213 http://www.ietf.org/rfc/rfc1952.txt
374 // ZIP PK... http://www.halyava.ru/document/ind_arch.htm
375 // Z \037\235 UNIX compress
378 if (empty() || !isReadableFile())
381 ifstream ifs(toFilesystemEncoding().c_str());
383 // Couldn't open file...
387 static string const gzipStamp = "\037\213";
390 static string const zipStamp = "PK";
393 static string const compressStamp = "\037\235";
395 // Maximum strings to read
396 int const max_count = 50;
401 bool firstLine = true;
402 while ((count++ < max_count) && format.empty()) {
404 LYXERR(Debug::GRAPHICS, "filetools(getFormatFromContents)\n"
405 << "\tFile type not recognised before EOF!");
410 string const stamp = str.substr(0, 2);
411 if (firstLine && str.size() >= 2) {
412 // at first we check for a zipped file, because this
413 // information is saved in the first bytes of the file!
414 // also some graphic formats which save the information
415 // in the first line, too.
416 if (prefixIs(str, gzipStamp)) {
419 } else if (stamp == zipStamp) {
422 } else if (stamp == compressStamp) {
426 } else if (stamp == "BM") {
429 } else if (stamp == "\001\332") {
433 // Don't need to use str.at(0), str.at(1) because
434 // we already know that str.size() >= 2
435 } else if (str[0] == 'P') {
451 } else if ((stamp == "II") || (stamp == "MM")) {
454 } else if (prefixIs(str,"%TGIF")) {
457 } else if (prefixIs(str,"#FIG")) {
460 } else if (prefixIs(str,"GIF")) {
463 } else if (str.size() > 3) {
464 int const c = ((str[0] << 24) & (str[1] << 16) &
465 (str[2] << 8) & str[3]);
476 else if (contains(str,"EPSF"))
477 // dummy, if we have wrong file description like
478 // %!PS-Adobe-2.0EPSF"
481 else if (contains(str, "Grace"))
484 else if (contains(str, "JFIF"))
487 else if (contains(str, "%PDF"))
490 else if (contains(str, "PNG"))
493 else if (contains(str, "%!PS-Adobe")) {
496 if (contains(str,"EPSF"))
502 else if (contains(str, "_bits[]"))
505 else if (contains(str, "XPM") || contains(str, "static char *"))
508 else if (contains(str, "BITPIX"))
512 if (!format.empty()) {
513 LYXERR(Debug::GRAPHICS, "Recognised Fileformat: " << format);
517 LYXERR(Debug::GRAPHICS, "filetools(getFormatFromContents)\n"
518 << "\tCouldn't find a known format!");
523 bool FileName::isZippedFile() const
525 string const type = guessFormatFromContents();
526 return contains("gzip zip compress", type) && !type.empty();
530 bool operator==(FileName const & lhs, FileName const & rhs)
532 return lhs.absFilename() == rhs.absFilename();
536 bool operator!=(FileName const & lhs, FileName const & rhs)
538 return lhs.absFilename() != rhs.absFilename();
542 bool operator<(FileName const & lhs, FileName const & rhs)
544 return lhs.absFilename() < rhs.absFilename();
548 bool operator>(FileName const & lhs, FileName const & rhs)
550 return lhs.absFilename() > rhs.absFilename();
554 std::ostream & operator<<(std::ostream & os, FileName const & filename)
556 return os << filename.absFilename();
560 /////////////////////////////////////////////////////////////////////
564 /////////////////////////////////////////////////////////////////////
567 DocFileName::DocFileName()
568 : save_abs_path_(true)
572 DocFileName::DocFileName(string const & abs_filename, bool save_abs)
573 : FileName(abs_filename), save_abs_path_(save_abs), zipped_valid_(false)
577 DocFileName::DocFileName(FileName const & abs_filename, bool save_abs)
578 : FileName(abs_filename), save_abs_path_(save_abs), zipped_valid_(false)
582 void DocFileName::set(string const & name, string const & buffer_path)
584 save_abs_path_ = absolutePath(name);
585 FileName::set(save_abs_path_ ? name : makeAbsPath(name, buffer_path).absFilename());
586 zipped_valid_ = false;
590 void DocFileName::erase()
593 zipped_valid_ = false;
597 string const DocFileName::relFilename(string const & path) const
600 return to_utf8(makeRelPath(qstring_to_ucs4(d->fi.absoluteFilePath()), from_utf8(path)));
604 string const DocFileName::outputFilename(string const & path) const
606 return save_abs_path_ ? absFilename() : relFilename(path);
610 string const DocFileName::mangledFilename(std::string const & dir) const
612 // We need to make sure that every DocFileName instance for a given
613 // filename returns the same mangled name.
614 typedef map<string, string> MangledMap;
615 static MangledMap mangledNames;
616 MangledMap::const_iterator const it = mangledNames.find(absFilename());
617 if (it != mangledNames.end())
620 string const name = absFilename();
622 string mname = os::internal_path(name);
623 // Remove the extension.
624 mname = changeExtension(name, string());
625 // The mangled name must be a valid LaTeX name.
626 // The list of characters to keep is probably over-restrictive,
627 // but it is not really a problem.
628 // Apart from non-ASCII characters, at least the following characters
629 // are forbidden: '/', '.', ' ', and ':'.
630 // On windows it is not possible to create files with '<', '>' or '?'
632 static string const keep = "abcdefghijklmnopqrstuvwxyz"
633 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
635 string::size_type pos = 0;
636 while ((pos = mname.find_first_not_of(keep, pos)) != string::npos)
638 // Add the extension back on
639 mname = changeExtension(mname, getExtension(name));
641 // Prepend a counter to the filename. This is necessary to make
642 // the mangled name unique.
643 static int counter = 0;
644 std::ostringstream s;
645 s << counter++ << mname;
648 // MiKTeX's YAP (version 2.4.1803) crashes if the file name
649 // is longer than about 160 characters. MiKTeX's pdflatex
650 // is even pickier. A maximum length of 100 has been proven to work.
651 // If dir.size() > max length, all bets are off for YAP. We truncate
652 // the filename nevertheless, keeping a minimum of 10 chars.
654 string::size_type max_length = std::max(100 - ((int)dir.size() + 1), 10);
656 // If the mangled file name is too long, hack it to fit.
657 // We know we're guaranteed to have a unique file name because
659 if (mname.size() > max_length) {
660 int const half = (int(max_length) / 2) - 2;
662 mname = mname.substr(0, half) + "___" +
663 mname.substr(mname.size() - half);
667 mangledNames[absFilename()] = mname;
672 bool DocFileName::isZipped() const
674 if (!zipped_valid_) {
675 zipped_ = isZippedFile();
676 zipped_valid_ = true;
682 string const DocFileName::unzippedFilename() const
684 return unzippedFileName(absFilename());
688 bool operator==(DocFileName const & lhs, DocFileName const & rhs)
690 return lhs.absFilename() == rhs.absFilename()
691 && lhs.saveAbsPath() == rhs.saveAbsPath();
695 bool operator!=(DocFileName const & lhs, DocFileName const & rhs)
697 return !(lhs == rhs);
700 } // namespace support