src/converter.C

   1 /**
   2  * \file converter.C
   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 "debug.h"
  19 #include "format.h"
  20 #include "gettext.h"
  21 #include "language.h"
  22 #include "LaTeX.h"
  23 #include "mover.h"
  24
  25 #include "frontends/Alert.h"
  26
  27 #include "support/filetools.h"
  28 #include "support/lyxlib.h"
  29 #include "support/path.h"
  30 #include "support/systemcall.h"
  31
  32 using lyx::support::AddName;
  33 using lyx::support::bformat;
  34 using lyx::support::ChangeExtension;
  35 using lyx::support::compare_ascii_no_case;
  36 using lyx::support::contains;
  37 using lyx::support::DirList;
  38 using lyx::support::GetExtension;
  39 using lyx::support::IsFileReadable;
  40 using lyx::support::LibFileSearch;
  41 using lyx::support::LibScriptSearch;
  42 using lyx::support::MakeRelPath;
  43 using lyx::support::OnlyFilename;
  44 using lyx::support::OnlyPath;
  45 using lyx::support::Path;
  46 using lyx::support::prefixIs;
  47 using lyx::support::QuoteName;
  48 using lyx::support::split;
  49 using lyx::support::subst;
  50 using lyx::support::Systemcall;
  51
  52 using std::endl;
  53 using std::find_if;
  54 using std::string;
  55 using std::vector;
  56 using std::distance;
  57
  58
  59 namespace {
  60
  61 string const token_from("$$i");
  62 string const token_base("$$b");
  63 string const token_to("$$o");
  64 string const token_path("$$p");
  65
  66
  67
  68 string const add_options(string const & command, string const & options)
  69 {
  70         string head;
  71         string const tail = split(command, head, ' ');
  72         return head + ' ' + options + ' ' + tail;
  73 }
  74
  75
  76 string const dvipdfm_options(BufferParams const & bp)
  77 {
  78         string result;
  79
  80         if (bp.papersize2 != VM_PAPER_CUSTOM) {
  81                 string const paper_size = bp.paperSizeName();
  82                 if (paper_size != "b5" && paper_size != "foolscap")
  83                         result = "-p "+ paper_size;
  84
  85                 if (bp.orientation == ORIENTATION_LANDSCAPE)
  86                         result += " -l";
  87         }
  88
  89         return result;
  90 }
  91
  92
  93 class ConverterEqual : public std::binary_function<string, string, bool> {
  94 public:
  95         ConverterEqual(string const & from, string const & to)
  96                 : from_(from), to_(to) {}
  97         bool operator()(Converter const & c) const {
  98                 return c.from == from_ && c.to == to_;
  99         }
 100 private:
 101         string const from_;
 102         string const to_;
 103 };
 104
 105 } // namespace anon
 106
 107
 108 Converter::Converter(string const & f, string const & t,
 109                      string const & c, string const & l)
 110         : from(f), to(t), command(c), flags(l),
 111           From(0), To(0), latex(false), xml(false),
 112           original_dir(false), need_aux(false)
 113 {}
 114
 115
 116 void Converter::readFlags()
 117 {
 118         string flag_list(flags);
 119         while (!flag_list.empty()) {
 120                 string flag_name, flag_value;
 121                 flag_list = split(flag_list, flag_value, ',');
 122                 flag_value = split(flag_value, flag_name, '=');
 123                 if (flag_name == "latex")
 124                         latex = true;
 125                 else if (flag_name == "xml")
 126                         xml = true;
 127                 else if (flag_name == "originaldir")
 128                         original_dir = true;
 129                 else if (flag_name == "needaux")
 130                         need_aux = true;
 131                 else if (flag_name == "resultdir")
 132                         result_dir = (flag_value.empty())
 133                                 ? token_base : flag_value;
 134                 else if (flag_name == "resultfile")
 135                         result_file = flag_value;
 136                 else if (flag_name == "parselog")
 137                         parselog = flag_value;
 138         }
 139         if (!result_dir.empty() && result_file.empty())
 140                 result_file = "index." + formats.extension(to);
 141         //if (!contains(command, token_from))
 142         //      latex = true;
 143 }
 144
 145
 146 bool operator<(Converter const & a, Converter const & b)
 147 {
 148         // use the compare_ascii_no_case instead of compare_no_case,
 149         // because in turkish, 'i' is not the lowercase version of 'I',
 150         // and thus turkish locale breaks parsing of tags.
 151         int const i = compare_ascii_no_case(a.From->prettyname(),
 152                                             b.From->prettyname());
 153         if (i == 0)
 154                 return compare_ascii_no_case(a.To->prettyname(),
 155                                              b.To->prettyname()) < 0;
 156         else
 157                 return i < 0;
 158 }
 159
 160
 161 Converter const * Converters::getConverter(string const & from,
 162                                             string const & to) const
 163 {
 164         ConverterList::const_iterator const cit =
 165                 find_if(converterlist_.begin(), converterlist_.end(),
 166                         ConverterEqual(from, to));
 167         if (cit != converterlist_.end())
 168                 return &(*cit);
 169         else
 170                 return 0;
 171 }
 172
 173
 174 int Converters::getNumber(string const & from, string const & to) const
 175 {
 176         ConverterList::const_iterator const cit =
 177                 find_if(converterlist_.begin(), converterlist_.end(),
 178                         ConverterEqual(from, to));
 179         if (cit != converterlist_.end())
 180                 return distance(converterlist_.begin(), cit);
 181         else
 182                 return -1;
 183 }
 184
 185
 186 void Converters::add(string const & from, string const & to,
 187                      string const & command, string const & flags)
 188 {
 189         formats.add(from);
 190         formats.add(to);
 191         ConverterList::iterator it = find_if(converterlist_.begin(),
 192                                              converterlist_.end(),
 193                                              ConverterEqual(from , to));
 194
 195         Converter converter(from, to, command, flags);
 196         if (it != converterlist_.end() && !flags.empty() && flags[0] == '*') {
 197                 converter = *it;
 198                 converter.command = command;
 199                 converter.flags = flags;
 200         }
 201         converter.readFlags();
 202
 203         if (converter.latex && (latex_command_.empty() || to == "dvi"))
 204                 latex_command_ = subst(command, token_from, "");
 205         // If we have both latex & pdflatex, we set latex_command to latex.
 206         // The latex_command is used to update the .aux file when running
 207         // a converter that uses it.
 208
 209         if (it == converterlist_.end()) {
 210                 converterlist_.push_back(converter);
 211         } else {
 212                 converter.From = it->From;
 213                 converter.To = 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->From = formats.getFormat(it->from);
 243                 it->To = 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->From = formats.getFormat(it->from);
 255                 it->To = formats.getFormat(it->to);
 256         }
 257 }
 258
 259
 260 void Converters::sort()
 261 {
 262         std::sort(converterlist_.begin(), converterlist_.end());
 263 }
 264
 265
 266 OutputParams::FLAVOR Converters::getFlavor(Graph::EdgePath const & path)
 267 {
 268         for (Graph::EdgePath::const_iterator cit = path.begin();
 269              cit != path.end(); ++cit) {
 270                 Converter const & conv = converterlist_[*cit];
 271                 if (conv.latex)
 272                         if (contains(conv.to, "pdf"))
 273                                 return OutputParams::PDFLATEX;
 274                 if (conv.xml)
 275                         return OutputParams::XML;
 276         }
 277         return OutputParams::LATEX;
 278 }
 279
 280
 281 bool Converters::convert(Buffer const * buffer,
 282                          string const & from_file, string const & to_file_base,
 283                          string const & from_format, string const & to_format,
 284                          string & to_file, bool try_default)
 285 {
 286         string const to_ext = formats.extension(to_format);
 287         to_file = ChangeExtension(to_file_base, to_ext);
 288
 289         if (from_format == to_format)
 290                 return move(from_format, from_file, to_file, false);
 291
 292         Graph::EdgePath edgepath = getPath(from_format, to_format);
 293         if (edgepath.empty()) {
 294                 if (try_default) {
 295                         // if no special converter defined, then we take the
 296                         // default one from ImageMagic.
 297                         string const from_ext = formats.extension(from_format);
 298                         string const command = "sh " +
 299                                 LibFileSearch("scripts", "convertDefault.sh") +
 300                                 ' ' + from_ext + ':' + from_file +
 301                                 ' ' + to_ext   + ':' + to_file;
 302                         lyxerr[Debug::FILES]
 303                                 << "No converter defined! "
 304                                    "I use convertDefault.sh:\n\t"
 305                                 << command << endl;
 306                         Systemcall one;
 307                         one.startscript(Systemcall::Wait, command);
 308                         if (IsFileReadable(to_file)) {
 309                                 return true;
 310                         }
 311                 }
 312                 Alert::error(_("Cannot convert file"),
 313                         bformat(_("No information for converting %1$s "
 314                                 "format files to %2$s.\n"
 315                                 "Try defining a convertor in the preferences."),
 316                         from_format, to_format));
 317                 return false;
 318         }
 319         OutputParams runparams;
 320         runparams.flavor = getFlavor(edgepath);
 321         string path = OnlyPath(from_file);
 322         Path p(path);
 323
 324         bool run_latex = false;
 325         string from_base = ChangeExtension(from_file, "");
 326         string to_base = ChangeExtension(to_file, "");
 327         string infile;
 328         string outfile = from_file;
 329         for (Graph::EdgePath::const_iterator cit = edgepath.begin();
 330              cit != edgepath.end(); ++cit) {
 331                 Converter const & conv = converterlist_[*cit];
 332                 bool dummy = conv.To->dummy() && conv.to != "program";
 333                 if (!dummy)
 334                         lyxerr[Debug::FILES] << "Converting from  "
 335                                << conv.from << " to " << conv.to << endl;
 336                 infile = outfile;
 337                 outfile = conv.result_dir.empty()
 338                         ? ChangeExtension(from_file, conv.To->extension())
 339                         : AddName(subst(conv.result_dir,
 340                                         token_base, from_base),
 341                                   subst(conv.result_file,
 342                                         token_base, OnlyFilename(from_base)));
 343
 344                 // if input and output files are equal, we use a
 345                 // temporary file as intermediary (JMarc)
 346                 string real_outfile;
 347                 if (outfile == infile) {
 348                         real_outfile = infile;
 349                         outfile = AddName(buffer->temppath(), "tmpfile.out");
 350                 }
 351
 352                 if (conv.latex) {
 353                         run_latex = true;
 354                         string const command = subst(conv.command, token_from, "");
 355                         lyxerr[Debug::FILES] << "Running " << command << endl;
 356                         if (!runLaTeX(*buffer, command, runparams))
 357                                 return false;
 358                 } else {
 359                         if (conv.need_aux && !run_latex
 360                             && !latex_command_.empty()) {
 361                                 lyxerr[Debug::FILES]
 362                                         << "Running " << latex_command_
 363                                         << " to update aux file"<<  endl;
 364                                 runLaTeX(*buffer, latex_command_, runparams);
 365                         }
 366
 367                         string const infile2 = (conv.original_dir)
 368                                 ? infile : MakeRelPath(infile, path);
 369                         string const outfile2 = (conv.original_dir)
 370                                 ? outfile : MakeRelPath(outfile, path);
 371
 372                         string command = conv.command;
 373                         command = subst(command, token_from, QuoteName(infile2));
 374                         command = subst(command, token_base, QuoteName(from_base));
 375                         command = subst(command, token_to, QuoteName(outfile2));
 376                         command = LibScriptSearch(command);
 377
 378                         if (!conv.parselog.empty())
 379                                 command += " 2> " + QuoteName(infile2 + ".out");
 380
 381                         if (conv.from == "dvi" && conv.to == "ps")
 382                                 command = add_options(command,
 383                                                       buffer->params().dvips_options());
 384                         else if (conv.from == "dvi" && prefixIs(conv.to, "pdf"))
 385                                 command = add_options(command,
 386                                                       dvipdfm_options(buffer->params()));
 387
 388                         lyxerr[Debug::FILES] << "Calling " << command << endl;
 389                         if (buffer)
 390                                 buffer->message(_("Executing command: ")
 391                                         + command);
 392
 393                         Systemcall::Starttype const type = (dummy)
 394                                 ? Systemcall::DontWait : Systemcall::Wait;
 395                         Systemcall one;
 396                         int res;
 397                         if (conv.original_dir) {
 398                                 Path p(buffer->filePath());
 399                                 res = one.startscript(type, command);
 400                         } else
 401                                 res = one.startscript(type, command);
 402
 403                         if (!real_outfile.empty()) {
 404                                 Mover const & mover = movers(conv.to);
 405                                 if (!mover.rename(outfile, real_outfile))
 406                                         res = -1;
 407                                 else
 408                                         lyxerr[Debug::FILES]
 409                                                 << "renaming file " << outfile
 410                                                 << " to " << real_outfile
 411                                                 << endl;
 412                         }
 413
 414                         if (!conv.parselog.empty()) {
 415                                 string const logfile =  infile2 + ".log";
 416                                 string const script = LibScriptSearch(conv.parselog);
 417                                 string const command2 = script +
 418                                         " < " + QuoteName(infile2 + ".out") +
 419                                         " > " + QuoteName(logfile);
 420                                 one.startscript(Systemcall::Wait, command2);
 421                                 if (!scanLog(*buffer, command, logfile))
 422                                         return false;
 423                         }
 424
 425                         if (res) {
 426                                 if (conv.to == "program") {
 427                                         Alert::error(_("Build errors"),
 428                                                 _("There were errors during the build process."));
 429                                 } else {
 430 // FIXME: this should go out of here. For example, here we cannot say if
 431 // it is a document (.lyx) or something else. Same goes for elsewhere.
 432                                 Alert::error(_("Cannot convert file"),
 433                                         bformat(_("An error occurred whilst running %1$s"),
 434                                                 command.substr(0, 50)));
 435                                 }
 436                                 return false;
 437                         }
 438                 }
 439         }
 440
 441         Converter const & conv = converterlist_[edgepath.back()];
 442         if (conv.To->dummy())
 443                 return true;
 444
 445         if (!conv.result_dir.empty()) {
 446                 to_file = AddName(subst(conv.result_dir, token_base, to_base),
 447                                   subst(conv.result_file,
 448                                         token_base, OnlyFilename(to_base)));
 449                 if (from_base != to_base) {
 450                         string const from = subst(conv.result_dir,
 451                                             token_base, from_base);
 452                         string const to = subst(conv.result_dir,
 453                                           token_base, to_base);
 454                         Mover const & mover = movers(conv.from);
 455                         if (!mover.rename(from, to)) {
 456                                 Alert::error(_("Cannot convert file"),
 457                                         bformat(_("Could not move a temporary file from %1$s to %2$s."),
 458                                                 from, to));
 459                                 return false;
 460                         }
 461                 }
 462                 return true;
 463         } else
 464                 return move(conv.to, outfile, to_file, conv.latex);
 465 }
 466
 467
 468 bool Converters::move(string const & fmt,
 469                       string const & from, string const & to, bool copy)
 470 {
 471         if (from == to)
 472                 return true;
 473
 474         bool no_errors = true;
 475         string const path = OnlyPath(from);
 476         string const base = OnlyFilename(ChangeExtension(from, ""));
 477         string const to_base = ChangeExtension(to, "");
 478         string const to_extension = GetExtension(to);
 479
 480         vector<string> files = DirList(OnlyPath(from), GetExtension(from));
 481         for (vector<string>::const_iterator it = files.begin();
 482              it != files.end(); ++it)
 483                 if (prefixIs(*it, base)) {
 484                         string const from2 = path + *it;
 485                         string to2 = to_base + it->substr(base.length());
 486                         to2 = ChangeExtension(to2, to_extension);
 487                         lyxerr[Debug::FILES] << "moving " << from2
 488                                              << " to " << to2 << endl;
 489
 490                         Mover const & mover = movers(fmt);
 491                         bool const moved = copy
 492                                 ? mover.copy(from2, to2)
 493                                 : mover.rename(from2, to2);
 494                         if (!moved && no_errors) {
 495                                 Alert::error(_("Cannot convert file"),
 496                                         bformat(copy ?
 497                                                 _("Could not copy a temporary file from %1$s to %2$s.") :
 498                                                 _("Could not move a temporary file from %1$s to %2$s."),
 499                                                 from2, to2));
 500                                 no_errors = false;
 501                         }
 502                 }
 503         return no_errors;
 504 }
 505
 506
 507 bool Converters::convert(Buffer const * buffer,
 508                          string const & from_file, string const & to_file_base,
 509                          string const & from_format, string const & to_format,
 510                          bool try_default)
 511 {
 512         string to_file;
 513         return convert(buffer, from_file, to_file_base, from_format, to_format,
 514                        to_file, try_default);
 515 }
 516
 517
 518 bool Converters::formatIsUsed(string const & format)
 519 {
 520         ConverterList::const_iterator cit = converterlist_.begin();
 521         ConverterList::const_iterator end = converterlist_.end();
 522         for (; cit != end; ++cit) {
 523                 if (cit->from == format || cit->to == format)
 524                         return true;
 525         }
 526         return false;
 527 }
 528
 529
 530 bool Converters::scanLog(Buffer const & buffer, string const & /*command*/,
 531                          string const & filename)
 532 {
 533         OutputParams runparams;
 534         runparams.flavor = OutputParams::LATEX;
 535         LaTeX latex("", runparams, filename, "");
 536         TeXErrors terr;
 537         int const result = latex.scanLogFile(terr);
 538
 539         if (result & LaTeX::ERRORS)
 540                 bufferErrors(buffer, terr);
 541
 542         return true;
 543 }
 544
 545
 546 namespace {
 547
 548 class showMessage : public std::unary_function<string, void>, public boost::signals::trackable {
 549 public:
 550         showMessage(Buffer const & b) : buffer_(b) {};
 551         void operator()(string const & m) const
 552         {
 553                 buffer_.message(m);
 554         }
 555 private:
 556         Buffer const & buffer_;
 557 };
 558
 559 }
 560
 561
 562 bool Converters::runLaTeX(Buffer const & buffer, string const & command,
 563                           OutputParams const & runparams)
 564 {
 565         buffer.busy(true);
 566         buffer.message(_("Running LaTeX..."));
 567
 568         runparams.document_language = buffer.params().language->babel();
 569
 570         // do the LaTeX run(s)
 571         string const name = buffer.getLatexName();
 572         LaTeX latex(command, runparams, name, buffer.filePath());
 573         TeXErrors terr;
 574         showMessage show(buffer);
 575         latex.message.connect(show);
 576         int const result = latex.run(terr);
 577
 578         if (result & LaTeX::ERRORS)
 579                 bufferErrors(buffer, terr);
 580
 581         // check return value from latex.run().
 582         if ((result & LaTeX::NO_LOGFILE)) {
 583                 string const str =
 584                         bformat(_("LaTeX did not run successfully. "
 585                                   "Additionally, LyX could not locate "
 586                                   "the LaTeX log %1$s."), name);
 587                 Alert::error(_("LaTeX failed"), str);
 588         } else if (result & LaTeX::NO_OUTPUT) {
 589                 Alert::warning(_("Output is empty"),
 590                                _("An empty output file was generated."));
 591         }
 592
 593
 594         buffer.busy(false);
 595
 596         int const ERROR_MASK =
 597                         LaTeX::NO_LOGFILE |
 598                         LaTeX::ERRORS |
 599                         LaTeX::NO_OUTPUT;
 600
 601         return (result & ERROR_MASK) == 0;
 602
 603 }
 604
 605
 606
 607 void Converters::buildGraph()
 608 {
 609         G_.init(formats.size());
 610         ConverterList::iterator beg = converterlist_.begin();
 611         ConverterList::iterator const end = converterlist_.end();
 612         for (ConverterList::iterator it = beg; it != end ; ++it) {
 613                 int const s = formats.getNumber(it->from);
 614                 int const t = formats.getNumber(it->to);
 615                 G_.addEdge(s,t);
 616         }
 617 }
 618
 619
 620 std::vector<Format const *> const
 621 Converters::intToFormat(std::vector<int> const & input)
 622 {
 623         vector<Format const *> result(input.size());
 624
 625         vector<int>::const_iterator it = input.begin();
 626         vector<int>::const_iterator const end = input.end();
 627         vector<Format const *>::iterator rit = result.begin();
 628         for ( ; it != end; ++it, ++rit) {
 629                 *rit = &formats.get(*it);
 630         }
 631         return result;
 632 }
 633
 634
 635 vector<Format const *> const
 636 Converters::getReachableTo(string const & target, bool const clear_visited)
 637 {
 638         vector<int> const & reachablesto =
 639                 G_.getReachableTo(formats.getNumber(target), clear_visited);
 640
 641         return intToFormat(reachablesto);
 642 }
 643
 644
 645 vector<Format const *> const
 646 Converters::getReachable(string const & from, bool const only_viewable,
 647                          bool const clear_visited)
 648 {
 649         vector<int> const & reachables =
 650                 G_.getReachable(formats.getNumber(from),
 651                                 only_viewable,
 652                                 clear_visited);
 653
 654         return intToFormat(reachables);
 655 }
 656
 657
 658 bool Converters::isReachable(string const & from, string const & to)
 659 {
 660         return G_.isReachable(formats.getNumber(from),
 661                               formats.getNumber(to));
 662 }
 663
 664
 665 Graph::EdgePath const
 666 Converters::getPath(string const & from, string const & to)
 667 {
 668         return G_.getPath(formats.getNumber(from),
 669                           formats.getNumber(to));
 670 }
 671
 672
 673 /// The global instance
 674 Converters converters;
 675
 676 // The global copy after reading lyxrc.defaults
 677 Converters system_converters;