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

Last change on this file since 29008 was 29008, checked in by mistic100, 10 years ago

feature:2807 better fix for svn:28995
  • Property svn:eol-style set to LF
File size: 49.9 KB
Line 
1<?php
2// +-----------------------------------------------------------------------+
3// | Piwigo - a PHP based photo gallery                                    |
4// +-----------------------------------------------------------------------+
5// | Copyright(C) 2008-2014 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
24/**
25 * @package functions\___
26 */
27
28include_once( PHPWG_ROOT_PATH .'include/functions_plugins.inc.php' );
29include_once( PHPWG_ROOT_PATH .'include/functions_user.inc.php' );
30include_once( PHPWG_ROOT_PATH .'include/functions_cookie.inc.php' );
31include_once( PHPWG_ROOT_PATH .'include/functions_session.inc.php' );
32include_once( PHPWG_ROOT_PATH .'include/functions_category.inc.php' );
33include_once( PHPWG_ROOT_PATH .'include/functions_html.inc.php' );
34include_once( PHPWG_ROOT_PATH .'include/functions_tag.inc.php' );
35include_once( PHPWG_ROOT_PATH .'include/functions_url.inc.php' );
36include_once( PHPWG_ROOT_PATH .'include/derivative_params.inc.php');
37include_once( PHPWG_ROOT_PATH .'include/derivative_std_params.inc.php');
38include_once( PHPWG_ROOT_PATH .'include/derivative.inc.php');
39include_once( PHPWG_ROOT_PATH .'include/template.class.php');
40include_once( PHPWG_ROOT_PATH .'include/cache.class.php');
41
42
43/**
44 * returns the current microsecond since Unix epoch
45 *
46 * @return int
47 */
48function micro_seconds()
49{
50  $t1 = explode(' ', microtime());
51  $t2 = explode('.', $t1[0]);
52  $t2 = $t1[1].substr($t2[1], 0, 6);
53  return $t2;
54}
55
56/**
57 * returns a float value coresponding to the number of seconds since
58 * the unix epoch (1st January 1970) and the microseconds are precised
59 * e.g. 1052343429.89276600
60 *
61 * @return float
62 */
63function get_moment()
64{
65  return microtime(true);
66}
67
68/**
69 * returns the number of seconds (with 3 decimals precision)
70 * between the start time and the end time given
71 *
72 * @param float $start
73 * @param float $end
74 * @return string "$TIME s"
75 */
76function get_elapsed_time($start, $end)
77{
78  return number_format($end - $start, 3, '.', ' ').' s';
79}
80
81/**
82 * returns the part of the string after the last "."
83 *
84 * @param string $filename
85 * @return string
86 */
87function get_extension( $filename )
88{
89  return substr( strrchr( $filename, '.' ), 1, strlen ( $filename ) );
90}
91
92/**
93 * returns the part of the string before the last ".".
94 * get_filename_wo_extension( 'test.tar.gz' ) = 'test.tar'
95 *
96 * @param string $filename
97 * @return string
98 */
99function get_filename_wo_extension( $filename )
100{
101  $pos = strrpos( $filename, '.' );
102  return ($pos===false) ? $filename : substr( $filename, 0, $pos);
103}
104
105/** no option for mkgetdir() */
106define('MKGETDIR_NONE', 0);
107/** sets mkgetdir() recursive */
108define('MKGETDIR_RECURSIVE', 1);
109/** sets mkgetdir() exit script on error */
110define('MKGETDIR_DIE_ON_ERROR', 2);
111/** sets mkgetdir() add a index.htm file */
112define('MKGETDIR_PROTECT_INDEX', 4);
113/** sets mkgetdir() add a .htaccess file*/
114define('MKGETDIR_PROTECT_HTACCESS', 8);
115/** default options for mkgetdir() = MKGETDIR_RECURSIVE | MKGETDIR_DIE_ON_ERROR | MKGETDIR_PROTECT_INDEX */
116define('MKGETDIR_DEFAULT', MKGETDIR_RECURSIVE | MKGETDIR_DIE_ON_ERROR | MKGETDIR_PROTECT_INDEX);
117
118/**
119 * creates directory if not exists and ensures that directory is writable
120 *
121 * @param string $dir
122 * @param int $flags combination of MKGETDIR_xxx
123 * @return bool
124 */
125function mkgetdir($dir, $flags=MKGETDIR_DEFAULT)
126{
127  if ( !is_dir($dir) )
128  {
129    global $conf;
130    if (substr(PHP_OS, 0, 3) == 'WIN')
131    {
132      $dir = str_replace('/', DIRECTORY_SEPARATOR, $dir);
133    }
134    $umask = umask(0);
135    $mkd = @mkdir($dir, $conf['chmod_value'], ($flags&MKGETDIR_RECURSIVE) ? true:false );
136    umask($umask);
137    if ($mkd==false)
138    {
139      !($flags&MKGETDIR_DIE_ON_ERROR) or fatal_error( "$dir ".l10n('no write access'));
140      return false;
141    }
142    if( $flags&MKGETDIR_PROTECT_HTACCESS )
143    {
144      $file = $dir.'/.htaccess';
145      file_exists($file) or @file_put_contents( $file, 'deny from all' );
146    }
147    if( $flags&MKGETDIR_PROTECT_INDEX )
148    {
149      $file = $dir.'/index.htm';
150      file_exists($file) or @file_put_contents( $file, 'Not allowed!' );
151    }
152  }
153  if ( !is_writable($dir) )
154  {
155    !($flags&MKGETDIR_DIE_ON_ERROR) or fatal_error( "$dir ".l10n('no write access'));
156    return false;
157  }
158  return true;
159}
160
161/**
162 * finds out if a string is in ASCII, UTF-8 or other encoding
163 *
164 * @param string $str
165 * @return int *0* if _$str_ is ASCII, *1* if UTF-8, *-1* otherwise
166 */
167function qualify_utf8($Str)
168{
169  $ret = 0;
170  for ($i=0; $i<strlen($Str); $i++)
171  {
172    if (ord($Str[$i]) < 0x80) continue; # 0bbbbbbb
173    $ret = 1;
174    if ((ord($Str[$i]) & 0xE0) == 0xC0) $n=1; # 110bbbbb
175    elseif ((ord($Str[$i]) & 0xF0) == 0xE0) $n=2; # 1110bbbb
176    elseif ((ord($Str[$i]) & 0xF8) == 0xF0) $n=3; # 11110bbb
177    elseif ((ord($Str[$i]) & 0xFC) == 0xF8) $n=4; # 111110bb
178    elseif ((ord($Str[$i]) & 0xFE) == 0xFC) $n=5; # 1111110b
179    else return -1; # Does not match any model
180    for ($j=0; $j<$n; $j++)
181    { # n bytes matching 10bbbbbb follow ?
182      if ((++$i == strlen($Str)) || ((ord($Str[$i]) & 0xC0) != 0x80))
183        return -1;
184    }
185  }
186  return $ret;
187}
188
189/**
190 * Remove accents from a UTF-8 or ISO-8859-1 string (from wordpress)
191 *
192 * @param string $string
193 * @return string
194 */
195function remove_accents($string)
196{
197  $utf = qualify_utf8($string);
198  if ( $utf == 0 )
199  {
200    return $string; // ascii
201  }
202
203  if ( $utf > 0 )
204  {
205    $chars = array(
206    // Decompositions for Latin-1 Supplement
207    "\xc3\x80"=>'A', "\xc3\x81"=>'A',
208    "\xc3\x82"=>'A', "\xc3\x83"=>'A',
209    "\xc3\x84"=>'A', "\xc3\x85"=>'A',
210    "\xc3\x87"=>'C', "\xc3\x88"=>'E',
211    "\xc3\x89"=>'E', "\xc3\x8a"=>'E',
212    "\xc3\x8b"=>'E', "\xc3\x8c"=>'I',
213    "\xc3\x8d"=>'I', "\xc3\x8e"=>'I',
214    "\xc3\x8f"=>'I', "\xc3\x91"=>'N',
215    "\xc3\x92"=>'O', "\xc3\x93"=>'O',
216    "\xc3\x94"=>'O', "\xc3\x95"=>'O',
217    "\xc3\x96"=>'O', "\xc3\x99"=>'U',
218    "\xc3\x9a"=>'U', "\xc3\x9b"=>'U',
219    "\xc3\x9c"=>'U', "\xc3\x9d"=>'Y',
220    "\xc3\x9f"=>'s', "\xc3\xa0"=>'a',
221    "\xc3\xa1"=>'a', "\xc3\xa2"=>'a',
222    "\xc3\xa3"=>'a', "\xc3\xa4"=>'a',
223    "\xc3\xa5"=>'a', "\xc3\xa7"=>'c',
224    "\xc3\xa8"=>'e', "\xc3\xa9"=>'e',
225    "\xc3\xaa"=>'e', "\xc3\xab"=>'e',
226    "\xc3\xac"=>'i', "\xc3\xad"=>'i',
227    "\xc3\xae"=>'i', "\xc3\xaf"=>'i',
228    "\xc3\xb1"=>'n', "\xc3\xb2"=>'o',
229    "\xc3\xb3"=>'o', "\xc3\xb4"=>'o',
230    "\xc3\xb5"=>'o', "\xc3\xb6"=>'o',
231    "\xc3\xb9"=>'u', "\xc3\xba"=>'u',
232    "\xc3\xbb"=>'u', "\xc3\xbc"=>'u',
233    "\xc3\xbd"=>'y', "\xc3\xbf"=>'y',
234    // Decompositions for Latin Extended-A
235    "\xc4\x80"=>'A', "\xc4\x81"=>'a',
236    "\xc4\x82"=>'A', "\xc4\x83"=>'a',
237    "\xc4\x84"=>'A', "\xc4\x85"=>'a',
238    "\xc4\x86"=>'C', "\xc4\x87"=>'c',
239    "\xc4\x88"=>'C', "\xc4\x89"=>'c',
240    "\xc4\x8a"=>'C', "\xc4\x8b"=>'c',
241    "\xc4\x8c"=>'C', "\xc4\x8d"=>'c',
242    "\xc4\x8e"=>'D', "\xc4\x8f"=>'d',
243    "\xc4\x90"=>'D', "\xc4\x91"=>'d',
244    "\xc4\x92"=>'E', "\xc4\x93"=>'e',
245    "\xc4\x94"=>'E', "\xc4\x95"=>'e',
246    "\xc4\x96"=>'E', "\xc4\x97"=>'e',
247    "\xc4\x98"=>'E', "\xc4\x99"=>'e',
248    "\xc4\x9a"=>'E', "\xc4\x9b"=>'e',
249    "\xc4\x9c"=>'G', "\xc4\x9d"=>'g',
250    "\xc4\x9e"=>'G', "\xc4\x9f"=>'g',
251    "\xc4\xa0"=>'G', "\xc4\xa1"=>'g',
252    "\xc4\xa2"=>'G', "\xc4\xa3"=>'g',
253    "\xc4\xa4"=>'H', "\xc4\xa5"=>'h',
254    "\xc4\xa6"=>'H', "\xc4\xa7"=>'h',
255    "\xc4\xa8"=>'I', "\xc4\xa9"=>'i',
256    "\xc4\xaa"=>'I', "\xc4\xab"=>'i',
257    "\xc4\xac"=>'I', "\xc4\xad"=>'i',
258    "\xc4\xae"=>'I', "\xc4\xaf"=>'i',
259    "\xc4\xb0"=>'I', "\xc4\xb1"=>'i',
260    "\xc4\xb2"=>'IJ', "\xc4\xb3"=>'ij',
261    "\xc4\xb4"=>'J', "\xc4\xb5"=>'j',
262    "\xc4\xb6"=>'K', "\xc4\xb7"=>'k',
263    "\xc4\xb8"=>'k', "\xc4\xb9"=>'L',
264    "\xc4\xba"=>'l', "\xc4\xbb"=>'L',
265    "\xc4\xbc"=>'l', "\xc4\xbd"=>'L',
266    "\xc4\xbe"=>'l', "\xc4\xbf"=>'L',
267    "\xc5\x80"=>'l', "\xc5\x81"=>'L',
268    "\xc5\x82"=>'l', "\xc5\x83"=>'N',
269    "\xc5\x84"=>'n', "\xc5\x85"=>'N',
270    "\xc5\x86"=>'n', "\xc5\x87"=>'N',
271    "\xc5\x88"=>'n', "\xc5\x89"=>'N',
272    "\xc5\x8a"=>'n', "\xc5\x8b"=>'N',
273    "\xc5\x8c"=>'O', "\xc5\x8d"=>'o',
274    "\xc5\x8e"=>'O', "\xc5\x8f"=>'o',
275    "\xc5\x90"=>'O', "\xc5\x91"=>'o',
276    "\xc5\x92"=>'OE', "\xc5\x93"=>'oe',
277    "\xc5\x94"=>'R', "\xc5\x95"=>'r',
278    "\xc5\x96"=>'R', "\xc5\x97"=>'r',
279    "\xc5\x98"=>'R', "\xc5\x99"=>'r',
280    "\xc5\x9a"=>'S', "\xc5\x9b"=>'s',
281    "\xc5\x9c"=>'S', "\xc5\x9d"=>'s',
282    "\xc5\x9e"=>'S', "\xc5\x9f"=>'s',
283    "\xc5\xa0"=>'S', "\xc5\xa1"=>'s',
284    "\xc5\xa2"=>'T', "\xc5\xa3"=>'t',
285    "\xc5\xa4"=>'T', "\xc5\xa5"=>'t',
286    "\xc5\xa6"=>'T', "\xc5\xa7"=>'t',
287    "\xc5\xa8"=>'U', "\xc5\xa9"=>'u',
288    "\xc5\xaa"=>'U', "\xc5\xab"=>'u',
289    "\xc5\xac"=>'U', "\xc5\xad"=>'u',
290    "\xc5\xae"=>'U', "\xc5\xaf"=>'u',
291    "\xc5\xb0"=>'U', "\xc5\xb1"=>'u',
292    "\xc5\xb2"=>'U', "\xc5\xb3"=>'u',
293    "\xc5\xb4"=>'W', "\xc5\xb5"=>'w',
294    "\xc5\xb6"=>'Y', "\xc5\xb7"=>'y',
295    "\xc5\xb8"=>'Y', "\xc5\xb9"=>'Z',
296    "\xc5\xba"=>'z', "\xc5\xbb"=>'Z',
297    "\xc5\xbc"=>'z', "\xc5\xbd"=>'Z',
298    "\xc5\xbe"=>'z', "\xc5\xbf"=>'s',
299    // Decompositions for Latin Extended-B
300    "\xc8\x98"=>'S', "\xc8\x99"=>'s',
301    "\xc8\x9a"=>'T', "\xc8\x9b"=>'t',
302    // Euro Sign
303    "\xe2\x82\xac"=>'E',
304    // GBP (Pound) Sign
305    "\xc2\xa3"=>'');
306
307    $string = strtr($string, $chars);
308  }
309  else
310  {
311    // Assume ISO-8859-1 if not UTF-8
312    $chars['in'] = chr(128).chr(131).chr(138).chr(142).chr(154).chr(158)
313      .chr(159).chr(162).chr(165).chr(181).chr(192).chr(193).chr(194)
314      .chr(195).chr(196).chr(197).chr(199).chr(200).chr(201).chr(202)
315      .chr(203).chr(204).chr(205).chr(206).chr(207).chr(209).chr(210)
316      .chr(211).chr(212).chr(213).chr(214).chr(216).chr(217).chr(218)
317      .chr(219).chr(220).chr(221).chr(224).chr(225).chr(226).chr(227)
318      .chr(228).chr(229).chr(231).chr(232).chr(233).chr(234).chr(235)
319      .chr(236).chr(237).chr(238).chr(239).chr(241).chr(242).chr(243)
320      .chr(244).chr(245).chr(246).chr(248).chr(249).chr(250).chr(251)
321      .chr(252).chr(253).chr(255);
322
323    $chars['out'] = "EfSZszYcYuAAAAAACEEEEIIIINOOOOOOUUUUYaaaaaaceeeeiiiinoooooouuuuyy";
324
325    $string = strtr($string, $chars['in'], $chars['out']);
326    $double_chars['in'] = array(chr(140), chr(156), chr(198), chr(208), chr(222), chr(223), chr(230), chr(240), chr(254));
327    $double_chars['out'] = array('OE', 'oe', 'AE', 'DH', 'TH', 'ss', 'ae', 'dh', 'th');
328    $string = str_replace($double_chars['in'], $double_chars['out'], $string);
329  }
330
331  return $string;
332}
333
334if (function_exists('mb_strtolower') && defined('PWG_CHARSET'))
335{
336  /**
337   * removes accents from a string and converts it to lower case
338   *
339   * @param string $term
340   * @return string
341   */
342  function transliterate($term)
343  {
344    return remove_accents( mb_strtolower($term, PWG_CHARSET) );
345  }
346}
347else
348{
349  /**
350   * @ignore
351   */
352  function transliterate($term)
353  {
354    return remove_accents( strtolower($term) );
355  }
356}
357
358/**
359 * simplify a string to insert it into an URL
360 *
361 * @param string $str
362 * @return string
363 */
364function str2url($str)
365{
366  $str = $safe = transliterate($str);
367  $str = preg_replace('/[^\x80-\xffa-z0-9_\s\'\:\/\[\],-]/','',$str);
368  $str = preg_replace('/[\s\'\:\/\[\],-]+/',' ',trim($str));
369  $res = str_replace(' ','_',$str);
370
371  if (empty($res))
372  {
373    $res = str_replace(' ','_', $safe);
374  }
375
376  return $res;
377}
378
379/**
380 * returns an array with a list of {language_code => language_name}
381 *
382 * @return string[]
383 */
384function get_languages()
385{
386  $query = '
387SELECT id, name
388  FROM '.LANGUAGES_TABLE.'
389  ORDER BY name ASC
390;';
391  $result = pwg_query($query);
392
393  $languages = array();
394  while ($row = pwg_db_fetch_assoc($result))
395  {
396    if (is_dir(PHPWG_ROOT_PATH.'language/'.$row['id']))
397    {
398      $languages[ $row['id'] ] = $row['name'];
399    }
400  }
401
402  return $languages;
403}
404
405/**
406 * log the visit into history table
407 *
408 * @param int $image_id
409 * @param string $image_type
410 * @return bool
411 */
412function pwg_log($image_id = null, $image_type = null)
413{
414  global $conf, $user, $page;
415
416  $do_log = $conf['log'];
417  if (is_admin())
418  {
419    $do_log = $conf['history_admin'];
420  }
421  if (is_a_guest())
422  {
423    $do_log = $conf['history_guest'];
424  }
425
426  $do_log = trigger_change('pwg_log_allowed', $do_log, $image_id, $image_type);
427
428  if (!$do_log)
429  {
430    return false;
431  }
432
433  $tags_string = null;
434  if ('tags'==@$page['section'])
435  {
436    $tags_string = implode(',', $page['tag_ids']);
437  }
438
439  $query = '
440INSERT INTO '.HISTORY_TABLE.'
441  (
442    date,
443    time,
444    user_id,
445    IP,
446    section,
447    category_id,
448    image_id,
449    image_type,
450    tag_ids
451  )
452  VALUES
453  (
454    CURRENT_DATE,
455    CURRENT_TIME,
456    '.$user['id'].',
457    \''.$_SERVER['REMOTE_ADDR'].'\',
458    '.(isset($page['section']) ? "'".$page['section']."'" : 'NULL').',
459    '.(isset($page['category']['id']) ? $page['category']['id'] : 'NULL').',
460    '.(isset($image_id) ? $image_id : 'NULL').',
461    '.(isset($image_type) ? "'".$image_type."'" : 'NULL').',
462    '.(isset($tags_string) ? "'".$tags_string."'" : 'NULL').'
463  )
464;';
465  pwg_query($query);
466
467  return true;
468}
469
470/**
471 * Computes the difference between two dates.
472 * returns a DateInterval object or a stdClass with the same attributes
473 * http://stephenharris.info/date-intervals-in-php-5-2
474 *
475 * @param DateTime $date1
476 * @param DateTime $date2
477 * @return DateInterval|stdClass
478 */
479function dateDiff($date1, $date2)
480{
481  if (version_compare(PHP_VERSION, '5.3.0') >= 0)
482  {
483    return $date1->diff($date2);
484  }
485
486  $diff = new stdClass();
487
488  //Make sure $date1 is ealier
489  $diff->invert = $date2 < $date1;
490  if ($diff->invert)
491  {
492    list($date1, $date2) = array($date2, $date1);
493  }
494
495  //Calculate R values
496  $R = ($date1 <= $date2 ? '+' : '-');
497  $r = ($date1 <= $date2 ? '' : '-');
498
499  //Calculate total days
500  $diff->days = round(abs($date1->format('U') - $date2->format('U'))/86400);
501
502  //A leap year work around - consistent with DateInterval
503  $leap_year = $date1->format('m-d') == '02-29';
504  if ($leap_year)
505  {
506    $date1->modify('-1 day');
507  }
508
509  //Years, months, days, hours
510  $periods = array('years'=>-1, 'months'=>-1, 'days'=>-1, 'hours'=>-1);
511
512  foreach ($periods as $period => &$i)
513  {
514    if ($period == 'days' && $leap_year)
515    {
516      $date1->modify('+1 day');
517    }
518
519    while ($date1 <= $date2 )
520    {
521      $date1->modify('+1 '.$period);
522      $i++;
523    }
524
525    //Reset date and record increments
526    $date1->modify('-1 '.$period);
527  }
528
529  list($diff->y, $diff->m, $diff->d, $diff->h) = array_values($periods);
530
531  //Minutes, seconds
532  $diff->s = round(abs($date1->format('U') - $date2->format('U')));
533  $diff->i = floor($diff->s/60);
534  $diff->s = $diff->s - $diff->i*60;
535
536  return $diff;
537}
538
539/**
540 * converts a string into a DateTime object
541 *
542 * @param int|string timestamp or datetime string
543 * @param string $format input format respecting date() syntax
544 * @return DateTime|false
545 */
546function str2DateTime($original, $format=null)
547{
548  if (empty($original))
549  {
550    return false;
551  }
552 
553  if ($original instanceof DateTime)
554  {
555    return $original;
556  }
557
558  if (!empty($format) && version_compare(PHP_VERSION, '5.3.0') >= 0)// from known date format
559  {
560    return DateTime::createFromFormat('!'.$format, $original); // ! char to reset fields to UNIX epoch
561  }
562  else
563  {
564    $t = trim($original, '0123456789');
565    if (empty($t)) // from timestamp
566    {
567      return new DateTime('@'.$original);
568    }
569    else // from unknown date format (assuming something like Y-m-d H:i:s)
570    {
571      $ymdhms = array();
572      $tok = strtok($original, '- :/');
573      while ($tok !== false)
574      {
575        $ymdhms[] = $tok;
576        $tok = strtok('- :/');
577      }
578
579      if (count($ymdhms)<3) return false;
580      if (!isset($ymdhms[3])) $ymdhms[3] = 0;
581      if (!isset($ymdhms[4])) $ymdhms[4] = 0;
582      if (!isset($ymdhms[5])) $ymdhms[5] = 0;
583
584      $date = new DateTime();
585      $date->setDate($ymdhms[0], $ymdhms[1], $ymdhms[2]);
586      $date->setTime($ymdhms[3], $ymdhms[4], $ymdhms[5]);
587      return $date;
588    }
589  }
590}
591
592/**
593 * returns a formatted and localized date for display
594 *
595 * @param int|string timestamp or datetime string
596 * @param array $show list of components displayed, default is ['day_name', 'day', 'month', 'year']
597 *    THIS PARAMETER IS PLANNED TO CHANGE
598 * @param string $format input format respecting date() syntax
599 * @return string
600 */
601function format_date($original, $show=null, $format=null)
602{
603  global $lang;
604
605  $date = str2DateTime($original, $format);
606
607  if (!$date)
608  {
609    return l10n('N/A');
610  }
611
612  if ($show === null || $show === true)
613  {
614    $show = array('day_name', 'day', 'month', 'year');
615  }
616
617  // TODO use IntlDateFormatter for proper i18n
618
619  $print = '';
620  if (in_array('day_name', $show))
621    $print.= $lang['day'][ $date->format('w') ].' ';
622
623  if (in_array('day', $show))
624    $print.= $date->format('j').' ';
625
626  if (in_array('month', $show))
627    $print.= $lang['month'][ $date->format('n') ].' ';
628
629  if (in_array('year', $show))
630    $print.= $date->format('Y').' ';
631
632  if (in_array('time', $show))
633  {
634    $temp = $date->format('H:i');
635    if ($temp != '00:00')
636    {
637      $print.= $temp.' ';
638    }
639  }
640
641  return trim($print);
642}
643
644/**
645 * Format a "From ... to ..." string from two dates
646 * @param string $from
647 * @param string $to
648 * @param boolean $full
649 * @return string
650 */
651function format_fromto($from, $to, $full=false)
652{
653  $from = str2DateTime($from);
654  $to = str2DateTime($to);
655
656  if ($from->format('Y-m-d') == $to->format('Y-m-d'))
657  {
658    return format_date($from);
659  }
660  else
661  {
662    if ($full || $from->format('Y') != $to->format('Y'))
663    {
664      $from_str = format_date($from);
665    }
666    else if ($from->format('m') != $to->format('m'))
667    {
668      $from_str = format_date($from, array('day_name', 'day', 'month'));
669    }
670    else
671    {
672      $from_str = format_date($from, array('day_name', 'day'));
673    }
674    $to_str = format_date($to);
675
676    return l10n('from %s to %s', $from_str, $to_str);
677  }
678}
679
680/**
681 * Works out the time since the given date
682 *
683 * @param int|string timestamp or datetime string
684 * @param string $stop year,month,week,day,hour,minute,second
685 * @param string $format input format respecting date() syntax
686 * @param bool $with_text append "ago" or "in the future"
687 * @param bool $with_weeks
688 * @return string
689 */
690function time_since($original, $stop='minute', $format=null, $with_text=true, $with_week=true)
691{
692  $date = str2DateTime($original, $format);
693
694  if (!$date)
695  {
696    return l10n('N/A');
697  }
698
699  $now = new DateTime();
700  $diff = dateDiff($now, $date);
701
702  $chunks = array(
703    'year' => $diff->y,
704    'month' => $diff->m,
705    'week' => 0,
706    'day' => $diff->d,
707    'hour' => $diff->h,
708    'minute' => $diff->i,
709    'second' => $diff->s,
710  );
711
712  // DateInterval does not contain the number of weeks
713  if ($with_week)
714  {
715    $chunks['week'] = (int)floor($chunks['day']/7);
716    $chunks['day'] = $chunks['day'] - $chunks['week']*7;
717  }
718
719  $j = array_search($stop, array_keys($chunks));
720
721  $print = ''; $i=0;
722  foreach ($chunks as $name => $value)
723  {
724    if ($value != 0)
725    {
726      $print.= ' '.l10n_dec('%d '.$name, '%d '.$name.'s', $value);
727    }
728    if (!empty($print) && $i >= $j)
729    {
730      break;
731    }
732    $i++;
733  }
734
735  $print = trim($print);
736
737  if ($with_text)
738  {
739    if ($diff->invert)
740    {
741      $print = l10n('%s ago', $print);
742    }
743    else
744    {
745      $print = l10n('%s in the future', $print);
746    }
747  }
748
749  return $print;
750}
751
752/**
753 * transform a date string from a format to another (MySQL to d/M/Y for instance)
754 *
755 * @param string $original
756 * @param string $format_in respecting date() syntax
757 * @param string $format_out respecting date() syntax
758 * @param string $default if _$original_ is empty
759 * @return string
760 */
761function transform_date($original, $format_in, $format_out, $default=null)
762{
763  if (empty($original)) return $default;
764  $date = str2DateTime($original, $format_in);
765  return $date->format($format_out);
766}
767
768/**
769 * append a variable to _$debug_ global
770 *
771 * @param string $string
772 */
773function pwg_debug( $string )
774{
775  global $debug,$t2,$page;
776
777  $now = explode( ' ', microtime() );
778  $now2 = explode( '.', $now[0] );
779  $now2 = $now[1].'.'.$now2[1];
780  $time = number_format( $now2 - $t2, 3, '.', ' ').' s';
781  $debug .= '<p>';
782  $debug.= '['.$time.', ';
783  $debug.= $page['count_queries'].' queries] : '.$string;
784  $debug.= "</p>\n";
785}
786
787/**
788 * Redirects to the given URL (HTTP method).
789 * once this function called, the execution doesn't go further
790 * (presence of an exit() instruction.
791 *
792 * @param string $url
793 * @return void
794 */
795function redirect_http( $url )
796{
797  if (ob_get_length () !== FALSE)
798  {
799    ob_clean();
800  }
801  // default url is on html format
802  $url = html_entity_decode($url);
803  header('Request-URI: '.$url);
804  header('Content-Location: '.$url);
805  header('Location: '.$url);
806  exit();
807}
808
809/**
810 * Redirects to the given URL (HTML method).
811 * once this function called, the execution doesn't go further
812 * (presence of an exit() instruction.
813 *
814 * @param string $url
815 * @param string $msg
816 * @param integer $refresh_time
817 * @return void
818 */
819function redirect_html( $url , $msg = '', $refresh_time = 0)
820{
821  global $user, $template, $lang_info, $conf, $lang, $t2, $page, $debug;
822
823  if (!isset($lang_info) || !isset($template) )
824  {
825    $user = build_user( $conf['guest_id'], true);
826    load_language('common.lang');
827    trigger_notify('loading_lang');
828    load_language('lang', PHPWG_ROOT_PATH.PWG_LOCAL_DIR, array('no_fallback'=>true, 'local'=>true) );
829    $template = new Template(PHPWG_ROOT_PATH.'themes', get_default_theme());
830  }
831        elseif (defined('IN_ADMIN') and IN_ADMIN)
832        {
833                $template = new Template(PHPWG_ROOT_PATH.'themes', get_default_theme());
834        }
835
836  if (empty($msg))
837  {
838    $msg = nl2br(l10n('Redirection...'));
839  }
840
841  $refresh = $refresh_time;
842  $url_link = $url;
843  $title = 'redirection';
844
845  $template->set_filenames( array( 'redirect' => 'redirect.tpl' ) );
846
847  include( PHPWG_ROOT_PATH.'include/page_header.php' );
848
849  $template->set_filenames( array( 'redirect' => 'redirect.tpl' ) );
850  $template->assign('REDIRECT_MSG', $msg);
851
852  $template->parse('redirect');
853
854  include( PHPWG_ROOT_PATH.'include/page_tail.php' );
855
856  exit();
857}
858
859/**
860 * Redirects to the given URL (automatically choose HTTP or HTML method).
861 * once this function called, the execution doesn't go further
862 * (presence of an exit() instruction.
863 *
864 * @param string $url
865 * @param string $msg
866 * @param integer $refresh_time
867 * @return void
868 */
869function redirect( $url , $msg = '', $refresh_time = 0)
870{
871  global $conf;
872
873  // with RefeshTime <> 0, only html must be used
874  if ($conf['default_redirect_method']=='http'
875      and $refresh_time==0
876      and !headers_sent()
877    )
878  {
879    redirect_http($url);
880  }
881  else
882  {
883    redirect_html($url, $msg, $refresh_time);
884  }
885}
886
887/**
888 * returns available themes
889 *
890 * @param bool $show_mobile
891 * @return array
892 */
893function get_pwg_themes($show_mobile=false)
894{
895  global $conf;
896
897  $themes = array();
898
899  $query = '
900SELECT
901    id,
902    name
903  FROM '.THEMES_TABLE.'
904  ORDER BY name ASC
905;';
906  $result = pwg_query($query);
907  while ($row = pwg_db_fetch_assoc($result))
908  {
909    if ($row['id'] == $conf['mobile_theme'])
910    {
911      if (!$show_mobile)
912      {
913        continue;
914      }
915      $row['name'] .= ' ('.l10n('Mobile').')';
916    }
917    if (check_theme_installed($row['id']))
918    {
919      $themes[ $row['id'] ] = $row['name'];
920    }
921  }
922
923  // plugins want remove some themes based on user status maybe?
924  $themes = trigger_change('get_pwg_themes', $themes);
925
926  return $themes;
927}
928
929/**
930 * check if a theme is installed (directory exsists)
931 *
932 * @param string $theme_id
933 * @return bool
934 */
935function check_theme_installed($theme_id)
936{
937  global $conf;
938
939  return file_exists($conf['themes_dir'].'/'.$theme_id.'/'.'themeconf.inc.php');
940}
941
942/**
943 * Transforms an original path to its pwg representative
944 *
945 * @param string $path
946 * @param string $representative_ext
947 * @return string
948 */
949function original_to_representative($path, $representative_ext)
950{
951  $pos = strrpos($path, '/');
952  $path = substr_replace($path, 'pwg_representative/', $pos+1, 0);
953  $pos = strrpos($path, '.');
954  return substr_replace($path, $representative_ext, $pos+1);
955}
956
957/**
958 * get the full path of an image
959 *
960 * @param array $element_info element information from db (at least 'path')
961 * @return string
962 */
963function get_element_path($element_info)
964{
965  $path = $element_info['path'];
966  if ( !url_is_remote($path) )
967  {
968    $path = PHPWG_ROOT_PATH.$path;
969  }
970  return $path;
971}
972
973
974/**
975 * fill the current user caddie with given elements, if not already in caddie
976 *
977 * @param int[] $elements_id
978 */
979function fill_caddie($elements_id)
980{
981  global $user;
982
983  $query = '
984SELECT element_id
985  FROM '.CADDIE_TABLE.'
986  WHERE user_id = '.$user['id'].'
987;';
988  $in_caddie = query2array($query, null, 'element_id');
989
990  $caddiables = array_diff($elements_id, $in_caddie);
991
992  $datas = array();
993
994  foreach ($caddiables as $caddiable)
995  {
996    $datas[] = array(
997      'element_id' => $caddiable,
998      'user_id' => $user['id'],
999      );
1000  }
1001
1002  if (count($caddiables) > 0)
1003  {
1004    mass_inserts(CADDIE_TABLE, array('element_id','user_id'), $datas);
1005  }
1006}
1007
1008/**
1009 * returns the element name from its filename.
1010 * removes file extension and replace underscores by spaces
1011 *
1012 * @param string $filename
1013 * @return string name
1014 */
1015function get_name_from_file($filename)
1016{
1017  return str_replace('_',' ',get_filename_wo_extension($filename));
1018}
1019
1020/**
1021 * translation function.
1022 * returns the corresponding value from _$lang_ if existing else the key is returned
1023 * if more than one parameter is provided sprintf is applied
1024 *
1025 * @param string $key
1026 * @param mixed $args,... optional arguments
1027 * @return string
1028 */
1029function l10n($key)
1030{
1031  global $lang, $conf;
1032
1033  if ( ($val=@$lang[$key]) === null)
1034  {
1035    if ($conf['debug_l10n'] and !isset($lang[$key]) and !empty($key))
1036    {
1037      trigger_error('[l10n] language key "'. $key .'" not defined', E_USER_WARNING);
1038    }
1039    $val = $key;
1040  }
1041
1042  if (func_num_args() > 1)
1043  {
1044    $args = func_get_args();
1045    $val = vsprintf($val, array_slice($args, 1));
1046  }
1047
1048  return $val;
1049}
1050
1051/**
1052 * returns the printf value for strings including %d
1053 * returned value is concorded with decimal value (singular, plural)
1054 *
1055 * @param string $singular_key
1056 * @param string $plural_key
1057 * @param int $decimal
1058 * @return string
1059 */
1060function l10n_dec($singular_key, $plural_key, $decimal)
1061{
1062  global $lang_info;
1063
1064  return
1065    sprintf(
1066      l10n((
1067        (($decimal > 1) or ($decimal == 0 and $lang_info['zero_plural']))
1068          ? $plural_key
1069          : $singular_key
1070        )), $decimal);
1071}
1072
1073/**
1074 * returns a single element to use with l10n_args
1075 *
1076 * @param string $key translation key
1077 * @param mixed $args arguments to use on sprintf($key, args)
1078 *   if args is a array, each values are used on sprintf
1079 * @return string
1080 */
1081function get_l10n_args($key, $args='')
1082{
1083  if (is_array($args))
1084  {
1085    $key_arg = array_merge(array($key), $args);
1086  }
1087  else
1088  {
1089    $key_arg = array($key,  $args);
1090  }
1091  return array('key_args' => $key_arg);
1092}
1093
1094/**
1095 * returns a string formated with l10n elements.
1096 * it is usefull to "prepare" a text and translate it later
1097 * @see get_l10n_args()
1098 *
1099 * @param array $key_args one l10n_args element or array of l10n_args elements
1100 * @param string $sep used when translated elements are concatened
1101 * @return string
1102 */
1103function l10n_args($key_args, $sep = "\n")
1104{
1105  if (is_array($key_args))
1106  {
1107    foreach ($key_args as $key => $element)
1108    {
1109      if (isset($result))
1110      {
1111        $result .= $sep;
1112      }
1113      else
1114      {
1115        $result = '';
1116      }
1117
1118      if ($key === 'key_args')
1119      {
1120        array_unshift($element, l10n(array_shift($element))); // translate the key
1121        $result .= call_user_func_array('sprintf', $element);
1122      }
1123      else
1124      {
1125        $result .= l10n_args($element, $sep);
1126      }
1127    }
1128  }
1129  else
1130  {
1131    fatal_error('l10n_args: Invalid arguments');
1132  }
1133
1134  return $result;
1135}
1136
1137/**
1138 * returns the corresponding value from $themeconf if existing or an empty string
1139 *
1140 * @param string $key
1141 * @return string
1142 */
1143function get_themeconf($key)
1144{
1145  global $template;
1146
1147  return $template->get_themeconf($key);
1148}
1149
1150/**
1151 * Returns webmaster mail address depending on $conf['webmaster_id']
1152 *
1153 * @return string
1154 */
1155function get_webmaster_mail_address()
1156{
1157  global $conf;
1158
1159  $query = '
1160SELECT '.$conf['user_fields']['email'].'
1161  FROM '.USERS_TABLE.'
1162  WHERE '.$conf['user_fields']['id'].' = '.$conf['webmaster_id'].'
1163;';
1164  list($email) = pwg_db_fetch_row(pwg_query($query));
1165
1166  $email = trigger_change('get_webmaster_mail_address', $email);
1167
1168  return $email;
1169}
1170
1171/**
1172 * Add configuration parameters from database to global $conf array
1173 *
1174 * @param string $condition SQL condition
1175 * @return void
1176 */
1177function load_conf_from_db($condition = '')
1178{
1179  global $conf;
1180
1181  $query = '
1182SELECT param, value
1183 FROM '.CONFIG_TABLE.'
1184 '.(!empty($condition) ? 'WHERE '.$condition : '').'
1185;';
1186  $result = pwg_query($query);
1187
1188  if ((pwg_db_num_rows($result) == 0) and !empty($condition))
1189  {
1190    fatal_error('No configuration data');
1191  }
1192
1193  while ($row = pwg_db_fetch_assoc($result))
1194  {
1195    $val = isset($row['value']) ? $row['value'] : '';
1196    // If the field is true or false, the variable is transformed into a boolean value.
1197    if ($val == 'true')
1198    {
1199      $val = true;
1200    }
1201    elseif ($val == 'false')
1202    {
1203      $val = false;
1204    }
1205    $conf[ $row['param'] ] = $val;
1206  }
1207
1208  trigger_notify('load_conf', $condition);
1209}
1210
1211/**
1212 * Add or update a config parameter
1213 *
1214 * @param string $param
1215 * @param string $value
1216 * @param boolean $updateGlobal update global *$conf* variable
1217 * @param callable $parser function to apply to the value before save in database
1218      (eg: serialize, json_encode) will not be applied to *$conf* if *$parser* is *true*
1219 */
1220function conf_update_param($param, $value, $updateGlobal=false, $parser=null)
1221{
1222  if ($parser != null)
1223  {
1224    $dbValue = call_user_func($parser, $value);
1225  }
1226  else if (is_array($value) || is_object($value))
1227  {
1228    $dbValue = addslashes(serialize($value));
1229  }
1230  else
1231  {
1232    $dbValue = boolean_to_string($value);
1233  }
1234
1235  $query = '
1236INSERT INTO
1237  '.CONFIG_TABLE.' (param, value)
1238  VALUES(\''.$param.'\', \''.$dbValue.'\')
1239  ON DUPLICATE KEY UPDATE value = \''.$dbValue.'\'
1240;';
1241
1242  pwg_query($query);
1243
1244  if ($updateGlobal)
1245  {
1246    global $conf;
1247    $conf[$param] = $value;
1248  }
1249}
1250
1251/**
1252 * Delete one or more config parameters
1253 * @since 2.6
1254 *
1255 * @param string|string[] $params
1256 */
1257function conf_delete_param($params)
1258{
1259  global $conf;
1260
1261  if (!is_array($params))
1262  {
1263    $params = array($params);
1264  }
1265  if (empty($params))
1266  {
1267    return;
1268  }
1269
1270  $query = '
1271DELETE FROM '.CONFIG_TABLE.'
1272  WHERE param IN(\''. implode('\',\'', $params) .'\')
1273;';
1274  pwg_query($query);
1275
1276  foreach ($params as $param)
1277  {
1278    unset($conf[$param]);
1279  }
1280}
1281
1282/**
1283 * Apply *unserialize* on a value only if it is a string
1284 * @since 2.7
1285 *
1286 * @param array|string $value
1287 * @return array
1288 */
1289function safe_unserialize($value)
1290{
1291  if (is_string($value))
1292  {
1293    return unserialize($value);
1294  }
1295  return $value;
1296}
1297
1298/**
1299 * Apply *json_decode* on a value only if it is a string
1300 * @since 2.7
1301 *
1302 * @param array|string $value
1303 * @return array
1304 */
1305function safe_json_decode($value)
1306{
1307  if (is_string($value))
1308  {
1309    return json_decode($value, true);
1310  }
1311  return $value;
1312}
1313
1314/**
1315 * Prepends and appends strings at each value of the given array.
1316 *
1317 * @param array $array
1318 * @param string $prepend_str
1319 * @param string $append_str
1320 * @return array
1321 */
1322function prepend_append_array_items($array, $prepend_str, $append_str)
1323{
1324  array_walk(
1325    $array,
1326    create_function('&$s', '$s = "'.$prepend_str.'".$s."'.$append_str.'";')
1327    );
1328
1329  return $array;
1330}
1331
1332/**
1333 * creates an simple hashmap based on a SQL query.
1334 * choose one to be the key, another one to be the value.
1335 * @deprecated 2.6
1336 *
1337 * @param string $query
1338 * @param string $keyname
1339 * @param string $valuename
1340 * @return array
1341 */
1342function simple_hash_from_query($query, $keyname, $valuename)
1343{
1344        return query2array($query, $keyname, $valuename);
1345}
1346
1347/**
1348 * creates an associative array based on a SQL query.
1349 * choose one to be the key
1350 * @deprecated 2.6
1351 *
1352 * @param string $query
1353 * @param string $keyname
1354 * @return array
1355 */
1356function hash_from_query($query, $keyname)
1357{
1358        return query2array($query, $keyname);
1359}
1360
1361/**
1362 * creates a numeric array based on a SQL query.
1363 * if _$fieldname_ is empty the returned value will be an array of arrays
1364 * if _$fieldname_ is provided the returned value will be a one dimension array
1365 * @deprecated 2.6
1366 *
1367 * @param string $query
1368 * @param string $fieldname
1369 * @return array
1370 */
1371function array_from_query($query, $fieldname=false)
1372{
1373  if (false === $fieldname)
1374  {
1375                return query2array($query);
1376  }
1377  else
1378  {
1379                return query2array($query, null, $fieldname);
1380  }
1381}
1382
1383/**
1384 * Return the basename of the current script.
1385 * The lowercase case filename of the current script without extension
1386 *
1387 * @return string
1388 */
1389function script_basename()
1390{
1391  global $conf;
1392
1393  foreach (array('SCRIPT_NAME', 'SCRIPT_FILENAME', 'PHP_SELF') as $value)
1394  {
1395    if (!empty($_SERVER[$value]))
1396    {
1397      $filename = strtolower($_SERVER[$value]);
1398      if ($conf['php_extension_in_urls'] and get_extension($filename)!=='php')
1399        continue;
1400      $basename = basename($filename, '.php');
1401      if (!empty($basename))
1402      {
1403        return $basename;
1404      }
1405    }
1406  }
1407  return '';
1408}
1409
1410/**
1411 * Return $conf['filter_pages'] value for the current page
1412 *
1413 * @param string $value_name
1414 * @return mixed
1415 */
1416function get_filter_page_value($value_name)
1417{
1418  global $conf;
1419
1420  $page_name = script_basename();
1421
1422  if (isset($conf['filter_pages'][$page_name][$value_name]))
1423  {
1424    return $conf['filter_pages'][$page_name][$value_name];
1425  }
1426  elseif (isset($conf['filter_pages']['default'][$value_name]))
1427  {
1428    return $conf['filter_pages']['default'][$value_name];
1429  }
1430  else
1431  {
1432    return null;
1433  }
1434}
1435
1436/**
1437 * return the character set used by Piwigo
1438 * @return string
1439 */
1440function get_pwg_charset()
1441{
1442  $pwg_charset = 'utf-8';
1443  if (defined('PWG_CHARSET'))
1444  {
1445    $pwg_charset = PWG_CHARSET;
1446  }
1447  return $pwg_charset;
1448}
1449
1450/**
1451 * returns the parent (fallback) language of a language.
1452 * if _$lang_id_ is null it applies to the current language
1453 * @since 2.6
1454 *
1455 * @param string $lang_id
1456 * @return string|null
1457 */
1458function get_parent_language($lang_id=null)
1459{
1460  if (empty($lang_id))
1461  {
1462    global $lang_info;
1463    return !empty($lang_info['parent']) ? $lang_info['parent'] : null;
1464  }
1465  else
1466  {
1467    $f = PHPWG_ROOT_PATH.'language/'.$lang_id.'/common.lang.php';
1468    if (file_exists($f))
1469    {
1470      include($f);
1471      return !empty($lang_info['parent']) ? $lang_info['parent'] : null;
1472    }
1473  }
1474  return null;
1475}
1476
1477/**
1478 * includes a language file or returns the content of a language file
1479 *
1480 * tries to load in descending order:
1481 *   param language, user language, default language
1482 *
1483 * @param string $filename
1484 * @param string $dirname
1485 * @param mixed options can contain
1486 *     @option string language - language to load
1487 *     @option bool return - if true the file content is returned
1488 *     @option bool no_fallback - if true do not load default language
1489 *     @option bool|string force_fallback - force pre-loading of another language
1490 *        default language if *true* or specified language
1491 *     @option bool local - if true load file from local directory
1492 * @return boolean|string
1493 */
1494function load_language($filename, $dirname = '', $options = array())
1495{
1496  global $user, $language_files;
1497
1498  // keep trace of plugins loaded files for switch_lang_to() function
1499  if (!empty($dirname) && !empty($filename) && !@$options['return']
1500    && !isset($language_files[$dirname][$filename]))
1501  {
1502    $language_files[$dirname][$filename] = $options;
1503  }
1504
1505  if (!@$options['return'])
1506  {
1507    $filename .= '.php';
1508  }
1509  if (empty($dirname))
1510  {
1511    $dirname = PHPWG_ROOT_PATH;
1512  }
1513  $dirname .= 'language/';
1514
1515  $default_language = defined('PHPWG_INSTALLED') ?
1516      get_default_language() : PHPWG_DEFAULT_LANGUAGE;
1517
1518  // construct list of potential languages
1519  $languages = array();
1520  if (!empty($options['language']))
1521  { // explicit language
1522    $languages[] = $options['language'];
1523  }
1524  if (!empty($user['language']))
1525  { // use language
1526    $languages[] = $user['language'];
1527  }
1528  if (($parent = get_parent_language()) != null)
1529  { // parent language
1530    // this is only for when the "child" language is missing
1531    $languages[] = $parent;
1532  }
1533  if (isset($options['force_fallback']))
1534  { // fallback language
1535    // this is only for when the main language is missing
1536    if ($options['force_fallback'] === true)
1537    {
1538      $options['force_fallback'] = $default_language;
1539    }
1540    $languages[] = $options['force_fallback'];
1541  }
1542  if (!@$options['no_fallback'])
1543  { // default language
1544    $languages[] = $default_language;
1545  }
1546
1547  $languages = array_unique($languages);
1548
1549  // find first existing
1550  $source_file       = '';
1551  $selected_language = '';
1552  foreach ($languages as $language)
1553  {
1554    $f = @$options['local'] ?
1555      $dirname.$language.'.'.$filename:
1556      $dirname.$language.'/'.$filename;
1557
1558    if (file_exists($f))
1559    {
1560      $selected_language = $language;
1561      $source_file = $f;
1562      break;
1563    }
1564  }
1565 
1566  if (!empty($source_file))
1567  {
1568    if (!@$options['return'])
1569    {
1570      // load forced fallback
1571      if (isset($options['force_fallback']) && $options['force_fallback'] != $selected_language)
1572      {
1573        @include(str_replace($selected_language, $options['force_fallback'], $source_file));
1574      }
1575
1576      // load language content
1577      @include($source_file);
1578      $load_lang = @$lang;
1579      $load_lang_info = @$lang_info;
1580
1581      // access already existing values
1582      global $lang, $lang_info;
1583      if (!isset($lang)) $lang = array();
1584      if (!isset($lang_info)) $lang_info = array();
1585
1586      // load parent language content directly in global
1587      if (!empty($load_lang_info['parent']))
1588        $parent_language = $load_lang_info['parent'];
1589      else if (!empty($lang_info['parent']))
1590        $parent_language = $lang_info['parent'];
1591      else 
1592        $parent_language = null;
1593
1594      if (!empty($parent_language) && $parent_language != $selected_language)
1595      {
1596        @include(str_replace($selected_language, $parent_language, $source_file));
1597      }
1598
1599      // merge contents
1600      $lang = array_merge($lang, (array)$load_lang);
1601      $lang_info = array_merge($lang_info, (array)$load_lang_info);
1602      return true;
1603    }
1604    else
1605    {
1606      $content = @file_get_contents($source_file);
1607      //Note: target charset is always utf-8 $content = convert_charset($content, 'utf-8', $target_charset);
1608      return $content;
1609    }
1610  }
1611
1612  return false;
1613}
1614
1615/**
1616 * converts a string from a character set to another character set
1617 *
1618 * @param string $str
1619 * @param string $source_charset
1620 * @param string $dest_charset
1621 */
1622function convert_charset($str, $source_charset, $dest_charset)
1623{
1624  if ($source_charset==$dest_charset)
1625    return $str;
1626  if ($source_charset=='iso-8859-1' and $dest_charset=='utf-8')
1627  {
1628    return utf8_encode($str);
1629  }
1630  if ($source_charset=='utf-8' and $dest_charset=='iso-8859-1')
1631  {
1632    return utf8_decode($str);
1633  }
1634  if (function_exists('iconv'))
1635  {
1636    return iconv($source_charset, $dest_charset, $str);
1637  }
1638  if (function_exists('mb_convert_encoding'))
1639  {
1640    return mb_convert_encoding( $str, $dest_charset, $source_charset );
1641  }
1642  return $str; // TODO
1643}
1644
1645/**
1646 * makes sure a index.htm protects the directory from browser file listing
1647 *
1648 * @param string $dir
1649 */
1650function secure_directory($dir)
1651{
1652  $file = $dir.'/index.htm';
1653  if (!file_exists($file))
1654  {
1655    @file_put_contents($file, 'Not allowed!');
1656  }
1657}
1658
1659/**
1660 * returns a "secret key" that is to be sent back when a user posts a form
1661 *
1662 * @param int $valid_after_seconds - key validity start time from now
1663 * @param string $aditionnal_data_to_hash
1664 * @return string
1665 */
1666function get_ephemeral_key($valid_after_seconds, $aditionnal_data_to_hash = '')
1667{
1668        global $conf;
1669        $time = round(microtime(true), 1);
1670        return $time.':'.$valid_after_seconds.':'
1671                .hash_hmac(
1672                        'md5',
1673                        $time.substr($_SERVER['REMOTE_ADDR'],0,5).$valid_after_seconds.$aditionnal_data_to_hash,
1674                        $conf['secret_key']);
1675}
1676
1677/**
1678 * verify a key sent back with a form
1679 *
1680 * @param string $key
1681 * @param string $aditionnal_data_to_hash
1682 * @return bool
1683 */
1684function verify_ephemeral_key($key, $aditionnal_data_to_hash = '')
1685{
1686        global $conf;
1687        $time = microtime(true);
1688        $key = explode( ':', @$key );
1689        if ( count($key)!=3
1690                or $key[0]>$time-(float)$key[1] // page must have been retrieved more than X sec ago
1691                or $key[0]<$time-3600 // 60 minutes expiration
1692                or hash_hmac(
1693                          'md5', $key[0].substr($_SERVER['REMOTE_ADDR'],0,5).$key[1].$aditionnal_data_to_hash, $conf['secret_key']
1694                        ) != $key[2]
1695          )
1696        {
1697                return false;
1698        }
1699        return true;
1700}
1701
1702/**
1703 * return an array which will be sent to template to display navigation bar
1704 *
1705 * @param string $url base url of all links
1706 * @param int $nb_elements
1707 * @param int $start
1708 * @param int $nb_element_page
1709 * @param bool $clean_url
1710 * @param string $param_name
1711 * @return array
1712 */
1713function create_navigation_bar($url, $nb_element, $start, $nb_element_page, $clean_url = false, $param_name='start')
1714{
1715  global $conf;
1716
1717  $navbar = array();
1718  $pages_around = $conf['paginate_pages_around'];
1719  $start_str = $clean_url ? '/'.$param_name.'-' : (strpos($url, '?')===false ? '?':'&amp;').$param_name.'=';
1720
1721  if (!isset($start) or !is_numeric($start) or (is_numeric($start) and $start < 0))
1722  {
1723    $start = 0;
1724  }
1725
1726  // navigation bar useful only if more than one page to display !
1727  if ($nb_element > $nb_element_page)
1728  {
1729    $url_start = $url.$start_str;
1730
1731    $cur_page = $navbar['CURRENT_PAGE'] = $start / $nb_element_page + 1;
1732    $maximum = ceil($nb_element / $nb_element_page);
1733
1734    $start = $nb_element_page * round( $start / $nb_element_page );
1735    $previous = $start - $nb_element_page;
1736    $next = $start + $nb_element_page;
1737    $last = ($maximum - 1) * $nb_element_page;
1738
1739    // link to first page and previous page?
1740    if ($cur_page != 1)
1741    {
1742      $navbar['URL_FIRST'] = $url;
1743      $navbar['URL_PREV'] = $previous > 0 ? $url_start.$previous : $url;
1744    }
1745    // link on next page and last page?
1746    if ($cur_page != $maximum)
1747    {
1748      $navbar['URL_NEXT'] = $url_start.($next < $last ? $next : $last);
1749      $navbar['URL_LAST'] = $url_start.$last;
1750    }
1751
1752    // pages to display
1753    $navbar['pages'] = array();
1754    $navbar['pages'][1] = $url;
1755    for ($i = max( floor($cur_page) - $pages_around , 2), $stop = min( ceil($cur_page) + $pages_around + 1, $maximum);
1756         $i < $stop; $i++)
1757    {
1758      $navbar['pages'][$i] = $url.$start_str.(($i - 1) * $nb_element_page);
1759    }
1760    $navbar['pages'][$maximum] = $url_start.$last;
1761    $navbar['NB_PAGE']=$maximum;
1762  }
1763  return $navbar;
1764}
1765
1766/**
1767 * return an array which will be sent to template to display recent icon
1768 *
1769 * @param string $date
1770 * @param bool $is_child_date
1771 * @return array
1772 */
1773function get_icon($date, $is_child_date = false)
1774{
1775  global $cache, $user;
1776
1777  if (empty($date))
1778  {
1779    return false;
1780  }
1781
1782  if (!isset($cache['get_icon']['title']))
1783  {
1784    $cache['get_icon']['title'] = l10n(
1785      'photos posted during the last %d days',
1786      $user['recent_period']
1787      );
1788  }
1789
1790  $icon = array(
1791    'TITLE' => $cache['get_icon']['title'],
1792    'IS_CHILD_DATE' => $is_child_date,
1793    );
1794
1795  if (isset($cache['get_icon'][$date]))
1796  {
1797    return $cache['get_icon'][$date] ? $icon : array();
1798  }
1799
1800  if (!isset($cache['get_icon']['sql_recent_date']))
1801  {
1802    // Use MySql date in order to standardize all recent "actions/queries"
1803    $cache['get_icon']['sql_recent_date'] = pwg_db_get_recent_period($user['recent_period']);
1804  }
1805
1806  $cache['get_icon'][$date] = $date > $cache['get_icon']['sql_recent_date'];
1807
1808  return $cache['get_icon'][$date] ? $icon : array();
1809}
1810
1811/**
1812 * check token comming from form posted or get params to prevent csrf attacks.
1813 * if pwg_token is empty action doesn't require token
1814 * else pwg_token is compare to server token
1815 *
1816 * @return void access denied if token given is not equal to server token
1817 */
1818function check_pwg_token()
1819{
1820  if (!empty($_REQUEST['pwg_token']))
1821  {
1822    if (get_pwg_token() != $_REQUEST['pwg_token'])
1823    {
1824      access_denied();
1825    }
1826  }
1827  else
1828  {
1829    bad_request('missing token');
1830  }
1831}
1832
1833/**
1834 * get pwg_token used to prevent csrf attacks
1835 *
1836 * @return string
1837 */
1838function get_pwg_token()
1839{
1840  global $conf;
1841
1842  return hash_hmac('md5', session_id(), $conf['secret_key']);
1843}
1844
1845/*
1846 * breaks the script execution if the given value doesn't match the given
1847 * pattern. This should happen only during hacking attempts.
1848 *
1849 * @param string $param_name
1850 * @param array $param_array
1851 * @param boolean $is_array
1852 * @param string $pattern
1853 * @param boolean $mandatory
1854 */
1855function check_input_parameter($param_name, $param_array, $is_array, $pattern, $mandatory=false)
1856{
1857  $param_value = null;
1858  if (isset($param_array[$param_name]))
1859  {
1860    $param_value = $param_array[$param_name];
1861  }
1862
1863  // it's ok if the input parameter is null
1864  if (empty($param_value))
1865  {
1866    if ($mandatory)
1867    {
1868      fatal_error('[Hacking attempt] the input parameter "'.$param_name.'" is not valid');
1869    }
1870    return true;
1871  }
1872
1873  if ($is_array)
1874  {
1875    if (!is_array($param_value))
1876    {
1877      fatal_error('[Hacking attempt] the input parameter "'.$param_name.'" should be an array');
1878    }
1879
1880    foreach ($param_value as $item_to_check)
1881    {
1882      if (!preg_match($pattern, $item_to_check))
1883      {
1884        fatal_error('[Hacking attempt] an item is not valid in input parameter "'.$param_name.'"');
1885      }
1886    }
1887  }
1888  else
1889  {
1890    if (!preg_match($pattern, $param_value))
1891    {
1892      fatal_error('[Hacking attempt] the input parameter "'.$param_name.'" is not valid');
1893    }
1894  }
1895}
1896
1897/**
1898 * get localized privacy level values
1899 *
1900 * @return string[]
1901 */
1902function get_privacy_level_options()
1903{
1904  global $conf;
1905
1906  $options = array();
1907  $label = '';
1908  foreach (array_reverse($conf['available_permission_levels']) as $level)
1909  {
1910    if (0 == $level)
1911    {
1912      $label = l10n('Everybody');
1913    }
1914    else
1915    {
1916      if (strlen($label))
1917      {
1918        $label .= ', ';
1919      }
1920      $label .= l10n( sprintf('Level %d', $level) );
1921    }
1922    $options[$level] = $label;
1923  }
1924  return $options;
1925}
1926
1927
1928/**
1929 * return the branch from the version. For example version 2.2.4 is for branch 2.2
1930 *
1931 * @param string $version
1932 * @return string
1933 */
1934function get_branch_from_version($version)
1935{
1936  return implode('.', array_slice(explode('.', $version), 0, 2));
1937}
1938
1939/**
1940 * return the device type: mobile, tablet or desktop
1941 *
1942 * @return string
1943 */
1944function get_device()
1945{
1946  $device = pwg_get_session_var('device');
1947
1948  if (is_null($device))
1949  {
1950    include_once(PHPWG_ROOT_PATH.'include/mdetect.php');
1951    $uagent_obj = new uagent_info();
1952    if ($uagent_obj->DetectSmartphone())
1953    {
1954      $device = 'mobile';
1955    }
1956    elseif ($uagent_obj->DetectTierTablet())
1957    {
1958      $device = 'tablet';
1959    }
1960    else
1961    {
1962      $device = 'desktop';
1963    }
1964    pwg_set_session_var('device', $device);
1965  }
1966
1967  return $device;
1968}
1969
1970/**
1971 * return true if mobile theme should be loaded
1972 *
1973 * @return bool
1974 */
1975function mobile_theme()
1976{
1977  global $conf;
1978
1979  if (empty($conf['mobile_theme']))
1980  {
1981    return false;
1982  }
1983
1984  if (isset($_GET['mobile']))
1985  {
1986    $is_mobile_theme = get_boolean($_GET['mobile']);
1987    pwg_set_session_var('mobile_theme', $is_mobile_theme);
1988  }
1989  else
1990  {
1991    $is_mobile_theme = pwg_get_session_var('mobile_theme');
1992  }
1993
1994  if (is_null($is_mobile_theme))
1995  {
1996    $is_mobile_theme = (get_device() == 'mobile');
1997    pwg_set_session_var('mobile_theme', $is_mobile_theme);
1998  }
1999
2000  return $is_mobile_theme;
2001}
2002
2003/**
2004 * check url format
2005 *
2006 * @param string $url
2007 * @return bool
2008 */
2009function url_check_format($url)
2010{
2011  return filter_var($url, FILTER_VALIDATE_URL, FILTER_FLAG_SCHEME_REQUIRED | FILTER_FLAG_HOST_REQUIRED)!==false;
2012}
2013
2014/**
2015 * check email format
2016 *
2017 * @param string $mail_address
2018 * @return bool
2019 */
2020function email_check_format($mail_address)
2021{
2022  return filter_var($mail_address, FILTER_VALIDATE_EMAIL)!==false;
2023}
2024
2025/**
2026 * returns the number of available comments for the connected user
2027 *
2028 * @return int
2029 */
2030function get_nb_available_comments()
2031{
2032  global $user;
2033  if (!isset($user['nb_available_comments']))
2034  {
2035    $where = array();
2036    if ( !is_admin() )
2037      $where[] = 'validated=\'true\'';
2038    $where[] = get_sql_condition_FandF
2039      (
2040        array
2041          (
2042            'forbidden_categories' => 'category_id',
2043            'forbidden_images' => 'ic.image_id'
2044          ),
2045        '', true
2046      );
2047
2048    $query = '
2049SELECT COUNT(DISTINCT(com.id))
2050  FROM '.IMAGE_CATEGORY_TABLE.' AS ic
2051    INNER JOIN '.COMMENTS_TABLE.' AS com
2052    ON ic.image_id = com.image_id
2053  WHERE '.implode('
2054    AND ', $where);
2055    list($user['nb_available_comments']) = pwg_db_fetch_row(pwg_query($query));
2056
2057    single_update(USER_CACHE_TABLE,
2058      array('nb_available_comments'=>$user['nb_available_comments']),
2059      array('user_id'=>$user['id'])
2060      );
2061  }
2062  return $user['nb_available_comments'];
2063}
2064
2065/**
2066 * Compare two versions with version_compare after having converted
2067 * single chars to their decimal values.
2068 * Needed because version_compare does not understand versions like '2.5.c'.
2069 * @since 2.6
2070 *
2071 * @param string $a
2072 * @param string $b
2073 * @param string $op
2074 */
2075function safe_version_compare($a, $b, $op=null)
2076{
2077  $replace_chars = create_function('$m', 'return ord(strtolower($m[1]));');
2078
2079  // add dot before groups of letters (version_compare does the same thing)
2080  $a = preg_replace('#([0-9]+)([a-z]+)#i', '$1.$2', $a);
2081  $b = preg_replace('#([0-9]+)([a-z]+)#i', '$1.$2', $b);
2082
2083  // apply ord() to any single letter
2084  $a = preg_replace_callback('#\b([a-z]{1})\b#i', $replace_chars, $a);
2085  $b = preg_replace_callback('#\b([a-z]{1})\b#i', $replace_chars, $b);
2086
2087  if (empty($op))
2088  {
2089    return version_compare($a, $b);
2090  }
2091  else
2092  {
2093    return version_compare($a, $b, $op);
2094  }
2095}
2096
2097?>
Note: See TracBrowser for help on using the repository browser.