application/hub/main/tags/package/class_PackageTags.php

   1 <?php
   2 /**
   3  * A Package tags class
   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 PackageTags extends BaseTags implements Tagable {
  25         // Exception codes
  26         const EXCEPTION_INVALID_TAG = 0x160;
  27
  28         /**
  29          * Last found protocol
  30          */
  31         private $lastProtocol = 'invalid';
  32
  33         /**
  34          * Last found recipient type
  35          */
  36         private $lastRecipientType = 'invalid';
  37
  38         /**
  39          * Protected constructor
  40          *
  41          * @return      void
  42          */
  43         protected function __construct () {
  44                 // Call parent constructor
  45                 parent::__construct(__CLASS__);
  46
  47                 // Init the object registry
  48                 $this->initObjectRegistry();
  49         }
  50
  51         /**
  52          * Creates an instance of this class
  53          *
  54          * @return      $tagsInstance   An instance of a Tagable class
  55          */
  56         public static final function createPackageTags () {
  57                 // Get new instance
  58                 $tagsInstance = new PackageTags();
  59
  60                 // Return the prepared instance
  61                 return $tagsInstance;
  62         }
  63
  64         /**
  65          * Loads the XML file (our "object registry") and saves an instance for
  66          * faster re-use.
  67          *
  68          * @return      void
  69          */
  70         private function initObjectRegistry () {
  71                 // Output debug message
  72                 self::createDebugInstance(__CLASS__)->debugOutput('TAGS[' . __LINE__ . ']: Initializing object registry - START');
  73
  74                 // Get the application instance
  75                 $applicationInstance = Registry::getRegistry()->getInstance('app');
  76
  77                 // Get a XML template instance
  78                 $templateInstance = XmlTemplateEngineFactory::createXmlTemplateEngineInstance('node_object_registry_template_class');
  79
  80                 // Set it for later use
  81                 $this->setTemplateInstance($templateInstance);
  82
  83                 // Read the XML file
  84                 $this->getTemplateInstance()->loadXmlTemplate();
  85
  86                 // Render the XML content
  87                 $this->getTemplateInstance()->renderXmlContent();
  88
  89                 // Output debug message
  90                 self::createDebugInstance(__CLASS__)->debugOutput('TAGS[' . __LINE__ . ']: Initializing object registry - FINISHED');
  91         }
  92
  93         /**
  94          * Extracts the tags from given package data
  95          *
  96          * @param       $packageData    Raw package data
  97          * @return      void
  98          */
  99         private function extractTagsFromPackageData (array $packageData) {
 100                 /*
 101                  * We take a look at the tags (in most cases only one is needed) so
 102                  * first we need the content data splitted up into all it's parts.
 103                  */
 104                 $contentData = explode(NetworkPackage::PACKAGE_MASK_SEPARATOR, $packageData[NetworkPackage::PACKAGE_DATA_CONTENT]);
 105
 106                 // Get the tags and store them locally
 107                 $this->setTags(explode(NetworkPackage::PACKAGE_TAGS_SEPARATOR, $contentData[NetworkPackage::INDEX_TAGS]));
 108         }
 109
 110         /**
 111          * Verifies all tags by looking them up in an XML file. This method is
 112          * the key method to make sure only known objects are being distributed and
 113          * shared over the whole hub-network. So if the "tag" (let's better say
 114          * object type) isn't found in that XML the package won't be distributed.
 115          *
 116          * @return      void
 117          * @throws      InvalidTagException             If a provided tag from the package data is invalid
 118          */
 119         private function verifyAllTags () {
 120                 // Get the registry
 121                 $objectRegistryInstance = ObjectTypeRegistryFactory::createObjectTypeRegistryInstance();
 122
 123                 // "Walk" over all tags
 124                 foreach ($this->getTags() as $tag) {
 125                         // Debug output
 126                         self::createDebugInstance(__CLASS__)->debugOutput('TAGS[' . __LINE__ . ']: Validating tag ' . $tag . ' ...');
 127
 128                         // Get an array from this tag
 129                         $entry = $objectRegistryInstance->getArrayFromKey(XmlObjectRegistryTemplateEngine::OBJECT_TYPE_DATA_NAME, $tag);
 130
 131                         // If the array is empty, the entry is invalid!
 132                         if (count($entry) == 0) {
 133                                 // Invalid entry found
 134                                 throw new InvalidTagException(array($this, $tag), self::EXCEPTION_INVALID_TAG);
 135                         } // END - if
 136
 137                         // Now save the last discovered protocol/recipient type
 138                         $this->lastProtocol      = $entry[XmlObjectRegistryTemplateEngine::OBJECT_TYPE_DATA_PROTOCOL];
 139                         $this->lastRecipientType = $entry[XmlObjectRegistryTemplateEngine::OBJECT_TYPE_DATA_RECIPIENT_TYPE];
 140                 } // END - foreach
 141         }
 142
 143         /**
 144          * Chooses the right protocol from given package data
 145          *
 146          * @param       $packageData    Raw package data
 147          * @return      $protocolName   Name of the choosen procotol
 148          */
 149         public function chooseProtocolFromPackageData (array $packageData) {
 150                 // Extract the tags
 151                 $this->extractTagsFromPackageData($packageData);
 152
 153                 // Now we need to verify every single tag
 154                 $this->verifyAllTags();
 155
 156                 // Use the last found protocol for transmission
 157                 $protocolName = $this->lastProtocol;
 158
 159                 // Return it
 160                 return $protocolName;
 161         }
 162
 163         /**
 164          * Checks whether the given package data is accepted by the listener
 165          *
 166          * @param       $packageData            Raw package data
 167          * @param       $listenerInstance       A Listenable instance
 168          * @return      $accepts                        Whether it is accepted
 169          */
 170         public function ifPackageDataIsAcceptedByListener (array $packageData, Listenable $listenerInstance) {
 171                 // Extract the tags
 172                 $this->extractTagsFromPackageData($packageData);
 173
 174                 // Now we need to verify every single tag
 175                 $this->verifyAllTags();
 176
 177                 // Now simply check it out
 178                 $accepts = (($this->lastRecipientType == $listenerInstance->getListenerType()) && ($listenerInstance->getListenerType() != 'invalid'));
 179
 180                 // And return the result
 181                 return $accepts;
 182         }
 183 }
 184
 185 // [EOF]
 186 ?>