source: protocols/nogaim.h @ a6a2d81

Last change on this file since a6a2d81 was b006464, checked in by Wilmer van der Gaast <wilmer@…>, at 2012-11-17T23:51:21Z

Merge mainline.

  • Property mode set to 100644
File size: 14.1 KB
RevLine 
[b7d3cc34]1  /********************************************************************\
2  * BitlBee -- An IRC to other IM-networks gateway                     *
3  *                                                                    *
[d860a8d]4  * Copyright 2002-2010 Wilmer van der Gaast and others                *
[b7d3cc34]5  \********************************************************************/
6
7/*
[6bbb939]8 * nogaim, soon to be known as im_api. Not a separate product (unless
9 * someone would be interested in such a thing), just a new name.
[b7d3cc34]10 *
11 * Gaim without gaim - for BitlBee
12 *
13 * This file contains functions called by the Gaim IM-modules. It contains
14 * some struct and type definitions from Gaim.
15 *
16 * Copyright (C) 1998-1999, Mark Spencer <markster@marko.net>
17 *                          (and possibly other members of the Gaim team)
[6bbb939]18 * Copyright 2002-2007 Wilmer van der Gaast <wilmer@gaast.net>
[b7d3cc34]19 */
20
21/*
22  This program is free software; you can redistribute it and/or modify
23  it under the terms of the GNU General Public License as published by
24  the Free Software Foundation; either version 2 of the License, or
25  (at your option) any later version.
26
27  This program is distributed in the hope that it will be useful,
28  but WITHOUT ANY WARRANTY; without even the implied warranty of
29  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
30  GNU General Public License for more details.
31
32  You should have received a copy of the GNU General Public License with
33  the Debian GNU/Linux distribution in /usr/share/common-licenses/GPL;
34  if not, write to the Free Software Foundation, Inc., 59 Temple Place,
35  Suite 330, Boston, MA  02111-1307  USA
36*/
37
38#ifndef _NOGAIM_H
39#define _NOGAIM_H
40
[daae10f]41#if(__sun)
42#include <inttypes.h>
43#else
[4cf80bb]44#include <stdint.h>
[daae10f]45#endif
46
[b7d3cc34]47#include "bitlbee.h"
[0a3c243]48#include "account.h"
[b7d3cc34]49#include "proxy.h"
[9143aeb]50#include "query.h"
[b7d3cc34]51#include "md5.h"
[2c2df7d]52#include "ft.h"
[b7d3cc34]53
54#define BUDDY_ALIAS_MAXLEN 388   /* because MSN names can be 387 characters */
55
[1c8a7a2]56#define WEBSITE "http://www.bitlbee.org/"
[b7d3cc34]57
[9624fdf]58/* Sharing flags between all kinds of things. I just hope I won't hit any
59   limits before 32-bit machines become extinct. ;-) */
[6bbb939]60#define OPT_LOGGED_IN   0x00000001
61#define OPT_LOGGING_OUT 0x00000002
62#define OPT_AWAY        0x00000004
[0ebf919]63#define OPT_MOBILE      0x00000008
[6bbb939]64#define OPT_DOES_HTML   0x00000010
[6286f80]65#define OPT_LOCALBUDDY  0x00000020 /* For nicks local to one groupchat */
[748bcdd]66#define OPT_SLOW_LOGIN  0x00000040 /* I.e. Twitter Oauth @ login time */
[df1fb67]67#define OPT_TYPING      0x00000100 /* Some pieces of code make assumptions */
68#define OPT_THINKING    0x00000200 /* about these values... Stupid me! */
[be999a5]69#define OPT_NOOTR       0x00001000 /* protocol not suitable for OTR */
[e132b60]70#define OPT_PONGS       0x00010000 /* Service sends us keep-alives */
71#define OPT_PONGED      0x00020000 /* Received a keep-alive during last interval */
[fb62f81f]72
[b7d3cc34]73/* ok. now the fun begins. first we create a connection structure */
[0da65d5]74struct im_connection
[192b80a]75{
[0a3c243]76        account_t *acc;
[52744f8]77        uint32_t flags;
[b7d3cc34]78       
[192b80a]79        /* each connection then can have its own protocol-specific data */
80        void *proto_data;
81       
[b7d3cc34]82        /* all connections need an input watcher */
83        int inpa;
[192b80a]84        guint keepalive;
[b7d3cc34]85       
86        /* buddy list stuff. there is still a global groups for the buddy list, but
87         * we need to maintain our own set of buddies, and our own permit/deny lists */
88        GSList *permit;
89        GSList *deny;
90        int permdeny;
91       
92        char *away;
93       
94        /* BitlBee */
[81e04e1]95        bee_t *bee;
[b7d3cc34]96       
[aea8b68]97        GSList *groupchats;
[b7d3cc34]98};
99
[0da65d5]100struct groupchat {
101        struct im_connection *ic;
[b7d3cc34]102
103        /* stuff used just for chat */
[acd61b9]104        /* The in_room variable is a list of handles (not nicks!), kind of
105         * "nick list". This is how you can check who is in the group chat
106         * already, for example to avoid adding somebody two times. */
[fa29d093]107        GList *in_room;
[aea8b68]108        //GList *ignored;
[fa29d093]109       
[aea8b68]110        //struct groupchat *next;
[acd61b9]111        /* The title variable contains the ID you gave when you created the
112         * chat using imcb_chat_new(). */
[fa29d093]113        char *title;
[50e1776]114        /* Use imcb_chat_topic() to change this variable otherwise the user
115         * won't notice the topic change. */
116        char *topic;
[fa29d093]117        char joined;
[acd61b9]118        /* This is for you, you can add your own structure here to extend this
119         * structure for your protocol's needs. */
[fa29d093]120        void *data;
[aea8b68]121        void *ui_data;
[b7d3cc34]122};
123
124struct buddy {
125        char name[80];
126        char show[BUDDY_ALIAS_MAXLEN];
[fa29d093]127        int present;
[b7d3cc34]128        time_t signon;
129        time_t idle;
[fa29d093]130        int uc;
[b7d3cc34]131        guint caps; /* woohoo! */
132        void *proto_data; /* what a hack */
[0da65d5]133        struct im_connection *ic; /* the connection it belongs to */
[b7d3cc34]134};
135
[d88c92a]136struct buddy_action {
137        char *name;
138        char *description;
139};
140
[b7d3cc34]141struct prpl {
142        int options;
[acd61b9]143        /* You should set this to the name of your protocol.
144         * - The user sees this name ie. when imcb_log() is used. */
[7b23afd]145        const char *name;
[cd741d8]146        void *data;
[1dd3470]147        /* Maximum Message Size of this protocol.
148         * - Introduced for OTR, in order to fragment large protocol messages.
149         * - 0 means "unlimited". */
150        unsigned int mms;
[b7d3cc34]151
[0da65d5]152        /* Added this one to be able to add per-account settings, don't think
[acd61b9]153         * it should be used for anything else. You are supposed to use the
154         * set_add() function to add new settings. */
[0da65d5]155        void (* init)           (account_t *);
[acd61b9]156        /* The typical usage of the login() function:
157         * - Create an im_connection using imcb_new() from the account_t parameter.
158         * - Initialize your myproto_data struct - you should store all your protocol-specific data there.
159         * - Save your custom structure to im_connection->proto_data.
160         * - Use proxy_connect() to connect to the server.
161         */
[0a3c243]162        void (* login)          (account_t *);
[acd61b9]163        /* Implementing this function is optional. */
[0da65d5]164        void (* keepalive)      (struct im_connection *);
[acd61b9]165        /* In this function you should:
166         * - Tell the server about you are logging out.
167         * - g_free() your myproto_data struct as BitlBee does not know how to
168         *   properly do so.
169         */
[0da65d5]170        void (* logout)         (struct im_connection *);
171       
[acd61b9]172        /* This function is called when the user wants to send a message to a handle.
173         * - 'to' is a handle, not a nick
174         * - 'flags' may be ignored
175         */
[f6c963b]176        int  (* buddy_msg)      (struct im_connection *, char *to, char *message, int flags);
[acd61b9]177        /* This function is called then the user uses the /away IRC command.
178         * - 'state' contains the away reason.
179         * - 'message' may be ignored if your protocol does not support it.
180         */
[0da65d5]181        void (* set_away)       (struct im_connection *, char *state, char *message);
[acd61b9]182        /* Implementing this function is optional. */
[0da65d5]183        void (* get_away)       (struct im_connection *, char *who);
[acd61b9]184        /* Implementing this function is optional. */
[9624fdf]185        int  (* send_typing)    (struct im_connection *, char *who, int flags);
[0da65d5]186       
[acd61b9]187        /* 'name' is a handle to add/remove. For now BitlBee doesn't really
188         * handle groups, just set it to NULL, so you can ignore that
189         * parameter. */
[0da65d5]190        void (* add_buddy)      (struct im_connection *, char *name, char *group);
191        void (* remove_buddy)   (struct im_connection *, char *name, char *group);
192       
[acd61b9]193        /* Block list stuff. Implementing these are optional. */
[0da65d5]194        void (* add_permit)     (struct im_connection *, char *who);
195        void (* add_deny)       (struct im_connection *, char *who);
196        void (* rem_permit)     (struct im_connection *, char *who);
197        void (* rem_deny)       (struct im_connection *, char *who);
[0eb971a]198        /* Doesn't actually have UI hooks. Not used at all, can be removed. */
[0da65d5]199        void (* set_permit_deny)(struct im_connection *);
200       
201        /* Request profile info. Free-formatted stuff, the IM module gives back
[acd61b9]202           this info via imcb_log(). Implementing these are optional. */
[0da65d5]203        void (* get_info)       (struct im_connection *, char *who);
[4452e69]204        /* set_my_name is *DEPRECATED*, not used by the UI anymore. Use the
205           display_name setting instead. */
[0da65d5]206        void (* set_my_name)    (struct im_connection *, char *name);
207        void (* set_name)       (struct im_connection *, char *who, char *name);
[192b80a]208       
209        /* Group chat stuff. */
[acd61b9]210        /* This is called when the user uses the /invite IRC command.
211         * - 'who' may be ignored
212         * - 'message' is a handle to invite
213         */
[0da65d5]214        void (* chat_invite)    (struct groupchat *, char *who, char *message);
[acd61b9]215        /* This is called when the user uses the /part IRC command in a group
216         * chat. You just should tell the user about it, nothing more. */
[0da65d5]217        void (* chat_leave)     (struct groupchat *);
[acd61b9]218        /* This is called when the user sends a message to the groupchat.
219         * 'flags' may be ignored. */
[f6c963b]220        void (* chat_msg)       (struct groupchat *, char *message, int flags);
[acd61b9]221        /* This is called when the user uses the /join #nick IRC command.
222         * - 'who' is the handle of the nick
223         */
[0da65d5]224        struct groupchat *
225             (* chat_with)      (struct im_connection *, char *who);
[acd61b9]226        /* This is used when the user uses the /join #channel IRC command.  If
227         * your protocol does not support publicly named group chats, then do
228         * not implement this. */
[0da65d5]229        struct groupchat *
[03f3828]230             (* chat_join)      (struct im_connection *, const char *room,
231                                 const char *nick, const char *password, set_t **sets);
[50e1776]232        /* Change the topic, if supported. Note that BitlBee expects the IM
233           server to confirm the topic change with a regular topic change
234           event. If it doesn't do that, you have to fake it to make it
235           visible to the user. */
[ef5c185]236        void (* chat_topic)     (struct groupchat *, char *topic);
[192b80a]237       
[03f3828]238        /* If your protocol module needs any special info for joining chatrooms
239           other than a roomname + nickname, add them here. */
240        void (* chat_add_settings)      (account_t *acc, set_t **head);
241        void (* chat_free_settings)     (account_t *acc, set_t **head);
242       
[acd61b9]243        /* You can tell what away states your protocol supports, so that
[2bc8ac0]244         * BitlBee will try to map the IRC away reasons to them. If your
245         * protocol doesn't have any, just return one generic "Away". */
[0da65d5]246        GList *(* away_states)(struct im_connection *ic);
[192b80a]247       
[acd61b9]248        /* Mainly for AOL, since they think "Bung hole" == "Bu ngho le". *sigh*
249         * - Most protocols will just want to set this to g_strcasecmp().*/
[5b52a48]250        int (* handle_cmp) (const char *who1, const char *who2);
[2ff2076]251
[fa295e36]252        /* Implement these callbacks if you want to use imcb_ask_auth() */
253        void (* auth_allow)     (struct im_connection *, const char *who);
254        void (* auth_deny)      (struct im_connection *, const char *who);
[2288705]255
[2ff2076]256        /* Incoming transfer request */
257        void (* transfer_request) (struct im_connection *, file_transfer_t *ft, char *handle );
[03f3828]258       
[203a2d2]259        void (* buddy_data_add) (struct bee_user *bu);
260        void (* buddy_data_free) (struct bee_user *bu);
261       
[d88c92a]262        GList *(* buddy_action_list) (struct bee_user *bu);
263        void *(* buddy_action) (struct bee_user *bu, const char *action, char * const args[], void *data);
264       
[03f3828]265        /* Some placeholders so eventually older plugins may cooperate with newer BitlBees. */
266        void *resv1;
267        void *resv2;
268        void *resv3;
269        void *resv4;
270        void *resv5;
[b7d3cc34]271};
272
[84b045d]273/* im_api core stuff. */
274void nogaim_init();
[b7d3cc34]275G_MODULE_EXPORT GSList *get_connections();
[f6c963b]276G_MODULE_EXPORT struct prpl *find_protocol( const char *name );
[acd61b9]277/* When registering a new protocol, you should allocate space for a new prpl
278 * struct, initialize it (set the function pointers to point to your
279 * functions), finally call this function. */
[f6c963b]280G_MODULE_EXPORT void register_protocol( struct prpl * );
[b7d3cc34]281
[84b045d]282/* Connection management. */
[acd61b9]283/* You will need this function in prpl->login() to get an im_connection from
284 * the account_t parameter. */
[84b045d]285G_MODULE_EXPORT struct im_connection *imcb_new( account_t *acc );
[c0c43fb]286G_MODULE_EXPORT void imc_free( struct im_connection *ic );
[acd61b9]287/* Once you're connected, you should call this function, so that the user will
288 * see the success. */
[84b045d]289G_MODULE_EXPORT void imcb_connected( struct im_connection *ic );
[acd61b9]290/* This can be used to disconnect when something went wrong (ie. read error
291 * from the server). You probably want to set the second parameter to TRUE. */
[c2fb3809]292G_MODULE_EXPORT void imc_logout( struct im_connection *ic, int allow_reconnect );
[b7d3cc34]293
[84b045d]294/* Communicating with the user. */
[acd61b9]295/* A printf()-like function to tell the user anything you want. */
[d11dd2f]296G_MODULE_EXPORT void imcb_log( struct im_connection *ic, char *format, ... ) G_GNUC_PRINTF( 2, 3 );
[acd61b9]297/* To tell the user an error, ie. before logging out when an error occurs. */
[d11dd2f]298G_MODULE_EXPORT void imcb_error( struct im_connection *ic, char *format, ... ) G_GNUC_PRINTF( 2, 3 );
[fa295e36]299
[acd61b9]300/* To ask a your about something.
301 * - 'msg' is the question.
302 * - 'data' can be your custom struct - it will be passed to the callbacks.
303 * - 'doit' or 'dont' will be called depending of the answer of the user.
304 */
[9143aeb]305G_MODULE_EXPORT void imcb_ask( struct im_connection *ic, char *msg, void *data, query_callback doit, query_callback dont );
[d0527c1]306G_MODULE_EXPORT void imcb_ask_with_free( struct im_connection *ic, char *msg, void *data, query_callback doit, query_callback dont, query_callback myfree );
[fa295e36]307
308/* Two common questions you may want to ask:
309 * - X added you to his contact list, allow?
310 * - X is not in your contact list, want to add?
311 */
312G_MODULE_EXPORT void imcb_ask_auth( struct im_connection *ic, const char *handle, const char *realname );
313G_MODULE_EXPORT void imcb_ask_add( struct im_connection *ic, const char *handle, const char *realname );
[b7d3cc34]314
[84b045d]315/* Buddy management */
[acd61b9]316/* This function should be called for each handle which are visible to the
[527360f]317 * user, usually after a login, or if the user added a buddy and the IM
318 * server confirms that the add was successful. Don't forget to do this! */
[c6ca3ee]319G_MODULE_EXPORT void imcb_add_buddy( struct im_connection *ic, const char *handle, const char *group );
320G_MODULE_EXPORT void imcb_remove_buddy( struct im_connection *ic, const char *handle, char *group );
[f0cb961]321G_MODULE_EXPORT struct buddy *imcb_find_buddy( struct im_connection *ic, char *handle );
[c6ca3ee]322G_MODULE_EXPORT void imcb_rename_buddy( struct im_connection *ic, const char *handle, const char *realname );
[fb00989]323G_MODULE_EXPORT void imcb_buddy_nick_hint( struct im_connection *ic, const char *handle, const char *nick );
[d88c92a]324G_MODULE_EXPORT void imcb_buddy_action_response( bee_user_t *bu, const char *action, char * const args[], void *data );
[84b045d]325
[bad41f56]326G_MODULE_EXPORT void imcb_buddy_typing( struct im_connection *ic, const char *handle, uint32_t flags );
[d860a8d]327G_MODULE_EXPORT struct bee_user *imcb_buddy_by_handle( struct im_connection *ic, const char *handle );
[85023c6]328G_MODULE_EXPORT void imcb_clean_handle( struct im_connection *ic, char *handle );
[84b045d]329
330/* Actions, or whatever. */
[58adb7e]331int imc_away_send_update( struct im_connection *ic );
[84b045d]332int imc_chat_msg( struct groupchat *c, char *msg, int flags );
333
334void imc_add_allow( struct im_connection *ic, char *handle );
335void imc_rem_allow( struct im_connection *ic, char *handle );
336void imc_add_block( struct im_connection *ic, char *handle );
337void imc_rem_block( struct im_connection *ic, char *handle );
338
339/* Misc. stuff */
[3e57660]340char *set_eval_timezone( set_t *set, char *value );
[84b045d]341gboolean auto_reconnect( gpointer data, gint fd, b_input_condition cond );
342void cancel_auto_reconnect( struct account *a );
343
[b7d3cc34]344#endif
Note: See TracBrowser for help on using the repository browser.