includes/api/ApiQueryExtLinksUsage.php

   1 <?php
   2
   3 /**
   4  * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19  * http://www.gnu.org/copyleft/gpl.html
  20  *
  21  * @file
  22  */
  23
  24 use MediaWiki\ExternalLinks\LinkFilter;
  25 use MediaWiki\MainConfigNames;
  26 use MediaWiki\Title\Title;
  27 use MediaWiki\Utils\UrlUtils;
  28 use Wikimedia\ParamValidator\ParamValidator;
  29 use Wikimedia\ParamValidator\TypeDef\IntegerDef;
  30
  31 /**
  32  * @ingroup API
  33  */
  34 class ApiQueryExtLinksUsage extends ApiQueryGeneratorBase {
  35
  36         private UrlUtils $urlUtils;
  37
  38         /**
  39          * @param ApiQuery $query
  40          * @param string $moduleName
  41          * @param UrlUtils $urlUtils
  42          */
  43         public function __construct( ApiQuery $query, $moduleName, UrlUtils $urlUtils ) {
  44                 parent::__construct( $query, $moduleName, 'eu' );
  45
  46                 $this->urlUtils = $urlUtils;
  47         }
  48
  49         public function execute() {
  50                 $this->run();
  51         }
  52
  53         public function getCacheMode( $params ) {
  54                 return 'public';
  55         }
  56
  57         public function executeGenerator( $resultPageSet ) {
  58                 $this->run( $resultPageSet );
  59         }
  60
  61         /**
  62          * @param ApiPageSet|null $resultPageSet
  63          * @return void
  64          */
  65         private function run( $resultPageSet = null ) {
  66                 $params = $this->extractRequestParams();
  67                 $db = $this->getDB();
  68
  69                 $query = $params['query'];
  70                 $protocol = LinkFilter::getProtocolPrefix( $params['protocol'] );
  71
  72                 $this->addTables( [ 'externallinks', 'page' ] );
  73                 $this->addJoinConds( [ 'page' => [ 'JOIN', 'page_id=el_from' ] ] );
  74                 $continueField = 'el_to_domain_index';
  75                 $fields = [ 'el_to_domain_index', 'el_to_path' ];
  76
  77                 $miser_ns = [];
  78                 if ( $this->getConfig()->get( MainConfigNames::MiserMode ) ) {
  79                         $miser_ns = $params['namespace'] ?: [];
  80                 } else {
  81                         $this->addWhereFld( 'page_namespace', $params['namespace'] );
  82                 }
  83                 if ( $query !== null && $query !== '' ) {
  84                         // Normalize query to match the normalization applied for the externallinks table
  85                         $query = Parser::normalizeLinkUrl( $query );
  86                         $conds = LinkFilter::getQueryConditions( $query, [
  87                                 'protocol' => $protocol,
  88                                 'oneWildcard' => true,
  89                                 'db' => $db
  90                         ] );
  91                         if ( !$conds ) {
  92                                 $this->dieWithError( 'apierror-badquery' );
  93                         }
  94                         $this->addWhere( $conds );
  95                 } else {
  96                         if ( $protocol !== null ) {
  97                                 $this->addWhere( $continueField . $db->buildLike( "$protocol", $db->anyString() ) );
  98                         }
  99                 }
 100                 $orderBy = [ 'el_id' ];
 101
 102                 $this->addOption( 'ORDER BY', $orderBy );
 103                 $this->addFields( $orderBy ); // Make sure
 104
 105                 $prop = array_fill_keys( $params['prop'], true );
 106                 $fld_ids = isset( $prop['ids'] );
 107                 $fld_title = isset( $prop['title'] );
 108                 $fld_url = isset( $prop['url'] );
 109
 110                 if ( $resultPageSet === null ) {
 111                         $this->addFields( [
 112                                 'page_id',
 113                                 'page_namespace',
 114                                 'page_title'
 115                         ] );
 116                         foreach ( $fields as $field ) {
 117                                 $this->addFieldsIf( $field, $fld_url );
 118                         }
 119                 } else {
 120                         $this->addFields( $resultPageSet->getPageTableFields() );
 121                 }
 122
 123                 $limit = $params['limit'];
 124                 $this->addOption( 'LIMIT', $limit + 1 );
 125
 126                 // T244254: Avoid MariaDB deciding to scan all of `page`.
 127                 $this->addOption( 'STRAIGHT_JOIN' );
 128
 129                 if ( $params['continue'] !== null ) {
 130                         $cont = $this->parseContinueParamOrDie( $params['continue'],
 131                                 array_fill( 0, count( $orderBy ), 'string' ) );
 132                         $conds = array_combine( $orderBy, array_map( 'rawurldecode', $cont ) );
 133                         $this->addWhere( $db->buildComparison( '>=', $conds ) );
 134                 }
 135
 136                 $res = $this->select( __METHOD__ );
 137
 138                 $result = $this->getResult();
 139
 140                 if ( $resultPageSet === null ) {
 141                         $this->executeGenderCacheFromResultWrapper( $res, __METHOD__ );
 142                 }
 143
 144                 $count = 0;
 145                 foreach ( $res as $row ) {
 146                         if ( ++$count > $limit ) {
 147                                 // We've reached the one extra which shows that there are
 148                                 // additional pages to be had. Stop here...
 149                                 $this->setContinue( $orderBy, $row );
 150                                 break;
 151                         }
 152
 153                         if ( count( $miser_ns ) && !in_array( $row->page_namespace, $miser_ns ) ) {
 154                                 continue;
 155                         }
 156
 157                         if ( $resultPageSet === null ) {
 158                                 $vals = [
 159                                         ApiResult::META_TYPE => 'assoc',
 160                                 ];
 161                                 if ( $fld_ids ) {
 162                                         $vals['pageid'] = (int)$row->page_id;
 163                                 }
 164                                 if ( $fld_title ) {
 165                                         $title = Title::makeTitle( $row->page_namespace, $row->page_title );
 166                                         ApiQueryBase::addTitleInfo( $vals, $title );
 167                                 }
 168                                 if ( $fld_url ) {
 169                                         $to = LinkFilter::reverseIndexes( $row->el_to_domain_index ) . $row->el_to_path;
 170                                         // expand protocol-relative urls
 171                                         if ( $params['expandurl'] ) {
 172                                                 $to = (string)$this->urlUtils->expand( $to, PROTO_CANONICAL );
 173                                         }
 174                                         $vals['url'] = $to;
 175                                 }
 176                                 $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $vals );
 177                                 if ( !$fit ) {
 178                                         $this->setContinue( $orderBy, $row );
 179                                         break;
 180                                 }
 181                         } else {
 182                                 $resultPageSet->processDbRow( $row );
 183                         }
 184                 }
 185
 186                 if ( $resultPageSet === null ) {
 187                         $result->addIndexedTagName( [ 'query', $this->getModuleName() ],
 188                                 $this->getModulePrefix() );
 189                 }
 190         }
 191
 192         private function setContinue( $orderBy, $row ) {
 193                 $fields = [];
 194                 foreach ( $orderBy as $field ) {
 195                         $fields[] = strtr( $row->$field, [ '%' => '%25', '|' => '%7C' ] );
 196                 }
 197                 $this->setContinueEnumParameter( 'continue', implode( '|', $fields ) );
 198         }
 199
 200         public function getAllowedParams() {
 201                 $ret = [
 202                         'prop' => [
 203                                 ParamValidator::PARAM_ISMULTI => true,
 204                                 ParamValidator::PARAM_DEFAULT => 'ids|title|url',
 205                                 ParamValidator::PARAM_TYPE => [
 206                                         'ids',
 207                                         'title',
 208                                         'url'
 209                                 ],
 210                                 ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
 211                         ],
 212                         'continue' => [
 213                                 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
 214                         ],
 215                         'protocol' => [
 216                                 ParamValidator::PARAM_TYPE => LinkFilter::prepareProtocols(),
 217                                 ParamValidator::PARAM_DEFAULT => '',
 218                         ],
 219                         'query' => null,
 220                         'namespace' => [
 221                                 ParamValidator::PARAM_ISMULTI => true,
 222                                 ParamValidator::PARAM_TYPE => 'namespace'
 223                         ],
 224                         'limit' => [
 225                                 ParamValidator::PARAM_DEFAULT => 10,
 226                                 ParamValidator::PARAM_TYPE => 'limit',
 227                                 IntegerDef::PARAM_MIN => 1,
 228                                 IntegerDef::PARAM_MAX => ApiBase::LIMIT_BIG1,
 229                                 IntegerDef::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 230                         ],
 231                         'expandurl' => [
 232                                 ParamValidator::PARAM_TYPE => 'boolean',
 233                                 ParamValidator::PARAM_DEFAULT => false,
 234                                 ParamValidator::PARAM_DEPRECATED => true,
 235                         ],
 236                 ];
 237
 238                 if ( $this->getConfig()->get( MainConfigNames::MiserMode ) ) {
 239                         $ret['namespace'][ApiBase::PARAM_HELP_MSG_APPEND] = [
 240                                 'api-help-param-limited-in-miser-mode',
 241                         ];
 242                 }
 243
 244                 return $ret;
 245         }
 246
 247         protected function getExamplesMessages() {
 248                 return [
 249                         'action=query&list=exturlusage&euquery=www.mediawiki.org'
 250                                 => 'apihelp-query+exturlusage-example-simple',
 251                 ];
 252         }
 253
 254         public function getHelpUrls() {
 255                 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Exturlusage';
 256         }
 257 }