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

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