source: protocols/nogaim.h @ e132b60

Last change on this file since e132b60 was e132b60, checked in by Wilmer van der Gaast <wilmer@…>, at 2012-11-11T23:32:47Z

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