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) 2011 - 2012 Cruncher 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->loadXmlTemplate();
  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          * Prepares the produces of some test units and pushes them onto the queue
  76          *
  77          * @param       $stateInstance  An instance of a Stateable instance
  78          * @return      void
  79          * @todo        ~60% done
  80          */
  81         public function prepareUnitProduction (Stateable $stateInstance) {
  82                 // First get a database wrapper because we want to permanently store test units
  83                 $wrapperInstance = ObjectFactory::createObjectByConfiguredName('cruncher_unit_db_wrapper_class');
  84
  85                 // Now get a search instance
  86                 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
  87
  88                 // Add criteria for looking up already created and available test units
  89                 $searchInstance->addCriteria(CruncherUnitDatabaseWrapper::DB_COLUMN_UNIT_TYPE  , BaseUnitProducer::UNIT_TYPE_TEST_UNIT);
  90                 $searchInstance->addCriteria(CruncherUnitDatabaseWrapper::DB_COLUMN_UNIT_STATUS, BaseUnitProducer::UNIT_STATUS_AVAILABLE);
  91                 $searchInstance->setConfiguredLimit('cruncher_test_unit_max_count');
  92
  93                 // Search for our units
  94                 $resultInstance = $wrapperInstance->doSelectByCriteria($searchInstance);
  95
  96                 // Do we have some entries?
  97                 if ($resultInstance->next()) {
  98                         // Entries found
  99                         // @TODO Unfinished work here
 100                         $this->debugInstance();
 101
 102                         // The state must be changed because ...
 103                         $stateInstance->someFooStateChange();
 104                 } else {
 105                         // Get an encrypted, random message from our source
 106                         $encryptedMessage = $this->getHelperInstance()->generateRandomMessage();
 107
 108                         // Debug message
 109                         self::createDebugInstance(__CLASS__)->debugOutput('PRODUCER: An encrypted, random message has been generated. Generating keys ...');
 110
 111                         // Set the encrypted message in the template instance
 112                         $this->getTemplateInstance()->assignVariable('encrypted_message', $encryptedMessage);
 113
 114                         // The state must be changed because we have a new message
 115                         $stateInstance->encryptedMessageGenerated();
 116                 }
 117         }
 118 }
 119
 120 // [EOF]
 121 ?>