Continued rewrite:

[hub.git] / application / hub / main / handler / protocol / ipv4 / class_BaseIpV4ProtocolHandler.php

diff --git a/application/hub/main/handler/protocol/ipv4/class_BaseIpV4ProtocolHandler.php b/application/hub/main/handler/protocol/ipv4/class_BaseIpV4ProtocolHandler.php
index 66dd83a4003628b83702750ee5d7f3c0e25a6757..95ae3bd7f14edec272a6fbc17fa75566e4834c54 100644 (file)
--- a/application/hub/main/handler/protocol/ipv4/class_BaseIpV4ProtocolHandler.php
+++ b/application/hub/main/handler/protocol/ipv4/class_BaseIpV4ProtocolHandler.php
@@ -22,14 +22,14 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 class BaseIpV4ProtocolHandler extends BaseProtocolHandler {
+       // Regular expression for validating IP:port UNLs
+       const UNL_REGEX = '/^([a-z]{1,}):\/\/\b(([01]?\d?\d|2[0-4]\d|25[0-5])\.){3}([01]?\d?\d|2[0-4]\d|25[0-5])\b:(6553[0-5]|655[0-2][0-9]\d|65[0-4](\d){2}|6[0-4](\d){3}|[1-5](\d){4}|[1-9](\d){0,3})$/';
+
        /**
         * Port number
         */
        private $port = 0;
 
-       // Regular expression for validating IP:port UNLs
-       const UNL_REGEX = '([a-z]{1,}):\/\/\b(([01]?\d?\d|2[0-4]\d|25[0-5])\.){3}([01]?\d?\d|2[0-4]\d|25[0-5])\b:(6553[0-5]|655[0-2][0-9]\d|65[0-4](\d){2}|6[0-4](\d){3}|[1-5](\d){4}|[1-9](\d){0,3})';
-
        /**
         * Protected constructor
         *
@@ -39,6 +39,9 @@ class BaseIpV4ProtocolHandler extends BaseProtocolHandler {
        protected function __construct ($className) {
                // Call parent constructor
                parent::__construct($className);
+
+               // Set regex
+               $this->setRegularExpression(self::UNL_REGEX);
        }
 
        /**
@@ -62,6 +65,48 @@ class BaseIpV4ProtocolHandler extends BaseProtocolHandler {
                return $this->port;
        }
 
+       /**
+        * Parses the given UNL by splitting it up in its components. The UNL ...
+        *
+        * protocol://address[:port]
+        *
+        * ... becomes:
+        *
+        * array(
+        *     'protocol' => 'value',
+        *     'address'  => 'value',
+        *     'port'     => 123
+        * )
+        *
+        * @param       $unl            Universal Node Locator (UNL) to "parse"
+        * @return      $unlData        Array with all components of the UNL
+        */
+       protected function parseUniversalNodeLocator ($unl) {
+               // Debug message
+               //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: unl=' . $unl . ' - CALLED!');
+
+               // First generic parse
+               $unlData = parent::parseGenericUniversalNodeLocator($unl);
+
+               /*
+                * Make sure the generic parts are all there. In case of a rewrite,
+                * these assertitions will bail out on badly formed arrays.
+                */
+               assert(isset($unlData[UniversalNodeLocator::UNL_PART_PROTOCOL]));
+               assert(isset($unlData[UniversalNodeLocator::UNL_PART_ADDRESS]));
+               assert(isset($unlData[UniversalNodeLocator::UNL_PART_EXTRA]));
+
+               // Copy 'extra' -> 'port' ...
+               $unlData[UniversalNodeLocator::UNL_PART_PORT] = $unlData[UniversalNodeLocator::UNL_PART_EXTRA];
+
+               // ... and drop 'extra'
+               unset($unlData[UniversalNodeLocator::UNL_PART_EXTRA]);
+
+               // Debug message
+               //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: unlData=' . print_r($unlData, TRUE) . ' - EXIT!');
+               return $unlData;
+       }
+
        /**
         * Validates given 'recipient' if it is a valid UNL. This means that the UNL
         * can be parsed by the protocol handler.
@@ -71,7 +116,7 @@ class BaseIpV4ProtocolHandler extends BaseProtocolHandler {
         */
        public function isValidUniversalNodeLocatorByPackageData (array $packageData) {
                // Debug message
-               /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: CALLED!');
+               //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: CALLED!');
 
                // Is 'recipient' there?
                assert(isset($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT]));
@@ -80,25 +125,32 @@ class BaseIpV4ProtocolHandler extends BaseProtocolHandler {
                assert(substr($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT], 0, strlen($this->getHandlerName())) != $this->getHandlerName());
 
                // Default is from generic validation
-               $isValid = $this->isValidUniversalNodeLocator($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT], self::UNL_REGEX);
+               $isValid = $this->isValidUniversalNodeLocator($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT]);
 
                // Debug message
-               /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: PACKAGE_DATA_RECIPIENT=' . $packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT] . ',isValid[' . gettype($isValid) . ']=' . intval($isValid));
+               //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: PACKAGE_DATA_RECIPIENT=' . $packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT] . ',isValid[' . gettype($isValid) . ']=' . intval($isValid));
 
                // If this doesn't fail, continue validating the IP:port combination
                if ($isValid === TRUE) {
-                       // Okay, the basic test is passed, so reset the variable
-                       $isValid = FALSE;
-
                        // ... and validate IP:port, first "parse" the UNL
-                       $unlParts = $this->parseUniversalNodeLocator($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT]);
+                       $unlData = $this->parseUniversalNodeLocator($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT]);
+
+                       /*
+                        * Make sure the extra field 'port' is there. This may look
+                        * superflious but in case of a rewrite this assert will stop at
+                        * badly formated arrays.
+                        */
+                       assert(isset($unlData[UniversalNodeLocator::UNL_PART_PORT]));
+
+                       // Set whole UNL data array
+                       $this->setUniversalNodeLocatorData($unlData);
 
-                       // Debug die
-                       die(__METHOD__ . ':PACKAGE_DATA_RECIPIENT=' . $packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT] . ',unlParts=' . print_r($unlParts, TRUE) . PHP_EOL);
+                       // Set port
+                       $this->setPort($unlData[UniversalNodeLocator::UNL_PART_PORT]);
                } // END - if
 
                // Return result
-               /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: isValid=' . intval($isValid) . ' - EXIT!');
+               //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: isValid=' . intval($isValid) . ' - EXIT!');
                return $isValid;
        }
 }