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
25 * @author Daniel Kinzler
29 * Exception representing a failure to serialize or unserialize a content object.
33 class MWContentSerializationException
extends MWException
{
37 * A content handler knows how do deal with a specific type of content on a wiki
38 * page. Content is stored in the database in a serialized form (using a
39 * serialization format a.k.a. MIME type) and is unserialized into its native
40 * PHP representation (the content model), which is wrapped in an instance of
41 * the appropriate subclass of Content.
43 * ContentHandler instances are stateless singletons that serve, among other
44 * things, as a factory for Content objects. Generally, there is one subclass
45 * of ContentHandler and one subclass of Content for every type of content model.
47 * Some content types have a flat model, that is, their native representation
48 * is the same as their serialized form. Examples would be JavaScript and CSS
49 * code. As of now, this also applies to wikitext (MediaWiki's default content
50 * type), but wikitext content may be represented by a DOM or AST structure in
55 abstract class ContentHandler
{
57 * Switch for enabling deprecation warnings. Used by ContentHandler::deprecated()
58 * and ContentHandler::runLegacyHooks().
60 * Once the ContentHandler code has settled in a bit, this should be set to true to
61 * make extensions etc. show warnings when using deprecated functions and hooks.
63 protected static $enableDeprecationWarnings = false;
66 * Convenience function for getting flat text from a Content object. This
67 * should only be used in the context of backwards compatibility with code
68 * that is not yet able to handle Content objects!
70 * If $content is null, this method returns the empty string.
72 * If $content is an instance of TextContent, this method returns the flat
73 * text as returned by $content->getNativeData().
75 * If $content is not a TextContent object, the behavior of this method
76 * depends on the global $wgContentHandlerTextFallback:
77 * - If $wgContentHandlerTextFallback is 'fail' and $content is not a
78 * TextContent object, an MWException is thrown.
79 * - If $wgContentHandlerTextFallback is 'serialize' and $content is not a
80 * TextContent object, $content->serialize() is called to get a string
81 * form of the content.
82 * - If $wgContentHandlerTextFallback is 'ignore' and $content is not a
83 * TextContent object, this method returns null.
84 * - otherwise, the behavior is undefined.
88 * @param Content $content
90 * @throws MWException If the content is not an instance of TextContent and
91 * wgContentHandlerTextFallback was set to 'fail'.
92 * @return string|null Textual form of the content, if available.
94 public static function getContentText( Content
$content = null ) {
95 global $wgContentHandlerTextFallback;
97 if ( is_null( $content ) ) {
101 if ( $content instanceof TextContent
) {
102 return $content->getNativeData();
105 wfDebugLog( 'ContentHandler', 'Accessing ' . $content->getModel() . ' content as text!' );
107 if ( $wgContentHandlerTextFallback == 'fail' ) {
108 throw new MWException(
109 "Attempt to get text from Content with model " .
114 if ( $wgContentHandlerTextFallback == 'serialize' ) {
115 return $content->serialize();
122 * Convenience function for creating a Content object from a given textual
125 * $text will be deserialized into a Content object of the model specified
126 * by $modelId (or, if that is not given, $title->getContentModel()) using
131 * @param string $text The textual representation, will be
132 * unserialized to create the Content object
133 * @param Title $title The title of the page this text belongs to.
134 * Required if $modelId is not provided.
135 * @param string $modelId The model to deserialize to. If not provided,
136 * $title->getContentModel() is used.
137 * @param string $format The format to use for deserialization. If not
138 * given, the model's default format is used.
140 * @throws MWException If model ID or format is not supported or if the text can not be
141 * unserialized using the format.
142 * @return Content A Content object representing the text.
144 public static function makeContent( $text, Title
$title = null,
145 $modelId = null, $format = null ) {
146 if ( is_null( $modelId ) ) {
147 if ( is_null( $title ) ) {
148 throw new MWException( "Must provide a Title object or a content model ID." );
151 $modelId = $title->getContentModel();
154 $handler = ContentHandler
::getForModelID( $modelId );
156 return $handler->unserializeContent( $text, $format );
160 * Returns the name of the default content model to be used for the page
161 * with the given title.
163 * Note: There should rarely be need to call this method directly.
164 * To determine the actual content model for a given page, use
165 * Title::getContentModel().
167 * Which model is to be used by default for the page is determined based
168 * on several factors:
169 * - The global setting $wgNamespaceContentModels specifies a content model
171 * - The hook ContentHandlerDefaultModelFor may be used to override the page's default
173 * - Pages in NS_MEDIAWIKI and NS_USER default to the CSS or JavaScript
174 * model if they end in .js or .css, respectively.
175 * - Pages in NS_MEDIAWIKI default to the wikitext model otherwise.
176 * - The hook TitleIsCssOrJsPage may be used to force a page to use the CSS
177 * or JavaScript model. This is a compatibility feature. The ContentHandlerDefaultModelFor
178 * hook should be used instead if possible.
179 * - The hook TitleIsWikitextPage may be used to force a page to use the
180 * wikitext model. This is a compatibility feature. The ContentHandlerDefaultModelFor
181 * hook should be used instead if possible.
183 * If none of the above applies, the wikitext model is used.
185 * Note: this is used by, and may thus not use, Title::getContentModel()
189 * @param Title $title
191 * @return string Default model name for the page given by $title
193 public static function getDefaultModelFor( Title
$title ) {
194 // NOTE: this method must not rely on $title->getContentModel() directly or indirectly,
195 // because it is used to initialize the mContentModel member.
197 $ns = $title->getNamespace();
201 $model = MWNamespace
::getNamespaceContentModel( $ns );
203 // Hook can determine default model
204 if ( !Hooks
::run( 'ContentHandlerDefaultModelFor', array( $title, &$model ) ) ) {
205 if ( !is_null( $model ) ) {
210 // Could this page contain code based on the title?
211 $isCodePage = NS_MEDIAWIKI
== $ns && preg_match( '!\.(css|js|json)$!u', $title->getText(), $m );
216 // Hook can force JS/CSS
217 Hooks
::run( 'TitleIsCssOrJsPage', array( $title, &$isCodePage ), '1.25' );
219 // Is this a user subpage containing code?
220 $isCodeSubpage = NS_USER
== $ns
222 && preg_match( "/\\/.*\\.(js|css|json)$/", $title->getText(), $m );
223 if ( $isCodeSubpage ) {
227 // Is this wikitext, according to $wgNamespaceContentModels or the DefaultModelFor hook?
228 $isWikitext = is_null( $model ) ||
$model == CONTENT_MODEL_WIKITEXT
;
229 $isWikitext = $isWikitext && !$isCodePage && !$isCodeSubpage;
231 // Hook can override $isWikitext
232 Hooks
::run( 'TitleIsWikitextPage', array( $title, &$isWikitext ), '1.25' );
234 if ( !$isWikitext ) {
237 return CONTENT_MODEL_JAVASCRIPT
;
239 return CONTENT_MODEL_CSS
;
241 return CONTENT_MODEL_JSON
;
243 return is_null( $model ) ? CONTENT_MODEL_TEXT
: $model;
247 // We established that it must be wikitext
249 return CONTENT_MODEL_WIKITEXT
;
253 * Returns the appropriate ContentHandler singleton for the given title.
257 * @param Title $title
259 * @return ContentHandler
261 public static function getForTitle( Title
$title ) {
262 $modelId = $title->getContentModel();
264 return ContentHandler
::getForModelID( $modelId );
268 * Returns the appropriate ContentHandler singleton for the given Content
273 * @param Content $content
275 * @return ContentHandler
277 public static function getForContent( Content
$content ) {
278 $modelId = $content->getModel();
280 return ContentHandler
::getForModelID( $modelId );
284 * @var array A Cache of ContentHandler instances by model id
286 protected static $handlers;
289 * Returns the ContentHandler singleton for the given model ID. Use the
290 * CONTENT_MODEL_XXX constants to identify the desired content model.
292 * ContentHandler singletons are taken from the global $wgContentHandlers
293 * array. Keys in that array are model names, the values are either
294 * ContentHandler singleton objects, or strings specifying the appropriate
295 * subclass of ContentHandler.
297 * If a class name is encountered when looking up the singleton for a given
298 * model name, the class is instantiated and the class name is replaced by
299 * the resulting singleton in $wgContentHandlers.
301 * If no ContentHandler is defined for the desired $modelId, the
302 * ContentHandler may be provided by the ContentHandlerForModelID hook.
303 * If no ContentHandler can be determined, an MWException is raised.
307 * @param string $modelId The ID of the content model for which to get a
308 * handler. Use CONTENT_MODEL_XXX constants.
310 * @throws MWException If no handler is known for the model ID.
311 * @return ContentHandler The ContentHandler singleton for handling the model given by the ID.
313 public static function getForModelID( $modelId ) {
314 global $wgContentHandlers;
316 if ( isset( ContentHandler
::$handlers[$modelId] ) ) {
317 return ContentHandler
::$handlers[$modelId];
320 if ( empty( $wgContentHandlers[$modelId] ) ) {
323 Hooks
::run( 'ContentHandlerForModelID', array( $modelId, &$handler ) );
325 if ( $handler === null ) {
326 throw new MWException( "No handler for model '$modelId' registered in \$wgContentHandlers" );
329 if ( !( $handler instanceof ContentHandler
) ) {
330 throw new MWException( "ContentHandlerForModelID must supply a ContentHandler instance" );
333 $class = $wgContentHandlers[$modelId];
334 $handler = new $class( $modelId );
336 if ( !( $handler instanceof ContentHandler
) ) {
337 throw new MWException( "$class from \$wgContentHandlers is not " .
338 "compatible with ContentHandler" );
342 wfDebugLog( 'ContentHandler', 'Created handler for ' . $modelId
343 . ': ' . get_class( $handler ) );
345 ContentHandler
::$handlers[$modelId] = $handler;
347 return ContentHandler
::$handlers[$modelId];
351 * Returns the localized name for a given content model.
353 * Model names are localized using system messages. Message keys
354 * have the form content-model-$name, where $name is getContentModelName( $id ).
356 * @param string $name The content model ID, as given by a CONTENT_MODEL_XXX
357 * constant or returned by Revision::getContentModel().
359 * @throws MWException If the model ID isn't known.
360 * @return string The content model's localized name.
362 public static function getLocalizedName( $name ) {
363 // Messages: content-model-wikitext, content-model-text,
364 // content-model-javascript, content-model-css
365 $key = "content-model-$name";
367 $msg = wfMessage( $key );
369 return $msg->exists() ?
$msg->plain() : $name;
372 public static function getContentModels() {
373 global $wgContentHandlers;
375 return array_keys( $wgContentHandlers );
378 public static function getAllContentFormats() {
379 global $wgContentHandlers;
383 foreach ( $wgContentHandlers as $model => $class ) {
384 $handler = ContentHandler
::getForModelID( $model );
385 $formats = array_merge( $formats, $handler->getSupportedFormats() );
388 $formats = array_unique( $formats );
393 // ------------------------------------------------------------------------
403 protected $mSupportedFormats;
406 * Constructor, initializing the ContentHandler instance with its model ID
407 * and a list of supported formats. Values for the parameters are typically
408 * provided as literals by subclass's constructors.
410 * @param string $modelId (use CONTENT_MODEL_XXX constants).
411 * @param string[] $formats List for supported serialization formats
412 * (typically as MIME types)
414 public function __construct( $modelId, $formats ) {
415 $this->mModelID
= $modelId;
416 $this->mSupportedFormats
= $formats;
418 $this->mModelName
= preg_replace( '/(Content)?Handler$/', '', get_class( $this ) );
419 $this->mModelName
= preg_replace( '/[_\\\\]/', '', $this->mModelName
);
420 $this->mModelName
= strtolower( $this->mModelName
);
424 * Serializes a Content object of the type supported by this ContentHandler.
428 * @param Content $content The Content object to serialize
429 * @param string $format The desired serialization format
431 * @return string Serialized form of the content
433 abstract public function serializeContent( Content
$content, $format = null );
436 * Applies transformations on export (returns the blob unchanged per default).
437 * Subclasses may override this to perform transformations such as conversion
438 * of legacy formats or filtering of internal meta-data.
440 * @param string $blob The blob to be exported
441 * @param string|null $format The blob's serialization format
445 public function exportTransform( $blob, $format = null ) {
450 * Unserializes a Content object of the type supported by this ContentHandler.
454 * @param string $blob Serialized form of the content
455 * @param string $format The format used for serialization
457 * @return Content The Content object created by deserializing $blob
459 abstract public function unserializeContent( $blob, $format = null );
462 * Apply import transformation (per default, returns $blob unchanged).
463 * This gives subclasses an opportunity to transform data blobs on import.
467 * @param string $blob
468 * @param string|null $format
472 public function importTransform( $blob, $format = null ) {
477 * Creates an empty Content object of the type supported by this
484 abstract public function makeEmptyContent();
487 * Creates a new Content object that acts as a redirect to the given page,
488 * or null if redirects are not supported by this content model.
490 * This default implementation always returns null. Subclasses supporting redirects
491 * must override this method.
493 * Note that subclasses that override this method to return a Content object
494 * should also override supportsRedirects() to return true.
498 * @param Title $destination The page to redirect to.
499 * @param string $text Text to include in the redirect, if possible.
501 * @return Content Always null.
503 public function makeRedirectContent( Title
$destination, $text = '' ) {
508 * Returns the model id that identifies the content model this
509 * ContentHandler can handle. Use with the CONTENT_MODEL_XXX constants.
513 * @return string The model ID
515 public function getModelID() {
516 return $this->mModelID
;
522 * @param string $model_id The model to check
524 * @throws MWException If the model ID is not the ID of the content model supported by this
527 protected function checkModelID( $model_id ) {
528 if ( $model_id !== $this->mModelID
) {
529 throw new MWException( "Bad content model: " .
530 "expected {$this->mModelID} " .
531 "but got $model_id." );
536 * Returns a list of serialization formats supported by the
537 * serializeContent() and unserializeContent() methods of this
542 * @return string[] List of serialization formats as MIME type like strings
544 public function getSupportedFormats() {
545 return $this->mSupportedFormats
;
549 * The format used for serialization/deserialization by default by this
552 * This default implementation will return the first element of the array
553 * of formats that was passed to the constructor.
557 * @return string The name of the default serialization format as a MIME type
559 public function getDefaultFormat() {
560 return $this->mSupportedFormats
[0];
564 * Returns true if $format is a serialization format supported by this
565 * ContentHandler, and false otherwise.
567 * Note that if $format is null, this method always returns true, because
568 * null means "use the default format".
572 * @param string $format The serialization format to check
576 public function isSupportedFormat( $format ) {
578 return true; // this means "use the default"
581 return in_array( $format, $this->mSupportedFormats
);
585 * Convenient for checking whether a format provided as a parameter is actually supported.
587 * @param string $format The serialization format to check
589 * @throws MWException If the format is not supported by this content handler.
591 protected function checkFormat( $format ) {
592 if ( !$this->isSupportedFormat( $format ) ) {
593 throw new MWException(
594 "Format $format is not supported for content model "
595 . $this->getModelID()
601 * Returns overrides for action handlers.
602 * Classes listed here will be used instead of the default one when
603 * (and only when) $wgActions[$action] === true. This allows subclasses
604 * to override the default action handlers.
608 * @return array Always an empty array.
610 public function getActionOverrides() {
615 * Factory for creating an appropriate DifferenceEngine for this content model.
619 * @param IContextSource $context Context to use, anything else will be ignored.
620 * @param int $old Revision ID we want to show and diff with.
621 * @param int|string $new Either a revision ID or one of the strings 'cur', 'prev' or 'next'.
622 * @param int $rcid FIXME: Deprecated, no longer used. Defaults to 0.
623 * @param bool $refreshCache If set, refreshes the diff cache. Defaults to false.
624 * @param bool $unhide If set, allow viewing deleted revs. Defaults to false.
626 * @return DifferenceEngine
628 public function createDifferenceEngine( IContextSource
$context, $old = 0, $new = 0,
629 $rcid = 0, //FIXME: Deprecated, no longer used
630 $refreshCache = false, $unhide = false ) {
632 // hook: get difference engine
633 $differenceEngine = null;
634 if ( !Hooks
::run( 'GetDifferenceEngine',
635 array( $context, $old, $new, $refreshCache, $unhide, &$differenceEngine )
637 return $differenceEngine;
639 $diffEngineClass = $this->getDiffEngineClass();
640 return new $diffEngineClass( $context, $old, $new, $rcid, $refreshCache, $unhide );
644 * Get the language in which the content of the given page is written.
646 * This default implementation just returns $wgContLang (except for pages
647 * in the MediaWiki namespace)
649 * Note that the pages language is not cacheable, since it may in some
650 * cases depend on user settings.
652 * Also note that the page language may or may not depend on the actual content of the page,
653 * that is, this method may load the content in order to determine the language.
657 * @param Title $title The page to determine the language for.
658 * @param Content $content The page's content, if you have it handy, to avoid reloading it.
660 * @return Language The page's language
662 public function getPageLanguage( Title
$title, Content
$content = null ) {
663 global $wgContLang, $wgLang;
664 $pageLang = $wgContLang;
666 if ( $title->getNamespace() == NS_MEDIAWIKI
) {
667 // Parse mediawiki messages with correct target language
668 list( /* $unused */, $lang ) = MessageCache
::singleton()->figureMessage( $title->getText() );
669 $pageLang = wfGetLangObj( $lang );
672 Hooks
::run( 'PageContentLanguage', array( $title, &$pageLang, $wgLang ) );
674 return wfGetLangObj( $pageLang );
678 * Get the language in which the content of this page is written when
679 * viewed by user. Defaults to $this->getPageLanguage(), but if the user
680 * specified a preferred variant, the variant will be used.
682 * This default implementation just returns $this->getPageLanguage( $title, $content ) unless
683 * the user specified a preferred variant.
685 * Note that the pages view language is not cacheable, since it depends on user settings.
687 * Also note that the page language may or may not depend on the actual content of the page,
688 * that is, this method may load the content in order to determine the language.
692 * @param Title $title The page to determine the language for.
693 * @param Content $content The page's content, if you have it handy, to avoid reloading it.
695 * @return Language The page's language for viewing
697 public function getPageViewLanguage( Title
$title, Content
$content = null ) {
698 $pageLang = $this->getPageLanguage( $title, $content );
700 if ( $title->getNamespace() !== NS_MEDIAWIKI
) {
701 // If the user chooses a variant, the content is actually
702 // in a language whose code is the variant code.
703 $variant = $pageLang->getPreferredVariant();
704 if ( $pageLang->getCode() !== $variant ) {
705 $pageLang = Language
::factory( $variant );
713 * Determines whether the content type handled by this ContentHandler
714 * can be used on the given page.
716 * This default implementation always returns true.
717 * Subclasses may override this to restrict the use of this content model to specific locations,
718 * typically based on the namespace or some other aspect of the title, such as a special suffix
719 * (e.g. ".svg" for SVG content).
721 * @note this calls the ContentHandlerCanBeUsedOn hook which may be used to override which
722 * content model can be used where.
724 * @param Title $title The page's title.
726 * @return bool True if content of this kind can be used on the given page, false otherwise.
728 public function canBeUsedOn( Title
$title ) {
731 Hooks
::run( 'ContentModelCanBeUsedOn', array( $this->getModelID(), $title, &$ok ) );
737 * Returns the name of the diff engine to use.
743 protected function getDiffEngineClass() {
744 return 'DifferenceEngine';
748 * Attempts to merge differences between three versions. Returns a new
749 * Content object for a clean merge and false for failure or a conflict.
751 * This default implementation always returns false.
755 * @param Content $oldContent The page's previous content.
756 * @param Content $myContent One of the page's conflicting contents.
757 * @param Content $yourContent One of the page's conflicting contents.
759 * @return Content|bool Always false.
761 public function merge3( Content
$oldContent, Content
$myContent, Content
$yourContent ) {
766 * Return an applicable auto-summary if one exists for the given edit.
770 * @param Content $oldContent The previous text of the page.
771 * @param Content $newContent The submitted text of the page.
772 * @param int $flags Bit mask: a bit mask of flags submitted for the edit.
774 * @return string An appropriate auto-summary, or an empty string.
776 public function getAutosummary( Content
$oldContent = null, Content
$newContent = null,
778 // Decide what kind of auto-summary is needed.
780 // Redirect auto-summaries
787 $ot = !is_null( $oldContent ) ?
$oldContent->getRedirectTarget() : null;
788 $rt = !is_null( $newContent ) ?
$newContent->getRedirectTarget() : null;
790 if ( is_object( $rt ) ) {
791 if ( !is_object( $ot )
792 ||
!$rt->equals( $ot )
793 ||
$ot->getFragment() != $rt->getFragment()
795 $truncatedtext = $newContent->getTextForSummary(
797 - strlen( wfMessage( 'autoredircomment' )->inContentLanguage()->text() )
798 - strlen( $rt->getFullText() ) );
800 return wfMessage( 'autoredircomment', $rt->getFullText() )
801 ->rawParams( $truncatedtext )->inContentLanguage()->text();
805 // New page auto-summaries
806 if ( $flags & EDIT_NEW
&& $newContent->getSize() > 0 ) {
807 // If they're making a new article, give its text, truncated, in
810 $truncatedtext = $newContent->getTextForSummary(
811 200 - strlen( wfMessage( 'autosumm-new' )->inContentLanguage()->text() ) );
813 return wfMessage( 'autosumm-new' )->rawParams( $truncatedtext )
814 ->inContentLanguage()->text();
817 // Blanking auto-summaries
818 if ( !empty( $oldContent ) && $oldContent->getSize() > 0 && $newContent->getSize() == 0 ) {
819 return wfMessage( 'autosumm-blank' )->inContentLanguage()->text();
820 } elseif ( !empty( $oldContent )
821 && $oldContent->getSize() > 10 * $newContent->getSize()
822 && $newContent->getSize() < 500
824 // Removing more than 90% of the article
826 $truncatedtext = $newContent->getTextForSummary(
827 200 - strlen( wfMessage( 'autosumm-replace' )->inContentLanguage()->text() ) );
829 return wfMessage( 'autosumm-replace' )->rawParams( $truncatedtext )
830 ->inContentLanguage()->text();
833 // New blank article auto-summary
834 if ( $flags & EDIT_NEW
&& $newContent->isEmpty() ) {
835 return wfMessage( 'autosumm-newblank' )->inContentLanguage()->text();
838 // If we reach this point, there's no applicable auto-summary for our
839 // case, so our auto-summary is empty.
844 * Auto-generates a deletion reason
848 * @param Title $title The page's title
849 * @param bool &$hasHistory Whether the page has a history
851 * @return mixed String containing deletion reason or empty string, or
852 * boolean false if no revision occurred
854 * @todo &$hasHistory is extremely ugly, it's here because
855 * WikiPage::getAutoDeleteReason() and Article::generateReason()
858 public function getAutoDeleteReason( Title
$title, &$hasHistory ) {
859 $dbw = wfGetDB( DB_MASTER
);
861 // Get the last revision
862 $rev = Revision
::newFromTitle( $title );
864 if ( is_null( $rev ) ) {
868 // Get the article's contents
869 $content = $rev->getContent();
872 // If the page is blank, use the text from the previous revision,
873 // which can only be blank if there's a move/import/protect dummy
875 if ( !$content ||
$content->isEmpty() ) {
876 $prev = $rev->getPrevious();
880 $content = $rev->getContent();
885 $this->checkModelID( $rev->getContentModel() );
887 // Find out if there was only one contributor
888 // Only scan the last 20 revisions
889 $res = $dbw->select( 'revision', 'rev_user_text',
891 'rev_page' => $title->getArticleID(),
892 $dbw->bitAnd( 'rev_deleted', Revision
::DELETED_USER
) . ' = 0'
895 array( 'LIMIT' => 20 )
898 if ( $res === false ) {
899 // This page has no revisions, which is very weird
903 $hasHistory = ( $res->numRows() > 1 );
904 $row = $dbw->fetchObject( $res );
906 if ( $row ) { // $row is false if the only contributor is hidden
907 $onlyAuthor = $row->rev_user_text
;
908 // Try to find a second contributor
909 foreach ( $res as $row ) {
910 if ( $row->rev_user_text
!= $onlyAuthor ) { // Bug 22999
919 // Generate the summary with a '$1' placeholder
921 // The current revision is blank and the one before is also
922 // blank. It's just not our lucky day
923 $reason = wfMessage( 'exbeforeblank', '$1' )->inContentLanguage()->text();
930 )->inContentLanguage()->text();
932 $reason = wfMessage( 'excontent', '$1' )->inContentLanguage()->text();
936 if ( $reason == '-' ) {
937 // Allow these UI messages to be blanked out cleanly
941 // Max content length = max comment length - length of the comment (excl. $1)
942 $text = $content ?
$content->getTextForSummary( 255 - ( strlen( $reason ) - 2 ) ) : '';
944 // Now replace the '$1' placeholder
945 $reason = str_replace( '$1', $text, $reason );
951 * Get the Content object that needs to be saved in order to undo all revisions
952 * between $undo and $undoafter. Revisions must belong to the same page,
953 * must exist and must not be deleted.
957 * @param Revision $current The current text
958 * @param Revision $undo The revision to undo
959 * @param Revision $undoafter Must be an earlier revision than $undo
961 * @return mixed String on success, false on failure
963 public function getUndoContent( Revision
$current, Revision
$undo, Revision
$undoafter ) {
964 $cur_content = $current->getContent();
966 if ( empty( $cur_content ) ) {
967 return false; // no page
970 $undo_content = $undo->getContent();
971 $undoafter_content = $undoafter->getContent();
973 if ( !$undo_content ||
!$undoafter_content ) {
974 return false; // no content to undo
977 $this->checkModelID( $cur_content->getModel() );
978 $this->checkModelID( $undo_content->getModel() );
979 $this->checkModelID( $undoafter_content->getModel() );
981 if ( $cur_content->equals( $undo_content ) ) {
982 // No use doing a merge if it's just a straight revert.
983 return $undoafter_content;
986 $undone_content = $this->merge3( $undo_content, $undoafter_content, $cur_content );
988 return $undone_content;
992 * Get parser options suitable for rendering and caching the article
994 * @param IContextSource|User|string $context One of the following:
995 * - IContextSource: Use the User and the Language of the provided
997 * - User: Use the provided User object and $wgLang for the language,
998 * so use an IContextSource object if possible.
999 * - 'canonical': Canonical options (anonymous user with default
1000 * preferences and content language).
1002 * @throws MWException
1003 * @return ParserOptions
1005 public function makeParserOptions( $context ) {
1006 global $wgContLang, $wgEnableParserLimitReporting;
1008 if ( $context instanceof IContextSource
) {
1009 $options = ParserOptions
::newFromContext( $context );
1010 } elseif ( $context instanceof User
) { // settings per user (even anons)
1011 $options = ParserOptions
::newFromUser( $context );
1012 } elseif ( $context === 'canonical' ) { // canonical settings
1013 $options = ParserOptions
::newFromUserAndLang( new User
, $wgContLang );
1015 throw new MWException( "Bad context for parser options: $context" );
1018 $options->enableLimitReport( $wgEnableParserLimitReporting ); // show inclusion/loop reports
1019 $options->setTidy( true ); // fix bad HTML
1025 * Returns true for content models that support caching using the
1026 * ParserCache mechanism. See WikiPage::shouldCheckParserCache().
1030 * @return bool Always false.
1032 public function isParserCacheSupported() {
1037 * Returns true if this content model supports sections.
1038 * This default implementation returns false.
1040 * Content models that return true here should also implement
1041 * Content::getSection, Content::replaceSection, etc. to handle sections..
1043 * @return bool Always false.
1045 public function supportsSections() {
1050 * Returns true if this content model supports redirects.
1051 * This default implementation returns false.
1053 * Content models that return true here should also implement
1054 * ContentHandler::makeRedirectContent to return a Content object.
1056 * @return bool Always false.
1058 public function supportsRedirects() {
1063 * Return true if this content model supports direct editing, such as via EditPage.
1065 * @return bool Default is false, and true for TextContent and it's derivatives.
1067 public function supportsDirectEditing() {
1072 * Whether or not this content model supports direct editing via ApiEditPage
1074 * @return bool Default is false, and true for TextContent and derivatives.
1076 public function supportsDirectApiEditing() {
1077 return $this->supportsDirectEditing();
1081 * Logs a deprecation warning, visible if $wgDevelopmentWarnings, but only if
1082 * self::$enableDeprecationWarnings is set to true.
1084 * @param string $func The name of the deprecated function
1085 * @param string $version The version since the method is deprecated. Usually 1.21
1086 * for ContentHandler related stuff.
1087 * @param string|bool $component : Component to which the function belongs.
1088 * If false, it is assumed the function is in MediaWiki core.
1090 * @see ContentHandler::$enableDeprecationWarnings
1093 public static function deprecated( $func, $version, $component = false ) {
1094 if ( self
::$enableDeprecationWarnings ) {
1095 wfDeprecated( $func, $version, $component, 3 );
1100 * Call a legacy hook that uses text instead of Content objects.
1101 * Will log a warning when a matching hook function is registered.
1102 * If the textual representation of the content is changed by the
1103 * hook function, a new Content object is constructed from the new
1106 * @param string $event Event name
1107 * @param array $args Parameters passed to hook functions
1108 * @param bool $warn Whether to log a warning.
1109 * Default to self::$enableDeprecationWarnings.
1110 * May be set to false for testing.
1112 * @return bool True if no handler aborted the hook
1114 * @see ContentHandler::$enableDeprecationWarnings
1116 public static function runLegacyHooks( $event, $args = array(),
1120 if ( $warn === null ) {
1121 $warn = self
::$enableDeprecationWarnings;
1124 if ( !Hooks
::isRegistered( $event ) ) {
1125 return true; // nothing to do here
1129 // Log information about which handlers are registered for the legacy hook,
1130 // so we can find and fix them.
1132 $handlers = Hooks
::getHandlers( $event );
1133 $handlerInfo = array();
1135 MediaWiki\
suppressWarnings();
1137 foreach ( $handlers as $handler ) {
1138 if ( is_array( $handler ) ) {
1139 if ( is_object( $handler[0] ) ) {
1140 $info = get_class( $handler[0] );
1142 $info = $handler[0];
1145 if ( isset( $handler[1] ) ) {
1146 $info .= '::' . $handler[1];
1148 } elseif ( is_object( $handler ) ) {
1149 $info = get_class( $handler[0] );
1150 $info .= '::on' . $event;
1155 $handlerInfo[] = $info;
1158 MediaWiki\restoreWarnings
();
1160 wfWarn( "Using obsolete hook $event via ContentHandler::runLegacyHooks()! Handlers: " .
1161 implode( ', ', $handlerInfo ), 2 );
1164 // convert Content objects to text
1165 $contentObjects = array();
1166 $contentTexts = array();
1168 foreach ( $args as $k => $v ) {
1169 if ( $v instanceof Content
) {
1170 /* @var Content $v */
1172 $contentObjects[$k] = $v;
1174 $v = $v->serialize();
1175 $contentTexts[$k] = $v;
1180 // call the hook functions
1181 $ok = Hooks
::run( $event, $args );
1183 // see if the hook changed the text
1184 foreach ( $contentTexts as $k => $orig ) {
1185 /* @var Content $content */
1187 $modified = $args[$k];
1188 $content = $contentObjects[$k];
1190 if ( $modified !== $orig ) {
1191 // text was changed, create updated Content object
1192 $content = $content->getContentHandler()->unserializeContent( $modified );
1195 $args[$k] = $content;