#include "support/debug.h"
#include "support/filetools.h"
+#include "support/lassert.h"
#include "support/lstrings.h"
-#include "support/lyxlib.h"
+#include "support/qstring_helpers.h"
#include "support/os.h"
+#include "support/Package.h"
#include "support/qstring_helpers.h"
#include <QDateTime>
#include <QFile>
#include <QFileInfo>
#include <QList>
+#include <QTemporaryFile>
#include <QTime>
-#include <boost/assert.hpp>
+#include <boost/crc.hpp>
+#include <boost/scoped_array.hpp>
+#include <algorithm>
+#include <iterator>
+#include <fstream>
+#include <iomanip>
#include <map>
#include <sstream>
-#include <fstream>
-#include <algorithm>
#ifdef HAVE_SYS_TYPES_H
# include <sys/types.h>
#ifdef HAVE_SYS_STAT_H
# include <sys/stat.h>
#endif
+#ifdef HAVE_UNISTD_H
+# include <unistd.h>
+#endif
+#ifdef HAVE_DIRECT_H
+# include <direct.h>
+#endif
+#ifdef _WIN32
+# include <windows.h>
+#endif
+
#include <cerrno>
#include <fcntl.h>
+// Three implementations of checksum(), depending on having mmap support or not.
+#if defined(HAVE_MMAP) && defined(HAVE_MUNMAP)
+#define SUM_WITH_MMAP
+#include <sys/mman.h>
+#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.
+// 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 {
-
/////////////////////////////////////////////////////////////////////
//
// FileName::Private
Private() {}
Private(string const & abs_filename) : fi(toqstr(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 and < 4.5.0, that causes problems with
+// QFileInfo::refresh() on *nix. So we recreate the object in that case.
+#if defined(_WIN32) || (QT_VERSION >= 0x040500)
+ fi.refresh();
+#else
+ fi = QFileInfo(fi.absoluteFilePath());
+#endif
+ }
+
+
+ static
+ bool isFilesystemEqual(QString const & lhs, QString const & rhs)
+ {
+ return QString::compare(lhs, rhs, os::isFilesystemCaseSensitive() ?
+ Qt::CaseSensitive : Qt::CaseInsensitive) == 0;
+ }
+
+ /// The absolute file name in UTF-8 encoding.
+ std::string name;
///
QFileInfo fi;
};
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), /**/);
}
FileName::FileName(FileName const & rhs) : d(new Private)
{
+ d->name = rhs.d->name;
d->fi = rhs.d->fi;
}
+FileName::FileName(FileName const & rhs, string const & suffix) : d(new Private)
+{
+ 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->fi.absoluteFilePath().isEmpty();
+ 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::absFilename() const
+string FileName::realPath() const
{
- return fromqstr(d->fi.absoluteFilePath());
+ return os::real_path(absFileName());
}
void FileName::set(string const & name)
{
d->fi.setFile(toqstr(name));
- BOOST_ASSERT(d->fi.isAbsolute());
+ d->name = fromqstr(d->fi.absoluteFilePath());
+ //LYXERR(Debug::FILES, "FileName::set(" << name << ')');
+ LASSERT(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 << ')');
+ LASSERT(empty() || isAbsolute(d->name), /**/);
}
void FileName::erase()
{
+ d->name.clear();
d->fi = QFileInfo();
}
-bool FileName::copyTo(FileName const & name, bool overwrite) const
+bool FileName::copyTo(FileName const & name) const
{
- if (overwrite)
- QFile::remove(name.d->fi.absoluteFilePath());
+ LYXERR(Debug::FILES, "Copying " << name);
+ QFile::remove(name.d->fi.absoluteFilePath());
bool success = QFile::copy(d->fi.absoluteFilePath(), name.d->fi.absoluteFilePath());
if (!success)
- lyxerr << "FileName::copyTo(): Could not copy file "
- << *this << " to " << name << endl;
+ LYXERR0("FileName::copyTo(): Could not copy file "
+ << *this << " to " << name);
+ return success;
+}
+
+
+bool FileName::renameTo(FileName const & name) const
+{
+ 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
+{
+ 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;
+ }
+#endif
+ return true;
+}
+
+
string FileName::toFilesystemEncoding() const
{
+ // 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());
bool FileName::exists() const
{
- return d->fi.exists();
+ return !empty() && d->fi.exists();
}
bool FileName::isSymLink() const
{
- return d->fi.isSymLink();
+ return !empty() && d->fi.isSymLink();
}
bool FileName::isFileEmpty() const
{
+ LASSERT(!empty(), return true);
return d->fi.size() == 0;
}
bool FileName::isDirectory() const
{
- return d->fi.isDir();
+ return !empty() && d->fi.isDir();
}
bool FileName::isReadOnly() const
{
+ LASSERT(!empty(), return true);
return d->fi.isReadable() && !d->fi.isWritable();
}
bool FileName::isReadableDirectory() const
{
- return d->fi.isDir() && d->fi.isReadable();
+ return isDirectory() && d->fi.isReadable();
}
string FileName::onlyFileName() const
{
- return support::onlyFilename(absFilename());
+ return fromqstr(d->fi.fileName());
+}
+
+
+string FileName::onlyFileNameWithoutExt() const
+{
+ return fromqstr(d->fi.completeBaseName());
+}
+
+
+string FileName::extension() const
+{
+ return fromqstr(d->fi.suffix());
+}
+
+
+bool FileName::hasExtension(const string & ext)
+{
+ return Private::isFilesystemEqual(d->fi.suffix(), toqstr(ext));
}
FileName FileName::onlyPath() const
{
- return FileName(support::onlyPath(absFilename()));
+ FileName path;
+ if (empty())
+ return path;
+ path.d->fi.setFile(d->fi.path());
+ path.d->name = fromqstr(path.d->fi.absoluteFilePath());
+ return path;
}
bool FileName::isReadableFile() const
{
- return d->fi.isFile() && d->fi.isReadable();
+ return !empty() && d->fi.isFile() && d->fi.isReadable();
}
bool FileName::isWritable() const
{
- return d->fi.isWritable();
+ return !empty() && d->fi.isWritable();
}
bool FileName::isDirWritable() const
{
- LYXERR(Debug::FILES, "isDirWriteable: " << *this);
-
- FileName const tmpfl(tempName(*this, "lyxwritetest"));
-
- if (tmpfl.empty())
- return false;
-
- tmpfl.removeFile();
- return true;
+ 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;
}
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;
}
-FileName FileName::tempName(FileName const & dir, string const & mask)
+static string createTempFile(QString const & mask)
{
- return support::tempName(dir, 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
+ QFileInfo fi(".");
+ return FileName(fromqstr(fi.absoluteFilePath()));
+}
+
+
+FileName FileName::tempPath()
+{
+ return FileName(os::internal_path(fromqstr(QDir::tempPath())));
+}
+
+
+void FileName::refresh() const
+{
+ d->refresh();
}
time_t FileName::lastModified() const
{
+ // 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();
}
}
-extern unsigned long sum(char const * file);
+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<char> beg(ifs);
+ istreambuf_iterator<char> 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!");
- return 0;
+ //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 0;
+ 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<void*>(MAP_FAILED)) {
+ close(fd);
+ return result;
}
- if (!lyxerr.debugging(Debug::FILES))
- return sum(absFilename().c_str());
- QTime t;
- t.start();
- unsigned long r = sum(absFilename().c_str());
- lyxerr << "Checksumming \"" << absFilename() << "\" lasted "
- << t.elapsed() << " ms." << endl;
- return r;
+ char * beg = static_cast<char*>(mm);
+ char * end = beg + info.st_size;
+
+ boost::crc_32_type crc;
+ crc.process_block(beg, end);
+ result = crc.checksum();
+
+ munmap(mm, info.st_size);
+ close(fd);
+
+ #else // no SUM_WITH_MMAP
+ result = checksum_ifstream_fallback(file);
+ #endif // SUM_WITH_MMAP
+#endif // QT_VERSION
+
+ 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;
}
+// 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
{
- BOOST_ASSERT(!empty());
- return mkdir(*this, permission) == 0;
+ 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 FileName::displayName(int threshold) const
{
- return makeDisplayPath(absFilename(), threshold);
+ return makeDisplayPath(absFileName(), threshold);
}
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)
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;
}
+// 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();
}
ostream & operator<<(ostream & os, FileName const & filename)
{
- return os << filename.absFilename();
+ return os << filename.absFileName();
}
void DocFileName::set(string const & name, string const & buffer_path)
{
- save_abs_path_ = absolutePath(name);
- FileName::set(save_abs_path_ ? name : makeAbsPath(name, buffer_path).absFilename());
+ save_abs_path_ = isAbsolute(name);
+ if (save_abs_path_)
+ FileName::set(name);
+ else
+ FileName::set(makeAbsPath(name, buffer_path).absFileName());
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
{
// We need to make sure that every DocFileName instance for a given
// filename returns the same mangled name.
typedef map<string, string> MangledMap;
static MangledMap mangledNames;
- MangledMap::const_iterator const it = mangledNames.find(absFilename());
+ 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.
// 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++] = '_';
}
}
- mangledNames[absFilename()] = mname;
+ mangledNames[absFileName()] = mname;
return mname;
}
}
-string DocFileName::unzippedFilename() const
+string DocFileName::unzippedFileName() const
{
- return unzippedFileName(absFilename());
+ return support::unzippedFileName(absFileName());
}
bool operator==(DocFileName const & lhs, DocFileName const & rhs)
{
- return lhs.absFilename() == rhs.absFilename()
+ return static_cast<FileName const &>(lhs)
+ == static_cast<FileName const &>(rhs)
&& lhs.saveAbsPath() == rhs.saveAbsPath();
}