Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
f299f7db | 6 | | Copyright CiviCRM LLC (c) 2004-2020 | |
6a488035 TO |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
f299f7db | 31 | * @copyright CiviCRM LLC (c) 2004-2020 |
6a488035 TO |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | class CRM_Core_Page_File extends CRM_Core_Page { | |
6a488035 | 36 | |
8246bca4 | 37 | /** |
38 | * Run page. | |
39 | */ | |
00be9182 | 40 | public function run() { |
6a488035 | 41 | $action = CRM_Utils_Request::retrieve('action', 'String', $this); |
3159f5dc | 42 | $download = CRM_Utils_Request::retrieve('download', 'Integer', $this, FALSE, 1); |
10b710f9 | 43 | $disposition = $download == 0 ? 'inline' : 'download'; |
6a488035 | 44 | |
518fa0ee SL |
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); | |
a0013a8d SL |
51 | $fileName = CRM_Utils_Request::retrieve('filename', 'String', $this, FALSE); |
52 | if (empty($fileName) && (empty($entityId) || empty($fileId))) { | |
6fcdf748 | 53 | CRM_Core_Error::statusBounce("Cannot access file: Must pass either \"Filename\" or the combination of \"Entity ID\" + \"File ID\""); |
a0013a8d | 54 | } |
acac898b TO |
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); | |
ff9aeadb | 63 | } |
acac898b | 64 | else { |
a7762e79 | 65 | if (!CRM_Utils_File::isValidFileName($fileName)) { |
e536c4d4 TO |
66 | throw new CRM_Core_Exception("Malformed filename"); |
67 | } | |
a0013a8d SL |
68 | $mimeType = ''; |
69 | $path = CRM_Core_Config::singleton()->customFileUploadDir . $fileName; | |
70 | } | |
f3726153 | 71 | |
6a488035 TO |
72 | if (!$path) { |
73 | CRM_Core_Error::statusBounce('Could not retrieve the file'); | |
74 | } | |
6cb3fe2e SL |
75 | |
76 | if (empty($mimeType)) { | |
ce5b9953 | 77 | $passedInMimeType = self::convertBadMimeAliasTypes(CRM_Utils_Request::retrieveValue('mime-type', 'String', $mimeType, FALSE)); |
6cb3fe2e SL |
78 | if (!in_array($passedInMimeType, explode(',', Civi::settings()->get('requestableMimeTypes')))) { |
79 | throw new CRM_Core_Exception("Supplied mime-type is not accepted"); | |
430858da | 80 | } |
6cb3fe2e SL |
81 | $extension = CRM_Utils_File::getExtensionFromPath($path); |
82 | $candidateExtensions = CRM_Utils_File::getAcceptableExtensionsForMimeType($passedInMimeType); | |
9a0e7039 | 83 | if (!in_array(strtolower($extension), array_map('strtolower', $candidateExtensions))) { |
6cb3fe2e | 84 | throw new CRM_Core_Exception("Supplied mime-type does not match file extension"); |
430858da | 85 | } |
6cb3fe2e | 86 | // Now that we have validated mime-type supplied as much as possible lets now set the MimeType variable/ |
430858da | 87 | $mimeType = $passedInMimeType; |
2d20f3a9 SL |
88 | } |
89 | ||
6a488035 TO |
90 | $buffer = file_get_contents($path); |
91 | if (!$buffer) { | |
92 | CRM_Core_Error::statusBounce('The file is either empty or you do not have permission to retrieve the file'); | |
93 | } | |
94 | ||
95 | if ($action & CRM_Core_Action::DELETE) { | |
a3d827a7 | 96 | if (CRM_Utils_Request::retrieve('confirmed', 'Boolean')) { |
7618eb9d | 97 | CRM_Core_BAO_File::deleteFileReferences($fileId, $entityId, $fieldId); |
6a488035 TO |
98 | CRM_Core_Session::setStatus(ts('The attached file has been deleted.'), ts('Complete'), 'success'); |
99 | ||
100 | $session = CRM_Core_Session::singleton(); | |
101 | $toUrl = $session->popUserContext(); | |
102 | CRM_Utils_System::redirect($toUrl); | |
103 | } | |
6a488035 TO |
104 | } |
105 | else { | |
b3fdbf3d DL |
106 | CRM_Utils_System::download( |
107 | CRM_Utils_File::cleanFileName(basename($path)), | |
6a488035 | 108 | $mimeType, |
3159f5dc | 109 | $buffer, |
110 | NULL, | |
111 | TRUE, | |
112 | $disposition | |
6a488035 TO |
113 | ); |
114 | } | |
115 | } | |
96025800 | 116 | |
ce5b9953 TO |
117 | /** |
118 | * Translate one mime type to another. | |
119 | * | |
120 | * Certain non-standard/weird MIME types have been common. Unfortunately, because | |
121 | * of the way this controller is used, the weird types may baked-into URLs. | |
122 | * We clean these up for compatibility. | |
123 | * | |
124 | * @param string $type | |
125 | * Ex: 'image/jpg' | |
126 | * @return string | |
127 | * Ex: 'image/jpeg'. | |
128 | */ | |
129 | protected static function convertBadMimeAliasTypes($type) { | |
130 | $badTypes = [ | |
131 | // Before PNG format was ubiquitous, it was image/x-png? | |
132 | 'image/x-png' => 'image/png', | |
133 | ||
134 | // People see "image/gif" and "image/png" and wrongly guess "image/jpg"? | |
135 | 'image/jpg' => 'image/jpeg', | |
136 | 'image/tif' => 'image/tiff', | |
137 | 'image/svg' => 'image/svg+xml', | |
138 | ||
139 | // StackExchange attributes "pjpeg" to some quirk in an old version of IE? | |
140 | 'image/pjpeg' => 'image/jpeg', | |
141 | ||
142 | ]; | |
143 | return isset($badTypes[$type]) ? $badTypes[$type] : $type; | |
144 | } | |
145 | ||
6a488035 | 146 | } |