From 4fa859bbc5461a586de9fa9b9ff970d5c7e8034b Mon Sep 17 00:00:00 2001 From: =?utf8?q?Roland=20H=C3=A4der?= Date: Sun, 19 Aug 2012 14:16:49 +0000 Subject: [PATCH] Added NodeMessageRequestNodeListHandler (unfinished) --- .gitattributes | 2 + application/hub/config.php | 3 + application/hub/main/class_BaseHubSystem.php | 1 + .../handler/message-types/requests/.htaccess | 1 + ...lass_NodeMessageRequestNodeListHandler.php | 103 ++++++++++++++++++ 5 files changed, 110 insertions(+) create mode 100644 application/hub/main/handler/message-types/requests/.htaccess create mode 100644 application/hub/main/handler/message-types/requests/class_NodeMessageRequestNodeListHandler.php diff --git a/.gitattributes b/.gitattributes index 2f44213fe..97469887c 100644 --- a/.gitattributes +++ b/.gitattributes @@ -328,6 +328,8 @@ application/hub/main/handler/message-types/answer/class_NodeMessageAnnouncementA application/hub/main/handler/message-types/class_ svneol=native#text/plain application/hub/main/handler/message-types/class_BaseMessageHandler.php svneol=native#text/plain application/hub/main/handler/message-types/class_NodeMessageAnnouncementHandler.php svneol=native#text/plain +application/hub/main/handler/message-types/requests/.htaccess -text svneol=unset#text/plain +application/hub/main/handler/message-types/requests/class_NodeMessageRequestNodeListHandler.php svneol=native#text/plain application/hub/main/handler/message-types/self-connect/.htaccess -text svneol=unset#text/plain application/hub/main/handler/message-types/self-connect/class_NodeMessageSelfConnectHandler.php svneol=native#text/plain application/hub/main/handler/network/.htaccess -text svneol=unset#text/plain diff --git a/application/hub/config.php b/application/hub/config.php index 992dbe9cf..cc60a169d 100644 --- a/application/hub/config.php +++ b/application/hub/config.php @@ -222,6 +222,9 @@ $cfg->setConfigEntry('message_type_announcement_answer_handler_class', 'NodeMess // CFG: MESSAGE-TYPE-SELF-CONNECT-HANDLER-CLASS $cfg->setConfigEntry('message_type_self_connect_handler_class', 'NodeMessageSelfConnectHandler'); +// CFG: MESSAGE-TYPE-REQUEST-NODE-LIST-HANDLER-CLASS +$cfg->setConfigEntry('message_type_request_node_list_handler_class', 'NodeMessageRequestNodeListHandler'); + // CFG: NODE-ANSWER-MESSAGE-ANNOUNCEMENT-HELPER-CLASS $cfg->setConfigEntry('node_answer_message_announcement_helper_class', 'NodeAnnouncementMessageAnswerHelper'); diff --git a/application/hub/main/class_BaseHubSystem.php b/application/hub/main/class_BaseHubSystem.php index d801735f5..b637cc339 100644 --- a/application/hub/main/class_BaseHubSystem.php +++ b/application/hub/main/class_BaseHubSystem.php @@ -30,6 +30,7 @@ class BaseHubSystem extends BaseFrameworkSystem { const EXCEPTION_ANNOUNCEMENT_NOT_ATTEMPTED = 0x904; const EXCEPTION_BASE64_ENCODING_NOT_MODULO_4 = 0x905; const EXCEPTION_NODE_SESSION_ID_NOT_VERIFYING = 0x906; + const EXCEPTION_REQUEST_NOT_ACCEPTED = 0x907; // Message status codes const MESSAGE_STATUS_CODE_OKAY = 'OKAY'; diff --git a/application/hub/main/handler/message-types/requests/.htaccess b/application/hub/main/handler/message-types/requests/.htaccess new file mode 100644 index 000000000..3a4288278 --- /dev/null +++ b/application/hub/main/handler/message-types/requests/.htaccess @@ -0,0 +1 @@ +Deny from all diff --git a/application/hub/main/handler/message-types/requests/class_NodeMessageRequestNodeListHandler.php b/application/hub/main/handler/message-types/requests/class_NodeMessageRequestNodeListHandler.php new file mode 100644 index 000000000..9110b6f67 --- /dev/null +++ b/application/hub/main/handler/message-types/requests/class_NodeMessageRequestNodeListHandler.php @@ -0,0 +1,103 @@ + + * @version 0.0.0 + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub Developer Team + * @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 NodeMessageRequestNodeListHandler extends BaseMessageHandler implements HandleableMessage, Registerable { + /** + * Protected constructor + * + * @return void + */ + protected function __construct () { + // Call parent constructor + parent::__construct(__CLASS__); + + // Set handler name + $this->setHandlerName('message_request_node_list'); + + // Init message data array + $this->messageDataElements = array( + ); + } + + /** + * Creates an instance of this class + * + * @return $handlerInstance An instance of a HandleableMessage class + */ + public final static function createNodeMessageRequestNodeListHandler () { + // Get new instance + $handlerInstance = new NodeMessageRequestNodeListHandler(); + + // Return the prepared instance + return $handlerInstance; + } + + /** + * Handles data array of the message + * + * @param $messageData An array with message data to handle + * @param $packageInstance An instance of a Receivable class + * @return void + * @throws RequestNotAcceptedException If this node does not accept this request + */ + public function handleMessageData (array $messageData, Receivable $packageInstance) { + // Get node instance + $nodeInstance = Registry::getRegistry()->getInstance('node'); + + // Is this node accepting announcements? + if (!$nodeInstance->isAcceptingNodeListRequests()) { + /* + * This node is not accepting node list requests. Throw an + * exception to abort any further processing. + */ + throw new RequestNotAcceptedException(array($this, $nodeInstance, $messageData), self::EXCEPTION_REQUEST_NOT_ACCEPTED); + } // END - if + + // Register the announcing node with this node + $this->registerNodeByMessageData($messageData); + + // Prepare answer message to be delivered back to the other node + $this->prepareAnswerMessage($messageData, $packageInstance); + } + + /** + * Adds all required elements from given array into data set instance + * + * @param $dataSetInstance An instance of a StoreableCriteria class + * @param $messageData An array with all message data + * @return void + */ + public function addArrayToDataSet (StoreableCriteria $dataSetInstance, array $messageData) { + // Add all ements + foreach ($this->messageDataElements as $key) { + // Is it there? + assert(isset($messageData[$key])); + + // Add it + $dataSetInstance->addCriteria('node_' . $key, $messageData[$key]); + } // END - foreach + } +} + +// [EOF] +?> -- 2.39.5