]> git.mxchange.org Git - hub.git/commitdiff
Self-connect continued (still broken), some code moved to generic classes to encapsul...
authorRoland Häder <roland@mxchange.org>
Thu, 17 Jun 2010 16:03:21 +0000 (16:03 +0000)
committerRoland Häder <roland@mxchange.org>
Thu, 17 Jun 2010 16:03:21 +0000 (16:03 +0000)
19 files changed:
.gitattributes
application/hub/config.php
application/hub/main/commands/console/class_HubConsoleMainCommand.php
application/hub/main/discovery/class_BaseHubDiscovery.php [new file with mode: 0644]
application/hub/main/discovery/package/class_PackageRecipientDiscovery.php
application/hub/main/discovery/socket/class_PackageSocketDiscovery.php
application/hub/main/helper/hub/announcement/class_HubDescriptorHelper.php
application/hub/main/helper/hub/class_
application/hub/main/helper/hub/class_BaseHubHelper.php
application/hub/main/helper/hub/connection/class_HubSelfConnectHelper.php
application/hub/main/nodes/class_BaseHubNode.php
application/hub/main/package/class_NetworkPackage.php
application/hub/main/tags/package/class_PackageTags.php
application/hub/main/template/announcement/class_AnnouncementTemplateEngine.php
application/hub/main/template/connect/.htaccess [new file with mode: 0644]
application/hub/main/template/connect/class_SelfConnectTemplateEngine.php [new file with mode: 0644]
application/hub/templates/xml/object_registry/object_registry.xml
application/hub/templates/xml/self_connect/.htaccess [new file with mode: 0644]
application/hub/templates/xml/self_connect/self_connect.xml [new file with mode: 0644]

index 28c2795ef00d80499cdad3567897cb2d0465b275..09963e53d6ff264c333eb04f04b997dc981a66ae 100644 (file)
@@ -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
index a96da58c214e5415a59d8d534a90e780cad80e16..57c648ba916fc59921ce901b967932632c0afc31 100644 (file)
@@ -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);
 
index fcbc20254dd7e11839b3a1d99a301d20d9ac8612..9b4ff4f70c665cc23e668725fc41c0eb93c566dd 100644 (file)
@@ -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 (file)
index 0000000..2706b4a
--- /dev/null
@@ -0,0 +1,61 @@
+<?php
+/**
+ * A PackageRecipient discovery class
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @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 <http://www.gnu.org/licenses/>.
+ */
+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]
+?>
index 6cf473d2aa0899a8776a81f5e8e2c22ca3cbf10b..ad062049dae60729e043b1b77703e22ff91cfd05 100644 (file)
@@ -21,7 +21,7 @@
  * 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 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
        }
index 4492ca9f676d03800062229b17e0641bd099f7ee..fb5b2b2a764446274c603f4ac8925900e15589b8 100644 (file)
@@ -21,7 +21,7 @@
  * 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 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);
index 6f9cbaa8085c55e29679e79ebef322fbf892fdea..63970e330ec6b3bd90690b069e941c37e8ef2999 100644 (file)
@@ -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();
index 934cf239b66ffc69f0522051232e386dc80120ad..e8efbe6dfd5cad41240fac399dfc32a860b52ac4 100644 (file)
@@ -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_!!!);
        }
 
        /**
index 1803959d02c4dd2f3bfdd95893f1ebf9b57098b5..a27bbdc79e8eacabe81fc6e026c970d739756f5d 100644 (file)
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 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]
index 9f333fe21e76d5c327ccd956efe97fc312356f1d..33289725a3ea9c5d5710faa0b2f09e83c87d48d6 100644 (file)
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 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]
index c5090f78933d674107bfb49a0eb2ea98d768744f..b83b93c9743c3e6c2497ff88ec77e0b4289921f9 100644 (file)
@@ -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');
        }
 
        /**
index 5c7f051947176cb8c9b53d6c3f02a43abc6c62f2..dd634f3adfe84492f6467779c14da3ee32713cc9 100644 (file)
@@ -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,
                ));
        }
index f0c0ee59e9410df72c9f6666b09f16cc8a4698c2..510c59b57a8baacec227118c7076e20c559b132d 100644 (file)
@@ -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);
 
index 76c399b64c46763a4b4950804fed8560e3235687..102d7e08908a31cb2f47d5edf9fe1e802cb1a831 100644 (file)
@@ -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 (file)
index 0000000..3a42882
--- /dev/null
@@ -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 (file)
index 0000000..f4c8744
--- /dev/null
@@ -0,0 +1,378 @@
+<?php
+/**
+ * An SelfConnect template engine class
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @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 <http://www.gnu.org/licenses/>.
+ */
+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: &gt;".$element."&lt;<br />\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."<br />\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: &gt;".$nodeName."&lt;<br />\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."<br />\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]
+?>
index d1b1c9a9ee1c975858e9cd7457470fdf4d283b87..62ce62470ce01d1c491437fa9f3da403373028d3 100644 (file)
@@ -41,14 +41,16 @@ along with this program. If not, see <http://www.gnu.org/licenses/>
                        ---------------------
                        upper - Only uploaded to "upper" hubs, these are bootstrap and
                                list-nodes
+                       self  - Only upload to itself
                        ???   - More to follow ...
                        //-->
                        <object-recipient-limitation>upper</object-recipient-limitation>
                        <!--
-                       Maximum spread of the object. 1 means, only the direct recipient is
-                       allowed to keep it (required for announcements), 2 means the direct
-                       recipient may share it to its direct connected hubs. This aids to
-                       keep the overall network load at low-profile.
+                       Maximum spread of the object. 'self' means only to itself, 1 means,
+                       only the direct recipient is allowed to keep it (required for
+                       announcements), 2 means the direct recipient may share it to its
+                       direct connected hubs. This aids to keep the overall network load at
+                       low-profile.
                        //-->
                        <object-max-spread>1</object-max-spread>
                        <!--
@@ -66,5 +68,26 @@ along with this program. If not, see <http://www.gnu.org/licenses/>
                        //-->
                        <object-recipient-type>hub</object-recipient-type>
                </object-list-entry>
+               <!-- A single object type we want to share. //-->
+               <object-list-entry>
+                       <!-- The actual name, this must be the same as tag names are. //-->
+                       <object-name>self_connect</object-name>
+                       <!--
+                       Recipient limitation
+                       //-->
+                       <object-recipient-limitation>self</object-recipient-limitation>
+                       <!--
+                       Maximum spread of the object
+                       //-->
+                       <object-max-spread>self</object-max-spread>
+                       <!--
+                       The protocol we should use for transmission
+                       //-->
+                       <object-protocol>tcp</object-protocol>
+                       <!--
+                       The recipient type for this type of object
+                       //-->
+                       <object-recipient-type>hub</object-recipient-type>
+               </object-list-entry>
        </object-list>
 </object-registry>
diff --git a/application/hub/templates/xml/self_connect/.htaccess b/application/hub/templates/xml/self_connect/.htaccess
new file mode 100644 (file)
index 0000000..3a42882
--- /dev/null
@@ -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 (file)
index 0000000..4d7c612
--- /dev/null
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!--
+A descriptor XML file for self-connect attempts
+
+@author                Roland Haeder <webmaster@ship-simu.org>
+@version       0.0.0
+@copyright     Copyright (c) 2007, 2008 Roland Haeder, 2009 Ship-Simu 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 <http://www.gnu.org/licenses/>
+//-->
+<self-connect>
+       <!-- Self-connect data, e.g. session/hub id for verification //-->
+       <self-connect-data>
+               <!-- Our node id. This should be announced only to upper hubs. //-->
+               <node-id>{?node_id?}</node-id>
+               <!-- The session id. This should be announced to all other hubs. //-->
+               <session-id>{?session_id?}</session-id>
+       </self-connect-data>
+</self-connect>