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
 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));
 174                 string contents;
 175
 176                 FileName const absfile(
 177                         support::makeAbsPath(file, m_buffer->temppath()));
 178                 if (support::isFileReadable(absfile))
 179                         contents = support::getFileContents(absfile);
 180
 181                 result = support::subst(result,
 182                                         ("$$Contents(\"" + file + "\")").c_str(),
 183                                         contents);
 184         }
 185
 186         return result;
 187 }
 188
 189
 190 namespace {
 191
 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.
 195 */
 196 void updateExternal(InsetExternalParams const & params,
 197                     string const & format,
 198                     Buffer const & buffer,
 199                     ExportData & exportdata,
 200                     bool external_in_tmpdir)
 201 {
 202         Template const * const et_ptr = getTemplatePtr(params);
 203         if (!et_ptr)
 204                 return; // FAILURE
 205         Template const & et = *et_ptr;
 206
 207         if (!et.automaticProduction)
 208                 return; // NOT_NEEDED
 209
 210         Template::Formats::const_iterator cit = et.formats.find(format);
 211         if (cit == et.formats.end())
 212                 return; // FAILURE
 213
 214         Template::Format const & outputFormat = cit->second;
 215         if (outputFormat.updateResult.empty())
 216                 return; // NOT_NEEDED
 217
 218         string from_format = et.inputFormat;
 219         if (from_format.empty())
 220                 return; // NOT_NEEDED
 221
 222         if (from_format == "*") {
 223                 if (params.filename.empty())
 224                         return; // NOT_NEEDED
 225
 226                 // Try and ascertain the file format from its contents.
 227                 from_format = formats.getFormatFromFile(params.filename);
 228                 if (from_format.empty())
 229                         return; // FAILURE
 230
 231         }
 232
 233         string const to_format = outputFormat.updateFormat;
 234         if (to_format.empty())
 235                 return; // NOT_NEEDED
 236
 237         if (!theConverters().isReachable(from_format, to_format)) {
 238                 lyxerr[Debug::EXTERNAL]
 239                         << "external::updateExternal. "
 240                         << "Unable to convert from "
 241                         << from_format << " to " << to_format << endl;
 242                 return; // FAILURE
 243         }
 244
 245         // The master buffer. This is useful when there are multiple levels
 246         // of include files
 247         Buffer const * m_buffer = buffer.getMasterBuffer();
 248
 249         // We copy the source file to the temp dir and do the conversion
 250         // there if necessary
 251         FileName const temp_file(
 252                 support::makeAbsPath(params.filename.mangledFilename(),
 253                                      m_buffer->temppath()));
 254         if (!params.filename.empty() && !is_directory(params.filename.toFilesystemEncoding())) {
 255                 unsigned long const from_checksum = support::sum(params.filename);
 256                 unsigned long const temp_checksum = support::sum(temp_file);
 257
 258                 if (from_checksum != temp_checksum) {
 259                         Mover const & mover = getMover(from_format);
 260                         if (!mover.copy(params.filename, temp_file)) {
 261                                 lyxerr[Debug::EXTERNAL]
 262                                         << "external::updateExternal. "
 263                                         << "Unable to copy "
 264                                         << params.filename << " to " << temp_file << endl;
 265                                 return; // FAILURE
 266                         }
 267                 }
 268         }
 269
 270         // the generated file (always in the temp dir)
 271         string const to_file = doSubstitution(params, buffer,
 272                                               outputFormat.updateResult,
 273                                               false, true);
 274         FileName const abs_to_file(
 275                 support::makeAbsPath(to_file, m_buffer->temppath()));
 276
 277         // Record the referenced files for the exporter.
 278         // The exporter will copy them to the export dir.
 279         typedef Template::Format::FileMap FileMap;
 280         FileMap::const_iterator rit  = outputFormat.referencedFiles.begin();
 281         FileMap::const_iterator rend = outputFormat.referencedFiles.end();
 282         for (; rit != rend; ++rit) {
 283                 vector<string>::const_iterator fit  = rit->second.begin();
 284                 vector<string>::const_iterator fend = rit->second.end();
 285                 for (; fit != fend; ++fit) {
 286                         FileName const source(support::makeAbsPath(
 287                                         doSubstitution(params, buffer, *fit,
 288                                                        false, true),
 289                                         m_buffer->temppath()));
 290                         // The path of the referenced file is never the
 291                         // temp path, but the filename may be the mangled
 292                         // or the real name. Therefore we substitute the
 293                         // paths and names separately.
 294                         string file = support::subst(*fit, "$$FName",
 295                                         "$$FPath$$Basename$$Extension");
 296                         file = doSubstitution(params, buffer, file, false, false,
 297                                               PATHS);
 298                         file = doSubstitution(params, buffer, file,
 299                                               false, external_in_tmpdir,
 300                                               ALL_BUT_PATHS);
 301                         // if file is a relative name, it is interpreted
 302                         // relative to the master document.
 303                         exportdata.addExternalFile(rit->first, source, file);
 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         // return success
 319 }
 320
 321
 322 string const substituteCommands(InsetExternalParams const & params,
 323                                 string const & input, string const & format);
 324
 325 string const substituteOptions(InsetExternalParams const & params,
 326                                string const & input, string const & format);
 327
 328 } // namespace anon
 329
 330
 331 int writeExternal(InsetExternalParams const & params,
 332                   string const & format,
 333                   Buffer const & buffer, odocstream & os,
 334                   ExportData & exportdata,
 335                   bool external_in_tmpdir,
 336                   bool external_in_comment)
 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         if (!external_in_comment)
 353                 updateExternal(params, format, buffer, exportdata,
 354                                external_in_tmpdir);
 355
 356         bool const use_latex_path = format == "LaTeX";
 357         string str = doSubstitution(params, buffer, cit->second.product,
 358                                     use_latex_path, external_in_tmpdir);
 359         str = substituteCommands(params, str, format);
 360         str = substituteOptions(params, str, format);
 361         // FIXME UNICODE
 362         os << from_utf8(str);
 363         return int(lyx::count(str.begin(), str.end(),'\n'));
 364 }
 365
 366 namespace {
 367
 368 // Empty template, specialised below.
 369 template <typename TransformType>
 370 string const substituteIt(string const &,
 371                           TransformID,
 372                           string const &,
 373                           Template::Format const &,
 374                           InsetExternalParams const &);
 375
 376
 377 template <>
 378 string const substituteIt<TransformCommand>(string const & input,
 379                                             TransformID id,
 380                                             string const & /* formatname */,
 381                                             Template::Format const & format,
 382                                             InsetExternalParams const & params)
 383 {
 384         typedef std::map<TransformID, TransformStore> Transformers;
 385         Transformers::const_iterator it = format.command_transformers.find(id);
 386         if (it == format.command_transformers.end())
 387                 return input;
 388
 389         TransformStore const & store = it->second;
 390
 391         TransformCommand::ptr_type ptr;
 392         if (id == Rotate)
 393                 ptr = store.getCommandTransformer(params.rotationdata);
 394         else if (id == Resize)
 395                 ptr = store.getCommandTransformer(params.resizedata);
 396
 397         if (!ptr.get())
 398                 return input;
 399
 400         string result =
 401                 support::subst(input, ptr->front_placeholder(), ptr->front());
 402         return support::subst(result, ptr->back_placeholder(),  ptr->back());
 403 }
 404
 405
 406 template <>
 407 string const substituteIt<TransformOption>(string const & input,
 408                                            TransformID id,
 409                                            string const & fname,
 410                                            Template::Format const & format,
 411                                            InsetExternalParams const & params)
 412 {
 413         typedef std::map<TransformID, TransformStore> Transformers;
 414         Transformers::const_iterator it = format.option_transformers.find(id);
 415         if (it == format.option_transformers.end())
 416                 return input;
 417
 418         TransformStore const & store = it->second;
 419
 420         TransformOption::ptr_type ptr;
 421         switch (id) {
 422         case Clip:
 423                 ptr = store.getOptionTransformer(params.clipdata);
 424                 break;
 425         case Extra:
 426                 ptr = store.getOptionTransformer(params.extradata.get(fname));
 427                 break;
 428         case Rotate:
 429                 ptr = store.getOptionTransformer(params.rotationdata);
 430                 break;
 431         case Resize:
 432                 ptr = store.getOptionTransformer(params.resizedata);
 433                 break;
 434         }
 435
 436         if (!ptr.get())
 437                 return input;
 438
 439         return support::subst(input, ptr->placeholder(), ptr->option());
 440 }
 441
 442
 443 template <typename TransformerType>
 444 string const transformIt(InsetExternalParams const & params,
 445                          string const & s, string const & formatname)
 446 {
 447         Template const * const et = getTemplatePtr(params);
 448         if (!et || et->transformIds.empty())
 449                 return s;
 450
 451         Template::Formats::const_iterator fit = et->formats.find(formatname);
 452         if (fit == et->formats.end())
 453                 return s;
 454
 455         string result = s;
 456         Template::Format const & format =  fit->second;
 457
 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,
 463                                                        format, params);
 464         }
 465         return result;
 466 }
 467
 468
 469 string const substituteCommands(InsetExternalParams const & params,
 470                                 string const & input, string const & format)
 471 {
 472         return transformIt<TransformCommand>(params, input, format);
 473 }
 474
 475
 476 string const substituteOption(InsetExternalParams const & params,
 477                               string const & input, string const & format)
 478 {
 479         string opt = transformIt<TransformOption>(params, input, format);
 480
 481         if (format == "LaTeX" || format == "PDFLaTeX")
 482                 return sanitizeLatexOption(opt);
 483         if (format == "DocBook")
 484                 return sanitizeDocBookOption(opt);
 485         return opt;
 486 }
 487
 488
 489 string const substituteOptions(InsetExternalParams const & params,
 490                                string const & input, string const & format)
 491 {
 492         string output = input;
 493
 494         Template const * const et = getTemplatePtr(params);
 495         if (!et || et->transformIds.empty())
 496                 return output;
 497
 498         Template::Formats::const_iterator fit = et->formats.find(format);
 499         if (fit == et->formats.end() || fit->second.options.empty())
 500                 return output;
 501
 502         typedef vector<Template::Option> Options;
 503         Options const & options = fit->second.options;
 504         Options::const_iterator it  = options.begin();
 505         Options::const_iterator end = options.end();
 506         for (; it != end; ++it) {
 507                 string const opt = substituteOption(params, it->option, format);
 508                 string const placeholder = "$$" + it->name;
 509                 output = support::subst(output, placeholder, opt);
 510         }
 511
 512         return output;
 513 }
 514
 515 } // namespace anon
 516
 517 } // namespace external
 518
 519 } // namespace lyx