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