includes/api/ApiQueryExternalLinks.php

   1 <?php
   2
   3 /*
   4  * Created on May 13, 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  * 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                 $params = $this->extractRequestParams();
  47                 $this->addFields(array (
  48                         'el_from',
  49                         'el_to'
  50                 ));
  51
  52                 $this->addTables('externallinks');
  53                 $this->addWhereFld('el_from', array_keys($this->getPageSet()->getGoodTitles()));
  54                 # Don't order by el_from if it's constant in the WHERE clause
  55                 if(count($this->getPageSet()->getGoodTitles()) != 1)
  56                         $this->addOption('ORDER BY', 'el_from');
  57                 $this->addOption('LIMIT', $params['limit'] + 1);
  58                 if(!is_null($params['offset']))
  59                         $this->addOption('OFFSET', $params['offset']);
  60
  61                 $db = $this->getDB();
  62                 $res = $this->select(__METHOD__);
  63
  64                 $data = array();
  65                 $lastId = 0;    // database has no ID 0
  66                 $count = 0;
  67                 while ($row = $db->fetchObject($res)) {
  68                         if (++$count > $params['limit']) {
  69                                 // We've reached the one extra which shows that
  70                                 // there are additional pages to be had. Stop here...
  71                                 $this->setContinueEnumParameter('offset', @$params['offset'] + $params['limit']);
  72                                 break;
  73                         }
  74                         if ($lastId != $row->el_from) {
  75                                 if($lastId != 0) {
  76                                         $this->addPageSubItems($lastId, $data);
  77                                         $data = array();
  78                                 }
  79                                 $lastId = $row->el_from;
  80                         }
  81
  82                         $entry = array();
  83                         ApiResult :: setContent($entry, $row->el_to);
  84                         $data[] = $entry;
  85                 }
  86
  87                 if($lastId != 0) {
  88                         $this->addPageSubItems($lastId, $data);
  89                 }
  90
  91                 $db->freeResult($res);
  92         }
  93
  94         public function getAllowedParams() {
  95                 return array(
  96                                 'limit' => array(
  97                                         ApiBase :: PARAM_DFLT => 10,
  98                                         ApiBase :: PARAM_TYPE => 'limit',
  99                                         ApiBase :: PARAM_MIN => 1,
 100                                         ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
 101                                         ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
 102                                 ),
 103                                 'offset' => null,
 104                 );
 105         }
 106
 107         public function getParamDescription () {
 108                 return array(
 109                         'limit' => 'How many links to return',
 110                         'offset' => 'When more results are available, use this to continue',
 111                 );
 112         }
 113
 114         public function getDescription() {
 115                 return 'Returns all external urls (not interwikies) from the given page(s)';
 116         }
 117
 118         protected function getExamples() {
 119                 return array (
 120                                 "Get a list of external links on the [[Main Page]]:",
 121                                 "  api.php?action=query&prop=extlinks&titles=Main%20Page",
 122                         );
 123         }
 124
 125         public function getVersion() {
 126                 return __CLASS__ . ': $Id$';
 127         }
 128 }