From 9332303b3db7ba79b79ed4bda9db33e4f0a98bb5 Mon Sep 17 00:00:00 2001
From: Roland Haeder <roland@mxchange.org>
Date: Sat, 18 Apr 2015 14:59:22 +0200
Subject: [PATCH] Added logout stuff.
Signed-off-by: Roland Haeder <roland@mxchange.org>
---
application/city/config.php | 6 +
.../html/class_HtmlCityLoginLogoutAction.php | 81 +++++++++++
.../html/class_CityHtmlLogoutCommand.php | 89 ++++++++++++
.../html/class_HtmlLogoutDoneCommand.php | 135 ++++++++++++++++++
.../html/class_CityHtmlLogoutController.php | 87 +++++++++++
.../class_CityHtmlLogoutDoneController.php | 72 ++++++++++
.../city/templates/de/code/logout_done.ctp | 19 +++
7 files changed, 489 insertions(+)
create mode 100644 application/city/main/actions/html/class_HtmlCityLoginLogoutAction.php
create mode 100644 application/city/main/commands/html/class_CityHtmlLogoutCommand.php
create mode 100644 application/city/main/commands/html/class_HtmlLogoutDoneCommand.php
create mode 100644 application/city/main/controller/html/class_CityHtmlLogoutController.php
create mode 100644 application/city/main/controller/html/class_CityHtmlLogoutDoneController.php
create mode 100644 application/city/templates/de/code/logout_done.ctp
diff --git a/application/city/config.php b/application/city/config.php
index c1fd59a..fba3046 100644
--- a/application/city/config.php
+++ b/application/city/config.php
@@ -77,6 +77,9 @@ $cfg->setConfigEntry('city_html_cmd_login_resolver_class', 'CityHtmlCommandResol
// CFG: CITY-HTML-CMD-LOGIN-FAILED-RESOLVER-CLASS
$cfg->setConfigEntry('city_html_cmd_login_failed_resolver_class', 'CityHtmlCommandResolver');
+// CFG: CITY-HTML-CMD-LOGOUT-DONE-RESOLVER-CLASS
+$cfg->setConfigEntry('city_html_cmd_logout_done_resolver_class', 'HtmlCommandResolver');
+
// CFG: NEWS-READER-HOME-CLASS
$cfg->setConfigEntry('news_reader_home_class', 'DefaultNewsReader');
@@ -98,6 +101,9 @@ $cfg->setConfigEntry('news_reader_login_area_city_map_class', 'DefaultNewsReader
// CFG: NEWS-READER-LOGIN-AREA-GOVERNMENT-CLASS
$cfg->setConfigEntry('news_reader_login_area_government_class', 'DefaultNewsReader');
+// CFG: NEWS-READER-LOGIN-AREA-LOGOUT-CLASS
+$cfg->setConfigEntry('news_reader_login_area_logout_class', 'DefaultNewsReader');
+
// CFG: NEWS-HOME-LIMIT
$cfg->setConfigEntry('news_home_limit', 10);
diff --git a/application/city/main/actions/html/class_HtmlCityLoginLogoutAction.php b/application/city/main/actions/html/class_HtmlCityLoginLogoutAction.php
new file mode 100644
index 0000000..e56aa1c
--- /dev/null
+++ b/application/city/main/actions/html/class_HtmlCityLoginLogoutAction.php
@@ -0,0 +1,81 @@
+<?php
+/**
+ * An action for logout
+ *
+ * @author Roland Haeder <webmaster@shipsimu.org>
+ * @version 0.0.0
+ * @copyright Copyright (c) 2015 City Developer Team
+ * @license GNU GPL 3.0 or any newer version
+ * @link http://www.shipsimu.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 <http://www.gnu.org/licenses/>.
+ */
+class HtmlCityLoginLogoutAction extends BaseCityAction implements Commandable, Registerable {
+ /**
+ * Protected constructor
+ *
+ * @return void
+ */
+ protected function __construct () {
+ // Call parent constructor
+ parent::__construct(__CLASS__);
+ }
+
+ /**
+ * Creates an instance of this action
+ *
+ * @param $resolverInstance An instance of an action resolver
+ * @return $actionInstance An instance of this action class
+ */
+ public static final function createHtmlCityLoginLogoutAction (ActionResolver $resolverInstance) {
+ // Get a new instance
+ $actionInstance = new HtmlCityLoginLogoutAction();
+
+ // Set the resolver instance
+ $actionInstance->setResolverInstance($resolverInstance);
+
+ // 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
+ * @todo 0% done
+ */
+ public function execute (Requestable $requestInstance, Responseable $responseInstance) {
+ // Call parent execute method
+ parent::execute($requestInstance, $responseInstance);
+
+ // Add your code here
+ }
+
+ /**
+ * 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) {
+ // Check for user status by default
+ $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('user_status_filter'));
+ }
+}
+
+// [EOF]
+?>
diff --git a/application/city/main/commands/html/class_CityHtmlLogoutCommand.php b/application/city/main/commands/html/class_CityHtmlLogoutCommand.php
new file mode 100644
index 0000000..38986dd
--- /dev/null
+++ b/application/city/main/commands/html/class_CityHtmlLogoutCommand.php
@@ -0,0 +1,89 @@
+<?php
+/**
+ * A command for logout
+ *
+ * @author Roland Haeder <webmaster@shipsimu.org>
+ * @version 0.0.0
+ * @copyright Copyright (c) 2015 City Developer Team
+ * @license GNU GPL 3.0 or any newer version
+ * @link http://www.shipsimu.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 <http://www.gnu.org/licenses/>.
+ */
+class CityHtmlLogoutCommand 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 static final function createCityHtmlLogoutCommand (CommandResolver $resolverInstance) {
+ // Get new instance
+ $commandInstance = new CityHtmlLogoutCommand();
+
+ // 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');
+
+ // Exit here
+ exit();
+ }
+
+ /**
+ * 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/application/city/main/commands/html/class_HtmlLogoutDoneCommand.php b/application/city/main/commands/html/class_HtmlLogoutDoneCommand.php
new file mode 100644
index 0000000..b02ab92
--- /dev/null
+++ b/application/city/main/commands/html/class_HtmlLogoutDoneCommand.php
@@ -0,0 +1,135 @@
+<?php
+/**
+ * A command for the login failed page
+ *
+ * @author Roland Haeder <webmaster@shipsimu.org>
+ * @version 0.0.0
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
+ * @license GNU GPL 3.0 or any newer version
+ * @link http://www.shipsimu.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 <http://www.gnu.org/licenses/>.
+ */
+class HtmlLogoutDoneCommand 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 static final function createHtmlLogoutDoneCommand (CommandResolver $resolverInstance) {
+ // Get new instance
+ $commandInstance = new HtmlLogoutDoneCommand();
+
+ // 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 the application instance
+ $applicationInstance = $this->getResolverInstance()->getApplicationInstance();
+
+ // Prepare a template instance
+ $templateInstance = $this->prepareTemplateInstance($applicationInstance);
+
+ // Assign application data
+ $templateInstance->assignApplicationData($applicationInstance);
+
+ // Load the master template
+ $masterTemplate = $applicationInstance->buildMasterTemplateName();
+
+ // Load header template
+ $templateInstance->loadCodeTemplate('header');
+
+ // Compile and assign it with a variable
+ $templateInstance->compileTemplate();
+ $templateInstance->assignTemplateWithVariable('header', 'header');
+
+ // Load footer template
+ $templateInstance->loadCodeTemplate('footer');
+
+ // Compile and assign it with a variable
+ $templateInstance->compileTemplate();
+ $templateInstance->assignTemplateWithVariable('footer', 'footer');
+
+ // Load the logout_done template
+ $templateInstance->loadCodeTemplate('logout_done');
+
+ // Assign the logout_done template with the master template as a content ... ;)
+ $templateInstance->assignTemplateWithVariable('logout_done', 'main_content');
+
+ // Load the master template
+ $templateInstance->loadCodeTemplate($masterTemplate);
+
+ // Set title
+ $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('logout_done_title'));
+
+ // Assign base URL
+ $templateInstance->assignConfigVariable('base_url');
+
+ // Construct the menu in every command. We could do this in BaseCommand class. But this means
+ // *every* command has a navigation system and that is want we don't want.
+ $menuInstance = ObjectFactory::createObjectByConfiguredName('logout_menu_class', array($applicationInstance));
+
+ // Render the menu
+ $menuInstance->renderMenu();
+
+ // Transfer it to the template engine instance
+ $menuInstance->transferContentToTemplateEngine($templateInstance);
+
+ /*
+ * ... and all variables. This should be merged together in a pattern
+ * to make things easier. A cache mechanism should be added between
+ * these two calls to cache compiled templates.
+ */
+ $templateInstance->compileVariables();
+
+ // Get the content back from the template engine and put it in response class
+ $templateInstance->transferToResponse($responseInstance);
+ }
+
+ /**
+ * 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/application/city/main/controller/html/class_CityHtmlLogoutController.php b/application/city/main/controller/html/class_CityHtmlLogoutController.php
new file mode 100644
index 0000000..4bed8dc
--- /dev/null
+++ b/application/city/main/controller/html/class_CityHtmlLogoutController.php
@@ -0,0 +1,87 @@
+<?php
+/**
+ * The default controller for logout page
+ *
+ * @author Roland Haeder <webmaster@shipsimu.org>
+ * @version 0.0.0
+ * @copyright Copyright (c) 2015 City Developer Team
+ * @license GNU GPL 3.0 or any newer version
+ * @link http://www.shipsimu.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 <http://www.gnu.org/licenses/>.
+ */
+class CityHtmlLogoutController extends BaseController implements Controller {
+ /**
+ * Protected constructor
+ *
+ * @return void
+ */
+ protected function __construct () {
+ // Call parent constructor
+ parent::__construct(__CLASS__);
+
+ // Init additional filter chains
+ foreach (array('shutdown') as $filterChain) {
+ $this->initFilterChain($filterChain);
+ } // END - foreach
+ }
+
+ /**
+ * Creates an instance of this class
+ *
+ * @param $resolverInstance An instance of a command resolver class
+ * @return $controllerInstance A prepared instance of this class
+ */
+ public static final function createCityHtmlLogoutController (CommandResolver $resolverInstance) {
+ // Create the instance
+ $controllerInstance = new CityHtmlLogoutController();
+
+ // 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_filter'));
+
+ // User status filter
+ $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('user_status_filter'));
+
+ // 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]
+?>
diff --git a/application/city/main/controller/html/class_CityHtmlLogoutDoneController.php b/application/city/main/controller/html/class_CityHtmlLogoutDoneController.php
new file mode 100644
index 0000000..dc311c5
--- /dev/null
+++ b/application/city/main/controller/html/class_CityHtmlLogoutDoneController.php
@@ -0,0 +1,72 @@
+<?php
+/**
+ * Controller for logout done page
+ *
+ * @author Roland Haeder <webmaster@shipsimu.org>
+ * @version 0.0.0
+ * @copyright Copyright (c) 2015 City Developer Team
+ * @license GNU GPL 3.0 or any newer version
+ * @link http://www.shipsimu.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 <http://www.gnu.org/licenses/>.
+ */
+class CityHtmlLogoutDoneController extends BaseController implements Controller {
+ /**
+ * Protected constructor
+ *
+ * @return void
+ */
+ protected function __construct () {
+ // Call parent constructor
+ parent::__construct(__CLASS__);
+
+ // Init additional filter chains
+ foreach (array('shutdown') as $filterChain) {
+ $this->initFilterChain($filterChain);
+ } // END - foreach
+ }
+
+ /**
+ * Creates an instance of this class
+ *
+ * @param $resolverInstance An instance of a command resolver class
+ * @return $controllerInstance A prepared instance of this class
+ * @todo Add some filters to this controller
+ */
+ public static final function createCityHtmlLogoutDoneController (CommandResolver $resolverInstance) {
+ // Create the instance
+ $controllerInstance = new CityHtmlLogoutDoneController();
+
+ // Set the command resolver
+ $controllerInstance->setResolverInstance($resolverInstance);
+
+ // 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) {
+ // Generic pre-post command execution
+ $this->executeGenericPrePostCommand($requestInstance, $responseInstance);
+ }
+}
+
+// [EOF]
+?>
diff --git a/application/city/templates/de/code/logout_done.ctp b/application/city/templates/de/code/logout_done.ctp
new file mode 100644
index 0000000..59c8cbc
--- /dev/null
+++ b/application/city/templates/de/code/logout_done.ctp
@@ -0,0 +1,19 @@
+<?php
+// Get helper instance
+$helperInstance = ObjectFactory::createObjectByConfiguredName('html_link_helper_class', array($this, 'relogin'));
+
+// Set link text
+$helperInstance->addLinkWithTextById('relogin');
+
+// Flush the content
+$helperInstance->flushContent();
+
+// [EOC]
+?>
+<div id="content_header">
+ Du bist jetzt aus dem Spiel ausgeloggt!
+</div>
+
+<div id="content_body">
+ Du kannst dich nun {?relogin?} oder weiter auf unseren Seiten bleiben. ;-)
+</div>
--
2.39.5