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

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Filter\Verifier\Confirmation;
   4
   5 /**
   6  * A filter for checking if supplied confirmation code is valid.
   7  *
   8  * @author              Roland Haeder <webmaster@shipsimu.org>
   9  * @version             0.0.0
  10  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  11  * @license             GNU GPL 3.0 or any newer version
  12  * @link                http://www.shipsimu.org
  13  *
  14  * This program is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation, either version 3 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * This program is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License
  25  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  26  */
  27 class ConfirmCodeVerifierFilter extends BaseFilter implements Filterable {
  28         /**
  29          * Protected constructor
  30          *
  31          * @return      void
  32          */
  33         protected function __construct () {
  34                 // Call parent constructor
  35                 parent::__construct(__CLASS__);
  36         }
  37
  38         /**
  39          * Creates an instance of this filter class
  40          *
  41          * @return      $filterInstance         An instance of this filter class
  42          */
  43         public static final function createConfirmCodeVerifierFilter () {
  44                 // Get a new instance
  45                 $filterInstance = new ConfirmCodeVerifierFilter();
  46
  47                 // Return the instance
  48                 return $filterInstance;
  49         }
  50
  51         /**
  52          * Executes the filter with given request and response objects
  53          *
  54          * @param       $requestInstance        An instance of a class with an Requestable interface
  55          * @param       $responseInstance       An instance of a class with an Responseable interface
  56          * @return      void
  57          * @throws      FilterChainException    If this filter fails to operate
  58          */
  59         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  60                 // Get confirmation code from request
  61                 $confirmCode = $requestInstance->getRequestElement('confirm');
  62
  63                 // Is this code set?
  64                 if (is_null($confirmCode)) {
  65                         // Is not in request
  66                         $requestInstance->requestIsValid(FALSE);
  67
  68                         // Add a message to the response
  69                         $responseInstance->addFatalMessage('confirm_code_unset');
  70
  71                         // Abort here
  72                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
  73                 } elseif (empty($confirmCode)) {
  74                         // Email is empty
  75                         $requestInstance->requestIsValid(FALSE);
  76
  77                         // Add a message to the response
  78                         $responseInstance->addFatalMessage('confirm_code_empty');
  79
  80                         // Abort here
  81                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
  82                 }
  83
  84                 // Get a user instance from registry
  85                 $userInstance = Registry::getRegistry()->getInstance('user');
  86
  87                 // Get the confirm code from user for comparison
  88                 $userCode = $userInstance->getField(UserDatabaseWrapper::DB_COLUMN_CONFIRM_HASH);
  89
  90                 // Do we have the same code or different?
  91                 if ($userCode != $confirmCode) {
  92                         // Email is empty
  93                         $requestInstance->requestIsValid(FALSE);
  94
  95                         // Redirect to error page
  96                         $responseInstance->redirectToConfiguredUrl('confirm_code_invalid');
  97
  98                         // Stop processing here
  99                         exit();
 100                 } // END - if
 101         }
 102
 103 }