* @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;
+ var $thumbnailRecord = 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();
+ try {
+ $this->thumbnailRecord = $this->storeThumbnail();
+ } catch (UnsupportedMediaException $e) {
+ // FIXME: Add "unknown media" icon or something
+ $this->thumbnailRecord = null;
+ }
$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()
{
return $this->short_fileurl;
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($maxWidth=null, $maxHeight=null, $square=true)
+ {
+ $imgPath = null;
+ $media = common_get_mime_media($this->mimetype);
+
+ if (Event::handle('CreateFileImageThumbnailSource', array($this, &$imgPath, $media))) {
+ switch ($media) {
+ case 'image':
+ $imgPath = $this->getPath();
+ break;
+ default:
+ throw new UnsupportedMediaException(_('Unsupported media format.'), $this->getPath());
+ }
+ }
+ if (!file_exists($imgPath)) {
+ throw new ServerException(sprintf('Thumbnail source is not stored locally: %s', $imgPath));
+ }
+
+ try {
+ $image = new ImageFile($this->fileRecord->id, $imgPath);
+ } catch (UnsupportedMediaException $e) {
+ // Avoid deleting the original
+ if ($image->getPath() != $this->getPath()) {
+ $image->unlink();
+ }
+ throw $e;
+ }
+
+ $outname = File::filename($this->scoped, 'thumb-' . $this->filename, $this->mimetype);
+ $outpath = File::path($outname);
+
+ $maxWidth = $maxWidth ?: common_config('attachments', 'thumb_width');
+ $maxHeight = $maxHeight ?: common_config('attachments', 'thumb_height');
+ list($width, $height, $x, $y, $w2, $h2) =
+ $this->scaleToFit($image->width, $image->height,
+ $maxWidth, $maxHeight,
+ common_config('attachments', 'thumb_square'));
+
+ $image->resizeTo($outpath, $width, $height, $x, $y, $w2, $h2);
+
+ // Avoid deleting the original
+ if ($image->getPath() != $this->getPath()) {
+ $image->unlink();
+ }
+ return File_thumbnail::saveThumbnail($this->fileRecord->id,
+ File::url($outname),
+ $width,
+ $height);
+ }
+
+ // This will give parameters to scale up if max values are larger than original
+ function scaleToFit($width, $height, $maxWidth=null, $maxHeight=null, $square=true)
+ {
+ if ($width <= 0 || $height <= 0
+ || ($maxWidth !== null && $maxWidth <= 0)
+ || ($maxHeight !== null && $maxHeight <= 0)) {
+ throw new ServerException('Bad scaleToFit parameters for MediaFile');
+ } elseif ($maxWidth === null) {
+ // maxWidth must be a positive number
+ throw new ServerException('MediaFile::scaleToFit maxWidth is null');
+ } elseif ($square || $maxHeight === null) {
+ // if square thumb ratio or if maxHeight is null,
+ // we set maxHeight to equal maxWidth
+ $maxHeight = $maxWidth;
+ $square = true;
+ }
+
+ // cropping data
+ $cx = 0; // crop x
+ $cy = 0; // crop y
+ $cw = null; // crop area width
+ $ch = null; // crop area height
+
+ if ($square) {
+ // resulting width and height
+ $rw = $maxWidth;
+ $rh = $maxHeight;
+
+ // minSide will determine the smallest image size
+ // and crop-values are determined from this
+ $minSide = $width > $height ? $height : $width;
+ $cx = $width / 2 - $minSide / 2;
+ $cy = $height / 2 - $minSide / 2;
+ $cw = $minSide;
+ $ch = $minSide;
+ } else {
+ // resulting sizes
+ $rw = $maxWidth;
+ $rh = floor($height * $maxWidth / $width);
+
+ if ($rh > $maxHeight) {
+ $rw = floor($width * $maxHeight / $height);
+ $rh = $maxHeight;
+ }
+ }
+ return array($rw, $rh, $cx, $cy, $cw, $ch);
+ }
+
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;
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']);
- 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'],
+ $mimetype = self::getUploadedMimeType($_FILES[$param]['tmp_name'],
$_FILES[$param]['name']);
- $filename = null;
+ $basename = basename($_FILES[$param]['name']);
+ $filename = File::filename($scoped, $basename, $mimetype);
+ $filepath = File::path($filename);
- if (isset($mimetype)) {
+ $result = move_uploaded_file($_FILES[$param]['tmp_name'], $filepath);
- $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);
-
- 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']))) {
-
- // Should never actually get here
-
- 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) {
- 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);
}
/**
* 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';
- $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)) {
+ static function getUploadedMimeType($filepath, $originalFilename=false) {
+ // We only accept filenames to existing files
+ $mimelookup = new finfo(FILEINFO_MIME_TYPE);
+ $mimetype = $mimelookup->file($filepath);
- // assuming a filename
-
- $filetype = MIME_Type::autoDetect($f);
-
- } else {
-
- // assuming a filehandle
-
- $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)) {
- return $filetype;
- }
- $media = MIME_Type::getMedia($filetype);
- if ('application' !== $media) {
- $hint = sprintf(_(' Try using another %s format.'), $media);
- } else {
- $hint = '';
+
+ // 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;
}
- throw new ClientException(sprintf(
- _('%s is not a supported file type on this server.'), $filetype) . $hint);
- }
- static function respectsQuota($user, $filesize)
- {
- $file = new File;
- $result = $file->isRespectsQuota($user, $filesize);
- if ($result === true) {
- return true;
+ // 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.'), $mimetype, $media);
} else {
- throw new ClientException($result);
+ // 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.'), $mimetype);
}
+ throw new ClientException($hint);
}
-
}
projects / quix0rs-gnu-social.git / blobdiff