MediaWiki  1.30.0
ApiQueryContributors.php
Go to the documentation of this file.
1 <?php
39  const MAX_PAGES = 100;
40 
41  public function __construct( ApiQuery $query, $moduleName ) {
42  // "pc" is short for "page contributors", "co" was already taken by the
43  // GeoData extension's prop=coordinates.
44  parent::__construct( $query, $moduleName, 'pc' );
45  }
46 
47  public function execute() {
48  $db = $this->getDB();
49  $params = $this->extractRequestParams();
50  $this->requireMaxOneParameter( $params, 'group', 'excludegroup', 'rights', 'excluderights' );
51 
52  // Only operate on existing pages
53  $pages = array_keys( $this->getPageSet()->getGoodTitles() );
54 
55  // Filter out already-processed pages
56  if ( $params['continue'] !== null ) {
57  $cont = explode( '|', $params['continue'] );
58  $this->dieContinueUsageIf( count( $cont ) != 2 );
59  $cont_page = (int)$cont[0];
60  $pages = array_filter( $pages, function ( $v ) use ( $cont_page ) {
61  return $v >= $cont_page;
62  } );
63  }
64  if ( !count( $pages ) ) {
65  // Nothing to do
66  return;
67  }
68 
69  // Apply MAX_PAGES, leaving any over the limit for a continue.
70  sort( $pages );
71  $continuePages = null;
72  if ( count( $pages ) > self::MAX_PAGES ) {
73  $continuePages = $pages[self::MAX_PAGES] . '|0';
74  $pages = array_slice( $pages, 0, self::MAX_PAGES );
75  }
76 
77  $result = $this->getResult();
78 
79  // First, count anons
80  $this->addTables( 'revision' );
81  $this->addFields( [
82  'page' => 'rev_page',
83  'anons' => 'COUNT(DISTINCT rev_user_text)',
84  ] );
85  $this->addWhereFld( 'rev_page', $pages );
86  $this->addWhere( 'rev_user = 0' );
87  $this->addWhere( $db->bitAnd( 'rev_deleted', Revision::DELETED_USER ) . ' = 0' );
88  $this->addOption( 'GROUP BY', 'rev_page' );
89  $res = $this->select( __METHOD__ );
90  foreach ( $res as $row ) {
91  $fit = $result->addValue( [ 'query', 'pages', $row->page ],
92  'anoncontributors', (int)$row->anons
93  );
94  if ( !$fit ) {
95  // This not fitting isn't reasonable, so it probably means that
96  // some other module used up all the space. Just set a dummy
97  // continue and hope it works next time.
98  $this->setContinueEnumParameter( 'continue',
99  $params['continue'] !== null ? $params['continue'] : '0|0'
100  );
101 
102  return;
103  }
104  }
105 
106  // Next, add logged-in users
107  $this->resetQueryParams();
108  $this->addTables( 'revision' );
109  $this->addFields( [
110  'page' => 'rev_page',
111  'user' => 'rev_user',
112  'username' => 'MAX(rev_user_text)', // Non-MySQL databases don't like partial group-by
113  ] );
114  $this->addWhereFld( 'rev_page', $pages );
115  $this->addWhere( 'rev_user != 0' );
116  $this->addWhere( $db->bitAnd( 'rev_deleted', Revision::DELETED_USER ) . ' = 0' );
117  $this->addOption( 'GROUP BY', 'rev_page, rev_user' );
118  $this->addOption( 'LIMIT', $params['limit'] + 1 );
119 
120  // Force a sort order to ensure that properties are grouped by page
121  // But only if pp_page is not constant in the WHERE clause.
122  if ( count( $pages ) > 1 ) {
123  $this->addOption( 'ORDER BY', 'rev_page, rev_user' );
124  } else {
125  $this->addOption( 'ORDER BY', 'rev_user' );
126  }
127 
128  $limitGroups = [];
129  if ( $params['group'] ) {
130  $excludeGroups = false;
131  $limitGroups = $params['group'];
132  } elseif ( $params['excludegroup'] ) {
133  $excludeGroups = true;
134  $limitGroups = $params['excludegroup'];
135  } elseif ( $params['rights'] ) {
136  $excludeGroups = false;
137  foreach ( $params['rights'] as $r ) {
138  $limitGroups = array_merge( $limitGroups, User::getGroupsWithPermission( $r ) );
139  }
140 
141  // If no group has the rights requested, no need to query
142  if ( !$limitGroups ) {
143  if ( $continuePages !== null ) {
144  // But we still need to continue for the next page's worth
145  // of anoncontributors
146  $this->setContinueEnumParameter( 'continue', $continuePages );
147  }
148 
149  return;
150  }
151  } elseif ( $params['excluderights'] ) {
152  $excludeGroups = true;
153  foreach ( $params['excluderights'] as $r ) {
154  $limitGroups = array_merge( $limitGroups, User::getGroupsWithPermission( $r ) );
155  }
156  }
157 
158  if ( $limitGroups ) {
159  $limitGroups = array_unique( $limitGroups );
160  $this->addTables( 'user_groups' );
161  $this->addJoinConds( [ 'user_groups' => [
162  $excludeGroups ? 'LEFT OUTER JOIN' : 'INNER JOIN',
163  [
164  'ug_user=rev_user',
165  'ug_group' => $limitGroups,
166  'ug_expiry IS NULL OR ug_expiry >= ' . $db->addQuotes( $db->timestamp() )
167  ]
168  ] ] );
169  $this->addWhereIf( 'ug_user IS NULL', $excludeGroups );
170  }
171 
172  if ( $params['continue'] !== null ) {
173  $cont = explode( '|', $params['continue'] );
174  $this->dieContinueUsageIf( count( $cont ) != 2 );
175  $cont_page = (int)$cont[0];
176  $cont_user = (int)$cont[1];
177  $this->addWhere(
178  "rev_page > $cont_page OR " .
179  "(rev_page = $cont_page AND " .
180  "rev_user >= $cont_user)"
181  );
182  }
183 
184  $res = $this->select( __METHOD__ );
185  $count = 0;
186  foreach ( $res as $row ) {
187  if ( ++$count > $params['limit'] ) {
188  // We've reached the one extra which shows that
189  // there are additional pages to be had. Stop here...
190  $this->setContinueEnumParameter( 'continue', $row->page . '|' . $row->user );
191 
192  return;
193  }
194 
195  $fit = $this->addPageSubItem( $row->page,
196  [ 'userid' => (int)$row->user, 'name' => $row->username ],
197  'user'
198  );
199  if ( !$fit ) {
200  $this->setContinueEnumParameter( 'continue', $row->page . '|' . $row->user );
201 
202  return;
203  }
204  }
205 
206  if ( $continuePages !== null ) {
207  $this->setContinueEnumParameter( 'continue', $continuePages );
208  }
209  }
210 
211  public function getCacheMode( $params ) {
212  return 'public';
213  }
214 
215  public function getAllowedParams() {
216  $userGroups = User::getAllGroups();
217  $userRights = User::getAllRights();
218 
219  return [
220  'group' => [
221  ApiBase::PARAM_TYPE => $userGroups,
222  ApiBase::PARAM_ISMULTI => true,
223  ],
224  'excludegroup' => [
225  ApiBase::PARAM_TYPE => $userGroups,
226  ApiBase::PARAM_ISMULTI => true,
227  ],
228  'rights' => [
229  ApiBase::PARAM_TYPE => $userRights,
230  ApiBase::PARAM_ISMULTI => true,
231  ],
232  'excluderights' => [
233  ApiBase::PARAM_TYPE => $userRights,
234  ApiBase::PARAM_ISMULTI => true,
235  ],
236  'limit' => [
237  ApiBase::PARAM_DFLT => 10,
238  ApiBase::PARAM_TYPE => 'limit',
239  ApiBase::PARAM_MIN => 1,
242  ],
243  'continue' => [
244  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
245  ],
246  ];
247  }
248 
249  protected function getExamplesMessages() {
250  return [
251  'action=query&prop=contributors&titles=Main_Page'
252  => 'apihelp-query+contributors-example-simple',
253  ];
254  }
255 
256  public function getHelpUrls() {
257  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Contributors';
258  }
259 }
Revision\DELETED_USER
const DELETED_USER
Definition: Revision.php:92
ApiQueryContributors
A query module to show contributors to a page.
Definition: ApiQueryContributors.php:34
ApiQueryBase\addFields
addFields( $value)
Add a set of fields to select to the internal array.
Definition: ApiQueryBase.php:196
ApiQuery
This is the main query class.
Definition: ApiQuery.php:40
ApiQueryContributors\MAX_PAGES
const MAX_PAGES
We don't want to process too many pages at once (it hits cold database pages too heavily),...
Definition: ApiQueryContributors.php:39
ApiQueryBase\resetQueryParams
resetQueryParams()
Blank the internal arrays with query parameters.
Definition: ApiQueryBase.php:148
captcha-old.count
count
Definition: captcha-old.py:249
ApiBase\PARAM_HELP_MSG
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition: ApiBase.php:128
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1963
ApiBase\PARAM_TYPE
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition: ApiBase.php:91
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:632
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
$params
$params
Definition: styleTest.css.php:40
$res
$res
Definition: database.txt:21
ApiQueryContributors\__construct
__construct(ApiQuery $query, $moduleName)
Definition: ApiQueryContributors.php:41
ApiQueryBase\addOption
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
Definition: ApiQueryBase.php:331
php
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
ApiQueryContributors\getExamplesMessages
getExamplesMessages()
Returns usage examples for this module.
Definition: ApiQueryContributors.php:249
$query
null for the 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:1581
ApiBase\PARAM_MIN
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:103
ApiQueryBase
This is a base class for all Query modules.
Definition: ApiQueryBase.php:37
ApiBase\LIMIT_BIG1
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:225
ApiQueryBase\getDB
getDB()
Get the Query database connection (read-only)
Definition: ApiQueryBase.php:109
ApiBase\PARAM_MAX
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:94
ApiQueryContributors\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiQueryContributors.php:215
ApiQueryBase\addTables
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
Definition: ApiQueryBase.php:162
ApiQueryBase\select
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
Definition: ApiQueryBase.php:356
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:740
ApiQueryContributors\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiQueryContributors.php:47
ApiBase\dieContinueUsageIf
dieContinueUsageIf( $condition)
Die with the 'badcontinue' error.
Definition: ApiBase.php:2026
ApiQueryBase\addJoinConds
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
Definition: ApiQueryBase.php:185
ApiQueryBase\addWhereFld
addWhereFld( $field, $value)
Equivalent to addWhere(array($field => $value))
Definition: ApiQueryBase.php:264
User\getAllGroups
static getAllGroups()
Return the set of defined explicit groups.
Definition: User.php:4885
ApiBase\requireMaxOneParameter
requireMaxOneParameter( $params, $required)
Die if more than one of a certain set of parameters is set and not false.
Definition: ApiBase.php:814
User\getAllRights
static getAllRights()
Get a list of all available permissions.
Definition: User.php:4897
ApiQueryBase\getPageSet
getPageSet()
Get the PageSet object to work on.
Definition: ApiQueryBase.php:134
ApiQueryContributors\getHelpUrls
getHelpUrls()
Return links to more detailed help pages about the module.
Definition: ApiQueryContributors.php:256
ApiQueryContributors\getCacheMode
getCacheMode( $params)
Get the cache mode for the data generated by this module.
Definition: ApiQueryContributors.php:211
ApiBase\LIMIT_BIG2
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:227
ApiBase\PARAM_DFLT
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:52
as
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
ApiBase\PARAM_ISMULTI
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:55
ApiBase\PARAM_MAX2
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right,...
Definition: ApiBase.php:100
ApiQueryBase\addWhere
addWhere( $value)
Add a set of WHERE clauses to the internal array.
Definition: ApiQueryBase.php:231
ApiQueryBase\setContinueEnumParameter
setContinueEnumParameter( $paramName, $paramValue)
Set a query-continue value.
Definition: ApiQueryBase.php:535
ApiQueryBase\addPageSubItem
addPageSubItem( $pageId, $item, $elemname=null)
Same as addPageSubItems(), but one element of $data at a time.
Definition: ApiQueryBase.php:514
ApiQueryBase\addWhereIf
addWhereIf( $value, $condition)
Same as addWhere(), but add the WHERE clauses only if a condition is met.
Definition: ApiQueryBase.php:249
User\getGroupsWithPermission
static getGroupsWithPermission( $role)
Get all the groups who have a given permission.
Definition: User.php:4768