We are no longer offering accounts on this server. Consider https://gitlab.freedesktop.org/ as a place to host projects.

facebookclient.php 34.7 KB
Newer Older
Zach Copley's avatar
Zach Copley committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
<?php
/**
 * StatusNet, the distributed open-source microblogging tool
 *
 * Class for communicating with Facebook
 *
 * 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
 * @package   StatusNet
 * @author    Craig Andrews <candrews@integralblue.com>
 * @author    Zach Copley <zach@status.net>
26
 * @copyright 2009-2011 StatusNet, Inc.
Zach Copley's avatar
Zach Copley committed
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link      http://status.net/
 */

if (!defined('STATUSNET')) {
    exit(1);
}

/**
 * Class for communication with Facebook
 *
 * @category Plugin
 * @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://status.net/
 */
class Facebookclient
{
    protected $facebook      = null; // Facebook Graph client obj
    protected $flink         = null; // Foreign_link StatusNet -> Facebook
    protected $notice        = null; // The user's notice
    protected $user          = null; // Sender of the notice

51 52 53 54 55 56
    /**
     *
     * @param Notice $notice the notice to manipulate
     * @param Profile $profile local user to act as; if left empty, the notice's poster will be used.
     */
    function __construct($notice, $profile=null)
Zach Copley's avatar
Zach Copley committed
57 58
    {
        $this->facebook = self::getFacebook();
59 60 61 62 63 64 65 66

        if (empty($this->facebook)) {
            throw new FacebookApiException(
                "Could not create Facebook client! Bad application ID or secret?"
            );
        }

        $this->notice = $notice;
Zach Copley's avatar
Zach Copley committed
67

68
        $profile_id = $profile ? $profile->id : $notice->profile_id;
Zach Copley's avatar
Zach Copley committed
69
        $this->flink = Foreign_link::getByUserID(
70
            $profile_id,
Zach Copley's avatar
Zach Copley committed
71 72 73
            FACEBOOK_SERVICE
        );

Zach Copley's avatar
Zach Copley committed
74 75 76
        if (!empty($this->flink)) {
            $this->user = $this->flink->getUser();
        }
Zach Copley's avatar
Zach Copley committed
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
    }

    /*
     * Get an instance of the Facebook Graph SDK object
     *
     * @param string $appId     Application
     * @param string $secret    Facebook API secret
     *
     * @return Facebook A Facebook SDK obj
     */
    static function getFacebook($appId = null, $secret = null)
    {
        // Check defaults and configuration for application ID and secret
        if (empty($appId)) {
            $appId = common_config('facebook', 'appid');
        }

        if (empty($secret)) {
            $secret = common_config('facebook', 'secret');
        }

        // If there's no app ID and secret set in the local config, look
        // for a global one
        if (empty($appId) || empty($secret)) {
            $appId  = common_config('facebook', 'global_appid');
            $secret = common_config('facebook', 'global_secret');
        }

105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
        if (empty($appId)) {
            common_log(
                LOG_WARNING,
                "Couldn't find Facebook application ID!",
                __FILE__
            );
        }

        if (empty($secret)) {
            common_log(
                LOG_WARNING,
                "Couldn't find Facebook application ID!",
                __FILE__
            );
        }

Zach Copley's avatar
Zach Copley committed
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
        return new Facebook(
            array(
               'appId'  => $appId,
               'secret' => $secret,
               'cookie' => true
            )
        );
    }

    /*
     * Broadcast a notice to Facebook
     *
     * @param Notice $notice    the notice to send
     */
    static function facebookBroadcastNotice($notice)
    {
        $client = new Facebookclient($notice);
138
        return $client->sendNotice();
Zach Copley's avatar
Zach Copley committed
139 140 141 142 143 144 145 146
    }

    /*
     * Should the notice go to Facebook?
     */
    function isFacebookBound() {

        if (empty($this->flink)) {
147
            // User hasn't setup bridging
Zach Copley's avatar
Zach Copley committed
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
            return false;
        }

        // Avoid a loop
        if ($this->notice->source == 'Facebook') {
            common_log(
                LOG_INFO,
                sprintf(
                    'Skipping notice %d because its source is Facebook.',
                    $this->notice->id
                ),
                __FILE__
            );
            return false;
        }

        // If the user does not want to broadcast to Facebook, move along
        if (!($this->flink->noticesync & FOREIGN_NOTICE_SEND == FOREIGN_NOTICE_SEND)) {
            common_log(
                LOG_INFO,
                sprintf(
                    'Skipping notice %d because user has FOREIGN_NOTICE_SEND bit off.',
                    $this->notice->id
                ),
                __FILE__
            );
            return false;
        }

        // If it's not a reply, or if the user WANTS to send @-replies,
        // then, yeah, it can go to Facebook.
179 180

        if ((empty($notice->reply_to) && !preg_match('/^@[a-zA-Z0-9_]{1,15}\b/u', $notice->content)) ||
Zach Copley's avatar
Zach Copley committed
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
            ($this->flink->noticesync & FOREIGN_NOTICE_SEND_REPLY)) {
            return true;
        }

        return false;
    }

    /*
     * Determine whether we should send this notice using the Graph API or the
     * old REST API and then dispatch
     */
    function sendNotice()
    {
        // If there's nothing in the credentials field try to send via
        // the Old Rest API

197 198 199
        if ($this->isFacebookBound()) {
            common_debug("notice is facebook bound", __FILE__);
            if (empty($this->flink->credentials)) {
200
                return $this->sendOldRest();
201
            } else {
Zach Copley's avatar
Zach Copley committed
202

203
                // Otherwise we most likely have an access token
204
                return $this->sendGraph();
205
            }
Zach Copley's avatar
Zach Copley committed
206
        }
207 208 209

        // dequeue
        return true;
Zach Copley's avatar
Zach Copley committed
210 211 212 213 214 215 216
    }

    /*
     * Send a notice to Facebook using the Graph API
     */
    function sendGraph()
    {
217 218 219 220 221 222
        try {

            $fbuid = $this->flink->foreign_id;

            common_debug(
                sprintf(
223
                    "Attempting use Graph API to post notice %d as a stream item for %s (%d), fbuid %d",
224 225 226 227 228 229 230 231 232 233
                    $this->notice->id,
                    $this->user->nickname,
                    $this->user->id,
                    $fbuid
                ),
                __FILE__
            );

            $params = array(
                'access_token' => $this->flink->credentials,
234
                // XXX: Need to worrry about length of the message?
235 236 237 238 239 240 241
                'message'      => $this->notice->content
            );

            $attachments = $this->notice->attachments();

            if (!empty($attachments)) {

242
                // We can only send one attachment with the Graph API :(
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261

                $first = array_shift($attachments);

                if (substr($first->mimetype, 0, 6) == 'image/'
                    || in_array(
                        $first->mimetype,
                        array('application/x-shockwave-flash', 'audio/mpeg' ))) {

                   $params['picture'] = $first->url;
                   $params['caption'] = 'Click for full size';
                   $params['source']  = $first->url;
                }

            }

            $result = $this->facebook->api(
                sprintf('/%s/feed', $fbuid), 'post', $params
            );

262 263 264 265 266 267
            // Save a mapping
            Notice_to_item::saveNew($this->notice->id, $result['id']);

            common_log(
                LOG_INFO,
                sprintf(
268
                    "Posted notice %d as a stream item for %s (%d), fbuid %d",
269 270 271 272 273 274 275 276
                    $this->notice->id,
                    $this->user->nickname,
                    $this->user->id,
                    $fbuid
                ),
                __FILE__
            );

277 278 279 280 281
        } catch (FacebookApiException $e) {
            return $this->handleFacebookError($e);
        }

        return true;
Zach Copley's avatar
Zach Copley committed
282 283 284 285 286 287 288 289 290 291
    }

    /*
     * Send a notice to Facebook using the deprecated Old REST API. We need this
     * for backwards compatibility. Users who signed up for Facebook bridging
     * using the old Facebook Canvas application do not have an OAuth 2.0
     * access token.
     */
    function sendOldRest()
    {
292
        try {
Zach Copley's avatar
Zach Copley committed
293

294 295 296 297 298 299 300 301 302 303 304 305 306 307
            $canPublish = $this->checkPermission('publish_stream');
            $canUpdate  = $this->checkPermission('status_update');

            // We prefer to use stream.publish, because it can handle
            // attachments and returns the ID of the published item

            if ($canPublish == 1) {
                $this->restPublishStream();
            } else if ($canUpdate == 1) {
                // as a last resort we can just update the user's "status"
                $this->restStatusUpdate();
            } else {

                $msg = 'Not sending notice %d to Facebook because user %s '
308
                     . '(%d), fbuid %d,  does not have \'status_update\' '
309 310 311 312 313 314 315 316 317 318 319 320 321
                     . 'or \'publish_stream\' permission.';

                common_log(
                    LOG_WARNING,
                    sprintf(
                        $msg,
                        $this->notice->id,
                        $this->user->nickname,
                        $this->user->id,
                        $this->flink->foreign_id
                    ),
                    __FILE__
                );
Zach Copley's avatar
Zach Copley committed
322
            }
323 324 325

        } catch (FacebookApiException $e) {
            return $this->handleFacebookError($e);
Zach Copley's avatar
Zach Copley committed
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
        }

        return true;
    }

    /*
     * Query Facebook to to see if a user has permission
     *
     *
     *
     * @param $permission the permission to check for - must be either
     *                    public_stream or status_update
     *
     * @return boolean result
     */
    function checkPermission($permission)
    {
        if (!in_array($permission, array('publish_stream', 'status_update'))) {
344 345
             // TRANS: Server exception thrown when permission check fails.
             throw new ServerException(_('No such permission!'));
Zach Copley's avatar
Zach Copley committed
346 347
        }

348
        $fbuid = $this->flink->foreign_id;
Zach Copley's avatar
Zach Copley committed
349 350 351

        common_debug(
            sprintf(
352
                'Checking for %s permission for user %s (%d), fbuid %d',
Zach Copley's avatar
Zach Copley committed
353 354 355 356 357 358 359 360
                $permission,
                $this->user->nickname,
                $this->user->id,
                $fbuid
            ),
            __FILE__
        );

361 362 363 364 365 366
        $hasPermission = $this->facebook->api(
            array(
                'method'   => 'users.hasAppPermission',
                'ext_perm' => $permission,
                'uid'      => $fbuid
            )
Zach Copley's avatar
Zach Copley committed
367 368 369 370 371 372
        );

        if ($hasPermission == 1) {

            common_debug(
                sprintf(
373
                    '%s (%d), fbuid %d has %s permission',
Zach Copley's avatar
Zach Copley committed
374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
                    $permission,
                    $this->user->nickname,
                    $this->user->id,
                    $fbuid
                ),
                __FILE__
            );

            return true;

        } else {

            $logMsg = '%s (%d), fbuid $fbuid does NOT have %s permission.'
                    . 'Facebook returned: %s';

            common_debug(
                sprintf(
                    $logMsg,
                    $this->user->nickname,
                    $this->user->id,
                    $permission,
                    $fbuid,
                    var_export($result, true)
                ),
                __FILE__
            );

            return false;
        }
    }

405 406 407 408 409 410
    /*
     * Handle a Facebook API Exception
     *
     * @param FacebookApiException $e the exception
     *
     */
Zach Copley's avatar
Zach Copley committed
411 412 413 414
    function handleFacebookError($e)
    {
        $fbuid  = $this->flink->foreign_id;
        $errmsg = $e->getMessage();
415 416 417
        $code   = $e->getCode();

        // The Facebook PHP SDK seems to always set the code attribute
418
        // of the Exception to 0; they put the real error code in
419 420 421 422 423
        // the message. Gar!
        if ($code == 0) {
            preg_match('/^\(#(?<code>\d+)\)/', $errmsg, $matches);
            $code = $matches['code'];
        }
Zach Copley's avatar
Zach Copley committed
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464

        // XXX: Check for any others?
        switch($code) {
         case 100: // Invalid parameter
            $msg = 'Facebook claims notice %d was posted with an invalid '
                 . 'parameter (error code 100 - %s) Notice details: '
                 . '[nickname=%s, user id=%d, fbuid=%d, content="%s"]. '
                 . 'Dequeing.';
            common_log(
                LOG_ERR, sprintf(
                    $msg,
                    $this->notice->id,
                    $errmsg,
                    $this->user->nickname,
                    $this->user->id,
                    $fbuid,
                    $this->notice->content
                ),
                __FILE__
            );
            return true;
            break;
         case 200: // Permissions error
         case 250: // Updating status requires the extended permission status_update
            $this->disconnect();
            return true; // dequeue
            break;
         case 341: // Feed action request limit reached
                $msg = '%s (userid=%d, fbuid=%d) has exceeded his/her limit '
                     . 'for posting notices to Facebook today. Dequeuing '
                     . 'notice %d';
                common_log(
                    LOG_INFO, sprintf(
                        $msg,
                        $user->nickname,
                        $user->id,
                        $fbuid,
                        $this->notice->id
                    ),
                    __FILE__
                );
465
            // @todo FIXME: We want to rety at a later time when the throttling has expired
Zach Copley's avatar
Zach Copley committed
466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
            // instead of just giving up.
            return true;
            break;
         default:
            $msg = 'Facebook returned an error we don\'t know how to deal with '
                 . 'when posting notice %d. Error code: %d, error message: "%s"'
                 . ' Notice details: [nickname=%s, user id=%d, fbuid=%d, '
                 . 'notice content="%s"]. Dequeing.';
            common_log(
                LOG_ERR, sprintf(
                    $msg,
                    $this->notice->id,
                    $code,
                    $errmsg,
                    $this->user->nickname,
                    $this->user->id,
                    $fbuid,
                    $this->notice->content
                ),
                __FILE__
            );
            return true; // dequeue
            break;
        }
    }

492 493 494 495 496 497 498 499
    /*
     * Publish a notice to Facebook as a status update
     *
     * This is the least preferable way to send a notice to Facebook because
     * it doesn't support attachments and the API method doesn't return
     * the ID of the post on Facebook.
     *
     */
Zach Copley's avatar
Zach Copley committed
500 501 502 503 504 505
    function restStatusUpdate()
    {
        $fbuid = $this->flink->foreign_id;

        common_debug(
            sprintf(
506
                "Attempting to post notice %d as a status update for %s (%d), fbuid %d",
Zach Copley's avatar
Zach Copley committed
507 508 509 510 511 512 513 514
                $this->notice->id,
                $this->user->nickname,
                $this->user->id,
                $fbuid
            ),
            __FILE__
        );

515 516 517
        $result = $this->facebook->api(
            array(
                'method'               => 'users.setStatus',
518
                'status'               => $this->formatMessage(),
519 520 521
                'status_includes_verb' => true,
                'uid'                  => $fbuid
            )
Zach Copley's avatar
Zach Copley committed
522 523
        );

524 525 526 527 528
        if ($result == 1) { // 1 is success

            common_log(
                LOG_INFO,
                sprintf(
529
                    "Posted notice %s as a status update for %s (%d), fbuid %d",
530 531 532 533 534 535 536 537 538 539 540 541 542 543
                    $this->notice->id,
                    $this->user->nickname,
                    $this->user->id,
                    $fbuid
                ),
                __FILE__
            );

            // There is no item ID returned for status update so we can't
            // save a Notice_to_item mapping

        } else {

            $msg = sprintf(
544
                "Error posting notice %s as a status update for %s (%d), fbuid %d - error code: %s",
Zach Copley's avatar
Zach Copley committed
545 546 547
                $this->notice->id,
                $this->user->nickname,
                $this->user->id,
548 549 550
                $fbuid,
                $result // will contain 0, or an error
            );
551

552 553
            throw new FacebookApiException($msg, $result);
        }
Zach Copley's avatar
Zach Copley committed
554 555
    }

556 557 558
    /*
     * Publish a notice to a Facebook user's stream using the old REST API
     */
Zach Copley's avatar
Zach Copley committed
559 560 561 562 563 564
    function restPublishStream()
    {
        $fbuid = $this->flink->foreign_id;

        common_debug(
            sprintf(
565
                'Attempting to post notice %d as stream item for %s (%d) fbuid %d',
Zach Copley's avatar
Zach Copley committed
566 567 568 569 570 571 572 573
                $this->notice->id,
                $this->user->nickname,
                $this->user->id,
                $fbuid
            ),
            __FILE__
        );

574
        $fbattachment = $this->formatAttachments();
Zach Copley's avatar
Zach Copley committed
575

576 577 578
        $result = $this->facebook->api(
            array(
                'method'     => 'stream.publish',
579
                'message'    => $this->formatMessage(),
580 581 582
                'attachment' => $fbattachment,
                'uid'        => $fbuid
            )
Zach Copley's avatar
Zach Copley committed
583 584
        );

585 586 587 588 589 590 591
        if (!empty($result)) { // result will contain the item ID
            // Save a mapping
            Notice_to_item::saveNew($this->notice->id, $result);

            common_log(
                LOG_INFO,
                sprintf(
592
                    'Posted notice %d as a %s for %s (%d), fbuid %d',
593 594 595 596 597 598 599 600 601 602 603
                    $this->notice->id,
                    empty($fbattachment) ? 'stream item' : 'stream item with attachment',
                    $this->user->nickname,
                    $this->user->id,
                    $fbuid
                ),
                __FILE__
            );
        } else {

            $msg = sprintf(
604
                'Could not post notice %d as a %s for %s (%d), fbuid %d - error code: %s',
Zach Copley's avatar
Zach Copley committed
605
                $this->notice->id,
606
                empty($fbattachment) ? 'stream item' : 'stream item with attachment',
Zach Copley's avatar
Zach Copley committed
607 608
                $this->user->nickname,
                $this->user->id,
609
                $result, // result will contain an error code
Zach Copley's avatar
Zach Copley committed
610
                $fbuid
611 612 613 614 615
            );

            throw new FacebookApiException($msg, $result);
        }
    }
616

617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636
    /*
     * Format the text message of a stream item so it's appropriate for
     * sending to Facebook. If the notice is too long, truncate it, and
     * add a linkback to the original notice at the end.
     *
     * @return String $txt the formated message
     */
    function formatMessage()
    {
        // Start with the plaintext source of this notice...
        $txt = $this->notice->content;

        // Facebook has a 420-char hardcoded max.
        if (mb_strlen($statustxt) > 420) {
            $noticeUrl = common_shorten_url($this->notice->uri);
            $urlLen = mb_strlen($noticeUrl);
            $txt = mb_substr($statustxt, 0, 420 - ($urlLen + 3)) . ' … ' . $noticeUrl;
        }

        return $txt;
Zach Copley's avatar
Zach Copley committed
637 638
    }

639 640 641 642 643 644 645
    /*
     * Format attachments for the old REST API stream.publish method
     *
     * Note: Old REST API supports multiple attachments per post
     *
     */
    function formatAttachments()
Zach Copley's avatar
Zach Copley committed
646
    {
647 648
        $attachments = $this->notice->attachments();

Zach Copley's avatar
Zach Copley committed
649 650 651 652 653 654
        $fbattachment          = array();
        $fbattachment['media'] = array();

        foreach($attachments as $attachment)
        {
            if($enclosure = $attachment->getEnclosure()){
655
                $fbmedia = $this->getFacebookMedia($enclosure);
Zach Copley's avatar
Zach Copley committed
656
            }else{
657
                $fbmedia = $this->getFacebookMedia($attachment);
Zach Copley's avatar
Zach Copley committed
658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674
            }
            if($fbmedia){
                $fbattachment['media'][]=$fbmedia;
            }else{
                $fbattachment['name'] = ($attachment->title ?
                                      $attachment->title : $attachment->url);
                $fbattachment['href'] = $attachment->url;
            }
        }
        if(count($fbattachment['media'])>0){
            unset($fbattachment['name']);
            unset($fbattachment['href']);
        }
        return $fbattachment;
    }

    /**
675
     * given a File objects, returns an associative array suitable for Facebook media
Zach Copley's avatar
Zach Copley committed
676
     */
677
    function getFacebookMedia($attachment)
Zach Copley's avatar
Zach Copley committed
678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701
    {
        $fbmedia    = array();

        if (strncmp($attachment->mimetype, 'image/', strlen('image/')) == 0) {
            $fbmedia['type']         = 'image';
            $fbmedia['src']          = $attachment->url;
            $fbmedia['href']         = $attachment->url;
        } else if ($attachment->mimetype == 'audio/mpeg') {
            $fbmedia['type']         = 'mp3';
            $fbmedia['src']          = $attachment->url;
        }else if ($attachment->mimetype == 'application/x-shockwave-flash') {
            $fbmedia['type']         = 'flash';

            // http://wiki.developers.facebook.com/index.php/Attachment_%28Streams%29
            // says that imgsrc is required... but we have no value to put in it
            // $fbmedia['imgsrc']='';

            $fbmedia['swfsrc']       = $attachment->url;
        }else{
            return false;
        }
        return $fbmedia;
    }

702 703 704 705
    /*
     * Disconnect a user from Facebook by deleting his Foreign_link.
     * Notifies the user his account has been disconnected by email.
     */
Zach Copley's avatar
Zach Copley committed
706 707
    function disconnect()
    {
708
        $fbuid = $this->flink->foreign_id;
Zach Copley's avatar
Zach Copley committed
709 710 711 712

        common_log(
            LOG_INFO,
            sprintf(
713
                'Removing Facebook link for %s (%d), fbuid %d',
Zach Copley's avatar
Zach Copley committed
714 715 716 717 718 719 720
                $this->user->nickname,
                $this->user->id,
                $fbuid
            ),
            __FILE__
        );

721
        $result = $this->flink->delete();
Zach Copley's avatar
Zach Copley committed
722 723 724 725 726

        if (empty($result)) {
            common_log(
                LOG_ERR,
                sprintf(
727
                    'Could not remove Facebook link for %s (%d), fbuid %d',
Zach Copley's avatar
Zach Copley committed
728 729 730 731 732 733 734 735 736 737
                    $this->user->nickname,
                    $this->user->id,
                    $fbuid
                ),
                __FILE__
            );
            common_log_db_error($flink, 'DELETE', __FILE__);
        }

        // Notify the user that we are removing their Facebook link
738 739 740 741 742 743
        if (!empty($this->user->email)) {
            $result = $this->mailFacebookDisconnect();

            if (!$result) {
                $msg = 'Unable to send email to notify %s (%d), fbuid %d '
                     . 'about his/her Facebook link being removed.';
Zach Copley's avatar
Zach Copley committed
744

745 746 747 748 749 750 751 752 753 754 755 756 757 758 759
                common_log(
                    LOG_WARNING,
                    sprintf(
                        $msg,
                        $this->user->nickname,
                        $this->user->id,
                        $fbuid
                    ),
                    __FILE__
                );
            }
        } else {
            $msg = 'Unable to send email to notify %s (%d), fbuid %d '
                 . 'about his/her Facebook link being removed because the '
                 . 'user has not set an email address.';
Zach Copley's avatar
Zach Copley committed
760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781

            common_log(
                LOG_WARNING,
                sprintf(
                    $msg,
                    $this->user->nickname,
                    $this->user->id,
                    $fbuid
                ),
                __FILE__
            );
        }
    }

    /**
     * Send a mail message to notify a user that her Facebook link
     * has been terminated.
     *
     * @return boolean success flag
     */
    function mailFacebookDisconnect()
    {
782
        $profile = $this->user->getProfile();
Zach Copley's avatar
Zach Copley committed
783 784 785

        $siteName = common_config('site', 'name');

786
        common_switch_locale($this->user->language);
Zach Copley's avatar
Zach Copley committed
787

788
        // TRANS: E-mail subject.
789
        $subject = _m('Your Facebook connection has been removed');
Zach Copley's avatar
Zach Copley committed
790

791
        // TRANS: E-mail body. %1$s is a username, %2$s is the StatusNet sitename.
792 793 794 795 796 797 798 799 800 801
        $msg = _m("Hi %1\$s,\n\n".
                  "We are sorry to inform you we are unable to publish your notice to\n".
                  "Facebook, and have removed the connection between your %2\$s account and\n".
                  "Facebook.\n\n".
                  "This may have happened because you have removed permission for %2\$s\n".
                  "to post on your behalf, or perhaps you have deactivated your Facebook\n".
                  "account. You can reconnect your %2\$s account to Facebook at any time by\n".
                  "logging in with Facebook again.\n\n".
                  "Sincerely,\n\n".
                  "%2\$s\n");
802

Zach Copley's avatar
Zach Copley committed
803
        $body = sprintf(
804
            $msg,
Zach Copley's avatar
Zach Copley committed
805 806 807
            $this->user->nickname,
            $siteName
        );
808

Zach Copley's avatar
Zach Copley committed
809 810
        common_switch_locale();

811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843
        $result = mail_to_user($this->user, $subject, $body);

        if (empty($this->user->password)) {
            $result = self::emailWarn($this->user);
        }

        return $result;
    }

    /*
     * Send the user an email warning that their account has been
     * disconnected and he/she has no way to login and must contact
     * the site administrator for help.
     *
     * @param User $user the deauthorizing user
     *
     */
    static function emailWarn($user)
    {
        $profile = $user->getProfile();

        $siteName  = common_config('site', 'name');
        $siteEmail = common_config('site', 'email');

        if (empty($siteEmail)) {
            common_log(
                LOG_WARNING,
                    "No site email address configured. Please set one."
            );
        }

        common_switch_locale($user->language);

844
        // TRANS: E-mail subject. %s is the StatusNet sitename.
845 846
        $subject = _m('Contact the %s administrator to retrieve your account');

847 848
        // TRANS: E-mail body. %1$s is a username,
        // TRANS: %2$s is the StatusNet sitename, %3$s is the site contact e-mail address.
849 850 851 852 853 854 855
        $msg = _m("Hi %1\$s,\n\n".
                  "We have noticed you have deauthorized the Facebook connection for your\n".
                  "%2\$s account.  You have not set a password for your %2\$s account yet, so\n".
                  "you will not be able to login. If you wish to continue using your %2\$s\n".
                  "account, please contact the site administrator (%3\$s) to set a password.\n\n".
                  "Sincerely,\n\n".
                  "%2\$s\n");
856 857

        $body = sprintf(
858
            $msg,
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886
            $user->nickname,
            $siteName,
            $siteEmail
        );

        common_switch_locale();

        if (mail_to_user($user, $subject, $body)) {
            common_log(
                LOG_INFO,
                sprintf(
                    'Sent account lockout warning to %s (%d)',
                    $user->nickname,
                    $user->id
                ),
                __FILE__
            );
        } else {
            common_log(
                LOG_WARNING,
                sprintf(
                    'Unable to send account lockout warning to %s (%d)',
                    $user->nickname,
                    $user->id
                ),
                __FILE__
            );
        }
Zach Copley's avatar
Zach Copley committed
887 888
    }

889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919
    /*
     * Check to see if we have a mapping to a copy of this notice
     * on Facebook
     *
     * @param Notice $notice the notice to check
     *
     * @return mixed null if it can't find one, or the id of the Facebook
     *               stream item
     */
    static function facebookStatusId($notice)
    {
        $n2i = Notice_to_item::staticGet('notice_id', $notice->id);

        if (empty($n2i)) {
            return null;
        } else {
            return $n2i->item_id;
        }
    }

    /*
     * Save a Foreign_user record of a Facebook user
     *
     * @param object $fbuser a Facebook Graph API user obj
     *                       See: http://developers.facebook.com/docs/reference/api/user
     * @return mixed $result Id or key
     *
     */
    static function addFacebookUser($fbuser)
    {
        // remove any existing, possibly outdated, record
920
        $luser = Foreign_user::getForeignUser($fbuser->id, FACEBOOK_SERVICE);
921 922 923 924 925 926 927 928 929 930

        if (!empty($luser)) {

            $result = $luser->delete();

            if ($result != false) {
                common_log(
                    LOG_INFO,
                    sprintf(
                        'Removed old Facebook user: %s, fbuid %d',
931 932
                        $fbuid->name,
                        $fbuid->id
933 934 935 936 937 938 939 940
                    ),
                    __FILE__
                );
            }
        }

        $fuser = new Foreign_user();

941
        $fuser->nickname = $fbuser->username;
942
        $fuser->uri      = $fbuser->link;
943
        $fuser->id       = $fbuser->id;
944 945 946 947 948 949 950 951 952 953
        $fuser->service  = FACEBOOK_SERVICE;
        $fuser->created  = common_sql_now();

        $result = $fuser->insert();

        if (empty($result)) {
            common_log(
                LOG_WARNING,
                    sprintf(
                        'Failed to add new Facebook user: %s, fbuid %d',
954 955
                        $fbuser->username,
                        $fbuser->id
956 957 958 959 960 961 962 963 964 965
                    ),
                    __FILE__
            );

            common_log_db_error($fuser, 'INSERT', __FILE__);
        } else {
            common_log(
                LOG_INFO,
                sprintf(
                    'Added new Facebook user: %s, fbuid %d',
966 967
                    $fbuser->name,
                    $fbuser->id
968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984
                ),
                __FILE__
            );
        }

        return $result;
    }

    /*
     * Remove an item from a Facebook user's feed if we have a mapping
     * for it.
     */
    function streamRemove()
    {
        $n2i = Notice_to_item::staticGet('notice_id', $this->notice->id);

        if (!empty($this->flink) && !empty($n2i)) {
985 986 987 988 989 990 991
            try {
                $result = $this->facebook->api(
                    array(
                        'method'  => 'stream.remove',
                        'post_id' => $n2i->item_id,
                        'uid'     => $this->flink->foreign_id
                    )
992 993
                );

994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
                if (!empty($result) && result == true) {
                    common_log(
                      LOG_INFO,
                        sprintf(
                            'Deleted Facebook item: %s for %s (%d), fbuid %d',
                            $n2i->item_id,
                            $this->user->nickname,
                            $this->user->id,
                            $this->flink->foreign_id
                        ),
                        __FILE__
                    );

                    $n2i->delete();
1008

1009 1010 1011 1012
                } else {
                    throw new FaceboookApiException(var_export($result, true));
                }
            } catch (FacebookApiException $e) {
1013 1014 1015
                common_log(
                  LOG_WARNING,
                    sprintf(
1016 1017 1018
                        'Could not deleted Facebook item: %s for %s (%d), '
                            . 'fbuid %d - (API error: %s) item already deleted '
                            . 'on Facebook? ',
1019 1020 1021
                        $n2i->item_id,
                        $this->user->nickname,
                        $this->user->id,
1022 1023
                        $this->flink->foreign_id,
                        $e
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039
                    ),
                    __FILE__
                );
            }
        }
    }

    /*
     * Like an item in a Facebook user's feed if we have a mapping
     * for it.
     */
    function like()
    {
        $n2i = Notice_to_item::staticGet('notice_id', $this->notice->id);

        if (!empty($this->flink) && !empty($n2i)) {
1040 1041 1042 1043 1044 1045 1046
            try {
                $result = $this->facebook->api(
                    array(
                        'method'  => 'stream.addlike',
                        'post_id' => $n2i->item_id,
                        'uid'     => $this->flink->foreign_id
                    )
1047 1048
                );

1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064
                if (!empty($result) && result == true) {
                    common_log(
                      LOG_INFO,
                        sprintf(
                            'Added like for item: %s for %s (%d), fbuid %d',
                            $n2i->item_id,
                            $this->user->nickname,
                            $this->user->id,
                            $this->flink->foreign_id
                        ),
                        __FILE__
                    );
                } else {
                    throw new FacebookApiException(var_export($result, true));
                }
            } catch (FacebookApiException $e) {
1065 1066 1067
                common_log(
                  LOG_WARNING,
                    sprintf(
1068 1069
                        'Could not like Facebook item: %s for %s (%d), '
                            . 'fbuid %d (API error: %s)',
1070 1071 1072
                        $n2i->item_id,
                        $this->user->nickname,
                        $this->user->id,
1073 1074
                        $this->flink->foreign_id,
                        $e
1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090
                    ),
                    __FILE__
                );
            }
        }
    }

    /*
     * Unlike an item in a Facebook user's feed if we have a mapping
     * for it.
     */
    function unLike()
    {
        $n2i = Notice_to_item::staticGet('notice_id', $this->notice->id);

        if (!empty($this->flink) && !empty($n2i)) {
1091 1092 1093 1094 1095 1096 1097
            try {
                $result = $this->facebook->api(
                    array(
                        'method'  => 'stream.removeLike',
                        'post_id' => $n2i->item_id,
                        'uid'     => $this->flink->foreign_id
                    )
1098 1099
                );

1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117
                if (!empty($result) && result == true) {
                    common_log(
                      LOG_INFO,
                        sprintf(
                            'Removed like for item: %s for %s (%d), fbuid %d',
                            $n2i->item_id,
                            $this->user->nickname,
                            $this->user->id,
                            $this->flink->foreign_id
                        ),
                        __FILE__
                    );

                } else {
                    throw new FacebookApiException(var_export($result, true));
                }
            } catch (FacebookApiException $e) {
                  common_log(
1118 1119
                  LOG_WARNING,
                    sprintf(
1120 1121
                        'Could not remove like for Facebook item: %s for %s '
                          . '(%d), fbuid %d (API error: %s)',
1122 1123 1124
                        $n2i->item_id,
                        $this->user->nickname,
                        $this->user->id,
1125 1126
                        $this->flink->foreign_id,
                        $e
1127 1128 1129 1130 1131 1132
                    ),
                    __FILE__
                );
            }
        }
    }
Zach Copley's avatar
Zach Copley committed
1133
}