* @ingroup Parser
*/
+use MediaWiki\Logger\LoggerFactory;
+
/**
* @ingroup Parser
*/
-interface Preprocessor {
+abstract class Preprocessor {
+
+ const CACHE_VERSION = 1;
+
/**
- * Create a new preprocessor object based on an initialised Parser object
+ * @var array Brace matching rules.
+ */
+ protected $rules = array(
+ '{' => array(
+ 'end' => '}',
+ 'names' => array(
+ 2 => 'template',
+ 3 => 'tplarg',
+ ),
+ 'min' => 2,
+ 'max' => 3,
+ ),
+ '[' => array(
+ 'end' => ']',
+ 'names' => array( 2 => null ),
+ 'min' => 2,
+ 'max' => 2,
+ )
+ );
+
+ /**
+ * Store a document tree in the cache.
*
- * @param Parser $parser
+ * @param string $text
+ * @param int $flags
+ */
+ protected function cacheSetTree( $text, $flags, $tree ) {
+ $config = RequestContext::getMain()->getConfig();
+
+ $length = strlen( $text );
+ $threshold = $config->get( 'PreprocessorCacheThreshold' );
+ if ( $threshold === false || $length < $threshold || $length > 1e6 ) {
+ return false;
+ }
+
+ $key = wfMemcKey(
+ // TODO: Once we require PHP 5.5, use static::class instead of
+ // get_called_class() or get_class( $this ).
+ defined( 'static::CACHE_PREFIX' ) ? static::CACHE_PREFIX : get_called_class(),
+ md5( $text ), $flags );
+ $value = sprintf( "%08d", static::CACHE_VERSION ) . $tree;
+
+ $cache = ObjectCache::getInstance( $config->get( 'MainCacheType' ) );
+ $cache->set( $key, $value, 86400 );
+
+ LoggerFactory::getInstance( 'Preprocessor' )
+ ->info( "Cached preprocessor output (key: $key)" );
+ }
+
+ /**
+ * Attempt to load a precomputed document tree for some given wikitext
+ * from the cache.
+ *
+ * @param string $text
+ * @param int $flags
+ * @return PPNode_Hash_Tree|bool
*/
- public function __construct( $parser );
+ protected function cacheGetTree( $text, $flags ) {
+ $config = RequestContext::getMain()->getConfig();
+
+ $length = strlen( $text );
+ $threshold = $config->get( 'PreprocessorCacheThreshold' );
+ if ( $threshold === false || $length < $threshold || $length > 1e6 ) {
+ return false;
+ }
+
+ $cache = ObjectCache::getInstance( $config->get( 'MainCacheType' ) );
+
+ $key = wfMemcKey(
+ // TODO: Once we require PHP 5.5, use static::class instead of
+ // get_called_class() or get_class( $this ).
+ defined( 'static::CACHE_PREFIX' ) ? static::CACHE_PREFIX : get_called_class(),
+ md5( $text ), $flags );
+
+ $value = $cache->get( $key );
+ if ( !$value ) {
+ return false;
+ }
+
+ $version = intval( substr( $value, 0, 8 ) );
+ if ( $version !== static::CACHE_VERSION ) {
+ return false;
+ }
+
+ LoggerFactory::getInstance( 'Preprocessor' )
+ ->info( "Loaded preprocessor output from cache (key: $key)" );
+
+ return substr( $value, 8 );
+ }
/**
* Create a new top-level frame for expansion of a page
*
* @return PPFrame
*/
- public function newFrame();
+ abstract public function newFrame();
/**
* Create a new custom frame for programmatic use of parameter replacement
*
* @return PPFrame
*/
- public function newCustomFrame( $args );
+ abstract public function newCustomFrame( $args );
/**
* Create a new custom node for programmatic use of parameter replacement
*
* @param array $values
*/
- public function newPartNodeArray( $values );
+ abstract public function newPartNodeArray( $values );
/**
* Preprocess text to a PPNode
*
* @return PPNode
*/
- public function preprocessToObj( $text, $flags = 0 );
+ abstract public function preprocessToObj( $text, $flags = 0 );
}
/**
/**
* Expand a document tree node, caching the result on its parent with the given key
+ * @param string|int $key
+ * @param string|PPNode $root
+ * @param int $flags
+ * @return string
*/
public function cachedExpand( $key, $root, $flags = 0 );
/**
* Expand a document tree node
+ * @param string|PPNode $root
+ * @param int $flags
+ * @return string
*/
public function expand( $root, $flags = 0 );
/**
* Implode with flags for expand()
+ * @param string $sep
+ * @param int $flags
+ * @param string|PPNode $args,...
+ * @return string
*/
public function implodeWithFlags( $sep, $flags /*, ... */ );
/**
* Implode with no flags specified
+ * @param string $sep
+ * @param string|PPNode $args,...
+ * @return string
*/
public function implode( $sep /*, ... */ );
/**
* Makes an object that, when expand()ed, will be the same as one obtained
* with implode()
+ * @param string $sep
+ * @param string|PPNode $args,...
+ * @return PPNode
*/
public function virtualImplode( $sep /*, ... */ );
/**
* Virtual implode with brackets
+ * @param string $start
+ * @param string $sep
+ * @param string $end
+ * @param string|PPNode $args,...
+ * @return PPNode
*/
public function virtualBracketedImplode( $start, $sep, $end /*, ... */ );
/**
* Returns all arguments of this frame
+ * @return array
*/
public function getArguments();
/**
* Returns all numbered arguments of this frame
+ * @return array
*/
public function getNumberedArguments();
/**
* Returns all named arguments of this frame
+ * @return array
*/
public function getNamedArguments();
/**
* Get an argument to this frame by name
+ * @param string $name
+ * @return bool
*/
public function getArgument( $name );
/**
* Return true if the frame is a template frame
+ * @return bool
*/
public function isTemplate();
/**
* Get an array-type node containing the children of this node.
* Returns false if this is not a tree node.
+ * @return PPNode
*/
public function getChildren();
/**
* Get the next sibling of any node. False if there isn't one
+ * @return PPNode
*/
public function getNextSibling();
/**
* Get all children of this tree node which have a given name.
* Returns an array-type node, or false if this is not a tree node.
+ * @param string $type
+ * @return bool|PPNode
*/
public function getChildrenOfType( $type );
/**
* Returns an item of an array-type node
+ * @param int $i
+ * @return bool|PPNode
*/
public function item( $i );
* #nodelist An array-type node
*
* The subclass may define various other names for tree and leaf nodes.
+ * @return string
*/
public function getName();
* name PPNode name
* index String index
* value PPNode value
+ * @return array
*/
public function splitArg();
/**
* Split an "<ext>" node into an associative array containing name, attr, inner and close
* All values in the resulting array are PPNodes. Inner and close are optional.
+ * @return array
*/
public function splitExt();
/**
* Split an "<h>" node
+ * @return array
*/
public function splitHeading();
}
dépôts / lhc / web / wiklou.git / blobdiff