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/lassert.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 string FileName::onlyFileNameWithoutExt() const
270 return fromqstr(d->fi.baseName());
274 FileName FileName::onlyPath() const
277 path.d->fi.setFile(d->fi.path());
282 bool FileName::isReadableFile() const
284 return d->fi.isFile() && d->fi.isReadable();
288 bool FileName::isWritable() const
290 return d->fi.isWritable();
294 bool FileName::isDirWritable() const
296 LYXERR(Debug::FILES, "isDirWriteable: " << *this);
298 FileName const tmpfl = FileName::tempName(absFilename() + "/lyxwritetest");
308 FileNameList FileName::dirList(string const & ext) const
310 FileNameList dirlist;
311 if (!isDirectory()) {
312 LYXERR0("Directory '" << *this << "' does not exist!");
316 QDir dir = d->fi.absoluteDir();
321 case '.': filter = "*" + toqstr(ext); break;
322 case '*': filter = toqstr(ext); break;
323 default: filter = "*." + toqstr(ext);
325 dir.setNameFilters(QStringList(filter));
326 LYXERR(Debug::FILES, "filtering on extension "
327 << fromqstr(filter) << " is requested.");
330 QFileInfoList list = dir.entryInfoList();
331 for (int i = 0; i != list.size(); ++i) {
332 FileName fi(fromqstr(list.at(i).absoluteFilePath()));
333 dirlist.push_back(fi);
334 LYXERR(Debug::FILES, "found file " << fi);
341 static int make_tempfile(char * templ)
343 #if defined(HAVE_MKSTEMP)
344 return ::mkstemp(templ);
345 #elif defined(HAVE_MKTEMP)
346 // This probably just barely works...
348 # if defined (HAVE_OPEN)
349 # if (!defined S_IRUSR)
350 # define S_IRUSR S_IREAD
351 # define S_IWUSR S_IWRITE
353 return ::open(templ, O_RDWR | O_CREAT | O_EXCL, S_IRUSR | S_IWUSR);
354 # elif defined (HAVE__OPEN)
355 return ::_open(templ,
356 _O_RDWR | _O_CREAT | _O_EXCL,
357 _S_IREAD | _S_IWRITE);
359 # error No open() function.
367 FileName FileName::tempName(string const & mask)
369 FileName tmp_name(mask);
371 if (tmp_name.d->fi.isAbsolute())
374 tmpfl = package().temp_dir().absFilename() + "/" + mask;
376 #if defined (HAVE_GETPID)
377 tmpfl += convert<string>(getpid());
378 #elif defined (HAVE__GETPID)
379 tmpfl += convert<string>(_getpid());
381 # error No getpid() function
385 // The supposedly safe mkstemp version
386 // FIXME: why not using std::string directly?
387 boost::scoped_array<char> tmpl(new char[tmpfl.length() + 1]); // + 1 for '\0'
388 tmpfl.copy(tmpl.get(), string::npos);
389 tmpl[tmpfl.length()] = '\0'; // terminator
391 int const tmpf = make_tempfile(tmpl.get());
393 string const t(to_utf8(from_filesystem8bit(tmpl.get())));
394 #if defined (HAVE_CLOSE)
396 #elif defined (HAVE__CLOSE)
399 # error No x() function.
401 LYXERR(Debug::FILES, "Temporary file `" << t << "' created.");
404 LYXERR(Debug::FILES, "LyX Error: Unable to create temporary file.");
409 FileName FileName::getcwd()
411 return FileName(".");
415 time_t FileName::lastModified() const
417 return d->fi.lastModified().toTime_t();
421 bool FileName::chdir() const
423 return QDir::setCurrent(d->fi.absoluteFilePath());
427 extern unsigned long sum(char const * file);
429 unsigned long FileName::checksum() const
432 //LYXERR0("File \"" << absFilename() << "\" does not exist!");
435 // a directory may be passed here so we need to test it. (bug 3622)
437 LYXERR0('"' << absFilename() << "\" is a directory!");
440 if (!lyxerr.debugging(Debug::FILES))
441 return sum(absFilename().c_str());
445 unsigned long r = sum(absFilename().c_str());
446 lyxerr << "Checksumming \"" << absFilename() << "\" lasted "
447 << t.elapsed() << " ms." << endl;
452 bool FileName::removeFile() const
454 bool const success = QFile::remove(d->fi.absoluteFilePath());
455 if (!success && exists())
456 LYXERR0("Could not delete file " << *this);
461 static bool rmdir(QFileInfo const & fi)
463 QDir dir(fi.absoluteFilePath());
464 QFileInfoList list = dir.entryInfoList();
466 for (int i = 0; i != list.size(); ++i) {
467 if (list.at(i).fileName() == ".")
469 if (list.at(i).fileName() == "..")
472 if (list.at(i).isDir()) {
473 LYXERR(Debug::FILES, "Removing dir "
474 << fromqstr(list.at(i).absoluteFilePath()));
475 removed = rmdir(list.at(i));
478 LYXERR(Debug::FILES, "Removing file "
479 << fromqstr(list.at(i).absoluteFilePath()));
480 removed = dir.remove(list.at(i).fileName());
484 LYXERR0("Could not delete "
485 << fromqstr(list.at(i).absoluteFilePath()));
488 QDir parent = fi.absolutePath();
489 success &= parent.rmdir(fi.fileName());
494 bool FileName::destroyDirectory() const
496 bool const success = rmdir(d->fi);
498 LYXERR0("Could not delete " << *this);
504 static int mymkdir(char const * pathname, unsigned long int mode)
506 // FIXME: why don't we have mode_t in lyx::mkdir prototype ??
508 # if MKDIR_TAKES_ONE_ARG
510 return ::mkdir(pathname);
511 // FIXME: "Permissions of created directories are ignored on this system."
514 return ::mkdir(pathname, mode_t(mode));
516 #elif defined(_WIN32)
518 return CreateDirectory(pathname, 0) != 0 ? 0 : -1;
519 // FIXME: "Permissions of created directories are ignored on this system."
521 return ::_mkdir(pathname);
522 // FIXME: "Permissions of created directories are ignored on this system."
524 # error "Don't know how to create a directory on this system."
530 bool FileName::createDirectory(int permission) const
532 LASSERT(!empty(), /**/);
533 return mymkdir(toFilesystemEncoding().c_str(), permission) == 0;
537 bool FileName::createPath() const
539 LASSERT(!empty(), /**/);
544 bool success = dir.mkpath(d->fi.absoluteFilePath());
546 LYXERR0("Cannot create path '" << *this << "'!");
551 docstring const FileName::absoluteFilePath() const
553 return qstring_to_ucs4(d->fi.absoluteFilePath());
557 docstring FileName::displayName(int threshold) const
559 return makeDisplayPath(absFilename(), threshold);
563 docstring FileName::fileContents(string const & encoding) const
565 if (!isReadableFile()) {
566 LYXERR0("File '" << *this << "' is not redable!");
570 QFile file(d->fi.absoluteFilePath());
571 if (!file.open(QIODevice::ReadOnly)) {
572 LYXERR0("File '" << *this
573 << "' could not be opened in read only mode!");
576 QByteArray contents = file.readAll();
579 if (contents.isEmpty()) {
580 LYXERR(Debug::FILES, "File '" << *this
581 << "' is either empty or some error happened while reading it.");
586 if (encoding.empty() || encoding == "UTF-8")
587 s = QString::fromUtf8(contents.data());
588 else if (encoding == "ascii")
589 s = QString::fromAscii(contents.data());
590 else if (encoding == "local8bit")
591 s = QString::fromLocal8Bit(contents.data());
592 else if (encoding == "latin1")
593 s = QString::fromLatin1(contents.data());
595 return qstring_to_ucs4(s);
599 void FileName::changeExtension(string const & extension)
601 // FIXME: use Qt native methods...
602 string const oldname = absFilename();
603 string::size_type const last_slash = oldname.rfind('/');
604 string::size_type last_dot = oldname.rfind('.');
605 if (last_dot < last_slash && last_slash != string::npos)
606 last_dot = string::npos;
609 // Make sure the extension starts with a dot
610 if (!extension.empty() && extension[0] != '.')
611 ext= '.' + extension;
615 set(oldname.substr(0, last_dot) + ext);
619 string FileName::guessFormatFromContents() const
621 // the different filetypes and what they contain in one of the first lines
622 // (dots are any characters). (Herbert 20020131)
625 // EPS %!PS-Adobe-3.0 EPSF...
632 // PBM P1... or P4 (B/W)
633 // PGM P2... or P5 (Grayscale)
634 // PPM P3... or P6 (color)
635 // PS %!PS-Adobe-2.0 or 1.0, no "EPSF"!
636 // SGI \001\332... (decimal 474)
638 // TIFF II... or MM...
640 // XPM /* XPM */ sometimes missing (f.ex. tgif-export)
641 // ...static char *...
642 // XWD \000\000\000\151 (0x00006900) decimal 105
644 // GZIP \037\213 http://www.ietf.org/rfc/rfc1952.txt
645 // ZIP PK... http://www.halyava.ru/document/ind_arch.htm
646 // Z \037\235 UNIX compress
649 if (empty() || !isReadableFile())
652 ifstream ifs(toFilesystemEncoding().c_str());
654 // Couldn't open file...
658 static string const gzipStamp = "\037\213";
661 static string const zipStamp = "PK";
664 static string const compressStamp = "\037\235";
666 // Maximum strings to read
667 int const max_count = 50;
672 bool firstLine = true;
673 while ((count++ < max_count) && format.empty()) {
675 LYXERR(Debug::GRAPHICS, "filetools(getFormatFromContents)\n"
676 << "\tFile type not recognised before EOF!");
681 string const stamp = str.substr(0, 2);
682 if (firstLine && str.size() >= 2) {
683 // at first we check for a zipped file, because this
684 // information is saved in the first bytes of the file!
685 // also some graphic formats which save the information
686 // in the first line, too.
687 if (prefixIs(str, gzipStamp)) {
690 } else if (stamp == zipStamp) {
693 } else if (stamp == compressStamp) {
697 } else if (stamp == "BM") {
700 } else if (stamp == "\001\332") {
704 // Don't need to use str.at(0), str.at(1) because
705 // we already know that str.size() >= 2
706 } else if (str[0] == 'P') {
722 } else if ((stamp == "II") || (stamp == "MM")) {
725 } else if (prefixIs(str,"%TGIF")) {
728 } else if (prefixIs(str,"#FIG")) {
731 } else if (prefixIs(str,"GIF")) {
734 } else if (str.size() > 3) {
735 int const c = ((str[0] << 24) & (str[1] << 16) &
736 (str[2] << 8) & str[3]);
747 else if (contains(str,"EPSF"))
748 // dummy, if we have wrong file description like
749 // %!PS-Adobe-2.0EPSF"
752 else if (contains(str, "Grace"))
755 else if (contains(str, "JFIF"))
758 else if (contains(str, "%PDF"))
761 else if (contains(str, "PNG"))
764 else if (contains(str, "%!PS-Adobe")) {
767 if (contains(str,"EPSF"))
773 else if (contains(str, "_bits[]"))
776 else if (contains(str, "XPM") || contains(str, "static char *"))
779 else if (contains(str, "BITPIX"))
783 if (!format.empty()) {
784 LYXERR(Debug::GRAPHICS, "Recognised Fileformat: " << format);
788 LYXERR(Debug::GRAPHICS, "filetools(getFormatFromContents)\n"
789 << "\tCouldn't find a known format!");
794 bool FileName::isZippedFile() const
796 string const type = guessFormatFromContents();
797 return contains("gzip zip compress", type) && !type.empty();
801 docstring const FileName::relPath(string const & path) const
804 return makeRelPath(absoluteFilePath(), from_utf8(path));
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 bool operator>(FileName const & lhs, FileName const & rhs)
828 return lhs.absFilename() > rhs.absFilename();
832 ostream & operator<<(ostream & os, FileName const & filename)
834 return os << filename.absFilename();
838 /////////////////////////////////////////////////////////////////////
842 /////////////////////////////////////////////////////////////////////
845 DocFileName::DocFileName()
846 : save_abs_path_(true)
850 DocFileName::DocFileName(string const & abs_filename, bool save_abs)
851 : FileName(abs_filename), save_abs_path_(save_abs), zipped_valid_(false)
855 DocFileName::DocFileName(FileName const & abs_filename, bool save_abs)
856 : FileName(abs_filename), save_abs_path_(save_abs), zipped_valid_(false)
860 void DocFileName::set(string const & name, string const & buffer_path)
863 bool const nameIsAbsolute = isAbsolute();
864 save_abs_path_ = nameIsAbsolute;
866 FileName::set(makeAbsPath(name, buffer_path).absFilename());
867 zipped_valid_ = false;
871 void DocFileName::erase()
874 zipped_valid_ = false;
878 string DocFileName::relFilename(string const & path) const
881 return to_utf8(relPath(path));
885 string DocFileName::outputFilename(string const & path) const
887 return save_abs_path_ ? absFilename() : relFilename(path);
891 string DocFileName::mangledFilename(string const & dir) const
893 // We need to make sure that every DocFileName instance for a given
894 // filename returns the same mangled name.
895 typedef map<string, string> MangledMap;
896 static MangledMap mangledNames;
897 MangledMap::const_iterator const it = mangledNames.find(absFilename());
898 if (it != mangledNames.end())
901 string const name = absFilename();
903 string mname = os::internal_path(name);
904 // Remove the extension.
905 mname = support::changeExtension(name, string());
906 // The mangled name must be a valid LaTeX name.
907 // The list of characters to keep is probably over-restrictive,
908 // but it is not really a problem.
909 // Apart from non-ASCII characters, at least the following characters
910 // are forbidden: '/', '.', ' ', and ':'.
911 // On windows it is not possible to create files with '<', '>' or '?'
913 static string const keep = "abcdefghijklmnopqrstuvwxyz"
914 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
916 string::size_type pos = 0;
917 while ((pos = mname.find_first_not_of(keep, pos)) != string::npos)
919 // Add the extension back on
920 mname = support::changeExtension(mname, getExtension(name));
922 // Prepend a counter to the filename. This is necessary to make
923 // the mangled name unique.
924 static int counter = 0;
926 s << counter++ << mname;
929 // MiKTeX's YAP (version 2.4.1803) crashes if the file name
930 // is longer than about 160 characters. MiKTeX's pdflatex
931 // is even pickier. A maximum length of 100 has been proven to work.
932 // If dir.size() > max length, all bets are off for YAP. We truncate
933 // the filename nevertheless, keeping a minimum of 10 chars.
935 string::size_type max_length = max(100 - ((int)dir.size() + 1), 10);
937 // If the mangled file name is too long, hack it to fit.
938 // We know we're guaranteed to have a unique file name because
940 if (mname.size() > max_length) {
941 int const half = (int(max_length) / 2) - 2;
943 mname = mname.substr(0, half) + "___" +
944 mname.substr(mname.size() - half);
948 mangledNames[absFilename()] = mname;
953 bool DocFileName::isZipped() const
955 if (!zipped_valid_) {
956 zipped_ = isZippedFile();
957 zipped_valid_ = true;
963 string DocFileName::unzippedFilename() const
965 return unzippedFileName(absFilename());
969 bool operator==(DocFileName const & lhs, DocFileName const & rhs)
971 return lhs.absFilename() == rhs.absFilename()
972 && lhs.saveAbsPath() == rhs.saveAbsPath();
976 bool operator!=(DocFileName const & lhs, DocFileName const & rhs)
978 return !(lhs == rhs);
981 } // namespace support