Add sslCAFile option to DatabaseMysqli
[mediawiki.git] / includes / content / ContentHandler.php
blob0509e292150525e9341f8541bc9196380c433405
1 <?php
3 use MediaWiki\Search\ParserOutputSearchDataExtractor;
5 /**
6 * Base class for content handling.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 * http://www.gnu.org/copyleft/gpl.html
23 * @since 1.21
25 * @file
26 * @ingroup Content
28 * @author Daniel Kinzler
30 /**
31 * A content handler knows how do deal with a specific type of content on a wiki
32 * page. Content is stored in the database in a serialized form (using a
33 * serialization format a.k.a. MIME type) and is unserialized into its native
34 * PHP representation (the content model), which is wrapped in an instance of
35 * the appropriate subclass of Content.
37 * ContentHandler instances are stateless singletons that serve, among other
38 * things, as a factory for Content objects. Generally, there is one subclass
39 * of ContentHandler and one subclass of Content for every type of content model.
41 * Some content types have a flat model, that is, their native representation
42 * is the same as their serialized form. Examples would be JavaScript and CSS
43 * code. As of now, this also applies to wikitext (MediaWiki's default content
44 * type), but wikitext content may be represented by a DOM or AST structure in
45 * the future.
47 * @ingroup Content
49 abstract class ContentHandler {
50 /**
51 * Convenience function for getting flat text from a Content object. This
52 * should only be used in the context of backwards compatibility with code
53 * that is not yet able to handle Content objects!
55 * If $content is null, this method returns the empty string.
57 * If $content is an instance of TextContent, this method returns the flat
58 * text as returned by $content->getNativeData().
60 * If $content is not a TextContent object, the behavior of this method
61 * depends on the global $wgContentHandlerTextFallback:
62 * - If $wgContentHandlerTextFallback is 'fail' and $content is not a
63 * TextContent object, an MWException is thrown.
64 * - If $wgContentHandlerTextFallback is 'serialize' and $content is not a
65 * TextContent object, $content->serialize() is called to get a string
66 * form of the content.
67 * - If $wgContentHandlerTextFallback is 'ignore' and $content is not a
68 * TextContent object, this method returns null.
69 * - otherwise, the behavior is undefined.
71 * @since 1.21
73 * @param Content $content
75 * @throws MWException If the content is not an instance of TextContent and
76 * wgContentHandlerTextFallback was set to 'fail'.
77 * @return string|null Textual form of the content, if available.
79 public static function getContentText( Content $content = null ) {
80 global $wgContentHandlerTextFallback;
82 if ( is_null( $content ) ) {
83 return '';
86 if ( $content instanceof TextContent ) {
87 return $content->getNativeData();
90 wfDebugLog( 'ContentHandler', 'Accessing ' . $content->getModel() . ' content as text!' );
92 if ( $wgContentHandlerTextFallback == 'fail' ) {
93 throw new MWException(
94 "Attempt to get text from Content with model " .
95 $content->getModel()
99 if ( $wgContentHandlerTextFallback == 'serialize' ) {
100 return $content->serialize();
103 return null;
107 * Convenience function for creating a Content object from a given textual
108 * representation.
110 * $text will be deserialized into a Content object of the model specified
111 * by $modelId (or, if that is not given, $title->getContentModel()) using
112 * the given format.
114 * @since 1.21
116 * @param string $text The textual representation, will be
117 * unserialized to create the Content object
118 * @param Title $title The title of the page this text belongs to.
119 * Required if $modelId is not provided.
120 * @param string $modelId The model to deserialize to. If not provided,
121 * $title->getContentModel() is used.
122 * @param string $format The format to use for deserialization. If not
123 * given, the model's default format is used.
125 * @throws MWException If model ID or format is not supported or if the text can not be
126 * unserialized using the format.
127 * @return Content A Content object representing the text.
129 public static function makeContent( $text, Title $title = null,
130 $modelId = null, $format = null ) {
131 if ( is_null( $modelId ) ) {
132 if ( is_null( $title ) ) {
133 throw new MWException( "Must provide a Title object or a content model ID." );
136 $modelId = $title->getContentModel();
139 $handler = self::getForModelID( $modelId );
141 return $handler->unserializeContent( $text, $format );
145 * Returns the name of the default content model to be used for the page
146 * with the given title.
148 * Note: There should rarely be need to call this method directly.
149 * To determine the actual content model for a given page, use
150 * Title::getContentModel().
152 * Which model is to be used by default for the page is determined based
153 * on several factors:
154 * - The global setting $wgNamespaceContentModels specifies a content model
155 * per namespace.
156 * - The hook ContentHandlerDefaultModelFor may be used to override the page's default
157 * model.
158 * - Pages in NS_MEDIAWIKI and NS_USER default to the CSS or JavaScript
159 * model if they end in .js or .css, respectively.
160 * - Pages in NS_MEDIAWIKI default to the wikitext model otherwise.
161 * - The hook TitleIsCssOrJsPage may be used to force a page to use the CSS
162 * or JavaScript model. This is a compatibility feature. The ContentHandlerDefaultModelFor
163 * hook should be used instead if possible.
164 * - The hook TitleIsWikitextPage may be used to force a page to use the
165 * wikitext model. This is a compatibility feature. The ContentHandlerDefaultModelFor
166 * hook should be used instead if possible.
168 * If none of the above applies, the wikitext model is used.
170 * Note: this is used by, and may thus not use, Title::getContentModel()
172 * @since 1.21
174 * @param Title $title
176 * @return string Default model name for the page given by $title
178 public static function getDefaultModelFor( Title $title ) {
179 // NOTE: this method must not rely on $title->getContentModel() directly or indirectly,
180 // because it is used to initialize the mContentModel member.
182 $ns = $title->getNamespace();
184 $ext = false;
185 $m = null;
186 $model = MWNamespace::getNamespaceContentModel( $ns );
188 // Hook can determine default model
189 if ( !Hooks::run( 'ContentHandlerDefaultModelFor', [ $title, &$model ] ) ) {
190 if ( !is_null( $model ) ) {
191 return $model;
195 // Could this page contain code based on the title?
196 $isCodePage = NS_MEDIAWIKI == $ns && preg_match( '!\.(css|js|json)$!u', $title->getText(), $m );
197 if ( $isCodePage ) {
198 $ext = $m[1];
201 // Is this a user subpage containing code?
202 $isCodeSubpage = NS_USER == $ns
203 && !$isCodePage
204 && preg_match( "/\\/.*\\.(js|css|json)$/", $title->getText(), $m );
205 if ( $isCodeSubpage ) {
206 $ext = $m[1];
209 // Is this wikitext, according to $wgNamespaceContentModels or the DefaultModelFor hook?
210 $isWikitext = is_null( $model ) || $model == CONTENT_MODEL_WIKITEXT;
211 $isWikitext = $isWikitext && !$isCodePage && !$isCodeSubpage;
213 if ( !$isWikitext ) {
214 switch ( $ext ) {
215 case 'js':
216 return CONTENT_MODEL_JAVASCRIPT;
217 case 'css':
218 return CONTENT_MODEL_CSS;
219 case 'json':
220 return CONTENT_MODEL_JSON;
221 default:
222 return is_null( $model ) ? CONTENT_MODEL_TEXT : $model;
226 // We established that it must be wikitext
228 return CONTENT_MODEL_WIKITEXT;
232 * Returns the appropriate ContentHandler singleton for the given title.
234 * @since 1.21
236 * @param Title $title
238 * @return ContentHandler
240 public static function getForTitle( Title $title ) {
241 $modelId = $title->getContentModel();
243 return self::getForModelID( $modelId );
247 * Returns the appropriate ContentHandler singleton for the given Content
248 * object.
250 * @since 1.21
252 * @param Content $content
254 * @return ContentHandler
256 public static function getForContent( Content $content ) {
257 $modelId = $content->getModel();
259 return self::getForModelID( $modelId );
263 * @var array A Cache of ContentHandler instances by model id
265 protected static $handlers;
268 * Returns the ContentHandler singleton for the given model ID. Use the
269 * CONTENT_MODEL_XXX constants to identify the desired content model.
271 * ContentHandler singletons are taken from the global $wgContentHandlers
272 * array. Keys in that array are model names, the values are either
273 * ContentHandler singleton objects, or strings specifying the appropriate
274 * subclass of ContentHandler.
276 * If a class name is encountered when looking up the singleton for a given
277 * model name, the class is instantiated and the class name is replaced by
278 * the resulting singleton in $wgContentHandlers.
280 * If no ContentHandler is defined for the desired $modelId, the
281 * ContentHandler may be provided by the ContentHandlerForModelID hook.
282 * If no ContentHandler can be determined, an MWException is raised.
284 * @since 1.21
286 * @param string $modelId The ID of the content model for which to get a
287 * handler. Use CONTENT_MODEL_XXX constants.
289 * @throws MWException For internal errors and problems in the configuration.
290 * @throws MWUnknownContentModelException If no handler is known for the model ID.
291 * @return ContentHandler The ContentHandler singleton for handling the model given by the ID.
293 public static function getForModelID( $modelId ) {
294 global $wgContentHandlers;
296 if ( isset( self::$handlers[$modelId] ) ) {
297 return self::$handlers[$modelId];
300 if ( empty( $wgContentHandlers[$modelId] ) ) {
301 $handler = null;
303 Hooks::run( 'ContentHandlerForModelID', [ $modelId, &$handler ] );
305 if ( $handler === null ) {
306 throw new MWUnknownContentModelException( $modelId );
309 if ( !( $handler instanceof ContentHandler ) ) {
310 throw new MWException( "ContentHandlerForModelID must supply a ContentHandler instance" );
312 } else {
313 $classOrCallback = $wgContentHandlers[$modelId];
315 if ( is_callable( $classOrCallback ) ) {
316 $handler = call_user_func( $classOrCallback, $modelId );
317 } else {
318 $handler = new $classOrCallback( $modelId );
321 if ( !( $handler instanceof ContentHandler ) ) {
322 throw new MWException( "$classOrCallback from \$wgContentHandlers is not " .
323 "compatible with ContentHandler" );
327 wfDebugLog( 'ContentHandler', 'Created handler for ' . $modelId
328 . ': ' . get_class( $handler ) );
330 self::$handlers[$modelId] = $handler;
332 return self::$handlers[$modelId];
336 * Returns the localized name for a given content model.
338 * Model names are localized using system messages. Message keys
339 * have the form content-model-$name, where $name is getContentModelName( $id ).
341 * @param string $name The content model ID, as given by a CONTENT_MODEL_XXX
342 * constant or returned by Revision::getContentModel().
343 * @param Language|null $lang The language to parse the message in (since 1.26)
345 * @throws MWException If the model ID isn't known.
346 * @return string The content model's localized name.
348 public static function getLocalizedName( $name, Language $lang = null ) {
349 // Messages: content-model-wikitext, content-model-text,
350 // content-model-javascript, content-model-css
351 $key = "content-model-$name";
353 $msg = wfMessage( $key );
354 if ( $lang ) {
355 $msg->inLanguage( $lang );
358 return $msg->exists() ? $msg->plain() : $name;
361 public static function getContentModels() {
362 global $wgContentHandlers;
364 $models = array_keys( $wgContentHandlers );
365 Hooks::run( 'GetContentModels', [ &$models ] );
366 return $models;
369 public static function getAllContentFormats() {
370 global $wgContentHandlers;
372 $formats = [];
374 foreach ( $wgContentHandlers as $model => $class ) {
375 $handler = self::getForModelID( $model );
376 $formats = array_merge( $formats, $handler->getSupportedFormats() );
379 $formats = array_unique( $formats );
381 return $formats;
384 // ------------------------------------------------------------------------
387 * @var string
389 protected $mModelID;
392 * @var string[]
394 protected $mSupportedFormats;
397 * Constructor, initializing the ContentHandler instance with its model ID
398 * and a list of supported formats. Values for the parameters are typically
399 * provided as literals by subclass's constructors.
401 * @param string $modelId (use CONTENT_MODEL_XXX constants).
402 * @param string[] $formats List for supported serialization formats
403 * (typically as MIME types)
405 public function __construct( $modelId, $formats ) {
406 $this->mModelID = $modelId;
407 $this->mSupportedFormats = $formats;
411 * Serializes a Content object of the type supported by this ContentHandler.
413 * @since 1.21
415 * @param Content $content The Content object to serialize
416 * @param string $format The desired serialization format
418 * @return string Serialized form of the content
420 abstract public function serializeContent( Content $content, $format = null );
423 * Applies transformations on export (returns the blob unchanged per default).
424 * Subclasses may override this to perform transformations such as conversion
425 * of legacy formats or filtering of internal meta-data.
427 * @param string $blob The blob to be exported
428 * @param string|null $format The blob's serialization format
430 * @return string
432 public function exportTransform( $blob, $format = null ) {
433 return $blob;
437 * Unserializes a Content object of the type supported by this ContentHandler.
439 * @since 1.21
441 * @param string $blob Serialized form of the content
442 * @param string $format The format used for serialization
444 * @return Content The Content object created by deserializing $blob
446 abstract public function unserializeContent( $blob, $format = null );
449 * Apply import transformation (per default, returns $blob unchanged).
450 * This gives subclasses an opportunity to transform data blobs on import.
452 * @since 1.24
454 * @param string $blob
455 * @param string|null $format
457 * @return string
459 public function importTransform( $blob, $format = null ) {
460 return $blob;
464 * Creates an empty Content object of the type supported by this
465 * ContentHandler.
467 * @since 1.21
469 * @return Content
471 abstract public function makeEmptyContent();
474 * Creates a new Content object that acts as a redirect to the given page,
475 * or null if redirects are not supported by this content model.
477 * This default implementation always returns null. Subclasses supporting redirects
478 * must override this method.
480 * Note that subclasses that override this method to return a Content object
481 * should also override supportsRedirects() to return true.
483 * @since 1.21
485 * @param Title $destination The page to redirect to.
486 * @param string $text Text to include in the redirect, if possible.
488 * @return Content Always null.
490 public function makeRedirectContent( Title $destination, $text = '' ) {
491 return null;
495 * Returns the model id that identifies the content model this
496 * ContentHandler can handle. Use with the CONTENT_MODEL_XXX constants.
498 * @since 1.21
500 * @return string The model ID
502 public function getModelID() {
503 return $this->mModelID;
507 * @since 1.21
509 * @param string $model_id The model to check
511 * @throws MWException If the model ID is not the ID of the content model supported by this
512 * ContentHandler.
514 protected function checkModelID( $model_id ) {
515 if ( $model_id !== $this->mModelID ) {
516 throw new MWException( "Bad content model: " .
517 "expected {$this->mModelID} " .
518 "but got $model_id." );
523 * Returns a list of serialization formats supported by the
524 * serializeContent() and unserializeContent() methods of this
525 * ContentHandler.
527 * @since 1.21
529 * @return string[] List of serialization formats as MIME type like strings
531 public function getSupportedFormats() {
532 return $this->mSupportedFormats;
536 * The format used for serialization/deserialization by default by this
537 * ContentHandler.
539 * This default implementation will return the first element of the array
540 * of formats that was passed to the constructor.
542 * @since 1.21
544 * @return string The name of the default serialization format as a MIME type
546 public function getDefaultFormat() {
547 return $this->mSupportedFormats[0];
551 * Returns true if $format is a serialization format supported by this
552 * ContentHandler, and false otherwise.
554 * Note that if $format is null, this method always returns true, because
555 * null means "use the default format".
557 * @since 1.21
559 * @param string $format The serialization format to check
561 * @return bool
563 public function isSupportedFormat( $format ) {
564 if ( !$format ) {
565 return true; // this means "use the default"
568 return in_array( $format, $this->mSupportedFormats );
572 * Convenient for checking whether a format provided as a parameter is actually supported.
574 * @param string $format The serialization format to check
576 * @throws MWException If the format is not supported by this content handler.
578 protected function checkFormat( $format ) {
579 if ( !$this->isSupportedFormat( $format ) ) {
580 throw new MWException(
581 "Format $format is not supported for content model "
582 . $this->getModelID()
588 * Returns overrides for action handlers.
589 * Classes listed here will be used instead of the default one when
590 * (and only when) $wgActions[$action] === true. This allows subclasses
591 * to override the default action handlers.
593 * @since 1.21
595 * @return array An array mapping action names (typically "view", "edit", "history" etc.) to
596 * either the full qualified class name of an Action class, a callable taking ( Page $page,
597 * IContextSource $context = null ) as parameters and returning an Action object, or an actual
598 * Action object. An empty array in this default implementation.
600 * @see Action::factory
602 public function getActionOverrides() {
603 return [];
607 * Factory for creating an appropriate DifferenceEngine for this content model.
609 * @since 1.21
611 * @param IContextSource $context Context to use, anything else will be ignored.
612 * @param int $old Revision ID we want to show and diff with.
613 * @param int|string $new Either a revision ID or one of the strings 'cur', 'prev' or 'next'.
614 * @param int $rcid FIXME: Deprecated, no longer used. Defaults to 0.
615 * @param bool $refreshCache If set, refreshes the diff cache. Defaults to false.
616 * @param bool $unhide If set, allow viewing deleted revs. Defaults to false.
618 * @return DifferenceEngine
620 public function createDifferenceEngine( IContextSource $context, $old = 0, $new = 0,
621 $rcid = 0, // FIXME: Deprecated, no longer used
622 $refreshCache = false, $unhide = false
624 // hook: get difference engine
625 $differenceEngine = null;
626 if ( !Hooks::run( 'GetDifferenceEngine',
627 [ $context, $old, $new, $refreshCache, $unhide, &$differenceEngine ]
628 ) ) {
629 return $differenceEngine;
631 $diffEngineClass = $this->getDiffEngineClass();
632 return new $diffEngineClass( $context, $old, $new, $rcid, $refreshCache, $unhide );
636 * Get the language in which the content of the given page is written.
638 * This default implementation just returns $wgContLang (except for pages
639 * in the MediaWiki namespace)
641 * Note that the pages language is not cacheable, since it may in some
642 * cases depend on user settings.
644 * Also note that the page language may or may not depend on the actual content of the page,
645 * that is, this method may load the content in order to determine the language.
647 * @since 1.21
649 * @param Title $title The page to determine the language for.
650 * @param Content $content The page's content, if you have it handy, to avoid reloading it.
652 * @return Language The page's language
654 public function getPageLanguage( Title $title, Content $content = null ) {
655 global $wgContLang, $wgLang;
656 $pageLang = $wgContLang;
658 if ( $title->getNamespace() == NS_MEDIAWIKI ) {
659 // Parse mediawiki messages with correct target language
660 list( /* $unused */, $lang ) = MessageCache::singleton()->figureMessage( $title->getText() );
661 $pageLang = Language::factory( $lang );
664 Hooks::run( 'PageContentLanguage', [ $title, &$pageLang, $wgLang ] );
666 return wfGetLangObj( $pageLang );
670 * Get the language in which the content of this page is written when
671 * viewed by user. Defaults to $this->getPageLanguage(), but if the user
672 * specified a preferred variant, the variant will be used.
674 * This default implementation just returns $this->getPageLanguage( $title, $content ) unless
675 * the user specified a preferred variant.
677 * Note that the pages view language is not cacheable, since it depends on user settings.
679 * Also note that the page language may or may not depend on the actual content of the page,
680 * that is, this method may load the content in order to determine the language.
682 * @since 1.21
684 * @param Title $title The page to determine the language for.
685 * @param Content $content The page's content, if you have it handy, to avoid reloading it.
687 * @return Language The page's language for viewing
689 public function getPageViewLanguage( Title $title, Content $content = null ) {
690 $pageLang = $this->getPageLanguage( $title, $content );
692 if ( $title->getNamespace() !== NS_MEDIAWIKI ) {
693 // If the user chooses a variant, the content is actually
694 // in a language whose code is the variant code.
695 $variant = $pageLang->getPreferredVariant();
696 if ( $pageLang->getCode() !== $variant ) {
697 $pageLang = Language::factory( $variant );
701 return $pageLang;
705 * Determines whether the content type handled by this ContentHandler
706 * can be used on the given page.
708 * This default implementation always returns true.
709 * Subclasses may override this to restrict the use of this content model to specific locations,
710 * typically based on the namespace or some other aspect of the title, such as a special suffix
711 * (e.g. ".svg" for SVG content).
713 * @note this calls the ContentHandlerCanBeUsedOn hook which may be used to override which
714 * content model can be used where.
716 * @param Title $title The page's title.
718 * @return bool True if content of this kind can be used on the given page, false otherwise.
720 public function canBeUsedOn( Title $title ) {
721 $ok = true;
723 Hooks::run( 'ContentModelCanBeUsedOn', [ $this->getModelID(), $title, &$ok ] );
725 return $ok;
729 * Returns the name of the diff engine to use.
731 * @since 1.21
733 * @return string
735 protected function getDiffEngineClass() {
736 return DifferenceEngine::class;
740 * Attempts to merge differences between three versions. Returns a new
741 * Content object for a clean merge and false for failure or a conflict.
743 * This default implementation always returns false.
745 * @since 1.21
747 * @param Content $oldContent The page's previous content.
748 * @param Content $myContent One of the page's conflicting contents.
749 * @param Content $yourContent One of the page's conflicting contents.
751 * @return Content|bool Always false.
753 public function merge3( Content $oldContent, Content $myContent, Content $yourContent ) {
754 return false;
758 * Return an applicable auto-summary if one exists for the given edit.
760 * @since 1.21
762 * @param Content $oldContent The previous text of the page.
763 * @param Content $newContent The submitted text of the page.
764 * @param int $flags Bit mask: a bit mask of flags submitted for the edit.
766 * @return string An appropriate auto-summary, or an empty string.
768 public function getAutosummary( Content $oldContent = null, Content $newContent = null,
769 $flags ) {
770 // Decide what kind of auto-summary is needed.
772 // Redirect auto-summaries
775 * @var $ot Title
776 * @var $rt Title
779 $ot = !is_null( $oldContent ) ? $oldContent->getRedirectTarget() : null;
780 $rt = !is_null( $newContent ) ? $newContent->getRedirectTarget() : null;
782 if ( is_object( $rt ) ) {
783 if ( !is_object( $ot )
784 || !$rt->equals( $ot )
785 || $ot->getFragment() != $rt->getFragment()
787 $truncatedtext = $newContent->getTextForSummary(
789 - strlen( wfMessage( 'autoredircomment' )->inContentLanguage()->text() )
790 - strlen( $rt->getFullText() ) );
792 return wfMessage( 'autoredircomment', $rt->getFullText() )
793 ->rawParams( $truncatedtext )->inContentLanguage()->text();
797 // New page auto-summaries
798 if ( $flags & EDIT_NEW && $newContent->getSize() > 0 ) {
799 // If they're making a new article, give its text, truncated, in
800 // the summary.
802 $truncatedtext = $newContent->getTextForSummary(
803 200 - strlen( wfMessage( 'autosumm-new' )->inContentLanguage()->text() ) );
805 return wfMessage( 'autosumm-new' )->rawParams( $truncatedtext )
806 ->inContentLanguage()->text();
809 // Blanking auto-summaries
810 if ( !empty( $oldContent ) && $oldContent->getSize() > 0 && $newContent->getSize() == 0 ) {
811 return wfMessage( 'autosumm-blank' )->inContentLanguage()->text();
812 } elseif ( !empty( $oldContent )
813 && $oldContent->getSize() > 10 * $newContent->getSize()
814 && $newContent->getSize() < 500
816 // Removing more than 90% of the article
818 $truncatedtext = $newContent->getTextForSummary(
819 200 - strlen( wfMessage( 'autosumm-replace' )->inContentLanguage()->text() ) );
821 return wfMessage( 'autosumm-replace' )->rawParams( $truncatedtext )
822 ->inContentLanguage()->text();
825 // New blank article auto-summary
826 if ( $flags & EDIT_NEW && $newContent->isEmpty() ) {
827 return wfMessage( 'autosumm-newblank' )->inContentLanguage()->text();
830 // If we reach this point, there's no applicable auto-summary for our
831 // case, so our auto-summary is empty.
832 return '';
836 * Auto-generates a deletion reason
838 * @since 1.21
840 * @param Title $title The page's title
841 * @param bool &$hasHistory Whether the page has a history
843 * @return mixed String containing deletion reason or empty string, or
844 * boolean false if no revision occurred
846 * @todo &$hasHistory is extremely ugly, it's here because
847 * WikiPage::getAutoDeleteReason() and Article::generateReason()
848 * have it / want it.
850 public function getAutoDeleteReason( Title $title, &$hasHistory ) {
851 $dbr = wfGetDB( DB_REPLICA );
853 // Get the last revision
854 $rev = Revision::newFromTitle( $title );
856 if ( is_null( $rev ) ) {
857 return false;
860 // Get the article's contents
861 $content = $rev->getContent();
862 $blank = false;
864 // If the page is blank, use the text from the previous revision,
865 // which can only be blank if there's a move/import/protect dummy
866 // revision involved
867 if ( !$content || $content->isEmpty() ) {
868 $prev = $rev->getPrevious();
870 if ( $prev ) {
871 $rev = $prev;
872 $content = $rev->getContent();
873 $blank = true;
877 $this->checkModelID( $rev->getContentModel() );
879 // Find out if there was only one contributor
880 // Only scan the last 20 revisions
881 $res = $dbr->select( 'revision', 'rev_user_text',
883 'rev_page' => $title->getArticleID(),
884 $dbr->bitAnd( 'rev_deleted', Revision::DELETED_USER ) . ' = 0'
886 __METHOD__,
887 [ 'LIMIT' => 20 ]
890 if ( $res === false ) {
891 // This page has no revisions, which is very weird
892 return false;
895 $hasHistory = ( $res->numRows() > 1 );
896 $row = $dbr->fetchObject( $res );
898 if ( $row ) { // $row is false if the only contributor is hidden
899 $onlyAuthor = $row->rev_user_text;
900 // Try to find a second contributor
901 foreach ( $res as $row ) {
902 if ( $row->rev_user_text != $onlyAuthor ) { // T24999
903 $onlyAuthor = false;
904 break;
907 } else {
908 $onlyAuthor = false;
911 // Generate the summary with a '$1' placeholder
912 if ( $blank ) {
913 // The current revision is blank and the one before is also
914 // blank. It's just not our lucky day
915 $reason = wfMessage( 'exbeforeblank', '$1' )->inContentLanguage()->text();
916 } else {
917 if ( $onlyAuthor ) {
918 $reason = wfMessage(
919 'excontentauthor',
920 '$1',
921 $onlyAuthor
922 )->inContentLanguage()->text();
923 } else {
924 $reason = wfMessage( 'excontent', '$1' )->inContentLanguage()->text();
928 if ( $reason == '-' ) {
929 // Allow these UI messages to be blanked out cleanly
930 return '';
933 // Max content length = max comment length - length of the comment (excl. $1)
934 $text = $content ? $content->getTextForSummary( 255 - ( strlen( $reason ) - 2 ) ) : '';
936 // Now replace the '$1' placeholder
937 $reason = str_replace( '$1', $text, $reason );
939 return $reason;
943 * Get the Content object that needs to be saved in order to undo all revisions
944 * between $undo and $undoafter. Revisions must belong to the same page,
945 * must exist and must not be deleted.
947 * @since 1.21
949 * @param Revision $current The current text
950 * @param Revision $undo The revision to undo
951 * @param Revision $undoafter Must be an earlier revision than $undo
953 * @return mixed String on success, false on failure
955 public function getUndoContent( Revision $current, Revision $undo, Revision $undoafter ) {
956 $cur_content = $current->getContent();
958 if ( empty( $cur_content ) ) {
959 return false; // no page
962 $undo_content = $undo->getContent();
963 $undoafter_content = $undoafter->getContent();
965 if ( !$undo_content || !$undoafter_content ) {
966 return false; // no content to undo
969 try {
970 $this->checkModelID( $cur_content->getModel() );
971 $this->checkModelID( $undo_content->getModel() );
972 if ( $current->getId() !== $undo->getId() ) {
973 // If we are undoing the most recent revision,
974 // its ok to revert content model changes. However
975 // if we are undoing a revision in the middle, then
976 // doing that will be confusing.
977 $this->checkModelID( $undoafter_content->getModel() );
979 } catch ( MWException $e ) {
980 // If the revisions have different content models
981 // just return false
982 return false;
985 if ( $cur_content->equals( $undo_content ) ) {
986 // No use doing a merge if it's just a straight revert.
987 return $undoafter_content;
990 $undone_content = $this->merge3( $undo_content, $undoafter_content, $cur_content );
992 return $undone_content;
996 * Get parser options suitable for rendering and caching the article
998 * @param IContextSource|User|string $context One of the following:
999 * - IContextSource: Use the User and the Language of the provided
1000 * context
1001 * - User: Use the provided User object and $wgLang for the language,
1002 * so use an IContextSource object if possible.
1003 * - 'canonical': Canonical options (anonymous user with default
1004 * preferences and content language).
1006 * @throws MWException
1007 * @return ParserOptions
1009 public function makeParserOptions( $context ) {
1010 global $wgContLang;
1012 if ( $context instanceof IContextSource ) {
1013 $user = $context->getUser();
1014 $lang = $context->getLanguage();
1015 } elseif ( $context instanceof User ) { // settings per user (even anons)
1016 $user = $context;
1017 $lang = null;
1018 } elseif ( $context === 'canonical' ) { // canonical settings
1019 $user = new User;
1020 $lang = $wgContLang;
1021 } else {
1022 throw new MWException( "Bad context for parser options: $context" );
1025 return ParserOptions::newCanonical( $user, $lang );
1029 * Returns true for content models that support caching using the
1030 * ParserCache mechanism. See WikiPage::shouldCheckParserCache().
1032 * @since 1.21
1034 * @return bool Always false.
1036 public function isParserCacheSupported() {
1037 return false;
1041 * Returns true if this content model supports sections.
1042 * This default implementation returns false.
1044 * Content models that return true here should also implement
1045 * Content::getSection, Content::replaceSection, etc. to handle sections..
1047 * @return bool Always false.
1049 public function supportsSections() {
1050 return false;
1054 * Returns true if this content model supports categories.
1055 * The default implementation returns true.
1057 * @return bool Always true.
1059 public function supportsCategories() {
1060 return true;
1064 * Returns true if this content model supports redirects.
1065 * This default implementation returns false.
1067 * Content models that return true here should also implement
1068 * ContentHandler::makeRedirectContent to return a Content object.
1070 * @return bool Always false.
1072 public function supportsRedirects() {
1073 return false;
1077 * Return true if this content model supports direct editing, such as via EditPage.
1079 * @return bool Default is false, and true for TextContent and it's derivatives.
1081 public function supportsDirectEditing() {
1082 return false;
1086 * Whether or not this content model supports direct editing via ApiEditPage
1088 * @return bool Default is false, and true for TextContent and derivatives.
1090 public function supportsDirectApiEditing() {
1091 return $this->supportsDirectEditing();
1095 * Get fields definition for search index
1097 * @todo Expose title, redirect, namespace, text, source_text, text_bytes
1098 * field mappings here. (see T142670 and T143409)
1100 * @param SearchEngine $engine
1101 * @return SearchIndexField[] List of fields this content handler can provide.
1102 * @since 1.28
1104 public function getFieldsForSearchIndex( SearchEngine $engine ) {
1105 $fields['category'] = $engine->makeSearchFieldMapping(
1106 'category',
1107 SearchIndexField::INDEX_TYPE_TEXT
1109 $fields['category']->setFlag( SearchIndexField::FLAG_CASEFOLD );
1111 $fields['external_link'] = $engine->makeSearchFieldMapping(
1112 'external_link',
1113 SearchIndexField::INDEX_TYPE_KEYWORD
1116 $fields['outgoing_link'] = $engine->makeSearchFieldMapping(
1117 'outgoing_link',
1118 SearchIndexField::INDEX_TYPE_KEYWORD
1121 $fields['template'] = $engine->makeSearchFieldMapping(
1122 'template',
1123 SearchIndexField::INDEX_TYPE_KEYWORD
1125 $fields['template']->setFlag( SearchIndexField::FLAG_CASEFOLD );
1127 $fields['content_model'] = $engine->makeSearchFieldMapping(
1128 'content_model',
1129 SearchIndexField::INDEX_TYPE_KEYWORD
1132 return $fields;
1136 * Add new field definition to array.
1137 * @param SearchIndexField[] &$fields
1138 * @param SearchEngine $engine
1139 * @param string $name
1140 * @param int $type
1141 * @return SearchIndexField[] new field defs
1142 * @since 1.28
1144 protected function addSearchField( &$fields, SearchEngine $engine, $name, $type ) {
1145 $fields[$name] = $engine->makeSearchFieldMapping( $name, $type );
1146 return $fields;
1150 * Return fields to be indexed by search engine
1151 * as representation of this document.
1152 * Overriding class should call parent function or take care of calling
1153 * the SearchDataForIndex hook.
1154 * @param WikiPage $page Page to index
1155 * @param ParserOutput $output
1156 * @param SearchEngine $engine Search engine for which we are indexing
1157 * @return array Map of name=>value for fields
1158 * @since 1.28
1160 public function getDataForSearchIndex(
1161 WikiPage $page,
1162 ParserOutput $output,
1163 SearchEngine $engine
1165 $fieldData = [];
1166 $content = $page->getContent();
1168 if ( $content ) {
1169 $searchDataExtractor = new ParserOutputSearchDataExtractor();
1171 $fieldData['category'] = $searchDataExtractor->getCategories( $output );
1172 $fieldData['external_link'] = $searchDataExtractor->getExternalLinks( $output );
1173 $fieldData['outgoing_link'] = $searchDataExtractor->getOutgoingLinks( $output );
1174 $fieldData['template'] = $searchDataExtractor->getTemplates( $output );
1176 $text = $content->getTextForSearchIndex();
1178 $fieldData['text'] = $text;
1179 $fieldData['source_text'] = $text;
1180 $fieldData['text_bytes'] = $content->getSize();
1181 $fieldData['content_model'] = $content->getModel();
1184 Hooks::run( 'SearchDataForIndex', [ &$fieldData, $this, $page, $output, $engine ] );
1185 return $fieldData;
1189 * Produce page output suitable for indexing.
1191 * Specific content handlers may override it if they need different content handling.
1193 * @param WikiPage $page
1194 * @param ParserCache $cache
1195 * @return ParserOutput
1197 public function getParserOutputForIndexing( WikiPage $page, ParserCache $cache = null ) {
1198 $parserOptions = $page->makeParserOptions( 'canonical' );
1199 $revId = $page->getRevision()->getId();
1200 if ( $cache ) {
1201 $parserOutput = $cache->get( $page, $parserOptions );
1203 if ( empty( $parserOutput ) ) {
1204 $parserOutput =
1205 $page->getContent()->getParserOutput( $page->getTitle(), $revId, $parserOptions );
1206 if ( $cache ) {
1207 $cache->save( $parserOutput, $page, $parserOptions );
1210 return $parserOutput;