Context Navigation

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

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

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

Download in other formats: