File indexing completed on 2024-12-22 05:36:17

 <?php
 /**
  * Zend Framework
  *
  * LICENSE
  *
  * This source file is subject to the new BSD license that is bundled
  * with this package in the file LICENSE.txt.
  * It is also available through the world-wide-web at this URL:
  * http://framework.zend.com/license/new-bsd
  * If you did not receive a copy of the license and are unable to
  * obtain it through the world-wide-web, please send an email
  * to license@zend.com so we can send you a copy immediately.
  *
  * @category   Zend
  * @package    Zend_Auth
  * @subpackage Adapter
  * @copyright  Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  * @version    $Id: DbTable.php 23775 2011-03-01 17:25:24Z ralph $
  */
 
 
 /**
  * @see Zend_Auth_Adapter_Interface
  */
 require_once 'Zend/Auth/Adapter/Interface.php';
 
 /**
  * @see Zend_Auth_Result
  */
 require_once 'Zend/Auth/Result.php';
 
 
 /**
  * @category   Zend
  * @package    Zend_Auth
  * @subpackage Adapter
  * @copyright  Copyright (c) 2011 Björn Schramke (http://www.schramke-online.de)
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  */
 class CB_Auth_Adapter_Doctrine2 implements Zend_Auth_Adapter_Interface
 {
 
     /**
      * Doctrine2 EntityManager
      *
      * @var \Doctrine\ORM\EntityManager
      */
     protected $_em = null;
 
     /**
      * $_modelName - the Doctrine2 entity to check
      *
      * @var string
      */
     protected $_modelName = null;
 
     /**
      * $_identityColumn - the column to use as the identity
      *
      * @var string
      */
     protected $_identityColumn = null;
 
     /**
      * $_credentialColumns - columns to be used as the credentials
      *
      * @var string
      */
     protected $_credentialColumn = null;
 
     /**
      * $_identity - Identity value
      *
      * @var string
      */
     protected $_identity = null;
 
     /**
      * $_credential - Credential values
      *
      * @var string
      */
     protected $_credential = null;
 
     /**
      * $_credentialTreatment - Treatment applied to the credential, such as MD5() or PASSWORD()
      *
      * @var string
      */
     protected $_credentialTreatment = null;
 
     /**
      * $_authenticateResultInfo
      *
      * @var array
      */
     protected $_authenticateResultInfo = null;
 
     /**
      * $_resultRow - Results of database authentication query
      *
      * @var array
      */
     protected $_resultRow = null;
 
     /**
      * $_ambiguityIdentity - Flag to indicate same Identity can be used with
      * different credentials. Default is FALSE and need to be set to true to
      * allow ambiguity usage.
      *
      * @var boolean
      */
     protected $_ambiguityIdentity = false;
 
     /**
      * __construct() - Sets configuration options
      *
      * @param  \Doctrine\ORM\EntityManager $em If null, default database adapter assumed
      * @param  string                   $tableName
      * @param  string                   $identityColumn
      * @param  string                   $credentialColumn
      * @param  string                   $credentialTreatment
      * @return void
      */
     public function __construct(\Doctrine\ORM\EntityManager $em = null, $modelName = null, $identityColumn = null,
                                 $credentialColumn = null, $credentialTreatment = null)
     {
         $this->_setEntityManager($em);
 
         if (null !== $modelName) {
             $this->setModelName($modelName);
         }
 
         if (null !== $identityColumn) {
             $this->setIdentityColumn($identityColumn);
         }
 
         if (null !== $credentialColumn) {
             $this->setCredentialColumn($credentialColumn);
         }
 
         if (null !== $credentialTreatment) {
             $this->setCredentialTreatment($credentialTreatment);
         }
     }
 
     /**
      * _setEntityManager() - set the EntityManager to be used for quering
      *
      * @param \Doctrine\ORM\EntityManager
      * @throws Zend_Auth_Adapter_Exception
      * @return CB_Auth_Adapter_Doctrine2
      */
     protected function _setEntityManager(\Doctrine\ORM\EntityManager $em = null)
     {
         $this->_em = $em;
             
         /**
          * If no adapter is specified, fetch default database adapter.
          */
         if(null === $this->_em) {
             require_once 'Zend/Auth/Adapter/Exception.php';
             throw new Zend_Auth_Adapter_Exception('No Doctrine2 EntityManager present');
         }
 
         return $this;
     }
 
     /**
      * setTableName() - set the table name to be used in the select query
      *
      * @param  string $tableName
      * @return CB_Auth_Adapter_Doctrine2 Provides a fluent interface
      */
     public function setModelName($modelName)
     {
         $this->_modelName = $modelName;
         return $this;
     }
 
     /**
      * setIdentityColumn() - set the column name to be used as the identity column
      *
      * @param  string $identityColumn
      * @return CB_Auth_Adapter_Doctrine2 Provides a fluent interface
      */
     public function setIdentityColumn($identityColumn)
     {
         $this->_identityColumn = $identityColumn;
         return $this;
     }
 
     /**
      * setCredentialColumn() - set the column name to be used as the credential column
      *
      * @param  string $credentialColumn
      * @return CB_Auth_Adapter_Doctrine2 Provides a fluent interface
      */
     public function setCredentialColumn($credentialColumn)
     {
         $this->_credentialColumn = $credentialColumn;
         return $this;
     }
 
     /**
      * setCredentialTreatment() - allows the developer to pass a parameterized string that is
      * used to transform or treat the input credential data.
      *
      * In many cases, passwords and other sensitive data are encrypted, hashed, encoded,
      * obscured, or otherwise treated through some function or algorithm. By specifying a
      * parameterized treatment string with this method, a developer may apply arbitrary SQL
      * upon input credential data.
      *
      * Examples:
      *
      *  'PASSWORD(?)'
      *  'MD5(?)'
      *
      * @param  string $treatment
      * @return CB_Auth_Adapter_Doctrine2 Provides a fluent interface
      */
     public function setCredentialTreatment($treatment)
     {
         $this->_credentialTreatment = $treatment;
         return $this;
     }
 
     /**
      * setIdentity() - set the value to be used as the identity
      *
      * @param  string $value
      * @return CB_Auth_Adapter_Doctrine2 Provides a fluent interface
      */
     public function setIdentity($value)
     {
         $this->_identity = $value;
         return $this;
     }
 
     /**
      * setCredential() - set the credential value to be used, optionally can specify a treatment
      * to be used, should be supplied in parameterized form, such as 'MD5(?)' or 'PASSWORD(?)'
      *
      * @param  string $credential
      * @return CB_Auth_Adapter_Doctrine2 Provides a fluent interface
      */
     public function setCredential($credential)
     {
         $this->_credential = $credential;
         return $this;
     }
 
     /**
      * getResultRowObject() - Returns the result row as a stdClass object
      *
      * @param  string|array $returnColumns
      * @param  string|array $omitColumns
      * @return stdClass|boolean
      */
     public function getResultRowObject($returnColumns = null, $omitColumns = null)
     {
         if (!$this->_resultRow) {
             return false;
         }
         
         return $this->_resultRow;
     }
 
     /**
      * authenticate() - defined by Zend_Auth_Adapter_Interface.  This method is called to
      * attempt an authentication.  Previous to this call, this adapter would have already
      * been configured with all necessary information to successfully connect to a database
      * table and attempt to find a record matching the provided identity.
      *
      * @throws Zend_Auth_Adapter_Exception if answering the authentication query is impossible
      * @return Zend_Auth_Result
      */
     public function authenticate()
     {
         $this->_authenticateSetup();
         $query = $this->_authenticateCreateSelect();
         $resultIdentities = $this->_authenticateQuerySelect($query);
         $authResult = $this->_authenticateValidateResultSet($resultIdentities);
                 
         if ( $authResult instanceof Zend_Auth_Result) 
         {
             return $authResult;
         }
        
         return $this->_authenticateValidateResult(array_shift($resultIdentities));
     }
 
     /**
      * _authenticateSetup() - This method abstracts the steps involved with
      * making sure that this adapter was indeed setup properly with all
      * required pieces of information.
      *
      * @throws Zend_Auth_Adapter_Exception - in the event that setup was not done properly
      * @return true
      */
     protected function _authenticateSetup()
     {
         $exception = null;
 
         if ($this->_modelName == '') {
             $exception = 'A model must be supplied for the CB_Auth_Adapter_Doctrine2 authentication adapter.';
         } elseif ($this->_identityColumn == '') {
             $exception = 'An identity column must be supplied for the CB_Auth_Adapter_Doctrine2 authentication adapter.';
         } elseif ($this->_credentialColumn == '') {
             $exception = 'A credential column must be supplied for the CB_Auth_Adapter_Doctrine2 authentication adapter.';
         } elseif ($this->_identity == '') {
             $exception = 'A value for the identity was not provided prior to authentication with CB_Auth_Adapter_Doctrine2.';
         } elseif ($this->_credential === null) {
             $exception = 'A credential value was not provided prior to authentication with CB_Auth_Adapter_Doctrine2.';
         }
 
         if (null !== $exception) {
             /**
              * @see Zend_Auth_Adapter_Exception
              */
             require_once 'Zend/Auth/Adapter/Exception.php';
             throw new Zend_Auth_Adapter_Exception($exception);
         }
 
         $this->_authenticateResultInfo = array(
             'code'     => Zend_Auth_Result::FAILURE,
             'identity' => $this->_identity,
             'messages' => array()
             );
 
         return true;
     }
 
     /**
      * _authenticateCreateSelect() - This method creates a \Doctrine\ORM\Query object that
      * is completely configured to be queried against the database.
      *
      * @return \Doctrine\ORM\Query
      */
     protected function _authenticateCreateSelect()
     {
         // build credential expression
         if (empty($this->_credentialTreatment) || (strpos($this->_credentialTreatment, '?') === false)) {
             $this->_credentialTreatment = '?';
         }
 
         $idExpr = 'u.'.$this->_identityColumn.' = :id';
 //        $credExpr = 'u.'.$this->_credentialColumn.' = :cred';
 //        $query = $this->_em->createQuery('SELECT u from Application_Model_User u WHERE '.$idExpr.' AND '.$credExpr);
         $query = $this->_em->createQuery('SELECT u from Application_Model_User u WHERE '.$idExpr);
         $query->setParameters(array(
             'id' => $this->_identity,
 //            'cred' => $this->_credential,
         ));
 
         return $query;
     }
 
     /**
      * _authenticateQuerySelect() - This method accepts a Zend_Db_Select object and
      * performs a query against the database with that object.
      *
      * @param Zend_Db_Select $dbSelect
      * @throws Zend_Auth_Adapter_Exception - when an invalid select
      *                                       object is encountered
      * @return array
      */
     
     protected function _authenticateQuerySelect(\Doctrine\ORM\Query $query)
     {
         try {
             $resultIdentities = $query->getResult(); 
         } catch (Exception $e) {
             /**
              * @see Zend_Auth_Adapter_Exception
              */
             require_once 'Zend/Auth/Adapter/Exception.php';
             throw new Zend_Auth_Adapter_Exception('The supplied parameters to CB_Auth_Adapter_Doctrine2 failed to '
                                                 . 'produce a valid DQL statement, please check table and column names '
                                                 . 'for validity.', 0, $e);
         }
         return $resultIdentities;
     }
 
     /**
      * _authenticateValidateResultSet() - This method attempts to make
      * certain that only one record was returned in the resultset
      *
      * @param array $resultIdentities
      * @return true|Zend_Auth_Result
      */
     protected function _authenticateValidateResultSet(array $resultIdentities)
     {
 
         if (count($resultIdentities) < 1) {
             $this->_authenticateResultInfo['code'] = Zend_Auth_Result::FAILURE_IDENTITY_NOT_FOUND;
             $this->_authenticateResultInfo['messages'][] = 'A record with the supplied identity could not be found.';
             return $this->_authenticateCreateAuthResult();
         } elseif (count($resultIdentities) > 1 && false === $this->getAmbiguityIdentity()) {
             $this->_authenticateResultInfo['code'] = Zend_Auth_Result::FAILURE_IDENTITY_AMBIGUOUS;
             $this->_authenticateResultInfo['messages'][] = 'More than one record matches the supplied identity.';
             return $this->_authenticateCreateAuthResult();
         }
 
         return true;
     }
 
     /**
      * _authenticateValidateResult() - This method attempts to validate that
      * the record in the resultset is indeed a record that matched the
      * identity provided to this adapter.
      *
      * @param array $resultIdentity
      * @return Zend_Auth_Result
      */
     protected function _authenticateValidateResult($resultIdentity)
     {
           $credColumnFunc = 'get'.ucfirst($this->_credentialColumn);
           
           if(!method_exists($resultIdentity,$credColumnFunc))
           {
             $this->_authenticateResultInfo['code'] = Zend_Auth_Result::FAILURE_CREDENTIAL_INVALID;
             $this->_authenticateResultInfo['messages'][] = 'Error on validating supplied credential.';
             return $this->_authenticateCreateAuthResult();
           }
           
           $cred = $resultIdentity->{$credColumnFunc}();
         if ($cred !== $this->_credential) 
         {
             $this->_authenticateResultInfo['code'] = Zend_Auth_Result::FAILURE_CREDENTIAL_INVALID;
             $this->_authenticateResultInfo['messages'][] = 'Supplied credential is invalid.';
             return $this->_authenticateCreateAuthResult();
         }
           
         $this->_resultRow = $resultIdentity;
 
         $this->_authenticateResultInfo['code'] = Zend_Auth_Result::SUCCESS;
         $this->_authenticateResultInfo['messages'][] = 'Authentication successful.';
         return $this->_authenticateCreateAuthResult();
     }
 
     /**
      * _authenticateCreateAuthResult() - Creates a Zend_Auth_Result object from
      * the information that has been collected during the authenticate() attempt.
      *
      * @return Zend_Auth_Result
      */
     protected function _authenticateCreateAuthResult()
     {
         return new Zend_Auth_Result(
             $this->_authenticateResultInfo['code'],
             $this->_authenticateResultInfo['identity'],
             $this->_authenticateResultInfo['messages']
             );
     }
 
 }