3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2008, 2009, StatusNet, Inc.
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Affero General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Affero General Public License for more details.
16 * You should have received a copy of the GNU Affero General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 require_once INSTALLDIR . '/plugins/Facebook/facebook/facebook.php';
21 require_once INSTALLDIR . '/plugins/Facebook/facebookaction.php';
22 require_once INSTALLDIR . '/lib/noticelist.php';
24 define("FACEBOOK_SERVICE", 2); // Facebook is foreign_service ID 2
25 define("FACEBOOK_NOTICE_PREFIX", 1);
26 define("FACEBOOK_PROMPTED_UPDATE_PREF", 2);
28 function getFacebook()
30 static $facebook = null;
32 $apikey = common_config('facebook', 'apikey');
33 $secret = common_config('facebook', 'secret');
35 if ($facebook === null) {
36 $facebook = new Facebook($apikey, $secret);
39 if (empty($facebook)) {
40 common_log(LOG_ERR, 'Could not make new Facebook client obj!',
47 function isFacebookBound($notice, $flink) {
55 if ($notice->source == 'Facebook') {
56 common_log(LOG_INFO, "Skipping notice $notice->id because its " .
57 'source is Facebook.');
61 // If the user does not want to broadcast to Facebook, move along
63 if (!($flink->noticesync & FOREIGN_NOTICE_SEND == FOREIGN_NOTICE_SEND)) {
64 common_log(LOG_INFO, "Skipping notice $notice->id " .
65 'because user has FOREIGN_NOTICE_SEND bit off.');
69 // If it's not a reply, or if the user WANTS to send @-replies,
70 // then, yeah, it can go to Facebook.
72 if (!preg_match('/@[a-zA-Z0-9_]{1,15}\b/u', $notice->content) ||
73 ($flink->noticesync & FOREIGN_NOTICE_SEND_REPLY)) {
81 function facebookBroadcastNotice($notice)
83 $facebook = getFacebook();
84 $flink = Foreign_link::getByUserID(
89 if (isFacebookBound($notice, $flink)) {
91 // Okay, we're good to go, update the FB status
93 $fbuid = $flink->foreign_id;
94 $user = $flink->getUser();
101 'FacebookPlugin - checking for publish_stream permission for user '
102 . "$user->nickname ($user->id), Facebook UID: $fbuid"
105 // NOTE: $facebook->api_client->users_hasAppPermission('publish_stream', $fbuid)
106 // has been returning bogus results, so we're using FQL to check for
107 // publish_stream permission now
109 $fql = "SELECT publish_stream FROM permissions WHERE uid = $fbuid";
110 $result = $facebook->api_client->fql_query($fql);
114 if (!empty($result)) {
115 $canPublish = $result[0]['publish_stream'];
118 if ($canPublish == 1) {
120 "FacebookPlugin - $user->nickname ($user->id), Facebook UID: $fbuid "
121 . 'has publish_stream permission.'
125 "FacebookPlugin - $user->nickname ($user->id), Facebook UID: $fbuid "
126 . 'does NOT have publish_stream permission. Facebook '
127 . 'returned: ' . var_export($result, true)
132 'FacebookPlugin - checking for status_update permission for user '
133 . "$user->nickname ($user->id), Facebook UID: $fbuid. "
136 $canUpdate = $facebook->api_client->users_hasAppPermission(
141 if ($canUpdate == 1) {
143 "FacebookPlugin - $user->nickname ($user->id), Facebook UID: $fbuid "
144 . 'has status_update permission.'
148 "FacebookPlugin - $user->nickname ($user->id), Facebook UID: $fbuid "
149 .'does NOT have status_update permission. Facebook '
150 . 'returned: ' . var_export($canPublish, true)
156 if ($notice->hasAttachments() && $canPublish == 1) {
157 publishStream($notice, $user, $fbuid);
158 } elseif ($canUpdate == 1 || $canPublish == 1) {
159 statusUpdate($notice, $user, $fbuid);
161 $msg = "FacebookPlugin - Not sending notice $notice->id to Facebook " .
162 "because user $user->nickname has not given the " .
163 'Facebook app \'status_update\' or \'publish_stream\' permission.';
164 common_log(LOG_WARNING, $msg);
167 // Finally, attempt to update the user's profile box
169 if ($canPublish == 1 || $canUpdate == 1) {
170 updateProfileBox($facebook, $flink, $notice, $user);
173 } catch (FacebookRestClientException $e) {
174 return handleFacebookError($e, $notice, $flink);
181 function handleFacebookError($e, $notice, $flink)
183 $fbuid = $flink->foreign_id;
184 $user = $flink->getUser();
185 $code = $e->getCode();
186 $errmsg = $e->getMessage();
188 // XXX: Check for any others?
190 case 100: // Invalid parameter
191 $msg = "FacebookPlugin - Facebook claims notice %d was posted with an invalid parameter (error code 100):"
192 . "\"%s\" (Notice details: nickname=%s, user ID=%d, Facebook ID=%d, notice content=\"%s\"). "
193 . "Removing notice from the Facebook queue for safety.";
207 case 200: // Permissions error
208 case 250: // Updating status requires the extended permission status_update
209 remove_facebook_app($flink);
210 return true; // dequeue
212 case 341: // Feed action request limit reached
213 $msg = "FacebookPlugin - User %s (User ID=%d, Facebook ID=%d) has exceeded "
214 . "his/her limit for posting notices to Facebook today. Dequeuing "
225 // @fixme: We want to rety at a later time when the throttling has expired
226 // instead of just giving up.
230 $msg = "FacebookPlugin - Facebook returned an error we don't know how to deal with while trying to "
231 . "post notice %d. Error code: %d, error message: \"%s\". (Notice details: "
232 . "nickname=%s, user ID=%d, Facebook ID=%d, notice content=\"%s\"). Removing notice "
233 . "from the Facebook queue for safety.";
246 return true; // dequeue
251 function statusUpdate($notice, $user, $fbuid)
254 "FacebookPlugin - Attempting to post notice $notice->id "
255 . "as a status update for $user->nickname ($user->id), "
256 . "Facebook UID: $fbuid"
259 $facebook = getFacebook();
260 $result = $facebook->api_client->users_setStatus(
267 common_debug('Facebook returned: ' . var_export($result, true));
271 "FacebookPlugin - Posted notice $notice->id as a status "
272 . "update for $user->nickname ($user->id), "
273 . "Facebook UID: $fbuid"
277 function publishStream($notice, $user, $fbuid)
280 "FacebookPlugin - Attempting to post notice $notice->id "
281 . "as stream item with attachment for $user->nickname ($user->id), "
282 . "Facebook UID: $fbuid"
285 $fbattachment = format_attachments($notice->attachments());
287 $facebook = getFacebook();
288 $facebook->api_client->stream_publish(
298 "FacebookPlugin - Posted notice $notice->id as a stream "
299 . "item with attachment for $user->nickname ($user->id), "
300 . "Facebook UID: $fbuid"
304 function updateProfileBox($facebook, $flink, $notice, $user) {
306 $facebook = getFacebook();
307 $fbaction = new FacebookAction(
308 $output = 'php://output',
314 $fbuid = $flink->foreign_id;
317 'FacebookPlugin - Attempting to update profile box with '
318 . "content from notice $notice->id for $user->nickname ($user->id), "
319 . "Facebook UID: $fbuid"
322 $fbaction->updateProfileBox($notice);
325 'FacebookPlugin - finished updating profile box for '
326 . "$user->nickname ($user->id) Facebook UID: $fbuid"
331 function format_attachments($attachments)
333 $fbattachment = array();
334 $fbattachment['media'] = array();
336 foreach($attachments as $attachment)
338 if($enclosure = $attachment->getEnclosure()){
339 $fbmedia = get_fbmedia_for_attachment($enclosure);
341 $fbmedia = get_fbmedia_for_attachment($attachment);
344 $fbattachment['media'][]=$fbmedia;
346 $fbattachment['name'] = ($attachment->title ?
347 $attachment->title : $attachment->url);
348 $fbattachment['href'] = $attachment->url;
351 if(count($fbattachment['media'])>0){
352 unset($fbattachment['name']);
353 unset($fbattachment['href']);
355 return $fbattachment;
359 * given an File objects, returns an associative array suitable for Facebook media
361 function get_fbmedia_for_attachment($attachment)
365 if (strncmp($attachment->mimetype, 'image/', strlen('image/')) == 0) {
366 $fbmedia['type'] = 'image';
367 $fbmedia['src'] = $attachment->url;
368 $fbmedia['href'] = $attachment->url;
369 } else if ($attachment->mimetype == 'audio/mpeg') {
370 $fbmedia['type'] = 'mp3';
371 $fbmedia['src'] = $attachment->url;
372 }else if ($attachment->mimetype == 'application/x-shockwave-flash') {
373 $fbmedia['type'] = 'flash';
375 // http://wiki.developers.facebook.com/index.php/Attachment_%28Streams%29
376 // says that imgsrc is required... but we have no value to put in it
377 // $fbmedia['imgsrc']='';
379 $fbmedia['swfsrc'] = $attachment->url;
386 function remove_facebook_app($flink)
389 $user = $flink->getUser();
391 common_log(LOG_INFO, 'Removing Facebook App Foreign link for ' .
392 "user $user->nickname (user id: $user->id).");
394 $result = $flink->delete();
396 if (empty($result)) {
397 common_log(LOG_ERR, 'Could not remove Facebook App ' .
398 "Foreign_link for $user->nickname (user id: $user->id)!");
399 common_log_db_error($flink, 'DELETE', __FILE__);
402 // Notify the user that we are removing their FB app access
404 $result = mail_facebook_app_removed($user);
408 $msg = 'Unable to send email to notify ' .
409 "$user->nickname (user id: $user->id) " .
410 'that their Facebook app link was ' .
413 common_log(LOG_WARNING, $msg);
419 * Send a mail message to notify a user that her Facebook Application
420 * access has been removed.
422 * @param User $user user whose Facebook app link has been removed
424 * @return boolean success flag
427 function mail_facebook_app_removed($user)
429 $profile = $user->getProfile();
431 $site_name = common_config('site', 'name');
433 common_switch_locale($user->language);
436 _m('Your %1$s Facebook application access has been disabled.',
439 $body = sprintf(_m("Hi, %1\$s. We're sorry to inform you that we are " .
440 'unable to update your Facebook status from %2$s, and have disabled ' .
441 'the Facebook application for your account. This may be because ' .
442 'you have removed the Facebook application\'s authorization, or ' .
443 'have deleted your Facebook account. You can re-enable the ' .
444 'Facebook application and automatic status updating by ' .
445 "re-installing the %2\$s Facebook application.\n\nRegards,\n\n%2\$s"),
446 $user->nickname, $site_name);
448 common_switch_locale();
449 return mail_to_user($user, $subject, $body);