CRM/Core/BAO/File.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  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.   |
  13  |                                                                    |
  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.        |
  18  |                                                                    |
  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  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * BAO object for crm_log table
  38  */
  39 class CRM_Core_BAO_File extends CRM_Core_DAO_File {
  40
  41   static $_signableFields = array('entityTable', 'entityID', 'fileID');
  42
  43   /**
  44    * @param int $fileID
  45    * @param int $entityID
  46    * @param null $entityTable
  47    *
  48    * @return array
  49    */
  50   public static function path($fileID, $entityID, $entityTable = NULL) {
  51     $entityFileDAO = new CRM_Core_DAO_EntityFile();
  52     if ($entityTable) {
  53       $entityFileDAO->entity_table = $entityTable;
  54     }
  55     $entityFileDAO->entity_id = $entityID;
  56     $entityFileDAO->file_id = $fileID;
  57
  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;
  64
  65         if (file_exists($path) && is_readable($path)) {
  66           return array($path, $fileDAO->mime_type);
  67         }
  68       }
  69     }
  70
  71     return array(NULL, NULL);
  72   }
  73
  74
  75   /**
  76    * @param $data
  77    * @param int $fileTypeID
  78    * @param $entityTable
  79    * @param int $entityID
  80    * @param $entitySubtype
  81    * @param bool $overwrite
  82    * @param null|array $fileParams
  83    * @param string $uploadName
  84    * @param null $mimeType
  85    *
  86    * @throws Exception
  87    */
  88   static function filePostProcess(
  89     $data,
  90     $fileTypeID,
  91     $entityTable,
  92     $entityID,
  93     $entitySubtype,
  94     $overwrite = TRUE,
  95     $fileParams = NULL,
  96     $uploadName = 'uploadFile',
  97     $mimeType = NULL
  98   ) {
  99     if (!$mimeType) {
 100       CRM_Core_Error::fatal(ts('Mime Type is now a required parameter'));
 101     }
 102
 103     $config = CRM_Core_Config::singleton();
 104
 105     $path = explode('/', $data);
 106     $filename = $path[count($path) - 1];
 107
 108     // rename this file to go into the secure directory
 109     if ($entitySubtype) {
 110       $directoryName = $config->customFileUploadDir . $entitySubtype . DIRECTORY_SEPARATOR . $entityID;
 111     }
 112     else {
 113       $directoryName = $config->customFileUploadDir;
 114     }
 115
 116     CRM_Utils_File::createDir($directoryName);
 117
 118     if (!rename($data, $directoryName . DIRECTORY_SEPARATOR . $filename)) {
 119       CRM_Core_Error::fatal(ts('Could not move custom file to custom upload directory'));
 120     }
 121
 122     // to get id's
 123     if ($overwrite && $fileTypeID) {
 124       list($sql, $params) = self::sql($entityTable, $entityID, $fileTypeID);
 125     }
 126     else {
 127       list($sql, $params) = self::sql($entityTable, $entityID, 0);
 128     }
 129
 130     $dao = CRM_Core_DAO::executeQuery($sql, $params);
 131     $dao->fetch();
 132
 133     $fileDAO = new CRM_Core_DAO_File();
 134     $op = 'create';
 135     if (isset($dao->cfID) && $dao->cfID) {
 136       $op = 'edit';
 137       $fileDAO->id = $dao->cfID;
 138       unlink($directoryName . DIRECTORY_SEPARATOR . $dao->uri);
 139     }
 140
 141     if (!empty($fileParams)) {
 142       $fileDAO->copyValues($fileParams);
 143     }
 144
 145     $fileDAO->uri = $filename;
 146     $fileDAO->mime_type = $mimeType;
 147     $fileDAO->file_type_id = $fileTypeID;
 148     $fileDAO->upload_date = date('Ymdhis');
 149     $fileDAO->save();
 150
 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;
 155     }
 156     $entityFileDAO->entity_table = $entityTable;
 157     $entityFileDAO->entity_id = $entityID;
 158     $entityFileDAO->file_id = $fileDAO->id;
 159     $entityFileDAO->save();
 160
 161     //save static tags
 162     if (!empty($fileParams['tag'])) {
 163       CRM_Core_BAO_EntityTag::create($fileParams['tag'], 'civicrm_file', $entityFileDAO->id);
 164     }
 165
 166     //save free tags
 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);
 169     }
 170
 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);
 173   }
 174
 175   /**
 176    * A static function wrapper that deletes the various objects that are
 177    * connected to a file object (i.e. file, entityFile and customValue
 178    */
 179   public static function deleteFileReferences($fileID, $entityID, $fieldID) {
 180     $fileDAO = new CRM_Core_DAO_File();
 181     $fileDAO->id = $fileID;
 182     if (!$fileDAO->find(TRUE)) {
 183       CRM_Core_Error::fatal();
 184     }
 185
 186     // lets call a pre hook before the delete, so attachments hooks can get the info before things
 187     // disappear
 188     CRM_Utils_Hook::pre('delete', 'File', $fileID, $fileDAO);
 189
 190     // get the table and column name
 191     list($tableName, $columnName, $groupID) = CRM_Core_BAO_CustomField::getTableColumnGroup($fieldID);
 192
 193     $entityFileDAO = new CRM_Core_DAO_EntityFile();
 194     $entityFileDAO->file_id = $fileID;
 195     $entityFileDAO->entity_id = $entityID;
 196     $entityFileDAO->entity_table = $tableName;
 197
 198     if (!$entityFileDAO->find(TRUE)) {
 199       CRM_Core_Error::fatal();
 200     }
 201
 202     $entityFileDAO->delete();
 203     $fileDAO->delete();
 204
 205     // also set the value to null of the table and column
 206     $query = "UPDATE $tableName SET $columnName = null WHERE $columnName = %1";
 207     $params = array(1 => array($fileID, 'Integer'));
 208     CRM_Core_DAO::executeQuery($query, $params);
 209   }
 210
 211   /**
 212    * The $useWhere is used so that the signature matches the parent class
 213    *
 214   public function delete($useWhere = FALSE) {
 215     list($fileID, $entityID, $fieldID) = func_get_args();
 216
 217     self::deleteFileReferences($fileID, $entityID, $fieldID);
 218   } */
 219
 220   /**
 221    * Delete all the files and associated object associated with this
 222    * combination
 223    */
 224   public static function deleteEntityFile($entityTable, $entityID, $fileTypeID = NULL, $fileID = NULL) {
 225     if (empty($entityTable) || empty($entityID)) {
 226       return;
 227     }
 228
 229     $config = CRM_Core_Config::singleton();
 230
 231     list($sql, $params) = self::sql($entityTable, $entityID, $fileTypeID, $fileID);
 232     $dao = CRM_Core_DAO::executeQuery($sql, $params);
 233
 234     $cfIDs = array();
 235     $cefIDs = array();
 236     while ($dao->fetch()) {
 237       $cfIDs[$dao->cfID] = $dao->uri;
 238       $cefIDs[] = $dao->cefID;
 239     }
 240
 241     if (!empty($cefIDs)) {
 242       $cefIDs = implode(',', $cefIDs);
 243       $sql = "DELETE FROM civicrm_entity_file where id IN ( $cefIDs )";
 244       CRM_Core_DAO::executeQuery($sql);
 245     }
 246
 247     if (!empty($cfIDs)) {
 248       // Delete file only if there no any entity using this file.
 249       $deleteFiles = array();
 250       foreach ($cfIDs as $fId => $fUri) {
 251         //delete tags from entity tag table
 252         $tagParams = array(
 253           'entity_table' => 'civicrm_file',
 254           'entity_id' => $fId
 255         );
 256
 257         CRM_Core_BAO_EntityTag::del($tagParams);
 258
 259         if (!CRM_Core_DAO::getFieldValue('CRM_Core_DAO_EntityFile', $fId, 'id', 'file_id')) {
 260           unlink($config->customFileUploadDir . DIRECTORY_SEPARATOR . $fUri);
 261           $deleteFiles[$fId] = $fId;
 262         }
 263       }
 264
 265       if (!empty($deleteFiles)) {
 266         $deleteFiles = implode(',', $deleteFiles);
 267         $sql = "DELETE FROM civicrm_file where id IN ( $deleteFiles )";
 268         CRM_Core_DAO::executeQuery($sql);
 269       }
 270     }
 271   }
 272
 273   /**
 274    * Get all the files and associated object associated with this
 275    * combination
 276    */
 277   public static function getEntityFile($entityTable, $entityID, $addDeleteArgs = FALSE) {
 278     if (empty($entityTable) || !$entityID) {
 279       $results = NULL;
 280       return $results;
 281     }
 282
 283     $config = CRM_Core_Config::singleton();
 284
 285     list($sql, $params) = self::sql($entityTable, $entityID, NULL);
 286     $dao = CRM_Core_DAO::executeQuery($sql, $params);
 287     $results = array();
 288     while ($dao->fetch()) {
 289       $result['fileID'] = $dao->cfID;
 290       $result['entityID'] = $dao->cefID;
 291       $result['mime_type'] = $dao->mime_type;
 292       $result['fileName'] = $dao->uri;
 293       $result['description'] = $dao->description;
 294       $result['cleanName'] = CRM_Utils_File::cleanFileName($dao->uri);
 295       $result['fullPath'] = $config->customFileUploadDir . DIRECTORY_SEPARATOR . $dao->uri;
 296       $result['url'] = CRM_Utils_System::url('civicrm/file', "reset=1&id={$dao->cfID}&eid={$dao->entity_id}");
 297       $result['href'] = "<a href=\"{$result['url']}\">{$result['cleanName']}</a>";
 298       $result['tag'] = CRM_Core_BAO_EntityTag::getTag($dao->cfID, 'civicrm_file');
 299       if ($addDeleteArgs) {
 300         $result['deleteURLArgs'] = self::deleteURLArgs($dao->entity_table, $dao->entity_id, $dao->cfID);
 301       }
 302       $results[$dao->cfID] = $result;
 303     }
 304
 305     //fix tag names
 306     $tags = CRM_Core_PseudoConstant::get('CRM_Core_DAO_EntityTag', 'tag_id', array('onlyActive' => FALSE));
 307
 308     foreach ($results as &$values) {
 309       if (!empty($values['tag'])) {
 310         $tagNames = array();
 311         foreach ($values['tag'] as $tid) {
 312           $tagNames[] = $tags[$tid];
 313         }
 314         $values['tag'] = implode(', ', $tagNames);
 315       }
 316       else {
 317         $values['tag'] = '';
 318       }
 319     }
 320
 321     $dao->free();
 322     return $results;
 323   }
 324
 325   /**
 326    * @param string $entityTable
 327    *   Table-name or "*" (to reference files directly by file-id).
 328    * @param int $entityID
 329    * @param int $fileTypeID
 330    * @param int $fileID
 331    *
 332    * @return array
 333    */
 334   public static function sql($entityTable, $entityID, $fileTypeID = NULL, $fileID = NULL) {
 335     if ($entityTable == '*') {
 336       // $entityID is the ID of a specific file
 337       $sql = "
 338 SELECT    CF.id as cfID,
 339            CF.uri as uri,
 340            CF.mime_type as mime_type,
 341            CF.description as description,
 342            CEF.id as cefID,
 343            CEF.entity_table as entity_table,
 344            CEF.entity_id as entity_id
 345 FROM      civicrm_file AS CF
 346 LEFT JOIN civicrm_entity_file AS CEF ON ( CEF.file_id = CF.id )
 347 WHERE     CF.id = %2";
 348
 349     } else {
 350       $sql = "
 351 SELECT    CF.id as cfID,
 352            CF.uri as uri,
 353            CF.mime_type as mime_type,
 354            CF.description as description,
 355            CEF.id as cefID,
 356            CEF.entity_table as entity_table,
 357            CEF.entity_id as entity_id
 358 FROM      civicrm_file AS CF
 359 LEFT JOIN civicrm_entity_file AS CEF ON ( CEF.file_id = CF.id )
 360 WHERE     CEF.entity_table = %1
 361 AND       CEF.entity_id    = %2";
 362     }
 363
 364     $params = array(
 365       1 => array($entityTable, 'String'),
 366       2 => array($entityID, 'Integer'),
 367     );
 368
 369     if ($fileTypeID !== NULL) {
 370       $sql .= " AND CF.file_type_id = %3";
 371       $params[3] = array($fileTypeID, 'Integer');
 372     }
 373
 374     if ($fileID !== NULL) {
 375       $sql .= " AND CF.id = %4";
 376       $params[4] = array($fileID, 'Integer');
 377     }
 378
 379     return array($sql, $params);
 380   }
 381
 382   /**
 383    * @param CRM_Core_Form $form
 384    * @param string $entityTable
 385    * @param int $entityID
 386    * @param null $numAttachments
 387    * @param bool $ajaxDelete
 388    */
 389   public static function buildAttachment(&$form, $entityTable, $entityID = NULL, $numAttachments = NULL, $ajaxDelete = FALSE) {
 390
 391     if (!$numAttachments) {
 392       $numAttachments = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'max_attachments');
 393     }
 394     // Assign maxAttachments count to template for help message
 395     $form->assign('maxAttachments', $numAttachments);
 396
 397     $config = CRM_Core_Config::singleton();
 398     // set default max file size as 2MB
 399     $maxFileSize = $config->maxFileSize ? $config->maxFileSize : 2;
 400
 401     $currentAttachmentInfo = self::getEntityFile($entityTable, $entityID, TRUE);
 402     $totalAttachments = 0;
 403     if ($currentAttachmentInfo) {
 404       $totalAttachments = count($currentAttachmentInfo);
 405       $form->add('checkbox', 'is_delete_attachment', ts('Delete All Attachment(s)'));
 406       $form->assign('currentAttachmentInfo', $currentAttachmentInfo);
 407     }
 408     else {
 409       $form->assign('currentAttachmentInfo', NULL);
 410     }
 411
 412     if ($totalAttachments) {
 413       if ($totalAttachments >= $numAttachments) {
 414         $numAttachments = 0;
 415       }
 416       else {
 417         $numAttachments -= $totalAttachments;
 418       }
 419     }
 420
 421     $form->assign('numAttachments', $numAttachments);
 422
 423     CRM_Core_BAO_Tag::getTags('civicrm_file', $tags, NULL,
 424       '&nbsp;&nbsp;', TRUE);
 425
 426     // get tagset info
 427     $parentNames = CRM_Core_BAO_Tag::getTagSet('civicrm_file');
 428
 429     // add attachments
 430     for ($i = 1; $i <= $numAttachments; $i++) {
 431       $form->addElement('file', "attachFile_$i", ts('Attach File'), 'size=30 maxlength=60');
 432       $form->addUploadElement("attachFile_$i");
 433       $form->setMaxFileSize($maxFileSize * 1024 * 1024);
 434       $form->addRule("attachFile_$i",
 435         ts('File size should be less than %1 MByte(s)',
 436           array(1 => $maxFileSize)
 437         ),
 438         'maxfilesize',
 439         $maxFileSize * 1024 * 1024
 440       );
 441       $form->addElement('text', "attachDesc_$i", NULL, array(
 442         'size' => 40,
 443         'maxlength' => 255,
 444         'placeholder' => ts('Description')
 445       ));
 446
 447       if (!empty($tags)) {
 448         $form->add('select', "tag_$i", ts('Tags'), $tags, FALSE,
 449           array(
 450             'id' => "tags_$i",
 451             'multiple' => 'multiple',
 452             'class' => 'huge crm-select2',
 453             'placeholder' => ts('- none -')
 454           )
 455         );
 456       }
 457       CRM_Core_Form_Tag::buildQuickForm($form, $parentNames, 'civicrm_file', NULL, FALSE, TRUE, "file_taglist_$i");
 458     }
 459   }
 460
 461   /**
 462    * Return a clean url string and the number of attachment for a
 463    * given entityTable, entityID
 464    *
 465    * @param $entityTable
 466    *   String The entityTable to which the file is attached.
 467    * @param $entityID
 468    *   Int The id of the object in the above entityTable.
 469    * @param $separator
 470    *   String The string separator where to implode the urls.
 471    *
 472    * @return array              An array with 2 elements. The string and the number of attachments
 473    * @static
 474    */
 475   public static function attachmentInfo($entityTable, $entityID, $separator = '<br />') {
 476     if (!$entityID) {
 477       return NULL;
 478     }
 479
 480     $currentAttachments = self::getEntityFile($entityTable, $entityID);
 481     if (!empty($currentAttachments)) {
 482       $currentAttachmentURL = array();
 483       foreach ($currentAttachments as $fileID => $attach) {
 484         $currentAttachmentURL[] = $attach['href'];
 485       }
 486       return implode($separator, $currentAttachmentURL);
 487     }
 488     return NULL;
 489   }
 490
 491   /**
 492    * @param $formValues
 493    * @param array $params
 494    * @param $entityTable
 495    * @param int $entityID
 496    */
 497   static function formatAttachment(
 498     &$formValues,
 499     &$params,
 500     $entityTable,
 501     $entityID = NULL
 502   ) {
 503
 504     // delete current attachments if applicable
 505     if ($entityID && !empty($formValues['is_delete_attachment'])) {
 506       CRM_Core_BAO_File::deleteEntityFile($entityTable, $entityID);
 507     }
 508
 509     $numAttachments = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'max_attachments');
 510
 511     $now = date('Ymdhis');
 512
 513     // setup all attachments
 514     for ($i = 1; $i <= $numAttachments; $i++) {
 515       $attachName = "attachFile_$i";
 516       $attachDesc = "attachDesc_$i";
 517       $attachTags = "tag_$i";
 518       $attachFreeTags = "file_taglist_$i";
 519       if (isset($formValues[$attachName]) && !empty($formValues[$attachName])) {
 520         // add static tags if selects
 521         $tagParams = array();
 522         if (!empty($formValues[$attachTags])) {
 523           foreach ($formValues[$attachTags] as $tag) {
 524             $tagParams[$tag] = 1;
 525           }
 526         }
 527
 528         // we dont care if the file is empty or not
 529         // CRM-7448
 530         $fileParams = array(
 531           'uri' => $formValues[$attachName]['name'],
 532           'type' => $formValues[$attachName]['type'],
 533           'location' => $formValues[$attachName]['name'],
 534           'description' => $formValues[$attachDesc],
 535           'upload_date' => $now,
 536           'tag' => $tagParams,
 537           'attachment_taglist' => CRM_Utils_Array::value($attachFreeTags, $formValues, array())
 538         );
 539
 540         $params[$attachName] = $fileParams;
 541       }
 542     }
 543   }
 544
 545   /**
 546    * @param array $params
 547    * @param $entityTable
 548    * @param int $entityID
 549    */
 550   public static function processAttachment(&$params, $entityTable, $entityID) {
 551     $numAttachments = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'max_attachments');
 552
 553     for ($i = 1; $i <= $numAttachments; $i++) {
 554       if (
 555         isset($params["attachFile_$i"]) &&
 556         is_array($params["attachFile_$i"])
 557       ) {
 558         self::filePostProcess(
 559           $params["attachFile_$i"]['location'],
 560           NULL,
 561           $entityTable,
 562           $entityID,
 563           NULL,
 564           TRUE,
 565           $params["attachFile_$i"],
 566           "attachFile_$i",
 567           $params["attachFile_$i"]['type']
 568         );
 569       }
 570     }
 571   }
 572
 573   /**
 574    * @return array
 575    */
 576   public static function uploadNames() {
 577     $numAttachments = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'max_attachments');
 578
 579     $names = array();
 580     for ($i = 1; $i <= $numAttachments; $i++) {
 581       $names[] = "attachFile_{$i}";
 582     }
 583     $names[] = 'uploadFile';
 584     return $names;
 585   }
 586
 587   /*
 588    * copy/attach an existing file to a different entity
 589    * table and id.
 590    */
 591   /**
 592    * @param $oldEntityTable
 593    * @param int $oldEntityId
 594    * @param $newEntityTable
 595    * @param int $newEntityId
 596    */
 597   public static function copyEntityFile($oldEntityTable, $oldEntityId, $newEntityTable, $newEntityId) {
 598     $oldEntityFile = new CRM_Core_DAO_EntityFile();
 599     $oldEntityFile->entity_id = $oldEntityId;
 600     $oldEntityFile->entity_table = $oldEntityTable;
 601     $oldEntityFile->find();
 602
 603     while ($oldEntityFile->fetch()) {
 604       $newEntityFile = new CRM_Core_DAO_EntityFile();
 605       $newEntityFile->entity_id = $newEntityId;
 606       $newEntityFile->entity_table = $newEntityTable;
 607       $newEntityFile->file_id = $oldEntityFile->file_id;
 608       $newEntityFile->save();
 609     }
 610   }
 611
 612   /**
 613    * @param $entityTable
 614    * @param int $entityID
 615    * @param int $fileID
 616    *
 617    * @return string
 618    */
 619   public static function deleteURLArgs($entityTable, $entityID, $fileID) {
 620     $params['entityTable'] = $entityTable;
 621     $params['entityID'] = $entityID;
 622     $params['fileID'] = $fileID;
 623
 624     $signer = new CRM_Utils_Signer(CRM_Core_Key::privateKey(), self::$_signableFields);
 625     $params['_sgn'] = $signer->sign($params);
 626     return CRM_Utils_System::makeQueryString($params);
 627   }
 628
 629   /**
 630    * Delete a file attachment from an entity table / entity ID
 631    *
 632    * @static
 633    */
 634   public static function deleteAttachment() {
 635     $params = array();
 636     $params['entityTable'] = CRM_Utils_Request::retrieve('entityTable', 'String', CRM_Core_DAO::$_nullObject, TRUE);
 637     $params['entityID'] = CRM_Utils_Request::retrieve('entityID', 'Positive', CRM_Core_DAO::$_nullObject, TRUE);
 638     $params['fileID'] = CRM_Utils_Request::retrieve('fileID', 'Positive', CRM_Core_DAO::$_nullObject, TRUE);
 639
 640     $signature = CRM_Utils_Request::retrieve('_sgn', 'String', CRM_Core_DAO::$_nullObject, TRUE);
 641
 642     $signer = new CRM_Utils_Signer(CRM_Core_Key::privateKey(), self::$_signableFields);
 643     if (!$signer->validate($signature, $params)) {
 644       CRM_Core_Error::fatal('Request signature is invalid');
 645     }
 646
 647     CRM_Core_BAO_File::deleteEntityFile($params['entityTable'], $params['entityID'], NULL, $params['fileID']);
 648   }
 649
 650
 651   /**
 652    * Display paper icon for a file attachment -- CRM-13624
 653    *
 654    * @param $entityTable
 655    *   String The entityTable to which the file is attached. eg "civicrm_contact", "civicrm_note", "civicrm_activity".
 656    *                             If you have the ID of a specific row in civicrm_file, use $entityTable='*'
 657    * @param $entityID
 658    *   Int The id of the object in the above entityTable.
 659    *
 660    * @return array|NULL          list of HTML snippets; one HTML snippet for each attachment. If none found, then NULL
 661    *
 662    * @static
 663    */
 664   public static function paperIconAttachment($entityTable, $entityID) {
 665     if (empty($entityTable) || !$entityID) {
 666       $results = NULL;
 667       return $results;
 668     }
 669     $currentAttachmentInfo = self::getEntityFile($entityTable, $entityID);
 670     foreach ($currentAttachmentInfo as $fileKey => $fileValue) {
 671       $fileID = $fileValue['fileID'];
 672       $fileType = $fileValue['mime_type'];
 673       $eid = $entityID;
 674       if ($fileID) {
 675         if ($fileType == 'image/jpeg' ||
 676           $fileType == 'image/pjpeg' ||
 677           $fileType == 'image/gif' ||
 678           $fileType == 'image/x-png' ||
 679           $fileType == 'image/png'
 680         ) {
 681           $url = $fileValue['url'];
 682           $alt = $fileValue['cleanName'];
 683           $file_url[$fileID] = "
 684               <a href=\"$url\" class='crm-image-popup'>
 685               <div class='icon paper-icon' title=\"$alt\" alt=\"$alt\"></div>
 686               </a>";
 687           // for non image files
 688         }
 689         else {
 690           $url = $fileValue['url'];
 691           $alt = $fileValue['cleanName'];
 692           $file_url[$fileID] = "<a href=\"$url\"><div class='icon paper-icon' title=\"$alt\" alt=\"$alt\"></div></a>";
 693         }
 694       }
 695     }
 696     if (empty($file_url)) {
 697       $results = NULL;
 698     }
 699     else {
 700       $results = $file_url;
 701     }
 702     return $results;
 703   }
 704
 705   /**
 706    * Get a reference to the file-search service (if one is available).
 707    *
 708    * @return CRM_Core_FileSearchInterface|NULL
 709    */
 710   public static function getSearchService() {
 711     $fileSearches = array();
 712     CRM_Utils_Hook::fileSearches($fileSearches);
 713
 714     // use the first available search
 715     foreach ($fileSearches as $fileSearch) {
 716       /** @var $fileSearch CRM_Core_FileSearchInterface */
 717       return $fileSearch;
 718     }
 719     return NULL;
 720   }
 721 }