Fix syntax terror from r79884
[lhc/web/wiklou.git] / includes / MagicWord.php
index d92817e..4698960 100644 (file)
@@ -1,6 +1,7 @@
 <?php
 /**
  * File for magic words
+ *
  * See docs/magicword.txt
  *
  * @file
@@ -60,10 +61,12 @@ class MagicWord {
                'numberofarticles',
                'numberoffiles',
                'numberofedits',
+               'articlepath',
                'sitename',
                'server',
                'servername',
                'scriptpath',
+               'stylepath',
                'pagename',
                'pagenamee',
                'fullpagename',
@@ -78,6 +81,7 @@ class MagicWord {
                'revisionday',
                'revisionday2',
                'revisionmonth',
+               'revisionmonth1',
                'revisionyear',
                'revisiontimestamp',
                'revisionuser',
@@ -107,46 +111,45 @@ class MagicWord {
 
        /* Array of caching hints for ParserCache */
        static public $mCacheTTLs = array (
-               'currentmonth'           => 86400,
-               'currentmonth1'          => 86400,
-               'currentmonthname'       => 86400,
-               'currentmonthnamegen'    => 86400,
-               'currentmonthabbrev'     => 86400,
-               'currentday'             => 3600,
-               'currentday2'            => 3600,
-               'currentdayname'         => 3600,
-               'currentyear'            => 86400,
-               'currenttime'            => 3600,
-               'currenthour'            => 3600,
-               'localmonth'             => 86400,
-               'localmonth1'            => 86400,
-               'localmonthname'         => 86400,
-               'localmonthnamegen'      => 86400,
-               'localmonthabbrev'       => 86400,
-               'localday'               => 3600,
-               'localday2'              => 3600,
-               'localdayname'           => 3600,
-               'localyear'              => 86400,
-               'localtime'              => 3600,
-               'localhour'              => 3600,
-               'numberofarticles'       => 3600,
-               'numberoffiles'          => 3600,
-               'numberofedits'          => 3600,
-               'currentweek'            => 3600,
-               'currentdow'             => 3600,
-               'localweek'              => 3600,
-               'localdow'               => 3600,
-               'numberofusers'          => 3600,
-               'numberofactiveusers'    => 3600,
-               'numberofpages'          => 3600,
-               'currentversion'         => 86400,
-               'currenttimestamp'       => 3600,
-               'localtimestamp'         => 3600,
-               'pagesinnamespace'       => 3600,
-               'numberofadmins'         => 3600,
-               'numberofviews'          => 3600,
-               'numberingroup'          => 3600,
-               'numberofcontribs'       => 3600,
+               'currentmonth' => 86400,
+               'currentmonth1' => 86400,
+               'currentmonthname' => 86400,
+               'currentmonthnamegen' => 86400,
+               'currentmonthabbrev' => 86400,
+               'currentday' => 3600,
+               'currentday2' => 3600,
+               'currentdayname' => 3600,
+               'currentyear' => 86400,
+               'currenttime' => 3600,
+               'currenthour' => 3600,
+               'localmonth' => 86400,
+               'localmonth1' => 86400,
+               'localmonthname' => 86400,
+               'localmonthnamegen' => 86400,
+               'localmonthabbrev' => 86400,
+               'localday' => 3600,
+               'localday2' => 3600,
+               'localdayname' => 3600,
+               'localyear' => 86400,
+               'localtime' => 3600,
+               'localhour' => 3600,
+               'numberofarticles' => 3600,
+               'numberoffiles' => 3600,
+               'numberofedits' => 3600,
+               'currentweek' => 3600,
+               'currentdow' => 3600,
+               'localweek' => 3600,
+               'localdow' => 3600,
+               'numberofusers' => 3600,
+               'numberofactiveusers' => 3600,
+               'numberofpages' => 3600,
+               'currentversion' => 86400,
+               'currenttimestamp' => 3600,
+               'localtimestamp' => 3600,
+               'pagesinnamespace' => 3600,
+               'numberofadmins' => 3600,
+               'numberofviews' => 3600,
+               'numberingroup' => 3600,
                );
 
        static public $mDoubleUnderscoreIDs = array(
@@ -161,8 +164,14 @@ class MagicWord {
                'index',
                'noindex',
                'staticredirect',
+               'notitleconvert',
+               'nocontentconvert',
        );
 
+       static public $mSubstIDs = array(
+               'subst',
+               'safesubst',
+       );
 
        static public $mObjects = array();
        static public $mDoubleUnderscoreArray = null;
@@ -186,7 +195,7 @@ class MagicWord {
         */
        static function &get( $id ) {
                wfProfileIn( __METHOD__ );
-               if (!array_key_exists( $id, self::$mObjects ) ) {
+               if ( !isset( self::$mObjects[$id] ) ) {
                        $mw = new MagicWord();
                        $mw->load( $id );
                        self::$mObjects[$id] = $mw;
@@ -214,6 +223,13 @@ class MagicWord {
                return self::$mVariableIDs;
        }
 
+       /**
+        * Get an array of parser substitution modifier IDs
+        */
+       static function getSubstIDs() {
+               return self::$mSubstIDs; 
+       }
+
        /* Allow external reads of TTL array */
        static function getCacheTTL($id) {
                if (array_key_exists($id,self::$mCacheTTLs)) {
@@ -231,6 +247,14 @@ class MagicWord {
                return self::$mDoubleUnderscoreArray;
        }
 
+       /**
+        * Clear the self::$mObjects variable
+        * For use in parser tests
+        */
+       public static function clearCache() {
+               self::$mObjects = array();
+       }
+
        # Initialises this object with an ID
        function load( $id ) {
                global $wgContLang;
@@ -314,7 +338,7 @@ class MagicWord {
         * @return bool
         */
        function match( $text ) {
-               return preg_match( $this->getRegex(), $text );
+               return (bool)preg_match( $this->getRegex(), $text );
        }
 
        /**
@@ -322,7 +346,7 @@ class MagicWord {
         * @return bool
         */
        function matchStart( $text ) {
-               return preg_match( $this->getRegexStart(), $text );
+               return (bool)preg_match( $this->getRegexStart(), $text );
        }
 
        /**
@@ -335,7 +359,7 @@ class MagicWord {
                $matches = array();
                $matchcount = preg_match( $this->getVariableStartToEndRegex(), $text, $matches );
                if ( $matchcount == 0 ) {
-                       return NULL;
+                       return null;
                } else {
                        # multiple matched parts (variable match); some will be empty because of
                        # synonyms. The variable will be the second non-empty one so remove any
@@ -492,7 +516,6 @@ class MagicWordArray {
         * Add a magic word by name
         */
        public function add( $name ) {
-               global $wgContLang;
                $this->names[] = $name;
                $this->hash = $this->baseRegex = $this->regex = null;
        }
@@ -549,7 +572,7 @@ class MagicWordArray {
        }
 
        /**
-        * Get an unanchored regex
+        * Get an unanchored regex that does not match parameters
         */
        function getRegex() {
                if ( is_null( $this->regex ) ) {
@@ -566,14 +589,29 @@ class MagicWordArray {
        }
 
        /**
-        * Get a regex for matching variables
+        * Get a regex for matching variables with parameters
         */
        function getVariableRegex() {
                return str_replace( "\\$1", "(.*?)", $this->getRegex() );
        }
 
        /**
-        * Get an anchored regex for matching variables
+        * Get a regex anchored to the start of the string that does not match parameters
+        */
+       function getRegexStart() {
+               $base = $this->getBaseRegex();
+               $newRegex = array( '', '' );
+               if ( $base[0] !== '' ) {
+                       $newRegex[0] = "/^(?:{$base[0]})/iuS";
+               }
+               if ( $base[1] !== '' ) {
+                       $newRegex[1] = "/^(?:{$base[1]})/S"; 
+               }
+               return $newRegex;
+       }
+
+       /**
+        * Get an anchored regex for matching variables with parameters
         */
        function getVariableStartToEndRegex() {
                $base = $this->getBaseRegex();
@@ -610,7 +648,6 @@ class MagicWordArray {
                }
                // This shouldn't happen either
                throw new MWException( __METHOD__.': parameter not found' );
-               return array( false, false );
        }
 
        /**
@@ -620,7 +657,6 @@ class MagicWordArray {
         * Both elements are false if there was no match.
         */
        public function matchVariableStartToEnd( $text ) {
-               global $wgContLang;
                $regexes = $this->getVariableStartToEndRegex();
                foreach ( $regexes as $regex ) {
                        if ( $regex !== '' ) {
@@ -670,4 +706,29 @@ class MagicWordArray {
                }
                return $found;
        }
+
+       /**
+        * 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.
+        */
+       public function matchStartAndRemove( &$text ) {
+               $regexes = $this->getRegexStart();
+               foreach ( $regexes as $regex ) {
+                       if ( $regex === '' ) {
+                               continue;
+                       }
+                       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;
+                       }
+               }
+               return false;
+       }
 }