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

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