source: protocols/nogaim.h @ 7435ccf

Last change on this file since 7435ccf was 527360f, checked in by Wilmer van der Gaast <wilmer@…>, at 2007-10-10T00:34:24Z

Added some comments to nogaim.h (Thanks to Miklos Vajna).
  • Property mode set to 100644
File size: 13.0 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#include "sha.h"
46
47#define BUF_LEN MSG_LEN
48#define BUF_LONG ( BUF_LEN * 2 )
49#define MSG_LEN 2048
50#define BUF_LEN MSG_LEN
51
52#define BUDDY_ALIAS_MAXLEN 388   /* because MSN names can be 387 characters */
53
54#define WEBSITE "http://www.bitlbee.org/"
55#define GAIM_AWAY_CUSTOM "Custom"
56
57/* Sharing flags between all kinds of things. I just hope I won't hit any
58   limits before 32-bit machines become extinct. ;-) */
59#define OPT_LOGGED_IN   0x00000001
60#define OPT_LOGGING_OUT 0x00000002
61#define OPT_AWAY        0x00000004
62#define OPT_DOES_HTML   0x00000010
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        u_int32_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 *conversations;
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        /* BitlBee */
107        struct groupchat *next;
108        char *channel;
109        /* The title variable contains the ID you gave when you created the
110         * chat using imcb_chat_new(). */
111        char *title;
112        char joined;
113        /* This is for you, you can add your own structure here to extend this
114         * structure for your protocol's needs. */
115        void *data;
116};
117
118struct buddy {
119        char name[80];
120        char show[BUDDY_ALIAS_MAXLEN];
121        int present;
122        int evil;
123        time_t signon;
124        time_t idle;
125        int uc;
126        guint caps; /* woohoo! */
127        void *proto_data; /* what a hack */
128        struct im_connection *ic; /* the connection it belongs to */
129};
130
131struct prpl {
132        int options;
133        /* You should set this to the name of your protocol.
134         * - The user sees this name ie. when imcb_log() is used. */
135        const char *name;
136
137        /* Added this one to be able to add per-account settings, don't think
138         * it should be used for anything else. You are supposed to use the
139         * set_add() function to add new settings. */
140        void (* init)           (account_t *);
141        /* The typical usage of the login() function:
142         * - Create an im_connection using imcb_new() from the account_t parameter.
143         * - Initialize your myproto_data struct - you should store all your protocol-specific data there.
144         * - Save your custom structure to im_connection->proto_data.
145         * - Use proxy_connect() to connect to the server.
146         */
147        void (* login)          (account_t *);
148        /* Implementing this function is optional. */
149        void (* keepalive)      (struct im_connection *);
150        /* In this function you should:
151         * - Tell the server about you are logging out.
152         * - g_free() your myproto_data struct as BitlBee does not know how to
153         *   properly do so.
154         */
155        void (* logout)         (struct im_connection *);
156       
157        /* This function is called when the user wants to send a message to a handle.
158         * - 'to' is a handle, not a nick
159         * - 'flags' may be ignored
160         */
161        int  (* buddy_msg)      (struct im_connection *, char *to, char *message, int flags);
162        /* This function is called then the user uses the /away IRC command.
163         * - 'state' contains the away reason.
164         * - 'message' may be ignored if your protocol does not support it.
165         */
166        void (* set_away)       (struct im_connection *, char *state, char *message);
167        /* Implementing this function is optional. */
168        void (* get_away)       (struct im_connection *, char *who);
169        /* Implementing this function is optional. */
170        int  (* send_typing)    (struct im_connection *, char *who, int flags);
171       
172        /* 'name' is a handle to add/remove. For now BitlBee doesn't really
173         * handle groups, just set it to NULL, so you can ignore that
174         * parameter. */
175        void (* add_buddy)      (struct im_connection *, char *name, char *group);
176        void (* remove_buddy)   (struct im_connection *, char *name, char *group);
177       
178        /* Block list stuff. Implementing these are optional. */
179        void (* add_permit)     (struct im_connection *, char *who);
180        void (* add_deny)       (struct im_connection *, char *who);
181        void (* rem_permit)     (struct im_connection *, char *who);
182        void (* rem_deny)       (struct im_connection *, char *who);
183        /* Doesn't actually have UI hooks. */
184        void (* set_permit_deny)(struct im_connection *);
185       
186        /* Request profile info. Free-formatted stuff, the IM module gives back
187           this info via imcb_log(). Implementing these are optional. */
188        void (* get_info)       (struct im_connection *, char *who);
189        void (* set_my_name)    (struct im_connection *, char *name);
190        void (* set_name)       (struct im_connection *, char *who, char *name);
191       
192        /* Group chat stuff. */
193        /* This is called when the user uses the /invite IRC command.
194         * - 'who' may be ignored
195         * - 'message' is a handle to invite
196         */
197        void (* chat_invite)    (struct groupchat *, char *who, char *message);
198        /* This is called when the user uses the /part IRC command in a group
199         * chat. You just should tell the user about it, nothing more. */
200        void (* chat_leave)     (struct groupchat *);
201        /* This is called when the user sends a message to the groupchat.
202         * 'flags' may be ignored. */
203        void (* chat_msg)       (struct groupchat *, char *message, int flags);
204        /* This is called when the user uses the /join #nick IRC command.
205         * - 'who' is the handle of the nick
206         */
207        struct groupchat *
208             (* chat_with)      (struct im_connection *, char *who);
209        /* This is used when the user uses the /join #channel IRC command.  If
210         * your protocol does not support publicly named group chats, then do
211         * not implement this. */
212        struct groupchat *
213             (* chat_join)      (struct im_connection *, char *room, char *nick, char *password);
214       
215        /* You can tell what away states your protocol supports, so that
216         * BitlBee will try to map the IRC away reasons to them, or use
217         * GAIM_AWAY_CUSTOM when calling skype_set_away(). */
218        GList *(* away_states)(struct im_connection *ic);
219       
220        /* Mainly for AOL, since they think "Bung hole" == "Bu ngho le". *sigh*
221         * - Most protocols will just want to set this to g_strcasecmp().*/
222        int (* handle_cmp) (const char *who1, const char *who2);
223};
224
225/* im_api core stuff. */
226void nogaim_init();
227G_MODULE_EXPORT GSList *get_connections();
228G_MODULE_EXPORT struct prpl *find_protocol( const char *name );
229/* When registering a new protocol, you should allocate space for a new prpl
230 * struct, initialize it (set the function pointers to point to your
231 * functions), finally call this function. */
232G_MODULE_EXPORT void register_protocol( struct prpl * );
233
234/* Connection management. */
235/* You will need this function in prpl->login() to get an im_connection from
236 * the account_t parameter. */
237G_MODULE_EXPORT struct im_connection *imcb_new( account_t *acc );
238G_MODULE_EXPORT void imcb_free( struct im_connection *ic );
239/* Once you're connected, you should call this function, so that the user will
240 * see the success. */
241G_MODULE_EXPORT void imcb_connected( struct im_connection *ic );
242/* This can be used to disconnect when something went wrong (ie. read error
243 * from the server). You probably want to set the second parameter to TRUE. */
244G_MODULE_EXPORT void imc_logout( struct im_connection *ic, int allow_reconnect );
245
246/* Communicating with the user. */
247/* A printf()-like function to tell the user anything you want. */
248G_MODULE_EXPORT void imcb_log( struct im_connection *ic, char *format, ... ) G_GNUC_PRINTF( 2, 3 );
249/* To tell the user an error, ie. before logging out when an error occurs. */
250G_MODULE_EXPORT void imcb_error( struct im_connection *ic, char *format, ... ) G_GNUC_PRINTF( 2, 3 );
251/* To ask a your about something.
252 * - 'msg' is the question.
253 * - 'data' can be your custom struct - it will be passed to the callbacks.
254 * - 'doit' or 'dont' will be called depending of the answer of the user.
255 */
256G_MODULE_EXPORT void imcb_ask( struct im_connection *ic, char *msg, void *data, void *doit, void *dont );
257G_MODULE_EXPORT void imcb_ask_add( struct im_connection *ic, char *handle, const char *realname );
258
259/* Buddy management */
260/* This function should be called for each handle which are visible to the
261 * user, usually after a login, or if the user added a buddy and the IM
262 * server confirms that the add was successful. Don't forget to do this! */
263G_MODULE_EXPORT void imcb_add_buddy( struct im_connection *ic, char *handle, char *group );
264G_MODULE_EXPORT void imcb_remove_buddy( struct im_connection *ic, char *handle, char *group );
265G_MODULE_EXPORT struct buddy *imcb_find_buddy( struct im_connection *ic, char *handle );
266G_MODULE_EXPORT void imcb_rename_buddy( struct im_connection *ic, char *handle, char *realname );
267
268/* Buddy activity */
269/* To manipulate the status of a handle.
270 * - flags can be |='d with OPT_* constants. You will need at least:
271 *   OPT_LOGGED_IN and OPT_AWAY.
272 * - 'state' and 'message' can be NULL */
273G_MODULE_EXPORT void imcb_buddy_status( struct im_connection *ic, const char *handle, int flags, const char *state, const char *message );
274/* Not implemented yet! */ G_MODULE_EXPORT void imcb_buddy_times( struct im_connection *ic, const char *handle, time_t login, time_t idle );
275/* Call when a handle says something. 'flags' and 'sent_at may be just 0. */
276G_MODULE_EXPORT void imcb_buddy_msg( struct im_connection *ic, char *handle, char *msg, u_int32_t flags, time_t sent_at );
277G_MODULE_EXPORT void imcb_buddy_typing( struct im_connection *ic, char *handle, u_int32_t flags );
278
279/* Groupchats */
280G_MODULE_EXPORT void imcb_chat_invited( struct im_connection *ic, char *handle, char *who, char *msg, GList *data );
281/* These two functions are to create a group chat.
282 * - imcb_chat_new(): the 'handle' parameter identifies the chat, like the
283 *   channel name on IRC.
284 * - After you have a groupchat pointer, you should add the handles, finally
285 *   the user her/himself. At that point the group chat will be visible to the
286 *   user, too. */
287G_MODULE_EXPORT struct groupchat *imcb_chat_new( struct im_connection *ic, char *handle );
288G_MODULE_EXPORT void imcb_chat_add_buddy( struct groupchat *b, char *handle );
289/* To remove a handle from a group chat. Reason can be NULL. */
290G_MODULE_EXPORT void imcb_chat_remove_buddy( struct groupchat *b, char *handle, char *reason );
291/* To tell BitlBee 'who' said 'msg' in 'c'. 'flags' and 'sent_at' can be 0. */
292G_MODULE_EXPORT void imcb_chat_msg( struct groupchat *c, char *who, char *msg, u_int32_t flags, time_t sent_at );
293G_MODULE_EXPORT void imcb_chat_removed( struct groupchat *c );
294struct groupchat *chat_by_channel( char *channel );
295
296/* Actions, or whatever. */
297int imc_set_away( struct im_connection *ic, char *away );
298int imc_buddy_msg( struct im_connection *ic, char *handle, char *msg, int flags );
299int imc_chat_msg( struct groupchat *c, char *msg, int flags );
300
301void imc_add_allow( struct im_connection *ic, char *handle );
302void imc_rem_allow( struct im_connection *ic, char *handle );
303void imc_add_block( struct im_connection *ic, char *handle );
304void imc_rem_block( struct im_connection *ic, char *handle );
305
306/* Misc. stuff */
307char *set_eval_away_devoice( set_t *set, char *value );
308gboolean auto_reconnect( gpointer data, gint fd, b_input_condition cond );
309void cancel_auto_reconnect( struct account *a );
310
311#endif
Note: See TracBrowser for help on using the repository browser.