MediaWiki  REL1_31
ApiQueryContributors.php
Go to the documentation of this file.
1 <?php
37  const MAX_PAGES = 100;
38 
39  public function __construct( ApiQuery $query, $moduleName ) {
40  // "pc" is short for "page contributors", "co" was already taken by the
41  // GeoData extension's prop=coordinates.
42  parent::__construct( $query, $moduleName, 'pc' );
43  }
44 
45  public function execute() {
47 
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();
79 
80  // For MIGRATION_NEW, target indexes on the revision_actor_temp table.
81  // Otherwise, revision is fine because it'll have to check all revision rows anyway.
82  $pageField = $wgActorTableSchemaMigrationStage === MIGRATION_NEW ? 'revactor_page' : 'rev_page';
84  ? 'revactor_actor' : $revQuery['fields']['rev_user'];
86  ? 'revactor_actor' : $revQuery['fields']['rev_user_text'];
87 
88  // First, count anons
89  $this->addTables( $revQuery['tables'] );
90  $this->addJoinConds( $revQuery['joins'] );
91  $this->addFields( [
92  'page' => $pageField,
93  'anons' => "COUNT(DISTINCT $countField)",
94  ] );
95  $this->addWhereFld( $pageField, $pages );
96  $this->addWhere( ActorMigration::newMigration()->isAnon( $revQuery['fields']['rev_user'] ) );
97  $this->addWhere( $db->bitAnd( 'rev_deleted', Revision::DELETED_USER ) . ' = 0' );
98  $this->addOption( 'GROUP BY', $pageField );
99  $res = $this->select( __METHOD__ );
100  foreach ( $res as $row ) {
101  $fit = $result->addValue( [ 'query', 'pages', $row->page ],
102  'anoncontributors', (int)$row->anons
103  );
104  if ( !$fit ) {
105  // This not fitting isn't reasonable, so it probably means that
106  // some other module used up all the space. Just set a dummy
107  // continue and hope it works next time.
108  $this->setContinueEnumParameter( 'continue',
109  $params['continue'] !== null ? $params['continue'] : '0|0'
110  );
111 
112  return;
113  }
114  }
115 
116  // Next, add logged-in users
117  $this->resetQueryParams();
118  $this->addTables( $revQuery['tables'] );
119  $this->addJoinConds( $revQuery['joins'] );
120  $this->addFields( [
121  'page' => $pageField,
122  'id' => $idField,
123  // Non-MySQL databases don't like partial group-by
124  'userid' => 'MAX(' . $revQuery['fields']['rev_user'] . ')',
125  'username' => 'MAX(' . $revQuery['fields']['rev_user_text'] . ')',
126  ] );
127  $this->addWhereFld( $pageField, $pages );
128  $this->addWhere( ActorMigration::newMigration()->isNotAnon( $revQuery['fields']['rev_user'] ) );
129  $this->addWhere( $db->bitAnd( 'rev_deleted', Revision::DELETED_USER ) . ' = 0' );
130  $this->addOption( 'GROUP BY', [ $pageField, $idField ] );
131  $this->addOption( 'LIMIT', $params['limit'] + 1 );
132 
133  // Force a sort order to ensure that properties are grouped by page
134  // But only if rev_page is not constant in the WHERE clause.
135  if ( count( $pages ) > 1 ) {
136  $this->addOption( 'ORDER BY', [ 'page', 'id' ] );
137  } else {
138  $this->addOption( 'ORDER BY', 'id' );
139  }
140 
141  $limitGroups = [];
142  if ( $params['group'] ) {
143  $excludeGroups = false;
144  $limitGroups = $params['group'];
145  } elseif ( $params['excludegroup'] ) {
146  $excludeGroups = true;
147  $limitGroups = $params['excludegroup'];
148  } elseif ( $params['rights'] ) {
149  $excludeGroups = false;
150  foreach ( $params['rights'] as $r ) {
151  $limitGroups = array_merge( $limitGroups, User::getGroupsWithPermission( $r ) );
152  }
153 
154  // If no group has the rights requested, no need to query
155  if ( !$limitGroups ) {
156  if ( $continuePages !== null ) {
157  // But we still need to continue for the next page's worth
158  // of anoncontributors
159  $this->setContinueEnumParameter( 'continue', $continuePages );
160  }
161 
162  return;
163  }
164  } elseif ( $params['excluderights'] ) {
165  $excludeGroups = true;
166  foreach ( $params['excluderights'] as $r ) {
167  $limitGroups = array_merge( $limitGroups, User::getGroupsWithPermission( $r ) );
168  }
169  }
170 
171  if ( $limitGroups ) {
172  $limitGroups = array_unique( $limitGroups );
173  $this->addTables( 'user_groups' );
174  $this->addJoinConds( [ 'user_groups' => [
175  $excludeGroups ? 'LEFT OUTER JOIN' : 'INNER JOIN',
176  [
177  'ug_user=' . $revQuery['fields']['rev_user'],
178  'ug_group' => $limitGroups,
179  'ug_expiry IS NULL OR ug_expiry >= ' . $db->addQuotes( $db->timestamp() )
180  ]
181  ] ] );
182  $this->addWhereIf( 'ug_user IS NULL', $excludeGroups );
183  }
184 
185  if ( $params['continue'] !== null ) {
186  $cont = explode( '|', $params['continue'] );
187  $this->dieContinueUsageIf( count( $cont ) != 2 );
188  $cont_page = (int)$cont[0];
189  $cont_id = (int)$cont[1];
190  $this->addWhere(
191  "$pageField > $cont_page OR " .
192  "($pageField = $cont_page AND " .
193  "$idField >= $cont_id)"
194  );
195  }
196 
197  $res = $this->select( __METHOD__ );
198  $count = 0;
199  foreach ( $res as $row ) {
200  if ( ++$count > $params['limit'] ) {
201  // We've reached the one extra which shows that
202  // there are additional pages to be had. Stop here...
203  $this->setContinueEnumParameter( 'continue', $row->page . '|' . $row->id );
204  return;
205  }
206 
207  $fit = $this->addPageSubItem( $row->page,
208  [ 'userid' => (int)$row->userid, 'name' => $row->username ],
209  'user'
210  );
211  if ( !$fit ) {
212  $this->setContinueEnumParameter( 'continue', $row->page . '|' . $row->id );
213  return;
214  }
215  }
216 
217  if ( $continuePages !== null ) {
218  $this->setContinueEnumParameter( 'continue', $continuePages );
219  }
220  }
221 
222  public function getCacheMode( $params ) {
223  return 'public';
224  }
225 
226  public function getAllowedParams() {
227  $userGroups = User::getAllGroups();
228  $userRights = User::getAllRights();
229 
230  return [
231  'group' => [
232  ApiBase::PARAM_TYPE => $userGroups,
233  ApiBase::PARAM_ISMULTI => true,
234  ],
235  'excludegroup' => [
236  ApiBase::PARAM_TYPE => $userGroups,
237  ApiBase::PARAM_ISMULTI => true,
238  ],
239  'rights' => [
240  ApiBase::PARAM_TYPE => $userRights,
241  ApiBase::PARAM_ISMULTI => true,
242  ],
243  'excluderights' => [
244  ApiBase::PARAM_TYPE => $userRights,
245  ApiBase::PARAM_ISMULTI => true,
246  ],
247  'limit' => [
248  ApiBase::PARAM_DFLT => 10,
249  ApiBase::PARAM_TYPE => 'limit',
250  ApiBase::PARAM_MIN => 1,
253  ],
254  'continue' => [
255  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
256  ],
257  ];
258  }
259 
260  protected function getExamplesMessages() {
261  return [
262  'action=query&prop=contributors&titles=Main_Page'
263  => 'apihelp-query+contributors-example-simple',
264  ];
265  }
266 
267  public function getHelpUrls() {
268  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Contributors';
269  }
270 }
Revision\DELETED_USER
const DELETED_USER
Definition: Revision.php:49
ApiQueryContributors
A query module to show contributors to a page.
Definition: ApiQueryContributors.php:32
ApiQueryBase\addFields
addFields( $value)
Add a set of fields to select to the internal array.
Definition: ApiQueryBase.php:192
ApiQuery
This is the main query class.
Definition: ApiQuery.php:36
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:37
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
ApiQueryBase\resetQueryParams
resetQueryParams()
Blank the internal arrays with query parameters.
Definition: ApiQueryBase.php:144
ApiBase\PARAM_HELP_MSG
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition: ApiBase.php:124
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:87
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:641
MIGRATION_NEW
const MIGRATION_NEW
Definition: Defines.php:305
$params
$params
Definition: styleTest.css.php:40
$res
$res
Definition: database.txt:21
ApiQueryContributors\__construct
__construct(ApiQuery $query, $moduleName)
Definition: ApiQueryContributors.php:39
ApiQueryBase\addOption
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
Definition: ApiQueryBase.php:325
$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. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. '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 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name '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:1993
$revQuery
$revQuery
Definition: testCompression.php:51
ActorMigration\newMigration
static newMigration()
Static constructor.
Definition: ActorMigration.php:89
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:37
ApiQueryContributors\getExamplesMessages
getExamplesMessages()
Returns usage examples for this module.
Definition: ApiQueryContributors.php:260
ApiBase\PARAM_MIN
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:99
Revision\getQueryInfo
static getQueryInfo( $options=[])
Return the tables, fields, and join conditions to be selected to create a new revision object.
Definition: Revision.php:492
ApiQueryBase
This is a base class for all Query modules.
Definition: ApiQueryBase.php:33
ApiBase\LIMIT_BIG1
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:234
ApiQueryBase\getDB
getDB()
Get the Query database connection (read-only)
Definition: ApiQueryBase.php:105
ApiBase\PARAM_MAX
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:90
ApiQueryContributors\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiQueryContributors.php:226
ApiQueryBase\addTables
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
Definition: ApiQueryBase.php:158
ApiQueryBase\select
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
Definition: ApiQueryBase.php:350
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:749
ApiQueryContributors\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiQueryContributors.php:45
ApiBase\dieContinueUsageIf
dieContinueUsageIf( $condition)
Die with the 'badcontinue' error.
Definition: ApiBase.php:2066
ApiQueryBase\addJoinConds
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
Definition: ApiQueryBase.php:181
ApiQueryBase\addWhereFld
addWhereFld( $field, $value)
Equivalent to addWhere(array($field => $value))
Definition: ApiQueryBase.php:260
User\getAllGroups
static getAllGroups()
Return the set of defined explicit groups.
Definition: User.php:5085
ApiBase\requireMaxOneParameter
requireMaxOneParameter( $params, $required)
Die if more than one of a certain set of parameters is set and not false.
Definition: ApiBase.php:823
User\getAllRights
static getAllRights()
Get a list of all available permissions.
Definition: User.php:5097
ApiQueryBase\getPageSet
getPageSet()
Get the PageSet object to work on.
Definition: ApiQueryBase.php:130
ApiQueryContributors\getHelpUrls
getHelpUrls()
Return links to more detailed help pages about the module.
Definition: ApiQueryContributors.php:267
ApiQueryContributors\getCacheMode
getCacheMode( $params)
Get the cache mode for the data generated by this module.
Definition: ApiQueryContributors.php:222
ApiBase\LIMIT_BIG2
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:236
ApiBase\PARAM_DFLT
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:48
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:22
ApiBase\PARAM_ISMULTI
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:51
ApiBase\PARAM_MAX2
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right,...
Definition: ApiBase.php:96
ApiQueryBase\addWhere
addWhere( $value)
Add a set of WHERE clauses to the internal array.
Definition: ApiQueryBase.php:227
ApiQueryBase\setContinueEnumParameter
setContinueEnumParameter( $paramName, $paramValue)
Set a query-continue value.
Definition: ApiQueryBase.php:531
$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:1620
ApiQueryBase\addPageSubItem
addPageSubItem( $pageId, $item, $elemname=null)
Same as addPageSubItems(), but one element of $data at a time.
Definition: ApiQueryBase.php:510
ApiQueryBase\addWhereIf
addWhereIf( $value, $condition)
Same as addWhere(), but add the WHERE clauses only if a condition is met.
Definition: ApiQueryBase.php:245
User\getGroupsWithPermission
static getGroupsWithPermission( $role)
Get all the groups who have a given permission.
Definition: User.php:4968
$wgActorTableSchemaMigrationStage
int $wgActorTableSchemaMigrationStage
Actor table schema migration stage.
Definition: DefaultSettings.php:8878