From: Sam Reed Date: Tue, 25 May 2010 19:50:20 +0000 (+0000) Subject: * (bug 23524) Api Modules as followup to bug 14473 (Add iwlinks table to track inline... X-Git-Tag: 1.31.0-rc.0~36724 X-Git-Url: https://git.cyclocoop.org/%28%28?a=commitdiff_plain;h=411600af879123d7a7478a1b795c0ce39e7e204d;p=lhc%2Fweb%2Fwiklou.git * (bug 23524) Api Modules as followup to bug 14473 (Add iwlinks table to track inline interwiki link usage Addition of IWBacklinks... That should be the bug done --- diff --git a/RELEASE-NOTES b/RELEASE-NOTES index 30a271c6cf..cf4a934140 100644 --- a/RELEASE-NOTES +++ b/RELEASE-NOTES @@ -187,6 +187,7 @@ in a negative namespace (which is invalid). * (bug 21346) Make deleted images searchable by hash * (bug 23461) Normalise usage of parameter names in parameter descriptions * (bug 23548) Allow access of another users watchlist through watchlistraw using token and username +* (bug 23524) Api Modules as followup to bug 14473 (Add iwlinks table to track inline interwiki link usage === Languages updated in 1.17 === diff --git a/includes/AutoLoader.php b/includes/AutoLoader.php index ffacb56cfa..438c6a1c1f 100644 --- a/includes/AutoLoader.php +++ b/includes/AutoLoader.php @@ -322,6 +322,7 @@ $wgAutoloadLocalClasses = array( 'ApiQueryImages' => 'includes/api/ApiQueryImages.php', 'ApiQueryInfo' => 'includes/api/ApiQueryInfo.php', 'ApiQueryIWLinks' => 'includes/api/ApiQueryIWLinks.php', + 'ApiQueryIWBacklinks' => 'includes/api/ApiQueryIWBacklinks.php', 'ApiQueryLangLinks' => 'includes/api/ApiQueryLangLinks.php', 'ApiQueryLinks' => 'includes/api/ApiQueryLinks.php', 'ApiQueryLogEvents' => 'includes/api/ApiQueryLogEvents.php', diff --git a/includes/api/ApiQuery.php b/includes/api/ApiQuery.php index 7274890533..febf368638 100644 --- a/includes/api/ApiQuery.php +++ b/includes/api/ApiQuery.php @@ -73,6 +73,7 @@ class ApiQuery extends ApiBase { 'embeddedin' => 'ApiQueryBacklinks', 'filearchive' => 'ApiQueryFilearchive', 'imageusage' => 'ApiQueryBacklinks', + 'iwbacklinks' => 'ApiQueryIWBacklinks', 'logevents' => 'ApiQueryLogEvents', 'recentchanges' => 'ApiQueryRecentChanges', 'search' => 'ApiQuerySearch', diff --git a/includes/api/ApiQueryIWBacklinks.php b/includes/api/ApiQueryIWBacklinks.php new file mode 100644 index 0000000000..ce9b8e5fac --- /dev/null +++ b/includes/api/ApiQueryIWBacklinks.php @@ -0,0 +1,180 @@ +@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., + * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * http://www.gnu.org/copyleft/gpl.html + */ + +if ( !defined( 'MEDIAWIKI' ) ) { + // Eclipse helper - will be ignored in production + require_once( "ApiQueryBase.php" ); +} + +/** + * This gives links pointing to the given interwiki + * @ingroup API + */ +class ApiQueryIWBacklinks extends ApiQueryBase { + + public function __construct( $query, $moduleName ) { + parent::__construct( $query, $moduleName, 'iwbl' ); + } + + public function execute() { + $params = $this->extractRequestParams( false ); + + $userMax = ( $this->redirect ? ApiBase::LIMIT_BIG1 / 2 : ApiBase::LIMIT_BIG1 ); + $botMax = ( $this->redirect ? ApiBase::LIMIT_BIG2 / 2 : ApiBase::LIMIT_BIG2 ); + + if ( $params['limit'] == 'max' ) { + $params['limit'] = $this->getMain()->canApiHighLimits() ? $botMax : $userMax; + $this->getResult()->addValue( 'limits', $this->getModuleName(), $params['limit'] ); + } + + if ( !is_null( $params['continue'] ) ) { + $cont = explode( '|', $params['continue'] ); + if ( count( $cont ) != 3 ) { + $this->dieUsage( 'Invalid continue param. You should pass the ' . + 'original value returned by the previous query', '_badcontinue' ); + } + + $from = intval( $cont[0] ); + $prefix = $this->getDB()->strencode( $cont[1] ); + $title = $this->getDB()->strencode( $this->titleToKey( $cont[2] ) ); + $this->addWhere( + "iwl_from > $from OR " . + "(iwl_from = $from AND " . + "(iwl_prefix > '$prefix' OR " . + "(iwl_prefix = '$prefix' AND " . + "iwl_title >= '$title')))" + ); + } + + $this->addTables( array( 'iwlinks', 'page' ) ); + $this->addWhere( 'iwl_from = page_id' ); + + $this->addFields( array( 'page_id', 'page_title', 'page_namespace', 'page_is_redirect', + 'iwl_from', 'iwl_prefix', 'iwl_title' ) ); + + if ( $params['prefix'] !== '' ) { + $this->addWhereFld( 'iwl_prefix', $params['prefix'] ); + } + + if ( $params['title'] !== '' ) { + $this->addWhereFld( 'iwl_title', $params['title'] ); + } + + $this->addWhereFld( 'page_namespace', $params['namespace'] ); + + $this->addOption( 'LIMIT', $params['limit'] + 1 ); + $this->addOption( 'ORDER BY', 'iwl_from' ); + $this->addOption( 'STRAIGHT_JOIN' ); + + $db = $this->getDB(); + $res = $this->select( __METHOD__ . '::firstQuery' ); + + $count = 0; + $result = $this->getResult(); + while ( $row = $db->fetchObject( $res ) ) { + if ( ++ $count > $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 + $this->setContinueEnumParameter( 'continue', "{$row->iwl_from}|{$row->iwl_prefix}|{$row->iwl_title}" ); + break; + } + + $entry = array(); + + $entry['pageid'] = intval( $row->page_id ); + $entry['ns'] = $row->page_namespace; + $entry['title'] = $row->page_title; + + if ( $row->page_is_redirect ) { + $entry['redirect'] = ''; + } + + $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $entry ); + if ( !$fit ) { + $this->setContinueEnumParameter( 'continue', "{$row->iwl_from}|{$row->iwl_prefix}|{$row->iwl_title}" ); + break; + } + } + $db->freeResult( $res ); + + $this->getResult()->setIndexedTagName_internal( + array( 'query', $this->getModuleName() ), + 'iw' + ); + } + + public function getAllowedParams() { + return array( + 'prefix' => null, + 'title' => null, + 'continue' => null, + 'namespace' => array( + ApiBase::PARAM_ISMULTI => true, + ApiBase::PARAM_TYPE => 'namespace' + ), + '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 + ) + ); + } + + public function getParamDescription() { + return array( + 'prefix' => 'Prefix for the interwiki', + 'title' => 'Interwiki link to search for', + 'continue' => 'When more results are available, use this to continue', + 'namespace' => 'The namespace to enumerate', + 'limit' => 'How many total pages to return', + ); + } + + public function getDescription() { + return 'Find all pages that link to the given interwiki link'; + } + + public function getPossibleErrors() { + return array_merge( parent::getPossibleErrors(), array( + array( 'invalidtitle', 'title' ), + array( 'missingparam', 'title' ), + array( 'code' => '_badcontinue', 'info' => 'Invalid continue param. You should pass the original value returned by the previous query' ), + ) ); + } + + protected function getExamples() { + return array( + 'api.php?action=query&list=iwbacklinks&iwbltitle=Test&iwblprefix=wikibooks', + 'api.php?action=query&generator=iwbacklinks&giwbltitle=Test&iwblprefix=wikibooks&prop=info' + ); + } + + public function getVersion() { + return __CLASS__ . ': $Id$'; + } +}