source: protocols/nogaim.h @ 10d089d

Last change on this file since 10d089d was 8c3637b, checked in by Wilmer van der Gaast <wilmer@…>, at 2015-05-24T19:43:09Z

imcb_get_local_contacts() so an IM plugin can request the local contact list
before finishing login. Makes sense since processing the contact list can be
a major part of the login process.
  • Property mode set to 100644
File size: 14.5 KB
Line 
1/********************************************************************\
2  * BitlBee -- An IRC to other IM-networks gateway                     *
3  *                                                                    *
4  * Copyright 2002-2012 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-2012 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., 51 Franklin St.,
35  Fifth Floor, Boston, MA  02110-1301  USA
36*/
37
38#ifndef _NOGAIM_H
39#define _NOGAIM_H
40
41#if (__sun)
42#include <inttypes.h>
43#else
44#include <stdint.h>
45#endif
46
47#include "bitlbee.h"
48#include "account.h"
49#include "proxy.h"
50#include "query.h"
51#include "md5.h"
52#include "ft.h"
53
54#define BUDDY_ALIAS_MAXLEN 388   /* because MSN names can be 387 characters */
55
56#define WEBSITE "http://www.bitlbee.org/"
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   
61   Argh! This needs to be renamed to be more clear which field they're used
62   for. As said it's currently mixed which is nonsense. Some are for the
63   im_connection flags field, some for imcb_buddy_status(), some for typing
64   notifications, and who knows what else... */
65#define OPT_LOGGED_IN   0x00000001
66#define OPT_LOGGING_OUT 0x00000002
67#define OPT_AWAY        0x00000004
68#define OPT_MOBILE      0x00000008
69#define OPT_DOES_HTML   0x00000010
70#define OPT_LOCALBUDDY  0x00000020 /* For nicks local to one groupchat */
71#define OPT_SLOW_LOGIN  0x00000040 /* I.e. Twitter Oauth @ login time */
72#define OPT_TYPING      0x00000100 /* Some pieces of code make assumptions */
73#define OPT_THINKING    0x00000200 /* about these values... Stupid me! */
74#define OPT_NOOTR       0x00001000 /* protocol not suitable for OTR */
75#define OPT_PONGS       0x00010000 /* Service sends us keep-alives */
76#define OPT_PONGED      0x00020000 /* Received a keep-alive during last interval */
77#define OPT_LOCAL_CONTACTS_SENT 0x00040000 /* Protocol already requested local contact list, so don't send it after finishing login. */
78
79/* ok. now the fun begins. first we create a connection structure */
80struct im_connection {
81        account_t *acc;
82        uint32_t flags;
83
84        /* each connection then can have its own protocol-specific data */
85        void *proto_data;
86
87        /* all connections need an input watcher */
88        int inpa;
89        guint keepalive;
90
91        /* buddy list stuff. there is still a global groups for the buddy list, but
92         * we need to maintain our own set of buddies, and our own permit/deny lists */
93        GSList *permit;
94        GSList *deny;
95        int permdeny;
96
97        char *away;
98
99        /* BitlBee */
100        bee_t *bee;
101
102        GSList *groupchats;
103};
104
105struct groupchat {
106        struct im_connection *ic;
107
108        /* stuff used just for chat */
109        /* The in_room variable is a list of handles (not nicks!), kind of
110         * "nick list". This is how you can check who is in the group chat
111         * already, for example to avoid adding somebody two times. */
112        GList *in_room;
113        //GList *ignored;
114
115        //struct groupchat *next;
116        /* The title variable contains the ID you gave when you created the
117         * chat using imcb_chat_new(). */
118        char *title;
119        /* Use imcb_chat_topic() to change this variable otherwise the user
120         * won't notice the topic change. */
121        char *topic;
122        char joined;
123        /* This is for you, you can add your own structure here to extend this
124         * structure for your protocol's needs. */
125        void *data;
126        void *ui_data;
127};
128
129struct buddy {
130        char name[80];
131        char show[BUDDY_ALIAS_MAXLEN];
132        int present;
133        time_t signon;
134        time_t idle;
135        int uc;
136        guint caps; /* woohoo! */
137        void *proto_data; /* what a hack */
138        struct im_connection *ic; /* the connection it belongs to */
139};
140
141struct buddy_action {
142        char *name;
143        char *description;
144};
145
146struct prpl {
147        int options;
148        /* You should set this to the name of your protocol.
149         * - The user sees this name ie. when imcb_log() is used. */
150        const char *name;
151        void *data;
152        /* Maximum Message Size of this protocol.
153         * - Introduced for OTR, in order to fragment large protocol messages.
154         * - 0 means "unlimited". */
155        unsigned int mms;
156
157        /* Added this one to be able to add per-account settings, don't think
158         * it should be used for anything else. You are supposed to use the
159         * set_add() function to add new settings. */
160        void (* init)           (account_t *);
161        /* The typical usage of the login() function:
162         * - Create an im_connection using imcb_new() from the account_t parameter.
163         * - Initialize your myproto_data struct - you should store all your protocol-specific data there.
164         * - Save your custom structure to im_connection->proto_data.
165         * - Use proxy_connect() to connect to the server.
166         */
167        void (* login)          (account_t *);
168        /* Implementing this function is optional. */
169        void (* keepalive)      (struct im_connection *);
170        /* In this function you should:
171         * - Tell the server about you are logging out.
172         * - g_free() your myproto_data struct as BitlBee does not know how to
173         *   properly do so.
174         */
175        void (* logout)         (struct im_connection *);
176
177        /* This function is called when the user wants to send a message to a handle.
178         * - 'to' is a handle, not a nick
179         * - 'flags' may be ignored
180         */
181        int (* buddy_msg)      (struct im_connection *, char *to, char *message, int flags);
182        /* This function is called then the user uses the /away IRC command.
183         * - 'state' contains the away reason.
184         * - 'message' may be ignored if your protocol does not support it.
185         */
186        void (* set_away)       (struct im_connection *, char *state, char *message);
187        /* Implementing this function is optional. */
188        int (* send_typing)    (struct im_connection *, char *who, int flags);
189
190        /* 'name' is a handle to add/remove. For now BitlBee doesn't really
191         * handle groups, just set it to NULL, so you can ignore that
192         * parameter. */
193        void (* add_buddy)      (struct im_connection *, char *name, char *group);
194        void (* remove_buddy)   (struct im_connection *, char *name, char *group);
195
196        /* Block list stuff. Implementing these are optional. */
197        void (* add_permit)     (struct im_connection *, char *who);
198        void (* add_deny)       (struct im_connection *, char *who);
199        void (* rem_permit)     (struct im_connection *, char *who);
200        void (* rem_deny)       (struct im_connection *, char *who);
201
202        /* Request profile info. Free-formatted stuff, the IM module gives back
203           this info via imcb_log(). Implementing these are optional. */
204        void (* get_info)       (struct im_connection *, char *who);
205
206        /* Group chat stuff. */
207        /* This is called when the user uses the /invite IRC command.
208         * - 'who' may be ignored
209         * - 'message' is a handle to invite
210         */
211        void (* chat_invite)    (struct groupchat *, char *who, char *message);
212        /* This is called when the user uses the /kick IRC command.
213         * - 'who' is a handle to kick
214         * - 'message' is a kick message or NULL
215         */
216        void (* chat_kick)      (struct groupchat *, char *who, const char *message);
217        /* This is called when the user uses the /part IRC command in a group
218         * chat. You just should tell the user about it, nothing more. */
219        void (* chat_leave)     (struct groupchat *);
220        /* This is called when the user sends a message to the groupchat.
221         * 'flags' may be ignored. */
222        void (* chat_msg)       (struct groupchat *, char *message, int flags);
223        /* This is called when the user uses the /join #nick IRC command.
224         * - 'who' is the handle of the nick
225         */
226        struct groupchat *
227        (* chat_with)      (struct im_connection *, char *who);
228        /* This is used when the user uses the /join #channel IRC command.  If
229         * your protocol does not support publicly named group chats, then do
230         * not implement this. */
231        struct groupchat *
232        (* chat_join)      (struct im_connection *, const char *room,
233                            const char *nick, const char *password, set_t **sets);
234        /* Change the topic, if supported. Note that BitlBee expects the IM
235           server to confirm the topic change with a regular topic change
236           event. If it doesn't do that, you have to fake it to make it
237           visible to the user. */
238        void (* chat_topic)     (struct groupchat *, char *topic);
239
240        /* If your protocol module needs any special info for joining chatrooms
241           other than a roomname + nickname, add them here. */
242        void (* chat_add_settings)      (account_t *acc, set_t **head);
243        void (* chat_free_settings)     (account_t *acc, set_t **head);
244
245        /* You can tell what away states your protocol supports, so that
246         * BitlBee will try to map the IRC away reasons to them. If your
247         * protocol doesn't have any, just return one generic "Away". */
248        GList *(* away_states)(struct im_connection *ic);
249
250        /* Mainly for AOL, since they think "Bung hole" == "Bu ngho le". *sigh*
251         * - Most protocols will just want to set this to g_strcasecmp().*/
252        int (* handle_cmp) (const char *who1, const char *who2);
253
254        /* Implement these callbacks if you want to use imcb_ask_auth() */
255        void (* auth_allow)     (struct im_connection *, const char *who);
256        void (* auth_deny)      (struct im_connection *, const char *who);
257
258        /* Incoming transfer request */
259        void (* transfer_request) (struct im_connection *, file_transfer_t *ft, char *handle);
260
261        void (* buddy_data_add) (struct bee_user *bu);
262        void (* buddy_data_free) (struct bee_user *bu);
263
264        GList *(* buddy_action_list) (struct bee_user *bu);
265        void *(* buddy_action) (struct bee_user *bu, const char *action, char * const args[], void *data);
266
267        /* If null, equivalent to handle_cmp( ic->acc->user, who ) */
268        gboolean (* handle_is_self) (struct im_connection *, const char *who);
269
270        /* Some placeholders so eventually older plugins may cooperate with newer BitlBees. */
271        void *resv1;
272        void *resv2;
273        void *resv3;
274        void *resv4;
275        void *resv5;
276};
277
278/* im_api core stuff. */
279void nogaim_init();
280G_MODULE_EXPORT GSList *get_connections();
281G_MODULE_EXPORT struct prpl *find_protocol(const char *name);
282/* When registering a new protocol, you should allocate space for a new prpl
283 * struct, initialize it (set the function pointers to point to your
284 * functions), finally call this function. */
285G_MODULE_EXPORT void register_protocol(struct prpl *);
286
287/* Connection management. */
288/* You will need this function in prpl->login() to get an im_connection from
289 * the account_t parameter. */
290G_MODULE_EXPORT struct im_connection *imcb_new(account_t *acc);
291G_MODULE_EXPORT void imc_free(struct im_connection *ic);
292/* Once you're connected, you should call this function, so that the user will
293 * see the success. */
294G_MODULE_EXPORT void imcb_connected(struct im_connection *ic);
295/* This can be used to disconnect when something went wrong (ie. read error
296 * from the server). You probably want to set the second parameter to TRUE. */
297G_MODULE_EXPORT void imc_logout(struct im_connection *ic, int allow_reconnect);
298
299/* Communicating with the user. */
300/* A printf()-like function to tell the user anything you want. */
301G_MODULE_EXPORT void imcb_log(struct im_connection *ic, char *format, ...) G_GNUC_PRINTF(2, 3);
302/* To tell the user an error, ie. before logging out when an error occurs. */
303G_MODULE_EXPORT void imcb_error(struct im_connection *ic, char *format, ...) G_GNUC_PRINTF(2, 3);
304
305/* To ask a your about something.
306 * - 'msg' is the question.
307 * - 'data' can be your custom struct - it will be passed to the callbacks.
308 * - 'doit' or 'dont' will be called depending of the answer of the user.
309 */
310G_MODULE_EXPORT void imcb_ask(struct im_connection *ic, char *msg, void *data, query_callback doit,
311                              query_callback dont);
312G_MODULE_EXPORT void imcb_ask_with_free(struct im_connection *ic, char *msg, void *data, query_callback doit,
313                                        query_callback dont, query_callback myfree);
314
315/* Two common questions you may want to ask:
316 * - X added you to his contact list, allow?
317 * - X is not in your contact list, want to add?
318 */
319G_MODULE_EXPORT void imcb_ask_auth(struct im_connection *ic, const char *handle, const char *realname);
320G_MODULE_EXPORT void imcb_ask_add(struct im_connection *ic, const char *handle, const char *realname);
321
322/* Buddy management */
323/* This function should be called for each handle which are visible to the
324 * user, usually after a login, or if the user added a buddy and the IM
325 * server confirms that the add was successful. Don't forget to do this! */
326G_MODULE_EXPORT void imcb_add_buddy(struct im_connection *ic, const char *handle, const char *group);
327G_MODULE_EXPORT void imcb_remove_buddy(struct im_connection *ic, const char *handle, char *group);
328G_MODULE_EXPORT struct buddy *imcb_find_buddy(struct im_connection *ic, char *handle);
329G_MODULE_EXPORT void imcb_rename_buddy(struct im_connection *ic, const char *handle, const char *realname);
330G_MODULE_EXPORT void imcb_buddy_nick_hint(struct im_connection *ic, const char *handle, const char *nick);
331G_MODULE_EXPORT void imcb_buddy_action_response(bee_user_t *bu, const char *action, char * const args[], void *data);
332G_MODULE_EXPORT GSList *imcb_get_local_contacts(struct im_connection *ic);
333
334G_MODULE_EXPORT void imcb_buddy_typing(struct im_connection *ic, const char *handle, uint32_t flags);
335G_MODULE_EXPORT struct bee_user *imcb_buddy_by_handle(struct im_connection *ic, const char *handle);
336G_MODULE_EXPORT void imcb_clean_handle(struct im_connection *ic, char *handle);
337
338/* Actions, or whatever. */
339int imc_away_send_update(struct im_connection *ic);
340int imc_chat_msg(struct groupchat *c, char *msg, int flags);
341
342void imc_add_allow(struct im_connection *ic, char *handle);
343void imc_rem_allow(struct im_connection *ic, char *handle);
344void imc_add_block(struct im_connection *ic, char *handle);
345void imc_rem_block(struct im_connection *ic, char *handle);
346
347/* Misc. stuff */
348char *set_eval_timezone(set_t *set, char *value);
349gboolean auto_reconnect(gpointer data, gint fd, b_input_condition cond);
350void cancel_auto_reconnect(struct account *a);
351
352#endif
Note: See TracBrowser for help on using the repository browser.