X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=lib%2Fmediafile.php;h=803cbe0a4cd6cece1f9d1e83540138d8912ab2b8;hb=489099ca917d74ee2bdc406cb26f9e3269ade625;hp=e1a9d1247c9001f5b29d164317db5fffcd5ca830;hpb=d59eb5e184591953ace103522b2db4a00ecd7777;p=quix0rs-gnu-social.git diff --git a/lib/mediafile.php b/lib/mediafile.php index e1a9d1247c..803cbe0a4c 100644 --- a/lib/mediafile.php +++ b/lib/mediafile.php @@ -34,20 +34,17 @@ if (!defined('GNUSOCIAL')) { exit(1); } class MediaFile { - protected $scoped = null; - var $filename = null; var $fileRecord = null; var $fileurl = null; var $short_fileurl = null; var $mimetype = null; - function __construct(Profile $scoped, $filename = null, $mimetype = null) + function __construct($filename = null, $mimetype = null, $filehash = null) { - $this->scoped = $scoped; - $this->filename = $filename; $this->mimetype = $mimetype; + $this->filehash = $filehash; $this->fileRecord = $this->storeFile(); $this->fileurl = common_local_url('attachment', @@ -60,9 +57,7 @@ class MediaFile public function attachToNotice(Notice $notice) { - File_to_post::processNew($this->fileRecord->id, $notice->id); - $this->maybeAddRedir($this->fileRecord->id, - common_local_url('file', array('notice' => $notice->id))); + File_to_post::processNew($this->fileRecord, $notice); } public function getPath() @@ -75,31 +70,91 @@ class MediaFile return $this->short_fileurl; } + function getEnclosure() + { + return $this->getFile()->getEnclosure(); + } + function delete() { $filepath = File::path($this->filename); @unlink($filepath); } - function storeFile() { + public function getFile() + { + if (!$this->fileRecord instanceof File) { + throw new ServerException('File record did not exist for MediaFile'); + } + + return $this->fileRecord; + } + + protected function storeFile() + { + $filepath = File::path($this->filename); + if (!empty($this->filename) && $this->filehash === null) { + // Calculate if we have an older upload method somewhere (Qvitter) that + // doesn't do this before calling new MediaFile on its local files... + $this->filehash = hash_file(File::FILEHASH_ALG, $filepath); + if ($this->filehash === false) { + throw new ServerException('Could not read file for hashing'); + } + } + + try { + $file = File::getByHash($this->filehash); + // We're done here. Yes. Already. We assume sha256 won't collide on us anytime soon. + return $file; + } catch (NoResultException $e) { + // Well, let's just continue below. + } + + $fileurl = File::url($this->filename); $file = new File; $file->filename = $this->filename; - $file->url = File::url($this->filename); - $filepath = File::path($this->filename); + $file->urlhash = File::hashurl($fileurl); + $file->url = $fileurl; + $file->filehash = $this->filehash; $file->size = filesize($filepath); + if ($file->size === false) { + throw new ServerException('Could not read file to get its size'); + } $file->date = time(); $file->mimetype = $this->mimetype; + $file_id = $file->insert(); - if (!$file_id) { + if ($file_id===false) { common_log_db_error($file, "INSERT", __FILE__); // TRANS: Client exception thrown when a database error was thrown during a file upload operation. throw new ClientException(_('There was a database error while saving your file. Please try again.')); } + // Set file geometrical properties if available + try { + $image = ImageFile::fromFileObject($file); + $orig = clone($file); + $file->width = $image->width; + $file->height = $image->height; + $file->update($orig); + + // We have to cleanup after ImageFile, since it + // may have generated a temporary file from a + // video support plugin or something. + // FIXME: Do this more automagically. + if ($image->getPath() != $file->getPath()) { + $image->unlink(); + } + } catch (ServerException $e) { + // We just couldn't make out an image from the file. This + // does not have to be UnsupportedMediaException, as we can + // also get ServerException from files not existing etc. + } + return $file; } @@ -110,17 +165,17 @@ class MediaFile function maybeAddRedir($file_id, $url) { - $file_redir = File_redirection::getKV('url', $url); - - if (empty($file_redir)) { - + try { + $file_redir = File_redirection::getByUrl($url); + } catch (NoResultException $e) { $file_redir = new File_redirection; + $file_redir->urlhash = File::hashurl($url); $file_redir->url = $url; $file_redir->file_id = $file_id; $result = $file_redir->insert(); - if (!$result) { + if ($result===false) { common_log_db_error($file_redir, "INSERT", __FILE__); // TRANS: Client exception thrown when a database error was thrown during a file upload operation. throw new ClientException(_('There was a database error while saving your file. Please try again.')); @@ -128,95 +183,155 @@ class MediaFile } } - static function fromUpload($param = 'media', Profile $scoped) + static function fromUpload($param='media', Profile $scoped=null) { - if (is_null($scoped)) { - $scoped = Profile::current(); - } - - if (!isset($_FILES[$param]['error'])){ - return; + // The existence of the "error" element means PHP has processed it properly even if it was ok. + if (!isset($_FILES[$param]) || !isset($_FILES[$param]['error'])) { + throw new NoUploadedMediaException($param); } switch ($_FILES[$param]['error']) { - case UPLOAD_ERR_OK: // success, jump out - break; - case UPLOAD_ERR_INI_SIZE: - // TRANS: Client exception thrown when an uploaded file is larger than set in php.ini. - throw new ClientException(_('The uploaded file exceeds the ' . - 'upload_max_filesize directive in php.ini.')); - case UPLOAD_ERR_FORM_SIZE: - throw new ClientException( + case UPLOAD_ERR_OK: // success, jump out + break; + case UPLOAD_ERR_INI_SIZE: + // TRANS: Client exception thrown when an uploaded file is larger than set in php.ini. + throw new ClientException(_('The uploaded file exceeds the ' . + 'upload_max_filesize directive in php.ini.')); + case UPLOAD_ERR_FORM_SIZE: + throw new ClientException( + // TRANS: Client exception. + _('The uploaded file exceeds the MAX_FILE_SIZE directive' . + ' that was specified in the HTML form.')); + case UPLOAD_ERR_PARTIAL: + @unlink($_FILES[$param]['tmp_name']); // TRANS: Client exception. - _('The uploaded file exceeds the MAX_FILE_SIZE directive' . - ' that was specified in the HTML form.')); - case UPLOAD_ERR_PARTIAL: - @unlink($_FILES[$param]['tmp_name']); - // TRANS: Client exception. - throw new ClientException(_('The uploaded file was only' . - ' partially uploaded.')); - case UPLOAD_ERR_NO_FILE: - // No file; probably just a non-AJAX submission. - return; - case UPLOAD_ERR_NO_TMP_DIR: - // TRANS: Client exception thrown when a temporary folder is not present to store a file upload. - throw new ClientException(_('Missing a temporary folder.')); - case UPLOAD_ERR_CANT_WRITE: - // TRANS: Client exception thrown when writing to disk is not possible during a file upload operation. - throw new ClientException(_('Failed to write file to disk.')); - case UPLOAD_ERR_EXTENSION: - // TRANS: Client exception thrown when a file upload operation has been stopped by an extension. - throw new ClientException(_('File upload stopped by extension.')); - default: - common_log(LOG_ERR, __METHOD__ . ": Unknown upload error " . - $_FILES[$param]['error']); - // TRANS: Client exception thrown when a file upload operation has failed with an unknown reason. - throw new ClientException(_('System error uploading file.')); + throw new ClientException(_('The uploaded file was only' . + ' partially uploaded.')); + case UPLOAD_ERR_NO_FILE: + // No file; probably just a non-AJAX submission. + throw new NoUploadedMediaException($param); + case UPLOAD_ERR_NO_TMP_DIR: + // TRANS: Client exception thrown when a temporary folder is not present to store a file upload. + throw new ClientException(_('Missing a temporary folder.')); + case UPLOAD_ERR_CANT_WRITE: + // TRANS: Client exception thrown when writing to disk is not possible during a file upload operation. + throw new ClientException(_('Failed to write file to disk.')); + case UPLOAD_ERR_EXTENSION: + // TRANS: Client exception thrown when a file upload operation has been stopped by an extension. + throw new ClientException(_('File upload stopped by extension.')); + default: + common_log(LOG_ERR, __METHOD__ . ": Unknown upload error " . + $_FILES[$param]['error']); + // TRANS: Client exception thrown when a file upload operation has failed with an unknown reason. + throw new ClientException(_('System error uploading file.')); } - // Throws exception if additional size does not respect quota - File::respectsQuota($scoped, $_FILES[$param]['size']); + // TODO: Make documentation clearer that this won't work for files >2GiB because + // PHP is stupid in its 32bit head. But noone accepts 2GiB files with PHP + // anyway... I hope. + $filehash = hash_file(File::FILEHASH_ALG, $_FILES[$param]['tmp_name']); + + try { + $file = File::getByHash($filehash); + // If no exception is thrown the file exists locally, so we'll use that and just add redirections. + // but if the _actual_ locally stored file doesn't exist, getPath will throw FileNotFoundException + $filename = basename($file->getPath()); + $mimetype = $file->mimetype; + + } catch (FileNotFoundException $e) { + // The file does not exist in our local filesystem, so store this upload. + + if (!move_uploaded_file($_FILES[$param]['tmp_name'], $e->path)) { + // TRANS: Client exception thrown when a file upload operation fails because the file could + // TRANS: not be moved from the temporary folder to the permanent file location. + throw new ClientException(_('File could not be moved to destination directory.')); + } + + $filename = basename($file->getPath()); + $mimetype = $file->mimetype; + + } catch (NoResultException $e) { + // We have to save the upload as a new local file. This is the normal course of action. - $mimetype = self::getUploadedMimeType($_FILES[$param]['tmp_name'], - $_FILES[$param]['name']); + if ($scoped instanceof Profile) { + // Throws exception if additional size does not respect quota + // This test is only needed, of course, if we're uploading something new. + File::respectsQuota($scoped, $_FILES[$param]['size']); + } + + $mimetype = self::getUploadedMimeType($_FILES[$param]['tmp_name'], $_FILES[$param]['name']); + $basename = basename($_FILES[$param]['name']); - $basename = basename($_FILES[$param]['name']); - $filename = File::filename($scoped, $basename, $mimetype); - $filepath = File::path($filename); + $filename = strtolower($filehash) . '.' . File::guessMimeExtension($mimetype, $basename); + $filepath = File::path($filename); - $result = move_uploaded_file($_FILES[$param]['tmp_name'], $filepath); + $result = move_uploaded_file($_FILES[$param]['tmp_name'], $filepath); - if (!$result) { - // TRANS: Client exception thrown when a file upload operation fails because the file could - // TRANS: not be moved from the temporary folder to the permanent file location. - throw new ClientException(_('File could not be moved to destination directory.')); + if (!$result) { + // TRANS: Client exception thrown when a file upload operation fails because the file could + // TRANS: not be moved from the temporary folder to the permanent file location. + throw new ClientException(_('File could not be moved to destination directory.')); + } } - return new MediaFile($scoped, $filename, $mimetype); + return new MediaFile($filename, $mimetype, $filehash); } - static function fromFilehandle($fh, Profile $scoped) { - + static function fromFilehandle($fh, Profile $scoped=null) { $stream = stream_get_meta_data($fh); + // So far we're only handling filehandles originating from tmpfile(), + // so we can always do hash_file on $stream['uri'] as far as I can tell! + $filehash = hash_file(File::FILEHASH_ALG, $stream['uri']); + + try { + $file = File::getByHash($filehash); + // Already have it, so let's reuse the locally stored File + // by using getPath we also check whether the file exists + // and throw a FileNotFoundException with the path if it doesn't. + $filename = basename($file->getPath()); + $mimetype = $file->mimetype; + } catch (FileNotFoundException $e) { + // This happens if the file we have uploaded has disappeared + // from the local filesystem for some reason. Since we got the + // File object from a sha256 check in fromFilehandle, it's safe + // to just copy the uploaded data to disk! + + fseek($fh, 0); // just to be sure, go to the beginning + // dump the contents of our filehandle to the path from our exception + // and report error if it failed. + if (false === file_put_contents($e->path, fread($fh, filesize($stream['uri'])))) { + // TRANS: Client exception thrown when a file upload operation fails because the file could + // TRANS: not be moved from the temporary folder to the permanent file location. + throw new ClientException(_('File could not be moved to destination directory.')); + } + if (!chmod($e->path, 0664)) { + common_log(LOG_ERR, 'Could not chmod uploaded file: '._ve($e->path)); + } - File::respectsQuota($scoped, filesize($stream['uri'])); + $filename = basename($file->getPath()); + $mimetype = $file->mimetype; - $mimetype = self::getUploadedMimeType($stream['uri']); + } catch (NoResultException $e) { + if ($scoped instanceof Profile) { + File::respectsQuota($scoped, filesize($stream['uri'])); + } - $filename = File::filename($scoped, "email", $mimetype); + $mimetype = self::getUploadedMimeType($stream['uri']); - $filepath = File::path($filename); + $filename = strtolower($filehash) . '.' . File::guessMimeExtension($mimetype); + $filepath = File::path($filename); - $result = copy($stream['uri'], $filepath) && chmod($filepath, 0664); + $result = copy($stream['uri'], $filepath) && chmod($filepath, 0664); - if (!$result) { - // TRANS: Client exception thrown when a file upload operation fails because the file could - // TRANS: not be moved from the temporary folder to the permanent file location. - throw new ClientException(_('File could not be moved to destination directory.' . - $stream['uri'] . ' ' . $filepath)); + if (!$result) { + common_log(LOG_ERR, 'File could not be moved (or chmodded) from '._ve($stream['uri']) . ' to ' . _ve($filepath)); + // TRANS: Client exception thrown when a file upload operation fails because the file could + // TRANS: not be moved from the temporary folder to the permanent file location. + throw new ClientException(_('File could not be moved to destination directory.' )); + } } - return new MediaFile($scoped, $filename, $mimetype); + return new MediaFile($filename, $mimetype, $filehash); } /** @@ -240,6 +355,8 @@ class MediaFile $unclearTypes = array('application/octet-stream', 'application/vnd.ms-office', 'application/zip', + 'text/plain', + 'text/html', // Ironically, Wikimedia Commons' SVG_logo.svg is identified as text/html // TODO: for XML we could do better content-based sniffing too 'text/xml'); @@ -248,10 +365,12 @@ class MediaFile // If we didn't match, or it is an unclear match if ($originalFilename && (!$mimetype || in_array($mimetype, $unclearTypes))) { try { - $type = common_supported_ext_to_mime($originalFilename); + $type = common_supported_filename_to_mime($originalFilename); return $type; + } catch (UnknownExtensionMimeException $e) { + // FIXME: I think we should keep the file extension here (supported should be === true here) } catch (Exception $e) { - // Extension not found, so $mimetype is our best guess + // Extension parsed but no connected mimetype, so $mimetype is our best guess } }