wiki.techinc.nl/includes/api/ApiQueryInfo.php

1026 lines
30 KiB
PHP
Raw Normal View History

<?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
*/
use MediaWiki\MediaWikiServices;
use MediaWiki\Linker\LinkTarget;
/**
2007-05-20 23:31:44 +00:00
* A query module to show basic page information.
*
* @ingroup API
*/
class ApiQueryInfo extends ApiQueryBase {
2009-11-19 17:57:27 +00:00
2009-02-13 14:44:19 +00:00
private $fld_protection = false, $fld_talkid = false,
$fld_subjectid = false, $fld_url = false,
$fld_readable = false, $fld_watched = false,
$fld_watchers = false, $fld_visitingwatchers = false,
$fld_notificationtimestamp = false,
$fld_preload = false, $fld_displaytitle = false, $fld_varianttitles = false;
private $params;
/** @var Title[] */
private $titles;
/** @var Title[] */
private $missing;
/** @var Title[] */
private $everything;
private $pageRestrictions, $pageIsRedir, $pageIsNew, $pageTouched,
$pageLatest, $pageLength;
private $protections, $restrictionTypes, $watched, $watchers, $visitingwatchers,
$notificationtimestamps, $talkids, $subjectids, $displaytitles, $variantTitles;
private $showZeroWatchers = false;
private $tokenFunctions;
private $countTestedActions = 0;
public function __construct( ApiQuery $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'in' );
}
2011-02-19 00:30:18 +00:00
/**
* @param ApiPageSet $pageSet
* @return void
2011-02-19 00:30:18 +00:00
*/
public function requestExtraData( $pageSet ) {
$pageSet->requestField( 'page_restrictions' );
// 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' );
if ( $config->get( 'ContentHandlerUseDB' ) ) {
$pageSet->requestField( 'page_content_model' );
}
if ( $config->get( 'PageLanguageUseDB' ) ) {
$pageSet->requestField( 'page_lang' );
}
}
2009-02-13 14:44:19 +00:00
/**
* Get an array mapping token names to their handler functions.
* The prototype for a token function is func($pageid, $title)
* it should return a token or false (permission denied)
* @deprecated since 1.24
* @return array [ tokenname => function ]
2009-02-13 14:44:19 +00:00
*/
protected function getTokenFunctions() {
// Don't call the hooks twice
if ( isset( $this->tokenFunctions ) ) {
return $this->tokenFunctions;
}
// If we're in a mode that breaks the same-origin policy, no tokens can
// be obtained
if ( $this->lacksSameOriginSecurity() ) {
return [];
}
$this->tokenFunctions = [
'edit' => [ self::class, 'getEditToken' ],
'delete' => [ self::class, 'getDeleteToken' ],
'protect' => [ self::class, 'getProtectToken' ],
'move' => [ self::class, 'getMoveToken' ],
'block' => [ self::class, 'getBlockToken' ],
'unblock' => [ self::class, 'getUnblockToken' ],
'email' => [ self::class, 'getEmailToken' ],
'import' => [ self::class, 'getImportToken' ],
'watch' => [ self::class, 'getWatchToken' ],
];
Hooks::run( 'APIQueryInfoTokens', [ &$this->tokenFunctions ] );
return $this->tokenFunctions;
}
/** @var string[] */
protected static $cachedTokens = [];
/**
* @deprecated since 1.24
*/
public static function resetTokenCache() {
self::$cachedTokens = [];
}
/**
* @deprecated since 1.24
*/
public static function getEditToken( $pageid, $title ) {
// We could check for $title->userCan('edit') here,
// but that's too expensive for this purpose
2009-02-13 14:44:19 +00:00
// and would break caching
global $wgUser;
if ( !MediaWikiServices::getInstance()->getPermissionManager()
->userHasRight( $wgUser, 'edit' ) ) {
return false;
}
2009-11-19 17:57:27 +00:00
// The token is always the same, let's exploit that
if ( !isset( self::$cachedTokens['edit'] ) ) {
self::$cachedTokens['edit'] = $wgUser->getEditToken();
}
return self::$cachedTokens['edit'];
}
2009-11-19 17:57:27 +00:00
/**
* @deprecated since 1.24
*/
public static function getDeleteToken( $pageid, $title ) {
global $wgUser;
if ( !MediaWikiServices::getInstance()->getPermissionManager()
->userHasRight( $wgUser, 'delete' ) ) {
2009-11-19 17:57:27 +00:00
return false;
}
// The token is always the same, let's exploit that
if ( !isset( self::$cachedTokens['delete'] ) ) {
self::$cachedTokens['delete'] = $wgUser->getEditToken();
}
return self::$cachedTokens['delete'];
}
/**
* @deprecated since 1.24
*/
public static function getProtectToken( $pageid, $title ) {
global $wgUser;
if ( !MediaWikiServices::getInstance()->getPermissionManager()
->userHasRight( $wgUser, 'protect' ) ) {
return false;
}
// The token is always the same, let's exploit that
if ( !isset( self::$cachedTokens['protect'] ) ) {
self::$cachedTokens['protect'] = $wgUser->getEditToken();
}
return self::$cachedTokens['protect'];
}
/**
* @deprecated since 1.24
*/
public static function getMoveToken( $pageid, $title ) {
global $wgUser;
if ( !MediaWikiServices::getInstance()->getPermissionManager()
->userHasRight( $wgUser, 'move' ) ) {
return false;
}
// The token is always the same, let's exploit that
if ( !isset( self::$cachedTokens['move'] ) ) {
self::$cachedTokens['move'] = $wgUser->getEditToken();
}
return self::$cachedTokens['move'];
}
/**
* @deprecated since 1.24
*/
public static function getBlockToken( $pageid, $title ) {
global $wgUser;
if ( !MediaWikiServices::getInstance()->getPermissionManager()
->userHasRight( $wgUser, 'block' ) ) {
return false;
}
// The token is always the same, let's exploit that
if ( !isset( self::$cachedTokens['block'] ) ) {
self::$cachedTokens['block'] = $wgUser->getEditToken();
}
return self::$cachedTokens['block'];
}
/**
* @deprecated since 1.24
*/
public static function getUnblockToken( $pageid, $title ) {
// Currently, this is exactly the same as the block token
return self::getBlockToken( $pageid, $title );
}
/**
* @deprecated since 1.24
*/
public static function getEmailToken( $pageid, $title ) {
global $wgUser;
if ( !$wgUser->canSendEmail() || $wgUser->isBlockedFromEmailuser() ) {
return false;
}
// The token is always the same, let's exploit that
if ( !isset( self::$cachedTokens['email'] ) ) {
self::$cachedTokens['email'] = $wgUser->getEditToken();
}
return self::$cachedTokens['email'];
}
2009-11-19 17:57:27 +00:00
/**
* @deprecated since 1.24
*/
public static function getImportToken( $pageid, $title ) {
global $wgUser;
if ( !MediaWikiServices::getInstance()
->getPermissionManager()
->userHasAnyRight( $wgUser, 'import', 'importupload' ) ) {
return false;
}
// The token is always the same, let's exploit that
if ( !isset( self::$cachedTokens['import'] ) ) {
self::$cachedTokens['import'] = $wgUser->getEditToken();
}
return self::$cachedTokens['import'];
}
/**
* @deprecated since 1.24
*/
public static function getWatchToken( $pageid, $title ) {
global $wgUser;
if ( !$wgUser->isLoggedIn() ) {
return false;
}
// The token is always the same, let's exploit that
if ( !isset( self::$cachedTokens['watch'] ) ) {
self::$cachedTokens['watch'] = $wgUser->getEditToken( 'watch' );
}
return self::$cachedTokens['watch'];
}
/**
* @deprecated since 1.24
*/
public static function getOptionsToken( $pageid, $title ) {
global $wgUser;
if ( !$wgUser->isLoggedIn() ) {
return false;
}
// The token is always the same, let's exploit that
if ( !isset( self::$cachedTokens['options'] ) ) {
self::$cachedTokens['options'] = $wgUser->getEditToken();
}
return self::$cachedTokens['options'];
}
public function execute() {
2009-02-13 14:44:19 +00:00
$this->params = $this->extractRequestParams();
if ( !is_null( $this->params['prop'] ) ) {
$prop = array_flip( $this->params['prop'] );
$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_displaytitle = isset( $prop['displaytitle'] );
$this->fld_varianttitles = isset( $prop['varianttitles'] );
}
$pageSet = $this->getPageSet();
2009-02-13 14:44:19 +00:00
$this->titles = $pageSet->getGoodTitles();
$this->missing = $pageSet->getMissingTitles();
$this->everything = $this->titles + $this->missing;
$result = $this->getResult();
uasort( $this->everything, [ Title::class, 'compare' ] );
if ( !is_null( $this->params['continue'] ) ) {
// Throw away any titles we're gonna skip so they don't
// clutter queries
$cont = explode( '|', $this->params['continue'] );
$this->dieContinueUsageIf( count( $cont ) != 2 );
$conttitle = Title::makeTitleSafe( $cont[0], $cont[1] );
foreach ( $this->everything as $pageid => $title ) {
if ( Title::compare( $title, $conttitle ) >= 0 ) {
break;
}
unset( $this->titles[$pageid] );
unset( $this->missing[$pageid] );
unset( $this->everything[$pageid] );
}
}
$this->pageRestrictions = $pageSet->getCustomField( 'page_restrictions' );
// 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' );
2009-02-13 14:44:19 +00:00
// Get protection info if requested
if ( $this->fld_protection ) {
2009-02-13 14:44:19 +00:00
$this->getProtectionInfo();
}
if ( $this->fld_watched || $this->fld_notificationtimestamp ) {
2009-11-19 17:57:27 +00:00
$this->getWatchedInfo();
}
2009-11-19 17:57:27 +00:00
if ( $this->fld_watchers ) {
$this->getWatcherInfo();
}
if ( $this->fld_visitingwatchers ) {
$this->getVisitingWatcherInfo();
}
2009-02-13 14:44:19 +00:00
// Run the talkid/subjectid query if requested
if ( $this->fld_talkid || $this->fld_subjectid ) {
2009-02-13 14:44:19 +00:00
$this->getTSIDs();
}
if ( $this->fld_displaytitle ) {
$this->getDisplayTitle();
}
2009-02-13 14:44:19 +00:00
if ( $this->fld_varianttitles ) {
$this->getVariantTitles();
}
/** @var Title $title */
foreach ( $this->everything as $pageid => $title ) {
$pageInfo = $this->extractPageInfo( $pageid, $title );
$fit = $pageInfo !== null && $result->addValue( [
2009-02-13 14:44:19 +00:00
'query',
'pages'
], $pageid, $pageInfo );
if ( !$fit ) {
$this->setContinueEnumParameter( 'continue',
$title->getNamespace() . '|' .
$title->getText() );
2009-02-13 14:44:19 +00:00
break;
}
}
2009-02-13 14:44:19 +00:00
}
2008-05-04 16:24:05 +00:00
2009-02-13 14:44:19 +00:00
/**
* Get a result array with information about a title
* @param int $pageid Page ID (negative for missing titles)
* @param Title $title
* @return array|null
2009-02-13 14:44:19 +00:00
*/
private function extractPageInfo( $pageid, $title ) {
$pageInfo = [];
// $title->exists() needs pageid, which is not set for all title objects
$titleExists = $pageid > 0;
$ns = $title->getNamespace();
$dbkey = $title->getDBkey();
$pageInfo['contentmodel'] = $title->getContentModel();
$pageLanguage = $title->getPageLanguage();
$pageInfo['pagelanguage'] = $pageLanguage->getCode();
$pageInfo['pagelanguagehtmlcode'] = $pageLanguage->getHtmlCode();
$pageInfo['pagelanguagedir'] = $pageLanguage->getDir();
$user = $this->getUser();
if ( $titleExists ) {
$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 ( !is_null( $this->params['token'] ) ) {
2009-02-13 14:44:19 +00:00
$tokenFunctions = $this->getTokenFunctions();
$pageInfo['starttimestamp'] = wfTimestamp( TS_ISO_8601, time() );
foreach ( $this->params['token'] as $t ) {
$val = call_user_func( $tokenFunctions[$t], $pageid, $title );
if ( $val === false ) {
$this->addWarning( [ 'apiwarn-tokennotallowed', $t ] );
} else {
2009-02-13 14:44:19 +00:00
$pageInfo[$t . 'token'] = $val;
}
}
}
if ( $this->fld_protection ) {
$pageInfo['protection'] = [];
if ( isset( $this->protections[$ns][$dbkey] ) ) {
2009-02-13 14:44:19 +00:00
$pageInfo['protection'] =
$this->protections[$ns][$dbkey];
}
API: Overhaul ApiResult, make format=xml not throw, and add json formatversion ApiResult was a mess: some methods could only be used with an array reference instead of manipulating the stored data, methods that had both array-ref and internal-data versions had names that didn't at all correspond, some methods that worked on an array reference were annoyingly non-static, and then the whole mess with setIndexedTagName. ApiFormatXml is also entirely annoying to deal with, as it liked to throw exceptions if certain metadata wasn't provided that no other formatter required. Its legacy also means we have this silly convention of using empty-string rather than boolean true, annoying restrictions on keys (leading to things that should be hashes being arrays of key-value object instead), '*' used as a key all over the place, and so on. So, changes here: * ApiResult is no longer an ApiBase or a ContextSource. * Wherever sensible, ApiResult provides a static method working on an arrayref and a non-static method working on internal data. * Metadata is now always added to ApiResult's internal data structure. Formatters are responsible for stripping it if necessary. "raw mode" is deprecated. * New metadata to replace the '*' key, solve the array() => '[]' vs '{}' question, and so on. * New class for formatting warnings and errors using i18n messages, and support for multiple errors and a more machine-readable format for warnings. For the moment, though, the actual output will not be changing yet (see T47843 for future plans). * New formatversion parameter for format=json and format=php, to select between BC mode and the modern output. * In BC mode, booleans will be converted to empty-string presence style; modules currently returning booleans will need to use ApiResult::META_BC_BOOLS to preserve their current output. Actual changes to the API modules' output (e.g. actually returning booleans for the new formatversion) beyond the use of ApiResult::setContentValue() are left for a future change. Bug: T76728 Bug: T57371 Bug: T33629 Change-Id: I7b37295e8862b188d1f3b0cd07f66ac34629678f
2014-12-03 22:14:22 +00:00
ApiResult::setIndexedTagName( $pageInfo['protection'], 'pr' );
$pageInfo['restrictiontypes'] = [];
if ( isset( $this->restrictionTypes[$ns][$dbkey] ) ) {
$pageInfo['restrictiontypes'] =
$this->restrictionTypes[$ns][$dbkey];
}
API: Overhaul ApiResult, make format=xml not throw, and add json formatversion ApiResult was a mess: some methods could only be used with an array reference instead of manipulating the stored data, methods that had both array-ref and internal-data versions had names that didn't at all correspond, some methods that worked on an array reference were annoyingly non-static, and then the whole mess with setIndexedTagName. ApiFormatXml is also entirely annoying to deal with, as it liked to throw exceptions if certain metadata wasn't provided that no other formatter required. Its legacy also means we have this silly convention of using empty-string rather than boolean true, annoying restrictions on keys (leading to things that should be hashes being arrays of key-value object instead), '*' used as a key all over the place, and so on. So, changes here: * ApiResult is no longer an ApiBase or a ContextSource. * Wherever sensible, ApiResult provides a static method working on an arrayref and a non-static method working on internal data. * Metadata is now always added to ApiResult's internal data structure. Formatters are responsible for stripping it if necessary. "raw mode" is deprecated. * New metadata to replace the '*' key, solve the array() => '[]' vs '{}' question, and so on. * New class for formatting warnings and errors using i18n messages, and support for multiple errors and a more machine-readable format for warnings. For the moment, though, the actual output will not be changing yet (see T47843 for future plans). * New formatversion parameter for format=json and format=php, to select between BC mode and the modern output. * In BC mode, booleans will be converted to empty-string presence style; modules currently returning booleans will need to use ApiResult::META_BC_BOOLS to preserve their current output. Actual changes to the API modules' output (e.g. actually returning booleans for the new formatversion) beyond the use of ApiResult::setContentValue() are left for a future change. Bug: T76728 Bug: T57371 Bug: T33629 Change-Id: I7b37295e8862b188d1f3b0cd07f66ac34629678f
2014-12-03 22:14:22 +00:00
ApiResult::setIndexedTagName( $pageInfo['restrictiontypes'], 'rt' );
2009-02-13 14:44:19 +00:00
}
if ( $this->fld_watched && $this->watched !== null ) {
$pageInfo['watched'] = $this->watched[$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 ( $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_url ) {
$pageInfo['fullurl'] = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT );
$pageInfo['editurl'] = wfExpandUrl( $title->getFullURL( 'action=edit' ), PROTO_CURRENT );
$pageInfo['canonicalurl'] = wfExpandUrl( $title->getFullURL(), PROTO_CANONICAL );
2009-02-13 14:44:19 +00:00
}
if ( $this->fld_readable ) {
$pageInfo['readable'] = $this->getPermissionManager()->userCan(
'read', $user, $title
);
}
if ( $this->fld_preload ) {
if ( $titleExists ) {
$pageInfo['preload'] = '';
} else {
$text = null;
Hooks::run( 'EditFormPreloadText', [ &$text, &$title ] );
$pageInfo['preload'] = $text;
}
2010-02-13 01:41:37 +00:00
}
if ( $this->fld_displaytitle ) {
if ( isset( $this->displaytitles[$pageid] ) ) {
$pageInfo['displaytitle'] = $this->displaytitles[$pageid];
} else {
2010-07-22 10:18:41 +00:00
$pageInfo['displaytitle'] = $title->getPrefixedText();
}
}
if ( $this->fld_varianttitles && isset( $this->variantTitles[$pageid] ) ) {
$pageInfo['varianttitles'] = $this->variantTitles[$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'];
$rigor = $detailLevel === 'quick' ? 'quick' : 'secure';
$errorFormatter = $this->getErrorFormatter();
if ( $errorFormatter->getFormat() === 'bc' ) {
// Eew, no. Use a more modern format here.
$errorFormatter = $errorFormatter->newWithFormat( 'plaintext' );
}
$user = $this->getUser();
$pageInfo['actions'] = [];
foreach ( $this->params['testactions'] as $action ) {
$this->countTestedActions++;
if ( $detailLevel === 'boolean' ) {
$pageInfo['actions'][$action] = $this->getPermissionManager()->userCan(
$action, $user, $title
);
} else {
$pageInfo['actions'][$action] = $errorFormatter->arrayFromStatus( $this->errorArrayToStatus(
$this->getPermissionManager()->getPermissionErrors(
$action, $user, $title, $rigor
),
$user
) );
}
}
}
2009-02-13 14:44:19 +00:00
return $pageInfo;
}
2009-02-13 14:44:19 +00:00
/**
* Get information about protections and put it in $protections
*/
private function getProtectionInfo() {
$this->protections = [];
2009-02-13 14:44:19 +00:00
$db = $this->getDB();
2009-02-13 14:44:19 +00:00
// 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 Title $title */
$title = $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[$title->getNamespace()][$title->getDBkey()][] = $a;
}
// Also check old restrictions
foreach ( $this->titles as $pageId => $title ) {
if ( $this->pageRestrictions[$pageId] ) {
$namespace = $title->getNamespace();
$dbKey = $title->getDBkey();
$restrictions = explode( ':', trim( $this->pageRestrictions[$pageId] ) );
foreach ( $restrictions as $restrict ) {
$temp = explode( '=', trim( $restrict ) );
if ( count( $temp ) == 1 ) {
// old old format should be treated as edit/move restriction
$restriction = trim( $temp[0] );
if ( $restriction == '' ) {
continue;
}
$this->protections[$namespace][$dbKey][] = [
'type' => 'edit',
'level' => $restriction,
'expiry' => 'infinity',
];
$this->protections[$namespace][$dbKey][] = [
'type' => 'move',
'level' => $restriction,
'expiry' => 'infinity',
];
} else {
$restriction = trim( $temp[1] );
if ( $restriction == '' ) {
continue;
}
$this->protections[$namespace][$dbKey][] = [
'type' => $temp[0],
'level' => $restriction,
'expiry' => 'infinity',
];
}
2009-02-13 14:44:19 +00:00
}
}
}
2009-02-13 14:44:19 +00:00
}
// Get protections for missing titles
if ( count( $this->missing ) ) {
$this->resetQueryParams();
$lb = new LinkBatch( $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 )
];
}
2009-02-13 14:44:19 +00:00
}
// Separate good and missing titles into files and other pages
// and populate $this->restrictionTypes
$images = $others = [];
foreach ( $this->everything as $title ) {
if ( $title->getNamespace() == NS_FILE ) {
2009-05-24 08:29:10 +00:00
$images[] = $title->getDBkey();
} else {
2009-02-13 14:44:19 +00:00
$others[] = $title;
}
// Applicable protection types
$this->restrictionTypes[$title->getNamespace()][$title->getDBkey()] =
array_values( $title->getRestrictionTypes() );
}
2009-02-13 14:44:19 +00:00
if ( count( $others ) ) {
2009-02-13 14:44:19 +00:00
// Non-images: check templatelinks
$lb = new LinkBatch( $others );
2009-02-13 14:44:19 +00:00
$this->resetQueryParams();
$this->addTables( [ 'page_restrictions', 'page', 'templatelinks' ] );
$this->addFields( [ 'pr_type', 'pr_level', 'pr_expiry',
'page_title', 'page_namespace',
'tl_title', 'tl_namespace' ] );
$this->addWhere( $lb->constructSet( 'tl', $db ) );
$this->addWhere( 'pr_page = page_id' );
$this->addWhere( 'pr_page = tl_from' );
$this->addWhereFld( 'pr_cascade', 1 );
$res = $this->select( __METHOD__ );
foreach ( $res as $row ) {
$source = Title::makeTitle( $row->page_namespace, $row->page_title );
$this->protections[$row->tl_namespace][$row->tl_title][] = [
2009-02-13 14:44:19 +00:00
'type' => $row->pr_type,
'level' => $row->pr_level,
'expiry' => ApiResult::formatExpiry( $row->pr_expiry ),
2009-02-13 14:44:19 +00:00
'source' => $source->getPrefixedText()
];
}
2009-02-13 14:44:19 +00:00
}
if ( count( $images ) ) {
2009-02-13 14:44:19 +00:00
// 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 ) {
$source = Title::makeTitle( $row->page_namespace, $row->page_title );
$this->protections[NS_FILE][$row->il_to][] = [
2009-02-13 14:44:19 +00:00
'type' => $row->pr_type,
'level' => $row->pr_level,
'expiry' => ApiResult::formatExpiry( $row->pr_expiry ),
2009-02-13 14:44:19 +00:00
'source' => $source->getPrefixedText()
];
* API: BREAKING CHANGE: (bug 11430) Return fewer results than the limit in some cases to prevent running out of memory * This means queries could possibly return fewer results than the limit and still set a query-continue * Add iicontinue, rvcontinue, cicontinue, incontinue, amfrom to faciliate query-continue for these modules * Implemented by blocking additions to the ApiResult object if they would make it too large ** Important things like query-continue values and warnings are exempt from this check ** RSS feeds and exported XML are also exempted (size-checking them would be too messy) ** Result size is checked against $wgAPIMaxResultSize, which defaults to 8 MB For those who really care, per-file details follow: ApiResult.php: * Introduced ApiResult::$mSize which keeps track of the result size. * Introduced ApiResult::size() which calculates an array's size (which is the sum of the strlen()s of its elements). * ApiResult::addValue() now checks that the result size stays below $wgAPIMaxResultSize. If the item won't fit, it won't be added and addValue() will return false. Callers should check the return value and set a query-continue if it's false. * Closed the back door that is ApiResult::getData(): callers can't manipulate the data array directly anymore so they can't bypass the result size limit. * Added ApiResult::setIndexedTagName_internal() which will call setIndexedTagName() on an array already in the result. This is needed for the 'new' order of adding results, which means addValue()ing one result at a time until you hit the limit or run out, then calling this function to set the tag name. * Added ApiResult::disableSizeCheck() and enableSizeCheck() which disable and enable size checking in addValue(). This is used for stuff like query-continue elements and warnings which shouldn't count towards the result size. * Added ApiResult::unsetValue() which removes an element from the result and decreases $mSize. ApiBase.php: * Like ApiResult::getData(), ApiBase::getResultData() no longer returns a reference. * Use ApiResult::disableSizeCheck() in ApiBase::setWarning() ApiQueryBase.php: * Added ApiQueryBase::addPageSubItem(), which adds page subitems one item at a time. * addPageSubItem() and addPageSubItems() now return whether the subitem fit in the result. * Use ApiResult::disableSizeCheck() in setContinueEnumParameter() ApiMain.php: * Use ApiResult::disableSizeCheck() in ApiMain::substituteResultWithError() * Use getParameter() rather than $mRequest to obtain requestid DefaultSettings.php: * Added $wgAPIMaxResultSize, with a default value of 8 MB ApiQuery*.php: * Added results one at a time, and set a query-continue if the result is full. ApiQueryLangLinks.php and friends: * Migrated from addPageSubItems() to addPageSubItem(). This eliminates the need for $lastId. ApiQueryAllLinks.php, ApiQueryWatchlist.php, ApiQueryAllimages.php, ApiQuerySearch.php: * Renamed $data to something more appropriate ($pageids, $ids or $titles) ApiQuerySiteinfo.php: * Abuse siprop as a query-continue parameter and set it to all props that couldn't be processed. ApiQueryRandom.php: * Doesn't do continuations, because the result is supposed to be random. * Be smart enough to not run the second query if the results of the first didn't fit. ApiQueryImageInfo.php, ApiQueryRevisions.php, ApiQueryCategoryInfo.php, ApiQueryInfo.php: * Added continue parameter which basically skips the first so many items ApiQueryBacklinks.php: * Throw the result in a big array first and addValue() that one element at a time if necessary ** This is necessary because the results aren't retrieved in order * Introduced $this->pageMap to map namespace and title to page ID * Rewritten extractRowInfo() and extractRedirRowInfo() a little * Declared all private member variables explicitly ApiQueryDeletedrevs.php: * Use a pagemap just like in Backlinks * Introduce fake page IDs and keep track of them so we know where to add what ** This doesn't change the output format, because the fake page IDs start at 0 and are consecutive ApiQueryAllmessages.php: * Add amfrom to facilitate query-continue ApiQueryUsers.php: * Rewrite: put the getOtherUsersInfo() code in execute()
2009-02-05 14:30:59 +00:00
}
}
2009-02-13 14:44:19 +00:00
}
2009-02-13 14:44:19 +00:00
/**
* Get talk page IDs (if requested) and subject page IDs (if requested)
* and put them in $talkids and $subjectids
2009-02-13 14:44:19 +00:00
*/
private function getTSIDs() {
$getTitles = $this->talkids = $this->subjectids = [];
$nsInfo = MediaWikiServices::getInstance()->getNamespaceInfo();
/** @var Title $t */
foreach ( $this->everything as $t ) {
if ( $nsInfo->isTalk( $t->getNamespace() ) ) {
if ( $this->fld_subjectid ) {
2009-02-13 14:44:19 +00:00
$getTitles[] = $t->getSubjectPage();
}
} elseif ( $this->fld_talkid ) {
2009-02-13 14:44:19 +00:00
$getTitles[] = $t->getTalkPage();
}
2009-02-13 14:44:19 +00:00
}
if ( $getTitles === [] ) {
2009-02-13 14:44:19 +00:00
return;
}
$db = $this->getDB();
2009-11-19 17:57:27 +00:00
2009-02-13 14:44:19 +00:00
// Construct a custom WHERE clause that matches
// all titles in $getTitles
$lb = new LinkBatch( $getTitles );
2009-02-13 14:44:19 +00:00
$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 = [];
2010-07-22 10:18:41 +00:00
$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;
}
}
private function getVariantTitles() {
if ( $this->titles === [] ) {
return;
}
$this->variantTitles = [];
foreach ( $this->titles as $pageId => $t ) {
$this->variantTitles[$pageId] = isset( $this->displaytitles[$pageId] )
? $this->getAllVariants( $this->displaytitles[$pageId] )
: $this->getAllVariants( $t->getText(), $t->getNamespace() );
}
}
private function getAllVariants( $text, $ns = NS_MAIN ) {
$result = [];
$contLang = MediaWikiServices::getInstance()->getContentLanguage();
foreach ( $contLang->getVariants() as $variant ) {
$convertTitle = $contLang->autoConvert( $text, $variant );
if ( $ns !== NS_MAIN ) {
$convertNs = $contLang->convertNamespace( $ns, $variant );
$convertTitle = $convertNs . ':' . $convertTitle;
}
$result[$variant] = $convertTitle;
}
return $result;
}
2009-11-19 17:57:27 +00:00
/**
* Get information about watched status and put it in $this->watched
* and $this->notificationtimestamps
*/
private function getWatchedInfo() {
$user = $this->getUser();
2009-11-19 17:57:27 +00:00
if ( $user->isAnon() || count( $this->everything ) == 0
|| !$this->getPermissionManager()->userHasRight( $user, 'viewmywatchlist' )
) {
2009-11-19 17:57:27 +00:00
return;
}
2009-11-19 17:57:27 +00:00
$this->watched = [];
$this->notificationtimestamps = [];
2009-11-19 17:57:27 +00:00
$store = MediaWikiServices::getInstance()->getWatchedItemStore();
$timestamps = $store->getNotificationTimestampsBatch( $user, $this->everything );
2009-11-19 17:57:27 +00:00
if ( $this->fld_watched ) {
foreach ( $timestamps as $namespaceId => $dbKeys ) {
$this->watched[$namespaceId] = array_map(
function ( $x ) {
return $x !== false;
},
$dbKeys
);
}
2009-11-19 17:57:27 +00:00
}
if ( $this->fld_notificationtimestamp ) {
$this->notificationtimestamps = $timestamps;
}
2009-11-19 17:57:27 +00:00
}
/**
* Get the count of watchers and put it in $this->watchers
*/
private function getWatcherInfo() {
if ( count( $this->everything ) == 0 ) {
return;
}
$user = $this->getUser();
$canUnwatchedpages = $this->getPermissionManager()->userHasRight( $user, 'unwatchedpages' );
$unwatchedPageThreshold = $this->getConfig()->get( 'UnwatchedPageThreshold' );
if ( !$canUnwatchedpages && !is_int( $unwatchedPageThreshold ) ) {
return;
}
$this->showZeroWatchers = $canUnwatchedpages;
$countOptions = [];
if ( !$canUnwatchedpages ) {
$countOptions['minimumWatchers'] = $unwatchedPageThreshold;
}
$this->watchers = MediaWikiServices::getInstance()->getWatchedItemStore()->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();
$user = $this->getUser();
$db = $this->getDB();
$canUnwatchedpages = $this->getPermissionManager()->userHasRight( $user, 'unwatchedpages' );
$unwatchedPageThreshold = $this->getConfig()->get( 'UnwatchedPageThreshold' );
if ( !$canUnwatchedpages && !is_int( $unwatchedPageThreshold ) ) {
return;
}
$this->showZeroWatchers = $canUnwatchedpages;
$titlesWithThresholds = [];
if ( $this->titles ) {
$lb = new LinkBatch( $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( 'WatchersMaxAge' );
$timestamps = [];
foreach ( $timestampRes as $row ) {
$revTimestamp = wfTimestamp( TS_UNIX, (int)$row->rev_timestamp );
$timestamps[$row->page_namespace][$row->page_title] = $revTimestamp - $age;
}
$titlesWithThresholds = array_map(
function ( LinkTarget $target ) use ( $timestamps ) {
return [
$target, $timestamps[$target->getNamespace()][$target->getDBkey()]
];
},
$this->titles
);
}
if ( $this->missing ) {
$titlesWithThresholds = array_merge(
$titlesWithThresholds,
array_map(
function ( LinkTarget $target ) {
return [ $target, null ];
},
$this->missing
)
);
}
$store = MediaWikiServices::getInstance()->getWatchedItemStore();
$this->visitingwatchers = $store->countVisitingWatchersMultiple(
$titlesWithThresholds,
!$canUnwatchedpages ? $unwatchedPageThreshold : null
);
}
public function getCacheMode( $params ) {
// Other props depend on something about the current user
$publicProps = [
'protection',
'talkid',
'subjectid',
'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';
}
if ( !is_null( $params['token'] ) ) {
return 'private';
}
return 'public';
}
public function getAllowedParams() {
return [
'prop' => [
ApiBase::PARAM_ISMULTI => true,
ApiBase::PARAM_TYPE => [
'protection',
'talkid',
'watched', # private
'watchers', # private
'visitingwatchers', # private
'notificationtimestamp', # private
'subjectid',
'url',
'readable', # private
'preload',
'displaytitle',
'varianttitles',
// If you add more properties here, please consider whether they
// need to be added to getCacheMode()
],
ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
ApiBase::PARAM_DEPRECATED_VALUES => [
'readable' => true, // Since 1.32
],
],
'testactions' => [
ApiBase::PARAM_TYPE => 'string',
ApiBase::PARAM_ISMULTI => true,
],
'testactionsdetail' => [
ApiBase::PARAM_TYPE => [ 'boolean', 'full', 'quick' ],
ApiBase::PARAM_DFLT => 'boolean',
ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
],
'token' => [
ApiBase::PARAM_DEPRECATED => true,
ApiBase::PARAM_ISMULTI => true,
ApiBase::PARAM_TYPE => array_keys( $this->getTokenFunctions() )
],
'continue' => [
ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
],
];
}
protected function getExamplesMessages() {
return [
'action=query&prop=info&titles=Main%20Page'
=> 'apihelp-query+info-example-simple',
'action=query&prop=info&inprop=protection&titles=Main%20Page'
=> 'apihelp-query+info-example-protection',
];
}
public function getHelpUrls() {
return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Info';
}
}