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 LYXERR(Debug::FILES, "Copying " << name);
170 QFile::remove(name.d->fi.absoluteFilePath());
171 bool success = QFile::copy(d->fi.absoluteFilePath(), name.d->fi.absoluteFilePath());
173 LYXERR0("FileName::copyTo(): Could not copy file "
174 << *this << " to " << name);
179 bool FileName::renameTo(FileName const & name) const
181 bool success = QFile::rename(d->fi.absoluteFilePath(), name.d->fi.absoluteFilePath());
183 LYXERR0("Could not rename file " << *this << " to " << name);
188 bool FileName::moveTo(FileName const & name) const
190 QFile::remove(name.d->fi.absoluteFilePath());
192 bool success = QFile::rename(d->fi.absoluteFilePath(),
193 name.d->fi.absoluteFilePath());
195 LYXERR0("Could not move file " << *this << " to " << name);
200 bool FileName::changePermission(unsigned long int mode) const
202 #if defined (HAVE_CHMOD) && defined (HAVE_MODE_T)
203 if (::chmod(toFilesystemEncoding().c_str(), mode_t(mode)) != 0) {
204 LYXERR0("File " << *this << ": cannot change permission to "
213 string FileName::toFilesystemEncoding() const
215 QByteArray const encoded = QFile::encodeName(d->fi.absoluteFilePath());
216 return string(encoded.begin(), encoded.end());
220 FileName FileName::fromFilesystemEncoding(string const & name)
222 QByteArray const encoded(name.c_str(), name.length());
223 return FileName(fromqstr(QFile::decodeName(encoded)));
227 bool FileName::exists() const
229 return d->fi.exists();
233 bool FileName::isSymLink() const
235 return d->fi.isSymLink();
239 bool FileName::isFileEmpty() const
241 return d->fi.size() == 0;
245 bool FileName::isDirectory() const
247 return d->fi.isDir();
251 bool FileName::isReadOnly() const
253 return d->fi.isReadable() && !d->fi.isWritable();
257 bool FileName::isReadableDirectory() const
259 return d->fi.isDir() && d->fi.isReadable();
263 string FileName::onlyFileName() const
265 return fromqstr(d->fi.fileName());
269 string FileName::onlyFileNameWithoutExt() const
271 return fromqstr(d->fi.baseName());
275 FileName FileName::onlyPath() const
278 path.d->fi.setFile(d->fi.path());
283 bool FileName::isReadableFile() const
285 return d->fi.isFile() && d->fi.isReadable();
289 bool FileName::isWritable() const
291 return d->fi.isWritable();
295 bool FileName::isDirWritable() const
297 LYXERR(Debug::FILES, "isDirWriteable: " << *this);
299 FileName const tmpfl = FileName::tempName(absFilename() + "/lyxwritetest");
309 FileNameList FileName::dirList(string const & ext) const
311 FileNameList dirlist;
312 if (!isDirectory()) {
313 LYXERR0("Directory '" << *this << "' does not exist!");
317 QDir dir = d->fi.absoluteDir();
322 case '.': filter = "*" + toqstr(ext); break;
323 case '*': filter = toqstr(ext); break;
324 default: filter = "*." + toqstr(ext);
326 dir.setNameFilters(QStringList(filter));
327 LYXERR(Debug::FILES, "filtering on extension "
328 << fromqstr(filter) << " is requested.");
331 QFileInfoList list = dir.entryInfoList();
332 for (int i = 0; i != list.size(); ++i) {
333 FileName fi(fromqstr(list.at(i).absoluteFilePath()));
334 dirlist.push_back(fi);
335 LYXERR(Debug::FILES, "found file " << fi);
342 static int make_tempfile(char * templ)
344 #if defined(HAVE_MKSTEMP)
345 return ::mkstemp(templ);
346 #elif defined(HAVE_MKTEMP)
347 // This probably just barely works...
349 # if defined (HAVE_OPEN)
350 # if (!defined S_IRUSR)
351 # define S_IRUSR S_IREAD
352 # define S_IWUSR S_IWRITE
354 return ::open(templ, O_RDWR | O_CREAT | O_EXCL, S_IRUSR | S_IWUSR);
355 # elif defined (HAVE__OPEN)
356 return ::_open(templ,
357 _O_RDWR | _O_CREAT | _O_EXCL,
358 _S_IREAD | _S_IWRITE);
360 # error No open() function.
368 FileName FileName::tempName(string const & mask)
370 FileName tmp_name(mask);
372 if (tmp_name.d->fi.isAbsolute())
375 tmpfl = package().temp_dir().absFilename() + "/" + mask;
377 #if defined (HAVE_GETPID)
378 tmpfl += convert<string>(getpid());
379 #elif defined (HAVE__GETPID)
380 tmpfl += convert<string>(_getpid());
382 # error No getpid() function
386 // The supposedly safe mkstemp version
387 // FIXME: why not using std::string directly?
388 boost::scoped_array<char> tmpl(new char[tmpfl.length() + 1]); // + 1 for '\0'
389 tmpfl.copy(tmpl.get(), string::npos);
390 tmpl[tmpfl.length()] = '\0'; // terminator
392 int const tmpf = make_tempfile(tmpl.get());
394 string const t(to_utf8(from_filesystem8bit(tmpl.get())));
395 #if defined (HAVE_CLOSE)
397 #elif defined (HAVE__CLOSE)
400 # error No x() function.
402 LYXERR(Debug::FILES, "Temporary file `" << t << "' created.");
405 LYXERR(Debug::FILES, "LyX Error: Unable to create temporary file.");
410 FileName FileName::getcwd()
412 return FileName(".");
416 time_t FileName::lastModified() const
418 // QFileInfo caches information about the file. So, in case this file has
419 // been touched between the object creation and now, we refresh the file
422 return d->fi.lastModified().toTime_t();
426 bool FileName::chdir() const
428 return QDir::setCurrent(d->fi.absoluteFilePath());
432 extern unsigned long sum(char const * file);
434 unsigned long FileName::checksum() const
437 //LYXERR0("File \"" << absFilename() << "\" does not exist!");
440 // a directory may be passed here so we need to test it. (bug 3622)
442 LYXERR0('"' << absFilename() << "\" is a directory!");
445 if (!lyxerr.debugging(Debug::FILES))
446 return sum(absFilename().c_str());
450 unsigned long r = sum(absFilename().c_str());
451 lyxerr << "Checksumming \"" << absFilename() << "\" lasted "
452 << t.elapsed() << " ms." << endl;
457 bool FileName::removeFile() const
459 bool const success = QFile::remove(d->fi.absoluteFilePath());
460 if (!success && exists())
461 LYXERR0("Could not delete file " << *this);
466 static bool rmdir(QFileInfo const & fi)
468 QDir dir(fi.absoluteFilePath());
469 QFileInfoList list = dir.entryInfoList();
471 for (int i = 0; i != list.size(); ++i) {
472 if (list.at(i).fileName() == ".")
474 if (list.at(i).fileName() == "..")
477 if (list.at(i).isDir()) {
478 LYXERR(Debug::FILES, "Removing dir "
479 << fromqstr(list.at(i).absoluteFilePath()));
480 removed = rmdir(list.at(i));
483 LYXERR(Debug::FILES, "Removing file "
484 << fromqstr(list.at(i).absoluteFilePath()));
485 removed = dir.remove(list.at(i).fileName());
489 LYXERR0("Could not delete "
490 << fromqstr(list.at(i).absoluteFilePath()));
493 QDir parent = fi.absolutePath();
494 success &= parent.rmdir(fi.fileName());
499 bool FileName::destroyDirectory() const
501 bool const success = rmdir(d->fi);
503 LYXERR0("Could not delete " << *this);
509 static int mymkdir(char const * pathname, unsigned long int mode)
511 // FIXME: why don't we have mode_t in lyx::mkdir prototype ??
513 # if MKDIR_TAKES_ONE_ARG
515 return ::mkdir(pathname);
516 // FIXME: "Permissions of created directories are ignored on this system."
519 return ::mkdir(pathname, mode_t(mode));
521 #elif defined(_WIN32)
523 return CreateDirectory(pathname, 0) != 0 ? 0 : -1;
524 // FIXME: "Permissions of created directories are ignored on this system."
526 return ::_mkdir(pathname);
527 // FIXME: "Permissions of created directories are ignored on this system."
529 # error "Don't know how to create a directory on this system."
535 bool FileName::createDirectory(int permission) const
537 LASSERT(!empty(), /**/);
538 return mymkdir(toFilesystemEncoding().c_str(), permission) == 0;
542 bool FileName::createPath() const
544 LASSERT(!empty(), /**/);
549 bool success = dir.mkpath(d->fi.absoluteFilePath());
551 LYXERR0("Cannot create path '" << *this << "'!");
556 docstring const FileName::absoluteFilePath() const
558 return qstring_to_ucs4(d->fi.absoluteFilePath());
562 docstring FileName::displayName(int threshold) const
564 return makeDisplayPath(absFilename(), threshold);
568 docstring FileName::fileContents(string const & encoding) const
570 if (!isReadableFile()) {
571 LYXERR0("File '" << *this << "' is not redable!");
575 QFile file(d->fi.absoluteFilePath());
576 if (!file.open(QIODevice::ReadOnly)) {
577 LYXERR0("File '" << *this
578 << "' could not be opened in read only mode!");
581 QByteArray contents = file.readAll();
584 if (contents.isEmpty()) {
585 LYXERR(Debug::FILES, "File '" << *this
586 << "' is either empty or some error happened while reading it.");
591 if (encoding.empty() || encoding == "UTF-8")
592 s = QString::fromUtf8(contents.data());
593 else if (encoding == "ascii")
594 s = QString::fromAscii(contents.data());
595 else if (encoding == "local8bit")
596 s = QString::fromLocal8Bit(contents.data());
597 else if (encoding == "latin1")
598 s = QString::fromLatin1(contents.data());
600 return qstring_to_ucs4(s);
604 void FileName::changeExtension(string const & extension)
606 // FIXME: use Qt native methods...
607 string const oldname = absFilename();
608 string::size_type const last_slash = oldname.rfind('/');
609 string::size_type last_dot = oldname.rfind('.');
610 if (last_dot < last_slash && last_slash != string::npos)
611 last_dot = string::npos;
614 // Make sure the extension starts with a dot
615 if (!extension.empty() && extension[0] != '.')
616 ext= '.' + extension;
620 set(oldname.substr(0, last_dot) + ext);
624 string FileName::guessFormatFromContents() const
626 // the different filetypes and what they contain in one of the first lines
627 // (dots are any characters). (Herbert 20020131)
630 // EPS %!PS-Adobe-3.0 EPSF...
637 // PBM P1... or P4 (B/W)
638 // PGM P2... or P5 (Grayscale)
639 // PPM P3... or P6 (color)
640 // PS %!PS-Adobe-2.0 or 1.0, no "EPSF"!
641 // SGI \001\332... (decimal 474)
643 // TIFF II... or MM...
645 // XPM /* XPM */ sometimes missing (f.ex. tgif-export)
646 // ...static char *...
647 // XWD \000\000\000\151 (0x00006900) decimal 105
649 // GZIP \037\213 http://www.ietf.org/rfc/rfc1952.txt
650 // ZIP PK... http://www.halyava.ru/document/ind_arch.htm
651 // Z \037\235 UNIX compress
654 if (empty() || !isReadableFile())
657 ifstream ifs(toFilesystemEncoding().c_str());
659 // Couldn't open file...
663 static string const gzipStamp = "\037\213";
666 static string const zipStamp = "PK";
669 static string const compressStamp = "\037\235";
671 // Maximum strings to read
672 int const max_count = 50;
677 bool firstLine = true;
678 while ((count++ < max_count) && format.empty()) {
680 LYXERR(Debug::GRAPHICS, "filetools(getFormatFromContents)\n"
681 << "\tFile type not recognised before EOF!");
686 string const stamp = str.substr(0, 2);
687 if (firstLine && str.size() >= 2) {
688 // at first we check for a zipped file, because this
689 // information is saved in the first bytes of the file!
690 // also some graphic formats which save the information
691 // in the first line, too.
692 if (prefixIs(str, gzipStamp)) {
695 } else if (stamp == zipStamp) {
698 } else if (stamp == compressStamp) {
702 } else if (stamp == "BM") {
705 } else if (stamp == "\001\332") {
709 // Don't need to use str.at(0), str.at(1) because
710 // we already know that str.size() >= 2
711 } else if (str[0] == 'P') {
727 } else if ((stamp == "II") || (stamp == "MM")) {
730 } else if (prefixIs(str,"%TGIF")) {
733 } else if (prefixIs(str,"#FIG")) {
736 } else if (prefixIs(str,"GIF")) {
739 } else if (str.size() > 3) {
740 int const c = ((str[0] << 24) & (str[1] << 16) &
741 (str[2] << 8) & str[3]);
752 else if (contains(str,"EPSF"))
753 // dummy, if we have wrong file description like
754 // %!PS-Adobe-2.0EPSF"
757 else if (contains(str, "Grace"))
760 else if (contains(str, "JFIF"))
763 else if (contains(str, "%PDF"))
766 else if (contains(str, "PNG"))
769 else if (contains(str, "%!PS-Adobe")) {
772 if (contains(str,"EPSF"))
778 else if (contains(str, "_bits[]"))
781 else if (contains(str, "XPM") || contains(str, "static char *"))
784 else if (contains(str, "BITPIX"))
788 if (!format.empty()) {
789 LYXERR(Debug::GRAPHICS, "Recognised Fileformat: " << format);
793 LYXERR(Debug::GRAPHICS, "filetools(getFormatFromContents)\n"
794 << "\tCouldn't find a known format!");
799 bool FileName::isZippedFile() const
801 string const type = guessFormatFromContents();
802 return contains("gzip zip compress", type) && !type.empty();
806 docstring const FileName::relPath(string const & path) const
809 return makeRelPath(absoluteFilePath(), from_utf8(path));
813 bool operator==(FileName const & lhs, FileName const & rhs)
815 return lhs.absFilename() == rhs.absFilename();
819 bool operator!=(FileName const & lhs, FileName const & rhs)
821 return lhs.absFilename() != rhs.absFilename();
825 bool operator<(FileName const & lhs, FileName const & rhs)
827 return lhs.absFilename() < rhs.absFilename();
831 bool operator>(FileName const & lhs, FileName const & rhs)
833 return lhs.absFilename() > rhs.absFilename();
837 ostream & operator<<(ostream & os, FileName const & filename)
839 return os << filename.absFilename();
843 /////////////////////////////////////////////////////////////////////
847 /////////////////////////////////////////////////////////////////////
850 DocFileName::DocFileName()
851 : save_abs_path_(true)
855 DocFileName::DocFileName(string const & abs_filename, bool save_abs)
856 : FileName(abs_filename), save_abs_path_(save_abs), zipped_valid_(false)
860 DocFileName::DocFileName(FileName const & abs_filename, bool save_abs)
861 : FileName(abs_filename), save_abs_path_(save_abs), zipped_valid_(false)
865 void DocFileName::set(string const & name, string const & buffer_path)
868 bool const nameIsAbsolute = isAbsolute();
869 save_abs_path_ = nameIsAbsolute;
871 FileName::set(makeAbsPath(name, buffer_path).absFilename());
872 zipped_valid_ = false;
876 void DocFileName::erase()
879 zipped_valid_ = false;
883 string DocFileName::relFilename(string const & path) const
886 return to_utf8(relPath(path));
890 string DocFileName::outputFilename(string const & path) const
892 return save_abs_path_ ? absFilename() : relFilename(path);
896 string DocFileName::mangledFilename(string const & dir) const
898 // We need to make sure that every DocFileName instance for a given
899 // filename returns the same mangled name.
900 typedef map<string, string> MangledMap;
901 static MangledMap mangledNames;
902 MangledMap::const_iterator const it = mangledNames.find(absFilename());
903 if (it != mangledNames.end())
906 string const name = absFilename();
908 string mname = os::internal_path(name);
909 // Remove the extension.
910 mname = support::changeExtension(name, string());
911 // The mangled name must be a valid LaTeX name.
912 // The list of characters to keep is probably over-restrictive,
913 // but it is not really a problem.
914 // Apart from non-ASCII characters, at least the following characters
915 // are forbidden: '/', '.', ' ', and ':'.
916 // On windows it is not possible to create files with '<', '>' or '?'
918 static string const keep = "abcdefghijklmnopqrstuvwxyz"
919 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
921 string::size_type pos = 0;
922 while ((pos = mname.find_first_not_of(keep, pos)) != string::npos)
924 // Add the extension back on
925 mname = support::changeExtension(mname, getExtension(name));
927 // Prepend a counter to the filename. This is necessary to make
928 // the mangled name unique.
929 static int counter = 0;
931 s << counter++ << mname;
934 // MiKTeX's YAP (version 2.4.1803) crashes if the file name
935 // is longer than about 160 characters. MiKTeX's pdflatex
936 // is even pickier. A maximum length of 100 has been proven to work.
937 // If dir.size() > max length, all bets are off for YAP. We truncate
938 // the filename nevertheless, keeping a minimum of 10 chars.
940 string::size_type max_length = max(100 - ((int)dir.size() + 1), 10);
942 // If the mangled file name is too long, hack it to fit.
943 // We know we're guaranteed to have a unique file name because
945 if (mname.size() > max_length) {
946 int const half = (int(max_length) / 2) - 2;
948 mname = mname.substr(0, half) + "___" +
949 mname.substr(mname.size() - half);
953 mangledNames[absFilename()] = mname;
958 bool DocFileName::isZipped() const
960 if (!zipped_valid_) {
961 zipped_ = isZippedFile();
962 zipped_valid_ = true;
968 string DocFileName::unzippedFilename() const
970 return unzippedFileName(absFilename());
974 bool operator==(DocFileName const & lhs, DocFileName const & rhs)
976 return lhs.absFilename() == rhs.absFilename()
977 && lhs.saveAbsPath() == rhs.saveAbsPath();
981 bool operator!=(DocFileName const & lhs, DocFileName const & rhs)
983 return !(lhs == rhs);
986 } // namespace support