source: protocols/nogaim.h @ 7a9d968

Last change on this file since 7a9d968 was 3f44e43, checked in by dequis <dx@…>, at 2016-11-21T07:49:26Z

Merge branch 'master' into parson
  • Property mode set to 100644
File size: 16.2 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#define OPT_SELFMESSAGE 0x00080000 /* A message sent by self from another location */
79
80/* ok. now the fun begins. first we create a connection structure */
81struct im_connection {
82        account_t *acc;
83        uint32_t flags;
84
85        /* each connection then can have its own protocol-specific data */
86        void *proto_data;
87
88        /* all connections need an input watcher */
89        int inpa;
90        guint keepalive;
91
92        /* buddy list stuff. there is still a global groups for the buddy list, but
93         * we need to maintain our own set of buddies, and our own permit/deny lists */
94        GSList *permit;
95        GSList *deny;
96        int permdeny;
97
98        char *away;
99
100        /* BitlBee */
101        bee_t *bee;
102
103        GSList *groupchats;
104        GSList *chatlist;
105};
106
107struct groupchat {
108        struct im_connection *ic;
109
110        /* stuff used just for chat */
111        /* The in_room variable is a list of handles (not nicks!), kind of
112         * "nick list". This is how you can check who is in the group chat
113         * already, for example to avoid adding somebody two times. */
114        GList *in_room;
115        //GList *ignored;
116
117        //struct groupchat *next;
118        /* The title variable contains the ID you gave when you created the
119         * chat using imcb_chat_new(). */
120        char *title;
121        /* Use imcb_chat_topic() to change this variable otherwise the user
122         * won't notice the topic change. */
123        char *topic;
124        char joined;
125        /* This is for you, you can add your own structure here to extend this
126         * structure for your protocol's needs. */
127        void *data;
128        void *ui_data;
129};
130
131struct buddy {
132        char name[80];
133        char show[BUDDY_ALIAS_MAXLEN];
134        int present;
135        time_t signon;
136        time_t idle;
137        int uc;
138        guint caps; /* woohoo! */
139        void *proto_data; /* what a hack */
140        struct im_connection *ic; /* the connection it belongs to */
141};
142
143struct buddy_action {
144        char *name;
145        char *description;
146};
147
148/* This enum takes a few things from libpurple and a few things from old OPT_ flags.
149 * The only flag that was used before this struct was PRPL_OPT_NOOTR.
150 *
151 * The libpurple ones only use the same values as the PurpleProtocolOptions
152 * enum for convenience, but there's no promise of direct compatibility with
153 * those values. As of libpurple 2.8.0 they use up to 0x800 (1 << 11), which is
154 * a nice coincidence.
155 */
156typedef enum {
157        /* The protocol doesn't use passwords
158         * Mirrors libpurple's OPT_PROTO_NO_PASSWORD */
159        PRPL_OPT_NO_PASSWORD = 1 << 4,
160
161        /* The protocol doesn't require passwords, but may use them
162         * Mirrors libpurple's OPT_PROTO_PASSWORD_OPTIONAL */
163        PRPL_OPT_PASSWORD_OPTIONAL = 1 << 7,
164
165        /* The protocol is not suitable for OTR, see OPT_NOOTR */
166        PRPL_OPT_NOOTR = 1 << 12,
167} prpl_options_t;
168
169struct prpl {
170        int options;
171        /* You should set this to the name of your protocol.
172         * - The user sees this name ie. when imcb_log() is used. */
173        const char *name;
174        void *data;
175        /* Maximum Message Size of this protocol.
176         * - Introduced for OTR, in order to fragment large protocol messages.
177         * - 0 means "unlimited". */
178        unsigned int mms;
179
180        /* Added this one to be able to add per-account settings, don't think
181         * it should be used for anything else. You are supposed to use the
182         * set_add() function to add new settings. */
183        void (* init)           (account_t *);
184        /* The typical usage of the login() function:
185         * - Create an im_connection using imcb_new() from the account_t parameter.
186         * - Initialize your myproto_data struct - you should store all your protocol-specific data there.
187         * - Save your custom structure to im_connection->proto_data.
188         * - Use proxy_connect() to connect to the server.
189         */
190        void (* login)          (account_t *);
191        /* Implementing this function is optional. */
192        void (* keepalive)      (struct im_connection *);
193        /* In this function you should:
194         * - Tell the server about you are logging out.
195         * - g_free() your myproto_data struct as BitlBee does not know how to
196         *   properly do so.
197         */
198        void (* logout)         (struct im_connection *);
199
200        /* This function is called when the user wants to send a message to a handle.
201         * - 'to' is a handle, not a nick
202         * - 'flags' may be ignored
203         */
204        int (* buddy_msg)      (struct im_connection *, char *to, char *message, int flags);
205        /* This function is called then the user uses the /away IRC command.
206         * - 'state' contains the away reason.
207         * - 'message' may be ignored if your protocol does not support it.
208         */
209        void (* set_away)       (struct im_connection *, char *state, char *message);
210        /* Implementing this function is optional. */
211        int (* send_typing)    (struct im_connection *, char *who, int flags);
212
213        /* 'name' is a handle to add/remove. For now BitlBee doesn't really
214         * handle groups, just set it to NULL, so you can ignore that
215         * parameter. */
216        void (* add_buddy)      (struct im_connection *, char *name, char *group);
217        void (* remove_buddy)   (struct im_connection *, char *name, char *group);
218
219        /* Block list stuff. Implementing these are optional. */
220        void (* add_permit)     (struct im_connection *, char *who);
221        void (* add_deny)       (struct im_connection *, char *who);
222        void (* rem_permit)     (struct im_connection *, char *who);
223        void (* rem_deny)       (struct im_connection *, char *who);
224
225        /* Request profile info. Free-formatted stuff, the IM module gives back
226           this info via imcb_log(). Implementing these are optional. */
227        void (* get_info)       (struct im_connection *, char *who);
228
229        /* Group chat stuff. */
230        /* This is called when the user uses the /invite IRC command.
231         * - 'who' may be ignored
232         * - 'message' is a handle to invite
233         */
234        void (* chat_invite)    (struct groupchat *, char *who, char *message);
235        /* This is called when the user uses the /kick IRC command.
236         * - 'who' is a handle to kick
237         * - 'message' is a kick message or NULL
238         */
239        void (* chat_kick)      (struct groupchat *, char *who, const char *message);
240        /* This is called when the user uses the /part IRC command in a group
241         * chat. You just should tell the user about it, nothing more. */
242        void (* chat_leave)     (struct groupchat *);
243        /* This is called when the user sends a message to the groupchat.
244         * 'flags' may be ignored. */
245        void (* chat_msg)       (struct groupchat *, char *message, int flags);
246        /* This is called when the user uses the /join #nick IRC command.
247         * - 'who' is the handle of the nick
248         */
249        struct groupchat *
250        (* chat_with)      (struct im_connection *, char *who);
251        /* This is used when the user uses the /join #channel IRC command.  If
252         * your protocol does not support publicly named group chats, then do
253         * not implement this. */
254        struct groupchat *
255        (* chat_join)      (struct im_connection *, const char *room,
256                            const char *nick, const char *password, set_t **sets);
257        /* Change the topic, if supported. Note that BitlBee expects the IM
258           server to confirm the topic change with a regular topic change
259           event. If it doesn't do that, you have to fake it to make it
260           visible to the user. */
261        void (* chat_topic)     (struct groupchat *, char *topic);
262
263        /* If your protocol module needs any special info for joining chatrooms
264           other than a roomname + nickname, add them here. */
265        void (* chat_add_settings)      (account_t *acc, set_t **head);
266        void (* chat_free_settings)     (account_t *acc, set_t **head);
267
268        /* You can tell what away states your protocol supports, so that
269         * BitlBee will try to map the IRC away reasons to them. If your
270         * protocol doesn't have any, just return one generic "Away". */
271        GList *(* away_states)(struct im_connection *ic);
272
273        /* Mainly for AOL, since they think "Bung hole" == "Bu ngho le". *sigh*
274         * - Most protocols will just want to set this to g_strcasecmp().*/
275        int (* handle_cmp) (const char *who1, const char *who2);
276
277        /* Implement these callbacks if you want to use imcb_ask_auth() */
278        void (* auth_allow)     (struct im_connection *, const char *who);
279        void (* auth_deny)      (struct im_connection *, const char *who);
280
281        /* Incoming transfer request */
282        void (* transfer_request) (struct im_connection *, file_transfer_t *ft, char *handle);
283
284        void (* buddy_data_add) (struct bee_user *bu);
285        void (* buddy_data_free) (struct bee_user *bu);
286
287        GList *(* buddy_action_list) (struct bee_user *bu);
288        void *(* buddy_action) (struct bee_user *bu, const char *action, char * const args[], void *data);
289
290        /* If null, equivalent to handle_cmp( ic->acc->user, who ) */
291        gboolean (* handle_is_self) (struct im_connection *, const char *who);
292
293        /* This sets/updates the im_connection->chatlist field with a
294         * bee_chat_info_t GSList. This function should ensure the
295         * bee_chat_list_finish() function gets called at some point
296         * after the chat list is completely updated.
297         */
298        void (* chat_list) (struct im_connection *, const char *server);
299
300        /* Some placeholders so eventually older plugins may cooperate with newer BitlBees. */
301        void *resv1;
302        void *resv2;
303        void *resv3;
304        void *resv4;
305        void *resv5;
306};
307
308struct plugin_info
309{
310        guint abiver;
311        const char *name;
312        const char *version;
313        const char *description;
314        const char *author;
315        const char *url;
316};
317
318#ifdef WITH_PLUGINS
319G_MODULE_EXPORT GList *get_plugins();
320#endif
321
322/* im_api core stuff. */
323void nogaim_init();
324G_MODULE_EXPORT GList *get_protocols();
325G_MODULE_EXPORT GList *get_protocols_disabled();
326G_MODULE_EXPORT GSList *get_connections();
327G_MODULE_EXPORT struct prpl *find_protocol(const char *name);
328G_MODULE_EXPORT gboolean is_protocol_disabled(const char *name);
329G_MODULE_EXPORT char *explain_unknown_protocol(const char *name);
330/* When registering a new protocol, you should allocate space for a new prpl
331 * struct, initialize it (set the function pointers to point to your
332 * functions), finally call this function. */
333G_MODULE_EXPORT void register_protocol(struct prpl *);
334
335/* Connection management. */
336/* You will need this function in prpl->login() to get an im_connection from
337 * the account_t parameter. */
338G_MODULE_EXPORT struct im_connection *imcb_new(account_t *acc);
339G_MODULE_EXPORT void imc_free(struct im_connection *ic);
340/* Once you're connected, you should call this function, so that the user will
341 * see the success. */
342G_MODULE_EXPORT void imcb_connected(struct im_connection *ic);
343/* This can be used to disconnect when something went wrong (ie. read error
344 * from the server). You probably want to set the second parameter to TRUE. */
345G_MODULE_EXPORT void imc_logout(struct im_connection *ic, int allow_reconnect);
346
347/* Communicating with the user. */
348/* A printf()-like function to tell the user anything you want. */
349G_MODULE_EXPORT void imcb_log(struct im_connection *ic, char *format, ...) G_GNUC_PRINTF(2, 3);
350/* To tell the user an error, ie. before logging out when an error occurs. */
351G_MODULE_EXPORT void imcb_error(struct im_connection *ic, char *format, ...) G_GNUC_PRINTF(2, 3);
352
353/* To ask a your about something.
354 * - 'msg' is the question.
355 * - 'data' can be your custom struct - it will be passed to the callbacks.
356 * - 'doit' or 'dont' will be called depending of the answer of the user.
357 */
358G_MODULE_EXPORT void imcb_ask(struct im_connection *ic, char *msg, void *data, query_callback doit,
359                              query_callback dont);
360G_MODULE_EXPORT void imcb_ask_with_free(struct im_connection *ic, char *msg, void *data, query_callback doit,
361                                        query_callback dont, query_callback myfree);
362
363/* Two common questions you may want to ask:
364 * - X added you to his contact list, allow?
365 * - X is not in your contact list, want to add?
366 */
367G_MODULE_EXPORT void imcb_ask_auth(struct im_connection *ic, const char *handle, const char *realname);
368G_MODULE_EXPORT void imcb_ask_add(struct im_connection *ic, const char *handle, const char *realname);
369
370/* Buddy management */
371/* This function should be called for each handle which are visible to the
372 * user, usually after a login, or if the user added a buddy and the IM
373 * server confirms that the add was successful. Don't forget to do this! */
374G_MODULE_EXPORT void imcb_add_buddy(struct im_connection *ic, const char *handle, const char *group);
375G_MODULE_EXPORT void imcb_remove_buddy(struct im_connection *ic, const char *handle, char *group);
376G_MODULE_EXPORT void imcb_rename_buddy(struct im_connection *ic, const char *handle, const char *realname);
377G_MODULE_EXPORT void imcb_buddy_nick_hint(struct im_connection *ic, const char *handle, const char *nick);
378G_MODULE_EXPORT void imcb_buddy_nick_change(struct im_connection *ic, const char *handle, const char *nick);
379G_MODULE_EXPORT void imcb_buddy_action_response(bee_user_t *bu, const char *action, char * const args[], void *data);
380G_MODULE_EXPORT GSList *imcb_get_local_contacts(struct im_connection *ic);
381
382G_MODULE_EXPORT void imcb_buddy_typing(struct im_connection *ic, const char *handle, guint32 flags);
383G_MODULE_EXPORT struct bee_user *imcb_buddy_by_handle(struct im_connection *ic, const char *handle);
384
385G_GNUC_DEPRECATED G_MODULE_EXPORT void imcb_clean_handle(struct im_connection *ic, char *handle);
386
387/* Actions, or whatever. */
388int imc_away_send_update(struct im_connection *ic);
389int imc_chat_msg(struct groupchat *c, char *msg, int flags);
390
391void imc_add_allow(struct im_connection *ic, char *handle);
392void imc_rem_allow(struct im_connection *ic, char *handle);
393void imc_add_block(struct im_connection *ic, char *handle);
394void imc_rem_block(struct im_connection *ic, char *handle);
395
396/* Misc. stuff */
397char *set_eval_timezone(set_t *set, char *value);
398gboolean auto_reconnect(gpointer data, gint fd, b_input_condition cond);
399void cancel_auto_reconnect(struct account *a);
400
401#endif
Note: See TracBrowser for help on using the repository browser.