MediaWiki  1.23.0
ApiQueryContributors.php
Go to the documentation of this file.
1 <?php
39  const MAX_PAGES = 100;
40 
41  public function __construct( $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( array(
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( array( 'query', 'pages', $row->page ),
92  'anoncontributors', $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( array(
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 = array();
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( array( 'user_groups' => array(
162  $excludeGroups ? 'LEFT OUTER JOIN' : 'INNER JOIN',
163  array( 'ug_user=rev_user', 'ug_group' => $limitGroups )
164  ) ) );
165  $this->addWhereIf( 'ug_user IS NULL', $excludeGroups );
166  }
167 
168  if ( $params['continue'] !== null ) {
169  $cont = explode( '|', $params['continue'] );
170  $this->dieContinueUsageIf( count( $cont ) != 2 );
171  $cont_page = (int)$cont[0];
172  $cont_user = (int)$cont[1];
173  $this->addWhere(
174  "rev_page > $cont_page OR " .
175  "(rev_page = $cont_page AND " .
176  "rev_user >= $cont_user)"
177  );
178  }
179 
180  $res = $this->select( __METHOD__ );
181  $count = 0;
182  foreach ( $res as $row ) {
183  if ( ++$count > $params['limit'] ) {
184  // We've reached the one extra which shows that
185  // there are additional pages to be had. Stop here...
186  $this->setContinueEnumParameter( 'continue', $row->page . '|' . $row->user );
187 
188  return;
189  }
190 
191  $fit = $this->addPageSubItem( $row->page,
192  array( 'userid' => $row->user, 'name' => $row->username ),
193  'user'
194  );
195  if ( !$fit ) {
196  $this->setContinueEnumParameter( 'continue', $row->page . '|' . $row->user );
197 
198  return;
199  }
200  }
201 
202  if ( $continuePages !== null ) {
203  $this->setContinueEnumParameter( 'continue', $continuePages );
204  }
205  }
206 
207  public function getCacheMode( $params ) {
208  return 'public';
209  }
210 
211  public function getAllowedParams() {
212  $userGroups = User::getAllGroups();
213  $userRights = User::getAllRights();
214 
215  return array(
216  'group' => array(
217  ApiBase::PARAM_TYPE => $userGroups,
218  ApiBase::PARAM_ISMULTI => true,
219  ),
220  'excludegroup' => array(
221  ApiBase::PARAM_TYPE => $userGroups,
222  ApiBase::PARAM_ISMULTI => true,
223  ),
224  'rights' => array(
225  ApiBase::PARAM_TYPE => $userRights,
226  ApiBase::PARAM_ISMULTI => true,
227  ),
228  'excluderights' => array(
229  ApiBase::PARAM_TYPE => $userRights,
230  ApiBase::PARAM_ISMULTI => true,
231  ),
232  'limit' => array(
233  ApiBase::PARAM_DFLT => 10,
234  ApiBase::PARAM_TYPE => 'limit',
235  ApiBase::PARAM_MIN => 1,
238  ),
239  'continue' => null,
240  );
241  }
242 
243  public function getParamDescription() {
244  return array(
245  'group' => array(
246  'Limit users to given group name(s)',
247  'Does not include implicit or auto-promoted groups like *, user, or autoconfirmed'
248  ),
249  'excludegroup' => array(
250  'Exclude users in given group name(s)',
251  'Does not include implicit or auto-promoted groups like *, user, or autoconfirmed'
252  ),
253  'rights' => array(
254  'Limit users to those having given right(s)',
255  'Does not include rights granted by implicit or auto-promoted groups ' .
256  'like *, user, or autoconfirmed'
257  ),
258  'excluderights' => array(
259  'Limit users to those not having given right(s)',
260  'Does not include rights granted by implicit or auto-promoted groups ' .
261  'like *, user, or autoconfirmed'
262  ),
263  'limit' => 'How many contributors to return',
264  'continue' => 'When more results are available, use this to continue',
265  );
266  }
267 
268  public function getPossibleErrors() {
269  return array_merge( parent::getPossibleErrors(),
271  array( 'group', 'excludegroup', 'rights', 'excluderights' )
272  )
273  );
274  }
275 
276  public function getDescription() {
277  return 'Get the list of logged-in contributors and ' .
278  'the count of anonymous contributors to a page.';
279  }
280 
281  public function getExamples() {
282  return array(
283  'api.php?action=query&prop=contributors&titles=Main_Page',
284  );
285  }
286 
287  public function getHelpUrls() {
288  return 'https://www.mediawiki.org/wiki/API:Properties#contributors_.2F_pc';
289  }
290 }
Revision\DELETED_USER
const DELETED_USER
Definition: Revision.php:67
ApiQueryContributors
A query module to show contributors to a page.
Definition: ApiQueryContributors.php:34
$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. $reader:XMLReader object $logInfo:Array of information Return false to stop further processing of the tag 'ImportHandlePageXMLTag':When parsing a XML tag in a page. $reader:XMLReader object $pageInfo:Array of information Return false to stop further processing of the tag 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information Return false to stop further processing of the tag 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. $reader:XMLReader object Return false to stop further processing of the tag 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. $reader:XMLReader object $revisionInfo:Array of information Return false to stop further processing of the tag '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 '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. '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 '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 '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 wfIsTrustedProxy() $ip:IP being check $result:Change this value to override the result of wfIsTrustedProxy() '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 User::isValidEmailAddr(), 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. '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 '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) '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:Associative array mapping language codes to prefixed links of the form "language:title". & $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. 'LinkBegin':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:1528
ApiQueryBase\addFields
addFields( $value)
Add a set of fields to select to the internal array.
Definition: ApiQueryBase.php:117
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
php
skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had been been the default skin since before being replaced by Vector largely rewritten in while keeping its appearance Several legacy skins were removed in the as the burden of supporting them became too heavy to bear Those in etc for skin dependent CSS etc for skin dependent JavaScript These can also be customised on a per user by etc This feature has led to a wide variety of user styles becoming that gallery is a good place to ending in php
Definition: skin.txt:62
ApiQueryBase\resetQueryParams
resetQueryParams()
Blank the internal arrays with query parameters.
Definition: ApiQueryBase.php:68
ApiBase\PARAM_TYPE
const PARAM_TYPE
Definition: ApiBase.php:50
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:205
ApiQueryBase\select
select( $method, $extraQuery=array())
Execute a SELECT query based on the values in the internal arrays.
Definition: ApiQueryBase.php:274
ApiQueryContributors\getParamDescription
getParamDescription()
Returns an array of parameter descriptions.
Definition: ApiQueryContributors.php:243
ApiQueryContributors\getPossibleErrors
getPossibleErrors()
Definition: ApiQueryContributors.php:268
$params
$params
Definition: styleTest.css.php:40
ApiQueryContributors\__construct
__construct( $query, $moduleName)
Definition: ApiQueryContributors.php:41
ApiQueryBase\addOption
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
Definition: ApiQueryBase.php:252
ApiBase\PARAM_MIN
const PARAM_MIN
Definition: ApiBase.php:56
ApiQueryBase
This is a base class for all Query modules.
Definition: ApiQueryBase.php:34
ApiBase\LIMIT_BIG1
const LIMIT_BIG1
Definition: ApiBase.php:78
ApiQueryContributors\getExamples
getExamples()
Returns usage examples for this module.
Definition: ApiQueryContributors.php:281
ApiQueryBase\getDB
getDB()
Get the Query database connection (read-only)
Definition: ApiQueryBase.php:417
ApiBase\PARAM_MAX
const PARAM_MAX
Definition: ApiBase.php:52
ApiQueryContributors\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiQueryContributors.php:211
ApiQueryBase\addTables
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
Definition: ApiQueryBase.php:82
array
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:687
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 $prefix.
Definition: ApiBase.php:1965
ApiQueryBase\addJoinConds
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
Definition: ApiQueryBase.php:106
ApiQueryBase\addWhereFld
addWhereFld( $field, $value)
Equivalent to addWhere(array($field => $value))
Definition: ApiQueryBase.php:185
User\getAllGroups
static getAllGroups()
Return the set of defined explicit groups.
Definition: User.php:4221
ApiQueryContributors\getDescription
getDescription()
Returns the description string for this module.
Definition: ApiQueryContributors.php:276
User\getAllRights
static getAllRights()
Get a list of all available permissions.
Definition: User.php:4233
ApiQueryBase\getPageSet
getPageSet()
Get the PageSet object to work on.
Definition: ApiQueryBase.php:441
$count
$count
Definition: UtfNormalTest2.php:96
ApiQueryContributors\getHelpUrls
getHelpUrls()
Definition: ApiQueryContributors.php:287
ApiQueryContributors\getCacheMode
getCacheMode( $params)
Get the cache mode for the data generated by this module.
Definition: ApiQueryContributors.php:207
ApiBase\LIMIT_BIG2
const LIMIT_BIG2
Definition: ApiBase.php:79
ApiBase\PARAM_DFLT
const PARAM_DFLT
Definition: ApiBase.php:46
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
Definition: ApiBase.php:48
ApiBase\PARAM_MAX2
const PARAM_MAX2
Definition: ApiBase.php:54
ApiQueryBase\addWhere
addWhere( $value)
Add a set of WHERE clauses to the internal array.
Definition: ApiQueryBase.php:152
ApiQueryBase\setContinueEnumParameter
setContinueEnumParameter( $paramName, $paramValue)
Set a query-continue value.
Definition: ApiQueryBase.php:404
ApiBase\getRequireMaxOneParameterErrorMessages
getRequireMaxOneParameterErrorMessages( $params)
Generates the possible error requireMaxOneParameter() can die with.
Definition: ApiBase.php:791
$query
return true to allow those checks to and false if checking is done use this to change the tables headers temp or archived zone change it to an object instance and return false override the list derivative used the name of the old file when set the default code will be skipped add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1105
ApiBase\requireMaxOneParameter
requireMaxOneParameter( $params)
Die if more than one of a certain set of parameters is set and not false.
Definition: ApiBase.php:769
$res
$res
Definition: database.txt:21
ApiQueryBase\addPageSubItem
addPageSubItem( $pageId, $item, $elemname=null)
Same as addPageSubItems(), but one element of $data at a time.
Definition: ApiQueryBase.php:383
ApiQueryBase\addWhereIf
addWhereIf( $value, $condition)
Same as addWhere(), but add the WHERE clauses only if a condition is met.
Definition: ApiQueryBase.php:170
User\getGroupsWithPermission
static getGroupsWithPermission( $role)
Get all the groups who have a given permission.
Definition: User.php:4123