application/hub/classes/filter/task/node/class_NodeTaskHandlerInitializerFilter.php

   1 <?php
   2 /**
   3  * A TaskHandlerInitializer filter for hubs
   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 NodeTaskHandlerInitializerFilter extends BaseNodeFilter implements Filterable {
  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 filter class
  37          *
  38          * @return      $filterInstance         An instance of this filter class
  39          */
  40         public static final function createNodeTaskHandlerInitializerFilter () {
  41                 // Get a new instance
  42                 $filterInstance = new NodeTaskHandlerInitializerFilter();
  43
  44                 // Return the instance
  45                 return $filterInstance;
  46         }
  47
  48         /**
  49          * Executes the filter with given request and response objects
  50          *
  51          * @param       $requestInstance        An instance of a class with an Requestable interface
  52          * @param       $responseInstance       An instance of a class with an Responseable interface
  53          * @return      void
  54          * @throws      FilterChainException    If the filter chain needs to be interrupted
  55          * @todo        Maybe some more tasks needs to be added?
  56          */
  57         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  58                 // Get node instance
  59                 $nodeInstance = NodeObjectFactory::createNodeInstance();
  60
  61                 // Get a new task handler instance
  62                 $handlerInstance = ObjectFactory::createObjectByConfiguredName('task_handler_class');
  63
  64                 // Put the task handler in registry
  65                 Registry::getRegistry()->addInstance('task_handler', $handlerInstance);
  66
  67                 // Prepare a package-tags initialization task for the listeners
  68                 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_package_tags_init_task_class');
  69
  70                 // Register it
  71                 $handlerInstance->registerTask('package_tags_init', $taskInstance);
  72
  73                 // Generate package writer task
  74                 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_package_writer_task_class');
  75
  76                 // Register it as well
  77                 $handlerInstance->registerTask('network_package_writer', $taskInstance);
  78
  79                 // Generate package reader task
  80                 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_package_reader_task_class');
  81
  82                 // Network package reader, needs to be delayed a little
  83                 $handlerInstance->registerTask('network_package_reader', $taskInstance);
  84
  85                 // Generate socket listener task
  86                 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_socket_listener_task_class');
  87
  88                 // Network package reader, needs to be delayed a little
  89                 $handlerInstance->registerTask('socket_listener', $taskInstance);
  90
  91                 // Generate package decoder task
  92                 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_package_decoder_task_class');
  93
  94                 // Register it as well
  95                 $handlerInstance->registerTask('package_decoder', $taskInstance);
  96
  97                 // Generate chunk assembler task
  98                 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_chunk_assembler_task_class');
  99
 100                 // Register it as well
 101                 $handlerInstance->registerTask('chunk_assembler', $taskInstance);
 102
 103                 // Generate DHT initialization task
 104                 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_dht_init_task_class');
 105
 106                 // Register it as well
 107                 $handlerInstance->registerTask('dht_init', $taskInstance);
 108
 109                 // Generate DHT query task
 110                 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_dht_query_task_class');
 111
 112                 // Register it as well
 113                 $handlerInstance->registerTask('dht_query', $taskInstance);
 114
 115                 // Generate DHT publication-check task
 116                 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_dht_publication_check_task_class');
 117
 118                 // Register it as well
 119                 $handlerInstance->registerTask('dht_check_publication', $taskInstance);
 120
 121                 // Generate DHT publication task
 122                 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_dht_publication_task_class');
 123
 124                 // Register it as well
 125                 $handlerInstance->registerTask('dht_publication', $taskInstance);
 126
 127                 // Prepare a self-test task for the listeners
 128                 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_selfconnect_task_class');
 129
 130                 // Register it
 131                 $handlerInstance->registerTask('self_connect', $taskInstance);
 132
 133                 // Prepare a update-check task
 134                 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_update_check_task_class');
 135
 136                 // Register it
 137                 $handlerInstance->registerTask('update_check', $taskInstance);
 138
 139                 // Get the list instance here
 140                 $listInstance = $nodeInstance->getListenerPoolInstance()->getPoolEntriesInstance();
 141
 142                 // Prepare a ping task
 143                 $taskInstance = ObjectFactory::createObjectByConfiguredName('node_ping_task_class', array($listInstance));
 144
 145                 // Register it
 146                 $handlerInstance->registerTask('ping', $taskInstance);
 147
 148                 /*
 149                  * Allow extra node-depending tasks, e.g. the bootstrapper node needs
 150                  * booting its DHT. DHTs are decentralized and are working on
 151                  * peer-to-peer basis.
 152                  */
 153                 $nodeInstance->addExtraTasks($handlerInstance);
 154         }
 155 }
 156
 157 // [EOF]
 158 ?>