3 * A NodeMessageDhtBootstrapAnswer handler
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 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 NodeMessageDhtBootstrapAnswerHandler 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_answer');
37 // Init message data array
38 $this->messageDataElements = array(
39 XmlDhtBootstrapAnswerTemplateEngine::DHT_BOOTSTRAP_DATA_EXTERNAL_IP,
40 XmlDhtBootstrapAnswerTemplateEngine::DHT_BOOTSTRAP_DATA_INTERNAL_IP,
41 XmlDhtBootstrapAnswerTemplateEngine::DHT_BOOTSTRAP_DATA_NODE_STATUS,
42 XmlDhtBootstrapAnswerTemplateEngine::DHT_BOOTSTRAP_DATA_SESSION_ID,
43 XmlDhtBootstrapAnswerTemplateEngine::DHT_BOOTSTRAP_DATA_LISTEN_PORT,
44 BaseXmlAnswerTemplateEngine::ANSWER_STATUS,
47 // Init message-data->configuration translation array
48 $this->messageToConfig = array(
50 XmlDhtBootstrapTemplateEngine::DHT_BOOTSTRAP_DATA_EXTERNAL_IP => 'your_external_ip',
51 XmlDhtBootstrapTemplateEngine::DHT_BOOTSTRAP_DATA_INTERNAL_IP => 'your_internal_ip',
52 XmlDhtBootstrapTemplateEngine::DHT_BOOTSTRAP_DATA_SESSION_ID => 'your_session_id'
56 // Init config-copy array
57 $this->configCopy = array(
58 XmlDhtBootstrapAnswerTemplateEngine::DHT_BOOTSTRAP_DATA_EXTERNAL_IP => 'external_ip',
59 XmlDhtBootstrapAnswerTemplateEngine::DHT_BOOTSTRAP_DATA_INTERNAL_IP => 'internal_ip',
60 XmlDhtBootstrapAnswerTemplateEngine::DHT_BOOTSTRAP_DATA_NODE_STATUS => 'node_status',
61 XmlDhtBootstrapAnswerTemplateEngine::DHT_BOOTSTRAP_DATA_SESSION_ID => 'session_id',
62 XmlDhtBootstrapAnswerTemplateEngine::DHT_BOOTSTRAP_DATA_LISTEN_PORT => 'node_listen_port',
66 $this->searchData = array(
67 XmlDhtBootstrapAnswerTemplateEngine::DHT_BOOTSTRAP_DATA_SESSION_ID,
68 XmlDhtBootstrapAnswerTemplateEngine::DHT_BOOTSTRAP_DATA_EXTERNAL_IP,
69 XmlDhtBootstrapAnswerTemplateEngine::DHT_BOOTSTRAP_DATA_LISTEN_PORT
74 * Creates an instance of this class
76 * @return $handlerInstance An instance of a HandleableMessage class
78 public final static function createNodeMessageDhtBootstrapAnswerHandler () {
80 $handlerInstance = new NodeMessageDhtBootstrapAnswerHandler();
82 // Return the prepared instance
83 return $handlerInstance;
87 * Handles data array of the message
89 * @param $messageData An array with message data to handle
90 * @param $packageInstance An instance of a Receivable class
92 * @throws NoDhtBootstrapAttemptedException If this DHT has not attempted to bootstrap
95 public function handleMessageData (array $messageData, Receivable $packageInstance) {
97 $dhtInstance = DhtObjectFactory::createDhtInstance('node');
99 // Has this DHT attempted to bootstrap?
100 if (!$dhtInstance->ifDhtIsBooting()) {
102 * This DHT has never bootstrapped, so it doesn't expect
103 * announcement answer messages.
105 throw new NoDhtBootstrapAttemptedException(array($this, $dhtInstance, $messageData), self::EXCEPTION_DHT_BOOTSTRAP_NOT_ATTEMPTED);
109 $this->partialStub('UNHANDLED: messageData=' . print_r($messageData, TRUE));
113 * Adds all required elements from given array into data set instance
115 * @param $dataSetInstance An instance of a StoreableCriteria class
116 * @param $messageData An array with all message data
119 public function addArrayToDataSet (StoreableCriteria $dataSetInstance, array $messageData) {
121 parent::addArrayToDataSet($dataSetInstance, $messageData);
124 foreach ($this->messageDataElements as $key) {
126 assert(isset($messageData[$key]));
129 * Add it, but remove any 'my-' prefixes as they are not used in
132 $dataSetInstance->addCriteria(str_replace('my-', '', $key), $messageData[$key]);
137 * Initializes configuration data from given message data array
139 * @param $messageData An array with all message data
141 * @throws UnsupportedOperationException If this method is called
143 protected function initMessageConfigurationData (array $messageData) {
144 // Please don't call this method
145 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
149 * Removes configuration data with given message data array from global
152 * @param $messageData An array with all message data
154 * @throws UnsupportedOperationException If this method is called
156 protected function removeMessageConfigurationData (array $messageData) {
157 // Please don't call this method
158 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);