3 * A hub-node class for the 'Boot' mode
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 HubBootNode extends BaseHubNode implements NodeHelper, Registerable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Creates an instance of this hub-node class
38 * @param $requestInstance An instance of a Requestable class
39 * @return $nodeInstance An instance of this hub-node class
41 public static final function createHubBootNode (Requestable $requestInstance) {
43 $nodeInstance = new HubBootNode();
45 // Set the request instance
46 $nodeInstance->setRequestInstance($requestInstance);
48 // Return the instance
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.
58 * @todo add some more special bootstrap things for this boot node
60 public function doBootstrapping () {
61 // Now check if the IP address matches one of the bootstrap nodes
62 if ($this->ifAddressMatchesBootstrapNodes($this->detectOwnUniversalNodeLocator())) {
63 // Get our port from configuration
64 $ourPort = $this->getConfigInstance()->getConfigEntry('node_listen_port');
67 $bootPort = substr($this->getBootUniversalNodeLocator(), -strlen($ourPort), strlen($ourPort));
69 // Is the port the same?
70 if ($bootPort == $ourPort) {
72 self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: IP/port matches bootstrap node ' . $this->getBootUniversalNodeLocator() . '.');
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.');
80 self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: WARNING: Mismatching mode ' . $this->getRequestInstance()->getRequestElement('mode') . '!=' . BaseHubNode::NODE_TYPE_BOOT . ' detected.');
83 // IP does match, but no port
84 self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: WARNING: Our IP ' . $this->detectOwnUniversalNodeLocator() . ' does match a known bootstrap-node but not the port ' . $ourPort . '/' . $bootPort . '.');
87 // Node does not match any know bootstrap-node
88 self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: WARNING: Our IP ' . $this->detectOwnUniversalNodeLocator() . ' does not match any known bootstrap-nodes.');
91 // Enable acceptance of announcements
92 $this->enableAcceptingAnnouncements();
94 // This might not be all...
95 $this->partialStub('Please implement more bootsrapping steps.');
99 * Add some node-specific filters
103 public function addExtraNodeFilters () {
104 // Get the application instance from registry
105 $applicationInstance = Registry::getRegistry()->getInstance('app');
107 // Get the controller from the application
108 $controllerInstance = $applicationInstance->getControllerInstance();
110 // @TODO Add some filters here
111 $this->partialStub('Add some filters here.');
115 * Adds extra tasks to the given handler for this node
117 * @param $handlerInstance An instance of a HandleableTask class
120 public function addExtraTasks (HandleableTask $handlerInstance) {
121 // Prepare a task for booting the DHT
122 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_dht_bootstrap_task_class');
125 $handlerInstance->registerTask('dht_bootstrap', $taskInstance);