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