plugins/FBConnect/FBConnectPlugin.php

   1 <?php
   2 /**
   3  * Laconica, the distributed open-source microblogging tool
   4  *
   5  * Plugin to enable Facebook Connect
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Plugin
  23  * @package   Laconica
  24  * @author    Zach Copley <zach@controlyourself.ca>
  25  * @copyright 2009 Control Yourself, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://laconi.ca/
  28  */
  29
  30 if (!defined('LACONICA')) {
  31     exit(1);
  32 }
  33
  34 define("FACEBOOK_CONNECT_SERVICE", 3);
  35
  36 require_once INSTALLDIR . '/lib/facebookutil.php';
  37 require_once INSTALLDIR . '/plugins/FBConnect/FBConnectAuth.php';
  38 require_once INSTALLDIR . '/plugins/FBConnect/FBConnectLogin.php';
  39 require_once INSTALLDIR . '/plugins/FBConnect/FBConnectSettings.php';
  40 require_once INSTALLDIR . '/plugins/FBConnect/FBCLoginGroupNav.php';
  41 require_once INSTALLDIR . '/plugins/FBConnect/FBCSettingsNav.php';
  42 require_once INSTALLDIR . '/plugins/FBConnect/FBC_XDReceiver.php';
  43
  44 /**
  45  * Plugin to enable Facebook Connect
  46  *
  47  * @category Plugin
  48  * @package  Laconica
  49  * @author   Zach Copley <zach@controlyourself.ca>
  50  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  51  * @link     http://laconi.ca/
  52  */
  53
  54 class FBConnectPlugin extends Plugin
  55 {
  56     function __construct()
  57     {
  58         parent::__construct();
  59     }
  60
  61     // Hook in new actions
  62     function onRouterInitialized(&$m) {
  63         $m->connect('main/facebookconnect', array('action' => 'FBConnectAuth'));
  64         $m->connect('main/facebooklogin', array('action' => 'FBConnectLogin'));
  65         $m->connect('settings/facebook', array('action' => 'FBConnectSettings'));
  66         $m->connect('xd_receiver.html', array('action' => 'FBC_XDReceiver'));
  67      }
  68
  69     // Add in xmlns:fb
  70     function onStartShowHTML($action)
  71     {
  72
  73         if ($this->reqFbScripts($action)) {
  74
  75             // XXX: Horrible hack to make Safari, FF2, and Chrome work with
  76             // Facebook Connect. These browser cannot use Facebook's
  77             // DOM parsing routines unless the mime type of the page is
  78             // text/html even though Facebook Connect uses XHTML.  This is
  79             // A bug in Facebook Connect, and this is a temporary solution
  80             // until they fix their JavaScript libs.
  81             header('Content-Type: text/html');
  82
  83             $action->extraHeaders();
  84
  85             $action->startXML('html',
  86                 '-//W3C//DTD XHTML 1.0 Strict//EN',
  87                 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
  88
  89             $language = $action->getLanguage();
  90
  91             $action->elementStart('html',
  92                 array('xmlns'  => 'http://www.w3.org/1999/xhtml',
  93                       'xmlns:fb' => 'http://www.facebook.com/2008/fbml',
  94                       'xml:lang' => $language,
  95                       'lang'     => $language));
  96
  97             return false;
  98
  99         } else {
 100
 101             return true;
 102         }
 103     }
 104
 105     // Note: this script needs to appear in the <body>
 106
 107     function onStartShowHeader($action)
 108     {
 109         if ($this->reqFbScripts($action)) {
 110
 111             $apikey = common_config('facebook', 'apikey');
 112             $plugin_path = common_path('plugins/FBConnect');
 113
 114             $login_url = common_local_url('FBConnectAuth');
 115             $logout_url = common_local_url('logout');
 116
 117             // XXX: Facebook says we don't need this FB_RequireFeatures(),
 118             // but we actually do, for IE and Safari. Gar.
 119
 120             $html = sprintf('<script type="text/javascript">
 121                                 window.onload = function () {
 122                                     FB_RequireFeatures(
 123                                         ["XFBML"],
 124                                             function() {
 125                                                 FB.init("%s", "../xd_receiver.html",
 126                                                  {"doNotUseCachedConnectState":true });
 127
 128                                             }
 129                                         ); }
 130
 131                                 function goto_login() {
 132                                     window.location = "%s";
 133                                 }
 134
 135                                 function goto_logout() {
 136                                     window.location = "%s";
 137                                 }
 138                               </script>', $apikey,
 139                                   $login_url, $logout_url);
 140
 141             $action->raw($html);
 142         }
 143
 144     }
 145
 146     // Note: this script needs to appear as close as possible to </body>
 147
 148     function onEndShowFooter($action)
 149     {
 150         if ($this->reqFbScripts($action)) {
 151
 152             $action->element('script',
 153                 array('type' => 'text/javascript',
 154                       'src'  => 'http://static.ak.connect.facebook.com/js/api_lib/v0.4/FeatureLoader.js.php'),
 155                       '');
 156         }
 157     }
 158
 159     function onEndShowLaconicaStyles($action)
 160     {
 161
 162         if ($this->reqFbScripts($action)) {
 163
 164             $action->element('link', array('rel' => 'stylesheet',
 165                 'type' => 'text/css',
 166                 'href' => common_path('plugins/FBConnect/FBConnectPlugin.css')));
 167         }
 168     }
 169
 170     /**
 171      * Does the Action we're plugged into require the FB Scripts?  We only
 172      * want to output FB namespace, scripts, CSS, etc. on the pages that
 173      * really need them.
 174      *
 175      * @param Action the action in question
 176      *
 177      * @return boolean true
 178      */
 179
 180     function reqFbScripts($action) {
 181
 182         // If you're logged in w/FB Connect, you always need the FB stuff
 183
 184         $fbuid = $this->loggedIn();
 185
 186         if (!empty($fbuid)) {
 187             return true;
 188         }
 189
 190         // List of actions that require FB stuff
 191
 192         $needy = array('FBConnectLoginAction',
 193                        'FBConnectauthAction',
 194                        'FBConnectSettingsAction');
 195
 196         if (in_array(get_class($action), $needy)) {
 197             return true;
 198         }
 199
 200         return false;
 201
 202     }
 203
 204     /**
 205      * Is the user currently logged in with FB Connect?
 206      *
 207      * @return mixed $fbuid the Facebook ID of the logged in user, or null
 208      */
 209
 210     function loggedIn()
 211     {
 212         $user = common_current_user();
 213
 214         if (!empty($user)) {
 215
 216             $flink = Foreign_link::getByUserId($user->id,
 217                 FACEBOOK_CONNECT_SERVICE);
 218             $fbuid = 0;
 219
 220             if (!empty($flink)) {
 221
 222                 try {
 223
 224                     $facebook = getFacebook();
 225                     $fbuid    = $facebook->api_client->users_getLoggedInUser();
 226
 227                 } catch (Exception $e) {
 228                     common_log(LOG_WARNING,
 229                         'Problem getting Facebook user: ' .
 230                             $e->getMessage());
 231                 }
 232
 233                 if ($fbuid > 0) {
 234                     return $fbuid;
 235                 }
 236             }
 237         }
 238
 239         return null;
 240     }
 241
 242     function onStartPrimaryNav($action)
 243     {
 244
 245         $user = common_current_user();
 246
 247         if (!empty($user)) {
 248
 249             $fbuid = $this->loggedIn();
 250
 251             if (!empty($fbuid)) {
 252
 253                 /* Default FB silhouette pic for FB users who haven't
 254                    uploaded a profile pic yet. */
 255
 256                 $silhouetteUrl =
 257                     'http://static.ak.fbcdn.net/pics/q_silhouette.gif';
 258
 259                 $url = $this->getProfilePicURL($fbuid);
 260
 261                 $action->elementStart('li', array('id' => 'nav_fb'));
 262
 263                 $action->element('img', array('id' => 'fbc_profile-pic',
 264                     'src' => (!empty($url)) ? $url : $silhouetteUrl,
 265                     'alt' => 'Facebook Connect User',
 266                     'width' => '16'), '');
 267
 268                 $iconurl =  common_path('plugins/FBConnect/fbfavicon.ico');
 269                 $action->element('img', array('id' => 'fb_favicon',
 270                     'src' => $iconurl));
 271
 272                 $action->elementEnd('li');
 273
 274             }
 275
 276             $action->menuItem(common_local_url('all', array('nickname' => $user->nickname)),
 277                 _('Home'), _('Personal profile and friends timeline'), false, 'nav_home');
 278             $action->menuItem(common_local_url('profilesettings'),
 279                 _('Account'), _('Change your email, avatar, password, profile'), false, 'nav_account');
 280             if (common_config('xmpp', 'enabled')) {
 281                 $action->menuItem(common_local_url('imsettings'),
 282                     _('Connect'), _('Connect to IM, SMS, Twitter'), false, 'nav_connect');
 283             } else {
 284              $action->menuItem(common_local_url('smssettings'),
 285                  _('Connect'), _('Connect to SMS, Twitter'), false, 'nav_connect');
 286             }
 287             if (common_config('invite', 'enabled')) {
 288                 $action->menuItem(common_local_url('invite'),
 289                     _('Invite'),
 290                     sprintf(_('Invite friends and colleagues to join you on %s'),
 291                     common_config('site', 'name')),
 292                     false, 'nav_invitecontact');
 293             }
 294
 295             // Need to override the Logout link to make it do FB stuff
 296             if (!empty($fbuid)) {
 297
 298                 $logout_url = common_local_url('logout');
 299                 $title =  _('Logout from the site');
 300                 $text = _('Logout');
 301
 302                 $html = sprintf('<li id="nav_logout"><a href="#" title="%s" ' .
 303                     'onclick="FB.Connect.logoutAndRedirect(\'%s\');">%s</a></li>',
 304                     $title, $logout_url, $text);
 305
 306                 $action->raw($html);
 307
 308              } else {
 309                  $action->menuItem(common_local_url('logout'),
 310                      _('Logout'), _('Logout from the site'), false, 'nav_logout');
 311              }
 312          }
 313          else {
 314              if (!common_config('site', 'closed')) {
 315                  $action->menuItem(common_local_url('register'),
 316                      _('Register'), _('Create an account'), false, 'nav_register');
 317              }
 318              $action->menuItem(common_local_url('login'),
 319                  _('Login'), _('Login to the site'), false, 'nav_login');
 320          }
 321
 322          $action->menuItem(common_local_url('doc', array('title' => 'help')),
 323              _('Help'), _('Help me!'), false, 'nav_help');
 324          $action->menuItem(common_local_url('peoplesearch'),
 325              _('Search'), _('Search for people or text'), false, 'nav_search');
 326
 327         return false;
 328     }
 329
 330     function onStartShowLocalNavBlock($action)
 331     {
 332         $action_name   = get_class($action);
 333
 334         $login_actions = array('LoginAction', 'RegisterAction',
 335             'OpenidloginAction', 'FBConnectLoginAction');
 336
 337         if (in_array($action_name, $login_actions)) {
 338             $nav = new FBCLoginGroupNav($action);
 339             $nav->show();
 340             return false;
 341         }
 342
 343         $connect_actions = array('SmssettingsAction', 'ImsettingsAction',
 344             'TwittersettingsAction', 'FBConnectSettingsAction');
 345
 346         if (in_array($action_name, $connect_actions)) {
 347             $nav = new FBCSettingsNav($action);
 348             $nav->show();
 349             return false;
 350         }
 351
 352         return true;
 353     }
 354
 355     function onStartLogout($action)
 356     {
 357         $action->logout();
 358         $fbuid = $this->loggedIn();
 359
 360         if (!empty($fbuid)) {
 361             try {
 362                 $facebook = getFacebook();
 363                 $facebook->expire_session();
 364             } catch (Exception $e) {
 365                 common_log(LOG_WARNING, 'Could\'t logout of Facebook: ' .
 366                     $e->getMessage());
 367             }
 368         }
 369
 370         return true;
 371     }
 372
 373     function getProfilePicURL($fbuid)
 374     {
 375
 376         $facebook = getFacebook();
 377         $url      = null;
 378
 379         try {
 380
 381             $fqry = 'SELECT pic_square FROM user WHERE uid = %s';
 382
 383             $result = $facebook->api_client->fql_query(sprintf($fqry, $fbuid));
 384
 385             if (!empty($result)) {
 386                 $url = $result[0]['pic_square'];
 387             }
 388
 389         } catch (Exception $e) {
 390             common_log(LOG_WARNING, "Facebook client failure requesting profile pic!");
 391         }
 392
 393        return $url;
 394
 395     }
 396
 397 }