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

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

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