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