User::isSafeToLoad() should return false if MW_NO_SESSION
[mediawiki.git] / includes / content / ContentHandler.php
blob6bc6abfda7b9eb13ebd457e7fb6c579b510df298
1 <?php
2 /**
3 * Base class for content handling.
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
20 * @since 1.21
22 * @file
23 * @ingroup Content
25 * @author Daniel Kinzler
28 /**
29 * Exception representing a failure to serialize or unserialize a content object.
31 * @ingroup Content
33 class MWContentSerializationException extends MWException {
36 /**
37 * Exception thrown when an unregistered content model is requested. This error
38 * can be triggered by user input, so a separate exception class is provided so
39 * callers can substitute a context-specific, internationalised error message.
41 * @ingroup Content
42 * @since 1.27
44 class MWUnknownContentModelException extends MWException {
45 /** @var string The name of the unknown content model */
46 private $modelId;
48 /** @param string $modelId */
49 function __construct( $modelId ) {
50 parent::__construct( "The content model '$modelId' is not registered on this wiki.\n" .
51 'See https://www.mediawiki.org/wiki/Content_handlers to find out which extensions ' .
52 'handle this content model.' );
53 $this->modelId = $modelId;
56 /** @return string */
57 public function getModelId() {
58 return $modelId;
62 /**
63 * A content handler knows how do deal with a specific type of content on a wiki
64 * page. Content is stored in the database in a serialized form (using a
65 * serialization format a.k.a. MIME type) and is unserialized into its native
66 * PHP representation (the content model), which is wrapped in an instance of
67 * the appropriate subclass of Content.
69 * ContentHandler instances are stateless singletons that serve, among other
70 * things, as a factory for Content objects. Generally, there is one subclass
71 * of ContentHandler and one subclass of Content for every type of content model.
73 * Some content types have a flat model, that is, their native representation
74 * is the same as their serialized form. Examples would be JavaScript and CSS
75 * code. As of now, this also applies to wikitext (MediaWiki's default content
76 * type), but wikitext content may be represented by a DOM or AST structure in
77 * the future.
79 * @ingroup Content
81 abstract class ContentHandler {
82 /**
83 * Switch for enabling deprecation warnings. Used by ContentHandler::deprecated()
84 * and ContentHandler::runLegacyHooks().
86 * Once the ContentHandler code has settled in a bit, this should be set to true to
87 * make extensions etc. show warnings when using deprecated functions and hooks.
89 protected static $enableDeprecationWarnings = false;
91 /**
92 * Convenience function for getting flat text from a Content object. This
93 * should only be used in the context of backwards compatibility with code
94 * that is not yet able to handle Content objects!
96 * If $content is null, this method returns the empty string.
98 * If $content is an instance of TextContent, this method returns the flat
99 * text as returned by $content->getNativeData().
101 * If $content is not a TextContent object, the behavior of this method
102 * depends on the global $wgContentHandlerTextFallback:
103 * - If $wgContentHandlerTextFallback is 'fail' and $content is not a
104 * TextContent object, an MWException is thrown.
105 * - If $wgContentHandlerTextFallback is 'serialize' and $content is not a
106 * TextContent object, $content->serialize() is called to get a string
107 * form of the content.
108 * - If $wgContentHandlerTextFallback is 'ignore' and $content is not a
109 * TextContent object, this method returns null.
110 * - otherwise, the behavior is undefined.
112 * @since 1.21
114 * @param Content $content
116 * @throws MWException If the content is not an instance of TextContent and
117 * wgContentHandlerTextFallback was set to 'fail'.
118 * @return string|null Textual form of the content, if available.
120 public static function getContentText( Content $content = null ) {
121 global $wgContentHandlerTextFallback;
123 if ( is_null( $content ) ) {
124 return '';
127 if ( $content instanceof TextContent ) {
128 return $content->getNativeData();
131 wfDebugLog( 'ContentHandler', 'Accessing ' . $content->getModel() . ' content as text!' );
133 if ( $wgContentHandlerTextFallback == 'fail' ) {
134 throw new MWException(
135 "Attempt to get text from Content with model " .
136 $content->getModel()
140 if ( $wgContentHandlerTextFallback == 'serialize' ) {
141 return $content->serialize();
144 return null;
148 * Convenience function for creating a Content object from a given textual
149 * representation.
151 * $text will be deserialized into a Content object of the model specified
152 * by $modelId (or, if that is not given, $title->getContentModel()) using
153 * the given format.
155 * @since 1.21
157 * @param string $text The textual representation, will be
158 * unserialized to create the Content object
159 * @param Title $title The title of the page this text belongs to.
160 * Required if $modelId is not provided.
161 * @param string $modelId The model to deserialize to. If not provided,
162 * $title->getContentModel() is used.
163 * @param string $format The format to use for deserialization. If not
164 * given, the model's default format is used.
166 * @throws MWException If model ID or format is not supported or if the text can not be
167 * unserialized using the format.
168 * @return Content A Content object representing the text.
170 public static function makeContent( $text, Title $title = null,
171 $modelId = null, $format = null ) {
172 if ( is_null( $modelId ) ) {
173 if ( is_null( $title ) ) {
174 throw new MWException( "Must provide a Title object or a content model ID." );
177 $modelId = $title->getContentModel();
180 $handler = ContentHandler::getForModelID( $modelId );
182 return $handler->unserializeContent( $text, $format );
186 * Returns the name of the default content model to be used for the page
187 * with the given title.
189 * Note: There should rarely be need to call this method directly.
190 * To determine the actual content model for a given page, use
191 * Title::getContentModel().
193 * Which model is to be used by default for the page is determined based
194 * on several factors:
195 * - The global setting $wgNamespaceContentModels specifies a content model
196 * per namespace.
197 * - The hook ContentHandlerDefaultModelFor may be used to override the page's default
198 * model.
199 * - Pages in NS_MEDIAWIKI and NS_USER default to the CSS or JavaScript
200 * model if they end in .js or .css, respectively.
201 * - Pages in NS_MEDIAWIKI default to the wikitext model otherwise.
202 * - The hook TitleIsCssOrJsPage may be used to force a page to use the CSS
203 * or JavaScript model. This is a compatibility feature. The ContentHandlerDefaultModelFor
204 * hook should be used instead if possible.
205 * - The hook TitleIsWikitextPage may be used to force a page to use the
206 * wikitext model. This is a compatibility feature. The ContentHandlerDefaultModelFor
207 * hook should be used instead if possible.
209 * If none of the above applies, the wikitext model is used.
211 * Note: this is used by, and may thus not use, Title::getContentModel()
213 * @since 1.21
215 * @param Title $title
217 * @return string Default model name for the page given by $title
219 public static function getDefaultModelFor( Title $title ) {
220 // NOTE: this method must not rely on $title->getContentModel() directly or indirectly,
221 // because it is used to initialize the mContentModel member.
223 $ns = $title->getNamespace();
225 $ext = false;
226 $m = null;
227 $model = MWNamespace::getNamespaceContentModel( $ns );
229 // Hook can determine default model
230 if ( !Hooks::run( 'ContentHandlerDefaultModelFor', [ $title, &$model ] ) ) {
231 if ( !is_null( $model ) ) {
232 return $model;
236 // Could this page contain code based on the title?
237 $isCodePage = NS_MEDIAWIKI == $ns && preg_match( '!\.(css|js|json)$!u', $title->getText(), $m );
238 if ( $isCodePage ) {
239 $ext = $m[1];
242 // Hook can force JS/CSS
243 Hooks::run( 'TitleIsCssOrJsPage', [ $title, &$isCodePage ], '1.25' );
245 // Is this a user subpage containing code?
246 $isCodeSubpage = NS_USER == $ns
247 && !$isCodePage
248 && preg_match( "/\\/.*\\.(js|css|json)$/", $title->getText(), $m );
249 if ( $isCodeSubpage ) {
250 $ext = $m[1];
253 // Is this wikitext, according to $wgNamespaceContentModels or the DefaultModelFor hook?
254 $isWikitext = is_null( $model ) || $model == CONTENT_MODEL_WIKITEXT;
255 $isWikitext = $isWikitext && !$isCodePage && !$isCodeSubpage;
257 // Hook can override $isWikitext
258 Hooks::run( 'TitleIsWikitextPage', [ $title, &$isWikitext ], '1.25' );
260 if ( !$isWikitext ) {
261 switch ( $ext ) {
262 case 'js':
263 return CONTENT_MODEL_JAVASCRIPT;
264 case 'css':
265 return CONTENT_MODEL_CSS;
266 case 'json':
267 return CONTENT_MODEL_JSON;
268 default:
269 return is_null( $model ) ? CONTENT_MODEL_TEXT : $model;
273 // We established that it must be wikitext
275 return CONTENT_MODEL_WIKITEXT;
279 * Returns the appropriate ContentHandler singleton for the given title.
281 * @since 1.21
283 * @param Title $title
285 * @return ContentHandler
287 public static function getForTitle( Title $title ) {
288 $modelId = $title->getContentModel();
290 return ContentHandler::getForModelID( $modelId );
294 * Returns the appropriate ContentHandler singleton for the given Content
295 * object.
297 * @since 1.21
299 * @param Content $content
301 * @return ContentHandler
303 public static function getForContent( Content $content ) {
304 $modelId = $content->getModel();
306 return ContentHandler::getForModelID( $modelId );
310 * @var array A Cache of ContentHandler instances by model id
312 protected static $handlers;
315 * Returns the ContentHandler singleton for the given model ID. Use the
316 * CONTENT_MODEL_XXX constants to identify the desired content model.
318 * ContentHandler singletons are taken from the global $wgContentHandlers
319 * array. Keys in that array are model names, the values are either
320 * ContentHandler singleton objects, or strings specifying the appropriate
321 * subclass of ContentHandler.
323 * If a class name is encountered when looking up the singleton for a given
324 * model name, the class is instantiated and the class name is replaced by
325 * the resulting singleton in $wgContentHandlers.
327 * If no ContentHandler is defined for the desired $modelId, the
328 * ContentHandler may be provided by the ContentHandlerForModelID hook.
329 * If no ContentHandler can be determined, an MWException is raised.
331 * @since 1.21
333 * @param string $modelId The ID of the content model for which to get a
334 * handler. Use CONTENT_MODEL_XXX constants.
336 * @throws MWException For internal errors and problems in the configuration.
337 * @throws MWUnknownContentModelException If no handler is known for the model ID.
338 * @return ContentHandler The ContentHandler singleton for handling the model given by the ID.
340 public static function getForModelID( $modelId ) {
341 global $wgContentHandlers;
343 if ( isset( ContentHandler::$handlers[$modelId] ) ) {
344 return ContentHandler::$handlers[$modelId];
347 if ( empty( $wgContentHandlers[$modelId] ) ) {
348 $handler = null;
350 Hooks::run( 'ContentHandlerForModelID', [ $modelId, &$handler ] );
352 if ( $handler === null ) {
353 throw new MWUnknownContentModelException( $modelId );
356 if ( !( $handler instanceof ContentHandler ) ) {
357 throw new MWException( "ContentHandlerForModelID must supply a ContentHandler instance" );
359 } else {
360 $classOrCallback = $wgContentHandlers[$modelId];
362 if ( is_callable( $classOrCallback ) ) {
363 $handler = call_user_func( $classOrCallback, $modelId );
364 } else {
365 $handler = new $classOrCallback( $modelId );
368 if ( !( $handler instanceof ContentHandler ) ) {
369 throw new MWException( "$classOrCallback from \$wgContentHandlers is not " .
370 "compatible with ContentHandler" );
374 wfDebugLog( 'ContentHandler', 'Created handler for ' . $modelId
375 . ': ' . get_class( $handler ) );
377 ContentHandler::$handlers[$modelId] = $handler;
379 return ContentHandler::$handlers[$modelId];
383 * Returns the localized name for a given content model.
385 * Model names are localized using system messages. Message keys
386 * have the form content-model-$name, where $name is getContentModelName( $id ).
388 * @param string $name The content model ID, as given by a CONTENT_MODEL_XXX
389 * constant or returned by Revision::getContentModel().
390 * @param Language|null $lang The language to parse the message in (since 1.26)
392 * @throws MWException If the model ID isn't known.
393 * @return string The content model's localized name.
395 public static function getLocalizedName( $name, Language $lang = null ) {
396 // Messages: content-model-wikitext, content-model-text,
397 // content-model-javascript, content-model-css
398 $key = "content-model-$name";
400 $msg = wfMessage( $key );
401 if ( $lang ) {
402 $msg->inLanguage( $lang );
405 return $msg->exists() ? $msg->plain() : $name;
408 public static function getContentModels() {
409 global $wgContentHandlers;
411 return array_keys( $wgContentHandlers );
414 public static function getAllContentFormats() {
415 global $wgContentHandlers;
417 $formats = [];
419 foreach ( $wgContentHandlers as $model => $class ) {
420 $handler = ContentHandler::getForModelID( $model );
421 $formats = array_merge( $formats, $handler->getSupportedFormats() );
424 $formats = array_unique( $formats );
426 return $formats;
429 // ------------------------------------------------------------------------
432 * @var string
434 protected $mModelID;
437 * @var string[]
439 protected $mSupportedFormats;
442 * Constructor, initializing the ContentHandler instance with its model ID
443 * and a list of supported formats. Values for the parameters are typically
444 * provided as literals by subclass's constructors.
446 * @param string $modelId (use CONTENT_MODEL_XXX constants).
447 * @param string[] $formats List for supported serialization formats
448 * (typically as MIME types)
450 public function __construct( $modelId, $formats ) {
451 $this->mModelID = $modelId;
452 $this->mSupportedFormats = $formats;
454 $this->mModelName = preg_replace( '/(Content)?Handler$/', '', get_class( $this ) );
455 $this->mModelName = preg_replace( '/[_\\\\]/', '', $this->mModelName );
456 $this->mModelName = strtolower( $this->mModelName );
460 * Serializes a Content object of the type supported by this ContentHandler.
462 * @since 1.21
464 * @param Content $content The Content object to serialize
465 * @param string $format The desired serialization format
467 * @return string Serialized form of the content
469 abstract public function serializeContent( Content $content, $format = null );
472 * Applies transformations on export (returns the blob unchanged per default).
473 * Subclasses may override this to perform transformations such as conversion
474 * of legacy formats or filtering of internal meta-data.
476 * @param string $blob The blob to be exported
477 * @param string|null $format The blob's serialization format
479 * @return string
481 public function exportTransform( $blob, $format = null ) {
482 return $blob;
486 * Unserializes a Content object of the type supported by this ContentHandler.
488 * @since 1.21
490 * @param string $blob Serialized form of the content
491 * @param string $format The format used for serialization
493 * @return Content The Content object created by deserializing $blob
495 abstract public function unserializeContent( $blob, $format = null );
498 * Apply import transformation (per default, returns $blob unchanged).
499 * This gives subclasses an opportunity to transform data blobs on import.
501 * @since 1.24
503 * @param string $blob
504 * @param string|null $format
506 * @return string
508 public function importTransform( $blob, $format = null ) {
509 return $blob;
513 * Creates an empty Content object of the type supported by this
514 * ContentHandler.
516 * @since 1.21
518 * @return Content
520 abstract public function makeEmptyContent();
523 * Creates a new Content object that acts as a redirect to the given page,
524 * or null if redirects are not supported by this content model.
526 * This default implementation always returns null. Subclasses supporting redirects
527 * must override this method.
529 * Note that subclasses that override this method to return a Content object
530 * should also override supportsRedirects() to return true.
532 * @since 1.21
534 * @param Title $destination The page to redirect to.
535 * @param string $text Text to include in the redirect, if possible.
537 * @return Content Always null.
539 public function makeRedirectContent( Title $destination, $text = '' ) {
540 return null;
544 * Returns the model id that identifies the content model this
545 * ContentHandler can handle. Use with the CONTENT_MODEL_XXX constants.
547 * @since 1.21
549 * @return string The model ID
551 public function getModelID() {
552 return $this->mModelID;
556 * @since 1.21
558 * @param string $model_id The model to check
560 * @throws MWException If the model ID is not the ID of the content model supported by this
561 * ContentHandler.
563 protected function checkModelID( $model_id ) {
564 if ( $model_id !== $this->mModelID ) {
565 throw new MWException( "Bad content model: " .
566 "expected {$this->mModelID} " .
567 "but got $model_id." );
572 * Returns a list of serialization formats supported by the
573 * serializeContent() and unserializeContent() methods of this
574 * ContentHandler.
576 * @since 1.21
578 * @return string[] List of serialization formats as MIME type like strings
580 public function getSupportedFormats() {
581 return $this->mSupportedFormats;
585 * The format used for serialization/deserialization by default by this
586 * ContentHandler.
588 * This default implementation will return the first element of the array
589 * of formats that was passed to the constructor.
591 * @since 1.21
593 * @return string The name of the default serialization format as a MIME type
595 public function getDefaultFormat() {
596 return $this->mSupportedFormats[0];
600 * Returns true if $format is a serialization format supported by this
601 * ContentHandler, and false otherwise.
603 * Note that if $format is null, this method always returns true, because
604 * null means "use the default format".
606 * @since 1.21
608 * @param string $format The serialization format to check
610 * @return bool
612 public function isSupportedFormat( $format ) {
613 if ( !$format ) {
614 return true; // this means "use the default"
617 return in_array( $format, $this->mSupportedFormats );
621 * Convenient for checking whether a format provided as a parameter is actually supported.
623 * @param string $format The serialization format to check
625 * @throws MWException If the format is not supported by this content handler.
627 protected function checkFormat( $format ) {
628 if ( !$this->isSupportedFormat( $format ) ) {
629 throw new MWException(
630 "Format $format is not supported for content model "
631 . $this->getModelID()
637 * Returns overrides for action handlers.
638 * Classes listed here will be used instead of the default one when
639 * (and only when) $wgActions[$action] === true. This allows subclasses
640 * to override the default action handlers.
642 * @since 1.21
644 * @return array Always an empty array.
646 public function getActionOverrides() {
647 return [];
651 * Factory for creating an appropriate DifferenceEngine for this content model.
653 * @since 1.21
655 * @param IContextSource $context Context to use, anything else will be ignored.
656 * @param int $old Revision ID we want to show and diff with.
657 * @param int|string $new Either a revision ID or one of the strings 'cur', 'prev' or 'next'.
658 * @param int $rcid FIXME: Deprecated, no longer used. Defaults to 0.
659 * @param bool $refreshCache If set, refreshes the diff cache. Defaults to false.
660 * @param bool $unhide If set, allow viewing deleted revs. Defaults to false.
662 * @return DifferenceEngine
664 public function createDifferenceEngine( IContextSource $context, $old = 0, $new = 0,
665 $rcid = 0, // FIXME: Deprecated, no longer used
666 $refreshCache = false, $unhide = false ) {
668 // hook: get difference engine
669 $differenceEngine = null;
670 if ( !Hooks::run( 'GetDifferenceEngine',
671 [ $context, $old, $new, $refreshCache, $unhide, &$differenceEngine ]
672 ) ) {
673 return $differenceEngine;
675 $diffEngineClass = $this->getDiffEngineClass();
676 return new $diffEngineClass( $context, $old, $new, $rcid, $refreshCache, $unhide );
680 * Get the language in which the content of the given page is written.
682 * This default implementation just returns $wgContLang (except for pages
683 * in the MediaWiki namespace)
685 * Note that the pages language is not cacheable, since it may in some
686 * cases depend on user settings.
688 * Also note that the page language may or may not depend on the actual content of the page,
689 * that is, this method may load the content in order to determine the language.
691 * @since 1.21
693 * @param Title $title The page to determine the language for.
694 * @param Content $content The page's content, if you have it handy, to avoid reloading it.
696 * @return Language The page's language
698 public function getPageLanguage( Title $title, Content $content = null ) {
699 global $wgContLang, $wgLang;
700 $pageLang = $wgContLang;
702 if ( $title->getNamespace() == NS_MEDIAWIKI ) {
703 // Parse mediawiki messages with correct target language
704 list( /* $unused */, $lang ) = MessageCache::singleton()->figureMessage( $title->getText() );
705 $pageLang = wfGetLangObj( $lang );
708 Hooks::run( 'PageContentLanguage', [ $title, &$pageLang, $wgLang ] );
710 return wfGetLangObj( $pageLang );
714 * Get the language in which the content of this page is written when
715 * viewed by user. Defaults to $this->getPageLanguage(), but if the user
716 * specified a preferred variant, the variant will be used.
718 * This default implementation just returns $this->getPageLanguage( $title, $content ) unless
719 * the user specified a preferred variant.
721 * Note that the pages view language is not cacheable, since it depends on user settings.
723 * Also note that the page language may or may not depend on the actual content of the page,
724 * that is, this method may load the content in order to determine the language.
726 * @since 1.21
728 * @param Title $title The page to determine the language for.
729 * @param Content $content The page's content, if you have it handy, to avoid reloading it.
731 * @return Language The page's language for viewing
733 public function getPageViewLanguage( Title $title, Content $content = null ) {
734 $pageLang = $this->getPageLanguage( $title, $content );
736 if ( $title->getNamespace() !== NS_MEDIAWIKI ) {
737 // If the user chooses a variant, the content is actually
738 // in a language whose code is the variant code.
739 $variant = $pageLang->getPreferredVariant();
740 if ( $pageLang->getCode() !== $variant ) {
741 $pageLang = Language::factory( $variant );
745 return $pageLang;
749 * Determines whether the content type handled by this ContentHandler
750 * can be used on the given page.
752 * This default implementation always returns true.
753 * Subclasses may override this to restrict the use of this content model to specific locations,
754 * typically based on the namespace or some other aspect of the title, such as a special suffix
755 * (e.g. ".svg" for SVG content).
757 * @note this calls the ContentHandlerCanBeUsedOn hook which may be used to override which
758 * content model can be used where.
760 * @param Title $title The page's title.
762 * @return bool True if content of this kind can be used on the given page, false otherwise.
764 public function canBeUsedOn( Title $title ) {
765 $ok = true;
767 Hooks::run( 'ContentModelCanBeUsedOn', [ $this->getModelID(), $title, &$ok ] );
769 return $ok;
773 * Returns the name of the diff engine to use.
775 * @since 1.21
777 * @return string
779 protected function getDiffEngineClass() {
780 return 'DifferenceEngine';
784 * Attempts to merge differences between three versions. Returns a new
785 * Content object for a clean merge and false for failure or a conflict.
787 * This default implementation always returns false.
789 * @since 1.21
791 * @param Content $oldContent The page's previous content.
792 * @param Content $myContent One of the page's conflicting contents.
793 * @param Content $yourContent One of the page's conflicting contents.
795 * @return Content|bool Always false.
797 public function merge3( Content $oldContent, Content $myContent, Content $yourContent ) {
798 return false;
802 * Return an applicable auto-summary if one exists for the given edit.
804 * @since 1.21
806 * @param Content $oldContent The previous text of the page.
807 * @param Content $newContent The submitted text of the page.
808 * @param int $flags Bit mask: a bit mask of flags submitted for the edit.
810 * @return string An appropriate auto-summary, or an empty string.
812 public function getAutosummary( Content $oldContent = null, Content $newContent = null,
813 $flags ) {
814 // Decide what kind of auto-summary is needed.
816 // Redirect auto-summaries
819 * @var $ot Title
820 * @var $rt Title
823 $ot = !is_null( $oldContent ) ? $oldContent->getRedirectTarget() : null;
824 $rt = !is_null( $newContent ) ? $newContent->getRedirectTarget() : null;
826 if ( is_object( $rt ) ) {
827 if ( !is_object( $ot )
828 || !$rt->equals( $ot )
829 || $ot->getFragment() != $rt->getFragment()
831 $truncatedtext = $newContent->getTextForSummary(
833 - strlen( wfMessage( 'autoredircomment' )->inContentLanguage()->text() )
834 - strlen( $rt->getFullText() ) );
836 return wfMessage( 'autoredircomment', $rt->getFullText() )
837 ->rawParams( $truncatedtext )->inContentLanguage()->text();
841 // New page auto-summaries
842 if ( $flags & EDIT_NEW && $newContent->getSize() > 0 ) {
843 // If they're making a new article, give its text, truncated, in
844 // the summary.
846 $truncatedtext = $newContent->getTextForSummary(
847 200 - strlen( wfMessage( 'autosumm-new' )->inContentLanguage()->text() ) );
849 return wfMessage( 'autosumm-new' )->rawParams( $truncatedtext )
850 ->inContentLanguage()->text();
853 // Blanking auto-summaries
854 if ( !empty( $oldContent ) && $oldContent->getSize() > 0 && $newContent->getSize() == 0 ) {
855 return wfMessage( 'autosumm-blank' )->inContentLanguage()->text();
856 } elseif ( !empty( $oldContent )
857 && $oldContent->getSize() > 10 * $newContent->getSize()
858 && $newContent->getSize() < 500
860 // Removing more than 90% of the article
862 $truncatedtext = $newContent->getTextForSummary(
863 200 - strlen( wfMessage( 'autosumm-replace' )->inContentLanguage()->text() ) );
865 return wfMessage( 'autosumm-replace' )->rawParams( $truncatedtext )
866 ->inContentLanguage()->text();
869 // New blank article auto-summary
870 if ( $flags & EDIT_NEW && $newContent->isEmpty() ) {
871 return wfMessage( 'autosumm-newblank' )->inContentLanguage()->text();
874 // If we reach this point, there's no applicable auto-summary for our
875 // case, so our auto-summary is empty.
876 return '';
880 * Auto-generates a deletion reason
882 * @since 1.21
884 * @param Title $title The page's title
885 * @param bool &$hasHistory Whether the page has a history
887 * @return mixed String containing deletion reason or empty string, or
888 * boolean false if no revision occurred
890 * @todo &$hasHistory is extremely ugly, it's here because
891 * WikiPage::getAutoDeleteReason() and Article::generateReason()
892 * have it / want it.
894 public function getAutoDeleteReason( Title $title, &$hasHistory ) {
895 $dbw = wfGetDB( DB_MASTER );
897 // Get the last revision
898 $rev = Revision::newFromTitle( $title );
900 if ( is_null( $rev ) ) {
901 return false;
904 // Get the article's contents
905 $content = $rev->getContent();
906 $blank = false;
908 // If the page is blank, use the text from the previous revision,
909 // which can only be blank if there's a move/import/protect dummy
910 // revision involved
911 if ( !$content || $content->isEmpty() ) {
912 $prev = $rev->getPrevious();
914 if ( $prev ) {
915 $rev = $prev;
916 $content = $rev->getContent();
917 $blank = true;
921 $this->checkModelID( $rev->getContentModel() );
923 // Find out if there was only one contributor
924 // Only scan the last 20 revisions
925 $res = $dbw->select( 'revision', 'rev_user_text',
927 'rev_page' => $title->getArticleID(),
928 $dbw->bitAnd( 'rev_deleted', Revision::DELETED_USER ) . ' = 0'
930 __METHOD__,
931 [ 'LIMIT' => 20 ]
934 if ( $res === false ) {
935 // This page has no revisions, which is very weird
936 return false;
939 $hasHistory = ( $res->numRows() > 1 );
940 $row = $dbw->fetchObject( $res );
942 if ( $row ) { // $row is false if the only contributor is hidden
943 $onlyAuthor = $row->rev_user_text;
944 // Try to find a second contributor
945 foreach ( $res as $row ) {
946 if ( $row->rev_user_text != $onlyAuthor ) { // Bug 22999
947 $onlyAuthor = false;
948 break;
951 } else {
952 $onlyAuthor = false;
955 // Generate the summary with a '$1' placeholder
956 if ( $blank ) {
957 // The current revision is blank and the one before is also
958 // blank. It's just not our lucky day
959 $reason = wfMessage( 'exbeforeblank', '$1' )->inContentLanguage()->text();
960 } else {
961 if ( $onlyAuthor ) {
962 $reason = wfMessage(
963 'excontentauthor',
964 '$1',
965 $onlyAuthor
966 )->inContentLanguage()->text();
967 } else {
968 $reason = wfMessage( 'excontent', '$1' )->inContentLanguage()->text();
972 if ( $reason == '-' ) {
973 // Allow these UI messages to be blanked out cleanly
974 return '';
977 // Max content length = max comment length - length of the comment (excl. $1)
978 $text = $content ? $content->getTextForSummary( 255 - ( strlen( $reason ) - 2 ) ) : '';
980 // Now replace the '$1' placeholder
981 $reason = str_replace( '$1', $text, $reason );
983 return $reason;
987 * Get the Content object that needs to be saved in order to undo all revisions
988 * between $undo and $undoafter. Revisions must belong to the same page,
989 * must exist and must not be deleted.
991 * @since 1.21
993 * @param Revision $current The current text
994 * @param Revision $undo The revision to undo
995 * @param Revision $undoafter Must be an earlier revision than $undo
997 * @return mixed String on success, false on failure
999 public function getUndoContent( Revision $current, Revision $undo, Revision $undoafter ) {
1000 $cur_content = $current->getContent();
1002 if ( empty( $cur_content ) ) {
1003 return false; // no page
1006 $undo_content = $undo->getContent();
1007 $undoafter_content = $undoafter->getContent();
1009 if ( !$undo_content || !$undoafter_content ) {
1010 return false; // no content to undo
1013 $this->checkModelID( $cur_content->getModel() );
1014 $this->checkModelID( $undo_content->getModel() );
1015 $this->checkModelID( $undoafter_content->getModel() );
1017 if ( $cur_content->equals( $undo_content ) ) {
1018 // No use doing a merge if it's just a straight revert.
1019 return $undoafter_content;
1022 $undone_content = $this->merge3( $undo_content, $undoafter_content, $cur_content );
1024 return $undone_content;
1028 * Get parser options suitable for rendering and caching the article
1030 * @param IContextSource|User|string $context One of the following:
1031 * - IContextSource: Use the User and the Language of the provided
1032 * context
1033 * - User: Use the provided User object and $wgLang for the language,
1034 * so use an IContextSource object if possible.
1035 * - 'canonical': Canonical options (anonymous user with default
1036 * preferences and content language).
1038 * @throws MWException
1039 * @return ParserOptions
1041 public function makeParserOptions( $context ) {
1042 global $wgContLang, $wgEnableParserLimitReporting;
1044 if ( $context instanceof IContextSource ) {
1045 $options = ParserOptions::newFromContext( $context );
1046 } elseif ( $context instanceof User ) { // settings per user (even anons)
1047 $options = ParserOptions::newFromUser( $context );
1048 } elseif ( $context === 'canonical' ) { // canonical settings
1049 $options = ParserOptions::newFromUserAndLang( new User, $wgContLang );
1050 } else {
1051 throw new MWException( "Bad context for parser options: $context" );
1054 $options->enableLimitReport( $wgEnableParserLimitReporting ); // show inclusion/loop reports
1055 $options->setTidy( true ); // fix bad HTML
1057 return $options;
1061 * Returns true for content models that support caching using the
1062 * ParserCache mechanism. See WikiPage::shouldCheckParserCache().
1064 * @since 1.21
1066 * @return bool Always false.
1068 public function isParserCacheSupported() {
1069 return false;
1073 * Returns true if this content model supports sections.
1074 * This default implementation returns false.
1076 * Content models that return true here should also implement
1077 * Content::getSection, Content::replaceSection, etc. to handle sections..
1079 * @return bool Always false.
1081 public function supportsSections() {
1082 return false;
1086 * Returns true if this content model supports redirects.
1087 * This default implementation returns false.
1089 * Content models that return true here should also implement
1090 * ContentHandler::makeRedirectContent to return a Content object.
1092 * @return bool Always false.
1094 public function supportsRedirects() {
1095 return false;
1099 * Return true if this content model supports direct editing, such as via EditPage.
1101 * @return bool Default is false, and true for TextContent and it's derivatives.
1103 public function supportsDirectEditing() {
1104 return false;
1108 * Whether or not this content model supports direct editing via ApiEditPage
1110 * @return bool Default is false, and true for TextContent and derivatives.
1112 public function supportsDirectApiEditing() {
1113 return $this->supportsDirectEditing();
1117 * Logs a deprecation warning, visible if $wgDevelopmentWarnings, but only if
1118 * self::$enableDeprecationWarnings is set to true.
1120 * @param string $func The name of the deprecated function
1121 * @param string $version The version since the method is deprecated. Usually 1.21
1122 * for ContentHandler related stuff.
1123 * @param string|bool $component : Component to which the function belongs.
1124 * If false, it is assumed the function is in MediaWiki core.
1126 * @see ContentHandler::$enableDeprecationWarnings
1127 * @see wfDeprecated
1129 public static function deprecated( $func, $version, $component = false ) {
1130 if ( self::$enableDeprecationWarnings ) {
1131 wfDeprecated( $func, $version, $component, 3 );
1136 * Call a legacy hook that uses text instead of Content objects.
1137 * Will log a warning when a matching hook function is registered.
1138 * If the textual representation of the content is changed by the
1139 * hook function, a new Content object is constructed from the new
1140 * text.
1142 * @param string $event Event name
1143 * @param array $args Parameters passed to hook functions
1144 * @param bool $warn Whether to log a warning.
1145 * Default to self::$enableDeprecationWarnings.
1146 * May be set to false for testing.
1148 * @return bool True if no handler aborted the hook
1150 * @see ContentHandler::$enableDeprecationWarnings
1152 public static function runLegacyHooks( $event, $args = [],
1153 $warn = null
1156 if ( $warn === null ) {
1157 $warn = self::$enableDeprecationWarnings;
1160 if ( !Hooks::isRegistered( $event ) ) {
1161 return true; // nothing to do here
1164 if ( $warn ) {
1165 // Log information about which handlers are registered for the legacy hook,
1166 // so we can find and fix them.
1168 $handlers = Hooks::getHandlers( $event );
1169 $handlerInfo = [];
1171 MediaWiki\suppressWarnings();
1173 foreach ( $handlers as $handler ) {
1174 if ( is_array( $handler ) ) {
1175 if ( is_object( $handler[0] ) ) {
1176 $info = get_class( $handler[0] );
1177 } else {
1178 $info = $handler[0];
1181 if ( isset( $handler[1] ) ) {
1182 $info .= '::' . $handler[1];
1184 } elseif ( is_object( $handler ) ) {
1185 $info = get_class( $handler[0] );
1186 $info .= '::on' . $event;
1187 } else {
1188 $info = $handler;
1191 $handlerInfo[] = $info;
1194 MediaWiki\restoreWarnings();
1196 wfWarn( "Using obsolete hook $event via ContentHandler::runLegacyHooks()! Handlers: " .
1197 implode( ', ', $handlerInfo ), 2 );
1200 // convert Content objects to text
1201 $contentObjects = [];
1202 $contentTexts = [];
1204 foreach ( $args as $k => $v ) {
1205 if ( $v instanceof Content ) {
1206 /* @var Content $v */
1208 $contentObjects[$k] = $v;
1210 $v = $v->serialize();
1211 $contentTexts[$k] = $v;
1212 $args[$k] = $v;
1216 // call the hook functions
1217 $ok = Hooks::run( $event, $args );
1219 // see if the hook changed the text
1220 foreach ( $contentTexts as $k => $orig ) {
1221 /* @var Content $content */
1223 $modified = $args[$k];
1224 $content = $contentObjects[$k];
1226 if ( $modified !== $orig ) {
1227 // text was changed, create updated Content object
1228 $content = $content->getContentHandler()->unserializeContent( $modified );
1231 $args[$k] = $content;
1234 return $ok;