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