3 * A generic filter for hub project
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 BaseHubFilter extends BaseFilter {
26 * Array with all data XML nodes (which hold the actual data) and their values
28 protected $dataXmlNodes = array();
31 * Protected constructor
33 * @param $className Real name of class
36 protected function __construct ($className) {
37 // Call parent constructor
38 parent::__construct($className);
42 * Processes the given raw message content. The method renderXmlContent
43 * may throw (not the method itself) several exceptions:
45 * InvalidXmlNodeException - If an invalid XML node has been found (e.g.
46 * wrong/out-dated template used)
47 * XmlNodeMismatchException - Again might be caused by invalid XML node
49 * XmlParserException - If the XML message is damaged or not
52 * @param $messageType Type of message
53 * @param $messageContent Raw message content
54 * @param $packageInstance An instance of a Receivable class
56 * @todo Exceptions from renderXmlContent() are currently unhandled
58 protected function genericProcessMessage ($messageType, $messageContent, Receivable $packageInstance) {
59 // Get a template instance from the factory
60 $templateInstance = XmlTemplateEngineFactory::createXmlTemplateEngineInstance('node_' . $messageType . '_template_class');
62 // And render the XML content (aka message)
63 $templateInstance->renderXmlContent($messageContent);
66 * The template system now stores all required data as 'general'
67 * variables, so simply get them. If there is an invalid XML node
68 * inside the message, the above method call will cause exceptions.
70 foreach ($this->dataXmlNodes as $key => $dummy) {
72 $value = $templateInstance->readXmlData($key);
75 * If value is NULL, a variable hasn't been found. This could mean
76 * that *this* node is running an out-dated software or the other
77 * peer is using an out-dated $messageType.xml template.
79 if (is_null($value)) {
81 self::createDebugInstance(__CLASS__)->debugOutput(str_replace('_', '-', strtoupper($messageType)) . '-TAG: Found not fully supported variable ' . $key . ' - skipping.');
83 // Skip this part, don't write NULLs to the array
88 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(str_replace('_', '-', strtoupper($messageType)) . '-TAG: key=' . $key . ',value=' . $value);
91 $this->dataXmlNodes[$key] = $value;
94 // Construct an array for pushing it on next stack
95 $messageArray = array(
96 // Message data itself
97 NetworkPackage::MESSAGE_ARRAY_DATA => $this->dataXmlNodes,
98 // Message type (which is $messageType)
99 NetworkPackage::MESSAGE_ARRAY_TYPE => $messageType
102 // Push the processed message back on stack
103 $packageInstance->getStackerInstance()->pushNamed(NetworkPackage::STACKER_NAME_PROCESSED_MESSAGE, $messageArray);