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 #include "support/path.h"
  34
  35 #include "support/std_ostream.h"
  36
  37 namespace support = lyx::support;
  38
  39 using std::endl;
  40
  41 using std::ostream;
  42 using std::string;
  43 using std::vector;
  44
  45
  46 namespace lyx {
  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         string const file_with_path = params.filename.absFilename();
  59         formats.edit(buffer, file_with_path,
  60                      formats.getFormatFromFile(file_with_path));
  61 }
  62
  63
  64 namespace {
  65
  66 string const subst_path(string const & input,
  67                         string const & placeholder,
  68                         string const & path,
  69                         bool use_latex_path,
  70                         support::latex_path_extension ext = support::PROTECT_EXTENSION,
  71                         support::latex_path_dots dots = support::LEAVE_DOTS)
  72 {
  73         if (input.find(placeholder) == string::npos)
  74                 return input;
  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);
  79 }
  80
  81 } // namespace anon
  82
  83
  84 string const doSubstitution(InsetExternalParams const & params,
  85                             Buffer const & buffer, string const & s,
  86                             bool use_latex_path,
  87                             bool external_in_tmpdir,
  88                             Substitute what)
  89 {
  90         Buffer const * m_buffer = buffer.getMasterBuffer();
  91         string const parentpath = external_in_tmpdir ?
  92                 m_buffer->temppath() :
  93                 buffer.filePath();
  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);
 100
 101         string result = s;
 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();
 116
 117                 result = subst_path(result, "$$FPath", filepath,
 118                                     use_latex_path,
 119                                     support::PROTECT_EXTENSION,
 120                                     support::ESCAPE_DOTS);
 121                 result = subst_path(result, "$$AbsPath", abspath,
 122                                     use_latex_path,
 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);
 142                 } else {
 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);
 151                 }
 152         }
 153
 154         if (what == PATHS)
 155                 return result;
 156
 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);
 166
 167         // Handle the $$Contents(filename) syntax
 168         if (support::contains(result, "$$Contents(\"")) {
 169
 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));
 173                 string contents;
 174
 175                 string const filepath = support::IsFileReadable(file) ?
 176                         buffer.filePath() : m_buffer->temppath();
 177                 support::Path p(filepath);
 178
 179                 if (support::IsFileReadable(file))
 180                         contents = support::GetFileContents(file);
 181
 182                 result = support::subst(result,
 183                                         ("$$Contents(\"" + file + "\")").c_str(),
 184                                         contents);
 185         }
 186
 187         return result;
 188 }
 189
 190
 191 namespace {
 192
 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.
 196 */
 197 void updateExternal(InsetExternalParams const & params,
 198                     string const & format,
 199                     Buffer const & buffer,
 200                     ExportData & exportdata,
 201                     bool external_in_tmpdir)
 202 {
 203         Template const * const et_ptr = getTemplatePtr(params);
 204         if (!et_ptr)
 205                 return; // FAILURE
 206         Template const & et = *et_ptr;
 207
 208         if (!et.automaticProduction)
 209                 return; // NOT_NEEDED
 210
 211         Template::Formats::const_iterator cit = et.formats.find(format);
 212         if (cit == et.formats.end())
 213                 return; // FAILURE
 214
 215         Template::Format const & outputFormat = cit->second;
 216         if (outputFormat.updateResult.empty())
 217                 return; // NOT_NEEDED
 218
 219         string from_format = et.inputFormat;
 220         if (from_format.empty())
 221                 return; // NOT_NEEDED
 222
 223         string abs_from_file = params.filename.absFilename();
 224
 225         if (from_format == "*") {
 226                 if (abs_from_file.empty())
 227                         return; // NOT_NEEDED
 228
 229                 // Try and ascertain the file format from its contents.
 230                 from_format = formats.getFormatFromFile(abs_from_file);
 231                 if (from_format.empty())
 232                         return; // FAILURE
 233
 234         }
 235
 236         string const to_format = outputFormat.updateFormat;
 237         if (to_format.empty())
 238                 return; // NOT_NEEDED
 239
 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;
 245                 return; // FAILURE
 246         }
 247
 248         // The master buffer. This is useful when there are multiple levels
 249         // of include files
 250         Buffer const * m_buffer = buffer.getMasterBuffer();
 251
 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);
 260
 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. "
 266                                         << "Unable to copy "
 267                                         << abs_from_file << " to " << temp_file << endl;
 268                                 return; // FAILURE
 269                         }
 270                 }
 271         }
 272
 273         // the generated file (always in the temp dir)
 274         string const to_file = doSubstitution(params, buffer,
 275                                               outputFormat.updateResult,
 276                                               false, true);
 277         string const abs_to_file =
 278                 support::MakeAbsPath(to_file, m_buffer->temppath());
 279
 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,
 291                                                        false, true),
 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,
 300                                               PATHS);
 301                         file = doSubstitution(params, buffer, file,
 302                                               false, external_in_tmpdir,
 303                                               ALL_BUT_PATHS);
 304                         // if file is a relative name, it is interpreted
 305                         // relative to the master document.
 306                         exportdata.addExternalFile(rit->first, source, file);
 307                 }
 308         }
 309
 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)
 313                 return; // SUCCESS
 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);
 319         // return success
 320 }
 321
 322
 323 string const substituteCommands(InsetExternalParams const & params,
 324                                 string const & input, string const & format);
 325
 326 string const substituteOptions(InsetExternalParams const & params,
 327                                string const & input, string const & format);
 328
 329 } // namespace anon
 330
 331
 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 {
 338         Template const * const et_ptr = getTemplatePtr(params);
 339         if (!et_ptr)
 340                 return 0;
 341         Template const & et = *et_ptr;
 342
 343         Template::Formats::const_iterator cit = et.formats.find(format);
 344         if (cit == et.formats.end()) {
 345                 lyxerr[Debug::EXTERNAL]
 346                         << "External template format '" << format
 347                         << "' not specified in template "
 348                         << params.templatename() << endl;
 349                 return 0;
 350         }
 351
 352         updateExternal(params, format, buffer, exportdata, external_in_tmpdir);
 353
 354         bool const use_latex_path = format == "LaTeX";
 355         string str = doSubstitution(params, buffer, cit->second.product,
 356                                     use_latex_path, external_in_tmpdir);
 357         str = substituteCommands(params, str, format);
 358         str = substituteOptions(params, str, format);
 359         os << str;
 360         return int(lyx::count(str.begin(), str.end(),'\n'));
 361 }
 362
 363 namespace {
 364
 365 // Empty template, specialised below.
 366 template <typename TransformType>
 367 string const substituteIt(string const &,
 368                           TransformID,
 369                           string const &,
 370                           Template::Format const &,
 371                           InsetExternalParams const &);
 372
 373
 374 template <>
 375 string const substituteIt<TransformCommand>(string const & input,
 376                                             TransformID id,
 377                                             string const & /* formatname */,
 378                                             Template::Format const & format,
 379                                             InsetExternalParams const & params)
 380 {
 381         typedef std::map<TransformID, TransformStore> Transformers;
 382         Transformers::const_iterator it = format.command_transformers.find(id);
 383         if (it == format.command_transformers.end())
 384                 return input;
 385
 386         TransformStore const & store = it->second;
 387
 388         TransformCommand::ptr_type ptr;
 389         if (id == Rotate)
 390                 ptr = store.getCommandTransformer(params.rotationdata);
 391         else if (id == Resize)
 392                 ptr = store.getCommandTransformer(params.resizedata);
 393
 394         if (!ptr.get())
 395                 return input;
 396
 397         string result =
 398                 support::subst(input, ptr->front_placeholder(), ptr->front());
 399         return support::subst(result, ptr->back_placeholder(),  ptr->back());
 400 }
 401
 402
 403 template <>
 404 string const substituteIt<TransformOption>(string const & input,
 405                                            TransformID id,
 406                                            string const & fname,
 407                                            Template::Format const & format,
 408                                            InsetExternalParams const & params)
 409 {
 410         typedef std::map<TransformID, TransformStore> Transformers;
 411         Transformers::const_iterator it = format.option_transformers.find(id);
 412         if (it == format.option_transformers.end())
 413                 return input;
 414
 415         TransformStore const & store = it->second;
 416
 417         TransformOption::ptr_type ptr;
 418         switch (id) {
 419         case Clip:
 420                 ptr = store.getOptionTransformer(params.clipdata);
 421                 break;
 422         case Extra:
 423                 ptr = store.getOptionTransformer(params.extradata.get(fname));
 424                 break;
 425         case Rotate:
 426                 ptr = store.getOptionTransformer(params.rotationdata);
 427                 break;
 428         case Resize:
 429                 ptr = store.getOptionTransformer(params.resizedata);
 430                 break;
 431         }
 432
 433         if (!ptr.get())
 434                 return input;
 435
 436         return support::subst(input, ptr->placeholder(), ptr->option());
 437 }
 438
 439
 440 template <typename TransformerType>
 441 string const transformIt(InsetExternalParams const & params,
 442                          string const & s, string const & formatname)
 443 {
 444         Template const * const et = getTemplatePtr(params);
 445         if (!et || et->transformIds.empty())
 446                 return s;
 447
 448         Template::Formats::const_iterator fit = et->formats.find(formatname);
 449         if (fit == et->formats.end())
 450                 return s;
 451
 452         string result = s;
 453         Template::Format const & format =  fit->second;
 454
 455         typedef vector<TransformID> TransformsIDs;
 456         TransformsIDs::const_iterator it  = et->transformIds.begin();
 457         TransformsIDs::const_iterator end = et->transformIds.end();
 458         for (; it != end; ++it) {
 459                 result = substituteIt<TransformerType>(result, *it, formatname,
 460                                                        format, params);
 461         }
 462         return result;
 463 }
 464
 465
 466 string const substituteCommands(InsetExternalParams const & params,
 467                                 string const & input, string const & format)
 468 {
 469         return transformIt<TransformCommand>(params, input, format);
 470 }
 471
 472
 473 string const substituteOption(InsetExternalParams const & params,
 474                               string const & input, string const & format)
 475 {
 476         string opt = transformIt<TransformOption>(params, input, format);
 477
 478         if (format == "LaTeX" || format == "PDFLaTeX")
 479                 return sanitizeLatexOption(opt);
 480         if (format == "DocBook")
 481                 return sanitizeDocBookOption(opt);
 482         if (format == "LinuxDoc")
 483                 return sanitizeLinuxDocOption(opt);
 484         return opt;
 485 }
 486
 487
 488 string const substituteOptions(InsetExternalParams const & params,
 489                                string const & input, string const & format)
 490 {
 491         string output = input;
 492
 493         Template const * const et = getTemplatePtr(params);
 494         if (!et || et->transformIds.empty())
 495                 return output;
 496
 497         Template::Formats::const_iterator fit = et->formats.find(format);
 498         if (fit == et->formats.end() || fit->second.options.empty())
 499                 return output;
 500
 501         typedef vector<Template::Option> Options;
 502         Options const & options = fit->second.options;
 503         Options::const_iterator it  = options.begin();
 504         Options::const_iterator end = options.end();
 505         for (; it != end; ++it) {
 506                 string const opt = substituteOption(params, it->option, format);
 507                 string const placeholder = "$$" + it->name;
 508                 output = support::subst(output, placeholder, opt);
 509         }
 510
 511         return output;
 512  }
 513
 514 } // namespace anon
 515
 516 } // namespace external
 517 } // namespace lyx