source: protocols/nogaim.h @ e46e077

Last change on this file since e46e077 was 85d7b85, checked in by Jelmer Vernooij <jelmer@…>, at 2008-04-02T14:22:57Z

Merge trunk.
  • Property mode set to 100644
File size: 14.2 KB
Line 
1  /********************************************************************\
2  * BitlBee -- An IRC to other IM-networks gateway                     *
3  *                                                                    *
4  * Copyright 2002-2004 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#include "bitlbee.h"
42#include "account.h"
43#include "proxy.h"
44#include "md5.h"
45
46#define BUF_LEN MSG_LEN
47#define BUF_LONG ( BUF_LEN * 2 )
48#define MSG_LEN 2048
49#define BUF_LEN MSG_LEN
50
51#define BUDDY_ALIAS_MAXLEN 388   /* because MSN names can be 387 characters */
52
53#define WEBSITE "http://www.bitlbee.org/"
54#define GAIM_AWAY_CUSTOM "Custom"
55
56/* Sharing flags between all kinds of things. I just hope I won't hit any
57   limits before 32-bit machines become extinct. ;-) */
58#define OPT_LOGGED_IN   0x00000001
59#define OPT_LOGGING_OUT 0x00000002
60#define OPT_AWAY        0x00000004
61#define OPT_DOES_HTML   0x00000010
62#define OPT_LOCALBUDDY  0x00000020 /* For nicks local to one groupchat */
63#define OPT_TYPING      0x00000100 /* Some pieces of code make assumptions */
64#define OPT_THINKING    0x00000200 /* about these values... Stupid me! */
65
66/* ok. now the fun begins. first we create a connection structure */
67struct im_connection
68{
69        account_t *acc;
70        uint32_t flags;
71       
72        /* each connection then can have its own protocol-specific data */
73        void *proto_data;
74       
75        /* all connections need an input watcher */
76        int inpa;
77        guint keepalive;
78       
79        /* buddy list stuff. there is still a global groups for the buddy list, but
80         * we need to maintain our own set of buddies, and our own permit/deny lists */
81        GSList *permit;
82        GSList *deny;
83        int permdeny;
84       
85        char displayname[128];
86        char *away;
87       
88        int evil;
89       
90        /* BitlBee */
91        irc_t *irc;
92       
93        struct groupchat *groupchats;
94};
95
96struct groupchat {
97        struct im_connection *ic;
98
99        /* stuff used just for chat */
100        /* The in_room variable is a list of handles (not nicks!), kind of
101         * "nick list". This is how you can check who is in the group chat
102         * already, for example to avoid adding somebody two times. */
103        GList *in_room;
104        GList *ignored;
105       
106        struct groupchat *next;
107        char *channel;
108        /* The title variable contains the ID you gave when you created the
109         * chat using imcb_chat_new(). */
110        char *title;
111        /* Use imcb_chat_topic() to change this variable otherwise the user
112         * won't notice the topic change. */
113        char *topic;
114        char joined;
115        /* This is for you, you can add your own structure here to extend this
116         * structure for your protocol's needs. */
117        void *data;
118};
119
120struct buddy {
121        char name[80];
122        char show[BUDDY_ALIAS_MAXLEN];
123        int present;
124        int evil;
125        time_t signon;
126        time_t idle;
127        int uc;
128        guint caps; /* woohoo! */
129        void *proto_data; /* what a hack */
130        struct im_connection *ic; /* the connection it belongs to */
131};
132
133struct ft
134{
135        const char *filename;
136       
137        /* Total number of bytes in file */
138        size_t total_bytes;
139       
140        /* Current number of bytes received */
141        size_t cur_bytes;
142};
143
144struct ft_request
145{
146        const char *filename;
147        struct gaim_connection *gc;
148};
149
150typedef void (*ft_recv_handler) (struct ft *, void *data, size_t len);
151
152struct prpl {
153        int options;
154        /* You should set this to the name of your protocol.
155         * - The user sees this name ie. when imcb_log() is used. */
156        const char *name;
157
158        /* Added this one to be able to add per-account settings, don't think
159         * it should be used for anything else. You are supposed to use the
160         * set_add() function to add new settings. */
161        void (* init)           (account_t *);
162        /* The typical usage of the login() function:
163         * - Create an im_connection using imcb_new() from the account_t parameter.
164         * - Initialize your myproto_data struct - you should store all your protocol-specific data there.
165         * - Save your custom structure to im_connection->proto_data.
166         * - Use proxy_connect() to connect to the server.
167         */
168        void (* login)          (account_t *);
169        /* Implementing this function is optional. */
170        void (* keepalive)      (struct im_connection *);
171        /* In this function you should:
172         * - Tell the server about you are logging out.
173         * - g_free() your myproto_data struct as BitlBee does not know how to
174         *   properly do so.
175         */
176        void (* logout)         (struct im_connection *);
177       
178        /* This function is called when the user wants to send a message to a handle.
179         * - 'to' is a handle, not a nick
180         * - 'flags' may be ignored
181         */
182        int  (* buddy_msg)      (struct im_connection *, char *to, char *message, int flags);
183        /* This function is called then the user uses the /away IRC command.
184         * - 'state' contains the away reason.
185         * - 'message' may be ignored if your protocol does not support it.
186         */
187        void (* set_away)       (struct im_connection *, char *state, char *message);
188        /* Implementing this function is optional. */
189        void (* get_away)       (struct im_connection *, char *who);
190        /* Implementing this function is optional. */
191        int  (* send_typing)    (struct im_connection *, char *who, int flags);
192       
193        /* 'name' is a handle to add/remove. For now BitlBee doesn't really
194         * handle groups, just set it to NULL, so you can ignore that
195         * parameter. */
196        void (* add_buddy)      (struct im_connection *, char *name, char *group);
197        void (* remove_buddy)   (struct im_connection *, char *name, char *group);
198       
199        /* Block list stuff. Implementing these are optional. */
200        void (* add_permit)     (struct im_connection *, char *who);
201        void (* add_deny)       (struct im_connection *, char *who);
202        void (* rem_permit)     (struct im_connection *, char *who);
203        void (* rem_deny)       (struct im_connection *, char *who);
204        /* Doesn't actually have UI hooks. */
205        void (* set_permit_deny)(struct im_connection *);
206       
207        /* Request profile info. Free-formatted stuff, the IM module gives back
208           this info via imcb_log(). Implementing these are optional. */
209        void (* get_info)       (struct im_connection *, char *who);
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 *, char *room, char *nick, char *password);
235        /* Change the topic, if supported. Note that BitlBee expects the IM
236           server to confirm the topic change with a regular topic change
237           event. If it doesn't do that, you have to fake it to make it
238           visible to the user. */
239        void (* chat_topic)     (struct groupchat *, char *topic);
240       
241        /* You can tell what away states your protocol supports, so that
242         * BitlBee will try to map the IRC away reasons to them, or use
243         * GAIM_AWAY_CUSTOM when calling skype_set_away(). */
244        GList *(* away_states)(struct im_connection *ic);
245       
246        /* Mainly for AOL, since they think "Bung hole" == "Bu ngho le". *sigh*
247         * - Most protocols will just want to set this to g_strcasecmp().*/
248        int (* handle_cmp) (const char *who1, const char *who2);
249};
250
251/* im_api core stuff. */
252void nogaim_init();
253G_MODULE_EXPORT GSList *get_connections();
254G_MODULE_EXPORT struct prpl *find_protocol( const char *name );
255/* When registering a new protocol, you should allocate space for a new prpl
256 * struct, initialize it (set the function pointers to point to your
257 * functions), finally call this function. */
258G_MODULE_EXPORT void register_protocol( struct prpl * );
259
260/* Connection management. */
261/* You will need this function in prpl->login() to get an im_connection from
262 * the account_t parameter. */
263G_MODULE_EXPORT struct im_connection *imcb_new( account_t *acc );
264G_MODULE_EXPORT void imcb_free( struct im_connection *ic );
265/* Once you're connected, you should call this function, so that the user will
266 * see the success. */
267G_MODULE_EXPORT void imcb_connected( struct im_connection *ic );
268/* This can be used to disconnect when something went wrong (ie. read error
269 * from the server). You probably want to set the second parameter to TRUE. */
270G_MODULE_EXPORT void imc_logout( struct im_connection *ic, int allow_reconnect );
271
272/* Communicating with the user. */
273/* A printf()-like function to tell the user anything you want. */
274G_MODULE_EXPORT void imcb_log( struct im_connection *ic, char *format, ... ) G_GNUC_PRINTF( 2, 3 );
275/* To tell the user an error, ie. before logging out when an error occurs. */
276G_MODULE_EXPORT void imcb_error( struct im_connection *ic, char *format, ... ) G_GNUC_PRINTF( 2, 3 );
277/* To ask a your about something.
278 * - 'msg' is the question.
279 * - 'data' can be your custom struct - it will be passed to the callbacks.
280 * - 'doit' or 'dont' will be called depending of the answer of the user.
281 */
282G_MODULE_EXPORT void imcb_ask( struct im_connection *ic, char *msg, void *data, void *doit, void *dont );
283G_MODULE_EXPORT void imcb_ask_add( struct im_connection *ic, char *handle, const char *realname );
284
285/* Buddy management */
286/* This function should be called for each handle which are visible to the
287 * user, usually after a login, or if the user added a buddy and the IM
288 * server confirms that the add was successful. Don't forget to do this! */
289G_MODULE_EXPORT void imcb_add_buddy( struct im_connection *ic, char *handle, char *group );
290G_MODULE_EXPORT void imcb_remove_buddy( struct im_connection *ic, char *handle, char *group );
291G_MODULE_EXPORT struct buddy *imcb_find_buddy( struct im_connection *ic, char *handle );
292G_MODULE_EXPORT void imcb_rename_buddy( struct im_connection *ic, char *handle, char *realname );
293G_MODULE_EXPORT void imcb_buddy_nick_hint( struct im_connection *ic, char *handle, char *nick );
294
295/* Buddy activity */
296/* To manipulate the status of a handle.
297 * - flags can be |='d with OPT_* constants. You will need at least:
298 *   OPT_LOGGED_IN and OPT_AWAY.
299 * - 'state' and 'message' can be NULL */
300G_MODULE_EXPORT void imcb_buddy_status( struct im_connection *ic, const char *handle, int flags, const char *state, const char *message );
301/* Not implemented yet! */ G_MODULE_EXPORT void imcb_buddy_times( struct im_connection *ic, const char *handle, time_t login, time_t idle );
302/* Call when a handle says something. 'flags' and 'sent_at may be just 0. */
303G_MODULE_EXPORT void imcb_buddy_msg( struct im_connection *ic, char *handle, char *msg, uint32_t flags, time_t sent_at );
304G_MODULE_EXPORT void imcb_buddy_typing( struct im_connection *ic, char *handle, uint32_t flags );
305G_MODULE_EXPORT void imcb_clean_handle( struct im_connection *ic, char *handle );
306
307/* Groupchats */
308G_MODULE_EXPORT void imcb_chat_invited( struct im_connection *ic, char *handle, char *who, char *msg, GList *data );
309/* These two functions are to create a group chat.
310 * - imcb_chat_new(): the 'handle' parameter identifies the chat, like the
311 *   channel name on IRC.
312 * - After you have a groupchat pointer, you should add the handles, finally
313 *   the user her/himself. At that point the group chat will be visible to the
314 *   user, too. */
315G_MODULE_EXPORT struct groupchat *imcb_chat_new( struct im_connection *ic, char *handle );
316G_MODULE_EXPORT void imcb_chat_add_buddy( struct groupchat *b, char *handle );
317/* To remove a handle from a group chat. Reason can be NULL. */
318G_MODULE_EXPORT void imcb_chat_remove_buddy( struct groupchat *b, char *handle, char *reason );
319/* To tell BitlBee 'who' said 'msg' in 'c'. 'flags' and 'sent_at' can be 0. */
320G_MODULE_EXPORT void imcb_chat_msg( struct groupchat *c, char *who, char *msg, uint32_t flags, time_t sent_at );
321/* System messages specific to a groupchat, so they can be displayed in the right context. */
322G_MODULE_EXPORT void imcb_chat_log( struct groupchat *c, char *format, ... ) G_GNUC_PRINTF( 2, 3 );
323/* To tell BitlBee 'who' changed the topic of 'c' to 'topic'. */
324G_MODULE_EXPORT void imcb_chat_topic( struct groupchat *c, char *who, char *topic, time_t set_at );
325G_MODULE_EXPORT void imcb_chat_free( struct groupchat *c );
326
327/* Actions, or whatever. */
328int imc_set_away( struct im_connection *ic, char *away );
329int imc_buddy_msg( struct im_connection *ic, char *handle, char *msg, int flags );
330int imc_chat_msg( struct groupchat *c, char *msg, int flags );
331
332void imc_add_allow( struct im_connection *ic, char *handle );
333void imc_rem_allow( struct im_connection *ic, char *handle );
334void imc_add_block( struct im_connection *ic, char *handle );
335void imc_rem_block( struct im_connection *ic, char *handle );
336
337/* Misc. stuff */
338char *set_eval_away_devoice( set_t *set, char *value );
339gboolean auto_reconnect( gpointer data, gint fd, b_input_condition cond );
340void cancel_auto_reconnect( struct account *a );
341
342#endif
Note: See TracBrowser for help on using the repository browser.