includes/api/ApiQueryAllLinks.php

   1 <?php
   2
   3 /*
   4  * Created on July 7, 2007
   5  *
   6  * API for MediaWiki 1.8+
   7  *
   8  * Copyright (C) 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  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  23  * http://www.gnu.org/copyleft/gpl.html
  24  */
  25
  26 if ( !defined( 'MEDIAWIKI' ) ) {
  27         // Eclipse helper - will be ignored in production
  28         require_once ( 'ApiQueryBase.php' );
  29 }
  30
  31 /**
  32  * Query module to enumerate links from all pages together.
  33  *
  34  * @ingroup API
  35  */
  36 class ApiQueryAllLinks extends ApiQueryGeneratorBase {
  37
  38         public function __construct( $query, $moduleName ) {
  39                 parent :: __construct( $query, $moduleName, 'al' );
  40         }
  41
  42         public function execute() {
  43                 $this->run();
  44         }
  45
  46         public function executeGenerator( $resultPageSet ) {
  47                 $this->run( $resultPageSet );
  48         }
  49
  50         private function run( $resultPageSet = null ) {
  51
  52                 $db = $this->getDB();
  53                 $params = $this->extractRequestParams();
  54
  55                 $prop = array_flip( $params['prop'] );
  56                 $fld_ids = isset( $prop['ids'] );
  57                 $fld_title = isset( $prop['title'] );
  58
  59                 if ( $params['unique'] ) {
  60                         if ( !is_null( $resultPageSet ) )
  61                                 $this->dieUsage( $this->getModuleName() . ' cannot be used as a generator in unique links mode', 'params' );
  62                         if ( $fld_ids )
  63                                 $this->dieUsage( $this->getModuleName() . ' cannot return corresponding page ids in unique links mode', 'params' );
  64                         $this->addOption( 'DISTINCT' );
  65                 }
  66
  67                 $this->addTables( 'pagelinks' );
  68                 $this->addWhereFld( 'pl_namespace', $params['namespace'] );
  69
  70                 if ( !is_null( $params['from'] ) && !is_null( $params['continue'] ) )
  71                         $this->dieUsage( 'alcontinue and alfrom cannot be used together', 'params' );
  72                 if ( !is_null( $params['continue'] ) )
  73                 {
  74                         $arr = explode( '|', $params['continue'] );
  75                         if ( count( $arr ) != 2 )
  76                                 $this->dieUsage( "Invalid continue parameter", 'badcontinue' );
  77                         $from = $this->getDB()->strencode( $this->titleToKey( $arr[0] ) );
  78                         $id = intval( $arr[1] );
  79                         $this->addWhere( "pl_title > '$from' OR " .
  80                                         "(pl_title = '$from' AND " .
  81                                         "pl_from > $id)" );
  82                 }
  83
  84                 if ( !is_null( $params['from'] ) )
  85                         $this->addWhere( 'pl_title>=' . $db->addQuotes( $this->titlePartToKey( $params['from'] ) ) );
  86                 if ( isset ( $params['prefix'] ) )
  87                         $this->addWhere( 'pl_title' . $db->buildLike( $this->titlePartToKey( $params['prefix'] ), $db->anyString() ) );
  88
  89                 $this->addFields( array (
  90                         'pl_title',
  91                 ) );
  92                 $this->addFieldsIf( 'pl_from', !$params['unique'] );
  93
  94                 $this->addOption( 'USE INDEX', 'pl_namespace' );
  95                 $limit = $params['limit'];
  96                 $this->addOption( 'LIMIT', $limit + 1 );
  97                 if ( $params['unique'] )
  98                         $this->addOption( 'ORDER BY', 'pl_title' );
  99                 else
 100                         $this->addOption( 'ORDER BY', 'pl_title, pl_from' );
 101
 102                 $res = $this->select( __METHOD__ );
 103
 104                 $pageids = array ();
 105                 $count = 0;
 106                 $result = $this->getResult();
 107                 while ( $row = $db->fetchObject( $res ) ) {
 108                         if ( ++ $count > $limit ) {
 109                                 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
 110                                 // TODO: Security issue - if the user has no right to view next title, it will still be shown
 111                                 if ( $params['unique'] )
 112                                         $this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->pl_title ) );
 113                                 else
 114                                         $this->setContinueEnumParameter( 'continue', $this->keyToTitle( $row->pl_title ) . "|" . $row->pl_from );
 115                                 break;
 116                         }
 117
 118                         if ( is_null( $resultPageSet ) ) {
 119                                 $vals = array();
 120                                 if ( $fld_ids )
 121                                         $vals['fromid'] = intval( $row->pl_from );
 122                                 if ( $fld_title ) {
 123                                         $title = Title :: makeTitle( $params['namespace'], $row->pl_title );
 124                                         ApiQueryBase::addTitleInfo( $vals, $title );
 125                                 }
 126                                 $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $vals );
 127                                 if ( !$fit )
 128                                 {
 129                                         if ( $params['unique'] )
 130                                                 $this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->pl_title ) );
 131                                         else
 132                                                 $this->setContinueEnumParameter( 'continue', $this->keyToTitle( $row->pl_title ) . "|" . $row->pl_from );
 133                                         break;
 134                                 }
 135                         } else {
 136                                 $pageids[] = $row->pl_from;
 137                         }
 138                 }
 139                 $db->freeResult( $res );
 140
 141                 if ( is_null( $resultPageSet ) ) {
 142                         $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'l' );
 143                 } else {
 144                         $resultPageSet->populateFromPageIDs( $pageids );
 145                 }
 146         }
 147
 148         public function getAllowedParams() {
 149                 return array (
 150                         'continue' => null,
 151                         'from' => null,
 152                         'prefix' => null,
 153                         'unique' => false,
 154                         'prop' => array (
 155                                 ApiBase :: PARAM_ISMULTI => true,
 156                                 ApiBase :: PARAM_DFLT => 'title',
 157                                 ApiBase :: PARAM_TYPE => array (
 158                                         'ids',
 159                                         'title'
 160                                 )
 161                         ),
 162                         'namespace' => array (
 163                                 ApiBase :: PARAM_DFLT => 0,
 164                                 ApiBase :: PARAM_TYPE => 'namespace'
 165                         ),
 166                         'limit' => array (
 167                                 ApiBase :: PARAM_DFLT => 10,
 168                                 ApiBase :: PARAM_TYPE => 'limit',
 169                                 ApiBase :: PARAM_MIN => 1,
 170                                 ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
 171                                 ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
 172                         )
 173                 );
 174         }
 175
 176         public function getParamDescription() {
 177                 return array (
 178                         'from' => 'The page title to start enumerating from.',
 179                         'prefix' => 'Search for all page titles that begin with this value.',
 180                         'unique' => 'Only show unique links. Cannot be used with generator or prop=ids',
 181                         'prop' => 'What pieces of information to include',
 182                         'namespace' => 'The namespace to enumerate.',
 183                         'limit' => 'How many total links to return.',
 184                         'continue' => 'When more results are available, use this to continue.',
 185                 );
 186         }
 187
 188         public function getDescription() {
 189                 return 'Enumerate all links that point to a given namespace';
 190         }
 191
 192         public function getPossibleErrors() {
 193                 return array_merge( parent::getPossibleErrors(), array(
 194                         array( 'code' => 'params', 'info' => $this->getModuleName() . ' cannot be used as a generator in unique links mode' ),
 195                         array( 'code' => 'params', 'info' => $this->getModuleName() . ' cannot return corresponding page ids in unique links mode' ),
 196                         array( 'code' => 'params', 'info' => 'alcontinue and alfrom cannot be used together' ),
 197                         array( 'code' => 'badcontinue', 'info' => 'Invalid continue parameter' ),
 198                 ) );
 199         }
 200
 201         protected function getExamples() {
 202                 return array (
 203                         'api.php?action=query&list=alllinks&alunique&alfrom=B',
 204                 );
 205         }
 206
 207         public function getVersion() {
 208                 return __CLASS__ . ': $Id$';
 209         }
 210 }