src/Converter.cpp

   1 /**
   2  * \file Converter.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Dekel Tsur
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "Converter.h"
  14
  15 #include "Buffer.h"
  16 #include "buffer_funcs.h"
  17 #include "BufferParams.h"
  18 #include "ConverterCache.h"
  19 #include "Encoding.h"
  20 #include "ErrorList.h"
  21 #include "Format.h"
  22 #include "InsetList.h"
  23 #include "Language.h"
  24 #include "LaTeX.h"
  25 #include "LyXRC.h"
  26 #include "Mover.h"
  27 #include "ParagraphList.h"
  28 #include "Session.h"
  29
  30 #include "frontends/alert.h"
  31
  32 #include "insets/InsetInclude.h"
  33
  34 #include "support/debug.h"
  35 #include "support/FileNameList.h"
  36 #include "support/filetools.h"
  37 #include "support/gettext.h"
  38 #include "support/lassert.h"
  39 #include "support/lstrings.h"
  40 #include "support/os.h"
  41 #include "support/Package.h"
  42 #include "support/PathChanger.h"
  43 #include "support/Systemcall.h"
  44
  45 using namespace std;
  46 using namespace lyx::support;
  47
  48 namespace lyx {
  49
  50 namespace Alert = lyx::frontend::Alert;
  51
  52
  53 namespace {
  54
  55 string const token_from("$$i");
  56 string const token_base("$$b");
  57 string const token_to("$$o");
  58 string const token_path("$$p");
  59 string const token_orig_path("$$r");
  60 string const token_orig_from("$$f");
  61 string const token_encoding("$$e");
  62 string const token_latex_encoding("$$E");
  63
  64
  65 string const add_options(string const & command, string const & options)
  66 {
  67         string head;
  68         string const tail = split(command, head, ' ');
  69         return head + ' ' + options + ' ' + tail;
  70 }
  71
  72
  73 string const dvipdfm_options(BufferParams const & bp)
  74 {
  75         string result;
  76
  77         if (bp.papersize != PAPER_CUSTOM) {
  78                 string const paper_size = bp.paperSizeName(BufferParams::DVIPDFM);
  79                 if (!paper_size.empty())
  80                         result = "-p "+ paper_size;
  81
  82                 if (bp.orientation == ORIENTATION_LANDSCAPE)
  83                         result += " -l";
  84         }
  85
  86         return result;
  87 }
  88
  89
  90 class ConverterEqual {
  91 public:
  92         ConverterEqual(string const & from, string const & to)
  93                 : from_(from), to_(to) {}
  94         bool operator()(Converter const & c) const {
  95                 return c.from() == from_ && c.to() == to_;
  96         }
  97 private:
  98         string const from_;
  99         string const to_;
 100 };
 101
 102 } // namespace
 103
 104
 105 Converter::Converter(string const & f, string const & t,
 106                      string const & c, string const & l)
 107         : from_(f), to_(t), command_(c), flags_(l),
 108           From_(0), To_(0), latex_(false), xml_(false),
 109           need_aux_(false), nice_(false), need_auth_(false)
 110 {}
 111
 112
 113 void Converter::readFlags()
 114 {
 115         string flag_list(flags_);
 116         while (!flag_list.empty()) {
 117                 string flag_name, flag_value;
 118                 flag_list = split(flag_list, flag_value, ',');
 119                 flag_value = split(flag_value, flag_name, '=');
 120                 if (flag_name == "latex") {
 121                         latex_ = true;
 122                         latex_flavor_ = flag_value.empty() ?
 123                                 "latex" : flag_value;
 124                 } else if (flag_name == "xml")
 125                         xml_ = true;
 126                 else if (flag_name == "needaux")
 127                         need_aux_ = true;
 128                 else if (flag_name == "resultdir")
 129                         result_dir_ = (flag_value.empty())
 130                                 ? token_base : flag_value;
 131                 else if (flag_name == "resultfile")
 132                         result_file_ = flag_value;
 133                 else if (flag_name == "parselog")
 134                         parselog_ = flag_value;
 135                 else if (flag_name == "nice")
 136                         nice_ = true;
 137                 else if (flag_name == "needauth")
 138                         need_auth_ = true;
 139         }
 140         if (!result_dir_.empty() && result_file_.empty())
 141                 result_file_ = "index." + theFormats().extension(to_);
 142         //if (!contains(command, token_from))
 143         //      latex = true;
 144 }
 145
 146
 147 Converter const * Converters::getConverter(string const & from,
 148                                             string const & to) const
 149 {
 150         ConverterList::const_iterator const cit =
 151                 find_if(converterlist_.begin(), converterlist_.end(),
 152                         ConverterEqual(from, to));
 153         if (cit != converterlist_.end())
 154                 return &(*cit);
 155         else
 156                 return 0;
 157 }
 158
 159
 160 int Converters::getNumber(string const & from, string const & to) const
 161 {
 162         ConverterList::const_iterator const cit =
 163                 find_if(converterlist_.begin(), converterlist_.end(),
 164                         ConverterEqual(from, to));
 165         if (cit != converterlist_.end())
 166                 return distance(converterlist_.begin(), cit);
 167         else
 168                 return -1;
 169 }
 170
 171
 172 void Converters::add(string const & from, string const & to,
 173                      string const & command, string const & flags)
 174 {
 175         theFormats().add(from);
 176         theFormats().add(to);
 177         ConverterList::iterator it = find_if(converterlist_.begin(),
 178                                              converterlist_.end(),
 179                                              ConverterEqual(from , to));
 180
 181         Converter converter(from, to, command, flags);
 182         if (it != converterlist_.end() && !flags.empty() && flags[0] == '*') {
 183                 converter = *it;
 184                 converter.setCommand(command);
 185                 converter.setFlags(flags);
 186         }
 187         converter.readFlags();
 188
 189         // The latex_command is used to update the .aux file when running
 190         // a converter that uses it.
 191         if (converter.latex()) {
 192                 if (latex_command_.empty() ||
 193                     converter.latex_flavor() == "latex")
 194                         latex_command_ = subst(command, token_from, "");
 195                 if (dvilualatex_command_.empty() ||
 196                     converter.latex_flavor() == "dvilualatex")
 197                         dvilualatex_command_ = subst(command, token_from, "");
 198                 if (lualatex_command_.empty() ||
 199                     converter.latex_flavor() == "lualatex")
 200                         lualatex_command_ = subst(command, token_from, "");
 201                 if (pdflatex_command_.empty() ||
 202                     converter.latex_flavor() == "pdflatex")
 203                         pdflatex_command_ = subst(command, token_from, "");
 204                 if (xelatex_command_.empty() ||
 205                     converter.latex_flavor() == "xelatex")
 206                         xelatex_command_ = subst(command, token_from, "");
 207         }
 208
 209         if (it == converterlist_.end()) {
 210                 converterlist_.push_back(converter);
 211         } else {
 212                 converter.setFrom(it->From());
 213                 converter.setTo(it->To());
 214                 *it = converter;
 215         }
 216 }
 217
 218
 219 void Converters::erase(string const & from, string const & to)
 220 {
 221         ConverterList::iterator const it =
 222                 find_if(converterlist_.begin(),
 223                         converterlist_.end(),
 224                         ConverterEqual(from, to));
 225         if (it != converterlist_.end())
 226                 converterlist_.erase(it);
 227 }
 228
 229
 230 // This method updates the pointers From and To in all the converters.
 231 // The code is not very efficient, but it doesn't matter as the number
 232 // of formats and converters is small.
 233 // Furthermore, this method is called only on startup, or after
 234 // adding/deleting a format in FormPreferences (the latter calls can be
 235 // eliminated if the formats in the Formats class are stored using a map or
 236 // a list (instead of a vector), but this will cause other problems).
 237 void Converters::update(Formats const & formats)
 238 {
 239         ConverterList::iterator it = converterlist_.begin();
 240         ConverterList::iterator end = converterlist_.end();
 241         for (; it != end; ++it) {
 242                 it->setFrom(formats.getFormat(it->from()));
 243                 it->setTo(formats.getFormat(it->to()));
 244         }
 245 }
 246
 247
 248 // This method updates the pointers From and To in the last converter.
 249 // It is called when adding a new converter in FormPreferences
 250 void Converters::updateLast(Formats const & formats)
 251 {
 252         if (converterlist_.begin() != converterlist_.end()) {
 253                 ConverterList::iterator it = converterlist_.end() - 1;
 254                 it->setFrom(formats.getFormat(it->from()));
 255                 it->setTo(formats.getFormat(it->to()));
 256         }
 257 }
 258
 259
 260 OutputParams::FLAVOR Converters::getFlavor(Graph::EdgePath const & path,
 261                                            Buffer const * buffer)
 262 {
 263         for (Graph::EdgePath::const_iterator cit = path.begin();
 264              cit != path.end(); ++cit) {
 265                 Converter const & conv = converterlist_[*cit];
 266                 if (conv.latex()) {
 267                         if (conv.latex_flavor() == "latex")
 268                                 return OutputParams::LATEX;
 269                         if (conv.latex_flavor() == "xelatex")
 270                                 return OutputParams::XETEX;
 271                         if (conv.latex_flavor() == "lualatex")
 272                                 return OutputParams::LUATEX;
 273                         if (conv.latex_flavor() == "dvilualatex")
 274                                 return OutputParams::DVILUATEX;
 275                         if (conv.latex_flavor() == "pdflatex")
 276                                 return OutputParams::PDFLATEX;
 277                 }
 278                 if (conv.xml())
 279                         return OutputParams::XML;
 280         }
 281         return buffer ? buffer->params().getOutputFlavor()
 282                       : OutputParams::LATEX;
 283 }
 284
 285
 286 bool Converters::checkAuth(Converter const & conv, string const & doc_fname,
 287                            bool use_shell_escape)
 288 {
 289         string conv_command = conv.command();
 290         bool const has_shell_escape = contains(conv_command, "-shell-escape")
 291                                 || contains(conv_command, "-enable-write18");
 292         if (conv.latex() && has_shell_escape && !use_shell_escape) {
 293                 docstring const shellescape_warning =
 294                       bformat(_("<p>The following LaTeX backend has been "
 295                         "configured to allow execution of external programs "
 296                         "for any document:</p>"
 297                         "<center><p><tt>%1$s</tt></p></center>"
 298                         "<p>This is a dangerous configuration. Please, "
 299                         "consider using the support offered by LyX for "
 300                         "allowing this privilege only to documents that "
 301                         "actually need it, instead.</p>"),
 302                         from_utf8(conv_command));
 303                 frontend::Alert::error(_("Security Warning"),
 304                                         shellescape_warning , false);
 305         } else if (!conv.latex())
 306                 use_shell_escape = false;
 307         if (!conv.need_auth() && !use_shell_escape)
 308                 return true;
 309         size_t const token_pos = conv_command.find("$$");
 310         bool const has_token = token_pos != string::npos;
 311         string const command = use_shell_escape && !has_shell_escape
 312                 ? (has_token ? conv_command.insert(token_pos, "-shell-escape ")
 313                              : conv_command.append(" -shell-escape"))
 314                 : conv_command;
 315         docstring const security_warning = (use_shell_escape
 316             ? bformat(_("<p>The following LaTeX backend has been requested "
 317                 "to allow execution of external programs:</p>"
 318                 "<center><p><tt>%1$s</tt></p></center>"
 319                 "<p>The external programs can execute arbitrary commands on "
 320                 "your system, including dangerous ones, if instructed to do "
 321                 "so by a maliciously crafted LyX document.</p>"),
 322               from_utf8(command))
 323             : bformat(_("<p>The requested operation requires the use of a "
 324                 "converter from %2$s to %3$s:</p>"
 325                 "<blockquote><p><tt>%1$s</tt></p></blockquote>"
 326                 "<p>This external program can execute arbitrary commands on "
 327                 "your system, including dangerous ones, if instructed to do "
 328                 "so by a maliciously crafted LyX document.</p>"),
 329               from_utf8(command), from_utf8(conv.from()),
 330               from_utf8(conv.to())));
 331         if (lyxrc.use_converter_needauth_forbidden && !use_shell_escape) {
 332                 frontend::Alert::error(
 333                     _("An external converter is disabled for security reasons"),
 334                     security_warning + _(
 335                     "<p><b>Your current preference settings forbid its execution.</b></p>"
 336                     "<p>(To change this setting, go to <i>Preferences &#x25b9; File "
 337                     "Handling &#x25b9; Converters</i> and uncheck <i>Security &#x25b9; "
 338                     "Forbid needauth converters</i>.)"), false);
 339                 return false;
 340         }
 341         if (!lyxrc.use_converter_needauth && !use_shell_escape)
 342                 return true;
 343         docstring const security_title = use_shell_escape
 344                 ? _("A LaTeX backend requires your authorization")
 345                 : _("An external converter requires your authorization");
 346         int choice;
 347         docstring const security_warning2 = security_warning + (use_shell_escape
 348                 ? _("<p>Should LaTeX backends be allowed to run external "
 349                     "programs?</p><p><b>Allow them only if you trust the "
 350                     "origin/sender of the LyX document!</b></p>")
 351                 : _("<p>Would you like to run this converter?</p>"
 352                     "<p><b>Only run if you trust the origin/sender of the LyX "
 353                     "document!</b></p>"));
 354         docstring const no = use_shell_escape
 355                                 ? _("Do &not allow") : _("Do &not run");
 356         docstring const yes = use_shell_escape ? _("A&llow") : _("&Run");
 357         docstring const always = use_shell_escape
 358                                         ? _("&Always allow for this document")
 359                                         : _("&Always run for this document");
 360         if (!doc_fname.empty()) {
 361                 LYXERR(Debug::FILES, "looking up: " << doc_fname);
 362                 bool authorized = use_shell_escape
 363                         ? theSession().shellescapeFiles().findAuth(doc_fname)
 364                         : theSession().authFiles().find(doc_fname);
 365                 if (!authorized) {
 366                         choice = frontend::Alert::prompt(security_title,
 367                                                          security_warning2,
 368                                                          0, 0, no, yes, always);
 369                         if (choice == 2) {
 370                                 if (use_shell_escape)
 371                                         theSession().shellescapeFiles().insert(doc_fname, true);
 372                                 else
 373                                         theSession().authFiles().insert(doc_fname);
 374                         }
 375                 } else {
 376                         choice = 1;
 377                 }
 378         } else {
 379                 choice = frontend::Alert::prompt(security_title,
 380                                                  security_warning2,
 381                                                  0, 0, no, yes);
 382         }
 383         return choice != 0;
 384 }
 385
 386
 387 bool Converters::convert(Buffer const * buffer,
 388                          FileName const & from_file, FileName const & to_file,
 389                          FileName const & orig_from,
 390                          string const & from_format, string const & to_format,
 391                          ErrorList & errorList, int conversionflags)
 392 {
 393         if (from_format == to_format)
 394                 return move(from_format, from_file, to_file, false);
 395
 396         if ((conversionflags & try_cache) &&
 397             ConverterCache::get().inCache(orig_from, to_format))
 398                 return ConverterCache::get().copy(orig_from, to_format, to_file);
 399
 400         Graph::EdgePath edgepath = getPath(from_format, to_format);
 401         if (edgepath.empty()) {
 402                 if (conversionflags & try_default) {
 403                         // if no special converter defined, then we take the
 404                         // default one from ImageMagic.
 405                         string const from_ext = from_format.empty() ?
 406                                 getExtension(from_file.absFileName()) :
 407                                 theFormats().extension(from_format);
 408                         string const to_ext = theFormats().extension(to_format);
 409                         string const command =
 410                                 os::python() + ' ' +
 411                                 quoteName(libFileSearch("scripts", "convertDefault.py").toFilesystemEncoding()) +
 412                                 ' ' + from_ext + ' ' +
 413                                 quoteName(from_file.toFilesystemEncoding()) +
 414                                 ' ' + to_ext + ' ' +
 415                                 quoteName(to_file.toFilesystemEncoding());
 416                         LYXERR(Debug::FILES, "No converter defined! "
 417                                    "I use convertDefault.py:\n\t" << command);
 418                         Systemcall one;
 419             Systemcall::Starttype starttype =
 420                 (buffer && buffer->isClone()) ?
 421                     Systemcall::WaitLoop : Systemcall::Wait;
 422                         one.startscript(starttype, command,
 423                                         buffer ? buffer->filePath() : string(),
 424                                         buffer ? buffer->layoutPos() : string());
 425                         if (to_file.isReadableFile()) {
 426                                 if (conversionflags & try_cache)
 427                                         ConverterCache::get().add(orig_from,
 428                                                         to_format, to_file);
 429                                 return true;
 430                         }
 431                 }
 432
 433                 // only warn once per session and per file type
 434                 static std::map<string, string> warned;
 435                 if (warned.find(from_format) != warned.end() && warned.find(from_format)->second == to_format) {
 436                         return false;
 437                 }
 438                 warned.insert(make_pair(from_format, to_format));
 439
 440                 Alert::error(_("Cannot convert file"),
 441                              bformat(_("No information for converting %1$s "
 442                                                     "format files to %2$s.\n"
 443                                                     "Define a converter in the preferences."),
 444                                                         from_ascii(from_format), from_ascii(to_format)));
 445                 return false;
 446         }
 447
 448         // buffer is only invalid for importing, and then runparams is not
 449         // used anyway.
 450         OutputParams runparams(buffer ? &buffer->params().encoding() : 0);
 451         runparams.flavor = getFlavor(edgepath, buffer);
 452
 453         if (buffer) {
 454                 runparams.use_japanese =
 455                         (buffer->params().bufferFormat() == "latex"
 456                          || suffixIs(buffer->params().bufferFormat(), "-ja"))
 457                         && buffer->params().encoding().package() == Encoding::japanese;
 458                 runparams.use_indices = buffer->params().use_indices;
 459                 runparams.bibtex_command = buffer->params().bibtexCommand();
 460                 runparams.index_command = (buffer->params().index_command == "default") ?
 461                         string() : buffer->params().index_command;
 462                 runparams.document_language = buffer->params().language->babel();
 463                 runparams.only_childbibs = !buffer->params().useBiblatex()
 464                                 && !buffer->params().useBibtopic()
 465                                 && buffer->params().multibib == "child";
 466         }
 467
 468         // Some converters (e.g. lilypond) can only output files to the
 469         // current directory, so we need to change the current directory.
 470         // This has the added benefit that all other files that may be
 471         // generated by the converter are deleted when LyX closes and do not
 472         // clutter the real working directory.
 473         // FIXME: This does not work if path is an UNC path on windows
 474         //        (bug 6127).
 475         string const path(onlyPath(from_file.absFileName()));
 476         // Prevent the compiler from optimizing away p
 477         FileName pp(path);
 478         PathChanger p(pp);
 479
 480         // empty the error list before any new conversion takes place.
 481         errorList.clear();
 482
 483         bool run_latex = false;
 484         string from_base = changeExtension(from_file.absFileName(), "");
 485         string to_base = changeExtension(to_file.absFileName(), "");
 486         FileName infile;
 487         FileName outfile = from_file;
 488         for (Graph::EdgePath::const_iterator cit = edgepath.begin();
 489              cit != edgepath.end(); ++cit) {
 490                 Converter const & conv = converterlist_[*cit];
 491                 bool dummy = conv.To()->dummy() && conv.to() != "program";
 492                 if (!dummy) {
 493                         LYXERR(Debug::FILES, "Converting from  "
 494                                << conv.from() << " to " << conv.to());
 495                 }
 496                 infile = outfile;
 497                 outfile = FileName(conv.result_file().empty()
 498                         ? changeExtension(from_file.absFileName(), conv.To()->extension())
 499                         : addName(subst(conv.result_dir(),
 500                                         token_base, from_base),
 501                                   subst(conv.result_file(),
 502                                         token_base, onlyFileName(from_base))));
 503
 504                 // if input and output files are equal, we use a
 505                 // temporary file as intermediary (JMarc)
 506                 FileName real_outfile;
 507                 if (!conv.result_file().empty())
 508                         real_outfile = FileName(changeExtension(from_file.absFileName(),
 509                                 conv.To()->extension()));
 510                 if (outfile == infile) {
 511                         real_outfile = infile;
 512                         // when importing, a buffer does not necessarily exist
 513                         if (buffer)
 514                                 outfile = FileName(addName(buffer->temppath(), "tmpfile.out"));
 515                         else
 516                                 outfile = FileName(addName(package().temp_dir().absFileName(),
 517                                                    "tmpfile.out"));
 518                 }
 519
 520                 if (buffer && buffer->params().use_minted
 521                     && lyxrc.pygmentize_command.empty() && conv.latex()) {
 522                         bool dowarn = false;
 523                         // Warn only if listings insets are actually used
 524                         for (Paragraph const & par : buffer->paragraphs()) {
 525                                 InsetList const & insets = par.insetList();
 526                                 pos_type lstpos = insets.find(LISTINGS_CODE, 0);
 527                                 pos_type incpos = insets.find(INCLUDE_CODE, 0);
 528                                 if (incpos >= 0) {
 529                                         InsetInclude const * include =
 530                                                 static_cast<InsetInclude *>
 531                                                         (insets.get(incpos));
 532                                         if (include->params().getCmdName() !=
 533                                                                 "inputminted") {
 534                                                 incpos = -1;
 535                                         }
 536                                 }
 537                                 if (lstpos >= 0 || incpos >= 0) {
 538                                         dowarn = true;
 539                                         break;
 540                                 }
 541                         }
 542                         if (dowarn) {
 543                                 Alert::warning(_("Pygments driver command not found!"),
 544                                     _("The driver command necessary to use the minted package\n"
 545                                       "(pygmentize) has not been found. Make sure you have\n"
 546                                       "the python-pygments module installed or, if the driver\n"
 547                                       "is named differently, to add the following line to the\n"
 548                                       "document preamble:\n\n"
 549                                       "\\AtBeginDocument{\\renewcommand{\\MintedPygmentize}{driver}}\n\n"
 550                                       "where 'driver' is name of the driver command."));
 551                         }
 552                 }
 553
 554                 if (!checkAuth(conv, buffer ? buffer->absFileName() : string(),
 555                                buffer && buffer->params().shell_escape))
 556                         return false;
 557
 558                 if (conv.latex()) {
 559                         // We are not importing, we have a buffer
 560                         LATTEST(buffer);
 561                         run_latex = true;
 562                         string command = conv.command();
 563                         command = subst(command, token_from, "");
 564                         command = subst(command, token_latex_encoding,
 565                                         buffer->params().encoding().latexName());
 566                         if (buffer->params().shell_escape
 567                             && !contains(command, "-shell-escape"))
 568                                 command += " -shell-escape ";
 569                         LYXERR(Debug::FILES, "Running " << command);
 570                         if (!runLaTeX(*buffer, command, runparams, errorList))
 571                                 return false;
 572                 } else {
 573                         if (conv.need_aux() && !run_latex) {
 574                                 // We are not importing, we have a buffer
 575                                 LATTEST(buffer);
 576                                 string command;
 577                                 switch (runparams.flavor) {
 578                                 case OutputParams::DVILUATEX:
 579                                         command = dvilualatex_command_;
 580                                         break;
 581                                 case OutputParams::LUATEX:
 582                                         command = lualatex_command_;
 583                                         break;
 584                                 case OutputParams::PDFLATEX:
 585                                         command = pdflatex_command_;
 586                                         break;
 587                                 case OutputParams::XETEX:
 588                                         command = xelatex_command_;
 589                                         break;
 590                                 default:
 591                                         command = latex_command_;
 592                                         break;
 593                                 }
 594                                 if (!command.empty()) {
 595                                         LYXERR(Debug::FILES, "Running "
 596                                                 << command
 597                                                 << " to update aux file");
 598                                         if (!runLaTeX(*buffer, command,
 599                                                       runparams, errorList))
 600                                                 return false;
 601                                 }
 602                         }
 603
 604                         // FIXME UNICODE
 605                         string const infile2 =
 606                                 to_utf8(makeRelPath(from_utf8(infile.absFileName()), from_utf8(path)));
 607                         string const outfile2 =
 608                                 to_utf8(makeRelPath(from_utf8(outfile.absFileName()), from_utf8(path)));
 609
 610                         string command = conv.command();
 611                         command = subst(command, token_from, quoteName(infile2));
 612                         command = subst(command, token_base, quoteName(from_base));
 613                         command = subst(command, token_to, quoteName(outfile2));
 614                         command = subst(command, token_path, quoteName(onlyPath(infile.absFileName())));
 615                         command = subst(command, token_orig_path, quoteName(onlyPath(orig_from.absFileName())));
 616                         command = subst(command, token_orig_from, quoteName(onlyFileName(orig_from.absFileName())));
 617                         command = subst(command, token_encoding, buffer ? buffer->params().encoding().iconvName() : string());
 618
 619                         if (!conv.parselog().empty())
 620                                 command += " 2> " + quoteName(infile2 + ".out");
 621
 622                         // it is not actually not necessary to test for buffer here,
 623                         // but it pleases coverity.
 624                         if (buffer && conv.from() == "dvi" && conv.to() == "ps")
 625                                 command = add_options(command,
 626                                                       buffer->params().dvips_options());
 627                         else if (buffer && conv.from() == "dvi" && prefixIs(conv.to(), "pdf"))
 628                                 command = add_options(command,
 629                                                       dvipdfm_options(buffer->params()));
 630
 631                         LYXERR(Debug::FILES, "Calling " << command);
 632                         if (buffer)
 633                                 buffer->message(_("Executing command: ")
 634                                 + from_utf8(command));
 635
 636                         Systemcall one;
 637                         int res;
 638                         if (dummy) {
 639                                 res = one.startscript(Systemcall::DontWait,
 640                                         to_filesystem8bit(from_utf8(command)),
 641                                         buffer ? buffer->filePath() : string(),
 642                                         buffer ? buffer->layoutPos() : string());
 643                                 // We're not waiting for the result, so we can't do anything
 644                                 // else here.
 645                         } else {
 646                                 Systemcall::Starttype starttype =
 647                                                 (buffer && buffer->isClone()) ?
 648                                                         Systemcall::WaitLoop : Systemcall::Wait;
 649                                 res = one.startscript(starttype,
 650                                                 to_filesystem8bit(from_utf8(command)),
 651                                                 buffer ? buffer->filePath()
 652                                                        : string(),
 653                                                 buffer ? buffer->layoutPos()
 654                                                        : string());
 655                                 if (!real_outfile.empty()) {
 656                                         Mover const & mover = getMover(conv.to());
 657                                         if (!mover.rename(outfile, real_outfile))
 658                                                 res = -1;
 659                                         else
 660                                                 LYXERR(Debug::FILES, "renaming file " << outfile
 661                                                         << " to " << real_outfile);
 662                                         // Finally, don't forget to tell any future
 663                                         // converters to use the renamed file...
 664                                         outfile = real_outfile;
 665                                 }
 666
 667                                 if (!conv.parselog().empty()) {
 668                                         string const logfile =  infile2 + ".log";
 669                                         string const command2 = conv.parselog() +
 670                                                 " < " + quoteName(infile2 + ".out") +
 671                                                 " > " + quoteName(logfile);
 672                                         one.startscript(starttype,
 673                                                 to_filesystem8bit(from_utf8(command2)),
 674                                                 buffer->filePath(),
 675                                                 buffer->layoutPos());
 676                                         if (!scanLog(*buffer, command, makeAbsPath(logfile, path), errorList))
 677                                                 return false;
 678                                 }
 679                         }
 680
 681                         if (res) {
 682                                 if (res == Systemcall::KILLED) {
 683                                         Alert::information(_("Process Killed"),
 684                                                 bformat(_("The conversion process was killed while running:\n%1$s"),
 685                                                         wrapParas(from_utf8(command))));
 686                                 } else if (res == Systemcall::TIMEOUT) {
 687                                         Alert::information(_("Process Timed Out"),
 688                                                 bformat(_("The conversion process:\n%1$s\ntimed out before completing."),
 689                                                         wrapParas(from_utf8(command))));
 690                                 } else if (conv.to() == "program") {
 691                                         Alert::error(_("Build errors"),
 692                                                 _("There were errors during the build process."));
 693                                 } else {
 694 // FIXME: this should go out of here. For example, here we cannot say if
 695 // it is a document (.lyx) or something else. Same goes for elsewhere.
 696                                         Alert::error(_("Cannot convert file"),
 697                                                 bformat(_("An error occurred while running:\n%1$s"),
 698                                                 wrapParas(from_utf8(command))));
 699                                 }
 700                                 return false;
 701                         }
 702                 }
 703         }
 704
 705         Converter const & conv = converterlist_[edgepath.back()];
 706         if (conv.To()->dummy())
 707                 return true;
 708
 709         if (!conv.result_dir().empty()) {
 710                 // The converter has put the file(s) in a directory.
 711                 // In this case we ignore the given to_file.
 712                 if (from_base != to_base) {
 713                         string const from = subst(conv.result_dir(),
 714                                             token_base, from_base);
 715                         string const to = subst(conv.result_dir(),
 716                                           token_base, to_base);
 717                         Mover const & mover = getMover(conv.from());
 718                         if (!mover.rename(FileName(from), FileName(to))) {
 719                                 Alert::error(_("Cannot convert file"),
 720                                         bformat(_("Could not move a temporary directory from %1$s to %2$s."),
 721                                                 from_utf8(from), from_utf8(to)));
 722                                 return false;
 723                         }
 724                 }
 725                 return true;
 726         } else {
 727                 if (conversionflags & try_cache)
 728                         ConverterCache::get().add(orig_from, to_format, outfile);
 729                 return move(conv.to(), outfile, to_file, conv.latex());
 730         }
 731 }
 732
 733
 734 bool Converters::move(string const & fmt,
 735                       FileName const & from, FileName const & to, bool copy)
 736 {
 737         if (from == to)
 738                 return true;
 739
 740         bool no_errors = true;
 741         string const path = onlyPath(from.absFileName());
 742         string const base = onlyFileName(removeExtension(from.absFileName()));
 743         string const to_base = removeExtension(to.absFileName());
 744         string const to_extension = getExtension(to.absFileName());
 745
 746         support::FileNameList const files = FileName(path).dirList(getExtension(from.absFileName()));
 747         for (support::FileNameList::const_iterator it = files.begin();
 748              it != files.end(); ++it) {
 749                 string const from2 = it->absFileName();
 750                 string const file2 = onlyFileName(from2);
 751                 if (prefixIs(file2, base)) {
 752                         string const to2 = changeExtension(
 753                                 to_base + file2.substr(base.length()),
 754                                 to_extension);
 755                         LYXERR(Debug::FILES, "moving " << from2 << " to " << to2);
 756
 757                         Mover const & mover = getMover(fmt);
 758                         bool const moved = copy
 759                                 ? mover.copy(*it, FileName(to2))
 760                                 : mover.rename(*it, FileName(to2));
 761                         if (!moved && no_errors) {
 762                                 Alert::error(_("Cannot convert file"),
 763                                         bformat(copy ?
 764                                                 _("Could not copy a temporary file from %1$s to %2$s.") :
 765                                                 _("Could not move a temporary file from %1$s to %2$s."),
 766                                                 from_utf8(from2), from_utf8(to2)));
 767                                 no_errors = false;
 768                         }
 769                 }
 770         }
 771         return no_errors;
 772 }
 773
 774
 775 bool Converters::formatIsUsed(string const & format)
 776 {
 777         ConverterList::const_iterator cit = converterlist_.begin();
 778         ConverterList::const_iterator end = converterlist_.end();
 779         for (; cit != end; ++cit) {
 780                 if (cit->from() == format || cit->to() == format)
 781                         return true;
 782         }
 783         return false;
 784 }
 785
 786
 787 bool Converters::scanLog(Buffer const & buffer, string const & /*command*/,
 788                          FileName const & filename, ErrorList & errorList)
 789 {
 790         OutputParams runparams(0);
 791         runparams.flavor = OutputParams::LATEX;
 792         LaTeX latex("", runparams, filename);
 793         TeXErrors terr;
 794         int const result = latex.scanLogFile(terr);
 795
 796         if (result & LaTeX::ERRORS)
 797                 buffer.bufferErrors(terr, errorList);
 798
 799         return true;
 800 }
 801
 802
 803 bool Converters::runLaTeX(Buffer const & buffer, string const & command,
 804                           OutputParams const & runparams, ErrorList & errorList)
 805 {
 806         buffer.setBusy(true);
 807         buffer.message(_("Running LaTeX..."));
 808
 809         // do the LaTeX run(s)
 810         string const name = buffer.latexName();
 811         LaTeX latex(command, runparams, FileName(makeAbsPath(name)),
 812                     buffer.filePath(), buffer.layoutPos(),
 813                     buffer.isClone(), buffer.lastPreviewError());
 814         TeXErrors terr;
 815         // The connection closes itself at the end of the scope when latex is
 816         // destroyed. One cannot close (and destroy) buffer while the converter is
 817         // running.
 818         latex.message.connect([&buffer](docstring const & msg){
 819                         buffer.message(msg);
 820                 });
 821         int const result = latex.run(terr);
 822
 823         if (result & LaTeX::ERRORS)
 824                 buffer.bufferErrors(terr, errorList);
 825
 826         if (!errorList.empty()) {
 827           // We will show the LaTeX Errors GUI later which contains
 828           // specific error messages so it would be repetitive to give
 829           // e.g. the "finished with an error" dialog in addition.
 830         }
 831         else if (result & LaTeX::NO_LOGFILE) {
 832                 docstring const str =
 833                         bformat(_("LaTeX did not run successfully. "
 834                                                "Additionally, LyX could not locate "
 835                                                "the LaTeX log %1$s."), from_utf8(name));
 836                 Alert::error(_("LaTeX failed"), str);
 837         } else if (result & LaTeX::NONZERO_ERROR) {
 838                 docstring const str =
 839                         bformat(_( "The external program\n%1$s\n"
 840                               "finished with an error. "
 841                               "It is recommended you fix the cause of the external "
 842                               "program's error (check the logs). "), from_utf8(command));
 843                 Alert::error(_("LaTeX failed"), str);
 844         } else if (result & LaTeX::NO_OUTPUT) {
 845                 Alert::warning(_("Output is empty"),
 846                                _("No output file was generated."));
 847         }
 848
 849
 850         buffer.setBusy(false);
 851
 852         int const ERROR_MASK =
 853                         LaTeX::NO_LOGFILE |
 854                         LaTeX::ERRORS |
 855                         LaTeX::NO_OUTPUT;
 856
 857         return (result & ERROR_MASK) == 0;
 858 }
 859
 860
 861
 862 void Converters::buildGraph()
 863 {
 864         // clear graph's data structures
 865         G_.init(theFormats().size());
 866         // each of the converters knows how to convert one format to another
 867         // so, for each of them, we create an arrow on the graph, going from
 868         // the one to the other
 869         ConverterList::iterator it = converterlist_.begin();
 870         ConverterList::iterator const end = converterlist_.end();
 871         for (; it != end ; ++it) {
 872                 int const from = theFormats().getNumber(it->from());
 873                 int const to   = theFormats().getNumber(it->to());
 874                 LASSERT(from >= 0, continue);
 875                 LASSERT(to >= 0, continue);
 876                 G_.addEdge(from, to);
 877         }
 878 }
 879
 880
 881 FormatList const Converters::intToFormat(vector<int> const & input)
 882 {
 883         FormatList result(input.size());
 884
 885         vector<int>::const_iterator it = input.begin();
 886         vector<int>::const_iterator const end = input.end();
 887         FormatList::iterator rit = result.begin();
 888         for ( ; it != end; ++it, ++rit) {
 889                 *rit = &theFormats().get(*it);
 890         }
 891         return result;
 892 }
 893
 894
 895 FormatList const Converters::getReachableTo(string const & target,
 896                 bool const clear_visited)
 897 {
 898         vector<int> const & reachablesto =
 899                 G_.getReachableTo(theFormats().getNumber(target), clear_visited);
 900
 901         return intToFormat(reachablesto);
 902 }
 903
 904
 905 FormatList const Converters::getReachable(string const & from,
 906                 bool const only_viewable, bool const clear_visited,
 907                 set<string> const & excludes)
 908 {
 909         set<int> excluded_numbers;
 910
 911         set<string>::const_iterator sit = excludes.begin();
 912         set<string>::const_iterator const end = excludes.end();
 913         for (; sit != end; ++sit)
 914                 excluded_numbers.insert(theFormats().getNumber(*sit));
 915
 916         vector<int> const & reachables =
 917                 G_.getReachable(theFormats().getNumber(from),
 918                                 only_viewable,
 919                                 clear_visited,
 920                                 excluded_numbers);
 921
 922         return intToFormat(reachables);
 923 }
 924
 925
 926 bool Converters::isReachable(string const & from, string const & to)
 927 {
 928         return G_.isReachable(theFormats().getNumber(from),
 929                               theFormats().getNumber(to));
 930 }
 931
 932
 933 Graph::EdgePath Converters::getPath(string const & from, string const & to)
 934 {
 935         return G_.getPath(theFormats().getNumber(from),
 936                           theFormats().getNumber(to));
 937 }
 938
 939
 940 FormatList Converters::importableFormats()
 941 {
 942         vector<string> l = loaders();
 943         FormatList result = getReachableTo(l[0], true);
 944         vector<string>::const_iterator it = l.begin() + 1;
 945         vector<string>::const_iterator en = l.end();
 946         for (; it != en; ++it) {
 947                 FormatList r = getReachableTo(*it, false);
 948                 result.insert(result.end(), r.begin(), r.end());
 949         }
 950         return result;
 951 }
 952
 953
 954 FormatList Converters::exportableFormats(bool only_viewable)
 955 {
 956         vector<string> s = savers();
 957         FormatList result = getReachable(s[0], only_viewable, true);
 958         vector<string>::const_iterator it = s.begin() + 1;
 959         vector<string>::const_iterator en = s.end();
 960         for (; it != en; ++it) {
 961                  FormatList r = getReachable(*it, only_viewable, false);
 962                 result.insert(result.end(), r.begin(), r.end());
 963         }
 964         return result;
 965 }
 966
 967
 968 vector<string> Converters::loaders() const
 969 {
 970         vector<string> v;
 971         v.push_back("lyx");
 972         v.push_back("text");
 973         v.push_back("textparagraph");
 974         return v;
 975 }
 976
 977
 978 vector<string> Converters::savers() const
 979 {
 980         vector<string> v;
 981         v.push_back("docbook");
 982         v.push_back("latex");
 983         v.push_back("literate");
 984         v.push_back("luatex");
 985         v.push_back("dviluatex");
 986         v.push_back("lyx");
 987         v.push_back("xhtml");
 988         v.push_back("pdflatex");
 989         v.push_back("platex");
 990         v.push_back("text");
 991         v.push_back("xetex");
 992         return v;
 993 }
 994
 995
 996 } // namespace lyx