]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - actions/avatarsettings.php
Merge branch 'twitter-check-dupe-by-uri' into 'master'
[quix0rs-gnu-social.git] / actions / avatarsettings.php
index 02a684b38f2649c5e8d45a3d096114e631a8bf6d..4b618eb9bef850d2f23c5c2d52fb5bb64012afe8 100644 (file)
  * @link      http://status.net/
  */
 
-if (!defined('STATUSNET') && !defined('LACONICA')) {
-    exit(1);
-}
-
-require_once INSTALLDIR.'/lib/accountsettingsaction.php';
-
-define('MAX_ORIGINAL', 480);
+if (!defined('GNUSOCIAL')) { exit(1); }
 
 /**
  * Upload an avatar
@@ -49,8 +43,7 @@ define('MAX_ORIGINAL', 480);
  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  * @link     http://status.net/
  */
-
-class AvatarsettingsAction extends AccountSettingsAction
+class AvatarsettingsAction extends SettingsAction
 {
     var $mode = null;
     var $imagefile = null;
@@ -61,9 +54,9 @@ class AvatarsettingsAction extends AccountSettingsAction
      *
      * @return string Title of the page
      */
-
     function title()
     {
+        // TRANS: Title for avatar upload page.
         return _('Avatar');
     }
 
@@ -72,20 +65,22 @@ class AvatarsettingsAction extends AccountSettingsAction
      *
      * @return instructions for use
      */
-
     function getInstructions()
     {
-        return sprintf(_('You can upload your personal avatar. The maximum file size is %s.'), ImageFile::maxFileSize());
+        // 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());
     }
 
     /**
      * Content area of the page
      *
-     * Shows a form for uploading an avatar.
+     * Shows a form for uploading an avatar. Currently overrides FormAction's showContent
+     * since we haven't made classes out of AvatarCropForm and AvatarUploadForm.
      *
      * @return void
      */
-
     function showContent()
     {
         if ($this->mode == 'crop') {
@@ -103,12 +98,10 @@ class AvatarsettingsAction extends AccountSettingsAction
 
         if (!$profile) {
             common_log_db_error($user, 'SELECT', __FILE__);
-            $this->serverError(_('User without matching profile'));
-            return;
+            // TRANS: Error message displayed when referring to a user without a profile.
+            $this->serverError(_('User has no profile.'));
         }
 
-        $original = $profile->getOriginalAvatar();
-
         $this->elementStart('form', array('enctype' => 'multipart/form-data',
                                           'method' => 'post',
                                           'id' => 'form_settings_avatar',
@@ -116,59 +109,73 @@ class AvatarsettingsAction extends AccountSettingsAction
                                           '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');
+            try {
+                $original = Avatar::getUploaded($profile);
+
+                $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->displayUrl(),
+                                            'width' => $original->width,
+                                            'height' => $original->height,
+                                            'alt' => $user->nickname));
+                $this->elementEnd('div');
+                $this->elementEnd('li');
+            } catch (NoAvatarException $e) {
+                // No original avatar found!
+            }
+
+            try {
+                $avatar = $profile->getAvatar(AVATAR_PROFILE_SIZE);
+                $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' => $avatar->displayUrl(),
+                                            'width' => AVATAR_PROFILE_SIZE,
+                                            'height' => AVATAR_PROFILE_SIZE,
+                                            'alt' => $user->nickname));
+                $this->elementEnd('div');
+                if (!empty($avatar->filename)) {
+                    // TRANS: Button on avatar upload page to delete current avatar.
+                    $this->submit('delete', _m('BUTTON','Delete'));
+                }
+                $this->elementEnd('li');
+            } catch (NoAvatarException $e) {
+                // No previously uploaded avatar to preview.
+            }
+
+            $this->elementStart('li', array ('id' => 'settings_attach'));
+            $this->element('input', array('name' => 'MAX_FILE_SIZE',
+                                          'type' => 'hidden',
+                                          'id' => 'MAX_FILE_SIZE',
+                                          'value' => ImageFile::maxFileSizeInt()));
+            $this->element('input', array('name' => 'avatarfile',
+                                          'type' => 'file',
+                                          'id' => 'avatarfile'));
             $this->elementEnd('li');
-        }
+            $this->elementEnd('ul');
 
-        $avatar = $profile->getAvatar(AVATAR_PROFILE_SIZE);
-
-        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,
-                                        'width' => AVATAR_PROFILE_SIZE,
-                                        'height' => AVATAR_PROFILE_SIZE,
-                                        'alt' => $user->nickname));
-            $this->elementEnd('div');
-            $this->submit('delete', _('Delete'));
+            $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');
         }
-
-        $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');
-        $this->submit('upload', _('Upload'));
-        $this->elementEnd('li');
-        $this->elementEnd('ul');
+        Event::handle('EndAvatarFormData', array($this));
 
         $this->elementEnd('fieldset');
         $this->elementEnd('form');
-
     }
 
     function showCropForm()
@@ -179,18 +186,17 @@ class AvatarsettingsAction extends AccountSettingsAction
 
         if (!$profile) {
             common_log_db_error($user, 'SELECT', __FILE__);
-            $this->serverError(_('User without matching profile'));
-            return;
+            // TRANS: Error message displayed when referring to a user without a profile.
+            $this->serverError(_('User has no profile.'));
         }
 
-        $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());
 
@@ -199,7 +205,8 @@ class AvatarsettingsAction extends AccountSettingsAction
         $this->elementStart('li',
                             array('id' => 'avatar_original',
                                   'class' => 'avatar_view'));
-        $this->element('h2', null, _("Original"));
+        // 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'],
@@ -211,7 +218,8 @@ class AvatarsettingsAction extends AccountSettingsAction
         $this->elementStart('li',
                             array('id' => 'avatar_preview',
                                   'class' => 'avatar_view'));
-        $this->element('h2', null, _("Preview"));
+        // 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,
@@ -225,42 +233,30 @@ class AvatarsettingsAction extends AccountSettingsAction
                                           'type' => 'hidden',
                                           'id' => $crop_info));
         }
-        $this->submit('crop', _('Crop'));
+
+        // 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');
-
     }
 
-    /**
-     * Handle a post
-     *
-     * We mux on the button name to figure out what the user actually wanted.
-     *
-     * @return void
-     */
-
-    function handlePost()
+    protected function doPost()
     {
-        // CSRF protection
-
-        $token = $this->trimmed('token');
-        if (!$token || $token != common_session_token()) {
-            $this->show_form(_('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 if ($this->arg('delete')) {
-            $this->deleteAvatar();
-        } else {
-            $this->showForm(_('Unexpected form submission.'));
+        if (Event::handle('StartAvatarSaveForm', array($this))) {
+            if ($this->trimmed('upload')) {
+                return $this->uploadAvatar();
+            } else if ($this->trimmed('crop')) {
+                return $this->cropAvatar();
+            } else if ($this->trimmed('delete')) {
+                return $this->deleteAvatar();
+            } else {
+                // TRANS: Unexpected validation error on avatar upload form.
+                throw new ClientException(_('Unexpected form submission.'));
+            }
+            Event::handle('EndAvatarSaveForm', array($this));
         }
     }
 
@@ -272,32 +268,26 @@ class AvatarsettingsAction extends AccountSettingsAction
      *
      * @return void
      */
-
     function uploadAvatar()
     {
-        try {
-            $imagefile = ImageFile::fromUpload('avatarfile');
-        } catch (Exception $e) {
-            $this->showForm($e->getMessage());
-            return;
-        }
-
-        $cur = common_current_user();
+        // 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');
 
-        $filename = Avatar::filename($cur->id,
-                                     image_type_to_extension($imagefile->type),
+        $type = $imagefile->preferredType();
+        $filename = Avatar::filename($this->scoped->getID(),
+                                     image_type_to_extension($type),
                                      null,
                                      'tmp'.common_timestamp());
 
         $filepath = Avatar::path($filename);
-
-        move_uploaded_file($imagefile->filepath, $filepath);
+        $imagefile = $imagefile->copyTo($filepath);
 
         $filedata = array('filename' => $filename,
                           'filepath' => $filepath,
                           'width' => $imagefile->width,
                           'height' => $imagefile->height,
-                          'type' => $imagefile->type);
+                          'type' => $type);
 
         $_SESSION['FILEDATA'] = $filedata;
 
@@ -305,8 +295,8 @@ class AvatarsettingsAction extends AccountSettingsAction
 
         $this->mode = 'crop';
 
-        $this->showForm(_('Pick a square area of the image to be your avatar'),
-                        true);
+        // TRANS: Avatar upload form instruction after uploading a file.
+        return _('Pick a square area of the image to be your avatar.');
     }
 
     /**
@@ -314,63 +304,63 @@ class AvatarsettingsAction extends AccountSettingsAction
      *
      * @return void
      */
-
-    function cropAvatar()
+    public function cropAvatar()
     {
         $filedata = $_SESSION['FILEDATA'];
 
-        if (!$filedata) {
-            $this->serverError(_('Lost our file data.'));
-            return;
+        if (empty($filedata)) {
+            // TRANS: Server error displayed if an avatar upload went wrong somehow server side.
+            throw new ServerException(_('Lost our file data.'));
         }
 
-        $file_d = ($filedata['width'] > $filedata['height'])
-                     ? $filedata['height'] : $filedata['width'];
+        $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 = min($dest_w, $dest_h, MAX_ORIGINAL);
+        $size = intval(min($dest_w, $dest_h, common_config('avatar', 'maxsize')));
 
-        $user = common_current_user();
-        $profile = $user->getProfile();
+        $box = array('width' => $size, 'height' => $size,
+                     'x' => $dest_x,   'y' => $dest_y,
+                     'w' => $dest_w,   'h' => $dest_h);
 
-        $imagefile = new ImageFile($user->id, $filedata['filepath']);
-        $filename = $imagefile->resize($size, $dest_x, $dest_y, $dest_w, $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 ($profile->setOriginal($filename)) {
+        if ($this->scoped->setOriginal($filename)) {
             @unlink($filedata['filepath']);
             unset($_SESSION['FILEDATA']);
             $this->mode = 'upload';
-            $this->showForm(_('Avatar updated.'), true);
-            common_broadcast_profile($profile);
-        } else {
-            $this->showForm(_('Failed updating avatar.'));
+            // TRANS: Success message for having updated a user avatar.
+            return _('Avatar updated.');
         }
+
+        // TRANS: Error displayed on the avatar upload page if the avatar could not be updated for an unknown reason.
+        throw new ServerException(_('Failed updating avatar.'));
     }
-    
+
     /**
      * Get rid of the current avatar.
      *
      * @return void
      */
-    
     function deleteAvatar()
     {
-        $user = common_current_user();
-        $profile = $user->getProfile();
-        
-        $avatar = $profile->getOriginalAvatar();
-        $avatar->delete();
-        $avatar = $profile->getAvatar(AVATAR_PROFILE_SIZE);
-        $avatar->delete();
-        $avatar = $profile->getAvatar(AVATAR_STREAM_SIZE);
-        $avatar->delete();
-        $avatar = $profile->getAvatar(AVATAR_MINI_SIZE);
-        $avatar->delete();
-
-        $this->showForm(_('Avatar deleted.'), true);
+        Avatar::deleteFromProfile($this->scoped);
+
+        // TRANS: Success message for deleting a user avatar.
+        return _('Avatar deleted.');
     }
 
     /**
@@ -382,7 +372,7 @@ class AvatarsettingsAction extends AccountSettingsAction
     function showStylesheets()
     {
         parent::showStylesheets();
-        $this->cssLink('css/jquery.Jcrop.css','base','screen, projection, tv');
+        $this->cssLink('js/extlib/jquery-jcrop/css/jcrop.css','base','screen, projection, tv');
     }
 
     /**
@@ -390,14 +380,13 @@ class AvatarsettingsAction extends AccountSettingsAction
      *
      * @return void
      */
-
     function showScripts()
     {
         parent::showScripts();
 
         if ($this->mode == 'crop') {
-            $this->script('js/jcrop/jquery.Jcrop.min.js');
-            $this->script('js/jcrop/jquery.Jcrop.go.js');
+            $this->script('extlib/jquery-jcrop/jcrop.js');
+            $this->script('jcrop.go.js');
         }
 
         $this->autofocus('avatarfile');