Autopromote.php

Go to the documentation of this file.

<?php
class Autopromote {
        public static function getAutopromoteGroups( User $user ) {
                global $wgAutopromote;

                $promote = array();

                foreach ( $wgAutopromote as $group => $cond ) {
                        if ( self::recCheckCondition( $cond, $user ) ) {
                                $promote[] = $group;
                        }
                }

                wfRunHooks( 'GetAutoPromoteGroups', array( $user, &$promote ) );

                return $promote;
        }

        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;
        }

        private static function recCheckCondition( $cond, User $user ) {
                $validOps = array( '&', '|', '^', '!' );

                if ( is_array( $cond ) && count( $cond ) >= 2 && in_array( $cond[0], $validOps ) ) {
                        # Recursive condition
                        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] == '|' ) { // 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] == '^' ) { // 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 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;
                                        }
                                }

                                return true;
                        }
                }
                # If we got here, the array presumably does not contain other condi-
                # tions; it's not recursive.  Pass it off to self::checkCondition.
                if ( !is_array( $cond ) ) {
                        $cond = array( $cond );
                }

                return self::checkCondition( $cond, $user );
        }

        private static function checkCondition( $cond, User $user ) {
                global $wgEmailAuthentication;
                if ( count( $cond ) < 1 ) {
                        return false;
                }

                switch( $cond[0] ) {
                        case APCOND_EMAILCONFIRMED:
                                if ( Sanitizer::validateEmail( $user->getEmail() ) ) {
                                        if ( $wgEmailAuthentication ) {
                                                return (bool)$user->getEmailAuthenticationTimestamp();
                                        } else {
                                                return true;
                                        }
                                }
                                return false;
                        case APCOND_EDITCOUNT:
                                return $user->getEditCount() >= $cond[1];
                        case APCOND_AGE:
                                $age = time() - wfTimestampOrNull( TS_UNIX, $user->getRegistration() );
                                return $age >= $cond[1];
                        case APCOND_AGE_FROM_EDIT:
                                $age = time() - wfTimestampOrNull( TS_UNIX, $user->getFirstEditTimestamp() );
                                return $age >= $cond[1];
                        case APCOND_INGROUPS:
                                $groups = array_slice( $cond, 1 );
                                return count( array_intersect( $groups, $user->getGroups() ) ) == count( $groups );
                        case APCOND_ISIP:
                                return $cond[1] == $user->getRequest()->getIP();
                        case APCOND_IPINRANGE:
                                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 ) );
                                if ( $result === null ) {
                                        throw new MWException( "Unrecognized condition {$cond[0]} for autopromotion!" );
                                }

                                return (bool)$result;
                }
        }
}