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                 // Set special description
  35                 $this->setObjectDescription("Command for resending confirmation link");
  36
  37                 // Create unique ID number
  38                 $this->generateUniqueId();
  39
  40                 // Clean up a little
  41                 $this->removeSystemArray();
  42         }
  43
  44         /**
  45          * Creates an instance of this class
  46          *
  47          * @param       $resolverInstance       An instance of a command resolver class
  48          * @return      $commandInstance        An instance a prepared command class
  49          */
  50         public final static function createWebResendLinkCommand (CommandResolver $resolverInstance) {
  51                 // Get new instance
  52                 $commandInstance = new WebResendLinkCommand();
  53
  54                 // Set the application instance
  55                 $commandInstance->setResolverInstance($resolverInstance);
  56
  57                 // Return the prepared instance
  58                 return $commandInstance;
  59         }
  60
  61         /**
  62          * Executes the given command with given request and response objects
  63          *
  64          * @param       $requestInstance        An instance of a class with an Requestable interface
  65          * @param       $responseInstance       An instance of a class with an Responseable interface
  66          * @return      void
  67          * @throws      InvalidInterfaceException       If the user class does not implement ManageableUser
  68          */
  69         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  70                 // Get user instance from registry
  71                 $userInstance = Registry::getRegistry()->getInstance('user');
  72
  73                 // Does the user instance implement ManageableUser?
  74                 if (!$userInstance instanceof ManageableUser) {
  75                         // Throw exception here
  76                         throw new InvalidInterfaceException(array($userInstance, 'ManageableUser'), self::EXCEPTION_REQUIRED_INTERFACE_MISSING);
  77                 } // END - if
  78
  79                 // Get an application instance
  80                 $appInstance = $this->getResolverInstance()->getApplicationInstance();
  81
  82                 // Get a RNG instance (Random Number Generator)
  83                 $rngInstance = ObjectFactory::createObjectByConfiguredName('rng_class');
  84
  85                 // Generate a pseudo-random string
  86                 $randomString = $rngInstance->randomString(255);
  87
  88                 // Get a crypto instance
  89                 $cryptoInstance = ObjectFactory::createObjectByConfiguredName('crypto_class');
  90
  91                 // Hash and encrypt the string
  92                 $hashedString = $cryptoInstance->hashString($cryptoInstance->encryptString($randomString));
  93
  94                 // Update the user class
  95                 $userInstance->updateDatabaseField(UserDatabaseWrapper::DB_COLUMN_CONFIRM_HASH, $hashedString);
  96
  97                 // Re-set config entry to mailer engine
  98                 $this->getConfigInstance()->setConfigEntry('template_class', $this->getConfigInstance()->readConfig('mail_template_class'));
  99
 100                 // Prepare the template engine
 101                 $templateInstance = $this->prepareTemplateInstance($appInstance);
 102
 103                 // Assign the application data with the template engine
 104                 $templateInstance->assignApplicationData($appInstance);
 105
 106                 // Get a mailer class
 107                 $mailerInstance = ObjectFactory::createObjectByConfiguredName('mailer_class', array($templateInstance, $appInstance, 'resend_link'));
 108
 109                 // Set this mailer in our template engine
 110                 $templateInstance->setMailerInstance($mailerInstance);
 111
 112                 // Add template variables we shall get
 113                 $mailerInstance->addConfigTemplateVariable('base_url');
 114                 $mailerInstance->addConfigTemplateVariable('admin_email');
 115                 $mailerInstance->addValueTemplateVariable('confirm_hash');
 116                 $mailerInstance->addValueTemplateVariable('username');
 117                 $mailerInstance->addValueTemplateVariable('email');
 118
 119                 // Add the value instance for the confirmation hash
 120                 $mailerInstance->addValueInstance('confirm_hash', $userInstance);
 121                 $mailerInstance->addValueInstance('username', $userInstance);
 122                 $mailerInstance->addValueInstance('email', $userInstance);
 123
 124                 // Add the recipient
 125                 $mailerInstance->addRecipientByUserInstance($userInstance);
 126
 127                 // Use subject line from template
 128                 $mailerInstance->useSubjectFromTemplate();
 129
 130                 // Send the email out
 131                 $mailerInstance->deliverEmail($responseInstance);
 132
 133                 // Send out notification to admin (depends on settings)
 134                 $mailerInstance->sendAdminNotification($responseInstance);
 135         }
 136
 137         /**
 138          * Adds extra filters to the given controller instance
 139          *
 140          * @param       $controllerInstance             A controller instance
 141          * @param       $requestInstance                An instance of a class with an Requestable interface
 142          * @return      void
 143          */
 144         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
 145                 // Filter for checking if account is unconfirmed
 146                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('user_unconfirmed_class'));
 147         }
 148 }
 149
 150 // [EOF]
 151 ?>