application/hub/main/streams/raw_data/input/class_RawDataInputStream.php

   1 <?php
   2 /**
   3  * A RawDataInputStream class
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009  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 RawDataInputStream extends BaseStream implements InputStreamable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33         }
  34
  35         /**
  36          * Creates an instance of this node class
  37          *
  38          * @param       $handlerInstance        An instance of a Networkable class
  39          * @return      $streamInstance         An instance of this node class
  40          */
  41         public final static function createRawDataInputStream (Networkable $handlerInstance) {
  42                 // Get a new instance
  43                 $streamInstance = new RawDataInputStream();
  44
  45                 // Set the handler instance
  46                 $streamInstance->setHandlerInstance($handlerInstance);
  47
  48                 // Return the instance
  49                 return $streamInstance;
  50         }
  51
  52         /**
  53          * Streams the data and maybe does something to it
  54          *
  55          * @param       $data   The data (string mostly) to "stream"
  56          * @return      $data   The data (string mostly) to "stream"
  57          * @todo        Do we need to do something more here?
  58          */
  59         public function streamData ($data) {
  60                 // Can it be validated?
  61                 if ((strlen($data) % 4) != 0) {
  62                         // Length modulo 4 must be zero, else it is an invalid Base64 message
  63                         $this->getHandlerInstance()->setErrorCode(BaseNetworkPackageHandler::SOCKET_ERROR_INVALID_BASE64_MODULO);
  64                         $data = false;
  65                 } elseif (!$this->isBase64Encoded($data)) {
  66                         // Is not a valid Base64-encoded message
  67                         $this->getHandlerInstance()->setErrorCode(BaseNetworkPackageHandler::SOCKET_ERROR_INVALID_BASE64_MESSAGE);
  68                         $data = false;
  69                 } else {
  70                         // Decode the data with BASE64-encoding
  71                         $data = base64_decode($data);
  72                 }
  73
  74                 // Return it
  75                 return $data;
  76         }
  77 }
  78
  79 // [EOF]
  80 ?>