includes/Autopromote.php

   1 <?php
   2 /**
   3  * This class checks if user can get extra rights
   4  * because of conditions specified in $wgAutopromote
   5  */
   6
   7 class Autopromote {
   8         /**
   9          * Get the groups for the given user based on $wgAutopromote.
  10          *
  11          * @param $user User The user to get the groups for
  12          * @return array Array of groups to promote to.
  13          */
  14         public static function getAutopromoteGroups( User $user ) {
  15                 global $wgAutopromote;
  16
  17                 $promote = array();
  18
  19                 foreach ( $wgAutopromote as $group => $cond ) {
  20                         if ( self::recCheckCondition( $cond, $user ) ) {
  21                                 $promote[] = $group;
  22                         }
  23                 }
  24
  25                 wfRunHooks( 'GetAutoPromoteGroups', array( $user, &$promote ) );
  26
  27                 return $promote;
  28         }
  29
  30         /**
  31          * Get the groups for the given user based on the given criteria.
  32          *
  33          * Does not return groups the user already belongs to or has once belonged.
  34          *
  35          * @param $user User The user to get the groups for
  36          * @param $event String key in $wgAutopromoteOnce (each one has groups/criteria)
  37          *
  38          * @return array Groups the user should be promoted to.
  39          *
  40          * @see $wgAutopromoteOnce
  41          */
  42         public static function getAutopromoteOnceGroups( User $user, $event ) {
  43                 global $wgAutopromoteOnce;
  44
  45                 $promote = array();
  46
  47                 if ( isset( $wgAutopromoteOnce[$event] ) && count( $wgAutopromoteOnce[$event] ) ) {
  48                         $currentGroups = $user->getGroups();
  49                         $formerGroups = $user->getFormerGroups();
  50                         foreach ( $wgAutopromoteOnce[$event] as $group => $cond ) {
  51                                 // Do not check if the user's already a member
  52                                 if ( in_array( $group, $currentGroups ) ) {
  53                                         continue;
  54                                 }
  55                                 // Do not autopromote if the user has belonged to the group
  56                                 if ( in_array( $group, $formerGroups ) ) {
  57                                         continue;
  58                                 }
  59                                 // Finally - check the conditions
  60                                 if ( self::recCheckCondition( $cond, $user ) ) {
  61                                         $promote[] = $group;
  62                                 }
  63                         }
  64                 }
  65
  66                 return $promote;
  67         }
  68
  69         /**
  70          * Recursively check a condition.  Conditions are in the form
  71          *   array( '&' or '|' or '^' or '!', cond1, cond2, ... )
  72          * where cond1, cond2, ... are themselves conditions; *OR*
  73          *   APCOND_EMAILCONFIRMED, *OR*
  74          *   array( APCOND_EMAILCONFIRMED ), *OR*
  75          *   array( APCOND_EDITCOUNT, number of edits ), *OR*
  76          *   array( APCOND_AGE, seconds since registration ), *OR*
  77          *   similar constructs defined by extensions.
  78          * This function evaluates the former type recursively, and passes off to
  79          * self::checkCondition for evaluation of the latter type.
  80          *
  81          * @param $cond Mixed: a condition, possibly containing other conditions
  82          * @param $user User The user to check the conditions against
  83          * @return bool Whether the condition is true
  84          */
  85         private static function recCheckCondition( $cond, User $user ) {
  86                 $validOps = array( '&', '|', '^', '!' );
  87
  88                 if ( is_array( $cond ) && count( $cond ) >= 2 && in_array( $cond[0], $validOps ) ) {
  89                         # Recursive condition
  90                         if ( $cond[0] == '&' ) { // AND (all conds pass)
  91                                 foreach ( array_slice( $cond, 1 ) as $subcond ) {
  92                                         if ( !self::recCheckCondition( $subcond, $user ) ) {
  93                                                 return false;
  94                                         }
  95                                 }
  96
  97                                 return true;
  98                         } elseif ( $cond[0] == '|' ) { // OR (at least one cond passes)
  99                                 foreach ( array_slice( $cond, 1 ) as $subcond ) {
 100                                         if ( self::recCheckCondition( $subcond, $user ) ) {
 101                                                 return true;
 102                                         }
 103                                 }
 104
 105                                 return false;
 106                         } elseif ( $cond[0] == '^' ) { // XOR (exactly one cond passes)
 107                                 if ( count( $cond ) > 3 ) {
 108                                         wfWarn( 'recCheckCondition() given XOR ("^") condition on three or more conditions. Check your $wgAutopromote and $wgAutopromoteOnce settings.' );
 109                                 }
 110                                 return self::recCheckCondition( $cond[1], $user )
 111                                         xor self::recCheckCondition( $cond[2], $user );
 112                         } elseif ( $cond[0] == '!' ) { // NOT (no conds pass)
 113                                 foreach ( array_slice( $cond, 1 ) as $subcond ) {
 114                                         if ( self::recCheckCondition( $subcond, $user ) ) {
 115                                                 return false;
 116                                         }
 117                                 }
 118
 119                                 return true;
 120                         }
 121                 }
 122                 # If we got here, the array presumably does not contain other condi-
 123                 # tions; it's not recursive.  Pass it off to self::checkCondition.
 124                 if ( !is_array( $cond ) ) {
 125                         $cond = array( $cond );
 126                 }
 127
 128                 return self::checkCondition( $cond, $user );
 129         }
 130
 131         /**
 132          * As recCheckCondition, but *not* recursive.  The only valid conditions
 133          * are those whose first element is APCOND_EMAILCONFIRMED/APCOND_EDITCOUNT/
 134          * APCOND_AGE.  Other types will throw an exception if no extension evalu-
 135          * ates them.
 136          *
 137          * @param $cond Array: A condition, which must not contain other conditions
 138          * @param $user User The user to check the condition against
 139          * @return bool Whether the condition is true for the user
 140          */
 141         private static function checkCondition( $cond, User $user ) {
 142                 global $wgEmailAuthentication;
 143                 if ( count( $cond ) < 1 ) {
 144                         return false;
 145                 }
 146
 147                 switch( $cond[0] ) {
 148                         case APCOND_EMAILCONFIRMED:
 149                                 if ( Sanitizer::validateEmail( $user->getEmail() ) ) {
 150                                         if ( $wgEmailAuthentication ) {
 151                                                 return (bool)$user->getEmailAuthenticationTimestamp();
 152                                         } else {
 153                                                 return true;
 154                                         }
 155                                 }
 156                                 return false;
 157                         case APCOND_EDITCOUNT:
 158                                 return $user->getEditCount() >= $cond[1];
 159                         case APCOND_AGE:
 160                                 $age = time() - wfTimestampOrNull( TS_UNIX, $user->getRegistration() );
 161                                 return $age >= $cond[1];
 162                         case APCOND_AGE_FROM_EDIT:
 163                                 $age = time() - wfTimestampOrNull( TS_UNIX, $user->getFirstEditTimestamp() );
 164                                 return $age >= $cond[1];
 165                         case APCOND_INGROUPS:
 166                                 $groups = array_slice( $cond, 1 );
 167                                 return count( array_intersect( $groups, $user->getGroups() ) ) == count( $groups );
 168                         case APCOND_ISIP:
 169                                 return $cond[1] == $user->getRequest()->getIP();
 170                         case APCOND_IPINRANGE:
 171                                 return IP::isInRange( $user->getRequest()->getIP(), $cond[1] );
 172                         case APCOND_BLOCKED:
 173                                 return $user->isBlocked();
 174                         case APCOND_ISBOT:
 175                                 return in_array( 'bot', User::getGroupPermissions( $user->getGroups() ) );
 176                         default:
 177                                 $result = null;
 178                                 wfRunHooks( 'AutopromoteCondition', array( $cond[0], array_slice( $cond, 1 ), $user, &$result ) );
 179                                 if ( $result === null ) {
 180                                         throw new MWException( "Unrecognized condition {$cond[0]} for autopromotion!" );
 181                                 }
 182
 183                                 return (bool)$result;
 184                 }
 185         }
 186 }