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)
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 bool FileName::removeFile() const
241 bool const success = QFile::remove(d->fi.absoluteFilePath());
243 lyxerr << "FileName::removeFile(): Could not delete file "
244 << *this << "." << endl;
249 static bool rmdir(QFileInfo const & fi)
251 QDir dir(fi.absoluteFilePath());
252 QFileInfoList list = dir.entryInfoList();
253 bool global_success = true;
254 for (int i = 0; i < list.size(); ++i) {
255 if (list.at(i).fileName() == ".")
257 if (list.at(i).fileName() == "..")
260 if (list.at(i).isDir()) {
261 LYXERR(Debug::FILES, "Erasing dir "
262 << fromqstr(list.at(i).absoluteFilePath()));
263 success = rmdir(list.at(i));
266 LYXERR(Debug::FILES, "Erasing file "
267 << fromqstr(list.at(i).absoluteFilePath()));
268 success = dir.remove(list.at(i).fileName());
271 global_success = false;
272 lyxerr << "Could not delete "
273 << fromqstr(list.at(i).absoluteFilePath()) << "." << endl;
276 QDir parent = fi.absolutePath();
277 global_success |= parent.rmdir(fi.fileName());
278 return global_success;
282 bool FileName::destroyDirectory() const
284 bool const success = rmdir(d->fi);
286 lyxerr << "Could not delete " << *this << "." << endl;
292 bool FileName::createDirectory(int permission) const
294 BOOST_ASSERT(!empty());
295 return mkdir(*this, permission) == 0;
299 std::vector<FileName> FileName::dirList(std::string const & ext)
301 std::vector<FileName> dirlist;
302 if (!exists() || !isDirectory()) {
303 lyxerr << "FileName::dirList(): Directory \"" << absFilename()
304 << "\" does not exist!" << endl;
308 QDir dir(d->fi.absoluteFilePath());
313 case '.': filter = "*" + toqstr(ext); break;
314 case '*': filter = toqstr(ext); break;
315 default: filter = "*." + toqstr(ext);
317 dir.setNameFilters(QStringList(filter));
318 LYXERR(Debug::FILES, "FileName::dirList(): filtering on extension "
319 << fromqstr(filter) << " is requested." << endl);
322 QFileInfoList list = dir.entryInfoList();
323 for (int i = 0; i < list.size(); ++i) {
325 fi.d->fi = list.at(i);
326 dirlist.push_back(fi);
327 LYXERR(Debug::FILES, "FileName::dirList(): found file "
328 << fi.absFilename() << endl);
335 docstring FileName::displayName(int threshold) const
337 return makeDisplayPath(absFilename(), threshold);
341 string FileName::fileContents() const
344 string const encodedname = toFilesystemEncoding();
345 ifstream ifs(encodedname.c_str());
353 lyxerr << "LyX was not able to read file '" << *this << '\'' << std::endl;
358 void FileName::changeExtension(std::string const & extension)
360 // FIXME: use Qt native methods...
361 string const oldname = absFilename();
362 string::size_type const last_slash = oldname.rfind('/');
363 string::size_type last_dot = oldname.rfind('.');
364 if (last_dot < last_slash && last_slash != string::npos)
365 last_dot = string::npos;
368 // Make sure the extension starts with a dot
369 if (!extension.empty() && extension[0] != '.')
370 ext= '.' + extension;
374 set(oldname.substr(0, last_dot) + ext);
378 string FileName::guessFormatFromContents() const
380 // the different filetypes and what they contain in one of the first lines
381 // (dots are any characters). (Herbert 20020131)
384 // EPS %!PS-Adobe-3.0 EPSF...
391 // PBM P1... or P4 (B/W)
392 // PGM P2... or P5 (Grayscale)
393 // PPM P3... or P6 (color)
394 // PS %!PS-Adobe-2.0 or 1.0, no "EPSF"!
395 // SGI \001\332... (decimal 474)
397 // TIFF II... or MM...
399 // XPM /* XPM */ sometimes missing (f.ex. tgif-export)
400 // ...static char *...
401 // XWD \000\000\000\151 (0x00006900) decimal 105
403 // GZIP \037\213 http://www.ietf.org/rfc/rfc1952.txt
404 // ZIP PK... http://www.halyava.ru/document/ind_arch.htm
405 // Z \037\235 UNIX compress
408 if (empty() || !isReadableFile())
411 ifstream ifs(toFilesystemEncoding().c_str());
413 // Couldn't open file...
417 static string const gzipStamp = "\037\213";
420 static string const zipStamp = "PK";
423 static string const compressStamp = "\037\235";
425 // Maximum strings to read
426 int const max_count = 50;
431 bool firstLine = true;
432 while ((count++ < max_count) && format.empty()) {
434 LYXERR(Debug::GRAPHICS, "filetools(getFormatFromContents)\n"
435 << "\tFile type not recognised before EOF!");
440 string const stamp = str.substr(0, 2);
441 if (firstLine && str.size() >= 2) {
442 // at first we check for a zipped file, because this
443 // information is saved in the first bytes of the file!
444 // also some graphic formats which save the information
445 // in the first line, too.
446 if (prefixIs(str, gzipStamp)) {
449 } else if (stamp == zipStamp) {
452 } else if (stamp == compressStamp) {
456 } else if (stamp == "BM") {
459 } else if (stamp == "\001\332") {
463 // Don't need to use str.at(0), str.at(1) because
464 // we already know that str.size() >= 2
465 } else if (str[0] == 'P') {
481 } else if ((stamp == "II") || (stamp == "MM")) {
484 } else if (prefixIs(str,"%TGIF")) {
487 } else if (prefixIs(str,"#FIG")) {
490 } else if (prefixIs(str,"GIF")) {
493 } else if (str.size() > 3) {
494 int const c = ((str[0] << 24) & (str[1] << 16) &
495 (str[2] << 8) & str[3]);
506 else if (contains(str,"EPSF"))
507 // dummy, if we have wrong file description like
508 // %!PS-Adobe-2.0EPSF"
511 else if (contains(str, "Grace"))
514 else if (contains(str, "JFIF"))
517 else if (contains(str, "%PDF"))
520 else if (contains(str, "PNG"))
523 else if (contains(str, "%!PS-Adobe")) {
526 if (contains(str,"EPSF"))
532 else if (contains(str, "_bits[]"))
535 else if (contains(str, "XPM") || contains(str, "static char *"))
538 else if (contains(str, "BITPIX"))
542 if (!format.empty()) {
543 LYXERR(Debug::GRAPHICS, "Recognised Fileformat: " << format);
547 LYXERR(Debug::GRAPHICS, "filetools(getFormatFromContents)\n"
548 << "\tCouldn't find a known format!");
553 bool FileName::isZippedFile() const
555 string const type = guessFormatFromContents();
556 return contains("gzip zip compress", type) && !type.empty();
560 bool operator==(FileName const & lhs, FileName const & rhs)
562 return lhs.absFilename() == rhs.absFilename();
566 bool operator!=(FileName const & lhs, FileName const & rhs)
568 return lhs.absFilename() != rhs.absFilename();
572 bool operator<(FileName const & lhs, FileName const & rhs)
574 return lhs.absFilename() < rhs.absFilename();
578 bool operator>(FileName const & lhs, FileName const & rhs)
580 return lhs.absFilename() > rhs.absFilename();
584 std::ostream & operator<<(std::ostream & os, FileName const & filename)
586 return os << filename.absFilename();
590 /////////////////////////////////////////////////////////////////////
594 /////////////////////////////////////////////////////////////////////
597 DocFileName::DocFileName()
598 : save_abs_path_(true)
602 DocFileName::DocFileName(string const & abs_filename, bool save_abs)
603 : FileName(abs_filename), save_abs_path_(save_abs), zipped_valid_(false)
607 DocFileName::DocFileName(FileName const & abs_filename, bool save_abs)
608 : FileName(abs_filename), save_abs_path_(save_abs), zipped_valid_(false)
612 void DocFileName::set(string const & name, string const & buffer_path)
614 save_abs_path_ = absolutePath(name);
615 FileName::set(save_abs_path_ ? name : makeAbsPath(name, buffer_path).absFilename());
616 zipped_valid_ = false;
620 void DocFileName::erase()
623 zipped_valid_ = false;
627 string const DocFileName::relFilename(string const & path) const
630 return to_utf8(makeRelPath(qstring_to_ucs4(d->fi.absoluteFilePath()), from_utf8(path)));
634 string const DocFileName::outputFilename(string const & path) const
636 return save_abs_path_ ? absFilename() : relFilename(path);
640 string const DocFileName::mangledFilename(std::string const & dir) const
642 // We need to make sure that every DocFileName instance for a given
643 // filename returns the same mangled name.
644 typedef map<string, string> MangledMap;
645 static MangledMap mangledNames;
646 MangledMap::const_iterator const it = mangledNames.find(absFilename());
647 if (it != mangledNames.end())
650 string const name = absFilename();
652 string mname = os::internal_path(name);
653 // Remove the extension.
654 mname = support::changeExtension(name, string());
655 // The mangled name must be a valid LaTeX name.
656 // The list of characters to keep is probably over-restrictive,
657 // but it is not really a problem.
658 // Apart from non-ASCII characters, at least the following characters
659 // are forbidden: '/', '.', ' ', and ':'.
660 // On windows it is not possible to create files with '<', '>' or '?'
662 static string const keep = "abcdefghijklmnopqrstuvwxyz"
663 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
665 string::size_type pos = 0;
666 while ((pos = mname.find_first_not_of(keep, pos)) != string::npos)
668 // Add the extension back on
669 mname = support::changeExtension(mname, getExtension(name));
671 // Prepend a counter to the filename. This is necessary to make
672 // the mangled name unique.
673 static int counter = 0;
674 std::ostringstream s;
675 s << counter++ << mname;
678 // MiKTeX's YAP (version 2.4.1803) crashes if the file name
679 // is longer than about 160 characters. MiKTeX's pdflatex
680 // is even pickier. A maximum length of 100 has been proven to work.
681 // If dir.size() > max length, all bets are off for YAP. We truncate
682 // the filename nevertheless, keeping a minimum of 10 chars.
684 string::size_type max_length = std::max(100 - ((int)dir.size() + 1), 10);
686 // If the mangled file name is too long, hack it to fit.
687 // We know we're guaranteed to have a unique file name because
689 if (mname.size() > max_length) {
690 int const half = (int(max_length) / 2) - 2;
692 mname = mname.substr(0, half) + "___" +
693 mname.substr(mname.size() - half);
697 mangledNames[absFilename()] = mname;
702 bool DocFileName::isZipped() const
704 if (!zipped_valid_) {
705 zipped_ = isZippedFile();
706 zipped_valid_ = true;
712 string const DocFileName::unzippedFilename() const
714 return unzippedFileName(absFilename());
718 bool operator==(DocFileName const & lhs, DocFileName const & rhs)
720 return lhs.absFilename() == rhs.absFilename()
721 && lhs.saveAbsPath() == rhs.saveAbsPath();
725 bool operator!=(DocFileName const & lhs, DocFileName const & rhs)
727 return !(lhs == rhs);
730 } // namespace support