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 {
  36     static $store = null;
  37     if (!$store) {
  38         # Can't be called statically
  39         $user = new User();
  40         $conn = $user->getDatabaseConnection();
  41         $store = new Auth_OpenID_MySQLStore($conn);
  42     }
  43     return $store;
  44 }
  45
  46 function oid_consumer()
  47 {
  48     $store = oid_store();
  49     $consumer = new Auth_OpenID_Consumer($store);
  50     return $consumer;
  51 }
  52
  53 function oid_clear_last()
  54 {
  55     oid_set_last('');
  56 }
  57
  58 function oid_set_last($openid_url)
  59 {
  60     common_set_cookie(OPENID_COOKIE_KEY,
  61                      $openid_url,
  62                      time() + OPENID_COOKIE_EXPIRY);
  63 }
  64
  65 function oid_get_last()
  66 {
  67     if (empty($_COOKIE[OPENID_COOKIE_KEY])) {
  68         return null;
  69     }
  70     $openid_url = $_COOKIE[OPENID_COOKIE_KEY];
  71     if ($openid_url && strlen($openid_url) > 0) {
  72         return $openid_url;
  73     } else {
  74         return null;
  75     }
  76 }
  77
  78 function oid_link_user($id, $canonical, $display)
  79 {
  80
  81     $oid = new User_openid();
  82     $oid->user_id = $id;
  83     $oid->canonical = $canonical;
  84     $oid->display = $display;
  85     $oid->created = DB_DataObject_Cast::dateTime();
  86
  87     if (!$oid->insert()) {
  88         $err = PEAR::getStaticProperty('DB_DataObject','lastError');
  89         common_debug('DB error ' . $err->code . ': ' . $err->message, __FILE__);
  90         return false;
  91     }
  92
  93     return true;
  94 }
  95
  96 function oid_get_user($openid_url)
  97 {
  98     $user = null;
  99     $oid = User_openid::staticGet('canonical', $openid_url);
 100     if ($oid) {
 101         $user = User::staticGet('id', $oid->user_id);
 102     }
 103     return $user;
 104 }
 105
 106 function oid_check_immediate($openid_url, $backto=null)
 107 {
 108     if (!$backto) {
 109         $action = $_REQUEST['action'];
 110         $args = common_copy_args($_GET);
 111         unset($args['action']);
 112         $backto = common_local_url($action, $args);
 113     }
 114     common_debug('going back to "' . $backto . '"', __FILE__);
 115
 116     common_ensure_session();
 117
 118     $_SESSION['openid_immediate_backto'] = $backto;
 119     common_debug('passed-in variable is "' . $backto . '"', __FILE__);
 120     common_debug('session variable is "' . $_SESSION['openid_immediate_backto'] . '"', __FILE__);
 121
 122     oid_authenticate($openid_url,
 123                      'finishimmediate',
 124                      true);
 125 }
 126
 127 function oid_authenticate($openid_url, $returnto, $immediate=false)
 128 {
 129
 130     $consumer = oid_consumer();
 131
 132     if (!$consumer) {
 133         common_server_error(_('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 _('Not a valid OpenID.');
 144     } else if (Auth_OpenID::isFailure($auth_request)) {
 145         return sprintf(_('OpenID failure: %s'), $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_root_url(true);
 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 sprintf(_('Could not redirect to server: %s'), $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             common_server_error(sprintf(_('Could not create OpenID form: %s'), $form_html->message));
 191         } else {
 192             $action = new AutosubmitAction(); // see below
 193             $action->form_html = $form_html;
 194             $action->form_id = $form_id;
 195             $action->prepare(array('action' => 'autosubmit'));
 196             $action->handle(array('action' => 'autosubmit'));
 197         }
 198     }
 199 }
 200
 201 # Half-assed attempt at a module-private function
 202
 203 function _oid_print_instructions()
 204 {
 205     common_element('div', 'instructions',
 206                    _('This form should automatically submit itself. '.
 207                       'If not, click the submit button to go to your '.
 208                       'OpenID provider.'));
 209 }
 210
 211 # update a user from sreg parameters
 212
 213 function oid_update_user(&$user, &$sreg)
 214 {
 215
 216     $profile = $user->getProfile();
 217
 218     $orig_profile = clone($profile);
 219
 220     if ($sreg['fullname'] && strlen($sreg['fullname']) <= 255) {
 221         $profile->fullname = $sreg['fullname'];
 222     }
 223
 224     if ($sreg['country']) {
 225         if ($sreg['postcode']) {
 226             # XXX: use postcode to get city and region
 227             # XXX: also, store postcode somewhere -- it's valuable!
 228             $profile->location = $sreg['postcode'] . ', ' . $sreg['country'];
 229         } else {
 230             $profile->location = $sreg['country'];
 231         }
 232     }
 233
 234     # XXX save language if it's passed
 235     # XXX save timezone if it's passed
 236
 237     if (!$profile->update($orig_profile)) {
 238         common_server_error(_('Error saving the profile.'));
 239         return false;
 240     }
 241
 242     $orig_user = clone($user);
 243
 244     if ($sreg['email'] && Validate::email($sreg['email'], true)) {
 245         $user->email = $sreg['email'];
 246     }
 247
 248     if (!$user->update($orig_user)) {
 249         common_server_error(_('Error saving the user.'));
 250         return false;
 251     }
 252
 253     return true;
 254 }
 255
 256 class AutosubmitAction extends Action
 257 {
 258     var $form_html = null;
 259     var $form_id = null;
 260
 261     function handle($args)
 262     {
 263         parent::handle($args);
 264         $this->showPage();
 265     }
 266
 267     function title()
 268     {
 269         return _('OpenID Auto-Submit');
 270     }
 271
 272     function showContent()
 273     {
 274         $this->raw($this->form_html);
 275         $this->element('script', null,
 276                        '$(document).ready(function() { ' .
 277                        '    $(\'#'. $this->form_id .'\').submit(); '.
 278                        '});');
 279     }
 280 }