11 $wgMagicFound = false;
13 /** Actual keyword to be used is set in Language.php */
14 define('MAG_REDIRECT', 0);
15 define('MAG_NOTOC', 1);
16 define('MAG_START', 2);
17 define('MAG_CURRENTMONTH', 3);
18 define('MAG_CURRENTMONTHNAME', 4);
19 define('MAG_CURRENTMONTHNAMEGEN', 5);
20 define('MAG_CURRENTMONTHABBREV', 6);
21 define('MAG_CURRENTDAY', 7);
22 define('MAG_CURRENTDAYNAME', 8);
23 define('MAG_CURRENTYEAR', 9);
24 define('MAG_CURRENTTIME', 10);
25 define('MAG_NUMBEROFARTICLES', 11);
26 define('MAG_SUBST', 12);
27 define('MAG_MSG', 13);
28 define('MAG_MSGNW', 14);
29 define('MAG_NOEDITSECTION', 15);
30 define('MAG_END', 16);
31 define('MAG_IMG_THUMBNAIL', 17);
32 define('MAG_IMG_RIGHT', 18);
33 define('MAG_IMG_LEFT', 19);
34 define('MAG_IMG_NONE', 20);
35 define('MAG_IMG_WIDTH', 21);
36 define('MAG_IMG_CENTER', 22);
37 define('MAG_INT', 23);
38 define('MAG_FORCETOC', 24);
39 define('MAG_SITENAME', 25);
41 define('MAG_LOCALURL', 27);
42 define('MAG_LOCALURLE', 28);
43 define('MAG_SERVER', 29);
44 define('MAG_IMG_FRAMED', 30);
45 define('MAG_PAGENAME', 31);
46 define('MAG_PAGENAMEE', 32);
47 define('MAG_NAMESPACE', 33);
48 define('MAG_TOC', 34);
49 define('MAG_GRAMMAR', 35);
50 define('MAG_NOTITLECONVERT', 36);
51 define('MAG_NOCONTENTCONVERT', 37);
52 define('MAG_CURRENTWEEK', 38);
53 define('MAG_CURRENTDOW', 39);
54 define('MAG_REVISIONID', 40);
55 define('MAG_SCRIPTPATH', 41);
56 define('MAG_SERVERNAME', 42);
57 define('MAG_NUMBEROFFILES', 43);
58 define('MAG_IMG_MANUALTHUMB', 44);
59 define('MAG_PLURAL', 45);
61 $wgVariableIDs = array(
64 MAG_CURRENTMONTHNAMEGEN
,
65 MAG_CURRENTMONTHABBREV
,
85 * This class encapsulates "magic words" such as #redirect, __NOTOC__, etc.
87 * if (MagicWord::get( MAG_REDIRECT )->match( $text ) )
89 * Possible future improvements:
90 * * Simultaneous searching for a number of magic words
91 * * $wgMagicWords in shared memory
93 * Please avoid reading the data out of one of these objects and then writing
94 * special case code. If possible, add another match()-like function here.
102 var $mId, $mSynonyms, $mCaseSensitive, $mRegex;
103 var $mRegexStart, $mBaseRegex, $mVariableRegex;
107 function MagicWord($id = 0, $syn = '', $cs = false) {
109 $this->mSynonyms
= (array)$syn;
110 $this->mCaseSensitive
= $cs;
112 $this->mRegexStart
= '';
113 $this->mVariableRegex
= '';
114 $this->mVariableStartToEndRegex
= '';
115 $this->mModified
= false;
119 * Factory: creates an object representing an ID
122 function &get( $id ) {
123 global $wgMagicWords;
125 if ( !is_array( $wgMagicWords ) ) {
126 wfDebugDieBacktrace( "Incorrect initialisation order, \$wgMagicWords does not exist\n" );
128 if (!array_key_exists( $id, $wgMagicWords ) ) {
129 $mw = new MagicWord();
131 $wgMagicWords[$id] = $mw;
133 return $wgMagicWords[$id];
136 # Initialises this object with an ID
137 function load( $id ) {
140 $wgContLang->getMagic( $this );
144 * Preliminary initialisation
147 function initRegex() {
148 #$variableClass = Title::legalChars();
149 # This was used for matching "$1" variables, but different uses of the feature will have
150 # different restrictions, which should be checked *after* the MagicWord has been matched,
152 $escSyn = array_map( 'preg_quote', $this->mSynonyms
);
153 $this->mBaseRegex
= implode( '|', $escSyn );
154 $case = $this->mCaseSensitive ?
'' : 'i';
155 $this->mRegex
= "/{$this->mBaseRegex}/{$case}";
156 $this->mRegexStart
= "/^(?:{$this->mBaseRegex})/{$case}";
157 $this->mVariableRegex
= str_replace( "\\$1", "(.*?)", $this->mRegex
);
158 $this->mVariableStartToEndRegex
= str_replace( "\\$1", "(.*?)",
159 "/^(?:{$this->mBaseRegex})$/{$case}" );
163 * Gets a regex representing matching the word
165 function getRegex() {
166 if ($this->mRegex
== '' ) {
169 return $this->mRegex
;
173 * Gets a regex matching the word, if it is at the string start
175 function getRegexStart() {
176 if ($this->mRegex
== '' ) {
179 return $this->mRegexStart
;
183 * regex without the slashes and what not
185 function getBaseRegex() {
186 if ($this->mRegex
== '') {
189 return $this->mBaseRegex
;
193 * Returns true if the text contains the word
196 function match( $text ) {
197 return preg_match( $this->getRegex(), $text );
201 * Returns true if the text starts with the word
204 function matchStart( $text ) {
205 return preg_match( $this->getRegexStart(), $text );
209 * Returns NULL if there's no match, the value of $1 otherwise
210 * The return code is the matched string, if there's no variable
211 * part in the regex and the matched variable part ($1) if there
214 function matchVariableStartToEnd( $text ) {
215 $matchcount = preg_match( $this->getVariableStartToEndRegex(), $text, $matches );
216 if ( $matchcount == 0 ) {
218 } elseif ( count($matches) == 1 ) {
221 # multiple matched parts (variable match); some will be empty because of synonyms
222 # the variable will be the second non-empty one so remove any blank elements and re-sort the indices
223 $matches = array_values(array_filter($matches));
230 * Returns true if the text matches the word, and alters the
231 * input string, removing all instances of the word
233 function matchAndRemove( &$text ) {
234 global $wgMagicFound;
235 $wgMagicFound = false;
236 $text = preg_replace_callback( $this->getRegex(), 'pregRemoveAndRecord', $text );
237 return $wgMagicFound;
240 function matchStartAndRemove( &$text ) {
241 global $wgMagicFound;
242 $wgMagicFound = false;
243 $text = preg_replace_callback( $this->getRegexStart(), 'pregRemoveAndRecord', $text );
244 return $wgMagicFound;
249 * Replaces the word with something else
251 function replace( $replacement, $subject ) {
252 $res = preg_replace( $this->getRegex(), $replacement, $subject );
253 $this->mModified
= !($res === $subject);
258 * Variable handling: {{SUBST:xxx}} style words
259 * Calls back a function to determine what to replace xxx with
260 * Input word must contain $1
262 function substituteCallback( $text, $callback ) {
263 $regex = $this->getVariableRegex();
264 $res = preg_replace_callback( $this->getVariableRegex(), $callback, $text );
265 $this->mModified
= !($res === $text);
270 * Matches the word, where $1 is a wildcard
272 function getVariableRegex() {
273 if ( $this->mVariableRegex
== '' ) {
276 return $this->mVariableRegex
;
280 * Matches the entire string, where $1 is a wildcard
282 function getVariableStartToEndRegex() {
283 if ( $this->mVariableStartToEndRegex
== '' ) {
286 return $this->mVariableStartToEndRegex
;
290 * Accesses the synonym list directly
292 function getSynonym( $i ) {
293 return $this->mSynonyms
[$i];
297 * Returns true if the last call to replace() or substituteCallback()
298 * returned a modified text, otherwise false.
300 function getWasModified(){
301 return $this->mModified
;
305 * $magicarr is an associative array of (magic word ID => replacement)
306 * This method uses the php feature to do several replacements at the same time,
307 * thereby gaining some efficiency. The result is placed in the out variable
308 * $result. The return value is true if something was replaced.
311 function replaceMultiple( $magicarr, $subject, &$result ){
314 foreach( $magicarr as $id => $replacement ){
315 $mw = MagicWord
::get( $id );
316 $search[] = $mw->getRegex();
317 $replace[] = $replacement;
320 $result = preg_replace( $search, $replace, $subject );
321 return !($result === $subject);
325 * Adds all the synonyms of this MagicWord to an array, to allow quick
326 * lookup in a list of magic words
328 function addToArray( &$array, $value ) {
329 foreach ( $this->mSynonyms
as $syn ) {
330 $array[$syn] = $value;
336 * Used in matchAndRemove()
339 function pregRemoveAndRecord( $match ) {
340 global $wgMagicFound;
341 $wgMagicFound = true;