3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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-2017
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');
45 * @param int $entityID
46 * @param null $entityTable
50 public static function path($fileID, $entityID, $entityTable = NULL) {
51 $entityFileDAO = new CRM_Core_DAO_EntityFile();
53 $entityFileDAO->entity_table
= $entityTable;
55 $entityFileDAO->entity_id
= $entityID;
56 $entityFileDAO->file_id
= $fileID;
58 if ($entityFileDAO->find(TRUE)) {
59 $fileDAO = new CRM_Core_DAO_File();
60 $fileDAO->id
= $fileID;
61 if ($fileDAO->find(TRUE)) {
62 $config = CRM_Core_Config
::singleton();
63 $path = $config->customFileUploadDir
. $fileDAO->uri
;
65 if (file_exists($path) && is_readable($path)) {
66 return array($path, $fileDAO->mime_type
);
71 return array(NULL, NULL);
77 * @param int $fileTypeID
79 * @param int $entityID
80 * @param $entitySubtype
81 * @param bool $overwrite
82 * @param null|array $fileParams
83 * @param string $uploadName
84 * @param null $mimeType
88 public static function filePostProcess(
96 $uploadName = 'uploadFile',
100 CRM_Core_Error
::statusBounce(ts('Mime Type is now a required parameter for file upload'));
103 $config = CRM_Core_Config
::singleton();
105 $path = explode('/', $data);
106 $filename = $path[count($path) - 1];
108 // rename this file to go into the secure directory
109 if ($entitySubtype) {
110 $directoryName = $config->customFileUploadDir
. $entitySubtype . DIRECTORY_SEPARATOR
. $entityID;
113 $directoryName = $config->customFileUploadDir
;
116 CRM_Utils_File
::createDir($directoryName);
118 if (!rename($data, $directoryName . DIRECTORY_SEPARATOR
. $filename)) {
119 CRM_Core_Error
::statusBounce(ts('Could not move custom file to custom upload directory'));
123 if ($overwrite && $fileTypeID) {
124 list($sql, $params) = self
::sql($entityTable, $entityID, $fileTypeID);
127 list($sql, $params) = self
::sql($entityTable, $entityID, 0);
130 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
133 $fileDAO = new CRM_Core_DAO_File();
135 if (isset($dao->cfID
) && $dao->cfID
) {
137 $fileDAO->id
= $dao->cfID
;
138 unlink($directoryName . DIRECTORY_SEPARATOR
. $dao->uri
);
141 if (!empty($fileParams)) {
142 $fileDAO->copyValues($fileParams);
145 $fileDAO->uri
= $filename;
146 $fileDAO->mime_type
= $mimeType;
147 $fileDAO->file_type_id
= $fileTypeID;
148 $fileDAO->upload_date
= date('YmdHis');
151 // need to add/update civicrm_entity_file
152 $entityFileDAO = new CRM_Core_DAO_EntityFile();
153 if (isset($dao->cefID
) && $dao->cefID
) {
154 $entityFileDAO->id
= $dao->cefID
;
156 $entityFileDAO->entity_table
= $entityTable;
157 $entityFileDAO->entity_id
= $entityID;
158 $entityFileDAO->file_id
= $fileDAO->id
;
159 $entityFileDAO->save();
162 if (!empty($fileParams['tag'])) {
163 CRM_Core_BAO_EntityTag
::create($fileParams['tag'], 'civicrm_file', $entityFileDAO->id
);
167 if (isset($fileParams['attachment_taglist']) && !empty($fileParams['attachment_taglist'])) {
168 CRM_Core_Form_Tag
::postProcess($fileParams['attachment_taglist'], $entityFileDAO->id
, 'civicrm_file');
171 // lets call the post hook here so attachments code can do the right stuff
172 CRM_Utils_Hook
::post($op, 'File', $fileDAO->id
, $fileDAO);
176 * A static function wrapper that deletes the various objects.
178 * Objects are those hat are connected to a file object (i.e. file, entityFile and customValue.
181 * @param int $entityID
182 * @param int $fieldID
186 public static function deleteFileReferences($fileID, $entityID, $fieldID) {
187 $fileDAO = new CRM_Core_DAO_File();
188 $fileDAO->id
= $fileID;
189 if (!$fileDAO->find(TRUE)) {
190 CRM_Core_Error
::fatal();
193 // lets call a pre hook before the delete, so attachments hooks can get the info before things
195 CRM_Utils_Hook
::pre('delete', 'File', $fileID, $fileDAO);
197 // get the table and column name
198 list($tableName, $columnName, $groupID) = CRM_Core_BAO_CustomField
::getTableColumnGroup($fieldID);
200 $entityFileDAO = new CRM_Core_DAO_EntityFile();
201 $entityFileDAO->file_id
= $fileID;
202 $entityFileDAO->entity_id
= $entityID;
203 $entityFileDAO->entity_table
= $tableName;
205 if (!$entityFileDAO->find(TRUE)) {
206 CRM_Core_Error
::fatal(sprintf('No record found for given file ID - %d and entity ID - %d', $fileID, $entityID));
209 $entityFileDAO->delete();
212 // also set the value to null of the table and column
213 $query = "UPDATE $tableName SET $columnName = null WHERE $columnName = %1";
214 $params = array(1 => array($fileID, 'Integer'));
215 CRM_Core_DAO
::executeQuery($query, $params);
219 * The $useWhere is used so that the signature matches the parent class
221 * public function delete($useWhere = FALSE) {
222 * list($fileID, $entityID, $fieldID) = func_get_args();
224 * self::deleteFileReferences($fileID, $entityID, $fieldID);
228 * Delete all the files and associated object associated with this combination.
230 * @param string $entityTable
231 * @param int $entityID
232 * @param int $fileTypeID
238 public static function deleteEntityFile($entityTable, $entityID, $fileTypeID = NULL, $fileID = NULL) {
240 if (empty($entityTable) ||
empty($entityID)) {
244 $config = CRM_Core_Config
::singleton();
246 list($sql, $params) = self
::sql($entityTable, $entityID, $fileTypeID, $fileID);
247 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
251 while ($dao->fetch()) {
252 $cfIDs[$dao->cfID
] = $dao->uri
;
253 $cefIDs[] = $dao->cefID
;
256 if (!empty($cefIDs)) {
257 $cefIDs = implode(',', $cefIDs);
258 $sql = "DELETE FROM civicrm_entity_file where id IN ( $cefIDs )";
259 CRM_Core_DAO
::executeQuery($sql);
263 if (!empty($cfIDs)) {
264 // Delete file only if there no any entity using this file.
265 $deleteFiles = array();
266 foreach ($cfIDs as $fId => $fUri) {
267 //delete tags from entity tag table
269 'entity_table' => 'civicrm_file',
273 CRM_Core_BAO_EntityTag
::del($tagParams);
275 if (!CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_EntityFile', $fId, 'id', 'file_id')) {
276 unlink($config->customFileUploadDir
. DIRECTORY_SEPARATOR
. $fUri);
277 $deleteFiles[$fId] = $fId;
281 if (!empty($deleteFiles)) {
282 $deleteFiles = implode(',', $deleteFiles);
283 $sql = "DELETE FROM civicrm_file where id IN ( $deleteFiles )";
284 CRM_Core_DAO
::executeQuery($sql);
292 * Get all the files and associated object associated with this combination.
294 * @param string $entityTable
295 * @param int $entityID
296 * @param bool $addDeleteArgs
300 public static function getEntityFile($entityTable, $entityID, $addDeleteArgs = FALSE) {
301 if (empty($entityTable) ||
!$entityID) {
306 $config = CRM_Core_Config
::singleton();
308 list($sql, $params) = self
::sql($entityTable, $entityID, NULL);
309 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
311 while ($dao->fetch()) {
312 $result['fileID'] = $dao->cfID
;
313 $result['entityID'] = $dao->cefID
;
314 $result['mime_type'] = $dao->mime_type
;
315 $result['fileName'] = $dao->uri
;
316 $result['description'] = $dao->description
;
317 $result['cleanName'] = CRM_Utils_File
::cleanFileName($dao->uri
);
318 $result['fullPath'] = $config->customFileUploadDir
. DIRECTORY_SEPARATOR
. $dao->uri
;
319 $result['url'] = CRM_Utils_System
::url('civicrm/file', "reset=1&id={$dao->cfID}&eid={$dao->entity_id}");
320 $result['href'] = "<a href=\"{$result['url']}\">{$result['cleanName']}</a>";
321 $result['tag'] = CRM_Core_BAO_EntityTag
::getTag($dao->cfID
, 'civicrm_file');
322 $result['icon'] = CRM_Utils_File
::getIconFromMimeType($dao->mime_type
);
323 if ($addDeleteArgs) {
324 $result['deleteURLArgs'] = self
::deleteURLArgs($dao->entity_table
, $dao->entity_id
, $dao->cfID
);
326 $results[$dao->cfID
] = $result;
330 $tags = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_EntityTag', 'tag_id', array('onlyActive' => FALSE));
332 foreach ($results as &$values) {
333 if (!empty($values['tag'])) {
335 foreach ($values['tag'] as $tid) {
336 $tagNames[] = $tags[$tid];
338 $values['tag'] = implode(', ', $tagNames);
350 * @param string $entityTable
351 * Table-name or "*" (to reference files directly by file-id).
352 * @param int $entityID
353 * @param int $fileTypeID
358 public static function sql($entityTable, $entityID, $fileTypeID = NULL, $fileID = NULL) {
359 if ($entityTable == '*') {
360 // $entityID is the ID of a specific file
362 SELECT CF.id as cfID,
364 CF.mime_type as mime_type,
365 CF.description as description,
367 CEF.entity_table as entity_table,
368 CEF.entity_id as entity_id
369 FROM civicrm_file AS CF
370 LEFT JOIN civicrm_entity_file AS CEF ON ( CEF.file_id = CF.id )
376 SELECT CF.id as cfID,
378 CF.mime_type as mime_type,
379 CF.description as description,
381 CEF.entity_table as entity_table,
382 CEF.entity_id as entity_id
383 FROM civicrm_file AS CF
384 LEFT JOIN civicrm_entity_file AS CEF ON ( CEF.file_id = CF.id )
385 WHERE CEF.entity_table = %1
386 AND CEF.entity_id = %2";
390 1 => array($entityTable, 'String'),
391 2 => array($entityID, 'Integer'),
394 if ($fileTypeID !== NULL) {
395 $sql .= " AND CF.file_type_id = %3";
396 $params[3] = array($fileTypeID, 'Integer');
399 if ($fileID !== NULL) {
400 $sql .= " AND CF.id = %4";
401 $params[4] = array($fileID, 'Integer');
404 return array($sql, $params);
408 * @param CRM_Core_Form $form
409 * @param string $entityTable
410 * @param int $entityID
411 * @param null $numAttachments
412 * @param bool $ajaxDelete
414 public static function buildAttachment(&$form, $entityTable, $entityID = NULL, $numAttachments = NULL, $ajaxDelete = FALSE) {
416 if (!$numAttachments) {
417 $numAttachments = Civi
::settings()->get('max_attachments');
419 // Assign maxAttachments count to template for help message
420 $form->assign('maxAttachments', $numAttachments);
422 $config = CRM_Core_Config
::singleton();
423 // set default max file size as 2MB
424 $maxFileSize = $config->maxFileSize ?
$config->maxFileSize
: 2;
426 $currentAttachmentInfo = self
::getEntityFile($entityTable, $entityID, TRUE);
427 $totalAttachments = 0;
428 if ($currentAttachmentInfo) {
429 $totalAttachments = count($currentAttachmentInfo);
430 $form->add('checkbox', 'is_delete_attachment', ts('Delete All Attachment(s)'));
431 $form->assign('currentAttachmentInfo', $currentAttachmentInfo);
434 $form->assign('currentAttachmentInfo', NULL);
437 if ($totalAttachments) {
438 if ($totalAttachments >= $numAttachments) {
442 $numAttachments -= $totalAttachments;
446 $form->assign('numAttachments', $numAttachments);
448 CRM_Core_BAO_Tag
::getTags('civicrm_file', $tags, NULL,
449 ' ', TRUE);
452 $parentNames = CRM_Core_BAO_Tag
::getTagSet('civicrm_file');
455 for ($i = 1; $i <= $numAttachments; $i++
) {
456 $form->addElement('file', "attachFile_$i", ts('Attach File'), 'size=30 maxlength=221');
457 $form->addUploadElement("attachFile_$i");
458 $form->setMaxFileSize($maxFileSize * 1024 * 1024);
459 $form->addRule("attachFile_$i",
460 ts('File size should be less than %1 MByte(s)',
461 array(1 => $maxFileSize)
464 $maxFileSize * 1024 * 1024
466 $form->addElement('text', "attachDesc_$i", NULL, array(
469 'placeholder' => ts('Description'),
473 $form->add('select', "tag_$i", ts('Tags'), $tags, FALSE,
476 'multiple' => 'multiple',
477 'class' => 'huge crm-select2',
478 'placeholder' => ts('- none -'),
482 CRM_Core_Form_Tag
::buildQuickForm($form, $parentNames, 'civicrm_file', NULL, FALSE, TRUE, "file_taglist_$i");
487 * Return a clean url string and the number of attachment for a
488 * given entityTable, entityID
490 * @param string $entityTable
491 * The entityTable to which the file is attached.
492 * @param int $entityID
493 * The id of the object in the above entityTable.
494 * @param string $separator
495 * The string separator where to implode the urls.
498 * An array with 2 elements. The string and the number of attachments
500 public static function attachmentInfo($entityTable, $entityID, $separator = '<br />') {
505 $currentAttachments = self
::getEntityFile($entityTable, $entityID);
506 if (!empty($currentAttachments)) {
507 $currentAttachmentURL = array();
508 foreach ($currentAttachments as $fileID => $attach) {
509 $currentAttachmentURL[] = $attach['href'];
511 return implode($separator, $currentAttachmentURL);
518 * @param array $params
519 * @param $entityTable
520 * @param int $entityID
522 public static function formatAttachment(
529 // delete current attachments if applicable
530 if ($entityID && !empty($formValues['is_delete_attachment'])) {
531 CRM_Core_BAO_File
::deleteEntityFile($entityTable, $entityID);
534 $numAttachments = Civi
::settings()->get('max_attachments');
536 // setup all attachments
537 for ($i = 1; $i <= $numAttachments; $i++
) {
538 $attachName = "attachFile_$i";
539 $attachDesc = "attachDesc_$i";
540 $attachTags = "tag_$i";
541 $attachFreeTags = "file_taglist_$i";
542 if (isset($formValues[$attachName]) && !empty($formValues[$attachName])) {
543 // add static tags if selects
544 $tagParams = array();
545 if (!empty($formValues[$attachTags])) {
546 foreach ($formValues[$attachTags] as $tag) {
547 $tagParams[$tag] = 1;
551 // we dont care if the file is empty or not
553 $extraParams = array(
554 'description' => $formValues[$attachDesc],
556 'attachment_taglist' => CRM_Utils_Array
::value($attachFreeTags, $formValues, array()),
559 CRM_Utils_File
::formatFile($formValues, $attachName, $extraParams);
561 // set the formatted attachment attributes to $params, later used by
562 // CRM_Activity_BAO_Activity::sendEmail(...) to send mail with desired attachments
563 if (!empty($formValues[$attachName])) {
564 $params[$attachName] = $formValues[$attachName];
571 * @param array $params
572 * @param $entityTable
573 * @param int $entityID
575 public static function processAttachment(&$params, $entityTable, $entityID) {
576 $numAttachments = Civi
::settings()->get('max_attachments');
578 for ($i = 1; $i <= $numAttachments; $i++
) {
580 isset($params["attachFile_$i"]) &&
581 is_array($params["attachFile_$i"])
583 self
::filePostProcess(
584 $params["attachFile_$i"]['location'],
590 $params["attachFile_$i"],
592 $params["attachFile_$i"]['type']
601 public static function uploadNames() {
602 $numAttachments = Civi
::settings()->get('max_attachments');
605 for ($i = 1; $i <= $numAttachments; $i++
) {
606 $names[] = "attachFile_{$i}";
608 $names[] = 'uploadFile';
613 * copy/attach an existing file to a different entity
616 * @param $oldEntityTable
617 * @param int $oldEntityId
618 * @param $newEntityTable
619 * @param int $newEntityId
621 public static function copyEntityFile($oldEntityTable, $oldEntityId, $newEntityTable, $newEntityId) {
622 $oldEntityFile = new CRM_Core_DAO_EntityFile();
623 $oldEntityFile->entity_id
= $oldEntityId;
624 $oldEntityFile->entity_table
= $oldEntityTable;
625 $oldEntityFile->find();
627 while ($oldEntityFile->fetch()) {
628 $newEntityFile = new CRM_Core_DAO_EntityFile();
629 $newEntityFile->entity_id
= $newEntityId;
630 $newEntityFile->entity_table
= $newEntityTable;
631 $newEntityFile->file_id
= $oldEntityFile->file_id
;
632 $newEntityFile->save();
637 * @param $entityTable
638 * @param int $entityID
643 public static function deleteURLArgs($entityTable, $entityID, $fileID) {
644 $params['entityTable'] = $entityTable;
645 $params['entityID'] = $entityID;
646 $params['fileID'] = $fileID;
648 $signer = new CRM_Utils_Signer(CRM_Core_Key
::privateKey(), self
::$_signableFields);
649 $params['_sgn'] = $signer->sign($params);
650 return CRM_Utils_System
::makeQueryString($params);
654 * Delete a file attachment from an entity table / entity ID
657 public static function deleteAttachment() {
659 $params['entityTable'] = CRM_Utils_Request
::retrieve('entityTable', 'String', CRM_Core_DAO
::$_nullObject, TRUE);
660 $params['entityID'] = CRM_Utils_Request
::retrieve('entityID', 'Positive', CRM_Core_DAO
::$_nullObject, TRUE);
661 $params['fileID'] = CRM_Utils_Request
::retrieve('fileID', 'Positive', CRM_Core_DAO
::$_nullObject, TRUE);
663 $signature = CRM_Utils_Request
::retrieve('_sgn', 'String', CRM_Core_DAO
::$_nullObject, TRUE);
665 $signer = new CRM_Utils_Signer(CRM_Core_Key
::privateKey(), self
::$_signableFields);
666 if (!$signer->validate($signature, $params)) {
667 CRM_Core_Error
::fatal('Request signature is invalid');
670 self
::deleteEntityFile($params['entityTable'], $params['entityID'], NULL, $params['fileID']);
675 * Display paper icon for a file attachment -- CRM-13624
677 * @param string $entityTable
678 * The entityTable to which the file is attached. eg "civicrm_contact", "civicrm_note", "civicrm_activity".
679 * If you have the ID of a specific row in civicrm_file, use $entityTable='*'
680 * @param int $entityID
681 * The id of the object in the above entityTable.
684 * list of HTML snippets; one HTML snippet for each attachment. If none found, then NULL
687 public static function paperIconAttachment($entityTable, $entityID) {
688 if (empty($entityTable) ||
!$entityID) {
692 $currentAttachmentInfo = self
::getEntityFile($entityTable, $entityID);
693 foreach ($currentAttachmentInfo as $fileKey => $fileValue) {
694 $fileID = $fileValue['fileID'];
696 $fileType = $fileValue['mime_type'];
697 $url = $fileValue['url'];
698 $title = $fileValue['cleanName'];
699 if ($fileType == 'image/jpeg' ||
700 $fileType == 'image/pjpeg' ||
701 $fileType == 'image/gif' ||
702 $fileType == 'image/x-png' ||
703 $fileType == 'image/png'
705 $file_url[$fileID] = "
706 <a href='$url' class='crm-image-popup' title='$title'>
707 <i class='crm-i fa-file-image-o'></i>
710 // for non image files
712 $file_url[$fileID] = "
713 <a href='$url' title='$title'>
714 <i class='crm-i fa-paperclip'></i>
719 if (empty($file_url)) {
723 $results = $file_url;
729 * Get a reference to the file-search service (if one is available).
731 * @return CRM_Core_FileSearchInterface|NULL
733 public static function getSearchService() {
734 $fileSearches = array();
735 CRM_Utils_Hook
::fileSearches($fileSearches);
737 // use the first available search
738 foreach ($fileSearches as $fileSearch) {
739 /** @var $fileSearch CRM_Core_FileSearchInterface */