From 3063bcd88a9ce09b88064593e890cfe5fc9f2204 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Roland=20H=C3=A4der?= Date: Thu, 17 Jun 2010 16:03:21 +0000 Subject: [PATCH] Self-connect continued (still broken), some code moved to generic classes to encapsulate it --- .gitattributes | 3 + application/hub/config.php | 17 +- .../console/class_HubConsoleMainCommand.php | 2 +- .../main/discovery/class_BaseHubDiscovery.php | 61 +++ .../class_PackageRecipientDiscovery.php | 16 +- .../socket/class_PackageSocketDiscovery.php | 15 +- .../class_HubDescriptorHelper.php | 5 +- application/hub/main/helper/hub/class_ | 3 + .../main/helper/hub/class_BaseHubHelper.php | 23 ++ .../connection/class_HubSelfConnectHelper.php | 50 ++- .../hub/main/nodes/class_BaseHubNode.php | 4 +- .../hub/main/package/class_NetworkPackage.php | 7 +- .../main/tags/package/class_PackageTags.php | 3 + .../class_AnnouncementTemplateEngine.php | 2 +- .../hub/main/template/connect/.htaccess | 1 + .../class_SelfConnectTemplateEngine.php | 378 ++++++++++++++++++ .../xml/object_registry/object_registry.xml | 31 +- .../hub/templates/xml/self_connect/.htaccess | 1 + .../xml/self_connect/self_connect.xml | 32 ++ 19 files changed, 627 insertions(+), 27 deletions(-) create mode 100644 application/hub/main/discovery/class_BaseHubDiscovery.php create mode 100644 application/hub/main/template/connect/.htaccess create mode 100644 application/hub/main/template/connect/class_SelfConnectTemplateEngine.php create mode 100644 application/hub/templates/xml/self_connect/.htaccess create mode 100644 application/hub/templates/xml/self_connect/self_connect.xml diff --git a/.gitattributes b/.gitattributes index 28c2795ef..09963e53d 100644 --- a/.gitattributes +++ b/.gitattributes @@ -322,6 +322,7 @@ application/hub/main/tasks/network/.htaccess -text application/hub/main/template/.htaccess -text application/hub/main/template/announcement/.htaccess -text application/hub/main/template/announcement/class_AnnouncementTemplateEngine.php -text +application/hub/main/template/connect/.htaccess -text application/hub/main/template/objects/.htaccess -text application/hub/main/tools/.htaccess -text application/hub/main/visitor/.htaccess -text @@ -347,6 +348,8 @@ application/hub/templates/xml/node/.htaccess -text application/hub/templates/xml/node/node_status.xml -text application/hub/templates/xml/object_registry/.htaccess -text application/hub/templates/xml/object_registry/object_registry.xml -text +application/hub/templates/xml/self_connect/.htaccess -text +application/hub/templates/xml/self_connect/self_connect.xml -text /clear-cache.sh -text db/.htaccess -text db/news/.htaccess -text diff --git a/application/hub/config.php b/application/hub/config.php index a96da58c2..57c648ba9 100644 --- a/application/hub/config.php +++ b/application/hub/config.php @@ -207,6 +207,18 @@ $cfg->setConfigEntry('announcement_template_type', 'xml/announcement'); // CFG: ANNOUNCEMENT-STACKER-CLASS $cfg->setConfigEntry('announcement_stacker_class', 'FiLoStacker'); +// CFG: SELF-CONNECT-TEMPLATE-CLASS +$cfg->setConfigEntry('self_connect_template_class', 'SelfConnectTemplateEngine'); + +// CFG: SELF-CONNECT-TEMPLATE-EXTENSION +$cfg->setConfigEntry('self_connect_template_extension', '.xml'); + +// CFG: SELF-CONNECT-TEMPLATE-TYPE +$cfg->setConfigEntry('self_connect_template_type', 'xml/self_connect'); + +// CFG: SELF-CONNECT-STACKER-CLASS +$cfg->setConfigEntry('self_connect_stacker_class', 'FiLoStacker'); + // CFG: OBJECT-REGISTRY-TEMPLATE-CLASS $cfg->setConfigEntry('object_registry_template_class', 'ObjectRegistryTemplateEngine'); @@ -223,7 +235,7 @@ $cfg->setConfigEntry('object_registry_stacker_class', 'FiLoStacker'); $cfg->setConfigEntry('object_type_registry_class', 'ObjectTypeRegistry'); // CFG: CODE-TEMPLATE-TYPE -$cfg->setConfigEntry('code_template_type', 'xml/announcement'); +$cfg->setConfigEntry('code_template_type', 'xml'); // CFG: PACKAGE-STACKER-CLASS $cfg->setConfigEntry('package_stacker_class', 'FiFoStacker'); @@ -231,6 +243,9 @@ $cfg->setConfigEntry('package_stacker_class', 'FiFoStacker'); // CFG: STACKER-ANNOUNCEMENT-MAX-SIZE $cfg->setConfigEntry('stacker_announcement_max_size', 20); +// CFG: STACKER-SELF-CONNECT-MAX-SIZE +$cfg->setConfigEntry('stacker_self_connect_max_size', 10); + // CFG: STACKER-UNDECLARED-MAX-SIZE $cfg->setConfigEntry('stacker_undeclared_max_size', 10000); diff --git a/application/hub/main/commands/console/class_HubConsoleMainCommand.php b/application/hub/main/commands/console/class_HubConsoleMainCommand.php index fcbc20254..9b4ff4f70 100644 --- a/application/hub/main/commands/console/class_HubConsoleMainCommand.php +++ b/application/hub/main/commands/console/class_HubConsoleMainCommand.php @@ -72,7 +72,7 @@ class HubConsoleMainCommand extends BaseCommand implements Commandable { // Get node instance $nodeInstance = Registry::getRegistry()->getInstance('node'); - // Add some node-specific filters, e.g. self-announcement + // Add some node-specific filters, e.g. announcement $nodeInstance->addExtraHubFilters(); // -------------------------- Hub activation -------------------------- diff --git a/application/hub/main/discovery/class_BaseHubDiscovery.php b/application/hub/main/discovery/class_BaseHubDiscovery.php new file mode 100644 index 000000000..2706b4aad --- /dev/null +++ b/application/hub/main/discovery/class_BaseHubDiscovery.php @@ -0,0 +1,61 @@ + + * @version 0.0.0 + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Core Developer Team + * @license GNU GPL 3.0 or any newer version + * @link http://www.ship-simu.org + * + * 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 . + */ +class BaseHubDiscovery extends BaseDiscovery { + /** + * Protected constructor + * + * @param $className Real class name + * @return void + */ + protected function __construct ($className) { + // Call parent constructor + parent::__construct($className); + } + + /** + * Determines the protoctol name + * + * @param $packageData Valid package data + * @return $protocolName Name of used protocol (TCP/UDP/etc.) + */ + protected function determineProtocolByPackageData (array $packageData) { + // First we need a tags instance + $tagsInstance = PackageTagsFactory::createPackageTagsInstance(); + + /* + * We need to decide here which socket (TCP or UDP) should be used for + * the actual data transmission. In this process we will find out if + * the recipient of this package has already a known (registered) socket + * and if so we can re-use it. If there is no socket registered, we try + * to make a new connection (TCP or UDP) to the given IP:port. + */ + $protocolName = $tagsInstance->chooseProtocolFromPackageData($packageData); + + // Return it + return $protocolName; + } +} + +// [EOF] +?> diff --git a/application/hub/main/discovery/package/class_PackageRecipientDiscovery.php b/application/hub/main/discovery/package/class_PackageRecipientDiscovery.php index 6cf473d2a..ad062049d 100644 --- a/application/hub/main/discovery/package/class_PackageRecipientDiscovery.php +++ b/application/hub/main/discovery/package/class_PackageRecipientDiscovery.php @@ -21,7 +21,7 @@ * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ -class PackageRecipientDiscovery extends BaseDiscovery implements DiscoverableRecipient, Registerable { +class PackageRecipientDiscovery extends BaseHubDiscovery implements DiscoverableRecipient, Registerable { /** * Protected constructor * @@ -69,9 +69,21 @@ class PackageRecipientDiscovery extends BaseDiscovery implements DiscoverableRec } // END - foreach break; + // The target 'self' is always the external IP address! + case NetworkPackage::NETWORK_TARGET_SELF: + // Determine own external ip by connecting to my (coder) server at 217.172.186.31 + $ip = ConsoleTools::determineExternalIp(); + + // Get port and add it + $ipPort = $ip . ':' . $this->getConfigInstance()->getConfigEntry('node_' . $this->determineProtocolByPackageData($packageData) . '_listen_port'); + + // Add it to the list + $listInstance->addEntry('ip_port', $ipPort); + break; + // This may be a direct recipient (hub's session id) default: - $this->partialStub('Please add code handling direct recipients.'); + $this->partialStub('Please add code handling recipients ' . $packageData['recipient']); break; } // END - switch } diff --git a/application/hub/main/discovery/socket/class_PackageSocketDiscovery.php b/application/hub/main/discovery/socket/class_PackageSocketDiscovery.php index 4492ca9f6..fb5b2b2a7 100644 --- a/application/hub/main/discovery/socket/class_PackageSocketDiscovery.php +++ b/application/hub/main/discovery/socket/class_PackageSocketDiscovery.php @@ -21,7 +21,7 @@ * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ -class PackageSocketDiscovery extends BaseDiscovery implements DiscoverableSocket, Registerable { +class PackageSocketDiscovery extends BaseHubDiscovery implements DiscoverableSocket, Registerable { /** * Protected constructor * @@ -91,17 +91,8 @@ class PackageSocketDiscovery extends BaseDiscovery implements DiscoverableSocket * @throws NoListGroupException If the procol group is not found in peer list */ public function discoverSocket (array $packageData) { - // First we need a tags instance - $tagsInstance = PackageTagsFactory::createPackageTagsInstance(); - - /* - * We need to decide here which socket (TCP or UDP) should be used for - * the actual data transmission. In this process we will find out if - * the recipient of this package has already a known (registered) socket - * and if so we can re-use it. If there is no socket registered, we try - * to make a new connection (TCP or UDP) to the given IP:port. - */ - $protocolName = $tagsInstance->chooseProtocolFromPackageData($packageData); + // Determine protocol name + $protocolName = $this->determineProtocolByPackageData($packageData); // Get the listener instance $listenerInstance = $this->discoverListenerInstance($protocolName, $packageData); diff --git a/application/hub/main/helper/hub/announcement/class_HubDescriptorHelper.php b/application/hub/main/helper/hub/announcement/class_HubDescriptorHelper.php index 6f9cbaa80..63970e330 100644 --- a/application/hub/main/helper/hub/announcement/class_HubDescriptorHelper.php +++ b/application/hub/main/helper/hub/announcement/class_HubDescriptorHelper.php @@ -36,6 +36,9 @@ class HubDescriptorHelper extends BaseHubHelper implements HelpableHub { protected function __construct () { // Call parent constructor parent::__construct(__CLASS__); + + // Set recipient type + $this->setRecipientType(NetworkPackage::NETWORK_TARGET_UPPER_HUBS); } /** @@ -84,7 +87,7 @@ class HubDescriptorHelper extends BaseHubHelper implements HelpableHub { $this->setTemplateInstance($templateInstance); // Read the XML descriptor - $this->getTemplateInstance()->loadAnnouncementTemplate('self_announcement'); + $this->getTemplateInstance()->loadAnnouncementTemplate(); // Render the XML content $this->getTemplateInstance()->renderXmlContent(); diff --git a/application/hub/main/helper/hub/class_ b/application/hub/main/helper/hub/class_ index 934cf239b..e8efbe6df 100644 --- a/application/hub/main/helper/hub/class_ +++ b/application/hub/main/helper/hub/class_ @@ -31,6 +31,9 @@ class Hub???Helper extends BaseHubHelper implements HelpableHub { protected function __construct () { // Call parent constructor parent::__construct(__CLASS__); + + // Set recipient type + $this->setRecipientType(NetworkPackage::NETWORK_TARGET_!!!); } /** diff --git a/application/hub/main/helper/hub/class_BaseHubHelper.php b/application/hub/main/helper/hub/class_BaseHubHelper.php index 1803959d0..a27bbdc79 100644 --- a/application/hub/main/helper/hub/class_BaseHubHelper.php +++ b/application/hub/main/helper/hub/class_BaseHubHelper.php @@ -22,6 +22,11 @@ * along with this program. If not, see . */ class BaseHubHelper extends BaseHubSystem { + /** + * Recipient type + */ + private $recipientType = 'invalid'; + /** * Protected constructor * @@ -32,6 +37,24 @@ class BaseHubHelper extends BaseHubSystem { // Call parent constructor parent::__construct($className); } + + /** + * Setter for recipient type + * + * @return $recipientType Type of a recipient (the helper is made for) + */ + protected final function setRecipientType ($recipientType) { + $this->recipientType = $recipientType; + } + + /** + * Getter for recipient type + * + * @return $recipientType Type of a recipient (the helper is made for) + */ + public final function getRecipientType () { + return $this->recipientType; + } } // [EOF] diff --git a/application/hub/main/helper/hub/connection/class_HubSelfConnectHelper.php b/application/hub/main/helper/hub/connection/class_HubSelfConnectHelper.php index 9f333fe21..33289725a 100644 --- a/application/hub/main/helper/hub/connection/class_HubSelfConnectHelper.php +++ b/application/hub/main/helper/hub/connection/class_HubSelfConnectHelper.php @@ -23,6 +23,11 @@ * along with this program. If not, see . */ class HubSelfConnectHelper extends BaseHubHelper implements HelpableHub { + /** + * Package tags + */ + private $packageTags = array('self_connect'); + /** * Protected constructor * @@ -31,17 +36,24 @@ class HubSelfConnectHelper extends BaseHubHelper implements HelpableHub { protected function __construct () { // Call parent constructor parent::__construct(__CLASS__); + + // Set recipient type + $this->setRecipientType(NetworkPackage::NETWORK_TARGET_SELF); } /** * Creates the helper class * + * @param $nodeInstance An instance of a NodeHelper class * @return $helperInstance A prepared instance of this helper */ - public final static function createHubSelfConnectHelper () { + public final static function createHubSelfConnectHelper (NodeHelper $nodeInstance) { // Get new instance $helperInstance = new HubSelfConnectHelper(); + // Set the node instance + $helperInstance->setNodeInstance($nodeInstance); + // Return the prepared instance return $helperInstance; } @@ -52,7 +64,32 @@ class HubSelfConnectHelper extends BaseHubHelper implements HelpableHub { * @return void */ public function loadDescriptorXml () { - $this->partialStub('Please implement this method.'); + // Debug message + $this->debugOutput('HELPER: Attempting self-connect...'); + + // Get the application instance + $appInstance = Registry::getRegistry()->getInstance('app'); + + // Get a XML template instance + $templateInstance = ObjectFactory::createObjectByConfiguredName('self_connect_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()->loadSelfConnectTemplate(); + + // Render the XML content + $this->getTemplateInstance()->renderXmlContent(); } /** @@ -73,6 +110,15 @@ class HubSelfConnectHelper extends BaseHubHelper implements HelpableHub { // 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] diff --git a/application/hub/main/nodes/class_BaseHubNode.php b/application/hub/main/nodes/class_BaseHubNode.php index c5090f789..b83b93c97 100644 --- a/application/hub/main/nodes/class_BaseHubNode.php +++ b/application/hub/main/nodes/class_BaseHubNode.php @@ -459,7 +459,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable { } // END - if // Debug output - $this->debugOutput('HUB: Self Announcement: START (taskInstance=' . $taskInstance->__toString(). ')'); + $this->debugOutput('HUB: Announcement: START (taskInstance=' . $taskInstance->__toString(). ')'); // Get a helper instance $helperInstance = ObjectFactory::createObjectByConfiguredName('hub_announcement_helper_class', array($this)); @@ -480,7 +480,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable { $this->getStateInstance()->nodeAnnouncedToUpperHubs(); // Debug output - $this->debugOutput('HUB: Self Announcement: FINISHED'); + $this->debugOutput('HUB: Announcement: FINISHED'); } /** diff --git a/application/hub/main/package/class_NetworkPackage.php b/application/hub/main/package/class_NetworkPackage.php index 5c7f05194..dd634f3ad 100644 --- a/application/hub/main/package/class_NetworkPackage.php +++ b/application/hub/main/package/class_NetworkPackage.php @@ -94,6 +94,11 @@ class NetworkPackage extends BaseFrameworkSystem implements Deliverable, Registe */ const NETWORK_TARGET_UPPER_HUBS = 'upper'; + /** + * Network target (alias): 'self' + */ + const NETWORK_TARGET_SELF = 'self'; + /** * Protected constructor * @@ -283,7 +288,7 @@ class NetworkPackage extends BaseFrameworkSystem implements Deliverable, Registe // Now prepare the temporary array and push it on the 'undeclared' stack $this->getStackerInstance()->pushNamed(self::STACKER_NAME_UNDECLARED, array( 'sender' => $helperInstance->getNodeInstance()->getSessionId(), - 'recipient' => self::NETWORK_TARGET_UPPER_HUBS, + 'recipient' => $helperInstance->getRecipientType(), 'content' => $content, )); } diff --git a/application/hub/main/tags/package/class_PackageTags.php b/application/hub/main/tags/package/class_PackageTags.php index f0c0ee59e..510c59b57 100644 --- a/application/hub/main/tags/package/class_PackageTags.php +++ b/application/hub/main/tags/package/class_PackageTags.php @@ -130,6 +130,9 @@ class PackageTags extends BaseTags implements Tagable { // "Walk" over all tags foreach ($this->getTags() as $tag) { + // Debug output + $this->debugOutput('TAGS: Validating tag ' . $tag . ' ...'); + // Get an array from this tag $entry = $objectRegistryInstance->getArrayFromKey($tag); diff --git a/application/hub/main/template/announcement/class_AnnouncementTemplateEngine.php b/application/hub/main/template/announcement/class_AnnouncementTemplateEngine.php index 76c399b64..102d7e089 100644 --- a/application/hub/main/template/announcement/class_AnnouncementTemplateEngine.php +++ b/application/hub/main/template/announcement/class_AnnouncementTemplateEngine.php @@ -135,7 +135,7 @@ class AnnouncementTemplateEngine extends BaseTemplateEngine implements Compileab * located in 'announcement' by default * @return void */ - public function loadAnnouncementTemplate ($template) { + public function loadAnnouncementTemplate ($template = 'self_announcement') { // Set template type $this->setTemplateType($this->getConfigInstance()->getConfigEntry('announcement_template_type')); diff --git a/application/hub/main/template/connect/.htaccess b/application/hub/main/template/connect/.htaccess new file mode 100644 index 000000000..3a4288278 --- /dev/null +++ b/application/hub/main/template/connect/.htaccess @@ -0,0 +1 @@ +Deny from all diff --git a/application/hub/main/template/connect/class_SelfConnectTemplateEngine.php b/application/hub/main/template/connect/class_SelfConnectTemplateEngine.php new file mode 100644 index 000000000..f4c874438 --- /dev/null +++ b/application/hub/main/template/connect/class_SelfConnectTemplateEngine.php @@ -0,0 +1,378 @@ + + * @version 0.0.0 + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Core Developer Team + * @license GNU GPL 3.0 or any newer version + * @link http://www.ship-simu.org + * @todo This template engine does not make use of setTemplateType() + * + * 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 . + */ +class SelfConnectTemplateEngine extends BaseTemplateEngine implements CompileableTemplate { + /** + * Main nodes in the XML tree ('menu' is ignored) + */ + private $mainNodes = array( + 'self-connect', + ); + + /** + * Sub nodes in the XML tree + */ + private $subNodes = array( + 'self-connect-data', + 'node-id', + 'session-id' + ); + + /** + * Current main node + */ + private $curr = array(); + + /** + * Content from dependency + */ + private $dependencyContent = array(); + + /** + * Protected constructor + * + * @return void + */ + protected function __construct () { + // Call parent constructor + parent::__construct(__CLASS__); + } + + /** + * Creates an instance of the class TemplateEngine and prepares it for usage + * + * @param $appInstance A manageable application + * @return $templateInstance An instance of TemplateEngine + * @throws BasePathIsEmptyException If the provided $templateBasePath is empty + * @throws InvalidBasePathStringException If $templateBasePath is no string + * @throws BasePathIsNoDirectoryException If $templateBasePath is no + * directory or not found + * @throws BasePathReadProtectedException If $templateBasePath is + * read-protected + */ + public final static function createSelfConnectTemplateEngine (ManageableApplication $appInstance) { + // Get a new instance + $templateInstance = new SelfConnectTemplateEngine(); + + // Get language and file I/O instances from application + $langInstance = $appInstance->getLanguageInstance(); + $ioInstance = $appInstance->getFileIoInstance(); + + // Determine base path + $templateBasePath = $templateInstance->getConfigInstance()->getConfigEntry('application_base_path') . $appInstance->getRequestInstance()->getRequestElement('app') . '/'; + + // Is the base path valid? + if (empty($templateBasePath)) { + // Base path is empty + throw new BasePathIsEmptyException($templateInstance, self::EXCEPTION_UNEXPECTED_EMPTY_STRING); + } elseif (!is_string($templateBasePath)) { + // Is not a string + throw new InvalidBasePathStringException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_STRING); + } elseif (!is_dir($templateBasePath)) { + // Is not a path + throw new BasePathIsNoDirectoryException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_PATH_NAME); + } elseif (!is_readable($templateBasePath)) { + // Is not readable + throw new BasePathReadProtectedException(array($templateInstance, $templateBasePath), self::EXCEPTION_READ_PROTECED_PATH); + } + + // Set the base path + $templateInstance->setTemplateBasePath($templateBasePath); + + // Set the language and IO instances + $templateInstance->setLanguageInstance($langInstance); + $templateInstance->setFileIoInstance($ioInstance); + + // Set template extensions + $templateInstance->setRawTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('raw_template_extension')); + $templateInstance->setCodeTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('self_connect_template_extension')); + + // Absolute output path for compiled templates + $templateInstance->setCompileOutputPath($templateInstance->getConfigInstance()->getConfigEntry('base_path') . $templateInstance->getConfigInstance()->getConfigEntry('compile_output_path')); + + // Init a variable stacker + $stackerInstance = ObjectFactory::createObjectByConfiguredName('self_connect_stacker_class'); + + // Set it + $templateInstance->setStackerInstance($stackerInstance); + + // Return the prepared instance + return $templateInstance; + } + + /** + * Load a specified self-connect template into the engine + * + * @param $template The self-connect template we shall load which is + * located in 'self_connect' by default + * @return void + */ + public function loadSelfConnectTemplate ($template = 'self_connect') { + // Set template type + $this->setTemplateType($this->getConfigInstance()->getConfigEntry('self_connect_template_type')); + + // Load the special template + $this->loadTemplate($template); + } + + /** + * Getter for current main node + * + * @return $currMainNode Current main node + */ + public final function getCurrMainNode () { + return $this->curr['main_node']; + } + + /** + * Setter for current main node + * + * @param $element Element name to set as current main node + * @return $currMainNode Current main node + */ + private final function setCurrMainNode ($element) { + $this->curr['main_node'] = (string) $element; + } + + /** + * Getter for main node array + * + * @return $mainNodes Array with valid main node names + */ + public final function getMainNodes () { + return $this->mainNodes; + } + + /** + * Getter for sub node array + * + * @return $subNodes Array with valid sub node names + */ + public final function getSubNodes () { + return $this->subNodes; + } + + /** + * Handles the start element of an XML resource + * + * @param $resource XML parser resource (currently ignored) + * @param $element The element we shall handle + * @param $attributes All attributes + * @return void + * @throws InvalidXmlNodeException If an unknown/invalid XML node name was found + */ + public function startElement ($resource, $element, array $attributes) { + // Initial method name which will never be called... + $methodName = 'initSelfConnect'; + + // Make the element name lower-case + $element = strtolower($element); + + // Is the element a main node? + //* DEBUG: */ echo "START: >".$element."<
\n"; + if (in_array($element, $this->getMainNodes())) { + // Okay, main node found! + $methodName = 'start' . $this->convertToClassName($element); + + // Set it + $this->setCurrMainNode($element); + } elseif (in_array($element, $this->getSubNodes())) { + // Sub node found + $methodName = 'start' . $this->convertToClassName($element); + } else { + // Invalid node name found + throw new InvalidXmlNodeException(array($this, $element, $attributes), XmlParser::EXCEPTION_XML_NODE_UNKNOWN); + } + + // Call method + //* DEBUG: */ echo "call: ".$methodName."
\n"; + call_user_func_array(array($this, $methodName), $attributes); + } + + /** + * Ends the main or sub node by sending out the gathered data + * + * @param $resource An XML resource pointer (currently ignored) + * @param $nodeName Name of the node we want to finish + * @return void + * @throws XmlNodeMismatchException If current main node mismatches the closing one + */ + public function endElement ($resource, $nodeName) { + // Make all lower-case + $nodeName = strtolower($nodeName); + + // Does this match with current main node? + //* DEBUG: */ echo "END: >".$nodeName."<
\n"; + if (($nodeName != $this->getCurrMainNode()) && (in_array($nodeName, $this->getMainNodes()))) { + // Did not match! + throw new XmlNodeMismatchException (array($this, $nodeName, $this->getCurrMainNode()), XmlParser::EXCEPTION_XML_NODE_MISMATCH); + } // END - if + + // Construct method name + $methodName = 'finish' . $this->convertToClassName($nodeName); + + // Call the corresponding method + //* DEBUG: */ echo "call: ".$methodName."
\n"; + call_user_func_array(array($this, $methodName), array()); + } + + /** + * Currently not used + * + * @param $resource XML parser resource (currently ignored) + * @param $characters Characters to handle + * @return void + * @todo Find something useful with this! + */ + public function characterHandler ($resource, $characters) { + // Trim all spaces away + $characters = trim($characters); + + // Is this string empty? + if (empty($characters)) { + // Then skip it silently + return false; + } // END - if + + // Assign the found characters to variable and use the last entry from + // stack as the name + parent::assignVariable($this->getStackerInstance()->getNamed('self_connect'), $characters); + } + + /** + * Handles the template dependency for given node + * + * @param $node The node we should load a dependency template + * @param $templateDependency A template to load to satisfy dependencies + * @return void + */ + private function handleTemplateDependency ($node, $templateDependency) { + // Is the template dependency set? + if ((!empty($templateDependency)) && (!isset($this->dependencyContent[$node]))) { + // Get a temporay menu template instance + $templateInstance = ObjectFactory::createObjectByConfiguredName('self_connect_template_class', array($this->getApplicationInstance())); + + // Then load it + $templateInstance->loadSelfConnectTemplate($templateDependency); + + // Get an XmlParser instance + $templateInstance->renderXmlContent(); + + // Parse the template's content contents + $this->dependencyContent[$node] = $templateInstance->getRawTemplateData(); + } // END - if + } + + /** + * Getter for cache file (FQFN) + * + * @return $fqfn Full-qualified file name of the menu cache + */ + public function getMenuCacheFqfn () { + $this->partialStub('Please implement this method.'); + } + + /** + * Starts the self_connect + * + * @return void + */ + private function startSelfConnect () { + // Push the node name on the stacker + $this->getStackerInstance()->pushNamed('self_connect', 'self-connect'); + } + + /** + * Starts the self_connect data + * + * @return void + */ + private function startSelfConnectData () { + // Push the node name on the stacker + $this->getStackerInstance()->pushNamed('self_connect', 'self-connect-data'); + } + + /** + * Starts the node id + * + * @return void + */ + private function startNodeId () { + // Push the node name on the stacker + $this->getStackerInstance()->pushNamed('self_connect', 'node-id'); + } + + /** + * Starts the session id + * + * @return void + */ + private function startSessionId () { + // Push the node name on the stacker + $this->getStackerInstance()->pushNamed('self_connect', 'session-id'); + } + + /** + * Finishes the session id + * + * @return void + */ + private function finishSessionId () { + // Pop the last entry + $this->getStackerInstance()->popNamed('self_connect'); + } + + /** + * Finishes the node id + * + * @return void + */ + private function finishNodeId () { + // Pop the last entry + $this->getStackerInstance()->popNamed('self_connect'); + } + + /** + * Finishes the self_connect data + * + * @return void + */ + private function finishSelfConnectData () { + // Pop the last entry + $this->getStackerInstance()->popNamed('self_connect'); + } + + /** + * Finishes the self_connect + * + * @return void + */ + private function finishSelfConnect () { + // Pop the last entry + $this->getStackerInstance()->popNamed('self_connect'); + } +} + +// [EOF] +?> diff --git a/application/hub/templates/xml/object_registry/object_registry.xml b/application/hub/templates/xml/object_registry/object_registry.xml index d1b1c9a9e..62ce62470 100644 --- a/application/hub/templates/xml/object_registry/object_registry.xml +++ b/application/hub/templates/xml/object_registry/object_registry.xml @@ -41,14 +41,16 @@ along with this program. If not, see --------------------- upper - Only uploaded to "upper" hubs, these are bootstrap and list-nodes + self - Only upload to itself ??? - More to follow ... //--> upper 1 hub + + + + self_connect + + self + + self + + tcp + + hub + diff --git a/application/hub/templates/xml/self_connect/.htaccess b/application/hub/templates/xml/self_connect/.htaccess new file mode 100644 index 000000000..3a4288278 --- /dev/null +++ b/application/hub/templates/xml/self_connect/.htaccess @@ -0,0 +1 @@ +Deny from all diff --git a/application/hub/templates/xml/self_connect/self_connect.xml b/application/hub/templates/xml/self_connect/self_connect.xml new file mode 100644 index 000000000..4d7c6123a --- /dev/null +++ b/application/hub/templates/xml/self_connect/self_connect.xml @@ -0,0 +1,32 @@ + + + + + + + {?node_id?} + + {?session_id?} + + -- 2.39.5