lib/openid.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.'/classes/User_openid.php');
  23
  24 require_once('Auth/OpenID.php');
  25 require_once('Auth/OpenID/Consumer.php');
  26 require_once('Auth/OpenID/SReg.php');
  27 require_once('Auth/OpenID/MySQLStore.php');
  28
  29 # About one year cookie expiry
  30
  31 define('OPENID_COOKIE_EXPIRY', round(365.25 * 24 * 60 * 60));
  32 define('OPENID_COOKIE_KEY', 'lastusedopenid');
  33
  34 function oid_store() {
  35     static $store = NULL;
  36         if (!$store) {
  37                 # Can't be called statically
  38                 $user = new User();
  39                 $conn = $user->getDatabaseConnection();
  40                 $store = new Auth_OpenID_MySQLStore($conn);
  41         }
  42         return $store;
  43 }
  44
  45 function oid_consumer() {
  46         $store = oid_store();
  47         $consumer = new Auth_OpenID_Consumer($store);
  48         return $consumer;
  49 }
  50
  51 function oid_clear_last() {
  52         oid_set_last('');
  53 }
  54
  55 function oid_set_last($openid_url) {
  56
  57         $path = common_config('site', 'path');
  58         $server = common_config('site', 'server');
  59
  60         if ($path && ($path != '/')) {
  61                 $cookiepath = '/' . $path . '/';
  62         } else {
  63                 $cookiepath = '/';
  64         }
  65
  66         setcookie(OPENID_COOKIE_KEY,
  67                           $openid_url,
  68                           time() + OPENID_COOKIE_EXPIRY,
  69                           $cookiepath,
  70                           $server);
  71 }
  72
  73 function oid_get_last() {
  74         $openid_url = $_COOKIE[OPENID_COOKIE_KEY];
  75         if ($openid_url && strlen($openid_url) > 0) {
  76                 return $openid_url;
  77         } else {
  78                 return NULL;
  79         }
  80 }
  81
  82 function oid_link_user($id, $canonical, $display) {
  83
  84         $oid = new User_openid();
  85         $oid->user_id = $id;
  86         $oid->canonical = $canonical;
  87         $oid->display = $display;
  88         $oid->created = DB_DataObject_Cast::dateTime();
  89
  90         if (!$oid->insert()) {
  91                 $err = PEAR::getStaticProperty('DB_DataObject','lastError');
  92                 common_debug('DB error ' . $err->code . ': ' . $err->message, __FILE__);
  93                 return false;
  94         }
  95
  96         return true;
  97 }
  98
  99 function oid_get_user($openid_url) {
 100         $user = NULL;
 101         $oid = User_openid::staticGet('canonical', $openid_url);
 102         if ($oid) {
 103                 $user = User::staticGet('id', $oid->user_id);
 104         }
 105         return $user;
 106 }
 107
 108 function oid_check_immediate($openid_url, $backto=NULL) {
 109         if (!$backto) {
 110                 $action = $_REQUEST['action'];
 111                 $args = common_copy_args($_GET);
 112                 unset($args['action']);
 113                 $backto = common_local_url($action, $args);
 114         }
 115         common_debug('going back to "' . $backto . '"', __FILE__);
 116
 117         common_ensure_session();
 118
 119         $_SESSION['openid_immediate_backto'] = $backto;
 120         common_debug('passed-in variable is "' . $backto . '"', __FILE__);
 121         common_debug('session variable is "' . $_SESSION['openid_immediate_backto'] . '"', __FILE__);
 122
 123         oid_authenticate($openid_url,
 124                                          'finishimmediate',
 125                                          true);
 126 }
 127
 128 function oid_authenticate($openid_url, $returnto, $immediate=false) {
 129
 130         $consumer = oid_consumer();
 131
 132         if (!$consumer) {
 133                 common_server_error(_t('Cannot instantiate OpenID consumer object.'));
 134                 return false;
 135         }
 136
 137         common_ensure_session();
 138
 139         $auth_request = $consumer->begin($openid_url);
 140
 141         // Handle failure status return values.
 142         if (!$auth_request) {
 143                 return _t('Not a valid OpenID.');
 144         } else if (Auth_OpenID::isFailure($auth_request)) {
 145                 return _t('OpenID failure: ') . $auth_request->message;
 146         }
 147
 148         $sreg_request = Auth_OpenID_SRegRequest::build(// Required
 149                                                                                                    array(),
 150                                                                                                    // Optional
 151                                                                                                    array('nickname',
 152                                                                                                                  'email',
 153                                                                                                                  'fullname',
 154                                                                                                                  'language',
 155                                                                                                                  'timezone',
 156                                                                                                                  'postcode',
 157                                                                                                                  'country'));
 158
 159         if ($sreg_request) {
 160                 $auth_request->addExtension($sreg_request);
 161         }
 162
 163         $trust_root = common_local_url('public');
 164         $process_url = common_local_url($returnto);
 165
 166         if ($auth_request->shouldSendRedirect()) {
 167                 $redirect_url = $auth_request->redirectURL($trust_root,
 168                                                                                                    $process_url,
 169                                                                                                    $immediate);
 170                 if (!$redirect_url) {
 171                 } else if (Auth_OpenID::isFailure($redirect_url)) {
 172                         return _t('Could not redirect to server: ') . $redirect_url->message;
 173                 } else {
 174                         common_redirect($redirect_url);
 175                 }
 176         } else {
 177                 // Generate form markup and render it.
 178                 $form_id = 'openid_message';
 179                 $form_html = $auth_request->formMarkup($trust_root, $process_url,
 180                                                                                            $immediate, array('id' => $form_id));
 181
 182                 # XXX: This is cheap, but things choke if we don't escape ampersands
 183                 # in the HTML attributes
 184
 185                 $form_html = preg_replace('/&/', '&amp;', $form_html);
 186
 187                 // Display an error if the form markup couldn't be generated;
 188                 // otherwise, render the HTML.
 189                 if (Auth_OpenID::isFailure($form_html)) {
 190                         $this->show_form(_t('Could not create OpenID form: ') . $form_html->message);
 191                 } else {
 192                         common_show_header(_t('OpenID Auto-Submit'));
 193                         common_element('p', 'instructions',
 194                                                    _t('This form should automatically submit itself. '.
 195                                                           'If not, click the submit button to go to your '.
 196                                                           'OpenID provider.'));
 197                         common_raw($form_html);
 198                         common_element('script', NULL,
 199                                                    '$(document).ready(function() { ' .
 200                                                    '    $("#'. $form_id .'").submit(); '.
 201                                                    '});');
 202                         common_show_footer();
 203                 }
 204         }
 205 }
 206
 207 # update a user from sreg parameters
 208
 209 function oid_update_user(&$user, &$sreg) {
 210
 211         $profile = $user->getProfile();
 212
 213         $orig_profile = clone($profile);
 214
 215         if ($sreg['fullname'] && strlen($sreg['fullname']) <= 255) {
 216                 $profile->fullname = $sreg['fullname'];
 217         }
 218
 219         if ($sreg['country']) {
 220                 if ($sreg['postcode']) {
 221                         # XXX: use postcode to get city and region
 222                         # XXX: also, store postcode somewhere -- it's valuable!
 223                         $profile->location = $sreg['postcode'] . ', ' . $sreg['country'];
 224                 } else {
 225                         $profile->location = $sreg['country'];
 226                 }
 227         }
 228
 229         # XXX save language if it's passed
 230         # XXX save timezone if it's passed
 231
 232         if (!$profile->update($orig_profile)) {
 233                 common_server_error(_t('Error saving the profile.'));
 234                 return false;
 235         }
 236
 237         $orig_user = clone($user);
 238
 239         if ($sreg['email'] && Validate::email($sreg['email'], true)) {
 240                 $user->email = $sreg['email'];
 241         }
 242
 243         if (!$user->update($orig_user)) {
 244                 common_server_error(_t('Error saving the user.'));
 245                 return false;
 246         }
 247
 248         return true;
 249 }