]> git.mxchange.org Git - hub.git/blob - application/hub/main/handler/answer-status/announcement/class_AnnouncementAnswerOkayHandler.php
39e792ed2f5c190af77f3d270ffb3cca3d33bf22
[hub.git] / application / hub / main / handler / answer-status / announcement / class_AnnouncementAnswerOkayHandler.php
1 <?php
2 /**
3  * A AnnouncementAnswerOkay handler
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.ship-simu.org
10  *
11  * This program is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation, either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
23  */
24 class AnnouncementAnswerOkayHandler extends BaseAnserStatusHandler implements HandleableAnswerStatus, Registerable {
25         /**
26          * Protected constructor
27          *
28          * @return      void
29          */
30         protected function __construct () {
31                 // Call parent constructor
32                 parent::__construct(__CLASS__);
33
34                 // Set handler name
35                 $this->setHandlerName('announcement_answer_okay');
36         }
37
38         /**
39          * Creates an instance of this class
40          *
41          * @return      $handlerInstance        An instance of a HandleableMessage class
42          */
43         public final static function createAnnouncementAnswerOkayHandler () {
44                 // Get new instance
45                 $handlerInstance = new AnnouncementAnswerOkayHandler();
46
47                 // Return the prepared instance
48                 return $handlerInstance;
49         }
50
51         /**
52          * Handles given message data array
53          *
54          * @param       $messageData            An array of message data
55          * @param       $packageInstance        An instance of a Receivable class
56          * @return      void
57          * @throws      NodeSessionIdVerficationException       If the provided session id is not matching
58          * @todo        Do some more here: Handle karma, et cetera?
59          * @todo        Rewrite this to use DHT
60          */
61         public function handleAnswerMessageData (array $messageData, Receivable $packageInstance) {
62                 // Get a database wrapper instance
63                 $wrapperInstance = ObjectFactory::createObjectByConfiguredName('node_list_db_wrapper_class');
64
65                 // Get also a search criteria instance
66                 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
67
68                 // Lookup external session id/external IP/port
69                 $searchInstance->addCriteria('node_session_id' , $messageData[XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID]);
70                 $searchInstance->addCriteria('node_external_ip', $messageData[XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_IP]);
71                 $searchInstance->addCriteria('node_tcp_port'   , $messageData[XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_TCP_PORT]);
72
73                 // Only one entry is fine
74                 $searchInstance->setLimit(1);
75
76                 // Run the query
77                 $resultInstance = $wrapperInstance->doSelectByCriteria($searchInstance);
78
79                 // Is there an try?
80                 if (!$resultInstance->next()) {
81                         // This is fatal, caused by "stolen" session id and/or not matching IP number/port combination
82                         throw new NodeSessionIdVerficationException(array($this, $messageData), BaseHubSystem::EXCEPTION_NODE_SESSION_ID_NOT_VERIFYING);
83                 } // END - if
84
85                 // Get handler instance
86                 $handlerInstance = Registry::getRegistry()->getInstance('task_handler');
87
88                 // Generate DHT bootstrap task
89                 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_dht_bootstrap_task_class');
90
91                 // Register it as well
92                 $handlerInstance->registerTask('dht_bootstrap', $taskInstance);
93
94                 // Update node data (include status code)
95                 $wrapperInstance->updateNodeByMessageData($messageData, $this, $searchInstance);
96
97                 // Get the node instance
98                 $nodeInstance = Registry::getRegistry()->getInstance('node');
99
100                 // Change state
101                 $nodeInstance->getStateInstance()->nodeAnnouncementSuccessful();
102
103                 // Prepare next message
104                 $this->prepareNextMessage($messageData, $packageInstance);
105         }
106
107         /**
108          * Initializes configuration data from given message data array
109          *
110          * The following array is being handled over:
111          *
112          *   my-external-ip => 1.2.3.4
113          *   my-internal-ip => 5.6.7.8
114          *   my-status      => reachable
115          *   my-session-id  => aaabbbcccdddeeefff123456789
116          *   my-tcp-port    => 9060
117          *   my-udp-port    => 9060
118          *   answer-status  => OKAY
119          *   message_type   => announcement_answer
120          *
121          * @param       $messageData    An array with all message data
122          * @return      void
123          */
124         protected function initMessageConfigurationData (array $messageData) {
125                 // Get node instance
126                 $nodeInstance = Registry::getRegistry()->getInstance('node');
127
128                 // Get an array of all accepted object types
129                 $objectList = $nodeInstance->getListFromAcceptedObjectTypes();
130
131                 // Add missing (temporary) configuration 'accepted_object_types'
132                 $this->getConfigInstance()->setConfigEntry('accepted_object_types', implode(BaseHubNode::OBJECT_LIST_SEPARATOR, $objectList));
133         }
134
135         /**
136          * Removes configuration data with given message data array from global
137          * configuration. For content of $messageData see method comment above.
138          *
139          * @param       $messageData    An array with all message data
140          * @return      void
141          */
142         protected function removeMessageConfigurationData (array $messageData) {
143                 // Remove temporay configuration
144                 $this->getConfigInstance()->unsetConfigEntry('accepted_object_types');
145         }
146 }
147
148 // [EOF]
149 ?>