inc/classes/main/commands/web/class_WebResendLinkCommand.php

   1 <?php
   2 /**
   3  * A command class for resending the confirmation link
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, this is free software
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class WebResendLinkCommand extends BaseCommand implements Commandable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33         }
  34
  35         /**
  36          * Creates an instance of this class
  37          *
  38          * @param       $resolverInstance       An instance of a command resolver class
  39          * @return      $commandInstance        An instance a prepared command class
  40          */
  41         public final static function createWebResendLinkCommand (CommandResolver $resolverInstance) {
  42                 // Get new instance
  43                 $commandInstance = new WebResendLinkCommand();
  44
  45                 // Set the application instance
  46                 $commandInstance->setResolverInstance($resolverInstance);
  47
  48                 // Return the prepared instance
  49                 return $commandInstance;
  50         }
  51
  52         /**
  53          * Executes the given command with given request and response objects
  54          *
  55          * @param       $requestInstance        An instance of a class with an Requestable interface
  56          * @param       $responseInstance       An instance of a class with an Responseable interface
  57          * @return      void
  58          * @throws      InvalidInterfaceException       If the user class does not implement ManageableMember
  59          */
  60         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  61                 // Get user instance from registry
  62                 $userInstance = Registry::getRegistry()->getInstance('user');
  63
  64                 // Does the user instance implement ManageableMember?
  65                 if (!$userInstance instanceof ManageableMember) {
  66                         // Throw exception here
  67                         throw new InvalidInterfaceException(array($userInstance, 'ManageableMember'), self::EXCEPTION_REQUIRED_INTERFACE_MISSING);
  68                 } // END - if
  69
  70                 // Get an application instance
  71                 $appInstance = $this->getResolverInstance()->getApplicationInstance();
  72
  73                 // Get a RNG instance (Random Number Generator)
  74                 $rngInstance = ObjectFactory::createObjectByConfiguredName('rng_class');
  75
  76                 // Generate a pseudo-random string
  77                 $randomString = $rngInstance->randomString(255);
  78
  79                 // Get a crypto instance
  80                 $cryptoInstance = ObjectFactory::createObjectByConfiguredName('crypto_class');
  81
  82                 // Hash and encrypt the string
  83                 $hashedString = $cryptoInstance->hashString($cryptoInstance->encryptString($randomString));
  84
  85                 // Update the user class
  86                 $userInstance->updateDatabaseField(UserDatabaseWrapper::DB_COLUMN_CONFIRM_HASH, $hashedString);
  87
  88                 // Re-set config entry to mailer engine
  89                 $this->getConfigInstance()->setConfigEntry('template_class', $this->getConfigInstance()->readConfig('mail_template_class'));
  90
  91                 // Prepare the template engine
  92                 $templateInstance = $this->prepareTemplateInstance($appInstance);
  93
  94                 // Assign the application data with the template engine
  95                 $templateInstance->assignApplicationData($appInstance);
  96
  97                 // Get a mailer class
  98                 $mailerInstance = ObjectFactory::createObjectByConfiguredName('mailer_class', array($templateInstance, $appInstance, 'resend_link'));
  99
 100                 // Set this mailer in our template engine
 101                 $templateInstance->setMailerInstance($mailerInstance);
 102
 103                 // Add template variables we shall get
 104                 $mailerInstance->addConfigTemplateVariable('base_url');
 105                 $mailerInstance->addConfigTemplateVariable('admin_email');
 106                 $mailerInstance->addValueTemplateVariable('confirm_hash');
 107                 $mailerInstance->addValueTemplateVariable('username');
 108                 $mailerInstance->addValueTemplateVariable('email');
 109
 110                 // Add the value instance for the confirmation hash
 111                 $mailerInstance->addValueInstance('confirm_hash', $userInstance);
 112                 $mailerInstance->addValueInstance('username', $userInstance);
 113                 $mailerInstance->addValueInstance('email', $userInstance);
 114
 115                 // Add the recipient
 116                 $mailerInstance->addRecipientByUserInstance($userInstance);
 117
 118                 // Use subject line from template
 119                 $mailerInstance->useSubjectFromTemplate();
 120
 121                 // Send the email out
 122                 $mailerInstance->deliverEmail($responseInstance);
 123
 124                 // Send out notification to admin (depends on settings)
 125                 $mailerInstance->sendAdminNotification($responseInstance);
 126         }
 127
 128         /**
 129          * Adds extra filters to the given controller instance
 130          *
 131          * @param       $controllerInstance             A controller instance
 132          * @param       $requestInstance                An instance of a class with an Requestable interface
 133          * @return      void
 134          */
 135         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
 136                 // Filter for checking if account is unconfirmed
 137                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('user_unconfirmed_filter', array($controllerInstance)));
 138         }
 139 }
 140
 141 // [EOF]
 142 ?>