FBConnectAuth.php 14.9 KB
Newer Older
1 2
<?php
/**
Evan Prodromou's avatar
Evan Prodromou committed
3
 * StatusNet, the distributed open-source microblogging tool
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
 *
 * Plugin to enable Facebook Connect
 *
 * 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  Plugin
Evan Prodromou's avatar
Evan Prodromou committed
23 24 25
 * @package   StatusNet
 * @author    Zach Copley <zach@status.net>
 * @copyright 2009 StatusNet, Inc.
26
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
Evan Prodromou's avatar
Evan Prodromou committed
27
 * @link      http://status.net/
28 29
 */

Zach Copley's avatar
Zach Copley committed
30
require_once INSTALLDIR . '/plugins/Facebook/FacebookPlugin.php';
31

32
class FBConnectauthAction extends Action
33 34 35 36 37 38 39
{
    var $fbuid      = null;
    var $fb_fields  = null;

    function prepare($args) {
        parent::prepare($args);

40
        $this->fbuid = getFacebook()->get_loggedin_user();
41

42 43 44 45
        if ($this->fbuid > 0) {
            $this->fb_fields = $this->getFacebookFields($this->fbuid,
                                                        array('first_name', 'last_name', 'name'));
        } else {
Zach Copley's avatar
Zach Copley committed
46 47 48 49 50
            list($proxy, $ip) = common_client_ip();

            common_log(LOG_WARNING, 'Facebook Connect Plugin - ' .
                       "Failed auth attempt, proxy = $proxy, ip = $ip.");

51 52
            $this->clientError(_('You must be logged into Facebook to ' .
                                 'use Facebook Connect.'));
53
        }
54 55 56 57 58 59 60 61 62

        return true;
    }

    function handle($args)
    {
        parent::handle($args);

        if (common_is_real_login()) {
63 64 65 66

            // User is already logged in.  Does she already have a linked Facebook acct?
            $flink = Foreign_link::getByForeignID($this->fbuid, FACEBOOK_CONNECT_SERVICE);

67
            if (!empty($flink)) {
68 69

                // User already has a linked Facebook account and shouldn't be here
Zach Copley's avatar
Zach Copley committed
70 71 72
                common_debug('Facebook Connect Plugin - ' .
                             'There is already a local user (' . $flink->user_id .
                             ') linked with this Facebook (' . $this->fbuid . ').');
73

Siebrand Mazeland's avatar
Siebrand Mazeland committed
74
                // We do not want these cookies
75 76 77 78 79 80 81 82 83 84 85
                getFacebook()->clear_cookie_state();

                $this->clientError(_('There is already a local user linked with this Facebook.'));

            } else {

                // User came from the Facebook connect settings tab, and
                // probably just wants to link/relink their Facebook account
                $this->connectUser();
            }

86
        } else if ($_SERVER['REQUEST_METHOD'] == 'POST') {
87

88 89 90 91 92 93 94 95 96 97 98 99 100
            $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('create')) {
                if (!$this->boolean('license')) {
                    $this->showForm(_('You can\'t register if you don\'t agree to the license.'),
                                    $this->trimmed('newname'));
                    return;
                }
                $this->createNewUser();
            } else if ($this->arg('connect')) {
101
                $this->connectNewUser();
102
            } else {
Zach Copley's avatar
Zach Copley committed
103 104
                common_debug('Facebook Connect Plugin - ' .
                             print_r($this->args, true));
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
                $this->showForm(_('Something weird happened.'),
                                $this->trimmed('newname'));
            }
        } else {
            $this->tryLogin();
        }
    }

    function showPageNotice()
    {
        if ($this->error) {
            $this->element('div', array('class' => 'error'), $this->error);
        } else {
            $this->element('div', 'instructions',
                           sprintf(_('This is the first time you\'ve logged into %s so we must connect your Facebook to a local account. You can either create a new account, or connect with your existing account, if you have one.'), common_config('site', 'name')));
        }
    }

    function title()
    {
        return _('Facebook Account Setup');
    }

    function showForm($error=null, $username=null)
    {
        $this->error = $error;
        $this->username = $username;

        $this->showPage();
    }

    function showPage()
    {
        parent::showPage();
    }

    function showContent()
    {
        if (!empty($this->message_text)) {
            $this->element('p', null, $this->message);
            return;
        }

        $this->elementStart('form', array('method' => 'post',
149
                                          'id' => 'form_settings_facebook_connect',
150
                                          'class' => 'form_settings',
151
                                          'action' => common_local_url('FBConnectAuth')));
152 153
        $this->elementStart('fieldset', array('id' => 'settings_facebook_connect_options'));
        $this->element('legend', null, _('Connection options'));
154 155
        $this->elementStart('ul', 'form_data');
        $this->elementStart('li');
156 157
        $this->element('input', array('type' => 'checkbox',
                                      'id' => 'license',
158
                                      'class' => 'checkbox',
159 160
                                      'name' => 'license',
                                      'value' => 'true'));
161
        $this->elementStart('label', array('class' => 'checkbox', 'for' => 'license'));
162 163 164 165
        $this->text(_('My text and files are available under '));
        $this->element('a', array('href' => common_config('license', 'url')),
                       common_config('license', 'title'));
        $this->text(_(' except this private data: password, email address, IM address, phone number.'));
166 167 168
        $this->elementEnd('label');
        $this->elementEnd('li');
        $this->elementEnd('ul');
169 170 171 172 173 174 175 176 177 178 179 180 181 182

        $this->elementStart('fieldset');
        $this->hidden('token', common_session_token());
        $this->element('legend', null,
                       _('Create new account'));
        $this->element('p', null,
                       _('Create a new user with this nickname.'));
        $this->elementStart('ul', 'form_data');
        $this->elementStart('li');
        $this->input('newname', _('New nickname'),
                     ($this->username) ? $this->username : '',
                     _('1-64 lowercase letters or numbers, no punctuation or spaces'));
        $this->elementEnd('li');
        $this->elementEnd('ul');
183
        $this->submit('create', _('Create'));
184 185 186 187
        $this->elementEnd('fieldset');

        $this->elementStart('fieldset');
        $this->element('legend', null,
188 189 190
                       _('Connect existing account'));
        $this->element('p', null,
                       _('If you already have an account, login with your username and password to connect it to your Facebook.'));
191 192
        $this->elementStart('ul', 'form_data');
        $this->elementStart('li');
193
        $this->input('nickname', _('Existing nickname'));
194 195
        $this->elementEnd('li');
        $this->elementStart('li');
196
        $this->password('password', _('Password'));
197 198
        $this->elementEnd('li');
        $this->elementEnd('ul');
199
        $this->submit('connect', _('Connect'));
200 201
        $this->elementEnd('fieldset');

202
        $this->elementEnd('fieldset');
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
        $this->elementEnd('form');
    }

    function message($msg)
    {
        $this->message_text = $msg;
        $this->showPage();
    }

    function createNewUser()
    {
        if (common_config('site', 'closed')) {
            $this->clientError(_('Registration not allowed.'));
            return;
        }

        $invite = null;

        if (common_config('site', 'inviteonly')) {
            $code = $_SESSION['invitecode'];
            if (empty($code)) {
                $this->clientError(_('Registration not allowed.'));
                return;
            }

            $invite = Invitation::staticGet($code);

            if (empty($invite)) {
                $this->clientError(_('Not a valid invitation code.'));
                return;
            }
        }

        $nickname = $this->trimmed('newname');

        if (!Validate::string($nickname, array('min_length' => 1,
                                               'max_length' => 64,
240
                                               'format' => NICKNAME_FMT))) {
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
            $this->showForm(_('Nickname must have only lowercase letters and numbers and no spaces.'));
            return;
        }

        if (!User::allowed_nickname($nickname)) {
            $this->showForm(_('Nickname not allowed.'));
            return;
        }

        if (User::staticGet('nickname', $nickname)) {
            $this->showForm(_('Nickname already in use. Try another one.'));
            return;
        }

        $fullname = trim($this->fb_fields['firstname'] .
            ' ' . $this->fb_fields['lastname']);

        $args = array('nickname' => $nickname, 'fullname' => $fullname);

        if (!empty($invite)) {
            $args['code'] = $invite->code;
        }

        $user = User::register($args);

        $result = $this->flinkUser($user->id, $this->fbuid);

        if (!$result) {
            $this->serverError(_('Error connecting user to Facebook.'));
            return;
        }

        common_set_user($user);
        common_real_login(true);

Zach Copley's avatar
Zach Copley committed
276 277
        common_debug('Facebook Connect Plugin - ' .
                     "Registered new user $user->id from Facebook user $this->fbuid");
278 279 280 281 282

        common_redirect(common_local_url('showstream', array('nickname' => $user->nickname)),
                        303);
    }

283
    function connectNewUser()
284 285 286 287 288 289 290 291 292 293 294
    {
        $nickname = $this->trimmed('nickname');
        $password = $this->trimmed('password');

        if (!common_check_user($nickname, $password)) {
            $this->showForm(_('Invalid username or password.'));
            return;
        }

        $user = User::staticGet('nickname', $nickname);

Zach Copley's avatar
Zach Copley committed
295 296 297
        if (!empty($user)) {
            common_debug('Facebook Connect Plugin - ' .
                         "Legit user to connect to Facebook: $nickname");
298 299 300 301 302 303 304 305 306
        }

        $result = $this->flinkUser($user->id, $this->fbuid);

        if (!$result) {
            $this->serverError(_('Error connecting user to Facebook.'));
            return;
        }

Zach Copley's avatar
Zach Copley committed
307 308
        common_debug('Facebook Connnect Plugin - ' .
                     "Connected Facebook user $this->fbuid to local user $user->id");
309 310 311 312 313 314 315

        common_set_user($user);
        common_real_login(true);

        $this->goHome($user->nickname);
    }

316 317 318 319 320 321
    function connectUser()
    {
        $user = common_current_user();

        $result = $this->flinkUser($user->id, $this->fbuid);

Zach Copley's avatar
Zach Copley committed
322
        if (empty($result)) {
323 324 325 326
            $this->serverError(_('Error connecting user to Facebook.'));
            return;
        }

Zach Copley's avatar
Zach Copley committed
327 328
        common_debug('Facebook Connect Plugin - ' .
                     "Connected Facebook user $this->fbuid to local user $user->id");
329 330 331 332 333

        // Return to Facebook connection settings tab
        common_redirect(common_local_url('FBConnectSettings'), 303);
    }

334 335
    function tryLogin()
    {
Zach Copley's avatar
Zach Copley committed
336 337
        common_debug('Facebook Connect Plugin - ' .
                     "Trying login for Facebook user $this->fbuid.");
338

339
        $flink = Foreign_link::getByForeignID($this->fbuid, FACEBOOK_CONNECT_SERVICE);
340

Zach Copley's avatar
Zach Copley committed
341
        if (!empty($flink)) {
342 343
            $user = $flink->getUser();

344
            if (!empty($user)) {
345

Zach Copley's avatar
Zach Copley committed
346 347
                common_debug('Facebook Connect Plugin - ' .
                             "Logged in Facebook user $flink->foreign_id as user $user->id ($user->nickname)");
348 349 350 351 352 353 354

                common_set_user($user);
                common_real_login(true);
                $this->goHome($user->nickname);
            }

        } else {
355

Zach Copley's avatar
Zach Copley committed
356 357
            common_debug('Facebook Connect Plugin - ' .
                         "No flink found for fbuid: $this->fbuid - new user");
358

359 360 361 362 363 364 365 366
            $this->showForm(null, $this->bestNewNickname());
        }
    }

    function goHome($nickname)
    {
        $url = common_get_returnto();
        if ($url) {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
367
            // We do not have to return to it again
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
            common_set_returnto(null);
        } else {
            $url = common_local_url('all',
                                    array('nickname' =>
                                          $nickname));
        }

        common_redirect($url, 303);
    }

    function flinkUser($user_id, $fbuid)
    {
        $flink = new Foreign_link();
        $flink->user_id = $user_id;
        $flink->foreign_id = $fbuid;
383
        $flink->service = FACEBOOK_CONNECT_SERVICE;
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426
        $flink->created = common_sql_now();

        $flink_id = $flink->insert();

        return $flink_id;
    }

    function bestNewNickname()
    {
        if (!empty($this->fb_fields['name'])) {
            $nickname = $this->nicknamize($this->fb_fields['name']);
            if ($this->isNewNickname($nickname)) {
                return $nickname;
            }
        }

        // Try the full name

        $fullname = trim($this->fb_fields['firstname'] .
            ' ' . $this->fb_fields['lastname']);

        if (!empty($fullname)) {
            $fullname = $this->nicknamize($fullname);
            if ($this->isNewNickname($fullname)) {
                return $fullname;
            }
        }

        return null;
    }

     // Given a string, try to make it work as a nickname

     function nicknamize($str)
     {
         $str = preg_replace('/\W/', '', $str);
         return strtolower($str);
     }

    function isNewNickname($str)
    {
        if (!Validate::string($str, array('min_length' => 1,
                                          'max_length' => 64,
427
                                          'format' => NICKNAME_FMT))) {
428 429 430 431 432 433 434 435 436 437 438 439 440 441
            return false;
        }
        if (!User::allowed_nickname($str)) {
            return false;
        }
        if (User::staticGet('nickname', $str)) {
            return false;
        }
        return true;
    }

    // XXX: Consider moving this to lib/facebookutil.php
    function getFacebookFields($fb_uid, $fields) {
        try {
442 443 444 445

            $facebook = getFacebook();

            $infos = $facebook->api_client->users_getInfo($fb_uid, $fields);
446 447 448 449 450 451 452

            if (empty($infos)) {
                return null;
            }
            return reset($infos);

        } catch (Exception $e) {
Zach Copley's avatar
Zach Copley committed
453 454
            common_log(LOG_WARNING, 'Facebook Connect Plugin - ' .
                       "Facebook client failure when requesting " .
455 456 457
                join(",", $fields) . " on uid " . $fb_uid .
                    " : ". $e->getMessage());
            return null;
458 459 460 461
        }
    }

}