Updated 'core'.

[hub.git] / application / hub / main / handler / message-types / answer / class_NodeMessageAnnouncementAnswerHandler.php

diff --git a/application/hub/main/handler/message-types/answer/class_NodeMessageAnnouncementAnswerHandler.php b/application/hub/main/handler/message-types/answer/class_NodeMessageAnnouncementAnswerHandler.php
index 1ca0e411ec03d24f500c2ef18357a6c2efd6bef3..eab9f542f0c4ac29311fa5fa954ec0e227f10ba8 100644 (file)
--- a/application/hub/main/handler/message-types/answer/class_NodeMessageAnnouncementAnswerHandler.php
+++ b/application/hub/main/handler/message-types/answer/class_NodeMessageAnnouncementAnswerHandler.php
@@ -2,11 +2,11 @@
 /**
  * A NodeMessageAnnouncementAnswer handler
  *
- * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team
  * @license            GNU GPL 3.0 or any newer version
- * @link               http://www.ship-simu.org
+ * @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
@@ -32,14 +32,42 @@ class NodeMessageAnnouncementAnswerHandler extends BaseMessageHandler implements
                parent::__construct(__CLASS__);
 
                // Set handler name
-               $this->setHandlerName('message_announcement');
+               $this->setHandlerName('message_announcement_answer');
 
                // Init message data array
                $this->messageDataElements = array(
+                       XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_ADDRESS,
+                       XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_INTERNAL_ADDRESS,
+                       XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_NODE_STATUS,
+                       XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_NODE_ID,
+                       XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID,
+                       XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_PRIVATE_KEY_HASH,
+                       BaseXmlAnswerTemplateEngine::ANSWER_STATUS,
                );
 
                // Init message-data->configuration translation array
                $this->messageToConfig = array(
+               /*
+                       XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_ADDRESS => 'your_external_address',
+                       XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_INTERNAL_ADDRESS => 'your_internal_address',
+                       XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID       => 'your_session_id'
+                       XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_PRIVATE_KEY_HASH => 'your_private_key_hash'
+               */
+               );
+
+               // Init config-copy array
+               $this->configCopy = array(
+                       XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_ADDRESS   => 'external_address',
+                       XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_INTERNAL_ADDRESS   => 'internal_address',
+                       XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_NODE_STATUS        => 'node_status',
+                       XmlAnnouncementAnswerTemplateEngine::OAANNOUNCEMENT_DATA_SESSION_ID       => 'session_id',
+                       XmlAnnouncementAnswerTemplateEngine::OAANNOUNCEMENT_DATA_PRIVATE_KEY_HASH => 'private_key_hash',
+               );
+
+               // Init array
+               $this->searchData = array(
+                       XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID,
+                       XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_ADDRESS,
                );
        }
 
@@ -62,11 +90,26 @@ class NodeMessageAnnouncementAnswerHandler extends BaseMessageHandler implements
         * @param       $messageData            An array with message data to handle
         * @param       $packageInstance        An instance of a Receivable class
         * @return      void
+        * @throws      NoAnnouncementAttemptedException        If this node has not attempted to announce itself
         */
        public function handleMessageData (array $messageData, Receivable $packageInstance) {
-               die('messageData=' . print_r($messageData, true);
+               // Get node instance
+               $nodeInstance = NodeObjectFactory::createNodeInstance();
+
+               // Has this node attempted to announce itself?
+               if (!$nodeInstance->ifNodeIsAnnouncing()) {
+                       /*
+                        * This node has never announced itself, so it doesn't expect
+                        * announcement answer messages.
+                        */
+                       throw new NoAnnouncementAttemptedException(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);
        }
 
        /**
@@ -75,11 +118,22 @@ class NodeMessageAnnouncementAnswerHandler extends BaseMessageHandler implements
         * @param       $dataSetInstance        An instance of a StoreableCriteria class
         * @param       $messageData            An array with all message data
         * @return      void
-        * @throws      UnsupportedOperationException   If this method is called
         */
        public function addArrayToDataSet (StoreableCriteria $dataSetInstance, array $messageData) {
-               // Please don't call this method
-               throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
+               // Add generic first
+               parent::addArrayToDataSet($dataSetInstance, $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(str_replace('my-', '', $key), $messageData[$key]);
+               } // END - foreach
        }
 
        /**