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

Revision 25812, 48.0 KB checked in by mistic100, 6 years ago (diff)

feature 2999: documentation of Template class, other classes of template.class.php pending

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