3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
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
::fatal(ts('Mime Type is now a required parameter'));
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
::fatal(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', CRM_Core_DAO
::$_nullObject);
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();
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 if ($addDeleteArgs) {
323 $result['deleteURLArgs'] = self
::deleteURLArgs($dao->entity_table
, $dao->entity_id
, $dao->cfID
);
325 $results[$dao->cfID
] = $result;
329 $tags = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_EntityTag', 'tag_id', array('onlyActive' => FALSE));
331 foreach ($results as &$values) {
332 if (!empty($values['tag'])) {
334 foreach ($values['tag'] as $tid) {
335 $tagNames[] = $tags[$tid];
337 $values['tag'] = implode(', ', $tagNames);
349 * @param string $entityTable
350 * Table-name or "*" (to reference files directly by file-id).
351 * @param int $entityID
352 * @param int $fileTypeID
357 public static function sql($entityTable, $entityID, $fileTypeID = NULL, $fileID = NULL) {
358 if ($entityTable == '*') {
359 // $entityID is the ID of a specific file
361 SELECT CF.id as cfID,
363 CF.mime_type as mime_type,
364 CF.description as description,
366 CEF.entity_table as entity_table,
367 CEF.entity_id as entity_id
368 FROM civicrm_file AS CF
369 LEFT JOIN civicrm_entity_file AS CEF ON ( CEF.file_id = CF.id )
375 SELECT CF.id as cfID,
377 CF.mime_type as mime_type,
378 CF.description as description,
380 CEF.entity_table as entity_table,
381 CEF.entity_id as entity_id
382 FROM civicrm_file AS CF
383 LEFT JOIN civicrm_entity_file AS CEF ON ( CEF.file_id = CF.id )
384 WHERE CEF.entity_table = %1
385 AND CEF.entity_id = %2";
389 1 => array($entityTable, 'String'),
390 2 => array($entityID, 'Integer'),
393 if ($fileTypeID !== NULL) {
394 $sql .= " AND CF.file_type_id = %3";
395 $params[3] = array($fileTypeID, 'Integer');
398 if ($fileID !== NULL) {
399 $sql .= " AND CF.id = %4";
400 $params[4] = array($fileID, 'Integer');
403 return array($sql, $params);
407 * @param CRM_Core_Form $form
408 * @param string $entityTable
409 * @param int $entityID
410 * @param null $numAttachments
411 * @param bool $ajaxDelete
413 public static function buildAttachment(&$form, $entityTable, $entityID = NULL, $numAttachments = NULL, $ajaxDelete = FALSE) {
415 if (!$numAttachments) {
416 $numAttachments = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'max_attachments');
418 // Assign maxAttachments count to template for help message
419 $form->assign('maxAttachments', $numAttachments);
421 $config = CRM_Core_Config
::singleton();
422 // set default max file size as 2MB
423 $maxFileSize = $config->maxFileSize ?
$config->maxFileSize
: 2;
425 $currentAttachmentInfo = self
::getEntityFile($entityTable, $entityID, TRUE);
426 $totalAttachments = 0;
427 if ($currentAttachmentInfo) {
428 $totalAttachments = count($currentAttachmentInfo);
429 $form->add('checkbox', 'is_delete_attachment', ts('Delete All Attachment(s)'));
430 $form->assign('currentAttachmentInfo', $currentAttachmentInfo);
433 $form->assign('currentAttachmentInfo', NULL);
436 if ($totalAttachments) {
437 if ($totalAttachments >= $numAttachments) {
441 $numAttachments -= $totalAttachments;
445 $form->assign('numAttachments', $numAttachments);
447 CRM_Core_BAO_Tag
::getTags('civicrm_file', $tags, NULL,
448 ' ', TRUE);
451 $parentNames = CRM_Core_BAO_Tag
::getTagSet('civicrm_file');
454 for ($i = 1; $i <= $numAttachments; $i++
) {
455 $form->addElement('file', "attachFile_$i", ts('Attach File'), 'size=30 maxlength=60');
456 $form->addUploadElement("attachFile_$i");
457 $form->setMaxFileSize($maxFileSize * 1024 * 1024);
458 $form->addRule("attachFile_$i",
459 ts('File size should be less than %1 MByte(s)',
460 array(1 => $maxFileSize)
463 $maxFileSize * 1024 * 1024
465 $form->addElement('text', "attachDesc_$i", NULL, array(
468 'placeholder' => ts('Description'),
472 $form->add('select', "tag_$i", ts('Tags'), $tags, FALSE,
475 'multiple' => 'multiple',
476 'class' => 'huge crm-select2',
477 'placeholder' => ts('- none -'),
481 CRM_Core_Form_Tag
::buildQuickForm($form, $parentNames, 'civicrm_file', NULL, FALSE, TRUE, "file_taglist_$i");
486 * Return a clean url string and the number of attachment for a
487 * given entityTable, entityID
489 * @param string $entityTable
490 * The entityTable to which the file is attached.
491 * @param int $entityID
492 * The id of the object in the above entityTable.
493 * @param string $separator
494 * The string separator where to implode the urls.
497 * An array with 2 elements. The string and the number of attachments
499 public static function attachmentInfo($entityTable, $entityID, $separator = '<br />') {
504 $currentAttachments = self
::getEntityFile($entityTable, $entityID);
505 if (!empty($currentAttachments)) {
506 $currentAttachmentURL = array();
507 foreach ($currentAttachments as $fileID => $attach) {
508 $currentAttachmentURL[] = $attach['href'];
510 return implode($separator, $currentAttachmentURL);
517 * @param array $params
518 * @param $entityTable
519 * @param int $entityID
521 public static function formatAttachment(
528 // delete current attachments if applicable
529 if ($entityID && !empty($formValues['is_delete_attachment'])) {
530 CRM_Core_BAO_File
::deleteEntityFile($entityTable, $entityID);
533 $numAttachments = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'max_attachments');
535 $now = date('Ymdhis');
537 // setup all attachments
538 for ($i = 1; $i <= $numAttachments; $i++
) {
539 $attachName = "attachFile_$i";
540 $attachDesc = "attachDesc_$i";
541 $attachTags = "tag_$i";
542 $attachFreeTags = "file_taglist_$i";
543 if (isset($formValues[$attachName]) && !empty($formValues[$attachName])) {
544 // add static tags if selects
545 $tagParams = array();
546 if (!empty($formValues[$attachTags])) {
547 foreach ($formValues[$attachTags] as $tag) {
548 $tagParams[$tag] = 1;
552 // we dont care if the file is empty or not
555 'uri' => $formValues[$attachName]['name'],
556 'type' => $formValues[$attachName]['type'],
557 'location' => $formValues[$attachName]['name'],
558 'description' => $formValues[$attachDesc],
559 'upload_date' => $now,
561 'attachment_taglist' => CRM_Utils_Array
::value($attachFreeTags, $formValues, array()),
564 $params[$attachName] = $fileParams;
570 * @param array $params
571 * @param $entityTable
572 * @param int $entityID
574 public static function processAttachment(&$params, $entityTable, $entityID) {
575 $numAttachments = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'max_attachments');
577 for ($i = 1; $i <= $numAttachments; $i++
) {
579 isset($params["attachFile_$i"]) &&
580 is_array($params["attachFile_$i"])
582 self
::filePostProcess(
583 $params["attachFile_$i"]['location'],
589 $params["attachFile_$i"],
591 $params["attachFile_$i"]['type']
600 public static function uploadNames() {
601 $numAttachments = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'max_attachments');
604 for ($i = 1; $i <= $numAttachments; $i++
) {
605 $names[] = "attachFile_{$i}";
607 $names[] = 'uploadFile';
612 * copy/attach an existing file to a different entity
615 * @param $oldEntityTable
616 * @param int $oldEntityId
617 * @param $newEntityTable
618 * @param int $newEntityId
620 public static function copyEntityFile($oldEntityTable, $oldEntityId, $newEntityTable, $newEntityId) {
621 $oldEntityFile = new CRM_Core_DAO_EntityFile();
622 $oldEntityFile->entity_id
= $oldEntityId;
623 $oldEntityFile->entity_table
= $oldEntityTable;
624 $oldEntityFile->find();
626 while ($oldEntityFile->fetch()) {
627 $newEntityFile = new CRM_Core_DAO_EntityFile();
628 $newEntityFile->entity_id
= $newEntityId;
629 $newEntityFile->entity_table
= $newEntityTable;
630 $newEntityFile->file_id
= $oldEntityFile->file_id
;
631 $newEntityFile->save();
636 * @param $entityTable
637 * @param int $entityID
642 public static function deleteURLArgs($entityTable, $entityID, $fileID) {
643 $params['entityTable'] = $entityTable;
644 $params['entityID'] = $entityID;
645 $params['fileID'] = $fileID;
647 $signer = new CRM_Utils_Signer(CRM_Core_Key
::privateKey(), self
::$_signableFields);
648 $params['_sgn'] = $signer->sign($params);
649 return CRM_Utils_System
::makeQueryString($params);
653 * Delete a file attachment from an entity table / entity ID
656 public static function deleteAttachment() {
658 $params['entityTable'] = CRM_Utils_Request
::retrieve('entityTable', 'String', CRM_Core_DAO
::$_nullObject, TRUE);
659 $params['entityID'] = CRM_Utils_Request
::retrieve('entityID', 'Positive', CRM_Core_DAO
::$_nullObject, TRUE);
660 $params['fileID'] = CRM_Utils_Request
::retrieve('fileID', 'Positive', CRM_Core_DAO
::$_nullObject, TRUE);
662 $signature = CRM_Utils_Request
::retrieve('_sgn', 'String', CRM_Core_DAO
::$_nullObject, TRUE);
664 $signer = new CRM_Utils_Signer(CRM_Core_Key
::privateKey(), self
::$_signableFields);
665 if (!$signer->validate($signature, $params)) {
666 CRM_Core_Error
::fatal('Request signature is invalid');
669 CRM_Core_BAO_File
::deleteEntityFile($params['entityTable'], $params['entityID'], NULL, $params['fileID']);
674 * Display paper icon for a file attachment -- CRM-13624
676 * @param string $entityTable
677 * The entityTable to which the file is attached. eg "civicrm_contact", "civicrm_note", "civicrm_activity".
678 * If you have the ID of a specific row in civicrm_file, use $entityTable='*'
679 * @param int $entityID
680 * The id of the object in the above entityTable.
683 * list of HTML snippets; one HTML snippet for each attachment. If none found, then NULL
686 public static function paperIconAttachment($entityTable, $entityID) {
687 if (empty($entityTable) ||
!$entityID) {
691 $currentAttachmentInfo = self
::getEntityFile($entityTable, $entityID);
692 foreach ($currentAttachmentInfo as $fileKey => $fileValue) {
693 $fileID = $fileValue['fileID'];
694 $fileType = $fileValue['mime_type'];
696 if ($fileType == 'image/jpeg' ||
697 $fileType == 'image/pjpeg' ||
698 $fileType == 'image/gif' ||
699 $fileType == 'image/x-png' ||
700 $fileType == 'image/png'
702 $url = $fileValue['url'];
703 $alt = $fileValue['cleanName'];
704 $file_url[$fileID] = "
705 <a href=\"$url\" class='crm-image-popup'>
706 <div class='icon paper-icon' title=\"$alt\" alt=\"$alt\"></div>
708 // for non image files
711 $url = $fileValue['url'];
712 $alt = $fileValue['cleanName'];
713 $file_url[$fileID] = "<a href=\"$url\"><div class='icon paper-icon' title=\"$alt\" alt=\"$alt\"></div></a>";
717 if (empty($file_url)) {
721 $results = $file_url;
727 * Get a reference to the file-search service (if one is available).
729 * @return CRM_Core_FileSearchInterface|NULL
731 public static function getSearchService() {
732 $fileSearches = array();
733 CRM_Utils_Hook
::fileSearches($fileSearches);
735 // use the first available search
736 foreach ($fileSearches as $fileSearch) {
737 /** @var $fileSearch CRM_Core_FileSearchInterface */