]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - plugins/FBConnect/FBConnectPlugin.php
Less intrusive, more reliable way for FB Connect plugin to modify the
[quix0rs-gnu-social.git] / plugins / FBConnect / FBConnectPlugin.php
index 11dc568a9a70f38f6f602d9534ce017b6d395b2b..0dacf90122dcfa8653337a98324f1d73d2aee7f3 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /**
- * Laconica, the distributed open-source microblogging tool
+ * StatusNet, the distributed open-source microblogging tool
  *
  * Plugin to enable Facebook Connect
  *
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  *
  * @category  Plugin
- * @package   Laconica
- * @author    Zach Copley <zach@controlyourself.ca>
- * @copyright 2009 Control Yourself, Inc.
+ * @package   StatusNet
+ * @author    Zach Copley <zach@status.net>
+ * @copyright 2009 StatusNet, Inc.
  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
- * @link      http://laconi.ca/
+ * @link      http://status.net/
  */
 
-if (!defined('LACONICA')) {
+if (!defined('STATUSNET') && !defined('LACONICA')) {
     exit(1);
 }
 
@@ -45,10 +45,10 @@ require_once INSTALLDIR . '/plugins/FBConnect/FBC_XDReceiver.php';
  * Plugin to enable Facebook Connect
  *
  * @category Plugin
- * @package  Laconica
- * @author   Zach Copley <zach@controlyourself.ca>
+ * @package  StatusNet
+ * @author   Zach Copley <zach@status.net>
  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
- * @link     http://laconi.ca/
+ * @link     http://status.net/
  */
 
 class FBConnectPlugin extends Plugin
@@ -69,185 +69,235 @@ class FBConnectPlugin extends Plugin
     // Add in xmlns:fb
     function onStartShowHTML($action)
     {
-        // XXX: Horrible hack to make Safari, FF2, and Chrome work with
-        // Facebook Connect. These browser cannot use Facebook's
-        // DOM parsing routines unless the mime type of the page is
-        // text/html even though Facebook Connect uses XHTML.  This is
-        // A bug in Facebook Connect, and this is a temporary solution
-        // until they fix their JavaScript libs.
-        header('Content-Type: text/html');
 
-        $action->extraHeaders();
+        if ($this->reqFbScripts($action)) {
 
-        $action->startXML('html',
-            '-//W3C//DTD XHTML 1.0 Strict//EN',
-            'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
+            // XXX: Horrible hack to make Safari, FF2, and Chrome work with
+            // Facebook Connect. These browser cannot use Facebook's
+            // DOM parsing routines unless the mime type of the page is
+            // text/html even though Facebook Connect uses XHTML.  This is
+            // A bug in Facebook Connect, and this is a temporary solution
+            // until they fix their JavaScript libs.
+            header('Content-Type: text/html');
 
-        $language = $action->getLanguage();
+            $action->extraHeaders();
 
-        $action->elementStart('html',
-            array('xmlns'  => 'http://www.w3.org/1999/xhtml',
-                  'xmlns:fb' => 'http://www.facebook.com/2008/fbml',
-                  'xml:lang' => $language,
-                  'lang'     => $language));
+            $action->startXML('html');
 
-        return false;
+            $language = $action->getLanguage();
+
+            $action->elementStart('html',
+                array('xmlns'  => 'http://www.w3.org/1999/xhtml',
+                      'xmlns:fb' => 'http://www.facebook.com/2008/fbml',
+                      'xml:lang' => $language,
+                      'lang'     => $language));
+
+            return false;
+
+        } else {
+
+            return true;
+        }
     }
 
     // Note: this script needs to appear in the <body>
 
-    function onStartShowHeader($action)
+    function onEndShowScripts($action)
     {
-        $apikey = common_config('facebook', 'apikey');
-        $plugin_path = common_path('plugins/FBConnect');
-
-        $login_url = common_local_url('FBConnectAuth');
-        $logout_url = common_local_url('logout');
-
-        // XXX: Facebook says we don't need this FB_RequireFeatures(),
-        // but we actually do, for IE and Safari. Gar.
-
-        $html = sprintf('<script type="text/javascript">
-                            window.onload = function () {
-                                FB_RequireFeatures(
-                                    ["XFBML"],
-                                        function() {
-                                            FB.Facebook.init("%s", "../xd_receiver.html");
-                                        }
-                                    ); }
-
-                            function goto_login() {
-                                window.location = "%s";
-                            }
-
-                            function goto_logout() {
-                                window.location = "%s";
-                            }
-                          </script>', $apikey,
-                              $login_url, $logout_url);
-
-        $action->raw($html);
+        if ($this->reqFbScripts($action)) {
+
+            $apikey = common_config('facebook', 'apikey');
+            $plugin_path = common_path('plugins/FBConnect');
+
+            $login_url = common_local_url('FBConnectAuth');
+            $logout_url = common_local_url('logout');
+
+            // XXX: Facebook says we don't need this FB_RequireFeatures(),
+            // but we actually do, for IE and Safari. Gar.
+
+            $js =  '<script type="text/javascript">';
+            $js .= '    $(document).ready(function () {';
+            $js .= '         FB_RequireFeatures(';
+            $js .= '             ["XFBML"], function() {';
+            $js .= '                 FB.init("%1$s", "../xd_receiver.html");';
+            $js .= '             }';
+            $js .= '         );';
+            $js .= '    });';
+
+            $js .= '    function goto_login() {';
+            $js .= '        window.location = "%2$s";';
+            $js .= '    }';
+
+            // The below function alters the logout link so that it logs the user out
+            // of Facebook Connect as well as the site.  However, for some pages
+            // (FB Connect Settings) we need to output the FB Connect scripts (to
+            // show an existing FB connection even if the user isn't authenticated
+            // with Facebook connect) but NOT alter the logout link. And the only
+            // way to reliably do that is with the FB Connect .js libs.  Crazy.
+
+            $js .= '    FB.ensureInit(function() {';
+            $js .= '        FB.Connect.ifUserConnected(';
+            $js .= '            function() { ';
+            $js .= '                $(\'#nav_logout a\').attr(\'href\', \'#\');';
+            $js .= '                $(\'#nav_logout a\').click(function() {';
+            $js .= '                   FB.Connect.logoutAndRedirect(\'%3$s\');';
+            $js .= '                   return false;';
+            $js .= '                })';
+            $js .= '            },';
+            $js .= '            function() {';
+            $js .= '                return false;';
+            $js .= '            }';
+            $js .= '        );';
+            $js .= '     });';
+            $js .= '</script>';
+
+            $js = sprintf($js, $apikey, $login_url, $logout_url);
+
+            // Compress the bugger down a bit
+            $js = str_replace('  ', '', $js);
+
+            $action->raw("  $js");  // leading two spaces to make it line up
+        }
+
     }
 
     // Note: this script needs to appear as close as possible to </body>
 
     function onEndShowFooter($action)
     {
-
-        $action->element('script',
-            array('type' => 'text/javascript',
-                  'src'  => 'http://static.ak.connect.facebook.com/js/api_lib/v0.4/FeatureLoader.js.php'),
-                  '');
+        if ($this->reqFbScripts($action)) {
+            $action->script('http://static.ak.connect.facebook.com/js/api_lib/v0.4/FeatureLoader.js.php');
+        }
     }
 
-    function onEndShowLaconicaStyles($action)
+    function onEndShowStatusNetStyles($action)
     {
-        $action->element('link', array('rel' => 'stylesheet',
-            'type' => 'text/css',
-            'href' => common_path('plugins/FBConnect/FBConnectPlugin.css')));
+        if ($this->reqFbScripts($action)) {
+            $action->cssLink('plugins/FBConnect/FBConnectPlugin.css');
+        }
     }
 
-    function onStartPrimaryNav($action)
+    /**
+     * Does the Action we're plugged into require the FB Scripts?  We only
+     * want to output FB namespace, scripts, CSS, etc. on the pages that
+     * really need them.
+     *
+     * @param Action the action in question
+     *
+     * @return boolean true
+     */
+
+    function reqFbScripts($action) {
+
+        // If you're logged in w/FB Connect, you always need the FB stuff
+
+        $fbuid = $this->loggedIn();
+
+        if (!empty($fbuid)) {
+            return true;
+        }
+
+        // List of actions that require FB stuff
+
+        $needy = array('FBConnectLoginAction',
+                       'FBConnectauthAction',
+                       'FBConnectSettingsAction');
+
+        if (in_array(get_class($action), $needy)) {
+            return true;
+        }
+
+        return false;
+
+    }
+
+    /**
+     * Is the user currently logged in with FB Connect?
+     *
+     * @return mixed $fbuid the Facebook ID of the logged in user, or null
+     */
+
+    function loggedIn()
     {
         $user = common_current_user();
 
-        if ($user) {
+        if (!empty($user)) {
 
             $flink = Foreign_link::getByUserId($user->id,
                 FACEBOOK_CONNECT_SERVICE);
             $fbuid = 0;
 
-            if ($flink) {
+            if (!empty($flink)) {
 
                 try {
 
                     $facebook = getFacebook();
-                    $fbuid = getFacebook()->get_loggedin_user();
+                    $fbuid    = $facebook->get_loggedin_user();
 
                 } catch (Exception $e) {
-                    common_log(LOG_WARNING,
-                        'Problem getting Facebook client: ' .
+                    common_log(LOG_WARNING, 'Facebook Connect Plugin - ' .
+                        'Problem getting Facebook user: ' .
                             $e->getMessage());
                 }
 
-                // Display Facebook Logged in indicator w/Facebook favicon
-
                 if ($fbuid > 0) {
+                    return $fbuid;
+                }
+            }
+        }
 
-                    $action->elementStart('li', array('id' => 'nav_fb'));
-                    $action->elementStart('fb:profile-pic', array('uid' => $flink->foreign_id,
-                        'linked' => 'false',
-                        'width' => 16,
-                        'height' => 16));
-                    $action->elementEnd('fb:profile-pic');
+        return null;
+    }
 
-                    $iconurl =  common_path('/plugins/FBConnect/fbfavicon.ico');
-                    $action->element('img', array('src' => $iconurl));
+    function onStartPrimaryNav($action)
+    {
 
-                    $action->elementEnd('li');
+        $user = common_current_user();
+        $connect = 'FBConnectSettings';
+        if (common_config('xmpp', 'enabled')) {
+            $connect = 'imsettings';
+        } else if (common_config('sms', 'enabled')) {
+            $connect = 'smssettings';
+        } else if (common_config('twitter', 'enabled')) {
+            $connect = 'twittersettings';
+        }
 
-                }
-            }
+        if (!empty($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');
-            }
-            if (common_config('invite', 'enabled')) {
-                $action->menuItem(common_local_url('invite'),
-                    _('Invite'),
-                    sprintf(_('Invite friends and colleagues to join you on %s'),
-                    common_config('site', 'name')),
-                    false, 'nav_invitecontact');
-            }
+            $fbuid = $this->loggedIn();
 
-            // Need to override the Logout link to make it do FB stuff
-            if ($flink && $fbuid > 0) {
-
-                $logout_url = common_local_url('logout');
-                $title =  _('Logout from the site');
-                $text = _('Logout');
-
-                $html = sprintf('<li id="nav_logout"><a href="%s" title="%s" ' .
-                    'onclick="FB.Connect.logout(function() { goto_logout() })">%s</a></li>',
-                    $logout_url, $title, $text);
-
-                $action->raw($html);
-
-             } else {
-                 $action->menuItem(common_local_url('logout'),
-                     _('Logout'), _('Logout from the site'), false, 'nav_logout');
-             }
-         }
-         else {
-             if (!common_config('site', 'closed')) {
-                 $action->menuItem(common_local_url('register'),
-                     _('Register'), _('Create an account'), false, 'nav_register');
-             }
-             $action->menuItem(common_local_url('openidlogin'),
-                 _('OpenID'), _('Login with OpenID'), false, 'nav_openid');
-             $action->menuItem(common_local_url('login'),
-                 _('Login'), _('Login to the site'), false, 'nav_login');
-         }
-
-         $action->menuItem(common_local_url('doc', array('title' => 'help')),
-             _('Help'), _('Help me!'), false, 'nav_help');
-         $action->menuItem(common_local_url('peoplesearch'),
-             _('Search'), _('Search for people or text'), false, 'nav_search');
+            if (!empty($fbuid)) {
 
-        return false;
+                /* Default FB silhouette pic for FB users who haven't
+                   uploaded a profile pic yet. */
+
+                $silhouetteUrl =
+                    'http://static.ak.fbcdn.net/pics/q_silhouette.gif';
+
+                $url = $this->getProfilePicURL($fbuid);
+
+                $action->elementStart('li', array('id' => 'nav_fb'));
+
+                $action->element('img', array('id' => 'fbc_profile-pic',
+                    'src' => (!empty($url)) ? $url : $silhouetteUrl,
+                    'alt' => 'Facebook Connect User',
+                    'width' => '16'), '');
+
+                $iconurl =  common_path('plugins/FBConnect/fbfavicon.ico');
+                $action->element('img', array('id' => 'fb_favicon',
+                    'src' => $iconurl));
+
+                $action->elementEnd('li');
+
+            }
+        }
+
+        return true;
     }
 
     function onStartShowLocalNavBlock($action)
     {
-        $action_name = get_class($action);
+        $action_name   = get_class($action);
 
         $login_actions = array('LoginAction', 'RegisterAction',
             'OpenidloginAction', 'FBConnectLoginAction');
@@ -258,7 +308,7 @@ class FBConnectPlugin extends Plugin
             return false;
         }
 
-        $connect_actions = array('SmssettingsAction',
+        $connect_actions = array('SmssettingsAction', 'ImsettingsAction',
             'TwittersettingsAction', 'FBConnectSettingsAction');
 
         if (in_array($action_name, $connect_actions)) {
@@ -272,30 +322,46 @@ class FBConnectPlugin extends Plugin
 
     function onStartLogout($action)
     {
-        $user = common_current_user();
+        $action->logout();
+        $fbuid = $this->loggedIn();
 
-        $flink = Foreign_link::getByUserId($user->id, FACEBOOK_CONNECT_SERVICE);
+        if (!empty($fbuid)) {
+            try {
+                $facebook = getFacebook();
+                $facebook->expire_session();
+            } catch (Exception $e) {
+                common_log(LOG_WARNING, 'Facebook Connect Plugin - ' .
+                           'Could\'t logout of Facebook: ' .
+                           $e->getMessage());
+            }
+        }
 
-        $action->logout();
+        return true;
+    }
 
-        if ($flink) {
+    function getProfilePicURL($fbuid)
+    {
 
-            $facebook = getFacebook();
+        $facebook = getFacebook();
+        $url      = null;
 
-            try {
-                $fbuid = $facebook->get_loggedin_user();
+        try {
 
-                if ($fbuid > 0) {
-                    $facebook->logout(common_local_url('public'));
-                }
+            $fqry = 'SELECT pic_square FROM user WHERE uid = %s';
 
-            } catch (Exception $e) {
-                common_log(LOG_WARNING, 'Could\'t logout of Facebook: ' .
-                    $e->getMessage());
+            $result = $facebook->api_client->fql_query(sprintf($fqry, $fbuid));
+
+            if (!empty($result)) {
+                $url = $result[0]['pic_square'];
             }
+
+        } catch (Exception $e) {
+            common_log(LOG_WARNING, 'Facebook Connect Plugin - ' .
+                       "Facebook client failure requesting profile pic!");
         }
 
-        return true;
+       return $url;
+
     }
 
 }