source: trunk/include/functions_user.inc.php @ 8844

Last change on this file since 8844 was 8844, checked in by rvelices, 10 years ago
  • fix icon display on index page (calendar by post date)
  • remove unnecessary include_once
  • mysql functions simplification
  • Property svn:eol-style set to LF
File size: 36.0 KB
Line 
1<?php
2// +-----------------------------------------------------------------------+
3// | Piwigo - a PHP based photo gallery                                    |
4// +-----------------------------------------------------------------------+
5// | Copyright(C) 2008-2011 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// validate_mail_address:
25//   o verifies whether the given mail address has the
26//     right format. ie someone@domain.com "someone" can contain ".", "-" or
27//     even "_". Exactly as "domain". The extension doesn't have to be
28//     "com". The mail address can also be empty.
29//   o check if address could be empty
30//   o check if address is not used by a other user
31// If the mail address doesn't correspond, an error message is returned.
32//
33function validate_mail_address($user_id, $mail_address)
34{
35  global $conf;
36
37  if (empty($mail_address) and
38      !($conf['obligatory_user_mail_address'] and
39      in_array(script_basename(), array('register', 'profile'))))
40  {
41    return '';
42  }
43
44  $atom   = '[-a-z0-9!#$%&\'*+\\/=?^_`{|}~]';   // before  arobase
45  $domain = '([a-z0-9]([-a-z0-9]*[a-z0-9]+)?)'; // domain name
46  $regex = '/^' . $atom . '+' . '(\.' . $atom . '+)*' . '@' . '(' . $domain . '{1,63}\.)+' . $domain . '{2,63}$/i';
47
48  if ( !preg_match( $regex, $mail_address ) )
49  {
50    return l10n('mail address must be like xxx@yyy.eee (example : jack@altern.org)');
51  }
52
53  if (defined("PHPWG_INSTALLED") and !empty($mail_address))
54  {
55    $query = '
56select count(*)
57from '.USERS_TABLE.'
58where upper('.$conf['user_fields']['email'].') = upper(\''.$mail_address.'\')
59'.(is_numeric($user_id) ? 'and '.$conf['user_fields']['id'].' != \''.$user_id.'\'' : '').'
60;';
61    list($count) = pwg_db_fetch_row(pwg_query($query));
62    if ($count != 0)
63    {
64      return l10n('this email address is already in use');
65    }
66  }
67}
68
69// validate_login_case:
70//   o check if login is not used by a other user
71// If the login doesn't correspond, an error message is returned.
72//
73function validate_login_case($login)
74{
75  global $conf;
76 
77  if (defined("PHPWG_INSTALLED"))
78  {
79    $query = "
80SELECT ".$conf['user_fields']['username']."
81FROM ".USERS_TABLE."
82WHERE LOWER(".stripslashes($conf['user_fields']['username']).") = '".strtolower($login)."'
83;";
84
85    $count = pwg_db_num_rows(pwg_query($query));
86
87    if ($count > 0)
88    {
89      return l10n('this login is already used');
90    }
91  }
92}
93
94function register_user($login, $password, $mail_address,
95  $with_notification = true, $errors = array())
96{
97  global $conf;
98
99  if ($login == '')
100  {
101    array_push($errors, l10n('Please, enter a login'));
102  }
103  if (preg_match('/^.* $/', $login))
104  {
105    array_push($errors, l10n('login mustn\'t end with a space character'));
106  }
107  if (preg_match('/^ .*$/', $login))
108  {
109    array_push($errors, l10n('login mustn\'t start with a space character'));
110  }
111  if (get_userid($login))
112  {
113    array_push($errors, l10n('this login is already used'));
114  }
115  $mail_error = validate_mail_address(null, $mail_address);
116  if ('' != $mail_error)
117  {
118    array_push($errors, $mail_error);
119  }
120
121  if ($conf['insensitive_case_logon'] == true)
122  {
123    $login_error = validate_login_case($login);
124    if ($login_error != '')
125    {
126      array_push($errors, $login_error);
127    }
128  }
129
130  $errors = trigger_event('register_user_check',
131              $errors,
132              array(
133                'username'=>$login,
134                'password'=>$password,
135                'email'=>$mail_address,
136              )
137            );
138
139  // if no error until here, registration of the user
140  if (count($errors) == 0)
141  {
142    // what will be the inserted id ?
143    $query = '
144SELECT MAX('.$conf['user_fields']['id'].') + 1
145  FROM '.USERS_TABLE.'
146;';
147    list($next_id) = pwg_db_fetch_row(pwg_query($query));
148
149    $insert =
150      array(
151        $conf['user_fields']['id'] => $next_id,
152        $conf['user_fields']['username'] => pwg_db_real_escape_string($login),
153        $conf['user_fields']['password'] => $conf['pass_convert']($password),
154        $conf['user_fields']['email'] => $mail_address
155        );
156
157    mass_inserts(USERS_TABLE, array_keys($insert), array($insert));
158
159    // Assign by default groups
160    {
161      $query = '
162SELECT id
163  FROM '.GROUPS_TABLE.'
164  WHERE is_default = \''.boolean_to_string(true).'\'
165  ORDER BY id ASC
166;';
167      $result = pwg_query($query);
168
169      $inserts = array();
170      while ($row = pwg_db_fetch_assoc($result))
171      {
172        array_push
173        (
174          $inserts,
175          array
176          (
177            'user_id' => $next_id,
178            'group_id' => $row['id']
179          )
180        );
181      }
182    }
183
184    if (count($inserts) != 0)
185    {
186      mass_inserts(USER_GROUP_TABLE, array('user_id', 'group_id'), $inserts);
187    }
188
189    $override = null;
190    if ($with_notification and $conf['browser_language'])
191    {
192      if ( !get_browser_language($override['language']) )
193        $override=null;
194    }
195    create_user_infos($next_id, $override);
196
197    if ($with_notification and $conf['email_admin_on_new_user'])
198    {
199      include_once(PHPWG_ROOT_PATH.'include/functions_mail.inc.php');
200      $admin_url = get_absolute_root_url()
201                   .'admin.php?page=user_list&username='.$login;
202
203      $keyargs_content = array
204      (
205        get_l10n_args('User: %s', stripslashes($login)),
206        get_l10n_args('Email: %s', $_POST['mail_address']),
207        get_l10n_args('', ''),
208        get_l10n_args('Admin: %s', $admin_url)
209      );
210
211      pwg_mail_notification_admins
212      (
213        get_l10n_args('Registration of %s', stripslashes($login)),
214        $keyargs_content
215      );
216    }
217
218    trigger_action('register_user',
219      array(
220        'id'=>$next_id,
221        'username'=>$login,
222        'email'=>$mail_address,
223       )
224      );
225  }
226
227  return $errors;
228}
229
230function build_user( $user_id, $use_cache )
231{
232  global $conf;
233
234  $user['id'] = $user_id;
235  $user = array_merge( $user, getuserdata($user_id, $use_cache) );
236
237  if ($user['id'] == $conf['guest_id'] and $user['status'] <> 'guest')
238  {
239    $user['status'] = 'guest';
240    $user['internal_status']['guest_must_be_guest'] = true;
241  }
242
243  // calculation of the number of picture to display per page
244  $user['nb_image_page'] = $user['nb_image_line'] * $user['nb_line_page'];
245
246  // Check user theme
247  if (!isset($user['theme_name']))
248  {
249    $user['theme'] = get_default_theme();
250  }
251
252  return $user;
253}
254
255/**
256 * find informations related to the user identifier
257 *
258 * @param int user identifier
259 * @param boolean use_cache
260 * @param array
261 */
262function getuserdata($user_id, $use_cache)
263{
264  global $conf;
265
266  $userdata = array();
267
268  // retrieve basic user data
269  $query = '
270SELECT ';
271  $is_first = true;
272  foreach ($conf['user_fields'] as $pwgfield => $dbfield)
273  {
274    if ($is_first)
275    {
276      $is_first = false;
277    }
278    else
279    {
280      $query.= '
281     , ';
282    }
283    $query.= $dbfield.' AS '.$pwgfield;
284  }
285  $query.= '
286  FROM '.USERS_TABLE.'
287  WHERE '.$conf['user_fields']['id'].' = \''.$user_id.'\'';
288
289  $row = pwg_db_fetch_assoc(pwg_query($query));
290
291  // retrieve user info
292  $query = '
293SELECT
294    ui.*,
295    uc.*,
296    t.name AS theme_name
297  FROM '.USER_INFOS_TABLE.' AS ui
298    LEFT JOIN '.USER_CACHE_TABLE.' AS uc ON ui.user_id = uc.user_id
299    LEFT JOIN '.THEMES_TABLE.' AS t ON t.id = ui.theme
300  WHERE ui.user_id = '.$user_id.'
301;';
302
303  $result = pwg_query($query);
304  $user_infos_row = pwg_db_fetch_assoc($result);
305
306  // retrieve additional user data ?
307  if ($conf['external_authentification'])
308  {
309    $query = '
310SELECT
311    COUNT(1) AS counter,
312  FROM '.USER_INFOS_TABLE.' AS ui
313    LEFT JOIN '.USER_CACHE_TABLE.' AS uc ON ui.user_id = uc.user_id
314    LEFT JOIN '.THEMES_TABLE.' AS t ON t.id = ui.theme
315  WHERE ui.user_id = '.$user_id.'
316  GROUP BY ui.user_id
317;';
318    if (pwg_db_fetch_row(pwg_query($query))!=1)
319    {
320      create_user_infos($user_id);
321   
322      $result = pwg_query($user_info_query);
323      $user_infos_row = pwg_db_fetch_assoc($result);     
324    }
325  }
326
327  // then merge basic + additional user data
328  $row = array_merge($row, $user_infos_row);
329
330  foreach ($row as $key => $value)
331  {
332    if (!is_numeric($key))
333    {
334      // If the field is true or false, the variable is transformed into a
335      // boolean value.
336      if ($value == 'true' or $value == 'false')
337      {
338        $userdata[$key] = get_boolean($value);
339      }
340      else
341      {
342        $userdata[$key] = $value;
343      }
344    }
345  }
346
347  if ($use_cache)
348  {
349    if (!isset($userdata['need_update'])
350        or !is_bool($userdata['need_update'])
351        or $userdata['need_update'] == true)
352    {
353      $userdata['cache_update_time'] = time();
354
355      // Set need update are done
356      $userdata['need_update'] = false;
357
358      $userdata['forbidden_categories'] =
359        calculate_permissions($userdata['id'], $userdata['status']);
360
361      /* now we build the list of forbidden images (this list does not contain
362      images that are not in at least an authorized category)*/
363      $query = '
364SELECT DISTINCT(id)
365  FROM '.IMAGES_TABLE.' INNER JOIN '.IMAGE_CATEGORY_TABLE.' ON id=image_id
366  WHERE category_id NOT IN ('.$userdata['forbidden_categories'].')
367    AND level>'.$userdata['level'];
368      $forbidden_ids = array_from_query($query, 'id');
369
370      if ( empty($forbidden_ids) )
371      {
372        array_push( $forbidden_ids, 0 );
373      }
374      $userdata['image_access_type'] = 'NOT IN'; //TODO maybe later
375      $userdata['image_access_list'] = implode(',',$forbidden_ids);
376
377
378      $query = '
379SELECT COUNT(DISTINCT(image_id)) as total
380  FROM '.IMAGE_CATEGORY_TABLE.'
381  WHERE category_id NOT IN ('.$userdata['forbidden_categories'].')
382    AND image_id '.$userdata['image_access_type'].' ('.$userdata['image_access_list'].')';
383      list($userdata['nb_total_images']) = pwg_db_fetch_row(pwg_query($query));
384
385
386      // now we update user cache categories
387      $user_cache_cats = get_computed_categories($userdata, null);
388      if ( !is_admin($userdata['status']) )
389      { // for non admins we forbid categories with no image (feature 1053)
390        $forbidden_ids = array();
391        foreach ($user_cache_cats as $cat)
392        {
393          if ($cat['count_images']==0)
394          {
395            array_push($forbidden_ids, $cat['cat_id']);
396            unset( $user_cache_cats[$cat['cat_id']] );
397          }
398        }
399        if ( !empty($forbidden_ids) )
400        {
401          if ( empty($userdata['forbidden_categories']) )
402          {
403            $userdata['forbidden_categories'] = implode(',', $forbidden_ids);
404          }
405          else
406          {
407            $userdata['forbidden_categories'] .= ','.implode(',', $forbidden_ids);
408          }
409        }
410      }
411
412      // delete user cache
413      $query = '
414DELETE FROM '.USER_CACHE_CATEGORIES_TABLE.'
415  WHERE user_id = '.$userdata['id'];
416      pwg_query($query);
417
418      mass_inserts
419      (
420        USER_CACHE_CATEGORIES_TABLE,
421        array
422        (
423          'user_id', 'cat_id',
424          'date_last', 'max_date_last', 'nb_images', 'count_images', 'count_categories'
425        ),
426        $user_cache_cats
427      );
428
429
430      // update user cache
431      $query = '
432DELETE FROM '.USER_CACHE_TABLE.'
433  WHERE user_id = '.$userdata['id'];
434      pwg_query($query);
435
436      $query = '
437INSERT INTO '.USER_CACHE_TABLE.'
438  (user_id, need_update, cache_update_time, forbidden_categories, nb_total_images,
439    image_access_type, image_access_list)
440  VALUES
441  ('.$userdata['id'].',\''.boolean_to_string($userdata['need_update']).'\','
442  .$userdata['cache_update_time'].',\''
443  .$userdata['forbidden_categories'].'\','.$userdata['nb_total_images'].',\''
444  .$userdata['image_access_type'].'\',\''.$userdata['image_access_list'].'\')';
445      pwg_query($query);
446    }
447  }
448
449  return $userdata;
450}
451
452/*
453 * deletes favorites of the current user if he's not allowed to see them
454 *
455 * @return void
456 */
457function check_user_favorites()
458{
459  global $user;
460
461  if ($user['forbidden_categories'] == '')
462  {
463    return;
464  }
465
466  // $filter['visible_categories'] and $filter['visible_images']
467  // must be not used because filter <> restriction
468  // retrieving images allowed : belonging to at least one authorized
469  // category
470  $query = '
471SELECT DISTINCT f.image_id
472  FROM '.FAVORITES_TABLE.' AS f INNER JOIN '.IMAGE_CATEGORY_TABLE.' AS ic
473    ON f.image_id = ic.image_id
474  WHERE f.user_id = '.$user['id'].'
475'.get_sql_condition_FandF
476  (
477    array
478      (
479        'forbidden_categories' => 'ic.category_id',
480      ),
481    'AND'
482  ).'
483;';
484  $result = pwg_query($query);
485  $authorizeds = array();
486  while ($row = pwg_db_fetch_assoc($result))
487  {
488    array_push($authorizeds, $row['image_id']);
489  }
490
491  $query = '
492SELECT image_id
493  FROM '.FAVORITES_TABLE.'
494  WHERE user_id = '.$user['id'].'
495;';
496  $result = pwg_query($query);
497  $favorites = array();
498  while ($row = pwg_db_fetch_assoc($result))
499  {
500    array_push($favorites, $row['image_id']);
501  }
502
503  $to_deletes = array_diff($favorites, $authorizeds);
504
505  if (count($to_deletes) > 0)
506  {
507    $query = '
508DELETE FROM '.FAVORITES_TABLE.'
509  WHERE image_id IN ('.implode(',', $to_deletes).')
510    AND user_id = '.$user['id'].'
511;';
512    pwg_query($query);
513  }
514}
515
516/**
517 * calculates the list of forbidden categories for a given user
518 *
519 * Calculation is based on private categories minus categories authorized to
520 * the groups the user belongs to minus the categories directly authorized
521 * to the user. The list contains at least -1 to be compliant with queries
522 * such as "WHERE category_id NOT IN ($forbidden_categories)"
523 *
524 * @param int user_id
525 * @param string user_status
526 * @return string forbidden_categories
527 */
528function calculate_permissions($user_id, $user_status)
529{
530  $private_array = array();
531  $authorized_array = array();
532
533  $query = '
534SELECT id
535  FROM '.CATEGORIES_TABLE.'
536  WHERE status = \'private\'
537;';
538  $result = pwg_query($query);
539  while ($row = pwg_db_fetch_assoc($result))
540  {
541    array_push($private_array, $row['id']);
542  }
543
544  // retrieve category ids directly authorized to the user
545  $query = '
546SELECT cat_id
547  FROM '.USER_ACCESS_TABLE.'
548  WHERE user_id = '.$user_id.'
549;';
550  $authorized_array = array_from_query($query, 'cat_id');
551
552  // retrieve category ids authorized to the groups the user belongs to
553  $query = '
554SELECT cat_id
555  FROM '.USER_GROUP_TABLE.' AS ug INNER JOIN '.GROUP_ACCESS_TABLE.' AS ga
556    ON ug.group_id = ga.group_id
557  WHERE ug.user_id = '.$user_id.'
558;';
559  $authorized_array =
560    array_merge(
561      $authorized_array,
562      array_from_query($query, 'cat_id')
563      );
564
565  // uniquify ids : some private categories might be authorized for the
566  // groups and for the user
567  $authorized_array = array_unique($authorized_array);
568
569  // only unauthorized private categories are forbidden
570  $forbidden_array = array_diff($private_array, $authorized_array);
571
572  // if user is not an admin, locked categories are forbidden
573  if (!is_admin($user_status))
574  {
575    $query = '
576SELECT id
577  FROM '.CATEGORIES_TABLE.'
578  WHERE visible = \'false\'
579;';
580    $result = pwg_query($query);
581    while ($row = pwg_db_fetch_assoc($result))
582    {
583      array_push($forbidden_array, $row['id']);
584    }
585    $forbidden_array = array_unique($forbidden_array);
586  }
587
588  if ( empty($forbidden_array) )
589  {// at least, the list contains 0 value. This category does not exists so
590   // where clauses such as "WHERE category_id NOT IN(0)" will always be
591   // true.
592    array_push($forbidden_array, 0);
593  }
594
595  return implode(',', $forbidden_array);
596}
597
598/**
599 * compute data of categories branches (one branch only)
600 */
601function compute_branch_cat_data(&$cats, &$list_cat_id, &$level, &$ref_level)
602{
603  $date = '';
604  $count_images = 0;
605  $count_categories = 0;
606  do
607  {
608    $cat_id = array_pop($list_cat_id);
609    if (!is_null($cat_id))
610    {
611      // Count images and categories
612      $cats[$cat_id]['count_images'] += $count_images;
613      $cats[$cat_id]['count_categories'] += $count_categories;
614      $count_images = $cats[$cat_id]['count_images'];
615      $count_categories = $cats[$cat_id]['count_categories'] + 1;
616
617      if ((empty($cats[$cat_id]['max_date_last'])) or ($cats[$cat_id]['max_date_last'] < $date))
618      {
619        $cats[$cat_id]['max_date_last'] = $date;
620      }
621      else
622      {
623        $date = $cats[$cat_id]['max_date_last'];
624      }
625      $ref_level = substr_count($cats[$cat_id]['global_rank'], '.') + 1;
626    }
627    else
628    {
629      $ref_level = 0;
630    }
631  } while ($level <= $ref_level);
632
633  // Last cat updating must be added to list for next branch
634  if ($ref_level <> 0)
635  {
636    array_push($list_cat_id, $cat_id);
637  }
638}
639
640/**
641 * compute data of categories branches
642 */
643function compute_categories_data(&$cats)
644{
645  $ref_level = 0;
646  $level = 0;
647  $list_cat_id = array();
648
649  foreach ($cats as $id => $category)
650  {
651    // Compute
652    $level = substr_count($category['global_rank'], '.') + 1;
653    if ($level > $ref_level)
654    {
655      array_push($list_cat_id, $id);
656    }
657    else
658    {
659      compute_branch_cat_data($cats, $list_cat_id, $level, $ref_level);
660      array_push($list_cat_id, $id);
661    }
662    $ref_level = $level;
663  }
664
665  $level = 1;
666  compute_branch_cat_data($cats, $list_cat_id, $level, $ref_level);
667}
668
669/**
670 * get computed array of categories
671 *
672 * @param array userdata
673 * @param int filter_days number of recent days to filter on or null
674 * @return array
675 */
676function get_computed_categories($userdata, $filter_days=null)
677{
678  $query = 'SELECT c.id AS cat_id, global_rank';
679  // Count by date_available to avoid count null
680  $query .= ',
681  MAX(date_available) AS date_last, COUNT(date_available) AS nb_images
682FROM '.CATEGORIES_TABLE.' as c
683  LEFT JOIN '.IMAGE_CATEGORY_TABLE.' AS ic ON ic.category_id = c.id
684  LEFT JOIN '.IMAGES_TABLE.' AS i
685    ON ic.image_id = i.id
686      AND i.level<='.$userdata['level'];
687
688  if ( isset($filter_days) )
689  {
690    $query .= ' AND i.date_available > '.pwg_db_get_recent_period_expression($filter_days);
691  }
692
693  if ( !empty($userdata['forbidden_categories']) )
694  {
695    $query.= '
696  WHERE c.id NOT IN ('.$userdata['forbidden_categories'].')';
697  }
698
699  $query.= '
700  GROUP BY c.id, c.global_rank';
701
702  $result = pwg_query($query);
703
704  $cats = array();
705  while ($row = pwg_db_fetch_assoc($result))
706  {
707    $row['user_id'] = $userdata['id'];
708    $row['count_categories'] = 0;
709    $row['count_images'] = (int)$row['nb_images'];
710    $row['max_date_last'] = $row['date_last'];
711
712    $cats += array($row['cat_id'] => $row);
713  }
714  uasort($cats, 'global_rank_compare');
715
716  compute_categories_data($cats);
717
718  if ( isset($filter_days) )
719  {
720    $cat_tmp = $cats;
721    $cats = array();
722
723    foreach ($cat_tmp as $category)
724    {
725      if (!empty($category['max_date_last']))
726      {
727        // Re-init counters
728        $category['count_categories'] = 0;
729        $category['count_images'] = (int)$category['nb_images'];
730        // Keep category
731        $cats[$category['cat_id']] = $category;
732      }
733    }
734    // Compute a second time
735    compute_categories_data($cats);
736  }
737  return $cats;
738}
739
740/**
741 * returns user identifier thanks to his name, false if not found
742 *
743 * @param string username
744 * @param int user identifier
745 */
746function get_userid($username)
747{
748  global $conf;
749
750  $username = pwg_db_real_escape_string($username);
751
752  $query = '
753SELECT '.$conf['user_fields']['id'].'
754  FROM '.USERS_TABLE.'
755  WHERE '.$conf['user_fields']['username'].' = \''.$username.'\'
756;';
757  $result = pwg_query($query);
758
759  if (pwg_db_num_rows($result) == 0)
760  {
761    return false;
762  }
763  else
764  {
765    list($user_id) = pwg_db_fetch_row($result);
766    return $user_id;
767  }
768}
769
770/**
771 * search an available feed_id
772 *
773 * @return string feed identifier
774 */
775function find_available_feed_id()
776{
777  while (true)
778  {
779    $key = generate_key(50);
780    $query = '
781SELECT COUNT(*)
782  FROM '.USER_FEED_TABLE.'
783  WHERE id = \''.$key.'\'
784;';
785    list($count) = pwg_db_fetch_row(pwg_query($query));
786    if (0 == $count)
787    {
788      return $key;
789    }
790  }
791}
792
793/*
794 * Returns a array with default user value
795 *
796 * @param convert_str allows to convert string value if necessary
797 */
798function get_default_user_info($convert_str = true)
799{
800  global $cache, $conf;
801
802  if (!isset($cache['default_user']))
803  {
804    $query = 'SELECT * FROM '.USER_INFOS_TABLE.
805            ' WHERE user_id = '.$conf['default_user_id'].';';
806
807    $result = pwg_query($query);
808    $cache['default_user'] = pwg_db_fetch_assoc($result);
809
810    if ($cache['default_user'] !== false)
811    {
812      unset($cache['default_user']['user_id']);
813      unset($cache['default_user']['status']);
814      unset($cache['default_user']['registration_date']);
815
816      // theme and language fields may be null in the database (see
817      // bug:1683) This is absolutely not nice to have this code in this
818      // very place, but it avoids a complexe upgrade with an "automatic
819      // fix" in the database => this code should be removed after branch
820      // 2.1 if a migration tasks performs the job the same way
821      if (empty($cache['default_user']['theme']))
822      {
823        mass_updates(
824          USER_INFOS_TABLE,
825          array(
826            'primary' => array('user_id'),
827            'update'  => array('theme')
828            ),
829          array(
830            array(
831              'user_id' => $conf['default_user_id'],
832              'theme' => PHPWG_DEFAULT_TEMPLATE
833              )
834            )
835          );
836        $cache['default_user']['theme'] = PHPWG_DEFAULT_TEMPLATE;
837      }
838     
839      if (empty($cache['default_user']['language']))
840      {
841        mass_updates(
842          USER_INFOS_TABLE,
843          array(
844            'primary' => array('user_id'),
845            'update'  => array('language')
846            ),
847          array(
848            array(
849              'user_id' => $conf['default_user_id'],
850              'language' => PHPWG_DEFAULT_LANGUAGE
851              )
852            )
853          );
854        $cache['default_user']['language'] = PHPWG_DEFAULT_LANGUAGE;
855      }
856    }
857  }
858
859  if (is_array($cache['default_user']) and $convert_str)
860  {
861    $default_user = array();
862    foreach ($cache['default_user'] as $name => $value)
863    {
864      // If the field is true or false, the variable is transformed into a
865      // boolean value.
866      if ($value == 'true' or $value == 'false')
867      {
868        $default_user[$name] = get_boolean($value);
869      }
870      else
871      {
872        $default_user[$name] = $value;
873      }
874    }
875    return $default_user;
876  }
877  else
878  {
879    return $cache['default_user'];
880  }
881}
882
883/*
884 * Returns a default user value
885 *
886 * @param value_name: name of value
887 * @param sos_value: value used if don't exist value
888 */
889function get_default_user_value($value_name, $sos_value)
890{
891  $default_user = get_default_user_info(true);
892  if ($default_user === false or empty($default_user[$value_name]))
893  {
894    return $sos_value;
895  }
896  else
897  {
898   return $default_user[$value_name];
899  }
900}
901
902/*
903 * Returns the default template value
904 *
905 */
906function get_default_theme()
907{
908  $theme = get_default_user_value('theme', PHPWG_DEFAULT_TEMPLATE);
909  if (check_theme_installed($theme))
910  {
911    return $theme;
912  }
913 
914  // let's find the first available theme
915  $active_themes = get_pwg_themes();
916  foreach (array_keys(get_pwg_themes()) as $theme_id)
917  {
918    if (check_theme_installed($theme_id))
919    {
920      return $theme_id;
921    }
922  }
923}
924
925/*
926 * Returns the default language value
927 *
928 */
929function get_default_language()
930{
931  return get_default_user_value('language', PHPWG_DEFAULT_LANGUAGE);
932}
933
934/**
935  * Returns true if the browser language value is set into param $lang
936  *
937  */
938function get_browser_language(&$lang)
939{
940  $browser_language = substr(@$_SERVER["HTTP_ACCEPT_LANGUAGE"], 0, 2);
941  foreach (get_languages() as $language_code => $language_name)
942  {
943    if (substr($language_code, 0, 2) == $browser_language)
944    {
945      $lang = $language_code;
946      return true;
947    }
948  }
949  return false;
950}
951
952/**
953 * add user informations based on default values
954 *
955 * @param int user_id / array of user_if
956 * @param array of values used to override default user values
957 */
958function create_user_infos($arg_id, $override_values = null)
959{
960  global $conf;
961
962  if (is_array($arg_id))
963  {
964    $user_ids = $arg_id;
965  }
966  else
967  {
968    $user_ids = array();
969    if (is_numeric($arg_id))
970    {
971      $user_ids[] = $arg_id;
972    }
973  }
974
975  if (!empty($user_ids))
976  {
977    $inserts = array();
978    list($dbnow) = pwg_db_fetch_row(pwg_query('SELECT NOW();'));
979
980    $default_user = get_default_user_info(false);
981    if ($default_user === false)
982    {
983      // Default on structure are used
984      $default_user = array();
985    }
986
987    if (!is_null($override_values))
988    {
989      $default_user = array_merge($default_user, $override_values);
990    }
991
992    foreach ($user_ids as $user_id)
993    {
994      $level= isset($default_user['level']) ? $default_user['level'] : 0;
995      if ($user_id == $conf['webmaster_id'])
996      {
997        $status = 'webmaster';
998        $level = max( $conf['available_permission_levels'] );
999      }
1000      else if (($user_id == $conf['guest_id']) or
1001               ($user_id == $conf['default_user_id']))
1002      {
1003        $status = 'guest';
1004      }
1005      else
1006      {
1007        $status = 'normal';
1008      }
1009
1010      $insert = array_merge(
1011        $default_user,
1012        array(
1013          'user_id' => $user_id,
1014          'status' => $status,
1015          'registration_date' => $dbnow,
1016          'level' => $level
1017          ));
1018
1019      array_push($inserts, $insert);
1020    }
1021
1022    mass_inserts(USER_INFOS_TABLE, array_keys($inserts[0]), $inserts);
1023  }
1024}
1025
1026/**
1027 * returns the auto login key or false on error
1028 * @param int user_id
1029 * @param time_t time
1030 * @param string [out] username
1031*/
1032function calculate_auto_login_key($user_id, $time, &$username)
1033{
1034  global $conf;
1035  $query = '
1036SELECT '.$conf['user_fields']['username'].' AS username
1037  , '.$conf['user_fields']['password'].' AS password
1038FROM '.USERS_TABLE.'
1039WHERE '.$conf['user_fields']['id'].' = '.$user_id;
1040  $result = pwg_query($query);
1041  if (pwg_db_num_rows($result) > 0)
1042  {
1043    $row = pwg_db_fetch_assoc($result);
1044    $username = stripslashes($row['username']);
1045    $data = $time.stripslashes($row['username']).$row['password'];
1046    $key = base64_encode(
1047      pack('H*', sha1($data))
1048      .hash_hmac('md5', $data, $conf['secret_key'],true)
1049      );
1050    return $key;
1051  }
1052  return false;
1053}
1054
1055/*
1056 * Performs all required actions for user login
1057 * @param int user_id
1058 * @param bool remember_me
1059 * @return void
1060*/
1061function log_user($user_id, $remember_me)
1062{
1063  global $conf, $user;
1064
1065  if ($remember_me and $conf['authorize_remembering'])
1066  {
1067    $now = time();
1068    $key = calculate_auto_login_key($user_id, $now, $username);
1069    if ($key!==false)
1070    {
1071      $cookie = $user_id.'-'.$now.'-'.$key;
1072      if (version_compare(PHP_VERSION, '5.2', '>=') )
1073      {
1074        setcookie($conf['remember_me_name'],
1075            $cookie,
1076            time()+$conf['remember_me_length'],
1077            cookie_path(),ini_get('session.cookie_domain'),ini_get('session.cookie_secure'),
1078            ini_get('session.cookie_httponly')
1079          );
1080      }
1081      else
1082      {
1083        setcookie($conf['remember_me_name'],
1084            $cookie,
1085            time()+$conf['remember_me_length'],
1086            cookie_path(),ini_get('session.cookie_domain'),ini_get('session.cookie_secure')
1087          );
1088      }
1089    }
1090  }
1091  else
1092  { // make sure we clean any remember me ...
1093    setcookie($conf['remember_me_name'], '', 0, cookie_path(),ini_get('session.cookie_domain'));
1094  }
1095  if ( session_id()!="" )
1096  { // we regenerate the session for security reasons
1097    // see http://www.acros.si/papers/session_fixation.pdf
1098    session_regenerate_id(true);
1099  }
1100  else
1101  {
1102    session_start();
1103  }
1104  $_SESSION['pwg_uid'] = (int)$user_id;
1105
1106  $user['id'] = $_SESSION['pwg_uid'];
1107}
1108
1109/*
1110 * Performs auto-connexion when cookie remember_me exists
1111 * @return true/false
1112*/
1113function auto_login() {
1114  global $conf;
1115
1116  if ( isset( $_COOKIE[$conf['remember_me_name']] ) )
1117  {
1118    $cookie = explode('-', stripslashes($_COOKIE[$conf['remember_me_name']]));
1119    if ( count($cookie)===3
1120        and is_numeric(@$cookie[0]) /*user id*/
1121        and is_numeric(@$cookie[1]) /*time*/
1122        and time()-$conf['remember_me_length']<=@$cookie[1]
1123        and time()>=@$cookie[1] /*cookie generated in the past*/ )
1124    {
1125      $key = calculate_auto_login_key( $cookie[0], $cookie[1], $username );
1126      if ($key!==false and $key===$cookie[2])
1127      {
1128        log_user($cookie[0], true);
1129        trigger_action('login_success', stripslashes($username));
1130        return true;
1131      }
1132    }
1133    setcookie($conf['remember_me_name'], '', 0, cookie_path(),ini_get('session.cookie_domain'));
1134  }
1135  return false;
1136}
1137
1138/**
1139 * Tries to login a user given username and password (must be MySql escaped)
1140 * return true on success
1141 */
1142function try_log_user($username, $password, $remember_me)
1143{
1144  global $conf;
1145  // retrieving the encrypted password of the login submitted
1146  $query = '
1147SELECT '.$conf['user_fields']['id'].' AS id,
1148       '.$conf['user_fields']['password'].' AS password
1149  FROM '.USERS_TABLE.'
1150  WHERE '.$conf['user_fields']['username'].' = \''.pwg_db_real_escape_string($username).'\'
1151;';
1152  $row = pwg_db_fetch_assoc(pwg_query($query));
1153  if ($row['password'] == $conf['pass_convert']($password))
1154  {
1155    log_user($row['id'], $remember_me);
1156    trigger_action('login_success', stripslashes($username));
1157    return true;
1158  }
1159  trigger_action('login_failure', stripslashes($username));
1160  return false;
1161}
1162
1163/** Performs all the cleanup on user logout */
1164function logout_user()
1165{
1166  global $conf;
1167  $_SESSION = array();
1168  session_unset();
1169  session_destroy();
1170  setcookie(session_name(),'',0,
1171      ini_get('session.cookie_path'),
1172      ini_get('session.cookie_domain')
1173    );
1174  setcookie($conf['remember_me_name'], '', 0, cookie_path(),ini_get('session.cookie_domain'));
1175}
1176
1177/*
1178 * Return user status used in this library
1179 * @return string
1180*/
1181function get_user_status($user_status)
1182{
1183  global $user;
1184
1185  if (empty($user_status))
1186  {
1187    if (isset($user['status']))
1188    {
1189      $user_status = $user['status'];
1190    }
1191    else
1192    {
1193      // swicth to default value
1194      $user_status = '';
1195    }
1196  }
1197  return $user_status;
1198}
1199
1200/*
1201 * Return access_type definition of user
1202 * Test does with user status
1203 * @return bool
1204*/
1205function get_access_type_status($user_status='')
1206{
1207  global $conf;
1208
1209  switch (get_user_status($user_status))
1210  {
1211    case 'guest':
1212    {
1213      $access_type_status =
1214        ($conf['guest_access'] ? ACCESS_GUEST : ACCESS_FREE);
1215      break;
1216    }
1217    case 'generic':
1218    {
1219      $access_type_status = ACCESS_GUEST;
1220      break;
1221    }
1222    case 'normal':
1223    {
1224      $access_type_status = ACCESS_CLASSIC;
1225      break;
1226    }
1227    case 'admin':
1228    {
1229      $access_type_status = ACCESS_ADMINISTRATOR;
1230      break;
1231    }
1232    case 'webmaster':
1233    {
1234      $access_type_status = ACCESS_WEBMASTER;
1235      break;
1236    }
1237    default:
1238    {
1239      $access_type_status = ACCESS_FREE;
1240      break;
1241    }
1242  }
1243
1244  return $access_type_status;
1245}
1246
1247/*
1248 * Return if user have access to access_type definition
1249 * Test does with user status
1250 * @return bool
1251*/
1252function is_autorize_status($access_type, $user_status = '')
1253{
1254  return (get_access_type_status($user_status) >= $access_type);
1255}
1256
1257/*
1258 * Check if user have access to access_type definition
1259 * Stop action if there are not access
1260 * Test does with user status
1261 * @return none
1262*/
1263function check_status($access_type, $user_status = '')
1264{
1265  if (!is_autorize_status($access_type, $user_status))
1266  {
1267    access_denied();
1268  }
1269}
1270
1271/*
1272 * Return if user is generic
1273 * @return bool
1274*/
1275 function is_generic($user_status = '')
1276{
1277  return get_user_status($user_status) == 'generic';
1278}
1279
1280/*
1281 * Return if user is only a guest
1282 * @return bool
1283*/
1284 function is_a_guest($user_status = '')
1285{
1286  return get_user_status($user_status) == 'guest';
1287}
1288
1289/*
1290 * Return if user is, at least, a classic user
1291 * @return bool
1292*/
1293 function is_classic_user($user_status = '')
1294{
1295  return is_autorize_status(ACCESS_CLASSIC, $user_status);
1296}
1297
1298/*
1299 * Return if user is, at least, an administrator
1300 * @return bool
1301*/
1302 function is_admin($user_status = '')
1303{
1304  return is_autorize_status(ACCESS_ADMINISTRATOR, $user_status);
1305}
1306
1307/*
1308 * Return if user is, at least, a webmaster
1309 * @return bool
1310*/
1311 function is_webmaster($user_status = '')
1312{
1313  return is_autorize_status(ACCESS_WEBMASTER, $user_status);
1314}
1315
1316/*
1317 * Adviser status is depreciated from piwigo 2.2
1318 * @return false
1319*/
1320function is_adviser()
1321{
1322  return false;
1323}
1324
1325/*
1326 * Return if current user can edit/delete/validate a comment
1327 * @param action edit/delete/validate
1328 * @return bool
1329 */
1330function can_manage_comment($action, $comment_author_id)
1331{
1332  global $user, $conf;
1333 
1334  if (is_a_guest())
1335  {
1336    return false;
1337  }
1338 
1339  if (!in_array($action, array('delete','edit', 'validate')))
1340  {
1341    return false;
1342  }
1343
1344  if (is_admin())
1345  {
1346    return true;
1347  }
1348
1349  if ('edit' == $action and $conf['user_can_edit_comment'])
1350  {
1351    if ($comment_author_id == $user['id']) {
1352      return true;
1353    }
1354  }
1355
1356  if ('delete' == $action and $conf['user_can_delete_comment'])
1357  {
1358    if ($comment_author_id == $user['id']) {
1359      return true;
1360    }
1361  }
1362
1363  return false;
1364}
1365
1366/*
1367 * Return mail address as display text
1368 * @return string
1369*/
1370function get_email_address_as_display_text($email_address)
1371{
1372  global $conf;
1373
1374  if (!isset($email_address) or (trim($email_address) == ''))
1375  {
1376    return '';
1377  }
1378  else
1379  {
1380    return $email_address;
1381  }
1382}
1383
1384/*
1385 * Compute sql where condition with restrict and filter data. "FandF" means
1386 * Forbidden and Filters.
1387 *
1388 * @param array condition_fields: read function body
1389 * @param string prefix_condition: prefixes sql if condition is not empty
1390 * @param boolean force_one_condition: use at least "1 = 1"
1391 *
1392 * @return string sql where/conditions
1393 */
1394function get_sql_condition_FandF(
1395  $condition_fields,
1396  $prefix_condition = null,
1397  $force_one_condition = false
1398  )
1399{
1400  global $user, $filter;
1401
1402  $sql_list = array();
1403
1404  foreach ($condition_fields as $condition => $field_name)
1405  {
1406    switch($condition)
1407    {
1408      case 'forbidden_categories':
1409      {
1410        if (!empty($user['forbidden_categories']))
1411        {
1412          $sql_list[] =
1413            $field_name.' NOT IN ('.$user['forbidden_categories'].')';
1414        }
1415        break;
1416      }
1417      case 'visible_categories':
1418      {
1419        if (!empty($filter['visible_categories']))
1420        {
1421          $sql_list[] =
1422            $field_name.' IN ('.$filter['visible_categories'].')';
1423        }
1424        break;
1425      }
1426      case 'visible_images':
1427        if (!empty($filter['visible_images']))
1428        {
1429          $sql_list[] =
1430            $field_name.' IN ('.$filter['visible_images'].')';
1431        }
1432        // note there is no break - visible include forbidden
1433      case 'forbidden_images':
1434        if (
1435            !empty($user['image_access_list'])
1436            or $user['image_access_type']!='NOT IN'
1437            )
1438        {
1439          $table_prefix=null;
1440          if ($field_name=='id')
1441          {
1442            $table_prefix = '';
1443          }
1444          elseif ($field_name=='i.id')
1445          {
1446            $table_prefix = 'i.';
1447          }
1448          if ( isset($table_prefix) )
1449          {
1450            $sql_list[]=$table_prefix.'level<='.$user['level'];
1451          }
1452          else
1453          {
1454            $sql_list[]=$field_name.' '.$user['image_access_type']
1455                .' ('.$user['image_access_list'].')';
1456          }
1457        }
1458        break;
1459      default:
1460      {
1461        die('Unknow condition');
1462        break;
1463      }
1464    }
1465  }
1466
1467  if (count($sql_list) > 0)
1468  {
1469    $sql = '('.implode(' AND ', $sql_list).')';
1470  }
1471  else
1472  {
1473    $sql = $force_one_condition ? '1 = 1' : '';
1474  }
1475
1476  if (isset($prefix_condition) and !empty($sql))
1477  {
1478    $sql = $prefix_condition.' '.$sql;
1479  }
1480
1481  return $sql;
1482}
1483
1484?>
Note: See TracBrowser for help on using the repository browser.