src/insets/ExternalSupport.C

   1 /**
   2  * \file ExternalSupport.C
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Asger Alstrup Nielsen
   7  * \author Angus Leeming
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "ExternalSupport.h"
  15 #include "ExternalTemplate.h"
  16 #include "ExternalTransforms.h"
  17 #include "insetexternal.h"
  18
  19 #include "buffer.h"
  20 #include "converter.h"
  21 #include "debug.h"
  22 #include "exporter.h"
  23 #include "format.h"
  24 #include "mover.h"
  25
  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
  34 #include <boost/filesystem/operations.hpp>
  35
  36 using std::endl;
  37 using std::string;
  38 using std::vector;
  39
  40 using boost::filesystem::is_directory;
  41
  42
  43 namespace lyx {
  44
  45 using support::FileName;
  46
  47 namespace external {
  48
  49 Template const * getTemplatePtr(InsetExternalParams const & params)
  50 {
  51         TemplateManager const & etm = TemplateManager::get();
  52         return etm.getTemplateByName(params.templatename());
  53 }
  54
  55
  56 void editExternal(InsetExternalParams const & params, Buffer const & buffer)
  57 {
  58         formats.edit(buffer, params.filename,
  59                      formats.getFormatFromFile(params.filename));
  60 }
  61
  62
  63 namespace {
  64
  65 string const subst_path(string const & input,
  66                         string const & placeholder,
  67                         string const & path,
  68                         bool use_latex_path,
  69                         support::latex_path_extension ext = support::PROTECT_EXTENSION,
  70                         support::latex_path_dots dots = support::LEAVE_DOTS)
  71 {
  72         if (input.find(placeholder) == string::npos)
  73                 return input;
  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);
  80 }
  81
  82 } // namespace anon
  83
  84
  85 string const doSubstitution(InsetExternalParams const & params,
  86                             Buffer const & buffer, string const & s,
  87                             bool use_latex_path,
  88                             bool external_in_tmpdir,
  89                             Substitute what)
  90 {
  91         Buffer const * m_buffer = buffer.getMasterBuffer();
  92         string const parentpath = external_in_tmpdir ?
  93                 m_buffer->temppath() :
  94                 buffer.filePath();
  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();
 101
 102         string result = s;
 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();
 117
 118                 result = subst_path(result, "$$FPath", filepath,
 119                                     use_latex_path,
 120                                     support::PROTECT_EXTENSION,
 121                                     support::ESCAPE_DOTS);
 122                 result = subst_path(result, "$$AbsPath", abspath,
 123                                     use_latex_path,
 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);
 143                 } else {
 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);
 152                 }
 153         }
 154
 155         if (what == PATHS)
 156                 return result;
 157
 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);
 167
 168         // Handle the $$Contents(filename) syntax
 169         if (support::contains(result, "$$Contents(\"")) {
 170                 // Since use_latex_path may be true we must extract the file
 171                 // name from s instead of result and do the substitutions
 172                 // again, this time with use_latex_path false.
 173                 string::size_type const spos = s.find("$$Contents(\"");
 174                 string::size_type const send = s.find("\")", spos);
 175                 string const file_template = s.substr(spos + 12, send - (spos + 12));
 176                 string const file = doSubstitution(params, buffer,
 177                                                    file_template, false,
 178                                                    external_in_tmpdir, what);
 179                 string contents;
 180
 181                 FileName const absfile(
 182                         support::makeAbsPath(file, m_buffer->temppath()));
 183                 if (support::isFileReadable(absfile))
 184                         contents = support::getFileContents(absfile);
 185
 186                 string::size_type const pos = result.find("$$Contents(\"");
 187                 string::size_type const end = result.find("\")", pos);
 188                 result.replace(pos, end + 2, contents);
 189         }
 190
 191         return result;
 192 }
 193
 194
 195 namespace {
 196
 197 /** update the file represented by the template.
 198     If \p external_in_tmpdir == true, then the generated file is
 199     placed in the buffer's temporary directory.
 200 */
 201 void updateExternal(InsetExternalParams const & params,
 202                     string const & format,
 203                     Buffer const & buffer,
 204                     ExportData & exportdata,
 205                     bool external_in_tmpdir,
 206                     bool dryrun)
 207 {
 208         Template const * const et_ptr = getTemplatePtr(params);
 209         if (!et_ptr)
 210                 return; // FAILURE
 211         Template const & et = *et_ptr;
 212
 213         if (!et.automaticProduction)
 214                 return; // NOT_NEEDED
 215
 216         Template::Formats::const_iterator cit = et.formats.find(format);
 217         if (cit == et.formats.end())
 218                 return; // FAILURE
 219
 220         Template::Format const & outputFormat = cit->second;
 221         if (outputFormat.updateResult.empty())
 222                 return; // NOT_NEEDED
 223
 224         string from_format = et.inputFormat;
 225         if (from_format.empty())
 226                 return; // NOT_NEEDED
 227
 228         if (from_format == "*") {
 229                 if (params.filename.empty())
 230                         return; // NOT_NEEDED
 231
 232                 // Try and ascertain the file format from its contents.
 233                 from_format = formats.getFormatFromFile(params.filename);
 234                 if (from_format.empty())
 235                         return; // FAILURE
 236
 237         }
 238
 239         string const to_format = outputFormat.updateFormat;
 240         if (to_format.empty())
 241                 return; // NOT_NEEDED
 242
 243         // The master buffer. This is useful when there are multiple levels
 244         // of include files
 245         Buffer const * m_buffer = buffer.getMasterBuffer();
 246
 247         // We copy the source file to the temp dir and do the conversion
 248         // there if necessary
 249         FileName const temp_file(
 250                 support::makeAbsPath(params.filename.mangledFilename(),
 251                                      m_buffer->temppath()));
 252         if (!params.filename.empty() && !is_directory(params.filename.toFilesystemEncoding())) {
 253                 unsigned long const from_checksum = support::sum(params.filename);
 254                 unsigned long const temp_checksum = support::sum(temp_file);
 255
 256                 if (from_checksum != temp_checksum) {
 257                         Mover const & mover = getMover(from_format);
 258                         if (!mover.copy(params.filename, temp_file)) {
 259                                 lyxerr[Debug::EXTERNAL]
 260                                         << "external::updateExternal. "
 261                                         << "Unable to copy "
 262                                         << params.filename << " to " << temp_file << endl;
 263                                 return; // FAILURE
 264                         }
 265                 }
 266         }
 267
 268         // the generated file (always in the temp dir)
 269         string const to_file = doSubstitution(params, buffer,
 270                                               outputFormat.updateResult,
 271                                               false, true);
 272         FileName const abs_to_file(
 273                 support::makeAbsPath(to_file, m_buffer->temppath()));
 274
 275         if (!dryrun) {
 276                 // Record the referenced files for the exporter.
 277                 // The exporter will copy them to the export dir.
 278                 typedef Template::Format::FileMap FileMap;
 279                 FileMap::const_iterator rit  = outputFormat.referencedFiles.begin();
 280                 FileMap::const_iterator rend = outputFormat.referencedFiles.end();
 281                 for (; rit != rend; ++rit) {
 282                         vector<string>::const_iterator fit  = rit->second.begin();
 283                         vector<string>::const_iterator fend = rit->second.end();
 284                         for (; fit != fend; ++fit) {
 285                                 FileName const source(support::makeAbsPath(
 286                                                 doSubstitution(params, buffer, *fit,
 287                                                                false, true),
 288                                                 m_buffer->temppath()));
 289                                 // The path of the referenced file is never the
 290                                 // temp path, but the filename may be the mangled
 291                                 // or the real name. Therefore we substitute the
 292                                 // paths and names separately.
 293                                 string file = support::subst(*fit, "$$FName",
 294                                                 "$$FPath$$Basename$$Extension");
 295                                 file = doSubstitution(params, buffer, file, false, false,
 296                                                       PATHS);
 297                                 file = doSubstitution(params, buffer, file,
 298                                                       false, external_in_tmpdir,
 299                                                       ALL_BUT_PATHS);
 300                                 // if file is a relative name, it is interpreted
 301                                 // relative to the master document.
 302                                 exportdata.addExternalFile(rit->first, source, file);
 303                         }
 304                 }
 305         }
 306
 307         // Do we need to perform the conversion?
 308         // Yes if to_file does not exist or if from_file is newer than to_file
 309         if (support::compare_timestamps(temp_file, abs_to_file) < 0)
 310                 return; // SUCCESS
 311
 312         // FIXME (Abdel 12/08/06): Is there a need to show these errors?
 313         ErrorList el;
 314         bool const success =
 315                 theConverters().convert(&buffer, temp_file, abs_to_file,
 316                                    params.filename, from_format, to_format, el,
 317                                    Converters::try_default | Converters::try_cache);
 318
 319         if (!success)
 320                 lyxerr[Debug::EXTERNAL]
 321                         << "external::updateExternal. "
 322                         << "Unable to convert from "
 323                         << from_format << " to " << to_format << endl;
 324
 325         // return success
 326 }
 327
 328
 329 string const substituteCommands(InsetExternalParams const & params,
 330                                 string const & input, string const & format);
 331
 332 string const substituteOptions(InsetExternalParams const & params,
 333                                string const & input, string const & format);
 334
 335 } // namespace anon
 336
 337
 338 int writeExternal(InsetExternalParams const & params,
 339                   string const & format,
 340                   Buffer const & buffer, odocstream & os,
 341                   ExportData & exportdata,
 342                   bool external_in_tmpdir,
 343                   bool dryrun)
 344 {
 345         Template const * const et_ptr = getTemplatePtr(params);
 346         if (!et_ptr)
 347                 return 0;
 348         Template const & et = *et_ptr;
 349
 350         Template::Formats::const_iterator cit = et.formats.find(format);
 351         if (cit == et.formats.end()) {
 352                 lyxerr[Debug::EXTERNAL]
 353                         << "External template format '" << format
 354                         << "' not specified in template "
 355                         << params.templatename() << endl;
 356                 return 0;
 357         }
 358
 359         if (!dryrun || support::contains(cit->second.product, "$$Contents"))
 360                 updateExternal(params, format, buffer, exportdata,
 361                                external_in_tmpdir, dryrun);
 362
 363         bool const use_latex_path = format == "LaTeX";
 364         string str = doSubstitution(params, buffer, cit->second.product,
 365                                     use_latex_path, external_in_tmpdir);
 366         str = substituteCommands(params, str, format);
 367         str = substituteOptions(params, str, format);
 368         // FIXME UNICODE
 369         os << from_utf8(str);
 370         return int(lyx::count(str.begin(), str.end(),'\n'));
 371 }
 372
 373 namespace {
 374
 375 // Empty template, specialised below.
 376 template <typename TransformType>
 377 string const substituteIt(string const &,
 378                           TransformID,
 379                           string const &,
 380                           Template::Format const &,
 381                           InsetExternalParams const &);
 382
 383
 384 template <>
 385 string const substituteIt<TransformCommand>(string const & input,
 386                                             TransformID id,
 387                                             string const & /* formatname */,
 388                                             Template::Format const & format,
 389                                             InsetExternalParams const & params)
 390 {
 391         typedef std::map<TransformID, TransformStore> Transformers;
 392         Transformers::const_iterator it = format.command_transformers.find(id);
 393         if (it == format.command_transformers.end())
 394                 return input;
 395
 396         TransformStore const & store = it->second;
 397
 398         TransformCommand::ptr_type ptr;
 399         if (id == Rotate)
 400                 ptr = store.getCommandTransformer(params.rotationdata);
 401         else if (id == Resize)
 402                 ptr = store.getCommandTransformer(params.resizedata);
 403
 404         if (!ptr.get())
 405                 return input;
 406
 407         string result =
 408                 support::subst(input, ptr->front_placeholder(), ptr->front());
 409         return support::subst(result, ptr->back_placeholder(),  ptr->back());
 410 }
 411
 412
 413 template <>
 414 string const substituteIt<TransformOption>(string const & input,
 415                                            TransformID id,
 416                                            string const & fname,
 417                                            Template::Format const & format,
 418                                            InsetExternalParams const & params)
 419 {
 420         typedef std::map<TransformID, TransformStore> Transformers;
 421         Transformers::const_iterator it = format.option_transformers.find(id);
 422         if (it == format.option_transformers.end())
 423                 return input;
 424
 425         TransformStore const & store = it->second;
 426
 427         TransformOption::ptr_type ptr;
 428         switch (id) {
 429         case Clip:
 430                 ptr = store.getOptionTransformer(params.clipdata);
 431                 break;
 432         case Extra:
 433                 ptr = store.getOptionTransformer(params.extradata.get(fname));
 434                 break;
 435         case Rotate:
 436                 ptr = store.getOptionTransformer(params.rotationdata);
 437                 break;
 438         case Resize:
 439                 ptr = store.getOptionTransformer(params.resizedata);
 440                 break;
 441         }
 442
 443         if (!ptr.get())
 444                 return input;
 445
 446         return support::subst(input, ptr->placeholder(), ptr->option());
 447 }
 448
 449
 450 template <typename TransformerType>
 451 string const transformIt(InsetExternalParams const & params,
 452                          string const & s, string const & formatname)
 453 {
 454         Template const * const et = getTemplatePtr(params);
 455         if (!et || et->transformIds.empty())
 456                 return s;
 457
 458         Template::Formats::const_iterator fit = et->formats.find(formatname);
 459         if (fit == et->formats.end())
 460                 return s;
 461
 462         string result = s;
 463         Template::Format const & format =  fit->second;
 464
 465         typedef vector<TransformID> TransformsIDs;
 466         TransformsIDs::const_iterator it  = et->transformIds.begin();
 467         TransformsIDs::const_iterator end = et->transformIds.end();
 468         for (; it != end; ++it) {
 469                 result = substituteIt<TransformerType>(result, *it, formatname,
 470                                                        format, params);
 471         }
 472         return result;
 473 }
 474
 475
 476 string const substituteCommands(InsetExternalParams const & params,
 477                                 string const & input, string const & format)
 478 {
 479         return transformIt<TransformCommand>(params, input, format);
 480 }
 481
 482
 483 string const substituteOption(InsetExternalParams const & params,
 484                               string const & input, string const & format)
 485 {
 486         string opt = transformIt<TransformOption>(params, input, format);
 487
 488         if (format == "LaTeX" || format == "PDFLaTeX")
 489                 return sanitizeLatexOption(opt);
 490         if (format == "DocBook")
 491                 return sanitizeDocBookOption(opt);
 492         return opt;
 493 }
 494
 495
 496 string const substituteOptions(InsetExternalParams const & params,
 497                                string const & input, string const & format)
 498 {
 499         string output = input;
 500
 501         Template const * const et = getTemplatePtr(params);
 502         if (!et || et->transformIds.empty())
 503                 return output;
 504
 505         Template::Formats::const_iterator fit = et->formats.find(format);
 506         if (fit == et->formats.end() || fit->second.options.empty())
 507                 return output;
 508
 509         typedef vector<Template::Option> Options;
 510         Options const & options = fit->second.options;
 511         Options::const_iterator it  = options.begin();
 512         Options::const_iterator end = options.end();
 513         for (; it != end; ++it) {
 514                 string const opt = substituteOption(params, it->option, format);
 515                 string const placeholder = "$$" + it->name;
 516                 output = support::subst(output, placeholder, opt);
 517         }
 518
 519         return output;
 520 }
 521
 522 } // namespace anon
 523
 524 } // namespace external
 525
 526 } // namespace lyx