dolibarr 21.0.0-alpha
api_contacts.class.php
1<?php
2/* Copyright (C) 2015 Jean-François Ferry <jfefe@aternatik.fr>
3 * Copyright (C) 2019 Frédéric France <frederic.france@netlogic.fr>
4 * Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.com>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <https://www.gnu.org/licenses/>.
18 */
19
20use Luracast\Restler\RestException;
21
22//require_once DOL_DOCUMENT_ROOT.'/contact/class/contact.class.php';
23//require_once DOL_DOCUMENT_ROOT.'/categories/class/categorie.class.php';
24
25
32class Contacts extends DolibarrApi
33{
38 public static $FIELDS = array(
39 'lastname',
40 );
41
45 public $contact;
46
50 public function __construct()
51 {
52 global $db, $conf;
53 $this->db = $db;
54
55 require_once DOL_DOCUMENT_ROOT.'/contact/class/contact.class.php';
56 require_once DOL_DOCUMENT_ROOT.'/categories/class/categorie.class.php';
57
58 $this->contact = new Contact($this->db);
59 }
60
73 public function get($id, $includecount = 0, $includeroles = 0)
74 {
75 if (!DolibarrApiAccess::$user->hasRight('societe', 'contact', 'lire')) {
76 throw new RestException(403, 'No permission to read contacts');
77 }
78
79 if ($id === 0) {
80 $result = $this->contact->initAsSpecimen();
81 } else {
82 $result = $this->contact->fetch($id);
83 }
84
85 if (!$result) {
86 throw new RestException(404, 'Contact not found');
87 }
88
89 if (!DolibarrApi::_checkAccessToResource('contact', $this->contact->id, 'socpeople&societe')) {
90 throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
91 }
92
93 if ($includecount) {
94 $this->contact->load_ref_elements();
95 }
96
97 if ($includeroles) {
98 $this->contact->fetchRoles();
99 }
100
101 if (isModEnabled('mailing')) {
102 $this->contact->getNoEmail();
103 }
104
105 return $this->_cleanObjectDatas($this->contact);
106 }
107
121 public function getByEmail($email, $includecount = 0, $includeroles = 0)
122 {
123 if (!DolibarrApiAccess::$user->hasRight('societe', 'contact', 'lire')) {
124 throw new RestException(403, 'No permission to read contacts');
125 }
126
127 if (empty($email)) {
128 $result = $this->contact->initAsSpecimen();
129 } else {
130 $result = $this->contact->fetch('', '', '', $email);
131 }
132
133 if (!$result) {
134 throw new RestException(404, 'Contact not found');
135 }
136
137 if (!DolibarrApi::_checkAccessToResource('contact', $this->contact->id, 'socpeople&societe')) {
138 throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
139 }
140
141 if ($includecount) {
142 $this->contact->load_ref_elements();
143 }
144
145 if ($includeroles) {
146 $this->contact->fetchRoles();
147 }
148
149 if (isModEnabled('mailing')) {
150 $this->contact->getNoEmail();
151 }
152
153 return $this->_cleanObjectDatas($this->contact);
154 }
155
176 public function index($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $thirdparty_ids = '', $category = 0, $sqlfilters = '', $includecount = 0, $includeroles = 0, $properties = '', $pagination_data = false)
177 {
178 global $db, $conf;
179
180 $obj_ret = array();
181
182 if (!DolibarrApiAccess::$user->hasRight('societe', 'contact', 'lire')) {
183 throw new RestException(403, 'No permission to read contacts');
184 }
185
186 // case of external user, $thirdparty_ids param is ignored and replaced by user's socid
187 $socids = DolibarrApiAccess::$user->socid ? DolibarrApiAccess::$user->socid : $thirdparty_ids;
188
189 // If the internal user must only see his customers, force searching by him
190 $search_sale = 0;
191 if (!DolibarrApiAccess::$user->hasRight('societe', 'client', 'voir') && !$socids) {
192 $search_sale = DolibarrApiAccess::$user->id;
193 }
194
195 $sql = "SELECT t.rowid";
196 $sql .= " FROM ".MAIN_DB_PREFIX."socpeople as t";
197 if ($category > 0) {
198 $sql .= ", ".MAIN_DB_PREFIX."categorie_contact as c";
199 }
200 $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."socpeople_extrafields as te ON te.fk_object = t.rowid";
201 $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."societe as s ON t.fk_soc = s.rowid";
202 $sql .= ' WHERE t.entity IN ('.getEntity('contact').')';
203 if ($socids) {
204 $sql .= " AND t.fk_soc IN (".$this->db->sanitize($socids).")";
205 }
206 // Search on sale representative
207 if ($search_sale && $search_sale != '-1') {
208 if ($search_sale == -2) {
209 $sql .= " AND NOT EXISTS (SELECT sc.fk_soc FROM ".MAIN_DB_PREFIX."societe_commerciaux as sc WHERE sc.fk_soc = t.fk_soc)";
210 } elseif ($search_sale > 0) {
211 $sql .= " AND EXISTS (SELECT sc.fk_soc FROM ".MAIN_DB_PREFIX."societe_commerciaux as sc WHERE sc.fk_soc = t.fk_soc AND sc.fk_user = ".((int) $search_sale).")";
212 }
213 }
214 // Select contacts of given category
215 if ($category > 0) {
216 $sql .= " AND c.fk_categorie = ".((int) $category);
217 $sql .= " AND c.fk_socpeople = t.rowid ";
218 }
219
220 // Add sql filters
221 if ($sqlfilters) {
222 $errormessage = '';
223 $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
224 if ($errormessage) {
225 throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
226 }
227 }
228
229 //this query will return total orders with the filters given
230 $sqlTotals = str_replace('SELECT t.rowid', 'SELECT count(t.rowid) as total', $sql);
231
232 $sql .= $this->db->order($sortfield, $sortorder);
233
234 if ($limit) {
235 if ($page < 0) {
236 $page = 0;
237 }
238 $offset = $limit * $page;
239
240 $sql .= $this->db->plimit($limit + 1, $offset);
241 }
242 $result = $this->db->query($sql);
243 if ($result) {
244 $num = $this->db->num_rows($result);
245 $min = min($num, ($limit <= 0 ? $num : $limit));
246 $i = 0;
247 while ($i < $min) {
248 $obj = $this->db->fetch_object($result);
249 $contact_static = new Contact($this->db);
250 if ($contact_static->fetch($obj->rowid)) {
251 $contact_static->fetchRoles();
252 if ($includecount) {
253 $contact_static->load_ref_elements();
254 }
255 if ($includeroles) {
256 $contact_static->fetchRoles();
257 }
258 if (isModEnabled('mailing')) {
259 $contact_static->getNoEmail();
260 }
261
262 $obj_ret[] = $this->_filterObjectProperties($this->_cleanObjectDatas($contact_static), $properties);
263 }
264
265 $i++;
266 }
267 } else {
268 throw new RestException(503, 'Error when retrieve contacts : '.$sql);
269 }
270
271 //if $pagination_data is true the response will contain element data with all values and element pagination with pagination data(total,page,limit)
272 if ($pagination_data) {
273 $totalsResult = $this->db->query($sqlTotals);
274 $total = $this->db->fetch_object($totalsResult)->total;
275
276 $tmp = $obj_ret;
277 $obj_ret = [];
278
279 $obj_ret['data'] = $tmp;
280 $obj_ret['pagination'] = [
281 'total' => (int) $total,
282 'page' => $page, //count starts from 0
283 'page_count' => ceil((int) $total / $limit),
284 'limit' => $limit
285 ];
286 }
287
288 return $obj_ret;
289 }
290
299 public function post($request_data = null)
300 {
301 if (!DolibarrApiAccess::$user->hasRight('societe', 'contact', 'creer')) {
302 throw new RestException(403, 'No permission to create/update contacts');
303 }
304 // Check mandatory fields
305 $result = $this->_validate($request_data);
306
307 foreach ($request_data as $field => $value) {
308 if ($field === 'caller') {
309 // 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
310 $this->contact->context['caller'] = sanitizeVal($request_data['caller'], 'aZ09');
311 continue;
312 }
313 if ($field == 'array_options' && is_array($value)) {
314 foreach ($value as $index => $val) {
315 $this->contact->array_options[$index] = $this->_checkValForAPI('extrafields', $val, $this->contact);
316 }
317 continue;
318 }
319
320 $this->contact->$field = $this->_checkValForAPI($field, $value, $this->contact);
321 }
322 if ($this->contact->create(DolibarrApiAccess::$user) < 0) {
323 throw new RestException(500, "Error creating contact", array_merge(array($this->contact->error), $this->contact->errors));
324 }
325 if (isModEnabled('mailing') && !empty($this->contact->email) && isset($this->contact->no_email)) {
326 $this->contact->setNoEmail($this->contact->no_email);
327 }
328 return $this->contact->id;
329 }
330
342 public function put($id, $request_data = null)
343 {
344 if (!DolibarrApiAccess::$user->hasRight('societe', 'contact', 'creer')) {
345 throw new RestException(403, 'No permission to create/update contacts');
346 }
347
348 $result = $this->contact->fetch($id);
349 if (!$result) {
350 throw new RestException(404, 'Contact not found');
351 }
352
353 if (!DolibarrApi::_checkAccessToResource('contact', $this->contact->id, 'socpeople&societe')) {
354 throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
355 }
356
357 foreach ($request_data as $field => $value) {
358 if ($field == 'id') {
359 continue;
360 }
361 if ($field === 'caller') {
362 // 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
363 $this->contact->context['caller'] = sanitizeVal($request_data['caller'], 'aZ09');
364 continue;
365 }
366 if ($field == 'array_options' && is_array($value)) {
367 foreach ($value as $index => $val) {
368 $this->contact->array_options[$index] = $this->_checkValForAPI('extrafields', $val, $this->contact);
369 }
370 continue;
371 }
372
373 $this->contact->$field = $this->_checkValForAPI($field, $value, $this->contact);
374 }
375
376 if (isModEnabled('mailing') && !empty($this->contact->email) && isset($this->contact->no_email)) {
377 $this->contact->setNoEmail($this->contact->no_email);
378 }
379
380 if ($this->contact->update($id, DolibarrApiAccess::$user, 0, 'update') > 0) {
381 return $this->get($id);
382 } else {
383 throw new RestException(500, $this->contact->error);
384 }
385 }
386
393 public function delete($id)
394 {
395 if (!DolibarrApiAccess::$user->hasRight('societe', 'contact', 'supprimer')) {
396 throw new RestException(403, 'No permission to delete contacts');
397 }
398 $result = $this->contact->fetch($id);
399 if (!$result) {
400 throw new RestException(404, 'Contact not found');
401 }
402
403 if (!DolibarrApi::_checkAccessToResource('contact', $this->contact->id, 'socpeople&societe')) {
404 throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
405 }
406 $this->contact->oldcopy = clone $this->contact;
407
408 if ($this->contact->delete(DolibarrApiAccess::$user) <= 0) {
409 throw new RestException(500, 'Error when delete contact ' . $this->contact->error);
410 }
411
412 return array(
413 'success' => array(
414 'code' => 200,
415 'message' => 'Contact deleted'
416 )
417 );
418 }
419
430 public function createUser($id, $request_data = null)
431 {
432 //if (!DolibarrApiAccess::$user->hasRight('user', 'user', 'creer')) {
433 //throw new RestException(403);
434 //}
435
436 if (!isset($request_data["login"])) {
437 throw new RestException(400, "login field missing");
438 }
439 if (!isset($request_data["password"])) {
440 throw new RestException(400, "password field missing");
441 }
442
443 if (!DolibarrApiAccess::$user->hasRight('societe', 'contact', 'lire')) {
444 throw new RestException(403, 'No permission to read contacts');
445 }
446 if (!DolibarrApiAccess::$user->hasRight('user', 'user', 'creer')) {
447 throw new RestException(403, 'No permission to create user');
448 }
449
450 $contact = new Contact($this->db);
451 $contact->fetch($id);
452 if ($contact->id <= 0) {
453 throw new RestException(404, 'Contact not found');
454 }
455
456 if (!DolibarrApi::_checkAccessToResource('contact', $contact->id, 'socpeople&societe')) {
457 throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
458 }
459
460 // Check mandatory fields
461 $login = $request_data["login"];
462 $password = $request_data["password"];
463 $useraccount = new User($this->db);
464 $result = $useraccount->create_from_contact($contact, $login, $password);
465 if ($result <= 0) {
466 throw new RestException(500, "User not created");
467 }
468 // password parameter not used in create_from_contact
469 $useraccount->setPassword($useraccount, $password);
470
471 return $result;
472 }
473
487 public function getCategories($id, $sortfield = "s.rowid", $sortorder = 'ASC', $limit = 0, $page = 0)
488 {
489 if (!DolibarrApiAccess::$user->hasRight('categorie', 'lire')) {
490 throw new RestException(403);
491 }
492
493 $categories = new Categorie($this->db);
494
495 $result = $categories->getListForItem($id, 'contact', $sortfield, $sortorder, $limit, $page);
496
497 if ($result < 0) {
498 throw new RestException(503, 'Error when retrieve category list : '.$categories->error);
499 }
500
501 return $result;
502 }
503
517 public function addCategory($id, $category_id)
518 {
519 if (!DolibarrApiAccess::$user->hasRight('societe', 'contact', 'creer')) {
520 throw new RestException(403, 'Insufficient rights');
521 }
522
523 $result = $this->contact->fetch($id);
524 if (!$result) {
525 throw new RestException(404, 'Contact not found');
526 }
527 $category = new Categorie($this->db);
528 $result = $category->fetch($category_id);
529 if (!$result) {
530 throw new RestException(404, 'category not found');
531 }
532
533 if (!DolibarrApi::_checkAccessToResource('contact', $this->contact->id)) {
534 throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
535 }
536 if (!DolibarrApi::_checkAccessToResource('category', $category->id)) {
537 throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
538 }
539
540 $category->add_type($this->contact, 'contact');
541
542 return $this->_cleanObjectDatas($this->contact);
543 }
544
557 public function deleteCategory($id, $category_id)
558 {
559 if (!DolibarrApiAccess::$user->hasRight('societe', 'contact', 'creer')) {
560 throw new RestException(403, 'Insufficient rights');
561 }
562
563 $result = $this->contact->fetch($id);
564 if (!$result) {
565 throw new RestException(404, 'Contact not found');
566 }
567 $category = new Categorie($this->db);
568 $result = $category->fetch($category_id);
569 if (!$result) {
570 throw new RestException(404, 'category not found');
571 }
572
573 if (!DolibarrApi::_checkAccessToResource('contact', $this->contact->id)) {
574 throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
575 }
576 if (!DolibarrApi::_checkAccessToResource('category', $category->id)) {
577 throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
578 }
579
580 $category->del_type($this->contact, 'contact');
581
582 return $this->_cleanObjectDatas($this->contact);
583 }
584
585 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
592 protected function _cleanObjectDatas($object)
593 {
594 // phpcs:enable
595 $object = parent::_cleanObjectDatas($object);
596
597 unset($object->total_ht);
598 unset($object->total_tva);
599 unset($object->total_localtax1);
600 unset($object->total_localtax2);
601 unset($object->total_ttc);
602
603 unset($object->note);
604 unset($object->lines);
605 unset($object->thirdparty);
606
607 return $object;
608 }
609
617 private function _validate($data)
618 {
619 $contact = array();
620 foreach (Contacts::$FIELDS as $field) {
621 if (!isset($data[$field])) {
622 throw new RestException(400, "$field field missing");
623 }
624 $contact[$field] = $data[$field];
625 }
626
627 return $contact;
628 }
629}
$id
Definition account.php:39
if( $user->socid > 0) if(! $user->hasRight('accounting', 'chartofaccount')) $object
Definition card.php:58
Class to manage categories.
Class to manage contact/addresses.
addCategory($id, $category_id)
Add a category to a contact.
put($id, $request_data=null)
Update contact.
_validate($data)
Validate fields before create or update object.
deleteCategory($id, $category_id)
Remove the link between a category and a contact.
createUser($id, $request_data=null)
Create an user account object from contact (external user)
post($request_data=null)
Create contact object.
getByEmail($email, $includecount=0, $includeroles=0)
Get properties of a contact object by Email.
getCategories($id, $sortfield="s.rowid", $sortorder='ASC', $limit=0, $page=0)
Get categories for a contact.
_cleanObjectDatas($object)
Clean sensible object datas.
__construct()
Constructor.
index($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $thirdparty_ids='', $category=0, $sqlfilters='', $includecount=0, $includeroles=0, $properties='', $pagination_data=false)
List contacts.
Class for API REST v1.
Definition api.class.php:30
_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.
Definition api.class.php:82
Class to manage Dolibarr users.
forgeSQLFromUniversalSearchCriteria($filter, &$errorstr='', $noand=0, $nopar=0, $noerror=0)
forgeSQLFromUniversalSearchCriteria
sanitizeVal($out='', $check='alphanohtml', $filter=null, $options=null)
Return a sanitized or empty value after checking value against a rule.