3 * Name: StatusNet Connector
5 * Author: Tobias Diekershoff <https://diekershoff.homeunix.net/friendika/profile/tobias>
8 /* StatusNet Plugin for Friendika
10 * Author: Tobias Diekershoff
11 * tobias.diekershoff@gmx.net
13 * License:3-clause BSD license
16 * To activate the plugin itself add it to the $a->config['system']['addon']
17 * setting. After this, your user can configure their Twitter account settings
18 * from "Settings -> Plugin Settings".
20 * Requirements: PHP5, curl [Slinky library]
22 * Documentation: http://diekershoff.homeunix.net/redmine/wiki/friendikaplugin/StatusNet_Plugin
27 * - what about multimedia content?
28 * so far we just strip HTML tags from the message
33 * We have to alter the TwitterOAuth class a little bit to work with any StatusNet
34 * installation abroad. Basically it's only make the API path variable and be happy.
36 * Thank you guys for the Twitter compatible API!
39 require_once('library/twitteroauth.php');
41 class StatusNetOAuth extends TwitterOAuth {
42 function get_maxlength() {
43 $config = $this->get($this->host . 'statusnet/config.json');
44 return $config->site->textlimit;
46 function accessTokenURL() { return $this->host.'oauth/access_token'; }
47 function authenticateURL() { return $this->host.'oauth/authenticate'; }
48 function authorizeURL() { return $this->host.'oauth/authorize'; }
49 function requestTokenURL() { return $this->host.'oauth/request_token'; }
50 function __construct($apipath, $consumer_key, $consumer_secret, $oauth_token = NULL, $oauth_token_secret = NULL) {
51 parent::__construct($consumer_key, $consumer_secret, $oauth_token, $oauth_token_secret);
52 $this->host = $apipath;
55 * Make an HTTP request
59 * Copied here from the twitteroauth library and complemented by applying the proxy settings of friendika
61 function http($url, $method, $postfields = NULL) {
62 $this->http_info = array();
65 $prx = get_config('system','proxy');
66 logger('Proxy SN: '.$prx);
68 curl_setopt($ci, CURLOPT_HTTPPROXYTUNNEL, 1);
69 curl_setopt($ci, CURLOPT_PROXY, $prx);
70 $prxusr = get_config('system','proxyuser');
72 curl_setopt($ci, CURLOPT_PROXYUSERPWD, $prxusr);
74 curl_setopt($ci, CURLOPT_USERAGENT, $this->useragent);
75 curl_setopt($ci, CURLOPT_CONNECTTIMEOUT, $this->connecttimeout);
76 curl_setopt($ci, CURLOPT_TIMEOUT, $this->timeout);
77 curl_setopt($ci, CURLOPT_RETURNTRANSFER, TRUE);
78 curl_setopt($ci, CURLOPT_HTTPHEADER, array('Expect:'));
79 curl_setopt($ci, CURLOPT_SSL_VERIFYPEER, $this->ssl_verifypeer);
80 curl_setopt($ci, CURLOPT_HEADERFUNCTION, array($this, 'getHeader'));
81 curl_setopt($ci, CURLOPT_HEADER, FALSE);
85 curl_setopt($ci, CURLOPT_POST, TRUE);
86 if (!empty($postfields)) {
87 curl_setopt($ci, CURLOPT_POSTFIELDS, $postfields);
91 curl_setopt($ci, CURLOPT_CUSTOMREQUEST, 'DELETE');
92 if (!empty($postfields)) {
93 $url = "{$url}?{$postfields}";
97 curl_setopt($ci, CURLOPT_URL, $url);
98 $response = curl_exec($ci);
99 $this->http_code = curl_getinfo($ci, CURLINFO_HTTP_CODE);
100 $this->http_info = array_merge($this->http_info, curl_getinfo($ci));
107 function statusnet_install() {
108 // we need some hooks, for the configuration and for sending tweets
109 register_hook('connector_settings', 'addon/statusnet/statusnet.php', 'statusnet_settings');
110 register_hook('connector_settings_post', 'addon/statusnet/statusnet.php', 'statusnet_settings_post');
111 register_hook('post_local_end', 'addon/statusnet/statusnet.php', 'statusnet_post_hook');
112 register_hook('jot_networks', 'addon/statusnet/statusnet.php', 'statusnet_jot_nets');
113 logger("installed statusnet");
117 function statusnet_uninstall() {
118 unregister_hook('connector_settings', 'addon/statusnet/statusnet.php', 'statusnet_settings');
119 unregister_hook('connector_settings_post', 'addon/statusnet/statusnet.php', 'statusnet_settings_post');
120 unregister_hook('plugin_settings', 'addon/statusnet/statusnet.php', 'statusnet_settings');
121 unregister_hook('plugin_settings_post', 'addon/statusnet/statusnet.php', 'statusnet_settings_post');
122 unregister_hook('post_local_end', 'addon/statusnet/statusnet.php', 'statusnet_post_hook');
123 unregister_hook('jot_networks', 'addon/statusnet/statusnet.php', 'statusnet_jot_nets');
126 function statusnet_jot_nets(&$a,&$b) {
130 $statusnet_post = get_pconfig(local_user(),'statusnet','post');
131 if(intval($statusnet_post) == 1) {
132 $statusnet_defpost = get_pconfig(local_user(),'statusnet','post_by_default');
133 $selected = ((intval($statusnet_defpost) == 1) ? ' checked="checked" ' : '');
134 $b .= '<div class="profile-jot-net"><input type="checkbox" name="statusnet_enable"' . $selected . ' value="1" /> '
135 . t('Post to StatusNet') . '</div>';
142 function statusnet_settings_post ($a,$post) {
145 // don't check statusnet settings if statusnet submit button is not clicked
146 if (!x($_POST,'statusnet-submit')) return;
148 if (isset($_POST['statusnet-disconnect'])) {
150 * if the statusnet-disconnect checkbox is set, clear the statusnet configuration
151 * TODO can we revoke the access tokens at Twitter and do we need to do so?
153 del_pconfig( local_user(), 'statusnet', 'consumerkey' );
154 del_pconfig( local_user(), 'statusnet', 'consumersecret' );
155 del_pconfig( local_user(), 'statusnet', 'post' );
156 del_pconfig( local_user(), 'statusnet', 'post_by_default' );
157 del_pconfig( local_user(), 'statusnet', 'oauthtoken' );
158 del_pconfig( local_user(), 'statusnet', 'oauthsecret' );
159 del_pconfig( local_user(), 'statusnet', 'baseapi' );
161 if (isset($_POST['statusnet-preconf-apiurl'])) {
163 * If the user used one of the preconfigured StatusNet server credentials
164 * use them. All the data are available in the global config.
165 * Check the API Url never the less and blame the admin if it's not working ^^
167 $globalsn = get_config('statusnet', 'sites');
168 foreach ( $globalsn as $asn) {
169 if ($asn['apiurl'] == $_POST['statusnet-preconf-apiurl'] ) {
170 $apibase = $asn['apiurl'];
171 $c = fetch_url( $apibase . 'statusnet/version.xml' );
172 if (strlen($c) > 0) {
173 set_pconfig(local_user(), 'statusnet', 'consumerkey', $asn['consumerkey'] );
174 set_pconfig(local_user(), 'statusnet', 'consumersecret', $asn['consumersecret'] );
175 set_pconfig(local_user(), 'statusnet', 'baseapi', $asn['apiurl'] );
177 notice( t('Please contact your site administrator.<br />The provided API URL is not valid.').EOL.$asn['apiurl'].EOL );
181 goaway($a->get_baseurl().'/settings/connectors');
183 if (isset($_POST['statusnet-consumersecret'])) {
184 // check if we can reach the API of the StatusNet server
185 // we'll check the API Version for that, if we don't get one we'll try to fix the path but will
186 // resign quickly after this one try to fix the path ;-)
187 $apibase = $_POST['statusnet-baseapi'];
188 $c = fetch_url( $apibase . 'statusnet/version.xml' );
189 if (strlen($c) > 0) {
190 // ok the API path is correct, let's save the settings
191 set_pconfig(local_user(), 'statusnet', 'consumerkey', $_POST['statusnet-consumerkey']);
192 set_pconfig(local_user(), 'statusnet', 'consumersecret', $_POST['statusnet-consumersecret']);
193 set_pconfig(local_user(), 'statusnet', 'baseapi', $apibase );
195 // the API path is not correct, maybe missing trailing / ?
196 $apibase = $apibase . '/';
197 $c = fetch_url( $apibase . 'statusnet/version.xml' );
198 if (strlen($c) > 0) {
199 // ok the API path is now correct, let's save the settings
200 set_pconfig(local_user(), 'statusnet', 'consumerkey', $_POST['statusnet-consumerkey']);
201 set_pconfig(local_user(), 'statusnet', 'consumersecret', $_POST['statusnet-consumersecret']);
202 set_pconfig(local_user(), 'statusnet', 'baseapi', $apibase );
204 // still not the correct API base, let's do noting
205 notice( t('We could not contact the StatusNet API with the Path you entered.').EOL );
208 goaway($a->get_baseurl().'/settings/connectors');
210 if (isset($_POST['statusnet-pin'])) {
211 // if the user supplied us with a PIN from Twitter, let the magic of OAuth happen
212 logger('got a StatusNet security code');
213 $api = get_pconfig(local_user(), 'statusnet', 'baseapi');
214 $ckey = get_pconfig(local_user(), 'statusnet', 'consumerkey' );
215 $csecret = get_pconfig(local_user(), 'statusnet', 'consumersecret' );
216 // the token and secret for which the PIN was generated were hidden in the settings
217 // form as token and token2, we need a new connection to Twitter using these token
218 // and secret to request a Access Token with the PIN
219 $connection = new StatusNetOAuth($api, $ckey, $csecret, $_POST['statusnet-token'], $_POST['statusnet-token2']);
220 $token = $connection->getAccessToken( $_POST['statusnet-pin'] );
221 // ok, now that we have the Access Token, save them in the user config
222 set_pconfig(local_user(),'statusnet', 'oauthtoken', $token['oauth_token']);
223 set_pconfig(local_user(),'statusnet', 'oauthsecret', $token['oauth_token_secret']);
224 set_pconfig(local_user(),'statusnet', 'post', 1);
225 // reload the Addon Settings page, if we don't do it see Bug #42
226 goaway($a->get_baseurl().'/settings/connectors');
228 // if no PIN is supplied in the POST variables, the user has changed the setting
229 // to post a tweet for every new __public__ posting to the wall
230 set_pconfig(local_user(),'statusnet','post',intval($_POST['statusnet-enable']));
231 set_pconfig(local_user(),'statusnet','post_by_default',intval($_POST['statusnet-default']));
232 info( t('StatusNet settings updated.') . EOL);
235 function statusnet_settings(&$a,&$s) {
238 $a->page['htmlhead'] .= '<link rel="stylesheet" type="text/css" href="' . $a->get_baseurl() . '/addon/statusnet/statusnet.css' . '" media="all" />' . "\r\n";
240 * 1) Check that we have a base api url and a consumer key & secret
241 * 2) If no OAuthtoken & stuff is present, generate button to get some
242 * allow the user to cancel the connection process at this step
243 * 3) Checkbox for "Send public notices (respect size limitation)
245 $api = get_pconfig(local_user(), 'statusnet', 'baseapi');
246 $ckey = get_pconfig(local_user(), 'statusnet', 'consumerkey' );
247 $csecret = get_pconfig(local_user(), 'statusnet', 'consumersecret' );
248 $otoken = get_pconfig(local_user(), 'statusnet', 'oauthtoken' );
249 $osecret = get_pconfig(local_user(), 'statusnet', 'oauthsecret' );
250 $enabled = get_pconfig(local_user(), 'statusnet', 'post');
251 $checked = (($enabled) ? ' checked="checked" ' : '');
252 $defenabled = get_pconfig(local_user(),'statusnet','post_by_default');
253 $defchecked = (($defenabled) ? ' checked="checked" ' : '');
254 $s .= '<div class="settings-block">';
255 $s .= '<h3>'. t('StatusNet Posting Settings').'</h3>';
257 if ( (!$ckey) && (!$csecret) ) {
261 $globalsn = get_config('statusnet', 'sites');
263 * lets check if we have one or more globally configured StatusNet
264 * server OAuth credentials in the configuration. If so offer them
265 * with a little explanation to the user as choice - otherwise
266 * ignore this option entirely.
268 if (! $globalsn == null) {
269 $s .= '<h4>' . t('Globally Available StatusNet OAuthKeys') . '</h4>';
270 $s .= '<p>'. t("There are preconfigured OAuth key pairs for some StatusNet servers available. If you are useing one of them, please use these credentials. If not feel free to connect to any other StatusNet instance \x28see below\x29.") .'</p>';
271 $s .= '<div id="statusnet-preconf-wrapper">';
272 foreach ($globalsn as $asn) {
273 $s .= '<input type="radio" name="statusnet-preconf-apiurl" value="'. $asn['apiurl'] .'">'. $asn['sitename'] .'<br />';
275 $s .= '<p></p><div class="clear"></div></div>';
276 $s .= '<div class="settings-submit-wrapper" ><input type="submit" name="statusnet-submit" class="settings-submit" value="' . t('Submit') . '" /></div>';
278 $s .= '<h4>' . t('Provide your own OAuth Credentials') . '</h4>';
279 $s .= '<p>'. t('No consumer key pair for StatusNet found. Register your Friendika Account as an desktop client on your StatusNet account, copy the consumer key pair here and enter the API base root.<br />Before you register your own OAuth key pair ask the administrator if there is already a key pair for this Friendika installation at your favorited StatusNet installation.') .'</p>';
280 $s .= '<div id="statusnet-consumer-wrapper">';
281 $s .= '<label id="statusnet-consumerkey-label" for="statusnet-consumerkey">'. t('OAuth Consumer Key') .'</label>';
282 $s .= '<input id="statusnet-consumerkey" type="text" name="statusnet-consumerkey" size="35" /><br />';
283 $s .= '<div class="clear"></div>';
284 $s .= '<label id="statusnet-consumersecret-label" for="statusnet-consumersecret">'. t('OAuth Consumer Secret') .'</label>';
285 $s .= '<input id="statusnet-consumersecret" type="text" name="statusnet-consumersecret" size="35" /><br />';
286 $s .= '<div class="clear"></div>';
287 $s .= '<label id="statusnet-baseapi-label" for="statusnet-baseapi">'. t("Base API Path \x28remember the trailing /\x29") .'</label>';
288 $s .= '<input id="statusnet-baseapi" type="text" name="statusnet-baseapi" size="35" /><br />';
289 $s .= '<p></p><div class="clear"></div></div>';
290 $s .= '<div class="settings-submit-wrapper" ><input type="submit" name="statusnet-submit" class="settings-submit" value="' . t('Submit') . '" /></div>';
293 * ok we have a consumer key pair now look into the OAuth stuff
295 if ( (!$otoken) && (!$osecret) ) {
297 * the user has not yet connected the account to statusnet
298 * get a temporary OAuth key/secret pair and display a button with
299 * which the user can request a PIN to connect the account to a
300 * account at statusnet
302 $connection = new StatusNetOAuth($api, $ckey, $csecret);
303 $request_token = $connection->getRequestToken('oob');
304 $token = $request_token['oauth_token'];
306 * make some nice form
308 $s .= '<p>'. t('To connect to your StatusNet account click the button below to get a security code from StatusNet which you have to copy into the input box below and submit the form. Only your <strong>public</strong> posts will be posted to StatusNet.') .'</p>';
309 $s .= '<a href="'.$connection->getAuthorizeURL($token,False).'" target="_statusnet"><img src="addon/statusnet/signinwithstatusnet.png" alt="'. t('Log in with StatusNet') .'"></a>';
310 $s .= '<div id="statusnet-pin-wrapper">';
311 $s .= '<label id="statusnet-pin-label" for="statusnet-pin">'. t('Copy the security code from StatusNet here') .'</label>';
312 $s .= '<input id="statusnet-pin" type="text" name="statusnet-pin" />';
313 $s .= '<input id="statusnet-token" type="hidden" name="statusnet-token" value="'.$token.'" />';
314 $s .= '<input id="statusnet-token2" type="hidden" name="statusnet-token2" value="'.$request_token['oauth_token_secret'].'" />';
315 $s .= '</div><div class="clear"></div>';
316 $s .= '<div class="settings-submit-wrapper" ><input type="submit" name="statusnet-submit" class="settings-submit" value="' . t('Submit') . '" /></div>';
317 $s .= '<h4>'.t('Cancel Connection Process').'</h4>';
318 $s .= '<div id="statusnet-cancel-wrapper">';
319 $s .= '<p>'.t('Current StatusNet API is').': '.$api.'</p>';
320 $s .= '<label id="statusnet-cancel-label" for="statusnet-cancel">'. t('Cancel StatusNet Connection') . '</label>';
321 $s .= '<input id="statusnet-cancel" type="checkbox" name="statusnet-disconnect" value="1" />';
322 $s .= '</div><div class="clear"></div>';
323 $s .= '<div class="settings-submit-wrapper" ><input type="submit" name="statusnet-submit" class="settings-submit" value="' . t('Submit') . '" /></div>';
326 * we have an OAuth key / secret pair for the user
327 * so let's give a chance to disable the postings to statusnet
329 $connection = new StatusNetOAuth($api,$ckey,$csecret,$otoken,$osecret);
330 $details = $connection->get('account/verify_credentials');
331 $s .= '<div id="statusnet-info" ><img id="statusnet-avatar" src="'.$details->profile_image_url.'" /><p id="statusnet-info-block">'. t('Currently connected to: ') .'<a href="'.$details->statusnet_profile_url.'" target="_statusnet">'.$details->screen_name.'</a><br /><em>'.$details->description.'</em></p></div>';
332 $s .= '<p>'. t('If enabled all your <strong>public</strong> postings can be posted to the associated StatusNet account. You can choose to do so by default (here) or for every posting separately in the posting options when writing the entry.') .'</p>';
333 $s .= '<div id="statusnet-enable-wrapper">';
334 $s .= '<label id="statusnet-enable-label" for="statusnet-checkbox">'. t('Allow posting to StatusNet') .'</label>';
335 $s .= '<input id="statusnet-checkbox" type="checkbox" name="statusnet-enable" value="1" ' . $checked . '/>';
336 $s .= '<div class="clear"></div>';
337 $s .= '<label id="statusnet-default-label" for="statusnet-default">'. t('Send public postings to StatusNet by default') .'</label>';
338 $s .= '<input id="statusnet-default" type="checkbox" name="statusnet-default" value="1" ' . $defchecked . '/>';
339 $s .= '</div><div class="clear"></div>';
341 $s .= '<div id="statusnet-disconnect-wrapper">';
342 $s .= '<label id="statusnet-disconnect-label" for="statusnet-disconnect">'. t('Clear OAuth configuration') .'</label>';
343 $s .= '<input id="statusnet-disconnect" type="checkbox" name="statusnet-disconnect" value="1" />';
344 $s .= '</div><div class="clear"></div>';
345 $s .= '<div class="settings-submit-wrapper" ><input type="submit" name="statusnet-submit" class="settings-submit" value="' . t('Submit') . '" /></div>';
348 $s .= '</div><div class="clear"></div></div>';
352 function statusnet_post_hook(&$a,&$b) {
358 logger('StatusNet post invoked');
360 if((local_user()) && (local_user() == $b['uid']) && (! $b['private'])) {
362 // mike 2-9-11 there was a restriction to only allow this for top level posts
363 // now relaxed so should allow one's own comments to be forwarded through the connector as well.
365 // Status.Net is not considered a private network
369 load_pconfig(local_user(), 'statusnet');
371 $api = get_pconfig(local_user(), 'statusnet', 'baseapi');
372 $ckey = get_pconfig(local_user(), 'statusnet', 'consumerkey' );
373 $csecret = get_pconfig(local_user(), 'statusnet', 'consumersecret' );
374 $otoken = get_pconfig(local_user(), 'statusnet', 'oauthtoken' );
375 $osecret = get_pconfig(local_user(), 'statusnet', 'oauthsecret' );
377 if($ckey && $csecret && $otoken && $osecret) {
379 $statusnet_post = get_pconfig(local_user(),'statusnet','post');
380 $statusnet_enable = (($statusnet_post && x($_POST,'statusnet_enable')) ? intval($_POST['statusnet_enable']) : 0);
381 // if API is used, default to the chosen settings
382 if($_POST['api_source'] && intval(get_pconfig(local_user(),'statusnet','post_by_default')))
383 $statusnet_enable = 1;
385 if($statusnet_enable && $statusnet_post) {
386 require_once('include/bbcode.php');
387 $dent = new StatusNetOAuth($api,$ckey,$csecret,$otoken,$osecret);
388 $max_char = $dent->get_maxlength(); // max. length for a dent
389 $msg = strip_tags(bbcode($b['body']));
390 // quotes not working - let's try this
391 $msg = html_entity_decode($msg);
392 if ( strlen($msg) > $max_char) {
394 require_once('library/slinky.php');
395 // post url = base url + /display/ + owner + post id
396 // we construct this from the Owner link and replace
397 // profile by display - this will cause an error when
398 // /profile/ is in the owner url twice but I don't
399 // think this will be very common...
400 $posturl = str_replace('/profile/','/display/',$b['owner-link']).'/'.$b['id'];
401 $slinky = new Slinky( $posturl );
402 // setup a cascade of shortening services
403 // try to get a short link from these services
404 // in the order ur1.ca, trim, id.gd, tinyurl
405 $slinky->set_cascade( array( new Slinky_UR1ca(), new Slinky_Trim(), new Slinky_IsGd(), new Slinky_TinyURL() ) );
406 $shortlink = $slinky->short();
407 // the new message will be shortened such that "... $shortlink"
408 // will fit into the character limit
409 $msg = substr($msg, 0, $max_char-strlen($shortlink)-4);
410 $msg .= '... ' . $shortlink;
412 // and now tweet it :-)
414 $dent->post('statuses/update', array('status' => $msg));
420 function statusnet_plugin_admin_post(&$a){
424 foreach($_POST['sitename'] as $id=>$sitename){
425 $sitename=trim($sitename);
426 $apiurl=trim($_POST['apiurl'][$id]);
427 $secret=trim($_POST['secret'][$id]);
428 $key=trim($_POST['key'][$id]);
433 !x($_POST['delete'][$id])){
436 'sitename' => $sitename,
438 'consumersecret' => $secret,
439 'consumerkey' => $key
444 $sites = set_config('statusnet','sites', $sites);
448 function statusnet_plugin_admin(&$a, &$o){
450 $sites = get_config('statusnet','sites');
452 if (is_array($sites)){
453 foreach($sites as $id=>$s){
454 $sitesform[] = Array(
455 'sitename' => Array("sitename[$id]", "Site name", $s['sitename'], ""),
456 'apiurl' => Array("apiurl[$id]", "Api url", $s['apiurl'], ""),
457 'secret' => Array("secret[$id]", "Secret", $s['consumersecret'], ""),
458 'key' => Array("key[$id]", "Key", $s['consumerkey'], ""),
459 'delete' => Array("delete[$id]", "Delete", False , "Check to delete this preset"),
463 /* empty form to add new site */
465 $sitesform[] = Array(
466 'sitename' => Array("sitename[$id]", t("Site name"), "", ""),
467 'apiurl' => Array("apiurl[$id]", t("API URL"), "", ""),
468 'secret' => Array("secret[$id]", t("Consumer Secret"), "", ""),
469 'key' => Array("key[$id]", t("Consumer Key"), "", ""),
473 $t = file_get_contents( dirname(__file__). "/admin.tpl" );
474 $o = replace_macros($t, array(
475 '$submit' => t('Submit'),
477 '$sites' => $sitesform,