application/hub/classes/nodes/boot/class_HubBootNode.php

   1 <?php
   2 /**
   3  * A hub-node class for the 'Boot' mode
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   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
  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 HubBootNode extends BaseHubNode implements NodeHelper, Registerable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33         }
  34
  35         /**
  36          * Creates an instance of this hub-node class
  37          *
  38          * @param       $requestInstance        An instance of a Requestable class
  39          * @return      $nodeInstance           An instance of this hub-node class
  40          */
  41         public static final function createHubBootNode (Requestable $requestInstance) {
  42                 // Get a new instance
  43                 $nodeInstance = new HubBootNode();
  44
  45                 // Set the request instance
  46                 $nodeInstance->setRequestInstance($requestInstance);
  47
  48                 // Return the instance
  49                 return $nodeInstance;
  50         }
  51
  52         /**
  53          * Method to "bootstrap" the node. This step does also apply provided
  54          * command-line arguments stored in the request instance. The regular node
  55          * should communicate with the bootstrap-nodes at this point.
  56          *
  57          * @return      void
  58          * @todo        add some more special bootstrap things for this boot node
  59          */
  60         public function doBootstrapping () {
  61                 // Get UNL
  62                 $unl = $this->detectOwnUniversalNodeLocator();
  63
  64                 // Debug message
  65                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: unl=' . $unl);
  66
  67                 // Now check if the IP address matches one of the bootstrap nodes
  68                 if ($this->ifAddressMatchesBootstrapNodes($unl)) {
  69                         // Get our port from configuration
  70                         $ourPort = $this->getConfigInstance()->getConfigEntry('node_listen_port');
  71
  72                         // Extract port
  73                         $bootPort = substr($this->getBootUniversalNodeLocator(), -strlen($ourPort), strlen($ourPort));
  74
  75                         // Is the port the same?
  76                         if ($bootPort == $ourPort) {
  77                                 // It is the same!
  78                                 self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: UNL matches bootstrap node ' . $this->getBootUniversalNodeLocator() . '.');
  79
  80                                 // Now, does the mode match
  81                                 if ($this->getRequestInstance()->getRequestElement('mode') == self::NODE_TYPE_BOOT) {
  82                                         // Output debug message
  83                                         self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Our node is a valid bootstrap node.');
  84                                 } else {
  85                                         // Output warning
  86                                         self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: WARNING: Mismatching mode ' . $this->getRequestInstance()->getRequestElement('mode') . '!=' . BaseHubNode::NODE_TYPE_BOOT . ' detected.');
  87                                 }
  88                         } else {
  89                                 // IP does match, but no port
  90                                 self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: WARNING: Our UNL ' . $unl . ' does match a known bootstrap-node but not the port ' . $ourPort . '/' . $bootPort . '.');
  91                         }
  92                 } else {
  93                         // Node does not match any know bootstrap-node
  94                         self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: WARNING: Our UNL ' . $unl . ' does not match any known bootstrap-nodes.');
  95                 }
  96
  97                 // Enable acceptance of announcements
  98                 $this->enableAcceptingAnnouncements();
  99
 100                 // This might not be all...
 101                 $this->partialStub('Please implement more bootsrapping steps.');
 102         }
 103
 104         /**
 105          * Add some node-specific filters
 106          *
 107          * @return      void
 108          */
 109         public function addExtraNodeFilters () {
 110                 // Get the application instance from registry
 111                 $applicationInstance = Registry::getRegistry()->getInstance('app');
 112
 113                 // Get the controller from the application
 114                 $controllerInstance = $applicationInstance->getControllerInstance();
 115
 116                 // @TODO Add some filters here
 117                 $this->partialStub('Add some filters here.');
 118         }
 119
 120         /**
 121          * Adds extra tasks to the given handler for this node
 122          *
 123          * @param       $handlerInstance        An instance of a HandleableTask class
 124          * @return      void
 125          */
 126         public function addExtraTasks (HandleableTask $handlerInstance) {
 127                 // Prepare a task for booting the DHT
 128                 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_dht_bootstrap_task_class');
 129
 130                 // Register it
 131                 $handlerInstance->registerTask('dht_bootstrap', $taskInstance);
 132         }
 133 }
 134
 135 // [EOF]
 136 ?>