diff options
Diffstat (limited to 'www/wiki/includes/api/ApiQueryExtLinksUsage.php')
| -rw-r--r-- | www/wiki/includes/api/ApiQueryExtLinksUsage.php | 231 |
1 files changed, 231 insertions, 0 deletions
diff --git a/www/wiki/includes/api/ApiQueryExtLinksUsage.php b/www/wiki/includes/api/ApiQueryExtLinksUsage.php new file mode 100644 index 00000000..fc5d8a04 --- /dev/null +++ b/www/wiki/includes/api/ApiQueryExtLinksUsage.php @@ -0,0 +1,231 @@ +<?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 + */ + +/** + * @ingroup API + */ +class ApiQueryExtLinksUsage extends ApiQueryGeneratorBase { + + public function __construct( ApiQuery $query, $moduleName ) { + parent::__construct( $query, $moduleName, 'eu' ); + } + + public function execute() { + $this->run(); + } + + public function getCacheMode( $params ) { + return 'public'; + } + + public function executeGenerator( $resultPageSet ) { + $this->run( $resultPageSet ); + } + + /** + * @param ApiPageSet $resultPageSet + * @return void + */ + private function run( $resultPageSet = null ) { + $params = $this->extractRequestParams(); + + $query = $params['query']; + $protocol = self::getProtocolPrefix( $params['protocol'] ); + + $this->addTables( [ 'page', 'externallinks' ] ); // must be in this order for 'USE INDEX' + $this->addOption( 'USE INDEX', 'el_index' ); + $this->addWhere( 'page_id=el_from' ); + + $miser_ns = []; + if ( $this->getConfig()->get( 'MiserMode' ) ) { + $miser_ns = $params['namespace'] ?: []; + } else { + $this->addWhereFld( 'page_namespace', $params['namespace'] ); + } + + // Normalize query to match the normalization applied for the externallinks table + $query = Parser::normalizeLinkUrl( $query ); + + $whereQuery = $this->prepareUrlQuerySearchString( $query, $protocol ); + + if ( $whereQuery !== null ) { + $this->addWhere( $whereQuery ); + } + + $prop = array_flip( $params['prop'] ); + $fld_ids = isset( $prop['ids'] ); + $fld_title = isset( $prop['title'] ); + $fld_url = isset( $prop['url'] ); + + if ( is_null( $resultPageSet ) ) { + $this->addFields( [ + 'page_id', + 'page_namespace', + 'page_title' + ] ); + $this->addFieldsIf( 'el_to', $fld_url ); + } else { + $this->addFields( $resultPageSet->getPageTableFields() ); + } + + $limit = $params['limit']; + $offset = $params['offset']; + $this->addOption( 'LIMIT', $limit + 1 ); + if ( isset( $offset ) ) { + $this->addOption( 'OFFSET', $offset ); + } + + $res = $this->select( __METHOD__ ); + + $result = $this->getResult(); + $count = 0; + foreach ( $res as $row ) { + if ( ++$count > $limit ) { + // We've reached the one extra which shows that there are + // additional pages to be had. Stop here... + $this->setContinueEnumParameter( 'offset', $offset + $limit ); + break; + } + + if ( count( $miser_ns ) && !in_array( $row->page_namespace, $miser_ns ) ) { + continue; + } + + if ( is_null( $resultPageSet ) ) { + $vals = [ + ApiResult::META_TYPE => 'assoc', + ]; + if ( $fld_ids ) { + $vals['pageid'] = intval( $row->page_id ); + } + if ( $fld_title ) { + $title = Title::makeTitle( $row->page_namespace, $row->page_title ); + ApiQueryBase::addTitleInfo( $vals, $title ); + } + if ( $fld_url ) { + $to = $row->el_to; + // expand protocol-relative urls + if ( $params['expandurl'] ) { + $to = wfExpandUrl( $to, PROTO_CANONICAL ); + } + $vals['url'] = $to; + } + $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $vals ); + if ( !$fit ) { + $this->setContinueEnumParameter( 'offset', $offset + $count - 1 ); + break; + } + } else { + $resultPageSet->processDbRow( $row ); + } + } + + if ( is_null( $resultPageSet ) ) { + $result->addIndexedTagName( [ 'query', $this->getModuleName() ], + $this->getModulePrefix() ); + } + } + + public function getAllowedParams() { + $ret = [ + 'prop' => [ + ApiBase::PARAM_ISMULTI => true, + ApiBase::PARAM_DFLT => 'ids|title|url', + ApiBase::PARAM_TYPE => [ + 'ids', + 'title', + 'url' + ], + ApiBase::PARAM_HELP_MSG_PER_VALUE => [], + ], + 'offset' => [ + ApiBase::PARAM_TYPE => 'integer', + ApiBase::PARAM_HELP_MSG => 'api-help-param-continue', + ], + 'protocol' => [ + ApiBase::PARAM_TYPE => self::prepareProtocols(), + ApiBase::PARAM_DFLT => '', + ], + 'query' => null, + 'namespace' => [ + ApiBase::PARAM_ISMULTI => true, + ApiBase::PARAM_TYPE => 'namespace' + ], + 'limit' => [ + ApiBase::PARAM_DFLT => 10, + ApiBase::PARAM_TYPE => 'limit', + ApiBase::PARAM_MIN => 1, + ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1, + ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2 + ], + 'expandurl' => false, + ]; + + if ( $this->getConfig()->get( 'MiserMode' ) ) { + $ret['namespace'][ApiBase::PARAM_HELP_MSG_APPEND] = [ + 'api-help-param-limited-in-miser-mode', + ]; + } + + return $ret; + } + + public static function prepareProtocols() { + global $wgUrlProtocols; + $protocols = [ '' ]; + foreach ( $wgUrlProtocols as $p ) { + if ( $p !== '//' ) { + $protocols[] = substr( $p, 0, strpos( $p, ':' ) ); + } + } + + return $protocols; + } + + public static function getProtocolPrefix( $protocol ) { + // Find the right prefix + global $wgUrlProtocols; + if ( $protocol && !in_array( $protocol, $wgUrlProtocols ) ) { + foreach ( $wgUrlProtocols as $p ) { + if ( substr( $p, 0, strlen( $protocol ) ) === $protocol ) { + $protocol = $p; + break; + } + } + + return $protocol; + } else { + return null; + } + } + + protected function getExamplesMessages() { + return [ + 'action=query&list=exturlusage&euquery=www.mediawiki.org' + => 'apihelp-query+exturlusage-example-simple', + ]; + } + + public function getHelpUrls() { + return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Exturlusage'; + } +} |