source: trunk/include/functions.inc.php @ 5196

Last change on this file since 5196 was 5196, checked in by plg, 14 years ago

increase copyright year to 2010

File size: 42.2 KB
Line 
1<?php
2// +-----------------------------------------------------------------------+
3// | Piwigo - a PHP based picture gallery                                  |
4// +-----------------------------------------------------------------------+
5// | Copyright(C) 2008-2010 Piwigo Team                  http://piwigo.org |
6// | Copyright(C) 2003-2008 PhpWebGallery Team    http://phpwebgallery.net |
7// | Copyright(C) 2002-2003 Pierrick LE GALL   http://le-gall.net/pierrick |
8// +-----------------------------------------------------------------------+
9// | This program is free software; you can redistribute it and/or modify  |
10// | it under the terms of the GNU General Public License as published by  |
11// | the Free Software Foundation                                          |
12// |                                                                       |
13// | This program is distributed in the hope that it will be useful, but   |
14// | WITHOUT ANY WARRANTY; without even the implied warranty of            |
15// | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU      |
16// | General Public License for more details.                              |
17// |                                                                       |
18// | You should have received a copy of the GNU General Public License     |
19// | along with this program; if not, write to the Free Software           |
20// | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, |
21// | USA.                                                                  |
22// +-----------------------------------------------------------------------+
23
24include_once( PHPWG_ROOT_PATH .'include/functions_user.inc.php' );
25include_once( PHPWG_ROOT_PATH .'include/functions_cookie.inc.php' );
26include_once( PHPWG_ROOT_PATH .'include/functions_session.inc.php' );
27include_once( PHPWG_ROOT_PATH .'include/functions_category.inc.php' );
28include_once( PHPWG_ROOT_PATH .'include/functions_xml.inc.php' );
29include_once( PHPWG_ROOT_PATH .'include/functions_html.inc.php' );
30include_once( PHPWG_ROOT_PATH .'include/functions_tag.inc.php' );
31include_once( PHPWG_ROOT_PATH .'include/functions_url.inc.php' );
32include_once( PHPWG_ROOT_PATH .'include/functions_plugins.inc.php' );
33
34//----------------------------------------------------------- generic functions
35function get_extra_fields($order_by_fields) 
36{
37  $fields = str_ireplace(array(' order by ', ' desc', ' asc'), 
38                         array('', '', ''),
39                         $order_by_fields
40                         );
41  if (!empty($fields))
42  { 
43    $fields = ','.$fields;
44  }
45  return $fields;
46}
47
48// The function get_moment returns a float value coresponding to the number
49// of seconds since the unix epoch (1st January 1970) and the microseconds
50// are precised : e.g. 1052343429.89276600
51function get_moment()
52{
53  $t1 = explode( ' ', microtime() );
54  $t2 = explode( '.', $t1[0] );
55  $t2 = $t1[1].'.'.$t2[1];
56  return $t2;
57}
58
59// The function get_elapsed_time returns the number of seconds (with 3
60// decimals precision) between the start time and the end time given.
61function get_elapsed_time( $start, $end )
62{
63  return number_format( $end - $start, 3, '.', ' ').' s';
64}
65
66// - The replace_space function replaces space and '-' characters
67//   by their HTML equivalent  &nbsb; and &minus;
68// - The function does not replace characters in HTML tags
69// - This function was created because IE5 does not respect the
70//   CSS "white-space: nowrap;" property unless space and minus
71//   characters are replaced like this function does.
72// - Example :
73//                 <div class="foo">My friend</div>
74//               ( 01234567891111111111222222222233 )
75//               (           0123456789012345678901 )
76// becomes :
77//             <div class="foo">My&nbsp;friend</div>
78function replace_space( $string )
79{
80  //return $string;
81  $return_string = '';
82  // $remaining is the rest of the string where to replace spaces characters
83  $remaining = $string;
84  // $start represents the position of the next '<' character
85  // $end   represents the position of the next '>' character
86  ; // -> 0
87  $end   = strpos ( $remaining, '>' ); // -> 16
88  // as long as a '<' and his friend '>' are found, we loop
89  while ( ($start=strpos( $remaining, '<' )) !==false
90        and ($end=strpos( $remaining, '>' )) !== false )
91  {
92    // $treatment is the part of the string to treat
93    // In the first loop of our example, this variable is empty, but in the
94    // second loop, it equals 'My friend'
95    $treatment = substr ( $remaining, 0, $start );
96    // Replacement of ' ' by his equivalent '&nbsp;'
97    $treatment = str_replace( ' ', '&nbsp;', $treatment );
98    $treatment = str_replace( '-', '&minus;', $treatment );
99    // composing the string to return by adding the treated string and the
100    // following HTML tag -> 'My&nbsp;friend</div>'
101    $return_string.= $treatment.substr( $remaining, $start, $end-$start+1 );
102    // the remaining string is deplaced to the part after the '>' of this
103    // loop
104    $remaining = substr ( $remaining, $end + 1, strlen( $remaining ) );
105  }
106  $treatment = str_replace( ' ', '&nbsp;', $remaining );
107  $treatment = str_replace( '-', '&minus;', $treatment );
108  $return_string.= $treatment;
109
110  return $return_string;
111}
112
113// get_extension returns the part of the string after the last "."
114function get_extension( $filename )
115{
116  return substr( strrchr( $filename, '.' ), 1, strlen ( $filename ) );
117}
118
119// get_filename_wo_extension returns the part of the string before the last
120// ".".
121// get_filename_wo_extension( 'test.tar.gz' ) -> 'test.tar'
122function get_filename_wo_extension( $filename )
123{
124  $pos = strrpos( $filename, '.' );
125  return ($pos===false) ? $filename : substr( $filename, 0, $pos);
126}
127
128/**
129 * returns an array contening sub-directories, excluding ".svn"
130 *
131 * @param string $dir
132 * @return array
133 */
134function get_dirs($directory)
135{
136  $sub_dirs = array();
137  if ($opendir = opendir($directory))
138  {
139    while ($file = readdir($opendir))
140    {
141      if ($file != '.'
142          and $file != '..'
143          and is_dir($directory.'/'.$file)
144          and $file != '.svn')
145      {
146        array_push($sub_dirs, $file);
147      }
148    }
149    closedir($opendir);
150  }
151  return $sub_dirs;
152}
153
154define('MKGETDIR_NONE', 0);
155define('MKGETDIR_RECURSIVE', 1);
156define('MKGETDIR_DIE_ON_ERROR', 2);
157define('MKGETDIR_PROTECT_INDEX', 4);
158define('MKGETDIR_PROTECT_HTACCESS', 8);
159define('MKGETDIR_DEFAULT', 7);
160/**
161 * creates directory if not exists; ensures that directory is writable
162 * @param:
163 *  string $dir
164 *  int $flags combination of MKGETDIR_xxx
165 * @return bool false on error else true
166 */
167function mkgetdir($dir, $flags=MKGETDIR_DEFAULT)
168{
169  if ( !is_dir($dir) )
170  {
171    $umask = umask(0);
172    $mkd = @mkdir($dir, 0755, ($flags&MKGETDIR_RECURSIVE) ? true:false );
173    umask($umask);
174    if ($mkd==false)
175    {
176      !($flags&MKGETDIR_DIE_ON_ERROR) or fatal_error( "$dir ".l10n('no write access'));
177      return false;
178    }
179    if( $flags&MKGETDIR_PROTECT_HTACCESS )
180    {
181      $file = $dir.'/.htaccess';
182      file_exists($file) or @file_put_contents( $file, 'deny from all' );
183    }
184    if( $flags&MKGETDIR_PROTECT_INDEX )
185    {
186      $file = $dir.'/index.htm';
187      file_exists($file) or @file_put_contents( $file, 'Not allowed!' );
188    }
189  }
190  if ( !is_writable($dir) )
191  {
192    !($flags&MKGETDIR_DIE_ON_ERROR) or fatal_error( "$dir ".l10n('no write access'));
193    return false;
194  }
195  return true;
196}
197
198/**
199 * returns thumbnail directory name of input diretoty name
200 * make thumbnail directory is necessary
201 * set error messages on array messages
202 *
203 * @param:
204 *  string $dirname
205 *  arrayy $errors
206 * @return bool false on error else string directory name
207 */
208function mkget_thumbnail_dir($dirname, &$errors)
209{
210  global $conf;
211
212  $tndir = $dirname.'/'.$conf['dir_thumbnail'];
213  if (! mkgetdir($tndir, MKGETDIR_NONE) )
214  {
215    array_push($errors,
216          '['.$dirname.'] : '.l10n('no write access'));
217    return false;
218  }
219  return $tndir;
220}
221
222/* Returns true if the string appears to be encoded in UTF-8. (from wordpress)
223 * @param string Str
224 */
225function seems_utf8($Str) { # by bmorel at ssi dot fr
226  for ($i=0; $i<strlen($Str); $i++) {
227    if (ord($Str[$i]) < 0x80) continue; # 0bbbbbbb
228    elseif ((ord($Str[$i]) & 0xE0) == 0xC0) $n=1; # 110bbbbb
229    elseif ((ord($Str[$i]) & 0xF0) == 0xE0) $n=2; # 1110bbbb
230    elseif ((ord($Str[$i]) & 0xF8) == 0xF0) $n=3; # 11110bbb
231    elseif ((ord($Str[$i]) & 0xFC) == 0xF8) $n=4; # 111110bb
232    elseif ((ord($Str[$i]) & 0xFE) == 0xFC) $n=5; # 1111110b
233    else return false; # Does not match any model
234    for ($j=0; $j<$n; $j++) { # n bytes matching 10bbbbbb follow ?
235      if ((++$i == strlen($Str)) || ((ord($Str[$i]) & 0xC0) != 0x80))
236      return false;
237    }
238  }
239  return true;
240}
241
242/* Remove accents from a UTF-8 or ISO-859-1 string (from wordpress)
243 * @param string sstring - an UTF-8 or ISO-8859-1 string
244 */
245function remove_accents($string)
246{
247  if ( !preg_match('/[\x80-\xff]/', $string) )
248    return $string;
249
250  if (seems_utf8($string)) {
251    $chars = array(
252    // Decompositions for Latin-1 Supplement
253    chr(195).chr(128) => 'A', chr(195).chr(129) => 'A',
254    chr(195).chr(130) => 'A', chr(195).chr(131) => 'A',
255    chr(195).chr(132) => 'A', chr(195).chr(133) => 'A',
256    chr(195).chr(135) => 'C', chr(195).chr(136) => 'E',
257    chr(195).chr(137) => 'E', chr(195).chr(138) => 'E',
258    chr(195).chr(139) => 'E', chr(195).chr(140) => 'I',
259    chr(195).chr(141) => 'I', chr(195).chr(142) => 'I',
260    chr(195).chr(143) => 'I', chr(195).chr(145) => 'N',
261    chr(195).chr(146) => 'O', chr(195).chr(147) => 'O',
262    chr(195).chr(148) => 'O', chr(195).chr(149) => 'O',
263    chr(195).chr(150) => 'O', chr(195).chr(153) => 'U',
264    chr(195).chr(154) => 'U', chr(195).chr(155) => 'U',
265    chr(195).chr(156) => 'U', chr(195).chr(157) => 'Y',
266    chr(195).chr(159) => 's', chr(195).chr(160) => 'a',
267    chr(195).chr(161) => 'a', chr(195).chr(162) => 'a',
268    chr(195).chr(163) => 'a', chr(195).chr(164) => 'a',
269    chr(195).chr(165) => 'a', chr(195).chr(167) => 'c',
270    chr(195).chr(168) => 'e', chr(195).chr(169) => 'e',
271    chr(195).chr(170) => 'e', chr(195).chr(171) => 'e',
272    chr(195).chr(172) => 'i', chr(195).chr(173) => 'i',
273    chr(195).chr(174) => 'i', chr(195).chr(175) => 'i',
274    chr(195).chr(177) => 'n', chr(195).chr(178) => 'o',
275    chr(195).chr(179) => 'o', chr(195).chr(180) => 'o',
276    chr(195).chr(181) => 'o', chr(195).chr(182) => 'o',
277    chr(195).chr(182) => 'o', chr(195).chr(185) => 'u',
278    chr(195).chr(186) => 'u', chr(195).chr(187) => 'u',
279    chr(195).chr(188) => 'u', chr(195).chr(189) => 'y',
280    chr(195).chr(191) => 'y',
281    // Decompositions for Latin Extended-A
282    chr(196).chr(128) => 'A', chr(196).chr(129) => 'a',
283    chr(196).chr(130) => 'A', chr(196).chr(131) => 'a',
284    chr(196).chr(132) => 'A', chr(196).chr(133) => 'a',
285    chr(196).chr(134) => 'C', chr(196).chr(135) => 'c',
286    chr(196).chr(136) => 'C', chr(196).chr(137) => 'c',
287    chr(196).chr(138) => 'C', chr(196).chr(139) => 'c',
288    chr(196).chr(140) => 'C', chr(196).chr(141) => 'c',
289    chr(196).chr(142) => 'D', chr(196).chr(143) => 'd',
290    chr(196).chr(144) => 'D', chr(196).chr(145) => 'd',
291    chr(196).chr(146) => 'E', chr(196).chr(147) => 'e',
292    chr(196).chr(148) => 'E', chr(196).chr(149) => 'e',
293    chr(196).chr(150) => 'E', chr(196).chr(151) => 'e',
294    chr(196).chr(152) => 'E', chr(196).chr(153) => 'e',
295    chr(196).chr(154) => 'E', chr(196).chr(155) => 'e',
296    chr(196).chr(156) => 'G', chr(196).chr(157) => 'g',
297    chr(196).chr(158) => 'G', chr(196).chr(159) => 'g',
298    chr(196).chr(160) => 'G', chr(196).chr(161) => 'g',
299    chr(196).chr(162) => 'G', chr(196).chr(163) => 'g',
300    chr(196).chr(164) => 'H', chr(196).chr(165) => 'h',
301    chr(196).chr(166) => 'H', chr(196).chr(167) => 'h',
302    chr(196).chr(168) => 'I', chr(196).chr(169) => 'i',
303    chr(196).chr(170) => 'I', chr(196).chr(171) => 'i',
304    chr(196).chr(172) => 'I', chr(196).chr(173) => 'i',
305    chr(196).chr(174) => 'I', chr(196).chr(175) => 'i',
306    chr(196).chr(176) => 'I', chr(196).chr(177) => 'i',
307    chr(196).chr(178) => 'IJ',chr(196).chr(179) => 'ij',
308    chr(196).chr(180) => 'J', chr(196).chr(181) => 'j',
309    chr(196).chr(182) => 'K', chr(196).chr(183) => 'k',
310    chr(196).chr(184) => 'k', chr(196).chr(185) => 'L',
311    chr(196).chr(186) => 'l', chr(196).chr(187) => 'L',
312    chr(196).chr(188) => 'l', chr(196).chr(189) => 'L',
313    chr(196).chr(190) => 'l', chr(196).chr(191) => 'L',
314    chr(197).chr(128) => 'l', chr(197).chr(129) => 'L',
315    chr(197).chr(130) => 'l', chr(197).chr(131) => 'N',
316    chr(197).chr(132) => 'n', chr(197).chr(133) => 'N',
317    chr(197).chr(134) => 'n', chr(197).chr(135) => 'N',
318    chr(197).chr(136) => 'n', chr(197).chr(137) => 'N',
319    chr(197).chr(138) => 'n', chr(197).chr(139) => 'N',
320    chr(197).chr(140) => 'O', chr(197).chr(141) => 'o',
321    chr(197).chr(142) => 'O', chr(197).chr(143) => 'o',
322    chr(197).chr(144) => 'O', chr(197).chr(145) => 'o',
323    chr(197).chr(146) => 'OE',chr(197).chr(147) => 'oe',
324    chr(197).chr(148) => 'R',chr(197).chr(149) => 'r',
325    chr(197).chr(150) => 'R',chr(197).chr(151) => 'r',
326    chr(197).chr(152) => 'R',chr(197).chr(153) => 'r',
327    chr(197).chr(154) => 'S',chr(197).chr(155) => 's',
328    chr(197).chr(156) => 'S',chr(197).chr(157) => 's',
329    chr(197).chr(158) => 'S',chr(197).chr(159) => 's',
330    chr(197).chr(160) => 'S', chr(197).chr(161) => 's',
331    chr(197).chr(162) => 'T', chr(197).chr(163) => 't',
332    chr(197).chr(164) => 'T', chr(197).chr(165) => 't',
333    chr(197).chr(166) => 'T', chr(197).chr(167) => 't',
334    chr(197).chr(168) => 'U', chr(197).chr(169) => 'u',
335    chr(197).chr(170) => 'U', chr(197).chr(171) => 'u',
336    chr(197).chr(172) => 'U', chr(197).chr(173) => 'u',
337    chr(197).chr(174) => 'U', chr(197).chr(175) => 'u',
338    chr(197).chr(176) => 'U', chr(197).chr(177) => 'u',
339    chr(197).chr(178) => 'U', chr(197).chr(179) => 'u',
340    chr(197).chr(180) => 'W', chr(197).chr(181) => 'w',
341    chr(197).chr(182) => 'Y', chr(197).chr(183) => 'y',
342    chr(197).chr(184) => 'Y', chr(197).chr(185) => 'Z',
343    chr(197).chr(186) => 'z', chr(197).chr(187) => 'Z',
344    chr(197).chr(188) => 'z', chr(197).chr(189) => 'Z',
345    chr(197).chr(190) => 'z', chr(197).chr(191) => 's',
346    // Euro Sign
347    chr(226).chr(130).chr(172) => 'E',
348    // GBP (Pound) Sign
349    chr(194).chr(163) => '');
350
351    $string = strtr($string, $chars);
352  } else {
353    // Assume ISO-8859-1 if not UTF-8
354    $chars['in'] = chr(128).chr(131).chr(138).chr(142).chr(154).chr(158)
355      .chr(159).chr(162).chr(165).chr(181).chr(192).chr(193).chr(194)
356      .chr(195).chr(196).chr(197).chr(199).chr(200).chr(201).chr(202)
357      .chr(203).chr(204).chr(205).chr(206).chr(207).chr(209).chr(210)
358      .chr(211).chr(212).chr(213).chr(214).chr(216).chr(217).chr(218)
359      .chr(219).chr(220).chr(221).chr(224).chr(225).chr(226).chr(227)
360      .chr(228).chr(229).chr(231).chr(232).chr(233).chr(234).chr(235)
361      .chr(236).chr(237).chr(238).chr(239).chr(241).chr(242).chr(243)
362      .chr(244).chr(245).chr(246).chr(248).chr(249).chr(250).chr(251)
363      .chr(252).chr(253).chr(255);
364
365    $chars['out'] = "EfSZszYcYuAAAAAACEEEEIIIINOOOOOOUUUUYaaaaaaceeeeiiiinoooooouuuuyy";
366
367    $string = strtr($string, $chars['in'], $chars['out']);
368    $double_chars['in'] = array(chr(140), chr(156), chr(198), chr(208), chr(222), chr(223), chr(230), chr(240), chr(254));
369    $double_chars['out'] = array('OE', 'oe', 'AE', 'DH', 'TH', 'ss', 'ae', 'dh', 'th');
370    $string = str_replace($double_chars['in'], $double_chars['out'], $string);
371  }
372
373  return $string;
374}
375
376/**
377 * simplify a string to insert it into an URL
378 *
379 * @param string
380 * @return string
381 */
382function str2url($str)
383{
384  $str = remove_accents($str);
385  $str = preg_replace('/[^a-z0-9_\s\'\:\/\[\],-]/','',strtolower($str));
386  $str = preg_replace('/[\s\'\:\/\[\],-]+/',' ',trim($str));
387  $res = str_replace(' ','_',$str);
388
389  return $res;
390}
391
392//-------------------------------------------- Piwigo specific functions
393
394/**
395 * returns an array with a list of {language_code => language_name}
396 *
397 * @returns array
398 */
399function get_languages($target_charset = null)
400{
401  if ( empty($target_charset) )
402  {
403    $target_charset = get_pwg_charset();
404  }
405  $target_charset = strtolower($target_charset);
406
407  $dir = opendir(PHPWG_ROOT_PATH.'language');
408  $languages = array();
409
410  while ($file = readdir($dir))
411  {
412    $path = PHPWG_ROOT_PATH.'language/'.$file;
413    if (!is_link($path) and file_exists($path.'/iso.txt'))
414    {
415      list($language_name) = @file($path.'/iso.txt');
416
417      $langdef = explode('.',$file);
418      if (count($langdef)>1) // (langCode,encoding)
419      {
420        $langdef[1] = strtolower($langdef[1]);
421
422        if (
423          $target_charset==$langdef[1]
424         or
425          ($target_charset=='utf-8' and $langdef[1]=='iso-8859-1')
426         or
427          ($target_charset=='iso-8859-1' and
428          in_array( substr($langdef[0],2), array('en','fr','de','es','it','nl')))
429        )
430        {
431          $language_name = convert_charset($language_name,
432              $langdef[1], $target_charset);
433          $languages[ $langdef[0] ] = $language_name;
434        }
435        else
436          continue; // the language encoding is not compatible with our charset
437      }
438      else
439      { // UTF-8
440        $language_name = convert_charset($language_name,
441              'utf-8', $target_charset);
442        $languages[$file] = $language_name;
443      }
444    }
445  }
446  closedir($dir);
447  @asort($languages);
448
449  return $languages;
450}
451
452function pwg_log($image_id = null, $image_type = null)
453{
454  global $conf, $user, $page;
455
456  $do_log = $conf['log'];
457  if (is_admin())
458  {
459    $do_log = $conf['history_admin'];
460  }
461  if (is_a_guest())
462  {
463    $do_log = $conf['history_guest'];
464  }
465
466  $do_log = trigger_event('pwg_log_allowed', $do_log, $image_id, $image_type);
467
468  if (!$do_log)
469  {
470    return false;
471  }
472
473  $tags_string = null;
474  if ('tags'==@$page['section'])
475  {
476    $tags_string = implode(',', $page['tag_ids']);
477  }
478
479  $query = '
480INSERT INTO '.HISTORY_TABLE.'
481  (
482    date,
483    time,
484    user_id,
485    IP,
486    section,
487    category_id,
488    image_id,
489    image_type,
490    tag_ids
491  )
492  VALUES
493  (
494    CURRENT_DATE,
495    CURRENT_TIME,
496    '.$user['id'].',
497    \''.$_SERVER['REMOTE_ADDR'].'\',
498    '.(isset($page['section']) ? "'".$page['section']."'" : 'NULL').',
499    '.(isset($page['category']['id']) ? $page['category']['id'] : 'NULL').',
500    '.(isset($image_id) ? $image_id : 'NULL').',
501    '.(isset($image_type) ? "'".$image_type."'" : 'NULL').',
502    '.(isset($tags_string) ? "'".$tags_string."'" : 'NULL').'
503  )
504;';
505  pwg_query($query);
506
507  return true;
508}
509
510// format_date returns a formatted date for display. The date given in
511// argument must be an american format (2003-09-15). By option, you can show the time.
512// The output is internationalized.
513//
514// format_date( "2003-09-15", true ) -> "Monday 15 September 2003 21:52"
515function format_date($date, $show_time = false)
516{
517  global $lang;
518
519  if (strpos($date, '0') == 0)
520  {
521    return l10n('N/A');
522  }
523
524  $ymdhms = array();
525  $tok = strtok( $date, '- :');
526  while ($tok !== false)
527  {
528    $ymdhms[] = $tok;
529    $tok = strtok('- :');
530  }
531
532  if ( count($ymdhms)<3 )
533  {
534    return false;
535  }
536
537  $formated_date = '';
538  // before 1970, Microsoft Windows can't mktime
539  if ($ymdhms[0] >= 1970)
540  {
541    // we ask midday because Windows think it's prior to midnight with a
542    // zero and refuse to work
543    $formated_date.= $lang['day'][date('w', mktime(12,0,0,$ymdhms[1],$ymdhms[2],$ymdhms[0]))];
544  }
545  $formated_date.= ' '.$ymdhms[2];
546  $formated_date.= ' '.$lang['month'][(int)$ymdhms[1]];
547  $formated_date.= ' '.$ymdhms[0];
548  if ($show_time and count($ymdhms)>=5 )
549  {
550    $formated_date.= ' '.$ymdhms[3].':'.$ymdhms[4];
551  }
552  return $formated_date;
553}
554
555function pwg_debug( $string )
556{
557  global $debug,$t2,$page;
558
559  $now = explode( ' ', microtime() );
560  $now2 = explode( '.', $now[0] );
561  $now2 = $now[1].'.'.$now2[1];
562  $time = number_format( $now2 - $t2, 3, '.', ' ').' s';
563  $debug .= '<p>';
564  $debug.= '['.$time.', ';
565  $debug.= $page['count_queries'].' queries] : '.$string;
566  $debug.= "</p>\n";
567}
568
569/**
570 * Redirects to the given URL (HTTP method)
571 *
572 * Note : once this function called, the execution doesn't go further
573 * (presence of an exit() instruction.
574 *
575 * @param string $url
576 * @return void
577 */
578function redirect_http( $url )
579{
580  if (ob_get_length () !== FALSE)
581  {
582    ob_clean();
583  }
584  // default url is on html format
585  $url = html_entity_decode($url);
586  header('Request-URI: '.$url);
587  header('Content-Location: '.$url);
588  header('Location: '.$url);
589  exit();
590}
591
592/**
593 * Redirects to the given URL (HTML method)
594 *
595 * Note : once this function called, the execution doesn't go further
596 * (presence of an exit() instruction.
597 *
598 * @param string $url
599 * @param string $title_msg
600 * @param integer $refreh_time
601 * @return void
602 */
603function redirect_html( $url , $msg = '', $refresh_time = 0)
604{
605  global $user, $template, $lang_info, $conf, $lang, $t2, $page, $debug;
606
607  if (!isset($lang_info))
608  {
609    $user = build_user( $conf['guest_id'], true);
610    load_language('common.lang');
611    trigger_action('loading_lang');
612    load_language('local.lang', '', array('no_fallback'=>true) );
613    $template = new Template(PHPWG_ROOT_PATH.'themes', get_default_theme());
614  }
615  else
616  {
617    $template = new Template(PHPWG_ROOT_PATH.'themes', $user['theme']);
618  }
619
620  if (empty($msg))
621  {
622    $msg = nl2br(l10n('Redirection...'));
623  }
624
625  $refresh = $refresh_time;
626  $url_link = $url;
627  $title = 'redirection';
628
629  $template->set_filenames( array( 'redirect' => 'redirect.tpl' ) );
630
631  include( PHPWG_ROOT_PATH.'include/page_header.php' );
632
633  $template->set_filenames( array( 'redirect' => 'redirect.tpl' ) );
634  $template->assign('REDIRECT_MSG', $msg);
635
636  $template->parse('redirect');
637
638  include( PHPWG_ROOT_PATH.'include/page_tail.php' );
639
640  exit();
641}
642
643/**
644 * Redirects to the given URL (Switch to HTTP method or HTML method)
645 *
646 * Note : once this function called, the execution doesn't go further
647 * (presence of an exit() instruction.
648 *
649 * @param string $url
650 * @param string $title_msg
651 * @param integer $refreh_time
652 * @return void
653 */
654function redirect( $url , $msg = '', $refresh_time = 0)
655{
656  global $conf;
657
658  // with RefeshTime <> 0, only html must be used
659  if ($conf['default_redirect_method']=='http'
660      and $refresh_time==0
661      and !headers_sent()
662    )
663  {
664    redirect_http($url);
665  }
666  else
667  {
668    redirect_html($url, $msg, $refresh_time);
669  }
670}
671
672/**
673 * returns $_SERVER['QUERY_STRING'] whitout keys given in parameters
674 *
675 * @param array $rejects
676 * @param boolean $escape - if true escape & to &amp; (for html)
677 * @returns string
678 */
679function get_query_string_diff($rejects=array(), $escape=true)
680{
681  $query_string = '';
682
683  $str = $_SERVER['QUERY_STRING'];
684  parse_str($str, $vars);
685
686  $is_first = true;
687  foreach ($vars as $key => $value)
688  {
689    if (!in_array($key, $rejects))
690    {
691      $query_string.= $is_first ? '?' : ($escape ? '&amp;' : '&' );
692      $is_first = false;
693      $query_string.= $key.'='.$value;
694    }
695  }
696
697  return $query_string;
698}
699
700function url_is_remote($url)
701{
702  if ( strncmp($url, 'http://', 7)==0
703    or strncmp($url, 'https://', 8)==0 )
704  {
705    return true;
706  }
707  return false;
708}
709
710/**
711 * returns available themes
712 */
713function get_pwg_themes()
714{
715  $themes = array();
716
717  $query = '
718SELECT
719    id,
720    name
721  FROM '.THEMES_TABLE.'
722  ORDER BY name ASC
723;';
724  $result = pwg_query($query);
725  while ($row = pwg_db_fetch_assoc($result))
726  {
727    $themes[ $row['id'] ] = $row['name'];
728  }
729
730  // plugins want remove some themes based on user status maybe?
731  $themes = trigger_event('get_pwg_themes', $themes);
732 
733  return $themes;
734}
735
736/* Returns the PATH to the thumbnail to be displayed. If the element does not
737 * have a thumbnail, the default mime image path is returned. The PATH can be
738 * used in the php script, but not sent to the browser.
739 * @param array element_info assoc array containing element info from db
740 * at least 'path', 'tn_ext' and 'id' should be present
741 */
742function get_thumbnail_path($element_info)
743{
744  $path = get_thumbnail_location($element_info);
745  if ( !url_is_remote($path) )
746  {
747    $path = PHPWG_ROOT_PATH.$path;
748  }
749  return $path;
750}
751
752/* Returns the URL of the thumbnail to be displayed. If the element does not
753 * have a thumbnail, the default mime image url is returned. The URL can be
754 * sent to the browser, but not used in the php script.
755 * @param array element_info assoc array containing element info from db
756 * at least 'path', 'tn_ext' and 'id' should be present
757 */
758function get_thumbnail_url($element_info)
759{
760  $path = get_thumbnail_location($element_info);
761  if ( !url_is_remote($path) )
762  {
763    $path = embellish_url(get_root_url().$path);
764  }
765
766  // plugins want another url ?
767  $path = trigger_event('get_thumbnail_url', $path, $element_info);
768  return $path;
769}
770
771/* returns the relative path of the thumnail with regards to to the root
772of piwigo (not the current page!).This function is not intended to be
773called directly from code.*/
774function get_thumbnail_location($element_info)
775{
776  global $conf;
777  if ( !empty( $element_info['tn_ext'] ) )
778  {
779    $path = substr_replace(
780      get_filename_wo_extension($element_info['path']),
781      '/'.$conf['dir_thumbnail'].'/'.$conf['prefix_thumbnail'],
782      strrpos($element_info['path'],'/'),
783      1
784      );
785    $path.= '.'.$element_info['tn_ext'];
786  }
787  else
788  {
789    $path = get_themeconf('mime_icon_dir')
790        .strtolower(get_extension($element_info['path'])).'.png';
791  }
792
793  // plugins want another location ?
794  $path = trigger_event( 'get_thumbnail_location', $path, $element_info);
795  return $path;
796}
797
798/* returns the title of the thumnail */
799function get_thumbnail_title($element_info)
800{
801  // message in title for the thumbnail
802  if (isset($element_info['file']))
803  {
804    $thumbnail_title = $element_info['file'];
805  }
806  else
807  {
808    $thumbnail_title = '';
809  }
810
811  if (!empty($element_info['filesize']))
812  {
813    $thumbnail_title .= ' : '.sprintf(l10n('%d Kb'), $element_info['filesize']);
814  }
815
816  return $thumbnail_title;
817}
818
819/**
820 * fill the current user caddie with given elements, if not already in
821 * caddie
822 *
823 * @param array elements_id
824 */
825function fill_caddie($elements_id)
826{
827  global $user;
828
829  include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
830
831  $query = '
832SELECT element_id
833  FROM '.CADDIE_TABLE.'
834  WHERE user_id = '.$user['id'].'
835;';
836  $in_caddie = array_from_query($query, 'element_id');
837
838  $caddiables = array_diff($elements_id, $in_caddie);
839
840  $datas = array();
841
842  foreach ($caddiables as $caddiable)
843  {
844    array_push($datas, array('element_id' => $caddiable,
845                             'user_id' => $user['id']));
846  }
847
848  if (count($caddiables) > 0)
849  {
850    mass_inserts(CADDIE_TABLE, array('element_id','user_id'), $datas);
851  }
852}
853
854/**
855 * returns the element name from its filename
856 *
857 * @param string filename
858 * @return string name
859 */
860function get_name_from_file($filename)
861{
862  return str_replace('_',' ',get_filename_wo_extension($filename));
863}
864
865/**
866 * returns the corresponding value from $lang if existing. Else, the key is
867 * returned
868 *
869 * @param string key
870 * @return string
871 */
872function l10n($key, $textdomain='messages')
873{
874  global $lang, $conf;
875
876  if ($conf['debug_l10n'] and !isset($lang[$key]) and !empty($key))
877  {
878    trigger_error('[l10n] language key "'.$key.'" is not defined', E_USER_WARNING);
879  }
880
881  return isset($lang[$key]) ? $lang[$key] : $key;
882}
883
884/**
885 * returns the prinft value for strings including %d
886 * return is concorded with decimal value (singular, plural)
887 *
888 * @param singular string key
889 * @param plural string key
890 * @param decimal value
891 * @return string
892 */
893function l10n_dec($singular_fmt_key, $plural_fmt_key, $decimal)
894{
895  global $lang_info;
896
897  return
898    sprintf(
899      l10n((
900        (($decimal > 1) or ($decimal == 0 and $lang_info['zero_plural']))
901          ? $plural_fmt_key
902          : $singular_fmt_key
903        )), $decimal);
904}
905
906/*
907 * returns a single element to use with l10n_args
908 *
909 * @param string key: translation key
910 * @param array/string/../number args:
911 *   arguments to use on sprintf($key, args)
912 *   if args is a array, each values are used on sprintf
913 * @return string
914 */
915function get_l10n_args($key, $args)
916{
917  if (is_array($args))
918  {
919    $key_arg = array_merge(array($key), $args);
920  }
921  else
922  {
923    $key_arg = array($key,  $args);
924  }
925  return array('key_args' => $key_arg);
926}
927
928/*
929 * returns a string with formated with l10n_args elements
930 *
931 * @param element/array $key_args: element or array of l10n_args elements
932 * @param $sep: if $key_args is array,
933 *   separator is used when translated l10n_args elements are concated
934 * @return string
935 */
936function l10n_args($key_args, $sep = "\n")
937{
938  if (is_array($key_args))
939  {
940    foreach ($key_args as $key => $element)
941    {
942      if (isset($result))
943      {
944        $result .= $sep;
945      }
946      else
947      {
948        $result = '';
949      }
950
951      if ($key === 'key_args')
952      {
953        array_unshift($element, l10n(array_shift($element)));
954        $result .= call_user_func_array('sprintf', $element);
955      }
956      else
957      {
958        $result .= l10n_args($element, $sep);
959      }
960    }
961  }
962  else
963  {
964    fatal_error('l10n_args: Invalid arguments');
965  }
966
967  return $result;
968}
969
970/**
971 * returns the corresponding value from $themeconf if existing. Else, the
972 * key is returned
973 *
974 * @param string key
975 * @return string
976 */
977function get_themeconf($key)
978{
979  global $template;
980
981  return $template->get_themeconf($key);
982}
983
984/**
985 * Returns webmaster mail address depending on $conf['webmaster_id']
986 *
987 * @return string
988 */
989function get_webmaster_mail_address()
990{
991  global $conf;
992
993  $query = '
994SELECT '.$conf['user_fields']['email'].'
995  FROM '.USERS_TABLE.'
996  WHERE '.$conf['user_fields']['id'].' = '.$conf['webmaster_id'].'
997;';
998  list($email) = pwg_db_fetch_row(pwg_query($query));
999
1000  return $email;
1001}
1002
1003/**
1004 * Add configuration parameters from database to global $conf array
1005 *
1006 * @return void
1007 */
1008function load_conf_from_db($condition = '')
1009{
1010  global $conf;
1011
1012  $query = '
1013SELECT param, value
1014 FROM '.CONFIG_TABLE.'
1015 '.(!empty($condition) ? 'WHERE '.$condition : '').'
1016;';
1017  $result = pwg_query($query);
1018
1019  if ((pwg_db_num_rows($result) == 0) and !empty($condition))
1020  {
1021    fatal_error('No configuration data');
1022  }
1023
1024  while ($row = pwg_db_fetch_assoc($result))
1025  {
1026    $conf[ $row['param'] ] = isset($row['value']) ? $row['value'] : '';
1027
1028    // If the field is true or false, the variable is transformed into a
1029    // boolean value.
1030    if ($conf[$row['param']] == 'true' or $conf[$row['param']] == 'false')
1031    {
1032      $conf[ $row['param'] ] = get_boolean($conf[ $row['param'] ]);
1033    }
1034  }
1035}
1036
1037function conf_update_param($param, $value)
1038{
1039  $query = '
1040DELETE
1041  FROM '.CONFIG_TABLE.'
1042  WHERE param = "'.$param.'"
1043;';
1044  pwg_query($query);
1045
1046  $query = '
1047INSERT
1048  INTO '.CONFIG_TABLE.'
1049  SET param = "'.$param.'"
1050    , value = "'.$value.'"
1051;';
1052  pwg_query($query);
1053}
1054
1055/**
1056 * Prepends and appends a string at each value of the given array.
1057 *
1058 * @param array
1059 * @param string prefix to each array values
1060 * @param string suffix to each array values
1061 */
1062function prepend_append_array_items($array, $prepend_str, $append_str)
1063{
1064  array_walk(
1065    $array,
1066    create_function('&$s', '$s = "'.$prepend_str.'".$s."'.$append_str.'";')
1067    );
1068
1069  return $array;
1070}
1071
1072/**
1073 * creates an hashed based on a query, this function is a very common
1074 * pattern used here. Among the selected columns fetched, choose one to be
1075 * the key, another one to be the value.
1076 *
1077 * @param string $query
1078 * @param string $keyname
1079 * @param string $valuename
1080 * @return array
1081 */
1082function simple_hash_from_query($query, $keyname, $valuename)
1083{
1084  $array = array();
1085
1086  $result = pwg_query($query);
1087  while ($row = pwg_db_fetch_assoc($result))
1088  {
1089    $array[ $row[$keyname] ] = $row[$valuename];
1090  }
1091
1092  return $array;
1093}
1094
1095/**
1096 * creates an hashed based on a query, this function is a very common
1097 * pattern used here. The key is given as parameter, the value is an associative
1098 * array.
1099 *
1100 * @param string $query
1101 * @param string $keyname
1102 * @return array
1103 */
1104function hash_from_query($query, $keyname)
1105{
1106  $array = array();
1107  $result = pwg_query($query);
1108  while ($row = pwg_db_fetch_assoc($result))
1109  {
1110    $array[ $row[$keyname] ] = $row;
1111  }
1112  return $array;
1113}
1114
1115/**
1116 * Return basename of the current script
1117 * Lower case convertion is applied on return value
1118 * Return value is without file extention ".php"
1119 *
1120 * @param void
1121 *
1122 * @return script basename
1123 */
1124function script_basename()
1125{
1126  global $conf;
1127
1128  foreach (array('SCRIPT_NAME', 'SCRIPT_FILENAME', 'PHP_SELF') as $value)
1129  {
1130    if (!empty($_SERVER[$value]))
1131    {
1132      $filename = strtolower($_SERVER[$value]);
1133      if ($conf['php_extension_in_urls'] and get_extension($filename)!=='php')
1134        continue;
1135      $basename = basename($filename, '.php');
1136      if (!empty($basename))
1137      {
1138        return $basename;
1139      }
1140    }
1141  }
1142  return '';
1143}
1144
1145/**
1146 * Return value for the current page define on $conf['filter_pages']
1147 * Îf value is not defined, default value are returned
1148 *
1149 * @param value name
1150 *
1151 * @return filter page value
1152 */
1153function get_filter_page_value($value_name)
1154{
1155  global $conf;
1156
1157  $page_name = script_basename();
1158
1159  if (isset($conf['filter_pages'][$page_name][$value_name]))
1160  {
1161    return $conf['filter_pages'][$page_name][$value_name];
1162  }
1163  else if (isset($conf['filter_pages']['default'][$value_name]))
1164  {
1165    return $conf['filter_pages']['default'][$value_name];
1166  }
1167  else
1168  {
1169    return null;
1170  }
1171}
1172
1173/**
1174 * returns the character set of data sent to browsers / received from forms
1175 */
1176function get_pwg_charset()
1177{
1178  defined('PWG_CHARSET') or fatal_error('PWG_CHARSET undefined');
1179  return PWG_CHARSET;
1180}
1181
1182/**
1183 * includes a language file or returns the content of a language file
1184 * availability of the file
1185 *
1186 * in descending order of preference:
1187 *   param language, user language, default language
1188 * Piwigo default language.
1189 *
1190 * @param string filename
1191 * @param string dirname
1192 * @param mixed options can contain
1193 *     language - language to load (if empty uses user language)
1194 *     return - if true the file content is returned otherwise the file is evaluated as php
1195 *     target_charset -
1196 *     no_fallback - the language must be respected
1197 * @return boolean success status or a string if options['return'] is true
1198 */
1199function load_language($filename, $dirname = '',
1200    $options = array() )
1201{
1202  global $user;
1203
1204  if (! @$options['return'] )
1205  {
1206    $filename .= '.php'; //MAYBE to do .. load .po and .mo localization files
1207  }
1208  if (empty($dirname))
1209  {
1210    $dirname = PHPWG_ROOT_PATH;
1211  }
1212  $dirname .= 'language/';
1213
1214  $languages = array();
1215  if ( !empty($options['language']) )
1216  {
1217    $languages[] = $options['language'];
1218  }
1219  if ( !empty($user['language']) )
1220  {
1221    $languages[] = $user['language'];
1222  }
1223  if ( ! @$options['no_fallback'] )
1224  {
1225    if ( defined('PHPWG_INSTALLED') )
1226    {
1227      $languages[] = get_default_language();
1228    }
1229    $languages[] = PHPWG_DEFAULT_LANGUAGE;
1230  }
1231
1232  $languages = array_unique($languages);
1233
1234  if ( empty($options['target_charset']) )
1235  {
1236    $target_charset = get_pwg_charset();
1237  }
1238  else
1239  {
1240    $target_charset = $options['target_charset'];
1241  }
1242  $target_charset = strtolower($target_charset);
1243  $source_charset = '';
1244  $source_file    = '';
1245  foreach ($languages as $language)
1246  {
1247    $dir = $dirname.$language;
1248
1249    if ($target_charset!='utf-8')
1250    {
1251      // exact charset match - no conversion required
1252      $f = $dir.'.'.$target_charset.'/'.$filename;
1253      if (file_exists($f))
1254      {
1255        $source_file = $f;
1256        break;
1257      }
1258    }
1259
1260    // UTF-8 ?
1261    $f = $dir.'/'.$filename;
1262    if (file_exists($f))
1263    {
1264      $source_charset = 'utf-8';
1265      $source_file = $f;
1266      break;
1267    }
1268  }
1269
1270  if ( !empty($source_file) )
1271  {
1272    if (! @$options['return'] )
1273    {
1274      @include($source_file);
1275      $load_lang = @$lang;
1276      $load_lang_info = @$lang_info;
1277
1278      global $lang, $lang_info;
1279      if ( !isset($lang) ) $lang=array();
1280      if ( !isset($lang_info) ) $lang_info=array();
1281
1282      if ( !empty($source_charset) and $source_charset!=$target_charset)
1283      {
1284        if ( is_array($load_lang) )
1285        {
1286          foreach ($load_lang as $k => $v)
1287          {
1288            if ( is_array($v) )
1289            {
1290              $func = create_function('$v', 'return convert_charset($v, "'.$source_charset.'","'.$target_charset.'");' );
1291              $lang[$k] = array_map($func, $v);
1292            }
1293            else
1294              $lang[$k] = convert_charset($v, $source_charset, $target_charset);
1295          }
1296        }
1297        if ( is_array($load_lang_info) )
1298        {
1299          foreach ($load_lang_info as $k => $v)
1300          {
1301            $lang_info[$k] = convert_charset($v, $source_charset, $target_charset);
1302          }
1303        }
1304      }
1305      else
1306      {
1307        $lang = array_merge( $lang, (array)$load_lang );
1308        $lang_info = array_merge( $lang_info, (array)$load_lang_info );
1309      }
1310      return true;
1311    }
1312    else
1313    {
1314      $content = @file_get_contents($source_file);
1315      if ( !empty($source_charset) and $source_charset!=$target_charset)
1316      {
1317        $content = convert_charset($content, $source_charset, $target_charset);
1318      }
1319      return $content;
1320    }
1321  }
1322  return false;
1323}
1324
1325/**
1326 * converts a string from a character set to another character set
1327 * @param string str the string to be converted
1328 * @param string source_charset the character set in which the string is encoded
1329 * @param string dest_charset the destination character set
1330 */
1331function convert_charset($str, $source_charset, $dest_charset)
1332{
1333  if ($source_charset==$dest_charset)
1334    return $str;
1335  if ($source_charset=='iso-8859-1' and $dest_charset=='utf-8')
1336  {
1337    return utf8_encode($str);
1338  }
1339  if ($source_charset=='utf-8' and $dest_charset=='iso-8859-1')
1340  {
1341    return utf8_decode($str);
1342  }
1343  if (function_exists('iconv'))
1344  {
1345    return iconv($source_charset, $dest_charset, $str);
1346  }
1347  if (function_exists('mb_convert_encoding'))
1348  {
1349    return mb_convert_encoding( $str, $dest_charset, $source_charset );
1350  }
1351  return $str; //???
1352}
1353
1354/**
1355 * makes sure a index.htm protects the directory from browser file listing
1356 *
1357 * @param string dir directory
1358 */
1359function secure_directory($dir)
1360{
1361  $file = $dir.'/index.htm';
1362  if (!file_exists($file))
1363  {
1364    @file_put_contents($file, 'Not allowed!');
1365  }
1366}
1367
1368/**
1369 * returns a "secret key" that is to be sent back when a user enters a comment
1370 *
1371 * @param int image_id
1372 */
1373function get_comment_post_key($image_id)
1374{
1375  global $conf;
1376
1377  $time = time();
1378
1379  return sprintf(
1380    '%s:%s',
1381    $time,
1382    hash_hmac(
1383      'md5',
1384      $time.':'.$image_id,
1385      $conf['secret_key']
1386      )
1387    );
1388}
1389
1390/**
1391 * return an array which will be sent to template to display navigation bar
1392 */
1393function create_navigation_bar($url, $nb_element, $start, $nb_element_page, $clean_url = false)
1394{
1395  global $conf;
1396
1397  $navbar = array();
1398  $pages_around = $conf['paginate_pages_around'];
1399  $start_str = $clean_url ? '/start-' : (strpos($url, '?')===false ? '?':'&amp;').'start=';
1400
1401  if (!isset($start) or !is_numeric($start) or (is_numeric($start) and $start < 0))
1402  {
1403    $start = 0;
1404  }
1405
1406  // navigation bar useful only if more than one page to display !
1407  if ($nb_element > $nb_element_page)
1408  {
1409    $cur_page = ceil($start / $nb_element_page) + 1;
1410    $maximum = ceil($nb_element / $nb_element_page);
1411    $previous = $start - $nb_element_page;
1412    $next = $start + $nb_element_page;
1413    $last = ($maximum - 1) * $nb_element_page;
1414
1415    $navbar['CURRENT_PAGE'] = $cur_page;
1416
1417    // link to first page and previous page?
1418    if ($cur_page != 1)
1419    {
1420      $navbar['URL_FIRST'] = $url;
1421      $navbar['URL_PREV'] = $url.($previous > 0 ? $start_str.$previous : '');
1422    }
1423    // link on next page and last page?
1424    if ($cur_page != $maximum)
1425    {
1426      $navbar['URL_NEXT'] = $url.$start_str.$next;
1427      $navbar['URL_LAST'] = $url.$start_str.$last;
1428    }
1429
1430    // pages to display
1431    $navbar['pages'] = array();
1432    $navbar['pages'][1] = $url;
1433    $navbar['pages'][$maximum] = $url.$start_str.$last;
1434
1435    for ($i = max($cur_page - $pages_around , 2), $stop = min($cur_page + $pages_around + 1, $maximum);
1436         $i < $stop; $i++)
1437    {
1438      $navbar['pages'][$i] = $url.$start_str.(($i - 1) * $nb_element_page);
1439    }
1440    ksort($navbar['pages']);
1441  }
1442  return $navbar;
1443}
1444
1445/**
1446 * return an array which will be sent to template to display recent icon
1447 */
1448function get_icon($date, $is_child_date = false)
1449{
1450  global $cache, $user;
1451
1452  if (empty($date))
1453  {
1454    return false;
1455  }
1456
1457  if (!isset($cache['get_icon']['title']))
1458  {
1459    $cache['get_icon']['title'] = sprintf(
1460      l10n('images posted during the last %d days'),
1461      $user['recent_period']
1462      );
1463  }
1464
1465  $icon = array(
1466    'TITLE' => $cache['get_icon']['title'],
1467    'IS_CHILD_DATE' => $is_child_date,
1468    );
1469
1470  if (isset($cache['get_icon'][$date]))
1471  {
1472    return $cache['get_icon'][$date] ? $icon : array();
1473  }
1474
1475  if (!isset($cache['get_icon']['sql_recent_date']))
1476  {
1477    // Use MySql date in order to standardize all recent "actions/queries"
1478    $cache['get_icon']['sql_recent_date'] = pwg_db_get_recent_period($user['recent_period']);
1479  }
1480
1481  $cache['get_icon'][$date] = $date > $cache['get_icon']['sql_recent_date'];
1482
1483  return $cache['get_icon'][$date] ? $icon : array();
1484}
1485
1486/**
1487 * check token comming from form posted or get params to prevent csrf attacks
1488 * if pwg_token is empty action doesn't require token
1489 * else pwg_token is compare to server token
1490 *
1491 * @return void access denied if token given is not equal to server token
1492 */
1493function check_pwg_token()
1494{
1495  $valid_token = get_pwg_token();
1496  $given_token = null;
1497
1498  if (!empty($_POST['pwg_token']))
1499  {
1500    $given_token = $_POST['pwg_token'];
1501  }
1502  elseif (!empty($_GET['pwg_token']))
1503  {
1504    $given_token = $_GET['pwg_token'];
1505  }
1506  if ($given_token != $valid_token)
1507  {
1508    access_denied();
1509  }
1510}
1511
1512function get_pwg_token()
1513{
1514  global $conf;
1515
1516  return hash_hmac('md5', session_id(), $conf['secret_key']);
1517}
1518
1519/*
1520 * breaks the script execution if the given value doesn't match the given
1521 * pattern. This should happen only during hacking attempts.
1522 *
1523 * @param string param_name
1524 * @param array param_array
1525 * @param boolean is_array
1526 * @param string pattern
1527 *
1528 * @return void
1529 */
1530function check_input_parameter($param_name, $param_array, $is_array, $pattern)
1531{
1532  $param_value = null;
1533  if (isset($param_array[$param_name]))
1534  {
1535    $param_value = $param_array[$param_name];
1536  }
1537
1538  // it's ok if the input parameter is null
1539  if (empty($param_value))
1540  {
1541    return true;
1542  }
1543
1544  if ($is_array)
1545  {
1546    if (!is_array($param_value))
1547    {
1548      fatal_error('[Hacking attempt] the input parameter "'.$param_name.'" should be an array');
1549    }
1550
1551    foreach ($param_value as $item_to_check)
1552    {
1553      if (!preg_match($pattern, $item_to_check))
1554      {
1555        fatal_error('[Hacking attempt] an item is not valid in input parameter "'.$param_name.'"');
1556      }
1557    }
1558  }
1559  else
1560  {
1561    if (!preg_match($pattern, $param_value))
1562    {
1563      fatal_error('[Hacking attempt] the input parameter "'.$param_name.'" is not valid');
1564    }
1565  }
1566}
1567?>
Note: See TracBrowser for help on using the repository browser.