Merge "Prefer console.error over console.log for exception logging"
[lhc/web/wiklou.git] / includes / Autopromote.php
index e8ef7fc..9c77855 100644 (file)
@@ -1,14 +1,35 @@
 <?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 {
        /**
         * Get the groups for the given user based on $wgAutopromote.
         *
-        * @param $user The user to get the groups for
+        * @param $user User The user to get the groups for
         * @return array Array of groups to promote to.
         */
        public static function getAutopromoteGroups( User $user ) {
@@ -17,8 +38,9 @@ class Autopromote {
                $promote = array();
 
                foreach ( $wgAutopromote as $group => $cond ) {
-                       if ( self::recCheckCondition( $cond, $user ) )
+                       if ( self::recCheckCondition( $cond, $user ) ) {
                                $promote[] = $group;
+                       }
                }
 
                wfRunHooks( 'GetAutoPromoteGroups', array( $user, &$promote ) );
@@ -26,9 +48,48 @@ class Autopromote {
                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 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, $event ) {
+               global $wgAutopromoteOnce;
+
+               $promote = array();
+
+               if ( isset( $wgAutopromoteOnce[$event] ) && count( $wgAutopromoteOnce[$event] ) ) {
+                       $currentGroups = $user->getGroups();
+                       $formerGroups = $user->getFormerGroups();
+                       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*
@@ -39,7 +100,7 @@ class Autopromote {
         * self::checkCondition for evaluation of the latter type.
         *
         * @param $cond Mixed: a condition, possibly containing other conditions
-        * @param $user The user to check the conditions against
+        * @param $user User The user to check the conditions against
         * @return bool Whether the condition is true
         */
        private static function recCheckCondition( $cond, User $user ) {
@@ -47,7 +108,7 @@ class Autopromote {
 
                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;
@@ -55,7 +116,7 @@ class Autopromote {
                                }
 
                                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;
@@ -63,18 +124,13 @@ class Autopromote {
                                }
 
                                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;
@@ -100,7 +156,7 @@ class Autopromote {
         * ates them.
         *
         * @param $cond Array: A condition, which must not contain other conditions
-        * @param $user The user to check the condition against
+        * @param $user User The user to check the condition against
         * @return bool Whether the condition is true for the user
         */
        private static function checkCondition( $cond, User $user ) {
@@ -111,7 +167,7 @@ class Autopromote {
 
                switch( $cond[0] ) {
                        case APCOND_EMAILCONFIRMED:
-                               if ( User::isValidEmailAddr( $user->getEmail() ) ) {
+                               if ( Sanitizer::validateEmail( $user->getEmail() ) ) {
                                        if ( $wgEmailAuthentication ) {
                                                return (bool)$user->getEmailAuthenticationTimestamp();
                                        } else {
@@ -131,11 +187,13 @@ class Autopromote {
                                $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 ) );