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

   1 <?php
   2 /**
   3  * A SelfConnectTag 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 PackageSelfConnectTagFilter 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                         XmlSelfConnectTemplateEngine::SELF_CONNECT_DATA_NODE_ID    => '',
  42                         XmlSelfConnectTemplateEngine::SELF_CONNECT_DATA_SESSION_ID => '',
  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 createPackageSelfConnectTagFilter () {
  52                 // Get a new instance
  53                 $filterInstance = new PackageSelfConnectTagFilter();
  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                 // Get a template instance from the factory
  90                 $templateInstance = XmlTemplateEngineFactory::createXmlTemplateEngineInstance('node_self_connect_template_class');
  91
  92                 // And render the XML content (aka message)
  93                 $templateInstance->renderXmlContent($messageContent);
  94
  95                 /*
  96                  * The template system now stores all required data as 'general'
  97                  * variables, so simply get them. If there is an invalid XML node
  98                  * inside the message, the above method call will cause exceptions.
  99                  */
 100                 foreach ($this->dataXmlNodes as $key => $dummy) {
 101                         // Get the variable from template engine
 102                         $value = $templateInstance->readSelfConnectData($key);
 103
 104                         /*
 105                          * If value is NULL, a variable hasn't been found. This could mean
 106                          * that *this* node is running an out-dated software or the other
 107                          * peer is using an out-dated self_connect.xml template.
 108                          */
 109                         if (is_null($value)) {
 110                                 // Output a warning
 111                                 $this->debugOutput('SELF-CONNECT-TAG: Found not fully supported variable ' . $key . ' - skipping.');
 112
 113                                 // Skip this part, don't write NULLs to the array
 114                                 continue;
 115                         } // END - if
 116
 117                         // Debug message
 118                         //* NOISY-DEBUG: */ $this->debugOutput('SELF-CONNECT-TAG: key=' . $key . ',value=' . $value);
 119
 120                         // Set it now
 121                         $this->dataXmlNodes[$key] = $value;
 122                 } // END - foreach
 123
 124                 // Construct an array for pushing it on next stack
 125                 $messageArray = array(
 126                         // Message data itself
 127                         NetworkPackage::MESSAGE_ARRAY_DATA => $this->dataXmlNodes,
 128                         // Message type (which is 'self_connect')
 129                         NetworkPackage::MESSAGE_ARRAY_TYPE => 'self_connect'
 130                 );
 131
 132                 // Push the processed message back on stack
 133                 $packageInstance->getStackerInstance()->pushNamed(NetworkPackage::STACKER_NAME_PROCESSED_MESSAGE, $messageArray);
 134         }
 135 }
 136
 137 // [EOF]
 138 ?>