application/hub/main/cruncher/class_BaseHubCruncher.php

   1 <?php
   2 /**
   3  * A general hub 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 abstract class BaseHubCruncher extends BaseHubSystem implements Updateable {
  25         /**
  26          * Version information
  27          */
  28         private $version = 'x.x';
  29
  30         /**
  31          * By default no cruncher is active
  32          */
  33         private $isActive = false;
  34
  35         /**
  36          * All buffer queue instances (a FIFO)
  37          */
  38         private $bufferInstance = NULL;
  39
  40         /**
  41          * Protected constructor
  42          *
  43          * @param       $className      Name of the class
  44          * @return      void
  45          */
  46         protected function __construct ($className) {
  47                 // Call parent constructor
  48                 parent::__construct($className);
  49
  50                 // Init this cruncher
  51                 $this->initCruncher();
  52         }
  53
  54         /**
  55          * Initialize the cruncher generically
  56          *
  57          * @return      void
  58          */
  59         private function initCruncher () {
  60                 // Init the state
  61                 CruncherStateFactory::createCruncherStateInstanceByName('init', $this);
  62         }
  63
  64         /**
  65          * Getter for version
  66          *
  67          * @return      $version        Version number of this cruncher
  68          */
  69         protected final function getVersion () {
  70                 return $this->version;
  71         }
  72
  73         /**
  74          * Setter for version
  75          *
  76          * @param       $version        Version number of this cruncher
  77          * @return      void
  78          */
  79         protected final function setVersion ($version) {
  80                 $this->version = (string) $version;
  81         }
  82
  83         /**
  84          * Checks whether the in-buffer queue is filled by comparing it's current
  85          * amount of entries against a threshold.
  86          *
  87          * @return      $isFilled       Whether the in-buffer is filled
  88          */
  89         protected function isInBufferQueueFilled () {
  90                 // Determine it
  91                 $isFilled = ($this->bufferInstance->getStackCount('in_queue') > $this->getConfigInstance()->getConfigEntry('cruncher_in_buffer_min_threshold'));
  92
  93                 // And return the result
  94                 return $isFilled;
  95         }
  96
  97         /**
  98          * This method fills the in-buffer with (a) test unit(s) which are mainly
  99          * used for development of the crunching part. They must be enabled in
 100          * configuration, or else your cruncher runs out of WUs and waits for more
 101          * to show up.
 102          *
 103          * In this method we already know that the in-buffer is going depleted so
 104          * we don't need to double-check it here.
 105          *
 106          * @return      void
 107          */
 108         abstract protected function fillInBufferQueueWithTestUnits ();
 109
 110         /**
 111          * This method fills the in-buffer with (real) WUs which will be crunched
 112          * and the result be sent back to the key producer instance.
 113          *
 114          * @return      void
 115          */
 116         abstract protected function fillInBufferQueueWithWorkUnits ();
 117
 118         /**
 119          * Enables/disables the cruncher (just sets a flag)
 120          *
 121          * @param       $version        Version number of this cruncher
 122          * @return      void
 123          */
 124         public final function enableIsActive ($isActive = true) {
 125                 $this->isActive = (bool) $isActive;
 126         }
 127
 128         /**
 129          * Determines whether the cruncher is active
 130          *
 131          * @return      $isActive       Whether the cruncher is active
 132          */
 133         public final function isActive () {
 134                 return $this->isActive;
 135         }
 136
 137         /**
 138          * Initializes all buffer queues (mostly in/out). This method is demanded
 139          * by the CruncherHelper interface.
 140          *
 141          * @return      void
 142          */
 143         public function initBufferQueues () {
 144                 /*
 145                  * Initialize both buffer queues, we can use the FIFO class here
 146                  * directly and encapsulate its method calls with protected methods.
 147                  */
 148                 $this->bufferInstance = ObjectFactory::createObjectByConfiguredName('cruncher_buffer_stacker_class');
 149
 150                 // Initialize common stackers, like in/out
 151                 $this->bufferInstance->initStacker('in_queue');
 152                 $this->bufferInstance->initStacker('out_queue');
 153
 154                 // Output debug message
 155                 $this->debugOutput('CRUNCHER: All buffers are now initialized.');
 156         }
 157
 158         /**
 159          * This method determines if the in-buffer is going to depleted and if so,
 160          * it fetches more WUs from the network. If no WU can be fetched from the
 161          * network and if enabled, a random test WU is being generated.
 162          *
 163          * This method is demanded from the CruncherHelper interface.
 164          *
 165          * @return      void
 166          */
 167         public function doFetchWorkUnits () {
 168                 // Simply check if we have enough WUs left in the in-buffer queue (a FIFO)
 169                 if (!$this->isInBufferQueueFilled()) {
 170                         // The in-buffer queue needs filling, so head out and get some work
 171                         $this->fillInBufferQueueWithWorkUnits();
 172
 173                         // Is the buffer still not filled and are test-packages allowed?
 174                         if ((!$this->isInBufferQueueFilled()) && ($this->getConfigInstance()->getConfigEntry('cruncher_test_units_enabled') == 'Y')) {
 175                                 // Then fill the in-buffer with (one) test-unit(s)
 176                                 $this->fillInBufferQueueWithTestUnits();
 177                         } // END - if
 178                 } // END - if
 179         }
 180
 181         /**
 182          * Updates a given field with new value
 183          *
 184          * @param       $fieldName              Field to update
 185          * @param       $fieldValue             New value to store
 186          * @return      void
 187          * @throws      DatabaseUpdateSupportException  If this class does not support database updates
 188          * @todo        Try to make this method more generic so we can move it in BaseFrameworkSystem
 189          */
 190         public function updateDatabaseField ($fieldName, $fieldValue) {
 191                 // Unfinished
 192                 $this->partialStub('Unfinished!');
 193                 return;
 194         }
 195 }
 196
 197 // [EOF]
 198 ?>