application/hub/main/filter/tags/answer/class_PackageAnnouncementAnswerTagFilter.php

   1 <?php
   2 /**
   3  * A AnnouncementAnswerTag filter for Package
   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 PackageAnnouncementAnswerTagFilter extends BaseNodeFilter implements FilterablePackage {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33
  34                 // Init array
  35                 $this->dataXmlNodes = array(
  36                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_IP   => '',
  37                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_INTERNAL_IP   => '',
  38                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_NODE_STATUS   => '',
  39                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID    => '',
  40                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_TCP_PORT      => 9060,
  41                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_UDP_PORT      => 9060,
  42                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_ANSWER_STATUS => '',
  43                 );
  44         }
  45
  46         /**
  47          * Creates an instance of this filter class
  48          *
  49          * @return      $filterInstance         An instance of this filter class
  50          */
  51         public final static function createPackageAnnouncementAnswerTagFilter () {
  52                 // Get a new instance
  53                 $filterInstance = new PackageAnnouncementAnswerTagFilter();
  54
  55                 // Return the instance
  56                 return $filterInstance;
  57         }
  58
  59         /**
  60          * Executes the filter with given request and response objects
  61          *
  62          * @param       $requestInstance        An instance of a class with an Requestable interface
  63          * @param       $responseInstance       An instance of a class with an Responseable interface
  64          * @return      void
  65          * @throws      UnsupportedOperationException   If this method is called, please use processMessage() instead!
  66          */
  67         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  68                 // Please don't call this method
  69                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
  70         }
  71
  72         /**
  73          * Processes the given raw message content. The method renderXmlContent
  74          * may throw (not the method itself) several exceptions:
  75          *
  76          * InvalidXmlNodeException  - If an invalid XML node has been found (e.g.
  77          *                            wrong/out-dated template used)
  78          * XmlNodeMismatchException - Again might be caused by invalid XML node
  79          *                            usage
  80          * XmlParserException       - If the XML message is damaged or not
  81          *                            well-formed
  82          *
  83          * @param       $messageContent         Raw message content
  84          * @param       $packageInstance        An instance of a Receivable class
  85          * @return      void
  86          * @todo        Exceptions from renderXmlContent() are currently unhandled
  87          */
  88         public function processMessage ($messageContent, Receivable $packageInstance) {
  89                 // Debug message
  90                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('ANNOUNCEMENT-ANSWER-TAG: messageContent(' . strlen($messageContent) . ')=' . $messageContent);
  91
  92                 // Get a template instance from the factory
  93                 $templateInstance = XmlTemplateEngineFactory::createXmlTemplateEngineInstance('node_announcement_answer_template_class');
  94
  95                 // And render the XML content (aka message)
  96                 $templateInstance->renderXmlContent($messageContent);
  97
  98                 /*
  99                  * The template system now stores all required data as 'general'
 100                  * variables, so simply get them. If there is an invalid XML node
 101                  * inside the message, the above method call will cause exceptions.
 102                  */
 103                 foreach ($this->dataXmlNodes as $key => $dummy) {
 104                         // Get the variable from template engine
 105                         $value = $templateInstance->readAnnouncementAnswerData($key);
 106
 107                         /*
 108                          * If value is NULL, a variable hasn't been found. This could mean
 109                          * that *this* node is running an out-dated software or the other
 110                          * peer is using an out-dated announcement_answer.xml template.
 111                          */
 112                         if (is_null($value)) {
 113                                 // Output a warning
 114                                 self::createDebugInstance(__CLASS__)->debugOutput('ANNOUNCEMENT-ANSWER-TAG: Found not fully supported variable ' . $key . ' - skipping.');
 115
 116                                 // Skip this part, don't write NULLs to the array
 117                                 continue;
 118                         } // END - if
 119
 120                         // Debug message
 121                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('ANNOUNCEMENT-ANSWER-TAG: key=' . $key . ',value=' . $value);
 122
 123                         // Set it now
 124                         $this->dataXmlNodes[$key] = $value;
 125                 } // END - foreach
 126
 127                 // Construct an array for pushing it on next stack
 128                 $messageArray = array(
 129                         // Message data itself
 130                         NetworkPackage::MESSAGE_ARRAY_DATA => $this->dataXmlNodes,
 131                         // Message type (which is 'announcement')
 132                         NetworkPackage::MESSAGE_ARRAY_TYPE => 'announcement_answer'
 133                 );
 134
 135                 // Push the processed message back on stack
 136                 $packageInstance->getStackerInstance()->pushNamed(NetworkPackage::STACKER_NAME_PROCESSED_MESSAGE, $messageArray);
 137         }
 138 }
 139
 140 // [EOF]
 141 ?>