From: Roland Häder Date: Sun, 26 Aug 2012 15:05:32 +0000 (+0000) Subject: Added unfinished template engine to handle answer message on request-node-list message X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=f219ecbb5d0756b1a29c264e031fcb8f7ece6a2f;p=hub.git Added unfinished template engine to handle answer message on request-node-list message --- diff --git a/.gitattributes b/.gitattributes index 71c04f816..db223fb78 100644 --- a/.gitattributes +++ b/.gitattributes @@ -354,6 +354,7 @@ application/hub/main/handler/message-types/anouncement/.htaccess -text svneol=un application/hub/main/handler/message-types/anouncement/class_NodeMessageAnnouncementHandler.php svneol=native#text/plain application/hub/main/handler/message-types/answer/.htaccess -text svneol=unset#text/plain application/hub/main/handler/message-types/answer/class_NodeMessageAnnouncementAnswerHandler.php svneol=native#text/plain +application/hub/main/handler/message-types/answer/class_NodeMessageRequestNodeListAnswerHandler.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 diff --git a/application/hub/config.php b/application/hub/config.php index 8531bf96e..3da10f2a4 100644 --- a/application/hub/config.php +++ b/application/hub/config.php @@ -228,6 +228,9 @@ $cfg->setConfigEntry('message_type_self_connect_handler_class', 'NodeMessageSelf // CFG: MESSAGE-TYPE-REQUEST-NODE-LIST-HANDLER-CLASS $cfg->setConfigEntry('message_type_request_node_list_handler_class', 'NodeMessageRequestNodeListHandler'); +// CFG: MESSAGE-TYPE-REQUEST-NODE-LIST-ANSWER-HANDLER-CLASS +$cfg->setConfigEntry('message_type_request_node_list_answer_handler_class', 'NodeMessageRequestNodeListAnswerHandler'); + // CFG: NODE-ANSWER-MESSAGE-ANNOUNCEMENT-HELPER-CLASS $cfg->setConfigEntry('node_answer_message_announcement_helper_class', 'NodeAnnouncementMessageAnswerHelper'); diff --git a/application/hub/main/handler/message-types/answer/class_NodeMessageRequestNodeListAnswerHandler.php b/application/hub/main/handler/message-types/answer/class_NodeMessageRequestNodeListAnswerHandler.php new file mode 100644 index 000000000..a5605a557 --- /dev/null +++ b/application/hub/main/handler/message-types/answer/class_NodeMessageRequestNodeListAnswerHandler.php @@ -0,0 +1,149 @@ + + * @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 NodeMessageRequestNodeListAnswerHandler 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_answer'); + + // Init message data array + $this->messageDataElements = array( + XmlRequestNodeListAnswerTemplateEngine::REQUEST_DATA_SESSION_ID, + ); + + // Init message-data->configuration translation array + $this->messageToConfig = array( + /* + XmlRequestNodeListTemplateEngine::REQUEST_DATA_SESSION_ID => 'your_session_id' + */ + ); + + // Init config-copy array + $this->configCopy = array( + XmlRequestNodeListAnswerTemplateEngine::REQUEST_DATA_SESSION_ID => 'session_id', + ); + + // Init array + $this->searchData = array( + XmlRequestNodeListAnswerTemplateEngine::REQUEST_DATA_SESSION_ID, + ); + } + + /** + * Creates an instance of this class + * + * @return $handlerInstance An instance of a HandleableMessage class + */ + public final static function createNodeMessageRequestNodeListAnswerHandler () { + // Get new instance + $handlerInstance = new NodeMessageRequestNodeListAnswerHandler(); + + // 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 NoRequestNodeListAttemptedException If this node has not attempted to announce itself + */ + public function handleMessageData (array $messageData, Receivable $packageInstance) { + // Get node instance + $nodeInstance = Registry::getRegistry()->getInstance('node'); + + // Has this node attempted to announce itself? + if (!$nodeInstance->ifNodeHasAnnounced()) { + /* + * This node has never announced itself, so it doesn't expect + * request-node-list answer messages. + */ + throw new NoRequestNodeListAttemptedException(array($this, $nodeInstance, $messageData), self::EXCEPTION_ANNOUNCEMENT_NOT_ATTEMPTED); + } // END - if + + // Register the announcing node with this node + $this->registerNodeByMessageData($messageData); + + // Handle the answer status element + $nodeInstance->handleAnswerStatusByMessageData($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, but remove any 'my-' prefixes as they are not used in + * database layer. + */ + $dataSetInstance->addCriteria('node_' . str_replace('my-', '', $key), $messageData[$key]); + } // END - foreach + } + + /** + * Initializes configuration data from given message data array + * + * @param $messageData An array with all message data + * @return void + * @throws UnsupportedOperationException If this method is called + */ + protected function initMessageConfigurationData (array $messageData) { + // Please don't call this method + throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION); + } + + /** + * Removes configuration data with given message data array from global + * configuration + * + * @param $messageData An array with all message data + * @return void + * @throws UnsupportedOperationException If this method is called + */ + protected function removeMessageConfigurationData (array $messageData) { + // Please don't call this method + throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION); + } +} + +// [EOF] +?>