application/hub/main/filter/tags/class_PackageAnnouncementTagFilter.php

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