application/hub/main/handler/message-types/class_BaseMessageHandler.php

   1 <?php
   2 /**
   3  * A general message handler
   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 BaseMessageHandler extends BaseHandler {
  25         /**
  26          * Array with search criteria elements
  27          */
  28         private $searchData = array();
  29
  30         /**
  31          * Array with all data XML nodes (which hold the actual data) and their values
  32          */
  33         protected $messageDataElements = array();
  34
  35         /**
  36          * Protected constructor
  37          *
  38          * @param       $className      Name of the class
  39          * @return      void
  40          */
  41         protected function __construct ($className) {
  42                 // Call parent constructor
  43                 parent::__construct($className);
  44
  45                 // Init array
  46                 $this->searchData = array(
  47                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID,
  48                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_IP,
  49                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_TCP_PORT
  50                 );
  51         }
  52
  53         /**
  54          * Registers an other node with this node by given message data. The
  55          * following data must always be present:
  56          *
  57          * - session-id  (for finding the node's record together with below data)
  58          * - external-ip (hostname or IP number)
  59          * - tcp-port    (TCP port for inbound connections)
  60          *
  61          * @param       $messageArray   An array with all minimum message data
  62          * @return      void
  63          */
  64         protected function registerNodeByMessageData (array $messageData) {
  65                 // Get a wrapper instance
  66                 $wrapperInstance = ObjectFactory::createObjectByConfiguredName('node_list_db_wrapper_class');
  67
  68                 // Get a search criteria class
  69                 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
  70
  71                 // Search for the node's session id and external IP/hostname + TCP port
  72                 foreach ($this->searchData as $key) {
  73                         // Add criteria
  74                         $searchInstance->addCriteria('node_' . $key, $messageData[$key]);
  75                 } // END - foreach
  76
  77                 // Only one entry is fine
  78                 $searchInstance->setLimit(1);
  79
  80                 // Run the query
  81                 $resultInstance = $wrapperInstance->doSelectByCriteria($searchInstance);
  82
  83                 // Is there already an entry?
  84                 if ($resultInstance->next()) {
  85                         // Entry found
  86                         $resultInstance->debugBackTrace('Entry found!');
  87                 } else {
  88                         // Nothing found, so register it
  89                         $wrapperInstance->registerNodeByMessageData($messageData, $this);
  90                 }
  91         }
  92
  93         /**
  94          * Prepares a message as answer for given message data for delivery.
  95          *
  96          * @param       $messageData            An array with all message data
  97          * @param       $packageInstance        An instance of a Deliverable instance
  98          * @return      void
  99          */
 100         protected function prepareAnswerMessage (array $messageData, Deliverable $packageInstance) {
 101                 // Get a helper instance based on this handler's name
 102                 $helperInstance = ObjectFactory::createObjectByConfiguredName('node_answer_' . $this->getHandlerName() . '_helper_class', array($messageData));
 103
 104                 // Load descriptor XML
 105                 $helperInstance->loadDescriptorXml();
 106
 107                 // Compile any configuration variables
 108                 $helperInstance->getTemplateInstance()->compileConfigInVariables();
 109
 110                 // Get node instance
 111                 $nodeInstance = Registry::getRegistry()->getInstance('node');
 112
 113                 // Deliver the package
 114                 $helperInstance->sendPackage($nodeInstance);
 115         }
 116 }
 117
 118 // [EOF]
 119 ?>