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