framework/main/classes/filter/change/class_PasswordChangeFilter.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Filter\Change\Password;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Filter\BaseFilter;
   7 use Org\Mxchange\CoreFramework\Filter\Chain\FilterChainException;
   8 use Org\Mxchange\CoreFramework\Filter\Filterable;
   9 use Org\Mxchange\CoreFramework\Registry\GenericRegistry;
  10 use Org\Mxchange\CoreFramework\Request\Requestable;
  11 use Org\Mxchange\CoreFramework\Response\Responseable;
  12
  13 /**
  14  * A filter for password change detection
  15  *
  16  * @author              Roland Haeder <webmaster@shipsimu.org>
  17  * @version             0.0.0
  18  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2022 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 PasswordChangeFilter extends BaseFilter implements Filterable {
  36         /**
  37          * Protected constructor
  38          *
  39          * @return      void
  40          */
  41         private function __construct () {
  42                 // Call parent constructor
  43                 parent::__construct(__CLASS__);
  44         }
  45
  46         /**
  47          * Creates an instance of this filter class
  48          *
  49          * @param       $controllerInstance             An instance of a controller class
  50          * @return      $filterInstance                 An instance of this filter class
  51          */
  52         public static final function createPasswordChangeFilter () {
  53                 // Get a new instance
  54                 $filterInstance = new PasswordChangeFilter();
  55
  56                 // Return the instance
  57                 return $filterInstance;
  58         }
  59
  60         /**
  61          * Executes the filter with given request and response objects
  62          *
  63          * @param       $requestInstance        An instance of a class with an Requestable interface
  64          * @param       $responseInstance       An instance of a class with an Responseable interface
  65          * @return      void
  66          * @todo        Finished updating user password hash here. HINT: Use the User class again.
  67          * @throws      FilterChainException    If this filter fails to operate
  68          */
  69         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  70                 // Get both passwords
  71                 $pass1 = $requestInstance->getRequestElement('pass1');
  72                 $pass2 = $requestInstance->getRequestElement('pass2');
  73
  74                 // Is only first email set?
  75                 if ((!empty($pass1)) && (empty($pass2))) {
  76                         // Request is invalid!
  77                         $requestInstance->requestIsValid(false);
  78
  79                         // Email 2 is empty
  80                         $responseInstance->addFatalMessage('pass2_empty');
  81
  82                         // Stop processing here
  83                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
  84                 }
  85
  86                 // Is only second pass set?
  87                 if ((empty($pass1)) && (!empty($pass2))) {
  88                         // Request is invalid!
  89                         $requestInstance->requestIsValid(false);
  90
  91                         // Email 1 is empty
  92                         $responseInstance->addFatalMessage('pass1_empty');
  93
  94                         // Stop processing here
  95                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
  96                 }
  97
  98                 // Are password and confirmation empty?
  99                 if ((empty($pass1)) && (empty($pass2))) {
 100                         // Don't change password here
 101                         return true;
 102                 }
 103
 104                 // Do both match?
 105                 if ($pass1 != $pass2) {
 106                         // Request is invalid!
 107                         $requestInstance->requestIsValid(false);
 108
 109                         // Emails are mismatching
 110                         $responseInstance->addFatalMessage('pass_mismatch');
 111
 112                         // Stop processing here
 113                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
 114                 }
 115
 116                 // Now, get a user instance for comparison
 117                 $userInstance = GenericRegistry::getRegistry()->getInstance('user');
 118
 119                 // Update the "password" field
 120                 $this->partialStub('Unfinished part.');
 121         }
 122
 123 }