]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - plugins/Facebook/facebookutil.php
Merge commit 'mainline/0.9.x' into 0.9.x
[quix0rs-gnu-social.git] / 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             common_debug("FacebookPlugin - checking for publish_stream permission for user $user->id");
108
109             $can_publish = $facebook->api_client->users_hasAppPermission('publish_stream',
110                                                                          $fbuid);
111
112             common_debug("FacebookPlugin - checking for status_update permission for user $user->id");
113
114             $can_update  = $facebook->api_client->users_hasAppPermission('status_update',
115                                                                          $fbuid);
116             if (!empty($attachments) && $can_publish == 1) {
117                 $fbattachment = format_attachments($attachments);
118                 $facebook->api_client->stream_publish($status, $fbattachment,
119                                                       null, null, $fbuid);
120                 common_log(LOG_INFO,
121                            "FacebookPlugin - Posted notice $notice->id w/attachment " .
122                            "to Facebook user's stream (fbuid = $fbuid).");
123             } elseif ($can_update == 1 || $can_publish == 1) {
124                 $facebook->api_client->users_setStatus($status, $fbuid, false, true);
125                 common_log(LOG_INFO,
126                            "FacebookPlugin - Posted notice $notice->id to Facebook " .
127                            "as a status update (fbuid = $fbuid).");
128             } else {
129                 $msg = "FacebookPlugin - Not sending notice $notice->id to Facebook " .
130                   "because user $user->nickname hasn't given the " .
131                   'Facebook app \'status_update\' or \'publish_stream\' permission.';
132                 common_log(LOG_WARNING, $msg);
133             }
134
135             // Finally, attempt to update the user's profile box
136
137             if ($can_publish == 1 || $can_update == 1) {
138                 updateProfileBox($facebook, $flink, $notice);
139             }
140
141         } catch (FacebookRestClientException $e) {
142
143             $code = $e->getCode();
144
145             $msg = "FacebookPlugin - Facebook returned error code $code: " .
146               $e->getMessage() . ' - ' .
147               "Unable to update Facebook status (notice $notice->id) " .
148               "for $user->nickname (user id: $user->id)!";
149
150             common_log(LOG_WARNING, $msg);
151
152             if ($code == 100 || $code == 200 || $code == 250) {
153
154                 // 100 The account is 'inactive' (probably - this is not well documented)
155                 // 200 The application does not have permission to operate on the passed in uid parameter.
156                 // 250 Updating status requires the extended permission status_update or publish_stream.
157                 // see: http://wiki.developers.facebook.com/index.php/Users.setStatus#Example_Return_XML
158
159                 remove_facebook_app($flink);
160
161         } else {
162
163                 // Try sending again later.
164
165                 return false;
166             }
167
168         }
169     }
170
171     return true;
172
173 }
174
175 function updateProfileBox($facebook, $flink, $notice) {
176     $fbaction = new FacebookAction($output = 'php://output',
177                                    $indent = null, $facebook, $flink);
178     $fbaction->updateProfileBox($notice);
179 }
180
181 function format_attachments($attachments)
182 {
183     $fbattachment          = array();
184     $fbattachment['media'] = array();
185
186     foreach($attachments as $attachment)
187     {
188         if($enclosure = $attachment->getEnclosure()){
189             $fbmedia = get_fbmedia_for_attachment($enclosure);
190         }else{
191             $fbmedia = get_fbmedia_for_attachment($attachment);
192         }
193         if($fbmedia){
194             $fbattachment['media'][]=$fbmedia;
195         }else{
196             $fbattachment['name'] = ($attachment->title ?
197                                   $attachment->title : $attachment->url);
198             $fbattachment['href'] = $attachment->url;
199         }
200     }
201     if(count($fbattachment['media'])>0){
202         unset($fbattachment['name']);
203         unset($fbattachment['href']);
204     }
205     return $fbattachment;
206 }
207
208 /**
209 * given an File objects, returns an associative array suitable for Facebook media
210 */
211 function get_fbmedia_for_attachment($attachment)
212 {
213     $fbmedia    = array();
214
215     if (strncmp($attachment->mimetype, 'image/', strlen('image/')) == 0) {
216         $fbmedia['type']         = 'image';
217         $fbmedia['src']          = $attachment->url;
218         $fbmedia['href']         = $attachment->url;
219     } else if ($attachment->mimetype == 'audio/mpeg') {
220         $fbmedia['type']         = 'mp3';
221         $fbmedia['src']          = $attachment->url;
222     }else if ($attachment->mimetype == 'application/x-shockwave-flash') {
223         $fbmedia['type']         = 'flash';
224
225         // http://wiki.developers.facebook.com/index.php/Attachment_%28Streams%29
226         // says that imgsrc is required... but we have no value to put in it
227         // $fbmedia['imgsrc']='';
228
229         $fbmedia['swfsrc']       = $attachment->url;
230     }else{
231         return false;
232     }
233     return $fbmedia;
234 }
235
236 function remove_facebook_app($flink)
237 {
238
239     $user = $flink->getUser();
240
241     common_log(LOG_INFO, 'Removing Facebook App Foreign link for ' .
242         "user $user->nickname (user id: $user->id).");
243
244     $result = $flink->delete();
245
246     if (empty($result)) {
247         common_log(LOG_ERR, 'Could not remove Facebook App ' .
248             "Foreign_link for $user->nickname (user id: $user->id)!");
249         common_log_db_error($flink, 'DELETE', __FILE__);
250     }
251
252     // Notify the user that we are removing their FB app access
253
254     $result = mail_facebook_app_removed($user);
255
256     if (!$result) {
257
258         $msg = 'Unable to send email to notify ' .
259             "$user->nickname (user id: $user->id) " .
260             'that their Facebook app link was ' .
261             'removed!';
262
263         common_log(LOG_WARNING, $msg);
264     }
265
266 }
267
268 /**
269  * Send a mail message to notify a user that her Facebook Application
270  * access has been removed.
271  *
272  * @param User $user   user whose Facebook app link has been removed
273  *
274  * @return boolean success flag
275  */
276
277 function mail_facebook_app_removed($user)
278 {
279     $profile = $user->getProfile();
280
281     $site_name = common_config('site', 'name');
282
283     common_switch_locale($user->language);
284
285     $subject = sprintf(
286         _m('Your %1$s Facebook application access has been disabled.',
287             $site_name));
288
289     $body = sprintf(_m("Hi, %1\$s. We're sorry to inform you that we are " .
290         'unable to update your Facebook status from %2$s, and have disabled ' .
291         'the Facebook application for your account. This may be because ' .
292         'you have removed the Facebook application\'s authorization, or ' .
293         'have deleted your Facebook account.  You can re-enable the ' .
294         'Facebook application and automatic status updating by ' .
295         "re-installing the %2\$s Facebook application.\n\nRegards,\n\n%2\$s"),
296         $user->nickname, $site_name);
297
298     common_switch_locale();
299     return mail_to_user($user, $subject, $body);
300
301 }