User class / resending of confirm link updated:
[shipsimu.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, 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 template instance
80                 $templateInstance = $responseInstance->getTemplateInstance();
81
82                 // Get an application instance
83                 $appInstance = $this->getResolverInstance()->getApplicationInstance();
84
85                 // Assign the application data with the template engine
86                 $templateInstance->assignApplicationData($appInstance);
87
88                 // Assign base URL
89                 $templateInstance->assignConfigVariable('base_url');
90
91                 // Get a RNG instance (Random Number Generator)
92                 $rngInstance = ObjectFactory::createObjectByConfiguredName('rng_class');
93
94                 // Generate a pseudo-random string
95                 $randomString = $rngInstance->randomString(255);
96
97                 // Get a crypto instance
98                 $cryptoInstance = ObjectFactory::createObjectByConfiguredName('crypto_class');
99
100                 // Hash and encrypt the string
101                 $hashedString = $cryptoInstance->hashString($cryptoInstance->encryptString($randomString));
102
103                 // Update the user class
104                 $userInstance->updateDatabaseField('confirm_hash', $hashedString);
105
106                 // Get a mailer class
107                 $mailerInstance = ObjectFactory::createObjectByConfiguredName('mailer_class', array($templateInstance));
108
109                 // Load the mail template
110                 $mailerInstance->loadTemplate('resend_link');
111
112                 // Get a user instance from registry
113                 $userInstance = Registry::getRegistry()->getInstance('user');
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();
123
124                 // Send out notification to admin (depends on settings)
125                 $mailerInstance->sendAdminNotification();
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_class'));
138         }
139 }
140
141 // [EOF]
142 ?>