3 * A general hub node class
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 BaseHubNode extends BaseFrameworkSystem implements Updateable {
31 * IP/port number of bootstrapping node
33 private $bootIpPort = '';
36 * Protected constructor
38 * @param $className Name of the class
41 protected function __construct ($className) {
42 // Call parent constructor
43 parent::__construct($className);
46 $this->removeNumberFormaters();
47 $this->removeSystemArray();
53 * @param $nodeId Our new node id
56 private final function setNodeId ($nodeId) {
57 $this->nodeId = (string) $nodeId;
63 * @return $nodeId Our new node id
65 private final function getNodeId () {
70 * Checks wether the given IP address matches one of the bootstrapping nodes
72 * @param $remoteAddr IP address to checkout against our bootstrapping list
73 * @return $isFound Wether the IP is found
75 protected function ifAddressMatchesBootstrappingNodes ($remoteAddr) {
76 // By default nothing is found
79 // Run through all configured IPs
80 foreach (explode(',', $this->getConfigInstance()->readConfig('hub_bootstrap_nodes')) as $ipPort) {
81 // Split it up in IP/port
82 $ipPortArray = explode(':', $ipPort);
85 if ($ipPortArray[0] == $remoteAddr) {
89 // Remember the port number
90 $this->bootIpPort = $ipPort;
93 $this->getDebugInstance()->output(__FUNCTION__.'['.__LINE__.']: IP matches remote address ' . $ipPort . '.');
95 // Stop further searching
97 } elseif ($ipPortArray[0] == $this->getConfigInstance()->readConfig('node_listen_addr')) {
98 // IP matches listen address. At this point we really don't care
99 // if we can also listen on that address!
102 // Remember the port number
103 $this->bootIpPort = $ipPort;
106 $this->getDebugInstance()->output(__FUNCTION__.'['.__LINE__.']: IP matches listen address ' . $ipPort . '.');
108 // Stop further searching
118 * Outputs the console teaser. This should only be executed on startup or
119 * full restarts. This method generates some space around the teaser.
123 protected function outputConsoleTeaser () {
124 // Get the app instance (for shortening our code)
125 $app = $this->getApplicationInstance();
128 $this->getDebugInstance()->output(' ');
129 $this->getDebugInstance()->output($app->getAppName() . ' v' . $app->getAppVersion() . ' - ' . $this->getRequestInstance()->getRequestElement('mode') . ' mode active');
130 $this->getDebugInstance()->output('Copyright (c) 2007 - 2008 Roland Haeder, 2009 Hub Developer Team');
131 $this->getDebugInstance()->output(' ');
132 $this->getDebugInstance()->output('This program comes with ABSOLUTELY NO WARRANTY; for details see docs/COPYING.');
133 $this->getDebugInstance()->output('This is free software, and you are welcome to redistribute it under certain');
134 $this->getDebugInstance()->output('conditions; see docs/COPYING for details.');
135 $this->getDebugInstance()->output(' ');
139 * Do generic things for bootup phase. This can be e.g. checking if the
140 * right node mode is selected for this hub's IP number.
143 * @todo This method is maybe not yet finished.
145 protected function doGenericBootstrapping () {
146 // @TODO Empty method
147 $this->partialStub('Add some generic bootstrap steps here.');
151 * Generic method to acquire a hub-id. On first run this generates a new one
152 * based on many pseudo-random data. On any later run, unless the id
153 * got not removed from database, it will be restored from the database.
157 protected function acquireHubId () {
158 // Get a wrapper instance
159 $wrapperInstance = ObjectFactory::createObjectByConfiguredName('node_info_db_wrapper_class');
161 // Now get a search criteria instance
162 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
164 // Search for the node number zero which is hard-coded the default
165 $searchInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_NR, 1);
166 $searchInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_TYPE, $this->getRequestInstance()->getRequestElement('mode'));
167 $searchInstance->setLimit(1);
170 $resultInstance = $wrapperInstance->doSelectByCriteria($searchInstance);
173 if ($resultInstance->next()) {
174 // Save the result instance in this class
175 $this->setResultInstance($resultInstance);
177 // Get the node id from result and set it
178 $this->setNodeId($this->getField(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_ID));
181 $this->getDebugInstance()->output('Re-using found node-id: ' . $this->getNodeId() . '');
183 // Get an RNG instance (Random Number Generator)
184 $rngInstance = ObjectFactory::createObjectByConfiguredName('rng_class');
186 // Generate a pseudo-random string
187 $randomString = $rngInstance->randomString(255) . ':' . $this->getRequestInstance()->getRequestElement('mode');
189 // Get a crypto instance
190 $cryptoInstance = ObjectFactory::createObjectByConfiguredName('crypto_class');
192 // Hash and encrypt the string so we become a "node id" aka Hub-Id
193 $this->setNodeId($cryptoInstance->hashString($cryptoInstance->encryptString($randomString)));
195 // Register the node id with our wrapper
196 $wrapperInstance->registerNodeId($this, $this->getRequestInstance());
199 $this->getDebugInstance()->output('Created new node-id: ' . $this->getNodeId() . '');
204 * Initializes queues which every node needs
208 protected function initGenericQueues () {
209 $this->partialStub('Init query queue here.');
213 * Adds hub data elements to a given dataset instance
215 * @param $criteriaInstance An instance of a storeable criteria
216 * @param $requestInstance An instance of a Requestable class
219 public function addElementsToDataSet (StoreableCriteria $criteriaInstance, Requestable $requestInstance) {
220 // Add node number and type
221 $criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_NR, 1);
222 $criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_TYPE, $requestInstance->getRequestElement('mode'));
225 $criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_ID, $this->getNodeId());
229 * Updates a given field with new value
231 * @param $fieldName Field to update
232 * @param $fieldValue New value to store
234 * @throws DatabaseUpdateSupportException If this class does not support database updates
235 * @todo Try to make this method more generic so we can move it in BaseFrameworkSystem
237 public function updateDatabaseField ($fieldName, $fieldValue) {
239 $this->partialStub("Unfinished!");
242 // Get a critieria instance
243 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
245 // Add search criteria
246 $searchInstance->addCriteria(UserDatabaseWrapper::DB_COLUMN_USERNAME, $this->getUserName());
247 $searchInstance->setLimit(1);
249 // Now get another criteria
250 $updateInstance = ObjectFactory::createObjectByConfiguredName('update_criteria_class');
252 // Add criteria entry which we shall update
253 $updateInstance->addCriteria($fieldName, $fieldValue);
255 // Add the search criteria for searching for the right entry
256 $updateInstance->setSearchInstance($searchInstance);
258 // Set wrapper class name
259 $updateInstance->setWrapperConfigEntry('user_db_wrapper_class');
261 // Remember the update in database result
262 $this->getResultInstance()->add2UpdateQueue($updateInstance);