MediaWiki  1.28.0
ApiQueryExternalLinks.php
Go to the documentation of this file.
1 <?php
33 
34  public function __construct( ApiQuery $query, $moduleName ) {
35  parent::__construct( $query, $moduleName, 'el' );
36  }
37 
38  public function execute() {
39  if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
40  return;
41  }
42 
43  $params = $this->extractRequestParams();
44 
45  $query = $params['query'];
46  $protocol = ApiQueryExtLinksUsage::getProtocolPrefix( $params['protocol'] );
47 
48  $this->addFields( [
49  'el_from',
50  'el_to'
51  ] );
52 
53  $this->addTables( 'externallinks' );
54  $this->addWhereFld( 'el_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
55 
56  $whereQuery = $this->prepareUrlQuerySearchString( $query, $protocol );
57 
58  if ( $whereQuery !== null ) {
59  $this->addWhere( $whereQuery );
60  }
61 
62  // Don't order by el_from if it's constant in the WHERE clause
63  if ( count( $this->getPageSet()->getGoodTitles() ) != 1 ) {
64  $this->addOption( 'ORDER BY', 'el_from' );
65  }
66 
67  // If we're querying all protocols, use DISTINCT to avoid repeating protocol-relative links twice
68  if ( $protocol === null ) {
69  $this->addOption( 'DISTINCT' );
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 = [];
89  $to = $row->el_to;
90  // expand protocol-relative urls
91  if ( $params['expandurl'] ) {
92  $to = wfExpandUrl( $to, PROTO_CANONICAL );
93  }
94  ApiResult::setContentValue( $entry, 'url', $to );
95  $fit = $this->addPageSubItem( $row->el_from, $entry );
96  if ( !$fit ) {
97  $this->setContinueEnumParameter( 'offset', $offset + $count - 1 );
98  break;
99  }
100  }
101  }
102 
103  public function getCacheMode( $params ) {
104  return 'public';
105  }
106 
107  public function getAllowedParams() {
108  return [
109  'limit' => [
110  ApiBase::PARAM_DFLT => 10,
111  ApiBase::PARAM_TYPE => 'limit',
112  ApiBase::PARAM_MIN => 1,
115  ],
116  'offset' => [
117  ApiBase::PARAM_TYPE => 'integer',
118  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
119  ],
120  'protocol' => [
122  ApiBase::PARAM_DFLT => '',
123  ],
124  'query' => null,
125  'expandurl' => false,
126  ];
127  }
128 
129  protected function getExamplesMessages() {
130  return [
131  'action=query&prop=extlinks&titles=Main%20Page'
132  => 'apihelp-query+extlinks-example-simple',
133  ];
134  }
135 
136  public function getHelpUrls() {
137  return 'https://www.mediawiki.org/wiki/API:Extlinks';
138  }
139 }
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:88
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:179
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1555
static getProtocolPrefix($protocol)
addWhereFld($field, $value)
Equivalent to addWhere(array($field => $value))
addPageSubItem($pageId, $item, $elemname=null)
Same as addPageSubItems(), but one element of $data at a time.
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:50
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:177
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:91
This is a base class for all Query modules.
extractRequestParams($parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:678
getPageSet()
Get the PageSet object to work on.
select($method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
wfExpandUrl($url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
addWhere($value)
Add a set of WHERE clauses to the internal array.
static setContentValue(array &$arr, $name, $value, $flags=0)
Add an output value to the array by name and mark as META_CONTENT.
Definition: ApiResult.php:480
prepareUrlQuerySearchString($query=null, $protocol=null)
$res
Definition: database.txt:21
addOption($name, $value=null)
Add an option such as LIMIT or USE INDEX.
$params
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right, for PARAM_TYPE 'limit'.
Definition: ApiBase.php:97
This is the main query class.
Definition: ApiQuery.php:38
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:125
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
const PROTO_CANONICAL
Definition: Defines.php:227
addFields($value)
Add a set of fields to select to the internal array.
setContinueEnumParameter($paramName, $paramValue)
Set a query-continue value.
$count
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:100
addTables($tables, $alias=null)
Add a set of tables to the internal array.