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

	Code Coverage
	Classes and Traits			Functions and Methods				Lines
Total		0.00%	0 / 1		33.33%	4 / 12	CRAP		55.56%	40 / 72
Validator		0.00%	0 / 1		33.33%	4 / 12	180.47		55.56%	40 / 72
readableDirectory($value)					0.00%	0 / 1	4.37		71.43%	5 / 7
writableDirectory($value)					0.00%	0 / 1	20		0.00%	0 / 7
writableFile($value)					0.00%	0 / 1	20		0.00%	0 / 7
readableFile($value)					0.00%	0 / 1	4.37		71.43%	5 / 7
validUrl($value)					0.00%	0 / 1	3.14		75.00%	6 / 8
validEmail($value)					100.00%	1 / 1	4		100.00%	5 / 5
validIp($value)					100.00%	1 / 1	3		100.00%	5 / 5
validIpv4($value)					0.00%	0 / 1	12		0.00%	0 / 5
validIpv4NotReserved($value)					0.00%	0 / 1	3.33		66.67%	4 / 6
validIpv6($value)					0.00%	0 / 1	12		0.00%	0 / 5
fixRelativePath($path_with_dots)					100.00%	1 / 1	2		100.00%	4 / 4
fixPath($path)					100.00%	1 / 1	3		100.00%	6 / 6

1	<?php
2
3	namespace Environaut\Checks;
4
5	/**
6	* Default validator class that may be used in checks
7	* for common types of data (esp. the Configurator).
8	*/
9	class Validator
10	{
11	/**
12	* Validates the given path and throws an exception
13	* if it is not a regular directory or readable.
14	*
15	* @param string $value value to check
16	*
17	* @return string path to valid directory
18	*
19	* @throws \InvalidArgumentException in case of validation errors (empty value, irregular or non-readable directory)
20	*/
21	public static function readableDirectory($value)
22	{
23	if (empty($value)) {
24	throw new \InvalidArgumentException("Empty path given.");
25	}
26
27	if (!is_dir($value)) {
28	throw new \InvalidArgumentException("Given path is not a regular directory.");
29	}
30
31	if (!is_readable($value)) {
32	throw new \InvalidArgumentException("Given directory is not readable.");
33	}
34
35	return $value;
36	}
37
38	/**
39	* Validates the given path and throws an exception
40	* if it is not a regular directory or writable.
41	*
42	* @param string $value value to check
43	*
44	* @return string path to valid directory
45	*
46	* @throws \InvalidArgumentException in case of validation errors (empty value, irregular or non-writable directory)
47	*/
48	public static function writableDirectory($value)
49	{
50	if (empty($value)) {
51	throw new \InvalidArgumentException("Empty path given.");
52	}
53
54	if (!is_dir($value)) {
55	throw new \InvalidArgumentException("Given path is not a regular directory.");
56	}
57
58	if (!is_writable($value)) {
59	throw new \InvalidArgumentException("Given directory is not writable.");
60	}
61
62	return $value;
63	}
64
65	/**
66	* Validates the given file path and throws an exception
67	* if it is not a regular file or writable.
68	*
69	* @param string $value value to check
70	*
71	* @return string path to valid file
72	*
73	* @throws \InvalidArgumentException in case of validation errors (empty value or irregular or non-writable file)
74	*/
75	public static function writableFile($value)
76	{
77	if (empty($value)) {
78	throw new \InvalidArgumentException("Empty file path given.");
79	}
80
81	if (!is_file($value)) {
82	throw new \InvalidArgumentException("Given file path is not a regular file.");
83	}
84
85	if (!is_writable($value)) {
86	throw new \InvalidArgumentException("Given file is not writable.");
87	}
88
89	return $value;
90	}
91
92	/**
93	* Validates the given file path and throws an exception
94	* if it is not a regular file or readable.
95	*
96	* @param string $value value to check
97	*
98	* @return string path to valid file
99	*
100	* @throws \InvalidArgumentException in case of validation errors (empty value or irregular or non-readable file)
101	*/
102	public static function readableFile($value)
103	{
104	if (empty($value)) {
105	throw new \InvalidArgumentException("Empty file path given.");
106	}
107
108	if (!is_file($value)) {
109	throw new \InvalidArgumentException("Given file path is not a regular file.");
110	}
111
112	if (!is_readable($value)) {
113	throw new \InvalidArgumentException("Given file is not readable.");
114	}
115
116	return $value;
117	}
118
119	/**
120	* Validates the given URL and throws an exception if
121	* it is not valid (Only http and https are valid as
122	* protocols).
123	*
124	* @param string $value value to check
125	*
126	* @return string URL
127	*
128	* @throws \InvalidArgumentException in case of validation errors (invalid or empty URL)
129	*/
130	public static function validUrl($value)
131	{
132	if (empty($value)) {
133	throw new \InvalidArgumentException(
134	"Empty URL given. Valid URLs have the format: http(s)://[(sub.)domain\|ip][:port][/[optional_path]]"
135	);
136	}
137
138	// this pattern has been taken from the symfony url validator:
139	// https://github.com/symfony/Validator/blob/master/Constraints/UrlValidator.php
140	// @author Bernhard Schussek <bschussek@gmail.com>
141	$pattern = <<<EOT
142	~^
143	(http\|https):// # protocols
144	(
145	([\pL\pN\pS-]+\.)+[\pL]+ # domain name
146	\| # or
147	\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3} # IPv4 address
148	\| # or
149	\[
150	(?:(?:(?:(?:(?:(?:(?:[0-9a-f]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-f]{1,4})):
151	(?:(?:[0-9a-f]{1,4})))\|(?:(?:(?:(?:(?:25[0-5]\|(?:[1-9]\|1[0-9]\|2[0-4])?[0-9]))\.){3}
152	(?:(?:25[0-5]\|(?:[1-9]\|1[0-9]\|2[0-4])?[0-9])))))))\|(?:(?:::(?:(?:(?:[0-9a-f]{1,4})):){5})
153	(?:(?:(?:(?:(?:[0-9a-f]{1,4})):(?:(?:[0-9a-f]{1,4})))\|(?:(?:(?:(?:(?:25[0-5]\|
154	(?:[1-9]\|1[0-9]\|2[0-4])?[0-9]))\.){3}(?:(?:25[0-5]\|(?:[1-9]\|1[0-9]\|2[0-4])?[0-9])))))))\|
155	(?:(?:(?:(?:(?:[0-9a-f]{1,4})))?::(?:(?:(?:[0-9a-f]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-f]{1,4})):
156	(?:(?:[0-9a-f]{1,4})))\|(?:(?:(?:(?:(?:25[0-5]\|(?:[1-9]\|1[0-9]\|2[0-4])?[0-9]))\.){3}
157	(?:(?:25[0-5]\|(?:[1-9]\|1[0-9]\|2[0-4])?[0-9])))))))\|(?:(?:(?:(?:(?:(?:[0-9a-f]{1,4})):){0,1}
158	(?:(?:[0-9a-f]{1,4})))?::(?:(?:(?:[0-9a-f]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-f]{1,4})):
159	(?:(?:[0-9a-f]{1,4})))\|(?:(?:(?:(?:(?:25[0-5]\|(?:[1-9]\|1[0-9]\|2[0-4])?[0-9]))\.){3}
160	(?:(?:25[0-5]\|(?:[1-9]\|1[0-9]\|2[0-4])?[0-9])))))))\|(?:(?:(?:(?:(?:(?:[0-9a-f]{1,4})):){0,2}
161	(?:(?:[0-9a-f]{1,4})))?::(?:(?:(?:[0-9a-f]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-f]{1,4})):
162	(?:(?:[0-9a-f]{1,4})))\|(?:(?:(?:(?:(?:25[0-5]\|(?:[1-9]\|1[0-9]\|2[0-4])?[0-9]))\.){3}
163	(?:(?:25[0-5]\|(?:[1-9]\|1[0-9]\|2[0-4])?[0-9])))))))\|(?:(?:(?:(?:(?:(?:[0-9a-f]{1,4})):){0,3}
164	(?:(?:[0-9a-f]{1,4})))?::(?:(?:[0-9a-f]{1,4})):)(?:(?:(?:(?:(?:[0-9a-f]{1,4})):
165	(?:(?:[0-9a-f]{1,4})))\|(?:(?:(?:(?:(?:25[0-5]\|(?:[1-9]\|1[0-9]\|2[0-4])?[0-9]))\.){3}
166	(?:(?:25[0-5]\|(?:[1-9]\|1[0-9]\|2[0-4])?[0-9])))))))\|(?:(?:(?:(?:(?:(?:[0-9a-f]{1,4})):){0,4}
167	(?:(?:[0-9a-f]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-f]{1,4})):(?:(?:[0-9a-f]{1,4})))\|
168	(?:(?:(?:(?:(?:25[0-5]\|(?:[1-9]\|1[0-9]\|2[0-4])?[0-9]))\.){3}(?:(?:25[0-5]\|
169	(?:[1-9]\|1[0-9]\|2[0-4])?[0-9])))))))\|(?:(?:(?:(?:(?:(?:[0-9a-f]{1,4})):){0,5}
170	(?:(?:[0-9a-f]{1,4})))?::)(?:(?:[0-9a-f]{1,4})))\|(?:(?:(?:(?:(?:(?:[0-9a-f]{1,4})):){0,6}
171	(?:(?:[0-9a-f]{1,4})))?::))))
172	\] # IPv6 address
173	)
174	(:[0-9]+)? # port (optional)
175	(/?\|/\S+) # /, nothing or / with something
176	$~ixu
177	EOT;
178
179	if (!preg_match($pattern, $value)) {
180	throw new \InvalidArgumentException(
181	"Invalid URL given. Valid URLs have the format: http(s)://[(sub.)domain\|ip][:port][/[optional_path]]"
182	);
183	}
184
185	return $value;
186	}
187
188	/**
189	* Validates the given value using the PHP filter_var
190	* with FILTER_VALIDATE_EMAIL option.
191	*
192	* @param string $value value to check
193	*
194	* @return string email
195	*
196	* @throws \InvalidArgumentException in case of validation errors (invalid or empty email)
197	*/
198	public static function validEmail($value)
199	{
200	if (is_object($value) \|\| empty($value)) {
201	throw new \InvalidArgumentException("Empty email given.");
202	}
203
204	if (!filter_var((string)$value, FILTER_VALIDATE_EMAIL)) {
205	throw new \InvalidArgumentException("Invalid email address given.");
206	}
207
208	return $value;
209	}
210
211	/**
212	* Validates the given value using the PHP filter_var with
213	* FILTER_VALIDATE_IP.
214	*
215	* @param string $value IP to validate
216	*
217	* @return string ipv4 or ipv6 (may still be in private or reserved range)
218	*
219	* @throws \InvalidArgumentException in case of validation errors (invalid or empty ip)
220	*/
221	public static function validIp($value)
222	{
223	if (empty($value)) {
224	throw new \InvalidArgumentException("Empty IP address given.");
225	}
226
227	if (!filter_var($value, FILTER_VALIDATE_IP)) {
228	throw new \InvalidArgumentException("Invalid IP address given.");
229	}
230
231	return $value;
232	}
233
234	/**
235	* Validates the given value using the PHP filter_var with
236	* FILTER_VALIDATE_IP and flag FILTER_FLAG_IPV4.
237	*
238	* @param string $value IP to validate
239	*
240	* @return string ipv4 (may still be in private or reserved range)
241	*
242	* @throws \InvalidArgumentException in case of validation errors (invalid or empty ip)
243	*/
244	public static function validIpv4($value)
245	{
246	if (empty($value)) {
247	throw new \InvalidArgumentException("Empty IPv4 address given.");
248	}
249
250	if (!filter_var($value, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4)) {
251	throw new \InvalidArgumentException("Invalid IPv4 address given.");
252	}
253
254	return $value;
255	}
256
257	/**
258	* Validates the given value using the PHP filter_var with
259	* FILTER_VALIDATE_IP and flag FILTER_FLAG_IPV4 \| FILTER_FLAG_NO_RES_RANGE.
260	*
261	* @param string $value IP to validate
262	*
263	* @return string ipv4 (may still be in private range)
264	*
265	* @throws \InvalidArgumentException in case of validation errors (invalid or empty ip)
266	*/
267	public static function validIpv4NotReserved($value)
268	{
269	if (empty($value)) {
270	throw new \InvalidArgumentException("Empty IPv4 address given.");
271	}
272
273	if (!filter_var($value, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4 \| FILTER_FLAG_NO_RES_RANGE)) {
274	throw new \InvalidArgumentException(
275	"Invalid IPv4 address given. Reserved ranges like 240.0.0.0/4 are disallowed."
276	);
277	}
278
279	return $value;
280	}
281
282	/**
283	* Validates the given value using the PHP filter_var with
284	* FILTER_VALIDATE_IP and flag FILTER_FLAG_IPV6
285	*
286	* @param string $value IP to validate
287	*
288	* @return string ipv6 (may still be in private or reserved range)
289	*
290	* @throws \InvalidArgumentException in case of validation errors (invalid or empty ip)
291	*/
292	public static function validIpv6($value)
293	{
294	if (empty($value)) {
295	throw new \InvalidArgumentException("Empty IPv6 address given.");
296	}
297
298	if (!filter_var($value, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6)) {
299	throw new \InvalidArgumentException("Invalid IPv6 address given.");
300	}
301
302	return $value;
303	}
304
305	/**
306	* Resolves dots and double slashes in relative paths to get
307	* nicer paths: "dev/data/assets/../../foo" will be "dev/foo/"
308	* and "foo/./bar" will be "foo/bar" etc.
309	*
310	* @return string
311	*/
312	public static function fixRelativePath($path_with_dots)
313	{
314	do {
315	$path_with_dots = preg_replace('#[^/\.]+/\.\./#', '', $path_with_dots, -1, $count);
316	} while ($count);
317
318	$path_with_dots = str_replace(array('/./', '//'), '/', $path_with_dots);
319
320	return $path_with_dots;
321	}
322
323	/**
324	* Appends '/' to the path if necessary.
325	*
326	* @param string $path file system path
327	*
328	* @return string path with trailing slash
329	*/
330	public static function fixPath($path)
331	{
332	if (empty($path)) {
333	return $path;
334	}
335
336	if ('/' != $path{strlen($path) - 1}) {
337	$path .= '/';
338	}
339
340	return $path;
341	}
342	}