]> git.lyx.org Git - lyx.git/blobdiff - src/Converter.cpp
Russian layouttranslations reviewed by Yuriy, Dec 13 2017.
[lyx.git] / src / Converter.cpp
index f58a188a606a1833db2d09debb6b1f34c53d0d86..d433f83c98d8581c28d45af308b0e26e699985cb 100644 (file)
 #include "Encoding.h"
 #include "ErrorList.h"
 #include "Format.h"
+#include "InsetList.h"
 #include "Language.h"
 #include "LaTeX.h"
 #include "LyXRC.h"
 #include "Mover.h"
+#include "ParagraphList.h"
 #include "Session.h"
 
 #include "frontends/alert.h"
 
+#include "insets/InsetInclude.h"
+
 #include "support/debug.h"
 #include "support/FileNameList.h"
 #include "support/filetools.h"
@@ -95,7 +99,7 @@ private:
        string const to_;
 };
 
-} // namespace anon
+} // namespace
 
 
 Converter::Converter(string const & f, string const & t,
@@ -279,20 +283,52 @@ OutputParams::FLAVOR Converters::getFlavor(Graph::EdgePath const & path,
 }
 
 
-bool Converters::checkAuth(Converter const & conv, string const & doc_fname)
+bool Converters::checkAuth(Converter const & conv, string const & doc_fname,
+                          bool use_shell_escape)
 {
-       if (!conv.need_auth())
+       string conv_command = conv.command();
+       bool const has_shell_escape = contains(conv_command, "-shell-escape")
+                               || contains(conv_command, "-enable-write18");
+       if (conv.latex() && has_shell_escape && !use_shell_escape) {
+               docstring const shellescape_warning =
+                     bformat(_("<p>The following LaTeX backend has been "
+                       "configured to allow execution of external programs "
+                       "for any document:</p>"
+                       "<center><p><tt>%1$s</tt></p></center>"
+                       "<p>This is a dangerous configuration. Please, "
+                       "consider using the support offered by LyX for "
+                       "allowing this privilege only to documents that "
+                       "actually need it, instead.</p>"),
+                       from_utf8(conv_command));
+               frontend::Alert::error(_("Security Warning"),
+                                       shellescape_warning , false);
+       } else if (!conv.latex())
+               use_shell_escape = false;
+       if (!conv.need_auth() && !use_shell_escape)
                return true;
-       const docstring security_warning = bformat(
-             _("<p>The requested operation requires the use of a converter from "
-               "%2$s to %3$s:</p>"
+       size_t const token_pos = conv_command.find("$$");
+       bool const has_token = token_pos != string::npos;
+       string const command = use_shell_escape && !has_shell_escape
+               ? (has_token ? conv_command.insert(token_pos, "-shell-escape ")
+                            : conv_command.append(" -shell-escape"))
+               : conv_command;
+       docstring const security_warning = (use_shell_escape
+           ? bformat(_("<p>The following LaTeX backend has been requested "
+               "to allow execution of external programs:</p>"
+               "<center><p><tt>%1$s</tt></p></center>"
+               "<p>The external programs can execute arbitrary commands on "
+               "your system, including dangerous ones, if instructed to do "
+               "so by a maliciously crafted LyX document.</p>"),
+             from_utf8(command))
+           : bformat(_("<p>The requested operation requires the use of a "
+               "converter from %2$s to %3$s:</p>"
                "<blockquote><p><tt>%1$s</tt></p></blockquote>"
-               "<p>This external program can execute arbitrary commands on your "
-               "system, including dangerous ones, if instructed to do so by a "
-               "maliciously crafted .lyx document.</p>"),
-             from_utf8(conv.command()), from_utf8(conv.from()),
-             from_utf8(conv.to()));
-       if (lyxrc.use_converter_needauth_forbidden) {
+               "<p>This external program can execute arbitrary commands on "
+               "your system, including dangerous ones, if instructed to do "
+               "so by a maliciously crafted LyX document.</p>"),
+             from_utf8(command), from_utf8(conv.from()),
+             from_utf8(conv.to())));
+       if (lyxrc.use_converter_needauth_forbidden && !use_shell_escape) {
                frontend::Alert::error(
                    _("An external converter is disabled for security reasons"),
                    security_warning + _(
@@ -302,29 +338,47 @@ bool Converters::checkAuth(Converter const & conv, string const & doc_fname)
                    "Forbid needauth converters</i>.)"), false);
                return false;
        }
-       if (!lyxrc.use_converter_needauth)
+       if (!lyxrc.use_converter_needauth && !use_shell_escape)
                return true;
-       static const docstring security_title =
-               _("An external converter requires your authorization");
+       docstring const security_title = use_shell_escape
+               ? _("A LaTeX backend requires your authorization")
+               : _("An external converter requires your authorization");
        int choice;
-       const docstring security_warning2 = security_warning +
-               _("<p>Would you like to run this converter?</p>"
-                 "<p><b>Only run if you trust the origin/sender of the LyX "
-                 "document!</b></p>");
+       docstring const security_warning2 = security_warning + (use_shell_escape
+               ? _("<p>Should LaTeX backends be allowed to run external "
+                   "programs?</p><p><b>Allow them only if you trust the "
+                   "origin/sender of the LyX document!</b></p>")
+               : _("<p>Would you like to run this converter?</p>"
+                   "<p><b>Only run if you trust the origin/sender of the LyX "
+                   "document!</b></p>"));
+       docstring const no = use_shell_escape
+                               ? _("Do &not allow") : _("Do &not run");
+       docstring const yes = use_shell_escape ? _("A&llow") : _("&Run");
+       docstring const always = use_shell_escape
+                                       ? _("&Always allow for this document")
+                                       : _("&Always run for this document");
        if (!doc_fname.empty()) {
                LYXERR(Debug::FILES, "looking up: " << doc_fname);
-               std::set<std::string> & auth_files = theSession().authFiles().authFiles();
-               if (auth_files.find(doc_fname) == auth_files.end()) {
-                       choice = frontend::Alert::prompt(security_title, security_warning2,
-                               0, 0, _("Do &not run"), _("&Run"), _("&Always run for this document"));
-                       if (choice == 2)
-                               auth_files.insert(doc_fname);
+               bool authorized = use_shell_escape
+                       ? theSession().shellescapeFiles().findAuth(doc_fname)
+                       : theSession().authFiles().find(doc_fname);
+               if (!authorized) {
+                       choice = frontend::Alert::prompt(security_title,
+                                                        security_warning2,
+                                                        0, 0, no, yes, always);
+                       if (choice == 2) {
+                               if (use_shell_escape)
+                                       theSession().shellescapeFiles().insert(doc_fname, true);
+                               else
+                                       theSession().authFiles().insert(doc_fname);
+                       }
                } else {
                        choice = 1;
                }
        } else {
-               choice = frontend::Alert::prompt(security_title, security_warning2,
-                       0, 0, _("Do &not run"), _("&Run"));
+               choice = frontend::Alert::prompt(security_title,
+                                                security_warning2,
+                                                0, 0, no, yes);
        }
        return choice != 0;
 }
@@ -362,9 +416,19 @@ bool Converters::convert(Buffer const * buffer,
                        LYXERR(Debug::FILES, "No converter defined! "
                                   "I use convertDefault.py:\n\t" << command);
                        Systemcall one;
-                       one.startscript(Systemcall::Wait, command,
-                                       buffer ? buffer->filePath() : string(),
-                                       buffer ? buffer->layoutPos() : string());
+                       Systemcall::Starttype starttype =
+                               (buffer && buffer->isClone()) ?
+                                       Systemcall::WaitLoop : Systemcall::Wait;
+                       int const exitval = one.startscript(starttype, command,
+                                       buffer ? buffer->filePath() : string(),
+                                       buffer ? buffer->layoutPos() : string());
+                       if (exitval == Systemcall::KILLED) {
+                               frontend::Alert::warning(
+                                       _("Converter killed"),
+                                       bformat(_("The running converter\n %1$s\nwas killed by the user."), 
+                                               from_utf8(command)));
+                               return false;
+                       }
                        if (to_file.isReadableFile()) {
                                if (conversionflags & try_cache)
                                        ConverterCache::get().add(orig_from,
@@ -395,7 +459,8 @@ bool Converters::convert(Buffer const * buffer,
 
        if (buffer) {
                runparams.use_japanese =
-                       buffer->params().bufferFormat() == "latex"
+                       (buffer->params().bufferFormat() == "latex"
+                        || suffixIs(buffer->params().bufferFormat(), "-ja"))
                        && buffer->params().encoding().package() == Encoding::japanese;
                runparams.use_indices = buffer->params().use_indices;
                runparams.bibtex_command = buffer->params().bibtexCommand();
@@ -459,21 +524,64 @@ bool Converters::convert(Buffer const * buffer,
                                                   "tmpfile.out"));
                }
 
-               if (!checkAuth(conv, buffer ? buffer->absFileName() : string()))
+               if (buffer && buffer->params().use_minted
+                   && lyxrc.pygmentize_command.empty() && conv.latex()) {
+                       bool dowarn = false;
+                       // Warn only if listings insets are actually used
+                       for (Paragraph const & par : buffer->paragraphs()) {
+                               InsetList const & insets = par.insetList();
+                               pos_type lstpos = insets.find(LISTINGS_CODE, 0);
+                               pos_type incpos = insets.find(INCLUDE_CODE, 0);
+                               if (incpos >= 0) {
+                                       InsetInclude const * include =
+                                               static_cast<InsetInclude *>
+                                                       (insets.get(incpos));
+                                       if (include->params().getCmdName() !=
+                                                               "inputminted") {
+                                               incpos = -1;
+                                       }
+                               }
+                               if (lstpos >= 0 || incpos >= 0) {
+                                       dowarn = true;
+                                       break;
+                               }
+                       }
+                       if (dowarn) {
+                               Alert::warning(_("Pygments driver command not found!"),
+                                   _("The driver command necessary to use the minted package\n"
+                                     "(pygmentize) has not been found. Make sure you have\n"
+                                     "the python-pygments module installed or, if the driver\n"
+                                     "is named differently, to add the following line to the\n"
+                                     "document preamble:\n\n"
+                                     "\\AtBeginDocument{\\renewcommand{\\MintedPygmentize}{driver}}\n\n"
+                                     "where 'driver' is name of the driver command."));
+                       }
+               }
+
+               if (!checkAuth(conv, buffer ? buffer->absFileName() : string(),
+                              buffer && buffer->params().shell_escape))
                        return false;
 
                if (conv.latex()) {
+                       // We are not importing, we have a buffer
                        LATTEST(buffer);
                        run_latex = true;
                        string command = conv.command();
                        command = subst(command, token_from, "");
                        command = subst(command, token_latex_encoding,
                                        buffer->params().encoding().latexName());
+                       if (buffer->params().shell_escape
+                           && !contains(command, "-shell-escape"))
+                               command += " -shell-escape ";
                        LYXERR(Debug::FILES, "Running " << command);
+                       // FIXME KILLED
+                       // Check changed return value here.
                        if (!runLaTeX(*buffer, command, runparams, errorList))
                                return false;
                } else {
                        if (conv.need_aux() && !run_latex) {
+                               // We are not importing, we have a buffer
+                               LATTEST(buffer);
                                string command;
                                switch (runparams.flavor) {
                                case OutputParams::DVILUATEX:
@@ -496,6 +604,8 @@ bool Converters::convert(Buffer const * buffer,
                                        LYXERR(Debug::FILES, "Running "
                                                << command
                                                << " to update aux file");
+                                       // FIXME KILLED
+                                       // Check changed return value here.
                                        if (!runLaTeX(*buffer, command,
                                                      runparams, errorList))
                                                return false;
@@ -544,12 +654,23 @@ bool Converters::convert(Buffer const * buffer,
                                // We're not waiting for the result, so we can't do anything
                                // else here.
                        } else {
-                               res = one.startscript(Systemcall::Wait,
+                               Systemcall::Starttype starttype =
+                                               (buffer && buffer->isClone()) ?
+                                                       Systemcall::WaitLoop : Systemcall::Wait;
+                               res = one.startscript(starttype,
                                                to_filesystem8bit(from_utf8(command)),
                                                buffer ? buffer->filePath()
                                                       : string(),
                                                buffer ? buffer->layoutPos()
                                                       : string());
+                               if (res == Systemcall::KILLED) {
+                                       frontend::Alert::warning(
+                                               _("Converter killed"),
+                                               bformat(_("The running converter\n %1$s\nwas killed by the user."), 
+                                                       from_utf8(command)));
+                                       return false;
+                               }
+                               
                                if (!real_outfile.empty()) {
                                        Mover const & mover = getMover(conv.to());
                                        if (!mover.rename(outfile, real_outfile))
@@ -567,17 +688,32 @@ bool Converters::convert(Buffer const * buffer,
                                        string const command2 = conv.parselog() +
                                                " < " + quoteName(infile2 + ".out") +
                                                " > " + quoteName(logfile);
-                                       one.startscript(Systemcall::Wait,
+                                       res = one.startscript(starttype,
                                                to_filesystem8bit(from_utf8(command2)),
                                                buffer->filePath(),
                                                buffer->layoutPos());
+                                       if (res == Systemcall::KILLED) {
+                                               frontend::Alert::warning(
+                                                       _("Converter killed"),
+                                                       bformat(_("The running converter\n %1$s\nwas killed by the user."), 
+                                                               from_utf8(command)));
+                                               return false;
+                                       }
                                        if (!scanLog(*buffer, command, makeAbsPath(logfile, path), errorList))
                                                return false;
                                }
                        }
 
                        if (res) {
-                               if (conv.to() == "program") {
+                               if (res == Systemcall::KILLED) {
+                                       Alert::information(_("Process Killed"),
+                                               bformat(_("The conversion process was killed while running:\n%1$s"),
+                                                       wrapParas(from_utf8(command))));
+                               } else if (res == Systemcall::TIMEOUT) {
+                                       Alert::information(_("Process Timed Out"),
+                                               bformat(_("The conversion process:\n%1$s\ntimed out before completing."),
+                                                       wrapParas(from_utf8(command))));
+                               } else if (conv.to() == "program") {
                                        Alert::error(_("Build errors"),
                                                _("There were errors during the build process."));
                                } else {
@@ -690,20 +826,8 @@ bool Converters::scanLog(Buffer const & buffer, string const & /*command*/,
 }
 
 
-namespace {
-
-class ShowMessage
-       : public boost::signals2::trackable {
-public:
-       ShowMessage(Buffer const & b) : buffer_(b) {}
-       void operator()(docstring const & msg) const { buffer_.message(msg); }
-private:
-       Buffer const & buffer_;
-};
-
-}
-
-
+// FIXME KILL
+// Probably need to return an INT here
 bool Converters::runLaTeX(Buffer const & buffer, string const & command,
                          OutputParams const & runparams, ErrorList & errorList)
 {
@@ -714,12 +838,22 @@ bool Converters::runLaTeX(Buffer const & buffer, string const & command,
        string const name = buffer.latexName();
        LaTeX latex(command, runparams, FileName(makeAbsPath(name)),
                    buffer.filePath(), buffer.layoutPos(),
-                   buffer.lastPreviewError());
+                   buffer.isClone(), buffer.lastPreviewError());
        TeXErrors terr;
-       ShowMessage show(buffer);
-       latex.message.connect(show);
+       // The connection closes itself at the end of the scope when latex is
+       // destroyed. One cannot close (and destroy) buffer while the converter is
+       // running.
+       latex.message.connect([&buffer](docstring const & msg){
+                       buffer.message(msg);
+               });
        int const result = latex.run(terr);
 
+       if (result == Systemcall::KILLED) {
+               Alert::error(_("Export canceled"),
+                       _("The export process was terminated by the user."));
+               return result;
+       }
+
        if (result & LaTeX::ERRORS)
                buffer.bufferErrors(terr, errorList);
 
@@ -792,7 +926,7 @@ FormatList const Converters::intToFormat(vector<int> const & input)
 }
 
 
-FormatList const Converters::getReachableTo(string const & target, 
+FormatList const Converters::getReachableTo(string const & target,
                bool const clear_visited)
 {
        vector<int> const & reachablesto =
@@ -802,8 +936,8 @@ FormatList const Converters::getReachableTo(string const & target,
 }
 
 
-FormatList const Converters::getReachable(string const & from, 
-               bool const only_viewable, bool const clear_visited, 
+FormatList const Converters::getReachable(string const & from,
+               bool const only_viewable, bool const clear_visited,
                set<string> const & excludes)
 {
        set<int> excluded_numbers;