source: protocols/nogaim.h @ bf2ebd8

1.3dev
Last change on this file since bf2ebd8 was f6f5eee, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-07-27T22:04:19Z

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