3 * Content object for wiki text pages.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
25 * @author Daniel Kinzler
28 use MediaWiki\MediaWikiServices
;
31 * Content object for wiki text pages.
35 class WikitextContent
extends TextContent
{
36 private $redirectTargetAndText = null;
38 public function __construct( $text ) {
39 parent
::__construct( $text, CONTENT_MODEL_WIKITEXT
);
43 * @param string|int $sectionId
45 * @return Content|bool|null
47 * @see Content::getSection()
49 public function getSection( $sectionId ) {
52 $text = $this->getNativeData();
53 $sect = $wgParser->getSection( $text, $sectionId, false );
55 if ( $sect === false ) {
58 return new static( $sect );
63 * @param string|int|null|bool $sectionId
64 * @param Content $with
65 * @param string $sectionTitle
70 * @see Content::replaceSection()
72 public function replaceSection( $sectionId, Content
$with, $sectionTitle = '' ) {
73 $myModelId = $this->getModel();
74 $sectionModelId = $with->getModel();
76 if ( $sectionModelId != $myModelId ) {
77 throw new MWException( "Incompatible content model for section: " .
78 "document uses $myModelId but " .
79 "section uses $sectionModelId." );
82 $oldtext = $this->getNativeData();
83 $text = $with->getNativeData();
85 if ( strval( $sectionId ) === '' ) {
86 return $with; # XXX: copy first?
89 if ( $sectionId === 'new' ) {
90 # Inserting a new section
91 $subject = $sectionTitle ?
wfMessage( 'newsectionheaderdefaultlevel' )
92 ->plaintextParams( $sectionTitle )->inContentLanguage()->text() . "\n\n" : '';
93 if ( Hooks
::run( 'PlaceNewSection', [ $this, $oldtext, $subject, &$text ] ) ) {
94 $text = strlen( trim( $oldtext ) ) > 0
95 ?
"{$oldtext}\n\n{$subject}{$text}"
96 : "{$subject}{$text}";
99 # Replacing an existing section; roll out the big guns
102 $text = $wgParser->replaceSection( $oldtext, $sectionId, $text );
105 $newContent = new static( $text );
111 * Returns a new WikitextContent object with the given section heading
114 * @param string $header
118 public function addSectionHeader( $header ) {
119 $text = wfMessage( 'newsectionheaderdefaultlevel' )
120 ->rawParams( $header )->inContentLanguage()->text();
122 $text .= $this->getNativeData();
124 return new static( $text );
128 * Returns a Content object with pre-save transformations applied using
129 * Parser::preSaveTransform().
131 * @param Title $title
133 * @param ParserOptions $popts
137 public function preSaveTransform( Title
$title, User
$user, ParserOptions
$popts ) {
140 $text = $this->getNativeData();
141 $pst = $wgParser->preSaveTransform( $text, $title, $user, $popts );
143 return ( $text === $pst ) ?
$this : new static( $pst );
147 * Returns a Content object with preload transformations applied (or this
148 * object if no transformations apply).
150 * @param Title $title
151 * @param ParserOptions $popts
152 * @param array $params
156 public function preloadTransform( Title
$title, ParserOptions
$popts, $params = [] ) {
159 $text = $this->getNativeData();
160 $plt = $wgParser->getPreloadText( $text, $title, $popts, $params );
162 return new static( $plt );
166 * Extract the redirect target and the remaining text on the page.
168 * @note migrated here from Title::newFromRedirectInternal()
172 * @return array List of two elements: Title|null and string.
174 protected function getRedirectTargetAndText() {
175 global $wgMaxRedirects;
177 if ( $this->redirectTargetAndText
!== null ) {
178 return $this->redirectTargetAndText
;
181 if ( $wgMaxRedirects < 1 ) {
182 // redirects are disabled, so quit early
183 $this->redirectTargetAndText
= [ null, $this->getNativeData() ];
184 return $this->redirectTargetAndText
;
187 $redir = MediaWikiServices
::getInstance()->getMagicWordFactory()->get( 'redirect' );
188 $text = ltrim( $this->getNativeData() );
189 if ( $redir->matchStartAndRemove( $text ) ) {
190 // Extract the first link and see if it's usable
191 // Ensure that it really does come directly after #REDIRECT
192 // Some older redirects included a colon, so don't freak about that!
194 if ( preg_match( '!^\s*:?\s*\[{2}(.*?)(?:\|.*?)?\]{2}\s*!', $text, $m ) ) {
195 // Strip preceding colon used to "escape" categories, etc.
196 // and URL-decode links
197 if ( strpos( $m[1], '%' ) !== false ) {
198 // Match behavior of inline link parsing here;
199 $m[1] = rawurldecode( ltrim( $m[1], ':' ) );
201 $title = Title
::newFromText( $m[1] );
202 // If the title is a redirect to bad special pages or is invalid, return null
203 if ( !$title instanceof Title ||
!$title->isValidRedirectTarget() ) {
204 $this->redirectTargetAndText
= [ null, $this->getNativeData() ];
205 return $this->redirectTargetAndText
;
208 $this->redirectTargetAndText
= [ $title, substr( $text, strlen( $m[0] ) ) ];
209 return $this->redirectTargetAndText
;
213 $this->redirectTargetAndText
= [ null, $this->getNativeData() ];
214 return $this->redirectTargetAndText
;
218 * Implement redirect extraction for wikitext.
222 * @see Content::getRedirectTarget
224 public function getRedirectTarget() {
225 list( $title, ) = $this->getRedirectTargetAndText();
231 * This implementation replaces the first link on the page with the given new target
232 * if this Content object is a redirect. Otherwise, this method returns $this.
236 * @param Title $target
240 * @see Content::updateRedirect()
242 public function updateRedirect( Title
$target ) {
243 if ( !$this->isRedirect() ) {
248 # Remember that redirect pages can have categories, templates, etc.,
249 # so the regex has to be fairly general
250 $newText = preg_replace( '/ \[ \[ [^\]]* \] \] /x',
251 '[[' . $target->getFullText() . ']]',
252 $this->getNativeData(), 1 );
254 return new static( $newText );
258 * Returns true if this content is not a redirect, and this content's text
259 * is countable according to the criteria defined by $wgArticleCountMethod.
261 * @param bool|null $hasLinks If it is known whether this content contains
262 * links, provide this information here, to avoid redundant parsing to
263 * find out (default: null).
264 * @param Title|null $title Optional title, defaults to the title from the current main request.
268 public function isCountable( $hasLinks = null, Title
$title = null ) {
269 global $wgArticleCountMethod;
271 if ( $this->isRedirect() ) {
275 if ( $wgArticleCountMethod === 'link' ) {
276 if ( $hasLinks === null ) { # not known, find out
278 $context = RequestContext
::getMain();
279 $title = $context->getTitle();
282 $po = $this->getParserOutput( $title, null, null, false );
283 $links = $po->getLinks();
284 $hasLinks = !empty( $links );
294 * @param int $maxlength
297 public function getTextForSummary( $maxlength = 250 ) {
298 $truncatedtext = parent
::getTextForSummary( $maxlength );
300 # clean up unfinished links
301 # XXX: make this optional? wasn't there in autosummary, but required for
303 $truncatedtext = preg_replace( '/\[\[([^\]]*)\]?$/', '$1', $truncatedtext );
305 return $truncatedtext;
309 * Returns a ParserOutput object resulting from parsing the content's text
312 * @param Title $title
313 * @param int $revId Revision to pass to the parser (default: null)
314 * @param ParserOptions $options (default: null)
315 * @param bool $generateHtml (default: true)
316 * @param ParserOutput &$output ParserOutput representing the HTML form of the text,
317 * may be manipulated or replaced.
319 protected function fillParserOutput( Title
$title, $revId,
320 ParserOptions
$options, $generateHtml, ParserOutput
&$output
324 list( $redir, $text ) = $this->getRedirectTargetAndText();
325 $output = $wgParser->parse( $text, $title, $options, true, true, $revId );
327 // Add redirect indicator at the top
329 // Make sure to include the redirect link in pagelinks
330 $output->addLink( $redir );
331 if ( $generateHtml ) {
332 $chain = $this->getRedirectChain();
334 Article
::getRedirectHeaderHtml( $title->getPageLanguage(), $chain, false ) .
335 $output->getRawText()
337 $output->addModuleStyles( 'mediawiki.action.view.redirectPage' );
343 * @throws MWException
345 protected function getHtml() {
346 throw new MWException(
347 "getHtml() not implemented for wikitext. "
348 . "Use getParserOutput()->getText()."
353 * This implementation calls $word->match() on the this TextContent object's text.
355 * @param MagicWord $word
359 * @see Content::matchMagicWord()
361 public function matchMagicWord( MagicWord
$word ) {
362 return $word->match( $this->getNativeData() );