UserModule.php

Go to the documentation of this file.

<?php
class UserModule extends CWebModule
{
    public $user_page_size = 10;

    public $fields_page_size = 10;

    public $hash = 'md5';

    public $sendActivationMail = true;

    public $loginNotActiv = false;

    public $activeAfterRegister = false;

    public $autoLogin = true;

    public $registrationUrl = array("/user/registration");
    public $recoveryUrl = array("/user/recovery/recovery");
    public $loginUrl = array("/user/login");
    public $logoutUrl = array("/user/logout");
    public $profileUrl = array("/user/profile");
    public $returnUrl = array("/user/profile");
    public $returnLogoutUrl = array("/user/login");

    public $rememberMeTime = 2592000; // 30 days

    public $fieldsMessage = '';

    public $relations = array();

    public $profileRelations = array();

    public $captcha = array('registration' => true);

    //public $cacheEnable = false;

    public $tableUsers = '{{users}}';
    public $tableProfiles = '{{profiles}}';
    public $tableProfileFields = '{{profiles_fields}}';

    public $defaultScope = array(
            'with' => array('profile'),
    );

    private static $_user;
    private static $_users = array();
    private static $_userByName = array();
    private static $_admin;
    private static $_admins;

    public $componentBehaviors = array();

    public function init()
    {
        // this method is called when the module is being created
        // you may place code here to customize the module or the application

        // import the module-level models and components
        $this->setImport(array(
            'user.models.*',
            'user.components.*',
        ));
    }

    public function getBehaviorsFor($componentName)
    {
        if (isset($this->componentBehaviors[$componentName])) {
            return $this->componentBehaviors[$componentName];
        } else {
            return array();
        }
    }

    public function beforeControllerAction($controller, $action)
    {
        if (parent::beforeControllerAction($controller, $action)) {
            // this method is called before any module controller action is performed
            // you may place customized code here
            return true;
        } else {
            return false;
        }
    }

    public static function t($str = '', $params = array(), $dic = 'user')
    {
        if (Yii::t("UserModule", $str) == $str) {
            return Yii::t("UserModule.".$dic, $str, $params);
        } else {
            return Yii::t("UserModule", $str, $params);
        }
    }

    public static function encrypting($string = "")
    {
        $hash = Yii::app()->getModule('user')->hash;
        if ($hash == "md5") {
            return md5($string);
        }
        if ($hash == "sha1") {
            return sha1($string);
        } else {
            return hash($hash, $string);
        }
    }

    public static function doCaptcha($place = '')
    {
        if (!extension_loaded('gd')) {
            return false;
        }
        if (in_array($place, Yii::app()->getModule('user')->captcha)) {
            return Yii::app()->getModule('user')->captcha[$place];
        }

        return false;
    }

    public static function isAdmin()
    {
        if (Yii::app()->user->isGuest) {
            return false;
        } else {
            if (!isset(self::$_admin)) {
                if (self::user()->superuser) {
                    self::$_admin = true;
                } else {
                    self::$_admin = false;
                }
            }

            return self::$_admin;
        }
    }

    public static function getAdmins()
    {
        if (!self::$_admins) {
            $admins = User::model()->active()->superuser()->findAll();
            $return_name = array();
            foreach ($admins as $admin) {
                array_push($return_name, $admin->username);
            }
            self::$_admins = ($return_name) ? $return_name : array('');
        }

        return self::$_admins;
    }

    public static function sendMail($email, $subject, $message)
    {
        $adminEmail = Yii::app()->params['adminEmail'];
        $headers = "MIME-Version: 1.0\r\nFrom: $adminEmail\r\nReply-To: $adminEmail\r\nContent-Type: text/html; charset=utf-8";
        $message = wordwrap($message, 70);
        $message = str_replace("\n.", "\n..", $message);

        return mail($email, '=?UTF-8?B?'.base64_encode($subject).'?=', $message, $headers);
    }

    public static function user($id = 0, $clearCache = false)
    {
        if (!$id && !Yii::app()->user->isGuest) {
            $id = Yii::app()->user->id;
        }
        if ($id) {
            if (!isset(self::$_users[$id]) || $clearCache) {
                self::$_users[$id] = User::model()->with(array('profile'))->findbyPk($id);
            }

            return self::$_users[$id];
        } else {
            return false;
        }
    }

    public static function getUserByName($username)
    {
        if (!isset(self::$_userByName[$username])) {
            $_userByName[$username] = User::model()->findByAttributes(array('username' => $username));
        }

        return $_userByName[$username];
    }

    public function users()
    {
        return User;
    }

    public static function isGuest()
    {
        return Yii::app()->user->isGuest;
    }

    public static function isUserTemp()
    {
        $user = self::user();
        if (empty($user)) {
            return false;
        }
        return $user->status == User::STATUS_TEMP;
    }

    public static function isNotGuestAndUserTemp()
    {
        return (!self::isGuest() && !self::isUserTemp());
    }

    public static function getUserId()
    {
        return Yii::app()->user->id;
    }

    public static function createAndLoginUserTemp()
    {
        $sessionId = Yii::app()->getSession()->getSessionId();
        $emailDomain = '@temp.com';
        $password = '';

        $RegistrationForm = new RegistrationForm();
        $User = User::model()->findByAttributes(array('username' => $sessionId));
        if (empty($User)) {
            $RegistrationForm->username = $sessionId;
            $RegistrationForm->email = $sessionId.$emailDomain;
            $RegistrationForm->password = UserModule::encrypting($password);
            $RegistrationForm->status = User::STATUS_TEMP;

            if (!$RegistrationForm->save(false)) {
                return false;
            }

            $profile = new Profile();
            $profile->user_id = $RegistrationForm->id;
            $profile->lastname = '-';
            $profile->firstname = '-';
            $profile->save(false);

            $RegistrationForm->setDefaultTempUserAssignments($RegistrationForm->id);
        } else {
            $RegistrationForm = $User;
        }

        $identity = new UserIdentity($sessionId, $password);
        $identity->authenticate();
        Yii::app()->user->login($identity, 0);

        $sessionId = Yii::app()->getSession()->getSessionId();
        $RegistrationForm->username = $sessionId;
        $RegistrationForm->email = $sessionId.$emailDomain;
        $RegistrationForm->save(false);

        return true;
    }
}