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"
37 #include <boost/assert.hpp>
44 using namespace lyx::support;
48 namespace Alert = frontend::Alert;
50 EmbeddedFile::EmbeddedFile(string const & file, std::string const & buffer_path)
51 : DocFileName("", false), embedded_(false), inset_list_()
53 set(file, buffer_path);
57 void EmbeddedFile::set(std::string const & filename, std::string const & buffer_path)
59 DocFileName::set(filename, buffer_path);
63 if (!buffer_path.empty())
64 inzip_name_ = calcInzipName(buffer_path);
68 void EmbeddedFile::setInzipName(std::string const & name)
70 if (name.empty() || name == inzip_name_)
73 // an enabled EmbeededFile should have this problem handled
74 BOOST_ASSERT(!isEnabled());
75 // file will be synced when it is enabled
80 string EmbeddedFile::embeddedFile() const
82 BOOST_ASSERT(isEnabled());
83 return temp_path_ + inzip_name_;
87 FileName EmbeddedFile::availableFile() const
89 if (isEnabled() && embedded())
90 return FileName(embeddedFile());
96 string EmbeddedFile::latexFilename(std::string const & buffer_path) const
98 return (isEnabled() && embedded()) ? inzip_name_ : relFilename(buffer_path);
102 void EmbeddedFile::addInset(Inset const * inset)
105 inset_list_.push_back(inset);
109 void EmbeddedFile::setEmbed(bool embed)
115 void EmbeddedFile::enable(bool enabled, Buffer const & buf, bool updateFile)
117 // This function will be called when
118 // 1. through EmbeddedFiles::enable() when a file is read. Files
119 // should be in place so no updateFromExternalFile or extract()
120 // should be called. (updateFile should be false in this case).
121 // 2. through menu item enable/disable. updateFile should be true.
122 // 3. A single embedded file is added or modified. updateFile
123 // can be true or false.
124 LYXERR(Debug::FILES, (enabled ? "Enable" : "Disable")
125 << " " << absFilename()
126 << (updateFile ? " (update file)." : " (no update)."));
129 temp_path_ = buf.temppath();
130 if (!suffixIs(temp_path_, '/'))
132 if (embedded() && updateFile)
133 updateFromExternalFile();
135 // when a new embeddeed file is created, it is not enabled, and
136 // there is no need to extract.
137 if (isEnabled() && embedded() && updateFile)
144 bool EmbeddedFile::extract() const
146 BOOST_ASSERT(isEnabled());
148 string ext_file = absFilename();
149 string emb_file = embeddedFile();
151 FileName emb(emb_file);
152 FileName ext(ext_file);
157 throw ExceptionMessage(ErrorException, _("Failed to extract file"),
158 bformat(_("Cannot extract file '%1$s'.\n"
159 "Source file %2$s does not exist"),
160 from_utf8(outputFilename()), from_utf8(emb_file)));
163 // if external file already exists ...
165 // no need to copy if the files are the same
166 if (checksum() == FileName(emb_file).checksum())
168 // otherwise, ask if overwrite
169 int ret = Alert::prompt(
170 _("Overwrite external file?"),
171 bformat(_("External file %1$s already exists, do you want to overwrite it?"),
172 from_utf8(ext_file)), 1, 1, _("&Overwrite"), _("&Cancel"));
174 // if the user does not want to overwrite, we still consider it
175 // a successful operation.
180 // need to make directory?
181 FileName path = ext.onlyPath();
182 if (!path.createPath()) {
183 throw ExceptionMessage(ErrorException, _("Copy file failure"),
184 bformat(_("Cannot create file path '%1$s'.\n"
185 "Please check whether the path is writeable."),
186 from_utf8(path.absFilename())));
190 if (emb.copyTo(ext)) {
191 LYXERR(Debug::FILES, "Extract file " << emb_file << " to " << ext_file << endl);
195 throw ExceptionMessage(ErrorException, _("Copy file failure"),
196 bformat(_("Cannot copy file %1$s to %2$s.\n"
197 "Please check whether the directory exists and is writeable."),
198 from_utf8(emb_file), from_utf8(ext_file)));
203 bool EmbeddedFile::updateFromExternalFile() const
205 BOOST_ASSERT(isEnabled());
207 string ext_file = absFilename();
208 string emb_file = embeddedFile();
210 FileName emb(emb_file);
211 FileName ext(ext_file);
217 // no external and internal file
218 throw ExceptionMessage(ErrorException,
219 _("Failed to embed file"),
220 bformat(_("Failed to embed file %1$s.\n"
221 "Please check whether this file exists and is readable."),
222 from_utf8(ext_file)));
225 // if embedded file already exists ...
227 // no need to copy if the files are the same
228 if (checksum() == FileName(emb_file).checksum())
230 // other wise, ask if overwrite
231 int const ret = Alert::prompt(
232 _("Update embedded file?"),
233 bformat(_("Embedded file %1$s already exists, do you want to overwrite it"),
234 from_utf8(ext_file)), 1, 1, _("&Overwrite"), _("&Cancel"));
236 // if the user does not want to overwrite, we still consider it
237 // a successful operation.
241 // need to make directory?
242 FileName path = emb.onlyPath();
243 if (!path.isDirectory())
247 throw ExceptionMessage(ErrorException,
248 _("Copy file failure"),
249 bformat(_("Cannot copy file %1$s to %2$s.\n"
250 "Please check whether the directory exists and is writeable."),
251 from_utf8(ext_file), from_utf8(emb_file)));
252 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
257 EmbeddedFile EmbeddedFile::copyTo(Buffer const & buf)
259 EmbeddedFile file = EmbeddedFile(absFilename(), buf.filePath());
260 file.setEmbed(embedded());
261 file.enable(buf.embedded(), buf, false);
263 // use external file.
267 LYXERR(Debug::FILES, "Copy " << availableFile()
268 << " to " << file.availableFile());
270 FileName from_file = availableFile();
271 FileName to_file = file.availableFile();
273 if (!from_file.exists()) {
275 throw ExceptionMessage(ErrorException,
276 _("Failed to copy embedded file"),
277 bformat(_("Failed to embed file %1$s.\n"
278 "Please check whether the source file is available"),
279 from_utf8(absFilename())));
280 file.setEmbed(false);
284 // if destination file already exists ...
285 if (to_file.exists()) {
286 // no need to copy if the files are the same
287 if (checksum() == to_file.checksum())
289 // other wise, ask if overwrite
290 int const ret = Alert::prompt(
291 _("Update embedded file?"),
292 bformat(_("Embedded file %1$s already exists, do you want to overwrite it"),
293 from_utf8(to_file.absFilename())), 1, 1, _("&Overwrite"), _("&Cancel"));
295 // if the user does not want to overwrite, we still consider it
296 // a successful operation.
300 // need to make directory?
301 FileName path = to_file.onlyPath();
302 if (!path.isDirectory())
304 if (from_file.copyTo(to_file))
306 throw ExceptionMessage(ErrorException,
307 _("Copy file failure"),
308 bformat(_("Cannot copy file %1$s to %2$s.\n"
309 "Please check whether the directory exists and is writeable."),
310 from_utf8(from_file.absFilename()), from_utf8(to_file.absFilename())));
315 void EmbeddedFile::updateInsets() const
317 vector<Inset const *>::const_iterator it = inset_list_.begin();
318 vector<Inset const *>::const_iterator it_end = inset_list_.end();
319 for (; it != it_end; ++it)
320 const_cast<Inset *>(*it)->updateEmbeddedFile(*this);
324 bool EmbeddedFile::isReadableFile() const
326 return availableFile().isReadableFile();
330 unsigned long EmbeddedFile::checksum() const
332 return availableFile().checksum();
336 Under the lyx temp directory, content.lyx and its embedded files are usually
339 $temp/$embDirName/file.lyx
340 $temp/$embDirName/figure1.png for ./figure1.png)
341 $temp/$embDirName/sub/figure2.png for ./sub/figure2.png)
343 This works fine for embedded files that are in the current or deeper directory
344 of the document directory, but not for files such as ../figures/figure.png.
345 A unique name $upDirName is chosen to represent .. in such filenames so that
346 'up' directories can be stored 'down' the directory tree:
348 $temp/$embDirName/$upDirName/figures/figure.png for ../figures/figure.png
349 $temp/$embDirName/$upDirName/$upDirName/figure.png for ../../figure.png
351 This name has to be fixed because it is used in lyx bundled .zip file.
353 Using a similar trick, we use $absDirName for absolute path so that
354 an absolute filename can be saved as
356 $temp/$embDirName/$absDirName/a/absolute/path for /a/absolute/path
359 embDirName is set to . so that embedded layout and class files can be
360 used directly. However, putting all embedded files directly under
361 the temp directory may lead to file conflicts. For example, if a user
362 embeds a file blah.log in blah.lyx, it will be replaced when
363 'latex blah.tex' is called.
365 const std::string embDirName = ".";
366 const std::string upDirName = "LyX.Embed.Dir.Up";
367 const std::string absDirName = "LyX.Embed.Dir.Abs";
368 const std::string driveName = "LyX.Embed.Drive";
369 const std::string spaceName = "LyX.Embed.Space";
371 std::string EmbeddedFile::calcInzipName(std::string const & buffer_path)
373 string inzipName = to_utf8(makeRelPath(from_utf8(absFilename()),
374 from_utf8(buffer_path)));
376 if (FileName(inzipName).isAbsolute())
377 inzipName = absDirName + '/' + inzipName;
379 // replace .. by upDirName
380 if (prefixIs(inzipName, "."))
381 inzipName = subst(inzipName, "..", upDirName);
382 // replace special characters by their value
383 inzipName = subst(inzipName, ":", driveName);
384 inzipName = subst(inzipName, " ", spaceName);
386 // to avoid name conflict between $docu_path/file and $temp_path/file
387 // embedded files are in a subdirectory of $temp_path.
388 inzipName = embDirName + '/' + inzipName;
393 void EmbeddedFile::syncInzipFile(std::string const & buffer_path)
395 BOOST_ASSERT(isEnabled());
396 string old_emb_file = temp_path_ + '/' + inzip_name_;
397 FileName old_emb(old_emb_file);
399 if (!old_emb.exists())
400 throw ExceptionMessage(ErrorException, _("Failed to open file"),
401 bformat(_("Embedded file %1$s does not exist. Did you tamper lyx temporary directory?"),
402 old_emb.displayName()));
404 string new_inzip_name = calcInzipName(buffer_path);
405 if (new_inzip_name == inzip_name_)
408 LYXERR(Debug::FILES, " OLD ZIP " << old_emb_file <<
409 " NEW ZIP " << calcInzipName(buffer_path));
411 string new_emb_file = temp_path_ + '/' + new_inzip_name;
412 FileName new_emb(new_emb_file);
414 // need to make directory?
415 FileName path = new_emb.onlyPath();
416 if (!path.createPath()) {
417 throw ExceptionMessage(ErrorException, _("Sync file failure"),
418 bformat(_("Cannot create file path '%1$s'.\n"
419 "Please check whether the path is writeable."),
420 from_utf8(path.absFilename())));
424 if (old_emb.copyTo(new_emb)) {
425 LYXERR(Debug::FILES, "Sync inzip file from " << inzip_name_
426 << " to " << new_inzip_name);
427 inzip_name_ = new_inzip_name;
430 throw ExceptionMessage(ErrorException, _("Sync file failure"),
431 bformat(_("Cannot copy file %1$s to %2$s.\n"
432 "Please check whether the directory exists and is writeable."),
433 from_utf8(old_emb_file), from_utf8(new_emb_file)));
437 bool operator==(EmbeddedFile const & lhs, EmbeddedFile const & rhs)
439 return lhs.absFilename() == rhs.absFilename()
440 && lhs.saveAbsPath() == rhs.saveAbsPath()
441 && lhs.embedded() == rhs.embedded();
445 bool operator!=(EmbeddedFile const & lhs, EmbeddedFile const & rhs)
447 return !(lhs == rhs);
451 void EmbeddedFileList::enable(bool enabled, Buffer & buffer, bool updateFile)
453 // update embedded file list
456 int count_embedded = 0;
457 int count_external = 0;
458 iterator it = begin();
459 iterator it_end = end();
460 // an exception may be thrown
461 for (; it != it_end; ++it) {
462 it->enable(enabled, buffer, updateFile);
468 // if operation is successful (no exception is thrown)
469 buffer.params().embedded = enabled;
471 // if the operation is successful, update insets
472 for (it = begin(); it != it_end; ++it)
475 if (!updateFile || (count_external == 0 && count_embedded == 0))
480 docstring const msg = bformat(_("%1$d external files are ignored.\n"
481 "%2$d embeddable files are embedded.\n"), count_external, count_embedded);
482 Alert::information(_("Packing all files"), msg);
484 docstring const msg = bformat(_("%1$d external files are ignored.\n"
485 "%2$d embedded files are extracted.\n"), count_external, count_embedded);
486 Alert::information(_("Unpacking all files"), msg);
491 void EmbeddedFileList::registerFile(EmbeddedFile const & file,
492 Inset const * inset, Buffer const & buffer)
494 BOOST_ASSERT(!buffer.embedded() || file.isEnabled());
496 string newfile = file.absFilename();
497 iterator efp = findFile(newfile);
499 if (efp->embedded() != file.embedded()) {
500 Alert::error(_("Wrong embedding status."),
501 bformat(_("File %1$s is included in more than one insets, "
502 "but with different embedding status. Assuming embedding status."),
503 from_utf8(efp->outputFilename())));
505 // update the inset with this embedding status.
506 const_cast<Inset*>(inset)->updateEmbeddedFile(*efp);
508 efp->addInset(inset);
513 back().addInset(inset);
517 EmbeddedFileList::const_iterator
518 EmbeddedFileList::findFile(std::string const & filename) const
520 // try to find this file from the list
521 std::vector<EmbeddedFile>::const_iterator it = begin();
522 std::vector<EmbeddedFile>::const_iterator it_end = end();
523 for (; it != it_end; ++it)
524 if (it->absFilename() == filename)
530 EmbeddedFileList::iterator
531 EmbeddedFileList::findFile(std::string const & filename)
533 // try to find this file from the list
534 std::vector<EmbeddedFile>::iterator it = begin();
535 std::vector<EmbeddedFile>::iterator it_end = end();
536 for (; it != it_end; ++it)
537 if (it->absFilename() == filename)
543 void EmbeddedFileList::validate(Buffer const & buffer)
547 for (InsetIterator it = inset_iterator_begin(buffer.inset()); it; ++it)
548 it->registerEmbeddedFiles(*this);
550 iterator it = begin();
551 iterator it_end = end();
552 for (; it != it_end; ++it) {
553 if (buffer.embedded() && it->embedded())
554 // An exception will be raised if inzip file does not exist
555 it->syncInzipFile(buffer.filePath());
557 // inzipName may be OS dependent
558 it->setInzipName(it->calcInzipName(buffer.filePath()));
560 for (it = begin(); it != it_end; ++it)
563 if (!buffer.embedded())
566 // check if extra embedded files exist
567 vector<string> extra = buffer.params().extraEmbeddedFiles();
568 vector<string>::iterator e_it = extra.begin();
569 vector<string>::iterator e_end = extra.end();
570 for (; e_it != e_end; ++e_it) {
571 EmbeddedFile file = EmbeddedFile(*e_it, buffer.filePath());
572 // do not update from external file
573 file.enable(true, buffer, false);
574 // but we do need to check file existence.
575 if (!FileName(file.embeddedFile()).exists())
576 throw ExceptionMessage(ErrorException, _("Failed to open file"),
577 bformat(_("Embedded file %1$s does not exist. Did you tamper lyx temporary directory?"),
578 file.displayName()));
583 void EmbeddedFileList::update(Buffer const & buffer)
587 for (InsetIterator it = inset_iterator_begin(buffer.inset()); it; ++it)
588 it->registerEmbeddedFiles(*this);
590 // add extra embedded files
591 vector<string> extra = buffer.params().extraEmbeddedFiles();
592 vector<string>::iterator it = extra.begin();
593 vector<string>::iterator it_end = extra.end();
594 for (; it != it_end; ++it) {
595 EmbeddedFile file = EmbeddedFile(*it, buffer.filePath());
597 file.enable(buffer.embedded(), buffer, false);
603 bool EmbeddedFileList::writeFile(DocFileName const & filename, Buffer const & buffer)
605 // file in the temporary path has the content
606 string const content = FileName(addName(buffer.temppath(),
607 "content.lyx")).toFilesystemEncoding();
609 vector<pair<string, string> > filenames;
610 // add content.lyx to filenames
611 filenames.push_back(make_pair(content, "content.lyx"));
612 // prepare list of embedded file
615 iterator it = begin();
616 iterator it_end = end();
617 for (; it != it_end; ++it) {
618 if (it->embedded()) {
619 string file = it->embeddedFile();
620 if (!FileName(file).exists())
621 throw ExceptionMessage(ErrorException, _("Failed to write file"),
622 bformat(_("Embedded file %1$s does not exist. Did you tamper lyx temporary directory?"),
624 filenames.push_back(make_pair(file, it->inzipName()));
625 LYXERR(Debug::FILES, "Writing file " << it->outputFilename()
626 << " as " << it->inzipName() << endl);
629 // write a zip file with all these files. Write to a temp file first, to
630 // avoid messing up the original file in case something goes terribly wrong.
631 DocFileName zipfile(addName(buffer.temppath(),
632 onlyFilename(changeExtension(
633 filename.toFilesystemEncoding(), ".zip"))));
635 ::zipFiles(zipfile.toFilesystemEncoding(), filenames);
637 if (!zipfile.copyTo(filename)) {
638 Alert::error(_("Save failure"),
639 bformat(_("Cannot create file %1$s.\n"
640 "Please check whether the directory exists and is writeable."),
641 from_utf8(filename.absFilename())));