mediafile.php 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673
  1. <?php
  2. /**
  3. * GNU social - a federating social network
  4. *
  5. * Abstraction for media files
  6. *
  7. * LICENCE: This program is free software: you can redistribute it and/or modify
  8. * it under the terms of the GNU Affero General Public License as published by
  9. * the Free Software Foundation, either version 3 of the License, or
  10. * (at your option) any later version.
  11. *
  12. * This program is distributed in the hope that it will be useful,
  13. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15. * GNU Affero General Public License for more details.
  16. *
  17. * You should have received a copy of the GNU Affero General Public License
  18. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  19. *
  20. * @category Media
  21. * @package GNUsocial
  22. * @author Robin Millette <robin@millette.info>
  23. * @author Miguel Dantas <biodantas@gmail.com>
  24. * @author Zach Copley <zach@status.net>
  25. * @author Mikael Nordfeldth <mmn@hethane.se>
  26. * @copyright 2008-2009, 2019 Free Software Foundation http://fsf.org
  27. * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28. * @link https://www.gnu.org/software/social/
  29. */
  30. defined('GNUSOCIAL') || die();
  31. /**
  32. * Class responsible for abstracting media files
  33. */
  34. class MediaFile
  35. {
  36. public $id = null;
  37. public $filepath = null;
  38. public $filename = null;
  39. public $fileRecord = null;
  40. public $fileurl = null;
  41. public $short_fileurl = null;
  42. public $mimetype = null;
  43. /**
  44. * @param string $filepath The path of the file this media refers to. Required
  45. * @param string $mimetype The mimetype of the file. Required
  46. * @param $filehash The hash of the file, if known. Optional
  47. * @param int|null $id The DB id of the file. Int if known, null if not.
  48. * If null, it searches for it. If -1, it skips all DB
  49. * interactions (useful for temporary objects)
  50. * @throws ClientException
  51. * @throws NoResultException
  52. * @throws ServerException
  53. */
  54. public function __construct(string $filepath, string $mimetype, $filehash = null, $id = null)
  55. {
  56. $this->filepath = $filepath;
  57. $this->filename = basename($this->filepath);
  58. $this->mimetype = $mimetype;
  59. $this->filehash = self::getHashOfFile($this->filepath, $filehash);
  60. $this->id = $id;
  61. // If id is -1, it means we're dealing with a temporary object and don't want to store it in the DB,
  62. // or add redirects
  63. if ($this->id !== -1) {
  64. if (!empty($this->id)) {
  65. // If we have an id, load it
  66. $this->fileRecord = new File();
  67. $this->fileRecord->id = $this->id;
  68. if (!$this->fileRecord->find(true)) {
  69. // If we have set an ID, we need that ID to exist!
  70. throw new NoResultException($this->fileRecord);
  71. }
  72. } else {
  73. // Otherwise, store it
  74. $this->fileRecord = $this->storeFile();
  75. }
  76. $this->fileurl = common_local_url(
  77. 'attachment',
  78. array('attachment' => $this->fileRecord->id)
  79. );
  80. $this->short_fileurl = common_shorten_url($this->fileurl);
  81. }
  82. }
  83. public function attachToNotice(Notice $notice)
  84. {
  85. File_to_post::processNew($this->fileRecord, $notice);
  86. }
  87. public function getPath()
  88. {
  89. return File::path($this->filename);
  90. }
  91. public function shortUrl()
  92. {
  93. return $this->short_fileurl;
  94. }
  95. public function getEnclosure()
  96. {
  97. return $this->getFile()->getEnclosure();
  98. }
  99. public function delete()
  100. {
  101. @unlink($this->filepath);
  102. }
  103. public function getFile()
  104. {
  105. if (!$this->fileRecord instanceof File) {
  106. throw new ServerException('File record did not exist for MediaFile');
  107. }
  108. return $this->fileRecord;
  109. }
  110. /**
  111. * Calculate the hash of a file.
  112. *
  113. * This won't work for files >2GiB because PHP uses only 32bit.
  114. * @param string $filepath
  115. * @param string|null $filehash
  116. * @return string
  117. * @throws ServerException
  118. */
  119. public static function getHashOfFile(string $filepath, $filehash = null)
  120. {
  121. assert(!empty($filepath), __METHOD__ . ": filepath cannot be null");
  122. if ($filehash === null) {
  123. // Calculate if we have an older upload method somewhere (Qvitter) that
  124. // doesn't do this before calling new MediaFile on its local files...
  125. $filehash = hash_file(File::FILEHASH_ALG, $filepath);
  126. if ($filehash === false) {
  127. throw new ServerException('Could not read file for hashing');
  128. }
  129. }
  130. return $filehash;
  131. }
  132. /**
  133. * Retrieve or insert as a file in the DB
  134. *
  135. * @return object File
  136. * @throws ClientException
  137. * @throws ServerException
  138. */
  139. protected function storeFile()
  140. {
  141. try {
  142. $file = File::getByHash($this->filehash);
  143. // We're done here. Yes. Already. We assume sha256 won't collide on us anytime soon.
  144. return $file;
  145. } catch (NoResultException $e) {
  146. // Well, let's just continue below.
  147. }
  148. $fileurl = common_local_url('attachment_view', array('filehash' => $this->filehash));
  149. $file = new File;
  150. $file->filename = $this->filename;
  151. $file->urlhash = File::hashurl($fileurl);
  152. $file->url = $fileurl;
  153. $file->filehash = $this->filehash;
  154. $file->size = filesize($this->filepath);
  155. if ($file->size === false) {
  156. throw new ServerException('Could not read file to get its size');
  157. }
  158. $file->date = time();
  159. $file->mimetype = $this->mimetype;
  160. $file_id = $file->insert();
  161. if ($file_id===false) {
  162. common_log_db_error($file, "INSERT", __FILE__);
  163. // TRANS: Client exception thrown when a database error was thrown during a file upload operation.
  164. throw new ClientException(_('There was a database error while saving your file. Please try again.'));
  165. }
  166. // Set file geometrical properties if available
  167. try {
  168. $image = ImageFile::fromFileObject($file);
  169. $orig = clone($file);
  170. $file->width = $image->width;
  171. $file->height = $image->height;
  172. $file->update($orig);
  173. // We have to cleanup after ImageFile, since it
  174. // may have generated a temporary file from a
  175. // video support plugin or something.
  176. // FIXME: Do this more automagically.
  177. if ($image->getPath() != $file->getPath()) {
  178. $image->unlink();
  179. }
  180. } catch (ServerException $e) {
  181. // We just couldn't make out an image from the file. This
  182. // does not have to be UnsupportedMediaException, as we can
  183. // also get ServerException from files not existing etc.
  184. }
  185. return $file;
  186. }
  187. /**
  188. * The maximum allowed file size, as a string
  189. */
  190. public static function maxFileSize()
  191. {
  192. $value = self::maxFileSizeInt();
  193. if ($value > 1024 * 1024) {
  194. $value = $value/(1024*1024);
  195. // TRANS: Number of megabytes. %d is the number.
  196. return sprintf(_m('%dMB', '%dMB', $value), $value);
  197. } elseif ($value > 1024) {
  198. $value = $value/1024;
  199. // TRANS: Number of kilobytes. %d is the number.
  200. return sprintf(_m('%dkB', '%dkB', $value), $value);
  201. } else {
  202. // TRANS: Number of bytes. %d is the number.
  203. return sprintf(_m('%dB', '%dB', $value), $value);
  204. }
  205. }
  206. /**
  207. * The maximum allowed file size, as an int
  208. */
  209. public static function maxFileSizeInt() : int
  210. {
  211. return common_config('attachments', 'file_quota');
  212. }
  213. /**
  214. * Encodes a file name and a file hash in the new file format, which is used to avoid
  215. * having an extension in the file, removing trust in extensions, while keeping the original name
  216. * @throws ClientException
  217. */
  218. public static function encodeFilename($original_name, string $filehash, $ext = null) : string
  219. {
  220. if (empty($original_name)) {
  221. $original_name = _('Untitled attachment');
  222. }
  223. // If we're given an extension explicitly, use it, otherwise...
  224. $ext = $ext ?:
  225. // get a replacement extension if configured, returns false if it's blocked,
  226. // null if no extension
  227. File::getSafeExtension($original_name);
  228. if ($ext === false) {
  229. throw new ClientException(_('Blacklisted file extension.'));
  230. }
  231. if (!empty($ext)) {
  232. // Remove dots if we have them (make sure they're not repeated)
  233. $ext = preg_replace('/^\.+/', '', $ext);
  234. $original_name = preg_replace('/\.+.+$/i', ".{$ext}", $original_name);
  235. }
  236. $enc_name = bin2hex($original_name);
  237. return "{$enc_name}-{$filehash}";
  238. }
  239. /**
  240. * Decode the new filename format
  241. * @return false | null | string on failure, no match (old format) or original file name, respectively
  242. */
  243. public static function decodeFilename(string $encoded_filename)
  244. {
  245. // The x is because it is using in thumbnails
  246. $ret = preg_match('/^([^-x]+?)-[^-]+$/', $encoded_filename, $matches);
  247. if ($ret === false) {
  248. return false;
  249. } elseif ($ret === 0) {
  250. return null; // No match
  251. } else {
  252. $filename = hex2bin($matches[1]);
  253. // Matches extension
  254. if (preg_match('/^(.+?)\.(.+)$/', $filename, $sub_matches) === 1) {
  255. $ext = $sub_matches[2];
  256. // Previously, there was a blacklisted extension array, which could have an alternative
  257. // extension, such as phps, to replace php. We want to turn it back (this is deprecated,
  258. // as it no longer makes sense, since we don't trust trust files based on extension,
  259. // but keep the feature)
  260. $blacklist = common_config('attachments', 'extblacklist');
  261. if (is_array($blacklist)) {
  262. foreach ($blacklist as $upload_ext => $safe_ext) {
  263. if ($ext === $safe_ext) {
  264. $ext = $upload_ext;
  265. break;
  266. }
  267. }
  268. }
  269. return "{$sub_matches[1]}.{$ext}";
  270. } else {
  271. // No extension, don't bother trying to replace it
  272. return $filename;
  273. }
  274. }
  275. }
  276. /**
  277. * Create a new MediaFile or ImageFile object from an upload
  278. *
  279. * Tries to set the mimetype correctly, using the most secure method available and rejects the file otherwise.
  280. * In case the upload is an image, this function returns an new ImageFile (which extends MediaFile)
  281. * The filename has a new format:
  282. * bin2hex("{$original_name}.{$ext}")."-{$filehash}"
  283. * This format should be respected. Notice the dash, which is important to distinguish it from the previous
  284. * format ("{$hash}.{$ext}")
  285. *
  286. * @param string $param
  287. * @param Profile|null $scoped
  288. * @return ImageFile|MediaFile
  289. * @throws ClientException
  290. * @throws NoResultException
  291. * @throws NoUploadedMediaException
  292. * @throws ServerException
  293. * @throws UnsupportedMediaException
  294. * @throws UseFileAsThumbnailException
  295. */
  296. public static function fromUpload(string $param='media', Profile $scoped=null)
  297. {
  298. // The existence of the "error" element means PHP has processed it properly even if it was ok.
  299. if (!isset($_FILES[$param]) || !isset($_FILES[$param]['error'])) {
  300. throw new NoUploadedMediaException($param);
  301. }
  302. switch ($_FILES[$param]['error']) {
  303. case UPLOAD_ERR_OK: // success, jump out
  304. break;
  305. case UPLOAD_ERR_INI_SIZE:
  306. case UPLOAD_ERR_FORM_SIZE:
  307. // TRANS: Exception thrown when too large a file is uploaded.
  308. // TRANS: %s is the maximum file size, for example "500b", "10kB" or "2MB".
  309. throw new ClientException(sprintf(
  310. _('That file is too big. The maximum file size is %s.'),
  311. self::maxFileSize()
  312. ));
  313. case UPLOAD_ERR_PARTIAL:
  314. @unlink($_FILES[$param]['tmp_name']);
  315. // TRANS: Client exception.
  316. throw new ClientException(_('The uploaded file was only partially uploaded.'));
  317. case UPLOAD_ERR_NO_FILE:
  318. // No file; probably just a non-AJAX submission.
  319. throw new NoUploadedMediaException($param);
  320. case UPLOAD_ERR_NO_TMP_DIR:
  321. // TRANS: Client exception thrown when a temporary folder is not present to store a file upload.
  322. throw new ClientException(_('Missing a temporary folder.'));
  323. case UPLOAD_ERR_CANT_WRITE:
  324. // TRANS: Client exception thrown when writing to disk is not possible during a file upload operation.
  325. throw new ClientException(_('Failed to write file to disk.'));
  326. case UPLOAD_ERR_EXTENSION:
  327. // TRANS: Client exception thrown when a file upload operation has been stopped by an extension.
  328. throw new ClientException(_('File upload stopped by extension.'));
  329. default:
  330. common_log(LOG_ERR, __METHOD__ . ": Unknown upload error " . $_FILES[$param]['error']);
  331. // TRANS: Client exception thrown when a file upload operation has failed with an unknown reason.
  332. throw new ClientException(_('System error uploading file.'));
  333. }
  334. $filehash = strtolower(self::getHashOfFile($_FILES[$param]['tmp_name']));
  335. try {
  336. $file = File::getByHash($filehash);
  337. // If no exception is thrown the file exists locally, so we'll use that and just add redirections.
  338. // but if the _actual_ locally stored file doesn't exist, getPath will throw FileNotFoundException
  339. $filepath = $file->getPath();
  340. $mimetype = $file->mimetype;
  341. } catch (FileNotFoundException | NoResultException $e) {
  342. // We have to save the upload as a new local file. This is the normal course of action.
  343. if ($scoped instanceof Profile) {
  344. // Throws exception if additional size does not respect quota
  345. // This test is only needed, of course, if we're uploading something new.
  346. File::respectsQuota($scoped, $_FILES[$param]['size']);
  347. }
  348. $mimetype = self::getUploadedMimeType($_FILES[$param]['tmp_name'], $_FILES[$param]['name']);
  349. $media = common_get_mime_media($mimetype);
  350. $basename = basename($_FILES[$param]['name']);
  351. if ($media === 'image') {
  352. // Use -1 for the id to avoid adding this temporary file to the DB
  353. $img = new ImageFile(-1, $_FILES[$param]['tmp_name']);
  354. // Validate the image by reencoding it. Additionally normalizes old formats to PNG,
  355. // keeping JPEG and GIF untouched
  356. $outpath = $img->resizeTo($img->filepath);
  357. $ext = image_type_to_extension($img->preferredType(), false);
  358. }
  359. $filename = self::encodeFilename($basename, $filehash, $ext);
  360. $filepath = File::path($filename);
  361. if ($media === 'image') {
  362. $result = rename($outpath, $filepath);
  363. } else {
  364. $result = move_uploaded_file($_FILES[$param]['tmp_name'], $filepath);
  365. }
  366. if (!$result) {
  367. // TRANS: Client exception thrown when a file upload operation fails because the file could
  368. // TRANS: not be moved from the temporary folder to the permanent file location.
  369. // UX: too specific
  370. throw new ClientException(_('File could not be moved to destination directory.'));
  371. }
  372. if ($media === 'image') {
  373. return new ImageFile(null, $filepath);
  374. }
  375. }
  376. return new MediaFile($filepath, $mimetype, $filehash);
  377. }
  378. public static function fromFilehandle($fh, Profile $scoped=null)
  379. {
  380. $stream = stream_get_meta_data($fh);
  381. // So far we're only handling filehandles originating from tmpfile(),
  382. // so we can always do hash_file on $stream['uri'] as far as I can tell!
  383. $filehash = hash_file(File::FILEHASH_ALG, $stream['uri']);
  384. try {
  385. $file = File::getByHash($filehash);
  386. // Already have it, so let's reuse the locally stored File
  387. // by using getPath we also check whether the file exists
  388. // and throw a FileNotFoundException with the path if it doesn't.
  389. $filename = basename($file->getPath());
  390. $mimetype = $file->mimetype;
  391. } catch (FileNotFoundException $e) {
  392. // This happens if the file we have uploaded has disappeared
  393. // from the local filesystem for some reason. Since we got the
  394. // File object from a sha256 check in fromFilehandle, it's safe
  395. // to just copy the uploaded data to disk!
  396. fseek($fh, 0); // just to be sure, go to the beginning
  397. // dump the contents of our filehandle to the path from our exception
  398. // and report error if it failed.
  399. if (false === file_put_contents($e->path, fread($fh, filesize($stream['uri'])))) {
  400. // TRANS: Client exception thrown when a file upload operation fails because the file could
  401. // TRANS: not be moved from the temporary folder to the permanent file location.
  402. throw new ClientException(_('File could not be moved to destination directory.'));
  403. }
  404. if (!chmod($e->path, 0664)) {
  405. common_log(LOG_ERR, 'Could not chmod uploaded file: '._ve($e->path));
  406. }
  407. $filename = basename($file->getPath());
  408. $mimetype = $file->mimetype;
  409. } catch (NoResultException $e) {
  410. if ($scoped instanceof Profile) {
  411. File::respectsQuota($scoped, filesize($stream['uri']));
  412. }
  413. $mimetype = self::getUploadedMimeType($stream['uri']);
  414. $filename = strtolower($filehash) . '.' . File::guessMimeExtension($mimetype);
  415. $filepath = File::path($filename);
  416. $result = copy($stream['uri'], $filepath) && chmod($filepath, 0664);
  417. if (!$result) {
  418. common_log(LOG_ERR, 'File could not be moved (or chmodded) from '._ve($stream['uri']) . ' to ' . _ve($filepath));
  419. // TRANS: Client exception thrown when a file upload operation fails because the file could
  420. // TRANS: not be moved from the temporary folder to the permanent file location.
  421. throw new ClientException(_('File could not be moved to destination directory.'));
  422. }
  423. }
  424. return new MediaFile($filename, $mimetype, $filehash);
  425. }
  426. /**
  427. * Attempt to identify the content type of a given file.
  428. *
  429. * @param string $filepath filesystem path as string (file must exist)
  430. * @param bool $originalFilename (optional) for extension-based detection
  431. * @return string
  432. *
  433. * @throws ClientException if type is known, but not supported for local uploads
  434. * @throws ServerException
  435. * @fixme this seems to tie a front-end error message in, kinda confusing
  436. *
  437. */
  438. public static function getUploadedMimeType(string $filepath, $originalFilename=false)
  439. {
  440. // We only accept filenames to existing files
  441. $mimetype = null;
  442. // From CodeIgniter
  443. // We'll need this to validate the MIME info string (e.g. text/plain; charset=us-ascii)
  444. $regexp = '/^([a-z\-]+\/[a-z0-9\-\.\+]+)(;\s[^\/]+)?$/';
  445. /**
  446. * Fileinfo extension - most reliable method
  447. *
  448. * Apparently XAMPP, CentOS, cPanel and who knows what
  449. * other PHP distribution channels EXPLICITLY DISABLE
  450. * ext/fileinfo, which is otherwise enabled by default
  451. * since PHP 5.3 ...
  452. */
  453. if (function_exists('finfo_file')) {
  454. $finfo = @finfo_open(FILEINFO_MIME);
  455. // It is possible that a FALSE value is returned, if there is no magic MIME database
  456. // file found on the system
  457. if (is_resource($finfo)) {
  458. $mime = @finfo_file($finfo, $filepath);
  459. finfo_close($finfo);
  460. /* According to the comments section of the PHP manual page,
  461. * it is possible that this function returns an empty string
  462. * for some files (e.g. if they don't exist in the magic MIME database)
  463. */
  464. if (is_string($mime) && preg_match($regexp, $mime, $matches)) {
  465. $mimetype = $matches[1];
  466. }
  467. }
  468. }
  469. /* This is an ugly hack, but UNIX-type systems provide a "native" way to detect the file type,
  470. * which is still more secure than depending on the value of $_FILES[$field]['type'], and as it
  471. * was reported in issue #750 (https://github.com/EllisLab/CodeIgniter/issues/750) - it's better
  472. * than mime_content_type() as well, hence the attempts to try calling the command line with
  473. * three different functions.
  474. *
  475. * Notes:
  476. * - the DIRECTORY_SEPARATOR comparison ensures that we're not on a Windows system
  477. * - many system admins would disable the exec(), shell_exec(), popen() and similar functions
  478. * due to security concerns, hence the function_usable() checks
  479. */
  480. if (DIRECTORY_SEPARATOR !== '\\') {
  481. $cmd = 'file --brief --mime '.escapeshellarg($filepath).' 2>&1';
  482. if (empty($mimetype) && function_exists('exec')) {
  483. /* This might look confusing, as $mime is being populated with all of the output
  484. * when set in the second parameter. However, we only need the last line, which is
  485. * the actual return value of exec(), and as such - it overwrites anything that could
  486. * already be set for $mime previously. This effectively makes the second parameter a
  487. * dummy value, which is only put to allow us to get the return status code.
  488. */
  489. $mime = @exec($cmd, $mime, $return_status);
  490. if ($return_status === 0 && is_string($mime) && preg_match($regexp, $mime, $matches)) {
  491. $mimetype = $matches[1];
  492. }
  493. }
  494. if (empty($mimetype) && function_exists('shell_exec')) {
  495. $mime = @shell_exec($cmd);
  496. if (strlen($mime) > 0) {
  497. $mime = explode("\n", trim($mime));
  498. if (preg_match($regexp, $mime[(count($mime) - 1)], $matches)) {
  499. $mimetype = $matches[1];
  500. }
  501. }
  502. }
  503. if (empty($mimetype) && function_exists('popen')) {
  504. $proc = @popen($cmd, 'r');
  505. if (is_resource($proc)) {
  506. $mime = @fread($proc, 512);
  507. @pclose($proc);
  508. if ($mime !== false) {
  509. $mime = explode("\n", trim($mime));
  510. if (preg_match($regexp, $mime[(count($mime) - 1)], $matches)) {
  511. $mimetype = $matches[1];
  512. }
  513. }
  514. }
  515. }
  516. }
  517. // Fall back to mime_content_type(), if available (still better than $_FILES[$field]['type'])
  518. if (empty($mimetype) && function_exists('mime_content_type')) {
  519. $mimetype = @mime_content_type($filepath);
  520. // It's possible that mime_content_type() returns FALSE or an empty string
  521. if ($mimetype == false && strlen($mimetype) > 0) {
  522. throw new ServerException(_m('Could not determine file\'s MIME type.'));
  523. }
  524. }
  525. // Unclear types are such that we can't really tell by the auto
  526. // detect what they are (.bin, .exe etc. are just "octet-stream")
  527. $unclearTypes = array('application/octet-stream',
  528. 'application/vnd.ms-office',
  529. 'application/zip',
  530. 'text/plain',
  531. 'text/html', // Ironically, Wikimedia Commons' SVG_logo.svg is identified as text/html
  532. // TODO: for XML we could do better content-based sniffing too
  533. 'text/xml');
  534. $supported = common_config('attachments', 'supported');
  535. // If we didn't match, or it is an unclear match
  536. if ($originalFilename && (!$mimetype || in_array($mimetype, $unclearTypes))) {
  537. try {
  538. $type = common_supported_filename_to_mime($originalFilename);
  539. return $type;
  540. } catch (UnknownExtensionMimeException $e) {
  541. // FIXME: I think we should keep the file extension here (supported should be === true here)
  542. } catch (Exception $e) {
  543. // Extension parsed but no connected mimetype, so $mimetype is our best guess
  544. }
  545. }
  546. // If $config['attachments']['supported'] equals boolean true, accept any mimetype
  547. if ($supported === true || array_key_exists($mimetype, $supported)) {
  548. // FIXME: Don't know if it always has a mimetype here because
  549. // finfo->file CAN return false on error: http://php.net/finfo_file
  550. // so if $supported === true, this may return something unexpected.
  551. return $mimetype;
  552. }
  553. // We can conclude that we have failed to get the MIME type
  554. $media = common_get_mime_media($mimetype);
  555. if ('application' !== $media) {
  556. // TRANS: Client exception thrown trying to upload a forbidden MIME type.
  557. // TRANS: %1$s is the file type that was denied, %2$s is the application part of
  558. // TRANS: the MIME type that was denied.
  559. $hint = sprintf(_('"%1$s" is not a supported file type on this server. ' .
  560. 'Try using another %2$s format.'), $mimetype, $media);
  561. } else {
  562. // TRANS: Client exception thrown trying to upload a forbidden MIME type.
  563. // TRANS: %s is the file type that was denied.
  564. $hint = sprintf(_('"%s" is not a supported file type on this server.'), $mimetype);
  565. }
  566. throw new ClientException($hint);
  567. }
  568. /**
  569. * Title for a file, to display in the interface (if there's no better title) and
  570. * for download filenames
  571. * @param $file File object
  572. * @returns string
  573. */
  574. public static function getDisplayName(File $file) : string {
  575. if (empty($file->filename)) {
  576. return _('Untitled attachment');
  577. }
  578. // New file name format is "{bin2hex(original_name.ext)}-{$hash}"
  579. $filename = self::decodeFilename($file->filename);
  580. // If there was an error in the match, something's wrong with some piece
  581. // of code (could be a file with utf8 chars in the name)
  582. $log_error_msg = "Invalid file name for File with id={$file->id} " .
  583. "({$file->filename}). Some plugin probably did something wrong.";
  584. if ($filename === false) {
  585. common_log(LOG_ERR, $log_error_msg);
  586. } elseif ($filename === null) {
  587. // The old file name format was "{hash}.{ext}" so we didn't have a name
  588. // This extracts the extension
  589. $ret = preg_match('/^.+?\.+?(.+)$/', $file->filename, $matches);
  590. if ($ret !== 1) {
  591. common_log(LOG_ERR, $log_error_msg);
  592. return _('Untitled attachment');
  593. }
  594. $ext = $matches[1];
  595. // There's a blacklisted extension array, which could have an alternative
  596. // extension, such as phps, to replace php. We want to turn it back
  597. // (currently defaulted to empty, but let's keep the feature)
  598. $blacklist = common_config('attachments', 'extblacklist');
  599. if (is_array($blacklist)) {
  600. foreach ($blacklist as $upload_ext => $safe_ext) {
  601. if ($ext === $safe_ext) {
  602. $ext = $upload_ext;
  603. break;
  604. }
  605. }
  606. }
  607. $filename = "untitled.{$ext}";
  608. }
  609. return $filename;
  610. }
  611. }