source: branches/2.6/include/ws_functions/pwg.users.php @ 27715

Revision 27715, 15.8 KB checked in by plg, 5 years ago (diff)

feature 3054: new trigger ws_users_getList

Line 
1<?php
2// +-----------------------------------------------------------------------+
3// | Piwigo - a PHP based photo gallery                                    |
4// +-----------------------------------------------------------------------+
5// | Copyright(C) 2008-2014 Piwigo Team                  http://piwigo.org |
6// | Copyright(C) 2003-2008 PhpWebGallery Team    http://phpwebgallery.net |
7// | Copyright(C) 2002-2003 Pierrick LE GALL   http://le-gall.net/pierrick |
8// +-----------------------------------------------------------------------+
9// | This program is free software; you can redistribute it and/or modify  |
10// | it under the terms of the GNU General Public License as published by  |
11// | the Free Software Foundation                                          |
12// |                                                                       |
13// | This program is distributed in the hope that it will be useful, but   |
14// | WITHOUT ANY WARRANTY; without even the implied warranty of            |
15// | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU      |
16// | General Public License for more details.                              |
17// |                                                                       |
18// | You should have received a copy of the GNU General Public License     |
19// | along with this program; if not, write to the Free Software           |
20// | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, |
21// | USA.                                                                  |
22// +-----------------------------------------------------------------------+
23
24/**
25 * API method
26 * Returns a list of users
27 * @param mixed[] $params
28 *    @option int[] user_id (optional)
29 *    @option string username (optional)
30 *    @option string[] status (optional)
31 *    @option int min_level (optional)
32 *    @option int[] group_id (optional)
33 *    @option int per_page
34 *    @option int page
35 *    @option string order
36 *    @option string display
37 */
38function ws_users_getList($params, &$service)
39{
40  global $conf;
41
42  $where_clauses = array('1=1');
43
44  if (!empty($params['user_id']))
45  {
46    $where_clauses[] = 'u.'.$conf['user_fields']['id'].' IN('. implode(',', $params['user_id']) .')';
47  }
48
49  if (!empty($params['username']))
50  {
51    $where_clauses[] = 'u.'.$conf['user_fields']['username'].' LIKE \''.pwg_db_real_escape_string($params['username']).'\'';
52  }
53
54  if (!empty($params['status']))
55  {
56    $params['status'] = array_intersect($params['status'], get_enums(USER_INFOS_TABLE, 'status'));
57    if (count($params['status']) > 0)
58    {
59      $where_clauses[] = 'ui.status IN("'. implode('","', $params['status']) .'")';
60    }
61  }
62
63  if (!empty($params['min_level']))
64  {
65    if ( !in_array($params['min_level'], $conf['available_permission_levels']) )
66    {
67      return new PwgError(WS_ERR_INVALID_PARAM, 'Invalid level');
68    }
69    $where_clauses[] = 'ui.level >= '.$params['min_level'];
70  }
71
72  if (!empty($params['group_id']))
73  {
74    $where_clauses[] = 'ug.group_id IN('. implode(',', $params['group_id']) .')';
75  }
76
77  $display = array('u.'.$conf['user_fields']['id'] => 'id');
78
79  if ($params['display'] != 'none')
80  {
81    $params['display'] = array_map('trim', explode(',', $params['display']));
82
83    if (in_array('all', $params['display']))
84    {
85      $params['display'] = array(
86        'username','email','status','level','groups','language','theme',
87        'nb_image_page','recent_period','expand','show_nb_comments','show_nb_hits',
88        'enabled_high','registration_date','registration_date_string',
89        'registration_date_since', 'last_visit', 'last_visit_string',
90        'last_visit_since'
91        );
92    }
93    else if (in_array('basics', $params['display']))
94    {
95      $params['display'] = array_merge($params['display'], array(
96        'username','email','status','level','groups',
97        ));
98    }
99    $params['display'] = array_flip($params['display']);
100
101    // if registration_date_string or registration_date_since is requested,
102    // then registration_date is automatically added
103    if (isset($params['display']['registration_date_string']) or isset($params['display']['registration_date_since']))
104    {
105      $params['display']['registration_date'] = true;
106    }
107
108    // if last_visit_string or last_visit_since is requested, then
109    // last_visit is automatically added
110    if (isset($params['display']['last_visit_string']) or isset($params['display']['last_visit_since']))
111    {
112      $params['display']['last_visit'] = true;
113    }
114
115    if (isset($params['display']['username']))
116    {
117      $display['u.'.$conf['user_fields']['username']] = 'username';
118    }
119    if (isset($params['display']['email']))
120    {
121      $display['u.'.$conf['user_fields']['email']] = 'email';
122    }
123
124    $ui_fields = array(
125      'status','level','language','theme','nb_image_page','recent_period','expand',
126      'show_nb_comments','show_nb_hits','enabled_high','registration_date'
127      );
128    foreach ($ui_fields as $field)
129    {
130      if (isset($params['display'][$field]))
131      {
132        $display['ui.'.$field] = $field;
133      }
134    }
135  }
136  else
137  {
138    $params['display'] = array();
139  }
140
141  $query = '
142SELECT DISTINCT ';
143
144  $first = true;
145  foreach ($display as $field => $name)
146  {
147    if (!$first) $query.= ', ';
148    else $first = false;
149    $query.= $field .' AS '. $name;
150  }
151  if (isset($params['display']['groups']))
152  {
153    if (!$first) $query.= ', ';
154    $query.= '"" AS groups';
155  }
156
157  $query.= '
158  FROM '. USERS_TABLE .' AS u
159    INNER JOIN '. USER_INFOS_TABLE .' AS ui
160      ON u.'. $conf['user_fields']['id'] .' = ui.user_id
161    LEFT JOIN '. USER_GROUP_TABLE .' AS ug
162      ON u.'. $conf['user_fields']['id'] .' = ug.user_id
163  WHERE
164    '. implode(' AND ', $where_clauses) .'
165  ORDER BY '. $params['order'] .'
166  LIMIT '. $params['per_page'] .'
167  OFFSET '. ($params['per_page']*$params['page']) .'
168;';
169
170  $users = array();
171  $result = pwg_query($query);
172  while ($row = pwg_db_fetch_assoc($result))
173  {
174    $row['id'] = intval($row['id']);
175    $users[ $row['id'] ] = $row;
176  }
177
178  if (count($users) > 0)
179  {
180    if (isset($params['display']['groups']))
181    {
182      $query = '
183SELECT user_id, group_id
184  FROM '. USER_GROUP_TABLE .'
185  WHERE user_id IN ('. implode(',', array_keys($users)) .')
186;';
187      $result = pwg_query($query);
188     
189      while ($row = pwg_db_fetch_assoc($result))
190      {
191        $users[ $row['user_id'] ]['groups'][] = intval($row['group_id']);
192      }
193    }
194   
195    if (isset($params['display']['registration_date_string']))
196    {
197      foreach ($users as $cur_user)
198      {
199        $users[$cur_user['id']]['registration_date_string'] = format_date($cur_user['registration_date'], false, false);
200      }
201    }
202
203    if (isset($params['display']['registration_date_since']))
204    {
205      foreach ($users as $cur_user)
206      {
207        $users[ $cur_user['id'] ]['registration_date_since'] = time_since($cur_user['registration_date'], 'month');
208      }
209    }
210
211    if (isset($params['display']['last_visit']))
212    {
213      $query = '
214SELECT
215    MAX(id) as history_id
216  FROM '.HISTORY_TABLE.'
217  WHERE user_id IN ('.implode(',', array_keys($users)).')
218  GROUP BY user_id
219;';
220      $history_ids = array_from_query($query, 'history_id');
221     
222      if (count($history_ids) == 0)
223      {
224        $history_ids[] = -1;
225      }
226     
227      $query = '
228SELECT
229    user_id,
230    date,
231    time
232  FROM '.HISTORY_TABLE.'
233  WHERE id IN ('.implode(',', $history_ids).')
234;';
235      $result = pwg_query($query);
236      while ($row = pwg_db_fetch_assoc($result))
237      {
238        $last_visit = $row['date'].' '.$row['time'];
239        $users[ $row['user_id'] ]['last_visit'] = $last_visit;
240       
241        if (isset($params['display']['last_visit_string']))
242        {
243          $users[ $row['user_id'] ]['last_visit_string'] = format_date($last_visit, false, false);
244        }
245       
246        if (isset($params['display']['last_visit_since']))
247        {
248          $users[ $row['user_id'] ]['last_visit_since'] = time_since($last_visit, 'day');
249        }
250      }
251    }
252  }
253
254  $users = trigger_change('ws_users_getList', $users);
255 
256  return array(
257    'paging' => new PwgNamedStruct(
258      array(
259        'page' => $params['page'],
260        'per_page' => $params['per_page'],
261        'count' => count($users)
262        )
263      ),
264    'users' => new PwgNamedArray(array_values($users), 'user')
265    );
266}
267
268/**
269 * API method
270 * Adds a user
271 * @param mixed[] $params
272 *    @option string username
273 *    @option string password (optional)
274 *    @option string email (optional)
275 */
276function ws_users_add($params, &$service)
277{
278  global $conf;
279
280  if ($conf['double_password_type_in_admin'])
281  {
282    if ($params['password'] != $params['password_confirm'])
283    {
284      return new PwgError(WS_ERR_INVALID_PARAM, l10n('The passwords do not match'));
285    }
286  }
287
288  $user_id = register_user(
289    $params['username'],
290    $params['password'],
291    $params['email'],
292    false, // notify admin
293    $errors,
294    $params['send_password_by_mail']
295    );
296
297  if (!$user_id)
298  {
299    return new PwgError(WS_ERR_INVALID_PARAM, $errors[0]);
300  }
301
302  return $service->invoke('pwg.users.getList', array('user_id'=>$user_id));
303}
304
305/**
306 * API method
307 * Deletes users
308 * @param mixed[] $params
309 *    @option int[] user_id
310 *    @option string pwg_token
311 */
312function ws_users_delete($params, &$service)
313{
314  if (get_pwg_token() != $params['pwg_token'])
315  {
316    return new PwgError(403, 'Invalid security token');
317  }
318
319  global $conf, $user;
320
321  include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
322
323  // protect some users
324  $params['user_id'] = array_diff(
325    $params['user_id'],
326    array(
327      $user['id'],
328      $conf['guest_id'],
329      $conf['default_user_id'],
330      $conf['webmaster_id'],
331      )
332    );
333
334  foreach ($params['user_id'] as $user_id)
335  {
336    delete_user($user_id);
337  }
338
339  return l10n_dec(
340    '%d user deleted', '%d users deleted',
341    count($params['user_id'])
342    );
343}
344
345/**
346 * API method
347 * Updates users
348 * @param mixed[] $params
349 *    @option int[] user_id
350 *    @option string username (optional)
351 *    @option string password (optional)
352 *    @option string email (optional)
353 *    @option string status (optional)
354 *    @option int level (optional)
355 *    @option string language (optional)
356 *    @option string theme (optional)
357 *    @option int nb_image_page (optional)
358 *    @option int recent_period (optional)
359 *    @option bool expand (optional)
360 *    @option bool show_nb_comments (optional)
361 *    @option bool show_nb_hits (optional)
362 *    @option bool enabled_high (optional)
363 */
364function ws_users_setInfo($params, &$service)
365{
366  global $conf, $user;
367
368  include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
369
370  $updates = $updates_infos = array();
371  $update_status = null;
372
373  if (count($params['user_id']) == 1)
374  {
375    if (get_username($params['user_id'][0]) === false)
376    {
377      return new PwgError(WS_ERR_INVALID_PARAM, 'This user does not exist.');
378    }
379
380    if (!empty($params['username']))
381    {
382      $user_id = get_userid($params['username']);
383      if ($user_id and $user_id != $params['user_id'][0])
384      {
385        return new PwgError(WS_ERR_INVALID_PARAM, l10n('this login is already used'));
386      }
387      if ($params['username'] != strip_tags($params['username']))
388      {
389        return new PwgError(WS_ERR_INVALID_PARAM, l10n('html tags are not allowed in login'));
390      }
391      $updates[ $conf['user_fields']['username'] ] = $params['username'];
392    }
393
394    if (!empty($params['email']))
395    {
396      if ( ($error = validate_mail_address($params['user_id'][0], $params['email'])) != '')
397      {
398        return new PwgError(WS_ERR_INVALID_PARAM, $error);
399      }
400      $updates[ $conf['user_fields']['email'] ] = $params['email'];
401    }
402
403    if (!empty($params['password']))
404    {
405      $updates[ $conf['user_fields']['password'] ] = $conf['password_hash']($params['password']);
406    }
407  }
408
409  if (!empty($params['status']))
410  {
411    if ( $params['status'] == 'webmaster' and !is_webmaster() )
412    {
413      return new PwgError(403, 'Only webmasters can grant "webmaster" status');
414    }
415    if ( !in_array($params['status'], array('guest','generic','normal','admin','webmaster')) )
416    {
417      return new PwgError(WS_ERR_INVALID_PARAM, 'Invalid status');
418    }
419
420    // status update query is separated from the rest as not applying to the same
421    // set of users (current, guest and webmaster can't be changed)
422    $params['user_id_for_status'] = array_diff(
423      $params['user_id'],
424      array(
425        $user['id'],
426        $conf['guest_id'],
427        $conf['webmaster_id'],
428        )
429      );
430
431    $update_status = $params['status'];
432  }
433
434  if (!empty($params['level']) or @$params['level']===0)
435  {
436    if ( !in_array($params['level'], $conf['available_permission_levels']) )
437    {
438      return new PwgError(WS_ERR_INVALID_PARAM, 'Invalid level');
439    }
440    $updates_infos['level'] = $params['level'];
441  }
442
443  if (!empty($params['language']))
444  {
445    if ( !in_array($params['language'], array_keys(get_languages())) )
446    {
447      return new PwgError(WS_ERR_INVALID_PARAM, 'Invalid language');
448    }
449    $updates_infos['language'] = $params['language'];
450  }
451
452  if (!empty($params['theme']))
453  {
454    if ( !in_array($params['theme'], array_keys(get_pwg_themes())) )
455    {
456      return new PwgError(WS_ERR_INVALID_PARAM, 'Invalid theme');
457    }
458    $updates_infos['theme'] = $params['theme'];
459  }
460
461  if (!empty($params['nb_image_page']))
462  {
463    $updates_infos['nb_image_page'] = $params['nb_image_page'];
464  }
465
466  if (!empty($params['recent_period']) or @$params['recent_period']===0)
467  {
468    $updates_infos['recent_period'] = $params['recent_period'];
469  }
470
471  if (!empty($params['expand']) or @$params['expand']===false)
472  {
473    $updates_infos['expand'] = boolean_to_string($params['expand']);
474  }
475
476  if (!empty($params['show_nb_comments']) or @$params['show_nb_comments']===false)
477  {
478    $updates_infos['show_nb_comments'] = boolean_to_string($params['show_nb_comments']);
479  }
480
481  if (!empty($params['show_nb_hits']) or @$params['show_nb_hits']===false)
482  {
483    $updates_infos['show_nb_hits'] = boolean_to_string($params['show_nb_hits']);
484  }
485
486  if (!empty($params['enabled_high']) or @$params['enabled_high']===false)
487  {
488    $updates_infos['enabled_high'] = boolean_to_string($params['enabled_high']);
489  }
490
491  // perform updates
492  single_update(
493    USERS_TABLE,
494    $updates,
495    array($conf['user_fields']['id'] => $params['user_id'][0])
496    );
497
498  if (isset($update_status) and count($params['user_id_for_status']) > 0)
499  {
500    $query = '
501UPDATE '. USER_INFOS_TABLE .' SET
502    status = "'. $update_status .'"
503  WHERE user_id IN('. implode(',', $params['user_id_for_status']) .')
504;';
505    pwg_query($query);
506  }
507
508  if (count($updates_infos) > 0)
509  {
510    $query = '
511UPDATE '. USER_INFOS_TABLE .' SET ';
512
513    $first = true;
514    foreach ($updates_infos as $field => $value)
515    {
516      if (!$first) $query.= ', ';
517      else $first = false;
518      $query.= $field .' = "'. $value .'"';
519    }
520
521    $query.= '
522  WHERE user_id IN('. implode(',', $params['user_id']) .')
523;';
524    pwg_query($query);
525  }
526
527  // manage association to groups
528  if (!empty($params['group_id']))
529  {
530    $query = '
531DELETE
532  FROM '.USER_GROUP_TABLE.'
533  WHERE user_id IN ('.implode(',', $params['user_id']).')
534;';
535    pwg_query($query);
536
537    // we remove all provided groups that do not really exist
538    $query = '
539SELECT
540    id
541  FROM '.GROUPS_TABLE.'
542  WHERE id IN ('.implode(',', $params['group_id']).')
543;';
544    $group_ids = array_from_query($query, 'id');
545
546    // if only -1 (a group id that can't exist) is in the list, then no
547    // group is associated
548   
549    if (count($group_ids) > 0)
550    {
551      $inserts = array();
552     
553      foreach ($group_ids as $group_id)
554      {
555        foreach ($params['user_id'] as $user_id)
556        {
557          $inserts[] = array('user_id' => $user_id, 'group_id' => $group_id);
558        }
559      }
560
561      mass_inserts(USER_GROUP_TABLE, array_keys($inserts[0]), $inserts);
562    }
563  }
564
565  invalidate_user_cache();
566
567  return $service->invoke('pwg.users.getList', array(
568    'user_id' => $params['user_id'],
569    'display' => 'basics,'.implode(',', array_keys($updates_infos)),
570    ));
571}
572
573?>
Note: See TracBrowser for help on using the repository browser.