MediaWiki  1.28.0
TemplateParser.php
Go to the documentation of this file.
1 <?php
27  protected $templateDir;
28 
32  protected $renderers;
33 
37  protected $forceRecompile = false;
38 
43  public function __construct( $templateDir = null, $forceRecompile = false ) {
44  $this->templateDir = $templateDir ?: __DIR__ . '/templates';
45  $this->forceRecompile = $forceRecompile;
46  }
47 
54  protected function getTemplateFilename( $templateName ) {
55  // Prevent upwards directory traversal using same methods as Title::secureAndSplit
56  if (
57  strpos( $templateName, '.' ) !== false &&
58  (
59  $templateName === '.' || $templateName === '..' ||
60  strpos( $templateName, './' ) === 0 ||
61  strpos( $templateName, '../' ) === 0 ||
62  strpos( $templateName, '/./' ) !== false ||
63  strpos( $templateName, '/../' ) !== false ||
64  substr( $templateName, -2 ) === '/.' ||
65  substr( $templateName, -3 ) === '/..'
66  )
67  ) {
68  throw new UnexpectedValueException( "Malformed \$templateName: $templateName" );
69  }
70 
71  return "{$this->templateDir}/{$templateName}.mustache";
72  }
73 
80  protected function getTemplate( $templateName ) {
81  // If a renderer has already been defined for this template, reuse it
82  if ( isset( $this->renderers[$templateName] ) &&
83  is_callable( $this->renderers[$templateName] )
84  ) {
85  return $this->renderers[$templateName];
86  }
87 
88  $filename = $this->getTemplateFilename( $templateName );
89 
90  if ( !file_exists( $filename ) ) {
91  throw new RuntimeException( "Could not locate template: {$filename}" );
92  }
93 
94  // Read the template file
95  $fileContents = file_get_contents( $filename );
96 
97  // Generate a quick hash for cache invalidation
98  $fastHash = md5( $fileContents );
99 
100  // Fetch a secret key for building a keyed hash of the PHP code
101  $config = ConfigFactory::getDefaultInstance()->makeConfig( 'main' );
102  $secretKey = $config->get( 'SecretKey' );
103 
104  if ( $secretKey ) {
105  // See if the compiled PHP code is stored in cache.
107  $key = $cache->makeKey( 'template', $templateName, $fastHash );
108  $code = $this->forceRecompile ? null : $cache->get( $key );
109 
110  if ( !$code ) {
111  $code = $this->compileForEval( $fileContents, $filename );
112 
113  // Prefix the cached code with a keyed hash (64 hex chars) as an integrity check
114  $cache->set( $key, hash_hmac( 'sha256', $code, $secretKey ) . $code );
115  } else {
116  // Verify the integrity of the cached PHP code
117  $keyedHash = substr( $code, 0, 64 );
118  $code = substr( $code, 64 );
119  if ( $keyedHash !== hash_hmac( 'sha256', $code, $secretKey ) ) {
120  // Generate a notice if integrity check fails
121  trigger_error( "Template failed integrity check: {$filename}" );
122  }
123  }
124  // If there is no secret key available, don't use cache
125  } else {
126  $code = $this->compileForEval( $fileContents, $filename );
127  }
128 
129  $renderer = eval( $code );
130  if ( !is_callable( $renderer ) ) {
131  throw new RuntimeException( "Requested template, {$templateName}, is not callable" );
132  }
133  $this->renderers[$templateName] = $renderer;
134  return $renderer;
135  }
136 
145  protected function compileForEval( $fileContents, $filename ) {
146  // Compile the template into PHP code
147  $code = $this->compile( $fileContents );
148 
149  if ( !$code ) {
150  throw new RuntimeException( "Could not compile template: {$filename}" );
151  }
152 
153  // Strip the "<?php" added by lightncandy so that it can be eval()ed
154  if ( substr( $code, 0, 5 ) === '<?php' ) {
155  $code = substr( $code, 5 );
156  }
157 
158  return $code;
159  }
160 
167  protected function compile( $code ) {
168  if ( !class_exists( 'LightnCandy' ) ) {
169  throw new RuntimeException( 'LightnCandy class not defined' );
170  }
171  return LightnCandy::compile(
172  $code,
173  [
174  // Do not add more flags here without discussion.
175  // If you do add more flags, be sure to update unit tests as well.
176  'flags' => LightnCandy::FLAG_ERROR_EXCEPTION,
177  'basedir' => $this->templateDir,
178  'fileext' => '.mustache',
179  ]
180  );
181  }
182 
200  public function processTemplate( $templateName, $args, array $scopes = [] ) {
201  $template = $this->getTemplate( $templateName );
202  return call_user_func( $template, $args, $scopes );
203  }
204 }
string $templateDir
The path to the Mustache templates.
the array() calling protocol came about after MediaWiki 1.4rc1.
getTemplate($templateName)
Returns a given template function if found, otherwise throws an exception.
compileForEval($fileContents, $filename)
Wrapper for compile() function that verifies successful compilation and strips out the '<...
__construct($templateDir=null, $forceRecompile=false)
compile($code)
Compile the Mustache code into PHP code using LightnCandy.
if($line===false) $args
Definition: cdb.php:64
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping $template
Definition: hooks.txt:802
$cache
Definition: mcc.php:33
callable[] $renderers
Array of cached rendering functions.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable & $code
Definition: hooks.txt:802
bool $forceRecompile
Always compile template files.
static getDefaultInstance()
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
static getLocalServerInstance($fallback=CACHE_NONE)
Factory function for CACHE_ACCEL (referenced from DefaultSettings.php)
const CACHE_ANYTHING
Definition: Defines.php:93
processTemplate($templateName, $args, array $scopes=[])
Returns HTML for a given template by calling the template function with the given args...
getTemplateFilename($templateName)
Constructs the location of the the source Mustache template.