includes/parser/StripState.php

   1 <?php
   2 /**
   3  * Holder for stripped items when parsing wiki markup.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup Parser
  22  */
  23
  24 /**
  25  * @todo document, briefly.
  26  * @newable
  27  * @ingroup Parser
  28  */
  29 class StripState {
  30         protected $data;
  31         protected $regex;
  32
  33         protected $parser;
  34
  35         protected $circularRefGuard;
  36         protected $depth = 0;
  37         protected $highestDepth = 0;
  38         protected $expandSize = 0;
  39
  40         protected $depthLimit = 20;
  41         protected $sizeLimit = 5000000;
  42
  43         /**
  44          * @stable to call
  45          *
  46          * @param Parser|null $parser
  47          * @param array $options
  48          */
  49         public function __construct( Parser $parser = null, $options = [] ) {
  50                 $this->data = [
  51                         'nowiki' => [],
  52                         'general' => []
  53                 ];
  54                 $this->regex = '/' . Parser::MARKER_PREFIX . "([^\x7f<>&'\"]+)" . Parser::MARKER_SUFFIX . '/';
  55                 $this->circularRefGuard = [];
  56                 $this->parser = $parser;
  57
  58                 if ( isset( $options['depthLimit'] ) ) {
  59                         $this->depthLimit = $options['depthLimit'];
  60                 }
  61                 if ( isset( $options['sizeLimit'] ) ) {
  62                         $this->sizeLimit = $options['sizeLimit'];
  63                 }
  64         }
  65
  66         /**
  67          * Add a nowiki strip item
  68          * @param string $marker
  69          * @param string|Closure $value
  70          */
  71         public function addNoWiki( $marker, $value ) {
  72                 $this->addItem( 'nowiki', $marker, $value );
  73         }
  74
  75         /**
  76          * @param string $marker
  77          * @param string|Closure $value
  78          */
  79         public function addGeneral( $marker, $value ) {
  80                 $this->addItem( 'general', $marker, $value );
  81         }
  82
  83         /**
  84          * @param string $type
  85          * @param-taint $type none
  86          * @param string $marker
  87          * @param-taint $marker none
  88          * @param string|Closure $value
  89          * @param-taint $value exec_html
  90          */
  91         protected function addItem( $type, $marker, $value ) {
  92                 if ( !preg_match( $this->regex, $marker, $m ) ) {
  93                         throw new InvalidArgumentException( "Invalid marker: $marker" );
  94                 }
  95
  96                 $this->data[$type][$m[1]] = $value;
  97         }
  98
  99         /**
 100          * @param string $text
 101          * @return mixed
 102          */
 103         public function unstripGeneral( $text ) {
 104                 return $this->unstripType( 'general', $text );
 105         }
 106
 107         /**
 108          * @param string $text
 109          * @return mixed
 110          */
 111         public function unstripNoWiki( $text ) {
 112                 return $this->unstripType( 'nowiki', $text );
 113         }
 114
 115         /**
 116          * @param string $text
 117          * @param callable $callback
 118          * @return string
 119          */
 120         public function replaceNoWikis( string $text, callable $callback ): string {
 121                 // Shortcut
 122                 if ( !count( $this->data['nowiki'] ) ) {
 123                         return $text;
 124                 }
 125
 126                 $callback = function ( $m ) use ( $callback ) {
 127                         $marker = $m[1];
 128                         if ( isset( $this->data['nowiki'][$marker] ) ) {
 129                                 $value = $this->data['nowiki'][$marker];
 130                                 if ( $value instanceof Closure ) {
 131                                         $value = $value();
 132                                 }
 133
 134                                 $this->expandSize += strlen( $value );
 135                                 if ( $this->expandSize > $this->sizeLimit ) {
 136                                         return $this->getLimitationWarning( 'unstrip-size', $this->sizeLimit );
 137                                 }
 138
 139                                 return call_user_func( $callback, $value );
 140                         } else {
 141                                 return $m[0];
 142                         }
 143                 };
 144
 145                 return preg_replace_callback( $this->regex, $callback, $text );
 146         }
 147
 148         /**
 149          * @param string $text
 150          * @return mixed
 151          */
 152         public function unstripBoth( $text ) {
 153                 $text = $this->unstripType( 'general', $text );
 154                 $text = $this->unstripType( 'nowiki', $text );
 155                 return $text;
 156         }
 157
 158         /**
 159          * @param string $type
 160          * @param string $text
 161          * @return mixed
 162          */
 163         protected function unstripType( $type, $text ) {
 164                 // Shortcut
 165                 if ( !count( $this->data[$type] ) ) {
 166                         return $text;
 167                 }
 168
 169                 $callback = function ( $m ) use ( $type ) {
 170                         $marker = $m[1];
 171                         if ( isset( $this->data[$type][$marker] ) ) {
 172                                 if ( isset( $this->circularRefGuard[$marker] ) ) {
 173                                         return $this->getWarning( 'parser-unstrip-loop-warning' );
 174                                 }
 175
 176                                 if ( $this->depth > $this->highestDepth ) {
 177                                         $this->highestDepth = $this->depth;
 178                                 }
 179                                 if ( $this->depth >= $this->depthLimit ) {
 180                                         return $this->getLimitationWarning( 'unstrip-depth', $this->depthLimit );
 181                                 }
 182
 183                                 $value = $this->data[$type][$marker];
 184                                 if ( $value instanceof Closure ) {
 185                                         $value = $value();
 186                                 }
 187
 188                                 $this->expandSize += strlen( $value );
 189                                 if ( $this->expandSize > $this->sizeLimit ) {
 190                                         return $this->getLimitationWarning( 'unstrip-size', $this->sizeLimit );
 191                                 }
 192
 193                                 $this->circularRefGuard[$marker] = true;
 194                                 $this->depth++;
 195                                 $ret = $this->unstripType( $type, $value );
 196                                 $this->depth--;
 197                                 unset( $this->circularRefGuard[$marker] );
 198
 199                                 return $ret;
 200                         } else {
 201                                 return $m[0];
 202                         }
 203                 };
 204
 205                 $text = preg_replace_callback( $this->regex, $callback, $text );
 206                 return $text;
 207         }
 208
 209         /**
 210          * Get warning HTML and register a limitation warning with the parser
 211          *
 212          * @param string $type
 213          * @param int|string $max
 214          * @return string
 215          */
 216         private function getLimitationWarning( $type, $max = '' ) {
 217                 if ( $this->parser ) {
 218                         $this->parser->limitationWarn( $type, $max );
 219                 }
 220                 return $this->getWarning( "$type-warning", $max );
 221         }
 222
 223         /**
 224          * Get warning HTML
 225          *
 226          * @param string $message
 227          * @param int|string $max
 228          * @return string
 229          */
 230         private function getWarning( $message, $max = '' ) {
 231                 return '<span class="error">' .
 232                         wfMessage( $message )
 233                                 ->numParams( $max )->inContentLanguage()->text() .
 234                         '</span>';
 235         }
 236
 237         /**
 238          * Get an array of parameters to pass to ParserOutput::setLimitReportData()
 239          *
 240          * @internal Should only be called by Parser
 241          * @return array
 242          */
 243         public function getLimitReport() {
 244                 return [
 245                         [ 'limitreport-unstrip-depth',
 246                                 [
 247                                         $this->highestDepth,
 248                                         $this->depthLimit
 249                                 ],
 250                         ],
 251                         [ 'limitreport-unstrip-size',
 252                                 [
 253                                         $this->expandSize,
 254                                         $this->sizeLimit
 255                                 ],
 256                         ]
 257                 ];
 258         }
 259
 260         /**
 261          * Remove any strip markers found in the given text.
 262          *
 263          * @param string $text
 264          * @return string
 265          */
 266         public function killMarkers( $text ) {
 267                 return preg_replace( $this->regex, '', $text );
 268         }
 269 }