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