inc/main/classes/filter/crypto/class_CaptchaEncryptFilter.php

   1 <?php
   2 /**
   3  * A filter for checking if value "encrypt" is set and fine
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class CaptchaEncryptFilter extends BaseFilter implements Filterable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33         }
  34
  35         /**
  36          * Creates an instance of this filter class
  37          *
  38          * @return      $filterInstance                 An instance of this filter class
  39          */
  40         public static final function createCaptchaEncryptFilter () {
  41                 // Get a new instance
  42                 $filterInstance = new CaptchaEncryptFilter();
  43
  44                 // Return the instance
  45                 return $filterInstance;
  46         }
  47
  48         /**
  49          * Executes the filter with given request and response objects
  50          *
  51          * @param       $requestInstance        An instance of a class with an Requestable interface
  52          * @param       $responseInstance       An instance of a class with an Responseable interface
  53          * @return      void
  54          * @throws      EncryptMissingException         If the "encrypt" value is not set
  55          */
  56         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  57                 // Get "encrypt" string barely from the request
  58                 $encryptRequest = $requestInstance->getRequestElement('encrypt');
  59
  60                 // Is it there?
  61                 if (is_null($encryptRequest)) {
  62                         // Not found, so request is invalid
  63                         $requestInstance->requestIsValid(FALSE);
  64
  65                         // Throw exception
  66                         throw new EncryptMissingException($this, CryptoHelper::EXCEPTION_ENCRYPT_MISSING);
  67                 } // END - if
  68
  69                 // Decode it fully
  70                 $encryptDecoded = base64_decode(str_replace(' ', '+', urldecode($encryptRequest)));
  71
  72                 // Get a crypto helper and decrypt the string
  73                 $decryptedString = ObjectFactory::createObjectByConfiguredName('crypto_class')->decryptString($encryptDecoded);
  74
  75                 // Is it the expected length?
  76                 if (strlen($decryptedString) != $this->getConfigInstance()->getConfigEntry('captcha_string_length')) {
  77                         // Not found, so request is invalid
  78                         $requestInstance->requestIsValid(FALSE);
  79
  80                         // Throw exception
  81                         throw new EncryptInvalidLengthException($this, CryptoHelper::EXCEPTION_ENCRYPT_INVALID);
  82                 } // END - if
  83
  84                 // Write it to the request
  85                 $requestInstance->setRequestElement('decrypted', $decryptedString);
  86         }
  87 }
  88
  89 // [EOF]
  90 ?>