application/hub/main/commands/console/class_HubConsoleCrawlerCommand.php

   1 <?php
   2 /**
   3  * A command for the 'crawler client' routine
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2014 Crawler 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 HubConsoleCrawlerCommand extends BaseCommand implements Commandable {
  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          * @param       $resolverInstance       An instance of a command resolver class
  39          * @return      $commandInstance        An instance a prepared command class
  40          */
  41         public static final function createHubConsoleCrawlerCommand (CommandResolver $resolverInstance) {
  42                 // Get new instance
  43                 $commandInstance = new HubConsoleCrawlerCommand();
  44
  45                 // Set the application instance
  46                 $commandInstance->setResolverInstance($resolverInstance);
  47
  48                 // Return the prepared instance
  49                 return $commandInstance;
  50         }
  51
  52         /**
  53          * Executes the given command with given request and response objects
  54          *
  55          * @param       $requestInstance        An instance of a class with an Requestable interface
  56          * @param       $responseInstance       An instance of a class with an Responseable interface
  57          * @return      void
  58          * @todo        Try to create a CrawlerActivationTask or so
  59          */
  60         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  61                 // Get a registry and the application instance from it
  62                 $applicationInstance = Registry::getRegistry()->getInstance('app');
  63
  64                 /*
  65                  * ----------------------- Bootstrapping phase ------------------------
  66                  * Try to bootstrap the node and pass the request instance to it for
  67                  * extra arguments which mostly override config entries or enable special
  68                  * features within the hub (none is ready at this development stage)
  69                  */
  70                 self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Beginning with bootstrap...');
  71                 $applicationInstance->getControllerInstance()->executeBootstrapFilters($requestInstance, $responseInstance);
  72                 self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Bootstrap finished.');
  73
  74                 // Get crawler instance
  75                 $crawlerInstance = Registry::getRegistry()->getInstance('crawler');
  76
  77                 // Add some crawler-specific filters
  78                 $crawlerInstance->addExtraCrawlerFilters();
  79
  80                 // Get task handler instance
  81                 $handlerInstance = Registry::getRegistry()->getInstance('task_handler');
  82
  83                 // Debug message
  84                 self::createDebugInstance(__CLASS__)->debugOutput('MAIN: --- Entering main loop. ---');
  85
  86                 /*
  87                  * ----------------------------- Main loop ----------------------------
  88                  * This is the main loop. Queried calls should come back here very fast
  89                  * so the whole application runs on nice speed. This while-loop goes
  90                  * until the crawler is no longer active or all tasks are killed.
  91                  */
  92                 while (($crawlerInstance->isActive()) && ($handlerInstance->hasTasksLeft())) {
  93                         // Handle all tasks here
  94                         $handlerInstance->handleTasks();
  95                 } // END - while
  96
  97                 // Debug message
  98                 self::createDebugInstance(__CLASS__)->debugOutput('MAIN: --- Leaving main loop. ---');
  99         }
 100
 101         /**
 102          * Adds extra filters to the given controller instance
 103          *
 104          * @param       $controllerInstance             A controller instance
 105          * @param       $requestInstance                An instance of a class with an Requestable interface
 106          * @return      void
 107          * @todo        Should we add some more filters?
 108          */
 109         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
 110                 // Add pre filters
 111                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('crawler_php_requirements_filter'));
 112                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('crawler_initializer_filter'));
 113                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('crawler_welcome_teaser_filter'));
 114
 115                 // Add bootstrap filters
 116                 $controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('crawler_bootstrap_task_handler_initializer_filter'));
 117                 $controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('crawler_bootstrap_extra_bootstrapping_filter'));
 118
 119                 // This is the last generic boostrap filter
 120                 $controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('crawler_bootstrap_generic_activation_filter'));
 121
 122                 // Add shutdown filters
 123                 //$controllerInstance->addShutdownFilter(ObjectFactory::createObjectByConfiguredName('crawler_shutdown_task_handler_filter'));
 124
 125                 // This is the last generic shutdown filter
 126                 $controllerInstance->addShutdownFilter(ObjectFactory::createObjectByConfiguredName('crawler_shutdown_filter'));
 127         }
 128 }
 129
 130 // [EOF]
 131 ?>