includes/api/ApiQueryIWBacklinks.php

   1 <?php
   2 /**
   3  * API for MediaWiki 1.17+
   4  *
   5  * Created on May 14, 2010
   6  *
   7  * Copyright © 2010 Sam Reed
   8  * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with this program; if not, write to the Free Software Foundation, Inc.,
  22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  23  * http://www.gnu.org/copyleft/gpl.html
  24  *
  25  * @file
  26  */
  27
  28 /**
  29  * This gives links pointing to the given interwiki
  30  * @ingroup API
  31  */
  32 class ApiQueryIWBacklinks extends ApiQueryGeneratorBase {
  33
  34         public function __construct( $query, $moduleName ) {
  35                 parent::__construct( $query, $moduleName, 'iwbl' );
  36         }
  37
  38         public function execute() {
  39                 $this->run();
  40         }
  41
  42         public function executeGenerator( $resultPageSet ) {
  43                 $this->run( $resultPageSet );
  44         }
  45
  46         /**
  47          * @param $resultPageSet ApiPageSet
  48          * @return void
  49          */
  50         public function run( $resultPageSet = null ) {
  51                 $params = $this->extractRequestParams();
  52
  53                 if ( isset( $params['title'] ) && !isset( $params['prefix'] ) ) {
  54                         $this->dieUsageMsg( array( 'missingparam', 'prefix' ) );
  55                 }
  56
  57                 if ( !is_null( $params['continue'] ) ) {
  58                         $cont = explode( '|', $params['continue'] );
  59                         $this->dieContinueUsageIf( count( $cont ) != 3 );
  60
  61                         $db = $this->getDB();
  62                         $op = $params['dir'] == 'descending' ? '<' : '>';
  63                         $prefix = $db->addQuotes( $cont[0] );
  64                         $title = $db->addQuotes( $cont[1] );
  65                         $from = intval( $cont[2] );
  66                         $this->addWhere(
  67                                 "iwl_prefix $op $prefix OR " .
  68                                 "(iwl_prefix = $prefix AND " .
  69                                 "(iwl_title $op $title OR " .
  70                                 "(iwl_title = $title AND " .
  71                                 "iwl_from $op= $from)))"
  72                         );
  73                 }
  74
  75                 $prop = array_flip( $params['prop'] );
  76                 $iwprefix = isset( $prop['iwprefix'] );
  77                 $iwtitle = isset( $prop['iwtitle'] );
  78
  79                 $this->addTables( array( 'iwlinks', 'page' ) );
  80                 $this->addWhere( 'iwl_from = page_id' );
  81
  82                 $this->addFields( array( 'page_id', 'page_title', 'page_namespace', 'page_is_redirect',
  83                         'iwl_from', 'iwl_prefix', 'iwl_title' ) );
  84
  85                 $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
  86                 if ( isset( $params['prefix'] ) ) {
  87                         $this->addWhereFld( 'iwl_prefix', $params['prefix'] );
  88                         if ( isset( $params['title'] ) ) {
  89                                 $this->addWhereFld( 'iwl_title', $params['title'] );
  90                                 $this->addOption( 'ORDER BY', 'iwl_from' . $sort );
  91                         } else {
  92                                 $this->addOption( 'ORDER BY', array(
  93                                         'iwl_title' . $sort,
  94                                         'iwl_from' . $sort
  95                                 ));
  96                         }
  97                 } else {
  98                         $this->addOption( 'ORDER BY', array(
  99                                 'iwl_prefix' . $sort,
 100                                 'iwl_title' . $sort,
 101                                 'iwl_from' . $sort
 102                         ));
 103                 }
 104
 105                 $this->addOption( 'LIMIT', $params['limit'] + 1 );
 106
 107                 $res = $this->select( __METHOD__ );
 108
 109                 $pages = array();
 110
 111                 $count = 0;
 112                 $result = $this->getResult();
 113                 foreach ( $res as $row ) {
 114                         if ( ++ $count > $params['limit'] ) {
 115                                 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
 116                                 // Continue string preserved in case the redirect query doesn't pass the limit
 117                                 $this->setContinueEnumParameter( 'continue', "{$row->iwl_prefix}|{$row->iwl_title}|{$row->iwl_from}" );
 118                                 break;
 119                         }
 120
 121                         if ( !is_null( $resultPageSet ) ) {
 122                                 $pages[] = Title::newFromRow( $row );
 123                         } else {
 124                                 $entry = array( 'pageid' => $row->page_id );
 125
 126                                 $title = Title::makeTitle( $row->page_namespace, $row->page_title );
 127                                 ApiQueryBase::addTitleInfo( $entry, $title );
 128
 129                                 if ( $row->page_is_redirect ) {
 130                                         $entry['redirect'] = '';
 131                                 }
 132
 133                                 if ( $iwprefix ) {
 134                                         $entry['iwprefix'] = $row->iwl_prefix;
 135                                 }
 136
 137                                 if ( $iwtitle ) {
 138                                         $entry['iwtitle'] = $row->iwl_title;
 139                                 }
 140
 141                                 $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $entry );
 142                                 if ( !$fit ) {
 143                                         $this->setContinueEnumParameter( 'continue', "{$row->iwl_prefix}|{$row->iwl_title}|{$row->iwl_from}" );
 144                                         break;
 145                                 }
 146                         }
 147                 }
 148
 149                 if ( is_null( $resultPageSet ) ) {
 150                         $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'iw' );
 151                 } else {
 152                         $resultPageSet->populateFromTitles( $pages );
 153                 }
 154         }
 155
 156         public function getCacheMode( $params ) {
 157                 return 'public';
 158         }
 159
 160         public function getAllowedParams() {
 161                 return array(
 162                         'prefix' => null,
 163                         'title' => null,
 164                         'continue' => null,
 165                         'limit' => array(
 166                                 ApiBase::PARAM_DFLT => 10,
 167                                 ApiBase::PARAM_TYPE => 'limit',
 168                                 ApiBase::PARAM_MIN => 1,
 169                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 170                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 171                         ),
 172                         'prop' => array(
 173                                 ApiBase::PARAM_ISMULTI => true,
 174                                 ApiBase::PARAM_DFLT => '',
 175                                 ApiBase::PARAM_TYPE => array(
 176                                         'iwprefix',
 177                                         'iwtitle',
 178                                 ),
 179                         ),
 180                         'dir' => array(
 181                                 ApiBase::PARAM_DFLT => 'ascending',
 182                                 ApiBase::PARAM_TYPE => array(
 183                                         'ascending',
 184                                         'descending'
 185                                 )
 186                         ),
 187                 );
 188         }
 189
 190         public function getParamDescription() {
 191                 return array(
 192                         'prefix' => 'Prefix for the interwiki',
 193                         'title' => "Interwiki link to search for. Must be used with {$this->getModulePrefix()}prefix",
 194                         'continue' => 'When more results are available, use this to continue',
 195                         'prop' => array(
 196                                 'Which properties to get',
 197                                 ' iwprefix       - Adds the prefix of the interwiki',
 198                                 ' iwtitle        - Adds the title of the interwiki',
 199                         ),
 200                         'limit' => 'How many total pages to return',
 201                         'dir' => 'The direction in which to list',
 202                 );
 203         }
 204
 205         public function getResultProperties() {
 206                 return array(
 207                         '' => array(
 208                                 'pageid' => 'integer',
 209                                 'ns' => 'namespace',
 210                                 'title' => 'string',
 211                                 'redirect' => 'boolean'
 212                         ),
 213                         'iwprefix' => array(
 214                                 'iwprefix' => 'string'
 215                         ),
 216                         'iwtitle' => array(
 217                                 'iwtitle' => 'string'
 218                         )
 219                 );
 220         }
 221
 222         public function getDescription() {
 223                 return array( 'Find all pages that link to the given interwiki link.',
 224                         'Can be used to find all links with a prefix, or',
 225                         'all links to a title (with a given prefix).',
 226                         'Using neither parameter is effectively "All IW Links"',
 227                 );
 228         }
 229
 230         public function getPossibleErrors() {
 231                 return array_merge( parent::getPossibleErrors(), array(
 232                         array( 'missingparam', 'prefix' ),
 233                 ) );
 234         }
 235
 236         public function getExamples() {
 237                 return array(
 238                         'api.php?action=query&list=iwbacklinks&iwbltitle=Test&iwblprefix=wikibooks',
 239                         'api.php?action=query&generator=iwbacklinks&giwbltitle=Test&giwblprefix=wikibooks&prop=info'
 240                 );
 241         }
 242
 243         public function getHelpUrls() {
 244                 return 'https://www.mediawiki.org/wiki/API:Iwbacklinks';
 245         }
 246 }