X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FEmbeddedFiles.cpp;h=59e93710155d87351e7ae9a1c4dc1aefad3bde63;hb=0362c6aae73c293d1c20277c12d362acfe0b2ef6;hp=325ca23362a9feb8b817b03820977e4e49418d04;hpb=b89cc942eb458284f40f4d4e7db58890c3288979;p=lyx.git diff --git a/src/EmbeddedFiles.cpp b/src/EmbeddedFiles.cpp index 325ca23362..59e9371015 100644 --- a/src/EmbeddedFiles.cpp +++ b/src/EmbeddedFiles.cpp @@ -1,6 +1,6 @@ // -*- C++ -*- /** - * \file EmbeddedFiles.cpp + * \file EmbeddedFileList.cpp * This file is part of LyX, the document processor. * Licence details can be found in the file COPYING. * @@ -30,8 +30,8 @@ #include "support/filetools.h" #include "support/gettext.h" #include "support/convert.h" -#include "support/lyxlib.h" #include "support/lstrings.h" +#include "support/ExceptionMessage.h" #include "support/FileZipListDir.h" #include @@ -45,75 +45,112 @@ namespace lyx { namespace Alert = frontend::Alert; +EmbeddedFile::EmbeddedFile(string const & file, std::string const & buffer_path) + : DocFileName("", false), inzip_name_(""), embedded_(false), inset_list_(), + temp_path_("") +{ + set(file, buffer_path); +} -EmbeddedFile::EmbeddedFile(string const & file, string const & inzip_name, - bool embed, Inset const * inset) - : DocFileName(file, true), inzip_name_(inzip_name), embedded_(embed), - inset_list_() + +void EmbeddedFile::set(std::string const & filename, std::string const & buffer_path) { - if (inset != NULL) - inset_list_.push_back(inset); + DocFileName::set(filename, buffer_path); + if (filename.empty()) + return; + + inzip_name_ = calcInzipName(buffer_path); } -string EmbeddedFile::embeddedFile(Buffer const * buf) const +void EmbeddedFile::setInzipName(std::string const & name) { - return addName(buf->temppath(), inzip_name_); + if (name.empty() || name == inzip_name_) + return; + + // an enabled EmbeededFile should have this problem handled + BOOST_ASSERT(!enabled()); + // file will be synced when it is enabled + inzip_name_ = name; } -void EmbeddedFile::addInset(Inset const * inset) +string EmbeddedFile::embeddedFile() const { - inset_list_.push_back(inset); + BOOST_ASSERT(enabled()); + return temp_path_ + inzip_name_; } -Inset const * EmbeddedFile::inset(int idx) const +FileName EmbeddedFile::availableFile() const { - BOOST_ASSERT(idx < refCount()); - // some embedded file do not have a valid par iterator - return inset_list_[idx]; + if (enabled() && embedded()) + return FileName(embeddedFile()); + else + return *this; } -void EmbeddedFile::saveBookmark(Buffer const * buf, int idx) const +string EmbeddedFile::latexFilename(std::string const & buffer_path) const { - Inset const * ptr = inset(idx); - // This might not be the most efficient method ... - for (InsetIterator it = inset_iterator_begin(buf->inset()); it; ++it) - if (&(*it) == ptr) { - // this is basically BufferView::saveBookmark(0) - LyX::ref().session().bookmarks().save( - FileName(buf->absFileName()), - it.bottom().pit(), - it.bottom().pos(), - it.paragraph().id(), - it.pos(), - 0 - ); - } - // this inset can not be located. There is something wrong that needs - // to be fixed. - BOOST_ASSERT(true); + return (enabled() && embedded()) ? inzip_name_ : relFilename(buffer_path); +} + + +void EmbeddedFile::addInset(Inset const * inset) +{ + if (inset != NULL) + inset_list_.push_back(inset); } -string EmbeddedFile::availableFile(Buffer const * buf) const +void EmbeddedFile::setEmbed(bool embed) { - return embedded() ? embeddedFile(buf) : absFilename(); + embedded_ = embed; } -bool EmbeddedFile::extract(Buffer const * buf) const +void EmbeddedFile::enable(bool flag, Buffer const * buf) { + if (enabled() == flag) + return; + + if (flag) { + temp_path_ = buf->temppath(); + if (!suffixIs(temp_path_, '/')) + temp_path_ += '/'; + if (embedded()) { + if (inzip_name_ != calcInzipName(buf->filePath())) + syncInzipFile(buf->filePath()); + updateFromExternalFile(); + } else + extract(); + } else { + extract(); + temp_path_ = ""; + } +} + + +bool EmbeddedFile::extract() const +{ + BOOST_ASSERT(enabled()); + string ext_file = absFilename(); - string emb_file = embeddedFile(buf); + string emb_file = embeddedFile(); FileName emb(emb_file); FileName ext(ext_file); - if (!emb.exists()) - return false; + if (!emb.exists()) { + if (ext.exists()) + return true; + else + throw ExceptionMessage(ErrorException, _("Failed to extract file"), + bformat(_("Cannot extract file '%1$s'.\n" + "Source file %2$s does not exist"), + from_utf8(outputFilename()), from_utf8(emb_file))); + } // if external file already exists ... if (ext.exists()) { @@ -134,30 +171,49 @@ bool EmbeddedFile::extract(Buffer const * buf) const // need to make directory? FileName path = ext.onlyPath(); - if (!path.isDirectory()) - makedir(const_cast(path.absFilename().c_str()), 0755); - if (emb.copyTo(ext)) + if (!path.createPath()) { + throw ExceptionMessage(ErrorException, _("Copy file failure"), + bformat(_("Cannot create file path '%1$s'.\n" + "Please check whether the path is writeable."), + from_utf8(path.absFilename()))); + return false; + } + + if (emb.copyTo(ext)) { + LYXERR(Debug::FILES, "Extract file " << emb_file << " to " << ext_file << endl); return true; - Alert::error(_("Copy file failure"), + } + + throw ExceptionMessage(ErrorException, _("Copy file failure"), bformat(_("Cannot copy file %1$s to %2$s.\n" "Please check whether the directory exists and is writeable."), from_utf8(emb_file), from_utf8(ext_file))); - //LYXERR(Debug::DEBUG, "Fs error: " << fe.what()); return false; } -bool EmbeddedFile::updateFromExternalFile(Buffer const * buf) const +bool EmbeddedFile::updateFromExternalFile() const { + BOOST_ASSERT(enabled()); + string ext_file = absFilename(); - string emb_file = embeddedFile(buf); + string emb_file = embeddedFile(); FileName emb(emb_file); FileName ext(ext_file); - if (!ext.exists()) - return false; - + if (!ext.exists()) { + // no need to update + if (emb.exists()) + return true; + // no external and internal file + throw ExceptionMessage(ErrorException, + _("Failed to embed file"), + bformat(_("Failed to embed file %1$s.\n" + "Please check whether this file exists and is readable."), + from_utf8(ext_file))); + } + // if embedded file already exists ... if (emb.exists()) { // no need to copy if the files are the same @@ -177,11 +233,12 @@ bool EmbeddedFile::updateFromExternalFile(Buffer const * buf) const // need to make directory? FileName path = emb.onlyPath(); if (!path.isDirectory()) - makedir(const_cast(path.absFilename().c_str()), 0755); + path.createPath(); if (ext.copyTo(emb)) return true; - Alert::error(_("Copy file failure"), - bformat(_("Cannot copy file %1$s to %2$s.\n" + throw ExceptionMessage(ErrorException, + _("Copy file failure"), + bformat(_("Cannot copy file %1$s to %2$s.\n" "Please check whether the directory exists and is writeable."), from_utf8(ext_file), from_utf8(emb_file))); //LYXERR(Debug::DEBUG, "Fs error: " << fe.what()); @@ -198,84 +255,228 @@ void EmbeddedFile::updateInsets(Buffer const * buf) const } -bool EmbeddedFiles::enabled() const +bool EmbeddedFile::isReadableFile() const { - return buffer_->params().embedded; + return availableFile().isReadableFile(); } -void EmbeddedFiles::enable(bool flag) +unsigned long EmbeddedFile::checksum() const { - if (enabled() != flag) { - // if enable, copy all files to temppath() - // if disable, extract all files - if ((flag && !updateFromExternalFile()) || (!flag && !extract())) - return; - // if operation is successful - buffer_->markDirty(); - buffer_->params().embedded = flag; - if (flag) - updateInsets(); + return availableFile().checksum(); +} + +/** +Under the lyx temp directory, content.lyx and its embedded files are usually +saved as + +$temp/$embDirName/file.lyx +$temp/$embDirName/figure1.png for ./figure1.png) +$temp/$embDirName/sub/figure2.png for ./sub/figure2.png) + +This works fine for embedded files that are in the current or deeper directory +of the document directory, but not for files such as ../figures/figure.png. +A unique name $upDirName is chosen to represent .. in such filenames so that +'up' directories can be stored 'down' the directory tree: + +$temp/$embDirName/$upDirName/figures/figure.png for ../figures/figure.png +$temp/$embDirName/$upDirName/$upDirName/figure.png for ../../figure.png + +This name has to be fixed because it is used in lyx bundled .zip file. + +Using a similar trick, we use $absDirName for absolute path so that +an absolute filename can be saved as + +$temp/$embDirName/$absDirName/a/absolute/path for /a/absolute/path + +*/ +const std::string embDirName = "LyX.Embedded.Files"; +const std::string upDirName = "LyX.Embed.Dir.Up"; +const std::string absDirName = "LyX.Embed.Dir.Abs"; +const std::string driveName = "LyX.Embed.Drive"; +const std::string spaceName = "LyX.Embed.Space"; + +std::string EmbeddedFile::calcInzipName(std::string const & buffer_path) +{ + string inzipName = to_utf8(makeRelPath(from_utf8(absFilename()), + from_utf8(buffer_path))); + + if (FileName(inzipName).isAbsolute()) + inzipName = absDirName + '/' + inzipName; + + // replace .. by upDirName + if (prefixIs(inzipName, ".")) + inzipName = subst(inzipName, "..", upDirName); + // replace special characters by their value + inzipName = subst(inzipName, ":", driveName); + inzipName = subst(inzipName, " ", spaceName); + + // to avoid name conflict between $docu_path/file and $temp_path/file + // embedded files are in a subdirectory of $temp_path. + inzipName = embDirName + '/' + inzipName; + return inzipName; +} + + +void EmbeddedFile::syncInzipFile(std::string const & buffer_path) +{ + BOOST_ASSERT(enabled()); + string old_emb_file = temp_path_ + '/' + inzip_name_; + FileName old_emb(old_emb_file); + + LYXERR(Debug::FILES, " OLD ZIP " << old_emb_file << + " NEW ZIP " << calcInzipName(buffer_path)); + + //BOOST_ASSERT(old_emb.exists()); + + string new_inzip_name = calcInzipName(buffer_path); + string new_emb_file = temp_path_ + '/' + new_inzip_name; + FileName new_emb(new_emb_file); + + // need to make directory? + FileName path = new_emb.onlyPath(); + if (!path.createPath()) { + throw ExceptionMessage(ErrorException, _("Sync file failure"), + bformat(_("Cannot create file path '%1$s'.\n" + "Please check whether the path is writeable."), + from_utf8(path.absFilename()))); + return; + } + + if (old_emb.copyTo(new_emb)) { + LYXERR(Debug::FILES, "Sync inzip file from " << inzip_name_ + << " to " << new_inzip_name); + inzip_name_ = new_inzip_name; + return; } + throw ExceptionMessage(ErrorException, _("Sync file failure"), + bformat(_("Cannot copy file %1$s to %2$s.\n" + "Please check whether the directory exists and is writeable."), + from_utf8(old_emb_file), from_utf8(new_emb_file))); +} + + +bool operator==(EmbeddedFile const & lhs, EmbeddedFile const & rhs) +{ + return lhs.absFilename() == rhs.absFilename() + && lhs.saveAbsPath() == rhs.saveAbsPath() + && lhs.embedded() == rhs.embedded(); +} + + +bool operator!=(EmbeddedFile const & lhs, EmbeddedFile const & rhs) +{ + return !(lhs == rhs); } -EmbeddedFile & EmbeddedFiles::registerFile(string const & filename, - bool embed, Inset const * inset, string const & inzipName) +void EmbeddedFileList::enable(bool flag, Buffer & buffer) { - // filename can be relative or absolute, translate to absolute filename - string abs_filename = makeAbsPath(filename, buffer_->filePath()).absFilename(); + if (buffer.embedded() == flag) + return; + + // update embedded file list + update(buffer); + + int count_embedded = 0; + int count_external = 0; + std::vector::iterator it = begin(); + std::vector::iterator it_end = end(); + // an exception may be thrown + for (; it != it_end; ++it) { + it->enable(flag, &buffer); + if (it->embedded()) + count_embedded ++; + else + count_external ++; + } + // if operation is successful (no exception is thrown) + buffer.markDirty(); + buffer.params().embedded = flag; + + // if the operation is successful, update insets + for (it = begin(); it != it_end; ++it) + it->updateInsets(&buffer); + + // show result + if (flag) { + docstring const msg = bformat(_("%1$d external files are ignored.\n" + "%2$d embeddable files are embedded.\n"), count_external, count_embedded); + Alert::information(_("Packing all files"), msg); + } else { + docstring const msg = bformat(_("%1$d external files are ignored.\n" + "%2$d embedded files are extracted.\n"), count_external, count_embedded); + Alert::information(_("Unpacking all files"), msg); + } +} + + +void EmbeddedFileList::registerFile(EmbeddedFile const & file, + Inset const * inset, Buffer const & buffer) +{ + BOOST_ASSERT(!buffer.embedded() || file.availableFile().exists()); + BOOST_ASSERT(!buffer.embedded() || file.enabled()); + // try to find this file from the list - EmbeddedFileList::iterator it = file_list_.begin(); - EmbeddedFileList::iterator it_end = file_list_.end(); + std::vector::iterator it = begin(); + std::vector::iterator it_end = end(); for (; it != it_end; ++it) - if (it->absFilename() == abs_filename || it->embeddedFile(buffer_) == abs_filename) - break; - // find this filename, keep the original embedding status - if (it != file_list_.end()) { - it->addInset(inset); - return *it; - } + if (it->absFilename() == file.absFilename()) { + if (it->embedded() != file.embedded()) { + Alert::error(_("Wrong embedding status."), + bformat(_("File %1$s is included in more than one insets, " + "but with different embedding status. Assuming embedding status."), + from_utf8(it->outputFilename()))); + it->setEmbed(true); + // update the inset with this embedding status. + const_cast(inset)->updateEmbeddedFile(buffer, *it); + } + it->addInset(inset); + return; + } // - file_list_.push_back(EmbeddedFile(abs_filename, - getInzipName(abs_filename, inzipName), embed, inset)); - return file_list_.back(); + push_back(file); + back().addInset(inset); } -void EmbeddedFiles::update() +void EmbeddedFileList::update(Buffer const & buffer) { - file_list_.clear(); + clear(); - for (InsetIterator it = inset_iterator_begin(buffer_->inset()); it; ++it) - it->registerEmbeddedFiles(*buffer_, *this); + for (InsetIterator it = inset_iterator_begin(buffer.inset()); it; ++it) + it->registerEmbeddedFiles(buffer, *this); } -bool EmbeddedFiles::writeFile(DocFileName const & filename) +bool EmbeddedFileList::writeFile(DocFileName const & filename, Buffer const & buffer) { // file in the temporary path has the content - string const content = FileName(addName(buffer_->temppath(), + string const content = FileName(addName(buffer.temppath(), "content.lyx")).toFilesystemEncoding(); vector > filenames; // add content.lyx to filenames filenames.push_back(make_pair(content, "content.lyx")); // prepare list of embedded file - EmbeddedFileList::iterator it = file_list_.begin(); - EmbeddedFileList::iterator it_end = file_list_.end(); + update(buffer); + std::vector::iterator it = begin(); + std::vector::iterator it_end = end(); for (; it != it_end; ++it) { if (it->embedded()) { - string file = it->availableFile(buffer_); - if (file.empty()) - lyxerr << "File " << it->absFilename() << " does not exist. Skip embedding it. " << endl; - else - filenames.push_back(make_pair(file, it->inzipName())); + string file = it->embeddedFile(); + if (!FileName(file).exists()) + throw ExceptionMessage(ErrorException, _("Failed to write file"), + bformat(_("Embedded file %1$s does not exist. Did you tamper lyx temporary directory?"), + it->displayName())); + filenames.push_back(make_pair(file, it->inzipName())); + LYXERR(Debug::FILES, "Writing file " << it->outputFilename() + << " as " << it->inzipName() << endl); } } // write a zip file with all these files. Write to a temp file first, to // avoid messing up the original file in case something goes terribly wrong. - DocFileName zipfile(addName(buffer_->temppath(), + DocFileName zipfile(addName(buffer.temppath(), onlyFilename(changeExtension( filename.toFilesystemEncoding(), ".zip")))); @@ -291,86 +492,4 @@ bool EmbeddedFiles::writeFile(DocFileName const & filename) return true; } - -EmbeddedFiles::EmbeddedFileList::const_iterator -EmbeddedFiles::find(std::string filename) const -{ - EmbeddedFileList::const_iterator it = file_list_.begin(); - EmbeddedFileList::const_iterator it_end = file_list_.end(); - for (; it != it_end; ++it) - if (it->absFilename() == filename || it->embeddedFile(buffer_) == filename) - return it; - return file_list_.end(); -} - - -bool EmbeddedFiles::extract() const -{ - EmbeddedFileList::const_iterator it = file_list_.begin(); - EmbeddedFileList::const_iterator it_end = file_list_.end(); - for (; it != it_end; ++it) - if (it->embedded()) - if(!it->extract(buffer_)) - return false; - return true; -} - - -bool EmbeddedFiles::updateFromExternalFile() const -{ - EmbeddedFileList::const_iterator it = file_list_.begin(); - EmbeddedFileList::const_iterator it_end = file_list_.end(); - for (; it != it_end; ++it) - if (it->embedded()) - if (!it->updateFromExternalFile(buffer_)) - return false; - return true; -} - - -string const EmbeddedFiles::getInzipName(string const & abs_filename, string const & name) -{ - // register a new one, using relative file path as inzip_name - string inzip_name = name; - if (name.empty()) - inzip_name = to_utf8(makeRelPath(from_utf8(abs_filename), - from_utf8(buffer_->filePath()))); - // if inzip_name is an absolute path, use filename only to avoid - // leaking of filesystem information in inzip_name - // The second case covers cases '../path/file' and '.' - if (absolutePath(inzip_name) || prefixIs(inzip_name, ".")) - inzip_name = onlyFilename(abs_filename); - // if this name has been used... - // use _1_name, _2_name etc - string tmp = inzip_name; - EmbeddedFileList::iterator it; - EmbeddedFileList::iterator it_end = file_list_.end(); - bool unique_name = false; - size_t i = 0; - while (!unique_name) { - unique_name = true; - if (i > 0) - inzip_name = convert(i) + "_" + tmp; - it = file_list_.begin(); - for (; it != it_end; ++it) - if (it->inzipName() == inzip_name) { - unique_name = false; - ++i; - break; - } - } - return inzip_name; -} - - -void EmbeddedFiles::updateInsets() const -{ - EmbeddedFiles::EmbeddedFileList::const_iterator it = begin(); - EmbeddedFiles::EmbeddedFileList::const_iterator it_end = end(); - for (; it != it_end; ++it) - if (it->refCount() > 0) - it->updateInsets(buffer_); -} - - }