From: Roland Häder Date: Tue, 26 Aug 2008 14:58:35 +0000 (+0000) Subject: Logout procedure rewritten to logout controller and command X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=63f10e66b084753fae3e9f3dc66bddd0ad6b1087;p=shipsimu.git Logout procedure rewritten to logout controller and command --- diff --git a/.gitattributes b/.gitattributes index 2f16f71..797f038 100644 --- a/.gitattributes +++ b/.gitattributes @@ -452,7 +452,6 @@ inc/classes/main/actions/class_BaseAction.php -text inc/classes/main/actions/post_registration/.htaccess -text inc/classes/main/actions/post_registration/class_LoginAfterRegistrationAction.php -text inc/classes/main/actions/web/.htaccess -text -inc/classes/main/actions/web/class_WebLoginLogoutAction.php -text inc/classes/main/actions/web/class_WebLoginProfileAction.php -text inc/classes/main/auth/.htaccess -text inc/classes/main/auth/class_CookieAuth.php -text @@ -474,6 +473,7 @@ inc/classes/main/commands/web/class_WebHomeCommand.php -text inc/classes/main/commands/web/class_WebLoginAreaCommand.php -text inc/classes/main/commands/web/class_WebLoginCommand.php -text inc/classes/main/commands/web/class_WebLoginFailedCommand.php -text +inc/classes/main/commands/web/class_WebLogoutCommand.php -text inc/classes/main/commands/web/class_WebLogoutDoneCommand.php -text inc/classes/main/commands/web/class_WebRegisterCommand.php -text inc/classes/main/commands/web/class_WebResendLinkCommand.php -text @@ -501,6 +501,7 @@ inc/classes/main/controller/web/class_WebDefaultController.php -text inc/classes/main/controller/web/class_WebDefaultNewsController.php -text inc/classes/main/controller/web/class_WebLoginController.php -text inc/classes/main/controller/web/class_WebLoginFailedController.php -text +inc/classes/main/controller/web/class_WebLogoutController.php -text inc/classes/main/controller/web/class_WebLogoutDoneController.php -text inc/classes/main/controller/web/class_WebRegisterController.php -text inc/classes/main/controller/web/class_WebStatusController.php -text diff --git a/application/blog/config.php b/application/blog/config.php index cf43842..53bdfd5 100644 --- a/application/blog/config.php +++ b/application/blog/config.php @@ -205,9 +205,6 @@ $cfg->setConfigEntry('blog_user_login_captcha', "GraphicalCodeCaptcha"); // CFG: blog-GUEST-LOGIN-CAPTCHA $cfg->setConfigEntry('blog_guest_login_captcha', "GraphicalCodeCaptcha"); -// CFG: LOGOUT-IMMEDIATE -$cfg->setConfigEntry('logout_immediate', "N"); - // CFG: CAPTCHA-STRING-LENGTH $cfg->setConfigEntry('captcha_string_length', 5); diff --git a/application/blog/templates/de/code/action_login_logout.ctp b/application/blog/templates/de/code/action_login_logout.ctp index 465e807..5d345c3 100644 --- a/application/blog/templates/de/code/action_login_logout.ctp +++ b/application/blog/templates/de/code/action_login_logout.ctp @@ -1,6 +1,6 @@ addLinkWithTextById('logout_now_link_text'); diff --git a/application/ship-simu/config.php b/application/ship-simu/config.php index c4b6093..f59de87 100644 --- a/application/ship-simu/config.php +++ b/application/ship-simu/config.php @@ -217,9 +217,6 @@ $cfg->setConfigEntry('shipsimu_guest_login_captcha', "GraphicalCodeCaptcha"); // CFG: MONEY-REFILL-FORM-CAPTCHA $cfg->setConfigEntry('money_refill_form_captcha', "GraphicalCodeCaptcha"); -// CFG: LOGOUT-IMMEDIATE -$cfg->setConfigEntry('logout_immediate', "N"); - // CFG: CAPTCHA-STRING-LENGTH $cfg->setConfigEntry('captcha_string_length', 5); diff --git a/application/ship-simu/main/filter/validator/class_MoneyRefillRequestValidatorFilter.php b/application/ship-simu/main/filter/validator/class_MoneyRefillRequestValidatorFilter.php index 3830938..632df43 100644 --- a/application/ship-simu/main/filter/validator/class_MoneyRefillRequestValidatorFilter.php +++ b/application/ship-simu/main/filter/validator/class_MoneyRefillRequestValidatorFilter.php @@ -58,7 +58,7 @@ class MoneyRefillRequestValidatorFilter extends BaseFrameworkSystem implements F * @todo 0% done */ public function execute (Requestable $requestInstance, Responseable $responseInstance) { - $this->partialStub("Please implement this method."); + $requestInstance->debugInstance(); } } diff --git a/application/ship-simu/templates/de/code/action_login_logout.ctp b/application/ship-simu/templates/de/code/action_login_logout.ctp index b7ebf87..944166e 100644 --- a/application/ship-simu/templates/de/code/action_login_logout.ctp +++ b/application/ship-simu/templates/de/code/action_login_logout.ctp @@ -1,6 +1,6 @@ addLinkWithTextById('logout_now_link_text'); diff --git a/inc/classes/main/actions/web/class_WebLoginLogoutAction.php b/inc/classes/main/actions/web/class_WebLoginLogoutAction.php deleted file mode 100644 index bf65545..0000000 --- a/inc/classes/main/actions/web/class_WebLoginLogoutAction.php +++ /dev/null @@ -1,85 +0,0 @@ - - * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software - * @license GNU GPL 3.0 or any newer version - * @link http://www.ship-simu.org - * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see . - */ -class WebLoginLogoutAction extends BaseAction implements Commandable, Registerable { - /** - * Protected constructor - * - * @return void - */ - protected function __construct () { - // Call parent constructor - parent::__construct(__CLASS__); - } - - /** - * Creates an instance of this action - * - * @return $actionInstance An instance of this action class - */ - public final static function createWebLoginLogoutAction () { - // Get a new instance - $actionInstance = new WebLoginLogoutAction(); - - // Return the instance - return $actionInstance; - } - - /** - * Executes the command with given request and response objects - * - * @param $requestInstance An instance of a class with an Requestable interface - * @param $responseInstance An instance of a class with an Responseable interface - * @return void - */ - public function execute (Requestable $requestInstance, Responseable $responseInstance) { - // Shall we logout or display logout page or logout immediately? - if (($this->getConfigInstance()->readConfig('logout_immediate') === "Y") || ($requestInstance->isRequestElementSet('logout'))) { - // Get an auth instance for checking and updating the auth cookies - $authInstance = ObjectFactory::createObjectByConfiguredName('auth_method_class', array($responseInstance)); - - // Set request instance - $authInstance->setRequestInstance($requestInstance); - - // Destroy the auth data - $authInstance->destroyAuthData(); - - // Redirect to "logout done" page - $responseInstance->redirectToConfiguredUrl('logout_done_url'); - } // END - if - } - - /** - * Adds extra filters to the given controller instance - * - * @param $controllerInstance A controller instance - * @param $requestInstance An instance of a class with an Requestable interface - * @return void - */ - public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) { - // Empty for now - } -} - -// [EOF] -?> diff --git a/inc/classes/main/commands/web/class_WebLogoutCommand.php b/inc/classes/main/commands/web/class_WebLogoutCommand.php new file mode 100644 index 0000000..e220c51 --- /dev/null +++ b/inc/classes/main/commands/web/class_WebLogoutCommand.php @@ -0,0 +1,86 @@ + + * @version 0.0.0 + * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software + * @license GNU GPL 3.0 or any newer version + * @link http://www.ship-simu.org + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ +class WebLogoutCommand extends BaseCommand implements Commandable { + /** + * Protected constructor + * + * @return void + */ + protected function __construct () { + // Call parent constructor + parent::__construct(__CLASS__); + } + + /** + * Creates an instance of this class + * + * @param $resolverInstance An instance of a command resolver class + * @return $commandInstance An instance a prepared command class + */ + public final static function createWebLogoutCommand (CommandResolver $resolverInstance) { + // Get new instance + $commandInstance = new WebLogoutCommand(); + + // Set the application instance + $commandInstance->setResolverInstance($resolverInstance); + + // Return the prepared instance + return $commandInstance; + } + + /** + * Executes the given command with given request and response objects + * + * @param $requestInstance An instance of a class with an Requestable interface + * @param $responseInstance An instance of a class with an Responseable interface + * @return void + */ + public function execute (Requestable $requestInstance, Responseable $responseInstance) { + // Get an auth instance for checking and updating the auth cookies + $authInstance = ObjectFactory::createObjectByConfiguredName('auth_method_class', array($responseInstance)); + + // Set request instance + $authInstance->setRequestInstance($requestInstance); + + // Destroy the auth data + $authInstance->destroyAuthData(); + + // Redirect to "logout done" page + $responseInstance->redirectToConfiguredUrl('logout_done_url'); + } + + /** + * Adds extra filters to the given controller instance + * + * @param $controllerInstance A controller instance + * @param $requestInstance An instance of a class with an Requestable interface + * @return void + */ + public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) { + // Empty for now + } +} + +// [EOF] +?> diff --git a/inc/classes/main/controller/web/class_WebLogoutController.php b/inc/classes/main/controller/web/class_WebLogoutController.php new file mode 100644 index 0000000..00b020a --- /dev/null +++ b/inc/classes/main/controller/web/class_WebLogoutController.php @@ -0,0 +1,82 @@ + + * @version 0.0.0 + * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software + * @license GNU GPL 3.0 or any newer version + * @link http://www.ship-simu.org + * @todo This controller shall still provide some headlines for sidebars + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ +class WebLogoutController extends BaseController implements Controller { + /** + * Protected constructor + * + * @return void + */ + protected function __construct () { + // Call parent constructor + parent::__construct(__CLASS__); + } + + /** + * Creates an instance of this class + * + * @param $resolverInstance An instance of a command resolver class + * @return $controllerInstance A prepared instance of this class + */ + public final static function createWebLogoutController (CommandResolver $resolverInstance) { + // Create the instance + $controllerInstance = new WebLogoutController(); + + // Set the command resolver + $controllerInstance->setResolverInstance($resolverInstance); + + // Add user auth filter (we don't need an update of the user here because it will be redirected) + $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('user_auth_class')); + + // User status filter + $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('user_status_class')); + + // Return the prepared instance + return $controllerInstance; + } + + /** + * Handles the given request and response + * + * @param $requestInstance An instance of a request class + * @param $responseInstance An instance of a response class + * @return void + */ + public function handleRequest (Requestable $requestInstance, Responseable $responseInstance) { + // Get the command instance + $commandInstance = $this->getResolverInstance()->resolveCommandByRequest($requestInstance); + + // This request was valid! :-D + $requestInstance->requestIsValid(); + + // Execute the command + $commandInstance->execute($requestInstance, $responseInstance); + + // Flush the response out + $responseInstance->flushBuffer(); + } +} + +// [EOF] +?>