Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
0c56e4c8 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
bc77d7c0 | 4 | | Copyright CiviCRM LLC. All rights reserved. | |
0c56e4c8 | 5 | | | |
bc77d7c0 TO |
6 | | This work is published under the GNU AGPLv3 license with some | |
7 | | permitted exceptions and without any warranty. For full license | | |
8 | | and copyright information, see https://civicrm.org/licensing | | |
0c56e4c8 | 9 | +--------------------------------------------------------------------+ |
d25dd0ee | 10 | */ |
0c56e4c8 TO |
11 | |
12 | /** | |
13 | * | |
14 | * @package CRM | |
ca5cec67 | 15 | * @copyright CiviCRM LLC https://civicrm.org/licensing |
6a488035 TO |
16 | */ |
17 | ||
0c56e4c8 TO |
18 | /** |
19 | * BAO object for crm_log table | |
20 | */ | |
21 | class CRM_Core_BAO_File extends CRM_Core_DAO_File { | |
22 | ||
518fa0ee | 23 | public static $_signableFields = ['entityTable', 'entityID', 'fileID']; |
0c56e4c8 | 24 | |
8913e915 D |
25 | /** |
26 | * If there is no setting configured on the admin screens, maximum number | |
27 | * of attachments to try to process when given a list of attachments to | |
28 | * process. | |
29 | */ | |
30 | const DEFAULT_MAX_ATTACHMENTS_BACKEND = 100; | |
31 | ||
ae2c7e00 | 32 | /** |
33 | * Takes an associative array and creates a File object. | |
34 | * | |
35 | * @param array $params | |
36 | * (reference ) an assoc array of name/value pairs. | |
37 | * | |
38 | * @return CRM_Core_BAO_File | |
39 | */ | |
40 | public static function create($params) { | |
41 | $fileDAO = new CRM_Core_DAO_File(); | |
42 | ||
43 | $op = empty($params['id']) ? 'create' : 'edit'; | |
44 | ||
45 | CRM_Utils_Hook::pre($op, 'File', CRM_Utils_Array::value('id', $params), $params); | |
46 | ||
47 | $fileDAO->copyValues($params); | |
48 | ||
49 | if (empty($params['id']) && empty($params['created_id'])) { | |
50 | $fileDAO->created_id = CRM_Core_Session::getLoggedInContactID(); | |
51 | } | |
52 | ||
53 | $fileDAO->save(); | |
54 | ||
55 | CRM_Utils_Hook::post($op, 'File', $fileDAO->id, $fileDAO); | |
56 | ||
57 | return $fileDAO; | |
58 | } | |
59 | ||
0c56e4c8 | 60 | /** |
100fef9d CW |
61 | * @param int $fileID |
62 | * @param int $entityID | |
0c56e4c8 TO |
63 | * |
64 | * @return array | |
65 | */ | |
9bbc34f1 | 66 | public static function path($fileID, $entityID) { |
0c56e4c8 | 67 | $entityFileDAO = new CRM_Core_DAO_EntityFile(); |
0c56e4c8 TO |
68 | $entityFileDAO->entity_id = $entityID; |
69 | $entityFileDAO->file_id = $fileID; | |
70 | ||
71 | if ($entityFileDAO->find(TRUE)) { | |
72 | $fileDAO = new CRM_Core_DAO_File(); | |
73 | $fileDAO->id = $fileID; | |
74 | if ($fileDAO->find(TRUE)) { | |
75 | $config = CRM_Core_Config::singleton(); | |
76 | $path = $config->customFileUploadDir . $fileDAO->uri; | |
77 | ||
78 | if (file_exists($path) && is_readable($path)) { | |
be2fb01f | 79 | return [$path, $fileDAO->mime_type]; |
0c56e4c8 TO |
80 | } |
81 | } | |
82 | } | |
83 | ||
be2fb01f | 84 | return [NULL, NULL]; |
0c56e4c8 TO |
85 | } |
86 | ||
0c56e4c8 | 87 | /** |
3fd42bb5 | 88 | * @param string $data |
100fef9d | 89 | * @param int $fileTypeID |
3fd42bb5 | 90 | * @param string $entityTable |
100fef9d | 91 | * @param int $entityID |
3fd42bb5 | 92 | * @param string|false $entitySubtype |
0c56e4c8 | 93 | * @param bool $overwrite |
75fd1335 | 94 | * @param null|array $fileParams |
0c56e4c8 | 95 | * @param string $uploadName |
3fd42bb5 | 96 | * @param string $mimeType |
0c56e4c8 TO |
97 | * |
98 | * @throws Exception | |
99 | */ | |
ae5ffbb7 | 100 | public static function filePostProcess( |
0c56e4c8 TO |
101 | $data, |
102 | $fileTypeID, | |
103 | $entityTable, | |
104 | $entityID, | |
3fd42bb5 | 105 | $entitySubtype = FALSE, |
0c56e4c8 TO |
106 | $overwrite = TRUE, |
107 | $fileParams = NULL, | |
108 | $uploadName = 'uploadFile', | |
109 | $mimeType = NULL | |
110 | ) { | |
111 | if (!$mimeType) { | |
b93376a8 | 112 | CRM_Core_Error::statusBounce(ts('Mime Type is now a required parameter for file upload')); |
0c56e4c8 TO |
113 | } |
114 | ||
115 | $config = CRM_Core_Config::singleton(); | |
116 | ||
117 | $path = explode('/', $data); | |
118 | $filename = $path[count($path) - 1]; | |
119 | ||
120 | // rename this file to go into the secure directory | |
121 | if ($entitySubtype) { | |
122 | $directoryName = $config->customFileUploadDir . $entitySubtype . DIRECTORY_SEPARATOR . $entityID; | |
123 | } | |
124 | else { | |
125 | $directoryName = $config->customFileUploadDir; | |
126 | } | |
127 | ||
128 | CRM_Utils_File::createDir($directoryName); | |
129 | ||
130 | if (!rename($data, $directoryName . DIRECTORY_SEPARATOR . $filename)) { | |
b93376a8 | 131 | CRM_Core_Error::statusBounce(ts('Could not move custom file to custom upload directory')); |
0c56e4c8 TO |
132 | } |
133 | ||
134 | // to get id's | |
135 | if ($overwrite && $fileTypeID) { | |
136 | list($sql, $params) = self::sql($entityTable, $entityID, $fileTypeID); | |
137 | } | |
138 | else { | |
139 | list($sql, $params) = self::sql($entityTable, $entityID, 0); | |
140 | } | |
141 | ||
142 | $dao = CRM_Core_DAO::executeQuery($sql, $params); | |
143 | $dao->fetch(); | |
144 | ||
145 | $fileDAO = new CRM_Core_DAO_File(); | |
146 | $op = 'create'; | |
147 | if (isset($dao->cfID) && $dao->cfID) { | |
148 | $op = 'edit'; | |
149 | $fileDAO->id = $dao->cfID; | |
150 | unlink($directoryName . DIRECTORY_SEPARATOR . $dao->uri); | |
151 | } | |
152 | ||
153 | if (!empty($fileParams)) { | |
154 | $fileDAO->copyValues($fileParams); | |
155 | } | |
156 | ||
157 | $fileDAO->uri = $filename; | |
158 | $fileDAO->mime_type = $mimeType; | |
159 | $fileDAO->file_type_id = $fileTypeID; | |
77ca21d6 | 160 | $fileDAO->upload_date = date('YmdHis'); |
0c56e4c8 TO |
161 | $fileDAO->save(); |
162 | ||
163 | // need to add/update civicrm_entity_file | |
164 | $entityFileDAO = new CRM_Core_DAO_EntityFile(); | |
165 | if (isset($dao->cefID) && $dao->cefID) { | |
166 | $entityFileDAO->id = $dao->cefID; | |
167 | } | |
168 | $entityFileDAO->entity_table = $entityTable; | |
169 | $entityFileDAO->entity_id = $entityID; | |
170 | $entityFileDAO->file_id = $fileDAO->id; | |
171 | $entityFileDAO->save(); | |
172 | ||
173 | //save static tags | |
174 | if (!empty($fileParams['tag'])) { | |
175 | CRM_Core_BAO_EntityTag::create($fileParams['tag'], 'civicrm_file', $entityFileDAO->id); | |
176 | } | |
177 | ||
178 | //save free tags | |
179 | if (isset($fileParams['attachment_taglist']) && !empty($fileParams['attachment_taglist'])) { | |
1273d77c | 180 | CRM_Core_Form_Tag::postProcess($fileParams['attachment_taglist'], $entityFileDAO->id, 'civicrm_file'); |
0c56e4c8 TO |
181 | } |
182 | ||
183 | // lets call the post hook here so attachments code can do the right stuff | |
184 | CRM_Utils_Hook::post($op, 'File', $fileDAO->id, $fileDAO); | |
185 | } | |
186 | ||
187 | /** | |
ad37ac8e | 188 | * A static function wrapper that deletes the various objects. |
189 | * | |
190 | * Objects are those hat are connected to a file object (i.e. file, entityFile and customValue. | |
191 | * | |
192 | * @param int $fileID | |
193 | * @param int $entityID | |
194 | * @param int $fieldID | |
195 | * | |
196 | * @throws \Exception | |
0c56e4c8 TO |
197 | */ |
198 | public static function deleteFileReferences($fileID, $entityID, $fieldID) { | |
199 | $fileDAO = new CRM_Core_DAO_File(); | |
200 | $fileDAO->id = $fileID; | |
201 | if (!$fileDAO->find(TRUE)) { | |
eea8ec44 | 202 | throw new CRM_Core_Exception(ts('File not found')); |
0c56e4c8 TO |
203 | } |
204 | ||
205 | // lets call a pre hook before the delete, so attachments hooks can get the info before things | |
206 | // disappear | |
207 | CRM_Utils_Hook::pre('delete', 'File', $fileID, $fileDAO); | |
208 | ||
209 | // get the table and column name | |
210 | list($tableName, $columnName, $groupID) = CRM_Core_BAO_CustomField::getTableColumnGroup($fieldID); | |
211 | ||
212 | $entityFileDAO = new CRM_Core_DAO_EntityFile(); | |
213 | $entityFileDAO->file_id = $fileID; | |
214 | $entityFileDAO->entity_id = $entityID; | |
215 | $entityFileDAO->entity_table = $tableName; | |
216 | ||
217 | if (!$entityFileDAO->find(TRUE)) { | |
eea8ec44 | 218 | throw new CRM_Core_Exception(sprintf('No record found for given file ID - %d and entity ID - %d', $fileID, $entityID)); |
0c56e4c8 TO |
219 | } |
220 | ||
221 | $entityFileDAO->delete(); | |
222 | $fileDAO->delete(); | |
223 | ||
224 | // also set the value to null of the table and column | |
225 | $query = "UPDATE $tableName SET $columnName = null WHERE $columnName = %1"; | |
be2fb01f | 226 | $params = [1 => [$fileID, 'Integer']]; |
0c56e4c8 TO |
227 | CRM_Core_DAO::executeQuery($query, $params); |
228 | } | |
229 | ||
230 | /** | |
231 | * The $useWhere is used so that the signature matches the parent class | |
0527cd81 | 232 | * |
353ffa53 TO |
233 | * public function delete($useWhere = FALSE) { |
234 | * list($fileID, $entityID, $fieldID) = func_get_args(); | |
235 | * | |
236 | * self::deleteFileReferences($fileID, $entityID, $fieldID); | |
237 | * } */ | |
0c56e4c8 TO |
238 | |
239 | /** | |
ad37ac8e | 240 | * Delete all the files and associated object associated with this combination. |
241 | * | |
242 | * @param string $entityTable | |
243 | * @param int $entityID | |
244 | * @param int $fileTypeID | |
245 | * @param int $fileID | |
246 | * | |
7b8bc7a1 SB |
247 | * @return bool |
248 | * Was file deleted? | |
0c56e4c8 | 249 | */ |
00be9182 | 250 | public static function deleteEntityFile($entityTable, $entityID, $fileTypeID = NULL, $fileID = NULL) { |
7b8bc7a1 | 251 | $isDeleted = FALSE; |
0c56e4c8 | 252 | if (empty($entityTable) || empty($entityID)) { |
7b8bc7a1 | 253 | return $isDeleted; |
0c56e4c8 TO |
254 | } |
255 | ||
256 | $config = CRM_Core_Config::singleton(); | |
257 | ||
258 | list($sql, $params) = self::sql($entityTable, $entityID, $fileTypeID, $fileID); | |
259 | $dao = CRM_Core_DAO::executeQuery($sql, $params); | |
260 | ||
be2fb01f CW |
261 | $cfIDs = []; |
262 | $cefIDs = []; | |
0c56e4c8 TO |
263 | while ($dao->fetch()) { |
264 | $cfIDs[$dao->cfID] = $dao->uri; | |
265 | $cefIDs[] = $dao->cefID; | |
266 | } | |
267 | ||
b28600f5 CW |
268 | // Delete tags from entity tag table. |
269 | if (!empty($cfIDs)) { | |
270 | $deleteFiles = []; | |
271 | foreach ($cfIDs as $fId => $fUri) { | |
272 | $tagParams = [ | |
273 | 'entity_table' => 'civicrm_file', | |
274 | 'entity_id' => $fId, | |
275 | ]; | |
276 | CRM_Core_BAO_EntityTag::del($tagParams); | |
277 | } | |
278 | } | |
279 | ||
280 | // Delete entries from entity file table. | |
0c56e4c8 TO |
281 | if (!empty($cefIDs)) { |
282 | $cefIDs = implode(',', $cefIDs); | |
283 | $sql = "DELETE FROM civicrm_entity_file where id IN ( $cefIDs )"; | |
284 | CRM_Core_DAO::executeQuery($sql); | |
7b8bc7a1 | 285 | $isDeleted = TRUE; |
0c56e4c8 TO |
286 | } |
287 | ||
288 | if (!empty($cfIDs)) { | |
be2fb01f | 289 | $deleteFiles = []; |
0c56e4c8 | 290 | foreach ($cfIDs as $fId => $fUri) { |
b28600f5 | 291 | // Delete file only if there are no longer any entities using this file. |
0c56e4c8 TO |
292 | if (!CRM_Core_DAO::getFieldValue('CRM_Core_DAO_EntityFile', $fId, 'id', 'file_id')) { |
293 | unlink($config->customFileUploadDir . DIRECTORY_SEPARATOR . $fUri); | |
294 | $deleteFiles[$fId] = $fId; | |
295 | } | |
296 | } | |
297 | ||
b28600f5 | 298 | // Delete entries from file table. |
0c56e4c8 TO |
299 | if (!empty($deleteFiles)) { |
300 | $deleteFiles = implode(',', $deleteFiles); | |
301 | $sql = "DELETE FROM civicrm_file where id IN ( $deleteFiles )"; | |
302 | CRM_Core_DAO::executeQuery($sql); | |
303 | } | |
7b8bc7a1 | 304 | $isDeleted = TRUE; |
0c56e4c8 | 305 | } |
7b8bc7a1 | 306 | return $isDeleted; |
0c56e4c8 TO |
307 | } |
308 | ||
309 | /** | |
ad37ac8e | 310 | * Get all the files and associated object associated with this combination. |
311 | * | |
312 | * @param string $entityTable | |
313 | * @param int $entityID | |
314 | * @param bool $addDeleteArgs | |
315 | * | |
316 | * @return array|null | |
0c56e4c8 | 317 | */ |
00be9182 | 318 | public static function getEntityFile($entityTable, $entityID, $addDeleteArgs = FALSE) { |
0c56e4c8 TO |
319 | if (empty($entityTable) || !$entityID) { |
320 | $results = NULL; | |
321 | return $results; | |
322 | } | |
323 | ||
324 | $config = CRM_Core_Config::singleton(); | |
325 | ||
326 | list($sql, $params) = self::sql($entityTable, $entityID, NULL); | |
327 | $dao = CRM_Core_DAO::executeQuery($sql, $params); | |
be2fb01f | 328 | $results = []; |
0c56e4c8 | 329 | while ($dao->fetch()) { |
ff9aeadb | 330 | $fileHash = self::generateFileHash($dao->entity_id, $dao->cfID); |
0c56e4c8 TO |
331 | $result['fileID'] = $dao->cfID; |
332 | $result['entityID'] = $dao->cefID; | |
333 | $result['mime_type'] = $dao->mime_type; | |
334 | $result['fileName'] = $dao->uri; | |
335 | $result['description'] = $dao->description; | |
336 | $result['cleanName'] = CRM_Utils_File::cleanFileName($dao->uri); | |
337 | $result['fullPath'] = $config->customFileUploadDir . DIRECTORY_SEPARATOR . $dao->uri; | |
ff9aeadb | 338 | $result['url'] = CRM_Utils_System::url('civicrm/file', "reset=1&id={$dao->cfID}&eid={$dao->entity_id}&fcs={$fileHash}"); |
0c56e4c8 TO |
339 | $result['href'] = "<a href=\"{$result['url']}\">{$result['cleanName']}</a>"; |
340 | $result['tag'] = CRM_Core_BAO_EntityTag::getTag($dao->cfID, 'civicrm_file'); | |
30a0455f | 341 | $result['icon'] = CRM_Utils_File::getIconFromMimeType($dao->mime_type); |
0c56e4c8 | 342 | if ($addDeleteArgs) { |
06faabfa | 343 | $result['deleteURLArgs'] = self::deleteURLArgs($dao->entity_table, $dao->entity_id, $dao->cfID); |
0c56e4c8 TO |
344 | } |
345 | $results[$dao->cfID] = $result; | |
346 | } | |
347 | ||
348 | //fix tag names | |
be2fb01f | 349 | $tags = CRM_Core_PseudoConstant::get('CRM_Core_DAO_EntityTag', 'tag_id', ['onlyActive' => FALSE]); |
0c56e4c8 TO |
350 | |
351 | foreach ($results as &$values) { | |
352 | if (!empty($values['tag'])) { | |
be2fb01f | 353 | $tagNames = []; |
0c56e4c8 TO |
354 | foreach ($values['tag'] as $tid) { |
355 | $tagNames[] = $tags[$tid]; | |
356 | } | |
357 | $values['tag'] = implode(', ', $tagNames); | |
358 | } | |
359 | else { | |
360 | $values['tag'] = ''; | |
361 | } | |
362 | } | |
363 | ||
0c56e4c8 TO |
364 | return $results; |
365 | } | |
366 | ||
367 | /** | |
6a0b768e TO |
368 | * @param string $entityTable |
369 | * Table-name or "*" (to reference files directly by file-id). | |
06faabfa | 370 | * @param int $entityID |
100fef9d CW |
371 | * @param int $fileTypeID |
372 | * @param int $fileID | |
0c56e4c8 TO |
373 | * |
374 | * @return array | |
375 | */ | |
00be9182 | 376 | public static function sql($entityTable, $entityID, $fileTypeID = NULL, $fileID = NULL) { |
06faabfa TO |
377 | if ($entityTable == '*') { |
378 | // $entityID is the ID of a specific file | |
379 | $sql = " | |
380 | SELECT CF.id as cfID, | |
381 | CF.uri as uri, | |
382 | CF.mime_type as mime_type, | |
383 | CF.description as description, | |
384 | CEF.id as cefID, | |
385 | CEF.entity_table as entity_table, | |
386 | CEF.entity_id as entity_id | |
387 | FROM civicrm_file AS CF | |
388 | LEFT JOIN civicrm_entity_file AS CEF ON ( CEF.file_id = CF.id ) | |
389 | WHERE CF.id = %2"; | |
390 | ||
0db6c3e1 TO |
391 | } |
392 | else { | |
06faabfa | 393 | $sql = " |
0c56e4c8 | 394 | SELECT CF.id as cfID, |
6a488035 TO |
395 | CF.uri as uri, |
396 | CF.mime_type as mime_type, | |
397 | CF.description as description, | |
06faabfa TO |
398 | CEF.id as cefID, |
399 | CEF.entity_table as entity_table, | |
400 | CEF.entity_id as entity_id | |
0c56e4c8 TO |
401 | FROM civicrm_file AS CF |
402 | LEFT JOIN civicrm_entity_file AS CEF ON ( CEF.file_id = CF.id ) | |
403 | WHERE CEF.entity_table = %1 | |
404 | AND CEF.entity_id = %2"; | |
06faabfa | 405 | } |
0c56e4c8 | 406 | |
be2fb01f CW |
407 | $params = [ |
408 | 1 => [$entityTable, 'String'], | |
409 | 2 => [$entityID, 'Integer'], | |
410 | ]; | |
0c56e4c8 TO |
411 | |
412 | if ($fileTypeID !== NULL) { | |
413 | $sql .= " AND CF.file_type_id = %3"; | |
be2fb01f | 414 | $params[3] = [$fileTypeID, 'Integer']; |
0c56e4c8 TO |
415 | } |
416 | ||
417 | if ($fileID !== NULL) { | |
418 | $sql .= " AND CF.id = %4"; | |
be2fb01f | 419 | $params[4] = [$fileID, 'Integer']; |
0c56e4c8 TO |
420 | } |
421 | ||
be2fb01f | 422 | return [$sql, $params]; |
0c56e4c8 TO |
423 | } |
424 | ||
425 | /** | |
75fd1335 TO |
426 | * @param CRM_Core_Form $form |
427 | * @param string $entityTable | |
100fef9d | 428 | * @param int $entityID |
0c56e4c8 TO |
429 | * @param null $numAttachments |
430 | * @param bool $ajaxDelete | |
8d0370a1 EM |
431 | * |
432 | * @throws \CRM_Core_Exception | |
0c56e4c8 | 433 | */ |
00be9182 | 434 | public static function buildAttachment(&$form, $entityTable, $entityID = NULL, $numAttachments = NULL, $ajaxDelete = FALSE) { |
0c56e4c8 TO |
435 | |
436 | if (!$numAttachments) { | |
aaffa79f | 437 | $numAttachments = Civi::settings()->get('max_attachments'); |
0c56e4c8 TO |
438 | } |
439 | // Assign maxAttachments count to template for help message | |
440 | $form->assign('maxAttachments', $numAttachments); | |
441 | ||
442 | $config = CRM_Core_Config::singleton(); | |
443 | // set default max file size as 2MB | |
444 | $maxFileSize = $config->maxFileSize ? $config->maxFileSize : 2; | |
445 | ||
446 | $currentAttachmentInfo = self::getEntityFile($entityTable, $entityID, TRUE); | |
8d0370a1 | 447 | $totalAttachments = $currentAttachmentInfo ? count($currentAttachmentInfo) : 0; |
0c56e4c8 | 448 | if ($currentAttachmentInfo) { |
0c56e4c8 | 449 | $form->add('checkbox', 'is_delete_attachment', ts('Delete All Attachment(s)')); |
0c56e4c8 | 450 | } |
8d0370a1 | 451 | $form->assign('currentAttachmentInfo', $currentAttachmentInfo); |
0c56e4c8 TO |
452 | |
453 | if ($totalAttachments) { | |
454 | if ($totalAttachments >= $numAttachments) { | |
455 | $numAttachments = 0; | |
456 | } | |
457 | else { | |
458 | $numAttachments -= $totalAttachments; | |
459 | } | |
460 | } | |
461 | ||
462 | $form->assign('numAttachments', $numAttachments); | |
463 | ||
e0f9d6a2 | 464 | CRM_Core_BAO_Tag::getTags('civicrm_file', $tags, NULL, |
465 | ' ', TRUE); | |
0c56e4c8 TO |
466 | |
467 | // get tagset info | |
468 | $parentNames = CRM_Core_BAO_Tag::getTagSet('civicrm_file'); | |
469 | ||
470 | // add attachments | |
471 | for ($i = 1; $i <= $numAttachments; $i++) { | |
d00e9ef0 | 472 | $form->addElement('file', "attachFile_$i", ts('Attach File'), 'size=30 maxlength=221'); |
0c56e4c8 TO |
473 | $form->addUploadElement("attachFile_$i"); |
474 | $form->setMaxFileSize($maxFileSize * 1024 * 1024); | |
475 | $form->addRule("attachFile_$i", | |
476 | ts('File size should be less than %1 MByte(s)', | |
be2fb01f | 477 | [1 => $maxFileSize] |
0c56e4c8 TO |
478 | ), |
479 | 'maxfilesize', | |
480 | $maxFileSize * 1024 * 1024 | |
481 | ); | |
be2fb01f | 482 | $form->addElement('text', "attachDesc_$i", NULL, [ |
0c56e4c8 TO |
483 | 'size' => 40, |
484 | 'maxlength' => 255, | |
21dfd5f5 | 485 | 'placeholder' => ts('Description'), |
be2fb01f | 486 | ]); |
0c56e4c8 | 487 | |
8d0370a1 | 488 | $tagField = "tag_$i"; |
0c56e4c8 | 489 | if (!empty($tags)) { |
8d0370a1 | 490 | $form->add('select', $tagField, ts('Tags'), $tags, FALSE, |
be2fb01f | 491 | [ |
0c56e4c8 TO |
492 | 'id' => "tags_$i", |
493 | 'multiple' => 'multiple', | |
494 | 'class' => 'huge crm-select2', | |
21dfd5f5 | 495 | 'placeholder' => ts('- none -'), |
be2fb01f | 496 | ] |
0c56e4c8 TO |
497 | ); |
498 | } | |
8d0370a1 EM |
499 | else { |
500 | $form->addOptionalQuickFormElement($tagField); | |
501 | } | |
0c56e4c8 TO |
502 | CRM_Core_Form_Tag::buildQuickForm($form, $parentNames, 'civicrm_file', NULL, FALSE, TRUE, "file_taglist_$i"); |
503 | } | |
504 | } | |
505 | ||
506 | /** | |
11a3487e BT |
507 | * Return a HTML string, separated by $separator, |
508 | * where each item is an anchor link to the file, | |
509 | * with the filename as the link text. | |
0c56e4c8 | 510 | * |
5a4f6742 CW |
511 | * @param string $entityTable |
512 | * The entityTable to which the file is attached. | |
513 | * @param int $entityID | |
514 | * The id of the object in the above entityTable. | |
515 | * @param string $separator | |
516 | * The string separator where to implode the urls. | |
0c56e4c8 | 517 | * |
11a3487e BT |
518 | * @return string|null |
519 | * HTML list of attachment links, or null if no attachments | |
0c56e4c8 | 520 | */ |
00be9182 | 521 | public static function attachmentInfo($entityTable, $entityID, $separator = '<br />') { |
0c56e4c8 TO |
522 | if (!$entityID) { |
523 | return NULL; | |
524 | } | |
525 | ||
526 | $currentAttachments = self::getEntityFile($entityTable, $entityID); | |
527 | if (!empty($currentAttachments)) { | |
be2fb01f | 528 | $currentAttachmentURL = []; |
0c56e4c8 TO |
529 | foreach ($currentAttachments as $fileID => $attach) { |
530 | $currentAttachmentURL[] = $attach['href']; | |
531 | } | |
532 | return implode($separator, $currentAttachmentURL); | |
533 | } | |
534 | return NULL; | |
535 | } | |
536 | ||
537 | /** | |
538 | * @param $formValues | |
c490a46a | 539 | * @param array $params |
0c56e4c8 | 540 | * @param $entityTable |
100fef9d | 541 | * @param int $entityID |
0c56e4c8 | 542 | */ |
ae5ffbb7 | 543 | public static function formatAttachment( |
0c56e4c8 TO |
544 | &$formValues, |
545 | &$params, | |
546 | $entityTable, | |
547 | $entityID = NULL | |
548 | ) { | |
549 | ||
550 | // delete current attachments if applicable | |
551 | if ($entityID && !empty($formValues['is_delete_attachment'])) { | |
552 | CRM_Core_BAO_File::deleteEntityFile($entityTable, $entityID); | |
553 | } | |
554 | ||
aaffa79f | 555 | $numAttachments = Civi::settings()->get('max_attachments'); |
0c56e4c8 | 556 | |
0c56e4c8 TO |
557 | // setup all attachments |
558 | for ($i = 1; $i <= $numAttachments; $i++) { | |
559 | $attachName = "attachFile_$i"; | |
560 | $attachDesc = "attachDesc_$i"; | |
561 | $attachTags = "tag_$i"; | |
562 | $attachFreeTags = "file_taglist_$i"; | |
563 | if (isset($formValues[$attachName]) && !empty($formValues[$attachName])) { | |
564 | // add static tags if selects | |
be2fb01f | 565 | $tagParams = []; |
0c56e4c8 TO |
566 | if (!empty($formValues[$attachTags])) { |
567 | foreach ($formValues[$attachTags] as $tag) { | |
568 | $tagParams[$tag] = 1; | |
569 | } | |
570 | } | |
571 | ||
572 | // we dont care if the file is empty or not | |
573 | // CRM-7448 | |
be2fb01f | 574 | $extraParams = [ |
0c56e4c8 | 575 | 'description' => $formValues[$attachDesc], |
0c56e4c8 | 576 | 'tag' => $tagParams, |
6187cca4 | 577 | 'attachment_taglist' => $formValues[$attachFreeTags] ?? [], |
be2fb01f | 578 | ]; |
0c56e4c8 | 579 | |
90a73810 | 580 | CRM_Utils_File::formatFile($formValues, $attachName, $extraParams); |
cde03305 | 581 | |
7e27588c EM |
582 | // set the formatted attachment attributes to $params, later used |
583 | // to send mail with desired attachments | |
cde03305 | 584 | if (!empty($formValues[$attachName])) { |
585 | $params[$attachName] = $formValues[$attachName]; | |
586 | } | |
0c56e4c8 TO |
587 | } |
588 | } | |
589 | } | |
590 | ||
591 | /** | |
c490a46a | 592 | * @param array $params |
0c56e4c8 | 593 | * @param $entityTable |
100fef9d | 594 | * @param int $entityID |
0c56e4c8 | 595 | */ |
00be9182 | 596 | public static function processAttachment(&$params, $entityTable, $entityID) { |
8913e915 | 597 | $numAttachments = Civi::settings()->get('max_attachments_backend') ?? self::DEFAULT_MAX_ATTACHMENTS_BACKEND; |
0c56e4c8 TO |
598 | |
599 | for ($i = 1; $i <= $numAttachments; $i++) { | |
8913e915 D |
600 | if (isset($params["attachFile_$i"])) { |
601 | /** | |
602 | * Moved the second condition into its own if block to avoid changing | |
603 | * how it works if there happens to be an entry that is not an array, | |
604 | * since we now might exit loop early via newly added break below. | |
605 | */ | |
606 | if (is_array($params["attachFile_$i"])) { | |
607 | self::filePostProcess( | |
608 | $params["attachFile_$i"]['location'], | |
609 | NULL, | |
610 | $entityTable, | |
611 | $entityID, | |
612 | NULL, | |
613 | TRUE, | |
614 | $params["attachFile_$i"], | |
615 | "attachFile_$i", | |
616 | $params["attachFile_$i"]['type'] | |
617 | ); | |
618 | } | |
619 | } | |
620 | else { | |
621 | /** | |
622 | * No point looping 100 times if there aren't any more. | |
623 | * This assumes the array is continuous and doesn't skip array keys, | |
624 | * but (a) where would it be doing that, and (b) it would have caused | |
625 | * problems before anyway if there were skipped keys. | |
626 | */ | |
627 | break; | |
0c56e4c8 TO |
628 | } |
629 | } | |
630 | } | |
631 | ||
632 | /** | |
633 | * @return array | |
634 | */ | |
00be9182 | 635 | public static function uploadNames() { |
aaffa79f | 636 | $numAttachments = Civi::settings()->get('max_attachments'); |
0c56e4c8 | 637 | |
be2fb01f | 638 | $names = []; |
0c56e4c8 TO |
639 | for ($i = 1; $i <= $numAttachments; $i++) { |
640 | $names[] = "attachFile_{$i}"; | |
641 | } | |
642 | $names[] = 'uploadFile'; | |
643 | return $names; | |
644 | } | |
645 | ||
d424ffde | 646 | /** |
c490a46a | 647 | * copy/attach an existing file to a different entity |
0c56e4c8 | 648 | * table and id. |
d424ffde | 649 | * |
0c56e4c8 | 650 | * @param $oldEntityTable |
100fef9d | 651 | * @param int $oldEntityId |
0c56e4c8 | 652 | * @param $newEntityTable |
100fef9d | 653 | * @param int $newEntityId |
0c56e4c8 | 654 | */ |
00be9182 | 655 | public static function copyEntityFile($oldEntityTable, $oldEntityId, $newEntityTable, $newEntityId) { |
6a488035 TO |
656 | $oldEntityFile = new CRM_Core_DAO_EntityFile(); |
657 | $oldEntityFile->entity_id = $oldEntityId; | |
658 | $oldEntityFile->entity_table = $oldEntityTable; | |
659 | $oldEntityFile->find(); | |
660 | ||
661 | while ($oldEntityFile->fetch()) { | |
662 | $newEntityFile = new CRM_Core_DAO_EntityFile(); | |
663 | $newEntityFile->entity_id = $newEntityId; | |
664 | $newEntityFile->entity_table = $newEntityTable; | |
665 | $newEntityFile->file_id = $oldEntityFile->file_id; | |
666 | $newEntityFile->save(); | |
667 | } | |
668 | } | |
669 | ||
0c56e4c8 TO |
670 | /** |
671 | * @param $entityTable | |
100fef9d CW |
672 | * @param int $entityID |
673 | * @param int $fileID | |
0c56e4c8 TO |
674 | * |
675 | * @return string | |
676 | */ | |
00be9182 | 677 | public static function deleteURLArgs($entityTable, $entityID, $fileID) { |
6a488035 | 678 | $params['entityTable'] = $entityTable; |
0c56e4c8 TO |
679 | $params['entityID'] = $entityID; |
680 | $params['fileID'] = $fileID; | |
6a488035 TO |
681 | |
682 | $signer = new CRM_Utils_Signer(CRM_Core_Key::privateKey(), self::$_signableFields); | |
683 | $params['_sgn'] = $signer->sign($params); | |
684 | return CRM_Utils_System::makeQueryString($params); | |
685 | } | |
686 | ||
687 | /** | |
100fef9d | 688 | * Delete a file attachment from an entity table / entity ID |
ac15829d | 689 | * @throws CRM_Core_Exception |
6a488035 | 690 | */ |
00be9182 | 691 | public static function deleteAttachment() { |
be2fb01f | 692 | $params = []; |
0c56e4c8 TO |
693 | $params['entityTable'] = CRM_Utils_Request::retrieve('entityTable', 'String', CRM_Core_DAO::$_nullObject, TRUE); |
694 | $params['entityID'] = CRM_Utils_Request::retrieve('entityID', 'Positive', CRM_Core_DAO::$_nullObject, TRUE); | |
695 | $params['fileID'] = CRM_Utils_Request::retrieve('fileID', 'Positive', CRM_Core_DAO::$_nullObject, TRUE); | |
6a488035 | 696 | |
0c56e4c8 | 697 | $signature = CRM_Utils_Request::retrieve('_sgn', 'String', CRM_Core_DAO::$_nullObject, TRUE); |
6a488035 TO |
698 | |
699 | $signer = new CRM_Utils_Signer(CRM_Core_Key::privateKey(), self::$_signableFields); | |
0c56e4c8 | 700 | if (!$signer->validate($signature, $params)) { |
ac15829d | 701 | throw new CRM_Core_Exception('Request signature is invalid'); |
6a488035 TO |
702 | } |
703 | ||
33d245c8 | 704 | self::deleteEntityFile($params['entityTable'], $params['entityID'], NULL, $params['fileID']); |
6a488035 TO |
705 | } |
706 | ||
34f51a07 | 707 | /** |
100fef9d | 708 | * Display paper icon for a file attachment -- CRM-13624 |
34f51a07 | 709 | * |
5a4f6742 CW |
710 | * @param string $entityTable |
711 | * The entityTable to which the file is attached. eg "civicrm_contact", "civicrm_note", "civicrm_activity". | |
06faabfa | 712 | * If you have the ID of a specific row in civicrm_file, use $entityTable='*' |
5a4f6742 CW |
713 | * @param int $entityID |
714 | * The id of the object in the above entityTable. | |
1a7ab71e | 715 | * |
72b3a70c CW |
716 | * @return array|NULL |
717 | * list of HTML snippets; one HTML snippet for each attachment. If none found, then NULL | |
1a7ab71e | 718 | * |
34f51a07 | 719 | */ |
00be9182 | 720 | public static function paperIconAttachment($entityTable, $entityID) { |
0c56e4c8 TO |
721 | if (empty($entityTable) || !$entityID) { |
722 | $results = NULL; | |
723 | return $results; | |
724 | } | |
725 | $currentAttachmentInfo = self::getEntityFile($entityTable, $entityID); | |
726 | foreach ($currentAttachmentInfo as $fileKey => $fileValue) { | |
34f51a07 | 727 | $fileID = $fileValue['fileID']; |
0c56e4c8 | 728 | if ($fileID) { |
b9773de0 CW |
729 | $fileType = $fileValue['mime_type']; |
730 | $url = $fileValue['url']; | |
731 | $title = $fileValue['cleanName']; | |
34f51a07 | 732 | if ($fileType == 'image/jpeg' || |
0c56e4c8 TO |
733 | $fileType == 'image/pjpeg' || |
734 | $fileType == 'image/gif' || | |
735 | $fileType == 'image/x-png' || | |
736 | $fileType == 'image/png' | |
737 | ) { | |
13a3d214 AH |
738 | $file_url[$fileID] = <<<HEREDOC |
739 | <a href="$url" class="crm-image-popup" title="$title"> | |
740 | <i class="crm-i fa-file-image-o" aria-hidden="true"></i> | |
741 | </a> | |
742 | HEREDOC; | |
34f51a07 | 743 | } |
b9773de0 | 744 | // for non image files |
34f51a07 | 745 | else { |
13a3d214 AH |
746 | $file_url[$fileID] = <<<HEREDOC |
747 | <a href="$url" title="$title"> | |
748 | <i class="crm-i fa-paperclip" aria-hidden="true"></i> | |
749 | </a> | |
750 | HEREDOC; | |
34f51a07 N |
751 | } |
752 | } | |
753 | } | |
0c56e4c8 TO |
754 | if (empty($file_url)) { |
755 | $results = NULL; | |
34f51a07 N |
756 | } |
757 | else { | |
0c56e4c8 | 758 | $results = $file_url; |
34f51a07 N |
759 | } |
760 | return $results; | |
761 | } | |
6cccc6d4 TO |
762 | |
763 | /** | |
764 | * Get a reference to the file-search service (if one is available). | |
765 | * | |
766 | * @return CRM_Core_FileSearchInterface|NULL | |
767 | */ | |
00be9182 | 768 | public static function getSearchService() { |
be2fb01f | 769 | $fileSearches = []; |
6cccc6d4 TO |
770 | CRM_Utils_Hook::fileSearches($fileSearches); |
771 | ||
772 | // use the first available search | |
773 | foreach ($fileSearches as $fileSearch) { | |
774 | /** @var $fileSearch CRM_Core_FileSearchInterface */ | |
775 | return $fileSearch; | |
776 | } | |
777 | return NULL; | |
778 | } | |
96025800 | 779 | |
ff9aeadb | 780 | /** |
7618eb9d TO |
781 | * Generates an access-token for downloading a specific file. |
782 | * | |
efddd94f TO |
783 | * @param int $entityId entity id the file is attached to |
784 | * @param int $fileId file ID | |
518fa0ee SL |
785 | * @param int $genTs |
786 | * @param int $life | |
ff9aeadb SL |
787 | * @return string |
788 | */ | |
efddd94f | 789 | public static function generateFileHash($entityId = NULL, $fileId = NULL, $genTs = NULL, $life = NULL) { |
ff9aeadb | 790 | // Use multiple (but stable) inputs for hash information. |
65d060f5 TO |
791 | $siteKey = CRM_Utils_Constant::value('CIVICRM_SITE_KEY'); |
792 | if (!$siteKey) { | |
793 | throw new \CRM_Core_Exception("Cannot generate file access token. Please set CIVICRM_SITE_KEY."); | |
794 | } | |
b68895ad SL |
795 | |
796 | if (!$genTs) { | |
797 | $genTs = time(); | |
798 | } | |
799 | if (!$life) { | |
54a043e4 | 800 | $days = Civi::settings()->get('checksum_timeout'); |
efddd94f | 801 | $life = 24 * $days; |
b68895ad | 802 | } |
ff9aeadb SL |
803 | // Trim 8 chars off the string, make it slightly easier to find |
804 | // but reveals less information from the hash. | |
efddd94f | 805 | $cs = hash_hmac('sha256', "entity={$entityId}&file={$fileId}&life={$life}", $siteKey); |
b68895ad | 806 | return "{$cs}_{$genTs}_{$life}"; |
ff9aeadb SL |
807 | } |
808 | ||
c5c40df7 | 809 | /** |
7618eb9d TO |
810 | * Validate a file access token. |
811 | * | |
c5c40df7 | 812 | * @param string $hash |
7618eb9d TO |
813 | * @param int $entityId Entity Id the file is attached to |
814 | * @param int $fileId File Id | |
c5c40df7 TO |
815 | * @return bool |
816 | */ | |
7618eb9d | 817 | public static function validateFileHash($hash, $entityId, $fileId) { |
c5c40df7 | 818 | $input = CRM_Utils_System::explode('_', $hash, 3); |
9c1bc317 CW |
819 | $inputTs = $input[1] ?? NULL; |
820 | $inputLF = $input[2] ?? NULL; | |
7618eb9d | 821 | $testHash = CRM_Core_BAO_File::generateFileHash($entityId, $fileId, $inputTs, $inputLF); |
c5c40df7 TO |
822 | if (hash_equals($testHash, $hash)) { |
823 | $now = time(); | |
824 | if ($inputTs + ($inputLF * 60 * 60) >= $now) { | |
825 | return TRUE; | |
826 | } | |
827 | else { | |
828 | return FALSE; | |
829 | } | |
830 | } | |
831 | return FALSE; | |
832 | } | |
833 | ||
b2aaa85e | 834 | } |