application/hub/main/database/wrapper/states/class_PeerStateLookupDatabaseWrapper.php

   1 <?php
   2 /**
   3  * A database wrapper for peer state lookups
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 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 PeerStateLookupDatabaseWrapper extends BaseDatabaseWrapper implements LookupablePeerState {
  25         // Exception constants
  26         const EXCEPTION_PEER_ALREADY_REGISTERED = 0x300;
  27
  28         // Constants for database table names
  29         const DB_TABLE_PEER_LOOKUP = 'peer_states';
  30
  31         // Constants for database column names
  32         const DB_COLUMN_PEER_IP           = 'peer_ip';
  33         const DB_COLUMN_PEER_PORT         = 'peer_port';
  34         const DB_COLUMN_PEER_SESSION_ID   = 'peer_session_id';
  35         const DB_COLUMN_PEER_STATE        = 'peer_state';
  36         const DB_COLUMN_SOCKET_ERROR_CODE = 'socket_error_code';
  37         const DB_COLUMN_SOCKET_ERROR_MSG  = 'socket_error_msg';
  38
  39         /**
  40          * Protected constructor
  41          *
  42          * @return      void
  43          */
  44         protected function __construct () {
  45                 // Call parent constructor
  46                 parent::__construct(__CLASS__);
  47         }
  48
  49         /**
  50          * Creates an instance of this database wrapper by a provided user class
  51          *
  52          * @return      $wrapperInstance        An instance of the created wrapper class
  53          */
  54         public static final function createPeerStateLookupDatabaseWrapper () {
  55                 // Get a new instance
  56                 $wrapperInstance = new PeerStateLookupDatabaseWrapper();
  57
  58                 // Set (primary!) table name
  59                 $wrapperInstance->setTableName(self::DB_TABLE_PEER_LOOKUP);
  60
  61                 // Return the instance
  62                 return $wrapperInstance;
  63         }
  64
  65         /**
  66          * "Getter" for a LocalSearchCriteria from given package data's sender
  67          *
  68          * @param       $packageData            Valid raw package data array
  69          * @return      $searchInstance         An instance of a LocalSearchCriteria class
  70          */
  71         private function getSenderSearchInstanceFromPackageData (array $packageData) {
  72                 // Get the instance
  73                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE-WRAPPER: Searching for sender ' . $packageData[NetworkPackage::PACKAGE_DATA_SENDER]);
  74                 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
  75
  76                 // Add 'sender' as the peer's IP address
  77                 $searchInstance->addCriteria(self::DB_COLUMN_PEER_SESSION_ID, $packageData[NetworkPackage::PACKAGE_DATA_SENDER]);
  78                 $searchInstance->setLimit(1);
  79
  80                 // Return the instance
  81                 return $searchInstance;
  82         }
  83
  84         /**
  85          * Checks whether given 'sender' is a new peer
  86          *
  87          * @param       $packageData            Raw package data
  88          * @param       $dataSetInstance        An optional instance of a StoreableCriteria class
  89          * @return      $isNewPeer                      Whether 'sender' is a new peer to this peer
  90          */
  91         public function isSenderNewPeer (array $packageData, StoreableCriteria $dataSetInstance = NULL) {
  92                 // Debug message
  93                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE-WRAPPER: ' . __FUNCTION__ . ' called with packageData()=' . count($packageData) . ' - ENTERED!');
  94
  95                 // Is always new peer by default
  96                 $isNewPeer = true;
  97
  98                 // Is the package valid?
  99                 if (!isset($packageData[NetworkPackage::PACKAGE_DATA_SENDER])) {
 100                         // Invalid package found, please report this
 101                         $this->debugBackTrace('[' . __METHOD__ . ':' . __LINE__ . ']:  packageData=' . print_r($packageData, true));
 102                 } // END - if
 103
 104                 // Get a search criteria instance from package data
 105                 $searchInstance = $this->getSenderSearchInstanceFromPackageData($packageData);
 106
 107                 // Is the dataset instance set?
 108                 if ($dataSetInstance instanceof StoreableCriteria) {
 109                         // Then remember the search instance in it
 110                         $dataSetInstance->setSearchInstance($searchInstance);
 111                 } // END - if
 112
 113                 // Count the query
 114                 $entries = $this->doSelectCountByCriteria($searchInstance, array(self::DB_COLUMN_PEER_SESSION_ID => true));
 115
 116                 // Is it there?
 117                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE-WRAPPER: entries=' . $entries);
 118                 $isNewPeer = ($entries != 1);
 119
 120                 // Return the result
 121                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE-WRAPPER: isNewPeer=' . intval($isNewPeer) . ' - EXIT!');
 122                 return $isNewPeer;
 123         }
 124
 125         /**
 126          * Registers a new peer with given package data. We use the session id from it.
 127          *
 128          * @param       $packageData            Raw package data
 129          * @param       $socketResource         A valid socket resource
 130          * @return      void
 131          * @throws      PeerAlreadyRegisteredException  If a peer is already registered
 132          */
 133         public function registerPeerByPackageData (array $packageData, $socketResource) {
 134                 // Make sure only new peers can be registered with package data
 135                 if (!$this->isSenderNewPeer($packageData)) {
 136                         // Throw an exception because this should normally not happen
 137                         throw new PeerAlreadyRegisteredException(array($this, $packageData), self::EXCEPTION_PEER_ALREADY_REGISTERED);
 138                 } // END - if
 139
 140                 // Generate a dataset instance
 141                 $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_PEER_LOOKUP));
 142
 143                 // Session ids must be unique
 144                 $dataSetInstance->setUniqueKey(self::DB_COLUMN_PEER_SESSION_ID);
 145
 146                 // Add session id
 147                 $dataSetInstance->addCriteria(self::DB_COLUMN_PEER_SESSION_ID, $packageData[NetworkPackage::PACKAGE_DATA_SENDER]);
 148
 149                 // Get peer name
 150                 if (!@socket_getpeername($socketResource, $peerName, $peerPort)) {
 151                         // Get last error
 152                         $lastError = socket_last_error($socketResource);
 153
 154                         // ... and cleartext message from it and put both into criteria
 155                         $dataSetInstance->addCriteria(self::DB_COLUMN_SOCKET_ERROR_CODE, $lastError);
 156                         $dataSetInstance->addCriteria(self::DB_COLUMN_SOCKET_ERROR_MSG , socket_strerror($lastError));
 157                 } // END - if
 158
 159                 // Add ip address and port
 160                 $dataSetInstance->addCriteria(self::DB_COLUMN_PEER_IP  , $peerName);
 161                 $dataSetInstance->addCriteria(self::DB_COLUMN_PEER_PORT, $peerPort);
 162
 163                 // "Insert" the data set
 164                 $this->queryInsertDataSet($dataSetInstance, array(self::DB_COLUMN_PEER_SESSION_ID => true));
 165
 166                 // Debug message
 167                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE-WRAPPER: Peer ' . $packageData[NetworkPackage::PACKAGE_DATA_SENDER] . ' has been registered.');
 168         }
 169
 170         /**
 171          * Registers the given peer state and raw package data
 172          *
 173          * @param       $stateInstance  A PeerStateable class instance
 174          * @param       $packageData    Valid package data array
 175          * @return      void
 176          * @throws      PeerAlreadyRegisteredException  If a peer is already registered
 177          * @todo        Unfinished area
 178          */
 179         public function registerPeerState (PeerStateable $stateInstance, array $packageData) {
 180                 // Generate a dataset instance
 181                 $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_PEER_LOOKUP));
 182
 183                 // Session ids must be unique
 184                 $dataSetInstance->setUniqueKey(self::DB_COLUMN_PEER_SESSION_ID);
 185
 186                 // Add session id
 187                 $dataSetInstance->addCriteria(self::DB_COLUMN_PEER_SESSION_ID, $packageData[NetworkPackage::PACKAGE_DATA_SENDER]);
 188                 $dataSetInstance->addCriteria(self::DB_COLUMN_PEER_STATE     , $stateInstance->getStateName());
 189
 190                 // Try to resolve sender's session id
 191                 $senderData = explode(':', HubTools::resolveSessionId($packageData[NetworkPackage::PACKAGE_DATA_SENDER], $packageData[NetworkPackage::PACKAGE_DATA_PROTOCOL]));
 192
 193                 // Just make sure that 'invalid:invalid' is not being processed
 194                 assert(($senderData[0] != 'invalid') && ($senderData[1] != 'invalid'));
 195
 196                 // Add ip address and port
 197                 $dataSetInstance->addCriteria(self::DB_COLUMN_PEER_IP  , $senderData[0]);
 198                 $dataSetInstance->addCriteria(self::DB_COLUMN_PEER_PORT, $senderData[1]);
 199
 200                 // Is this a new peer?
 201                 if ($this->isSenderNewPeer($packageData, $dataSetInstance)) {
 202                         // "Insert" the data set
 203                         $this->queryInsertDataSet($dataSetInstance, array(self::DB_COLUMN_PEER_SESSION_ID => true));
 204                 } else {
 205                         // Update the data set
 206                         $this->queryUpdateDataSet($dataSetInstance, array(self::DB_COLUMN_PEER_SESSION_ID => true));
 207                 }
 208
 209                 // Debug message
 210                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE-WRAPPER: Peer ' . $packageData[NetworkPackage::PACKAGE_DATA_SENDER] . ' has been registered/updated with state ' . $stateInstance->getStateName());
 211         }
 212
 213         /**
 214          * Purges old entries of given socket resource. We use the IP address from that resource.
 215          *
 216          * @param       $socketResource         A valid socket resource
 217          * @return      void
 218          * @throws      InvalidSocketException  If the socket resource was invalid
 219          * @todo        Unfinished area
 220          */
 221         public function purgeOldEntriesBySocketResource ($socketResource) {
 222                 // Get peer name
 223                 if (!@socket_getpeername($socketResource, $peerName, $peerPort)) {
 224                         // Get last error
 225                         $lastError = socket_last_error($socketResource);
 226
 227                         // Doesn't work!
 228                         throw new InvalidSocketException(array($this, $socketResource, $lastError, socket_strerror($lastError)), BaseListener::EXCEPTION_INVALID_SOCKET);
 229                 } // END - if
 230
 231                 // Debug message
 232                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE-WRAPPER: peerName=' . $peerName . ',peerPort=' . $peerPort . ' - UNFINISHED!');
 233         }
 234
 235         /**
 236          * Checks whether a given peer state (in helper instance) is same as stored
 237          * in database compared with the one from $helperInstance.
 238          *
 239          * @param       $helperInstance                 An instance of a ConnectionHelper class
 240          * @param       $packageData                    Valid package data array
 241          * @return      $isSamePeerState                Whether the peer's state is the same
 242          */
 243         public function isSamePeerState (ConnectionHelper $helperInstance, array $packageData) {
 244                 // Debug message
 245                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE-WRAPPER: State ' . $helperInstance->getPrintableState() . ' needs to be checked it has changed ...');
 246
 247                 // Now get the search instance from given package data
 248                 $searchInstance = $this->getSenderSearchInstanceFromPackageData($packageData);
 249
 250                 // With this search instance query the database for the peer and get a result instance
 251                 $resultInstance = $this->doSelectByCriteria($searchInstance);
 252
 253                 // Do we have an entry? This should always the case
 254                 assert($resultInstance->next());
 255
 256                 // Yes, so get the current (=first) entry from it
 257                 $rowData = $resultInstance->current();
 258
 259                 // Now just compare it with given state from helper instance
 260                 $isSamePeerState = ($rowData[self::DB_COLUMN_PEER_STATE] == $helperInstance->getPrintableState());
 261
 262                 // Debug message
 263                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE-WRAPPER: state in database: ' . $rowData[self::DB_COLUMN_PEER_STATE] . ', new state: ' . $helperInstance->getPrintableState() . ',isSamePeerState=' . intval($isSamePeerState));
 264
 265                 // Return it
 266                 return $isSamePeerState;
 267         }
 268 }
 269
 270 // [EOF]
 271 ?>