actions/register.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Register a new user account
   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  Login
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @copyright 2008-2009 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET') && !defined('LACONICA')) {
  31     exit(1);
  32 }
  33
  34 /**
  35  * An action for registering a new user account
  36  *
  37  * @category Login
  38  * @package  StatusNet
  39  * @author   Evan Prodromou <evan@status.net>
  40  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  41  * @link     http://status.net/
  42  */
  43
  44 class RegisterAction extends Action
  45 {
  46     /**
  47      * Has there been an error?
  48      */
  49
  50     var $error = null;
  51
  52     /**
  53      * Have we registered?
  54      */
  55
  56     var $registered = false;
  57
  58     /**
  59      * Are we processing an invite?
  60      */
  61
  62     var $invite = null;
  63
  64     /**
  65      * Prepare page to run
  66      *
  67      *
  68      * @param $args
  69      * @return string title
  70      */
  71
  72     function prepare($args)
  73     {
  74         parent::prepare($args);
  75         $this->code = $this->trimmed('code');
  76
  77         if (empty($this->code)) {
  78             common_ensure_session();
  79             if (array_key_exists('invitecode', $_SESSION)) {
  80                 $this->code = $_SESSION['invitecode'];
  81             }
  82         }
  83
  84         if (common_config('site', 'inviteonly') && empty($this->code)) {
  85             $this->clientError(_('Sorry, only invited people can register.'));
  86             return false;
  87         }
  88
  89         if (!empty($this->code)) {
  90             $this->invite = Invitation::staticGet('code', $this->code);
  91             if (empty($this->invite)) {
  92                 $this->clientError(_('Sorry, invalid invitation code.'));
  93                 return false;
  94             }
  95             // Store this in case we need it
  96             common_ensure_session();
  97             $_SESSION['invitecode'] = $this->code;
  98         }
  99
 100         return true;
 101     }
 102
 103     /**
 104      * Title of the page
 105      *
 106      * @return string title
 107      */
 108
 109     function title()
 110     {
 111         if ($this->registered) {
 112             return _('Registration successful');
 113         } else {
 114             return _('Register');
 115         }
 116     }
 117
 118     /**
 119      * Handle input, produce output
 120      *
 121      * Switches on request method; either shows the form or handles its input.
 122      *
 123      * Checks if registration is closed and shows an error if so.
 124      *
 125      * @param array $args $_REQUEST data
 126      *
 127      * @return void
 128      */
 129
 130     function handle($args)
 131     {
 132         parent::handle($args);
 133
 134         if (common_config('site', 'closed')) {
 135             $this->clientError(_('Registration not allowed.'));
 136         } else if (common_logged_in()) {
 137             $this->clientError(_('Already logged in.'));
 138         } else if ($_SERVER['REQUEST_METHOD'] == 'POST') {
 139             $this->tryRegister();
 140         } else {
 141             $this->showForm();
 142         }
 143     }
 144
 145     function showScripts()
 146     {
 147         parent::showScripts();
 148         $this->autofocus('nickname');
 149     }
 150
 151     /**
 152      * Try to register a user
 153      *
 154      * Validates the input and tries to save a new user and profile
 155      * record. On success, shows an instructions page.
 156      *
 157      * @return void
 158      */
 159
 160     function tryRegister()
 161     {
 162         if (Event::handle('StartRegistrationTry', array($this))) {
 163             $token = $this->trimmed('token');
 164             if (!$token || $token != common_session_token()) {
 165                 $this->showForm(_('There was a problem with your session token. '.
 166                                   'Try again, please.'));
 167                 return;
 168             }
 169
 170             $nickname = $this->trimmed('nickname');
 171             $email    = $this->trimmed('email');
 172             $fullname = $this->trimmed('fullname');
 173             $homepage = $this->trimmed('homepage');
 174             $bio      = $this->trimmed('bio');
 175             $location = $this->trimmed('location');
 176
 177             // We don't trim these... whitespace is OK in a password!
 178             $password = $this->arg('password');
 179             $confirm  = $this->arg('confirm');
 180
 181             // invitation code, if any
 182             $code = $this->trimmed('code');
 183
 184             if ($code) {
 185                 $invite = Invitation::staticGet($code);
 186             }
 187
 188             if (common_config('site', 'inviteonly') && !($code && $invite)) {
 189                 $this->clientError(_('Sorry, only invited people can register.'));
 190                 return;
 191             }
 192
 193             // Input scrubbing
 194             $nickname = common_canonical_nickname($nickname);
 195             $email    = common_canonical_email($email);
 196
 197             if (!$this->boolean('license')) {
 198                 $this->showForm(_('You can\'t register if you don\'t '.
 199                                   'agree to the license.'));
 200             } else if ($email && !Validate::email($email, common_config('email', 'check_domain'))) {
 201                 $this->showForm(_('Not a valid email address.'));
 202             } else if (!Validate::string($nickname, array('min_length' => 1,
 203                                                           'max_length' => 64,
 204                                                           'format' => NICKNAME_FMT))) {
 205                 $this->showForm(_('Nickname must have only lowercase letters '.
 206                                   'and numbers and no spaces.'));
 207             } else if ($this->nicknameExists($nickname)) {
 208                 $this->showForm(_('Nickname already in use. Try another one.'));
 209             } else if (!User::allowed_nickname($nickname)) {
 210                 $this->showForm(_('Not a valid nickname.'));
 211             } else if ($this->emailExists($email)) {
 212                 $this->showForm(_('Email address already exists.'));
 213             } else if (!is_null($homepage) && (strlen($homepage) > 0) &&
 214                        !Validate::uri($homepage,
 215                                       array('allowed_schemes' =>
 216                                             array('http', 'https')))) {
 217                 $this->showForm(_('Homepage is not a valid URL.'));
 218                 return;
 219             } else if (!is_null($fullname) && mb_strlen($fullname) > 255) {
 220                 $this->showForm(_('Full name is too long (max 255 chars).'));
 221                 return;
 222             } else if (Profile::bioTooLong($bio)) {
 223                 $this->showForm(sprintf(_('Bio is too long (max %d chars).'),
 224                                         Profile::maxBio()));
 225                 return;
 226             } else if (!is_null($location) && mb_strlen($location) > 255) {
 227                 $this->showForm(_('Location is too long (max 255 chars).'));
 228                 return;
 229             } else if (strlen($password) < 6) {
 230                 $this->showForm(_('Password must be 6 or more characters.'));
 231                 return;
 232             } else if ($password != $confirm) {
 233                 $this->showForm(_('Passwords don\'t match.'));
 234             } else if ($user = User::register(array('nickname' => $nickname,
 235                                                     'password' => $password,
 236                                                     'email' => $email,
 237                                                     'fullname' => $fullname,
 238                                                     'homepage' => $homepage,
 239                                                     'bio' => $bio,
 240                                                     'location' => $location,
 241                                                     'code' => $code))) {
 242                 if (!$user) {
 243                     $this->showForm(_('Invalid username or password.'));
 244                     return;
 245                 }
 246                 // success!
 247                 if (!common_set_user($user)) {
 248                     $this->serverError(_('Error setting user.'));
 249                     return;
 250                 }
 251                 // this is a real login
 252                 common_real_login(true);
 253                 if ($this->boolean('rememberme')) {
 254                     common_debug('Adding rememberme cookie for ' . $nickname);
 255                     common_rememberme($user);
 256                 }
 257
 258                 Event::handle('EndRegistrationTry', array($this));
 259
 260                 // Re-init language env in case it changed (not yet, but soon)
 261                 common_init_language();
 262
 263                 $this->showSuccess();
 264             } else {
 265                 $this->showForm(_('Invalid username or password.'));
 266             }
 267         }
 268     }
 269
 270     /**
 271      * Does the given nickname already exist?
 272      *
 273      * Checks a canonical nickname against the database.
 274      *
 275      * @param string $nickname nickname to check
 276      *
 277      * @return boolean true if the nickname already exists
 278      */
 279
 280     function nicknameExists($nickname)
 281     {
 282         $user = User::staticGet('nickname', $nickname);
 283         return ($user !== false);
 284     }
 285
 286     /**
 287      * Does the given email address already exist?
 288      *
 289      * Checks a canonical email address against the database.
 290      *
 291      * @param string $email email address to check
 292      *
 293      * @return boolean true if the address already exists
 294      */
 295
 296     function emailExists($email)
 297     {
 298         $email = common_canonical_email($email);
 299         if (!$email || strlen($email) == 0) {
 300             return false;
 301         }
 302         $user = User::staticGet('email', $email);
 303         return ($user !== false);
 304     }
 305
 306     /**
 307      * Instructions or a notice for the page
 308      *
 309      * Shows the error, if any, or instructions for registration.
 310      *
 311      * @return void
 312      */
 313
 314     function showPageNotice()
 315     {
 316         if ($this->registered) {
 317             return;
 318         } else if ($this->error) {
 319             $this->element('p', 'error', $this->error);
 320         } else {
 321             $instr =
 322               common_markup_to_html(_('With this form you can create '.
 323                                       ' a new account. ' .
 324                                       'You can then post notices and '.
 325                                       'link up to friends and colleagues. '));
 326
 327             $this->elementStart('div', 'instructions');
 328             $this->raw($instr);
 329             $this->elementEnd('div');
 330         }
 331     }
 332
 333     /**
 334      * Wrapper for showing a page
 335      *
 336      * Stores an error and shows the page
 337      *
 338      * @param string $error Error, if any
 339      *
 340      * @return void
 341      */
 342
 343     function showForm($error=null)
 344     {
 345         $this->error = $error;
 346         $this->showPage();
 347     }
 348
 349     /**
 350      * Show the page content
 351      *
 352      * Either shows the registration form or, if registration was successful,
 353      * instructions for using the site.
 354      *
 355      * @return void
 356      */
 357
 358     function showContent()
 359     {
 360         if ($this->registered) {
 361             $this->showSuccessContent();
 362         } else {
 363             $this->showFormContent();
 364         }
 365     }
 366
 367     /**
 368      * Show the registration form
 369      *
 370      * @return void
 371      */
 372
 373     function showFormContent()
 374     {
 375         $code = $this->trimmed('code');
 376
 377         $invite = null;
 378
 379         if ($code) {
 380             $invite = Invitation::staticGet($code);
 381         }
 382
 383         if (common_config('site', 'inviteonly') && !($code && $invite)) {
 384             $this->clientError(_('Sorry, only invited people can register.'));
 385             return;
 386         }
 387
 388         $this->elementStart('form', array('method' => 'post',
 389                                           'id' => 'form_register',
 390                                           'class' => 'form_settings',
 391                                           'action' => common_local_url('register')));
 392         $this->elementStart('fieldset');
 393         $this->element('legend', null, 'Account settings');
 394         $this->hidden('token', common_session_token());
 395
 396         if ($this->code) {
 397             $this->hidden('code', $this->code);
 398         }
 399
 400         $this->elementStart('ul', 'form_data');
 401         if (Event::handle('StartRegistrationFormData', array($this))) {
 402             $this->elementStart('li');
 403             $this->input('nickname', _('Nickname'), $this->trimmed('nickname'),
 404                          _('1-64 lowercase letters or numbers, '.
 405                            'no punctuation or spaces. Required.'));
 406             $this->elementEnd('li');
 407             $this->elementStart('li');
 408             $this->password('password', _('Password'),
 409                             _('6 or more characters. Required.'));
 410             $this->elementEnd('li');
 411             $this->elementStart('li');
 412             $this->password('confirm', _('Confirm'),
 413                             _('Same as password above. Required.'));
 414             $this->elementEnd('li');
 415             $this->elementStart('li');
 416             if ($this->invite && $this->invite->address_type == 'email') {
 417                 $this->input('email', _('Email'), $this->invite->address,
 418                              _('Used only for updates, announcements, '.
 419                                'and password recovery'));
 420             } else {
 421                 $this->input('email', _('Email'), $this->trimmed('email'),
 422                              _('Used only for updates, announcements, '.
 423                                'and password recovery'));
 424             }
 425             $this->elementEnd('li');
 426             $this->elementStart('li');
 427             $this->input('fullname', _('Full name'),
 428                          $this->trimmed('fullname'),
 429                          _('Longer name, preferably your "real" name'));
 430             $this->elementEnd('li');
 431             $this->elementStart('li');
 432             $this->input('homepage', _('Homepage'),
 433                          $this->trimmed('homepage'),
 434                          _('URL of your homepage, blog, '.
 435                            'or profile on another site'));
 436             $this->elementEnd('li');
 437             $this->elementStart('li');
 438             $maxBio = Profile::maxBio();
 439             if ($maxBio > 0) {
 440                 $bioInstr = sprintf(_('Describe yourself and your interests in %d chars'),
 441                                     $maxBio);
 442             } else {
 443                 $bioInstr = _('Describe yourself and your interests');
 444             }
 445             $this->textarea('bio', _('Bio'),
 446                             $this->trimmed('bio'),
 447                             $bioInstr);
 448             $this->elementEnd('li');
 449             $this->elementStart('li');
 450             $this->input('location', _('Location'),
 451                          $this->trimmed('location'),
 452                          _('Where you are, like "City, '.
 453                            'State (or Region), Country"'));
 454             $this->elementEnd('li');
 455             Event::handle('EndRegistrationFormData', array($this));
 456             $this->elementStart('li', array('id' => 'settings_rememberme'));
 457             $this->checkbox('rememberme', _('Remember me'),
 458                             $this->boolean('rememberme'),
 459                             _('Automatically login in the future; '.
 460                               'not for shared computers!'));
 461             $this->elementEnd('li');
 462             $attrs = array('type' => 'checkbox',
 463                            'id' => 'license',
 464                            'class' => 'checkbox',
 465                            'name' => 'license',
 466                            'value' => 'true');
 467             if ($this->boolean('license')) {
 468                 $attrs['checked'] = 'checked';
 469             }
 470             $this->elementStart('li');
 471             $this->element('input', $attrs);
 472             $this->elementStart('label', array('class' => 'checkbox', 'for' => 'license'));
 473             $this->text(_('My text and files are available under '));
 474             $this->element('a', array('href' => common_config('license', 'url')),
 475                            common_config('license', 'title'), _("Creative Commons Attribution 3.0"));
 476             $this->text(_(' except this private data: password, '.
 477                           'email address, IM address, and phone number.'));
 478             $this->elementEnd('label');
 479             $this->elementEnd('li');
 480         }
 481         $this->elementEnd('ul');
 482         $this->submit('submit', _('Register'));
 483         $this->elementEnd('fieldset');
 484         $this->elementEnd('form');
 485     }
 486
 487     /**
 488      * Show some information about registering for the site
 489      *
 490      * Save the registration flag, run showPage
 491      *
 492      * @return void
 493      */
 494
 495     function showSuccess()
 496     {
 497         $this->registered = true;
 498         $this->showPage();
 499     }
 500
 501     /**
 502      * Show some information about registering for the site
 503      *
 504      * Gives some information and options for new registrees.
 505      *
 506      * @return void
 507      */
 508
 509     function showSuccessContent()
 510     {
 511         $nickname = $this->arg('nickname');
 512
 513         $profileurl = common_local_url('showstream',
 514                                        array('nickname' => $nickname));
 515
 516         $this->elementStart('div', 'success');
 517         $instr = sprintf(_('Congratulations, %1$s! And welcome to %%%%site.name%%%%. '.
 518                            'From here, you may want to...'. "\n\n" .
 519                            '* Go to [your profile](%2$s) '.
 520                            'and post your first message.' .  "\n" .
 521                            '* Add a [Jabber/GTalk address]'.
 522                            '(%%%%action.imsettings%%%%) '.
 523                            'so you can send notices '.
 524                            'through instant messages.' . "\n" .
 525                            '* [Search for people](%%%%action.peoplesearch%%%%) '.
 526                            'that you may know or '.
 527                            'that share your interests. ' . "\n" .
 528                            '* Update your [profile settings]'.
 529                            '(%%%%action.profilesettings%%%%)'.
 530                            ' to tell others more about you. ' . "\n" .
 531                            '* Read over the [online docs](%%%%doc.help%%%%)'.
 532                            ' for features you may have missed. ' . "\n\n" .
 533                            'Thanks for signing up and we hope '.
 534                            'you enjoy using this service.'),
 535                          $nickname, $profileurl);
 536
 537         $this->raw(common_markup_to_html($instr));
 538
 539         $have_email = $this->trimmed('email');
 540         if ($have_email) {
 541             $emailinstr = _('(You should receive a message by email '.
 542                             'momentarily, with ' .
 543                             'instructions on how to confirm '.
 544                             'your email address.)');
 545             $this->raw(common_markup_to_html($emailinstr));
 546         }
 547         $this->elementEnd('div');
 548     }
 549
 550     /**
 551      * Show the login group nav menu
 552      *
 553      * @return void
 554      */
 555
 556     function showLocalNav()
 557     {
 558         $nav = new LoginGroupNav($this);
 559         $nav->show();
 560     }
 561 }
 562