inc/main/classes/filter/verifier/class_ConfirmCodeVerifierFilter.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Filter\Verifier\Confirmation;
   4
   5 // Import framework stuff
   6 use CoreFramework\Registry\Generic\Registry;
   7
   8 /**
   9  * A filter for checking if supplied confirmation code is valid.
  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 ConfirmCodeVerifierFilter 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 createConfirmCodeVerifierFilter () {
  47                 // Get a new instance
  48                 $filterInstance = new ConfirmCodeVerifierFilter();
  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      FilterChainException    If this filter fails to operate
  61          */
  62         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  63                 // Get confirmation code from request
  64                 $confirmCode = $requestInstance->getRequestElement('confirm');
  65
  66                 // Is this code set?
  67                 if (is_null($confirmCode)) {
  68                         // Is not in request
  69                         $requestInstance->requestIsValid(FALSE);
  70
  71                         // Add a message to the response
  72                         $responseInstance->addFatalMessage('confirm_code_unset');
  73
  74                         // Abort here
  75                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
  76                 } elseif (empty($confirmCode)) {
  77                         // Email is empty
  78                         $requestInstance->requestIsValid(FALSE);
  79
  80                         // Add a message to the response
  81                         $responseInstance->addFatalMessage('confirm_code_empty');
  82
  83                         // Abort here
  84                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
  85                 }
  86
  87                 // Get a user instance from registry
  88                 $userInstance = Registry::getRegistry()->getInstance('user');
  89
  90                 // Get the confirm code from user for comparison
  91                 $userCode = $userInstance->getField(UserDatabaseWrapper::DB_COLUMN_CONFIRM_HASH);
  92
  93                 // Do we have the same code or different?
  94                 if ($userCode != $confirmCode) {
  95                         // Email is empty
  96                         $requestInstance->requestIsValid(FALSE);
  97
  98                         // Redirect to error page
  99                         $responseInstance->redirectToConfiguredUrl('confirm_code_invalid');
 100
 101                         // Stop processing here
 102                         exit();
 103                 } // END - if
 104         }
 105
 106 }