<?php
/**
- * Laconica, the distributed open-source microblogging tool
+ * StatusNet, the distributed open-source microblogging tool
*
* Upload an avatar
*
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* @category Settings
- * @package Laconica
- * @author Evan Prodromou <evan@controlyourself.ca>
- * @author Zach Copley <zach@controlyourself.ca>
- * @copyright 2008-2009 Control Yourself, Inc.
+ * @package StatusNet
+ * @author Evan Prodromou <evan@status.net>
+ * @author Zach Copley <zach@status.net>
+ * @copyright 2008-2009 StatusNet, Inc.
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
- * @link http://laconi.ca/
+ * @link http://status.net/
*/
-if (!defined('LACONICA')) {
+if (!defined('STATUSNET') && !defined('LACONICA')) {
exit(1);
}
require_once INSTALLDIR.'/lib/accountsettingsaction.php';
+define('MAX_ORIGINAL', 480);
+
/**
* Upload an avatar
*
* We use jCrop plugin for jQuery to crop the image after upload.
*
* @category Settings
- * @package Laconica
- * @author Evan Prodromou <evan@controlyourself.ca>
- * @author Zach Copley <zach@controlyourself.ca>
- * @author Sarven Capadisli <csarven@controlyourself.ca>
+ * @package StatusNet
+ * @author Evan Prodromou <evan@status.net>
+ * @author Zach Copley <zach@status.net>
+ * @author Sarven Capadisli <csarven@status.net>
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
- * @link http://laconi.ca/
+ * @link http://status.net/
*/
-
class AvatarsettingsAction extends AccountSettingsAction
{
+ var $mode = null;
+ var $imagefile = null;
+ var $filename = null;
+
/**
* Title of the page
*
* @return string Title of the page
*/
-
function title()
{
+ // TRANS: Title for avatar upload page.
return _('Avatar');
}
*
* @return instructions for use
*/
-
function getInstructions()
{
- return _('Set your personal avatar.');
+ // TRANS: Instruction for avatar upload page.
+ // TRANS: %s is the maximum file size, for example "500b", "10kB" or "2MB".
+ return sprintf(_('You can upload your personal avatar. The maximum file size is %s.'),
+ ImageFile::maxFileSize());
}
/**
*/
function showContent()
+ {
+ if ($this->mode == 'crop') {
+ $this->showCropForm();
+ } else {
+ $this->showUploadForm();
+ }
+ }
+
+ function showUploadForm()
{
$user = common_current_user();
if (!$profile) {
common_log_db_error($user, 'SELECT', __FILE__);
- $this->serverError(_('User without matching profile'));
+ // TRANS: Server error displayed in avatar upload page when no matching profile can be found for a user.
+ $this->serverError(_('User without matching profile.'));
return;
}
'action' =>
common_local_url('avatarsettings')));
$this->elementStart('fieldset');
+ // TRANS: Avatar upload page form legend.
$this->element('legend', null, _('Avatar settings'));
$this->hidden('token', common_session_token());
- $this->elementStart('ul', 'form_data');
- if ($original) {
- $this->elementStart('li',
- array('id' => 'avatar_original',
- 'class' => 'avatar_view'));
- $this->element('h2', null, _("Original"));
- $this->elementStart('div', array('id'=>'avatar_original_view'));
- $this->element('img', array('src' => $original->url,
- 'width' => $original->width,
- 'height' => $original->height,
- 'alt' => $user->nickname));
- $this->elementEnd('div');
+ if (Event::handle('StartAvatarFormData', array($this))) {
+ $this->elementStart('ul', 'form_data');
+ if ($original) {
+ $this->elementStart('li', array('id' => 'avatar_original',
+ 'class' => 'avatar_view'));
+ // TRANS: Header on avatar upload page for thumbnail of originally uploaded avatar (h2).
+ $this->element('h2', null, _("Original"));
+ $this->elementStart('div', array('id'=>'avatar_original_view'));
+ $this->element('img', array('src' => $original->url,
+ 'width' => $original->width,
+ 'height' => $original->height,
+ 'alt' => $user->nickname));
+ $this->elementEnd('div');
+ $this->elementEnd('li');
+ }
+
+ $avatar = $profile->getAvatar(AVATAR_PROFILE_SIZE);
+
+ if ($avatar) {
+ $this->elementStart('li', array('id' => 'avatar_preview',
+ 'class' => 'avatar_view'));
+ // TRANS: Header on avatar upload page for thumbnail of to be used rendition of uploaded avatar (h2).
+ $this->element('h2', null, _("Preview"));
+ $this->elementStart('div', array('id'=>'avatar_preview_view'));
+ $this->element('img', array('src' => $original->url,
+ 'width' => AVATAR_PROFILE_SIZE,
+ 'height' => AVATAR_PROFILE_SIZE,
+ 'alt' => $user->nickname));
+ $this->elementEnd('div');
+ // TRANS: Button on avatar upload page to delete current avatar.
+ $this->submit('delete', _m('BUTTON','Delete'));
+ $this->elementEnd('li');
+ }
+
+ $this->elementStart('li', array ('id' => 'settings_attach'));
+ $this->element('input', array('name' => 'avatarfile',
+ 'type' => 'file',
+ 'id' => 'avatarfile'));
+ $this->element('input', array('name' => 'MAX_FILE_SIZE',
+ 'type' => 'hidden',
+ 'id' => 'MAX_FILE_SIZE',
+ 'value' => ImageFile::maxFileSizeInt()));
$this->elementEnd('li');
+ $this->elementEnd('ul');
+
+ $this->elementStart('ul', 'form_actions');
+ $this->elementStart('li');
+ // TRANS: Button on avatar upload page to upload an avatar.
+ $this->submit('upload', _m('BUTTON','Upload'));
+ $this->elementEnd('li');
+ $this->elementEnd('ul');
}
+ Event::handle('EndAvatarFormData', array($this));
- $avatar = $profile->getAvatar(AVATAR_PROFILE_SIZE);
+ $this->elementEnd('fieldset');
+ $this->elementEnd('form');
+ }
- if ($avatar) {
- $this->elementStart('li',
- array('id' => 'avatar_preview',
- 'class' => 'avatar_view'));
- $this->element('h2', null, _("Preview"));
- $this->elementStart('div', array('id'=>'avatar_preview_view'));
- $this->element('img', array('src' => $original->url,//$avatar->url,
- 'width' => AVATAR_PROFILE_SIZE,
- 'height' => AVATAR_PROFILE_SIZE,
- 'alt' => $user->nickname));
- $this->elementEnd('div');
-
- foreach (array('avatar_crop_x', 'avatar_crop_y',
- 'avatar_crop_w', 'avatar_crop_h') as $crop_info) {
- $this->element('input', array('name' => $crop_info,
- 'type' => 'hidden',
- 'id' => $crop_info));
- }
- $this->submit('crop', _('Crop'));
+ function showCropForm()
+ {
+ $user = common_current_user();
- $this->elementEnd('li');
+ $profile = $user->getProfile();
+
+ if (!$profile) {
+ common_log_db_error($user, 'SELECT', __FILE__);
+ // TRANS: Server error displayed in avatar upload page when no matching profile can be found for a user.
+ $this->serverError(_('User without matching profile.'));
+ return;
}
- $this->elementStart('li', array ('id' => 'settings_attach'));
- $this->element('input', array('name' => 'avatarfile',
- 'type' => 'file',
- 'id' => 'avatarfile'));
- $this->element('input', array('name' => 'MAX_FILE_SIZE',
- 'type' => 'hidden',
- 'id' => 'MAX_FILE_SIZE',
- 'value' => MAX_AVATAR_SIZE));
+ $original = $profile->getOriginalAvatar();
+
+ $this->elementStart('form', array('method' => 'post',
+ 'id' => 'form_settings_avatar',
+ 'class' => 'form_settings',
+ 'action' =>
+ common_local_url('avatarsettings')));
+ $this->elementStart('fieldset');
+ // TRANS: Avatar upload page crop form legend.
+ $this->element('legend', null, _('Avatar settings'));
+ $this->hidden('token', common_session_token());
+
+ $this->elementStart('ul', 'form_data');
+
+ $this->elementStart('li',
+ array('id' => 'avatar_original',
+ 'class' => 'avatar_view'));
+ // TRANS: Header on avatar upload crop form for thumbnail of originally uploaded avatar (h2).
+ $this->element('h2', null, _("Original"));
+ $this->elementStart('div', array('id'=>'avatar_original_view'));
+ $this->element('img', array('src' => Avatar::url($this->filedata['filename']),
+ 'width' => $this->filedata['width'],
+ 'height' => $this->filedata['height'],
+ 'alt' => $user->nickname));
+ $this->elementEnd('div');
$this->elementEnd('li');
- $this->elementEnd('ul');
- $this->elementStart('ul', 'form_actions');
- $this->elementStart('li');
- $this->submit('upload', _('Upload'));
+ $this->elementStart('li',
+ array('id' => 'avatar_preview',
+ 'class' => 'avatar_view'));
+ // TRANS: Header on avatar upload crop form for thumbnail of to be used rendition of uploaded avatar (h2).
+ $this->element('h2', null, _("Preview"));
+ $this->elementStart('div', array('id'=>'avatar_preview_view'));
+ $this->element('img', array('src' => Avatar::url($this->filedata['filename']),
+ 'width' => AVATAR_PROFILE_SIZE,
+ 'height' => AVATAR_PROFILE_SIZE,
+ 'alt' => $user->nickname));
+ $this->elementEnd('div');
+
+ foreach (array('avatar_crop_x', 'avatar_crop_y',
+ 'avatar_crop_w', 'avatar_crop_h') as $crop_info) {
+ $this->element('input', array('name' => $crop_info,
+ 'type' => 'hidden',
+ 'id' => $crop_info));
+ }
+
+ // TRANS: Button on avatar upload crop form to confirm a selected crop as avatar.
+ $this->submit('crop', _m('BUTTON','Crop'));
+
$this->elementEnd('li');
$this->elementEnd('ul');
-
$this->elementEnd('fieldset');
$this->elementEnd('form');
-
}
/**
*
* @return void
*/
-
function handlePost()
{
+ // Workaround for PHP returning empty $_POST and $_FILES when POST
+ // length > post_max_size in php.ini
+
+ if (empty($_FILES)
+ && empty($_POST)
+ && ($_SERVER['CONTENT_LENGTH'] > 0)
+ ) {
+ // TRANS: Client error displayed when the number of bytes in a POST request exceeds a limit.
+ // TRANS: %s is the number of bytes of the CONTENT_LENGTH.
+ $msg = _m('The server was unable to handle that much POST data (%s byte) due to its current configuration.',
+ 'The server was unable to handle that much POST data (%s bytes) due to its current configuration.',
+ intval($_SERVER['CONTENT_LENGTH']));
+ $this->showForm(sprintf($msg, $_SERVER['CONTENT_LENGTH']));
+ return;
+ }
+
// CSRF protection
$token = $this->trimmed('token');
if (!$token || $token != common_session_token()) {
- $this->show_form(_('There was a problem with your session token. '.
+ $this->showForm(_('There was a problem with your session token. '.
'Try again, please.'));
return;
}
- if ($this->arg('upload')) {
- $this->uploadAvatar();
- } else if ($this->arg('crop')) {
- $this->cropAvatar();
- } else {
- $this->showForm(_('Unexpected form submission.'));
+ if (Event::handle('StartAvatarSaveForm', array($this))) {
+ if ($this->arg('upload')) {
+ $this->uploadAvatar();
+ } else if ($this->arg('crop')) {
+ $this->cropAvatar();
+ } else if ($this->arg('delete')) {
+ $this->deleteAvatar();
+ } else {
+ // TRANS: Unexpected validation error on avatar upload form.
+ $this->showForm(_('Unexpected form submission.'));
+ }
+ Event::handle('EndAvatarSaveForm', array($this));
}
}
*
* @return void
*/
-
function uploadAvatar()
{
- switch ($_FILES['avatarfile']['error']) {
- case UPLOAD_ERR_OK: // success, jump out
- break;
- case UPLOAD_ERR_INI_SIZE:
- case UPLOAD_ERR_FORM_SIZE:
- $this->showForm(_('That file is too big.'));
+ try {
+ $imagefile = ImageFile::fromUpload('avatarfile');
+ } catch (Exception $e) {
+ $this->showForm($e->getMessage());
return;
- case UPLOAD_ERR_PARTIAL:
- @unlink($_FILES['avatarfile']['tmp_name']);
- $this->showForm(_('Partial upload.'));
- return;
- default:
- $this->showForm(_('System error uploading file.'));
+ }
+ if ($imagefile === null) {
+ // TRANS: Validation error on avatar upload form when no file was uploaded.
+ $this->showForm(_('No file uploaded.'));
return;
}
- $info = @getimagesize($_FILES['avatarfile']['tmp_name']);
+ $cur = common_current_user();
- if (!$info) {
- @unlink($_FILES['avatarfile']['tmp_name']);
- $this->showForm(_('Not an image or corrupt file.'));
- return;
- }
+ $filename = Avatar::filename($cur->id,
+ image_type_to_extension($imagefile->type),
+ null,
+ 'tmp'.common_timestamp());
- switch ($info[2]) {
- case IMAGETYPE_GIF:
- case IMAGETYPE_JPEG:
- case IMAGETYPE_PNG:
- break;
- default:
- $this->showForm(_('Unsupported image file format.'));
- return;
- }
+ $filepath = Avatar::path($filename);
- $user = common_current_user();
+ move_uploaded_file($imagefile->filepath, $filepath);
- $profile = $user->getProfile();
+ $filedata = array('filename' => $filename,
+ 'filepath' => $filepath,
+ 'width' => $imagefile->width,
+ 'height' => $imagefile->height,
+ 'type' => $imagefile->type);
- if ($profile->setOriginal($_FILES['avatarfile']['tmp_name'])) {
- $this->showForm(_('Avatar updated.'), true);
- } else {
- $this->showForm(_('Failed updating avatar.'));
- }
+ $_SESSION['FILEDATA'] = $filedata;
+
+ $this->filedata = $filedata;
+
+ $this->mode = 'crop';
- @unlink($_FILES['avatarfile']['tmp_name']);
+ // TRANS: Avatar upload form unstruction after uploading a file.
+ $this->showForm(_('Pick a square area of the image to be your avatar'),
+ true);
}
/**
*
* @return void
*/
-
function cropAvatar()
{
- $user = common_current_user();
+ $filedata = $_SESSION['FILEDATA'];
+
+ if (!$filedata) {
+ // TRANS: Server error displayed if an avatar upload went wrong somehow server side.
+ $this->serverError(_('Lost our file data.'));
+ return;
+ }
+
+ $file_d = ($filedata['width'] > $filedata['height'])
+ ? $filedata['height'] : $filedata['width'];
+ $dest_x = $this->arg('avatar_crop_x') ? $this->arg('avatar_crop_x'):0;
+ $dest_y = $this->arg('avatar_crop_y') ? $this->arg('avatar_crop_y'):0;
+ $dest_w = $this->arg('avatar_crop_w') ? $this->arg('avatar_crop_w'):$file_d;
+ $dest_h = $this->arg('avatar_crop_h') ? $this->arg('avatar_crop_h'):$file_d;
+ $size = min($dest_w, $dest_h, MAX_ORIGINAL);
+
+ $user = common_current_user();
$profile = $user->getProfile();
- $x = $this->arg('avatar_crop_x');
- $y = $this->arg('avatar_crop_y');
- $w = $this->arg('avatar_crop_w');
- $h = $this->arg('avatar_crop_h');
+ $imagefile = new ImageFile($user->id, $filedata['filepath']);
+ $filename = $imagefile->resize($size, $dest_x, $dest_y, $dest_w, $dest_h);
- if ($profile->crop_avatars($x, $y, $w, $h)) {
+ if ($profile->setOriginal($filename)) {
+ @unlink($filedata['filepath']);
+ unset($_SESSION['FILEDATA']);
+ $this->mode = 'upload';
+ // TRANS: Success message for having updated a user avatar.
$this->showForm(_('Avatar updated.'), true);
+ common_broadcast_profile($profile);
} else {
+ // TRANS: Error displayed on the avatar upload page if the avatar could not be updated for an unknown reason.
$this->showForm(_('Failed updating avatar.'));
}
}
+ /**
+ * Get rid of the current avatar.
+ *
+ * @return void
+ */
+ function deleteAvatar()
+ {
+ $user = common_current_user();
+ $profile = $user->getProfile();
+
+ $avatar = $profile->getOriginalAvatar();
+ if($avatar) $avatar->delete();
+ $avatar = $profile->getAvatar(AVATAR_PROFILE_SIZE);
+ if($avatar) $avatar->delete();
+ $avatar = $profile->getAvatar(AVATAR_STREAM_SIZE);
+ if($avatar) $avatar->delete();
+ $avatar = $profile->getAvatar(AVATAR_MINI_SIZE);
+ if($avatar) $avatar->delete();
+
+ // TRANS: Success message for deleting a user avatar.
+ $this->showForm(_('Avatar deleted.'), true);
+ }
+
/**
* Add the jCrop stylesheet
*
function showStylesheets()
{
parent::showStylesheets();
- $jcropStyle =
- common_path('theme/base/css/jquery.Jcrop.css?version='.LACONICA_VERSION);
-
- $this->element('link', array('rel' => 'stylesheet',
- 'type' => 'text/css',
- 'href' => $jcropStyle,
- 'media' => 'screen, projection, tv'));
+ $this->cssLink('css/jquery.Jcrop.css','base','screen, projection, tv');
}
/**
*
* @return void
*/
-
function showScripts()
{
parent::showScripts();
- $jcropPack = common_path('js/jcrop/jquery.Jcrop.pack.js');
- $jcropGo = common_path('js/jcrop/jquery.Jcrop.go.js');
+ if ($this->mode == 'crop') {
+ $this->script('jcrop/jquery.Jcrop.min.js');
+ $this->script('jcrop/jquery.Jcrop.go.js');
+ }
- $this->element('script', array('type' => 'text/javascript',
- 'src' => $jcropPack));
- $this->element('script', array('type' => 'text/javascript',
- 'src' => $jcropGo));
+ $this->autofocus('avatarfile');
}
}