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