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

Last change on this file since 15316 was 15316, checked in by plg, 12 years ago

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