application/hub/main/tasks/node/chunks/class_NodeChunkAssemblerTask.php

   1 <?php
   2 /**
   3  * A ChunkAssembler node-task
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.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 NodeChunkAssemblerTask extends BaseTask implements Taskable, Visitable {
  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 class
  37          *
  38          * @return      $taskInstance   An instance of a Visitable class
  39          */
  40         public final static function createNodeChunkAssemblerTask () {
  41                 // Get new instance
  42                 $taskInstance = new NodeChunkAssemblerTask();
  43
  44                 // Get a chunk handler instance
  45                 $handlerInstance = ChunkHandlerFactory::createChunkHandlerInstance();
  46
  47                 // And add it to this task instance
  48                 $taskInstance->setHandlerInstance($handlerInstance);
  49
  50                 // Return the prepared instance
  51                 return $taskInstance;
  52         }
  53
  54         /**
  55          * Accepts the visitor to process the visitor
  56          *
  57          * @param       $visitorInstance        An instance of a Visitor class
  58          * @return      void
  59          * @todo        Also visit some sub-objects?
  60          */
  61         public function accept (Visitor $visitorInstance) {
  62                 // Visit this task
  63                 $visitorInstance->visitTask($this);
  64         }
  65
  66         /**
  67          * Executes the task
  68          *
  69          * @return      void
  70          */
  71         public function executeTask () {
  72                 // "Cache" handler instance
  73                 $handlerInstance = $this->getHandlerInstance();
  74
  75                 // Are there chunks to handle or a final array to assemble?
  76                 if ($handlerInstance->ifUnassembledChunksAvailable()) {
  77                         /*
  78                          * Then do the final steps:
  79                          *
  80                          * 1) Sort the final array with ksort(). This will bring the "hash
  81                          *    chunk" up to the last array index and the EOP chunk to the
  82                          *    pre-last array index
  83                          * 2) Assemble all chunks except two last (see above step)
  84                          * 3) While so, do the final check on all hashes
  85                          * 4) If the package is assembled back together, hash it again for
  86                          *    the very final verification.
  87                          */
  88                         $handlerInstance->assembleChunksFromFinalArray();
  89                 } elseif ($handlerInstance->ifUnhandledChunksWithFinalAvailable()) {
  90                         /*
  91                          * Then handle them (not all!). This should push all chunks into a
  92                          * 'final array' for last verification.
  93                          */
  94                         $handlerInstance->handleAvailableChunksWithFinal();
  95                 } elseif ($handlerInstance->ifRawPackageDataIsAvailable()) {
  96                         /*
  97                          * The final raw package data is back together again. So feed it
  98                          * into the next stack for further decoding/processing
  99                          */
 100                         $handlerInstance->handledAssembledRawPackageData();
 101                 }
 102         }
 103
 104         /**
 105          * Shuts down the task
 106          *
 107          * @return      void
 108          * @todo        0% done
 109          */
 110         public function doShutdown () {
 111                 self::createDebugInstance(__CLASS__)->debugOutput('TASK[' . __METHOD__ . ':' . __LINE__ . ']: Shutting down...');
 112         }
 113 }
 114
 115 // [EOF]
 116 ?>