3 * A helper class for announcing this node to other nodes
5 * @author Roland Haeder <webmaster@ship-simu.org>
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 * @todo Find an interface for hub helper
12 * This program is free software: you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation, either version 3 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 class HubAnnouncementHelper extends BaseHubHelper implements HelpableHub {
27 * Protected constructor
31 protected function __construct () {
32 // Call parent constructor
33 parent::__construct(__CLASS__);
36 $this->setRecipientType(NetworkPackage::NETWORK_TARGET_UPPER_NODES);
39 $this->setPackageTags(array('announcement'));
43 * Creates the helper class
45 * @return $helperInstance A prepared instance of this helper
47 public static final function createHubAnnouncementHelper () {
49 $helperInstance = new HubAnnouncementHelper();
51 // Return the prepared instance
52 return $helperInstance;
56 * Loads the announcement descriptor for parsing
60 public function loadDescriptorXml () {
62 self::createDebugInstance(__CLASS__)->debugOutput('HELPER: Starting with announcement to upper hubs...');
64 // Get a XML template instance
65 $templateInstance = XmlTemplateEngineFactory::createXmlTemplateEngineInstance('node_announcement_template_class');
67 // Set it for later use
68 $this->setTemplateInstance($templateInstance);
70 // Read the XML descriptor
71 $this->getTemplateInstance()->loadXmlTemplate();
73 // Render the XML content
74 $this->getTemplateInstance()->renderXmlContent();
78 * Publishes the node's descriptor XML to all found upper nodes when the
79 * node has not yet published it's descriptor to a bootstrap node. This is
80 * done by getting the raw XML content and inserting all variables into
81 * the code. After this wents fine, the rendered content got "packaged"
82 * for network delivery.
84 * @param $nodeInstance An instance of a NodeHelper class
87 public function sendPackage (NodeHelper $nodeInstance) {
88 // Sanity check: Is the node in the approx. state? (active)
89 $nodeInstance->getStateInstance()->validateNodeStateIsActiveOrReachable();
91 // Compile the template, this inserts the loaded node data into the gaps.
92 $this->getTemplateInstance()->compileTemplate();
94 // Get a singleton network package instance
95 $packageInstance = NetworkPackageFactory::createNetworkPackageInstance();
97 // Next, feed the content in. The network package class is a pipe-through class.
98 $packageInstance->enqueueRawDataFromTemplate($this, NetworkPackage::PROTOCOL_TCP);