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 (same as Friendika)
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;
56 function statusnet_install() {
57 // we need some hooks, for the configuration and for sending tweets
58 register_hook('plugin_settings', 'addon/statusnet/statusnet.php', 'statusnet_settings');
59 register_hook('plugin_settings_post', 'addon/statusnet/statusnet.php', 'statusnet_settings_post');
60 register_hook('post_local_end', 'addon/statusnet/statusnet.php', 'statusnet_post_hook');
61 register_hook('jot_networks', 'addon/statusnet/statusnet.php', 'statusnet_jot_nets');
63 logger("installed statusnet");
67 function statusnet_uninstall() {
68 unregister_hook('plugin_settings', 'addon/statusnet/statusnet.php', 'statusnet_settings');
69 unregister_hook('plugin_settings_post', 'addon/statusnet/statusnet.php', 'statusnet_settings_post');
70 unregister_hook('post_local_end', 'addon/statusnet/statusnet.php', 'statusnet_post_hook');
71 unregister_hook('jot_networks', 'addon/statusnet/statusnet.php', 'statusnet_jot_nets');
74 function statusnet_jot_nets(&$a,&$b) {
78 $statusnet_post = get_pconfig(local_user(),'statusnet','post');
79 if(intval($statusnet_post) == 1) {
80 $statusnet_defpost = get_pconfig(local_user(),'statusnet','post_by_default');
81 $selected = ((intval($statusnet_defpost) == 1) ? ' checked="checked" ' : '');
82 $b .= '<div class="profile-jot-net"><input type="checkbox" name="statusnet_enable"' . $selected . 'value="1" /> '
83 . t('Post to StatusNet') . '</div>';
90 function statusnet_settings_post ($a,$post) {
93 if (isset($_POST['statusnet-disconnect'])) {
95 * if the statusnet-disconnect checkbox is set, clear the statusnet configuration
96 * TODO can we revoke the access tokens at Twitter and do we need to do so?
98 del_pconfig( local_user(), 'statusnet', 'consumerkey' );
99 del_pconfig( local_user(), 'statusnet', 'consumersecret' );
100 del_pconfig( local_user(), 'statusnet', 'post' );
101 del_pconfig( local_user(), 'statusnet', 'post_by_default' );
102 del_pconfig( local_user(), 'statusnet', 'oauthtoken' );
103 del_pconfig( local_user(), 'statusnet', 'oauthsecret' );
104 del_pconfig( local_user(), 'statusnet', 'baseapi' );
106 if (isset($_POST['statusnet-preconf-apiurl'])) {
108 * If the user used one of the preconfigured StatusNet server credentials
109 * use them. All the data are available in the global config.
110 * Check the API Url never the less and blame the admin if it's not working ^^
112 $globalsn = get_config('statusnet', 'sites');
113 foreach ( $globalsn as $asn) {
114 if ($asn['apiurl'] == $_POST['statusnet-preconf-apiurl'] ) {
115 $apibase = $asn['apiurl'];
116 $c = fetch_url( $apibase . 'statusnet/version.xml' );
117 if (strlen($c) > 0) {
118 set_pconfig(local_user(), 'statusnet', 'consumerkey', $asn['consumerkey'] );
119 set_pconfig(local_user(), 'statusnet', 'consumersecret', $asn['consumersecret'] );
120 set_pconfig(local_user(), 'statusnet', 'baseapi', $asn['apiurl'] );
122 notice( t('Please contact your site administrator.<br />The provided API URL is not valid.').EOL.$asn['apiurl'].EOL );
126 goaway($a->get_baseurl().'/settings/addon');
128 if (isset($_POST['statusnet-consumersecret'])) {
129 // check if we can reach the API of the StatusNet server
130 // we'll check the API Version for that, if we don't get one we'll try to fix the path but will
131 // resign quickly after this one try to fix the path ;-)
132 $apibase = $_POST['statusnet-baseapi'];
133 $c = fetch_url( $apibase . 'statusnet/version.xml' );
134 if (strlen($c) > 0) {
135 // ok the API path is correct, let's save the settings
136 set_pconfig(local_user(), 'statusnet', 'consumerkey', $_POST['statusnet-consumerkey']);
137 set_pconfig(local_user(), 'statusnet', 'consumersecret', $_POST['statusnet-consumersecret']);
138 set_pconfig(local_user(), 'statusnet', 'baseapi', $apibase );
140 // the API path is not correct, maybe missing trailing / ?
141 $apibase = $apibase . '/';
142 $c = fetch_url( $apibase . 'statusnet/version.xml' );
143 if (strlen($c) > 0) {
144 // ok the API path is now correct, let's save the settings
145 set_pconfig(local_user(), 'statusnet', 'consumerkey', $_POST['statusnet-consumerkey']);
146 set_pconfig(local_user(), 'statusnet', 'consumersecret', $_POST['statusnet-consumersecret']);
147 set_pconfig(local_user(), 'statusnet', 'baseapi', $apibase );
149 // still not the correct API base, let's do noting
150 notice( t('We could not contact the StatusNet API with the Path you entered.').EOL );
153 goaway($a->get_baseurl().'/settings/addon');
155 if (isset($_POST['statusnet-pin'])) {
156 // if the user supplied us with a PIN from Twitter, let the magic of OAuth happen
157 logger('got a StatusNet security code');
158 $api = get_pconfig(local_user(), 'statusnet', 'baseapi');
159 $ckey = get_pconfig(local_user(), 'statusnet', 'consumerkey' );
160 $csecret = get_pconfig(local_user(), 'statusnet', 'consumersecret' );
161 // the token and secret for which the PIN was generated were hidden in the settings
162 // form as token and token2, we need a new connection to Twitter using these token
163 // and secret to request a Access Token with the PIN
164 $connection = new StatusNetOAuth($api, $ckey, $csecret, $_POST['statusnet-token'], $_POST['statusnet-token2']);
165 $token = $connection->getAccessToken( $_POST['statusnet-pin'] );
166 // ok, now that we have the Access Token, save them in the user config
167 set_pconfig(local_user(),'statusnet', 'oauthtoken', $token['oauth_token']);
168 set_pconfig(local_user(),'statusnet', 'oauthsecret', $token['oauth_token_secret']);
169 set_pconfig(local_user(),'statusnet', 'post', 1);
170 // reload the Addon Settings page, if we don't do it see Bug #42
171 goaway($a->get_baseurl().'/settings/addon');
173 // if no PIN is supplied in the POST variables, the user has changed the setting
174 // to post a tweet for every new __public__ posting to the wall
175 set_pconfig(local_user(),'statusnet','post',intval($_POST['statusnet-enable']));
176 set_pconfig(local_user(),'statusnet','post_by_default',intval($_POST['statusnet-default']));
177 info( t('StatusNet settings updated.') . EOL);
180 function statusnet_settings(&$a,&$s) {
183 $a->page['htmlhead'] .= '<link rel="stylesheet" type="text/css" href="' . $a->get_baseurl() . '/addon/statusnet/statusnet.css' . '" media="all" />' . "\r\n";
185 * 1) Check that we have a base api url and a consumer key & secret
186 * 2) If no OAuthtoken & stuff is present, generate button to get some
187 * allow the user to cancel the connection process at this step
188 * 3) Checkbox for "Send public notices (respect size limitation)
190 $api = get_pconfig(local_user(), 'statusnet', 'baseapi');
191 $ckey = get_pconfig(local_user(), 'statusnet', 'consumerkey' );
192 $csecret = get_pconfig(local_user(), 'statusnet', 'consumersecret' );
193 $otoken = get_pconfig(local_user(), 'statusnet', 'oauthtoken' );
194 $osecret = get_pconfig(local_user(), 'statusnet', 'oauthsecret' );
195 $enabled = get_pconfig(local_user(), 'statusnet', 'post');
196 $checked = (($enabled) ? ' checked="checked" ' : '');
197 $defenabled = get_pconfig(local_user(),'statusnet','post_by_default');
198 $defchecked = (($defenabled) ? ' checked="checked" ' : '');
199 $s .= '<div class="settings-block">';
200 $s .= '<h3>'. t('StatusNet Posting Settings').'</h3>';
202 if ( (!$ckey) && (!$csecret) ) {
206 $globalsn = get_config('statusnet', 'sites');
208 * lets check if we have one or more globally configured StatusNet
209 * server OAuth credentials in the configuration. If so offer them
210 * with a little explanation to the user as choice - otherwise
211 * ignore this option entirely.
213 if (! $globalsn == null) {
214 $s .= '<h4>' . t('Globally Available StatusNet OAuthKeys') . '</h4>';
215 $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>';
216 $s .= '<div id="statusnet-preconf-wrapper">';
217 foreach ($globalsn as $asn) {
218 $s .= '<input type="radio" name="statusnet-preconf-apiurl" value="'. $asn['apiurl'] .'">'. $asn['sitename'] .'<br />';
220 $s .= '<p></p><div class="clear"></div></div>';
221 $s .= '<div class="settings-submit-wrapper" ><input type="submit" name="submit" class="settings-submit" value="' . t('Submit') . '" /></div>';
223 $s .= '<h4>' . t('Provide your own OAuth Credentials') . '</h4>';
224 $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>';
225 $s .= '<div id="statusnet-consumer-wrapper">';
226 $s .= '<label id="statusnet-consumerkey-label" for="statusnet-consumerkey">'. t('OAuth Consumer Key') .'</label>';
227 $s .= '<input id="statusnet-consumerkey" type="text" name="statusnet-consumerkey" size="35" /><br />';
228 $s .= '<div class="clear"></div>';
229 $s .= '<label id="statusnet-consumersecret-label" for="statusnet-consumersecret">'. t('OAuth Consumer Secret') .'</label>';
230 $s .= '<input id="statusnet-consumersecret" type="text" name="statusnet-consumersecret" size="35" /><br />';
231 $s .= '<div class="clear"></div>';
232 $s .= '<label id="statusnet-baseapi-label" for="statusnet-baseapi">'. t("Base API Path \x28remember the trailing /\x29") .'</label>';
233 $s .= '<input id="statusnet-baseapi" type="text" name="statusnet-baseapi" size="35" /><br />';
234 $s .= '<p></p><div class="clear"></div></div>';
235 $s .= '<div class="settings-submit-wrapper" ><input type="submit" name="submit" class="settings-submit" value="' . t('Submit') . '" /></div>';
238 * ok we have a consumer key pair now look into the OAuth stuff
240 if ( (!$otoken) && (!$osecret) ) {
242 * the user has not yet connected the account to statusnet
243 * get a temporary OAuth key/secret pair and display a button with
244 * which the user can request a PIN to connect the account to a
245 * account at statusnet
247 $connection = new StatusNetOAuth($api, $ckey, $csecret);
248 $request_token = $connection->getRequestToken('oob');
249 $token = $request_token['oauth_token'];
251 * make some nice form
253 $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>';
254 $s .= '<a href="'.$connection->getAuthorizeURL($token,False).'" target="_statusnet"><img src="addon/statusnet/signinwithstatusnet.png" alt="'. t('Log in with StatusNet') .'"></a>';
255 $s .= '<div id="statusnet-pin-wrapper">';
256 $s .= '<label id="statusnet-pin-label" for="statusnet-pin">'. t('Copy the security code from StatusNet here') .'</label>';
257 $s .= '<input id="statusnet-pin" type="text" name="statusnet-pin" />';
258 $s .= '<input id="statusnet-token" type="hidden" name="statusnet-token" value="'.$token.'" />';
259 $s .= '<input id="statusnet-token2" type="hidden" name="statusnet-token2" value="'.$request_token['oauth_token_secret'].'" />';
260 $s .= '</div><div class="clear"></div>';
261 $s .= '<div class="settings-submit-wrapper" ><input type="submit" name="submit" class="settings-submit" value="' . t('Submit') . '" /></div>';
262 $s .= '<h4>'.t('Cancel Connection Process').'</h4>';
263 $s .= '<div id="statusnet-cancel-wrapper">';
264 $s .= '<p>'.t('Current StatusNet API is').': '.$api.'</p>';
265 $s .= '<label id="statusnet-cancel-label" for="statusnet-cancel">'. t('Cancel StatusNet Connection') . '</label>';
266 $s .= '<input id="statusnet-cancel" type="checkbox" name="statusnet-disconnect" value="1" />';
267 $s .= '</div><div class="clear"></div>';
268 $s .= '<div class="settings-submit-wrapper" ><input type="submit" name="submit" class="settings-submit" value="' . t('Submit') . '" /></div>';
271 * we have an OAuth key / secret pair for the user
272 * so let's give a chance to disable the postings to statusnet
274 $connection = new StatusNetOAuth($api,$ckey,$csecret,$otoken,$osecret);
275 $details = $connection->get('account/verify_credentials');
276 $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>';
277 $s .= '<p>'. t('If enabled all your <strong>public</strong> postings will be posted to the associated StatusNet account.') .'</p>';
278 $s .= '<div id="statusnet-enable-wrapper">';
279 $s .= '<label id="statusnet-enable-label" for="statusnet-checkbox">'. t('Allow posting to StatusNet') .'</label>';
280 $s .= '<input id="statusnet-checkbox" type="checkbox" name="statusnet-enable" value="1" ' . $checked . '/>';
281 $s .= '<div class="clear"></div>';
282 $s .= '<label id="statusnet-default-label" for="statusnet-default">'. t('Send public postings to StatusNet by default') .'</label>';
283 $s .= '<input id="statusnet-default" type="checkbox" name="statusnet-default" value="1" ' . $defchecked . '/>';
284 $s .= '</div><div class="clear"></div>';
286 $s .= '<div id="statusnet-disconnect-wrapper">';
287 $s .= '<label id="statusnet-disconnect-label" for="statusnet-disconnect">'. t('Clear OAuth configuration') .'</label>';
288 $s .= '<input id="statusnet-disconnect" type="checkbox" name="statusnet-disconnect" value="1" />';
289 $s .= '</div><div class="clear"></div>';
290 $s .= '<div class="settings-submit-wrapper" ><input type="submit" name="submit" class="settings-submit" value="' . t('Submit') . '" /></div>';
293 $s .= '</div><div class="clear"></div></div>';
297 function statusnet_post_hook(&$a,&$b) {
303 logger('StatusNet post invoked');
305 if((local_user()) && (local_user() == $b['uid']) && (! $b['private']) && (!$b['parent']) ) {
307 load_pconfig(local_user(), 'statusnet');
309 $api = get_pconfig(local_user(), 'statusnet', 'baseapi');
310 $ckey = get_pconfig(local_user(), 'statusnet', 'consumerkey' );
311 $csecret = get_pconfig(local_user(), 'statusnet', 'consumersecret' );
312 $otoken = get_pconfig(local_user(), 'statusnet', 'oauthtoken' );
313 $osecret = get_pconfig(local_user(), 'statusnet', 'oauthsecret' );
315 if($ckey && $csecret && $otoken && $osecret) {
317 $statusnet_post = get_pconfig(local_user(),'statusnet','post');
318 $statusnet_enable = (($statusnet_post && x($_POST,'statusnet_enable')) ? intval($_POST['statusnet_enable']) : 0);
320 if($statusnet_enable && $statusnet_post) {
321 require_once('include/bbcode.php');
322 $dent = new StatusNetOAuth($api,$ckey,$csecret,$otoken,$osecret);
323 $max_char = $dent->get_maxlength(); // max. length for a dent
324 $msg = strip_tags(bbcode($b['body']));
325 if ( strlen($msg) > $max_char) {
327 require_once('library/slinky.php');
328 // post url = base url + /display/ + owner + post id
329 // we construct this from the Owner link and replace
330 // profile by display - this will cause an error when
331 // /profile/ is in the owner url twice but I don't
332 // think this will be very common...
333 $posturl = str_replace('/profile/','/display/',$b['owner-link']).'/'.$b['id'];
334 $slinky = new Slinky( $posturl );
335 // setup a cascade of shortening services
336 // try to get a short link from these services
337 // in the order ur1.ca, trim, id.gd, tinyurl
338 $slinky->set_cascade( array( new Slinky_UR1ca(), new Slinky_Trim(), new Slinky_IsGd(), new Slinky_TinyURL() ) );
339 $shortlink = $slinky->short();
340 // the new message will be shortened such that "... $shortlink"
341 // will fit into the character limit
342 $msg = substr($msg, 0, $max_char-strlen($shortlink)-4);
343 $msg .= '... ' . $shortlink;
345 // and now tweet it :-)
347 $dent->post('statuses/update', array('status' => $msg));