Implement media upload in the API

This commit is contained in:
Zach Copley 2009-10-27 21:45:56 -07:00
parent 93a6e83d5d
commit 2d0aba49d9
2 changed files with 106 additions and 72 deletions

View File

@ -38,6 +38,7 @@ if (!defined('STATUSNET')) {
} }
require_once INSTALLDIR . '/lib/apiauth.php'; require_once INSTALLDIR . '/lib/apiauth.php';
require_once INSTALLDIR . '/lib/mediafile.php';
/** /**
* Updates the authenticating user's status (posts a notice). * Updates the authenticating user's status (posts a notice).
@ -60,7 +61,6 @@ class ApiStatusesUpdateAction extends ApiAuthAction
var $source = null; var $source = null;
var $status = null; var $status = null;
var $in_reply_to_status_id = null; var $in_reply_to_status_id = null;
static $reserved_sources = array('web', 'omb', 'mail', 'xmpp', 'api'); static $reserved_sources = array('web', 'omb', 'mail', 'xmpp', 'api');
/** /**
@ -76,25 +76,8 @@ class ApiStatusesUpdateAction extends ApiAuthAction
{ {
parent::prepare($args); parent::prepare($args);
$this->user = $this->auth_user; $this->user = $this->auth_user;
if (empty($this->user)) {
$this->clientError(_('No such user!'), 404, $this->format);
return false;
}
$this->status = $this->trimmed('status'); $this->status = $this->trimmed('status');
if (empty($this->status)) {
$this->clientError(
'Client must provide a \'status\' parameter with a value.',
400,
$this->format
);
return false;
}
$this->source = $this->trimmed('source'); $this->source = $this->trimmed('source');
if (empty($this->source) || in_array($source, $this->reserved_sources)) { if (empty($this->source) || in_array($source, $this->reserved_sources)) {
@ -129,6 +112,27 @@ class ApiStatusesUpdateAction extends ApiAuthAction
return; return;
} }
if (empty($_POST) && $_SERVER['CONTENT_LENGTH']) {
$this->clientError(sprintf(_('The server was unable to handle ' .
'that much POST data (%s bytes) due to its current configuration.'),
$_SERVER['CONTENT_LENGTH']));
return;
}
if (empty($this->user)) {
$this->clientError(_('No such user!'), 404, $this->format);
return;
}
if (empty($this->status)) {
$this->clientError(
'Client must provide a \'status\' parameter with a value.',
400,
$this->format
);
return;
}
$status_shortened = common_shorten_links($this->status); $status_shortened = common_shorten_links($this->status);
if (Notice::contentTooLong($status_shortened)) { if (Notice::contentTooLong($status_shortened)) {
@ -187,14 +191,42 @@ class ApiStatusesUpdateAction extends ApiAuthAction
} }
} }
$upload = null;
common_debug('looking for attachment');
$upload = MediaFile::fromUpload('media', $this->user);
common_debug("uploaded file = " . var_export($upload, true));
if (isset($upload)) {
common_debug('newNotice: found an upload');
$status_shortened .= ' ' . $upload->shortUrl();
common_debug('content w/upload = ' . $status_shortened);
if (Notice::contentTooLong($status_shortened)) {
$upload->delete();
$this->clientError(sprintf(_('Max notice size is %d chars, including attachment URL.'),
Notice::maxContent()));
} else {
common_debug('content not too long');
}
}
$this->notice = Notice::saveNew( $this->notice = Notice::saveNew(
$this->user->id, $this->user->id,
html_entity_decode($this->status, ENT_NOQUOTES, 'UTF-8'), html_entity_decode($status_shortened, ENT_NOQUOTES, 'UTF-8'),
$this->source, $this->source,
1, 1,
$reply_to $reply_to
); );
if (isset($upload)) {
$upload->attachToNotice($this->notice);
}
common_broadcast_notice($this->notice); common_broadcast_notice($this->notice);
} }

View File

@ -31,9 +31,9 @@ if (!defined('STATUSNET') && !defined('LACONICA')) {
exit(1); exit(1);
} }
class MediaFile class MediaFile
{ {
var $filename = null; var $filename = null;
var $fileRecord = null; var $fileRecord = null;
var $user = null; var $user = null;
@ -46,16 +46,16 @@ class MediaFile
if ($user == null) { if ($user == null) {
$this->user = common_current_user(); $this->user = common_current_user();
} }
common_debug('in MediaFile constructor'); common_debug('in MediaFile constructor');
$this->filename = $filename; $this->filename = $filename;
$this->mimetype = $mimetype; $this->mimetype = $mimetype;
common_debug('storing file'); common_debug('storing file');
$this->fileRecord = $this->storeFile(); $this->fileRecord = $this->storeFile();
common_debug('finished storing file'); common_debug('finished storing file');
$this->fileurl = common_local_url('attachment', $this->fileurl = common_local_url('attachment',
array('attachment' => $this->fileRecord->id)); array('attachment' => $this->fileRecord->id));
@ -67,24 +67,24 @@ class MediaFile
common_debug('shortening file url'); common_debug('shortening file url');
$this->short_fileurl = common_shorten_url($this->fileurl); $this->short_fileurl = common_shorten_url($this->fileurl);
common_debug('shortened file url = ' . $short_fileurl); common_debug('shortened file url = ' . $short_fileurl);
// Also, not sure this is necessary -- Zach // Also, not sure this is necessary -- Zach
$this->maybeAddRedir($this->fileRecord->id, $this->short_fileurl); $this->maybeAddRedir($this->fileRecord->id, $this->short_fileurl);
common_debug("MediaFile: end of constructor"); common_debug("MediaFile: end of constructor");
} }
function attachToNotice($notice) function attachToNotice($notice)
{ {
common_debug('MediaFile::attachToNotice() -- doing File_to_post'); common_debug('MediaFile::attachToNotice() -- doing File_to_post');
File_to_post::processNew($this->fileRecord->id, $notice->id); File_to_post::processNew($this->fileRecord->id, $notice->id);
common_debug('MediaFile done doing File_to_post'); common_debug('MediaFile done doing File_to_post');
$this->maybeAddRedir($this->fileRecord->id, $this->maybeAddRedir($this->fileRecord->id,
common_local_url('file', array('notice' => $notice->id))); common_local_url('file', array('notice' => $notice->id)));
} }
function shortUrl() function shortUrl()
{ {
return $this->short_fileurl; return $this->short_fileurl;
} }
@ -115,12 +115,12 @@ class MediaFile
$file_id = $file->insert(); $file_id = $file->insert();
if (!$file_id) { if (!$file_id) {
common_debug("storeFile: problem inserting new file"); common_debug("storeFile: problem inserting new file");
common_log_db_error($file, "INSERT", __FILE__); common_log_db_error($file, "INSERT", __FILE__);
throw new ClientException(_('There was a database error while saving your file. Please try again.')); throw new ClientException(_('There was a database error while saving your file. Please try again.'));
} }
common_debug('finished storing file'); common_debug('finished storing file');
return $file; return $file;
@ -133,15 +133,15 @@ class MediaFile
function maybeAddRedir($file_id, $url) function maybeAddRedir($file_id, $url)
{ {
common_debug("maybeAddRedir: looking up url: $url for file id $file_id"); common_debug("maybeAddRedir: looking up url: $url for file id $file_id");
$file_redir = File_redirection::staticGet('url', $url); $file_redir = File_redirection::staticGet('url', $url);
if (empty($file_redir)) { if (empty($file_redir)) {
common_debug("maybeAddRedir: $url is not in the db"); common_debug("maybeAddRedir: $url is not in the db");
$file_redir = new File_redirection; $file_redir = new File_redirection;
$file_redir->url = $url; $file_redir->url = $url;
$file_redir->file_id = $file_id; $file_redir->file_id = $file_id;
@ -153,20 +153,24 @@ class MediaFile
throw new ClientException(_('There was a database error while saving your file. Please try again.')); throw new ClientException(_('There was a database error while saving your file. Please try again.'));
} }
} else { } else {
common_debug("maybeAddRedir: no need to add $url, it's already in the db"); common_debug("maybeAddRedir: no need to add $url, it's already in the db");
} }
} }
static function fromUpload($param = 'media') static function fromUpload($param = 'media', $user = null)
{ {
common_debug("fromUpload: param = $param"); common_debug("fromUpload: param = $param");
if (empty($user)) {
$user = common_current_user();
}
if (!isset($_FILES[$param]['error'])){ if (!isset($_FILES[$param]['error'])){
common_debug('no file found'); common_debug('no file found');
return; return;
} }
switch ($_FILES[$param]['error']) { switch ($_FILES[$param]['error']) {
case UPLOAD_ERR_OK: // success, jump out case UPLOAD_ERR_OK: // success, jump out
break; break;
@ -183,7 +187,7 @@ class MediaFile
@unlink($_FILES[$param]['tmp_name']); @unlink($_FILES[$param]['tmp_name']);
throw new ClientException(_('The uploaded file was only' . throw new ClientException(_('The uploaded file was only' .
' partially uploaded.')); ' partially uploaded.'));
return; return;
case UPLOAD_ERR_NO_TMP_DIR: case UPLOAD_ERR_NO_TMP_DIR:
throw new ClientException(_('Missing a temporary folder.')); throw new ClientException(_('Missing a temporary folder.'));
return; return;
@ -197,24 +201,22 @@ class MediaFile
throw new ClientException(_('System error uploading file.')); throw new ClientException(_('System error uploading file.'));
return; return;
} }
$user = common_current_user();
if (!MediaFile::respectsQuota($user, $_FILES['attach']['size'])) { if (!MediaFile::respectsQuota($user, $_FILES['attach']['size'])) {
// Should never actually get here // Should never actually get here
@unlink($_FILES[$param]['tmp_name']); @unlink($_FILES[$param]['tmp_name']);
throw new ClientException(_('File exceeds user\'s quota!')); throw new ClientException(_('File exceeds user\'s quota!'));
return; return;
} }
$mimetype = MediaFile::getUploadedFileType($_FILES[$param]['tmp_name']); $mimetype = MediaFile::getUploadedFileType($_FILES[$param]['tmp_name']);
$filename = null; $filename = null;
if (isset($mimetype)) { if (isset($mimetype)) {
$basename = basename($_FILES[$param]['name']); $basename = basename($_FILES[$param]['name']);
$filename = File::filename($user->getProfile(), $basename, $mimetype); $filename = File::filename($user->getProfile(), $basename, $mimetype);
$filepath = File::path($filename); $filepath = File::path($filename);
@ -222,44 +224,44 @@ class MediaFile
common_debug("filepath = " . $filepath); common_debug("filepath = " . $filepath);
$result = move_uploaded_file($_FILES[$param]['tmp_name'], $filepath); $result = move_uploaded_file($_FILES[$param]['tmp_name'], $filepath);
if (!$result) { if (!$result) {
throw new ClientException(_('File could not be moved to destination directory.')); throw new ClientException(_('File could not be moved to destination directory.'));
return; return;
} }
} else { } else {
throw new ClientException(_('Could not determine file\'s mime-type!')); throw new ClientException(_('Could not determine file\'s mime-type!'));
return; return;
} }
return new MediaFile($user, $filename, $mimetype); return new MediaFile($user, $filename, $mimetype);
} }
static function fromFilehandle($user, $fh) { static function fromFilehandle($fh, $user) {
$stream = stream_get_meta_data($fh); $stream = stream_get_meta_data($fh);
if (MediaFile::respectsQuota($user, filesize($stream['uri']))) { if (MediaFile::respectsQuota($user, filesize($stream['uri']))) {
// Should never actually get here // Should never actually get here
throw new ClientException(_('File exceeds user\'s quota!')); throw new ClientException(_('File exceeds user\'s quota!'));
return; return;
} }
$mimetype = MediaFile::getUploadedFileType($fh); $mimetype = MediaFile::getUploadedFileType($fh);
$filename = null; $filename = null;
if (isset($mimetype)) { if (isset($mimetype)) {
$filename = File::filename($user->getProfile(), "email", $mimetype); $filename = File::filename($user->getProfile(), "email", $mimetype);
$filepath = File::path($filename); $filepath = File::path($filename);
$result = copy($stream['uri'], $filepath) && chmod($filepath, 0664); $result = copy($stream['uri'], $filepath) && chmod($filepath, 0664);
if (!$result) { if (!$result) {
throw new ClientException(_('File could not be moved to destination directory.' . throw new ClientException(_('File could not be moved to destination directory.' .
$stream['uri'] . ' ' . $filepath)); $stream['uri'] . ' ' . $filepath));
@ -268,33 +270,33 @@ class MediaFile
throw new ClientException(_('Could not determine file\'s mime-type!')); throw new ClientException(_('Could not determine file\'s mime-type!'));
return; return;
} }
return new MediaFile($user, $filename, $mimetype); return new MediaFile($user, $filename, $mimetype);
} }
static function getUploadedFileType($f) { static function getUploadedFileType($f) {
require_once 'MIME/Type.php'; require_once 'MIME/Type.php';
common_debug("in getUploadedFileType"); common_debug("in getUploadedFileType");
$cmd = &PEAR::getStaticProperty('MIME_Type', 'fileCmd'); $cmd = &PEAR::getStaticProperty('MIME_Type', 'fileCmd');
$cmd = common_config('attachments', 'filecommand'); $cmd = common_config('attachments', 'filecommand');
$filetype = null; $filetype = null;
if (is_string($f)) { if (is_string($f)) {
// assuming a filename // assuming a filename
$filetype = MIME_Type::autoDetect($f); $filetype = MIME_Type::autoDetect($f);
} else { } else {
// assuming a filehandle // assuming a filehandle
$stream = stream_get_meta_data($f); $stream = stream_get_meta_data($f);
$filetype = MIME_Type::autoDetect($stream['uri']); $filetype = MIME_Type::autoDetect($stream['uri']);
} }
if (in_array($filetype, common_config('attachments', 'supported'))) { if (in_array($filetype, common_config('attachments', 'supported'))) {
return $filetype; return $filetype;
} }
@ -308,7 +310,7 @@ class MediaFile
_('%s is not a supported filetype on this server.'), $filetype) . $hint); _('%s is not a supported filetype on this server.'), $filetype) . $hint);
} }
static function respectsQuota($user, $filesize) static function respectsQuota($user, $filesize)
{ {
$file = new File; $file = new File;
$result = $file->isRespectsQuota($user, $filesize); $result = $file->isRespectsQuota($user, $filesize);