includes/api/ApiQueryExtLinksUsage.php

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