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

Revision 13085, 42.9 KB checked in by mistic100, 8 years ago (diff)

feature 2564: forgot a file in previous commit

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