* @link http://status.net/
*/
-if (!defined('STATUSNET') && !defined('LACONICA')) {
- exit(1);
-}
+if (!defined('GNUSOCIAL')) { exit(1); }
class MediaFile
{
+ protected $scoped = null;
var $filename = null;
var $fileRecord = null;
- var $user = null;
var $fileurl = null;
var $short_fileurl = null;
var $mimetype = null;
- function __construct($user = null, $filename = null, $mimetype = null)
+ function __construct(Profile $scoped, $filename = null, $mimetype = null)
{
- if ($user == null) {
- $this->user = common_current_user();
- } else {
- $this->user = $user;
- }
+ $this->scoped = $scoped;
$this->filename = $filename;
$this->mimetype = $mimetype;
$this->fileRecord = $this->storeFile();
- $this->thumbnailRecord = $this->storeThumbnail();
$this->fileurl = common_local_url('attachment',
array('attachment' => $this->fileRecord->id));
$this->maybeAddRedir($this->fileRecord->id, $this->short_fileurl);
}
- function attachToNotice($notice)
+ 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)));
+ }
+
+ public function getPath()
+ {
+ return File::path($this->filename);
}
function shortUrl()
@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()
+ {
$file = new File;
$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.'));
}
- return $file;
- }
-
- /**
- * Generate and store a thumbnail image for the uploaded file, if applicable.
- *
- * @return File_thumbnail or null
- */
- function storeThumbnail()
- {
- if (substr($this->mimetype, 0, strlen('image/')) != 'image/') {
- // @fixme video thumbs would be nice!
- return null;
- }
+ // Set file geometrical properties if available
try {
- $image = new ImageFile($this->fileRecord->id,
- File::path($this->filename));
- } catch (Exception $e) {
- // Unsupported image type.
- return null;
+ $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.
}
- $outname = File::filename($this->user->getProfile(), 'thumb-' . $this->filename, $this->mimetype);
- $outpath = File::path($outname);
-
- $maxWidth = common_config('attachments', 'thumb_width');
- $maxHeight = common_config('attachments', 'thumb_height');
- list($width, $height) = $this->scaleToFit($image->width, $image->height, $maxWidth, $maxHeight);
-
- $image->resizeTo($outpath, $width, $height);
- File_thumbnail::saveThumbnail($this->fileRecord->id,
- File::url($outname),
- $width,
- $height);
- }
-
- function scaleToFit($width, $height, $maxWidth, $maxHeight)
- {
- $aspect = $maxWidth / $maxHeight;
- $w1 = $maxWidth;
- $h1 = intval($height * $maxWidth / $width);
- if ($h1 > $maxHeight) {
- $w2 = intval($width * $maxHeight / $height);
- $h2 = $maxHeight;
- return array($w2, $h2);
- }
- return array($w1, $h1);
+ return $file;
}
function rememberFile($file, $short)
function maybeAddRedir($file_id, $url)
{
- $file_redir = File_redirection::staticGet('url', $url);
-
- if (empty($file_redir)) {
+ $file_redir = File_redirection::getKV('url', $url);
+ if (!$file_redir instanceof File_redirection) {
$file_redir = new File_redirection;
$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.'));
}
}
- static function fromUpload($param = 'media', $user = null)
+ static function fromUpload($param='media', Profile $scoped=null)
{
- if (empty($user)) {
- $user = common_current_user();
+ 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.'));
- return;
- 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.'));
- return;
- case UPLOAD_ERR_PARTIAL:
- @unlink($_FILES[$param]['tmp_name']);
- // TRANS: Client exception.
- throw new ClientException(_('The uploaded file was only' .
- ' partially uploaded.'));
- return;
- 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.'));
- return;
- 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.'));
- return;
- 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.'));
- return;
- 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.'));
- return;
- }
-
- if (!MediaFile::respectsQuota($user, $_FILES[$param]['size'])) {
-
- // Should never actually get here
-
- @unlink($_FILES[$param]['tmp_name']);
- // TRANS: Client exception thrown when a file upload operation would cause a user to exceed a set quota.
- throw new ClientException(_('File exceeds user\'s quota.'));
- return;
+ 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.'));
}
- $mimetype = MediaFile::getUploadedFileType($_FILES[$param]['tmp_name'],
- $_FILES[$param]['name']);
-
- $filename = null;
-
- if (isset($mimetype)) {
+ // Throws exception if additional size does not respect quota
+ File::respectsQuota($scoped, $_FILES[$param]['size']);
- $basename = basename($_FILES[$param]['name']);
- $filename = File::filename($user->getProfile(), $basename, $mimetype);
- $filepath = File::path($filename);
+ $mimetype = self::getUploadedMimeType($_FILES[$param]['tmp_name'],
+ $_FILES[$param]['name']);
- $result = move_uploaded_file($_FILES[$param]['tmp_name'], $filepath);
+ $basename = basename($_FILES[$param]['name']);
+ $filename = File::filename($scoped, $basename, $mimetype);
+ $filepath = File::path($filename);
- 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;
- }
+ $result = move_uploaded_file($_FILES[$param]['tmp_name'], $filepath);
- } else {
- // TRANS: Client exception thrown when a file upload operation has been stopped because the MIME
- // TRANS: type of the uploaded file could not be determined.
- throw new ClientException(_('Could not determine file\'s MIME type.'));
- return;
+ 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($user, $filename, $mimetype);
+ return new MediaFile($scoped, $filename, $mimetype);
}
- static function fromFilehandle($fh, $user) {
+ static function fromFilehandle($fh, Profile $scoped) {
$stream = stream_get_meta_data($fh);
- if (!MediaFile::respectsQuota($user, filesize($stream['uri']))) {
-
- // Should never actually get here
-
- // TRANS: Client exception thrown when a file upload operation would cause a user to exceed a set quota.
- throw new ClientException(_('File exceeds user\'s quota.'));
- return;
- }
+ File::respectsQuota($scoped, filesize($stream['uri']));
- $mimetype = MediaFile::getUploadedFileType($fh);
+ $mimetype = self::getUploadedMimeType($stream['uri']);
- $filename = null;
+ $filename = File::filename($scoped, "email", $mimetype);
- if (isset($mimetype)) {
+ $filepath = File::path($filename);
- $filename = File::filename($user->getProfile(), "email", $mimetype);
+ $result = copy($stream['uri'], $filepath) && chmod($filepath, 0664);
- $filepath = File::path($filename);
-
- $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));
- }
- } else {
- // TRANS: Client exception thrown when a file upload operation has been stopped because the MIME
- // TRANS: type of the uploaded file could not be determined.
- throw new ClientException(_('Could not determine file\'s MIME type.'));
- return;
+ 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));
}
- return new MediaFile($user, $filename, $mimetype);
+ return new MediaFile($scoped, $filename, $mimetype);
}
/**
* Attempt to identify the content type of a given file.
*
- * @param mixed $f file handle resource, or filesystem path as string
+ * @param string $filepath filesystem path as string (file must exist)
* @param string $originalFilename (optional) for extension-based detection
* @return string
*
- * @fixme is this an internal or public method? It's called from GetFileAction
* @fixme this seems to tie a front-end error message in, kinda confusing
- * @fixme this looks like it could return a PEAR_Error in some cases, if
- * type can't be identified and $config['attachments']['supported'] is true
*
* @throws ClientException if type is known, but not supported for local uploads
*/
- static function getUploadedFileType($f, $originalFilename=false) {
- require_once 'MIME/Type.php';
- require_once 'MIME/Type/Extension.php';
-
- // We have to disable auto handling of PEAR errors
- PEAR::staticPushErrorHandling(PEAR_ERROR_RETURN);
- $mte = new MIME_Type_Extension();
-
- $cmd = &PEAR::getStaticProperty('MIME_Type', 'fileCmd');
- $cmd = common_config('attachments', 'filecommand');
-
- $filetype = null;
-
- // If we couldn't get a clear type from the file extension,
- // we'll go ahead and try checking the content. Content checks
- // are unambiguous for most image files, but nearly useless
- // for office document formats.
-
- if (is_string($f)) {
-
- // assuming a filename
-
- $filetype = MIME_Type::autoDetect($f);
-
- } else {
-
- // assuming a filehandle
+ static function getUploadedMimeType($filepath, $originalFilename=false) {
+ // We only accept filenames to existing files
+ $mimelookup = new finfo(FILEINFO_MIME_TYPE);
+ $mimetype = $mimelookup->file($filepath);
- $stream = stream_get_meta_data($f);
- $filetype = MIME_Type::autoDetect($stream['uri']);
- }
-
- // The content-based sources for MIME_Type::autoDetect()
- // are wildly unreliable for office-type documents. If we've
- // gotten an unclear reponse back or just couldn't identify it,
- // we'll try detecting a type from its extension...
+ // Unclear types are such that we can't really tell by the auto
+ // detect what they are (.bin, .exe etc. are just "octet-stream")
$unclearTypes = array('application/octet-stream',
'application/vnd.ms-office',
- 'application/zip');
-
- if ($originalFilename && (!$filetype || in_array($filetype, $unclearTypes))) {
- $type = $mte->getMIMEType($originalFilename);
- if (is_string($type)) {
- $filetype = $type;
- }
- }
+ 'application/zip',
+ // TODO: for XML we could do better content-based sniffing too
+ 'text/xml');
$supported = common_config('attachments', 'supported');
- if (is_array($supported)) {
- // Normalize extensions to mime types
- foreach ($supported as $i => $entry) {
- if (strpos($entry, '/') === false) {
- common_log(LOG_INFO, "sample.$entry");
- $supported[$i] = $mte->getMIMEType("sample.$entry");
- }
+
+ // 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);
+ return $type;
+ } catch (Exception $e) {
+ // Extension not found, so $mimetype is our best guess
}
}
- if ($supported === true || in_array($filetype, $supported)) {
- // Restore PEAR error handlers for our DB code...
- PEAR::staticPopErrorHandling();
- return $filetype;
+
+ // If $config['attachments']['supported'] equals boolean true, accept any mimetype
+ if ($supported === true || array_key_exists($mimetype, $supported)) {
+ // FIXME: Don't know if it always has a mimetype here because
+ // finfo->file CAN return false on error: http://php.net/finfo_file
+ // so if $supported === true, this may return something unexpected.
+ return $mimetype;
}
- $media = MIME_Type::getMedia($filetype);
+
+ // We can conclude that we have failed to get the MIME type
+ $media = common_get_mime_media($mimetype);
if ('application' !== $media) {
// TRANS: Client exception thrown trying to upload a forbidden MIME type.
// TRANS: %1$s is the file type that was denied, %2$s is the application part of
// TRANS: the MIME type that was denied.
$hint = sprintf(_('"%1$s" is not a supported file type on this server. ' .
- 'Try using another %2$s format.'), $filetype, $media);
+ 'Try using another %2$s format.'), $mimetype, $media);
} else {
// TRANS: Client exception thrown trying to upload a forbidden MIME type.
// TRANS: %s is the file type that was denied.
- $hint = sprintf(_('"%s" is not a supported file type on this server.'), $filetype);
+ $hint = sprintf(_('"%s" is not a supported file type on this server.'), $mimetype);
}
- // Restore PEAR error handlers for our DB code...
- PEAR::staticPopErrorHandling();
throw new ClientException($hint);
}
-
- static function respectsQuota($user, $filesize)
- {
- $file = new File;
- $result = $file->isRespectsQuota($user, $filesize);
- if ($result === true) {
- return true;
- } else {
- throw new ClientException($result);
- }
- }
-
}
projects / quix0rs-gnu-social.git / blobdiff