From fd6116296efd4dc9168b3fefa6ba586d83a1a454 Mon Sep 17 00:00:00 2001 From: Tobias Diekershoff Date: Sun, 6 Feb 2011 17:27:16 +0100 Subject: [PATCH] Post to Twitter plugin With this plugin a user can choose to post every _public_ message that s/he posts on Friendika also on Twitter. The message will be shortened to if longer then 140 characters in length. If shortened a link to the original posting will be append to the Twitter posting. --- addon/twitter/lighter.png | Bin 0 -> 2490 bytes addon/twitter/twitter.css | 41 +++++++++ addon/twitter/twitter.php | 185 ++++++++++++++++++++++++++++++++++++-- 3 files changed, 220 insertions(+), 6 deletions(-) create mode 100644 addon/twitter/lighter.png create mode 100644 addon/twitter/twitter.css diff --git a/addon/twitter/lighter.png b/addon/twitter/lighter.png new file mode 100644 index 0000000000000000000000000000000000000000..297bb03404f2d7462ee9355aae38f5f5f3e47fbd GIT binary patch literal 2490 zcmV;r2}SmaP)dbVG7wVRUJ4ZXi@?ZDjy8FEKeU zFgbGL({lg-0338hSaefwW^{L9a%BKPWN%_+AVz6&Wp{6KYjYq&Q#1y$)1UwV2@^>~ zK~!jg?VEdWl+_u=f8X9WA)72QVM!vF1VSK4AZQ?nK}o}NseS3JN$f zgRQMIo!W~OJ6`ZouvAJ_K&eH%O=zU35Dd9+OGJ}EvYTu++57IdU;kJVc9XpY6B?a; zX3k{ZIp=-eC+|7m`<-)kR{+>vQ7sWi9D|5ebEgWz_KIq$s4!>9f*d_|j-lj_V|e1| zv2!Q@e7>PCTvsDT9K#C=07>!<2 zJRT3v{^4m(e0B`AMuXes=AQD^+;C$tPj22q>4H*zdfz>`#KAid3>9xAeo+*W%jE#P zv+pgwyLbU*^X6iX@D|vxdJPV{BV^y=rMIzo>FtA}CzL%H7|@3PC-uR0k{o`MEpT&+ zmiCUwd$DjaD&G5mR^R=5Ugy>A zFL6`pd;osE=`rd~)-ZEc5shchvh}x5aZ~9nJpS;;UjCggyhMFX4IM@k^;K2OnpeX9 zJ+G59W-M>Ndx+<@J`*QB2?^MN1N-(fead7?=HEi6T!B@Box5IR=L;`>Ej{PX zHuTf??pp_V_K#2V&%f=WuDXUP)2>6K(eP;bS}ruV@b7*5sr;ydIrB8I2tIsDgsYdEB~aA*X6k7? zxX|2;qp^|Gwe@`Y#d&IupCC)EqUw`l7)GU&uTKu*U$o?QG#U*z%qZYj8`hDRoCLu8 zhbzgOI5DbLyT^;&?d{E@=<{Loc(HlBWQ@7?YwIarxgyB6oH@guS9eiXI-mWozJlq( z1uEY@fC2%N(MZ*iqs%Lw&3$(-XHs%f#Ci8GF3A_N^~J`q@N(Yec4#`>p8;Rm>`^(w z^()mX);zY6A1}KTOQ(hBpZ+tI2M_vvC6EgOasg^TuSW9u`2L~=xMTvlF=IdirA&q( z01}jz+(`M#6-+Id=Jypvl2wZSngV!x>{xvBuA7QRt)c4kYU--0D3~!Fhr>aA^+`_G z)iHDWG@POs#IMsQgCL+*sYp&si#>KieJ zAZPaXZl!3>9M-SjNX7dfvh?=bdf)$&1YWO*1jqy#ZFVPakM~lt{ns24pi(Mnce*e+ zoV|U5)IWA0uWtapa=C)>xf3{EU4zZ(WX19y(%RC@hySVMd_x1@*}REPr@KGD1PCBr zszd|P3jULJU(P|*6JUEpf1ZUYMN@b5y{gO~R0`R^ zzo2^1b1iYS>vBugsL9qPM&yVTyCwWp(Uo=ev@y*W7rS{ZmOePbh#j}_&X%YtxeZa(=9L5<&(e8Bi z<5wsYm^&^0MKr*8(egMLdIIf9`S}2Jn9Y=xl~T570XoAdF4!DlHH6a}anEJ-cv*VQ z<;7KRgYq-}Q)5qi@;qcECS38JtLDV#Y+3g(n;(3LUp}&dB%O}ct5)I-xFV2%>k11g zTUf@C&yKTa*KVdw^(R50loR*{_b2SKCHeZt4jkLpj^;ZlKOe6sQZ!>aT9uM(b0*;N zdYL_=0IS=B(gj7|CTgIo3w=s5DLNgUE;lDl z=6*ck(9~r1FRqNt5);TzP2p%4ylH~wfExv!+`pk8s}?!j(i+mgrP)GJVGd2L zrifxR3OQ=I9MLCX4Ray;#3LJ#2{HtkfT^vG#S0hk#JUIhwAC2&WDQrS)2nfk*V=iQ!Y2K(sVlqHpM%x^1{ck;y4Kin5jc`W;@8<8AFx4+YWs z?QSo2A}4+Q<6F?#y0F{rconfig['twitter']['consumerkey'] = 'your consumer_key here'; + * $a->config['twitter']['consumersecret'] = 'your consumer_secret here'; + * + * To activate the plugin itself add it to the $a->config['system']['addon'] + * setting. After this, your user can configure their Twitter account settings + * from "Settings -> Plugin Settings". + * + * Documentation: http://diekershoff.homeunix.net/redmine/wiki/friendikaplugin/Twitter_Plugin + */ + +/* __TODO__ + * + * - deletion of the OAuth credentials does not work + * - include short links to the original posting if possible + * - what about multimedia content? + * so far we just strip HTML tags from the message + * - after entering the PIN reload page propperly + */ function twitter_install() { + // we need some hooks, for the configuration and for sending tweets + register_hook('plugin_settings', 'addon/twitter/twitter.php', 'twitter_settings'); + register_hook('plugin_settings_post', 'addon/twitter/twitter.php', 'twitter_settings_post'); register_hook('post_local_end', 'addon/twitter/twitter.php', 'twitter_post_hook'); + logger("installed twitter"); } function twitter_uninstall() { + unregister_hook('plugin_settings', 'addon/twitter/twitter.php', 'twitter_settings'); + unregister_hook('plugin_settings_post', 'addon/twitter/twitter.php', 'twitter_settings_post'); unregister_hook('post_local_end', 'addon/twitter/twitter.php', 'twitter_post_hook'); } +function twitter_settings_post ($a,$post) { + if(! local_user()) + return; + if (isset($_POST['twitter-disconnect'])) { + /*** + * if the twitter-disconnect checkbox is set, clear the OAuth key/secret pair + * from the user configuration + * TODO this does not work that way!? + * TODO can we revoke the access tokens at Twitter and do we need to do so? + */ + del_pconfig( local_user(), 'twitter', 'consumerkey' ); + del_pconfig( local_user(), 'twitter', 'consumersecret' ); + del_pconfig( local_user(), 'twitter', 'post' ); + } else { + if (isset($_POST['twitter-pin'])) { + // if the user supplied us with a PIN from Twitter, let the magic of OAuth happen + logger('got a Twitter PIN'); + require_once('addon/twitter/twitteroauth.php'); + $ckey = get_config('twitter', 'consumerkey' ); + $csecret = get_config('twitter', 'consumersecret' ); + // the token and secret for which the PIN was generated were hidden in the settings + // form as token and token2, we need a new connection to Twitter using these token + // and secret to request a Access Token with the PIN + $connection = new TwitterOAuth($ckey, $csecret, $_POST['twitter-token'], $_POST['twitter-token2']); + $token = $connection->getAccessToken( $_POST['twitter-pin'] ); + // ok, now that we have the Access Token, save them in the user config + set_pconfig(local_user(),'twitter', 'oauthtoken', $token['oauth_token']); + set_pconfig(local_user(),'twitter', 'oauthsecret', $token['oauth_token_secret']); + set_pconfig(local_user(),'twitter', 'post', 1); + // reload the Addon Settings page, if we don't do it see Bug #42 + header('Location: '.$a->get_baseurl().'/settings/addon'); + } else { + // if no PIN is supplied in the POST variables, the user has changed the setting + // to post a tweet for every new __public__ posting to the wall + set_pconfig(local_user(),'twitter','post',intval($_POST['twitter'])); + }} +} +function twitter_settings(&$a,&$s) { + if(! local_user()) + return; + $a->page['htmlhead'] .= '' . "\r\n"; + /*** + * 1) Check that we have global consumer key & secret + * 2) If no OAuthtoken & stuff is present, generate button to get some + * 3) Checkbox for "Send public notices (140 chars only) + */ + $ckey = get_config('twitter', 'consumerkey' ); + $csecret = get_config('twitter', 'consumersecret' ); + $otoken = get_pconfig(local_user(), 'twitter', 'oauthtoken' ); + $osecret = get_pconfig(local_user(), 'twitter', 'oauthsecret' ); + $enabled = get_pconfig(local_user(), 'twitter', 'post'); + $checked = (($enabled) ? ' checked="checked" ' : ''); + $s .= '

'.t('Twitter Posting Settings').'

'; + if ( (!$ckey) && (!$csecret) ) { + /*** + * no global consumer keys + * display warning and skip personal config + */ + $s .= '

'.t('No consumer key pair for Twitter found. Please contact your site administrator.').'

'; + } else { + /*** + * ok we have a consumer key pair now look into the OAuth stuff + */ + if ( (!$otoken) && (!$osecret) ) { + /*** + * the user has not yet connected the account to twitter... + * get a temporary OAuth key/secret pair and display a button with + * which the user can request a PIN to connect the account to a + * account at Twitter. + */ + require_once('addon/twitter/twitteroauth.php'); + $connection = new TwitterOAuth($ckey, $csecret); + $request_token = $connection->getRequestToken(); + $token = $request_token['oauth_token']; + /*** + * make some nice form + */ + $s .= '

'.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 public posts will be posted to Twitter.').'

'; + $s .= ''.t('Log in with Twitter').'></a>'; + $s .= '<div id='; + $s .= ''; + $s .= ''; + $s .= ''; + $s .= ''; + $s .= '
'; + $s .= '
'; + } else { + /*** + * we have an OAuth key / secret pair for the user + * so let's give a chance to disable the postings to Twitter + */ + require_once('addon/twitter/twitteroauth.php'); + $connection = new TwitterOAuth($ckey,$csecret,$otoken,$osecret); + $details = $connection->get('account/verify_credentials'); + $s .= ''; + $s .= '

'.t('If enabled all your public postings will be posted to the associated Twitter account as well.').'

'; + $s .= '
'; + $s .= ''; + $s .= ''; + $s .= '
'; + $s .= '
'; + $s .= ''; + $s .= ''; + $s .= '
'; + $s .= '
'; + } + } + $s .= '
'; +} function twitter_post_hook(&$a,&$b) { @@ -19,12 +169,14 @@ function twitter_post_hook(&$a,&$b) { * Post to Twitter */ + logger('twitter post invoked'); + if((local_user()) && (local_user() == $b['uid']) && (! $b['private'])) { load_pconfig(local_user(), 'twitter'); - $ckey = get_pconfig(local_user(), 'twitter', 'consumerkey' ); - $csecret = get_pconfig(local_user(), 'twitter', 'consumersecret' ); + $ckey = get_config('twitter', 'consumerkey' ); + $csecret = get_config('twitter', 'consumersecret' ); $otoken = get_pconfig(local_user(), 'twitter', 'oauthtoken' ); $osecret = get_pconfig(local_user(), 'twitter', 'oauthsecret' ); @@ -35,12 +187,33 @@ function twitter_post_hook(&$a,&$b) { if($twitter_post) { require_once('addon/twitter/twitteroauth.php'); require_once('include/bbcode.php'); - $tweet = new TwitterOAuth($ckey,$csecret,$otoken,$osecret); - $tweet->post('statuses/update', array('status' => bbcode($b['body']))); + $max_char = 140; // max. length for a tweet + $msg = strip_tags(bbcode($b['body'])); + if ( strlen($msg) > $max_char) { + $shortlink = ""; + require_once('addon/twitter/slinky.php'); + // post url = base url + /display/ + owner + post id + // we construct this from the Owner link and replace + // profile by display - this will cause an error when + // /profile/ is in the owner url twice but I don't + // think this will be very common... + $posturl = str_replace('/profile/','/display/',$b['owner-link']).'/'.$b['id']; + $slinky = new Slinky( $posturl ); + // setup a cascade of shortening services + // try to get a short link from these services + // in the order ur1.ca, trim, id.gd, tinyurl + $slinky->set_cascade( array( new Slinky_UR1ca(), new Slinky_Trim(), new Slinky_IsGd(), new Slinky_TinyURL() ) ); + $shortlink = $slinky->short(); + // the new message will be shortened such that "... $shortlink" + // will fit into the character limit + $msg = substr($msg, 0, $max_char-strlen($shortlink)-4); + $msg .= '... ' . $shortlink; + } + // and now tweet it :-) + $tweet->post('statuses/update', array('status' => $msg)); } } - } + } } -