[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3   * API for MediaWiki 1.17+
   4   *
   5   * Created on May 14, 2010
   6   *
   7   * Copyright © 2010 Sam Reed
   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   * @file
  26   */
  27  
  28  /**
  29   * A query module to list all interwiki links on a page
  30   *
  31   * @ingroup API
  32   */
  33  class ApiQueryIWLinks extends ApiQueryBase {
  34  
  35  	public function __construct( ApiQuery $query, $moduleName ) {
  36          parent::__construct( $query, $moduleName, 'iw' );
  37      }
  38  
  39  	public function execute() {
  40          if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
  41              return;
  42          }
  43  
  44          $params = $this->extractRequestParams();
  45          $prop = array_flip( (array)$params['prop'] );
  46  
  47          if ( isset( $params['title'] ) && !isset( $params['prefix'] ) ) {
  48              $this->dieUsageMsg( array( 'missingparam', 'prefix' ) );
  49          }
  50  
  51          // Handle deprecated param
  52          $this->requireMaxOneParameter( $params, 'url', 'prop' );
  53          if ( $params['url'] ) {
  54              $this->logFeatureUsage( 'prop=iwlinks&iwurl' );
  55              $prop = array( 'url' => 1 );
  56          }
  57  
  58          $this->addFields( array(
  59              'iwl_from',
  60              'iwl_prefix',
  61              'iwl_title'
  62          ) );
  63  
  64          $this->addTables( 'iwlinks' );
  65          $this->addWhereFld( 'iwl_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
  66  
  67          if ( !is_null( $params['continue'] ) ) {
  68              $cont = explode( '|', $params['continue'] );
  69              $this->dieContinueUsageIf( count( $cont ) != 3 );
  70              $op = $params['dir'] == 'descending' ? '<' : '>';
  71              $db = $this->getDB();
  72              $iwlfrom = intval( $cont[0] );
  73              $iwlprefix = $db->addQuotes( $cont[1] );
  74              $iwltitle = $db->addQuotes( $cont[2] );
  75              $this->addWhere(
  76                  "iwl_from $op $iwlfrom OR " .
  77                  "(iwl_from = $iwlfrom AND " .
  78                  "(iwl_prefix $op $iwlprefix OR " .
  79                  "(iwl_prefix = $iwlprefix AND " .
  80                  "iwl_title $op= $iwltitle)))"
  81              );
  82          }
  83  
  84          $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
  85          if ( isset( $params['prefix'] ) ) {
  86              $this->addWhereFld( 'iwl_prefix', $params['prefix'] );
  87              if ( isset( $params['title'] ) ) {
  88                  $this->addWhereFld( 'iwl_title', $params['title'] );
  89                  $this->addOption( 'ORDER BY', 'iwl_from' . $sort );
  90              } else {
  91                  $this->addOption( 'ORDER BY', array(
  92                      'iwl_from' . $sort,
  93                      'iwl_title' . $sort
  94                  ) );
  95              }
  96          } else {
  97              // Don't order by iwl_from if it's constant in the WHERE clause
  98              if ( count( $this->getPageSet()->getGoodTitles() ) == 1 ) {
  99                  $this->addOption( 'ORDER BY', 'iwl_prefix' . $sort );
 100              } else {
 101                  $this->addOption( 'ORDER BY', array(
 102                      'iwl_from' . $sort,
 103                      'iwl_prefix' . $sort,
 104                      'iwl_title' . $sort
 105                  ) );
 106              }
 107          }
 108  
 109          $this->addOption( 'LIMIT', $params['limit'] + 1 );
 110          $res = $this->select( __METHOD__ );
 111  
 112          $count = 0;
 113          foreach ( $res as $row ) {
 114              if ( ++$count > $params['limit'] ) {
 115                  // We've reached the one extra which shows that
 116                  // there are additional pages to be had. Stop here...
 117                  $this->setContinueEnumParameter(
 118                      'continue',
 119                      "{$row->iwl_from}|{$row->iwl_prefix}|{$row->iwl_title}"
 120                  );
 121                  break;
 122              }
 123              $entry = array( 'prefix' => $row->iwl_prefix );
 124  
 125              if ( isset( $prop['url'] ) ) {
 126                  $title = Title::newFromText( "{$row->iwl_prefix}:{$row->iwl_title}" );
 127                  if ( $title ) {
 128                      $entry['url'] = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT );
 129                  }
 130              }
 131  
 132              ApiResult::setContent( $entry, $row->iwl_title );
 133              $fit = $this->addPageSubItem( $row->iwl_from, $entry );
 134              if ( !$fit ) {
 135                  $this->setContinueEnumParameter(
 136                      'continue',
 137                      "{$row->iwl_from}|{$row->iwl_prefix}|{$row->iwl_title}"
 138                  );
 139                  break;
 140              }
 141          }
 142      }
 143  
 144  	public function getCacheMode( $params ) {
 145          return 'public';
 146      }
 147  
 148  	public function getAllowedParams() {
 149          return array(
 150              'url' => array(
 151                  ApiBase::PARAM_DFLT => false,
 152                  ApiBase::PARAM_DEPRECATED => true,
 153              ),
 154              'prop' => array(
 155                  ApiBase::PARAM_ISMULTI => true,
 156                  ApiBase::PARAM_TYPE => array(
 157                      'url',
 158                  )
 159              ),
 160              'limit' => array(
 161                  ApiBase::PARAM_DFLT => 10,
 162                  ApiBase::PARAM_TYPE => 'limit',
 163                  ApiBase::PARAM_MIN => 1,
 164                  ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 165                  ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 166              ),
 167              'continue' => null,
 168              'prefix' => null,
 169              'title' => null,
 170              'dir' => array(
 171                  ApiBase::PARAM_DFLT => 'ascending',
 172                  ApiBase::PARAM_TYPE => array(
 173                      'ascending',
 174                      'descending'
 175                  )
 176              ),
 177          );
 178      }
 179  
 180  	public function getParamDescription() {
 181          return array(
 182              'prop' => array(
 183                  'Which additional properties to get for each interlanguage link',
 184                  ' url      - Adds the full URL',
 185              ),
 186              'url' => "Whether to get the full URL (Cannot be used with {$this->getModulePrefix()}prop)",
 187              'limit' => 'How many interwiki links to return',
 188              'continue' => 'When more results are available, use this to continue',
 189              'prefix' => 'Prefix for the interwiki',
 190              'title' => "Interwiki link to search for. Must be used with {$this->getModulePrefix()}prefix",
 191              'dir' => 'The direction in which to list',
 192          );
 193      }
 194  
 195  	public function getDescription() {
 196          return 'Returns all interwiki links from the given page(s).';
 197      }
 198  
 199  	public function getExamples() {
 200          return array(
 201              'api.php?action=query&prop=iwlinks&titles=Main%20Page'
 202                  => 'Get interwiki links from the [[Main Page]]',
 203          );
 204      }
 205  
 206  	public function getHelpUrls() {
 207          return 'https://www.mediawiki.org/wiki/API:Iwlinks';
 208      }
 209  }