3 * A AnnouncementAnswerTag filter for Package
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 PackageAnnouncementAnswerTagFilter extends BaseFilter implements FilterablePackage {
26 * Array with all data XML nodes (which hold the actual data) and their values
28 private $dataXmlNodes = array();
31 * Protected constructor
35 protected function __construct () {
36 // Call parent constructor
37 parent::__construct(__CLASS__);
40 $this->dataXmlNodes = array(
41 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_IP => '',
42 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_INTERNAL_IP => '',
43 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_NODE_STATUS => '',
44 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID => '',
45 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_TCP_PORT => 9060,
46 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_UDP_PORT => 9060,
47 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_ANSWER_STATUS => '',
52 * Creates an instance of this filter class
54 * @return $filterInstance An instance of this filter class
56 public final static function createPackageAnnouncementAnswerTagFilter () {
58 $filterInstance = new PackageAnnouncementAnswerTagFilter();
60 // Return the instance
61 return $filterInstance;
65 * Executes the filter with given request and response objects
67 * @param $requestInstance An instance of a class with an Requestable interface
68 * @param $responseInstance An instance of a class with an Responseable interface
70 * @throws UnsupportedOperationException If this method is called, please use processMessage() instead!
72 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
73 // Please don't call this method
74 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
78 * Processes the given raw message content. The method renderXmlContent
79 * may throw (not the method itself) several exceptions:
81 * InvalidXmlNodeException - If an invalid XML node has been found (e.g.
82 * wrong/out-dated template used)
83 * XmlNodeMismatchException - Again might be caused by invalid XML node
85 * XmlParserException - If the XML message is damaged or not
88 * @param $messageContent Raw message content
89 * @param $packageInstance An instance of a Receivable class
91 * @todo Exceptions from renderXmlContent() are currently unhandled
93 public function processMessage ($messageContent, Receivable $packageInstance) {
95 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('ANNOUNCEMENT-ANSWER-TAG: messageContent(' . strlen($messageContent) . ')=' . $messageContent);
97 // Get a template instance from the factory
98 $templateInstance = XmlTemplateEngineFactory::createXmlTemplateEngineInstance('node_announcement_answer_template_class');
100 // And render the XML content (aka message)
101 $templateInstance->renderXmlContent($messageContent);
104 * The template system now stores all required data as 'general'
105 * variables, so simply get them. If there is an invalid XML node
106 * inside the message, the above method call will cause exceptions.
108 foreach ($this->dataXmlNodes as $key => $dummy) {
109 // Get the variable from template engine
110 $value = $templateInstance->readAnnouncementAnswerData($key);
113 * If value is NULL, a variable hasn't been found. This could mean
114 * that *this* node is running an out-dated software or the other
115 * peer is using an out-dated announcement_answer.xml template.
117 if (is_null($value)) {
119 self::createDebugInstance(__CLASS__)->debugOutput('ANNOUNCEMENT-ANSWER-TAG: Found not fully supported variable ' . $key . ' - skipping.');
121 // Skip this part, don't write NULLs to the array
126 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('ANNOUNCEMENT-ANSWER-TAG: key=' . $key . ',value=' . $value);
129 $this->dataXmlNodes[$key] = $value;
132 // Construct an array for pushing it on next stack
133 $messageArray = array(
134 // Message data itself
135 NetworkPackage::MESSAGE_ARRAY_DATA => $this->dataXmlNodes,
136 // Message type (which is 'announcement')
137 NetworkPackage::MESSAGE_ARRAY_TYPE => 'announcement_answer'
140 // Push the processed message back on stack
141 $packageInstance->getStackerInstance()->pushNamed(NetworkPackage::STACKER_NAME_PROCESSED_MESSAGE, $messageArray);