var $fileurl = null;
var $short_fileurl = null;
var $mimetype = null;
- var $thumbnailRecord = null;
function __construct(Profile $scoped, $filename = null, $mimetype = null)
{
$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));
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()
@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($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));
- }
-
+ // Set file geometrical properties if available
try {
- $image = new ImageFile($this->fileRecord->id, $imgPath);
- } catch (UnsupportedMediaException $e) {
- // Avoid deleting the original
- if ($image->getPath() != $this->getPath()) {
+ $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();
}
- throw $e;
+ } 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->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);
+ return $file;
}
function rememberFile($file, $short)
{
$file_redir = File_redirection::getKV('url', $url);
- if (empty($file_redir)) {
-
+ 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', 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']);
$mimetype = self::getUploadedMimeType($_FILES[$param]['tmp_name'],
- $_FILES[$param]['name']);
+ $_FILES[$param]['name']);
$basename = basename($_FILES[$param]['name']);
$filename = File::filename($scoped, $basename, $mimetype);