5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.org
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.
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.
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/>.
24 class PackageTags extends BaseTag implements Tagable {
26 const EXCEPTION_INVALID_TAG = 0x160;
29 * Last found protocol instance
31 private $lastProtocol = NULL;
34 * Last found recipient type
36 private $lastRecipientType = 'invalid';
39 * Protected constructor
43 protected function __construct () {
44 // Call parent constructor
45 parent::__construct(__CLASS__);
47 // Init the object registry
48 $this->initObjectRegistry();
52 * Creates an instance of this class
54 * @return $tagsInstance An instance of a Tagable class
56 public static final function createPackageTags () {
58 $tagsInstance = new PackageTags();
60 // Return the prepared instance
65 * Loads the XML file (our "object registry") and saves an instance for
70 private function initObjectRegistry () {
71 // Output debug message
72 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('TAGS[' . __METHOD__ . ':' . __LINE__ . ']: Initializing object registry - CALLED!');
74 // Get the application instance
75 $applicationInstance = Registry::getRegistry()->getInstance('app');
77 // Get a XML template instance
78 $templateInstance = XmlTemplateEngineFactory::createXmlTemplateEngineInstance('node_object_registry_template_class');
80 // Set it for later use
81 $this->setTemplateInstance($templateInstance);
84 $this->getTemplateInstance()->loadXmlTemplate();
86 // Render the XML content
87 $this->getTemplateInstance()->renderXmlContent();
89 // Output debug message
90 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('TAGS[' . __METHOD__ . ':' . __LINE__ . ']: Initializing object registry - EXIT!');
94 * Extracts the tags from given package data
96 * @param $packageData Raw package data
99 private function extractTagsFromPackageData (array $packageData) {
101 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('TAGS[' . __METHOD__ . ':' . __LINE__ . ']: packageData=' . print_r($packageData, TRUE));
104 * We take a look at the tags (in most cases only one is needed) so
105 * first we need the content data splitted up into all it's parts.
107 $contentData = explode(NetworkPackage::PACKAGE_MASK_SEPARATOR, $packageData[NetworkPackage::PACKAGE_DATA_CONTENT]);
109 // Get the tags and store them locally
110 $this->setTags(explode(NetworkPackage::PACKAGE_TAGS_SEPARATOR, $contentData[NetworkPackage::INDEX_TAGS]));
114 * Verifies all tags by looking them up in an XML file. This method is
115 * the key method to make sure only known objects are being distributed and
116 * shared over the whole hub-network. So if the "tag" (let's better say
117 * object type) isn't found in that XML the package won't be distributed.
119 * @param $packageData Raw package data
121 * @throws InvalidTagException If a provided tag from the package data is invalid
123 private function verifyAllTags (array $packageData) {
125 $objectRegistryInstance = ObjectTypeRegistryFactory::createObjectTypeRegistryInstance();
127 // "Walk" over all tags
128 foreach ($this->getTags() as $tag) {
130 self::createDebugInstance(__CLASS__)->debugOutput('TAGS[' . __METHOD__ . ':' . __LINE__ . ']: Validating tag ' . $tag . ' ...');
132 // Get an array from this tag
133 $entry = $objectRegistryInstance->getArrayFromKey(XmlObjectRegistryTemplateEngine::OBJECT_TYPE_DATA_NAME, $tag);
136 * If it is no array or the array is empty or an entry is missing
137 * the entry is invalid.
139 if ((!is_array($entry)) || (count($entry) == 0) || (!isset($entry[XmlObjectRegistryTemplateEngine::OBJECT_TYPE_DATA_PROTOCOL])) || (!isset($entry[XmlObjectRegistryTemplateEngine::OBJECT_TYPE_DATA_RECIPIENT_TYPE]))) {
140 // Invalid entry found
141 throw new InvalidTagException(array($this, $tag), self::EXCEPTION_INVALID_TAG);
144 // Now save the last discovered protocol/recipient type
145 $this->lastProtocol = ProtocolHandlerFactory::createProtocolHandlerFromPackageData($packageData);
146 $this->lastRecipientType = $entry[XmlObjectRegistryTemplateEngine::OBJECT_TYPE_DATA_RECIPIENT_TYPE];
151 * Chooses the right protocol from given package data
153 * @param $packageData Raw package data
154 * @return $lastProtocol An instance of the last used HandleableProtocol class
156 public function chooseProtocolFromPackageData (array $packageData) {
158 $this->extractTagsFromPackageData($packageData);
160 // Now we need to verify every single tag
161 $this->verifyAllTags($packageData);
163 // Return the last (and only) found protocol (e.g. 'tcp' is very usual)
164 return $this->lastProtocol;
168 * Checks whether the given package data is accepted by the listener
170 * @param $packageData Raw package data
171 * @param $listenerInstance A Listenable instance
172 * @return $accepts Whether it is accepted
174 public function ifPackageDataIsAcceptedByListener (array $packageData, Listenable $listenerInstance) {
176 $this->extractTagsFromPackageData($packageData);
178 // Now we need to verify every single tag
179 $this->verifyAllTags($packageData);
181 // Now simply check it out
182 $accepts = (($this->lastRecipientType == $listenerInstance->getListenerType()) && ($listenerInstance->getListenerType() != 'invalid'));
184 // And return the result