3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2019
37 * BAO object for crm_log table
39 class CRM_Core_BAO_File
extends CRM_Core_DAO_File
{
41 static $_signableFields = array('entityTable', 'entityID', 'fileID');
44 * Takes an associative array and creates a File object.
46 * @param array $params
47 * (reference ) an assoc array of name/value pairs.
49 * @return CRM_Core_BAO_File
51 public static function create($params) {
52 $fileDAO = new CRM_Core_DAO_File();
54 $op = empty($params['id']) ?
'create' : 'edit';
56 CRM_Utils_Hook
::pre($op, 'File', CRM_Utils_Array
::value('id', $params), $params);
58 $fileDAO->copyValues($params);
60 if (empty($params['id']) && empty($params['created_id'])) {
61 $fileDAO->created_id
= CRM_Core_Session
::getLoggedInContactID();
66 CRM_Utils_Hook
::post($op, 'File', $fileDAO->id
, $fileDAO);
73 * @param int $entityID
77 public static function path($fileID, $entityID) {
78 $entityFileDAO = new CRM_Core_DAO_EntityFile();
79 $entityFileDAO->entity_id
= $entityID;
80 $entityFileDAO->file_id
= $fileID;
82 if ($entityFileDAO->find(TRUE)) {
83 $fileDAO = new CRM_Core_DAO_File();
84 $fileDAO->id
= $fileID;
85 if ($fileDAO->find(TRUE)) {
86 $config = CRM_Core_Config
::singleton();
87 $path = $config->customFileUploadDir
. $fileDAO->uri
;
89 if (file_exists($path) && is_readable($path)) {
90 return array($path, $fileDAO->mime_type
);
95 return array(NULL, NULL);
101 * @param int $fileTypeID
102 * @param $entityTable
103 * @param int $entityID
104 * @param $entitySubtype
105 * @param bool $overwrite
106 * @param null|array $fileParams
107 * @param string $uploadName
108 * @param null $mimeType
112 public static function filePostProcess(
120 $uploadName = 'uploadFile',
124 CRM_Core_Error
::statusBounce(ts('Mime Type is now a required parameter for file upload'));
127 $config = CRM_Core_Config
::singleton();
129 $path = explode('/', $data);
130 $filename = $path[count($path) - 1];
132 // rename this file to go into the secure directory
133 if ($entitySubtype) {
134 $directoryName = $config->customFileUploadDir
. $entitySubtype . DIRECTORY_SEPARATOR
. $entityID;
137 $directoryName = $config->customFileUploadDir
;
140 CRM_Utils_File
::createDir($directoryName);
142 if (!rename($data, $directoryName . DIRECTORY_SEPARATOR
. $filename)) {
143 CRM_Core_Error
::statusBounce(ts('Could not move custom file to custom upload directory'));
147 if ($overwrite && $fileTypeID) {
148 list($sql, $params) = self
::sql($entityTable, $entityID, $fileTypeID);
151 list($sql, $params) = self
::sql($entityTable, $entityID, 0);
154 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
157 $fileDAO = new CRM_Core_DAO_File();
159 if (isset($dao->cfID
) && $dao->cfID
) {
161 $fileDAO->id
= $dao->cfID
;
162 unlink($directoryName . DIRECTORY_SEPARATOR
. $dao->uri
);
165 if (!empty($fileParams)) {
166 $fileDAO->copyValues($fileParams);
169 $fileDAO->uri
= $filename;
170 $fileDAO->mime_type
= $mimeType;
171 $fileDAO->file_type_id
= $fileTypeID;
172 $fileDAO->upload_date
= date('YmdHis');
175 // need to add/update civicrm_entity_file
176 $entityFileDAO = new CRM_Core_DAO_EntityFile();
177 if (isset($dao->cefID
) && $dao->cefID
) {
178 $entityFileDAO->id
= $dao->cefID
;
180 $entityFileDAO->entity_table
= $entityTable;
181 $entityFileDAO->entity_id
= $entityID;
182 $entityFileDAO->file_id
= $fileDAO->id
;
183 $entityFileDAO->save();
186 if (!empty($fileParams['tag'])) {
187 CRM_Core_BAO_EntityTag
::create($fileParams['tag'], 'civicrm_file', $entityFileDAO->id
);
191 if (isset($fileParams['attachment_taglist']) && !empty($fileParams['attachment_taglist'])) {
192 CRM_Core_Form_Tag
::postProcess($fileParams['attachment_taglist'], $entityFileDAO->id
, 'civicrm_file');
195 // lets call the post hook here so attachments code can do the right stuff
196 CRM_Utils_Hook
::post($op, 'File', $fileDAO->id
, $fileDAO);
200 * A static function wrapper that deletes the various objects.
202 * Objects are those hat are connected to a file object (i.e. file, entityFile and customValue.
205 * @param int $entityID
206 * @param int $fieldID
210 public static function deleteFileReferences($fileID, $entityID, $fieldID) {
211 $fileDAO = new CRM_Core_DAO_File();
212 $fileDAO->id
= $fileID;
213 if (!$fileDAO->find(TRUE)) {
214 CRM_Core_Error
::fatal();
217 // lets call a pre hook before the delete, so attachments hooks can get the info before things
219 CRM_Utils_Hook
::pre('delete', 'File', $fileID, $fileDAO);
221 // get the table and column name
222 list($tableName, $columnName, $groupID) = CRM_Core_BAO_CustomField
::getTableColumnGroup($fieldID);
224 $entityFileDAO = new CRM_Core_DAO_EntityFile();
225 $entityFileDAO->file_id
= $fileID;
226 $entityFileDAO->entity_id
= $entityID;
227 $entityFileDAO->entity_table
= $tableName;
229 if (!$entityFileDAO->find(TRUE)) {
230 CRM_Core_Error
::fatal(sprintf('No record found for given file ID - %d and entity ID - %d', $fileID, $entityID));
233 $entityFileDAO->delete();
236 // also set the value to null of the table and column
237 $query = "UPDATE $tableName SET $columnName = null WHERE $columnName = %1";
238 $params = array(1 => array($fileID, 'Integer'));
239 CRM_Core_DAO
::executeQuery($query, $params);
243 * The $useWhere is used so that the signature matches the parent class
245 * public function delete($useWhere = FALSE) {
246 * list($fileID, $entityID, $fieldID) = func_get_args();
248 * self::deleteFileReferences($fileID, $entityID, $fieldID);
252 * Delete all the files and associated object associated with this combination.
254 * @param string $entityTable
255 * @param int $entityID
256 * @param int $fileTypeID
262 public static function deleteEntityFile($entityTable, $entityID, $fileTypeID = NULL, $fileID = NULL) {
264 if (empty($entityTable) ||
empty($entityID)) {
268 $config = CRM_Core_Config
::singleton();
270 list($sql, $params) = self
::sql($entityTable, $entityID, $fileTypeID, $fileID);
271 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
275 while ($dao->fetch()) {
276 $cfIDs[$dao->cfID
] = $dao->uri
;
277 $cefIDs[] = $dao->cefID
;
280 if (!empty($cefIDs)) {
281 $cefIDs = implode(',', $cefIDs);
282 $sql = "DELETE FROM civicrm_entity_file where id IN ( $cefIDs )";
283 CRM_Core_DAO
::executeQuery($sql);
287 if (!empty($cfIDs)) {
288 // Delete file only if there no any entity using this file.
289 $deleteFiles = array();
290 foreach ($cfIDs as $fId => $fUri) {
291 //delete tags from entity tag table
293 'entity_table' => 'civicrm_file',
297 CRM_Core_BAO_EntityTag
::del($tagParams);
299 if (!CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_EntityFile', $fId, 'id', 'file_id')) {
300 unlink($config->customFileUploadDir
. DIRECTORY_SEPARATOR
. $fUri);
301 $deleteFiles[$fId] = $fId;
305 if (!empty($deleteFiles)) {
306 $deleteFiles = implode(',', $deleteFiles);
307 $sql = "DELETE FROM civicrm_file where id IN ( $deleteFiles )";
308 CRM_Core_DAO
::executeQuery($sql);
316 * Get all the files and associated object associated with this combination.
318 * @param string $entityTable
319 * @param int $entityID
320 * @param bool $addDeleteArgs
324 public static function getEntityFile($entityTable, $entityID, $addDeleteArgs = FALSE) {
325 if (empty($entityTable) ||
!$entityID) {
330 $config = CRM_Core_Config
::singleton();
332 list($sql, $params) = self
::sql($entityTable, $entityID, NULL);
333 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
335 while ($dao->fetch()) {
336 $fileHash = self
::generateFileHash($dao->entity_id
, $dao->cfID
);
337 $result['fileID'] = $dao->cfID
;
338 $result['entityID'] = $dao->cefID
;
339 $result['mime_type'] = $dao->mime_type
;
340 $result['fileName'] = $dao->uri
;
341 $result['description'] = $dao->description
;
342 $result['cleanName'] = CRM_Utils_File
::cleanFileName($dao->uri
);
343 $result['fullPath'] = $config->customFileUploadDir
. DIRECTORY_SEPARATOR
. $dao->uri
;
344 $result['url'] = CRM_Utils_System
::url('civicrm/file', "reset=1&id={$dao->cfID}&eid={$dao->entity_id}&fcs={$fileHash}");
345 $result['href'] = "<a href=\"{$result['url']}\">{$result['cleanName']}</a>";
346 $result['tag'] = CRM_Core_BAO_EntityTag
::getTag($dao->cfID
, 'civicrm_file');
347 $result['icon'] = CRM_Utils_File
::getIconFromMimeType($dao->mime_type
);
348 if ($addDeleteArgs) {
349 $result['deleteURLArgs'] = self
::deleteURLArgs($dao->entity_table
, $dao->entity_id
, $dao->cfID
);
351 $results[$dao->cfID
] = $result;
355 $tags = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_EntityTag', 'tag_id', array('onlyActive' => FALSE));
357 foreach ($results as &$values) {
358 if (!empty($values['tag'])) {
360 foreach ($values['tag'] as $tid) {
361 $tagNames[] = $tags[$tid];
363 $values['tag'] = implode(', ', $tagNames);
375 * @param string $entityTable
376 * Table-name or "*" (to reference files directly by file-id).
377 * @param int $entityID
378 * @param int $fileTypeID
383 public static function sql($entityTable, $entityID, $fileTypeID = NULL, $fileID = NULL) {
384 if ($entityTable == '*') {
385 // $entityID is the ID of a specific file
387 SELECT CF.id as cfID,
389 CF.mime_type as mime_type,
390 CF.description as description,
392 CEF.entity_table as entity_table,
393 CEF.entity_id as entity_id
394 FROM civicrm_file AS CF
395 LEFT JOIN civicrm_entity_file AS CEF ON ( CEF.file_id = CF.id )
401 SELECT CF.id as cfID,
403 CF.mime_type as mime_type,
404 CF.description as description,
406 CEF.entity_table as entity_table,
407 CEF.entity_id as entity_id
408 FROM civicrm_file AS CF
409 LEFT JOIN civicrm_entity_file AS CEF ON ( CEF.file_id = CF.id )
410 WHERE CEF.entity_table = %1
411 AND CEF.entity_id = %2";
415 1 => array($entityTable, 'String'),
416 2 => array($entityID, 'Integer'),
419 if ($fileTypeID !== NULL) {
420 $sql .= " AND CF.file_type_id = %3";
421 $params[3] = array($fileTypeID, 'Integer');
424 if ($fileID !== NULL) {
425 $sql .= " AND CF.id = %4";
426 $params[4] = array($fileID, 'Integer');
429 return array($sql, $params);
433 * @param CRM_Core_Form $form
434 * @param string $entityTable
435 * @param int $entityID
436 * @param null $numAttachments
437 * @param bool $ajaxDelete
439 public static function buildAttachment(&$form, $entityTable, $entityID = NULL, $numAttachments = NULL, $ajaxDelete = FALSE) {
441 if (!$numAttachments) {
442 $numAttachments = Civi
::settings()->get('max_attachments');
444 // Assign maxAttachments count to template for help message
445 $form->assign('maxAttachments', $numAttachments);
447 $config = CRM_Core_Config
::singleton();
448 // set default max file size as 2MB
449 $maxFileSize = $config->maxFileSize ?
$config->maxFileSize
: 2;
451 $currentAttachmentInfo = self
::getEntityFile($entityTable, $entityID, TRUE);
452 $totalAttachments = 0;
453 if ($currentAttachmentInfo) {
454 $totalAttachments = count($currentAttachmentInfo);
455 $form->add('checkbox', 'is_delete_attachment', ts('Delete All Attachment(s)'));
456 $form->assign('currentAttachmentInfo', $currentAttachmentInfo);
459 $form->assign('currentAttachmentInfo', NULL);
462 if ($totalAttachments) {
463 if ($totalAttachments >= $numAttachments) {
467 $numAttachments -= $totalAttachments;
471 $form->assign('numAttachments', $numAttachments);
473 CRM_Core_BAO_Tag
::getTags('civicrm_file', $tags, NULL,
474 ' ', TRUE);
477 $parentNames = CRM_Core_BAO_Tag
::getTagSet('civicrm_file');
480 for ($i = 1; $i <= $numAttachments; $i++
) {
481 $form->addElement('file', "attachFile_$i", ts('Attach File'), 'size=30 maxlength=221');
482 $form->addUploadElement("attachFile_$i");
483 $form->setMaxFileSize($maxFileSize * 1024 * 1024);
484 $form->addRule("attachFile_$i",
485 ts('File size should be less than %1 MByte(s)',
486 array(1 => $maxFileSize)
489 $maxFileSize * 1024 * 1024
491 $form->addElement('text', "attachDesc_$i", NULL, array(
494 'placeholder' => ts('Description'),
498 $form->add('select', "tag_$i", ts('Tags'), $tags, FALSE,
501 'multiple' => 'multiple',
502 'class' => 'huge crm-select2',
503 'placeholder' => ts('- none -'),
507 CRM_Core_Form_Tag
::buildQuickForm($form, $parentNames, 'civicrm_file', NULL, FALSE, TRUE, "file_taglist_$i");
512 * Return a clean url string and the number of attachment for a
513 * given entityTable, entityID
515 * @param string $entityTable
516 * The entityTable to which the file is attached.
517 * @param int $entityID
518 * The id of the object in the above entityTable.
519 * @param string $separator
520 * The string separator where to implode the urls.
523 * An array with 2 elements. The string and the number of attachments
525 public static function attachmentInfo($entityTable, $entityID, $separator = '<br />') {
530 $currentAttachments = self
::getEntityFile($entityTable, $entityID);
531 if (!empty($currentAttachments)) {
532 $currentAttachmentURL = array();
533 foreach ($currentAttachments as $fileID => $attach) {
534 $currentAttachmentURL[] = $attach['href'];
536 return implode($separator, $currentAttachmentURL);
543 * @param array $params
544 * @param $entityTable
545 * @param int $entityID
547 public static function formatAttachment(
554 // delete current attachments if applicable
555 if ($entityID && !empty($formValues['is_delete_attachment'])) {
556 CRM_Core_BAO_File
::deleteEntityFile($entityTable, $entityID);
559 $numAttachments = Civi
::settings()->get('max_attachments');
561 // setup all attachments
562 for ($i = 1; $i <= $numAttachments; $i++
) {
563 $attachName = "attachFile_$i";
564 $attachDesc = "attachDesc_$i";
565 $attachTags = "tag_$i";
566 $attachFreeTags = "file_taglist_$i";
567 if (isset($formValues[$attachName]) && !empty($formValues[$attachName])) {
568 // add static tags if selects
569 $tagParams = array();
570 if (!empty($formValues[$attachTags])) {
571 foreach ($formValues[$attachTags] as $tag) {
572 $tagParams[$tag] = 1;
576 // we dont care if the file is empty or not
578 $extraParams = array(
579 'description' => $formValues[$attachDesc],
581 'attachment_taglist' => CRM_Utils_Array
::value($attachFreeTags, $formValues, array()),
584 CRM_Utils_File
::formatFile($formValues, $attachName, $extraParams);
586 // set the formatted attachment attributes to $params, later used by
587 // CRM_Activity_BAO_Activity::sendEmail(...) to send mail with desired attachments
588 if (!empty($formValues[$attachName])) {
589 $params[$attachName] = $formValues[$attachName];
596 * @param array $params
597 * @param $entityTable
598 * @param int $entityID
600 public static function processAttachment(&$params, $entityTable, $entityID) {
601 $numAttachments = Civi
::settings()->get('max_attachments');
603 for ($i = 1; $i <= $numAttachments; $i++
) {
605 isset($params["attachFile_$i"]) &&
606 is_array($params["attachFile_$i"])
608 self
::filePostProcess(
609 $params["attachFile_$i"]['location'],
615 $params["attachFile_$i"],
617 $params["attachFile_$i"]['type']
626 public static function uploadNames() {
627 $numAttachments = Civi
::settings()->get('max_attachments');
630 for ($i = 1; $i <= $numAttachments; $i++
) {
631 $names[] = "attachFile_{$i}";
633 $names[] = 'uploadFile';
638 * copy/attach an existing file to a different entity
641 * @param $oldEntityTable
642 * @param int $oldEntityId
643 * @param $newEntityTable
644 * @param int $newEntityId
646 public static function copyEntityFile($oldEntityTable, $oldEntityId, $newEntityTable, $newEntityId) {
647 $oldEntityFile = new CRM_Core_DAO_EntityFile();
648 $oldEntityFile->entity_id
= $oldEntityId;
649 $oldEntityFile->entity_table
= $oldEntityTable;
650 $oldEntityFile->find();
652 while ($oldEntityFile->fetch()) {
653 $newEntityFile = new CRM_Core_DAO_EntityFile();
654 $newEntityFile->entity_id
= $newEntityId;
655 $newEntityFile->entity_table
= $newEntityTable;
656 $newEntityFile->file_id
= $oldEntityFile->file_id
;
657 $newEntityFile->save();
662 * @param $entityTable
663 * @param int $entityID
668 public static function deleteURLArgs($entityTable, $entityID, $fileID) {
669 $params['entityTable'] = $entityTable;
670 $params['entityID'] = $entityID;
671 $params['fileID'] = $fileID;
673 $signer = new CRM_Utils_Signer(CRM_Core_Key
::privateKey(), self
::$_signableFields);
674 $params['_sgn'] = $signer->sign($params);
675 return CRM_Utils_System
::makeQueryString($params);
679 * Delete a file attachment from an entity table / entity ID
682 public static function deleteAttachment() {
684 $params['entityTable'] = CRM_Utils_Request
::retrieve('entityTable', 'String', CRM_Core_DAO
::$_nullObject, TRUE);
685 $params['entityID'] = CRM_Utils_Request
::retrieve('entityID', 'Positive', CRM_Core_DAO
::$_nullObject, TRUE);
686 $params['fileID'] = CRM_Utils_Request
::retrieve('fileID', 'Positive', CRM_Core_DAO
::$_nullObject, TRUE);
688 $signature = CRM_Utils_Request
::retrieve('_sgn', 'String', CRM_Core_DAO
::$_nullObject, TRUE);
690 $signer = new CRM_Utils_Signer(CRM_Core_Key
::privateKey(), self
::$_signableFields);
691 if (!$signer->validate($signature, $params)) {
692 CRM_Core_Error
::fatal('Request signature is invalid');
695 self
::deleteEntityFile($params['entityTable'], $params['entityID'], NULL, $params['fileID']);
700 * Display paper icon for a file attachment -- CRM-13624
702 * @param string $entityTable
703 * The entityTable to which the file is attached. eg "civicrm_contact", "civicrm_note", "civicrm_activity".
704 * If you have the ID of a specific row in civicrm_file, use $entityTable='*'
705 * @param int $entityID
706 * The id of the object in the above entityTable.
709 * list of HTML snippets; one HTML snippet for each attachment. If none found, then NULL
712 public static function paperIconAttachment($entityTable, $entityID) {
713 if (empty($entityTable) ||
!$entityID) {
717 $currentAttachmentInfo = self
::getEntityFile($entityTable, $entityID);
718 foreach ($currentAttachmentInfo as $fileKey => $fileValue) {
719 $fileID = $fileValue['fileID'];
721 $fileType = $fileValue['mime_type'];
722 $url = $fileValue['url'];
723 $title = $fileValue['cleanName'];
724 if ($fileType == 'image/jpeg' ||
725 $fileType == 'image/pjpeg' ||
726 $fileType == 'image/gif' ||
727 $fileType == 'image/x-png' ||
728 $fileType == 'image/png'
730 $file_url[$fileID] = "
731 <a href='$url' class='crm-image-popup' title='$title'>
732 <i class='crm-i fa-file-image-o'></i>
735 // for non image files
737 $file_url[$fileID] = "
738 <a href='$url' title='$title'>
739 <i class='crm-i fa-paperclip'></i>
744 if (empty($file_url)) {
748 $results = $file_url;
754 * Get a reference to the file-search service (if one is available).
756 * @return CRM_Core_FileSearchInterface|NULL
758 public static function getSearchService() {
759 $fileSearches = array();
760 CRM_Utils_Hook
::fileSearches($fileSearches);
762 // use the first available search
763 foreach ($fileSearches as $fileSearch) {
764 /** @var $fileSearch CRM_Core_FileSearchInterface */
771 * Generates a MD5 Hash to be appended to file URLS to be checked when trying to download the file.
772 * @param int $eid entity id the file is attached to
773 * @param int $fid file ID
776 public static function generateFileHash($eid = NULL, $fid = NULL, $genTs = NULL, $life = NULL) {
777 // Use multiple (but stable) inputs for hash information.
778 $siteKey = defined('CIVICRM_SITE_KEY') ? CIVICRM_SITE_KEY
: 'NO_SITE_KEY';
786 // Trim 8 chars off the string, make it slightly easier to find
787 // but reveals less information from the hash.
788 $cs = hash_hmac('sha256', "{$fid}_{$life}", $siteKey);
789 return "{$cs}_{$genTs}_{$life}";