plugins/OpenID/finishopenidlogin.php

   1 <?php
   2 /*
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2008, 2009, StatusNet, Inc.
   5  *
   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.
  10  *
  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.
  15  *
  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/>.
  18  */
  19
  20 if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
  21
  22 require_once INSTALLDIR.'/plugins/OpenID/openid.php';
  23
  24 class FinishopenidloginAction extends Action
  25 {
  26     var $error = null;
  27     var $username = null;
  28     var $message = null;
  29
  30     function handle($args)
  31     {
  32         parent::handle($args);
  33         if (common_is_real_login()) {
  34             $this->clientError(_m('Already logged in.'));
  35         } else if ($_SERVER['REQUEST_METHOD'] == 'POST') {
  36             $token = $this->trimmed('token');
  37             if (!$token || $token != common_session_token()) {
  38                 $this->showForm(_m('There was a problem with your session token. Try again, please.'));
  39                 return;
  40             }
  41             if ($this->arg('create')) {
  42                 if (!$this->boolean('license')) {
  43                     $this->showForm(_m('You can\'t register if you don\'t agree to the license.'),
  44                                     $this->trimmed('newname'));
  45                     return;
  46                 }
  47                 $this->createNewUser();
  48             } else if ($this->arg('connect')) {
  49                 $this->connectUser();
  50             } else {
  51                 $this->showForm(_m('Something weird happened.'),
  52                                 $this->trimmed('newname'));
  53             }
  54         } else {
  55             $this->tryLogin();
  56         }
  57     }
  58
  59     function showPageNotice()
  60     {
  61         if ($this->error) {
  62             $this->element('div', array('class' => 'error'), $this->error);
  63         } else {
  64             $this->element('div', 'instructions',
  65                            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')));
  66         }
  67     }
  68
  69     function title()
  70     {
  71         return _m('OpenID Account Setup');
  72     }
  73
  74     function showForm($error=null, $username=null)
  75     {
  76         $this->error = $error;
  77         $this->username = $username;
  78
  79         $this->showPage();
  80     }
  81
  82     /**
  83      * @fixme much of this duplicates core code, which is very fragile.
  84      * Should probably be replaced with an extensible mini version of
  85      * the core registration form.
  86      */
  87     function showContent()
  88     {
  89         if (!empty($this->message_text)) {
  90             $this->element('div', array('class' => 'error'), $this->message_text);
  91             return;
  92         }
  93
  94         $this->elementStart('form', array('method' => 'post',
  95                                           'id' => 'account_connect',
  96                                           'class' => 'form_settings',
  97                                           'action' => common_local_url('finishopenidlogin')));
  98         $this->hidden('token', common_session_token());
  99         $this->elementStart('fieldset', array('id' => 'form_openid_createaccount'));
 100         $this->element('legend', null,
 101                        _m('Create new account'));
 102         $this->element('p', null,
 103                        _m('Create a new user with this nickname.'));
 104         $this->elementStart('ul', 'form_data');
 105         $this->elementStart('li');
 106         $this->input('newname', _m('New nickname'),
 107                      ($this->username) ? $this->username : '',
 108                      _m('1-64 lowercase letters or numbers, no punctuation or spaces'));
 109         $this->elementEnd('li');
 110         $this->elementStart('li');
 111         $this->element('input', array('type' => 'checkbox',
 112                                       'id' => 'license',
 113                                       'class' => 'checkbox',
 114                                       'name' => 'license',
 115                                       'value' => 'true'));
 116         $this->elementStart('label', array('for' => 'license',
 117                                           'class' => 'checkbox'));
 118         $message = _('My text and files are available under %s ' .
 119                      'except this private data: password, ' .
 120                      'email address, IM address, and phone number.');
 121         $link = '<a href="' .
 122                 htmlspecialchars(common_config('license', 'url')) .
 123                 '">' .
 124                 htmlspecialchars(common_config('license', 'title')) .
 125                 '</a>';
 126         $this->raw(sprintf(htmlspecialchars($message), $link));
 127         $this->elementEnd('label');
 128         $this->elementEnd('li');
 129         $this->elementEnd('ul');
 130         $this->submit('create', _m('Create'));
 131         $this->elementEnd('fieldset');
 132
 133         $this->elementStart('fieldset', array('id' => 'form_openid_createaccount'));
 134         $this->element('legend', null,
 135                        _m('Connect existing account'));
 136         $this->element('p', null,
 137                        _m('If you already have an account, login with your username and password to connect it to your OpenID.'));
 138         $this->elementStart('ul', 'form_data');
 139         $this->elementStart('li');
 140         $this->input('nickname', _m('Existing nickname'));
 141         $this->elementEnd('li');
 142         $this->elementStart('li');
 143         $this->password('password', _m('Password'));
 144         $this->elementEnd('li');
 145         $this->elementEnd('ul');
 146         $this->submit('connect', _m('Connect'));
 147         $this->elementEnd('fieldset');
 148         $this->elementEnd('form');
 149     }
 150
 151     function tryLogin()
 152     {
 153         $consumer = oid_consumer();
 154
 155         $response = $consumer->complete(common_local_url('finishopenidlogin'));
 156
 157         if ($response->status == Auth_OpenID_CANCEL) {
 158             $this->message(_m('OpenID authentication cancelled.'));
 159             return;
 160         } else if ($response->status == Auth_OpenID_FAILURE) {
 161             // Authentication failed; display the error message.
 162             $this->message(sprintf(_m('OpenID authentication failed: %s'), $response->message));
 163         } else if ($response->status == Auth_OpenID_SUCCESS) {
 164             // This means the authentication succeeded; extract the
 165             // identity URL and Simple Registration data (if it was
 166             // returned).
 167             $display = $response->getDisplayIdentifier();
 168             $canonical = ($response->endpoint->canonicalID) ?
 169               $response->endpoint->canonicalID : $response->getDisplayIdentifier();
 170
 171             oid_assert_allowed($display);
 172             oid_assert_allowed($canonical);
 173
 174             $sreg_resp = Auth_OpenID_SRegResponse::fromSuccessResponse($response);
 175
 176             if ($sreg_resp) {
 177                 $sreg = $sreg_resp->contents();
 178             }
 179
 180             $user = oid_get_user($canonical);
 181
 182             if ($user) {
 183                 oid_set_last($display);
 184                 # XXX: commented out at @edd's request until better
 185                 # control over how data flows from OpenID provider.
 186                 # oid_update_user($user, $sreg);
 187                 common_set_user($user);
 188                 common_real_login(true);
 189                 if (isset($_SESSION['openid_rememberme']) && $_SESSION['openid_rememberme']) {
 190                     common_rememberme($user);
 191                 }
 192                 unset($_SESSION['openid_rememberme']);
 193                 $this->goHome($user->nickname);
 194             } else {
 195                 $this->saveValues($display, $canonical, $sreg);
 196                 $this->showForm(null, $this->bestNewNickname($display, $sreg));
 197             }
 198         }
 199     }
 200
 201     function message($msg)
 202     {
 203         $this->message_text = $msg;
 204         $this->showPage();
 205     }
 206
 207     function saveValues($display, $canonical, $sreg)
 208     {
 209         common_ensure_session();
 210         $_SESSION['openid_display'] = $display;
 211         $_SESSION['openid_canonical'] = $canonical;
 212         $_SESSION['openid_sreg'] = $sreg;
 213     }
 214
 215     function getSavedValues()
 216     {
 217         return array($_SESSION['openid_display'],
 218                      $_SESSION['openid_canonical'],
 219                      $_SESSION['openid_sreg']);
 220     }
 221
 222     function createNewUser()
 223     {
 224         # FIXME: save invite code before redirect, and check here
 225
 226         if (common_config('site', 'closed')) {
 227             $this->clientError(_m('Registration not allowed.'));
 228             return;
 229         }
 230
 231         $invite = null;
 232
 233         if (common_config('site', 'inviteonly')) {
 234             $code = $_SESSION['invitecode'];
 235             if (empty($code)) {
 236                 $this->clientError(_m('Registration not allowed.'));
 237                 return;
 238             }
 239
 240             $invite = Invitation::staticGet($code);
 241
 242             if (empty($invite)) {
 243                 $this->clientError(_m('Not a valid invitation code.'));
 244                 return;
 245             }
 246         }
 247
 248         $nickname = $this->trimmed('newname');
 249
 250         if (!Validate::string($nickname, array('min_length' => 1,
 251                                                'max_length' => 64,
 252                                                'format' => NICKNAME_FMT))) {
 253             $this->showForm(_m('Nickname must have only lowercase letters and numbers and no spaces.'));
 254             return;
 255         }
 256
 257         if (!User::allowed_nickname($nickname)) {
 258             $this->showForm(_m('Nickname not allowed.'));
 259             return;
 260         }
 261
 262         if (User::staticGet('nickname', $nickname)) {
 263             $this->showForm(_m('Nickname already in use. Try another one.'));
 264             return;
 265         }
 266
 267         list($display, $canonical, $sreg) = $this->getSavedValues();
 268
 269         if (!$display || !$canonical) {
 270             $this->serverError(_m('Stored OpenID not found.'));
 271             return;
 272         }
 273
 274         # Possible race condition... let's be paranoid
 275
 276         $other = oid_get_user($canonical);
 277
 278         if ($other) {
 279             $this->serverError(_m('Creating new account for OpenID that already has a user.'));
 280             return;
 281         }
 282
 283         Event::handle('StartOpenIDCreateNewUser', array($canonical, &$sreg));
 284
 285         $location = '';
 286         if (!empty($sreg['country'])) {
 287             if ($sreg['postcode']) {
 288                 # XXX: use postcode to get city and region
 289                 # XXX: also, store postcode somewhere -- it's valuable!
 290                 $location = $sreg['postcode'] . ', ' . $sreg['country'];
 291             } else {
 292                 $location = $sreg['country'];
 293             }
 294         }
 295
 296         if (!empty($sreg['fullname']) && mb_strlen($sreg['fullname']) <= 255) {
 297             $fullname = $sreg['fullname'];
 298         } else {
 299             $fullname = '';
 300         }
 301
 302         if (!empty($sreg['email']) && Validate::email($sreg['email'], common_config('email', 'check_domain'))) {
 303             $email = $sreg['email'];
 304         } else {
 305             $email = '';
 306         }
 307
 308         # XXX: add language
 309         # XXX: add timezone
 310
 311         $args = array('nickname' => $nickname,
 312                       'email' => $email,
 313                       'fullname' => $fullname,
 314                       'location' => $location);
 315
 316         if (!empty($invite)) {
 317             $args['code'] = $invite->code;
 318         }
 319
 320         $user = User::register($args);
 321
 322         $result = oid_link_user($user->id, $canonical, $display);
 323
 324         Event::handle('EndOpenIDCreateNewUser', array($user, $canonical, $sreg));
 325
 326         oid_set_last($display);
 327         common_set_user($user);
 328         common_real_login(true);
 329         if (isset($_SESSION['openid_rememberme']) && $_SESSION['openid_rememberme']) {
 330             common_rememberme($user);
 331         }
 332         unset($_SESSION['openid_rememberme']);
 333         common_redirect(common_local_url('showstream', array('nickname' => $user->nickname)),
 334                         303);
 335     }
 336
 337     function connectUser()
 338     {
 339         $nickname = $this->trimmed('nickname');
 340         $password = $this->trimmed('password');
 341
 342         if (!common_check_user($nickname, $password)) {
 343             $this->showForm(_m('Invalid username or password.'));
 344             return;
 345         }
 346
 347         # They're legit!
 348
 349         $user = User::staticGet('nickname', $nickname);
 350
 351         list($display, $canonical, $sreg) = $this->getSavedValues();
 352
 353         if (!$display || !$canonical) {
 354             $this->serverError(_m('Stored OpenID not found.'));
 355             return;
 356         }
 357
 358         $result = oid_link_user($user->id, $canonical, $display);
 359
 360         if (!$result) {
 361             $this->serverError(_m('Error connecting user to OpenID.'));
 362             return;
 363         }
 364
 365         if (Event::handle('StartOpenIDUpdateUser', array($user, $canonical, &$sreg))) {
 366             oid_update_user($user, $sreg);
 367         }
 368         Event::handle('EndOpenIDUpdateUser', array($user, $canonical, $sreg));
 369
 370         oid_set_last($display);
 371         common_set_user($user);
 372         common_real_login(true);
 373         if (isset($_SESSION['openid_rememberme']) && $_SESSION['openid_rememberme']) {
 374             common_rememberme($user);
 375         }
 376         unset($_SESSION['openid_rememberme']);
 377         $this->goHome($user->nickname);
 378     }
 379
 380     function goHome($nickname)
 381     {
 382         $url = common_get_returnto();
 383         if ($url) {
 384             # We don't have to return to it again
 385             common_set_returnto(null);
 386             $url = common_inject_session($url);
 387         } else {
 388             $url = common_local_url('all',
 389                                     array('nickname' =>
 390                                           $nickname));
 391         }
 392         common_redirect($url, 303);
 393     }
 394
 395     function bestNewNickname($display, $sreg)
 396     {
 397
 398         # Try the passed-in nickname
 399
 400         if (!empty($sreg['nickname'])) {
 401             $nickname = $this->nicknamize($sreg['nickname']);
 402             if ($this->isNewNickname($nickname)) {
 403                 return $nickname;
 404             }
 405         }
 406
 407         # Try the full name
 408
 409         if (!empty($sreg['fullname'])) {
 410             $fullname = $this->nicknamize($sreg['fullname']);
 411             if ($this->isNewNickname($fullname)) {
 412                 return $fullname;
 413             }
 414         }
 415
 416         # Try the URL
 417
 418         $from_url = $this->openidToNickname($display);
 419
 420         if ($from_url && $this->isNewNickname($from_url)) {
 421             return $from_url;
 422         }
 423
 424         # XXX: others?
 425
 426         return null;
 427     }
 428
 429     function isNewNickname($str)
 430     {
 431         if (!Validate::string($str, array('min_length' => 1,
 432                                           'max_length' => 64,
 433                                           'format' => NICKNAME_FMT))) {
 434             return false;
 435         }
 436         if (!User::allowed_nickname($str)) {
 437             return false;
 438         }
 439         if (User::staticGet('nickname', $str)) {
 440             return false;
 441         }
 442         return true;
 443     }
 444
 445     function openidToNickname($openid)
 446     {
 447         if (Auth_Yadis_identifierScheme($openid) == 'XRI') {
 448             return $this->xriToNickname($openid);
 449         } else {
 450             return $this->urlToNickname($openid);
 451         }
 452     }
 453
 454     # We try to use an OpenID URL as a legal StatusNet user name in this order
 455     # 1. Plain hostname, like http://evanp.myopenid.com/
 456     # 2. One element in path, like http://profile.typekey.com/EvanProdromou/
 457     #    or http://getopenid.com/evanprodromou
 458
 459     function urlToNickname($openid)
 460     {
 461         return common_url_to_nickname($openid);
 462     }
 463
 464     function xriToNickname($xri)
 465     {
 466         $base = $this->xriBase($xri);
 467
 468         if (!$base) {
 469             return null;
 470         } else {
 471             # =evan.prodromou
 472             # or @gratis*evan.prodromou
 473             $parts = explode('*', substr($base, 1));
 474             return $this->nicknamize(array_pop($parts));
 475         }
 476     }
 477
 478     function xriBase($xri)
 479     {
 480         if (substr($xri, 0, 6) == 'xri://') {
 481             return substr($xri, 6);
 482         } else {
 483             return $xri;
 484         }
 485     }
 486
 487     # Given a string, try to make it work as a nickname
 488
 489     function nicknamize($str)
 490     {
 491         return common_nicknamize($str);
 492     }
 493 }