21use Luracast\Restler\RestException;
23require_once DOL_DOCUMENT_ROOT.
'/user/class/user.class.php';
24require_once DOL_DOCUMENT_ROOT.
'/user/class/usergroup.class.php';
38 public static $FIELDS = array(
55 $this->useraccount =
new User($this->db);
74 public function index($sortfield =
"t.rowid", $sortorder =
'ASC', $limit = 100, $page = 0, $user_ids =
'0', $category = 0, $sqlfilters =
'', $properties =
'')
76 if (!DolibarrApiAccess::$user->hasRight(
'user',
'user',
'lire') && empty(DolibarrApiAccess::$user->admin)) {
77 throw new RestException(403,
"You are not allowed to read list of users");
85 $sql =
"SELECT t.rowid";
86 $sql .=
" FROM ".MAIN_DB_PREFIX.
"user AS t LEFT JOIN ".MAIN_DB_PREFIX.
"user_extrafields AS ef ON (ef.fk_object = t.rowid)";
88 $sql .=
", ".$this->db->prefix().
"categorie_user as c";
90 $sql .=
' WHERE t.entity IN ('.getEntity(
'user').
')';
92 $sql .=
" AND t.rowid IN (".$this->db->sanitize($user_ids).
")";
97 $sql .=
" AND c.fk_categorie = ".((int) $category);
98 $sql .=
" AND c.fk_user = t.rowid";
106 throw new RestException(400,
'Error when validating parameter sqlfilters -> '.$errormessage);
110 $sql .= $this->db->order($sortfield, $sortorder);
115 $offset = $limit * $page;
117 $sql .= $this->db->plimit($limit + 1, $offset);
120 $result = $this->db->query($sql);
124 $num = $this->db->num_rows($result);
125 $min = min($num, ($limit <= 0 ? $num : $limit));
127 $obj = $this->db->fetch_object($result);
128 $user_static =
new User($this->db);
129 if ($user_static->fetch($obj->rowid)) {
135 throw new RestException(503,
'Error when retrieve User list : '.$this->db->lasterror());
151 public function get(
$id, $includepermissions = 0)
153 if (!DolibarrApiAccess::$user->hasRight(
'user',
'user',
'lire') && empty(DolibarrApiAccess::$user->admin) &&
$id != 0 && DolibarrApiAccess::$user->id !=
$id) {
154 throw new RestException(403,
'Not allowed');
158 $result = $this->useraccount->initAsSpecimen();
160 $result = $this->useraccount->fetch(
$id);
163 throw new RestException(404,
'User not found');
167 throw new RestException(403,
'Access not allowed for login '.DolibarrApiAccess::$user->login);
170 if ($includepermissions) {
171 $this->useraccount->loadRights();
193 throw new RestException(400,
'Bad parameters');
196 if (!DolibarrApiAccess::$user->hasRight(
'user',
'user',
'lire') && empty(DolibarrApiAccess::$user->admin) && DolibarrApiAccess::$user->login != $login) {
197 throw new RestException(403,
'Not allowed');
200 $result = $this->useraccount->fetch(
'', $login);
202 throw new RestException(404,
'User not found');
206 throw new RestException(403,
'Access not allowed for login '.DolibarrApiAccess::$user->login);
209 if ($includepermissions) {
210 $this->useraccount->loadRights();
232 throw new RestException(400,
'Bad parameters');
235 if (!DolibarrApiAccess::$user->hasRight(
'user',
'user',
'lire') && empty(DolibarrApiAccess::$user->admin) && DolibarrApiAccess::$user->
email != $email) {
236 throw new RestException(403,
'Not allowed');
239 $result = $this->useraccount->fetch(
'',
'',
'', 0, -1, $email);
241 throw new RestException(404,
'User not found');
245 throw new RestException(403,
'Access not allowed for login '.DolibarrApiAccess::$user->login);
248 if ($includepermissions) {
249 $this->useraccount->loadRights();
266 public function getInfo($includepermissions = 0)
268 if (!DolibarrApiAccess::$user->hasRight(
'user',
'self',
'creer') && !DolibarrApiAccess::$user->hasRight(
'user',
'user',
'lire') && empty(DolibarrApiAccess::$user->admin)) {
269 throw new RestException(403,
'Not allowed');
272 $apiUser = DolibarrApiAccess::$user;
274 $result = $this->useraccount->fetch($apiUser->id);
276 throw new RestException(404,
'User not found');
280 throw new RestException(403,
'Access not allowed for login '.DolibarrApiAccess::$user->login);
283 if ($includepermissions) {
284 $this->useraccount->loadRights();
288 $userGroupList = $usergroup->listGroupsForUser($apiUser->id,
false);
289 if (!is_array($userGroupList)) {
290 throw new RestException(404,
'User group not found');
306 public function post($request_data =
null)
309 if (!DolibarrApiAccess::$user->hasRight(
'user',
'creer') && empty(DolibarrApiAccess::$user->admin)) {
310 throw new RestException(403,
"User creation not allowed for login ".DolibarrApiAccess::$user->login);
322 foreach ($request_data as $field => $value) {
323 if (in_array($field, array(
'pass_crypted',
'pass_indatabase',
'pass_indatabase_crypted',
'pass_temp',
'api_key'))) {
325 throw new RestException(405,
'The property '.$field.
" can't be set/modified using the APIs");
327 if ($field ===
'caller') {
329 $this->useraccount->context[
'caller'] =
sanitizeVal($request_data[
'caller'],
'aZ09');
340 $this->useraccount->$field = $this->
_checkValForAPI($field, $value, $this->useraccount);
343 if ($this->useraccount->create(DolibarrApiAccess::$user) < 0) {
344 throw new RestException(500,
'Error creating', array_merge(array($this->useraccount->error), $this->useraccount->errors));
346 return $this->useraccount->id;
361 public function put(
$id, $request_data =
null)
364 if (!DolibarrApiAccess::$user->hasRight(
'user',
'user',
'creer') && empty(DolibarrApiAccess::$user->admin)) {
365 throw new RestException(403,
"User update not allowed");
368 $result = $this->useraccount->fetch(
$id);
370 throw new RestException(404,
'Account not found');
374 throw new RestException(403,
'Access not allowed for login '.DolibarrApiAccess::$user->login);
377 foreach ($request_data as $field => $value) {
378 if (in_array($field, array(
'pass_crypted',
'pass_indatabase',
'pass_indatabase_crypted',
'pass_temp',
'api_key'))) {
380 throw new RestException(405,
'The property '.$field.
" can't be set/modified using the APIs");
382 if ($field ==
'id') {
385 if ($field ==
'pass') {
386 if ($this->useraccount->id != DolibarrApiAccess::$user->id && !DolibarrApiAccess::$user->hasRight(
'user',
'user',
'password')) {
387 throw new RestException(403,
'You are not allowed to modify password of other users');
389 if ($this->useraccount->id == DolibarrApiAccess::$user->id && !DolibarrApiAccess::$user->hasRight(
'user',
'self',
'password')) {
390 throw new RestException(403,
'You are not allowed to modify your own password');
393 if ($field ===
'caller') {
395 $this->useraccount->context[
'caller'] =
sanitizeVal($request_data[
'caller'],
'aZ09');
399 if (DolibarrApiAccess::$user->admin) {
400 if ($field ==
'admin' && $value != $this->useraccount->admin && empty($value)) {
401 throw new RestException(403,
'Reseting the admin status of a user is not possible using the API');
404 if ($field ==
'admin' && $value != $this->useraccount->admin) {
405 throw new RestException(403,
'Only an admin user can modify the admin status of another user');
408 if ($field ==
'entity' && $value != $this->useraccount->entity) {
409 throw new RestException(403,
'Changing entity of a user using the APIs is not possible');
414 if ($field ==
'statut' || $field ==
'status') {
415 $result = $this->useraccount->setstatus($value);
417 throw new RestException(500,
'Error when updating status of user: '.$this->useraccount->error);
420 $this->useraccount->$field = $this->
_checkValForAPI($field, $value, $this->useraccount);
426 if ($this->useraccount->update(DolibarrApiAccess::$user) >= 0) {
427 return $this->
get(
$id);
429 throw new RestException(500, $this->useraccount->error);
450 throw new RestException(403,
"Error: login and password reset APIs are disabled. You can get access token from the backoffice to get access permission but permission and password manipulation from APIs are forbidden.");
455 throw new RestException(403,
"Error: password reset APIs are disabled by default. To allow this, the option API_ALLOW_PASSWORD_RESET must be set.");
458 if (!DolibarrApiAccess::$user->hasRight(
'user',
'user',
'creer') && empty(DolibarrApiAccess::$user->admin)) {
459 throw new RestException(403,
"setPassword on user not allowed for login ".DolibarrApiAccess::$user->login);
462 $result = $this->useraccount->fetch(
$id);
464 throw new RestException(404,
'User not found, no password changed');
468 throw new RestException(403,
'Access on this object not allowed for login '.DolibarrApiAccess::$user->login);
471 $newpassword = $this->useraccount->setPassword($this->useraccount,
'');
472 if (is_int($newpassword) && $newpassword < 0) {
473 throw new RestException(500,
'ErrorFailedToSetNewPassword'.$this->useraccount->error);
476 if ($send_password) {
477 if ($this->useraccount->send_password($this->useraccount, $newpassword) > 0) {
480 throw new RestException(500,
'ErrorFailedSendingNewPassword - '.$this->useraccount->error);
501 if (!DolibarrApiAccess::$user->hasRight(
'user',
'user',
'lire') && empty(DolibarrApiAccess::$user->admin)) {
502 throw new RestException(403);
505 $user =
new User($this->db);
506 $result = $user->fetch(
$id);
508 throw new RestException(404,
'user not found');
512 $groups = $usergroup->listGroupsForUser(
$id,
false);
514 foreach ($groups as $group) {
539 if (!DolibarrApiAccess::$user->hasRight(
'user',
'user',
'creer') && empty(DolibarrApiAccess::$user->admin)) {
540 throw new RestException(403,
'setGroup on users not allowed for login '.DolibarrApiAccess::$user->login);
543 $result = $this->useraccount->fetch(
$id);
545 throw new RestException(404,
'User not found');
549 throw new RestException(403,
'Access not allowed for login '.DolibarrApiAccess::$user->login);
552 if (isModEnabled(
'multicompany') &&
getDolGlobalString(
'MULTICOMPANY_TRANSVERSE_MODE') && !empty(DolibarrApiAccess::$user->admin) && empty(DolibarrApiAccess::$user->entity)) {
553 $entity = (!empty($entity) ? $entity : $conf->entity);
557 $entity = (DolibarrApiAccess::$user->entity > 0 ? DolibarrApiAccess::$user->entity : $conf->entity);
560 $result = $this->useraccount->SetInGroup($group, $entity);
561 if (!($result > 0)) {
562 throw new RestException(500, $this->useraccount->error);
588 public function listGroups($sortfield =
"t.rowid", $sortorder =
'ASC', $limit = 100, $page = 0, $group_ids =
'0', $sqlfilters =
'', $properties =
'')
592 if ((!
getDolGlobalString(
'MAIN_USE_ADVANCED_PERMS') && !DolibarrApiAccess::$user->hasRight(
'user',
'user',
'lire') && empty(DolibarrApiAccess::$user->admin)) ||
593 getDolGlobalString(
'MAIN_USE_ADVANCED_PERMS') && !DolibarrApiAccess::$user->hasRight(
'user',
'group_advance',
'read') && empty(DolibarrApiAccess::$user->admin)) {
594 throw new RestException(403,
"You are not allowed to read groups");
600 $sql =
"SELECT t.rowid";
601 $sql .=
" FROM ".MAIN_DB_PREFIX.
"usergroup AS t LEFT JOIN ".MAIN_DB_PREFIX.
"usergroup_extrafields AS ef ON (ef.fk_object = t.rowid)";
602 $sql .=
' WHERE t.entity IN ('.getEntity(
'user').
')';
604 $sql .=
" AND t.rowid IN (".$this->db->sanitize($group_ids).
")";
611 throw new RestException(400,
'Error when validating parameter sqlfilters -> '.$errormessage);
615 $sql .= $this->db->order($sortfield, $sortorder);
620 $offset = $limit * $page;
622 $sql .= $this->db->plimit($limit + 1, $offset);
625 $result = $this->db->query($sql);
629 $num = $this->db->num_rows($result);
630 $min = min($num, ($limit <= 0 ? $num : $limit));
632 $obj = $this->db->fetch_object($result);
633 $group_static =
new UserGroup($this->db);
634 if ($group_static->fetch($obj->rowid)) {
640 throw new RestException(503,
'Error when retrieve Group list : '.$this->db->lasterror());
662 if ((!
getDolGlobalString(
'MAIN_USE_ADVANCED_PERMS') && !DolibarrApiAccess::$user->hasRight(
'user',
'user',
'lire') && empty(DolibarrApiAccess::$user->admin)) ||
663 getDolGlobalString(
'MAIN_USE_ADVANCED_PERMS') && !DolibarrApiAccess::$user->hasRight(
'user',
'group_advance',
'read') && empty(DolibarrApiAccess::$user->admin)) {
664 throw new RestException(403,
"You are not allowed to read groups");
667 $group_static =
new UserGroup($this->db);
668 $result = $group_static->fetch($group,
'', $load_members);
671 throw new RestException(404,
'Group not found');
686 public function delete(
$id)
688 if (!DolibarrApiAccess::$user->hasRight(
'user',
'user',
'supprimer') && empty(DolibarrApiAccess::$user->admin)) {
689 throw new RestException(403,
'Not allowed');
691 $result = $this->useraccount->fetch(
$id);
693 throw new RestException(404,
'User not found');
697 throw new RestException(403,
'Access not allowed for login '.DolibarrApiAccess::$user->login);
699 $this->useraccount->oldcopy = clone $this->useraccount;
701 if (!$this->useraccount->delete(DolibarrApiAccess::$user)) {
702 throw new RestException(500);
708 'message' =>
'Ticket deleted'
725 unset(
$object->default_values);
726 unset(
$object->lastsearch_values);
727 unset(
$object->lastsearch_values_tmp);
731 unset(
$object->total_localtax1);
732 unset(
$object->total_localtax2);
735 unset(
$object->label_incoterms);
736 unset(
$object->location_incoterms);
738 unset(
$object->fk_delivery_address);
740 unset(
$object->all_permissions_are_loaded);
741 unset(
$object->shipping_method_id);
745 unset(
$object->clicktodial_loaded);
749 unset(
$object->pass_indatabase);
750 unset(
$object->pass_indatabase_crypted);
753 unset(
$object->clicktodial_password);
759 $canreadsalary = ((isModEnabled(
'salaries') && DolibarrApiAccess::$user->hasRight(
'salaries',
'read')) || !isModEnabled(
'salaries'));
761 if (!$canreadsalary) {
779 $cleanObjectList = array();
781 foreach ($objectList as
$object) {
782 $cleanObject = parent::_cleanObjectDatas(
$object);
784 unset($cleanObject->default_values);
785 unset($cleanObject->lastsearch_values);
786 unset($cleanObject->lastsearch_values_tmp);
788 unset($cleanObject->total_ht);
789 unset($cleanObject->total_tva);
790 unset($cleanObject->total_localtax1);
791 unset($cleanObject->total_localtax2);
792 unset($cleanObject->total_ttc);
794 unset($cleanObject->libelle_incoterms);
795 unset($cleanObject->location_incoterms);
797 unset($cleanObject->fk_delivery_address);
798 unset($cleanObject->fk_incoterms);
799 unset($cleanObject->all_permissions_are_loaded);
800 unset($cleanObject->shipping_method_id);
801 unset($cleanObject->nb_rights);
802 unset($cleanObject->search_sid);
803 unset($cleanObject->ldap_sid);
804 unset($cleanObject->clicktodial_loaded);
806 unset($cleanObject->datec);
807 unset($cleanObject->tms);
808 unset($cleanObject->members);
809 unset($cleanObject->note);
810 unset($cleanObject->note_private);
812 $cleanObjectList[] = $cleanObject;
815 return $cleanObjectList;
828 foreach (Users::$FIELDS as $field) {
829 if (!isset($data[$field])) {
830 throw new RestException(400,
"$field field missing");
832 $account[$field] = $data[$field];
if( $user->socid > 0) if(! $user->hasRight('accounting', 'chartofaccount')) $object
_filterObjectProperties($object, $properties)
Filter properties that will be returned on object.
static _checkAccessToResource($resource, $resource_id=0, $dbtablename='', $feature2='', $dbt_keyfield='fk_soc', $dbt_select='rowid')
Check access by user to a given resource.
_checkValForAPI($field, $value, $object)
Check and convert a string depending on its type/name.
Class to manage user groups.
Class to manage Dolibarr users.
put($id, $request_data=null)
Update user account.
listGroups($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $group_ids='0', $sqlfilters='', $properties='')
List Groups.
index($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $user_ids='0', $category=0, $sqlfilters='', $properties='')
List Users.
_cleanObjectDatas($object)
Clean sensible object datas.
getInfo($includepermissions=0)
Get more properties of a user.
_cleanUserGroupListDatas($objectList)
Clean sensible user group list datas.
setGroup($id, $group, $entity=1)
Add a user into a group.
setPassword($id, $send_password=false)
Update a user password.
infoGroups($group, $load_members=0)
Get properties of an group object.
_validate($data)
Validate fields before create or update object.
getByEmail($email, $includepermissions=0)
Get properties of an user object by Email.
getGroups($id)
List the groups of a user.
post($request_data=null)
Create user account.
getByLogin($login, $includepermissions=0)
Get properties of an user object by login.
__construct()
Constructor.
print $script_file $mode $langs defaultlang(is_numeric($duration_value) ? " delay=". $duration_value :"").(is_numeric($duration_value2) ? " after cd cd cd description as p label as s rowid as s nom as s email
Sender: Who sends the email ("Sender" has sent emails on behalf of "From").
forgeSQLFromUniversalSearchCriteria($filter, &$errorstr='', $noand=0, $nopar=0, $noerror=0)
forgeSQLFromUniversalSearchCriteria
getDolGlobalString($key, $default='')
Return a Dolibarr global constant string value.
sanitizeVal($out='', $check='alphanohtml', $filter=null, $options=null)
Return a sanitized or empty value after checking value against a rule.