includes/api/ApiQueryExternalLinks.php

   1 <?php
   2
   3 /**
   4  * Created on May 13, 2007
   5  *
   6  * API for MediaWiki 1.8+
   7  *
   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
  26 if ( !defined( 'MEDIAWIKI' ) ) {
  27         // Eclipse helper - will be ignored in production
  28         require_once( "ApiQueryBase.php" );
  29 }
  30
  31 /**
  32  * A query module to list all external URLs found on a given set of pages.
  33  *
  34  * @ingroup API
  35  */
  36 class ApiQueryExternalLinks extends ApiQueryBase {
  37
  38         public function __construct( $query, $moduleName ) {
  39                 parent::__construct( $query, $moduleName, 'el' );
  40         }
  41
  42         public function execute() {
  43                 if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
  44                         return;
  45                 }
  46
  47                 $params = $this->extractRequestParams();
  48                 $this->addFields( array(
  49                         'el_from',
  50                         'el_to'
  51                 ) );
  52
  53                 $this->addTables( 'externallinks' );
  54                 $this->addWhereFld( 'el_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
  55
  56                 // Don't order by el_from if it's constant in the WHERE clause
  57                 if ( count( $this->getPageSet()->getGoodTitles() ) != 1 ) {
  58                         $this->addOption( 'ORDER BY', 'el_from' );
  59                 }
  60
  61                 $this->addOption( 'LIMIT', $params['limit'] + 1 );
  62                 if ( !is_null( $params['offset'] ) ) {
  63                         $this->addOption( 'OFFSET', $params['offset'] );
  64                 }
  65
  66                 $res = $this->select( __METHOD__ );
  67
  68                 $count = 0;
  69                 foreach ( $res as $row ) {
  70                         if ( ++$count > $params['limit'] ) {
  71                                 // We've reached the one extra which shows that
  72                                 // there are additional pages to be had. Stop here...
  73                                 $this->setContinueEnumParameter( 'offset', @$params['offset'] + $params['limit'] );
  74                                 break;
  75                         }
  76                         $entry = array();
  77                         ApiResult::setContent( $entry, $row->el_to );
  78                         $fit = $this->addPageSubItem( $row->el_from, $entry );
  79                         if ( !$fit ) {
  80                                 $this->setContinueEnumParameter( 'offset', @$params['offset'] + $count - 1 );
  81                                 break;
  82                         }
  83                 }
  84         }
  85
  86         public function getCacheMode( $params ) {
  87                 return 'public';
  88         }
  89
  90         public function getAllowedParams() {
  91                 return array(
  92                         'limit' => array(
  93                                 ApiBase::PARAM_DFLT => 10,
  94                                 ApiBase::PARAM_TYPE => 'limit',
  95                                 ApiBase::PARAM_MIN => 1,
  96                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
  97                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
  98                         ),
  99                         'offset' => null,
 100                 );
 101         }
 102
 103         public function getParamDescription() {
 104                 return array(
 105                         'limit' => 'How many links to return',
 106                         'offset' => 'When more results are available, use this to continue',
 107                 );
 108         }
 109
 110         public function getDescription() {
 111                 return 'Returns all external urls (not interwikies) from the given page(s)';
 112         }
 113
 114         protected function getExamples() {
 115                 return array(
 116                         'Get a list of external links on the [[Main Page]]:',
 117                         '  api.php?action=query&prop=extlinks&titles=Main%20Page',
 118                 );
 119         }
 120
 121         public function getVersion() {
 122                 return __CLASS__ . ': $Id$';
 123         }
 124 }