<?php
/**
 * A Descriptor hub helper class
 *
 * @author		Roland Haeder <webmaster@ship-simu.org>
 * @version		0.0.0
 * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Hub Developer Team
 * @license		GNU GPL 3.0 or any newer version
 * @link		http://www.ship-simu.org
 * @todo		Find an interface for hub helper
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
class HubDescriptorHelper extends BaseHubHelper implements HelpableHub {
	/**
	 * An array with all tags for network packages
	 */
	private $packageTags = array('announcement');

	/**
	 * Protected constructor
	 *
	 * @return	void
	 */
	protected function __construct () {
		// Call parent constructor
		parent::__construct(__CLASS__);
	}

	/**
	 * Creates the helper class
	 *
	 * @param	$nodeInstance		An instance of a NodeHelper class
	 * @return	$helperInstance		A prepared instance of this helper
	 */
	public final static function createHubDescriptorHelper (NodeHelper $nodeInstance) {
		// Get new instance
		$helperInstance = new HubDescriptorHelper();

		// Set the node instance
		$helperInstance->setNodeInstance($nodeInstance);

		// Return the prepared instance
		return $helperInstance;
	}

	/**
	 * Loads the announcement descriptor for parsing
	 *
	 * @return	void
	 * @todo	Rewrite the ->renderXmlContent() call to no arguments
	 */
	public function loadDescriptorXml () {
		// Debug message
		$this->debugOutput('HELPER: Starting with announcement to upper hubs...');

		// Get the application instance
		$appInstance = Registry::getRegistry()->getInstance('app');

		// Get a XML template instance
		$templateInstance = ObjectFactory::createObjectByConfiguredName('announcement_template_class', array($appInstance));

		// Disable language support
		$templateInstance->enableLanguageSupport(false);

		/*
		 * Enable compacting/rewriting of the  XML to save bandwidth from XML
		 * comments. This is expensive and should be avoided in general.
		 */
		$templateInstance->enableXmlCompacting();

		// Set it for later use
		$this->setTemplateInstance($templateInstance);

		// Read the XML descriptor
		$this->getTemplateInstance()->loadAnnouncementTemplate('self_announcement');

		// Render the XML content
		$this->getTemplateInstance()->renderXmlContent();
	}

	/**
	 * Publishes the node's descriptor XML to all found upper nodes when the
	 * node has not yet published it's descriptor to a bootstrap node. This is
	 * done by getting the raw XML content and inserting all variables into
	 * the code. After this wents fine, the rendered content got "packaged"
	 * for network delivery.
	 *
	 * @return	void
	 */
	public function sendPackage () {
		// Sanity check: Is the node in the approx. state? (active)
		$this->getNodeInstance()->getStateInstance()->validateNodeStateIsActive();

		// Compile the template, this inserts the loaded node data into the gaps.
		$this->getTemplateInstance()->compileTemplate();

		// Get a singleton network package instance
		$packageInstance = NetworkPackageFactory::createNetworkPackageInstance();

		// Next, feed the content in. The network package class is a pipe-through class.
		$packageInstance->enqueueRawDataFromTemplate($this);
	}

	/**
	 * Getter for package tags in a simple array
	 *
	 * @return	$tags	An array with all tags for the currently handled package
	 */
	public final function getPackageTags () {
		return $this->packageTags;
	}
}

// [EOF]
?>