source: branches/2.1/include/functions.inc.php @ 20958

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

bug 2228 fixed: there should be no blank space in the URL to avoid infinite
loop redirection (this happens with chinese only characters + blank space in
the category name).

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