application/hub/main/database/wrapper/node/class_NodeListDatabaseWrapper.php

   1 <?php
   2 /**
   3  * A database wrapper for node list
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   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
  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 NodeListDatabaseWrapper extends BaseDatabaseWrapper implements NodeListWrapper, Registerable {
  25         // Table names
  26         const DB_TABLE_NODE_LIST = 'node_list';
  27
  28         // Table columns
  29         const DB_COLUMN_ANSWER_STATUS = 'last_answer_status';
  30         const DB_COLUMN_MESSAGE_TYPE  = 'last_message_type';
  31
  32         // Other constants
  33         const INVALID_IP_PORT = 'invalid:invalid';
  34
  35         /**
  36          * Protected constructor
  37          *
  38          * @return      void
  39          */
  40         protected function __construct () {
  41                 // Call parent constructor
  42                 parent::__construct(__CLASS__);
  43         }
  44
  45         /**
  46          * Creates an instance of this database wrapper by a provided user class
  47          *
  48          * @return      $wrapperInstance        An instance of the created wrapper class
  49          */
  50         public static final function createNodeListDatabaseWrapper () {
  51                 // Get a new instance
  52                 $wrapperInstance = new NodeListDatabaseWrapper();
  53
  54                 // Set (primary!) table name
  55                 $wrapperInstance->setTableName(self::DB_TABLE_NODE_LIST);
  56
  57                 // Return the instance
  58                 return $wrapperInstance;
  59         }
  60
  61         /**
  62          * Resolves a session id into an ip:port combination
  63          *
  64          * @param       $sessionId      A valid session id
  65          * @param       $protocol       Name of the protocol (TCP/UDP)
  66          * @return      $recipient      Recipient as ip:port combination
  67          */
  68         public function resolveIpPortBySessionId ($sessionId, $protocol) {
  69                 // Set invalid ip:port combination
  70                 $recipient = self::INVALID_IP_PORT;
  71
  72                 // Now get a search criteria instance
  73                 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
  74
  75                 // Search for the node session id
  76                 $searchInstance->addCriteria('node_' . XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID, $sessionId);
  77                 $searchInstance->setLimit(1);
  78
  79                 // Get a result back
  80                 $resultInstance = $this->doSelectByCriteria($searchInstance);
  81
  82                 // Is it valid?
  83                 if ($resultInstance->next()) {
  84                         // Save the result instance in this class
  85                         $this->setResultInstance($resultInstance);
  86
  87                         // Get the node id from result and set it
  88                         $recipientIp   = $this->getField('node_' . XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_IP);
  89
  90                         // Which protocol?
  91                         switch ($protocol) {
  92                                 case NetworkPackage::PROTOCOL_TCP: // Transmission Control Protocol has been used
  93                                         $recipientPort = $this->getField('node_' . XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_TCP_PORT);
  94                                         break;
  95
  96                                 case NetworkPackage::PROTOCOL_UDP: // User Datagram Protocol has been used
  97                                         $recipientPort = $this->getField('node_' . XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_UDP_PORT);
  98                                         break;
  99
 100                                 default: // Unsupported protocol detected!
 101                                         $this->debugBackTrace('Unsupported protocol ' . $protocol . ' specified!');
 102                                         break;
 103                         } // END - switch
 104
 105                         // Now put both together
 106                         $recipient = $recipientIp . ':' . $recipientPort;
 107
 108                         // Debug message
 109                         self::createDebugInstance(__CLASS__)->debugOutput('DATABASE-WRAPPER: sessionId[' . $protocol . ']=' . $sessionId . ' resolved as recipient=' . $recipient);
 110                 } // END - if
 111
 112                 // Return result
 113                 return $recipient;
 114         }
 115
 116         /**
 117          * Resolves a ip:port combination into a session id
 118          *
 119          * @param       $ipPort         Ip:port combination
 120          * @param       $protocol       Name of the used protocol (TCP/UDP)
 121          * @return      $sessionId      A valid session id
 122          */
 123         public function resolveSessionIdByIpPort ($ipPort, $protocol) {
 124                 // Set invalid session id as default
 125                 $sessionId = 'invalid';
 126
 127                 // Split ip:port
 128                 $ipPortArray = explode(':', $ipPort);
 129
 130                 // Now get a search criteria instance
 131                 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
 132
 133                 // Search for the node session id
 134                 $searchInstance->addCriteria('node_' . XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_IP, $ipPortArray[0]);
 135
 136                 // Which protocol?
 137                 switch ($protocol) {
 138                         case NetworkPackage::PROTOCOL_TCP: // Transmission Control Procol has been used
 139                                 $searchInstance->addCriteria('node_' . XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_TCP_PORT, $ipPortArray[1]);
 140                                 break;
 141
 142                         case NetworkPackage::PROTOCOL_UDP: // User Datagram Protocol has been used
 143                                 $searchInstance->addCriteria('node_' . XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_UDP_PORT, $ipPortArray[1]);
 144                                 break;
 145
 146                         default: // Unsupported protocol detected!
 147                                 $this->debugBackTrace('Unsupported protocol ' . $protocol . ' specified!');
 148                                 break;
 149                 } // END - switch
 150
 151                 // Only one record
 152                 $searchInstance->setLimit(1);
 153
 154                 // Get a result back
 155                 $resultInstance = $this->doSelectByCriteria($searchInstance);
 156
 157                 // Is it valid?
 158                 if ($resultInstance->next()) {
 159                         // Save the result instance in this class
 160                         $this->setResultInstance($resultInstance);
 161
 162                         // Get the session from result
 163                         $sessionId = $this->getField('node_' . XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID);
 164                 } // END - if
 165
 166                 // Return result
 167                 return $sessionId;
 168         }
 169
 170         /**
 171          * Registeres a node by given message data.
 172          *
 173          * @param       $messageData            An array of all message data
 174          * @param       $handlerInstance        An instance of a HandleableMessage class
 175          * @return      void
 176          */
 177         public function registerNodeByMessageData (array $messageData, Handleable $handlerInstance) {
 178                 // Get a data set instance
 179                 $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_NODE_LIST));
 180
 181                 // Set primary key (session id)
 182                 $dataSetInstance->setUniqueKey('node_' . XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID);
 183
 184                 // Add all array elements
 185                 $handlerInstance->addArrayToDataSet($dataSetInstance, $messageData);
 186
 187                 // Run the "INSERT" query
 188                 $this->queryInsertDataSet($dataSetInstance);
 189         }
 190
 191         /**
 192          * Updates an existing entry in node list
 193          *
 194          * @param       $messageData            An array of all message data
 195          * @param       $handlerInstance        An instance of a HandleableMessage class
 196          * @param       $searchInstance         An instance of LocalSearchCriteria class
 197          * @return      void
 198          */
 199         public function updateNodeByMessageData (array $messageData, Handleable $handlerInstance, LocalSearchCriteria $searchInstance) {
 200                 // Get a data set instance
 201                 $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_NODE_LIST));
 202
 203                 // Add search instance
 204                 $dataSetInstance->setSearchInstance($searchInstance);
 205
 206                 // Set primary key (session id)
 207                 $dataSetInstance->setUniqueKey('node_' . XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID);
 208
 209                 // Add all array elements
 210                 $handlerInstance->addArrayToDataSet($dataSetInstance, $messageData);
 211
 212                 // Run the "UPDATE" query
 213                 $this->queryUpdateDataSet($dataSetInstance);
 214         }
 215 }
 216
 217 // [EOF]
 218 ?>