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

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

no longer use of images.tn_ext field any longer
  • Property svn:eol-style set to LF
File size: 42.5 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 ($ymdhms[0] >= 1970 and $ymdhms[1] != 0 and $ymdhms[2] != 0)
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
501  if ($ymdhms[2] != 0)
502  {
503    $formated_date.= ' '.$ymdhms[2];
504  }
505
506  if ($ymdhms[1] != 0)
507  {
508    $formated_date.= ' '.$lang['month'][(int)$ymdhms[1]];
509  }
510 
511  $formated_date.= ' '.$ymdhms[0];
512  if ($show_time and count($ymdhms)>=5 )
513  {
514    $formated_date.= ' '.$ymdhms[3].':'.$ymdhms[4];
515  }
516  return $formated_date;
517}
518
519/**
520 * Works out the time since the entry post, takes a an argument in unix time or datetime
521 */
522function time_since($original, $stop = 'minute')
523{
524  if (!is_int($original))
525  {
526    $ymdhms = array();
527    $tok = strtok($original, '- :');
528    while ($tok !== false)
529    {
530      $ymdhms[] = $tok;
531      $tok = strtok('- :');
532    }
533   
534    if ($ymdhms[0] < 1970) return false;
535    if (!isset($ymdhms[3])) $ymdhms[3] = 12;
536    if (!isset($ymdhms[4])) $ymdhms[4] = 0;
537    if (!isset($ymdhms[5])) $ymdhms[5] = 0;
538    $original = mktime($ymdhms[3],$ymdhms[4],$ymdhms[5],$ymdhms[1],$ymdhms[2],$ymdhms[0]);
539  }
540 
541  // array of time period chunks
542  $chunks = array(
543    'year' => 60 * 60 * 24 * 365,
544    'month' => 60 * 60 * 24 * 30,
545    'week' => 60 * 60 * 24 * 7,
546    'day' => 60 * 60 * 24,
547    'hour' => 60 * 60,
548    'minute' => 60,
549    'second' => 1,
550  );
551 
552  $today = time(); /* Current unix time  */
553  $since = abs($today - $original);
554 
555  $print = null;
556  foreach ($chunks as $name => $seconds)
557  {
558    if (($count = floor($since / $seconds)) != 0)
559    {
560      $print.= l10n_dec('%d '.$name, '%d '.$name.'s', $count);
561      $since-= $count*$seconds;
562    }
563    if (!empty($print) and $chunks[$name] <= $chunks[$stop])
564    {
565      break;
566    }
567  }
568
569  if ($today > $original) 
570  {
571    $print = sprintf(l10n('%s ago'), $print);
572  }
573  else
574  {
575    $print = sprintf(l10n('%s in the future'), $print);
576  }
577 
578  return $print;
579}
580
581function pwg_debug( $string )
582{
583  global $debug,$t2,$page;
584
585  $now = explode( ' ', microtime() );
586  $now2 = explode( '.', $now[0] );
587  $now2 = $now[1].'.'.$now2[1];
588  $time = number_format( $now2 - $t2, 3, '.', ' ').' s';
589  $debug .= '<p>';
590  $debug.= '['.$time.', ';
591  $debug.= $page['count_queries'].' queries] : '.$string;
592  $debug.= "</p>\n";
593}
594
595/**
596 * Redirects to the given URL (HTTP method)
597 *
598 * Note : once this function called, the execution doesn't go further
599 * (presence of an exit() instruction.
600 *
601 * @param string $url
602 * @return void
603 */
604function redirect_http( $url )
605{
606  if (ob_get_length () !== FALSE)
607  {
608    ob_clean();
609  }
610  // default url is on html format
611  $url = html_entity_decode($url);
612  header('Request-URI: '.$url);
613  header('Content-Location: '.$url);
614  header('Location: '.$url);
615  exit();
616}
617
618/**
619 * Redirects to the given URL (HTML method)
620 *
621 * Note : once this function called, the execution doesn't go further
622 * (presence of an exit() instruction.
623 *
624 * @param string $url
625 * @param string $title_msg
626 * @param integer $refreh_time
627 * @return void
628 */
629function redirect_html( $url , $msg = '', $refresh_time = 0)
630{
631  global $user, $template, $lang_info, $conf, $lang, $t2, $page, $debug;
632
633  if (!isset($lang_info) || !isset($template) )
634  {
635    $user = build_user( $conf['guest_id'], true);
636    load_language('common.lang');
637    trigger_action('loading_lang');
638    load_language('lang', PHPWG_ROOT_PATH.PWG_LOCAL_DIR, array('no_fallback'=>true, 'local'=>true) );
639    $template = new Template(PHPWG_ROOT_PATH.'themes', get_default_theme());
640  }
641        elseif (defined('IN_ADMIN') and IN_ADMIN)
642        {
643                $template = new Template(PHPWG_ROOT_PATH.'themes', get_default_theme());
644        }
645
646  if (empty($msg))
647  {
648    $msg = nl2br(l10n('Redirection...'));
649  }
650
651  $refresh = $refresh_time;
652  $url_link = $url;
653  $title = 'redirection';
654
655  $template->set_filenames( array( 'redirect' => 'redirect.tpl' ) );
656
657  include( PHPWG_ROOT_PATH.'include/page_header.php' );
658
659  $template->set_filenames( array( 'redirect' => 'redirect.tpl' ) );
660  $template->assign('REDIRECT_MSG', $msg);
661
662  $template->parse('redirect');
663
664  include( PHPWG_ROOT_PATH.'include/page_tail.php' );
665
666  exit();
667}
668
669/**
670 * Redirects to the given URL (Switch to HTTP method or HTML method)
671 *
672 * Note : once this function called, the execution doesn't go further
673 * (presence of an exit() instruction.
674 *
675 * @param string $url
676 * @param string $title_msg
677 * @param integer $refreh_time
678 * @return void
679 */
680function redirect( $url , $msg = '', $refresh_time = 0)
681{
682  global $conf;
683
684  // with RefeshTime <> 0, only html must be used
685  if ($conf['default_redirect_method']=='http'
686      and $refresh_time==0
687      and !headers_sent()
688    )
689  {
690    redirect_http($url);
691  }
692  else
693  {
694    redirect_html($url, $msg, $refresh_time);
695  }
696}
697
698/**
699 * returns $_SERVER['QUERY_STRING'] whitout keys given in parameters
700 *
701 * @param array $rejects
702 * @param boolean $escape - if true escape & to &amp; (for html)
703 * @returns string
704 */
705function get_query_string_diff($rejects=array(), $escape=true)
706{
707  if (empty($_SERVER['QUERY_STRING']))
708  {
709    return '';
710  }
711
712  $query_string = '';
713
714  $str = $_SERVER['QUERY_STRING'];
715  parse_str($str, $vars);
716
717  $is_first = true;
718  foreach ($vars as $key => $value)
719  {
720    if (!in_array($key, $rejects))
721    {
722      $query_string.= $is_first ? '?' : ($escape ? '&amp;' : '&' );
723      $is_first = false;
724      $query_string.= $key.'='.$value;
725    }
726  }
727
728  return $query_string;
729}
730
731function url_is_remote($url)
732{
733  if ( strncmp($url, 'http://', 7)==0
734    or strncmp($url, 'https://', 8)==0 )
735  {
736    return true;
737  }
738  return false;
739}
740
741/**
742 * returns available themes
743 */
744function get_pwg_themes($show_mobile=false)
745{
746  global $conf;
747
748  $themes = array();
749
750  $query = '
751SELECT
752    id,
753    name
754  FROM '.THEMES_TABLE.'
755  ORDER BY name ASC
756;';
757  $result = pwg_query($query);
758  while ($row = pwg_db_fetch_assoc($result))
759  {
760    if ($row['id'] == $conf['mobile_theme'])
761    {
762      if (!$show_mobile)
763      {
764        continue;
765      }
766      $row['name'] .= ' ('.l10n('Mobile').')';
767    }
768    if (check_theme_installed($row['id']))
769    {
770      $themes[ $row['id'] ] = $row['name'];
771    }
772  }
773
774  // plugins want remove some themes based on user status maybe?
775  $themes = trigger_event('get_pwg_themes', $themes);
776
777  return $themes;
778}
779
780function check_theme_installed($theme_id)
781{
782  global $conf;
783
784  return file_exists($conf['themes_dir'].'/'.$theme_id.'/'.'themeconf.inc.php');
785}
786
787/** Transforms an original path to its pwg representative */
788function original_to_representative($path, $representative_ext)
789{
790  $pos = strrpos($path, '/');
791  $path = substr_replace($path, 'pwg_representative/', $pos+1, 0);
792  $pos = strrpos($path, '.');
793  return substr_replace($path, $representative_ext, $pos+1);
794}
795
796/**
797 * @param element_info array containing element information from db;
798 * at least 'id', 'path' should be present
799 */
800function get_element_path($element_info)
801{
802  $path = $element_info['path'];
803  if ( !url_is_remote($path) )
804  {
805    $path = PHPWG_ROOT_PATH.$path;
806  }
807  return $path;
808}
809
810
811/* Returns the URL of the thumbnail to be displayed. If the element does not
812 * have a thumbnail, the default mime image url is returned. The URL can be
813 * sent to the browser, but not used in the php script.
814 * @param array element_info assoc array containing element info from db
815 * at least 'path' and 'id' should be present
816 */
817function get_thumbnail_url($element_info)
818{
819  return DerivativeImage::thumb_url($element_info);
820}
821
822/**
823 * fill the current user caddie with given elements, if not already in
824 * caddie
825 *
826 * @param array elements_id
827 */
828function fill_caddie($elements_id)
829{
830  global $user;
831
832  $query = '
833SELECT element_id
834  FROM '.CADDIE_TABLE.'
835  WHERE user_id = '.$user['id'].'
836;';
837  $in_caddie = array_from_query($query, 'element_id');
838
839  $caddiables = array_diff($elements_id, $in_caddie);
840
841  $datas = array();
842
843  foreach ($caddiables as $caddiable)
844  {
845    array_push($datas, array('element_id' => $caddiable,
846                             'user_id' => $user['id']));
847  }
848
849  if (count($caddiables) > 0)
850  {
851    mass_inserts(CADDIE_TABLE, array('element_id','user_id'), $datas);
852  }
853}
854
855/**
856 * returns the element name from its filename
857 *
858 * @param string filename
859 * @return string name
860 */
861function get_name_from_file($filename)
862{
863  return str_replace('_',' ',get_filename_wo_extension($filename));
864}
865
866/**
867 * returns the corresponding value from $lang if existing. Else, the key is
868 * returned
869 *
870 * @param string key
871 * @return string
872 */
873function l10n($key)
874{
875  global $lang, $conf;
876
877  if ( ($val=@$lang[$key]) == null)
878  {
879    if ($conf['debug_l10n'] and !isset($lang[$key]) and !empty($key))
880    {
881      trigger_error('[l10n] language key "'.$key.'" is not defined', E_USER_WARNING);
882    }
883    $val = $key;
884  }
885  return $val;
886}
887
888/**
889 * returns the prinft value for strings including %d
890 * return is concorded with decimal value (singular, plural)
891 *
892 * @param singular string key
893 * @param plural string key
894 * @param decimal value
895 * @return string
896 */
897function l10n_dec($singular_fmt_key, $plural_fmt_key, $decimal)
898{
899  global $lang_info;
900
901  return
902    sprintf(
903      l10n((
904        (($decimal > 1) or ($decimal == 0 and $lang_info['zero_plural']))
905          ? $plural_fmt_key
906          : $singular_fmt_key
907        )), $decimal);
908}
909
910/*
911 * returns a single element to use with l10n_args
912 *
913 * @param string key: translation key
914 * @param array/string/../number args:
915 *   arguments to use on sprintf($key, args)
916 *   if args is a array, each values are used on sprintf
917 * @return string
918 */
919function get_l10n_args($key, $args)
920{
921  if (is_array($args))
922  {
923    $key_arg = array_merge(array($key), $args);
924  }
925  else
926  {
927    $key_arg = array($key,  $args);
928  }
929  return array('key_args' => $key_arg);
930}
931
932/*
933 * returns a string with formated with l10n_args elements
934 *
935 * @param element/array $key_args: element or array of l10n_args elements
936 * @param $sep: if $key_args is array,
937 *   separator is used when translated l10n_args elements are concated
938 * @return string
939 */
940function l10n_args($key_args, $sep = "\n")
941{
942  if (is_array($key_args))
943  {
944    foreach ($key_args as $key => $element)
945    {
946      if (isset($result))
947      {
948        $result .= $sep;
949      }
950      else
951      {
952        $result = '';
953      }
954
955      if ($key === 'key_args')
956      {
957        array_unshift($element, l10n(array_shift($element)));
958        $result .= call_user_func_array('sprintf', $element);
959      }
960      else
961      {
962        $result .= l10n_args($element, $sep);
963      }
964    }
965  }
966  else
967  {
968    fatal_error('l10n_args: Invalid arguments');
969  }
970
971  return $result;
972}
973
974/**
975 * returns the corresponding value from $themeconf if existing. Else, the
976 * key is returned
977 *
978 * @param string key
979 * @return string
980 */
981function get_themeconf($key)
982{
983  global $template;
984
985  return $template->get_themeconf($key);
986}
987
988/**
989 * Returns webmaster mail address depending on $conf['webmaster_id']
990 *
991 * @return string
992 */
993function get_webmaster_mail_address()
994{
995  global $conf;
996
997  $query = '
998SELECT '.$conf['user_fields']['email'].'
999  FROM '.USERS_TABLE.'
1000  WHERE '.$conf['user_fields']['id'].' = '.$conf['webmaster_id'].'
1001;';
1002  list($email) = pwg_db_fetch_row(pwg_query($query));
1003
1004  return $email;
1005}
1006
1007/**
1008 * Add configuration parameters from database to global $conf array
1009 *
1010 * @return void
1011 */
1012function load_conf_from_db($condition = '')
1013{
1014  global $conf;
1015
1016  $query = '
1017SELECT param, value
1018 FROM '.CONFIG_TABLE.'
1019 '.(!empty($condition) ? 'WHERE '.$condition : '').'
1020;';
1021  $result = pwg_query($query);
1022
1023  if ((pwg_db_num_rows($result) == 0) and !empty($condition))
1024  {
1025    fatal_error('No configuration data');
1026  }
1027
1028  while ($row = pwg_db_fetch_assoc($result))
1029  {
1030    $val = isset($row['value']) ? $row['value'] : '';
1031    // If the field is true or false, the variable is transformed into a boolean value.
1032    if ($val == 'true')
1033    {
1034      $val = true;
1035    }
1036    elseif ($val == 'false')
1037    {
1038      $val = false;
1039    }
1040    $conf[ $row['param'] ] = $val;
1041  }
1042}
1043
1044function conf_update_param($param, $value)
1045{
1046  $query = '
1047SELECT
1048    param,
1049    value
1050  FROM '.CONFIG_TABLE.'
1051  WHERE param = \''.$param.'\'
1052;';
1053  $params = array_from_query($query, 'param');
1054
1055  if (count($params) == 0)
1056  {
1057    $query = '
1058INSERT
1059  INTO '.CONFIG_TABLE.'
1060  (param, value)
1061  VALUES(\''.$param.'\', \''.$value.'\')
1062;';
1063    pwg_query($query);
1064  }
1065  else
1066  {
1067    $query = '
1068UPDATE '.CONFIG_TABLE.'
1069  SET value = \''.$value.'\'
1070  WHERE param = \''.$param.'\'
1071;';
1072    pwg_query($query);
1073  }
1074}
1075
1076/**
1077 * Prepends and appends a string at each value of the given array.
1078 *
1079 * @param array
1080 * @param string prefix to each array values
1081 * @param string suffix to each array values
1082 */
1083function prepend_append_array_items($array, $prepend_str, $append_str)
1084{
1085  array_walk(
1086    $array,
1087    create_function('&$s', '$s = "'.$prepend_str.'".$s."'.$append_str.'";')
1088    );
1089
1090  return $array;
1091}
1092
1093/**
1094 * creates an hashed based on a query, this function is a very common
1095 * pattern used here. Among the selected columns fetched, choose one to be
1096 * the key, another one to be the value.
1097 *
1098 * @param string $query
1099 * @param string $keyname
1100 * @param string $valuename
1101 * @return array
1102 */
1103function simple_hash_from_query($query, $keyname, $valuename)
1104{
1105  $array = array();
1106
1107  $result = pwg_query($query);
1108  while ($row = pwg_db_fetch_assoc($result))
1109  {
1110    $array[ $row[$keyname] ] = $row[$valuename];
1111  }
1112
1113  return $array;
1114}
1115
1116/**
1117 * creates an hashed based on a query, this function is a very common
1118 * pattern used here. The key is given as parameter, the value is an associative
1119 * array.
1120 *
1121 * @param string $query
1122 * @param string $keyname
1123 * @return array
1124 */
1125function hash_from_query($query, $keyname)
1126{
1127  $array = array();
1128  $result = pwg_query($query);
1129  while ($row = pwg_db_fetch_assoc($result))
1130  {
1131    $array[ $row[$keyname] ] = $row;
1132  }
1133  return $array;
1134}
1135
1136/**
1137 * Return basename of the current script
1138 * Lower case convertion is applied on return value
1139 * Return value is without file extention ".php"
1140 *
1141 * @param void
1142 *
1143 * @return script basename
1144 */
1145function script_basename()
1146{
1147  global $conf;
1148
1149  foreach (array('SCRIPT_NAME', 'SCRIPT_FILENAME', 'PHP_SELF') as $value)
1150  {
1151    if (!empty($_SERVER[$value]))
1152    {
1153      $filename = strtolower($_SERVER[$value]);
1154      if ($conf['php_extension_in_urls'] and get_extension($filename)!=='php')
1155        continue;
1156      $basename = basename($filename, '.php');
1157      if (!empty($basename))
1158      {
1159        return $basename;
1160      }
1161    }
1162  }
1163  return '';
1164}
1165
1166/**
1167 * Return value for the current page define on $conf['filter_pages']
1168 * Îf value is not defined, default value are returned
1169 *
1170 * @param value name
1171 *
1172 * @return filter page value
1173 */
1174function get_filter_page_value($value_name)
1175{
1176  global $conf;
1177
1178  $page_name = script_basename();
1179
1180  if (isset($conf['filter_pages'][$page_name][$value_name]))
1181  {
1182    return $conf['filter_pages'][$page_name][$value_name];
1183  }
1184  else if (isset($conf['filter_pages']['default'][$value_name]))
1185  {
1186    return $conf['filter_pages']['default'][$value_name];
1187  }
1188  else
1189  {
1190    return null;
1191  }
1192}
1193
1194/**
1195 * returns the character set of data sent to browsers / received from forms
1196 */
1197function get_pwg_charset()
1198{
1199  $pwg_charset = 'utf-8';
1200  if (defined('PWG_CHARSET'))
1201  {
1202    $pwg_charset = PWG_CHARSET;
1203  }
1204  return $pwg_charset;
1205}
1206
1207/**
1208 * includes a language file or returns the content of a language file
1209 * availability of the file
1210 *
1211 * in descending order of preference:
1212 *   param language, user language, default language
1213 * Piwigo default language.
1214 *
1215 * @param string filename
1216 * @param string dirname
1217 * @param mixed options can contain
1218 *     language - language to load (if empty uses user language)
1219 *     return - if true the file content is returned otherwise the file is evaluated as php
1220 *     target_charset -
1221 *     no_fallback - the language must be respected
1222 *     local - if true, get local language file
1223 * @return boolean success status or a string if options['return'] is true
1224 */
1225function load_language($filename, $dirname = '',
1226    $options = array() )
1227{
1228  global $user;
1229
1230  if (! @$options['return'] )
1231  {
1232    $filename .= '.php'; //MAYBE to do .. load .po and .mo localization files
1233  }
1234  if (empty($dirname))
1235  {
1236    $dirname = PHPWG_ROOT_PATH;
1237  }
1238  $dirname .= 'language/';
1239
1240  $languages = array();
1241  if ( !empty($options['language']) )
1242  {
1243    $languages[] = $options['language'];
1244  }
1245  if ( !empty($user['language']) )
1246  {
1247    $languages[] = $user['language'];
1248  }
1249  if ( ! @$options['no_fallback'] )
1250  {
1251    if ( defined('PHPWG_INSTALLED') )
1252    {
1253      $languages[] = get_default_language();
1254    }
1255    $languages[] = PHPWG_DEFAULT_LANGUAGE;
1256  }
1257
1258  $languages = array_unique($languages);
1259
1260  if ( empty($options['target_charset']) )
1261  {
1262    $target_charset = get_pwg_charset();
1263  }
1264  else
1265  {
1266    $target_charset = $options['target_charset'];
1267  }
1268  $target_charset = strtolower($target_charset);
1269  $source_file    = '';
1270  foreach ($languages as $language)
1271  {
1272    $f = @$options['local'] ?
1273      $dirname.$language.'.'.$filename:
1274      $dirname.$language.'/'.$filename;
1275
1276    if (file_exists($f))
1277    {
1278      $source_file = $f;
1279      break;
1280    }
1281  }
1282
1283  if ( !empty($source_file) )
1284  {
1285    if (! @$options['return'] )
1286    {
1287      @include($source_file);
1288      $load_lang = @$lang;
1289      $load_lang_info = @$lang_info;
1290
1291      global $lang, $lang_info;
1292      if ( !isset($lang) ) $lang=array();
1293      if ( !isset($lang_info) ) $lang_info=array();
1294
1295      if ( 'utf-8'!=$target_charset)
1296      {
1297        if ( is_array($load_lang) )
1298        {
1299          foreach ($load_lang as $k => $v)
1300          {
1301            if ( is_array($v) )
1302            {
1303              $func = create_function('$v', 'return convert_charset($v, "utf-8", "'.$target_charset.'");' );
1304              $lang[$k] = array_map($func, $v);
1305            }
1306            else
1307              $lang[$k] = convert_charset($v, 'utf-8', $target_charset);
1308          }
1309        }
1310        if ( is_array($load_lang_info) )
1311        {
1312          foreach ($load_lang_info as $k => $v)
1313          {
1314            $lang_info[$k] = convert_charset($v, 'utf-8', $target_charset);
1315          }
1316        }
1317      }
1318      else
1319      {
1320        $lang = array_merge( $lang, (array)$load_lang );
1321        $lang_info = array_merge( $lang_info, (array)$load_lang_info );
1322      }
1323      return true;
1324    }
1325    else
1326    {
1327      $content = @file_get_contents($source_file);
1328      $content = convert_charset($content, 'utf-8', $target_charset);
1329      return $content;
1330    }
1331  }
1332  return false;
1333}
1334
1335/**
1336 * converts a string from a character set to another character set
1337 * @param string str the string to be converted
1338 * @param string source_charset the character set in which the string is encoded
1339 * @param string dest_charset the destination character set
1340 */
1341function convert_charset($str, $source_charset, $dest_charset)
1342{
1343  if ($source_charset==$dest_charset)
1344    return $str;
1345  if ($source_charset=='iso-8859-1' and $dest_charset=='utf-8')
1346  {
1347    return utf8_encode($str);
1348  }
1349  if ($source_charset=='utf-8' and $dest_charset=='iso-8859-1')
1350  {
1351    return utf8_decode($str);
1352  }
1353  if (function_exists('iconv'))
1354  {
1355    return iconv($source_charset, $dest_charset, $str);
1356  }
1357  if (function_exists('mb_convert_encoding'))
1358  {
1359    return mb_convert_encoding( $str, $dest_charset, $source_charset );
1360  }
1361  return $str; //???
1362}
1363
1364/**
1365 * makes sure a index.htm protects the directory from browser file listing
1366 *
1367 * @param string dir directory
1368 */
1369function secure_directory($dir)
1370{
1371  $file = $dir.'/index.htm';
1372  if (!file_exists($file))
1373  {
1374    @file_put_contents($file, 'Not allowed!');
1375  }
1376}
1377
1378/**
1379 * returns a "secret key" that is to be sent back when a user posts a form
1380 *
1381 * @param int valid_after_seconds - key validity start time from now
1382 */
1383function get_ephemeral_key($valid_after_seconds, $aditionnal_data_to_hash = '')
1384{
1385        global $conf;
1386        $time = round(microtime(true), 1);
1387        return $time.':'.$valid_after_seconds.':'
1388                .hash_hmac(
1389                        'md5',
1390                        $time.substr($_SERVER['REMOTE_ADDR'],0,5).$valid_after_seconds.$aditionnal_data_to_hash,
1391                        $conf['secret_key']);
1392}
1393
1394function verify_ephemeral_key($key, $aditionnal_data_to_hash = '')
1395{
1396        global $conf;
1397        $time = microtime(true);
1398        $key = explode( ':', @$key );
1399        if ( count($key)!=3
1400                or $key[0]>$time-(float)$key[1] // page must have been retrieved more than X sec ago
1401                or $key[0]<$time-3600 // 60 minutes expiration
1402                or hash_hmac(
1403                          'md5', $key[0].substr($_SERVER['REMOTE_ADDR'],0,5).$key[1].$aditionnal_data_to_hash, $conf['secret_key']
1404                        ) != $key[2]
1405          )
1406        {
1407                return false;
1408        }
1409        return true;
1410}
1411
1412/**
1413 * return an array which will be sent to template to display navigation bar
1414 */
1415function create_navigation_bar($url, $nb_element, $start, $nb_element_page, $clean_url = false)
1416{
1417  global $conf;
1418
1419  $navbar = array();
1420  $pages_around = $conf['paginate_pages_around'];
1421  $start_str = $clean_url ? '/start-' : (strpos($url, '?')===false ? '?':'&amp;').'start=';
1422
1423  if (!isset($start) or !is_numeric($start) or (is_numeric($start) and $start < 0))
1424  {
1425    $start = 0;
1426  }
1427
1428  // navigation bar useful only if more than one page to display !
1429  if ($nb_element > $nb_element_page)
1430  {
1431    $cur_page = ceil($start / $nb_element_page) + 1;
1432    $maximum = ceil($nb_element / $nb_element_page);
1433    $previous = $start - $nb_element_page;
1434    $next = $start + $nb_element_page;
1435    $last = ($maximum - 1) * $nb_element_page;
1436
1437    $navbar['CURRENT_PAGE'] = $cur_page;
1438
1439    // link to first page and previous page?
1440    if ($cur_page != 1)
1441    {
1442      $navbar['URL_FIRST'] = $url;
1443      $navbar['URL_PREV'] = $url.($previous > 0 ? $start_str.$previous : '');
1444    }
1445    // link on next page and last page?
1446    if ($cur_page != $maximum)
1447    {
1448      $navbar['URL_NEXT'] = $url.$start_str.$next;
1449      $navbar['URL_LAST'] = $url.$start_str.$last;
1450    }
1451
1452    // pages to display
1453    $navbar['pages'] = array();
1454    $navbar['pages'][1] = $url;
1455    $navbar['pages'][$maximum] = $url.$start_str.$last;
1456
1457    for ($i = max($cur_page - $pages_around , 2), $stop = min($cur_page + $pages_around + 1, $maximum);
1458         $i < $stop; $i++)
1459    {
1460      $navbar['pages'][$i] = $url.$start_str.(($i - 1) * $nb_element_page);
1461    }
1462    ksort($navbar['pages']);
1463  }
1464  return $navbar;
1465}
1466
1467/**
1468 * return an array which will be sent to template to display recent icon
1469 */
1470function get_icon($date, $is_child_date = false)
1471{
1472  global $cache, $user;
1473
1474  if (empty($date))
1475  {
1476    return false;
1477  }
1478
1479  if (!isset($cache['get_icon']['title']))
1480  {
1481    $cache['get_icon']['title'] = sprintf(
1482      l10n('photos posted during the last %d days'),
1483      $user['recent_period']
1484      );
1485  }
1486
1487  $icon = array(
1488    'TITLE' => $cache['get_icon']['title'],
1489    'IS_CHILD_DATE' => $is_child_date,
1490    );
1491
1492  if (isset($cache['get_icon'][$date]))
1493  {
1494    return $cache['get_icon'][$date] ? $icon : array();
1495  }
1496
1497  if (!isset($cache['get_icon']['sql_recent_date']))
1498  {
1499    // Use MySql date in order to standardize all recent "actions/queries"
1500    $cache['get_icon']['sql_recent_date'] = pwg_db_get_recent_period($user['recent_period']);
1501  }
1502
1503  $cache['get_icon'][$date] = $date > $cache['get_icon']['sql_recent_date'];
1504
1505  return $cache['get_icon'][$date] ? $icon : array();
1506}
1507
1508/**
1509 * check token comming from form posted or get params to prevent csrf attacks
1510 * if pwg_token is empty action doesn't require token
1511 * else pwg_token is compare to server token
1512 *
1513 * @return void access denied if token given is not equal to server token
1514 */
1515function check_pwg_token()
1516{
1517  if (!empty($_REQUEST['pwg_token']))
1518  {
1519    if (get_pwg_token() != $_REQUEST['pwg_token'])
1520    {
1521      access_denied();
1522    }
1523  }
1524  else
1525    bad_request('missing token');
1526}
1527
1528function get_pwg_token()
1529{
1530  global $conf;
1531
1532  return hash_hmac('md5', session_id(), $conf['secret_key']);
1533}
1534
1535/*
1536 * breaks the script execution if the given value doesn't match the given
1537 * pattern. This should happen only during hacking attempts.
1538 *
1539 * @param string param_name
1540 * @param array param_array
1541 * @param boolean is_array
1542 * @param string pattern
1543 *
1544 * @return void
1545 */
1546function check_input_parameter($param_name, $param_array, $is_array, $pattern)
1547{
1548  $param_value = null;
1549  if (isset($param_array[$param_name]))
1550  {
1551    $param_value = $param_array[$param_name];
1552  }
1553
1554  // it's ok if the input parameter is null
1555  if (empty($param_value))
1556  {
1557    return true;
1558  }
1559
1560  if ($is_array)
1561  {
1562    if (!is_array($param_value))
1563    {
1564      fatal_error('[Hacking attempt] the input parameter "'.$param_name.'" should be an array');
1565    }
1566
1567    foreach ($param_value as $item_to_check)
1568    {
1569      if (!preg_match($pattern, $item_to_check))
1570      {
1571        fatal_error('[Hacking attempt] an item is not valid in input parameter "'.$param_name.'"');
1572      }
1573    }
1574  }
1575  else
1576  {
1577    if (!preg_match($pattern, $param_value))
1578    {
1579      fatal_error('[Hacking attempt] the input parameter "'.$param_name.'" is not valid');
1580    }
1581  }
1582}
1583
1584
1585function get_privacy_level_options()
1586{
1587  global $conf;
1588
1589  $options = array();
1590  foreach (array_reverse($conf['available_permission_levels']) as $level)
1591  {
1592    $label = null;
1593
1594    if (0 == $level)
1595    {
1596      $label = l10n('Everybody');
1597    }
1598    else
1599    {
1600      $labels = array();
1601      $sub_levels = array_reverse($conf['available_permission_levels']);
1602      foreach ($sub_levels as $sub_level)
1603      {
1604        if ($sub_level == 0 or $sub_level < $level)
1605        {
1606          break;
1607        }
1608        array_push(
1609          $labels,
1610          l10n(
1611            sprintf(
1612              'Level %d',
1613              $sub_level
1614              )
1615            )
1616          );
1617      }
1618
1619      $label = implode(', ', $labels);
1620    }
1621    $options[$level] = $label;
1622  }
1623  return $options;
1624}
1625
1626
1627/**
1628 * return the branch from the version. For example version 2.2.4 is for branch 2.2
1629 */
1630function get_branch_from_version($version)
1631{
1632  return implode('.', array_slice(explode('.', $version), 0, 2));
1633}
1634
1635/**
1636 * return the device type: mobile, tablet or desktop
1637 */
1638function get_device()
1639{
1640  $device = pwg_get_session_var('device');
1641
1642  if (is_null($device))
1643  {
1644    include_once(PHPWG_ROOT_PATH.'include/mdetect.php');
1645    $uagent_obj = new uagent_info();
1646    if ($uagent_obj->DetectTierIphone())
1647    {
1648      $device = 'mobile';
1649    }
1650    elseif ($uagent_obj->DetectTierTablet())
1651    {
1652      $device = 'tablet';
1653    }
1654    else
1655    {
1656      $device = 'desktop';
1657    }
1658    pwg_set_session_var('device', $device);
1659  }
1660
1661  return $device;
1662}
1663
1664/**
1665 * return true if mobile theme should be loaded
1666 */
1667function mobile_theme()
1668{
1669  global $conf;
1670
1671  if (empty($conf['mobile_theme']))
1672  {
1673    return false;
1674  }
1675
1676  if (isset($_GET['mobile']))
1677  {
1678    $is_mobile_theme = get_boolean($_GET['mobile']);
1679    pwg_set_session_var('mobile_theme', $is_mobile_theme);
1680    unset($_GET['mobile']);
1681  }
1682  else
1683  {
1684    $is_mobile_theme = pwg_get_session_var('mobile_theme');
1685  }
1686
1687  if (is_null($is_mobile_theme))
1688  {
1689    $is_mobile_theme = (get_device() == 'mobile');
1690    pwg_set_session_var('mobile_theme', $is_mobile_theme);
1691  }
1692
1693  return $is_mobile_theme;
1694}
1695?>
Note: See TracBrowser for help on using the repository browser.