includes/api/ApiQueryExtLinksUsage.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  * @ingroup API
  33  */
  34 class ApiQueryExtLinksUsage extends ApiQueryGeneratorBase {
  35
  36         public function __construct($query, $moduleName) {
  37                 parent :: __construct($query, $moduleName, 'eu');
  38         }
  39
  40         public function execute() {
  41                 $this->run();
  42         }
  43
  44         public function executeGenerator($resultPageSet) {
  45                 $this->run($resultPageSet);
  46         }
  47
  48         private function run($resultPageSet = null) {
  49
  50                 $params = $this->extractRequestParams();
  51
  52                 $protocol = $params['protocol'];
  53                 $query = $params['query'];
  54
  55                 // Find the right prefix
  56                 global $wgUrlProtocols;
  57                 if($protocol && !in_array($protocol, $wgUrlProtocols))
  58                 {
  59                         foreach ($wgUrlProtocols as $p) {
  60                                 if( substr( $p, 0, strlen( $protocol ) ) === $protocol ) {
  61                                         $protocol = $p;
  62                                         break;
  63                                 }
  64                         }
  65                 }
  66                 else
  67                         $protocol = null;
  68
  69                 $db = $this->getDB();
  70                 $this->addTables(array('page','externallinks'));        // must be in this order for 'USE INDEX'
  71                 $this->addOption('USE INDEX', 'el_index');
  72                 $this->addWhere('page_id=el_from');
  73                 $this->addWhereFld('page_namespace', $params['namespace']);
  74
  75                 if(!is_null($query) || $query != '')
  76                 {
  77                         if(is_null($protocol))
  78                                 $protocol = 'http://';
  79
  80                         $likeQuery = LinkFilter::makeLikeArray($query, $protocol);
  81                         if (!$likeQuery)
  82                                 $this->dieUsage('Invalid query', 'bad_query');
  83
  84                         $likeQuery = LinkFilter::keepOneWildcard($likeQuery);
  85                         $this->addWhere('el_index ' . $db->buildLike( $likeQuery ));
  86                 }
  87                 else if(!is_null($protocol))
  88                         $this->addWhere('el_index ' . $db->buildLike( "$protocol", $db->anyString() ));
  89
  90                 $prop = array_flip($params['prop']);
  91                 $fld_ids = isset($prop['ids']);
  92                 $fld_title = isset($prop['title']);
  93                 $fld_url = isset($prop['url']);
  94
  95                 if (is_null($resultPageSet)) {
  96                         $this->addFields(array (
  97                                 'page_id',
  98                                 'page_namespace',
  99                                 'page_title'
 100                         ));
 101                         $this->addFieldsIf('el_to', $fld_url);
 102                 } else {
 103                         $this->addFields($resultPageSet->getPageTableFields());
 104                 }
 105
 106                 $limit = $params['limit'];
 107                 $offset = $params['offset'];
 108                 $this->addOption('LIMIT', $limit +1);
 109                 if (isset ($offset))
 110                         $this->addOption('OFFSET', $offset);
 111
 112                 $res = $this->select(__METHOD__);
 113
 114                 $result = $this->getResult();
 115                 $count = 0;
 116                 while ($row = $db->fetchObject($res)) {
 117                         if (++ $count > $limit) {
 118                                 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
 119                                 $this->setContinueEnumParameter('offset', $offset+$limit);
 120                                 break;
 121                         }
 122
 123                         if (is_null($resultPageSet)) {
 124                                 $vals = array();
 125                                 if ($fld_ids)
 126                                         $vals['pageid'] = intval($row->page_id);
 127                                 if ($fld_title) {
 128                                         $title = Title :: makeTitle($row->page_namespace, $row->page_title);
 129                                         ApiQueryBase::addTitleInfo($vals, $title);
 130                                 }
 131                                 if ($fld_url)
 132                                         $vals['url'] = $row->el_to;
 133                                 $fit = $result->addValue(array('query', $this->getModuleName()), null, $vals);
 134                                 if(!$fit)
 135                                 {
 136                                         $this->setContinueEnumParameter('offset', $offset + $count - 1);
 137                                         break;
 138                                 }
 139                         } else {
 140                                 $resultPageSet->processDbRow($row);
 141                         }
 142                 }
 143                 $db->freeResult($res);
 144
 145                 if (is_null($resultPageSet)) {
 146                         $result->setIndexedTagName_internal(array('query', $this->getModuleName()),
 147                                         $this->getModulePrefix());
 148                 }
 149         }
 150
 151         public function getAllowedParams() {
 152                 global $wgUrlProtocols;
 153                 $protocols = array('');
 154                 foreach ($wgUrlProtocols as $p) {
 155                         $protocols[] = substr($p, 0, strpos($p,':'));
 156                 }
 157
 158                 return array (
 159                         'prop' => array (
 160                                 ApiBase :: PARAM_ISMULTI => true,
 161                                 ApiBase :: PARAM_DFLT => 'ids|title|url',
 162                                 ApiBase :: PARAM_TYPE => array (
 163                                         'ids',
 164                                         'title',
 165                                         'url'
 166                                 )
 167                         ),
 168                         'offset' => array (
 169                                 ApiBase :: PARAM_TYPE => 'integer'
 170                         ),
 171                         'protocol' => array (
 172                                 ApiBase :: PARAM_TYPE => $protocols,
 173                                 ApiBase :: PARAM_DFLT => '',
 174                         ),
 175                         'query' => null,
 176                         'namespace' => array (
 177                                 ApiBase :: PARAM_ISMULTI => true,
 178                                 ApiBase :: PARAM_TYPE => 'namespace'
 179                         ),
 180                         'limit' => array (
 181                                 ApiBase :: PARAM_DFLT => 10,
 182                                 ApiBase :: PARAM_TYPE => 'limit',
 183                                 ApiBase :: PARAM_MIN => 1,
 184                                 ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
 185                                 ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
 186                         )
 187                 );
 188         }
 189
 190         public function getParamDescription() {
 191                 return array (
 192                         'prop' => 'What pieces of information to include',
 193                         'offset' => 'Used for paging. Use the value returned for "continue"',
 194                         'protocol' => array(    'Protocol of the url. If empty and euquery set, the protocol is http.',
 195                                                 'Leave both this and euquery empty to list all external links'),
 196                         'query' => 'Search string without protocol. See [[Special:LinkSearch]]. Leave empty to list all external links',
 197                         'namespace' => 'The page namespace(s) to enumerate.',
 198                         'limit' => 'How many pages to return.'
 199                 );
 200         }
 201
 202         public function getDescription() {
 203                 return 'Enumerate pages that contain a given URL';
 204         }
 205
 206         protected function getExamples() {
 207                 return array (
 208                         'api.php?action=query&list=exturlusage&euquery=www.mediawiki.org'
 209                 );
 210         }
 211
 212         public function getVersion() {
 213                 return __CLASS__ . ': $Id$';
 214         }
 215 }