Copyright upgraded to 2010
[core.git] / 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, 2009, 2010 Core Developer Team
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          */
59         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
60                 // Get user instance from registry
61                 $userInstance = Registry::getRegistry()->getInstance('user');
62
63                 // Get an application instance
64                 $appInstance = $this->getResolverInstance()->getApplicationInstance();
65
66                 // Get a RNG instance (Random Number Generator)
67                 $rngInstance = ObjectFactory::createObjectByConfiguredName('rng_class');
68
69                 // Generate a pseudo-random string
70                 $randomString = $rngInstance->randomString(255);
71
72                 // Get a crypto instance
73                 $cryptoInstance = ObjectFactory::createObjectByConfiguredName('crypto_class');
74
75                 // Hash and encrypt the string
76                 $hashedString = $cryptoInstance->hashString($cryptoInstance->encryptString($randomString));
77
78                 // Update the user class
79                 $userInstance->updateDatabaseField(UserDatabaseWrapper::DB_COLUMN_CONFIRM_HASH, $hashedString);
80
81                 // Re-set config entry to mailer engine
82                 $this->getConfigInstance()->setConfigEntry('web_template_class', $this->getConfigInstance()->getConfigEntry('mail_template_class'));
83
84                 // Prepare the template engine
85                 $templateInstance = $this->prepareTemplateInstance($appInstance);
86
87                 // Assign the application data with the template engine
88                 $templateInstance->assignApplicationData($appInstance);
89
90                 // Get a mailer class
91                 $mailerInstance = ObjectFactory::createObjectByConfiguredName('mailer_class', array($templateInstance, $appInstance, 'resend_link'));
92
93                 // Set this mailer in our template engine
94                 $templateInstance->setMailerInstance($mailerInstance);
95
96                 // Add template variables we shall get
97                 $mailerInstance->addConfigTemplateVariable('base_url');
98                 $mailerInstance->addConfigTemplateVariable('admin_email');
99                 $mailerInstance->addValueTemplateVariable('confirm_hash');
100                 $mailerInstance->addValueTemplateVariable('username');
101                 $mailerInstance->addValueTemplateVariable('email');
102
103                 // Add the value instance for the confirmation hash
104                 $mailerInstance->addValueInstance('confirm_hash', $userInstance);
105                 $mailerInstance->addValueInstance('username', $userInstance);
106                 $mailerInstance->addValueInstance('email', $userInstance);
107
108                 // Add the recipient
109                 $mailerInstance->addRecipientByUserInstance($userInstance);
110
111                 // Use subject line from template
112                 $mailerInstance->useSubjectFromTemplate();
113
114                 // Send the email out
115                 $mailerInstance->deliverEmail($responseInstance);
116
117                 // Send out notification to admin (depends on settings)
118                 $mailerInstance->sendAdminNotification($responseInstance);
119         }
120
121         /**
122          * Adds extra filters to the given controller instance
123          *
124          * @param       $controllerInstance             A controller instance
125          * @param       $requestInstance                An instance of a class with an Requestable interface
126          * @return      void
127          */
128         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
129                 // Filter for checking if account is unconfirmed
130                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('user_unconfirmed_filter'));
131         }
132 }
133
134 // [EOF]
135 ?>