source: protocols/nogaim.h @ bfe7caa

Last change on this file since bfe7caa was 31e5846, checked in by Wilmer van der Gaast <wilmer@…>, at 2008-01-20T00:17:57Z

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