1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
|
<?php
/**
* Content object for wiki text pages.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @since 1.21
*
* @file
* @ingroup Content
*
* @author Daniel Kinzler
*/
use MediaWiki\Logger\LoggerFactory;
use MediaWiki\MediaWikiServices;
/**
* Content object for wiki text pages.
*
* @newable
* @ingroup Content
*/
class WikitextContent extends TextContent {
private $redirectTargetAndText = null;
/**
* @var bool Tracks if the parser set the user-signature flag when creating this content, which
* would make it expire faster in ApiStashEdit.
*/
private $hadSignature = false;
/**
* @var string|null Stack trace of the previous parse
*/
private $previousParseStackTrace = null;
/**
* @stable to call
*
* @param string $text
*/
public function __construct( $text ) {
parent::__construct( $text, CONTENT_MODEL_WIKITEXT );
}
/**
* @param string|int $sectionId
*
* @return Content|bool|null
*
* @see Content::getSection()
*/
public function getSection( $sectionId ) {
$text = $this->getText();
$sect = MediaWikiServices::getInstance()->getParser()
->getSection( $text, $sectionId, false );
if ( $sect === false ) {
return false;
} else {
return new static( $sect );
}
}
/**
* @param string|int|null|bool $sectionId
* @param Content $with
* @param string $sectionTitle
*
* @throws MWException
* @return Content
*
* @see Content::replaceSection()
*/
public function replaceSection( $sectionId, Content $with, $sectionTitle = '' ) {
$myModelId = $this->getModel();
$sectionModelId = $with->getModel();
if ( $sectionModelId != $myModelId ) {
throw new MWException( "Incompatible content model for section: " .
"document uses $myModelId but " .
"section uses $sectionModelId." );
}
/** @var self $with $oldtext */
'@phan-var self $with';
$oldtext = $this->getText();
$text = $with->getText();
if ( strval( $sectionId ) === '' ) {
return $with; # XXX: copy first?
}
if ( $sectionId === 'new' ) {
# Inserting a new section
$subject = strval( $sectionTitle ) !== '' ? wfMessage( 'newsectionheaderdefaultlevel' )
->plaintextParams( $sectionTitle )->inContentLanguage()->text() . "\n\n" : '';
if ( Hooks::runner()->onPlaceNewSection( $this, $oldtext, $subject, $text ) ) {
$text = strlen( trim( $oldtext ) ) > 0
? "{$oldtext}\n\n{$subject}{$text}"
: "{$subject}{$text}";
}
} else {
# Replacing an existing section; roll out the big guns
$text = MediaWikiServices::getInstance()->getParser()
->replaceSection( $oldtext, $sectionId, $text );
}
$newContent = new static( $text );
return $newContent;
}
/**
* Returns a new WikitextContent object with the given section heading
* prepended.
*
* @param string $header
*
* @return Content
*/
public function addSectionHeader( $header ) {
$text = wfMessage( 'newsectionheaderdefaultlevel' )
->rawParams( $header )->inContentLanguage()->text();
$text .= "\n\n";
$text .= $this->getText();
return new static( $text );
}
/**
* Returns a Content object with pre-save transformations applied using
* Parser::preSaveTransform().
*
* @param Title $title
* @param User $user
* @param ParserOptions $popts
*
* @return Content
*/
public function preSaveTransform( Title $title, User $user, ParserOptions $popts ) {
$text = $this->getText();
$parser = MediaWikiServices::getInstance()->getParser();
$pst = $parser->preSaveTransform( $text, $title, $user, $popts );
if ( $text === $pst ) {
return $this;
}
$ret = new static( $pst );
if ( $parser->getOutput()->getFlag( 'user-signature' ) ) {
$ret->hadSignature = true;
}
return $ret;
}
/**
* Returns a Content object with preload transformations applied (or this
* object if no transformations apply).
*
* @param Title $title
* @param ParserOptions $popts
* @param array $params
*
* @return Content
*/
public function preloadTransform( Title $title, ParserOptions $popts, $params = [] ) {
$text = $this->getText();
$plt = MediaWikiServices::getInstance()->getParser()
->getPreloadText( $text, $title, $popts, $params );
return new static( $plt );
}
/**
* Extract the redirect target and the remaining text on the page.
*
* @note migrated here from Title::newFromRedirectInternal()
*
* @since 1.23
*
* @return array List of two elements: Title|null and string.
*/
protected function getRedirectTargetAndText() {
global $wgMaxRedirects;
if ( $this->redirectTargetAndText !== null ) {
return $this->redirectTargetAndText;
}
if ( $wgMaxRedirects < 1 ) {
// redirects are disabled, so quit early
$this->redirectTargetAndText = [ null, $this->getText() ];
return $this->redirectTargetAndText;
}
$redir = MediaWikiServices::getInstance()->getMagicWordFactory()->get( 'redirect' );
$text = ltrim( $this->getText() );
if ( $redir->matchStartAndRemove( $text ) ) {
// Extract the first link and see if it's usable
// Ensure that it really does come directly after #REDIRECT
// Some older redirects included a colon, so don't freak about that!
$m = [];
if ( preg_match( '!^\s*:?\s*\[{2}(.*?)(?:\|.*?)?\]{2}\s*!', $text, $m ) ) {
// Strip preceding colon used to "escape" categories, etc.
// and URL-decode links
if ( strpos( $m[1], '%' ) !== false ) {
// Match behavior of inline link parsing here;
$m[1] = rawurldecode( ltrim( $m[1], ':' ) );
}
$title = Title::newFromText( $m[1] );
// If the title is a redirect to bad special pages or is invalid, return null
if ( !$title instanceof Title || !$title->isValidRedirectTarget() ) {
$this->redirectTargetAndText = [ null, $this->getText() ];
return $this->redirectTargetAndText;
}
$this->redirectTargetAndText = [ $title, substr( $text, strlen( $m[0] ) ) ];
return $this->redirectTargetAndText;
}
}
$this->redirectTargetAndText = [ null, $this->getText() ];
return $this->redirectTargetAndText;
}
/**
* Implement redirect extraction for wikitext.
*
* @return Title|null
*
* @see Content::getRedirectTarget
*/
public function getRedirectTarget() {
list( $title, ) = $this->getRedirectTargetAndText();
return $title;
}
/**
* This implementation replaces the first link on the page with the given new target
* if this Content object is a redirect. Otherwise, this method returns $this.
*
* @since 1.21
*
* @param Title $target
*
* @return Content
*
* @see Content::updateRedirect()
*/
public function updateRedirect( Title $target ) {
if ( !$this->isRedirect() ) {
return $this;
}
# Fix the text
# Remember that redirect pages can have categories, templates, etc.,
# so the regex has to be fairly general
$newText = preg_replace( '/ \[ \[ [^\]]* \] \] /x',
'[[' . $target->getFullText() . ']]',
$this->getText(), 1 );
return new static( $newText );
}
/**
* Returns true if this content is not a redirect, and this content's text
* is countable according to the criteria defined by $wgArticleCountMethod.
*
* @param bool|null $hasLinks If it is known whether this content contains
* links, provide this information here, to avoid redundant parsing to
* find out (default: null).
* @param Title|null $title Optional title, defaults to the title from the current main request.
*
* @return bool
*/
public function isCountable( $hasLinks = null, Title $title = null ) {
global $wgArticleCountMethod;
if ( $this->isRedirect() ) {
return false;
}
if ( $wgArticleCountMethod === 'link' ) {
if ( $hasLinks === null ) { # not known, find out
if ( !$title ) {
$context = RequestContext::getMain();
$title = $context->getTitle();
}
$po = $this->getParserOutput( $title, null, null, false );
$links = $po->getLinks();
$hasLinks = !empty( $links );
}
return $hasLinks;
}
return true;
}
/**
* @param int $maxlength
* @return string
*/
public function getTextForSummary( $maxlength = 250 ) {
$truncatedtext = parent::getTextForSummary( $maxlength );
# clean up unfinished links
# XXX: make this optional? wasn't there in autosummary, but required for
# deletion summary.
$truncatedtext = preg_replace( '/\[\[([^\]]*)\]?$/', '$1', $truncatedtext );
return $truncatedtext;
}
/**
* Returns a ParserOutput object resulting from parsing the content's text
* using the global Parser service.
*
* @param Title $title
* @param int|null $revId ID of the revision being rendered.
* See Parser::parse() for the ramifications. (default: null)
* @param ParserOptions $options (default: null)
* @param bool $generateHtml (default: true)
* @param ParserOutput &$output ParserOutput representing the HTML form of the text,
* may be manipulated or replaced.
*/
protected function fillParserOutput( Title $title, $revId,
ParserOptions $options, $generateHtml, ParserOutput &$output
) {
$stackTrace = ( new RuntimeException() )->getTraceAsString();
if ( $this->previousParseStackTrace ) {
// NOTE: there may be legitimate changes to re-parse the same WikiText content,
// e.g. if predicted revision ID for the REVISIONID magic word mismatched.
// But that should be rare.
$logger = LoggerFactory::getInstance( 'DuplicateParse' );
$logger->debug(
__METHOD__ . ': Possibly redundant parse!',
[
'title' => $title->getPrefixedDBkey(),
'rev' => $revId,
'options-hash' => $options->optionsHash(
ParserOptions::allCacheVaryingOptions(),
$title
),
'trace' => $stackTrace,
'previous-trace' => $this->previousParseStackTrace,
]
);
}
$this->previousParseStackTrace = $stackTrace;
list( $redir, $text ) = $this->getRedirectTargetAndText();
$output = MediaWikiServices::getInstance()->getParser()
->parse( $text, $title, $options, true, true, $revId );
// Add redirect indicator at the top
if ( $redir ) {
// Make sure to include the redirect link in pagelinks
$output->addLink( $redir );
if ( $generateHtml ) {
$chain = $this->getRedirectChain();
$output->setText(
Article::getRedirectHeaderHtml( $title->getPageLanguage(), $chain, false ) .
$output->getRawText()
);
$output->addModuleStyles( 'mediawiki.action.view.redirectPage' );
}
}
// Pass along user-signature flag
if ( $this->hadSignature ) {
$output->setFlag( 'user-signature' );
}
}
/**
* @throws MWException
*/
protected function getHtml() {
throw new MWException(
"getHtml() not implemented for wikitext. "
. "Use getParserOutput()->getText()."
);
}
/**
* This implementation calls $word->match() on the this TextContent object's text.
*
* @param MagicWord $word
*
* @return bool
*
* @see Content::matchMagicWord()
*/
public function matchMagicWord( MagicWord $word ) {
return $word->match( $this->getText() );
}
}
|