source: protocols/nogaim.h @ e1bea35

Last change on this file since e1bea35 was 3d45471, checked in by Wilmer van der Gaast <wilmer@…>, at 2015-02-22T14:49:58Z

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