4 * Base class for content handling.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 * http://www.gnu.org/copyleft/gpl.html
26 * @author Daniel Kinzler
29 use Wikimedia\Assert\Assert
;
30 use MediaWiki\Logger\LoggerFactory
;
31 use MediaWiki\MediaWikiServices
;
32 use MediaWiki\Revision\SlotRenderingProvider
;
33 use MediaWiki\Search\ParserOutputSearchDataExtractor
;
36 * A content handler knows how do deal with a specific type of content on a wiki
37 * page. Content is stored in the database in a serialized form (using a
38 * serialization format a.k.a. MIME type) and is unserialized into its native
39 * PHP representation (the content model), which is wrapped in an instance of
40 * the appropriate subclass of Content.
42 * ContentHandler instances are stateless singletons that serve, among other
43 * things, as a factory for Content objects. Generally, there is one subclass
44 * of ContentHandler and one subclass of Content for every type of content model.
46 * Some content types have a flat model, that is, their native representation
47 * is the same as their serialized form. Examples would be JavaScript and CSS
48 * code. As of now, this also applies to wikitext (MediaWiki's default content
49 * type), but wikitext content may be represented by a DOM or AST structure in
54 abstract class ContentHandler
{
56 * Convenience function for getting flat text from a Content object. This
57 * should only be used in the context of backwards compatibility with code
58 * that is not yet able to handle Content objects!
60 * If $content is null, this method returns the empty string.
62 * If $content is an instance of TextContent, this method returns the flat
63 * text as returned by $content->getText().
65 * If $content is not a TextContent object, the behavior of this method
66 * depends on the global $wgContentHandlerTextFallback:
67 * - If $wgContentHandlerTextFallback is 'fail' and $content is not a
68 * TextContent object, an MWException is thrown.
69 * - If $wgContentHandlerTextFallback is 'serialize' and $content is not a
70 * TextContent object, $content->serialize() is called to get a string
71 * form of the content.
72 * - If $wgContentHandlerTextFallback is 'ignore' and $content is not a
73 * TextContent object, this method returns null.
74 * - otherwise, the behavior is undefined.
78 * @param Content|null $content
80 * @throws MWException If the content is not an instance of TextContent and
81 * wgContentHandlerTextFallback was set to 'fail'.
82 * @return string|null Textual form of the content, if available.
84 public static function getContentText( Content
$content = null ) {
85 global $wgContentHandlerTextFallback;
87 if ( is_null( $content ) ) {
91 if ( $content instanceof TextContent
) {
92 return $content->getText();
95 wfDebugLog( 'ContentHandler', 'Accessing ' . $content->getModel() . ' content as text!' );
97 if ( $wgContentHandlerTextFallback == 'fail' ) {
98 throw new MWException(
99 "Attempt to get text from Content with model " .
104 if ( $wgContentHandlerTextFallback == 'serialize' ) {
105 return $content->serialize();
112 * Convenience function for creating a Content object from a given textual
115 * $text will be deserialized into a Content object of the model specified
116 * by $modelId (or, if that is not given, $title->getContentModel()) using
121 * @param string $text The textual representation, will be
122 * unserialized to create the Content object
123 * @param Title|null $title The title of the page this text belongs to.
124 * Required if $modelId is not provided.
125 * @param string|null $modelId The model to deserialize to. If not provided,
126 * $title->getContentModel() is used.
127 * @param string|null $format The format to use for deserialization. If not
128 * given, the model's default format is used.
130 * @throws MWException If model ID or format is not supported or if the text can not be
131 * unserialized using the format.
132 * @return Content A Content object representing the text.
134 public static function makeContent( $text, Title
$title = null,
135 $modelId = null, $format = null ) {
136 if ( is_null( $modelId ) ) {
137 if ( is_null( $title ) ) {
138 throw new MWException( "Must provide a Title object or a content model ID." );
141 $modelId = $title->getContentModel();
144 $handler = self
::getForModelID( $modelId );
146 return $handler->unserializeContent( $text, $format );
150 * Returns the name of the default content model to be used for the page
151 * with the given title.
153 * Note: There should rarely be need to call this method directly.
154 * To determine the actual content model for a given page, use
155 * Title::getContentModel().
157 * Which model is to be used by default for the page is determined based
158 * on several factors:
159 * - The global setting $wgNamespaceContentModels specifies a content model
161 * - The hook ContentHandlerDefaultModelFor may be used to override the page's default
163 * - Pages in NS_MEDIAWIKI and NS_USER default to the CSS or JavaScript
164 * model if they end in .js or .css, respectively.
165 * - Pages in NS_MEDIAWIKI default to the wikitext model otherwise.
166 * - The hook TitleIsCssOrJsPage may be used to force a page to use the CSS
167 * or JavaScript model. This is a compatibility feature. The ContentHandlerDefaultModelFor
168 * hook should be used instead if possible.
169 * - The hook TitleIsWikitextPage may be used to force a page to use the
170 * wikitext model. This is a compatibility feature. The ContentHandlerDefaultModelFor
171 * hook should be used instead if possible.
173 * If none of the above applies, the wikitext model is used.
175 * Note: this is used by, and may thus not use, Title::getContentModel()
178 * @deprecated since 1.33, use SlotRoleHandler::getDefaultModel() together with
179 * SlotRoleRegistry::getRoleHandler().
181 * @param Title $title
183 * @return string Default model name for the page given by $title
185 public static function getDefaultModelFor( Title
$title ) {
186 $slotRoleregistry = MediaWikiServices
::getInstance()->getSlotRoleRegistry();
187 $mainSlotHandler = $slotRoleregistry->getRoleHandler( 'main' );
188 return $mainSlotHandler->getDefaultModel( $title );
192 * Returns the appropriate ContentHandler singleton for the given title.
196 * @param Title $title
198 * @return ContentHandler
200 public static function getForTitle( Title
$title ) {
201 $modelId = $title->getContentModel();
203 return self
::getForModelID( $modelId );
207 * Returns the appropriate ContentHandler singleton for the given Content
212 * @param Content $content
214 * @return ContentHandler
216 public static function getForContent( Content
$content ) {
217 $modelId = $content->getModel();
219 return self
::getForModelID( $modelId );
223 * @var array A Cache of ContentHandler instances by model id
225 protected static $handlers;
228 * Returns the ContentHandler singleton for the given model ID. Use the
229 * CONTENT_MODEL_XXX constants to identify the desired content model.
231 * ContentHandler singletons are taken from the global $wgContentHandlers
232 * array. Keys in that array are model names, the values are either
233 * ContentHandler singleton objects, or strings specifying the appropriate
234 * subclass of ContentHandler.
236 * If a class name is encountered when looking up the singleton for a given
237 * model name, the class is instantiated and the class name is replaced by
238 * the resulting singleton in $wgContentHandlers.
240 * If no ContentHandler is defined for the desired $modelId, the
241 * ContentHandler may be provided by the ContentHandlerForModelID hook.
242 * If no ContentHandler can be determined, an MWException is raised.
246 * @param string $modelId The ID of the content model for which to get a
247 * handler. Use CONTENT_MODEL_XXX constants.
249 * @throws MWException For internal errors and problems in the configuration.
250 * @throws MWUnknownContentModelException If no handler is known for the model ID.
251 * @return ContentHandler The ContentHandler singleton for handling the model given by the ID.
253 public static function getForModelID( $modelId ) {
254 global $wgContentHandlers;
256 if ( isset( self
::$handlers[$modelId] ) ) {
257 return self
::$handlers[$modelId];
260 if ( empty( $wgContentHandlers[$modelId] ) ) {
263 Hooks
::run( 'ContentHandlerForModelID', [ $modelId, &$handler ] );
265 if ( $handler === null ) {
266 throw new MWUnknownContentModelException( $modelId );
269 if ( !( $handler instanceof ContentHandler
) ) {
270 throw new MWException( "ContentHandlerForModelID must supply a ContentHandler instance" );
273 $classOrCallback = $wgContentHandlers[$modelId];
275 if ( is_callable( $classOrCallback ) ) {
276 $handler = call_user_func( $classOrCallback, $modelId );
278 $handler = new $classOrCallback( $modelId );
281 if ( !( $handler instanceof ContentHandler
) ) {
282 throw new MWException( "$classOrCallback from \$wgContentHandlers is not " .
283 "compatible with ContentHandler" );
287 wfDebugLog( 'ContentHandler', 'Created handler for ' . $modelId
288 . ': ' . get_class( $handler ) );
290 self
::$handlers[$modelId] = $handler;
292 return self
::$handlers[$modelId];
296 * Clean up handlers cache.
298 public static function cleanupHandlersCache() {
299 self
::$handlers = [];
303 * Returns the localized name for a given content model.
305 * Model names are localized using system messages. Message keys
306 * have the form content-model-$name, where $name is getContentModelName( $id ).
308 * @param string $name The content model ID, as given by a CONTENT_MODEL_XXX
309 * constant or returned by Revision::getContentModel().
310 * @param Language|null $lang The language to parse the message in (since 1.26)
312 * @throws MWException If the model ID isn't known.
313 * @return string The content model's localized name.
315 public static function getLocalizedName( $name, Language
$lang = null ) {
316 // Messages: content-model-wikitext, content-model-text,
317 // content-model-javascript, content-model-css
318 $key = "content-model-$name";
320 $msg = wfMessage( $key );
322 $msg->inLanguage( $lang );
325 return $msg->exists() ?
$msg->plain() : $name;
328 public static function getContentModels() {
329 global $wgContentHandlers;
331 $models = array_keys( $wgContentHandlers );
332 Hooks
::run( 'GetContentModels', [ &$models ] );
336 public static function getAllContentFormats() {
337 global $wgContentHandlers;
341 foreach ( $wgContentHandlers as $model => $class ) {
342 $handler = self
::getForModelID( $model );
343 $formats = array_merge( $formats, $handler->getSupportedFormats() );
346 $formats = array_unique( $formats );
351 // ------------------------------------------------------------------------
361 protected $mSupportedFormats;
364 * Constructor, initializing the ContentHandler instance with its model ID
365 * and a list of supported formats. Values for the parameters are typically
366 * provided as literals by subclass's constructors.
368 * @param string $modelId (use CONTENT_MODEL_XXX constants).
369 * @param string[] $formats List for supported serialization formats
370 * (typically as MIME types)
372 public function __construct( $modelId, $formats ) {
373 $this->mModelID
= $modelId;
374 $this->mSupportedFormats
= $formats;
378 * Serializes a Content object of the type supported by this ContentHandler.
382 * @param Content $content The Content object to serialize
383 * @param string|null $format The desired serialization format
385 * @return string Serialized form of the content
387 abstract public function serializeContent( Content
$content, $format = null );
390 * Applies transformations on export (returns the blob unchanged per default).
391 * Subclasses may override this to perform transformations such as conversion
392 * of legacy formats or filtering of internal meta-data.
394 * @param string $blob The blob to be exported
395 * @param string|null $format The blob's serialization format
399 public function exportTransform( $blob, $format = null ) {
404 * Unserializes a Content object of the type supported by this ContentHandler.
408 * @param string $blob Serialized form of the content
409 * @param string|null $format The format used for serialization
411 * @return Content The Content object created by deserializing $blob
413 abstract public function unserializeContent( $blob, $format = null );
416 * Apply import transformation (per default, returns $blob unchanged).
417 * This gives subclasses an opportunity to transform data blobs on import.
421 * @param string $blob
422 * @param string|null $format
426 public function importTransform( $blob, $format = null ) {
431 * Creates an empty Content object of the type supported by this
438 abstract public function makeEmptyContent();
441 * Creates a new Content object that acts as a redirect to the given page,
442 * or null if redirects are not supported by this content model.
444 * This default implementation always returns null. Subclasses supporting redirects
445 * must override this method.
447 * Note that subclasses that override this method to return a Content object
448 * should also override supportsRedirects() to return true.
452 * @param Title $destination The page to redirect to.
453 * @param string $text Text to include in the redirect, if possible.
455 * @return Content Always null.
457 public function makeRedirectContent( Title
$destination, $text = '' ) {
462 * Returns the model id that identifies the content model this
463 * ContentHandler can handle. Use with the CONTENT_MODEL_XXX constants.
467 * @return string The model ID
469 public function getModelID() {
470 return $this->mModelID
;
476 * @param string $model_id The model to check
478 * @throws MWException If the model ID is not the ID of the content model supported by this
481 protected function checkModelID( $model_id ) {
482 if ( $model_id !== $this->mModelID
) {
483 throw new MWException( "Bad content model: " .
484 "expected {$this->mModelID} " .
485 "but got $model_id." );
490 * Returns a list of serialization formats supported by the
491 * serializeContent() and unserializeContent() methods of this
496 * @return string[] List of serialization formats as MIME type like strings
498 public function getSupportedFormats() {
499 return $this->mSupportedFormats
;
503 * The format used for serialization/deserialization by default by this
506 * This default implementation will return the first element of the array
507 * of formats that was passed to the constructor.
511 * @return string The name of the default serialization format as a MIME type
513 public function getDefaultFormat() {
514 return $this->mSupportedFormats
[0];
518 * Returns true if $format is a serialization format supported by this
519 * ContentHandler, and false otherwise.
521 * Note that if $format is null, this method always returns true, because
522 * null means "use the default format".
526 * @param string $format The serialization format to check
530 public function isSupportedFormat( $format ) {
532 return true; // this means "use the default"
535 return in_array( $format, $this->mSupportedFormats
);
539 * Convenient for checking whether a format provided as a parameter is actually supported.
541 * @param string $format The serialization format to check
543 * @throws MWException If the format is not supported by this content handler.
545 protected function checkFormat( $format ) {
546 if ( !$this->isSupportedFormat( $format ) ) {
547 throw new MWException(
548 "Format $format is not supported for content model "
549 . $this->getModelID()
555 * Returns overrides for action handlers.
556 * Classes listed here will be used instead of the default one when
557 * (and only when) $wgActions[$action] === true. This allows subclasses
558 * to override the default action handlers.
562 * @return array An array mapping action names (typically "view", "edit", "history" etc.) to
563 * either the full qualified class name of an Action class, a callable taking ( Page $page,
564 * IContextSource $context = null ) as parameters and returning an Action object, or an actual
565 * Action object. An empty array in this default implementation.
567 * @see Action::factory
569 public function getActionOverrides() {
574 * Factory for creating an appropriate DifferenceEngine for this content model.
575 * Since 1.32, this is only used for page-level diffs; to diff two content objects,
576 * use getSlotDiffRenderer.
578 * The DifferenceEngine subclass to use is selected in getDiffEngineClass(). The
579 * GetDifferenceEngine hook will receive the DifferenceEngine object and can replace or
581 * (Note that in older versions of MediaWiki the hook documentation instructed extensions
582 * to return false from the hook; you should not rely on always being able to decorate
583 * the DifferenceEngine instance from the hook. If the owner of the content type wants to
584 * decorare the instance, overriding this method is a safer approach.)
586 * @todo This is page-level functionality so it should not belong to ContentHandler.
587 * Move it to a better place once one exists (e.g. PageTypeHandler).
591 * @param IContextSource $context Context to use, anything else will be ignored.
592 * @param int $old Revision ID we want to show and diff with.
593 * @param int|string $new Either a revision ID or one of the strings 'cur', 'prev' or 'next'.
594 * @param int $rcid FIXME: Deprecated, no longer used. Defaults to 0.
595 * @param bool $refreshCache If set, refreshes the diff cache. Defaults to false.
596 * @param bool $unhide If set, allow viewing deleted revs. Defaults to false.
598 * @return DifferenceEngine
600 public function createDifferenceEngine( IContextSource
$context, $old = 0, $new = 0,
601 $rcid = 0, // FIXME: Deprecated, no longer used
602 $refreshCache = false, $unhide = false
604 $diffEngineClass = $this->getDiffEngineClass();
605 $differenceEngine = new $diffEngineClass( $context, $old, $new, $rcid, $refreshCache, $unhide );
606 Hooks
::run( 'GetDifferenceEngine', [ $context, $old, $new, $refreshCache, $unhide,
607 &$differenceEngine ] );
608 return $differenceEngine;
612 * Get an appropriate SlotDiffRenderer for this content model.
614 * @param IContextSource $context
615 * @return SlotDiffRenderer
617 final public function getSlotDiffRenderer( IContextSource
$context ) {
618 $slotDiffRenderer = $this->getSlotDiffRendererInternal( $context );
619 if ( get_class( $slotDiffRenderer ) === TextSlotDiffRenderer
::class ) {
620 // To keep B/C, when SlotDiffRenderer is not overridden for a given content type
621 // but DifferenceEngine is, use that instead.
622 $differenceEngine = $this->createDifferenceEngine( $context );
623 if ( get_class( $differenceEngine ) !== DifferenceEngine
::class ) {
624 // TODO turn this into a deprecation warning in a later release
625 LoggerFactory
::getInstance( 'diff' )->info(
626 'Falling back to DifferenceEngineSlotDiffRenderer', [
627 'modelID' => $this->getModelID(),
628 'DifferenceEngine' => get_class( $differenceEngine ),
630 $slotDiffRenderer = new DifferenceEngineSlotDiffRenderer( $differenceEngine );
633 Hooks
::run( 'GetSlotDiffRenderer', [ $this, &$slotDiffRenderer, $context ] );
634 return $slotDiffRenderer;
638 * Return the SlotDiffRenderer appropriate for this content handler.
639 * @param IContextSource $context
640 * @return SlotDiffRenderer
642 protected function getSlotDiffRendererInternal( IContextSource
$context ) {
643 $contentLanguage = MediaWikiServices
::getInstance()->getContentLanguage();
644 $statsdDataFactory = MediaWikiServices
::getInstance()->getStatsdDataFactory();
645 $slotDiffRenderer = new TextSlotDiffRenderer();
646 $slotDiffRenderer->setStatsdDataFactory( $statsdDataFactory );
647 // XXX using the page language would be better, but it's unclear how that should be injected
648 $slotDiffRenderer->setLanguage( $contentLanguage );
649 $slotDiffRenderer->setWikiDiff2MovedParagraphDetectionCutoff(
650 $context->getConfig()->get( 'WikiDiff2MovedParagraphDetectionCutoff' )
653 $engine = DifferenceEngine
::getEngine();
654 if ( $engine === false ) {
655 $slotDiffRenderer->setEngine( TextSlotDiffRenderer
::ENGINE_PHP
);
656 } elseif ( $engine === 'wikidiff2' ) {
657 $slotDiffRenderer->setEngine( TextSlotDiffRenderer
::ENGINE_WIKIDIFF2
);
659 $slotDiffRenderer->setEngine( TextSlotDiffRenderer
::ENGINE_EXTERNAL
, $engine );
662 return $slotDiffRenderer;
666 * Get the language in which the content of the given page is written.
668 * This default implementation just returns the content language (except for pages
669 * in the MediaWiki namespace)
671 * Note that the page's language is not cacheable, since it may in some
672 * cases depend on user settings.
674 * Also note that the page language may or may not depend on the actual content of the page,
675 * that is, this method may load the content in order to determine the language.
679 * @param Title $title The page to determine the language for.
680 * @param Content|null $content The page's content, if you have it handy, to avoid reloading it.
682 * @return Language The page's language
684 public function getPageLanguage( Title
$title, Content
$content = null ) {
686 $pageLang = MediaWikiServices
::getInstance()->getContentLanguage();
688 if ( $title->inNamespace( NS_MEDIAWIKI
) ) {
689 // Parse mediawiki messages with correct target language
690 list( /* $unused */, $lang ) = MessageCache
::singleton()->figureMessage( $title->getText() );
691 $pageLang = Language
::factory( $lang );
694 // Simplify hook handlers by only passing objects of one type, in case nothing
695 // else has unstubbed the StubUserLang object by now.
696 StubObject
::unstub( $wgLang );
698 Hooks
::run( 'PageContentLanguage', [ $title, &$pageLang, $wgLang ] );
700 return wfGetLangObj( $pageLang );
704 * Get the language in which the content of this page is written when
705 * viewed by user. Defaults to $this->getPageLanguage(), but if the user
706 * specified a preferred variant, the variant will be used.
708 * This default implementation just returns $this->getPageLanguage( $title, $content ) unless
709 * the user specified a preferred variant.
711 * Note that the pages view language is not cacheable, since it depends on user settings.
713 * Also note that the page language may or may not depend on the actual content of the page,
714 * that is, this method may load the content in order to determine the language.
718 * @param Title $title The page to determine the language for.
719 * @param Content|null $content The page's content, if you have it handy, to avoid reloading it.
721 * @return Language The page's language for viewing
723 public function getPageViewLanguage( Title
$title, Content
$content = null ) {
724 $pageLang = $this->getPageLanguage( $title, $content );
726 if ( $title->getNamespace() !== NS_MEDIAWIKI
) {
727 // If the user chooses a variant, the content is actually
728 // in a language whose code is the variant code.
729 $variant = $pageLang->getPreferredVariant();
730 if ( $pageLang->getCode() !== $variant ) {
731 $pageLang = Language
::factory( $variant );
739 * Determines whether the content type handled by this ContentHandler
740 * can be used for the main slot of the given page.
742 * This default implementation always returns true.
743 * Subclasses may override this to restrict the use of this content model to specific locations,
744 * typically based on the namespace or some other aspect of the title, such as a special suffix
745 * (e.g. ".svg" for SVG content).
747 * @note this calls the ContentHandlerCanBeUsedOn hook which may be used to override which
748 * content model can be used where.
750 * @see SlotRoleHandler::isAllowedModel
752 * @param Title $title The page's title.
754 * @return bool True if content of this kind can be used on the given page, false otherwise.
756 public function canBeUsedOn( Title
$title ) {
759 Hooks
::run( 'ContentModelCanBeUsedOn', [ $this->getModelID(), $title, &$ok ] );
765 * Returns the name of the diff engine to use.
771 protected function getDiffEngineClass() {
772 return DifferenceEngine
::class;
776 * Attempts to merge differences between three versions. Returns a new
777 * Content object for a clean merge and false for failure or a conflict.
779 * This default implementation always returns false.
783 * @param Content $oldContent The page's previous content.
784 * @param Content $myContent One of the page's conflicting contents.
785 * @param Content $yourContent One of the page's conflicting contents.
787 * @return Content|bool Always false.
789 public function merge3( Content
$oldContent, Content
$myContent, Content
$yourContent ) {
794 * Return type of change if one exists for the given edit.
798 * @param Content|null $oldContent The previous text of the page.
799 * @param Content|null $newContent The submitted text of the page.
800 * @param int $flags Bit mask: a bit mask of flags submitted for the edit.
802 * @return string|null String key representing type of change, or null.
804 private function getChangeType(
805 Content
$oldContent = null,
806 Content
$newContent = null,
809 $oldTarget = $oldContent !== null ?
$oldContent->getRedirectTarget() : null;
810 $newTarget = $newContent !== null ?
$newContent->getRedirectTarget() : null;
812 // We check for the type of change in the given edit, and return string key accordingly
814 // Blanking of a page
815 if ( $oldContent && $oldContent->getSize() > 0 &&
816 $newContent && $newContent->getSize() === 0
824 // New redirect page (by creating new page or by changing content page)
825 return 'new-redirect';
826 } elseif ( !$newTarget->equals( $oldTarget ) ||
827 $oldTarget->getFragment() !== $newTarget->getFragment()
829 // Redirect target changed
830 return 'changed-redirect-target';
832 } elseif ( $oldTarget ) {
833 // Changing an existing redirect into a non-redirect
834 return 'removed-redirect';
838 if ( $flags & EDIT_NEW
&& $newContent ) {
839 if ( $newContent->getSize() === 0 ) {
847 // Removing more than 90% of the page
848 if ( $oldContent && $newContent && $oldContent->getSize() > 10 * $newContent->getSize() ) {
852 // Content model changed
853 if ( $oldContent && $newContent && $oldContent->getModel() !== $newContent->getModel() ) {
854 return 'contentmodelchange';
861 * Return an applicable auto-summary if one exists for the given edit.
865 * @param Content|null $oldContent The previous text of the page.
866 * @param Content|null $newContent The submitted text of the page.
867 * @param int $flags Bit mask: a bit mask of flags submitted for the edit.
869 * @return string An appropriate auto-summary, or an empty string.
871 public function getAutosummary(
872 Content
$oldContent = null,
873 Content
$newContent = null,
876 $changeType = $this->getChangeType( $oldContent, $newContent, $flags );
878 // There's no applicable auto-summary for our case, so our auto-summary is empty.
879 if ( !$changeType ) {
883 // Decide what kind of auto-summary is needed.
884 switch ( $changeType ) {
886 $newTarget = $newContent->getRedirectTarget();
887 $truncatedtext = $newContent->getTextForSummary(
889 - strlen( wfMessage( 'autoredircomment' )->inContentLanguage()->text() )
890 - strlen( $newTarget->getFullText() )
893 return wfMessage( 'autoredircomment', $newTarget->getFullText() )
894 ->plaintextParams( $truncatedtext )->inContentLanguage()->text();
895 case 'changed-redirect-target':
896 $oldTarget = $oldContent->getRedirectTarget();
897 $newTarget = $newContent->getRedirectTarget();
899 $truncatedtext = $newContent->getTextForSummary(
901 - strlen( wfMessage( 'autosumm-changed-redirect-target' )
902 ->inContentLanguage()->text() )
903 - strlen( $oldTarget->getFullText() )
904 - strlen( $newTarget->getFullText() )
907 return wfMessage( 'autosumm-changed-redirect-target',
908 $oldTarget->getFullText(),
909 $newTarget->getFullText() )
910 ->rawParams( $truncatedtext )->inContentLanguage()->text();
911 case 'removed-redirect':
912 $oldTarget = $oldContent->getRedirectTarget();
913 $truncatedtext = $newContent->getTextForSummary(
915 - strlen( wfMessage( 'autosumm-removed-redirect' )
916 ->inContentLanguage()->text() )
917 - strlen( $oldTarget->getFullText() ) );
919 return wfMessage( 'autosumm-removed-redirect', $oldTarget->getFullText() )
920 ->rawParams( $truncatedtext )->inContentLanguage()->text();
922 // If they're making a new article, give its text, truncated, in the summary.
923 $truncatedtext = $newContent->getTextForSummary(
924 200 - strlen( wfMessage( 'autosumm-new' )->inContentLanguage()->text() ) );
926 return wfMessage( 'autosumm-new' )->rawParams( $truncatedtext )
927 ->inContentLanguage()->text();
929 return wfMessage( 'autosumm-blank' )->inContentLanguage()->text();
931 $truncatedtext = $newContent->getTextForSummary(
932 200 - strlen( wfMessage( 'autosumm-replace' )->inContentLanguage()->text() ) );
934 return wfMessage( 'autosumm-replace' )->rawParams( $truncatedtext )
935 ->inContentLanguage()->text();
937 return wfMessage( 'autosumm-newblank' )->inContentLanguage()->text();
944 * Return an applicable tag if one exists for the given edit or return null.
948 * @param Content|null $oldContent The previous text of the page.
949 * @param Content|null $newContent The submitted text of the page.
950 * @param int $flags Bit mask: a bit mask of flags submitted for the edit.
952 * @return string|null An appropriate tag, or null.
954 public function getChangeTag(
955 Content
$oldContent = null,
956 Content
$newContent = null,
959 $changeType = $this->getChangeType( $oldContent, $newContent, $flags );
961 // There's no applicable tag for this change.
962 if ( !$changeType ) {
966 // Core tags use the same keys as ones returned from $this->getChangeType()
967 // but prefixed with pseudo namespace 'mw-', so we add the prefix before checking
968 // if this type of change should be tagged
969 $tag = 'mw-' . $changeType;
971 // Not all change types are tagged, so we check against the list of defined tags.
972 if ( in_array( $tag, ChangeTags
::getSoftwareTags() ) ) {
980 * Auto-generates a deletion reason
984 * @param Title $title The page's title
985 * @param bool &$hasHistory Whether the page has a history
987 * @return mixed String containing deletion reason or empty string, or
988 * boolean false if no revision occurred
990 * @todo &$hasHistory is extremely ugly, it's here because
991 * WikiPage::getAutoDeleteReason() and Article::generateReason()
994 public function getAutoDeleteReason( Title
$title, &$hasHistory ) {
995 $dbr = wfGetDB( DB_REPLICA
);
997 // Get the last revision
998 $rev = Revision
::newFromTitle( $title );
1000 if ( is_null( $rev ) ) {
1004 // Get the article's contents
1005 $content = $rev->getContent();
1008 // If the page is blank, use the text from the previous revision,
1009 // which can only be blank if there's a move/import/protect dummy
1010 // revision involved
1011 if ( !$content ||
$content->isEmpty() ) {
1012 $prev = $rev->getPrevious();
1016 $content = $rev->getContent();
1021 $this->checkModelID( $rev->getContentModel() );
1023 // Find out if there was only one contributor
1024 // Only scan the last 20 revisions
1025 $revQuery = Revision
::getQueryInfo();
1026 $res = $dbr->select(
1027 $revQuery['tables'],
1028 [ 'rev_user_text' => $revQuery['fields']['rev_user_text'] ],
1030 'rev_page' => $title->getArticleID(),
1031 $dbr->bitAnd( 'rev_deleted', Revision
::DELETED_USER
) . ' = 0'
1038 if ( $res === false ) {
1039 // This page has no revisions, which is very weird
1043 $hasHistory = ( $res->numRows() > 1 );
1044 $row = $dbr->fetchObject( $res );
1046 if ( $row ) { // $row is false if the only contributor is hidden
1047 $onlyAuthor = $row->rev_user_text
;
1048 // Try to find a second contributor
1049 foreach ( $res as $row ) {
1050 if ( $row->rev_user_text
!= $onlyAuthor ) { // T24999
1051 $onlyAuthor = false;
1056 $onlyAuthor = false;
1059 // Generate the summary with a '$1' placeholder
1061 // The current revision is blank and the one before is also
1062 // blank. It's just not our lucky day
1063 $reason = wfMessage( 'exbeforeblank', '$1' )->inContentLanguage()->text();
1065 if ( $onlyAuthor ) {
1066 $reason = wfMessage(
1070 )->inContentLanguage()->text();
1072 $reason = wfMessage( 'excontent', '$1' )->inContentLanguage()->text();
1076 if ( $reason == '-' ) {
1077 // Allow these UI messages to be blanked out cleanly
1081 // Max content length = max comment length - length of the comment (excl. $1)
1082 $text = $content ?
$content->getTextForSummary( 255 - ( strlen( $reason ) - 2 ) ) : '';
1084 // Now replace the '$1' placeholder
1085 $reason = str_replace( '$1', $text, $reason );
1091 * Get the Content object that needs to be saved in order to undo all revisions
1092 * between $undo and $undoafter. Revisions must belong to the same page,
1093 * must exist and must not be deleted.
1096 * @since 1.32 accepts Content objects for all parameters instead of Revision objects.
1097 * Passing Revision objects is deprecated.
1099 * @param Revision|Content $current The current text
1100 * @param Revision|Content $undo The content of the revision to undo
1101 * @param Revision|Content $undoafter Must be from an earlier revision than $undo
1102 * @param bool $undoIsLatest Set true if $undo is from the current revision (since 1.32)
1104 * @return mixed Content on success, false on failure
1106 public function getUndoContent( $current, $undo, $undoafter, $undoIsLatest = false ) {
1107 Assert
::parameterType( Revision
::class . '|' . Content
::class, $current, '$current' );
1108 if ( $current instanceof Content
) {
1109 Assert
::parameter( $undo instanceof Content
, '$undo',
1110 'Must be Content when $current is Content' );
1111 Assert
::parameter( $undoafter instanceof Content
, '$undoafter',
1112 'Must be Content when $current is Content' );
1113 $cur_content = $current;
1114 $undo_content = $undo;
1115 $undoafter_content = $undoafter;
1117 Assert
::parameter( $undo instanceof Revision
, '$undo',
1118 'Must be Revision when $current is Revision' );
1119 Assert
::parameter( $undoafter instanceof Revision
, '$undoafter',
1120 'Must be Revision when $current is Revision' );
1122 $cur_content = $current->getContent();
1124 if ( empty( $cur_content ) ) {
1125 return false; // no page
1128 $undo_content = $undo->getContent();
1129 $undoafter_content = $undoafter->getContent();
1131 if ( !$undo_content ||
!$undoafter_content ) {
1132 return false; // no content to undo
1135 $undoIsLatest = $current->getId() === $undo->getId();
1139 $this->checkModelID( $cur_content->getModel() );
1140 $this->checkModelID( $undo_content->getModel() );
1141 if ( !$undoIsLatest ) {
1142 // If we are undoing the most recent revision,
1143 // its ok to revert content model changes. However
1144 // if we are undoing a revision in the middle, then
1145 // doing that will be confusing.
1146 $this->checkModelID( $undoafter_content->getModel() );
1148 } catch ( MWException
$e ) {
1149 // If the revisions have different content models
1150 // just return false
1154 if ( $cur_content->equals( $undo_content ) ) {
1155 // No use doing a merge if it's just a straight revert.
1156 return $undoafter_content;
1159 $undone_content = $this->merge3( $undo_content, $undoafter_content, $cur_content );
1161 return $undone_content;
1165 * Get parser options suitable for rendering and caching the article
1167 * @deprecated since 1.32, use WikiPage::makeParserOptions() or
1168 * ParserOptions::newCanonical() instead.
1169 * @param IContextSource|User|string $context One of the following:
1170 * - IContextSource: Use the User and the Language of the provided
1172 * - User: Use the provided User object and $wgLang for the language,
1173 * so use an IContextSource object if possible.
1174 * - 'canonical': Canonical options (anonymous user with default
1175 * preferences and content language).
1177 * @throws MWException
1178 * @return ParserOptions
1180 public function makeParserOptions( $context ) {
1181 wfDeprecated( __METHOD__
, '1.32' );
1182 return ParserOptions
::newCanonical( $context );
1186 * Returns true for content models that support caching using the
1187 * ParserCache mechanism. See WikiPage::shouldCheckParserCache().
1191 * @return bool Always false.
1193 public function isParserCacheSupported() {
1198 * Returns true if this content model supports sections.
1199 * This default implementation returns false.
1201 * Content models that return true here should also implement
1202 * Content::getSection, Content::replaceSection, etc. to handle sections..
1204 * @return bool Always false.
1206 public function supportsSections() {
1211 * Returns true if this content model supports categories.
1212 * The default implementation returns true.
1214 * @return bool Always true.
1216 public function supportsCategories() {
1221 * Returns true if this content model supports redirects.
1222 * This default implementation returns false.
1224 * Content models that return true here should also implement
1225 * ContentHandler::makeRedirectContent to return a Content object.
1227 * @return bool Always false.
1229 public function supportsRedirects() {
1234 * Return true if this content model supports direct editing, such as via EditPage.
1236 * @return bool Default is false, and true for TextContent and it's derivatives.
1238 public function supportsDirectEditing() {
1243 * Whether or not this content model supports direct editing via ApiEditPage
1245 * @return bool Default is false, and true for TextContent and derivatives.
1247 public function supportsDirectApiEditing() {
1248 return $this->supportsDirectEditing();
1252 * Get fields definition for search index
1254 * @todo Expose title, redirect, namespace, text, source_text, text_bytes
1255 * field mappings here. (see T142670 and T143409)
1257 * @param SearchEngine $engine
1258 * @return SearchIndexField[] List of fields this content handler can provide.
1261 public function getFieldsForSearchIndex( SearchEngine
$engine ) {
1262 $fields['category'] = $engine->makeSearchFieldMapping(
1264 SearchIndexField
::INDEX_TYPE_TEXT
1266 $fields['category']->setFlag( SearchIndexField
::FLAG_CASEFOLD
);
1268 $fields['external_link'] = $engine->makeSearchFieldMapping(
1270 SearchIndexField
::INDEX_TYPE_KEYWORD
1273 $fields['outgoing_link'] = $engine->makeSearchFieldMapping(
1275 SearchIndexField
::INDEX_TYPE_KEYWORD
1278 $fields['template'] = $engine->makeSearchFieldMapping(
1280 SearchIndexField
::INDEX_TYPE_KEYWORD
1282 $fields['template']->setFlag( SearchIndexField
::FLAG_CASEFOLD
);
1284 $fields['content_model'] = $engine->makeSearchFieldMapping(
1286 SearchIndexField
::INDEX_TYPE_KEYWORD
1293 * Add new field definition to array.
1294 * @param SearchIndexField[] &$fields
1295 * @param SearchEngine $engine
1296 * @param string $name
1298 * @return SearchIndexField[] new field defs
1301 protected function addSearchField( &$fields, SearchEngine
$engine, $name, $type ) {
1302 $fields[$name] = $engine->makeSearchFieldMapping( $name, $type );
1307 * Return fields to be indexed by search engine
1308 * as representation of this document.
1309 * Overriding class should call parent function or take care of calling
1310 * the SearchDataForIndex hook.
1311 * @param WikiPage $page Page to index
1312 * @param ParserOutput $output
1313 * @param SearchEngine $engine Search engine for which we are indexing
1314 * @return array Map of name=>value for fields
1317 public function getDataForSearchIndex(
1319 ParserOutput
$output,
1320 SearchEngine
$engine
1323 $content = $page->getContent();
1326 $searchDataExtractor = new ParserOutputSearchDataExtractor();
1328 $fieldData['category'] = $searchDataExtractor->getCategories( $output );
1329 $fieldData['external_link'] = $searchDataExtractor->getExternalLinks( $output );
1330 $fieldData['outgoing_link'] = $searchDataExtractor->getOutgoingLinks( $output );
1331 $fieldData['template'] = $searchDataExtractor->getTemplates( $output );
1333 $text = $content->getTextForSearchIndex();
1335 $fieldData['text'] = $text;
1336 $fieldData['source_text'] = $text;
1337 $fieldData['text_bytes'] = $content->getSize();
1338 $fieldData['content_model'] = $content->getModel();
1341 Hooks
::run( 'SearchDataForIndex', [ &$fieldData, $this, $page, $output, $engine ] );
1346 * Produce page output suitable for indexing.
1348 * Specific content handlers may override it if they need different content handling.
1350 * @param WikiPage $page
1351 * @param ParserCache|null $cache
1352 * @return ParserOutput
1354 public function getParserOutputForIndexing( WikiPage
$page, ParserCache
$cache = null ) {
1355 // TODO: MCR: ContentHandler should be called per slot, not for the whole page.
1357 $parserOptions = $page->makeParserOptions( 'canonical' );
1359 $parserOutput = $cache->get( $page, $parserOptions );
1362 if ( empty( $parserOutput ) ) {
1363 $renderer = MediaWikiServices
::getInstance()->getRevisionRenderer();
1365 $renderer->getRenderedRevision(
1366 $page->getRevision()->getRevisionRecord(),
1368 )->getRevisionParserOutput();
1370 $cache->save( $parserOutput, $page, $parserOptions );
1373 return $parserOutput;
1377 * Returns a list of DeferrableUpdate objects for recording information about the
1378 * given Content in some secondary data store.
1380 * Application logic should not call this method directly. Instead, it should call
1381 * DerivedPageDataUpdater::getSecondaryDataUpdates().
1383 * @note Implementations must not return a LinksUpdate instance. Instead, a LinksUpdate
1384 * is created by the calling code in DerivedPageDataUpdater, on the combined ParserOutput
1385 * of all slots, not for each slot individually. This is in contrast to the old
1386 * getSecondaryDataUpdates method defined by AbstractContent, which returned a LinksUpdate.
1388 * @note Implementations should not call $content->getParserOutput, they should call
1389 * $slotOutput->getSlotRendering( $role, false ) instead if they need to access a ParserOutput
1390 * of $content. This allows existing ParserOutput objects to be re-used, while avoiding
1391 * creating a ParserOutput when none is needed.
1393 * @param Title $title The title of the page to supply the updates for
1394 * @param Content $content The content to generate data updates for.
1395 * @param string $role The role (slot) in which the content is being used. Which updates
1396 * are performed should generally not depend on the role the content has, but the
1397 * DeferrableUpdates themselves may need to know the role, to track to which slot the
1398 * data refers, and to avoid overwriting data of the same kind from another slot.
1399 * @param SlotRenderingProvider $slotOutput A provider that can be used to gain access to
1400 * a ParserOutput of $content by calling $slotOutput->getSlotParserOutput( $role, false ).
1401 * @return DeferrableUpdate[] A list of DeferrableUpdate objects for putting information
1402 * about this content object somewhere. The default implementation returns an empty
1406 public function getSecondaryDataUpdates(
1410 SlotRenderingProvider
$slotOutput
1416 * Returns a list of DeferrableUpdate objects for removing information about content
1417 * in some secondary data store. This is used when a page is deleted, and also when
1418 * a slot is removed from a page.
1420 * Application logic should not call this method directly. Instead, it should call
1421 * WikiPage::getSecondaryDataUpdates().
1423 * @note Implementations must not return a LinksDeletionUpdate instance. Instead, a
1424 * LinksDeletionUpdate is created by the calling code in WikiPage.
1425 * This is in contrast to the old getDeletionUpdates method defined by AbstractContent,
1426 * which returned a LinksUpdate.
1428 * @note Implementations should not rely on the page's current content, but rather the current
1429 * state of the secondary data store.
1431 * @param Title $title The title of the page to supply the updates for
1432 * @param string $role The role (slot) in which the content is being used. Which updates
1433 * are performed should generally not depend on the role the content has, but the
1434 * DeferrableUpdates themselves may need to know the role, to track to which slot the
1435 * data refers, and to avoid overwriting data of the same kind from another slot.
1437 * @return DeferrableUpdate[] A list of DeferrableUpdate objects for putting information
1438 * about this content object somewhere. The default implementation returns an empty
1443 public function getDeletionUpdates( Title
$title, $role ) {