Context Navigation

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

Last change on this file since 334 was 334, checked in by quinn, 16 years ago
Fixed lots of misplings. I'm so embarrassed! ;P
File size: 34.7 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 mixed $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	* Return a human readable filesize.
274	*
275	* @param int $size Size
276	* @param int $unit The maximum unit
277	* @param int $format The return string format
278	* @author Aidan Lister <aidan@php.net>
279	* @version 1.1.0
280	*/
281	function humanFileSize($size, $format='%01.2f %s', $max_unit=null)
282	{
283	// Units
284	$units = array('B', 'KB', 'MB', 'GB', 'TB');
285	$ii = count($units) - 1;
286
287	// Max unit
288	$max_unit = array_search((string) $max_unit, $units);
289	if ($max_unit === null \|\| $max_unit === false) {
290	$max_unit = $ii;
291	}
292
293	// Loop
294	$i = 0;
295	while ($max_unit != $i && $size >= 1024 && $i < $ii) {
296	$size /= 1024;
297	$i++;
298	}
299
300	return sprintf($format, $size, $units[$i]);
301	}
302
303	/*
304	* Returns a human readable amount of time for the given amount of seconds.
305	*
306	* 45 seconds
307	* 12 minutes
308	* 3.5 hours
309	* 2 days
310	* 1 week
311	* 4 months
312	*
313	* Months are calculated using the real number of days in a year: 365.2422 / 12.
314	*
315	* @access public
316	* @param int $seconds Seconds of time.
317	* @param string $max_unit Key value from the $units array.
318	* @param string $format Sprintf formatting string.
319	* @return string Value of units elapsed.
320	* @author Quinn Comendant <quinn@strangecode.com>
321	* @version 1.0
322	* @since 23 Jun 2006 12:15:19
323	*/
324	function humanTime($seconds, $max_unit=null, $format='%01.1f')
325	{
326	// Units: array of seconds in the unit, singular and plural unit names.
327	$units = array(
328	'second' => array(1, _("second"), _("seconds")),
329	'minute' => array(60, _("minute"), _("minutes")),
330	'hour' => array(3600, _("hour"), _("hours")),
331	'day' => array(86400, _("day"), _("days")),
332	'week' => array(604800, _("week"), _("weeks")),
333	'month' => array(2629743.84, _("month"), _("months")),
334	'year' => array(31556926.08, _("year"), _("years")),
335	'decade' => array(315569260.8, _("decade"), _("decades")),
336	);
337
338	// Max unit to calculate.
339	$max_unit = isset($units[$max_unit]) ? $max_unit : 'decade';
340
341	$final_time = $seconds;
342	$last_unit = 'second';
343	foreach ($units as $k => $v) {
344	if ($max_unit != $k && $seconds >= $v[0]) {
345	$final_time = $seconds / $v[0];
346	$last_unit = $k;
347	}
348	}
349	$final_time = sprintf($format, $final_time);
350	return sprintf('%s %s', $final_time, (1 == $final_time ? $units[$last_unit][1] : $units[$last_unit][2]));
351	}
352
353	/**
354	* Tests the existence of a file anywhere in the include path.
355	*
356	* @param string $file File in include path.
357	* @return mixed False if file not found, the path of the file if it is found.
358	* @author Quinn Comendant <quinn@strangecode.com>
359	* @since 03 Dec 2005 14:23:26
360	*/
361	function fileExistsIncludePath($file)
362	{
363	$app =& App::getInstance();
364
365	foreach (explode(PATH_SEPARATOR, get_include_path()) as $path) {
366	$fullpath = $path . DIRECTORY_SEPARATOR . $file;
367	if (file_exists($fullpath)) {
368	$app->logMsg(sprintf('Found file "%s" at path: %s', $file, $fullpath), LOG_DEBUG, __FILE__, __LINE__);
369	return $fullpath;
370	} else {
371	$app->logMsg(sprintf('File "%s" not found in include_path: %s', $file, get_include_path()), LOG_DEBUG, __FILE__, __LINE__);
372	return false;
373	}
374	}
375	}
376
377	/**
378	* Returns stats of a file from the include path.
379	*
380	* @param string $file File in include path.
381	* @param mixed $stat Which statistic to return (or null to return all).
382	* @return mixed Value of requested key from fstat(), or false on error.
383	* @author Quinn Comendant <quinn@strangecode.com>
384	* @since 03 Dec 2005 14:23:26
385	*/
386	function statIncludePath($file, $stat=null)
387	{
388	// Open file pointer read-only using include path.
389	if ($fp = fopen($file, 'r', true)) {
390	// File opened successfully, get stats.
391	$stats = fstat($fp);
392	fclose($fp);
393	// Return specified stats.
394	return is_null($stat) ? $stats : $stats[$stat];
395	} else {
396	return false;
397	}
398	}
399
400	/*
401	* Writes content to the specified file. This function emulates the functionality of file_put_contents from PHP 5.
402	*
403	* @access public
404	* @param string $filename Path to file.
405	* @param string $content Data to write into file.
406	* @return bool Success or failure.
407	* @author Quinn Comendant <quinn@strangecode.com>
408	* @since 11 Apr 2006 22:48:30
409	*/
410	function filePutContents($filename, $content)
411	{
412	$app =& App::getInstance();
413
414	// Open file for writing and truncate to zero length.
415	if ($fp = fopen($filename, 'w')) {
416	if (flock($fp, LOCK_EX)) {
417	if (!fwrite($fp, $content, mb_strlen($content))) {
418	$app->logMsg(sprintf('Failed writing to file: %s', $filename), LOG_ERR, __FILE__, __LINE__);
419	fclose($fp);
420	return false;
421	}
422	flock($fp, LOCK_UN);
423	} else {
424	$app->logMsg(sprintf('Could not lock file for writing: %s', $filename), LOG_ERR, __FILE__, __LINE__);
425	fclose($fp);
426	return false;
427	}
428	fclose($fp);
429	// Success!
430	$app->logMsg(sprintf('Wrote to file: %s', $filename), LOG_DEBUG, __FILE__, __LINE__);
431	return true;
432	} else {
433	$app->logMsg(sprintf('Could not open file for writing: %s', $filename), LOG_ERR, __FILE__, __LINE__);
434	return false;
435	}
436	}
437
438
439	/**
440	* If $var is net set or null, set it to $default. Otherwise leave it alone.
441	* Returns the final value of $var. Use to find a default value of one is not available.
442	*
443	* @param mixed $var The variable that is being set.
444	* @param mixed $default What to set it to if $val is not currently set.
445	* @return mixed The resulting value of $var.
446	*/
447	function setDefault(&$var, $default='')
448	{
449	if (!isset($var)) {
450	$var = $default;
451	}
452	return $var;
453	}
454
455	/**
456	* Like preg_quote() except for arrays, it takes an array of strings and puts
457	* a backslash in front of every character that is part of the regular
458	* expression syntax.
459	*
460	* @param array $array input array
461	* @param array $delim optional character that will also be escaped.
462	* @return array an array with the same values as $array1 but shuffled
463	*/
464	function pregQuoteArray($array, $delim='/')
465	{
466	if (!empty($array)) {
467	if (is_array($array)) {
468	foreach ($array as $key=>$val) {
469	$quoted_array[$key] = preg_quote($val, $delim);
470	}
471	return $quoted_array;
472	} else {
473	return preg_quote($array, $delim);
474	}
475	}
476	}
477
478	/**
479	* Converts a PHP Array into encoded URL arguments and return them as an array.
480	*
481	* @param mixed $data An array to transverse recursively, or a string
482	* to use directly to create url arguments.
483	* @param string $prefix The name of the first dimension of the array.
484	* If not specified, the first keys of the array will be used.
485	* @return array URL with array elements as URL key=value arguments.
486	*/
487	function urlEncodeArray($data, $prefix='', $_return=true)
488	{
489
490	// Data is stored in static variable.
491	static $args;
492
493	if (is_array($data)) {
494	foreach ($data as $key => $val) {
495	// If the prefix is empty, use the $key as the name of the first dimension of the "array".
496	// ...otherwise, append the key as a new dimension of the "array".
497	$new_prefix = ('' == $prefix) ? urlencode($key) : $prefix . '[' . urlencode($key) . ']';
498	// Enter recursion.
499	urlEncodeArray($val, $new_prefix, false);
500	}
501	} else {
502	// We've come to the last dimension of the array, save the "array" and its value.
503	$args[$prefix] = urlencode($data);
504	}
505
506	if ($_return) {
507	// This is not a recursive execution. All recursion is complete.
508	// Reset static var and return the result.
509	$ret = $args;
510	$args = array();
511	return is_array($ret) ? $ret : array();
512	}
513	}
514
515	/**
516	* Converts a PHP Array into encoded URL arguments and return them in a string.
517	*
518	* @param mixed $data An array to transverse recursively, or a string
519	* to use directly to create url arguments.
520	* @param string $prefix The name of the first dimension of the array.
521	* If not specified, the first keys of the array will be used.
522	* @return string url A string ready to append to a url.
523	*/
524	function urlEncodeArrayToString($data, $prefix='')
525	{
526
527	$array_args = urlEncodeArray($data, $prefix);
528	$url_args = '';
529	$delim = '';
530	foreach ($array_args as $key=>$val) {
531	$url_args .= $delim . $key . '=' . $val;
532	$delim = ini_get('arg_separator.output');
533	}
534	return $url_args;
535	}
536
537	/**
538	* Fills an array with the result from a multiple ereg search.
539	* Courtesy of Bruno - rbronosky@mac.com - 10-May-2001
540	*
541	* @param mixed $pattern regular expression needle
542	* @param mixed $string haystack
543	* @return array populated with each found result
544	*/
545	function eregAll($pattern, $string)
546	{
547	do {
548	if (!mb_ereg($pattern, $string, $temp)) {
549	continue;
550	}
551	$string = str_replace($temp[0], '', $string);
552	$results[] = $temp;
553	} while (mb_ereg($pattern, $string, $temp));
554	return $results;
555	}
556
557	/**
558	* Prints the word "checked" if a variable is set, and optionally matches
559	* the desired value, otherwise prints nothing,
560	* used for printing the word "checked" in a checkbox form input.
561	*
562	* @param mixed $var the variable to compare
563	* @param mixed $value optional, what to compare with if a specific value is required.
564	*/
565	function frmChecked($var, $value=null)
566	{
567	if (func_num_args() == 1 && $var) {
568	// 'Checked' if var is true.
569	echo ' checked="checked" ';
570	} else if (func_num_args() == 2 && $var == $value) {
571	// 'Checked' if var and value match.
572	echo ' checked="checked" ';
573	} else if (func_num_args() == 2 && is_array($var)) {
574	// 'Checked' if the value is in the key or the value of an array.
575	if (isset($var[$value])) {
576	echo ' checked="checked" ';
577	} else if (in_array($value, $var)) {
578	echo ' checked="checked" ';
579	}
580	}
581	}
582
583	/**
584	* prints the word "selected" if a variable is set, and optionally matches
585	* the desired value, otherwise prints nothing,
586	* otherwise prints nothing, used for printing the word "checked" in a
587	* select form input
588	*
589	* @param mixed $var the variable to compare
590	* @param mixed $value optional, what to compare with if a specific value is required.
591	*/
592	function frmSelected($var, $value=null)
593	{
594	if (func_num_args() == 1 && $var) {
595	// 'selected' if var is true.
596	echo ' selected="selected" ';
597	} else if (func_num_args() == 2 && $var == $value) {
598	// 'selected' if var and value match.
599	echo ' selected="selected" ';
600	} else if (func_num_args() == 2 && is_array($var)) {
601	// 'selected' if the value is in the key or the value of an array.
602	if (isset($var[$value])) {
603	echo ' selected="selected" ';
604	} else if (in_array($value, $var)) {
605	echo ' selected="selected" ';
606	}
607	}
608	}
609
610	/**
611	* Adds slashes to values of an array and converts the array to a comma
612	* delimited list. If value provided is a string return the string
613	* escaped. This is useful for putting values coming in from posted
614	* checkboxes into a SET column of a database.
615	*
616	*
617	* @param array $in Array to convert.
618	* @return string Comma list of array values.
619	*/
620	function escapedList($in, $separator="', '")
621	{
622	$db =& DB::getInstance();
623
624	if (is_array($in) && !empty($in)) {
625	return join($separator, array_map(array($db, 'escapeString'), $in));
626	} else {
627	return $db->escapeString($in);
628	}
629	}
630
631	/**
632	* Converts a human string date into a SQL-safe date. Dates nearing
633	* infinity use the date 2038-01-01 so conversion to unix time format
634	* remain within valid range.
635	*
636	* @param array $date String date to convert.
637	* @param array $format Date format to pass to date().
638	* Default produces MySQL datetime: 0000-00-00 00:00:00.
639	* @return string SQL-safe date.
640	*/
641	function strToSQLDate($date, $format='Y-m-d H:i:s')
642	{
643	// Translate the human string date into SQL-safe date format.
644	if (empty($date) \|\| mb_strpos($date, '0000-00-00') !== false \|\| strtotime($date) === -1 \|\| strtotime($date) === false) {
645	// Return a string of zero time, formatted the same as $format.
646	return strtr($format, array(
647	'Y' => '0000',
648	'm' => '00',
649	'd' => '00',
650	'H' => '00',
651	'i' => '00',
652	's' => '00',
653	));
654	} else {
655	return date($format, strtotime($date));
656	}
657	}
658
659	/**
660	* If magic_quotes_gpc is in use, run stripslashes() on $var. If $var is an
661	* array, stripslashes is run on each value, recursively, and the stripped
662	* array is returned.
663	*
664	* @param mixed $var The string or array to un-quote, if necessary.
665	* @return mixed $var, minus any magic quotes.
666	*/
667	function dispelMagicQuotes($var)
668	{
669	static $magic_quotes_gpc;
670
671	if (!isset($magic_quotes_gpc)) {
672	$magic_quotes_gpc = get_magic_quotes_gpc();
673	}
674
675	if ($magic_quotes_gpc) {
676	if (!is_array($var)) {
677	$var = stripslashes($var);
678	} else {
679	foreach ($var as $key=>$val) {
680	if (is_array($val)) {
681	$var[$key] = dispelMagicQuotes($val);
682	} else {
683	$var[$key] = stripslashes($val);
684	}
685	}
686	}
687	}
688	return $var;
689	}
690
691	/**
692	* Get a form variable from GET or POST data, stripped of magic
693	* quotes if necessary.
694	*
695	* @param string $var (optional) The name of the form variable to look for.
696	* @param string $default (optional) The value to return if the
697	* variable is not there.
698	* @return mixed A cleaned GET or POST if no $var specified.
699	* @return string A cleaned form $var if found, or $default.
700	*/
701	function getFormData($var=null, $default=null)
702	{
703	if ('POST' == getenv('REQUEST_METHOD') && is_null($var)) {
704	return dispelMagicQuotes($_POST);
705	} else if ('GET' == getenv('REQUEST_METHOD') && is_null($var)) {
706	return dispelMagicQuotes($_GET);
707	}
708	if (isset($_POST[$var])) {
709	return dispelMagicQuotes($_POST[$var]);
710	} else if (isset($_GET[$var])) {
711	return dispelMagicQuotes($_GET[$var]);
712	} else {
713	return $default;
714	}
715	}
716	function getPost($var=null, $default=null)
717	{
718	if (is_null($var)) {
719	return dispelMagicQuotes($_POST);
720	}
721	if (isset($_POST[$var])) {
722	return dispelMagicQuotes($_POST[$var]);
723	} else {
724	return $default;
725	}
726	}
727	function getGet($var=null, $default=null)
728	{
729	if (is_null($var)) {
730	return dispelMagicQuotes($_GET);
731	}
732	if (isset($_GET[$var])) {
733	return dispelMagicQuotes($_GET[$var]);
734	} else {
735	return $default;
736	}
737	}
738
739	/**
740	* Signs a value using md5 and a simple text key. In order for this
741	* function to be useful (i.e. secure) the key must be kept secret, which
742	* means keeping it as safe as database credentials. Putting it into an
743	* environment variable set in httpd.conf is a good place.
744	*
745	* @access public
746	* @param string $val The string to sign.
747	* @param string $salt (Optional) A text key to use for computing the signature.
748	* @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.
749	* @return string The original value with a signature appended.
750	*/
751	function addSignature($val, $salt=null, $length=18)
752	{
753	$app =& App::getInstance();
754
755	if ('' == trim($val)) {
756	$app->logMsg(sprintf('Cannot add signature to an empty string.', null), LOG_INFO, __FILE__, __LINE__);
757	return '';
758	}
759
760	if (!isset($salt)) {
761	$salt = $app->getParam('signing_key');
762	}
763
764	return $val . '-' . mb_strtolower(mb_substr(md5($salt . md5($val . $salt)), 0, $length));
765	}
766
767	/**
768	* Strips off the signature appended by addSignature().
769	*
770	* @access public
771	* @param string $signed_val The string to sign.
772	* @return string The original value with a signature removed.
773	*/
774	function removeSignature($signed_val)
775	{
776	if (empty($signed_val) \|\| mb_strpos($signed_val, '-') === false) {
777	return '';
778	}
779	return mb_substr($signed_val, 0, mb_strrpos($signed_val, '-'));
780	}
781
782
783	/**
784	* Verifies a signature appened to a value by addSignature().
785	*
786	* @access public
787	* @param string $signed_val A value with appended signature.
788	* @param string $salt (Optional) A text key to use for computing the signature.
789	* @return bool True if the signature matches the var.
790	*/
791	function verifySignature($signed_val, $salt=null, $length=18)
792	{
793	// All comparisons are done using lower-case strings.
794	$signed_val = mb_strtolower($signed_val);
795	// Strip the value from the signed value.
796	$val = removeSignature($signed_val);
797	// If the signed value matches the original signed value we consider the value safe.
798	if ($signed_val == addSignature($val, $salt, $length)) {
799	// Signature verified.
800	return true;
801	} else {
802	return false;
803	}
804	}
805
806	/**
807	* Sends empty output to the browser and flushes the php buffer so the client
808	* will see data before the page is finished processing.
809	*/
810	function flushBuffer()
811	{
812	echo str_repeat(' ', 205);
813	flush();
814	}
815
816	/**
817	* Adds email address to mailman mailing list. Requires /etc/sudoers entry for apache to sudo execute add_members.
818	* Don't forget to allow php_admin_value open_basedir access to "/var/mailman/bin".
819	*
820	* @access public
821	* @param string $email Email address to add.
822	* @param string $list Name of list to add to.
823	* @param bool $send_welcome_message True to send welcome message to subscriber.
824	* @return bool True on success, false on failure.
825	*/
826	function mailmanAddMember($email, $list, $send_welcome_message=false)
827	{
828	$app =& App::getInstance();
829
830	$add_members = '/usr/lib/mailman/bin/add_members';
831	/// FIXME: checking of executable is disabled.
832	if (true \|\| is_executable($add_members) && is_readable($add_members)) {
833	$welcome_msg = $send_welcome_message ? 'y' : 'n';
834	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);
835	if (0 == $return_code) {
836	$app->logMsg(sprintf('Mailman add member success for list: %s, user: %s', $list, $email, $stdout), LOG_INFO, __FILE__, __LINE__);
837	return true;
838	} else {
839	$app->logMsg(sprintf('Mailman add member failed for list: %s, user: %s, with message: %s', $list, $email, $stdout), LOG_WARNING, __FILE__, __LINE__);
840	return false;
841	}
842	} else {
843	$app->logMsg(sprintf('Mailman add member program not executable: %s', $add_members), LOG_ALERT, __FILE__, __LINE__);
844	return false;
845	}
846	}
847
848	/**
849	* Removes email address from mailman mailing list. Requires /etc/sudoers entry for apache to sudo execute add_members.
850	* Don't forget to allow php_admin_value open_basedir access to "/var/mailman/bin".
851	*
852	* @access public
853	* @param string $email Email address to add.
854	* @param string $list Name of list to add to.
855	* @param bool $send_user_ack True to send goodbye message to subscriber.
856	* @return bool True on success, false on failure.
857	*/
858	function mailmanRemoveMember($email, $list, $send_user_ack=false)
859	{
860	$app =& App::getInstance();
861
862	$remove_members = '/usr/lib/mailman/bin/remove_members';
863	/// FIXME: checking of executable is disabled.
864	if (true \|\| is_executable($remove_members) && is_readable($remove_members)) {
865	$userack = $send_user_ack ? '' : '--nouserack';
866	exec(sprintf("/usr/bin/sudo %s %s --noadminack '%s' '%s'", escapeshellarg($remove_members), $userack, escapeshellarg($list), escapeshellarg($email)), $stdout, $return_code);
867	if (0 == $return_code) {
868	$app->logMsg(sprintf('Mailman remove member success for list: %s, user: %s', $list, $email, $stdout), LOG_INFO, __FILE__, __LINE__);
869	return true;
870	} else {
871	$app->logMsg(sprintf('Mailman remove member failed for list: %s, user: %s, with message: %s', $list, $email, $stdout), LOG_WARNING, __FILE__, __LINE__);
872	return false;
873	}
874	} else {
875	$app->logMsg(sprintf('Mailman remove member program not executable: %s', $remove_members), LOG_ALERT, __FILE__, __LINE__);
876	return false;
877	}
878	}
879
880	/**
881	* Returns the remote IP address, taking into consideration proxy servers.
882	*
883	* @param bool $dolookup If true we resolve to IP to a host name,
884	* if false we don't.
885	* @return string IP address if $dolookup is false or no arg
886	* Hostname if $dolookup is true
887	*/
888	function getRemoteAddr($dolookup=false)
889	{
890	$ip = getenv('HTTP_CLIENT_IP');
891	if (in_array($ip, array('', 'unknown', 'localhost', '127.0.0.1'))) {
892	$ip = getenv('HTTP_X_FORWARDED_FOR');
893	if (mb_strpos($ip, ',') !== false) {
894	// If HTTP_X_FORWARDED_FOR returns a comma-delimited list of IPs then return the first one (assuming the first is the original).
895	$ips = explode(',', $ip, 2);
896	$ip = $ips[0];
897	}
898	if (in_array($ip, array('', 'unknown', 'localhost', '127.0.0.1'))) {
899	$ip = getenv('REMOTE_ADDR');
900	}
901	}
902	return $dolookup && '' != $ip ? gethostbyaddr($ip) : $ip;
903	}
904
905	/**
906	* Tests whether a given IP address can be found in an array of IP address networks.
907	* Elements of networks array can be single IP addresses or an IP address range in CIDR notation
908	* See: http://en.wikipedia.org/wiki/Classless_inter-domain_routing
909	*
910	* @access public
911	* @param string IP address to search for.
912	* @param array Array of networks to search within.
913	* @return mixed Returns the network that matched on success, false on failure.
914	*/
915	function ipInRange($ip, $networks)
916	{
917	if (!is_array($networks)) {
918	$networks = array($networks);
919	}
920
921	$ip_binary = sprintf('%032b', ip2long($ip));
922	foreach ($networks as $network) {
923	if (preg_match('![\d\.]{7,15}/\d{1,2}!', $network)) {
924	// IP is in CIDR notation.
925	list($cidr_ip, $cidr_bitmask) = explode('/', $network);
926	$cidr_ip_binary = sprintf('%032b', ip2long($cidr_ip));
927	if (mb_substr($ip_binary, 0, $cidr_bitmask) === mb_substr($cidr_ip_binary, 0, $cidr_bitmask)) {
928	// IP address is within the specified IP range.
929	return $network;
930	}
931	} else {
932	if ($ip === $network) {
933	// IP address exactly matches.
934	return $network;
935	}
936	}
937	}
938
939	return false;
940	}
941
942	/**
943	* If the given $url is on the same web site, return true. This can be used to
944	* prevent from sending sensitive info in a get query (like the SID) to another
945	* domain.
946	*
947	* @param string $url the URI to test.
948	* @return bool True if given $url is our domain or has no domain (is a relative url), false if it's another.
949	*/
950	function isMyDomain($url)
951	{
952	static $urls = array();
953
954	if (!isset($urls[$url])) {
955	if (!preg_match('\|https?://[\w.]+/\|', $url)) {
956	// If we can't find a domain we assume the URL is local (i.e. "/my/url/path/" or "../img/file.jpg").
957	$urls[$url] = true;
958	} else {
959	$urls[$url] = preg_match('\|https?://[\w.]*' . preg_quote(getenv('HTTP_HOST'), '\|') . '\|i', $url);
960	}
961	}
962	return $urls[$url];
963	}
964
965	/**
966	* Takes a URL and returns it without the query or anchor portion
967	*
968	* @param string $url any kind of URI
969	* @return string the URI with ? or # and everything after removed
970	*/
971	function stripQuery($url)
972	{
973	return preg_replace('![?#].*!', '', $url);
974	}
975
976	/**
977	* Returns a fully qualified URL to the current script, including the query.
978	*
979	* @return string a full url to the current script
980	*/
981	function absoluteMe()
982	{
983	$protocol = ('on' == getenv('HTTPS')) ? 'https://' : 'http://';
984	return $protocol . getenv('HTTP_HOST') . getenv('REQUEST_URI');
985	}
986
987	/**
988	* Compares the current url with the referring url.
989	*
990	* @param bool $exclude_query Remove the query string first before comparing.
991	* @return bool True if the current URL is the same as the referring URL, false otherwise.
992	*/
993	function refererIsMe($exclude_query=false)
994	{
995	if ($exclude_query) {
996	return (stripQuery(absoluteMe()) == stripQuery(getenv('HTTP_REFERER')));
997	} else {
998	return (absoluteMe() == getenv('HTTP_REFERER'));
999	}
1000	}
1001
1002	/**
1003	* Stub functions used when installation does not have
1004	* GNU gettext extension installed
1005	*/
1006	if (!extension_loaded('gettext')) {
1007	/**
1008	* Translates text
1009	*
1010	* @access public
1011	* @param string $text the text to be translated
1012	* @return string translated text
1013	*/
1014	function gettext($text) {
1015	return $text;
1016	}
1017
1018	/**
1019	* Translates text
1020	*
1021	* @access public
1022	* @param string $text the text to be translated
1023	* @return string translated text
1024	*/
1025	function _($text) {
1026	return $text;
1027	}
1028
1029	/**
1030	* Translates text by domain
1031	*
1032	* @access public
1033	* @param string $domain the language to translate the text into
1034	* @param string $text the text to be translated
1035	* @return string translated text
1036	*/
1037	function dgettext($domain, $text) {
1038	return $text;
1039	}
1040
1041	/**
1042	* Translates text by domain and category
1043	*
1044	* @access public
1045	* @param string $domain the language to translate the text into
1046	* @param string $text the text to be translated
1047	* @param string $category the language dialect to use
1048	* @return string translated text
1049	*/
1050	function dcgettext($domain, $text, $category) {
1051	return $text;
1052	}
1053
1054	/**
1055	* Binds the text domain
1056	*
1057	* @access public
1058	* @param string $domain the language to translate the text into
1059	* @param string
1060	* @return string translated text
1061	*/
1062	function bindtextdomain($domain, $directory) {
1063	return $domain;
1064	}
1065
1066	/**
1067	* Sets the text domain
1068	*
1069	* @access public
1070	* @param string $domain the language to translate the text into
1071	* @return string translated text
1072	*/
1073	function textdomain($domain) {
1074	return $domain;
1075	}
1076	}
1077
1078
1079
1080	?>

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

Download in other formats: