4 * Exception representing a failure to serialize or unserialize a content object.
6 class MWContentSerializationException
extends MWException
{
11 * A content handler knows how do deal with a specific type of content on a wiki
12 * page. Content is stored in the database in a serialized form (using a
13 * serialization format a.k.a. MIME type) and is unserialized into its native
14 * PHP representation (the content model), which is wrapped in an instance of
15 * the appropriate subclass of Content.
17 * ContentHandler instances are stateless singletons that serve, among other
18 * things, as a factory for Content objects. Generally, there is one subclass
19 * of ContentHandler and one subclass of Content for every type of content model.
21 * Some content types have a flat model, that is, their native representation
22 * is the same as their serialized form. Examples would be JavaScript and CSS
23 * code. As of now, this also applies to wikitext (MediaWiki's default content
24 * type), but wikitext content may be represented by a DOM or AST structure in
27 * This program is free software; you can redistribute it and/or modify
28 * it under the terms of the GNU General Public License as published by
29 * the Free Software Foundation; either version 2 of the License, or
30 * (at your option) any later version.
32 * This program is distributed in the hope that it will be useful,
33 * but WITHOUT ANY WARRANTY; without even the implied warranty of
34 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
35 * GNU General Public License for more details.
37 * You should have received a copy of the GNU General Public License along
38 * with this program; if not, write to the Free Software Foundation, Inc.,
39 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
40 * http://www.gnu.org/copyleft/gpl.html
47 * @author Daniel Kinzler
49 abstract class ContentHandler
{
52 * Switch for enabling deprecation warnings. Used by ContentHandler::deprecated()
53 * and ContentHandler::runLegacyHooks().
55 * Once the ContentHandler code has settled in a bit, this should be set to true to
56 * make extensions etc. show warnings when using deprecated functions and hooks.
58 protected static $enableDeprecationWarnings = false;
61 * Convenience function for getting flat text from a Content object. This
62 * should only be used in the context of backwards compatibility with code
63 * that is not yet able to handle Content objects!
65 * If $content is null, this method returns the empty string.
67 * If $content is an instance of TextContent, this method returns the flat
68 * text as returned by $content->getNativeData().
70 * If $content is not a TextContent object, the behavior of this method
71 * depends on the global $wgContentHandlerTextFallback:
72 * - If $wgContentHandlerTextFallback is 'fail' and $content is not a
73 * TextContent object, an MWException is thrown.
74 * - If $wgContentHandlerTextFallback is 'serialize' and $content is not a
75 * TextContent object, $content->serialize() is called to get a string
76 * form of the content.
77 * - If $wgContentHandlerTextFallback is 'ignore' and $content is not a
78 * TextContent object, this method returns null.
79 * - otherwise, the behaviour is undefined.
84 * @param $content Content|null
85 * @return null|string the textual form of $content, if available
86 * @throws MWException if $content is not an instance of TextContent and
87 * $wgContentHandlerTextFallback was set to 'fail'.
89 public static function getContentText( Content
$content = null ) {
90 global $wgContentHandlerTextFallback;
92 if ( is_null( $content ) ) {
96 if ( $content instanceof TextContent
) {
97 return $content->getNativeData();
100 if ( $wgContentHandlerTextFallback == 'fail' ) {
101 throw new MWException(
102 "Attempt to get text from Content with model " .
107 if ( $wgContentHandlerTextFallback == 'serialize' ) {
108 return $content->serialize();
115 * Convenience function for creating a Content object from a given textual
118 * $text will be deserialized into a Content object of the model specified
119 * by $modelId (or, if that is not given, $title->getContentModel()) using
126 * @param $text string the textual representation, will be
127 * unserialized to create the Content object
128 * @param $title null|Title the title of the page this text belongs to.
129 * Required if $modelId is not provided.
130 * @param $modelId null|string the model to deserialize to. If not provided,
131 * $title->getContentModel() is used.
132 * @param $format null|string the format to use for deserialization. If not
133 * given, the model's default format is used.
135 * @return Content a Content object representing $text
137 * @throw MWException if $model or $format is not supported or if $text can
138 * not be unserialized using $format.
140 public static function makeContent( $text, Title
$title = null,
141 $modelId = null, $format = null )
143 if ( is_null( $modelId ) ) {
144 if ( is_null( $title ) ) {
145 throw new MWException( "Must provide a Title object or a content model ID." );
148 $modelId = $title->getContentModel();
151 $handler = ContentHandler
::getForModelID( $modelId );
152 return $handler->unserializeContent( $text, $format );
156 * Returns the name of the default content model to be used for the page
157 * with the given title.
159 * Note: There should rarely be need to call this method directly.
160 * To determine the actual content model for a given page, use
161 * Title::getContentModel().
163 * Which model is to be used by default for the page is determined based
164 * on several factors:
165 * - The global setting $wgNamespaceContentModels specifies a content model
167 * - The hook ContentHandlerDefaultModelFor may be used to override the page's default
169 * - Pages in NS_MEDIAWIKI and NS_USER default to the CSS or JavaScript
170 * model if they end in .js or .css, respectively.
171 * - Pages in NS_MEDIAWIKI default to the wikitext model otherwise.
172 * - The hook TitleIsCssOrJsPage may be used to force a page to use the CSS
173 * or JavaScript model. This is a compatibility feature. The ContentHandlerDefaultModelFor
174 * hook should be used instead if possible.
175 * - The hook TitleIsWikitextPage may be used to force a page to use the
176 * wikitext model. This is a compatibility feature. The ContentHandlerDefaultModelFor
177 * hook should be used instead if possible.
179 * If none of the above applies, the wikitext model is used.
181 * Note: this is used by, and may thus not use, Title::getContentModel()
186 * @param $title Title
187 * @return null|string default model name for the page given by $title
189 public static function getDefaultModelFor( Title
$title ) {
190 global $wgNamespaceContentModels;
192 // NOTE: this method must not rely on $title->getContentModel() directly or indirectly,
193 // because it is used to initialize the mContentModel member.
195 $ns = $title->getNamespace();
201 if ( !empty( $wgNamespaceContentModels[ $ns ] ) ) {
202 $model = $wgNamespaceContentModels[ $ns ];
205 // Hook can determine default model
206 if ( !wfRunHooks( 'ContentHandlerDefaultModelFor', array( $title, &$model ) ) ) {
207 if ( !is_null( $model ) ) {
212 // Could this page contain custom CSS or JavaScript, based on the title?
213 $isCssOrJsPage = NS_MEDIAWIKI
== $ns && preg_match( '!\.(css|js)$!u', $title->getText(), $m );
214 if ( $isCssOrJsPage ) {
218 // Hook can force JS/CSS
219 wfRunHooks( 'TitleIsCssOrJsPage', array( $title, &$isCssOrJsPage ) );
221 // Is this a .css subpage of a user page?
222 $isJsCssSubpage = NS_USER
== $ns
224 && preg_match( "/\\/.*\\.(js|css)$/", $title->getText(), $m );
225 if ( $isJsCssSubpage ) {
229 // Is this wikitext, according to $wgNamespaceContentModels or the DefaultModelFor hook?
230 $isWikitext = is_null( $model ) ||
$model == CONTENT_MODEL_WIKITEXT
;
231 $isWikitext = $isWikitext && !$isCssOrJsPage && !$isJsCssSubpage;
233 // Hook can override $isWikitext
234 wfRunHooks( 'TitleIsWikitextPage', array( $title, &$isWikitext ) );
236 if ( !$isWikitext ) {
239 return CONTENT_MODEL_JAVASCRIPT
;
241 return CONTENT_MODEL_CSS
;
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.
258 * @param $title Title
259 * @return ContentHandler
261 public static function getForTitle( Title
$title ) {
262 $modelId = $title->getContentModel();
263 return ContentHandler
::getForModelID( $modelId );
267 * Returns the appropriate ContentHandler singleton for the given Content
273 * @param $content Content
274 * @return ContentHandler
276 public static function getForContent( Content
$content ) {
277 $modelId = $content->getModel();
278 return ContentHandler
::getForModelID( $modelId );
282 * @var Array A Cache of ContentHandler instances by model id
287 * Returns the ContentHandler singleton for the given model ID. Use the
288 * CONTENT_MODEL_XXX constants to identify the desired content model.
290 * ContentHandler singletons are taken from the global $wgContentHandlers
291 * array. Keys in that array are model names, the values are either
292 * ContentHandler singleton objects, or strings specifying the appropriate
293 * subclass of ContentHandler.
295 * If a class name is encountered when looking up the singleton for a given
296 * model name, the class is instantiated and the class name is replaced by
297 * the resulting singleton in $wgContentHandlers.
299 * If no ContentHandler is defined for the desired $modelId, the
300 * ContentHandler may be provided by the ContentHandlerForModelID hook.
301 * If no ContentHandler can be determined, an MWException is raised.
306 * @param $modelId String The ID of the content model for which to get a
307 * handler. Use CONTENT_MODEL_XXX constants.
308 * @return ContentHandler The ContentHandler singleton for handling the
309 * model given by $modelId
310 * @throws MWException if no handler is known for $modelId.
312 public static function getForModelID( $modelId ) {
313 global $wgContentHandlers;
315 if ( isset( ContentHandler
::$handlers[$modelId] ) ) {
316 return ContentHandler
::$handlers[$modelId];
319 if ( empty( $wgContentHandlers[$modelId] ) ) {
322 wfRunHooks( 'ContentHandlerForModelID', array( $modelId, &$handler ) );
324 if ( $handler === null ) {
325 throw new MWException( "No handler for model '$modelId'' registered in \$wgContentHandlers" );
328 if ( !( $handler instanceof ContentHandler
) ) {
329 throw new MWException( "ContentHandlerForModelID must supply a ContentHandler instance" );
332 $class = $wgContentHandlers[$modelId];
333 $handler = new $class( $modelId );
335 if ( !( $handler instanceof ContentHandler
) ) {
336 throw new MWException( "$class from \$wgContentHandlers is not compatible with ContentHandler" );
340 ContentHandler
::$handlers[$modelId] = $handler;
341 return ContentHandler
::$handlers[$modelId];
345 * Returns the localized name for a given content model.
347 * Model names are localized using system messages. Message keys
348 * have the form content-model-$name, where $name is getContentModelName( $id ).
351 * @param $name String The content model ID, as given by a CONTENT_MODEL_XXX
352 * constant or returned by Revision::getContentModel().
354 * @return string The content format's localized name.
355 * @throws MWException if the model id isn't known.
357 public static function getLocalizedName( $name ) {
358 $key = "content-model-$name";
360 $msg = wfMessage( $key );
362 return $msg->exists() ?
$msg->plain() : $name;
365 public static function getContentModels() {
366 global $wgContentHandlers;
368 return array_keys( $wgContentHandlers );
371 public static function getAllContentFormats() {
372 global $wgContentHandlers;
376 foreach ( $wgContentHandlers as $model => $class ) {
377 $handler = ContentHandler
::getForModelID( $model );
378 $formats = array_merge( $formats, $handler->getSupportedFormats() );
381 $formats = array_unique( $formats );
385 // ------------------------------------------------------------------------
388 protected $mSupportedFormats;
391 * Constructor, initializing the ContentHandler instance with its model ID
392 * and a list of supported formats. Values for the parameters are typically
393 * provided as literals by subclass's constructors.
395 * @param $modelId String (use CONTENT_MODEL_XXX constants).
396 * @param $formats array List for supported serialization formats
397 * (typically as MIME types)
399 public function __construct( $modelId, $formats ) {
400 $this->mModelID
= $modelId;
401 $this->mSupportedFormats
= $formats;
403 $this->mModelName
= preg_replace( '/(Content)?Handler$/', '', get_class( $this ) );
404 $this->mModelName
= preg_replace( '/[_\\\\]/', '', $this->mModelName
);
405 $this->mModelName
= strtolower( $this->mModelName
);
409 * Serializes a Content object of the type supported by this ContentHandler.
414 * @param $content Content The Content object to serialize
415 * @param $format null|String The desired serialization format
416 * @return string Serialized form of the content
418 public abstract function serializeContent( Content
$content, $format = null );
421 * Unserializes a Content object of the type supported by this ContentHandler.
426 * @param $blob string serialized form of the content
427 * @param $format null|String the format used for serialization
428 * @return Content the Content object created by deserializing $blob
430 public abstract function unserializeContent( $blob, $format = null );
433 * Creates an empty Content object of the type supported by this
440 public abstract function makeEmptyContent();
443 * Creates a new Content object that acts as a redirect to the given page,
444 * or null of redirects are not supported by this content model.
446 * This default implementation always returns null. Subclasses supporting redirects
447 * must override this method.
451 * @param Title $destination the page to redirect to.
455 public function makeRedirectContent( Title
$destination ) {
460 * Returns the model id that identifies the content model this
461 * ContentHandler can handle. Use with the CONTENT_MODEL_XXX constants.
465 * @return String The model ID
467 public function getModelID() {
468 return $this->mModelID
;
472 * Throws an MWException if $model_id is not the ID of the content model
473 * supported by this ContentHandler.
477 * @param String $model_id The model to check
479 * @throws MWException
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 array 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 $format string the serialization format to check
529 public function isSupportedFormat( $format ) {
532 return true; // this means "use the default"
535 return in_array( $format, $this->mSupportedFormats
);
539 * Throws an MWException if isSupportedFormat( $format ) is not true.
540 * Convenient for checking whether a format provided as a parameter is
541 * actually supported.
543 * @param $format string the serialization format to check
545 * @throws MWException
547 protected function checkFormat( $format ) {
548 if ( !$this->isSupportedFormat( $format ) ) {
549 throw new MWException(
550 "Format $format is not supported for content model "
551 . $this->getModelID()
557 * Returns overrides for action handlers.
558 * Classes listed here will be used instead of the default one when
559 * (and only when) $wgActions[$action] === true. This allows subclasses
560 * to override the default action handlers.
566 public function getActionOverrides() {
571 * Factory for creating an appropriate DifferenceEngine for this content model.
575 * @param $context IContextSource context to use, anything else will be
577 * @param $old Integer Old ID we want to show and diff with.
578 * @param $new int|string String either 'prev' or 'next'.
579 * @param $rcid Integer ??? FIXME (default 0)
580 * @param $refreshCache boolean If set, refreshes the diff cache
581 * @param $unhide boolean If set, allow viewing deleted revs
583 * @return DifferenceEngine
585 public function createDifferenceEngine( IContextSource
$context,
587 $rcid = 0, # FIXME: use everywhere!
588 $refreshCache = false, $unhide = false
590 $this->checkModelID( $context->getTitle()->getContentModel() );
592 $diffEngineClass = $this->getDiffEngineClass();
594 return new $diffEngineClass( $context, $old, $new, $rcid, $refreshCache, $unhide );
598 * Get the language in which the content of the given page is written.
600 * This default implementation just returns $wgContLang (except for pages in the MediaWiki namespace)
602 * Note that the pages language is not cacheable, since it may in some cases depend on user settings.
604 * Also note that the page language may or may not depend on the actual content of the page,
605 * that is, this method may load the content in order to determine the language.
609 * @param Title $title the page to determine the language for.
610 * @param Content|null $content the page's content, if you have it handy, to avoid reloading it.
612 * @return Language the page's language
614 public function getPageLanguage( Title
$title, Content
$content = null ) {
617 if ( $title->getNamespace() == NS_MEDIAWIKI
) {
618 // Parse mediawiki messages with correct target language
619 list( /* $unused */, $lang ) = MessageCache
::singleton()->figureMessage( $title->getText() );
620 return wfGetLangObj( $lang );
627 * Get the language in which the content of this page is written when
628 * viewed by user. Defaults to $this->getPageLanguage(), but if the user
629 * specified a preferred variant, the variant will be used.
631 * This default implementation just returns $this->getPageLanguage( $title, $content ) unless
632 * the user specified a preferred variant.
634 * Note that the pages view language is not cacheable, since it depends on user settings.
636 * Also note that the page language may or may not depend on the actual content of the page,
637 * that is, this method may load the content in order to determine the language.
641 * @param Title $title the page to determine the language for.
642 * @param Content|null $content the page's content, if you have it handy, to avoid reloading it.
644 * @return Language the page's language for viewing
646 public function getPageViewLanguage( Title
$title, Content
$content = null ) {
647 $pageLang = $this->getPageLanguage( $title, $content );
649 if ( $title->getNamespace() !== NS_MEDIAWIKI
) {
650 // If the user chooses a variant, the content is actually
651 // in a language whose code is the variant code.
652 $variant = $pageLang->getPreferredVariant();
653 if ( $pageLang->getCode() !== $variant ) {
654 $pageLang = Language
::factory( $variant );
662 * Determines whether the content type handled by this ContentHandler
663 * can be used on the given page.
665 * This default implementation always returns true.
666 * Subclasses may override this to restrict the use of this content model to specific locations,
667 * typically based on the namespace or some other aspect of the title, such as a special suffix
668 * (e.g. ".svg" for SVG content).
670 * @param Title $title the page's title.
672 * @return bool true if content of this kind can be used on the given page, false otherwise.
674 public function canBeUsedOn( Title
$title ) {
679 * Returns the name of the diff engine to use.
685 protected function getDiffEngineClass() {
686 return 'DifferenceEngine';
690 * Attempts to merge differences between three versions.
691 * Returns a new Content object for a clean merge and false for failure or
694 * This default implementation always returns false.
698 * @param $oldContent Content|string String
699 * @param $myContent Content|string String
700 * @param $yourContent Content|string String
702 * @return Content|Bool
704 public function merge3( Content
$oldContent, Content
$myContent, Content
$yourContent ) {
709 * Return an applicable auto-summary if one exists for the given edit.
713 * @param $oldContent Content|null: the previous text of the page.
714 * @param $newContent Content|null: The submitted text of the page.
715 * @param $flags int Bit mask: a bit mask of flags submitted for the edit.
717 * @return string An appropriate auto-summary, or an empty string.
719 public function getAutosummary( Content
$oldContent = null, Content
$newContent = null, $flags ) {
722 // Decide what kind of auto-summary is needed.
724 // Redirect auto-summaries
731 $ot = !is_null( $oldContent ) ?
$oldContent->getRedirectTarget() : null;
732 $rt = !is_null( $newContent ) ?
$newContent->getRedirectTarget() : null;
734 if ( is_object( $rt ) ) {
735 if ( !is_object( $ot )
736 ||
!$rt->equals( $ot )
737 ||
$ot->getFragment() != $rt->getFragment() )
739 $truncatedtext = $newContent->getTextForSummary(
741 - strlen( wfMessage( 'autoredircomment' )->inContentLanguage()->text() )
742 - strlen( $rt->getFullText() ) );
744 return wfMessage( 'autoredircomment', $rt->getFullText() )
745 ->rawParams( $truncatedtext )->inContentLanguage()->text();
749 // New page auto-summaries
750 if ( $flags & EDIT_NEW
&& $newContent->getSize() > 0 ) {
751 // If they're making a new article, give its text, truncated, in
754 $truncatedtext = $newContent->getTextForSummary(
755 200 - strlen( wfMessage( 'autosumm-new' )->inContentLanguage()->text() ) );
757 return wfMessage( 'autosumm-new' )->rawParams( $truncatedtext )
758 ->inContentLanguage()->text();
761 // Blanking auto-summaries
762 if ( !empty( $oldContent ) && $oldContent->getSize() > 0 && $newContent->getSize() == 0 ) {
763 return wfMessage( 'autosumm-blank' )->inContentLanguage()->text();
764 } elseif ( !empty( $oldContent )
765 && $oldContent->getSize() > 10 * $newContent->getSize()
766 && $newContent->getSize() < 500 )
768 // Removing more than 90% of the article
770 $truncatedtext = $newContent->getTextForSummary(
771 200 - strlen( wfMessage( 'autosumm-replace' )->inContentLanguage()->text() ) );
773 return wfMessage( 'autosumm-replace' )->rawParams( $truncatedtext )
774 ->inContentLanguage()->text();
777 // If we reach this point, there's no applicable auto-summary for our
778 // case, so our auto-summary is empty.
783 * Auto-generates a deletion reason
787 * @param $title Title: the page's title
788 * @param &$hasHistory Boolean: whether the page has a history
789 * @return mixed String containing deletion reason or empty string, or
790 * boolean false if no revision occurred
792 * @XXX &$hasHistory is extremely ugly, it's here because
793 * WikiPage::getAutoDeleteReason() and Article::getReason()
796 public function getAutoDeleteReason( Title
$title, &$hasHistory ) {
797 $dbw = wfGetDB( DB_MASTER
);
799 // Get the last revision
800 $rev = Revision
::newFromTitle( $title );
802 if ( is_null( $rev ) ) {
806 // Get the article's contents
807 $content = $rev->getContent();
810 $this->checkModelID( $content->getModel() );
812 // If the page is blank, use the text from the previous revision,
813 // which can only be blank if there's a move/import/protect dummy
815 if ( $content->getSize() == 0 ) {
816 $prev = $rev->getPrevious();
819 $content = $prev->getContent();
824 // Find out if there was only one contributor
825 // Only scan the last 20 revisions
826 $res = $dbw->select( 'revision', 'rev_user_text',
828 'rev_page' => $title->getArticleID(),
829 $dbw->bitAnd( 'rev_deleted', Revision
::DELETED_USER
) . ' = 0'
832 array( 'LIMIT' => 20 )
835 if ( $res === false ) {
836 // This page has no revisions, which is very weird
840 $hasHistory = ( $res->numRows() > 1 );
841 $row = $dbw->fetchObject( $res );
843 if ( $row ) { // $row is false if the only contributor is hidden
844 $onlyAuthor = $row->rev_user_text
;
845 // Try to find a second contributor
846 foreach ( $res as $row ) {
847 if ( $row->rev_user_text
!= $onlyAuthor ) { // Bug 22999
856 // Generate the summary with a '$1' placeholder
858 // The current revision is blank and the one before is also
859 // blank. It's just not our lucky day
860 $reason = wfMessage( 'exbeforeblank', '$1' )->inContentLanguage()->text();
867 )->inContentLanguage()->text();
869 $reason = wfMessage( 'excontent', '$1' )->inContentLanguage()->text();
873 if ( $reason == '-' ) {
874 // Allow these UI messages to be blanked out cleanly
878 // Max content length = max comment length - length of the comment (excl. $1)
879 $text = $content->getTextForSummary( 255 - ( strlen( $reason ) - 2 ) );
881 // Now replace the '$1' placeholder
882 $reason = str_replace( '$1', $text, $reason );
888 * Get the Content object that needs to be saved in order to undo all revisions
889 * between $undo and $undoafter. Revisions must belong to the same page,
890 * must exist and must not be deleted.
894 * @param $current Revision The current text
895 * @param $undo Revision The revision to undo
896 * @param $undoafter Revision Must be an earlier revision than $undo
898 * @return mixed String on success, false on failure
900 public function getUndoContent( Revision
$current, Revision
$undo, Revision
$undoafter ) {
901 $cur_content = $current->getContent();
903 if ( empty( $cur_content ) ) {
904 return false; // no page
907 $undo_content = $undo->getContent();
908 $undoafter_content = $undoafter->getContent();
910 $this->checkModelID( $cur_content->getModel() );
911 $this->checkModelID( $undo_content->getModel() );
912 $this->checkModelID( $undoafter_content->getModel() );
914 if ( $cur_content->equals( $undo_content ) ) {
915 // No use doing a merge if it's just a straight revert.
916 return $undoafter_content;
919 $undone_content = $this->merge3( $undo_content, $undoafter_content, $cur_content );
921 return $undone_content;
925 * Get parser options suitable for rendering the primary article wikitext
927 * @param IContextSource|User|string $context One of the following:
928 * - IContextSource: Use the User and the Language of the provided
930 * - User: Use the provided User object and $wgLang for the language,
931 * so use an IContextSource object if possible.
932 * - 'canonical': Canonical options (anonymous user with default
933 * preferences and content language).
935 * @param IContextSource|User|string $context
937 * @throws MWException
938 * @return ParserOptions
940 public function makeParserOptions( $context ) {
943 if ( $context instanceof IContextSource
) {
944 $options = ParserOptions
::newFromContext( $context );
945 } elseif ( $context instanceof User
) { // settings per user (even anons)
946 $options = ParserOptions
::newFromUser( $context );
947 } elseif ( $context === 'canonical' ) { // canonical settings
948 $options = ParserOptions
::newFromUserAndLang( new User
, $wgContLang );
950 throw new MWException( "Bad context for parser options: $context" );
953 $options->enableLimitReport(); // show inclusion/loop reports
954 $options->setTidy( true ); // fix bad HTML
960 * Returns true for content models that support caching using the
961 * ParserCache mechanism. See WikiPage::isParserCacheUsed().
967 public function isParserCacheSupported() {
972 * Returns true if this content model supports sections.
974 * This default implementation returns false.
976 * @return boolean whether sections are supported.
978 public function supportsSections() {
983 * Logs a deprecation warning, visible if $wgDevelopmentWarnings, but only if
984 * self::$enableDeprecationWarnings is set to true.
986 * @param String $func The name of the deprecated function
987 * @param string $version The version since the method is deprecated. Usually 1.21
988 * for ContentHandler related stuff.
989 * @param String|bool $component: Component to which the function belongs.
990 * If false, it is assumed the function is in MediaWiki core.
992 * @see ContentHandler::$enableDeprecationWarnings
995 public static function deprecated( $func, $version, $component = false ) {
996 if ( self
::$enableDeprecationWarnings ) {
997 wfDeprecated( $func, $version, $component, 3 );
1002 * Call a legacy hook that uses text instead of Content objects.
1003 * Will log a warning when a matching hook function is registered.
1004 * If the textual representation of the content is changed by the
1005 * hook function, a new Content object is constructed from the new
1008 * @param $event String: event name
1009 * @param $args Array: parameters passed to hook functions
1010 * @param $warn bool: whether to log a warning.
1011 * Default to self::$enableDeprecationWarnings.
1012 * May be set to false for testing.
1014 * @return Boolean True if no handler aborted the hook
1016 * @see ContentHandler::$enableDeprecationWarnings
1018 public static function runLegacyHooks( $event, $args = array(),
1021 if ( $warn === null ) {
1022 $warn = self
::$enableDeprecationWarnings;
1025 if ( !Hooks
::isRegistered( $event ) ) {
1026 return true; // nothing to do here
1030 // Log information about which handlers are registered for the legacy hook,
1031 // so we can find and fix them.
1033 $handlers = Hooks
::getHandlers( $event );
1034 $handlerInfo = array();
1036 wfSuppressWarnings();
1038 foreach ( $handlers as $handler ) {
1041 if ( is_array( $handler ) ) {
1042 if ( is_object( $handler[0] ) ) {
1043 $info = get_class( $handler[0] );
1045 $info = $handler[0];
1048 if ( isset( $handler[1] ) ) {
1049 $info .= '::' . $handler[1];
1051 } else if ( is_object( $handler ) ) {
1052 $info = get_class( $handler[0] );
1053 $info .= '::on' . $event;
1058 $handlerInfo[] = $info;
1061 wfRestoreWarnings();
1063 wfWarn( "Using obsolete hook $event via ContentHandler::runLegacyHooks()! Handlers: " . implode(', ', $handlerInfo), 2 );
1066 // convert Content objects to text
1067 $contentObjects = array();
1068 $contentTexts = array();
1070 foreach ( $args as $k => $v ) {
1071 if ( $v instanceof Content
) {
1072 /* @var Content $v */
1074 $contentObjects[$k] = $v;
1076 $v = $v->serialize();
1077 $contentTexts[ $k ] = $v;
1082 // call the hook functions
1083 $ok = wfRunHooks( $event, $args );
1085 // see if the hook changed the text
1086 foreach ( $contentTexts as $k => $orig ) {
1087 /* @var Content $content */
1089 $modified = $args[ $k ];
1090 $content = $contentObjects[$k];
1092 if ( $modified !== $orig ) {
1093 // text was changed, create updated Content object
1094 $content = $content->getContentHandler()->unserializeContent( $modified );
1097 $args[ $k ] = $content;