44 $this->
getMain()->setCacheMode(
'anon-public-user-private' );
57 if ( $title ===
null ) {
58 $titleProvided =
false;
62 $titleProvided =
true;
69 $model =
$params[
'contentmodel'];
70 $format =
$params[
'contentformat'];
72 $prop = array_flip(
$params[
'prop'] );
74 if ( isset(
$params[
'section'] ) ) {
75 $this->section =
$params[
'section'];
76 if ( !preg_match(
'/^((T-)?\d+|new)$/', $this->section ) ) {
80 $this->section =
false;
90 $needContent = isset( $prop[
'wikitext'] ) ||
91 isset( $prop[
'parsetree'] ) ||
$params[
'generatexml'];
96 if ( !is_null( $oldid ) || !is_null( $pageid ) || !is_null( $page ) ) {
97 if ( $this->section ===
'new' ) {
98 $this->
dieWithError(
'apierror-invalidparammix-parse-new-section',
'invalidparammix' );
100 if ( !is_null( $oldid ) ) {
102 $rev = Revision::newFromId( $oldid );
104 $this->
dieWithError( [
'apierror-nosuchrevid', $oldid ] );
108 if ( !
$rev->userCan( Revision::DELETED_TEXT, $this->getUser() ) ) {
110 [
'apierror-permissiondenied', $this->
msg(
'action-deletedtext' ) ]
114 $titleObj =
$rev->getTitle();
116 $pageObj = WikiPage::factory( $titleObj );
119 $pageObj, $popts, $suppressCache, $pageid,
$rev, $needContent
126 if ( !is_null( $pageid ) ) {
127 $reqParams[
'pageids'] = $pageid;
129 $reqParams[
'titles'] = $page;
135 $redirValues = $pageSet->getRedirectTitlesAsResult( $this->
getResult() );
138 foreach ( $pageSet->getRedirectTitles() as $title ) {
139 $to = $title->getFullText();
141 $pageParams = [
'title' => $to ];
142 } elseif ( !is_null( $pageid ) ) {
143 $pageParams = [
'pageid' => $pageid ];
145 $pageParams = [
'title' => $page ];
149 $titleObj = $pageObj->getTitle();
150 if ( !$titleObj || !$titleObj->exists() ) {
157 if ( isset( $prop[
'revid'] ) ) {
158 $oldid = $pageObj->getLatest();
163 $pageObj, $popts, $suppressCache, $pageid,
null, $needContent
167 $titleObj = Title::newFromText( $title );
168 if ( !$titleObj || $titleObj->isExternal() ) {
172 if ( $revid !==
null ) {
173 $rev = Revision::newFromId( $revid );
175 $this->
dieWithError( [
'apierror-nosuchrevid', $revid ] );
177 $pTitleObj = $titleObj;
178 $titleObj =
$rev->getTitle();
179 if ( $titleProvided ) {
180 if ( !$titleObj->equals( $pTitleObj ) ) {
187 $titleProvided =
true;
191 if ( $titleObj->canExist() ) {
192 $pageObj = WikiPage::factory( $titleObj );
196 $pageObj = $article->getPage();
200 $textProvided = !is_null( $text );
202 if ( !$textProvided ) {
203 if ( $titleProvided && ( $prop ||
$params[
'generatexml'] ) ) {
204 if ( $revid !==
null ) {
205 $this->
addWarning(
'apiwarn-parse-revidwithouttext' );
207 $this->
addWarning(
'apiwarn-parse-titlewithouttext' );
216 if ( $textProvided && !$titleProvided && is_null( $model ) ) {
218 $this->
addWarning( [
'apiwarn-parse-nocontentmodel', $model ] );
222 $this->content = ContentHandler::makeContent( $text, $titleObj, $model, $format );
225 'wrap' =>
ApiMessage::create(
'apierror-contentserializationexception',
'parseerror' )
229 if ( $this->section !==
false ) {
230 if ( $this->section ===
'new' ) {
232 if ( !is_null(
$params[
'sectiontitle'] ) &&
$params[
'sectiontitle'] !==
'' ) {
233 $this->content = $this->content->addSectionHeader(
$params[
'sectiontitle'] );
236 $this->content = $this->
getSectionContent( $this->content, $titleObj->getPrefixedText() );
241 $this->pstContent = $this->content->preSaveTransform( $titleObj, $this->
getUser(), $popts );
246 $result_array[
'text'] = $this->pstContent->serialize( $format );
248 if ( isset( $prop[
'wikitext'] ) ) {
249 $result_array[
'wikitext'] = $this->content->serialize( $format );
252 if ( !is_null(
$params[
'summary'] ) ||
253 ( !is_null(
$params[
'sectiontitle'] ) && $this->section ===
'new' )
259 $result->addValue(
null, $this->
getModuleName(), $result_array );
266 $p_result = $this->pstContent->getParserOutput( $titleObj, $revid, $popts );
268 $p_result = $this->content->getParserOutput( $titleObj, $revid, $popts );
274 $result_array[
'title'] = $titleObj->getPrefixedText();
275 $result_array[
'pageid'] = $pageid ?: $pageObj->getId();
276 if ( $this->contentIsDeleted ) {
277 $result_array[
'textdeleted'] =
true;
279 if ( $this->contentIsSuppressed ) {
280 $result_array[
'textsuppressed'] =
true;
283 if ( isset(
$params[
'useskin'] ) ) {
284 $factory = MediaWikiServices::getInstance()->getSkinFactory();
285 $skin = $factory->makeSkin( Skin::normalizeKey(
$params[
'useskin'] ) );
291 if ( $skin || isset( $prop[
'headhtml'] ) || isset( $prop[
'categorieshtml'] ) ) {
316 $outputPage->addParserOutputMetadata( $p_result );
321 $skin->setupSkinUserCss( $outputPage );
323 foreach ( $skin->getDefaultModules() as $group ) {
324 $outputPage->addModules( $group );
329 if ( !is_null( $oldid ) ) {
330 $result_array[
'revid'] = intval( $oldid );
333 if (
$params[
'redirects'] && !is_null( $redirValues ) ) {
334 $result_array[
'redirects'] = $redirValues;
337 if ( isset( $prop[
'text'] ) ) {
338 $result_array[
'text'] = $p_result->getText( [
339 'allowTOC' => !
$params[
'disabletoc'],
340 'enableSectionEditLinks' => !
$params[
'disableeditsection'],
341 'unwrap' =>
$params[
'wrapoutputclass'] ===
'',
342 'deduplicateStyles' => !
$params[
'disablestylededuplication'],
347 if ( !is_null(
$params[
'summary'] ) ||
348 ( !is_null(
$params[
'sectiontitle'] ) && $this->section ===
'new' )
354 if ( isset( $prop[
'langlinks'] ) ) {
356 $langlinks = $outputPage->getLanguageLinks();
358 $langlinks = $p_result->getLanguageLinks();
362 if (
$params[
'effectivelanglinks'] ) {
364 Hooks::run(
'LanguageLinks', [ $titleObj, &$langlinks, &$linkFlags ] );
370 if ( isset( $prop[
'categories'] ) ) {
373 if ( isset( $prop[
'categorieshtml'] ) ) {
374 $result_array[
'categorieshtml'] = $outputPage->getSkin()->getCategories();
377 if ( isset( $prop[
'links'] ) ) {
378 $result_array[
'links'] = $this->
formatLinks( $p_result->getLinks() );
380 if ( isset( $prop[
'templates'] ) ) {
381 $result_array[
'templates'] = $this->
formatLinks( $p_result->getTemplates() );
383 if ( isset( $prop[
'images'] ) ) {
384 $result_array[
'images'] = array_keys( $p_result->getImages() );
386 if ( isset( $prop[
'externallinks'] ) ) {
387 $result_array[
'externallinks'] = array_keys( $p_result->getExternalLinks() );
389 if ( isset( $prop[
'sections'] ) ) {
390 $result_array[
'sections'] = $p_result->getSections();
392 if ( isset( $prop[
'parsewarnings'] ) ) {
393 $result_array[
'parsewarnings'] = $p_result->getWarnings();
396 if ( isset( $prop[
'displaytitle'] ) ) {
397 $result_array[
'displaytitle'] = $p_result->getDisplayTitle() !==
false
398 ? $p_result->getDisplayTitle() : $titleObj->getPrefixedText();
401 if ( isset( $prop[
'headitems'] ) ) {
403 $result_array[
'headitems'] = $this->
formatHeadItems( $outputPage->getHeadItemsArray() );
405 $result_array[
'headitems'] = $this->
formatHeadItems( $p_result->getHeadItems() );
409 if ( isset( $prop[
'headhtml'] ) ) {
410 $result_array[
'headhtml'] = $outputPage->headElement(
$context->
getSkin() );
414 if ( isset( $prop[
'modules'] ) ) {
416 $result_array[
'modules'] = $outputPage->getModules();
417 $result_array[
'modulescripts'] = $outputPage->getModuleScripts();
418 $result_array[
'modulestyles'] = $outputPage->getModuleStyles();
420 $result_array[
'modules'] = array_values( array_unique( $p_result->getModules() ) );
421 $result_array[
'modulescripts'] = array_values( array_unique( $p_result->getModuleScripts() ) );
422 $result_array[
'modulestyles'] = array_values( array_unique( $p_result->getModuleStyles() ) );
426 if ( isset( $prop[
'jsconfigvars'] ) ) {
427 $jsconfigvars = $skin ? $outputPage->getJsConfigVars() : $p_result->getJsConfigVars();
431 if ( isset( $prop[
'encodedjsconfigvars'] ) ) {
432 $jsconfigvars = $skin ? $outputPage->getJsConfigVars() : $p_result->getJsConfigVars();
433 $result_array[
'encodedjsconfigvars'] = FormatJson::encode(
441 if ( isset( $prop[
'modules'] ) &&
442 !isset( $prop[
'jsconfigvars'] ) && !isset( $prop[
'encodedjsconfigvars'] ) ) {
443 $this->
addWarning(
'apiwarn-moduleswithoutvars' );
446 if ( isset( $prop[
'indicators'] ) ) {
448 $result_array[
'indicators'] = (
array)$outputPage->getIndicators();
450 $result_array[
'indicators'] = (
array)$p_result->getIndicators();
455 if ( isset( $prop[
'iwlinks'] ) ) {
456 $result_array[
'iwlinks'] = $this->
formatIWLinks( $p_result->getInterwikiLinks() );
459 if ( isset( $prop[
'wikitext'] ) ) {
460 $result_array[
'wikitext'] = $this->content->serialize( $format );
462 if ( !is_null( $this->pstContent ) ) {
463 $result_array[
'psttext'] = $this->pstContent->serialize( $format );
467 if ( isset( $prop[
'properties'] ) ) {
468 $result_array[
'properties'] = (
array)$p_result->getProperties();
472 if ( isset( $prop[
'limitreportdata'] ) ) {
473 $result_array[
'limitreportdata'] =
476 if ( isset( $prop[
'limitreporthtml'] ) ) {
481 if ( isset( $prop[
'parsetree'] ) ||
$params[
'generatexml'] ) {
483 $this->
dieWithError(
'apierror-parsetree-notwikitext',
'notwikitext' );
486 $wgParser->startExternalParse( $titleObj, $popts, Parser::OT_PREPROCESS );
487 $xml =
$wgParser->preprocessToDom( $this->content->getNativeData() )->__toString();
488 $result_array[
'parsetree'] = $xml;
495 'categories' =>
'cl',
499 'externallinks' =>
'el',
504 'indicators' =>
'ind',
505 'modulescripts' =>
'm',
506 'modulestyles' =>
'm',
507 'properties' =>
'pp',
508 'limitreportdata' =>
'lr',
509 'parsewarnings' =>
'pw'
512 $result->addValue(
null, $this->
getModuleName(), $result_array );
524 $popts = $pageObj->makeParserOptions( $this->
getContext() );
525 $popts->enableLimitReport( !
$params[
'disablepp'] && !
$params[
'disablelimitreport'] );
526 $popts->setIsPreview(
$params[
'preview'] ||
$params[
'sectionpreview'] );
527 $popts->setIsSectionPreview(
$params[
'sectionpreview'] );
528 if (
$params[
'disabletidy'] ) {
529 $popts->setTidy(
false );
531 if (
$params[
'wrapoutputclass'] !==
'' ) {
532 $popts->setWrapOutputClass(
$params[
'wrapoutputclass'] );
536 $suppressCache =
false;
537 Hooks::run(
'ApiMakeParserOptions',
538 [ $popts, $pageObj->getTitle(),
$params, $this, &$reset, &$suppressCache ] );
541 $suppressCache = $suppressCache || !$popts->isSafeToCache();
543 return [ $popts, $reset, $suppressCache ];
556 WikiPage $page, $popts, $suppressCache, $pageId,
$rev, $getContent
558 $revId =
$rev ?
$rev->getId() :
null;
559 $isDeleted =
$rev &&
$rev->isDeleted( Revision::DELETED_TEXT );
561 if ( $getContent || $this->section !==
false || $isDeleted ) {
563 $this->content =
$rev->getContent( Revision::FOR_THIS_USER, $this->
getUser() );
564 if ( !$this->content ) {
565 $this->
dieWithError( [
'apierror-missingcontent-revid', $revId ] );
569 if ( !$this->content ) {
573 $this->contentIsDeleted = $isDeleted;
574 $this->contentIsSuppressed =
$rev &&
575 $rev->isDeleted( Revision::DELETED_TEXT | Revision::DELETED_RESTRICTED );
578 if ( $this->section !==
false ) {
581 $pageId ===
null ? $page->
getTitle()->getPrefixedText() : $this->
msg(
'pageid', $pageId )
583 return $this->content->getParserOutput( $page->
getTitle(), $revId, $popts );
588 $pout = $this->content->getParserOutput( $page->
getTitle(), $revId, $popts );
611 $this->
dieWithError( [
'apierror-nosuchsection-what', $this->section, $what ],
'nosuchsection' );
614 $this->
dieWithError( [
'apierror-sectionsnotsupported-what', $what ],
'nosuchsection' );
630 $summary = !is_null(
$params[
'summary'] ) ?
$params[
'summary'] :
'';
631 $sectionTitle = !is_null(
$params[
'sectiontitle'] ) ?
$params[
'sectiontitle'] :
'';
633 if ( $this->section ===
'new' && ( $sectionTitle ===
'' || $summary ===
'' ) ) {
634 if ( $sectionTitle !==
'' ) {
635 $summary =
$params[
'sectiontitle'];
637 if ( $summary !==
'' ) {
638 $summary =
wfMessage(
'newsectionsummary' )
639 ->rawParams(
$wgParser->stripSectionName( $summary ) )
640 ->inContentLanguage()->text();
648 foreach ( $links as
$link ) {
650 $bits = explode(
':',
$link, 2 );
651 $title = Title::newFromText(
$link );
653 $entry[
'lang'] = $bits[0];
657 $entry[
'langname'] = Language::fetchLanguageName(
658 $title->getInterwiki(),
659 $this->getLanguage()->getCode()
663 $entry[
'autonym'] = Language::fetchLanguageName( $title->getInterwiki() );
682 $db = $this->
getDB();
683 $res = $db->select( [
'page',
'page_props' ],
684 [
'page_title',
'pp_propname' ],
685 $lb->constructSet(
'page', $db ),
689 'LEFT JOIN', [
'pp_propname' =>
'hiddencat',
'pp_page = page_id' ]
693 foreach (
$res as $row ) {
694 $hiddencats[$row->page_title] = isset( $row->pp_propname );
697 $linkCache = LinkCache::singleton();
699 foreach ( $links as
$link => $sortkey ) {
701 $entry[
'sortkey'] = $sortkey;
704 if ( !isset( $hiddencats[
$link] ) ) {
705 $entry[
'missing'] =
true;
710 $linkCache->addBadLinkObj( $title );
711 if ( $title->isKnown() ) {
712 $entry[
'known'] =
true;
714 } elseif ( $hiddencats[
$link] ) {
715 $entry[
'hidden'] =
true;
725 foreach ( $links as $ns => $nslinks ) {
726 foreach ( $nslinks as $title => $id ) {
730 $entry[
'exists'] = $id != 0;
740 foreach ( $iw as $prefix =>
$titles ) {
741 foreach ( array_keys(
$titles ) as $title ) {
743 $entry[
'prefix'] = $prefix;
745 $title = Title::newFromText(
"{$prefix}:{$title}" );
760 foreach ( $headItems as $tag =>
$content ) {
762 $entry[
'tag'] = $tag;
773 foreach ( $limitReportData as $name =>
$value ) {
775 $entry[
'name'] =
$name;
776 if ( !is_array(
$value ) ) {
780 $entry = array_merge( $entry,
$value );
788 foreach ( $mapping as $key => $name ) {
789 if ( isset( $array[$key] ) ) {
809 'redirects' =>
false,
815 'images|externallinks|sections|revid|displaytitle|iwlinks|' .
816 'properties|parsewarnings',
833 'encodedjsconfigvars',
848 'headitems' =>
'apiwarn-deprecation-parse-headitems',
851 'wrapoutputclass' =>
'mw-parser-output',
854 'effectivelanglinks' => [
866 'disablelimitreport' =>
false,
867 'disableeditsection' =>
false,
868 'disabletidy' =>
false,
869 'disablestylededuplication' =>
false,
878 'sectionpreview' =>
false,
879 'disabletoc' =>
false,
894 'action=parse&page=Project:Sandbox'
895 =>
'apihelp-parse-example-page',
896 'action=parse&text={{Project:Sandbox}}&contentmodel=wikitext'
897 =>
'apihelp-parse-example-text',
898 'action=parse&text={{PAGENAME}}&title=Test'
899 =>
'apihelp-parse-example-texttitle',
900 'action=parse&summary=Some+[[link]]&prop='
901 =>
'apihelp-parse-example-summary',
906 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Parsing_wikitext#parse';
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
if(! $wgRequest->checkUrlExtension()) if(isset($_SERVER[ 'PATH_INFO']) &&$_SERVER[ 'PATH_INFO'] !='') if(! $wgEnableAPI) $wgTitle
This abstract class implements many basic API functions, and is the base of all API classes.
const PARAM_DEPRECATED
(boolean) Is the parameter deprecated (will show a warning)?
getDB()
Gets a default replica DB connection object.
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
const PARAM_DEPRECATED_VALUES
(array) When PARAM_TYPE is an array, this indicates which of the values are deprecated.
getMain()
Get the main module.
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
const PARAM_HELP_MSG_PER_VALUE
((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg...
getResult()
Get the result object.
requireMaxOneParameter( $params, $required)
Die if more than one of a certain set of parameters is set and not false.
dieWithException( $exception, array $options=[])
Abort execution with an error derived from an exception.
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
addWarning( $msg, $code=null, $data=null)
Add a warning for this module.
getModuleName()
Get the name of the module being executed by this instance.
getTitleOrPageId( $params, $load=false)
Get a WikiPage object from a title or pageid param, if possible.
checkTitleUserPermissions(Title $title, $actions, $user=null)
Helper function for permission-denied errors.
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
This is the main API class, used for both external and internal processing.
static create( $msg, $code=null, array $data=null)
Create an IApiMessage for the message.
This class contains a list of pages that the client has requested.
formatSummary( $title, $params)
This mimicks the behavior of EditPage in formatting a summary.
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
getParsedContent(WikiPage $page, $popts, $suppressCache, $pageId, $rev, $getContent)
formatHeadItems( $headItems)
getExamplesMessages()
Returns usage examples for this module.
formatCategoryLinks( $links)
formatLimitReportData( $limitReportData)
makeParserOptions(WikiPage $pageObj, array $params)
Constructs a ParserOptions object.
bool $contentIsSuppressed
getSectionContent(Content $content, $what)
Extract the requested section from the given Content.
getHelpUrls()
Return links to more detailed help pages about the module.
setIndexedTagNames(&$array, $mapping)
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
static setArrayType(array &$arr, $type, $kvpKeyName=null)
Set the array data type.
static addMetadataToResultVars( $vars, $forceHash=true)
Add the correct metadata to an array of vars we want to export through the API.
const META_SUBELEMENTS
Key for the 'subelements' metadata item.
const META_BC_SUBELEMENTS
Key for the 'BC subelements' metadata item.
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
static setContentValue(array &$arr, $name, $value, $flags=0)
Add an output value to the array by name and mark as META_CONTENT.
static setIndexedTagNameRecursive(array &$arr, $tag)
Set indexed tag name on $arr and all subarrays.
static newFromTitle( $title, IContextSource $context)
Create an Article object of the appropriate class for the given page.
msg( $key)
Get a Message object with context set Parameters are the same as wfMessage()
getContext()
Get the base IContextSource object.
An IContextSource implementation which will inherit context from another source but allow individual ...
static getPreviewLimitReport( $output)
Get the Limit report for page previews.
WebRequest clone which takes values from a provided array.
Class representing a list of titles The execute() method checks them all for existence and adds them ...
setArray( $array)
Set the link list to a given 2-d array First key is the namespace, second is the DB key,...
static formatComment( $comment, $title=null, $local=false, $wikiId=null)
This function is called by all recent changes variants, by the page history, and by the user contribu...
Exception representing a failure to serialize or unserialize a content object.
This class should be covered by a general architecture document which does not exist as of January 20...
Class representing a MediaWiki article and history.
getLatest()
Get the page_latest field.
getParserOutput(ParserOptions $parserOptions, $oldid=null, $forceParse=false)
Get a ParserOutput for the given ParserOptions and revision ID.
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 hook is for auditing only $req
the array() calling protocol came about after MediaWiki 1.4rc1.
namespace being checked & $result
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
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Allows to change the fields on the form that will be generated $name
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
const CONTENT_MODEL_WIKITEXT
Base interface for content objects.
linkcache txt The LinkCache class maintains a list of article titles and the information about whether or not the article exists in the database This is used to mark up links when displaying a page If the same link appears more than once on any page then it only has to be looked up once In most cases link lookups are done in batches with the LinkBatch class or the equivalent in so the link cache is mostly useful for short snippets of parsed and for links in the navigation areas of the skin The link cache was formerly used to track links used in a document for the purposes of updating the link tables This application is now deprecated To create a you can use the following $titles