application/hub/main/database/wrapper/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, 2010 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 {
  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
  36         /**
  37          * Protected constructor
  38          *
  39          * @return      void
  40          */
  41         protected function __construct () {
  42                 // Call parent constructor
  43                 parent::__construct(__CLASS__);
  44         }
  45
  46         /**
  47          * Creates an instance of this database wrapper by a provided user class
  48          *
  49          * @return      $wrapperInstance        An instance of the created wrapper class
  50          */
  51         public final static function createPeerStateLookupDatabaseWrapper () {
  52                 // Get a new instance
  53                 $wrapperInstance = new PeerStateLookupDatabaseWrapper();
  54
  55                 // Set (primary!) table name
  56                 $wrapperInstance->setTableName(self::DB_TABLE_PEER_LOOKUP);
  57
  58                 // Return the instance
  59                 return $wrapperInstance;
  60         }
  61
  62         /**
  63          * Getter for index key
  64          *
  65          * @return      $indexKey       Index key
  66          */
  67         public final function getIndexKey () {
  68                 return $this->getDatabaseInstance()->getIndexKey();
  69         }
  70
  71         /**
  72          * Checks wether given 'sender' is a new peer
  73          *
  74          * @param       $packageData    Raw package data
  75          * @return      $isNewPeer              Wether 'sender' is a new peer to this node
  76          */
  77         public function isSenderNewPeer (array $packageData) {
  78                 // Is always new peer by default
  79                 $isNewPeer = true;
  80
  81                 // Remove session id > IP:port
  82                 $ipPort = HubTools::resolveSessionId($packageData[NetworkPackage::INDEX_PACKAGE_SENDER]);
  83
  84                 // Is it not invalid:invalid?
  85                 if ($ipPort != 'invalid:invalid') {
  86                         // Get a search criteria instance
  87                         $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
  88
  89                         // Add 'sender' as the peer's IP address
  90                         $searchInstance->addCriteria(self::DB_COLUMN_PEER_IP, $ipPort);
  91                         $searchInstance->setLimit(1);
  92
  93                         // Count the query
  94                         $entries = $this->doSelectCountByCriteria($searchInstance);
  95
  96                         // Is it there?
  97                         $isNewPeer = ($entries === 0);
  98                 } // END - if
  99
 100                 // Return the result
 101                 return $isNewPeer;
 102         }
 103
 104         /**
 105          * Registers a new peer with given package data. We use the session id from it.
 106          *
 107          * @param       $packageData            Raw package data
 108          * @param       $socketResource         A valid socket resource
 109          * @return      void
 110          * @throws      PeerAlreadyRegisteredException  If a peer is already registered
 111          * @throws      InvalidSocketException  If the socket resource was invalid
 112          */
 113         public function registerPeerByPackageData (array $packageData, $socketResource) {
 114                 // Make sure only new peers can be registered with package data
 115                 if (!$this->isSenderNewPeer($packageData)) {
 116                         // Throw an exception because this should normally not happen
 117                         throw new PeerAlreadyRegisteredException(array($this, $packageData), self::EXCEPTION_PEER_ALREADY_REGISTERED);
 118                 } // END - if
 119
 120                 // Generate a dataset instance
 121                 $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_PEER_LOOKUP));
 122
 123                 // Session ids must be unique
 124                 $dataSetInstance->setUniqueKey(self::DB_COLUMN_PEER_SESSION_ID);
 125
 126                 // Add session id
 127                 $dataSetInstance->addCriteria(self::DB_COLUMN_PEER_SESSION_ID, $packageData[NetworkPackage::INDEX_PACKAGE_SENDER]);
 128
 129                 // Get peer name
 130                 if (!socket_getpeername($socketResource, $peerName, $peerPort)) {
 131                         // Get last error
 132                         $lastError = socket_last_error($socketResource);
 133
 134                         // Doesn't work!
 135                         throw new InvalidSocketException(array($this, gettype($socketResource), $lastError, socket_strerror($lastError)), BaseListener::EXCEPTION_INVALID_SOCKET);
 136                 } // END - if
 137
 138                 // Add ip address and port
 139                 $dataSetInstance->addCriteria(self::DB_COLUMN_PEER_IP  , $peerName);
 140                 $dataSetInstance->addCriteria(self::DB_COLUMN_PEER_PORT, $peerPort);
 141
 142                 // "Insert" the data set
 143                 $this->getDatabaseInstance()->queryInsertDataSet($dataSetInstance);
 144         }
 145
 146         /**
 147          * Purges old entries of given socket resource. We use the IP address from that resource.
 148          *
 149          * @param       $socketResource         A valid socket resource
 150          * @return      void
 151          * @throws      InvalidSocketException  If the socket resource was invalid
 152          */
 153         public function purgeOldEntriesBySocketResource ($socketResource) {
 154                 // Get peer name
 155                 if (!socket_getpeername($socketResource, $peerName, $peerPort)) {
 156                         // Get last error
 157                         $lastError = socket_last_error($socketResource);
 158
 159                         // Doesn't work!
 160                         throw new InvalidSocketException(array($this, gettype($socketResource), $lastError, socket_strerror($lastError)), BaseListener::EXCEPTION_INVALID_SOCKET);
 161                 } // END - if
 162         }
 163 }
 164
 165 // [EOF]
 166 ?>