62 if ( !class_exists(
'XMLReader' ) ) {
63 throw new Exception(
'Import requires PHP to have been compiled with libxml support' );
66 $this->reader =
new XMLReader();
69 if ( !in_array(
'uploadsource', stream_get_wrappers() ) ) {
70 stream_wrapper_register(
'uploadsource', UploadSourceAdapter::class );
76 $oldDisable = libxml_disable_entity_loader(
false );
77 if ( defined(
'LIBXML_PARSEHUGE' ) ) {
78 $status = $this->reader->open(
"uploadsource://$id",
null, LIBXML_PARSEHUGE );
80 $status = $this->reader->open(
"uploadsource://$id" );
83 $error = libxml_get_last_error();
84 libxml_disable_entity_loader( $oldDisable );
85 throw new MWException(
'Encountered an internal error while initializing WikiImporter object: ' .
88 libxml_disable_entity_loader( $oldDisable );
109 $this->
debug(
"FAILURE: $err" );
110 wfDebug(
"WikiImporter XML error: $err\n" );
114 if ( $this->mDebug ) {
119 public function warn( $data ) {
127 if ( is_callable( $this->mNoticeCallback ) ) {
128 call_user_func( $this->mNoticeCallback, $msg,
$params );
149 $this->mNoUpdates = $noupdates;
159 $this->pageOffset = $nthPage;
169 return wfSetVar( $this->mNoticeCallback, $callback );
179 $this->mPageCallback = $callback;
194 $this->mPageOutCallback = $callback;
205 $this->mRevisionCallback = $callback;
216 $this->mUploadCallback = $callback;
227 $this->mLogItemCallback = $callback;
238 $this->mSiteInfoCallback = $callback;
248 $this->importTitleFactory = $factory;
257 if ( is_null( $namespace ) ) {
263 MWNamespace::exists( intval( $namespace ) )
265 $namespace = intval( $namespace );
280 if ( is_null( $rootpage ) ) {
283 } elseif ( $rootpage !==
'' ) {
284 $rootpage = rtrim( $rootpage,
'/' );
285 $title = Title::newFromText( $rootpage );
288 $status->fatal(
'import-rootpage-invalid' );
290 if ( !MWNamespace::hasSubpages(
$title->getNamespace() ) ) {
293 : MediaWikiServices::getInstance()->getContentLanguage()->
294 getNsText(
$title->getNamespace() );
295 $status->fatal(
'import-rootpage-nosubpage', $displayNSText );
310 $this->mImageBasePath = $dir;
317 $this->mImportUploads = $import;
326 $this->externalUserNames =
new ExternalUserNames( $usernamePrefix, $assignKnownUsers );
344 $title = $titleAndForeignTitle[0];
345 $page = WikiPage::factory(
$title );
346 $this->countableCache[
'title_' .
$title->getPrefixedText()] = $page->isCountable();
356 if ( !$revision->getContentHandler()->canBeUsedOn( $revision->getTitle() ) ) {
357 $this->
notice(
'import-error-bad-location',
358 $revision->getTitle()->getPrefixedText(),
360 $revision->getModel(),
361 $revision->getFormat() );
367 return $revision->importOldRevision();
369 $this->
notice(
'import-error-unserialize',
370 $revision->getTitle()->getPrefixedText(),
372 $revision->getModel(),
373 $revision->getFormat() );
385 return $revision->importLogItem();
394 return $revision->importUpload();
407 $sRevCount, $pageInfo
416 $page = WikiPage::factory(
$title );
417 $page->loadPageData(
'fromdbmaster' );
420 wfDebug( __METHOD__ .
': Skipping article count adjustment for ' .
$title .
421 ' because WikiPage::getContent() returned null' );
423 $editInfo = $page->prepareContentForEdit(
$content );
424 $countKey =
'title_' .
$title->getPrefixedText();
425 $countable = $page->isCountable( $editInfo );
426 if ( array_key_exists( $countKey, $this->countableCache ) &&
427 $countable != $this->countableCache[$countKey] ) {
428 DeferredUpdates::addUpdate( SiteStatsUpdate::factory( [
429 'articles' => ( (
int)$countable - (
int)$this->countableCache[$countKey] )
435 $args = func_get_args();
436 return Hooks::run(
'AfterImportPage',
$args );
444 $this->
debug(
"Got revision:" );
445 if ( is_object( $revision->title ) ) {
446 $this->
debug(
"-- Title: " . $revision->title->getPrefixedText() );
448 $this->
debug(
"-- Title: <invalid>" );
450 $this->
debug(
"-- User: " . $revision->user_text );
451 $this->
debug(
"-- Timestamp: " . $revision->timestamp );
452 $this->
debug(
"-- Comment: " . $revision->comment );
453 $this->
debug(
"-- Text: " . $revision->text );
462 if ( isset( $this->mSiteInfoCallback ) ) {
463 return call_user_func_array( $this->mSiteInfoCallback,
464 [ $siteInfo, $this ] );
475 if ( isset( $this->mPageCallback ) ) {
476 call_user_func( $this->mPageCallback,
$title );
489 $sucCount, $pageInfo ) {
490 if ( isset( $this->mPageOutCallback ) ) {
491 $args = func_get_args();
492 call_user_func_array( $this->mPageOutCallback,
$args );
502 if ( isset( $this->mRevisionCallback ) ) {
503 return call_user_func_array( $this->mRevisionCallback,
504 [ $revision, $this ] );
516 if ( isset( $this->mLogItemCallback ) ) {
517 return call_user_func_array( $this->mLogItemCallback,
518 [ $revision, $this ] );
531 return $this->reader->getAttribute( $attr );
542 if ( $this->reader->isEmptyElement ) {
546 while ( $this->reader->read() ) {
547 switch ( $this->reader->nodeType ) {
548 case XMLReader::TEXT:
549 case XMLReader::CDATA:
550 case XMLReader::SIGNIFICANT_WHITESPACE:
551 $buffer .= $this->reader->value;
553 case XMLReader::END_ELEMENT:
558 $this->reader->close();
572 $oldDisable = libxml_disable_entity_loader(
true );
573 $this->reader->read();
575 if ( $this->reader->localName !=
'mediawiki' ) {
576 libxml_disable_entity_loader( $oldDisable );
577 throw new MWException(
"Expected <mediawiki> tag, got " .
578 $this->reader->localName );
580 $this->
debug(
"<mediawiki> tag is correct." );
582 $this->
debug(
"Starting primary dump processing loop." );
584 $keepReading = $this->reader->read();
589 while ( $keepReading ) {
590 $tag = $this->reader->localName;
591 if ( $this->pageOffset ) {
592 if ( $tag ===
'page' ) {
595 if ( $pageCount < $this->pageOffset ) {
596 $keepReading = $this->reader->next();
600 $type = $this->reader->nodeType;
602 if ( !Hooks::run(
'ImportHandleToplevelXMLTag', [ $this ] ) ) {
604 } elseif ( $tag ==
'mediawiki' &&
$type == XMLReader::END_ELEMENT ) {
606 } elseif ( $tag ==
'siteinfo' ) {
608 } elseif ( $tag ==
'page' ) {
610 } elseif ( $tag ==
'logitem' ) {
612 } elseif ( $tag !=
'#text' ) {
613 $this->
warn(
"Unhandled top-level XML tag $tag" );
619 $keepReading = $this->reader->next();
621 $this->
debug(
"Skip" );
623 $keepReading = $this->reader->read();
626 }
catch ( Exception $ex ) {
631 libxml_disable_entity_loader( $oldDisable );
632 $this->reader->close();
642 $this->
debug(
"Enter site info handler." );
646 $normalFields = [
'sitename',
'base',
'generator',
'case' ];
648 while ( $this->reader->read() ) {
649 if ( $this->reader->nodeType == XMLReader::END_ELEMENT &&
650 $this->reader->localName ==
'siteinfo' ) {
654 $tag = $this->reader->localName;
656 if ( $tag ==
'namespace' ) {
659 } elseif ( in_array( $tag, $normalFields ) ) {
669 $this->
debug(
"Enter log item handler." );
673 $normalFields = [
'id',
'comment',
'type',
'action',
'timestamp',
674 'logtitle',
'params' ];
676 while ( $this->reader->read() ) {
677 if ( $this->reader->nodeType == XMLReader::END_ELEMENT &&
678 $this->reader->localName ==
'logitem' ) {
682 $tag = $this->reader->localName;
684 if ( !Hooks::run(
'ImportHandleLogItemXMLTag', [
688 } elseif ( in_array( $tag, $normalFields ) ) {
690 } elseif ( $tag ==
'contributor' ) {
692 } elseif ( $tag !=
'#text' ) {
693 $this->
warn(
"Unhandled log-item XML tag $tag" );
707 if ( isset( $logInfo[
'id'] ) ) {
708 $revision->setID( $logInfo[
'id'] );
710 $revision->setType( $logInfo[
'type'] );
711 $revision->setAction( $logInfo[
'action'] );
712 if ( isset( $logInfo[
'timestamp'] ) ) {
713 $revision->setTimestamp( $logInfo[
'timestamp'] );
715 if ( isset( $logInfo[
'params'] ) ) {
716 $revision->setParams( $logInfo[
'params'] );
718 if ( isset( $logInfo[
'logtitle'] ) ) {
721 $revision->setTitle( Title::newFromText( $logInfo[
'logtitle'] ) );
724 $revision->setNoUpdates( $this->mNoUpdates );
726 if ( isset( $logInfo[
'comment'] ) ) {
727 $revision->setComment( $logInfo[
'comment'] );
730 if ( isset( $logInfo[
'contributor'][
'ip'] ) ) {
731 $revision->setUserIP( $logInfo[
'contributor'][
'ip'] );
734 if ( !isset( $logInfo[
'contributor'][
'username'] ) ) {
735 $revision->setUsername( $this->externalUserNames->addPrefix(
'Unknown user' ) );
737 $revision->setUsername(
738 $this->externalUserNames->applyPrefix( $logInfo[
'contributor'][
'username'] )
747 $this->
debug(
"Enter page handler." );
748 $pageInfo = [
'revisionCount' => 0,
'successfulRevisionCount' => 0 ];
751 $normalFields = [
'title',
'ns',
'id',
'redirect',
'restrictions' ];
756 while ( $skip ? $this->reader->next() : $this->reader->read() ) {
757 if ( $this->reader->nodeType == XMLReader::END_ELEMENT &&
758 $this->reader->localName ==
'page' ) {
764 $tag = $this->reader->localName;
769 } elseif ( !Hooks::run(
'ImportHandlePageXMLTag', [ $this,
772 } elseif ( in_array( $tag, $normalFields ) ) {
780 if ( $tag ==
'redirect' ) {
785 } elseif ( $tag ==
'revision' || $tag ==
'upload' ) {
788 $pageInfo[
'ns'] ??
null );
791 if ( is_array(
$title ) ) {
793 list( $pageInfo[
'_title'], $foreignTitle ) =
$title;
801 if ( $tag ==
'revision' ) {
807 } elseif ( $tag !=
'#text' ) {
808 $this->
warn(
"Unhandled page XML tag $tag" );
818 if ( array_key_exists(
'_title', $pageInfo ) ) {
820 $pageInfo[
'revisionCount'],
821 $pageInfo[
'successfulRevisionCount'],
830 $this->
debug(
"Enter revision handler" );
833 $normalFields = [
'id',
'timestamp',
'comment',
'minor',
'model',
'format',
'text',
'sha1' ];
837 while ( $skip ? $this->reader->next() : $this->reader->read() ) {
838 if ( $this->reader->nodeType == XMLReader::END_ELEMENT &&
839 $this->reader->localName ==
'revision' ) {
843 $tag = $this->reader->localName;
845 if ( !Hooks::run(
'ImportHandleRevisionXMLTag', [
846 $this, $pageInfo, $revisionInfo
849 } elseif ( in_array( $tag, $normalFields ) ) {
851 } elseif ( $tag ==
'contributor' ) {
853 } elseif ( $tag !=
'#text' ) {
854 $this->
warn(
"Unhandled revision XML tag $tag" );
859 $pageInfo[
'revisionCount']++;
861 $pageInfo[
'successfulRevisionCount']++;
878 if ( ( !isset( $revisionInfo[
'model'] ) ||
879 in_array( $revisionInfo[
'model'], [
890 ( isset( $revisionInfo[
'id'] ) ?
891 "the revision with ID $revisionInfo[id]" :
893 ) .
" exceeds the maximum allowable size ($wgMaxArticleSize KB)" );
898 if ( isset( $revisionInfo[
'id'] ) ) {
899 $revision->setID( $revisionInfo[
'id'] );
901 if ( isset( $revisionInfo[
'model'] ) ) {
902 $revision->setModel( $revisionInfo[
'model'] );
904 if ( isset( $revisionInfo[
'format'] ) ) {
905 $revision->setFormat( $revisionInfo[
'format'] );
907 $revision->setTitle( $pageInfo[
'_title'] );
909 if ( isset( $revisionInfo[
'text'] ) ) {
910 $handler = $revision->getContentHandler();
912 $revisionInfo[
'text'],
913 $revision->getFormat() );
915 $revision->setText( $text );
917 if ( isset( $revisionInfo[
'timestamp'] ) ) {
918 $revision->setTimestamp( $revisionInfo[
'timestamp'] );
923 if ( isset( $revisionInfo[
'comment'] ) ) {
924 $revision->setComment( $revisionInfo[
'comment'] );
927 if ( isset( $revisionInfo[
'minor'] ) ) {
928 $revision->setMinor(
true );
930 if ( isset( $revisionInfo[
'contributor'][
'ip'] ) ) {
931 $revision->setUserIP( $revisionInfo[
'contributor'][
'ip'] );
932 } elseif ( isset( $revisionInfo[
'contributor'][
'username'] ) ) {
933 $revision->setUsername(
934 $this->externalUserNames->applyPrefix( $revisionInfo[
'contributor'][
'username'] )
937 $revision->setUsername( $this->externalUserNames->addPrefix(
'Unknown user' ) );
939 if ( isset( $revisionInfo[
'sha1'] ) ) {
940 $revision->setSha1Base36( $revisionInfo[
'sha1'] );
942 $revision->setNoUpdates( $this->mNoUpdates );
952 $this->
debug(
"Enter upload handler" );
955 $normalFields = [
'timestamp',
'comment',
'filename',
'text',
956 'src',
'size',
'sha1base36',
'archivename',
'rel' ];
960 while ( $skip ? $this->reader->next() : $this->reader->read() ) {
961 if ( $this->reader->nodeType == XMLReader::END_ELEMENT &&
962 $this->reader->localName ==
'upload' ) {
966 $tag = $this->reader->localName;
968 if ( !Hooks::run(
'ImportHandleUploadXMLTag', [
972 } elseif ( in_array( $tag, $normalFields ) ) {
974 } elseif ( $tag ==
'contributor' ) {
976 } elseif ( $tag ==
'contents' ) {
978 $encoding = $this->reader->getAttribute(
'encoding' );
979 if ( $encoding ===
'base64' ) {
980 $uploadInfo[
'fileSrc'] = $this->
dumpTemp( base64_decode( $contents ) );
981 $uploadInfo[
'isTempSrc'] =
true;
983 } elseif ( $tag !=
'#text' ) {
984 $this->
warn(
"Unhandled upload XML tag $tag" );
989 if ( $this->mImageBasePath && isset( $uploadInfo[
'rel'] ) ) {
990 $path =
"{$this->mImageBasePath}/{$uploadInfo['rel']}";
991 if ( file_exists(
$path ) ) {
992 $uploadInfo[
'fileSrc'] =
$path;
993 $uploadInfo[
'isTempSrc'] =
false;
997 if ( $this->mImportUploads ) {
1007 $filename = tempnam(
wfTempDir(),
'importupload' );
1008 file_put_contents( $filename, $contents );
1019 $text = $uploadInfo[
'text'] ??
'';
1021 $revision->setTitle( $pageInfo[
'_title'] );
1022 $revision->setID( $pageInfo[
'id'] );
1023 $revision->setTimestamp( $uploadInfo[
'timestamp'] );
1024 $revision->setText( $text );
1025 $revision->setFilename( $uploadInfo[
'filename'] );
1026 if ( isset( $uploadInfo[
'archivename'] ) ) {
1027 $revision->setArchiveName( $uploadInfo[
'archivename'] );
1029 $revision->setSrc( $uploadInfo[
'src'] );
1030 if ( isset( $uploadInfo[
'fileSrc'] ) ) {
1031 $revision->setFileSrc( $uploadInfo[
'fileSrc'],
1032 !empty( $uploadInfo[
'isTempSrc'] ) );
1034 if ( isset( $uploadInfo[
'sha1base36'] ) ) {
1035 $revision->setSha1Base36( $uploadInfo[
'sha1base36'] );
1037 $revision->setSize( intval( $uploadInfo[
'size'] ) );
1038 $revision->setComment( $uploadInfo[
'comment'] );
1040 if ( isset( $uploadInfo[
'contributor'][
'ip'] ) ) {
1041 $revision->setUserIP( $uploadInfo[
'contributor'][
'ip'] );
1043 if ( isset( $uploadInfo[
'contributor'][
'username'] ) ) {
1044 $revision->setUsername(
1045 $this->externalUserNames->applyPrefix( $uploadInfo[
'contributor'][
'username'] )
1048 $revision->setNoUpdates( $this->mNoUpdates );
1050 return call_user_func( $this->mUploadCallback, $revision );
1057 $fields = [
'id',
'ip',
'username' ];
1060 if ( $this->reader->isEmptyElement ) {
1063 while ( $this->reader->read() ) {
1064 if ( $this->reader->nodeType == XMLReader::END_ELEMENT &&
1065 $this->reader->localName ==
'contributor' ) {
1069 $tag = $this->reader->localName;
1071 if ( in_array( $tag, $fields ) ) {
1085 if ( is_null( $this->foreignNamespaces ) ) {
1089 $this->foreignNamespaces );
1092 $foreignTitle = $foreignTitleFactory->createForeignTitle( $text,
1095 $title = $this->importTitleFactory->createTitleFromForeignTitle(
1098 $commandLineMode = $this->config->get(
'CommandLineMode' );
1099 if ( is_null(
$title ) ) {
1100 # Invalid page title? Ignore the page
1101 $this->
notice(
'import-error-invalid', $foreignTitle->getFullText() );
1103 } elseif (
$title->isExternal() ) {
1104 $this->
notice(
'import-error-interwiki',
$title->getPrefixedText() );
1106 } elseif ( !
$title->canExist() ) {
1107 $this->
notice(
'import-error-special',
$title->getPrefixedText() );
1109 } elseif ( !
$title->userCan(
'edit' ) && !$commandLineMode ) {
1110 # Do not import if the importing wiki user cannot edit this page
1111 $this->
notice(
'import-error-edit',
$title->getPrefixedText() );
1113 } elseif ( !
$title->exists() && !
$title->userCan(
'create' ) && !$commandLineMode ) {
1114 # Do not import if the importing wiki user cannot create this page
1115 $this->
notice(
'import-error-create',
$title->getPrefixedText() );
1119 return [
$title, $foreignTitle ];
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
This list may contain false positives That usually means there is additional text with links below the first Each row contains links to the first and second as well as the first line of the second redirect text
$wgMaxArticleSize
Maximum article size in kilobytes.
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
wfTempDir()
Tries to get the system directory for temporary files.
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
wfSetVar(&$dest, $source, $force=false)
Sets dest to source and returns the original value of dest If source is NULL, it just returns the val...
Class to parse and build external user names.
Exception representing a failure to serialize or unserialize a content object.
A parser that translates page titles on a foreign wiki into ForeignTitle objects, with no knowledge o...
A class to convert page titles on a foreign wiki (ForeignTitle objects) into page titles on the local...
A parser that translates page titles on a foreign wiki into ForeignTitle objects, using information a...
A class to convert page titles on a foreign wiki (ForeignTitle objects) into page titles on the local...
A class to convert page titles on a foreign wiki (ForeignTitle objects) into page titles on the local...
static registerSource(ImportSource $source)
XML file reader for the page data importer.
finishImportPage( $title, $foreignTitle, $revCount, $sRevCount, $pageInfo)
Mostly for hook use.
setImportUploads( $import)
doImport()
Primary entry point.
setPageCallback( $callback)
Sets the action to perform as each new page in the stream is reached.
setUsernamePrefix( $usernamePrefix, $assignKnownUsers)
ExternalUserNames $externalUserNames
setNoUpdates( $noupdates)
Set 'no updates' mode.
pageOutCallback( $title, $foreignTitle, $revCount, $sucCount, $pageInfo)
Notify the callback function when a "</page>" is closed.
setLogItemCallback( $callback)
Sets the action to perform as each log item reached.
importUpload( $revision)
Dummy for now...
setImportTitleFactory( $factory)
Sets the factory object to use to convert ForeignTitle objects into local Title objects.
setSiteInfoCallback( $callback)
Sets the action to perform when site info is encountered.
nodeAttribute( $attr)
Retrieves the contents of the named attribute of the current element.
pageCallback( $title)
Notify the callback function when a new "<page>" is reached.
processLogItem( $logInfo)
setTargetNamespace( $namespace)
Set a target namespace to override the defaults.
setPageOffset( $nthPage)
Sets 'pageOffset' value.
debugRevisionHandler(&$revision)
Alternate per-revision callback, for debugging.
nodeContents()
Shouldn't something like this be built-in to XMLReader? Fetches text contents of the current element,...
importLogItem( $revision)
Default per-revision callback, performs the import.
handleRevision(&$pageInfo)
revisionCallback( $revision)
Notify the callback function of a revision.
logItemCallback( $revision)
Notify the callback function of a new log item.
setDebug( $debug)
Set debug mode...
processRevision( $pageInfo, $revisionInfo)
processUpload( $pageInfo, $uploadInfo)
bool $disableStatisticsUpdate
processTitle( $text, $ns=null)
importRevision( $revision)
Default per-revision callback, performs the import.
ImportTitleFactory $importTitleFactory
__construct(ImportSource $source, Config $config)
Creates an ImportXMLReader drawing from the source provided.
setPageOutCallback( $callback)
Sets the action to perform as each page in the stream is completed.
setTargetRootPage( $rootpage)
Set a target root page under which all pages are imported.
setNoticeCallback( $callback)
Set a callback that displays notice messages.
beforeImportPage( $titleAndForeignTitle)
Default per-page callback.
disableStatisticsUpdate()
Statistics update can cause a lot of time.
siteInfoCallback( $siteInfo)
Notify the callback function of site info.
setRevisionCallback( $callback)
Sets the action to perform as each page revision is reached.
setUploadCallback( $callback)
Sets the action to perform as each file upload version is reached.
Represents a revision, log entry or upload during the import process.
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
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
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 use $formDescriptor instead 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
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
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
Interface for configuration instances.
Source interface for XML import.
Represents an object that can convert page titles on a foreign wiki (ForeignTitle objects) into page ...
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))