addon/twitter/twitter.php

   1 <?php
   2 /**
   3  * Name: Twitter Connector
   4  * Version: 1.0
   5  * Author: Tobias Diekershoff <https://diekershoff.homeunix.net/friendika/profile/tobias>
   6  */
   7
   8
   9 /*   Twitter Plugin for Friendika
  10  *
  11  *   Author: Tobias Diekershoff
  12  *           tobias.diekershoff@gmx.net
  13  *
  14  *   License:3-clause BSD license (same as Friendika)
  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 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.
  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('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");
  51 }
  52
  53
  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');
  59 }
  60
  61 function twitter_jot_nets(&$a,&$b) {
  62         if(! local_user())
  63                 return;
  64
  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>';
  71         }
  72
  73
  74 }
  75
  76 function twitter_settings_post ($a,$post) {
  77         if(! local_user())
  78                 return;
  79         // don't check twitter settings if twitter submit button is not clicked
  80         if (!x($_POST,'twitter-submit')) return;
  81
  82         if (isset($_POST['twitter-disconnect'])) {
  83                 /***
  84                  * if the twitter-disconnect checkbox is set, clear the OAuth key/secret pair
  85                  * from the user configuration
  86                  * TODO can we revoke the access tokens at Twitter and do we need to do so?
  87                  */
  88                 del_pconfig( local_user(), 'twitter', 'consumerkey'  );
  89                 del_pconfig( local_user(), 'twitter', 'consumersecret' );
  90                 del_pconfig( local_user(), 'twitter', 'post' );
  91         } else {
  92         if (isset($_POST['twitter-pin'])) {
  93                 //  if the user supplied us with a PIN from Twitter, let the magic of OAuth happen
  94                 logger('got a Twitter PIN');
  95                 require_once('library/twitteroauth.php');
  96                 $ckey    = get_config('twitter', 'consumerkey'  );
  97                 $csecret = get_config('twitter', 'consumersecret' );
  98                 //  the token and secret for which the PIN was generated were hidden in the settings
  99                 //  form as token and token2, we need a new connection to Twitter using these token
 100                 //  and secret to request a Access Token with the PIN
 101                 $connection = new TwitterOAuth($ckey, $csecret, $_POST['twitter-token'], $_POST['twitter-token2']);
 102                 $token   = $connection->getAccessToken( $_POST['twitter-pin'] );
 103                 //  ok, now that we have the Access Token, save them in the user config
 104                 set_pconfig(local_user(),'twitter', 'oauthtoken',  $token['oauth_token']);
 105                 set_pconfig(local_user(),'twitter', 'oauthsecret', $token['oauth_token_secret']);
 106                 set_pconfig(local_user(),'twitter', 'post', 1);
 107                 //  reload the Addon Settings page, if we don't do it see Bug #42
 108                 header('Location: '.$a->get_baseurl().'/settings/addon');
 109         } else {
 110                 //  if no PIN is supplied in the POST variables, the user has changed the setting
 111                 //  to post a tweet for every new __public__ posting to the wall
 112                 set_pconfig(local_user(),'twitter','post',intval($_POST['twitter-enable']));
 113         }}
 114 }
 115 function twitter_settings(&$a,&$s) {
 116         if(! local_user())
 117                 return;
 118         $a->page['htmlhead'] .= '<link rel="stylesheet"  type="text/css" href="' . $a->get_baseurl() . '/addon/twitter/twitter.css' . '" media="all" />' . "\r\n";
 119         /***
 120          * 1) Check that we have global consumer key & secret
 121          * 2) If no OAuthtoken & stuff is present, generate button to get some
 122          * 3) Checkbox for "Send public notices (140 chars only)
 123          */
 124         $ckey    = get_config('twitter', 'consumerkey' );
 125         $csecret = get_config('twitter', 'consumersecret' );
 126         $otoken  = get_pconfig(local_user(), 'twitter', 'oauthtoken'  );
 127         $osecret = get_pconfig(local_user(), 'twitter', 'oauthsecret' );
 128         $enabled = get_pconfig(local_user(), 'twitter', 'post');
 129         $checked = (($enabled) ? ' checked="checked" ' : '');
 130         $s .= '<div class="settings-block">';
 131         $s .= '<h3>'. t('Twitter Posting Settings') .'</h3>';
 132
 133         if ( (!$ckey) && (!$csecret) ) {
 134                 /***
 135                  * no global consumer keys
 136                  * display warning and skip personal config
 137                  */
 138                 $s .= '<p>'. t('No consumer key pair for Twitter found. Please contact your site administrator.') .'</p>';
 139         } else {
 140                 /***
 141                  * ok we have a consumer key pair now look into the OAuth stuff
 142                  */
 143                 if ( (!$otoken) && (!$osecret) ) {
 144                         /***
 145                          * the user has not yet connected the account to twitter...
 146                          * get a temporary OAuth key/secret pair and display a button with
 147                          * which the user can request a PIN to connect the account to a
 148                          * account at Twitter.
 149                          */
 150                         require_once('library/twitteroauth.php');
 151                         $connection = new TwitterOAuth($ckey, $csecret);
 152                         $request_token = $connection->getRequestToken();
 153                         $token = $request_token['oauth_token'];
 154                         /***
 155                          *  make some nice form
 156                          */
 157                         $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>';
 158                         $s .= '<a href="'.$connection->getAuthorizeURL($token).'" target="_twitter"><img src="addon/twitter/lighter.png" alt="'.t('Log in with Twitter').'"></a>';
 159                         $s .= '<div id="twitter-pin-wrapper">';
 160                         $s .= '<label id="twitter-pin-label" for="twitter-pin">'. t('Copy the PIN from Twitter here') .'</label>';
 161                         $s .= '<input id="twitter-pin" type="text" name="twitter-pin" />';
 162                         $s .= '<input id="twitter-token" type="hidden" name="twitter-token" value="'.$token.'" />';
 163                         $s .= '<input id="twitter-token2" type="hidden" name="twitter-token2" value="'.$request_token['oauth_token_secret'].'" />';
 164             $s .= '</div><div class="clear"></div>';
 165             $s .= '<div class="settings-submit-wrapper" ><input type="submit" name="twitter-submit" class="settings-submit" value="' . t('Submit') . '" /></div>';
 166                 } else {
 167                         /***
 168                          *  we have an OAuth key / secret pair for the user
 169                          *  so let's give a chance to disable the postings to Twitter
 170                          */
 171                         require_once('library/twitteroauth.php');
 172                         $connection = new TwitterOAuth($ckey,$csecret,$otoken,$osecret);
 173                         $details = $connection->get('account/verify_credentials');
 174                         $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>';
 175                         $s .= '<p>'. t('If enabled all your <strong>public</strong> postings will be posted to the associated Twitter account as well.') .'</p>';
 176                         $s .= '<div id="twitter-enable-wrapper">';
 177                         $s .= '<label id="twitter-enable-label" for="twitter-checkbox">'. t('Send public postings to Twitter'). '</label>';
 178                         $s .= '<input id="twitter-checkbox" type="checkbox" name="twitter-enable" value="1" ' . $checked . '/>';
 179                         $s .= '</div><div class="clear"></div>';
 180                         $s .= '<div id="twitter-disconnect-wrapper">';
 181                         $s .= '<label id="twitter-disconnect-label" for="twitter-disconnect">'. t('Clear OAuth configuration') .'</label>';
 182                         $s .= '<input id="twitter-disconnect" type="checkbox" name="twitter-disconnect" value="1" />';
 183                         $s .= '</div><div class="clear"></div>';
 184                         $s .= '<div class="settings-submit-wrapper" ><input type="submit" name="twitter-submit" class="settings-submit" value="' . t('Submit') . '" /></div>';
 185                 }
 186         }
 187         $s .= '</div><div class="clear"></div></div>';
 188 }
 189
 190
 191 function twitter_post_hook(&$a,&$b) {
 192
 193         /**
 194          * Post to Twitter
 195          */
 196
 197         logger('twitter post invoked');
 198
 199         if((local_user()) && (local_user() == $b['uid']) && (! $b['private']) && (! $b['parent']) ) {
 200
 201                 // Twitter is not considered a private network
 202                 if($b['prvnets'])
 203                         return;
 204
 205
 206                 load_pconfig(local_user(), 'twitter');
 207
 208                 $ckey    = get_config('twitter', 'consumerkey'  );
 209                 $csecret = get_config('twitter', 'consumersecret' );
 210                 $otoken  = get_pconfig(local_user(), 'twitter', 'oauthtoken'  );
 211                 $osecret = get_pconfig(local_user(), 'twitter', 'oauthsecret' );
 212
 213                 if($ckey && $csecret && $otoken && $osecret) {
 214
 215                         $twitter_post = intval(get_pconfig(local_user(),'twitter','post'));
 216                         $twitter_enable = (($twitter_post && x($_POST,'twitter_enable')) ? intval($_POST['twitter_enable']) : 0);
 217
 218                         if($twitter_post && $twitter_enable) {
 219                                 logger('Posting to Twitter', LOGGER_DEBUG);
 220                                 require_once('library/twitteroauth.php');
 221                                 require_once('include/bbcode.php');
 222                                 $tweet = new TwitterOAuth($ckey,$csecret,$otoken,$osecret);
 223                                 $max_char = 140; // max. length for a tweet
 224                                 $msg = strip_tags(bbcode($b['body']));
 225                                 if ( strlen($msg) > $max_char) {
 226                                         $shortlink = "";
 227                                         require_once('library/slinky.php');
 228                                         // post url = base url + /display/ + owner + post id
 229                                         // we construct this from the Owner link and replace
 230                                         // profile by display - this will cause an error when
 231                                         // /profile/ is in the owner url twice but I don't
 232                                         // think this will be very common...
 233                                         $posturl = str_replace('/profile/','/display/',$b['owner-link']).'/'.$b['id'];
 234                                         $slinky = new Slinky( $posturl );
 235                                         // setup a cascade of shortening services
 236                                         // try to get a short link from these services
 237                                         // in the order ur1.ca, trim, id.gd, tinyurl
 238                                         $slinky->set_cascade( array( new Slinky_UR1ca(), new Slinky_Trim(), new Slinky_IsGd(), new Slinky_TinyURL() ) );
 239                                         $shortlink = $slinky->short();
 240                                         // the new message will be shortened such that "... $shortlink"
 241                                         // will fit into the character limit
 242                                         $msg = substr($msg, 0, $max_char-strlen($shortlink)-4);
 243                                         $msg .= '... ' . $shortlink;
 244                                 }
 245                 // and now tweet it :-)
 246                                 if(strlen($msg))
 247                                         $tweet->post('statuses/update', array('status' => $msg));
 248                         }
 249                 }
 250         }
 251 }
 252
 253 function twitter_plugin_admin_post(&$a){
 254         $consumerkey    =       ((x($_POST,'consumerkey'))              ? notags(trim($_POST['consumerkey']))   : '');
 255         $consumersecret =       ((x($_POST,'consumersecret'))   ? notags(trim($_POST['consumersecret'])): '');
 256         set_config('twitter','consumerkey',$consumerkey);
 257         set_config('twitter','consumersecret',$consumersecret);
 258         info( t('Settings updated.'). EOL );
 259 }
 260 function twitter_plugin_admin(&$a, &$o){
 261         $t = file_get_contents( dirname(__file__). "/admin.tpl" );
 262         $o = replace_macros($t, array(
 263                 '$submit' => t('Submit'),
 264                                                                 // name, label, value, help, [extra values]
 265                 '$consumerkey' => array('consumerkey', t('Consumer key'),  get_config('twitter', 'consumerkey' ), ''),
 266                 '$consumersecret' => array('consumersecret', t('Consumer secret'),  get_config('twitter', 'consumersecret' ), '')
 267         ));
 268 }