application/hub/main/cruncher/mcrypt/class_HubMcryptCruncher.php

   1 <?php
   2 /**
   3  * A hub-mcrypt cruncher class
   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 HubMcryptCruncher extends BaseHubCruncher implements CruncherHelper, Registerable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33
  34                 // Set version number
  35                 $this->setVersion('0.0.0');
  36         }
  37
  38         /**
  39          * Creates an instance of this hub-cruncher class
  40          *
  41          * @return      $cruncherInstance       An instance of this hub-cruncher class
  42          */
  43         public final static function createHubMcryptCruncher () {
  44                 // Get a new instance
  45                 $cruncherInstance = new HubMcryptCruncher();
  46
  47                 // Return the instance
  48                 return $cruncherInstance;
  49         }
  50
  51         /**
  52          * This method fills the in-buffer with (a) test unit(s) which are mainly
  53          * used for development of the crunching part. They must be enabled in
  54          * configuration, or else your cruncher runs out of WUs and waits for more
  55          * to show up.
  56          *
  57          * In this method we already know that the in-buffer is going depleted so
  58          * we don't need to double-check it here.
  59          *
  60          * @return      void
  61          */
  62         protected function fillInBufferQueueWithTestUnits () {
  63                 // Are test units enabled?
  64                 if ($this->getConfigInstance()->getConfigEntry('cruncher_test_units_enabled') == 'N') {
  65                         // They are disabled, so skip any further steps
  66                         return;
  67                 } // END - if
  68
  69                 // Get a test-unit generator instance
  70                 $generatorInstance = ObjectFactory::createObjectByConfiguredName('cruncher_test_unit_generator_class');
  71
  72                 // We don't need an iterator here because we just need to generate some test units
  73                 for ($idx = 0; $idx < $this->getConfigInstance()->getConfigEntry('cruncher_max_text_unit_amount'); $idx++) {
  74                         // Get a test unit from it
  75                         $unitInstance = $generatorInstance->generateUnit();
  76
  77                         // ... and finally queue it to the in-buffer queue
  78                         $this->queueUnitInstanceToInBuffer($unitInstance);
  79                 } // END - for
  80         }
  81
  82         /**
  83          * This method fills the in-buffer with (real) WUs which will be crunched
  84          * and the result be sent back to the key producer instance.
  85          *
  86          * @return      void
  87          */
  88         protected function fillInBufferQueueWithWorkUnits () {
  89                 $this->partialStub('Please implement this method.');
  90         }
  91
  92         /**
  93          * Method to "bootstrap" the cruncher. This step does also apply provided
  94          * command-line arguments stored in the request instance. No buffer queue
  95          * will be initialized here, we only do "general" things here.
  96          *
  97          * @return      void
  98          * @todo        Implement this method
  99          */
 100         public function doBootstrapping () {
 101                 $this->partialStub('Please implement this method.');
 102         }
 103
 104         /**
 105          * Outputs the console teaser. This should only be executed on startup or
 106          * full restarts. This method generates some space around the teaser.
 107          *
 108          * @return      void
 109          */
 110         public function outputConsoleTeaser () {
 111                 // Output all lines
 112                 $this->debugOutput(' ');
 113                 $this->debugOutput('MCrypt Cruncher v' . $this->getVersion() . ' is starting ...');
 114                 $this->debugOutput('Copyright (c) 2011 MCrypt Cruncher Developer Team');
 115                 $this->debugOutput(' ');
 116                 $this->debugOutput('This program comes with ABSOLUTELY NO WARRANTY; for details see docs/COPYING.');
 117                 $this->debugOutput('This is free software, and you are welcome to redistribute it under certain');
 118                 $this->debugOutput('conditions; see docs/COPYING for details.');
 119                 $this->debugOutput(' ');
 120         }
 121
 122         /**
 123          * Add some cruncher-specific filters
 124          *
 125          * @param       $controllerInstance     An object of a Controller instance
 126          * @param       $responseInstance       An object of a Responseable instance
 127          * @return      void
 128          * @todo        0% done
 129          */
 130         public function addExtraFilters (Controller $controllerInstance, Responseable $responseInstance) {
 131                 // Add some filters here
 132                 $this->partialStub('Please add some cruncher-specific filters, if required.');
 133         }
 134 }
 135
 136 // [EOF]
 137 ?>