]> git.mxchange.org Git - hub.git/commitdiff
Added NodeMessageRequestNodeListHandler (unfinished)
authorRoland Häder <roland@mxchange.org>
Sun, 19 Aug 2012 14:16:49 +0000 (14:16 +0000)
committerRoland Häder <roland@mxchange.org>
Sun, 19 Aug 2012 14:16:49 +0000 (14:16 +0000)
.gitattributes
application/hub/config.php
application/hub/main/class_BaseHubSystem.php
application/hub/main/handler/message-types/requests/.htaccess [new file with mode: 0644]
application/hub/main/handler/message-types/requests/class_NodeMessageRequestNodeListHandler.php [new file with mode: 0644]

index 2f44213fe6219974702c2db926dfa0c85d4c28e7..97469887c23dbea092ea6cfa96e9e59ee0174478 100644 (file)
@@ -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
index 992dbe9cf81c443f77c80d7749b0cfb9be1ee0f8..cc60a169daf61cafaa069b8fe9cd3f9dfc954f3b 100644 (file)
@@ -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');
 
index d801735f562d2a83c33dd2c319f67dcb9a792b3a..b637cc3395cde93a8c65dd2d33bb1319ad0b1ddb 100644 (file)
@@ -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 (file)
index 0000000..3a42882
--- /dev/null
@@ -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 (file)
index 0000000..9110b6f
--- /dev/null
@@ -0,0 +1,103 @@
+<?php
+/**
+ * A NodeMessageRequestNodeList handler
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @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 <http://www.gnu.org/licenses/>.
+ */
+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]
+?>