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         if (oid_get_last()) {
  53                 oid_set_last('');
  54         }
  55 }
  56
  57 function oid_set_last($openid_url) {
  58         global $config;
  59         setcookie(OPENID_COOKIE_KEY, $openid_url,
  60                           time() + OPENID_COOKIE_EXPIRY,
  61                           '/' . $config['site']['path'] . '/',
  62                           $config['site']['server']);
  63 }
  64
  65 function oid_get_last() {
  66         return $_COOKIE[OPENID_COOKIE_KEY];
  67 }
  68
  69 function oid_link_user($id, $canonical, $display) {
  70
  71         $oid = new User_openid();
  72         $oid->user_id = $id;
  73         $oid->canonical = $canonical;
  74         $oid->display = $display;
  75         $oid->created = DB_DataObject_Cast::dateTime();
  76
  77         if (!$oid->insert()) {
  78                 $err = PEAR::getStaticProperty('DB_DataObject','lastError');
  79                 common_debug('DB error ' . $err->code . ': ' . $err->message, __FILE__);
  80                 return false;
  81         }
  82
  83         return true;
  84 }
  85
  86 function oid_get_user($openid_url) {
  87         $user = NULL;
  88         $oid = User_openid::staticGet('canonical', $openid_url);
  89         if ($oid) {
  90                 $user = User::staticGet('id', $oid->user_id);
  91         }
  92         return $user;
  93 }
  94
  95 function oid_check_immediate($openid_url, $backto=NULL) {
  96         if (!$backto) {
  97                 $action = $_REQUEST['action'];
  98                 $args = common_copy_args($_GET);
  99                 unset($args['action']);
 100                 $backto = common_local_url($action, $args);
 101         }
 102         common_debug('going back to "' . $backto . '"', __FILE__);
 103
 104         common_ensure_session();
 105
 106         $_SESSION['openid_immediate_backto'] = $backto;
 107         common_debug('passed-in variable is "' . $backto . '"', __FILE__);
 108         common_debug('session variable is "' . $_SESSION['openid_immediate_backto'] . '"', __FILE__);
 109
 110         oid_authenticate($openid_url,
 111                                          'finishimmediate',
 112                                          true);
 113 }
 114
 115 function oid_authenticate($openid_url, $returnto, $immediate=false) {
 116
 117         $consumer = oid_consumer();
 118
 119         if (!$consumer) {
 120                 common_server_error(_t('Cannot instantiate OpenID consumer object.'));
 121                 return false;
 122         }
 123
 124         common_ensure_session();
 125
 126         $auth_request = $consumer->begin($openid_url);
 127
 128         // Handle failure status return values.
 129         if (!$auth_request) {
 130                 return _t('Not a valid OpenID.');
 131         } else if (Auth_OpenID::isFailure($auth_request)) {
 132                 return _t('OpenID failure: ') . $auth_request->message;
 133         }
 134
 135         $sreg_request = Auth_OpenID_SRegRequest::build(// Required
 136                                                                                                    array(),
 137                                                                                                    // Optional
 138                                                                                                    array('nickname',
 139                                                                                                                  'email',
 140                                                                                                                  'fullname',
 141                                                                                                                  'language',
 142                                                                                                                  'timezone',
 143                                                                                                                  'postcode',
 144                                                                                                                  'country'));
 145
 146         if ($sreg_request) {
 147                 $auth_request->addExtension($sreg_request);
 148         }
 149
 150         $trust_root = common_local_url('public');
 151         $process_url = common_local_url($returnto);
 152
 153         if ($auth_request->shouldSendRedirect()) {
 154                 $redirect_url = $auth_request->redirectURL($trust_root,
 155                                                                                                    $process_url,
 156                                                                                                    $immediate);
 157                 if (!$redirect_url) {
 158                 } else if (Auth_OpenID::isFailure($redirect_url)) {
 159                         return _t('Could not redirect to server: ') . $redirect_url->message;
 160                 } else {
 161                         common_redirect($redirect_url);
 162                 }
 163         } else {
 164                 // Generate form markup and render it.
 165                 $form_id = 'openid_message';
 166                 $form_html = $auth_request->formMarkup($trust_root, $process_url,
 167                                                                                            $immediate, array('id' => $form_id));
 168
 169                 # XXX: This is cheap, but things choke if we don't escape ampersands
 170                 # in the HTML attributes
 171
 172                 $form_html = preg_replace('/&/', '&amp;', $form_html);
 173
 174                 // Display an error if the form markup couldn't be generated;
 175                 // otherwise, render the HTML.
 176                 if (Auth_OpenID::isFailure($form_html)) {
 177                         $this->show_form(_t('Could not create OpenID form: ') . $form_html->message);
 178                 } else {
 179                         common_show_header(_t('OpenID Auto-Submit'));
 180                         common_element('p', 'instructions',
 181                                                    _t('This form should automatically submit itself. '.
 182                                                           'If not, click the submit button to go to your '.
 183                                                           'OpenID provider.'));
 184                         common_raw($form_html);
 185                         common_element('script', NULL,
 186                                                    '$(document).ready(function() { ' .
 187                                                    '    $("#'. $form_id .'").submit(); '.
 188                                                    '});');
 189                         common_show_footer();
 190                 }
 191         }
 192 }
 193
 194 # update a user from sreg parameters
 195
 196 function oid_update_user(&$user, &$sreg) {
 197
 198         $profile = $user->getProfile();
 199
 200         $orig_profile = clone($profile);
 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         if (!$profile->update($orig_profile)) {
 220                 common_server_error(_t('Error saving the profile.'));
 221                 return false;
 222         }
 223
 224         $orig_user = clone($user);
 225
 226         if ($sreg['email'] && Validate::email($sreg['email'], true)) {
 227                 $user->email = $sreg['email'];
 228         }
 229
 230         if (!$user->update($orig_user)) {
 231                 common_server_error(_t('Error saving the user.'));
 232                 return false;
 233         }
 234
 235         return true;
 236 }