forked from Wavyzz/dolibarr
627 lines
18 KiB
PHP
627 lines
18 KiB
PHP
<?php
|
|
/* Copyright (C) 2015 Jean-François Ferry <jfefe@aternatik.fr>
|
|
*
|
|
* 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';
|
|
|
|
/**
|
|
* API class for users
|
|
*
|
|
* @access protected
|
|
* @class DolibarrApiAccess {@requires user,external}
|
|
*/
|
|
class Users extends DolibarrApi
|
|
{
|
|
/**
|
|
*
|
|
* @var array $FIELDS Mandatory fields, checked when create and update object
|
|
*/
|
|
static $FIELDS = array(
|
|
'login',
|
|
);
|
|
|
|
/**
|
|
* @var User $user {@type User}
|
|
*/
|
|
public $useraccount;
|
|
|
|
/**
|
|
* Constructor
|
|
*/
|
|
public function __construct()
|
|
{
|
|
global $db, $conf;
|
|
$this->db = $db;
|
|
$this->useraccount = new User($this->db);
|
|
}
|
|
|
|
|
|
/**
|
|
* List Users
|
|
*
|
|
* Get a list of Users
|
|
*
|
|
* @param string $sortfield Sort field
|
|
* @param string $sortorder Sort order
|
|
* @param int $limit Limit for list
|
|
* @param int $page Page number
|
|
* @param string $user_ids User ids filter field. Example: '1' or '1,2,3' {@pattern /^[0-9,]*$/i}
|
|
* @param string $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.date_creation:<:'20160101')"
|
|
* @return array Array of User objects
|
|
*/
|
|
public function index($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $user_ids = 0, $sqlfilters = '')
|
|
{
|
|
global $db, $conf;
|
|
|
|
$obj_ret = array();
|
|
|
|
if (!DolibarrApiAccess::$user->rights->user->user->lire) {
|
|
throw new RestException(401, "You are not allowed to read list of users");
|
|
}
|
|
|
|
// case of external user, $societe param is ignored and replaced by user's socid
|
|
//$socid = DolibarrApiAccess::$user->socid ? DolibarrApiAccess::$user->socid : $societe;
|
|
|
|
$sql = "SELECT t.rowid";
|
|
$sql .= " FROM ".MAIN_DB_PREFIX."user as t";
|
|
$sql .= ' WHERE t.entity IN ('.getEntity('user').')';
|
|
if ($user_ids) $sql .= " AND t.rowid IN (".$user_ids.")";
|
|
// Add sql filters
|
|
if ($sqlfilters)
|
|
{
|
|
if (!DolibarrApi::_checkFilters($sqlfilters))
|
|
{
|
|
throw new RestException(503, 'Error when validating parameter sqlfilters '.$sqlfilters);
|
|
}
|
|
$regexstring = '\(([^:\'\(\)]+:[^:\'\(\)]+:[^:\(\)]+)\)';
|
|
$sql .= " AND (".preg_replace_callback('/'.$regexstring.'/', 'DolibarrApi::_forge_criteria_callback', $sqlfilters).")";
|
|
}
|
|
|
|
$sql .= $db->order($sortfield, $sortorder);
|
|
if ($limit) {
|
|
if ($page < 0)
|
|
{
|
|
$page = 0;
|
|
}
|
|
$offset = $limit * $page;
|
|
|
|
$sql .= $db->plimit($limit + 1, $offset);
|
|
}
|
|
|
|
$result = $db->query($sql);
|
|
|
|
if ($result)
|
|
{
|
|
$i = 0;
|
|
$num = $db->num_rows($result);
|
|
$min = min($num, ($limit <= 0 ? $num : $limit));
|
|
while ($i < $min)
|
|
{
|
|
$obj = $db->fetch_object($result);
|
|
$user_static = new User($db);
|
|
if ($user_static->fetch($obj->rowid)) {
|
|
$obj_ret[] = $this->_cleanObjectDatas($user_static);
|
|
}
|
|
$i++;
|
|
}
|
|
}
|
|
else {
|
|
throw new RestException(503, 'Error when retrieve User list : '.$db->lasterror());
|
|
}
|
|
if (!count($obj_ret)) {
|
|
throw new RestException(404, 'No User found');
|
|
}
|
|
return $obj_ret;
|
|
}
|
|
|
|
/**
|
|
* Get properties of an user object
|
|
*
|
|
* Return an array with user informations
|
|
*
|
|
* @param int $id ID of user
|
|
* @return array|mixed data without useless information
|
|
*
|
|
* @throws RestException
|
|
*/
|
|
public function get($id)
|
|
{
|
|
//if (!DolibarrApiAccess::$user->rights->user->user->lire) {
|
|
//throw new RestException(401);
|
|
//}
|
|
|
|
$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(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
|
|
}
|
|
|
|
return $this->_cleanObjectDatas($this->useraccount);
|
|
}
|
|
|
|
/**
|
|
* Get properties of user connected
|
|
*
|
|
* @url GET /info
|
|
*
|
|
* @return array|mixed Data without useless information
|
|
*
|
|
* @throws 401 RestException Insufficient rights
|
|
* @throws 404 RestException User not found
|
|
* @throws 404 RestException User group not found
|
|
*/
|
|
public function getInfo()
|
|
{
|
|
$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(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
|
|
}
|
|
|
|
$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);
|
|
}
|
|
|
|
/**
|
|
* Create user account
|
|
*
|
|
* @param array $request_data New user data
|
|
* @return int
|
|
*/
|
|
public function post($request_data = null)
|
|
{
|
|
// check user authorization
|
|
//if(! DolibarrApiAccess::$user->rights->user->creer) {
|
|
// throw new RestException(401, "User creation not allowed");
|
|
//}
|
|
// check mandatory fields
|
|
/*if (!isset($request_data["login"]))
|
|
throw new RestException(400, "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)
|
|
{
|
|
$this->useraccount->$field = $value;
|
|
}
|
|
|
|
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;
|
|
}
|
|
|
|
|
|
/**
|
|
* Update account
|
|
*
|
|
* @param int $id Id of account to update
|
|
* @param array $request_data Datas
|
|
* @return array
|
|
*
|
|
* @throws RestException
|
|
*/
|
|
public function put($id, $request_data = null)
|
|
{
|
|
//if (!DolibarrApiAccess::$user->rights->user->user->creer) {
|
|
//throw new RestException(401);
|
|
//}
|
|
|
|
$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(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
|
|
}
|
|
|
|
foreach ($request_data as $field => $value)
|
|
{
|
|
if ($field == 'id') continue;
|
|
// The status must be updated using setstatus() because it
|
|
// is not handled by the update() method.
|
|
if ($field == 'statut') {
|
|
$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 = $value;
|
|
}
|
|
}
|
|
|
|
// 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);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* List the groups of a user
|
|
*
|
|
* @param int $id Id of user
|
|
* @return array Array of group objects
|
|
*
|
|
* @throws RestException
|
|
*
|
|
* @url GET {id}/groups
|
|
*/
|
|
public function getGroups($id)
|
|
{
|
|
$obj_ret = array();
|
|
|
|
if (!DolibarrApiAccess::$user->rights->user->user->lire) {
|
|
throw new RestException(401);
|
|
}
|
|
|
|
$user = new User($this->db);
|
|
$result = $user->fetch($id);
|
|
if (!$result) {
|
|
throw new RestException(404, 'user not found');
|
|
}
|
|
|
|
$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;
|
|
}
|
|
|
|
|
|
/**
|
|
* Add a user into a group
|
|
*
|
|
* @param int $id User ID
|
|
* @param int $group Group ID
|
|
* @param int $entity Entity ID (valid only for superadmin in multicompany transverse mode)
|
|
* @return int 1 if success
|
|
*
|
|
* @url GET {id}/setGroup/{group}
|
|
*/
|
|
public function setGroup($id, $group, $entity = 1)
|
|
{
|
|
|
|
global $conf;
|
|
|
|
//if (!DolibarrApiAccess::$user->rights->user->user->supprimer) {
|
|
//throw new RestException(401);
|
|
//}
|
|
$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(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
|
|
}
|
|
|
|
if (!empty($conf->multicompany->enabled) && !empty($conf->global->MULTICOMPANY_TRANSVERSE_MODE) && !empty(DolibarrApiAccess::$user->admin) && empty(DolibarrApiAccess::$user->entity))
|
|
{
|
|
$entity = (!empty($entity) ? $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 = (DolibarrApiAccess::$user->entity > 0 ? DolibarrApiAccess::$user->entity : $conf->entity);
|
|
}
|
|
|
|
$result = $this->useraccount->SetInGroup($group, $entity);
|
|
if (!($result > 0))
|
|
{
|
|
throw new RestException(500, $this->useraccount->error);
|
|
}
|
|
|
|
return 1;
|
|
}
|
|
|
|
/**
|
|
* List Groups
|
|
*
|
|
* Return an array with a list of Groups
|
|
*
|
|
* @url GET /groups
|
|
*
|
|
* @param string $sortfield Sort field
|
|
* @param string $sortorder Sort order
|
|
* @param int $limit Limit for list
|
|
* @param int $page Page number
|
|
* @param string $group_ids Groups ids filter field. Example: '1' or '1,2,3' {@pattern /^[0-9,]*$/i}
|
|
* @param string $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.date_creation:<:'20160101')"
|
|
* @return array Array of User objects
|
|
*/
|
|
public function listGroups($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $group_ids = 0, $sqlfilters = '')
|
|
{
|
|
global $db, $conf;
|
|
|
|
$obj_ret = array();
|
|
|
|
if (!DolibarrApiAccess::$user->rights->user->group_advance->read) {
|
|
throw new RestException(401, "You are not allowed to read list of groups");
|
|
}
|
|
|
|
// case of external user, $societe param is ignored and replaced by user's socid
|
|
//$socid = DolibarrApiAccess::$user->socid ? DolibarrApiAccess::$user->socid : $societe;
|
|
|
|
$sql = "SELECT t.rowid";
|
|
$sql .= " FROM ".MAIN_DB_PREFIX."usergroup as t";
|
|
$sql .= ' WHERE t.entity IN ('.getEntity('user').')';
|
|
if ($group_ids) $sql .= " AND t.rowid IN (".$group_ids.")";
|
|
// Add sql filters
|
|
if ($sqlfilters)
|
|
{
|
|
if (!DolibarrApi::_checkFilters($sqlfilters))
|
|
{
|
|
throw new RestException(503, 'Error when validating parameter sqlfilters '.$sqlfilters);
|
|
}
|
|
$regexstring = '\(([^:\'\(\)]+:[^:\'\(\)]+:[^:\(\)]+)\)';
|
|
$sql .= " AND (".preg_replace_callback('/'.$regexstring.'/', 'DolibarrApi::_forge_criteria_callback', $sqlfilters).")";
|
|
}
|
|
|
|
$sql .= $db->order($sortfield, $sortorder);
|
|
if ($limit) {
|
|
if ($page < 0)
|
|
{
|
|
$page = 0;
|
|
}
|
|
$offset = $limit * $page;
|
|
|
|
$sql .= $db->plimit($limit + 1, $offset);
|
|
}
|
|
|
|
$result = $db->query($sql);
|
|
|
|
if ($result)
|
|
{
|
|
$i = 0;
|
|
$num = $db->num_rows($result);
|
|
$min = min($num, ($limit <= 0 ? $num : $limit));
|
|
while ($i < $min)
|
|
{
|
|
$obj = $db->fetch_object($result);
|
|
$group_static = new UserGroup($this->db);
|
|
if ($group_static->fetch($obj->rowid)) {
|
|
$obj_ret[] = $this->_cleanObjectDatas($group_static);
|
|
}
|
|
$i++;
|
|
}
|
|
}
|
|
else {
|
|
throw new RestException(503, 'Error when retrieve Group list : '.$db->lasterror());
|
|
}
|
|
if (!count($obj_ret)) {
|
|
throw new RestException(404, 'No Group found');
|
|
}
|
|
return $obj_ret;
|
|
}
|
|
|
|
/**
|
|
* Get properties of an group object
|
|
*
|
|
* Return an array with group informations
|
|
*
|
|
* @url GET /groups/{group}
|
|
*
|
|
* @param int $group ID of group
|
|
* @param int $load_members Load members list or not {@min 0} {@max 1}
|
|
* @return array Array of User objects
|
|
*/
|
|
public function infoGroups($group, $load_members = 0)
|
|
{
|
|
global $db, $conf;
|
|
|
|
if (!DolibarrApiAccess::$user->rights->user->group_advance->read) {
|
|
throw new RestException(401, "You are not allowed to read groups");
|
|
}
|
|
|
|
$group_static = new UserGroup($this->db);
|
|
$result = $group_static->fetch($group, '', $load_members);
|
|
|
|
if (!$result)
|
|
{
|
|
throw new RestException(404, 'Group not found');
|
|
}
|
|
|
|
return $this->_cleanObjectDatas($group_static);
|
|
}
|
|
|
|
/**
|
|
* Delete account
|
|
*
|
|
* @param int $id Account ID
|
|
* @return array
|
|
*/
|
|
public function delete($id)
|
|
{
|
|
//if (!DolibarrApiAccess::$user->rights->user->user->supprimer) {
|
|
//throw new RestException(401);
|
|
//}
|
|
$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(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
|
|
}
|
|
$this->useraccount->oldcopy = clone $this->useraccount;
|
|
return $this->useraccount->delete(DolibarrApiAccess::$user);
|
|
}
|
|
|
|
// phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
|
|
/**
|
|
* Clean sensible object datas
|
|
*
|
|
* @param object $object Object to clean
|
|
* @return array Array of cleaned object properties
|
|
*/
|
|
protected function _cleanObjectDatas($object)
|
|
{
|
|
// phpcs:enable
|
|
global $conf;
|
|
|
|
$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);
|
|
|
|
// 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 = ((!empty($conf->salaries->enabled) && !empty(DolibarrApiAccess::$user->rights->salaries->read))
|
|
|| (!empty($conf->hrm->enabled) && !empty(DolibarrApiAccess::$user->rights->hrm->employee->read)));
|
|
|
|
if (!$canreadsalary)
|
|
{
|
|
unset($object->salary);
|
|
unset($object->salaryextra);
|
|
unset($object->thm);
|
|
unset($object->tjm);
|
|
}
|
|
|
|
return $object;
|
|
}
|
|
|
|
/**
|
|
* Clean sensible user group list datas
|
|
*
|
|
* @param array $objectList Array of object to clean
|
|
* @return array Array of cleaned object properties
|
|
*/
|
|
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->datem);
|
|
unset($cleanObject->members);
|
|
unset($cleanObject->note);
|
|
unset($cleanObject->note_private);
|
|
|
|
$cleanObjectList[] = $cleanObject;
|
|
}
|
|
|
|
return $cleanObjectList;
|
|
}
|
|
|
|
/**
|
|
* Validate fields before create or update object
|
|
*
|
|
* @param array|null $data Data to validate
|
|
* @return array
|
|
* @throws RestException
|
|
*/
|
|
private function _validate($data)
|
|
{
|
|
$account = array();
|
|
foreach (Users::$FIELDS as $field) {
|
|
if (!isset($data[$field]))
|
|
throw new RestException(400, "$field field missing");
|
|
$account[$field] = $data[$field];
|
|
}
|
|
return $account;
|
|
}
|
|
}
|