From ab826e7e2ef101ca11120b1d3869a51cfd1295e9 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Roland=20H=C3=A4der?= Date: Thu, 17 May 2012 19:05:31 +0000 Subject: [PATCH] Added class for handling self-connect messages --- .gitattributes | 3 + application/hub/config.php | 3 + .../class_NodeMessageAnnouncementHandler.php | 5 - .../hub/main/handler/message-types/class_ | 95 +++++++++++++++++++ .../class_BaseMessageHandler.php | 5 + .../message-types/self-connect/.htaccess | 1 + .../class_NodeMessageSelfConnectHandler.php | 92 ++++++++++++++++++ 7 files changed, 199 insertions(+), 5 deletions(-) create mode 100644 application/hub/main/handler/message-types/class_ create mode 100644 application/hub/main/handler/message-types/self-connect/.htaccess create mode 100644 application/hub/main/handler/message-types/self-connect/class_NodeMessageSelfConnectHandler.php diff --git a/.gitattributes b/.gitattributes index bddcba8fc..8c66ae552 100644 --- a/.gitattributes +++ b/.gitattributes @@ -297,8 +297,11 @@ application/hub/main/handler/class_BaseHandler.php svneol=native#text/plain application/hub/main/handler/message-types/.htaccess -text svneol=unset#text/plain application/hub/main/handler/message-types/anouncement/.htaccess -text svneol=unset#text/plain application/hub/main/handler/message-types/anouncement/class_NodeMessageAnnouncementHandler.php svneol=native#text/plain +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/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 application/hub/main/handler/network/class_ svneol=native#text/plain application/hub/main/handler/network/class_BaseRawDataHandler.php svneol=native#text/plain diff --git a/application/hub/config.php b/application/hub/config.php index 0b9c156bc..7bec78aa8 100644 --- a/application/hub/config.php +++ b/application/hub/config.php @@ -207,6 +207,9 @@ $cfg->setConfigEntry('package_tag_self_connect_filter', 'PackageSelfConnectTagFi // CFG: MESSAGE-TYPE-ANNOUNCEMENT-HANDLER-CLASS $cfg->setConfigEntry('message_type_announcement_handler_class', 'NodeMessageAnnouncementHandler'); +// CFG: MESSAGE-TYPE-SELF-CONNECT-HANDLER-CLASS +$cfg->setConfigEntry('message_type_self_connect_handler_class', 'NodeMessageSelfConnectHandler'); + // CFG: NEWS-READER-CLASS $cfg->setConfigEntry('news_reader_class', 'ConsoleNewsReader'); diff --git a/application/hub/main/handler/message-types/anouncement/class_NodeMessageAnnouncementHandler.php b/application/hub/main/handler/message-types/anouncement/class_NodeMessageAnnouncementHandler.php index 0f18ea1f3..8b4195a95 100644 --- a/application/hub/main/handler/message-types/anouncement/class_NodeMessageAnnouncementHandler.php +++ b/application/hub/main/handler/message-types/anouncement/class_NodeMessageAnnouncementHandler.php @@ -22,11 +22,6 @@ * along with this program. If not, see . */ class NodeMessageAnnouncementHandler extends BaseMessageHandler implements HandleableMessage, Registerable { - /** - * Array with all data XML nodes (which hold the actual data) and their values - */ - private $messageDataElements = array(); - /** * Protected constructor * diff --git a/application/hub/main/handler/message-types/class_ b/application/hub/main/handler/message-types/class_ new file mode 100644 index 000000000..47794405d --- /dev/null +++ b/application/hub/main/handler/message-types/class_ @@ -0,0 +1,95 @@ + + * @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 NodeMessage???Handler extends BaseMessageHandler implements HandleableMessage, Registerable { + /** + * Protected constructor + * + * @return void + */ + protected function __construct () { + // Call parent constructor + parent::__construct(__CLASS__); + + // Set handler name + $this->setHandlerName('message_type_==='); + + // Init message data array + $this->messageDataElements = array( + Xml???TemplateEngine::!!!_DATA_EXTERNAL_IP, + Xml???TemplateEngine::!!!_DATA_NODE_STATUS, + Xml???TemplateEngine::!!!_DATA_SESSION_ID, + Xml???TemplateEngine::!!!_DATA_TCP_PORT, + Xml???TemplateEngine::!!!_DATA_UDP_PORT + ); + } + + /** + * Creates an instance of this class + * + * @return $handlerInstance An instance of a HandleableMessage class + */ + public final static function createNodeMessage???Handler () { + // Get new instance + $handlerInstance = new NodeMessage???Handler(); + + // 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 + */ + public function handleMessageData (array $messageData, Receivable $packageInstance) { + // 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] +?> diff --git a/application/hub/main/handler/message-types/class_BaseMessageHandler.php b/application/hub/main/handler/message-types/class_BaseMessageHandler.php index b918dc1dd..7b6763eee 100644 --- a/application/hub/main/handler/message-types/class_BaseMessageHandler.php +++ b/application/hub/main/handler/message-types/class_BaseMessageHandler.php @@ -27,6 +27,11 @@ class BaseMessageHandler extends BaseHandler { */ private $searchData = array(); + /** + * Array with all data XML nodes (which hold the actual data) and their values + */ + protected $messageDataElements = array(); + /** * Protected constructor * diff --git a/application/hub/main/handler/message-types/self-connect/.htaccess b/application/hub/main/handler/message-types/self-connect/.htaccess new file mode 100644 index 000000000..3a4288278 --- /dev/null +++ b/application/hub/main/handler/message-types/self-connect/.htaccess @@ -0,0 +1 @@ +Deny from all diff --git a/application/hub/main/handler/message-types/self-connect/class_NodeMessageSelfConnectHandler.php b/application/hub/main/handler/message-types/self-connect/class_NodeMessageSelfConnectHandler.php new file mode 100644 index 000000000..f14efd96e --- /dev/null +++ b/application/hub/main/handler/message-types/self-connect/class_NodeMessageSelfConnectHandler.php @@ -0,0 +1,92 @@ + + * @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 NodeMessageSelfConnectHandler extends BaseMessageHandler implements HandleableMessage, Registerable { + /** + * Protected constructor + * + * @return void + */ + protected function __construct () { + // Call parent constructor + parent::__construct(__CLASS__); + + // Set handler name + $this->setHandlerName('message_type_self_connect'); + + // Init message data array + $this->messageDataElements = array( + XmlSelfConnectTemplateEngine::SELF_CONNECT_DATA_NODE_ID, + XmlSelfConnectTemplateEngine::SELF_CONNECT_DATA_SESSION_ID + ); + } + + /** + * Creates an instance of this class + * + * @return $handlerInstance An instance of a HandleableMessage class + */ + public final static function createNodeMessageSelfConnectHandler () { + // Get new instance + $handlerInstance = new NodeMessageSelfConnectHandler(); + + // 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 + */ + public function handleMessageData (array $messageData, Receivable $packageInstance) { + // 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