3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2008, 2009, StatusNet, Inc.
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Affero General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Affero General Public License for more details.
16 * You should have received a copy of the GNU Affero General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 if (!defined('STATUSNET')) {
24 require_once INSTALLDIR.'/plugins/OpenID/openid.php';
26 class FinishopenidloginAction extends Action
32 function handle($args)
34 parent::handle($args);
35 if (common_is_real_login()) {
36 // TRANS: Client error message trying to log on with OpenID while already logged on.
37 $this->clientError(_m('Already logged in.'));
38 } else if ($_SERVER['REQUEST_METHOD'] == 'POST') {
39 $token = $this->trimmed('token');
40 if (!$token || $token != common_session_token()) {
41 // TRANS: Message given when there is a problem with the user's session token.
42 $this->showForm(_m('There was a problem with your session token. Try again, please.'));
45 if ($this->arg('create')) {
46 if (!$this->boolean('license')) {
47 // TRANS: Message given if user does not agree with the site's license.
48 $this->showForm(_m('You can\'t register if you don\'t agree to the license.'),
49 $this->trimmed('newname'));
52 $this->createNewUser();
53 } else if ($this->arg('connect')) {
56 // TRANS: Messag given on an unknown error.
57 $this->showForm(_m('An unknown error has occured.'),
58 $this->trimmed('newname'));
65 function showPageNotice()
68 $this->element('div', array('class' => 'error'), $this->error);
70 $this->element('div', 'instructions',
71 // TRANS: Instructions given after a first successful logon using OpenID.
72 // TRANS: %s is the site name.
73 sprintf(_m('This is the first time you\'ve logged into %s so we must connect your OpenID to a local account. You can either create a new account, or connect with your existing account, if you have one.'), common_config('site', 'name')));
80 return _m('OpenID Account Setup');
83 function showForm($error=null, $username=null)
85 $this->error = $error;
86 $this->username = $username;
92 * @fixme much of this duplicates core code, which is very fragile.
93 * Should probably be replaced with an extensible mini version of
94 * the core registration form.
96 function showContent()
98 if (!empty($this->message_text)) {
99 $this->element('div', array('class' => 'error'), $this->message_text);
103 // We don't recognize this OpenID, so we're going to give the user
104 // two options, each in its own mini-form.
106 // First, they can create a new account using their OpenID auth
107 // info. The profile will be pre-populated with whatever name,
108 // email, and location we can get from the OpenID provider, so
109 // all we ask for is the license confirmation.
110 $this->elementStart('form', array('method' => 'post',
111 'id' => 'account_create',
112 'class' => 'form_settings',
113 'action' => common_local_url('finishopenidlogin')));
114 $this->hidden('token', common_session_token());
115 $this->elementStart('fieldset', array('id' => 'form_openid_createaccount'));
116 $this->element('legend', null,
117 _m('Create new account'));
118 $this->element('p', null,
119 _m('Create a new user with this nickname.'));
120 $this->elementStart('ul', 'form_data');
121 $this->elementStart('li');
122 $this->input('newname', _m('New nickname'),
123 ($this->username) ? $this->username : '',
124 _m('1-64 lowercase letters or numbers, no punctuation or spaces'));
125 $this->elementEnd('li');
126 $this->elementStart('li');
127 $this->element('input', array('type' => 'checkbox',
129 'class' => 'checkbox',
132 $this->elementStart('label', array('for' => 'license',
133 'class' => 'checkbox'));
134 // TRANS: OpenID plugin link text.
135 // TRANS: %s is a link to a licese with the license name as link text.
136 $message = _('My text and files are available under %s ' .
137 'except this private data: password, ' .
138 'email address, IM address, and phone number.');
139 $link = '<a href="' .
140 htmlspecialchars(common_config('license', 'url')) .
142 htmlspecialchars(common_config('license', 'title')) .
144 $this->raw(sprintf(htmlspecialchars($message), $link));
145 $this->elementEnd('label');
146 $this->elementEnd('li');
147 $this->elementEnd('ul');
148 // TRANS: Button label in form in which to create a new user on the site for an OpenID.
149 $this->submit('create', _m('BUTTON', 'Create'));
150 $this->elementEnd('fieldset');
151 $this->elementEnd('form');
153 // The second option is to attach this OpenID to an existing account
154 // on the local system, which they need to provide a password for.
155 $this->elementStart('form', array('method' => 'post',
156 'id' => 'account_connect',
157 'class' => 'form_settings',
158 'action' => common_local_url('finishopenidlogin')));
159 $this->hidden('token', common_session_token());
160 $this->elementStart('fieldset', array('id' => 'form_openid_createaccount'));
161 $this->element('legend', null,
162 // TRANS: Used as form legend for form in which to connect an OpenID to an existing user on the site.
163 _m('Connect existing account'));
164 $this->element('p', null,
165 // TRANS: User instructions for form in which to connect an OpenID to an existing user on the site.
166 _m('If you already have an account, login with your username and password to connect it to your OpenID.'));
167 $this->elementStart('ul', 'form_data');
168 $this->elementStart('li');
169 // TRANS: Field label in form in which to connect an OpenID to an existing user on the site.
170 $this->input('nickname', _m('Existing nickname'));
171 $this->elementEnd('li');
172 $this->elementStart('li');
173 // TRANS: Field label in form in which to connect an OpenID to an existing user on the site.
174 $this->password('password', _m('Password'));
175 $this->elementEnd('li');
176 $this->elementEnd('ul');
177 // TRANS: Button label in form in which to connect an OpenID to an existing user on the site.
178 $this->submit('connect', _m('BUTTON', 'Connect'));
179 $this->elementEnd('fieldset');
180 $this->elementEnd('form');
185 $consumer = oid_consumer();
187 $response = $consumer->complete(common_local_url('finishopenidlogin'));
189 if ($response->status == Auth_OpenID_CANCEL) {
190 // TRANS: Status message in case the response from the OpenID provider is that the logon attempt was cancelled.
191 $this->message(_m('OpenID authentication cancelled.'));
193 } else if ($response->status == Auth_OpenID_FAILURE) {
194 // TRANS: OpenID authentication failed; display the error message. %s is the error message.
195 $this->message(sprintf(_m('OpenID authentication failed: %s'), $response->message));
196 } else if ($response->status == Auth_OpenID_SUCCESS) {
197 // This means the authentication succeeded; extract the
198 // identity URL and Simple Registration data (if it was
200 $display = $response->getDisplayIdentifier();
201 $canonical = ($response->endpoint->canonicalID) ?
202 $response->endpoint->canonicalID : $response->getDisplayIdentifier();
204 oid_assert_allowed($display);
205 oid_assert_allowed($canonical);
207 $sreg_resp = Auth_OpenID_SRegResponse::fromSuccessResponse($response);
210 $sreg = $sreg_resp->contents();
213 // Launchpad teams extension
214 if (!oid_check_teams($response)) {
215 $this->message(_m('OpenID authentication aborted: you are not allowed to login to this site.'));
219 $user = oid_get_user($canonical);
222 oid_set_last($display);
223 # XXX: commented out at @edd's request until better
224 # control over how data flows from OpenID provider.
225 # oid_update_user($user, $sreg);
226 common_set_user($user);
227 common_real_login(true);
228 if (isset($_SESSION['openid_rememberme']) && $_SESSION['openid_rememberme']) {
229 common_rememberme($user);
231 unset($_SESSION['openid_rememberme']);
232 $this->goHome($user->nickname);
234 $this->saveValues($display, $canonical, $sreg);
235 $this->showForm(null, $this->bestNewNickname($display, $sreg));
240 function message($msg)
242 $this->message_text = $msg;
246 function saveValues($display, $canonical, $sreg)
248 common_ensure_session();
249 $_SESSION['openid_display'] = $display;
250 $_SESSION['openid_canonical'] = $canonical;
251 $_SESSION['openid_sreg'] = $sreg;
254 function getSavedValues()
256 return array($_SESSION['openid_display'],
257 $_SESSION['openid_canonical'],
258 $_SESSION['openid_sreg']);
261 function createNewUser()
263 # FIXME: save invite code before redirect, and check here
265 if (!Event::handle('StartRegistrationTry', array($this))) {
269 if (common_config('site', 'closed')) {
270 // TRANS: OpenID plugin message. No new user registration is allowed on the site.
271 $this->clientError(_m('Registration not allowed.'));
277 if (common_config('site', 'inviteonly')) {
278 $code = $_SESSION['invitecode'];
280 // TRANS: OpenID plugin message. No new user registration is allowed on the site without an invitation code, and none was provided.
281 $this->clientError(_m('Registration not allowed.'));
285 $invite = Invitation::staticGet($code);
287 if (empty($invite)) {
288 // TRANS: OpenID plugin message. No new user registration is allowed on the site without an invitation code, and the one provided was not valid.
289 $this->clientError(_m('Not a valid invitation code.'));
295 $nickname = Nickname::normalize($this->trimmed('newname'));
296 } catch (NicknameException $e) {
297 $this->showForm($e->getMessage());
301 if (!User::allowed_nickname($nickname)) {
302 // TRANS: OpenID plugin message. The entered new user name is blacklisted.
303 $this->showForm(_m('Nickname not allowed.'));
307 if (User::staticGet('nickname', $nickname)) {
308 // TRANS: OpenID plugin message. The entered new user name is already used.
309 $this->showForm(_m('Nickname already in use. Try another one.'));
313 list($display, $canonical, $sreg) = $this->getSavedValues();
315 if (!$display || !$canonical) {
316 // TRANS: OpenID plugin server error. A stored OpenID cannot be retrieved.
317 $this->serverError(_m('Stored OpenID not found.'));
321 # Possible race condition... let's be paranoid
323 $other = oid_get_user($canonical);
326 // TRANS: OpenID plugin server error.
327 $this->serverError(_m('Creating new account for OpenID that already has a user.'));
331 Event::handle('StartOpenIDCreateNewUser', array($canonical, &$sreg));
334 if (!empty($sreg['country'])) {
335 if ($sreg['postcode']) {
336 # XXX: use postcode to get city and region
337 # XXX: also, store postcode somewhere -- it's valuable!
338 $location = $sreg['postcode'] . ', ' . $sreg['country'];
340 $location = $sreg['country'];
344 if (!empty($sreg['fullname']) && mb_strlen($sreg['fullname']) <= 255) {
345 $fullname = $sreg['fullname'];
350 if (!empty($sreg['email']) && Validate::email($sreg['email'], common_config('email', 'check_domain'))) {
351 $email = $sreg['email'];
359 $args = array('nickname' => $nickname,
361 'fullname' => $fullname,
362 'location' => $location);
364 if (!empty($invite)) {
365 $args['code'] = $invite->code;
368 $user = User::register($args);
370 $result = oid_link_user($user->id, $canonical, $display);
372 Event::handle('EndOpenIDCreateNewUser', array($user, $canonical, $sreg));
374 oid_set_last($display);
375 common_set_user($user);
376 common_real_login(true);
377 if (isset($_SESSION['openid_rememberme']) && $_SESSION['openid_rememberme']) {
378 common_rememberme($user);
380 unset($_SESSION['openid_rememberme']);
382 Event::handle('EndRegistrationTry', array($this));
384 common_redirect(common_local_url('showstream', array('nickname' => $user->nickname)),
388 function connectUser()
390 $nickname = $this->trimmed('nickname');
391 $password = $this->trimmed('password');
393 if (!common_check_user($nickname, $password)) {
394 // TRANS: OpenID plugin message.
395 $this->showForm(_m('Invalid username or password.'));
401 $user = User::staticGet('nickname', $nickname);
403 list($display, $canonical, $sreg) = $this->getSavedValues();
405 if (!$display || !$canonical) {
406 // TRANS: OpenID plugin server error. A stored OpenID cannot be found.
407 $this->serverError(_m('Stored OpenID not found.'));
411 $result = oid_link_user($user->id, $canonical, $display);
414 // TRANS: OpenID plugin server error. The user or user profile could not be saved.
415 $this->serverError(_m('Error connecting user to OpenID.'));
419 if (Event::handle('StartOpenIDUpdateUser', array($user, $canonical, &$sreg))) {
420 oid_update_user($user, $sreg);
422 Event::handle('EndOpenIDUpdateUser', array($user, $canonical, $sreg));
424 oid_set_last($display);
425 common_set_user($user);
426 common_real_login(true);
427 if (isset($_SESSION['openid_rememberme']) && $_SESSION['openid_rememberme']) {
428 common_rememberme($user);
430 unset($_SESSION['openid_rememberme']);
431 $this->goHome($user->nickname);
434 function goHome($nickname)
436 $url = common_get_returnto();
438 # We don't have to return to it again
439 common_set_returnto(null);
440 $url = common_inject_session($url);
442 $url = common_local_url('all',
446 common_redirect($url, 303);
449 function bestNewNickname($display, $sreg)
452 # Try the passed-in nickname
454 if (!empty($sreg['nickname'])) {
455 $nickname = $this->nicknamize($sreg['nickname']);
456 if ($this->isNewNickname($nickname)) {
463 if (!empty($sreg['fullname'])) {
464 $fullname = $this->nicknamize($sreg['fullname']);
465 if ($this->isNewNickname($fullname)) {
472 $from_url = $this->openidToNickname($display);
474 if ($from_url && $this->isNewNickname($from_url)) {
483 function isNewNickname($str)
485 if (!Nickname::isValid($str)) {
488 if (!User::allowed_nickname($str)) {
491 if (User::staticGet('nickname', $str)) {
497 function openidToNickname($openid)
499 if (Auth_Yadis_identifierScheme($openid) == 'XRI') {
500 return $this->xriToNickname($openid);
502 return $this->urlToNickname($openid);
506 # We try to use an OpenID URL as a legal StatusNet user name in this order
507 # 1. Plain hostname, like http://evanp.myopenid.com/
508 # 2. One element in path, like http://profile.typekey.com/EvanProdromou/
509 # or http://getopenid.com/evanprodromou
511 function urlToNickname($openid)
513 return common_url_to_nickname($openid);
516 function xriToNickname($xri)
518 $base = $this->xriBase($xri);
524 # or @gratis*evan.prodromou
525 $parts = explode('*', substr($base, 1));
526 return $this->nicknamize(array_pop($parts));
530 function xriBase($xri)
532 if (substr($xri, 0, 6) == 'xri://') {
533 return substr($xri, 6);
539 # Given a string, try to make it work as a nickname
541 function nicknamize($str)
543 return common_nicknamize($str);