twitter/twitter.php

   1 <?php
   2 /**
   3  * Name: Twitter Connector
   4  * Version: 1.0.1
   5  * Author: Tobias Diekershoff <https://diekershoff.homeunix.net/friendika/profile/tobias>
   6  */
   7
   8
   9 /*   Twitter Plugin for Friendica
  10  *
  11  *   Author: Tobias Diekershoff
  12  *           tobias.diekershoff@gmx.net
  13  *
  14  *   License:3-clause BSD license
  15  *
  16  *   Configuration:
  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
  19  *
  20  *     Register your Friendica 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.
  23  *
  24  *     Add this key pair to your global .htconfig.php
  25  *
  26  *     $a->config['twitter']['consumerkey'] = 'your consumer_key here';
  27  *     $a->config['twitter']['consumersecret'] = 'your consumer_secret here';
  28  *
  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".
  32  *
  33  *     Requirements: PHP5, curl [Slinky library]
  34  *
  35  *     Documentation: http://diekershoff.homeunix.net/redmine/wiki/friendikaplugin/Twitter_Plugin
  36  */
  37
  38 /*   __TODO__
  39  *
  40  *   - what about multimedia content?
  41  *     so far we just strip HTML tags from the message
  42  */
  43
  44 function twitter_install() {
  45         //  we need some hooks, for the configuration and for sending tweets
  46         register_hook('connector_settings', 'addon/twitter/twitter.php', 'twitter_settings');
  47         register_hook('connector_settings_post', 'addon/twitter/twitter.php', 'twitter_settings_post');
  48         register_hook('post_local', 'addon/twitter/twitter.php', 'twitter_post_local');
  49         register_hook('notifier_normal', 'addon/twitter/twitter.php', 'twitter_post_hook');
  50         register_hook('jot_networks', 'addon/twitter/twitter.php', 'twitter_jot_nets');
  51         logger("installed twitter");
  52 }
  53
  54
  55 function twitter_uninstall() {
  56         unregister_hook('connector_settings', 'addon/twitter/twitter.php', 'twitter_settings');
  57         unregister_hook('connector_settings_post', 'addon/twitter/twitter.php', 'twitter_settings_post');
  58         unregister_hook('post_local', 'addon/twitter/twitter.php', 'twitter_post_local');
  59         unregister_hook('notifier_normal', 'addon/twitter/twitter.php', 'twitter_post_hook');
  60         unregister_hook('jot_networks', 'addon/twitter/twitter.php', 'twitter_jot_nets');
  61
  62         // old setting - remove only
  63         unregister_hook('post_local_end', 'addon/twitter/twitter.php', 'twitter_post_hook');
  64         unregister_hook('plugin_settings', 'addon/twitter/twitter.php', 'twitter_settings');
  65         unregister_hook('plugin_settings_post', 'addon/twitter/twitter.php', 'twitter_settings_post');
  66
  67 }
  68
  69 function twitter_jot_nets(&$a,&$b) {
  70         if(! local_user())
  71                 return;
  72
  73         $tw_post = get_pconfig(local_user(),'twitter','post');
  74         if(intval($tw_post) == 1) {
  75                 $tw_defpost = get_pconfig(local_user(),'twitter','post_by_default');
  76                 $selected = ((intval($tw_defpost) == 1) ? ' checked="checked" ' : '');
  77                 $b .= '<div class="profile-jot-net"><input type="checkbox" name="twitter_enable"' . $selected . ' value="1" /> '
  78                         . t('Post to Twitter') . '</div>';
  79         }
  80
  81
  82 }
  83
  84 function twitter_settings_post ($a,$post) {
  85         if(! local_user())
  86                 return;
  87         // don't check twitter settings if twitter submit button is not clicked
  88         if (!x($_POST,'twitter-submit')) return;
  89
  90         if (isset($_POST['twitter-disconnect'])) {
  91                 /***
  92                  * if the twitter-disconnect checkbox is set, clear the OAuth key/secret pair
  93                  * from the user configuration
  94                  * TODO can we revoke the access tokens at Twitter and do we need to do so?
  95                  */
  96                 del_pconfig( local_user(), 'twitter', 'consumerkey'  );
  97                 del_pconfig( local_user(), 'twitter', 'consumersecret' );
  98                 del_pconfig( local_user(), 'twitter', 'post' );
  99                 del_pconfig( local_user(), 'twitter', 'post_by_default' );
 100         } else {
 101         if (isset($_POST['twitter-pin'])) {
 102                 //  if the user supplied us with a PIN from Twitter, let the magic of OAuth happen
 103                 logger('got a Twitter PIN');
 104                 require_once('library/twitteroauth.php');
 105                 $ckey    = get_config('twitter', 'consumerkey'  );
 106                 $csecret = get_config('twitter', 'consumersecret' );
 107                 //  the token and secret for which the PIN was generated were hidden in the settings
 108                 //  form as token and token2, we need a new connection to Twitter using these token
 109                 //  and secret to request a Access Token with the PIN
 110                 $connection = new TwitterOAuth($ckey, $csecret, $_POST['twitter-token'], $_POST['twitter-token2']);
 111                 $token   = $connection->getAccessToken( $_POST['twitter-pin'] );
 112                 //  ok, now that we have the Access Token, save them in the user config
 113                 set_pconfig(local_user(),'twitter', 'oauthtoken',  $token['oauth_token']);
 114                 set_pconfig(local_user(),'twitter', 'oauthsecret', $token['oauth_token_secret']);
 115                 set_pconfig(local_user(),'twitter', 'post', 1);
 116                 //  reload the Addon Settings page, if we don't do it see Bug #42
 117                 goaway($a->get_baseurl().'/settings/connectors');
 118         } else {
 119                 //  if no PIN is supplied in the POST variables, the user has changed the setting
 120                 //  to post a tweet for every new __public__ posting to the wall
 121                 set_pconfig(local_user(),'twitter','post',intval($_POST['twitter-enable']));
 122                 set_pconfig(local_user(),'twitter','post_by_default',intval($_POST['twitter-default']));
 123                 info( t('Twitter settings updated.') . EOL);
 124         }}
 125 }
 126 function twitter_settings(&$a,&$s) {
 127         if(! local_user())
 128                 return;
 129         $a->page['htmlhead'] .= '<link rel="stylesheet"  type="text/css" href="' . $a->get_baseurl() . '/addon/twitter/twitter.css' . '" media="all" />' . "\r\n";
 130         /***
 131          * 1) Check that we have global consumer key & secret
 132          * 2) If no OAuthtoken & stuff is present, generate button to get some
 133          * 3) Checkbox for "Send public notices (140 chars only)
 134          */
 135         $ckey    = get_config('twitter', 'consumerkey' );
 136         $csecret = get_config('twitter', 'consumersecret' );
 137         $otoken  = get_pconfig(local_user(), 'twitter', 'oauthtoken'  );
 138         $osecret = get_pconfig(local_user(), 'twitter', 'oauthsecret' );
 139         $enabled = get_pconfig(local_user(), 'twitter', 'post');
 140         $checked = (($enabled) ? ' checked="checked" ' : '');
 141         $defenabled = get_pconfig(local_user(),'twitter','post_by_default');
 142         $defchecked = (($defenabled) ? ' checked="checked" ' : '');
 143
 144         $s .= '<div class="settings-block">';
 145         $s .= '<h3>'. t('Twitter Posting Settings') .'</h3>';
 146
 147         if ( (!$ckey) && (!$csecret) ) {
 148                 /***
 149                  * no global consumer keys
 150                  * display warning and skip personal config
 151                  */
 152                 $s .= '<p>'. t('No consumer key pair for Twitter found. Please contact your site administrator.') .'</p>';
 153         } else {
 154                 /***
 155                  * ok we have a consumer key pair now look into the OAuth stuff
 156                  */
 157                 if ( (!$otoken) && (!$osecret) ) {
 158                         /***
 159                          * the user has not yet connected the account to twitter...
 160                          * get a temporary OAuth key/secret pair and display a button with
 161                          * which the user can request a PIN to connect the account to a
 162                          * account at Twitter.
 163                          */
 164                         require_once('library/twitteroauth.php');
 165                         $connection = new TwitterOAuth($ckey, $csecret);
 166                         $request_token = $connection->getRequestToken();
 167                         $token = $request_token['oauth_token'];
 168                         /***
 169                          *  make some nice form
 170                          */
 171                         $s .= '<p>'. t('At this Friendica 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>';
 172                         $s .= '<a href="'.$connection->getAuthorizeURL($token).'" target="_twitter"><img src="addon/twitter/lighter.png" alt="'.t('Log in with Twitter').'"></a>';
 173                         $s .= '<div id="twitter-pin-wrapper">';
 174                         $s .= '<label id="twitter-pin-label" for="twitter-pin">'. t('Copy the PIN from Twitter here') .'</label>';
 175                         $s .= '<input id="twitter-pin" type="text" name="twitter-pin" />';
 176                         $s .= '<input id="twitter-token" type="hidden" name="twitter-token" value="'.$token.'" />';
 177                         $s .= '<input id="twitter-token2" type="hidden" name="twitter-token2" value="'.$request_token['oauth_token_secret'].'" />';
 178             $s .= '</div><div class="clear"></div>';
 179             $s .= '<div class="settings-submit-wrapper" ><input type="submit" name="twitter-submit" class="settings-submit" value="' . t('Submit') . '" /></div>';
 180                 } else {
 181                         /***
 182                          *  we have an OAuth key / secret pair for the user
 183                          *  so let's give a chance to disable the postings to Twitter
 184                          */
 185                         require_once('library/twitteroauth.php');
 186                         $connection = new TwitterOAuth($ckey,$csecret,$otoken,$osecret);
 187                         $details = $connection->get('account/verify_credentials');
 188                         $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>';
 189                         $s .= '<p>'. t('If enabled all your <strong>public</strong> postings can be posted to the associated Twitter account. You can choose to do so by default (here) or for every posting separately in the posting options when writing the entry.') .'</p>';
 190                         $s .= '<div id="twitter-enable-wrapper">';
 191                         $s .= '<label id="twitter-enable-label" for="twitter-checkbox">'. t('Allow posting to Twitter'). '</label>';
 192                         $s .= '<input id="twitter-checkbox" type="checkbox" name="twitter-enable" value="1" ' . $checked . '/>';
 193                         $s .= '<div class="clear"></div>';
 194                         $s .= '<label id="twitter-default-label" for="twitter-default">'. t('Send public postings to Twitter by default') .'</label>';
 195                         $s .= '<input id="twitter-default" type="checkbox" name="twitter-default" value="1" ' . $defchecked . '/>';
 196                         $s .= '</div><div class="clear"></div>';
 197
 198                         $s .= '<div id="twitter-disconnect-wrapper">';
 199                         $s .= '<label id="twitter-disconnect-label" for="twitter-disconnect">'. t('Clear OAuth configuration') .'</label>';
 200                         $s .= '<input id="twitter-disconnect" type="checkbox" name="twitter-disconnect" value="1" />';
 201                         $s .= '</div><div class="clear"></div>';
 202                         $s .= '<div class="settings-submit-wrapper" ><input type="submit" name="twitter-submit" class="settings-submit" value="' . t('Submit') . '" /></div>';
 203                 }
 204         }
 205         $s .= '</div><div class="clear"></div></div>';
 206 }
 207
 208
 209 function twitter_post_local(&$a,&$b) {
 210
 211         if($b['edit'])
 212                 return;
 213
 214         if((local_user()) && (local_user() == $b['uid']) && (! $b['private']) && (! $b['parent']) ) {
 215
 216                 $twitter_post = intval(get_pconfig(local_user(),'twitter','post'));
 217                 $twitter_enable = (($twitter_post && x($_REQUEST,'twitter_enable')) ? intval($_REQUEST['twitter_enable']) : 0);
 218
 219                 // if API is used, default to the chosen settings
 220                 if($_REQUEST['api_source'] && intval(get_pconfig(local_user(),'twitter','post_by_default')))
 221                         $twitter_enable = 1;
 222
 223         if(! $twitter_enable)
 224             return;
 225
 226         if(strlen($b['postopts']))
 227             $b['postopts'] .= ',';
 228         $b['postopts'] .= 'twitter';
 229         }
 230 }
 231
 232
 233 function twitter_post_hook(&$a,&$b) {
 234
 235         /**
 236          * Post to Twitter
 237          */
 238
 239         if($b['deleted'] || $b['private'] || ($b['created'] !== $b['edited']))
 240         return;
 241
 242         if(! strstr($b['postopts'],'twitter'))
 243                 return;
 244
 245         if($b['parent'] != $b['id'])
 246                 return;
 247
 248         logger('twitter post invoked');
 249
 250
 251         load_pconfig($b['uid'], 'twitter');
 252
 253         $ckey    = get_config('twitter', 'consumerkey'  );
 254         $csecret = get_config('twitter', 'consumersecret' );
 255         $otoken  = get_pconfig($b['uid'], 'twitter', 'oauthtoken'  );
 256         $osecret = get_pconfig($b['uid'], 'twitter', 'oauthsecret' );
 257
 258         if($ckey && $csecret && $otoken && $osecret) {
 259                 logger('twitter: we have customer key and oauth stuff, going to send.', LOGGER_DEBUG);
 260
 261                 require_once('library/twitteroauth.php');
 262                 require_once('include/bbcode.php');
 263                 $tweet = new TwitterOAuth($ckey,$csecret,$otoken,$osecret);
 264                 $max_char = 138; // max. length for a tweet
 265                 $msg = strip_tags(bbcode($b['body']));
 266                 if ( strlen($msg) > $max_char) {
 267                         logger('Twitter: have to shorten the message to fit 140 chars', LOGGER_DEBUG);
 268                         $shortlink = "";
 269                         require_once('library/slinky.php');
 270                         $slinky = new Slinky( $b['plink'] );
 271                         // setup a cascade of shortening services
 272                         // try to get a short link from these services
 273                         // in the order ur1.ca, trim, id.gd, tinyurl
 274                         $slinky->set_cascade( array( new Slinky_UR1ca(), new Slinky_Trim(), new Slinky_IsGd(), new Slinky_TinyURL() ) );
 275                         $shortlink = $slinky->short();
 276                         // the new message will be shortened such that "... $shortlink"
 277                         // will fit into the character limit
 278                         $msg = substr($msg, 0, $max_char-strlen($shortlink)-4);
 279                         $msg .= '... ' . $shortlink;
 280                 }
 281                 // and now tweet it :-)
 282                 if(strlen($msg)) {
 283                         $result = $tweet->post('statuses/update', array('status' => $msg));
 284                         logger('twitter_post send', LOGGER_DEBUG);
 285                 }
 286         }
 287 }
 288
 289 function twitter_plugin_admin_post(&$a){
 290         $consumerkey    =       ((x($_POST,'consumerkey'))              ? notags(trim($_POST['consumerkey']))   : '');
 291         $consumersecret =       ((x($_POST,'consumersecret'))   ? notags(trim($_POST['consumersecret'])): '');
 292         set_config('twitter','consumerkey',$consumerkey);
 293         set_config('twitter','consumersecret',$consumersecret);
 294         info( t('Settings updated.'). EOL );
 295 }
 296 function twitter_plugin_admin(&$a, &$o){
 297         $t = file_get_contents( dirname(__file__). "/admin.tpl" );
 298         $o = replace_macros($t, array(
 299                 '$submit' => t('Submit'),
 300                                                                 // name, label, value, help, [extra values]
 301                 '$consumerkey' => array('consumerkey', t('Consumer key'),  get_config('twitter', 'consumerkey' ), ''),
 302                 '$consumersecret' => array('consumersecret', t('Consumer secret'),  get_config('twitter', 'consumersecret' ), '')
 303         ));
 304 }