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