includes/api/ApiQueryIWBacklinks.php

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