X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FEmbeddedFiles.cpp;h=4109dcd74662eba9fb255722449602ede3d5ae5b;hb=6c977615633e5e132494b9a7fa778588210f9c95;hp=155ed86ac787c1b57f58d669b59c9bc71f0bf482;hpb=3189e7b5dd438876016091463b8e66b134295fb5;p=lyx.git diff --git a/src/EmbeddedFiles.cpp b/src/EmbeddedFiles.cpp index 155ed86ac7..4109dcd746 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. * @@ -13,151 +13,162 @@ #include #include "EmbeddedFiles.h" + #include "Buffer.h" #include "BufferParams.h" -#include "Paragraph.h" -#include "InsetIterator.h" -#include "debug.h" -#include "gettext.h" +#include "ErrorList.h" #include "Format.h" +#include "InsetIterator.h" #include "Lexer.h" -#include "ErrorList.h" +#include "LyX.h" +#include "Paragraph.h" +#include "Session.h" #include "frontends/alert.h" -#include - +#include "support/debug.h" #include "support/filetools.h" -#include "support/fs_extras.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 "LyX.h" -#include "Session.h" +#include #include #include #include -using std::ofstream; -using std::endl; -using std::vector; -using std::string; -using std::pair; -using std::make_pair; -using std::istream; -using std::ostream; -using std::getline; -using std::istringstream; +using namespace std; +using namespace lyx::support; namespace lyx { -namespace fs = boost::filesystem; namespace Alert = frontend::Alert; -using support::FileName; -using support::DocFileName; -using support::makeAbsPath; -using support::addName; -using support::onlyPath; -using support::absolutePath; -using support::onlyFilename; -using support::makeRelPath; -using support::changeExtension; -using support::bformat; -using support::prefixIs; -using support::sum; -using support::makedir; - - -EmbeddedFile::EmbeddedFile(string const & file, string const & inzip_name, - bool embed, Inset const * inset) - : DocFileName(file, true), inzip_name_(inzip_name), embedded_(embed), - valid_(true), inset_list_() +EmbeddedFile::EmbeddedFile(string const & file, std::string const & buffer_path) + : DocFileName("", false), embedded_(false), inset_list_() { - if (inset != NULL) - inset_list_.push_back(inset); + set(file, buffer_path); } -string EmbeddedFile::embeddedFile(Buffer const * buf) const +void EmbeddedFile::set(std::string const & filename, std::string const & buffer_path) { - return addName(buf->temppath(), inzip_name_); + DocFileName::set(filename, buffer_path); + if (filename.empty()) + return; + + if (!buffer_path.empty()) + inzip_name_ = calcInzipName(buffer_path); } -void EmbeddedFile::addInset(Inset const * inset) +void EmbeddedFile::setInzipName(std::string const & name) { - inset_list_.push_back(inset); + 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; } -Inset const * EmbeddedFile::inset(int idx) const +string EmbeddedFile::embeddedFile() const { - BOOST_ASSERT(idx < refCount()); - // some embedded file do not have a valid par iterator - return inset_list_[idx]; + BOOST_ASSERT(enabled()); + return temp_path_ + inzip_name_; } -void EmbeddedFile::saveBookmark(Buffer const * buf, int idx) const +FileName EmbeddedFile::availableFile() 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->fileName()), - 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); + if (enabled() && embedded()) + return FileName(embeddedFile()); + else + return *this; } -string EmbeddedFile::availableFile(Buffer const * buf) const +string EmbeddedFile::latexFilename(std::string const & buffer_path) const { - if (embedded()) - return embeddedFile(buf); - else - return absFilename(); + return (enabled() && embedded()) ? inzip_name_ : relFilename(buffer_path); } -void EmbeddedFile::invalidate() +void EmbeddedFile::addInset(Inset const * inset) { - // Clear inset_list_ because they will be registered again. - inset_list_.clear(); - valid_ = false; + if (inset != NULL) + inset_list_.push_back(inset); } -bool EmbeddedFile::extract(Buffer const * buf) const +void EmbeddedFile::setEmbed(bool embed) { + embedded_ = embed; +} + + +void EmbeddedFile::enable(bool flag, Buffer const * buf, bool updateFile) +{ + // This function will be called when + // 1. through EmbeddedFiles::enable() when a file is read. Files + // should be in place so no updateFromExternalFile or extract() + // should be called. (updateFile should be false in this case). + // 2. through menu item enable/disable. updateFile should be true. + // 3. A single embedded file is added or modified. updateFile + // can be true or false. + LYXERR(Debug::FILES, (flag ? "Enable" : "Disable") + << " " << absFilename() + << (updateFile ? " (update file)." : " (no update).")); + + if (flag) { + temp_path_ = buf->temppath(); + if (!suffixIs(temp_path_, '/')) + temp_path_ += '/'; + if (embedded() && updateFile) + updateFromExternalFile(); + } else { + // when a new embeddeed file is created, it is not enabled, and + // there is no need to extract. + if (enabled() && embedded() && updateFile) + extract(); + temp_path_ = ""; + } +} + + +bool EmbeddedFile::extract() const +{ + BOOST_ASSERT(enabled()); string ext_file = absFilename(); - string emb_file = embeddedFile(buf); + string emb_file = embeddedFile(); - if (!fs::exists(emb_file)) - return false; + FileName emb(emb_file); + FileName ext(ext_file); + + if (!emb.exists()) { + if (ext.exists()) + return true; + 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 (fs::exists(ext_file)) { + if (ext.exists()) { // no need to copy if the files are the same - if (sum(*this) == sum(FileName(emb_file))) + if (checksum() == FileName(emb_file).checksum()) return true; // otherwise, ask if overwrite int ret = Alert::prompt( _("Overwrite external file?"), - bformat(_("External file %1$s already exists, do you want to overwrite it"), + bformat(_("External file %1$s already exists, do you want to overwrite it?"), from_utf8(ext_file)), 1, 1, _("&Overwrite"), _("&Cancel")); if (ret != 0) // if the user does not want to overwrite, we still consider it @@ -165,41 +176,61 @@ bool EmbeddedFile::extract(Buffer const * buf) const return true; } // copy file - try { - // need to make directory? - string path = onlyPath(ext_file); - if (!fs::is_directory(path)) - makedir(const_cast(path.c_str()), 0755); - fs::copy_file(emb_file, ext_file, false); + + // need to make directory? + FileName path = ext.onlyPath(); + 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; - } catch (fs::filesystem_error const & fe) { - Alert::error(_("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() << endl; } + + 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))); 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()) { + // 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 (!fs::exists(ext_file)) - return false; - // if embedded file already exists ... - if (fs::exists(emb_file)) { + if (emb.exists()) { // no need to copy if the files are the same - if (sum(*this) == sum(FileName(emb_file))) + if (checksum() == FileName(emb_file).checksum()) return true; // other wise, ask if overwrite int const ret = Alert::prompt( _("Update embedded file?"), - bformat(_("Embeddedl file %1$s already exists, do you want to overwrite it"), + bformat(_("Embedded file %1$s already exists, do you want to overwrite it"), from_utf8(ext_file)), 1, 1, _("&Overwrite"), _("&Cancel")); if (ret != 0) // if the user does not want to overwrite, we still consider it @@ -207,265 +238,386 @@ bool EmbeddedFile::updateFromExternalFile(Buffer const * buf) const return true; } // copy file - try { - // need to make directory? - string path = onlyPath(emb_file); - if (!fs::is_directory(path)) - makedir(const_cast(path.c_str()), 0755); - fs::copy_file(ext_file, emb_file, false); + // need to make directory? + FileName path = emb.onlyPath(); + if (!path.isDirectory()) + path.createPath(); + if (ext.copyTo(emb)) return true; - } catch (fs::filesystem_error const & fe) { - Alert::error(_("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() << endl; - } + 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()); return false; } -bool EmbeddedFiles::enabled() const +EmbeddedFile EmbeddedFile::copyTo(Buffer const * buf) { - return buffer_->params().embedded; + EmbeddedFile file = EmbeddedFile(absFilename(), buf->filePath()); + file.setEmbed(embedded()); + file.enable(buf->embedded(), buf, false); + + // use external file. + if (!embedded()) + return file; + + LYXERR(Debug::FILES, "Copy " << availableFile() + << " to " << file.availableFile()); + + FileName from_file = availableFile(); + FileName to_file = file.availableFile(); + + if (!from_file.exists()) { + // no from file + throw ExceptionMessage(ErrorException, + _("Failed to copy embedded file"), + bformat(_("Failed to embed file %1$s.\n" + "Please check whether the source file is available"), + from_utf8(absFilename()))); + file.setEmbed(false); + return file; + } + + // if destination file already exists ... + if (to_file.exists()) { + // no need to copy if the files are the same + if (checksum() == to_file.checksum()) + return file; + // other wise, ask if overwrite + int const ret = Alert::prompt( + _("Update embedded file?"), + bformat(_("Embedded file %1$s already exists, do you want to overwrite it"), + from_utf8(to_file.absFilename())), 1, 1, _("&Overwrite"), _("&Cancel")); + if (ret != 0) + // if the user does not want to overwrite, we still consider it + // a successful operation. + return file; + } + // copy file + // need to make directory? + FileName path = to_file.onlyPath(); + if (!path.isDirectory()) + path.createPath(); + if (from_file.copyTo(to_file)) + return file; + 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(from_file.absFilename()), from_utf8(to_file.absFilename()))); + return file; } -bool EmbeddedFiles::enable(bool flag) +void EmbeddedFile::updateInsets() const { - if (enabled() != flag) { - // if enable, copy all files to temppath() - // if disable, extract all files - if ((flag && !updateFromExternalFile()) || (!flag && !extract())) - return false; - // if operation is successful - buffer_->markDirty(); - buffer_->params().embedded = flag; - } + vector::const_iterator it = inset_list_.begin(); + vector::const_iterator it_end = inset_list_.end(); + for (; it != it_end; ++it) + const_cast(*it)->updateEmbeddedFile(*this); } -void EmbeddedFiles::registerFile(string const & filename, - bool embed, Inset const * inset, string const & inzipName) +bool EmbeddedFile::isReadableFile() const { - // filename can be relative or absolute, translate to absolute filename - string abs_filename = makeAbsPath(filename, buffer_->filePath()).absFilename(); - // try to find this file from the list - EmbeddedFileList::iterator it = file_list_.begin(); - EmbeddedFileList::iterator it_end = file_list_.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); - it->validate(); - return; - } - // try to be more careful - file_list_.push_back(EmbeddedFile(abs_filename, - getInzipName(abs_filename, inzipName), embed, inset)); + return availableFile().isReadableFile(); } -void EmbeddedFiles::update() +unsigned long EmbeddedFile::checksum() const { - // invalidate all files, obsolete files will then not be validated by the - // following document scan. These files will still be kept though, because - // they may be added later and their embedding status will be meaningful - // again (thinking of cut/paste of an InsetInclude). - EmbeddedFileList::iterator it = file_list_.begin(); - EmbeddedFileList::iterator it_end = file_list_.end(); - for (; it != it_end; ++it) - // we do not update items that are manually inserted - if (it->refCount() > 0) - it->invalidate(); + return availableFile().checksum(); +} - for (InsetIterator it = inset_iterator_begin(buffer_->inset()); it; ++it) - it->registerEmbeddedFiles(*buffer_, *this); +/** +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 + +FIXME: +embDirName is set to . so that embedded layout and class files can be +used directly. However, putting all embedded files directly under +the temp directory may lead to file conflicts. For example, if a user +embeds a file blah.log in blah.lyx, it will be replaced when +'latex blah.tex' is called. +*/ +const std::string embDirName = "."; +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; } -bool EmbeddedFiles::write(DocFileName const & filename) +void EmbeddedFile::syncInzipFile(std::string const & buffer_path) { - // file in the temporary path has the content - string const content = FileName(addName(buffer_->temppath(), - "content.lyx")).toFilesystemEncoding(); + BOOST_ASSERT(enabled()); + string old_emb_file = temp_path_ + '/' + inzip_name_; + FileName old_emb(old_emb_file); - 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(); - for (; it != it_end; ++it) { - if (it->valid() && 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())); - } + if (!old_emb.exists()) + throw ExceptionMessage(ErrorException, _("Failed to open file"), + bformat(_("Embedded file %1$s does not exist. Did you tamper lyx temporary directory?"), + old_emb.displayName())); + + string new_inzip_name = calcInzipName(buffer_path); + if (new_inzip_name == inzip_name_) + return; + + LYXERR(Debug::FILES, " OLD ZIP " << old_emb_file << + " NEW ZIP " << 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; } - // 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(), - onlyFilename(changeExtension( - filename.toFilesystemEncoding(), ".zip")))); - ::zipFiles(zipfile.toFilesystemEncoding(), filenames); - // copy file back - try { - fs::copy_file(zipfile.toFilesystemEncoding(), filename.toFilesystemEncoding(), false); - } catch (fs::filesystem_error const & fe) { - Alert::error(_("Save failure"), - bformat(_("Cannot create file %1$s.\n" - "Please check whether the directory exists and is writeable."), - from_utf8(filename.absFilename()))); - LYXERR(Debug::DEBUG) << "Fs error: " << fe.what() << endl; + 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; } - return true; + 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))); } -EmbeddedFiles::EmbeddedFileList::const_iterator EmbeddedFiles::find(std::string filename) const +bool operator==(EmbeddedFile const & lhs, EmbeddedFile const & rhs) { - 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(); + return lhs.absFilename() == rhs.absFilename() + && lhs.saveAbsPath() == rhs.saveAbsPath() + && lhs.embedded() == rhs.embedded(); } -bool EmbeddedFiles::extract() const +bool operator!=(EmbeddedFile const & lhs, EmbeddedFile const & rhs) { - EmbeddedFileList::const_iterator it = file_list_.begin(); - EmbeddedFileList::const_iterator it_end = file_list_.end(); - for (; it != it_end; ++it) - if (it->valid() && it->embedded()) - if(!it->extract(buffer_)) - return false; - return true; + return !(lhs == rhs); } -bool EmbeddedFiles::updateFromExternalFile() const +void EmbeddedFileList::enable(bool flag, Buffer & buffer, bool updateFile) { - EmbeddedFileList::const_iterator it = file_list_.begin(); - EmbeddedFileList::const_iterator it_end = file_list_.end(); - for (; it != it_end; ++it) - if (it->valid() && it->embedded()) - if (!it->updateFromExternalFile(buffer_)) - return false; - return true; -} + // update embedded file list + update(buffer); + + int count_embedded = 0; + int count_external = 0; + iterator it = begin(); + iterator it_end = end(); + // an exception may be thrown + for (; it != it_end; ++it) { + it->enable(flag, &buffer, updateFile); + if (it->embedded()) + ++count_embedded; + else + ++count_external; + } + // if operation is successful (no exception is thrown) + buffer.params().embedded = flag; + // if the operation is successful, update insets + for (it = begin(); it != it_end; ++it) + it->updateInsets(); -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; - } + if (!updateFile || (count_external == 0 && count_embedded == 0)) + return; + + // 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); } - return inzip_name; } -bool EmbeddedFiles::readManifest(Lexer & lex, ErrorList & errorList) +void EmbeddedFileList::registerFile(EmbeddedFile const & file, + Inset const * inset, Buffer const & buffer) { - int line = -1; - int begin_manifest_line = -1; - - file_list_.clear(); - string filename = ""; - string inzipName = ""; - bool status = ""; + BOOST_ASSERT(!buffer.embedded() || file.enabled()); - while (lex.isOK()) { - lex.next(); - string const token = lex.getString(); + // try to find this file from the list + std::vector::iterator it = begin(); + std::vector::iterator it_end = end(); + for (; it != it_end; ++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(*it); + } + it->addInset(inset); + return; + } + // + file.clearInsets(); + push_back(file); + back().addInset(inset); +} - if (token.empty()) - continue; - if (token == "\\end_manifest") - break; +void EmbeddedFileList::validate(Buffer const & buffer) +{ + clear(); + + for (InsetIterator it = inset_iterator_begin(buffer.inset()); it; ++it) + it->registerEmbeddedFiles(*this); - ++line; - if (token == "\\begin_manifest") { - begin_manifest_line = line; - continue; - } - - LYXERR(Debug::PARSER) << "Handling document manifest token: `" - << token << '\'' << endl; - - if (token == "\\filename") - lex >> filename; - else if (token == "\\inzipName") - lex >> inzipName; - else if (token == "\\status") { - lex >> status; - registerFile(filename, status, NULL, inzipName); - filename = ""; - inzipName = ""; - } else { - docstring const s = _("\\begin_file is missing"); - errorList.push_back(ErrorItem(_("Manifest error"), - s, -1, 0, 0)); - } + iterator it = begin(); + iterator it_end = end(); + for (; it != it_end; ++it) { + if (buffer.embedded() && it->embedded()) + // An exception will be raised if inzip file does not exist + it->syncInzipFile(buffer.filePath()); + else + // inzipName may be OS dependent + it->setInzipName(it->calcInzipName(buffer.filePath())); } - if (begin_manifest_line) { - docstring const s = _("\\begin_manifest is missing"); - errorList.push_back(ErrorItem(_("Manifest error"), - s, -1, 0, 0)); + for (it = begin(); it != it_end; ++it) + it->updateInsets(); + + if (!buffer.embedded()) + return; + + // check if extra embedded files exist + vector extra = buffer.params().extraEmbeddedFiles(); + vector::iterator e_it = extra.begin(); + vector::iterator e_end = extra.end(); + for (; e_it != e_end; ++e_it) { + EmbeddedFile file = EmbeddedFile(*e_it, buffer.filePath()); + // do not update from external file + file.enable(true, &buffer, false); + // but we do need to check file existence. + if (!FileName(file.embeddedFile()).exists()) + throw ExceptionMessage(ErrorException, _("Failed to open file"), + bformat(_("Embedded file %1$s does not exist. Did you tamper lyx temporary directory?"), + file.displayName())); } - return true; } -void EmbeddedFiles::writeManifest(ostream & os) const +void EmbeddedFileList::update(Buffer const & buffer) { - EmbeddedFiles::EmbeddedFileList::const_iterator it = begin(); - EmbeddedFiles::EmbeddedFileList::const_iterator it_end = end(); + clear(); + + for (InsetIterator it = inset_iterator_begin(buffer.inset()); it; ++it) + it->registerEmbeddedFiles(*this); + + // add extra embedded files + vector extra = buffer.params().extraEmbeddedFiles(); + vector::iterator it = extra.begin(); + vector::iterator it_end = extra.end(); for (; it != it_end; ++it) { - if (!it->valid()) - continue; - // save the relative path - os << "\\filename " - << to_utf8(makeRelPath(from_utf8(it->absFilename()), - from_utf8(buffer_->filePath()))) << '\n' - << "\\inzipName " << it->inzipName() << '\n' - << "\\status " << (it->embedded() ? "true" : "false") << '\n'; + EmbeddedFile file = EmbeddedFile(*it, buffer.filePath()); + file.setEmbed(true); + file.enable(buffer.embedded(), &buffer, false); + insert(end(), file); } } +bool EmbeddedFileList::writeFile(DocFileName const & filename, Buffer const & buffer) +{ + // file in the temporary path has the content + 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 + update(buffer); + // + iterator it = begin(); + iterator it_end = end(); + for (; it != it_end; ++it) { + if (it->embedded()) { + 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(), + onlyFilename(changeExtension( + filename.toFilesystemEncoding(), ".zip")))); + + ::zipFiles(zipfile.toFilesystemEncoding(), filenames); + // copy file back + if (!zipfile.copyTo(filename)) { + Alert::error(_("Save failure"), + bformat(_("Cannot create file %1$s.\n" + "Please check whether the directory exists and is writeable."), + from_utf8(filename.absFilename()))); + } + return true; } + +} // namespace lyx