Introduced experimental apt-proxy sub project (a connector for apt-proxy usage into...

[hub.git] / application / hub / main / cruncher / mcrypt / class_HubMcryptCruncher.php

diff --git a/application/hub/main/cruncher/mcrypt/class_HubMcryptCruncher.php b/application/hub/main/cruncher/mcrypt/class_HubMcryptCruncher.php
index c0f7ac8eba2de7cfb3fb05d34f23ac0cf6f78a11..51d6224442f671581f004e7a5df9bd8f09e59c6d 100644 (file)
--- a/application/hub/main/cruncher/mcrypt/class_HubMcryptCruncher.php
+++ b/application/hub/main/cruncher/mcrypt/class_HubMcryptCruncher.php
@@ -4,7 +4,7 @@
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Hub Developer Team
+ * @copyright  Copyright (c) 2011 - 2012 Cruncher Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.ship-simu.org
  *
@@ -30,36 +30,84 @@ class HubMcryptCruncher extends BaseHubCruncher implements CruncherHelper, Regis
        protected function __construct () {
                // Call parent constructor
                parent::__construct(__CLASS__);
+
+               // Set version number
+               $this->setVersion('0.0.0');
        }
 
        /**
         * Creates an instance of this hub-cruncher class
         *
-        * @param       $requestInstance        An instance of a Requestable class
         * @return      $cruncherInstance       An instance of this hub-cruncher class
         */
-       public final static function createHubMcryptCruncher (Requestable $requestInstance) {
+       public final static function createHubMcryptCruncher () {
                // Get a new instance
                $cruncherInstance = new HubMcryptCruncher();
 
-               // Set the request instance
-               $cruncherInstance->setRequestInstance($requestInstance);
-
                // Return the instance
                return $cruncherInstance;
        }
 
+       /**
+        * This method fills the in-buffer with (a) test unit(s) which are mainly
+        * used for development of the crunching part. They must be enabled in
+        * configuration, or else your cruncher runs out of WUs and waits for more
+        * to show up.
+        *
+        * In this method we already know that the in-buffer is going depleted so
+        * we don't need to double-check it here.
+        *
+        * @return      void
+        */
+       protected function fillInBufferQueueWithTestUnits () {
+               // Are test units enabled?
+               if ($this->getConfigInstance()->getConfigEntry('cruncher_test_units_enabled') == 'N') {
+                       // They are disabled, so skip any further steps
+                       return;
+               } elseif ($this->getStateInstance()->isCruncherStateVirgin()) {
+                       // No virgin crunchers please, because they usually have no test units ready for crunching
+                       return;
+               }
+
+               // Get a test-unit generator instance
+               $generatorInstance = ObjectFactory::createObjectByConfiguredName('cruncher_test_unit_generator_class');
+
+               // We don't need an iterator here because we just need to generate some test units
+               for ($idx = 0; $idx < $this->getConfigInstance()->getConfigEntry('cruncher_max_text_unit_amount'); $idx++) {
+                       // Get a test unit from it
+                       $unitInstance = $generatorInstance->generateNextUnitInstance();
+
+                       // ... and finally queue it to the in-buffer queue
+                       $this->queueUnitInstanceToInBuffer($unitInstance);
+               } // END - for
+       }
+
+       /**
+        * This method fills the in-buffer with (real) WUs which will be crunched
+        * and the result be sent back to the key producer instance.
+        *
+        * @return      void
+        */
+       protected function fillInBufferQueueWithWorkUnits () {
+               // This cruncher's state must not be one of these: 'virgin'
+               if ($this->getStateInstance()->isCruncherStateVirgin()) {
+                       // We can silently skip here, until the generation is finished
+                       return;
+               } // END - if
+
+               // @TODO Implement this method
+               $this->partialStub('Please implement this method.');
+       }
+
        /**
         * Method to "bootstrap" the cruncher. This step does also apply provided
-        * command-line arguments stored in the request instance. The regular cruncher
-        * should communicate with the bootstrap-crunchers at this point.
+        * command-line arguments stored in the request instance. No buffer queue
+        * will be initialized here, we only do "general" things here.
         *
         * @return      void
         * @todo        Implement this method
         */
        public function doBootstrapping () {
-               // Call generic (parent) bootstrapping method first
-               parent::doGenericBootstrapping();
                $this->partialStub('Please implement this method.');
        }
 
@@ -70,16 +118,28 @@ class HubMcryptCruncher extends BaseHubCruncher implements CruncherHelper, Regis
         * @return      void
         */
        public function outputConsoleTeaser () {
-               $this->partialStub('Please implement this method.');
+               // Output all lines
+               self::createDebugInstance(__CLASS__)->debugOutput(' ');
+               self::createDebugInstance(__CLASS__)->debugOutput('MCrypt Cruncher v' . $this->getVersion() . ' is starting ...');
+               self::createDebugInstance(__CLASS__)->debugOutput('Copyright (c) 2011 Cruncher Developer Team');
+               self::createDebugInstance(__CLASS__)->debugOutput(' ');
+               self::createDebugInstance(__CLASS__)->debugOutput('This program comes with ABSOLUTELY NO WARRANTY; for details see docs/COPYING.');
+               self::createDebugInstance(__CLASS__)->debugOutput('This is free software, and you are welcome to redistribute it under certain');
+               self::createDebugInstance(__CLASS__)->debugOutput('conditions; see docs/COPYING for details.');
+               self::createDebugInstance(__CLASS__)->debugOutput(' ');
        }
 
        /**
         * Add some cruncher-specific filters
         *
+        * @param       $controllerInstance     An object of a Controller instance
+        * @param       $responseInstance       An object of a Responseable instance
         * @return      void
+        * @todo        0% done
         */
-       public function addExtraCruncherFilters () {
+       public function addExtraFilters (Controller $controllerInstance, Responseable $responseInstance) {
                // Add some filters here
+               $this->partialStub('Please add some cruncher-specific filters, if required.');
        }
 }