includes/api/ApiQueryLinks.php

   1 <?php
   2 /**
   3  *
   4  *
   5  * Created on May 12, 2007
   6  *
   7  * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  22  * http://www.gnu.org/copyleft/gpl.html
  23  *
  24  * @file
  25  */
  26
  27 /**
  28  * A query module to list all wiki links on a given set of pages.
  29  *
  30  * @ingroup API
  31  */
  32 class ApiQueryLinks extends ApiQueryGeneratorBase {
  33
  34         const LINKS = 'links';
  35         const TEMPLATES = 'templates';
  36
  37         private $table, $prefix, $description, $helpUrl;
  38
  39         public function __construct( $query, $moduleName ) {
  40                 switch ( $moduleName ) {
  41                         case self::LINKS:
  42                                 $this->table = 'pagelinks';
  43                                 $this->prefix = 'pl';
  44                                 $this->description = 'link';
  45                                 $this->titlesParam = 'titles';
  46                                 $this->titlesParamDescription = 'Only list links to these titles. Useful for checking whether a certain page links to a certain title.';
  47                                 $this->helpUrl = 'https://www.mediawiki.org/wiki/API:Properties#links_.2F_pl';
  48                                 break;
  49                         case self::TEMPLATES:
  50                                 $this->table = 'templatelinks';
  51                                 $this->prefix = 'tl';
  52                                 $this->description = 'template';
  53                                 $this->titlesParam = 'templates';
  54                                 $this->titlesParamDescription = 'Only list these templates. Useful for checking whether a certain page uses a certain template.';
  55                                 $this->helpUrl = 'https://www.mediawiki.org/wiki/API:Properties#templates_.2F_tl';
  56                                 break;
  57                         default:
  58                                 ApiBase::dieDebug( __METHOD__, 'Unknown module name' );
  59                 }
  60
  61                 parent::__construct( $query, $moduleName, $this->prefix );
  62         }
  63
  64         public function execute() {
  65                 $this->run();
  66         }
  67
  68         public function getCacheMode( $params ) {
  69                 return 'public';
  70         }
  71
  72         public function executeGenerator( $resultPageSet ) {
  73                 $this->run( $resultPageSet );
  74         }
  75
  76         /**
  77          * @param $resultPageSet ApiPageSet
  78          * @return
  79          */
  80         private function run( $resultPageSet = null ) {
  81                 if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
  82                         return; // nothing to do
  83                 }
  84
  85                 $params = $this->extractRequestParams();
  86
  87                 $this->addFields( array(
  88                         $this->prefix . '_from AS pl_from',
  89                         $this->prefix . '_namespace AS pl_namespace',
  90                         $this->prefix . '_title AS pl_title'
  91                 ) );
  92
  93                 $this->addTables( $this->table );
  94                 $this->addWhereFld( $this->prefix . '_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
  95                 $this->addWhereFld( $this->prefix . '_namespace', $params['namespace'] );
  96
  97                 if ( !is_null( $params[$this->titlesParam] ) ) {
  98                         $lb = new LinkBatch;
  99                         foreach ( $params[$this->titlesParam] as $t ) {
 100                                 $title = Title::newFromText( $t );
 101                                 if ( !$title ) {
 102                                         $this->setWarning( "\"$t\" is not a valid title" );
 103                                 } else {
 104                                         $lb->addObj( $title );
 105                                 }
 106                         }
 107                         $cond = $lb->constructSet( $this->prefix, $this->getDB() );
 108                         if ( $cond ) {
 109                                 $this->addWhere( $cond );
 110                         }
 111                 }
 112
 113                 if ( !is_null( $params['continue'] ) ) {
 114                         $cont = explode( '|', $params['continue'] );
 115                         if ( count( $cont ) != 3 ) {
 116                                 $this->dieUsage( 'Invalid continue param. You should pass the ' .
 117                                         'original value returned by the previous query', '_badcontinue' );
 118                         }
 119                         $plfrom = intval( $cont[0] );
 120                         $plns = intval( $cont[1] );
 121                         $pltitle = $this->getDB()->strencode( $this->titleToKey( $cont[2] ) );
 122                         $this->addWhere(
 123                                 "{$this->prefix}_from > $plfrom OR " .
 124                                 "({$this->prefix}_from = $plfrom AND " .
 125                                 "({$this->prefix}_namespace > $plns OR " .
 126                                 "({$this->prefix}_namespace = $plns AND " .
 127                                 "{$this->prefix}_title >= '$pltitle')))"
 128                         );
 129                 }
 130
 131                 $dir = ( $params['dir'] == 'descending' ? ' DESC' : '' );
 132                 // Here's some MySQL craziness going on: if you use WHERE foo='bar'
 133                 // and later ORDER BY foo MySQL doesn't notice the ORDER BY is pointless
 134                 // but instead goes and filesorts, because the index for foo was used
 135                 // already. To work around this, we drop constant fields in the WHERE
 136                 // clause from the ORDER BY clause
 137                 $order = array();
 138                 if ( count( $this->getPageSet()->getGoodTitles() ) != 1 ) {
 139                         $order[] = $this->prefix . '_from' . $dir;
 140                 }
 141                 if ( count( $params['namespace'] ) != 1 ) {
 142                         $order[] = $this->prefix . '_namespace' . $dir;
 143                 }
 144
 145                 $order[] = $this->prefix . "_title" . $dir;
 146                 $this->addOption( 'ORDER BY', $order );
 147                 $this->addOption( 'USE INDEX', $this->prefix . '_from' );
 148                 $this->addOption( 'LIMIT', $params['limit'] + 1 );
 149
 150                 $res = $this->select( __METHOD__ );
 151
 152                 if ( is_null( $resultPageSet ) ) {
 153                         $count = 0;
 154                         foreach ( $res as $row ) {
 155                                 if ( ++$count > $params['limit'] ) {
 156                                         // We've reached the one extra which shows that
 157                                         // there are additional pages to be had. Stop here...
 158                                         $this->setContinueEnumParameter( 'continue',
 159                                                 "{$row->pl_from}|{$row->pl_namespace}|" .
 160                                                 $this->keyToTitle( $row->pl_title ) );
 161                                         break;
 162                                 }
 163                                 $vals = array();
 164                                 ApiQueryBase::addTitleInfo( $vals, Title::makeTitle( $row->pl_namespace, $row->pl_title ) );
 165                                 $fit = $this->addPageSubItem( $row->pl_from, $vals );
 166                                 if ( !$fit ) {
 167                                         $this->setContinueEnumParameter( 'continue',
 168                                                 "{$row->pl_from}|{$row->pl_namespace}|" .
 169                                                 $this->keyToTitle( $row->pl_title ) );
 170                                         break;
 171                                 }
 172                         }
 173                 } else {
 174                         $titles = array();
 175                         $count = 0;
 176                         foreach ( $res as $row ) {
 177                                 if ( ++$count > $params['limit'] ) {
 178                                         // We've reached the one extra which shows that
 179                                         // there are additional pages to be had. Stop here...
 180                                         $this->setContinueEnumParameter( 'continue',
 181                                                 "{$row->pl_from}|{$row->pl_namespace}|" .
 182                                                 $this->keyToTitle( $row->pl_title ) );
 183                                         break;
 184                                 }
 185                                 $titles[] = Title::makeTitle( $row->pl_namespace, $row->pl_title );
 186                         }
 187                         $resultPageSet->populateFromTitles( $titles );
 188                 }
 189         }
 190
 191         public function getAllowedParams() {
 192                 return array(
 193                         'namespace' => array(
 194                                 ApiBase::PARAM_TYPE => 'namespace',
 195                                 ApiBase::PARAM_ISMULTI => true
 196                         ),
 197                         'limit' => array(
 198                                 ApiBase::PARAM_DFLT => 10,
 199                                 ApiBase::PARAM_TYPE => 'limit',
 200                                 ApiBase::PARAM_MIN => 1,
 201                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 202                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 203                         ),
 204                         'continue' => null,
 205                         $this->titlesParam => array(
 206                                 ApiBase::PARAM_ISMULTI => true,
 207                         ),
 208                         'dir' => array(
 209                                 ApiBase::PARAM_DFLT => 'ascending',
 210                                 ApiBase::PARAM_TYPE => array(
 211                                         'ascending',
 212                                         'descending'
 213                                 )
 214                         ),
 215                 );
 216         }
 217
 218         public function getParamDescription() {
 219                 $desc = $this->description;
 220                 return array(
 221                         'namespace' => "Show {$desc}s in this namespace(s) only",
 222                         'limit' => "How many {$desc}s to return",
 223                         'continue' => 'When more results are available, use this to continue',
 224                         $this->titlesParam => $this->titlesParamDescription,
 225                         'dir' => 'The direction in which to list',
 226                 );
 227         }
 228
 229         public function getDescription() {
 230                 return "Returns all {$this->description}s from the given page(s)";
 231         }
 232
 233         public function getExamples() {
 234                 $desc = $this->description;
 235                 $name = $this->getModuleName();
 236                 return array(
 237                         "api.php?action=query&prop={$name}&titles=Main%20Page" => "Get {$desc}s from the [[Main Page]]:",
 238                         "api.php?action=query&generator={$name}&titles=Main%20Page&prop=info" => "Get information about the {$desc} pages in the [[Main Page]]:",
 239                         "api.php?action=query&prop={$name}&titles=Main%20Page&{$this->prefix}namespace=2|10" => "Get {$desc}s from the Main Page in the User and Template namespaces:",
 240                 );
 241         }
 242
 243         public function getHelpUrls() {
 244                 return $this->helpUrl;
 245         }
 246
 247         public function getVersion() {
 248                 return __CLASS__ . ': $Id$';
 249         }
 250 }