source: protocols/nogaim.h @ b5cfc2b

Last change on this file since b5cfc2b was b79308b, checked in by ulim <a.sporto+bee@…>, at 2008-04-14T13:10:53Z

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