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-2010 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
51 function __construct($notice)
53 $this->facebook = self::getFacebook();
55 if (empty($this->facebook)) {
56 throw new FacebookApiException(
57 "Could not create Facebook client! Bad application ID or secret?"
61 $this->notice = $notice;
63 $this->flink = Foreign_link::getByUserID(
68 if (!empty($this->flink)) {
69 $this->user = $this->flink->getUser();
74 * Get an instance of the Facebook Graph SDK object
76 * @param string $appId Application
77 * @param string $secret Facebook API secret
79 * @return Facebook A Facebook SDK obj
81 static function getFacebook($appId = null, $secret = null)
83 // Check defaults and configuration for application ID and secret
85 $appId = common_config('facebook', 'appid');
89 $secret = common_config('facebook', 'secret');
92 // If there's no app ID and secret set in the local config, look
94 if (empty($appId) || empty($secret)) {
95 $appId = common_config('facebook', 'global_appid');
96 $secret = common_config('facebook', 'global_secret');
102 "Couldn't find Facebook application ID!",
107 if (empty($secret)) {
110 "Couldn't find Facebook application ID!",
125 * Broadcast a notice to Facebook
127 * @param Notice $notice the notice to send
129 static function facebookBroadcastNotice($notice)
131 $client = new Facebookclient($notice);
132 return $client->sendNotice();
136 * Should the notice go to Facebook?
138 function isFacebookBound() {
140 if (empty($this->flink)) {
141 // User hasn't setup bridging
146 if ($this->notice->source == 'Facebook') {
150 'Skipping notice %d because its source is Facebook.',
158 // If the user does not want to broadcast to Facebook, move along
159 if (!($this->flink->noticesync & FOREIGN_NOTICE_SEND == FOREIGN_NOTICE_SEND)) {
163 'Skipping notice %d because user has FOREIGN_NOTICE_SEND bit off.',
171 // If it's not a reply, or if the user WANTS to send @-replies,
172 // then, yeah, it can go to Facebook.
173 if (!preg_match('/@[a-zA-Z0-9_]{1,15}\b/u', $this->notice->content) ||
174 ($this->flink->noticesync & FOREIGN_NOTICE_SEND_REPLY)) {
182 * Determine whether we should send this notice using the Graph API or the
183 * old REST API and then dispatch
185 function sendNotice()
187 // If there's nothing in the credentials field try to send via
190 if ($this->isFacebookBound()) {
191 common_debug("notice is facebook bound", __FILE__);
192 if (empty($this->flink->credentials)) {
193 return $this->sendOldRest();
196 // Otherwise we most likely have an access token
197 return $this->sendGraph();
206 * Send a notice to Facebook using the Graph API
212 $fbuid = $this->flink->foreign_id;
216 "Attempting use Graph API to post notice %d as a stream item for %s (%d), fbuid %d",
218 $this->user->nickname,
226 'access_token' => $this->flink->credentials,
227 // XXX: Need to worrry about length of the message?
228 'message' => $this->notice->content
231 $attachments = $this->notice->attachments();
233 if (!empty($attachments)) {
235 // We can only send one attachment with the Graph API :(
237 $first = array_shift($attachments);
239 if (substr($first->mimetype, 0, 6) == 'image/'
242 array('application/x-shockwave-flash', 'audio/mpeg' ))) {
244 $params['picture'] = $first->url;
245 $params['caption'] = 'Click for full size';
246 $params['source'] = $first->url;
251 $result = $this->facebook->api(
252 sprintf('/%s/feed', $fbuid), 'post', $params
256 Notice_to_item::saveNew($this->notice->id, $result['id']);
261 "Posted notice %d as a stream item for %s (%d), fbuid %d",
263 $this->user->nickname,
270 } catch (FacebookApiException $e) {
271 return $this->handleFacebookError($e);
278 * Send a notice to Facebook using the deprecated Old REST API. We need this
279 * for backwards compatibility. Users who signed up for Facebook bridging
280 * using the old Facebook Canvas application do not have an OAuth 2.0
283 function sendOldRest()
287 $canPublish = $this->checkPermission('publish_stream');
288 $canUpdate = $this->checkPermission('status_update');
290 // We prefer to use stream.publish, because it can handle
291 // attachments and returns the ID of the published item
293 if ($canPublish == 1) {
294 $this->restPublishStream();
295 } else if ($canUpdate == 1) {
296 // as a last resort we can just update the user's "status"
297 $this->restStatusUpdate();
300 $msg = 'Not sending notice %d to Facebook because user %s '
301 . '(%d), fbuid %d, does not have \'status_update\' '
302 . 'or \'publish_stream\' permission.';
309 $this->user->nickname,
311 $this->flink->foreign_id
317 } catch (FacebookApiException $e) {
318 return $this->handleFacebookError($e);
325 * Query Facebook to to see if a user has permission
329 * @param $permission the permission to check for - must be either
330 * public_stream or status_update
332 * @return boolean result
334 function checkPermission($permission)
336 if (!in_array($permission, array('publish_stream', 'status_update'))) {
337 throw new ServerException("No such permission!");
340 $fbuid = $this->flink->foreign_id;
344 'Checking for %s permission for user %s (%d), fbuid %d',
346 $this->user->nickname,
353 $hasPermission = $this->facebook->api(
355 'method' => 'users.hasAppPermission',
356 'ext_perm' => $permission,
361 if ($hasPermission == 1) {
365 '%s (%d), fbuid %d has %s permission',
367 $this->user->nickname,
378 $logMsg = '%s (%d), fbuid $fbuid does NOT have %s permission.'
379 . 'Facebook returned: %s';
384 $this->user->nickname,
388 var_export($result, true)
399 * Handle a Facebook API Exception
401 * @param FacebookApiException $e the exception
404 function handleFacebookError($e)
406 $fbuid = $this->flink->foreign_id;
407 $errmsg = $e->getMessage();
408 $code = $e->getCode();
410 // The Facebook PHP SDK seems to always set the code attribute
411 // of the Exception to 0; they put the real error code in
414 preg_match('/^\(#(?<code>\d+)\)/', $errmsg, $matches);
415 $code = $matches['code'];
418 // XXX: Check for any others?
420 case 100: // Invalid parameter
421 $msg = 'Facebook claims notice %d was posted with an invalid '
422 . 'parameter (error code 100 - %s) Notice details: '
423 . '[nickname=%s, user id=%d, fbuid=%d, content="%s"]. '
430 $this->user->nickname,
433 $this->notice->content
439 case 200: // Permissions error
440 case 250: // Updating status requires the extended permission status_update
442 return true; // dequeue
444 case 341: // Feed action request limit reached
445 $msg = '%s (userid=%d, fbuid=%d) has exceeded his/her limit '
446 . 'for posting notices to Facebook today. Dequeuing '
458 // @fixme: We want to rety at a later time when the throttling has expired
459 // instead of just giving up.
463 $msg = 'Facebook returned an error we don\'t know how to deal with '
464 . 'when posting notice %d. Error code: %d, error message: "%s"'
465 . ' Notice details: [nickname=%s, user id=%d, fbuid=%d, '
466 . 'notice content="%s"]. Dequeing.';
473 $this->user->nickname,
476 $this->notice->content
480 return true; // dequeue
486 * Publish a notice to Facebook as a status update
488 * This is the least preferable way to send a notice to Facebook because
489 * it doesn't support attachments and the API method doesn't return
490 * the ID of the post on Facebook.
493 function restStatusUpdate()
495 $fbuid = $this->flink->foreign_id;
499 "Attempting to post notice %d as a status update for %s (%d), fbuid %d",
501 $this->user->nickname,
508 $result = $this->facebook->api(
510 'method' => 'users.setStatus',
511 'status' => $this->formatMessage(),
512 'status_includes_verb' => true,
517 if ($result == 1) { // 1 is success
522 "Posted notice %s as a status update for %s (%d), fbuid %d",
524 $this->user->nickname,
531 // There is no item ID returned for status update so we can't
532 // save a Notice_to_item mapping
537 "Error posting notice %s as a status update for %s (%d), fbuid %d - error code: %s",
539 $this->user->nickname,
542 $result // will contain 0, or an error
545 throw new FacebookApiException($msg, $result);
550 * Publish a notice to a Facebook user's stream using the old REST API
552 function restPublishStream()
554 $fbuid = $this->flink->foreign_id;
558 'Attempting to post notice %d as stream item for %s (%d) fbuid %d',
560 $this->user->nickname,
567 $fbattachment = $this->formatAttachments();
569 $result = $this->facebook->api(
571 'method' => 'stream.publish',
572 'message' => $this->formatMessage(),
573 'attachment' => $fbattachment,
578 if (!empty($result)) { // result will contain the item ID
581 Notice_to_item::saveNew($this->notice->id, $result);
586 'Posted notice %d as a %s for %s (%d), fbuid %d',
588 empty($fbattachment) ? 'stream item' : 'stream item with attachment',
589 $this->user->nickname,
599 'Could not post notice %d as a %s for %s (%d), fbuid %d - error code: %s',
601 empty($fbattachment) ? 'stream item' : 'stream item with attachment',
602 $this->user->nickname,
604 $result, // result will contain an error code
608 throw new FacebookApiException($msg, $result);
613 * Format the text message of a stream item so it's appropriate for
614 * sending to Facebook. If the notice is too long, truncate it, and
615 * add a linkback to the original notice at the end.
617 * @return String $txt the formated message
619 function formatMessage()
621 // Start with the plaintext source of this notice...
622 $txt = $this->notice->content;
624 // Facebook has a 420-char hardcoded max.
625 if (mb_strlen($statustxt) > 420) {
626 $noticeUrl = common_shorten_url($this->notice->uri);
627 $urlLen = mb_strlen($noticeUrl);
628 $txt = mb_substr($statustxt, 0, 420 - ($urlLen + 3)) . ' … ' . $noticeUrl;
635 * Format attachments for the old REST API stream.publish method
637 * Note: Old REST API supports multiple attachments per post
640 function formatAttachments()
642 $attachments = $this->notice->attachments();
644 $fbattachment = array();
645 $fbattachment['media'] = array();
647 foreach($attachments as $attachment)
649 if($enclosure = $attachment->getEnclosure()){
650 $fbmedia = $this->getFacebookMedia($enclosure);
652 $fbmedia = $this->getFacebookMedia($attachment);
655 $fbattachment['media'][]=$fbmedia;
657 $fbattachment['name'] = ($attachment->title ?
658 $attachment->title : $attachment->url);
659 $fbattachment['href'] = $attachment->url;
662 if(count($fbattachment['media'])>0){
663 unset($fbattachment['name']);
664 unset($fbattachment['href']);
666 return $fbattachment;
670 * given a File objects, returns an associative array suitable for Facebook media
672 function getFacebookMedia($attachment)
676 if (strncmp($attachment->mimetype, 'image/', strlen('image/')) == 0) {
677 $fbmedia['type'] = 'image';
678 $fbmedia['src'] = $attachment->url;
679 $fbmedia['href'] = $attachment->url;
680 } else if ($attachment->mimetype == 'audio/mpeg') {
681 $fbmedia['type'] = 'mp3';
682 $fbmedia['src'] = $attachment->url;
683 }else if ($attachment->mimetype == 'application/x-shockwave-flash') {
684 $fbmedia['type'] = 'flash';
686 // http://wiki.developers.facebook.com/index.php/Attachment_%28Streams%29
687 // says that imgsrc is required... but we have no value to put in it
688 // $fbmedia['imgsrc']='';
690 $fbmedia['swfsrc'] = $attachment->url;
698 * Disconnect a user from Facebook by deleting his Foreign_link.
699 * Notifies the user his account has been disconnected by email.
701 function disconnect()
703 $fbuid = $this->flink->foreign_id;
708 'Removing Facebook link for %s (%d), fbuid %d',
709 $this->user->nickname,
716 $result = $this->flink->delete();
718 if (empty($result)) {
722 'Could not remove Facebook link for %s (%d), fbuid %d',
723 $this->user->nickname,
729 common_log_db_error($flink, 'DELETE', __FILE__);
732 // Notify the user that we are removing their Facebook link
733 if (!empty($this->user->email)) {
734 $result = $this->mailFacebookDisconnect();
738 $msg = 'Unable to send email to notify %s (%d), fbuid %d '
739 . 'about his/her Facebook link being removed.';
745 $this->user->nickname,
755 $msg = 'Unable to send email to notify %s (%d), fbuid %d '
756 . 'about his/her Facebook link being removed because the '
757 . 'user has not set an email address.';
763 $this->user->nickname,
773 * Send a mail message to notify a user that her Facebook link
774 * has been terminated.
776 * @return boolean success flag
778 function mailFacebookDisconnect()
780 $profile = $this->user->getProfile();
782 $siteName = common_config('site', 'name');
784 common_switch_locale($this->user->language);
786 $subject = _m('Your Facebook connection has been removed');
791 We're sorry to inform you we are unable to publish your notice to
792 Facebook, and have removed the connection between your %2$s account and
795 This may have happened because you have removed permission for %2$s
796 to post on your behalf, or perhaps you have deactivated your Facebook
797 account. You can reconnect your %s account to Facebook at any time by
798 logging in with Facebook again.
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 $subject = _m('Contact the %s administrator to retrieve your account');
850 We've noticed you have deauthorized the Facebook connection for your
851 %2$s account. You have not set a password for your %2$s account yet, so
852 you will not be able to login. If you wish to continue using your %2$s
853 account, please contact the site administrator (%3$s) to set a password.
866 common_switch_locale();
868 if (mail_to_user($user, $subject, $body)) {
872 'Sent account lockout warning to %s (%d)',
882 'Unable to send account lockout warning to %s (%d)',
892 * Check to see if we have a mapping to a copy of this notice
895 * @param Notice $notice the notice to check
897 * @return mixed null if it can't find one, or the id of the Facebook
900 static function facebookStatusId($notice)
902 $n2i = Notice_to_item::staticGet('notice_id', $notice->id);
907 return $n2i->item_id;
912 * Save a Foreign_user record of a Facebook user
914 * @param object $fbuser a Facebook Graph API user obj
915 * See: http://developers.facebook.com/docs/reference/api/user
916 * @return mixed $result Id or key
919 static function addFacebookUser($fbuser)
921 // remove any existing, possibly outdated, record
922 $luser = Foreign_user::getForeignUser($fbuser['id'], FACEBOOK_SERVICE);
924 if (!empty($luser)) {
926 $result = $luser->delete();
928 if ($result != false) {
932 'Removed old Facebook user: %s, fbuid %d',
941 $fuser = new Foreign_user();
943 $fuser->nickname = $fbuser['name'];
944 $fuser->uri = $fbuser['link'];
945 $fuser->id = $fbuser['id'];
946 $fuser->service = FACEBOOK_SERVICE;
947 $fuser->created = common_sql_now();
949 $result = $fuser->insert();
951 if (empty($result)) {
955 'Failed to add new Facebook user: %s, fbuid %d',
962 common_log_db_error($fuser, 'INSERT', __FILE__);
967 'Added new Facebook user: %s, fbuid %d',
979 * Remove an item from a Facebook user's feed if we have a mapping
982 function streamRemove()
984 $n2i = Notice_to_item::staticGet('notice_id', $this->notice->id);
986 if (!empty($this->flink) && !empty($n2i)) {
990 $result = $this->facebook->api(
992 'method' => 'stream.remove',
993 'post_id' => $n2i->item_id,
994 'uid' => $this->flink->foreign_id
998 if (!empty($result) && result == true) {
1003 'Deleted Facebook item: %s for %s (%d), fbuid %d',
1005 $this->user->nickname,
1007 $this->flink->foreign_id
1015 throw new FaceboookApiException(var_export($result, true));
1018 } catch (FacebookApiException $e) {
1022 'Could not deleted Facebook item: %s for %s (%d), '
1023 . 'fbuid %d - (API error: %s) item already deleted '
1026 $this->user->nickname,
1028 $this->flink->foreign_id,
1038 * Like an item in a Facebook user's feed if we have a mapping
1043 $n2i = Notice_to_item::staticGet('notice_id', $this->notice->id);
1045 if (!empty($this->flink) && !empty($n2i)) {
1049 $result = $this->facebook->api(
1051 'method' => 'stream.addlike',
1052 'post_id' => $n2i->item_id,
1053 'uid' => $this->flink->foreign_id
1057 if (!empty($result) && result == true) {
1062 'Added like for item: %s for %s (%d), fbuid %d',
1064 $this->user->nickname,
1066 $this->flink->foreign_id
1072 throw new FacebookApiException(var_export($result, true));
1075 } catch (FacebookApiException $e) {
1079 'Could not like Facebook item: %s for %s (%d), '
1080 . 'fbuid %d (API error: %s)',
1082 $this->user->nickname,
1084 $this->flink->foreign_id,
1094 * Unlike an item in a Facebook user's feed if we have a mapping
1099 $n2i = Notice_to_item::staticGet('notice_id', $this->notice->id);
1101 if (!empty($this->flink) && !empty($n2i)) {
1105 $result = $this->facebook->api(
1107 'method' => 'stream.removeLike',
1108 'post_id' => $n2i->item_id,
1109 'uid' => $this->flink->foreign_id
1113 if (!empty($result) && result == true) {
1118 'Removed like for item: %s for %s (%d), fbuid %d',
1120 $this->user->nickname,
1122 $this->flink->foreign_id
1128 throw new FacebookApiException(var_export($result, true));
1131 } catch (FacebookApiException $e) {
1135 'Could not remove like for Facebook item: %s for %s '
1136 . '(%d), fbuid %d (API error: %s)',
1138 $this->user->nickname,
1140 $this->flink->foreign_id,