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