Context Navigation

source: trunk/lib/Utilities.inc.php @ 348

Last change on this file since 348 was 348, checked in by quinn, 15 years ago

File size: 35.3 KB

Line
1	<?php
2	/**
3	* Utilities.inc.php
4	* Code by Strangecode :: www.strangecode.com :: This document contains copyrighted information
5	*/
6
7
8	/**
9	* Print variable dump.
10	*
11	* @param mixed $var Variable to dump.
12	* @param bool $display Hide the dump in HTML comments?
13	* @param bool $var_dump Use var_dump instead of print_r.
14	*/
15	function dump($var, $display=false, $var_dump=false)
16	{
17	echo $display ? "\n<br /><pre>\n" : "\n\n\n<!--\n";
18	if ($var_dump) {
19	var_dump($var);
20	} else {
21	print_r($var);
22	}
23	echo $display ? "\n</pre><br />\n" : "\n-->\n\n\n";
24	}
25
26	/**
27	* Return dump as variable.
28	*
29	* @param mixed $var Variable to dump.
30	* @param bool $serialize Remove line-endings. Useful for logging variables.
31	* @return string Dump of var.
32	*/
33	function getDump($var, $serialize=false)
34	{
35	ob_start();
36	print_r($var);
37	$d = ob_get_contents();
38	ob_end_clean();
39	return $serialize ? preg_replace('/\s+/m', '', $d) : $d;
40	}
41
42	/**
43	* Return dump as cleaned text. Useful for dumping data into emails.
44	*
45	* @param array $var Variable to dump.
46	* @param strong $indent A string to prepend indented lines (tab for example).
47	* @return string Dump of var.
48	*/
49	function fancyDump($var, $indent='')
50	{
51	$output = '';
52	if (is_array($var)) {
53	foreach ($var as $k=>$v) {
54	$k = ucfirst(mb_strtolower(str_replace(array('_', ' '), ' ', $k)));
55	if (is_array($v)) {
56	$output .= sprintf("\n%s%s: %s\n", $indent, $k, fancyDump($v, $indent . $indent));
57	} else {
58	$output .= sprintf("%s%s: %s\n", $indent, $k, $v);
59	}
60	}
61	} else {
62	$output .= sprintf("%s%s\n", $indent, $var);
63	}
64	return $output;
65	}
66
67	/**
68	* Returns text with appropriate html translations.
69	*
70	* @param string $text Text to clean.
71	* @param bool $preserve_html If set to true, oTxt will not translate <, >, ", or '
72	* characters into HTML entities. This allows HTML to pass through unmunged.
73	* @return string Cleaned text.
74	*/
75	function oTxt($text, $preserve_html=false)
76	{
77	$app =& App::getInstance();
78
79	$search = array();
80	$replace = array();
81
82	// Make converted ampersand entities into normal ampersands (they will be done manually later) to retain HTML entities.
83	$search['retain_ampersand'] = '/&/';
84	$replace['retain_ampersand'] = '&';
85
86	if ($preserve_html) {
87	// Convert characters that must remain non-entities for displaying HTML.
88	$search['retain_left_angle'] = '/</';
89	$replace['retain_left_angle'] = '<';
90
91	$search['retain_right_angle'] = '/>/';
92	$replace['retain_right_angle'] = '>';
93
94	$search['retain_single_quote'] = '/'/';
95	$replace['retain_single_quote'] = "'";
96
97	$search['retain_double_quote'] = '/"/';
98	$replace['retain_double_quote'] = '"';
99	}
100
101	// & becomes &. Exclude any occurrence where the & is followed by a alphanum or unicode character.
102	$search['ampersand'] = '/&(?![\w\d#]{1,10};)/';
103	$replace['ampersand'] = '&';
104
105	return preg_replace($search, $replace, htmlspecialchars($text, ENT_QUOTES, $app->getParam('character_set')));
106	}
107
108	/**
109	* Returns text with stylistic modifications. Warning: this will break some HTML attributes!
110	* TODO: Allow a string such as this to be passed: <a href="javascript:openPopup('/foo/bar.php')">Click here</a>
111	*
112	* @param string $text Text to clean.
113	* @return string Cleaned text.
114	*/
115	function fancyTxt($text)
116	{
117	$search = array();
118	$replace = array();
119
120	// "double quoted text" becomes “double quoted text”
121	$search['double_quotes'] = '/(^\|[^\w=])(?:"\|"\|"\|"\|“)([^"]+?)(?:"\|"\|"\|"\|”)([^\w]\|$)/ms'; // " is the same as " and " and "
122	$replace['double_quotes'] = '$1“$2”$3';
123
124	// text's apostrophes become text’s apostrophes
125	$search['apostrophe'] = '/(\w)(?:\'\|'\|')(\w)/ms';
126	$replace['apostrophe'] = '$1’$2';
127
128	// 'single quoted text' becomes ‘single quoted text’
129	$search['single_quotes'] = '/(^\|[^\w=])(?:\'\|'\|‘)([^\']+?)(?:\'\|'\|’)([^\w]\|$)/ms';
130	$replace['single_quotes'] = '$1‘$2’$3';
131
132	// plural posessives' apostrophes become posessives’
133	$search['apostrophes'] = '/(s)(?:\'\|'\|')(\s)/ms';
134	$replace['apostrophes'] = '$1’$2';
135
136	// em--dashes become em—dashes
137	$search['em_dash'] = '/(\s[^!<-])--([^>-]\s)/';
138	$replace['em_dash'] = '$1—$2';
139
140	return preg_replace($search, $replace, $text);
141	}
142
143	/**
144	* Applies a class to search terms to highlight them ala google results.
145	*
146	* @param string $text Input text to search.
147	* @param string $search String of word(s) that will be highlighted.
148	* @param string $class CSS class to apply.
149	* @return string Text with searched words wrapped in <span>.
150	*/
151	function highlightWords($text, $search, $class='sc-highlightwords')
152	{
153	$words = preg_split('/[^\w]/', $search, -1, PREG_SPLIT_NO_EMPTY);
154
155	$search = array();
156	$replace = array();
157
158	foreach ($words as $w) {
159	if ('' != trim($w)) {
160	$search[] = '/\b(' . preg_quote($w) . ')\b/i';
161	$replace[] = '<span class="' . $class . '">$1</span>';
162	}
163	}
164
165	return empty($replace) ? $text : preg_replace($search, $replace, $text);
166	}
167
168
169	/**
170	* Generates a hexadecimal html color based on provided word.
171	*
172	* @access public
173	* @param string $text A string for which to convert to color.
174	* @return string A hexadecimal html color.
175	*/
176	function getTextColor($text, $method=1)
177	{
178	$hash = md5($text);
179	$rgb = array(
180	mb_substr($hash, 0, 1),
181	mb_substr($hash, 1, 1),
182	mb_substr($hash, 2, 1),
183	mb_substr($hash, 3, 1),
184	mb_substr($hash, 4, 1),
185	mb_substr($hash, 5, 1),
186	);
187
188	switch ($method) {
189	case 1 :
190	default :
191	// Reduce all hex values slightly to avoid all white.
192	array_walk($rgb, create_function('&$v', '$v = dechex(round(hexdec($v) * 0.87));'));
193	break;
194	case 2 :
195	foreach ($rgb as $i => $v) {
196	if (hexdec($v) > hexdec('c')) {
197	$rgb[$i] = dechex(hexdec('f') - hexdec($v));
198	}
199	}
200	break;
201	}
202
203	return join('', $rgb);
204	}
205
206	/**
207	* Encodes a string into unicode values 128-255.
208	* Useful for hiding an email address from spambots.
209	*
210	* @access public
211	* @param string $text A line of text to encode.
212	* @return string Encoded text.
213	*/
214	function encodeAscii($text)
215	{
216	$output = '';
217	$num = mb_strlen($text);
218	for ($i=0; $i<$num; $i++) {
219	$output .= sprintf('&#%03s', ord($text{$i}));
220	}
221	return $output;
222	}
223
224	/**
225	* Encodes an email into a "user at domain dot com" format.
226	*
227	* @access public
228	* @param string $email An email to encode.
229	* @param string $at Replaces the @.
230	* @param string $dot Replaces the ..
231	* @return string Encoded email.
232	*/
233	function encodeEmail($email, $at=' at ', $dot=' dot ')
234	{
235	$search = array('/@/', '/\./');
236	$replace = array($at, $dot);
237	return preg_replace($search, $replace, $email);
238	}
239
240	/**
241	* Turns "a really long string" into "a rea...string"
242	*
243	* @access public
244	* @param string $str Input string
245	* @param int $len Maximum string length.
246	* @param string $where Where to cut the string. One of: 'start', 'middle', or 'end'.
247	* @return string Truncated output string
248	* @author Quinn Comendant <quinn@strangecode.com>
249	* @since 29 Mar 2006 13:48:49
250	*/
251	function truncate($str, $len, $where='middle', $delim='…')
252	{
253	if ($len <= 3 \|\| mb_strlen($str) <= 3) {
254	return '';
255	}
256	$part1 = floor(($len - 3) / 2);
257	$part2 = ceil(($len - 3) / 2);
258	switch ($where) {
259	case 'start' :
260	return preg_replace(array(sprintf('/^.{4,}(.{%s})$/sU', $part1 + $part2), '/\s\.{3,}\s/sU'), array($delim . '$1', $delim), $str);
261	break;
262	default :
263	case 'middle' :
264	return preg_replace(array(sprintf('/^(.{%s}).{4,}(.{%s})$/sU', $part1, $part2), '/\s\.{3,}\s/sU'), array('$1' . $delim . '$2', $delim), $str);
265	break;
266	case 'end' :
267	return preg_replace(array(sprintf('/^(.{%s}).{4,}$/sU', $part1 + $part2), '/\s\.{3,}\s/sU'), array('$1' . $delim, $delim), $str);
268	break;
269	}
270	}
271
272	/*
273	* A substitution for the missing mb_ucfirst function.
274	*
275	* @access public
276	* @param string $strong The string
277	* @return string String with uper-cased first character.
278	* @author Quinn Comendant <quinn@strangecode.com>
279	* @version 1.0
280	* @since 06 Dec 2008 17:04:01
281	*/
282	if (!function_exists('mb_ucfirst')) {
283	function mb_ucfirst($string)
284	{
285	return mb_strtoupper(mb_substr($string, 0, 1)) . mb_substr($string, 1, mb_strlen($string));
286	}
287	}
288
289	/**
290	* Return a human readable disk space measurement. Input value measured in bytes.
291	*
292	* @param int $size Size in bytes.
293	* @param int $unit The maximum unit
294	* @param int $format The return string format
295	* @author Aidan Lister <aidan@php.net>
296	* @version 1.1.0
297	*/
298	function humanFileSize($size, $format='%01.2f %s', $max_unit=null, $multiplier=1024)
299	{
300	// Units
301	$units = array('B', 'KB', 'MB', 'GB', 'TB');
302	$ii = count($units) - 1;
303
304	// Max unit
305	$max_unit = array_search((string) $max_unit, $units);
306	if ($max_unit === null \|\| $max_unit === false) {
307	$max_unit = $ii;
308	}
309
310	// Loop
311	$i = 0;
312	while ($max_unit != $i && $size >= $multiplier && $i < $ii) {
313	$size /= $multiplier;
314	$i++;
315	}
316
317	return sprintf($format, $size, $units[$i]);
318	}
319
320	/*
321	* Returns a human readable amount of time for the given amount of seconds.
322	*
323	* 45 seconds
324	* 12 minutes
325	* 3.5 hours
326	* 2 days
327	* 1 week
328	* 4 months
329	*
330	* Months are calculated using the real number of days in a year: 365.2422 / 12.
331	*
332	* @access public
333	* @param int $seconds Seconds of time.
334	* @param string $max_unit Key value from the $units array.
335	* @param string $format Sprintf formatting string.
336	* @return string Value of units elapsed.
337	* @author Quinn Comendant <quinn@strangecode.com>
338	* @version 1.0
339	* @since 23 Jun 2006 12:15:19
340	*/
341	function humanTime($seconds, $max_unit=null, $format='%01.1f')
342	{
343	// Units: array of seconds in the unit, singular and plural unit names.
344	$units = array(
345	'second' => array(1, _("second"), _("seconds")),
346	'minute' => array(60, _("minute"), _("minutes")),
347	'hour' => array(3600, _("hour"), _("hours")),
348	'day' => array(86400, _("day"), _("days")),
349	'week' => array(604800, _("week"), _("weeks")),
350	'month' => array(2629743.84, _("month"), _("months")),
351	'year' => array(31556926.08, _("year"), _("years")),
352	'decade' => array(315569260.8, _("decade"), _("decades")),
353	);
354
355	// Max unit to calculate.
356	$max_unit = isset($units[$max_unit]) ? $max_unit : 'decade';
357
358	$final_time = $seconds;
359	$last_unit = 'second';
360	foreach ($units as $k => $v) {
361	if ($max_unit != $k && $seconds >= $v[0]) {
362	$final_time = $seconds / $v[0];
363	$last_unit = $k;
364	}
365	}
366	$final_time = sprintf($format, $final_time);
367	return sprintf('%s %s', $final_time, (1 == $final_time ? $units[$last_unit][1] : $units[$last_unit][2]));
368	}
369
370	/**
371	* Tests the existence of a file anywhere in the include path.
372	*
373	* @param string $file File in include path.
374	* @return mixed False if file not found, the path of the file if it is found.
375	* @author Quinn Comendant <quinn@strangecode.com>
376	* @since 03 Dec 2005 14:23:26
377	*/
378	function fileExistsIncludePath($file)
379	{
380	$app =& App::getInstance();
381
382	foreach (explode(PATH_SEPARATOR, get_include_path()) as $path) {
383	$fullpath = $path . DIRECTORY_SEPARATOR . $file;
384	if (file_exists($fullpath)) {
385	$app->logMsg(sprintf('Found file "%s" at path: %s', $file, $fullpath), LOG_DEBUG, __FILE__, __LINE__);
386	return $fullpath;
387	} else {
388	$app->logMsg(sprintf('File "%s" not found in include_path: %s', $file, get_include_path()), LOG_DEBUG, __FILE__, __LINE__);
389	return false;
390	}
391	}
392	}
393
394	/**
395	* Returns stats of a file from the include path.
396	*
397	* @param string $file File in include path.
398	* @param mixed $stat Which statistic to return (or null to return all).
399	* @return mixed Value of requested key from fstat(), or false on error.
400	* @author Quinn Comendant <quinn@strangecode.com>
401	* @since 03 Dec 2005 14:23:26
402	*/
403	function statIncludePath($file, $stat=null)
404	{
405	// Open file pointer read-only using include path.
406	if ($fp = fopen($file, 'r', true)) {
407	// File opened successfully, get stats.
408	$stats = fstat($fp);
409	fclose($fp);
410	// Return specified stats.
411	return is_null($stat) ? $stats : $stats[$stat];
412	} else {
413	return false;
414	}
415	}
416
417	/*
418	* Writes content to the specified file. This function emulates the functionality of file_put_contents from PHP 5.
419	*
420	* @access public
421	* @param string $filename Path to file.
422	* @param string $content Data to write into file.
423	* @return bool Success or failure.
424	* @author Quinn Comendant <quinn@strangecode.com>
425	* @since 11 Apr 2006 22:48:30
426	*/
427	function filePutContents($filename, $content)
428	{
429	$app =& App::getInstance();
430
431	// Open file for writing and truncate to zero length.
432	if ($fp = fopen($filename, 'w')) {
433	if (flock($fp, LOCK_EX)) {
434	if (!fwrite($fp, $content, mb_strlen($content))) {
435	$app->logMsg(sprintf('Failed writing to file: %s', $filename), LOG_ERR, __FILE__, __LINE__);
436	fclose($fp);
437	return false;
438	}
439	flock($fp, LOCK_UN);
440	} else {
441	$app->logMsg(sprintf('Could not lock file for writing: %s', $filename), LOG_ERR, __FILE__, __LINE__);
442	fclose($fp);
443	return false;
444	}
445	fclose($fp);
446	// Success!
447	$app->logMsg(sprintf('Wrote to file: %s', $filename), LOG_DEBUG, __FILE__, __LINE__);
448	return true;
449	} else {
450	$app->logMsg(sprintf('Could not open file for writing: %s', $filename), LOG_ERR, __FILE__, __LINE__);
451	return false;
452	}
453	}
454
455
456	/**
457	* If $var is net set or null, set it to $default. Otherwise leave it alone.
458	* Returns the final value of $var. Use to find a default value of one is not available.
459	*
460	* @param mixed $var The variable that is being set.
461	* @param mixed $default What to set it to if $val is not currently set.
462	* @return mixed The resulting value of $var.
463	*/
464	function setDefault(&$var, $default='')
465	{
466	if (!isset($var)) {
467	$var = $default;
468	}
469	return $var;
470	}
471
472	/**
473	* Like preg_quote() except for arrays, it takes an array of strings and puts
474	* a backslash in front of every character that is part of the regular
475	* expression syntax.
476	*
477	* @param array $array input array
478	* @param array $delim optional character that will also be escaped.
479	* @return array an array with the same values as $array1 but shuffled
480	*/
481	function pregQuoteArray($array, $delim='/')
482	{
483	if (!empty($array)) {
484	if (is_array($array)) {
485	foreach ($array as $key=>$val) {
486	$quoted_array[$key] = preg_quote($val, $delim);
487	}
488	return $quoted_array;
489	} else {
490	return preg_quote($array, $delim);
491	}
492	}
493	}
494
495	/**
496	* Converts a PHP Array into encoded URL arguments and return them as an array.
497	*
498	* @param mixed $data An array to transverse recursively, or a string
499	* to use directly to create url arguments.
500	* @param string $prefix The name of the first dimension of the array.
501	* If not specified, the first keys of the array will be used.
502	* @return array URL with array elements as URL key=value arguments.
503	*/
504	function urlEncodeArray($data, $prefix='', $_return=true)
505	{
506
507	// Data is stored in static variable.
508	static $args;
509
510	if (is_array($data)) {
511	foreach ($data as $key => $val) {
512	// If the prefix is empty, use the $key as the name of the first dimension of the "array".
513	// ...otherwise, append the key as a new dimension of the "array".
514	$new_prefix = ('' == $prefix) ? urlencode($key) : $prefix . '[' . urlencode($key) . ']';
515	// Enter recursion.
516	urlEncodeArray($val, $new_prefix, false);
517	}
518	} else {
519	// We've come to the last dimension of the array, save the "array" and its value.
520	$args[$prefix] = urlencode($data);
521	}
522
523	if ($_return) {
524	// This is not a recursive execution. All recursion is complete.
525	// Reset static var and return the result.
526	$ret = $args;
527	$args = array();
528	return is_array($ret) ? $ret : array();
529	}
530	}
531
532	/**
533	* Converts a PHP Array into encoded URL arguments and return them in a string.
534	*
535	* @param mixed $data An array to transverse recursively, or a string
536	* to use directly to create url arguments.
537	* @param string $prefix The name of the first dimension of the array.
538	* If not specified, the first keys of the array will be used.
539	* @return string url A string ready to append to a url.
540	*/
541	function urlEncodeArrayToString($data, $prefix='')
542	{
543
544	$array_args = urlEncodeArray($data, $prefix);
545	$url_args = '';
546	$delim = '';
547	foreach ($array_args as $key=>$val) {
548	$url_args .= $delim . $key . '=' . $val;
549	$delim = ini_get('arg_separator.output');
550	}
551	return $url_args;
552	}
553
554	/**
555	* Fills an array with the result from a multiple ereg search.
556	* Courtesy of Bruno - rbronosky@mac.com - 10-May-2001
557	*
558	* @param mixed $pattern regular expression needle
559	* @param mixed $string haystack
560	* @return array populated with each found result
561	*/
562	function eregAll($pattern, $string)
563	{
564	do {
565	if (!mb_ereg($pattern, $string, $temp)) {
566	continue;
567	}
568	$string = str_replace($temp[0], '', $string);
569	$results[] = $temp;
570	} while (mb_ereg($pattern, $string, $temp));
571	return $results;
572	}
573
574	/**
575	* Prints the word "checked" if a variable is set, and optionally matches
576	* the desired value, otherwise prints nothing,
577	* used for printing the word "checked" in a checkbox form input.
578	*
579	* @param mixed $var the variable to compare
580	* @param mixed $value optional, what to compare with if a specific value is required.
581	*/
582	function frmChecked($var, $value=null)
583	{
584	if (func_num_args() == 1 && $var) {
585	// 'Checked' if var is true.
586	echo ' checked="checked" ';
587	} else if (func_num_args() == 2 && $var == $value) {
588	// 'Checked' if var and value match.
589	echo ' checked="checked" ';
590	} else if (func_num_args() == 2 && is_array($var)) {
591	// 'Checked' if the value is in the key or the value of an array.
592	if (isset($var[$value])) {
593	echo ' checked="checked" ';
594	} else if (in_array($value, $var)) {
595	echo ' checked="checked" ';
596	}
597	}
598	}
599
600	/**
601	* prints the word "selected" if a variable is set, and optionally matches
602	* the desired value, otherwise prints nothing,
603	* otherwise prints nothing, used for printing the word "checked" in a
604	* select form input
605	*
606	* @param mixed $var the variable to compare
607	* @param mixed $value optional, what to compare with if a specific value is required.
608	*/
609	function frmSelected($var, $value=null)
610	{
611	if (func_num_args() == 1 && $var) {
612	// 'selected' if var is true.
613	echo ' selected="selected" ';
614	} else if (func_num_args() == 2 && $var == $value) {
615	// 'selected' if var and value match.
616	echo ' selected="selected" ';
617	} else if (func_num_args() == 2 && is_array($var)) {
618	// 'selected' if the value is in the key or the value of an array.
619	if (isset($var[$value])) {
620	echo ' selected="selected" ';
621	} else if (in_array($value, $var)) {
622	echo ' selected="selected" ';
623	}
624	}
625	}
626
627	/**
628	* Adds slashes to values of an array and converts the array to a comma
629	* delimited list. If value provided is a string return the string
630	* escaped. This is useful for putting values coming in from posted
631	* checkboxes into a SET column of a database.
632	*
633	*
634	* @param array $in Array to convert.
635	* @return string Comma list of array values.
636	*/
637	function escapedList($in, $separator="', '")
638	{
639	$db =& DB::getInstance();
640
641	if (is_array($in) && !empty($in)) {
642	return join($separator, array_map(array($db, 'escapeString'), $in));
643	} else {
644	return $db->escapeString($in);
645	}
646	}
647
648	/**
649	* Converts a human string date into a SQL-safe date. Dates nearing
650	* infinity use the date 2038-01-01 so conversion to unix time format
651	* remain within valid range.
652	*
653	* @param array $date String date to convert.
654	* @param array $format Date format to pass to date().
655	* Default produces MySQL datetime: 0000-00-00 00:00:00.
656	* @return string SQL-safe date.
657	*/
658	function strToSQLDate($date, $format='Y-m-d H:i:s')
659	{
660	// Translate the human string date into SQL-safe date format.
661	if (empty($date) \|\| mb_strpos($date, '0000-00-00') !== false \|\| strtotime($date) === -1 \|\| strtotime($date) === false) {
662	// Return a string of zero time, formatted the same as $format.
663	return strtr($format, array(
664	'Y' => '0000',
665	'm' => '00',
666	'd' => '00',
667	'H' => '00',
668	'i' => '00',
669	's' => '00',
670	));
671	} else {
672	return date($format, strtotime($date));
673	}
674	}
675
676	/**
677	* If magic_quotes_gpc is in use, run stripslashes() on $var. If $var is an
678	* array, stripslashes is run on each value, recursively, and the stripped
679	* array is returned.
680	*
681	* @param mixed $var The string or array to un-quote, if necessary.
682	* @return mixed $var, minus any magic quotes.
683	*/
684	function dispelMagicQuotes($var)
685	{
686	static $magic_quotes_gpc;
687
688	if (!isset($magic_quotes_gpc)) {
689	$magic_quotes_gpc = get_magic_quotes_gpc();
690	}
691
692	if ($magic_quotes_gpc) {
693	if (!is_array($var)) {
694	$var = stripslashes($var);
695	} else {
696	foreach ($var as $key=>$val) {
697	if (is_array($val)) {
698	$var[$key] = dispelMagicQuotes($val);
699	} else {
700	$var[$key] = stripslashes($val);
701	}
702	}
703	}
704	}
705	return $var;
706	}
707
708	/**
709	* Get a form variable from GET or POST data, stripped of magic
710	* quotes if necessary.
711	*
712	* @param string $var (optional) The name of the form variable to look for.
713	* @param string $default (optional) The value to return if the
714	* variable is not there.
715	* @return mixed A cleaned GET or POST if no $var specified.
716	* @return string A cleaned form $var if found, or $default.
717	*/
718	function getFormData($var=null, $default=null)
719	{
720	if ('POST' == getenv('REQUEST_METHOD') && is_null($var)) {
721	return dispelMagicQuotes($_POST);
722	} else if ('GET' == getenv('REQUEST_METHOD') && is_null($var)) {
723	return dispelMagicQuotes($_GET);
724	}
725	if (isset($_POST[$var])) {
726	return dispelMagicQuotes($_POST[$var]);
727	} else if (isset($_GET[$var])) {
728	return dispelMagicQuotes($_GET[$var]);
729	} else {
730	return $default;
731	}
732	}
733	function getPost($var=null, $default=null)
734	{
735	if (is_null($var)) {
736	return dispelMagicQuotes($_POST);
737	}
738	if (isset($_POST[$var])) {
739	return dispelMagicQuotes($_POST[$var]);
740	} else {
741	return $default;
742	}
743	}
744	function getGet($var=null, $default=null)
745	{
746	if (is_null($var)) {
747	return dispelMagicQuotes($_GET);
748	}
749	if (isset($_GET[$var])) {
750	return dispelMagicQuotes($_GET[$var]);
751	} else {
752	return $default;
753	}
754	}
755
756	/**
757	* Signs a value using md5 and a simple text key. In order for this
758	* function to be useful (i.e. secure) the key must be kept secret, which
759	* means keeping it as safe as database credentials. Putting it into an
760	* environment variable set in httpd.conf is a good place.
761	*
762	* @access public
763	* @param string $val The string to sign.
764	* @param string $salt (Optional) A text key to use for computing the signature.
765	* @param string $length (Optional) The length of the added signature. Longer signatures are safer. Must match the length passed to verifySignature() for the signatures to match.
766	* @return string The original value with a signature appended.
767	*/
768	function addSignature($val, $salt=null, $length=18)
769	{
770	$app =& App::getInstance();
771
772	if ('' == trim($val)) {
773	$app->logMsg(sprintf('Cannot add signature to an empty string.', null), LOG_INFO, __FILE__, __LINE__);
774	return '';
775	}
776
777	if (!isset($salt)) {
778	$salt = $app->getParam('signing_key');
779	}
780
781	return $val . '-' . mb_strtolower(mb_substr(md5($salt . md5($val . $salt)), 0, $length));
782	}
783
784	/**
785	* Strips off the signature appended by addSignature().
786	*
787	* @access public
788	* @param string $signed_val The string to sign.
789	* @return string The original value with a signature removed.
790	*/
791	function removeSignature($signed_val)
792	{
793	if (empty($signed_val) \|\| mb_strpos($signed_val, '-') === false) {
794	return '';
795	}
796	return mb_substr($signed_val, 0, mb_strrpos($signed_val, '-'));
797	}
798
799
800	/**
801	* Verifies a signature appened to a value by addSignature().
802	*
803	* @access public
804	* @param string $signed_val A value with appended signature.
805	* @param string $salt (Optional) A text key to use for computing the signature.
806	* @return bool True if the signature matches the var.
807	*/
808	function verifySignature($signed_val, $salt=null, $length=18)
809	{
810	// All comparisons are done using lower-case strings.
811	$signed_val = mb_strtolower($signed_val);
812	// Strip the value from the signed value.
813	$val = removeSignature($signed_val);
814	// If the signed value matches the original signed value we consider the value safe.
815	if ($signed_val == addSignature($val, $salt, $length)) {
816	// Signature verified.
817	return true;
818	} else {
819	return false;
820	}
821	}
822
823	/**
824	* Sends empty output to the browser and flushes the php buffer so the client
825	* will see data before the page is finished processing.
826	*/
827	function flushBuffer()
828	{
829	echo str_repeat(' ', 205);
830	flush();
831	}
832
833	/**
834	* Adds email address to mailman mailing list. Requires /etc/sudoers entry for apache to sudo execute add_members.
835	* Don't forget to allow php_admin_value open_basedir access to "/var/mailman/bin".
836	*
837	* @access public
838	* @param string $email Email address to add.
839	* @param string $list Name of list to add to.
840	* @param bool $send_welcome_message True to send welcome message to subscriber.
841	* @return bool True on success, false on failure.
842	*/
843	function mailmanAddMember($email, $list, $send_welcome_message=false)
844	{
845	$app =& App::getInstance();
846
847	$add_members = '/usr/lib/mailman/bin/add_members';
848	/// FIXME: checking of executable is disabled.
849	if (true \|\| is_executable($add_members) && is_readable($add_members)) {
850	$welcome_msg = $send_welcome_message ? 'y' : 'n';
851	exec(sprintf("/bin/echo '%s' \| /usr/bin/sudo %s -r - --welcome-msg=%s --admin-notify=n '%s'", escapeshellarg($email), escapeshellarg($add_members), $welcome_msg, escapeshellarg($list)), $stdout, $return_code);
852	if (0 == $return_code) {
853	$app->logMsg(sprintf('Mailman add member success for list: %s, user: %s', $list, $email), LOG_INFO, __FILE__, __LINE__);
854	return true;
855	} else {
856	$app->logMsg(sprintf('Mailman add member failed for list: %s, user: %s, with message: %s', $list, $email, $stdout), LOG_WARNING, __FILE__, __LINE__);
857	return false;
858	}
859	} else {
860	$app->logMsg(sprintf('Mailman add member program not executable: %s', $add_members), LOG_ALERT, __FILE__, __LINE__);
861	return false;
862	}
863	}
864
865	/**
866	* Removes email address from mailman mailing list. Requires /etc/sudoers entry for apache to sudo execute add_members.
867	* Don't forget to allow php_admin_value open_basedir access to "/var/mailman/bin".
868	*
869	* @access public
870	* @param string $email Email address to add.
871	* @param string $list Name of list to add to.
872	* @param bool $send_user_ack True to send goodbye message to subscriber.
873	* @return bool True on success, false on failure.
874	*/
875	function mailmanRemoveMember($email, $list, $send_user_ack=false)
876	{
877	$app =& App::getInstance();
878
879	$remove_members = '/usr/lib/mailman/bin/remove_members';
880	/// FIXME: checking of executable is disabled.
881	if (true \|\| is_executable($remove_members) && is_readable($remove_members)) {
882	$userack = $send_user_ack ? '' : '--nouserack';
883	exec(sprintf("/usr/bin/sudo %s %s --noadminack '%s' '%s'", escapeshellarg($remove_members), $userack, escapeshellarg($list), escapeshellarg($email)), $stdout, $return_code);
884	if (0 == $return_code) {
885	$app->logMsg(sprintf('Mailman remove member success for list: %s, user: %s', $list, $email), LOG_INFO, __FILE__, __LINE__);
886	return true;
887	} else {
888	$app->logMsg(sprintf('Mailman remove member failed for list: %s, user: %s, with message: %s', $list, $email, $stdout), LOG_WARNING, __FILE__, __LINE__);
889	return false;
890	}
891	} else {
892	$app->logMsg(sprintf('Mailman remove member program not executable: %s', $remove_members), LOG_ALERT, __FILE__, __LINE__);
893	return false;
894	}
895	}
896
897	/**
898	* Returns the remote IP address, taking into consideration proxy servers.
899	*
900	* @param bool $dolookup If true we resolve to IP to a host name,
901	* if false we don't.
902	* @return string IP address if $dolookup is false or no arg
903	* Hostname if $dolookup is true
904	*/
905	function getRemoteAddr($dolookup=false)
906	{
907	$ip = getenv('HTTP_CLIENT_IP');
908	if (in_array($ip, array('', 'unknown', 'localhost', '127.0.0.1'))) {
909	$ip = getenv('HTTP_X_FORWARDED_FOR');
910	if (mb_strpos($ip, ',') !== false) {
911	// If HTTP_X_FORWARDED_FOR returns a comma-delimited list of IPs then return the first one (assuming the first is the original).
912	$ips = explode(',', $ip, 2);
913	$ip = $ips[0];
914	}
915	if (in_array($ip, array('', 'unknown', 'localhost', '127.0.0.1'))) {
916	$ip = getenv('REMOTE_ADDR');
917	}
918	}
919	return $dolookup && '' != $ip ? gethostbyaddr($ip) : $ip;
920	}
921
922	/**
923	* Tests whether a given IP address can be found in an array of IP address networks.
924	* Elements of networks array can be single IP addresses or an IP address range in CIDR notation
925	* See: http://en.wikipedia.org/wiki/Classless_inter-domain_routing
926	*
927	* @access public
928	* @param string IP address to search for.
929	* @param array Array of networks to search within.
930	* @return mixed Returns the network that matched on success, false on failure.
931	*/
932	function ipInRange($ip, $networks)
933	{
934	if (!is_array($networks)) {
935	$networks = array($networks);
936	}
937
938	$ip_binary = sprintf('%032b', ip2long($ip));
939	foreach ($networks as $network) {
940	if (preg_match('![\d\.]{7,15}/\d{1,2}!', $network)) {
941	// IP is in CIDR notation.
942	list($cidr_ip, $cidr_bitmask) = explode('/', $network);
943	$cidr_ip_binary = sprintf('%032b', ip2long($cidr_ip));
944	if (mb_substr($ip_binary, 0, $cidr_bitmask) === mb_substr($cidr_ip_binary, 0, $cidr_bitmask)) {
945	// IP address is within the specified IP range.
946	return $network;
947	}
948	} else {
949	if ($ip === $network) {
950	// IP address exactly matches.
951	return $network;
952	}
953	}
954	}
955
956	return false;
957	}
958
959	/**
960	* If the given $url is on the same web site, return true. This can be used to
961	* prevent from sending sensitive info in a get query (like the SID) to another
962	* domain.
963	*
964	* @param string $url the URI to test.
965	* @return bool True if given $url is our domain or has no domain (is a relative url), false if it's another.
966	*/
967	function isMyDomain($url)
968	{
969	static $urls = array();
970
971	if (!isset($urls[$url])) {
972	if (!preg_match('\|https?://[\w.]+/\|', $url)) {
973	// If we can't find a domain we assume the URL is local (i.e. "/my/url/path/" or "../img/file.jpg").
974	$urls[$url] = true;
975	} else {
976	$urls[$url] = preg_match('\|https?://[\w.]*' . preg_quote(getenv('HTTP_HOST'), '\|') . '\|i', $url);
977	}
978	}
979	return $urls[$url];
980	}
981
982	/**
983	* Takes a URL and returns it without the query or anchor portion
984	*
985	* @param string $url any kind of URI
986	* @return string the URI with ? or # and everything after removed
987	*/
988	function stripQuery($url)
989	{
990	return preg_replace('/[?#].*$/', '', $url);
991	}
992
993	/**
994	* Returns a fully qualified URL to the current script, including the query.
995	*
996	* @return string a full url to the current script
997	*/
998	function absoluteMe()
999	{
1000	$protocol = ('on' == getenv('HTTPS')) ? 'https://' : 'http://';
1001	return $protocol . getenv('HTTP_HOST') . getenv('REQUEST_URI');
1002	}
1003
1004	/**
1005	* Compares the current url with the referring url.
1006	*
1007	* @param bool $exclude_query Remove the query string first before comparing.
1008	* @return bool True if the current URL is the same as the referring URL, false otherwise.
1009	*/
1010	function refererIsMe($exclude_query=false)
1011	{
1012	if ($exclude_query) {
1013	return (stripQuery(absoluteMe()) == stripQuery(getenv('HTTP_REFERER')));
1014	} else {
1015	return (absoluteMe() == getenv('HTTP_REFERER'));
1016	}
1017	}
1018
1019	/**
1020	* Stub functions used when installation does not have
1021	* GNU gettext extension installed
1022	*/
1023	if (!extension_loaded('gettext')) {
1024	/**
1025	* Translates text
1026	*
1027	* @access public
1028	* @param string $text the text to be translated
1029	* @return string translated text
1030	*/
1031	function gettext($text) {
1032	return $text;
1033	}
1034
1035	/**
1036	* Translates text
1037	*
1038	* @access public
1039	* @param string $text the text to be translated
1040	* @return string translated text
1041	*/
1042	function _($text) {
1043	return $text;
1044	}
1045
1046	/**
1047	* Translates text by domain
1048	*
1049	* @access public
1050	* @param string $domain the language to translate the text into
1051	* @param string $text the text to be translated
1052	* @return string translated text
1053	*/
1054	function dgettext($domain, $text) {
1055	return $text;
1056	}
1057
1058	/**
1059	* Translates text by domain and category
1060	*
1061	* @access public
1062	* @param string $domain the language to translate the text into
1063	* @param string $text the text to be translated
1064	* @param string $category the language dialect to use
1065	* @return string translated text
1066	*/
1067	function dcgettext($domain, $text, $category) {
1068	return $text;
1069	}
1070
1071	/**
1072	* Binds the text domain
1073	*
1074	* @access public
1075	* @param string $domain the language to translate the text into
1076	* @param string
1077	* @return string translated text
1078	*/
1079	function bindtextdomain($domain, $directory) {
1080	return $domain;
1081	}
1082
1083	/**
1084	* Sets the text domain
1085	*
1086	* @access public
1087	* @param string $domain the language to translate the text into
1088	* @return string translated text
1089	*/
1090	function textdomain($domain) {
1091	return $domain;
1092	}
1093	}
1094
1095
1096
1097	?>

Note: See TracBrowser for help on using the repository browser.

Download in other formats: