]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - plugins/OpenID/OpenIDPlugin.php
Merge branch '1.1.x' of gitorious.org:statusnet/mainline into 1.1.x
[quix0rs-gnu-social.git] / plugins / OpenID / OpenIDPlugin.php
index a033a50109087cd887487987cac5ba51bbdbf99a..ed6d6534c09dbdaff0ebef609fabd235cee9b628 100644 (file)
@@ -46,7 +46,6 @@ if (!defined('STATUSNET')) {
  * @link     http://status.net/
  * @link     http://openid.net/
  */
-
 class OpenIDPlugin extends Plugin
 {
     // Plugin parameter: set true to disallow non-OpenID logins
@@ -60,7 +59,6 @@ class OpenIDPlugin extends Plugin
             global $config;
             $config['site']['openidonly'] = (bool)$this->openidOnly;
         }
-
     }
 
     /**
@@ -72,7 +70,6 @@ class OpenIDPlugin extends Plugin
      *
      * @return boolean hook return
      */
-
     function onStartInitializeRouter($m)
     {
         $m->connect('main/openid', array('action' => 'openidlogin'));
@@ -83,7 +80,7 @@ class OpenIDPlugin extends Plugin
         $m->connect('index.php?action=finishaddopenid',
                     array('action' => 'finishaddopenid'));
         $m->connect('main/openidserver', array('action' => 'openidserver'));
-        $m->connect('admin/openid', array('action' => 'openidadminpanel'));
+        $m->connect('panel/openid', array('action' => 'openidadminpanel'));
 
         return true;
     }
@@ -98,7 +95,6 @@ class OpenIDPlugin extends Plugin
      *
      * @return boolean hook return
      */
-
     function onStartConnectPath(&$path, &$defaults, &$rules, &$result)
     {
         if (common_config('site', 'openidonly')) {
@@ -127,7 +123,6 @@ class OpenIDPlugin extends Plugin
      *
      * @return boolean hook return
      */
-
     function onArgsInitialize($args)
     {
         if (common_config('site', 'openidonly')) {
@@ -140,7 +135,8 @@ class OpenIDPlugin extends Plugin
                     common_redirect(common_local_url('openidsettings'));
                     exit(0);
                 } else if ($action == 'recoverpassword') {
-                    throw new ClientException('Unavailable action');
+                    // TRANS: Client exception thrown when an action is not available.
+                    throw new ClientException(_m('Unavailable action.'));
                 }
             }
         }
@@ -158,7 +154,6 @@ class OpenIDPlugin extends Plugin
      *
      * @return boolean hook return
      */
-
     function onEndPublicXRDS($action, &$xrdsOutputter)
     {
         $xrdsOutputter->elementStart('XRD', array('xmlns' => 'xri://$xrd*($v*2.0)',
@@ -189,7 +184,6 @@ class OpenIDPlugin extends Plugin
      *
      * @return boolean hook return
      */
-
     function onEndUserXRDS($action, &$xrdsOutputter)
     {
         $xrdsOutputter->elementStart('XRD', array('xmlns' => 'xri://$xrd*($v*2.0)',
@@ -218,12 +212,11 @@ class OpenIDPlugin extends Plugin
      *
      * @return boolean hook return
      */
-
     function onStartPrimaryNav($action)
     {
         if (common_config('site', 'openidonly') && !common_logged_in()) {
             // TRANS: Tooltip for main menu option "Login"
-            $tooltip = _m('TOOLTIP', 'Login to the site');
+            $tooltip = _m('TOOLTIP', 'Login to the site.');
             $action->menuItem(common_local_url('openidlogin'),
                               // TRANS: Main menu option when not logged in to log in
                               _m('MENU', 'Login'),
@@ -240,7 +233,7 @@ class OpenIDPlugin extends Plugin
                               'nav_help');
             if (!common_config('site', 'private')) {
                 // TRANS: Tooltip for main menu option "Search"
-                $tooltip = _m('TOOLTIP', 'Search for people or text');
+                $tooltip = _m('TOOLTIP', 'Search for people or text.');
                 $action->menuItem(common_local_url('peoplesearch'),
                                   // TRANS: Main menu option when logged in or when the StatusNet instance is not private
                                   _m('MENU', 'Search'), $tooltip, false, 'nav_search');
@@ -256,12 +249,11 @@ class OpenIDPlugin extends Plugin
      *
      * If we're in openidOnly mode, we disable the menu for all other login.
      *
-     * @param Action &$action Action being executed
+     * @param Action $action Action being executed
      *
      * @return boolean hook return
      */
-
-    function onStartLoginGroupNav(&$action)
+    function onStartLoginGroupNav($action)
     {
         if (common_config('site', 'openidonly')) {
             $this->showOpenIDLoginTab($action);
@@ -277,12 +269,11 @@ class OpenIDPlugin extends Plugin
     /**
      * Menu item for login
      *
-     * @param Action &$action Action being executed
+     * @param Action $action Action being executed
      *
      * @return boolean hook return
      */
-
-    function onEndLoginGroupNav(&$action)
+    function onEndLoginGroupNav($action)
     {
         $this->showOpenIDLoginTab($action);
 
@@ -296,7 +287,6 @@ class OpenIDPlugin extends Plugin
      *
      * @return void
      */
-
     function showOpenIDLoginTab($action)
     {
         $action_name = $action->trimmed('action');
@@ -305,7 +295,7 @@ class OpenIDPlugin extends Plugin
                           // TRANS: OpenID plugin menu item on site logon page.
                           _m('MENU', 'OpenID'),
                           // TRANS: OpenID plugin tooltip for logon menu item.
-                          _m('Login or register with OpenID'),
+                          _m('Login or register with OpenID.'),
                           $action_name === 'openidlogin');
     }
 
@@ -319,7 +309,6 @@ class OpenIDPlugin extends Plugin
      *
      * @return void
      */
-
     function onStartAccountSettingsPasswordMenuItem($menu, &$unused) {
         if (common_config('site', 'openidonly')) {
             return false;
@@ -330,12 +319,11 @@ class OpenIDPlugin extends Plugin
     /**
      * Menu item for OpenID settings
      *
-     * @param Action &$action Action being executed
+     * @param Action $action Action being executed
      *
      * @return boolean hook return
      */
-
-    function onEndAccountSettingsNav(&$action)
+    function onEndAccountSettingsNav($action)
     {
         $action_name = $action->trimmed('action');
 
@@ -343,7 +331,7 @@ class OpenIDPlugin extends Plugin
                           // TRANS: OpenID plugin menu item on user settings page.
                           _m('MENU', 'OpenID'),
                           // TRANS: OpenID plugin tooltip for user settings menu item.
-                          _m('Add or remove OpenIDs'),
+                          _m('Add or remove OpenIDs.'),
                           $action_name === 'openidsettings');
 
         return true;
@@ -358,7 +346,6 @@ class OpenIDPlugin extends Plugin
      *
      * @return boolean hook return
      */
-
     function onAutoload($cls)
     {
         switch ($cls)
@@ -400,7 +387,6 @@ class OpenIDPlugin extends Plugin
      *
      * @return boolean hook return
      */
-
     function onSensitiveAction($action, &$ssl)
     {
         switch ($action)
@@ -424,7 +410,6 @@ class OpenIDPlugin extends Plugin
      *
      * @return boolean hook return
      */
-
     function onLoginAction($action, &$login)
     {
         switch ($action)
@@ -447,7 +432,6 @@ class OpenIDPlugin extends Plugin
      *
      * @return void
      */
-
     function onEndShowHeadElements($action)
     {
         if ($action instanceof ShowstreamAction) {
@@ -471,7 +455,6 @@ class OpenIDPlugin extends Plugin
      *
      * @return boolean whether to continue
      */
-
     function onRedirectToLogin($action, $user)
     {
         if (common_config('site', 'openid_only') || (!empty($user) && User_openid::hasOpenID($user->id))) {
@@ -488,7 +471,6 @@ class OpenIDPlugin extends Plugin
      *
      * @return boolean hook value
      */
-
     function onEndShowPageNotice($action)
     {
         $name = $action->trimmed('action');
@@ -497,18 +479,24 @@ class OpenIDPlugin extends Plugin
         {
         case 'register':
             if (common_logged_in()) {
-                $instr = '(Have an [OpenID](http://openid.net/)? ' .
-                  '[Add an OpenID to your account](%%action.openidsettings%%)!';
+                // TRANS: Page notice for logged in users to try and get them to add an OpenID account to their StatusNet account.
+                // TRANS: This message contains Markdown links in the form (description)[link].
+                $instr = _m('(Have an [OpenID](http://openid.net/)? ' .
+                  '[Add an OpenID to your account](%%action.openidsettings%%)!');
             } else {
-                $instr = '(Have an [OpenID](http://openid.net/)? ' .
+                // TRANS: Page notice for anonymous users to try and get them to register with an OpenID account.
+                // TRANS: This message contains Markdown links in the form (description)[link].
+                $instr = _m('(Have an [OpenID](http://openid.net/)? ' .
                   'Try our [OpenID registration]'.
-                  '(%%action.openidlogin%%)!)';
+                  '(%%action.openidlogin%%)!)');
             }
             break;
         case 'login':
-            $instr = '(Have an [OpenID](http://openid.net/)? ' .
+            // TRANS: Page notice on the login page to try and get them to log on with an OpenID account.
+            // TRANS: This message contains Markdown links in the form (description)[link].
+            $instr = _m('(Have an [OpenID](http://openid.net/)? ' .
               'Try our [OpenID login]'.
-              '(%%action.openidlogin%%)!)';
+              '(%%action.openidlogin%%)!)');
             break;
         default:
             return true;
@@ -527,7 +515,6 @@ class OpenIDPlugin extends Plugin
      *
      * @return boolean hook value
      */
-
     function onStartLoadDoc(&$title, &$output)
     {
         if ($title == 'openid') {
@@ -549,15 +536,12 @@ class OpenIDPlugin extends Plugin
      *
      * @return boolean hook value
      */
-
-    function onEndLoadDoc($title, &$output)
-    {
-        if ($title == 'help') {
-            $menuitem = '* [OpenID](%%doc.openid%%) - what OpenID is and how to use it with this service';
-
-            $output .= common_markup_to_html($menuitem);
-        }
-
+    function onEndDocsMenu(&$items) {
+        $items[] = array('doc', 
+                         array('title' => 'openid'),
+                         _m('MENU', 'OpenID'),
+                         _('Logging in with OpenID'),
+                         'nav_doc_openid');
         return true;
     }
 
@@ -568,7 +552,6 @@ class OpenIDPlugin extends Plugin
      *
      * @return boolean hook value
      */
-
     function onCheckSchema()
     {
         $schema = Schema::get();
@@ -590,6 +573,33 @@ class OpenIDPlugin extends Plugin
                                    new ColumnDef('created', 'datetime',
                                                  null, false),
                                    new ColumnDef('modified', 'timestamp')));
+
+        /* These are used by JanRain OpenID library */
+
+        $schema->ensureTable('oid_associations',
+                             array(
+                                 'fields' => array(
+                                     'server_url' => array('type' => 'blob', 'not null' => true),
+                                     'handle' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'default' => ''), // character set latin1,
+                                     'secret' => array('type' => 'blob'),
+                                     'issued' => array('type' => 'int'),
+                                     'lifetime' => array('type' => 'int'),
+                                     'assoc_type' => array('type' => 'varchar', 'length' => 64),
+                                 ),
+                                 'primary key' => array(array('server_url', 255), 'handle'),
+                             ));
+        $schema->ensureTable('oid_nonces',
+                             array(
+                                 'fields' => array(
+                                     'server_url' => array('type' => 'varchar', 'length' => 2047),
+                                     'timestamp' => array('type' => 'int'),
+                                     'salt' => array('type' => 'char', 'length' => 40),
+                                 ),
+                                 'unique keys' => array(
+                                     'oid_nonces_server_url_timestamp_salt_key' => array(array('server_url', 255), 'timestamp', 'salt'),
+                                 ),
+                             ));
+
         return true;
     }
 
@@ -601,7 +611,6 @@ class OpenIDPlugin extends Plugin
      *
      * @return boolean hook value
      */
-
     function onUserDeleteRelated($user, &$tables)
     {
         $tables[] = 'User_openid';
@@ -616,7 +625,6 @@ class OpenIDPlugin extends Plugin
      *
      * @return boolean hook value
      */
-
     function onEndAdminPanelNav($nav)
     {
         if (AdminPanelAction::canAdmin('openid')) {
@@ -625,8 +633,10 @@ class OpenIDPlugin extends Plugin
 
             $nav->out->menuItem(
                 common_local_url('openidadminpanel'),
-                _m('OpenID'),
-                _m('OpenID configuration'),
+                // TRANS: OpenID configuration menu item.
+                _m('MENU','OpenID'),
+                // TRANS: Tooltip for OpenID configuration menu item.
+                _m('OpenID configuration.'),
                 $action_name == 'openidadminpanel',
                 'nav_openid_admin_panel'
             );
@@ -635,6 +645,28 @@ class OpenIDPlugin extends Plugin
         return true;
     }
 
+    /**
+     * Add OpenID information to the Account Management Control Document
+     * Event supplied by the Account Manager plugin
+     *
+     * @param array &$amcd Array that expresses the AMCD
+     *
+     * @return boolean hook value
+     */
+
+    function onEndAccountManagementControlDocument(&$amcd)
+    {
+        $amcd['auth-methods']['openid'] = array(
+            'connect' => array(
+                'method' => 'POST',
+                'path' => common_local_url('openidlogin'),
+                'params' => array(
+                    'identity' => 'openid_url'
+                )
+            )
+        );
+    }
+
     /**
      * Add our version information to output
      *
@@ -642,7 +674,6 @@ class OpenIDPlugin extends Plugin
      *
      * @return boolean hook value
      */
-
     function onPluginVersion(&$versions)
     {
         $versions[] = array('name' => 'OpenID',
@@ -650,8 +681,137 @@ class OpenIDPlugin extends Plugin
                             'author' => 'Evan Prodromou, Craig Andrews',
                             'homepage' => 'http://status.net/wiki/Plugin:OpenID',
                             'rawdescription' =>
-                            // TRANS: OpenID plugin description.
+                            // TRANS: Plugin description.
                             _m('Use <a href="http://openid.net/">OpenID</a> to login to the site.'));
         return true;
     }
+
+    function onStartOAuthLoginForm($action, &$button)
+    {
+        if (common_config('site', 'openidonly')) {
+            // Cancel the regular password login form, we won't need it.
+            $this->showOAuthLoginForm($action);
+            // TRANS: button label for OAuth authorization page when needing OpenID authentication first.
+            $button = _m('BUTTON', 'Continue');
+            return false;
+        } else {
+            // Leave the regular password login form in place.
+            // We'll add an OpenID link at bottom...?
+            return true;
+        }
+    }
+
+    /**
+     * @fixme merge with common code for main OpenID login form
+     * @param HTMLOutputter $action
+     */
+    protected function showOAuthLoginForm($action)
+    {
+        $action->elementStart('fieldset');
+        // TRANS: OpenID plugin logon form legend.
+        $action->element('legend', null, _m('LEGEND','OpenID login'));
+
+        $action->elementStart('ul', 'form_data');
+        $action->elementStart('li');
+        $provider = common_config('openid', 'trusted_provider');
+        $appendUsername = common_config('openid', 'append_username');
+        if ($provider) {
+            // TRANS: Field label.
+            $action->element('label', array(), _m('OpenID provider'));
+            $action->element('span', array(), $provider);
+            if ($appendUsername) {
+                $action->element('input', array('id' => 'openid_username',
+                                              'name' => 'openid_username',
+                                              'style' => 'float: none'));
+            }
+            $action->element('p', 'form_guide',
+                           // TRANS: Form guide.
+                           ($appendUsername ? _m('Enter your username.') . ' ' : '') .
+                           // TRANS: Form guide.
+                           _m('You will be sent to the provider\'s site for authentication.'));
+            $action->hidden('openid_url', $provider);
+        } else {
+            // TRANS: OpenID plugin logon form field label.
+            $action->input('openid_url', _m('OpenID URL'),
+                         '',
+                        // TRANS: OpenID plugin logon form field instructions.
+                         _m('Your OpenID URL.'));
+        }
+        $action->elementEnd('li');
+        $action->elementEnd('ul');
+
+        $action->elementEnd('fieldset');
+    }
+
+    /**
+     * Handle a POST user credential check in apioauthauthorization.
+     * If given an OpenID URL, we'll pass us over to the regular things
+     * and then redirect back here on completion.
+     *
+     * @fixme merge with common code for main OpenID login form
+     * @param HTMLOutputter $action
+     */
+    function onStartOAuthLoginCheck($action, &$user)
+    {
+        $provider = common_config('openid', 'trusted_provider');
+        if ($provider) {
+            $openid_url = $provider;
+            if (common_config('openid', 'append_username')) {
+                $openid_url .= $action->trimmed('openid_username');
+            }
+        } else {
+            $openid_url = $action->trimmed('openid_url');
+        }
+
+        if ($openid_url) {
+            require_once dirname(__FILE__) . '/openid.php';
+            oid_assert_allowed($openid_url);
+
+            $returnto = common_local_url(
+                'ApiOauthAuthorize',
+                array(),
+                array(
+                    'oauth_token' => $action->arg('oauth_token'),
+                   'mode'        => $action->arg('mode')
+                )
+            );
+            common_set_returnto($returnto);
+
+            // This will redirect if functional...
+            $result = oid_authenticate($openid_url,
+                                       'finishopenidlogin');
+            if (is_string($result)) { # error message
+                throw new ServerException($result);
+            } else {
+                exit(0);
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * Add link in user's XRD file to allow OpenID login.
+     *
+     * This link in the XRD should let users log in with their
+     * Webfinger identity to services that support it. See
+     * http://webfinger.org/login for an example.
+     *
+     * @param XRD  &$xrd Currently-displaying XRD object
+     * @param User $user The user that it's for
+     *
+     * @return boolean hook value (always true)
+     */
+
+    function onEndXrdActionLinks(&$xrd, $user)
+    {
+        $profile = $user->getProfile();
+
+        if (!empty($profile)) {
+            $xrd->links[] = array('rel' => 'http://specs.openid.net/auth/2.0/provider',
+                                  'href' => $profile->profileurl);
+        }
+
+        return true;
+    }
 }