includes/api/ApiQueryExternalLinks.php

   1 <?php
   2 /**
   3  *
   4  *
   5  * Created on May 13, 2007
   6  *
   7  * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  22  * http://www.gnu.org/copyleft/gpl.html
  23  *
  24  * @file
  25  */
  26
  27 if ( !defined( 'MEDIAWIKI' ) ) {
  28         // Eclipse helper - will be ignored in production
  29         require_once( "ApiQueryBase.php" );
  30 }
  31
  32 /**
  33  * A query module to list all external URLs found on a given set of pages.
  34  *
  35  * @ingroup API
  36  */
  37 class ApiQueryExternalLinks extends ApiQueryBase {
  38
  39         public function __construct( $query, $moduleName ) {
  40                 parent::__construct( $query, $moduleName, 'el' );
  41         }
  42
  43         public function execute() {
  44                 if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
  45                         return;
  46                 }
  47
  48                 $params = $this->extractRequestParams();
  49
  50                 $query = $params['query'];
  51                 $protocol = ApiQueryExtLinksUsage::getProtocolPrefix( $params['protocol'] );
  52
  53                 $this->addFields( array(
  54                         'el_from',
  55                         'el_to'
  56                 ) );
  57
  58                 $this->addTables( 'externallinks' );
  59                 $this->addWhereFld( 'el_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
  60
  61                 $whereQuery = $this->prepareUrlQuerySearchString( $query, $protocol );
  62
  63                 if ( $whereQuery !== null ) {
  64                         $this->addWhere( $whereQuery );
  65                 }
  66
  67                 // Don't order by el_from if it's constant in the WHERE clause
  68                 if ( count( $this->getPageSet()->getGoodTitles() ) != 1 ) {
  69                         $this->addOption( 'ORDER BY', 'el_from' );
  70                 }
  71
  72                 $this->addOption( 'LIMIT', $params['limit'] + 1 );
  73                 $offset = isset( $params['offset'] ) ? $params['offset'] : 0;
  74                 if ( $offset ) {
  75                         $this->addOption( 'OFFSET', $params['offset'] );
  76                 }
  77
  78                 $res = $this->select( __METHOD__ );
  79
  80                 $count = 0;
  81                 foreach ( $res as $row ) {
  82                         if ( ++$count > $params['limit'] ) {
  83                                 // We've reached the one extra which shows that
  84                                 // there are additional pages to be had. Stop here...
  85                                 $this->setContinueEnumParameter( 'offset', $offset + $params['limit'] );
  86                                 break;
  87                         }
  88                         $entry = array();
  89                         // We *could* run this through wfExpandUrl() but I think it's better to output the link verbatim, even if it's protocol-relative --Roan
  90                         ApiResult::setContent( $entry, $row->el_to );
  91                         $fit = $this->addPageSubItem( $row->el_from, $entry );
  92                         if ( !$fit ) {
  93                                 $this->setContinueEnumParameter( 'offset', $offset + $count - 1 );
  94                                 break;
  95                         }
  96                 }
  97         }
  98
  99         public function getCacheMode( $params ) {
 100                 return 'public';
 101         }
 102
 103         public function getAllowedParams() {
 104                 return array(
 105                         'limit' => array(
 106                                 ApiBase::PARAM_DFLT => 10,
 107                                 ApiBase::PARAM_TYPE => 'limit',
 108                                 ApiBase::PARAM_MIN => 1,
 109                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 110                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 111                         ),
 112                         'offset' => array(
 113                                 ApiBase::PARAM_TYPE => 'integer'
 114                         ),
 115                         'protocol' => array(
 116                                 ApiBase::PARAM_TYPE => ApiQueryExtLinksUsage::prepareProtocols(),
 117                                 ApiBase::PARAM_DFLT => '',
 118                         ),
 119                         'query' => null,
 120                 );
 121         }
 122
 123         public function getParamDescription() {
 124                 $p = $this->getModulePrefix();
 125                 return array(
 126                         'limit' => 'How many links to return',
 127                         'offset' => 'When more results are available, use this to continue',
 128                         'protocol' => array(
 129                                 "Protocol of the url. If empty and {$p}query set, the protocol is http.",
 130                                 "Leave both this and {$p}query empty to list all external links"
 131                         ),
 132                         'query' => 'Search string without protocol. Useful for checking whether a certain page contains a certain external url',
 133                 );
 134         }
 135
 136         public function getDescription() {
 137                 return 'Returns all external urls (not interwikies) from the given page(s)';
 138         }
 139
 140         public function getPossibleErrors() {
 141                 return array_merge( parent::getPossibleErrors(), array(
 142                         array( 'code' => 'bad_query', 'info' => 'Invalid query' ),
 143                 ) );
 144         }
 145
 146         protected function getExamples() {
 147                 return array(
 148                         'Get a list of external links on the [[Main Page]]:',
 149                         '  api.php?action=query&prop=extlinks&titles=Main%20Page',
 150                 );
 151         }
 152
 153         public function getHelpUrls() {
 154                 return 'http://www.mediawiki.org/wiki/API:Properties#extlinks_.2F_el';
 155         }
 156
 157         public function getVersion() {
 158                 return __CLASS__ . ': $Id$';
 159         }
 160 }