grzanieplus.pl/plugins/sfGuardPlugin/lib/user/sfGuardSecurityUser.class.php

<?php

/*
 * This file is part of the symfony package.
 * (c) 2004-2006 Fabien Potencier <fabien.potencier@symfony-project.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

/**
 *
 * @package    symfony
 * @subpackage plugin
 * @author     Fabien Potencier <fabien.potencier@symfony-project.com>
 * @version    SVN: $Id: sfGuardSecurityUser.class.php 2310 2008-11-25 14:11:23Z michal $
 */
class sfGuardSecurityUser extends sfBasicSecurityUser
{

    private $user = null;


    public function isAuthenticated()
    {
        if ($this->authenticated && null !== $this->getGuardUser() && $this->getLastPasswordChange() < $this->getGuardUser()->getLastPasswordChange()) 
        {
            $this->signOut();
            return false;
        }

        return $this->authenticated;
    }

    public function hasCredential($credential, $useAnd = true)
    {
        if ($this->getAttribute('super_admin', false, 'sfGuardSecurityUser'))
        {
            return true;
        }

        return parent::hasCredential($credential, $useAnd);
    }

    public function isSuperAdmin()
    {
        return $this->getAttribute('super_admin', false, 'sfGuardSecurityUser');
    }

    public function isAnonymous()
    {
        return!$this->isAuthenticated();
    }


    public function getLastPasswordChange()
    {
        return $this->getAttribute('last_password_change', null, 'sfGuardSecurityUser');
    }

    public function updateLastPasswordChange()
    {
        $this->setAttribute('last_password_change', null !== $this->getGuardUser() ? $this->getGuardUser()->getLastPasswordChange() : null, 'sfGuardSecurityUser');
    }

    public function getLastLogin()
    {
        return $this->getAttribute('last_login', $this->getGuardUser() ? $this->getGuardUser()->getLastLogin() : null, 'sfGuardSecurityUser');
    }

    public function getGuardUserId()
    {
        return $this->isAuthenticated() ? $this->getAttribute('id', null, 'sfGuardSecurityUser') : null;
    }

    /**
     * 
     * @param sfGuardUser $user 
     * @param bool $remember 
     * @param Connection $con 
     * @return void 
     * @throws PropelException 
     */
    public function signIn($user, $remember = false, $con = null)
    {
        // disable Fast Cache for this session if user is authenticated
        if (SF_APP == 'frontend')
        {
            stFastCacheController::disable();
        }

        $this->setAttribute('last_login', $user->getLastLogin(), 'sfGuardSecurityUser');

        // signin
        $this->setAttribute('user_id', $user->getId(), 'sfGuardSecurityUser');
        $this->setAttribute('super_admin', $user->getIsSuperAdmin(), 'sfGuardSecurityUser');
        $this->setAttribute('username', $user->getUsername(), 'sfGuardSecurityUser');
        $this->setAttribute('last_password_change', $user->getLastPasswordChange(), 'sfGuardSecurityUser');
        $this->setAttribute('id', $user->getId(), 'sfGuardSecurityUser');
        $this->setAuthenticated(true);
        $this->clearCredentials();
        $this->addCredentials($user->getAllPermissionNames());
        $this->addCredentials($user->getModulePermissionNames());
 
        // stLanguage
        $userLanguage = $user->getLanguage();

        if (!empty($userLanguage))
        {
            // $language = LanguagePeer::retrieveByCulture($userLanguage); 
            // if (is_object($language) && $language->getActive()) $this->setCulture($userLanguage);
        }
        else
        {
            $user->setLanguage($this->getCulture());
            $user->save($con);
        }

        // save last login
        $user->setLastLogin(time());
        $user->save($con);

        // remember?
        if ($remember)
        {
            // remove old keys
            $c = new Criteria();
            $expiration_age = sfConfig::get('app_sf_guard_plugin_remember_key_expiration_age', 15 * 24 * 3600);
            $c->add(sfGuardRememberKeyPeer::CREATED_AT, time() - $expiration_age, Criteria::LESS_THAN);
            sfGuardRememberKeyPeer::doDelete($c);

            // remove other keys from this user
            $c = new Criteria();
            $c->add(sfGuardRememberKeyPeer::USER_ID, $user->getId());
            sfGuardRememberKeyPeer::doDelete($c);

            // generate new keys
            $key = $this->generateRandomKey();

            // save key
            $rk = new sfGuardRememberKey();
            $rk->setRememberKey($key);
            $rk->setSfGuardUser($user);
            $rk->setIpAddress($_SERVER['REMOTE_ADDR']);
            $rk->save($con);

            // make key as a cookie
            $remember_cookie = sfConfig::get('app_sf_guard_plugin_remember_cookie_name', 'sfRemember');
            sfContext::getInstance()->getResponse()->setCookie($remember_cookie, $key, time() + $expiration_age);
        }
    }

    protected function generateRandomKey($len = 20)
    {
        $string = '';
        $pool = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789';
        for ($i = 1; $i <= $len; $i++)
        {
            $string .= substr($pool, rand(0, 61), 1);
        }

        return md5($string);
    }

    public function signOut()
    {
        $this->getAttributeHolder()->removeNamespace('sfGuardSecurityUser');
        $this->user = null;
        $this->clearCredentials();
        $this->setAuthenticated(false);
        $expiration_age = sfConfig::get('app_sf_guard_plugin_remember_key_expiration_age', 15 * 24 * 3600);
        $remember_cookie = sfConfig::get('app_sf_guard_plugin_remember_cookie_name', 'sfRemember');
        sfContext::getInstance()->getResponse()->setCookie($remember_cookie, '', time() - $expiration_age);
    }

    /**
     * 
     * @return sfGuardUser 
     * @throws PropelException 
     * @throws sfException 
     */
    public function getGuardUser()
    {
        if (!$this->user && $id = $this->getAttribute('user_id', null, 'sfGuardSecurityUser'))
        {
            $this->user = sfGuardUserPeer::retrieveByPk($id);

            if (!$this->user)
            {
                // the user does not exist anymore in the database
                $this->signOut();

                throw new sfException('The user does not exist anymore in the database.');
            }
        }

        return $this->user;
    }

    // add some proxy method to the sfGuardUser instance

    public function __toString()
    {
        return $this->getGuardUser()->__toString();
    }

    public function getUsername()
    {
        return $this->isAuthenticated() ? $this->getAttribute('username', null, 'sfGuardSecurityUser') : null;
    }

    public function getEmail()
    {
        return $this->getGuardUser()->getEmail();
    }

    public function setPassword($password, $con = null)
    {
        $this->getGuardUser()->setPassword($password);
        $this->getGuardUser()->save($con);

        $this->updateLastPasswordChange();
    }

    public function setEmail($email, $con = null)
    {
        $this->getGuardUser()->setUsername($email);
        $this->getGuardUser()->save($con);
    }

    public function checkPassword($password)
    {
        return $this->getGuardUser()->checkPassword($password);
    }

    public function hasGroup($name)
    {
        return $this->getGuardUser() ? $this->getGuardUser()->hasGroup($name) : false;
    }

    public function getGroups()
    {
        return $this->getGuardUser() ? $this->getGuardUser()->getGroups() : array();
    }

    public function getGroupNames()
    {
        return $this->getGuardUser() ? $this->getGuardUser()->getGroupNames() : array();
    }

    public function hasPermission($name)
    {
        return $this->getGuardUser() ? $this->getGuardUser()->hasPermission($name) : false;
    }

    public function getPermissions()
    {
        return $this->getGuardUser()->getPermissions();
    }

    public function getPermissionNames()
    {
        return $this->getGuardUser() ? $this->getGuardUser()->getPermissionNames() : array();
    }

    public function getAllPermissions()
    {
        return $this->getGuardUser() ? $this->getGuardUser()->getAllPermissions() : array();
    }

    public function getAllPermissionNames()
    {
        return $this->getGuardUser() ? $this->getGuardUser()->getAllPermissionNames() : array();
    }

    public function getProfile()
    {
        return $this->getGuardUser() ? $this->getGuardUser()->getProfile() : null;
    }

    public function addGroupByName($name, $con = null)
    {
        return $this->getGuardUser()->addGroupByName($name, $con);
    }

    public function addPermissionByName($name, $con = null)
    {
        return $this->getGuardUser()->addPermissionByName($name, $con);
    }

}