Updated 'core'.
[hub.git] / application / hub / main / filter / node / class_NodePhpRequirementsFilter.php
1 <?php
2 /**
3  * A PhpRequirements filter for nodes
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.shipsimu.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 NodePhpRequirementsFilter extends BaseNodeFilter implements Filterable {
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 filter class
37          *
38          * @return      $filterInstance         An instance of this filter class
39          */
40         public static final function createNodePhpRequirementsFilter () {
41                 // Get a new instance
42                 $filterInstance = new NodePhpRequirementsFilter();
43
44                 // Return the instance
45                 return $filterInstance;
46         }
47
48         /**
49          * Executes the filter with given request and response objects
50          *
51          * @param       $requestInstance        An instance of a class with an Requestable interface
52          * @param       $responseInstance       An instance of a class with an Responseable interface
53          * @return      void
54          * @throws      FilterChainException    If a required PHP function is not available
55          * @todo        Add more test and try to add an extra message to the thrown exception
56          */
57         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
58                 // By default, the requirement check is passed and zero checks are failed
59                 $checkPassed = TRUE;
60                 $checksFailed = 0;
61
62                 // Socket support is essential...
63                 if (!function_exists('socket_create')) {
64                         // Test failed
65                         $checkPassed = FALSE;
66                         $checksFailed++;
67                 } // END - if
68
69                 // If scrypt() is not found (ext-scrypt) then the "Hubcoins reward" is not working
70                 if ((extension_loaded('scrypt')) && (is_callable('scrypt'))) {
71                         // Mark it as working
72                         self::createDebugInstance(__CLASS__)->debugOutput('FILTER[' . __METHOD__ . ':' . __LINE__ . '] ext-scrypt and a callable scrypt() function found. "Hubcoin reward" feature possible.');
73                         $this->getConfigInstance()->setConfigEntry('extension_scrypt_loaded', TRUE);
74                 } else {
75                         // Not working (not all have ext-scrypt installed
76                         self::createDebugInstance(__CLASS__)->debugOutput('FILTER[' . __METHOD__ . ':' . __LINE__ . '] ext-scrypt not found or scrypt() function not found. "Hubcoin reward" feature disabled.');
77                 }
78
79                 // Are all tests passed?
80                 if ($checkPassed === FALSE) {
81                         // Throw an exception
82                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
83                 } // END - if
84         }
85 }
86
87 // [EOF]
88 ?>