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         $location = '';
 284         if (!empty($sreg['country'])) {
 285             if ($sreg['postcode']) {
 286                 # XXX: use postcode to get city and region
 287                 # XXX: also, store postcode somewhere -- it's valuable!
 288                 $location = $sreg['postcode'] . ', ' . $sreg['country'];
 289             } else {
 290                 $location = $sreg['country'];
 291             }
 292         }
 293
 294         if (!empty($sreg['fullname']) && mb_strlen($sreg['fullname']) <= 255) {
 295             $fullname = $sreg['fullname'];
 296         } else {
 297             $fullname = '';
 298         }
 299
 300         if (!empty($sreg['email']) && Validate::email($sreg['email'], common_config('email', 'check_domain'))) {
 301             $email = $sreg['email'];
 302         } else {
 303             $email = '';
 304         }
 305
 306         # XXX: add language
 307         # XXX: add timezone
 308
 309         $args = array('nickname' => $nickname,
 310                       'email' => $email,
 311                       'fullname' => $fullname,
 312                       'location' => $location);
 313
 314         if (!empty($invite)) {
 315             $args['code'] = $invite->code;
 316         }
 317
 318         $user = User::register($args);
 319
 320         $result = oid_link_user($user->id, $canonical, $display);
 321
 322         oid_set_last($display);
 323         common_set_user($user);
 324         common_real_login(true);
 325         if (isset($_SESSION['openid_rememberme']) && $_SESSION['openid_rememberme']) {
 326             common_rememberme($user);
 327         }
 328         unset($_SESSION['openid_rememberme']);
 329         common_redirect(common_local_url('showstream', array('nickname' => $user->nickname)),
 330                         303);
 331     }
 332
 333     function connectUser()
 334     {
 335         $nickname = $this->trimmed('nickname');
 336         $password = $this->trimmed('password');
 337
 338         if (!common_check_user($nickname, $password)) {
 339             $this->showForm(_m('Invalid username or password.'));
 340             return;
 341         }
 342
 343         # They're legit!
 344
 345         $user = User::staticGet('nickname', $nickname);
 346
 347         list($display, $canonical, $sreg) = $this->getSavedValues();
 348
 349         if (!$display || !$canonical) {
 350             $this->serverError(_m('Stored OpenID not found.'));
 351             return;
 352         }
 353
 354         $result = oid_link_user($user->id, $canonical, $display);
 355
 356         if (!$result) {
 357             $this->serverError(_m('Error connecting user to OpenID.'));
 358             return;
 359         }
 360
 361         oid_update_user($user, $sreg);
 362         oid_set_last($display);
 363         common_set_user($user);
 364         common_real_login(true);
 365         if (isset($_SESSION['openid_rememberme']) && $_SESSION['openid_rememberme']) {
 366             common_rememberme($user);
 367         }
 368         unset($_SESSION['openid_rememberme']);
 369         $this->goHome($user->nickname);
 370     }
 371
 372     function goHome($nickname)
 373     {
 374         $url = common_get_returnto();
 375         if ($url) {
 376             # We don't have to return to it again
 377             common_set_returnto(null);
 378             $url = common_inject_session($url);
 379         } else {
 380             $url = common_local_url('all',
 381                                     array('nickname' =>
 382                                           $nickname));
 383         }
 384         common_redirect($url, 303);
 385     }
 386
 387     function bestNewNickname($display, $sreg)
 388     {
 389
 390         # Try the passed-in nickname
 391
 392         if (!empty($sreg['nickname'])) {
 393             $nickname = $this->nicknamize($sreg['nickname']);
 394             if ($this->isNewNickname($nickname)) {
 395                 return $nickname;
 396             }
 397         }
 398
 399         # Try the full name
 400
 401         if (!empty($sreg['fullname'])) {
 402             $fullname = $this->nicknamize($sreg['fullname']);
 403             if ($this->isNewNickname($fullname)) {
 404                 return $fullname;
 405             }
 406         }
 407
 408         # Try the URL
 409
 410         $from_url = $this->openidToNickname($display);
 411
 412         if ($from_url && $this->isNewNickname($from_url)) {
 413             return $from_url;
 414         }
 415
 416         # XXX: others?
 417
 418         return null;
 419     }
 420
 421     function isNewNickname($str)
 422     {
 423         if (!Validate::string($str, array('min_length' => 1,
 424                                           'max_length' => 64,
 425                                           'format' => NICKNAME_FMT))) {
 426             return false;
 427         }
 428         if (!User::allowed_nickname($str)) {
 429             return false;
 430         }
 431         if (User::staticGet('nickname', $str)) {
 432             return false;
 433         }
 434         return true;
 435     }
 436
 437     function openidToNickname($openid)
 438     {
 439         if (Auth_Yadis_identifierScheme($openid) == 'XRI') {
 440             return $this->xriToNickname($openid);
 441         } else {
 442             return $this->urlToNickname($openid);
 443         }
 444     }
 445
 446     # We try to use an OpenID URL as a legal StatusNet user name in this order
 447     # 1. Plain hostname, like http://evanp.myopenid.com/
 448     # 2. One element in path, like http://profile.typekey.com/EvanProdromou/
 449     #    or http://getopenid.com/evanprodromou
 450
 451     function urlToNickname($openid)
 452     {
 453         return common_url_to_nickname($openid);
 454     }
 455
 456     function xriToNickname($xri)
 457     {
 458         $base = $this->xriBase($xri);
 459
 460         if (!$base) {
 461             return null;
 462         } else {
 463             # =evan.prodromou
 464             # or @gratis*evan.prodromou
 465             $parts = explode('*', substr($base, 1));
 466             return $this->nicknamize(array_pop($parts));
 467         }
 468     }
 469
 470     function xriBase($xri)
 471     {
 472         if (substr($xri, 0, 6) == 'xri://') {
 473             return substr($xri, 6);
 474         } else {
 475             return $xri;
 476         }
 477     }
 478
 479     # Given a string, try to make it work as a nickname
 480
 481     function nicknamize($str)
 482     {
 483         return common_nicknamize($str);
 484     }
 485 }