3 * A hub-mcrypt cruncher class
5 * @author Roland Haeder <webmaster@ship-simu.org>
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
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.
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.
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/>.
24 class HubMcryptCruncher extends BaseHubCruncher implements CruncherHelper, Registerable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
35 $this->setVersion('0.0.0');
39 * Creates an instance of this hub-cruncher class
41 * @param $requestInstance An instance of a Requestable class
42 * @return $cruncherInstance An instance of this hub-cruncher class
44 public final static function createHubMcryptCruncher (Requestable $requestInstance) {
46 $cruncherInstance = new HubMcryptCruncher();
48 // Set the request instance
49 $cruncherInstance->setRequestInstance($requestInstance);
51 // Return the instance
52 return $cruncherInstance;
56 * Method to "bootstrap" the cruncher. This step does also apply provided
57 * command-line arguments stored in the request instance. No buffer queue
58 * will be initialized here, we do only "general" things here.
61 * @todo Implement this method
63 public function doBootstrapping () {
64 $this->partialStub('Please implement this method.');
68 * This method determines if the in-buffer is going to depleted and if so,
69 * it fetches more WUs from the network. If no WU can be fetched from the
70 * network and if enabled, a random test WU is being generated.
74 public function doFetchWorkUnits () {
75 // Simply check if we have enough WUs left in the in-buffer queue (a FIFO)
76 if (!$this->isInBufferQueueFilled()) {
77 // The in-buffer queue needs filling, so head out and get some work
78 $this->fillInBufferQueueWithWorkUnits();
80 // Is the buffer still not filled and are test-packages allowed?
81 if ((!$this->isInBufferQueueFilled()) && ($this->getConfigInstance()->getConfigEntry('cruncher_allow_test_units') == 'Y')) {
82 // Then fill the in-buffer with (one) test-unit(s)
83 $this->fillInBufferQueueWithTestUnits();
89 * Outputs the console teaser. This should only be executed on startup or
90 * full restarts. This method generates some space around the teaser.
94 public function outputConsoleTeaser () {
96 $this->debugOutput(' ');
97 $this->debugOutput('MCrypt Cruncher v' . $this->getVersion() . ' is starting ...');
98 $this->debugOutput('Copyright (c) 2011 MCrypt Cruncher Developer Team');
99 $this->debugOutput(' ');
100 $this->debugOutput('This program comes with ABSOLUTELY NO WARRANTY; for details see docs/COPYING.');
101 $this->debugOutput('This is free software, and you are welcome to redistribute it under certain');
102 $this->debugOutput('conditions; see docs/COPYING for details.');
103 $this->debugOutput(' ');
107 * Add some cruncher-specific filters
109 * @param $controllerInstance An object of a Controller instance
110 * @param $responseInstance An object of a Responseable instance
114 public function addExtraFilters (Controller $controllerInstance, Responseable $responseInstance) {
115 // Add some filters here
116 $this->partialStub('Please add some cruncher-specific filters, if required.');