source: protocols/nogaim.h @ c6ca3ee

Last change on this file since c6ca3ee was c6ca3ee, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-03-14T17:49:24Z

Some const/etc cleanups submitted by domen@… back in bug #431.

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