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 * Protected constructor
38 protected function __construct () {
39 // Call parent constructor
40 parent::__construct(__CLASS__);
42 // Init the object registry
43 $this->initObjectRegistry();
47 * Creates an instance of this class
49 * @return $tagsInstance An instance of a Tagable class
51 public final static function createPackageTags () {
53 $tagsInstance = new PackageTags();
55 // Return the prepared instance
60 * Loads the XML file (our "object registry") and saves an instance for faster re-use
64 private function initObjectRegistry () {
65 // Output debug message
66 $this->debugOutput('TAGS: Initializing object registry - START');
68 // Get the application instance
69 $appInstance = Registry::getRegistry()->getInstance('app');
71 // Get a XML template instance
72 $templateInstance = ObjectFactory::createObjectByConfiguredName('object_registry_template_class', array($appInstance));
74 // Disable language support
75 $templateInstance->enableLanguageSupport(false);
78 * Enable compacting/rewriting of the XML to save bandwidth from XML
79 * comments. This is expensive and should be avoided in general.
81 $templateInstance->enableXmlCompacting();
83 // Set it for later use
84 $this->setTemplateInstance($templateInstance);
87 $this->getTemplateInstance()->loadObjectRegistryTemplate('object_registry');
89 // Render the XML content
90 $this->getTemplateInstance()->renderXmlContent();
92 // Output debug message
93 $this->debugOutput('TAGS: Initializing object registry - FINISHED');
97 * Extracts the tags from given package data
99 * @param $packageData Raw package data
102 private function extractTagsFromPackageData (array $packageData) {
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_SEPERATOR, $packageData['content']);
109 // Get the tags and store them locally
110 $this->setTags(explode(NetworkPackage::PACKAGE_TAGS_SEPERATOR, $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.
120 * @throws InvalidTagException If a provided tag from the package data is invalid
122 private function verifyAllTags () {
124 $objectRegistryInstance = ObjectFactory::createObjectByConfiguredName('object_type_registry_class');
126 // "Walk" over all tags
127 foreach ($this->getTags() as $tag) {
128 // Get an array from this tag
129 $entry = $objectRegistryInstance->getArrayFromKey($tag);
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);
137 // Now save the last discovered protocol
138 $this->lastProtocol = $entry['object-protocol'];
143 * Chooses the right protocol from given package data
145 * @param $packageData Raw package data
146 * @return $protocolName Name of the choosen procotol
148 public function chooseProtocolFromPackageData (array $packageData) {
150 $this->extractTagsFromPackageData($packageData);
152 // Now we need to verify every single tag
153 $this->verifyAllTags();
155 // Use the last found protocol for transmission
156 $protocolName = $this->lastProtocol;
159 return $protocolName;