<?php
+/**
+ * Automatic user rights promotion based on conditions specified
+ * in $wgAutopromote.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
+
/**
* This class checks if user can get extra rights
* because of conditions specified in $wgAutopromote
*/
-
class Autopromote {
- /**
- * A function which may be assigned to a hook in order to check
- * autopromotion of the current user (\ref $wgUser) to the specified
- * group.
- *
- * Contrary to autopromotion by \ref $wgAutopromote, the group will be
- * possible to remove manually via Special:UserRights. In such case it
- * will not be re-added autmoatically. The user will also not lose the
- * group if they no longer meet the criteria.
- *
- * Example configuration:
- * \code $wgHooks['ArticleSaveComplete'][] = array (
- * 'Autopromote::autopromoteOnceHook',
- * array( 'somegroup' => array(APCOND_EDITCOUNT, 200) )
- * ); \endcode
- *
- * The second array should be of the same format as \ref $wgAutopromote.
- *
- * This funciton simply runs User::autopromoteOnce() on $wgUser. You may
- * run this method from your custom function if you wish.
- *
- * @param $criteria array Groups and conditions which must be met in order to
- * aquire these groups. Array of the same format as \ref $wgAutopromote.
- *
- * @return Always true.
- *
- * @see User::autopromoteOnce()
- * @see $wgAutopromote
- */
- public static function autopromoteOnceHook($criteria) {
- global $wgUser;
- $wgUser->autopromoteOnce($criteria);
- return true;
- }
-
/**
* Get the groups for the given user based on $wgAutopromote.
*
return $promote;
}
-
+
/**
* Get the groups for the given user based on the given criteria.
- *
+ *
* Does not return groups the user already belongs to or has once belonged.
- *
- * @param $user The user to get the groups for
- * @param $criteria array Groups and conditions the user must meet in order
- * to be promoted to these groups. Array of the same format as
- * \ref $wgAutopromote.
- *
+ *
+ * @param $user User The user to get the groups for
+ * @param $event String key in $wgAutopromoteOnce (each one has groups/criteria)
+ *
* @return array Groups the user should be promoted to.
+ *
+ * @see $wgAutopromoteOnce
*/
- public static function getAutopromoteOnceGroups( User $user, $criteria ) {
+ public static function getAutopromoteOnceGroups( User $user, $event ) {
+ global $wgAutopromoteOnce;
+
$promote = array();
-
- //get the current groups
- $currentGroups = $user->getGroups();
-
- foreach( $criteria as $group => $cond ) {
- //do not check if the user's already a member
- if ( in_array($group, $currentGroups))
- continue;
-
- //do not autopromote if the user has belonged to the group
+
+ if ( isset( $wgAutopromoteOnce[$event] ) && count( $wgAutopromoteOnce[$event] ) ) {
+ $currentGroups = $user->getGroups();
$formerGroups = $user->getFormerGroups();
- if ( in_array($group, $formerGroups) )
- continue;
-
- //finally - check the conditions
- if ( self::recCheckCondition($cond, $user) )
- $promote[] = $group;
+ foreach ( $wgAutopromoteOnce[$event] as $group => $cond ) {
+ // Do not check if the user's already a member
+ if ( in_array( $group, $currentGroups ) ) {
+ continue;
+ }
+ // Do not autopromote if the user has belonged to the group
+ if ( in_array( $group, $formerGroups ) ) {
+ continue;
+ }
+ // Finally - check the conditions
+ if ( self::recCheckCondition( $cond, $user ) ) {
+ $promote[] = $group;
+ }
+ }
}
+
return $promote;
}
/**
* Recursively check a condition. Conditions are in the form
- * array( '&' or '|' or '^', cond1, cond2, ... )
+ * array( '&' or '|' or '^' or '!', cond1, cond2, ... )
* where cond1, cond2, ... are themselves conditions; *OR*
* APCOND_EMAILCONFIRMED, *OR*
* array( APCOND_EMAILCONFIRMED ), *OR*
if ( is_array( $cond ) && count( $cond ) >= 2 && in_array( $cond[0], $validOps ) ) {
# Recursive condition
- if ( $cond[0] == '&' ) {
+ if ( $cond[0] == '&' ) { // AND (all conds pass)
foreach ( array_slice( $cond, 1 ) as $subcond ) {
if ( !self::recCheckCondition( $subcond, $user ) ) {
return false;
}
return true;
- } elseif ( $cond[0] == '|' ) {
+ } elseif ( $cond[0] == '|' ) { // OR (at least one cond passes)
foreach ( array_slice( $cond, 1 ) as $subcond ) {
if ( self::recCheckCondition( $subcond, $user ) ) {
return true;
}
return false;
- } elseif ( $cond[0] == '^' ) {
- $res = null;
- foreach ( array_slice( $cond, 1 ) as $subcond ) {
- if ( is_null( $res ) ) {
- $res = self::recCheckCondition( $subcond, $user );
- } else {
- $res = ( $res xor self::recCheckCondition( $subcond, $user ) );
- }
+ } elseif ( $cond[0] == '^' ) { // XOR (exactly one cond passes)
+ if ( count( $cond ) > 3 ) {
+ wfWarn( 'recCheckCondition() given XOR ("^") condition on three or more conditions. Check your $wgAutopromote and $wgAutopromoteOnce settings.' );
}
-
- return $res;
- } elseif ( $cond[0] == '!' ) {
+ return self::recCheckCondition( $cond[1], $user )
+ xor self::recCheckCondition( $cond[2], $user );
+ } elseif ( $cond[0] == '!' ) { // NOT (no conds pass)
foreach ( array_slice( $cond, 1 ) as $subcond ) {
if ( self::recCheckCondition( $subcond, $user ) ) {
return false;
*
* @param $cond Array: A condition, which must not contain other conditions
* @param $user User The user to check the condition against
+ * @throws MWException
* @return bool Whether the condition is true for the user
*/
private static function checkCondition( $cond, User $user ) {
switch( $cond[0] ) {
case APCOND_EMAILCONFIRMED:
- if ( User::isValidEmailAddr( $user->getEmail() ) ) {
+ if ( Sanitizer::validateEmail( $user->getEmail() ) ) {
if ( $wgEmailAuthentication ) {
return (bool)$user->getEmailAuthenticationTimestamp();
} else {
$groups = array_slice( $cond, 1 );
return count( array_intersect( $groups, $user->getGroups() ) ) == count( $groups );
case APCOND_ISIP:
- return $cond[1] == wfGetIP();
+ return $cond[1] == $user->getRequest()->getIP();
case APCOND_IPINRANGE:
- return IP::isInRange( wfGetIP(), $cond[1] );
+ return IP::isInRange( $user->getRequest()->getIP(), $cond[1] );
case APCOND_BLOCKED:
return $user->isBlocked();
+ case APCOND_ISBOT:
+ return in_array( 'bot', User::getGroupPermissions( $user->getGroups() ) );
default:
$result = null;
wfRunHooks( 'AutopromoteCondition', array( $cond[0], array_slice( $cond, 1 ), $user, &$result ) );