Merge "Follow-up I0b781c11 (2a55449): use User::getAutomaticGroups()."

[lhc/web/wiklou.git] / includes / parser / StripState.php

diff --git a/includes/parser/StripState.php b/includes/parser/StripState.php
index 0bf9e17..ad95d5f 100644 (file)
--- a/includes/parser/StripState.php
+++ b/includes/parser/StripState.php
@@ -1,4 +1,25 @@
 <?php
+/**
+ * Holder for stripped items when parsing wiki markup.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @ingroup Parser
+ */
 
 /**
  * @todo document, briefly.
@@ -10,7 +31,14 @@ class StripState {
        protected $regex;
 
        protected $tempType, $tempMergePrefix;
+       protected $circularRefGuard;
+       protected $recursionLevel = 0;
+
+       const UNSTRIP_RECURSION_LIMIT = 20;
 
+       /**
+        * @param $prefix string
+        */
        function __construct( $prefix ) {
                $this->prefix = $prefix;
                $this->data = array(
@@ -18,19 +46,32 @@ class StripState {
                        'general' => array()
                );
                $this->regex = "/{$this->prefix}([^\x7f]+)" . Parser::MARKER_SUFFIX . '/';
+               $this->circularRefGuard = array();
        }
 
        /**
         * Add a nowiki strip item
+        * @param $marker
+        * @param $value
         */
        function addNoWiki( $marker, $value ) {
                $this->addItem( 'nowiki', $marker, $value );
        }
 
+       /**
+        * @param $marker
+        * @param $value
+        */
        function addGeneral( $marker, $value ) {
                $this->addItem( 'general', $marker, $value );
        }
 
+       /**
+        * @throws MWException
+        * @param $type
+        * @param $marker
+        * @param $value
+        */
        protected function addItem( $type, $marker, $value ) {
                if ( !preg_match( $this->regex, $marker, $m ) ) {
                        throw new MWException( "Invalid marker: $marker" );
@@ -39,20 +80,37 @@ class StripState {
                $this->data[$type][$m[1]] = $value;
        }
 
+       /**
+        * @param $text
+        * @return mixed
+        */
        function unstripGeneral( $text ) {
                return $this->unstripType( 'general', $text );
        }
 
+       /**
+        * @param $text
+        * @return mixed
+        */
        function unstripNoWiki( $text ) {
                return $this->unstripType( 'nowiki', $text );
        }
 
+       /**
+        * @param  $text
+        * @return mixed
+        */
        function unstripBoth( $text ) {
                $text = $this->unstripType( 'general', $text );
                $text = $this->unstripType( 'nowiki', $text );
                return $text;
        }
 
+       /**
+        * @param $type
+        * @param $text
+        * @return mixed
+        */
        protected function unstripType( $type, $text ) {
                // Shortcut 
                if ( !count( $this->data[$type] ) ) {
@@ -60,16 +118,38 @@ class StripState {
                }
 
                wfProfileIn( __METHOD__ );
+               $oldType = $this->tempType;
                $this->tempType = $type;
-               $out = preg_replace_callback( $this->regex, array( $this, 'unstripCallback' ), $text );
-               $this->tempType = null;
+               $text = preg_replace_callback( $this->regex, array( $this, 'unstripCallback' ), $text );
+               $this->tempType = $oldType;
                wfProfileOut( __METHOD__ );
-               return $out;
+               return $text;
        }
 
+       /**
+        * @param $m array
+        * @return array
+        */
        protected function unstripCallback( $m ) {
-               if ( isset( $this->data[$this->tempType][$m[1]] ) ) {
-                       return $this->data[$this->tempType][$m[1]];
+               $marker = $m[1];
+               if ( isset( $this->data[$this->tempType][$marker] ) ) {
+                       if ( isset( $this->circularRefGuard[$marker] ) ) {
+                               return '<span class="error">'
+                                       . wfMessage( 'parser-unstrip-loop-warning' )->inContentLanguage()->text()
+                                       . '</span>';
+                       }
+                       if ( $this->recursionLevel >= self::UNSTRIP_RECURSION_LIMIT ) {
+                               return '<span class="error">' . 
+                                       wfMessage( 'parser-unstrip-recursion-limit' )
+                                               ->numParams( self::UNSTRIP_RECURSION_LIMIT )->inContentLanguage()->text() .
+                                       '</span>';
+                       }
+                       $this->circularRefGuard[$marker] = true;
+                       $this->recursionLevel++;
+                       $ret = $this->unstripType( $this->tempType, $this->data[$this->tempType][$marker] );
+                       $this->recursionLevel--;
+                       unset( $this->circularRefGuard[$marker] );
+                       return $ret;
                } else {
                        return $m[0];
                }
@@ -78,6 +158,10 @@ class StripState {
        /**
         * Get a StripState object which is sufficient to unstrip the given text. 
         * It will contain the minimum subset of strip items necessary.
+        *
+        * @param $text string
+        *
+        * @return StripState
         */
        function getSubState( $text ) {
                $subState = new StripState( $this->prefix );
@@ -130,9 +214,23 @@ class StripState {
                return $texts;
        }
 
+       /**
+        * @param $m
+        * @return string
+        */
        protected function mergeCallback( $m ) {
                $key = $m[1];
                return "{$this->prefix}{$this->tempMergePrefix}-$key" . Parser::MARKER_SUFFIX;
        }
+
+       /**
+        * Remove any strip markers found in the given text.
+        *
+        * @param $text Input string
+        * @return string
+        */
+       function killMarkers( $text ) {
+               return preg_replace( $this->regex, '', $text );
+       }
 }