source: protocols/twitter/twitter_lib.c @ 40bc82d

/***************************************************************************\
*                                                                           *
*  BitlBee - An IRC to IM gateway                                           *
*  Simple module to facilitate twitter functionality.                       *
*                                                                           *
*  Copyright 2009 Geert Mulders <g.c.w.m.mulders@gmail.com>                 *
*                                                                           *
*  This library is free software; you can redistribute it and/or            *
*  modify it under the terms of the GNU Lesser General Public               *
*  License as published by the Free Software Foundation, version            *
*  2.1.                                                                     *
*                                                                           *
*  This library is distributed in the hope that it will be useful,          *
*  but WITHOUT ANY WARRANTY; without even the implied warranty of           *
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU        *
*  Lesser General Public License for more details.                          *
*                                                                           *
*  You should have received a copy of the GNU Lesser General Public License *
*  along with this library; if not, write to the Free Software Foundation,  *
*  Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA           *
*                                                                           *
****************************************************************************/

/* For strptime(): */
#define _XOPEN_SOURCE

#include "twitter_http.h"
#include "twitter.h"
#include "bitlbee.h"
#include "url.h"
#include "misc.h"
#include "base64.h"
#include "xmltree.h"
#include "twitter_lib.h"
#include <ctype.h>
#include <errno.h>

#define TXL_STATUS 1
#define TXL_USER 2
#define TXL_ID 3

struct twitter_xml_list {
        int type;
        int next_cursor;
        GSList *list;
        gpointer data;
};

struct twitter_xml_user {
        char *name;
        char *screen_name;
};

struct twitter_xml_status {
        time_t created_at;
        char *text;
        struct twitter_xml_user *user;
        guint64 id;
};

/**
 * Frees a twitter_xml_user struct.
 */
static void txu_free(struct twitter_xml_user *txu)
{
        g_free(txu->name);
        g_free(txu->screen_name);
        g_free(txu);
}


/**
 * Frees a twitter_xml_status struct.
 */
static void txs_free(struct twitter_xml_status *txs)
{
        g_free(txs->text);
        txu_free(txs->user);
        g_free(txs);
}

/**
 * Free a twitter_xml_list struct.
 * type is the type of list the struct holds.
 */
static void txl_free(struct twitter_xml_list *txl)
{
        GSList *l;
        for ( l = txl->list; l ; l = g_slist_next(l) )
                if (txl->type == TXL_STATUS)
                        txs_free((struct twitter_xml_status *)l->data);
                else if (txl->type == TXL_ID)
                        g_free(l->data);
        g_slist_free(txl->list);
}

/**
 * Add a buddy if it is not allready added, set the status to logged in.
 */
static void twitter_add_buddy(struct im_connection *ic, char *name, const char *fullname)
{
        struct twitter_data *td = ic->proto_data;

        // Check if the buddy is allready in the buddy list.
        if (!imcb_find_buddy( ic, name ))
        {
                // The buddy is not in the list, add the buddy and set the status to logged in.
                imcb_add_buddy( ic, name, NULL );
                imcb_rename_buddy( ic, name, fullname );
                if (set_getbool( &ic->acc->set, "use_groupchat" ))
                        imcb_chat_add_buddy( td->home_timeline_gc, name );
                else
                        imcb_buddy_status( ic, name, OPT_LOGGED_IN, NULL, NULL );
        }
}

static void twitter_http_get_friends_ids(struct http_request *req);

/**
 * Get the friends ids.
 */
void twitter_get_friends_ids(struct im_connection *ic, int next_cursor)
{
        struct twitter_data *td = ic->proto_data;

        // Primitive, but hey! It works...      
        char* args[2];
        args[0] = "cursor";
        args[1] = g_strdup_printf ("%d", next_cursor);
        twitter_http(TWITTER_FRIENDS_IDS_URL, twitter_http_get_friends_ids, ic, 0, td->user, td->pass, args, 2);

        g_free(args[1]);
}

/**
 * Function to help fill a list.
 */
static xt_status twitter_xt_next_cursor( struct xt_node *node, struct twitter_xml_list *txl )
{
        // Do something with the cursor.
        txl->next_cursor = node->text != NULL ? atoi(node->text) : -1;

        return XT_HANDLED;
}

/**
 * Fill a list of ids.
 */
static xt_status twitter_xt_get_friends_id_list( struct xt_node *node, struct twitter_xml_list *txl )
{
        struct xt_node *child;
        
        // Set the list type.
        txl->type = TXL_ID;

        // The root <statuses> node should hold the list of statuses <status>
        // Walk over the nodes children.
        for( child = node->children ; child ; child = child->next )
        {
                if ( g_strcasecmp( "id", child->name ) == 0)
                {
                        // Add the item to the list.
                        txl->list = g_slist_append (txl->list, g_memdup( child->text, child->text_len + 1 ));
                }
                else if ( g_strcasecmp( "next_cursor", child->name ) == 0)
                {
                        twitter_xt_next_cursor(child, txl);
                }
        }

        return XT_HANDLED;
}

/**
 * Callback for getting the friends ids.
 */
static void twitter_http_get_friends_ids(struct http_request *req)
{
        struct im_connection *ic;
        struct xt_parser *parser;
        struct twitter_xml_list *txl;
        struct twitter_data *td;

        ic = req->data;

        // Check if the connection is still active.
        if( !g_slist_find( twitter_connections, ic ) )
                return;
        
        td = ic->proto_data;

        // Check if the HTTP request went well.
        if (req->status_code != 200) {
                // It didn't go well, output the error and return.
                if (++td->http_fails >= 5)
                        imcb_error(ic, "Could not retrieve friends. HTTP STATUS: %d", req->status_code);
                
                return;
        } else {
                td->http_fails = 0;
        }

        txl = g_new0(struct twitter_xml_list, 1);

        // Parse the data.
        parser = xt_new( NULL, txl );
        xt_feed( parser, req->reply_body, req->body_size );
        twitter_xt_get_friends_id_list(parser->root, txl);
        xt_free( parser );

        if (txl->next_cursor)
                twitter_get_friends_ids(ic, txl->next_cursor);

        txl_free(txl);
        g_free(txl);
}

/**
 * Function to fill a twitter_xml_user struct.
 * It sets:
 *  - the name and
 *  - the screen_name.
 */
static xt_status twitter_xt_get_user( struct xt_node *node, struct twitter_xml_user *txu )
{
        struct xt_node *child;

        // Walk over the nodes children.
        for( child = node->children ; child ; child = child->next )
        {
                if ( g_strcasecmp( "name", child->name ) == 0)
                {
                        txu->name = g_memdup( child->text, child->text_len + 1 );
                }
                else if (g_strcasecmp( "screen_name", child->name ) == 0)
                {
                        txu->screen_name = g_memdup( child->text, child->text_len + 1 );
                }
        }
        return XT_HANDLED;
}

/**
 * Function to fill a twitter_xml_list struct.
 * It sets:
 *  - all <user>s from the <users> element.
 */
static xt_status twitter_xt_get_users( struct xt_node *node, struct twitter_xml_list *txl )
{
        struct twitter_xml_user *txu;
        struct xt_node *child;

        // Set the type of the list.
        txl->type = TXL_USER;

        // The root <users> node should hold the list of users <user>
        // Walk over the nodes children.
        for( child = node->children ; child ; child = child->next )
        {
                if ( g_strcasecmp( "user", child->name ) == 0)
                {
                        txu = g_new0(struct twitter_xml_user, 1);
                        twitter_xt_get_user(child, txu);
                        // Put the item in the front of the list.
                        txl->list = g_slist_prepend (txl->list, txu);
                }
        }

        return XT_HANDLED;
}

/**
 * Function to fill a twitter_xml_list struct.
 * It calls twitter_xt_get_users to get the <user>s from a <users> element.
 * It sets:
 *  - the next_cursor.
 */
static xt_status twitter_xt_get_user_list( struct xt_node *node, struct twitter_xml_list *txl )
{
        struct xt_node *child;

        // Set the type of the list.
        txl->type = TXL_USER;

        // The root <user_list> node should hold a users <users> element
        // Walk over the nodes children.
        for( child = node->children ; child ; child = child->next )
        {
                if ( g_strcasecmp( "users", child->name ) == 0)
                {
                        twitter_xt_get_users(child, txl);
                }
                else if ( g_strcasecmp( "next_cursor", child->name ) == 0)
                {
                        twitter_xt_next_cursor(child, txl);
                }
        }

        return XT_HANDLED;
}


/**
 * Function to fill a twitter_xml_status struct.
 * It sets:
 *  - the status text and
 *  - the created_at timestamp and
 *  - the status id and
 *  - the user in a twitter_xml_user struct.
 */
static xt_status twitter_xt_get_status( struct xt_node *node, struct twitter_xml_status *txs )
{
        struct xt_node *child;

        // Walk over the nodes children.
        for( child = node->children ; child ; child = child->next )
        {
                if ( g_strcasecmp( "text", child->name ) == 0)
                {
                        txs->text = g_memdup( child->text, child->text_len + 1 );
                }
                else if (g_strcasecmp( "created_at", child->name ) == 0)
                {
                        struct tm parsed;
                        
                        /* Very sensitive to changes to the formatting of
                           this field. :-( Also assumes the timezone used
                           is UTC since C time handling functions suck. */
                        if( strptime( child->text, "%a %b %d %H:%M:%S %z %Y", &parsed ) != NULL )
                                txs->created_at = mktime_utc( &parsed );
                }
                else if (g_strcasecmp( "user", child->name ) == 0)
                {
                        txs->user = g_new0(struct twitter_xml_user, 1);
                        twitter_xt_get_user( child, txs->user );
                }
                else if (g_strcasecmp( "id", child->name ) == 0)
                {
                        txs->id = g_ascii_strtoull (child->text, NULL, 10);
                }
        }
        return XT_HANDLED;
}

/**
 * Function to fill a twitter_xml_list struct.
 * It sets:
 *  - all <status>es within the <status> element and
 *  - the next_cursor.
 */
static xt_status twitter_xt_get_status_list( struct xt_node *node, struct twitter_xml_list *txl )
{
        struct twitter_xml_status *txs;
        struct xt_node *child;

        // Set the type of the list.
        txl->type = TXL_STATUS;

        // The root <statuses> node should hold the list of statuses <status>
        // Walk over the nodes children.
        for( child = node->children ; child ; child = child->next )
        {
                if ( g_strcasecmp( "status", child->name ) == 0)
                {
                        txs = g_new0(struct twitter_xml_status, 1);
                        twitter_xt_get_status(child, txs);
                        // Put the item in the front of the list.
                        txl->list = g_slist_prepend (txl->list, txs);
                }
                else if ( g_strcasecmp( "next_cursor", child->name ) == 0)
                {
                        twitter_xt_next_cursor(child, txl);
                }
        }

        return XT_HANDLED;
}

static void twitter_http_get_home_timeline(struct http_request *req);

/**
 * Get the timeline.
 */
void twitter_get_home_timeline(struct im_connection *ic, int next_cursor)
{
        struct twitter_data *td = ic->proto_data;

        char* args[4];
        args[0] = "cursor";
        args[1] = g_strdup_printf ("%d", next_cursor);
        if (td->home_timeline_id) {
                args[2] = "since_id";
                args[3] = g_strdup_printf ("%llu", (long long unsigned int) td->home_timeline_id);
        }

        twitter_http(TWITTER_HOME_TIMELINE_URL, twitter_http_get_home_timeline, ic, 0, td->user, td->pass, args, td->home_timeline_id ? 4 : 2);

        g_free(args[1]);
        if (td->home_timeline_id) {
                g_free(args[3]);
        }
}

/**
 * Function that is called to see the statuses in a groupchat window.
 */
static void twitter_groupchat(struct im_connection *ic, GSList *list)
{
        struct twitter_data *td = ic->proto_data;
        GSList *l = NULL;
        struct twitter_xml_status *status;
        struct groupchat *gc;

        // Create a new groupchat if it does not exsist.
        if (!td->home_timeline_gc)
        {   
                char *name_hint = g_strdup_printf( "Twitter_%s", ic->acc->user );
                td->home_timeline_gc = gc = imcb_chat_new( ic, "home/timeline" );
                imcb_chat_name_hint( gc, name_hint );
                g_free( name_hint );
                // Add the current user to the chat...
                imcb_chat_add_buddy( gc, ic->acc->user );
        }
        else
        {   
                gc = td->home_timeline_gc;
        }

        for ( l = list; l ; l = g_slist_next(l) )
        {
                status = l->data;
                twitter_add_buddy(ic, status->user->screen_name, status->user->name);
                
                // Say it!
                if (g_strcasecmp(td->user, status->user->screen_name) == 0)
                        imcb_chat_log (gc, "Your Tweet: %s", status->text);
                else
                        imcb_chat_msg (gc, status->user->screen_name, status->text, 0, status->created_at );
                
                // Update the home_timeline_id to hold the highest id, so that by the next request
                // we won't pick up the updates allready in the list.
                td->home_timeline_id = td->home_timeline_id < status->id ? status->id : td->home_timeline_id;
        }
}

/**
 * Function that is called to see statuses as private messages.
 */
static void twitter_private_message_chat(struct im_connection *ic, GSList *list)
{
        struct twitter_data *td = ic->proto_data;
        GSList *l = NULL;
        struct twitter_xml_status *status;

        for ( l = list; l ; l = g_slist_next(l) )
        {
                status = l->data;
                imcb_buddy_msg( ic, status->user->screen_name, status->text, 0, status->created_at );
                // Update the home_timeline_id to hold the highest id, so that by the next request
                // we won't pick up the updates allready in the list.
                td->home_timeline_id = td->home_timeline_id < status->id ? status->id : td->home_timeline_id;
        }
}

/**
 * Callback for getting the home timeline.
 */
static void twitter_http_get_home_timeline(struct http_request *req)
{
        struct im_connection *ic = req->data;
        struct twitter_data *td;
        struct xt_parser *parser;
        struct twitter_xml_list *txl;

        // Check if the connection is still active.
        if( !g_slist_find( twitter_connections, ic ) )
                return;
        
        td = ic->proto_data;

        // Check if the HTTP request went well.
        if (req->status_code == 200)
        {
                td->http_fails = 0;
                if (!ic->flags & OPT_LOGGED_IN)
                        imcb_connected(ic);
        }
        else if (req->status_code == 401)
        {
                imcb_error( ic, "Authentication failure" );
                imc_logout( ic, FALSE );
                return;
        }
        else
        {
                // It didn't go well, output the error and return.
                if (++td->http_fails >= 5)
                        imcb_error(ic, "Could not retrieve " TWITTER_HOME_TIMELINE_URL ". HTTP STATUS: %d", req->status_code);
                
                return;
        }

        txl = g_new0(struct twitter_xml_list, 1);
        txl->list = NULL;

        // Parse the data.
        parser = xt_new( NULL, txl );
        xt_feed( parser, req->reply_body, req->body_size );
        // The root <statuses> node should hold the list of statuses <status>
        twitter_xt_get_status_list(parser->root, txl);
        xt_free( parser );

        // See if the user wants to see the messages in a groupchat window or as private messages.
        if (set_getbool( &ic->acc->set, "use_groupchat" ))
                twitter_groupchat(ic, txl->list);
        else
                twitter_private_message_chat(ic, txl->list);

        // Free the structure.  
        txl_free(txl);
        g_free(txl);
}

/**
 * Callback for getting (twitter)friends...
 *
 * Be afraid, be very afraid! This function will potentially add hundreds of "friends". "Who has 
 * hundreds of friends?" you wonder? You probably not, since you are reading the source of 
 * BitlBee... Get a life and meet new people!
 */
static void twitter_http_get_statuses_friends(struct http_request *req)
{
        struct im_connection *ic = req->data;
        struct twitter_data *td;
        struct xt_parser *parser;
        struct twitter_xml_list *txl;
        GSList *l = NULL;
        struct twitter_xml_user *user;

        // Check if the connection is still active.
        if( !g_slist_find( twitter_connections, ic ) )
                return;
        
        td = ic->proto_data;
        
        // Check if the HTTP request went well.
        if (req->status_code != 200) {
                // It didn't go well, output the error and return.
                if (++td->http_fails >= 5)
                        imcb_error(ic, "Could not retrieve " TWITTER_SHOW_FRIENDS_URL " HTTP STATUS: %d", req->status_code);
                
                return;
        } else {
                td->http_fails = 0;
        }

        txl = g_new0(struct twitter_xml_list, 1);
        txl->list = NULL;

        // Parse the data.
        parser = xt_new( NULL, txl );
        xt_feed( parser, req->reply_body, req->body_size );

        // Get the user list from the parsed xml feed.
        twitter_xt_get_user_list(parser->root, txl);
        xt_free( parser );

        // Add the users as buddies.
        for ( l = txl->list; l ; l = g_slist_next(l) )
        {
                user = l->data;
                twitter_add_buddy(ic, user->screen_name, user->name);
        }

        // if the next_cursor is set to something bigger then 0 there are more friends to gather.
        if (txl->next_cursor > 0)
                twitter_get_statuses_friends(ic, txl->next_cursor);

        // Free the structure.
        txl_free(txl);
        g_free(txl);
}

/**
 * Get the friends.
 */
void twitter_get_statuses_friends(struct im_connection *ic, int next_cursor)
{
        struct twitter_data *td = ic->proto_data;

        char* args[2];
        args[0] = "cursor";
        args[1] = g_strdup_printf ("%d", next_cursor);

        twitter_http(TWITTER_SHOW_FRIENDS_URL, twitter_http_get_statuses_friends, ic, 0, td->user, td->pass, args, 2);

        g_free(args[1]);
}

/**
 * Callback after sending a new update to twitter.
 */
static void twitter_http_post_status(struct http_request *req)
{
        struct im_connection *ic = req->data;

        // Check if the connection is still active.
        if( !g_slist_find( twitter_connections, ic ) )
                return;

        // Check if the HTTP request went well.
        if (req->status_code != 200) {
                // It didn't go well, output the error and return.
                imcb_error(ic, "Could not post tweet... HTTP STATUS: %d", req->status_code);
                return;
        }
}

/**
 * Function to POST a new status to twitter.
 */ 
void twitter_post_status(struct im_connection *ic, char* msg)
{
        struct twitter_data *td = ic->proto_data;

        char* args[2];
        args[0] = "status";
        args[1] = msg;
        twitter_http(TWITTER_STATUS_UPDATE_URL, twitter_http_post_status, ic, 1, td->user, td->pass, args, 2);
//      g_free(args[1]);
}


/**
 * Function to POST a new message to twitter.
 */
void twitter_direct_messages_new(struct im_connection *ic, char *who, char *msg)
{
        struct twitter_data *td = ic->proto_data;

        char* args[4];
        args[0] = "screen_name";
        args[1] = who;
        args[2] = "text";
        args[3] = msg;
        // Use the same callback as for twitter_post_status, since it does basically the same.
        twitter_http(TWITTER_DIRECT_MESSAGES_NEW_URL, twitter_http_post_status, ic, 1, td->user, td->pass, args, 4);
//      g_free(args[1]);
//      g_free(args[3]);
}