application/hub/main/producer/cruncher/work_units/class_CruncherTestUnitProducer.php

   1 <?php
   2 /**
   3  * A CruncherTestUnit producer 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 CruncherTestUnitProducer extends BaseUnitProducer implements UnitProducer, Registerable {
  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          * @return      $producerInstance       An instance of a Producer class
  39          */
  40         public final static function createCruncherTestUnitProducer () {
  41                 // Get new instance
  42                 $producerInstance = new CruncherTestUnitProducer();
  43
  44                 // Test units have a helper class that wraps the source
  45                 $helperInstance = ObjectFactory::createObjectByConfiguredName('crypto_random_message_helper_class', array('test'));
  46
  47                 // So set it in the producer
  48                 $producerInstance->setHelperInstance($helperInstance);
  49
  50                 // Return the prepared instance
  51                 return $producerInstance;
  52         }
  53
  54         /**
  55          * Initializes the producer. This method satisfies the abstract BaseProducer
  56          * class.
  57          *
  58          * @return      void
  59          */
  60         protected function initProducer () {
  61                 // Get a XML template instance
  62                 $templateInstance = XmlTemplateEngineFactory::createXmlTemplateEngineInstance('cruncher_test_unit_producer_template_class');
  63
  64                 // Load the template
  65                 $templateInstance->loadCruncherTestUnitTemplate('test_unit');
  66
  67                 // Render the XML content
  68                 $templateInstance->renderXmlContent();
  69
  70                 // And set it in this cruncher
  71                 $this->setTemplateInstance($templateInstance);
  72         }
  73
  74         /**
  75          * Produces some test units and pushes them onto the queue
  76          *
  77          * @return      void
  78          * @todo        ~30% done
  79          */
  80         public function produceUnits () {
  81                 // First get a database wrapper because we want to permanently store test units
  82                 $wrapperInstance = ObjectFactory::createObjectByConfiguredName('cruncher_unit_db_wrapper_class');
  83
  84                 // Now get a search instance
  85                 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
  86
  87                 // Add criteria for looking up already created and available test units
  88                 $searchInstance->addCriteria(CruncherUnitDatabaseWrapper::DB_COLUMN_UNIT_TYPE  , BaseUnitProducer::UNIT_TYPE_TEST_UNIT);
  89                 $searchInstance->addCriteria(CruncherUnitDatabaseWrapper::DB_COLUMN_UNIT_STATUS, BaseUnitProducer::UNIT_STATUS_AVAILABLE);
  90                 $searchInstance->setConfiguredLimit('cruncher_test_unit_max_count');
  91
  92                 // Search for our units
  93                 $resultInstance = $wrapperInstance->doSelectByCriteria($searchInstance);
  94
  95                 // Do we have some entries?
  96                 if ($resultInstance->next()) {
  97                         // Entries found
  98                         // @TODO Unfinished work here
  99                         $this->debugInstance();
 100                 } else {
 101                         // Get an encrypted, random message from our source
 102                         $encryptedMessage = $this->getHelperInstance()->generateRandomMessage();
 103
 104                         // Debug message
 105                         $this->debugOutput('PRODUCER: An encrypted, random message has been generated. Generating keys ...');
 106
 107                         // Set the encrypted message in the template instance
 108                         $this->getTemplateInstance()->assignVariable('encrypted_message', $encryptedMessage);
 109
 110                         /*
 111                          * Now we need to create an iterator, just as for the work units,
 112                          * to create new keys from the encrypted message. The iterator will
 113                          * not iterate over an object nor a collection. It will instead
 114                          * encapsulate the "key production" into a class and not in a simple
 115                          * for() loop. These keys then needs to be bundled into test units
 116                          * and stored to database for later re-usage.
 117                          */
 118
 119                         // First get an iterator, again the helper will do that for us
 120                         $iteratorInstance = $this->getHelperInstance()->getKeyIterator();
 121
 122                         // Begin the "key production"
 123                         while ($iteratorInstance->valid()) {
 124                                 // Get current key (which is not the key of the iterator)
 125                                 $currentKey = $iteratorInstance->current();
 126
 127                                 // @TODO Do something with it
 128                                 $this->debugOutput('currentKey=' . $currentKey . ' needs to be processed.');
 129
 130                                 // Continue with next one
 131                                 $iteratorInstance->next();
 132                         } // END - while
 133
 134                         die(__METHOD__ . ": Ended the key production.\n");
 135                 }
 136         }
 137 }
 138
 139 // [EOF]
 140 ?>