actions/avatarsettings.php

   1 <?php
   2 /**
   3  * Laconica, the distributed open-source microblogging tool
   4  *
   5  * Upload an avatar
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Settings
  23  * @package   Laconica
  24  * @author    Evan Prodromou <evan@controlyourself.ca>
  25  * @author    Zach Copley <zach@controlyourself.ca>
  26  * @copyright 2008-2009 Control Yourself, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://laconi.ca/
  29  */
  30
  31 if (!defined('LACONICA')) {
  32     exit(1);
  33 }
  34
  35 require_once INSTALLDIR.'/lib/accountsettingsaction.php';
  36
  37 define('MAX_ORIGINAL', 480);
  38
  39 /**
  40  * Upload an avatar
  41  *
  42  * We use jCrop plugin for jQuery to crop the image after upload.
  43  *
  44  * @category Settings
  45  * @package  Laconica
  46  * @author   Evan Prodromou <evan@controlyourself.ca>
  47  * @author   Zach Copley <zach@controlyourself.ca>
  48  * @author   Sarven Capadisli <csarven@controlyourself.ca>
  49  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  50  * @link     http://laconi.ca/
  51  */
  52
  53 class AvatarsettingsAction extends AccountSettingsAction
  54 {
  55     var $mode = null;
  56     var $imagefile = null;
  57     var $filename = null;
  58
  59     /**
  60      * Title of the page
  61      *
  62      * @return string Title of the page
  63      */
  64
  65     function title()
  66     {
  67         return _('Avatar');
  68     }
  69
  70     /**
  71      * Instructions for use
  72      *
  73      * @return instructions for use
  74      */
  75
  76     function getInstructions()
  77     {
  78         return sprintf(_('You can upload your personal avatar. The maximum file size is %s.'), ImageFile::maxFileSize());
  79     }
  80
  81     /**
  82      * Content area of the page
  83      *
  84      * Shows a form for uploading an avatar.
  85      *
  86      * @return void
  87      */
  88
  89     function showContent()
  90     {
  91         if ($this->mode == 'crop') {
  92             $this->showCropForm();
  93         } else {
  94             $this->showUploadForm();
  95         }
  96     }
  97
  98     function showUploadForm()
  99     {
 100         $user = common_current_user();
 101
 102         $profile = $user->getProfile();
 103
 104         if (!$profile) {
 105             common_log_db_error($user, 'SELECT', __FILE__);
 106             $this->serverError(_('User without matching profile'));
 107             return;
 108         }
 109
 110         $original = $profile->getOriginalAvatar();
 111
 112         $this->elementStart('form', array('enctype' => 'multipart/form-data',
 113                                           'method' => 'post',
 114                                           'id' => 'form_settings_avatar',
 115                                           'class' => 'form_settings',
 116                                           'action' =>
 117                                           common_local_url('avatarsettings')));
 118         $this->elementStart('fieldset');
 119         $this->element('legend', null, _('Avatar settings'));
 120         $this->hidden('token', common_session_token());
 121
 122         $this->elementStart('ul', 'form_data');
 123         if ($original) {
 124             $this->elementStart('li', array('id' => 'avatar_original',
 125                                             'class' => 'avatar_view'));
 126             $this->element('h2', null, _("Original"));
 127             $this->elementStart('div', array('id'=>'avatar_original_view'));
 128             $this->element('img', array('src' => $original->url,
 129                                         'width' => $original->width,
 130                                         'height' => $original->height,
 131                                         'alt' => $user->nickname));
 132             $this->elementEnd('div');
 133             $this->elementEnd('li');
 134         }
 135
 136         $avatar = $profile->getAvatar(AVATAR_PROFILE_SIZE);
 137
 138         if ($avatar) {
 139             $this->elementStart('li', array('id' => 'avatar_preview',
 140                                             'class' => 'avatar_view'));
 141             $this->element('h2', null, _("Preview"));
 142             $this->elementStart('div', array('id'=>'avatar_preview_view'));
 143             $this->element('img', array('src' => $original->url,
 144                                         'width' => AVATAR_PROFILE_SIZE,
 145                                         'height' => AVATAR_PROFILE_SIZE,
 146                                         'alt' => $user->nickname));
 147             $this->elementEnd('div');
 148             $this->elementEnd('li');
 149         }
 150
 151         $this->elementStart('li', array ('id' => 'settings_attach'));
 152         $this->element('input', array('name' => 'avatarfile',
 153                                       'type' => 'file',
 154                                       'id' => 'avatarfile'));
 155         $this->element('input', array('name' => 'MAX_FILE_SIZE',
 156                                       'type' => 'hidden',
 157                                       'id' => 'MAX_FILE_SIZE',
 158                                       'value' => ImageFile::maxFileSizeInt()));
 159         $this->elementEnd('li');
 160         $this->elementEnd('ul');
 161
 162         $this->elementStart('ul', 'form_actions');
 163         $this->elementStart('li');
 164         $this->submit('upload', _('Upload'));
 165         $this->elementEnd('li');
 166         $this->elementEnd('ul');
 167
 168         $this->elementEnd('fieldset');
 169         $this->elementEnd('form');
 170
 171     }
 172
 173     function showCropForm()
 174     {
 175         $user = common_current_user();
 176
 177         $profile = $user->getProfile();
 178
 179         if (!$profile) {
 180             common_log_db_error($user, 'SELECT', __FILE__);
 181             $this->serverError(_('User without matching profile'));
 182             return;
 183         }
 184
 185         $original = $profile->getOriginalAvatar();
 186
 187         $this->elementStart('form', array('method' => 'post',
 188                                           'id' => 'form_settings_avatar',
 189                                           'class' => 'form_settings',
 190                                           'action' =>
 191                                           common_local_url('avatarsettings')));
 192         $this->elementStart('fieldset');
 193         $this->element('legend', null, _('Avatar settings'));
 194         $this->hidden('token', common_session_token());
 195
 196         $this->elementStart('ul', 'form_data');
 197
 198         $this->elementStart('li',
 199                             array('id' => 'avatar_original',
 200                                   'class' => 'avatar_view'));
 201         $this->element('h2', null, _("Original"));
 202         $this->elementStart('div', array('id'=>'avatar_original_view'));
 203         $this->element('img', array('src' => common_avatar_url($this->filedata['filename']),
 204                                     'width' => $this->filedata['width'],
 205                                     'height' => $this->filedata['height'],
 206                                     'alt' => $user->nickname));
 207         $this->elementEnd('div');
 208         $this->elementEnd('li');
 209
 210         $this->elementStart('li',
 211                             array('id' => 'avatar_preview',
 212                                   'class' => 'avatar_view'));
 213         $this->element('h2', null, _("Preview"));
 214         $this->elementStart('div', array('id'=>'avatar_preview_view'));
 215         $this->element('img', array('src' => common_avatar_url($this->filedata['filename']),
 216                                     'width' => AVATAR_PROFILE_SIZE,
 217                                     'height' => AVATAR_PROFILE_SIZE,
 218                                     'alt' => $user->nickname));
 219         $this->elementEnd('div');
 220
 221         foreach (array('avatar_crop_x', 'avatar_crop_y',
 222                        'avatar_crop_w', 'avatar_crop_h') as $crop_info) {
 223             $this->element('input', array('name' => $crop_info,
 224                                           'type' => 'hidden',
 225                                           'id' => $crop_info));
 226         }
 227         $this->submit('crop', _('Crop'));
 228
 229         $this->elementEnd('li');
 230         $this->elementEnd('ul');
 231         $this->elementEnd('fieldset');
 232         $this->elementEnd('form');
 233
 234     }
 235
 236     /**
 237      * Handle a post
 238      *
 239      * We mux on the button name to figure out what the user actually wanted.
 240      *
 241      * @return void
 242      */
 243
 244     function handlePost()
 245     {
 246         // CSRF protection
 247
 248         $token = $this->trimmed('token');
 249         if (!$token || $token != common_session_token()) {
 250             $this->show_form(_('There was a problem with your session token. '.
 251                                'Try again, please.'));
 252             return;
 253         }
 254
 255         if ($this->arg('upload')) {
 256             $this->uploadAvatar();
 257         } else if ($this->arg('crop')) {
 258             $this->cropAvatar();
 259         } else {
 260             $this->showForm(_('Unexpected form submission.'));
 261         }
 262     }
 263
 264     /**
 265      * Handle an image upload
 266      *
 267      * Does all the magic for handling an image upload, and crops the
 268      * image by default.
 269      *
 270      * @return void
 271      */
 272
 273     function uploadAvatar()
 274     {
 275         try {
 276             $imagefile = ImageFile::fromUpload('avatarfile');
 277         } catch (Exception $e) {
 278             $this->showForm($e->getMessage());
 279             return;
 280         }
 281
 282         $cur = common_current_user();
 283
 284         $filename = common_avatar_filename($cur->id,
 285                                            image_type_to_extension($imagefile->type),
 286                                            null,
 287                                            'tmp'.common_timestamp());
 288
 289         $filepath = common_avatar_path($filename);
 290
 291         move_uploaded_file($imagefile->filepath, $filepath);
 292
 293         $filedata = array('filename' => $filename,
 294                           'filepath' => $filepath,
 295                           'width' => $imagefile->width,
 296                           'height' => $imagefile->height,
 297                           'type' => $imagefile->type);
 298
 299         $_SESSION['FILEDATA'] = $filedata;
 300
 301         $this->filedata = $filedata;
 302
 303         $this->mode = 'crop';
 304
 305         $this->showForm(_('Pick a square area of the image to be your avatar'),
 306                         true);
 307     }
 308
 309     /**
 310      * Handle the results of jcrop.
 311      *
 312      * @return void
 313      */
 314
 315     function cropAvatar()
 316     {
 317         $filedata = $_SESSION['FILEDATA'];
 318
 319         if (!$filedata) {
 320             $this->serverError(_('Lost our file data.'));
 321             return;
 322         }
 323
 324         // If image is not being cropped assume pos & dimentions of original
 325         $dest_x = $this->arg('avatar_crop_x') ? $this->arg('avatar_crop_x'):0;
 326         $dest_y = $this->arg('avatar_crop_y') ? $this->arg('avatar_crop_y'):0;
 327         $dest_w = $this->arg('avatar_crop_w') ? $this->arg('avatar_crop_w'):$filedata['width'];
 328         $dest_h = $this->arg('avatar_crop_h') ? $this->arg('avatar_crop_h'):$filedata['height'];
 329         $size = min($dest_w, $dest_h);
 330         $size = ($size > MAX_ORIGINAL) ? MAX_ORIGINAL:$size;
 331
 332         $user = common_current_user();
 333         $profile = $user->getProfile();
 334
 335         $imagefile = new ImageFile($user->id, $filedata['filepath']);
 336         $filename = $imagefile->resize($size, $dest_x, $dest_y, $dest_w, $dest_h);
 337
 338         if ($profile->setOriginal($filename)) {
 339             @unlink($filedata['filepath']);
 340             unset($_SESSION['FILEDATA']);
 341             $this->mode = 'upload';
 342             $this->showForm(_('Avatar updated.'), true);
 343         } else {
 344             $this->showForm(_('Failed updating avatar.'));
 345         }
 346     }
 347
 348     /**
 349      * Add the jCrop stylesheet
 350      *
 351      * @return void
 352      */
 353
 354     function showStylesheets()
 355     {
 356         parent::showStylesheets();
 357         $jcropStyle =
 358           common_path('theme/base/css/jquery.Jcrop.css?version='.LACONICA_VERSION);
 359
 360         $this->element('link', array('rel' => 'stylesheet',
 361                                      'type' => 'text/css',
 362                                      'href' => $jcropStyle,
 363                                      'media' => 'screen, projection, tv'));
 364     }
 365
 366     /**
 367      * Add the jCrop scripts
 368      *
 369      * @return void
 370      */
 371
 372     function showScripts()
 373     {
 374         parent::showScripts();
 375
 376         if ($this->mode == 'crop') {
 377             $jcropPack = common_path('js/jcrop/jquery.Jcrop.pack.js');
 378             $jcropGo   = common_path('js/jcrop/jquery.Jcrop.go.js');
 379
 380             $this->element('script', array('type' => 'text/javascript',
 381                                            'src' => $jcropPack));
 382             $this->element('script', array('type' => 'text/javascript',
 383                                            'src' => $jcropGo));
 384         }
 385     }
 386 }