3 * A database wrapper for peer state lookups
5 * @author Roland Haeder <webmaster@ship-simu.org>
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
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.
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.
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/>.
24 class PeerStateLookupDatabaseWrapper extends BaseDatabaseWrapper implements LookupablePeerState {
25 // Exception constants
26 const EXCEPTION_PEER_ALREADY_REGISTERED = 0x300;
28 // Constants for database table names
29 const DB_TABLE_PEER_LOOKUP = 'peer_states';
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';
40 * Protected constructor
44 protected function __construct () {
45 // Call parent constructor
46 parent::__construct(__CLASS__);
50 * Creates an instance of this database wrapper by a provided user class
52 * @return $wrapperInstance An instance of the created wrapper class
54 public static final function createPeerStateLookupDatabaseWrapper () {
56 $wrapperInstance = new PeerStateLookupDatabaseWrapper();
58 // Set (primary!) table name
59 $wrapperInstance->setTableName(self::DB_TABLE_PEER_LOOKUP);
61 // Return the instance
62 return $wrapperInstance;
66 * Getter for index key
68 * @return $indexKey Index key
70 public final function getIndexKey () {
71 return $this->getDatabaseInstance()->getIndexKey();
75 * Checks wether given 'sender' is a new peer
77 * @param $packageData Raw package data
78 * @param $dataSetInstance An optional instance of a StoreableCriteria class
79 * @return $isNewPeer Wether 'sender' is a new peer to this peer
81 public function isSenderNewPeer (array $packageData, StoreableCriteria $dataSetInstance = NULL) {
82 //* DEBUG: */ $this->debugOutput('DATABASE-WRAPPER: ' . __FUNCTION__ . ' called with packageData()=' . count($packageData) . ' - ENTERED!');
83 // Is always new peer by default
86 // Is the package valid?
87 if (!isset($packageData[NetworkPackage::PACKAGE_DATA_SENDER])) {
88 // Invalid package found, please report this
89 die(__METHOD__ . ': packageData=' . print_r($packageData, true));
92 // Get a search criteria instance
93 //* DEBUG: */ $this->debugOutput('DATABASE-WRAPPER: Searching for sender ' . $packageData[NetworkPackage::PACKAGE_DATA_SENDER]);
94 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
96 // Add 'sender' as the peer's IP address
97 $searchInstance->addCriteria(self::DB_COLUMN_PEER_SESSION_ID, $packageData[NetworkPackage::PACKAGE_DATA_SENDER]);
98 $searchInstance->setLimit(1);
100 // Is the dataset instance set?
101 if ($dataSetInstance instanceof StoreableCriteria) {
102 // Then remember the search instance in it
103 $dataSetInstance->setSearchInstance($searchInstance);
107 $entries = $this->doSelectCountByCriteria($searchInstance, array(self::DB_COLUMN_PEER_SESSION_ID => true));
110 //* DEBUG: */ $this->debugOutput('DATABASE-WRAPPER: entries=' . $entries);
111 $isNewPeer = ($entries != 1);
114 //* DEBUG: */ $this->debugOutput('DATABASE-WRAPPER: isNewPeer=' . intval($isNewPeer) . ' - EXIT!');
119 * Registers a new peer with given package data. We use the session id from it.
121 * @param $packageData Raw package data
122 * @param $socketResource A valid socket resource
124 * @throws PeerAlreadyRegisteredException If a peer is already registered
126 public function registerPeerByPackageData (array $packageData, $socketResource) {
127 // Make sure only new peers can be registered with package data
128 if (!$this->isSenderNewPeer($packageData)) {
129 // Throw an exception because this should normally not happen
130 throw new PeerAlreadyRegisteredException(array($this, $packageData), self::EXCEPTION_PEER_ALREADY_REGISTERED);
133 // Generate a dataset instance
134 $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_PEER_LOOKUP));
136 // Session ids must be unique
137 $dataSetInstance->setUniqueKey(self::DB_COLUMN_PEER_SESSION_ID);
140 $dataSetInstance->addCriteria(self::DB_COLUMN_PEER_SESSION_ID, $packageData[NetworkPackage::PACKAGE_DATA_SENDER]);
143 if (!@socket_getpeername($socketResource, $peerName, $peerPort)) {
145 $lastError = socket_last_error($socketResource);
147 // ... and cleartext message from it and put both into criteria
148 $dataSetInstance->addCriteria(self::DB_COLUMN_SOCKET_ERROR_CODE, $lastError);
149 $dataSetInstance->addCriteria(self::DB_COLUMN_SOCKET_ERROR_MSG , socket_strerror($lastError));
152 // Add ip address and port
153 $dataSetInstance->addCriteria(self::DB_COLUMN_PEER_IP , $peerName);
154 $dataSetInstance->addCriteria(self::DB_COLUMN_PEER_PORT, $peerPort);
156 // "Insert" the data set
157 $this->queryInsertDataSet($dataSetInstance, array(self::DB_COLUMN_PEER_SESSION_ID => true));
160 /* DEBUG: */ $this->debugOutput('DATABASE-WRAPPER: Peer ' . $packageData[NetworkPackage::PACKAGE_DATA_SENDER] . ' has been registered.');
164 * Registers the given peer state and raw package data
166 * @param $stateInstance A PeerStateable class instance
167 * @param $packageData Valid package data array
169 * @throws PeerAlreadyRegisteredException If a peer is already registered
170 * @todo Unfinished area
172 public function registerPeerState (PeerStateable $stateInstance, array $packageData) {
173 // Generate a dataset instance
174 $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_PEER_LOOKUP));
176 // Session ids must be unique
177 $dataSetInstance->setUniqueKey(self::DB_COLUMN_PEER_SESSION_ID);
180 $dataSetInstance->addCriteria(self::DB_COLUMN_PEER_SESSION_ID, $packageData[NetworkPackage::PACKAGE_DATA_SENDER]);
181 $dataSetInstance->addCriteria(self::DB_COLUMN_PEER_STATE, $stateInstance->getStateName());
183 // Try to resolve sender's session id
184 $senderData = explode(':', HubTools::resolveSessionId($packageData[NetworkPackage::PACKAGE_DATA_SENDER]));
186 // Just make sure that 'invalid:invalid' is not being processed
187 assert(($senderData[0] != 'invalid') && ($senderData[1] != 'invalid'));
189 // Add ip address and port
190 $dataSetInstance->addCriteria(self::DB_COLUMN_PEER_IP , $senderData[0]);
191 $dataSetInstance->addCriteria(self::DB_COLUMN_PEER_PORT, $senderData[1]);
193 // Is this a new peer?
194 if ($this->isSenderNewPeer($packageData, $dataSetInstance)) {
195 // "Insert" the data set
196 $this->queryInsertDataSet($dataSetInstance, array(self::DB_COLUMN_PEER_SESSION_ID => true));
198 // Update the data set
199 $this->queryUpdateDataSet($dataSetInstance, array(self::DB_COLUMN_PEER_SESSION_ID => true));
203 /* DEBUG: */ $this->debugOutput('DATABASE-WRAPPER: Peer ' . $packageData[NetworkPackage::PACKAGE_DATA_SENDER] . ' has been registered with state ' . $stateInstance->getStateName());
207 * Purges old entries of given socket resource. We use the IP address from that resource.
209 * @param $socketResource A valid socket resource
211 * @throws InvalidSocketException If the socket resource was invalid
212 * @todo Unfinished area
214 public function purgeOldEntriesBySocketResource ($socketResource) {
216 if (!@socket_getpeername($socketResource, $peerName, $peerPort)) {
218 $lastError = socket_last_error($socketResource);
221 throw new InvalidSocketException(array($this, gettype($socketResource), $lastError, socket_strerror($lastError)), BaseListener::EXCEPTION_INVALID_SOCKET);
224 $this->debugBackTrace('peerName=' . $peerName . ',peerPort=' . $peerPort . ' - UNFINISHED!');