source: branches/1.1dev/lib/Utilities.inc.php @ 651

Last change on this file since 651 was 651, checked in by anonymous, 6 years ago

Update fancyDump
File size: 30.4 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        The variable to dump.
12 * @param  bool     $display    Print the dump in <pre> tags or hide it in html comments (non-CLI only).
13 * @param  bool     $dump_method   Dump method. See SC_DUMP_* constants.
14 * @param  string   $file       Value of __FILE__.
15 * @param  string   $line       Value of __LINE__
16 */
17define('SC_DUMP_PRINT_R', 0);
18define('SC_DUMP_VAR_DUMP', 1);
19define('SC_DUMP_VAR_EXPORT', 2);
20function dump($var, $display=false, $dump_method=SC_DUMP_PRINT_R, $file='', $line='')
21{
22    if ('cli' === php_sapi_name() || defined('_CLI')) {
23        echo "DUMP FROM: $file $line\n";
24    } else {
25        echo $display ? "\n<br />DUMP <strong>$file $line</strong><br /><pre>\n" : "\n<!-- DUMP $file $line\n";
26    }
27
28    switch ($dump_method) {
29    case SC_DUMP_PRINT_R:
30    default:
31        // Print human-readable descriptions of invisible types.
32        if (null === $var) {
33            echo '(null)';
34        } else if (true === $var) {
35            echo '(bool: true)';
36        } else if (false === $var) {
37            echo '(bool: false)';
38        } else if (is_scalar($var) && '' === $var) {
39            echo '(empty string)';
40        } else if (is_scalar($var) && preg_match('/^\s+$/', $var)) {
41            echo '(only white space)';
42        } else {
43            print_r($var);
44        }
45        break;
46
47    case SC_DUMP_VAR_DUMP:
48        var_dump($var);
49        break;
50
51    case SC_DUMP_VAR_EXPORT:
52        var_export($var);
53        break;
54    }
55
56    if ('cli' === php_sapi_name() || defined('_CLI')) {
57        echo "\n";
58    } else {
59        echo $display ? "\n</pre><br />\n" : "\n-->\n";
60    }
61}
62
63/**
64 * Return dump as variable.
65 *
66 * @param  mixed $var      Variable to dump.
67 *
68 * @return string Dump of var.
69 */
70function getDump($var)
71{
72    ob_start();
73    print_r($var);
74    $d = ob_get_contents();
75    ob_end_clean();
76    return $d;
77}
78
79/*
80* Return dump as cleaned text. Useful for dumping data into emails or output from CLI scripts.
81* To output tab-style lists set $indent to "\t" and $depth to 0;
82* To output markdown-style lists set $indent to '- ' and $depth to 1;
83* Also see yaml_emit() https://secure.php.net/manual/en/function.yaml-emit.php
84*
85* @param  array    $var        Variable to dump.
86* @param  string   $indent     A string to prepend indented lines.
87* @param  string   $depth      Starting depth of this iteration of recursion (set to 0 to have no initial indentation).
88* @return string               Pretty dump of $var.
89* @author   Quinn Comendant <quinn@strangecode.com>
90* @version 2.0
91*/
92function fancyDump($var, $indent='- ', $depth=1)
93{
94    $indent_str = str_repeat($indent, $depth);
95    $output = '';
96    if (is_array($var)) {
97        foreach ($var as $k=>$v) {
98            $k = ucfirst(mb_strtolower(str_replace(array('_', '  '), ' ', $k)));
99            if (is_array($v)) {
100                $output .= sprintf("\n%s%s:\n%s\n", $indent_str, $k, fancyDump($v, $indent, $depth+1));
101            } else {
102                $output .= sprintf("%s%s: %s\n", $indent_str, $k, $v);
103            }
104        }
105    } else {
106        $output .= sprintf("%s%s\n", $indent_str, $var);
107    }
108    return preg_replace(['/^[ \t]+$/', '/\n\n+/', '/^(?:\S( ))?(?:\S( ))?(?:\S( ))?(?:\S( ))?(?:\S( ))?(?:\S( ))?(?:\S( ))?(?:\S( ))?(\S )/m'], ['', "\n", '$1$1$2$2$3$3$4$4$5$5$6$6$7$7$8$8$9'], $output);
109}
110
111/**
112 * Returns text with appropriate html translations.
113 *
114 * @param  string $txt              Text to clean.
115 * @param  bool   $preserve_html    If set to true, oTxt will not translage <, >, ", or '
116 *                                  characters into HTML entities. This allows HTML to pass
117 *                                  through unmunged.
118 *
119 * @return string                   Cleaned text.
120 */
121function oTxt($txt, $preserve_html=false)
122{
123    global $CFG;
124
125    $search = array();
126    $replace = array();
127
128    // Make converted ampersand entities into normal ampersands (they will be done manually later) to retain HTML entities.
129    $search['retain_ampersand']     = '/&amp;/';
130    $replace['retain_ampersand']    = '&';
131
132    if ($preserve_html) {
133        // Convert characters that must remain non-entities for displaying HTML.
134        $search['retain_left_angle']       = '/&lt;/';
135        $replace['retain_left_angle']      = '<';
136
137        $search['retain_right_angle']      = '/&gt;/';
138        $replace['retain_right_angle']     = '>';
139
140        $search['retain_single_quote']     = '/&#039;/';
141        $replace['retain_single_quote']    = "'";
142
143        $search['retain_double_quote']     = '/&quot;/';
144        $replace['retain_double_quote']    = '"';
145    }
146
147    // & becomes &amp;
148    $search['ampersand']        = '/&((?![\w\d#]{1,10};))/';
149    $replace['ampersand']       = '&amp;\\1';
150
151    return preg_replace($search, $replace, htmlentities($txt, ENT_QUOTES, $CFG->character_set));
152}
153
154/**
155 * Returns text with stylistic modifications.
156 *
157 * @param  string   $txt  Text to clean.
158 *
159 * @return string         Cleaned text.
160 */
161function fancyTxt($txt)
162{
163    $search = array();
164    $replace = array();
165
166    // "double quoted text"  becomes  &ldquo;double quoted text&rdquo;
167    $search['double_quotes']    = '/(^|[^\w=])(?:"|&quot;|&#34;|&#x22;|&ldquo;)([^"]+?)(?:"|&quot;|&#34;|&#x22;|&rdquo;)([^\w]|$)/'; // " is the same as &quot; and &#34; and &#x22;
168    $replace['double_quotes']   = '\\1&ldquo;\\2&rdquo;\\3';
169
170    // text's apostrophes  become  text&rsquo;s apostrophes
171    $search['apostrophe']       = '/(\w)(?:\'|&#39;)(\w)/';
172    $replace['apostrophe']      = '\\1&rsquo;\\2';
173
174    // "single quoted text"  becomes  &lsquo;single quoted text&rsquo;
175    $search['single_quotes']    = '/(^|[^\w=])(?:\'|&#39;|&lsquo;)([^\']+?)(?:\'|&#39;|&rsquo;)([^\w]|$)/';
176    $replace['single_quotes']   = '\\1&lsquo;\\2&rsquo;\\3';
177
178    // em--dashes  become em&mdash;dashes
179    $search['em_dash']          = '/(\s*[^!<-])--([^>-]\s*)/';
180    $replace['em_dash']         = '\\1&mdash;\\2';
181
182    // & becomes &amp;
183    $search['ampersand']        = '/&((?![\w\d#]{1,10};))/';
184    $replace['ampersand']       = '&amp;\\1';
185
186    return preg_replace($search, $replace, $txt);
187}
188
189/*
190* Finds all URLs in text and hyperlinks them.
191*
192* @access   public
193* @param    string  $text   Text to search for URLs.
194* @param    bool    $strict True to only include URLs starting with a scheme (http:// ftp:// im://), or false to include URLs starting with 'www.'.
195* @param    mixed   $length Number of characters to truncate URL, or NULL to disable truncating.
196* @param    string  $delim  Delimiter to append, indicate truncation.
197* @return   string          Same input text, but URLs hyperlinked.
198* @author   Quinn Comendant <quinn@strangecode.com>
199* @version  2.1
200* @since    22 Mar 2015 23:29:04
201*/
202function hyperlinkTxt($text, $strict=false, $length=null, $delim='
')
203{
204    // A list of schemes we allow at the beginning of a URL.
205    $schemes = 'mailto:|tel:|skype:|callto:|facetime:|bitcoin:|geo:|magnet:\?|sip:|sms:|xmpp:|view-source:(?:https?://)?|[\w-]{2,}://';
206
207    // Capture the full URL into the first match and only the first X characters into the second match.
208    // This will match URLs not preceded by " ' or = (URLs inside an attribute) or ` (Markdown quoted) or double-scheme (http://http://www.asdf.com)
209    // Valid URL characters: ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-._~:/?#[]@!$&'()*+,;=
210    $regex = '@
211        \b                              # Start with a word-boundary.
212        (?<!"|\'|=|>|`|\]\(|[:/]/) # Negative look-behind to exclude URLs already in <a> tag, <tags>beween</tags>, `Markdown quoted`, [Markdown](link), and avoid broken:/ and doubled://schemes://
213        (                               # Begin match 1
214            (                           # Begin match 2
215                (?:%s)                  # URL starts with known scheme or www. if strict = false
216                [^\s/$.?#]+             # Any domain-valid characters
217                [^\s"`<>]{1,%s}         # Match 2 is limited to a maximum of LENGTH valid URL characters
218            )
219            [^\s"`<>]*                  # Match 1 continues with any further valid URL characters
220            ([^\P{Any}\s
<>«»"—–%s])    # Final character not a space or common end-of-sentence punctuation (.,:;?!, etc). Using double negation set, see http://stackoverflow.com/a/4786560/277303
221        )
222        @Suxi
223    ';
224    $regex = sprintf($regex,
225        ($strict ? $schemes : $schemes . '|www\.'), // Strict=false adds "www." to the list of allowed start-of-URL.
226        ($length ? $length : ''),
227        ($strict ? '' : '?!.,:;)\'-') // Strict=false excludes some "URL-valid" characters from the last character of URL. (Hyphen must remain last character in this class.)
228    );
229
230    // Use a callback function to decide when to append the delim.
231    // Also encode special chars with oTxt().
232    return preg_replace_callback($regex, function ($m) use ($length, $delim) {
233        $url = $m[1];
234        $truncated_url = $m[2] . $m[3];
235        $absolute_url = preg_replace('!^www\.!', 'http://www.', $url);
236        if (is_null($length) || $url == $truncated_url) {
237            // If not truncating, or URL was not truncated.
238            // Remove http schemas, and any single trailing / to make the display URL.
239            $display_url = preg_replace(['!^https?://!', '!^([^/]+)/$!'], ['', '$1'], $url);
240            return sprintf('<a href="%s">%s</a>', oTxt($absolute_url), $display_url);
241        } else {
242            // Truncated URL.
243            // Remove http schemas, and any single trailing / to make the display URL.
244            $display_url = preg_replace(['!^https?://!', '!^([^/]+)/$!'], ['', '$1'], trim($truncated_url));
245            return sprintf('<a href="%s">%s%s</a>', oTxt($absolute_url), $display_url, $delim);
246        }
247    }, $text);
248}
249
250/**
251 * Turns "a really long string" into "a rea...string"
252 *
253 * @access  public
254 * @param   string  $str    Input string
255 * @param   int     $len    Maximum string length.
256 * @param   string  $where  Where to cut the string. One of: 'start', 'middle', or 'end'.
257 * @return  string          Truncated output string
258 * @author  Quinn Comendant <quinn@strangecode.com>
259 * @since   29 Mar 2006 13:48:49
260 */
261function truncate($str, $len=50, $where='end', $delim='
')
262{
263    $dlen = mb_strlen($delim);
264    if ($len <= $dlen || mb_strlen($str) <= $dlen) {
265        return substr($str, 0, $len);
266    }
267    $part1 = floor(($len - $dlen) / 2);
268    $part2 = ceil(($len - $dlen) / 2);
269
270    if ($len > ini_get('pcre.backtrack_limit')) {
271        logMsg(sprintf('Asked to truncate string len of %s > pcre.backtrack_limit of %s', $len, ini_get('pcre.backtrack_limit')), LOG_DEBUG, __FILE__, __LINE__);
272        ini_set('pcre.backtrack_limit', $len);
273    }
274
275    switch ($where) {
276    case 'start' :
277        return preg_replace(array(sprintf('/^.{%s,}(.{%s})$/su', $dlen + 1, $part1 + $part2), sprintf('/\s*%s{%s,}\s*/su', preg_quote($delim), $dlen)), array($delim . '$1', $delim), $str);
278
279    case 'middle' :
280        return preg_replace(array(sprintf('/^(.{%s}).{%s,}(.{%s})$/su', $part1, $dlen + 1, $part2), sprintf('/\s*%s{%s,}\s*/su', preg_quote($delim), $dlen)), array('$1' . $delim . '$2', $delim), $str);
281
282    case 'end' :
283    default :
284        return preg_replace(array(sprintf('/^(.{%s}).{%s,}$/su', $part1 + $part2, $dlen + 1), sprintf('/\s*%s{%s,}\s*/su', preg_quote($delim), $dlen)), array('$1' . $delim, $delim), $str);
285    }
286}
287
288/**
289 * Generates a hexadecimal html color based on provided word.
290 *
291 * @access public
292 *
293 * @param  string $text  A string for which to convert to color.
294 *
295 * @return string  A hexadecimal html color.
296 */
297function getTextColor($text, $method=1)
298{
299    $hash = md5($text);
300    $rgb = array(
301        substr($hash, 0, 1),
302        substr($hash, 1, 1),
303        substr($hash, 2, 1),
304        substr($hash, 3, 1),
305        substr($hash, 4, 1),
306        substr($hash, 5, 1),
307    );
308
309    switch ($method) {
310    case 1 :
311    default :
312        // Reduce all hex values slighly to avoid all white.
313        array_walk($rgb, create_function('&$v', '$v = dechex(round(hexdec($v) * 0.87));'));
314        break;
315    case 2 :
316        foreach ($rgb as $i => $v) {
317            if (hexdec($v) > hexdec('c')) {
318                $rgb[$i] = dechex(hexdec('f') - hexdec($v));
319            }
320        }
321        break;
322    }
323
324    return join('', $rgb);
325}
326
327/**
328 * Encodes a string into unicode values 128-255.
329 * Useful for hiding an email address from spambots.
330 *
331 * @access  public
332 *
333 * @param   string   $text   A line of text to encode.
334 *
335 * @return  string   Encoded text.
336 */
337function encodeAscii($text)
338{
339    $ouput = '';
340    $num = strlen($text);
341    for ($i=0; $i<$num; $i++) {
342        $output .= sprintf('&#%03s', ord($text{$i}));
343    }
344    return $output;
345}
346
347/**
348 * Encodes an email into a user (at) domain (dot) com format.
349 *
350 * @access  public
351 * @param   string   $email   An email to encode.
352 * @param   string   $at      Replaces the @.
353 * @param   string   $dot     Replaces the ..
354 * @return  string   Encoded email.
355 */
356function encodeEmail($email, $at=' at ', $dot=' dot ')
357{
358    $search = array('/@/', '/\./');
359    $replace = array($at, $dot);
360    return preg_replace($search, $replace, $email);
361}
362
363/**
364 * Return a human readable filesize.
365 *
366 * @param       int    $size        Size
367 * @param       int    $unit        The maximum unit
368 * @param       int    $format      The return string format
369 * @author      Aidan Lister <aidan@php.net>
370 * @version     1.1.0
371 */
372function humanFileSize($size, $unit=null, $format='%01.2f %s')
373{
374    // Units
375    $units = array('B', 'KB', 'MB', 'GB', 'TB');
376    $ii = count($units) - 1;
377
378    // Max unit
379    $unit = array_search((string) $unit, $units);
380    if ($unit === null || $unit === false) {
381        $unit = $ii;
382    }
383
384    // Loop
385    $i = 0;
386    while ($unit != $i && $size >= 1024 && $i < $ii) {
387        $size /= 1024;
388        $i++;
389    }
390
391    return sprintf($format, $size, $units[$i]);
392}
393
394/**
395 * If $var is net set or null, set it to $default. Otherwise leave it alone.
396 * Returns the final value of $var. Use to find a default value of one is not avilable.
397 *
398 * @param  mixed $var       The variable that is being set.
399 * @param  mixed $default   What to set it to if $val is not currently set.
400 * @return mixed            The resulting value of $var.
401 */
402function setDefault(&$var, $default='')
403{
404    if (!isset($var)) {
405        $var = $default;
406    }
407    return $var;
408}
409
410/**
411 * Like preg_quote() except for arrays, it takes an array of strings and puts
412 * a backslash in front of every character that is part of the regular
413 * expression syntax.
414 *
415 * @param  array $array    input array
416 * @param  array $delim    optional character that will also be excaped.
417 *
418 * @return array    an array with the same values as $array1 but shuffled
419 */
420function pregQuoteArray($array, $delim='/')
421{
422    if (!empty($array)) {
423        if (is_array($array)) {
424            foreach ($array as $key=>$val) {
425                $quoted_array[$key] = preg_quote($val, $delim);
426            }
427            return $quoted_array;
428        } else {
429            return preg_quote($array, $delim);
430        }
431    }
432}
433
434/**
435 * Converts a PHP Array into encoded URL arguments and return them as an array.
436 *
437 * @param  mixed $data        An array to transverse recursively, or a string
438 *                            to use directly to create url arguments.
439 * @param  string $prefix     The name of the first dimension of the array.
440 *                            If not specified, the first keys of the array will be used.
441 *
442 * @return array              URL with array elements as URL key=value arguments.
443 */
444function urlEncodeArray($data, $prefix='', $_return=true) {
445
446    // Data is stored in static variable.
447    static $args;
448
449    if (is_array($data)) {
450        foreach ($data as $key => $val) {
451            // If the prefix is empty, use the $key as the name of the first dimension of the "array".
452            // ...otherwise, append the key as a new dimension of the "array".
453            $new_prefix = ('' == $prefix) ? urlencode($key) : $prefix . '[' . urlencode($key) . ']';
454            // Enter recursion.
455            urlEncodeArray($val, $new_prefix, false);
456        }
457    } else {
458        // We've come to the last dimension of the array, save the "array" and it's value.
459        $args[$prefix] = urlencode($data);
460    }
461
462    if ($_return) {
463        // This is not a recursive execution. All recursion is complete.
464        // Reset static var and return the result.
465        $ret = $args;
466        $args = array();
467        return is_array($ret) ? $ret : array();
468    }
469}
470
471/**
472 * Converts a PHP Array into encoded URL arguments and return them in a string.
473 *
474 * @param  mixed $data        An array to transverse recursively, or a string
475 *                            to use directly to create url arguments.
476 * @param  string $prefix     The name of the first dimension of the array.
477 *                            If not specified, the first keys of the array will be used.
478 *
479 * @return string url         A string ready to append to a url.
480 */
481function urlEncodeArrayToString($data, $prefix='') {
482
483    $array_args = urlEncodeArray($data, $prefix);
484    $url_args = '';
485    $delim = '';
486    foreach ($array_args as $key=>$val) {
487        $url_args .= $delim . $key . '=' . $val;
488        $delim = ini_get('arg_separator.output');
489    }
490    return $url_args;
491}
492
493/**
494 * An alternative to "shuffle()" that actually works.
495 *
496 * @param  array $array1   input array
497 * @param  array $array2   argument used internally through recursion
498 *
499 * @return array    an array with the same values as $array1 but shuffled
500 */
501function arrayRand(&$array1, $array2 = array())
502{
503    if (!sizeof($array1)) {
504        return array();
505    }
506
507    srand((double) microtime() * 10000000);
508    $rand = array_rand($array1);
509
510    $array2[] = $array1[$rand];
511    unset ($array1[$rand]);
512
513    return $array2 + arrayRand($array1, $array2);
514}
515
516/**
517 * Fills an arrray with the result from a multiple ereg search.
518 * Curtesy of Bruno - rbronosky@mac.com - 10-May-2001
519 * Blame him for the funky do...while loop.
520 *
521 * @param  mixed $pattern   regular expression needle
522 * @param  mixed $string   haystack
523 *
524 * @return array    populated with each found result
525 */
526function eregAll($pattern, $string)
527{
528    do {
529        if (!ereg($pattern, $string, $temp)) {
530             continue;
531        }
532        $string = str_replace($temp[0], '', $string);
533        $results[] = $temp;
534    } while (ereg($pattern, $string, $temp));
535    return $results;
536}
537
538/**
539 * Prints the word "checked" if a variable is set, and optionally matches
540 * the desired value, otherwise prints nothing,
541 * used for printing the word "checked" in a checkbox form input.
542 *
543 * @param  mixed $var     the variable to compare
544 * @param  mixed $value   optional, what to compare with if a specific value is required.
545 */
546function frmChecked($var, $value=null)
547{
548    if (func_num_args() == 1 && $var) {
549        // 'Checked' if var is true.
550        echo ' checked="checked" ';
551    } else if (func_num_args() == 2 && $var == $value) {
552        // 'Checked' if var and value match.
553        echo ' checked="checked" ';
554    } else if (func_num_args() == 2 && is_array($var)) {
555        // 'Checked' if the value is in the key or the value of an array.
556        if (isset($var[$value])) {
557            echo ' checked="checked" ';
558        } else if (in_array($value, $var)) {
559            echo ' checked="checked" ';
560        }
561    }
562}
563
564/**
565 * prints the word "selected" if a variable is set, and optionally matches
566 * the desired value, otherwise prints nothing,
567 * otherwise prints nothing, used for printing the word "checked" in a
568 * select form input
569 *
570 * @param  mixed $var     the variable to compare
571 * @param  mixed $value   optional, what to compare with if a specific value is required.
572 */
573function frmSelected($var, $value=null)
574{
575    if (func_num_args() == 1 && $var) {
576        // 'selected' if var is true.
577        echo ' selected="selected" ';
578    } else if (func_num_args() == 2 && $var == $value) {
579        // 'selected' if var and value match.
580        echo ' selected="selected" ';
581    } else if (func_num_args() == 2 && is_array($var)) {
582        // 'selected' if the value is in the key or the value of an array.
583        if (isset($var[$value])) {
584            echo ' selected="selected" ';
585        } else if (in_array($value, $var)) {
586            echo ' selected="selected" ';
587        }
588    }
589}
590
591/**
592 * Adds slashes to values of an array and converts the array to a
593 * comma delimited list. If value provided is not an array or is empty
594 * return nothing. This is useful for putting values coming in from
595 * posted checkboxes into a SET column of a database.
596 *
597 * @param  array $array   Array to convert.
598 * @return string         Comma list of array values.
599 */
600function dbArrayToList($array)
601{
602    if (is_array($array) && !empty($array)) {
603        return join(',', array_map('mysql_real_escape_string', array_keys($array)));
604    }
605}
606
607/**
608 * Converts a human string date into a SQL-safe date.
609 * Dates nearing infinity use the date 2038-01-01 so conversion to unix time
610 * format remain within valid range.
611 *
612 * @param  array $date     String date to convert.
613 * @param  array $format   Date format to pass to date().
614 *                         Default produces MySQL datetime: 0000-00-00 00:00:00.
615 *
616 * @return string          SQL-safe date.
617 */
618function strToSQLDate($date, $format='Y-m-d H:i:s')
619{
620    // Translate the human string date into SQL-safe date format.
621    if (empty($date) || '0000-00-00' == $date || strtotime($date) === -1) {
622        $sql_date = '0000-00-00';
623    } else {
624        $sql_date = date($format, strtotime($date));
625    }
626
627    return $sql_date;
628}
629
630/**
631 * If magic_quotes_gpc is in use, run stripslashes() on $var. If $var is an
632 * array, stripslashes is run on each value, recursively, and the stripped
633 * array is returned
634 *
635 * @param  mixed $var   The string or array to un-quote, if necessary.
636 * @return mixed        $var, minus any magic quotes.
637 */
638function dispelMagicQuotes($var)
639{
640    static $magic_quotes_gpc;
641
642    if (!isset($magic_quotes_gpc)) {
643        $magic_quotes_gpc = get_magic_quotes_gpc();
644    }
645
646    if ($magic_quotes_gpc) {
647        if (!is_array($var)) {
648            $var = stripslashes($var);
649        } else {
650            foreach ($var as $key=>$val) {
651                if (is_array($val)) {
652                    $var[$key] = dispelMagicQuotes($val);
653                } else {
654                    $var[$key] = stripslashes($val);
655                }
656            }
657        }
658    }
659    return $var;
660}
661
662/**
663 * Get a form variable from GET or POST data, stripped of magic
664 * quotes if necessary.
665 *
666 * @param string $var (optional) The name of the form variable to look for.
667 * @param string $default (optional) The value to return if the
668 *                                   variable is not there.
669 *
670 * @return mixed      A cleaned GET or POST if no $var specified.
671 * @return string     A cleaned form $var if found, or $default.
672 */
673function getFormData($var=null, $default=null)
674{
675    if ('POST' == $_SERVER['REQUEST_METHOD'] && is_null($var)) {
676        return dispelMagicQuotes($_POST);
677    } else if ('GET' == $_SERVER['REQUEST_METHOD'] && is_null($var)) {
678        return dispelMagicQuotes($_GET);
679    }
680    if (isset($_POST[$var])) {
681        return dispelMagicQuotes($_POST[$var]);
682    } else if (isset($_GET[$var])) {
683        return dispelMagicQuotes($_GET[$var]);
684    } else {
685        return $default;
686    }
687}
688function getPost($var=null, $default=null)
689{
690    if (is_null($var)) {
691        return dispelMagicQuotes($_POST);
692    }
693    if (isset($_POST[$var])) {
694        return dispelMagicQuotes($_POST[$var]);
695    } else {
696        return $default;
697    }
698}
699function getGet($var=null, $default=null)
700{
701    if (is_null($var)) {
702        return dispelMagicQuotes($_GET);
703    }
704    if (isset($_GET[$var])) {
705        return dispelMagicQuotes($_GET[$var]);
706    } else {
707        return $default;
708    }
709}
710
711/**
712 * Signs a value using md5 and a simple text key. In order for this
713 * function to be useful (i.e. secure) the key must be kept secret, which
714 * means keeping it as safe as database credentials. Putting it into an
715 * environment variable set in httpd.conf is a good place.
716 *
717 * @access  public
718 *
719 * @param   string  $val    The string to sign.
720 * @param   string  $key    (Optional) A text key to use for computing the signature.
721 *
722 * @return  string  The original value with a signature appended.
723 */
724function addSignature($val, $key=null)
725{
726    global $CFG;
727
728    if ('' == $val) {
729        logMsg(sprintf('Adding signature to empty string.', null), LOG_NOTICE, __FILE__, __LINE__);
730    }
731
732    if (!isset($key)) {
733        $key = $CFG->signing_key;
734    }
735
736    return $val . '-' . substr(md5($val . $key), 0, 18);
737}
738
739/**
740 * Strips off the signature appended by addSignature().
741 *
742 * @access  public
743 *
744 * @param   string  $signed_val     The string to sign.
745 *
746 * @return  string  The original value with a signature removed.
747 */
748function removeSignature($signed_val)
749{
750    return substr($signed_val, 0, strrpos($signed_val, '-'));
751}
752
753
754/**
755 * Verifies a signature appened to a value by addSignature().
756 *
757 * @access  public
758 *
759 * @param   string  $signed_val A value with appended signature.
760 * @param   string  $key        (Optional) A text key to use for computing the signature.
761 *
762 * @return  bool    True if the signature matches the var.
763 */
764function verifySignature($signed_val, $key=null)
765{
766    // Strip the value from the signed value.
767    $val = substr($signed_val, 0, strrpos($signed_val, '-'));
768    // If the signed value matches the original signed value we consider the value safe.
769    if ($signed_val == addSignature($val, $key)) {
770        // Signature verified.
771        return true;
772    } else {
773        return false;
774    }
775}
776
777/**
778 * Stub functions used when installation does not have
779 * GNU gettext extension installed
780 */
781if (!extension_loaded('gettext')) {
782    /**
783    * Translates text
784    *
785    * @access public
786    * @param string $text the text to be translated
787    * @return string translated text
788    */
789    function gettext($text) {
790        return $text;
791    }
792
793    /**
794    * Translates text
795    *
796    * @access public
797    * @param string $text the text to be translated
798    * @return string translated text
799    */
800    function _($text) {
801        return $text;
802    }
803
804    /**
805    * Translates text by domain
806    *
807    * @access public
808    * @param string $domain the language to translate the text into
809    * @param string $text the text to be translated
810    * @return string translated text
811    */
812    function dgettext($domain, $text) {
813        return $text;
814    }
815
816    /**
817    * Translates text by domain and category
818    *
819    * @access public
820    * @param string $domain the language to translate the text into
821    * @param string $text the text to be translated
822    * @param string $category the language dialect to use
823    * @return string translated text
824    */
825    function dcgettext($domain, $text, $category) {
826        return $text;
827    }
828
829    /**
830    * Binds the text domain
831    *
832    * @access public
833    * @param string $domain the language to translate the text into
834    * @param string
835    * @return string translated text
836    */
837    function bindtextdomain($domain, $directory) {
838        return $domain;
839    }
840
841    /**
842    * Sets the text domain
843    *
844    * @access public
845    * @param string $domain the language to translate the text into
846    * @return string translated text
847    */
848    function textdomain($domain) {
849        return $domain;
850    }
851}
852
853/**
854 * Sends empty output to the browser and flushes the php buffer so the client
855 * will see data before the page is finished processing.
856 */
857function flushBuffer() {
858    echo str_repeat('          ', 205);
859    flush();
860}
861
862/**
863 * Adds email address to mailman mailing list. Requires /etc/sudoers entry for apache to sudo execute add_members.
864 * Don't forget to allow php_admin_value open_basedir access to "/var/mailman/bin".
865 *
866 * @access  public
867 *
868 * @param   string  $email     Email address to add.
869 * @param   string  $list      Name of list to add to.
870 * @param   bool    $send_welcome_message   True to send welcome message to subscriber.
871 *
872 * @return  bool    True on success, false on failure.
873 */
874function mailmanAddMember($email, $list, $send_welcome_message=false)
875{
876   $add_members = '/usr/lib/mailman/bin/add_members';
877    if (true || is_executable($add_members) && is_readable($add_members)) {
878        $welcome_msg = $send_welcome_message ? 'y' : 'n';
879        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);
880        $stdout = is_array($stdout) ? getDump($stdout) : $stdout;
881        if (0 == $return_code) {
882            logMsg(sprintf('Mailman add member success for list: %s, user: %s', $list, $email, $stdout), LOG_INFO, __FILE__, __LINE__);
883            return true;
884        } else {
885            logMsg(sprintf('Mailman add member failed for list: %s, user: %s, with message: %s', $list, $email, $stdout), LOG_WARNING, __FILE__, __LINE__);
886            return false;
887        }
888    } else {
889        logMsg(sprintf('Mailman add member program not executable: %s', $add_members), LOG_ALERT, __FILE__, __LINE__);
890        return false;
891    }
892}
893
894/**
895 * Removes email address from mailman mailing list. Requires /etc/sudoers entry for apache to sudo execute add_members.
896 * Don't forget to allow php_admin_value open_basedir access to "/var/mailman/bin".
897 *
898 * @access  public
899 *
900 * @param   string  $email     Email address to add.
901 * @param   string  $list      Name of list to add to.
902 * @param   bool    $send_user_ack   True to send goodbye message to subscriber.
903 *
904 * @return  bool    True on success, false on failure.
905 */
906function mailmanRemoveMember($email, $list, $send_user_ack=false)
907{
908    $remove_members = '/usr/lib/mailman/bin/remove_members';
909    if (true || is_executable($remove_members) && is_readable($remove_members)) {
910        $userack = $send_user_ack ? '' : '--nouserack';
911        exec(sprintf('/usr/bin/sudo %s %s --noadminack %s %s', escapeshellarg($remove_members), $userack, escapeshellarg($list), escapeshellarg($email)), $stdout, $return_code);
912        $stdout = is_array($stdout) ? getDump($stdout) : $stdout;
913        if (0 == $return_code) {
914            logMsg(sprintf('Mailman remove member success for list: %s, user: %s', $list, $email, $stdout), LOG_INFO, __FILE__, __LINE__);
915            return true;
916        } else {
917            logMsg(sprintf('Mailman remove member failed for list: %s, user: %s, with message: %s', $list, $email, $stdout), LOG_WARNING, __FILE__, __LINE__);
918            return false;
919        }
920    } else {
921        logMsg(sprintf('Mailman remove member program not executable: %s', $remove_members), LOG_ALERT, __FILE__, __LINE__);
922        return false;
923    }
924}
925
926
927
928?>
Note: See TracBrowser for help on using the repository browser.