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                                 common_real_login(true);
 134                                 $this->go_home($user->nickname);
 135                         } else {
 136                                 $this->save_values($display, $canonical, $sreg);
 137                                 $this->show_form(NULL, $this->best_new_nickname($display, $sreg));
 138                         }
 139                 }
 140         }
 141
 142         function message($msg) {
 143                 common_show_header(_t('OpenID Login'));
 144                 common_element('p', NULL, $msg);
 145                 common_show_footer();
 146         }
 147
 148         function save_values($display, $canonical, $sreg) {
 149                 common_ensure_session();
 150                 $_SESSION['openid_display'] = $display;
 151                 $_SESSION['openid_canonical'] = $canonical;
 152                 $_SESSION['openid_sreg'] = $sreg;
 153         }
 154
 155         function get_saved_values() {
 156                 return array($_SESSION['openid_display'],
 157                                          $_SESSION['openid_canonical'],
 158                                          $_SESSION['openid_sreg']);
 159         }
 160
 161         function create_new_user() {
 162
 163                 $nickname = $this->trimmed('newname');
 164
 165                 if (!Validate::string($nickname, array('min_length' => 1,
 166                                                                                            'max_length' => 64,
 167                                                                                            'format' => VALIDATE_NUM . VALIDATE_ALPHA_LOWER))) {
 168                         $this->show_form(_t('Nickname must have only letters and numbers and no spaces.'));
 169                         return;
 170                 }
 171
 172                 if (!User::allowed_nickname($nickname)) {
 173                         $this->show_form(_t('Nickname not allowed.'));
 174                         return;
 175                 }
 176
 177                 if (User::staticGet('nickname', $nickname)) {
 178                         $this->show_form(_t('Nickname already in use. Try another one.'));
 179                         return;
 180                 }
 181
 182                 list($display, $canonical, $sreg) = $this->get_saved_values();
 183
 184                 if (!$display || !$canonical) {
 185                         common_server_error(_t('Stored OpenID not found.'));
 186                         return;
 187                 }
 188
 189                 # Possible race condition... let's be paranoid
 190
 191                 $other = oid_get_user($canonical);
 192
 193                 if ($other) {
 194                         common_server_error(_t('Creating new account for OpenID that already has a user.'));
 195                         return;
 196                 }
 197
 198                 $profile = new Profile();
 199
 200                 $profile->nickname = $nickname;
 201
 202                 if ($sreg['fullname'] && strlen($sreg['fullname']) <= 255) {
 203                         $profile->fullname = $sreg['fullname'];
 204                 }
 205
 206                 if ($sreg['country']) {
 207                         if ($sreg['postcode']) {
 208                                 # XXX: use postcode to get city and region
 209                                 # XXX: also, store postcode somewhere -- it's valuable!
 210                                 $profile->location = $sreg['postcode'] . ', ' . $sreg['country'];
 211                         } else {
 212                                 $profile->location = $sreg['country'];
 213                         }
 214                 }
 215
 216                 # XXX save language if it's passed
 217                 # XXX save timezone if it's passed
 218
 219                 $profile->profileurl = common_profile_url($nickname);
 220
 221                 $profile->created = DB_DataObject_Cast::dateTime(); # current time
 222
 223                 $id = $profile->insert();
 224                 if (!$id) {
 225                         common_server_error(_t('Error saving the profile.'));
 226                         return;
 227                 }
 228
 229                 $user = new User();
 230                 $user->id = $id;
 231                 $user->nickname = $nickname;
 232                 $user->uri = common_user_uri($user);
 233
 234                 if ($sreg['email'] && Validate::email($sreg['email'], true)) {
 235                         $user->email = $sreg['email'];
 236                 }
 237
 238                 $user->created = DB_DataObject_Cast::dateTime(); # current time
 239
 240                 $result = $user->insert();
 241
 242                 if (!$result) {
 243                         # Try to clean up...
 244                         $profile->delete();
 245                 }
 246
 247                 $result = oid_link_user($user->id, $canonical, $display);
 248
 249                 if (!$result) {
 250                         # Try to clean up...
 251                         $user->delete();
 252                         $profile->delete();
 253                 }
 254
 255                 oid_set_last($display);
 256                 common_set_user($user->nickname);
 257                 common_real_login(true);
 258                 common_redirect(common_local_url('showstream', array('nickname' => $user->nickname)));
 259         }
 260
 261         function connect_user() {
 262
 263                 $nickname = $this->trimmed('nickname');
 264                 $password = $this->trimmed('password');
 265
 266                 if (!common_check_user($nickname, $password)) {
 267                         $this->show_form(_t('Invalid username or password.'));
 268                         return;
 269                 }
 270
 271                 # They're legit!
 272
 273                 $user = User::staticGet('nickname', $nickname);
 274
 275                 list($display, $canonical, $sreg) = $this->get_saved_values();
 276
 277                 if (!$display || !$canonical) {
 278                         common_server_error(_t('Stored OpenID not found.'));
 279                         return;
 280                 }
 281
 282                 $result = oid_link_user($user->id, $canonical, $display);
 283
 284                 if (!$result) {
 285                         common_server_error(_t('Error connecting user to OpenID.'));
 286                         return;
 287                 }
 288
 289                 oid_update_user($user, $sreg);
 290                 oid_set_last($display);
 291                 common_set_user($user->nickname);
 292                 common_real_login(true);
 293                 $this->go_home($user->nickname);
 294         }
 295
 296         function go_home($nickname) {
 297                 $url = common_get_returnto();
 298                 if ($url) {
 299                         # We don't have to return to it again
 300                         common_set_returnto(NULL);
 301                 } else {
 302                         $url = common_local_url('all',
 303                                                                         array('nickname' =>
 304                                                                                   $nickname));
 305                 }
 306                 common_redirect($url);
 307         }
 308
 309         function best_new_nickname($display, $sreg) {
 310
 311                 # Try the passed-in nickname
 312
 313
 314                 if ($sreg['nickname']) {
 315                         $nickname = $this->nicknamize($sreg['nickname']);
 316                         if ($this->is_new_nickname($nickname)) {
 317                                 return $nickname;
 318                         }
 319                 }
 320
 321                 # Try the full name
 322
 323                 if ($sreg['fullname']) {
 324                         $fullname = $this->nicknamize($sreg['fullname']);
 325                         if ($this->is_new_nickname($fullname)) {
 326                                 return $fullname;
 327                         }
 328                 }
 329
 330                 # Try the URL
 331
 332                 $from_url = $this->openid_to_nickname($display);
 333
 334                 if ($from_url && $this->is_new_nickname($from_url)) {
 335                         return $from_url;
 336                 }
 337
 338                 # XXX: others?
 339
 340                 return NULL;
 341         }
 342
 343         function is_new_nickname($str) {
 344                 if (!Validate::string($str, array('min_length' => 1,
 345                                                                                   'max_length' => 64,
 346                                                                                   'format' => VALIDATE_NUM . VALIDATE_ALPHA_LOWER))) {
 347                         return false;
 348                 }
 349         if (!User::allowed_nickname($str)) {
 350                         return false;
 351                 }
 352                 if (User::staticGet('nickname', $str)) {
 353                         return false;
 354                 }
 355                 return true;
 356         }
 357
 358         function openid_to_nickname($openid) {
 359         if (Auth_Yadis_identifierScheme($openid) == 'XRI') {
 360                         return $this->xri_to_nickname($openid);
 361                 } else {
 362                         return $this->url_to_nickname($openid);
 363                 }
 364         }
 365
 366         # We try to use an OpenID URL as a legal Laconica user name in this order
 367         # 1. Plain hostname, like http://evanp.myopenid.com/
 368         # 2. One element in path, like http://profile.typekey.com/EvanProdromou/
 369         #    or http://getopenid.com/evanprodromou
 370
 371     function url_to_nickname($openid) {
 372                 static $bad = array('query', 'user', 'password', 'port', 'fragment');
 373
 374             $parts = parse_url($openid);
 375
 376                 # If any of these parts exist, this won't work
 377
 378                 foreach ($bad as $badpart) {
 379                         if (array_key_exists($badpart, $parts)) {
 380                                 return NULL;
 381                         }
 382                 }
 383
 384                 # We just have host and/or path
 385
 386                 # If it's just a host...
 387                 if (array_key_exists('host', $parts) &&
 388                         (!array_key_exists('path', $parts) || strcmp($parts['path'], '/') == 0))
 389                 {
 390                         $hostparts = explode('.', $parts['host']);
 391
 392                         # Try to catch common idiom of nickname.service.tld
 393
 394                         if ((count($hostparts) > 2) &&
 395                                 (strlen($hostparts[count($hostparts) - 2]) > 3) && # try to skip .co.uk, .com.au
 396                                 (strcmp($hostparts[0], 'www') != 0))
 397                         {
 398                                 return $this->nicknamize($hostparts[0]);
 399                         } else {
 400                                 # Do the whole hostname
 401                                 return $this->nicknamize($parts['host']);
 402                         }
 403                 } else {
 404                         if (array_key_exists('path', $parts)) {
 405                                 # Strip starting, ending slashes
 406                                 $path = preg_replace('@/$@', '', $parts['path']);
 407                                 $path = preg_replace('@^/@', '', $path);
 408                                 if (strpos($path, '/') === false) {
 409                                         return $this->nicknamize($path);
 410                                 }
 411                         }
 412                 }
 413
 414                 return NULL;
 415         }
 416
 417         function xri_to_nickname($xri) {
 418                 $base = $this->xri_base($xri);
 419
 420                 if (!$base) {
 421                         return NULL;
 422                 } else {
 423                         # =evan.prodromou
 424                         # or @gratis*evan.prodromou
 425                         $parts = explode('*', substr($base, 1));
 426                         return $this->nicknamize(array_pop($parts));
 427                 }
 428         }
 429
 430         function xri_base($xri) {
 431                 if (substr($xri, 0, 6) == 'xri://') {
 432                         return substr($xri, 6);
 433                 } else {
 434                         return $xri;
 435                 }
 436         }
 437
 438         # Given a string, try to make it work as a nickname
 439
 440         function nicknamize($str) {
 441                 $str = preg_replace('/\W/', '', $str);
 442                 return strtolower($str);
 443         }
 444 }