X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/mediawiki.git/blobdiff_plain/18a6620945d02687fbcfc4c27355d952fd748b41..6932310fd58ebef145fa01eb76edf7150284d8ea:/includes/api/ApiParse.php diff --git a/includes/api/ApiParse.php b/includes/api/ApiParse.php index 2d12c233..7cbd3537 100644 --- a/includes/api/ApiParse.php +++ b/includes/api/ApiParse.php @@ -1,10 +1,8 @@ @gmail.com + * Copyright © 2007 Yuri Astrakhan "@gmail.com" * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -24,21 +22,24 @@ * @file */ -if ( !defined( 'MEDIAWIKI' ) ) { - // Eclipse helper - will be ignored in production - require_once( "ApiBase.php" ); -} +use MediaWiki\MediaWikiServices; /** * @ingroup API */ class ApiParse extends ApiBase { - private $section, $text, $pstText = null; + /** @var string $section */ + private $section = null; - public function __construct( $main, $action ) { - parent::__construct( $main, $action ); - } + /** @var Content $content */ + private $content = null; + + /** @var Content $pstContent */ + private $pstContent = null; + + /** @var bool */ + private $contentIsDeleted = false, $contentIsSuppressed = false; public function execute() { // The data is hot but user-dependent, like page views, so we set vary cookies @@ -46,180 +47,337 @@ class ApiParse extends ApiBase { // Get parameters $params = $this->extractRequestParams(); + + // No easy way to say that text and title or revid are allowed together + // while the rest aren't, so just do it in three calls. + $this->requireMaxOneParameter( $params, 'page', 'pageid', 'oldid', 'text' ); + $this->requireMaxOneParameter( $params, 'page', 'pageid', 'oldid', 'title' ); + $this->requireMaxOneParameter( $params, 'page', 'pageid', 'oldid', 'revid' ); + $text = $params['text']; $title = $params['title']; + if ( $title === null ) { + $titleProvided = false; + // A title is needed for parsing, so arbitrarily choose one + $title = 'API'; + } else { + $titleProvided = true; + } + $page = $params['page']; $pageid = $params['pageid']; $oldid = $params['oldid']; - if ( !is_null( $page ) && ( !is_null( $text ) || $title != 'API' ) ) { - $this->dieUsage( 'The page parameter cannot be used together with the text and title parameters', 'params' ); - } + $model = $params['contentmodel']; + $format = $params['contentformat']; + $prop = array_flip( $params['prop'] ); if ( isset( $params['section'] ) ) { $this->section = $params['section']; + if ( !preg_match( '/^((T-)?\d+|new)$/', $this->section ) ) { + $this->dieWithError( 'apierror-invalidsection' ); + } } else { $this->section = false; } // The parser needs $wgTitle to be set, apparently the // $title parameter in Parser::parse isn't enough *sigh* - global $wgParser, $wgUser, $wgTitle, $wgLang; + // TODO: Does this still need $wgTitle? + global $wgParser, $wgTitle; - // Currently unnecessary, code to act as a safeguard against any change in current behaviour of uselang breaks - $oldLang = null; - if ( isset( $params['uselang'] ) && $params['uselang'] != $wgLang->getCode() ) { - $oldLang = $wgLang; // Backup wgLang - $wgLang = Language::factory( $params['uselang'] ); - } + $redirValues = null; - $popts = new ParserOptions(); - $popts->setTidy( true ); - $popts->enableLimitReport( !$params['disablepp'] ); + $needContent = isset( $prop['wikitext'] ) || + isset( $prop['parsetree'] ) || $params['generatexml']; - $redirValues = null; + // Return result + $result = $this->getResult(); if ( !is_null( $oldid ) || !is_null( $pageid ) || !is_null( $page ) ) { - + if ( $this->section === 'new' ) { + $this->dieWithError( 'apierror-invalidparammix-parse-new-section', 'invalidparammix' ); + } if ( !is_null( $oldid ) ) { // Don't use the parser cache - $rev = Revision::newFromID( $oldid ); + $rev = Revision::newFromId( $oldid ); if ( !$rev ) { - $this->dieUsage( "There is no revision ID $oldid", 'missingrev' ); + $this->dieWithError( [ 'apierror-nosuchrevid', $oldid ] ); } - if ( !$rev->userCan( Revision::DELETED_TEXT ) ) { - $this->dieUsage( "You don't have permission to view deleted revisions", 'permissiondenied' ); + + $this->checkTitleUserPermissions( $rev->getTitle(), 'read' ); + if ( !$rev->userCan( Revision::DELETED_TEXT, $this->getUser() ) ) { + $this->dieWithError( + [ 'apierror-permissiondenied', $this->msg( 'action-deletedtext' ) ] + ); } $titleObj = $rev->getTitle(); - $wgTitle = $titleObj; - - //If for some reason the "oldid" is actually the current revision, it may be cached - if ( $titleObj->getLatestRevID() === $oldid ) { - $articleObj = new Article( $titleObj, 0 ); - - $p_result = $this->getParsedSectionOrText( $articleObj, $titleObj, $popts, $pageid, - isset( $prop['wikitext'] ) ) ; - - } else { // This is an old revision, so get the text differently - $this->text = $rev->getText( Revision::FOR_THIS_USER ); - - $wgTitle = $titleObj; - - if ( $this->section !== false ) { - $this->text = $this->getSectionText( $this->text, 'r' . $rev->getId() ); + $pageObj = WikiPage::factory( $titleObj ); + list( $popts, $reset, $suppressCache ) = $this->makeParserOptions( $pageObj, $params ); + $p_result = $this->getParsedContent( + $pageObj, $popts, $suppressCache, $pageid, $rev, $needContent + ); + } else { // Not $oldid, but $pageid or $page + if ( $params['redirects'] ) { + $reqParams = [ + 'redirects' => '', + ]; + if ( !is_null( $pageid ) ) { + $reqParams['pageids'] = $pageid; + } else { // $page + $reqParams['titles'] = $page; } - - $p_result = $wgParser->parse( $this->text, $titleObj, $popts ); - } - - } else { // Not $oldid - - if ( !is_null ( $pageid ) ) { - $titleObj = Title::newFromID( $pageid ); - - if ( !$titleObj ) { - $this->dieUsageMsg( array( 'nosuchpageid', $pageid ) ); + $req = new FauxRequest( $reqParams ); + $main = new ApiMain( $req ); + $pageSet = new ApiPageSet( $main ); + $pageSet->execute(); + $redirValues = $pageSet->getRedirectTitlesAsResult( $this->getResult() ); + + $to = $page; + foreach ( $pageSet->getRedirectTitles() as $title ) { + $to = $title->getFullText(); } + $pageParams = [ 'title' => $to ]; + } elseif ( !is_null( $pageid ) ) { + $pageParams = [ 'pageid' => $pageid ]; } else { // $page + $pageParams = [ 'title' => $page ]; + } - if ( $params['redirects'] ) { - $req = new FauxRequest( array( - 'action' => 'query', - 'redirects' => '', - 'titles' => $page - ) ); - $main = new ApiMain( $req ); - $main->execute(); - $data = $main->getResultData(); - $redirValues = @$data['query']['redirects']; - $to = $page; - foreach ( (array)$redirValues as $r ) { - $to = $r['to']; - } - } else { - $to = $page; - } - $titleObj = Title::newFromText( $to ); - if ( !$titleObj || !$titleObj->exists() ) { - $this->dieUsage( "The page you specified doesn't exist", 'missingtitle' ); - } + $pageObj = $this->getTitleOrPageId( $pageParams, 'fromdb' ); + $titleObj = $pageObj->getTitle(); + if ( !$titleObj || !$titleObj->exists() ) { + $this->dieWithError( 'apierror-missingtitle' ); } + + $this->checkTitleUserPermissions( $titleObj, 'read' ); $wgTitle = $titleObj; - $articleObj = new Article( $titleObj, 0 ); if ( isset( $prop['revid'] ) ) { - $oldid = $articleObj->getRevIdFetched(); + $oldid = $pageObj->getLatest(); } - $p_result = $this->getParsedSectionOrText( $articleObj, $titleObj, $popts, $pageid, - isset( $prop['wikitext'] ) ) ; + list( $popts, $reset, $suppressCache ) = $this->makeParserOptions( $pageObj, $params ); + $p_result = $this->getParsedContent( + $pageObj, $popts, $suppressCache, $pageid, null, $needContent + ); } - } else { // Not $oldid, $pageid, $page. Hence based on $text - - $this->text = $text; $titleObj = Title::newFromText( $title ); - if ( !$titleObj ) { - $titleObj = Title::newFromText( 'API' ); + if ( !$titleObj || $titleObj->isExternal() ) { + $this->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $title ) ] ); + } + $revid = $params['revid']; + if ( $revid !== null ) { + $rev = Revision::newFromId( $revid ); + if ( !$rev ) { + $this->dieWithError( [ 'apierror-nosuchrevid', $revid ] ); + } + $pTitleObj = $titleObj; + $titleObj = $rev->getTitle(); + if ( $titleProvided ) { + if ( !$titleObj->equals( $pTitleObj ) ) { + $this->addWarning( [ 'apierror-revwrongpage', $rev->getId(), + wfEscapeWikiText( $pTitleObj->getPrefixedText() ) ] ); + } + } else { + // Consider the title derived from the revid as having + // been provided. + $titleProvided = true; + } } $wgTitle = $titleObj; + if ( $titleObj->canExist() ) { + $pageObj = WikiPage::factory( $titleObj ); + } else { + // Do like MediaWiki::initializeArticle() + $article = Article::newFromTitle( $titleObj, $this->getContext() ); + $pageObj = $article->getPage(); + } + + list( $popts, $reset ) = $this->makeParserOptions( $pageObj, $params ); + $textProvided = !is_null( $text ); + + if ( !$textProvided ) { + if ( $titleProvided && ( $prop || $params['generatexml'] ) ) { + if ( $revid !== null ) { + $this->addWarning( 'apiwarn-parse-revidwithouttext' ); + } else { + $this->addWarning( 'apiwarn-parse-titlewithouttext' ); + } + } + // Prevent warning from ContentHandler::makeContent() + $text = ''; + } + + // If we are parsing text, do not use the content model of the default + // API title, but default to wikitext to keep BC. + if ( $textProvided && !$titleProvided && is_null( $model ) ) { + $model = CONTENT_MODEL_WIKITEXT; + $this->addWarning( [ 'apiwarn-parse-nocontentmodel', $model ] ); + } + + try { + $this->content = ContentHandler::makeContent( $text, $titleObj, $model, $format ); + } catch ( MWContentSerializationException $ex ) { + $this->dieWithException( $ex, [ + 'wrap' => ApiMessage::create( 'apierror-contentserializationexception', 'parseerror' ) + ] ); + } if ( $this->section !== false ) { - $this->text = $this->getSectionText( $this->text, $titleObj->getText() ); + if ( $this->section === 'new' ) { + // Insert the section title above the content. + if ( !is_null( $params['sectiontitle'] ) && $params['sectiontitle'] !== '' ) { + $this->content = $this->content->addSectionHeader( $params['sectiontitle'] ); + } + } else { + $this->content = $this->getSectionContent( $this->content, $titleObj->getPrefixedText() ); + } } if ( $params['pst'] || $params['onlypst'] ) { - $this->pstText = $wgParser->preSaveTransform( $this->text, $titleObj, $wgUser, $popts ); + $this->pstContent = $this->content->preSaveTransform( $titleObj, $this->getUser(), $popts ); } if ( $params['onlypst'] ) { // Build a result and bail out - $result_array['text'] = array(); - $this->getResult()->setContent( $result_array['text'], $this->pstText ); + $result_array = []; + if ( $this->contentIsDeleted ) { + $result_array['textdeleted'] = true; + } + if ( $this->contentIsSuppressed ) { + $result_array['textsuppressed'] = true; + } + $result_array['text'] = $this->pstContent->serialize( $format ); + $result_array[ApiResult::META_BC_SUBELEMENTS][] = 'text'; if ( isset( $prop['wikitext'] ) ) { - $result_array['wikitext'] = array(); - $this->getResult()->setContent( $result_array['wikitext'], $this->text ); + $result_array['wikitext'] = $this->content->serialize( $format ); + $result_array[ApiResult::META_BC_SUBELEMENTS][] = 'wikitext'; + } + if ( !is_null( $params['summary'] ) || + ( !is_null( $params['sectiontitle'] ) && $this->section === 'new' ) + ) { + $result_array['parsedsummary'] = $this->formatSummary( $titleObj, $params ); + $result_array[ApiResult::META_BC_SUBELEMENTS][] = 'parsedsummary'; } - $this->getResult()->addValue( null, $this->getModuleName(), $result_array ); + + $result->addValue( null, $this->getModuleName(), $result_array ); + return; } - $p_result = $wgParser->parse( $params['pst'] ? $this->pstText : $this->text, $titleObj, $popts ); + + // Not cached (save or load) + if ( $params['pst'] ) { + $p_result = $this->pstContent->getParserOutput( $titleObj, $revid, $popts ); + } else { + $p_result = $this->content->getParserOutput( $titleObj, $revid, $popts ); + } + } + + $result_array = []; + + $result_array['title'] = $titleObj->getPrefixedText(); + $result_array['pageid'] = $pageid ?: $pageObj->getId(); + if ( $this->contentIsDeleted ) { + $result_array['textdeleted'] = true; + } + if ( $this->contentIsSuppressed ) { + $result_array['textsuppressed'] = true; + } + + if ( $params['disabletoc'] ) { + $p_result->setTOCEnabled( false ); + } + + if ( isset( $params['useskin'] ) ) { + $factory = MediaWikiServices::getInstance()->getSkinFactory(); + $skin = $factory->makeSkin( Skin::normalizeKey( $params['useskin'] ) ); + } else { + $skin = null; + } + + $outputPage = null; + if ( $skin || isset( $prop['headhtml'] ) || isset( $prop['categorieshtml'] ) ) { + // Enabling the skin via 'useskin', 'headhtml', or 'categorieshtml' + // gets OutputPage and Skin involved, which (among others) applies + // these hooks: + // - ParserOutputHooks + // - Hook: LanguageLinks + // - Hook: OutputPageParserOutput + // - Hook: OutputPageMakeCategoryLinks + $context = new DerivativeContext( $this->getContext() ); + $context->setTitle( $titleObj ); + $context->setWikiPage( $pageObj ); + + if ( $skin ) { + // Use the skin specified by 'useskin' + $context->setSkin( $skin ); + // Context clones the skin, refetch to stay in sync. (T166022) + $skin = $context->getSkin(); + } else { + // Make sure the context's skin refers to the context. Without this, + // $outputPage->getSkin()->getOutput() !== $outputPage which + // confuses some of the output. + $context->setSkin( $context->getSkin() ); + } + + $outputPage = new OutputPage( $context ); + $outputPage->addParserOutputMetadata( $p_result ); + $context->setOutput( $outputPage ); + + if ( $skin ) { + // Based on OutputPage::output() + foreach ( $skin->getDefaultModules() as $group ) { + $outputPage->addModules( $group ); + } + } + } + + if ( !is_null( $oldid ) ) { + $result_array['revid'] = intval( $oldid ); } - // Return result - $result = $this->getResult(); - $result_array = array(); if ( $params['redirects'] && !is_null( $redirValues ) ) { $result_array['redirects'] = $redirValues; } if ( isset( $prop['text'] ) ) { - $result_array['text'] = array(); - $result->setContent( $result_array['text'], $p_result->getText() ); + $result_array['text'] = $p_result->getText(); + $result_array[ApiResult::META_BC_SUBELEMENTS][] = 'text'; } - if ( !is_null( $params['summary'] ) ) { - $result_array['parsedsummary'] = array(); - $result->setContent( $result_array['parsedsummary'], $wgUser->getSkin()->formatComment( $params['summary'], $titleObj ) ); + if ( !is_null( $params['summary'] ) || + ( !is_null( $params['sectiontitle'] ) && $this->section === 'new' ) + ) { + $result_array['parsedsummary'] = $this->formatSummary( $titleObj, $params ); + $result_array[ApiResult::META_BC_SUBELEMENTS][] = 'parsedsummary'; } if ( isset( $prop['langlinks'] ) ) { - $result_array['langlinks'] = $this->formatLangLinks( $p_result->getLanguageLinks() ); - } - if ( isset( $prop['languageshtml'] ) ) { - $languagesHtml = $this->languagesHtml( $p_result->getLanguageLinks() ); - $result_array['languageshtml'] = array(); - $result->setContent( $result_array['languageshtml'], $languagesHtml ); + if ( $skin ) { + $langlinks = $outputPage->getLanguageLinks(); + } else { + $langlinks = $p_result->getLanguageLinks(); + // The deprecated 'effectivelanglinks' option depredates OutputPage + // support via 'useskin'. If not already applied, then run just this + // one hook of OutputPage::addParserOutputMetadata here. + if ( $params['effectivelanglinks'] ) { + $linkFlags = []; + Hooks::run( 'LanguageLinks', [ $titleObj, &$langlinks, &$linkFlags ] ); + } + } + + $result_array['langlinks'] = $this->formatLangLinks( $langlinks ); } if ( isset( $prop['categories'] ) ) { $result_array['categories'] = $this->formatCategoryLinks( $p_result->getCategories() ); } if ( isset( $prop['categorieshtml'] ) ) { - $categoriesHtml = $this->categoriesHtml( $p_result->getCategories() ); - $result_array['categorieshtml'] = array(); - $result->setContent( $result_array['categorieshtml'], $categoriesHtml ); + $result_array['categorieshtml'] = $outputPage->getSkin()->getCategories(); + $result_array[ApiResult::META_BC_SUBELEMENTS][] = 'categorieshtml'; } if ( isset( $prop['links'] ) ) { $result_array['links'] = $this->formatLinks( $p_result->getLinks() ); @@ -236,53 +394,112 @@ class ApiParse extends ApiBase { if ( isset( $prop['sections'] ) ) { $result_array['sections'] = $p_result->getSections(); } + if ( isset( $prop['parsewarnings'] ) ) { + $result_array['parsewarnings'] = $p_result->getWarnings(); + } if ( isset( $prop['displaytitle'] ) ) { - $result_array['displaytitle'] = $p_result->getDisplayTitle() ? - $p_result->getDisplayTitle() : - $titleObj->getPrefixedText(); + $result_array['displaytitle'] = $p_result->getDisplayTitle() ?: + $titleObj->getPrefixedText(); } - if ( isset( $prop['headitems'] ) || isset( $prop['headhtml'] ) ) { - $out = new OutputPage; - $out->addParserOutputNoText( $p_result ); - $userSkin = $wgUser->getSkin(); + if ( isset( $prop['headitems'] ) ) { + if ( $skin ) { + $result_array['headitems'] = $this->formatHeadItems( $outputPage->getHeadItemsArray() ); + } else { + $result_array['headitems'] = $this->formatHeadItems( $p_result->getHeadItems() ); + } } - if ( isset( $prop['headitems'] ) ) { - $headItems = $this->formatHeadItems( $p_result->getHeadItems() ); + if ( isset( $prop['headhtml'] ) ) { + $result_array['headhtml'] = $outputPage->headElement( $context->getSkin() ); + $result_array[ApiResult::META_BC_SUBELEMENTS][] = 'headhtml'; + } + + if ( isset( $prop['modules'] ) ) { + if ( $skin ) { + $result_array['modules'] = $outputPage->getModules(); + $result_array['modulescripts'] = $outputPage->getModuleScripts(); + $result_array['modulestyles'] = $outputPage->getModuleStyles(); + } else { + $result_array['modules'] = array_values( array_unique( $p_result->getModules() ) ); + $result_array['modulescripts'] = array_values( array_unique( $p_result->getModuleScripts() ) ); + $result_array['modulestyles'] = array_values( array_unique( $p_result->getModuleStyles() ) ); + } + } - $userSkin->setupUserCss( $out ); - $css = $this->formatCss( $out->buildCssLinksArray() ); + if ( isset( $prop['jsconfigvars'] ) ) { + $jsconfigvars = $skin ? $outputPage->getJsConfigVars() : $p_result->getJsConfigVars(); + $result_array['jsconfigvars'] = ApiResult::addMetadataToResultVars( $jsconfigvars ); + } - $scripts = array( $out->getHeadScripts( $userSkin ) ); + if ( isset( $prop['encodedjsconfigvars'] ) ) { + $jsconfigvars = $skin ? $outputPage->getJsConfigVars() : $p_result->getJsConfigVars(); + $result_array['encodedjsconfigvars'] = FormatJson::encode( + $jsconfigvars, + false, + FormatJson::ALL_OK + ); + $result_array[ApiResult::META_SUBELEMENTS][] = 'encodedjsconfigvars'; + } - $result_array['headitems'] = array_merge( $headItems, $css, $scripts ); + if ( isset( $prop['modules'] ) && + !isset( $prop['jsconfigvars'] ) && !isset( $prop['encodedjsconfigvars'] ) ) { + $this->addWarning( 'apiwarn-moduleswithoutvars' ); } - if ( isset( $prop['headhtml'] ) ) { - $result_array['headhtml'] = array(); - $result->setContent( $result_array['headhtml'], $out->headElement( $userSkin ) ); + if ( isset( $prop['indicators'] ) ) { + if ( $skin ) { + $result_array['indicators'] = (array)$outputPage->getIndicators(); + } else { + $result_array['indicators'] = (array)$p_result->getIndicators(); + } + ApiResult::setArrayType( $result_array['indicators'], 'BCkvp', 'name' ); } if ( isset( $prop['iwlinks'] ) ) { $result_array['iwlinks'] = $this->formatIWLinks( $p_result->getInterwikiLinks() ); } - + if ( isset( $prop['wikitext'] ) ) { - $result_array['wikitext'] = array(); - $result->setContent( $result_array['wikitext'], $this->text ); - if ( !is_null( $this->pstText ) ) { - $result_array['psttext'] = array(); - $result->setContent( $result_array['psttext'], $this->pstText ); + $result_array['wikitext'] = $this->content->serialize( $format ); + $result_array[ApiResult::META_BC_SUBELEMENTS][] = 'wikitext'; + if ( !is_null( $this->pstContent ) ) { + $result_array['psttext'] = $this->pstContent->serialize( $format ); + $result_array[ApiResult::META_BC_SUBELEMENTS][] = 'psttext'; } } + if ( isset( $prop['properties'] ) ) { + $result_array['properties'] = (array)$p_result->getProperties(); + ApiResult::setArrayType( $result_array['properties'], 'BCkvp', 'name' ); + } - if ( !is_null( $oldid ) ) { - $result_array['revid'] = intval( $oldid ); + if ( isset( $prop['limitreportdata'] ) ) { + $result_array['limitreportdata'] = + $this->formatLimitReportData( $p_result->getLimitReportData() ); } + if ( isset( $prop['limitreporthtml'] ) ) { + $result_array['limitreporthtml'] = EditPage::getPreviewLimitReport( $p_result ); + $result_array[ApiResult::META_BC_SUBELEMENTS][] = 'limitreporthtml'; + } + + if ( isset( $prop['parsetree'] ) || $params['generatexml'] ) { + if ( $this->content->getModel() != CONTENT_MODEL_WIKITEXT ) { + $this->dieWithError( 'apierror-parsetree-notwikitext', 'notwikitext' ); + } - $result_mapping = array( + $wgParser->startExternalParse( $titleObj, $popts, Parser::OT_PREPROCESS ); + $dom = $wgParser->preprocessToDom( $this->content->getNativeData() ); + if ( is_callable( [ $dom, 'saveXML' ] ) ) { + $xml = $dom->saveXML(); + } else { + $xml = $dom->__toString(); + } + $result_array['parsetree'] = $xml; + $result_array[ApiResult::META_BC_SUBELEMENTS][] = 'parsetree'; + } + + $result_mapping = [ 'redirects' => 'r', 'langlinks' => 'll', 'categories' => 'cl', @@ -293,178 +510,325 @@ class ApiParse extends ApiBase { 'iwlinks' => 'iw', 'sections' => 's', 'headitems' => 'hi', - ); + 'modules' => 'm', + 'indicators' => 'ind', + 'modulescripts' => 'm', + 'modulestyles' => 'm', + 'properties' => 'pp', + 'limitreportdata' => 'lr', + 'parsewarnings' => 'pw' + ]; $this->setIndexedTagNames( $result_array, $result_mapping ); $result->addValue( null, $this->getModuleName(), $result_array ); + } - if ( !is_null( $oldLang ) ) { - $wgLang = $oldLang; // Reset $wgLang to $oldLang - } + /** + * Constructs a ParserOptions object + * + * @param WikiPage $pageObj + * @param array $params + * + * @return array [ ParserOptions, ScopedCallback, bool $suppressCache ] + */ + protected function makeParserOptions( WikiPage $pageObj, array $params ) { + $popts = $pageObj->makeParserOptions( $this->getContext() ); + $popts->enableLimitReport( !$params['disablepp'] && !$params['disablelimitreport'] ); + $popts->setIsPreview( $params['preview'] || $params['sectionpreview'] ); + $popts->setIsSectionPreview( $params['sectionpreview'] ); + $popts->setEditSection( !$params['disableeditsection'] ); + if ( $params['disabletidy'] ) { + $popts->setTidy( false ); + } + $popts->setWrapOutputClass( + $params['wrapoutputclass'] === '' ? false : $params['wrapoutputclass'] + ); + + $reset = null; + $suppressCache = false; + Hooks::run( 'ApiMakeParserOptions', + [ $popts, $pageObj->getTitle(), $params, $this, &$reset, &$suppressCache ] ); + + // Force cache suppression when $popts aren't cacheable. + $suppressCache = $suppressCache || !$popts->isSafeToCache(); + + return [ $popts, $reset, $suppressCache ]; } /** - * @param $articleObj Article - * @param $titleObj Title - * @param $popts ParserOptions - * @param $pageId Int - * @param $getWikitext Bool + * @param WikiPage $page + * @param ParserOptions $popts + * @param bool $suppressCache + * @param int $pageId + * @param Revision|null $rev + * @param bool $getContent * @return ParserOutput */ - private function getParsedSectionOrText( $articleObj, $titleObj, $popts, $pageId = null, $getWikitext = false ) { - if ( $this->section !== false ) { - global $wgParser; + private function getParsedContent( + WikiPage $page, $popts, $suppressCache, $pageId, $rev, $getContent + ) { + $revId = $rev ? $rev->getId() : null; + $isDeleted = $rev && $rev->isDeleted( Revision::DELETED_TEXT ); + + if ( $getContent || $this->section !== false || $isDeleted ) { + if ( $rev ) { + $this->content = $rev->getContent( Revision::FOR_THIS_USER, $this->getUser() ); + if ( !$this->content ) { + $this->dieWithError( [ 'apierror-missingcontent-revid', $revId ] ); + } + } else { + $this->content = $page->getContent( Revision::FOR_THIS_USER, $this->getUser() ); + if ( !$this->content ) { + $this->dieWithError( [ 'apierror-missingcontent-pageid', $pageId ] ); + } + } + $this->contentIsDeleted = $isDeleted; + $this->contentIsSuppressed = $rev && + $rev->isDeleted( Revision::DELETED_TEXT | Revision::DELETED_RESTRICTED ); + } - $this->text = $this->getSectionText( $articleObj->getRawText(), !is_null ( $pageId ) - ? 'page id ' . $pageId : $titleObj->getText() ); + if ( $this->section !== false ) { + $this->content = $this->getSectionContent( + $this->content, + $pageId === null ? $page->getTitle()->getPrefixedText() : $this->msg( 'pageid', $pageId ) + ); + return $this->content->getParserOutput( $page->getTitle(), $revId, $popts ); + } - return $wgParser->parse( $this->text, $titleObj, $popts ); + if ( $isDeleted ) { + // getParserOutput can't do revdeled revisions + $pout = $this->content->getParserOutput( $page->getTitle(), $revId, $popts ); } else { - // Try the parser cache first - $pout = $articleObj->getParserOutput(); - if ( $getWikitext ) { - $rev = Revision::newFromTitle( $titleObj ); - if ( $rev ) { - $this->text = $rev->getText(); - } - } - return $pout; + // getParserOutput will save to Parser cache if able + $pout = $page->getParserOutput( $popts, $revId, $suppressCache ); + } + if ( !$pout ) { + $this->dieWithError( [ 'apierror-nosuchrevid', $revId ?: $page->getLatest() ] ); + } + + return $pout; + } + + /** + * Extract the requested section from the given Content + * + * @param Content $content + * @param string|Message $what Identifies the content in error messages, e.g. page title. + * @return Content + */ + private function getSectionContent( Content $content, $what ) { + // Not cached (save or load) + $section = $content->getSection( $this->section ); + if ( $section === false ) { + $this->dieWithError( [ 'apierror-nosuchsection-what', $this->section, $what ], 'nosuchsection' ); + } + if ( $section === null ) { + $this->dieWithError( [ 'apierror-sectionsnotsupported-what', $what ], 'nosuchsection' ); + $section = false; } + + return $section; } - private function getSectionText( $text, $what ) { + /** + * This mimicks the behavior of EditPage in formatting a summary + * + * @param Title $title of the page being parsed + * @param Array $params the API parameters of the request + * @return Content|bool + */ + private function formatSummary( $title, $params ) { global $wgParser; - $text = $wgParser->getSection( $text, $this->section, false ); - if ( $text === false ) { - $this->dieUsage( "There is no section {$this->section} in " . $what, 'nosuchsection' ); + $summary = !is_null( $params['summary'] ) ? $params['summary'] : ''; + $sectionTitle = !is_null( $params['sectiontitle'] ) ? $params['sectiontitle'] : ''; + + if ( $this->section === 'new' && ( $sectionTitle === '' || $summary === '' ) ) { + if ( $sectionTitle !== '' ) { + $summary = $params['sectiontitle']; + } + if ( $summary !== '' ) { + $summary = wfMessage( 'newsectionsummary' ) + ->rawParams( $wgParser->stripSectionName( $summary ) ) + ->inContentLanguage()->text(); + } } - return $text; + return Linker::formatComment( $summary, $title, $this->section === 'new' ); } private function formatLangLinks( $links ) { - $result = array(); + $result = []; foreach ( $links as $link ) { - $entry = array(); + $entry = []; $bits = explode( ':', $link, 2 ); $title = Title::newFromText( $link ); - + $entry['lang'] = $bits[0]; if ( $title ) { - $entry['url'] = $title->getFullURL(); + $entry['url'] = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT ); + // localised language name in 'uselang' language + $entry['langname'] = Language::fetchLanguageName( + $title->getInterwiki(), + $this->getLanguage()->getCode() + ); + + // native language name + $entry['autonym'] = Language::fetchLanguageName( $title->getInterwiki() ); } - $this->getResult()->setContent( $entry, $bits[1] ); + ApiResult::setContentValue( $entry, 'title', $bits[1] ); $result[] = $entry; } + return $result; } private function formatCategoryLinks( $links ) { - $result = array(); + $result = []; + + if ( !$links ) { + return $result; + } + + // Fetch hiddencat property + $lb = new LinkBatch; + $lb->setArray( [ NS_CATEGORY => $links ] ); + $db = $this->getDB(); + $res = $db->select( [ 'page', 'page_props' ], + [ 'page_title', 'pp_propname' ], + $lb->constructSet( 'page', $db ), + __METHOD__, + [], + [ 'page_props' => [ + 'LEFT JOIN', [ 'pp_propname' => 'hiddencat', 'pp_page = page_id' ] + ] ] + ); + $hiddencats = []; + foreach ( $res as $row ) { + $hiddencats[$row->page_title] = isset( $row->pp_propname ); + } + + $linkCache = LinkCache::singleton(); + foreach ( $links as $link => $sortkey ) { - $entry = array(); + $entry = []; $entry['sortkey'] = $sortkey; - $this->getResult()->setContent( $entry, $link ); + // array keys will cast numeric category names to ints, so cast back to string + ApiResult::setContentValue( $entry, 'category', (string)$link ); + if ( !isset( $hiddencats[$link] ) ) { + $entry['missing'] = true; + + // We already know the link doesn't exist in the database, so + // tell LinkCache that before calling $title->isKnown(). + $title = Title::makeTitle( NS_CATEGORY, $link ); + $linkCache->addBadLinkObj( $title ); + if ( $title->isKnown() ) { + $entry['known'] = true; + } + } elseif ( $hiddencats[$link] ) { + $entry['hidden'] = true; + } $result[] = $entry; } - return $result; - } - private function categoriesHtml( $categories ) { - global $wgOut, $wgUser; - $wgOut->addCategoryLinks( $categories ); - $sk = $wgUser->getSkin(); - return $sk->getCategories(); - } - - private function languagesHtml( $languages ) { - global $wgOut, $wgUser; - $wgOut->setLanguageLinks( $languages ); - $sk = $wgUser->getSkin(); - return $sk->otherLanguages(); + return $result; } private function formatLinks( $links ) { - $result = array(); + $result = []; foreach ( $links as $ns => $nslinks ) { foreach ( $nslinks as $title => $id ) { - $entry = array(); + $entry = []; $entry['ns'] = $ns; - $this->getResult()->setContent( $entry, Title::makeTitle( $ns, $title )->getFullText() ); - if ( $id != 0 ) { - $entry['exists'] = ''; - } + ApiResult::setContentValue( $entry, 'title', Title::makeTitle( $ns, $title )->getFullText() ); + $entry['exists'] = $id != 0; $result[] = $entry; } } + return $result; } private function formatIWLinks( $iw ) { - $result = array(); + $result = []; foreach ( $iw as $prefix => $titles ) { foreach ( array_keys( $titles ) as $title ) { - $entry = array(); + $entry = []; $entry['prefix'] = $prefix; $title = Title::newFromText( "{$prefix}:{$title}" ); if ( $title ) { - $entry['url'] = $title->getFullURL(); + $entry['url'] = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT ); } - $this->getResult()->setContent( $entry, $title->getFullText() ); + ApiResult::setContentValue( $entry, 'title', $title->getFullText() ); $result[] = $entry; } } + return $result; } private function formatHeadItems( $headItems ) { - $result = array(); + $result = []; foreach ( $headItems as $tag => $content ) { - $entry = array(); + $entry = []; $entry['tag'] = $tag; - $this->getResult()->setContent( $entry, $content ); + ApiResult::setContentValue( $entry, 'content', $content ); $result[] = $entry; } + return $result; } - private function formatCss( $css ) { - $result = array(); - foreach ( $css as $file => $link ) { - $entry = array(); - $entry['file'] = $file; - $this->getResult()->setContent( $entry, $link ); + private function formatLimitReportData( $limitReportData ) { + $result = []; + + foreach ( $limitReportData as $name => $value ) { + $entry = []; + $entry['name'] = $name; + if ( !is_array( $value ) ) { + $value = [ $value ]; + } + ApiResult::setIndexedTagNameRecursive( $value, 'param' ); + $entry = array_merge( $entry, $value ); $result[] = $entry; } + return $result; } private function setIndexedTagNames( &$array, $mapping ) { foreach ( $mapping as $key => $name ) { if ( isset( $array[$key] ) ) { - $this->getResult()->setIndexedTagName( $array[$key], $name ); + ApiResult::setIndexedTagName( $array[$key], $name ); } } } public function getAllowedParams() { - return array( - 'title' => array( - ApiBase::PARAM_DFLT => 'API', - ), - 'text' => null, + return [ + 'title' => null, + 'text' => [ + ApiBase::PARAM_TYPE => 'text', + ], + 'revid' => [ + ApiBase::PARAM_TYPE => 'integer', + ], 'summary' => null, 'page' => null, - 'pageid' => null, + 'pageid' => [ + ApiBase::PARAM_TYPE => 'integer', + ], 'redirects' => false, - 'oldid' => null, - 'prop' => array( - ApiBase::PARAM_DFLT => 'text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle', + 'oldid' => [ + ApiBase::PARAM_TYPE => 'integer', + ], + 'prop' => [ + ApiBase::PARAM_DFLT => 'text|langlinks|categories|links|templates|' . + 'images|externallinks|sections|revid|displaytitle|iwlinks|' . + 'properties|parsewarnings', ApiBase::PARAM_ISMULTI => true, - ApiBase::PARAM_TYPE => array( + ApiBase::PARAM_TYPE => [ 'text', 'langlinks', - 'languageshtml', 'categories', 'categorieshtml', 'links', @@ -474,85 +838,81 @@ class ApiParse extends ApiBase { 'sections', 'revid', 'displaytitle', - 'headitems', 'headhtml', + 'modules', + 'jsconfigvars', + 'encodedjsconfigvars', + 'indicators', 'iwlinks', 'wikitext', - ) - ), + 'properties', + 'limitreportdata', + 'limitreporthtml', + 'parsetree', + 'parsewarnings', + 'headitems', + ], + ApiBase::PARAM_HELP_MSG_PER_VALUE => [ + 'parsetree' => [ 'apihelp-parse-paramvalue-prop-parsetree', CONTENT_MODEL_WIKITEXT ], + ], + ApiBase::PARAM_DEPRECATED_VALUES => [ + 'headitems' => 'apiwarn-deprecation-parse-headitems', + ], + ], + 'wrapoutputclass' => 'mw-parser-output', 'pst' => false, 'onlypst' => false, - 'uselang' => null, + 'effectivelanglinks' => [ + ApiBase::PARAM_DFLT => false, + ApiBase::PARAM_DEPRECATED => true, + ], 'section' => null, - 'disablepp' => false, - ); - } - - public function getParamDescription() { - $p = $this->getModulePrefix(); - return array( - 'text' => 'Wikitext to parse', - 'summary' => 'Summary to parse', - 'redirects' => "If the {$p}page parameter is set to a redirect, resolve it", - 'title' => 'Title of page the text belongs to', - 'page' => "Parse the content of this page. Cannot be used together with {$p}text and {$p}title", - 'pageid' => "Parse the content of this page. Overrides {$p}page", - 'oldid' => "Parse the content of this revision. Overrides {$p}page and {$p}pageid", - 'prop' => array( - 'Which pieces of information to get', - ' text - Gives the parsed text of the wikitext', - ' langlinks - Gives the langlinks the parsed wikitext', - ' categories - Gives the categories of the parsed wikitext', - ' categorieshtml - Gives the html version of the categories', - ' languageshtml - Gives the html version of the languagelinks', - ' links - Gives the internal links in the parsed wikitext', - ' templates - Gives the templates in the parsed wikitext', - ' images - Gives the images in the parsed wikitext', - ' externallinks - Gives the external links in the parsed wikitext', - ' sections - Gives the sections in the parsed wikitext', - ' revid - Adds the revision id of the parsed page', - ' displaytitle - Adds the title of the parsed wikitext', - ' headitems - Gives items to put in the of the page', - ' headhtml - Gives parsed of the page', - ' iwlinks - Gives interwiki links in the parsed wikitext', - ' wikitext - Gives the original wikitext that was parsed', - ), - 'pst' => array( - 'Do a pre-save transform on the input before parsing it', - 'Ignored if page, pageid or oldid is used' - ), - 'onlypst' => array( - 'Do a pre-save transform (PST) on the input, but don\'t parse it', - 'Returns the same wikitext, after a PST has been applied. Ignored if page, pageid or oldid is used' - ), - 'uselang' => 'Which language to parse the request in', - 'section' => 'Only retrieve the content of this section number', - 'disablepp' => 'Disable the PP Report from the parser output', - ); + 'sectiontitle' => [ + ApiBase::PARAM_TYPE => 'string', + ], + 'disablepp' => [ + ApiBase::PARAM_DFLT => false, + ApiBase::PARAM_DEPRECATED => true, + ], + 'disablelimitreport' => false, + 'disableeditsection' => false, + 'disabletidy' => false, + 'generatexml' => [ + ApiBase::PARAM_DFLT => false, + ApiBase::PARAM_HELP_MSG => [ + 'apihelp-parse-param-generatexml', CONTENT_MODEL_WIKITEXT + ], + ApiBase::PARAM_DEPRECATED => true, + ], + 'preview' => false, + 'sectionpreview' => false, + 'disabletoc' => false, + 'useskin' => [ + ApiBase::PARAM_TYPE => array_keys( Skin::getAllowedSkins() ), + ], + 'contentformat' => [ + ApiBase::PARAM_TYPE => ContentHandler::getAllContentFormats(), + ], + 'contentmodel' => [ + ApiBase::PARAM_TYPE => ContentHandler::getContentModels(), + ] + ]; } - public function getDescription() { - return 'This module parses wikitext and returns parser output'; - } - - public function getPossibleErrors() { - return array_merge( parent::getPossibleErrors(), array( - array( 'code' => 'params', 'info' => 'The page parameter cannot be used together with the text and title parameters' ), - array( 'code' => 'missingrev', 'info' => 'There is no revision ID oldid' ), - array( 'code' => 'permissiondenied', 'info' => 'You don\'t have permission to view deleted revisions' ), - array( 'code' => 'missingtitle', 'info' => 'The page you specified doesn\'t exist' ), - array( 'code' => 'nosuchsection', 'info' => 'There is no section sectionnumber in page' ), - array( 'nosuchpageid' ), - ) ); - } - - protected function getExamples() { - return array( - 'api.php?action=parse&text={{Project:Sandbox}}' - ); + protected function getExamplesMessages() { + return [ + 'action=parse&page=Project:Sandbox' + => 'apihelp-parse-example-page', + 'action=parse&text={{Project:Sandbox}}&contentmodel=wikitext' + => 'apihelp-parse-example-text', + 'action=parse&text={{PAGENAME}}&title=Test' + => 'apihelp-parse-example-texttitle', + 'action=parse&summary=Some+[[link]]&prop=' + => 'apihelp-parse-example-summary', + ]; } - public function getVersion() { - return __CLASS__ . ': $Id: ApiParse.php 89672 2011-06-07 18:45:20Z catrope $'; + public function getHelpUrls() { + return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Parsing_wikitext#parse'; } }