$out is needed here

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

diff --git a/includes/MagicWord.php b/includes/MagicWord.php
index 9e8d025..7c027d4 100644 (file)
--- a/includes/MagicWord.php
+++ b/includes/MagicWord.php
@@ -1,6 +1,8 @@
 <?php
 /**
  * File for magic words
+ * See docs/magicword.txt
+ *
  * @addtogroup Parser
  */
 
@@ -100,9 +102,60 @@ class MagicWord {
                'pagesinnamespace',
                'numberofadmins',
                'defaultsort',
+               'pagesincategory',
+       );
+       
+       /* Array of caching hints for ParserCache */
+       static public $mCacheTTLs = array (
+               'currentmonth' => 86400,
+               'currentmonthname' => 86400,
+               'currentmonthnamegen' => 86400,
+               'currentmonthabbrev' => 86400,
+               'currentday' => 3600,
+               'currentday2' => 3600,
+               'currentdayname' => 3600,
+               'currentyear' => 86400,
+               'currenttime' => 3600,
+               'currenthour' => 3600,
+               'localmonth' => 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,
+               'numberofpages' => 3600,
+               'currentversion' => 86400,
+               'currenttimestamp' => 3600,
+               'localtimestamp' => 3600,
+               'pagesinnamespace' => 3600,
+               'numberofadmins' => 3600,
+               );
+
+       static public $mDoubleUnderscoreIDs = array(
+               'notoc',
+               'nogallery',
+               'forcetoc',
+               'toc',
+               'noeditsection',
+               'newsectionlink',
+               'hiddencat',
        );
 
+
        static public $mObjects = array();
+       static public $mDoubleUnderscoreArray = null;
 
        /**#@-*/
 
@@ -122,11 +175,13 @@ class MagicWord {
         * @static
         */
        static function &get( $id ) {
+               wfProfileIn( __METHOD__ );
                if (!array_key_exists( $id, self::$mObjects ) ) {
                        $mw = new MagicWord();
                        $mw->load( $id );
                        self::$mObjects[$id] = $mw;
                }
+               wfProfileOut( __METHOD__ );
                return self::$mObjects[$id];
        }
 
@@ -148,7 +203,24 @@ class MagicWord {
                }
                return self::$mVariableIDs;
        }
+       
+       /* Allow external reads of TTL array */
+       static function getCacheTTL($id) {
+               if (array_key_exists($id,self::$mCacheTTLs)) {
+                       return self::$mCacheTTLs[$id];
+               } else {
+                       return -1;
+               }
+       }
 
+       /** Get a MagicWordArray of double-underscore entities */
+       static function getDoubleUnderscoreArray() {
+               if ( is_null( self::$mDoubleUnderscoreArray ) ) {
+                       self::$mDoubleUnderscoreArray = new MagicWordArray( self::$mDoubleUnderscoreIDs );
+               }
+               return self::$mDoubleUnderscoreArray;
+       }
+       
        # Initialises this object with an ID
        function load( $id ) {
                global $wgContLang;
@@ -399,6 +471,7 @@ class MagicWordArray {
        var $names = array();
        var $hash;
        var $baseRegex, $regex;
+       var $matches;
 
        function __construct( $names = array() ) {
                $this->names = $names;
@@ -505,6 +578,8 @@ class MagicWordArray {
 
        /**
         * Parse a match array from preg_match
+        * Returns array(magic word ID, parameter value)
+        * If there is no parameter value, that element will be false.
         */
        function parseMatch( $m ) {
                reset( $m );
@@ -518,7 +593,7 @@ class MagicWordArray {
                                // continue;
                                throw new MWException( __METHOD__ . ': bad parameter name' );
                        }
-                       list( $synIndex, $magicName ) = $parts;
+                       list( /* $synIndex */, $magicName ) = $parts;
                        $paramValue = next( $m );
                        return array( $magicName, $paramValue );
                }
@@ -536,7 +611,7 @@ class MagicWordArray {
        public function matchVariableStartToEnd( $text ) {
                global $wgContLang;
                $regexes = $this->getVariableStartToEndRegex();
-               foreach ( $regexes as $case => $regex ) {
+               foreach ( $regexes as $regex ) {
                        if ( $regex !== '' ) {
                                $m = false;
                                if ( preg_match( $regex, $text, $m ) ) {
@@ -563,4 +638,25 @@ class MagicWordArray {
                }
                return false;
        }
+
+       /**
+        * Returns an associative array, ID => param value, for all items that match
+        * Removes the matched items from the input string (passed by reference)
+        */
+       public function matchAndRemove( &$text ) {
+               $found = array();
+               $regexes = $this->getRegex();
+               foreach ( $regexes as $regex ) {
+                       if ( $regex === '' ) {
+                               continue;
+                       }
+                       preg_match_all( $regex, $text, $matches, PREG_SET_ORDER );
+                       foreach ( $matches as $m ) {
+                               list( $name, $param ) = $this->parseMatch( $m );
+                               $found[$name] = $param;
+                       }
+                       $text = preg_replace( $regex, '', $text );
+               }
+               return $found;
+       }
 }