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