<?php
/**
* File for magic words
+ *
* See docs/magicword.txt
*
* @file
/**#@+
* @private
*/
- var $mId, $mSynonyms, $mCaseSensitive, $mRegex;
- var $mRegexStart, $mBaseRegex, $mVariableRegex;
- var $mModified, $mFound;
+ var $mId, $mSynonyms, $mCaseSensitive;
+ var $mRegex = '';
+ var $mRegexStart = '';
+ var $mBaseRegex = '';
+ var $mVariableRegex = '';
+ var $mVariableStartToEndRegex = '';
+ var $mModified = false;
+ var $mFound = false;
static public $mVariableIDsInitialised = false;
static public $mVariableIDs = array(
'numberofarticles',
'numberoffiles',
'numberofedits',
+ 'articlepath',
+ 'pageid',
'sitename',
'server',
'servername',
'revisionday',
'revisionday2',
'revisionmonth',
+ 'revisionmonth1',
'revisionyear',
'revisiontimestamp',
'revisionuser',
/**#@-*/
- function __construct($id = 0, $syn = '', $cs = false) {
+ function __construct($id = 0, $syn = array(), $cs = false) {
$this->mId = $id;
$this->mSynonyms = (array)$syn;
$this->mCaseSensitive = $cs;
- $this->mRegex = '';
- $this->mRegexStart = '';
- $this->mVariableRegex = '';
- $this->mVariableStartToEndRegex = '';
- $this->mModified = false;
}
/**
* Factory: creates an object representing an ID
- * @static
+ *
+ * @param $id
+ *
+ * @return MagicWord
*/
static function &get( $id ) {
- wfProfileIn( __METHOD__ );
if ( !isset( self::$mObjects[$id] ) ) {
$mw = new MagicWord();
$mw->load( $id );
self::$mObjects[$id] = $mw;
}
- wfProfileOut( __METHOD__ );
return self::$mObjects[$id];
}
/**
* Get an array of parser variable IDs
+ *
+ * @return array
*/
static function getVariableIDs() {
if ( !self::$mVariableIDsInitialised ) {
/**
* Get an array of parser substitution modifier IDs
+ * @return array
*/
static function getSubstIDs() {
- return self::$mSubstIDs;
+ return self::$mSubstIDs;
}
- /* Allow external reads of TTL array */
- static function getCacheTTL($id) {
- if (array_key_exists($id,self::$mCacheTTLs)) {
+ /**
+ * Allow external reads of TTL array
+ *
+ * @param $id int
+ * @return array
+ */
+ static function getCacheTTL( $id ) {
+ if ( array_key_exists( $id, self::$mCacheTTLs ) ) {
return self::$mCacheTTLs[$id];
} else {
return -1;
}
}
- /** Get a MagicWordArray of double-underscore entities */
+ /**
+ * Get a MagicWordArray of double-underscore entities
+ *
+ * @return MagicWordArray
+ */
static function getDoubleUnderscoreArray() {
if ( is_null( self::$mDoubleUnderscoreArray ) ) {
self::$mDoubleUnderscoreArray = new MagicWordArray( self::$mDoubleUnderscoreIDs );
self::$mObjects = array();
}
- # Initialises this object with an ID
+ /**
+ * Initialises this object with an ID
+ *
+ * @param $id
+ */
function load( $id ) {
global $wgContLang;
+ wfProfileIn( __METHOD__ );
$this->mId = $id;
$wgContLang->getMagic( $this );
if ( !$this->mSynonyms ) {
#throw new MWException( "Error: invalid magic word '$id'" );
wfDebugLog( 'exception', "Error: invalid magic word '$id'\n" );
}
+ wfProfileOut( __METHOD__ );
}
/**
* @private
*/
function initRegex() {
- #$variableClass = Title::legalChars();
- # This was used for matching "$1" variables, but different uses of the feature will have
- # different restrictions, which should be checked *after* the MagicWord has been matched,
- # not here. - IMSoP
+ // Sort the synonyms by length, descending, so that the longest synonym
+ // matches in precedence to the shortest
+ $synonyms = $this->mSynonyms;
+ usort( $synonyms, array( $this, 'compareStringLength' ) );
$escSyn = array();
- foreach ( $this->mSynonyms as $synonym )
+ foreach ( $synonyms as $synonym )
// In case a magic word contains /, like that's going to happen;)
$escSyn[] = preg_quote( $synonym, '/' );
$this->mBaseRegex = implode( '|', $escSyn );
"/^(?:{$this->mBaseRegex})$/{$case}" );
}
+ /**
+ * A comparison function that returns -1, 0 or 1 depending on whether the
+ * first string is longer, the same length or shorter than the second
+ * string.
+ *
+ * @param $s1 string
+ * @param $s2 string
+ *
+ * @return int
+ */
+ function compareStringLength( $s1, $s2 ) {
+ $l1 = strlen( $s1 );
+ $l2 = strlen( $s2 );
+ if ( $l1 < $l2 ) {
+ return 1;
+ } elseif ( $l1 > $l2 ) {
+ return -1;
+ } else {
+ return 0;
+ }
+ }
+
/**
* Gets a regex representing matching the word
+ *
+ * @return string
*/
function getRegex() {
if ($this->mRegex == '' ) {
* Gets the regexp case modifier to use, i.e. i or nothing, to be used if
* one is using MagicWord::getBaseRegex(), otherwise it'll be included in
* the complete expression
+ *
+ * @return string
*/
function getRegexCase() {
if ( $this->mRegex === '' )
/**
* Gets a regex matching the word, if it is at the string start
+ *
+ * @return string
*/
function getRegexStart() {
if ($this->mRegex == '' ) {
/**
* regex without the slashes and what not
+ *
+ * @return string
*/
function getBaseRegex() {
if ($this->mRegex == '') {
/**
* Returns true if the text contains the word
+ *
+ * @param $text string
+ *
* @return bool
*/
function match( $text ) {
/**
* Returns true if the text starts with the word
+ *
+ * @param $text string
+ *
* @return bool
*/
function matchStart( $text ) {
* The return code is the matched string, if there's no variable
* part in the regex and the matched variable part ($1) if there
* is one.
+ *
+ * @param $text string
+ *
+ * @return string
*/
function matchVariableStartToEnd( $text ) {
$matches = array();
$matches = array_values(array_filter($matches));
- if ( count($matches) == 1 ) { return $matches[0]; }
- else { return $matches[1]; }
+ if ( count($matches) == 1 ) {
+ return $matches[0];
+ } else {
+ return $matches[1];
+ }
}
}
/**
* Returns true if the text matches the word, and alters the
* input string, removing all instances of the word
+ *
+ * @param $text string
+ *
+ * @return bool
*/
function matchAndRemove( &$text ) {
$this->mFound = false;
return $this->mFound;
}
+ /**
+ * @param $text
+ * @return bool
+ */
function matchStartAndRemove( &$text ) {
$this->mFound = false;
$text = preg_replace_callback( $this->getRegexStart(), array( &$this, 'pregRemoveAndRecord' ), $text );
/**
* Used in matchAndRemove()
- * @private
- **/
- function pregRemoveAndRecord( ) {
+ *
+ * @return string
+ */
+ function pregRemoveAndRecord() {
$this->mFound = true;
return '';
}
/**
* Replaces the word with something else
- */
- function replace( $replacement, $subject, $limit=-1 ) {
+ *
+ * @param $replacement
+ * @param $subject
+ * @param $limit int
+ *
+ * @return string
+ */
+ function replace( $replacement, $subject, $limit = -1 ) {
$res = preg_replace( $this->getRegex(), StringUtils::escapeRegexReplacement( $replacement ), $subject, $limit );
$this->mModified = !($res === $subject);
return $res;
* Variable handling: {{SUBST:xxx}} style words
* Calls back a function to determine what to replace xxx with
* Input word must contain $1
+ *
+ * @param $text string
+ * @param $callback
+ *
+ * @return string
*/
function substituteCallback( $text, $callback ) {
$res = preg_replace_callback( $this->getVariableRegex(), $callback, $text );
/**
* Matches the word, where $1 is a wildcard
+ *
+ * @return string
*/
function getVariableRegex() {
if ( $this->mVariableRegex == '' ) {
/**
* Matches the entire string, where $1 is a wildcard
+ *
+ * @return string
*/
function getVariableStartToEndRegex() {
if ( $this->mVariableStartToEndRegex == '' ) {
/**
* Accesses the synonym list directly
+ *
+ * @param $i int
+ *
+ * @return string
*/
function getSynonym( $i ) {
return $this->mSynonyms[$i];
}
+ /**
+ * @return array
+ */
function getSynonyms() {
return $this->mSynonyms;
}
/**
* Returns true if the last call to replace() or substituteCallback()
* returned a modified text, otherwise false.
+ *
+ * @return bool
*/
function getWasModified(){
return $this->mModified;
* This method uses the php feature to do several replacements at the same time,
* thereby gaining some efficiency. The result is placed in the out variable
* $result. The return value is true if something was replaced.
- * @static
- **/
+ * @todo Should this be static? It doesn't seem to be used at all
+ *
+ * @param $magicarr
+ * @param $subject
+ * @param $result
+ *
+ * @return bool
+ */
function replaceMultiple( $magicarr, $subject, &$result ){
$search = array();
$replace = array();
/**
* Adds all the synonyms of this MagicWord to an array, to allow quick
* lookup in a list of magic words
+ *
+ * @param $array
+ * @param $value
*/
function addToArray( &$array, $value ) {
global $wgContLang;
}
}
+ /**
+ * @return bool
+ */
function isCaseSensitive() {
return $this->mCaseSensitive;
}
+ /**
+ * @return int
+ */
function getId() {
return $this->mId;
}
/**
* Add a magic word by name
+ *
+ * @param $name string
*/
public function add( $name ) {
- global $wgContLang;
$this->names[] = $name;
$this->hash = $this->baseRegex = $this->regex = null;
}
/**
* Add a number of magic words by name
+ *
+ * @param $names array
*/
public function addArray( $names ) {
$this->names = array_merge( $this->names, array_values( $names ) );
}
/**
- * Get an unanchored regex
+ * Get an unanchored regex that does not match parameters
*/
function getRegex() {
if ( is_null( $this->regex ) ) {
}
/**
- * Get a regex for matching variables
+ * Get a regex for matching variables with parameters
+ *
+ * @return string
*/
function getVariableRegex() {
return str_replace( "\\$1", "(.*?)", $this->getRegex() );
}
/**
- * Get a regex for matching a prefix. Does not match parameters.
+ * Get a regex anchored to the start of the string that does not match parameters
+ *
+ * @return array
*/
function getRegexStart() {
$base = $this->getBaseRegex();
$newRegex = array( '', '' );
if ( $base[0] !== '' ) {
- $newRegex[0] = str_replace( "\\$1", "", "/^(?:{$base[0]})/iuS" );
+ $newRegex[0] = "/^(?:{$base[0]})/iuS";
}
if ( $base[1] !== '' ) {
- $newRegex[1] = str_replace( "\\$1", "", "/^(?:{$base[1]})/S" );
+ $newRegex[1] = "/^(?:{$base[1]})/S";
}
return $newRegex;
}
/**
- * Get an anchored regex for matching variables
+ * Get an anchored regex for matching variables with parameters
+ *
+ * @return array
*/
function getVariableStartToEndRegex() {
$base = $this->getBaseRegex();
* Parse a match array from preg_match
* Returns array(magic word ID, parameter value)
* If there is no parameter value, that element will be false.
+ *
+ * @param $m array
+ *
+ * @return array
*/
function parseMatch( $m ) {
reset( $m );
}
// This shouldn't happen either
throw new MWException( __METHOD__.': parameter not found' );
- return array( false, false );
}
/**
* Returns an array with the magic word name in the first element and the
* parameter in the second element.
* Both elements are false if there was no match.
+ *
+ * @param $text string
+ *
+ * @return array
*/
public function matchVariableStartToEnd( $text ) {
- global $wgContLang;
$regexes = $this->getVariableStartToEndRegex();
foreach ( $regexes as $regex ) {
if ( $regex !== '' ) {
/**
* Match some text, without parameter capture
* Returns the magic word name, or false if there was no capture
+ *
+ * @param $text string
+ *
+ * @return string|false
*/
public function matchStartToEnd( $text ) {
$hash = $this->getHash();
/**
* Returns an associative array, ID => param value, for all items that match
* Removes the matched items from the input string (passed by reference)
+ *
+ * @param $text string
+ *
+ * @return array
*/
public function matchAndRemove( &$text ) {
$found = array();
}
/**
- * Returns the magic word id removed from the start, or false
- * does not match parameters.
+ * Return the ID of the magic word at the start of $text, and remove
+ * the prefix from $text.
+ * Return false if no match found and $text is not modified.
+ * Does not match parameters.
+ *
+ * @param $text string
+ *
+ * @return int|false
*/
public function matchStartAndRemove( &$text ) {
- $found = FALSE;
$regexes = $this->getRegexStart();
foreach ( $regexes as $regex ) {
if ( $regex === '' ) {
continue;
}
- preg_match_all( $regex, $text, $matches, PREG_SET_ORDER );
- foreach ( $matches as $m ) {
- list( $found, $param ) = $this->parseMatch( $m );
+ if ( preg_match( $regex, $text, $m ) ) {
+ list( $id, ) = $this->parseMatch( $m );
+ if ( strlen( $m[0] ) >= strlen( $text ) ) {
+ $text = '';
+ } else {
+ $text = substr( $text, strlen( $m[0] ) );
+ }
+ return $id;
}
- $text = preg_replace( $regex, '', $text );
}
- return $found;
+ return false;
}
}
dépôts / lhc / web / wiklou.git / blobdiff