3 * Name: Twitter Connector
5 * Author: Tobias Diekershoff <https://diekershoff.homeunix.net/friendika/profile/tobias>
9 /* Twitter Plugin for Friendika
11 * Author: Tobias Diekershoff
12 * tobias.diekershoff@gmx.net
14 * License:3-clause BSD license (same as Friendika)
17 * To use this plugin you need a OAuth Consumer key pair (key & secret)
18 * you can get it from Twitter at https://twitter.com/apps
20 * Register your Friendika site as "Client" application with "Read & Write" access
21 * we do not need "Twitter as login". When you've registered the app you get the
22 * OAuth Consumer key and secret pair for your application/site.
24 * Add this key pair to your global .htconfig.php
26 * $a->config['twitter']['consumerkey'] = 'your consumer_key here';
27 * $a->config['twitter']['consumersecret'] = 'your consumer_secret here';
29 * To activate the plugin itself add it to the $a->config['system']['addon']
30 * setting. After this, your user can configure their Twitter account settings
31 * from "Settings -> Plugin Settings".
33 * Requirements: PHP5, curl [Slinky library]
35 * Documentation: http://diekershoff.homeunix.net/redmine/wiki/friendikaplugin/Twitter_Plugin
40 * - what about multimedia content?
41 * so far we just strip HTML tags from the message
44 function twitter_install() {
45 // we need some hooks, for the configuration and for sending tweets
46 register_hook('plugin_settings', 'addon/twitter/twitter.php', 'twitter_settings');
47 register_hook('plugin_settings_post', 'addon/twitter/twitter.php', 'twitter_settings_post');
48 register_hook('post_local_end', 'addon/twitter/twitter.php', 'twitter_post_hook');
49 register_hook('jot_networks', 'addon/twitter/twitter.php', 'twitter_jot_nets');
50 logger("installed twitter");
54 function twitter_uninstall() {
55 unregister_hook('plugin_settings', 'addon/twitter/twitter.php', 'twitter_settings');
56 unregister_hook('plugin_settings_post', 'addon/twitter/twitter.php', 'twitter_settings_post');
57 unregister_hook('post_local_end', 'addon/twitter/twitter.php', 'twitter_post_hook');
58 unregister_hook('jot_networks', 'addon/twitter/twitter.php', 'twitter_jot_nets');
61 function twitter_jot_nets(&$a,&$b) {
65 $tw_post = get_pconfig(local_user(),'twitter','post');
66 if(intval($tw_post) == 1) {
67 $tw_defpost = get_pconfig(local_user(),'twitter','post_by_default');
68 $selected = ((intval($tw_defpost) == 1) ? ' checked="checked" ' : '');
69 $b .= '<div class="profile-jot-net"><input type="checkbox" name="twitter_enable"' . $selected . 'value="1" /> '
70 . t('Post to Twitter') . '</div>';
76 function twitter_settings_post ($a,$post) {
79 if (isset($_POST['twitter-disconnect'])) {
81 * if the twitter-disconnect checkbox is set, clear the OAuth key/secret pair
82 * from the user configuration
83 * TODO can we revoke the access tokens at Twitter and do we need to do so?
85 del_pconfig( local_user(), 'twitter', 'consumerkey' );
86 del_pconfig( local_user(), 'twitter', 'consumersecret' );
87 del_pconfig( local_user(), 'twitter', 'post' );
89 if (isset($_POST['twitter-pin'])) {
90 // if the user supplied us with a PIN from Twitter, let the magic of OAuth happen
91 logger('got a Twitter PIN');
92 require_once('library/twitteroauth.php');
93 $ckey = get_config('twitter', 'consumerkey' );
94 $csecret = get_config('twitter', 'consumersecret' );
95 // the token and secret for which the PIN was generated were hidden in the settings
96 // form as token and token2, we need a new connection to Twitter using these token
97 // and secret to request a Access Token with the PIN
98 $connection = new TwitterOAuth($ckey, $csecret, $_POST['twitter-token'], $_POST['twitter-token2']);
99 $token = $connection->getAccessToken( $_POST['twitter-pin'] );
100 // ok, now that we have the Access Token, save them in the user config
101 set_pconfig(local_user(),'twitter', 'oauthtoken', $token['oauth_token']);
102 set_pconfig(local_user(),'twitter', 'oauthsecret', $token['oauth_token_secret']);
103 set_pconfig(local_user(),'twitter', 'post', 1);
104 // reload the Addon Settings page, if we don't do it see Bug #42
105 header('Location: '.$a->get_baseurl().'/settings/addon');
107 // if no PIN is supplied in the POST variables, the user has changed the setting
108 // to post a tweet for every new __public__ posting to the wall
109 set_pconfig(local_user(),'twitter','post',intval($_POST['twitter-enable']));
112 function twitter_settings(&$a,&$s) {
115 $a->page['htmlhead'] .= '<link rel="stylesheet" type="text/css" href="' . $a->get_baseurl() . '/addon/twitter/twitter.css' . '" media="all" />' . "\r\n";
117 * 1) Check that we have global consumer key & secret
118 * 2) If no OAuthtoken & stuff is present, generate button to get some
119 * 3) Checkbox for "Send public notices (140 chars only)
121 $ckey = get_config('twitter', 'consumerkey' );
122 $csecret = get_config('twitter', 'consumersecret' );
123 $otoken = get_pconfig(local_user(), 'twitter', 'oauthtoken' );
124 $osecret = get_pconfig(local_user(), 'twitter', 'oauthsecret' );
125 $enabled = get_pconfig(local_user(), 'twitter', 'post');
126 $checked = (($enabled) ? ' checked="checked" ' : '');
127 $s .= '<div class="settings-block">';
128 $s .= '<h3>'. t('Twitter Posting Settings') .'</h3>';
130 if ( (!$ckey) && (!$csecret) ) {
132 * no global consumer keys
133 * display warning and skip personal config
135 $s .= '<p>'. t('No consumer key pair for Twitter found. Please contact your site administrator.') .'</p>';
138 * ok we have a consumer key pair now look into the OAuth stuff
140 if ( (!$otoken) && (!$osecret) ) {
142 * the user has not yet connected the account to twitter...
143 * get a temporary OAuth key/secret pair and display a button with
144 * which the user can request a PIN to connect the account to a
145 * account at Twitter.
147 require_once('library/twitteroauth.php');
148 $connection = new TwitterOAuth($ckey, $csecret);
149 $request_token = $connection->getRequestToken();
150 $token = $request_token['oauth_token'];
152 * make some nice form
154 $s .= '<p>'. t('At this Friendika instance the Twitter plugin was enabled but you have not yet connected your account to your Twitter account. To do so click the button below to get a PIN from Twitter which you have to copy into the input box below and submit the form. Only your <strong>public</strong> posts will be posted to Twitter.') .'</p>';
155 $s .= '<a href="'.$connection->getAuthorizeURL($token).'" target="_twitter"><img src="addon/twitter/lighter.png" alt="'.t('Log in with Twitter').'"></a>';
156 $s .= '<div id="twitter-pin-wrapper">';
157 $s .= '<label id="twitter-pin-label" for="twitter-pin">'. t('Copy the PIN from Twitter here') .'</label>';
158 $s .= '<input id="twitter-pin" type="text" name="twitter-pin" />';
159 $s .= '<input id="twitter-token" type="hidden" name="twitter-token" value="'.$token.'" />';
160 $s .= '<input id="twitter-token2" type="hidden" name="twitter-token2" value="'.$request_token['oauth_token_secret'].'" />';
161 $s .= '</div><div class="clear"></div>';
162 $s .= '<div class="settings-submit-wrapper" ><input type="submit" name="submit" class="settings-submit" value="' . t('Submit') . '" /></div>';
165 * we have an OAuth key / secret pair for the user
166 * so let's give a chance to disable the postings to Twitter
168 require_once('library/twitteroauth.php');
169 $connection = new TwitterOAuth($ckey,$csecret,$otoken,$osecret);
170 $details = $connection->get('account/verify_credentials');
171 $s .= '<div id="twitter-info" ><img id="twitter-avatar" src="'.$details->profile_image_url.'" /><p id="twitter-info-block">'. t('Currently connected to: ') .'<a href="https://twitter.com/'.$details->screen_name.'" target="_twitter">'.$details->screen_name.'</a><br /><em>'.$details->description.'</em></p></div>';
172 $s .= '<p>'. t('If enabled all your <strong>public</strong> postings will be posted to the associated Twitter account as well.') .'</p>';
173 $s .= '<div id="twitter-enable-wrapper">';
174 $s .= '<label id="twitter-enable-label" for="twitter-checkbox">'. t('Send public postings to Twitter'). '</label>';
175 $s .= '<input id="twitter-checkbox" type="checkbox" name="twitter-enable" value="1" ' . $checked . '/>';
176 $s .= '</div><div class="clear"></div>';
177 $s .= '<div id="twitter-disconnect-wrapper">';
178 $s .= '<label id="twitter-disconnect-label" for="twitter-disconnect">'. t('Clear OAuth configuration') .'</label>';
179 $s .= '<input id="twitter-disconnect" type="checkbox" name="twitter-disconnect" value="1" />';
180 $s .= '</div><div class="clear"></div>';
181 $s .= '<div class="settings-submit-wrapper" ><input type="submit" name="submit" class="settings-submit" value="' . t('Submit') . '" /></div>';
184 $s .= '</div><div class="clear"></div></div>';
188 function twitter_post_hook(&$a,&$b) {
194 logger('twitter post invoked');
196 if((local_user()) && (local_user() == $b['uid']) && (! $b['private']) && (! $b['parent']) ) {
198 load_pconfig(local_user(), 'twitter');
200 $ckey = get_config('twitter', 'consumerkey' );
201 $csecret = get_config('twitter', 'consumersecret' );
202 $otoken = get_pconfig(local_user(), 'twitter', 'oauthtoken' );
203 $osecret = get_pconfig(local_user(), 'twitter', 'oauthsecret' );
205 if($ckey && $csecret && $otoken && $osecret) {
207 $twitter_post = intval(get_pconfig(local_user(),'twitter','post'));
208 $twitter_enable = (($twitter_post && x($_POST,'twitter_enable')) ? intval($_POST['twitter_enable']) : 0);
210 if($twitter_post && $twitter_enable) {
211 require_once('library/twitteroauth.php');
212 require_once('include/bbcode.php');
213 $tweet = new TwitterOAuth($ckey,$csecret,$otoken,$osecret);
214 $max_char = 140; // max. length for a tweet
215 $msg = strip_tags(bbcode($b['body']));
216 if ( strlen($msg) > $max_char) {
218 require_once('library/slinky.php');
219 // post url = base url + /display/ + owner + post id
220 // we construct this from the Owner link and replace
221 // profile by display - this will cause an error when
222 // /profile/ is in the owner url twice but I don't
223 // think this will be very common...
224 $posturl = str_replace('/profile/','/display/',$b['owner-link']).'/'.$b['id'];
225 $slinky = new Slinky( $posturl );
226 // setup a cascade of shortening services
227 // try to get a short link from these services
228 // in the order ur1.ca, trim, id.gd, tinyurl
229 $slinky->set_cascade( array( new Slinky_UR1ca(), new Slinky_Trim(), new Slinky_IsGd(), new Slinky_TinyURL() ) );
230 $shortlink = $slinky->short();
231 // the new message will be shortened such that "... $shortlink"
232 // will fit into the character limit
233 $msg = substr($msg, 0, $max_char-strlen($shortlink)-4);
234 $msg .= '... ' . $shortlink;
236 // and now tweet it :-)
238 $tweet->post('statuses/update', array('status' => $msg));