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