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

Revision 5208, 40.8 KB checked in by patdenice, 10 years ago (diff)

feature 1522: Move local css local files and local language files to local directory.
Add $conftemplate_force_compile to help developpers.

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      $languages[$file] = convert_charset($language_name, $target_charset);
418    }
419  }
420  closedir($dir);
421  @asort($languages);
422
423  return $languages;
424}
425
426function pwg_log($image_id = null, $image_type = null)
427{
428  global $conf, $user, $page;
429
430  $do_log = $conf['log'];
431  if (is_admin())
432  {
433    $do_log = $conf['history_admin'];
434  }
435  if (is_a_guest())
436  {
437    $do_log = $conf['history_guest'];
438  }
439
440  $do_log = trigger_event('pwg_log_allowed', $do_log, $image_id, $image_type);
441
442  if (!$do_log)
443  {
444    return false;
445  }
446
447  $tags_string = null;
448  if ('tags'==@$page['section'])
449  {
450    $tags_string = implode(',', $page['tag_ids']);
451  }
452
453  $query = '
454INSERT INTO '.HISTORY_TABLE.'
455  (
456    date,
457    time,
458    user_id,
459    IP,
460    section,
461    category_id,
462    image_id,
463    image_type,
464    tag_ids
465  )
466  VALUES
467  (
468    CURRENT_DATE,
469    CURRENT_TIME,
470    '.$user['id'].',
471    \''.$_SERVER['REMOTE_ADDR'].'\',
472    '.(isset($page['section']) ? "'".$page['section']."'" : 'NULL').',
473    '.(isset($page['category']['id']) ? $page['category']['id'] : 'NULL').',
474    '.(isset($image_id) ? $image_id : 'NULL').',
475    '.(isset($image_type) ? "'".$image_type."'" : 'NULL').',
476    '.(isset($tags_string) ? "'".$tags_string."'" : 'NULL').'
477  )
478;';
479  pwg_query($query);
480
481  return true;
482}
483
484// format_date returns a formatted date for display. The date given in
485// argument must be an american format (2003-09-15). By option, you can show the time.
486// The output is internationalized.
487//
488// format_date( "2003-09-15", true ) -> "Monday 15 September 2003 21:52"
489function format_date($date, $show_time = false)
490{
491  global $lang;
492
493  if (strpos($date, '0') == 0)
494  {
495    return l10n('N/A');
496  }
497
498  $ymdhms = array();
499  $tok = strtok( $date, '- :');
500  while ($tok !== false)
501  {
502    $ymdhms[] = $tok;
503    $tok = strtok('- :');
504  }
505
506  if ( count($ymdhms)<3 )
507  {
508    return false;
509  }
510
511  $formated_date = '';
512  // before 1970, Microsoft Windows can't mktime
513  if ($ymdhms[0] >= 1970)
514  {
515    // we ask midday because Windows think it's prior to midnight with a
516    // zero and refuse to work
517    $formated_date.= $lang['day'][date('w', mktime(12,0,0,$ymdhms[1],$ymdhms[2],$ymdhms[0]))];
518  }
519  $formated_date.= ' '.$ymdhms[2];
520  $formated_date.= ' '.$lang['month'][(int)$ymdhms[1]];
521  $formated_date.= ' '.$ymdhms[0];
522  if ($show_time and count($ymdhms)>=5 )
523  {
524    $formated_date.= ' '.$ymdhms[3].':'.$ymdhms[4];
525  }
526  return $formated_date;
527}
528
529function pwg_debug( $string )
530{
531  global $debug,$t2,$page;
532
533  $now = explode( ' ', microtime() );
534  $now2 = explode( '.', $now[0] );
535  $now2 = $now[1].'.'.$now2[1];
536  $time = number_format( $now2 - $t2, 3, '.', ' ').' s';
537  $debug .= '<p>';
538  $debug.= '['.$time.', ';
539  $debug.= $page['count_queries'].' queries] : '.$string;
540  $debug.= "</p>\n";
541}
542
543/**
544 * Redirects to the given URL (HTTP method)
545 *
546 * Note : once this function called, the execution doesn't go further
547 * (presence of an exit() instruction.
548 *
549 * @param string $url
550 * @return void
551 */
552function redirect_http( $url )
553{
554  if (ob_get_length () !== FALSE)
555  {
556    ob_clean();
557  }
558  // default url is on html format
559  $url = html_entity_decode($url);
560  header('Request-URI: '.$url);
561  header('Content-Location: '.$url);
562  header('Location: '.$url);
563  exit();
564}
565
566/**
567 * Redirects to the given URL (HTML method)
568 *
569 * Note : once this function called, the execution doesn't go further
570 * (presence of an exit() instruction.
571 *
572 * @param string $url
573 * @param string $title_msg
574 * @param integer $refreh_time
575 * @return void
576 */
577function redirect_html( $url , $msg = '', $refresh_time = 0)
578{
579  global $user, $template, $lang_info, $conf, $lang, $t2, $page, $debug;
580
581  if (!isset($lang_info))
582  {
583    $user = build_user( $conf['guest_id'], true);
584    load_language('common.lang');
585    trigger_action('loading_lang');
586    load_language('lang', PHPWG_ROOT_PATH.'local/', array('no_fallback'=>true, 'local'=>true) );
587    $template = new Template(PHPWG_ROOT_PATH.'themes', get_default_theme());
588  }
589  else
590  {
591    $template = new Template(PHPWG_ROOT_PATH.'themes', $user['theme']);
592  }
593
594  if (empty($msg))
595  {
596    $msg = nl2br(l10n('Redirection...'));
597  }
598
599  $refresh = $refresh_time;
600  $url_link = $url;
601  $title = 'redirection';
602
603  $template->set_filenames( array( 'redirect' => 'redirect.tpl' ) );
604
605  include( PHPWG_ROOT_PATH.'include/page_header.php' );
606
607  $template->set_filenames( array( 'redirect' => 'redirect.tpl' ) );
608  $template->assign('REDIRECT_MSG', $msg);
609
610  $template->parse('redirect');
611
612  include( PHPWG_ROOT_PATH.'include/page_tail.php' );
613
614  exit();
615}
616
617/**
618 * Redirects to the given URL (Switch to HTTP method or HTML method)
619 *
620 * Note : once this function called, the execution doesn't go further
621 * (presence of an exit() instruction.
622 *
623 * @param string $url
624 * @param string $title_msg
625 * @param integer $refreh_time
626 * @return void
627 */
628function redirect( $url , $msg = '', $refresh_time = 0)
629{
630  global $conf;
631
632  // with RefeshTime <> 0, only html must be used
633  if ($conf['default_redirect_method']=='http'
634      and $refresh_time==0
635      and !headers_sent()
636    )
637  {
638    redirect_http($url);
639  }
640  else
641  {
642    redirect_html($url, $msg, $refresh_time);
643  }
644}
645
646/**
647 * returns $_SERVER['QUERY_STRING'] whitout keys given in parameters
648 *
649 * @param array $rejects
650 * @param boolean $escape - if true escape & to &amp; (for html)
651 * @returns string
652 */
653function get_query_string_diff($rejects=array(), $escape=true)
654{
655  $query_string = '';
656
657  $str = $_SERVER['QUERY_STRING'];
658  parse_str($str, $vars);
659
660  $is_first = true;
661  foreach ($vars as $key => $value)
662  {
663    if (!in_array($key, $rejects))
664    {
665      $query_string.= $is_first ? '?' : ($escape ? '&amp;' : '&' );
666      $is_first = false;
667      $query_string.= $key.'='.$value;
668    }
669  }
670
671  return $query_string;
672}
673
674function url_is_remote($url)
675{
676  if ( strncmp($url, 'http://', 7)==0
677    or strncmp($url, 'https://', 8)==0 )
678  {
679    return true;
680  }
681  return false;
682}
683
684/**
685 * returns available themes
686 */
687function get_pwg_themes()
688{
689  $themes = array();
690
691  $query = '
692SELECT
693    id,
694    name
695  FROM '.THEMES_TABLE.'
696  ORDER BY name ASC
697;';
698  $result = pwg_query($query);
699  while ($row = pwg_db_fetch_assoc($result))
700  {
701    $themes[ $row['id'] ] = $row['name'];
702  }
703
704  // plugins want remove some themes based on user status maybe?
705  $themes = trigger_event('get_pwg_themes', $themes);
706
707  return $themes;
708}
709
710/* Returns the PATH to the thumbnail to be displayed. If the element does not
711 * have a thumbnail, the default mime image path is returned. The PATH can be
712 * used in the php script, but not sent to the browser.
713 * @param array element_info assoc array containing element info from db
714 * at least 'path', 'tn_ext' and 'id' should be present
715 */
716function get_thumbnail_path($element_info)
717{
718  $path = get_thumbnail_location($element_info);
719  if ( !url_is_remote($path) )
720  {
721    $path = PHPWG_ROOT_PATH.$path;
722  }
723  return $path;
724}
725
726/* Returns the URL of the thumbnail to be displayed. If the element does not
727 * have a thumbnail, the default mime image url is returned. The URL can be
728 * sent to the browser, but not used in the php script.
729 * @param array element_info assoc array containing element info from db
730 * at least 'path', 'tn_ext' and 'id' should be present
731 */
732function get_thumbnail_url($element_info)
733{
734  $path = get_thumbnail_location($element_info);
735  if ( !url_is_remote($path) )
736  {
737    $path = embellish_url(get_root_url().$path);
738  }
739
740  // plugins want another url ?
741  $path = trigger_event('get_thumbnail_url', $path, $element_info);
742  return $path;
743}
744
745/* returns the relative path of the thumnail with regards to to the root
746of piwigo (not the current page!).This function is not intended to be
747called directly from code.*/
748function get_thumbnail_location($element_info)
749{
750  global $conf;
751  if ( !empty( $element_info['tn_ext'] ) )
752  {
753    $path = substr_replace(
754      get_filename_wo_extension($element_info['path']),
755      '/'.$conf['dir_thumbnail'].'/'.$conf['prefix_thumbnail'],
756      strrpos($element_info['path'],'/'),
757      1
758      );
759    $path.= '.'.$element_info['tn_ext'];
760  }
761  else
762  {
763    $path = get_themeconf('mime_icon_dir')
764        .strtolower(get_extension($element_info['path'])).'.png';
765  }
766
767  // plugins want another location ?
768  $path = trigger_event( 'get_thumbnail_location', $path, $element_info);
769  return $path;
770}
771
772/* returns the title of the thumnail */
773function get_thumbnail_title($element_info)
774{
775  // message in title for the thumbnail
776  if (isset($element_info['file']))
777  {
778    $thumbnail_title = $element_info['file'];
779  }
780  else
781  {
782    $thumbnail_title = '';
783  }
784
785  if (!empty($element_info['filesize']))
786  {
787    $thumbnail_title .= ' : '.sprintf(l10n('%d Kb'), $element_info['filesize']);
788  }
789
790  return $thumbnail_title;
791}
792
793/**
794 * fill the current user caddie with given elements, if not already in
795 * caddie
796 *
797 * @param array elements_id
798 */
799function fill_caddie($elements_id)
800{
801  global $user;
802
803  include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
804
805  $query = '
806SELECT element_id
807  FROM '.CADDIE_TABLE.'
808  WHERE user_id = '.$user['id'].'
809;';
810  $in_caddie = array_from_query($query, 'element_id');
811
812  $caddiables = array_diff($elements_id, $in_caddie);
813
814  $datas = array();
815
816  foreach ($caddiables as $caddiable)
817  {
818    array_push($datas, array('element_id' => $caddiable,
819                             'user_id' => $user['id']));
820  }
821
822  if (count($caddiables) > 0)
823  {
824    mass_inserts(CADDIE_TABLE, array('element_id','user_id'), $datas);
825  }
826}
827
828/**
829 * returns the element name from its filename
830 *
831 * @param string filename
832 * @return string name
833 */
834function get_name_from_file($filename)
835{
836  return str_replace('_',' ',get_filename_wo_extension($filename));
837}
838
839/**
840 * returns the corresponding value from $lang if existing. Else, the key is
841 * returned
842 *
843 * @param string key
844 * @return string
845 */
846function l10n($key, $textdomain='messages')
847{
848  global $lang, $conf;
849
850  if ($conf['debug_l10n'] and !isset($lang[$key]) and !empty($key))
851  {
852    trigger_error('[l10n] language key "'.$key.'" is not defined', E_USER_WARNING);
853  }
854
855  return isset($lang[$key]) ? $lang[$key] : $key;
856}
857
858/**
859 * returns the prinft value for strings including %d
860 * return is concorded with decimal value (singular, plural)
861 *
862 * @param singular string key
863 * @param plural string key
864 * @param decimal value
865 * @return string
866 */
867function l10n_dec($singular_fmt_key, $plural_fmt_key, $decimal)
868{
869  global $lang_info;
870
871  return
872    sprintf(
873      l10n((
874        (($decimal > 1) or ($decimal == 0 and $lang_info['zero_plural']))
875          ? $plural_fmt_key
876          : $singular_fmt_key
877        )), $decimal);
878}
879
880/*
881 * returns a single element to use with l10n_args
882 *
883 * @param string key: translation key
884 * @param array/string/../number args:
885 *   arguments to use on sprintf($key, args)
886 *   if args is a array, each values are used on sprintf
887 * @return string
888 */
889function get_l10n_args($key, $args)
890{
891  if (is_array($args))
892  {
893    $key_arg = array_merge(array($key), $args);
894  }
895  else
896  {
897    $key_arg = array($key,  $args);
898  }
899  return array('key_args' => $key_arg);
900}
901
902/*
903 * returns a string with formated with l10n_args elements
904 *
905 * @param element/array $key_args: element or array of l10n_args elements
906 * @param $sep: if $key_args is array,
907 *   separator is used when translated l10n_args elements are concated
908 * @return string
909 */
910function l10n_args($key_args, $sep = "\n")
911{
912  if (is_array($key_args))
913  {
914    foreach ($key_args as $key => $element)
915    {
916      if (isset($result))
917      {
918        $result .= $sep;
919      }
920      else
921      {
922        $result = '';
923      }
924
925      if ($key === 'key_args')
926      {
927        array_unshift($element, l10n(array_shift($element)));
928        $result .= call_user_func_array('sprintf', $element);
929      }
930      else
931      {
932        $result .= l10n_args($element, $sep);
933      }
934    }
935  }
936  else
937  {
938    fatal_error('l10n_args: Invalid arguments');
939  }
940
941  return $result;
942}
943
944/**
945 * returns the corresponding value from $themeconf if existing. Else, the
946 * key is returned
947 *
948 * @param string key
949 * @return string
950 */
951function get_themeconf($key)
952{
953  global $template;
954
955  return $template->get_themeconf($key);
956}
957
958/**
959 * Returns webmaster mail address depending on $conf['webmaster_id']
960 *
961 * @return string
962 */
963function get_webmaster_mail_address()
964{
965  global $conf;
966
967  $query = '
968SELECT '.$conf['user_fields']['email'].'
969  FROM '.USERS_TABLE.'
970  WHERE '.$conf['user_fields']['id'].' = '.$conf['webmaster_id'].'
971;';
972  list($email) = pwg_db_fetch_row(pwg_query($query));
973
974  return $email;
975}
976
977/**
978 * Add configuration parameters from database to global $conf array
979 *
980 * @return void
981 */
982function load_conf_from_db($condition = '')
983{
984  global $conf;
985
986  $query = '
987SELECT param, value
988 FROM '.CONFIG_TABLE.'
989 '.(!empty($condition) ? 'WHERE '.$condition : '').'
990;';
991  $result = pwg_query($query);
992
993  if ((pwg_db_num_rows($result) == 0) and !empty($condition))
994  {
995    fatal_error('No configuration data');
996  }
997
998  while ($row = pwg_db_fetch_assoc($result))
999  {
1000    $conf[ $row['param'] ] = isset($row['value']) ? $row['value'] : '';
1001
1002    // If the field is true or false, the variable is transformed into a
1003    // boolean value.
1004    if ($conf[$row['param']] == 'true' or $conf[$row['param']] == 'false')
1005    {
1006      $conf[ $row['param'] ] = get_boolean($conf[ $row['param'] ]);
1007    }
1008  }
1009}
1010
1011function conf_update_param($param, $value)
1012{
1013  $query = '
1014DELETE
1015  FROM '.CONFIG_TABLE.'
1016  WHERE param = "'.$param.'"
1017;';
1018  pwg_query($query);
1019
1020  $query = '
1021INSERT
1022  INTO '.CONFIG_TABLE.'
1023  SET param = "'.$param.'"
1024    , value = "'.$value.'"
1025;';
1026  pwg_query($query);
1027}
1028
1029/**
1030 * Prepends and appends a string at each value of the given array.
1031 *
1032 * @param array
1033 * @param string prefix to each array values
1034 * @param string suffix to each array values
1035 */
1036function prepend_append_array_items($array, $prepend_str, $append_str)
1037{
1038  array_walk(
1039    $array,
1040    create_function('&$s', '$s = "'.$prepend_str.'".$s."'.$append_str.'";')
1041    );
1042
1043  return $array;
1044}
1045
1046/**
1047 * creates an hashed based on a query, this function is a very common
1048 * pattern used here. Among the selected columns fetched, choose one to be
1049 * the key, another one to be the value.
1050 *
1051 * @param string $query
1052 * @param string $keyname
1053 * @param string $valuename
1054 * @return array
1055 */
1056function simple_hash_from_query($query, $keyname, $valuename)
1057{
1058  $array = array();
1059
1060  $result = pwg_query($query);
1061  while ($row = pwg_db_fetch_assoc($result))
1062  {
1063    $array[ $row[$keyname] ] = $row[$valuename];
1064  }
1065
1066  return $array;
1067}
1068
1069/**
1070 * creates an hashed based on a query, this function is a very common
1071 * pattern used here. The key is given as parameter, the value is an associative
1072 * array.
1073 *
1074 * @param string $query
1075 * @param string $keyname
1076 * @return array
1077 */
1078function hash_from_query($query, $keyname)
1079{
1080  $array = array();
1081  $result = pwg_query($query);
1082  while ($row = pwg_db_fetch_assoc($result))
1083  {
1084    $array[ $row[$keyname] ] = $row;
1085  }
1086  return $array;
1087}
1088
1089/**
1090 * Return basename of the current script
1091 * Lower case convertion is applied on return value
1092 * Return value is without file extention ".php"
1093 *
1094 * @param void
1095 *
1096 * @return script basename
1097 */
1098function script_basename()
1099{
1100  global $conf;
1101
1102  foreach (array('SCRIPT_NAME', 'SCRIPT_FILENAME', 'PHP_SELF') as $value)
1103  {
1104    if (!empty($_SERVER[$value]))
1105    {
1106      $filename = strtolower($_SERVER[$value]);
1107      if ($conf['php_extension_in_urls'] and get_extension($filename)!=='php')
1108        continue;
1109      $basename = basename($filename, '.php');
1110      if (!empty($basename))
1111      {
1112        return $basename;
1113      }
1114    }
1115  }
1116  return '';
1117}
1118
1119/**
1120 * Return value for the current page define on $conf['filter_pages']
1121 * Îf value is not defined, default value are returned
1122 *
1123 * @param value name
1124 *
1125 * @return filter page value
1126 */
1127function get_filter_page_value($value_name)
1128{
1129  global $conf;
1130
1131  $page_name = script_basename();
1132
1133  if (isset($conf['filter_pages'][$page_name][$value_name]))
1134  {
1135    return $conf['filter_pages'][$page_name][$value_name];
1136  }
1137  else if (isset($conf['filter_pages']['default'][$value_name]))
1138  {
1139    return $conf['filter_pages']['default'][$value_name];
1140  }
1141  else
1142  {
1143    return null;
1144  }
1145}
1146
1147/**
1148 * returns the character set of data sent to browsers / received from forms
1149 */
1150function get_pwg_charset()
1151{
1152  defined('PWG_CHARSET') or fatal_error('PWG_CHARSET undefined');
1153  return PWG_CHARSET;
1154}
1155
1156/**
1157 * includes a language file or returns the content of a language file
1158 * availability of the file
1159 *
1160 * in descending order of preference:
1161 *   param language, user language, default language
1162 * Piwigo default language.
1163 *
1164 * @param string filename
1165 * @param string dirname
1166 * @param mixed options can contain
1167 *     language - language to load (if empty uses user language)
1168 *     return - if true the file content is returned otherwise the file is evaluated as php
1169 *     target_charset -
1170 *     no_fallback - the language must be respected
1171 *     local - if true, get local language file
1172 * @return boolean success status or a string if options['return'] is true
1173 */
1174function load_language($filename, $dirname = '',
1175    $options = array() )
1176{
1177  global $user;
1178
1179  if (! @$options['return'] )
1180  {
1181    $filename .= '.php'; //MAYBE to do .. load .po and .mo localization files
1182  }
1183  if (empty($dirname))
1184  {
1185    $dirname = PHPWG_ROOT_PATH;
1186  }
1187  $dirname .= 'language/';
1188
1189  $languages = array();
1190  if ( !empty($options['language']) )
1191  {
1192    $languages[] = $options['language'];
1193  }
1194  if ( !empty($user['language']) )
1195  {
1196    $languages[] = $user['language'];
1197  }
1198  if ( ! @$options['no_fallback'] )
1199  {
1200    if ( defined('PHPWG_INSTALLED') )
1201    {
1202      $languages[] = get_default_language();
1203    }
1204    $languages[] = PHPWG_DEFAULT_LANGUAGE;
1205  }
1206
1207  $languages = array_unique($languages);
1208
1209  if ( empty($options['target_charset']) )
1210  {
1211    $target_charset = get_pwg_charset();
1212  }
1213  else
1214  {
1215    $target_charset = $options['target_charset'];
1216  }
1217  $target_charset = strtolower($target_charset);
1218  $source_file    = '';
1219  foreach ($languages as $language)
1220  {
1221    $f = @$options['local'] ?
1222      $dirname.$language.'.'.$filename:
1223      $dirname.$language.'/'.$filename;
1224
1225    if (file_exists($f))
1226    {
1227      $source_file = $f;
1228      break;
1229    }
1230  }
1231
1232  if ( !empty($source_file) )
1233  {
1234    if (! @$options['return'] )
1235    {
1236      @include($source_file);
1237      $load_lang = @$lang;
1238      $load_lang_info = @$lang_info;
1239
1240      global $lang, $lang_info;
1241      if ( !isset($lang) ) $lang=array();
1242      if ( !isset($lang_info) ) $lang_info=array();
1243
1244      if ( 'utf-8'!=$target_charset)
1245      {
1246        if ( is_array($load_lang) )
1247        {
1248          foreach ($load_lang as $k => $v)
1249          {
1250            if ( is_array($v) )
1251            {
1252              $func = create_function('$v', 'return convert_charset($v, "'.$target_charset.'");' );
1253              $lang[$k] = array_map($func, $v);
1254            }
1255            else
1256              $lang[$k] = convert_charset($v, $target_charset);
1257          }
1258        }
1259        if ( is_array($load_lang_info) )
1260        {
1261          foreach ($load_lang_info as $k => $v)
1262          {
1263            $lang_info[$k] = convert_charset($v, $target_charset);
1264          }
1265        }
1266      }
1267      else
1268      {
1269        $lang = array_merge( $lang, (array)$load_lang );
1270        $lang_info = array_merge( $lang_info, (array)$load_lang_info );
1271      }
1272      return true;
1273    }
1274    else
1275    {
1276      $content = @file_get_contents($source_file);
1277      $content = convert_charset($content, $target_charset);
1278      return $content;
1279    }
1280  }
1281  return false;
1282}
1283
1284/**
1285 * converts a string from utf-8 character set to another character set
1286 * @param string str the string to be converted
1287 * @param string dest_charset the destination character set
1288 */
1289function convert_charset($str, $dest_charset)
1290{
1291  if ($dest_charset=='utf-8')
1292  {
1293    return $str;
1294  }
1295  if ($dest_charset=='iso-8859-1')
1296  {
1297    return utf8_decode($str);
1298  }
1299  if (function_exists('iconv'))
1300  {
1301    return iconv('utf-8', $dest_charset, $str);
1302  }
1303  if (function_exists('mb_convert_encoding'))
1304  {
1305    return mb_convert_encoding( $str, $dest_charset, 'utf-8' );
1306  }
1307  return $str; //???
1308}
1309
1310/**
1311 * makes sure a index.htm protects the directory from browser file listing
1312 *
1313 * @param string dir directory
1314 */
1315function secure_directory($dir)
1316{
1317  $file = $dir.'/index.htm';
1318  if (!file_exists($file))
1319  {
1320    @file_put_contents($file, 'Not allowed!');
1321  }
1322}
1323
1324/**
1325 * returns a "secret key" that is to be sent back when a user enters a comment
1326 *
1327 * @param int image_id
1328 */
1329function get_comment_post_key($image_id)
1330{
1331  global $conf;
1332
1333  $time = time();
1334
1335  return sprintf(
1336    '%s:%s',
1337    $time,
1338    hash_hmac(
1339      'md5',
1340      $time.':'.$image_id,
1341      $conf['secret_key']
1342      )
1343    );
1344}
1345
1346/**
1347 * return an array which will be sent to template to display navigation bar
1348 */
1349function create_navigation_bar($url, $nb_element, $start, $nb_element_page, $clean_url = false)
1350{
1351  global $conf;
1352
1353  $navbar = array();
1354  $pages_around = $conf['paginate_pages_around'];
1355  $start_str = $clean_url ? '/start-' : (strpos($url, '?')===false ? '?':'&amp;').'start=';
1356
1357  if (!isset($start) or !is_numeric($start) or (is_numeric($start) and $start < 0))
1358  {
1359    $start = 0;
1360  }
1361
1362  // navigation bar useful only if more than one page to display !
1363  if ($nb_element > $nb_element_page)
1364  {
1365    $cur_page = ceil($start / $nb_element_page) + 1;
1366    $maximum = ceil($nb_element / $nb_element_page);
1367    $previous = $start - $nb_element_page;
1368    $next = $start + $nb_element_page;
1369    $last = ($maximum - 1) * $nb_element_page;
1370
1371    $navbar['CURRENT_PAGE'] = $cur_page;
1372
1373    // link to first page and previous page?
1374    if ($cur_page != 1)
1375    {
1376      $navbar['URL_FIRST'] = $url;
1377      $navbar['URL_PREV'] = $url.($previous > 0 ? $start_str.$previous : '');
1378    }
1379    // link on next page and last page?
1380    if ($cur_page != $maximum)
1381    {
1382      $navbar['URL_NEXT'] = $url.$start_str.$next;
1383      $navbar['URL_LAST'] = $url.$start_str.$last;
1384    }
1385
1386    // pages to display
1387    $navbar['pages'] = array();
1388    $navbar['pages'][1] = $url;
1389    $navbar['pages'][$maximum] = $url.$start_str.$last;
1390
1391    for ($i = max($cur_page - $pages_around , 2), $stop = min($cur_page + $pages_around + 1, $maximum);
1392         $i < $stop; $i++)
1393    {
1394      $navbar['pages'][$i] = $url.$start_str.(($i - 1) * $nb_element_page);
1395    }
1396    ksort($navbar['pages']);
1397  }
1398  return $navbar;
1399}
1400
1401/**
1402 * return an array which will be sent to template to display recent icon
1403 */
1404function get_icon($date, $is_child_date = false)
1405{
1406  global $cache, $user;
1407
1408  if (empty($date))
1409  {
1410    return false;
1411  }
1412
1413  if (!isset($cache['get_icon']['title']))
1414  {
1415    $cache['get_icon']['title'] = sprintf(
1416      l10n('images posted during the last %d days'),
1417      $user['recent_period']
1418      );
1419  }
1420
1421  $icon = array(
1422    'TITLE' => $cache['get_icon']['title'],
1423    'IS_CHILD_DATE' => $is_child_date,
1424    );
1425
1426  if (isset($cache['get_icon'][$date]))
1427  {
1428    return $cache['get_icon'][$date] ? $icon : array();
1429  }
1430
1431  if (!isset($cache['get_icon']['sql_recent_date']))
1432  {
1433    // Use MySql date in order to standardize all recent "actions/queries"
1434    $cache['get_icon']['sql_recent_date'] = pwg_db_get_recent_period($user['recent_period']);
1435  }
1436
1437  $cache['get_icon'][$date] = $date > $cache['get_icon']['sql_recent_date'];
1438
1439  return $cache['get_icon'][$date] ? $icon : array();
1440}
1441
1442/**
1443 * check token comming from form posted or get params to prevent csrf attacks
1444 * if pwg_token is empty action doesn't require token
1445 * else pwg_token is compare to server token
1446 *
1447 * @return void access denied if token given is not equal to server token
1448 */
1449function check_pwg_token()
1450{
1451  $valid_token = get_pwg_token();
1452  $given_token = null;
1453
1454  if (!empty($_POST['pwg_token']))
1455  {
1456    $given_token = $_POST['pwg_token'];
1457  }
1458  elseif (!empty($_GET['pwg_token']))
1459  {
1460    $given_token = $_GET['pwg_token'];
1461  }
1462  if ($given_token != $valid_token)
1463  {
1464    access_denied();
1465  }
1466}
1467
1468function get_pwg_token()
1469{
1470  global $conf;
1471
1472  return hash_hmac('md5', session_id(), $conf['secret_key']);
1473}
1474
1475/*
1476 * breaks the script execution if the given value doesn't match the given
1477 * pattern. This should happen only during hacking attempts.
1478 *
1479 * @param string param_name
1480 * @param array param_array
1481 * @param boolean is_array
1482 * @param string pattern
1483 *
1484 * @return void
1485 */
1486function check_input_parameter($param_name, $param_array, $is_array, $pattern)
1487{
1488  $param_value = null;
1489  if (isset($param_array[$param_name]))
1490  {
1491    $param_value = $param_array[$param_name];
1492  }
1493
1494  // it's ok if the input parameter is null
1495  if (empty($param_value))
1496  {
1497    return true;
1498  }
1499
1500  if ($is_array)
1501  {
1502    if (!is_array($param_value))
1503    {
1504      fatal_error('[Hacking attempt] the input parameter "'.$param_name.'" should be an array');
1505    }
1506
1507    foreach ($param_value as $item_to_check)
1508    {
1509      if (!preg_match($pattern, $item_to_check))
1510      {
1511        fatal_error('[Hacking attempt] an item is not valid in input parameter "'.$param_name.'"');
1512      }
1513    }
1514  }
1515  else
1516  {
1517    if (!preg_match($pattern, $param_value))
1518    {
1519      fatal_error('[Hacking attempt] the input parameter "'.$param_name.'" is not valid');
1520    }
1521  }
1522}
1523?>
Note: See TracBrowser for help on using the repository browser.