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