5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Hub Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.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 BaseTags implements Tagable {
26 const EXCEPTION_INVALID_TAG = 0x160;
31 private $lastProtocol = 'invalid';
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 final static function createPackageTags () {
58 $tagsInstance = new PackageTags();
60 // Return the prepared instance
65 * Loads the XML file (our "object registry") and saves an instance for faster re-use
69 private function initObjectRegistry () {
70 // Output debug message
71 $this->debugOutput('TAGS: Initializing object registry - START');
73 // Get the application instance
74 $appInstance = Registry::getRegistry()->getInstance('app');
76 // Get a XML template instance
77 $templateInstance = ObjectFactory::createObjectByConfiguredName('object_registry_template_class', array($appInstance));
79 // Disable language support
80 $templateInstance->enableLanguageSupport(false);
83 * Enable compacting/rewriting of the XML to save bandwidth from XML
84 * comments. This is expensive and should be avoided in general.
86 $templateInstance->enableXmlCompacting();
88 // Set it for later use
89 $this->setTemplateInstance($templateInstance);
92 $this->getTemplateInstance()->loadObjectRegistryTemplate('object_registry');
94 // Render the XML content
95 $this->getTemplateInstance()->renderXmlContent();
97 // Output debug message
98 $this->debugOutput('TAGS: Initializing object registry - FINISHED');
102 * Extracts the tags from given package data
104 * @param $packageData Raw package data
107 private function extractTagsFromPackageData (array $packageData) {
109 * We take a look at the tags (in most cases only one is needed) so
110 * first we need the content data splitted up into all it's parts.
112 $contentData = explode(NetworkPackage::PACKAGE_MASK_SEPERATOR, $packageData['content']);
114 // Get the tags and store them locally
115 $this->setTags(explode(NetworkPackage::PACKAGE_TAGS_SEPERATOR, $contentData[NetworkPackage::INDEX_TAGS]));
119 * Verifies all tags by looking them up in an XML file. This method is
120 * the key method to make sure only known objects are being distributed and
121 * shared over the whole hub-network. So if the "tag" (let's better say
122 * object type) isn't found in that XML the package won't be distributed.
125 * @throws InvalidTagException If a provided tag from the package data is invalid
127 private function verifyAllTags () {
129 $objectRegistryInstance = ObjectFactory::createObjectByConfiguredName('object_type_registry_class');
131 // "Walk" over all tags
132 foreach ($this->getTags() as $tag) {
133 // Get an array from this tag
134 $entry = $objectRegistryInstance->getArrayFromKey($tag);
136 // If the array is empty, the entry is invalid!
137 if (count($entry) == 0) {
138 // Invalid entry found
139 throw new InvalidTagException(array($this, $tag), self::EXCEPTION_INVALID_TAG);
142 // Now save the last discovered protocol/recipient type
143 $this->lastProtocol = $entry['object-protocol'];
144 $this->lastRecipientType = $entry['object-recipient-type'];
149 * Chooses the right protocol from given package data
151 * @param $packageData Raw package data
152 * @return $protocolName Name of the choosen procotol
154 public function chooseProtocolFromPackageData (array $packageData) {
156 $this->extractTagsFromPackageData($packageData);
158 // Now we need to verify every single tag
159 $this->verifyAllTags();
161 // Use the last found protocol for transmission
162 $protocolName = $this->lastProtocol;
165 return $protocolName;
169 * Checks wether the given package data is accepted by the listener
171 * @param $packageData Raw package data
172 * @param $listenerInstance A Listenable instance
173 * @return $accepts Wether it is accepted
175 public function ifPackageDataIsAcceptedByListener (array $packageData, Listenable $listenerInstance) {
177 $this->extractTagsFromPackageData($packageData);
179 // Now we need to verify every single tag
180 $this->verifyAllTags();
182 // Now simply check it out
183 $accepts = (($this->lastRecipientType == $listenerInstance->getListenerType()) && ($listenerInstance->getListenerType() != 'invalid'));
185 // And return the result