3 * A database wrapper for node list
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 NodeListDatabaseWrapper extends BaseDatabaseWrapper implements Registerable {
26 const DB_TABLE_NODE_LIST = 'node_list';
28 // Constants for column name
29 const DB_COLUMN_NODE_SESSION_ID = 'node_session_id';
30 const DB_COLUMN_NODE_IP_PORT = 'node_ipport';
33 const INVALID_IP_PORT = 'invalid:invalid';
36 * Protected constructor
40 protected function __construct () {
41 // Call parent constructor
42 parent::__construct(__CLASS__);
46 * Creates an instance of this database wrapper by a provided user class
48 * @return $wrapperInstance An instance of the created wrapper class
50 public static final function createNodeListDatabaseWrapper () {
52 $wrapperInstance = new NodeListDatabaseWrapper();
54 // Set (primary!) table name
55 $wrapperInstance->setTableName(self::DB_TABLE_NODE_LIST);
57 // Return the instance
58 return $wrapperInstance;
62 * Resolves a session id into an ip:port combination
64 * @param $sessionId A valid session id
65 * @return $recipient Recipient as ip:port combination
67 public function resolveIpPortBySessionId ($sessionId) {
68 // Set invalid ip:port combination
69 $recipient = self::INVALID_IP_PORT;
71 // Now get a search criteria instance
72 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
74 // Search for the node session id
75 $searchInstance->addCriteria(NodeListDatabaseWrapper::DB_COLUMN_NODE_SESSION_ID, $sessionId);
76 $searchInstance->setLimit(1);
79 $resultInstance = $this->doSelectByCriteria($searchInstance);
82 if ($resultInstance->next()) {
83 // Save the result instance in this class
84 $this->setResultInstance($resultInstance);
86 // Get the node id from result and set it
87 $recipient = $this->getField(NodeListDatabaseWrapper::DB_COLUMN_NODE_IP_PORT);
95 * Resolves a ip:port combination into a session id
97 * @param $ipPort Ip:port combination
98 * @return $sessionId A valid session id
100 public function resolveSessionIdByIpPort ($ipPort) {
101 // Set invalid session id as default
102 $sessionId = 'invalid';
104 // Now get a search criteria instance
105 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
107 // Search for the node session id
108 $searchInstance->addCriteria(NodeListDatabaseWrapper::DB_COLUMN_NODE_IP_PORT, $ipPort);
109 $searchInstance->setLimit(1);
112 $resultInstance = $this->doSelectByCriteria($searchInstance);
115 if ($resultInstance->next()) {
116 // Save the result instance in this class
117 $this->setResultInstance($resultInstance);
119 // Get the session from result
120 $sessionId = $this->getField(NodeListDatabaseWrapper::DB_COLUMN_NODE_SESSION_ID);