]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - plugins/OpenID/OpenIDPlugin.php
Added more checked type-hints.
[quix0rs-gnu-social.git] / plugins / OpenID / OpenIDPlugin.php
index d1a6786fa8c6d9790dd78aae2607699a7d77d716..ec2e6a85d3d0dab5a48a73d21cd44425a4086cb8 100644 (file)
@@ -20,7 +20,7 @@
  * @category  Plugin
  * @package   StatusNet
  * @author    Evan Prodromou <evan@status.net>
- * @author   Craig Andrews <candrews@integralblue.com>
+ * @author    Craig Andrews <candrews@integralblue.com>
  * @copyright 2009-2010 StatusNet, Inc.
  * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
@@ -37,6 +37,8 @@ if (!defined('STATUSNET')) {
  * This class enables consumer support for OpenID, the distributed authentication
  * and identity system.
  *
+ * Depends on: WebFinger plugin for HostMeta-lookup (user@host format)
+ *
  * @category Plugin
  * @package  StatusNet
  * @author   Evan Prodromou <evan@status.net>
@@ -66,11 +68,11 @@ class OpenIDPlugin extends Plugin
      *
      * Hook for RouterInitialized event.
      *
-     * @param Net_URL_Mapper $m URL mapper
+     * @param URLMapper $m URL mapper
      *
      * @return boolean hook return
      */
-    function onStartInitializeRouter($m)
+    public function onStartInitializeRouter(URLMapper $m)
     {
         $m->connect('main/openid', array('action' => 'openidlogin'));
         $m->connect('main/openidtrust', array('action' => 'openidtrust'));
@@ -80,7 +82,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;
     }
@@ -130,12 +132,11 @@ class OpenIDPlugin extends Plugin
                 $action = trim($args['action']);
                 if (in_array($action, array('login', 'register'))) {
                     common_redirect(common_local_url('openidlogin'));
-                    exit(0);
                 } else if ($action == 'passwordsettings') {
                     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.'));
                 }
             }
         }
@@ -215,7 +216,7 @@ class OpenIDPlugin extends Plugin
     {
         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'),
@@ -232,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');
@@ -248,11 +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);
@@ -268,11 +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);
 
@@ -294,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');
     }
 
@@ -318,11 +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');
 
@@ -330,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;
@@ -349,31 +350,14 @@ class OpenIDPlugin extends Plugin
     {
         switch ($cls)
         {
-        case 'OpenidloginAction':
-        case 'FinishopenidloginAction':
-        case 'FinishaddopenidAction':
-        case 'XrdsAction':
-        case 'PublicxrdsAction':
-        case 'OpenidsettingsAction':
-        case 'OpenidserverAction':
-        case 'OpenidtrustAction':
-        case 'OpenidadminpanelAction':
-            require_once dirname(__FILE__) . '/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
-            return false;
-        case 'User_openid':
-            require_once dirname(__FILE__) . '/User_openid.php';
-            return false;
-        case 'User_openid_trustroot':
-            require_once dirname(__FILE__) . '/User_openid_trustroot.php';
-            return false;
         case 'Auth_OpenID_TeamsExtension':
         case 'Auth_OpenID_TeamsRequest':
         case 'Auth_OpenID_TeamsResponse':
             require_once dirname(__FILE__) . '/extlib/teams-extension.php';
             return false;
-        default:
-            return true;
         }
+
+        return parent::onAutoload($cls);
     }
 
     /**
@@ -424,8 +408,8 @@ class OpenIDPlugin extends Plugin
     }
 
     /**
-     * We include a <meta> element linking to the userxrds page, for OpenID
-     * client-side authentication.
+     * We include a <meta> element linking to the webfinger resource page,
+     * for OpenID client-side authentication.
      *
      * @param Action $action Action being shown
      *
@@ -458,7 +442,6 @@ class OpenIDPlugin extends Plugin
     {
         if (common_config('site', 'openid_only') || (!empty($user) && User_openid::hasOpenID($user->id))) {
             common_redirect(common_local_url('openidlogin'), 303);
-            return false;
         }
         return true;
     }
@@ -478,18 +461,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;
@@ -529,14 +518,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;
     }
 
@@ -550,24 +537,36 @@ class OpenIDPlugin extends Plugin
     function onCheckSchema()
     {
         $schema = Schema::get();
-        $schema->ensureTable('user_openid',
-                             array(new ColumnDef('canonical', 'varchar',
-                                                 '255', false, 'PRI'),
-                                   new ColumnDef('display', 'varchar',
-                                                 '255', false, 'UNI'),
-                                   new ColumnDef('user_id', 'integer',
-                                                 null, false, 'MUL'),
-                                   new ColumnDef('created', 'datetime',
-                                                 null, false),
-                                   new ColumnDef('modified', 'timestamp')));
-        $schema->ensureTable('user_openid_trustroot',
-                             array(new ColumnDef('trustroot', 'varchar',
-                                                 '255', false, 'PRI'),
-                                   new ColumnDef('user_id', 'integer',
-                                                 null, false, 'PRI'),
-                                   new ColumnDef('created', 'datetime',
-                                                 null, false),
-                                   new ColumnDef('modified', 'timestamp')));
+        $schema->ensureTable('user_openid', User_openid::schemaDef());
+        $schema->ensureTable('user_openid_trustroot', User_openid_trustroot::schemaDef());
+        $schema->ensureTable('user_openid_prefs', User_openid_prefs::schemaDef());
+
+        /* 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;
     }
 
@@ -593,7 +592,7 @@ class OpenIDPlugin extends Plugin
      *
      * @return boolean hook value
      */
-    function onEndAdminPanelNav($nav)
+    function onEndAdminPanelNav(Menu $nav)
     {
         if (AdminPanelAction::canAdmin('openid')) {
 
@@ -604,7 +603,7 @@ class OpenIDPlugin extends Plugin
                 // TRANS: OpenID configuration menu item.
                 _m('MENU','OpenID'),
                 // TRANS: Tooltip for OpenID configuration menu item.
-                _m('OpenID configuration'),
+                _m('OpenID configuration.'),
                 $action_name == 'openidadminpanel',
                 'nav_openid_admin_panel'
             );
@@ -642,14 +641,14 @@ class OpenIDPlugin extends Plugin
      *
      * @return boolean hook value
      */
-    function onPluginVersion(&$versions)
+    function onPluginVersion(array &$versions)
     {
         $versions[] = array('name' => 'OpenID',
-                            'version' => STATUSNET_VERSION,
+                            'version' => GNUSOCIAL_VERSION,
                             '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;
     }
@@ -677,7 +676,7 @@ class OpenIDPlugin extends Plugin
     {
         $action->elementStart('fieldset');
         // TRANS: OpenID plugin logon form legend.
-        $action->element('legend', null, _m('OpenID login'));
+        $action->element('legend', null, _m('LEGEND','OpenID login'));
 
         $action->elementStart('ul', 'form_data');
         $action->elementStart('li');
@@ -703,7 +702,7 @@ class OpenIDPlugin extends Plugin
             $action->input('openid_url', _m('OpenID URL'),
                          '',
                         // TRANS: OpenID plugin logon form field instructions.
-                         _m('Your OpenID URL'));
+                         _m('Your OpenID URL.'));
         }
         $action->elementEnd('li');
         $action->elementEnd('ul');
@@ -736,7 +735,7 @@ class OpenIDPlugin extends Plugin
             oid_assert_allowed($openid_url);
 
             $returnto = common_local_url(
-                'ApiOauthAuthorize',
+                'ApiOAuthAuthorize',
                 array(),
                 array(
                     'oauth_token' => $action->arg('oauth_token'),
@@ -760,26 +759,54 @@ class OpenIDPlugin extends Plugin
 
     /**
      * 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
-     * 
+     * @param XML_XRD   $xrd    Currently-displaying resource descriptor
+     * @param Profile   $target The profile that it's for
+     *
      * @return boolean hook value (always true)
      */
 
-    function onEndXrdActionLinks(&$xrd, $user)
+    function onEndWebFingerProfileLinks(XML_XRD $xrd, Profile $target)
     {
-        $profile = $user->getProfile();
-       
-        if (!empty($profile)) {
-            $xrd->links[] = array('rel' => 'http://specs.openid.net/auth/2.0/provider',
-                                  'href' => $profile->profileurl);
+        $xrd->links[] = new XML_XRD_Element_Link(
+                            'http://specs.openid.net/auth/2.0/provider',
+                            $target->profileurl);
+
+        return true;
+    }
+
+    /**
+     * Add links in the user's profile block to their OpenID URLs.
+     *
+     * @param Profile $profile The profile being shown
+     * @param Array   &$links  Writeable array of arrays (href, text, image).
+     *
+     * @return boolean hook value (true)
+     */
+    
+    function onOtherAccountProfiles($profile, &$links)
+    {
+        $prefs = User_openid_prefs::getKV('user_id', $profile->id);
+
+        if (empty($prefs) || !$prefs->hide_profile_link) {
+
+            $oid = new User_openid();
+
+            $oid->user_id = $profile->id;
+
+            if ($oid->find()) {
+                while ($oid->fetch()) {
+                    $links[] = array('href' => $oid->display,
+                                     'text' => _('OpenID'),
+                                     'image' => $this->path("icons/openid-16x16.gif"));
+                }
+            }
         }
-       
+
         return true;
     }
 }