3 * Content object implementation for representing flat text.
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
29 * Content object implementation for representing flat text.
31 * TextContent instances are immutable
35 class TextContent extends AbstractContent {
39 * @param string $model_id
42 public function __construct( $text, $model_id = CONTENT_MODEL_TEXT ) {
43 parent::__construct( $model_id );
45 if ( $text === null || $text === false ) {
46 wfWarn( "TextContent constructed with \$text = " . var_export( $text, true ) . "! "
47 . "This may indicate an error in the caller's scope.", 2 );
52 if ( !is_string( $text ) ) {
53 throw new MWException( "TextContent expects a string in the constructor." );
60 * @note Mutable subclasses MUST override this to return a copy!
62 * @return Content $this
64 public function copy() {
65 return $this; # NOTE: this is ok since TextContent are immutable.
68 public function getTextForSummary( $maxlength = 250 ) {
71 $text = $this->getNativeData();
73 $truncatedtext = $wgContLang->truncate(
74 preg_replace( "/[\n\r]/", ' ', $text ),
75 max( 0, $maxlength ) );
77 return $truncatedtext;
81 * Returns the text's size in bytes.
85 public function getSize() {
86 $text = $this->getNativeData();
88 return strlen( $text );
92 * Returns true if this content is not a redirect, and $wgArticleCountMethod
95 * @param bool|null $hasLinks If it is known whether this content contains links,
96 * provide this information here, to avoid redundant parsing to find out.
100 public function isCountable( $hasLinks = null ) {
101 global $wgArticleCountMethod;
103 if ( $this->isRedirect() ) {
107 if ( $wgArticleCountMethod === 'any' ) {
115 * Returns the text represented by this Content object, as a string.
117 * @return string The raw text.
119 public function getNativeData() {
124 * Returns the text represented by this Content object, as a string.
126 * @return string The raw text.
128 public function getTextForSearchIndex() {
129 return $this->getNativeData();
133 * Returns attempts to convert this content object to wikitext,
134 * and then returns the text string. The conversion may be lossy.
136 * @note this allows any text-based content to be transcluded as if it was wikitext.
138 * @return string|bool The raw text, or false if the conversion failed.
140 public function getWikitextForTransclusion() {
141 $wikitext = $this->convert( CONTENT_MODEL_WIKITEXT, 'lossy' );
144 return $wikitext->getNativeData();
151 * Do a "\r\n" -> "\n" and "\r" -> "\n" transformation
152 * as well as trim trailing whitespace
154 * This was formerly part of Parser::preSaveTransform, but
155 * for non-wikitext content models they probably still want
156 * to normalize line endings without all of the other PST
160 * @param string $text
163 public static function normalizeLineEndings( $text ) {
164 return str_replace( [ "\r\n", "\r" ], "\n", rtrim( $text ) );
168 * Returns a Content object with pre-save transformations applied.
170 * At a minimum, subclasses should make sure to call TextContent::normalizeLineEndings()
171 * either directly or part of Parser::preSaveTransform().
173 * @param Title $title
175 * @param ParserOptions $popts
179 public function preSaveTransform( Title $title, User $user, ParserOptions $popts ) {
180 $text = $this->getNativeData();
181 $pst = self::normalizeLineEndings( $text );
183 return ( $text === $pst ) ? $this : new static( $pst, $this->getModel() );
187 * Diff this content object with another content object.
191 * @param Content $that The other content object to compare this content object to.
192 * @param Language $lang The language object to use for text segmentation.
193 * If not given, $wgContentLang is used.
195 * @return Diff A diff representing the changes that would have to be
196 * made to this content object to make it equal to $that.
198 public function diff( Content $that, Language $lang = null ) {
201 $this->checkModelID( $that->getModel() );
203 // @todo could implement this in DifferenceEngine and just delegate here?
209 $otext = $this->getNativeData();
210 $ntext = $that->getNativeData();
212 # Note: Use native PHP diff, external engines don't give us abstract output
213 $ota = explode( "\n", $lang->segmentForDiff( $otext ) );
214 $nta = explode( "\n", $lang->segmentForDiff( $ntext ) );
216 $diff = new Diff( $ota, $nta );
222 * Fills the provided ParserOutput object with information derived from the content.
223 * Unless $generateHtml was false, this includes an HTML representation of the content
224 * provided by getHtml().
226 * For content models listed in $wgTextModelsToParse, this method will call the MediaWiki
227 * wikitext parser on the text to extract any (wikitext) links, magic words, etc.
229 * Subclasses may override this to provide custom content processing.
230 * For custom HTML generation alone, it is sufficient to override getHtml().
232 * @param Title $title Context title for parsing
233 * @param int $revId Revision ID (for {{REVISIONID}})
234 * @param ParserOptions $options Parser options
235 * @param bool $generateHtml Whether or not to generate HTML
236 * @param ParserOutput &$output The output object to fill (reference).
238 protected function fillParserOutput( Title $title, $revId,
239 ParserOptions $options, $generateHtml, ParserOutput &$output
241 global $wgParser, $wgTextModelsToParse;
243 if ( in_array( $this->getModel(), $wgTextModelsToParse ) ) {
244 // parse just to get links etc into the database, HTML is replaced below.
245 $output = $wgParser->parse( $this->getNativeData(), $title, $options, true, true, $revId );
248 if ( $generateHtml ) {
249 $html = $this->getHtml();
254 $output->setText( $html );
258 * Generates an HTML version of the content, for display. Used by
259 * fillParserOutput() to provide HTML for the ParserOutput object.
261 * Subclasses may override this to provide a custom HTML rendering.
262 * If further information is to be derived from the content (such as
263 * categories), the fillParserOutput() method can be overridden instead.
265 * For backwards-compatibility, this default implementation just calls
266 * getHighlightHtml().
268 * @return string An HTML representation of the content
270 protected function getHtml() {
271 return $this->getHighlightHtml();
275 * Generates an HTML version of the content, for display.
277 * This default implementation returns an HTML-escaped version
278 * of the raw text content.
280 * @note The functionality of this method should really be implemented
281 * in getHtml(), and subclasses should override getHtml() if needed.
282 * getHighlightHtml() is kept around for backward compatibility with
283 * extensions that already override it.
285 * @deprecated since 1.24. Use getHtml() instead. In particular, subclasses overriding
286 * getHighlightHtml() should override getHtml() instead.
288 * @return string An HTML representation of the content
290 protected function getHighlightHtml() {
291 return htmlspecialchars( $this->getNativeData() );
295 * This implementation provides lossless conversion between content models based
298 * @param string $toModel The desired content model, use the CONTENT_MODEL_XXX flags.
299 * @param string $lossy Flag, set to "lossy" to allow lossy conversion. If lossy conversion is not
300 * allowed, full round-trip conversion is expected to work without losing information.
302 * @return Content|bool A content object with the content model $toModel, or false if that
303 * conversion is not supported.
305 * @see Content::convert()
307 public function convert( $toModel, $lossy = '' ) {
308 $converted = parent::convert( $toModel, $lossy );
310 if ( $converted !== false ) {
314 $toHandler = ContentHandler::getForModelID( $toModel );
316 if ( $toHandler instanceof TextContentHandler ) {
317 // NOTE: ignore content serialization format - it's just text anyway.
318 $text = $this->getNativeData();
319 $converted = $toHandler->unserializeContent( $text );