*/
class CRM_Core_BAO_File extends CRM_Core_DAO_File {
- static $_signableFields = array('entityTable', 'entityID', 'fileID');
+ public static $_signableFields = ['entityTable', 'entityID', 'fileID'];
/**
* Takes an associative array and creates a File object.
$path = $config->customFileUploadDir . $fileDAO->uri;
if (file_exists($path) && is_readable($path)) {
- return array($path, $fileDAO->mime_type);
+ return [$path, $fileDAO->mime_type];
}
}
}
- return array(NULL, NULL);
+ return [NULL, NULL];
}
-
/**
* @param $data
* @param int $fileTypeID
$fileDAO = new CRM_Core_DAO_File();
$fileDAO->id = $fileID;
if (!$fileDAO->find(TRUE)) {
- CRM_Core_Error::fatal();
+ throw new CRM_Core_Exception(ts('File not found'));
}
// lets call a pre hook before the delete, so attachments hooks can get the info before things
$entityFileDAO->entity_table = $tableName;
if (!$entityFileDAO->find(TRUE)) {
- CRM_Core_Error::fatal(sprintf('No record found for given file ID - %d and entity ID - %d', $fileID, $entityID));
+ throw new CRM_Core_Exception(sprintf('No record found for given file ID - %d and entity ID - %d', $fileID, $entityID));
}
$entityFileDAO->delete();
// also set the value to null of the table and column
$query = "UPDATE $tableName SET $columnName = null WHERE $columnName = %1";
- $params = array(1 => array($fileID, 'Integer'));
+ $params = [1 => [$fileID, 'Integer']];
CRM_Core_DAO::executeQuery($query, $params);
}
list($sql, $params) = self::sql($entityTable, $entityID, $fileTypeID, $fileID);
$dao = CRM_Core_DAO::executeQuery($sql, $params);
- $cfIDs = array();
- $cefIDs = array();
+ $cfIDs = [];
+ $cefIDs = [];
while ($dao->fetch()) {
$cfIDs[$dao->cfID] = $dao->uri;
$cefIDs[] = $dao->cefID;
if (!empty($cfIDs)) {
// Delete file only if there no any entity using this file.
- $deleteFiles = array();
+ $deleteFiles = [];
foreach ($cfIDs as $fId => $fUri) {
//delete tags from entity tag table
- $tagParams = array(
+ $tagParams = [
'entity_table' => 'civicrm_file',
'entity_id' => $fId,
- );
+ ];
CRM_Core_BAO_EntityTag::del($tagParams);
list($sql, $params) = self::sql($entityTable, $entityID, NULL);
$dao = CRM_Core_DAO::executeQuery($sql, $params);
- $results = array();
+ $results = [];
while ($dao->fetch()) {
$fileHash = self::generateFileHash($dao->entity_id, $dao->cfID);
$result['fileID'] = $dao->cfID;
}
//fix tag names
- $tags = CRM_Core_PseudoConstant::get('CRM_Core_DAO_EntityTag', 'tag_id', array('onlyActive' => FALSE));
+ $tags = CRM_Core_PseudoConstant::get('CRM_Core_DAO_EntityTag', 'tag_id', ['onlyActive' => FALSE]);
foreach ($results as &$values) {
if (!empty($values['tag'])) {
- $tagNames = array();
+ $tagNames = [];
foreach ($values['tag'] as $tid) {
$tagNames[] = $tags[$tid];
}
AND CEF.entity_id = %2";
}
- $params = array(
- 1 => array($entityTable, 'String'),
- 2 => array($entityID, 'Integer'),
- );
+ $params = [
+ 1 => [$entityTable, 'String'],
+ 2 => [$entityID, 'Integer'],
+ ];
if ($fileTypeID !== NULL) {
$sql .= " AND CF.file_type_id = %3";
- $params[3] = array($fileTypeID, 'Integer');
+ $params[3] = [$fileTypeID, 'Integer'];
}
if ($fileID !== NULL) {
$sql .= " AND CF.id = %4";
- $params[4] = array($fileID, 'Integer');
+ $params[4] = [$fileID, 'Integer'];
}
- return array($sql, $params);
+ return [$sql, $params];
}
/**
$form->setMaxFileSize($maxFileSize * 1024 * 1024);
$form->addRule("attachFile_$i",
ts('File size should be less than %1 MByte(s)',
- array(1 => $maxFileSize)
+ [1 => $maxFileSize]
),
'maxfilesize',
$maxFileSize * 1024 * 1024
);
- $form->addElement('text', "attachDesc_$i", NULL, array(
+ $form->addElement('text', "attachDesc_$i", NULL, [
'size' => 40,
'maxlength' => 255,
'placeholder' => ts('Description'),
- ));
+ ]);
if (!empty($tags)) {
$form->add('select', "tag_$i", ts('Tags'), $tags, FALSE,
- array(
+ [
'id' => "tags_$i",
'multiple' => 'multiple',
'class' => 'huge crm-select2',
'placeholder' => ts('- none -'),
- )
+ ]
);
}
CRM_Core_Form_Tag::buildQuickForm($form, $parentNames, 'civicrm_file', NULL, FALSE, TRUE, "file_taglist_$i");
$currentAttachments = self::getEntityFile($entityTable, $entityID);
if (!empty($currentAttachments)) {
- $currentAttachmentURL = array();
+ $currentAttachmentURL = [];
foreach ($currentAttachments as $fileID => $attach) {
$currentAttachmentURL[] = $attach['href'];
}
$attachFreeTags = "file_taglist_$i";
if (isset($formValues[$attachName]) && !empty($formValues[$attachName])) {
// add static tags if selects
- $tagParams = array();
+ $tagParams = [];
if (!empty($formValues[$attachTags])) {
foreach ($formValues[$attachTags] as $tag) {
$tagParams[$tag] = 1;
// we dont care if the file is empty or not
// CRM-7448
- $extraParams = array(
+ $extraParams = [
'description' => $formValues[$attachDesc],
'tag' => $tagParams,
- 'attachment_taglist' => CRM_Utils_Array::value($attachFreeTags, $formValues, array()),
- );
+ 'attachment_taglist' => CRM_Utils_Array::value($attachFreeTags, $formValues, []),
+ ];
CRM_Utils_File::formatFile($formValues, $attachName, $extraParams);
public static function uploadNames() {
$numAttachments = Civi::settings()->get('max_attachments');
- $names = array();
+ $names = [];
for ($i = 1; $i <= $numAttachments; $i++) {
$names[] = "attachFile_{$i}";
}
*
*/
public static function deleteAttachment() {
- $params = array();
+ $params = [];
$params['entityTable'] = CRM_Utils_Request::retrieve('entityTable', 'String', CRM_Core_DAO::$_nullObject, TRUE);
$params['entityID'] = CRM_Utils_Request::retrieve('entityID', 'Positive', CRM_Core_DAO::$_nullObject, TRUE);
$params['fileID'] = CRM_Utils_Request::retrieve('fileID', 'Positive', CRM_Core_DAO::$_nullObject, TRUE);
self::deleteEntityFile($params['entityTable'], $params['entityID'], NULL, $params['fileID']);
}
-
/**
* Display paper icon for a file attachment -- CRM-13624
*
* @return CRM_Core_FileSearchInterface|NULL
*/
public static function getSearchService() {
- $fileSearches = array();
+ $fileSearches = [];
CRM_Utils_Hook::fileSearches($fileSearches);
// use the first available search
}
/**
- * Generates a MD5 Hash to be appended to file URLS to be checked when trying to download the file.
- * @param int $eid entity id the file is attached to
- * @param int $fid file ID
+ * Generates an access-token for downloading a specific file.
+ *
+ * @param int $entityId entity id the file is attached to
+ * @param int $fileId file ID
+ * @param int $genTs
+ * @param int $life
* @return string
*/
- public static function generateFileHash($eid = NULL, $fid = NULL, $genTs = NULL, $life = NULL) {
+ public static function generateFileHash($entityId = NULL, $fileId = NULL, $genTs = NULL, $life = NULL) {
// Use multiple (but stable) inputs for hash information.
- $siteKey = defined('CIVICRM_SITE_KEY') ? CIVICRM_SITE_KEY : 'NO_SITE_KEY';
+ $siteKey = CRM_Utils_Constant::value('CIVICRM_SITE_KEY');
+ if (!$siteKey) {
+ throw new \CRM_Core_Exception("Cannot generate file access token. Please set CIVICRM_SITE_KEY.");
+ }
if (!$genTs) {
$genTs = time();
}
if (!$life) {
- $life = 24 * 2;
+ $days = Civi::settings()->get('checksum_timeout');
+ $life = 24 * $days;
}
// Trim 8 chars off the string, make it slightly easier to find
// but reveals less information from the hash.
- $cs = hash_hmac('sha256', "{$fid}_{$life}", $siteKey);
+ $cs = hash_hmac('sha256', "entity={$entityId}&file={$fileId}&life={$life}", $siteKey);
return "{$cs}_{$genTs}_{$life}";
}
/**
- * Validate a file Hash
+ * Validate a file access token.
+ *
* @param string $hash
- * @param int $eid Entity Id the file is attached to
- * @param int $fid File Id
+ * @param int $entityId Entity Id the file is attached to
+ * @param int $fileId File Id
* @return bool
*/
- public static function validateFileHash($hash, $eid, $fid) {
+ public static function validateFileHash($hash, $entityId, $fileId) {
$input = CRM_Utils_System::explode('_', $hash, 3);
$inputTs = CRM_Utils_Array::value(1, $input);
$inputLF = CRM_Utils_Array::value(2, $input);
- $testHash = CRM_Core_BAO_File::generateFileHash($eid, $fid, $inputTs, $inputLF);
+ $testHash = CRM_Core_BAO_File::generateFileHash($entityId, $fileId, $inputTs, $inputLF);
if (hash_equals($testHash, $hash)) {
$now = time();
if ($inputTs + ($inputLF * 60 * 60) >= $now) {
projects / civicrm-core.git / blobdiff