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

Last change on this file since 23376 was 23372, checked in by mistic100, 11 years ago

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