Oops, forgot to change this in r71426

[lhc/web/wiklou.git] / includes / MagicWord.php

diff --git a/includes/MagicWord.php b/includes/MagicWord.php
index 4f5148a..a0bcd8c 100644 (file)
--- a/includes/MagicWord.php
+++ b/includes/MagicWord.php
@@ -1,9 +1,11 @@
 <?php
 /**
  * File for magic words
+ *
  * See docs/magicword.txt
  *
- * @addtogroup Parser
+ * @file
+ * @ingroup Parser
  */
 
 /**
@@ -22,6 +24,7 @@
  * magic words which are also Parser variables, add a MagicWordwgVariableIDs
  * hook. Use string keys.
  *
+ * @ingroup Parser
  */
 class MagicWord {
        /**#@+
@@ -34,6 +37,7 @@ class MagicWord {
        static public $mVariableIDsInitialised = false;
        static public $mVariableIDs = array(
                'currentmonth',
+               'currentmonth1',
                'currentmonthname',
                'currentmonthnamegen',
                'currentmonthabbrev',
@@ -44,6 +48,7 @@ class MagicWord {
                'currenttime',
                'currenthour',
                'localmonth',
+               'localmonth1',
                'localmonthname',
                'localmonthnamegen',
                'localmonthabbrev',
@@ -56,10 +61,12 @@ class MagicWord {
                'numberofarticles',
                'numberoffiles',
                'numberofedits',
+               'articlepath',
                'sitename',
                'server',
                'servername',
                'scriptpath',
+               'stylepath',
                'pagename',
                'pagenamee',
                'fullpagename',
@@ -74,11 +81,12 @@ class MagicWord {
                'revisionday',
                'revisionday2',
                'revisionmonth',
+               'revisionmonth1',
                'revisionyear',
                'revisiontimestamp',
+               'revisionuser',
                'subpagename',
                'subpagenamee',
-               'displaytitle',
                'talkspace',
                'talkspacee',
                'subjectspace',
@@ -88,26 +96,23 @@ class MagicWord {
                'subjectpagename',
                'subjectpagenamee',
                'numberofusers',
-               'newsectionlink',
+               'numberofactiveusers',
                'numberofpages',
                'currentversion',
                'basepagename',
                'basepagenamee',
-               'urlencode',
                'currenttimestamp',
                'localtimestamp',
                'directionmark',
-               'language',
                'contentlanguage',
-               'pagesinnamespace',
                'numberofadmins',
-               'defaultsort',
-               'pagesincategory',
+               'numberofviews',
        );
 
        /* Array of caching hints for ParserCache */
        static public $mCacheTTLs = array (
                'currentmonth' => 86400,
+               'currentmonth1' => 86400,
                'currentmonthname' => 86400,
                'currentmonthnamegen' => 86400,
                'currentmonthabbrev' => 86400,
@@ -118,6 +123,7 @@ class MagicWord {
                'currenttime' => 3600,
                'currenthour' => 3600,
                'localmonth' => 86400,
+               'localmonth1' => 86400,
                'localmonthname' => 86400,
                'localmonthnamegen' => 86400,
                'localmonthabbrev' => 86400,
@@ -135,12 +141,15 @@ class MagicWord {
                '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(
@@ -150,9 +159,19 @@ class MagicWord {
                'toc',
                'noeditsection',
                'newsectionlink',
+               'nonewsectionlink',
                'hiddencat',
+               'index',
+               'noindex',
+               'staticredirect',
+               'notitleconvert',
+               'nocontentconvert',
        );
 
+       static public $mSubstIDs = array(
+               'subst',
+               'safesubst',
+       );
 
        static public $mObjects = array();
        static public $mDoubleUnderscoreArray = null;
@@ -176,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;
@@ -204,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)) {
@@ -221,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;
@@ -304,7 +338,7 @@ class MagicWord {
         * @return bool
         */
        function match( $text ) {
-               return preg_match( $this->getRegex(), $text );
+               return (bool)preg_match( $this->getRegex(), $text );
        }
 
        /**
@@ -312,7 +346,7 @@ class MagicWord {
         * @return bool
         */
        function matchStart( $text ) {
-               return preg_match( $this->getRegexStart(), $text );
+               return (bool)preg_match( $this->getRegexStart(), $text );
        }
 
        /**
@@ -325,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
@@ -466,6 +500,7 @@ class MagicWord {
 
 /**
  * Class for handling an array of magic words
+ * @ingroup Parser
  */
 class MagicWordArray {
        var $names = array();
@@ -481,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;
        }
@@ -538,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 ) ) {
@@ -555,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();
@@ -609,7 +658,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 !== '' ) {
@@ -659,4 +707,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, $param ) = $this->parseMatch( $m );
+                               if ( strlen( $m[0] ) >= strlen( $text ) ) {
+                                       $text = '';
+                               } else {
+                                       $text = substr( $text, strlen( $m[0] ) );
+                               }
+                               return $id;
+                       }
+               }
+               return false;
+       }
 }