3 * A NodeMessageRequestNodeList handler
5 * @author Roland Haeder <webmaster@ship-simu.org>
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
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 NodeMessageRequestNodeListHandler extends BaseMessageHandler implements HandleableMessage, Registerable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
35 $this->setHandlerName('message_request_node_list');
37 // Init message data array
38 $this->messageDataElements = array(
39 XmlRequestNodeListTemplateEngine::REQUEST_DATA_ACCEPTED_OBJECT_TYPES,
42 // Init config-copy array
43 $this->configCopy = array(
46 // Init search data array
47 $this->searchData = array(
48 XmlRequestNodeListTemplateEngine::REQUEST_DATA_SESSION_ID,
53 * Creates an instance of this class
55 * @return $handlerInstance An instance of a HandleableMessage class
57 public final static function createNodeMessageRequestNodeListHandler () {
59 $handlerInstance = new NodeMessageRequestNodeListHandler();
61 // Return the prepared instance
62 return $handlerInstance;
66 * Handles data array of the message
68 * @param $messageData An array with message data to handle
69 * @param $packageInstance An instance of a Receivable class
71 * @throws RequestNotAcceptedException If this node does not accept this request
73 public function handleMessageData (array $messageData, Receivable $packageInstance) {
75 $nodeInstance = Registry::getRegistry()->getInstance('node');
77 // Is this node accepting announcements?
78 if (!$nodeInstance->isAcceptingNodeListRequests()) {
80 * This node is not accepting node list requests. Throw an
81 * exception to abort any further processing.
83 throw new RequestNotAcceptedException(array($this, $nodeInstance, $messageData), self::EXCEPTION_REQUEST_NOT_ACCEPTED);
86 // Register the announcing node with this node
87 $this->registerNodeByMessageData($messageData);
89 // Prepare answer message to be delivered back to the other node
90 $this->prepareAnswerMessage($messageData, $packageInstance);
94 * Adds all required elements from given array into data set instance
96 * @param $dataSetInstance An instance of a StoreableCriteria class
97 * @param $messageData An array with all message data
100 public function addArrayToDataSet (StoreableCriteria $dataSetInstance, array $messageData) {
102 parent::addArrayToDataSet($dataSetInstance, $messageData);
105 foreach ($this->messageDataElements as $key) {
107 assert(isset($messageData[$key]));
110 $dataSetInstance->addCriteria($key, $messageData[$key]);
115 * Initializes configuration data from given message data array
117 * @param $messageData An array with all message data
120 protected function initMessageConfigurationData (array $messageData) {
122 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(' REQUEST-HANDLER: messageData=' . print_r($messageData, true));
124 // "Walk" throught the config-copy array
125 foreach ($this->configCopy as $targetKey => $sourceKey) {
127 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('REQUEST-HANDLER: Copying from sourceKey=' . $sourceKey . ' to targetKey=' . $targetKey . '...');
129 // Copy from source to targetKey
130 $this->getConfigInstance()->setConfigEntry($targetKey, $this->getConfigInstance()->getConfigEntry($sourceKey));
133 // Query local DHT for nodes except given session id
134 $nodeList = $this->getDhtInstance()->queryLocalNodeListExceptByMessageData($messageData, $this, XmlRequestNodeListTemplateEngine::REQUEST_DATA_SESSION_ID, XmlRequestNodeListTemplateEngine::REQUEST_DATA_ACCEPTED_OBJECT_TYPES, BaseHubNode::OBJECT_LIST_SEPARATOR);
136 // Set it serialized in configuration (temporarily)
137 $this->getConfigInstance()->setConfigEntry('node_list', base64_encode(serialize($nodeList)));
139 // Translate last exception into a status code
140 $statusCode = $this->getTranslatedStatusFromLastException();
142 // Set it in configuration (temporarily)
143 $this->getConfigInstance()->setConfigEntry('answer_status', $statusCode);
147 * Removes configuration data with given message data array from global
150 * @param $messageData An array with all message data
153 protected function removeMessageConfigurationData (array $messageData) {
154 // "Walk" throught the config-copy array again
155 foreach ($this->configCopy as $configKey => $dummy) {
156 // Now unset this configuration entry (to save some memory again)
157 $this->getConfigInstance()->unsetConfigEntry($configKey);
160 // Remove answer status/node list as well
161 $this->getConfigInstance()->unsetConfigEntry('answer_status');
162 $this->getConfigInstance()->unsetConfigEntry('node_list');