2 * \file ExternalSupport.C
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Asger Alstrup Nielsen
7 * \author Angus Leeming
9 * Full author contact details are available in file CREDITS.
14 #include "ExternalSupport.h"
15 #include "ExternalTemplate.h"
16 #include "ExternalTransforms.h"
17 #include "insetexternal.h"
20 #include "converter.h"
26 #include "support/filetools.h"
27 #include "support/forkedcall.h"
28 #include "support/lstrings.h"
29 #include "support/lyxalgo.h"
30 #include "support/lyxlib.h"
31 #include "support/os.h"
32 #include "support/package.h"
34 #include <boost/filesystem/operations.hpp>
40 using boost::filesystem::is_directory;
45 using support::FileName;
49 Template const * getTemplatePtr(InsetExternalParams const & params)
51 TemplateManager const & etm = TemplateManager::get();
52 return etm.getTemplateByName(params.templatename());
56 void editExternal(InsetExternalParams const & params, Buffer const & buffer)
58 formats.edit(buffer, params.filename,
59 formats.getFormatFromFile(params.filename));
65 string const subst_path(string const & input,
66 string const & placeholder,
69 support::latex_path_extension ext = support::PROTECT_EXTENSION,
70 support::latex_path_dots dots = support::LEAVE_DOTS)
72 if (input.find(placeholder) == string::npos)
74 // Don't use external_path here when use_latex_path is false, as the
75 // path will be compared with another one in internal style later
76 // in Converters::move.
77 string const path2 = use_latex_path ?
78 support::latex_path(path, ext, dots) : path;
79 return support::subst(input, placeholder, path2);
85 string const doSubstitution(InsetExternalParams const & params,
86 Buffer const & buffer, string const & s,
88 bool external_in_tmpdir,
91 Buffer const * m_buffer = buffer.getMasterBuffer();
92 string const parentpath = external_in_tmpdir ?
93 m_buffer->temppath() :
95 string const filename = external_in_tmpdir ?
96 params.filename.mangledFilename() :
97 params.filename.outputFilename(parentpath);
98 string const basename = support::changeExtension(
99 support::onlyFilename(filename), string());
100 string const absname = support::makeAbsPath(filename, parentpath).absFilename();
103 if (what != ALL_BUT_PATHS) {
104 string const filepath = support::onlyPath(filename);
105 string const abspath = support::onlyPath(absname);
106 string const masterpath = external_in_tmpdir ?
107 m_buffer->temppath() :
108 m_buffer->filePath();
109 string relToMasterPath = support::onlyPath(
110 support::makeRelPath(absname, masterpath));
111 if (relToMasterPath == "./")
112 relToMasterPath.clear();
113 string relToParentPath = support::onlyPath(
114 support::makeRelPath(absname, parentpath));
115 if (relToParentPath == "./")
116 relToParentPath.clear();
118 result = subst_path(result, "$$FPath", filepath,
120 support::PROTECT_EXTENSION,
121 support::ESCAPE_DOTS);
122 result = subst_path(result, "$$AbsPath", abspath,
124 support::PROTECT_EXTENSION,
125 support::ESCAPE_DOTS);
126 result = subst_path(result, "$$RelPathMaster",
127 relToMasterPath, use_latex_path,
128 support::PROTECT_EXTENSION,
129 support::ESCAPE_DOTS);
130 result = subst_path(result, "$$RelPathParent",
131 relToParentPath, use_latex_path,
132 support::PROTECT_EXTENSION,
133 support::ESCAPE_DOTS);
134 if (support::absolutePath(filename)) {
135 result = subst_path(result, "$$AbsOrRelPathMaster",
136 abspath, use_latex_path,
137 support::PROTECT_EXTENSION,
138 support::ESCAPE_DOTS);
139 result = subst_path(result, "$$AbsOrRelPathParent",
140 abspath, use_latex_path,
141 support::PROTECT_EXTENSION,
142 support::ESCAPE_DOTS);
144 result = subst_path(result, "$$AbsOrRelPathMaster",
145 relToMasterPath, use_latex_path,
146 support::PROTECT_EXTENSION,
147 support::ESCAPE_DOTS);
148 result = subst_path(result, "$$AbsOrRelPathParent",
149 relToParentPath, use_latex_path,
150 support::PROTECT_EXTENSION,
151 support::ESCAPE_DOTS);
158 result = subst_path(result, "$$FName", filename, use_latex_path,
159 support::EXCLUDE_EXTENSION);
160 result = subst_path(result, "$$Basename", basename, use_latex_path,
161 support::PROTECT_EXTENSION, support::ESCAPE_DOTS);
162 result = subst_path(result, "$$Extension",
163 '.' + support::getExtension(filename), use_latex_path);
164 result = subst_path(result, "$$Tempname", params.tempname().absFilename(), use_latex_path);
165 result = subst_path(result, "$$Sysdir",
166 support::package().system_support(), use_latex_path);
168 // Handle the $$Contents(filename) syntax
169 if (support::contains(result, "$$Contents(\"")) {
171 string::size_type const pos = result.find("$$Contents(\"");
172 string::size_type const end = result.find("\")", pos);
173 string const file = result.substr(pos + 12, end - (pos + 12));
176 FileName const absfile(
177 support::makeAbsPath(file, m_buffer->temppath()));
178 if (support::isFileReadable(absfile))
179 contents = support::getFileContents(absfile);
181 result = support::subst(result,
182 ("$$Contents(\"" + file + "\")").c_str(),
192 /** update the file represented by the template.
193 If \p external_in_tmpdir == true, then the generated file is
194 placed in the buffer's temporary directory.
196 void updateExternal(InsetExternalParams const & params,
197 string const & format,
198 Buffer const & buffer,
199 ExportData & exportdata,
200 bool external_in_tmpdir,
203 Template const * const et_ptr = getTemplatePtr(params);
206 Template const & et = *et_ptr;
208 if (!et.automaticProduction)
209 return; // NOT_NEEDED
211 Template::Formats::const_iterator cit = et.formats.find(format);
212 if (cit == et.formats.end())
215 Template::Format const & outputFormat = cit->second;
216 if (outputFormat.updateResult.empty())
217 return; // NOT_NEEDED
219 string from_format = et.inputFormat;
220 if (from_format.empty())
221 return; // NOT_NEEDED
223 if (from_format == "*") {
224 if (params.filename.empty())
225 return; // NOT_NEEDED
227 // Try and ascertain the file format from its contents.
228 from_format = formats.getFormatFromFile(params.filename);
229 if (from_format.empty())
234 string const to_format = outputFormat.updateFormat;
235 if (to_format.empty())
236 return; // NOT_NEEDED
238 if (!theConverters().isReachable(from_format, to_format)) {
239 lyxerr[Debug::EXTERNAL]
240 << "external::updateExternal. "
241 << "Unable to convert from "
242 << from_format << " to " << to_format << endl;
246 // The master buffer. This is useful when there are multiple levels
248 Buffer const * m_buffer = buffer.getMasterBuffer();
250 // We copy the source file to the temp dir and do the conversion
251 // there if necessary
252 FileName const temp_file(
253 support::makeAbsPath(params.filename.mangledFilename(),
254 m_buffer->temppath()));
255 if (!params.filename.empty() && !is_directory(params.filename.toFilesystemEncoding())) {
256 unsigned long const from_checksum = support::sum(params.filename);
257 unsigned long const temp_checksum = support::sum(temp_file);
259 if (from_checksum != temp_checksum) {
260 Mover const & mover = getMover(from_format);
261 if (!mover.copy(params.filename, temp_file)) {
262 lyxerr[Debug::EXTERNAL]
263 << "external::updateExternal. "
265 << params.filename << " to " << temp_file << endl;
271 // the generated file (always in the temp dir)
272 string const to_file = doSubstitution(params, buffer,
273 outputFormat.updateResult,
275 FileName const abs_to_file(
276 support::makeAbsPath(to_file, m_buffer->temppath()));
279 // Record the referenced files for the exporter.
280 // The exporter will copy them to the export dir.
281 typedef Template::Format::FileMap FileMap;
282 FileMap::const_iterator rit = outputFormat.referencedFiles.begin();
283 FileMap::const_iterator rend = outputFormat.referencedFiles.end();
284 for (; rit != rend; ++rit) {
285 vector<string>::const_iterator fit = rit->second.begin();
286 vector<string>::const_iterator fend = rit->second.end();
287 for (; fit != fend; ++fit) {
288 FileName const source(support::makeAbsPath(
289 doSubstitution(params, buffer, *fit,
291 m_buffer->temppath()));
292 // The path of the referenced file is never the
293 // temp path, but the filename may be the mangled
294 // or the real name. Therefore we substitute the
295 // paths and names separately.
296 string file = support::subst(*fit, "$$FName",
297 "$$FPath$$Basename$$Extension");
298 file = doSubstitution(params, buffer, file, false, false,
300 file = doSubstitution(params, buffer, file,
301 false, external_in_tmpdir,
303 // if file is a relative name, it is interpreted
304 // relative to the master document.
305 exportdata.addExternalFile(rit->first, source, file);
310 // Do we need to perform the conversion?
311 // Yes if to_file does not exist or if from_file is newer than to_file
312 if (support::compare_timestamps(temp_file, abs_to_file) < 0)
315 // FIXME (Abdel 12/08/06): Is there a need to show these errors?
317 /* bool const success = */
318 theConverters().convert(&buffer, temp_file, abs_to_file,
319 params.filename, from_format, to_format, el,
320 Converters::try_default | Converters::try_cache);
325 string const substituteCommands(InsetExternalParams const & params,
326 string const & input, string const & format);
328 string const substituteOptions(InsetExternalParams const & params,
329 string const & input, string const & format);
334 int writeExternal(InsetExternalParams const & params,
335 string const & format,
336 Buffer const & buffer, odocstream & os,
337 ExportData & exportdata,
338 bool external_in_tmpdir,
341 Template const * const et_ptr = getTemplatePtr(params);
344 Template const & et = *et_ptr;
346 Template::Formats::const_iterator cit = et.formats.find(format);
347 if (cit == et.formats.end()) {
348 lyxerr[Debug::EXTERNAL]
349 << "External template format '" << format
350 << "' not specified in template "
351 << params.templatename() << endl;
355 if (!dryrun || support::contains(cit->second.product, "$$Contents"))
356 updateExternal(params, format, buffer, exportdata,
357 external_in_tmpdir, dryrun);
359 bool const use_latex_path = format == "LaTeX";
360 string str = doSubstitution(params, buffer, cit->second.product,
361 use_latex_path, external_in_tmpdir);
362 str = substituteCommands(params, str, format);
363 str = substituteOptions(params, str, format);
365 os << from_utf8(str);
366 return int(lyx::count(str.begin(), str.end(),'\n'));
371 // Empty template, specialised below.
372 template <typename TransformType>
373 string const substituteIt(string const &,
376 Template::Format const &,
377 InsetExternalParams const &);
381 string const substituteIt<TransformCommand>(string const & input,
383 string const & /* formatname */,
384 Template::Format const & format,
385 InsetExternalParams const & params)
387 typedef std::map<TransformID, TransformStore> Transformers;
388 Transformers::const_iterator it = format.command_transformers.find(id);
389 if (it == format.command_transformers.end())
392 TransformStore const & store = it->second;
394 TransformCommand::ptr_type ptr;
396 ptr = store.getCommandTransformer(params.rotationdata);
397 else if (id == Resize)
398 ptr = store.getCommandTransformer(params.resizedata);
404 support::subst(input, ptr->front_placeholder(), ptr->front());
405 return support::subst(result, ptr->back_placeholder(), ptr->back());
410 string const substituteIt<TransformOption>(string const & input,
412 string const & fname,
413 Template::Format const & format,
414 InsetExternalParams const & params)
416 typedef std::map<TransformID, TransformStore> Transformers;
417 Transformers::const_iterator it = format.option_transformers.find(id);
418 if (it == format.option_transformers.end())
421 TransformStore const & store = it->second;
423 TransformOption::ptr_type ptr;
426 ptr = store.getOptionTransformer(params.clipdata);
429 ptr = store.getOptionTransformer(params.extradata.get(fname));
432 ptr = store.getOptionTransformer(params.rotationdata);
435 ptr = store.getOptionTransformer(params.resizedata);
442 return support::subst(input, ptr->placeholder(), ptr->option());
446 template <typename TransformerType>
447 string const transformIt(InsetExternalParams const & params,
448 string const & s, string const & formatname)
450 Template const * const et = getTemplatePtr(params);
451 if (!et || et->transformIds.empty())
454 Template::Formats::const_iterator fit = et->formats.find(formatname);
455 if (fit == et->formats.end())
459 Template::Format const & format = fit->second;
461 typedef vector<TransformID> TransformsIDs;
462 TransformsIDs::const_iterator it = et->transformIds.begin();
463 TransformsIDs::const_iterator end = et->transformIds.end();
464 for (; it != end; ++it) {
465 result = substituteIt<TransformerType>(result, *it, formatname,
472 string const substituteCommands(InsetExternalParams const & params,
473 string const & input, string const & format)
475 return transformIt<TransformCommand>(params, input, format);
479 string const substituteOption(InsetExternalParams const & params,
480 string const & input, string const & format)
482 string opt = transformIt<TransformOption>(params, input, format);
484 if (format == "LaTeX" || format == "PDFLaTeX")
485 return sanitizeLatexOption(opt);
486 if (format == "DocBook")
487 return sanitizeDocBookOption(opt);
492 string const substituteOptions(InsetExternalParams const & params,
493 string const & input, string const & format)
495 string output = input;
497 Template const * const et = getTemplatePtr(params);
498 if (!et || et->transformIds.empty())
501 Template::Formats::const_iterator fit = et->formats.find(format);
502 if (fit == et->formats.end() || fit->second.options.empty())
505 typedef vector<Template::Option> Options;
506 Options const & options = fit->second.options;
507 Options::const_iterator it = options.begin();
508 Options::const_iterator end = options.end();
509 for (; it != end; ++it) {
510 string const opt = substituteOption(params, it->option, format);
511 string const placeholder = "$$" + it->name;
512 output = support::subst(output, placeholder, opt);
520 } // namespace external