X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2Fapi%2FApiParse.php;h=b1e344c9137b958e048546a9730293700a2ce361;hb=2b78de3f023660acec4fa20c8123768722c87b72;hp=5c5ff566778f1f1b98baa14647ff210d4f839512;hpb=809ab03c48bb5bf5bccbaa876970f329e6e2ccaf;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/api/ApiParse.php b/includes/api/ApiParse.php index 5c5ff56677..b1e344c913 100644 --- a/includes/api/ApiParse.php +++ b/includes/api/ApiParse.php @@ -1,7 +1,5 @@ @gmail.com @@ -33,8 +31,7 @@ if ( !defined( 'MEDIAWIKI' ) ) { * @ingroup API */ class ApiParse extends ApiBase { - - private $section; + private $section, $text, $pstText = null; public function __construct( $main, $action ) { parent::__construct( $main, $action ); @@ -65,7 +62,8 @@ class ApiParse extends ApiBase { // 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, $wgLang; // Currently unnecessary, code to act as a safeguard against any change in current behaviour of uselang breaks $oldLang = null; @@ -80,8 +78,10 @@ class ApiParse extends ApiBase { $redirValues = null; - if ( !is_null( $oldid ) || !is_null( $pageid ) || !is_null( $page ) ) { + // Return result + $result = $this->getResult(); + if ( !is_null( $oldid ) || !is_null( $pageid ) || !is_null( $page ) ) { if ( !is_null( $oldid ) ) { // Don't use the parser cache $rev = Revision::newFromID( $oldid ); @@ -100,52 +100,61 @@ class ApiParse extends ApiBase { if ( $titleObj->getLatestRevID() === intval( $oldid ) ) { $articleObj = new Article( $titleObj, 0 ); - $p_result = $this->getParsedSectionOrText( $articleObj, $titleObj, $popts, $pageid ) ; - + // May get from/save to parser cache + $p_result = $this->getParsedSectionOrText( $articleObj, $titleObj, $popts, $pageid, + isset( $prop['wikitext'] ) ) ; } else { // This is an old revision, so get the text differently - $text = $rev->getText( Revision::FOR_THIS_USER ); + $this->text = $rev->getText( Revision::FOR_THIS_USER ); $wgTitle = $titleObj; if ( $this->section !== false ) { - $text = $this->getSectionText( $text, 'r' . $rev->getId() ); + $this->text = $this->getSectionText( $this->text, 'r' . $rev->getId() ); } - $p_result = $wgParser->parse( $text, $titleObj, $popts ); + // Should we save old revision parses to the parser cache? + $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 ) ); + } else { // Not $oldid, but $pageid or $page + if ( $params['redirects'] ) { + $reqParams = array( + 'action' => 'query', + 'redirects' => '', + ); + if ( !is_null ( $pageid ) ) { + $reqParams['pageids'] = $pageid; + } else { // $page + $reqParams['titles'] = $page; } - } else { // $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; + $req = new FauxRequest( $reqParams ); + $main = new ApiMain( $req ); + $main->execute(); + $data = $main->getResultData(); + $redirValues = isset( $data['query']['redirects'] ) + ? $data['query']['redirects'] + : array(); + $to = $page; + foreach ( (array)$redirValues as $r ) { + $to = $r['to']; } $titleObj = Title::newFromText( $to ); - if ( !$titleObj || !$titleObj->exists() ) { - $this->dieUsage( "The page you specified doesn't exist", 'missingtitle' ); + } else { + if ( !is_null ( $pageid ) ) { + $reqParams['pageids'] = $pageid; + $titleObj = Title::newFromID( $pageid ); + } else { // $page + $to = $page; + $titleObj = Title::newFromText( $to ); } } + if ( !is_null ( $pageid ) ) { + if ( !$titleObj ) { + // Still throw nosuchpageid error if pageid was provided + $this->dieUsageMsg( array( 'nosuchpageid', $pageid ) ); + } + } elseif ( !$titleObj || !$titleObj->exists() ) { + $this->dieUsage( "The page you specified doesn't exist", 'missingtitle' ); + } $wgTitle = $titleObj; $articleObj = new Article( $titleObj, 0 ); @@ -153,36 +162,42 @@ class ApiParse extends ApiBase { $oldid = $articleObj->getRevIdFetched(); } - $p_result = $this->getParsedSectionOrText( $articleObj, $titleObj, $popts, $pageid ) ; + // Potentially cached + $p_result = $this->getParsedSectionOrText( $articleObj, $titleObj, $popts, $pageid, + isset( $prop['wikitext'] ) ) ; } - } else { // Not $oldid, $pageid, $page. Hence based on $text + $this->text = $text; $titleObj = Title::newFromText( $title ); if ( !$titleObj ) { - $titleObj = Title::newFromText( 'API' ); + $this->dieUsageMsg( array( 'invalidtitle', $title ) ); } $wgTitle = $titleObj; if ( $this->section !== false ) { - $text = $this->getSectionText( $text, $titleObj->getText() ); + $this->text = $this->getSectionText( $this->text, $titleObj->getText() ); } if ( $params['pst'] || $params['onlypst'] ) { - $text = $wgParser->preSaveTransform( $text, $titleObj, $wgUser, $popts ); + $this->pstText = $wgParser->preSaveTransform( $this->text, $titleObj, $this->getUser(), $popts ); } if ( $params['onlypst'] ) { // Build a result and bail out + $result_array = array(); $result_array['text'] = array(); - $this->getResult()->setContent( $result_array['text'], $text ); - $this->getResult()->addValue( null, $this->getModuleName(), $result_array ); + $result->setContent( $result_array['text'], $this->pstText ); + if ( isset( $prop['wikitext'] ) ) { + $result_array['wikitext'] = array(); + $result->setContent( $result_array['wikitext'], $this->text ); + } + $result->addValue( null, $this->getModuleName(), $result_array ); return; } - $p_result = $wgParser->parse( $text, $titleObj, $popts ); + // Not cached (save or load) + $p_result = $wgParser->parse( $params['pst'] ? $this->pstText : $this->text, $titleObj, $popts ); } - // Return result - $result = $this->getResult(); $result_array = array(); $result_array['title'] = $titleObj->getPrefixedText(); @@ -202,7 +217,7 @@ class ApiParse extends ApiBase { if ( !is_null( $params['summary'] ) ) { $result_array['parsedsummary'] = array(); - $result->setContent( $result_array['parsedsummary'], $wgUser->getSkin()->formatComment( $params['summary'], $titleObj ) ); + $result->setContent( $result_array['parsedsummary'], Linker::formatComment( $params['summary'], $titleObj ) ); } if ( isset( $prop['langlinks'] ) ) { @@ -244,31 +259,39 @@ class ApiParse extends ApiBase { } if ( isset( $prop['headitems'] ) || isset( $prop['headhtml'] ) ) { - $out = new OutputPage; - $out->addParserOutputNoText( $p_result ); - $userSkin = $wgUser->getSkin(); - } + $context = $this->getContext(); + $context->setTitle( $titleObj ); + $context->getOutput()->addParserOutputNoText( $p_result ); - if ( isset( $prop['headitems'] ) ) { - $headItems = $this->formatHeadItems( $p_result->getHeadItems() ); + if ( isset( $prop['headitems'] ) ) { + $headItems = $this->formatHeadItems( $p_result->getHeadItems() ); - $userSkin->setupUserCss( $out ); - $css = $this->formatCss( $out->buildCssLinksArray() ); + $css = $this->formatCss( $context->getOutput()->buildCssLinksArray() ); - $scripts = array( $out->getHeadScripts( $userSkin ) ); + $scripts = array( $context->getOutput()->getHeadScripts() ); - $result_array['headitems'] = array_merge( $headItems, $css, $scripts ); - } + $result_array['headitems'] = array_merge( $headItems, $css, $scripts ); + } - if ( isset( $prop['headhtml'] ) ) { - $result_array['headhtml'] = array(); - $result->setContent( $result_array['headhtml'], $out->headElement( $userSkin ) ); + if ( isset( $prop['headhtml'] ) ) { + $result_array['headhtml'] = array(); + $result->setContent( $result_array['headhtml'], $context->getOutput()->headElement( $context->getSkin() ) ); + } } 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_mapping = array( 'redirects' => 'r', 'langlinks' => 'll', @@ -290,28 +313,39 @@ class ApiParse extends ApiBase { } /** - * @param $articleObj Article - * @param $titleObj Title - * @param $popts ParserOptions - * @param $pageId Int + * @param $articleObj Article + * @param $titleObj Title + * @param $popts ParserOptions + * @param $pageId Int + * @param $getWikitext Bool * @return ParserOutput */ - private function getParsedSectionOrText( $articleObj, $titleObj, $popts, $pageId = null ) { + private function getParsedSectionOrText( $articleObj, $titleObj, $popts, $pageId = null, $getWikitext = false ) { if ( $this->section !== false ) { global $wgParser; - $text = $this->getSectionText( $articleObj->getRawText(), !is_null ( $pageId ) + $this->text = $this->getSectionText( $articleObj->getRawText(), !is_null( $pageId ) ? 'page id ' . $pageId : $titleObj->getText() ); - return $wgParser->parse( $text, $titleObj, $popts ); + // Not cached (save or load) + return $wgParser->parse( $this->text, $titleObj, $popts ); } else { // Try the parser cache first - return $articleObj->getParserOutput(); + // getParserOutput will save to Parser cache if able + $pout = $articleObj->getParserOutput(); + if ( $getWikitext ) { + $rev = Revision::newFromTitle( $titleObj ); + if ( $rev ) { + $this->text = $rev->getText(); + } + } + return $pout; } } private function getSectionText( $text, $what ) { global $wgParser; + // Not cached (save or load) $text = $wgParser->getSection( $text, $this->section, false ); if ( $text === false ) { $this->dieUsage( "There is no section {$this->section} in " . $what, 'nosuchsection' ); @@ -325,10 +359,10 @@ class ApiParse extends ApiBase { $entry = array(); $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 ); } $this->getResult()->setContent( $entry, $bits[1] ); $result[] = $entry; @@ -348,17 +382,43 @@ class ApiParse extends ApiBase { } private function categoriesHtml( $categories ) { - global $wgOut, $wgUser; - $wgOut->addCategoryLinks( $categories ); - $sk = $wgUser->getSkin(); - return $sk->getCategories(); + $context = $this->getContext(); + $context->getOutput()->addCategoryLinks( $categories ); + return $context->getSkin()->getCategories(); } + /** + * @deprecated since 1.18 No modern skin generates language links this way, please use language links + * data to generate your own HTML. + * @param $languages array + * @return string + */ private function languagesHtml( $languages ) { - global $wgOut, $wgUser; - $wgOut->setLanguageLinks( $languages ); - $sk = $wgUser->getSkin(); - return $sk->otherLanguages(); + global $wgContLang, $wgHideInterlanguageLinks; + + if ( $wgHideInterlanguageLinks || count( $languages ) == 0 ) { + return ''; + } + + $s = htmlspecialchars( wfMsg( 'otherlanguages' ) . wfMsg( 'colon-separator' ) ); + + $langs = array(); + foreach ( $languages as $l ) { + $nt = Title::newFromText( $l ); + $text = $wgContLang->getLanguageName( $nt->getInterwiki() ); + + $langs[] = Html::element( 'a', + array( 'href' => $nt->getFullURL(), 'title' => $nt->getText(), 'class' => "external" ), + $text == '' ? $l : $text ); + } + + $s .= implode( htmlspecialchars( wfMsgExt( 'pipe-separator', 'escapenoentities' ) ), $langs ); + + if ( $wgContLang->isRTL() ) { + $s = Html::rawElement( 'span', array( 'dir' => "LTR" ), $s ); + } + + return $s; } private function formatLinks( $links ) { @@ -386,7 +446,7 @@ class ApiParse extends ApiBase { $title = Title::newFromText( "{$prefix}:{$title}" ); if ( $title ) { - $entry['url'] = $title->getFullURL(); + $entry['url'] = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT ); } $this->getResult()->setContent( $entry, $title->getFullText() ); @@ -434,9 +494,13 @@ class ApiParse extends ApiBase { 'text' => null, 'summary' => null, 'page' => null, - 'pageid' => null, + 'pageid' => array( + ApiBase::PARAM_TYPE => 'integer', + ), 'redirects' => false, - 'oldid' => null, + 'oldid' => array( + ApiBase::PARAM_TYPE => 'integer', + ), 'prop' => array( ApiBase::PARAM_DFLT => 'text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle', ApiBase::PARAM_ISMULTI => true, @@ -456,6 +520,7 @@ class ApiParse extends ApiBase { 'headitems', 'headhtml', 'iwlinks', + 'wikitext', ) ), 'pst' => false, @@ -471,7 +536,7 @@ class ApiParse extends ApiBase { return array( 'text' => 'Wikitext to parse', 'summary' => 'Summary to parse', - 'redirects' => "If the {$p}page parameter is set to a redirect, resolve it", + 'redirects' => "If the {$p}page or the {$p}pageid 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", @@ -493,7 +558,7 @@ class ApiParse extends ApiBase { ' headitems - Gives items to put in the of the page', ' headhtml - Gives parsed of the page', ' iwlinks - Gives interwiki links in the parsed wikitext', - 'NOTE: Section tree is only generated if there are more than 4 sections, or if the __TOC__ keyword is present' + ' wikitext - Gives the original wikitext that was parsed', ), 'pst' => array( 'Do a pre-save transform on the input before parsing it', @@ -510,7 +575,7 @@ class ApiParse extends ApiBase { } public function getDescription() { - return 'This module parses wikitext and returns parser output'; + return 'Parses wikitext and returns parser output'; } public function getPossibleErrors() { @@ -521,15 +586,20 @@ class ApiParse extends ApiBase { array( 'code' => 'missingtitle', 'info' => 'The page you specified doesn\'t exist' ), array( 'code' => 'nosuchsection', 'info' => 'There is no section sectionnumber in page' ), array( 'nosuchpageid' ), + array( 'invalidtitle', 'title' ), ) ); } - protected function getExamples() { + public function getExamples() { return array( 'api.php?action=parse&text={{Project:Sandbox}}' ); } + public function getHelpUrls() { + return 'http://www.mediawiki.org/wiki/API:Parsing_wikitext#parse'; + } + public function getVersion() { return __CLASS__ . ': $Id$'; }