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 * @return $cruncherInstance An instance of this hub-cruncher class
43 public final static function createHubMcryptCruncher () {
45 $cruncherInstance = new HubMcryptCruncher();
47 // Return the instance
48 return $cruncherInstance;
52 * This method fills the in-buffer with (a) test unit(s) which are mainly
53 * used for development of the crunching part. They must be enabled in
54 * configuration, or else your cruncher runs out of WUs and waits for more
57 * In this method we already know that the in-buffer is going depleted so
58 * we don't need to double-check it here.
62 protected function fillInBufferQueueWithTestUnits () {
63 // Are test units enabled?
64 if ($this->getConfigInstance()->getConfigEntry('cruncher_test_units_enabled') == 'N') {
65 // They are disabled, so skip any further steps
67 } elseif ($this->getStateInstance()->isCruncherStateVirgin()) {
68 // No virgin crunchers please, because they usually have no test units ready for crunching
72 // Get a test-unit generator instance
73 $generatorInstance = ObjectFactory::createObjectByConfiguredName('cruncher_test_unit_generator_class');
75 // We don't need an iterator here because we just need to generate some test units
76 for ($idx = 0; $idx < $this->getConfigInstance()->getConfigEntry('cruncher_max_text_unit_amount'); $idx++) {
77 // Get a test unit from it
78 $unitInstance = $generatorInstance->generateNextUnitInstance();
80 // ... and finally queue it to the in-buffer queue
81 $this->queueUnitInstanceToInBuffer($unitInstance);
86 * This method fills the in-buffer with (real) WUs which will be crunched
87 * and the result be sent back to the key producer instance.
91 protected function fillInBufferQueueWithWorkUnits () {
92 // This cruncher's state must not be one of these: 'virgin'
93 if ($this->getStateInstance()->isCruncherStateVirgin()) {
94 // We can silently skip here, until the generation is finished
98 // @TODO Implement this method
99 $this->partialStub('Please implement this method.');
103 * Method to "bootstrap" the cruncher. This step does also apply provided
104 * command-line arguments stored in the request instance. No buffer queue
105 * will be initialized here, we only do "general" things here.
108 * @todo Implement this method
110 public function doBootstrapping () {
111 $this->partialStub('Please implement this method.');
115 * Outputs the console teaser. This should only be executed on startup or
116 * full restarts. This method generates some space around the teaser.
120 public function outputConsoleTeaser () {
122 $this->debugOutput(' ');
123 $this->debugOutput('MCrypt Cruncher v' . $this->getVersion() . ' is starting ...');
124 $this->debugOutput('Copyright (c) 2011 Hub Developer Team');
125 $this->debugOutput(' ');
126 $this->debugOutput('This program comes with ABSOLUTELY NO WARRANTY; for details see docs/COPYING.');
127 $this->debugOutput('This is free software, and you are welcome to redistribute it under certain');
128 $this->debugOutput('conditions; see docs/COPYING for details.');
129 $this->debugOutput(' ');
133 * Add some cruncher-specific filters
135 * @param $controllerInstance An object of a Controller instance
136 * @param $responseInstance An object of a Responseable instance
140 public function addExtraFilters (Controller $controllerInstance, Responseable $responseInstance) {
141 // Add some filters here
142 $this->partialStub('Please add some cruncher-specific filters, if required.');