X-Git-Url: http://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2FMagicWord.php;h=511efab4cf54181abcecd7439dd2dc4579dce5c9;hb=bf63ffaa2c7e472181d74829a8bb380ad2ee9735;hp=9089d5108a2cb63a0a5a3722022e464773c208fd;hpb=ad76b42c79a8e627ff2c68f1f4ca231b73575afb;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/MagicWord.php b/includes/MagicWord.php index 9089d5108a..511efab4cf 100644 --- a/includes/MagicWord.php +++ b/includes/MagicWord.php @@ -1,244 +1,366 @@ match( $text ) ) -# -# Possible future improvements: -# * Simultaneous searching for a number of magic words -# * $wgMagicWords in shared memory -# -# Please avoid reading the data out of one of these objects and then writing -# special case code. If possible, add another match()-like function here. - -/*private*/ $wgMagicFound = false; - -define("MAG_REDIRECT", 0); -define("MAG_NOTOC", 1); -define("MAG_START", 2); -define("MAG_CURRENTMONTH", 3); -define("MAG_CURRENTMONTHNAME", 4); -define("MAG_CURRENTDAY", 5); -define("MAG_CURRENTDAYNAME", 6); -define("MAG_CURRENTYEAR", 7); -define("MAG_CURRENTTIME", 8); -define("MAG_NUMBEROFARTICLES", 9); -define("MAG_CURRENTMONTHNAMEGEN", 10); -define("MAG_MSG", 11); -define("MAG_SUBST", 12); -define("MAG_MSGNW", 13); -define("MAG_NOEDITSECTION", 14); -define("MAG_END", 15); -define("MAG_IMG_THUMBNAIL", 16); -define("MAG_IMG_RIGHT", 17); -define("MAG_IMG_LEFT", 18); -define("MAG_IMG_NONE", 19); -define("MAG_IMG_WIDTH", 20); -define("MAG_IMG_CENTER", 21); -define("MAG_INT", 22); -define("MAG_FORCETOC", 23); -define("MAG_SITENAME", 24); -define("MAG_NS", 25); -define("MAG_LOCALURL", 26); -define("MAG_LOCALURLE", 27); -define("MAG_SERVER", 28); -define("MAG_IMG_FRAMED", 29); -define("MAG_PAGENAME", 30); -define("MAG_NAMESPACE", 31); - -$wgVariableIDs = array( - MAG_CURRENTMONTH, - MAG_CURRENTMONTHNAME, - MAG_CURRENTDAY, - MAG_CURRENTDAYNAME, - MAG_CURRENTYEAR, - MAG_CURRENTTIME, - MAG_NUMBEROFARTICLES, - MAG_CURRENTMONTHNAMEGEN, - MAG_SITENAME, - MAG_SERVER, - MAG_PAGENAME, - MAG_NAMESPACE -); - +/** + * This class encapsulates "magic words" such as #redirect, __NOTOC__, etc. + * Usage: + * if (MagicWord::get( 'redirect' )->match( $text ) ) + * + * Possible future improvements: + * * Simultaneous searching for a number of magic words + * * MagicWord::$mObjects in shared memory + * + * Please avoid reading the data out of one of these objects and then writing + * special case code. If possible, add another match()-like function here. + * + * To add magic words in an extension, use the LanguageGetMagic hook. For + * magic words which are also Parser variables, add a MagicWordwgVariableIDs + * hook. Use string keys. + * + * @package MediaWiki + */ class MagicWord { - /*private*/ var $mId, $mSynonyms, $mCaseSensitive, $mRegex; - /*private*/ var $mRegexStart, $mBaseRegex, $mVariableRegex; - /*private*/ var $mModified; + /**#@+ + * @private + */ + var $mId, $mSynonyms, $mCaseSensitive, $mRegex; + var $mRegexStart, $mBaseRegex, $mVariableRegex; + var $mModified, $mFound; + + static public $mVariableIDsInitialised = false; + static public $mVariableIDs = array( + 'currentmonth', + 'currentmonthname', + 'currentmonthnamegen', + 'currentmonthabbrev', + 'currentday', + 'currentday2', + 'currentdayname', + 'currentyear', + 'currenttime', + 'currenthour', + 'localmonth', + 'localmonthname', + 'localmonthnamegen', + 'localmonthabbrev', + 'localday', + 'localday2', + 'localdayname', + 'localyear', + 'localtime', + 'localhour', + 'numberofarticles', + 'numberoffiles', + 'sitename', + 'server', + 'servername', + 'scriptpath', + 'pagename', + 'pagenamee', + 'fullpagename', + 'fullpagenamee', + 'namespace', + 'namespacee', + 'currentweek', + 'currentdow', + 'localweek', + 'localdow', + 'revisionid', + 'revisionday', + 'revisionday2', + 'revisionmonth', + 'revisionyear', + 'revisiontimestamp', + 'subpagename', + 'subpagenamee', + 'displaytitle', + 'talkspace', + 'talkspacee', + 'subjectspace', + 'subjectspacee', + 'talkpagename', + 'talkpagenamee', + 'subjectpagename', + 'subjectpagenamee', + 'numberofusers', + 'rawsuffix', + 'newsectionlink', + 'numberofpages', + 'currentversion', + 'basepagename', + 'basepagenamee', + 'urlencode', + 'currenttimestamp', + 'localtimestamp', + 'directionmark', + 'language', + 'contentlanguage', + 'pagesinnamespace', + 'numberofadmins', + ); + + static public $mObjects = array(); + + /**#@-*/ - function MagicWord($id = 0, $syn = "", $cs = false) - { + function MagicWord($id = 0, $syn = '', $cs = false) { $this->mId = $id; $this->mSynonyms = (array)$syn; $this->mCaseSensitive = $cs; - $this->mRegex = ""; - $this->mRegexStart = ""; - $this->mVariableRegex = ""; - $this->mVariableStartToEndRegex = ""; + $this->mRegex = ''; + $this->mRegexStart = ''; + $this->mVariableRegex = ''; + $this->mVariableStartToEndRegex = ''; $this->mModified = false; } - # Factory: creates an object representing an ID - /*static*/ function &get( $id ) - { - global $wgMagicWords; - - if (!array_key_exists( $id, $wgMagicWords ) ) { + /** + * Factory: creates an object representing an ID + * @static + */ + static function &get( $id ) { + if (!array_key_exists( $id, self::$mObjects ) ) { $mw = new MagicWord(); $mw->load( $id ); - $wgMagicWords[$id] = $mw; + self::$mObjects[$id] = $mw; + } + return self::$mObjects[$id]; + } + + /** + * Get an array of parser variable IDs + */ + static function getVariableIDs() { + if ( !self::$mVariableIDsInitialised ) { + # Deprecated constant definition hook, available for extensions that need it + $magicWords = array(); + wfRunHooks( 'MagicWordMagicWords', array( &$magicWords ) ); + foreach ( $magicWords as $word ) { + define( $word, $word ); + } + + # Get variable IDs + wfRunHooks( 'MagicWordwgVariableIDs', array( &self::$mVariableIDs ) ); + self::$mVariableIDsInitialised = true; } - return $wgMagicWords[$id]; + return self::$mVariableIDs; } - + # Initialises this object with an ID - function load( $id ) - { - global $wgLang; + function load( $id ) { + global $wgContLang; $this->mId = $id; - $wgLang->getMagic( $this ); + $wgContLang->getMagic( $this ); + if ( !$this->mSynonyms ) { + $this->mSynonyms = array( 'dkjsagfjsgashfajsh' ); + #throw new MWException( "Error: invalid magic word '$id'" ); + wfDebugLog( 'exception', "Error: invalid magic word '$id'\n" ); + } } - - # Preliminary initialisation - /* private */ function initRegex() - { - $variableClass = Title::legalChars(); - $escSyn = array_map( "preg_quote", $this->mSynonyms ); - $this->mBaseRegex = implode( "|", $escSyn ); - $case = $this->mCaseSensitive ? "" : "i"; + + /** + * Preliminary initialisation + * @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 + + $escSyn = array(); + foreach ( $this->mSynonyms as $synonym ) + // In case a magic word contains /, like that's going to happen;) + $escSyn[] = preg_quote( $synonym, '/' ); + $this->mBaseRegex = implode( '|', $escSyn ); + + $case = $this->mCaseSensitive ? '' : 'i'; $this->mRegex = "/{$this->mBaseRegex}/{$case}"; - $this->mRegexStart = "/^{$this->mBaseRegex}/{$case}"; - $this->mVariableRegex = str_replace( "\\$1", "([$variableClass]*?)", $this->mRegex ); - $this->mVariableStartToEndRegex = str_replace( "\\$1", "([$variableClass]*?)", - "/^{$this->mBaseRegex}$/{$case}" ); + $this->mRegexStart = "/^(?:{$this->mBaseRegex})/{$case}"; + $this->mVariableRegex = str_replace( "\\$1", "(.*?)", $this->mRegex ); + $this->mVariableStartToEndRegex = str_replace( "\\$1", "(.*?)", + "/^(?:{$this->mBaseRegex})$/{$case}" ); } - - # Gets a regex representing matching the word - function getRegex() - { - if ($this->mRegex == "" ) { + + /** + * Gets a regex representing matching the word + */ + function getRegex() { + if ($this->mRegex == '' ) { $this->initRegex(); } return $this->mRegex; } - # Gets a regex matching the word, if it is at the - # string start - function getRegexStart() - { - 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 + */ + function getRegexCase() { + if ( $this->mRegex === '' ) + $this->initRegex(); + + return $this->mCaseSensitive ? '' : 'i'; + } + + /** + * Gets a regex matching the word, if it is at the string start + */ + function getRegexStart() { + if ($this->mRegex == '' ) { $this->initRegex(); } return $this->mRegexStart; } - # regex without the slashes and what not - function getBaseRegex() - { - if ($this->mRegex == "") { + /** + * regex without the slashes and what not + */ + function getBaseRegex() { + if ($this->mRegex == '') { $this->initRegex(); } return $this->mBaseRegex; } - - # Returns true if the text contains the word + + /** + * Returns true if the text contains the word + * @return bool + */ function match( $text ) { return preg_match( $this->getRegex(), $text ); } - # Returns true if the text starts with the word - function matchStart( $text ) - { + /** + * Returns true if the text starts with the word + * @return bool + */ + function matchStart( $text ) { return preg_match( $this->getRegexStart(), $text ); } - # Returns NULL if there's no match, the value of $1 otherwise - # 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. + /** + * Returns NULL if there's no match, the value of $1 otherwise + * 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. + */ function matchVariableStartToEnd( $text ) { + $matches = array(); $matchcount = preg_match( $this->getVariableStartToEndRegex(), $text, $matches ); if ( $matchcount == 0 ) { return NULL; - } elseif ( count($matches) == 1 ) { - return $matches[0]; } else { - return $matches[1]; + # multiple matched parts (variable match); some will be empty because of + # synonyms. The variable will be the second non-empty one so remove any + # blank elements and re-sort the indices. + # See also bug 6526 + + $matches = array_values(array_filter($matches)); + + 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 - function matchAndRemove( &$text ) - { - global $wgMagicFound; - $wgMagicFound = false; - $text = preg_replace_callback( $this->getRegex(), "pregRemoveAndRecord", $text ); - return $wgMagicFound; + /** + * Returns true if the text matches the word, and alters the + * input string, removing all instances of the word + */ + function matchAndRemove( &$text ) { + $this->mFound = false; + $text = preg_replace_callback( $this->getRegex(), array( &$this, 'pregRemoveAndRecord' ), $text ); + return $this->mFound; } function matchStartAndRemove( &$text ) { - global $wgMagicFound; - $wgMagicFound = false; - $text = preg_replace_callback( $this->getRegexStart(), "pregRemoveAndRecord", $text ); - return $wgMagicFound; - } + $this->mFound = false; + $text = preg_replace_callback( $this->getRegexStart(), array( &$this, 'pregRemoveAndRecord' ), $text ); + return $this->mFound; + } + /** + * Used in matchAndRemove() + * @private + **/ + function pregRemoveAndRecord( $match ) { + $this->mFound = true; + return ''; + } - # Replaces the word with something else - function replace( $replacement, $subject ) - { - $res = preg_replace( $this->getRegex(), $replacement, $subject ); + /** + * Replaces the word with something else + */ + function replace( $replacement, $subject, $limit=-1 ) { + $res = preg_replace( $this->getRegex(), wfRegexReplacement( $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 + /** + * Variable handling: {{SUBST:xxx}} style words + * Calls back a function to determine what to replace xxx with + * Input word must contain $1 + */ function substituteCallback( $text, $callback ) { - $regex = $this->getVariableRegex(); $res = preg_replace_callback( $this->getVariableRegex(), $callback, $text ); $this->mModified = !($res === $text); return $res; } - # Matches the word, where $1 is a wildcard - function getVariableRegex() - { - if ( $this->mVariableRegex == "" ) { + /** + * Matches the word, where $1 is a wildcard + */ + function getVariableRegex() { + if ( $this->mVariableRegex == '' ) { $this->initRegex(); - } + } return $this->mVariableRegex; } - # Matches the entire string, where $1 is a wildcard - function getVariableStartToEndRegex() - { - if ( $this->mVariableStartToEndRegex == "" ) { + /** + * Matches the entire string, where $1 is a wildcard + */ + function getVariableStartToEndRegex() { + if ( $this->mVariableStartToEndRegex == '' ) { $this->initRegex(); - } + } return $this->mVariableStartToEndRegex; } - # Accesses the synonym list directly + /** + * Accesses the synonym list directly + */ function getSynonym( $i ) { return $this->mSynonyms[$i]; } - # Returns true if the last call to replace() or substituteCallback() - # returned a modified text, otherwise false. + function getSynonyms() { + return $this->mSynonyms; + } + + /** + * Returns true if the last call to replace() or substituteCallback() + * returned a modified text, otherwise false. + */ function getWasModified(){ return $this->mModified; } - # $magicarr is an associative array of (magic word ID => replacement) - # 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 */ function replaceMultiple( $magicarr, $subject, &$result ){ + /** + * $magicarr is an associative array of (magic word ID => replacement) + * 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 + **/ + function replaceMultiple( $magicarr, $subject, &$result ){ $search = array(); $replace = array(); foreach( $magicarr as $id => $replacement ){ @@ -251,21 +373,19 @@ class MagicWord { return !($result === $subject); } - # Adds all the synonyms of this MagicWord to an array, to allow quick lookup in a list of magic words - function addToArray( &$array, $value ) - { + /** + * Adds all the synonyms of this MagicWord to an array, to allow quick + * lookup in a list of magic words + */ + function addToArray( &$array, $value ) { foreach ( $this->mSynonyms as $syn ) { $array[$syn] = $value; } } -} -# Used in matchAndRemove() -/*private*/ function pregRemoveAndRecord( $match ) -{ - global $wgMagicFound; - $wgMagicFound = true; - return ""; + function isCaseSensitive() { + return $this->mCaseSensitive; + } } ?>