3 * A general message handler
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 BaseMessageHandler extends BaseHandler {
26 * Array with search criteria elements
28 private $searchData = array();
31 * Array with all data XML nodes (which hold the actual data) and their values
33 protected $messageDataElements = array();
36 * Protected constructor
38 * @param $className Name of the class
41 protected function __construct ($className) {
42 // Call parent constructor
43 parent::__construct($className);
46 $this->searchData = array(
47 XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID,
48 XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_IP,
49 XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_TCP_PORT
54 * Registers an other node with this node by given message data. The
55 * following data must always be present:
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)
61 * @param $messageArray An array with all minimum message data
64 protected function registerNodeByMessageData (array $messageData) {
65 // Get a wrapper instance
66 $wrapperInstance = ObjectFactory::createObjectByConfiguredName('node_list_db_wrapper_class');
68 // Get a search criteria class
69 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
71 // Search for the node's session id and external IP/hostname + TCP port
72 foreach ($this->searchData as $key) {
74 $searchInstance->addCriteria('node_' . $key, $messageData[$key]);
77 // Only one entry is fine
78 $searchInstance->setLimit(1);
81 $resultInstance = $wrapperInstance->doSelectByCriteria($searchInstance);
83 // Is there already an entry?
84 if ($resultInstance->next()) {
86 $resultInstance->debugBackTrace('Entry found!');
88 // Nothing found, so register it
89 $wrapperInstance->registerNodeByMessageData($messageData, $this);