* Fix explicit s-maxage=0 on raw pages; should help with proxy issues in
[lhc/web/wiklou.git] / includes / MagicWord.php
index e038328..9d0b3bf 100644 (file)
@@ -21,6 +21,7 @@ $magicWords = array(
        'MAG_CURRENTMONTHNAMEGEN',
        'MAG_CURRENTMONTHABBREV',
        'MAG_CURRENTDAY',
+       'MAG_CURRENTDAY2',
        'MAG_CURRENTDAYNAME',
        'MAG_CURRENTYEAR',
        'MAG_CURRENTTIME',
@@ -68,7 +69,10 @@ $magicWords = array(
        'MAG_UC',
        'MAG_FULLPAGENAME',
        'MAG_FULLPAGENAMEE',
+       'MAG_RAW',
 );
+if ( ! defined( 'MEDIAWIKI_INSTALL' ) )
+       wfRunHooks( 'MagicWordMagicWords', array( &$magicWords ) );
 
 for ( $i = 0; $i < count( $magicWords ); ++$i )
        define( $magicWords[$i], $i );
@@ -79,6 +83,7 @@ $wgVariableIDs = array(
        MAG_CURRENTMONTHNAMEGEN,
        MAG_CURRENTMONTHABBREV,
        MAG_CURRENTDAY,
+       MAG_CURRENTDAY2,
        MAG_CURRENTDAYNAME,
        MAG_CURRENTYEAR,
        MAG_CURRENTTIME,
@@ -98,17 +103,19 @@ $wgVariableIDs = array(
        MAG_CURRENTDOW,
        MAG_REVISIONID,
 );
+if ( ! defined( 'MEDIAWIKI_INSTALL' ) )
+       wfRunHooks( 'MagicWordwgVariableIDs', array( &$wgVariableIDs ) );
 
 /**
  * This class encapsulates "magic words" such as #redirect, __NOTOC__, etc.
  * Usage:
  *     if (MagicWord::get( MAG_REDIRECT )->match( $text ) )
- * 
- * Possible future improvements: 
+ *
+ * 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 
+ * 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.
  *
  * @package MediaWiki
@@ -119,7 +126,7 @@ class MagicWord {
         */
        var $mId, $mSynonyms, $mCaseSensitive, $mRegex;
        var $mRegexStart, $mBaseRegex, $mVariableRegex;
-       var $mModified; 
+       var $mModified;
        /**#@-*/
 
        function MagicWord($id = 0, $syn = '', $cs = false) {
@@ -139,7 +146,7 @@ class MagicWord {
         */
        function &get( $id ) {
                global $wgMagicWords;
-               
+
                if ( !is_array( $wgMagicWords ) ) {
                        wfDebugDieBacktrace( "Incorrect initialisation order, \$wgMagicWords does not exist\n" );
                }
@@ -150,33 +157,38 @@ class MagicWord {
                }
                return $wgMagicWords[$id];
        }
-       
+
        # Initialises this object with an ID
        function load( $id ) {
-               global $wgContLang;             
+               global $wgContLang;
                $this->mId = $id;
                $wgContLang->getMagic( $this );
        }
-       
+
        /**
         * Preliminary initialisation
-        * @private
+        * @access 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_map( 'preg_quote', $this->mSynonyms );
+               
+               $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", "(.*?)", $this->mRegex );
-               $this->mVariableStartToEndRegex = str_replace( "\\$1", "(.*?)", 
+               $this->mVariableStartToEndRegex = str_replace( "\\$1", "(.*?)",
                        "/^(?:{$this->mBaseRegex})$/{$case}" );
        }
-       
+
        /**
         * Gets a regex representing matching the word
         */
@@ -187,6 +199,18 @@ class MagicWord {
                return $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
         */
@@ -206,7 +230,7 @@ class MagicWord {
                }
                return $this->mBaseRegex;
        }
-               
+
        /**
         * Returns true if the text contains the word
         * @return bool
@@ -230,6 +254,7 @@ class MagicWord {
         * is one.
         */
        function matchVariableStartToEnd( $text ) {
+               $matches = array();
                $matchcount = preg_match( $this->getVariableStartToEndRegex(), $text, $matches );
                if ( $matchcount == 0 ) {
                        return NULL;
@@ -260,14 +285,14 @@ class MagicWord {
                $wgMagicFound = false;
                $text = preg_replace_callback( $this->getRegexStart(), 'pregRemoveAndRecord', $text );
                return $wgMagicFound;
-       }               
+       }
 
 
        /**
         * Replaces the word with something else
         */
        function replace( $replacement, $subject ) {
-               $res = preg_replace( $this->getRegex(), $replacement, $subject );
+               $res = preg_replace( $this->getRegex(), wfRegexReplacement( $replacement ), $subject );
                $this->mModified = !($res === $subject);
                return $res;
        }
@@ -278,7 +303,6 @@ class MagicWord {
         * 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;
@@ -290,7 +314,7 @@ class MagicWord {
        function getVariableRegex()     {
                if ( $this->mVariableRegex == '' ) {
                        $this->initRegex();
-               } 
+               }
                return $this->mVariableRegex;
        }
 
@@ -300,7 +324,7 @@ class MagicWord {
        function getVariableStartToEndRegex() {
                if ( $this->mVariableStartToEndRegex == '' ) {
                        $this->initRegex();
-               } 
+               }
                return $this->mVariableStartToEndRegex;
        }
 
@@ -312,7 +336,7 @@ class MagicWord {
        }
 
        /**
-        * Returns true if the last call to replace() or substituteCallback() 
+        * Returns true if the last call to replace() or substituteCallback()
         * returned a modified text, otherwise false.
         */
        function getWasModified(){
@@ -324,7 +348,7 @@ class MagicWord {
         * 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 
+        * @static
         **/
        function replaceMultiple( $magicarr, $subject, &$result ){
                $search = array();
@@ -352,7 +376,7 @@ class MagicWord {
 
 /**
  * Used in matchAndRemove()
- * @private
+ * @access private
  **/
 function pregRemoveAndRecord( $match ) {
        global $wgMagicFound;