source: irc.h @ 3f10fad

Last change on this file since 3f10fad was 1aa74f55, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-08-23T10:34:36Z

Process incoming XMPP groupchat invites in a saner way: Create a temporary
channel the user can easily /join.
  • Property mode set to 100644
File size: 9.5 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/* The IRC-based UI (for now the only one)                              */
8
9/*
10  This program is free software; you can redistribute it and/or modify
11  it under the terms of the GNU General Public License as published by
12  the Free Software Foundation; either version 2 of the License, or
13  (at your option) any later version.
14
15  This program is distributed in the hope that it will be useful,
16  but WITHOUT ANY WARRANTY; without even the implied warranty of
17  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  GNU General Public License for more details.
19
20  You should have received a copy of the GNU General Public License with
21  the Debian GNU/Linux distribution in /usr/share/common-licenses/GPL;
22  if not, write to the Free Software Foundation, Inc., 59 Temple Place,
23  Suite 330, Boston, MA  02111-1307  USA
24*/
25
26#ifndef _IRC_H
27#define _IRC_H
28
29#define IRC_MAX_LINE 512
30#define IRC_MAX_ARGS 8
31
32#define IRC_LOGIN_TIMEOUT 60
33#define IRC_PING_STRING "PinglBee"
34
35#define UMODES "abisw"     /* Allowed umodes (although they mostly do nothing) */
36#define UMODES_PRIV "Ro"   /* Allowed, but not by user directly */
37#define UMODES_KEEP "R"    /* Don't allow unsetting using /MODE */
38#define CMODES "ntC"       /* Allowed modes */
39#define CMODE "t"          /* Default mode */
40#define UMODE "s"          /* Default mode */
41
42#define CTYPES "&#"        /* Valid channel name prefixes */
43
44typedef enum
45{
46        USTATUS_OFFLINE = 0,
47        USTATUS_AUTHORIZED = 1, /* Gave the correct server password (PASS). */
48        USTATUS_LOGGED_IN = 2,  /* USER+NICK(+PASS) finished. */
49        USTATUS_IDENTIFIED = 4, /* To NickServ (root). */
50        USTATUS_SHUTDOWN = 8,   /* Now used to indicate we're shutting down.
51                                   Currently just blocks irc_vawrite(). */
52} irc_status_t;
53
54struct irc_user;
55
56typedef struct irc
57{
58        int fd;
59        irc_status_t status;
60        double last_pong;
61        int pinging;
62        char *sendbuffer;
63        char *readbuffer;
64        GIConv iconv, oconv;
65
66        struct irc_user *root;
67        struct irc_user *user;
68       
69        char *password; /* HACK: Used to save the user's password, but before
70                           logging in, this may contain a password we should
71                           send to identify after USER/NICK are received. */
72
73        char umode[8];
74       
75        struct query *queries;
76        GSList *file_transfers;
77       
78        GSList *users, *channels;
79        struct irc_channel *default_channel;
80        GHashTable *nick_user_hash;
81        GHashTable *watches; /* See irc_cmd_watch() */
82
83        gint r_watch_source_id;
84        gint w_watch_source_id;
85        gint ping_source_id;
86        gint login_source_id; /* To slightly delay some events at login time. */
87       
88        struct bee *b;
89} irc_t;
90
91typedef enum
92{
93        /* Replaced with iu->last_channel IRC_USER_PRIVATE = 1, */
94        IRC_USER_AWAY = 2,
95} irc_user_flags_t;
96
97typedef struct irc_user
98{
99        irc_t *irc;
100       
101        char *nick;
102        char *user;
103        char *host;
104        char *fullname;
105       
106        /* Nickname in lowercase for case insensitive searches */
107        char *key;
108       
109        irc_user_flags_t flags;
110        struct irc_channel *last_channel;
111       
112        GString *pastebuf; /* Paste buffer (combine lines into a multiline msg). */
113        guint pastebuf_timer;
114        time_t away_reply_timeout; /* Only send a 301 if this time passed. */
115       
116        struct bee_user *bu;
117       
118        const struct irc_user_funcs *f;
119} irc_user_t;
120
121struct irc_user_funcs
122{
123        gboolean (*privmsg)( irc_user_t *iu, const char *msg );
124        gboolean (*ctcp)( irc_user_t *iu, char * const* ctcp );
125};
126
127extern const struct irc_user_funcs irc_user_root_funcs;
128extern const struct irc_user_funcs irc_user_self_funcs;
129
130typedef enum
131{
132        IRC_CHANNEL_JOINED = 1, /* The user is currently in the channel. */
133        IRC_CHANNEL_TEMP = 2,   /* Erase the channel when the user leaves,
134                                   and don't save it. */
135       
136        /* Hack: Set this flag right before jumping into IM when we expect
137           a call to imcb_chat_new(). */
138        IRC_CHANNEL_CHAT_PICKME = 0x10000,
139} irc_channel_flags_t;
140
141typedef struct irc_channel
142{
143        irc_t *irc;
144        char *name;
145        char mode[8];
146        int flags;
147       
148        char *topic;
149        char *topic_who;
150        time_t topic_time;
151       
152        GSList *users; /* struct irc_channel_user */
153        struct irc_user *last_target;
154        struct set *set;
155       
156        GString *pastebuf; /* Paste buffer (combine lines into a multiline msg). */
157        guint pastebuf_timer;
158       
159        const struct irc_channel_funcs *f;
160        void *data;
161} irc_channel_t;
162
163struct irc_channel_funcs
164{
165        gboolean (*privmsg)( irc_channel_t *ic, const char *msg );
166        gboolean (*join)( irc_channel_t *ic );
167        gboolean (*part)( irc_channel_t *ic, const char *msg );
168        gboolean (*topic)( irc_channel_t *ic, const char *new );
169        gboolean (*invite)( irc_channel_t *ic, irc_user_t *iu );
170       
171        gboolean (*_init)( irc_channel_t *ic );
172        gboolean (*_free)( irc_channel_t *ic );
173};
174
175typedef enum
176{
177        IRC_CHANNEL_USER_OP = 1,
178        IRC_CHANNEL_USER_HALFOP = 2,
179        IRC_CHANNEL_USER_VOICE = 4,
180        IRC_CHANNEL_USER_NONE = 8,
181} irc_channel_user_flags_t;
182
183typedef struct irc_channel_user
184{
185        irc_user_t *iu;
186        int flags;
187} irc_channel_user_t;
188
189typedef enum
190{
191        IRC_CC_TYPE_DEFAULT,
192        IRC_CC_TYPE_REST,
193        IRC_CC_TYPE_GROUP,
194        IRC_CC_TYPE_ACCOUNT,
195        IRC_CC_TYPE_PROTOCOL,
196} irc_control_channel_type_t;
197
198struct irc_control_channel
199{
200        irc_control_channel_type_t type;
201        struct bee_group *group;
202        struct account *account;
203        struct prpl *protocol;
204        char modes[4];
205};
206
207extern const struct bee_ui_funcs irc_ui_funcs;
208
209typedef enum
210{
211        IRC_CDU_SILENT,
212        IRC_CDU_PART,
213        IRC_CDU_KICK,
214} irc_channel_del_user_type_t;
215
216/* irc.c */
217extern GSList *irc_connection_list;
218
219irc_t *irc_new( int fd );
220void irc_abort( irc_t *irc, int immed, char *format, ... ) G_GNUC_PRINTF( 3, 4 );
221void irc_free( irc_t *irc );
222void irc_setpass (irc_t *irc, const char *pass);
223
224void irc_process( irc_t *irc );
225char **irc_parse_line( char *line );
226char *irc_build_line( char **cmd );
227
228void irc_write( irc_t *irc, char *format, ... ) G_GNUC_PRINTF( 2, 3 );
229void irc_write_all( int now, char *format, ... ) G_GNUC_PRINTF( 2, 3 );
230void irc_vawrite( irc_t *irc, char *format, va_list params );
231
232void irc_flush( irc_t *irc );
233void irc_switch_fd( irc_t *irc, int fd );
234void irc_sync( irc_t *irc );
235void irc_desync( irc_t *irc );
236
237int irc_check_login( irc_t *irc );
238
239void irc_umode_set( irc_t *irc, const char *s, gboolean allow_priv );
240
241/* irc_channel.c */
242irc_channel_t *irc_channel_new( irc_t *irc, const char *name );
243irc_channel_t *irc_channel_by_name( irc_t *irc, const char *name );
244irc_channel_t *irc_channel_get( irc_t *irc, char *id );
245int irc_channel_free( irc_channel_t *ic );
246void irc_channel_free_soon( irc_channel_t *ic );
247int irc_channel_add_user( irc_channel_t *ic, irc_user_t *iu );
248int irc_channel_del_user( irc_channel_t *ic, irc_user_t *iu, irc_channel_del_user_type_t type, const char *msg );
249irc_channel_user_t *irc_channel_has_user( irc_channel_t *ic, irc_user_t *iu );
250int irc_channel_set_topic( irc_channel_t *ic, const char *topic, const irc_user_t *who );
251void irc_channel_user_set_mode( irc_channel_t *ic, irc_user_t *iu, irc_channel_user_flags_t flags );
252void irc_channel_set_mode( irc_channel_t *ic, const char *s );
253void irc_channel_auto_joins( irc_t *irc, struct account *acc );
254void irc_channel_printf( irc_channel_t *ic, char *format, ... );
255gboolean irc_channel_name_ok( const char *name );
256void irc_channel_name_strip( char *name );
257int irc_channel_name_cmp( const char *a_, const char *b_ );
258void irc_channel_update_ops( irc_channel_t *ic, char *value );
259char *set_eval_irc_channel_ops( struct set *set, char *value );
260gboolean irc_channel_wants_user( irc_channel_t *ic, irc_user_t *iu );
261
262/* irc_commands.c */
263void irc_exec( irc_t *irc, char **cmd );
264
265/* irc_send.c */
266void irc_send_num( irc_t *irc, int code, char *format, ... ) G_GNUC_PRINTF( 3, 4 );
267void irc_send_login( irc_t *irc );
268void irc_send_motd( irc_t *irc );
269void irc_usermsg( irc_t *irc, char *format, ... );
270void irc_send_join( irc_channel_t *ic, irc_user_t *iu );
271void irc_send_part( irc_channel_t *ic, irc_user_t *iu, const char *reason );
272void irc_send_quit( irc_user_t *iu, const char *reason );
273void irc_send_kick( irc_channel_t *ic, irc_user_t *iu, irc_user_t *kicker, const char *reason );
274void irc_send_names( irc_channel_t *ic );
275void irc_send_topic( irc_channel_t *ic, gboolean topic_change );
276void irc_send_whois( irc_user_t *iu );
277void irc_send_who( irc_t *irc, GSList *l, const char *channel );
278void irc_send_msg( irc_user_t *iu, const char *type, const char *dst, const char *msg, const char *prefix );
279void irc_send_msg_raw( irc_user_t *iu, const char *type, const char *dst, const char *msg );
280void irc_send_msg_f( irc_user_t *iu, const char *type, const char *dst, const char *format, ... ) G_GNUC_PRINTF( 4, 5 );
281void irc_send_nick( irc_user_t *iu, const char *new );
282void irc_send_channel_user_mode_diff( irc_channel_t *ic, irc_user_t *iu,
283                                      irc_channel_user_flags_t old, irc_channel_user_flags_t new );
284void irc_send_invite( irc_user_t *iu, irc_channel_t *ic );
285
286/* irc_user.c */
287irc_user_t *irc_user_new( irc_t *irc, const char *nick );
288int irc_user_free( irc_t *irc, irc_user_t *iu );
289irc_user_t *irc_user_by_name( irc_t *irc, const char *nick );
290int irc_user_set_nick( irc_user_t *iu, const char *new );
291gint irc_user_cmp( gconstpointer a_, gconstpointer b_ );
292const char *irc_user_get_away( irc_user_t *iu );
293void irc_user_quit( irc_user_t *iu, const char *msg );
294
295/* irc_util.c */
296char *set_eval_timezone( struct set *set, char *value );
297char *irc_format_timestamp( irc_t *irc, time_t msg_ts );
298
299/* irc_im.c */
300void bee_irc_channel_update( irc_t *irc, irc_channel_t *ic, irc_user_t *iu );
301
302#endif
Note: See TracBrowser for help on using the repository browser.