X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FEmbeddedFiles.cpp;h=59e93710155d87351e7ae9a1c4dc1aefad3bde63;hb=0362c6aae73c293d1c20277c12d362acfe0b2ef6;hp=23bebc3756063d51d84c31fd204c9ca2da39873a;hpb=c9a7e8c4169e7f45b9bfa6859fe6765adb0bc3a7;p=lyx.git diff --git a/src/EmbeddedFiles.cpp b/src/EmbeddedFiles.cpp index 23bebc3756..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. * @@ -43,35 +43,6 @@ using namespace lyx::support; namespace lyx { -/** Dir name used for ".." in the bundled file. - -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"; - namespace Alert = frontend::Alert; EmbeddedFile::EmbeddedFile(string const & file, std::string const & buffer_path) @@ -88,19 +59,19 @@ void EmbeddedFile::set(std::string const & filename, std::string const & buffer_ if (filename.empty()) return; - inzip_name_ = to_utf8(makeRelPath(from_utf8(absFilename()), - from_utf8(buffer_path))); - - if (FileName(inzip_name_).isAbsolute()) - inzip_name_ = absDirName + '/' + inzip_name_; + inzip_name_ = calcInzipName(buffer_path); +} - // replace .. by upDirName - if (prefixIs(inzip_name_, ".")) - inzip_name_ = subst(inzip_name_, "..", upDirName); - // to avoid name conflict between $docu_path/file and $temp_path/file - // embedded files are in a subdirectory of $temp_path. - inzip_name_ = embDirName + '/' + inzip_name_; +void EmbeddedFile::setInzipName(std::string const & 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; } @@ -143,13 +114,17 @@ 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 (embedded()) { + if (inzip_name_ != calcInzipName(buf->filePath())) + syncInzipFile(buf->filePath()); updateFromExternalFile(); + } else + extract(); } else { extract(); temp_path_ = ""; @@ -286,6 +261,101 @@ bool EmbeddedFile::isReadableFile() const } +unsigned long EmbeddedFile::checksum() const +{ + 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() @@ -300,39 +370,33 @@ bool operator!=(EmbeddedFile const & lhs, EmbeddedFile const & rhs) } -bool EmbeddedFiles::enabled() const -{ - return buffer_->params().embedded; -} - - -void EmbeddedFiles::enable(bool flag) +void EmbeddedFileList::enable(bool flag, Buffer & buffer) { - if (enabled() == flag) + if (buffer.embedded() == flag) return; // update embedded file list - update(); + update(buffer); int count_embedded = 0; int count_external = 0; - EmbeddedFileList::iterator it = file_list_.begin(); - EmbeddedFileList::iterator it_end = file_list_.end(); + 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_); + 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; + buffer.markDirty(); + buffer.params().embedded = flag; // if the operation is successful, update insets - for (it = file_list_.begin(); it != it_end; ++it) - it->updateInsets(buffer_); + for (it = begin(); it != it_end; ++it) + it->updateInsets(&buffer); // show result if (flag) { @@ -347,14 +411,15 @@ void EmbeddedFiles::enable(bool flag) } -void EmbeddedFiles::registerFile(EmbeddedFile const & file, Inset const * inset) +void EmbeddedFileList::registerFile(EmbeddedFile const & file, + Inset const * inset, Buffer const & buffer) { - BOOST_ASSERT(!enabled() || file.availableFile().exists()); - BOOST_ASSERT(!enabled() || file.enabled()); + 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() == file.absFilename()) { if (it->embedded() != file.embedded()) { @@ -364,39 +429,39 @@ void EmbeddedFiles::registerFile(EmbeddedFile const & file, Inset const * inset) from_utf8(it->outputFilename()))); it->setEmbed(true); // update the inset with this embedding status. - const_cast(inset)->updateEmbeddedFile(*buffer_, *it); + const_cast(inset)->updateEmbeddedFile(buffer, *it); } it->addInset(inset); return; } // - file_list_.push_back(file); - file_list_.back().addInset(inset); + 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 - update(); - 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->embeddedFile(); @@ -411,7 +476,7 @@ bool EmbeddedFiles::writeFile(DocFileName const & filename) } // 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"))));