plugins/Facebook/facebookutil.php

   1 <?php
   2 /*
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2008, 2009, StatusNet, Inc.
   5  *
   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.
  10  *
  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.
  15  *
  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/>.
  18  */
  19
  20 require_once INSTALLDIR . '/plugins/Facebook/facebook/facebook.php';
  21 require_once INSTALLDIR . '/plugins/Facebook/facebookaction.php';
  22 require_once INSTALLDIR . '/lib/noticelist.php';
  23
  24 define("FACEBOOK_SERVICE", 2); // Facebook is foreign_service ID 2
  25 define("FACEBOOK_NOTICE_PREFIX", 1);
  26 define("FACEBOOK_PROMPTED_UPDATE_PREF", 2);
  27
  28 function getFacebook()
  29 {
  30     static $facebook = null;
  31
  32     $apikey = common_config('facebook', 'apikey');
  33     $secret = common_config('facebook', 'secret');
  34
  35     if ($facebook === null) {
  36         $facebook = new Facebook($apikey, $secret);
  37     }
  38
  39     if (empty($facebook)) {
  40         common_log(LOG_ERR, 'Could not make new Facebook client obj!',
  41             __FILE__);
  42     }
  43
  44     return $facebook;
  45 }
  46
  47 function isFacebookBound($notice, $flink) {
  48
  49     if (empty($flink)) {
  50         return false;
  51     }
  52
  53     // Avoid a loop
  54
  55     if ($notice->source == 'Facebook') {
  56         common_log(LOG_INFO, "Skipping notice $notice->id because its " .
  57                    'source is Facebook.');
  58         return false;
  59     }
  60
  61     // If the user does not want to broadcast to Facebook, move along
  62
  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.');
  66         return false;
  67     }
  68
  69     // If it's not a reply, or if the user WANTS to send @-replies,
  70     // then, yeah, it can go to Facebook.
  71
  72     if (!preg_match('/@[a-zA-Z0-9_]{1,15}\b/u', $notice->content) ||
  73         ($flink->noticesync & FOREIGN_NOTICE_SEND_REPLY)) {
  74         return true;
  75     }
  76
  77     return false;
  78
  79 }
  80
  81 function facebookBroadcastNotice($notice)
  82 {
  83     $facebook = getFacebook();
  84     $flink = Foreign_link::getByUserID($notice->profile_id, FACEBOOK_SERVICE);
  85
  86     if (isFacebookBound($notice, $flink)) {
  87
  88         // Okay, we're good to go, update the FB status
  89
  90         $status = null;
  91         $fbuid = $flink->foreign_id;
  92         $user = $flink->getUser();
  93         $attachments  = $notice->attachments();
  94
  95         try {
  96
  97             // Get the status 'verb' (prefix) the user has set
  98
  99             // XXX: Does this call count against our per user FB request limit?
 100             // If so we should consider storing verb elsewhere or not storing
 101
 102             $prefix = trim($facebook->api_client->data_getUserPreference(FACEBOOK_NOTICE_PREFIX,
 103                                                                          $fbuid));
 104
 105             $status = "$prefix $notice->content";
 106
 107             $can_publish = $facebook->api_client->users_hasAppPermission('publish_stream',
 108                                                                          $fbuid);
 109
 110             $can_update  = $facebook->api_client->users_hasAppPermission('status_update',
 111                                                                          $fbuid);
 112             if (!empty($attachments) && $can_publish == 1) {
 113                 $fbattachment = format_attachments($attachments);
 114                 $facebook->api_client->stream_publish($status, $fbattachment,
 115                                                       null, null, $fbuid);
 116                 common_log(LOG_INFO,
 117                            "Posted notice $notice->id w/attachment " .
 118                            "to Facebook user's stream (fbuid = $fbuid).");
 119             } elseif ($can_update == 1 || $can_publish == 1) {
 120                 $facebook->api_client->users_setStatus($status, $fbuid, false, true);
 121                 common_log(LOG_INFO,
 122                            "Posted notice $notice->id to Facebook " .
 123                            "as a status update (fbuid = $fbuid).");
 124             } else {
 125                 $msg = "Not sending notice $notice->id to Facebook " .
 126                   "because user $user->nickname hasn't given the " .
 127                   'Facebook app \'status_update\' or \'publish_stream\' permission.';
 128                 common_log(LOG_WARNING, $msg);
 129             }
 130
 131             // Finally, attempt to update the user's profile box
 132
 133             if ($can_publish == 1 || $can_update == 1) {
 134                 updateProfileBox($facebook, $flink, $notice);
 135             }
 136
 137         } catch (FacebookRestClientException $e) {
 138
 139             $code = $e->getCode();
 140
 141             $msg = "Facebook returned error code $code: " .
 142               $e->getMessage() . ' - ' .
 143               "Unable to update Facebook status (notice $notice->id) " .
 144               "for $user->nickname (user id: $user->id)!";
 145
 146             common_log(LOG_WARNING, $msg);
 147
 148             if ($code == 100 || $code == 200 || $code == 250) {
 149
 150                 // 100 The account is 'inactive' (probably - this is not well documented)
 151                 // 200 The application does not have permission to operate on the passed in uid parameter.
 152                 // 250 Updating status requires the extended permission status_update or publish_stream.
 153                 // see: http://wiki.developers.facebook.com/index.php/Users.setStatus#Example_Return_XML
 154
 155                 remove_facebook_app($flink);
 156
 157         } else {
 158
 159                 // Try sending again later.
 160
 161                 return false;
 162             }
 163
 164         }
 165     }
 166
 167     return true;
 168
 169 }
 170
 171 function updateProfileBox($facebook, $flink, $notice) {
 172     $fbaction = new FacebookAction($output = 'php://output',
 173                                    $indent = null, $facebook, $flink);
 174     $fbaction->updateProfileBox($notice);
 175 }
 176
 177 function format_attachments($attachments)
 178 {
 179     $fbattachment          = array();
 180     $fbattachment['media'] = array();
 181
 182     foreach($attachments as $attachment)
 183     {
 184         if($enclosure = $attachment->getEnclosure()){
 185             $fbmedia = get_fbmedia_for_attachment($enclosure);
 186         }else{
 187             $fbmedia = get_fbmedia_for_attachment($attachment);
 188         }
 189         if($fbmedia){
 190             $fbattachment['media'][]=$fbmedia;
 191         }else{
 192             $fbattachment['name'] = ($attachment->title ?
 193                                   $attachment->title : $attachment->url);
 194             $fbattachment['href'] = $attachment->url;
 195         }
 196     }
 197     if(count($fbattachment['media'])>0){
 198         unset($fbattachment['name']);
 199         unset($fbattachment['href']);
 200     }
 201     return $fbattachment;
 202 }
 203
 204 /**
 205 * given an File objects, returns an associative array suitable for Facebook media
 206 */
 207 function get_fbmedia_for_attachment($attachment)
 208 {
 209     $fbmedia    = array();
 210
 211     if (strncmp($attachment->mimetype, 'image/', strlen('image/')) == 0) {
 212         $fbmedia['type']         = 'image';
 213         $fbmedia['src']          = $attachment->url;
 214         $fbmedia['href']         = $attachment->url;
 215     } else if ($attachment->mimetype == 'audio/mpeg') {
 216         $fbmedia['type']         = 'mp3';
 217         $fbmedia['src']          = $attachment->url;
 218     }else if ($attachment->mimetype == 'application/x-shockwave-flash') {
 219         $fbmedia['type']         = 'flash';
 220
 221         // http://wiki.developers.facebook.com/index.php/Attachment_%28Streams%29
 222         // says that imgsrc is required... but we have no value to put in it
 223         // $fbmedia['imgsrc']='';
 224
 225         $fbmedia['swfsrc']       = $attachment->url;
 226     }else{
 227         return false;
 228     }
 229     return $fbmedia;
 230 }
 231
 232 function remove_facebook_app($flink)
 233 {
 234
 235     $user = $flink->getUser();
 236
 237     common_log(LOG_INFO, 'Removing Facebook App Foreign link for ' .
 238         "user $user->nickname (user id: $user->id).");
 239
 240     $result = $flink->delete();
 241
 242     if (empty($result)) {
 243         common_log(LOG_ERR, 'Could not remove Facebook App ' .
 244             "Foreign_link for $user->nickname (user id: $user->id)!");
 245         common_log_db_error($flink, 'DELETE', __FILE__);
 246     }
 247
 248     // Notify the user that we are removing their FB app access
 249
 250     $result = mail_facebook_app_removed($user);
 251
 252     if (!$result) {
 253
 254         $msg = 'Unable to send email to notify ' .
 255             "$user->nickname (user id: $user->id) " .
 256             'that their Facebook app link was ' .
 257             'removed!';
 258
 259         common_log(LOG_WARNING, $msg);
 260     }
 261
 262 }
 263
 264 /**
 265  * Send a mail message to notify a user that her Facebook Application
 266  * access has been removed.
 267  *
 268  * @param User $user   user whose Facebook app link has been removed
 269  *
 270  * @return boolean success flag
 271  */
 272
 273 function mail_facebook_app_removed($user)
 274 {
 275     $profile = $user->getProfile();
 276
 277     $site_name = common_config('site', 'name');
 278
 279     common_switch_locale($user->language);
 280
 281     $subject = sprintf(
 282         _m('Your %1$s Facebook application access has been disabled.',
 283             $site_name));
 284
 285     $body = sprintf(_m("Hi, %1\$s. We're sorry to inform you that we are " .
 286         'unable to update your Facebook status from %2$s, and have disabled ' .
 287         'the Facebook application for your account. This may be because ' .
 288         'you have removed the Facebook application\'s authorization, or ' .
 289         'have deleted your Facebook account.  You can re-enable the ' .
 290         'Facebook application and automatic status updating by ' .
 291         "re-installing the %2\$s Facebook application.\n\nRegards,\n\n%2\$s"),
 292         $user->nickname, $site_name);
 293
 294     common_switch_locale();
 295     return mail_to_user($user, $subject, $body);
 296
 297 }