From 9db190c7e736ec8d063187d4241b59feaf7dc2d1 Mon Sep 17 00:00:00 2001 From: Pierre Schmitz Date: Wed, 22 Jun 2011 11:28:20 +0200 Subject: update to MediaWiki 1.17.0 --- includes/api/ApiQueryBacklinks.php | 268 +++++++++++++++++++------------------ 1 file changed, 139 insertions(+), 129 deletions(-) (limited to 'includes/api/ApiQueryBacklinks.php') diff --git a/includes/api/ApiQueryBacklinks.php b/includes/api/ApiQueryBacklinks.php index 648da069..b412d2d6 100644 --- a/includes/api/ApiQueryBacklinks.php +++ b/includes/api/ApiQueryBacklinks.php @@ -1,11 +1,10 @@ @gmail.com + * Created on Oct 16, 2006 + * + * Copyright © 2006 Yuri Astrakhan @gmail.com * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -19,13 +18,15 @@ * * 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., - * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * http://www.gnu.org/copyleft/gpl.html + * + * @file */ if ( !defined( 'MEDIAWIKI' ) ) { // Eclipse helper - will be ignored in production - require_once ( "ApiQueryBase.php" ); + require_once( "ApiQueryBase.php" ); } /** @@ -38,23 +39,23 @@ if ( !defined( 'MEDIAWIKI' ) ) { */ class ApiQueryBacklinks extends ApiQueryGeneratorBase { - private $params, $rootTitle, $contRedirs, $contLevel, $contTitle, $contID, $redirID, $redirect; + private $params, $rootTitle, $contID, $redirID, $redirect; private $bl_ns, $bl_from, $bl_table, $bl_code, $bl_title, $bl_sort, $bl_fields, $hasNS; private $pageMap, $resultArr; // output element name, database column field prefix, database table - private $backlinksSettings = array ( - 'backlinks' => array ( + private $backlinksSettings = array( + 'backlinks' => array( 'code' => 'bl', 'prefix' => 'pl', 'linktbl' => 'pagelinks' ), - 'embeddedin' => array ( + 'embeddedin' => array( 'code' => 'ei', 'prefix' => 'tl', 'linktbl' => 'templatelinks' ), - 'imageusage' => array ( + 'imageusage' => array( 'code' => 'iu', 'prefix' => 'il', 'linktbl' => 'imagelinks' @@ -62,27 +63,29 @@ class ApiQueryBacklinks extends ApiQueryGeneratorBase { ); public function __construct( $query, $moduleName ) { - extract( $this->backlinksSettings[$moduleName] ); + $settings = $this->backlinksSettings[$moduleName]; + $prefix = $settings['prefix']; + $code = $settings['code']; $this->resultArr = array(); - parent :: __construct( $query, $moduleName, $code ); + parent::__construct( $query, $moduleName, $code ); $this->bl_ns = $prefix . '_namespace'; $this->bl_from = $prefix . '_from'; - $this->bl_table = $linktbl; + $this->bl_table = $settings['linktbl']; $this->bl_code = $code; $this->hasNS = $moduleName !== 'imageusage'; if ( $this->hasNS ) { $this->bl_title = $prefix . '_title'; $this->bl_sort = "{$this->bl_ns}, {$this->bl_title}, {$this->bl_from}"; - $this->bl_fields = array ( + $this->bl_fields = array( $this->bl_ns, $this->bl_title ); } else { $this->bl_title = $prefix . '_to'; $this->bl_sort = "{$this->bl_title}, {$this->bl_from}"; - $this->bl_fields = array ( + $this->bl_fields = array( $this->bl_title ); } @@ -106,29 +109,32 @@ class ApiQueryBacklinks extends ApiQueryGeneratorBase { * AND pl_title='Foo' AND pl_namespace=0 * LIMIT 11 ORDER BY pl_from */ - $db = $this->getDB(); $this->addTables( array( $this->bl_table, 'page' ) ); $this->addWhere( "{$this->bl_from}=page_id" ); - if ( is_null( $resultPageSet ) ) + if ( is_null( $resultPageSet ) ) { $this->addFields( array( 'page_id', 'page_title', 'page_namespace' ) ); - else + } else { $this->addFields( $resultPageSet->getPageTableFields() ); + } $this->addFields( 'page_is_redirect' ); $this->addWhereFld( $this->bl_title, $this->rootTitle->getDBkey() ); - if ( $this->hasNS ) + if ( $this->hasNS ) { $this->addWhereFld( $this->bl_ns, $this->rootTitle->getNamespace() ); + } $this->addWhereFld( 'page_namespace', $this->params['namespace'] ); - if ( !is_null( $this->contID ) ) + if ( !is_null( $this->contID ) ) { $this->addWhere( "{$this->bl_from}>={$this->contID}" ); + } - if ( $this->params['filterredir'] == 'redirects' ) + if ( $this->params['filterredir'] == 'redirects' ) { $this->addWhereFld( 'page_is_redirect', 1 ); - else if ( $this->params['filterredir'] == 'nonredirects' && !$this->redirect ) + } elseif ( $this->params['filterredir'] == 'nonredirects' && !$this->redirect ) { // bug 22245 - Check for !redirect, as filtering nonredirects, when getting what links to them is contradictory $this->addWhereFld( 'page_is_redirect', 0 ); + } $this->addOption( 'LIMIT', $this->params['limit'] + 1 ); $this->addOption( 'ORDER BY', $this->bl_from ); @@ -145,45 +151,48 @@ class ApiQueryBacklinks extends ApiQueryGeneratorBase { $this->addTables( array( 'page', $this->bl_table ) ); $this->addWhere( "{$this->bl_from}=page_id" ); - if ( is_null( $resultPageSet ) ) + if ( is_null( $resultPageSet ) ) { $this->addFields( array( 'page_id', 'page_title', 'page_namespace', 'page_is_redirect' ) ); - else + } else { $this->addFields( $resultPageSet->getPageTableFields() ); + } $this->addFields( $this->bl_title ); - if ( $this->hasNS ) + if ( $this->hasNS ) { $this->addFields( $this->bl_ns ); + } // We can't use LinkBatch here because $this->hasNS may be false $titleWhere = array(); - foreach ( $this->redirTitles as $t ) + foreach ( $this->redirTitles as $t ) { $titleWhere[] = "{$this->bl_title} = " . $db->addQuotes( $t->getDBkey() ) . - ( $this->hasNS ? " AND {$this->bl_ns} = '{$t->getNamespace()}'" : "" ); + ( $this->hasNS ? " AND {$this->bl_ns} = '{$t->getNamespace()}'" : '' ); + } $this->addWhere( $db->makeList( $titleWhere, LIST_OR ) ); $this->addWhereFld( 'page_namespace', $this->params['namespace'] ); - if ( !is_null( $this->redirID ) ) - { + if ( !is_null( $this->redirID ) ) { $first = $this->redirTitles[0]; $title = $db->strencode( $first->getDBkey() ); $ns = $first->getNamespace(); $from = $this->redirID; - if ( $this->hasNS ) + if ( $this->hasNS ) { $this->addWhere( "{$this->bl_ns} > $ns OR " . "({$this->bl_ns} = $ns AND " . "({$this->bl_title} > '$title' OR " . "({$this->bl_title} = '$title' AND " . "{$this->bl_from} >= $from)))" ); - else + } else { $this->addWhere( "{$this->bl_title} > '$title' OR " . "({$this->bl_title} = '$title' AND " . "{$this->bl_from} >= $from)" ); - + } } - if ( $this->params['filterredir'] == 'redirects' ) + if ( $this->params['filterredir'] == 'redirects' ) { $this->addWhereFld( 'page_is_redirect', 1 ); - else if ( $this->params['filterredir'] == 'nonredirects' ) + } elseif ( $this->params['filterredir'] == 'nonredirects' ) { $this->addWhereFld( 'page_is_redirect', 0 ); + } $this->addOption( 'LIMIT', $this->params['limit'] + 1 ); $this->addOption( 'ORDER BY', $this->bl_sort ); @@ -197,20 +206,19 @@ class ApiQueryBacklinks extends ApiQueryGeneratorBase { $botMax = ( $this->redirect ? ApiBase::LIMIT_BIG2 / 2 : ApiBase::LIMIT_BIG2 ); if ( $this->params['limit'] == 'max' ) { $this->params['limit'] = $this->getMain()->canApiHighLimits() ? $botMax : $userMax; - $this->getResult()->addValue( 'limits', $this->getModuleName(), $this->params['limit'] ); + $this->getResult()->setParsedLimit( $this->getModuleName(), $this->params['limit'] ); } $this->processContinue(); $this->prepareFirstQuery( $resultPageSet ); - $db = $this->getDB(); $res = $this->select( __METHOD__ . '::firstQuery' ); $count = 0; $this->pageMap = array(); // Maps ns and title to pageid $this->continueStr = null; $this->redirTitles = array(); - while ( $row = $db->fetchObject( $res ) ) { + foreach ( $res as $row ) { if ( ++ $count > $this->params['limit'] ) { // We've reached the one extra which shows that there are additional pages to be had. Stop here... // Continue string preserved in case the redirect query doesn't pass the limit @@ -218,93 +226,89 @@ class ApiQueryBacklinks extends ApiQueryGeneratorBase { break; } - if ( is_null( $resultPageSet ) ) + if ( is_null( $resultPageSet ) ) { $this->extractRowInfo( $row ); - else - { + } else { $this->pageMap[$row->page_namespace][$row->page_title] = $row->page_id; - if ( $row->page_is_redirect ) + if ( $row->page_is_redirect ) { $this->redirTitles[] = Title::makeTitle( $row->page_namespace, $row->page_title ); + } $resultPageSet->processDbRow( $row ); } } - $db->freeResult( $res ); - if ( $this->redirect && count( $this->redirTitles ) ) - { + if ( $this->redirect && count( $this->redirTitles ) ) { $this->resetQueryParams(); $this->prepareSecondQuery( $resultPageSet ); $res = $this->select( __METHOD__ . '::secondQuery' ); $count = 0; - while ( $row = $db->fetchObject( $res ) ) - { - if ( ++$count > $this->params['limit'] ) - { + foreach ( $res as $row ) { + if ( ++$count > $this->params['limit'] ) { // We've reached the one extra which shows that there are additional pages to be had. Stop here... // We need to keep the parent page of this redir in - if ( $this->hasNS ) - $parentID = $this->pageMap[$row-> { $this->bl_ns } ][$row-> { $this->bl_title } ]; - else - $parentID = $this->pageMap[NS_IMAGE][$row-> { $this->bl_title } ]; + if ( $this->hasNS ) { + $parentID = $this->pageMap[$row->{$this->bl_ns}][$row->{$this->bl_title}]; + } else { + $parentID = $this->pageMap[NS_IMAGE][$row->{$this->bl_title}]; + } $this->continueStr = $this->getContinueRedirStr( $parentID, $row->page_id ); break; } - if ( is_null( $resultPageSet ) ) + if ( is_null( $resultPageSet ) ) { $this->extractRedirRowInfo( $row ); - else + } else { $resultPageSet->processDbRow( $row ); + } } - $db->freeResult( $res ); } if ( is_null( $resultPageSet ) ) { // Try to add the result data in one go and pray that it fits $fit = $this->getResult()->addValue( 'query', $this->getModuleName(), array_values( $this->resultArr ) ); - if ( !$fit ) - { + if ( !$fit ) { // It didn't fit. Add elements one by one until the // result is full. - foreach ( $this->resultArr as $pageID => $arr ) - { + foreach ( $this->resultArr as $pageID => $arr ) { // Add the basic entry without redirlinks first $fit = $this->getResult()->addValue( array( 'query', $this->getModuleName() ), null, array_diff_key( $arr, array( 'redirlinks' => '' ) ) ); - if ( !$fit ) - { + if ( !$fit ) { $this->continueStr = $this->getContinueStr( $pageID ); break; } $hasRedirs = false; - foreach ( (array)@$arr['redirlinks'] as $key => $redir ) - { + foreach ( (array)@$arr['redirlinks'] as $key => $redir ) { $fit = $this->getResult()->addValue( array( 'query', $this->getModuleName(), $pageID, 'redirlinks' ), $key, $redir ); - if ( !$fit ) - { + if ( !$fit ) { $this->continueStr = $this->getContinueRedirStr( $pageID, $redir['pageid'] ); break; } $hasRedirs = true; } - if ( $hasRedirs ) + if ( $hasRedirs ) { $this->getResult()->setIndexedTagName_internal( array( 'query', $this->getModuleName(), $pageID, 'redirlinks' ), $this->bl_code ); - if ( !$fit ) + } + if ( !$fit ) { break; + } } } $this->getResult()->setIndexedTagName_internal( - array( 'query', $this->getModuleName() ), - $this->bl_code ); + array( 'query', $this->getModuleName() ), + $this->bl_code + ); } - if ( !is_null( $this->continueStr ) ) + if ( !is_null( $this->continueStr ) ) { $this->setContinueEnumParameter( 'continue', $this->continueStr ); + } } private function extractRowInfo( $row ) { @@ -312,8 +316,7 @@ class ApiQueryBacklinks extends ApiQueryGeneratorBase { $t = Title::makeTitle( $row->page_namespace, $row->page_title ); $a = array( 'pageid' => intval( $row->page_id ) ); ApiQueryBase::addTitleInfo( $a, $t ); - if ( $row->page_is_redirect ) - { + if ( $row->page_is_redirect ) { $a['redirect'] = ''; $this->redirTitles[] = $t; } @@ -321,12 +324,12 @@ class ApiQueryBacklinks extends ApiQueryGeneratorBase { $this->resultArr[$a['pageid']] = $a; } - private function extractRedirRowInfo( $row ) - { + private function extractRedirRowInfo( $row ) { $a['pageid'] = intval( $row->page_id ); ApiQueryBase::addTitleInfo( $a, Title::makeTitle( $row->page_namespace, $row->page_title ) ); - if ( $row->page_is_redirect ) + if ( $row->page_is_redirect ) { $a['redirect'] = ''; + } $ns = $this->hasNS ? $row-> { $this->bl_ns } : NS_FILE; $parentID = $this->pageMap[$ns][$row-> { $this->bl_title } ]; // Put all the results in an array first @@ -335,24 +338,23 @@ class ApiQueryBacklinks extends ApiQueryGeneratorBase { } protected function processContinue() { - if ( !is_null( $this->params['continue'] ) ) + if ( !is_null( $this->params['continue'] ) ) { $this->parseContinueParam(); - else { - if ( $this->params['title'] !== "" ) { + } else { + if ( $this->params['title'] !== '' ) { $title = Title::newFromText( $this->params['title'] ); if ( !$title ) { $this->dieUsageMsg( array( 'invalidtitle', $this->params['title'] ) ); } else { $this->rootTitle = $title; } - } else { - $this->dieUsageMsg( array( 'missingparam', 'title' ) ); } } // only image titles are allowed for the root in imageinfo mode - if ( !$this->hasNS && $this->rootTitle->getNamespace() !== NS_FILE ) + if ( !$this->hasNS && $this->rootTitle->getNamespace() !== NS_FILE ) { $this->dieUsage( "The title for {$this->getModuleName()} query must be an image", 'bad_image_title' ); + } } protected function parseContinueParam() { @@ -366,23 +368,27 @@ class ApiQueryBacklinks extends ApiQueryGeneratorBase { // null stuff out now so we know what's set and what isn't $this->rootTitle = $this->contID = $this->redirID = null; $rootNs = intval( $continueList[0] ); - if ( $rootNs === 0 && $continueList[0] !== '0' ) + if ( $rootNs === 0 && $continueList[0] !== '0' ) { // Illegal continue parameter - $this->dieUsage( "Invalid continue param. You should pass the original value returned by the previous query", "_badcontinue" ); + $this->dieUsage( 'Invalid continue param. You should pass the original value returned by the previous query', '_badcontinue' ); + } $this->rootTitle = Title::makeTitleSafe( $rootNs, $continueList[1] ); - if ( !$this->rootTitle ) - $this->dieUsage( "Invalid continue param. You should pass the original value returned by the previous query", "_badcontinue" ); + if ( !$this->rootTitle ) { + $this->dieUsage( 'Invalid continue param. You should pass the original value returned by the previous query', '_badcontinue' ); + } $contID = intval( $continueList[2] ); - if ( $contID === 0 && $continueList[2] !== '0' ) - $this->dieUsage( "Invalid continue param. You should pass the original value returned by the previous query", "_badcontinue" ); + if ( $contID === 0 && $continueList[2] !== '0' ) { + $this->dieUsage( 'Invalid continue param. You should pass the original value returned by the previous query', '_badcontinue' ); + } $this->contID = $contID; $redirID = intval( @$continueList[3] ); - - if ( $redirID === 0 && @$continueList[3] !== '0' ) + + if ( $redirID === 0 && @$continueList[3] !== '0' ) { // This one isn't required return; + } $this->redirID = $redirID; } @@ -398,88 +404,92 @@ class ApiQueryBacklinks extends ApiQueryGeneratorBase { } public function getAllowedParams() { - $retval = array ( - 'title' => null, + $retval = array( + 'title' => array( + ApiBase::PARAM_TYPE => 'string', + ApiBase::PARAM_REQUIRED => true + ), 'continue' => null, - 'namespace' => array ( - ApiBase :: PARAM_ISMULTI => true, - ApiBase :: PARAM_TYPE => 'namespace' + 'namespace' => array( + ApiBase::PARAM_ISMULTI => true, + ApiBase::PARAM_TYPE => 'namespace' ), 'filterredir' => array( - ApiBase :: PARAM_DFLT => 'all', - ApiBase :: PARAM_TYPE => array( + ApiBase::PARAM_DFLT => 'all', + ApiBase::PARAM_TYPE => array( 'all', 'redirects', 'nonredirects' ) ), - 'limit' => array ( - ApiBase :: PARAM_DFLT => 10, - ApiBase :: PARAM_TYPE => 'limit', - ApiBase :: PARAM_MIN => 1, - ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1, - ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2 + 'limit' => array( + ApiBase::PARAM_DFLT => 10, + ApiBase::PARAM_TYPE => 'limit', + ApiBase::PARAM_MIN => 1, + ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1, + ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2 ) ); - if ( $this->getModuleName() == 'embeddedin' ) + if ( $this->getModuleName() == 'embeddedin' ) { return $retval; + } $retval['redirect'] = false; return $retval; } public function getParamDescription() { - $retval = array ( - 'title' => 'Title to search.', - 'continue' => 'When more results are available, use this to continue.', - 'namespace' => 'The namespace to enumerate.', + $retval = array( + 'title' => 'Title to search', + 'continue' => 'When more results are available, use this to continue', + 'namespace' => 'The namespace to enumerate', ); - if ( $this->getModuleName() != 'embeddedin' ) + if ( $this->getModuleName() != 'embeddedin' ) { return array_merge( $retval, array( 'redirect' => 'If linking page is a redirect, find all pages that link to that redirect as well. Maximum limit is halved.', 'filterredir' => "How to filter for redirects. If set to nonredirects when {$this->bl_code}redirect is enabled, this is only applied to the second level", 'limit' => "How many total pages to return. If {$this->bl_code}redirect is enabled, limit applies to each level separately (which means you may get up to 2 * limit results)." ) ); + } return array_merge( $retval, array( 'filterredir' => 'How to filter for redirects', - 'limit' => 'How many total pages to return.' + 'limit' => 'How many total pages to return' ) ); } public function getDescription() { switch ( $this->getModuleName() ) { - case 'backlinks' : + case 'backlinks': return 'Find all pages that link to the given page'; - case 'embeddedin' : + case 'embeddedin': return 'Find all pages that embed (transclude) the given title'; - case 'imageusage' : + case 'imageusage': return 'Find all pages that use the given image title.'; - default : - ApiBase :: dieDebug( __METHOD__, 'Unknown module name' ); + default: + ApiBase::dieDebug( __METHOD__, 'Unknown module name' ); } } - + public function getPossibleErrors() { return array_merge( parent::getPossibleErrors(), array( array( 'invalidtitle', 'title' ), - array( 'missingparam', 'title' ), array( 'code' => 'bad_image_title', 'info' => "The title for {$this->getModuleName()} query must be an image" ), array( 'code' => '_badcontinue', 'info' => 'Invalid continue param. You should pass the original value returned by the previous query' ), ) ); } protected function getExamples() { - static $examples = array ( - 'backlinks' => array ( - "api.php?action=query&list=backlinks&bltitle=Main%20Page", - "api.php?action=query&generator=backlinks&gbltitle=Main%20Page&prop=info" + static $examples = array( + 'backlinks' => array( + 'api.php?action=query&list=backlinks&bltitle=Main%20Page', + 'api.php?action=query&generator=backlinks&gbltitle=Main%20Page&prop=info' ), - 'embeddedin' => array ( - "api.php?action=query&list=embeddedin&eititle=Template:Stub", - "api.php?action=query&generator=embeddedin&geititle=Template:Stub&prop=info" + 'embeddedin' => array( + 'api.php?action=query&list=embeddedin&eititle=Template:Stub', + 'api.php?action=query&generator=embeddedin&geititle=Template:Stub&prop=info' ), - 'imageusage' => array ( - "api.php?action=query&list=imageusage&iutitle=File:Albert%20Einstein%20Head.jpg", - "api.php?action=query&generator=imageusage&giutitle=File:Albert%20Einstein%20Head.jpg&prop=info" + 'imageusage' => array( + 'api.php?action=query&list=imageusage&iutitle=File:Albert%20Einstein%20Head.jpg', + 'api.php?action=query&generator=imageusage&giutitle=File:Albert%20Einstein%20Head.jpg&prop=info' ) ); @@ -487,6 +497,6 @@ class ApiQueryBacklinks extends ApiQueryGeneratorBase { } public function getVersion() { - return __CLASS__ . ': $Id: ApiQueryBacklinks.php 69932 2010-07-26 08:03:21Z tstarling $'; + return __CLASS__ . ': $Id: ApiQueryBacklinks.php 75921 2010-11-03 12:49:21Z demon $'; } } -- cgit v1.2.3-54-g00ecf