3 * StatusNet, the distributed open-source microblogging tool
5 * Class for communicating with Facebook
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.
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.
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/>.
24 * @author Craig Andrews <candrews@integralblue.com>
25 * @author Zach Copley <zach@status.net>
26 * @copyright 2009-2011 StatusNet, Inc.
27 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
28 * @link http://status.net/
31 if (!defined('STATUSNET')) {
36 * Class for communication with Facebook
40 * @author Zach Copley <zach@status.net>
41 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
42 * @link http://status.net/
46 protected $facebook = null; // Facebook Graph client obj
47 protected $flink = null; // Foreign_link StatusNet -> Facebook
48 protected $notice = null; // The user's notice
49 protected $user = null; // Sender of the notice
53 * @param Notice $notice the notice to manipulate
54 * @param Profile $profile local user to act as; if left empty, the notice's poster will be used.
56 function __construct($notice, $profile=null)
58 $this->facebook = self::getFacebook();
60 if (empty($this->facebook)) {
61 throw new FacebookApiException(
62 "Could not create Facebook client! Bad application ID or secret?"
66 $this->notice = $notice;
68 $profile_id = $profile ? $profile->id : $notice->profile_id;
69 $this->flink = Foreign_link::getByUserID(
74 if (!empty($this->flink)) {
75 $this->user = $this->flink->getUser();
80 * Get an instance of the Facebook Graph SDK object
82 * @param string $appId Application
83 * @param string $secret Facebook API secret
85 * @return Facebook A Facebook SDK obj
87 static function getFacebook($appId = null, $secret = null)
89 // Check defaults and configuration for application ID and secret
91 $appId = common_config('facebook', 'appid');
95 $secret = common_config('facebook', 'secret');
98 // If there's no app ID and secret set in the local config, look
100 if (empty($appId) || empty($secret)) {
101 $appId = common_config('facebook', 'global_appid');
102 $secret = common_config('facebook', 'global_secret');
108 "Couldn't find Facebook application ID!",
113 if (empty($secret)) {
116 "Couldn't find Facebook application ID!",
131 * Broadcast a notice to Facebook
133 * @param Notice $notice the notice to send
135 static function facebookBroadcastNotice($notice)
137 $client = new Facebookclient($notice);
138 return $client->sendNotice();
142 * Should the notice go to Facebook?
144 function isFacebookBound() {
146 if (empty($this->flink)) {
147 // User hasn't setup bridging
152 if ($this->notice->source == 'Facebook') {
156 'Skipping notice %d because its source is Facebook.',
164 // If the user does not want to broadcast to Facebook, move along
165 if (!($this->flink->noticesync & FOREIGN_NOTICE_SEND == FOREIGN_NOTICE_SEND)) {
169 'Skipping notice %d because user has FOREIGN_NOTICE_SEND bit off.',
177 // If it's not a reply, or if the user WANTS to send @-replies,
178 // then, yeah, it can go to Facebook.
180 if (empty($this->notice->reply_to) ||
181 ($this->flink->noticesync & FOREIGN_NOTICE_SEND_REPLY)) {
189 * Determine whether we should send this notice using the Graph API or the
190 * old REST API and then dispatch
192 function sendNotice()
194 // If there's nothing in the credentials field try to send via
197 if ($this->isFacebookBound()) {
198 common_debug("notice is facebook bound", __FILE__);
199 if (empty($this->flink->credentials)) {
200 return $this->sendOldRest();
203 // Otherwise we most likely have an access token
204 return $this->sendGraph();
213 * Send a notice to Facebook using the Graph API
219 $fbuid = $this->flink->foreign_id;
223 "Attempting use Graph API to post notice %d as a stream item for %s (%d), fbuid %d",
225 $this->user->nickname,
233 'access_token' => $this->flink->credentials,
234 // XXX: Need to worrry about length of the message?
235 'message' => $this->notice->content
238 $attachments = $this->notice->attachments();
240 if (!empty($attachments)) {
242 // We can only send one attachment with the Graph API :(
244 $first = array_shift($attachments);
246 if (substr($first->mimetype, 0, 6) == 'image/'
249 array('application/x-shockwave-flash', 'audio/mpeg' ))) {
251 $params['picture'] = $first->url;
252 $params['caption'] = 'Click for full size';
253 $params['source'] = $first->url;
258 $result = $this->facebook->api(
259 sprintf('/%s/feed', $fbuid), 'post', $params
263 Notice_to_item::saveNew($this->notice->id, $result['id']);
268 "Posted notice %d as a stream item for %s (%d), fbuid %d",
270 $this->user->nickname,
277 } catch (FacebookApiException $e) {
278 return $this->handleFacebookError($e);
285 * Send a notice to Facebook using the deprecated Old REST API. We need this
286 * for backwards compatibility. Users who signed up for Facebook bridging
287 * using the old Facebook Canvas application do not have an OAuth 2.0
290 function sendOldRest()
294 $canPublish = $this->checkPermission('publish_stream');
295 $canUpdate = $this->checkPermission('status_update');
297 // We prefer to use stream.publish, because it can handle
298 // attachments and returns the ID of the published item
300 if ($canPublish == 1) {
301 $this->restPublishStream();
302 } else if ($canUpdate == 1) {
303 // as a last resort we can just update the user's "status"
304 $this->restStatusUpdate();
307 $msg = 'Not sending notice %d to Facebook because user %s '
308 . '(%d), fbuid %d, does not have \'status_update\' '
309 . 'or \'publish_stream\' permission.';
316 $this->user->nickname,
318 $this->flink->foreign_id
324 } catch (FacebookApiException $e) {
325 return $this->handleFacebookError($e);
332 * Query Facebook to to see if a user has permission
336 * @param $permission the permission to check for - must be either
337 * public_stream or status_update
339 * @return boolean result
341 function checkPermission($permission)
343 if (!in_array($permission, array('publish_stream', 'status_update'))) {
344 // TRANS: Server exception thrown when permission check fails.
345 throw new ServerException(_('No such permission!'));
348 $fbuid = $this->flink->foreign_id;
352 'Checking for %s permission for user %s (%d), fbuid %d',
354 $this->user->nickname,
361 $hasPermission = $this->facebook->api(
363 'method' => 'users.hasAppPermission',
364 'ext_perm' => $permission,
369 if ($hasPermission == 1) {
373 '%s (%d), fbuid %d has %s permission',
375 $this->user->nickname,
386 $logMsg = '%s (%d), fbuid $fbuid does NOT have %s permission.'
387 . 'Facebook returned: %s';
392 $this->user->nickname,
396 var_export($result, true)
406 * Handle a Facebook API Exception
408 * @param FacebookApiException $e the exception
411 function handleFacebookError($e)
413 $fbuid = $this->flink->foreign_id;
414 $errmsg = $e->getMessage();
415 $code = $e->getCode();
417 // The Facebook PHP SDK seems to always set the code attribute
418 // of the Exception to 0; they put the real error code in
421 preg_match('/^\(#(?<code>\d+)\)/', $errmsg, $matches);
422 $code = $matches['code'];
425 // XXX: Check for any others?
427 case 100: // Invalid parameter
428 $msg = 'Facebook claims notice %d was posted with an invalid '
429 . 'parameter (error code 100 - %s) Notice details: '
430 . '[nickname=%s, user id=%d, fbuid=%d, content="%s"]. '
437 $this->user->nickname,
440 $this->notice->content
446 case 200: // Permissions error
447 case 250: // Updating status requires the extended permission status_update
449 return true; // dequeue
451 case 341: // Feed action request limit reached
452 $msg = '%s (userid=%d, fbuid=%d) has exceeded his/her limit '
453 . 'for posting notices to Facebook today. Dequeuing '
465 // @todo FIXME: We want to rety at a later time when the throttling has expired
466 // instead of just giving up.
470 $msg = 'Facebook returned an error we don\'t know how to deal with '
471 . 'when posting notice %d. Error code: %d, error message: "%s"'
472 . ' Notice details: [nickname=%s, user id=%d, fbuid=%d, '
473 . 'notice content="%s"]. Dequeing.';
480 $this->user->nickname,
483 $this->notice->content
487 return true; // dequeue
493 * Publish a notice to Facebook as a status update
495 * This is the least preferable way to send a notice to Facebook because
496 * it doesn't support attachments and the API method doesn't return
497 * the ID of the post on Facebook.
500 function restStatusUpdate()
502 $fbuid = $this->flink->foreign_id;
506 "Attempting to post notice %d as a status update for %s (%d), fbuid %d",
508 $this->user->nickname,
515 $result = $this->facebook->api(
517 'method' => 'users.setStatus',
518 'status' => $this->formatMessage(),
519 'status_includes_verb' => true,
524 if ($result == 1) { // 1 is success
529 "Posted notice %s as a status update for %s (%d), fbuid %d",
531 $this->user->nickname,
538 // There is no item ID returned for status update so we can't
539 // save a Notice_to_item mapping
544 "Error posting notice %s as a status update for %s (%d), fbuid %d - error code: %s",
546 $this->user->nickname,
549 $result // will contain 0, or an error
552 throw new FacebookApiException($msg, $result);
557 * Publish a notice to a Facebook user's stream using the old REST API
559 function restPublishStream()
561 $fbuid = $this->flink->foreign_id;
565 'Attempting to post notice %d as stream item for %s (%d) fbuid %d',
567 $this->user->nickname,
574 $fbattachment = $this->formatAttachments();
576 $result = $this->facebook->api(
578 'method' => 'stream.publish',
579 'message' => $this->formatMessage(),
580 'attachment' => $fbattachment,
585 if (!empty($result)) { // result will contain the item ID
587 Notice_to_item::saveNew($this->notice->id, $result);
592 'Posted notice %d as a %s for %s (%d), fbuid %d',
594 empty($fbattachment) ? 'stream item' : 'stream item with attachment',
595 $this->user->nickname,
604 'Could not post notice %d as a %s for %s (%d), fbuid %d - error code: %s',
606 empty($fbattachment) ? 'stream item' : 'stream item with attachment',
607 $this->user->nickname,
609 $result, // result will contain an error code
613 throw new FacebookApiException($msg, $result);
618 * Format the text message of a stream item so it's appropriate for
619 * sending to Facebook. If the notice is too long, truncate it, and
620 * add a linkback to the original notice at the end.
622 * @return String $txt the formated message
624 function formatMessage()
626 // Start with the plaintext source of this notice...
627 $txt = $this->notice->content;
629 // Facebook has a 420-char hardcoded max.
630 if (mb_strlen($statustxt) > 420) {
631 $noticeUrl = common_shorten_url($this->notice->getUrl());
632 $urlLen = mb_strlen($noticeUrl);
633 $txt = mb_substr($statustxt, 0, 420 - ($urlLen + 3)) . ' … ' . $noticeUrl;
640 * Format attachments for the old REST API stream.publish method
642 * Note: Old REST API supports multiple attachments per post
645 function formatAttachments()
647 $attachments = $this->notice->attachments();
649 $fbattachment = array();
650 $fbattachment['media'] = array();
652 foreach($attachments as $attachment)
655 $enclosure = $attachment->getEnclosure();
656 $fbmedia = $this->getFacebookMedia($enclosure);
657 } catch (ServerException $e) {
658 $fbmedia = $this->getFacebookMedia($attachment);
661 $fbattachment['media'][]=$fbmedia;
663 $fbattachment['name'] = ($attachment->title ?
664 $attachment->title : $attachment->url);
665 $fbattachment['href'] = $attachment->url;
668 if(count($fbattachment['media'])>0){
669 unset($fbattachment['name']);
670 unset($fbattachment['href']);
672 return $fbattachment;
676 * given a File objects, returns an associative array suitable for Facebook media
678 function getFacebookMedia($attachment)
682 if (strncmp($attachment->mimetype, 'image/', strlen('image/')) == 0) {
683 $fbmedia['type'] = 'image';
684 $fbmedia['src'] = $attachment->url;
685 $fbmedia['href'] = $attachment->url;
686 } else if ($attachment->mimetype == 'audio/mpeg') {
687 $fbmedia['type'] = 'mp3';
688 $fbmedia['src'] = $attachment->url;
689 }else if ($attachment->mimetype == 'application/x-shockwave-flash') {
690 $fbmedia['type'] = 'flash';
692 // http://wiki.developers.facebook.com/index.php/Attachment_%28Streams%29
693 // says that imgsrc is required... but we have no value to put in it
694 // $fbmedia['imgsrc']='';
696 $fbmedia['swfsrc'] = $attachment->url;
704 * Disconnect a user from Facebook by deleting his Foreign_link.
705 * Notifies the user his account has been disconnected by email.
707 function disconnect()
709 $fbuid = $this->flink->foreign_id;
714 'Removing Facebook link for %s (%d), fbuid %d',
715 $this->user->nickname,
722 $result = $this->flink->delete();
724 if (empty($result)) {
728 'Could not remove Facebook link for %s (%d), fbuid %d',
729 $this->user->nickname,
735 common_log_db_error($flink, 'DELETE', __FILE__);
738 // Notify the user that we are removing their Facebook link
739 if (!empty($this->user->email)) {
740 $result = $this->mailFacebookDisconnect();
743 $msg = 'Unable to send email to notify %s (%d), fbuid %d '
744 . 'about his/her Facebook link being removed.';
750 $this->user->nickname,
758 $msg = 'Unable to send email to notify %s (%d), fbuid %d '
759 . 'about his/her Facebook link being removed because the '
760 . 'user has not set an email address.';
766 $this->user->nickname,
776 * Send a mail message to notify a user that her Facebook link
777 * has been terminated.
779 * @return boolean success flag
781 function mailFacebookDisconnect()
783 $profile = $this->user->getProfile();
785 $siteName = common_config('site', 'name');
787 common_switch_locale($this->user->language);
789 // TRANS: E-mail subject.
790 $subject = _m('Your Facebook connection has been removed');
792 // TRANS: E-mail body. %1$s is a username, %2$s is the StatusNet sitename.
793 $msg = _m("Hi %1\$s,\n\n".
794 "We are sorry to inform you we are unable to publish your notice to\n".
795 "Facebook, and have removed the connection between your %2\$s account and\n".
797 "This may have happened because you have removed permission for %2\$s\n".
798 "to post on your behalf, or perhaps you have deactivated your Facebook\n".
799 "account. You can reconnect your %2\$s account to Facebook at any time by\n".
800 "logging in with Facebook again.\n\n".
806 $this->user->nickname,
810 common_switch_locale();
812 $result = mail_to_user($this->user, $subject, $body);
814 if (empty($this->user->password)) {
815 $result = self::emailWarn($this->user);
822 * Send the user an email warning that their account has been
823 * disconnected and he/she has no way to login and must contact
824 * the site administrator for help.
826 * @param User $user the deauthorizing user
829 static function emailWarn($user)
831 $profile = $user->getProfile();
833 $siteName = common_config('site', 'name');
834 $siteEmail = common_config('site', 'email');
836 if (empty($siteEmail)) {
839 "No site email address configured. Please set one."
843 common_switch_locale($user->language);
845 // TRANS: E-mail subject. %s is the StatusNet sitename.
846 $subject = _m('Contact the %s administrator to retrieve your account');
848 // TRANS: E-mail body. %1$s is a username,
849 // TRANS: %2$s is the StatusNet sitename, %3$s is the site contact e-mail address.
850 $msg = _m("Hi %1\$s,\n\n".
851 "We have noticed you have deauthorized the Facebook connection for your\n".
852 "%2\$s account. You have not set a password for your %2\$s account yet, so\n".
853 "you will not be able to login. If you wish to continue using your %2\$s\n".
854 "account, please contact the site administrator (%3\$s) to set a password.\n\n".
865 common_switch_locale();
867 if (mail_to_user($user, $subject, $body)) {
871 'Sent account lockout warning to %s (%d)',
881 'Unable to send account lockout warning to %s (%d)',
891 * Check to see if we have a mapping to a copy of this notice
894 * @param Notice $notice the notice to check
896 * @return mixed null if it can't find one, or the id of the Facebook
899 static function facebookStatusId($notice)
901 $n2i = Notice_to_item::getKV('notice_id', $notice->id);
906 return $n2i->item_id;
911 * Save a Foreign_user record of a Facebook user
913 * @param object $fbuser a Facebook Graph API user obj
914 * See: http://developers.facebook.com/docs/reference/api/user
915 * @return mixed $result Id or key
918 static function addFacebookUser($fbuser)
920 // remove any existing, possibly outdated, record
921 $luser = Foreign_user::getForeignUser($fbuser->id, FACEBOOK_SERVICE);
923 if (!empty($luser)) {
925 $result = $luser->delete();
927 if ($result != false) {
931 'Removed old Facebook user: %s, fbuid %d',
940 $fuser = new Foreign_user();
942 $fuser->nickname = $fbuser->username;
943 $fuser->uri = $fbuser->link;
944 $fuser->id = $fbuser->id;
945 $fuser->service = FACEBOOK_SERVICE;
946 $fuser->created = common_sql_now();
948 $result = $fuser->insert();
950 if (empty($result)) {
954 'Failed to add new Facebook user: %s, fbuid %d',
961 common_log_db_error($fuser, 'INSERT', __FILE__);
966 'Added new Facebook user: %s, fbuid %d',
978 * Remove an item from a Facebook user's feed if we have a mapping
981 function streamRemove()
983 $n2i = Notice_to_item::getKV('notice_id', $this->notice->id);
985 if (!empty($this->flink) && !empty($n2i)) {
987 $result = $this->facebook->api(
989 'method' => 'stream.remove',
990 'post_id' => $n2i->item_id,
991 'uid' => $this->flink->foreign_id
995 if (!empty($result) && result == true) {
999 'Deleted Facebook item: %s for %s (%d), fbuid %d',
1001 $this->user->nickname,
1003 $this->flink->foreign_id
1011 throw new FaceboookApiException(var_export($result, true));
1013 } catch (FacebookApiException $e) {
1017 'Could not deleted Facebook item: %s for %s (%d), '
1018 . 'fbuid %d - (API error: %s) item already deleted '
1021 $this->user->nickname,
1023 $this->flink->foreign_id,
1033 * Like an item in a Facebook user's feed if we have a mapping
1038 $n2i = Notice_to_item::getKV('notice_id', $this->notice->id);
1040 if (!empty($this->flink) && !empty($n2i)) {
1042 $result = $this->facebook->api(
1044 'method' => 'stream.addlike',
1045 'post_id' => $n2i->item_id,
1046 'uid' => $this->flink->foreign_id
1050 if (!empty($result) && result == true) {
1054 'Added like for item: %s for %s (%d), fbuid %d',
1056 $this->user->nickname,
1058 $this->flink->foreign_id
1063 throw new FacebookApiException(var_export($result, true));
1065 } catch (FacebookApiException $e) {
1069 'Could not like Facebook item: %s for %s (%d), '
1070 . 'fbuid %d (API error: %s)',
1072 $this->user->nickname,
1074 $this->flink->foreign_id,
1084 * Unlike an item in a Facebook user's feed if we have a mapping
1089 $n2i = Notice_to_item::getKV('notice_id', $this->notice->id);
1091 if (!empty($this->flink) && !empty($n2i)) {
1093 $result = $this->facebook->api(
1095 'method' => 'stream.removeLike',
1096 'post_id' => $n2i->item_id,
1097 'uid' => $this->flink->foreign_id
1101 if (!empty($result) && result == true) {
1105 'Removed like for item: %s for %s (%d), fbuid %d',
1107 $this->user->nickname,
1109 $this->flink->foreign_id
1115 throw new FacebookApiException(var_export($result, true));
1117 } catch (FacebookApiException $e) {
1121 'Could not remove like for Facebook item: %s for %s '
1122 . '(%d), fbuid %d (API error: %s)',
1124 $this->user->nickname,
1126 $this->flink->foreign_id,