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 $title \Title the title of 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( Title
$title,
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: handle ImagePage and CategoryPage
462 # TODO: make sure we cover lucene search / wikisearch.
463 # TODO: make sure ReplaceTemplates still works
464 # FUTURE: 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
469 # TODO: make sure we cover the external editor interface (does anyone actually use that?!)
471 # TODO: tie into API to provide contentModel for Revisions
472 # TODO: tie into API to provide serialized version and contentFormat for Revisions
473 # TODO: tie into API edit interface
474 # FUTURE: make EditForm plugin for EditPage
476 # FUTURE: special type for redirects?!
477 # FUTURE: MultipartMultipart < WikipageContent (Main + Links + X)
478 # FUTURE: LinksContent < LanguageLinksContent, CategoriesContent
483 * A content object represents page content, e.g. the text to show on a page.
484 * Content objects have no knowledge about how they relate to Wiki pages.
488 abstract class AbstractContent
implements Content
{
491 * Name of the content model this Content object represents.
492 * Use with CONTENT_MODEL_XXX constants
494 * @var string $model_id
499 * @param String $model_id
501 public function __construct( $model_id = null ) {
502 $this->model_id
= $model_id;
506 * @see Content::getModel()
508 public function getModel() {
509 return $this->model_id
;
513 * Throws an MWException if $model_id is not the id of the content model
514 * supported by this Content object.
516 * @param $model_id int the model to check
518 * @throws MWException
520 protected function checkModelID( $model_id ) {
521 if ( $model_id !== $this->model_id
) {
522 throw new MWException( "Bad content model: " .
523 "expected {$this->model_id} " .
524 "but got $model_id." );
529 * @see Content::getContentHandler()
531 public function getContentHandler() {
532 return ContentHandler
::getForContent( $this );
536 * @see Content::getDefaultFormat()
538 public function getDefaultFormat() {
539 return $this->getContentHandler()->getDefaultFormat();
543 * @see Content::getSupportedFormats()
545 public function getSupportedFormats() {
546 return $this->getContentHandler()->getSupportedFormats();
550 * @see Content::isSupportedFormat()
552 public function isSupportedFormat( $format ) {
554 return true; // this means "use the default"
557 return $this->getContentHandler()->isSupportedFormat( $format );
561 * Throws an MWException if $this->isSupportedFormat( $format ) doesn't
565 * @throws MWException
567 protected function checkFormat( $format ) {
568 if ( !$this->isSupportedFormat( $format ) ) {
569 throw new MWException( "Format $format is not supported for content model " .
575 * @see Content::serialize
577 public function serialize( $format = null ) {
578 return $this->getContentHandler()->serializeContent( $this, $format );
582 * @see Content::isEmpty()
584 public function isEmpty() {
585 return $this->getSize() == 0;
589 * @see Content::isValid()
591 public function isValid() {
596 * @see Content::equals()
598 public function equals( Content
$that = null ) {
599 if ( is_null( $that ) ) {
603 if ( $that === $this ) {
607 if ( $that->getModel() !== $this->getModel() ) {
611 return $this->getNativeData() === $that->getNativeData();
616 * Returns a list of DataUpdate objects for recording information about this
617 * Content in some secondary data store.
619 * This default implementation calls
620 * $this->getParserOutput( $content, $title, null, null, false ),
621 * and then calls getSecondaryDataUpdates( $title, $recursive ) on the
622 * resulting ParserOutput object.
624 * Subclasses may override this to determine the secondary data updates more
625 * efficiently, preferrably without the need to generate a parser output object.
627 * @see Content::getSecondaryDataUpdates()
629 * @param $title Title The context for determining the necessary updates
630 * @param $old Content|null An optional Content object representing the
631 * previous content, i.e. the content being replaced by this Content
633 * @param $recursive boolean Whether to include recursive updates (default:
635 * @param $parserOutput ParserOutput|null Optional ParserOutput object.
636 * Provide if you have one handy, to avoid re-parsing of the content.
638 * @return Array. A list of DataUpdate objects for putting information
639 * about this content object somewhere.
643 public function getSecondaryDataUpdates( Title
$title,
645 $recursive = true, ParserOutput
$parserOutput = null
647 if ( !$parserOutput ) {
648 $parserOutput = $this->getParserOutput( $title, null, null, false );
651 return $parserOutput->getSecondaryDataUpdates( $title, $recursive );
656 * @see Content::getRedirectChain()
658 public function getRedirectChain() {
659 global $wgMaxRedirects;
660 $title = $this->getRedirectTarget();
661 if ( is_null( $title ) ) {
664 // recursive check to follow double redirects
665 $recurse = $wgMaxRedirects;
666 $titles = array( $title );
667 while ( --$recurse > 0 ) {
668 if ( $title->isRedirect() ) {
669 $page = WikiPage
::factory( $title );
670 $newtitle = $page->getRedirectTarget();
674 // Redirects to some special pages are not permitted
675 if ( $newtitle instanceOf Title
&& $newtitle->isValidRedirectTarget() ) {
676 // The new title passes the checks, so make that our current
677 // title so that further recursion can be checked
679 $titles[] = $newtitle;
688 * @see Content::getRedirectTarget()
690 public function getRedirectTarget() {
695 * @see Content::getUltimateRedirectTarget()
696 * @note: migrated here from Title::newFromRedirectRecurse
698 public function getUltimateRedirectTarget() {
699 $titles = $this->getRedirectChain();
700 return $titles ?
array_pop( $titles ) : null;
704 * @see Content::isRedirect()
710 public function isRedirect() {
711 return $this->getRedirectTarget() !== null;
715 * @see Content::updateRedirect()
717 * This default implementation always returns $this.
721 * @return Content $this
723 public function updateRedirect( Title
$target ) {
728 * @see Content::getSection()
730 public function getSection( $sectionId ) {
735 * @see Content::replaceSection()
737 public function replaceSection( $section, Content
$with, $sectionTitle = '' ) {
742 * @see Content::preSaveTransform()
744 public function preSaveTransform( Title
$title, User
$user, ParserOptions
$popts ) {
749 * @see Content::addSectionHeader()
751 public function addSectionHeader( $header ) {
756 * @see Content::preloadTransform()
758 public function preloadTransform( Title
$title, ParserOptions
$popts ) {
763 * @see Content::prepareSave()
765 public function prepareSave( WikiPage
$page, $flags, $baseRevId, User
$user ) {
766 if ( $this->isValid() ) {
767 return Status
::newGood();
769 return Status
::newFatal( "invalid-content-data" );
774 * @see Content::getDeletionUpdates()
778 * @param $title \Title the title of the deleted page
779 * @param $parserOutput null|\ParserOutput optional parser output object
780 * for efficient access to meta-information about the content object.
781 * Provide if you have one handy.
783 * @return array A list of DataUpdate instances that will clean up the
784 * database after deletion.
786 public function getDeletionUpdates( Title
$title,
787 ParserOutput
$parserOutput = null )
790 new LinksDeletionUpdate( $title ),
795 * @see Content::matchMagicWord()
797 * This default implementation always returns false. Subclasses may override this to supply matching logic.
799 * @param MagicWord $word
803 public function matchMagicWord( MagicWord
$word ) {
809 * Content object implementation for representing flat text.
811 * TextContent instances are immutable
815 abstract class TextContent
extends AbstractContent
{
817 public function __construct( $text, $model_id = null ) {
818 parent
::__construct( $model_id );
820 $this->mText
= $text;
823 public function copy() {
824 return $this; # NOTE: this is ok since TextContent are immutable.
827 public function getTextForSummary( $maxlength = 250 ) {
830 $text = $this->getNativeData();
832 $truncatedtext = $wgContLang->truncate(
833 preg_replace( "/[\n\r]/", ' ', $text ),
834 max( 0, $maxlength ) );
836 return $truncatedtext;
840 * returns the text's size in bytes.
842 * @return int The size
844 public function getSize( ) {
845 $text = $this->getNativeData( );
846 return strlen( $text );
850 * Returns true if this content is not a redirect, and $wgArticleCountMethod
853 * @param $hasLinks Bool: if it is known whether this content contains links,
854 * provide this information here, to avoid redundant parsing to find out.
856 * @return bool True if the content is countable
858 public function isCountable( $hasLinks = null ) {
859 global $wgArticleCountMethod;
861 if ( $this->isRedirect( ) ) {
865 if ( $wgArticleCountMethod === 'any' ) {
873 * Returns the text represented by this Content object, as a string.
875 * @param the raw text
877 public function getNativeData( ) {
878 $text = $this->mText
;
883 * Returns the text represented by this Content object, as a string.
885 * @param the raw text
887 public function getTextForSearchIndex( ) {
888 return $this->getNativeData();
892 * Returns the text represented by this Content object, as a string.
894 * @param the raw text
896 public function getWikitextForTransclusion( ) {
897 return $this->getNativeData();
901 * Diff this content object with another content object..
905 * @param $that Content the other content object to compare this content object to
906 * @param $lang Language the language object to use for text segmentation.
907 * If not given, $wgContentLang is used.
909 * @return DiffResult a diff representing the changes that would have to be
910 * made to this content object to make it equal to $that.
912 public function diff( Content
$that, Language
$lang = null ) {
915 $this->checkModelID( $that->getModel() );
917 # @todo: could implement this in DifferenceEngine and just delegate here?
919 if ( !$lang ) $lang = $wgContLang;
921 $otext = $this->getNativeData();
922 $ntext = $this->getNativeData();
924 # Note: Use native PHP diff, external engines don't give us abstract output
925 $ota = explode( "\n", $wgContLang->segmentForDiff( $otext ) );
926 $nta = explode( "\n", $wgContLang->segmentForDiff( $ntext ) );
928 $diff = new Diff( $ota, $nta );
934 * Returns a generic ParserOutput object, wrapping the HTML returned by
937 * @param $title Title Context title for parsing
938 * @param $revId int|null Revision ID (for {{REVISIONID}})
939 * @param $options ParserOptions|null Parser options
940 * @param $generateHtml bool Whether or not to generate HTML
942 * @return ParserOutput representing the HTML form of the text
944 public function getParserOutput( Title
$title,
946 ParserOptions
$options = null, $generateHtml = true
948 # Generic implementation, relying on $this->getHtml()
950 if ( $generateHtml ) {
951 $html = $this->getHtml();
956 $po = new ParserOutput( $html );
961 * Generates an HTML version of the content, for display. Used by
962 * getParserOutput() to construct a ParserOutput object.
964 * This default implementation just calls getHighlightHtml(). Content
965 * models that have another mapping to HTML (as is the case for markup
966 * languages like wikitext) should override this method to generate the
969 * @return string An HTML representation of the content
971 protected function getHtml() {
972 return $this->getHighlightHtml();
976 * Generates a syntax-highlighted version of the content, as HTML.
977 * Used by the default implementation of getHtml().
979 * @return string an HTML representation of the content's markup
981 protected function getHighlightHtml( ) {
982 # TODO: make Highlighter interface, use highlighter here, if available
983 return htmlspecialchars( $this->getNativeData() );
990 class WikitextContent
extends TextContent
{
992 public function __construct( $text ) {
993 parent
::__construct( $text, CONTENT_MODEL_WIKITEXT
);
997 * @see Content::getSection()
999 public function getSection( $section ) {
1002 $text = $this->getNativeData();
1003 $sect = $wgParser->getSection( $text, $section, false );
1005 return new WikitextContent( $sect );
1009 * @see Content::replaceSection()
1011 public function replaceSection( $section, Content
$with, $sectionTitle = '' ) {
1012 wfProfileIn( __METHOD__
);
1014 $myModelId = $this->getModel();
1015 $sectionModelId = $with->getModel();
1017 if ( $sectionModelId != $myModelId ) {
1018 throw new MWException( "Incompatible content model for section: " .
1019 "document uses $myModelId but " .
1020 "section uses $sectionModelId." );
1023 $oldtext = $this->getNativeData();
1024 $text = $with->getNativeData();
1026 if ( $section === '' ) {
1027 return $with; # XXX: copy first?
1028 } if ( $section == 'new' ) {
1029 # Inserting a new section
1030 $subject = $sectionTitle ?
wfMessage( 'newsectionheaderdefaultlevel' )
1031 ->rawParams( $sectionTitle )->inContentLanguage()->text() . "\n\n" : '';
1032 if ( wfRunHooks( 'PlaceNewSection', array( $this, $oldtext, $subject, &$text ) ) ) {
1033 $text = strlen( trim( $oldtext ) ) > 0
1034 ?
"{$oldtext}\n\n{$subject}{$text}"
1035 : "{$subject}{$text}";
1038 # Replacing an existing section; roll out the big guns
1041 $text = $wgParser->replaceSection( $oldtext, $section, $text );
1044 $newContent = new WikitextContent( $text );
1046 wfProfileOut( __METHOD__
);
1051 * Returns a new WikitextContent object with the given section heading
1054 * @param $header string
1057 public function addSectionHeader( $header ) {
1058 $text = wfMessage( 'newsectionheaderdefaultlevel' )
1059 ->inContentLanguage()->params( $header )->text();
1061 $text .= $this->getNativeData();
1063 return new WikitextContent( $text );
1067 * Returns a Content object with pre-save transformations applied using
1068 * Parser::preSaveTransform().
1070 * @param $title Title
1072 * @param $popts ParserOptions
1075 public function preSaveTransform( Title
$title, User
$user, ParserOptions
$popts ) {
1078 $text = $this->getNativeData();
1079 $pst = $wgParser->preSaveTransform( $text, $title, $user, $popts );
1081 return new WikitextContent( $pst );
1085 * Returns a Content object with preload transformations applied (or this
1086 * object if no transformations apply).
1088 * @param $title Title
1089 * @param $popts ParserOptions
1092 public function preloadTransform( Title
$title, ParserOptions
$popts ) {
1095 $text = $this->getNativeData();
1096 $plt = $wgParser->getPreloadText( $text, $title, $popts );
1098 return new WikitextContent( $plt );
1102 * Implement redirect extraction for wikitext.
1104 * @return null|Title
1106 * @note: migrated here from Title::newFromRedirectInternal()
1108 * @see Content::getRedirectTarget
1109 * @see AbstractContent::getRedirectTarget
1111 public function getRedirectTarget() {
1112 global $wgMaxRedirects;
1113 if ( $wgMaxRedirects < 1 ) {
1114 // redirects are disabled, so quit early
1117 $redir = MagicWord
::get( 'redirect' );
1118 $text = trim( $this->getNativeData() );
1119 if ( $redir->matchStartAndRemove( $text ) ) {
1120 // Extract the first link and see if it's usable
1121 // Ensure that it really does come directly after #REDIRECT
1122 // Some older redirects included a colon, so don't freak about that!
1124 if ( preg_match( '!^\s*:?\s*\[{2}(.*?)(?:\|.*?)?\]{2}!', $text, $m ) ) {
1125 // Strip preceding colon used to "escape" categories, etc.
1126 // and URL-decode links
1127 if ( strpos( $m[1], '%' ) !== false ) {
1128 // Match behavior of inline link parsing here;
1129 $m[1] = rawurldecode( ltrim( $m[1], ':' ) );
1131 $title = Title
::newFromText( $m[1] );
1132 // If the title is a redirect to bad special pages or is invalid, return null
1133 if ( !$title instanceof Title ||
!$title->isValidRedirectTarget() ) {
1143 * @see Content::updateRedirect()
1145 * This implementation replaces the first link on the page with the given new target
1146 * if this Content object is a redirect. Otherwise, this method returns $this.
1150 * @param Title $target
1152 * @return Content a new Content object with the updated redirect (or $this if this Content object isn't a redirect)
1154 public function updateRedirect( Title
$target ) {
1155 if ( !$this->isRedirect() ) {
1160 # Remember that redirect pages can have categories, templates, etc.,
1161 # so the regex has to be fairly general
1162 $newText = preg_replace( '/ \[ \[ [^\]]* \] \] /x',
1163 '[[' . $target->getFullText() . ']]',
1164 $this->getNativeData(), 1 );
1166 return new WikitextContent( $newText );
1170 * Returns true if this content is not a redirect, and this content's text
1171 * is countable according to the criteria defined by $wgArticleCountMethod.
1173 * @param $hasLinks Bool if it is known whether this content contains
1174 * links, provide this information here, to avoid redundant parsing to
1176 * @param $title null|\Title
1178 * @internal param \IContextSource $context context for parsing if necessary
1180 * @return bool True if the content is countable
1182 public function isCountable( $hasLinks = null, Title
$title = null ) {
1183 global $wgArticleCountMethod;
1185 if ( $this->isRedirect( ) ) {
1189 $text = $this->getNativeData();
1191 switch ( $wgArticleCountMethod ) {
1195 return strpos( $text, ',' ) !== false;
1197 if ( $hasLinks === null ) { # not known, find out
1199 $context = RequestContext
::getMain();
1200 $title = $context->getTitle();
1203 $po = $this->getParserOutput( $title, null, null, false );
1204 $links = $po->getLinks();
1205 $hasLinks = !empty( $links );
1214 public function getTextForSummary( $maxlength = 250 ) {
1215 $truncatedtext = parent
::getTextForSummary( $maxlength );
1217 # clean up unfinished links
1218 # XXX: make this optional? wasn't there in autosummary, but required for
1220 $truncatedtext = preg_replace( '/\[\[([^\]]*)\]?$/', '$1', $truncatedtext );
1222 return $truncatedtext;
1227 * Returns a ParserOutput object resulting from parsing the content's text
1232 * @param $content Content the content to render
1233 * @param $title \Title
1234 * @param $revId null
1235 * @param $options null|ParserOptions
1236 * @param $generateHtml bool
1238 * @internal param \IContextSource|null $context
1239 * @return ParserOutput representing the HTML form of the text
1241 public function getParserOutput( Title
$title,
1243 ParserOptions
$options = null, $generateHtml = true
1248 $options = new ParserOptions();
1251 $po = $wgParser->parse( $this->getNativeData(), $title, $options, true, true, $revId );
1255 protected function getHtml() {
1256 throw new MWException(
1257 "getHtml() not implemented for wikitext. "
1258 . "Use getParserOutput()->getText()."
1263 * @see Content::matchMagicWord()
1265 * This implementation calls $word->match() on the this TextContent object's text.
1267 * @param MagicWord $word
1269 * @return bool whether this Content object matches the given magic word.
1271 public function matchMagicWord( MagicWord
$word ) {
1272 return $word->match( $this->getNativeData() );
1277 * Wrapper allowing us to handle a system message as a Content object. Note that this is generally *not* used
1278 * to represent content from the MediaWiki namespace, and that there is no MessageContentHandler. MessageContent
1279 * is just intended as glue for wrapping a message programatically.
1283 class MessageContent
extends AbstractContent
{
1288 protected $mMessage;
1291 * @param Message|String $msg A Message object, or a message key
1292 * @param array|null $params An optional array of message parameters
1294 public function __construct( $msg, $params = null ) {
1295 # XXX: messages may be wikitext, html or plain text! and maybe even something else entirely.
1296 parent
::__construct( CONTENT_MODEL_WIKITEXT
);
1298 if ( is_string( $msg ) ) {
1299 $this->mMessage
= wfMessage( $msg );
1301 $this->mMessage
= clone $msg;
1305 $this->mMessage
= $this->mMessage
->params( $params );
1310 * Returns the message as rendered HTML
1312 * @return string The message text, parsed into html
1314 public function getHtml() {
1315 return $this->mMessage
->parse();
1319 * Returns the message as rendered HTML
1321 * @return string The message text, parsed into html
1323 public function getWikitext() {
1324 return $this->mMessage
->text();
1328 * Returns the message object, with any parameters already substituted.
1330 * @return Message The message object.
1332 public function getNativeData() {
1333 //NOTE: Message objects are mutable. Cloning here makes MessageContent immutable.
1334 return clone $this->mMessage
;
1338 * @see Content::getTextForSearchIndex
1340 public function getTextForSearchIndex() {
1341 return $this->mMessage
->plain();
1345 * @see Content::getWikitextForTransclusion
1347 public function getWikitextForTransclusion() {
1348 return $this->getWikitext();
1352 * @see Content::getTextForSummary
1354 public function getTextForSummary( $maxlength = 250 ) {
1355 return substr( $this->mMessage
->plain(), 0, $maxlength );
1359 * @see Content::getSize
1363 public function getSize() {
1364 return strlen( $this->mMessage
->plain() );
1368 * @see Content::copy
1370 * @return Content. A copy of this object
1372 public function copy() {
1373 // MessageContent is immutable (because getNativeData() returns a clone of the Message object)
1378 * @see Content::isCountable
1380 * @return bool false
1382 public function isCountable( $hasLinks = null ) {
1387 * @see Content::getParserOutput
1389 * @return ParserOutput
1391 public function getParserOutput(
1392 Title
$title, $revId = null,
1393 ParserOptions
$options = null, $generateHtml = true
1396 if ( $generateHtml ) {
1397 $html = $this->getHtml();
1402 $po = new ParserOutput( $html );
1410 class JavaScriptContent
extends TextContent
{
1411 public function __construct( $text ) {
1412 parent
::__construct( $text, CONTENT_MODEL_JAVASCRIPT
);
1416 * Returns a Content object with pre-save transformations applied using
1417 * Parser::preSaveTransform().
1419 * @param Title $title
1421 * @param ParserOptions $popts
1424 public function preSaveTransform( Title
$title, User
$user, ParserOptions
$popts ) {
1426 // @todo: make pre-save transformation optional for script pages
1429 $text = $this->getNativeData();
1430 $pst = $wgParser->preSaveTransform( $text, $title, $user, $popts );
1432 return new JavaScriptContent( $pst );
1436 protected function getHtml( ) {
1438 $html .= "<pre class=\"mw-code mw-js\" dir=\"ltr\">\n";
1439 $html .= $this->getHighlightHtml( );
1440 $html .= "\n</pre>\n";
1449 class CssContent
extends TextContent
{
1450 public function __construct( $text ) {
1451 parent
::__construct( $text, CONTENT_MODEL_CSS
);
1455 * Returns a Content object with pre-save transformations applied using
1456 * Parser::preSaveTransform().
1458 * @param $title Title
1460 * @param $popts ParserOptions
1463 public function preSaveTransform( Title
$title, User
$user, ParserOptions
$popts ) {
1465 // @todo: make pre-save transformation optional for script pages
1467 $text = $this->getNativeData();
1468 $pst = $wgParser->preSaveTransform( $text, $title, $user, $popts );
1470 return new CssContent( $pst );
1474 protected function getHtml( ) {
1476 $html .= "<pre class=\"mw-code mw-css\" dir=\"ltr\">\n";
1477 $html .= $this->getHighlightHtml( );
1478 $html .= "\n</pre>\n";