3 * A general hub node class
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 BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
28 const NODE_TYPE_BOOT = 'boot';
29 const NODE_TYPE_MASTER = 'master';
30 const NODE_TYPE_LIST = 'list';
31 const NODE_TYPE_REGULAR = 'regular';
33 // Exception constants
34 const EXCEPTION_HUB_ALREADY_ANNOUNCED = 0xe00;
37 const OBJECT_LIST_SEPARATOR = ',';
40 * IP/port number of bootstrapping node
42 private $bootIpPort = '';
45 * Query connector instance
47 private $queryConnectorInstance = NULL;
50 * Queue connector instance
52 private $queueConnectorInstance = NULL;
55 * Whether this node is anncounced (KEEP ON false!)
58 private $hubIsAnnounced = false;
61 * Whether this hub is active (default: false)
63 private $isActive = false;
66 * Whether this node accepts announcements (default: false)
68 private $acceptAnnouncements = false;
71 * Protected constructor
73 * @param $className Name of the class
76 protected function __construct ($className) {
77 // Call parent constructor
78 parent::__construct($className);
80 // Get a wrapper instance
81 $wrapperInstance = DatabaseWrapperFactory::createWrapperByConfiguredName('node_info_db_wrapper_class');
84 $this->setWrapperInstance($wrapperInstance);
86 // Get a crypto instance
87 $cryptoInstance = ObjectFactory::createObjectByConfiguredName('crypto_class');
90 $this->setCryptoInstance($cryptoInstance);
92 // Init state which sets the state to 'init'
97 * Initializes the node's state which sets it to 'init'
101 private function initState() {
103 * Get the state factory and create the initial state, we don't need
104 * the state instance here
106 NodeStateFactory::createNodeStateInstanceByName('init', $this);
110 * Generates a random string from various data inluding UUID if PECL
111 * extension uuid is installed.
113 * @param $length Length of the random part
114 * @return $randomString Random string
115 * @todo Make this code more generic and move it to CryptoHelper or
117 protected function generateRamdomString ($length) {
118 // Get an RNG instance
119 $rngInstance = ObjectFactory::createObjectByConfiguredName('rng_class');
121 // Generate a pseudo-random string
122 $randomString = $rngInstance->randomString($length) . ':' . $this->getBootIpPort() . ':' . $this->getRequestInstance()->getRequestElement('mode');
124 // Add UUID for even more entropy for the hasher
125 $randomString .= $this->getCryptoInstance()->createUuid();
128 return $randomString;
132 * Generates a private key and hashes it (for speeding up things)
134 * @param $searchInstance An instance of a LocalSearchCriteria class
137 private function generatePrivateKeyAndHash (LocalSearchCriteria $searchInstance) {
138 // Generate a pseudo-random string
139 $randomString = $this->generateRandomString(255);
141 // Hash and encrypt the string so we become a node id (also documented as "hub id")
142 $this->setPrivateKey($this->getCryptoInstance()->encryptString($randomString));
143 $this->setPrivateKeyHash($this->getCryptoInstance()->hashString($this->getPrivateKey()));
145 // Register the node id with our wrapper
146 $this->getWrapperInstance()->registerPrivateKey($this, $this->getRequestInstance(), $searchInstance);
149 self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Created new private key with hash: ' . $this->getPrivateKeyHash() . '');
153 * Setter for query instance
155 * @param $connectorInstance Our new query instance
158 private final function setQueryConnectorInstance (Connectable $connectorInstance) {
159 $this->queryConnectorInstance = $connectorInstance;
163 * Getter for query instance
165 * @return $connectorInstance Our new query instance
167 public final function getQueryConnectorInstance () {
168 return $this->queryConnectorInstance;
172 * Setter for queue instance
174 * @param $connectorInstance Our new queue instance
177 private final function setQueueConnectorInstance (Connectable $connectorInstance) {
178 $this->queueConnectorInstance = $connectorInstance;
182 * Getter for queue instance
184 * @return $connectorInstance Our new queue instance
186 public final function getQueueConnectorInstance () {
187 return $this->queueConnectorInstance;
191 * Getter for boot IP/port combination
193 * @return $bootIpPort The IP/port combination of the boot node
195 protected final function getBootIpPort () {
196 return $this->bootIpPort;
200 * Checks whether the given IP address matches one of the bootstrapping nodes
202 * @param $remoteAddr IP address to checkout against our bootstrapping list
203 * @return $isFound Whether the IP is found
205 protected function ifAddressMatchesBootstrappingNodes ($remoteAddr) {
206 // By default nothing is found
209 // Run through all configured IPs
210 foreach (explode(BaseHubSystem::BOOTSTRAP_NODES_SEPARATOR, $this->getConfigInstance()->getConfigEntry('hub_bootstrap_nodes')) as $ipPort) {
211 // Split it up in IP/port
212 $ipPortArray = explode(':', $ipPort);
215 if ($ipPortArray[0] == $remoteAddr) {
219 // Remember the port number
220 $this->bootIpPort = $ipPort;
223 self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: ' . __FUNCTION__ . '[' . __LINE__ . ']: IP matches remote address ' . $ipPort . '.');
225 // Stop further searching
227 } elseif ($ipPortArray[0] == $this->getConfigInstance()->getConfigEntry('node_listen_addr')) {
229 * IP matches listen address. At this point we really don't care
230 * if we can really listen on that address
234 // Remember the port number
235 $this->bootIpPort = $ipPort;
238 self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: ' . __FUNCTION__ . '[' . __LINE__ . ']: IP matches listen address ' . $ipPort . '.');
240 // Stop further searching
250 * Outputs the console teaser. This should only be executed on startup or
251 * full restarts. This method generates some space around the teaser.
255 public function outputConsoleTeaser () {
256 // Get the app instance (for shortening our code)
257 $app = $this->getApplicationInstance();
260 self::createDebugInstance(__CLASS__)->debugOutput(' ');
261 self::createDebugInstance(__CLASS__)->debugOutput($app->getAppName() . ' v' . $app->getAppVersion() . ' - ' . $this->getRequestInstance()->getRequestElement('mode') . ' mode active');
262 self::createDebugInstance(__CLASS__)->debugOutput('Copyright (c) 2007 - 2008 Roland Haeder, 2009 - 2012 Hub Developer Team');
263 self::createDebugInstance(__CLASS__)->debugOutput(' ');
264 self::createDebugInstance(__CLASS__)->debugOutput('This program comes with ABSOLUTELY NO WARRANTY; for details see docs/COPYING.');
265 self::createDebugInstance(__CLASS__)->debugOutput('This is free software, and you are welcome to redistribute it under certain');
266 self::createDebugInstance(__CLASS__)->debugOutput('conditions; see docs/COPYING for details.');
267 self::createDebugInstance(__CLASS__)->debugOutput(' ');
271 * Generic method to acquire a hub-id. On first run this generates a new one
272 * based on many pseudo-random data. On any later run, unless the id
273 * got not removed from database, it will be restored from the database.
275 * @param $requestInstance A Requestable class
276 * @param $responseInstance A Responseable class
279 public function bootstrapAcquireNodeId (Requestable $requestInstance, Responseable $responseInstance) {
280 // Is there a node id?
281 if ($this->getWrapperInstance()->ifNodeDataIsFound($this)) {
282 // Get the node id from result and set it
283 $this->setNodeId($this->getField(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_ID));
286 self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Re-using found node-id: ' . $this->getNodeId() . '');
288 // Generate a pseudo-random string
289 $randomString = $this->generateRandomString(255);
291 // Hash and encrypt the string so we become a node id (also documented as "hub id")
292 $this->setNodeId($this->getCryptoInstance()->hashString($this->getCryptoInstance()->encryptString($randomString)));
294 // Register the node id with our wrapper
295 $this->getWrapperInstance()->registerNodeId($this, $this->getRequestInstance());
298 self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Created new node-id: ' . $this->getNodeId() . '');
303 * Generates a session id which will be sent to the other hubs and peers
307 public function bootstrapGenerateSessionId () {
308 // Now get a search criteria instance
309 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
311 // Search for the node number one which is hard-coded the default
312 $searchInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_NR, 1);
313 $searchInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_TYPE, $this->getRequestInstance()->getRequestElement('mode'));
314 $searchInstance->setLimit(1);
316 // Get a random string
317 $randomString = $this->generateRamdomString(255);
319 // Hash and encrypt the string so we become a "node id" aka Hub-Id
320 $this->setSessionId($this->getCryptoInstance()->hashString($this->getCryptoInstance()->encryptString($randomString)));
322 // Register the node id with our wrapper
323 $this->getWrapperInstance()->registerSessionId($this, $this->getRequestInstance(), $searchInstance);
326 self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Created new session-id: ' . $this->getSessionId() . '');
328 // Change the state because the node has auired a hub id
329 $this->getStateInstance()->nodeGeneratedSessionId();
333 * Generate a private key for en-/decryption
337 public function bootstrapGeneratePrivateKey () {
339 if ($this->getWrapperInstance()->ifNodeDataIsFound($this)) {
340 // Is the element set?
341 if (is_null($this->getField(NodeInformationDatabaseWrapper::DB_COLUMN_PRIVATE_KEY))) {
343 * Auto-generate the private key for e.g. out-dated database
344 * "tables". This allows a smooth update for the underlaying
347 $this->generatePrivateKeyAndHash($searchInstance);
349 // Get the node id from result and set it
350 $this->setPrivateKey(base64_decode($this->getField(NodeInformationDatabaseWrapper::DB_COLUMN_PRIVATE_KEY)));
351 $this->setPrivateKeyHash($this->getField(NodeInformationDatabaseWrapper::DB_COLUMN_PRIVATE_KEY_HASH));
354 self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Re-using found private key hash: ' . $this->getPrivateKeyHash() . '');
358 * Generate it in a private method (no confusion with 'private
359 * method access' and 'private key' here! ;-)).
361 $this->generatePrivateKeyAndHash($searchInstance);
366 * Adds hub data elements to a given dataset instance
368 * @param $criteriaInstance An instance of a storeable criteria
369 * @param $requestInstance An instance of a Requestable class
372 public function addElementsToDataSet (StoreableCriteria $criteriaInstance, Requestable $requestInstance = NULL) {
373 // Add node number and type
374 $criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_NR, 1);
375 $criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_TYPE, $requestInstance->getRequestElement('mode'));
378 $criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_ID, $this->getNodeId());
380 // Add the session id if acquired
381 if ($this->getSessionId() != '') {
382 $criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_SESSION_ID, $this->getSessionId());
385 // Add the private key if acquired
386 if ($this->getPrivateKey() != '') {
387 $criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_PRIVATE_KEY, base64_encode($this->getPrivateKey()));
388 $criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_PRIVATE_KEY_HASH, $this->getPrivateKeyHash());
393 * Updates a given field with new value
395 * @param $fieldName Field to update
396 * @param $fieldValue New value to store
398 * @throws DatabaseUpdateSupportException If this class does not support database updates
399 * @todo Try to make this method more generic so we can move it in BaseFrameworkSystem
401 public function updateDatabaseField ($fieldName, $fieldValue) {
403 $this->partialStub('Unfinished!');
406 // Get a critieria instance
407 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
409 // Add search criteria
410 $searchInstance->addCriteria(UserDatabaseWrapper::DB_COLUMN_USERNAME, $this->getUserName());
411 $searchInstance->setLimit(1);
413 // Now get another criteria
414 $updateInstance = ObjectFactory::createObjectByConfiguredName('update_criteria_class');
416 // Add criteria entry which we shall update
417 $updateInstance->addCriteria($fieldName, $fieldValue);
419 // Add the search criteria for searching for the right entry
420 $updateInstance->setSearchInstance($searchInstance);
422 // Set wrapper class name
423 $updateInstance->setWrapperConfigEntry('user_db_wrapper_class');
425 // Remember the update in database result
426 $this->getResultInstance()->add2UpdateQueue($updateInstance);
430 * Announces this hub to the upper (bootstrap or list) hubs. After this is
431 * successfully done the given task is unregistered from the handler. This
432 * might look a bit overloaded here but the announcement phase isn't a
433 * simple "Hello there" message, it may later on also contain more
434 * informations like the object list.
436 * @param $taskInstance The task instance running this announcement
438 * @throws NodeAlreadyAnnouncedException If this hub is already announced
439 * @todo Change the first if() block to check for a specific state
441 public function announceToUpperNodes (Taskable $taskInstance) {
442 // Is this hub node announced?
443 if ($this->hubIsAnnounced === true) {
444 // Already announced!
445 throw new NodeAlreadyAnnouncedException($this, self::EXCEPTION_HUB_ALREADY_ANNOUNCED);
449 self::createDebugInstance(__CLASS__)->debugOutput('HUB-Announcement: START (taskInstance=' . $taskInstance->__toString(). ')');
451 // Get a helper instance
452 $helperInstance = ObjectFactory::createObjectByConfiguredName('node_announcement_helper_class');
454 // Load the announcement descriptor
455 $helperInstance->loadDescriptorXml($this);
457 // Compile all variables
458 $helperInstance->getTemplateInstance()->compileConfigInVariables();
460 // "Publish" the descriptor by sending it to the bootstrap/list nodes
461 $helperInstance->sendPackage($this);
463 // Change the state, this should be the last line except debug output
464 $this->getStateInstance()->nodeAnnouncedToUpperHubs();
467 self::createDebugInstance(__CLASS__)->debugOutput('HUB-Announcement: FINISHED');
471 * Does a self-connect attempt on the public IP address. This should make
472 * it sure, we are reachable from outside world. For this kind of package we
473 * don't need that overload we have in the announcement phase.
475 * @param $taskInstance The task instance running this announcement
478 public function doSelfConnection (Taskable $taskInstance) {
480 self::createDebugInstance(__CLASS__)->debugOutput('HUB: Self Connection: START (taskInstance=' . $taskInstance->__toString(). ')');
482 // Get a helper instance
483 $helperInstance = ObjectFactory::createObjectByConfiguredName('node_self_connect_helper_class', array($this));
485 // Load the descriptor (XML) file
486 $helperInstance->loadDescriptorXml($this);
488 // Compile all variables
489 $helperInstance->getTemplateInstance()->compileConfigInVariables();
491 // And send the package away
492 $helperInstance->sendPackage($this);
495 self::createDebugInstance(__CLASS__)->debugOutput('HUB: Self Connection: FINISHED');
499 * Activates the hub by doing some final preparation and setting
500 * $hubIsActive to true
502 * @param $requestInstance A Requestable class
503 * @param $responseInstance A Responseable class
506 public function activateNode (Requestable $requestInstance, Responseable $responseInstance) {
507 // Checks whether a listener is still active and shuts it down if one
508 // is still listening.
509 if (($this->determineIfListenerIsActive()) && ($this->isNodeActive())) {
510 // Shutdown them down before they can hurt anything
511 $this->shutdownListenerPool();
514 // Get the controller here
515 $controllerInstance = Registry::getRegistry()->getInstance('controller');
517 // Run all filters for the hub activation
518 $controllerInstance->executeActivationFilters($requestInstance, $responseInstance);
520 // ----------------------- Last step from here ------------------------
521 // Activate the hub. This is ALWAYS the last step in this method
522 $this->getStateInstance()->nodeIsActivated();
523 // ---------------------- Last step until here ------------------------
527 * Initializes the listener pool (class)
531 public function initializeListenerPool () {
533 self::createDebugInstance(__CLASS__)->debugOutput('HUB: Initialize listener: START');
535 // Get a new pool instance
536 $this->setListenerPoolInstance(ObjectFactory::createObjectByConfiguredName('listener_pool_class', array($this)));
538 // Get an instance of the low-level listener
539 $listenerInstance = ObjectFactory::createObjectByConfiguredName('tcp_listener_class', array($this));
541 // Setup address and port
542 $listenerInstance->setListenAddressByConfiguration('node_listen_addr');
545 * All nodes can now use the same configuration entry because it can be
546 * customized in config-local.php.
548 $listenerInstance->setListenPortByConfiguration('node_listen_port');
550 // Initialize the listener
551 $listenerInstance->initListener();
553 // Get a decorator class
554 $decoratorInstance = ObjectFactory::createObjectByConfiguredName('node_tcp_listener_class', array($listenerInstance));
556 // Add this listener to the pool
557 $this->getListenerPoolInstance()->addListener($decoratorInstance);
559 // Get a decorator class
560 $decoratorInstance = ObjectFactory::createObjectByConfiguredName('client_tcp_listener_class', array($listenerInstance));
562 // Add this listener to the pool
563 $this->getListenerPoolInstance()->addListener($decoratorInstance);
565 // Get an instance of the low-level listener
566 $listenerInstance = ObjectFactory::createObjectByConfiguredName('udp_listener_class', array($this));
568 // Setup address and port
569 $listenerInstance->setListenAddressByConfiguration('node_listen_addr');
572 * All nodes can now use the same configuration entry because it can be
573 * customized in config-local.php.
575 $listenerInstance->setListenPortByConfiguration('node_listen_port');
577 // Initialize the listener
578 $listenerInstance->initListener();
580 // Get a decorator class
581 $decoratorInstance = ObjectFactory::createObjectByConfiguredName('node_udp_listener_class', array($listenerInstance));
583 // Add this listener to the pool
584 $this->getListenerPoolInstance()->addListener($decoratorInstance);
586 // Get a decorator class
587 $decoratorInstance = ObjectFactory::createObjectByConfiguredName('client_udp_listener_class', array($listenerInstance));
589 // Add this listener to the pool
590 $this->getListenerPoolInstance()->addListener($decoratorInstance);
593 self::createDebugInstance(__CLASS__)->debugOutput('HUB: Initialize listener: FINISHED.');
597 * Getter for isActive attribute
599 * @return $isActive Whether the hub is active
601 public final function isNodeActive () {
602 return $this->isActive;
606 * Enables (default) or disables isActive flag
608 * @param $isActive Whether the hub is active
611 public final function enableIsActive ($isActive = true) {
612 $this->isActive = (bool) $isActive;
616 * Checks whether this node accepts announcements
618 * @return $acceptAnnouncements Whether this node accepts announcements
620 public final function isAcceptingAnnouncements () {
621 // Check it (this node must be active and not shutdown!)
622 $acceptAnnouncements = (($this->acceptAnnouncements === true) && ($this->isNodeActive()));
625 return $acceptAnnouncements;
629 * Checks whether this node has attempted to announce itself
631 * @return $hasAnnounced Whether this node has attempted to announce itself
632 * @todo Add checking if this node has been announced to the sender node
634 public function ifNodeHasAnnounced () {
636 /* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE: ifNodeHasAnnounced(): state=' . $this->getStateInstance()->getStateName());
638 // Simply check the state of this node
639 $hasAnnounced = ($this->getStateInstance() instanceof NodeAnnouncedState);
642 /* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE: ifNodeHasAnnounced(): hasAnnounced=' . intval($hasAnnounced));
645 return $hasAnnounced;
649 * Checks whether this node has attempted to announce itself and completed it
651 * @return $hasAnnouncementCompleted Whether this node has attempted to announce itself and completed it
652 * @todo Add checking if this node has been announced to the sender node
654 public function ifNodeHasAnnouncementCompleted () {
656 /* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE: ifNodeHasAnnouncementCompleted(): state=' . $this->getStateInstance()->getStateName());
658 // Simply check the state of this node
659 $hasAnnouncementCompleted = ($this->getStateInstance() instanceof NodeAnnouncementCompletedState);
662 /* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE: ifNodeHasAnnouncementCompleted(): hasAnnouncementCompleted=' . intval($hasAnnouncementCompleted));
665 return $hasAnnouncementCompleted;
669 * Enables whether this node accepts announcements
671 * @param $acceptAnnouncements Whether this node accepts announcements (default: true)
674 protected final function enableAcceptingAnnouncements ($acceptAnnouncements = true) {
675 $this->acceptAnnouncements = $acceptAnnouncements;
679 * Checks wether this node is accepting node-list requests
681 * @return $acceptsRequest Wether this node accepts node-list requests
683 public function isAcceptingNodeListRequests () {
685 * Only 'regular' nodes does not accept such requests, checking
686 * HubRegularNode is faster, but if e.g. HubRegularI2PNode will be
687 * added then the next check will be true.
689 $acceptsRequest = ((!$this instanceof HubRegularNode) && ($this->getRequestInstance()->getRequestElement('mode') != self::NODE_TYPE_REGULAR));
692 return $acceptsRequest;
696 * "Getter" for address:port combination
698 * @return $addressPort A address:port combination for this node
700 public final function getAddressPort () {
702 $addressPort = $this->getConfigInstance()->detectServerAddress() . ':' . $this->getConfigInstance()->getConfigEntry('node_listen_port');
709 * Updates/refreshes node data (e.g. status).
712 * @todo Find more to do here
714 public function updateNodeData () {
715 // Set some dummy configuration entries, e.g. node_status
716 $this->getConfigInstance()->setConfigEntry('node_status', $this->getStateInstance()->getStateName());
720 * Handles message answer by given data array
722 * @param $messageData A valid answer message data array
723 * @param $packageInstance An instance of a Receivable class
725 * @todo Handle thrown exception
727 public function handleAnswerStatusByMessageData (array $messageData, Receivable $packageInstance) {
729 assert(!empty($messageData[BaseXmlAnswerTemplateEngine::ANSWER_STATUS]));
731 // Construct configuration entry for handling class' name
732 $classConfigEntry = strtolower($messageData[NetworkPackage::MESSAGE_ARRAY_TYPE] . '_status_' . $messageData[BaseXmlAnswerTemplateEngine::ANSWER_STATUS]) . '_handler_class';
734 // Try to get a class
735 $handlerInstance = ObjectFactory::createObjectByConfiguredName($classConfigEntry);
738 $handlerInstance->handleAnswerMessageData($messageData, $packageInstance);
742 * "Getter" for an array of all accepted object types
744 * @return $objectList Array of all accepted object types
746 public function getListFromAcceptedObjectTypes () {
747 // Get registry instance
748 $objectRegistryInstance = ObjectTypeRegistryFactory::createObjectTypeRegistryInstance();
751 $objectList = $objectRegistryInstance->getEntries(XmlObjectRegistryTemplateEngine::OBJECT_TYPE_DATA_NAME);