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 - 2011 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: */ $this->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          * Getter for index key
  86          *
  87          * @return      $indexKey       Index key
  88          */
  89         public final function getIndexKey () {
  90                 return $this->getDatabaseInstance()->getIndexKey();
  91         }
  92
  93         /**
  94          * Checks wether given 'sender' is a new peer
  95          *
  96          * @param       $packageData            Raw package data
  97          * @param       $dataSetInstance        An optional instance of a StoreableCriteria class
  98          * @return      $isNewPeer                      Wether 'sender' is a new peer to this peer
  99          */
 100         public function isSenderNewPeer (array $packageData, StoreableCriteria $dataSetInstance = NULL) {
 101                 // Debug message
 102                 //* NOISY-DEBUG: */ $this->debugOutput('DATABASE-WRAPPER: ' . __FUNCTION__ . ' called with packageData()=' . count($packageData) . ' - ENTERED!');
 103
 104                 // Is always new peer by default
 105                 $isNewPeer = true;
 106
 107                 // Is the package valid?
 108                 if (!isset($packageData[NetworkPackage::PACKAGE_DATA_SENDER])) {
 109                         // Invalid package found, please report this
 110                         $this->debugBackTrace(__METHOD__ . ': packageData=' . print_r($packageData, true));
 111                 } // END - if
 112
 113                 // Get a search criteria instance from package data
 114                 $searchInstance = $this->getSenderSearchInstanceFromPackageData($packageData);
 115
 116                 // Is the dataset instance set?
 117                 if ($dataSetInstance instanceof StoreableCriteria) {
 118                         // Then remember the search instance in it
 119                         $dataSetInstance->setSearchInstance($searchInstance);
 120                 } // END - if
 121
 122                 // Count the query
 123                 $entries = $this->doSelectCountByCriteria($searchInstance, array(self::DB_COLUMN_PEER_SESSION_ID => true));
 124
 125                 // Is it there?
 126                 //* NOISY-DEBUG: */ $this->debugOutput('DATABASE-WRAPPER: entries=' . $entries);
 127                 $isNewPeer = ($entries != 1);
 128
 129                 // Return the result
 130                 //* NOISY-DEBUG: */ $this->debugOutput('DATABASE-WRAPPER: isNewPeer=' . intval($isNewPeer) . ' - EXIT!');
 131                 return $isNewPeer;
 132         }
 133
 134         /**
 135          * Registers a new peer with given package data. We use the session id from it.
 136          *
 137          * @param       $packageData            Raw package data
 138          * @param       $socketResource         A valid socket resource
 139          * @return      void
 140          * @throws      PeerAlreadyRegisteredException  If a peer is already registered
 141          */
 142         public function registerPeerByPackageData (array $packageData, $socketResource) {
 143                 // Make sure only new peers can be registered with package data
 144                 if (!$this->isSenderNewPeer($packageData)) {
 145                         // Throw an exception because this should normally not happen
 146                         throw new PeerAlreadyRegisteredException(array($this, $packageData), self::EXCEPTION_PEER_ALREADY_REGISTERED);
 147                 } // END - if
 148
 149                 // Generate a dataset instance
 150                 $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_PEER_LOOKUP));
 151
 152                 // Session ids must be unique
 153                 $dataSetInstance->setUniqueKey(self::DB_COLUMN_PEER_SESSION_ID);
 154
 155                 // Add session id
 156                 $dataSetInstance->addCriteria(self::DB_COLUMN_PEER_SESSION_ID, $packageData[NetworkPackage::PACKAGE_DATA_SENDER]);
 157
 158                 // Get peer name
 159                 if (!@socket_getpeername($socketResource, $peerName, $peerPort)) {
 160                         // Get last error
 161                         $lastError = socket_last_error($socketResource);
 162
 163                         // ... and cleartext message from it and put both into criteria
 164                         $dataSetInstance->addCriteria(self::DB_COLUMN_SOCKET_ERROR_CODE, $lastError);
 165                         $dataSetInstance->addCriteria(self::DB_COLUMN_SOCKET_ERROR_MSG , socket_strerror($lastError));
 166                 } // END - if
 167
 168                 // Add ip address and port
 169                 $dataSetInstance->addCriteria(self::DB_COLUMN_PEER_IP  , $peerName);
 170                 $dataSetInstance->addCriteria(self::DB_COLUMN_PEER_PORT, $peerPort);
 171
 172                 // "Insert" the data set
 173                 $this->queryInsertDataSet($dataSetInstance, array(self::DB_COLUMN_PEER_SESSION_ID => true));
 174
 175                 // Debug message
 176                 /* NOISY-DEBUG: */ $this->debugOutput('DATABASE-WRAPPER: Peer ' . $packageData[NetworkPackage::PACKAGE_DATA_SENDER] . ' has been registered.');
 177         }
 178
 179         /**
 180          * Registers the given peer state and raw package data
 181          *
 182          * @param       $stateInstance  A PeerStateable class instance
 183          * @param       $packageData    Valid package data array
 184          * @return      void
 185          * @throws      PeerAlreadyRegisteredException  If a peer is already registered
 186          * @todo        Unfinished area
 187          */
 188         public function registerPeerState (PeerStateable $stateInstance, array $packageData) {
 189                 // Generate a dataset instance
 190                 $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_PEER_LOOKUP));
 191
 192                 // Session ids must be unique
 193                 $dataSetInstance->setUniqueKey(self::DB_COLUMN_PEER_SESSION_ID);
 194
 195                 // Add session id
 196                 $dataSetInstance->addCriteria(self::DB_COLUMN_PEER_SESSION_ID, $packageData[NetworkPackage::PACKAGE_DATA_SENDER]);
 197                 $dataSetInstance->addCriteria(self::DB_COLUMN_PEER_STATE     , $stateInstance->getStateName());
 198
 199                 // Try to resolve sender's session id
 200                 $senderData = explode(':', HubTools::resolveSessionId($packageData[NetworkPackage::PACKAGE_DATA_SENDER]));
 201
 202                 // Just make sure that 'invalid:invalid' is not being processed
 203                 assert(($senderData[0] != 'invalid') && ($senderData[1] != 'invalid'));
 204
 205                 // Add ip address and port
 206                 $dataSetInstance->addCriteria(self::DB_COLUMN_PEER_IP  , $senderData[0]);
 207                 $dataSetInstance->addCriteria(self::DB_COLUMN_PEER_PORT, $senderData[1]);
 208
 209                 // Is this a new peer?
 210                 if ($this->isSenderNewPeer($packageData, $dataSetInstance)) {
 211                         // "Insert" the data set
 212                         $this->queryInsertDataSet($dataSetInstance, array(self::DB_COLUMN_PEER_SESSION_ID => true));
 213                 } else {
 214                         // Update the data set
 215                         $this->queryUpdateDataSet($dataSetInstance, array(self::DB_COLUMN_PEER_SESSION_ID => true));
 216                 }
 217
 218                 // Debug message
 219                 /* NOISY-DEBUG: */ $this->debugOutput('DATABASE-WRAPPER: Peer ' . $packageData[NetworkPackage::PACKAGE_DATA_SENDER] . ' has been registered/updated with state ' . $stateInstance->getStateName());
 220         }
 221
 222         /**
 223          * Purges old entries of given socket resource. We use the IP address from that resource.
 224          *
 225          * @param       $socketResource         A valid socket resource
 226          * @return      void
 227          * @throws      InvalidSocketException  If the socket resource was invalid
 228          * @todo        Unfinished area
 229          */
 230         public function purgeOldEntriesBySocketResource ($socketResource) {
 231                 // Get peer name
 232                 if (!@socket_getpeername($socketResource, $peerName, $peerPort)) {
 233                         // Get last error
 234                         $lastError = socket_last_error($socketResource);
 235
 236                         // Doesn't work!
 237                         throw new InvalidSocketException(array($this, gettype($socketResource), $lastError, socket_strerror($lastError)), BaseListener::EXCEPTION_INVALID_SOCKET);
 238                 } // END - if
 239
 240                 // Debug message
 241                 /* NOISY-DEBUG: */ $this->debugOutput('DATABASE-WRAPPER: peerName=' . $peerName . ',peerPort=' . $peerPort . ' - UNFINISHED!');
 242         }
 243
 244         /**
 245          * Checks wether a given peer state (in helper instance) has changed from
 246          * stored one in database.
 247          *
 248          * @param       $helperInstance                 An instance of a ConnectionHelper class
 249          * @param       $packageData                    Valid package data array
 250          * @return      $isPeerStateChanged             Wether the peer's state has changed
 251          */
 252         public function ifPeerStateHasChanged (ConnectionHelper $helperInstance, array $packageData) {
 253                 // Debug message
 254                 /* NOISY-DEBUG: */ $this->debugOutput('DATABASE-WRAPPER: State ' . $helperInstance->getPrintableState() . ' needs to be checked it it has changed ...');
 255
 256                 // By default the peer's state has not changed
 257                 $isPeerStateChanged = false;
 258
 259                 // Return it
 260                 return $isPeerStateChanged;
 261         }
 262 }
 263
 264 // [EOF]
 265 ?>