Commit | Line | Data |
---|---|---|
19b53e5b | 1 | <?php |
380f3545 TO |
2 | |
3 | /* | |
4 | +--------------------------------------------------------------------+ | |
41498ac5 | 5 | | Copyright CiviCRM LLC. All rights reserved. | |
380f3545 | 6 | | | |
41498ac5 TO |
7 | | This work is published under the GNU AGPLv3 license with some | |
8 | | permitted exceptions and without any warranty. For full license | | |
9 | | and copyright information, see https://civicrm.org/licensing | | |
380f3545 TO |
10 | +--------------------------------------------------------------------+ |
11 | */ | |
12 | ||
19b53e5b C |
13 | namespace Civi\Api4\Generic\Traits; |
14 | ||
c9e3994d | 15 | use Civi\Api4\CustomField; |
721c9da1 | 16 | use Civi\Api4\Service\Schema\Joinable\CustomGroupJoinable; |
19b53e5b | 17 | use Civi\Api4\Utils\FormattingUtil; |
a62d97f3 | 18 | use Civi\Api4\Utils\CoreUtil; |
19b53e5b C |
19 | |
20 | /** | |
21 | * @method string getLanguage() | |
14a9c588 | 22 | * @method $this setLanguage(string $language) |
19b53e5b C |
23 | */ |
24 | trait DAOActionTrait { | |
25 | ||
26 | /** | |
27 | * Specify the language to use if this is a multi-lingual environment. | |
28 | * | |
29 | * E.g. "en_US" or "fr_CA" | |
30 | * | |
31 | * @var string | |
32 | */ | |
33 | protected $language; | |
34 | ||
35 | /** | |
36 | * @return \CRM_Core_DAO|string | |
37 | */ | |
38 | protected function getBaoName() { | |
a62d97f3 | 39 | return CoreUtil::getBAOFromApiName($this->getEntityName()); |
19b53e5b C |
40 | } |
41 | ||
42 | /** | |
a4c7afc0 | 43 | * Convert saved object to array |
19b53e5b | 44 | * |
a4c7afc0 CW |
45 | * Used by create, update & save actions |
46 | * | |
47 | * @param \CRM_Core_DAO $bao | |
48 | * @param array $input | |
19b53e5b C |
49 | * @return array |
50 | */ | |
a4c7afc0 CW |
51 | public function baoToArray($bao, $input) { |
52 | $allFields = array_column($bao->fields(), 'name'); | |
53 | if (!empty($this->reload)) { | |
54 | $inputFields = $allFields; | |
55 | $bao->find(TRUE); | |
56 | } | |
57 | else { | |
58 | $inputFields = array_keys($input); | |
59 | // Convert 'null' input to true null | |
60 | foreach ($input as $key => $val) { | |
61 | if ($val === 'null') { | |
62 | $bao->$key = NULL; | |
63 | } | |
64 | } | |
65 | } | |
19b53e5b | 66 | $values = []; |
a4c7afc0 CW |
67 | foreach ($allFields as $field) { |
68 | if (isset($bao->$field) || in_array($field, $inputFields)) { | |
69 | $values[$field] = $bao->$field ?? NULL; | |
19b53e5b C |
70 | } |
71 | } | |
72 | return $values; | |
73 | } | |
74 | ||
19b53e5b C |
75 | /** |
76 | * Fill field defaults which were declared by the api. | |
77 | * | |
78 | * Note: default values from core are ignored because the BAO or database layer will supply them. | |
79 | * | |
80 | * @param array $params | |
81 | */ | |
82 | protected function fillDefaults(&$params) { | |
83 | $fields = $this->entityFields(); | |
84 | $bao = $this->getBaoName(); | |
85 | $coreFields = array_column($bao::fields(), NULL, 'name'); | |
86 | ||
87 | foreach ($fields as $name => $field) { | |
88 | // If a default value in the api field is different than in core, the api should override it. | |
89 | if (!isset($params[$name]) && !empty($field['default_value']) && $field['default_value'] != \CRM_Utils_Array::pathGet($coreFields, [$name, 'default'])) { | |
90 | $params[$name] = $field['default_value']; | |
91 | } | |
92 | } | |
93 | } | |
94 | ||
95 | /** | |
96 | * Write bao objects as part of a create/update action. | |
97 | * | |
98 | * @param array $items | |
99 | * The records to write to the DB. | |
14a9c588 | 100 | * |
19b53e5b C |
101 | * @return array |
102 | * The records after being written to the DB (e.g. including newly assigned "id"). | |
103 | * @throws \API_Exception | |
14a9c588 | 104 | * @throws \CRM_Core_Exception |
19b53e5b C |
105 | */ |
106 | protected function writeObjects($items) { | |
107 | $baoName = $this->getBaoName(); | |
108 | ||
109 | // Some BAOs are weird and don't support a straightforward "create" method. | |
110 | $oddballs = [ | |
111 | 'EntityTag' => 'add', | |
112 | 'GroupContact' => 'add', | |
19b53e5b C |
113 | ]; |
114 | $method = $oddballs[$this->getEntityName()] ?? 'create'; | |
115 | if (!method_exists($baoName, $method)) { | |
116 | $method = 'add'; | |
117 | } | |
118 | ||
119 | $result = []; | |
120 | ||
121 | foreach ($items as $item) { | |
2929a8fb | 122 | $entityId = $item['id'] ?? NULL; |
37d82abe | 123 | FormattingUtil::formatWriteParams($item, $this->entityFields()); |
19b53e5b C |
124 | $this->formatCustomParams($item, $entityId); |
125 | $item['check_permissions'] = $this->getCheckPermissions(); | |
126 | ||
127 | // For some reason the contact bao requires this | |
14a9c588 | 128 | if ($entityId && $this->getEntityName() === 'Contact') { |
19b53e5b C |
129 | $item['contact_id'] = $entityId; |
130 | } | |
131 | ||
132 | if ($this->getCheckPermissions()) { | |
133 | $this->checkContactPermissions($baoName, $item); | |
134 | } | |
135 | ||
14a9c588 | 136 | if ($this->getEntityName() === 'Address') { |
1db5a675 | 137 | $createResult = $baoName::$method($item, $this->fixAddress); |
19b53e5b C |
138 | } |
139 | elseif (method_exists($baoName, $method)) { | |
140 | $createResult = $baoName::$method($item); | |
141 | } | |
142 | else { | |
2ee9afab | 143 | $createResult = $baoName::writeRecord($item); |
19b53e5b C |
144 | } |
145 | ||
146 | if (!$createResult) { | |
147 | $errMessage = sprintf('%s write operation failed', $this->getEntityName()); | |
148 | throw new \API_Exception($errMessage); | |
149 | } | |
150 | ||
a4c7afc0 | 151 | $result[] = $this->baoToArray($createResult, $item); |
19b53e5b | 152 | } |
2929a8fb | 153 | FormattingUtil::formatOutputValues($result, $this->entityFields(), $this->getEntityName()); |
19b53e5b C |
154 | return $result; |
155 | } | |
156 | ||
19b53e5b C |
157 | /** |
158 | * @param array $params | |
159 | * @param int $entityId | |
14a9c588 | 160 | * |
14a9c588 | 161 | * @throws \API_Exception |
162 | * @throws \CRM_Core_Exception | |
19b53e5b C |
163 | */ |
164 | protected function formatCustomParams(&$params, $entityId) { | |
165 | $customParams = []; | |
166 | ||
167 | // $customValueID is the ID of the custom value in the custom table for this | |
168 | // entity (i guess this assumes it's not a multi value entity) | |
169 | foreach ($params as $name => $value) { | |
c9e3994d CW |
170 | $field = $this->getCustomFieldInfo($name); |
171 | if (!$field) { | |
19b53e5b C |
172 | continue; |
173 | } | |
174 | ||
19b53e5b | 175 | // todo are we sure we don't want to allow setting to NULL? need to test |
c9e3994d | 176 | if (NULL !== $value) { |
19b53e5b | 177 | |
c9e3994d | 178 | if ($field['suffix']) { |
721c9da1 | 179 | $options = FormattingUtil::getPseudoconstantList($field, $field['suffix'], $params, $this->getActionName()); |
961e974c CW |
180 | $value = FormattingUtil::replacePseudoconstant($options, $value, TRUE); |
181 | } | |
182 | ||
c9e3994d | 183 | if ($field['html_type'] === 'CheckBox') { |
19b53e5b | 184 | // this function should be part of a class |
c9e3994d | 185 | formatCheckBoxField($value, 'custom_' . $field['id'], $this->getEntityName()); |
19b53e5b C |
186 | } |
187 | ||
a6a158e7 CW |
188 | if ($field['data_type'] === 'ContactReference' && !is_numeric($value)) { |
189 | require_once 'api/v3/utils.php'; | |
190 | $value = \_civicrm_api3_resolve_contactID($value); | |
191 | if ('unknown-user' === $value) { | |
192 | throw new \API_Exception("\"{$field['name']}\" \"{$value}\" cannot be resolved to a contact ID", 2002, ['error_field' => $field['name'], "type" => "integer"]); | |
193 | } | |
194 | } | |
195 | ||
19b53e5b | 196 | \CRM_Core_BAO_CustomField::formatCustomField( |
c9e3994d | 197 | $field['id'], |
19b53e5b C |
198 | $customParams, |
199 | $value, | |
c9e3994d | 200 | $field['custom_group.extends'], |
19b53e5b C |
201 | // todo check when this is needed |
202 | NULL, | |
203 | $entityId, | |
204 | FALSE, | |
205 | FALSE, | |
206 | TRUE | |
207 | ); | |
208 | } | |
209 | } | |
210 | ||
211 | if ($customParams) { | |
212 | $params['custom'] = $customParams; | |
213 | } | |
214 | } | |
215 | ||
c9e3994d CW |
216 | /** |
217 | * Gets field info needed to save custom data | |
218 | * | |
721c9da1 | 219 | * @param string $fieldExpr |
c9e3994d CW |
220 | * Field identifier with possible suffix, e.g. MyCustomGroup.MyField1:label |
221 | * @return array|NULL | |
222 | */ | |
721c9da1 CW |
223 | protected function getCustomFieldInfo(string $fieldExpr) { |
224 | if (strpos($fieldExpr, '.') === FALSE) { | |
c9e3994d CW |
225 | return NULL; |
226 | } | |
721c9da1 | 227 | list($groupName, $fieldName) = explode('.', $fieldExpr); |
c9e3994d | 228 | list($fieldName, $suffix) = array_pad(explode(':', $fieldName), 2, NULL); |
721c9da1 CW |
229 | $cacheKey = "APIv4_Custom_Fields-$groupName"; |
230 | $info = \Civi::cache('metadata')->get($cacheKey); | |
231 | if (!isset($info[$fieldName])) { | |
232 | $info = []; | |
233 | $fields = CustomField::get(FALSE) | |
a6a158e7 | 234 | ->addSelect('id', 'name', 'html_type', 'data_type', 'custom_group.extends') |
c9e3994d CW |
235 | ->addWhere('custom_group.name', '=', $groupName) |
236 | ->execute()->indexBy('name'); | |
721c9da1 CW |
237 | foreach ($fields as $name => $field) { |
238 | $field['custom_field_id'] = $field['id']; | |
239 | $field['name'] = $groupName . '.' . $name; | |
240 | $field['entity'] = CustomGroupJoinable::getEntityFromExtends($field['custom_group.extends']); | |
241 | $info[$name] = $field; | |
242 | } | |
243 | \Civi::cache('metadata')->set($cacheKey, $info); | |
c9e3994d | 244 | } |
721c9da1 | 245 | return isset($info[$fieldName]) ? ['suffix' => $suffix] + $info[$fieldName] : NULL; |
c9e3994d CW |
246 | } |
247 | ||
19b53e5b C |
248 | /** |
249 | * Check edit/delete permissions for contacts and related entities. | |
250 | * | |
14a9c588 | 251 | * @param string $baoName |
252 | * @param array $item | |
253 | * | |
19b53e5b C |
254 | * @throws \Civi\API\Exception\UnauthorizedException |
255 | */ | |
256 | protected function checkContactPermissions($baoName, $item) { | |
14a9c588 | 257 | if ($baoName === 'CRM_Contact_BAO_Contact' && !empty($item['id'])) { |
258 | $permission = $this->getActionName() === 'delete' ? \CRM_Core_Permission::DELETE : \CRM_Core_Permission::EDIT; | |
19b53e5b C |
259 | if (!\CRM_Contact_BAO_Contact_Permission::allow($item['id'], $permission)) { |
260 | throw new \Civi\API\Exception\UnauthorizedException('Permission denied to modify contact record'); | |
261 | } | |
262 | } | |
263 | else { | |
264 | // Fixme: decouple from v3 | |
265 | require_once 'api/v3/utils.php'; | |
2ee9afab | 266 | _civicrm_api3_check_edit_permissions($baoName, $item); |
19b53e5b C |
267 | } |
268 | } | |
269 | ||
270 | } |