1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
|
<?php
namespace Civi\Api4\Generic\Traits;
use CRM_Utils_Array as UtilsArray;
use Civi\Api4\Utils\FormattingUtil;
use Civi\Api4\Query\Api4SelectQuery;
trait DAOActionTrait {
/**
* @return \CRM_Core_DAO|string
*/
protected function getBaoName() {
require_once 'api/v3/utils.php';
return \_civicrm_api3_get_BAO($this->getEntityName());
}
/**
* Extract the true fields from a BAO
*
* (Used by create and update actions)
* @param object $bao
* @return array
*/
public static function baoToArray($bao) {
$fields = $bao->fields();
$values = [];
foreach ($fields as $key => $field) {
$name = $field['name'];
if (property_exists($bao, $name)) {
$values[$name] = $bao->$name;
}
}
return $values;
}
/**
* @return array|int
*/
protected function getObjects() {
$query = new Api4SelectQuery($this->getEntityName(), $this->getCheckPermissions());
$query->select = $this->getSelect();
$query->where = $this->getWhere();
$query->orderBy = $this->getOrderBy();
$query->limit = $this->getLimit();
$query->offset = $this->getOffset();
return $query->run();
}
/**
* Write a bao object as part of a create/update action.
*
* @param array $items
* The record to write to the DB.
* @return array
* The record after being written to the DB (e.g. including newly assigned "id").
* @throws \API_Exception
*/
protected function writeObjects($items) {
$baoName = $this->getBaoName();
// Some BAOs are weird and don't support a straightforward "create" method.
$oddballs = [
'Address' => 'add',
'GroupContact' => 'add',
'Website' => 'add',
];
$method = UtilsArray::value($this->getEntityName(), $oddballs, 'create');
if (!method_exists($baoName, $method)) {
$method = 'add';
}
$result = [];
foreach ($items as $item) {
$entityId = UtilsArray::value('id', $item);
FormattingUtil::formatWriteParams($item, $this->getEntityName(), $this->getEntityFields());
$this->formatCustomParams($item, $entityId);
$item['check_permissions'] = $this->getCheckPermissions();
$apiKeyPermission = $this->getEntityName() != 'Contact' || !$this->getCheckPermissions() || array_key_exists('api_key', $this->getEntityFields())
|| ($entityId && \CRM_Core_Permission::check('edit own api keys') && \CRM_Core_Session::getLoggedInContactID() == $entityId);
if (!$apiKeyPermission && array_key_exists('api_key', $item)) {
throw new \Civi\API\Exception\UnauthorizedException('Permission denied to modify api key');
}
// For some reason the contact bao requires this
if ($entityId && $this->getEntityName() == 'Contact') {
$item['contact_id'] = $entityId;
}
if ($this->getCheckPermissions() && $entityId) {
$this->checkContactPermissions($baoName, $item);
}
if (method_exists($baoName, $method)) {
$createResult = $baoName::$method($item);
}
else {
$createResult = $this->genericCreateMethod($item);
}
if (!$createResult) {
$errMessage = sprintf('%s write operation failed', $this->getEntityName());
throw new \API_Exception($errMessage);
}
if (!empty($this->reload) && is_a($createResult, 'CRM_Core_DAO')) {
$createResult->find(TRUE);
}
// trim back the junk and just get the array:
$resultArray = $this->baoToArray($createResult);
if (!$apiKeyPermission && array_key_exists('api_key', $resultArray)) {
unset($resultArray['api_key']);
}
$result[] = $resultArray;
}
return $result;
}
/**
* Fallback when a BAO does not contain create or add functions
*
* @param $params
* @return mixed
*/
private function genericCreateMethod($params) {
$baoName = $this->getBaoName();
$hook = empty($params['id']) ? 'create' : 'edit';
\CRM_Utils_Hook::pre($hook, $this->getEntityName(), UtilsArray::value('id', $params), $params);
/** @var \CRM_Core_DAO $instance */
$instance = new $baoName();
$instance->copyValues($params, TRUE);
$instance->save();
\CRM_Utils_Hook::post($hook, $this->getEntityName(), $instance->id, $instance);
return $instance;
}
/**
* @param array $params
* @param int $entityId
* @return mixed
*/
private function formatCustomParams(&$params, $entityId) {
$customParams = [];
// $customValueID is the ID of the custom value in the custom table for this
// entity (i guess this assumes it's not a multi value entity)
foreach ($params as $name => $value) {
if (strpos($name, '.') === FALSE) {
continue;
}
list($customGroup, $customField) = explode('.', $name);
$customFieldId = \CRM_Core_BAO_CustomField::getFieldValue(
\CRM_Core_DAO_CustomField::class,
$customField,
'id',
'name'
);
$customFieldType = \CRM_Core_BAO_CustomField::getFieldValue(
\CRM_Core_DAO_CustomField::class,
$customField,
'html_type',
'name'
);
$customFieldExtends = \CRM_Core_BAO_CustomGroup::getFieldValue(
\CRM_Core_DAO_CustomGroup::class,
$customGroup,
'extends',
'name'
);
// todo are we sure we don't want to allow setting to NULL? need to test
if ($customFieldId && NULL !== $value) {
if ($customFieldType == 'CheckBox') {
// this function should be part of a class
formatCheckBoxField($value, 'custom_' . $customFieldId, $this->getEntityName());
}
\CRM_Core_BAO_CustomField::formatCustomField(
$customFieldId,
$customParams,
$value,
$customFieldExtends,
NULL, // todo check when this is needed
$entityId,
FALSE,
FALSE,
TRUE
);
}
}
if ($customParams) {
$params['custom'] = $customParams;
}
}
/**
* Check edit/delete permissions for contacts and related entities.
*
* @param $baoName
* @param $item
* @throws \Civi\API\Exception\UnauthorizedException
*/
protected function checkContactPermissions($baoName, $item) {
if ($baoName == 'CRM_Contact_BAO_Contact') {
$permission = $this->getActionName() == 'delete' ? \CRM_Core_Permission::DELETE : \CRM_Core_Permission::EDIT;
if (!\CRM_Contact_BAO_Contact_Permission::allow($item['id'], $permission)) {
throw new \Civi\API\Exception\UnauthorizedException('Permission denied to modify contact record');
}
}
else {
// Fixme: decouple from v3
require_once 'api/v3/utils.php';
_civicrm_api3_check_edit_permissions($baoName, ['check_permissions' => 1] + $item);
}
}
}
|
