ApiQueryInfo.php
No OneTemporary
Actions

Size

36 KB

Referenced Files

None

Subscribers

None

ApiQueryInfo.php
View Options

	<?php
	/**
	* Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@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
	* the Free Software Foundation; either version 2 of the License, or
	* (at your option) any later version.
	*
	* This program is distributed in the hope that it will be useful,
	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	* GNU General Public License for more details.
	*
	* You should have received a copy of the GNU General Public License along
	* with this program; if not, write to the Free Software Foundation, Inc.,
	* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
	* http://www.gnu.org/copyleft/gpl.html
	*
	* @file
	*/

	namespace MediaWiki\Api;

	use MediaWiki\Cache\LinkBatchFactory;
	use MediaWiki\EditPage\IntroMessageBuilder;
	use MediaWiki\EditPage\PreloadedContentBuilder;
	use MediaWiki\Language\ILanguageConverter;
	use MediaWiki\Language\Language;
	use MediaWiki\Languages\LanguageConverterFactory;
	use MediaWiki\Linker\LinksMigration;
	use MediaWiki\Linker\LinkTarget;
	use MediaWiki\MainConfigNames;
	use MediaWiki\Page\PageIdentity;
	use MediaWiki\Page\PageReference;
	use MediaWiki\ParamValidator\TypeDef\TitleDef;
	use MediaWiki\Permissions\PermissionStatus;
	use MediaWiki\Permissions\RestrictionStore;
	use MediaWiki\Revision\RevisionLookup;
	use MediaWiki\Title\NamespaceInfo;
	use MediaWiki\Title\Title;
	use MediaWiki\Title\TitleFactory;
	use MediaWiki\Title\TitleFormatter;
	use MediaWiki\Title\TitleValue;
	use MediaWiki\User\TempUser\TempUserCreator;
	use MediaWiki\User\UserFactory;
	use MediaWiki\Utils\UrlUtils;
	use MediaWiki\Watchlist\WatchedItem;
	use MediaWiki\Watchlist\WatchedItemStore;
	use MessageLocalizer;
	use Wikimedia\ParamValidator\ParamValidator;
	use Wikimedia\ParamValidator\TypeDef\EnumDef;

	/**
	* A query module to show basic page information.
	*
	* @ingroup API
	*/
	class ApiQueryInfo extends ApiQueryBase {

	private ILanguageConverter $languageConverter;
	private LinkBatchFactory $linkBatchFactory;
	private NamespaceInfo $namespaceInfo;
	private TitleFactory $titleFactory;
	private TitleFormatter $titleFormatter;
	private WatchedItemStore $watchedItemStore;
	private RestrictionStore $restrictionStore;
	private LinksMigration $linksMigration;
	private TempUserCreator $tempUserCreator;
	private UserFactory $userFactory;
	private IntroMessageBuilder $introMessageBuilder;
	private PreloadedContentBuilder $preloadedContentBuilder;
	private RevisionLookup $revisionLookup;
	private UrlUtils $urlUtils;

	private bool $fld_protection = false;
	private bool $fld_talkid = false;
	private bool $fld_subjectid = false;
	private bool $fld_url = false;
	private bool $fld_readable = false;
	private bool $fld_watched = false;
	private bool $fld_watchers = false;
	private bool $fld_visitingwatchers = false;
	private bool $fld_notificationtimestamp = false;
	private bool $fld_preload = false;
	private bool $fld_preloadcontent = false;
	private bool $fld_editintro = false;
	private bool $fld_displaytitle = false;
	private bool $fld_varianttitles = false;

	/**
	* @var bool Whether to include link class information for the
	* given page titles.
	*/
	private $fld_linkclasses = false;

	/**
	* @var bool Whether to include the name of the associated page
	*/
	private $fld_associatedpage = false;

	/** @var array */
	private $params;

	/** @var array<int,PageIdentity> */
	private $titles;
	/** @var array<int,PageIdentity> */
	private $missing;
	/** @var array<int,PageIdentity> */
	private $everything;

	/**
	* @var array<int,bool> [page_id] => page_is_redirect database field, guaranteed to be
	* initialized via execute()
	*/
	private $pageIsRedir;
	/**
	* @var array<int,bool> [page_id] => page_is_new database field, guaranteed to be
	* initialized via execute()
	*/
	private $pageIsNew;
	/**
	* @var array<int,int> [page_id] => page_touched database field, guaranteed to be
	* initialized via execute()
	*/
	private $pageTouched;
	/**
	* @var array<int,int> [page_id] => page_latest database field, guaranteed to be
	* initialized via execute()
	*/
	private $pageLatest;
	/**
	* @var array<int,int> [page_id] => page_len database field, guaranteed to be
	* initialized via execute()
	*/
	private $pageLength;

	/** @var array[][][] */
	private $protections;
	/** @var string[][][] */
	private $restrictionTypes;
	/** @var bool[][] */
	private $watched;
	/** @var int[][] */
	private $watchers;
	/** @var int[][] */
	private $visitingwatchers;
	/** @var string[][] */
	private $notificationtimestamps;
	/** @var int[][] */
	private $talkids;
	/** @var int[][] */
	private $subjectids;
	/** @var string[][] */
	private $displaytitles;
	/** @var string[][] */
	private $variantTitles;

	/**
	* Watchlist expiries that corresponds with the $watched property. Keyed by namespace and title.
	* @var array<int,array<string,string>>
	*/
	private $watchlistExpiries;

	/**
	* @var array<int,string[]> Mapping of page id to list of 'extra link
	* classes' for the given page
	*/
	private $linkClasses;

	/** @var bool */
	private $showZeroWatchers = false;

	/** @var int */
	private $countTestedActions = 0;

	public function __construct(
	ApiQuery $queryModule,
	string $moduleName,
	Language $contentLanguage,
	LinkBatchFactory $linkBatchFactory,
	NamespaceInfo $namespaceInfo,
	TitleFactory $titleFactory,
	TitleFormatter $titleFormatter,
	WatchedItemStore $watchedItemStore,
	LanguageConverterFactory $languageConverterFactory,
	RestrictionStore $restrictionStore,
	LinksMigration $linksMigration,
	TempUserCreator $tempUserCreator,
	UserFactory $userFactory,
	IntroMessageBuilder $introMessageBuilder,
	PreloadedContentBuilder $preloadedContentBuilder,
	RevisionLookup $revisionLookup,
	UrlUtils $urlUtils
	) {
	parent::__construct( $queryModule, $moduleName, 'in' );
	$this->languageConverter = $languageConverterFactory->getLanguageConverter( $contentLanguage );
	$this->linkBatchFactory = $linkBatchFactory;
	$this->namespaceInfo = $namespaceInfo;
	$this->titleFactory = $titleFactory;
	$this->titleFormatter = $titleFormatter;
	$this->watchedItemStore = $watchedItemStore;
	$this->restrictionStore = $restrictionStore;
	$this->linksMigration = $linksMigration;
	$this->tempUserCreator = $tempUserCreator;
	$this->userFactory = $userFactory;
	$this->introMessageBuilder = $introMessageBuilder;
	$this->preloadedContentBuilder = $preloadedContentBuilder;
	$this->revisionLookup = $revisionLookup;
	$this->urlUtils = $urlUtils;
	}

	/**
	* @param ApiPageSet $pageSet
	* @return void
	*/
	public function requestExtraData( $pageSet ) {
	// If the pageset is resolving redirects we won't get page_is_redirect.
	// But we can't know for sure until the pageset is executed (revids may
	// turn it off), so request it unconditionally.
	$pageSet->requestField( 'page_is_redirect' );
	$pageSet->requestField( 'page_is_new' );
	$config = $this->getConfig();
	$pageSet->requestField( 'page_touched' );
	$pageSet->requestField( 'page_latest' );
	$pageSet->requestField( 'page_len' );
	$pageSet->requestField( 'page_content_model' );
	if ( $config->get( MainConfigNames::PageLanguageUseDB ) ) {
	$pageSet->requestField( 'page_lang' );
	}
	}

	public function execute() {
	$this->params = $this->extractRequestParams();
	if ( $this->params['prop'] !== null ) {
	$prop = array_fill_keys( $this->params['prop'], true );
	$this->fld_protection = isset( $prop['protection'] );
	$this->fld_watched = isset( $prop['watched'] );
	$this->fld_watchers = isset( $prop['watchers'] );
	$this->fld_visitingwatchers = isset( $prop['visitingwatchers'] );
	$this->fld_notificationtimestamp = isset( $prop['notificationtimestamp'] );
	$this->fld_talkid = isset( $prop['talkid'] );
	$this->fld_subjectid = isset( $prop['subjectid'] );
	$this->fld_url = isset( $prop['url'] );
	$this->fld_readable = isset( $prop['readable'] );
	$this->fld_preload = isset( $prop['preload'] );
	$this->fld_preloadcontent = isset( $prop['preloadcontent'] );
	$this->fld_editintro = isset( $prop['editintro'] );
	$this->fld_displaytitle = isset( $prop['displaytitle'] );
	$this->fld_varianttitles = isset( $prop['varianttitles'] );
	$this->fld_linkclasses = isset( $prop['linkclasses'] );
	$this->fld_associatedpage = isset( $prop['associatedpage'] );
	}

	$pageSet = $this->getPageSet();
	$this->titles = $pageSet->getGoodPages();
	$this->missing = $pageSet->getMissingPages();
	$this->everything = $this->titles + $this->missing;
	$result = $this->getResult();

	if (
	( $this->fld_preloadcontent \|\| $this->fld_editintro ) &&
	( count( $this->everything ) > 1 \|\| count( $this->getPageSet()->getRevisionIDs() ) > 1 )
	) {
	// This is relatively slow, so disallow doing it for multiple pages, just in case.
	// (Also, handling multiple revisions would be tricky.)
	$this->dieWithError(
	[ 'apierror-info-singlepagerevision', $this->getModulePrefix() ], 'invalidparammix'
	);
	}

	uasort( $this->everything, [ Title::class, 'compare' ] );
	if ( $this->params['continue'] !== null ) {
	// Throw away any titles we're gonna skip so they don't
	// clutter queries
	$cont = $this->parseContinueParamOrDie( $this->params['continue'], [ 'int', 'string' ] );
	$conttitle = $this->titleFactory->makeTitleSafe( $cont[0], $cont[1] );
	$this->dieContinueUsageIf( !$conttitle );
	foreach ( $this->everything as $pageid => $page ) {
	if ( Title::compare( $page, $conttitle ) >= 0 ) {
	break;
	}
	unset( $this->titles[$pageid] );
	unset( $this->missing[$pageid] );
	unset( $this->everything[$pageid] );
	}
	}

	// when resolving redirects, no page will have this field
	$this->pageIsRedir = !$pageSet->isResolvingRedirects()
	? $pageSet->getCustomField( 'page_is_redirect' )
	: [];
	$this->pageIsNew = $pageSet->getCustomField( 'page_is_new' );

	$this->pageTouched = $pageSet->getCustomField( 'page_touched' );
	$this->pageLatest = $pageSet->getCustomField( 'page_latest' );
	$this->pageLength = $pageSet->getCustomField( 'page_len' );

	// Get protection info if requested
	if ( $this->fld_protection ) {
	$this->getProtectionInfo();
	}

	if ( $this->fld_watched \|\| $this->fld_notificationtimestamp ) {
	$this->getWatchedInfo();
	}

	if ( $this->fld_watchers ) {
	$this->getWatcherInfo();
	}

	if ( $this->fld_visitingwatchers ) {
	$this->getVisitingWatcherInfo();
	}

	// Run the talkid/subjectid query if requested
	if ( $this->fld_talkid \|\| $this->fld_subjectid ) {
	$this->getTSIDs();
	}

	if ( $this->fld_displaytitle ) {
	$this->getDisplayTitle();
	}

	if ( $this->fld_varianttitles ) {
	$this->getVariantTitles();
	}

	if ( $this->fld_linkclasses ) {
	$this->getLinkClasses( $this->params['linkcontext'] );
	}

	/** @var PageIdentity $page */
	foreach ( $this->everything as $pageid => $page ) {
	$pageInfo = $this->extractPageInfo( $pageid, $page );
	$fit = $pageInfo !== null && $result->addValue( [
	'query',
	'pages'
	], $pageid, $pageInfo );
	if ( !$fit ) {
	$this->setContinueEnumParameter( 'continue',
	$page->getNamespace() . '\|' .
	$this->titleFormatter->getText( $page ) );
	break;
	}
	}
	}

	/**
	* Get a result array with information about a title
	* @param int $pageid Page ID (negative for missing titles)
	* @param PageIdentity $page
	* @return array\|null
	*/
	private function extractPageInfo( $pageid, $page ) {
	$title = $this->titleFactory->newFromPageIdentity( $page );
	$pageInfo = [];
	// $page->exists() needs pageid, which is not set for all title objects
	$pageExists = $pageid > 0;
	$ns = $page->getNamespace();
	$dbkey = $page->getDBkey();

	$pageInfo['contentmodel'] = $title->getContentModel();

	$pageLanguage = $title->getPageLanguage();
	$pageInfo['pagelanguage'] = $pageLanguage->getCode();
	$pageInfo['pagelanguagehtmlcode'] = $pageLanguage->getHtmlCode();
	$pageInfo['pagelanguagedir'] = $pageLanguage->getDir();

	if ( $pageExists ) {
	$pageInfo['touched'] = wfTimestamp( TS_ISO_8601, $this->pageTouched[$pageid] );
	$pageInfo['lastrevid'] = (int)$this->pageLatest[$pageid];
	$pageInfo['length'] = (int)$this->pageLength[$pageid];

	if ( isset( $this->pageIsRedir[$pageid] ) && $this->pageIsRedir[$pageid] ) {
	$pageInfo['redirect'] = true;
	}
	if ( $this->pageIsNew[$pageid] ) {
	$pageInfo['new'] = true;
	}
	}

	if ( $this->fld_protection ) {
	$pageInfo['protection'] = [];
	if ( isset( $this->protections[$ns][$dbkey] ) ) {
	$pageInfo['protection'] =
	$this->protections[$ns][$dbkey];
	}
	ApiResult::setIndexedTagName( $pageInfo['protection'], 'pr' );

	$pageInfo['restrictiontypes'] = [];
	if ( isset( $this->restrictionTypes[$ns][$dbkey] ) ) {
	$pageInfo['restrictiontypes'] =
	$this->restrictionTypes[$ns][$dbkey];
	}
	ApiResult::setIndexedTagName( $pageInfo['restrictiontypes'], 'rt' );
	}

	if ( $this->fld_watched ) {
	$pageInfo['watched'] = false;

	if ( isset( $this->watched[$ns][$dbkey] ) ) {
	$pageInfo['watched'] = $this->watched[$ns][$dbkey];
	}

	if ( isset( $this->watchlistExpiries[$ns][$dbkey] ) ) {
	$pageInfo['watchlistexpiry'] = $this->watchlistExpiries[$ns][$dbkey];
	}
	}

	if ( $this->fld_watchers ) {
	if ( $this->watchers !== null && $this->watchers[$ns][$dbkey] !== 0 ) {
	$pageInfo['watchers'] = $this->watchers[$ns][$dbkey];
	} elseif ( $this->showZeroWatchers ) {
	$pageInfo['watchers'] = 0;
	}
	}

	if ( $this->fld_visitingwatchers ) {
	if ( $this->visitingwatchers !== null && $this->visitingwatchers[$ns][$dbkey] !== 0 ) {
	$pageInfo['visitingwatchers'] = $this->visitingwatchers[$ns][$dbkey];
	} elseif ( $this->showZeroWatchers ) {
	$pageInfo['visitingwatchers'] = 0;
	}
	}

	if ( $this->fld_notificationtimestamp ) {
	$pageInfo['notificationtimestamp'] = '';
	if ( isset( $this->notificationtimestamps[$ns][$dbkey] ) ) {
	$pageInfo['notificationtimestamp'] =
	wfTimestamp( TS_ISO_8601, $this->notificationtimestamps[$ns][$dbkey] );
	}
	}

	if ( $this->fld_talkid && isset( $this->talkids[$ns][$dbkey] ) ) {
	$pageInfo['talkid'] = $this->talkids[$ns][$dbkey];
	}

	if ( $this->fld_subjectid && isset( $this->subjectids[$ns][$dbkey] ) ) {
	$pageInfo['subjectid'] = $this->subjectids[$ns][$dbkey];
	}

	if ( $this->fld_associatedpage && $ns >= NS_MAIN ) {
	$pageInfo['associatedpage'] = $this->titleFormatter->getPrefixedText(
	$this->namespaceInfo->getAssociatedPage( TitleValue::newFromPage( $page ) )
	);
	}

	if ( $this->fld_url ) {
	$pageInfo['fullurl'] = (string)$this->urlUtils->expand(
	$title->getFullURL(), PROTO_CURRENT
	);
	$pageInfo['editurl'] = (string)$this->urlUtils->expand(
	$title->getFullURL( 'action=edit' ), PROTO_CURRENT
	);
	$pageInfo['canonicalurl'] = (string)$this->urlUtils->expand(
	$title->getFullURL(), PROTO_CANONICAL
	);
	}
	if ( $this->fld_readable ) {
	$pageInfo['readable'] = $this->getAuthority()->definitelyCan( 'read', $page );
	}

	if ( $this->fld_preload ) {
	if ( $pageExists ) {
	$pageInfo['preload'] = '';
	} else {
	$text = null;
	// @phan-suppress-next-line PhanTypeMismatchArgument Type mismatch on pass-by-ref args
	$this->getHookRunner()->onEditFormPreloadText( $text, $title );

	$pageInfo['preload'] = $text;
	}
	}

	if ( $this->fld_preloadcontent ) {
	$newSection = $this->params['preloadnewsection'];
	// Preloaded content is not supported for already existing pages or sections.
	// The actual page/section content should be shown for editing (from prop=revisions API).
	if ( !$pageExists \|\| $newSection ) {
	$content = $this->preloadedContentBuilder->getPreloadedContent(
	$title->toPageIdentity(),
	$this->getAuthority(),
	$this->params['preloadcustom'],
	$this->params['preloadparams'] ?? [],
	$newSection ? 'new' : null
	);
	$defaultContent = $newSection ? null :
	$this->preloadedContentBuilder->getDefaultContent( $title->toPageIdentity() );
	$contentIsDefault = $defaultContent ? $content->equals( $defaultContent ) : $content->isEmpty();
	// Adapted from ApiQueryRevisionsBase::extractAllSlotInfo.
	// The preloaded content fills the main slot.
	$pageInfo['preloadcontent']['contentmodel'] = $content->getModel();
	$pageInfo['preloadcontent']['contentformat'] = $content->getDefaultFormat();
	ApiResult::setContentValue( $pageInfo['preloadcontent'], 'content', $content->serialize() );
	// If the preloaded content generated from these parameters is the same as
	// the default page content, the user should be discouraged from saving the page
	// (e.g. by disabling the save button until changes are made, or displaying a warning).
	$pageInfo['preloadisdefault'] = $contentIsDefault;
	}
	}

	if ( $this->fld_editintro ) {
	// Use $page as the context page in every processed message (T300184)
	$localizerWithPage = new class( $this, $page ) implements MessageLocalizer {
	private MessageLocalizer $base;
	private PageReference $page;

	public function __construct( MessageLocalizer $base, PageReference $page ) {
	$this->base = $base;
	$this->page = $page;
	}

	/**
	* @inheritDoc
	*/
	public function msg( $key, ...$params ) {
	return $this->base->msg( $key, ...$params )->page( $this->page );
	}
	};

	$styleParamMap = [
	'lessframes' => IntroMessageBuilder::LESS_FRAMES,
	'moreframes' => IntroMessageBuilder::MORE_FRAMES,
	];
	// If we got here, there is exactly one page and revision in the query
	$revId = array_key_first( $this->getPageSet()->getLiveRevisionIDs() );
	$revRecord = $revId ? $this->revisionLookup->getRevisionById( $revId ) : null;

	$messages = $this->introMessageBuilder->getIntroMessages(
	$styleParamMap[ $this->params['editintrostyle'] ],
	$this->params['editintroskip'] ?? [],
	$localizerWithPage,
	$title->toPageIdentity(),
	$revRecord,
	$this->getAuthority(),
	$this->params['editintrocustom'],
	// Maybe expose these as parameters in the future, but for now it doesn't seem worth it:
	null,
	false
	);
	ApiResult::setIndexedTagName( $messages, 'ei' );
	ApiResult::setArrayType( $messages, 'kvp', 'key' );

	$pageInfo['editintro'] = $messages;
	}

	if ( $this->fld_displaytitle ) {
	$pageInfo['displaytitle'] = $this->displaytitles[$pageid] ??
	htmlspecialchars( $this->titleFormatter->getPrefixedText( $page ), ENT_NOQUOTES );
	}

	if ( $this->fld_varianttitles && isset( $this->variantTitles[$pageid] ) ) {
	$pageInfo['varianttitles'] = $this->variantTitles[$pageid];
	}

	if ( $this->fld_linkclasses && isset( $this->linkClasses[$pageid] ) ) {
	$pageInfo['linkclasses'] = $this->linkClasses[$pageid];
	}

	if ( $this->params['testactions'] ) {
	$limit = $this->getMain()->canApiHighLimits() ? self::LIMIT_SML2 : self::LIMIT_SML1;
	if ( $this->countTestedActions >= $limit ) {
	return null; // force a continuation
	}

	$detailLevel = $this->params['testactionsdetail'];
	$errorFormatter = $this->getErrorFormatter();
	if ( $errorFormatter->getFormat() === 'bc' ) {
	// Eew, no. Use a more modern format here.
	$errorFormatter = $errorFormatter->newWithFormat( 'plaintext' );
	}

	$pageInfo['actions'] = [];
	if ( $this->params['testactionsautocreate'] ) {
	$pageInfo['wouldautocreate'] = [];
	}

	foreach ( $this->params['testactions'] as $action ) {
	$this->countTestedActions++;

	$shouldAutoCreate = $this->tempUserCreator->shouldAutoCreate( $this->getUser(), $action );

	if ( $shouldAutoCreate ) {
	$authority = $this->userFactory->newTempPlaceholder();
	} else {
	$authority = $this->getAuthority();
	}

	if ( $detailLevel === 'boolean' ) {
	$pageInfo['actions'][$action] = $authority->authorizeRead( $action, $page );
	} else {
	$status = new PermissionStatus();
	if ( $detailLevel === 'quick' ) {
	$authority->probablyCan( $action, $page, $status );
	} else {
	$authority->definitelyCan( $action, $page, $status );
	}
	$this->addBlockInfoToStatus( $status );
	$pageInfo['actions'][$action] = $errorFormatter->arrayFromStatus( $status );
	}

	if ( $this->params['testactionsautocreate'] ) {
	$pageInfo['wouldautocreate'][$action] = $shouldAutoCreate;
	}
	}
	}

	return $pageInfo;
	}

	/**
	* Get information about protections and put it in $protections
	*/
	private function getProtectionInfo() {
	$this->protections = [];
	$db = $this->getDB();

	// Get normal protections for existing titles
	if ( count( $this->titles ) ) {
	$this->resetQueryParams();
	$this->addTables( 'page_restrictions' );
	$this->addFields( [ 'pr_page', 'pr_type', 'pr_level',
	'pr_expiry', 'pr_cascade' ] );
	$this->addWhereFld( 'pr_page', array_keys( $this->titles ) );

	$res = $this->select( __METHOD__ );
	foreach ( $res as $row ) {
	/** @var PageReference $page */
	$page = $this->titles[$row->pr_page];
	$a = [
	'type' => $row->pr_type,
	'level' => $row->pr_level,
	'expiry' => ApiResult::formatExpiry( $row->pr_expiry )
	];
	if ( $row->pr_cascade ) {
	$a['cascade'] = true;
	}
	$this->protections[$page->getNamespace()][$page->getDBkey()][] = $a;
	}
	}

	// Get protections for missing titles
	if ( count( $this->missing ) ) {
	$this->resetQueryParams();
	$lb = $this->linkBatchFactory->newLinkBatch( $this->missing );
	$this->addTables( 'protected_titles' );
	$this->addFields( [ 'pt_title', 'pt_namespace', 'pt_create_perm', 'pt_expiry' ] );
	$this->addWhere( $lb->constructSet( 'pt', $db ) );
	$res = $this->select( __METHOD__ );
	foreach ( $res as $row ) {
	$this->protections[$row->pt_namespace][$row->pt_title][] = [
	'type' => 'create',
	'level' => $row->pt_create_perm,
	'expiry' => ApiResult::formatExpiry( $row->pt_expiry )
	];
	}
	}

	// Separate good and missing titles into files and other pages
	// and populate $this->restrictionTypes
	$images = $others = [];
	foreach ( $this->everything as $page ) {
	if ( $page->getNamespace() === NS_FILE ) {
	$images[] = $page->getDBkey();
	} else {
	$others[] = $page;
	}
	// Applicable protection types
	$this->restrictionTypes[$page->getNamespace()][$page->getDBkey()] =
	array_values( $this->restrictionStore->listApplicableRestrictionTypes( $page ) );
	}

	[ $blNamespace, $blTitle ] = $this->linksMigration->getTitleFields( 'templatelinks' );
	$queryInfo = $this->linksMigration->getQueryInfo( 'templatelinks' );

	if ( count( $others ) ) {
	// Non-images: check templatelinks
	$lb = $this->linkBatchFactory->newLinkBatch( $others );
	$this->resetQueryParams();
	$this->addTables( array_merge( [ 'page_restrictions', 'page' ], $queryInfo['tables'] ) );
	// templatelinks must use PRIMARY index and not the tl_target_id.
	$this->addOption( 'USE INDEX', [ 'templatelinks' => 'PRIMARY' ] );
	$this->addFields( [ 'pr_type', 'pr_level', 'pr_expiry',
	'page_title', 'page_namespace',
	$blNamespace, $blTitle ] );
	$this->addWhere( $lb->constructSet( 'tl', $db ) );
	$this->addWhere( 'pr_page = page_id' );
	$this->addWhere( 'pr_page = tl_from' );
	$this->addWhereFld( 'pr_cascade', 1 );
	$this->addJoinConds( $queryInfo['joins'] );

	$res = $this->select( __METHOD__ );
	foreach ( $res as $row ) {
	$this->protections[$row->$blNamespace][$row->$blTitle][] = [
	'type' => $row->pr_type,
	'level' => $row->pr_level,
	'expiry' => ApiResult::formatExpiry( $row->pr_expiry ),
	'source' => $this->titleFormatter->formatTitle( $row->page_namespace, $row->page_title ),
	];
	}
	}

	if ( count( $images ) ) {
	// Images: check imagelinks
	$this->resetQueryParams();
	$this->addTables( [ 'page_restrictions', 'page', 'imagelinks' ] );
	$this->addFields( [ 'pr_type', 'pr_level', 'pr_expiry',
	'page_title', 'page_namespace', 'il_to' ] );
	$this->addWhere( 'pr_page = page_id' );
	$this->addWhere( 'pr_page = il_from' );
	$this->addWhereFld( 'pr_cascade', 1 );
	$this->addWhereFld( 'il_to', $images );

	$res = $this->select( __METHOD__ );
	foreach ( $res as $row ) {
	$this->protections[NS_FILE][$row->il_to][] = [
	'type' => $row->pr_type,
	'level' => $row->pr_level,
	'expiry' => ApiResult::formatExpiry( $row->pr_expiry ),
	'source' => $this->titleFormatter->formatTitle( $row->page_namespace, $row->page_title ),
	];
	}
	}
	}

	/**
	* Get talk page IDs (if requested) and subject page IDs (if requested)
	* and put them in $talkids and $subjectids
	*/
	private function getTSIDs() {
	$getTitles = $this->talkids = $this->subjectids = [];
	$nsInfo = $this->namespaceInfo;

	/** @var PageReference $page */
	foreach ( $this->everything as $page ) {
	if ( $nsInfo->isTalk( $page->getNamespace() ) ) {
	if ( $this->fld_subjectid ) {
	$getTitles[] = $nsInfo->getSubjectPage( TitleValue::newFromPage( $page ) );
	}
	} elseif ( $this->fld_talkid ) {
	$getTitles[] = $nsInfo->getTalkPage( TitleValue::newFromPage( $page ) );
	}
	}
	if ( $getTitles === [] ) {
	return;
	}

	$db = $this->getDB();

	// Construct a custom WHERE clause that matches
	// all titles in $getTitles
	$lb = $this->linkBatchFactory->newLinkBatch( $getTitles );
	$this->resetQueryParams();
	$this->addTables( 'page' );
	$this->addFields( [ 'page_title', 'page_namespace', 'page_id' ] );
	$this->addWhere( $lb->constructSet( 'page', $db ) );
	$res = $this->select( __METHOD__ );
	foreach ( $res as $row ) {
	if ( $nsInfo->isTalk( $row->page_namespace ) ) {
	$this->talkids[$nsInfo->getSubject( $row->page_namespace )][$row->page_title] =
	(int)( $row->page_id );
	} else {
	$this->subjectids[$nsInfo->getTalk( $row->page_namespace )][$row->page_title] =
	(int)( $row->page_id );
	}
	}
	}

	private function getDisplayTitle() {
	$this->displaytitles = [];

	$pageIds = array_keys( $this->titles );

	if ( $pageIds === [] ) {
	return;
	}

	$this->resetQueryParams();
	$this->addTables( 'page_props' );
	$this->addFields( [ 'pp_page', 'pp_value' ] );
	$this->addWhereFld( 'pp_page', $pageIds );
	$this->addWhereFld( 'pp_propname', 'displaytitle' );
	$res = $this->select( __METHOD__ );

	foreach ( $res as $row ) {
	$this->displaytitles[$row->pp_page] = $row->pp_value;
	}
	}

	/**
	* Fetch the set of extra link classes associated with links to the
	* set of titles ("link colours"), as they would appear on the
	* given context page.
	* @param ?LinkTarget $context_title The page context in which link
	* colors are determined.
	*/
	private function getLinkClasses( ?LinkTarget $context_title = null ) {
	if ( $this->titles === [] ) {
	return;
	}
	// For compatibility with legacy GetLinkColours hook:
	// $pagemap maps from page id to title (as prefixed db key)
	// $classes maps from title (prefixed db key) to a space-separated
	// list of link classes ("link colours").
	// The hook should not modify $pagemap, and should only append to
	// $classes (being careful to maintain space separation).
	$classes = [];
	$pagemap = [];
	foreach ( $this->titles as $pageId => $page ) {
	$pdbk = $this->titleFormatter->getPrefixedDBkey( $page );
	$pagemap[$pageId] = $pdbk;
	$classes[$pdbk] = isset( $this->pageIsRedir[$pageId] ) && $this->pageIsRedir[$pageId] ? 'mw-redirect' : '';
	}
	// legacy hook requires a real Title, not a LinkTarget
	$context_title = $this->titleFactory->newFromLinkTarget(
	$context_title ?? $this->titleFactory->newMainPage()
	);
	$this->getHookRunner()->onGetLinkColours(
	$pagemap, $classes, $context_title
	);

	// This API class expects the class list to be:
	// (a) indexed by pageid, not title, and
	// (b) a proper array of strings (possibly zero-length),
	// not a single space-separated string (possibly the empty string)
	$this->linkClasses = [];
	foreach ( $this->titles as $pageId => $page ) {
	$pdbk = $this->titleFormatter->getPrefixedDBkey( $page );
	$this->linkClasses[$pageId] = preg_split(
	'/\s+/', $classes[$pdbk] ?? '', -1, PREG_SPLIT_NO_EMPTY
	);
	}
	}

	private function getVariantTitles() {
	if ( $this->titles === [] ) {
	return;
	}
	$this->variantTitles = [];
	foreach ( $this->titles as $pageId => $page ) {
	$this->variantTitles[$pageId] = isset( $this->displaytitles[$pageId] )
	? $this->getAllVariants( $this->displaytitles[$pageId] )
	: $this->getAllVariants( $this->titleFormatter->getText( $page ), $page->getNamespace() );
	}
	}

	private function getAllVariants( $text, $ns = NS_MAIN ) {
	$result = [];
	foreach ( $this->languageConverter->getVariants() as $variant ) {
	$convertTitle = $this->languageConverter->autoConvert( $text, $variant );
	if ( $ns !== NS_MAIN ) {
	$convertNs = $this->languageConverter->convertNamespace( $ns, $variant );
	$convertTitle = $convertNs . ':' . $convertTitle;
	}
	$result[$variant] = $convertTitle;
	}
	return $result;
	}

	/**
	* Get information about watched status and put it in $this->watched
	* and $this->notificationtimestamps
	*/
	private function getWatchedInfo() {
	$user = $this->getUser();

	if ( !$user->isRegistered() \|\| count( $this->everything ) == 0
	\|\| !$this->getAuthority()->isAllowed( 'viewmywatchlist' )
	) {
	return;
	}

	$this->watched = [];
	$this->watchlistExpiries = [];
	$this->notificationtimestamps = [];

	/** @var WatchedItem[] $items */
	$items = $this->watchedItemStore->loadWatchedItemsBatch( $user, $this->everything );

	foreach ( $items as $item ) {
	$nsId = $item->getTarget()->getNamespace();
	$dbKey = $item->getTarget()->getDBkey();

	if ( $this->fld_watched ) {
	$this->watched[$nsId][$dbKey] = true;

	$expiry = $item->getExpiry( TS_ISO_8601 );
	if ( $expiry ) {
	$this->watchlistExpiries[$nsId][$dbKey] = $expiry;
	}
	}

	if ( $this->fld_notificationtimestamp ) {
	$this->notificationtimestamps[$nsId][$dbKey] = $item->getNotificationTimestamp();
	}
	}
	}

	/**
	* Get the count of watchers and put it in $this->watchers
	*/
	private function getWatcherInfo() {
	if ( count( $this->everything ) == 0 ) {
	return;
	}

	$canUnwatchedpages = $this->getAuthority()->isAllowed( 'unwatchedpages' );
	$unwatchedPageThreshold =
	$this->getConfig()->get( MainConfigNames::UnwatchedPageThreshold );
	if ( !$canUnwatchedpages && !is_int( $unwatchedPageThreshold ) ) {
	return;
	}

	$this->showZeroWatchers = $canUnwatchedpages;

	$countOptions = [];
	if ( !$canUnwatchedpages ) {
	$countOptions['minimumWatchers'] = $unwatchedPageThreshold;
	}

	$this->watchers = $this->watchedItemStore->countWatchersMultiple(
	$this->everything,
	$countOptions
	);
	}

	/**
	* Get the count of watchers who have visited recent edits and put it in
	* $this->visitingwatchers
	*
	* Based on InfoAction::pageCounts
	*/
	private function getVisitingWatcherInfo() {
	$config = $this->getConfig();
	$db = $this->getDB();

	$canUnwatchedpages = $this->getAuthority()->isAllowed( 'unwatchedpages' );
	$unwatchedPageThreshold = $config->get( MainConfigNames::UnwatchedPageThreshold );
	if ( !$canUnwatchedpages && !is_int( $unwatchedPageThreshold ) ) {
	return;
	}

	$this->showZeroWatchers = $canUnwatchedpages;

	$titlesWithThresholds = [];
	if ( $this->titles ) {
	$lb = $this->linkBatchFactory->newLinkBatch( $this->titles );

	// Fetch last edit timestamps for pages
	$this->resetQueryParams();
	$this->addTables( [ 'page', 'revision' ] );
	$this->addFields( [ 'page_namespace', 'page_title', 'rev_timestamp' ] );
	$this->addWhere( [
	'page_latest = rev_id',
	$lb->constructSet( 'page', $db ),
	] );
	$this->addOption( 'GROUP BY', [ 'page_namespace', 'page_title' ] );
	$timestampRes = $this->select( __METHOD__ );

	$age = $config->get( MainConfigNames::WatchersMaxAge );
	$timestamps = [];
	foreach ( $timestampRes as $row ) {
	$revTimestamp = wfTimestamp( TS_UNIX, (int)$row->rev_timestamp );
	$timestamps[$row->page_namespace][$row->page_title] = (int)$revTimestamp - $age;
	}
	$titlesWithThresholds = array_map(
	static function ( PageReference $target ) use ( $timestamps ) {
	return [
	$target, $timestamps[$target->getNamespace()][$target->getDBkey()]
	];
	},
	$this->titles
	);
	}

	if ( $this->missing ) {
	$titlesWithThresholds = array_merge(
	$titlesWithThresholds,
	array_map(
	static function ( PageReference $target ) {
	return [ $target, null ];
	},
	$this->missing
	)
	);
	}
	$this->visitingwatchers = $this->watchedItemStore->countVisitingWatchersMultiple(
	$titlesWithThresholds,
	!$canUnwatchedpages ? $unwatchedPageThreshold : null
	);
	}

	public function getCacheMode( $params ) {
	// Other props depend on something about the current user
	$publicProps = [
	'protection',
	'talkid',
	'subjectid',
	'associatedpage',
	'url',
	'preload',
	'displaytitle',
	'varianttitles',
	];
	if ( array_diff( (array)$params['prop'], $publicProps ) ) {
	return 'private';
	}

	// testactions also depends on the current user
	if ( $params['testactions'] ) {
	return 'private';
	}

	return 'public';
	}

	public function getAllowedParams() {
	return [
	'prop' => [
	ParamValidator::PARAM_ISMULTI => true,
	ParamValidator::PARAM_TYPE => [
	'protection',
	'talkid',
	'watched', # private
	'watchers', # private
	'visitingwatchers', # private
	'notificationtimestamp', # private
	'subjectid',
	'associatedpage',
	'url',
	'readable', # private
	'preload',
	'preloadcontent', # private: checks current user's permissions
	'editintro', # private: checks current user's permissions
	'displaytitle',
	'varianttitles',
	'linkclasses', # private: stub length (and possibly hook colors)
	// If you add more properties here, please consider whether they
	// need to be added to getCacheMode()
	],
	ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
	EnumDef::PARAM_DEPRECATED_VALUES => [
	'readable' => true, // Since 1.32
	'preload' => true, // Since 1.41
	],
	],
	'linkcontext' => [
	ParamValidator::PARAM_TYPE => 'title',
	ParamValidator::PARAM_DEFAULT => $this->titleFactory->newMainPage()->getPrefixedText(),
	TitleDef::PARAM_RETURN_OBJECT => true,
	],
	'testactions' => [
	ParamValidator::PARAM_TYPE => 'string',
	ParamValidator::PARAM_ISMULTI => true,
	],
	'testactionsdetail' => [
	ParamValidator::PARAM_TYPE => [ 'boolean', 'full', 'quick' ],
	ParamValidator::PARAM_DEFAULT => 'boolean',
	ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
	],
	'testactionsautocreate' => false,
	'preloadcustom' => [
	// This should be a valid and existing page title, but we don't want to validate it here,
	// because it's usually someone else's fault. It could emit a warning in the future.
	ParamValidator::PARAM_TYPE => 'string',
	ApiBase::PARAM_HELP_MSG_INFO => [ [ 'preloadcontentonly' ] ],
	],
	'preloadparams' => [
	ParamValidator::PARAM_ISMULTI => true,
	ApiBase::PARAM_HELP_MSG_INFO => [ [ 'preloadcontentonly' ] ],
	],
	'preloadnewsection' => [
	ParamValidator::PARAM_TYPE => 'boolean',
	ParamValidator::PARAM_DEFAULT => false,
	ApiBase::PARAM_HELP_MSG_INFO => [ [ 'preloadcontentonly' ] ],
	],
	'editintrostyle' => [
	ParamValidator::PARAM_TYPE => [ 'lessframes', 'moreframes' ],
	ParamValidator::PARAM_DEFAULT => 'moreframes',
	ApiBase::PARAM_HELP_MSG_INFO => [ [ 'editintroonly' ] ],
	],
	'editintroskip' => [
	ParamValidator::PARAM_TYPE => 'string',
	ParamValidator::PARAM_ISMULTI => true,
	ApiBase::PARAM_HELP_MSG_INFO => [ [ 'editintroonly' ] ],
	],
	'editintrocustom' => [
	// This should be a valid and existing page title, but we don't want to validate it here,
	// because it's usually someone else's fault. It could emit a warning in the future.
	ParamValidator::PARAM_TYPE => 'string',
	ApiBase::PARAM_HELP_MSG_INFO => [ [ 'editintroonly' ] ],
	],
	'continue' => [
	ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
	],
	];
	}

	protected function getExamplesMessages() {
	$title = Title::newMainPage()->getPrefixedText();
	$mp = rawurlencode( $title );

	return [
	"action=query&prop=info&titles={$mp}"
	=> 'apihelp-query+info-example-simple',
	"action=query&prop=info&inprop=protection&titles={$mp}"
	=> 'apihelp-query+info-example-protection',
	];
	}

	public function getHelpUrls() {
	return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Info';
	}
	}

	/** @deprecated class alias since 1.43 */
	class_alias( ApiQueryInfo::class, 'ApiQueryInfo' );

File Metadata

Mime Type: text/x-php
Expires: Sat, May 16, 14:18 (1 d, 9 h)
Storage Engine: local-disk
Storage Format: Raw Data
Storage Handle: d4/f5/e632a1e86363c64bdc6f09e357fd
Default Alt Text: ApiQueryInfo.php (36 KB)

ApiQueryInfo.phpNo OneTemporaryActions

ApiQueryInfo.phpView Options

File Metadata

Event Timeline

ApiQueryInfo.php
No OneTemporary
Actions

ApiQueryInfo.php
View Options