MediaWiki  1.28.0
Preprocessor.php
Go to the documentation of this file.
1 <?php
25 
29 abstract class Preprocessor {
30 
31  const CACHE_VERSION = 1;
32 
36  protected $rules = [
37  '{' => [
38  'end' => '}',
39  'names' => [
40  2 => 'template',
41  3 => 'tplarg',
42  ],
43  'min' => 2,
44  'max' => 3,
45  ],
46  '[' => [
47  'end' => ']',
48  'names' => [ 2 => null ],
49  'min' => 2,
50  'max' => 2,
51  ]
52  ];
53 
60  protected function cacheSetTree( $text, $flags, $tree ) {
61  $config = RequestContext::getMain()->getConfig();
62 
63  $length = strlen( $text );
64  $threshold = $config->get( 'PreprocessorCacheThreshold' );
65  if ( $threshold === false || $length < $threshold || $length > 1e6 ) {
66  return false;
67  }
68 
69  $key = wfMemcKey(
70  defined( 'static::CACHE_PREFIX' ) ? static::CACHE_PREFIX : static::class,
71  md5( $text ), $flags );
72  $value = sprintf( "%08d", static::CACHE_VERSION ) . $tree;
73 
74  $cache = ObjectCache::getInstance( $config->get( 'MainCacheType' ) );
75  $cache->set( $key, $value, 86400 );
76 
77  LoggerFactory::getInstance( 'Preprocessor' )
78  ->info( "Cached preprocessor output (key: $key)" );
79  }
80 
89  protected function cacheGetTree( $text, $flags ) {
90  $config = RequestContext::getMain()->getConfig();
91 
92  $length = strlen( $text );
93  $threshold = $config->get( 'PreprocessorCacheThreshold' );
94  if ( $threshold === false || $length < $threshold || $length > 1e6 ) {
95  return false;
96  }
97 
98  $cache = ObjectCache::getInstance( $config->get( 'MainCacheType' ) );
99 
100  $key = wfMemcKey(
101  defined( 'static::CACHE_PREFIX' ) ? static::CACHE_PREFIX : static::class,
102  md5( $text ), $flags );
103 
104  $value = $cache->get( $key );
105  if ( !$value ) {
106  return false;
107  }
108 
109  $version = intval( substr( $value, 0, 8 ) );
110  if ( $version !== static::CACHE_VERSION ) {
111  return false;
112  }
113 
114  LoggerFactory::getInstance( 'Preprocessor' )
115  ->info( "Loaded preprocessor output from cache (key: $key)" );
116 
117  return substr( $value, 8 );
118  }
119 
125  abstract public function newFrame();
126 
135  abstract public function newCustomFrame( $args );
136 
143  abstract public function newPartNodeArray( $values );
144 
153  abstract public function preprocessToObj( $text, $flags = 0 );
154 }
155 
159 interface PPFrame {
160  const NO_ARGS = 1;
161  const NO_TEMPLATES = 2;
162  const STRIP_COMMENTS = 4;
163  const NO_IGNORE = 8;
164  const RECOVER_COMMENTS = 16;
165  const NO_TAGS = 32;
166 
167  const RECOVER_ORIG = 59; // = 1|2|8|16|32 no constant expression support in PHP yet
168 
171 
181  public function newChild( $args = false, $title = false, $indexOffset = 0 );
182 
190  public function cachedExpand( $key, $root, $flags = 0 );
191 
198  public function expand( $root, $flags = 0 );
199 
207  public function implodeWithFlags( $sep, $flags /*, ... */ );
208 
215  public function implode( $sep /*, ... */ );
216 
224  public function virtualImplode( $sep /*, ... */ );
225 
234  public function virtualBracketedImplode( $start, $sep, $end /*, ... */ );
235 
241  public function isEmpty();
242 
247  public function getArguments();
248 
253  public function getNumberedArguments();
254 
259  public function getNamedArguments();
260 
266  public function getArgument( $name );
267 
274  public function loopCheck( $title );
275 
280  public function isTemplate();
281 
293  public function setVolatile( $flag = true );
294 
304  public function isVolatile();
305 
318  public function getTTL();
319 
329  public function setTTL( $ttl );
330 
336  public function getTitle();
337 }
338 
352 interface PPNode {
358  public function getChildren();
359 
365  public function getFirstChild();
366 
371  public function getNextSibling();
372 
379  public function getChildrenOfType( $type );
380 
384  public function getLength();
385 
391  public function item( $i );
392 
406  public function getName();
407 
415  public function splitArg();
416 
422  public function splitExt();
423 
428  public function splitHeading();
429 }
expand($root, $flags=0)
Expand a document tree node.
array $rules
Brace matching rules.
cachedExpand($key, $root, $flags=0)
Expand a document tree node, caching the result on its parent with the given key. ...
item($i)
Returns an item of an array-type node.
isEmpty()
Returns true if there are no arguments in this frame.
getArgument($name)
Get an argument to this frame by name.
setVolatile($flag=true)
Set the "volatile" flag.
newCustomFrame($args)
Create a new custom frame for programmatic use of parameter replacement as used in some extensions...
splitHeading()
Split an "" node.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
getTTL()
Get the TTL of the frame's output.
static getInstance($id)
Get a cached instance of the specified type of cache object.
Definition: ObjectCache.php:92
getArguments()
Returns all arguments of this frame.
There are three types of nodes:
getNamedArguments()
Returns all named arguments of this frame.
$value
setTTL($ttl)
Set the TTL of the output of this frame and all of its ancestors.
it s the revision text itself In either if gzip is the revision text is gzipped $flags
Definition: hooks.txt:2703
const RECOVER_COMMENTS
getNumberedArguments()
Returns all numbered arguments of this frame.
const NO_ARGS
const NO_IGNORE
if($line===false) $args
Definition: cdb.php:64
newChild($args=false, $title=false, $indexOffset=0)
Create a child frame.
implodeWithFlags($sep, $flags)
Implode with flags for expand()
getFirstChild()
Get the first child of a tree node.
const NO_TEMPLATES
array cacheSetTree($text, $flags, $tree)
Store a document tree in the cache.
static getMain()
Static methods.
implode($sep)
Implode with no flags specified.
getNextSibling()
Get the next sibling of any node.
getName()
Get the name of this node.
const RECOVER_ORIG
loopCheck($title)
Returns true if the infinite loop check is OK, false if a loop is detected.
$cache
Definition: mcc.php:33
const CACHE_VERSION
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:953
getLength()
Returns the length of the array, or false if this is not an array-type node.
isVolatile()
Get the "volatile" flag.
getChildrenOfType($type)
Get all children of this tree node which have a given name.
getTitle()
Get a title of frame.
splitExt()
Split an "" node into an associative array containing name, attr, inner and close All values in ...
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
const NO_TAGS
virtualBracketedImplode($start, $sep, $end)
Virtual implode with brackets.
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
splitArg()
Split a "" node into an associative array containing: name PPNode name index String index value...
MediaWiki Logger LoggerFactory implements a PSR[0] compatible message logging system Named Psr Log LoggerInterface instances can be obtained from the MediaWiki Logger LoggerFactory::getInstance() static method.MediaWiki\Logger\LoggerFactory expects a class implementing the MediaWiki\Logger\Spi interface to act as a factory for new Psr\Log\LoggerInterface instances.The"Spi"in MediaWiki\Logger\Spi stands for"service provider interface".An SPI is an API intended to be implemented or extended by a third party.This software design pattern is intended to enable framework extension and replaceable components.It is specifically used in the MediaWiki\Logger\LoggerFactory service to allow alternate PSR-3 logging implementations to be easily integrated with MediaWiki.The service provider interface allows the backend logging library to be implemented in multiple ways.The $wgMWLoggerDefaultSpi global provides the classname of the default MediaWiki\Logger\Spi implementation to be loaded at runtime.This can either be the name of a class implementing the MediaWiki\Logger\Spi with a zero argument const ructor or a callable that will return an MediaWiki\Logger\Spi instance.Alternately the MediaWiki\Logger\LoggerFactory MediaWiki Logger LoggerFactory
Definition: logger.txt:5
preprocessToObj($text, $flags=0)
Preprocess text to a PPNode.
wfMemcKey()
Make a cache key for the local wiki.
getChildren()
Get an array-type node containing the children of this node.
newFrame()
Create a new top-level frame for expansion of a page.
const STRIP_COMMENTS
isTemplate()
Return true if the frame is a template frame.
const SUPPORTS_INDEX_OFFSET
This constant exists when $indexOffset is supported in newChild()
newPartNodeArray($values)
Create a new custom node for programmatic use of parameter replacement as used in some extensions...
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition: hooks.txt:2491
cacheGetTree($text, $flags)
Attempt to load a precomputed document tree for some given wikitext from the cache.
virtualImplode($sep)
Makes an object that, when expand()ed, will be the same as one obtained with implode() ...
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:300