application/hub/main/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 - 2014 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                 // Now check if the IP address matches one of the bootstrap nodes
  62                 if ($this->ifAddressMatchesBootstrapNodes($this->getConfigInstance()->detectServerAddress())) {
  63                         // Get our port from configuration
  64                         $ourPort = $this->getConfigInstance()->getConfigEntry('node_listen_port');
  65
  66                         // Extract port
  67                         $bootPort = substr($this->getBootIpPort(), -strlen($ourPort), strlen($ourPort));
  68
  69                         // Is the port the same?
  70                         if ($bootPort == $ourPort) {
  71                                 // It is the same!
  72                                 self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: IP/port matches bootstrap node ' . $this->getBootIpPort() . '.');
  73
  74                                 // Now, does the mode match
  75                                 if ($this->getRequestInstance()->getRequestElement('mode') == self::NODE_TYPE_BOOT) {
  76                                         // Output debug message
  77                                         self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Our node is a valid bootstrap node.');
  78                                 } else {
  79                                         // Output warning
  80                                         self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: WARNING: Mismatching mode ' . $this->getRequestInstance()->getRequestElement('mode') . '!=' . BaseHubNode::NODE_TYPE_BOOT . ' detected.');
  81                                 }
  82                         } else {
  83                                 // IP does match, but no port
  84                                 self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: WARNING: Our IP ' . $this->getConfigInstance()->detectServerAddress() . ' does match a known bootstrap-node but not the port ' . $ourPort . '/' . $bootPort . '.');
  85                         }
  86                 } else {
  87                         // Node does not match any know bootstrap-node
  88                         self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: WARNING: Our IP ' . $this->getConfigInstance()->detectServerAddress() . ' does not match any known bootstrap-nodes.');
  89                 }
  90
  91                 // Enable acceptance of announcements
  92                 $this->enableAcceptingAnnouncements();
  93
  94                 // This might not be all...
  95                 $this->partialStub('Please implement more bootsrapping steps.');
  96         }
  97
  98         /**
  99          * Add some node-specific filters
 100          *
 101          * @return      void
 102          */
 103         public function addExtraNodeFilters () {
 104                 // Get the application instance from registry
 105                 $applicationInstance = Registry::getRegistry()->getInstance('app');
 106
 107                 // Get the controller from the application
 108                 $controllerInstance = $applicationInstance->getControllerInstance();
 109
 110                 // @TODO Add some filters here
 111                 $this->partialStub('Add some filters here.');
 112         }
 113
 114         /**
 115          * Adds extra tasks to the given handler for this node
 116          *
 117          * @param       $handlerInstance        An instance of a HandleableTask class
 118          * @return      void
 119          */
 120         public function addExtraTasks (HandleableTask $handlerInstance) {
 121                 // Prepare a task for booting the DHT
 122                 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_dht_bootstrap_task_class');
 123
 124                 // Register it
 125                 $handlerInstance->registerTask('dht_bootstrap', $taskInstance);
 126         }
 127 }
 128
 129 // [EOF]
 130 ?>