MediaWiki 1.30.2

[autoinstallsdev/mediawiki.git] / includes / api / ApiQueryExternalLinks.php

diff --git a/includes/api/ApiQueryExternalLinks.php b/includes/api/ApiQueryExternalLinks.php
index 440b31d6f05c64c66e23b366ed2aeeab341b873b..71fd6d1b4b776cd7349c9e41ed5c32ce35511145 100644 (file)
--- a/includes/api/ApiQueryExternalLinks.php
+++ b/includes/api/ApiQueryExternalLinks.php
@@ -1,11 +1,10 @@
 <?php
-
-/*
- * Created on May 13, 2007
+/**
  *
- * API for MediaWiki 1.8+
  *
- * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
+ * Created on May 13, 2007
+ *
+ * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -19,75 +18,122 @@
  *
  * You should have received a copy of the GNU General Public License along
  * with this program; if not, write to the Free Software Foundation, Inc.,
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
  */
 
-if (!defined('MEDIAWIKI')) {
-       // Eclipse helper - will be ignored in production
-       require_once ("ApiQueryBase.php");
-}
-
 /**
  * A query module to list all external URLs found on a given set of pages.
- * 
- * @addtogroup API
+ *
+ * @ingroup API
  */
 class ApiQueryExternalLinks extends ApiQueryBase {
 
-       public function __construct($query, $moduleName) {
-               parent :: __construct($query, $moduleName, 'el');
+       public function __construct( ApiQuery $query, $moduleName ) {
+               parent::__construct( $query, $moduleName, 'el' );
        }
 
        public function execute() {
+               if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
+                       return;
+               }
+
+               $params = $this->extractRequestParams();
 
-               $this->addFields(array (
+               $query = $params['query'];
+               $protocol = ApiQueryExtLinksUsage::getProtocolPrefix( $params['protocol'] );
+
+               $this->addFields( [
                        'el_from',
                        'el_to'
-               ));
-               
-               $this->addTables('externallinks');
-               $this->addWhereFld('el_from', array_keys($this->getPageSet()->getGoodTitles()));
-
-               $db = $this->getDB();
-               $res = $this->select(__METHOD__);
-                       
-               $data = array();
-               $lastId = 0;    // database has no ID 0 
-               while ($row = $db->fetchObject($res)) {
-                       if ($lastId != $row->el_from) {
-                               if($lastId != 0) {
-                                       $this->addPageSubItems($lastId, $data);
-                                       $data = array();
-                               }
-                               $lastId = $row->el_from;
-                       }
-                       
-                       $entry = array();
-                       ApiResult :: setContent($entry, $row->el_to);
-                       $data[] = $entry;
+               ] );
+
+               $this->addTables( 'externallinks' );
+               $this->addWhereFld( 'el_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
+
+               $whereQuery = $this->prepareUrlQuerySearchString( $query, $protocol );
+
+               if ( $whereQuery !== null ) {
+                       $this->addWhere( $whereQuery );
+               }
+
+               // Don't order by el_from if it's constant in the WHERE clause
+               if ( count( $this->getPageSet()->getGoodTitles() ) != 1 ) {
+                       $this->addOption( 'ORDER BY', 'el_from' );
+               }
+
+               // If we're querying all protocols, use DISTINCT to avoid repeating protocol-relative links twice
+               if ( $protocol === null ) {
+                       $this->addOption( 'DISTINCT' );
+               }
+
+               $this->addOption( 'LIMIT', $params['limit'] + 1 );
+               $offset = isset( $params['offset'] ) ? $params['offset'] : 0;
+               if ( $offset ) {
+                       $this->addOption( 'OFFSET', $params['offset'] );
                }
 
-               if($lastId != 0) {
-                       $this->addPageSubItems($lastId, $data);
+               $res = $this->select( __METHOD__ );
+
+               $count = 0;
+               foreach ( $res as $row ) {
+                       if ( ++$count > $params['limit'] ) {
+                               // We've reached the one extra which shows that
+                               // there are additional pages to be had. Stop here...
+                               $this->setContinueEnumParameter( 'offset', $offset + $params['limit'] );
+                               break;
+                       }
+                       $entry = [];
+                       $to = $row->el_to;
+                       // expand protocol-relative urls
+                       if ( $params['expandurl'] ) {
+                               $to = wfExpandUrl( $to, PROTO_CANONICAL );
+                       }
+                       ApiResult::setContentValue( $entry, 'url', $to );
+                       $fit = $this->addPageSubItem( $row->el_from, $entry );
+                       if ( !$fit ) {
+                               $this->setContinueEnumParameter( 'offset', $offset + $count - 1 );
+                               break;
+                       }
                }
+       }
 
-               $db->freeResult($res);
+       public function getCacheMode( $params ) {
+               return 'public';
        }
 
-       protected function getDescription() {
-               return 'Returns all external urls (not interwikies) from the given page(s)';
+       public function getAllowedParams() {
+               return [
+                       'limit' => [
+                               ApiBase::PARAM_DFLT => 10,
+                               ApiBase::PARAM_TYPE => 'limit',
+                               ApiBase::PARAM_MIN => 1,
+                               ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
+                               ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
+                       ],
+                       'offset' => [
+                               ApiBase::PARAM_TYPE => 'integer',
+                               ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
+                       ],
+                       'protocol' => [
+                               ApiBase::PARAM_TYPE => ApiQueryExtLinksUsage::prepareProtocols(),
+                               ApiBase::PARAM_DFLT => '',
+                       ],
+                       'query' => null,
+                       'expandurl' => false,
+               ];
        }
 
-       protected function getExamples() {
-               return array (
-                               "Get a list of external links on the [[Main Page]]:",
-                               "  api.php?action=query&prop=extlinks&titles=Main%20Page",
-                       );
+       protected function getExamplesMessages() {
+               return [
+                       'action=query&prop=extlinks&titles=Main%20Page'
+                               => 'apihelp-query+extlinks-example-simple',
+               ];
        }
 
-       public function getVersion() {
-               return __CLASS__ . ': $Id: ApiQueryExternalLinks.php 23819 2007-07-07 03:05:09Z yurik $';
+       public function getHelpUrls() {
+               return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Extlinks';
        }
 }
-