application/hub/main/handler/network/class_BaseNetworkPackageHandler.php

   1 <?php
   2 /**
   3  * A general Handler
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class BaseNetworkPackageHandler extends BaseHandler {
  25         // Error codes:
  26         // - Socket raw data stream errors
  27         const SOCKET_ERROR_UNKNOWN                = 'unknown_error';      // Unknown error (should not happen)
  28         const SOCKET_ERROR_TRANSPORT_ENDPOINT     = 'transport_endpoint'; // Transport endpoint has closed
  29         const SOCKET_ERROR_EMPTY_DATA             = 'empty_data';         // Other peer has sent nothing
  30         const SOCKET_ERROR_INVALID_BASE64_MODULO  = 'base64_modulo';      // Length is not modulo 4
  31         const SOCKET_ERROR_INVALID_BASE64_MESSAGE = 'base64_message';     // Raw data is not Base64-encoded
  32         const SOCKET_ERROR_UNHANDLED              = 'unhandled_package';  // Unhandled raw data (not bad)
  33
  34         // - Package errors
  35         const PACKAGE_ERROR_INVALID_DATA         = 'invalid_data';    // Invalid data in package found
  36         const PACKAGE_ERROR_INCOMPLETE_DATA      = 'incomplete_data'; // Incomplete data sent (e.g. field is missing)
  37         const PACKAGE_ERROR_INVALID_CONTENT      = 'invalid_content'; // Content is invalid (e.g. not well-formed)
  38         const PACKAGE_ERROR_RECIPIENT_MISMATCH   = 'recipient_error'; // Recipient is not us
  39         const PACKAGE_LEVEL_CHECK_OKAY           = 'checked_package'; // Package is fine
  40
  41         /**
  42          * Error code from socket
  43          */
  44         private $errorCode = -1;
  45
  46         /**
  47          * Protected constructor
  48          *
  49          * @param       $className      Name of the class
  50          * @return      void
  51          */
  52         protected function __construct ($className) {
  53                 // Call parent constructor
  54                 parent::__construct($className);
  55
  56                 // Get an input stream instance
  57                 $streamInstance = ObjectFactory::createObjectByConfiguredName('node_raw_data_input_stream_class', array($this));
  58
  59                 // Set it in this network-package handler
  60                 $this->setInputStreamInstance($streamInstance);
  61
  62                 // Init stacker instance for processed raw data
  63                 $stackerInstance = ObjectFactory::createObjectByConfiguredName('node_raw_data_stacker_class');
  64
  65                 // Remember this in this package handler
  66                 $this->setStackerInstance($stackerInstance);
  67
  68                 // Init stacker
  69                 $this->initStacker();
  70         }
  71
  72         /**
  73          * Initializes the stacker for raw data
  74          *
  75          * @return      void
  76          */
  77         protected function initStacker () {
  78                 $this->getStackerInstance()->initStacker('raw_data');
  79         }
  80
  81         /**
  82          * Adds given decoded data to the raw data stacker
  83          *
  84          * @param       $decodedData    Decoded data from the socket resource
  85          * @return      void
  86          */
  87         protected function addDecodedDataToStacker ($decodedData) {
  88                 // Add it
  89                 $this->getStackerInstance()->pushNamed('raw_data', array(
  90                         'decoded_data' => $decodedData,
  91                         'error_code'   => $this->getErrorCode()
  92                 ));
  93         }
  94
  95         /**
  96          * Checks wether the 'recipient' field matches our own address:port
  97          * combination.
  98          *
  99          * @param       $packageData    Raw package data
 100          * @return      $matches                Wether it matches
 101          */
 102         protected function ifRecipientMatchesOwnAddress (array $packageData) {
 103                 // Construct own address first,
 104                 $ownAddress = Registry::getRegistry()->getInstance('node')->getAddressPort($this);
 105
 106                 // Does it match?
 107                 // @TODO Numeric or alpha-numeric index?
 108                 $matches = ($ownAddress === $packageData[NetworkPackage::INDEX_PACKAGE_RECIPIENT]);
 109
 110                 // Return result
 111                 return $matches;
 112         }
 113
 114         /**
 115          * Setter for error code
 116          *
 117          * @param       $errorCode      The error code we shall set
 118          * @return      void
 119          */
 120         protected final function setErrorCode ($errorCode) {
 121                 $this->errorCode = $errorCode;
 122         }
 123
 124         /**
 125          * Getter for error code
 126          *
 127          * @return      $errorCode      The error code
 128          */
 129         public final function getErrorCode () {
 130                 return $this->errorCode;
 131         }
 132 }
 133
 134 // [EOF]
 135 ?>