3 * A hub-node class for the 'Boot' mode
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 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 HubBootNode extends BaseHubNode implements NodeHelper {
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 final static function createHubBootNode (Requestable $requestInstance) {
43 $nodeInstance = new HubBootNode();
45 // Set the request instance
46 $nodeInstance->setRequestInstance($requestInstance);
48 // --------------------- Hub-id acquirement phase ---------------------
49 // Acquire a hub-id. This step generates on first launch a new one and
50 // on any later launches it will restore the hub-id from the database.
51 // A passed 'nickname=xxx' argument will be used to add some
52 // 'personality' to the hub.
53 $nodeInstance->acquireHubId();
55 // Return the instance
60 * Method to "bootstrap" the node. This step does also apply provided
61 * command-line arguments stored in the request instance. The regular node
62 * should communicate with the bootstrap-nodes at this point.
65 * @todo add some more special bootstrap things for this boot node
67 public function doBootstrapping () {
68 // Call generic (parent) bootstrapping method first
69 parent::doGenericBootstrapping();
71 // Now check if the IP address matches one of the bootstrap nodes
72 if ($this->ifAddressMatchesBootstrappingNodes($_SERVER['REMOTE_ADDR'])) {
73 // Get our port from configuration
74 $ourPort = $this->getConfigInstance()->readConfig('node_listen_port');
76 // Is the port the same?
77 if (substr($this->bootIpPort, -strlen($ourPort), strlen($ourPort)) == $ourPort) {
79 $this->getDebugInstance()->output(__FUNCTION__.'['.__LINE__.']: IP/port matches bootstrapping node ' . $this->bootIpPort . '.');
81 // Now, does the mode match (should be 'boot'!)
82 if ($this->getRequestInstance()->getRequestElement('mode') == 'boot') {
83 // Output debug message
84 $this->getDebugInstance()->output(__FUNCTION__.'['.__LINE__.']: Our node is a valid bootstrapping node.');
87 $this->getDebugInstance()->output(__FUNCTION__.'['.__LINE__.']: WARNING! Mismatching mode ' . $this->getRequestInstance()->getRequestElement('mode') . '!=boot detected.');
92 // This might not be all...
93 $this->partialStub('Please implement more bootsrapping steps.');
95 // This should be the last thing to do: output teaser lines
96 $this->outputConsoleTeaser();