]> git.lyx.org Git - lyx.git/blobdiff - src/support/FileName.cpp
Provide proper fallback if a bibliography processor is not found
[lyx.git] / src / support / FileName.cpp
index e68d1f71906669d7af064e27a97eac1a2521eecb..482bb93e2135dcdeda0d72721ef30d723d5ed9ef 100644 (file)
@@ -17,7 +17,7 @@
 #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"
 #include <QFileInfo>
 #include <QList>
 #include <QTemporaryFile>
-#include <QTime>
+#include <QElapsedTimer>
+
+#ifdef _WIN32
+#include <QThread>
+#endif
 
 #include <boost/crc.hpp>
-#include <boost/scoped_array.hpp>
 
 #include <algorithm>
 #include <iterator>
 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 {
 
@@ -90,24 +84,17 @@ struct FileName::Private
 {
        Private() {}
 
-       Private(string const & abs_filename) : fi(toqstr(abs_filename))
+       Private(string const & abs_filename) : fi(toqstr(handleTildeName(abs_filename)))
        {
                name = fromqstr(fi.absoluteFilePath());
                fi.setCaching(fi.exists() ? true : false);
        }
        ///
-       inline void refresh() 
+       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)
        {
@@ -115,6 +102,14 @@ struct FileName::Private
                        Qt::CaseSensitive : Qt::CaseInsensitive) == 0;
        }
 
+       static
+       string const handleTildeName(string const & name)
+       {
+               return name == "~" ? Package::get_home_dir().absFileName() :
+                       prefixIs(name, "~/") ? Package::get_home_dir().absFileName() + name.substr(1) :
+                       name;
+       }
+
        /// The absolute file name in UTF-8 encoding.
        std::string name;
        ///
@@ -137,7 +132,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));
 }
 
 
@@ -178,7 +173,7 @@ bool FileName::empty() const
 
 bool FileName::isAbsolute(string const & name)
 {
-       QFileInfo fi(toqstr(name));
+       QFileInfo fi(toqstr(Private::handleTildeName(name)));
        return fi.isAbsolute();
 }
 
@@ -197,10 +192,10 @@ string FileName::realPath() const
 
 void FileName::set(string const & name)
 {
-       d->fi.setFile(toqstr(name));
+       d->fi.setFile(toqstr(Private::handleTildeName(name)));
        d->name = fromqstr(d->fi.absoluteFilePath());
        //LYXERR(Debug::FILES, "FileName::set(" << name << ')');
-       LASSERT(empty() || isAbsolute(d->name), /**/);
+       LATTEST(empty() || isAbsolute(d->name));
 }
 
 
@@ -212,7 +207,7 @@ void FileName::set(FileName const & rhs, string const & suffix)
                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));
 }
 
 
@@ -223,9 +218,26 @@ void FileName::erase()
 }
 
 
-bool FileName::copyTo(FileName const & name) const
+bool FileName::copyTo(FileName const & name, bool keepsymlink) const
+{
+       FileNameSet visited;
+       return copyTo(name, keepsymlink, visited);
+}
+
+
+bool FileName::copyTo(FileName const & name, bool keepsymlink,
+                      FileName::FileNameSet & visited) const
 {
-       LYXERR(Debug::FILES, "Copying " << name);
+       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)
@@ -237,7 +249,9 @@ 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());
+       d->refresh();
        if (!success)
                LYXERR0("Could not rename file " << *this << " to " << name);
        return success;
@@ -246,10 +260,26 @@ bool FileName::renameTo(FileName const & name) const
 
 bool FileName::moveTo(FileName const & name) const
 {
+       LYXERR(Debug::FILES, "Moving " << *this << " to " << name);
+#ifdef _WIN32
+       // there's a locking problem on Windows sometimes, so
+       // we will keep trying for five seconds, in the hope
+       // that clears.
+       name.refresh();
+       if (name.exists()) {
+               bool removed = name.removeFile();
+               int tries = 1;
+               while (!removed && tries < 6)   {
+                       QThread::sleep(1);
+                       removed = name.removeFile();
+                       tries++;
+               }
+       }
+#else
        QFile::remove(name.d->fi.absoluteFilePath());
+#endif
 
-       bool success = QFile::rename(d->fi.absoluteFilePath(),
-               name.d->fi.absoluteFilePath());
+       bool const success = renameTo(name);
        if (!success)
                LYXERR0("Could not move file " << *this << " to " << name);
        return success;
@@ -268,6 +298,13 @@ bool FileName::changePermission(unsigned long int mode) const
        return true;
 }
 
+bool FileName::clonePermissions(FileName const & source)
+{
+       QFile fin(toqstr(source.absFileName()));
+       QFile f(toqstr(absFileName()));
+
+       return f.setPermissions(fin.permissions());
+}
 
 string FileName::toFilesystemEncoding() const
 {
@@ -306,6 +343,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);
@@ -367,6 +407,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();
@@ -428,34 +481,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
@@ -482,7 +507,11 @@ time_t FileName::lastModified() const
        // been touched between the object creation and now, we refresh the file
        // information.
        d->refresh();
+#if (QT_VERSION >= QT_VERSION_CHECK(5, 8, 0))
+       return d->fi.lastModified().toSecsSinceEpoch();
+#else
        return d->fi.lastModified().toTime_t();
+#endif
 }
 
 
@@ -492,6 +521,28 @@ 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<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;
@@ -507,7 +558,7 @@ unsigned long FileName::checksum() const
        }
 
        // This is used in the debug output at the end of the method.
-       static QTime t;
+       static QElapsedTimer t;
        if (lyxerr.debugging(Debug::FILES))
                t.restart();
 
@@ -516,7 +567,7 @@ unsigned long FileName::checksum() const
        // 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 
+       // see QAbstractFileEngine::supportsExtension() and
        // QAbstractFileEngine::MapExtension)
        QFile qf(fi.filePath());
        if (!qf.open(QIODevice::ReadOnly))
@@ -543,7 +594,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);
@@ -564,23 +619,12 @@ 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<char> beg(ifs);
-       istreambuf_iterator<char> 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() << "\" "
-               << result << " lasted " << t.elapsed() << " ms.");
+               << result << " lasted " << QString::number(t.elapsed()) << " ms.");
        return result;
 }
 
@@ -607,12 +651,12 @@ static bool rmdir(QFileInfo const & fi)
                        continue;
                bool removed;
                if (list.at(i).isDir()) {
-                       LYXERR(Debug::FILES, "Removing dir " 
+                       LYXERR(Debug::FILES, "Removing dir "
                                << fromqstr(list.at(i).absoluteFilePath()));
                        removed = rmdir(list.at(i));
                }
                else {
-                       LYXERR(Debug::FILES, "Removing file " 
+                       LYXERR(Debug::FILES, "Removing file "
                                << fromqstr(list.at(i).absoluteFilePath()));
                        removed = dir.remove(list.at(i).fileName());
                }
@@ -621,7 +665,7 @@ static bool rmdir(QFileInfo const & fi)
                        LYXERR0("Could not delete "
                                << fromqstr(list.at(i).absoluteFilePath()));
                }
-       } 
+       }
        QDir parent = fi.absolutePath();
        success &= parent.rmdir(fi.fileName());
        return success;
@@ -707,7 +751,7 @@ docstring FileName::displayName(int threshold) const
 docstring FileName::fileContents(string const & encoding) const
 {
        if (!isReadableFile()) {
-               LYXERR0("File '" << *this << "' is not redable!");
+               LYXERR0("File '" << *this << "' is not readable!");
                return docstring();
        }
 
@@ -730,7 +774,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")
@@ -760,192 +808,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
@@ -1045,12 +907,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)
 {}
 
 
@@ -1061,14 +923,12 @@ void DocFileName::set(string const & name, string const & buffer_path)
                FileName::set(name);
        else
                FileName::set(makeAbsPath(name, buffer_path).absFileName());
-       zipped_valid_ = false;
 }
 
 
 void DocFileName::erase()
 {
        FileName::erase();
-       zipped_valid_ = false;
 }
 
 
@@ -1087,10 +947,15 @@ string DocFileName::outputFileName(string const & path) 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<string, string> MangledMap;
        static MangledMap mangledNames;
+       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;
@@ -1109,7 +974,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++] = '_';
@@ -1147,16 +1012,6 @@ string DocFileName::mangledFileName(string const & dir) const
 }
 
 
-bool DocFileName::isZipped() const
-{
-       if (!zipped_valid_) {
-               zipped_ = isZippedFile();
-               zipped_valid_ = true;
-       }
-       return zipped_;
-}
-
-
 string DocFileName::unzippedFileName() const
 {
        return support::unzippedFileName(absFileName());