source: trunk/include/ws_functions/pwg.users.php @ 26461

Revision 26461, 15.8 KB checked in by mistic100, 5 years ago (diff)

Update headers to 2014. Happy new year!!

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  return array(
255    'paging' => new PwgNamedStruct(
256      array(
257        'page' => $params['page'],
258        'per_page' => $params['per_page'],
259        'count' => count($users)
260        )
261      ),
262    'users' => new PwgNamedArray(array_values($users), 'user')
263    );
264}
265
266/**
267 * API method
268 * Adds a user
269 * @param mixed[] $params
270 *    @option string username
271 *    @option string password (optional)
272 *    @option string email (optional)
273 */
274function ws_users_add($params, &$service)
275{
276  global $conf;
277
278  if ($conf['double_password_type_in_admin'])
279  {
280    if ($params['password'] != $params['password_confirm'])
281    {
282      return new PwgError(WS_ERR_INVALID_PARAM, l10n('The passwords do not match'));
283    }
284  }
285
286  $user_id = register_user(
287    $params['username'],
288    $params['password'],
289    $params['email'],
290    false, // notify admin
291    $errors,
292    $params['send_password_by_mail']
293    );
294
295  if (!$user_id)
296  {
297    return new PwgError(WS_ERR_INVALID_PARAM, $errors[0]);
298  }
299
300  return $service->invoke('pwg.users.getList', array('user_id'=>$user_id));
301}
302
303/**
304 * API method
305 * Deletes users
306 * @param mixed[] $params
307 *    @option int[] user_id
308 *    @option string pwg_token
309 */
310function ws_users_delete($params, &$service)
311{
312  if (get_pwg_token() != $params['pwg_token'])
313  {
314    return new PwgError(403, 'Invalid security token');
315  }
316
317  global $conf, $user;
318
319  include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
320
321  // protect some users
322  $params['user_id'] = array_diff(
323    $params['user_id'],
324    array(
325      $user['id'],
326      $conf['guest_id'],
327      $conf['default_user_id'],
328      $conf['webmaster_id'],
329      )
330    );
331
332  foreach ($params['user_id'] as $user_id)
333  {
334    delete_user($user_id);
335  }
336
337  return l10n_dec(
338    '%d user deleted', '%d users deleted',
339    count($params['user_id'])
340    );
341}
342
343/**
344 * API method
345 * Updates users
346 * @param mixed[] $params
347 *    @option int[] user_id
348 *    @option string username (optional)
349 *    @option string password (optional)
350 *    @option string email (optional)
351 *    @option string status (optional)
352 *    @option int level (optional)
353 *    @option string language (optional)
354 *    @option string theme (optional)
355 *    @option int nb_image_page (optional)
356 *    @option int recent_period (optional)
357 *    @option bool expand (optional)
358 *    @option bool show_nb_comments (optional)
359 *    @option bool show_nb_hits (optional)
360 *    @option bool enabled_high (optional)
361 */
362function ws_users_setInfo($params, &$service)
363{
364  global $conf, $user;
365
366  include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
367
368  $updates = $updates_infos = array();
369  $update_status = null;
370
371  if (count($params['user_id']) == 1)
372  {
373    if (get_username($params['user_id'][0]) === false)
374    {
375      return new PwgError(WS_ERR_INVALID_PARAM, 'This user does not exist.');
376    }
377
378    if (!empty($params['username']))
379    {
380      $user_id = get_userid($params['username']);
381      if ($user_id and $user_id != $params['user_id'][0])
382      {
383        return new PwgError(WS_ERR_INVALID_PARAM, l10n('this login is already used'));
384      }
385      if ($params['username'] != strip_tags($params['username']))
386      {
387        return new PwgError(WS_ERR_INVALID_PARAM, l10n('html tags are not allowed in login'));
388      }
389      $updates[ $conf['user_fields']['username'] ] = $params['username'];
390    }
391
392    if (!empty($params['email']))
393    {
394      if ( ($error = validate_mail_address($params['user_id'][0], $params['email'])) != '')
395      {
396        return new PwgError(WS_ERR_INVALID_PARAM, $error);
397      }
398      $updates[ $conf['user_fields']['email'] ] = $params['email'];
399    }
400
401    if (!empty($params['password']))
402    {
403      $updates[ $conf['user_fields']['password'] ] = $conf['password_hash']($params['password']);
404    }
405  }
406
407  if (!empty($params['status']))
408  {
409    if ( $params['status'] == 'webmaster' and !is_webmaster() )
410    {
411      return new PwgError(403, 'Only webmasters can grant "webmaster" status');
412    }
413    if ( !in_array($params['status'], array('guest','generic','normal','admin','webmaster')) )
414    {
415      return new PwgError(WS_ERR_INVALID_PARAM, 'Invalid status');
416    }
417
418    // status update query is separated from the rest as not applying to the same
419    // set of users (current, guest and webmaster can't be changed)
420    $params['user_id_for_status'] = array_diff(
421      $params['user_id'],
422      array(
423        $user['id'],
424        $conf['guest_id'],
425        $conf['webmaster_id'],
426        )
427      );
428
429    $update_status = $params['status'];
430  }
431
432  if (!empty($params['level']) or @$params['level']===0)
433  {
434    if ( !in_array($params['level'], $conf['available_permission_levels']) )
435    {
436      return new PwgError(WS_ERR_INVALID_PARAM, 'Invalid level');
437    }
438    $updates_infos['level'] = $params['level'];
439  }
440
441  if (!empty($params['language']))
442  {
443    if ( !in_array($params['language'], array_keys(get_languages())) )
444    {
445      return new PwgError(WS_ERR_INVALID_PARAM, 'Invalid language');
446    }
447    $updates_infos['language'] = $params['language'];
448  }
449
450  if (!empty($params['theme']))
451  {
452    if ( !in_array($params['theme'], array_keys(get_pwg_themes())) )
453    {
454      return new PwgError(WS_ERR_INVALID_PARAM, 'Invalid theme');
455    }
456    $updates_infos['theme'] = $params['theme'];
457  }
458
459  if (!empty($params['nb_image_page']))
460  {
461    $updates_infos['nb_image_page'] = $params['nb_image_page'];
462  }
463
464  if (!empty($params['recent_period']) or @$params['recent_period']===0)
465  {
466    $updates_infos['recent_period'] = $params['recent_period'];
467  }
468
469  if (!empty($params['expand']) or @$params['expand']===false)
470  {
471    $updates_infos['expand'] = boolean_to_string($params['expand']);
472  }
473
474  if (!empty($params['show_nb_comments']) or @$params['show_nb_comments']===false)
475  {
476    $updates_infos['show_nb_comments'] = boolean_to_string($params['show_nb_comments']);
477  }
478
479  if (!empty($params['show_nb_hits']) or @$params['show_nb_hits']===false)
480  {
481    $updates_infos['show_nb_hits'] = boolean_to_string($params['show_nb_hits']);
482  }
483
484  if (!empty($params['enabled_high']) or @$params['enabled_high']===false)
485  {
486    $updates_infos['enabled_high'] = boolean_to_string($params['enabled_high']);
487  }
488
489  // perform updates
490  single_update(
491    USERS_TABLE,
492    $updates,
493    array($conf['user_fields']['id'] => $params['user_id'][0])
494    );
495
496  if (isset($update_status) and count($params['user_id_for_status']) > 0)
497  {
498    $query = '
499UPDATE '. USER_INFOS_TABLE .' SET
500    status = "'. $update_status .'"
501  WHERE user_id IN('. implode(',', $params['user_id_for_status']) .')
502;';
503    pwg_query($query);
504  }
505
506  if (count($updates_infos) > 0)
507  {
508    $query = '
509UPDATE '. USER_INFOS_TABLE .' SET ';
510
511    $first = true;
512    foreach ($updates_infos as $field => $value)
513    {
514      if (!$first) $query.= ', ';
515      else $first = false;
516      $query.= $field .' = "'. $value .'"';
517    }
518
519    $query.= '
520  WHERE user_id IN('. implode(',', $params['user_id']) .')
521;';
522    pwg_query($query);
523  }
524
525  // manage association to groups
526  if (!empty($params['group_id']))
527  {
528    $query = '
529DELETE
530  FROM '.USER_GROUP_TABLE.'
531  WHERE user_id IN ('.implode(',', $params['user_id']).')
532;';
533    pwg_query($query);
534
535    // we remove all provided groups that do not really exist
536    $query = '
537SELECT
538    id
539  FROM '.GROUPS_TABLE.'
540  WHERE id IN ('.implode(',', $params['group_id']).')
541;';
542    $group_ids = array_from_query($query, 'id');
543
544    // if only -1 (a group id that can't exist) is in the list, then no
545    // group is associated
546   
547    if (count($group_ids) > 0)
548    {
549      $inserts = array();
550     
551      foreach ($group_ids as $group_id)
552      {
553        foreach ($params['user_id'] as $user_id)
554        {
555          $inserts[] = array('user_id' => $user_id, 'group_id' => $group_id);
556        }
557      }
558
559      mass_inserts(USER_GROUP_TABLE, array_keys($inserts[0]), $inserts);
560    }
561  }
562
563  invalidate_user_cache();
564
565  return $service->invoke('pwg.users.getList', array(
566    'user_id' => $params['user_id'],
567    'display' => 'basics,'.implode(',', array_keys($updates_infos)),
568    ));
569}
570
571?>
Note: See TracBrowser for help on using the repository browser.