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;
70 $this->flink = Foreign_link::getByUserID($profile_id, FACEBOOK_SERVICE);
71 $this->user = $this->flink->getUser();
72 } catch (NoResultException $e) {
73 // at least $this->flink could've gotten set to something,
74 // but the logic that was here before didn't care, so let's not care either
79 * Get an instance of the Facebook Graph SDK object
81 * @param string $appId Application
82 * @param string $secret Facebook API secret
84 * @return Facebook A Facebook SDK obj
86 static function getFacebook($appId = null, $secret = null)
88 // Check defaults and configuration for application ID and secret
90 $appId = common_config('facebook', 'appid');
94 $secret = common_config('facebook', 'secret');
97 // If there's no app ID and secret set in the local config, look
99 if (empty($appId) || empty($secret)) {
100 $appId = common_config('facebook', 'global_appid');
101 $secret = common_config('facebook', 'global_secret');
107 "Couldn't find Facebook application ID!",
112 if (empty($secret)) {
115 "Couldn't find Facebook application ID!",
130 * Broadcast a notice to Facebook
132 * @param Notice $notice the notice to send
134 static function facebookBroadcastNotice($notice)
136 $client = new Facebookclient($notice);
137 return $client->sendNotice();
141 * Should the notice go to Facebook?
143 function isFacebookBound() {
145 if (empty($this->flink)) {
146 // User hasn't setup bridging
151 if ($this->notice->source == 'Facebook') {
155 'Skipping notice %d because its source is Facebook.',
163 // If the user does not want to broadcast to Facebook, move along
164 if (!($this->flink->noticesync & FOREIGN_NOTICE_SEND == FOREIGN_NOTICE_SEND)) {
168 'Skipping notice %d because user has FOREIGN_NOTICE_SEND bit off.',
176 // If it's not a reply, or if the user WANTS to send @-replies,
177 // then, yeah, it can go to Facebook.
179 if (empty($this->notice->reply_to) ||
180 ($this->flink->noticesync & FOREIGN_NOTICE_SEND_REPLY)) {
188 * Determine whether we should send this notice using the Graph API or the
189 * old REST API and then dispatch
191 function sendNotice()
193 // If there's nothing in the credentials field try to send via
196 if ($this->isFacebookBound()) {
197 common_debug("notice is facebook bound", __FILE__);
198 if (empty($this->flink->credentials)) {
199 return $this->sendOldRest();
202 // Otherwise we most likely have an access token
203 return $this->sendGraph();
212 * Send a notice to Facebook using the Graph API
218 $fbuid = $this->flink->foreign_id;
222 "Attempting use Graph API to post notice %d as a stream item for %s (%d), fbuid %d",
224 $this->user->nickname,
232 'access_token' => $this->flink->credentials,
233 // XXX: Need to worrry about length of the message?
234 'message' => $this->notice->content
237 $attachments = $this->notice->attachments();
239 if (!empty($attachments)) {
241 // We can only send one attachment with the Graph API :(
243 $first = array_shift($attachments);
245 if (substr($first->mimetype, 0, 6) == 'image/'
248 array('application/x-shockwave-flash', 'audio/mpeg' ))) {
250 $params['picture'] = $first->url;
251 $params['caption'] = 'Click for full size';
252 $params['source'] = $first->url;
257 $result = $this->facebook->api(
258 sprintf('/%s/feed', $fbuid), 'post', $params
262 Notice_to_item::saveNew($this->notice->id, $result['id']);
267 "Posted notice %d as a stream item for %s (%d), fbuid %d",
269 $this->user->nickname,
276 } catch (FacebookApiException $e) {
277 return $this->handleFacebookError($e);
284 * Send a notice to Facebook using the deprecated Old REST API. We need this
285 * for backwards compatibility. Users who signed up for Facebook bridging
286 * using the old Facebook Canvas application do not have an OAuth 2.0
289 function sendOldRest()
293 $canPublish = $this->checkPermission('publish_stream');
294 $canUpdate = $this->checkPermission('status_update');
296 // We prefer to use stream.publish, because it can handle
297 // attachments and returns the ID of the published item
299 if ($canPublish == 1) {
300 $this->restPublishStream();
301 } else if ($canUpdate == 1) {
302 // as a last resort we can just update the user's "status"
303 $this->restStatusUpdate();
306 $msg = 'Not sending notice %d to Facebook because user %s '
307 . '(%d), fbuid %d, does not have \'status_update\' '
308 . 'or \'publish_stream\' permission.';
315 $this->user->nickname,
317 $this->flink->foreign_id
323 } catch (FacebookApiException $e) {
324 return $this->handleFacebookError($e);
331 * Query Facebook to to see if a user has permission
335 * @param $permission the permission to check for - must be either
336 * public_stream or status_update
338 * @return boolean result
340 function checkPermission($permission)
342 if (!in_array($permission, array('publish_stream', 'status_update'))) {
343 // TRANS: Server exception thrown when permission check fails.
344 throw new ServerException(_('No such permission!'));
347 $fbuid = $this->flink->foreign_id;
351 'Checking for %s permission for user %s (%d), fbuid %d',
353 $this->user->nickname,
360 $hasPermission = $this->facebook->api(
362 'method' => 'users.hasAppPermission',
363 'ext_perm' => $permission,
368 if ($hasPermission == 1) {
372 '%s (%d), fbuid %d has %s permission',
374 $this->user->nickname,
385 $logMsg = '%s (%d), fbuid $fbuid does NOT have %s permission.'
386 . 'Facebook returned: %s';
391 $this->user->nickname,
395 var_export($result, true)
405 * Handle a Facebook API Exception
407 * @param FacebookApiException $e the exception
410 function handleFacebookError($e)
412 $fbuid = $this->flink->foreign_id;
413 $errmsg = $e->getMessage();
414 $code = $e->getCode();
416 // The Facebook PHP SDK seems to always set the code attribute
417 // of the Exception to 0; they put the real error code in
420 preg_match('/^\(#(?<code>\d+)\)/', $errmsg, $matches);
421 $code = $matches['code'];
424 // XXX: Check for any others?
426 case 100: // Invalid parameter
427 $msg = 'Facebook claims notice %d was posted with an invalid '
428 . 'parameter (error code 100 - %s) Notice details: '
429 . '[nickname=%s, user id=%d, fbuid=%d, content="%s"]. '
436 $this->user->nickname,
439 $this->notice->content
445 case 200: // Permissions error
446 case 250: // Updating status requires the extended permission status_update
448 return true; // dequeue
450 case 341: // Feed action request limit reached
451 $msg = '%s (userid=%d, fbuid=%d) has exceeded his/her limit '
452 . 'for posting notices to Facebook today. Dequeuing '
464 // @todo FIXME: We want to rety at a later time when the throttling has expired
465 // instead of just giving up.
469 $msg = 'Facebook returned an error we don\'t know how to deal with '
470 . 'when posting notice %d. Error code: %d, error message: "%s"'
471 . ' Notice details: [nickname=%s, user id=%d, fbuid=%d, '
472 . 'notice content="%s"]. Dequeing.';
479 $this->user->nickname,
482 $this->notice->content
486 return true; // dequeue
492 * Publish a notice to Facebook as a status update
494 * This is the least preferable way to send a notice to Facebook because
495 * it doesn't support attachments and the API method doesn't return
496 * the ID of the post on Facebook.
499 function restStatusUpdate()
501 $fbuid = $this->flink->foreign_id;
505 "Attempting to post notice %d as a status update for %s (%d), fbuid %d",
507 $this->user->nickname,
514 $result = $this->facebook->api(
516 'method' => 'users.setStatus',
517 'status' => $this->formatMessage(),
518 'status_includes_verb' => true,
523 if ($result == 1) { // 1 is success
528 "Posted notice %s as a status update for %s (%d), fbuid %d",
530 $this->user->nickname,
537 // There is no item ID returned for status update so we can't
538 // save a Notice_to_item mapping
543 "Error posting notice %s as a status update for %s (%d), fbuid %d - error code: %s",
545 $this->user->nickname,
548 $result // will contain 0, or an error
551 throw new FacebookApiException($msg, $result);
556 * Publish a notice to a Facebook user's stream using the old REST API
558 function restPublishStream()
560 $fbuid = $this->flink->foreign_id;
564 'Attempting to post notice %d as stream item for %s (%d) fbuid %d',
566 $this->user->nickname,
573 $fbattachment = $this->formatAttachments();
575 $result = $this->facebook->api(
577 'method' => 'stream.publish',
578 'message' => $this->formatMessage(),
579 'attachment' => $fbattachment,
584 if (!empty($result)) { // result will contain the item ID
586 Notice_to_item::saveNew($this->notice->id, $result);
591 'Posted notice %d as a %s for %s (%d), fbuid %d',
593 empty($fbattachment) ? 'stream item' : 'stream item with attachment',
594 $this->user->nickname,
603 'Could not post notice %d as a %s for %s (%d), fbuid %d - error code: %s',
605 empty($fbattachment) ? 'stream item' : 'stream item with attachment',
606 $this->user->nickname,
608 $result, // result will contain an error code
612 throw new FacebookApiException($msg, $result);
617 * Format the text message of a stream item so it's appropriate for
618 * sending to Facebook. If the notice is too long, truncate it, and
619 * add a linkback to the original notice at the end.
621 * @return String $txt the formated message
623 function formatMessage()
625 // Start with the plaintext source of this notice...
626 $txt = $this->notice->content;
628 // Facebook has a 420-char hardcoded max.
629 if (mb_strlen($statustxt) > 420) {
630 $noticeUrl = common_shorten_url($this->notice->getUrl());
631 $urlLen = mb_strlen($noticeUrl);
632 $txt = mb_substr($statustxt, 0, 420 - ($urlLen + 3)) . ' … ' . $noticeUrl;
639 * Format attachments for the old REST API stream.publish method
641 * Note: Old REST API supports multiple attachments per post
644 function formatAttachments()
646 $attachments = $this->notice->attachments();
648 $fbattachment = array();
649 $fbattachment['media'] = array();
651 foreach($attachments as $attachment)
654 $enclosure = $attachment->getEnclosure();
655 $fbmedia = $this->getFacebookMedia($enclosure);
656 } catch (ServerException $e) {
657 $fbmedia = $this->getFacebookMedia($attachment);
660 $fbattachment['media'][]=$fbmedia;
662 $fbattachment['name'] = ($attachment->title ?
663 $attachment->title : $attachment->url);
664 $fbattachment['href'] = $attachment->url;
667 if(count($fbattachment['media'])>0){
668 unset($fbattachment['name']);
669 unset($fbattachment['href']);
671 return $fbattachment;
675 * given a File objects, returns an associative array suitable for Facebook media
677 function getFacebookMedia($attachment)
681 if (strncmp($attachment->mimetype, 'image/', strlen('image/')) == 0) {
682 $fbmedia['type'] = 'image';
683 $fbmedia['src'] = $attachment->url;
684 $fbmedia['href'] = $attachment->url;
685 } else if ($attachment->mimetype == 'audio/mpeg') {
686 $fbmedia['type'] = 'mp3';
687 $fbmedia['src'] = $attachment->url;
688 }else if ($attachment->mimetype == 'application/x-shockwave-flash') {
689 $fbmedia['type'] = 'flash';
691 // http://wiki.developers.facebook.com/index.php/Attachment_%28Streams%29
692 // says that imgsrc is required... but we have no value to put in it
693 // $fbmedia['imgsrc']='';
695 $fbmedia['swfsrc'] = $attachment->url;
703 * Disconnect a user from Facebook by deleting his Foreign_link.
704 * Notifies the user his account has been disconnected by email.
706 function disconnect()
708 $fbuid = $this->flink->foreign_id;
713 'Removing Facebook link for %s (%d), fbuid %d',
714 $this->user->nickname,
721 $result = $this->flink->delete();
723 if (empty($result)) {
727 'Could not remove Facebook link for %s (%d), fbuid %d',
728 $this->user->nickname,
734 common_log_db_error($flink, 'DELETE', __FILE__);
737 // Notify the user that we are removing their Facebook link
738 if (!empty($this->user->email)) {
739 $result = $this->mailFacebookDisconnect();
742 $msg = 'Unable to send email to notify %s (%d), fbuid %d '
743 . 'about his/her Facebook link being removed.';
749 $this->user->nickname,
757 $msg = 'Unable to send email to notify %s (%d), fbuid %d '
758 . 'about his/her Facebook link being removed because the '
759 . 'user has not set an email address.';
765 $this->user->nickname,
775 * Send a mail message to notify a user that her Facebook link
776 * has been terminated.
778 * @return boolean success flag
780 function mailFacebookDisconnect()
782 $profile = $this->user->getProfile();
784 $siteName = common_config('site', 'name');
786 common_switch_locale($this->user->language);
788 // TRANS: E-mail subject.
789 $subject = _m('Your Facebook connection has been removed');
791 // TRANS: E-mail body. %1$s is a username, %2$s is the StatusNet sitename.
792 $msg = _m("Hi %1\$s,\n\n".
793 "We are sorry to inform you we are unable to publish your notice to\n".
794 "Facebook, and have removed the connection between your %2\$s account and\n".
796 "This may have happened because you have removed permission for %2\$s\n".
797 "to post on your behalf, or perhaps you have deactivated your Facebook\n".
798 "account. You can reconnect your %2\$s account to Facebook at any time by\n".
799 "logging in with Facebook again.\n\n".
805 $this->user->nickname,
809 common_switch_locale();
811 $result = mail_to_user($this->user, $subject, $body);
813 if (empty($this->user->password)) {
814 $result = self::emailWarn($this->user);
821 * Send the user an email warning that their account has been
822 * disconnected and he/she has no way to login and must contact
823 * the site administrator for help.
825 * @param User $user the deauthorizing user
828 static function emailWarn($user)
830 $profile = $user->getProfile();
832 $siteName = common_config('site', 'name');
833 $siteEmail = common_config('site', 'email');
835 if (empty($siteEmail)) {
838 "No site email address configured. Please set one."
842 common_switch_locale($user->language);
844 // TRANS: E-mail subject. %s is the StatusNet sitename.
845 $subject = _m('Contact the %s administrator to retrieve your account');
847 // TRANS: E-mail body. %1$s is a username,
848 // TRANS: %2$s is the StatusNet sitename, %3$s is the site contact e-mail address.
849 $msg = _m("Hi %1\$s,\n\n".
850 "We have noticed you have deauthorized the Facebook connection for your\n".
851 "%2\$s account. You have not set a password for your %2\$s account yet, so\n".
852 "you will not be able to login. If you wish to continue using your %2\$s\n".
853 "account, please contact the site administrator (%3\$s) to set a password.\n\n".
864 common_switch_locale();
866 if (mail_to_user($user, $subject, $body)) {
870 'Sent account lockout warning to %s (%d)',
880 'Unable to send account lockout warning to %s (%d)',
890 * Check to see if we have a mapping to a copy of this notice
893 * @param Notice $notice the notice to check
895 * @return mixed null if it can't find one, or the id of the Facebook
898 static function facebookStatusId($notice)
900 $n2i = Notice_to_item::getKV('notice_id', $notice->id);
905 return $n2i->item_id;
910 * Save a Foreign_user record of a Facebook user
912 * @param object $fbuser a Facebook Graph API user obj
913 * See: http://developers.facebook.com/docs/reference/api/user
914 * @return mixed $result Id or key
917 static function addFacebookUser($fbuser)
919 // remove any existing, possibly outdated, record
921 $fuser = Foreign_user::getForeignUser($fbuser->id, FACEBOOK_SERVICE);
922 $result = $fuser->delete();
923 if ($result != false) {
927 'Removed old Facebook user: %s, fbuid %d',
934 } catch (NoResultException $e) {
935 // no old foreign users exist for this id
938 $fuser = new Foreign_user();
940 $fuser->nickname = $fbuser->username;
941 $fuser->uri = $fbuser->link;
942 $fuser->id = $fbuser->id;
943 $fuser->service = FACEBOOK_SERVICE;
944 $fuser->created = common_sql_now();
946 $result = $fuser->insert();
948 if (empty($result)) {
952 'Failed to add new Facebook user: %s, fbuid %d',
959 common_log_db_error($fuser, 'INSERT', __FILE__);
964 'Added new Facebook user: %s, fbuid %d',
976 * Remove an item from a Facebook user's feed if we have a mapping
979 function streamRemove()
981 $n2i = Notice_to_item::getKV('notice_id', $this->notice->id);
983 if (!empty($this->flink) && !empty($n2i)) {
985 $result = $this->facebook->api(
987 'method' => 'stream.remove',
988 'post_id' => $n2i->item_id,
989 'uid' => $this->flink->foreign_id
993 if (!empty($result) && result == true) {
997 'Deleted Facebook item: %s for %s (%d), fbuid %d',
999 $this->user->nickname,
1001 $this->flink->foreign_id
1009 throw new FaceboookApiException(var_export($result, true));
1011 } catch (FacebookApiException $e) {
1015 'Could not deleted Facebook item: %s for %s (%d), '
1016 . 'fbuid %d - (API error: %s) item already deleted '
1019 $this->user->nickname,
1021 $this->flink->foreign_id,
1031 * Like an item in a Facebook user's feed if we have a mapping
1036 $n2i = Notice_to_item::getKV('notice_id', $this->notice->id);
1038 if (!empty($this->flink) && !empty($n2i)) {
1040 $result = $this->facebook->api(
1042 'method' => 'stream.addlike',
1043 'post_id' => $n2i->item_id,
1044 'uid' => $this->flink->foreign_id
1048 if (!empty($result) && result == true) {
1052 'Added like for item: %s for %s (%d), fbuid %d',
1054 $this->user->nickname,
1056 $this->flink->foreign_id
1061 throw new FacebookApiException(var_export($result, true));
1063 } catch (FacebookApiException $e) {
1067 'Could not like Facebook item: %s for %s (%d), '
1068 . 'fbuid %d (API error: %s)',
1070 $this->user->nickname,
1072 $this->flink->foreign_id,
1082 * Unlike an item in a Facebook user's feed if we have a mapping
1087 $n2i = Notice_to_item::getKV('notice_id', $this->notice->id);
1089 if (!empty($this->flink) && !empty($n2i)) {
1091 $result = $this->facebook->api(
1093 'method' => 'stream.removeLike',
1094 'post_id' => $n2i->item_id,
1095 'uid' => $this->flink->foreign_id
1099 if (!empty($result) && result == true) {
1103 'Removed like for item: %s for %s (%d), fbuid %d',
1105 $this->user->nickname,
1107 $this->flink->foreign_id
1113 throw new FacebookApiException(var_export($result, true));
1115 } catch (FacebookApiException $e) {
1119 'Could not remove like for Facebook item: %s for %s '
1120 . '(%d), fbuid %d (API error: %s)',
1122 $this->user->nickname,
1124 $this->flink->foreign_id,