application/hub/main/nodes/class_BaseHubNode.php

   1 <?php
   2 /**
   3  * A general hub node class
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   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
  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 BaseHubNode extends BaseFrameworkSystem implements Updateable {
  25         /**
  26          * Node id
  27          */
  28         private $nodeId = '';
  29
  30         /**
  31          * IP/port number of bootstrapping node
  32          */
  33         private $bootIpPort = '';
  34
  35         /**
  36          * Protected constructor
  37          *
  38          * @param       $className      Name of the class
  39          * @return      void
  40          */
  41         protected function __construct ($className) {
  42                 // Call parent constructor
  43                 parent::__construct($className);
  44
  45                 // Clean up a little
  46                 $this->removeNumberFormaters();
  47                 $this->removeSystemArray();
  48         }
  49
  50         /**
  51          * Setter for node id
  52          *
  53          * @param       $nodeId         Our new node id
  54          * @return      void
  55          */
  56         private final function setNodeId ($nodeId) {
  57                 $this->nodeId = (string) $nodeId;
  58         }
  59
  60         /**
  61          * Getter for node id
  62          *
  63          * @return      $nodeId         Our new node id
  64          */
  65         private final function getNodeId () {
  66                 return $this->nodeId;
  67         }
  68
  69         /**
  70          * Checks wether the given IP address matches one of the bootstrapping nodes
  71          *
  72          * @param       $remoteAddr             IP address to checkout against our bootstrapping list
  73          * @return      $isFound                Wether the IP is found
  74          */
  75         protected function ifAddressMatchesBootstrappingNodes ($remoteAddr) {
  76                 // By default nothing is found
  77                 $isFound = false;
  78
  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);
  83
  84                         // Does it match?
  85                         if ($ipPortArray[0] == $remoteAddr) {
  86                                 // Found it!
  87                                 $isFound = true;
  88
  89                                 // Remember the port number
  90                                 $this->bootIpPort = $ipPort;
  91
  92                                 // Output message
  93                                 $this->getDebugInstance()->output(__FUNCTION__.'['.__LINE__.']: IP matches remote address ' . $ipPort . '.');
  94
  95                                 // Stop further searching
  96                                 break;
  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!
 100                                 $isFound = true;
 101
 102                                 // Remember the port number
 103                                 $this->bootIpPort = $ipPort;
 104
 105                                 // Output message
 106                                 $this->getDebugInstance()->output(__FUNCTION__.'['.__LINE__.']: IP matches listen address ' . $ipPort . '.');
 107
 108                                 // Stop further searching
 109                                 break;
 110                         }
 111                 } // END - foreach
 112
 113                 // Return the result
 114                 return $isFound;
 115         }
 116
 117         /**
 118          * Outputs the console teaser. This should only be executed on startup or
 119          * full restarts. This method generates some space around the teaser.
 120          *
 121          * @return      void
 122          */
 123         private function outputConsoleTeaser () {
 124                 // Get the app instance (for shortening our code)
 125                 $app = $this->getApplicationInstance();
 126
 127                 // Output all lines
 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(' ');
 136         }
 137
 138         /**
 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.
 141          *
 142          * @todo        This method is maybe not yet finished.
 143          * @return      void
 144          */
 145         protected function doGenericBootstrapping () {
 146                 // Finally output our teaser. This should be the last line!
 147                 $this->outputConsoleTeaser();
 148         }
 149
 150         /**
 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.
 154          *
 155          * @param       $requestInstance        An instance of a Requestable class
 156          * @return      void
 157          */
 158         public function acquireHubId (Requestable $requestInstance) {
 159                 // Get a wrapper instance
 160                 $wrapperInstance = ObjectFactory::createObjectByConfiguredName('node_info_db_wrapper_class');
 161
 162                 // Now get a search criteria instance
 163                 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
 164
 165                 // Search for the node number zero which is hard-coded the default
 166                 $searchInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_NR, 1);
 167                 $searchInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_TYPE, $requestInstance->getRequestElement('mode'));
 168                 $searchInstance->setLimit(1);
 169
 170                 // Get a result back
 171                 $resultInstance = $wrapperInstance->doSelectByCriteria($searchInstance);
 172
 173                 // Is it valid?
 174                 if ($resultInstance->next()) {
 175                         // Save the result instance in this class
 176                         $this->setResultInstance($resultInstance);
 177
 178                         // Get the node id from result and set it
 179                         $this->setNodeId($this->getField(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_ID));
 180
 181                         // Output message
 182                         $this->getDebugInstance()->output('Re-using found node-id: ' . $this->getNodeId() . '');
 183                 } else {
 184                         // Get an RNG instance (Random Number Generator)
 185                         $rngInstance = ObjectFactory::createObjectByConfiguredName('rng_class');
 186
 187                         // Generate a pseudo-random string
 188                         $randomString = $rngInstance->randomString(255) . ':' . $requestInstance->getRequestElement('mode');
 189
 190                         // Get a crypto instance
 191                         $cryptoInstance = ObjectFactory::createObjectByConfiguredName('crypto_class');
 192
 193                         // Hash and encrypt the string so we become a "node id" aka Hub-Id
 194                         $this->setNodeId($cryptoInstance->hashString($cryptoInstance->encryptString($randomString)));
 195
 196                         // Register the node id with our wrapper
 197                         $wrapperInstance->registerNodeId($this, $requestInstance);
 198
 199                         // Output message
 200                         $this->getDebugInstance()->output('Created new node-id: ' . $this->getNodeId() . '');
 201                 }
 202         }
 203
 204         /**
 205          * Adds hub data elements to a given dataset instance
 206          *
 207          * @param       $criteriaInstance       An instance of a storeable criteria
 208          * @param       $requestInstance        An instance of a Requestable class
 209          * @return      void
 210          */
 211         public function addElementsToDataSet (StoreableCriteria $criteriaInstance, Requestable $requestInstance) {
 212                 // Add node number and type
 213                 $criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_NR, 1);
 214                 $criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_TYPE, $requestInstance->getRequestElement('mode'));
 215
 216                 // Add the node id
 217                 $criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_ID, $this->getNodeId());
 218         }
 219
 220         /**
 221          * Updates a given field with new value
 222          *
 223          * @param       $fieldName              Field to update
 224          * @param       $fieldValue             New value to store
 225          * @return      void
 226          * @throws      DatabaseUpdateSupportException  If this class does not support database updates
 227          * @todo        Try to make this method more generic so we can move it in BaseFrameworkSystem
 228          */
 229         public function updateDatabaseField ($fieldName, $fieldValue) {
 230                 // Unfinished
 231                 $this->partialStub("Unfinished!");
 232                 return;
 233
 234                 // Get a critieria instance
 235                 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
 236
 237                 // Add search criteria
 238                 $searchInstance->addCriteria(UserDatabaseWrapper::DB_COLUMN_USERNAME, $this->getUserName());
 239                 $searchInstance->setLimit(1);
 240
 241                 // Now get another criteria
 242                 $updateInstance = ObjectFactory::createObjectByConfiguredName('update_criteria_class');
 243
 244                 // Add criteria entry which we shall update
 245                 $updateInstance->addCriteria($fieldName, $fieldValue);
 246
 247                 // Add the search criteria for searching for the right entry
 248                 $updateInstance->setSearchInstance($searchInstance);
 249
 250                 // Set wrapper class name
 251                 $updateInstance->setWrapperConfigEntry('user_db_wrapper_class');
 252
 253                 // Remember the update in database result
 254                 $this->getResultInstance()->add2UpdateQueue($updateInstance);
 255         }
 256 }
 257
 258 // [EOF]
 259 ?>