3 * A NodeMessageAnnouncement handler
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.org
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.
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.
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/>.
24 class NodeMessageAnnouncementHandler extends BaseMessageHandler implements HandleableMessage, Registerable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
35 $this->setHandlerName('message_announcement');
37 // Init message data array
38 $this->messageDataElements = array(
39 XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_ADDRESS,
40 XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_INTERNAL_ADDRESS,
41 XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_NODE_STATUS,
42 XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_NODE_MODE,
43 XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID,
46 // Init message-data->configuration translation array
47 $this->messageToConfig = array(
48 XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_ADDRESS => 'your_external_address',
49 XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_INTERNAL_ADDRESS => 'your_internal_address',
50 XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID => 'your_session_id'
53 // Init config-copy array
54 $this->configCopy = array(
55 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_ADDRESS => 'external_address',
56 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_INTERNAL_ADDRESS => 'internal_address',
57 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_NODE_STATUS => 'node_status',
58 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID => 'session_id',
62 $this->searchData = array(
63 XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_ADDRESS
68 * Creates an instance of this class
70 * @return $handlerInstance An instance of a HandleableMessage class
72 public final static function createNodeMessageAnnouncementHandler () {
74 $handlerInstance = new NodeMessageAnnouncementHandler();
76 // Return the prepared instance
77 return $handlerInstance;
81 * Handles data array of the message
83 * @param $messageData An array with message data to handle
84 * @param $packageInstance An instance of a Receivable class
86 * @throws AnnouncementNotAcceptedException If this node does not accept announcements
88 public function handleMessageData (array $messageData, Receivable $packageInstance) {
90 $nodeInstance = NodeObjectFactory::createNodeInstance();
92 // Is this node accepting announcements?
93 if (!$nodeInstance->isAcceptingAnnouncements()) {
95 * This node is not accepting announcements, then someone wants to
96 * announce his node to a non-bootstrap and non-master node.
98 throw new AnnouncementNotAcceptedException(array($this, $nodeInstance, $messageData), BaseHubSystem::EXCEPTION_ANNOUNCEMENT_NOT_ACCEPTED);
101 // Register the announcing node with this node
102 $this->registerNodeByMessageData($messageData);
104 // Prepare answer message to be delivered back to the other node
105 $this->prepareAnswerMessage($messageData, $packageInstance);
109 * Adds all required elements from given array into data set instance
111 * @param $dataSetInstance An instance of a StoreableCriteria class
112 * @param $messageData An array with all message data
115 public function addArrayToDataSet (StoreableCriteria $dataSetInstance, array $messageData) {
117 parent::addArrayToDataSet($dataSetInstance, $messageData);
120 foreach ($this->messageDataElements as $key) {
122 assert(isset($messageData[$key]));
125 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('ANNOUNCEMENT-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: Adding messageData[' . $key . ']=' . $messageData[$key] . ' ...');
126 $dataSetInstance->addCriteria($key, $messageData[$key]);
131 * Initializes configuration data from given message data array
133 * @param $messageData An array with all message data
136 protected function initMessageConfigurationData (array $messageData) {
138 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('ANNOUNCEMENT-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: messageData=' . print_r($messageData, TRUE));
140 // "Walk" throught the translation array
141 foreach ($this->messageToConfig as $messageKey => $configKey) {
143 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('ANNOUNCEMENT-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: Setting messageKey=' . $messageKey . ',configKey=' . $configKey . ':' . $messageData[$messageKey]);
145 // Set the element in configuration
146 $this->getConfigInstance()->setConfigEntry($configKey, $messageData[$messageKey]);
149 // "Walk" throught the config-copy array
150 foreach ($this->configCopy as $targetKey => $sourceKey) {
152 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('ANNOUNCEMENT-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: Copying from sourceKey=' . $sourceKey . ' to targetKey=' . $targetKey . '...');
154 // Copy from source to targetKey
155 $this->getConfigInstance()->setConfigEntry($targetKey, $this->getConfigInstance()->getConfigEntry($sourceKey));
158 // Translate last exception into a status code
159 $statusCode = $this->getTranslatedStatusFromLastException();
161 // Set it in configuration (temporarily)
162 $this->getConfigInstance()->setConfigEntry(NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_ANSWER_STATUS, $statusCode);
166 * Removes configuration data with given message data array from global
169 * @param $messageData An array with all message data
172 protected function removeMessageConfigurationData (array $messageData) {
173 // "Walk" throught the translation array again
174 foreach ($this->messageToConfig as $dummy => $configKey) {
175 // Now unset this configuration entry (to save some memory)
176 $this->getConfigInstance()->unsetConfigEntry($configKey);
179 // "Walk" throught the config-copy array again
180 foreach ($this->configCopy as $configKey => $dummy) {
181 // Now unset this configuration entry (to save some memory again)
182 $this->getConfigInstance()->unsetConfigEntry($configKey);
185 // Remove NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_ANSWER_STATUS as well
186 $this->getConfigInstance()->unsetConfigEntry(NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_ANSWER_STATUS);