82 if ( is_null( $content ) ) {
87 return $content->getNativeData();
90 wfDebugLog(
'ContentHandler',
'Accessing ' . $content->getModel() .
' content as text!' );
94 "Attempt to get text from Content with model " .
100 return $content->serialize();
130 $modelId =
null, $format =
null ) {
131 if ( is_null( $modelId ) ) {
132 if ( is_null(
$title ) ) {
133 throw new MWException(
"Must provide a Title object or a content model ID." );
136 $modelId =
$title->getContentModel();
141 return $handler->unserializeContent( $text, $format );
182 $ns =
$title->getNamespace();
186 $model = MWNamespace::getNamespaceContentModel( $ns );
189 if ( !Hooks::run(
'ContentHandlerDefaultModelFor', [
$title, &$model ] ) ) {
190 if ( !is_null( $model ) ) {
196 $isCodePage =
NS_MEDIAWIKI == $ns && preg_match(
'!\.(css|js|json)$!u',
$title->getText(), $m );
202 $isCodeSubpage =
NS_USER == $ns
204 && preg_match(
"/\\/.*\\.(js|css|json)$/",
$title->getText(), $m );
205 if ( $isCodeSubpage ) {
211 $isWikitext = $isWikitext && !$isCodePage && !$isCodeSubpage;
213 if ( !$isWikitext ) {
241 $modelId =
$title->getContentModel();
296 if ( isset( self::$handlers[$modelId] ) ) {
297 return self::$handlers[$modelId];
303 Hooks::run(
'ContentHandlerForModelID', [ $modelId, &
$handler ] );
310 throw new MWException(
"ContentHandlerForModelID must supply a ContentHandler instance" );
315 if ( is_callable( $classOrCallback ) ) {
316 $handler = call_user_func( $classOrCallback, $modelId );
318 $handler =
new $classOrCallback( $modelId );
322 throw new MWException(
"$classOrCallback from \$wgContentHandlers is not " .
323 "compatible with ContentHandler" );
327 wfDebugLog(
'ContentHandler',
'Created handler for ' . $modelId
330 self::$handlers[$modelId] =
$handler;
332 return self::$handlers[$modelId];
351 $key =
"content-model-$name";
355 $msg->inLanguage(
$lang );
358 return $msg->exists() ? $msg->plain() :
$name;
365 Hooks::run(
'GetContentModels', [ &$models ] );
376 $formats = array_merge( $formats,
$handler->getSupportedFormats() );
379 $formats = array_unique( $formats );
406 $this->mModelID = $modelId;
407 $this->mSupportedFormats = $formats;
515 if ( $model_id !== $this->mModelID ) {
517 "expected {$this->mModelID} " .
518 "but got $model_id." );
547 return $this->mSupportedFormats[0];
568 return in_array( $format, $this->mSupportedFormats );
581 "Format $format is not supported for content model "
626 if ( !Hooks::run(
'GetDifferenceEngine',
661 $pageLang = Language::factory(
$lang );
664 Hooks::run(
'PageContentLanguage', [
$title, &$pageLang,
$wgLang ] );
695 $variant = $pageLang->getPreferredVariant();
696 if ( $pageLang->getCode() !== $variant ) {
697 $pageLang = Language::factory( $variant );
723 Hooks::run(
'ContentModelCanBeUsedOn', [ $this->
getModelID(), $title, &$ok ] );
736 return DifferenceEngine::class;
779 $ot = !is_null( $oldContent ) ? $oldContent->getRedirectTarget() :
null;
780 $rt = !is_null( $newContent ) ? $newContent->getRedirectTarget() :
null;
782 if ( is_object( $rt ) ) {
783 if ( !is_object( $ot )
784 || !$rt->equals( $ot )
785 || $ot->getFragment() != $rt->getFragment()
787 $truncatedtext = $newContent->getTextForSummary(
789 - strlen(
wfMessage(
'autoredircomment' )->inContentLanguage()->
text() )
790 - strlen( $rt->getFullText() ) );
792 return wfMessage(
'autoredircomment', $rt->getFullText() )
793 ->rawParams( $truncatedtext )->inContentLanguage()->text();
802 $truncatedtext = $newContent->getTextForSummary(
803 200 - strlen(
wfMessage(
'autosumm-new' )->inContentLanguage()->
text() ) );
805 return wfMessage(
'autosumm-new' )->rawParams( $truncatedtext )
806 ->inContentLanguage()->text();
810 if ( !empty( $oldContent ) && $oldContent->getSize() > 0 && $newContent->getSize() == 0 ) {
811 return wfMessage(
'autosumm-blank' )->inContentLanguage()->text();
812 } elseif ( !empty( $oldContent )
813 && $oldContent->getSize() > 10 * $newContent->getSize()
814 && $newContent->getSize() < 500
818 $truncatedtext = $newContent->getTextForSummary(
819 200 - strlen(
wfMessage(
'autosumm-replace' )->inContentLanguage()->
text() ) );
821 return wfMessage(
'autosumm-replace' )->rawParams( $truncatedtext )
822 ->inContentLanguage()->text();
827 return wfMessage(
'autosumm-newblank' )->inContentLanguage()->text();
856 if ( is_null(
$rev ) ) {
861 $content =
$rev->getContent();
867 if ( !$content || $content->isEmpty() ) {
868 $prev =
$rev->getPrevious();
872 $content =
$rev->getContent();
881 $res =
$dbr->select(
'revision',
'rev_user_text',
890 if (
$res ===
false ) {
895 $hasHistory = (
$res->numRows() > 1 );
899 $onlyAuthor = $row->rev_user_text;
901 foreach (
$res as $row ) {
902 if ( $row->rev_user_text != $onlyAuthor ) {
915 $reason =
wfMessage(
'exbeforeblank',
'$1' )->inContentLanguage()->text();
922 )->inContentLanguage()->text();
924 $reason =
wfMessage(
'excontent',
'$1' )->inContentLanguage()->text();
928 if ( $reason ==
'-' ) {
934 $text = $content ? $content->getTextForSummary( 255 - ( strlen( $reason ) - 2 ) ) :
'';
937 $reason = str_replace(
'$1', $text, $reason );
958 if ( empty( $cur_content ) ) {
963 $undoafter_content = $undoafter->
getContent();
965 if ( !$undo_content || !$undoafter_content ) {
985 if ( $cur_content->equals( $undo_content ) ) {
987 return $undoafter_content;
990 $undone_content = $this->
merge3( $undo_content, $undoafter_content, $cur_content );
992 return $undone_content;
1018 } elseif (
$context ===
'canonical' ) {
1022 throw new MWException(
"Bad context for parser options: $context" );
1025 return ParserOptions::newCanonical(
$user,
$lang );
1105 $fields[
'category'] =
$engine->makeSearchFieldMapping(
1111 $fields[
'external_link'] =
$engine->makeSearchFieldMapping(
1116 $fields[
'outgoing_link'] =
$engine->makeSearchFieldMapping(
1121 $fields[
'template'] =
$engine->makeSearchFieldMapping(
1127 $fields[
'content_model'] =
$engine->makeSearchFieldMapping(
1171 $fieldData[
'category'] = $searchDataExtractor->getCategories(
$output );
1172 $fieldData[
'external_link'] = $searchDataExtractor->getExternalLinks(
$output );
1173 $fieldData[
'outgoing_link'] = $searchDataExtractor->getOutgoingLinks(
$output );
1174 $fieldData[
'template'] = $searchDataExtractor->getTemplates(
$output );
1176 $text = $content->getTextForSearchIndex();
1178 $fieldData[
'text'] = $text;
1179 $fieldData[
'source_text'] = $text;
1180 $fieldData[
'text_bytes'] = $content->getSize();
1181 $fieldData[
'content_model'] = $content->getModel();
1184 Hooks::run(
'SearchDataForIndex', [ &$fieldData, $this, $page,
$output,
$engine ] );
1201 $parserOutput =
$cache->get( $page, $parserOptions );
1203 if ( empty( $parserOutput ) ) {
1207 $cache->save( $parserOutput, $page, $parserOptions );
1210 return $parserOutput;
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
$wgContentHandlerTextFallback
How to react if a plain text version of a non-text Content object is requested using ContentHandler::...
$wgContentHandlers
Plugins for page content model handling.
wfGetLangObj( $langcode=false)
Return a Language object from $langcode.
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not.
A content handler knows how do deal with a specific type of content on a wiki page.
getParserOutputForIndexing(WikiPage $page, ParserCache $cache=null)
Produce page output suitable for indexing.
getAutosummary(Content $oldContent=null, Content $newContent=null, $flags)
Return an applicable auto-summary if one exists for the given edit.
getModelID()
Returns the model id that identifies the content model this ContentHandler can handle.
makeRedirectContent(Title $destination, $text='')
Creates a new Content object that acts as a redirect to the given page, or null if redirects are not ...
__construct( $modelId, $formats)
Constructor, initializing the ContentHandler instance with its model ID and a list of supported forma...
static getAllContentFormats()
string[] $mSupportedFormats
static makeContent( $text, Title $title=null, $modelId=null, $format=null)
Convenience function for creating a Content object from a given textual representation.
importTransform( $blob, $format=null)
Apply import transformation (per default, returns $blob unchanged).
isParserCacheSupported()
Returns true for content models that support caching using the ParserCache mechanism.
static getForModelID( $modelId)
Returns the ContentHandler singleton for the given model ID.
supportsDirectApiEditing()
Whether or not this content model supports direct editing via ApiEditPage.
getAutoDeleteReason(Title $title, &$hasHistory)
Auto-generates a deletion reason.
getDiffEngineClass()
Returns the name of the diff engine to use.
static getForTitle(Title $title)
Returns the appropriate ContentHandler singleton for the given title.
exportTransform( $blob, $format=null)
Applies transformations on export (returns the blob unchanged per default).
merge3(Content $oldContent, Content $myContent, Content $yourContent)
Attempts to merge differences between three versions.
checkFormat( $format)
Convenient for checking whether a format provided as a parameter is actually supported.
addSearchField(&$fields, SearchEngine $engine, $name, $type)
Add new field definition to array.
getActionOverrides()
Returns overrides for action handlers.
createDifferenceEngine(IContextSource $context, $old=0, $new=0, $rcid=0, $refreshCache=false, $unhide=false)
Factory for creating an appropriate DifferenceEngine for this content model.
getUndoContent(Revision $current, Revision $undo, Revision $undoafter)
Get the Content object that needs to be saved in order to undo all revisions between $undo and $undoa...
static getContentModels()
getPageLanguage(Title $title, Content $content=null)
Get the language in which the content of the given page is written.
getDefaultFormat()
The format used for serialization/deserialization by default by this ContentHandler.
static getDefaultModelFor(Title $title)
Returns the name of the default content model to be used for the page with the given title.
unserializeContent( $blob, $format=null)
Unserializes a Content object of the type supported by this ContentHandler.
static getLocalizedName( $name, Language $lang=null)
Returns the localized name for a given content model.
supportsDirectEditing()
Return true if this content model supports direct editing, such as via EditPage.
isSupportedFormat( $format)
Returns true if $format is a serialization format supported by this ContentHandler,...
getSupportedFormats()
Returns a list of serialization formats supported by the serializeContent() and unserializeContent() ...
supportsSections()
Returns true if this content model supports sections.
static getContentText(Content $content=null)
Convenience function for getting flat text from a Content object.
getDataForSearchIndex(WikiPage $page, ParserOutput $output, SearchEngine $engine)
Return fields to be indexed by search engine as representation of this document.
supportsCategories()
Returns true if this content model supports categories.
static getForContent(Content $content)
Returns the appropriate ContentHandler singleton for the given Content object.
supportsRedirects()
Returns true if this content model supports redirects.
canBeUsedOn(Title $title)
Determines whether the content type handled by this ContentHandler can be used on the given page.
serializeContent(Content $content, $format=null)
Serializes a Content object of the type supported by this ContentHandler.
makeEmptyContent()
Creates an empty Content object of the type supported by this ContentHandler.
static array $handlers
A Cache of ContentHandler instances by model id.
makeParserOptions( $context)
Get parser options suitable for rendering and caching the article.
getFieldsForSearchIndex(SearchEngine $engine)
Get fields definition for search index.
getPageViewLanguage(Title $title, Content $content=null)
Get the language in which the content of this page is written when viewed by user.
Internationalisation code.
Exception thrown when an unregistered content model is requested.
static singleton()
Get the signleton instance of this class.
getContent( $audience=self::FOR_PUBLIC, User $user=null)
Fetch revision content if it's available to the specified audience.
static newFromTitle(LinkTarget $linkTarget, $id=0, $flags=0)
Load either the current, or a specified, revision that's attached to a given link target.
Contain a class for special pages.
Content object implementation for representing flat text.
Represents a title within MediaWiki.
getArticleID( $flags=0)
Get the article ID for this Title from the link cache, adding it if necessary.
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Class representing a MediaWiki article and history.
getRevision()
Get the latest revision.
makeParserOptions( $context)
Get parser options suitable for rendering the primary article wikitext.
getContent( $audience=Revision::FOR_PUBLIC, User $user=null)
Get the content of the current revision.
getTitle()
Get the title object of the article.
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
when a variable name is used in a it is silently declared as a new local masking the global
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as $wgLang
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
const CONTENT_MODEL_WIKITEXT
const CONTENT_MODEL_JAVASCRIPT
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify as strings Extensions should add to this list prev or next $refreshCache
the array() calling protocol came about after MediaWiki 1.4rc1.
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify as strings Extensions should add to this list prev or next refreshes the diff cache $unhide
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place $output
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
namespace and then decline to actually register it file or subcat img or subcat $title
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "<div ...>$1</div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify as strings Extensions should add to this list prev or next refreshes the diff cache allow viewing deleted revs & $differenceEngine
it s the revision text itself In either if gzip is the revision text is gzipped $flags
Allows to change the fields on the form that will be generated $name
the value to return A Title object or null for latest all implement SearchIndexField $engine
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves $handler
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
returning false will NOT prevent logging $e
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Base interface for content objects.
getModel()
Returns the ID of the content model used by this Content object.
Interface for objects which can provide a MediaWiki context on request.
const INDEX_TYPE_TEXT
Field types.
const FLAG_CASEFOLD
Generic field flags.
if(!isset( $args[0])) $lang