Upgrade Facebook posting:
- Use FQL to check for publish stream permission instead of old REST API - Better error handling, especially for error code 100 - More logging / better log messages
This commit is contained in:
Zach Copley
parent
8d87514727
commit
777ca74500
|
|
@ -81,114 +81,288 @@ function isFacebookBound($notice, $flink) {
|
||||||
function facebookBroadcastNotice($notice)
|
function facebookBroadcastNotice($notice)
|
||||||
{
|
{
|
||||||
$facebook = getFacebook();
|
$facebook = getFacebook();
|
||||||
$flink = Foreign_link::getByUserID($notice->profile_id, FACEBOOK_SERVICE);
|
$flink = Foreign_link::getByUserID(
|
||||||
|
$notice->profile_id,
|
||||||
|
FACEBOOK_SERVICE
|
||||||
|
);
|
||||||
|
|
||||||
if (isFacebookBound($notice, $flink)) {
|
if (isFacebookBound($notice, $flink)) {
|
||||||
|
|
||||||
// Okay, we're good to go, update the FB status
|
// Okay, we're good to go, update the FB status
|
||||||
|
|
||||||
$status = null;
|
|
||||||
$fbuid = $flink->foreign_id;
|
$fbuid = $flink->foreign_id;
|
||||||
$user = $flink->getUser();
|
$user = $flink->getUser();
|
||||||
$attachments = $notice->attachments();
|
|
||||||
|
|
||||||
try {
|
try {
|
||||||
|
|
||||||
// Get the status 'verb' (prefix) the user has set
|
// Check permissions
|
||||||
|
|
||||||
// XXX: Does this call count against our per user FB request limit?
|
common_debug(
|
||||||
// If so we should consider storing verb elsewhere or not storing
|
'FacebookPlugin - checking for publish_stream permission for user '
|
||||||
|
. "$user->nickname ($user->id), Facebook UID: $fbuid"
|
||||||
|
);
|
||||||
|
|
||||||
$prefix = trim($facebook->api_client->data_getUserPreference(FACEBOOK_NOTICE_PREFIX,
|
// NOTE: $facebook->api_client->users_hasAppPermission('publish_stream', $fbuid)
|
||||||
$fbuid));
|
// has been returning bogus results, so we're using FQL to check for
|
||||||
|
// publish_stream permission now
|
||||||
|
|
||||||
$status = "$prefix $notice->content";
|
$fql = "SELECT publish_stream FROM permissions WHERE uid = $fbuid";
|
||||||
|
$result = $facebook->api_client->fql_query($fql);
|
||||||
|
|
||||||
common_debug("FacebookPlugin - checking for publish_stream permission for user $user->id");
|
$canPublish = 0;
|
||||||
|
|
||||||
$can_publish = $facebook->api_client->users_hasAppPermission('publish_stream',
|
if (!empty($result)) {
|
||||||
$fbuid);
|
$canPublish = $result[0]['publish_stream'];
|
||||||
|
}
|
||||||
|
|
||||||
common_debug("FacebookPlugin - checking for status_update permission for user $user->id");
|
if ($canPublish == 1) {
|
||||||
|
common_debug(
|
||||||
|
"FacebookPlugin - $user->nickname ($user->id), Facebook UID: $fbuid "
|
||||||
|
. 'has publish_stream permission.'
|
||||||
|
);
|
||||||
|
} else {
|
||||||
|
common_debug(
|
||||||
|
"FacebookPlugin - $user->nickname ($user->id), Facebook UID: $fbuid "
|
||||||
|
. 'does NOT have publish_stream permission. Facebook '
|
||||||
|
. 'returned: ' . var_export($result, true)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
$can_update = $facebook->api_client->users_hasAppPermission('status_update',
|
common_debug(
|
||||||
$fbuid);
|
'FacebookPlugin - checking for status_update permission for user '
|
||||||
if (!empty($attachments) && $can_publish == 1) {
|
. "$user->nickname ($user->id), Facebook UID: $fbuid. "
|
||||||
$fbattachment = format_attachments($attachments);
|
);
|
||||||
$facebook->api_client->stream_publish($status, $fbattachment,
|
|
||||||
null, null, $fbuid);
|
$canUpdate = $facebook->api_client->users_hasAppPermission(
|
||||||
common_log(LOG_INFO,
|
'status_update',
|
||||||
"FacebookPlugin - Posted notice $notice->id w/attachment " .
|
$fbuid
|
||||||
"to Facebook user's stream (fbuid = $fbuid).");
|
);
|
||||||
} elseif ($can_update == 1 || $can_publish == 1) {
|
|
||||||
$facebook->api_client->users_setStatus($status, $fbuid, false, true);
|
if ($canUpdate == 1) {
|
||||||
common_log(LOG_INFO,
|
common_debug(
|
||||||
"FacebookPlugin - Posted notice $notice->id to Facebook " .
|
"FacebookPlugin - $user->nickname ($user->id), Facebook UID: $fbuid "
|
||||||
"as a status update (fbuid = $fbuid).");
|
. 'has status_update permission.'
|
||||||
|
);
|
||||||
|
} else {
|
||||||
|
common_debug(
|
||||||
|
"FacebookPlugin - $user->nickname ($user->id), Facebook UID: $fbuid "
|
||||||
|
.'does NOT have status_update permission. Facebook '
|
||||||
|
. 'returned: ' . var_export($can_publish, true)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Post to Facebook
|
||||||
|
|
||||||
|
if ($notice->hasAttachments() && $canPublish == 1) {
|
||||||
|
publishStream($notice, $user, $fbuid);
|
||||||
|
} elseif ($canUpdate == 1 || $canPublish == 1) {
|
||||||
|
statusUpdate($notice, $user, $fbuid);
|
||||||
} else {
|
} else {
|
||||||
$msg = "FacebookPlugin - Not sending notice $notice->id to Facebook " .
|
$msg = "FacebookPlugin - Not sending notice $notice->id to Facebook " .
|
||||||
"because user $user->nickname hasn't given the " .
|
"because user $user->nickname has not given the " .
|
||||||
'Facebook app \'status_update\' or \'publish_stream\' permission.';
|
'Facebook app \'status_update\' or \'publish_stream\' permission.';
|
||||||
common_log(LOG_WARNING, $msg);
|
common_log(LOG_WARNING, $msg);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Finally, attempt to update the user's profile box
|
// Finally, attempt to update the user's profile box
|
||||||
|
|
||||||
if ($can_publish == 1 || $can_update == 1) {
|
if ($canPublish == 1 || $canUpdate == 1) {
|
||||||
updateProfileBox($facebook, $flink, $notice);
|
updateProfileBox($facebook, $flink, $notice, $user);
|
||||||
}
|
}
|
||||||
|
|
||||||
} catch (FacebookRestClientException $e) {
|
} catch (FacebookRestClientException $e) {
|
||||||
|
return handleFacebookError($e, $notice, $flink);
|
||||||
$code = $e->getCode();
|
|
||||||
|
|
||||||
$msg = "FacebookPlugin - Facebook returned error code $code: " .
|
|
||||||
$e->getMessage() . ' - ' .
|
|
||||||
"Unable to update Facebook status (notice $notice->id) " .
|
|
||||||
"for $user->nickname (user id: $user->id)!";
|
|
||||||
|
|
||||||
common_log(LOG_WARNING, $msg);
|
|
||||||
|
|
||||||
if ($code == 100 || $code == 200 || $code == 250) {
|
|
||||||
|
|
||||||
// 100 The account is 'inactive' (probably - this is not well documented)
|
|
||||||
// 200 The application does not have permission to operate on the passed in uid parameter.
|
|
||||||
// 250 Updating status requires the extended permission status_update or publish_stream.
|
|
||||||
// see: http://wiki.developers.facebook.com/index.php/Users.setStatus#Example_Return_XML
|
|
||||||
|
|
||||||
remove_facebook_app($flink);
|
|
||||||
|
|
||||||
} else if ($code == 341) {
|
|
||||||
// 341 Feed action request limit reached - Unable to update Facebook status
|
|
||||||
// Reposting immediately probably won't work, so drop the message for now. :(
|
|
||||||
|
|
||||||
common_log(LOG_ERR, "Facebook rate limit hit: dropping notice $notice->id");
|
|
||||||
return true;
|
|
||||||
} else {
|
|
||||||
|
|
||||||
// Try sending again later.
|
|
||||||
//
|
|
||||||
// @fixme at the moment, returning false here could lead to an infinite loop
|
|
||||||
// if the error condition isn't actually transitory.
|
|
||||||
//
|
|
||||||
// Temporarily throwing an exception to kill the process so it'll hit our
|
|
||||||
// retry limits.
|
|
||||||
throw new Exception("Facebook error $code on notice $notice->id");
|
|
||||||
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return true;
|
return true;
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function updateProfileBox($facebook, $flink, $notice) {
|
function handleFacebookError($e, $notice, $flink)
|
||||||
$fbaction = new FacebookAction($output = 'php://output',
|
{
|
||||||
$indent = null, $facebook, $flink);
|
$fbuid = $flink->foreign_id;
|
||||||
|
$user = $flink->getUser();
|
||||||
|
$code = $e->getCode();
|
||||||
|
$errmsg = $e->getMessage();
|
||||||
|
|
||||||
|
// XXX: Check for any others?
|
||||||
|
switch($code) {
|
||||||
|
case 100: // Invalid parameter
|
||||||
|
$msg = "FacebookPlugin - Facebook claims notice %d was posted with an invalid parameter (error code 100):"
|
||||||
|
. "\"%s\" (Notice details: nickname=%s, user ID=%d, Facebook ID=%d, notice content=\"%s\"). "
|
||||||
|
. "Removing notice from the Facebook queue for safety.";
|
||||||
|
common_log(
|
||||||
|
LOG_ERROR, sprintf(
|
||||||
|
$msg,
|
||||||
|
$notice->id,
|
||||||
|
$errmsg,
|
||||||
|
$user->nickname,
|
||||||
|
$user->id,
|
||||||
|
$fbuid,
|
||||||
|
$notice->content
|
||||||
|
)
|
||||||
|
);
|
||||||
|
return true;
|
||||||
|
break;
|
||||||
|
case 200: // Permissions error
|
||||||
|
case 250: // Updating status requires the extended permission status_update
|
||||||
|
remove_facebook_app($flink);
|
||||||
|
return true; // dequeue
|
||||||
|
break;
|
||||||
|
case 341: // Feed action request limit reached
|
||||||
|
$msg = "FacebookPlugin - User %s (User ID=%d, Facebook ID=%d) has exceeded "
|
||||||
|
. "his/her limit for posting notices to Facebook today. Dequeuing "
|
||||||
|
. "notice %d.";
|
||||||
|
common_log(
|
||||||
|
LOG_INFO, sprintf(
|
||||||
|
$msg,
|
||||||
|
$user->nickname,
|
||||||
|
$user->id,
|
||||||
|
$fbuid,
|
||||||
|
$notice->id
|
||||||
|
)
|
||||||
|
);
|
||||||
|
// @fixme: We want to rety at a later time when the throttling has expired
|
||||||
|
// instead of just giving up.
|
||||||
|
return true;
|
||||||
|
break;
|
||||||
|
default:
|
||||||
|
$msg = "FacebookPlugin - Facebook returned an error we don't know how to deal with while trying to "
|
||||||
|
. "post notice %d. Error code: %d, error message: \"%s\". (Notice details: "
|
||||||
|
. "nickname=%s, user ID=%d, Facebook ID=%d, notice content=\"%s\"). Re-queueing "
|
||||||
|
. "notice, and will try to send again later.";
|
||||||
|
common_log(
|
||||||
|
LOG_ERROR, sprintf(
|
||||||
|
$msg,
|
||||||
|
$notice->id,
|
||||||
|
$code,
|
||||||
|
$errmsg,
|
||||||
|
$user->nickname,
|
||||||
|
$user->id,
|
||||||
|
$fbuid,
|
||||||
|
$notice->content
|
||||||
|
)
|
||||||
|
);
|
||||||
|
// Re-queue and try again later
|
||||||
|
return false;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function statusUpdate($notice, $user, $fbuid)
|
||||||
|
{
|
||||||
|
common_debug(
|
||||||
|
"FacebookPlugin - Attempting to post notice $notice->id "
|
||||||
|
. "as a status update for $user->nickname ($user->id), "
|
||||||
|
. "Facebook UID: $fbuid"
|
||||||
|
);
|
||||||
|
|
||||||
|
$text = formatNotice($notice, $user, $fbuid);
|
||||||
|
|
||||||
|
$facebook = getFacebook();
|
||||||
|
$result = $facebook->api_client->users_setStatus(
|
||||||
|
$text,
|
||||||
|
$fbuid,
|
||||||
|
false,
|
||||||
|
true
|
||||||
|
);
|
||||||
|
|
||||||
|
common_debug('Facebook returned: ' . var_export($result, true));
|
||||||
|
|
||||||
|
common_log(
|
||||||
|
LOG_INFO,
|
||||||
|
"FacebookPlugin - Posted notice $notice->id as a status "
|
||||||
|
. "update for $user->nickname ($user->id), "
|
||||||
|
. "Facebook UID: $fbuid"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function publishStream($notice, $user, $fbuid)
|
||||||
|
{
|
||||||
|
common_debug(
|
||||||
|
"FacebookPlugin - Attempting to post notice $notice->id "
|
||||||
|
. "as stream item with attachment for $user->nickname ($user->id), "
|
||||||
|
. "Facebook UID: $fbuid"
|
||||||
|
);
|
||||||
|
|
||||||
|
$text = formatNotice($notice, $user, $fbuid);
|
||||||
|
$fbattachment = format_attachments($notice->attachments());
|
||||||
|
|
||||||
|
$facebook = getFacebook();
|
||||||
|
$facebook->api_client->stream_publish(
|
||||||
|
$text,
|
||||||
|
$fbattachment,
|
||||||
|
null,
|
||||||
|
null,
|
||||||
|
$fbuid
|
||||||
|
);
|
||||||
|
|
||||||
|
common_debug('Facebook returned: ' . var_export($result, true));
|
||||||
|
|
||||||
|
common_log(
|
||||||
|
LOG_INFO,
|
||||||
|
"FacebookPlugin - Posted notice $notice->id as a stream "
|
||||||
|
. "item with attachment for $user->nickname ($user->id), "
|
||||||
|
. "Facebook UID: $fbuid"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
function formatNotice($notice, $user, $fbuid)
|
||||||
|
{
|
||||||
|
// Get the status 'verb' the user has set, if any
|
||||||
|
|
||||||
|
common_debug(
|
||||||
|
"FacebookPlugin - Looking to see if $user->nickname ($user->id), "
|
||||||
|
. "Facebook UID: $fbuid has set a verb for Facebook posting..."
|
||||||
|
);
|
||||||
|
|
||||||
|
$facebook = getFacebook();
|
||||||
|
$verb = trim(
|
||||||
|
$facebook->api_client->data_getUserPreference(
|
||||||
|
FACEBOOK_NOTICE_PREFIX,
|
||||||
|
$fbuid
|
||||||
|
)
|
||||||
|
);
|
||||||
|
|
||||||
|
common_debug("Facebook returned " . var_export($verb, true));
|
||||||
|
|
||||||
|
$text = null;
|
||||||
|
|
||||||
|
if (!empty($verb)) {
|
||||||
|
common_debug("FacebookPlugin - found a verb: $verb");
|
||||||
|
$text = trim($verb) . ' ' . $notice->content;
|
||||||
|
} else {
|
||||||
|
common_debug("FacebookPlugin - no verb found.");
|
||||||
|
$text = $notice->content;
|
||||||
|
}
|
||||||
|
|
||||||
|
return $text;
|
||||||
|
}
|
||||||
|
|
||||||
|
function updateProfileBox($facebook, $flink, $notice, $user) {
|
||||||
|
|
||||||
|
$facebook = getFacebook();
|
||||||
|
$fbaction = new FacebookAction(
|
||||||
|
$output = 'php://output',
|
||||||
|
$indent = null,
|
||||||
|
$facebook,
|
||||||
|
$flink
|
||||||
|
);
|
||||||
|
|
||||||
|
common_debug(
|
||||||
|
'FacebookPlugin - Attempting to update profile box with '
|
||||||
|
. "content from notice $notice->id for $user->nickname ($user->id)"
|
||||||
|
. "Facebook UID: $fbuid"
|
||||||
|
);
|
||||||
|
|
||||||
$fbaction->updateProfileBox($notice);
|
$fbaction->updateProfileBox($notice);
|
||||||
|
|
||||||
|
common_debug(
|
||||||
|
'FacebookPlugin - finished updating profile box for '
|
||||||
|
. "$user->nickname ($user->id) Facebook UID: $fbuid"
|
||||||
|
);
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function format_attachments($attachments)
|
function format_attachments($attachments)
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue
Block a user