3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
8 * Full author contact details are available in file CREDITS.
15 #include "BufferParams.h"
17 #include "ServerSocket.h"
19 #include "frontends/alert.h" //to be removed?
21 #include "support/debug.h"
22 #include "support/filetools.h"
23 #include "support/gettext.h"
24 #include "support/lstrings.h"
25 #include "support/os.h"
26 #include "support/PathChanger.h"
27 #include "support/Systemcall.h"
28 #include "support/textutils.h"
29 #include "support/Translator.h"
35 // FIXME: Q_WS_MACX is not available, it's in Qt
36 #ifdef USE_MACOSX_PACKAGING
37 #include "support/linkback/LinkBackProxy.h"
45 using namespace lyx::support;
49 namespace Alert = frontend::Alert;
50 namespace os = support::os;
54 string const token_from_format("$$i");
55 string const token_path_format("$$p");
56 string const token_socket_format("$$a");
59 class FormatNamesEqual : public unary_function<Format, bool> {
61 FormatNamesEqual(string const & name)
64 bool operator()(Format const & f) const
66 return f.name() == name_;
73 class FormatExtensionsEqual : public unary_function<Format, bool> {
75 FormatExtensionsEqual(string const & extension)
76 : extension_(extension)
78 bool operator()(Format const & f) const
80 return f.hasExtension(extension_);
87 class FormatMimeEqual : public unary_function<Format, bool> {
89 FormatMimeEqual(string const & mime)
92 bool operator()(Format const & f) const
94 // The test for empty mime strings is needed since we allow
95 // formats with empty mime types.
96 return f.mime() == mime_ && !mime_.empty();
105 bool Format::formatSorter(Format const * lhs, Format const * rhs)
107 return compare_locale(_(lhs->prettyname()), _(rhs->prettyname())) < 0;
110 bool operator<(Format const & a, Format const & b)
112 return compare_locale(_(a.prettyname()), _(b.prettyname())) < 0;
116 Format::Format(string const & n, string const & e, string const & p,
117 string const & s, string const & v, string const & ed,
118 string const & m, int flags)
119 : name_(n), prettyname_(p), shortcut_(s), viewer_(v),
120 editor_(ed), mime_(m), flags_(flags)
122 extension_list_ = getVectorFromString(e, ",");
123 LYXERR(Debug::GRAPHICS, "New Format: n=" << n << ", flags=" << flags);
127 bool Format::dummy() const
129 return extension().empty();
133 string const Format::extensions() const
135 return getStringFromVector(extension_list_, ", ");
139 bool Format::hasExtension(string const & e) const
141 return (find(extension_list_.begin(), extension_list_.end(), e)
142 != extension_list_.end());
146 bool Format::isChildFormat() const
150 return isDigitASCII(name_[name_.length() - 1]);
154 string const Format::parentFormat() const
156 return name_.substr(0, name_.length() - 1);
160 void Format::setExtensions(string const & e)
162 extension_list_ = getVectorFromString(e, ",");
166 // This method should return a reference, and throw an exception
167 // if the format named name cannot be found (Lgb)
168 Format const * Formats::getFormat(string const & name) const
170 FormatList::const_iterator cit =
171 find_if(formatlist.begin(), formatlist.end(),
172 FormatNamesEqual(name));
173 if (cit != formatlist.end())
182 /** Guess the file format name (as in Format::name()) from contents.
183 * Normally you don't want to use this directly, but rather
184 * Formats::getFormatFromFile().
186 string guessFormatFromContents(FileName const & fn)
188 // the different filetypes and what they contain in one of the first lines
189 // (dots are any characters). (Herbert 20020131)
192 // EPS %!PS-Adobe-3.0 EPSF...
196 // JPG \377\330... (0xFFD8)
199 // PBM P1... or P4 (B/W)
200 // PGM P2... or P5 (Grayscale)
201 // PPM P3... or P6 (color)
202 // PS %!PS-Adobe-2.0 or 1.0, no "EPSF"!
203 // SGI \001\332... (decimal 474)
205 // TIFF II... or MM...
207 // XPM /* XPM */ sometimes missing (f.ex. tgif-export)
208 // ...static char *...
209 // XWD \000\000\000\151 (0x00006900) decimal 105
211 // GZIP \037\213 http://www.ietf.org/rfc/rfc1952.txt
212 // ZIP PK... http://www.halyava.ru/document/ind_arch.htm
213 // Z \037\235 UNIX compress
216 if (fn.empty() || !fn.isReadableFile())
219 ifstream ifs(fn.toFilesystemEncoding().c_str());
221 // Couldn't open file...
225 static string const gzipStamp = "\037\213";
228 static string const zipStamp = "PK";
230 // ZIP containers (koffice, openoffice.org etc).
231 static string const nonzipStamp = "\008\0\0\0mimetypeapplication/";
234 static string const compressStamp = "\037\235";
236 // DOS binary EPS according to Adobe TN-5002
237 static string const binEPSStamp = "\xC5\xD0\xD3\xC6";
240 // Maximum strings to read
241 int const max_count = 50;
246 bool firstLine = true;
247 bool backslash = false;
248 bool maybelatex = false;
250 while ((count++ < max_count) && format.empty() && !maybelatex) {
255 string const stamp = str.substr(0, 2);
256 if (firstLine && str.size() >= 2) {
257 // at first we check for a zipped file, because this
258 // information is saved in the first bytes of the file!
259 // also some graphic formats which save the information
260 // in the first line, too.
261 if (prefixIs(str, gzipStamp)) {
264 } else if (stamp == zipStamp &&
265 !contains(str, nonzipStamp)) {
268 } else if (stamp == compressStamp) {
272 } else if (stamp == "BM") {
275 } else if (stamp == "\377\330") {
278 } else if (stamp == "\001\332") {
280 } else if (prefixIs(str, binEPSStamp)) {
284 // Don't need to use str.at(0), str.at(1) because
285 // we already know that str.size() >= 2
286 } else if (str[0] == 'P') {
302 } else if ((stamp == "II") || (stamp == "MM")) {
305 } else if (prefixIs(str,"%TGIF")) {
308 } else if (prefixIs(str,"#FIG")) {
311 } else if (prefixIs(str,"GIF")) {
314 } else if (str.size() > 3) {
315 int const c = ((str[0] << 24) & (str[1] << 16) &
316 (str[2] << 8) & str[3]);
327 else if (contains(str,"EPSF"))
328 // dummy, if we have wrong file description like
329 // %!PS-Adobe-2.0EPSF"
332 else if (contains(str, "Grace"))
335 else if (contains(str, "%PDF"))
336 // autodetect pdf format for graphics inclusion
339 else if (contains(str, "PNG"))
342 else if (contains(str, "%!PS-Adobe")) {
345 if (contains(str,"EPSF"))
351 else if (contains(str, "_bits[]"))
354 else if (contains(str, "XPM") || contains(str, "static char *"))
357 else if (contains(str, "BITPIX"))
360 else if (contains(str, "\\documentclass") ||
361 contains(str, "\\chapter") ||
362 contains(str, "\\section") ||
363 contains(str, "\\begin") ||
364 contains(str, "\\end") ||
365 contains(str, "$$") ||
366 contains(str, "\\[") ||
367 contains(str, "\\]"))
370 if (contains(str, '\\'))
372 dollars += count_char(str, '$');
373 if (backslash && dollars > 1)
379 if (format.empty() && maybelatex && !isBinaryFile(fn))
382 if (format.empty()) {
384 LYXERR(Debug::GRAPHICS, "filetools(getFormatFromContents)\n"
385 "\tFile type not recognised before EOF!");
387 LYXERR(Debug::GRAPHICS, "Recognised Fileformat: " << format);
391 LYXERR(Debug::GRAPHICS, "filetools(getFormatFromContents)\n"
392 << "\tCouldn't find a known format!");
399 string Formats::getFormatFromFile(FileName const & filename) const
401 if (filename.empty())
406 if (filename.exists()) {
407 magic_t magic_cookie = magic_open(MAGIC_MIME);
410 if (magic_load(magic_cookie, NULL) != 0) {
411 LYXERR(Debug::GRAPHICS, "Formats::getFormatFromFile\n"
412 << "\tCouldn't load magic database - "
413 << magic_error(magic_cookie));
415 char const * result = magic_file(magic_cookie,
416 filename.toFilesystemEncoding().c_str());
419 mime = token(result, ';', 0);
421 LYXERR(Debug::GRAPHICS, "Formats::getFormatFromFile\n"
422 << "\tCouldn't query magic database - "
423 << magic_error(magic_cookie));
425 // our own detection is better for binary files (can be anything)
426 // and different plain text formats
427 if (!mime.empty() && mime != "application/octet-stream" &&
428 mime != "text/plain") {
429 Formats::const_iterator cit =
430 find_if(formatlist.begin(), formatlist.end(),
431 FormatMimeEqual(mime));
432 if (cit != formats.end()) {
433 LYXERR(Debug::GRAPHICS, "\tgot format from MIME type: "
434 << mime << " -> " << cit->name());
435 // See special eps/ps handling below
436 if (mime == "application/postscript")
437 psformat = cit->name();
439 format = cit->name();
443 magic_close(magic_cookie);
450 // libmagic does not distinguish eps and ps.
451 // Therefore we need to use our own detection here, but only if it
452 // recognizes either ps or eps. Otherwise the libmagic guess will
453 // be better (bug 9146).
454 string const format = guessFormatFromContents(filename);
455 if (!psformat.empty()) {
456 if (isPostScriptFileFormat(format))
462 string const ext = getExtension(filename.absFileName());
463 if (isZippedFileFormat(format) && !ext.empty()) {
464 string const & fmt_name = formats.getFormatFromExtension(ext);
465 if (!fmt_name.empty()) {
466 Format const * p_format = formats.getFormat(fmt_name);
467 if (p_format && p_format->zippedNative())
468 return p_format->name();
474 // try to find a format from the file extension.
475 return getFormatFromExtension(ext);
479 string Formats::getFormatFromExtension(string const & ext) const
482 // this is ambigous if two formats have the same extension,
483 // but better than nothing
484 Formats::const_iterator cit =
485 find_if(formatlist.begin(), formatlist.end(),
486 FormatExtensionsEqual(ext));
487 if (cit != formats.end()) {
488 LYXERR(Debug::GRAPHICS, "\twill guess format from file extension: "
489 << ext << " -> " << cit->name());
497 /// Used to store last timestamp of file and whether it is (was) zipped
500 std::time_t timestamp;
501 ZippedInfo(bool zipped, std::time_t timestamp)
502 : zipped(zipped), timestamp(timestamp) { }
507 /// Mapping absolute pathnames of files to their ZippedInfo metadata.
508 static std::map<std::string, ZippedInfo> zipped_;
511 bool Formats::isZippedFile(support::FileName const & filename) const {
512 string const & fname = filename.absFileName();
513 time_t timestamp = filename.lastModified();
514 map<string, ZippedInfo>::iterator it = zipped_.find(fname);
515 if (it != zipped_.end() && it->second.timestamp == timestamp)
516 return it->second.zipped;
517 string const & format = getFormatFromFile(filename);
518 bool zipped = (format == "gzip" || format == "zip");
519 zipped_.insert(make_pair(fname, ZippedInfo(zipped, timestamp)));
524 bool Formats::isZippedFileFormat(string const & format)
526 return contains("gzip zip compress", format) && !format.empty();
530 bool Formats::isPostScriptFileFormat(string const & format)
532 return format == "ps" || format == "eps";
535 static string fixCommand(string const & cmd, string const & ext,
536 os::auto_open_mode mode)
538 // configure.py says we do not want a viewer/editor
542 // Does the OS manage this format?
543 if (os::canAutoOpenFile(ext, mode))
546 // if configure.py found nothing, clear the command
547 if (token(cmd, ' ', 0) == "auto")
550 // use the command found by configure.py
555 void Formats::setAutoOpen()
557 FormatList::iterator fit = formatlist.begin();
558 FormatList::iterator const fend = formatlist.end();
559 for ( ; fit != fend ; ++fit) {
560 fit->setViewer(fixCommand(fit->viewer(), fit->extension(), os::VIEW));
561 fit->setEditor(fixCommand(fit->editor(), fit->extension(), os::EDIT));
566 int Formats::getNumber(string const & name) const
568 FormatList::const_iterator cit =
569 find_if(formatlist.begin(), formatlist.end(),
570 FormatNamesEqual(name));
571 if (cit != formatlist.end())
572 return distance(formatlist.begin(), cit);
578 void Formats::add(string const & name)
580 if (!getFormat(name))
581 add(name, name, name, string(), string(), string(),
582 string(), Format::document);
586 void Formats::add(string const & name, string const & extensions,
587 string const & prettyname, string const & shortcut,
588 string const & viewer, string const & editor,
589 string const & mime, int flags)
591 FormatList::iterator it =
592 find_if(formatlist.begin(), formatlist.end(),
593 FormatNamesEqual(name));
594 if (it == formatlist.end())
595 formatlist.push_back(Format(name, extensions, prettyname,
596 shortcut, viewer, editor, mime, flags));
598 *it = Format(name, extensions, prettyname, shortcut, viewer,
599 editor, mime, flags);
603 void Formats::erase(string const & name)
605 FormatList::iterator it =
606 find_if(formatlist.begin(), formatlist.end(),
607 FormatNamesEqual(name));
608 if (it != formatlist.end())
609 formatlist.erase(it);
615 std::sort(formatlist.begin(), formatlist.end());
619 void Formats::setViewer(string const & name, string const & command)
622 FormatList::iterator it =
623 find_if(formatlist.begin(), formatlist.end(),
624 FormatNamesEqual(name));
625 if (it != formatlist.end())
626 it->setViewer(command);
630 void Formats::setEditor(string const & name, string const & command)
633 FormatList::iterator it =
634 find_if(formatlist.begin(), formatlist.end(),
635 FormatNamesEqual(name));
636 if (it != formatlist.end())
637 it->setEditor(command);
641 bool Formats::view(Buffer const & buffer, FileName const & filename,
642 string const & format_name) const
644 if (filename.empty() || !filename.exists()) {
645 Alert::error(_("Cannot view file"),
646 bformat(_("File does not exist: %1$s"),
647 from_utf8(filename.absFileName())));
651 Format const * format = getFormat(format_name);
652 if (format && format->viewer().empty() &&
653 format->isChildFormat())
654 format = getFormat(format->parentFormat());
655 if (!format || format->viewer().empty()) {
656 // FIXME: I believe this is the wrong place to show alerts, it should be done
657 // by the caller (this should be "utility" code)
658 Alert::error(_("Cannot view file"),
659 bformat(_("No information for viewing %1$s"),
660 prettyName(format_name)));
664 if (format->viewer() == "auto") {
665 if (os::autoOpenFile(filename.absFileName(), os::VIEW, buffer.filePath()))
668 Alert::error(_("Cannot view file"),
669 bformat(_("Auto-view file %1$s failed"),
670 from_utf8(filename.absFileName())));
675 string command = format->viewer();
677 if (format_name == "dvi" &&
678 !lyxrc.view_dvi_paper_option.empty()) {
679 string paper_size = buffer.params().paperSizeName(BufferParams::XDVI);
680 if (!paper_size.empty()) {
681 command += ' ' + lyxrc.view_dvi_paper_option;
682 command += ' ' + paper_size;
683 if (buffer.params().orientation == ORIENTATION_LANDSCAPE &&
684 buffer.params().papersize != PAPER_CUSTOM)
689 if (!contains(command, token_from_format))
690 command += ' ' + token_from_format;
692 command = subst(command, token_from_format, quoteName(onlyFileName(filename.toFilesystemEncoding())));
693 command = subst(command, token_path_format, quoteName(onlyPath(filename.toFilesystemEncoding())));
694 command = subst(command, token_socket_format, quoteName(theServerSocket().address()));
695 LYXERR(Debug::FILES, "Executing command: " << command);
696 // FIXME UNICODE utf8 can be wrong for files
697 buffer.message(_("Executing command: ") + from_utf8(command));
699 PathChanger p(filename.onlyPath());
701 one.startscript(Systemcall::DontWait, command, buffer.filePath());
703 // we can't report any sort of error, since we aren't waiting
708 bool Formats::edit(Buffer const & buffer, FileName const & filename,
709 string const & format_name) const
711 if (filename.empty() || !filename.exists()) {
712 Alert::error(_("Cannot edit file"),
713 bformat(_("File does not exist: %1$s"),
714 from_utf8(filename.absFileName())));
718 // LinkBack files look like PDF, but have the .linkback extension
719 string const ext = getExtension(filename.absFileName());
720 if (format_name == "pdf6" && ext == "linkback") {
721 #ifdef USE_MACOSX_PACKAGING
722 return editLinkBackFile(filename.absFileName().c_str());
724 Alert::error(_("Cannot edit file"),
725 _("LinkBack files can only be edited on Apple Mac OSX."));
727 #endif // USE_MACOSX_PACKAGING
730 Format const * format = getFormat(format_name);
731 if (format && format->editor().empty() &&
732 format->isChildFormat())
733 format = getFormat(format->parentFormat());
734 if (!format || format->editor().empty()) {
735 // FIXME: I believe this is the wrong place to show alerts, it should
736 // be done by the caller (this should be "utility" code)
737 Alert::error(_("Cannot edit file"),
738 bformat(_("No information for editing %1$s"),
739 prettyName(format_name)));
744 if (format->editor() == "auto") {
745 if (os::autoOpenFile(filename.absFileName(), os::EDIT, buffer.filePath()))
748 Alert::error(_("Cannot edit file"),
749 bformat(_("Auto-edit file %1$s failed"),
750 from_utf8(filename.absFileName())));
755 string command = format->editor();
757 if (!contains(command, token_from_format))
758 command += ' ' + token_from_format;
760 command = subst(command, token_from_format, quoteName(filename.toFilesystemEncoding()));
761 command = subst(command, token_path_format, quoteName(onlyPath(filename.toFilesystemEncoding())));
762 command = subst(command, token_socket_format, quoteName(theServerSocket().address()));
763 LYXERR(Debug::FILES, "Executing command: " << command);
764 // FIXME UNICODE utf8 can be wrong for files
765 buffer.message(_("Executing command: ") + from_utf8(command));
768 one.startscript(Systemcall::DontWait, command, buffer.filePath());
770 // we can't report any sort of error, since we aren't waiting
775 docstring const Formats::prettyName(string const & name) const
777 Format const * format = getFormat(name);
779 return from_utf8(format->prettyname());
781 return from_utf8(name);
785 string const Formats::extension(string const & name) const
787 Format const * format = getFormat(name);
789 return format->extension();
795 string const Formats::extensions(string const & name) const
797 Format const * format = getFormat(name);
799 return format->extensions();
807 typedef Translator<OutputParams::FLAVOR, string> FlavorTranslator;
810 FlavorTranslator initFlavorTranslator()
812 FlavorTranslator f(OutputParams::LATEX, "latex");
813 f.addPair(OutputParams::DVILUATEX, "dviluatex");
814 f.addPair(OutputParams::LUATEX, "luatex");
815 f.addPair(OutputParams::PDFLATEX, "pdflatex");
816 f.addPair(OutputParams::XETEX, "xetex");
817 f.addPair(OutputParams::XML, "docbook-xml");
818 f.addPair(OutputParams::HTML, "xhtml");
819 f.addPair(OutputParams::TEXT, "text");
824 FlavorTranslator const & flavorTranslator()
826 static FlavorTranslator const translator = initFlavorTranslator();
833 std::string flavor2format(OutputParams::FLAVOR flavor)
835 return flavorTranslator().find(flavor);
839 /* Not currently needed, but I'll leave the code in case it is.
840 OutputParams::FLAVOR format2flavor(std::string fmt)
842 return flavorTranslator().find(fmt);
847 Formats system_formats;