3 * Holder for stripped items when parsing wiki markup.
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.
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.
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
25 * @todo document, briefly.
34 protected $circularRefGuard;
36 protected $highestDepth = 0;
37 protected $expandSize = 0;
39 protected $depthLimit = 20;
40 protected $sizeLimit = 5000000;
43 * @param Parser|null $parser
44 * @param array $options
46 public function __construct( Parser
$parser = null, $options = [] ) {
51 $this->regex
= '/' . Parser
::MARKER_PREFIX
. "([^\x7f<>&'\"]+)" . Parser
::MARKER_SUFFIX
. '/';
52 $this->circularRefGuard
= [];
53 $this->parser
= $parser;
55 if ( isset( $options['depthLimit'] ) ) {
56 $this->depthLimit
= $options['depthLimit'];
58 if ( isset( $options['sizeLimit'] ) ) {
59 $this->sizeLimit
= $options['sizeLimit'];
64 * Add a nowiki strip item
65 * @param string $marker
66 * @param string $value
68 public function addNoWiki( $marker, $value ) {
69 $this->addItem( 'nowiki', $marker, $value );
73 * @param string $marker
74 * @param string $value
76 public function addGeneral( $marker, $value ) {
77 $this->addItem( 'general', $marker, $value );
83 * @param string $marker
84 * @param string $value
86 protected function addItem( $type, $marker, $value ) {
87 if ( !preg_match( $this->regex
, $marker, $m ) ) {
88 throw new MWException( "Invalid marker: $marker" );
91 $this->data
[$type][$m[1]] = $value;
98 public function unstripGeneral( $text ) {
99 return $this->unstripType( 'general', $text );
103 * @param string $text
106 public function unstripNoWiki( $text ) {
107 return $this->unstripType( 'nowiki', $text );
111 * @param string $text
114 public function unstripBoth( $text ) {
115 $text = $this->unstripType( 'general', $text );
116 $text = $this->unstripType( 'nowiki', $text );
121 * @param string $type
122 * @param string $text
125 protected function unstripType( $type, $text ) {
127 if ( !count( $this->data
[$type] ) ) {
131 $callback = function ( $m ) use ( $type ) {
133 if ( isset( $this->data
[$type][$marker] ) ) {
134 if ( isset( $this->circularRefGuard
[$marker] ) ) {
135 return $this->getWarning( 'parser-unstrip-loop-warning' );
138 if ( $this->depth
> $this->highestDepth
) {
139 $this->highestDepth
= $this->depth
;
141 if ( $this->depth
>= $this->depthLimit
) {
142 return $this->getLimitationWarning( 'unstrip-depth', $this->depthLimit
);
145 $value = $this->data
[$type][$marker];
146 if ( $value instanceof Closure
) {
150 $this->expandSize +
= strlen( $value );
151 if ( $this->expandSize
> $this->sizeLimit
) {
152 return $this->getLimitationWarning( 'unstrip-size', $this->sizeLimit
);
155 $this->circularRefGuard
[$marker] = true;
157 $ret = $this->unstripType( $type, $value );
159 unset( $this->circularRefGuard
[$marker] );
167 $text = preg_replace_callback( $this->regex
, $callback, $text );
172 * Get warning HTML and register a limitation warning with the parser
174 * @param string $type
178 private function getLimitationWarning( $type, $max = '' ) {
179 if ( $this->parser
) {
180 $this->parser
->limitationWarn( $type, $max );
182 return $this->getWarning( "$type-warning", $max );
188 * @param string $message
192 private function getWarning( $message, $max = '' ) {
193 return '<span class="error">' .
194 wfMessage( $message )
195 ->numParams( $max )->inContentLanguage()->text() .
200 * Get an array of parameters to pass to ParserOutput::setLimitReportData()
202 * @internal Should only be called by Parser
205 public function getLimitReport() {
207 [ 'limitreport-unstrip-depth',
213 [ 'limitreport-unstrip-size',
223 * Get a StripState object which is sufficient to unstrip the given text.
224 * It will contain the minimum subset of strip items necessary.
226 * @deprecated since 1.31
227 * @param string $text
230 public function getSubState( $text ) {
231 wfDeprecated( __METHOD__
, '1.31' );
233 $subState = new StripState
;
236 $startPos = strpos( $text, Parser
::MARKER_PREFIX
, $pos );
237 $endPos = strpos( $text, Parser
::MARKER_SUFFIX
, $pos );
238 if ( $startPos === false ||
$endPos === false ) {
242 $endPos +
= strlen( Parser
::MARKER_SUFFIX
);
243 $marker = substr( $text, $startPos, $endPos - $startPos );
244 if ( !preg_match( $this->regex
, $marker, $m ) ) {
249 if ( isset( $this->data
['nowiki'][$key] ) ) {
250 $subState->data
['nowiki'][$key] = $this->data
['nowiki'][$key];
251 } elseif ( isset( $this->data
['general'][$key] ) ) {
252 $subState->data
['general'][$key] = $this->data
['general'][$key];
260 * Merge another StripState object into this one. The strip marker keys
261 * will not be preserved. The strings in the $texts array will have their
262 * strip markers rewritten, the resulting array of strings will be returned.
264 * @deprecated since 1.31
265 * @param StripState $otherState
266 * @param array $texts
269 public function merge( $otherState, $texts ) {
270 wfDeprecated( __METHOD__
, '1.31' );
272 $mergePrefix = wfRandomString( 16 );
274 foreach ( $otherState->data
as $type => $items ) {
275 foreach ( $items as $key => $value ) {
276 $this->data
[$type]["$mergePrefix-$key"] = $value;
280 $callback = function ( $m ) use ( $mergePrefix ) {
282 return Parser
::MARKER_PREFIX
. $mergePrefix . '-' . $key . Parser
::MARKER_SUFFIX
;
284 $texts = preg_replace_callback( $otherState->regex
, $callback, $texts );
289 * Remove any strip markers found in the given text.
291 * @param string $text
294 public function killMarkers( $text ) {
295 return preg_replace( $this->regex
, '', $text );