dépôts / lhc / web / wiklou.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
history | raw | HEAD
Merge "Leading semicolon line-bolding made visible in printable version"
[lhc/web/wiklou.git] / includes / parser / Parser.php
1 <?php
2 /**
3 * PHP parser that converts wiki markup to HTML.
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 * @defgroup Parser Parser
26 */
27
28 /**
29 * PHP Parser - Processes wiki markup (which uses a more user-friendly
30 * syntax, such as "[[link]]" for making links), and provides a one-way
31 * transformation of that wiki markup it into (X)HTML output / markup
32 * (which in turn the browser understands, and can display).
33 *
34 * There are seven main entry points into the Parser class:
35 *
36 * - Parser::parse()
37 * produces HTML output
38 * - Parser::preSaveTransform().
39 * produces altered wiki markup.
40 * - Parser::preprocess()
41 * removes HTML comments and expands templates
42 * - Parser::cleanSig() and Parser::cleanSigInSig()
43 * Cleans a signature before saving it to preferences
44 * - Parser::getSection()
45 * Return the content of a section from an article for section editing
46 * - Parser::replaceSection()
47 * Replaces a section by number inside an article
48 * - Parser::getPreloadText()
49 * Removes <noinclude> sections, and <includeonly> tags.
50 *
51 * Globals used:
52 * object: $wgContLang
53 *
54 * @warning $wgUser or $wgTitle or $wgRequest or $wgLang. Keep them away!
55 *
56 * @par Settings:
57 * $wgNamespacesWithSubpages
58 *
59 * @par Settings only within ParserOptions:
60 * $wgAllowExternalImages
61 * $wgAllowSpecialInclusion
62 * $wgInterwikiMagic
63 * $wgMaxArticleSize
64 *
65 * @ingroup Parser
66 */
67 class Parser {
68 /**
69 * Update this version number when the ParserOutput format
70 * changes in an incompatible way, so the parser cache
71 * can automatically discard old data.
72 */
73 const VERSION = '1.6.4';
74
75 /**
76 * Update this version number when the output of serialiseHalfParsedText()
77 * changes in an incompatible way
78 */
79 const HALF_PARSED_VERSION = 2;
80
81 # Flags for Parser::setFunctionHook
82 # Also available as global constants from Defines.php
83 const SFH_NO_HASH = 1;
84 const SFH_OBJECT_ARGS = 2;
85
86 # Constants needed for external link processing
87 # Everything except bracket, space, or control characters
88 # \p{Zs} is unicode 'separator, space' category. It covers the space 0x20
89 # as well as U+3000 is IDEOGRAPHIC SPACE for bug 19052
90 const EXT_LINK_URL_CLASS = '[^][<>"\\x00-\\x20\\x7F\p{Zs}]';
91 const EXT_IMAGE_REGEX = '/^(http:\/\/|https:\/\/)([^][<>"\\x00-\\x20\\x7F\p{Zs}]+)
92 \\/([A-Za-z0-9_.,~%\\-+&;#*?!=()@\\x80-\\xFF]+)\\.((?i)gif|png|jpg|jpeg)$/Sxu';
93
94 # State constants for the definition list colon extraction
95 const COLON_STATE_TEXT = 0;
96 const COLON_STATE_TAG = 1;
97 const COLON_STATE_TAGSTART = 2;
98 const COLON_STATE_CLOSETAG = 3;
99 const COLON_STATE_TAGSLASH = 4;
100 const COLON_STATE_COMMENT = 5;
101 const COLON_STATE_COMMENTDASH = 6;
102 const COLON_STATE_COMMENTDASHDASH = 7;
103
104 # Flags for preprocessToDom
105 const PTD_FOR_INCLUSION = 1;
106
107 # Allowed values for $this->mOutputType
108 # Parameter to startExternalParse().
109 const OT_HTML = 1; # like parse()
110 const OT_WIKI = 2; # like preSaveTransform()
111 const OT_PREPROCESS = 3; # like preprocess()
112 const OT_MSG = 3;
113 const OT_PLAIN = 4; # like extractSections() - portions of the original are returned unchanged.
114
115 # Marker Suffix needs to be accessible staticly.
116 const MARKER_SUFFIX = "-QINU\x7f";
117
118 # Markers used for wrapping the table of contents
119 const TOC_START = '<mw:toc>';
120 const TOC_END = '</mw:toc>';
121
122 # Persistent:
123 var $mTagHooks = array();
124 var $mTransparentTagHooks = array();
125 var $mFunctionHooks = array();
126 var $mFunctionSynonyms = array( 0 => array(), 1 => array() );
127 var $mFunctionTagHooks = array();
128 var $mStripList = array();
129 var $mDefaultStripList = array();
130 var $mVarCache = array();
131 var $mImageParams = array();
132 var $mImageParamsMagicArray = array();
133 var $mMarkerIndex = 0;
134 var $mFirstCall = true;
135
136 # Initialised by initialiseVariables()
137
138 /**
139 * @var MagicWordArray
140 */
141 var $mVariables;
142
143 /**
144 * @var MagicWordArray
145 */
146 var $mSubstWords;
147 var $mConf, $mPreprocessor, $mExtLinkBracketedRegex, $mUrlProtocols; # Initialised in constructor
148
149 # Cleared with clearState():
150 /**
151 * @var ParserOutput
152 */
153 var $mOutput;
154 var $mAutonumber, $mDTopen;
155
156 /**
157 * @var StripState
158 */
159 var $mStripState;
160
161 var $mIncludeCount, $mArgStack, $mLastSection, $mInPre;
162 /**
163 * @var LinkHolderArray
164 */
165 var $mLinkHolders;
166
167 var $mLinkID;
168 var $mIncludeSizes, $mPPNodeCount, $mGeneratedPPNodeCount, $mHighestExpansionDepth;
169 var $mDefaultSort;
170 var $mTplExpandCache; # empty-frame expansion cache
171 var $mTplRedirCache, $mTplDomCache, $mHeadings, $mDoubleUnderscores;
172 var $mExpensiveFunctionCount; # number of expensive parser function calls
173 var $mShowToc, $mForceTocPosition;
174
175 /**
176 * @var User
177 */
178 var $mUser; # User object; only used when doing pre-save transform
179
180 # Temporary
181 # These are variables reset at least once per parse regardless of $clearState
182
183 /**
184 * @var ParserOptions
185 */
186 var $mOptions;
187
188 /**
189 * @var Title
190 */
191 var $mTitle; # Title context, used for self-link rendering and similar things
192 var $mOutputType; # Output type, one of the OT_xxx constants
193 var $ot; # Shortcut alias, see setOutputType()
194 var $mRevisionObject; # The revision object of the specified revision ID
195 var $mRevisionId; # ID to display in {{REVISIONID}} tags
196 var $mRevisionTimestamp; # The timestamp of the specified revision ID
197 var $mRevisionUser; # User to display in {{REVISIONUSER}} tag
198 var $mRevisionSize; # Size to display in {{REVISIONSIZE}} variable
199 var $mRevIdForTs; # The revision ID which was used to fetch the timestamp
200 var $mInputSize = false; # For {{PAGESIZE}} on current page.
201
202 /**
203 * @var string
204 */
205 var $mUniqPrefix;
206
207 /**
208 * @var Array with the language name of each language link (i.e. the
209 * interwiki prefix) in the key, value arbitrary. Used to avoid sending
210 * duplicate language links to the ParserOutput.
211 */
212 var $mLangLinkLanguages;
213
214 /**
215 * Constructor
216 *
217 * @param $conf array
218 */
219 public function __construct( $conf = array() ) {
220 $this->mConf = $conf;
221 $this->mUrlProtocols = wfUrlProtocols();
222 $this->mExtLinkBracketedRegex = '/\[(((?i)' . $this->mUrlProtocols . ')' .
223 self::EXT_LINK_URL_CLASS . '+)\p{Zs}*([^\]\\x00-\\x08\\x0a-\\x1F]*?)\]/Su';
224 if ( isset( $conf['preprocessorClass'] ) ) {
225 $this->mPreprocessorClass = $conf['preprocessorClass'];
226 } elseif ( defined( 'HPHP_VERSION' ) ) {
227 # Preprocessor_Hash is much faster than Preprocessor_DOM under HipHop
228 $this->mPreprocessorClass = 'Preprocessor_Hash';
229 } elseif ( extension_loaded( 'domxml' ) ) {
230 # PECL extension that conflicts with the core DOM extension (bug 13770)
231 wfDebug( "Warning: you have the obsolete domxml extension for PHP. Please remove it!\n" );
232 $this->mPreprocessorClass = 'Preprocessor_Hash';
233 } elseif ( extension_loaded( 'dom' ) ) {
234 $this->mPreprocessorClass = 'Preprocessor_DOM';
235 } else {
236 $this->mPreprocessorClass = 'Preprocessor_Hash';
237 }
238 wfDebug( __CLASS__ . ": using preprocessor: {$this->mPreprocessorClass}\n" );
239 }
240
241 /**
242 * Reduce memory usage to reduce the impact of circular references
243 */
244 function __destruct() {
245 if ( isset( $this->mLinkHolders ) ) {
246 unset( $this->mLinkHolders );
247 }
248 foreach ( $this as $name => $value ) {
249 unset( $this->$name );
250 }
251 }
252
253 /**
254 * Allow extensions to clean up when the parser is cloned
255 */
256 function __clone() {
257 wfRunHooks( 'ParserCloned', array( $this ) );
258 }
259
260 /**
261 * Do various kinds of initialisation on the first call of the parser
262 */
263 function firstCallInit() {
264 if ( !$this->mFirstCall ) {
265 return;
266 }
267 $this->mFirstCall = false;
268
269 wfProfileIn( __METHOD__ );
270
271 CoreParserFunctions::register( $this );
272 CoreTagHooks::register( $this );
273 $this->initialiseVariables();
274
275 wfRunHooks( 'ParserFirstCallInit', array( &$this ) );
276 wfProfileOut( __METHOD__ );
277 }
278
279 /**
280 * Clear Parser state
281 *
282 * @private
283 */
284 function clearState() {
285 wfProfileIn( __METHOD__ );
286 if ( $this->mFirstCall ) {
287 $this->firstCallInit();
288 }
289 $this->mOutput = new ParserOutput;
290 $this->mOptions->registerWatcher( array( $this->mOutput, 'recordOption' ) );
291 $this->mAutonumber = 0;
292 $this->mLastSection = '';
293 $this->mDTopen = false;
294 $this->mIncludeCount = array();
295 $this->mArgStack = false;
296 $this->mInPre = false;
297 $this->mLinkHolders = new LinkHolderArray( $this );
298 $this->mLinkID = 0;
299 $this->mRevisionObject = $this->mRevisionTimestamp =
300 $this->mRevisionId = $this->mRevisionUser = $this->mRevisionSize = null;
301 $this->mVarCache = array();
302 $this->mUser = null;
303 $this->mLangLinkLanguages = array();
304
305 /**
306 * Prefix for temporary replacement strings for the multipass parser.
307 * \x07 should never appear in input as it's disallowed in XML.
308 * Using it at the front also gives us a little extra robustness
309 * since it shouldn't match when butted up against identifier-like
310 * string constructs.
311 *
312 * Must not consist of all title characters, or else it will change
313 * the behavior of <nowiki> in a link.
314 */
315 $this->mUniqPrefix = "\x7fUNIQ" . self::getRandomString();
316 $this->mStripState = new StripState( $this->mUniqPrefix );
317
318 # Clear these on every parse, bug 4549
319 $this->mTplExpandCache = $this->mTplRedirCache = $this->mTplDomCache = array();
320
321 $this->mShowToc = true;
322 $this->mForceTocPosition = false;
323 $this->mIncludeSizes = array(
324 'post-expand' => 0,
325 'arg' => 0,
326 );
327 $this->mPPNodeCount = 0;
328 $this->mGeneratedPPNodeCount = 0;
329 $this->mHighestExpansionDepth = 0;
330 $this->mDefaultSort = false;
331 $this->mHeadings = array();
332 $this->mDoubleUnderscores = array();
333 $this->mExpensiveFunctionCount = 0;
334
335 # Fix cloning
336 if ( isset( $this->mPreprocessor ) && $this->mPreprocessor->parser !== $this ) {
337 $this->mPreprocessor = null;
338 }
339
340 wfRunHooks( 'ParserClearState', array( &$this ) );
341 wfProfileOut( __METHOD__ );
342 }
343
344 /**
345 * Convert wikitext to HTML
346 * Do not call this function recursively.
347 *
348 * @param string $text text we want to parse
349 * @param $title Title object
350 * @param $options ParserOptions
351 * @param $linestart boolean
352 * @param $clearState boolean
353 * @param int $revid number to pass in {{REVISIONID}}
354 * @return ParserOutput a ParserOutput
355 */
356 public function parse( $text, Title $title, ParserOptions $options, $linestart = true, $clearState = true, $revid = null ) {
357 /**
358 * First pass--just handle <nowiki> sections, pass the rest off
359 * to internalParse() which does all the real work.
360 */
361
362 global $wgUseTidy, $wgAlwaysUseTidy, $wgShowHostnames;
363 $fname = __METHOD__ . '-' . wfGetCaller();
364 wfProfileIn( __METHOD__ );
365 wfProfileIn( $fname );
366
367 $this->startParse( $title, $options, self::OT_HTML, $clearState );
368
369 $this->mInputSize = strlen( $text );
370 if ( $this->mOptions->getEnableLimitReport() ) {
371 $this->mOutput->resetParseStartTime();
372 }
373
374 # Remove the strip marker tag prefix from the input, if present.
375 if ( $clearState ) {
376 $text = str_replace( $this->mUniqPrefix, '', $text );
377 }
378
379 $oldRevisionId = $this->mRevisionId;
380 $oldRevisionObject = $this->mRevisionObject;
381 $oldRevisionTimestamp = $this->mRevisionTimestamp;
382 $oldRevisionUser = $this->mRevisionUser;
383 $oldRevisionSize = $this->mRevisionSize;
384 if ( $revid !== null ) {
385 $this->mRevisionId = $revid;
386 $this->mRevisionObject = null;
387 $this->mRevisionTimestamp = null;
388 $this->mRevisionUser = null;
389 $this->mRevisionSize = null;
390 }
391
392 wfRunHooks( 'ParserBeforeStrip', array( &$this, &$text, &$this->mStripState ) );
393 # No more strip!
394 wfRunHooks( 'ParserAfterStrip', array( &$this, &$text, &$this->mStripState ) );
395 $text = $this->internalParse( $text );
396 wfRunHooks( 'ParserAfterParse', array( &$this, &$text, &$this->mStripState ) );
397
398 $text = $this->mStripState->unstripGeneral( $text );
399
400 # Clean up special characters, only run once, next-to-last before doBlockLevels
401 $fixtags = array(
402 # french spaces, last one Guillemet-left
403 # only if there is something before the space
404 '/(.) (?=\\?|:|;|!|%|\\302\\273)/' => '\\1&#160;',
405 # french spaces, Guillemet-right
406 '/(\\302\\253) /' => '\\1&#160;',
407 '/&#160;(!\s*important)/' => ' \\1', # Beware of CSS magic word !important, bug #11874.
408 );
409 $text = preg_replace( array_keys( $fixtags ), array_values( $fixtags ), $text );
410
411 $text = $this->doBlockLevels( $text, $linestart );
412
413 $this->replaceLinkHolders( $text );
414
415 /**
416 * The input doesn't get language converted if
417 * a) It's disabled
418 * b) Content isn't converted
419 * c) It's a conversion table
420 * d) it is an interface message (which is in the user language)
421 */
422 if ( !( $options->getDisableContentConversion()
423 || isset( $this->mDoubleUnderscores['nocontentconvert'] ) )
424 ) {
425 if ( !$this->mOptions->getInterfaceMessage() ) {
426 # The position of the convert() call should not be changed. it
427 # assumes that the links are all replaced and the only thing left
428 # is the <nowiki> mark.
429 $text = $this->getConverterLanguage()->convert( $text );
430 }
431 }
432
433 /**
434 * A converted title will be provided in the output object if title and
435 * content conversion are enabled, the article text does not contain
436 * a conversion-suppressing double-underscore tag, and no
437 * {{DISPLAYTITLE:...}} is present. DISPLAYTITLE takes precedence over
438 * automatic link conversion.
439 */
440 if ( !( $options->getDisableTitleConversion()
441 || isset( $this->mDoubleUnderscores['nocontentconvert'] )
442 || isset( $this->mDoubleUnderscores['notitleconvert'] )
443 || $this->mOutput->getDisplayTitle() !== false )
444 ) {
445 $convruletitle = $this->getConverterLanguage()->getConvRuleTitle();
446 if ( $convruletitle ) {
447 $this->mOutput->setTitleText( $convruletitle );
448 } else {
449 $titleText = $this->getConverterLanguage()->convertTitle( $title );
450 $this->mOutput->setTitleText( $titleText );
451 }
452 }
453
454 $text = $this->mStripState->unstripNoWiki( $text );
455
456 wfRunHooks( 'ParserBeforeTidy', array( &$this, &$text ) );
457
458 $text = $this->replaceTransparentTags( $text );
459 $text = $this->mStripState->unstripGeneral( $text );
460
461 $text = Sanitizer::normalizeCharReferences( $text );
462
463 if ( ( $wgUseTidy && $this->mOptions->getTidy() ) || $wgAlwaysUseTidy ) {
464 $text = MWTidy::tidy( $text );
465 } else {
466 # attempt to sanitize at least some nesting problems
467 # (bug #2702 and quite a few others)
468 $tidyregs = array(
469 # ''Something [http://www.cool.com cool''] -->
470 # <i>Something</i><a href="http://www.cool.com"..><i>cool></i></a>
471 '/(<([bi])>)(<([bi])>)?([^<]*)(<\/?a[^<]*>)([^<]*)(<\/\\4>)?(<\/\\2>)/' =>
472 '\\1\\3\\5\\8\\9\\6\\1\\3\\7\\8\\9',
473 # fix up an anchor inside another anchor, only
474 # at least for a single single nested link (bug 3695)
475 '/(<a[^>]+>)([^<]*)(<a[^>]+>[^<]*)<\/a>(.*)<\/a>/' =>
476 '\\1\\2</a>\\3</a>\\1\\4</a>',
477 # fix div inside inline elements- doBlockLevels won't wrap a line which
478 # contains a div, so fix it up here; replace
479 # div with escaped text
480 '/(<([aib]) [^>]+>)([^<]*)(<div([^>]*)>)(.*)(<\/div>)([^<]*)(<\/\\2>)/' =>
481 '\\1\\3&lt;div\\5&gt;\\6&lt;/div&gt;\\8\\9',
482 # remove empty italic or bold tag pairs, some
483 # introduced by rules above
484 '/<([bi])><\/\\1>/' => '',
485 );
486
487 $text = preg_replace(
488 array_keys( $tidyregs ),
489 array_values( $tidyregs ),
490 $text );
491 }
492
493 if ( $this->mExpensiveFunctionCount > $this->mOptions->getExpensiveParserFunctionLimit() ) {
494 $this->limitationWarn( 'expensive-parserfunction',
495 $this->mExpensiveFunctionCount,
496 $this->mOptions->getExpensiveParserFunctionLimit()
497 );
498 }
499
500 wfRunHooks( 'ParserAfterTidy', array( &$this, &$text ) );
501
502 # Information on include size limits, for the benefit of users who try to skirt them
503 if ( $this->mOptions->getEnableLimitReport() ) {
504 $max = $this->mOptions->getMaxIncludeSize();
505
506 $cpuTime = $this->mOutput->getTimeSinceStart( 'cpu' );
507 if ( $cpuTime !== null ) {
508 $this->mOutput->setLimitReportData( 'limitreport-cputime',
509 sprintf( "%.3f", $cpuTime )
510 );
511 }
512
513 $wallTime = $this->mOutput->getTimeSinceStart( 'wall' );
514 $this->mOutput->setLimitReportData( 'limitreport-walltime',
515 sprintf( "%.3f", $wallTime )
516 );
517
518 $this->mOutput->setLimitReportData( 'limitreport-ppvisitednodes',
519 array( $this->mPPNodeCount, $this->mOptions->getMaxPPNodeCount() )
520 );
521 $this->mOutput->setLimitReportData( 'limitreport-ppgeneratednodes',
522 array( $this->mGeneratedPPNodeCount, $this->mOptions->getMaxGeneratedPPNodeCount() )
523 );
524 $this->mOutput->setLimitReportData( 'limitreport-postexpandincludesize',
525 array( $this->mIncludeSizes['post-expand'], $max )
526 );
527 $this->mOutput->setLimitReportData( 'limitreport-templateargumentsize',
528 array( $this->mIncludeSizes['arg'], $max )
529 );
530 $this->mOutput->setLimitReportData( 'limitreport-expansiondepth',
531 array( $this->mHighestExpansionDepth, $this->mOptions->getMaxPPExpandDepth() )
532 );
533 $this->mOutput->setLimitReportData( 'limitreport-expensivefunctioncount',
534 array( $this->mExpensiveFunctionCount, $this->mOptions->getExpensiveParserFunctionLimit() )
535 );
536 wfRunHooks( 'ParserLimitReportPrepare', array( $this, $this->mOutput ) );
537
538 $limitReport = "NewPP limit report\n";
539 if ( $wgShowHostnames ) {
540 $limitReport .= 'Parsed by ' . wfHostname() . "\n";
541 }
542 foreach ( $this->mOutput->getLimitReportData() as $key => $value ) {
543 if ( wfRunHooks( 'ParserLimitReportFormat',
544 array( $key, &$value, &$limitReport, false, false )
545 ) ) {
546 $keyMsg = wfMessage( $key )->inLanguage( 'en' )->useDatabase( false );
547 $valueMsg = wfMessage( array( "$key-value-text", "$key-value" ) )
548 ->inLanguage( 'en' )->useDatabase( false );
549 if ( !$valueMsg->exists() ) {
550 $valueMsg = new RawMessage( '$1' );
551 }
552 if ( !$keyMsg->isDisabled() && !$valueMsg->isDisabled() ) {
553 $valueMsg->params( $value );
554 $limitReport .= "{$keyMsg->text()}: {$valueMsg->text()}\n";
555 }
556 }
557 }
558 // Since we're not really outputting HTML, decode the entities and
559 // then re-encode the things that need hiding inside HTML comments.
560 $limitReport = htmlspecialchars_decode( $limitReport );
561 wfRunHooks( 'ParserLimitReport', array( $this, &$limitReport ) );
562
563 // Sanitize for comment. Note '‐' in the replacement is U+2010,
564 // which looks much like the problematic '-'.
565 $limitReport = str_replace( array( '-', '&' ), array( '‐', '&amp;' ), $limitReport );
566 $text .= "\n<!-- \n$limitReport-->\n";
567
568 if ( $this->mGeneratedPPNodeCount > $this->mOptions->getMaxGeneratedPPNodeCount() / 10 ) {
569 wfDebugLog( 'generated-pp-node-count', $this->mGeneratedPPNodeCount . ' ' .
570 $this->mTitle->getPrefixedDBkey() );
571 }
572 }
573 $this->mOutput->setText( $text );
574
575 $this->mRevisionId = $oldRevisionId;
576 $this->mRevisionObject = $oldRevisionObject;
577 $this->mRevisionTimestamp = $oldRevisionTimestamp;
578 $this->mRevisionUser = $oldRevisionUser;
579 $this->mRevisionSize = $oldRevisionSize;
580 $this->mInputSize = false;
581 wfProfileOut( $fname );
582 wfProfileOut( __METHOD__ );
583
584 return $this->mOutput;
585 }
586
587 /**
588 * Recursive parser entry point that can be called from an extension tag
589 * hook.
590 *
591 * If $frame is not provided, then template variables (e.g., {{{1}}}) within $text are not expanded
592 *
593 * @param string $text text extension wants to have parsed
594 * @param $frame PPFrame: The frame to use for expanding any template variables
595 *
596 * @return string
597 */
598 function recursiveTagParse( $text, $frame = false ) {
599 wfProfileIn( __METHOD__ );
600 wfRunHooks( 'ParserBeforeStrip', array( &$this, &$text, &$this->mStripState ) );
601 wfRunHooks( 'ParserAfterStrip', array( &$this, &$text, &$this->mStripState ) );
602 $text = $this->internalParse( $text, false, $frame );
603 wfProfileOut( __METHOD__ );
604 return $text;
605 }
606
607 /**
608 * Expand templates and variables in the text, producing valid, static wikitext.
609 * Also removes comments.
610 * @return mixed|string
611 */
612 function preprocess( $text, Title $title = null, ParserOptions $options, $revid = null ) {
613 wfProfileIn( __METHOD__ );
614 $this->startParse( $title, $options, self::OT_PREPROCESS, true );
615 if ( $revid !== null ) {
616 $this->mRevisionId = $revid;
617 }
618 wfRunHooks( 'ParserBeforeStrip', array( &$this, &$text, &$this->mStripState ) );
619 wfRunHooks( 'ParserAfterStrip', array( &$this, &$text, &$this->mStripState ) );
620 $text = $this->replaceVariables( $text );
621 $text = $this->mStripState->unstripBoth( $text );
622 wfProfileOut( __METHOD__ );
623 return $text;
624 }
625
626 /**
627 * Recursive parser entry point that can be called from an extension tag
628 * hook.
629 *
630 * @param string $text text to be expanded
631 * @param $frame PPFrame: The frame to use for expanding any template variables
632 * @return String
633 * @since 1.19
634 */
635 public function recursivePreprocess( $text, $frame = false ) {
636 wfProfileIn( __METHOD__ );
637 $text = $this->replaceVariables( $text, $frame );
638 $text = $this->mStripState->unstripBoth( $text );
639 wfProfileOut( __METHOD__ );
640 return $text;
641 }
642
643 /**
644 * Process the wikitext for the "?preload=" feature. (bug 5210)
645 *
646 * "<noinclude>", "<includeonly>" etc. are parsed as for template
647 * transclusion, comments, templates, arguments, tags hooks and parser
648 * functions are untouched.
649 *
650 * @param $text String
651 * @param $title Title
652 * @param $options ParserOptions
653 * @return String
654 */
655 public function getPreloadText( $text, Title $title, ParserOptions $options ) {
656 # Parser (re)initialisation
657 $this->startParse( $title, $options, self::OT_PLAIN, true );
658
659 $flags = PPFrame::NO_ARGS | PPFrame::NO_TEMPLATES;
660 $dom = $this->preprocessToDom( $text, self::PTD_FOR_INCLUSION );
661 $text = $this->getPreprocessor()->newFrame()->expand( $dom, $flags );
662 $text = $this->mStripState->unstripBoth( $text );
663 return $text;
664 }
665
666 /**
667 * Get a random string
668 *
669 * @return string
670 */
671 public static function getRandomString() {
672 return wfRandomString( 16 );
673 }
674
675 /**
676 * Set the current user.
677 * Should only be used when doing pre-save transform.
678 *
679 * @param $user Mixed: User object or null (to reset)
680 */
681 function setUser( $user ) {
682 $this->mUser = $user;
683 }
684
685 /**
686 * Accessor for mUniqPrefix.
687 *
688 * @return String
689 */
690 public function uniqPrefix() {
691 if ( !isset( $this->mUniqPrefix ) ) {
692 # @todo FIXME: This is probably *horribly wrong*
693 # LanguageConverter seems to want $wgParser's uniqPrefix, however
694 # if this is called for a parser cache hit, the parser may not
695 # have ever been initialized in the first place.
696 # Not really sure what the heck is supposed to be going on here.
697 return '';
698 # throw new MWException( "Accessing uninitialized mUniqPrefix" );
699 }
700 return $this->mUniqPrefix;
701 }
702
703 /**
704 * Set the context title
705 *
706 * @param $t Title
707 */
708 function setTitle( $t ) {
709 if ( !$t || $t instanceof FakeTitle ) {
710 $t = Title::newFromText( 'NO TITLE' );
711 }
712
713 if ( strval( $t->getFragment() ) !== '' ) {
714 # Strip the fragment to avoid various odd effects
715 $this->mTitle = clone $t;
716 $this->mTitle->setFragment( '' );
717 } else {
718 $this->mTitle = $t;
719 }
720 }
721
722 /**
723 * Accessor for the Title object
724 *
725 * @return Title object
726 */
727 function getTitle() {
728 return $this->mTitle;
729 }
730
731 /**
732 * Accessor/mutator for the Title object
733 *
734 * @param $x Title object or null to just get the current one
735 * @return Title object
736 */
737 function Title( $x = null ) {
738 return wfSetVar( $this->mTitle, $x );
739 }
740
741 /**
742 * Set the output type
743 *
744 * @param $ot Integer: new value
745 */
746 function setOutputType( $ot ) {
747 $this->mOutputType = $ot;
748 # Shortcut alias
749 $this->ot = array(
750 'html' => $ot == self::OT_HTML,
751 'wiki' => $ot == self::OT_WIKI,
752 'pre' => $ot == self::OT_PREPROCESS,
753 'plain' => $ot == self::OT_PLAIN,
754 );
755 }
756
757 /**
758 * Accessor/mutator for the output type
759 *
760 * @param int|null $x New value or null to just get the current one
761 * @return Integer
762 */
763 function OutputType( $x = null ) {
764 return wfSetVar( $this->mOutputType, $x );
765 }
766
767 /**
768 * Get the ParserOutput object
769 *
770 * @return ParserOutput object
771 */
772 function getOutput() {
773 return $this->mOutput;
774 }
775
776 /**
777 * Get the ParserOptions object
778 *
779 * @return ParserOptions object
780 */
781 function getOptions() {
782 return $this->mOptions;
783 }
784
785 /**
786 * Accessor/mutator for the ParserOptions object
787 *
788 * @param $x ParserOptions New value or null to just get the current one
789 * @return ParserOptions Current ParserOptions object
790 */
791 function Options( $x = null ) {
792 return wfSetVar( $this->mOptions, $x );
793 }
794
795 /**
796 * @return int
797 */
798 function nextLinkID() {
799 return $this->mLinkID++;
800 }
801
802 /**
803 * @param $id int
804 */
805 function setLinkID( $id ) {
806 $this->mLinkID = $id;
807 }
808
809 /**
810 * Get a language object for use in parser functions such as {{FORMATNUM:}}
811 * @return Language
812 */
813 function getFunctionLang() {
814 return $this->getTargetLanguage();
815 }
816
817 /**
818 * Get the target language for the content being parsed. This is usually the
819 * language that the content is in.
820 *
821 * @since 1.19
822 *
823 * @throws MWException
824 * @return Language|null
825 */
826 public function getTargetLanguage() {
827 $target = $this->mOptions->getTargetLanguage();
828
829 if ( $target !== null ) {
830 return $target;
831 } elseif ( $this->mOptions->getInterfaceMessage() ) {
832 return $this->mOptions->getUserLangObj();
833 } elseif ( is_null( $this->mTitle ) ) {
834 throw new MWException( __METHOD__ . ': $this->mTitle is null' );
835 }
836
837 return $this->mTitle->getPageLanguage();
838 }
839
840 /**
841 * Get the language object for language conversion
842 */
843 function getConverterLanguage() {
844 return $this->getTargetLanguage();
845 }
846
847 /**
848 * Get a User object either from $this->mUser, if set, or from the
849 * ParserOptions object otherwise
850 *
851 * @return User object
852 */
853 function getUser() {
854 if ( !is_null( $this->mUser ) ) {
855 return $this->mUser;
856 }
857 return $this->mOptions->getUser();
858 }
859
860 /**
861 * Get a preprocessor object
862 *
863 * @return Preprocessor instance
864 */
865 function getPreprocessor() {
866 if ( !isset( $this->mPreprocessor ) ) {
867 $class = $this->mPreprocessorClass;
868 $this->mPreprocessor = new $class( $this );
869 }
870 return $this->mPreprocessor;
871 }
872
873 /**
874 * Replaces all occurrences of HTML-style comments and the given tags
875 * in the text with a random marker and returns the next text. The output
876 * parameter $matches will be an associative array filled with data in
877 * the form:
878 *
879 * @code
880 * 'UNIQ-xxxxx' => array(
881 * 'element',
882 * 'tag content',
883 * array( 'param' => 'x' ),
884 * '<element param="x">tag content</element>' ) )
885 * @endcode
886 *
887 * @param array $elements list of element names. Comments are always extracted.
888 * @param string $text Source text string.
889 * @param array $matches Out parameter, Array: extracted tags
890 * @param $uniq_prefix string
891 * @return String: stripped text
892 */
893 public static function extractTagsAndParams( $elements, $text, &$matches, $uniq_prefix = '' ) {
894 static $n = 1;
895 $stripped = '';
896 $matches = array();
897
898 $taglist = implode( '|', $elements );
899 $start = "/<($taglist)(\\s+[^>]*?|\\s*?)(\/?" . ">)|<(!--)/i";
900
901 while ( $text != '' ) {
902 $p = preg_split( $start, $text, 2, PREG_SPLIT_DELIM_CAPTURE );
903 $stripped .= $p[0];
904 if ( count( $p ) < 5 ) {
905 break;
906 }
907 if ( count( $p ) > 5 ) {
908 # comment
909 $element = $p[4];
910 $attributes = '';
911 $close = '';
912 $inside = $p[5];
913 } else {
914 # tag
915 $element = $p[1];
916 $attributes = $p[2];
917 $close = $p[3];
918 $inside = $p[4];
919 }
920
921 $marker = "$uniq_prefix-$element-" . sprintf( '%08X', $n++ ) . self::MARKER_SUFFIX;
922 $stripped .= $marker;
923
924 if ( $close === '/>' ) {
925 # Empty element tag, <tag />
926 $content = null;
927 $text = $inside;
928 $tail = null;
929 } else {
930 if ( $element === '!--' ) {
931 $end = '/(-->)/';
932 } else {
933 $end = "/(<\\/$element\\s*>)/i";
934 }
935 $q = preg_split( $end, $inside, 2, PREG_SPLIT_DELIM_CAPTURE );
936 $content = $q[0];
937 if ( count( $q ) < 3 ) {
938 # No end tag -- let it run out to the end of the text.
939 $tail = '';
940 $text = '';
941 } else {
942 $tail = $q[1];
943 $text = $q[2];
944 }
945 }
946
947 $matches[$marker] = array( $element,
948 $content,
949 Sanitizer::decodeTagAttributes( $attributes ),
950 "<$element$attributes$close$content$tail" );
951 }
952 return $stripped;
953 }
954
955 /**
956 * Get a list of strippable XML-like elements
957 *
958 * @return array
959 */
960 function getStripList() {
961 return $this->mStripList;
962 }
963
964 /**
965 * Add an item to the strip state
966 * Returns the unique tag which must be inserted into the stripped text
967 * The tag will be replaced with the original text in unstrip()
968 *
969 * @param $text string
970 *
971 * @return string
972 */
973 function insertStripItem( $text ) {
974 $rnd = "{$this->mUniqPrefix}-item-{$this->mMarkerIndex}-" . self::MARKER_SUFFIX;
975 $this->mMarkerIndex++;
976 $this->mStripState->addGeneral( $rnd, $text );
977 return $rnd;
978 }
979
980 /**
981 * parse the wiki syntax used to render tables
982 *
983 * @private
984 * @return string
985 */
986 function doTableStuff( $text ) {
987 wfProfileIn( __METHOD__ );
988
989 $lines = StringUtils::explode( "\n", $text );
990 $out = '';
991 $td_history = array(); # Is currently a td tag open?
992 $last_tag_history = array(); # Save history of last lag activated (td, th or caption)
993 $tr_history = array(); # Is currently a tr tag open?
994 $tr_attributes = array(); # history of tr attributes
995 $has_opened_tr = array(); # Did this table open a <tr> element?
996 $indent_level = 0; # indent level of the table
997
998 foreach ( $lines as $outLine ) {
999 $line = trim( $outLine );
1000
1001 if ( $line === '' ) { # empty line, go to next line
1002 $out .= $outLine . "\n";
1003 continue;
1004 }
1005
1006 $first_character = $line[0];
1007 $matches = array();
1008
1009 if ( preg_match( '/^(:*)\{\|(.*)$/', $line, $matches ) ) {
1010 # First check if we are starting a new table
1011 $indent_level = strlen( $matches[1] );
1012
1013 $attributes = $this->mStripState->unstripBoth( $matches[2] );
1014 $attributes = Sanitizer::fixTagAttributes( $attributes, 'table' );
1015
1016 $outLine = str_repeat( '<dl><dd>', $indent_level ) . "<table{$attributes}>";
1017 array_push( $td_history, false );
1018 array_push( $last_tag_history, '' );
1019 array_push( $tr_history, false );
1020 array_push( $tr_attributes, '' );
1021 array_push( $has_opened_tr, false );
1022 } elseif ( count( $td_history ) == 0 ) {
1023 # Don't do any of the following
1024 $out .= $outLine . "\n";
1025 continue;
1026 } elseif ( substr( $line, 0, 2 ) === '|}' ) {
1027 # We are ending a table
1028 $line = '</table>' . substr( $line, 2 );
1029 $last_tag = array_pop( $last_tag_history );
1030
1031 if ( !array_pop( $has_opened_tr ) ) {
1032 $line = "<tr><td></td></tr>{$line}";
1033 }
1034
1035 if ( array_pop( $tr_history ) ) {
1036 $line = "</tr>{$line}";
1037 }
1038
1039 if ( array_pop( $td_history ) ) {
1040 $line = "</{$last_tag}>{$line}";
1041 }
1042 array_pop( $tr_attributes );
1043 $outLine = $line . str_repeat( '</dd></dl>', $indent_level );
1044 } elseif ( substr( $line, 0, 2 ) === '|-' ) {
1045 # Now we have a table row
1046 $line = preg_replace( '#^\|-+#', '', $line );
1047
1048 # Whats after the tag is now only attributes
1049 $attributes = $this->mStripState->unstripBoth( $line );
1050 $attributes = Sanitizer::fixTagAttributes( $attributes, 'tr' );
1051 array_pop( $tr_attributes );
1052 array_push( $tr_attributes, $attributes );
1053
1054 $line = '';
1055 $last_tag = array_pop( $last_tag_history );
1056 array_pop( $has_opened_tr );
1057 array_push( $has_opened_tr, true );
1058
1059 if ( array_pop( $tr_history ) ) {
1060 $line = '</tr>';
1061 }
1062
1063 if ( array_pop( $td_history ) ) {
1064 $line = "</{$last_tag}>{$line}";
1065 }
1066
1067 $outLine = $line;
1068 array_push( $tr_history, false );
1069 array_push( $td_history, false );
1070 array_push( $last_tag_history, '' );
1071 } elseif ( $first_character === '|' || $first_character === '!' || substr( $line, 0, 2 ) === '|+' ) {
1072 # This might be cell elements, td, th or captions
1073 if ( substr( $line, 0, 2 ) === '|+' ) {
1074 $first_character = '+';
1075 $line = substr( $line, 1 );
1076 }
1077
1078 $line = substr( $line, 1 );
1079
1080 if ( $first_character === '!' ) {
1081 $line = str_replace( '!!', '||', $line );
1082 }
1083
1084 # Split up multiple cells on the same line.
1085 # FIXME : This can result in improper nesting of tags processed
1086 # by earlier parser steps, but should avoid splitting up eg
1087 # attribute values containing literal "||".
1088 $cells = StringUtils::explodeMarkup( '||', $line );
1089
1090 $outLine = '';
1091
1092 # Loop through each table cell
1093 foreach ( $cells as $cell ) {
1094 $previous = '';
1095 if ( $first_character !== '+' ) {
1096 $tr_after = array_pop( $tr_attributes );
1097 if ( !array_pop( $tr_history ) ) {
1098 $previous = "<tr{$tr_after}>\n";
1099 }
1100 array_push( $tr_history, true );
1101 array_push( $tr_attributes, '' );
1102 array_pop( $has_opened_tr );
1103 array_push( $has_opened_tr, true );
1104 }
1105
1106 $last_tag = array_pop( $last_tag_history );
1107
1108 if ( array_pop( $td_history ) ) {
1109 $previous = "</{$last_tag}>\n{$previous}";
1110 }
1111
1112 if ( $first_character === '|' ) {
1113 $last_tag = 'td';
1114 } elseif ( $first_character === '!' ) {
1115 $last_tag = 'th';
1116 } elseif ( $first_character === '+' ) {
1117 $last_tag = 'caption';
1118 } else {
1119 $last_tag = '';
1120 }
1121
1122 array_push( $last_tag_history, $last_tag );
1123
1124 # A cell could contain both parameters and data
1125 $cell_data = explode( '|', $cell, 2 );
1126
1127 # Bug 553: Note that a '|' inside an invalid link should not
1128 # be mistaken as delimiting cell parameters
1129 if ( strpos( $cell_data[0], '[[' ) !== false ) {
1130 $cell = "{$previous}<{$last_tag}>{$cell}";
1131 } elseif ( count( $cell_data ) == 1 ) {
1132 $cell = "{$previous}<{$last_tag}>{$cell_data[0]}";
1133 } else {
1134 $attributes = $this->mStripState->unstripBoth( $cell_data[0] );
1135 $attributes = Sanitizer::fixTagAttributes( $attributes, $last_tag );
1136 $cell = "{$previous}<{$last_tag}{$attributes}>{$cell_data[1]}";
1137 }
1138
1139 $outLine .= $cell;
1140 array_push( $td_history, true );
1141 }
1142 }
1143 $out .= $outLine . "\n";
1144 }
1145
1146 # Closing open td, tr && table
1147 while ( count( $td_history ) > 0 ) {
1148 if ( array_pop( $td_history ) ) {
1149 $out .= "</td>\n";
1150 }
1151 if ( array_pop( $tr_history ) ) {
1152 $out .= "</tr>\n";
1153 }
1154 if ( !array_pop( $has_opened_tr ) ) {
1155 $out .= "<tr><td></td></tr>\n";
1156 }
1157
1158 $out .= "</table>\n";
1159 }
1160
1161 # Remove trailing line-ending (b/c)
1162 if ( substr( $out, -1 ) === "\n" ) {
1163 $out = substr( $out, 0, -1 );
1164 }
1165
1166 # special case: don't return empty table
1167 if ( $out === "<table>\n<tr><td></td></tr>\n</table>" ) {
1168 $out = '';
1169 }
1170
1171 wfProfileOut( __METHOD__ );
1172
1173 return $out;
1174 }
1175
1176 /**
1177 * Helper function for parse() that transforms wiki markup into
1178 * HTML. Only called for $mOutputType == self::OT_HTML.
1179 *
1180 * @private
1181 *
1182 * @param $text string
1183 * @param $isMain bool
1184 * @param $frame bool
1185 *
1186 * @return string
1187 */
1188 function internalParse( $text, $isMain = true, $frame = false ) {
1189 wfProfileIn( __METHOD__ );
1190
1191 $origText = $text;
1192
1193 # Hook to suspend the parser in this state
1194 if ( !wfRunHooks( 'ParserBeforeInternalParse', array( &$this, &$text, &$this->mStripState ) ) ) {
1195 wfProfileOut( __METHOD__ );
1196 return $text;
1197 }
1198
1199 # if $frame is provided, then use $frame for replacing any variables
1200 if ( $frame ) {
1201 # use frame depth to infer how include/noinclude tags should be handled
1202 # depth=0 means this is the top-level document; otherwise it's an included document
1203 if ( !$frame->depth ) {
1204 $flag = 0;
1205 } else {
1206 $flag = Parser::PTD_FOR_INCLUSION;
1207 }
1208 $dom = $this->preprocessToDom( $text, $flag );
1209 $text = $frame->expand( $dom );
1210 } else {
1211 # if $frame is not provided, then use old-style replaceVariables
1212 $text = $this->replaceVariables( $text );
1213 }
1214
1215 wfRunHooks( 'InternalParseBeforeSanitize', array( &$this, &$text, &$this->mStripState ) );
1216 $text = Sanitizer::removeHTMLtags( $text, array( &$this, 'attributeStripCallback' ), false, array_keys( $this->mTransparentTagHooks ) );
1217 wfRunHooks( 'InternalParseBeforeLinks', array( &$this, &$text, &$this->mStripState ) );
1218
1219 # Tables need to come after variable replacement for things to work
1220 # properly; putting them before other transformations should keep
1221 # exciting things like link expansions from showing up in surprising
1222 # places.
1223 $text = $this->doTableStuff( $text );
1224
1225 $text = preg_replace( '/(^|\n)-----*/', '\\1<hr />', $text );
1226
1227 $text = $this->doDoubleUnderscore( $text );
1228
1229 $text = $this->doHeadings( $text );
1230 $text = $this->replaceInternalLinks( $text );
1231 $text = $this->doAllQuotes( $text );
1232 $text = $this->replaceExternalLinks( $text );
1233
1234 # replaceInternalLinks may sometimes leave behind
1235 # absolute URLs, which have to be masked to hide them from replaceExternalLinks
1236 $text = str_replace( $this->mUniqPrefix . 'NOPARSE', '', $text );
1237
1238 $text = $this->doMagicLinks( $text );
1239 $text = $this->formatHeadings( $text, $origText, $isMain );
1240
1241 wfProfileOut( __METHOD__ );
1242 return $text;
1243 }
1244
1245 /**
1246 * Replace special strings like "ISBN xxx" and "RFC xxx" with
1247 * magic external links.
1248 *
1249 * DML
1250 * @private
1251 *
1252 * @param $text string
1253 *
1254 * @return string
1255 */
1256 function doMagicLinks( $text ) {
1257 wfProfileIn( __METHOD__ );
1258 $prots = wfUrlProtocolsWithoutProtRel();
1259 $urlChar = self::EXT_LINK_URL_CLASS;
1260 $text = preg_replace_callback(
1261 '!(?: # Start cases
1262 (<a[ \t\r\n>].*?</a>) | # m[1]: Skip link text
1263 (<.*?>) | # m[2]: Skip stuff inside HTML elements' . "
1264 (\\b(?i:$prots)$urlChar+) | # m[3]: Free external links" . '
1265 (?:RFC|PMID)\s+([0-9]+) | # m[4]: RFC or PMID, capture number
1266 ISBN\s+(\b # m[5]: ISBN, capture number
1267 (?: 97[89] [\ \-]? )? # optional 13-digit ISBN prefix
1268 (?: [0-9] [\ \-]? ){9} # 9 digits with opt. delimiters
1269 [0-9Xx] # check digit
1270 \b)
1271 )!xu', array( &$this, 'magicLinkCallback' ), $text );
1272 wfProfileOut( __METHOD__ );
1273 return $text;
1274 }
1275
1276 /**
1277 * @throws MWException
1278 * @param $m array
1279 * @return HTML|string
1280 */
1281 function magicLinkCallback( $m ) {
1282 if ( isset( $m[1] ) && $m[1] !== '' ) {
1283 # Skip anchor
1284 return $m[0];
1285 } elseif ( isset( $m[2] ) && $m[2] !== '' ) {
1286 # Skip HTML element
1287 return $m[0];
1288 } elseif ( isset( $m[3] ) && $m[3] !== '' ) {
1289 # Free external link
1290 return $this->makeFreeExternalLink( $m[0] );
1291 } elseif ( isset( $m[4] ) && $m[4] !== '' ) {
1292 # RFC or PMID
1293 if ( substr( $m[0], 0, 3 ) === 'RFC' ) {
1294 $keyword = 'RFC';
1295 $urlmsg = 'rfcurl';
1296 $CssClass = 'mw-magiclink-rfc';
1297 $id = $m[4];
1298 } elseif ( substr( $m[0], 0, 4 ) === 'PMID' ) {
1299 $keyword = 'PMID';
1300 $urlmsg = 'pubmedurl';
1301 $CssClass = 'mw-magiclink-pmid';
1302 $id = $m[4];
1303 } else {
1304 throw new MWException( __METHOD__ . ': unrecognised match type "' .
1305 substr( $m[0], 0, 20 ) . '"' );
1306 }
1307 $url = wfMessage( $urlmsg, $id )->inContentLanguage()->text();
1308 return Linker::makeExternalLink( $url, "{$keyword} {$id}", true, $CssClass );
1309 } elseif ( isset( $m[5] ) && $m[5] !== '' ) {
1310 # ISBN
1311 $isbn = $m[5];
1312 $num = strtr( $isbn, array(
1313 '-' => '',
1314 ' ' => '',
1315 'x' => 'X',
1316 ));
1317 $titleObj = SpecialPage::getTitleFor( 'Booksources', $num );
1318 return '<a href="' .
1319 htmlspecialchars( $titleObj->getLocalURL() ) .
1320 "\" class=\"internal mw-magiclink-isbn\">ISBN $isbn</a>";
1321 } else {
1322 return $m[0];
1323 }
1324 }
1325
1326 /**
1327 * Make a free external link, given a user-supplied URL
1328 *
1329 * @param $url string
1330 *
1331 * @return string HTML
1332 * @private
1333 */
1334 function makeFreeExternalLink( $url ) {
1335 wfProfileIn( __METHOD__ );
1336
1337 $trail = '';
1338
1339 # The characters '<' and '>' (which were escaped by
1340 # removeHTMLtags()) should not be included in
1341 # URLs, per RFC 2396.
1342 $m2 = array();
1343 if ( preg_match( '/&(lt|gt);/', $url, $m2, PREG_OFFSET_CAPTURE ) ) {
1344 $trail = substr( $url, $m2[0][1] ) . $trail;
1345 $url = substr( $url, 0, $m2[0][1] );
1346 }
1347
1348 # Move trailing punctuation to $trail
1349 $sep = ',;\.:!?';
1350 # If there is no left bracket, then consider right brackets fair game too
1351 if ( strpos( $url, '(' ) === false ) {
1352 $sep .= ')';
1353 }
1354
1355 $numSepChars = strspn( strrev( $url ), $sep );
1356 if ( $numSepChars ) {
1357 $trail = substr( $url, -$numSepChars ) . $trail;
1358 $url = substr( $url, 0, -$numSepChars );
1359 }
1360
1361 $url = Sanitizer::cleanUrl( $url );
1362
1363 # Is this an external image?
1364 $text = $this->maybeMakeExternalImage( $url );
1365 if ( $text === false ) {
1366 # Not an image, make a link
1367 $text = Linker::makeExternalLink( $url,
1368 $this->getConverterLanguage()->markNoConversion( $url, true ),
1369 true, 'free',
1370 $this->getExternalLinkAttribs( $url ) );
1371 # Register it in the output object...
1372 # Replace unnecessary URL escape codes with their equivalent characters
1373 $pasteurized = self::replaceUnusualEscapes( $url );
1374 $this->mOutput->addExternalLink( $pasteurized );
1375 }
1376 wfProfileOut( __METHOD__ );
1377 return $text . $trail;
1378 }
1379
1380 /**
1381 * Parse headers and return html
1382 *
1383 * @private
1384 *
1385 * @param $text string
1386 *
1387 * @return string
1388 */
1389 function doHeadings( $text ) {
1390 wfProfileIn( __METHOD__ );
1391 for ( $i = 6; $i >= 1; --$i ) {
1392 $h = str_repeat( '=', $i );
1393 $text = preg_replace( "/^$h(.+)$h\\s*$/m", "<h$i>\\1</h$i>", $text );
1394 }
1395 wfProfileOut( __METHOD__ );
1396 return $text;
1397 }
1398
1399 /**
1400 * Replace single quotes with HTML markup
1401 * @private
1402 *
1403 * @param $text string
1404 *
1405 * @return string the altered text
1406 */
1407 function doAllQuotes( $text ) {
1408 wfProfileIn( __METHOD__ );
1409 $outtext = '';
1410 $lines = StringUtils::explode( "\n", $text );
1411 foreach ( $lines as $line ) {
1412 $outtext .= $this->doQuotes( $line ) . "\n";
1413 }
1414 $outtext = substr( $outtext, 0, -1 );
1415 wfProfileOut( __METHOD__ );
1416 return $outtext;
1417 }
1418
1419 /**
1420 * Helper function for doAllQuotes()
1421 *
1422 * @param $text string
1423 *
1424 * @return string
1425 */
1426 public function doQuotes( $text ) {
1427 $arr = preg_split( "/(''+)/", $text, -1, PREG_SPLIT_DELIM_CAPTURE );
1428 $countarr = count( $arr );
1429 if ( $countarr == 1 ) {
1430 return $text;
1431 }
1432
1433 // First, do some preliminary work. This may shift some apostrophes from
1434 // being mark-up to being text. It also counts the number of occurrences
1435 // of bold and italics mark-ups.
1436 $numbold = 0;
1437 $numitalics = 0;
1438 for ( $i = 1; $i < $countarr; $i += 2 ) {
1439 $thislen = strlen( $arr[$i] );
1440 // If there are ever four apostrophes, assume the first is supposed to
1441 // be text, and the remaining three constitute mark-up for bold text.
1442 // (bug 13227: ''''foo'''' turns into ' ''' foo ' ''')
1443 if ( $thislen == 4 ) {
1444 $arr[$i - 1] .= "'";
1445 $arr[$i] = "'''";
1446 $thislen = 3;
1447 } elseif ( $thislen > 5 ) {
1448 // If there are more than 5 apostrophes in a row, assume they're all
1449 // text except for the last 5.
1450 // (bug 13227: ''''''foo'''''' turns into ' ''''' foo ' ''''')
1451 $arr[$i - 1] .= str_repeat( "'", $thislen - 5 );
1452 $arr[$i] = "'''''";
1453 $thislen = 5;
1454 }
1455 // Count the number of occurrences of bold and italics mark-ups.
1456 if ( $thislen == 2 ) {
1457 $numitalics++;
1458 } elseif ( $thislen == 3 ) {
1459 $numbold++;
1460 } elseif ( $thislen == 5 ) {
1461 $numitalics++;
1462 $numbold++;
1463 }
1464 }
1465
1466 // If there is an odd number of both bold and italics, it is likely
1467 // that one of the bold ones was meant to be an apostrophe followed
1468 // by italics. Which one we cannot know for certain, but it is more
1469 // likely to be one that has a single-letter word before it.
1470 if ( ( $numbold % 2 == 1 ) && ( $numitalics % 2 == 1 ) ) {
1471 $firstsingleletterword = -1;
1472 $firstmultiletterword = -1;
1473 $firstspace = -1;
1474 for ( $i = 1; $i < $countarr; $i += 2 ) {
1475 if ( strlen( $arr[$i] ) == 3 ) {
1476 $x1 = substr( $arr[$i - 1], -1 );
1477 $x2 = substr( $arr[$i - 1], -2, 1 );
1478 if ( $x1 === ' ' ) {
1479 if ( $firstspace == -1 ) {
1480 $firstspace = $i;
1481 }
1482 } elseif ( $x2 === ' ' ) {
1483 if ( $firstsingleletterword == -1 ) {
1484 $firstsingleletterword = $i;
1485 // if $firstsingleletterword is set, we don't
1486 // look at the other options, so we can bail early.
1487 break;
1488 }
1489 } else {
1490 if ( $firstmultiletterword == -1 ) {
1491 $firstmultiletterword = $i;
1492 }
1493 }
1494 }
1495 }
1496
1497 // If there is a single-letter word, use it!
1498 if ( $firstsingleletterword > -1 ) {
1499 $arr[$firstsingleletterword] = "''";
1500 $arr[$firstsingleletterword - 1] .= "'";
1501 } elseif ( $firstmultiletterword > -1 ) {
1502 // If not, but there's a multi-letter word, use that one.
1503 $arr[$firstmultiletterword] = "''";
1504 $arr[$firstmultiletterword - 1] .= "'";
1505 } elseif ( $firstspace > -1 ) {
1506 // ... otherwise use the first one that has neither.
1507 // (notice that it is possible for all three to be -1 if, for example,
1508 // there is only one pentuple-apostrophe in the line)
1509 $arr[$firstspace] = "''";
1510 $arr[$firstspace - 1] .= "'";
1511 }
1512 }
1513
1514 // Now let's actually convert our apostrophic mush to HTML!
1515 $output = '';
1516 $buffer = '';
1517 $state = '';
1518 $i = 0;
1519 foreach ( $arr as $r ) {
1520 if ( ( $i % 2 ) == 0 ) {
1521 if ( $state === 'both' ) {
1522 $buffer .= $r;
1523 } else {
1524 $output .= $r;
1525 }
1526 } else {
1527 $thislen = strlen( $r );
1528 if ( $thislen == 2 ) {
1529 if ( $state === 'i' ) {
1530 $output .= '</i>';
1531 $state = '';
1532 } elseif ( $state === 'bi' ) {
1533 $output .= '</i>';
1534 $state = 'b';
1535 } elseif ( $state === 'ib' ) {
1536 $output .= '</b></i><b>';
1537 $state = 'b';
1538 } elseif ( $state === 'both' ) {
1539 $output .= '<b><i>' . $buffer . '</i>';
1540 $state = 'b';
1541 } else { // $state can be 'b' or ''
1542 $output .= '<i>';
1543 $state .= 'i';
1544 }
1545 } elseif ( $thislen == 3 ) {
1546 if ( $state === 'b' ) {
1547 $output .= '</b>';
1548 $state = '';
1549 } elseif ( $state === 'bi' ) {
1550 $output .= '</i></b><i>';
1551 $state = 'i';
1552 } elseif ( $state === 'ib' ) {
1553 $output .= '</b>';
1554 $state = 'i';
1555 } elseif ( $state === 'both' ) {
1556 $output .= '<i><b>' . $buffer . '</b>';
1557 $state = 'i';
1558 } else { // $state can be 'i' or ''
1559 $output .= '<b>';
1560 $state .= 'b';
1561 }
1562 } elseif ( $thislen == 5 ) {
1563 if ( $state === 'b' ) {
1564 $output .= '</b><i>';
1565 $state = 'i';
1566 } elseif ( $state === 'i' ) {
1567 $output .= '</i><b>';
1568 $state = 'b';
1569 } elseif ( $state === 'bi' ) {
1570 $output .= '</i></b>';
1571 $state = '';
1572 } elseif ( $state === 'ib' ) {
1573 $output .= '</b></i>';
1574 $state = '';
1575 } elseif ( $state === 'both' ) {
1576 $output .= '<i><b>' . $buffer . '</b></i>';
1577 $state = '';
1578 } else { // ($state == '')
1579 $buffer = '';
1580 $state = 'both';
1581 }
1582 }
1583 }
1584 $i++;
1585 }
1586 // Now close all remaining tags. Notice that the order is important.
1587 if ( $state === 'b' || $state === 'ib' ) {
1588 $output .= '</b>';
1589 }
1590 if ( $state === 'i' || $state === 'bi' || $state === 'ib' ) {
1591 $output .= '</i>';
1592 }
1593 if ( $state === 'bi' ) {
1594 $output .= '</b>';
1595 }
1596 // There might be lonely ''''', so make sure we have a buffer
1597 if ( $state === 'both' && $buffer ) {
1598 $output .= '<b><i>' . $buffer . '</i></b>';
1599 }
1600 return $output;
1601 }
1602
1603 /**
1604 * Replace external links (REL)
1605 *
1606 * Note: this is all very hackish and the order of execution matters a lot.
1607 * Make sure to run tests/parserTests.php if you change this code.
1608 *
1609 * @private
1610 *
1611 * @param $text string
1612 *
1613 * @throws MWException
1614 * @return string
1615 */
1616 function replaceExternalLinks( $text ) {
1617 wfProfileIn( __METHOD__ );
1618
1619 $bits = preg_split( $this->mExtLinkBracketedRegex, $text, -1, PREG_SPLIT_DELIM_CAPTURE );
1620 if ( $bits === false ) {
1621 wfProfileOut( __METHOD__ );
1622 throw new MWException( "PCRE needs to be compiled with --enable-unicode-properties in order for MediaWiki to function" );
1623 }
1624 $s = array_shift( $bits );
1625
1626 $i = 0;
1627 while ( $i < count( $bits ) ) {
1628 $url = $bits[$i++];
1629 $i++; // protocol
1630 $text = $bits[$i++];
1631 $trail = $bits[$i++];
1632
1633 # The characters '<' and '>' (which were escaped by
1634 # removeHTMLtags()) should not be included in
1635 # URLs, per RFC 2396.
1636 $m2 = array();
1637 if ( preg_match( '/&(lt|gt);/', $url, $m2, PREG_OFFSET_CAPTURE ) ) {
1638 $text = substr( $url, $m2[0][1] ) . ' ' . $text;
1639 $url = substr( $url, 0, $m2[0][1] );
1640 }
1641
1642 # If the link text is an image URL, replace it with an <img> tag
1643 # This happened by accident in the original parser, but some people used it extensively
1644 $img = $this->maybeMakeExternalImage( $text );
1645 if ( $img !== false ) {
1646 $text = $img;
1647 }
1648
1649 $dtrail = '';
1650
1651 # Set linktype for CSS - if URL==text, link is essentially free
1652 $linktype = ( $text === $url ) ? 'free' : 'text';
1653
1654 # No link text, e.g. [http://domain.tld/some.link]
1655 if ( $text == '' ) {
1656 # Autonumber
1657 $langObj = $this->getTargetLanguage();
1658 $text = '[' . $langObj->formatNum( ++$this->mAutonumber ) . ']';
1659 $linktype = 'autonumber';
1660 } else {
1661 # Have link text, e.g. [http://domain.tld/some.link text]s
1662 # Check for trail
1663 list( $dtrail, $trail ) = Linker::splitTrail( $trail );
1664 }
1665
1666 $text = $this->getConverterLanguage()->markNoConversion( $text );
1667
1668 $url = Sanitizer::cleanUrl( $url );
1669
1670 # Use the encoded URL
1671 # This means that users can paste URLs directly into the text
1672 # Funny characters like ö aren't valid in URLs anyway
1673 # This was changed in August 2004
1674 $s .= Linker::makeExternalLink( $url, $text, false, $linktype,
1675 $this->getExternalLinkAttribs( $url ) ) . $dtrail . $trail;
1676
1677 # Register link in the output object.
1678 # Replace unnecessary URL escape codes with the referenced character
1679 # This prevents spammers from hiding links from the filters
1680 $pasteurized = self::replaceUnusualEscapes( $url );
1681 $this->mOutput->addExternalLink( $pasteurized );
1682 }
1683
1684 wfProfileOut( __METHOD__ );
1685 return $s;
1686 }
1687 /**
1688 * Get the rel attribute for a particular external link.
1689 *
1690 * @since 1.21
1691 * @param string|bool $url optional URL, to extract the domain from for rel =>
1692 * nofollow if appropriate
1693 * @param $title Title optional Title, for wgNoFollowNsExceptions lookups
1694 * @return string|null rel attribute for $url
1695 */
1696 public static function getExternalLinkRel( $url = false, $title = null ) {
1697 global $wgNoFollowLinks, $wgNoFollowNsExceptions, $wgNoFollowDomainExceptions;
1698 $ns = $title ? $title->getNamespace() : false;
1699 if ( $wgNoFollowLinks && !in_array( $ns, $wgNoFollowNsExceptions )
1700 && !wfMatchesDomainList( $url, $wgNoFollowDomainExceptions )
1701 ) {
1702 return 'nofollow';
1703 }
1704 return null;
1705 }
1706 /**
1707 * Get an associative array of additional HTML attributes appropriate for a
1708 * particular external link. This currently may include rel => nofollow
1709 * (depending on configuration, namespace, and the URL's domain) and/or a
1710 * target attribute (depending on configuration).
1711 *
1712 * @param string|bool $url optional URL, to extract the domain from for rel =>
1713 * nofollow if appropriate
1714 * @return Array associative array of HTML attributes
1715 */
1716 function getExternalLinkAttribs( $url = false ) {
1717 $attribs = array();
1718 $attribs['rel'] = self::getExternalLinkRel( $url, $this->mTitle );
1719
1720 if ( $this->mOptions->getExternalLinkTarget() ) {
1721 $attribs['target'] = $this->mOptions->getExternalLinkTarget();
1722 }
1723 return $attribs;
1724 }
1725
1726 /**
1727 * Replace unusual URL escape codes with their equivalent characters
1728 *
1729 * @param $url String
1730 * @return String
1731 *
1732 * @todo This can merge genuinely required bits in the path or query string,
1733 * breaking legit URLs. A proper fix would treat the various parts of
1734 * the URL differently; as a workaround, just use the output for
1735 * statistical records, not for actual linking/output.
1736 */
1737 static function replaceUnusualEscapes( $url ) {
1738 return preg_replace_callback( '/%[0-9A-Fa-f]{2}/',
1739 array( __CLASS__, 'replaceUnusualEscapesCallback' ), $url );
1740 }
1741
1742 /**
1743 * Callback function used in replaceUnusualEscapes().
1744 * Replaces unusual URL escape codes with their equivalent character
1745 *
1746 * @param $matches array
1747 *
1748 * @return string
1749 */
1750 private static function replaceUnusualEscapesCallback( $matches ) {
1751 $char = urldecode( $matches[0] );
1752 $ord = ord( $char );
1753 # Is it an unsafe or HTTP reserved character according to RFC 1738?
1754 if ( $ord > 32 && $ord < 127 && strpos( '<>"#{}|\^~[]`;/?', $char ) === false ) {
1755 # No, shouldn't be escaped
1756 return $char;
1757 } else {
1758 # Yes, leave it escaped
1759 return $matches[0];
1760 }
1761 }
1762
1763 /**
1764 * make an image if it's allowed, either through the global
1765 * option, through the exception, or through the on-wiki whitelist
1766 * @private
1767 *
1768 * $param $url string
1769 *
1770 * @return string
1771 */
1772 function maybeMakeExternalImage( $url ) {
1773 $imagesfrom = $this->mOptions->getAllowExternalImagesFrom();
1774 $imagesexception = !empty( $imagesfrom );
1775 $text = false;
1776 # $imagesfrom could be either a single string or an array of strings, parse out the latter
1777 if ( $imagesexception && is_array( $imagesfrom ) ) {
1778 $imagematch = false;
1779 foreach ( $imagesfrom as $match ) {
1780 if ( strpos( $url, $match ) === 0 ) {
1781 $imagematch = true;
1782 break;
1783 }
1784 }
1785 } elseif ( $imagesexception ) {
1786 $imagematch = ( strpos( $url, $imagesfrom ) === 0 );
1787 } else {
1788 $imagematch = false;
1789 }
1790 if ( $this->mOptions->getAllowExternalImages()
1791 || ( $imagesexception && $imagematch ) ) {
1792 if ( preg_match( self::EXT_IMAGE_REGEX, $url ) ) {
1793 # Image found
1794 $text = Linker::makeExternalImage( $url );
1795 }
1796 }
1797 if ( !$text && $this->mOptions->getEnableImageWhitelist()
1798 && preg_match( self::EXT_IMAGE_REGEX, $url ) ) {
1799 $whitelist = explode( "\n", wfMessage( 'external_image_whitelist' )->inContentLanguage()->text() );
1800 foreach ( $whitelist as $entry ) {
1801 # Sanitize the regex fragment, make it case-insensitive, ignore blank entries/comments
1802 if ( strpos( $entry, '#' ) === 0 || $entry === '' ) {
1803 continue;
1804 }
1805 if ( preg_match( '/' . str_replace( '/', '\\/', $entry ) . '/i', $url ) ) {
1806 # Image matches a whitelist entry
1807 $text = Linker::makeExternalImage( $url );
1808 break;
1809 }
1810 }
1811 }
1812 return $text;
1813 }
1814
1815 /**
1816 * Process [[ ]] wikilinks
1817 *
1818 * @param $s string
1819 *
1820 * @return String: processed text
1821 *
1822 * @private
1823 */
1824 function replaceInternalLinks( $s ) {
1825 $this->mLinkHolders->merge( $this->replaceInternalLinks2( $s ) );
1826 return $s;
1827 }
1828
1829 /**
1830 * Process [[ ]] wikilinks (RIL)
1831 * @param $s
1832 * @throws MWException
1833 * @return LinkHolderArray
1834 *
1835 * @private
1836 */
1837 function replaceInternalLinks2( &$s ) {
1838 wfProfileIn( __METHOD__ );
1839
1840 wfProfileIn( __METHOD__ . '-setup' );
1841 static $tc = false, $e1, $e1_img;
1842 # the % is needed to support urlencoded titles as well
1843 if ( !$tc ) {
1844 $tc = Title::legalChars() . '#%';
1845 # Match a link having the form [[namespace:link|alternate]]trail
1846 $e1 = "/^([{$tc}]+)(?:\\|(.+?))?]](.*)\$/sD";
1847 # Match cases where there is no "]]", which might still be images
1848 $e1_img = "/^([{$tc}]+)\\|(.*)\$/sD";
1849 }
1850
1851 $holders = new LinkHolderArray( $this );
1852
1853 # split the entire text string on occurrences of [[
1854 $a = StringUtils::explode( '[[', ' ' . $s );
1855 # get the first element (all text up to first [[), and remove the space we added
1856 $s = $a->current();
1857 $a->next();
1858 $line = $a->current(); # Workaround for broken ArrayIterator::next() that returns "void"
1859 $s = substr( $s, 1 );
1860
1861 $useLinkPrefixExtension = $this->getTargetLanguage()->linkPrefixExtension();
1862 $e2 = null;
1863 if ( $useLinkPrefixExtension ) {
1864 # Match the end of a line for a word that's not followed by whitespace,
1865 # e.g. in the case of 'The Arab al[[Razi]]', 'al' will be matched
1866 global $wgContLang;
1867 $charset = $wgContLang->linkPrefixCharset();
1868 $e2 = "/^((?>.*[^$charset]|))(.+)$/sDu";
1869 }
1870
1871 if ( is_null( $this->mTitle ) ) {
1872 wfProfileOut( __METHOD__ . '-setup' );
1873 wfProfileOut( __METHOD__ );
1874 throw new MWException( __METHOD__ . ": \$this->mTitle is null\n" );
1875 }
1876 $nottalk = !$this->mTitle->isTalkPage();
1877
1878 if ( $useLinkPrefixExtension ) {
1879 $m = array();
1880 if ( preg_match( $e2, $s, $m ) ) {
1881 $first_prefix = $m[2];
1882 } else {
1883 $first_prefix = false;
1884 }
1885 } else {
1886 $prefix = '';
1887 }
1888
1889 $useSubpages = $this->areSubpagesAllowed();
1890 wfProfileOut( __METHOD__ . '-setup' );
1891
1892 # Loop for each link
1893 for ( ; $line !== false && $line !== null; $a->next(), $line = $a->current() ) {
1894 # Check for excessive memory usage
1895 if ( $holders->isBig() ) {
1896 # Too big
1897 # Do the existence check, replace the link holders and clear the array
1898 $holders->replace( $s );
1899 $holders->clear();
1900 }
1901
1902 if ( $useLinkPrefixExtension ) {
1903 wfProfileIn( __METHOD__ . '-prefixhandling' );
1904 if ( preg_match( $e2, $s, $m ) ) {
1905 $prefix = $m[2];
1906 $s = $m[1];
1907 } else {
1908 $prefix = '';
1909 }
1910 # first link
1911 if ( $first_prefix ) {
1912 $prefix = $first_prefix;
1913 $first_prefix = false;
1914 }
1915 wfProfileOut( __METHOD__ . '-prefixhandling' );
1916 }
1917
1918 $might_be_img = false;
1919
1920 wfProfileIn( __METHOD__ . "-e1" );
1921 if ( preg_match( $e1, $line, $m ) ) { # page with normal text or alt
1922 $text = $m[2];
1923 # If we get a ] at the beginning of $m[3] that means we have a link that's something like:
1924 # [[Image:Foo.jpg|[http://example.com desc]]] <- having three ] in a row fucks up,
1925 # the real problem is with the $e1 regex
1926 # See bug 1300.
1927 #
1928 # Still some problems for cases where the ] is meant to be outside punctuation,
1929 # and no image is in sight. See bug 2095.
1930 #
1931 if ( $text !== ''
1932 && substr( $m[3], 0, 1 ) === ']'
1933 && strpos( $text, '[' ) !== false
1934 ) {
1935 $text .= ']'; # so that replaceExternalLinks($text) works later
1936 $m[3] = substr( $m[3], 1 );
1937 }
1938 # fix up urlencoded title texts
1939 if ( strpos( $m[1], '%' ) !== false ) {
1940 # Should anchors '#' also be rejected?
1941 $m[1] = str_replace( array( '<', '>' ), array( '&lt;', '&gt;' ), rawurldecode( $m[1] ) );
1942 }
1943 $trail = $m[3];
1944 } elseif ( preg_match( $e1_img, $line, $m ) ) { # Invalid, but might be an image with a link in its caption
1945 $might_be_img = true;
1946 $text = $m[2];
1947 if ( strpos( $m[1], '%' ) !== false ) {
1948 $m[1] = rawurldecode( $m[1] );
1949 }
1950 $trail = "";
1951 } else { # Invalid form; output directly
1952 $s .= $prefix . '[[' . $line;
1953 wfProfileOut( __METHOD__ . "-e1" );
1954 continue;
1955 }
1956 wfProfileOut( __METHOD__ . "-e1" );
1957 wfProfileIn( __METHOD__ . "-misc" );
1958
1959 # Don't allow internal links to pages containing
1960 # PROTO: where PROTO is a valid URL protocol; these
1961 # should be external links.
1962 if ( preg_match( '/^(?i:' . $this->mUrlProtocols . ')/', $m[1] ) ) {
1963 $s .= $prefix . '[[' . $line;
1964 wfProfileOut( __METHOD__ . "-misc" );
1965 continue;
1966 }
1967
1968 # Make subpage if necessary
1969 if ( $useSubpages ) {
1970 $link = $this->maybeDoSubpageLink( $m[1], $text );
1971 } else {
1972 $link = $m[1];
1973 }
1974
1975 $noforce = ( substr( $m[1], 0, 1 ) !== ':' );
1976 if ( !$noforce ) {
1977 # Strip off leading ':'
1978 $link = substr( $link, 1 );
1979 }
1980
1981 wfProfileOut( __METHOD__ . "-misc" );
1982 wfProfileIn( __METHOD__ . "-title" );
1983 $nt = Title::newFromText( $this->mStripState->unstripNoWiki( $link ) );
1984 if ( $nt === null ) {
1985 $s .= $prefix . '[[' . $line;
1986 wfProfileOut( __METHOD__ . "-title" );
1987 continue;
1988 }
1989
1990 $ns = $nt->getNamespace();
1991 $iw = $nt->getInterWiki();
1992 wfProfileOut( __METHOD__ . "-title" );
1993
1994 if ( $might_be_img ) { # if this is actually an invalid link
1995 wfProfileIn( __METHOD__ . "-might_be_img" );
1996 if ( $ns == NS_FILE && $noforce ) { # but might be an image
1997 $found = false;
1998 while ( true ) {
1999 # look at the next 'line' to see if we can close it there
2000 $a->next();
2001 $next_line = $a->current();
2002 if ( $next_line === false || $next_line === null ) {
2003 break;
2004 }
2005 $m = explode( ']]', $next_line, 3 );
2006 if ( count( $m ) == 3 ) {
2007 # the first ]] closes the inner link, the second the image
2008 $found = true;
2009 $text .= "[[{$m[0]}]]{$m[1]}";
2010 $trail = $m[2];
2011 break;
2012 } elseif ( count( $m ) == 2 ) {
2013 # if there's exactly one ]] that's fine, we'll keep looking
2014 $text .= "[[{$m[0]}]]{$m[1]}";
2015 } else {
2016 # if $next_line is invalid too, we need look no further
2017 $text .= '[[' . $next_line;
2018 break;
2019 }
2020 }
2021 if ( !$found ) {
2022 # we couldn't find the end of this imageLink, so output it raw
2023 # but don't ignore what might be perfectly normal links in the text we've examined
2024 $holders->merge( $this->replaceInternalLinks2( $text ) );
2025 $s .= "{$prefix}[[$link|$text";
2026 # note: no $trail, because without an end, there *is* no trail
2027 wfProfileOut( __METHOD__ . "-might_be_img" );
2028 continue;
2029 }
2030 } else { # it's not an image, so output it raw
2031 $s .= "{$prefix}[[$link|$text";
2032 # note: no $trail, because without an end, there *is* no trail
2033 wfProfileOut( __METHOD__ . "-might_be_img" );
2034 continue;
2035 }
2036 wfProfileOut( __METHOD__ . "-might_be_img" );
2037 }
2038
2039 $wasblank = ( $text == '' );
2040 if ( $wasblank ) {
2041 $text = $link;
2042 } else {
2043 # Bug 4598 madness. Handle the quotes only if they come from the alternate part
2044 # [[Lista d''e paise d''o munno]] -> <a href="...">Lista d''e paise d''o munno</a>
2045 # [[Criticism of Harry Potter|Criticism of ''Harry Potter'']]
2046 # -> <a href="Criticism of Harry Potter">Criticism of <i>Harry Potter</i></a>
2047 $text = $this->doQuotes( $text );
2048 }
2049
2050 # Link not escaped by : , create the various objects
2051 if ( $noforce ) {
2052 # Interwikis
2053 wfProfileIn( __METHOD__ . "-interwiki" );
2054 if ( $iw && $this->mOptions->getInterwikiMagic() && $nottalk && Language::fetchLanguageName( $iw, null, 'mw' ) ) {
2055 // XXX: the above check prevents links to sites with identifiers that are not language codes
2056
2057 # Bug 24502: filter duplicates
2058 if ( !isset( $this->mLangLinkLanguages[$iw] ) ) {
2059 $this->mLangLinkLanguages[$iw] = true;
2060 $this->mOutput->addLanguageLink( $nt->getFullText() );
2061 }
2062
2063 $s = rtrim( $s . $prefix );
2064 $s .= trim( $trail, "\n" ) == '' ? '': $prefix . $trail;
2065 wfProfileOut( __METHOD__ . "-interwiki" );
2066 continue;
2067 }
2068 wfProfileOut( __METHOD__ . "-interwiki" );
2069
2070 if ( $ns == NS_FILE ) {
2071 wfProfileIn( __METHOD__ . "-image" );
2072 if ( !wfIsBadImage( $nt->getDBkey(), $this->mTitle ) ) {
2073 if ( $wasblank ) {
2074 # if no parameters were passed, $text
2075 # becomes something like "File:Foo.png",
2076 # which we don't want to pass on to the
2077 # image generator
2078 $text = '';
2079 } else {
2080 # recursively parse links inside the image caption
2081 # actually, this will parse them in any other parameters, too,
2082 # but it might be hard to fix that, and it doesn't matter ATM
2083 $text = $this->replaceExternalLinks( $text );
2084 $holders->merge( $this->replaceInternalLinks2( $text ) );
2085 }
2086 # cloak any absolute URLs inside the image markup, so replaceExternalLinks() won't touch them
2087 $s .= $prefix . $this->armorLinks(
2088 $this->makeImage( $nt, $text, $holders ) ) . $trail;
2089 } else {
2090 $s .= $prefix . $trail;
2091 }
2092 wfProfileOut( __METHOD__ . "-image" );
2093 continue;
2094 }
2095
2096 if ( $ns == NS_CATEGORY ) {
2097 wfProfileIn( __METHOD__ . "-category" );
2098 $s = rtrim( $s . "\n" ); # bug 87
2099
2100 if ( $wasblank ) {
2101 $sortkey = $this->getDefaultSort();
2102 } else {
2103 $sortkey = $text;
2104 }
2105 $sortkey = Sanitizer::decodeCharReferences( $sortkey );
2106 $sortkey = str_replace( "\n", '', $sortkey );
2107 $sortkey = $this->getConverterLanguage()->convertCategoryKey( $sortkey );
2108 $this->mOutput->addCategory( $nt->getDBkey(), $sortkey );
2109
2110 /**
2111 * Strip the whitespace Category links produce, see bug 87
2112 */
2113 $s .= trim( $prefix . $trail, "\n" ) == '' ? '' : $prefix . $trail;
2114
2115 wfProfileOut( __METHOD__ . "-category" );
2116 continue;
2117 }
2118 }
2119
2120 # Self-link checking. For some languages, variants of the title are checked in
2121 # LinkHolderArray::doVariants() to allow batching the existence checks necessary
2122 # for linking to a different variant.
2123 if ( $ns != NS_SPECIAL && $nt->equals( $this->mTitle ) && $nt->getFragment() === '' ) {
2124 $s .= $prefix . Linker::makeSelfLinkObj( $nt, $text, '', $trail );
2125 continue;
2126 }
2127
2128 # NS_MEDIA is a pseudo-namespace for linking directly to a file
2129 # @todo FIXME: Should do batch file existence checks, see comment below
2130 if ( $ns == NS_MEDIA ) {
2131 wfProfileIn( __METHOD__ . "-media" );
2132 # Give extensions a chance to select the file revision for us
2133 $options = array();
2134 $descQuery = false;
2135 wfRunHooks( 'BeforeParserFetchFileAndTitle',
2136 array( $this, $nt, &$options, &$descQuery ) );
2137 # Fetch and register the file (file title may be different via hooks)
2138 list( $file, $nt ) = $this->fetchFileAndTitle( $nt, $options );
2139 # Cloak with NOPARSE to avoid replacement in replaceExternalLinks
2140 $s .= $prefix . $this->armorLinks(
2141 Linker::makeMediaLinkFile( $nt, $file, $text ) ) . $trail;
2142 wfProfileOut( __METHOD__ . "-media" );
2143 continue;
2144 }
2145
2146 wfProfileIn( __METHOD__ . "-always_known" );
2147 # Some titles, such as valid special pages or files in foreign repos, should
2148 # be shown as bluelinks even though they're not included in the page table
2149 #
2150 # @todo FIXME: isAlwaysKnown() can be expensive for file links; we should really do
2151 # batch file existence checks for NS_FILE and NS_MEDIA
2152 if ( $iw == '' && $nt->isAlwaysKnown() ) {
2153 $this->mOutput->addLink( $nt );
2154 $s .= $this->makeKnownLinkHolder( $nt, $text, array(), $trail, $prefix );
2155 } else {
2156 # Links will be added to the output link list after checking
2157 $s .= $holders->makeHolder( $nt, $text, array(), $trail, $prefix );
2158 }
2159 wfProfileOut( __METHOD__ . "-always_known" );
2160 }
2161 wfProfileOut( __METHOD__ );
2162 return $holders;
2163 }
2164
2165 /**
2166 * Render a forced-blue link inline; protect against double expansion of
2167 * URLs if we're in a mode that prepends full URL prefixes to internal links.
2168 * Since this little disaster has to split off the trail text to avoid
2169 * breaking URLs in the following text without breaking trails on the
2170 * wiki links, it's been made into a horrible function.
2171 *
2172 * @param $nt Title
2173 * @param $text String
2174 * @param array $query or String
2175 * @param $trail String
2176 * @param $prefix String
2177 * @return String: HTML-wikitext mix oh yuck
2178 */
2179 function makeKnownLinkHolder( $nt, $text = '', $query = array(), $trail = '', $prefix = '' ) {
2180 list( $inside, $trail ) = Linker::splitTrail( $trail );
2181
2182 if ( is_string( $query ) ) {
2183 $query = wfCgiToArray( $query );
2184 }
2185 if ( $text == '' ) {
2186 $text = htmlspecialchars( $nt->getPrefixedText() );
2187 }
2188
2189 $link = Linker::linkKnown( $nt, "$prefix$text$inside", array(), $query );
2190
2191 return $this->armorLinks( $link ) . $trail;
2192 }
2193
2194 /**
2195 * Insert a NOPARSE hacky thing into any inline links in a chunk that's
2196 * going to go through further parsing steps before inline URL expansion.
2197 *
2198 * Not needed quite as much as it used to be since free links are a bit
2199 * more sensible these days. But bracketed links are still an issue.
2200 *
2201 * @param string $text more-or-less HTML
2202 * @return String: less-or-more HTML with NOPARSE bits
2203 */
2204 function armorLinks( $text ) {
2205 return preg_replace( '/\b((?i)' . $this->mUrlProtocols . ')/',
2206 "{$this->mUniqPrefix}NOPARSE$1", $text );
2207 }
2208
2209 /**
2210 * Return true if subpage links should be expanded on this page.
2211 * @return Boolean
2212 */
2213 function areSubpagesAllowed() {
2214 # Some namespaces don't allow subpages
2215 return MWNamespace::hasSubpages( $this->mTitle->getNamespace() );
2216 }
2217
2218 /**
2219 * Handle link to subpage if necessary
2220 *
2221 * @param string $target the source of the link
2222 * @param &$text String: the link text, modified as necessary
2223 * @return string the full name of the link
2224 * @private
2225 */
2226 function maybeDoSubpageLink( $target, &$text ) {
2227 return Linker::normalizeSubpageLink( $this->mTitle, $target, $text );
2228 }
2229
2230 /**#@+
2231 * Used by doBlockLevels()
2232 * @private
2233 *
2234 * @return string
2235 */
2236 function closeParagraph() {
2237 $result = '';
2238 if ( $this->mLastSection != '' ) {
2239 $result = '</' . $this->mLastSection . ">\n";
2240 }
2241 $this->mInPre = false;
2242 $this->mLastSection = '';
2243 return $result;
2244 }
2245
2246 /**
2247 * getCommon() returns the length of the longest common substring
2248 * of both arguments, starting at the beginning of both.
2249 * @private
2250 *
2251 * @param $st1 string
2252 * @param $st2 string
2253 *
2254 * @return int
2255 */
2256 function getCommon( $st1, $st2 ) {
2257 $fl = strlen( $st1 );
2258 $shorter = strlen( $st2 );
2259 if ( $fl < $shorter ) {
2260 $shorter = $fl;
2261 }
2262
2263 for ( $i = 0; $i < $shorter; ++$i ) {
2264 if ( $st1[$i] != $st2[$i] ) {
2265 break;
2266 }
2267 }
2268 return $i;
2269 }
2270
2271 /**
2272 * These next three functions open, continue, and close the list
2273 * element appropriate to the prefix character passed into them.
2274 * @private
2275 *
2276 * @param $char string
2277 *
2278 * @return string
2279 */
2280 function openList( $char ) {
2281 $result = $this->closeParagraph();
2282
2283 if ( '*' === $char ) {
2284 $result .= "<ul>\n<li>";
2285 } elseif ( '#' === $char ) {
2286 $result .= "<ol>\n<li>";
2287 } elseif ( ':' === $char ) {
2288 $result .= "<dl>\n<dd>";
2289 } elseif ( ';' === $char ) {
2290 $result .= "<dl>\n<dt>";
2291 $this->mDTopen = true;
2292 } else {
2293 $result = '<!-- ERR 1 -->';
2294 }
2295
2296 return $result;
2297 }
2298
2299 /**
2300 * TODO: document
2301 * @param $char String
2302 * @private
2303 *
2304 * @return string
2305 */
2306 function nextItem( $char ) {
2307 if ( '*' === $char || '#' === $char ) {
2308 return "</li>\n<li>";
2309 } elseif ( ':' === $char || ';' === $char ) {
2310 $close = "</dd>\n";
2311 if ( $this->mDTopen ) {
2312 $close = "</dt>\n";
2313 }
2314 if ( ';' === $char ) {
2315 $this->mDTopen = true;
2316 return $close . '<dt>';
2317 } else {
2318 $this->mDTopen = false;
2319 return $close . '<dd>';
2320 }
2321 }
2322 return '<!-- ERR 2 -->';
2323 }
2324
2325 /**
2326 * TODO: document
2327 * @param $char String
2328 * @private
2329 *
2330 * @return string
2331 */
2332 function closeList( $char ) {
2333 if ( '*' === $char ) {
2334 $text = "</li>\n</ul>";
2335 } elseif ( '#' === $char ) {
2336 $text = "</li>\n</ol>";
2337 } elseif ( ':' === $char ) {
2338 if ( $this->mDTopen ) {
2339 $this->mDTopen = false;
2340 $text = "</dt>\n</dl>";
2341 } else {
2342 $text = "</dd>\n</dl>";
2343 }
2344 } else {
2345 return '<!-- ERR 3 -->';
2346 }
2347 return $text . "\n";
2348 }
2349 /**#@-*/
2350
2351 /**
2352 * Make lists from lines starting with ':', '*', '#', etc. (DBL)
2353 *
2354 * @param $text String
2355 * @param $linestart Boolean: whether or not this is at the start of a line.
2356 * @private
2357 * @return string the lists rendered as HTML
2358 */
2359 function doBlockLevels( $text, $linestart ) {
2360 wfProfileIn( __METHOD__ );
2361
2362 # Parsing through the text line by line. The main thing
2363 # happening here is handling of block-level elements p, pre,
2364 # and making lists from lines starting with * # : etc.
2365 #
2366 $textLines = StringUtils::explode( "\n", $text );
2367
2368 $lastPrefix = $output = '';
2369 $this->mDTopen = $inBlockElem = false;
2370 $prefixLength = 0;
2371 $paragraphStack = false;
2372 $inBlockquote = false;
2373
2374 foreach ( $textLines as $oLine ) {
2375 # Fix up $linestart
2376 if ( !$linestart ) {
2377 $output .= $oLine;
2378 $linestart = true;
2379 continue;
2380 }
2381 # * = ul
2382 # # = ol
2383 # ; = dt
2384 # : = dd
2385
2386 $lastPrefixLength = strlen( $lastPrefix );
2387 $preCloseMatch = preg_match( '/<\\/pre/i', $oLine );
2388 $preOpenMatch = preg_match( '/<pre/i', $oLine );
2389 # If not in a <pre> element, scan for and figure out what prefixes are there.
2390 if ( !$this->mInPre ) {
2391 # Multiple prefixes may abut each other for nested lists.
2392 $prefixLength = strspn( $oLine, '*#:;' );
2393 $prefix = substr( $oLine, 0, $prefixLength );
2394
2395 # eh?
2396 # ; and : are both from definition-lists, so they're equivalent
2397 # for the purposes of determining whether or not we need to open/close
2398 # elements.
2399 $prefix2 = str_replace( ';', ':', $prefix );
2400 $t = substr( $oLine, $prefixLength );
2401 $this->mInPre = (bool)$preOpenMatch;
2402 } else {
2403 # Don't interpret any other prefixes in preformatted text
2404 $prefixLength = 0;
2405 $prefix = $prefix2 = '';
2406 $t = $oLine;
2407 }
2408
2409 # List generation
2410 if ( $prefixLength && $lastPrefix === $prefix2 ) {
2411 # Same as the last item, so no need to deal with nesting or opening stuff
2412 $output .= $this->nextItem( substr( $prefix, -1 ) );
2413 $paragraphStack = false;
2414
2415 if ( substr( $prefix, -1 ) === ';' ) {
2416 # The one nasty exception: definition lists work like this:
2417 # ; title : definition text
2418 # So we check for : in the remainder text to split up the
2419 # title and definition, without b0rking links.
2420 $term = $t2 = '';
2421 if ( $this->findColonNoLinks( $t, $term, $t2 ) !== false ) {
2422 $t = $t2;
2423 $output .= $term . $this->nextItem( ':' );
2424 }
2425 }
2426 } elseif ( $prefixLength || $lastPrefixLength ) {
2427 # We need to open or close prefixes, or both.
2428
2429 # Either open or close a level...
2430 $commonPrefixLength = $this->getCommon( $prefix, $lastPrefix );
2431 $paragraphStack = false;
2432
2433 # Close all the prefixes which aren't shared.
2434 while ( $commonPrefixLength < $lastPrefixLength ) {
2435 $output .= $this->closeList( $lastPrefix[$lastPrefixLength - 1] );
2436 --$lastPrefixLength;
2437 }
2438
2439 # Continue the current prefix if appropriate.
2440 if ( $prefixLength <= $commonPrefixLength && $commonPrefixLength > 0 ) {
2441 $output .= $this->nextItem( $prefix[$commonPrefixLength - 1] );
2442 }
2443
2444 # Open prefixes where appropriate.
2445 while ( $prefixLength > $commonPrefixLength ) {
2446 $char = substr( $prefix, $commonPrefixLength, 1 );
2447 $output .= $this->openList( $char );
2448
2449 if ( ';' === $char ) {
2450 # @todo FIXME: This is dupe of code above
2451 if ( $this->findColonNoLinks( $t, $term, $t2 ) !== false ) {
2452 $t = $t2;
2453 $output .= $term . $this->nextItem( ':' );
2454 }
2455 }
2456 ++$commonPrefixLength;
2457 }
2458 $lastPrefix = $prefix2;
2459 }
2460
2461 # If we have no prefixes, go to paragraph mode.
2462 if ( 0 == $prefixLength ) {
2463 wfProfileIn( __METHOD__ . "-paragraph" );
2464 # No prefix (not in list)--go to paragraph mode
2465 # XXX: use a stack for nestable elements like span, table and div
2466 $openmatch = preg_match( '/(?:<table|<h1|<h2|<h3|<h4|<h5|<h6|<pre|<tr|<p|<ul|<ol|<dl|<li|<\\/tr|<\\/td|<\\/th)/iS', $t );
2467 $closematch = preg_match(
2468 '/(?:<\\/table|<\\/h1|<\\/h2|<\\/h3|<\\/h4|<\\/h5|<\\/h6|' .
2469 '<td|<th|<\\/?blockquote|<\\/?div|<hr|<\\/pre|<\\/p|<\\/mw:|' . $this->mUniqPrefix . '-pre|<\\/li|<\\/ul|<\\/ol|<\\/dl|<\\/?center)/iS', $t );
2470 if ( $openmatch or $closematch ) {
2471 $paragraphStack = false;
2472 # TODO bug 5718: paragraph closed
2473 $output .= $this->closeParagraph();
2474 if ( $preOpenMatch and !$preCloseMatch ) {
2475 $this->mInPre = true;
2476 }
2477 $bqOffset = 0;
2478 while ( preg_match( '/<(\\/?)blockquote[\s>]/i', $t, $bqMatch, PREG_OFFSET_CAPTURE, $bqOffset ) ) {
2479 $inBlockquote = !$bqMatch[1][0]; // is this a close tag?
2480 $bqOffset = $bqMatch[0][1] + strlen( $bqMatch[0][0] );
2481 }
2482 $inBlockElem = !$closematch;
2483 } elseif ( !$inBlockElem && !$this->mInPre ) {
2484 if ( ' ' == substr( $t, 0, 1 ) and ( $this->mLastSection === 'pre' || trim( $t ) != '' ) and !$inBlockquote ) {
2485 # pre
2486 if ( $this->mLastSection !== 'pre' ) {
2487 $paragraphStack = false;
2488 $output .= $this->closeParagraph() . '<pre>';
2489 $this->mLastSection = 'pre';
2490 }
2491 $t = substr( $t, 1 );
2492 } else {
2493 # paragraph
2494 if ( trim( $t ) === '' ) {
2495 if ( $paragraphStack ) {
2496 $output .= $paragraphStack . '<br />';
2497 $paragraphStack = false;
2498 $this->mLastSection = 'p';
2499 } else {
2500 if ( $this->mLastSection !== 'p' ) {
2501 $output .= $this->closeParagraph();
2502 $this->mLastSection = '';
2503 $paragraphStack = '<p>';
2504 } else {
2505 $paragraphStack = '</p><p>';
2506 }
2507 }
2508 } else {
2509 if ( $paragraphStack ) {
2510 $output .= $paragraphStack;
2511 $paragraphStack = false;
2512 $this->mLastSection = 'p';
2513 } elseif ( $this->mLastSection !== 'p' ) {
2514 $output .= $this->closeParagraph() . '<p>';
2515 $this->mLastSection = 'p';
2516 }
2517 }
2518 }
2519 }
2520 wfProfileOut( __METHOD__ . "-paragraph" );
2521 }
2522 # somewhere above we forget to get out of pre block (bug 785)
2523 if ( $preCloseMatch && $this->mInPre ) {
2524 $this->mInPre = false;
2525 }
2526 if ( $paragraphStack === false ) {
2527 $output .= $t . "\n";
2528 }
2529 }
2530 while ( $prefixLength ) {
2531 $output .= $this->closeList( $prefix2[$prefixLength - 1] );
2532 --$prefixLength;
2533 }
2534 if ( $this->mLastSection != '' ) {
2535 $output .= '</' . $this->mLastSection . '>';
2536 $this->mLastSection = '';
2537 }
2538
2539 wfProfileOut( __METHOD__ );
2540 return $output;
2541 }
2542
2543 /**
2544 * Split up a string on ':', ignoring any occurrences inside tags
2545 * to prevent illegal overlapping.
2546 *
2547 * @param string $str the string to split
2548 * @param &$before String set to everything before the ':'
2549 * @param &$after String set to everything after the ':'
2550 * @throws MWException
2551 * @return String the position of the ':', or false if none found
2552 */
2553 function findColonNoLinks( $str, &$before, &$after ) {
2554 wfProfileIn( __METHOD__ );
2555
2556 $pos = strpos( $str, ':' );
2557 if ( $pos === false ) {
2558 # Nothing to find!
2559 wfProfileOut( __METHOD__ );
2560 return false;
2561 }
2562
2563 $lt = strpos( $str, '<' );
2564 if ( $lt === false || $lt > $pos ) {
2565 # Easy; no tag nesting to worry about
2566 $before = substr( $str, 0, $pos );
2567 $after = substr( $str, $pos + 1 );
2568 wfProfileOut( __METHOD__ );
2569 return $pos;
2570 }
2571
2572 # Ugly state machine to walk through avoiding tags.
2573 $state = self::COLON_STATE_TEXT;
2574 $stack = 0;
2575 $len = strlen( $str );
2576 for ( $i = 0; $i < $len; $i++ ) {
2577 $c = $str[$i];
2578
2579 switch ( $state ) {
2580 # (Using the number is a performance hack for common cases)
2581 case 0: # self::COLON_STATE_TEXT:
2582 switch ( $c ) {
2583 case "<":
2584 # Could be either a <start> tag or an </end> tag
2585 $state = self::COLON_STATE_TAGSTART;
2586 break;
2587 case ":":
2588 if ( $stack == 0 ) {
2589 # We found it!
2590 $before = substr( $str, 0, $i );
2591 $after = substr( $str, $i + 1 );
2592 wfProfileOut( __METHOD__ );
2593 return $i;
2594 }
2595 # Embedded in a tag; don't break it.
2596 break;
2597 default:
2598 # Skip ahead looking for something interesting
2599 $colon = strpos( $str, ':', $i );
2600 if ( $colon === false ) {
2601 # Nothing else interesting
2602 wfProfileOut( __METHOD__ );
2603 return false;
2604 }
2605 $lt = strpos( $str, '<', $i );
2606 if ( $stack === 0 ) {
2607 if ( $lt === false || $colon < $lt ) {
2608 # We found it!
2609 $before = substr( $str, 0, $colon );
2610 $after = substr( $str, $colon + 1 );
2611 wfProfileOut( __METHOD__ );
2612 return $i;
2613 }
2614 }
2615 if ( $lt === false ) {
2616 # Nothing else interesting to find; abort!
2617 # We're nested, but there's no close tags left. Abort!
2618 break 2;
2619 }
2620 # Skip ahead to next tag start
2621 $i = $lt;
2622 $state = self::COLON_STATE_TAGSTART;
2623 }
2624 break;
2625 case 1: # self::COLON_STATE_TAG:
2626 # In a <tag>
2627 switch ( $c ) {
2628 case ">":
2629 $stack++;
2630 $state = self::COLON_STATE_TEXT;
2631 break;
2632 case "/":
2633 # Slash may be followed by >?
2634 $state = self::COLON_STATE_TAGSLASH;
2635 break;
2636 default:
2637 # ignore
2638 }
2639 break;
2640 case 2: # self::COLON_STATE_TAGSTART:
2641 switch ( $c ) {
2642 case "/":
2643 $state = self::COLON_STATE_CLOSETAG;
2644 break;
2645 case "!":
2646 $state = self::COLON_STATE_COMMENT;
2647 break;
2648 case ">":
2649 # Illegal early close? This shouldn't happen D:
2650 $state = self::COLON_STATE_TEXT;
2651 break;
2652 default:
2653 $state = self::COLON_STATE_TAG;
2654 }
2655 break;
2656 case 3: # self::COLON_STATE_CLOSETAG:
2657 # In a </tag>
2658 if ( $c === ">" ) {
2659 $stack--;
2660 if ( $stack < 0 ) {
2661 wfDebug( __METHOD__ . ": Invalid input; too many close tags\n" );
2662 wfProfileOut( __METHOD__ );
2663 return false;
2664 }
2665 $state = self::COLON_STATE_TEXT;
2666 }
2667 break;
2668 case self::COLON_STATE_TAGSLASH:
2669 if ( $c === ">" ) {
2670 # Yes, a self-closed tag <blah/>
2671 $state = self::COLON_STATE_TEXT;
2672 } else {
2673 # Probably we're jumping the gun, and this is an attribute
2674 $state = self::COLON_STATE_TAG;
2675 }
2676 break;
2677 case 5: # self::COLON_STATE_COMMENT:
2678 if ( $c === "-" ) {
2679 $state = self::COLON_STATE_COMMENTDASH;
2680 }
2681 break;
2682 case self::COLON_STATE_COMMENTDASH:
2683 if ( $c === "-" ) {
2684 $state = self::COLON_STATE_COMMENTDASHDASH;
2685 } else {
2686 $state = self::COLON_STATE_COMMENT;
2687 }
2688 break;
2689 case self::COLON_STATE_COMMENTDASHDASH:
2690 if ( $c === ">" ) {
2691 $state = self::COLON_STATE_TEXT;
2692 } else {
2693 $state = self::COLON_STATE_COMMENT;
2694 }
2695 break;
2696 default:
2697 wfProfileOut( __METHOD__ );
2698 throw new MWException( "State machine error in " . __METHOD__ );
2699 }
2700 }
2701 if ( $stack > 0 ) {
2702 wfDebug( __METHOD__ . ": Invalid input; not enough close tags (stack $stack, state $state)\n" );
2703 wfProfileOut( __METHOD__ );
2704 return false;
2705 }
2706 wfProfileOut( __METHOD__ );
2707 return false;
2708 }
2709
2710 /**
2711 * Return value of a magic variable (like PAGENAME)
2712 *
2713 * @private
2714 *
2715 * @param $index integer
2716 * @param bool|\PPFrame $frame
2717 *
2718 * @throws MWException
2719 * @return string
2720 */
2721 function getVariableValue( $index, $frame = false ) {
2722 global $wgContLang, $wgSitename, $wgServer;
2723 global $wgArticlePath, $wgScriptPath, $wgStylePath;
2724
2725 if ( is_null( $this->mTitle ) ) {
2726 // If no title set, bad things are going to happen
2727 // later. Title should always be set since this
2728 // should only be called in the middle of a parse
2729 // operation (but the unit-tests do funky stuff)
2730 throw new MWException( __METHOD__ . ' Should only be '
2731 . ' called while parsing (no title set)' );
2732 }
2733
2734 /**
2735 * Some of these require message or data lookups and can be
2736 * expensive to check many times.
2737 */
2738 if ( wfRunHooks( 'ParserGetVariableValueVarCache', array( &$this, &$this->mVarCache ) ) ) {
2739 if ( isset( $this->mVarCache[$index] ) ) {
2740 return $this->mVarCache[$index];
2741 }
2742 }
2743
2744 $ts = wfTimestamp( TS_UNIX, $this->mOptions->getTimestamp() );
2745 wfRunHooks( 'ParserGetVariableValueTs', array( &$this, &$ts ) );
2746
2747 $pageLang = $this->getFunctionLang();
2748
2749 switch ( $index ) {
2750 case 'currentmonth':
2751 $value = $pageLang->formatNum( MWTimestamp::getInstance( $ts )->format( 'm' ) );
2752 break;
2753 case 'currentmonth1':
2754 $value = $pageLang->formatNum( MWTimestamp::getInstance( $ts )->format( 'n' ) );
2755 break;
2756 case 'currentmonthname':
2757 $value = $pageLang->getMonthName( MWTimestamp::getInstance( $ts )->format( 'n' ) );
2758 break;
2759 case 'currentmonthnamegen':
2760 $value = $pageLang->getMonthNameGen( MWTimestamp::getInstance( $ts )->format( 'n' ) );
2761 break;
2762 case 'currentmonthabbrev':
2763 $value = $pageLang->getMonthAbbreviation( MWTimestamp::getInstance( $ts )->format( 'n' ) );
2764 break;
2765 case 'currentday':
2766 $value = $pageLang->formatNum( MWTimestamp::getInstance( $ts )->format( 'j' ) );
2767 break;
2768 case 'currentday2':
2769 $value = $pageLang->formatNum( MWTimestamp::getInstance( $ts )->format( 'd' ) );
2770 break;
2771 case 'localmonth':
2772 $value = $pageLang->formatNum( MWTimestamp::getLocalInstance( $ts )->format( 'm' ) );
2773 break;
2774 case 'localmonth1':
2775 $value = $pageLang->formatNum( MWTimestamp::getLocalInstance( $ts )->format( 'n' ) );
2776 break;
2777 case 'localmonthname':
2778 $value = $pageLang->getMonthName( MWTimestamp::getLocalInstance( $ts )->format( 'n' ) );
2779 break;
2780 case 'localmonthnamegen':
2781 $value = $pageLang->getMonthNameGen( MWTimestamp::getLocalInstance( $ts )->format( 'n' ) );
2782 break;
2783 case 'localmonthabbrev':
2784 $value = $pageLang->getMonthAbbreviation( MWTimestamp::getLocalInstance( $ts )->format( 'n' ) );
2785 break;
2786 case 'localday':
2787 $value = $pageLang->formatNum( MWTimestamp::getLocalInstance( $ts )->format( 'j' ) );
2788 break;
2789 case 'localday2':
2790 $value = $pageLang->formatNum( MWTimestamp::getLocalInstance( $ts )->format( 'd' ) );
2791 break;
2792 case 'pagename':
2793 $value = wfEscapeWikiText( $this->mTitle->getText() );
2794 break;
2795 case 'pagenamee':
2796 $value = wfEscapeWikiText( $this->mTitle->getPartialURL() );
2797 break;
2798 case 'fullpagename':
2799 $value = wfEscapeWikiText( $this->mTitle->getPrefixedText() );
2800 break;
2801 case 'fullpagenamee':
2802 $value = wfEscapeWikiText( $this->mTitle->getPrefixedURL() );
2803 break;
2804 case 'subpagename':
2805 $value = wfEscapeWikiText( $this->mTitle->getSubpageText() );
2806 break;
2807 case 'subpagenamee':
2808 $value = wfEscapeWikiText( $this->mTitle->getSubpageUrlForm() );
2809 break;
2810 case 'rootpagename':
2811 $value = wfEscapeWikiText( $this->mTitle->getRootText() );
2812 break;
2813 case 'rootpagenamee':
2814 $value = wfEscapeWikiText( wfUrlEncode( str_replace( ' ', '_', $this->mTitle->getRootText() ) ) );
2815 break;
2816 case 'basepagename':
2817 $value = wfEscapeWikiText( $this->mTitle->getBaseText() );
2818 break;
2819 case 'basepagenamee':
2820 $value = wfEscapeWikiText( wfUrlEncode( str_replace( ' ', '_', $this->mTitle->getBaseText() ) ) );
2821 break;
2822 case 'talkpagename':
2823 if ( $this->mTitle->canTalk() ) {
2824 $talkPage = $this->mTitle->getTalkPage();
2825 $value = wfEscapeWikiText( $talkPage->getPrefixedText() );
2826 } else {
2827 $value = '';
2828 }
2829 break;
2830 case 'talkpagenamee':
2831 if ( $this->mTitle->canTalk() ) {
2832 $talkPage = $this->mTitle->getTalkPage();
2833 $value = wfEscapeWikiText( $talkPage->getPrefixedURL() );
2834 } else {
2835 $value = '';
2836 }
2837 break;
2838 case 'subjectpagename':
2839 $subjPage = $this->mTitle->getSubjectPage();
2840 $value = wfEscapeWikiText( $subjPage->getPrefixedText() );
2841 break;
2842 case 'subjectpagenamee':
2843 $subjPage = $this->mTitle->getSubjectPage();
2844 $value = wfEscapeWikiText( $subjPage->getPrefixedURL() );
2845 break;
2846 case 'pageid': // requested in bug 23427
2847 $pageid = $this->getTitle()->getArticleID();
2848 if ( $pageid == 0 ) {
2849 # 0 means the page doesn't exist in the database,
2850 # which means the user is previewing a new page.
2851 # The vary-revision flag must be set, because the magic word
2852 # will have a different value once the page is saved.
2853 $this->mOutput->setFlag( 'vary-revision' );
2854 wfDebug( __METHOD__ . ": {{PAGEID}} used in a new page, setting vary-revision...\n" );
2855 }
2856 $value = $pageid ? $pageid : null;
2857 break;
2858 case 'revisionid':
2859 # Let the edit saving system know we should parse the page
2860 # *after* a revision ID has been assigned.
2861 $this->mOutput->setFlag( 'vary-revision' );
2862 wfDebug( __METHOD__ . ": {{REVISIONID}} used, setting vary-revision...\n" );
2863 $value = $this->mRevisionId;
2864 break;
2865 case 'revisionday':
2866 # Let the edit saving system know we should parse the page
2867 # *after* a revision ID has been assigned. This is for null edits.
2868 $this->mOutput->setFlag( 'vary-revision' );
2869 wfDebug( __METHOD__ . ": {{REVISIONDAY}} used, setting vary-revision...\n" );
2870 $value = intval( substr( $this->getRevisionTimestamp(), 6, 2 ) );
2871 break;
2872 case 'revisionday2':
2873 # Let the edit saving system know we should parse the page
2874 # *after* a revision ID has been assigned. This is for null edits.
2875 $this->mOutput->setFlag( 'vary-revision' );
2876 wfDebug( __METHOD__ . ": {{REVISIONDAY2}} used, setting vary-revision...\n" );
2877 $value = substr( $this->getRevisionTimestamp(), 6, 2 );
2878 break;
2879 case 'revisionmonth':
2880 # Let the edit saving system know we should parse the page
2881 # *after* a revision ID has been assigned. This is for null edits.
2882 $this->mOutput->setFlag( 'vary-revision' );
2883 wfDebug( __METHOD__ . ": {{REVISIONMONTH}} used, setting vary-revision...\n" );
2884 $value = substr( $this->getRevisionTimestamp(), 4, 2 );
2885 break;
2886 case 'revisionmonth1':
2887 # Let the edit saving system know we should parse the page
2888 # *after* a revision ID has been assigned. This is for null edits.
2889 $this->mOutput->setFlag( 'vary-revision' );
2890 wfDebug( __METHOD__ . ": {{REVISIONMONTH1}} used, setting vary-revision...\n" );
2891 $value = intval( substr( $this->getRevisionTimestamp(), 4, 2 ) );
2892 break;
2893 case 'revisionyear':
2894 # Let the edit saving system know we should parse the page
2895 # *after* a revision ID has been assigned. This is for null edits.
2896 $this->mOutput->setFlag( 'vary-revision' );
2897 wfDebug( __METHOD__ . ": {{REVISIONYEAR}} used, setting vary-revision...\n" );
2898 $value = substr( $this->getRevisionTimestamp(), 0, 4 );
2899 break;
2900 case 'revisiontimestamp':
2901 # Let the edit saving system know we should parse the page
2902 # *after* a revision ID has been assigned. This is for null edits.
2903 $this->mOutput->setFlag( 'vary-revision' );
2904 wfDebug( __METHOD__ . ": {{REVISIONTIMESTAMP}} used, setting vary-revision...\n" );
2905 $value = $this->getRevisionTimestamp();
2906 break;
2907 case 'revisionuser':
2908 # Let the edit saving system know we should parse the page
2909 # *after* a revision ID has been assigned. This is for null edits.
2910 $this->mOutput->setFlag( 'vary-revision' );
2911 wfDebug( __METHOD__ . ": {{REVISIONUSER}} used, setting vary-revision...\n" );
2912 $value = $this->getRevisionUser();
2913 break;
2914 case 'revisionsize':
2915 # Let the edit saving system know we should parse the page
2916 # *after* a revision ID has been assigned. This is for null edits.
2917 $this->mOutput->setFlag( 'vary-revision' );
2918 wfDebug( __METHOD__ . ": {{REVISIONSIZE}} used, setting vary-revision...\n" );
2919 $value = $this->getRevisionSize();
2920 break;
2921 case 'namespace':
2922 $value = str_replace( '_', ' ', $wgContLang->getNsText( $this->mTitle->getNamespace() ) );
2923 break;
2924 case 'namespacee':
2925 $value = wfUrlencode( $wgContLang->getNsText( $this->mTitle->getNamespace() ) );
2926 break;
2927 case 'namespacenumber':
2928 $value = $this->mTitle->getNamespace();
2929 break;
2930 case 'talkspace':
2931 $value = $this->mTitle->canTalk() ? str_replace( '_', ' ', $this->mTitle->getTalkNsText() ) : '';
2932 break;
2933 case 'talkspacee':
2934 $value = $this->mTitle->canTalk() ? wfUrlencode( $this->mTitle->getTalkNsText() ) : '';
2935 break;
2936 case 'subjectspace':
2937 $value = str_replace( '_', ' ', $this->mTitle->getSubjectNsText() );
2938 break;
2939 case 'subjectspacee':
2940 $value = ( wfUrlencode( $this->mTitle->getSubjectNsText() ) );
2941 break;
2942 case 'currentdayname':
2943 $value = $pageLang->getWeekdayName( (int)MWTimestamp::getInstance( $ts )->format( 'w' ) + 1 );
2944 break;
2945 case 'currentyear':
2946 $value = $pageLang->formatNum( MWTimestamp::getInstance( $ts )->format( 'Y' ), true );
2947 break;
2948 case 'currenttime':
2949 $value = $pageLang->time( wfTimestamp( TS_MW, $ts ), false, false );
2950 break;
2951 case 'currenthour':
2952 $value = $pageLang->formatNum( MWTimestamp::getInstance( $ts )->format( 'H' ), true );
2953 break;
2954 case 'currentweek':
2955 # @bug 4594 PHP5 has it zero padded, PHP4 does not, cast to
2956 # int to remove the padding
2957 $value = $pageLang->formatNum( (int)MWTimestamp::getInstance( $ts )->format( 'W' ) );
2958 break;
2959 case 'currentdow':
2960 $value = $pageLang->formatNum( MWTimestamp::getInstance( $ts )->format( 'w' ) );
2961 break;
2962 case 'localdayname':
2963 $value = $pageLang->getWeekdayName( (int)MWTimestamp::getLocalInstance( $ts )->format( 'w' ) + 1 );
2964 break;
2965 case 'localyear':
2966 $value = $pageLang->formatNum( MWTimestamp::getLocalInstance( $ts )->format( 'Y' ), true );
2967 break;
2968 case 'localtime':
2969 $value = $pageLang->time( MWTimestamp::getLocalInstance( $ts )->format( 'YmdHis' ), false, false );
2970 break;
2971 case 'localhour':
2972 $value = $pageLang->formatNum( MWTimestamp::getLocalInstance( $ts )->format( 'H' ), true );
2973 break;
2974 case 'localweek':
2975 # @bug 4594 PHP5 has it zero padded, PHP4 does not, cast to
2976 # int to remove the padding
2977 $value = $pageLang->formatNum( (int)MWTimestamp::getLocalInstance( $ts )->format( 'W' ) );
2978 break;
2979 case 'localdow':
2980 $value = $pageLang->formatNum( MWTimestamp::getLocalInstance( $ts )->format( 'w' ) );
2981 break;
2982 case 'numberofarticles':
2983 $value = $pageLang->formatNum( SiteStats::articles() );
2984 break;
2985 case 'numberoffiles':
2986 $value = $pageLang->formatNum( SiteStats::images() );
2987 break;
2988 case 'numberofusers':
2989 $value = $pageLang->formatNum( SiteStats::users() );
2990 break;
2991 case 'numberofactiveusers':
2992 $value = $pageLang->formatNum( SiteStats::activeUsers() );
2993 break;
2994 case 'numberofpages':
2995 $value = $pageLang->formatNum( SiteStats::pages() );
2996 break;
2997 case 'numberofadmins':
2998 $value = $pageLang->formatNum( SiteStats::numberingroup( 'sysop' ) );
2999 break;
3000 case 'numberofedits':
3001 $value = $pageLang->formatNum( SiteStats::edits() );
3002 break;
3003 case 'numberofviews':
3004 global $wgDisableCounters;
3005 $value = !$wgDisableCounters ? $pageLang->formatNum( SiteStats::views() ) : '';
3006 break;
3007 case 'currenttimestamp':
3008 $value = wfTimestamp( TS_MW, $ts );
3009 break;
3010 case 'localtimestamp':
3011 $value = MWTimestamp::getLocalInstance( $ts )->format( 'YmdHis' );
3012 break;
3013 case 'currentversion':
3014 $value = SpecialVersion::getVersion();
3015 break;
3016 case 'articlepath':
3017 return $wgArticlePath;
3018 case 'sitename':
3019 return $wgSitename;
3020 case 'server':
3021 return $wgServer;
3022 case 'servername':
3023 $serverParts = wfParseUrl( $wgServer );
3024 return $serverParts && isset( $serverParts['host'] ) ? $serverParts['host'] : $wgServer;
3025 case 'scriptpath':
3026 return $wgScriptPath;
3027 case 'stylepath':
3028 return $wgStylePath;
3029 case 'directionmark':
3030 return $pageLang->getDirMark();
3031 case 'contentlanguage':
3032 global $wgLanguageCode;
3033 return $wgLanguageCode;
3034 default:
3035 $ret = null;
3036 wfRunHooks( 'ParserGetVariableValueSwitch', array( &$this, &$this->mVarCache, &$index, &$ret, &$frame ) );
3037 return $ret;
3038 }
3039
3040 if ( $index ) {
3041 $this->mVarCache[$index] = $value;
3042 }
3043
3044 return $value;
3045 }
3046
3047 /**
3048 * initialise the magic variables (like CURRENTMONTHNAME) and substitution modifiers
3049 *
3050 * @private
3051 */
3052 function initialiseVariables() {
3053 wfProfileIn( __METHOD__ );
3054 $variableIDs = MagicWord::getVariableIDs();
3055 $substIDs = MagicWord::getSubstIDs();
3056
3057 $this->mVariables = new MagicWordArray( $variableIDs );
3058 $this->mSubstWords = new MagicWordArray( $substIDs );
3059 wfProfileOut( __METHOD__ );
3060 }
3061
3062 /**
3063 * Preprocess some wikitext and return the document tree.
3064 * This is the ghost of replace_variables().
3065 *
3066 * @param string $text The text to parse
3067 * @param $flags Integer: bitwise combination of:
3068 * self::PTD_FOR_INCLUSION Handle "<noinclude>" and "<includeonly>" as if the text is being
3069 * included. Default is to assume a direct page view.
3070 *
3071 * The generated DOM tree must depend only on the input text and the flags.
3072 * The DOM tree must be the same in OT_HTML and OT_WIKI mode, to avoid a regression of bug 4899.
3073 *
3074 * Any flag added to the $flags parameter here, or any other parameter liable to cause a
3075 * change in the DOM tree for a given text, must be passed through the section identifier
3076 * in the section edit link and thus back to extractSections().
3077 *
3078 * The output of this function is currently only cached in process memory, but a persistent
3079 * cache may be implemented at a later date which takes further advantage of these strict
3080 * dependency requirements.
3081 *
3082 * @return PPNode
3083 */
3084 function preprocessToDom( $text, $flags = 0 ) {
3085 $dom = $this->getPreprocessor()->preprocessToObj( $text, $flags );
3086 return $dom;
3087 }
3088
3089 /**
3090 * Return a three-element array: leading whitespace, string contents, trailing whitespace
3091 *
3092 * @param $s string
3093 *
3094 * @return array
3095 */
3096 public static function splitWhitespace( $s ) {
3097 $ltrimmed = ltrim( $s );
3098 $w1 = substr( $s, 0, strlen( $s ) - strlen( $ltrimmed ) );
3099 $trimmed = rtrim( $ltrimmed );
3100 $diff = strlen( $ltrimmed ) - strlen( $trimmed );
3101 if ( $diff > 0 ) {
3102 $w2 = substr( $ltrimmed, -$diff );
3103 } else {
3104 $w2 = '';
3105 }
3106 return array( $w1, $trimmed, $w2 );
3107 }
3108
3109 /**
3110 * Replace magic variables, templates, and template arguments
3111 * with the appropriate text. Templates are substituted recursively,
3112 * taking care to avoid infinite loops.
3113 *
3114 * Note that the substitution depends on value of $mOutputType:
3115 * self::OT_WIKI: only {{subst:}} templates
3116 * self::OT_PREPROCESS: templates but not extension tags
3117 * self::OT_HTML: all templates and extension tags
3118 *
3119 * @param string $text the text to transform
3120 * @param $frame PPFrame Object describing the arguments passed to the template.
3121 * Arguments may also be provided as an associative array, as was the usual case before MW1.12.
3122 * Providing arguments this way may be useful for extensions wishing to perform variable replacement explicitly.
3123 * @param $argsOnly Boolean only do argument (triple-brace) expansion, not double-brace expansion
3124 * @private
3125 *
3126 * @return string
3127 */
3128 function replaceVariables( $text, $frame = false, $argsOnly = false ) {
3129 # Is there any text? Also, Prevent too big inclusions!
3130 if ( strlen( $text ) < 1 || strlen( $text ) > $this->mOptions->getMaxIncludeSize() ) {
3131 return $text;
3132 }
3133 wfProfileIn( __METHOD__ );
3134
3135 if ( $frame === false ) {
3136 $frame = $this->getPreprocessor()->newFrame();
3137 } elseif ( !( $frame instanceof PPFrame ) ) {
3138 wfDebug( __METHOD__ . " called using plain parameters instead of a PPFrame instance. Creating custom frame.\n" );
3139 $frame = $this->getPreprocessor()->newCustomFrame( $frame );
3140 }
3141
3142 $dom = $this->preprocessToDom( $text );
3143 $flags = $argsOnly ? PPFrame::NO_TEMPLATES : 0;
3144 $text = $frame->expand( $dom, $flags );
3145
3146 wfProfileOut( __METHOD__ );
3147 return $text;
3148 }
3149
3150 /**
3151 * Clean up argument array - refactored in 1.9 so parserfunctions can use it, too.
3152 *
3153 * @param $args array
3154 *
3155 * @return array
3156 */
3157 static function createAssocArgs( $args ) {
3158 $assocArgs = array();
3159 $index = 1;
3160 foreach ( $args as $arg ) {
3161 $eqpos = strpos( $arg, '=' );
3162 if ( $eqpos === false ) {
3163 $assocArgs[$index++] = $arg;
3164 } else {
3165 $name = trim( substr( $arg, 0, $eqpos ) );
3166 $value = trim( substr( $arg, $eqpos + 1 ) );
3167 if ( $value === false ) {
3168 $value = '';
3169 }
3170 if ( $name !== false ) {
3171 $assocArgs[$name] = $value;
3172 }
3173 }
3174 }
3175
3176 return $assocArgs;
3177 }
3178
3179 /**
3180 * Warn the user when a parser limitation is reached
3181 * Will warn at most once the user per limitation type
3182 *
3183 * @param string $limitationType should be one of:
3184 * 'expensive-parserfunction' (corresponding messages:
3185 * 'expensive-parserfunction-warning',
3186 * 'expensive-parserfunction-category')
3187 * 'post-expand-template-argument' (corresponding messages:
3188 * 'post-expand-template-argument-warning',
3189 * 'post-expand-template-argument-category')
3190 * 'post-expand-template-inclusion' (corresponding messages:
3191 * 'post-expand-template-inclusion-warning',
3192 * 'post-expand-template-inclusion-category')
3193 * 'node-count-exceeded' (corresponding messages:
3194 * 'node-count-exceeded-warning',
3195 * 'node-count-exceeded-category')
3196 * 'expansion-depth-exceeded' (corresponding messages:
3197 * 'expansion-depth-exceeded-warning',
3198 * 'expansion-depth-exceeded-category')
3199 * @param int|null $current Current value
3200 * @param int|null $max Maximum allowed, when an explicit limit has been
3201 * exceeded, provide the values (optional)
3202 */
3203 function limitationWarn( $limitationType, $current = '', $max = '' ) {
3204 # does no harm if $current and $max are present but are unnecessary for the message
3205 $warning = wfMessage( "$limitationType-warning" )->numParams( $current, $max )
3206 ->inLanguage( $this->mOptions->getUserLangObj() )->text();
3207 $this->mOutput->addWarning( $warning );
3208 $this->addTrackingCategory( "$limitationType-category" );
3209 }
3210
3211 /**
3212 * Return the text of a template, after recursively
3213 * replacing any variables or templates within the template.
3214 *
3215 * @param array $piece the parts of the template
3216 * $piece['title']: the title, i.e. the part before the |
3217 * $piece['parts']: the parameter array
3218 * $piece['lineStart']: whether the brace was at the start of a line
3219 * @param $frame PPFrame The current frame, contains template arguments
3220 * @throws MWException
3221 * @return String: the text of the template
3222 * @private
3223 */
3224 function braceSubstitution( $piece, $frame ) {
3225 wfProfileIn( __METHOD__ );
3226 wfProfileIn( __METHOD__ . '-setup' );
3227
3228 # Flags
3229 $found = false; # $text has been filled
3230 $nowiki = false; # wiki markup in $text should be escaped
3231 $isHTML = false; # $text is HTML, armour it against wikitext transformation
3232 $forceRawInterwiki = false; # Force interwiki transclusion to be done in raw mode not rendered
3233 $isChildObj = false; # $text is a DOM node needing expansion in a child frame
3234 $isLocalObj = false; # $text is a DOM node needing expansion in the current frame
3235
3236 # Title object, where $text came from
3237 $title = false;
3238
3239 # $part1 is the bit before the first |, and must contain only title characters.
3240 # Various prefixes will be stripped from it later.
3241 $titleWithSpaces = $frame->expand( $piece['title'] );
3242 $part1 = trim( $titleWithSpaces );
3243 $titleText = false;
3244
3245 # Original title text preserved for various purposes
3246 $originalTitle = $part1;
3247
3248 # $args is a list of argument nodes, starting from index 0, not including $part1
3249 # @todo FIXME: If piece['parts'] is null then the call to getLength() below won't work b/c this $args isn't an object
3250 $args = ( null == $piece['parts'] ) ? array() : $piece['parts'];
3251 wfProfileOut( __METHOD__ . '-setup' );
3252
3253 $titleProfileIn = null; // profile templates
3254
3255 # SUBST
3256 wfProfileIn( __METHOD__ . '-modifiers' );
3257 if ( !$found ) {
3258
3259 $substMatch = $this->mSubstWords->matchStartAndRemove( $part1 );
3260
3261 # Possibilities for substMatch: "subst", "safesubst" or FALSE
3262 # Decide whether to expand template or keep wikitext as-is.
3263 if ( $this->ot['wiki'] ) {
3264 if ( $substMatch === false ) {
3265 $literal = true; # literal when in PST with no prefix
3266 } else {
3267 $literal = false; # expand when in PST with subst: or safesubst:
3268 }
3269 } else {
3270 if ( $substMatch == 'subst' ) {
3271 $literal = true; # literal when not in PST with plain subst:
3272 } else {
3273 $literal = false; # expand when not in PST with safesubst: or no prefix
3274 }
3275 }
3276 if ( $literal ) {
3277 $text = $frame->virtualBracketedImplode( '{{', '|', '}}', $titleWithSpaces, $args );
3278 $isLocalObj = true;
3279 $found = true;
3280 }
3281 }
3282
3283 # Variables
3284 if ( !$found && $args->getLength() == 0 ) {
3285 $id = $this->mVariables->matchStartToEnd( $part1 );
3286 if ( $id !== false ) {
3287 $text = $this->getVariableValue( $id, $frame );
3288 if ( MagicWord::getCacheTTL( $id ) > -1 ) {
3289 $this->mOutput->updateCacheExpiry( MagicWord::getCacheTTL( $id ) );
3290 }
3291 $found = true;
3292 }
3293 }
3294
3295 # MSG, MSGNW and RAW
3296 if ( !$found ) {
3297 # Check for MSGNW:
3298 $mwMsgnw = MagicWord::get( 'msgnw' );
3299 if ( $mwMsgnw->matchStartAndRemove( $part1 ) ) {
3300 $nowiki = true;
3301 } else {
3302 # Remove obsolete MSG:
3303 $mwMsg = MagicWord::get( 'msg' );
3304 $mwMsg->matchStartAndRemove( $part1 );
3305 }
3306
3307 # Check for RAW:
3308 $mwRaw = MagicWord::get( 'raw' );
3309 if ( $mwRaw->matchStartAndRemove( $part1 ) ) {
3310 $forceRawInterwiki = true;
3311 }
3312 }
3313 wfProfileOut( __METHOD__ . '-modifiers' );
3314
3315 # Parser functions
3316 if ( !$found ) {
3317 wfProfileIn( __METHOD__ . '-pfunc' );
3318
3319 $colonPos = strpos( $part1, ':' );
3320 if ( $colonPos !== false ) {
3321 $func = substr( $part1, 0, $colonPos );
3322 $funcArgs = array( trim( substr( $part1, $colonPos + 1 ) ) );
3323 for ( $i = 0; $i < $args->getLength(); $i++ ) {
3324 $funcArgs[] = $args->item( $i );
3325 }
3326 try {
3327 $result = $this->callParserFunction( $frame, $func, $funcArgs );
3328 } catch ( Exception $ex ) {
3329 wfProfileOut( __METHOD__ . '-pfunc' );
3330 wfProfileOut( __METHOD__ );
3331 throw $ex;
3332 }
3333
3334 # The interface for parser functions allows for extracting
3335 # flags into the local scope. Extract any forwarded flags
3336 # here.
3337 extract( $result );
3338 }
3339 wfProfileOut( __METHOD__ . '-pfunc' );
3340 }
3341
3342 # Finish mangling title and then check for loops.
3343 # Set $title to a Title object and $titleText to the PDBK
3344 if ( !$found ) {
3345 $ns = NS_TEMPLATE;
3346 # Split the title into page and subpage
3347 $subpage = '';
3348 $relative = $this->maybeDoSubpageLink( $part1, $subpage );
3349 if ( $part1 !== $relative ) {
3350 $part1 = $relative;
3351 $ns = $this->mTitle->getNamespace();
3352 }
3353 $title = Title::newFromText( $part1, $ns );
3354 if ( $title ) {
3355 $titleText = $title->getPrefixedText();
3356 # Check for language variants if the template is not found
3357 if ( $this->getConverterLanguage()->hasVariants() && $title->getArticleID() == 0 ) {
3358 $this->getConverterLanguage()->findVariantLink( $part1, $title, true );
3359 }
3360 # Do recursion depth check
3361 $limit = $this->mOptions->getMaxTemplateDepth();
3362 if ( $frame->depth >= $limit ) {
3363 $found = true;
3364 $text = '<span class="error">'
3365 . wfMessage( 'parser-template-recursion-depth-warning' )
3366 ->numParams( $limit )->inContentLanguage()->text()
3367 . '</span>';
3368 }
3369 }
3370 }
3371
3372 # Load from database
3373 if ( !$found && $title ) {
3374 if ( !Profiler::instance()->isPersistent() ) {
3375 # Too many unique items can kill profiling DBs/collectors
3376 $titleProfileIn = __METHOD__ . "-title-" . $title->getPrefixedDBkey();
3377 wfProfileIn( $titleProfileIn ); // template in
3378 }
3379 wfProfileIn( __METHOD__ . '-loadtpl' );
3380 if ( !$title->isExternal() ) {
3381 if ( $title->isSpecialPage()
3382 && $this->mOptions->getAllowSpecialInclusion()
3383 && $this->ot['html']
3384 ) {
3385 // Pass the template arguments as URL parameters.
3386 // "uselang" will have no effect since the Language object
3387 // is forced to the one defined in ParserOptions.
3388 $pageArgs = array();
3389 for ( $i = 0; $i < $args->getLength(); $i++ ) {
3390 $bits = $args->item( $i )->splitArg();
3391 if ( strval( $bits['index'] ) === '' ) {
3392 $name = trim( $frame->expand( $bits['name'], PPFrame::STRIP_COMMENTS ) );
3393 $value = trim( $frame->expand( $bits['value'] ) );
3394 $pageArgs[$name] = $value;
3395 }
3396 }
3397
3398 // Create a new context to execute the special page
3399 $context = new RequestContext;
3400 $context->setTitle( $title );
3401 $context->setRequest( new FauxRequest( $pageArgs ) );
3402 $context->setUser( $this->getUser() );
3403 $context->setLanguage( $this->mOptions->getUserLangObj() );
3404 $ret = SpecialPageFactory::capturePath( $title, $context );
3405 if ( $ret ) {
3406 $text = $context->getOutput()->getHTML();
3407 $this->mOutput->addOutputPageMetadata( $context->getOutput() );
3408 $found = true;
3409 $isHTML = true;
3410 $this->disableCache();
3411 }
3412 } elseif ( MWNamespace::isNonincludable( $title->getNamespace() ) ) {
3413 $found = false; # access denied
3414 wfDebug( __METHOD__ . ": template inclusion denied for " . $title->getPrefixedDBkey() );
3415 } else {
3416 list( $text, $title ) = $this->getTemplateDom( $title );
3417 if ( $text !== false ) {
3418 $found = true;
3419 $isChildObj = true;
3420 }
3421 }
3422
3423 # If the title is valid but undisplayable, make a link to it
3424 if ( !$found && ( $this->ot['html'] || $this->ot['pre'] ) ) {
3425 $text = "[[:$titleText]]";
3426 $found = true;
3427 }
3428 } elseif ( $title->isTrans() ) {
3429 # Interwiki transclusion
3430 if ( $this->ot['html'] && !$forceRawInterwiki ) {
3431 $text = $this->interwikiTransclude( $title, 'render' );
3432 $isHTML = true;
3433 } else {
3434 $text = $this->interwikiTransclude( $title, 'raw' );
3435 # Preprocess it like a template
3436 $text = $this->preprocessToDom( $text, self::PTD_FOR_INCLUSION );
3437 $isChildObj = true;
3438 }
3439 $found = true;
3440 }
3441
3442 # Do infinite loop check
3443 # This has to be done after redirect resolution to avoid infinite loops via redirects
3444 if ( !$frame->loopCheck( $title ) ) {
3445 $found = true;
3446 $text = '<span class="error">'
3447 . wfMessage( 'parser-template-loop-warning', $titleText )->inContentLanguage()->text()
3448 . '</span>';
3449 wfDebug( __METHOD__ . ": template loop broken at '$titleText'\n" );
3450 }
3451 wfProfileOut( __METHOD__ . '-loadtpl' );
3452 }
3453
3454 # If we haven't found text to substitute by now, we're done
3455 # Recover the source wikitext and return it
3456 if ( !$found ) {
3457 $text = $frame->virtualBracketedImplode( '{{', '|', '}}', $titleWithSpaces, $args );
3458 if ( $titleProfileIn ) {
3459 wfProfileOut( $titleProfileIn ); // template out
3460 }
3461 wfProfileOut( __METHOD__ );
3462 return array( 'object' => $text );
3463 }
3464
3465 # Expand DOM-style return values in a child frame
3466 if ( $isChildObj ) {
3467 # Clean up argument array
3468 $newFrame = $frame->newChild( $args, $title );
3469
3470 if ( $nowiki ) {
3471 $text = $newFrame->expand( $text, PPFrame::RECOVER_ORIG );
3472 } elseif ( $titleText !== false && $newFrame->isEmpty() ) {
3473 # Expansion is eligible for the empty-frame cache
3474 if ( isset( $this->mTplExpandCache[$titleText] ) ) {
3475 $text = $this->mTplExpandCache[$titleText];
3476 } else {
3477 $text = $newFrame->expand( $text );
3478 $this->mTplExpandCache[$titleText] = $text;
3479 }
3480 } else {
3481 # Uncached expansion
3482 $text = $newFrame->expand( $text );
3483 }
3484 }
3485 if ( $isLocalObj && $nowiki ) {
3486 $text = $frame->expand( $text, PPFrame::RECOVER_ORIG );
3487 $isLocalObj = false;
3488 }
3489
3490 if ( $titleProfileIn ) {
3491 wfProfileOut( $titleProfileIn ); // template out
3492 }
3493
3494 # Replace raw HTML by a placeholder
3495 if ( $isHTML ) {
3496 $text = $this->insertStripItem( $text );
3497 } elseif ( $nowiki && ( $this->ot['html'] || $this->ot['pre'] ) ) {
3498 # Escape nowiki-style return values
3499 $text = wfEscapeWikiText( $text );
3500 } elseif ( is_string( $text )
3501 && !$piece['lineStart']
3502 && preg_match( '/^(?:{\\||:|;|#|\*)/', $text )
3503 ) {
3504 # Bug 529: if the template begins with a table or block-level
3505 # element, it should be treated as beginning a new line.
3506 # This behavior is somewhat controversial.
3507 $text = "\n" . $text;
3508 }
3509
3510 if ( is_string( $text ) && !$this->incrementIncludeSize( 'post-expand', strlen( $text ) ) ) {
3511 # Error, oversize inclusion
3512 if ( $titleText !== false ) {
3513 # Make a working, properly escaped link if possible (bug 23588)
3514 $text = "[[:$titleText]]";
3515 } else {
3516 # This will probably not be a working link, but at least it may
3517 # provide some hint of where the problem is
3518 preg_replace( '/^:/', '', $originalTitle );
3519 $text = "[[:$originalTitle]]";
3520 }
3521 $text .= $this->insertStripItem( '<!-- WARNING: template omitted, post-expand include size too large -->' );
3522 $this->limitationWarn( 'post-expand-template-inclusion' );
3523 }
3524
3525 if ( $isLocalObj ) {
3526 $ret = array( 'object' => $text );
3527 } else {
3528 $ret = array( 'text' => $text );
3529 }
3530
3531 wfProfileOut( __METHOD__ );
3532 return $ret;
3533 }
3534
3535 /**
3536 * Call a parser function and return an array with text and flags.
3537 *
3538 * The returned array will always contain a boolean 'found', indicating
3539 * whether the parser function was found or not. It may also contain the
3540 * following:
3541 * text: string|object, resulting wikitext or PP DOM object
3542 * isHTML: bool, $text is HTML, armour it against wikitext transformation
3543 * isChildObj: bool, $text is a DOM node needing expansion in a child frame
3544 * isLocalObj: bool, $text is a DOM node needing expansion in the current frame
3545 * nowiki: bool, wiki markup in $text should be escaped
3546 *
3547 * @since 1.21
3548 * @param $frame PPFrame The current frame, contains template arguments
3549 * @param $function string Function name
3550 * @param $args array Arguments to the function
3551 * @return array
3552 */
3553 public function callParserFunction( $frame, $function, array $args = array() ) {
3554 global $wgContLang;
3555
3556 wfProfileIn( __METHOD__ );
3557
3558 # Case sensitive functions
3559 if ( isset( $this->mFunctionSynonyms[1][$function] ) ) {
3560 $function = $this->mFunctionSynonyms[1][$function];
3561 } else {
3562 # Case insensitive functions
3563 $function = $wgContLang->lc( $function );
3564 if ( isset( $this->mFunctionSynonyms[0][$function] ) ) {
3565 $function = $this->mFunctionSynonyms[0][$function];
3566 } else {
3567 wfProfileOut( __METHOD__ );
3568 return array( 'found' => false );
3569 }
3570 }
3571
3572 wfProfileIn( __METHOD__ . '-pfunc-' . $function );
3573 list( $callback, $flags ) = $this->mFunctionHooks[$function];
3574
3575 # Workaround for PHP bug 35229 and similar
3576 if ( !is_callable( $callback ) ) {
3577 wfProfileOut( __METHOD__ . '-pfunc-' . $function );
3578 wfProfileOut( __METHOD__ );
3579 throw new MWException( "Tag hook for $function is not callable\n" );
3580 }
3581
3582 $allArgs = array( &$this );
3583 if ( $flags & SFH_OBJECT_ARGS ) {
3584 # Convert arguments to PPNodes and collect for appending to $allArgs
3585 $funcArgs = array();
3586 foreach ( $args as $k => $v ) {
3587 if ( $v instanceof PPNode || $k === 0 ) {
3588 $funcArgs[] = $v;
3589 } else {
3590 $funcArgs[] = $this->mPreprocessor->newPartNodeArray( array( $k => $v ) )->item( 0 );
3591 }
3592 }
3593
3594 # Add a frame parameter, and pass the arguments as an array
3595 $allArgs[] = $frame;
3596 $allArgs[] = $funcArgs;
3597 } else {
3598 # Convert arguments to plain text and append to $allArgs
3599 foreach ( $args as $k => $v ) {
3600 if ( $v instanceof PPNode ) {
3601 $allArgs[] = trim( $frame->expand( $v ) );
3602 } elseif ( is_int( $k ) && $k >= 0 ) {
3603 $allArgs[] = trim( $v );
3604 } else {
3605 $allArgs[] = trim( "$k=$v" );
3606 }
3607 }
3608 }
3609
3610 $result = call_user_func_array( $callback, $allArgs );
3611
3612 # The interface for function hooks allows them to return a wikitext
3613 # string or an array containing the string and any flags. This mungs
3614 # things around to match what this method should return.
3615 if ( !is_array( $result ) ) {
3616 $result = array(
3617 'found' => true,
3618 'text' => $result,
3619 );
3620 } else {
3621 if ( isset( $result[0] ) && !isset( $result['text'] ) ) {
3622 $result['text'] = $result[0];
3623 }
3624 unset( $result[0] );
3625 $result += array(
3626 'found' => true,
3627 );
3628 }
3629
3630 $noparse = true;
3631 $preprocessFlags = 0;
3632 if ( isset( $result['noparse'] ) ) {
3633 $noparse = $result['noparse'];
3634 }
3635 if ( isset( $result['preprocessFlags'] ) ) {
3636 $preprocessFlags = $result['preprocessFlags'];
3637 }
3638
3639 if ( !$noparse ) {
3640 $result['text'] = $this->preprocessToDom( $result['text'], $preprocessFlags );
3641 $result['isChildObj'] = true;
3642 }
3643 wfProfileOut( __METHOD__ . '-pfunc-' . $function );
3644 wfProfileOut( __METHOD__ );
3645
3646 return $result;
3647 }
3648
3649 /**
3650 * Get the semi-parsed DOM representation of a template with a given title,
3651 * and its redirect destination title. Cached.
3652 *
3653 * @param $title Title
3654 *
3655 * @return array
3656 */
3657 function getTemplateDom( $title ) {
3658 $cacheTitle = $title;
3659 $titleText = $title->getPrefixedDBkey();
3660
3661 if ( isset( $this->mTplRedirCache[$titleText] ) ) {
3662 list( $ns, $dbk ) = $this->mTplRedirCache[$titleText];
3663 $title = Title::makeTitle( $ns, $dbk );
3664 $titleText = $title->getPrefixedDBkey();
3665 }
3666 if ( isset( $this->mTplDomCache[$titleText] ) ) {
3667 return array( $this->mTplDomCache[$titleText], $title );
3668 }
3669
3670 # Cache miss, go to the database
3671 list( $text, $title ) = $this->fetchTemplateAndTitle( $title );
3672
3673 if ( $text === false ) {
3674 $this->mTplDomCache[$titleText] = false;
3675 return array( false, $title );
3676 }
3677
3678 $dom = $this->preprocessToDom( $text, self::PTD_FOR_INCLUSION );
3679 $this->mTplDomCache[$titleText] = $dom;
3680
3681 if ( !$title->equals( $cacheTitle ) ) {
3682 $this->mTplRedirCache[$cacheTitle->getPrefixedDBkey()] =
3683 array( $title->getNamespace(), $cdb = $title->getDBkey() );
3684 }
3685
3686 return array( $dom, $title );
3687 }
3688
3689 /**
3690 * Fetch the unparsed text of a template and register a reference to it.
3691 * @param Title $title
3692 * @return Array ( string or false, Title )
3693 */
3694 function fetchTemplateAndTitle( $title ) {
3695 $templateCb = $this->mOptions->getTemplateCallback(); # Defaults to Parser::statelessFetchTemplate()
3696 $stuff = call_user_func( $templateCb, $title, $this );
3697 $text = $stuff['text'];
3698 $finalTitle = isset( $stuff['finalTitle'] ) ? $stuff['finalTitle'] : $title;
3699 if ( isset( $stuff['deps'] ) ) {
3700 foreach ( $stuff['deps'] as $dep ) {
3701 $this->mOutput->addTemplate( $dep['title'], $dep['page_id'], $dep['rev_id'] );
3702 if ( $dep['title']->equals( $this->getTitle() ) ) {
3703 // If we transclude ourselves, the final result
3704 // will change based on the new version of the page
3705 $this->mOutput->setFlag( 'vary-revision' );
3706 }
3707 }
3708 }
3709 return array( $text, $finalTitle );
3710 }
3711
3712 /**
3713 * Fetch the unparsed text of a template and register a reference to it.
3714 * @param Title $title
3715 * @return mixed string or false
3716 */
3717 function fetchTemplate( $title ) {
3718 $rv = $this->fetchTemplateAndTitle( $title );
3719 return $rv[0];
3720 }
3721
3722 /**
3723 * Static function to get a template
3724 * Can be overridden via ParserOptions::setTemplateCallback().
3725 *
3726 * @param $title Title
3727 * @param $parser Parser
3728 *
3729 * @return array
3730 */
3731 static function statelessFetchTemplate( $title, $parser = false ) {
3732 $text = $skip = false;
3733 $finalTitle = $title;
3734 $deps = array();
3735
3736 # Loop to fetch the article, with up to 1 redirect
3737 for ( $i = 0; $i < 2 && is_object( $title ); $i++ ) {
3738 # Give extensions a chance to select the revision instead
3739 $id = false; # Assume current
3740 wfRunHooks( 'BeforeParserFetchTemplateAndtitle',
3741 array( $parser, $title, &$skip, &$id ) );
3742
3743 if ( $skip ) {
3744 $text = false;
3745 $deps[] = array(
3746 'title' => $title,
3747 'page_id' => $title->getArticleID(),
3748 'rev_id' => null
3749 );
3750 break;
3751 }
3752 # Get the revision
3753 $rev = $id
3754 ? Revision::newFromId( $id )
3755 : Revision::newFromTitle( $title, false, Revision::READ_NORMAL );
3756 $rev_id = $rev ? $rev->getId() : 0;
3757 # If there is no current revision, there is no page
3758 if ( $id === false && !$rev ) {
3759 $linkCache = LinkCache::singleton();
3760 $linkCache->addBadLinkObj( $title );
3761 }
3762
3763 $deps[] = array(
3764 'title' => $title,
3765 'page_id' => $title->getArticleID(),
3766 'rev_id' => $rev_id );
3767 if ( $rev && !$title->equals( $rev->getTitle() ) ) {
3768 # We fetched a rev from a different title; register it too...
3769 $deps[] = array(
3770 'title' => $rev->getTitle(),
3771 'page_id' => $rev->getPage(),
3772 'rev_id' => $rev_id );
3773 }
3774
3775 if ( $rev ) {
3776 $content = $rev->getContent();
3777 $text = $content ? $content->getWikitextForTransclusion() : null;
3778
3779 if ( $text === false || $text === null ) {
3780 $text = false;
3781 break;
3782 }
3783 } elseif ( $title->getNamespace() == NS_MEDIAWIKI ) {
3784 global $wgContLang;
3785 $message = wfMessage( $wgContLang->lcfirst( $title->getText() ) )->inContentLanguage();
3786 if ( !$message->exists() ) {
3787 $text = false;
3788 break;
3789 }
3790 $content = $message->content();
3791 $text = $message->plain();
3792 } else {
3793 break;
3794 }
3795 if ( !$content ) {
3796 break;
3797 }
3798 # Redirect?
3799 $finalTitle = $title;
3800 $title = $content->getRedirectTarget();
3801 }
3802 return array(
3803 'text' => $text,
3804 'finalTitle' => $finalTitle,
3805 'deps' => $deps );
3806 }
3807
3808 /**
3809 * Fetch a file and its title and register a reference to it.
3810 * If 'broken' is a key in $options then the file will appear as a broken thumbnail.
3811 * @param Title $title
3812 * @param array $options Array of options to RepoGroup::findFile
3813 * @return File|bool
3814 */
3815 function fetchFile( $title, $options = array() ) {
3816 $res = $this->fetchFileAndTitle( $title, $options );
3817 return $res[0];
3818 }
3819
3820 /**
3821 * Fetch a file and its title and register a reference to it.
3822 * If 'broken' is a key in $options then the file will appear as a broken thumbnail.
3823 * @param Title $title
3824 * @param array $options Array of options to RepoGroup::findFile
3825 * @return Array ( File or false, Title of file )
3826 */
3827 function fetchFileAndTitle( $title, $options = array() ) {
3828 $file = $this->fetchFileNoRegister( $title, $options );
3829
3830 $time = $file ? $file->getTimestamp() : false;
3831 $sha1 = $file ? $file->getSha1() : false;
3832 # Register the file as a dependency...
3833 $this->mOutput->addImage( $title->getDBkey(), $time, $sha1 );
3834 if ( $file && !$title->equals( $file->getTitle() ) ) {
3835 # Update fetched file title
3836 $title = $file->getTitle();
3837 if ( is_null( $file->getRedirectedTitle() ) ) {
3838 # This file was not a redirect, but the title does not match.
3839 # Register under the new name because otherwise the link will
3840 # get lost.
3841 $this->mOutput->addImage( $title->getDBkey(), $time, $sha1 );
3842 }
3843 }
3844 return array( $file, $title );
3845 }
3846
3847 /**
3848 * Helper function for fetchFileAndTitle.
3849 *
3850 * Also useful if you need to fetch a file but not use it yet,
3851 * for example to get the file's handler.
3852 *
3853 * @param Title $title
3854 * @param array $options Array of options to RepoGroup::findFile
3855 * @return File or false
3856 */
3857 protected function fetchFileNoRegister( $title, $options = array() ) {
3858 if ( isset( $options['broken'] ) ) {
3859 $file = false; // broken thumbnail forced by hook
3860 } elseif ( isset( $options['sha1'] ) ) { // get by (sha1,timestamp)
3861 $file = RepoGroup::singleton()->findFileFromKey( $options['sha1'], $options );
3862 } else { // get by (name,timestamp)
3863 $file = wfFindFile( $title, $options );
3864 }
3865 return $file;
3866 }
3867
3868 /**
3869 * Transclude an interwiki link.
3870 *
3871 * @param $title Title
3872 * @param $action
3873 *
3874 * @return string
3875 */
3876 function interwikiTransclude( $title, $action ) {
3877 global $wgEnableScaryTranscluding;
3878
3879 if ( !$wgEnableScaryTranscluding ) {
3880 return wfMessage( 'scarytranscludedisabled' )->inContentLanguage()->text();
3881 }
3882
3883 $url = $title->getFullURL( array( 'action' => $action ) );
3884
3885 if ( strlen( $url ) > 255 ) {
3886 return wfMessage( 'scarytranscludetoolong' )->inContentLanguage()->text();
3887 }
3888 return $this->fetchScaryTemplateMaybeFromCache( $url );
3889 }
3890
3891 /**
3892 * @param $url string
3893 * @return Mixed|String
3894 */
3895 function fetchScaryTemplateMaybeFromCache( $url ) {
3896 global $wgTranscludeCacheExpiry;
3897 $dbr = wfGetDB( DB_SLAVE );
3898 $tsCond = $dbr->timestamp( time() - $wgTranscludeCacheExpiry );
3899 $obj = $dbr->selectRow( 'transcache', array( 'tc_time', 'tc_contents' ),
3900 array( 'tc_url' => $url, "tc_time >= " . $dbr->addQuotes( $tsCond ) ) );
3901 if ( $obj ) {
3902 return $obj->tc_contents;
3903 }
3904
3905 $req = MWHttpRequest::factory( $url );
3906 $status = $req->execute(); // Status object
3907 if ( $status->isOK() ) {
3908 $text = $req->getContent();
3909 } elseif ( $req->getStatus() != 200 ) { // Though we failed to fetch the content, this status is useless.
3910 return wfMessage( 'scarytranscludefailed-httpstatus', $url, $req->getStatus() /* HTTP status */ )->inContentLanguage()->text();
3911 } else {
3912 return wfMessage( 'scarytranscludefailed', $url )->inContentLanguage()->text();
3913 }
3914
3915 $dbw = wfGetDB( DB_MASTER );
3916 $dbw->replace( 'transcache', array( 'tc_url' ), array(
3917 'tc_url' => $url,
3918 'tc_time' => $dbw->timestamp( time() ),
3919 'tc_contents' => $text
3920 ) );
3921 return $text;
3922 }
3923
3924 /**
3925 * Triple brace replacement -- used for template arguments
3926 * @private
3927 *
3928 * @param $piece array
3929 * @param $frame PPFrame
3930 *
3931 * @return array
3932 */
3933 function argSubstitution( $piece, $frame ) {
3934 wfProfileIn( __METHOD__ );
3935
3936 $error = false;
3937 $parts = $piece['parts'];
3938 $nameWithSpaces = $frame->expand( $piece['title'] );
3939 $argName = trim( $nameWithSpaces );
3940 $object = false;
3941 $text = $frame->getArgument( $argName );
3942 if ( $text === false && $parts->getLength() > 0
3943 && ( $this->ot['html']
3944 || $this->ot['pre']
3945 || ( $this->ot['wiki'] && $frame->isTemplate() )
3946 )
3947 ) {
3948 # No match in frame, use the supplied default
3949 $object = $parts->item( 0 )->getChildren();
3950 }
3951 if ( !$this->incrementIncludeSize( 'arg', strlen( $text ) ) ) {
3952 $error = '<!-- WARNING: argument omitted, expansion size too large -->';
3953 $this->limitationWarn( 'post-expand-template-argument' );
3954 }
3955
3956 if ( $text === false && $object === false ) {
3957 # No match anywhere
3958 $object = $frame->virtualBracketedImplode( '{{{', '|', '}}}', $nameWithSpaces, $parts );
3959 }
3960 if ( $error !== false ) {
3961 $text .= $error;
3962 }
3963 if ( $object !== false ) {
3964 $ret = array( 'object' => $object );
3965 } else {
3966 $ret = array( 'text' => $text );
3967 }
3968
3969 wfProfileOut( __METHOD__ );
3970 return $ret;
3971 }
3972
3973 /**
3974 * Return the text to be used for a given extension tag.
3975 * This is the ghost of strip().
3976 *
3977 * @param array $params Associative array of parameters:
3978 * name PPNode for the tag name
3979 * attr PPNode for unparsed text where tag attributes are thought to be
3980 * attributes Optional associative array of parsed attributes
3981 * inner Contents of extension element
3982 * noClose Original text did not have a close tag
3983 * @param $frame PPFrame
3984 *
3985 * @throws MWException
3986 * @return string
3987 */
3988 function extensionSubstitution( $params, $frame ) {
3989 $name = $frame->expand( $params['name'] );
3990 $attrText = !isset( $params['attr'] ) ? null : $frame->expand( $params['attr'] );
3991 $content = !isset( $params['inner'] ) ? null : $frame->expand( $params['inner'] );
3992 $marker = "{$this->mUniqPrefix}-$name-" . sprintf( '%08X', $this->mMarkerIndex++ ) . self::MARKER_SUFFIX;
3993
3994 $isFunctionTag = isset( $this->mFunctionTagHooks[strtolower( $name )] ) &&
3995 ( $this->ot['html'] || $this->ot['pre'] );
3996 if ( $isFunctionTag ) {
3997 $markerType = 'none';
3998 } else {
3999 $markerType = 'general';
4000 }
4001 if ( $this->ot['html'] || $isFunctionTag ) {
4002 $name = strtolower( $name );
4003 $attributes = Sanitizer::decodeTagAttributes( $attrText );
4004 if ( isset( $params['attributes'] ) ) {
4005 $attributes = $attributes + $params['attributes'];
4006 }
4007
4008 if ( isset( $this->mTagHooks[$name] ) ) {
4009 # Workaround for PHP bug 35229 and similar
4010 if ( !is_callable( $this->mTagHooks[$name] ) ) {
4011 throw new MWException( "Tag hook for $name is not callable\n" );
4012 }
4013 $output = call_user_func_array( $this->mTagHooks[$name],
4014 array( $content, $attributes, $this, $frame ) );
4015 } elseif ( isset( $this->mFunctionTagHooks[$name] ) ) {
4016 list( $callback, ) = $this->mFunctionTagHooks[$name];
4017 if ( !is_callable( $callback ) ) {
4018 throw new MWException( "Tag hook for $name is not callable\n" );
4019 }
4020
4021 $output = call_user_func_array( $callback, array( &$this, $frame, $content, $attributes ) );
4022 } else {
4023 $output = '<span class="error">Invalid tag extension name: ' .
4024 htmlspecialchars( $name ) . '</span>';
4025 }
4026
4027 if ( is_array( $output ) ) {
4028 # Extract flags to local scope (to override $markerType)
4029 $flags = $output;
4030 $output = $flags[0];
4031 unset( $flags[0] );
4032 extract( $flags );
4033 }
4034 } else {
4035 if ( is_null( $attrText ) ) {
4036 $attrText = '';
4037 }
4038 if ( isset( $params['attributes'] ) ) {
4039 foreach ( $params['attributes'] as $attrName => $attrValue ) {
4040 $attrText .= ' ' . htmlspecialchars( $attrName ) . '="' .
4041 htmlspecialchars( $attrValue ) . '"';
4042 }
4043 }
4044 if ( $content === null ) {
4045 $output = "<$name$attrText/>";
4046 } else {
4047 $close = is_null( $params['close'] ) ? '' : $frame->expand( $params['close'] );
4048 $output = "<$name$attrText>$content$close";
4049 }
4050 }
4051
4052 if ( $markerType === 'none' ) {
4053 return $output;
4054 } elseif ( $markerType === 'nowiki' ) {
4055 $this->mStripState->addNoWiki( $marker, $output );
4056 } elseif ( $markerType === 'general' ) {
4057 $this->mStripState->addGeneral( $marker, $output );
4058 } else {
4059 throw new MWException( __METHOD__ . ': invalid marker type' );
4060 }
4061 return $marker;
4062 }
4063
4064 /**
4065 * Increment an include size counter
4066 *
4067 * @param string $type the type of expansion
4068 * @param $size Integer: the size of the text
4069 * @return Boolean: false if this inclusion would take it over the maximum, true otherwise
4070 */
4071 function incrementIncludeSize( $type, $size ) {
4072 if ( $this->mIncludeSizes[$type] + $size > $this->mOptions->getMaxIncludeSize() ) {
4073 return false;
4074 } else {
4075 $this->mIncludeSizes[$type] += $size;
4076 return true;
4077 }
4078 }
4079
4080 /**
4081 * Increment the expensive function count
4082 *
4083 * @return Boolean: false if the limit has been exceeded
4084 */
4085 function incrementExpensiveFunctionCount() {
4086 $this->mExpensiveFunctionCount++;
4087 return $this->mExpensiveFunctionCount <= $this->mOptions->getExpensiveParserFunctionLimit();
4088 }
4089
4090 /**
4091 * Strip double-underscore items like __NOGALLERY__ and __NOTOC__
4092 * Fills $this->mDoubleUnderscores, returns the modified text
4093 *
4094 * @param $text string
4095 *
4096 * @return string
4097 */
4098 function doDoubleUnderscore( $text ) {
4099 wfProfileIn( __METHOD__ );
4100
4101 # The position of __TOC__ needs to be recorded
4102 $mw = MagicWord::get( 'toc' );
4103 if ( $mw->match( $text ) ) {
4104 $this->mShowToc = true;
4105 $this->mForceTocPosition = true;
4106
4107 # Set a placeholder. At the end we'll fill it in with the TOC.
4108 $text = $mw->replace( '<!--MWTOC-->', $text, 1 );
4109
4110 # Only keep the first one.
4111 $text = $mw->replace( '', $text );
4112 }
4113
4114 # Now match and remove the rest of them
4115 $mwa = MagicWord::getDoubleUnderscoreArray();
4116 $this->mDoubleUnderscores = $mwa->matchAndRemove( $text );
4117
4118 if ( isset( $this->mDoubleUnderscores['nogallery'] ) ) {
4119 $this->mOutput->mNoGallery = true;
4120 }
4121 if ( isset( $this->mDoubleUnderscores['notoc'] ) && !$this->mForceTocPosition ) {
4122 $this->mShowToc = false;
4123 }
4124 if ( isset( $this->mDoubleUnderscores['hiddencat'] ) && $this->mTitle->getNamespace() == NS_CATEGORY ) {
4125 $this->addTrackingCategory( 'hidden-category-category' );
4126 }
4127 # (bug 8068) Allow control over whether robots index a page.
4128 #
4129 # @todo FIXME: Bug 14899: __INDEX__ always overrides __NOINDEX__ here! This
4130 # is not desirable, the last one on the page should win.
4131 if ( isset( $this->mDoubleUnderscores['noindex'] ) && $this->mTitle->canUseNoindex() ) {
4132 $this->mOutput->setIndexPolicy( 'noindex' );
4133 $this->addTrackingCategory( 'noindex-category' );
4134 }
4135 if ( isset( $this->mDoubleUnderscores['index'] ) && $this->mTitle->canUseNoindex() ) {
4136 $this->mOutput->setIndexPolicy( 'index' );
4137 $this->addTrackingCategory( 'index-category' );
4138 }
4139
4140 # Cache all double underscores in the database
4141 foreach ( $this->mDoubleUnderscores as $key => $val ) {
4142 $this->mOutput->setProperty( $key, '' );
4143 }
4144
4145 wfProfileOut( __METHOD__ );
4146 return $text;
4147 }
4148
4149 /**
4150 * Add a tracking category, getting the title from a system message,
4151 * or print a debug message if the title is invalid.
4152 *
4153 * @param string $msg message key
4154 * @return Boolean: whether the addition was successful
4155 */
4156 public function addTrackingCategory( $msg ) {
4157 if ( $this->mTitle->getNamespace() === NS_SPECIAL ) {
4158 wfDebug( __METHOD__ . ": Not adding tracking category $msg to special page!\n" );
4159 return false;
4160 }
4161 // Important to parse with correct title (bug 31469)
4162 $cat = wfMessage( $msg )
4163 ->title( $this->getTitle() )
4164 ->inContentLanguage()
4165 ->text();
4166
4167 # Allow tracking categories to be disabled by setting them to "-"
4168 if ( $cat === '-' ) {
4169 return false;
4170 }
4171
4172 $containerCategory = Title::makeTitleSafe( NS_CATEGORY, $cat );
4173 if ( $containerCategory ) {
4174 $this->mOutput->addCategory( $containerCategory->getDBkey(), $this->getDefaultSort() );
4175 return true;
4176 } else {
4177 wfDebug( __METHOD__ . ": [[MediaWiki:$msg]] is not a valid title!\n" );
4178 return false;
4179 }
4180 }
4181
4182 /**
4183 * This function accomplishes several tasks:
4184 * 1) Auto-number headings if that option is enabled
4185 * 2) Add an [edit] link to sections for users who have enabled the option and can edit the page
4186 * 3) Add a Table of contents on the top for users who have enabled the option
4187 * 4) Auto-anchor headings
4188 *
4189 * It loops through all headlines, collects the necessary data, then splits up the
4190 * string and re-inserts the newly formatted headlines.
4191 *
4192 * @param $text String
4193 * @param string $origText original, untouched wikitext
4194 * @param $isMain Boolean
4195 * @return mixed|string
4196 * @private
4197 */
4198 function formatHeadings( $text, $origText, $isMain = true ) {
4199 global $wgMaxTocLevel, $wgExperimentalHtmlIds;
4200
4201 # Inhibit editsection links if requested in the page
4202 if ( isset( $this->mDoubleUnderscores['noeditsection'] ) ) {
4203 $maybeShowEditLink = $showEditLink = false;
4204 } else {
4205 $maybeShowEditLink = true; /* Actual presence will depend on ParserOptions option */
4206 $showEditLink = $this->mOptions->getEditSection();
4207 }
4208 if ( $showEditLink ) {
4209 $this->mOutput->setEditSectionTokens( true );
4210 }
4211
4212 # Get all headlines for numbering them and adding funky stuff like [edit]
4213 # links - this is for later, but we need the number of headlines right now
4214 $matches = array();
4215 $numMatches = preg_match_all( '/<H(?P<level>[1-6])(?P<attrib>.*?' . '>)\s*(?P<header>[\s\S]*?)\s*<\/H[1-6] *>/i', $text, $matches );
4216
4217 # if there are fewer than 4 headlines in the article, do not show TOC
4218 # unless it's been explicitly enabled.
4219 $enoughToc = $this->mShowToc &&
4220 ( ( $numMatches >= 4 ) || $this->mForceTocPosition );
4221
4222 # Allow user to stipulate that a page should have a "new section"
4223 # link added via __NEWSECTIONLINK__
4224 if ( isset( $this->mDoubleUnderscores['newsectionlink'] ) ) {
4225 $this->mOutput->setNewSection( true );
4226 }
4227
4228 # Allow user to remove the "new section"
4229 # link via __NONEWSECTIONLINK__
4230 if ( isset( $this->mDoubleUnderscores['nonewsectionlink'] ) ) {
4231 $this->mOutput->hideNewSection( true );
4232 }
4233
4234 # if the string __FORCETOC__ (not case-sensitive) occurs in the HTML,
4235 # override above conditions and always show TOC above first header
4236 if ( isset( $this->mDoubleUnderscores['forcetoc'] ) ) {
4237 $this->mShowToc = true;
4238 $enoughToc = true;
4239 }
4240
4241 # headline counter
4242 $headlineCount = 0;
4243 $numVisible = 0;
4244
4245 # Ugh .. the TOC should have neat indentation levels which can be
4246 # passed to the skin functions. These are determined here
4247 $toc = '';
4248 $full = '';
4249 $head = array();
4250 $sublevelCount = array();
4251 $levelCount = array();
4252 $level = 0;
4253 $prevlevel = 0;
4254 $toclevel = 0;
4255 $prevtoclevel = 0;
4256 $markerRegex = "{$this->mUniqPrefix}-h-(\d+)-" . self::MARKER_SUFFIX;
4257 $baseTitleText = $this->mTitle->getPrefixedDBkey();
4258 $oldType = $this->mOutputType;
4259 $this->setOutputType( self::OT_WIKI );
4260 $frame = $this->getPreprocessor()->newFrame();
4261 $root = $this->preprocessToDom( $origText );
4262 $node = $root->getFirstChild();
4263 $byteOffset = 0;
4264 $tocraw = array();
4265 $refers = array();
4266
4267 foreach ( $matches[3] as $headline ) {
4268 $isTemplate = false;
4269 $titleText = false;
4270 $sectionIndex = false;
4271 $numbering = '';
4272 $markerMatches = array();
4273 if ( preg_match( "/^$markerRegex/", $headline, $markerMatches ) ) {
4274 $serial = $markerMatches[1];
4275 list( $titleText, $sectionIndex ) = $this->mHeadings[$serial];
4276 $isTemplate = ( $titleText != $baseTitleText );
4277 $headline = preg_replace( "/^$markerRegex\\s*/", "", $headline );
4278 }
4279
4280 if ( $toclevel ) {
4281 $prevlevel = $level;
4282 }
4283 $level = $matches[1][$headlineCount];
4284
4285 if ( $level > $prevlevel ) {
4286 # Increase TOC level
4287 $toclevel++;
4288 $sublevelCount[$toclevel] = 0;
4289 if ( $toclevel < $wgMaxTocLevel ) {
4290 $prevtoclevel = $toclevel;
4291 $toc .= Linker::tocIndent();
4292 $numVisible++;
4293 }
4294 } elseif ( $level < $prevlevel && $toclevel > 1 ) {
4295 # Decrease TOC level, find level to jump to
4296
4297 for ( $i = $toclevel; $i > 0; $i-- ) {
4298 if ( $levelCount[$i] == $level ) {
4299 # Found last matching level
4300 $toclevel = $i;
4301 break;
4302 } elseif ( $levelCount[$i] < $level ) {
4303 # Found first matching level below current level
4304 $toclevel = $i + 1;
4305 break;
4306 }
4307 }
4308 if ( $i == 0 ) {
4309 $toclevel = 1;
4310 }
4311 if ( $toclevel < $wgMaxTocLevel ) {
4312 if ( $prevtoclevel < $wgMaxTocLevel ) {
4313 # Unindent only if the previous toc level was shown :p
4314 $toc .= Linker::tocUnindent( $prevtoclevel - $toclevel );
4315 $prevtoclevel = $toclevel;
4316 } else {
4317 $toc .= Linker::tocLineEnd();
4318 }
4319 }
4320 } else {
4321 # No change in level, end TOC line
4322 if ( $toclevel < $wgMaxTocLevel ) {
4323 $toc .= Linker::tocLineEnd();
4324 }
4325 }
4326
4327 $levelCount[$toclevel] = $level;
4328
4329 # count number of headlines for each level
4330 $sublevelCount[$toclevel]++;
4331 $dot = 0;
4332 for ( $i = 1; $i <= $toclevel; $i++ ) {
4333 if ( !empty( $sublevelCount[$i] ) ) {
4334 if ( $dot ) {
4335 $numbering .= '.';
4336 }
4337 $numbering .= $this->getTargetLanguage()->formatNum( $sublevelCount[$i] );
4338 $dot = 1;
4339 }
4340 }
4341
4342 # The safe header is a version of the header text safe to use for links
4343
4344 # Remove link placeholders by the link text.
4345 # <!--LINK number-->
4346 # turns into
4347 # link text with suffix
4348 # Do this before unstrip since link text can contain strip markers
4349 $safeHeadline = $this->replaceLinkHoldersText( $headline );
4350
4351 # Avoid insertion of weird stuff like <math> by expanding the relevant sections
4352 $safeHeadline = $this->mStripState->unstripBoth( $safeHeadline );
4353
4354 # Strip out HTML (first regex removes any tag not allowed)
4355 # Allowed tags are:
4356 # * <sup> and <sub> (bug 8393)
4357 # * <i> (bug 26375)
4358 # * <b> (r105284)
4359 # * <span dir="rtl"> and <span dir="ltr"> (bug 35167)
4360 #
4361 # We strip any parameter from accepted tags (second regex), except dir="rtl|ltr" from <span>,
4362 # to allow setting directionality in toc items.
4363 $tocline = preg_replace(
4364 array( '#<(?!/?(span|sup|sub|i|b)(?: [^>]*)?>).*?' . '>#', '#<(/?(?:span(?: dir="(?:rtl|ltr)")?|sup|sub|i|b))(?: .*?)?' . '>#' ),
4365 array( '', '<$1>' ),
4366 $safeHeadline
4367 );
4368 $tocline = trim( $tocline );
4369
4370 # For the anchor, strip out HTML-y stuff period
4371 $safeHeadline = preg_replace( '/<.*?' . '>/', '', $safeHeadline );
4372 $safeHeadline = Sanitizer::normalizeSectionNameWhitespace( $safeHeadline );
4373
4374 # Save headline for section edit hint before it's escaped
4375 $headlineHint = $safeHeadline;
4376
4377 if ( $wgExperimentalHtmlIds ) {
4378 # For reverse compatibility, provide an id that's
4379 # HTML4-compatible, like we used to.
4380 #
4381 # It may be worth noting, academically, that it's possible for
4382 # the legacy anchor to conflict with a non-legacy headline
4383 # anchor on the page. In this case likely the "correct" thing
4384 # would be to either drop the legacy anchors or make sure
4385 # they're numbered first. However, this would require people
4386 # to type in section names like "abc_.D7.93.D7.90.D7.A4"
4387 # manually, so let's not bother worrying about it.
4388 $legacyHeadline = Sanitizer::escapeId( $safeHeadline,
4389 array( 'noninitial', 'legacy' ) );
4390 $safeHeadline = Sanitizer::escapeId( $safeHeadline );
4391
4392 if ( $legacyHeadline == $safeHeadline ) {
4393 # No reason to have both (in fact, we can't)
4394 $legacyHeadline = false;
4395 }
4396 } else {
4397 $legacyHeadline = false;
4398 $safeHeadline = Sanitizer::escapeId( $safeHeadline,
4399 'noninitial' );
4400 }
4401
4402 # HTML names must be case-insensitively unique (bug 10721).
4403 # This does not apply to Unicode characters per
4404 # http://dev.w3.org/html5/spec/infrastructure.html#case-sensitivity-and-string-comparison
4405 # @todo FIXME: We may be changing them depending on the current locale.
4406 $arrayKey = strtolower( $safeHeadline );
4407 if ( $legacyHeadline === false ) {
4408 $legacyArrayKey = false;
4409 } else {
4410 $legacyArrayKey = strtolower( $legacyHeadline );
4411 }
4412
4413 # count how many in assoc. array so we can track dupes in anchors
4414 if ( isset( $refers[$arrayKey] ) ) {
4415 $refers[$arrayKey]++;
4416 } else {
4417 $refers[$arrayKey] = 1;
4418 }
4419 if ( isset( $refers[$legacyArrayKey] ) ) {
4420 $refers[$legacyArrayKey]++;
4421 } else {
4422 $refers[$legacyArrayKey] = 1;
4423 }
4424
4425 # Don't number the heading if it is the only one (looks silly)
4426 if ( count( $matches[3] ) > 1 && $this->mOptions->getNumberHeadings() ) {
4427 # the two are different if the line contains a link
4428 $headline = Html::element( 'span', array( 'class' => 'mw-headline-number' ), $numbering ) . ' ' . $headline;
4429 }
4430
4431 # Create the anchor for linking from the TOC to the section
4432 $anchor = $safeHeadline;
4433 $legacyAnchor = $legacyHeadline;
4434 if ( $refers[$arrayKey] > 1 ) {
4435 $anchor .= '_' . $refers[$arrayKey];
4436 }
4437 if ( $legacyHeadline !== false && $refers[$legacyArrayKey] > 1 ) {
4438 $legacyAnchor .= '_' . $refers[$legacyArrayKey];
4439 }
4440 if ( $enoughToc && ( !isset( $wgMaxTocLevel ) || $toclevel < $wgMaxTocLevel ) ) {
4441 $toc .= Linker::tocLine( $anchor, $tocline,
4442 $numbering, $toclevel, ( $isTemplate ? false : $sectionIndex ) );
4443 }
4444
4445 # Add the section to the section tree
4446 # Find the DOM node for this header
4447 $noOffset = ( $isTemplate || $sectionIndex === false );
4448 while ( $node && !$noOffset ) {
4449 if ( $node->getName() === 'h' ) {
4450 $bits = $node->splitHeading();
4451 if ( $bits['i'] == $sectionIndex ) {
4452 break;
4453 }
4454 }
4455 $byteOffset += mb_strlen( $this->mStripState->unstripBoth(
4456 $frame->expand( $node, PPFrame::RECOVER_ORIG ) ) );
4457 $node = $node->getNextSibling();
4458 }
4459 $tocraw[] = array(
4460 'toclevel' => $toclevel,
4461 'level' => $level,
4462 'line' => $tocline,
4463 'number' => $numbering,
4464 'index' => ( $isTemplate ? 'T-' : '' ) . $sectionIndex,
4465 'fromtitle' => $titleText,
4466 'byteoffset' => ( $noOffset ? null : $byteOffset ),
4467 'anchor' => $anchor,
4468 );
4469
4470 # give headline the correct <h#> tag
4471 if ( $maybeShowEditLink && $sectionIndex !== false ) {
4472 // Output edit section links as markers with styles that can be customized by skins
4473 if ( $isTemplate ) {
4474 # Put a T flag in the section identifier, to indicate to extractSections()
4475 # that sections inside <includeonly> should be counted.
4476 $editlinkArgs = array( $titleText, "T-$sectionIndex"/*, null */ );
4477 } else {
4478 $editlinkArgs = array( $this->mTitle->getPrefixedText(), $sectionIndex, $headlineHint );
4479 }
4480 // We use a bit of pesudo-xml for editsection markers. The language converter is run later on
4481 // Using a UNIQ style marker leads to the converter screwing up the tokens when it converts stuff
4482 // And trying to insert strip tags fails too. At this point all real inputted tags have already been escaped
4483 // so we don't have to worry about a user trying to input one of these markers directly.
4484 // We use a page and section attribute to stop the language converter from converting these important bits
4485 // of data, but put the headline hint inside a content block because the language converter is supposed to
4486 // be able to convert that piece of data.
4487 $editlink = '<mw:editsection page="' . htmlspecialchars( $editlinkArgs[0] );
4488 $editlink .= '" section="' . htmlspecialchars( $editlinkArgs[1] ) . '"';
4489 if ( isset( $editlinkArgs[2] ) ) {
4490 $editlink .= '>' . $editlinkArgs[2] . '</mw:editsection>';
4491 } else {
4492 $editlink .= '/>';
4493 }
4494 } else {
4495 $editlink = '';
4496 }
4497 $head[$headlineCount] = Linker::makeHeadline( $level,
4498 $matches['attrib'][$headlineCount], $anchor, $headline,
4499 $editlink, $legacyAnchor );
4500
4501 $headlineCount++;
4502 }
4503
4504 $this->setOutputType( $oldType );
4505
4506 # Never ever show TOC if no headers
4507 if ( $numVisible < 1 ) {
4508 $enoughToc = false;
4509 }
4510
4511 if ( $enoughToc ) {
4512 if ( $prevtoclevel > 0 && $prevtoclevel < $wgMaxTocLevel ) {
4513 $toc .= Linker::tocUnindent( $prevtoclevel - 1 );
4514 }
4515 $toc = Linker::tocList( $toc, $this->mOptions->getUserLangObj() );
4516 $this->mOutput->setTOCHTML( $toc );
4517 $toc = self::TOC_START . $toc . self::TOC_END;
4518 }
4519
4520 if ( $isMain ) {
4521 $this->mOutput->setSections( $tocraw );
4522 }
4523
4524 # split up and insert constructed headlines
4525 $blocks = preg_split( '/<H[1-6].*?' . '>[\s\S]*?<\/H[1-6]>/i', $text );
4526 $i = 0;
4527
4528 // build an array of document sections
4529 $sections = array();
4530 foreach ( $blocks as $block ) {
4531 // $head is zero-based, sections aren't.
4532 if ( empty( $head[$i - 1] ) ) {
4533 $sections[$i] = $block;
4534 } else {
4535 $sections[$i] = $head[$i - 1] . $block;
4536 }
4537
4538 /**
4539 * Send a hook, one per section.
4540 * The idea here is to be able to make section-level DIVs, but to do so in a
4541 * lower-impact, more correct way than r50769
4542 *
4543 * $this : caller
4544 * $section : the section number
4545 * &$sectionContent : ref to the content of the section
4546 * $showEditLinks : boolean describing whether this section has an edit link
4547 */
4548 wfRunHooks( 'ParserSectionCreate', array( $this, $i, &$sections[$i], $showEditLink ) );
4549
4550 $i++;
4551 }
4552
4553 if ( $enoughToc && $isMain && !$this->mForceTocPosition ) {
4554 // append the TOC at the beginning
4555 // Top anchor now in skin
4556 $sections[0] = $sections[0] . $toc . "\n";
4557 }
4558
4559 $full .= join( '', $sections );
4560
4561 if ( $this->mForceTocPosition ) {
4562 return str_replace( '<!--MWTOC-->', $toc, $full );
4563 } else {
4564 return $full;
4565 }
4566 }
4567
4568 /**
4569 * Transform wiki markup when saving a page by doing "\r\n" -> "\n"
4570 * conversion, substitting signatures, {{subst:}} templates, etc.
4571 *
4572 * @param string $text the text to transform
4573 * @param $title Title: the Title object for the current article
4574 * @param $user User: the User object describing the current user
4575 * @param $options ParserOptions: parsing options
4576 * @param $clearState Boolean: whether to clear the parser state first
4577 * @return String: the altered wiki markup
4578 */
4579 public function preSaveTransform( $text, Title $title, User $user, ParserOptions $options, $clearState = true ) {
4580 $this->startParse( $title, $options, self::OT_WIKI, $clearState );
4581 $this->setUser( $user );
4582
4583 $pairs = array(
4584 "\r\n" => "\n",
4585 );
4586 $text = str_replace( array_keys( $pairs ), array_values( $pairs ), $text );
4587 if ( $options->getPreSaveTransform() ) {
4588 $text = $this->pstPass2( $text, $user );
4589 }
4590 $text = $this->mStripState->unstripBoth( $text );
4591
4592 $this->setUser( null ); #Reset
4593
4594 return $text;
4595 }
4596
4597 /**
4598 * Pre-save transform helper function
4599 * @private
4600 *
4601 * @param $text string
4602 * @param $user User
4603 *
4604 * @return string
4605 */
4606 function pstPass2( $text, $user ) {
4607 global $wgContLang;
4608
4609 # Note: This is the timestamp saved as hardcoded wikitext to
4610 # the database, we use $wgContLang here in order to give
4611 # everyone the same signature and use the default one rather
4612 # than the one selected in each user's preferences.
4613 # (see also bug 12815)
4614 $ts = $this->mOptions->getTimestamp();
4615 $timestamp = MWTimestamp::getLocalInstance( $ts );
4616 $ts = $timestamp->format( 'YmdHis' );
4617 $tzMsg = $timestamp->format( 'T' ); # might vary on DST changeover!
4618
4619 # Allow translation of timezones through wiki. format() can return
4620 # whatever crap the system uses, localised or not, so we cannot
4621 # ship premade translations.
4622 $key = 'timezone-' . strtolower( trim( $tzMsg ) );
4623 $msg = wfMessage( $key )->inContentLanguage();
4624 if ( $msg->exists() ) {
4625 $tzMsg = $msg->text();
4626 }
4627
4628 $d = $wgContLang->timeanddate( $ts, false, false ) . " ($tzMsg)";
4629
4630 # Variable replacement
4631 # Because mOutputType is OT_WIKI, this will only process {{subst:xxx}} type tags
4632 $text = $this->replaceVariables( $text );
4633
4634 # This works almost by chance, as the replaceVariables are done before the getUserSig(),
4635 # which may corrupt this parser instance via its wfMessage()->text() call-
4636
4637 # Signatures
4638 $sigText = $this->getUserSig( $user );
4639 $text = strtr( $text, array(
4640 '~~~~~' => $d,
4641 '~~~~' => "$sigText $d",
4642 '~~~' => $sigText
4643 ) );
4644
4645 # Context links ("pipe tricks"): [[|name]] and [[name (context)|]]
4646 $tc = '[' . Title::legalChars() . ']';
4647 $nc = '[ _0-9A-Za-z\x80-\xff-]'; # Namespaces can use non-ascii!
4648
4649 $p1 = "/\[\[(:?$nc+:|:|)($tc+?)( ?\\($tc+\\))\\|]]/"; # [[ns:page (context)|]]
4650 $p4 = "/\[\[(:?$nc+:|:|)($tc+?)( ?（$tc+）)\\|]]/"; # [[ns:page（context）|]] (double-width brackets, added in r40257)
4651 $p3 = "/\[\[(:?$nc+:|:|)($tc+?)( ?\\($tc+\\)|)((?:, |，)$tc+|)\\|]]/"; # [[ns:page (context), context|]] (using either single or double-width comma)
4652 $p2 = "/\[\[\\|($tc+)]]/"; # [[|page]] (reverse pipe trick: add context from page title)
4653
4654 # try $p1 first, to turn "[[A, B (C)|]]" into "[[A, B (C)|A, B]]"
4655 $text = preg_replace( $p1, '[[\\1\\2\\3|\\2]]', $text );
4656 $text = preg_replace( $p4, '[[\\1\\2\\3|\\2]]', $text );
4657 $text = preg_replace( $p3, '[[\\1\\2\\3\\4|\\2]]', $text );
4658
4659 $t = $this->mTitle->getText();
4660 $m = array();
4661 if ( preg_match( "/^($nc+:|)$tc+?( \\($tc+\\))$/", $t, $m ) ) {
4662 $text = preg_replace( $p2, "[[$m[1]\\1$m[2]|\\1]]", $text );
4663 } elseif ( preg_match( "/^($nc+:|)$tc+?(, $tc+|)$/", $t, $m ) && "$m[1]$m[2]" != '' ) {
4664 $text = preg_replace( $p2, "[[$m[1]\\1$m[2]|\\1]]", $text );
4665 } else {
4666 # if there's no context, don't bother duplicating the title
4667 $text = preg_replace( $p2, '[[\\1]]', $text );
4668 }
4669
4670 # Trim trailing whitespace
4671 $text = rtrim( $text );
4672
4673 return $text;
4674 }
4675
4676 /**
4677 * Fetch the user's signature text, if any, and normalize to
4678 * validated, ready-to-insert wikitext.
4679 * If you have pre-fetched the nickname or the fancySig option, you can
4680 * specify them here to save a database query.
4681 * Do not reuse this parser instance after calling getUserSig(),
4682 * as it may have changed if it's the $wgParser.
4683 *
4684 * @param $user User
4685 * @param string|bool $nickname nickname to use or false to use user's default nickname
4686 * @param $fancySig Boolean|null whether the nicknname is the complete signature
4687 * or null to use default value
4688 * @return string
4689 */
4690 function getUserSig( &$user, $nickname = false, $fancySig = null ) {
4691 global $wgMaxSigChars;
4692
4693 $username = $user->getName();
4694
4695 # If not given, retrieve from the user object.
4696 if ( $nickname === false ) {
4697 $nickname = $user->getOption( 'nickname' );
4698 }
4699
4700 if ( is_null( $fancySig ) ) {
4701 $fancySig = $user->getBoolOption( 'fancysig' );
4702 }
4703
4704 $nickname = $nickname == null ? $username : $nickname;
4705
4706 if ( mb_strlen( $nickname ) > $wgMaxSigChars ) {
4707 $nickname = $username;
4708 wfDebug( __METHOD__ . ": $username has overlong signature.\n" );
4709 } elseif ( $fancySig !== false ) {
4710 # Sig. might contain markup; validate this
4711 if ( $this->validateSig( $nickname ) !== false ) {
4712 # Validated; clean up (if needed) and return it
4713 return $this->cleanSig( $nickname, true );
4714 } else {
4715 # Failed to validate; fall back to the default
4716 $nickname = $username;
4717 wfDebug( __METHOD__ . ": $username has bad XML tags in signature.\n" );
4718 }
4719 }
4720
4721 # Make sure nickname doesnt get a sig in a sig
4722 $nickname = self::cleanSigInSig( $nickname );
4723
4724 # If we're still here, make it a link to the user page
4725 $userText = wfEscapeWikiText( $username );
4726 $nickText = wfEscapeWikiText( $nickname );
4727 $msgName = $user->isAnon() ? 'signature-anon' : 'signature';
4728
4729 return wfMessage( $msgName, $userText, $nickText )->inContentLanguage()->title( $this->getTitle() )->text();
4730 }
4731
4732 /**
4733 * Check that the user's signature contains no bad XML
4734 *
4735 * @param $text String
4736 * @return mixed An expanded string, or false if invalid.
4737 */
4738 function validateSig( $text ) {
4739 return Xml::isWellFormedXmlFragment( $text ) ? $text : false;
4740 }
4741
4742 /**
4743 * Clean up signature text
4744 *
4745 * 1) Strip ~~~, ~~~~ and ~~~~~ out of signatures @see cleanSigInSig
4746 * 2) Substitute all transclusions
4747 *
4748 * @param $text String
4749 * @param bool $parsing Whether we're cleaning (preferences save) or parsing
4750 * @return String: signature text
4751 */
4752 public function cleanSig( $text, $parsing = false ) {
4753 if ( !$parsing ) {
4754 global $wgTitle;
4755 $this->startParse( $wgTitle, new ParserOptions, self::OT_PREPROCESS, true );
4756 }
4757
4758 # Option to disable this feature
4759 if ( !$this->mOptions->getCleanSignatures() ) {
4760 return $text;
4761 }
4762
4763 # @todo FIXME: Regex doesn't respect extension tags or nowiki
4764 # => Move this logic to braceSubstitution()
4765 $substWord = MagicWord::get( 'subst' );
4766 $substRegex = '/\{\{(?!(?:' . $substWord->getBaseRegex() . '))/x' . $substWord->getRegexCase();
4767 $substText = '{{' . $substWord->getSynonym( 0 );
4768
4769 $text = preg_replace( $substRegex, $substText, $text );
4770 $text = self::cleanSigInSig( $text );
4771 $dom = $this->preprocessToDom( $text );
4772 $frame = $this->getPreprocessor()->newFrame();
4773 $text = $frame->expand( $dom );
4774
4775 if ( !$parsing ) {
4776 $text = $this->mStripState->unstripBoth( $text );
4777 }
4778
4779 return $text;
4780 }
4781
4782 /**
4783 * Strip ~~~, ~~~~ and ~~~~~ out of signatures
4784 *
4785 * @param $text String
4786 * @return String: signature text with /~{3,5}/ removed
4787 */
4788 public static function cleanSigInSig( $text ) {
4789 $text = preg_replace( '/~{3,5}/', '', $text );
4790 return $text;
4791 }
4792
4793 /**
4794 * Set up some variables which are usually set up in parse()
4795 * so that an external function can call some class members with confidence
4796 *
4797 * @param $title Title|null
4798 * @param $options ParserOptions
4799 * @param $outputType
4800 * @param $clearState bool
4801 */
4802 public function startExternalParse( Title $title = null, ParserOptions $options, $outputType, $clearState = true ) {
4803 $this->startParse( $title, $options, $outputType, $clearState );
4804 }
4805
4806 /**
4807 * @param $title Title|null
4808 * @param $options ParserOptions
4809 * @param $outputType
4810 * @param $clearState bool
4811 */
4812 private function startParse( Title $title = null, ParserOptions $options, $outputType, $clearState = true ) {
4813 $this->setTitle( $title );
4814 $this->mOptions = $options;
4815 $this->setOutputType( $outputType );
4816 if ( $clearState ) {
4817 $this->clearState();
4818 }
4819 }
4820
4821 /**
4822 * Wrapper for preprocess()
4823 *
4824 * @param string $text the text to preprocess
4825 * @param $options ParserOptions: options
4826 * @param $title Title object or null to use $wgTitle
4827 * @return String
4828 */
4829 public function transformMsg( $text, $options, $title = null ) {
4830 static $executing = false;
4831
4832 # Guard against infinite recursion
4833 if ( $executing ) {
4834 return $text;
4835 }
4836 $executing = true;
4837
4838 wfProfileIn( __METHOD__ );
4839 if ( !$title ) {
4840 global $wgTitle;
4841 $title = $wgTitle;
4842 }
4843
4844 $text = $this->preprocess( $text, $title, $options );
4845
4846 $executing = false;
4847 wfProfileOut( __METHOD__ );
4848 return $text;
4849 }
4850
4851 /**
4852 * Create an HTML-style tag, e.g. "<yourtag>special text</yourtag>"
4853 * The callback should have the following form:
4854 * function myParserHook( $text, $params, $parser, $frame ) { ... }
4855 *
4856 * Transform and return $text. Use $parser for any required context, e.g. use
4857 * $parser->getTitle() and $parser->getOptions() not $wgTitle or $wgOut->mParserOptions
4858 *
4859 * Hooks may return extended information by returning an array, of which the
4860 * first numbered element (index 0) must be the return string, and all other
4861 * entries are extracted into local variables within an internal function
4862 * in the Parser class.
4863 *
4864 * This interface (introduced r61913) appears to be undocumented, but
4865 * 'markerName' is used by some core tag hooks to override which strip
4866 * array their results are placed in. **Use great caution if attempting
4867 * this interface, as it is not documented and injudicious use could smash
4868 * private variables.**
4869 *
4870 * @param $tag Mixed: the tag to use, e.g. 'hook' for "<hook>"
4871 * @param $callback Mixed: the callback function (and object) to use for the tag
4872 * @throws MWException
4873 * @return Mixed|null The old value of the mTagHooks array associated with the hook
4874 */
4875 public function setHook( $tag, $callback ) {
4876 $tag = strtolower( $tag );
4877 if ( preg_match( '/[<>\r\n]/', $tag, $m ) ) {
4878 throw new MWException( "Invalid character {$m[0]} in setHook('$tag', ...) call" );
4879 }
4880 $oldVal = isset( $this->mTagHooks[$tag] ) ? $this->mTagHooks[$tag] : null;
4881 $this->mTagHooks[$tag] = $callback;
4882 if ( !in_array( $tag, $this->mStripList ) ) {
4883 $this->mStripList[] = $tag;
4884 }
4885
4886 return $oldVal;
4887 }
4888
4889 /**
4890 * As setHook(), but letting the contents be parsed.
4891 *
4892 * Transparent tag hooks are like regular XML-style tag hooks, except they
4893 * operate late in the transformation sequence, on HTML instead of wikitext.
4894 *
4895 * This is probably obsoleted by things dealing with parser frames?
4896 * The only extension currently using it is geoserver.
4897 *
4898 * @since 1.10
4899 * @todo better document or deprecate this
4900 *
4901 * @param $tag Mixed: the tag to use, e.g. 'hook' for "<hook>"
4902 * @param $callback Mixed: the callback function (and object) to use for the tag
4903 * @throws MWException
4904 * @return Mixed|null The old value of the mTagHooks array associated with the hook
4905 */
4906 function setTransparentTagHook( $tag, $callback ) {
4907 $tag = strtolower( $tag );
4908 if ( preg_match( '/[<>\r\n]/', $tag, $m ) ) {
4909 throw new MWException( "Invalid character {$m[0]} in setTransparentHook('$tag', ...) call" );
4910 }
4911 $oldVal = isset( $this->mTransparentTagHooks[$tag] ) ? $this->mTransparentTagHooks[$tag] : null;
4912 $this->mTransparentTagHooks[$tag] = $callback;
4913
4914 return $oldVal;
4915 }
4916
4917 /**
4918 * Remove all tag hooks
4919 */
4920 function clearTagHooks() {
4921 $this->mTagHooks = array();
4922 $this->mFunctionTagHooks = array();
4923 $this->mStripList = $this->mDefaultStripList;
4924 }
4925
4926 /**
4927 * Create a function, e.g. {{sum:1|2|3}}
4928 * The callback function should have the form:
4929 * function myParserFunction( &$parser, $arg1, $arg2, $arg3 ) { ... }
4930 *
4931 * Or with SFH_OBJECT_ARGS:
4932 * function myParserFunction( $parser, $frame, $args ) { ... }
4933 *
4934 * The callback may either return the text result of the function, or an array with the text
4935 * in element 0, and a number of flags in the other elements. The names of the flags are
4936 * specified in the keys. Valid flags are:
4937 * found The text returned is valid, stop processing the template. This
4938 * is on by default.
4939 * nowiki Wiki markup in the return value should be escaped
4940 * isHTML The returned text is HTML, armour it against wikitext transformation
4941 *
4942 * @param string $id The magic word ID
4943 * @param $callback Mixed: the callback function (and object) to use
4944 * @param $flags Integer: a combination of the following flags:
4945 * SFH_NO_HASH No leading hash, i.e. {{plural:...}} instead of {{#if:...}}
4946 *
4947 * SFH_OBJECT_ARGS Pass the template arguments as PPNode objects instead of text. This
4948 * allows for conditional expansion of the parse tree, allowing you to eliminate dead
4949 * branches and thus speed up parsing. It is also possible to analyse the parse tree of
4950 * the arguments, and to control the way they are expanded.
4951 *
4952 * The $frame parameter is a PPFrame. This can be used to produce expanded text from the
4953 * arguments, for instance:
4954 * $text = isset( $args[0] ) ? $frame->expand( $args[0] ) : '';
4955 *
4956 * For technical reasons, $args[0] is pre-expanded and will be a string. This may change in
4957 * future versions. Please call $frame->expand() on it anyway so that your code keeps
4958 * working if/when this is changed.
4959 *
4960 * If you want whitespace to be trimmed from $args, you need to do it yourself, post-
4961 * expansion.
4962 *
4963 * Please read the documentation in includes/parser/Preprocessor.php for more information
4964 * about the methods available in PPFrame and PPNode.
4965 *
4966 * @throws MWException
4967 * @return string|callback The old callback function for this name, if any
4968 */
4969 public function setFunctionHook( $id, $callback, $flags = 0 ) {
4970 global $wgContLang;
4971
4972 $oldVal = isset( $this->mFunctionHooks[$id] ) ? $this->mFunctionHooks[$id][0] : null;
4973 $this->mFunctionHooks[$id] = array( $callback, $flags );
4974
4975 # Add to function cache
4976 $mw = MagicWord::get( $id );
4977 if ( !$mw ) {
4978 throw new MWException( __METHOD__ . '() expecting a magic word identifier.' );
4979 }
4980
4981 $synonyms = $mw->getSynonyms();
4982 $sensitive = intval( $mw->isCaseSensitive() );
4983
4984 foreach ( $synonyms as $syn ) {
4985 # Case
4986 if ( !$sensitive ) {
4987 $syn = $wgContLang->lc( $syn );
4988 }
4989 # Add leading hash
4990 if ( !( $flags & SFH_NO_HASH ) ) {
4991 $syn = '#' . $syn;
4992 }
4993 # Remove trailing colon
4994 if ( substr( $syn, -1, 1 ) === ':' ) {
4995 $syn = substr( $syn, 0, -1 );
4996 }
4997 $this->mFunctionSynonyms[$sensitive][$syn] = $id;
4998 }
4999 return $oldVal;
5000 }
5001
5002 /**
5003 * Get all registered function hook identifiers
5004 *
5005 * @return Array
5006 */
5007 function getFunctionHooks() {
5008 return array_keys( $this->mFunctionHooks );
5009 }
5010
5011 /**
5012 * Create a tag function, e.g. "<test>some stuff</test>".
5013 * Unlike tag hooks, tag functions are parsed at preprocessor level.
5014 * Unlike parser functions, their content is not preprocessed.
5015 * @param $tag
5016 * @param $callback
5017 * @param $flags
5018 * @throws MWException
5019 * @return null
5020 */
5021 function setFunctionTagHook( $tag, $callback, $flags ) {
5022 $tag = strtolower( $tag );
5023 if ( preg_match( '/[<>\r\n]/', $tag, $m ) ) {
5024 throw new MWException( "Invalid character {$m[0]} in setFunctionTagHook('$tag', ...) call" );
5025 }
5026 $old = isset( $this->mFunctionTagHooks[$tag] ) ?
5027 $this->mFunctionTagHooks[$tag] : null;
5028 $this->mFunctionTagHooks[$tag] = array( $callback, $flags );
5029
5030 if ( !in_array( $tag, $this->mStripList ) ) {
5031 $this->mStripList[] = $tag;
5032 }
5033
5034 return $old;
5035 }
5036
5037 /**
5038 * @todo FIXME: Update documentation. makeLinkObj() is deprecated.
5039 * Replace "<!--LINK-->" link placeholders with actual links, in the buffer
5040 * Placeholders created in Skin::makeLinkObj()
5041 *
5042 * @param $text string
5043 * @param $options int
5044 *
5045 * @return array of link CSS classes, indexed by PDBK.
5046 */
5047 function replaceLinkHolders( &$text, $options = 0 ) {
5048 return $this->mLinkHolders->replace( $text );
5049 }
5050
5051 /**
5052 * Replace "<!--LINK-->" link placeholders with plain text of links
5053 * (not HTML-formatted).
5054 *
5055 * @param $text String
5056 * @return String
5057 */
5058 function replaceLinkHoldersText( $text ) {
5059 return $this->mLinkHolders->replaceText( $text );
5060 }
5061
5062 /**
5063 * Renders an image gallery from a text with one line per image.
5064 * text labels may be given by using |-style alternative text. E.g.
5065 * Image:one.jpg|The number "1"
5066 * Image:tree.jpg|A tree
5067 * given as text will return the HTML of a gallery with two images,
5068 * labeled 'The number "1"' and
5069 * 'A tree'.
5070 *
5071 * @param string $text
5072 * @param array $params
5073 * @return string HTML
5074 */
5075 function renderImageGallery( $text, $params ) {
5076 wfProfileIn( __METHOD__ );
5077
5078 $mode = false;
5079 if ( isset( $params['mode'] ) ) {
5080 $mode = $params['mode'];
5081 }
5082
5083 try {
5084 $ig = ImageGalleryBase::factory( $mode );
5085 } catch ( MWException $e ) {
5086 // If invalid type set, fallback to default.
5087 $ig = ImageGalleryBase::factory( false );
5088 }
5089
5090 $ig->setContextTitle( $this->mTitle );
5091 $ig->setShowBytes( false );
5092 $ig->setShowFilename( false );
5093 $ig->setParser( $this );
5094 $ig->setHideBadImages();
5095 $ig->setAttributes( Sanitizer::validateTagAttributes( $params, 'table' ) );
5096
5097 if ( isset( $params['showfilename'] ) ) {
5098 $ig->setShowFilename( true );
5099 } else {
5100 $ig->setShowFilename( false );
5101 }
5102 if ( isset( $params['caption'] ) ) {
5103 $caption = $params['caption'];
5104 $caption = htmlspecialchars( $caption );
5105 $caption = $this->replaceInternalLinks( $caption );
5106 $ig->setCaptionHtml( $caption );
5107 }
5108 if ( isset( $params['perrow'] ) ) {
5109 $ig->setPerRow( $params['perrow'] );
5110 }
5111 if ( isset( $params['widths'] ) ) {
5112 $ig->setWidths( $params['widths'] );
5113 }
5114 if ( isset( $params['heights'] ) ) {
5115 $ig->setHeights( $params['heights'] );
5116 }
5117 $ig->setAdditionalOptions( $params );
5118
5119 wfRunHooks( 'BeforeParserrenderImageGallery', array( &$this, &$ig ) );
5120
5121 $lines = StringUtils::explode( "\n", $text );
5122 foreach ( $lines as $line ) {
5123 # match lines like these:
5124 # Image:someimage.jpg|This is some image
5125 $matches = array();
5126 preg_match( "/^([^|]+)(\\|(.*))?$/", $line, $matches );
5127 # Skip empty lines
5128 if ( count( $matches ) == 0 ) {
5129 continue;
5130 }
5131
5132 if ( strpos( $matches[0], '%' ) !== false ) {
5133 $matches[1] = rawurldecode( $matches[1] );
5134 }
5135 $title = Title::newFromText( $matches[1], NS_FILE );
5136 if ( is_null( $title ) ) {
5137 # Bogus title. Ignore these so we don't bomb out later.
5138 continue;
5139 }
5140
5141 # We need to get what handler the file uses, to figure out parameters.
5142 # Note, a hook can overide the file name, and chose an entirely different
5143 # file (which potentially could be of a different type and have different handler).
5144 $options = array();
5145 $descQuery = false;
5146 wfRunHooks( 'BeforeParserFetchFileAndTitle',
5147 array( $this, $title, &$options, &$descQuery ) );
5148 # Don't register it now, as ImageGallery does that later.
5149 $file = $this->fetchFileNoRegister( $title, $options );
5150 $handler = $file ? $file->getHandler() : false;
5151
5152 wfProfileIn( __METHOD__ . '-getMagicWord' );
5153 $paramMap = array(
5154 'img_alt' => 'gallery-internal-alt',
5155 'img_link' => 'gallery-internal-link',
5156 );
5157 if ( $handler ) {
5158 $paramMap = $paramMap + $handler->getParamMap();
5159 // We don't want people to specify per-image widths.
5160 // Additionally the width parameter would need special casing anyhow.
5161 unset( $paramMap['img_width'] );
5162 }
5163
5164 $mwArray = new MagicWordArray( array_keys( $paramMap ) );
5165 wfProfileOut( __METHOD__ . '-getMagicWord' );
5166
5167 $label = '';
5168 $alt = '';
5169 $link = '';
5170 $handlerOptions = array();
5171 if ( isset( $matches[3] ) ) {
5172 // look for an |alt= definition while trying not to break existing
5173 // captions with multiple pipes (|) in it, until a more sensible grammar
5174 // is defined for images in galleries
5175
5176 // FIXME: Doing recursiveTagParse at this stage, and the trim before
5177 // splitting on '|' is a bit odd, and different from makeImage.
5178 $matches[3] = $this->recursiveTagParse( trim( $matches[3] ) );
5179 $parameterMatches = StringUtils::explode( '|', $matches[3] );
5180
5181 foreach ( $parameterMatches as $parameterMatch ) {
5182 list( $magicName, $match ) = $mwArray->matchVariableStartToEnd( $parameterMatch );
5183 if ( $magicName ) {
5184 $paramName = $paramMap[$magicName];
5185
5186 switch ( $paramName ) {
5187 case 'gallery-internal-alt':
5188 $alt = $this->stripAltText( $match, false );
5189 break;
5190 case 'gallery-internal-link':
5191 $linkValue = strip_tags( $this->replaceLinkHoldersText( $match ) );
5192 $chars = self::EXT_LINK_URL_CLASS;
5193 $prots = $this->mUrlProtocols;
5194 //check to see if link matches an absolute url, if not then it must be a wiki link.
5195 if ( preg_match( "/^($prots)$chars+$/u", $linkValue ) ) {
5196 $link = $linkValue;
5197 } else {
5198 $localLinkTitle = Title::newFromText( $linkValue );
5199 if ( $localLinkTitle !== null ) {
5200 $link = $localLinkTitle->getLocalURL();
5201 }
5202 }
5203 break;
5204 default:
5205 // Must be a handler specific parameter.
5206 if ( $handler->validateParam( $paramName, $match ) ) {
5207 $handlerOptions[$paramName] = $match;
5208 } else {
5209 // Guess not. Append it to the caption.
5210 wfDebug( "$parameterMatch failed parameter validation" );
5211 $label .= '|' . $parameterMatch;
5212 }
5213 }
5214
5215 } else {
5216 // concatenate all other pipes
5217 $label .= '|' . $parameterMatch;
5218 }
5219 }
5220 // remove the first pipe
5221 $label = substr( $label, 1 );
5222 }
5223
5224 $ig->add( $title, $label, $alt, $link, $handlerOptions );
5225 }
5226 $html = $ig->toHTML();
5227 wfProfileOut( __METHOD__ );
5228 return $html;
5229 }
5230
5231 /**
5232 * @param $handler
5233 * @return array
5234 */
5235 function getImageParams( $handler ) {
5236 if ( $handler ) {
5237 $handlerClass = get_class( $handler );
5238 } else {
5239 $handlerClass = '';
5240 }
5241 if ( !isset( $this->mImageParams[$handlerClass] ) ) {
5242 # Initialise static lists
5243 static $internalParamNames = array(
5244 'horizAlign' => array( 'left', 'right', 'center', 'none' ),
5245 'vertAlign' => array( 'baseline', 'sub', 'super', 'top', 'text-top', 'middle',
5246 'bottom', 'text-bottom' ),
5247 'frame' => array( 'thumbnail', 'manualthumb', 'framed', 'frameless',
5248 'upright', 'border', 'link', 'alt', 'class' ),
5249 );
5250 static $internalParamMap;
5251 if ( !$internalParamMap ) {
5252 $internalParamMap = array();
5253 foreach ( $internalParamNames as $type => $names ) {
5254 foreach ( $names as $name ) {
5255 $magicName = str_replace( '-', '_', "img_$name" );
5256 $internalParamMap[$magicName] = array( $type, $name );
5257 }
5258 }
5259 }
5260
5261 # Add handler params
5262 $paramMap = $internalParamMap;
5263 if ( $handler ) {
5264 $handlerParamMap = $handler->getParamMap();
5265 foreach ( $handlerParamMap as $magic => $paramName ) {
5266 $paramMap[$magic] = array( 'handler', $paramName );
5267 }
5268 }
5269 $this->mImageParams[$handlerClass] = $paramMap;
5270 $this->mImageParamsMagicArray[$handlerClass] = new MagicWordArray( array_keys( $paramMap ) );
5271 }
5272 return array( $this->mImageParams[$handlerClass], $this->mImageParamsMagicArray[$handlerClass] );
5273 }
5274
5275 /**
5276 * Parse image options text and use it to make an image
5277 *
5278 * @param $title Title
5279 * @param $options String
5280 * @param $holders LinkHolderArray|bool
5281 * @return string HTML
5282 */
5283 function makeImage( $title, $options, $holders = false ) {
5284 # Check if the options text is of the form "options|alt text"
5285 # Options are:
5286 # * thumbnail make a thumbnail with enlarge-icon and caption, alignment depends on lang
5287 # * left no resizing, just left align. label is used for alt= only
5288 # * right same, but right aligned
5289 # * none same, but not aligned
5290 # * ___px scale to ___ pixels width, no aligning. e.g. use in taxobox
5291 # * center center the image
5292 # * frame Keep original image size, no magnify-button.
5293 # * framed Same as "frame"
5294 # * frameless like 'thumb' but without a frame. Keeps user preferences for width
5295 # * upright reduce width for upright images, rounded to full __0 px
5296 # * border draw a 1px border around the image
5297 # * alt Text for HTML alt attribute (defaults to empty)
5298 # * class Set a class for img node
5299 # * link Set the target of the image link. Can be external, interwiki, or local
5300 # vertical-align values (no % or length right now):
5301 # * baseline
5302 # * sub
5303 # * super
5304 # * top
5305 # * text-top
5306 # * middle
5307 # * bottom
5308 # * text-bottom
5309
5310 $parts = StringUtils::explode( "|", $options );
5311
5312 # Give extensions a chance to select the file revision for us
5313 $options = array();
5314 $descQuery = false;
5315 wfRunHooks( 'BeforeParserFetchFileAndTitle',
5316 array( $this, $title, &$options, &$descQuery ) );
5317 # Fetch and register the file (file title may be different via hooks)
5318 list( $file, $title ) = $this->fetchFileAndTitle( $title, $options );
5319
5320 # Get parameter map
5321 $handler = $file ? $file->getHandler() : false;
5322
5323 list( $paramMap, $mwArray ) = $this->getImageParams( $handler );
5324
5325 if ( !$file ) {
5326 $this->addTrackingCategory( 'broken-file-category' );
5327 }
5328
5329 # Process the input parameters
5330 $caption = '';
5331 $params = array( 'frame' => array(), 'handler' => array(),
5332 'horizAlign' => array(), 'vertAlign' => array() );
5333 foreach ( $parts as $part ) {
5334 $part = trim( $part );
5335 list( $magicName, $value ) = $mwArray->matchVariableStartToEnd( $part );
5336 $validated = false;
5337 if ( isset( $paramMap[$magicName] ) ) {
5338 list( $type, $paramName ) = $paramMap[$magicName];
5339
5340 # Special case; width and height come in one variable together
5341 if ( $type === 'handler' && $paramName === 'width' ) {
5342 $parsedWidthParam = $this->parseWidthParam( $value );
5343 if ( isset( $parsedWidthParam['width'] ) ) {
5344 $width = $parsedWidthParam['width'];
5345 if ( $handler->validateParam( 'width', $width ) ) {
5346 $params[$type]['width'] = $width;
5347 $validated = true;
5348 }
5349 }
5350 if ( isset( $parsedWidthParam['height'] ) ) {
5351 $height = $parsedWidthParam['height'];
5352 if ( $handler->validateParam( 'height', $height ) ) {
5353 $params[$type]['height'] = $height;
5354 $validated = true;
5355 }
5356 }
5357 # else no validation -- bug 13436
5358 } else {
5359 if ( $type === 'handler' ) {
5360 # Validate handler parameter
5361 $validated = $handler->validateParam( $paramName, $value );
5362 } else {
5363 # Validate internal parameters
5364 switch ( $paramName ) {
5365 case 'manualthumb':
5366 case 'alt':
5367 case 'class':
5368 # @todo FIXME: Possibly check validity here for
5369 # manualthumb? downstream behavior seems odd with
5370 # missing manual thumbs.
5371 $validated = true;
5372 $value = $this->stripAltText( $value, $holders );
5373 break;
5374 case 'link':
5375 $chars = self::EXT_LINK_URL_CLASS;
5376 $prots = $this->mUrlProtocols;
5377 if ( $value === '' ) {
5378 $paramName = 'no-link';
5379 $value = true;
5380 $validated = true;
5381 } elseif ( preg_match( "/^(?i)$prots/", $value ) ) {
5382 if ( preg_match( "/^((?i)$prots)$chars+$/u", $value, $m ) ) {
5383 $paramName = 'link-url';
5384 $this->mOutput->addExternalLink( $value );
5385 if ( $this->mOptions->getExternalLinkTarget() ) {
5386 $params[$type]['link-target'] = $this->mOptions->getExternalLinkTarget();
5387 }
5388 $validated = true;
5389 }
5390 } else {
5391 $linkTitle = Title::newFromText( $value );
5392 if ( $linkTitle ) {
5393 $paramName = 'link-title';
5394 $value = $linkTitle;
5395 $this->mOutput->addLink( $linkTitle );
5396 $validated = true;
5397 }
5398 }
5399 break;
5400 default:
5401 # Most other things appear to be empty or numeric...
5402 $validated = ( $value === false || is_numeric( trim( $value ) ) );
5403 }
5404 }
5405
5406 if ( $validated ) {
5407 $params[$type][$paramName] = $value;
5408 }
5409 }
5410 }
5411 if ( !$validated ) {
5412 $caption = $part;
5413 }
5414 }
5415
5416 # Process alignment parameters
5417 if ( $params['horizAlign'] ) {
5418 $params['frame']['align'] = key( $params['horizAlign'] );
5419 }
5420 if ( $params['vertAlign'] ) {
5421 $params['frame']['valign'] = key( $params['vertAlign'] );
5422 }
5423
5424 $params['frame']['caption'] = $caption;
5425
5426 # Will the image be presented in a frame, with the caption below?
5427 $imageIsFramed = isset( $params['frame']['frame'] )
5428 || isset( $params['frame']['framed'] )
5429 || isset( $params['frame']['thumbnail'] )
5430 || isset( $params['frame']['manualthumb'] );
5431
5432 # In the old days, [[Image:Foo|text...]] would set alt text. Later it
5433 # came to also set the caption, ordinary text after the image -- which
5434 # makes no sense, because that just repeats the text multiple times in
5435 # screen readers. It *also* came to set the title attribute.
5436 #
5437 # Now that we have an alt attribute, we should not set the alt text to
5438 # equal the caption: that's worse than useless, it just repeats the
5439 # text. This is the framed/thumbnail case. If there's no caption, we
5440 # use the unnamed parameter for alt text as well, just for the time be-
5441 # ing, if the unnamed param is set and the alt param is not.
5442 #
5443 # For the future, we need to figure out if we want to tweak this more,
5444 # e.g., introducing a title= parameter for the title; ignoring the un-
5445 # named parameter entirely for images without a caption; adding an ex-
5446 # plicit caption= parameter and preserving the old magic unnamed para-
5447 # meter for BC; ...
5448 if ( $imageIsFramed ) { # Framed image
5449 if ( $caption === '' && !isset( $params['frame']['alt'] ) ) {
5450 # No caption or alt text, add the filename as the alt text so
5451 # that screen readers at least get some description of the image
5452 $params['frame']['alt'] = $title->getText();
5453 }
5454 # Do not set $params['frame']['title'] because tooltips don't make sense
5455 # for framed images
5456 } else { # Inline image
5457 if ( !isset( $params['frame']['alt'] ) ) {
5458 # No alt text, use the "caption" for the alt text
5459 if ( $caption !== '' ) {
5460 $params['frame']['alt'] = $this->stripAltText( $caption, $holders );
5461 } else {
5462 # No caption, fall back to using the filename for the
5463 # alt text
5464 $params['frame']['alt'] = $title->getText();
5465 }
5466 }
5467 # Use the "caption" for the tooltip text
5468 $params['frame']['title'] = $this->stripAltText( $caption, $holders );
5469 }
5470
5471 wfRunHooks( 'ParserMakeImageParams', array( $title, $file, &$params, $this ) );
5472
5473 # Linker does the rest
5474 $time = isset( $options['time'] ) ? $options['time'] : false;
5475 $ret = Linker::makeImageLink( $this, $title, $file, $params['frame'], $params['handler'],
5476 $time, $descQuery, $this->mOptions->getThumbSize() );
5477
5478 # Give the handler a chance to modify the parser object
5479 if ( $handler ) {
5480 $handler->parserTransformHook( $this, $file );
5481 }
5482
5483 return $ret;
5484 }
5485
5486 /**
5487 * @param $caption
5488 * @param $holders LinkHolderArray
5489 * @return mixed|String
5490 */
5491 protected function stripAltText( $caption, $holders ) {
5492 # Strip bad stuff out of the title (tooltip). We can't just use
5493 # replaceLinkHoldersText() here, because if this function is called
5494 # from replaceInternalLinks2(), mLinkHolders won't be up-to-date.
5495 if ( $holders ) {
5496 $tooltip = $holders->replaceText( $caption );
5497 } else {
5498 $tooltip = $this->replaceLinkHoldersText( $caption );
5499 }
5500
5501 # make sure there are no placeholders in thumbnail attributes
5502 # that are later expanded to html- so expand them now and
5503 # remove the tags
5504 $tooltip = $this->mStripState->unstripBoth( $tooltip );
5505 $tooltip = Sanitizer::stripAllTags( $tooltip );
5506
5507 return $tooltip;
5508 }
5509
5510 /**
5511 * Set a flag in the output object indicating that the content is dynamic and
5512 * shouldn't be cached.
5513 */
5514 function disableCache() {
5515 wfDebug( "Parser output marked as uncacheable.\n" );
5516 if ( !$this->mOutput ) {
5517 throw new MWException( __METHOD__ .
5518 " can only be called when actually parsing something" );
5519 }
5520 $this->mOutput->setCacheTime( -1 ); // old style, for compatibility
5521 $this->mOutput->updateCacheExpiry( 0 ); // new style, for consistency
5522 }
5523
5524 /**
5525 * Callback from the Sanitizer for expanding items found in HTML attribute
5526 * values, so they can be safely tested and escaped.
5527 *
5528 * @param $text String
5529 * @param $frame PPFrame
5530 * @return String
5531 */
5532 function attributeStripCallback( &$text, $frame = false ) {
5533 $text = $this->replaceVariables( $text, $frame );
5534 $text = $this->mStripState->unstripBoth( $text );
5535 return $text;
5536 }
5537
5538 /**
5539 * Accessor
5540 *
5541 * @return array
5542 */
5543 function getTags() {
5544 return array_merge( array_keys( $this->mTransparentTagHooks ), array_keys( $this->mTagHooks ), array_keys( $this->mFunctionTagHooks ) );
5545 }
5546
5547 /**
5548 * Replace transparent tags in $text with the values given by the callbacks.
5549 *
5550 * Transparent tag hooks are like regular XML-style tag hooks, except they
5551 * operate late in the transformation sequence, on HTML instead of wikitext.
5552 *
5553 * @param $text string
5554 *
5555 * @return string
5556 */
5557 function replaceTransparentTags( $text ) {
5558 $matches = array();
5559 $elements = array_keys( $this->mTransparentTagHooks );
5560 $text = self::extractTagsAndParams( $elements, $text, $matches, $this->mUniqPrefix );
5561 $replacements = array();
5562
5563 foreach ( $matches as $marker => $data ) {
5564 list( $element, $content, $params, $tag ) = $data;
5565 $tagName = strtolower( $element );
5566 if ( isset( $this->mTransparentTagHooks[$tagName] ) ) {
5567 $output = call_user_func_array( $this->mTransparentTagHooks[$tagName], array( $content, $params, $this ) );
5568 } else {
5569 $output = $tag;
5570 }
5571 $replacements[$marker] = $output;
5572 }
5573 return strtr( $text, $replacements );
5574 }
5575
5576 /**
5577 * Break wikitext input into sections, and either pull or replace
5578 * some particular section's text.
5579 *
5580 * External callers should use the getSection and replaceSection methods.
5581 *
5582 * @param string $text Page wikitext
5583 * @param string $section a section identifier string of the form:
5584 * "<flag1> - <flag2> - ... - <section number>"
5585 *
5586 * Currently the only recognised flag is "T", which means the target section number
5587 * was derived during a template inclusion parse, in other words this is a template
5588 * section edit link. If no flags are given, it was an ordinary section edit link.
5589 * This flag is required to avoid a section numbering mismatch when a section is
5590 * enclosed by "<includeonly>" (bug 6563).
5591 *
5592 * The section number 0 pulls the text before the first heading; other numbers will
5593 * pull the given section along with its lower-level subsections. If the section is
5594 * not found, $mode=get will return $newtext, and $mode=replace will return $text.
5595 *
5596 * Section 0 is always considered to exist, even if it only contains the empty
5597 * string. If $text is the empty string and section 0 is replaced, $newText is
5598 * returned.
5599 *
5600 * @param string $mode one of "get" or "replace"
5601 * @param string $newText replacement text for section data.
5602 * @return String: for "get", the extracted section text.
5603 * for "replace", the whole page with the section replaced.
5604 */
5605 private function extractSections( $text, $section, $mode, $newText = '' ) {
5606 global $wgTitle; # not generally used but removes an ugly failure mode
5607 $this->startParse( $wgTitle, new ParserOptions, self::OT_PLAIN, true );
5608 $outText = '';
5609 $frame = $this->getPreprocessor()->newFrame();
5610
5611 # Process section extraction flags
5612 $flags = 0;
5613 $sectionParts = explode( '-', $section );
5614 $sectionIndex = array_pop( $sectionParts );
5615 foreach ( $sectionParts as $part ) {
5616 if ( $part === 'T' ) {
5617 $flags |= self::PTD_FOR_INCLUSION;
5618 }
5619 }
5620
5621 # Check for empty input
5622 if ( strval( $text ) === '' ) {
5623 # Only sections 0 and T-0 exist in an empty document
5624 if ( $sectionIndex == 0 ) {
5625 if ( $mode === 'get' ) {
5626 return '';
5627 } else {
5628 return $newText;
5629 }
5630 } else {
5631 if ( $mode === 'get' ) {
5632 return $newText;
5633 } else {
5634 return $text;
5635 }
5636 }
5637 }
5638
5639 # Preprocess the text
5640 $root = $this->preprocessToDom( $text, $flags );
5641
5642 # <h> nodes indicate section breaks
5643 # They can only occur at the top level, so we can find them by iterating the root's children
5644 $node = $root->getFirstChild();
5645
5646 # Find the target section
5647 if ( $sectionIndex == 0 ) {
5648 # Section zero doesn't nest, level=big
5649 $targetLevel = 1000;
5650 } else {
5651 while ( $node ) {
5652 if ( $node->getName() === 'h' ) {
5653 $bits = $node->splitHeading();
5654 if ( $bits['i'] == $sectionIndex ) {
5655 $targetLevel = $bits['level'];
5656 break;
5657 }
5658 }
5659 if ( $mode === 'replace' ) {
5660 $outText .= $frame->expand( $node, PPFrame::RECOVER_ORIG );
5661 }
5662 $node = $node->getNextSibling();
5663 }
5664 }
5665
5666 if ( !$node ) {
5667 # Not found
5668 if ( $mode === 'get' ) {
5669 return $newText;
5670 } else {
5671 return $text;
5672 }
5673 }
5674
5675 # Find the end of the section, including nested sections
5676 do {
5677 if ( $node->getName() === 'h' ) {
5678 $bits = $node->splitHeading();
5679 $curLevel = $bits['level'];
5680 if ( $bits['i'] != $sectionIndex && $curLevel <= $targetLevel ) {
5681 break;
5682 }
5683 }
5684 if ( $mode === 'get' ) {
5685 $outText .= $frame->expand( $node, PPFrame::RECOVER_ORIG );
5686 }
5687 $node = $node->getNextSibling();
5688 } while ( $node );
5689
5690 # Write out the remainder (in replace mode only)
5691 if ( $mode === 'replace' ) {
5692 # Output the replacement text
5693 # Add two newlines on -- trailing whitespace in $newText is conventionally
5694 # stripped by the editor, so we need both newlines to restore the paragraph gap
5695 # Only add trailing whitespace if there is newText
5696 if ( $newText != "" ) {
5697 $outText .= $newText . "\n\n";
5698 }
5699
5700 while ( $node ) {
5701 $outText .= $frame->expand( $node, PPFrame::RECOVER_ORIG );
5702 $node = $node->getNextSibling();
5703 }
5704 }
5705
5706 if ( is_string( $outText ) ) {
5707 # Re-insert stripped tags
5708 $outText = rtrim( $this->mStripState->unstripBoth( $outText ) );
5709 }
5710
5711 return $outText;
5712 }
5713
5714 /**
5715 * This function returns the text of a section, specified by a number ($section).
5716 * A section is text under a heading like == Heading == or \<h1\>Heading\</h1\>, or
5717 * the first section before any such heading (section 0).
5718 *
5719 * If a section contains subsections, these are also returned.
5720 *
5721 * @param string $text text to look in
5722 * @param string $section section identifier
5723 * @param string $deftext default to return if section is not found
5724 * @return string text of the requested section
5725 */
5726 public function getSection( $text, $section, $deftext = '' ) {
5727 return $this->extractSections( $text, $section, "get", $deftext );
5728 }
5729
5730 /**
5731 * This function returns $oldtext after the content of the section
5732 * specified by $section has been replaced with $text. If the target
5733 * section does not exist, $oldtext is returned unchanged.
5734 *
5735 * @param string $oldtext former text of the article
5736 * @param int $section section identifier
5737 * @param string $text replacing text
5738 * @return String: modified text
5739 */
5740 public function replaceSection( $oldtext, $section, $text ) {
5741 return $this->extractSections( $oldtext, $section, "replace", $text );
5742 }
5743
5744 /**
5745 * Get the ID of the revision we are parsing
5746 *
5747 * @return Mixed: integer or null
5748 */
5749 function getRevisionId() {
5750 return $this->mRevisionId;
5751 }
5752
5753 /**
5754 * Get the revision object for $this->mRevisionId
5755 *
5756 * @return Revision|null either a Revision object or null
5757 * @since 1.23 (public since 1.23)
5758 */
5759 public function getRevisionObject() {
5760 if ( !is_null( $this->mRevisionObject ) ) {
5761 return $this->mRevisionObject;
5762 }
5763 if ( is_null( $this->mRevisionId ) ) {
5764 return null;
5765 }
5766
5767 $this->mRevisionObject = Revision::newFromId( $this->mRevisionId );
5768 return $this->mRevisionObject;
5769 }
5770
5771 /**
5772 * Get the timestamp associated with the current revision, adjusted for
5773 * the default server-local timestamp
5774 */
5775 function getRevisionTimestamp() {
5776 if ( is_null( $this->mRevisionTimestamp ) ) {
5777 wfProfileIn( __METHOD__ );
5778
5779 global $wgContLang;
5780
5781 $revObject = $this->getRevisionObject();
5782 $timestamp = $revObject ? $revObject->getTimestamp() : wfTimestampNow();
5783
5784 # The cryptic '' timezone parameter tells to use the site-default
5785 # timezone offset instead of the user settings.
5786 #
5787 # Since this value will be saved into the parser cache, served
5788 # to other users, and potentially even used inside links and such,
5789 # it needs to be consistent for all visitors.
5790 $this->mRevisionTimestamp = $wgContLang->userAdjust( $timestamp, '' );
5791
5792 wfProfileOut( __METHOD__ );
5793 }
5794 return $this->mRevisionTimestamp;
5795 }
5796
5797 /**
5798 * Get the name of the user that edited the last revision
5799 *
5800 * @return String: user name
5801 */
5802 function getRevisionUser() {
5803 if ( is_null( $this->mRevisionUser ) ) {
5804 $revObject = $this->getRevisionObject();
5805
5806 # if this template is subst: the revision id will be blank,
5807 # so just use the current user's name
5808 if ( $revObject ) {
5809 $this->mRevisionUser = $revObject->getUserText();
5810 } elseif ( $this->ot['wiki'] || $this->mOptions->getIsPreview() ) {
5811 $this->mRevisionUser = $this->getUser()->getName();
5812 }
5813 }
5814 return $this->mRevisionUser;
5815 }
5816
5817 /**
5818 * Get the size of the revision
5819 *
5820 * @return int|null revision size
5821 */
5822 function getRevisionSize() {
5823 if ( is_null( $this->mRevisionSize ) ) {
5824 $revObject = $this->getRevisionObject();
5825
5826 # if this variable is subst: the revision id will be blank,
5827 # so just use the parser input size, because the own substituation
5828 # will change the size.
5829 if ( $revObject ) {
5830 $this->mRevisionSize = $revObject->getSize();
5831 } elseif ( $this->ot['wiki'] || $this->mOptions->getIsPreview() ) {
5832 $this->mRevisionSize = $this->mInputSize;
5833 }
5834 }
5835 return $this->mRevisionSize;
5836 }
5837
5838 /**
5839 * Mutator for $mDefaultSort
5840 *
5841 * @param string $sort New value
5842 */
5843 public function setDefaultSort( $sort ) {
5844 $this->mDefaultSort = $sort;
5845 $this->mOutput->setProperty( 'defaultsort', $sort );
5846 }
5847
5848 /**
5849 * Accessor for $mDefaultSort
5850 * Will use the empty string if none is set.
5851 *
5852 * This value is treated as a prefix, so the
5853 * empty string is equivalent to sorting by
5854 * page name.
5855 *
5856 * @return string
5857 */
5858 public function getDefaultSort() {
5859 if ( $this->mDefaultSort !== false ) {
5860 return $this->mDefaultSort;
5861 } else {
5862 return '';
5863 }
5864 }
5865
5866 /**
5867 * Accessor for $mDefaultSort
5868 * Unlike getDefaultSort(), will return false if none is set
5869 *
5870 * @return string or false
5871 */
5872 public function getCustomDefaultSort() {
5873 return $this->mDefaultSort;
5874 }
5875
5876 /**
5877 * Try to guess the section anchor name based on a wikitext fragment
5878 * presumably extracted from a heading, for example "Header" from
5879 * "== Header ==".
5880 *
5881 * @param $text string
5882 *
5883 * @return string
5884 */
5885 public function guessSectionNameFromWikiText( $text ) {
5886 # Strip out wikitext links(they break the anchor)
5887 $text = $this->stripSectionName( $text );
5888 $text = Sanitizer::normalizeSectionNameWhitespace( $text );
5889 return '#' . Sanitizer::escapeId( $text, 'noninitial' );
5890 }
5891
5892 /**
5893 * Same as guessSectionNameFromWikiText(), but produces legacy anchors
5894 * instead. For use in redirects, since IE6 interprets Redirect: headers
5895 * as something other than UTF-8 (apparently?), resulting in breakage.
5896 *
5897 * @param string $text The section name
5898 * @return string An anchor
5899 */
5900 public function guessLegacySectionNameFromWikiText( $text ) {
5901 # Strip out wikitext links(they break the anchor)
5902 $text = $this->stripSectionName( $text );
5903 $text = Sanitizer::normalizeSectionNameWhitespace( $text );
5904 return '#' . Sanitizer::escapeId( $text, array( 'noninitial', 'legacy' ) );
5905 }
5906
5907 /**
5908 * Strips a text string of wikitext for use in a section anchor
5909 *
5910 * Accepts a text string and then removes all wikitext from the
5911 * string and leaves only the resultant text (i.e. the result of
5912 * [[User:WikiSysop|Sysop]] would be "Sysop" and the result of
5913 * [[User:WikiSysop]] would be "User:WikiSysop") - this is intended
5914 * to create valid section anchors by mimicing the output of the
5915 * parser when headings are parsed.
5916 *
5917 * @param string $text text string to be stripped of wikitext
5918 * for use in a Section anchor
5919 * @return string Filtered text string
5920 */
5921 public function stripSectionName( $text ) {
5922 # Strip internal link markup
5923 $text = preg_replace( '/\[\[:?([^[|]+)\|([^[]+)\]\]/', '$2', $text );
5924 $text = preg_replace( '/\[\[:?([^[]+)\|?\]\]/', '$1', $text );
5925
5926 # Strip external link markup
5927 # @todo FIXME: Not tolerant to blank link text
5928 # I.E. [http://www.mediawiki.org] will render as [1] or something depending
5929 # on how many empty links there are on the page - need to figure that out.
5930 $text = preg_replace( '/\[(?i:' . $this->mUrlProtocols . ')([^ ]+?) ([^[]+)\]/', '$2', $text );
5931
5932 # Parse wikitext quotes (italics & bold)
5933 $text = $this->doQuotes( $text );
5934
5935 # Strip HTML tags
5936 $text = StringUtils::delimiterReplace( '<', '>', '', $text );
5937 return $text;
5938 }
5939
5940 /**
5941 * strip/replaceVariables/unstrip for preprocessor regression testing
5942 *
5943 * @param $text string
5944 * @param $title Title
5945 * @param $options ParserOptions
5946 * @param $outputType int
5947 *
5948 * @return string
5949 */
5950 function testSrvus( $text, Title $title, ParserOptions $options, $outputType = self::OT_HTML ) {
5951 $this->startParse( $title, $options, $outputType, true );
5952
5953 $text = $this->replaceVariables( $text );
5954 $text = $this->mStripState->unstripBoth( $text );
5955 $text = Sanitizer::removeHTMLtags( $text );
5956 return $text;
5957 }
5958
5959 /**
5960 * @param $text string
5961 * @param $title Title
5962 * @param $options ParserOptions
5963 * @return string
5964 */
5965 function testPst( $text, Title $title, ParserOptions $options ) {
5966 return $this->preSaveTransform( $text, $title, $options->getUser(), $options );
5967 }
5968
5969 /**
5970 * @param $text
5971 * @param $title Title
5972 * @param $options ParserOptions
5973 * @return string
5974 */
5975 function testPreprocess( $text, Title $title, ParserOptions $options ) {
5976 return $this->testSrvus( $text, $title, $options, self::OT_PREPROCESS );
5977 }
5978
5979 /**
5980 * Call a callback function on all regions of the given text that are not
5981 * inside strip markers, and replace those regions with the return value
5982 * of the callback. For example, with input:
5983 *
5984 * aaa<MARKER>bbb
5985 *
5986 * This will call the callback function twice, with 'aaa' and 'bbb'. Those
5987 * two strings will be replaced with the value returned by the callback in
5988 * each case.
5989 *
5990 * @param $s string
5991 * @param $callback
5992 *
5993 * @return string
5994 */
5995 function markerSkipCallback( $s, $callback ) {
5996 $i = 0;
5997 $out = '';
5998 while ( $i < strlen( $s ) ) {
5999 $markerStart = strpos( $s, $this->mUniqPrefix, $i );
6000 if ( $markerStart === false ) {
6001 $out .= call_user_func( $callback, substr( $s, $i ) );
6002 break;
6003 } else {
6004 $out .= call_user_func( $callback, substr( $s, $i, $markerStart - $i ) );
6005 $markerEnd = strpos( $s, self::MARKER_SUFFIX, $markerStart );
6006 if ( $markerEnd === false ) {
6007 $out .= substr( $s, $markerStart );
6008 break;
6009 } else {
6010 $markerEnd += strlen( self::MARKER_SUFFIX );
6011 $out .= substr( $s, $markerStart, $markerEnd - $markerStart );
6012 $i = $markerEnd;
6013 }
6014 }
6015 }
6016 return $out;
6017 }
6018
6019 /**
6020 * Remove any strip markers found in the given text.
6021 *
6022 * @param $text Input string
6023 * @return string
6024 */
6025 function killMarkers( $text ) {
6026 return $this->mStripState->killMarkers( $text );
6027 }
6028
6029 /**
6030 * Save the parser state required to convert the given half-parsed text to
6031 * HTML. "Half-parsed" in this context means the output of
6032 * recursiveTagParse() or internalParse(). This output has strip markers
6033 * from replaceVariables (extensionSubstitution() etc.), and link
6034 * placeholders from replaceLinkHolders().
6035 *
6036 * Returns an array which can be serialized and stored persistently. This
6037 * array can later be loaded into another parser instance with
6038 * unserializeHalfParsedText(). The text can then be safely incorporated into
6039 * the return value of a parser hook.
6040 *
6041 * @param $text string
6042 *
6043 * @return array
6044 */
6045 function serializeHalfParsedText( $text ) {
6046 wfProfileIn( __METHOD__ );
6047 $data = array(
6048 'text' => $text,
6049 'version' => self::HALF_PARSED_VERSION,
6050 'stripState' => $this->mStripState->getSubState( $text ),
6051 'linkHolders' => $this->mLinkHolders->getSubArray( $text )
6052 );
6053 wfProfileOut( __METHOD__ );
6054 return $data;
6055 }
6056
6057 /**
6058 * Load the parser state given in the $data array, which is assumed to
6059 * have been generated by serializeHalfParsedText(). The text contents is
6060 * extracted from the array, and its markers are transformed into markers
6061 * appropriate for the current Parser instance. This transformed text is
6062 * returned, and can be safely included in the return value of a parser
6063 * hook.
6064 *
6065 * If the $data array has been stored persistently, the caller should first
6066 * check whether it is still valid, by calling isValidHalfParsedText().
6067 *
6068 * @param array $data Serialized data
6069 * @throws MWException
6070 * @return String
6071 */
6072 function unserializeHalfParsedText( $data ) {
6073 if ( !isset( $data['version'] ) || $data['version'] != self::HALF_PARSED_VERSION ) {
6074 throw new MWException( __METHOD__ . ': invalid version' );
6075 }
6076
6077 # First, extract the strip state.
6078 $texts = array( $data['text'] );
6079 $texts = $this->mStripState->merge( $data['stripState'], $texts );
6080
6081 # Now renumber links
6082 $texts = $this->mLinkHolders->mergeForeign( $data['linkHolders'], $texts );
6083
6084 # Should be good to go.
6085 return $texts[0];
6086 }
6087
6088 /**
6089 * Returns true if the given array, presumed to be generated by
6090 * serializeHalfParsedText(), is compatible with the current version of the
6091 * parser.
6092 *
6093 * @param $data Array
6094 *
6095 * @return bool
6096 */
6097 function isValidHalfParsedText( $data ) {
6098 return isset( $data['version'] ) && $data['version'] == self::HALF_PARSED_VERSION;
6099 }
6100
6101 /**
6102 * Parsed a width param of imagelink like 300px or 200x300px
6103 *
6104 * @param $value String
6105 *
6106 * @return array
6107 * @since 1.20
6108 */
6109 public function parseWidthParam( $value ) {
6110 $parsedWidthParam = array();
6111 if ( $value === '' ) {
6112 return $parsedWidthParam;
6113 }
6114 $m = array();
6115 # (bug 13500) In both cases (width/height and width only),
6116 # permit trailing "px" for backward compatibility.
6117 if ( preg_match( '/^([0-9]*)x([0-9]*)\s*(?:px)?\s*$/', $value, $m ) ) {
6118 $width = intval( $m[1] );
6119 $height = intval( $m[2] );
6120 $parsedWidthParam['width'] = $width;
6121 $parsedWidthParam['height'] = $height;
6122 } elseif ( preg_match( '/^[0-9]*\s*(?:px)?\s*$/', $value ) ) {
6123 $width = intval( $value );
6124 $parsedWidthParam['width'] = $width;
6125 }
6126 return $parsedWidthParam;
6127 }
6128 }
Wiklou, le Wiki du Wiklou