#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"
string const to_;
};
-} // namespace anon
+} // namespace
Converter::Converter(string const & f, string const & t,
"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")
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." + theFormats().extension(to_);
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")
}
-bool Converters::checkAuth(Converter const & conv, string const & doc_fname)
+string Converters::getHyperrefDriver(Graph::EdgePath const & path)
+{
+ 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)
{
- 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 + _(
"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 ¬ 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);
- 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 ¬ 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 ¬ run"), _("&Run"));
+ choice = frontend::Alert::prompt(security_title,
+ 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()) {
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<string, string> 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));
"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
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().bibtexCommand();
- runparams.index_command = (buffer->params().index_command == "default") ?
- string() : buffer->params().index_command;
- runparams.document_language = buffer->params().language->babel();
- runparams.only_childbibs = !buffer->params().useBiblatex()
- && !buffer->params().useBibtopic()
- && buffer->params().multibib == "child";
+ (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
"tmpfile.out"));
}
- if (!checkAuth(conv, buffer ? buffer->absFileName() : string()))
- 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<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 FAILURE;
if (conv.latex()) {
// We are not importing, we have a buffer
- LATTEST(buffer);
+ LASSERT(buffer, return FAILURE);
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);
- 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);
+ LASSERT(buffer, return FAILURE);
string command;
switch (runparams.flavor) {
case OutputParams::DVILUATEX:
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;
}
}
// 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))
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 (!scanLog(*buffer, command, makeAbsPath(logfile, path), errorList))
- return false;
+ 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 (buffer && !scanLog(*buffer, command, makeAbsPath(logfile, path), errorList))
+ 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."));
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.
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;
}
}
}
-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);
string const name = buffer.latexName();
LaTeX latex(command, runparams, FileName(makeAbsPath(name)),
buffer.filePath(), buffer.layoutPos(),
- buffer.lastPreviewError());
+ buffer.isClone(), buffer.freshStartRequired());
TeXErrors terr;
// The connection closes itself at the end of the scope when latex is
// destroyed. One cannot close (and destroy) buffer while the converter is
});
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
_("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;
}
projects / lyx.git / blobdiff