MediaWiki  master
Autopromote.php
Go to the documentation of this file.
1 <?php
28 class Autopromote {
35  public static function getAutopromoteGroups( User $user ) {
36  global $wgAutopromote;
37 
38  $promote = [];
39 
40  foreach ( $wgAutopromote as $group => $cond ) {
41  if ( self::recCheckCondition( $cond, $user ) ) {
42  $promote[] = $group;
43  }
44  }
45 
46  Hooks::run( 'GetAutoPromoteGroups', [ $user, &$promote ] );
47 
48  return $promote;
49  }
50 
63  public static function getAutopromoteOnceGroups( User $user, $event ) {
64  global $wgAutopromoteOnce;
65 
66  $promote = [];
67 
68  if ( isset( $wgAutopromoteOnce[$event] ) && count( $wgAutopromoteOnce[$event] ) ) {
69  $currentGroups = $user->getGroups();
70  $formerGroups = $user->getFormerGroups();
71  foreach ( $wgAutopromoteOnce[$event] as $group => $cond ) {
72  // Do not check if the user's already a member
73  if ( in_array( $group, $currentGroups ) ) {
74  continue;
75  }
76  // Do not autopromote if the user has belonged to the group
77  if ( in_array( $group, $formerGroups ) ) {
78  continue;
79  }
80  // Finally - check the conditions
81  if ( self::recCheckCondition( $cond, $user ) ) {
82  $promote[] = $group;
83  }
84  }
85  }
86 
87  return $promote;
88  }
89 
106  private static function recCheckCondition( $cond, User $user ) {
107  $validOps = [ '&', '|', '^', '!' ];
108 
109  if ( is_array( $cond ) && count( $cond ) >= 2 && in_array( $cond[0], $validOps ) ) {
110  # Recursive condition
111  if ( $cond[0] == '&' ) { // AND (all conds pass)
112  foreach ( array_slice( $cond, 1 ) as $subcond ) {
113  if ( !self::recCheckCondition( $subcond, $user ) ) {
114  return false;
115  }
116  }
117 
118  return true;
119  } elseif ( $cond[0] == '|' ) { // OR (at least one cond passes)
120  foreach ( array_slice( $cond, 1 ) as $subcond ) {
121  if ( self::recCheckCondition( $subcond, $user ) ) {
122  return true;
123  }
124  }
125 
126  return false;
127  } elseif ( $cond[0] == '^' ) { // XOR (exactly one cond passes)
128  if ( count( $cond ) > 3 ) {
129  wfWarn( 'recCheckCondition() given XOR ("^") condition on three or more conditions.' .
130  ' Check your $wgAutopromote and $wgAutopromoteOnce settings.' );
131  }
132  return self::recCheckCondition( $cond[1], $user )
133  xor self::recCheckCondition( $cond[2], $user );
134  } elseif ( $cond[0] == '!' ) { // NOT (no conds pass)
135  foreach ( array_slice( $cond, 1 ) as $subcond ) {
136  if ( self::recCheckCondition( $subcond, $user ) ) {
137  return false;
138  }
139  }
140 
141  return true;
142  }
143  }
144  // If we got here, the array presumably does not contain other conditions;
145  // it's not recursive. Pass it off to self::checkCondition.
146  if ( !is_array( $cond ) ) {
147  $cond = [ $cond ];
148  }
149 
150  return self::checkCondition( $cond, $user );
151  }
152 
163  private static function checkCondition( $cond, User $user ) {
164  global $wgEmailAuthentication;
165  if ( count( $cond ) < 1 ) {
166  return false;
167  }
168 
169  switch ( $cond[0] ) {
171  if ( Sanitizer::validateEmail( $user->getEmail() ) ) {
172  if ( $wgEmailAuthentication ) {
173  return (bool)$user->getEmailAuthenticationTimestamp();
174  } else {
175  return true;
176  }
177  }
178  return false;
179  case APCOND_EDITCOUNT:
180  $reqEditCount = $cond[1];
181 
182  // T157718: Avoid edit count lookup if specified edit count is 0 or invalid
183  if ( $reqEditCount <= 0 ) {
184  return true;
185  }
186  return $user->getEditCount() >= $reqEditCount;
187  case APCOND_AGE:
188  $age = time() - wfTimestampOrNull( TS_UNIX, $user->getRegistration() );
189  return $age >= $cond[1];
191  $age = time() - wfTimestampOrNull( TS_UNIX, $user->getFirstEditTimestamp() );
192  return $age >= $cond[1];
193  case APCOND_INGROUPS:
194  $groups = array_slice( $cond, 1 );
195  return count( array_intersect( $groups, $user->getGroups() ) ) == count( $groups );
196  case APCOND_ISIP:
197  return $cond[1] == $user->getRequest()->getIP();
198  case APCOND_IPINRANGE:
199  return IP::isInRange( $user->getRequest()->getIP(), $cond[1] );
200  case APCOND_BLOCKED:
201  return $user->isBlocked();
202  case APCOND_ISBOT:
203  return in_array( 'bot', User::getGroupPermissions( $user->getGroups() ) );
204  default:
205  $result = null;
206  Hooks::run( 'AutopromoteCondition', [ $cond[0],
207  array_slice( $cond, 1 ), $user, &$result ] );
208  if ( $result === null ) {
209  throw new MWException( "Unrecognized condition {$cond[0]} for autopromotion!" );
210  }
211 
212  return (bool)$result;
213  }
214  }
215 }
getEmail()
Get the user&#39;s e-mail address.
Definition: User.php:3057
wfWarn( $msg, $callerOffset=1, $level=E_USER_NOTICE)
Send a warning either to the debug log or in a PHP error depending on $wgDevelopmentWarnings.
const APCOND_AGE
Definition: Defines.php:206
static getGroupPermissions( $groups)
Get the permissions associated with a given list of groups.
Definition: User.php:5017
getFirstEditTimestamp()
Get the timestamp of the first edit.
Definition: User.php:4966
const APCOND_ISBOT
Definition: Defines.php:213
wfTimestampOrNull( $outputtype=TS_UNIX, $ts=null)
Return a formatted timestamp, or null if input is null.
isBlocked( $fromReplica=true)
Check if user is blocked.
Definition: User.php:2280
const APCOND_BLOCKED
Definition: Defines.php:212
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 '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. '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 '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 since 1.28! 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:1980
const APCOND_ISIP
Definition: Defines.php:209
static validateEmail( $addr)
Does a string look like an e-mail address?
Definition: Sanitizer.php:2116
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:48
getRegistration()
Get the timestamp of account creation.
Definition: User.php:4952
static checkCondition( $cond, User $user)
As recCheckCondition, but not recursive.
This class checks if user can get extra rights because of conditions specified in $wgAutopromote...
Definition: Autopromote.php:28
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
static getAutopromoteGroups(User $user)
Get the groups for the given user based on $wgAutopromote.
Definition: Autopromote.php:35
const APCOND_AGE_FROM_EDIT
Definition: Defines.php:211
static isInRange( $addr, $range)
Determine if a given IPv4/IPv6 address is in a given CIDR network.
Definition: IP.php:650
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
$wgAutopromote
Array containing the conditions of automatic promotion of a user to specific groups.
static recCheckCondition( $cond, User $user)
Recursively check a condition.
$wgEmailAuthentication
Require email authentication before sending mail to an email address.
getRequest()
Get the WebRequest object to use with this object.
Definition: User.php:3908
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
getGroups()
Get the list of explicit group memberships this user has.
Definition: User.php:3595
getEmailAuthenticationTimestamp()
Get the timestamp of the user&#39;s e-mail authentication.
Definition: User.php:3067
const APCOND_EMAILCONFIRMED
Definition: Defines.php:207
const APCOND_INGROUPS
Definition: Defines.php:208
getEditCount()
Get the user&#39;s edit count.
Definition: User.php:3697
const APCOND_IPINRANGE
Definition: Defines.php:210
const APCOND_EDITCOUNT
Definition: Defines.php:205
static getAutopromoteOnceGroups(User $user, $event)
Get the groups for the given user based on the given criteria.
Definition: Autopromote.php:63
$wgAutopromoteOnce
Automatically add a usergroup to any user who matches certain conditions.
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1473
getFormerGroups()
Returns the groups the user has belonged to.
Definition: User.php:3673
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200