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

   1 <?php
   2 /**
   3  * A database wrapper for peer state lookups
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.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) . ' - CALLED!');
  94
  95                 // Is the package valid?
  96                 if (!isset($packageData[NetworkPackage::PACKAGE_DATA_SENDER])) {
  97                         // Invalid package found, please report this
  98                         $this->debugBackTrace('[' . __METHOD__ . ':' . __LINE__ . ']:  packageData=' . print_r($packageData, TRUE));
  99                 } // END - if
 100
 101                 // Get a search criteria instance from package data
 102                 $searchInstance = $this->getSenderSearchInstanceFromPackageData($packageData);
 103
 104                 // Is the dataset instance set?
 105                 if ($dataSetInstance instanceof StoreableCriteria) {
 106                         // Then remember the search instance in it
 107                         $dataSetInstance->setSearchInstance($searchInstance);
 108                 } // END - if
 109
 110                 // Count the query
 111                 $entries = $this->doSelectCountByCriteria($searchInstance, array(self::DB_COLUMN_PEER_SESSION_ID => TRUE));
 112
 113                 // Is it there?
 114                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE-WRAPPER: entries=' . $entries);
 115                 $isNewPeer = ($entries != 1);
 116
 117                 // Return the result
 118                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE-WRAPPER: isNewPeer=' . intval($isNewPeer) . ' - EXIT!');
 119                 return $isNewPeer;
 120         }
 121
 122         /**
 123          * Registers a new peer with given package data. We use the session id from it.
 124          *
 125          * @param       $packageData            Raw package data
 126          * @param       $socketResource         A valid socket resource
 127          * @return      void
 128          * @throws      PeerAlreadyRegisteredException  If a peer is already registered
 129          */
 130         public function registerPeerByPackageData (array $packageData, $socketResource) {
 131                 // Make sure only new peers can be registered with package data
 132                 if (!$this->isSenderNewPeer($packageData)) {
 133                         // Throw an exception because this should normally not happen
 134                         throw new PeerAlreadyRegisteredException(array($this, $packageData), self::EXCEPTION_PEER_ALREADY_REGISTERED);
 135                 } // END - if
 136
 137                 // Generate a dataset instance
 138                 $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_PEER_LOOKUP));
 139
 140                 // Session ids must be unique
 141                 $dataSetInstance->setUniqueKey(self::DB_COLUMN_PEER_SESSION_ID);
 142
 143                 // Add session id
 144                 $dataSetInstance->addCriteria(self::DB_COLUMN_PEER_SESSION_ID, $packageData[NetworkPackage::PACKAGE_DATA_SENDER]);
 145
 146                 // Get peer name
 147                 if (!@socket_getpeername($socketResource, $peerName, $peerPort)) {
 148                         // Get last error
 149                         $lastError = socket_last_error($socketResource);
 150
 151                         // ... and cleartext message from it and put both into criteria
 152                         $dataSetInstance->addCriteria(self::DB_COLUMN_SOCKET_ERROR_CODE, $lastError);
 153                         $dataSetInstance->addCriteria(self::DB_COLUMN_SOCKET_ERROR_MSG , socket_strerror($lastError));
 154                 } // END - if
 155
 156                 // Add ip address and port
 157                 $dataSetInstance->addCriteria(self::DB_COLUMN_PEER_IP  , $peerName);
 158                 $dataSetInstance->addCriteria(self::DB_COLUMN_PEER_PORT, $peerPort);
 159
 160                 // "Insert" the data set
 161                 $this->queryInsertDataSet($dataSetInstance, array(self::DB_COLUMN_PEER_SESSION_ID => TRUE));
 162
 163                 // Debug message
 164                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE-WRAPPER: Peer ' . $packageData[NetworkPackage::PACKAGE_DATA_SENDER] . ' has been registered.');
 165         }
 166
 167         /**
 168          * Registers the given peer state and raw package data
 169          *
 170          * @param       $stateInstance  A PeerStateable class instance
 171          * @param       $packageData    Valid package data array
 172          * @return      void
 173          * @throws      PeerAlreadyRegisteredException  If a peer is already registered
 174          * @todo        Unfinished area
 175          */
 176         public function registerPeerState (PeerStateable $stateInstance, array $packageData) {
 177                 // Generate a dataset instance
 178                 $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_PEER_LOOKUP));
 179
 180                 // Session ids must be unique
 181                 $dataSetInstance->setUniqueKey(self::DB_COLUMN_PEER_SESSION_ID);
 182
 183                 // Add session id
 184                 $dataSetInstance->addCriteria(self::DB_COLUMN_PEER_SESSION_ID, $packageData[NetworkPackage::PACKAGE_DATA_SENDER]);
 185                 $dataSetInstance->addCriteria(self::DB_COLUMN_PEER_STATE     , $stateInstance->getStateName());
 186
 187                 // Try to resolve sender's session id
 188                 $senderData = explode(':', HubTools::resolveSessionId($packageData[NetworkPackage::PACKAGE_DATA_SENDER]));
 189
 190                 // Just make sure that 'invalid:invalid' is not being processed
 191                 assert(($senderData[0] != 'invalid') && ($senderData[1] != 'invalid') && ($senderData[2] != 'invalid'));
 192
 193                 // Add ip address and port
 194                 $dataSetInstance->addCriteria(self::DB_COLUMN_PEER_IP  , $senderData[0]);
 195                 $dataSetInstance->addCriteria(self::DB_COLUMN_PEER_PORT, $senderData[1]);
 196
 197                 // Is this a new peer?
 198                 if ($this->isSenderNewPeer($packageData, $dataSetInstance)) {
 199                         // "Insert" the data set
 200                         $this->queryInsertDataSet($dataSetInstance, array(self::DB_COLUMN_PEER_SESSION_ID => TRUE));
 201                 } else {
 202                         // Update the data set
 203                         $this->queryUpdateDataSet($dataSetInstance, array(self::DB_COLUMN_PEER_SESSION_ID => TRUE));
 204                 }
 205
 206                 // Debug message
 207                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE-WRAPPER: Peer ' . $packageData[NetworkPackage::PACKAGE_DATA_SENDER] . ' has been registered/updated with state ' . $stateInstance->getStateName());
 208         }
 209
 210         /**
 211          * Purges old entries of given socket resource. We use the IP address from that resource.
 212          *
 213          * @param       $socketResource         A valid socket resource
 214          * @return      void
 215          * @throws      InvalidSocketException  If the socket resource was invalid
 216          * @todo        Unfinished area
 217          */
 218         public function purgeOldEntriesBySocketResource ($socketResource) {
 219                 // Get peer name
 220                 if (!@socket_getpeername($socketResource, $peerName, $peerPort)) {
 221                         // Get last error
 222                         $lastError = socket_last_error($socketResource);
 223
 224                         // Doesn't work!
 225                         throw new InvalidSocketException(array($this, $socketResource, $lastError, socket_strerror($lastError)), BaseListener::EXCEPTION_INVALID_SOCKET);
 226                 } // END - if
 227
 228                 // Debug message
 229                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE-WRAPPER: peerName=' . $peerName . ',peerPort=' . $peerPort . ' - UNFINISHED!');
 230         }
 231
 232         /**
 233          * Checks whether a given peer state (in helper instance) is same as stored
 234          * in database compared with the one from $helperInstance.
 235          *
 236          * @param       $helperInstance                 An instance of a ConnectionHelper class
 237          * @param       $packageData                    Valid package data array
 238          * @return      $isSamePeerState                Whether the peer's state is the same
 239          */
 240         public function isSamePeerState (ConnectionHelper $helperInstance, array $packageData) {
 241                 // Debug message
 242                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE-WRAPPER: State ' . $helperInstance->getPrintableState() . ' needs to be checked it has changed ...');
 243
 244                 // Now get the search instance from given package data
 245                 $searchInstance = $this->getSenderSearchInstanceFromPackageData($packageData);
 246
 247                 // With this search instance query the database for the peer and get a result instance
 248                 $resultInstance = $this->doSelectByCriteria($searchInstance);
 249
 250                 // Do we have an entry? This should always the case
 251                 assert($resultInstance->next());
 252
 253                 // Yes, so get the current (=first) entry from it
 254                 $rowData = $resultInstance->current();
 255
 256                 // Debug message
 257                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE-WRAPPER: rowData[' . gettype($rowData) . ']=' . print_r($rowData, TRUE));
 258
 259                 // Assert on important elements
 260                 assert(isset($rowData[self::DB_COLUMN_PEER_STATE]));
 261
 262                 // Now just compare it with given state from helper instance
 263                 $isSamePeerState = ($rowData[self::DB_COLUMN_PEER_STATE] == $helperInstance->getPrintableState());
 264
 265                 // Debug message
 266                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DATABASE-WRAPPER: state in database: ' . $rowData[self::DB_COLUMN_PEER_STATE] . ', new state: ' . $helperInstance->getPrintableState() . ',isSamePeerState=' . intval($isSamePeerState));
 267
 268                 // Return it
 269                 return $isSamePeerState;
 270         }
 271 }
 272
 273 // [EOF]
 274 ?>