2006-09-26 01:44:13 +00:00
|
|
|
<?php
|
2010-02-24 14:45:19 +00:00
|
|
|
/**
|
2010-12-22 20:52:06 +00:00
|
|
|
*
|
2006-09-26 01:44:13 +00:00
|
|
|
*
|
2010-08-07 19:59:42 +00:00
|
|
|
* Created on Sep 25, 2006
|
|
|
|
|
*
|
2012-07-15 20:13:02 +00:00
|
|
|
* Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
|
2006-09-26 01:44:13 +00:00
|
|
|
*
|
|
|
|
|
* 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.,
|
2010-06-21 13:13:32 +00:00
|
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
2006-09-26 01:44:13 +00:00
|
|
|
* http://www.gnu.org/copyleft/gpl.html
|
2010-08-07 19:59:42 +00:00
|
|
|
*
|
|
|
|
|
* @file
|
2006-09-26 01:44:13 +00:00
|
|
|
*/
|
|
|
|
|
|
2007-04-20 08:55:14 +00:00
|
|
|
/**
|
2007-05-20 23:31:44 +00:00
|
|
|
* A query module to show basic page information.
|
2008-04-14 07:45:50 +00:00
|
|
|
*
|
WARNING: HUGE COMMIT
Doxygen documentation update:
* Changed alls @addtogroup to @ingroup. @addtogroup adds the comment to the group description, but doesn't add the file, class, function, ... to the group like @ingroup does. See for example http://svn.wikimedia.org/doc/group__SpecialPage.html where it's impossible to see related files, classes, ... that should belong to that group.
* Added @file to file description, it seems that it should be explicitely decalred for file descriptions, otherwise doxygen will think that the comment document the first class, variabled, function, ... that is in that file.
* Removed some empty comments
* Removed some ?>
Added following groups:
* ExternalStorage
* JobQueue
* MaintenanceLanguage
One more thing: there are still a lot of warnings when generating the doc.
2008-05-20 17:13:28 +00:00
|
|
|
* @ingroup API
|
2007-04-20 08:55:14 +00:00
|
|
|
*/
|
2006-09-26 01:44:13 +00:00
|
|
|
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,
|
2012-06-18 20:33:19 +00:00
|
|
|
$fld_readable = false, $fld_watched = false, $fld_notificationtimestamp = false,
|
2012-12-12 21:51:54 +00:00
|
|
|
$fld_preload = false, $fld_displaytitle = false;
|
2006-09-26 01:44:13 +00:00
|
|
|
|
2011-02-27 21:10:11 +00:00
|
|
|
private $params, $titles, $missing, $everything, $pageCounter;
|
|
|
|
|
|
|
|
|
|
private $pageRestrictions, $pageIsRedir, $pageIsNew, $pageTouched,
|
2012-12-12 21:51:54 +00:00
|
|
|
$pageLatest, $pageLength;
|
2011-02-27 21:10:11 +00:00
|
|
|
|
2012-06-18 20:33:19 +00:00
|
|
|
private $protections, $watched, $notificationtimestamps, $talkids, $subjectids, $displaytitles;
|
2011-02-27 21:10:11 +00:00
|
|
|
|
2010-10-09 00:01:45 +00:00
|
|
|
private $tokenFunctions;
|
|
|
|
|
|
2010-01-11 15:55:52 +00:00
|
|
|
public function __construct( $query, $moduleName ) {
|
2010-02-24 14:45:19 +00:00
|
|
|
parent::__construct( $query, $moduleName, 'in' );
|
2006-09-26 01:44:13 +00:00
|
|
|
}
|
|
|
|
|
|
2011-02-19 00:30:18 +00:00
|
|
|
/**
|
|
|
|
|
* @param $pageSet ApiPageSet
|
2012-01-12 19:41:18 +00:00
|
|
|
* @return void
|
2011-02-19 00:30:18 +00:00
|
|
|
*/
|
2010-01-11 15:55:52 +00:00
|
|
|
public function requestExtraData( $pageSet ) {
|
2010-11-05 22:24:07 +00:00
|
|
|
global $wgDisableCounters;
|
2010-11-04 13:10:38 +00:00
|
|
|
|
2010-01-11 15:55:52 +00:00
|
|
|
$pageSet->requestField( 'page_restrictions' );
|
2012-07-08 15:09:04 +00:00
|
|
|
// when resolving redirects, no page will have this field
|
|
|
|
|
if( !$pageSet->isResolvingRedirects() ) {
|
|
|
|
|
$pageSet->requestField( 'page_is_redirect' );
|
|
|
|
|
}
|
2010-01-11 15:55:52 +00:00
|
|
|
$pageSet->requestField( 'page_is_new' );
|
2010-11-05 22:24:07 +00:00
|
|
|
if ( !$wgDisableCounters ) {
|
2010-11-04 13:10:38 +00:00
|
|
|
$pageSet->requestField( 'page_counter' );
|
|
|
|
|
}
|
2010-01-11 15:55:52 +00:00
|
|
|
$pageSet->requestField( 'page_touched' );
|
|
|
|
|
$pageSet->requestField( 'page_latest' );
|
|
|
|
|
$pageSet->requestField( 'page_len' );
|
2006-10-01 20:17:16 +00:00
|
|
|
}
|
|
|
|
|
|
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)
|
2011-10-28 18:10:41 +00:00
|
|
|
* @return array array(tokenname => function)
|
2009-02-13 14:44:19 +00:00
|
|
|
*/
|
2008-07-04 12:07:02 +00:00
|
|
|
protected function getTokenFunctions() {
|
|
|
|
|
// Don't call the hooks twice
|
2010-02-24 14:45:19 +00:00
|
|
|
if ( isset( $this->tokenFunctions ) ) {
|
2008-07-04 12:07:02 +00:00
|
|
|
return $this->tokenFunctions;
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
2008-07-04 12:07:02 +00:00
|
|
|
|
2008-07-05 11:18:50 +00:00
|
|
|
// If we're in JSON callback mode, no tokens can be obtained
|
2010-02-24 14:45:19 +00:00
|
|
|
if ( !is_null( $this->getMain()->getRequest()->getVal( 'callback' ) ) ) {
|
2008-07-05 11:18:50 +00:00
|
|
|
return array();
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
2008-07-05 11:18:50 +00:00
|
|
|
|
2008-07-04 12:07:02 +00:00
|
|
|
$this->tokenFunctions = array(
|
2008-07-06 18:43:06 +00:00
|
|
|
'edit' => array( 'ApiQueryInfo', 'getEditToken' ),
|
|
|
|
|
'delete' => array( 'ApiQueryInfo', 'getDeleteToken' ),
|
|
|
|
|
'protect' => array( 'ApiQueryInfo', 'getProtectToken' ),
|
|
|
|
|
'move' => array( 'ApiQueryInfo', 'getMoveToken' ),
|
|
|
|
|
'block' => array( 'ApiQueryInfo', 'getBlockToken' ),
|
2008-08-26 21:34:47 +00:00
|
|
|
'unblock' => array( 'ApiQueryInfo', 'getUnblockToken' ),
|
|
|
|
|
'email' => array( 'ApiQueryInfo', 'getEmailToken' ),
|
2009-02-04 20:11:27 +00:00
|
|
|
'import' => array( 'ApiQueryInfo', 'getImportToken' ),
|
2011-05-21 16:38:40 +00:00
|
|
|
'watch' => array( 'ApiQueryInfo', 'getWatchToken'),
|
2008-07-04 12:07:02 +00:00
|
|
|
);
|
2010-01-11 15:55:52 +00:00
|
|
|
wfRunHooks( 'APIQueryInfoTokens', array( &$this->tokenFunctions ) );
|
2008-07-04 12:07:02 +00:00
|
|
|
return $this->tokenFunctions;
|
|
|
|
|
}
|
|
|
|
|
|
2012-06-22 20:37:26 +00:00
|
|
|
static $cachedTokens = array();
|
|
|
|
|
|
|
|
|
|
public static function resetTokenCache() {
|
|
|
|
|
ApiQueryInfo::$cachedTokens = array();
|
|
|
|
|
}
|
|
|
|
|
|
2010-02-24 14:45:19 +00:00
|
|
|
public static function getEditToken( $pageid, $title ) {
|
2008-07-04 12:07:02 +00:00
|
|
|
// 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
|
2008-07-04 12:07:02 +00:00
|
|
|
global $wgUser;
|
2010-02-24 14:45:19 +00:00
|
|
|
if ( !$wgUser->isAllowed( 'edit' ) ) {
|
2008-07-04 12:07:02 +00:00
|
|
|
return false;
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
2009-11-19 17:57:27 +00:00
|
|
|
|
2012-06-22 20:37:26 +00:00
|
|
|
// The token is always the same, let's exploit that
|
|
|
|
|
if ( !isset( ApiQueryInfo::$cachedTokens[ 'edit' ] ) ) {
|
|
|
|
|
ApiQueryInfo::$cachedTokens[ 'edit' ] = $wgUser->getEditToken();
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
2008-07-04 12:07:02 +00:00
|
|
|
|
2012-06-22 20:37:26 +00:00
|
|
|
return ApiQueryInfo::$cachedTokens[ 'edit' ];
|
2008-07-04 12:07:02 +00:00
|
|
|
}
|
2009-11-19 17:57:27 +00:00
|
|
|
|
2010-02-24 14:45:19 +00:00
|
|
|
public static function getDeleteToken( $pageid, $title ) {
|
2008-07-04 12:07:02 +00:00
|
|
|
global $wgUser;
|
2010-02-24 14:45:19 +00:00
|
|
|
if ( !$wgUser->isAllowed( 'delete' ) ) {
|
2009-11-19 17:57:27 +00:00
|
|
|
return false;
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
2008-07-04 12:07:02 +00:00
|
|
|
|
2012-06-22 20:37:26 +00:00
|
|
|
// The token is always the same, let's exploit that
|
|
|
|
|
if ( !isset( ApiQueryInfo::$cachedTokens[ 'delete' ] ) ) {
|
|
|
|
|
ApiQueryInfo::$cachedTokens[ 'delete' ] = $wgUser->getEditToken();
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
2008-07-04 12:07:02 +00:00
|
|
|
|
2012-06-22 20:37:26 +00:00
|
|
|
return ApiQueryInfo::$cachedTokens[ 'delete' ];
|
2008-07-04 12:07:02 +00:00
|
|
|
}
|
|
|
|
|
|
2010-02-24 14:45:19 +00:00
|
|
|
public static function getProtectToken( $pageid, $title ) {
|
2008-07-04 12:07:02 +00:00
|
|
|
global $wgUser;
|
2010-02-24 14:45:19 +00:00
|
|
|
if ( !$wgUser->isAllowed( 'protect' ) ) {
|
2008-07-04 12:07:02 +00:00
|
|
|
return false;
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
2008-07-04 12:07:02 +00:00
|
|
|
|
2012-06-22 20:37:26 +00:00
|
|
|
// The token is always the same, let's exploit that
|
|
|
|
|
if ( !isset( ApiQueryInfo::$cachedTokens[ 'protect' ] ) ) {
|
|
|
|
|
ApiQueryInfo::$cachedTokens[ 'protect' ] = $wgUser->getEditToken();
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
2008-07-04 12:07:02 +00:00
|
|
|
|
2012-06-22 20:37:26 +00:00
|
|
|
return ApiQueryInfo::$cachedTokens[ 'protect' ];
|
2008-07-04 12:07:02 +00:00
|
|
|
}
|
|
|
|
|
|
2010-02-24 14:45:19 +00:00
|
|
|
public static function getMoveToken( $pageid, $title ) {
|
2008-07-04 12:07:02 +00:00
|
|
|
global $wgUser;
|
2010-02-24 14:45:19 +00:00
|
|
|
if ( !$wgUser->isAllowed( 'move' ) ) {
|
2008-07-04 12:07:02 +00:00
|
|
|
return false;
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
2008-07-04 12:07:02 +00:00
|
|
|
|
2012-06-22 20:37:26 +00:00
|
|
|
// The token is always the same, let's exploit that
|
|
|
|
|
if ( !isset( ApiQueryInfo::$cachedTokens[ 'move' ] ) ) {
|
|
|
|
|
ApiQueryInfo::$cachedTokens[ 'move' ] = $wgUser->getEditToken();
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
2008-07-04 12:07:02 +00:00
|
|
|
|
2012-06-22 20:37:26 +00:00
|
|
|
return ApiQueryInfo::$cachedTokens[ 'move' ];
|
2008-07-04 12:07:02 +00:00
|
|
|
}
|
|
|
|
|
|
2010-02-24 14:45:19 +00:00
|
|
|
public static function getBlockToken( $pageid, $title ) {
|
2008-07-04 12:07:02 +00:00
|
|
|
global $wgUser;
|
2010-02-24 14:45:19 +00:00
|
|
|
if ( !$wgUser->isAllowed( 'block' ) ) {
|
2008-07-04 12:07:02 +00:00
|
|
|
return false;
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
2008-07-04 12:07:02 +00:00
|
|
|
|
2012-06-22 20:37:26 +00:00
|
|
|
// The token is always the same, let's exploit that
|
|
|
|
|
if ( !isset( ApiQueryInfo::$cachedTokens[ 'block' ] ) ) {
|
|
|
|
|
ApiQueryInfo::$cachedTokens[ 'block' ] = $wgUser->getEditToken();
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
2008-07-04 12:07:02 +00:00
|
|
|
|
2012-06-22 20:37:26 +00:00
|
|
|
return ApiQueryInfo::$cachedTokens[ 'block' ];
|
2008-07-04 12:07:02 +00:00
|
|
|
}
|
|
|
|
|
|
2010-02-24 14:45:19 +00:00
|
|
|
public static function getUnblockToken( $pageid, $title ) {
|
2008-07-04 12:07:02 +00:00
|
|
|
// Currently, this is exactly the same as the block token
|
2010-01-11 15:55:52 +00:00
|
|
|
return self::getBlockToken( $pageid, $title );
|
2008-07-04 12:07:02 +00:00
|
|
|
}
|
|
|
|
|
|
2010-02-24 14:45:19 +00:00
|
|
|
public static function getEmailToken( $pageid, $title ) {
|
2008-08-26 21:34:47 +00:00
|
|
|
global $wgUser;
|
2010-02-24 14:45:19 +00:00
|
|
|
if ( !$wgUser->canSendEmail() || $wgUser->isBlockedFromEmailUser() ) {
|
2008-08-26 21:34:47 +00:00
|
|
|
return false;
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
2008-08-26 21:34:47 +00:00
|
|
|
|
2012-06-22 20:37:26 +00:00
|
|
|
// The token is always the same, let's exploit that
|
|
|
|
|
if ( !isset( ApiQueryInfo::$cachedTokens[ 'email' ] ) ) {
|
|
|
|
|
ApiQueryInfo::$cachedTokens[ 'email' ] = $wgUser->getEditToken();
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
2008-08-26 21:34:47 +00:00
|
|
|
|
2012-06-22 20:37:26 +00:00
|
|
|
return ApiQueryInfo::$cachedTokens[ 'email' ];
|
2008-08-26 21:34:47 +00:00
|
|
|
}
|
2009-11-19 17:57:27 +00:00
|
|
|
|
2010-02-24 14:45:19 +00:00
|
|
|
public static function getImportToken( $pageid, $title ) {
|
2009-02-04 20:11:27 +00:00
|
|
|
global $wgUser;
|
2011-04-01 17:29:15 +00:00
|
|
|
if ( !$wgUser->isAllowedAny( 'import', 'importupload' ) ) {
|
2009-02-04 20:11:27 +00:00
|
|
|
return false;
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
2009-02-04 20:11:27 +00:00
|
|
|
|
2012-06-22 20:37:26 +00:00
|
|
|
// The token is always the same, let's exploit that
|
|
|
|
|
if ( !isset( ApiQueryInfo::$cachedTokens[ 'import' ] ) ) {
|
|
|
|
|
ApiQueryInfo::$cachedTokens[ 'import' ] = $wgUser->getEditToken();
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
2009-02-04 20:11:27 +00:00
|
|
|
|
2012-06-22 20:37:26 +00:00
|
|
|
return ApiQueryInfo::$cachedTokens[ 'import' ];
|
2009-02-04 20:11:27 +00:00
|
|
|
}
|
2008-08-26 21:34:47 +00:00
|
|
|
|
2011-05-21 16:38:40 +00:00
|
|
|
public static function getWatchToken( $pageid, $title ) {
|
|
|
|
|
global $wgUser;
|
|
|
|
|
if ( !$wgUser->isLoggedIn() ) {
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
|
2012-06-22 20:37:26 +00:00
|
|
|
// The token is always the same, let's exploit that
|
|
|
|
|
if ( !isset( ApiQueryInfo::$cachedTokens[ 'watch' ] ) ) {
|
|
|
|
|
ApiQueryInfo::$cachedTokens[ 'watch' ] = $wgUser->getEditToken( 'watch' );
|
2011-05-21 16:38:40 +00:00
|
|
|
}
|
|
|
|
|
|
2012-06-22 20:37:26 +00:00
|
|
|
return ApiQueryInfo::$cachedTokens[ 'watch' ];
|
2011-05-21 16:38:40 +00:00
|
|
|
}
|
|
|
|
|
|
2012-05-04 10:31:08 +00:00
|
|
|
public static function getOptionsToken( $pageid, $title ) {
|
|
|
|
|
global $wgUser;
|
|
|
|
|
if ( !$wgUser->isLoggedIn() ) {
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
|
2012-06-22 20:37:26 +00:00
|
|
|
// The token is always the same, let's exploit that
|
|
|
|
|
if ( !isset( ApiQueryInfo::$cachedTokens[ 'options' ] ) ) {
|
|
|
|
|
ApiQueryInfo::$cachedTokens[ 'options' ] = $wgUser->getEditToken();
|
2012-05-04 10:31:08 +00:00
|
|
|
}
|
|
|
|
|
|
2012-06-22 20:37:26 +00:00
|
|
|
return ApiQueryInfo::$cachedTokens[ 'options' ];
|
2012-05-04 10:31:08 +00:00
|
|
|
}
|
|
|
|
|
|
2006-09-27 05:13:48 +00:00
|
|
|
public function execute() {
|
2009-02-13 14:44:19 +00:00
|
|
|
$this->params = $this->extractRequestParams();
|
2010-01-11 15:55:52 +00:00
|
|
|
if ( !is_null( $this->params['prop'] ) ) {
|
|
|
|
|
$prop = array_flip( $this->params['prop'] );
|
|
|
|
|
$this->fld_protection = isset( $prop['protection'] );
|
|
|
|
|
$this->fld_watched = isset( $prop['watched'] );
|
2012-06-18 20:33:19 +00:00
|
|
|
$this->fld_notificationtimestamp = isset( $prop['notificationtimestamp'] );
|
2010-01-11 15:55:52 +00:00
|
|
|
$this->fld_talkid = isset( $prop['talkid'] );
|
|
|
|
|
$this->fld_subjectid = isset( $prop['subjectid'] );
|
|
|
|
|
$this->fld_url = isset( $prop['url'] );
|
|
|
|
|
$this->fld_readable = isset( $prop['readable'] );
|
2010-02-24 14:45:19 +00:00
|
|
|
$this->fld_preload = isset( $prop['preload'] );
|
2010-07-22 07:00:38 +00:00
|
|
|
$this->fld_displaytitle = isset( $prop['displaytitle'] );
|
2007-06-18 02:00:23 +00:00
|
|
|
}
|
2008-04-14 07:45:50 +00:00
|
|
|
|
2006-10-01 20:17:16 +00:00
|
|
|
$pageSet = $this->getPageSet();
|
2009-02-13 14:44:19 +00:00
|
|
|
$this->titles = $pageSet->getGoodTitles();
|
|
|
|
|
$this->missing = $pageSet->getMissingTitles();
|
2009-02-13 15:14:21 +00:00
|
|
|
$this->everything = $this->titles + $this->missing;
|
2006-10-25 03:54:56 +00:00
|
|
|
$result = $this->getResult();
|
2006-09-26 01:44:13 +00:00
|
|
|
|
2010-01-11 15:55:52 +00:00
|
|
|
uasort( $this->everything, array( 'Title', 'compare' ) );
|
2010-02-24 14:45:19 +00:00
|
|
|
if ( !is_null( $this->params['continue'] ) ) {
|
2009-02-13 15:36:32 +00:00
|
|
|
// Throw away any titles we're gonna skip so they don't
|
|
|
|
|
// clutter queries
|
2010-01-11 15:55:52 +00:00
|
|
|
$cont = explode( '|', $this->params['continue'] );
|
2010-02-24 14:45:19 +00:00
|
|
|
if ( count( $cont ) != 2 ) {
|
|
|
|
|
$this->dieUsage( 'Invalid continue param. You should pass the original ' .
|
|
|
|
|
'value returned by the previous query', '_badcontinue' );
|
|
|
|
|
}
|
2010-01-11 15:55:52 +00:00
|
|
|
$conttitle = Title::makeTitleSafe( $cont[0], $cont[1] );
|
2010-02-24 14:45:19 +00:00
|
|
|
foreach ( $this->everything as $pageid => $title ) {
|
|
|
|
|
if ( Title::compare( $title, $conttitle ) >= 0 ) {
|
2009-02-13 15:36:32 +00:00
|
|
|
break;
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
2010-01-11 15:55:52 +00:00
|
|
|
unset( $this->titles[$pageid] );
|
|
|
|
|
unset( $this->missing[$pageid] );
|
|
|
|
|
unset( $this->everything[$pageid] );
|
2009-02-13 15:36:32 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2010-01-11 15:55:52 +00:00
|
|
|
$this->pageRestrictions = $pageSet->getCustomField( 'page_restrictions' );
|
2012-07-08 15:09:04 +00:00
|
|
|
// when resolving redirects, no page will have this field
|
|
|
|
|
$this->pageIsRedir = !$pageSet->isResolvingRedirects()
|
|
|
|
|
? $pageSet->getCustomField( 'page_is_redirect' )
|
|
|
|
|
: array();
|
2010-01-11 15:55:52 +00:00
|
|
|
$this->pageIsNew = $pageSet->getCustomField( 'page_is_new' );
|
2010-11-04 13:10:38 +00:00
|
|
|
|
2010-11-05 22:24:07 +00:00
|
|
|
global $wgDisableCounters;
|
2010-11-04 13:10:38 +00:00
|
|
|
|
2010-11-05 22:24:07 +00:00
|
|
|
if ( !$wgDisableCounters ) {
|
2010-11-04 13:10:38 +00:00
|
|
|
$this->pageCounter = $pageSet->getCustomField( 'page_counter' );
|
|
|
|
|
}
|
2010-01-11 15:55:52 +00:00
|
|
|
$this->pageTouched = $pageSet->getCustomField( 'page_touched' );
|
|
|
|
|
$this->pageLatest = $pageSet->getCustomField( 'page_latest' );
|
|
|
|
|
$this->pageLength = $pageSet->getCustomField( 'page_len' );
|
2006-10-01 20:17:16 +00:00
|
|
|
|
2009-02-13 14:44:19 +00:00
|
|
|
// Get protection info if requested
|
2010-02-24 14:45:19 +00:00
|
|
|
if ( $this->fld_protection ) {
|
2009-02-13 14:44:19 +00:00
|
|
|
$this->getProtectionInfo();
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
2007-06-18 02:00:23 +00:00
|
|
|
|
2012-06-18 20:33:19 +00:00
|
|
|
if ( $this->fld_watched || $this->fld_notificationtimestamp ) {
|
2009-11-19 17:57:27 +00:00
|
|
|
$this->getWatchedInfo();
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
2009-11-19 17:57:27 +00:00
|
|
|
|
2009-02-13 14:44:19 +00:00
|
|
|
// Run the talkid/subjectid query if requested
|
2010-02-24 14:45:19 +00:00
|
|
|
if ( $this->fld_talkid || $this->fld_subjectid ) {
|
2009-02-13 14:44:19 +00:00
|
|
|
$this->getTSIDs();
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
2010-07-23 07:33:40 +00:00
|
|
|
|
2010-07-22 08:48:34 +00:00
|
|
|
if ( $this->fld_displaytitle ) {
|
|
|
|
|
$this->getDisplayTitle();
|
|
|
|
|
}
|
2009-02-13 14:44:19 +00:00
|
|
|
|
2010-01-11 15:55:52 +00:00
|
|
|
foreach ( $this->everything as $pageid => $title ) {
|
|
|
|
|
$pageInfo = $this->extractPageInfo( $pageid, $title );
|
2010-02-24 14:45:19 +00:00
|
|
|
$fit = $result->addValue( array(
|
2009-02-13 14:44:19 +00:00
|
|
|
'query',
|
|
|
|
|
'pages'
|
2010-01-11 15:55:52 +00:00
|
|
|
), $pageid, $pageInfo );
|
2010-02-24 14:45:19 +00:00
|
|
|
if ( !$fit ) {
|
2010-01-11 15:55:52 +00:00
|
|
|
$this->setContinueEnumParameter( 'continue',
|
2009-02-13 15:36:32 +00:00
|
|
|
$title->getNamespace() . '|' .
|
2010-01-11 15:55:52 +00:00
|
|
|
$title->getText() );
|
2009-02-13 14:44:19 +00:00
|
|
|
break;
|
2008-05-04 15:10:58 +00:00
|
|
|
}
|
2007-06-18 02:00:23 +00:00
|
|
|
}
|
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 $pageid int Page ID (negative for missing titles)
|
|
|
|
|
* @param $title Title object
|
|
|
|
|
* @return array
|
|
|
|
|
*/
|
2010-02-24 14:45:19 +00:00
|
|
|
private function extractPageInfo( $pageid, $title ) {
|
2009-02-13 14:44:19 +00:00
|
|
|
$pageInfo = array();
|
2012-06-08 09:02:46 +00:00
|
|
|
$titleExists = $pageid > 0; //$title->exists() needs pageid, which is not set for all title objects
|
|
|
|
|
$ns = $title->getNamespace();
|
|
|
|
|
$dbkey = $title->getDBkey();
|
|
|
|
|
if ( $titleExists ) {
|
2010-11-05 22:24:07 +00:00
|
|
|
global $wgDisableCounters;
|
2010-11-04 13:10:38 +00:00
|
|
|
|
2010-01-11 15:55:52 +00:00
|
|
|
$pageInfo['touched'] = wfTimestamp( TS_ISO_8601, $this->pageTouched[$pageid] );
|
|
|
|
|
$pageInfo['lastrevid'] = intval( $this->pageLatest[$pageid] );
|
2010-11-05 22:24:07 +00:00
|
|
|
$pageInfo['counter'] = $wgDisableCounters
|
2010-11-04 13:10:38 +00:00
|
|
|
? ""
|
|
|
|
|
: intval( $this->pageCounter[$pageid] );
|
2010-01-11 15:55:52 +00:00
|
|
|
$pageInfo['length'] = intval( $this->pageLength[$pageid] );
|
2010-07-22 07:00:38 +00:00
|
|
|
|
2012-07-08 15:09:04 +00:00
|
|
|
if ( isset( $this->pageIsRedir[$pageid] ) && $this->pageIsRedir[$pageid] ) {
|
2009-02-13 14:44:19 +00:00
|
|
|
$pageInfo['redirect'] = '';
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
|
|
|
|
if ( $this->pageIsNew[$pageid] ) {
|
2009-02-13 14:44:19 +00:00
|
|
|
$pageInfo['new'] = '';
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
2008-01-08 16:31:50 +00:00
|
|
|
}
|
2008-04-14 07:45:50 +00:00
|
|
|
|
2010-01-11 15:55:52 +00:00
|
|
|
if ( !is_null( $this->params['token'] ) ) {
|
2009-02-13 14:44:19 +00:00
|
|
|
$tokenFunctions = $this->getTokenFunctions();
|
2010-01-11 15:55:52 +00:00
|
|
|
$pageInfo['starttimestamp'] = wfTimestamp( TS_ISO_8601, time() );
|
2010-02-24 14:45:19 +00:00
|
|
|
foreach ( $this->params['token'] as $t ) {
|
2010-01-11 15:55:52 +00:00
|
|
|
$val = call_user_func( $tokenFunctions[$t], $pageid, $title );
|
2010-02-24 14:45:19 +00:00
|
|
|
if ( $val === false ) {
|
2010-01-11 15:55:52 +00:00
|
|
|
$this->setWarning( "Action '$t' is not allowed for the current user" );
|
2010-02-24 14:45:19 +00:00
|
|
|
} else {
|
2009-02-13 14:44:19 +00:00
|
|
|
$pageInfo[$t . 'token'] = $val;
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
2008-03-25 15:31:24 +00:00
|
|
|
}
|
|
|
|
|
}
|
2008-01-08 16:31:50 +00:00
|
|
|
|
2010-01-11 15:55:52 +00:00
|
|
|
if ( $this->fld_protection ) {
|
2009-02-13 14:44:19 +00:00
|
|
|
$pageInfo['protection'] = array();
|
2012-06-08 09:02:46 +00:00
|
|
|
if ( isset( $this->protections[$ns][$dbkey] ) ) {
|
2009-02-13 14:44:19 +00:00
|
|
|
$pageInfo['protection'] =
|
2012-06-08 09:02:46 +00:00
|
|
|
$this->protections[$ns][$dbkey];
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
2010-01-11 15:55:52 +00:00
|
|
|
$this->getResult()->setIndexedTagName( $pageInfo['protection'], 'pr' );
|
2009-02-13 14:44:19 +00:00
|
|
|
}
|
2010-01-23 22:47:49 +00:00
|
|
|
|
2012-06-08 09:02:46 +00:00
|
|
|
if ( $this->fld_watched && isset( $this->watched[$ns][$dbkey] ) ) {
|
2009-11-19 17:57:27 +00:00
|
|
|
$pageInfo['watched'] = '';
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
|
|
|
|
|
2012-06-18 20:33:19 +00:00
|
|
|
if ( $this->fld_notificationtimestamp ) {
|
|
|
|
|
$pageInfo['notificationtimestamp'] = '';
|
|
|
|
|
if ( isset( $this->notificationtimestamps[$ns][$dbkey] ) ) {
|
|
|
|
|
$pageInfo['notificationtimestamp'] = wfTimestamp( TS_ISO_8601, $this->notificationtimestamps[$ns][$dbkey] );
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2012-10-26 16:18:59 +00:00
|
|
|
if ( $this->fld_talkid && isset( $this->talkids[$ns][$dbkey] ) ) {
|
2012-06-08 09:02:46 +00:00
|
|
|
$pageInfo['talkid'] = $this->talkids[$ns][$dbkey];
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
2010-01-23 22:47:49 +00:00
|
|
|
|
2012-06-08 09:02:46 +00:00
|
|
|
if ( $this->fld_subjectid && isset( $this->subjectids[$ns][$dbkey] ) ) {
|
|
|
|
|
$pageInfo['subjectid'] = $this->subjectids[$ns][$dbkey];
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
2010-01-23 22:47:49 +00:00
|
|
|
|
2010-01-11 15:55:52 +00:00
|
|
|
if ( $this->fld_url ) {
|
2011-08-19 15:46:08 +00:00
|
|
|
$pageInfo['fullurl'] = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT );
|
|
|
|
|
$pageInfo['editurl'] = wfExpandUrl( $title->getFullURL( 'action=edit' ), PROTO_CURRENT );
|
2009-02-13 14:44:19 +00:00
|
|
|
}
|
2012-09-22 11:33:33 +00:00
|
|
|
if ( $this->fld_readable && $title->userCan( 'read', $this->getUser() ) ) {
|
2009-11-19 17:57:27 +00:00
|
|
|
$pageInfo['readable'] = '';
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
|
|
|
|
|
2010-01-31 22:06:02 +00:00
|
|
|
if ( $this->fld_preload ) {
|
2012-06-08 09:02:46 +00:00
|
|
|
if ( $titleExists ) {
|
2010-01-31 22:06:02 +00:00
|
|
|
$pageInfo['preload'] = '';
|
2010-02-24 14:45:19 +00:00
|
|
|
} else {
|
2010-07-22 07:00:38 +00:00
|
|
|
$text = null;
|
2010-01-31 22:06:02 +00:00
|
|
|
wfRunHooks( 'EditFormPreloadText', array( &$text, &$title ) );
|
2010-02-24 14:45:19 +00:00
|
|
|
|
2010-01-31 22:06:02 +00:00
|
|
|
$pageInfo['preload'] = $text;
|
|
|
|
|
}
|
2010-02-13 01:41:37 +00:00
|
|
|
}
|
2010-07-23 07:33:40 +00:00
|
|
|
|
2010-07-22 07:00:38 +00:00
|
|
|
if ( $this->fld_displaytitle ) {
|
2012-06-08 09:02:46 +00:00
|
|
|
if ( isset( $this->displaytitles[$pageid] ) ) {
|
|
|
|
|
$pageInfo['displaytitle'] = $this->displaytitles[$pageid];
|
2010-07-22 08:48:34 +00:00
|
|
|
} else {
|
2010-07-22 10:18:41 +00:00
|
|
|
$pageInfo['displaytitle'] = $title->getPrefixedText();
|
2010-07-22 08:48:34 +00:00
|
|
|
}
|
2010-07-22 07:00:38 +00:00
|
|
|
}
|
2010-07-22 08:48:34 +00:00
|
|
|
|
2009-02-13 14:44:19 +00:00
|
|
|
return $pageInfo;
|
|
|
|
|
}
|
2006-09-26 01:44:13 +00:00
|
|
|
|
2009-02-13 14:44:19 +00:00
|
|
|
/**
|
|
|
|
|
* Get information about protections and put it in $protections
|
|
|
|
|
*/
|
2010-02-24 14:45:19 +00:00
|
|
|
private function getProtectionInfo() {
|
2011-03-18 19:15:56 +00:00
|
|
|
global $wgContLang;
|
2009-02-13 14:44:19 +00:00
|
|
|
$this->protections = array();
|
|
|
|
|
$db = $this->getDB();
|
2007-05-19 20:26:08 +00:00
|
|
|
|
2009-02-13 14:44:19 +00:00
|
|
|
// Get normal protections for existing titles
|
2010-02-24 14:45:19 +00:00
|
|
|
if ( count( $this->titles ) ) {
|
2009-12-02 12:28:27 +00:00
|
|
|
$this->resetQueryParams();
|
2012-06-17 16:46:21 +00:00
|
|
|
$this->addTables( 'page_restrictions' );
|
2010-01-11 15:55:52 +00:00
|
|
|
$this->addFields( array( 'pr_page', 'pr_type', 'pr_level',
|
2012-06-17 16:46:21 +00:00
|
|
|
'pr_expiry', 'pr_cascade' ) );
|
2010-01-11 15:55:52 +00:00
|
|
|
$this->addWhereFld( 'pr_page', array_keys( $this->titles ) );
|
2009-02-13 15:36:32 +00:00
|
|
|
|
2010-01-11 15:55:52 +00:00
|
|
|
$res = $this->select( __METHOD__ );
|
2010-06-20 18:48:34 +00:00
|
|
|
foreach ( $res as $row ) {
|
2012-06-17 16:46:21 +00:00
|
|
|
$title = $this->titles[$row->pr_page];
|
2009-02-13 15:36:32 +00:00
|
|
|
$a = array(
|
|
|
|
|
'type' => $row->pr_type,
|
|
|
|
|
'level' => $row->pr_level,
|
2011-03-18 19:15:56 +00:00
|
|
|
'expiry' => $wgContLang->formatExpiry( $row->pr_expiry, TS_ISO_8601 )
|
2009-02-13 15:36:32 +00:00
|
|
|
);
|
2010-02-24 14:45:19 +00:00
|
|
|
if ( $row->pr_cascade ) {
|
2009-02-13 15:36:32 +00:00
|
|
|
$a['cascade'] = '';
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
2012-06-17 16:46:21 +00:00
|
|
|
$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] ) );
|
2010-01-11 15:55:52 +00:00
|
|
|
foreach ( $restrictions as $restrict ) {
|
|
|
|
|
$temp = explode( '=', trim( $restrict ) );
|
|
|
|
|
if ( count( $temp ) == 1 ) {
|
2009-02-13 15:36:32 +00:00
|
|
|
// old old format should be treated as edit/move restriction
|
2010-01-11 15:55:52 +00:00
|
|
|
$restriction = trim( $temp[0] );
|
2009-02-13 15:36:32 +00:00
|
|
|
|
2010-02-24 14:45:19 +00:00
|
|
|
if ( $restriction == '' ) {
|
2009-02-13 15:36:32 +00:00
|
|
|
continue;
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
2012-06-17 16:46:21 +00:00
|
|
|
$this->protections[$namespace][$dbKey][] = array(
|
2009-02-13 15:36:32 +00:00
|
|
|
'type' => 'edit',
|
|
|
|
|
'level' => $restriction,
|
|
|
|
|
'expiry' => 'infinity',
|
|
|
|
|
);
|
2012-06-17 16:46:21 +00:00
|
|
|
$this->protections[$namespace][$dbKey][] = array(
|
2009-02-13 15:36:32 +00:00
|
|
|
'type' => 'move',
|
|
|
|
|
'level' => $restriction,
|
|
|
|
|
'expiry' => 'infinity',
|
|
|
|
|
);
|
|
|
|
|
} else {
|
2010-01-11 15:55:52 +00:00
|
|
|
$restriction = trim( $temp[1] );
|
2010-02-24 14:45:19 +00:00
|
|
|
if ( $restriction == '' ) {
|
2009-02-13 15:36:32 +00:00
|
|
|
continue;
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
2012-06-17 16:46:21 +00:00
|
|
|
$this->protections[$namespace][$dbKey][] = array(
|
2009-02-13 15:36:32 +00:00
|
|
|
'type' => $temp[0],
|
|
|
|
|
'level' => $restriction,
|
|
|
|
|
'expiry' => 'infinity',
|
|
|
|
|
);
|
|
|
|
|
}
|
2009-02-13 14:44:19 +00:00
|
|
|
}
|
2008-07-04 12:07:02 +00:00
|
|
|
}
|
2007-08-01 22:46:22 +00:00
|
|
|
}
|
2009-02-13 14:44:19 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Get protections for missing titles
|
2010-02-24 14:45:19 +00:00
|
|
|
if ( count( $this->missing ) ) {
|
2009-02-13 15:36:32 +00:00
|
|
|
$this->resetQueryParams();
|
2010-01-11 15:55:52 +00:00
|
|
|
$lb = new LinkBatch( $this->missing );
|
|
|
|
|
$this->addTables( 'protected_titles' );
|
|
|
|
|
$this->addFields( array( 'pt_title', 'pt_namespace', 'pt_create_perm', 'pt_expiry' ) );
|
|
|
|
|
$this->addWhere( $lb->constructSet( 'pt', $db ) );
|
|
|
|
|
$res = $this->select( __METHOD__ );
|
2010-06-20 18:48:34 +00:00
|
|
|
foreach ( $res as $row ) {
|
2009-02-13 15:36:32 +00:00
|
|
|
$this->protections[$row->pt_namespace][$row->pt_title][] = array(
|
|
|
|
|
'type' => 'create',
|
|
|
|
|
'level' => $row->pt_create_perm,
|
2011-03-18 19:15:56 +00:00
|
|
|
'expiry' => $wgContLang->formatExpiry( $row->pt_expiry, TS_ISO_8601 )
|
2009-02-13 15:36:32 +00:00
|
|
|
);
|
|
|
|
|
}
|
2009-02-13 14:44:19 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Cascading protections
|
|
|
|
|
$images = $others = array();
|
2010-06-13 01:23:12 +00:00
|
|
|
foreach ( $this->everything as $title ) {
|
2010-02-24 14:45:19 +00:00
|
|
|
if ( $title->getNamespace() == NS_FILE ) {
|
2009-05-24 08:29:10 +00:00
|
|
|
$images[] = $title->getDBkey();
|
2010-02-24 14:45:19 +00:00
|
|
|
} else {
|
2009-02-13 14:44:19 +00:00
|
|
|
$others[] = $title;
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
2010-06-13 01:23:12 +00:00
|
|
|
}
|
2009-02-13 14:44:19 +00:00
|
|
|
|
2010-01-11 15:55:52 +00:00
|
|
|
if ( count( $others ) ) {
|
2009-02-13 14:44:19 +00:00
|
|
|
// Non-images: check templatelinks
|
2010-01-11 15:55:52 +00:00
|
|
|
$lb = new LinkBatch( $others );
|
2009-02-13 14:44:19 +00:00
|
|
|
$this->resetQueryParams();
|
2010-01-11 15:55:52 +00:00
|
|
|
$this->addTables( array( 'page_restrictions', 'page', 'templatelinks' ) );
|
|
|
|
|
$this->addFields( array( 'pr_type', 'pr_level', 'pr_expiry',
|
2009-02-13 14:44:19 +00:00
|
|
|
'page_title', 'page_namespace',
|
2010-01-11 15:55:52 +00:00
|
|
|
'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__ );
|
2010-06-20 18:48:34 +00:00
|
|
|
foreach ( $res as $row ) {
|
2010-01-11 15:55:52 +00:00
|
|
|
$source = Title::makeTitle( $row->page_namespace, $row->page_title );
|
2009-02-13 15:14:21 +00:00
|
|
|
$this->protections[$row->tl_namespace][$row->tl_title][] = array(
|
2009-02-13 14:44:19 +00:00
|
|
|
'type' => $row->pr_type,
|
|
|
|
|
'level' => $row->pr_level,
|
2011-03-18 19:15:56 +00:00
|
|
|
'expiry' => $wgContLang->formatExpiry( $row->pr_expiry, TS_ISO_8601 ),
|
2009-02-13 14:44:19 +00:00
|
|
|
'source' => $source->getPrefixedText()
|
|
|
|
|
);
|
2008-09-25 15:55:09 +00:00
|
|
|
}
|
2009-02-13 14:44:19 +00:00
|
|
|
}
|
2007-06-18 02:00:23 +00:00
|
|
|
|
2010-01-11 15:55:52 +00:00
|
|
|
if ( count( $images ) ) {
|
2009-02-13 14:44:19 +00:00
|
|
|
// Images: check imagelinks
|
|
|
|
|
$this->resetQueryParams();
|
2010-01-11 15:55:52 +00:00
|
|
|
$this->addTables( array( 'page_restrictions', 'page', 'imagelinks' ) );
|
|
|
|
|
$this->addFields( array( '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__ );
|
2010-06-20 18:48:34 +00:00
|
|
|
foreach ( $res as $row ) {
|
2010-01-11 15:55:52 +00:00
|
|
|
$source = Title::makeTitle( $row->page_namespace, $row->page_title );
|
2009-02-13 14:44:19 +00:00
|
|
|
$this->protections[NS_FILE][$row->il_to][] = array(
|
|
|
|
|
'type' => $row->pr_type,
|
|
|
|
|
'level' => $row->pr_level,
|
2011-03-18 19:15:56 +00:00
|
|
|
'expiry' => $wgContLang->formatExpiry( $row->pr_expiry, TS_ISO_8601 ),
|
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
|
|
|
}
|
2006-10-01 20:17:16 +00:00
|
|
|
}
|
2009-02-13 14:44:19 +00:00
|
|
|
}
|
2007-09-03 20:17:53 +00:00
|
|
|
|
2009-02-13 14:44:19 +00:00
|
|
|
/**
|
|
|
|
|
* Get talk page IDs (if requested) and subject page IDs (if requested)
|
2010-02-24 14:45:19 +00:00
|
|
|
* and put them in $talkids and $subjectids
|
2009-02-13 14:44:19 +00:00
|
|
|
*/
|
2010-02-24 14:45:19 +00:00
|
|
|
private function getTSIDs() {
|
2009-02-13 14:44:19 +00:00
|
|
|
$getTitles = $this->talkids = $this->subjectids = array();
|
2010-07-22 08:48:34 +00:00
|
|
|
|
2010-02-24 14:45:19 +00:00
|
|
|
foreach ( $this->everything as $t ) {
|
|
|
|
|
if ( MWNamespace::isTalk( $t->getNamespace() ) ) {
|
|
|
|
|
if ( $this->fld_subjectid ) {
|
2009-02-13 14:44:19 +00:00
|
|
|
$getTitles[] = $t->getSubjectPage();
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
|
|
|
|
} elseif ( $this->fld_talkid ) {
|
2009-02-13 14:44:19 +00:00
|
|
|
$getTitles[] = $t->getTalkPage();
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
2009-02-13 14:44:19 +00:00
|
|
|
}
|
2010-02-24 14:45:19 +00:00
|
|
|
if ( !count( $getTitles ) ) {
|
2009-02-13 14:44:19 +00:00
|
|
|
return;
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
2010-07-23 07:33:40 +00:00
|
|
|
|
2010-07-22 08:48:34 +00:00
|
|
|
$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
|
2010-01-11 15:55:52 +00:00
|
|
|
$lb = new LinkBatch( $getTitles );
|
2009-02-13 14:44:19 +00:00
|
|
|
$this->resetQueryParams();
|
2010-01-11 15:55:52 +00:00
|
|
|
$this->addTables( 'page' );
|
|
|
|
|
$this->addFields( array( 'page_title', 'page_namespace', 'page_id' ) );
|
|
|
|
|
$this->addWhere( $lb->constructSet( 'page', $db ) );
|
|
|
|
|
$res = $this->select( __METHOD__ );
|
2010-06-20 18:48:34 +00:00
|
|
|
foreach ( $res as $row ) {
|
2010-02-24 14:45:19 +00:00
|
|
|
if ( MWNamespace::isTalk( $row->page_namespace ) ) {
|
2010-01-11 15:55:52 +00:00
|
|
|
$this->talkids[MWNamespace::getSubject( $row->page_namespace )][$row->page_title] =
|
|
|
|
|
intval( $row->page_id );
|
2010-02-24 14:45:19 +00:00
|
|
|
} else {
|
2010-01-11 15:55:52 +00:00
|
|
|
$this->subjectids[MWNamespace::getTalk( $row->page_namespace )][$row->page_title] =
|
|
|
|
|
intval( $row->page_id );
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
2007-09-03 20:17:53 +00:00
|
|
|
}
|
2006-09-26 01:44:13 +00:00
|
|
|
}
|
2010-07-23 07:33:40 +00:00
|
|
|
|
2010-07-22 08:48:34 +00:00
|
|
|
private function getDisplayTitle() {
|
2010-07-22 10:18:41 +00:00
|
|
|
$this->displaytitles = array();
|
2010-07-23 07:33:40 +00:00
|
|
|
|
2010-07-22 10:18:41 +00:00
|
|
|
$pageIds = array_keys( $this->titles );
|
2010-07-23 07:33:40 +00:00
|
|
|
|
2010-07-22 08:48:34 +00:00
|
|
|
if ( !count( $pageIds ) ) {
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
$this->resetQueryParams();
|
|
|
|
|
$this->addTables( 'page_props' );
|
|
|
|
|
$this->addFields( array( 'pp_page', 'pp_value' ) );
|
|
|
|
|
$this->addWhereFld( 'pp_page', $pageIds );
|
|
|
|
|
$this->addWhereFld( 'pp_propname', 'displaytitle' );
|
|
|
|
|
$res = $this->select( __METHOD__ );
|
2010-07-23 07:33:40 +00:00
|
|
|
|
2010-07-22 08:48:34 +00:00
|
|
|
foreach ( $res as $row ) {
|
|
|
|
|
$this->displaytitles[$row->pp_page] = $row->pp_value;
|
|
|
|
|
}
|
|
|
|
|
}
|
2006-09-26 01:44:13 +00:00
|
|
|
|
2009-11-19 17:57:27 +00:00
|
|
|
/**
|
2010-07-14 19:00:54 +00:00
|
|
|
* Get information about watched status and put it in $this->watched
|
2012-06-18 20:33:19 +00:00
|
|
|
* and $this->notificationtimestamps
|
2009-12-02 12:28:27 +00:00
|
|
|
*/
|
2010-02-24 14:45:19 +00:00
|
|
|
private function getWatchedInfo() {
|
2011-10-26 23:27:01 +00:00
|
|
|
$user = $this->getUser();
|
2009-11-19 17:57:27 +00:00
|
|
|
|
2011-10-26 23:27:01 +00:00
|
|
|
if ( $user->isAnon() || count( $this->everything ) == 0 ) {
|
2009-11-19 17:57:27 +00:00
|
|
|
return;
|
2010-02-24 14:45:19 +00:00
|
|
|
}
|
2009-11-19 17:57:27 +00:00
|
|
|
|
|
|
|
|
$this->watched = array();
|
2012-06-18 20:33:19 +00:00
|
|
|
$this->notificationtimestamps = array();
|
2009-11-19 17:57:27 +00:00
|
|
|
$db = $this->getDB();
|
|
|
|
|
|
2010-11-19 10:53:08 +00:00
|
|
|
$lb = new LinkBatch( $this->everything );
|
2009-11-19 17:57:27 +00:00
|
|
|
|
2009-12-02 12:28:27 +00:00
|
|
|
$this->resetQueryParams();
|
2010-11-19 10:53:08 +00:00
|
|
|
$this->addTables( array( 'watchlist' ) );
|
|
|
|
|
$this->addFields( array( 'wl_title', 'wl_namespace' ) );
|
2012-06-18 20:33:19 +00:00
|
|
|
$this->addFieldsIf( 'wl_notificationtimestamp', $this->fld_notificationtimestamp );
|
2010-01-11 15:55:52 +00:00
|
|
|
$this->addWhere( array(
|
2010-11-19 10:53:08 +00:00
|
|
|
$lb->constructSet( 'wl', $db ),
|
2011-10-26 23:27:01 +00:00
|
|
|
'wl_user' => $user->getID()
|
2010-01-11 15:55:52 +00:00
|
|
|
) );
|
2009-11-19 17:57:27 +00:00
|
|
|
|
2010-01-11 15:55:52 +00:00
|
|
|
$res = $this->select( __METHOD__ );
|
2009-11-19 17:57:27 +00:00
|
|
|
|
2010-06-20 18:48:34 +00:00
|
|
|
foreach ( $res as $row ) {
|
2012-06-18 20:33:19 +00:00
|
|
|
if ( $this->fld_watched ) {
|
|
|
|
|
$this->watched[$row->wl_namespace][$row->wl_title] = true;
|
|
|
|
|
}
|
|
|
|
|
if ( $this->fld_notificationtimestamp ) {
|
|
|
|
|
$this->notificationtimestamps[$row->wl_namespace][$row->wl_title] = $row->wl_notificationtimestamp;
|
|
|
|
|
}
|
2009-11-19 17:57:27 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2010-07-23 07:17:56 +00:00
|
|
|
public function getCacheMode( $params ) {
|
|
|
|
|
$publicProps = array(
|
|
|
|
|
'protection',
|
|
|
|
|
'talkid',
|
|
|
|
|
'subjectid',
|
|
|
|
|
'url',
|
|
|
|
|
'preload',
|
|
|
|
|
'displaytitle',
|
|
|
|
|
);
|
|
|
|
|
if ( !is_null( $params['prop'] ) ) {
|
|
|
|
|
foreach ( $params['prop'] as $prop ) {
|
|
|
|
|
if ( !in_array( $prop, $publicProps ) ) {
|
|
|
|
|
return 'private';
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
if ( !is_null( $params['token'] ) ) {
|
|
|
|
|
return 'private';
|
|
|
|
|
}
|
|
|
|
|
return 'public';
|
|
|
|
|
}
|
|
|
|
|
|
2008-01-28 19:05:26 +00:00
|
|
|
public function getAllowedParams() {
|
2010-02-24 14:45:19 +00:00
|
|
|
return array(
|
|
|
|
|
'prop' => array(
|
|
|
|
|
ApiBase::PARAM_DFLT => null,
|
|
|
|
|
ApiBase::PARAM_ISMULTI => true,
|
|
|
|
|
ApiBase::PARAM_TYPE => array(
|
2008-03-25 15:31:24 +00:00
|
|
|
'protection',
|
|
|
|
|
'talkid',
|
2010-07-23 07:17:56 +00:00
|
|
|
'watched', # private
|
2012-06-18 20:33:19 +00:00
|
|
|
'notificationtimestamp', # private
|
2008-09-25 15:55:09 +00:00
|
|
|
'subjectid',
|
|
|
|
|
'url',
|
2010-07-23 07:17:56 +00:00
|
|
|
'readable', # private
|
2010-07-22 08:48:34 +00:00
|
|
|
'preload',
|
|
|
|
|
'displaytitle',
|
2010-07-23 07:33:40 +00:00
|
|
|
// If you add more properties here, please consider whether they
|
2010-07-23 07:17:56 +00:00
|
|
|
// need to be added to getCacheMode()
|
2010-01-11 15:55:52 +00:00
|
|
|
) ),
|
2010-02-24 14:45:19 +00:00
|
|
|
'token' => array(
|
|
|
|
|
ApiBase::PARAM_DFLT => null,
|
|
|
|
|
ApiBase::PARAM_ISMULTI => true,
|
|
|
|
|
ApiBase::PARAM_TYPE => array_keys( $this->getTokenFunctions() )
|
* 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
|
|
|
),
|
|
|
|
|
'continue' => null,
|
2007-06-18 02:00:23 +00:00
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
|
2008-01-28 19:05:26 +00:00
|
|
|
public function getParamDescription() {
|
2010-02-24 14:45:19 +00:00
|
|
|
return array(
|
|
|
|
|
'prop' => array(
|
2007-06-18 02:00:23 +00:00
|
|
|
'Which additional properties to get:',
|
2012-06-18 20:33:19 +00:00
|
|
|
' protection - List the protection level of each page',
|
|
|
|
|
' talkid - The page ID of the talk page for each non-talk page',
|
|
|
|
|
' watched - List the watched status of each page',
|
|
|
|
|
' notificationtimestamp - The watchlist notification timestamp of each page',
|
|
|
|
|
' subjectid - The page ID of the parent page for each talk page',
|
|
|
|
|
' url - Gives a full URL to the page, and also an edit URL',
|
|
|
|
|
' readable - Whether the user can read this page',
|
|
|
|
|
' preload - Gives the text returned by EditFormPreloadText',
|
|
|
|
|
' displaytitle - Gives the way the page title is actually displayed',
|
2007-08-01 22:46:22 +00:00
|
|
|
),
|
|
|
|
|
'token' => 'Request a token to perform a data-modifying action on a page',
|
* 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
|
|
|
'continue' => 'When more results are available, use this to continue',
|
2007-06-18 02:00:23 +00:00
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
|
Added result properties to action=paraminfo
Added information about the properties of the results of API calls
to action=paraminfo, including information about "property groups":
what should the prop parameter be set to to get that property.
Uses the same format for types as parameters already do.
The output format of some modules doesn't fit this, so the result
properties for them weren't added, or only partially.
Partially implemented modules:
* expandtemplates:
parsetree is in its own tag
* protect, allusers, backlinks, deletedrevs, info, imageinfo,
logevents, querypage, recentchanges, revisions, searchinfo,
usercontribs, userinfo, users, watchlist, upload:
response with partially complex structure
Not implemented modules:
* feedcontributions, feedwatchlist, opensearch, rds:
non-standard reponse
* help:
error is normal response; not very useful for automated tools anyway
* paraminfo, parse, pageprops, siteinfo, userrights:
response with complex structure
Change-Id: Iff2a9bef79f994e73eef3062b4dd5461bff968ab
2012-05-02 15:00:30 +00:00
|
|
|
public function getResultProperties() {
|
|
|
|
|
$props = array(
|
|
|
|
|
ApiBase::PROP_LIST => false,
|
|
|
|
|
'' => array(
|
|
|
|
|
'touched' => 'timestamp',
|
|
|
|
|
'lastrevid' => 'integer',
|
|
|
|
|
'counter' => array(
|
|
|
|
|
ApiBase::PROP_TYPE => 'integer',
|
|
|
|
|
ApiBase::PROP_NULLABLE => true
|
|
|
|
|
),
|
|
|
|
|
'length' => 'integer',
|
|
|
|
|
'redirect' => 'boolean',
|
|
|
|
|
'new' => 'boolean',
|
|
|
|
|
'starttimestamp' => array(
|
|
|
|
|
ApiBase::PROP_TYPE => 'timestamp',
|
|
|
|
|
ApiBase::PROP_NULLABLE => true
|
|
|
|
|
)
|
|
|
|
|
),
|
|
|
|
|
'watched' => array(
|
|
|
|
|
'watched' => 'boolean'
|
|
|
|
|
),
|
2012-06-18 20:33:19 +00:00
|
|
|
'notificationtimestamp' => array(
|
|
|
|
|
'notificationtimestamp' => array(
|
|
|
|
|
ApiBase::PROP_TYPE => 'timestamp',
|
|
|
|
|
ApiBase::PROP_NULLABLE => true
|
|
|
|
|
)
|
|
|
|
|
),
|
Added result properties to action=paraminfo
Added information about the properties of the results of API calls
to action=paraminfo, including information about "property groups":
what should the prop parameter be set to to get that property.
Uses the same format for types as parameters already do.
The output format of some modules doesn't fit this, so the result
properties for them weren't added, or only partially.
Partially implemented modules:
* expandtemplates:
parsetree is in its own tag
* protect, allusers, backlinks, deletedrevs, info, imageinfo,
logevents, querypage, recentchanges, revisions, searchinfo,
usercontribs, userinfo, users, watchlist, upload:
response with partially complex structure
Not implemented modules:
* feedcontributions, feedwatchlist, opensearch, rds:
non-standard reponse
* help:
error is normal response; not very useful for automated tools anyway
* paraminfo, parse, pageprops, siteinfo, userrights:
response with complex structure
Change-Id: Iff2a9bef79f994e73eef3062b4dd5461bff968ab
2012-05-02 15:00:30 +00:00
|
|
|
'talkid' => array(
|
|
|
|
|
'talkid' => array(
|
|
|
|
|
ApiBase::PROP_TYPE => 'integer',
|
|
|
|
|
ApiBase::PROP_NULLABLE => true
|
|
|
|
|
)
|
|
|
|
|
),
|
|
|
|
|
'subjectid' => array(
|
|
|
|
|
'subjectid' => array(
|
|
|
|
|
ApiBase::PROP_TYPE => 'integer',
|
|
|
|
|
ApiBase::PROP_NULLABLE => true
|
|
|
|
|
)
|
|
|
|
|
),
|
|
|
|
|
'url' => array(
|
|
|
|
|
'fullurl' => 'string',
|
|
|
|
|
'editurl' => 'string'
|
|
|
|
|
),
|
|
|
|
|
'readable' => array(
|
|
|
|
|
'readable' => 'boolean'
|
|
|
|
|
),
|
|
|
|
|
'preload' => array(
|
|
|
|
|
'preload' => 'string'
|
|
|
|
|
),
|
|
|
|
|
'displaytitle' => array(
|
|
|
|
|
'displaytitle' => 'string'
|
|
|
|
|
)
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
self::addTokenProperties( $props, $this->getTokenFunctions() );
|
|
|
|
|
|
|
|
|
|
return $props;
|
|
|
|
|
}
|
|
|
|
|
|
2008-01-28 19:05:26 +00:00
|
|
|
public function getDescription() {
|
2006-10-01 20:17:16 +00:00
|
|
|
return 'Get basic page information such as namespace, title, last touched date, ...';
|
2006-09-26 01:44:13 +00:00
|
|
|
}
|
2010-02-24 14:45:19 +00:00
|
|
|
|
2010-02-13 01:38:12 +00:00
|
|
|
public function getPossibleErrors() {
|
|
|
|
|
return array_merge( parent::getPossibleErrors(), array(
|
|
|
|
|
array( 'code' => '_badcontinue', 'info' => 'Invalid continue param. You should pass the original value returned by the previous query' ),
|
|
|
|
|
) );
|
|
|
|
|
}
|
2006-09-26 01:44:13 +00:00
|
|
|
|
2011-08-17 22:24:21 +00:00
|
|
|
public function getExamples() {
|
2010-02-24 14:45:19 +00:00
|
|
|
return array(
|
2007-06-18 02:00:23 +00:00
|
|
|
'api.php?action=query&prop=info&titles=Main%20Page',
|
2007-06-29 20:02:26 +00:00
|
|
|
'api.php?action=query&prop=info&inprop=protection&titles=Main%20Page'
|
2006-09-26 01:44:13 +00:00
|
|
|
);
|
|
|
|
|
}
|
2006-10-01 21:20:55 +00:00
|
|
|
|
2011-07-17 16:51:11 +00:00
|
|
|
public function getHelpUrls() {
|
2011-11-28 15:43:11 +00:00
|
|
|
return 'https://www.mediawiki.org/wiki/API:Properties#info_.2F_in';
|
2011-07-17 16:51:11 +00:00
|
|
|
}
|
|
|
|
|
|
2006-10-01 21:20:55 +00:00
|
|
|
public function getVersion() {
|
2007-12-06 18:33:18 +00:00
|
|
|
return __CLASS__ . ': $Id$';
|
2006-10-01 21:20:55 +00:00
|
|
|
}
|
2006-09-26 01:44:13 +00:00
|
|
|
}
|