actions/profilesettings.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Change profile settings
   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   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @author    Zach Copley <zach@status.net>
  26  * @author    Sarven Capadisli <csarven@status.net>
  27  * @copyright 2008-2009 StatusNet, Inc.
  28  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  29  * @link      http://status.net/
  30  */
  31
  32 if (!defined('STATUSNET') && !defined('LACONICA')) {
  33     exit(1);
  34 }
  35
  36 require_once INSTALLDIR.'/lib/accountsettingsaction.php';
  37
  38 /**
  39  * Change profile settings
  40  *
  41  * @category Settings
  42  * @package  StatusNet
  43  * @author   Evan Prodromou <evan@status.net>
  44  * @author   Zach Copley <zach@status.net>
  45  * @author   Sarven Capadisli <csarven@status.net>
  46  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  47  * @link     http://status.net/
  48  */
  49
  50 class ProfilesettingsAction extends AccountSettingsAction
  51 {
  52     /**
  53      * Title of the page
  54      *
  55      * @return string Title of the page
  56      */
  57
  58     function title()
  59     {
  60         return _('Profile settings');
  61     }
  62
  63     /**
  64      * Instructions for use
  65      *
  66      * @return instructions for use
  67      */
  68
  69     function getInstructions()
  70     {
  71         return _('You can update your personal profile info here '.
  72                  'so people know more about you.');
  73     }
  74
  75     function showScripts()
  76     {
  77         parent::showScripts();
  78         $this->autofocus('nickname');
  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         $user = common_current_user();
  92         $profile = $user->getProfile();
  93
  94         $this->elementStart('form', array('method' => 'post',
  95                                           'id' => 'form_settings_profile',
  96                                           'class' => 'form_settings',
  97                                           'action' => common_local_url('profilesettings')));
  98         $this->elementStart('fieldset');
  99         $this->element('legend', null, _('Profile information'));
 100         $this->hidden('token', common_session_token());
 101
 102         // too much common patterns here... abstractable?
 103         $this->elementStart('ul', 'form_data');
 104         if (Event::handle('StartProfileFormData', array($this))) {
 105             $this->elementStart('li');
 106             $this->input('nickname', _('Nickname'),
 107                          ($this->arg('nickname')) ? $this->arg('nickname') : $profile->nickname,
 108                          _('1-64 lowercase letters or numbers, no punctuation or spaces'));
 109             $this->elementEnd('li');
 110             $this->elementStart('li');
 111             $this->input('fullname', _('Full name'),
 112                          ($this->arg('fullname')) ? $this->arg('fullname') : $profile->fullname);
 113             $this->elementEnd('li');
 114             $this->elementStart('li');
 115             $this->input('homepage', _('Homepage'),
 116                          ($this->arg('homepage')) ? $this->arg('homepage') : $profile->homepage,
 117                          _('URL of your homepage, blog, or profile on another site'));
 118             $this->elementEnd('li');
 119             $this->elementStart('li');
 120             $maxBio = Profile::maxBio();
 121             if ($maxBio > 0) {
 122                 $bioInstr = sprintf(_('Describe yourself and your interests in %d chars'),
 123                                     $maxBio);
 124             } else {
 125                 $bioInstr = _('Describe yourself and your interests');
 126             }
 127             $this->textarea('bio', _('Bio'),
 128                             ($this->arg('bio')) ? $this->arg('bio') : $profile->bio,
 129                             $bioInstr);
 130             $this->elementEnd('li');
 131             $this->elementStart('li');
 132             $this->input('location', _('Location'),
 133                          ($this->arg('location')) ? $this->arg('location') : $profile->location,
 134                          _('Where you are, like "City, State (or Region), Country"'));
 135             $this->elementEnd('li');
 136             Event::handle('EndProfileFormData', array($this));
 137             $this->elementStart('li');
 138             $this->input('tags', _('Tags'),
 139                          ($this->arg('tags')) ? $this->arg('tags') : implode(' ', $user->getSelfTags()),
 140                          _('Tags for yourself (letters, numbers, -, ., and _), comma- or space- separated'));
 141             $this->elementEnd('li');
 142             $this->elementStart('li');
 143             $language = common_language();
 144             $this->dropdown('language', _('Language'),
 145                             get_nice_language_list(), _('Preferred language'),
 146                             false, $language);
 147             $this->elementEnd('li');
 148             $timezone = common_timezone();
 149             $timezones = array();
 150             foreach(DateTimeZone::listIdentifiers() as $k => $v) {
 151                 $timezones[$v] = $v;
 152             }
 153             $this->elementStart('li');
 154             $this->dropdown('timezone', _('Timezone'),
 155                             $timezones, _('What timezone are you normally in?'),
 156                             true, $timezone);
 157             $this->elementEnd('li');
 158             $this->elementStart('li');
 159             $this->checkbox('autosubscribe',
 160                             _('Automatically subscribe to whoever '.
 161                               'subscribes to me (best for non-humans)'),
 162                             ($this->arg('autosubscribe')) ?
 163                             $this->boolean('autosubscribe') : $user->autosubscribe);
 164             $this->elementEnd('li');
 165         }
 166         $this->elementEnd('ul');
 167         $this->submit('save', _('Save'));
 168
 169         $this->elementEnd('fieldset');
 170         $this->elementEnd('form');
 171     }
 172
 173     /**
 174      * Handle a post
 175      *
 176      * Validate input and save changes. Reload the form with a success
 177      * or error message.
 178      *
 179      * @return void
 180      */
 181
 182     function handlePost()
 183     {
 184         // CSRF protection
 185         $token = $this->trimmed('token');
 186         if (!$token || $token != common_session_token()) {
 187             $this->showForm(_('There was a problem with your session token. '.
 188                               'Try again, please.'));
 189             return;
 190         }
 191
 192         if (Event::handle('StartProfileSaveForm', array($this))) {
 193
 194             $nickname = $this->trimmed('nickname');
 195             $fullname = $this->trimmed('fullname');
 196             $homepage = $this->trimmed('homepage');
 197             $bio = $this->trimmed('bio');
 198             $location = $this->trimmed('location');
 199             $autosubscribe = $this->boolean('autosubscribe');
 200             $language = $this->trimmed('language');
 201             $timezone = $this->trimmed('timezone');
 202             $tagstring = $this->trimmed('tags');
 203
 204             // Some validation
 205             if (!Validate::string($nickname, array('min_length' => 1,
 206                                                    'max_length' => 64,
 207                                                    'format' => NICKNAME_FMT))) {
 208                 $this->showForm(_('Nickname must have only lowercase letters and numbers and no spaces.'));
 209                 return;
 210             } else if (!User::allowed_nickname($nickname)) {
 211                 $this->showForm(_('Not a valid nickname.'));
 212                 return;
 213             } else if (!is_null($homepage) && (strlen($homepage) > 0) &&
 214                        !Validate::uri($homepage, array('allowed_schemes' => array('http', 'https')))) {
 215                 $this->showForm(_('Homepage is not a valid URL.'));
 216                 return;
 217             } else if (!is_null($fullname) && mb_strlen($fullname) > 255) {
 218                 $this->showForm(_('Full name is too long (max 255 chars).'));
 219                 return;
 220             } else if (Profile::bioTooLong($bio)) {
 221                 $this->showForm(sprintf(_('Bio is too long (max %d chars).'),
 222                                         Profile::maxBio()));
 223                 return;
 224             } else if (!is_null($location) && mb_strlen($location) > 255) {
 225                 $this->showForm(_('Location is too long (max 255 chars).'));
 226                 return;
 227             }  else if (is_null($timezone) || !in_array($timezone, DateTimeZone::listIdentifiers())) {
 228                 $this->showForm(_('Timezone not selected.'));
 229                 return;
 230             } else if ($this->nicknameExists($nickname)) {
 231                 $this->showForm(_('Nickname already in use. Try another one.'));
 232                 return;
 233             } else if (!is_null($language) && strlen($language) > 50) {
 234                 $this->showForm(_('Language is too long (max 50 chars).'));
 235                 return;
 236             }
 237
 238             if ($tagstring) {
 239                 $tags = array_map('common_canonical_tag', preg_split('/[\s,]+/', $tagstring));
 240             } else {
 241                 $tags = array();
 242             }
 243
 244             foreach ($tags as $tag) {
 245                 if (!common_valid_profile_tag($tag)) {
 246                     $this->showForm(sprintf(_('Invalid tag: "%s"'), $tag));
 247                     return;
 248                 }
 249             }
 250
 251             $user = common_current_user();
 252
 253             $user->query('BEGIN');
 254
 255             if ($user->nickname != $nickname ||
 256                 $user->language != $language ||
 257                 $user->timezone != $timezone) {
 258
 259                 common_debug('Updating user nickname from ' . $user->nickname . ' to ' . $nickname,
 260                              __FILE__);
 261                 common_debug('Updating user language from ' . $user->language . ' to ' . $language,
 262                              __FILE__);
 263                 common_debug('Updating user timezone from ' . $user->timezone . ' to ' . $timezone,
 264                              __FILE__);
 265
 266                 $original = clone($user);
 267
 268                 $user->nickname = $nickname;
 269                 $user->language = $language;
 270                 $user->timezone = $timezone;
 271
 272                 $result = $user->updateKeys($original);
 273
 274                 if ($result === false) {
 275                     common_log_db_error($user, 'UPDATE', __FILE__);
 276                     $this->serverError(_('Couldn\'t update user.'));
 277                     return;
 278                 } else {
 279                     // Re-initialize language environment if it changed
 280                     common_init_language();
 281                 }
 282             }
 283
 284             // XXX: XOR
 285             if ($user->autosubscribe ^ $autosubscribe) {
 286
 287                 $original = clone($user);
 288
 289                 $user->autosubscribe = $autosubscribe;
 290
 291                 $result = $user->update($original);
 292
 293                 if ($result === false) {
 294                     common_log_db_error($user, 'UPDATE', __FILE__);
 295                     $this->serverError(_('Couldn\'t update user for autosubscribe.'));
 296                     return;
 297                 }
 298             }
 299
 300             $profile = $user->getProfile();
 301
 302             $orig_profile = clone($profile);
 303
 304             $profile->nickname = $user->nickname;
 305             $profile->fullname = $fullname;
 306             $profile->homepage = $homepage;
 307             $profile->bio = $bio;
 308             $profile->location = $location;
 309
 310             $loc = Location::fromName($location);
 311
 312             if (!empty($loc)) {
 313                 $profile->lat         = $loc->lat;
 314                 $profile->lon         = $loc->lon;
 315                 $profile->location_id = $loc->location_id;
 316                 $profile->location_ns = $loc->location_ns;
 317             }
 318
 319             $profile->profileurl = common_profile_url($nickname);
 320
 321             common_debug('Old profile: ' . common_log_objstring($orig_profile), __FILE__);
 322             common_debug('New profile: ' . common_log_objstring($profile), __FILE__);
 323
 324             $result = $profile->update($orig_profile);
 325
 326             if ($result === false) {
 327                 common_log_db_error($profile, 'UPDATE', __FILE__);
 328                 $this->serverError(_('Couldn\'t save profile.'));
 329                 return;
 330             }
 331
 332             // Set the user tags
 333             $result = $user->setSelfTags($tags);
 334
 335             if (!$result) {
 336                 $this->serverError(_('Couldn\'t save tags.'));
 337                 return;
 338             }
 339
 340             $user->query('COMMIT');
 341             Event::handle('EndProfileSaveForm', array($this));
 342             common_broadcast_profile($profile);
 343
 344             $this->showForm(_('Settings saved.'), true);
 345
 346         }
 347     }
 348
 349     function nicknameExists($nickname)
 350     {
 351         $user = common_current_user();
 352         $other = User::staticGet('nickname', $nickname);
 353         if (!$other) {
 354             return false;
 355         } else {
 356             return $other->id != $user->id;
 357         }
 358     }
 359 }