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"
33 #include "support/path.h"
35 #include "support/std_ostream.h"
37 namespace support = lyx::support;
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 string const file_with_path = params.filename.absFilename();
59 formats.edit(buffer, file_with_path,
60 formats.getFormatFromFile(file_with_path));
66 string const subst_path(string const & input,
67 string const & placeholder,
70 support::latex_path_extension ext = support::PROTECT_EXTENSION,
71 support::latex_path_dots dots = support::LEAVE_DOTS)
73 if (input.find(placeholder) == string::npos)
75 string const path2 = use_latex_path ?
76 support::latex_path(path, ext, dots) :
77 support::os::external_path(path);
78 return support::subst(input, placeholder, path2);
84 string const doSubstitution(InsetExternalParams const & params,
85 Buffer const & buffer, string const & s,
87 bool external_in_tmpdir,
90 Buffer const * m_buffer = buffer.getMasterBuffer();
91 string const parentpath = external_in_tmpdir ?
92 m_buffer->temppath() :
94 string const filename = external_in_tmpdir ?
95 params.filename.mangledFilename() :
96 params.filename.outputFilename(parentpath);
97 string const basename = support::changeExtension(
98 support::onlyFilename(filename), string());
99 string const absname = support::makeAbsPath(filename, parentpath);
102 if (what != ALL_BUT_PATHS) {
103 string const filepath = support::onlyPath(filename);
104 string const abspath = support::onlyPath(absname);
105 string const masterpath = external_in_tmpdir ?
106 m_buffer->temppath() :
107 m_buffer->filePath();
108 string relToMasterPath = support::onlyPath(
109 support::makeRelPath(absname, masterpath));
110 if (relToMasterPath == "./")
111 relToMasterPath.clear();
112 string relToParentPath = support::onlyPath(
113 support::makeRelPath(absname, parentpath));
114 if (relToParentPath == "./")
115 relToParentPath.clear();
117 result = subst_path(result, "$$FPath", filepath,
119 support::PROTECT_EXTENSION,
120 support::ESCAPE_DOTS);
121 result = subst_path(result, "$$AbsPath", abspath,
123 support::PROTECT_EXTENSION,
124 support::ESCAPE_DOTS);
125 result = subst_path(result, "$$RelPathMaster",
126 relToMasterPath, use_latex_path,
127 support::PROTECT_EXTENSION,
128 support::ESCAPE_DOTS);
129 result = subst_path(result, "$$RelPathParent",
130 relToParentPath, use_latex_path,
131 support::PROTECT_EXTENSION,
132 support::ESCAPE_DOTS);
133 if (support::absolutePath(filename)) {
134 result = subst_path(result, "$$AbsOrRelPathMaster",
135 abspath, use_latex_path,
136 support::PROTECT_EXTENSION,
137 support::ESCAPE_DOTS);
138 result = subst_path(result, "$$AbsOrRelPathParent",
139 abspath, use_latex_path,
140 support::PROTECT_EXTENSION,
141 support::ESCAPE_DOTS);
143 result = subst_path(result, "$$AbsOrRelPathMaster",
144 relToMasterPath, use_latex_path,
145 support::PROTECT_EXTENSION,
146 support::ESCAPE_DOTS);
147 result = subst_path(result, "$$AbsOrRelPathParent",
148 relToParentPath, use_latex_path,
149 support::PROTECT_EXTENSION,
150 support::ESCAPE_DOTS);
157 result = subst_path(result, "$$FName", filename, use_latex_path,
158 support::EXCLUDE_EXTENSION);
159 result = subst_path(result, "$$Basename", basename, use_latex_path,
160 support::PROTECT_EXTENSION, support::ESCAPE_DOTS);
161 result = subst_path(result, "$$Extension",
162 '.' + support::getExtension(filename), use_latex_path);
163 result = subst_path(result, "$$Tempname", params.tempname(), use_latex_path);
164 result = subst_path(result, "$$Sysdir",
165 support::package().system_support(), use_latex_path);
167 // Handle the $$Contents(filename) syntax
168 if (support::contains(result, "$$Contents(\"")) {
170 string::size_type const pos = result.find("$$Contents(\"");
171 string::size_type const end = result.find("\")", pos);
172 string const file = result.substr(pos + 12, end - (pos + 12));
175 string const filepath = support::isFileReadable(file) ?
176 buffer.filePath() : m_buffer->temppath();
177 support::Path p(filepath);
179 if (support::isFileReadable(file))
180 contents = support::getFileContents(file);
182 result = support::subst(result,
183 ("$$Contents(\"" + file + "\")").c_str(),
193 /** update the file represented by the template.
194 If \p external_in_tmpdir == true, then the generated file is
195 placed in the buffer's temporary directory.
197 void updateExternal(InsetExternalParams const & params,
198 string const & format,
199 Buffer const & buffer,
200 ExportData & exportdata,
201 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 string abs_from_file = params.filename.absFilename();
225 if (from_format == "*") {
226 if (abs_from_file.empty())
227 return; // NOT_NEEDED
229 // Try and ascertain the file format from its contents.
230 from_format = formats.getFormatFromFile(abs_from_file);
231 if (from_format.empty())
236 string const to_format = outputFormat.updateFormat;
237 if (to_format.empty())
238 return; // NOT_NEEDED
240 if (!converters.isReachable(from_format, to_format)) {
241 lyxerr[Debug::EXTERNAL]
242 << "external::updateExternal. "
243 << "Unable to convert from "
244 << from_format << " to " << to_format << endl;
248 // The master buffer. This is useful when there are multiple levels
250 Buffer const * m_buffer = buffer.getMasterBuffer();
252 // We copy the source file to the temp dir and do the conversion
253 // there if necessary
254 string const temp_file =
255 support::makeAbsPath(params.filename.mangledFilename(),
256 m_buffer->temppath());
257 if (!abs_from_file.empty()) {
258 unsigned long const from_checksum = support::sum(abs_from_file);
259 unsigned long const temp_checksum = support::sum(temp_file);
261 if (from_checksum != temp_checksum) {
262 Mover const & mover = movers(from_format);
263 if (!mover.copy(abs_from_file, temp_file)) {
264 lyxerr[Debug::EXTERNAL]
265 << "external::updateExternal. "
267 << abs_from_file << " to " << temp_file << endl;
273 // the generated file (always in the temp dir)
274 string const to_file = doSubstitution(params, buffer,
275 outputFormat.updateResult,
277 string const abs_to_file =
278 support::makeAbsPath(to_file, m_buffer->temppath());
280 // Record the referenced files for the exporter.
281 // The exporter will copy them to the export dir.
282 typedef Template::Format::FileMap FileMap;
283 FileMap::const_iterator rit = outputFormat.referencedFiles.begin();
284 FileMap::const_iterator rend = outputFormat.referencedFiles.end();
285 for (; rit != rend; ++rit) {
286 vector<string>::const_iterator fit = rit->second.begin();
287 vector<string>::const_iterator fend = rit->second.end();
288 for (; fit != fend; ++fit) {
289 string const source = support::makeAbsPath(
290 doSubstitution(params, buffer, *fit,
292 m_buffer->temppath());
293 // The path of the referenced file is never the
294 // temp path, but the filename may be the mangled
295 // or the real name. Therefore we substitute the
296 // paths and names separately.
297 string file = support::subst(*fit, "$$FName",
298 "$$FPath$$Basename$$Extension");
299 file = doSubstitution(params, buffer, file, false, false,
301 file = doSubstitution(params, buffer, file,
302 false, external_in_tmpdir,
304 // if file is a relative name, it is interpreted
305 // relative to the master document.
306 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)
314 string const to_file_base =
315 support::changeExtension(to_file, string());
316 /* bool const success = */
317 converters.convert(&buffer, temp_file, to_file_base,
318 from_format, to_format, true);
323 string const substituteCommands(InsetExternalParams const & params,
324 string const & input, string const & format);
326 string const substituteOptions(InsetExternalParams const & params,
327 string const & input, string const & format);
332 int writeExternal(InsetExternalParams const & params,
333 string const & format,
334 Buffer const & buffer, ostream & os,
335 ExportData & exportdata,
336 bool external_in_tmpdir,
337 bool external_in_comment)
339 Template const * const et_ptr = getTemplatePtr(params);
342 Template const & et = *et_ptr;
344 Template::Formats::const_iterator cit = et.formats.find(format);
345 if (cit == et.formats.end()) {
346 lyxerr[Debug::EXTERNAL]
347 << "External template format '" << format
348 << "' not specified in template "
349 << params.templatename() << endl;
353 if (!external_in_comment)
354 updateExternal(params, format, buffer, exportdata,
357 bool const use_latex_path = format == "LaTeX";
358 string str = doSubstitution(params, buffer, cit->second.product,
359 use_latex_path, external_in_tmpdir);
360 str = substituteCommands(params, str, format);
361 str = substituteOptions(params, str, format);
363 return int(lyx::count(str.begin(), str.end(),'\n'));
368 // Empty template, specialised below.
369 template <typename TransformType>
370 string const substituteIt(string const &,
373 Template::Format const &,
374 InsetExternalParams const &);
378 string const substituteIt<TransformCommand>(string const & input,
380 string const & /* formatname */,
381 Template::Format const & format,
382 InsetExternalParams const & params)
384 typedef std::map<TransformID, TransformStore> Transformers;
385 Transformers::const_iterator it = format.command_transformers.find(id);
386 if (it == format.command_transformers.end())
389 TransformStore const & store = it->second;
391 TransformCommand::ptr_type ptr;
393 ptr = store.getCommandTransformer(params.rotationdata);
394 else if (id == Resize)
395 ptr = store.getCommandTransformer(params.resizedata);
401 support::subst(input, ptr->front_placeholder(), ptr->front());
402 return support::subst(result, ptr->back_placeholder(), ptr->back());
407 string const substituteIt<TransformOption>(string const & input,
409 string const & fname,
410 Template::Format const & format,
411 InsetExternalParams const & params)
413 typedef std::map<TransformID, TransformStore> Transformers;
414 Transformers::const_iterator it = format.option_transformers.find(id);
415 if (it == format.option_transformers.end())
418 TransformStore const & store = it->second;
420 TransformOption::ptr_type ptr;
423 ptr = store.getOptionTransformer(params.clipdata);
426 ptr = store.getOptionTransformer(params.extradata.get(fname));
429 ptr = store.getOptionTransformer(params.rotationdata);
432 ptr = store.getOptionTransformer(params.resizedata);
439 return support::subst(input, ptr->placeholder(), ptr->option());
443 template <typename TransformerType>
444 string const transformIt(InsetExternalParams const & params,
445 string const & s, string const & formatname)
447 Template const * const et = getTemplatePtr(params);
448 if (!et || et->transformIds.empty())
451 Template::Formats::const_iterator fit = et->formats.find(formatname);
452 if (fit == et->formats.end())
456 Template::Format const & format = fit->second;
458 typedef vector<TransformID> TransformsIDs;
459 TransformsIDs::const_iterator it = et->transformIds.begin();
460 TransformsIDs::const_iterator end = et->transformIds.end();
461 for (; it != end; ++it) {
462 result = substituteIt<TransformerType>(result, *it, formatname,
469 string const substituteCommands(InsetExternalParams const & params,
470 string const & input, string const & format)
472 return transformIt<TransformCommand>(params, input, format);
476 string const substituteOption(InsetExternalParams const & params,
477 string const & input, string const & format)
479 string opt = transformIt<TransformOption>(params, input, format);
481 if (format == "LaTeX" || format == "PDFLaTeX")
482 return sanitizeLatexOption(opt);
483 if (format == "DocBook")
484 return sanitizeDocBookOption(opt);
485 if (format == "LinuxDoc")
486 return sanitizeLinuxDocOption(opt);
491 string const substituteOptions(InsetExternalParams const & params,
492 string const & input, string const & format)
494 string output = input;
496 Template const * const et = getTemplatePtr(params);
497 if (!et || et->transformIds.empty())
500 Template::Formats::const_iterator fit = et->formats.find(format);
501 if (fit == et->formats.end() || fit->second.options.empty())
504 typedef vector<Template::Option> Options;
505 Options const & options = fit->second.options;
506 Options::const_iterator it = options.begin();
507 Options::const_iterator end = options.end();
508 for (; it != end; ++it) {
509 string const opt = substituteOption(params, it->option, format);
510 string const placeholder = "$$" + it->name;
511 output = support::subst(output, placeholder, opt);
519 } // namespace external