src/EmbeddedFiles.cpp

   1 // -*- C++ -*-
   2 /**
   3  * \file EmbeddedFileList.cpp
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Bo Peng
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  *
  11  */
  12
  13 #include <config.h>
  14
  15 #include "EmbeddedFiles.h"
  16
  17 #include "Buffer.h"
  18 #include "BufferParams.h"
  19 #include "ErrorList.h"
  20 #include "Format.h"
  21 #include "InsetIterator.h"
  22 #include "Lexer.h"
  23 #include "LyX.h"
  24 #include "Paragraph.h"
  25 #include "Session.h"
  26
  27 #include "frontends/alert.h"
  28
  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"
  36
  37 #include <boost/assert.hpp>
  38
  39 #include <sstream>
  40 #include <fstream>
  41 #include <utility>
  42
  43 using namespace std;
  44 using namespace lyx::support;
  45
  46 namespace lyx {
  47
  48 namespace Alert = frontend::Alert;
  49
  50 EmbeddedFile::EmbeddedFile(string const & file, std::string const & buffer_path)
  51         : DocFileName("", false), embedded_(false), inset_list_()
  52 {
  53         set(file, buffer_path);
  54 }
  55
  56
  57 void EmbeddedFile::set(std::string const & filename, std::string const & buffer_path)
  58 {
  59         DocFileName::set(filename, buffer_path);
  60         if (filename.empty())
  61                 return;
  62
  63         if (!buffer_path.empty())
  64                 inzip_name_ = calcInzipName(buffer_path);
  65 }
  66
  67
  68 void EmbeddedFile::setInzipName(std::string const & name)
  69 {
  70         if (name.empty() || name == inzip_name_)
  71                 return;
  72
  73         // an enabled EmbeededFile should have this problem handled
  74         BOOST_ASSERT(!enabled());
  75         // file will be synced when it is enabled
  76         inzip_name_ = name;
  77 }
  78
  79
  80 string EmbeddedFile::embeddedFile() const
  81 {
  82         BOOST_ASSERT(enabled());
  83         return temp_path_ + inzip_name_;
  84 }
  85
  86
  87 FileName EmbeddedFile::availableFile() const
  88 {
  89         if (enabled() && embedded())
  90                 return FileName(embeddedFile());
  91         else
  92                 return *this;
  93 }
  94
  95
  96 string EmbeddedFile::latexFilename(std::string const & buffer_path) const
  97 {
  98         return (enabled() && embedded()) ? inzip_name_ : relFilename(buffer_path);
  99 }
 100
 101
 102 void EmbeddedFile::addInset(Inset const * inset)
 103 {
 104         if (inset != NULL)
 105                 inset_list_.push_back(inset);
 106 }
 107
 108
 109 void EmbeddedFile::setEmbed(bool embed)
 110 {
 111         embedded_ = embed;
 112 }
 113
 114
 115 void EmbeddedFile::enable(bool flag, Buffer const * buf, bool updateFile)
 116 {
 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, (flag ? "Enable" : "Disable")
 125                 << " " << absFilename()
 126                 << (updateFile ? " (update file)." : " (no update)."));
 127
 128         if (flag) {
 129                 temp_path_ = buf->temppath();
 130                 if (!suffixIs(temp_path_, '/'))
 131                         temp_path_ += '/';
 132                 if (embedded() && updateFile)
 133                         updateFromExternalFile();
 134         } else {
 135                 // when a new embeddeed file is created, it is not enabled, and
 136                 // there is no need to extract.
 137                 if (enabled() && embedded() && updateFile)
 138                         extract();
 139                 temp_path_ = "";
 140         }
 141 }
 142
 143
 144 bool EmbeddedFile::extract() const
 145 {
 146         BOOST_ASSERT(enabled());
 147
 148         string ext_file = absFilename();
 149         string emb_file = embeddedFile();
 150
 151         FileName emb(emb_file);
 152         FileName ext(ext_file);
 153
 154         if (!emb.exists()) {
 155                 if (ext.exists())
 156                         return true;
 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)));
 161         }
 162
 163         // if external file already exists ...
 164         if (ext.exists()) {
 165                 // no need to copy if the files are the same
 166                 if (checksum() == FileName(emb_file).checksum())
 167                         return true;
 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"));
 173                 if (ret != 0)
 174                         // if the user does not want to overwrite, we still consider it
 175                         // a successful operation.
 176                         return true;
 177         }
 178         // copy file
 179
 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())));
 187                 return false;
 188         }
 189
 190         if (emb.copyTo(ext)) {
 191                 LYXERR(Debug::FILES, "Extract file " << emb_file << " to " << ext_file << endl);
 192                 return true;
 193         }
 194
 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)));
 199         return false;
 200 }
 201
 202
 203 bool EmbeddedFile::updateFromExternalFile() const
 204 {
 205         BOOST_ASSERT(enabled());
 206
 207         string ext_file = absFilename();
 208         string emb_file = embeddedFile();
 209
 210         FileName emb(emb_file);
 211         FileName ext(ext_file);
 212
 213         if (!ext.exists()) {
 214                 // no need to update
 215                 if (emb.exists())
 216                         return true;
 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)));
 223         }
 224
 225         // if embedded file already exists ...
 226         if (emb.exists()) {
 227                 // no need to copy if the files are the same
 228                 if (checksum() == FileName(emb_file).checksum())
 229                         return true;
 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"));
 235                 if (ret != 0)
 236                         // if the user does not want to overwrite, we still consider it
 237                         // a successful operation.
 238                         return true;
 239         }
 240         // copy file
 241         // need to make directory?
 242         FileName path = emb.onlyPath();
 243         if (!path.isDirectory())
 244                 path.createPath();
 245         if (ext.copyTo(emb))
 246                 return true;
 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());
 253         return false;
 254 }
 255
 256
 257 void EmbeddedFile::updateInsets() const
 258 {
 259         vector<Inset const *>::const_iterator it = inset_list_.begin();
 260         vector<Inset const *>::const_iterator it_end = inset_list_.end();
 261         for (; it != it_end; ++it)
 262                 const_cast<Inset *>(*it)->updateEmbeddedFile(*this);
 263 }
 264
 265
 266 bool EmbeddedFile::isReadableFile() const
 267 {
 268         return availableFile().isReadableFile();
 269 }
 270
 271
 272 unsigned long EmbeddedFile::checksum() const
 273 {
 274         return availableFile().checksum();
 275 }
 276
 277 /**
 278 Under the lyx temp directory, content.lyx and its embedded files are usually
 279 saved as
 280
 281 $temp/$embDirName/file.lyx
 282 $temp/$embDirName/figure1.png     for ./figure1.png)
 283 $temp/$embDirName/sub/figure2.png for ./sub/figure2.png)
 284
 285 This works fine for embedded files that are in the current or deeper directory
 286 of the document directory, but not for files such as ../figures/figure.png.
 287 A unique name $upDirName is chosen to represent .. in such filenames so that
 288 'up' directories can be stored 'down' the directory tree:
 289
 290 $temp/$embDirName/$upDirName/figures/figure.png     for ../figures/figure.png
 291 $temp/$embDirName/$upDirName/$upDirName/figure.png  for ../../figure.png
 292
 293 This name has to be fixed because it is used in lyx bundled .zip file.
 294
 295 Using a similar trick, we use $absDirName for absolute path so that
 296 an absolute filename can be saved as
 297
 298 $temp/$embDirName/$absDirName/a/absolute/path for /a/absolute/path
 299
 300 FIXME:
 301 embDirName is set to . so that embedded layout and class files can be
 302 used directly. However, putting all embedded files directly under
 303 the temp directory may lead to file conflicts. For example, if a user
 304 embeds a file blah.log in blah.lyx, it will be replaced when
 305 'latex blah.tex' is called.
 306 */
 307 const std::string embDirName = ".";
 308 const std::string upDirName = "LyX.Embed.Dir.Up";
 309 const std::string absDirName = "LyX.Embed.Dir.Abs";
 310 const std::string driveName = "LyX.Embed.Drive";
 311 const std::string spaceName = "LyX.Embed.Space";
 312
 313 std::string EmbeddedFile::calcInzipName(std::string const & buffer_path)
 314 {
 315         string inzipName = to_utf8(makeRelPath(from_utf8(absFilename()),
 316                         from_utf8(buffer_path)));
 317
 318         if (FileName(inzipName).isAbsolute())
 319                 inzipName = absDirName + '/' + inzipName;
 320
 321         // replace .. by upDirName
 322         if (prefixIs(inzipName, "."))
 323                 inzipName = subst(inzipName, "..", upDirName);
 324         // replace special characters by their value
 325         inzipName = subst(inzipName, ":", driveName);
 326         inzipName = subst(inzipName, " ", spaceName);
 327
 328         // to avoid name conflict between $docu_path/file and $temp_path/file
 329         // embedded files are in a subdirectory of $temp_path.
 330         inzipName = embDirName + '/' + inzipName;
 331         return inzipName;
 332 }
 333
 334
 335 void EmbeddedFile::syncInzipFile(std::string const & buffer_path)
 336 {
 337         BOOST_ASSERT(enabled());
 338         string old_emb_file = temp_path_ + '/' + inzip_name_;
 339         FileName old_emb(old_emb_file);
 340
 341         if (!old_emb.exists())
 342                 throw ExceptionMessage(ErrorException, _("Failed to open file"),
 343                         bformat(_("Embedded file %1$s does not exist. Did you tamper lyx temporary directory?"),
 344                                 old_emb.displayName()));
 345
 346         string new_inzip_name = calcInzipName(buffer_path);
 347         if (new_inzip_name == inzip_name_)
 348                 return;
 349
 350         LYXERR(Debug::FILES, " OLD ZIP " << old_emb_file <<
 351                 " NEW ZIP " << calcInzipName(buffer_path));
 352
 353         string new_emb_file = temp_path_ + '/' + new_inzip_name;
 354         FileName new_emb(new_emb_file);
 355
 356         // need to make directory?
 357         FileName path = new_emb.onlyPath();
 358         if (!path.createPath()) {
 359                 throw ExceptionMessage(ErrorException, _("Sync file failure"),
 360                         bformat(_("Cannot create file path '%1$s'.\n"
 361                         "Please check whether the path is writeable."),
 362                         from_utf8(path.absFilename())));
 363                 return;
 364         }
 365
 366         if (old_emb.copyTo(new_emb)) {
 367                 LYXERR(Debug::FILES, "Sync inzip file from " << inzip_name_
 368                         << " to " << new_inzip_name);
 369                 inzip_name_ = new_inzip_name;
 370                 return;
 371         }
 372         throw ExceptionMessage(ErrorException, _("Sync file failure"),
 373                  bformat(_("Cannot copy file %1$s to %2$s.\n"
 374                                  "Please check whether the directory exists and is writeable."),
 375                                 from_utf8(old_emb_file), from_utf8(new_emb_file)));
 376 }
 377
 378
 379 bool operator==(EmbeddedFile const & lhs, EmbeddedFile const & rhs)
 380 {
 381         return lhs.absFilename() == rhs.absFilename()
 382                 && lhs.saveAbsPath() == rhs.saveAbsPath()
 383                 && lhs.embedded() == rhs.embedded();
 384 }
 385
 386
 387 bool operator!=(EmbeddedFile const & lhs, EmbeddedFile const & rhs)
 388 {
 389         return !(lhs == rhs);
 390 }
 391
 392
 393 void EmbeddedFileList::enable(bool flag, Buffer & buffer, bool updateFile)
 394 {
 395         // update embedded file list
 396         update(buffer);
 397
 398         int count_embedded = 0;
 399         int count_external = 0;
 400         iterator it = begin();
 401         iterator it_end = end();
 402         // an exception may be thrown
 403         for (; it != it_end; ++it) {
 404                 it->enable(flag, &buffer, updateFile);
 405                 if (it->embedded())
 406                         ++count_embedded;
 407                 else
 408                         ++count_external;
 409         }
 410         // if operation is successful (no exception is thrown)
 411         buffer.params().embedded = flag;
 412
 413         // if the operation is successful, update insets
 414         for (it = begin(); it != it_end; ++it)
 415                 it->updateInsets();
 416
 417         if (!updateFile)
 418                 return;
 419
 420         // show result
 421         if (flag) {
 422                 docstring const msg = bformat(_("%1$d external files are ignored.\n"
 423                         "%2$d embeddable files are embedded.\n"), count_external, count_embedded);
 424                 Alert::information(_("Packing all files"), msg);
 425         } else {
 426                 docstring const msg = bformat(_("%1$d external files are ignored.\n"
 427                         "%2$d embedded files are extracted.\n"), count_external, count_embedded);
 428                 Alert::information(_("Unpacking all files"), msg);
 429         }
 430 }
 431
 432
 433 void EmbeddedFileList::registerFile(EmbeddedFile const & file,
 434         Inset const * inset, Buffer const & buffer)
 435 {
 436         BOOST_ASSERT(!buffer.embedded() || file.enabled());
 437
 438         // try to find this file from the list
 439         std::vector<EmbeddedFile>::iterator it = begin();
 440         std::vector<EmbeddedFile>::iterator it_end = end();
 441         for (; it != it_end; ++it)
 442                 if (it->absFilename() == file.absFilename()) {
 443                         if (it->embedded() != file.embedded()) {
 444                                 Alert::error(_("Wrong embedding status."),
 445                                         bformat(_("File %1$s is included in more than one insets, "
 446                                                 "but with different embedding status. Assuming embedding status."),
 447                                                 from_utf8(it->outputFilename())));
 448                                 it->setEmbed(true);
 449                                 // update the inset with this embedding status.
 450                                 const_cast<Inset*>(inset)->updateEmbeddedFile(*it);
 451                         }
 452                         it->addInset(inset);
 453                         return;
 454                 }
 455         //
 456         file.clearInsets();
 457         push_back(file);
 458         back().addInset(inset);
 459 }
 460
 461
 462 void EmbeddedFileList::validate(Buffer const & buffer)
 463 {
 464         clear();
 465
 466         for (InsetIterator it = inset_iterator_begin(buffer.inset()); it; ++it)
 467                 it->registerEmbeddedFiles(*this);
 468
 469         iterator it = begin();
 470         iterator it_end = end();
 471         for (; it != it_end; ++it) {
 472                 if (buffer.embedded() && it->embedded())
 473                         // An exception will be raised if inzip file does not exist
 474                         it->syncInzipFile(buffer.filePath());
 475                 else
 476                         // inzipName may be OS dependent
 477                         it->setInzipName(it->calcInzipName(buffer.filePath()));
 478         }
 479         for (it = begin(); it != it_end; ++it)
 480                 it->updateInsets();
 481
 482         if (!buffer.embedded())
 483                 return;
 484
 485         // check if extra embedded files exist
 486         vector<string> extra = buffer.params().extraEmbeddedFiles();
 487         vector<string>::iterator e_it = extra.begin();
 488         vector<string>::iterator e_end = extra.end();
 489         for (; e_it != e_end; ++e_it) {
 490                 EmbeddedFile file = EmbeddedFile(*e_it, buffer.filePath());
 491                 // do not update from external file
 492                 file.enable(true, &buffer, false);
 493                 // but we do need to check file existence.
 494                 if (!FileName(file.embeddedFile()).exists())
 495                         throw ExceptionMessage(ErrorException, _("Failed to open file"),
 496                                 bformat(_("Embedded file %1$s does not exist. Did you tamper lyx temporary directory?"),
 497                                         file.displayName()));
 498         }
 499 }
 500
 501
 502 void EmbeddedFileList::update(Buffer const & buffer)
 503 {
 504         clear();
 505
 506         for (InsetIterator it = inset_iterator_begin(buffer.inset()); it; ++it)
 507                 it->registerEmbeddedFiles(*this);
 508
 509         // add extra embedded files
 510         vector<string> extra = buffer.params().extraEmbeddedFiles();
 511         vector<string>::iterator it = extra.begin();
 512         vector<string>::iterator it_end = extra.end();
 513         for (; it != it_end; ++it) {
 514                 EmbeddedFile file = EmbeddedFile(*it, buffer.filePath());
 515                 file.setEmbed(true);
 516                 file.enable(buffer.embedded(), &buffer, false);
 517                 insert(end(), file);
 518         }
 519 }
 520
 521
 522 bool EmbeddedFileList::writeFile(DocFileName const & filename, Buffer const & buffer)
 523 {
 524         // file in the temporary path has the content
 525         string const content = FileName(addName(buffer.temppath(),
 526                 "content.lyx")).toFilesystemEncoding();
 527
 528         vector<pair<string, string> > filenames;
 529         // add content.lyx to filenames
 530         filenames.push_back(make_pair(content, "content.lyx"));
 531         // prepare list of embedded file
 532         update(buffer);
 533         //
 534         iterator it = begin();
 535         iterator it_end = end();
 536         for (; it != it_end; ++it) {
 537                 if (it->embedded()) {
 538                         string file = it->embeddedFile();
 539                         if (!FileName(file).exists())
 540                                 throw ExceptionMessage(ErrorException, _("Failed to write file"),
 541                                         bformat(_("Embedded file %1$s does not exist. Did you tamper lyx temporary directory?"),
 542                                                 it->displayName()));
 543                         filenames.push_back(make_pair(file, it->inzipName()));
 544                         LYXERR(Debug::FILES, "Writing file " << it->outputFilename()
 545                                 << " as " << it->inzipName() << endl);
 546                 }
 547         }
 548         // write a zip file with all these files. Write to a temp file first, to
 549         // avoid messing up the original file in case something goes terribly wrong.
 550         DocFileName zipfile(addName(buffer.temppath(),
 551                 onlyFilename(changeExtension(
 552                         filename.toFilesystemEncoding(), ".zip"))));
 553
 554         ::zipFiles(zipfile.toFilesystemEncoding(), filenames);
 555         // copy file back
 556         if (!zipfile.copyTo(filename)) {
 557                 Alert::error(_("Save failure"),
 558                          bformat(_("Cannot create file %1$s.\n"
 559                                            "Please check whether the directory exists and is writeable."),
 560                                          from_utf8(filename.absFilename())));
 561         }
 562         return true;
 563 }
 564
 565 } // namespace lyx