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();
- }
+ $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));
if (!$file_id) {
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;
+ }
+ try {
+ $image = new ImageFile($this->fileRecord->id,
+ File::path($this->filename));
+ } catch (Exception $e) {
+ // Unsupported image type.
+ return null;
+ }
+
+ $outname = File::filename($this->scoped, '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);
+ }
+
function rememberFile($file, $short)
{
$this->maybeAddRedir($file->id, $short);
function maybeAddRedir($file_id, $url)
{
- $file_redir = File_redirection::staticGet('url', $url);
+ $file_redir = File_redirection::getKV('url', $url);
if (empty($file_redir)) {
if (!$result) {
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)
{
- if (empty($user)) {
- $user = common_current_user();
+ if (is_null($scoped)) {
+ $scoped = Profile::current();
}
if (!isset($_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(
+ // 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;
// 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['attach']['size'])) {
-
- // Should never actually get here
-
- @unlink($_FILES[$param]['tmp_name']);
- throw new ClientException(_('File exceeds user\'s quota.'));
- return;
- }
+ // Throws exception if additional size does not respect quota
+ File::respectsQuota($scoped, $_FILES[$param]['size']);
$mimetype = MediaFile::getUploadedFileType($_FILES[$param]['tmp_name'],
$_FILES[$param]['name']);
- $filename = null;
-
- if (isset($mimetype)) {
+ $basename = basename($_FILES[$param]['name']);
+ $filename = File::filename($scoped, $basename, $mimetype);
+ $filepath = File::path($filename);
- $basename = basename($_FILES[$param]['name']);
- $filename = File::filename($user->getProfile(), $basename, $mimetype);
- $filepath = File::path($filename);
+ $result = move_uploaded_file($_FILES[$param]['tmp_name'], $filepath);
- $result = move_uploaded_file($_FILES[$param]['tmp_name'], $filepath);
-
- if (!$result) {
- throw new ClientException(_('File could not be moved to destination directory.'));
- return;
- }
-
- } else {
- 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']))) {
+ File::respectsQuota($scoped, filesize($stream['uri']));
- // Should never actually get here
+ $mimetype = MediaFile::getUploadedFileType($stream['uri']);
- throw new ClientException(_('File exceeds user\'s quota.'));
- return;
- }
-
- $mimetype = MediaFile::getUploadedFileType($fh);
-
- $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) {
- throw new ClientException(_('File could not be moved to destination directory.' .
- $stream['uri'] . ' ' . $filepath));
- }
- } else {
- 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);
}
/**
* @throws ClientException if type is known, but not supported for local uploads
*/
static function getUploadedFileType($f, $originalFilename=false) {
+ global $_PEAR;
+
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 = &$_PEAR->getStaticProperty('MIME_Type', 'fileCmd');
$cmd = common_config('attachments', 'filecommand');
$filetype = null;
// 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
-
- $stream = stream_get_meta_data($f);
- $filetype = MIME_Type::autoDetect($stream['uri']);
- }
+ // We only accept filenames to existing files
+ $filetype = MIME_Type::autoDetect($f);
// The content-based sources for MIME_Type::autoDetect()
// are wildly unreliable for office-type documents. If we've
// we'll try detecting a type from its extension...
$unclearTypes = array('application/octet-stream',
'application/vnd.ms-office',
- 'application/zip');
+ 'application/zip',
+ // TODO: for XML we could do better content-based sniffing too
+ 'text/xml');
if ($originalFilename && (!$filetype || in_array($filetype, $unclearTypes))) {
$type = $mte->getMIMEType($originalFilename);
}
}
if ($supported === true || in_array($filetype, $supported)) {
+ // Restore PEAR error handlers for our DB code...
+ $_PEAR->staticPopErrorHandling();
return $filetype;
}
$media = MIME_Type::getMedia($filetype);
if ('application' !== $media) {
- $hint = sprintf(_(' Try using another %s format.'), $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);
} else {
- $hint = '';
+ // 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);
}
- throw new ClientException(sprintf(
- _('%s is not a supported file type on this server.'), $filetype) . $hint);
+ // 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);
- }
- }
-
}