api_users.class.php

<?php
/* Copyright (C) 2015   Jean-François Ferry       <jfefe@aternatik.fr>
 * Copyright (C) 2020-2025  Thibault FOUCART      <support@ptibogxiv.net>
 * Copyright (C) 2024-2025  MDW             <mdeweerd@users.noreply.github.com>
 * Copyright (C) 2024-2025  Frédéric France       <frederic.france@free.fr>
 * Copyright (C) 2025   William Mead        <william@m34d.com>
 * Copyright (C) 2025   Jean François Baillette   <jean-francois@swiiptel.net>
 * Copyright (C) 2026   Charlene Benke        <charlene@patas-monkey.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */
 
use Luracast\Restler\RestException;
 
require_once DOL_DOCUMENT_ROOT.'/user/class/user.class.php';
require_once DOL_DOCUMENT_ROOT.'/user/class/usergroup.class.php';
require_once DOL_DOCUMENT_ROOT.'/core/class/notify.class.php';
 
 
class Users extends DolibarrApi
{
  public static $FIELDS = array(
    'login',
  );
 
  public $useraccount;
 
  public function __construct()
  {
    global $db;
 
    $this->db = $db;
    $this->useraccount = new User($this->db);
  }
 
 
  public function index($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $user_ids = '0', $category = 0, $sqlfilters = '', $properties = '')
  {
    if (!DolibarrApiAccess::$user->hasRight('user', 'user', 'lire') && empty(DolibarrApiAccess::$user->admin)) {
      throw new RestException(403, "You are not allowed to read list of users");
    }
 
    $obj_ret = array();
 
    // case of external user, $societe param is ignored and replaced by user's socid
    //$socid = DolibarrApiAccess::$user->socid ?: $societe;
 
    $sql = "SELECT t.rowid";
    $sql .= " FROM ".MAIN_DB_PREFIX."user AS t LEFT JOIN ".MAIN_DB_PREFIX."user_extrafields AS ef ON (ef.fk_object = t.rowid)"; // Modification VMR Global Solutions to include extrafields as search parameters in the API GET call, so we will be able to filter on extrafields
    if ($category > 0) {
      $sql .= ", ".$this->db->prefix()."categorie_user as c";
    }
    $sql .= ' WHERE t.entity IN ('.getEntity('user').')';
    if ($user_ids) {
      $sql .= " AND t.rowid IN (".$this->db->sanitize($user_ids).")";
    }
 
    // Select products of given category
    if ($category > 0) {
      $sql .= " AND c.fk_categorie = ".((int) $category);
      $sql .= " AND c.fk_user = t.rowid";
    }
 
    // Add sql filters
    if ($sqlfilters) {
      // List of properties we can't filter on, whatever are permissions (to avoid guess by search binary attack)
      $forbiddenfilterfields = array(
        'pass',
        'pass_crypted',
        'pass_temp',
        'api_key',
        'openid'
      );
      $canreadsalary = ((isModEnabled('salaries') && DolibarrApiAccess::$user->hasRight('salaries', 'read')) || !isModEnabled('salaries'));
      if (!$canreadsalary) {
        $forbiddenfilterfields[] = 'salary';
        $forbiddenfilterfields[] = 'salaryextra';
        $forbiddenfilterfields[] = 'thm';
        $forbiddenfilterfields[] = 'tjm';
      }
 
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage, 0, 0, 0, $forbiddenfilterfields);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
    $sql .= $this->db->order($sortfield, $sortorder);
    if ($limit) {
      if ($page < 0) {
        $page = 0;
      }
      $offset = $limit * $page;
 
      $sql .= $this->db->plimit($limit + 1, $offset);
    }
 
    $result = $this->db->query($sql);
 
    if ($result) {
      $i = 0;
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      while ($i < $min) {
        $obj = $this->db->fetch_object($result);
        $user_static = new User($this->db);
        if ($user_static->fetch($obj->rowid)) {
          $obj_ret[] = $this->_filterObjectProperties($this->_cleanObjectDatas($user_static), $properties);
        }
        $i++;
      }
    } else {
      throw new RestException(503, 'Error when retrieve User list : '.$this->db->lasterror());
    }
 
    return $obj_ret;
  }
 
  public function get($id, $includepermissions = 0)
  {
    if ($id == 0) {
      throw new RestException(400, 'No user with id=0 can exist');
    }
 
    if (!DolibarrApiAccess::$user->hasRight('user', 'user', 'lire') && empty(DolibarrApiAccess::$user->admin) && DolibarrApiAccess::$user->id != $id) {
      throw new RestException(403, 'Not allowed');
    }
 
    if ($id == 0) {
      $result = $this->useraccount->initAsSpecimen();
    } else {
      $result = $this->useraccount->fetch($id);
    }
    if (!$result) {
      throw new RestException(404, 'User not found');
    }
 
    if ($id > 0 && !DolibarrApi::_checkAccessToResource('user', $this->useraccount->id, 'user')) {
      throw new RestException(403, 'Access on this object not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    if ($includepermissions) {
      $this->useraccount->loadRights();
    }
 
    return $this->_cleanObjectDatas($this->useraccount);
  }
 
  public function getByLogin($login, $includepermissions = 0)
  {
    if (empty($login)) {
      throw new RestException(400, 'Bad parameters');
    }
 
    if (!DolibarrApiAccess::$user->hasRight('user', 'user', 'lire') && empty(DolibarrApiAccess::$user->admin) && DolibarrApiAccess::$user->login != $login) {
      throw new RestException(403, 'Not allowed');
    }
 
    $result = $this->useraccount->fetch(0, $login);
    if (!$result) {
      throw new RestException(404, 'User not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('user', $this->useraccount->id, 'user')) {
      throw new RestException(403, 'Access on this object not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    if ($includepermissions) {
      $this->useraccount->loadRights();
    }
 
    return $this->_cleanObjectDatas($this->useraccount);
  }
 
  public function getByEmail($email, $includepermissions = 0)
  {
    if (empty($email)) {
      throw new RestException(400, 'Bad parameters');
    }
 
    if (!DolibarrApiAccess::$user->hasRight('user', 'user', 'lire') && empty(DolibarrApiAccess::$user->admin) && DolibarrApiAccess::$user->email != $email) {
      throw new RestException(403, 'Not allowed');
    }
 
    $result = $this->useraccount->fetch(0, '', '', 0, -1, $email);
    if (!$result) {
      throw new RestException(404, 'User not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('user', $this->useraccount->id, 'user')) {
      throw new RestException(403, 'Access on this object not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    if ($includepermissions) {
      $this->useraccount->loadRights();
    }
 
    return $this->_cleanObjectDatas($this->useraccount);
  }
 
  public function getInfo($includepermissions = 0)
  {
    if (!DolibarrApiAccess::$user->hasRight('user', 'self', 'creer') && !DolibarrApiAccess::$user->hasRight('user', 'user', 'lire') && empty(DolibarrApiAccess::$user->admin)) {
      throw new RestException(403, 'Not allowed');
    }
 
    $apiUser = DolibarrApiAccess::$user;
 
    $result = $this->useraccount->fetch($apiUser->id);
    if (!$result) {
      throw new RestException(404, 'User not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('user', $this->useraccount->id, 'user')) {
      throw new RestException(403, 'Access on this object not allowed to current logged user');
    }
 
    if ($includepermissions) {
      $this->useraccount->loadRights();
    }
 
    $usergroup = new UserGroup($this->db);
    $userGroupList = $usergroup->listGroupsForUser($apiUser->id, false);
    if (!is_array($userGroupList)) {
      throw new RestException(404, 'User group not found');
    }
 
    $this->useraccount->user_group_list = $this->_cleanUserGroupListDatas($userGroupList);
 
    return $this->_cleanObjectDatas($this->useraccount);
  }
 
  public function post($request_data = null)
  {
    // Check user authorization
    if (!DolibarrApiAccess::$user->hasRight('user', 'user', 'creer') && empty(DolibarrApiAccess::$user->admin)) {
      throw new RestException(403, "User creation not allowed for login ".DolibarrApiAccess::$user->login);
    }
 
    // check mandatory fields
    if (!isset($request_data["login"]))
      throw new RestException(500, "login field missing");
    /*if (!isset($request_data["password"]))
      throw new RestException(400, "password field missing");
    if (!isset($request_data["lastname"]))
       throw new RestException(400, "lastname field missing");*/
 
    //assign field values
    foreach ($request_data as $field => $value) {
      if (in_array($field, array('pass_crypted', 'pass_indatabase', 'pass_indatabase_crypted', 'pass_temp', 'api_key', 'openid'))) {
        // This properties can't be set/modified with API
        throw new RestException(405, 'The property '.$field." can't be set/modified using the APIs");
      }
      /*if ($field == 'pass') {
        if (!DolibarrApiAccess::$user->hasRight('user', 'user', 'password')) {
          throw new RestException(403, 'You are not allowed to modify/set password of other users');
          continue;
        }
      }
      */
      $canreadsalary = ((isModEnabled('salaries') && DolibarrApiAccess::$user->hasRight('salaries', 'read')) || !isModEnabled('salaries'));
      if (!$canreadsalary) {
        if (in_array($field, array('salary', 'salaryextra', 'thm', 'tjm'))) {
          // This properties can't be set/modified with API
          throw new RestException(405, 'The property '.$field." can't be set/modified using the APIs with permission on salaries");
        }
      }
 
      if ($field === 'caller') {
        // Add a mention of caller so on trigger called after action, we can filter to avoid a loop if we try to sync back again with the caller
        $this->useraccount->context['caller'] = sanitizeVal($request_data['caller'], 'aZ09');
        continue;
      }
 
      if (DolibarrApiAccess::$user->admin) {  // If user for API is admin
        if ($field == 'admin' && $value != $this->useraccount->admin && empty($value)) {
          throw new RestException(403, 'Reseting the admin status of a user is not possible using the API');
        }
      } else {
        if ($field == 'admin' && $value != $this->useraccount->admin) {
          throw new RestException(403, 'Only an admin user can modify the admin status of another user');
        }
      }
 
      $this->useraccount->$field = $this->_checkValForAPI($field, $value, $this->useraccount);
    }
 
    if ($this->useraccount->create(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500, 'Error creating', array_merge(array($this->useraccount->error), $this->useraccount->errors));
    }
    return $this->useraccount->id;
  }
 
 
  public function put($id, $request_data = null)
  {
    $isSelfUpdate = ((int) $id === (int) DolibarrApiAccess::$user->id);
 
    // Check user authorization
    if (
      !DolibarrApiAccess::$user->hasRight('user', 'user', 'creer')
      && !DolibarrApiAccess::$user->hasRight('user', 'user', 'write')
      && !(
        $isSelfUpdate
        && (
          DolibarrApiAccess::$user->hasRight('user', 'self', 'creer')
          || DolibarrApiAccess::$user->hasRight('user', 'self', 'write')
        )
      )
      && empty(DolibarrApiAccess::$user->admin)
    ) {
      throw new RestException(403, "User update not allowed");
    }
 
    $result = $this->useraccount->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Account not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('user', $this->useraccount->id, 'user')) {
      throw new RestException(403, 'Access on this object not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    foreach ($request_data as $field => $value) {
      if (in_array($field, array('pass_crypted', 'pass_indatabase', 'pass_indatabase_crypted', 'pass_temp', 'api_key', 'openid'))) {
        // This properties can't be set/modified with API
        throw new RestException(405, 'The property '.$field." can't be set/modified using the APIs");
      }
 
      $canreadsalary = ((isModEnabled('salaries') && DolibarrApiAccess::$user->hasRight('salaries', 'read')) || !isModEnabled('salaries'));
      if (!$canreadsalary) {
        if (in_array($field, array('salary', 'salaryextra', 'thm', 'tjm'))) {
          // This properties can't be set/modified with API
          throw new RestException(405, 'The property '.$field." can't be set/modified using the APIs with permission on salaries");
        }
      }
 
      if ($field == 'id') {
        continue;
      }
      if ($field == 'pass') {
        if ($this->useraccount->id != DolibarrApiAccess::$user->id && !DolibarrApiAccess::$user->hasRight('user', 'user', 'password')) {
          throw new RestException(403, 'You are not allowed to modify password of other users');
        }
        if ($this->useraccount->id == DolibarrApiAccess::$user->id && !DolibarrApiAccess::$user->hasRight('user', 'self', 'password')) {
          throw new RestException(403, 'You are not allowed to modify your own password');
        }
      }
      if ($field === 'caller') {
        // Add a mention of caller so on trigger called after action, we can filter to avoid a loop if we try to sync back again with the caller
        $this->useraccount->context['caller'] = sanitizeVal($request_data['caller'], 'aZ09');
        continue;
      }
      if ($field == 'array_options' && is_array($value)) {
        foreach ($value as $index => $val) {
          $this->useraccount->array_options[$index] = $this->_checkValExtrafieldsForAPI($index, $val, $this->useraccount);
        }
        continue;
      }
 
      if (DolibarrApiAccess::$user->admin) {  // If user for API is admin
        if ($field == 'admin' && $value != $this->useraccount->admin && empty($value)) {
          throw new RestException(403, 'Reseting the admin status of a user is not possible using the API');
        }
      } else {
        if ($field == 'admin' && $value != $this->useraccount->admin) {
          throw new RestException(403, 'Only an admin user can modify the admin status of another user');
        }
      }
      if ($field == 'entity' && $value != $this->useraccount->entity) {
        throw new RestException(403, 'Changing entity of a user using the APIs is not possible');
      }
 
      // The status must be updated using setstatus() because it
      // is not handled by the update() method.
      if ($field == 'statut' || $field == 'status') {
        $result = $this->useraccount->setstatus($value);
        if ($result < 0) {
          throw new RestException(500, 'Error when updating status of user: '.$this->useraccount->error);
        }
      } else {
        $this->useraccount->$field = $this->_checkValForAPI($field, $value, $this->useraccount);
      }
    }
 
    // If there is no error, update() returns the number of affected
    // rows so if the update is a no op, the return value is zezo.
    if ($this->useraccount->update(DolibarrApiAccess::$user) >= 0) {
      return $this->get($id);
    } else {
      throw new RestException(500, $this->useraccount->error);
    }
  }
 
  public function setPassword($id, $send_password = false)
  {
    if (!getDolGlobalInt('API_ENABLE_LOGIN_API')) {
      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.");
    }
 
    if (!getDolGlobalString('API_ALLOW_PASSWORD_RESET')) {
      throw new RestException(403, "Error: password reset APIs are disabled by default. To allow this, the option API_ALLOW_PASSWORD_RESET must be set.");
    }
 
    if (!DolibarrApiAccess::$user->hasRight('user', 'user', 'creer') && empty(DolibarrApiAccess::$user->admin)) {
      throw new RestException(403, "setPassword on user not allowed for login ".DolibarrApiAccess::$user->login);
    }
 
    $result = $this->useraccount->fetch($id);
    if (!$result) {
      throw new RestException(404, 'User not found, no password changed');
    }
 
    if (!DolibarrApi::_checkAccessToResource('user', $this->useraccount->id, 'user')) {
      throw new RestException(403, 'Access on this object not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $newpassword = $this->useraccount->setPassword($this->useraccount, ''); // This will generate a new password
    if (is_int($newpassword) && $newpassword < 0) {
      throw new RestException(500, 'ErrorFailedToSetNewPassword'.$this->useraccount->error);
    } else {
      // Success
      if ($send_password) {
        if ($this->useraccount->send_password($this->useraccount, $newpassword) > 0) {
          return 2;
        } else {
          throw new RestException(500, 'ErrorFailedSendingNewPassword - '.$this->useraccount->error);
        }
      } else {
        return 1;
      }
    }
  }
 
  public function getGroups($id)
  {
    if ($id == 0) {
      throw new RestException(400, 'No user with id=0 can exist');
    }
 
    if (!DolibarrApiAccess::$user->hasRight('user', 'user', 'lire') && empty(DolibarrApiAccess::$user->admin)) {
      throw new RestException(403);
    }
 
    $user = new User($this->db);
    $result = $user->fetch($id);
    if (!$result) {
      throw new RestException(404, 'User not found');
    }
    if (!DolibarrApi::_checkAccessToResource('user', $user->id, 'user')) {
      throw new RestException(403, 'Access on this object not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $usergroup = new UserGroup($this->db);
    $groups = $usergroup->listGroupsForUser($id, false);
    $obj_ret = array();
    foreach ($groups as $group) {
      $obj_ret[] = $this->_cleanObjectDatas($group);
    }
    return $obj_ret;
  }
 
 
  public function setGroup($id, $group, $entity = 1)
  {
    global $conf;
 
    if (!DolibarrApiAccess::$user->hasRight('user', 'user', 'creer') && empty(DolibarrApiAccess::$user->admin)) {
      throw new RestException(403, 'setGroup on users not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->useraccount->fetch($id);
    if (!$result) {
      throw new RestException(404, 'User not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('user', $this->useraccount->id, 'user')) {
      throw new RestException(403, 'Access on this object not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    if (isModEnabled('multicompany') && getDolGlobalString('MULTICOMPANY_TRANSVERSE_MODE') && !empty(DolibarrApiAccess::$user->admin) && empty(DolibarrApiAccess::$user->entity)) {
      $entity = (!empty($entity) ? (int) $entity : $conf->entity);
    } else {
      // When using API, action is done on entity of logged user because a user of entity X with permission to create user should not be able to
      // hack the security by giving himself permissions on another entity.
      $entity = (((int) DolibarrApiAccess::$user->entity) > 0 ? (int) DolibarrApiAccess::$user->entity : $conf->entity);
    }
 
    $result = $this->useraccount->SetInGroup($group, $entity);
    if (!($result > 0)) {
      throw new RestException(500, $this->useraccount->error);
    }
 
    return 1;
  }
 
  public function postGroups($request_data = null)
  {
    // Check user authorization
    if (!DolibarrApiAccess::$user->hasRight('user', 'group_advance', 'write') && empty(DolibarrApiAccess::$user->admin)) {
      throw new RestException(403, "Usergroup creation not allowed for login ".DolibarrApiAccess::$user->login);
    }
    $usergroup = new UserGroup($this->db);
    foreach ($request_data as $field => $value) {
      if ($field === 'caller') {
        // Add a mention of caller so on trigger called after action, we can filter to avoid a loop if we try to sync back again with the caller
        $usergroup->context['caller'] = sanitizeVal($request_data['caller'], 'aZ09');
        continue;
      }
      if ($field == 'id') {
        throw new RestException(400, 'Creating with id field is forbidden');
      }
 
      $usergroup->$field = $this->_checkValForAPI($field, $value, $usergroup);
    }
 
    if ($usergroup->create(1) < 0) {
      throw new RestException(500, 'Error creating', array_merge(array($usergroup->error), $usergroup->errors));
    }
    return $usergroup->id;
  }
 
  public function putGroups($group, $request_data = null)
  {
    // Check user authorization
    if (!DolibarrApiAccess::$user->hasRight('user', 'group_advance', 'write') && empty(DolibarrApiAccess::$user->admin)) {
      throw new RestException(403, "Usergroup update not allowed");
    }
 
    $usergroup = new UserGroup($this->db);
 
    $result = $usergroup->fetch($group);
    if ($result < 1) {
      throw new RestException(404, 'Usergroup not found');
    }
 
    foreach ($request_data as $field => $value) {
      if ($field == 'id') {
        throw new RestException(400, 'Updating with id field is forbidden');
      }
      if ($field === 'caller') {
        // Add a mention of caller so on trigger called after action, we can filter to avoid a loop if we try to sync back again with the caller
        $usergroup->context['caller'] = sanitizeVal($request_data['caller'], 'aZ09');
        continue;
      }
 
      if ($field == 'entity' && $value != $usergroup->entity) {
        throw new RestException(403, 'Changing entity of a user using the APIs is not possible');
      }
 
      $usergroup->$field = $this->_checkValForAPI($field, $value, $usergroup);
    }
 
    // If there is no error, update() returns the number of affected
    // rows so if the update is a no op, the return value is zezo.
    if ($usergroup->update() >= 0) {
      return $this->infoGroups($group);
    } else {
      throw new RestException(500, $usergroup->error);
    }
  }
 
  public function removeUserFromGroup($id, $group)
  {
    if (!DolibarrApiAccess::$user->admin) {
      throw new RestException(403, 'Only admin can remove users from groups');
    }
 
    $sql = "DELETE FROM " . MAIN_DB_PREFIX . "usergroup_user";
    $sql .= " WHERE fk_user = " . ((int) $id);
    $sql .= " AND fk_usergroup = " . ((int) $group);
 
    $resql = $this->db->query($sql);
 
    if (!$resql) {
      throw new RestException(503, 'DB error: ' . $this->db->lasterror());
    }
 
    return [
      'success' => true,
      'message' => "User $id removed from group $group"
    ];
  }
 
  public function listGroups($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $group_ids = '0', $sqlfilters = '', $properties = '')
  {
    $obj_ret = array();
 
    if ((!getDolGlobalString('MAIN_USE_ADVANCED_PERMS') && !DolibarrApiAccess::$user->hasRight('user', 'user', 'lire') && empty(DolibarrApiAccess::$user->admin)) ||
      getDolGlobalString('MAIN_USE_ADVANCED_PERMS') && !DolibarrApiAccess::$user->hasRight('user', 'group_advance', 'read') && empty(DolibarrApiAccess::$user->admin)) {
      throw new RestException(403, "You are not allowed to read groups");
    }
 
    // case of external user, $societe param is ignored and replaced by user's socid
    //$socid = DolibarrApiAccess::$user->socid ?: $societe;
 
    $sql = "SELECT t.rowid";
    $sql .= " FROM ".MAIN_DB_PREFIX."usergroup AS t LEFT JOIN ".MAIN_DB_PREFIX."usergroup_extrafields AS ef ON (ef.fk_object = t.rowid)"; // Modification VMR Global Solutions to include extrafields as search parameters in the API GET call, so we will be able to filter on extrafields
    $sql .= ' WHERE t.entity IN ('.getEntity('user').')';
    if ($group_ids) {
      $sql .= " AND t.rowid IN (".$this->db->sanitize($group_ids).")";
    }
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
    $sql .= $this->db->order($sortfield, $sortorder);
    if ($limit) {
      if ($page < 0) {
        $page = 0;
      }
      $offset = $limit * $page;
 
      $sql .= $this->db->plimit($limit + 1, $offset);
    }
 
    $result = $this->db->query($sql);
 
    if ($result) {
      $i = 0;
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      while ($i < $min) {
        $obj = $this->db->fetch_object($result);
        $group_static = new UserGroup($this->db);
        if ($group_static->fetch($obj->rowid)) {
          $obj_ret[] = $this->_filterObjectProperties($this->_cleanObjectDatas($group_static), $properties);
        }
        $i++;
      }
    } else {
      throw new RestException(503, 'Error when retrieve Group list : '.$this->db->lasterror());
    }
 
    return $obj_ret;
  }
 
  public function infoGroups($group, $load_members = 0, $includepermissions = 0)
  {
    if ($group == 0) {
      throw new RestException(400, 'No usergroup with id=0 can exist');
    }
 
    if ((!getDolGlobalString('MAIN_USE_ADVANCED_PERMS') && !DolibarrApiAccess::$user->hasRight('user', 'user', 'lire') && empty(DolibarrApiAccess::$user->admin)) ||
      getDolGlobalString('MAIN_USE_ADVANCED_PERMS') && !DolibarrApiAccess::$user->hasRight('user', 'group_advance', 'read') && empty(DolibarrApiAccess::$user->admin)) {
      throw new RestException(403, "You are not allowed to read groups");
    }
 
    $group_static = new UserGroup($this->db);
    $result = $group_static->fetch($group, '', (bool) $load_members);
 
    if ($result < 1) {
      throw new RestException(404, 'Usergroup not found');
    }
 
    if ($includepermissions) {
      $group_static->loadRights();
    }
 
    if ($load_members > 0 && is_array($group_static->members) && count($group_static->members) > 0) {
      foreach ($group_static->members as &$member) {
        $member = $this->_cleanObjectDatas($member);
      }
    }
 
    return $this->_cleanUserGroup($group_static);
  }
 
  public function delete($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('user', 'user', 'supprimer') && empty(DolibarrApiAccess::$user->admin)) {
      throw new RestException(403, 'Not allowed');
    }
    $result = $this->useraccount->fetch($id);
    if (!$result) {
      throw new RestException(404, 'User not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('user', $this->useraccount->id, 'user')) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
    $this->useraccount->oldcopy = clone $this->useraccount; // @phan-suppress-current-line PhanTypeMismatchProperty
 
    if (!$this->useraccount->delete(DolibarrApiAccess::$user)) {
      throw new RestException(500);
    }
 
    return array(
      'success' => array(
        'code' => 200,
        'message' => 'User deleted'
      )
    );
  }
 
  public function deleteGroups($group)
  {
    if (!DolibarrApiAccess::$user->hasRight('user', 'group_advance', 'delete') && empty(DolibarrApiAccess::$user->admin)) {
      throw new RestException(403, 'Not allowed');
    }
 
    $usergroup = new UserGroup($this->db);
 
    $result = $usergroup->fetch($group);
    if ($result < 0) {
      throw new RestException(404, 'Usergroup not found');
    }
 
    if (!$usergroup->delete(DolibarrApiAccess::$user)) {
      throw new RestException(500);
    }
 
    return array(
      'success' => array(
        'code' => 200,
        'message' => 'Usergroup deleted'
      )
    );
  }
 
  public function getUserNotification($id)
  {
    if (empty($id)) {
      throw new RestException(400, 'No user with id=0 can exist');
    }
    if (!DolibarrApiAccess::$user->hasRight('user', 'user', 'lire') && empty(DolibarrApiAccess::$user->admin)) {
      throw new RestException(403);
    }
    if (!DolibarrApi::_checkAccessToResource('user', $id)) {
      throw new RestException(403, 'Access on this object not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $sql = "SELECT rowid as id, fk_action as event, fk_user, type, datec, tms";
    $sql .= " FROM ".MAIN_DB_PREFIX."notify_def";
    $sql .= " WHERE fk_user  = ".((int) $id);
 
    $result = $this->db->query($sql);
    if ($this->db->num_rows($result) == 0) {
      throw new RestException(404, 'Notification not found');
    }
 
    $i = 0;
 
    $notifications = array();
 
    if ($result) {
      $num = $this->db->num_rows($result);
      //$min = min($num, ($limit <= 0 ? $num : $limit));
      $min = $num;
      while ($i < $min) {
        $obj = $this->db->fetch_object($result);
        $notifications[] = $obj;
        $i++;
      }
    } else {
      throw new RestException(404, 'No notifications found');
    }
 
    $fields = array('id', 'fk_user', 'event', 'datec', 'tms', 'type');
 
    $returnNotifications = array();
 
    foreach ($notifications as $notification) {
      $object = array();
      foreach ($notification as $key => $value) {
        if (in_array($key, $fields)) {
          $object[$key] = $value;
        }
      }
      $returnNotifications[] = $object;
    }
 
    // Too complex for phan ?: @phan-suppress-next-line PhanTypeMismatchReturn
    return $returnNotifications;
  }
 
  public function createUserNotification($id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight('user', 'user', 'creer')) {
      throw new RestException(403, "User has no right to update users");
    }
    if ($this->useraccount->fetch($id) <= 0) {
      throw new RestException(404, 'Error creating User Notification, User doesn\'t exists');
    }
    $notification = new Notify($this->db);
 
    $notification->fk_user = $id;
 
    foreach ($request_data as $field => $value) {
      $notification->$field = $this->_checkValForAPI($field, $value, $notification);
    }
 
    $event = $notification->event;
    if (!$event) {
      throw new RestException(500, 'Error creating User Notification, request_data missing event');
    }
    $fk_user = $notification->fk_user;
 
    $exists_sql = "SELECT rowid, fk_action as event, fk_user, type, datec, tms as datem";
    $exists_sql .= " FROM ".MAIN_DB_PREFIX."notify_def";
    $exists_sql .= " WHERE fk_action = '".$this->db->escape((string) $event)."'";
    $exists_sql .= " AND fk_user = '".$this->db->escape((string) $fk_user)."'";
 
    $exists_result = $this->db->query($exists_sql);
    if ($this->db->num_rows($exists_result) > 0) {
      throw new RestException(403, 'Notification already exists');
    }
 
    if ($notification->create(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500, 'Error creating User Notification');
    }
 
    if ($notification->update(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500, 'Error updating values');
    }
 
    return $this->_cleanObjectDatas($notification);
  }
 
  public function createUserNotificationByCode($id, $code, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight('user', 'user', 'creer')) {
      throw new RestException(403, "User has no right to update users");
    }
    if ($this->useraccount->fetch($id) <= 0) {
      throw new RestException(404, 'Error creating User Notification, User doesn\'t exists');
    }
    $notification = new Notify($this->db);
    $notification->fk_user = $id;
 
    $sql = "SELECT t.rowid as id FROM ".MAIN_DB_PREFIX."c_action_trigger as t";
    $sql .= " WHERE t.code = '".$this->db->escape($code)."'";
 
    $result = $this->db->query($sql);
    if ($this->db->num_rows($result) == 0) {
      throw new RestException(404, 'Action Trigger code not found');
    }
 
    $notification->event = $this->db->fetch_row($result)[0];
    foreach ($request_data as $field => $value) {
      if ($field === 'event') {
        throw new RestException(500, 'Error creating User Notification, request_data contains event key');
      }
      if ($field === 'fk_action') {
        throw new RestException(500, 'Error creating User Notification, request_data contains fk_action key');
      }
      $notification->$field = $this->_checkValForAPI($field, $value, $notification);
    }
 
    $event = $notification->event;
    $fk_user = $notification->fk_user;
 
    $exists_sql = "SELECT rowid, fk_action as event, fk_user, type, datec, tms as datem";
    $exists_sql .= " FROM ".MAIN_DB_PREFIX."notify_def";
    $exists_sql .= " WHERE fk_action = '".$this->db->escape((string) $event)."'";
    $exists_sql .= " AND fk_user = '".$this->db->escape((string) $fk_user)."'";
 
    $exists_result = $this->db->query($exists_sql);
    if ($this->db->num_rows($exists_result) > 0) {
      throw new RestException(403, 'Notification already exists');
    }
 
    if ($notification->create(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500, 'Error creating User Notification, are request_data well formed?');
    }
 
    if ($notification->update(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500, 'Error updating values');
    }
 
    return $this->_cleanObjectDatas($notification);
  }
 
  public function deleteUserNotification($id, $notification_id)
  {
    if (!DolibarrApiAccess::$user->hasRight('user', 'user', 'creer')) {
      throw new RestException(403, "User has no right to update users");
    }
 
    $notification = new Notify($this->db);
 
    $notification->fetch($notification_id);
 
    $fk_user = (int) $notification->fk_user;
 
    if ($fk_user == $id) {
      return $notification->delete(DolibarrApiAccess::$user);
    } else {
      throw new RestException(403, "Not allowed due to bad consistency of input data");
    }
  }
 
  public function updateUserNotification($id, $notification_id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight('user', 'user', 'creer')) {
      throw new RestException(403, "User has no right to update users");
    }
    if ($this->useraccount->fetch($id) <= 0) {
      throw new RestException(404, 'Error creating Notification, User doesn\'t exists');
    }
    $notification = new Notify($this->db);
 
    // @phan-suppress-next-line PhanPluginSuspiciousParamPosition
    $notification->fetch($notification_id, $id);
 
    if ($notification->fk_user != $id) {
      throw new RestException(403, "Not allowed due to bad consistency of input data");
    }
 
    foreach ($request_data as $field => $value) {
      $notification->$field = $this->_checkValForAPI($field, $value, $notification);
    }
 
    if ($notification->update(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500, 'Error updating values');
    }
 
    return $this->_cleanObjectDatas($notification);
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  protected function _cleanObjectDatas($object)
  {
    // phpcs:enable
    $object = parent::_cleanObjectDatas($object);
 
    unset($object->default_values);
    unset($object->lastsearch_values);
    unset($object->lastsearch_values_tmp);
 
    unset($object->total_ht);
    unset($object->total_tva);
    unset($object->total_localtax1);
    unset($object->total_localtax2);
    unset($object->total_ttc);
 
    unset($object->label_incoterms);
    unset($object->location_incoterms);
 
    unset($object->fk_delivery_address);
    unset($object->fk_incoterms);
    unset($object->all_permissions_are_loaded);
    unset($object->shipping_method_id);
    unset($object->nb_rights);
    unset($object->search_sid);
    unset($object->ldap_sid);
    unset($object->clicktodial_loaded);
 
    unset($object->lines);
    unset($object->model_pdf);
 
    // List of properties never returned by API, whatever are permissions
    unset($object->pass);
    unset($object->pass_indatabase);
    unset($object->pass_indatabase_crypted);
    unset($object->pass_temp);
    unset($object->api_key);
    unset($object->clicktodial_password);
    unset($object->openid);
 
    $canreadsalary = ((isModEnabled('salaries') && DolibarrApiAccess::$user->hasRight('salaries', 'read')) || !isModEnabled('salaries'));
    if (!$canreadsalary) {
      unset($object->salary);
      unset($object->salaryextra);
      unset($object->thm);
      unset($object->tjm);
    }
 
    return $object;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  private function _cleanUserGroup($object)
  {
    // phpcs:enable
    $object = parent::_cleanObjectDatas($object);
 
    unset($object->actiontypecode);
    unset($object->all_permissions_are_loaded);
    unset($object->barcode_type_coder);
    unset($object->barcode_type);
    unset($object->canvas);
    unset($object->civility_code);
    unset($object->civility_id);
    unset($object->clicktodial_loaded);
    unset($object->cond_reglement_id);
    unset($object->cond_reglement_supplier_id);
    unset($object->contact_id);
    unset($object->contacts_ids_internal);
    unset($object->contacts_ids);
    unset($object->country_code);
    unset($object->country_id);
    unset($object->date_cloture);
    unset($object->date_creation);
    unset($object->date_modification);
    unset($object->date_validation);
    unset($object->default_values);
    unset($object->demand_reason_id);
    unset($object->deposit_percent);
    unset($object->extraparams);
    unset($object->firstname);
    unset($object->fk_account);
    unset($object->fk_delivery_address);
    unset($object->fk_incoterms);
    unset($object->fk_multicurrency);
    unset($object->fk_project);
    unset($object->fk_user_creat);
    unset($object->fk_user_modif);
    unset($object->globalgroup);
    unset($object->import_key);
    unset($object->last_main_doc);
    unset($object->lastname);
    unset($object->lastsearch_values_tmp);
    unset($object->lastsearch_values);
    unset($object->ldap_sid);
    unset($object->libelle_incoterms);
    unset($object->lines);
    unset($object->linkedObjectsIds);
    unset($object->location_incoterms);
    unset($object->members);
    unset($object->mode_reglement_id);
    unset($object->module);
    unset($object->multicurrency_code);
    unset($object->multicurrency_total_ht);
    unset($object->multicurrency_total_localtax1);
    unset($object->multicurrency_total_localtax2);
    unset($object->multicurrency_total_ttc);
    unset($object->multicurrency_total_tva);
    unset($object->multicurrency_tx);
    unset($object->nb_rights);
    unset($object->nb_users);
    unset($object->note_public);
    unset($object->origin_id);
    unset($object->origin_type);
    unset($object->product);
    unset($object->ref_ext);
    unset($object->ref);
    unset($object->region_id);
    unset($object->retained_warranty_fk_cond_reglement);
    unset($object->rights);
    unset($object->search_sid);
    unset($object->shipping_method_id);
    unset($object->shipping_method);
    unset($object->specimen);
    unset($object->state_id);
    unset($object->status);
    unset($object->statut);
    unset($object->total_ht);
    unset($object->total_localtax1);
    unset($object->total_localtax2);
    unset($object->total_ttc);
    unset($object->total_tva);
    unset($object->totalpaid_multicurrency);
    unset($object->totalpaid);
    unset($object->transport_mode_id);
    unset($object->TRIGGER_PREFIX);
    unset($object->user_closing_id);
    unset($object->user_creation_id);
    unset($object->user_modification_id);
    unset($object->user_validation_id);
    unset($object->user);
    unset($object->usergroup_entity);
    unset($object->warehouse_id);
 
    return $object;
  }
 
  private function _cleanUserGroupListDatas($objectList)
  {
    $cleanObjectList = array();
 
    foreach ($objectList as $object) {
      $cleanObject = parent::_cleanObjectDatas($object);
 
      unset($cleanObject->default_values);
      unset($cleanObject->lastsearch_values);
      unset($cleanObject->lastsearch_values_tmp);
 
      unset($cleanObject->total_ht);
      unset($cleanObject->total_tva);
      unset($cleanObject->total_localtax1);
      unset($cleanObject->total_localtax2);
      unset($cleanObject->total_ttc);
 
      unset($cleanObject->libelle_incoterms);
      unset($cleanObject->location_incoterms);
 
      unset($cleanObject->fk_delivery_address);
      unset($cleanObject->fk_incoterms);
      unset($cleanObject->all_permissions_are_loaded);
      unset($cleanObject->shipping_method_id);
      unset($cleanObject->nb_rights);
      unset($cleanObject->search_sid);
      unset($cleanObject->ldap_sid);
      unset($cleanObject->clicktodial_loaded);
 
      unset($cleanObject->datec);
      unset($cleanObject->tms);
      unset($cleanObject->members);
      unset($cleanObject->note);
      unset($cleanObject->note_private);
 
      $cleanObjectList[] = $cleanObject;
    }
 
    return $cleanObjectList;
  }
 
  private function _validate($data) // @phpstan-ignore-line
  {
    $account = array();
    foreach (Users::$FIELDS as $field) {
      if (!isset($data[$field])) {
        throw new RestException(400, "$field field missing");
      }
      $account[$field] = $data[$field];
    }
    return $account;
  }
}