dépôts / lhc / web / wiklou.git / blob
? search:


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