plugins/OpenID/OpenIDPlugin.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * PHP version 5
   6  *
   7  * LICENCE: This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as published by
   9  * the Free Software Foundation, either version 3 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  *
  20  * @category  Plugin
  21  * @package   StatusNet
  22  * @author    Evan Prodromou <evan@status.net>
  23  * @author   Craig Andrews <candrews@integralblue.com>
  24  * @copyright 2009-2010 StatusNet, Inc.
  25  * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 /**
  35  * Plugin for OpenID authentication and identity
  36  *
  37  * This class enables consumer support for OpenID, the distributed authentication
  38  * and identity system.
  39  *
  40  * @category Plugin
  41  * @package  StatusNet
  42  * @author   Evan Prodromou <evan@status.net>
  43  * @author   Craig Andrews <candrews@integralblue.com>
  44  * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
  45  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  46  * @link     http://status.net/
  47  * @link     http://openid.net/
  48  */
  49 class OpenIDPlugin extends Plugin
  50 {
  51     // Plugin parameter: set true to disallow non-OpenID logins
  52     // If set, overrides the setting in database or $config['site']['openidonly']
  53     public $openidOnly = null;
  54
  55     function initialize()
  56     {
  57         parent::initialize();
  58         if ($this->openidOnly !== null) {
  59             global $config;
  60             $config['site']['openidonly'] = (bool)$this->openidOnly;
  61         }
  62     }
  63
  64     /**
  65      * Add OpenID-related paths to the router table
  66      *
  67      * Hook for RouterInitialized event.
  68      *
  69      * @param Net_URL_Mapper $m URL mapper
  70      *
  71      * @return boolean hook return
  72      */
  73     function onStartInitializeRouter($m)
  74     {
  75         $m->connect('main/openid', array('action' => 'openidlogin'));
  76         $m->connect('main/openidtrust', array('action' => 'openidtrust'));
  77         $m->connect('settings/openid', array('action' => 'openidsettings'));
  78         $m->connect('index.php?action=finishopenidlogin',
  79                     array('action' => 'finishopenidlogin'));
  80         $m->connect('index.php?action=finishaddopenid',
  81                     array('action' => 'finishaddopenid'));
  82         $m->connect('main/openidserver', array('action' => 'openidserver'));
  83         $m->connect('panel/openid', array('action' => 'openidadminpanel'));
  84
  85         return true;
  86     }
  87
  88     /**
  89      * In OpenID-only mode, disable paths for password stuff
  90      *
  91      * @param string $path     path to connect
  92      * @param array  $defaults path defaults
  93      * @param array  $rules    path rules
  94      * @param array  $result   unused
  95      *
  96      * @return boolean hook return
  97      */
  98     function onStartConnectPath(&$path, &$defaults, &$rules, &$result)
  99     {
 100         if (common_config('site', 'openidonly')) {
 101             // Note that we should not remove the login and register
 102             // actions. Lots of auth-related things link to them,
 103             // such as when visiting a private site without a session
 104             // or revalidating a remembered login for admin work.
 105             //
 106             // We take those two over with redirects to ourselves
 107             // over in onArgsInitialize().
 108             static $block = array('main/recoverpassword',
 109                                   'settings/password');
 110
 111             if (in_array($path, $block)) {
 112                 return false;
 113             }
 114         }
 115
 116         return true;
 117     }
 118
 119     /**
 120      * If we've been hit with password-login args, redirect
 121      *
 122      * @param array $args args (URL, Get, post)
 123      *
 124      * @return boolean hook return
 125      */
 126     function onArgsInitialize($args)
 127     {
 128         if (common_config('site', 'openidonly')) {
 129             if (array_key_exists('action', $args)) {
 130                 $action = trim($args['action']);
 131                 if (in_array($action, array('login', 'register'))) {
 132                     common_redirect(common_local_url('openidlogin'));
 133                     exit(0);
 134                 } else if ($action == 'passwordsettings') {
 135                     common_redirect(common_local_url('openidsettings'));
 136                     exit(0);
 137                 } else if ($action == 'recoverpassword') {
 138                     // TRANS: Client exception thrown when an action is not available.
 139                     throw new ClientException(_m('Unavailable action.'));
 140                 }
 141             }
 142         }
 143         return true;
 144     }
 145
 146     /**
 147      * Public XRDS output hook
 148      *
 149      * Puts the bits of code needed by some OpenID providers to show
 150      * we're good citizens.
 151      *
 152      * @param Action       $action         Action being executed
 153      * @param XMLOutputter &$xrdsOutputter Output channel
 154      *
 155      * @return boolean hook return
 156      */
 157     function onEndPublicXRDS($action, &$xrdsOutputter)
 158     {
 159         $xrdsOutputter->elementStart('XRD', array('xmlns' => 'xri://$xrd*($v*2.0)',
 160                                                   'xmlns:simple' => 'http://xrds-simple.net/core/1.0',
 161                                                   'version' => '2.0'));
 162         $xrdsOutputter->element('Type', null, 'xri://$xrds*simple');
 163         //consumer
 164         foreach (array('finishopenidlogin', 'finishaddopenid') as $finish) {
 165             $xrdsOutputter->showXrdsService(Auth_OpenID_RP_RETURN_TO_URL_TYPE,
 166                                             common_local_url($finish));
 167         }
 168         //provider
 169         $xrdsOutputter->showXrdsService('http://specs.openid.net/auth/2.0/server',
 170                                         common_local_url('openidserver'),
 171                                         null,
 172                                         null,
 173                                         'http://specs.openid.net/auth/2.0/identifier_select');
 174         $xrdsOutputter->elementEnd('XRD');
 175     }
 176
 177     /**
 178      * User XRDS output hook
 179      *
 180      * Puts the bits of code needed to discover OpenID endpoints.
 181      *
 182      * @param Action       $action         Action being executed
 183      * @param XMLOutputter &$xrdsOutputter Output channel
 184      *
 185      * @return boolean hook return
 186      */
 187     function onEndUserXRDS($action, &$xrdsOutputter)
 188     {
 189         $xrdsOutputter->elementStart('XRD', array('xmlns' => 'xri://$xrd*($v*2.0)',
 190                                                   'xml:id' => 'openid',
 191                                                   'xmlns:simple' => 'http://xrds-simple.net/core/1.0',
 192                                                   'version' => '2.0'));
 193         $xrdsOutputter->element('Type', null, 'xri://$xrds*simple');
 194
 195         //consumer
 196         $xrdsOutputter->showXrdsService('http://specs.openid.net/auth/2.0/return_to',
 197                                         common_local_url('finishopenidlogin'));
 198
 199         //provider
 200         $xrdsOutputter->showXrdsService('http://specs.openid.net/auth/2.0/signon',
 201                                         common_local_url('openidserver'),
 202                                         null,
 203                                         null,
 204                                         common_profile_url($action->user->nickname));
 205         $xrdsOutputter->elementEnd('XRD');
 206     }
 207
 208     /**
 209      * If we're in OpenID-only mode, hide all the main menu except OpenID login.
 210      *
 211      * @param Action $action Action being run
 212      *
 213      * @return boolean hook return
 214      */
 215     function onStartPrimaryNav($action)
 216     {
 217         if (common_config('site', 'openidonly') && !common_logged_in()) {
 218             // TRANS: Tooltip for main menu option "Login"
 219             $tooltip = _m('TOOLTIP', 'Login to the site.');
 220             $action->menuItem(common_local_url('openidlogin'),
 221                               // TRANS: Main menu option when not logged in to log in
 222                               _m('MENU', 'Login'),
 223                               $tooltip,
 224                               false,
 225                               'nav_login');
 226             // TRANS: Tooltip for main menu option "Help"
 227             $tooltip = _m('TOOLTIP', 'Help me!');
 228             $action->menuItem(common_local_url('doc', array('title' => 'help')),
 229                               // TRANS: Main menu option for help on the StatusNet site
 230                               _m('MENU', 'Help'),
 231                               $tooltip,
 232                               false,
 233                               'nav_help');
 234             if (!common_config('site', 'private')) {
 235                 // TRANS: Tooltip for main menu option "Search"
 236                 $tooltip = _m('TOOLTIP', 'Search for people or text.');
 237                 $action->menuItem(common_local_url('peoplesearch'),
 238                                   // TRANS: Main menu option when logged in or when the StatusNet instance is not private
 239                                   _m('MENU', 'Search'), $tooltip, false, 'nav_search');
 240             }
 241             Event::handle('EndPrimaryNav', array($action));
 242             return false;
 243         }
 244         return true;
 245     }
 246
 247     /**
 248      * Menu for login
 249      *
 250      * If we're in openidOnly mode, we disable the menu for all other login.
 251      *
 252      * @param Action $action Action being executed
 253      *
 254      * @return boolean hook return
 255      */
 256     function onStartLoginGroupNav($action)
 257     {
 258         if (common_config('site', 'openidonly')) {
 259             $this->showOpenIDLoginTab($action);
 260             // Even though we replace this code, we
 261             // DON'T run the End* hook, to keep others from
 262             // adding tabs. Not nice, but.
 263             return false;
 264         }
 265
 266         return true;
 267     }
 268
 269     /**
 270      * Menu item for login
 271      *
 272      * @param Action $action Action being executed
 273      *
 274      * @return boolean hook return
 275      */
 276     function onEndLoginGroupNav($action)
 277     {
 278         $this->showOpenIDLoginTab($action);
 279
 280         return true;
 281     }
 282
 283     /**
 284      * Show menu item for login
 285      *
 286      * @param Action $action Action being executed
 287      *
 288      * @return void
 289      */
 290     function showOpenIDLoginTab($action)
 291     {
 292         $action_name = $action->trimmed('action');
 293
 294         $action->menuItem(common_local_url('openidlogin'),
 295                           // TRANS: OpenID plugin menu item on site logon page.
 296                           _m('MENU', 'OpenID'),
 297                           // TRANS: OpenID plugin tooltip for logon menu item.
 298                           _m('Login or register with OpenID.'),
 299                           $action_name === 'openidlogin');
 300     }
 301
 302     /**
 303      * Show menu item for password
 304      *
 305      * We hide it in openID-only mode
 306      *
 307      * @param Action $menu    Widget for menu
 308      * @param void   &$unused Unused value
 309      *
 310      * @return void
 311      */
 312     function onStartAccountSettingsPasswordMenuItem($menu, &$unused) {
 313         if (common_config('site', 'openidonly')) {
 314             return false;
 315         }
 316         return true;
 317     }
 318
 319     /**
 320      * Menu item for OpenID settings
 321      *
 322      * @param Action $action Action being executed
 323      *
 324      * @return boolean hook return
 325      */
 326     function onEndAccountSettingsNav($action)
 327     {
 328         $action_name = $action->trimmed('action');
 329
 330         $action->menuItem(common_local_url('openidsettings'),
 331                           // TRANS: OpenID plugin menu item on user settings page.
 332                           _m('MENU', 'OpenID'),
 333                           // TRANS: OpenID plugin tooltip for user settings menu item.
 334                           _m('Add or remove OpenIDs.'),
 335                           $action_name === 'openidsettings');
 336
 337         return true;
 338     }
 339
 340     /**
 341      * Autoloader
 342      *
 343      * Loads our classes if they're requested.
 344      *
 345      * @param string $cls Class requested
 346      *
 347      * @return boolean hook return
 348      */
 349     function onAutoload($cls)
 350     {
 351         switch ($cls)
 352         {
 353         case 'OpenidloginAction':
 354         case 'FinishopenidloginAction':
 355         case 'FinishaddopenidAction':
 356         case 'XrdsAction':
 357         case 'PublicxrdsAction':
 358         case 'OpenidsettingsAction':
 359         case 'OpenidserverAction':
 360         case 'OpenidtrustAction':
 361         case 'OpenidadminpanelAction':
 362             require_once dirname(__FILE__) . '/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
 363             return false;
 364         case 'User_openid':
 365             require_once dirname(__FILE__) . '/User_openid.php';
 366             return false;
 367         case 'User_openid_trustroot':
 368             require_once dirname(__FILE__) . '/User_openid_trustroot.php';
 369             return false;
 370         case 'Auth_OpenID_TeamsExtension':
 371         case 'Auth_OpenID_TeamsRequest':
 372         case 'Auth_OpenID_TeamsResponse':
 373             require_once dirname(__FILE__) . '/extlib/teams-extension.php';
 374             return false;
 375         default:
 376             return true;
 377         }
 378     }
 379
 380     /**
 381      * Sensitive actions
 382      *
 383      * These actions should use https when SSL support is 'sometimes'
 384      *
 385      * @param Action  $action Action to form an URL for
 386      * @param boolean &$ssl   Whether to mark it for SSL
 387      *
 388      * @return boolean hook return
 389      */
 390     function onSensitiveAction($action, &$ssl)
 391     {
 392         switch ($action)
 393         {
 394         case 'finishopenidlogin':
 395         case 'finishaddopenid':
 396             $ssl = true;
 397             return false;
 398         default:
 399             return true;
 400         }
 401     }
 402
 403     /**
 404      * Login actions
 405      *
 406      * These actions should be visible even when the site is marked private
 407      *
 408      * @param Action  $action Action to show
 409      * @param boolean &$login Whether it's a login action
 410      *
 411      * @return boolean hook return
 412      */
 413     function onLoginAction($action, &$login)
 414     {
 415         switch ($action)
 416         {
 417         case 'openidlogin':
 418         case 'finishopenidlogin':
 419         case 'openidserver':
 420             $login = true;
 421             return false;
 422         default:
 423             return true;
 424         }
 425     }
 426
 427     /**
 428      * We include a <meta> element linking to the userxrds page, for OpenID
 429      * client-side authentication.
 430      *
 431      * @param Action $action Action being shown
 432      *
 433      * @return void
 434      */
 435     function onEndShowHeadElements($action)
 436     {
 437         if ($action instanceof ShowstreamAction) {
 438             $action->element('link', array('rel' => 'openid2.provider',
 439                                            'href' => common_local_url('openidserver')));
 440             $action->element('link', array('rel' => 'openid2.local_id',
 441                                            'href' => $action->profile->profileurl));
 442             $action->element('link', array('rel' => 'openid.server',
 443                                            'href' => common_local_url('openidserver')));
 444             $action->element('link', array('rel' => 'openid.delegate',
 445                                            'href' => $action->profile->profileurl));
 446         }
 447         return true;
 448     }
 449
 450     /**
 451      * Redirect to OpenID login if they have an OpenID
 452      *
 453      * @param Action $action Action being executed
 454      * @param User   $user   User doing the action
 455      *
 456      * @return boolean whether to continue
 457      */
 458     function onRedirectToLogin($action, $user)
 459     {
 460         if (common_config('site', 'openid_only') || (!empty($user) && User_openid::hasOpenID($user->id))) {
 461             common_redirect(common_local_url('openidlogin'), 303);
 462             return false;
 463         }
 464         return true;
 465     }
 466
 467     /**
 468      * Show some extra instructions for using OpenID
 469      *
 470      * @param Action $action Action being executed
 471      *
 472      * @return boolean hook value
 473      */
 474     function onEndShowPageNotice($action)
 475     {
 476         $name = $action->trimmed('action');
 477
 478         switch ($name)
 479         {
 480         case 'register':
 481             if (common_logged_in()) {
 482                 // TRANS: Page notice for logged in users to try and get them to add an OpenID account to their StatusNet account.
 483                 // TRANS: This message contains Markdown links in the form (description)[link].
 484                 $instr = _m('(Have an [OpenID](http://openid.net/)? ' .
 485                   '[Add an OpenID to your account](%%action.openidsettings%%)!');
 486             } else {
 487                 // TRANS: Page notice for anonymous users to try and get them to register with an OpenID account.
 488                 // TRANS: This message contains Markdown links in the form (description)[link].
 489                 $instr = _m('(Have an [OpenID](http://openid.net/)? ' .
 490                   'Try our [OpenID registration]'.
 491                   '(%%action.openidlogin%%)!)');
 492             }
 493             break;
 494         case 'login':
 495             // TRANS: Page notice on the login page to try and get them to log on with an OpenID account.
 496             // TRANS: This message contains Markdown links in the form (description)[link].
 497             $instr = _m('(Have an [OpenID](http://openid.net/)? ' .
 498               'Try our [OpenID login]'.
 499               '(%%action.openidlogin%%)!)');
 500             break;
 501         default:
 502             return true;
 503         }
 504
 505         $output = common_markup_to_html($instr);
 506         $action->raw($output);
 507         return true;
 508     }
 509
 510     /**
 511      * Load our document if requested
 512      *
 513      * @param string &$title  Title to fetch
 514      * @param string &$output HTML to output
 515      *
 516      * @return boolean hook value
 517      */
 518     function onStartLoadDoc(&$title, &$output)
 519     {
 520         if ($title == 'openid') {
 521             $filename = INSTALLDIR.'/plugins/OpenID/doc-src/openid';
 522
 523             $c      = file_get_contents($filename);
 524             $output = common_markup_to_html($c);
 525             return false; // success!
 526         }
 527
 528         return true;
 529     }
 530
 531     /**
 532      * Add our document to the global menu
 533      *
 534      * @param string $title   Title being fetched
 535      * @param string &$output HTML being output
 536      *
 537      * @return boolean hook value
 538      */
 539     function onEndLoadDoc($title, &$output)
 540     {
 541         if ($title == 'help') {
 542             // TRANS: Item on help page. This message contains Markdown links in the form [description](link).
 543             $menuitem = _m('* [OpenID](%%doc.openid%%) - What OpenID is and how to use it with this service.');
 544
 545             $output .= common_markup_to_html($menuitem);
 546         }
 547
 548         return true;
 549     }
 550
 551     /**
 552      * Data definitions
 553      *
 554      * Assure that our data objects are available in the DB
 555      *
 556      * @return boolean hook value
 557      */
 558     function onCheckSchema()
 559     {
 560         $schema = Schema::get();
 561         $schema->ensureTable('user_openid',
 562                              array(new ColumnDef('canonical', 'varchar',
 563                                                  '255', false, 'PRI'),
 564                                    new ColumnDef('display', 'varchar',
 565                                                  '255', false, 'UNI'),
 566                                    new ColumnDef('user_id', 'integer',
 567                                                  null, false, 'MUL'),
 568                                    new ColumnDef('created', 'datetime',
 569                                                  null, false),
 570                                    new ColumnDef('modified', 'timestamp')));
 571         $schema->ensureTable('user_openid_trustroot',
 572                              array(new ColumnDef('trustroot', 'varchar',
 573                                                  '255', false, 'PRI'),
 574                                    new ColumnDef('user_id', 'integer',
 575                                                  null, false, 'PRI'),
 576                                    new ColumnDef('created', 'datetime',
 577                                                  null, false),
 578                                    new ColumnDef('modified', 'timestamp')));
 579
 580         /* These are used by JanRain OpenID library */
 581
 582         $schema->ensureTable('oid_associations',
 583                              array(
 584                                  'fields' => array(
 585                                      'server_url' => array('type' => 'blob', 'not null' => true),
 586                                      'handle' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'default' => ''), // character set latin1,
 587                                      'secret' => array('type' => 'blob'),
 588                                      'issued' => array('type' => 'int'),
 589                                      'lifetime' => array('type' => 'int'),
 590                                      'assoc_type' => array('type' => 'varchar', 'length' => 64),
 591                                  ),
 592                                  'primary key' => array(array('server_url', 255), 'handle'),
 593                              ));
 594         $schema->ensureTable('oid_nonces',
 595                              array(
 596                                  'fields' => array(
 597                                      'server_url' => array('type' => 'varchar', 'length' => 2047),
 598                                      'timestamp' => array('type' => 'int'),
 599                                      'salt' => array('type' => 'char', 'length' => 40),
 600                                  ),
 601                                  'unique keys' => array(
 602                                      'oid_nonces_server_url_timestamp_salt_key' => array(array('server_url', 255), 'timestamp', 'salt'),
 603                                  ),
 604                              ));
 605
 606         return true;
 607     }
 608
 609     /**
 610      * Add our tables to be deleted when a user is deleted
 611      *
 612      * @param User  $user    User being deleted
 613      * @param array &$tables Array of table names
 614      *
 615      * @return boolean hook value
 616      */
 617     function onUserDeleteRelated($user, &$tables)
 618     {
 619         $tables[] = 'User_openid';
 620         $tables[] = 'User_openid_trustroot';
 621         return true;
 622     }
 623
 624     /**
 625      * Add an OpenID tab to the admin panel
 626      *
 627      * @param Widget $nav Admin panel nav
 628      *
 629      * @return boolean hook value
 630      */
 631     function onEndAdminPanelNav($nav)
 632     {
 633         if (AdminPanelAction::canAdmin('openid')) {
 634
 635             $action_name = $nav->action->trimmed('action');
 636
 637             $nav->out->menuItem(
 638                 common_local_url('openidadminpanel'),
 639                 // TRANS: OpenID configuration menu item.
 640                 _m('MENU','OpenID'),
 641                 // TRANS: Tooltip for OpenID configuration menu item.
 642                 _m('OpenID configuration.'),
 643                 $action_name == 'openidadminpanel',
 644                 'nav_openid_admin_panel'
 645             );
 646         }
 647
 648         return true;
 649     }
 650
 651     /**
 652      * Add OpenID information to the Account Management Control Document
 653      * Event supplied by the Account Manager plugin
 654      *
 655      * @param array &$amcd Array that expresses the AMCD
 656      *
 657      * @return boolean hook value
 658      */
 659
 660     function onEndAccountManagementControlDocument(&$amcd)
 661     {
 662         $amcd['auth-methods']['openid'] = array(
 663             'connect' => array(
 664                 'method' => 'POST',
 665                 'path' => common_local_url('openidlogin'),
 666                 'params' => array(
 667                     'identity' => 'openid_url'
 668                 )
 669             )
 670         );
 671     }
 672
 673     /**
 674      * Add our version information to output
 675      *
 676      * @param array &$versions Array of version-data arrays
 677      *
 678      * @return boolean hook value
 679      */
 680     function onPluginVersion(&$versions)
 681     {
 682         $versions[] = array('name' => 'OpenID',
 683                             'version' => STATUSNET_VERSION,
 684                             'author' => 'Evan Prodromou, Craig Andrews',
 685                             'homepage' => 'http://status.net/wiki/Plugin:OpenID',
 686                             'rawdescription' =>
 687                             // TRANS: Plugin description.
 688                             _m('Use <a href="http://openid.net/">OpenID</a> to login to the site.'));
 689         return true;
 690     }
 691
 692     function onStartOAuthLoginForm($action, &$button)
 693     {
 694         if (common_config('site', 'openidonly')) {
 695             // Cancel the regular password login form, we won't need it.
 696             $this->showOAuthLoginForm($action);
 697             // TRANS: button label for OAuth authorization page when needing OpenID authentication first.
 698             $button = _m('BUTTON', 'Continue');
 699             return false;
 700         } else {
 701             // Leave the regular password login form in place.
 702             // We'll add an OpenID link at bottom...?
 703             return true;
 704         }
 705     }
 706
 707     /**
 708      * @fixme merge with common code for main OpenID login form
 709      * @param HTMLOutputter $action
 710      */
 711     protected function showOAuthLoginForm($action)
 712     {
 713         $action->elementStart('fieldset');
 714         // TRANS: OpenID plugin logon form legend.
 715         $action->element('legend', null, _m('LEGEND','OpenID login'));
 716
 717         $action->elementStart('ul', 'form_data');
 718         $action->elementStart('li');
 719         $provider = common_config('openid', 'trusted_provider');
 720         $appendUsername = common_config('openid', 'append_username');
 721         if ($provider) {
 722             // TRANS: Field label.
 723             $action->element('label', array(), _m('OpenID provider'));
 724             $action->element('span', array(), $provider);
 725             if ($appendUsername) {
 726                 $action->element('input', array('id' => 'openid_username',
 727                                               'name' => 'openid_username',
 728                                               'style' => 'float: none'));
 729             }
 730             $action->element('p', 'form_guide',
 731                            // TRANS: Form guide.
 732                            ($appendUsername ? _m('Enter your username.') . ' ' : '') .
 733                            // TRANS: Form guide.
 734                            _m('You will be sent to the provider\'s site for authentication.'));
 735             $action->hidden('openid_url', $provider);
 736         } else {
 737             // TRANS: OpenID plugin logon form field label.
 738             $action->input('openid_url', _m('OpenID URL'),
 739                          '',
 740                         // TRANS: OpenID plugin logon form field instructions.
 741                          _m('Your OpenID URL.'));
 742         }
 743         $action->elementEnd('li');
 744         $action->elementEnd('ul');
 745
 746         $action->elementEnd('fieldset');
 747     }
 748
 749     /**
 750      * Handle a POST user credential check in apioauthauthorization.
 751      * If given an OpenID URL, we'll pass us over to the regular things
 752      * and then redirect back here on completion.
 753      *
 754      * @fixme merge with common code for main OpenID login form
 755      * @param HTMLOutputter $action
 756      */
 757     function onStartOAuthLoginCheck($action, &$user)
 758     {
 759         $provider = common_config('openid', 'trusted_provider');
 760         if ($provider) {
 761             $openid_url = $provider;
 762             if (common_config('openid', 'append_username')) {
 763                 $openid_url .= $action->trimmed('openid_username');
 764             }
 765         } else {
 766             $openid_url = $action->trimmed('openid_url');
 767         }
 768
 769         if ($openid_url) {
 770             require_once dirname(__FILE__) . '/openid.php';
 771             oid_assert_allowed($openid_url);
 772
 773             $returnto = common_local_url(
 774                 'ApiOauthAuthorize',
 775                 array(),
 776                 array(
 777                     'oauth_token' => $action->arg('oauth_token'),
 778                     'mode'        => $action->arg('mode')
 779                 )
 780             );
 781             common_set_returnto($returnto);
 782
 783             // This will redirect if functional...
 784             $result = oid_authenticate($openid_url,
 785                                        'finishopenidlogin');
 786             if (is_string($result)) { # error message
 787                 throw new ServerException($result);
 788             } else {
 789                 exit(0);
 790             }
 791         }
 792
 793         return true;
 794     }
 795
 796     /**
 797      * Add link in user's XRD file to allow OpenID login.
 798      *
 799      * This link in the XRD should let users log in with their
 800      * Webfinger identity to services that support it. See
 801      * http://webfinger.org/login for an example.
 802      *
 803      * @param XRD  &$xrd Currently-displaying XRD object
 804      * @param User $user The user that it's for
 805      *
 806      * @return boolean hook value (always true)
 807      */
 808
 809     function onEndXrdActionLinks(&$xrd, $user)
 810     {
 811         $profile = $user->getProfile();
 812
 813         if (!empty($profile)) {
 814             $xrd->links[] = array('rel' => 'http://specs.openid.net/auth/2.0/provider',
 815                                   'href' => $profile->profileurl);
 816         }
 817
 818         return true;
 819     }
 820 }