source: protocols/nogaim.h @ b41d5d2

Last change on this file since b41d5d2 was 748bcdd, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-11-21T15:23:54Z

Time out if logging in takes too long (2m for now). Except for Twitter
OAuth login, which requires user action. This mostly solves problems with
OSCAR login silently failing, but may also be useful in other places.
  • Property mode set to 100644
File size: 13.6 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#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
71/* ok. now the fun begins. first we create a connection structure */
72struct im_connection
73{
74        account_t *acc;
75        uint32_t flags;
76       
77        /* each connection then can have its own protocol-specific data */
78        void *proto_data;
79       
80        /* all connections need an input watcher */
81        int inpa;
82        guint keepalive;
83       
84        /* buddy list stuff. there is still a global groups for the buddy list, but
85         * we need to maintain our own set of buddies, and our own permit/deny lists */
86        GSList *permit;
87        GSList *deny;
88        int permdeny;
89       
90        char displayname[128];
91        char *away;
92       
93        int evil;
94       
95        /* BitlBee */
96        bee_t *bee;
97       
98        GSList *groupchats;
99};
100
101struct groupchat {
102        struct im_connection *ic;
103
104        /* stuff used just for chat */
105        /* The in_room variable is a list of handles (not nicks!), kind of
106         * "nick list". This is how you can check who is in the group chat
107         * already, for example to avoid adding somebody two times. */
108        GList *in_room;
109        //GList *ignored;
110       
111        //struct groupchat *next;
112        /* The title variable contains the ID you gave when you created the
113         * chat using imcb_chat_new(). */
114        char *title;
115        /* Use imcb_chat_topic() to change this variable otherwise the user
116         * won't notice the topic change. */
117        char *topic;
118        char joined;
119        /* This is for you, you can add your own structure here to extend this
120         * structure for your protocol's needs. */
121        void *data;
122        void *ui_data;
123};
124
125struct buddy {
126        char name[80];
127        char show[BUDDY_ALIAS_MAXLEN];
128        int present;
129        int evil;
130        time_t signon;
131        time_t idle;
132        int uc;
133        guint caps; /* woohoo! */
134        void *proto_data; /* what a hack */
135        struct im_connection *ic; /* the connection it belongs to */
136};
137
138struct prpl {
139        int options;
140        /* You should set this to the name of your protocol.
141         * - The user sees this name ie. when imcb_log() is used. */
142        const char *name;
143        void *data;
144        /* Maximum Message Size of this protocol.
145         * - Introduced for OTR, in order to fragment large protocol messages.
146         * - 0 means "unlimited". */
147        unsigned int mms;
148
149        /* Added this one to be able to add per-account settings, don't think
150         * it should be used for anything else. You are supposed to use the
151         * set_add() function to add new settings. */
152        void (* init)           (account_t *);
153        /* The typical usage of the login() function:
154         * - Create an im_connection using imcb_new() from the account_t parameter.
155         * - Initialize your myproto_data struct - you should store all your protocol-specific data there.
156         * - Save your custom structure to im_connection->proto_data.
157         * - Use proxy_connect() to connect to the server.
158         */
159        void (* login)          (account_t *);
160        /* Implementing this function is optional. */
161        void (* keepalive)      (struct im_connection *);
162        /* In this function you should:
163         * - Tell the server about you are logging out.
164         * - g_free() your myproto_data struct as BitlBee does not know how to
165         *   properly do so.
166         */
167        void (* logout)         (struct im_connection *);
168       
169        /* This function is called when the user wants to send a message to a handle.
170         * - 'to' is a handle, not a nick
171         * - 'flags' may be ignored
172         */
173        int  (* buddy_msg)      (struct im_connection *, char *to, char *message, int flags);
174        /* This function is called then the user uses the /away IRC command.
175         * - 'state' contains the away reason.
176         * - 'message' may be ignored if your protocol does not support it.
177         */
178        void (* set_away)       (struct im_connection *, char *state, char *message);
179        /* Implementing this function is optional. */
180        void (* get_away)       (struct im_connection *, char *who);
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        /* Doesn't actually have UI hooks. */
196        void (* set_permit_deny)(struct im_connection *);
197       
198        /* Request profile info. Free-formatted stuff, the IM module gives back
199           this info via imcb_log(). Implementing these are optional. */
200        void (* get_info)       (struct im_connection *, char *who);
201        /* set_my_name is *DEPRECATED*, not used by the UI anymore. Use the
202           display_name setting instead. */
203        void (* set_my_name)    (struct im_connection *, char *name);
204        void (* set_name)       (struct im_connection *, char *who, char *name);
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 /part IRC command in a group
213         * chat. You just should tell the user about it, nothing more. */
214        void (* chat_leave)     (struct groupchat *);
215        /* This is called when the user sends a message to the groupchat.
216         * 'flags' may be ignored. */
217        void (* chat_msg)       (struct groupchat *, char *message, int flags);
218        /* This is called when the user uses the /join #nick IRC command.
219         * - 'who' is the handle of the nick
220         */
221        struct groupchat *
222             (* chat_with)      (struct im_connection *, char *who);
223        /* This is used when the user uses the /join #channel IRC command.  If
224         * your protocol does not support publicly named group chats, then do
225         * not implement this. */
226        struct groupchat *
227             (* chat_join)      (struct im_connection *, const char *room,
228                                 const char *nick, const char *password, set_t **sets);
229        /* Change the topic, if supported. Note that BitlBee expects the IM
230           server to confirm the topic change with a regular topic change
231           event. If it doesn't do that, you have to fake it to make it
232           visible to the user. */
233        void (* chat_topic)     (struct groupchat *, char *topic);
234       
235        /* If your protocol module needs any special info for joining chatrooms
236           other than a roomname + nickname, add them here. */
237        void (* chat_add_settings)      (account_t *acc, set_t **head);
238        void (* chat_free_settings)     (account_t *acc, set_t **head);
239       
240        /* You can tell what away states your protocol supports, so that
241         * BitlBee will try to map the IRC away reasons to them. If your
242         * protocol doesn't have any, just return one generic "Away". */
243        GList *(* away_states)(struct im_connection *ic);
244       
245        /* Mainly for AOL, since they think "Bung hole" == "Bu ngho le". *sigh*
246         * - Most protocols will just want to set this to g_strcasecmp().*/
247        int (* handle_cmp) (const char *who1, const char *who2);
248
249        /* Implement these callbacks if you want to use imcb_ask_auth() */
250        void (* auth_allow)     (struct im_connection *, const char *who);
251        void (* auth_deny)      (struct im_connection *, const char *who);
252
253        /* Incoming transfer request */
254        void (* transfer_request) (struct im_connection *, file_transfer_t *ft, char *handle );
255       
256        void (* buddy_data_add) (struct bee_user *bu);
257        void (* buddy_data_free) (struct bee_user *bu);
258       
259        /* Some placeholders so eventually older plugins may cooperate with newer BitlBees. */
260        void *resv1;
261        void *resv2;
262        void *resv3;
263        void *resv4;
264        void *resv5;
265};
266
267/* im_api core stuff. */
268void nogaim_init();
269G_MODULE_EXPORT GSList *get_connections();
270G_MODULE_EXPORT struct prpl *find_protocol( const char *name );
271/* When registering a new protocol, you should allocate space for a new prpl
272 * struct, initialize it (set the function pointers to point to your
273 * functions), finally call this function. */
274G_MODULE_EXPORT void register_protocol( struct prpl * );
275
276/* Connection management. */
277/* You will need this function in prpl->login() to get an im_connection from
278 * the account_t parameter. */
279G_MODULE_EXPORT struct im_connection *imcb_new( account_t *acc );
280G_MODULE_EXPORT void imc_free( struct im_connection *ic );
281/* Once you're connected, you should call this function, so that the user will
282 * see the success. */
283G_MODULE_EXPORT void imcb_connected( struct im_connection *ic );
284/* This can be used to disconnect when something went wrong (ie. read error
285 * from the server). You probably want to set the second parameter to TRUE. */
286G_MODULE_EXPORT void imc_logout( struct im_connection *ic, int allow_reconnect );
287
288/* Communicating with the user. */
289/* A printf()-like function to tell the user anything you want. */
290G_MODULE_EXPORT void imcb_log( struct im_connection *ic, char *format, ... ) G_GNUC_PRINTF( 2, 3 );
291/* To tell the user an error, ie. before logging out when an error occurs. */
292G_MODULE_EXPORT void imcb_error( struct im_connection *ic, char *format, ... ) G_GNUC_PRINTF( 2, 3 );
293
294/* To ask a your about something.
295 * - 'msg' is the question.
296 * - 'data' can be your custom struct - it will be passed to the callbacks.
297 * - 'doit' or 'dont' will be called depending of the answer of the user.
298 */
299G_MODULE_EXPORT void imcb_ask( struct im_connection *ic, char *msg, void *data, query_callback doit, query_callback dont );
300G_MODULE_EXPORT void imcb_ask_with_free( struct im_connection *ic, char *msg, void *data, query_callback doit, query_callback dont, query_callback myfree );
301
302/* Two common questions you may want to ask:
303 * - X added you to his contact list, allow?
304 * - X is not in your contact list, want to add?
305 */
306G_MODULE_EXPORT void imcb_ask_auth( struct im_connection *ic, const char *handle, const char *realname );
307G_MODULE_EXPORT void imcb_ask_add( struct im_connection *ic, const char *handle, const char *realname );
308
309/* Buddy management */
310/* This function should be called for each handle which are visible to the
311 * user, usually after a login, or if the user added a buddy and the IM
312 * server confirms that the add was successful. Don't forget to do this! */
313G_MODULE_EXPORT void imcb_add_buddy( struct im_connection *ic, const char *handle, const char *group );
314G_MODULE_EXPORT void imcb_remove_buddy( struct im_connection *ic, const char *handle, char *group );
315G_MODULE_EXPORT struct buddy *imcb_find_buddy( struct im_connection *ic, char *handle );
316G_MODULE_EXPORT void imcb_rename_buddy( struct im_connection *ic, const char *handle, const char *realname );
317G_MODULE_EXPORT void imcb_buddy_nick_hint( struct im_connection *ic, const char *handle, const char *nick );
318
319G_MODULE_EXPORT void imcb_buddy_typing( struct im_connection *ic, const char *handle, uint32_t flags );
320G_MODULE_EXPORT struct bee_user *imcb_buddy_by_handle( struct im_connection *ic, const char *handle );
321G_MODULE_EXPORT void imcb_clean_handle( struct im_connection *ic, char *handle );
322
323/* Actions, or whatever. */
324int imc_away_send_update( struct im_connection *ic );
325int imc_chat_msg( struct groupchat *c, char *msg, int flags );
326
327void imc_add_allow( struct im_connection *ic, char *handle );
328void imc_rem_allow( struct im_connection *ic, char *handle );
329void imc_add_block( struct im_connection *ic, char *handle );
330void imc_rem_block( struct im_connection *ic, char *handle );
331
332/* Misc. stuff */
333char *set_eval_timezone( set_t *set, char *value );
334gboolean auto_reconnect( gpointer data, gint fd, b_input_condition cond );
335void cancel_auto_reconnect( struct account *a );
336
337#endif
Note: See TracBrowser for help on using the repository browser.