Code Coverage for /home/graste/projects/environaut/src/Environaut/Checks/PhpSettingCheck.php

	Code Coverage
	Classes and Traits			Functions and Methods				Lines
Total		0.00%	0 / 1		66.67%	4 / 6	CRAP		94.51%	172 / 182
PhpSettingCheck		0.00%	0 / 1		66.67%	4 / 6	58.56		94.51%	172 / 182
getDefaultGroupName()					100.00%	1 / 1	1		100.00%	1 / 1
run()					0.00%	0 / 1	30.54		91.59%	98 / 107
getSupportedComparisons()					100.00%	1 / 1	1		100.00%	8 / 8
compareIntegers($value, $setting_value)					0.00%	0 / 1	7		96.00%	24 / 25
getOperator($value)					100.00%	1 / 1	13		100.00%	20 / 20
getIntegerValue($value)					100.00%	1 / 1	6		100.00%	21 / 21

1	<?php
2
3	namespace Environaut\Checks;
4
5	use Environaut\Checks\Check;
6
7	/**
8	* This check compares PHP runtime configuration options (from php.ini etc.) against given values.
9	* The following comparison operations are supported:
10	* - "equals": the default comparison; checks whether the setting is exactly as given (e.g. "foo")
11	* - "null": checks whether the setting is NULL
12	* - "notempty": checks whether the setting has a value set (that is, not null or empty string)
13	* - "version": checks how versions compare (e.g. "=>2.6.30")
14	* - "regex": checks whether the PHP setting's value matches the given regular expression (e.g. "/file\.ini/"
15	* - "integer": checks whether the integer or byte value of the PHP setting is correct (e.g. ">30" or ">=256M")
16	*
17	* By default the name of the check will be used as the PHP runtime setting name to check. For integer
18	* or byte values that may be set to infinite values (like "-1" or "0") you can specify the setting's
19	* infite value via the "infinite" parameter. The comparison operation is "equals" by default and
20	* may be specified via the "comparison" parameter.
21	*
22	* All supported parameters are:
23	* - "setting": name of setting to check (defaults to the "name" of the check)
24	* - "custom_name": name to be used for messages if the check's name is used as setting name
25	* - "value": the value to compare the setting's value against
26	* - "infinite": the infinite value of the setting to check (e.g. "-1" or "0" for integer or byte values)
27	* - "comparison": the comparison operation to use (see above)
28	* - "help": message to display when the setting's value is not correct
29	*/
30	class PhpSettingCheck extends Check
31	{
32	/**
33	* Default group name used in messages of the report.
34	* By default also used as default setting group name if not customized.
35	*/
36	const DEFAULT_CUSTOM_GROUP_NAME = 'PHP Settings';
37
38	/**
39	* Returns the default group name this check uses when none is specified.
40	*
41	* @return string default group name of the check
42	*/
43	public function getDefaultGroupName()
44	{
45	return self::DEFAULT_CUSTOM_GROUP_NAME;
46	}
47
48	public function run()
49	{
50	$params = $this->getParameters();
51
52	$setting = $params->get('setting', $this->getName());
53	if (empty($setting)) {
54	throw new \InvalidArgumentException(
55	'Parameter "setting" must be a (valid) php.ini setting to check on class "' . get_class($this) . '".'
56	);
57	}
58
59	$custom_name = $params->get('custom_name', $this->getName());
60	$help = $params->get('help');
61	$setting_value = $params->get('value');
62	$infinite_value = $params->get('infinite');
63	$comparison = strtolower($params->get('comparison', 'equals'));
64
65	if (!in_array($comparison, self::getSupportedComparisons())) {
66	throw new \InvalidArgumentException(
67	'Unsupported comparison name: "' . $comparison .
68	'". Supported are: ' . implode(', ', self::getSupportedComparisons())
69	);
70	}
71
72	/**
73	* The value of the configuration option as
74	* - a string on success or
75	* - an empty string for null values or
76	* - false if the setting doesn't exist
77	*/
78	$value = ini_get($setting);
79
80	$okay = true;
81	if (false === $value) {
82	$this->addError('There is no setting with the name "' . $setting . '".', $custom_name);
83	$okay = false;
84	} else {
85	switch ($comparison) {
86	case 'integer':
87	// bail out here directly to not compare float values like "2.75M" or "1e3"
88	if ($value !== trim($value) \|\| strpos($value, '.') !== false \|\| stripos($value, 'e') !== false) {
89	$this->addError(
90	'Value of "' . $setting . '" should be "' . $setting_value .
91	'", but is: "' . $value . '". Leading whitespace or ' .
92	'decimal values will fail in practice as PHP treats e.g. "2.75M" as "2M"!',
93	$custom_name
94	);
95	$okay = false;
96	break;
97	}
98
99	if ((null !== $infinite_value && $value != $infinite_value) \|\| null === $infinite_value) {
100	$okay = self::compareIntegers($value, $setting_value);
101	if (!$okay) {
102	$this->addError(
103	'Value of "' . $setting . '" should be "' . $setting_value .
104	'", but is: "' . $value . '"',
105	$custom_name
106	);
107	}
108	}
109	break;
110	case 'regex':
111	if (!preg_match($setting_value, $value)) {
112	$this->addError(
113	'Value of "' . $setting . '" does not match "' . $setting_value .
114	'": ' . $value . '"',
115	$custom_name
116	);
117	$okay = false;
118	}
119	break;
120	case 'version':
121	$operator = self::getOperator($setting_value);
122	$setting_value_without_operator = ltrim($setting_value, '<>!=');
123	if (!version_compare($value, $setting_value_without_operator, $operator)) {
124	$this->addError(
125	'Version of "' . $setting . '" should be "' . $setting_value .
126	'", but is: "' . $value . '"',
127	$custom_name
128	);
129	$okay = false;
130	}
131	break;
132	case 'notempty':
133	if ($value === null \|\| $value === "") {
134	$this->addError(
135	'Value of "' . $setting . '" should not be NULL or empty string, but is: "' . $value .
136	'"',
137	$custom_name
138	);
139	$okay = false;
140	}
141	break;
142	case 'null':
143	if ($value !== "") {
144	$this->addError(
145	'Value of "' . $setting . '" must be NULL, but is: "' . $value . '"',
146	$custom_name
147	);
148	$okay = false;
149	}
150	break;
151	case 'notequals':
152	if ($value === $setting_value) {
153	$this->addError(
154	'Value of "' . $setting . '" should not be "' . $setting_value . '", but is: "' . $value .
155	'"',
156	$custom_name
157	);
158	$okay = false;
159	}
160	break;
161	case 'equals':
162	default:
163	if ($value === "" && $setting_value === "0") {
164	break; // boolean value should be off (and can be reported as "" or "0" according to php docs)
165	}
166	if ($value !== $setting_value) {
167	$this->addError(
168	'Value of "' . $setting . '" should be "' . $setting_value . '", but is: "' . $value .
169	'"',
170	$custom_name
171	);
172	$okay = false;
173	}
174	break;
175	}
176	}
177
178	if (!$okay && $help !== null) {
179	// TODO depending on local/global value and access level we could generate
180	// a small help here where to change the ini setting
181	$this->addNotice($help, $custom_name);
182	}
183
184	if ($okay) {
185	// TODO give better info depending on comparison type?
186	$this->addInfo('Value of "' . $setting . '" is okay: "' . $value . '"', $custom_name);
187	}
188
189	return $okay;
190	}
191
192	/**
193	* Returns the supported comparison names that may be used in comparison operations.
194	*
195	* @return array of strings (supported comparison names)
196	*/
197	public static function getSupportedComparisons()
198	{
199	return array(
200	'equals',
201	'notequals',
202	'regex',
203	'notempty',
204	'null',
205	'version',
206	'integer',
207	);
208	}
209
210	/**
211	* Compares the given values according to the comparison operator the second
212	* value might have and returns whether the evaluation is true.
213	*
214	* @param string $value integer value that is set in php.ini (e.g. "8M")
215	* @param string $setting_value comparison value as string (e.g. ">=8M")
216	*
217	* @return bool true if comparison is okay; false otherwise.
218	*/
219	public static function compareIntegers($value, $setting_value)
220	{
221	$okay = false;
222
223	$actual = self::getIntegerValue($value);
224	$operator = self::getOperator($setting_value);
225	$expected = self::getIntegerValue($setting_value);
226	switch ($operator) {
227	case '>':
228	$okay = $actual > $expected;
229	break;
230	case '>=':
231	$okay = $actual >= $expected;
232	break;
233	case '<':
234	$okay = $actual < $expected;
235	break;
236	case '<=':
237	$okay = $actual <= $expected;
238	break;
239	case '!=':
240	$okay = $actual != $expected;
241	break;
242	case '=':
243	default:
244	$okay = $actual == $expected;
245	break;
246	}
247
248	return $okay;
249	}
250
251	/**
252	* Returns the comparison operator part of the given value. Valid known
253	* comparison operators are: "<", ">", "<=", ">=", "!=" and "=".
254	* By default a ">=" will be returned (if no comparison operator is found).
255	*
256	* @param string $value string that might contain a comparison operator (e.g. "<=2M")
257	*
258	* @return string operator string found
259	*/
260	public static function getOperator($value)
261	{
262	// TODO make this smarter and perhaps support "eq", "ne", "le", "ge" etc.
263	$operator = strpos($value, '>=') === 0 ? '>=' : null;
264	if (null === $operator) {
265	$operator = strpos($value, '>') === 0 ? '>' : null;
266	}
267	if (null === $operator) {
268	$operator = strpos($value, '=') === 0 ? '=' : null;
269	}
270	if (null === $operator) {
271	$operator = strpos($value, '<=') === 0 ? '<=' : null;
272	}
273	if (null === $operator) {
274	$operator = strpos($value, '<') === 0 ? '<' : null;
275	}
276	if (null === $operator) {
277	$operator = strpos($value, '!=') === 0 ? '!=' : null;
278	}
279	if (null === $operator) {
280	$operator = '>=';
281	}
282
283	return $operator;
284	}
285
286	/**
287	* Returns the integer value of the given value.
288	*
289	* @param mixed $value string to interpret (e.g. ">=2.75M")
290	*
291	* @return int integer value as PHP interprets it on ini settings
292	*/
293	public static function getIntegerValue($value)
294	{
295	if (!is_numeric($value)) {
296	// strip excessive whitespace
297	$value = trim($value);
298	// strip comparison operator
299	$value = ltrim($value, '<>!=');
300	// remove the K\|M\|G suffix if necessary
301	$len = strlen($value);
302	if (!is_numeric($value)) {
303	$quantity = substr($value, 0, $len - 1);
304	// we need this, as PHP sets a memory_limit of 0 if the ini value is 0.25M
305	// another example: 2.75M will be 2M for PHP (e.g. on post_max_size)
306	$quantity = intval($quantity);
307	} else {
308	$quantity = $value;
309	}
310	// get unit if this string represents a byte value
311	$unit = strtolower(substr($value, $len - 1));
312	switch ($unit) {
313	case 'k':
314	$quantity *= 1024;
315	break;
316	case 'm':
317	$quantity *= 1048576;
318	break;
319	case 'g':
320	$quantity *= 1073741824;
321	break;
322	}
323
324	return $quantity;
325	}
326
327	return intval($value);
328	}
329	}