source: irc.h @ f5c0d8e

Last change on this file since f5c0d8e was f5c0d8e, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-08-31T20:06:14Z

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