3 * A content object represents page content, e.g. the text to show on a page.
4 * Content objects have no knowledge about how they relate to wiki pages.
13 * @return string A string representing the content in a way useful for
14 * building a full text search index. If no useful representation exists,
15 * this method returns an empty string.
17 * @todo: test that this actually works
18 * @todo: make sure this also works with LuceneSearch / WikiSearch
20 public function getTextForSearchIndex( );
25 * @return string The wikitext to include when another page includes this
26 * content, or false if the content is not includable in a wikitext page.
28 * @TODO: allow native handling, bypassing wikitext representation, like
29 * for includable special pages.
30 * @TODO: allow transclusion into other content models than Wikitext!
31 * @TODO: used in WikiPage and MessageCache to get message text. Not so
32 * nice. What should we use instead?!
34 public function getWikitextForTransclusion( );
37 * Returns a textual representation of the content suitable for use in edit
38 * summaries and log messages.
42 * @param $maxlength int Maximum length of the summary text
43 * @return The summary text
45 public function getTextForSummary( $maxlength = 250 );
48 * Returns native representation of the data. Interpretation depends on
49 * the data model used, as given by getDataModel().
53 * @return mixed The native representation of the content. Could be a
54 * string, a nested array structure, an object, a binary blob...
57 * @NOTE: review all calls carefully, caller must be aware of content model!
59 public function getNativeData( );
62 * Returns the content's nominal size in bogo-bytes.
66 public function getSize( );
69 * Returns the ID of the content model used by this Content object.
70 * Corresponds to the CONTENT_MODEL_XXX constants.
74 * @return String The model id
76 public function getModel();
79 * Convenience method that returns the ContentHandler singleton for handling
80 * the content model that this Content object uses.
82 * Shorthand for ContentHandler::getForContent( $this )
86 * @return ContentHandler
88 public function getContentHandler();
91 * Convenience method that returns the default serialization format for the
92 * content model that this Content object uses.
94 * Shorthand for $this->getContentHandler()->getDefaultFormat()
100 public function getDefaultFormat();
103 * Convenience method that returns the list of serialization formats
104 * supported for the content model that this Content object uses.
106 * Shorthand for $this->getContentHandler()->getSupportedFormats()
110 * @return Array of supported serialization formats
112 public function getSupportedFormats();
115 * Returns true if $format is a supported serialization format for this
116 * Content object, false if it isn't.
118 * Note that this should always return true if $format is null, because null
119 * stands for the default serialization.
121 * Shorthand for $this->getContentHandler()->isSupportedFormat( $format )
125 * @param $format string The format to check
126 * @return bool Whether the format is supported
128 public function isSupportedFormat( $format );
131 * Convenience method for serializing this Content object.
133 * Shorthand for $this->getContentHandler()->serializeContent( $this, $format )
137 * @param $format null|string The desired serialization format (or null for
138 * the default format).
139 * @return string Serialized form of this Content object
141 public function serialize( $format = null );
144 * Returns true if this Content object represents empty content.
148 * @return bool Whether this Content object is empty
150 public function isEmpty();
153 * Returns whether the content is valid. This is intended for local validity
154 * checks, not considering global consistency.
156 * Content needs to be valid before it can be saved.
158 * This default implementation always returns true.
164 public function isValid();
167 * Returns true if this Content objects is conceptually equivalent to the
168 * given Content object.
172 * - Will return false if $that is null.
173 * - Will return true if $that === $this.
174 * - Will return false if $that->getModelName() != $this->getModel().
175 * - Will return false if $that->getNativeData() is not equal to $this->getNativeData(),
176 * where the meaning of "equal" depends on the actual data model.
178 * Implementations should be careful to make equals() transitive and reflexive:
180 * - $a->equals( $b ) <=> $b->equals( $a )
181 * - $a->equals( $b ) && $b->equals( $c ) ==> $a->equals( $c )
185 * @param $that Content The Content object to compare to
186 * @return bool True if this Content object is equal to $that, false otherwise.
188 public function equals( Content
$that = null );
191 * Return a copy of this Content object. The following must be true for the
194 * if $copy = $original->copy()
196 * - get_class($original) === get_class($copy)
197 * - $original->getModel() === $copy->getModel()
198 * - $original->equals( $copy )
200 * If and only if the Content object is immutable, the copy() method can and
201 * should return $this. That is, $copy === $original may be true, but only
202 * for immutable content objects.
206 * @return Content. A copy of this object
208 public function copy( );
211 * Returns true if this content is countable as a "real" wiki page, provided
212 * that it's also in a countable location (e.g. a current revision in the
217 * @param $hasLinks Bool: If it is known whether this content contains
218 * links, provide this information here, to avoid redundant parsing to
222 public function isCountable( $hasLinks = null ) ;
226 * Parse the Content object and generate a ParserOutput from the result.
227 * $result->getText() can be used to obtain the generated HTML. If no HTML
228 * is needed, $generateHtml can be set to false; in that case,
229 * $result->getText() may return null.
231 * @param $title Title The page title to use as a context for rendering
232 * @param $revId null|int The revision being rendered (optional)
233 * @param $options null|ParserOptions Any parser options
234 * @param $generateHtml Boolean Whether to generate HTML (default: true). If false,
235 * the result of calling getText() on the ParserOutput object returned by
236 * this method is undefined.
240 * @return ParserOutput
242 public function getParserOutput( Title
$title,
244 ParserOptions
$options = null, $generateHtml = true );
245 # TODO: make RenderOutput and RenderOptions base classes
248 * Returns a list of DataUpdate objects for recording information about this
249 * Content in some secondary data store. If the optional second argument,
250 * $old, is given, the updates may model only the changes that need to be
251 * made to replace information about the old content with information about
254 * This default implementation calls
255 * $this->getParserOutput( $content, $title, null, null, false ),
256 * and then calls getSecondaryDataUpdates( $title, $recursive ) on the
257 * resulting ParserOutput object.
259 * Subclasses may implement this to determine the necessary updates more
260 * efficiently, or make use of information about the old content.
262 * @param $title Title The context for determining the necessary updates
263 * @param $old Content|null An optional Content object representing the
264 * previous content, i.e. the content being replaced by this Content
266 * @param $recursive boolean Whether to include recursive updates (default:
268 * @param $parserOutput ParserOutput|null Optional ParserOutput object.
269 * Provide if you have one handy, to avoid re-parsing of the content.
271 * @return Array. A list of DataUpdate objects for putting information
272 * about this content object somewhere.
276 public function getSecondaryDataUpdates( Title
$title,
278 $recursive = true, ParserOutput
$parserOutput = null
282 * Construct the redirect destination from this content and return an
283 * array of Titles, or null if this content doesn't represent a redirect.
284 * The last element in the array is the final destination after all redirects
285 * have been resolved (up to $wgMaxRedirects times).
289 * @return Array of Titles, with the destination last
291 public function getRedirectChain();
294 * Construct the redirect destination from this content and return a Title,
295 * or null if this content doesn't represent a redirect.
296 * This will only return the immediate redirect target, useful for
297 * the redirect table and other checks that don't need full recursion.
301 * @return Title: The corresponding Title
303 public function getRedirectTarget();
306 * Construct the redirect destination from this content and return the
307 * Title, or null if this content doesn't represent a redirect.
309 * This will recurse down $wgMaxRedirects times or until a non-redirect
310 * target is hit in order to provide (hopefully) the Title of the final
311 * destination instead of another redirect.
313 * There is usually no need to override the default behaviour, subclasses that
314 * want to implement redirects should override getRedirectTarget().
320 public function getUltimateRedirectTarget();
323 * Returns whether this Content represents a redirect.
324 * Shorthand for getRedirectTarget() !== null.
330 public function isRedirect();
333 * If this Content object is a redirect, this method updates the redirect target.
334 * Otherwise, it does nothing.
338 * @param Title $target the new redirect target
340 * @return Content a new Content object with the updated redirect (or $this if this Content object isn't a redirect)
342 public function updateRedirect( Title
$target );
345 * Returns the section with the given ID.
349 * @param $sectionId string The section's ID, given as a numeric string.
350 * The ID "0" retrieves the section before the first heading, "1" the
351 * text between the first heading (included) and the second heading
353 * @return Content|Boolean|null The section, or false if no such section
354 * exist, or null if sections are not supported.
356 public function getSection( $sectionId );
359 * Replaces a section of the content and returns a Content object with the
364 * @param $section Empty/null/false or a section number (0, 1, 2, T1, T2...), or "new"
365 * @param $with Content: new content of the section
366 * @param $sectionTitle String: new section's subject, only if $section is 'new'
367 * @return string Complete article text, or null if error
369 public function replaceSection( $section, Content
$with, $sectionTitle = '' );
372 * Returns a Content object with pre-save transformations applied (or this
373 * object if no transformations apply).
377 * @param $title Title
379 * @param $popts null|ParserOptions
382 public function preSaveTransform( Title
$title, User
$user, ParserOptions
$popts );
385 * Returns a new WikitextContent object with the given section heading
386 * prepended, if supported. The default implementation just returns this
387 * Content object unmodified, ignoring the section header.
391 * @param $header string
394 public function addSectionHeader( $header );
397 * Returns a Content object with preload transformations applied (or this
398 * object if no transformations apply).
402 * @param $title Title
403 * @param $popts null|ParserOptions
406 public function preloadTransform( Title
$title, ParserOptions
$popts );
409 * Prepare Content for saving. Called before Content is saved by WikiPage::doEditContent() and in
412 * This may be used to check the content's consistency with global state. This function should
413 * NOT write any information to the database.
415 * Note that this method will usually be called inside the same transaction bracket that will be used
416 * to save the new revision.
418 * Note that this method is called before any update to the page table is performed. This means that
419 * $page may not yet know a page ID.
421 * @param WikiPage $page The page to be saved.
422 * @param int $flags bitfield for use with EDIT_XXX constants, see WikiPage::doEditContent()
423 * @param int $baseRevId the ID of the current revision
426 * @return Status A status object indicating whether the content was successfully prepared for saving.
427 * If the returned status indicates an error, a rollback will be performed and the
428 * transaction aborted.
430 * @see see WikiPage::doEditContent()
432 public function prepareSave( WikiPage
$page, $flags, $baseRevId, User
$user );
435 * Returns a list of updates to perform when this content is deleted.
436 * The necessary updates may be taken from the Content object, or depend on
437 * the current state of the database.
441 * @param $page \WikiPage the deleted page
442 * @param $parserOutput null|\ParserOutput optional parser output object
443 * for efficient access to meta-information about the content object.
444 * Provide if you have one handy.
446 * @return array A list of DataUpdate instances that will clean up the
447 * database after deletion.
449 public function getDeletionUpdates( WikiPage
$page,
450 ParserOutput
$parserOutput = null );
453 * Returns true if this Content object matches the given magic word.
455 * @param MagicWord $word the magic word to match
457 * @return bool whether this Content object matches the given magic word.
459 public function matchMagicWord( MagicWord
$word );
461 # TODO: ImagePage and CategoryPage interfere with per-content action handlers
462 # TODO: make sure WikiSearch extension still works
463 # TODO: make sure ReplaceTemplates extension still works
464 # TODO: nice&sane integration of GeSHi syntax highlighting
465 # [11:59] <vvv> Hooks are ugly; make CodeHighlighter interface and a
466 # config to set the class which handles syntax highlighting
467 # [12:00] <vvv> And default it to a DummyHighlighter
472 * A content object represents page content, e.g. the text to show on a page.
473 * Content objects have no knowledge about how they relate to Wiki pages.
477 abstract class AbstractContent
implements Content
{
480 * Name of the content model this Content object represents.
481 * Use with CONTENT_MODEL_XXX constants
483 * @var string $model_id
488 * @param String $model_id
490 public function __construct( $model_id = null ) {
491 $this->model_id
= $model_id;
495 * @see Content::getModel()
497 public function getModel() {
498 return $this->model_id
;
502 * Throws an MWException if $model_id is not the id of the content model
503 * supported by this Content object.
505 * @param $model_id int the model to check
507 * @throws MWException
509 protected function checkModelID( $model_id ) {
510 if ( $model_id !== $this->model_id
) {
511 throw new MWException( "Bad content model: " .
512 "expected {$this->model_id} " .
513 "but got $model_id." );
518 * @see Content::getContentHandler()
520 public function getContentHandler() {
521 return ContentHandler
::getForContent( $this );
525 * @see Content::getDefaultFormat()
527 public function getDefaultFormat() {
528 return $this->getContentHandler()->getDefaultFormat();
532 * @see Content::getSupportedFormats()
534 public function getSupportedFormats() {
535 return $this->getContentHandler()->getSupportedFormats();
539 * @see Content::isSupportedFormat()
541 public function isSupportedFormat( $format ) {
543 return true; // this means "use the default"
546 return $this->getContentHandler()->isSupportedFormat( $format );
550 * Throws an MWException if $this->isSupportedFormat( $format ) doesn't
554 * @throws MWException
556 protected function checkFormat( $format ) {
557 if ( !$this->isSupportedFormat( $format ) ) {
558 throw new MWException( "Format $format is not supported for content model " .
564 * @see Content::serialize
566 public function serialize( $format = null ) {
567 return $this->getContentHandler()->serializeContent( $this, $format );
571 * @see Content::isEmpty()
573 public function isEmpty() {
574 return $this->getSize() == 0;
578 * @see Content::isValid()
580 public function isValid() {
585 * @see Content::equals()
587 public function equals( Content
$that = null ) {
588 if ( is_null( $that ) ) {
592 if ( $that === $this ) {
596 if ( $that->getModel() !== $this->getModel() ) {
600 return $this->getNativeData() === $that->getNativeData();
605 * Returns a list of DataUpdate objects for recording information about this
606 * Content in some secondary data store.
608 * This default implementation calls
609 * $this->getParserOutput( $content, $title, null, null, false ),
610 * and then calls getSecondaryDataUpdates( $title, $recursive ) on the
611 * resulting ParserOutput object.
613 * Subclasses may override this to determine the secondary data updates more
614 * efficiently, preferrably without the need to generate a parser output object.
616 * @see Content::getSecondaryDataUpdates()
618 * @param $title Title The context for determining the necessary updates
619 * @param $old Content|null An optional Content object representing the
620 * previous content, i.e. the content being replaced by this Content
622 * @param $recursive boolean Whether to include recursive updates (default:
624 * @param $parserOutput ParserOutput|null Optional ParserOutput object.
625 * Provide if you have one handy, to avoid re-parsing of the content.
627 * @return Array. A list of DataUpdate objects for putting information
628 * about this content object somewhere.
632 public function getSecondaryDataUpdates( Title
$title,
634 $recursive = true, ParserOutput
$parserOutput = null
636 if ( !$parserOutput ) {
637 $parserOutput = $this->getParserOutput( $title, null, null, false );
640 return $parserOutput->getSecondaryDataUpdates( $title, $recursive );
645 * @see Content::getRedirectChain()
647 public function getRedirectChain() {
648 global $wgMaxRedirects;
649 $title = $this->getRedirectTarget();
650 if ( is_null( $title ) ) {
653 // recursive check to follow double redirects
654 $recurse = $wgMaxRedirects;
655 $titles = array( $title );
656 while ( --$recurse > 0 ) {
657 if ( $title->isRedirect() ) {
658 $page = WikiPage
::factory( $title );
659 $newtitle = $page->getRedirectTarget();
663 // Redirects to some special pages are not permitted
664 if ( $newtitle instanceOf Title
&& $newtitle->isValidRedirectTarget() ) {
665 // The new title passes the checks, so make that our current
666 // title so that further recursion can be checked
668 $titles[] = $newtitle;
677 * @see Content::getRedirectTarget()
679 public function getRedirectTarget() {
684 * @see Content::getUltimateRedirectTarget()
685 * @note: migrated here from Title::newFromRedirectRecurse
687 public function getUltimateRedirectTarget() {
688 $titles = $this->getRedirectChain();
689 return $titles ?
array_pop( $titles ) : null;
693 * @see Content::isRedirect()
699 public function isRedirect() {
700 return $this->getRedirectTarget() !== null;
704 * @see Content::updateRedirect()
706 * This default implementation always returns $this.
710 * @return Content $this
712 public function updateRedirect( Title
$target ) {
717 * @see Content::getSection()
719 public function getSection( $sectionId ) {
724 * @see Content::replaceSection()
726 public function replaceSection( $section, Content
$with, $sectionTitle = '' ) {
731 * @see Content::preSaveTransform()
733 public function preSaveTransform( Title
$title, User
$user, ParserOptions
$popts ) {
738 * @see Content::addSectionHeader()
740 public function addSectionHeader( $header ) {
745 * @see Content::preloadTransform()
747 public function preloadTransform( Title
$title, ParserOptions
$popts ) {
752 * @see Content::prepareSave()
754 public function prepareSave( WikiPage
$page, $flags, $baseRevId, User
$user ) {
755 if ( $this->isValid() ) {
756 return Status
::newGood();
758 return Status
::newFatal( "invalid-content-data" );
763 * @see Content::getDeletionUpdates()
767 * @param $page \WikiPage the deleted page
768 * @param $parserOutput null|\ParserOutput optional parser output object
769 * for efficient access to meta-information about the content object.
770 * Provide if you have one handy.
772 * @return array A list of DataUpdate instances that will clean up the
773 * database after deletion.
775 public function getDeletionUpdates( WikiPage
$page,
776 ParserOutput
$parserOutput = null )
779 new LinksDeletionUpdate( $page ),
784 * @see Content::matchMagicWord()
786 * This default implementation always returns false. Subclasses may override this to supply matching logic.
788 * @param MagicWord $word
792 public function matchMagicWord( MagicWord
$word ) {
798 * Content object implementation for representing flat text.
800 * TextContent instances are immutable
804 abstract class TextContent
extends AbstractContent
{
806 public function __construct( $text, $model_id = null ) {
807 parent
::__construct( $model_id );
809 $this->mText
= $text;
812 public function copy() {
813 return $this; # NOTE: this is ok since TextContent are immutable.
816 public function getTextForSummary( $maxlength = 250 ) {
819 $text = $this->getNativeData();
821 $truncatedtext = $wgContLang->truncate(
822 preg_replace( "/[\n\r]/", ' ', $text ),
823 max( 0, $maxlength ) );
825 return $truncatedtext;
829 * returns the text's size in bytes.
831 * @return int The size
833 public function getSize( ) {
834 $text = $this->getNativeData( );
835 return strlen( $text );
839 * Returns true if this content is not a redirect, and $wgArticleCountMethod
842 * @param $hasLinks Bool: if it is known whether this content contains links,
843 * provide this information here, to avoid redundant parsing to find out.
845 * @return bool True if the content is countable
847 public function isCountable( $hasLinks = null ) {
848 global $wgArticleCountMethod;
850 if ( $this->isRedirect( ) ) {
854 if ( $wgArticleCountMethod === 'any' ) {
862 * Returns the text represented by this Content object, as a string.
864 * @param the raw text
866 public function getNativeData( ) {
867 $text = $this->mText
;
872 * Returns the text represented by this Content object, as a string.
874 * @param the raw text
876 public function getTextForSearchIndex( ) {
877 return $this->getNativeData();
881 * Returns the text represented by this Content object, as a string.
883 * @param the raw text
885 public function getWikitextForTransclusion( ) {
886 return $this->getNativeData();
890 * Diff this content object with another content object..
894 * @param $that Content the other content object to compare this content object to
895 * @param $lang Language the language object to use for text segmentation.
896 * If not given, $wgContentLang is used.
898 * @return DiffResult a diff representing the changes that would have to be
899 * made to this content object to make it equal to $that.
901 public function diff( Content
$that, Language
$lang = null ) {
904 $this->checkModelID( $that->getModel() );
906 # @todo: could implement this in DifferenceEngine and just delegate here?
908 if ( !$lang ) $lang = $wgContLang;
910 $otext = $this->getNativeData();
911 $ntext = $this->getNativeData();
913 # Note: Use native PHP diff, external engines don't give us abstract output
914 $ota = explode( "\n", $wgContLang->segmentForDiff( $otext ) );
915 $nta = explode( "\n", $wgContLang->segmentForDiff( $ntext ) );
917 $diff = new Diff( $ota, $nta );
923 * Returns a generic ParserOutput object, wrapping the HTML returned by
926 * @param $title Title Context title for parsing
927 * @param $revId int|null Revision ID (for {{REVISIONID}})
928 * @param $options ParserOptions|null Parser options
929 * @param $generateHtml bool Whether or not to generate HTML
931 * @return ParserOutput representing the HTML form of the text
933 public function getParserOutput( Title
$title,
935 ParserOptions
$options = null, $generateHtml = true
937 # Generic implementation, relying on $this->getHtml()
939 if ( $generateHtml ) {
940 $html = $this->getHtml();
945 $po = new ParserOutput( $html );
950 * Generates an HTML version of the content, for display. Used by
951 * getParserOutput() to construct a ParserOutput object.
953 * This default implementation just calls getHighlightHtml(). Content
954 * models that have another mapping to HTML (as is the case for markup
955 * languages like wikitext) should override this method to generate the
958 * @return string An HTML representation of the content
960 protected function getHtml() {
961 return $this->getHighlightHtml();
965 * Generates a syntax-highlighted version of the content, as HTML.
966 * Used by the default implementation of getHtml().
968 * @return string an HTML representation of the content's markup
970 protected function getHighlightHtml( ) {
971 # TODO: make Highlighter interface, use highlighter here, if available
972 return htmlspecialchars( $this->getNativeData() );
979 class WikitextContent
extends TextContent
{
981 public function __construct( $text ) {
982 parent
::__construct( $text, CONTENT_MODEL_WIKITEXT
);
986 * @see Content::getSection()
988 public function getSection( $section ) {
991 $text = $this->getNativeData();
992 $sect = $wgParser->getSection( $text, $section, false );
994 return new WikitextContent( $sect );
998 * @see Content::replaceSection()
1000 public function replaceSection( $section, Content
$with, $sectionTitle = '' ) {
1001 wfProfileIn( __METHOD__
);
1003 $myModelId = $this->getModel();
1004 $sectionModelId = $with->getModel();
1006 if ( $sectionModelId != $myModelId ) {
1007 throw new MWException( "Incompatible content model for section: " .
1008 "document uses $myModelId but " .
1009 "section uses $sectionModelId." );
1012 $oldtext = $this->getNativeData();
1013 $text = $with->getNativeData();
1015 if ( $section === '' ) {
1016 return $with; # XXX: copy first?
1017 } if ( $section == 'new' ) {
1018 # Inserting a new section
1019 $subject = $sectionTitle ?
wfMessage( 'newsectionheaderdefaultlevel' )
1020 ->rawParams( $sectionTitle )->inContentLanguage()->text() . "\n\n" : '';
1021 if ( wfRunHooks( 'PlaceNewSection', array( $this, $oldtext, $subject, &$text ) ) ) {
1022 $text = strlen( trim( $oldtext ) ) > 0
1023 ?
"{$oldtext}\n\n{$subject}{$text}"
1024 : "{$subject}{$text}";
1027 # Replacing an existing section; roll out the big guns
1030 $text = $wgParser->replaceSection( $oldtext, $section, $text );
1033 $newContent = new WikitextContent( $text );
1035 wfProfileOut( __METHOD__
);
1040 * Returns a new WikitextContent object with the given section heading
1043 * @param $header string
1046 public function addSectionHeader( $header ) {
1047 $text = wfMessage( 'newsectionheaderdefaultlevel' )
1048 ->inContentLanguage()->params( $header )->text();
1050 $text .= $this->getNativeData();
1052 return new WikitextContent( $text );
1056 * Returns a Content object with pre-save transformations applied using
1057 * Parser::preSaveTransform().
1059 * @param $title Title
1061 * @param $popts ParserOptions
1064 public function preSaveTransform( Title
$title, User
$user, ParserOptions
$popts ) {
1067 $text = $this->getNativeData();
1068 $pst = $wgParser->preSaveTransform( $text, $title, $user, $popts );
1070 return new WikitextContent( $pst );
1074 * Returns a Content object with preload transformations applied (or this
1075 * object if no transformations apply).
1077 * @param $title Title
1078 * @param $popts ParserOptions
1081 public function preloadTransform( Title
$title, ParserOptions
$popts ) {
1084 $text = $this->getNativeData();
1085 $plt = $wgParser->getPreloadText( $text, $title, $popts );
1087 return new WikitextContent( $plt );
1091 * Implement redirect extraction for wikitext.
1093 * @return null|Title
1095 * @note: migrated here from Title::newFromRedirectInternal()
1097 * @see Content::getRedirectTarget
1098 * @see AbstractContent::getRedirectTarget
1100 public function getRedirectTarget() {
1101 global $wgMaxRedirects;
1102 if ( $wgMaxRedirects < 1 ) {
1103 // redirects are disabled, so quit early
1106 $redir = MagicWord
::get( 'redirect' );
1107 $text = trim( $this->getNativeData() );
1108 if ( $redir->matchStartAndRemove( $text ) ) {
1109 // Extract the first link and see if it's usable
1110 // Ensure that it really does come directly after #REDIRECT
1111 // Some older redirects included a colon, so don't freak about that!
1113 if ( preg_match( '!^\s*:?\s*\[{2}(.*?)(?:\|.*?)?\]{2}!', $text, $m ) ) {
1114 // Strip preceding colon used to "escape" categories, etc.
1115 // and URL-decode links
1116 if ( strpos( $m[1], '%' ) !== false ) {
1117 // Match behavior of inline link parsing here;
1118 $m[1] = rawurldecode( ltrim( $m[1], ':' ) );
1120 $title = Title
::newFromText( $m[1] );
1121 // If the title is a redirect to bad special pages or is invalid, return null
1122 if ( !$title instanceof Title ||
!$title->isValidRedirectTarget() ) {
1132 * @see Content::updateRedirect()
1134 * This implementation replaces the first link on the page with the given new target
1135 * if this Content object is a redirect. Otherwise, this method returns $this.
1139 * @param Title $target
1141 * @return Content a new Content object with the updated redirect (or $this if this Content object isn't a redirect)
1143 public function updateRedirect( Title
$target ) {
1144 if ( !$this->isRedirect() ) {
1149 # Remember that redirect pages can have categories, templates, etc.,
1150 # so the regex has to be fairly general
1151 $newText = preg_replace( '/ \[ \[ [^\]]* \] \] /x',
1152 '[[' . $target->getFullText() . ']]',
1153 $this->getNativeData(), 1 );
1155 return new WikitextContent( $newText );
1159 * Returns true if this content is not a redirect, and this content's text
1160 * is countable according to the criteria defined by $wgArticleCountMethod.
1162 * @param $hasLinks Bool if it is known whether this content contains
1163 * links, provide this information here, to avoid redundant parsing to
1165 * @param $title null|\Title
1167 * @internal param \IContextSource $context context for parsing if necessary
1169 * @return bool True if the content is countable
1171 public function isCountable( $hasLinks = null, Title
$title = null ) {
1172 global $wgArticleCountMethod;
1174 if ( $this->isRedirect( ) ) {
1178 $text = $this->getNativeData();
1180 switch ( $wgArticleCountMethod ) {
1184 return strpos( $text, ',' ) !== false;
1186 if ( $hasLinks === null ) { # not known, find out
1188 $context = RequestContext
::getMain();
1189 $title = $context->getTitle();
1192 $po = $this->getParserOutput( $title, null, null, false );
1193 $links = $po->getLinks();
1194 $hasLinks = !empty( $links );
1203 public function getTextForSummary( $maxlength = 250 ) {
1204 $truncatedtext = parent
::getTextForSummary( $maxlength );
1206 # clean up unfinished links
1207 # XXX: make this optional? wasn't there in autosummary, but required for
1209 $truncatedtext = preg_replace( '/\[\[([^\]]*)\]?$/', '$1', $truncatedtext );
1211 return $truncatedtext;
1216 * Returns a ParserOutput object resulting from parsing the content's text
1221 * @param $content Content the content to render
1222 * @param $title \Title
1223 * @param $revId null
1224 * @param $options null|ParserOptions
1225 * @param $generateHtml bool
1227 * @internal param \IContextSource|null $context
1228 * @return ParserOutput representing the HTML form of the text
1230 public function getParserOutput( Title
$title,
1232 ParserOptions
$options = null, $generateHtml = true
1237 $options = new ParserOptions();
1240 $po = $wgParser->parse( $this->getNativeData(), $title, $options, true, true, $revId );
1244 protected function getHtml() {
1245 throw new MWException(
1246 "getHtml() not implemented for wikitext. "
1247 . "Use getParserOutput()->getText()."
1252 * @see Content::matchMagicWord()
1254 * This implementation calls $word->match() on the this TextContent object's text.
1256 * @param MagicWord $word
1258 * @return bool whether this Content object matches the given magic word.
1260 public function matchMagicWord( MagicWord
$word ) {
1261 return $word->match( $this->getNativeData() );
1266 * Wrapper allowing us to handle a system message as a Content object. Note that this is generally *not* used
1267 * to represent content from the MediaWiki namespace, and that there is no MessageContentHandler. MessageContent
1268 * is just intended as glue for wrapping a message programatically.
1272 class MessageContent
extends AbstractContent
{
1277 protected $mMessage;
1280 * @param Message|String $msg A Message object, or a message key
1281 * @param array|null $params An optional array of message parameters
1283 public function __construct( $msg, $params = null ) {
1284 # XXX: messages may be wikitext, html or plain text! and maybe even something else entirely.
1285 parent
::__construct( CONTENT_MODEL_WIKITEXT
);
1287 if ( is_string( $msg ) ) {
1288 $this->mMessage
= wfMessage( $msg );
1290 $this->mMessage
= clone $msg;
1294 $this->mMessage
= $this->mMessage
->params( $params );
1299 * Returns the message as rendered HTML
1301 * @return string The message text, parsed into html
1303 public function getHtml() {
1304 return $this->mMessage
->parse();
1308 * Returns the message as rendered HTML
1310 * @return string The message text, parsed into html
1312 public function getWikitext() {
1313 return $this->mMessage
->text();
1317 * Returns the message object, with any parameters already substituted.
1319 * @return Message The message object.
1321 public function getNativeData() {
1322 //NOTE: Message objects are mutable. Cloning here makes MessageContent immutable.
1323 return clone $this->mMessage
;
1327 * @see Content::getTextForSearchIndex
1329 public function getTextForSearchIndex() {
1330 return $this->mMessage
->plain();
1334 * @see Content::getWikitextForTransclusion
1336 public function getWikitextForTransclusion() {
1337 return $this->getWikitext();
1341 * @see Content::getTextForSummary
1343 public function getTextForSummary( $maxlength = 250 ) {
1344 return substr( $this->mMessage
->plain(), 0, $maxlength );
1348 * @see Content::getSize
1352 public function getSize() {
1353 return strlen( $this->mMessage
->plain() );
1357 * @see Content::copy
1359 * @return Content. A copy of this object
1361 public function copy() {
1362 // MessageContent is immutable (because getNativeData() returns a clone of the Message object)
1367 * @see Content::isCountable
1369 * @return bool false
1371 public function isCountable( $hasLinks = null ) {
1376 * @see Content::getParserOutput
1378 * @return ParserOutput
1380 public function getParserOutput(
1381 Title
$title, $revId = null,
1382 ParserOptions
$options = null, $generateHtml = true
1385 if ( $generateHtml ) {
1386 $html = $this->getHtml();
1391 $po = new ParserOutput( $html );
1399 class JavaScriptContent
extends TextContent
{
1400 public function __construct( $text ) {
1401 parent
::__construct( $text, CONTENT_MODEL_JAVASCRIPT
);
1405 * Returns a Content object with pre-save transformations applied using
1406 * Parser::preSaveTransform().
1408 * @param Title $title
1410 * @param ParserOptions $popts
1413 public function preSaveTransform( Title
$title, User
$user, ParserOptions
$popts ) {
1415 // @todo: make pre-save transformation optional for script pages
1418 $text = $this->getNativeData();
1419 $pst = $wgParser->preSaveTransform( $text, $title, $user, $popts );
1421 return new JavaScriptContent( $pst );
1425 protected function getHtml( ) {
1427 $html .= "<pre class=\"mw-code mw-js\" dir=\"ltr\">\n";
1428 $html .= $this->getHighlightHtml( );
1429 $html .= "\n</pre>\n";
1438 class CssContent
extends TextContent
{
1439 public function __construct( $text ) {
1440 parent
::__construct( $text, CONTENT_MODEL_CSS
);
1444 * Returns a Content object with pre-save transformations applied using
1445 * Parser::preSaveTransform().
1447 * @param $title Title
1449 * @param $popts ParserOptions
1452 public function preSaveTransform( Title
$title, User
$user, ParserOptions
$popts ) {
1454 // @todo: make pre-save transformation optional for script pages
1456 $text = $this->getNativeData();
1457 $pst = $wgParser->preSaveTransform( $text, $title, $user, $popts );
1459 return new CssContent( $pst );
1463 protected function getHtml( ) {
1465 $html .= "<pre class=\"mw-code mw-css\" dir=\"ltr\">\n";
1466 $html .= $this->getHighlightHtml( );
1467 $html .= "\n</pre>\n";