Cruncher continued and rewritten to use states:

[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 c31309971efefc8e0d3023e964c4ddec59ad8159..65fb3ca9e06da1589a96bdf01360df172cf07d70 100644 (file)
--- a/application/hub/main/cruncher/mcrypt/class_HubMcryptCruncher.php
+++ b/application/hub/main/cruncher/mcrypt/class_HubMcryptCruncher.php
@@ -38,51 +38,77 @@ class HubMcryptCruncher extends BaseHubCruncher implements CruncherHelper, Regis
        /**
         * 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;
        }
 
        /**
-        * Method to "bootstrap" the cruncher. This step does also apply provided
-        * command-line arguments stored in the request instance. No buffer queue
-        * will be initialized here, we do only "general" things here.
+        * 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
-        * @todo        Implement this method
         */
-       public function doBootstrapping () {
-               $this->partialStub('Please implement this method.');
+       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 determines if the in-buffer is going to depleted and if so,
-        * it fetches more WUs from the network. If no WU can be fetched from the
-        * network and if enabled, a random test WU is being generated.
+        * 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
         */
-       public function doFetchWorkUnits () {
-               // Simply check if we have enough WUs left in the in-buffer queue (a FIFO)
-               if (!$this->isInBufferQueueFilled()) {
-                       // The in-buffer queue needs filling, so head out and get some work
-                       $this->fillInBufferQueueWithWorkUnits();
-
-                       // Is the buffer still not filled and are test-packages allowed?
-                       if ((!$this->isInBufferQueueFilled()) && ($this->getConfigInstance()->getConfigEntry('cruncher_allow_test_units') == 'Y')) {
-                               // Then fill the in-buffer with (one) test-unit(s)
-                               $this->fillInBufferQueueWithTestUnits();
-                       } // END - if
+       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. No buffer queue
+        * will be initialized here, we only do "general" things here.
+        *
+        * @return      void
+        * @todo        Implement this method
+        */
+       public function doBootstrapping () {
+               $this->partialStub('Please implement this method.');
        }
 
        /**
@@ -95,7 +121,7 @@ class HubMcryptCruncher extends BaseHubCruncher implements CruncherHelper, Regis
                // Output all lines
                $this->debugOutput(' ');
                $this->debugOutput('MCrypt Cruncher v' . $this->getVersion() . ' is starting ...');
-               $this->debugOutput('Copyright (c) 2011 MCrypt Cruncher Developer Team');
+               $this->debugOutput('Copyright (c) 2011 Hub Developer Team');
                $this->debugOutput(' ');
                $this->debugOutput('This program comes with ABSOLUTELY NO WARRANTY; for details see docs/COPYING.');
                $this->debugOutput('This is free software, and you are welcome to redistribute it under certain');