actions/finishopenidlogin.php

   1 <?php
   2 /*
   3  * Laconica - a distributed open-source microblogging tool
   4  * Copyright (C) 2008, Controlez-Vous, 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('LACONICA')) { exit(1); }
  21
  22 require_once(INSTALLDIR.'/lib/openid.php');
  23
  24 class FinishopenidloginAction extends Action {
  25
  26         function handle($args) {
  27                 parent::handle($args);
  28                 if (common_logged_in()) {
  29                         common_user_error(_t('Already logged in.'));
  30                 } else if ($_SERVER['REQUEST_METHOD'] == 'POST') {
  31                         if ($this->arg('create')) {
  32                                 if (!$this->boolean('license')) {
  33                                         $this->show_form(_t('You can\'t register if you don\'t agree to the license.'),
  34                                                                          $this->trimmed('newname'));
  35                                         return;
  36                                 }
  37                                 $this->create_new_user();
  38                         } else if ($this->arg('connect')) {
  39                                 $this->connect_user();
  40                         } else {
  41                                 common_debug(print_r($this->args, true), __FILE__);
  42                                 $this->show_form(_t('Something weird happened.'),
  43                                                                  $this->trimmed('newname'));
  44                         }
  45                 } else {
  46                         $this->try_login();
  47                 }
  48         }
  49
  50         function show_top($error=NULL) {
  51                 if ($error) {
  52                         common_element('div', array('class' => 'error'), $error);
  53                 } else {
  54                         global $config;
  55                         common_element('div', 'instructions',
  56                                                    _t('This is the first time you\'ve logged into ') .
  57                                                    $config['site']['name'] .
  58                                                    _t(' so we must connect your OpenID to a local account. ' .
  59                                                           ' You can either create a new account, or connect with ' .
  60                                                           ' your existing account, if you have one.'));
  61                 }
  62         }
  63
  64         function show_form($error=NULL, $username=NULL) {
  65                 common_show_header(_t('OpenID Account Setup'), NULL, $error,
  66                                                    array($this, 'show_top'));
  67
  68                 common_element_start('form', array('method' => 'POST',
  69                                                                                    'id' => 'account_connect',
  70                                                                                    'action' => common_local_url('finishopenidlogin')));
  71                 common_element('h2', NULL,
  72                                            'Create new account');
  73                 common_element('p', NULL,
  74                                            _t('Create a new user with this nickname.'));
  75                 common_input('newname', _t('New nickname'),
  76                                          ($username) ? $username : '',
  77                                          _t('1-64 lowercase letters or numbers, no punctuation or spaces'));
  78                 common_element_start('p');
  79                 common_element('input', array('type' => 'checkbox',
  80                                                                           'id' => 'license',
  81                                                                           'name' => 'license',
  82                                                                           'value' => 'true'));
  83                 common_text(_t('My text and files are available under '));
  84                 common_element('a', array(href => common_config('license', 'url')),
  85                                            common_config('license', 'title'));
  86                 common_text(_t(' except this private data: password, email address, IM address, phone number.'));
  87                 common_element_end('p');
  88                 common_submit('create', _t('Create'));
  89                 common_element('h2', NULL,
  90                                            'Connect existing account');
  91                 common_element('p', NULL,
  92                                            _t('If you already have an account, login with your username and password '.
  93                                                   'to connect it to your OpenID.'));
  94                 common_input('nickname', _t('Existing nickname'));
  95                 common_password('password', _t('Password'));
  96                 common_submit('connect', _t('Connect'));
  97                 common_element_end('form');
  98                 common_show_footer();
  99         }
 100
 101         function try_login() {
 102
 103                 $consumer = oid_consumer();
 104
 105                 $response = $consumer->complete(common_local_url('finishopenidlogin'));
 106
 107                 if ($response->status == Auth_OpenID_CANCEL) {
 108                         $this->message(_t('OpenID authentication cancelled.'));
 109                         return;
 110                 } else if ($response->status == Auth_OpenID_FAILURE) {
 111                         // Authentication failed; display the error message.
 112                         $this->message(_t('OpenID authentication failed: ') . $response->message);
 113                 } else if ($response->status == Auth_OpenID_SUCCESS) {
 114                         // This means the authentication succeeded; extract the
 115                         // identity URL and Simple Registration data (if it was
 116                         // returned).
 117                         $display = $response->getDisplayIdentifier();
 118                         $canonical = ($response->endpoint->canonicalID) ?
 119                           $response->endpoint->canonicalID : $response->getDisplayIdentifier();
 120
 121                         $sreg_resp = Auth_OpenID_SRegResponse::fromSuccessResponse($response);
 122
 123                         if ($sreg_resp) {
 124                                 $sreg = $sreg_resp->contents();
 125                         }
 126
 127                         $user = oid_get_user($canonical);
 128
 129                         if ($user) {
 130                                 oid_set_last($display);
 131                                 oid_update_user($user, $sreg);
 132                                 common_set_user($user->nickname);
 133                                 $this->go_home($user->nickname);
 134                         } else {
 135                                 $this->save_values($display, $canonical, $sreg);
 136                                 $this->show_form(NULL, $this->best_new_nickname($display, $sreg));
 137                         }
 138                 }
 139         }
 140
 141         function message($msg) {
 142                 common_show_header(_t('OpenID Login'));
 143                 common_element('p', NULL, $msg);
 144                 common_show_footer();
 145         }
 146
 147         function save_values($display, $canonical, $sreg) {
 148                 common_ensure_session();
 149                 $_SESSION['openid_display'] = $display;
 150                 $_SESSION['openid_canonical'] = $canonical;
 151                 $_SESSION['openid_sreg'] = $sreg;
 152         }
 153
 154         function get_saved_values() {
 155                 return array($_SESSION['openid_display'],
 156                                          $_SESSION['openid_canonical'],
 157                                          $_SESSION['openid_sreg']);
 158         }
 159
 160         function create_new_user() {
 161
 162                 $nickname = $this->trimmed('newname');
 163
 164                 if (!Validate::string($nickname, array('min_length' => 1,
 165                                                                                            'max_length' => 64,
 166                                                                                            'format' => VALIDATE_NUM . VALIDATE_ALPHA_LOWER))) {
 167                         $this->show_form(_t('Nickname must have only letters and numbers and no spaces.'));
 168                         return;
 169                 }
 170
 171                 if (User::staticGet('nickname', $nickname)) {
 172                         $this->show_form(_t('Nickname already in use. Try another one.'));
 173                         return;
 174                 }
 175
 176                 list($display, $canonical, $sreg) = $this->get_saved_values();
 177
 178                 if (!$display || !$canonical) {
 179                         common_server_error(_t('Stored OpenID not found.'));
 180                         return;
 181                 }
 182
 183                 # Possible race condition... let's be paranoid
 184
 185                 $other = oid_get_user($canonical);
 186
 187                 if ($other) {
 188                         common_server_error(_t('Creating new account for OpenID that already has a user.'));
 189                         return;
 190                 }
 191
 192                 $profile = new Profile();
 193
 194                 $profile->nickname = $nickname;
 195
 196                 if ($sreg['fullname'] && strlen($sreg['fullname']) <= 255) {
 197                         $profile->fullname = $sreg['fullname'];
 198                 }
 199
 200                 if ($sreg['country']) {
 201                         if ($sreg['postcode']) {
 202                                 # XXX: use postcode to get city and region
 203                                 # XXX: also, store postcode somewhere -- it's valuable!
 204                                 $profile->location = $sreg['postcode'] . ', ' . $sreg['country'];
 205                         } else {
 206                                 $profile->location = $sreg['country'];
 207                         }
 208                 }
 209
 210                 # XXX save language if it's passed
 211                 # XXX save timezone if it's passed
 212
 213                 $profile->profileurl = common_profile_url($nickname);
 214
 215                 $profile->created = DB_DataObject_Cast::dateTime(); # current time
 216
 217                 $id = $profile->insert();
 218                 if (!$id) {
 219                         common_server_error(_t('Error saving the profile.'));
 220                         return;
 221                 }
 222
 223                 $user = new User();
 224                 $user->id = $id;
 225                 $user->nickname = $nickname;
 226                 $user->uri = common_user_uri($user);
 227
 228                 if ($sreg['email'] && Validate::email($sreg['email'], true)) {
 229                         $user->email = $sreg['email'];
 230                 }
 231
 232                 $user->created = DB_DataObject_Cast::dateTime(); # current time
 233
 234                 $result = $user->insert();
 235
 236                 if (!$result) {
 237                         # Try to clean up...
 238                         $profile->delete();
 239                 }
 240
 241                 $result = oid_link_user($user->id, $canonical, $display);
 242
 243                 if (!$result) {
 244                         # Try to clean up...
 245                         $user->delete();
 246                         $profile->delete();
 247                 }
 248
 249                 oid_set_last($display);
 250                 common_set_user($user->nickname);
 251                 common_redirect(common_local_url('showstream', array('nickname' => $user->nickname)));
 252         }
 253
 254         function connect_user() {
 255
 256                 $nickname = $this->trimmed('nickname');
 257                 $password = $this->trimmed('password');
 258
 259                 if (!common_check_user($nickname, $password)) {
 260                         $this->show_form(_t('Invalid username or password.'));
 261                         return;
 262                 }
 263
 264                 # They're legit!
 265
 266                 $user = User::staticGet('nickname', $nickname);
 267
 268                 list($display, $canonical, $sreg) = $this->get_saved_values();
 269
 270                 if (!$display || !$canonical) {
 271                         common_server_error(_t('Stored OpenID not found.'));
 272                         return;
 273                 }
 274
 275                 $result = oid_link_user($user->id, $canonical, $display);
 276
 277                 if (!$result) {
 278                         common_server_error(_t('Error connecting user to OpenID.'));
 279                         return;
 280                 }
 281
 282                 oid_update_user($user, $sreg);
 283                 oid_set_last($display);
 284                 common_set_user($user->nickname);
 285                 $this->go_home($user->nickname);
 286         }
 287
 288         function go_home($nickname) {
 289                 $url = common_get_returnto();
 290                 if ($url) {
 291                         # We don't have to return to it again
 292                         common_set_returnto(NULL);
 293                 } else {
 294                         $url = common_local_url('all',
 295                                                                         array('nickname' =>
 296                                                                                   $nickname));
 297                 }
 298                 common_redirect($url);
 299         }
 300
 301         function best_new_nickname($display, $sreg) {
 302
 303                 # Try the passed-in nickname
 304
 305
 306                 if ($sreg['nickname']) {
 307                         $nickname = $this->nicknamize($sreg['nickname']);
 308                         if ($this->is_new_nickname($nickname)) {
 309                                 return $nickname;
 310                         }
 311                 }
 312
 313                 # Try the full name
 314
 315                 if ($sreg['fullname']) {
 316                         $fullname = $this->nicknamize($sreg['fullname']);
 317                         if ($this->is_new_nickname($fullname)) {
 318                                 return $fullname;
 319                         }
 320                 }
 321
 322                 # Try the URL
 323
 324                 $from_url = $this->openid_to_nickname($display);
 325
 326                 if ($from_url && $this->is_new_nickname($from_url)) {
 327                         return $from_url;
 328                 }
 329
 330                 # XXX: others?
 331
 332                 return NULL;
 333         }
 334
 335         function is_new_nickname($str) {
 336                 if (!Validate::string($str, array('min_length' => 1,
 337                                                                                   'max_length' => 64,
 338                                                                                   'format' => VALIDATE_NUM . VALIDATE_ALPHA_LOWER))) {
 339                         return false;
 340                 }
 341                 if (User::staticGet('nickname', $str)) {
 342                         return false;
 343                 }
 344                 return true;
 345         }
 346
 347         function openid_to_nickname($openid) {
 348         if (Auth_Yadis_identifierScheme($openid) == 'XRI') {
 349                         return $this->xri_to_nickname($openid);
 350                 } else {
 351                         return $this->url_to_nickname($openid);
 352                 }
 353         }
 354
 355         # We try to use an OpenID URL as a legal Laconica user name in this order
 356         # 1. Plain hostname, like http://evanp.myopenid.com/
 357         # 2. One element in path, like http://profile.typekey.com/EvanProdromou/
 358         #    or http://getopenid.com/evanprodromou
 359
 360     function url_to_nickname($openid) {
 361                 static $bad = array('query', 'user', 'password', 'port', 'fragment');
 362
 363             $parts = parse_url($openid);
 364
 365                 # If any of these parts exist, this won't work
 366
 367                 foreach ($bad as $badpart) {
 368                         if (array_key_exists($badpart, $parts)) {
 369                                 return NULL;
 370                         }
 371                 }
 372
 373                 # We just have host and/or path
 374
 375                 # If it's just a host...
 376                 if (array_key_exists('host', $parts) &&
 377                         (!array_key_exists('path', $parts) || strcmp($parts['path'], '/') == 0))
 378                 {
 379                         $hostparts = explode('.', $parts['host']);
 380
 381                         # Try to catch common idiom of nickname.service.tld
 382
 383                         if ((count($hostparts) > 2) &&
 384                                 (strlen($hostparts[count($hostparts) - 2]) > 3) && # try to skip .co.uk, .com.au
 385                                 (strcmp($hostparts[0], 'www') != 0))
 386                         {
 387                                 return $this->nicknamize($hostparts[0]);
 388                         } else {
 389                                 # Do the whole hostname
 390                                 return $this->nicknamize($parts['host']);
 391                         }
 392                 } else {
 393                         if (array_key_exists('path', $parts)) {
 394                                 # Strip starting, ending slashes
 395                                 $path = preg_replace('@/$@', '', $parts['path']);
 396                                 $path = preg_replace('@^/@', '', $path);
 397                                 if (strpos($path, '/') === false) {
 398                                         return $this->nicknamize($path);
 399                                 }
 400                         }
 401                 }
 402
 403                 return NULL;
 404         }
 405
 406         function xri_to_nickname($xri) {
 407                 $base = $this->xri_base($xri);
 408
 409                 if (!$base) {
 410                         return NULL;
 411                 } else {
 412                         # =evan.prodromou
 413                         # or @gratis*evan.prodromou
 414                         $parts = explode('*', substr($base, 1));
 415                         return $this->nicknamize(array_pop($parts));
 416                 }
 417         }
 418
 419         function xri_base($xri) {
 420                 if (substr($xri, 0, 6) == 'xri://') {
 421                         return substr($xri, 6);
 422                 } else {
 423                         return $xri;
 424                 }
 425         }
 426
 427         # Given a string, try to make it work as a nickname
 428
 429         function nicknamize($str) {
 430                 $str = preg_replace('/\W/', '', $str);
 431                 return strtolower($str);
 432         }
 433 }