]> git.lyx.org Git - lyx.git/blobdiff - src/EmbeddedFiles.cpp
even example code should follow the style conventions
[lyx.git] / src / EmbeddedFiles.cpp
index 3eb5476cdc1c0565387fb76a7f69d8194b1318e1..4109dcd74662eba9fb255722449602ede3d5ae5b 100644 (file)
@@ -34,6 +34,8 @@
 #include "support/ExceptionMessage.h"
 #include "support/FileZipListDir.h"
 
+#include <boost/assert.hpp>
+
 #include <sstream>
 #include <fstream>
 #include <utility>
@@ -46,8 +48,7 @@ namespace lyx {
 namespace Alert = frontend::Alert;
 
 EmbeddedFile::EmbeddedFile(string const & file, std::string const & buffer_path)
-       : DocFileName("", false), inzip_name_(""), embedded_(false), inset_list_(),
-       temp_path_("")
+       : DocFileName("", false), embedded_(false), inset_list_()
 {
        set(file, buffer_path);
 }
@@ -128,14 +129,12 @@ void EmbeddedFile::enable(bool flag, Buffer const * buf, bool updateFile)
                temp_path_ = buf->temppath();
                if (!suffixIs(temp_path_, '/'))
                        temp_path_ += '/';
-               if (embedded()) {
-                       if (inzip_name_ != calcInzipName(buf->filePath()))
-                               syncInzipFile(buf->filePath());
-                       if (updateFile)
-                               updateFromExternalFile();
-               }
-       } else {
                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_ = "";
        }
@@ -155,11 +154,10 @@ bool EmbeddedFile::extract() const
        if (!emb.exists()) {
                if (ext.exists())
                        return true;
-               else
-                       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)));
+               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 ...
@@ -170,7 +168,7 @@ bool EmbeddedFile::extract() const
                // 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
@@ -256,6 +254,64 @@ bool EmbeddedFile::updateFromExternalFile() const
 }
 
 
+EmbeddedFile EmbeddedFile::copyTo(Buffer const * buf)
+{
+       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;
+}
+
+
 void EmbeddedFile::updateInsets() const
 {
        vector<Inset const *>::const_iterator it = inset_list_.begin();
@@ -299,8 +355,14 @@ 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 = "LyX.Embedded.Files";
+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";
@@ -334,12 +396,18 @@ void EmbeddedFile::syncInzipFile(std::string const & buffer_path)
        string old_emb_file = temp_path_ + '/' + inzip_name_;
        FileName old_emb(old_emb_file);
 
+       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));
 
-       //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);
        
@@ -398,14 +466,13 @@ void EmbeddedFileList::enable(bool flag, Buffer & buffer, bool updateFile)
                        ++count_external;
        }
        // if operation is successful (no exception is thrown)
-       buffer.markDirty();
        buffer.params().embedded = flag;
 
        // if the operation is successful, update insets
        for (it = begin(); it != it_end; ++it)
                it->updateInsets();
 
-       if (!updateFile)
+       if (!updateFile || (count_external == 0 && count_embedded == 0))
                return;
 
        // show result
@@ -450,6 +517,46 @@ void EmbeddedFileList::registerFile(EmbeddedFile const & file,
 }
 
 
+void EmbeddedFileList::validate(Buffer const & buffer)
+{
+       clear();
+       
+       for (InsetIterator it = inset_iterator_begin(buffer.inset()); it; ++it)
+               it->registerEmbeddedFiles(*this);
+
+       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()));
+       }
+       for (it = begin(); it != it_end; ++it)
+               it->updateInsets();
+       
+       if (!buffer.embedded())
+               return;
+
+       // check if extra embedded files exist
+       vector<string> extra = buffer.params().extraEmbeddedFiles();
+       vector<string>::iterator e_it = extra.begin();
+       vector<string>::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()));
+       }
+}
+
+
 void EmbeddedFileList::update(Buffer const & buffer)
 {
        clear();
@@ -464,7 +571,7 @@ void EmbeddedFileList::update(Buffer const & buffer)
        for (; it != it_end; ++it) {
                EmbeddedFile file = EmbeddedFile(*it, buffer.filePath());
                file.setEmbed(true);
-               file.enable(buffer.embedded(), &buffer, true);
+               file.enable(buffer.embedded(), &buffer, false);
                insert(end(), file);
        }
 }
@@ -506,10 +613,9 @@ bool EmbeddedFileList::writeFile(DocFileName const & filename, Buffer const & bu
        // copy file back
        if (!zipfile.copyTo(filename)) {
                Alert::error(_("Save failure"),
-                                bformat(_("Cannot create file %1$s.\n"
+                        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());
        }
        return true;
 }