CRM/Core/Page/File.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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-2019
  32  * $Id$
  33  *
  34  */
  35 class CRM_Core_Page_File extends CRM_Core_Page {
  36
  37   /**
  38    * Run page.
  39    */
  40   public function run() {
  41     $action = CRM_Utils_Request::retrieve('action', 'String', $this);
  42     $download = CRM_Utils_Request::retrieve('download', 'Integer', $this, FALSE, 1);
  43     $disposition = $download == 0 ? 'inline' : 'download';
  44
  45     // Entity ID (e.g. Contact ID)
  46     $entityId = CRM_Utils_Request::retrieve('eid', 'Positive', $this, FALSE);
  47     // Field ID
  48     $fieldId = CRM_Utils_Request::retrieve('fid', 'Positive', $this, FALSE);
  49     // File ID
  50     $fileId = CRM_Utils_Request::retrieve('id', 'Positive', $this, FALSE);
  51     $fileName = CRM_Utils_Request::retrieve('filename', 'String', $this, FALSE);
  52     if (empty($fileName) && (empty($entityId) || empty($fileId))) {
  53       CRM_Core_Error::statusBounce("Cannot access file: Must pass either \"Filename\" or the combination of \"Entity ID\" + \"File ID\"");
  54     }
  55
  56     if (empty($fileName)) {
  57       $hash = CRM_Utils_Request::retrieve('fcs', 'Alphanumeric', $this);
  58       if (!CRM_Core_BAO_File::validateFileHash($hash, $entityId, $fileId)) {
  59         CRM_Core_Error::statusBounce('URL for file is not valid');
  60       }
  61
  62       list($path, $mimeType) = CRM_Core_BAO_File::path($fileId, $entityId);
  63     }
  64     else {
  65       if (!CRM_Utils_File::isValidFileName($fileName)) {
  66         throw new CRM_Core_Exception("Malformed filename");
  67       }
  68       $mimeType = '';
  69       $path = CRM_Core_Config::singleton()->customFileUploadDir . $fileName;
  70     }
  71     $mimeType = CRM_Utils_Request::retrieveValue('mime-type', 'String', $mimeType, FALSE);
  72
  73     if (!$path) {
  74       CRM_Core_Error::statusBounce('Could not retrieve the file');
  75     }
  76
  77     $buffer = file_get_contents($path);
  78     if (!$buffer) {
  79       CRM_Core_Error::statusBounce('The file is either empty or you do not have permission to retrieve the file');
  80     }
  81
  82     if ($action & CRM_Core_Action::DELETE) {
  83       if (CRM_Utils_Request::retrieve('confirmed', 'Boolean')) {
  84         CRM_Core_BAO_File::deleteFileReferences($fileId, $entityId, $fieldId);
  85         CRM_Core_Session::setStatus(ts('The attached file has been deleted.'), ts('Complete'), 'success');
  86
  87         $session = CRM_Core_Session::singleton();
  88         $toUrl = $session->popUserContext();
  89         CRM_Utils_System::redirect($toUrl);
  90       }
  91     }
  92     else {
  93       CRM_Utils_System::download(
  94         CRM_Utils_File::cleanFileName(basename($path)),
  95         $mimeType,
  96         $buffer,
  97         NULL,
  98         TRUE,
  99         $disposition
 100       );
 101     }
 102   }
 103
 104 }