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, 2010 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 {
25 // Constants for database table names
26 const DB_TABLE_PEER_LOOKUP = 'peer_states';
28 // Constants for database column names
29 const DB_COLUMN_PEER_IP = 'peer_ip';
32 * Protected constructor
36 protected function __construct () {
37 // Call parent constructor
38 parent::__construct(__CLASS__);
42 * Creates an instance of this database wrapper by a provided user class
44 * @return $wrapperInstance An instance of the created wrapper class
46 public final static function createPeerStateLookupDatabaseWrapper () {
48 $wrapperInstance = new PeerStateLookupDatabaseWrapper();
50 // Set (primary!) table name
51 $wrapperInstance->setTableName(self::DB_TABLE_PEER_LOOKUP);
53 // Return the instance
54 return $wrapperInstance;
58 * Getter for index key
60 * @return $indexKey Index key
62 public final function getIndexKey () {
63 return $this->getDatabaseInstance()->getIndexKey();
67 * Checks wether given 'sender' is a new peer
69 * @param $packageData Raw package data
70 * @return $isNewPeer Wether 'sender' is a new peer to this node
72 public function isSenderNewPeer (array $packageData) {
73 // Is always new peer by default
76 // Remove session id > IP:port
77 $ipPort = HubTools::resolveSessionId($packageData[NetworkPackage::INDEX_PACKAGE_SENDER]);
79 // Is it not invalid:invalid?
80 if ($ipPort != 'invalid:invalid') {
81 // Get a search criteria instance
82 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
84 // Add 'sender' as the peer's IP address
85 $searchInstance->addCriteria(self::DB_COLUMN_PEER_IP, $ipPort);
86 $searchInstance->setLimit(1);
89 $entries = $this->doSelectCountByCriteria($searchInstance);
92 $isNewPeer = ($entries === 0);