3 * StatusNet, the distributed open-source microblogging tool
5 * Register a new user account
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.
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.
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/>.
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/
30 if (!defined('STATUSNET') && !defined('LACONICA')) {
35 * An action for registering a new user account
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/
44 class RegisterAction extends Action
47 * Has there been an error?
56 var $registered = false;
59 * Are we processing an invite?
69 * @return string title
72 function prepare($args)
74 parent::prepare($args);
75 $this->code = $this->trimmed('code');
77 if (empty($this->code)) {
78 common_ensure_session();
79 if (array_key_exists('invitecode', $_SESSION)) {
80 $this->code = $_SESSION['invitecode'];
84 if (common_config('site', 'inviteonly') && empty($this->code)) {
85 $this->clientError(_('Sorry, only invited people can register.'));
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.'));
95 // Store this in case we need it
96 common_ensure_session();
97 $_SESSION['invitecode'] = $this->code;
106 * @return string title
111 if ($this->registered) {
112 return _('Registration successful');
114 return _('Register');
119 * Handle input, produce output
121 * Switches on request method; either shows the form or handles its input.
123 * Checks if registration is closed and shows an error if so.
125 * @param array $args $_REQUEST data
130 function handle($args)
132 parent::handle($args);
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();
145 function showScripts()
147 parent::showScripts();
148 $this->autofocus('nickname');
152 * Try to register a user
154 * Validates the input and tries to save a new user and profile
155 * record. On success, shows an instructions page.
160 function tryRegister()
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.'));
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');
177 // We don't trim these... whitespace is OK in a password!
178 $password = $this->arg('password');
179 $confirm = $this->arg('confirm');
181 // invitation code, if any
182 $code = $this->trimmed('code');
185 $invite = Invitation::staticGet($code);
188 if (common_config('site', 'inviteonly') && !($code && $invite)) {
189 $this->clientError(_('Sorry, only invited people can register.'));
194 $nickname = common_canonical_nickname($nickname);
195 $email = common_canonical_email($email);
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,
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.'));
219 } else if (!is_null($fullname) && mb_strlen($fullname) > 255) {
220 $this->showForm(_('Full name is too long (max 255 chars).'));
222 } else if (Profile::bioTooLong($bio)) {
223 $this->showForm(sprintf(_('Bio is too long (max %d chars).'),
226 } else if (!is_null($location) && mb_strlen($location) > 255) {
227 $this->showForm(_('Location is too long (max 255 chars).'));
229 } else if (strlen($password) < 6) {
230 $this->showForm(_('Password must be 6 or more characters.'));
232 } else if ($password != $confirm) {
233 $this->showForm(_('Passwords don\'t match.'));
234 } else if ($user = User::register(array('nickname' => $nickname,
235 'password' => $password,
237 'fullname' => $fullname,
238 'homepage' => $homepage,
240 'location' => $location,
243 $this->showForm(_('Invalid username or password.'));
247 if (!common_set_user($user)) {
248 $this->serverError(_('Error setting user.'));
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);
258 Event::handle('EndRegistrationTry', array($this));
260 // Re-init language env in case it changed (not yet, but soon)
261 common_init_language();
263 $this->showSuccess();
265 $this->showForm(_('Invalid username or password.'));
271 * Does the given nickname already exist?
273 * Checks a canonical nickname against the database.
275 * @param string $nickname nickname to check
277 * @return boolean true if the nickname already exists
280 function nicknameExists($nickname)
282 $user = User::staticGet('nickname', $nickname);
283 return is_object($user);
287 * Does the given email address already exist?
289 * Checks a canonical email address against the database.
291 * @param string $email email address to check
293 * @return boolean true if the address already exists
296 function emailExists($email)
298 $email = common_canonical_email($email);
299 if (!$email || strlen($email) == 0) {
302 $user = User::staticGet('email', $email);
303 return is_object($user);
306 // overrrided to add entry-title class
307 function showPageTitle() {
308 if (Event::handle('StartShowPageTitle', array($this))) {
309 $this->element('h1', array('class' => 'entry-title'), $this->title());
313 // overrided to add hentry, and content-inner class
314 function showContentBlock()
316 $this->elementStart('div', array('id' => 'content', 'class' => 'hentry'));
317 $this->showPageTitle();
318 $this->showPageNoticeBlock();
319 $this->elementStart('div', array('id' => 'content_inner',
320 'class' => 'entry-content'));
321 // show the actual content (forms, lists, whatever)
322 $this->showContent();
323 $this->elementEnd('div');
324 $this->elementEnd('div');
328 * Instructions or a notice for the page
330 * Shows the error, if any, or instructions for registration.
335 function showPageNotice()
337 if ($this->registered) {
339 } else if ($this->error) {
340 $this->element('p', 'error', $this->error);
343 common_markup_to_html(_('With this form you can create '.
345 'You can then post notices and '.
346 'link up to friends and colleagues. '));
348 $this->elementStart('div', 'instructions');
350 $this->elementEnd('div');
355 * Wrapper for showing a page
357 * Stores an error and shows the page
359 * @param string $error Error, if any
364 function showForm($error=null)
366 $this->error = $error;
371 * Show the page content
373 * Either shows the registration form or, if registration was successful,
374 * instructions for using the site.
379 function showContent()
381 if ($this->registered) {
382 $this->showSuccessContent();
384 $this->showFormContent();
389 * Show the registration form
394 function showFormContent()
396 $code = $this->trimmed('code');
401 $invite = Invitation::staticGet($code);
404 if (common_config('site', 'inviteonly') && !($code && $invite)) {
405 $this->clientError(_('Sorry, only invited people can register.'));
409 $this->elementStart('form', array('method' => 'post',
410 'id' => 'form_register',
411 'class' => 'form_settings',
412 'action' => common_local_url('register')));
413 $this->elementStart('fieldset');
414 $this->element('legend', null, 'Account settings');
415 $this->hidden('token', common_session_token());
418 $this->hidden('code', $this->code);
421 $this->elementStart('ul', 'form_data');
422 if (Event::handle('StartRegistrationFormData', array($this))) {
423 $this->elementStart('li');
424 $this->input('nickname', _('Nickname'), $this->trimmed('nickname'),
425 _('1-64 lowercase letters or numbers, '.
426 'no punctuation or spaces. Required.'));
427 $this->elementEnd('li');
428 $this->elementStart('li');
429 $this->password('password', _('Password'),
430 _('6 or more characters. Required.'));
431 $this->elementEnd('li');
432 $this->elementStart('li');
433 $this->password('confirm', _('Confirm'),
434 _('Same as password above. Required.'));
435 $this->elementEnd('li');
436 $this->elementStart('li');
437 if ($this->invite && $this->invite->address_type == 'email') {
438 $this->input('email', _('Email'), $this->invite->address,
439 _('Used only for updates, announcements, '.
440 'and password recovery'));
442 $this->input('email', _('Email'), $this->trimmed('email'),
443 _('Used only for updates, announcements, '.
444 'and password recovery'));
446 $this->elementEnd('li');
447 $this->elementStart('li');
448 $this->input('fullname', _('Full name'),
449 $this->trimmed('fullname'),
450 _('Longer name, preferably your "real" name'));
451 $this->elementEnd('li');
452 $this->elementStart('li');
453 $this->input('homepage', _('Homepage'),
454 $this->trimmed('homepage'),
455 _('URL of your homepage, blog, '.
456 'or profile on another site'));
457 $this->elementEnd('li');
458 $this->elementStart('li');
459 $maxBio = Profile::maxBio();
461 $bioInstr = sprintf(_('Describe yourself and your interests in %d chars'),
464 $bioInstr = _('Describe yourself and your interests');
466 $this->textarea('bio', _('Bio'),
467 $this->trimmed('bio'),
469 $this->elementEnd('li');
470 $this->elementStart('li');
471 $this->input('location', _('Location'),
472 $this->trimmed('location'),
473 _('Where you are, like "City, '.
474 'State (or Region), Country"'));
475 $this->elementEnd('li');
476 Event::handle('EndRegistrationFormData', array($this));
477 $this->elementStart('li', array('id' => 'settings_rememberme'));
478 $this->checkbox('rememberme', _('Remember me'),
479 $this->boolean('rememberme'),
480 _('Automatically login in the future; '.
481 'not for shared computers!'));
482 $this->elementEnd('li');
483 $attrs = array('type' => 'checkbox',
485 'class' => 'checkbox',
488 if ($this->boolean('license')) {
489 $attrs['checked'] = 'checked';
491 $this->elementStart('li');
492 $this->element('input', $attrs);
493 $this->elementStart('label', array('class' => 'checkbox', 'for' => 'license'));
494 $this->text(_('My text and files are available under '));
495 $this->element('a', array('href' => common_config('license', 'url')),
496 common_config('license', 'title'), _("Creative Commons Attribution 3.0"));
497 $this->text(_(' except this private data: password, '.
498 'email address, IM address, and phone number.'));
499 $this->elementEnd('label');
500 $this->elementEnd('li');
502 $this->elementEnd('ul');
503 $this->submit('submit', _('Register'));
504 $this->elementEnd('fieldset');
505 $this->elementEnd('form');
509 * Show some information about registering for the site
511 * Save the registration flag, run showPage
516 function showSuccess()
518 $this->registered = true;
523 * Show some information about registering for the site
525 * Gives some information and options for new registrees.
530 function showSuccessContent()
532 $nickname = $this->arg('nickname');
534 $profileurl = common_local_url('showstream',
535 array('nickname' => $nickname));
537 $this->elementStart('div', 'success');
538 $instr = sprintf(_('Congratulations, %1$s! And welcome to %%%%site.name%%%%. '.
539 'From here, you may want to...'. "\n\n" .
540 '* Go to [your profile](%2$s) '.
541 'and post your first message.' . "\n" .
542 '* Add a [Jabber/GTalk address]'.
543 '(%%%%action.imsettings%%%%) '.
544 'so you can send notices '.
545 'through instant messages.' . "\n" .
546 '* [Search for people](%%%%action.peoplesearch%%%%) '.
547 'that you may know or '.
548 'that share your interests. ' . "\n" .
549 '* Update your [profile settings]'.
550 '(%%%%action.profilesettings%%%%)'.
551 ' to tell others more about you. ' . "\n" .
552 '* Read over the [online docs](%%%%doc.help%%%%)'.
553 ' for features you may have missed. ' . "\n\n" .
554 'Thanks for signing up and we hope '.
555 'you enjoy using this service.'),
556 $nickname, $profileurl);
558 $this->raw(common_markup_to_html($instr));
560 $have_email = $this->trimmed('email');
562 $emailinstr = _('(You should receive a message by email '.
563 'momentarily, with ' .
564 'instructions on how to confirm '.
565 'your email address.)');
566 $this->raw(common_markup_to_html($emailinstr));
568 $this->elementEnd('div');
572 * Show the login group nav menu
577 function showLocalNav()
579 $nav = new LoginGroupNav($this);