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