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
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.
179 if (!preg_match('/@[a-zA-Z0-9_]{1,15}\b/u', $this->notice->content) ||
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 throw new ServerException("No such permission!");
346 $fbuid = $this->flink->foreign_id;
350 'Checking for %s permission for user %s (%d), fbuid %d',
352 $this->user->nickname,
359 $hasPermission = $this->facebook->api(
361 'method' => 'users.hasAppPermission',
362 'ext_perm' => $permission,
367 if ($hasPermission == 1) {
371 '%s (%d), fbuid %d has %s permission',
373 $this->user->nickname,
384 $logMsg = '%s (%d), fbuid $fbuid does NOT have %s permission.'
385 . 'Facebook returned: %s';
390 $this->user->nickname,
394 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 // @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
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,
605 'Could not post notice %d as a %s for %s (%d), fbuid %d - error code: %s',
607 empty($fbattachment) ? 'stream item' : 'stream item with attachment',
608 $this->user->nickname,
610 $result, // result will contain an error code
614 throw new FacebookApiException($msg, $result);
619 * Format the text message of a stream item so it's appropriate for
620 * sending to Facebook. If the notice is too long, truncate it, and
621 * add a linkback to the original notice at the end.
623 * @return String $txt the formated message
625 function formatMessage()
627 // Start with the plaintext source of this notice...
628 $txt = $this->notice->content;
630 // Facebook has a 420-char hardcoded max.
631 if (mb_strlen($statustxt) > 420) {
632 $noticeUrl = common_shorten_url($this->notice->uri);
633 $urlLen = mb_strlen($noticeUrl);
634 $txt = mb_substr($statustxt, 0, 420 - ($urlLen + 3)) . ' … ' . $noticeUrl;
641 * Format attachments for the old REST API stream.publish method
643 * Note: Old REST API supports multiple attachments per post
646 function formatAttachments()
648 $attachments = $this->notice->attachments();
650 $fbattachment = array();
651 $fbattachment['media'] = array();
653 foreach($attachments as $attachment)
655 if($enclosure = $attachment->getEnclosure()){
656 $fbmedia = $this->getFacebookMedia($enclosure);
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();
744 $msg = 'Unable to send email to notify %s (%d), fbuid %d '
745 . 'about his/her Facebook link being removed.';
751 $this->user->nickname,
761 $msg = 'Unable to send email to notify %s (%d), fbuid %d '
762 . 'about his/her Facebook link being removed because the '
763 . 'user has not set an email address.';
769 $this->user->nickname,
779 * Send a mail message to notify a user that her Facebook link
780 * has been terminated.
782 * @return boolean success flag
784 function mailFacebookDisconnect()
786 $profile = $this->user->getProfile();
788 $siteName = common_config('site', 'name');
790 common_switch_locale($this->user->language);
792 $subject = _m('Your Facebook connection has been removed');
797 We're sorry to inform you we are unable to publish your notice to
798 Facebook, and have removed the connection between your %2$s account and
801 This may have happened because you have removed permission for %2$s
802 to post on your behalf, or perhaps you have deactivated your Facebook
803 account. You can reconnect your %s account to Facebook at any time by
804 logging in with Facebook again.
812 $this->user->nickname,
816 common_switch_locale();
818 $result = mail_to_user($this->user, $subject, $body);
820 if (empty($this->user->password)) {
821 $result = self::emailWarn($this->user);
828 * Send the user an email warning that their account has been
829 * disconnected and he/she has no way to login and must contact
830 * the site administrator for help.
832 * @param User $user the deauthorizing user
835 static function emailWarn($user)
837 $profile = $user->getProfile();
839 $siteName = common_config('site', 'name');
840 $siteEmail = common_config('site', 'email');
842 if (empty($siteEmail)) {
845 "No site email address configured. Please set one."
849 common_switch_locale($user->language);
851 $subject = _m('Contact the %s administrator to retrieve your account');
856 We've noticed you have deauthorized the Facebook connection for your
857 %2$s account. You have not set a password for your %2$s account yet, so
858 you will not be able to login. If you wish to continue using your %2$s
859 account, please contact the site administrator (%3$s) to set a password.
872 common_switch_locale();
874 if (mail_to_user($user, $subject, $body)) {
878 'Sent account lockout warning to %s (%d)',
888 'Unable to send account lockout warning to %s (%d)',
898 * Check to see if we have a mapping to a copy of this notice
901 * @param Notice $notice the notice to check
903 * @return mixed null if it can't find one, or the id of the Facebook
906 static function facebookStatusId($notice)
908 $n2i = Notice_to_item::staticGet('notice_id', $notice->id);
913 return $n2i->item_id;
918 * Save a Foreign_user record of a Facebook user
920 * @param object $fbuser a Facebook Graph API user obj
921 * See: http://developers.facebook.com/docs/reference/api/user
922 * @return mixed $result Id or key
925 static function addFacebookUser($fbuser)
927 // remove any existing, possibly outdated, record
928 $luser = Foreign_user::getForeignUser($fbuser['id'], FACEBOOK_SERVICE);
930 if (!empty($luser)) {
932 $result = $luser->delete();
934 if ($result != false) {
938 'Removed old Facebook user: %s, fbuid %d',
947 $fuser = new Foreign_user();
949 $fuser->nickname = $fbuser['name'];
950 $fuser->uri = $fbuser['link'];
951 $fuser->id = $fbuser['id'];
952 $fuser->service = FACEBOOK_SERVICE;
953 $fuser->created = common_sql_now();
955 $result = $fuser->insert();
957 if (empty($result)) {
961 'Failed to add new Facebook user: %s, fbuid %d',
968 common_log_db_error($fuser, 'INSERT', __FILE__);
973 'Added new Facebook user: %s, fbuid %d',
985 * Remove an item from a Facebook user's feed if we have a mapping
988 function streamRemove()
990 $n2i = Notice_to_item::staticGet('notice_id', $this->notice->id);
992 if (!empty($this->flink) && !empty($n2i)) {
996 $result = $this->facebook->api(
998 'method' => 'stream.remove',
999 'post_id' => $n2i->item_id,
1000 'uid' => $this->flink->foreign_id
1004 if (!empty($result) && result == true) {
1009 'Deleted Facebook item: %s for %s (%d), fbuid %d',
1011 $this->user->nickname,
1013 $this->flink->foreign_id
1021 throw new FaceboookApiException(var_export($result, true));
1024 } catch (FacebookApiException $e) {
1028 'Could not deleted Facebook item: %s for %s (%d), '
1029 . 'fbuid %d - (API error: %s) item already deleted '
1032 $this->user->nickname,
1034 $this->flink->foreign_id,
1044 * Like an item in a Facebook user's feed if we have a mapping
1049 $n2i = Notice_to_item::staticGet('notice_id', $this->notice->id);
1051 if (!empty($this->flink) && !empty($n2i)) {
1055 $result = $this->facebook->api(
1057 'method' => 'stream.addlike',
1058 'post_id' => $n2i->item_id,
1059 'uid' => $this->flink->foreign_id
1063 if (!empty($result) && result == true) {
1068 'Added like for item: %s for %s (%d), fbuid %d',
1070 $this->user->nickname,
1072 $this->flink->foreign_id
1078 throw new FacebookApiException(var_export($result, true));
1081 } catch (FacebookApiException $e) {
1085 'Could not like Facebook item: %s for %s (%d), '
1086 . 'fbuid %d (API error: %s)',
1088 $this->user->nickname,
1090 $this->flink->foreign_id,
1100 * Unlike an item in a Facebook user's feed if we have a mapping
1105 $n2i = Notice_to_item::staticGet('notice_id', $this->notice->id);
1107 if (!empty($this->flink) && !empty($n2i)) {
1111 $result = $this->facebook->api(
1113 'method' => 'stream.removeLike',
1114 'post_id' => $n2i->item_id,
1115 'uid' => $this->flink->foreign_id
1119 if (!empty($result) && result == true) {
1124 'Removed like for item: %s for %s (%d), fbuid %d',
1126 $this->user->nickname,
1128 $this->flink->foreign_id
1134 throw new FacebookApiException(var_export($result, true));
1137 } catch (FacebookApiException $e) {
1141 'Could not remove like for Facebook item: %s for %s '
1142 . '(%d), fbuid %d (API error: %s)',
1144 $this->user->nickname,
1146 $this->flink->foreign_id,