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 - 2012 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 a LocalSearchCriteria from given package data's sender
68 * @param $packageData Valid raw package data array
69 * @return $searchInstance An instance of a LocalSearchCriteria class
71 private function getSenderSearchInstanceFromPackageData (array $packageData) {
73 //* NOISY-DEBUG: */ $this->debugOutput('DATABASE-WRAPPER: Searching for sender ' . $packageData[NetworkPackage::PACKAGE_DATA_SENDER]);
74 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
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);
80 // Return the instance
81 return $searchInstance;
85 * Checks whether given 'sender' is a new peer
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
91 public function isSenderNewPeer (array $packageData, StoreableCriteria $dataSetInstance = NULL) {
93 //* NOISY-DEBUG: */ $this->debugOutput('DATABASE-WRAPPER: ' . __FUNCTION__ . ' called with packageData()=' . count($packageData) . ' - ENTERED!');
95 // Is always new peer by default
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));
104 // Get a search criteria instance from package data
105 $searchInstance = $this->getSenderSearchInstanceFromPackageData($packageData);
107 // Is the dataset instance set?
108 if ($dataSetInstance instanceof StoreableCriteria) {
109 // Then remember the search instance in it
110 $dataSetInstance->setSearchInstance($searchInstance);
114 $entries = $this->doSelectCountByCriteria($searchInstance, array(self::DB_COLUMN_PEER_SESSION_ID => true));
117 //* NOISY-DEBUG: */ $this->debugOutput('DATABASE-WRAPPER: entries=' . $entries);
118 $isNewPeer = ($entries != 1);
121 //* NOISY-DEBUG: */ $this->debugOutput('DATABASE-WRAPPER: isNewPeer=' . intval($isNewPeer) . ' - EXIT!');
126 * Registers a new peer with given package data. We use the session id from it.
128 * @param $packageData Raw package data
129 * @param $socketResource A valid socket resource
131 * @throws PeerAlreadyRegisteredException If a peer is already registered
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);
140 // Generate a dataset instance
141 $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_PEER_LOOKUP));
143 // Session ids must be unique
144 $dataSetInstance->setUniqueKey(self::DB_COLUMN_PEER_SESSION_ID);
147 $dataSetInstance->addCriteria(self::DB_COLUMN_PEER_SESSION_ID, $packageData[NetworkPackage::PACKAGE_DATA_SENDER]);
150 if (!socket_getpeername($socketResource, $peerName, $peerPort)) {
152 $lastError = socket_last_error($socketResource);
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));
159 // Add ip address and port
160 $dataSetInstance->addCriteria(self::DB_COLUMN_PEER_IP , $peerName);
161 $dataSetInstance->addCriteria(self::DB_COLUMN_PEER_PORT, $peerPort);
163 // "Insert" the data set
164 $this->queryInsertDataSet($dataSetInstance, array(self::DB_COLUMN_PEER_SESSION_ID => true));
167 //* NOISY-DEBUG: */ $this->debugOutput('DATABASE-WRAPPER: Peer ' . $packageData[NetworkPackage::PACKAGE_DATA_SENDER] . ' has been registered.');
171 * Registers the given peer state and raw package data
173 * @param $stateInstance A PeerStateable class instance
174 * @param $packageData Valid package data array
176 * @throws PeerAlreadyRegisteredException If a peer is already registered
177 * @todo Unfinished area
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));
183 // Session ids must be unique
184 $dataSetInstance->setUniqueKey(self::DB_COLUMN_PEER_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());
190 // Try to resolve sender's session id
191 $senderData = explode(':', HubTools::resolveSessionId($packageData[NetworkPackage::PACKAGE_DATA_SENDER], $packageData[NetworkPackage::PACKAGE_DATA_PROTOCOL]));
193 // Just make sure that 'invalid:invalid' is not being processed
194 assert(($senderData[0] != 'invalid') && ($senderData[1] != 'invalid'));
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]);
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));
205 // Update the data set
206 $this->queryUpdateDataSet($dataSetInstance, array(self::DB_COLUMN_PEER_SESSION_ID => true));
210 //* NOISY-DEBUG: */ $this->debugOutput('DATABASE-WRAPPER: Peer ' . $packageData[NetworkPackage::PACKAGE_DATA_SENDER] . ' has been registered/updated with state ' . $stateInstance->getStateName());
214 * Purges old entries of given socket resource. We use the IP address from that resource.
216 * @param $socketResource A valid socket resource
218 * @throws InvalidSocketException If the socket resource was invalid
219 * @todo Unfinished area
221 public function purgeOldEntriesBySocketResource ($socketResource) {
223 if (!socket_getpeername($socketResource, $peerName, $peerPort)) {
225 $lastError = socket_last_error($socketResource);
228 throw new InvalidSocketException(array($this, $socketResource, $lastError, socket_strerror($lastError)), BaseListener::EXCEPTION_INVALID_SOCKET);
232 //* NOISY-DEBUG: */ $this->debugOutput('DATABASE-WRAPPER: peerName=' . $peerName . ',peerPort=' . $peerPort . ' - UNFINISHED!');
236 * Checks whether a given peer state (in helper instance) is same as stored
237 * in database compared with the one from $helperInstance.
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
243 public function isSamePeerState (ConnectionHelper $helperInstance, array $packageData) {
245 //* NOISY-DEBUG: */ $this->debugOutput('DATABASE-WRAPPER: State ' . $helperInstance->getPrintableState() . ' needs to be checked it has changed ...');
247 // Now get the search instance from given package data
248 $searchInstance = $this->getSenderSearchInstanceFromPackageData($packageData);
250 // With this search instance query the database for the peer and get a result instance
251 $resultInstance = $this->doSelectByCriteria($searchInstance);
253 // Do we have an entry? This should always the case
254 assert($resultInstance->next());
256 // Yes, so get the current (=first) entry from it
257 $rowData = $resultInstance->current();
259 // Now just compare it with given state from helper instance
260 $isSamePeerState = ($rowData[self::DB_COLUMN_PEER_STATE] == $helperInstance->getPrintableState());
263 //* NOISY-DEBUG: */ $this->debugOutput('DATABASE-WRAPPER: state in database: ' . $rowData[self::DB_COLUMN_PEER_STATE] . ', new state: ' . $helperInstance->getPrintableState() . ',isSamePeerState=' . intval($isSamePeerState));
266 return $isSamePeerState;