source: protocols/nogaim.h @ 256899f

Last change on this file since 256899f was ef5c185, checked in by Wilmer van der Gaast <wilmer@…>, at 2007-11-19T23:14:39Z

Added Jabber groupchat topic support.
  • Property mode set to 100644
File size: 13.7 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_LOCALBUDDY  0x00000020 /* For nicks local to one groupchat */
64#define OPT_TYPING      0x00000100 /* Some pieces of code make assumptions */
65#define OPT_THINKING    0x00000200 /* about these values... Stupid me! */
66
67/* ok. now the fun begins. first we create a connection structure */
68struct im_connection
69{
70        account_t *acc;
71        u_int32_t flags;
72       
73        /* each connection then can have its own protocol-specific data */
74        void *proto_data;
75       
76        /* all connections need an input watcher */
77        int inpa;
78        guint keepalive;
79       
80        /* buddy list stuff. there is still a global groups for the buddy list, but
81         * we need to maintain our own set of buddies, and our own permit/deny lists */
82        GSList *permit;
83        GSList *deny;
84        int permdeny;
85       
86        char displayname[128];
87        char *away;
88       
89        int evil;
90       
91        /* BitlBee */
92        irc_t *irc;
93       
94        struct groupchat *groupchats;
95};
96
97struct groupchat {
98        struct im_connection *ic;
99
100        /* stuff used just for chat */
101        /* The in_room variable is a list of handles (not nicks!), kind of
102         * "nick list". This is how you can check who is in the group chat
103         * already, for example to avoid adding somebody two times. */
104        GList *in_room;
105        GList *ignored;
106       
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        /* Use imcb_chat_topic() to change this variable otherwise the user
113         * won't notice the topic change. */
114        char *topic;
115        char joined;
116        /* This is for you, you can add your own structure here to extend this
117         * structure for your protocol's needs. */
118        void *data;
119};
120
121struct buddy {
122        char name[80];
123        char show[BUDDY_ALIAS_MAXLEN];
124        int present;
125        int evil;
126        time_t signon;
127        time_t idle;
128        int uc;
129        guint caps; /* woohoo! */
130        void *proto_data; /* what a hack */
131        struct im_connection *ic; /* the connection it belongs to */
132};
133
134struct prpl {
135        int options;
136        /* You should set this to the name of your protocol.
137         * - The user sees this name ie. when imcb_log() is used. */
138        const char *name;
139
140        /* Added this one to be able to add per-account settings, don't think
141         * it should be used for anything else. You are supposed to use the
142         * set_add() function to add new settings. */
143        void (* init)           (account_t *);
144        /* The typical usage of the login() function:
145         * - Create an im_connection using imcb_new() from the account_t parameter.
146         * - Initialize your myproto_data struct - you should store all your protocol-specific data there.
147         * - Save your custom structure to im_connection->proto_data.
148         * - Use proxy_connect() to connect to the server.
149         */
150        void (* login)          (account_t *);
151        /* Implementing this function is optional. */
152        void (* keepalive)      (struct im_connection *);
153        /* In this function you should:
154         * - Tell the server about you are logging out.
155         * - g_free() your myproto_data struct as BitlBee does not know how to
156         *   properly do so.
157         */
158        void (* logout)         (struct im_connection *);
159       
160        /* This function is called when the user wants to send a message to a handle.
161         * - 'to' is a handle, not a nick
162         * - 'flags' may be ignored
163         */
164        int  (* buddy_msg)      (struct im_connection *, char *to, char *message, int flags);
165        /* This function is called then the user uses the /away IRC command.
166         * - 'state' contains the away reason.
167         * - 'message' may be ignored if your protocol does not support it.
168         */
169        void (* set_away)       (struct im_connection *, char *state, char *message);
170        /* Implementing this function is optional. */
171        void (* get_away)       (struct im_connection *, char *who);
172        /* Implementing this function is optional. */
173        int  (* send_typing)    (struct im_connection *, char *who, int flags);
174       
175        /* 'name' is a handle to add/remove. For now BitlBee doesn't really
176         * handle groups, just set it to NULL, so you can ignore that
177         * parameter. */
178        void (* add_buddy)      (struct im_connection *, char *name, char *group);
179        void (* remove_buddy)   (struct im_connection *, char *name, char *group);
180       
181        /* Block list stuff. Implementing these are optional. */
182        void (* add_permit)     (struct im_connection *, char *who);
183        void (* add_deny)       (struct im_connection *, char *who);
184        void (* rem_permit)     (struct im_connection *, char *who);
185        void (* rem_deny)       (struct im_connection *, char *who);
186        /* Doesn't actually have UI hooks. */
187        void (* set_permit_deny)(struct im_connection *);
188       
189        /* Request profile info. Free-formatted stuff, the IM module gives back
190           this info via imcb_log(). Implementing these are optional. */
191        void (* get_info)       (struct im_connection *, char *who);
192        void (* set_my_name)    (struct im_connection *, char *name);
193        void (* set_name)       (struct im_connection *, char *who, char *name);
194       
195        /* Group chat stuff. */
196        /* This is called when the user uses the /invite IRC command.
197         * - 'who' may be ignored
198         * - 'message' is a handle to invite
199         */
200        void (* chat_invite)    (struct groupchat *, char *who, char *message);
201        /* This is called when the user uses the /part IRC command in a group
202         * chat. You just should tell the user about it, nothing more. */
203        void (* chat_leave)     (struct groupchat *);
204        /* This is called when the user sends a message to the groupchat.
205         * 'flags' may be ignored. */
206        void (* chat_msg)       (struct groupchat *, char *message, int flags);
207        /* This is called when the user uses the /join #nick IRC command.
208         * - 'who' is the handle of the nick
209         */
210        struct groupchat *
211             (* chat_with)      (struct im_connection *, char *who);
212        /* This is used when the user uses the /join #channel IRC command.  If
213         * your protocol does not support publicly named group chats, then do
214         * not implement this. */
215        struct groupchat *
216             (* chat_join)      (struct im_connection *, char *room, char *nick, char *password);
217        /* Change the topic, if supported. Note that BitlBee expects the IM
218           server to confirm the topic change with a regular topic change
219           event. If it doesn't do that, you have to fake it to make it
220           visible to the user. */
221        void (* chat_topic)     (struct groupchat *, char *topic);
222       
223        /* You can tell what away states your protocol supports, so that
224         * BitlBee will try to map the IRC away reasons to them, or use
225         * GAIM_AWAY_CUSTOM when calling skype_set_away(). */
226        GList *(* away_states)(struct im_connection *ic);
227       
228        /* Mainly for AOL, since they think "Bung hole" == "Bu ngho le". *sigh*
229         * - Most protocols will just want to set this to g_strcasecmp().*/
230        int (* handle_cmp) (const char *who1, const char *who2);
231};
232
233/* im_api core stuff. */
234void nogaim_init();
235G_MODULE_EXPORT GSList *get_connections();
236G_MODULE_EXPORT struct prpl *find_protocol( const char *name );
237/* When registering a new protocol, you should allocate space for a new prpl
238 * struct, initialize it (set the function pointers to point to your
239 * functions), finally call this function. */
240G_MODULE_EXPORT void register_protocol( struct prpl * );
241
242/* Connection management. */
243/* You will need this function in prpl->login() to get an im_connection from
244 * the account_t parameter. */
245G_MODULE_EXPORT struct im_connection *imcb_new( account_t *acc );
246G_MODULE_EXPORT void imcb_free( struct im_connection *ic );
247/* Once you're connected, you should call this function, so that the user will
248 * see the success. */
249G_MODULE_EXPORT void imcb_connected( struct im_connection *ic );
250/* This can be used to disconnect when something went wrong (ie. read error
251 * from the server). You probably want to set the second parameter to TRUE. */
252G_MODULE_EXPORT void imc_logout( struct im_connection *ic, int allow_reconnect );
253
254/* Communicating with the user. */
255/* A printf()-like function to tell the user anything you want. */
256G_MODULE_EXPORT void imcb_log( struct im_connection *ic, char *format, ... ) G_GNUC_PRINTF( 2, 3 );
257/* To tell the user an error, ie. before logging out when an error occurs. */
258G_MODULE_EXPORT void imcb_error( struct im_connection *ic, char *format, ... ) G_GNUC_PRINTF( 2, 3 );
259/* To ask a your about something.
260 * - 'msg' is the question.
261 * - 'data' can be your custom struct - it will be passed to the callbacks.
262 * - 'doit' or 'dont' will be called depending of the answer of the user.
263 */
264G_MODULE_EXPORT void imcb_ask( struct im_connection *ic, char *msg, void *data, void *doit, void *dont );
265G_MODULE_EXPORT void imcb_ask_add( struct im_connection *ic, char *handle, const char *realname );
266
267/* Buddy management */
268/* This function should be called for each handle which are visible to the
269 * user, usually after a login, or if the user added a buddy and the IM
270 * server confirms that the add was successful. Don't forget to do this! */
271G_MODULE_EXPORT void imcb_add_buddy( struct im_connection *ic, char *handle, char *group );
272G_MODULE_EXPORT void imcb_remove_buddy( struct im_connection *ic, char *handle, char *group );
273G_MODULE_EXPORT struct buddy *imcb_find_buddy( struct im_connection *ic, char *handle );
274G_MODULE_EXPORT void imcb_rename_buddy( struct im_connection *ic, char *handle, char *realname );
275G_MODULE_EXPORT void imcb_buddy_nick_hint( struct im_connection *ic, char *handle, char *nick );
276
277/* Buddy activity */
278/* To manipulate the status of a handle.
279 * - flags can be |='d with OPT_* constants. You will need at least:
280 *   OPT_LOGGED_IN and OPT_AWAY.
281 * - 'state' and 'message' can be NULL */
282G_MODULE_EXPORT void imcb_buddy_status( struct im_connection *ic, const char *handle, int flags, const char *state, const char *message );
283/* Not implemented yet! */ G_MODULE_EXPORT void imcb_buddy_times( struct im_connection *ic, const char *handle, time_t login, time_t idle );
284/* Call when a handle says something. 'flags' and 'sent_at may be just 0. */
285G_MODULE_EXPORT void imcb_buddy_msg( struct im_connection *ic, char *handle, char *msg, u_int32_t flags, time_t sent_at );
286G_MODULE_EXPORT void imcb_buddy_typing( struct im_connection *ic, char *handle, u_int32_t flags );
287G_MODULE_EXPORT void imcb_clean_handle( struct im_connection *ic, char *handle );
288
289/* Groupchats */
290G_MODULE_EXPORT void imcb_chat_invited( struct im_connection *ic, char *handle, char *who, char *msg, GList *data );
291/* These two functions are to create a group chat.
292 * - imcb_chat_new(): the 'handle' parameter identifies the chat, like the
293 *   channel name on IRC.
294 * - After you have a groupchat pointer, you should add the handles, finally
295 *   the user her/himself. At that point the group chat will be visible to the
296 *   user, too. */
297G_MODULE_EXPORT struct groupchat *imcb_chat_new( struct im_connection *ic, char *handle );
298G_MODULE_EXPORT void imcb_chat_add_buddy( struct groupchat *b, char *handle );
299/* To remove a handle from a group chat. Reason can be NULL. */
300G_MODULE_EXPORT void imcb_chat_remove_buddy( struct groupchat *b, char *handle, char *reason );
301/* To tell BitlBee 'who' said 'msg' in 'c'. 'flags' and 'sent_at' can be 0. */
302G_MODULE_EXPORT void imcb_chat_msg( struct groupchat *c, char *who, char *msg, u_int32_t flags, time_t sent_at );
303/* To tell BitlBee 'who' changed the topic of 'c' to 'topic'. */
304G_MODULE_EXPORT void imcb_chat_topic( struct groupchat *c, char *who, char *topic, time_t set_at );
305G_MODULE_EXPORT void imcb_chat_free( struct groupchat *c );
306
307/* Actions, or whatever. */
308int imc_set_away( struct im_connection *ic, char *away );
309int imc_buddy_msg( struct im_connection *ic, char *handle, char *msg, int flags );
310int imc_chat_msg( struct groupchat *c, char *msg, int flags );
311
312void imc_add_allow( struct im_connection *ic, char *handle );
313void imc_rem_allow( struct im_connection *ic, char *handle );
314void imc_add_block( struct im_connection *ic, char *handle );
315void imc_rem_block( struct im_connection *ic, char *handle );
316
317/* Misc. stuff */
318char *set_eval_away_devoice( set_t *set, char *value );
319gboolean auto_reconnect( gpointer data, gint fd, b_input_condition cond );
320void cancel_auto_reconnect( struct account *a );
321
322#endif
Note: See TracBrowser for help on using the repository browser.