X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fsupport%2FFileName.cpp;h=929c4165bebd541bead6ce6e7a6a61774e12f89d;hb=8d640dc77608bedddb5b00982c23665584f52d21;hp=cb08ba242a46e56d4b73128370b72c1406d3f786;hpb=ccc77c73da81a67656bbe196c0fab55b63d231d3;p=lyx.git diff --git a/src/support/FileName.cpp b/src/support/FileName.cpp index cb08ba242a..929c4165be 100644 --- a/src/support/FileName.cpp +++ b/src/support/FileName.cpp @@ -13,12 +13,11 @@ #include "support/FileName.h" #include "support/FileNameList.h" -#include "support/convert.h" #include "support/debug.h" #include "support/filetools.h" #include "support/lassert.h" #include "support/lstrings.h" -#include "support/qstring_helpers.h" +#include "support/mutex.h" #include "support/os.h" #include "support/Package.h" #include "support/qstring_helpers.h" @@ -32,7 +31,6 @@ #include #include -#include #include #include @@ -60,19 +58,6 @@ #include #include -#if defined(HAVE_MKSTEMP) && ! defined(HAVE_DECL_MKSTEMP) -extern "C" int mkstemp(char *); -#endif - -#if !defined(HAVE_MKSTEMP) && defined(HAVE_MKTEMP) -# ifdef HAVE_IO_H -# include -# endif -# ifdef HAVE_PROCESS_H -# include -# endif -#endif - // Three implementations of checksum(), depending on having mmap support or not. #if defined(HAVE_MMAP) && defined(HAVE_MUNMAP) #define SUM_WITH_MMAP @@ -80,6 +65,7 @@ extern "C" int mkstemp(char *); #endif // SUM_WITH_MMAP using namespace std; +using namespace lyx::support; // OK, this is ugly, but it is the only workaround I found to compile // with gcc (any version) on a system which uses a non-GNU toolchain. @@ -105,21 +91,13 @@ struct FileName::Private Private(string const & abs_filename) : fi(toqstr(abs_filename)) { - name = abs_filename; + name = fromqstr(fi.absoluteFilePath()); fi.setCaching(fi.exists() ? true : false); } /// inline void refresh() { -// There seems to be a bug in Qt >= 4.2.0, at least, that causes problems with -// QFileInfo::refresh() on *nix. So we recreate the object in that case. -// FIXME: When Trolltech fixes the bug, we will have to replace 0x999999 below -// with the actual working minimum version. -#if defined(_WIN32) || (QT_VERSION >= 0x999999) fi.refresh(); -#else - fi = QFileInfo(fi.absoluteFilePath()); -#endif } @@ -152,7 +130,7 @@ FileName::FileName(string const & abs_filename) : d(abs_filename.empty() ? new Private : new Private(abs_filename)) { //LYXERR(Debug::FILES, "FileName(" << abs_filename << ')'); - LASSERT(empty() || isAbsolute(d->name), /**/); + LATTEST(empty() || isAbsolute(d->name)); } @@ -198,7 +176,7 @@ bool FileName::isAbsolute(string const & name) } -string FileName::absFilename() const +string FileName::absFileName() const { return d->name; } @@ -206,28 +184,28 @@ string FileName::absFilename() const string FileName::realPath() const { - return os::real_path(toFilesystemEncoding()); + return os::real_path(absFileName()); } void FileName::set(string const & name) { - d->name = name; d->fi.setFile(toqstr(name)); + d->name = fromqstr(d->fi.absoluteFilePath()); //LYXERR(Debug::FILES, "FileName::set(" << name << ')'); - LASSERT(empty() || isAbsolute(d->name), /**/); + LATTEST(empty() || isAbsolute(d->name)); } void FileName::set(FileName const & rhs, string const & suffix) { - d->name = rhs.d->name + suffix; if (!rhs.d->fi.isDir()) d->fi.setFile(rhs.d->fi.filePath() + toqstr(suffix)); else d->fi.setFile(QDir(rhs.d->fi.absoluteFilePath()), toqstr(suffix)); + d->name = fromqstr(d->fi.absoluteFilePath()); //LYXERR(Debug::FILES, "FileName::set(" << d->name << ')'); - LASSERT(empty() || isAbsolute(d->name), /**/); + LATTEST(empty() || isAbsolute(d->name)); } @@ -238,9 +216,26 @@ void FileName::erase() } -bool FileName::copyTo(FileName const & name) const +bool FileName::copyTo(FileName const & name, bool keepsymlink) const { - LYXERR(Debug::FILES, "Copying " << name); + FileNameSet visited; + return copyTo(name, keepsymlink, visited); +} + + +bool FileName::copyTo(FileName const & name, bool keepsymlink, + FileName::FileNameSet & visited) const +{ + LYXERR(Debug::FILES, "Copying " << name << " keep symlink: " << keepsymlink); + if (keepsymlink && name.isSymLink()) { + visited.insert(*this); + FileName const target(fromqstr(name.d->fi.symLinkTarget())); + if (visited.find(target) != visited.end()) { + LYXERR(Debug::FILES, "Found circular symlink: " << target); + return false; + } + return copyTo(target, true); + } QFile::remove(name.d->fi.absoluteFilePath()); bool success = QFile::copy(d->fi.absoluteFilePath(), name.d->fi.absoluteFilePath()); if (!success) @@ -252,6 +247,7 @@ bool FileName::copyTo(FileName const & name) const bool FileName::renameTo(FileName const & name) const { + LYXERR(Debug::FILES, "Renaming " << name << " as " << *this); bool success = QFile::rename(d->fi.absoluteFilePath(), name.d->fi.absoluteFilePath()); if (!success) LYXERR0("Could not rename file " << *this << " to " << name); @@ -261,6 +257,7 @@ bool FileName::renameTo(FileName const & name) const bool FileName::moveTo(FileName const & name) const { + LYXERR(Debug::FILES, "Moving " << name << " to " << *this); QFile::remove(name.d->fi.absoluteFilePath()); bool success = QFile::rename(d->fi.absoluteFilePath(), @@ -286,13 +283,22 @@ bool FileName::changePermission(unsigned long int mode) const string FileName::toFilesystemEncoding() const { - // FIXME: This doesn't work on Windows for non ascii file names with Qt < 4.4. - // Provided that Windows package uses Qt4.4, this isn't a problem. + // This doesn't work on Windows for non ascii file names. QByteArray const encoded = QFile::encodeName(d->fi.absoluteFilePath()); return string(encoded.begin(), encoded.end()); } +string FileName::toSafeFilesystemEncoding(os::file_access how) const +{ + // This will work on Windows for non ascii file names. + QString const safe_path = + toqstr(os::safe_internal_path(absFileName(), how)); + QByteArray const encoded = QFile::encodeName(safe_path); + return string(encoded.begin(), encoded.end()); +} + + FileName FileName::fromFilesystemEncoding(string const & name) { QByteArray const encoded(name.c_str(), name.length()); @@ -312,6 +318,9 @@ bool FileName::isSymLink() const } +//QFileInfo caching info might fool this test if file was changed meanwhile. +//refresh() helps, but we don't want to put it blindly here, because it might +//trigger slowdown on networked file systems. bool FileName::isFileEmpty() const { LASSERT(!empty(), return true); @@ -373,6 +382,19 @@ FileName FileName::onlyPath() const } +FileName FileName::parentPath() const +{ + FileName path; + // return empty path for parent of root dir + // parent of empty path is empty too + if (empty() || d->fi.isRoot()) + return path; + path.d->fi.setFile(d->fi.path()); + path.d->name = fromqstr(path.d->fi.absoluteFilePath()); + return path; +} + + bool FileName::isReadableFile() const { return !empty() && d->fi.isFile() && d->fi.isReadable(); @@ -407,7 +429,9 @@ FileNameList FileName::dirList(string const & ext) const return dirlist; } - QDir dir = d->fi.absoluteDir(); + // If the directory is specified without a trailing '/', absoluteDir() + // would return the parent dir, so we must use absoluteFilePath() here. + QDir dir = d->fi.absoluteFilePath(); if (!ext.empty()) { QString filter; @@ -432,34 +456,6 @@ FileNameList FileName::dirList(string const & ext) const } -static string createTempFile(QString const & mask) -{ - QTemporaryFile qt_tmp(mask); - if (qt_tmp.open()) { - string const temp_file = fromqstr(qt_tmp.fileName()); - LYXERR(Debug::FILES, "Temporary file `" << temp_file << "' created."); - return temp_file; - } - LYXERR(Debug::FILES, "Unable to create temporary file with following template: " - << qt_tmp.fileTemplate()); - return string(); -} - - -FileName FileName::tempName(FileName const & temp_dir, string const & mask) -{ - QFileInfo tmp_fi(QDir(temp_dir.d->fi.absoluteFilePath()), toqstr(mask)); - LYXERR(Debug::FILES, "Temporary file in " << tmp_fi.absoluteFilePath()); - return FileName(createTempFile(tmp_fi.absoluteFilePath())); -} - - -FileName FileName::tempName(string const & mask) -{ - return tempName(package().temp_dir(), mask); -} - - FileName FileName::getcwd() { // return makeAbsPath("."); would create an infinite loop @@ -474,6 +470,12 @@ FileName FileName::tempPath() } +void FileName::refresh() const +{ + d->refresh(); +} + + time_t FileName::lastModified() const { // QFileInfo caches information about the file. So, in case this file has @@ -490,17 +492,39 @@ bool FileName::chdir() const } +bool FileName::link(FileName const & name) const +{ + return QFile::link(toqstr(absFileName()), toqstr(name.absFileName())); +} + + +unsigned long checksum_ifstream_fallback(char const * file) +{ + unsigned long result = 0; + //LYXERR(Debug::FILES, "lyx::sum() using istreambuf_iterator (fast)"); + ifstream ifs(file, ios_base::in | ios_base::binary); + if (!ifs) + return result; + + istreambuf_iterator beg(ifs); + istreambuf_iterator end; + boost::crc_32_type crc; + crc = for_each(beg, end, crc); + result = crc.checksum(); + return result; +} + unsigned long FileName::checksum() const { unsigned long result = 0; if (!exists()) { - //LYXERR0("File \"" << absFilename() << "\" does not exist!"); + //LYXERR0("File \"" << absFileName() << "\" does not exist!"); return result; } // a directory may be passed here so we need to test it. (bug 3622) if (isDirectory()) { - LYXERR0('"' << absFilename() << "\" is a directory!"); + LYXERR0('"' << absFileName() << "\" is a directory!"); return result; } @@ -512,7 +536,7 @@ unsigned long FileName::checksum() const #if QT_VERSION >= 0x999999 // First version of checksum uses Qt4.4 mmap support. // FIXME: This code is not ready with Qt4.4.2, - // see http://bugzilla.lyx.org/show_bug.cgi?id=5293 + // see http://www.lyx.org/trac/ticket/5293 // FIXME: should we check if the MapExtension extension is supported? // see QAbstractFileEngine::supportsExtension() and // QAbstractFileEngine::MapExtension) @@ -530,7 +554,7 @@ unsigned long FileName::checksum() const #else // QT_VERSION - string const encoded = toFilesystemEncoding(); + string const encoded = toSafeFilesystemEncoding(); char const * file = encoded.c_str(); #ifdef SUM_WITH_MMAP @@ -541,7 +565,11 @@ unsigned long FileName::checksum() const return result; struct stat info; - fstat(fd, &info); + if (fstat(fd, &info)){ + // fstat fails on samba shares (bug 5891) + close(fd); + return checksum_ifstream_fallback(file); + } void * mm = mmap(0, info.st_size, PROT_READ, MAP_PRIVATE, fd, 0); @@ -562,22 +590,11 @@ unsigned long FileName::checksum() const close(fd); #else // no SUM_WITH_MMAP - - //LYXERR(Debug::FILES, "lyx::sum() using istreambuf_iterator (fast)"); - ifstream ifs(file, ios_base::in | ios_base::binary); - if (!ifs) - return result; - - istreambuf_iterator beg(ifs); - istreambuf_iterator end; - boost::crc_32_type crc; - crc = for_each(beg, end, crc); - result = crc.checksum(); - + result = checksum_ifstream_fallback(file); #endif // SUM_WITH_MMAP #endif // QT_VERSION - LYXERR(Debug::FILES, "Checksumming \"" << absFilename() << "\" " + LYXERR(Debug::FILES, "Checksumming \"" << absFileName() << "\" " << result << " lasted " << t.elapsed() << " ms."); return result; } @@ -698,14 +715,14 @@ docstring const FileName::absoluteFilePath() const docstring FileName::displayName(int threshold) const { - return makeDisplayPath(absFilename(), threshold); + return makeDisplayPath(absFileName(), threshold); } docstring FileName::fileContents(string const & encoding) const { if (!isReadableFile()) { - LYXERR0("File '" << *this << "' is not redable!"); + LYXERR0("File '" << *this << "' is not readable!"); return docstring(); } @@ -728,7 +745,11 @@ docstring FileName::fileContents(string const & encoding) const if (encoding.empty() || encoding == "UTF-8") s = QString::fromUtf8(contents.data()); else if (encoding == "ascii") +#if (QT_VERSION < 0x050000) s = QString::fromAscii(contents.data()); +#else + s = QString::fromLatin1(contents.data()); +#endif else if (encoding == "local8bit") s = QString::fromLocal8Bit(contents.data()); else if (encoding == "latin1") @@ -741,7 +762,7 @@ docstring FileName::fileContents(string const & encoding) const void FileName::changeExtension(string const & extension) { // FIXME: use Qt native methods... - string const oldname = absFilename(); + string const oldname = absFileName(); string::size_type const last_slash = oldname.rfind('/'); string::size_type last_dot = oldname.rfind('.'); if (last_dot < last_slash && last_slash != string::npos) @@ -758,192 +779,6 @@ void FileName::changeExtension(string const & extension) } -string FileName::guessFormatFromContents() const -{ - // the different filetypes and what they contain in one of the first lines - // (dots are any characters). (Herbert 20020131) - // AGR Grace... - // BMP BM... - // EPS %!PS-Adobe-3.0 EPSF... - // FIG #FIG... - // FITS ...BITPIX... - // GIF GIF... - // JPG JFIF - // PDF %PDF-... - // PNG .PNG... - // PBM P1... or P4 (B/W) - // PGM P2... or P5 (Grayscale) - // PPM P3... or P6 (color) - // PS %!PS-Adobe-2.0 or 1.0, no "EPSF"! - // SGI \001\332... (decimal 474) - // TGIF %TGIF... - // TIFF II... or MM... - // XBM ..._bits[]... - // XPM /* XPM */ sometimes missing (f.ex. tgif-export) - // ...static char *... - // XWD \000\000\000\151 (0x00006900) decimal 105 - // - // GZIP \037\213 http://www.ietf.org/rfc/rfc1952.txt - // ZIP PK... http://www.halyava.ru/document/ind_arch.htm - // Z \037\235 UNIX compress - - // paranoia check - if (empty() || !isReadableFile()) - return string(); - - ifstream ifs(toFilesystemEncoding().c_str()); - if (!ifs) - // Couldn't open file... - return string(); - - // gnuzip - static string const gzipStamp = "\037\213"; - - // PKZIP - static string const zipStamp = "PK"; - - // compress - static string const compressStamp = "\037\235"; - - // Maximum strings to read - int const max_count = 50; - int count = 0; - - string str; - string format; - bool firstLine = true; - while ((count++ < max_count) && format.empty()) { - if (ifs.eof()) { - LYXERR(Debug::GRAPHICS, "filetools(getFormatFromContents)\n" - << "\tFile type not recognised before EOF!"); - break; - } - - getline(ifs, str); - string const stamp = str.substr(0, 2); - if (firstLine && str.size() >= 2) { - // at first we check for a zipped file, because this - // information is saved in the first bytes of the file! - // also some graphic formats which save the information - // in the first line, too. - if (prefixIs(str, gzipStamp)) { - format = "gzip"; - - } else if (stamp == zipStamp) { - format = "zip"; - - } else if (stamp == compressStamp) { - format = "compress"; - - // the graphics part - } else if (stamp == "BM") { - format = "bmp"; - - } else if (stamp == "\001\332") { - format = "sgi"; - - // PBM family - // Don't need to use str.at(0), str.at(1) because - // we already know that str.size() >= 2 - } else if (str[0] == 'P') { - switch (str[1]) { - case '1': - case '4': - format = "pbm"; - break; - case '2': - case '5': - format = "pgm"; - break; - case '3': - case '6': - format = "ppm"; - } - break; - - } else if ((stamp == "II") || (stamp == "MM")) { - format = "tiff"; - - } else if (prefixIs(str,"%TGIF")) { - format = "tgif"; - - } else if (prefixIs(str,"#FIG")) { - format = "fig"; - - } else if (prefixIs(str,"GIF")) { - format = "gif"; - - } else if (str.size() > 3) { - int const c = ((str[0] << 24) & (str[1] << 16) & - (str[2] << 8) & str[3]); - if (c == 105) { - format = "xwd"; - } - } - - firstLine = false; - } - - if (!format.empty()) - break; - else if (contains(str,"EPSF")) - // dummy, if we have wrong file description like - // %!PS-Adobe-2.0EPSF" - format = "eps"; - - else if (contains(str, "Grace")) - format = "agr"; - - else if (contains(str, "JFIF")) - format = "jpg"; - - else if (contains(str, "%PDF")) - format = "pdf"; - - else if (contains(str, "PNG")) - format = "png"; - - else if (contains(str, "%!PS-Adobe")) { - // eps or ps - ifs >> str; - if (contains(str,"EPSF")) - format = "eps"; - else - format = "ps"; - } - - else if (contains(str, "_bits[]")) - format = "xbm"; - - else if (contains(str, "XPM") || contains(str, "static char *")) - format = "xpm"; - - else if (contains(str, "BITPIX")) - format = "fits"; - } - - // Dia knows also compressed form - if ((format == "gzip") && (!compare_ascii_no_case(extension(), "dia"))) - format="dia"; - - if (!format.empty()) { - LYXERR(Debug::GRAPHICS, "Recognised Fileformat: " << format); - return format; - } - - LYXERR(Debug::GRAPHICS, "filetools(getFormatFromContents)\n" - << "\tCouldn't find a known format!"); - return string(); -} - - -bool FileName::isZippedFile() const -{ - string const type = guessFormatFromContents(); - return contains("gzip zip compress", type) && !type.empty(); -} - - docstring const FileName::relPath(string const & path) const { // FIXME UNICODE @@ -964,8 +799,8 @@ bool equivalent(FileName const & l, FileName const & r) // * Long and short file names that refer to the same file on Windows are // treated as if they referred to different files. // This is supposed to be fixed for Qt5. - FileName const lhs(os::internal_path(l.absFilename())); - FileName const rhs(os::internal_path(r.absFilename())); + FileName const lhs(os::internal_path(l.absFileName())); + FileName const rhs(os::internal_path(r.absFileName())); if (lhs.empty()) // QFileInfo::operator==() returns false if the two QFileInfo are empty. @@ -999,7 +834,10 @@ bool equivalent(FileName const & l, FileName const & r) bool operator==(FileName const & lhs, FileName const & rhs) { - return lhs.absFilename() == rhs.absFilename(); + return os::isFilesystemCaseSensitive() + ? lhs.absFileName() == rhs.absFileName() + : !QString::compare(toqstr(lhs.absFileName()), + toqstr(rhs.absFileName()), Qt::CaseInsensitive); } @@ -1011,19 +849,19 @@ bool operator!=(FileName const & lhs, FileName const & rhs) bool operator<(FileName const & lhs, FileName const & rhs) { - return lhs.absFilename() < rhs.absFilename(); + return lhs.absFileName() < rhs.absFileName(); } bool operator>(FileName const & lhs, FileName const & rhs) { - return lhs.absFilename() > rhs.absFilename(); + return lhs.absFileName() > rhs.absFileName(); } ostream & operator<<(ostream & os, FileName const & filename) { - return os << filename.absFilename(); + return os << filename.absFileName(); } @@ -1040,12 +878,12 @@ DocFileName::DocFileName() DocFileName::DocFileName(string const & abs_filename, bool save_abs) - : FileName(abs_filename), save_abs_path_(save_abs), zipped_valid_(false) + : FileName(abs_filename), save_abs_path_(save_abs) {} DocFileName::DocFileName(FileName const & abs_filename, bool save_abs) - : FileName(abs_filename), save_abs_path_(save_abs), zipped_valid_(false) + : FileName(abs_filename), save_abs_path_(save_abs) {} @@ -1055,42 +893,45 @@ void DocFileName::set(string const & name, string const & buffer_path) if (save_abs_path_) FileName::set(name); else - FileName::set(makeAbsPath(name, buffer_path).absFilename()); - zipped_valid_ = false; + FileName::set(makeAbsPath(name, buffer_path).absFileName()); } void DocFileName::erase() { FileName::erase(); - zipped_valid_ = false; } -string DocFileName::relFilename(string const & path) const +string DocFileName::relFileName(string const & path) const { // FIXME UNICODE return to_utf8(relPath(path)); } -string DocFileName::outputFilename(string const & path) const +string DocFileName::outputFileName(string const & path) const { - return save_abs_path_ ? absFilename() : relFilename(path); + return save_abs_path_ ? absFileName() : relFileName(path); } -string DocFileName::mangledFilename(string const & dir) const +string DocFileName::mangledFileName(string const & dir) const { + // Concurrent access to these variables is possible. + // We need to make sure that every DocFileName instance for a given // filename returns the same mangled name. typedef map MangledMap; static MangledMap mangledNames; - MangledMap::const_iterator const it = mangledNames.find(absFilename()); + static Mutex mangledMutex; + // this locks both access to mangledNames and counter below + Mutex::Locker lock(&mangledMutex); + MangledMap::const_iterator const it = mangledNames.find(absFileName()); if (it != mangledNames.end()) return (*it).second; - string const name = absFilename(); + string const name = absFileName(); // Now the real work string mname = os::internal_path(name); // Remove the extension. @@ -1104,7 +945,7 @@ string DocFileName::mangledFilename(string const & dir) const // in the name. static string const keep = "abcdefghijklmnopqrstuvwxyz" "ABCDEFGHIJKLMNOPQRSTUVWXYZ" - "+,-0123456789;="; + "+-0123456789;="; string::size_type pos = 0; while ((pos = mname.find_first_not_of(keep, pos)) != string::npos) mname[pos++] = '_'; @@ -1137,24 +978,14 @@ string DocFileName::mangledFilename(string const & dir) const } } - mangledNames[absFilename()] = mname; + mangledNames[absFileName()] = mname; return mname; } -bool DocFileName::isZipped() const -{ - if (!zipped_valid_) { - zipped_ = isZippedFile(); - zipped_valid_ = true; - } - return zipped_; -} - - -string DocFileName::unzippedFilename() const +string DocFileName::unzippedFileName() const { - return unzippedFileName(absFilename()); + return support::unzippedFileName(absFileName()); }