]> git.lyx.org Git - lyx.git/blobdiff - src/support/FileName.cpp
Embedding: merge lyx::EmbeddedFiles to lyx::support::EmbeddedFileList
[lyx.git] / src / support / FileName.cpp
index 170b3823b95b8dd53fc4ed3b238dd935c053c48b..e847ecc5a2ace72d7073febeb51644fb4e69e23d 100644 (file)
 #include <config.h>
 
 #include "support/FileName.h"
+#include "support/FileNameList.h"
+
+#include "support/convert.h"
+#include "support/debug.h"
 #include "support/filetools.h"
 #include "support/lstrings.h"
 #include "support/os.h"
+#include "support/Package.h"
 #include "support/qstring_helpers.h"
 
-#include "debug.h"
-#include "lyxlib.h"
-
 #include <QDateTime>
 #include <QDir>
 #include <QFile>
 #include <QFileInfo>
 #include <QList>
+#include <QTime>
 
 #include <boost/assert.hpp>
+#include <boost/scoped_array.hpp>
 
 #include <map>
 #include <sstream>
 #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>
 
 
-using std::map;
-using std::string;
-using std::ifstream;
-using std::ostringstream;
-using std::endl;
+#ifdef HAVE_UNISTD_H
+# include <unistd.h>
+#endif
+
+#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 <io.h>
+# endif
+# ifdef HAVE_PROCESS_H
+#  include <process.h>
+# endif
+#endif
+
+using namespace std;
 
 namespace lyx {
 namespace support {
@@ -63,7 +90,9 @@ struct FileName::Private
        Private() {}
 
        Private(string const & abs_filename) : fi(toqstr(abs_filename))
-       {}
+       {
+               fi.setCaching(fi.exists() ? true : false);
+       }
        ///
        QFileInfo fi;
 };
@@ -76,15 +105,19 @@ struct FileName::Private
 
 
 FileName::FileName() : d(new Private)
-{}
+{
+}
+
 
 FileName::FileName(string const & abs_filename)
        : d(abs_filename.empty() ? new Private : new Private(abs_filename))
 {
-       BOOST_ASSERT(empty() || d->fi.isAbsolute());
-#if defined(_WIN32)
-       BOOST_ASSERT(!contains(abs_filename, '\\'));
-#endif
+}
+
+
+FileName::~FileName()
+{
+       delete d;
 }
 
 
@@ -103,11 +136,16 @@ FileName & FileName::operator=(FileName const & rhs)
 
 bool FileName::empty() const
 {
-       lyxerr << "FileName::empty() '" << absFilename() << "'" << endl;
        return d->fi.absoluteFilePath().isEmpty();
 }
 
 
+bool FileName::isAbsolute() const
+{
+       return d->fi.isAbsolute();
+}
+
+
 string FileName::absFilename() const
 {
        return fromqstr(d->fi.absoluteFilePath());
@@ -117,10 +155,6 @@ string FileName::absFilename() const
 void FileName::set(string const & name)
 {
        d->fi.setFile(toqstr(name));
-       BOOST_ASSERT(d->fi.isAbsolute());
-#if defined(_WIN32)
-       BOOST_ASSERT(!contains(name, '\\'));
-#endif
 }
 
 
@@ -132,7 +166,46 @@ void FileName::erase()
 
 bool FileName::copyTo(FileName const & name) const
 {
-       return QFile::copy(d->fi.absoluteFilePath(), name.d->fi.absoluteFilePath());
+       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;
+       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;
 }
 
 
@@ -186,15 +259,17 @@ bool FileName::isReadableDirectory() const
 }
 
 
-std::string FileName::onlyFileName() const
+string FileName::onlyFileName() const
 {
-       return support::onlyFilename(absFilename());
+       return fromqstr(d->fi.fileName());
 }
 
 
 FileName FileName::onlyPath() const
 {
-       return FileName(support::onlyPath(absFilename()));
+       FileName path;
+       path.d->fi.setFile(d->fi.path());
+       return path;
 }
 
 
@@ -214,51 +289,199 @@ bool FileName::isDirWritable() const
 {
        LYXERR(Debug::FILES, "isDirWriteable: " << *this);
 
-       FileName const tmpfl(tempName(*this, "lyxwritetest"));
+       FileName const tmpfl = FileName::tempName(absFilename() + "/lyxwritetest");
 
        if (tmpfl.empty())
                return false;
 
-       unlink(tmpfl);
+       tmpfl.removeFile();
        return true;
 }
 
 
-FileName FileName::tempName(FileName const & dir, std::string const & mask)
+FileNameList FileName::dirList(string const & ext) const
 {
-       return support::tempName(dir, mask);
+       FileNameList dirlist;
+       if (!isDirectory()) {
+               LYXERR0("Directory '" << *this << "' does not exist!");
+               return dirlist;
+       }
+
+       QDir dir = d->fi.absoluteDir();
+
+       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.");
+       }
+
+       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;
+}
+
+
+static int make_tempfile(char * templ)
+{
+#if defined(HAVE_MKSTEMP)
+       return ::mkstemp(templ);
+#elif defined(HAVE_MKTEMP)
+       // This probably just barely works...
+       ::mktemp(templ);
+# if defined (HAVE_OPEN)
+# if (!defined S_IRUSR)
+#   define S_IRUSR S_IREAD
+#   define S_IWUSR S_IWRITE
+# endif
+       return ::open(templ, O_RDWR | O_CREAT | O_EXCL, S_IRUSR | S_IWUSR);
+# elif defined (HAVE__OPEN)
+       return ::_open(templ,
+                      _O_RDWR | _O_CREAT | _O_EXCL,
+                      _S_IREAD | _S_IWRITE);
+# else
+#  error No open() function.
+# endif
+#else
+#error FIX FIX FIX
+#endif
 }
 
 
-std::time_t FileName::lastModified() const
+FileName FileName::tempName(string const & mask)
+{
+       FileName tmp_name(mask);
+       string tmpfl;
+       if (tmp_name.d->fi.isAbsolute())
+               tmpfl = mask;
+       else
+               tmpfl = package().temp_dir().absFilename() + "/" + mask;
+
+#if defined (HAVE_GETPID)
+       tmpfl += convert<string>(getpid());
+#elif defined (HAVE__GETPID)
+       tmpfl += convert<string>(_getpid());
+#else
+# error No getpid() function
+#endif
+       tmpfl += "XXXXXX";
+
+       // The supposedly safe mkstemp version
+       // FIXME: why not using std::string directly?
+       boost::scoped_array<char> tmpl(new char[tmpfl.length() + 1]); // + 1 for '\0'
+       tmpfl.copy(tmpl.get(), string::npos);
+       tmpl[tmpfl.length()] = '\0'; // terminator
+
+       int const tmpf = make_tempfile(tmpl.get());
+       if (tmpf != -1) {
+               string const t(to_utf8(from_filesystem8bit(tmpl.get())));
+#if defined (HAVE_CLOSE)
+               ::close(tmpf);
+#elif defined (HAVE__CLOSE)
+               ::_close(tmpf);
+#else
+# error No x() function.
+#endif
+               LYXERR(Debug::FILES, "Temporary file `" << t << "' created.");
+               return FileName(t);
+       }
+       LYXERR(Debug::FILES, "LyX Error: Unable to create temporary file.");
+       return FileName();
+}
+
+
+FileName FileName::getcwd()
+{
+       return FileName(".");
+}
+
+
+time_t FileName::lastModified() const
 {
        return d->fi.lastModified().toTime_t();
 }
 
 
+bool FileName::chdir() const
+{
+       return QDir::setCurrent(d->fi.absoluteFilePath());
+}
+
+
+extern unsigned long sum(char const * file);
+
+unsigned long FileName::checksum() const
+{
+       if (!exists()) {
+               //LYXERR0("File \"" << absFilename() << "\" does not exist!");
+               return 0;
+       }
+       // a directory may be passed here so we need to test it. (bug 3622)
+       if (isDirectory()) {
+               LYXERR0('"' << absFilename() << "\" is a directory!");
+               return 0;
+       }
+       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;
+}
+
+
+bool FileName::removeFile() const
+{
+       bool const success = QFile::remove(d->fi.absoluteFilePath());
+       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();
-       for (int i = 0; i < list.size(); ++i) {
+       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, "Erasing dir " 
-                               << fromqstr(list.at(i).absoluteFilePath()) << endl);
-                       if (!rmdir(list.at(i)))
-                               return false;
+                       LYXERR(Debug::FILES, "Removing dir " 
+                               << fromqstr(list.at(i).absoluteFilePath()));
+                       removed = rmdir(list.at(i));
                }
                else {
-                       LYXERR(Debug::FILES, "Erasing file " 
-                               << fromqstr(list.at(i).absoluteFilePath()) << endl);
-                       dir.remove(list.at(i).fileName());
+                       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();
-       return parent.rmdir(fi.fileName());
+       success &= parent.rmdir(fi.fileName());
+       return success;
 }
 
 
@@ -266,16 +489,62 @@ bool FileName::destroyDirectory() const
 {
        bool const success = rmdir(d->fi);
        if (!success)
-               lyxerr << "Could not delete " << *this << "." << endl;
+               LYXERR0("Could not delete " << *this);
 
        return success;
 }
 
 
+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;
+       return mymkdir(toFilesystemEncoding().c_str(), permission) == 0;
+}
+
+
+bool FileName::createPath() const
+{
+       BOOST_ASSERT(!empty());
+       if (isDirectory())
+               return true;
+
+       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());
 }
 
 
@@ -285,20 +554,59 @@ docstring FileName::displayName(int threshold) const
 }
 
 
-string FileName::fileContents() const
+docstring FileName::fileContents(string const & encoding) 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();
-               }
+       if (!isReadableFile()) {
+               LYXERR0("File '" << *this << "' is not redable!");
+               return docstring();
        }
-       lyxerr << "LyX was not able to read file '" << *this << '\'' << std::endl;
-       return string();
+
+       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 (contents.isEmpty()) {
+               LYXERR(Debug::FILES, "File '" << *this
+                       << "' is either empty or some error happened while reading it.");
+               return docstring();
+       }
+
+       QString s;
+       if (encoding.empty() || encoding == "UTF-8")
+               s = QString::fromUtf8(contents.data());
+       else if (encoding == "ascii")
+               s = QString::fromAscii(contents.data());
+       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);
 }
 
 
@@ -330,8 +638,8 @@ string FileName::guessFormatFromContents() const
        // 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
 
+       // paranoia check
        if (empty() || !isReadableFile())
                return string();
 
@@ -484,6 +792,13 @@ bool FileName::isZippedFile() const
 }
 
 
+docstring const FileName::relPath(string const & path) const
+{
+       // FIXME UNICODE
+       return makeRelPath(absoluteFilePath(), from_utf8(path));
+}
+
+
 bool operator==(FileName const & lhs, FileName const & rhs)
 {
        return lhs.absFilename() == rhs.absFilename();
@@ -508,7 +823,7 @@ bool operator>(FileName const & lhs, FileName const & rhs)
 }
 
 
-std::ostream & operator<<(std::ostream & os, FileName const & filename)
+ostream & operator<<(ostream & os, FileName const & filename)
 {
        return os << filename.absFilename();
 }
@@ -538,8 +853,9 @@ DocFileName::DocFileName(FileName const & abs_filename, bool save_abs)
 
 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());
+       FileName::set(name);
+       if (!isAbsolute())
+               FileName::set(makeAbsPath(name, buffer_path).absFilename());
        zipped_valid_ = false;
 }
 
@@ -551,20 +867,20 @@ void DocFileName::erase()
 }
 
 
-string const DocFileName::relFilename(string const & path) const
+string DocFileName::relFilename(string const & path) const
 {
        // FIXME UNICODE
-       return to_utf8(makeRelPath(qstring_to_ucs4(d->fi.absoluteFilePath()), from_utf8(path)));
+       return to_utf8(relPath(path));
 }
 
 
-string const DocFileName::outputFilename(string const & path) const
+string DocFileName::outputFilename(string const & path) const
 {
        return save_abs_path_ ? absFilename() : relFilename(path);
 }
 
 
-string const DocFileName::mangledFilename(std::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.
@@ -578,7 +894,7 @@ string const DocFileName::mangledFilename(std::string const & dir) const
        // Now the real work
        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.
@@ -593,12 +909,12 @@ string const DocFileName::mangledFilename(std::string const & dir) const
        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();
 
@@ -608,7 +924,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
@@ -636,7 +952,7 @@ bool DocFileName::isZipped() const
 }
 
 
-string const DocFileName::unzippedFilename() const
+string DocFileName::unzippedFilename() const
 {
        return unzippedFileName(absFilename());
 }