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