X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fsupport%2FFileName.cpp;h=929c4165bebd541bead6ce6e7a6a61774e12f89d;hb=8d640dc77608bedddb5b00982c23665584f52d21;hp=5c31ee83735df808344f1d9c9fae5c34495852ab;hpb=565e446e26f0023893f752fd71e7d38051cb6238;p=lyx.git diff --git a/src/support/FileName.cpp b/src/support/FileName.cpp index 5c31ee8373..929c4165be 100644 --- a/src/support/FileName.cpp +++ b/src/support/FileName.cpp @@ -11,39 +11,33 @@ #include #include "support/FileName.h" +#include "support/FileNameList.h" + +#include "support/debug.h" #include "support/filetools.h" +#include "support/lassert.h" #include "support/lstrings.h" +#include "support/mutex.h" #include "support/os.h" +#include "support/Package.h" #include "support/qstring_helpers.h" -#include "debug.h" -#include "lyxlib.h" - +#include +#include #include #include +#include +#include +#include -#include -#include +#include +#include +#include +#include +#include #include #include -#include -#include - - -using std::map; -using std::string; -using std::ifstream; -using std::ostringstream; -using std::endl; - -namespace fs = boost::filesystem; - -// FIXME: merge this -// -#include -#include -#include #ifdef HAVE_SYS_TYPES_H # include @@ -51,142 +45,256 @@ namespace fs = boost::filesystem; #ifdef HAVE_SYS_STAT_H # include #endif +#ifdef HAVE_UNISTD_H +# include +#endif +#ifdef HAVE_DIRECT_H +# include +#endif +#ifdef _WIN32 +# include +#endif + #include #include +// Three implementations of checksum(), depending on having mmap support or not. +#if defined(HAVE_MMAP) && defined(HAVE_MUNMAP) +#define SUM_WITH_MMAP +#include +#endif // SUM_WITH_MMAP -// BOOST_POSIX or BOOST_WINDOWS specify which API to use. -# if !defined( BOOST_WINDOWS ) && !defined( BOOST_POSIX ) -# if defined(_WIN32) || defined(__WIN32__) || defined(WIN32) || defined(__CYGWIN__) -# define BOOST_WINDOWS -# else -# define BOOST_POSIX -# endif -# endif +using namespace std; +using namespace lyx::support; -#if defined (BOOST_WINDOWS) -# define WIN32_LEAN_AND_MEAN -# include -# undef min -# undef max -#endif +// 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. +// The problem is that gcc uses a weak symbol for a particular +// instantiation and that the system linker usually does not +// understand those weak symbols (seen on HP-UX, tru64, AIX and +// others). Thus we force an explicit instanciation of this particular +// template (JMarc) +template struct boost::detail::crc_table_t<32, 0x04C11DB7, true>; +namespace lyx { +namespace support { -static bool copy_file(std::string const & source, std::string const & target, bool noclobber) -{ +///////////////////////////////////////////////////////////////////// +// +// FileName::Private +// +///////////////////////////////////////////////////////////////////// -#ifdef BOOST_POSIX - int const infile = ::open(source.c_str(), O_RDONLY); - if (infile == -1) - return false; +struct FileName::Private +{ + Private() {} - struct stat source_stat; - int const ret = ::fstat(infile, &source_stat); - if (ret == -1) { - //int err = errno; - ::close(infile); + Private(string const & abs_filename) : fi(toqstr(abs_filename)) + { + name = fromqstr(fi.absoluteFilePath()); + fi.setCaching(fi.exists() ? true : false); + } + /// + inline void refresh() + { + fi.refresh(); } - int const flags = O_WRONLY | O_CREAT | (noclobber ? O_EXCL : O_TRUNC); - int const outfile = ::open(target.c_str(), flags, source_stat.st_mode); - if (outfile == -1) { - //int err = errno; - ::close(infile); - return false; + static + bool isFilesystemEqual(QString const & lhs, QString const & rhs) + { + return QString::compare(lhs, rhs, os::isFilesystemCaseSensitive() ? + Qt::CaseSensitive : Qt::CaseInsensitive) == 0; } - std::size_t const buf_sz = 32768; - char buf[buf_sz]; - ssize_t in = -1; - ssize_t out = -1; - - while (true) { - in = ::read(infile, buf, buf_sz); - if (in == -1) { - break; - } else if (in == 0) { - break; - } else { - out = ::write(outfile, buf, in); - if (out == -1) { - break; - } - } - } + /// The absolute file name in UTF-8 encoding. + std::string name; + /// + QFileInfo fi; +}; - //int err = errno; +///////////////////////////////////////////////////////////////////// +// +// FileName +// +///////////////////////////////////////////////////////////////////// - ::close(infile); - ::close(outfile); - if (in == -1 || out == -1) - return false; -#endif +FileName::FileName() : d(new Private) +{ +} -#ifdef BOOST_WINDOWS - if (::CopyFile(source.c_str(), target.c_str(), noclobber) == 0) { - // CopyFile is probably not setting errno so this is most - // likely wrong. - return false; - } -#endif - return true; + +FileName::FileName(string const & abs_filename) + : d(abs_filename.empty() ? new Private : new Private(abs_filename)) +{ + //LYXERR(Debug::FILES, "FileName(" << abs_filename << ')'); + LATTEST(empty() || isAbsolute(d->name)); } -namespace lyx { -namespace support { +FileName::~FileName() +{ + delete d; +} -///////////////////////////////////////////////////////////////////// -// -// FileName -// -///////////////////////////////////////////////////////////////////// +FileName::FileName(FileName const & rhs) : d(new Private) +{ + d->name = rhs.d->name; + d->fi = rhs.d->fi; +} -FileName::FileName(string const & abs_filename) - : name_(abs_filename) +FileName::FileName(FileName const & rhs, string const & suffix) : d(new Private) { - BOOST_ASSERT(empty() || absolutePath(name_)); -#if defined(_WIN32) - BOOST_ASSERT(!contains(name_, '\\')); -#endif + set(rhs, suffix); +} + + +FileName & FileName::operator=(FileName const & rhs) +{ + if (&rhs == this) + return *this; + d->name = rhs.d->name; + d->fi = rhs.d->fi; + return *this; +} + + +bool FileName::empty() const +{ + return d->name.empty(); +} + + +bool FileName::isAbsolute(string const & name) +{ + QFileInfo fi(toqstr(name)); + return fi.isAbsolute(); +} + + +string FileName::absFileName() const +{ + return d->name; +} + + +string FileName::realPath() const +{ + return os::real_path(absFileName()); } void FileName::set(string const & name) { - name_ = name; - BOOST_ASSERT(absolutePath(name_)); -#if defined(_WIN32) - BOOST_ASSERT(!contains(name_, '\\')); -#endif + d->fi.setFile(toqstr(name)); + d->name = fromqstr(d->fi.absoluteFilePath()); + //LYXERR(Debug::FILES, "FileName::set(" << name << ')'); + LATTEST(empty() || isAbsolute(d->name)); +} + + +void FileName::set(FileName const & rhs, string const & 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 << ')'); + LATTEST(empty() || isAbsolute(d->name)); } void FileName::erase() { - name_.erase(); + d->name.clear(); + d->fi = QFileInfo(); } -bool FileName::copyTo(FileName const & name, bool noclobber) const +bool FileName::copyTo(FileName const & name, bool keepsymlink) const { - try { - copy_file(toFilesystemEncoding(), name.toFilesystemEncoding(), noclobber); - return true; + 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); } - catch (...) { + QFile::remove(name.d->fi.absoluteFilePath()); + bool success = QFile::copy(d->fi.absoluteFilePath(), name.d->fi.absoluteFilePath()); + if (!success) + LYXERR0("FileName::copyTo(): Could not copy file " + << *this << " to " << name); + return success; +} + + +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); + return success; +} + + +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(), + name.d->fi.absoluteFilePath()); + if (!success) + LYXERR0("Could not move file " << *this << " to " << name); + return success; +} + + +bool FileName::changePermission(unsigned long int mode) const +{ +#if defined (HAVE_CHMOD) && defined (HAVE_MODE_T) + if (::chmod(toFilesystemEncoding().c_str(), mode_t(mode)) != 0) { + LYXERR0("File " << *this << ": cannot change permission to " + << mode << "."); + return false; } - return false; +#endif + return true; } string FileName::toFilesystemEncoding() const { - QByteArray const encoded = QFile::encodeName(toqstr(name_)); + // 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()); } @@ -200,337 +308,560 @@ FileName FileName::fromFilesystemEncoding(string const & name) bool FileName::exists() const { - return QFileInfo(toqstr(name_)).exists(); + return !empty() && d->fi.exists(); +} + + +bool FileName::isSymLink() const +{ + return !empty() && d->fi.isSymLink(); +} + + +//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); + return d->fi.size() == 0; } bool FileName::isDirectory() const { - return QFileInfo(toqstr(name_)).isDir(); + return !empty() && d->fi.isDir(); } bool FileName::isReadOnly() const { - QFileInfo const fi(toqstr(name_)); - return fi.isReadable() && !fi.isWritable(); + LASSERT(!empty(), return true); + return d->fi.isReadable() && !d->fi.isWritable(); +} + + +bool FileName::isReadableDirectory() const +{ + return isDirectory() && d->fi.isReadable(); } -bool FileName::isReadable() const +string FileName::onlyFileName() const { - QFileInfo const fi(toqstr(name_)); - return fi.isReadable(); + return fromqstr(d->fi.fileName()); } -std::string FileName::onlyFileName() const +string FileName::onlyFileNameWithoutExt() const { - return support::onlyFilename(absFilename()); + return fromqstr(d->fi.completeBaseName()); } -std::string FileName::onlyPath() const +string FileName::extension() const { - return support::onlyPath(absFilename()); + return fromqstr(d->fi.suffix()); } -bool FileName::isFileReadable() const +bool FileName::hasExtension(const string & ext) { - QFileInfo const fi(toqstr(name_)); - return fi.isFile() && fi.isReadable(); + return Private::isFilesystemEqual(d->fi.suffix(), toqstr(ext)); +} + + +FileName FileName::onlyPath() const +{ + FileName path; + if (empty()) + return path; + path.d->fi.setFile(d->fi.path()); + path.d->name = fromqstr(path.d->fi.absoluteFilePath()); + return path; +} + + +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(); } bool FileName::isWritable() const { - QFileInfo const fi(toqstr(name_)); - return fi.isWritable(); + return !empty() && d->fi.isWritable(); } bool FileName::isDirWritable() const { - LYXERR(Debug::FILES) << "isDirWriteable: " << *this << std::endl; + LASSERT(isDirectory(), return false); + QFileInfo tmp(QDir(d->fi.absoluteFilePath()), "lyxwritetest"); + QTemporaryFile qt_tmp(tmp.absoluteFilePath()); + if (qt_tmp.open()) { + LYXERR(Debug::FILES, "Directory " << *this << " is writable"); + return true; + } + LYXERR(Debug::FILES, "Directory " << *this << " is not writable"); + return false; +} + + +FileNameList FileName::dirList(string const & ext) const +{ + FileNameList dirlist; + if (!isDirectory()) { + LYXERR0("Directory '" << *this << "' does not exist!"); + return dirlist; + } - FileName const tmpfl(tempName(*this, "lyxwritetest")); + // 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 (tmpfl.empty()) - return false; + if (!ext.empty()) { + QString filter; + switch (ext[0]) { + case '.': filter = "*" + toqstr(ext); break; + case '*': filter = toqstr(ext); break; + default: filter = "*." + toqstr(ext); + } + dir.setNameFilters(QStringList(filter)); + LYXERR(Debug::FILES, "filtering on extension " + << fromqstr(filter) << " is requested."); + } - unlink(tmpfl); - return true; + QFileInfoList list = dir.entryInfoList(); + for (int i = 0; i != list.size(); ++i) { + FileName fi(fromqstr(list.at(i).absoluteFilePath())); + dirlist.push_back(fi); + LYXERR(Debug::FILES, "found file " << fi); + } + + return dirlist; } -FileName FileName::tempName(FileName const & dir, std::string const & mask) +FileName FileName::getcwd() { - return support::tempName(dir, mask); + // return makeAbsPath("."); would create an infinite loop + QFileInfo fi("."); + return FileName(fromqstr(fi.absoluteFilePath())); } -std::time_t FileName::lastModified() const +FileName FileName::tempPath() { - return fs::last_write_time(toFilesystemEncoding()); + return FileName(os::internal_path(fromqstr(QDir::tempPath()))); } -bool FileName::destroyDirectory() const +void FileName::refresh() const { - try { - return fs::remove_all(toFilesystemEncoding()) > 0; - } catch (fs::filesystem_error const & fe){ - lyxerr << "Could not delete " << *this << ". (" << fe.what() << ")" - << std::endl; - return false; - } + d->refresh(); } -bool FileName::createDirectory(int permission) const +time_t FileName::lastModified() const { - BOOST_ASSERT(!empty()); - return mkdir(*this, permission) == 0; + // QFileInfo caches information about the file. So, in case this file has + // been touched between the object creation and now, we refresh the file + // information. + d->refresh(); + return d->fi.lastModified().toTime_t(); } -docstring FileName::displayName(int threshold) const +bool FileName::chdir() const { - return makeDisplayPath(absFilename(), threshold); + return QDir::setCurrent(d->fi.absoluteFilePath()); } -string FileName::fileContents() const +bool FileName::link(FileName const & name) const { - if (exists()) { - string const encodedname = toFilesystemEncoding(); - ifstream ifs(encodedname.c_str()); - ostringstream ofs; - if (ifs && ofs) { - ofs << ifs.rdbuf(); - ifs.close(); - return ofs.str(); - } - } - lyxerr << "LyX was not able to read file '" << *this << '\'' << std::endl; - return string(); -} - - -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() || !isReadable()) - return string(); - - ifstream ifs(toFilesystemEncoding().c_str()); + 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) - // 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!" - << endl; - break; - } + return result; - 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; - } + istreambuf_iterator beg(ifs); + istreambuf_iterator end; + boost::crc_32_type crc; + crc = for_each(beg, end, crc); + result = crc.checksum(); + return result; +} - if (!format.empty()) - break; - else if (contains(str,"EPSF")) - // dummy, if we have wrong file description like - // %!PS-Adobe-2.0EPSF" - format = "eps"; +unsigned long FileName::checksum() const +{ + unsigned long result = 0; + + if (!exists()) { + //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!"); + return result; + } + + // This is used in the debug output at the end of the method. + static QTime t; + if (lyxerr.debugging(Debug::FILES)) + t.restart(); + +#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://www.lyx.org/trac/ticket/5293 + // FIXME: should we check if the MapExtension extension is supported? + // see QAbstractFileEngine::supportsExtension() and + // QAbstractFileEngine::MapExtension) + QFile qf(fi.filePath()); + if (!qf.open(QIODevice::ReadOnly)) + return result; + qint64 size = fi.size(); + uchar * ubeg = qf.map(0, size); + uchar * uend = ubeg + size; + boost::crc_32_type ucrc; + ucrc.process_block(ubeg, uend); + qf.unmap(ubeg); + qf.close(); + result = ucrc.checksum(); + +#else // QT_VERSION + + string const encoded = toSafeFilesystemEncoding(); + char const * file = encoded.c_str(); + + #ifdef SUM_WITH_MMAP + //LYXERR(Debug::FILES, "using mmap (lightning fast)"); + + int fd = open(file, O_RDONLY); + if (!fd) + return result; + + struct stat 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); + // Some platforms have the wrong type for MAP_FAILED (compaq cxx). + if (mm == reinterpret_cast(MAP_FAILED)) { + close(fd); + return result; + } - else if (contains(str, "Grace")) - format = "agr"; + char * beg = static_cast(mm); + char * end = beg + info.st_size; - else if (contains(str, "JFIF")) - format = "jpg"; + boost::crc_32_type crc; + crc.process_block(beg, end); + result = crc.checksum(); - else if (contains(str, "%PDF")) - format = "pdf"; + munmap(mm, info.st_size); + close(fd); - else if (contains(str, "PNG")) - format = "png"; + #else // no SUM_WITH_MMAP + result = checksum_ifstream_fallback(file); + #endif // SUM_WITH_MMAP +#endif // QT_VERSION - else if (contains(str, "%!PS-Adobe")) { - // eps or ps - ifs >> str; - if (contains(str,"EPSF")) - format = "eps"; - else - format = "ps"; + LYXERR(Debug::FILES, "Checksumming \"" << absFileName() << "\" " + << result << " lasted " << t.elapsed() << " ms."); + return result; +} + + +bool FileName::removeFile() const +{ + bool const success = QFile::remove(d->fi.absoluteFilePath()); + d->refresh(); + if (!success && exists()) + LYXERR0("Could not delete file " << *this); + return success; +} + + +static bool rmdir(QFileInfo const & fi) +{ + QDir dir(fi.absoluteFilePath()); + QFileInfoList list = dir.entryInfoList(); + bool success = true; + for (int i = 0; i != list.size(); ++i) { + if (list.at(i).fileName() == ".") + continue; + if (list.at(i).fileName() == "..") + continue; + bool removed; + if (list.at(i).isDir()) { + LYXERR(Debug::FILES, "Removing dir " + << fromqstr(list.at(i).absoluteFilePath())); + removed = rmdir(list.at(i)); } + else { + LYXERR(Debug::FILES, "Removing file " + << fromqstr(list.at(i).absoluteFilePath())); + removed = dir.remove(list.at(i).fileName()); + } + if (!removed) { + success = false; + LYXERR0("Could not delete " + << fromqstr(list.at(i).absoluteFilePath())); + } + } + QDir parent = fi.absolutePath(); + success &= parent.rmdir(fi.fileName()); + return success; +} - else if (contains(str, "_bits[]")) - format = "xbm"; - else if (contains(str, "XPM") || contains(str, "static char *")) - format = "xpm"; +bool FileName::destroyDirectory() const +{ + bool const success = rmdir(d->fi); + if (!success) + LYXERR0("Could not delete " << *this); + + return success; +} - else if (contains(str, "BITPIX")) - format = "fits"; + +// Only used in non Win32 platforms +static int mymkdir(char const * pathname, unsigned long int mode) +{ + // FIXME: why don't we have mode_t in lyx::mkdir prototype ?? +#if HAVE_MKDIR +# if MKDIR_TAKES_ONE_ARG + // MinGW32 + return ::mkdir(pathname); + // FIXME: "Permissions of created directories are ignored on this system." +# else + // POSIX + return ::mkdir(pathname, mode_t(mode)); +# endif +#elif defined(_WIN32) + // plain Windows 32 + return CreateDirectory(pathname, 0) != 0 ? 0 : -1; + // FIXME: "Permissions of created directories are ignored on this system." +#elif HAVE__MKDIR + return ::_mkdir(pathname); + // FIXME: "Permissions of created directories are ignored on this system." +#else +# error "Don't know how to create a directory on this system." +#endif + +} + + +bool FileName::createDirectory(int permission) const +{ + LASSERT(!empty(), return false); +#ifdef Q_OS_WIN32 + // FIXME: "Permissions of created directories are ignored on this system." + return createPath(); +#else + return mymkdir(toFilesystemEncoding().c_str(), permission) == 0; +#endif +} + + +bool FileName::createPath() const +{ + LASSERT(!empty(), return false); + LYXERR(Debug::FILES, "creating path '" << *this << "'."); + if (isDirectory()) + return false; + + QDir dir; + bool success = dir.mkpath(d->fi.absoluteFilePath()); + if (!success) + LYXERR0("Cannot create path '" << *this << "'!"); + return success; +} + + +docstring const FileName::absoluteFilePath() const +{ + return qstring_to_ucs4(d->fi.absoluteFilePath()); +} + + +docstring FileName::displayName(int threshold) const +{ + return makeDisplayPath(absFileName(), threshold); +} + + +docstring FileName::fileContents(string const & encoding) const +{ + if (!isReadableFile()) { + LYXERR0("File '" << *this << "' is not readable!"); + return docstring(); + } + + QFile file(d->fi.absoluteFilePath()); + if (!file.open(QIODevice::ReadOnly)) { + LYXERR0("File '" << *this + << "' could not be opened in read only mode!"); + return docstring(); } + QByteArray contents = file.readAll(); + file.close(); - if (!format.empty()) { - LYXERR(Debug::GRAPHICS) - << "Recognised Fileformat: " << format << endl; - return format; + if (contents.isEmpty()) { + LYXERR(Debug::FILES, "File '" << *this + << "' is either empty or some error happened while reading it."); + return docstring(); } - LYXERR(Debug::GRAPHICS) - << "filetools(getFormatFromContents)\n" - << "\tCouldn't find a known format!\n"; - return string(); + QString s; + 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") + s = QString::fromLatin1(contents.data()); + + return qstring_to_ucs4(s); +} + + +void FileName::changeExtension(string const & extension) +{ + // FIXME: use Qt native methods... + 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) + last_dot = string::npos; + + string ext; + // Make sure the extension starts with a dot + if (!extension.empty() && extension[0] != '.') + ext= '.' + extension; + else + ext = extension; + + set(oldname.substr(0, last_dot) + ext); } -bool FileName::isZippedFile() const +docstring const FileName::relPath(string const & path) const { - string const type = guessFormatFromContents(); - return contains("gzip zip compress", type) && !type.empty(); + // FIXME UNICODE + return makeRelPath(absoluteFilePath(), from_utf8(path)); +} + + +// Note: According to Qt, QFileInfo::operator== is undefined when +// both files do not exist (Qt4.5 gives true for all non-existent +// files, while Qt4.4 compares the filenames). +// see: +// http://www.qtsoftware.com/developer/task-tracker/ +// index_html?id=248471&method=entry. +bool equivalent(FileName const & l, FileName const & r) +{ + // FIXME: In future use Qt. + // Qt 4.4: We need to solve this warning from Qt documentation: + // * 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())); + + if (lhs.empty()) + // QFileInfo::operator==() returns false if the two QFileInfo are empty. + return rhs.empty(); + + if (rhs.empty()) + // Avoid unnecessary checks below. + return false; + + lhs.d->refresh(); + rhs.d->refresh(); + + if (!lhs.d->fi.isSymLink() && !rhs.d->fi.isSymLink()) { + // Qt already checks if the filesystem is case sensitive or not. + // see note above why the extra check with fileName is needed. + return lhs.d->fi == rhs.d->fi + && lhs.d->fi.fileName() == rhs.d->fi.fileName(); + } + + // FIXME: When/if QFileInfo support symlink comparison, remove this code. + QFileInfo fi1(lhs.d->fi); + if (fi1.isSymLink()) + fi1 = QFileInfo(fi1.symLinkTarget()); + QFileInfo fi2(rhs.d->fi); + if (fi2.isSymLink()) + fi2 = QFileInfo(fi2.symLinkTarget()); + // see note above why the extra check with fileName is needed. + return fi1 == fi2 && fi1.fileName() == fi2.fileName(); } 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); } bool operator!=(FileName const & lhs, FileName const & rhs) { - return lhs.absFilename() != rhs.absFilename(); + return !(operator==(lhs, 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(); } -std::ostream & operator<<(std::ostream & os, FileName const & filename) +ostream & operator<<(ostream & os, FileName const & filename) { - return os << filename.absFilename(); + return os << filename.absFileName(); } @@ -547,58 +878,64 @@ 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) {} void DocFileName::set(string const & name, string const & buffer_path) { - save_abs_path_ = absolutePath(name); - name_ = save_abs_path_ ? name : makeAbsPath(name, buffer_path).absFilename(); - zipped_valid_ = false; + save_abs_path_ = isAbsolute(name); + if (save_abs_path_) + FileName::set(name); + else + FileName::set(makeAbsPath(name, buffer_path).absFileName()); } void DocFileName::erase() { - name_.erase(); - zipped_valid_ = false; + FileName::erase(); } -string const DocFileName::relFilename(string const & path) const +string DocFileName::relFileName(string const & path) const { // FIXME UNICODE - return to_utf8(makeRelPath(from_utf8(name_), from_utf8(path))); + return to_utf8(relPath(path)); } -string const DocFileName::outputFilename(string const & path) const +string DocFileName::outputFileName(string const & path) const { - // FIXME UNICODE - return save_abs_path_ ? name_ : to_utf8(makeRelPath(from_utf8(name_), from_utf8(path))); + return save_abs_path_ ? absFileName() : relFileName(path); } -string const DocFileName::mangledFilename(std::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(name_); + 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(); // Now the real work - string mname = os::internal_path(name_); + string mname = os::internal_path(name); // Remove the extension. - mname = changeExtension(name_, string()); + mname = support::changeExtension(name, string()); // The mangled name must be a valid LaTeX name. // The list of characters to keep is probably over-restrictive, // but it is not really a problem. @@ -608,17 +945,17 @@ string const DocFileName::mangledFilename(std::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++] = '_'; // Add the extension back on - mname = changeExtension(mname, getExtension(name_)); + mname = support::changeExtension(mname, getExtension(name)); // Prepend a counter to the filename. This is necessary to make // the mangled name unique. static int counter = 0; - std::ostringstream s; + ostringstream s; s << counter++ << mname; mname = s.str(); @@ -628,7 +965,7 @@ string const DocFileName::mangledFilename(std::string const & dir) const // If dir.size() > max length, all bets are off for YAP. We truncate // the filename nevertheless, keeping a minimum of 10 chars. - string::size_type max_length = std::max(100 - ((int)dir.size() + 1), 10); + string::size_type max_length = max(100 - ((int)dir.size() + 1), 10); // If the mangled file name is too long, hack it to fit. // We know we're guaranteed to have a unique file name because @@ -641,30 +978,21 @@ string const DocFileName::mangledFilename(std::string const & dir) const } } - mangledNames[name_] = mname; + mangledNames[absFileName()] = mname; return mname; } -bool DocFileName::isZipped() const +string DocFileName::unzippedFileName() const { - if (!zipped_valid_) { - zipped_ = isZippedFile(); - zipped_valid_ = true; - } - return zipped_; -} - - -string const DocFileName::unzippedFilename() const -{ - return unzippedFileName(name_); + return support::unzippedFileName(absFileName()); } bool operator==(DocFileName const & lhs, DocFileName const & rhs) { - return lhs.absFilename() == rhs.absFilename() + return static_cast(lhs) + == static_cast(rhs) && lhs.saveAbsPath() == rhs.saveAbsPath(); } @@ -676,6 +1004,3 @@ bool operator!=(DocFileName const & lhs, DocFileName const & rhs) } // namespace support } // namespace lyx - - -