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          * @param       $requestInstance        An instance of a Requestable class
  42          * @return      $cruncherInstance       An instance of this hub-cruncher class
  43          */
  44         public final static function createHubMcryptCruncher (Requestable $requestInstance) {
  45                 // Get a new instance
  46                 $cruncherInstance = new HubMcryptCruncher();
  47
  48                 // Set the request instance
  49                 $cruncherInstance->setRequestInstance($requestInstance);
  50
  51                 // Return the instance
  52                 return $cruncherInstance;
  53         }
  54
  55         /**
  56          * This method fills the in-buffer with (a) test unit(s) which are mainly
  57          * used for development of the crunching part. They must be enabled in
  58          * configuration, or else your cruncher runs out of WUs and waits for more
  59          * to show up.
  60          *
  61          * In this method we already know that the in-buffer is going depleted so
  62          * we don't need to double-check it here.
  63          *
  64          * @return      void
  65          */
  66         protected function fillInBufferQueueWithTestUnits () {
  67                 $this->partialStub('Please implement this method.');
  68         }
  69
  70         /**
  71          * This method fills the in-buffer with (real) WUs which will be crunched
  72          * and the result be sent back to the key producer instance.
  73          *
  74          * @return      void
  75          */
  76         protected function fillInBufferQueueWithWorkUnits () {
  77                 $this->partialStub('Please implement this method.');
  78         }
  79
  80         /**
  81          * Method to "bootstrap" the cruncher. This step does also apply provided
  82          * command-line arguments stored in the request instance. No buffer queue
  83          * will be initialized here, we only do "general" things here.
  84          *
  85          * @return      void
  86          * @todo        Implement this method
  87          */
  88         public function doBootstrapping () {
  89                 $this->partialStub('Please implement this method.');
  90         }
  91
  92         /**
  93          * Outputs the console teaser. This should only be executed on startup or
  94          * full restarts. This method generates some space around the teaser.
  95          *
  96          * @return      void
  97          */
  98         public function outputConsoleTeaser () {
  99                 // Output all lines
 100                 $this->debugOutput(' ');
 101                 $this->debugOutput('MCrypt Cruncher v' . $this->getVersion() . ' is starting ...');
 102                 $this->debugOutput('Copyright (c) 2011 MCrypt Cruncher Developer Team');
 103                 $this->debugOutput(' ');
 104                 $this->debugOutput('This program comes with ABSOLUTELY NO WARRANTY; for details see docs/COPYING.');
 105                 $this->debugOutput('This is free software, and you are welcome to redistribute it under certain');
 106                 $this->debugOutput('conditions; see docs/COPYING for details.');
 107                 $this->debugOutput(' ');
 108         }
 109
 110         /**
 111          * Add some cruncher-specific filters
 112          *
 113          * @param       $controllerInstance     An object of a Controller instance
 114          * @param       $responseInstance       An object of a Responseable instance
 115          * @return      void
 116          * @todo        0% done
 117          */
 118         public function addExtraFilters (Controller $controllerInstance, Responseable $responseInstance) {
 119                 // Add some filters here
 120                 $this->partialStub('Please add some cruncher-specific filters, if required.');
 121         }
 122 }
 123
 124 // [EOF]
 125 ?>