From: Zach Copley <zach@controlyourself.ca>
Date: Thu, 21 May 2009 05:43:11 +0000 (+0000)
Subject: - Reworked login / logout workflow
X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=54cd0a2046c417fd072bb4cf79aeda163cf760af;p=quix0rs-gnu-social.git

- Reworked login / logout workflow
- Added Facebook Connect tab to login nav
- Show Facebook mini-avatar when logged in
- Added Facebook Connect tab to connect settings nav
- Option to disconnect from Facebook
---

diff --git a/db/foreign_services.sql b/db/foreign_services.sql
index 557ede0246..79c04cee56 100644
--- a/db/foreign_services.sql
+++ b/db/foreign_services.sql
@@ -2,4 +2,5 @@ insert into foreign_service
     (id, name, description, created)
 values
     ('1','Twitter', 'Twitter Micro-blogging service', now()),
-    ('2','Facebook', 'Facebook', now());
+    ('2','Facebook', 'Facebook', now()),
+    ('3','FacebookConnect', 'Facebook Connect', now());
diff --git a/plugins/FBConnect/FBCSettingsNav.php b/plugins/FBConnect/FBCSettingsNav.php
new file mode 100644
index 0000000000..8b84118532
--- /dev/null
+++ b/plugins/FBConnect/FBCSettingsNav.php
@@ -0,0 +1,113 @@
+<?php
+/**
+ * Laconica, the distributed open-source microblogging tool
+ *
+ * Menu for login group of actions
+ *
+ * PHP version 5
+ *
+ * LICENCE: This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @category  Menu
+ * @package   Laconica
+ * @author    Evan Prodromou <evan@controlyourself.ca>
+ * @author    Zach Copley <zach@controlyourself.ca>
+ * @copyright 2009 Control Yourself, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link      http://laconi.ca/
+ */
+
+if (!defined('LACONICA')) {
+    exit(1);
+}
+
+require_once INSTALLDIR . '/lib/widget.php';
+
+/**
+ * A widget for showing the connect group local nav menu
+ *
+ * @category Output
+ * @package  Laconica
+ * @author   Evan Prodromou <evan@controlyourself.ca>
+ * @author   Zach Copley <zach@controlyourself.ca>
+ * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link     http://laconi.ca/
+ *
+ * @see      Widget
+ */
+
+class FBCSettingsNav extends Widget
+{
+    var $action = null;
+
+    /**
+     * Construction
+     *
+     * @param Action $action current action, used for output
+     */
+
+    function __construct($action=null)
+    {
+        parent::__construct($action);
+        $this->action = $action;
+    }
+
+    /**
+     * Show the menu
+     *
+     * @return void
+     */
+
+    function show()
+    {
+
+        $this->action->elementStart('dl', array('id' => 'site_nav_local_views'));
+        $this->action->element('dt', null, _('Local views'));
+        $this->action->elementStart('dd');
+
+        # action => array('prompt', 'title')
+        $menu =
+          array('imsettings' =>
+                array(_('IM'),
+                      _('Updates by instant messenger (IM)')),
+                'smssettings' =>
+                array(_('SMS'),
+                      _('Updates by SMS')),
+                'twittersettings' =>
+                array(_('Twitter'),
+                      _('Twitter integration options')),
+                'FBConnectSettings' =>
+                array(_('Facebook'),
+                      _('Facebook Connect settings')));
+
+        $action_name = $this->action->trimmed('action');
+        $this->action->elementStart('ul', array('class' => 'nav'));
+
+        foreach ($menu as $menuaction => $menudesc) {
+            if ($menuaction == 'imsettings' &&
+                !common_config('xmpp', 'enabled')) {
+                continue;
+            }
+            $this->action->menuItem(common_local_url($menuaction),
+				    $menudesc[0],
+				    $menudesc[1],
+				    $action_name === $menuaction);
+        }
+
+        $this->action->elementEnd('ul');
+
+        $this->action->elementEnd('dd');
+        $this->action->elementEnd('dl');
+    }
+}
diff --git a/plugins/FBConnect/FBConnectAuth.php b/plugins/FBConnect/FBConnectAuth.php
index 0dc016c05c..e8724cdf9a 100644
--- a/plugins/FBConnect/FBConnectAuth.php
+++ b/plugins/FBConnect/FBConnectAuth.php
@@ -29,7 +29,7 @@
 
 require_once INSTALLDIR . '/plugins/FBConnect/FBConnectPlugin.php';
 
-class FbconnectauthAction extends Action
+class FBConnectauthAction extends Action
 {
 
     var $fbuid      = null;
@@ -38,9 +38,20 @@ class FbconnectauthAction extends Action
     function prepare($args) {
         parent::prepare($args);
 
-        $this->fbuid = getFacebook()->get_loggedin_user();
-        $this->fb_fields = $this->getFacebookFields($this->fbuid,
-            array('first_name', 'last_name', 'name'));
+        try {
+
+            $this->fbuid = getFacebook()->get_loggedin_user();
+
+            if ($this->fbuid > 0) {
+                $this->fb_fields = $this->getFacebookFields($this->fbuid,
+                    array('first_name', 'last_name', 'name'));
+            } else {
+                common_debug("No Facebook User found.");
+            }
+
+        } catch (Exception $e) {
+            common_debug("Problem getting fbuid.");
+        }
 
         return true;
     }
@@ -52,6 +63,7 @@ class FbconnectauthAction extends Action
         if (common_is_real_login()) {
             $this->clientError(_('Already logged in.'));
         } else if ($_SERVER['REQUEST_METHOD'] == 'POST') {
+
             $token = $this->trimmed('token');
             if (!$token || $token != common_session_token()) {
                 $this->showForm(_('There was a problem with your session token. Try again, please.'));
@@ -113,7 +125,7 @@ class FbconnectauthAction extends Action
 
         $this->elementStart('form', array('method' => 'post',
                                           'id' => 'account_connect',
-                                          'action' => common_local_url('fbconnectlogin')));
+                                          'action' => common_local_url('FBConnectAuth')));
         $this->hidden('token', common_session_token());
         $this->element('h2', null,
                        _('Create new account'));
@@ -255,7 +267,7 @@ class FbconnectauthAction extends Action
     {
         common_debug("Trying Facebook Login...");
 
-        $flink = Foreign_link::getByForeignID($this->fbuid, FACEBOOK_SERVICE);
+        $flink = Foreign_link::getByForeignID($this->fbuid, FACEBOOK_CONNECT_SERVICE);
 
         if ($flink) {
             $user = $flink->getUser();
@@ -270,6 +282,9 @@ class FbconnectauthAction extends Action
             }
 
         } else {
+
+            common_debug("no flink found for fbuid: $this->fbuid");
+
             $this->showForm(null, $this->bestNewNickname());
         }
     }
@@ -291,10 +306,12 @@ class FbconnectauthAction extends Action
 
     function flinkUser($user_id, $fbuid)
     {
+        common_debug("flinkUser()");
+
         $flink = new Foreign_link();
         $flink->user_id = $user_id;
         $flink->foreign_id = $fbuid;
-        $flink->service = FACEBOOK_SERVICE;
+        $flink->service = FACEBOOK_CONNECT_SERVICE;
         $flink->created = common_sql_now();
 
         $flink_id = $flink->insert();
diff --git a/plugins/FBConnect/FBConnectLogin.php b/plugins/FBConnect/FBConnectLogin.php
index 70710eb709..7989dc854d 100644
--- a/plugins/FBConnect/FBConnectLogin.php
+++ b/plugins/FBConnect/FBConnectLogin.php
@@ -17,8 +17,8 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-if (!defined('LACONICA')) { 
-    exit(1); 
+if (!defined('LACONICA')) {
+    exit(1);
 }
 
 require_once INSTALLDIR . '/plugins/FBConnect/FBConnectPlugin.php';
@@ -31,8 +31,8 @@ class FBConnectLoginAction extends Action
 
         if (common_is_real_login()) {
             $this->clientError(_('Already logged in.'));
-        } 
-        
+        }
+
         $this->showPage();
     }
 
@@ -58,7 +58,7 @@ class FBConnectLoginAction extends Action
     function showContent() {
 
         $this->elementStart('fieldset');
-        
+
 
         $this->element('fb:login-button', array('onlogin' => 'goto_login()',
             'length' => 'long'));
diff --git a/plugins/FBConnect/FBConnectPlugin.php b/plugins/FBConnect/FBConnectPlugin.php
index 079270510d..36dee04487 100644
--- a/plugins/FBConnect/FBConnectPlugin.php
+++ b/plugins/FBConnect/FBConnectPlugin.php
@@ -31,10 +31,15 @@ if (!defined('LACONICA')) {
     exit(1);
 }
 
+define("FACEBOOK_CONNECT_SERVICE", 3);
+
 require_once INSTALLDIR . '/lib/facebookutil.php';
 require_once INSTALLDIR . '/plugins/FBConnect/FBConnectAuth.php';
 require_once INSTALLDIR . '/plugins/FBConnect/FBConnectLogin.php';
+require_once INSTALLDIR . '/plugins/FBConnect/FBConnectSettings.php';
 require_once INSTALLDIR . '/plugins/FBConnect/FBCLoginGroupNav.php';
+require_once INSTALLDIR . '/plugins/FBConnect/FBCSettingsNav.php';
+
 
 /**
  * Plugin to enable Facebook Connect
@@ -56,32 +61,14 @@ class FBConnectPlugin extends Plugin
 
     // Hook in new actions
     function onRouterInitialized(&$m) {
-        
-        common_debug("onRouterIntialized()");
-        
         $m->connect('main/facebookconnect', array('action' => 'FBConnectAuth'));
         $m->connect('main/facebooklogin', array('action' => 'FBConnectLogin'));
+        $m->connect('settings/facebook', array('action' => 'FBConnectSettings'));
      }
 
     // Add in xmlns:fb
     function onStartShowHTML($action)
     {
-
-        // XXX: This is probably a bad place to do general processing
-        // so maybe I need to make some new events?  Maybe in
-        // Action::prepare?
-
-        $name = get_class($action);
-
-        common_debug("onStartShowHTML: action = $name");
-
-        // Avoid a redirect loop
-        if (!in_array($name, array('FBConnectAuthAction', 'ClientErrorAction'))) {
-
-            $this->checkFacebookUser($action);
-
-        }
-
         $httpaccept = isset($_SERVER['HTTP_ACCEPT']) ?
         $_SERVER['HTTP_ACCEPT'] : null;
 
@@ -128,15 +115,7 @@ class FBConnectPlugin extends Plugin
         $apikey = common_config('facebook', 'apikey');
         $plugin_path = common_path('plugins/FBConnect');
 
-        $login_url = common_get_returnto();
-
-        if ($login_url) {
-            // We don't have to return to it again
-            common_set_returnto(null);
-        } else {
-            $url = common_local_url('public');
-        }
-        
+        $login_url = common_local_url('FBConnectAuth');
         $logout_url = common_local_url('logout');
 
         $html = sprintf('<script type="text/javascript">FB.init("%s", "%s/xd_receiver.htm");
@@ -144,7 +123,7 @@ class FBConnectPlugin extends Plugin
                             function goto_login() {
                                 window.location = "%s";
                             }
-                            
+
                             function goto_logout() {
                                 window.location = "%s";
                             }
@@ -160,22 +139,49 @@ class FBConnectPlugin extends Plugin
         $user = common_current_user();
 
         if ($user) {
-             $action->menuItem(common_local_url('all', array('nickname' => $user->nickname)),
-                             _('Home'), _('Personal profile and friends timeline'), false, 'nav_home');
-             $action->menuItem(common_local_url('profilesettings'),
-                             _('Account'), _('Change your email, avatar, password, profile'), false, 'nav_account');
-             if (common_config('xmpp', 'enabled')) {
-                 $action->menuItem(common_local_url('imsettings'),
-                                 _('Connect'), _('Connect to IM, SMS, Twitter'), false, 'nav_connect');
-             } else {
-                 $action->menuItem(common_local_url('smssettings'),
-                                 _('Connect'), _('Connect to SMS, Twitter'), false, 'nav_connect');
-             }
-             $action->menuItem(common_local_url('invite'),
-                              _('Invite'),
-                              sprintf(_('Invite friends and colleagues to join you on %s'),
-                              common_config('site', 'name')),
-                              false, 'nav_invitecontact');
+
+            $flink = Foreign_link::getByUserId($user->id, FACEBOOK_CONNECT_SERVICE);
+
+            if ($flink) {
+
+                $facebook = getFacebook();
+
+                if ($facebook->api_client->users_isAppUser($flink->foreign_id) ||
+                    $facebook->api_client->added) {
+
+                    // XXX: We need to replace this with a proper mini-icon and only after
+                    // checing the FB Connect JavaScript lib method to see what the Connect
+                    // status is. Checking Connect status looks to be impossible with the
+                    // PHP client.
+
+                    $action->elementStart('li');
+                    $action->elementStart('fb:profile-pic', array('uid' => $flink->foreign_id,
+                        'facebook-logo' => 'true',
+                        'linked' => 'false',
+                        'width' => 32,
+                        'height' => 32));
+                    $action->elementEnd('fb:profile-pic');
+                    $action->elementEnd('li');
+                }
+
+            }
+            
+            $action->menuItem(common_local_url('all', array('nickname' => $user->nickname)),
+                         _('Home'), _('Personal profile and friends timeline'), false, 'nav_home');
+            $action->menuItem(common_local_url('profilesettings'),
+                         _('Account'), _('Change your email, avatar, password, profile'), false, 'nav_account');
+            if (common_config('xmpp', 'enabled')) {
+             $action->menuItem(common_local_url('imsettings'),
+                             _('Connect'), _('Connect to IM, SMS, Twitter'), false, 'nav_connect');
+            } else {
+             $action->menuItem(common_local_url('smssettings'),
+                             _('Connect'), _('Connect to SMS, Twitter'), false, 'nav_connect');
+            }
+            $action->menuItem(common_local_url('invite'),
+                          _('Invite'),
+                          sprintf(_('Invite friends and colleagues to join you on %s'),
+                          common_config('site', 'name')),
+                          false, 'nav_invitecontact');
 
              // Need to override the Logout link to make it do FB stuff
 
@@ -206,89 +212,34 @@ class FBConnectPlugin extends Plugin
          $action->menuItem(common_local_url('peoplesearch'),
                          _('Search'), _('Search for people or text'), false, 'nav_search');
 
-        // Tack on "Connect with Facebook" button
-
-        // XXX: Maybe this looks bad and should not go here.  Where should it go?
-
-        if (!$user) {
-             $action->elementStart('li');
-             $action->element('fb:login-button', array('onlogin' => 'goto_login()',
-                 'length' => 'long'));
-             $action->elementEnd('li');
-        }
-
         return false;
     }
 
-    function checkFacebookUser() {
-
-        $user = common_current_user();
-
-        if ($user) {
-            return;
-        }
-
-        try {
-
-            $facebook = getFacebook();
-            $fbuid = $facebook->get_loggedin_user();
-
-            // If you're a Facebook user and you're logged in do nothing
-
-            // If you're a Facebook user and you're not logged in
-            // redirect to Facebook connect login page because that means you have clicked
-            // the 'connect with Facebook' button and have cookies
-
-            if ($fbuid > 0) {
-
-                if ($facebook->api_client->users_isAppUser($fbuid) ||
-                    $facebook->api_client->added) {
-
-                    // user should be connected...
-
-                    common_debug("Facebook user found: $fbuid");
-
-                    if ($user) {
-                        common_debug("Facebook user is logged in.");
-                        return;
-
-                    } else {
-                        common_debug("Facebook user is NOT logged in.");
-                        common_redirect(common_local_url('FBConnectAuth'), 303);
-                    }
-
-                } else {
-                    common_debug("No Facebook connect user found.");
-                }
-            }
-
-        } catch (Exception $e) {
-            common_debug('Expired FB session.');
-        }
-
-    }
-    
     function onStartShowLocalNavBlock($action)
     {
         $action_name = get_class($action);
-        
-        common_debug($action_name);
-        
-        $login_actions = array('LoginAction', 'RegisterAction', 
+
+        $login_actions = array('LoginAction', 'RegisterAction',
             'OpenidloginAction', 'FacebookStart');
-        
+
         if (in_array($action_name, $login_actions)) {
-        
-            common_debug("LoginAction found!");
-        
             $nav = new FBCLoginGroupNav($action);
             $nav->show();
             return false;
         }
-        
+
+        $connect_actions = array('SmssettingsAction',
+            'TwittersettingsAction', 'FBConnectSettingsAction');
+
+        if (in_array($action_name, $connect_actions)) {
+            $nav = new FBCSettingsNav($action);
+            $nav->show();
+            return false;
+        }
+
         return true;
-        
     }
+
 }
 
 
diff --git a/plugins/FBConnect/FBConnectSettings.php b/plugins/FBConnect/FBConnectSettings.php
new file mode 100644
index 0000000000..b7831269c0
--- /dev/null
+++ b/plugins/FBConnect/FBConnectSettings.php
@@ -0,0 +1,184 @@
+<?php
+/**
+ * Laconica, the distributed open-source microblogging tool
+ *
+ * Facebook Connect settings
+ *
+ * PHP version 5
+ *
+ * LICENCE: This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @category  Settings
+ * @package   Laconica
+ * @author    Zach Copley <zach@controlyourself.ca>
+ * @copyright 2009 Control Yourself, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link      http://laconi.ca/
+ */
+
+if (!defined('LACONICA')) {
+    exit(1);
+}
+
+require_once INSTALLDIR.'/lib/connectsettingsaction.php';
+
+/**
+ * Facebook Connect settings action
+ *
+ * @category Settings
+ * @package  Laconica
+ * @author   Zach Copley <zach@controlyourself.ca>
+ * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link     http://laconi.ca/
+ */
+
+class FBConnectSettingsAction extends ConnectSettingsAction
+{
+    /**
+     * Title of the page
+     *
+     * @return string Title of the page
+     */
+
+    function title()
+    {
+        return _('Facebook Connect Settings');
+    }
+
+    /**
+     * Instructions for use
+     *
+     * @return instructions for use
+     */
+
+    function getInstructions()
+    {
+        return _('Manage how your account connects to Facebook');
+    }
+
+    /**
+     * Content area of the page
+     *
+     * Shows a form for uploading an avatar.
+     *
+     * @return void
+     */
+
+    function showContent()
+    {
+        $user = common_current_user();
+
+        $flink = Foreign_link::getByUserID($user->id, FACEBOOK_CONNECT_SERVICE);
+
+        if (!$flink) {
+
+            $this->element('p', 'form_note',
+                _('There is no Facebook user connected to this account.'));
+
+            $this->element('fb:login-button', array('onlogin' => 'goto_login()',
+                'length' => 'long'));
+
+            return;
+        }
+
+        $this->element('p', 'form_note',
+                       _('Connected Facebook user:'));
+
+        $this->elementStart('p', array('class' => 'facebook-user-display'));
+        $this->elementStart('fb:profile-pic',
+            array('uid' => $flink->foreign_id,
+                  'size' => 'square',
+                  'linked' => 'true',
+                  'facebook-logo' => 'true'));
+        $this->elementEnd('fb:profile-pic');
+
+        $this->elementStart('fb:name', array('uid' => $flink->foreign_id));
+        $this->elementEnd('fb:name');
+        $this->elementEnd('p');
+
+        $this->elementStart('form', array('method' => 'post',
+                                          'id' => 'form_settings_facebook',
+                                          'class' => 'form_settings',
+                                          'action' =>
+                                          common_local_url('FBConnectSettings')));
+
+        $this->hidden('token', common_session_token());
+
+        $this->elementStart('fieldset');
+
+        $this->element('legend', null, _('Disconnect my account from Facebook'));
+
+        if (!$user->password) {
+
+            $this->elementStart('p', array('class' => 'form_guide'));
+            $this->text(_('Disconnecting your Faceboook ' .
+                          'would make it impossible to log in! Please '));
+            $this->element('a',
+                array('href' => common_local_url('passwordsettings')),
+                    _('set a password'));
+
+            $this->text(_(' first.'));
+            $this->elementEnd('p');
+        } else {
+            $this->submit('disconnect', _('Disconnect'));
+         }
+
+        $this->elementEnd('fieldset');
+        $this->elementEnd('form');
+    }
+
+    /**
+     * Handle post
+     *
+     * Disconnects the current Facebook user from the current user's account
+     *
+     * @return void
+     */
+
+    function handlePost()
+    {
+        // CSRF protection
+        $token = $this->trimmed('token');
+        if (!$token || $token != common_session_token()) {
+            $this->showForm(_('There was a problem with your session token. '.
+                              'Try again, please.'));
+            return;
+        }
+
+        if ($this->arg('disconnect')) {
+
+            $user = common_current_user();
+
+            $flink = Foreign_link::getByUserID($user->id, FACEBOOK_CONNECT_SERVICE);
+            $result = $flink->delete();
+
+            if ($result === false) {
+                common_log_db_error($user, 'DELETE', __FILE__);
+                $this->serverError(_('Couldn\'t delete link to Facebook.'));
+                return;
+            }
+
+            $facebook = getFacebook();
+            $facebook->logout();
+
+            $this->showForm(_('Facebook user disconnected.'), true);
+
+        } else {
+            $this->showForm(_('Not sure what you\'re trying to do.'));
+            return;
+        }
+
+    }
+
+}