3 * \file EmbeddedFileList.cpp
4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
9 * Full author contact details are available in file CREDITS.
15 #include "EmbeddedFiles.h"
18 #include "BufferParams.h"
19 #include "ErrorList.h"
21 #include "InsetIterator.h"
24 #include "Paragraph.h"
27 #include "frontends/alert.h"
29 #include "support/debug.h"
30 #include "support/filetools.h"
31 #include "support/gettext.h"
32 #include "support/convert.h"
33 #include "support/lstrings.h"
34 #include "support/ExceptionMessage.h"
35 #include "support/FileZipListDir.h"
42 using namespace lyx::support;
46 namespace Alert = frontend::Alert;
48 EmbeddedFile::EmbeddedFile(string const & file, std::string const & buffer_path)
49 : DocFileName("", false), inzip_name_(""), embedded_(false), inset_list_(),
52 set(file, buffer_path);
56 void EmbeddedFile::set(std::string const & filename, std::string const & buffer_path)
58 DocFileName::set(filename, buffer_path);
62 if (!buffer_path.empty())
63 inzip_name_ = calcInzipName(buffer_path);
67 void EmbeddedFile::setInzipName(std::string const & name)
69 if (name.empty() || name == inzip_name_)
72 // an enabled EmbeededFile should have this problem handled
73 BOOST_ASSERT(!enabled());
74 // file will be synced when it is enabled
79 string EmbeddedFile::embeddedFile() const
81 BOOST_ASSERT(enabled());
82 return temp_path_ + inzip_name_;
86 FileName EmbeddedFile::availableFile() const
88 if (enabled() && embedded())
89 return FileName(embeddedFile());
95 string EmbeddedFile::latexFilename(std::string const & buffer_path) const
97 return (enabled() && embedded()) ? inzip_name_ : relFilename(buffer_path);
101 void EmbeddedFile::addInset(Inset const * inset)
104 inset_list_.push_back(inset);
108 void EmbeddedFile::setEmbed(bool embed)
114 void EmbeddedFile::enable(bool flag, Buffer const * buf, bool updateFile)
116 // This function will be called when
117 // 1. through EmbeddedFiles::enable() when a file is read. Files
118 // should be in place so no updateFromExternalFile or extract()
119 // should be called. (updateFile should be false in this case).
120 // 2. through menu item enable/disable. updateFile should be true.
121 // 3. A single embedded file is added or modified. updateFile
122 // can be true or false.
123 LYXERR(Debug::FILES, (flag ? "Enable" : "Disable")
124 << " " << absFilename()
125 << (updateFile ? " (update file)." : " (no update)."));
128 temp_path_ = buf->temppath();
129 if (!suffixIs(temp_path_, '/'))
131 if (embedded() && updateFile)
132 updateFromExternalFile();
134 if (embedded() && updateFile)
141 bool EmbeddedFile::extract() const
143 BOOST_ASSERT(enabled());
145 string ext_file = absFilename();
146 string emb_file = embeddedFile();
148 FileName emb(emb_file);
149 FileName ext(ext_file);
154 throw ExceptionMessage(ErrorException, _("Failed to extract file"),
155 bformat(_("Cannot extract file '%1$s'.\n"
156 "Source file %2$s does not exist"),
157 from_utf8(outputFilename()), from_utf8(emb_file)));
160 // if external file already exists ...
162 // no need to copy if the files are the same
163 if (checksum() == FileName(emb_file).checksum())
165 // otherwise, ask if overwrite
166 int ret = Alert::prompt(
167 _("Overwrite external file?"),
168 bformat(_("External file %1$s already exists, do you want to overwrite it"),
169 from_utf8(ext_file)), 1, 1, _("&Overwrite"), _("&Cancel"));
171 // if the user does not want to overwrite, we still consider it
172 // a successful operation.
177 // need to make directory?
178 FileName path = ext.onlyPath();
179 if (!path.createPath()) {
180 throw ExceptionMessage(ErrorException, _("Copy file failure"),
181 bformat(_("Cannot create file path '%1$s'.\n"
182 "Please check whether the path is writeable."),
183 from_utf8(path.absFilename())));
187 if (emb.copyTo(ext)) {
188 LYXERR(Debug::FILES, "Extract file " << emb_file << " to " << ext_file << endl);
192 throw ExceptionMessage(ErrorException, _("Copy file failure"),
193 bformat(_("Cannot copy file %1$s to %2$s.\n"
194 "Please check whether the directory exists and is writeable."),
195 from_utf8(emb_file), from_utf8(ext_file)));
200 bool EmbeddedFile::updateFromExternalFile() const
202 BOOST_ASSERT(enabled());
204 string ext_file = absFilename();
205 string emb_file = embeddedFile();
207 FileName emb(emb_file);
208 FileName ext(ext_file);
214 // no external and internal file
215 throw ExceptionMessage(ErrorException,
216 _("Failed to embed file"),
217 bformat(_("Failed to embed file %1$s.\n"
218 "Please check whether this file exists and is readable."),
219 from_utf8(ext_file)));
222 // if embedded file already exists ...
224 // no need to copy if the files are the same
225 if (checksum() == FileName(emb_file).checksum())
227 // other wise, ask if overwrite
228 int const ret = Alert::prompt(
229 _("Update embedded file?"),
230 bformat(_("Embedded file %1$s already exists, do you want to overwrite it"),
231 from_utf8(ext_file)), 1, 1, _("&Overwrite"), _("&Cancel"));
233 // if the user does not want to overwrite, we still consider it
234 // a successful operation.
238 // need to make directory?
239 FileName path = emb.onlyPath();
240 if (!path.isDirectory())
244 throw ExceptionMessage(ErrorException,
245 _("Copy file failure"),
246 bformat(_("Cannot copy file %1$s to %2$s.\n"
247 "Please check whether the directory exists and is writeable."),
248 from_utf8(ext_file), from_utf8(emb_file)));
249 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
254 void EmbeddedFile::updateInsets() const
256 vector<Inset const *>::const_iterator it = inset_list_.begin();
257 vector<Inset const *>::const_iterator it_end = inset_list_.end();
258 for (; it != it_end; ++it)
259 const_cast<Inset *>(*it)->updateEmbeddedFile(*this);
263 bool EmbeddedFile::isReadableFile() const
265 return availableFile().isReadableFile();
269 unsigned long EmbeddedFile::checksum() const
271 return availableFile().checksum();
275 Under the lyx temp directory, content.lyx and its embedded files are usually
278 $temp/$embDirName/file.lyx
279 $temp/$embDirName/figure1.png for ./figure1.png)
280 $temp/$embDirName/sub/figure2.png for ./sub/figure2.png)
282 This works fine for embedded files that are in the current or deeper directory
283 of the document directory, but not for files such as ../figures/figure.png.
284 A unique name $upDirName is chosen to represent .. in such filenames so that
285 'up' directories can be stored 'down' the directory tree:
287 $temp/$embDirName/$upDirName/figures/figure.png for ../figures/figure.png
288 $temp/$embDirName/$upDirName/$upDirName/figure.png for ../../figure.png
290 This name has to be fixed because it is used in lyx bundled .zip file.
292 Using a similar trick, we use $absDirName for absolute path so that
293 an absolute filename can be saved as
295 $temp/$embDirName/$absDirName/a/absolute/path for /a/absolute/path
298 embDirName is set to . so that embedded layout and class files can be
299 used directly. However, putting all embedded files directly under
300 the temp directory may lead to file conflicts. For example, if a user
301 embeds a file blah.log in blah.lyx, it will be replaced when
302 'latex blah.tex' is called.
304 const std::string embDirName = ".";
305 const std::string upDirName = "LyX.Embed.Dir.Up";
306 const std::string absDirName = "LyX.Embed.Dir.Abs";
307 const std::string driveName = "LyX.Embed.Drive";
308 const std::string spaceName = "LyX.Embed.Space";
310 std::string EmbeddedFile::calcInzipName(std::string const & buffer_path)
312 string inzipName = to_utf8(makeRelPath(from_utf8(absFilename()),
313 from_utf8(buffer_path)));
315 if (FileName(inzipName).isAbsolute())
316 inzipName = absDirName + '/' + inzipName;
318 // replace .. by upDirName
319 if (prefixIs(inzipName, "."))
320 inzipName = subst(inzipName, "..", upDirName);
321 // replace special characters by their value
322 inzipName = subst(inzipName, ":", driveName);
323 inzipName = subst(inzipName, " ", spaceName);
325 // to avoid name conflict between $docu_path/file and $temp_path/file
326 // embedded files are in a subdirectory of $temp_path.
327 inzipName = embDirName + '/' + inzipName;
332 void EmbeddedFile::syncInzipFile(std::string const & buffer_path)
334 BOOST_ASSERT(enabled());
335 string old_emb_file = temp_path_ + '/' + inzip_name_;
336 FileName old_emb(old_emb_file);
338 if (!old_emb.exists())
339 throw ExceptionMessage(ErrorException, _("Failed to open file"),
340 bformat(_("Embedded file %1$s does not exist. Did you tamper lyx temporary directory?"),
341 old_emb.displayName()));
343 string new_inzip_name = calcInzipName(buffer_path);
344 if (new_inzip_name == inzip_name_)
347 LYXERR(Debug::FILES, " OLD ZIP " << old_emb_file <<
348 " NEW ZIP " << calcInzipName(buffer_path));
350 string new_emb_file = temp_path_ + '/' + new_inzip_name;
351 FileName new_emb(new_emb_file);
353 // need to make directory?
354 FileName path = new_emb.onlyPath();
355 if (!path.createPath()) {
356 throw ExceptionMessage(ErrorException, _("Sync file failure"),
357 bformat(_("Cannot create file path '%1$s'.\n"
358 "Please check whether the path is writeable."),
359 from_utf8(path.absFilename())));
363 if (old_emb.copyTo(new_emb)) {
364 LYXERR(Debug::FILES, "Sync inzip file from " << inzip_name_
365 << " to " << new_inzip_name);
366 inzip_name_ = new_inzip_name;
369 throw ExceptionMessage(ErrorException, _("Sync file failure"),
370 bformat(_("Cannot copy file %1$s to %2$s.\n"
371 "Please check whether the directory exists and is writeable."),
372 from_utf8(old_emb_file), from_utf8(new_emb_file)));
376 bool operator==(EmbeddedFile const & lhs, EmbeddedFile const & rhs)
378 return lhs.absFilename() == rhs.absFilename()
379 && lhs.saveAbsPath() == rhs.saveAbsPath()
380 && lhs.embedded() == rhs.embedded();
384 bool operator!=(EmbeddedFile const & lhs, EmbeddedFile const & rhs)
386 return !(lhs == rhs);
390 void EmbeddedFileList::enable(bool flag, Buffer & buffer, bool updateFile)
392 // update embedded file list
395 int count_embedded = 0;
396 int count_external = 0;
397 iterator it = begin();
398 iterator it_end = end();
399 // an exception may be thrown
400 for (; it != it_end; ++it) {
401 it->enable(flag, &buffer, updateFile);
407 // if operation is successful (no exception is thrown)
408 buffer.params().embedded = flag;
410 // if the operation is successful, update insets
411 for (it = begin(); it != it_end; ++it)
419 docstring const msg = bformat(_("%1$d external files are ignored.\n"
420 "%2$d embeddable files are embedded.\n"), count_external, count_embedded);
421 Alert::information(_("Packing all files"), msg);
423 docstring const msg = bformat(_("%1$d external files are ignored.\n"
424 "%2$d embedded files are extracted.\n"), count_external, count_embedded);
425 Alert::information(_("Unpacking all files"), msg);
430 void EmbeddedFileList::registerFile(EmbeddedFile const & file,
431 Inset const * inset, Buffer const & buffer)
433 BOOST_ASSERT(!buffer.embedded() || file.enabled());
435 // try to find this file from the list
436 std::vector<EmbeddedFile>::iterator it = begin();
437 std::vector<EmbeddedFile>::iterator it_end = end();
438 for (; it != it_end; ++it)
439 if (it->absFilename() == file.absFilename()) {
440 if (it->embedded() != file.embedded()) {
441 Alert::error(_("Wrong embedding status."),
442 bformat(_("File %1$s is included in more than one insets, "
443 "but with different embedding status. Assuming embedding status."),
444 from_utf8(it->outputFilename())));
446 // update the inset with this embedding status.
447 const_cast<Inset*>(inset)->updateEmbeddedFile(*it);
455 back().addInset(inset);
459 void EmbeddedFileList::validate(Buffer const & buffer)
463 for (InsetIterator it = inset_iterator_begin(buffer.inset()); it; ++it)
464 it->registerEmbeddedFiles(*this);
466 iterator it = begin();
467 iterator it_end = end();
468 for (; it != it_end; ++it) {
469 if (buffer.embedded() && it->embedded())
470 // An exception will be raised if inzip file does not exist
471 it->syncInzipFile(buffer.filePath());
473 // inzipName may be OS dependent
474 it->setInzipName(it->calcInzipName(buffer.filePath()));
476 for (it = begin(); it != it_end; ++it)
479 if (!buffer.embedded())
482 // check if extra embedded files exist
483 vector<string> extra = buffer.params().extraEmbeddedFiles();
484 vector<string>::iterator e_it = extra.begin();
485 vector<string>::iterator e_end = extra.end();
486 for (; e_it != e_end; ++e_it) {
487 EmbeddedFile file = EmbeddedFile(*e_it, buffer.filePath());
488 // do not update from external file
489 file.enable(true, &buffer, false);
490 // but we do need to check file existence.
491 if (!FileName(file.embeddedFile()).exists())
492 throw ExceptionMessage(ErrorException, _("Failed to open file"),
493 bformat(_("Embedded file %1$s does not exist. Did you tamper lyx temporary directory?"),
494 file.displayName()));
499 void EmbeddedFileList::update(Buffer const & buffer)
503 for (InsetIterator it = inset_iterator_begin(buffer.inset()); it; ++it)
504 it->registerEmbeddedFiles(*this);
506 // add extra embedded files
507 vector<string> extra = buffer.params().extraEmbeddedFiles();
508 vector<string>::iterator it = extra.begin();
509 vector<string>::iterator it_end = extra.end();
510 for (; it != it_end; ++it) {
511 EmbeddedFile file = EmbeddedFile(*it, buffer.filePath());
513 file.enable(buffer.embedded(), &buffer, false);
519 bool EmbeddedFileList::writeFile(DocFileName const & filename, Buffer const & buffer)
521 // file in the temporary path has the content
522 string const content = FileName(addName(buffer.temppath(),
523 "content.lyx")).toFilesystemEncoding();
525 vector<pair<string, string> > filenames;
526 // add content.lyx to filenames
527 filenames.push_back(make_pair(content, "content.lyx"));
528 // prepare list of embedded file
531 iterator it = begin();
532 iterator it_end = end();
533 for (; it != it_end; ++it) {
534 if (it->embedded()) {
535 string file = it->embeddedFile();
536 if (!FileName(file).exists())
537 throw ExceptionMessage(ErrorException, _("Failed to write file"),
538 bformat(_("Embedded file %1$s does not exist. Did you tamper lyx temporary directory?"),
540 filenames.push_back(make_pair(file, it->inzipName()));
541 LYXERR(Debug::FILES, "Writing file " << it->outputFilename()
542 << " as " << it->inzipName() << endl);
545 // write a zip file with all these files. Write to a temp file first, to
546 // avoid messing up the original file in case something goes terribly wrong.
547 DocFileName zipfile(addName(buffer.temppath(),
548 onlyFilename(changeExtension(
549 filename.toFilesystemEncoding(), ".zip"))));
551 ::zipFiles(zipfile.toFilesystemEncoding(), filenames);
553 if (!zipfile.copyTo(filename)) {
554 Alert::error(_("Save failure"),
555 bformat(_("Cannot create file %1$s.\n"
556 "Please check whether the directory exists and is writeable."),
557 from_utf8(filename.absFilename())));