source: protocols/twitter/twitter.c @ 203a2d2

Last change on this file since 203a2d2 was 203a2d2, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-08-07T21:06:24Z

Allow protocol modules to keep per-contact protocol-specific data. Use
this in the Twitter module to remember the id and timestamp of a contact's
last tweet, which can later be used for simple replies/retweets.
  • Property mode set to 100644
File size: 13.3 KB
Line 
1/***************************************************************************\
2*                                                                           *
3*  BitlBee - An IRC to IM gateway                                           *
4*  Simple module to facilitate twitter functionality.                       *
5*                                                                           *
6*  Copyright 2009 Geert Mulders <g.c.w.m.mulders@gmail.com>                 *
7*                                                                           *
8*  This library is free software; you can redistribute it and/or            *
9*  modify it under the terms of the GNU Lesser General Public               *
10*  License as published by the Free Software Foundation, version            *
11*  2.1.                                                                     *
12*                                                                           *
13*  This library is distributed in the hope that it will be useful,          *
14*  but WITHOUT ANY WARRANTY; without even the implied warranty of           *
15*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU        *
16*  Lesser General Public License for more details.                          *
17*                                                                           *
18*  You should have received a copy of the GNU Lesser General Public License *
19*  along with this library; if not, write to the Free Software Foundation,  *
20*  Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA           *
21*                                                                           *
22****************************************************************************/
23
24#include "nogaim.h"
25#include "oauth.h"
26#include "twitter.h"
27#include "twitter_http.h"
28#include "twitter_lib.h"
29#include "url.h"
30
31/**
32 * Main loop function
33 */
34gboolean twitter_main_loop(gpointer data, gint fd, b_input_condition cond)
35{
36        struct im_connection *ic = data;
37       
38        // Check if we are still logged in...
39        if (!g_slist_find( twitter_connections, ic ))
40                return 0;
41
42        // Do stuff..
43        twitter_get_home_timeline(ic, -1);
44
45        // If we are still logged in run this function again after timeout.
46        return (ic->flags & OPT_LOGGED_IN) == OPT_LOGGED_IN;
47}
48
49static void twitter_main_loop_start( struct im_connection *ic )
50{
51        struct twitter_data *td = ic->proto_data;
52       
53        imcb_log( ic, "Getting initial statuses" );
54
55        // Run this once. After this queue the main loop function.
56        twitter_main_loop(ic, -1, 0);
57
58        // Queue the main_loop
59        // Save the return value, so we can remove the timeout on logout.
60        td->main_loop_id = b_timeout_add(60000, twitter_main_loop, ic);
61}
62
63static void twitter_oauth_start( struct im_connection *ic );
64
65void twitter_login_finish( struct im_connection *ic )
66{
67        struct twitter_data *td = ic->proto_data;
68       
69        if( set_getbool( &ic->acc->set, "oauth" ) && !td->oauth_info )
70                twitter_oauth_start( ic );
71        else if( g_strcasecmp( set_getstr( &ic->acc->set, "mode" ), "one" ) != 0 &&
72                 !( td->flags & TWITTER_HAVE_FRIENDS ) )
73        {
74                imcb_log( ic, "Getting contact list" );
75                twitter_get_statuses_friends( ic, -1 );
76        }
77        else
78                twitter_main_loop_start( ic );
79}
80
81static const struct oauth_service twitter_oauth =
82{
83        "http://api.twitter.com/oauth/request_token",
84        "http://api.twitter.com/oauth/access_token",
85        "https://api.twitter.com/oauth/authorize",
86        .consumer_key = "xsDNKJuNZYkZyMcu914uEA",
87        .consumer_secret = "FCxqcr0pXKzsF9ajmP57S3VQ8V6Drk4o2QYtqMcOszo",
88};
89
90static gboolean twitter_oauth_callback( struct oauth_info *info );
91
92static void twitter_oauth_start( struct im_connection *ic )
93{
94        struct twitter_data *td = ic->proto_data;
95       
96        imcb_log( ic, "Requesting OAuth request token" );
97
98        td->oauth_info = oauth_request_token( &twitter_oauth, twitter_oauth_callback, ic );
99}
100
101static gboolean twitter_oauth_callback( struct oauth_info *info )
102{
103        struct im_connection *ic = info->data;
104        struct twitter_data *td;
105       
106        if( !g_slist_find( twitter_connections, ic ) )
107                return FALSE;
108       
109        td = ic->proto_data;
110        if( info->stage == OAUTH_REQUEST_TOKEN )
111        {
112                char name[strlen(ic->acc->user)+9], *msg;
113               
114                if( info->request_token == NULL )
115                {
116                        imcb_error( ic, "OAuth error: %s", info->http->status_string );
117                        imc_logout( ic, TRUE );
118                        return FALSE;
119                }
120               
121                sprintf( name, "%s_%s", td->prefix, ic->acc->user );
122                msg = g_strdup_printf( "To finish OAuth authentication, please visit "
123                                       "%s and respond with the resulting PIN code.",
124                                       info->auth_url );
125                imcb_buddy_msg( ic, name, msg, 0, 0 );
126                g_free( msg );
127        }
128        else if( info->stage == OAUTH_ACCESS_TOKEN )
129        {
130                if( info->token == NULL || info->token_secret == NULL )
131                {
132                        imcb_error( ic, "OAuth error: %s", info->http->status_string );
133                        imc_logout( ic, TRUE );
134                        return FALSE;
135                }
136               
137                /* IM mods didn't do this so far and it's ugly but I should
138                   be able to get away with it... */
139                g_free( ic->acc->pass );
140                ic->acc->pass = oauth_to_string( info );
141               
142                twitter_login_finish( ic );
143        }
144       
145        return TRUE;
146}
147
148
149static char *set_eval_mode( set_t *set, char *value )
150{
151        if( g_strcasecmp( value, "one" ) == 0 ||
152            g_strcasecmp( value, "many" ) == 0 ||
153            g_strcasecmp( value, "chat" ) == 0 )
154                return value;
155        else
156                return NULL;
157}
158
159static gboolean twitter_length_check( struct im_connection *ic, gchar *msg )
160{
161        int max = set_getint( &ic->acc->set, "message_length" ), len;
162       
163        if( max == 0 || ( len = g_utf8_strlen( msg, -1 ) ) <= max )
164                return TRUE;
165       
166        imcb_error( ic, "Maximum message length exceeded: %d > %d", len, max );
167       
168        return FALSE;
169}
170
171static void twitter_init( account_t *acc )
172{
173        set_t *s;
174        char *def_url;
175        char *def_oauth;
176       
177        if( strcmp( acc->prpl->name, "twitter" ) == 0 )
178        {
179                def_url = TWITTER_API_URL;
180                def_oauth = "true";
181        }
182        else /* if( strcmp( acc->prpl->name, "identica" ) == 0 ) */
183        {
184                def_url = IDENTICA_API_URL;
185                def_oauth = "false";
186        }
187       
188        s = set_add( &acc->set, "base_url", def_url, NULL, acc );
189        s->flags |= ACC_SET_OFFLINE_ONLY;
190       
191        s = set_add( &acc->set, "commands", "true", set_eval_bool, acc );
192       
193        s = set_add( &acc->set, "message_length", "140", set_eval_int, acc );
194       
195        s = set_add( &acc->set, "mode", "one", set_eval_mode, acc );
196        s->flags |= ACC_SET_OFFLINE_ONLY;
197       
198        s = set_add( &acc->set, "oauth", def_oauth, set_eval_bool, acc );
199}
200
201/**
202 * Login method. Since the twitter API works with seperate HTTP request we
203 * only save the user and pass to the twitter_data object.
204 */
205static void twitter_login( account_t *acc )
206{
207        struct im_connection *ic = imcb_new( acc );
208        struct twitter_data *td;
209        char name[strlen(acc->user)+9];
210        url_t url;
211
212        if( !url_set( &url, set_getstr( &ic->acc->set, "base_url" ) ) ||
213            ( url.proto != PROTO_HTTP && url.proto != PROTO_HTTPS ) )
214        {
215                imcb_error( ic, "Incorrect API base URL: %s", set_getstr( &ic->acc->set, "base_url" ) );
216                imc_logout( ic, FALSE );
217                return;
218        }
219       
220        twitter_connections = g_slist_append( twitter_connections, ic );
221        td = g_new0( struct twitter_data, 1 );
222        ic->proto_data = td;
223       
224        td->url_ssl = url.proto == PROTO_HTTPS;
225        td->url_port = url.port;
226        td->url_host = g_strdup( url.host );
227        if( strcmp( url.file, "/" ) != 0 )
228                td->url_path = g_strdup( url.file );
229        else
230                td->url_path = g_strdup( "" );
231        if( g_str_has_suffix( url.host, ".com" ) )
232                td->prefix = g_strndup( url.host, strlen( url.host ) - 4 );
233        else
234                td->prefix = g_strdup( url.host );
235       
236        td->user = acc->user;
237        if( strstr( acc->pass, "oauth_token=" ) )
238                td->oauth_info = oauth_from_string( acc->pass, &twitter_oauth );
239       
240        sprintf( name, "%s_%s", td->prefix, acc->user );
241        imcb_add_buddy( ic, name, NULL );
242        imcb_buddy_status( ic, name, OPT_LOGGED_IN, NULL, NULL );
243       
244        imcb_log( ic, "Connecting" );
245       
246        twitter_login_finish( ic );
247}
248
249/**
250 * Logout method. Just free the twitter_data.
251 */
252static void twitter_logout( struct im_connection *ic )
253{
254        struct twitter_data *td = ic->proto_data;
255       
256        // Set the status to logged out.
257        ic->flags = 0;
258
259        // Remove the main_loop function from the function queue.
260        b_event_remove(td->main_loop_id);
261
262        if(td->home_timeline_gc)
263                imcb_chat_free(td->home_timeline_gc);
264
265        if( td )
266        {
267                oauth_info_free( td->oauth_info );
268                g_free( td->prefix );
269                g_free( td->url_host );
270                g_free( td->url_path );
271                g_free( td->pass );
272                g_free( td );
273        }
274
275        twitter_connections = g_slist_remove( twitter_connections, ic );
276}
277
278static void twitter_handle_command( struct im_connection *ic, char *message );
279
280/**
281 *
282 */
283static int twitter_buddy_msg( struct im_connection *ic, char *who, char *message, int away )
284{
285        struct twitter_data *td = ic->proto_data;
286        int plen = strlen( td->prefix );
287       
288        if (g_strncasecmp(who, td->prefix, plen) == 0 && who[plen] == '_' &&
289            g_strcasecmp(who + plen + 1, ic->acc->user) == 0)
290        {
291                if( set_getbool( &ic->acc->set, "oauth" ) &&
292                    td->oauth_info && td->oauth_info->token == NULL )
293                {
294                        char pin[strlen(message)+1], *s;
295                       
296                        strcpy( pin, message );
297                        for( s = pin + sizeof( pin ) - 2; s > pin && isspace( *s ); s -- )
298                                *s = '\0';
299                        for( s = pin; *s && isspace( *s ); s ++ ) {}
300                       
301                        if( !oauth_access_token( s, td->oauth_info ) )
302                        {
303                                imcb_error( ic, "OAuth error: %s", "Failed to send access token request" );
304                                imc_logout( ic, TRUE );
305                                return FALSE;
306                        }
307                }
308                else
309                        twitter_handle_command(ic, message);
310        }
311        else
312        {
313                twitter_direct_messages_new(ic, who, message);
314        }
315        return( 0 );
316}
317
318/**
319 *
320 */
321static void twitter_set_my_name( struct im_connection *ic, char *info )
322{
323}
324
325static void twitter_get_info(struct im_connection *ic, char *who) 
326{
327}
328
329static void twitter_add_buddy( struct im_connection *ic, char *who, char *group )
330{
331        twitter_friendships_create_destroy(ic, who, 1);
332}
333
334static void twitter_remove_buddy( struct im_connection *ic, char *who, char *group )
335{
336        twitter_friendships_create_destroy(ic, who, 0);
337}
338
339static void twitter_chat_msg( struct groupchat *c, char *message, int flags )
340{
341        if( c && message )
342                twitter_handle_command( c->ic, message );
343}
344
345static void twitter_chat_invite( struct groupchat *c, char *who, char *message )
346{
347}
348
349static void twitter_chat_leave( struct groupchat *c )
350{
351        struct twitter_data *td = c->ic->proto_data;
352       
353        if( c != td->home_timeline_gc )
354                return; /* WTF? */
355       
356        /* If the user leaves the channel: Fine. Rejoin him/her once new
357           tweets come in. */
358        imcb_chat_free(td->home_timeline_gc);
359        td->home_timeline_gc = NULL;
360}
361
362static struct groupchat *twitter_chat_with( struct im_connection *ic, char *who )
363{
364        return NULL;
365}
366
367static void twitter_keepalive( struct im_connection *ic )
368{
369}
370
371static void twitter_add_permit( struct im_connection *ic, char *who )
372{
373}
374
375static void twitter_rem_permit( struct im_connection *ic, char *who )
376{
377}
378
379static void twitter_add_deny( struct im_connection *ic, char *who )
380{
381}
382
383static void twitter_rem_deny( struct im_connection *ic, char *who )
384{
385}
386
387static int twitter_send_typing( struct im_connection *ic, char *who, int typing )
388{
389        return( 1 );
390}
391
392//static char *twitter_set_display_name( set_t *set, char *value )
393//{
394//      return value;
395//}
396
397static void twitter_buddy_data_add( struct bee_user *bu )
398{
399        bu->data = g_new0( struct twitter_user_data, 1 );
400}
401
402static void twitter_buddy_data_free( struct bee_user *bu )
403{
404        g_free( bu->data );
405}
406
407static void twitter_handle_command( struct im_connection *ic, char *message )
408{
409        struct twitter_data *td = ic->proto_data;
410        char *cmds, **cmd;
411       
412        cmds = g_strdup( message );
413        cmd = split_command_parts( cmds );
414       
415        if( cmd[0] == NULL )
416        {
417                g_free( cmds );
418                return;
419        }
420        else if( !set_getbool( &ic->acc->set, "commands" ) )
421        {
422                /* Not supporting commands. */
423        }
424        else if( g_strcasecmp( cmd[0], "undo" ) == 0 )
425        {
426                guint64 id;
427               
428                if( cmd[1] )
429                {
430                        char *end = NULL;
431                       
432                        id = g_ascii_strtoull( cmd[1], &end, 10 );
433                        if( end == NULL )
434                                id = 0;
435                }
436                else
437                        id = td->last_status_id;
438               
439                /* TODO: User feedback. */
440                if( id )
441                        twitter_status_destroy( ic, id );
442               
443                g_free( cmds );
444                return;
445        }
446        else if( g_strcasecmp( cmd[0], "post" ) == 0 )
447        {
448                message += 5;
449        }
450       
451        {
452                char *s, *new = NULL;
453                bee_user_t *bu;
454               
455                if( !twitter_length_check( ic, message ) )
456                {
457                        g_free( cmds );
458                        return;
459                }
460               
461                s = cmd[0] + strlen( cmd[0] ) - 1;
462                if( s > cmd[0] && ( *s == ':' || *s == ',' ) )
463                {
464                        *s = '\0';
465                       
466                        if( ( bu = bee_user_by_handle( ic->bee, ic, cmd[0] ) ) )
467                        {
468                                new = g_strdup_printf( "@%s %s", bu->handle,
469                                                       message + ( s - cmd[0] ) + 2 );
470                                message = new;
471                        }
472                }
473               
474                twitter_post_status( ic, message );
475                g_free( new );
476        }
477        g_free( cmds );
478}
479
480void twitter_initmodule()
481{
482        struct prpl *ret = g_new0(struct prpl, 1);
483       
484        ret->name = "twitter";
485        ret->login = twitter_login;
486        ret->init = twitter_init;
487        ret->logout = twitter_logout;
488        ret->buddy_msg = twitter_buddy_msg;
489        ret->get_info = twitter_get_info;
490        ret->set_my_name = twitter_set_my_name;
491        ret->add_buddy = twitter_add_buddy;
492        ret->remove_buddy = twitter_remove_buddy;
493        ret->chat_msg = twitter_chat_msg;
494        ret->chat_invite = twitter_chat_invite;
495        ret->chat_leave = twitter_chat_leave;
496        ret->chat_with = twitter_chat_with;
497        ret->keepalive = twitter_keepalive;
498        ret->add_permit = twitter_add_permit;
499        ret->rem_permit = twitter_rem_permit;
500        ret->add_deny = twitter_add_deny;
501        ret->rem_deny = twitter_rem_deny;
502        ret->send_typing = twitter_send_typing;
503        ret->buddy_data_add = twitter_buddy_data_add;
504        ret->buddy_data_free = twitter_buddy_data_free;
505        ret->handle_cmp = g_strcasecmp;
506       
507        register_protocol(ret);
508
509        /* And an identi.ca variant: */
510        ret = g_memdup(ret, sizeof(struct prpl));
511        ret->name = "identica";
512        register_protocol(ret);
513
514        // Initialise the twitter_connections GSList.
515        twitter_connections = NULL;
516}
Note: See TracBrowser for help on using the repository browser.