gnu-social/actions/avatarsettings.php

434 lines
15 KiB
PHP
Raw Normal View History

2009-01-16 22:29:13 +00:00
<?php
// This file is part of GNU social - https://www.gnu.org/software/social
//
// GNU social is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// GNU social is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with GNU social. If not, see <http://www.gnu.org/licenses/>.
2009-01-16 22:29:13 +00:00
/**
* Upload an avatar
*
* @category Settings
* @package GNUsocial
*
* @author Evan Prodromou <evan@status.net>
* @author Zach Copley <zach@status.net>
* @author Diogo Cordeiro <diogo@fc.up.pt>
* @copyright 2008-2009, 2020 Free Software Foundation http://fsf.org
2009-01-16 22:29:13 +00:00
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
*/
defined('GNUSOCIAL') || die;
2009-01-16 22:29:13 +00:00
/**
* Upload an avatar
*
2009-01-21 20:33:37 +00:00
* We use jCrop plugin for jQuery to crop the image after upload.
2009-01-16 22:29:13 +00:00
*
* @category Settings
* @package StatusNet
*
* @author Evan Prodromou <evan@status.net>
* @author Zach Copley <zach@status.net>
* @author Sarven Capadisli <csarven@status.net>
2009-01-16 22:29:13 +00:00
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
*
* @see http://status.net/
2009-01-16 22:29:13 +00:00
*/
class AvatarsettingsAction extends SettingsAction
2009-01-16 22:29:13 +00:00
{
public $mode;
public $imagefile;
public $filename;
public function prepare(array $args = [])
{
$avatarpath = Avatar::path('');
if (!is_writable($avatarpath)) {
throw new Exception(_m("The administrator of your site needs to
add write permissions on the avatar upload folder before
you're able to set one."));
}
parent::prepare($args);
return true;
}
2009-01-16 22:29:13 +00:00
/**
* Title of the page
*
* @return string Title of the page
* @throws Exception
*
2009-01-16 22:29:13 +00:00
*/
public function title()
2009-01-16 22:29:13 +00:00
{
// TRANS: Title for avatar upload page.
return _m('Avatar');
2009-01-16 22:29:13 +00:00
}
/**
* Instructions for use
*
* @return string instructions for use
* @throws Exception
*
2009-01-16 22:29:13 +00:00
*/
public function getInstructions()
2009-01-16 22:29:13 +00:00
{
// TRANS: Instruction for avatar upload page.
// TRANS: %s is the maximum file size, for example "500b", "10kB" or "2MB".
return sprintf(
_m('You can upload your personal avatar. The maximum file size is %s.'),
ImageFile::maxFileSize()
);
2009-01-16 22:29:13 +00:00
}
/**
* Content area of the page
*
* Shows a form for uploading an avatar. Currently overrides FormAction's showContent
* since we haven't made classes out of AvatarCropForm and AvatarUploadForm.
2009-01-16 22:29:13 +00:00
*
* @return void
*/
public function showContent()
{
if ($this->mode == 'crop') {
$this->showCropForm();
} else {
$this->showUploadForm();
}
}
public function showUploadForm()
2009-01-16 22:29:13 +00:00
{
// If we detect that the user didn't finish setting a new avatar, remove the temporary file.
if (isset($_SESSION['FILEDATA'])) {
@unlink($_SESSION['FILEDATA']['filepath']);
unset($_SESSION['FILEDATA']);
}
$this->elementStart('form', ['enctype' => 'multipart/form-data',
'method' => 'post',
'id' => 'form_settings_avatar',
'class' => 'form_settings',
'action' => common_local_url('avatarsettings'),]);
2009-01-21 20:33:37 +00:00
$this->elementStart('fieldset');
// TRANS: Avatar upload page form legend.
$this->element('legend', null, _m('Avatar settings'));
2009-01-16 22:29:13 +00:00
$this->hidden('token', common_session_token());
if (Event::handle('StartAvatarFormData', [$this])) {
2009-12-10 03:31:07 +00:00
$this->elementStart('ul', 'form_data');
Avatar resizing improvements and better code reuse * getOriginal added to Avatar class This is a static function that retrieves the original avatar in a leaner way than Profile->getOriginalAvatar() did (see below). This will throw an Exception if there was none to be found. * getProfileAvatars added to Avatar class This gets all Avatars from a profile and returns them in an array. * newSize added to Avatar class This will scale an original avatar or throw an Exception (originally from Avatar::getOriginal) if one wasn't found. * deleteFromProfile added to Avatar class Deletes all avatars for a Profile. This makes the code much smarter when removing all avatars from a user. Previously only specific, hardcoded (through constants) sizes would be deleted. If you ever changed lib/framework.php then many oddsized avatars would remain with the old method. * Migrated Profile class to new Avatar::getOriginal support Profile class now uses Avatar::getOriginal through its own $this->getOriginalAvatar and thus remains backwards compatible. * Updating stock GNU Social to use Avatar::getOriginal All places where core StatusNet code used the $profile->getOriginalAvatar, it will now useAvatar::getOriginal with proper error handling. * Updated Profile class to use Avatar::newSize When doing setOriginal, the scaling will be done with the new method introduced in this merge. This also edits the _fillAvatar function to avoid adding NULL values to the array (which causes errors when attempting to access array entries as objects). See issue #3478 at http://status.net/open-source/issues/3478
2013-09-30 21:13:37 +01:00
try {
$original = Avatar::getUploaded($this->scoped);
Avatar resizing improvements and better code reuse * getOriginal added to Avatar class This is a static function that retrieves the original avatar in a leaner way than Profile->getOriginalAvatar() did (see below). This will throw an Exception if there was none to be found. * getProfileAvatars added to Avatar class This gets all Avatars from a profile and returns them in an array. * newSize added to Avatar class This will scale an original avatar or throw an Exception (originally from Avatar::getOriginal) if one wasn't found. * deleteFromProfile added to Avatar class Deletes all avatars for a Profile. This makes the code much smarter when removing all avatars from a user. Previously only specific, hardcoded (through constants) sizes would be deleted. If you ever changed lib/framework.php then many oddsized avatars would remain with the old method. * Migrated Profile class to new Avatar::getOriginal support Profile class now uses Avatar::getOriginal through its own $this->getOriginalAvatar and thus remains backwards compatible. * Updating stock GNU Social to use Avatar::getOriginal All places where core StatusNet code used the $profile->getOriginalAvatar, it will now useAvatar::getOriginal with proper error handling. * Updated Profile class to use Avatar::newSize When doing setOriginal, the scaling will be done with the new method introduced in this merge. This also edits the _fillAvatar function to avoid adding NULL values to the array (which causes errors when attempting to access array entries as objects). See issue #3478 at http://status.net/open-source/issues/3478
2013-09-30 21:13:37 +01:00
$this->elementStart('li', ['id' => 'avatar_original',
'class' => 'avatar_view',]);
// TRANS: Header on avatar upload page for thumbnail of originally uploaded avatar (h2).
$this->element('h2', null, _m('Original'));
$this->elementStart('div', ['id' => 'avatar_original_view']);
$this->element('img', ['src' => $original->displayUrl(),
'width' => $original->width,
'height' => $original->height,
'alt' => $this->scoped->getNickname(),]);
2009-12-10 03:31:07 +00:00
$this->elementEnd('div');
$this->elementEnd('li');
} catch (NoAvatarException $e) {
Avatar resizing improvements and better code reuse * getOriginal added to Avatar class This is a static function that retrieves the original avatar in a leaner way than Profile->getOriginalAvatar() did (see below). This will throw an Exception if there was none to be found. * getProfileAvatars added to Avatar class This gets all Avatars from a profile and returns them in an array. * newSize added to Avatar class This will scale an original avatar or throw an Exception (originally from Avatar::getOriginal) if one wasn't found. * deleteFromProfile added to Avatar class Deletes all avatars for a Profile. This makes the code much smarter when removing all avatars from a user. Previously only specific, hardcoded (through constants) sizes would be deleted. If you ever changed lib/framework.php then many oddsized avatars would remain with the old method. * Migrated Profile class to new Avatar::getOriginal support Profile class now uses Avatar::getOriginal through its own $this->getOriginalAvatar and thus remains backwards compatible. * Updating stock GNU Social to use Avatar::getOriginal All places where core StatusNet code used the $profile->getOriginalAvatar, it will now useAvatar::getOriginal with proper error handling. * Updated Profile class to use Avatar::newSize When doing setOriginal, the scaling will be done with the new method introduced in this merge. This also edits the _fillAvatar function to avoid adding NULL values to the array (which causes errors when attempting to access array entries as objects). See issue #3478 at http://status.net/open-source/issues/3478
2013-09-30 21:13:37 +01:00
// No original avatar found!
2009-12-10 03:31:07 +00:00
}
try {
$avatar = $this->scoped->getAvatar(AVATAR_PROFILE_SIZE);
$this->elementStart('li', ['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, _m('Preview'));
$this->elementStart('div', ['id' => 'avatar_preview_view']);
$this->element('img', ['src' => $avatar->displayUrl(),
'width' => AVATAR_PROFILE_SIZE,
'height' => AVATAR_PROFILE_SIZE,
'alt' => $this->scoped->getNickname(),]);
2009-12-10 03:31:07 +00:00
$this->elementEnd('div');
if (!empty($avatar->filename)) {
// TRANS: Button on avatar upload page to delete current avatar.
$this->submit('delete', _m('BUTTON', 'Delete'));
}
2009-12-10 03:31:07 +00:00
$this->elementEnd('li');
} catch (NoAvatarException $e) {
// No previously uploaded avatar to preview.
2009-12-10 03:31:07 +00:00
}
$this->elementStart('li', ['id' => 'settings_attach']);
$this->element('input', ['name' => 'MAX_FILE_SIZE',
'type' => 'hidden',
'id' => 'MAX_FILE_SIZE',
'value' => ImageFile::maxFileSizeInt(),]);
$this->element('input', ['name' => 'avatarfile',
'type' => 'file',
'id' => 'avatarfile',]);
2009-01-21 20:33:37 +00:00
$this->elementEnd('li');
2009-12-10 03:31:07 +00:00
$this->elementEnd('ul');
2009-01-16 22:29:13 +00:00
2009-12-10 03:31:07 +00:00
$this->elementStart('ul', 'form_actions');
$this->elementStart('li');
// TRANS: Button on avatar upload page to upload an avatar.
$this->submit('upload', _m('BUTTON', 'Upload'));
2009-01-23 06:14:56 +00:00
$this->elementEnd('li');
2009-12-10 03:31:07 +00:00
$this->elementEnd('ul');
2009-01-16 22:29:13 +00:00
}
Event::handle('EndAvatarFormData', [$this]);
2009-01-21 20:33:37 +00:00
$this->elementEnd('fieldset');
2009-01-16 22:29:13 +00:00
$this->elementEnd('form');
}
public function showCropForm()
{
$this->elementStart('form', ['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, _m('Avatar settings'));
$this->hidden('token', common_session_token());
$this->elementStart('ul', 'form_data');
$this->elementStart(
'li',
['id' => 'avatar_original',
'class' => 'avatar_view',]
);
// TRANS: Header on avatar upload crop form for thumbnail of originally uploaded avatar (h2).
$this->element('h2', null, _m('Original'));
$this->elementStart('div', ['id' => 'avatar_original_view']);
$this->element('img', ['src' => Avatar::url($this->filedata['filename']),
'width' => $this->filedata['width'],
'height' => $this->filedata['height'],
'alt' => $this->scoped->getNickname(),]);
$this->elementEnd('div');
$this->elementEnd('li');
$this->elementStart(
'li',
['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, _m('Preview'));
$this->elementStart('div', ['id' => 'avatar_preview_view']);
$this->element('img', ['src' => Avatar::url($this->filedata['filename']),
'width' => AVATAR_PROFILE_SIZE,
'height' => AVATAR_PROFILE_SIZE,
'alt' => $this->scoped->getNickname(),]);
$this->elementEnd('div');
foreach (['avatar_crop_x', 'avatar_crop_y',
'avatar_crop_w', 'avatar_crop_h',] as $crop_info) {
$this->element('input', ['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 string
* @throws NoResultException
* @throws NoUploadedMediaException
* @throws ServerException
* @throws UnsupportedMediaException
* @throws UseFileAsThumbnailException
* @throws Exception
*
* @throws ClientException
*/
protected function doPost()
2009-01-16 22:29:13 +00:00
{
if (Event::handle('StartAvatarSaveForm', [$this])) {
if ($this->trimmed('upload')) {
return $this->uploadAvatar();
} elseif ($this->trimmed('crop')) {
return $this->cropAvatar();
} elseif ($this->trimmed('delete')) {
return $this->deleteAvatar();
} else {
// TRANS: Unexpected validation error on avatar upload form.
throw new ClientException(_m('Unexpected form submission.'));
}
Event::handle('EndAvatarSaveForm', [$this]);
2009-01-16 22:29:13 +00:00
}
}
/**
* Handle an image upload
*
* Does all the magic for handling an image upload, and crops the
* image by default.
*
* @return string
* @throws NoResultException
* @throws NoUploadedMediaException
* @throws ServerException
* @throws UnsupportedMediaException
* @throws UseFileAsThumbnailException
*
* @throws ClientException
2009-01-16 22:29:13 +00:00
*/
public function uploadAvatar(): string
2009-01-16 22:29:13 +00:00
{
// ImageFile throws exception if something goes wrong, which we'll
// pick up and show as an error message above the form.
$imagefile = ImageFile::fromUpload('avatarfile');
2009-01-16 22:29:13 +00:00
$type = $imagefile->preferredType();
$filename = Avatar::filename(
$this->scoped->getID(),
image_type_to_extension($type),
null,
'tmp' . common_timestamp()
);
2009-01-16 22:29:13 +00:00
$filepath = Avatar::path($filename);
$imagefile = $imagefile->copyTo($filepath);
$filedata = [
'filename' => $filename,
'filepath' => $filepath,
'width' => $imagefile->width,
'height' => $imagefile->height,
'type' => $type,
];
$_SESSION['FILEDATA'] = $filedata;
$this->filedata = $filedata;
$this->mode = 'crop';
// TRANS: Avatar upload form instruction after uploading a file.
return _m('Pick a square area of the image to be your avatar.');
2009-01-16 22:29:13 +00:00
}
/**
* Handle the results of jcrop.
*
* @return string
* @throws NoResultException
* @throws ServerException
* @throws UnsupportedMediaException
*
* @throws ClientException
2009-01-16 22:29:13 +00:00
*/
public function cropAvatar()
2009-01-16 22:29:13 +00:00
{
$filedata = $_SESSION['FILEDATA'];
if (empty($filedata)) {
// TRANS: Server error displayed if an avatar upload went wrong somehow server side.
throw new ServerException(_m('Lost our file data.'));
}
$file_d = min($filedata['width'], $filedata['height']);
$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 = (int)(min($dest_w, $dest_h, common_config('avatar', 'maxsize')));
$box = ['width' => $size, 'height' => $size,
'x' => $dest_x, 'y' => $dest_y,
'w' => $dest_w, 'h' => $dest_h,];
$imagefile = new ImageFile(null, $filedata['filepath']);
$filename = Avatar::filename(
$this->scoped->getID(),
image_type_to_extension($imagefile->preferredType()),
$size,
common_timestamp()
);
try {
$imagefile->resizeTo(Avatar::path($filename), $box);
} catch (UseFileAsThumbnailException $e) {
common_debug('Using uploaded avatar directly without resizing, copying it to: ' . $filename);
if (!copy($filedata['filepath'], Avatar::path($filename))) {
common_debug('Tried to copy image file ' . $filedata['filepath'] . ' to destination ' . Avatar::path($filename));
throw new ServerException('Could not copy file to destination.');
}
}
if ($this->scoped->setOriginal($filename)) {
@unlink($filedata['filepath']);
unset($_SESSION['FILEDATA']);
$this->mode = 'upload';
// TRANS: Success message for having updated a user avatar.
return _m('Avatar updated.');
2009-01-16 22:29:13 +00:00
}
// TRANS: Error displayed on the avatar upload page if the avatar could not be updated for an unknown reason.
throw new ServerException(_m('Failed updating avatar.'));
2009-01-16 22:29:13 +00:00
}
2009-02-10 01:17:56 +00:00
/**
* Get rid of the current avatar.
*
* @return string
* @throws Exception
*
2009-02-10 01:17:56 +00:00
*/
public function deleteAvatar()
2009-02-10 01:17:56 +00:00
{
Avatar::deleteFromProfile($this->scoped);
2009-02-10 01:17:56 +00:00
// TRANS: Success message for deleting a user avatar.
return _m('Avatar deleted.');
2009-02-10 01:17:56 +00:00
}
2009-01-16 22:29:13 +00:00
/**
* Add the jCrop stylesheet
*
* @return void
*/
public function showStylesheets()
2009-01-16 22:29:13 +00:00
{
parent::showStylesheets();
$this->cssLink('js/extlib/jquery-jcrop/css/jcrop.css', 'base', 'screen, projection, tv');
2009-01-16 22:29:13 +00:00
}
/**
* Add the jCrop scripts
*
* @return void
*/
public function showScripts()
2009-01-16 22:29:13 +00:00
{
parent::showScripts();
if ($this->mode == 'crop') {
$this->script('extlib/jquery-jcrop/jcrop.js');
$this->script('jcrop.go.js');
}
$this->autofocus('avatarfile');
2009-01-16 22:29:13 +00:00
}
}