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

Last change on this file since 23563 was 23384, checked in by rvelices, 11 years ago

smarty 3 - first pass for tests

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