X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FConverter.cpp;h=d5686f666da5a6a2152b7188333d0137ad2e97f8;hb=9176e60b7bcab3e355521a86ddb4c2778cd9b29e;hp=112175bff95a183addc320987c542c812b814bb9;hpb=309209e3197beea1a5c912bebfba1f533daa3ad2;p=lyx.git diff --git a/src/Converter.cpp b/src/Converter.cpp index 112175bff9..d5686f666d 100644 --- a/src/Converter.cpp +++ b/src/Converter.cpp @@ -19,13 +19,18 @@ #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" @@ -94,7 +99,7 @@ private: string const to_; }; -} // namespace anon +} // namespace Converter::Converter(string const & f, string const & t, @@ -118,9 +123,11 @@ void Converter::readFlags() "latex" : flag_value; } else if (flag_name == "xml") xml_ = true; - else if (flag_name == "needaux") + else if (flag_name == "needaux") { need_aux_ = true; - else if (flag_name == "resultdir") + latex_flavor_ = flag_value.empty() ? + "latex" : flag_value; + } else if (flag_name == "resultdir") result_dir_ = (flag_value.empty()) ? token_base : flag_value; else if (flag_name == "resultfile") @@ -131,9 +138,11 @@ void Converter::readFlags() nice_ = true; else if (flag_name == "needauth") need_auth_ = true; + else if (flag_name == "hyperref-driver") + href_driver_ = flag_value; } if (!result_dir_.empty() && result_file_.empty()) - result_file_ = "index." + formats.extension(to_); + result_file_ = "index." + theFormats().extension(to_); //if (!contains(command, token_from)) // latex = true; } @@ -167,8 +176,8 @@ int Converters::getNumber(string const & from, string const & to) const void Converters::add(string const & from, string const & to, string const & command, string const & flags) { - formats.add(from); - formats.add(to); + theFormats().add(from); + theFormats().add(to); ConverterList::iterator it = find_if(converterlist_.begin(), converterlist_.end(), ConverterEqual(from , to)); @@ -258,7 +267,7 @@ OutputParams::FLAVOR Converters::getFlavor(Graph::EdgePath const & path, for (Graph::EdgePath::const_iterator cit = path.begin(); cit != path.end(); ++cit) { Converter const & conv = converterlist_[*cit]; - if (conv.latex()) { + if (conv.latex() || conv.need_aux()) { if (conv.latex_flavor() == "latex") return OutputParams::LATEX; if (conv.latex_flavor() == "xelatex") @@ -278,61 +287,133 @@ OutputParams::FLAVOR Converters::getFlavor(Graph::EdgePath const & path, } -bool Converters::checkAuth(Converter const & conv, string const & doc_fname) +string Converters::getHyperrefDriver(Graph::EdgePath const & path) { - if (!conv.need_auth()) + for (Graph::EdgePath::const_iterator cit = path.begin(); + cit != path.end(); ++cit) { + Converter const & conv = converterlist_[*cit]; + if (!conv.hyperref_driver().empty()) + return conv.hyperref_driver(); + } + return string(); +} + + +bool Converters::checkAuth(Converter const & conv, string const & doc_fname, + bool use_shell_escape) +{ + 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(_("

The following LaTeX backend has been " + "configured to allow execution of external programs " + "for any document:

" + "

%1$s

" + "

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.

"), + 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; - if (lyxrc.use_converter_needauth_forbidden) { - frontend::Alert::warning( - _("Potentially harmful external converters disabled"), - _("Requested operation needs use of a potentially harmful external converter program, " - "which is forbidden by default.\nThese converters are tagged by the 'needauth' option. " - "In order to unlock execution of these converters,\nplease, go to " - "Preferences->File Handling->Converters and uncheck " - "Security->Forbid needauth converters."), true); + 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(_("

The following LaTeX backend has been requested " + "to allow execution of external programs:

" + "

%1$s

" + "

The external programs can execute arbitrary commands on " + "your system, including dangerous ones, if instructed to do " + "so by a maliciously crafted LyX document.

"), + from_utf8(command)) + : bformat(_("

The requested operation requires the use of a " + "converter from %2$s to %3$s:

" + "

%1$s

" + "

This external program can execute arbitrary commands on " + "your system, including dangerous ones, if instructed to do " + "so by a maliciously crafted LyX document.

"), + 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 + _( + "

Your current preference settings forbid its execution.

" + "

(To change this setting, go to Preferences ▹ File " + "Handling ▹ Converters and uncheck Security ▹ " + "Forbid needauth converters.)"), false); return false; } - if (!lyxrc.use_converter_needauth) + if (!lyxrc.use_converter_needauth && !use_shell_escape) return true; - static const docstring security_title = _("Launch of external converter needs user authorization"); - static const char security_warning[] = "LyX is about to run converter '%1$s' which is launching an external program " - "that normally acts as a picture/format converter. However, this external program is known to be able to " - "execute arbitrary actions on the system on behalf of the user, including dangerous ones such as deleting " - "files, if instructed to do so by a maliciously crafted .lyx document.\n\nWould you like to run the converter?\n\n" - "ANSWER RUN ONLY IF YOU TRUST THE ORIGIN/SENDER OF THE LYX DOCUMENT!"; + docstring const security_title = use_shell_escape + ? _("A LaTeX backend requires your authorization") + : _("An external converter requires your authorization"); int choice; + docstring const security_warning2 = security_warning + (use_shell_escape + ? _("

Should LaTeX backends be allowed to run external " + "programs?

Allow them only if you trust the " + "origin/sender of the LyX document!

") + : _("

Would you like to run this converter?

" + "

Only run if you trust the origin/sender of the LyX " + "document!

")); + docstring const no = use_shell_escape + ? _("Do ¬ allow") : _("Do ¬ 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); - if (auth_files_.find(doc_fname) == auth_files_.end()) { + bool authorized = use_shell_escape + ? theSession().shellescapeFiles().findAuth(doc_fname) + : theSession().authFiles().find(doc_fname); + if (!authorized) { choice = frontend::Alert::prompt(security_title, - bformat(_(security_warning), from_utf8(conv.command())), - 0, 0, _("Do &NOT run"), _("&Run"), _("&Always run for this document")); - if (choice == 2) - auth_files_.insert(doc_fname); + 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, - bformat(_(security_warning), from_utf8(conv.command())), - 0, 0, _("Do &NOT run"), _("&Run")); + security_warning2, + 0, 0, no, yes); } return choice != 0; } -bool Converters::convert(Buffer const * buffer, +Converters::RetVal Converters::convert(Buffer const * buffer, FileName const & from_file, FileName const & to_file, FileName const & orig_from, string const & from_format, string const & to_format, ErrorList & errorList, int conversionflags) { if (from_format == to_format) - return move(from_format, from_file, to_file, false); + return move(from_format, from_file, to_file, false) ? + SUCCESS : FAILURE; if ((conversionflags & try_cache) && ConverterCache::get().inCache(orig_from, to_format)) - return ConverterCache::get().copy(orig_from, to_format, to_file); + return ConverterCache::get().copy(orig_from, to_format, to_file) ? + SUCCESS : FAILURE; Graph::EdgePath edgepath = getPath(from_format, to_format); if (edgepath.empty()) { @@ -341,8 +422,8 @@ bool Converters::convert(Buffer const * buffer, // default one from ImageMagic. string const from_ext = from_format.empty() ? getExtension(from_file.absFileName()) : - formats.extension(from_format); - string const to_ext = formats.extension(to_format); + theFormats().extension(from_format); + string const to_ext = theFormats().extension(to_format); string const command = os::python() + ' ' + quoteName(libFileSearch("scripts", "convertDefault.py").toFilesystemEncoding()) + @@ -353,21 +434,31 @@ 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 following converter was killed by the user.\n %1$s\n"), + from_utf8(command))); + return KILLED; + } if (to_file.isReadableFile()) { if (conversionflags & try_cache) ConverterCache::get().add(orig_from, to_format, to_file); - return true; + return SUCCESS; } } // only warn once per session and per file type static std::map warned; if (warned.find(from_format) != warned.end() && warned.find(from_format)->second == to_format) { - return false; + return FAILURE; } warned.insert(make_pair(from_format, to_format)); @@ -376,7 +467,7 @@ bool Converters::convert(Buffer const * buffer, "format files to %2$s.\n" "Define a converter in the preferences."), from_ascii(from_format), from_ascii(to_format))); - return false; + return FAILURE; } // buffer is only invalid for importing, and then runparams is not @@ -385,15 +476,22 @@ bool Converters::convert(Buffer const * buffer, runparams.flavor = getFlavor(edgepath, buffer); if (buffer) { + BufferParams const & bp = buffer->params(); runparams.use_japanese = - buffer->params().bufferFormat() == "latex" - && buffer->params().encoding().package() == Encoding::japanese; - runparams.use_indices = buffer->params().use_indices; - runparams.bibtex_command = (buffer->params().bibtex_command == "default") ? - string() : buffer->params().bibtex_command; - runparams.index_command = (buffer->params().index_command == "default") ? - string() : buffer->params().index_command; - runparams.document_language = buffer->params().language->babel(); + (bp.bufferFormat() == "latex" + || suffixIs(bp.bufferFormat(), "-ja")) + && bp.encoding().package() == Encoding::japanese; + runparams.use_indices = bp.use_indices; + runparams.bibtex_command = bp.bibtexCommand(); + runparams.index_command = (bp.index_command == "default") ? + string() : bp.index_command; + runparams.document_language = bp.language->babel(); + runparams.xindy_language = bp.language->xindy(); + // Some macros rely on font encoding + runparams.main_fontenc = bp.main_font_encoding(); + runparams.only_childbibs = !bp.useBiblatex() + && !bp.useBibtopic() + && bp.multibib == "child"; } // Some converters (e.g. lilypond) can only output files to the @@ -448,20 +546,65 @@ bool Converters::convert(Buffer const * buffer, "tmpfile.out")); } - if (!checkAuth(conv, buffer->absFileName())) - return false; + 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 + (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 FAILURE; 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 ? - buffer->params().encoding().latexName() : string()); + 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); - if (!runLaTeX(*buffer, command, runparams, errorList)) - return false; + // FIXME KILLED + // Check changed return value here. + RetVal const retval = runLaTeX(*buffer, command, runparams, errorList); + if (retval != SUCCESS) + return retval; } 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: @@ -484,9 +627,11 @@ bool Converters::convert(Buffer const * buffer, LYXERR(Debug::FILES, "Running " << command << " to update aux file"); - if (!runLaTeX(*buffer, command, - runparams, errorList)) - return false; + // FIXME KILLED + // Check changed return value here. + RetVal const retval = runLaTeX(*buffer, command, runparams, errorList); + if (retval != SUCCESS) + return retval; } } @@ -532,12 +677,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 following converter was killed by the user.\n %1$s\n"), + from_utf8(command))); + return KILLED; + } + if (!real_outfile.empty()) { Mover const & mover = getMover(conv.to()); if (!mover.rename(outfile, real_outfile)) @@ -555,16 +711,35 @@ 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 following converter was killed by the user.\n %1$s\n"), + from_utf8(command))); + return KILLED; + } if (!scanLog(*buffer, command, makeAbsPath(logfile, path), errorList)) - return false; + return FAILURE; } } if (res) { + if (res == Systemcall::KILLED) { + Alert::information(_("Process Killed"), + bformat(_("The conversion process was killed while running:\n%1$s"), + wrapParas(from_utf8(command)))); + return KILLED; + } + if (res == Systemcall::TIMEOUT) { + Alert::information(_("Process Timed Out"), + bformat(_("The conversion process:\n%1$s\ntimed out before completing."), + wrapParas(from_utf8(command)))); + return KILLED; + } if (conv.to() == "program") { Alert::error(_("Build errors"), _("There were errors during the build process.")); @@ -575,14 +750,14 @@ bool Converters::convert(Buffer const * buffer, bformat(_("An error occurred while running:\n%1$s"), wrapParas(from_utf8(command)))); } - return false; + return FAILURE; } } } Converter const & conv = converterlist_[edgepath.back()]; if (conv.To()->dummy()) - return true; + return SUCCESS; if (!conv.result_dir().empty()) { // The converter has put the file(s) in a directory. @@ -597,14 +772,14 @@ bool Converters::convert(Buffer const * buffer, Alert::error(_("Cannot convert file"), bformat(_("Could not move a temporary directory from %1$s to %2$s."), from_utf8(from), from_utf8(to))); - return false; + return FAILURE; } } - return true; + return SUCCESS; } else { if (conversionflags & try_cache) ConverterCache::get().add(orig_from, to_format, outfile); - return move(conv.to(), outfile, to_file, conv.latex()); + return move(conv.to(), outfile, to_file, conv.latex()) ? SUCCESS : FAILURE; } } @@ -678,21 +853,7 @@ 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_; -}; - -} - - -bool Converters::runLaTeX(Buffer const & buffer, string const & command, +Converters::RetVal Converters::runLaTeX(Buffer const & buffer, string const & command, OutputParams const & runparams, ErrorList & errorList) { buffer.setBusy(true); @@ -702,15 +863,33 @@ 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.freshStartRequired()); 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 KILLED; + } + if (result & LaTeX::ERRORS) buffer.bufferErrors(terr, errorList); + if ((result & LaTeX::UNDEF_CIT) || (result & LaTeX::UNDEF_REF)) { + buffer.bufferRefs(terr, errorList); + if (errorList.empty()) + errorList.push_back(ErrorItem(_("Undefined reference"), + _("Undefined reference or citation was found during the build, please check the Log."), + &buffer)); + } + if (!errorList.empty()) { // We will show the LaTeX Errors GUI later which contains // specific error messages so it would be repetitive to give @@ -734,15 +913,16 @@ bool Converters::runLaTeX(Buffer const & buffer, string const & command, _("No output file was generated.")); } - buffer.setBusy(false); int const ERROR_MASK = LaTeX::NO_LOGFILE | LaTeX::ERRORS | + LaTeX::UNDEF_CIT | + LaTeX::UNDEF_REF | LaTeX::NO_OUTPUT; - return (result & ERROR_MASK) == 0; + return (result & ERROR_MASK) == 0 ? SUCCESS : FAILURE; } @@ -750,15 +930,15 @@ bool Converters::runLaTeX(Buffer const & buffer, string const & command, void Converters::buildGraph() { // clear graph's data structures - G_.init(formats.size()); + G_.init(theFormats().size()); // each of the converters knows how to convert one format to another // so, for each of them, we create an arrow on the graph, going from // the one to the other ConverterList::iterator it = converterlist_.begin(); ConverterList::iterator const end = converterlist_.end(); for (; it != end ; ++it) { - int const from = formats.getNumber(it->from()); - int const to = formats.getNumber(it->to()); + int const from = theFormats().getNumber(it->from()); + int const to = theFormats().getNumber(it->to()); LASSERT(from >= 0, continue); LASSERT(to >= 0, continue); G_.addEdge(from, to); @@ -774,24 +954,24 @@ FormatList const Converters::intToFormat(vector const & input) vector::const_iterator const end = input.end(); FormatList::iterator rit = result.begin(); for ( ; it != end; ++it, ++rit) { - *rit = &formats.get(*it); + *rit = &theFormats().get(*it); } return result; } -FormatList const Converters::getReachableTo(string const & target, +FormatList const Converters::getReachableTo(string const & target, bool const clear_visited) { vector const & reachablesto = - G_.getReachableTo(formats.getNumber(target), clear_visited); + G_.getReachableTo(theFormats().getNumber(target), clear_visited); return intToFormat(reachablesto); } -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 const & excludes) { set excluded_numbers; @@ -799,10 +979,10 @@ FormatList const Converters::getReachable(string const & from, set::const_iterator sit = excludes.begin(); set::const_iterator const end = excludes.end(); for (; sit != end; ++sit) - excluded_numbers.insert(formats.getNumber(*sit)); + excluded_numbers.insert(theFormats().getNumber(*sit)); vector const & reachables = - G_.getReachable(formats.getNumber(from), + G_.getReachable(theFormats().getNumber(from), only_viewable, clear_visited, excluded_numbers); @@ -813,15 +993,15 @@ FormatList const Converters::getReachable(string const & from, bool Converters::isReachable(string const & from, string const & to) { - return G_.isReachable(formats.getNumber(from), - formats.getNumber(to)); + return G_.isReachable(theFormats().getNumber(from), + theFormats().getNumber(to)); } Graph::EdgePath Converters::getPath(string const & from, string const & to) { - return G_.getPath(formats.getNumber(from), - formats.getNumber(to)); + return G_.getPath(theFormats().getNumber(from), + theFormats().getNumber(to)); }