source: irc.h @ 12b29db

Last change on this file since 12b29db was 1c8e5f7, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-06-11T15:12:27Z

Added away_reply_timeout setting so BitlBee will suppress away messages sent
in response to PRIVMSG if one was sent recently - some IRC clients including
irssi don't do this very well (when talking to >1 people who are away for
example).

  • Property mode set to 100644
File size: 8.1 KB
Line 
1  /********************************************************************\
2  * BitlBee -- An IRC to other IM-networks gateway                     *
3  *                                                                    *
4  * Copyright 2002-2004 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 "nt"        /* 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,
48        USTATUS_LOGGED_IN = 2,
49        USTATUS_IDENTIFIED = 4,
50        USTATUS_SHUTDOWN = 8
51} irc_status_t;
52
53struct irc_user;
54
55typedef struct irc
56{
57        int fd;
58        irc_status_t status;
59        double last_pong;
60        int pinging;
61        char *sendbuffer;
62        char *readbuffer;
63        GIConv iconv, oconv;
64
65        struct irc_user *root;
66        struct irc_user *user;
67       
68        char *last_root_cmd;
69
70        char *password; /* HACK: Used to save the user's password, but before
71                           logging in, this may contain a password we should
72                           send to identify after USER/NICK are received. */
73
74        char umode[8];
75       
76        struct query *queries;
77        GSList *file_transfers;
78       
79        GSList *users, *channels;
80        struct irc_channel *default_channel;
81        GHashTable *nick_user_hash;
82        GHashTable *watches;
83
84        gint r_watch_source_id;
85        gint w_watch_source_id;
86        gint ping_source_id;
87       
88        struct bee *b;
89} irc_t;
90
91typedef enum
92{
93        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 sensitive searches */
107        char *key;
108       
109        irc_user_flags_t flags;
110       
111        GString *pastebuf; /* Paste buffer (combine lines into a multiline msg). */
112        guint pastebuf_timer;
113        time_t away_reply_timeout; /* Only send a 301 if this time passed. */
114       
115        struct bee_user *bu;
116       
117        const struct irc_user_funcs *f;
118} irc_user_t;
119
120struct irc_user_funcs
121{
122        gboolean (*privmsg)( irc_user_t *iu, const char *msg );
123        gboolean (*ctcp)( irc_user_t *iu, char * const* ctcp );
124};
125
126extern const struct irc_user_funcs irc_user_root_funcs;
127extern const struct irc_user_funcs irc_user_self_funcs;
128
129typedef enum
130{
131        IRC_CHANNEL_JOINED = 1,
132       
133        /* Hack: Set this flag right before jumping into IM when we expect
134           a call to imcb_chat_new(). */
135        IRC_CHANNEL_CHAT_PICKME = 0x10000,
136} irc_channel_flags_t;
137
138typedef struct irc_channel
139{
140        irc_t *irc;
141        char *name;
142        char mode[8];
143        int flags;
144       
145        char *topic;
146        char *topic_who;
147        time_t topic_time;
148       
149        GSList *users; /* struct irc_channel_user */
150        struct set *set;
151       
152        GString *pastebuf; /* Paste buffer (combine lines into a multiline msg). */
153        guint pastebuf_timer;
154       
155        const struct irc_channel_funcs *f;
156        void *data;
157} irc_channel_t;
158
159struct irc_channel_funcs
160{
161        gboolean (*privmsg)( irc_channel_t *ic, const char *msg );
162        gboolean (*join)( irc_channel_t *ic );
163        gboolean (*part)( irc_channel_t *ic, const char *msg );
164        gboolean (*topic)( irc_channel_t *ic, const char *new );
165        gboolean (*invite)( irc_channel_t *ic, irc_user_t *iu );
166       
167        gboolean (*_init)( irc_channel_t *ic );
168        gboolean (*_free)( irc_channel_t *ic );
169};
170
171typedef enum
172{
173        IRC_CHANNEL_USER_OP = 1,
174        IRC_CHANNEL_USER_HALFOP = 2,
175        IRC_CHANNEL_USER_VOICE = 4,
176} irc_channel_user_flags_t;
177
178typedef struct irc_channel_user
179{
180        irc_user_t *iu;
181        int flags;
182} irc_channel_user_t;
183
184typedef enum
185{
186        IRC_CC_TYPE_DEFAULT,
187        IRC_CC_TYPE_REST,
188        IRC_CC_TYPE_GROUP,
189        IRC_CC_TYPE_ACCOUNT,
190} irc_control_channel_type_t;
191
192struct irc_control_channel
193{
194        irc_control_channel_type_t type;
195        struct bee_group *group;
196        struct account *account;
197};
198
199extern const struct bee_ui_funcs irc_ui_funcs;
200
201/* irc.c */
202extern GSList *irc_connection_list;
203
204irc_t *irc_new( int fd );
205void irc_abort( irc_t *irc, int immed, char *format, ... ) G_GNUC_PRINTF( 3, 4 );
206void irc_free( irc_t *irc );
207void irc_setpass (irc_t *irc, const char *pass);
208
209void irc_process( irc_t *irc );
210char **irc_parse_line( char *line );
211char *irc_build_line( char **cmd );
212
213void irc_write( irc_t *irc, char *format, ... ) G_GNUC_PRINTF( 2, 3 );
214void irc_write_all( int now, char *format, ... ) G_GNUC_PRINTF( 2, 3 );
215void irc_vawrite( irc_t *irc, char *format, va_list params );
216
217int irc_check_login( irc_t *irc );
218
219void irc_umode_set( irc_t *irc, const char *s, gboolean allow_priv );
220
221/* irc_channel.c */
222irc_channel_t *irc_channel_new( irc_t *irc, const char *name );
223irc_channel_t *irc_channel_by_name( irc_t *irc, const char *name );
224irc_channel_t *irc_channel_get( irc_t *irc, char *id );
225int irc_channel_free( irc_channel_t *ic );
226int irc_channel_add_user( irc_channel_t *ic, irc_user_t *iu );
227int irc_channel_del_user( irc_channel_t *ic, irc_user_t *iu, gboolean silent, const char *msg );
228irc_channel_user_t *irc_channel_has_user( irc_channel_t *ic, irc_user_t *iu );
229int irc_channel_set_topic( irc_channel_t *ic, const char *topic, const irc_user_t *who );
230void irc_channel_user_set_mode( irc_channel_t *ic, irc_user_t *iu, irc_channel_user_flags_t flags );
231void irc_channel_printf( irc_channel_t *ic, char *format, ... );
232gboolean irc_channel_name_ok( const char *name );
233void irc_channel_update_ops( irc_channel_t *ic, char *value );
234char *set_eval_irc_channel_ops( struct set *set, char *value );
235
236/* irc_commands.c */
237void irc_exec( irc_t *irc, char **cmd );
238
239/* irc_send.c */
240void irc_send_num( irc_t *irc, int code, char *format, ... ) G_GNUC_PRINTF( 3, 4 );
241void irc_send_login( irc_t *irc );
242void irc_send_motd( irc_t *irc );
243void irc_usermsg( irc_t *irc, char *format, ... );
244void irc_send_join( irc_channel_t *ic, irc_user_t *iu );
245void irc_send_part( irc_channel_t *ic, irc_user_t *iu, const char *reason );
246void irc_send_quit( irc_user_t *iu, const char *reason );
247void irc_send_names( irc_channel_t *ic );
248void irc_send_topic( irc_channel_t *ic, gboolean topic_change );
249void irc_send_whois( irc_user_t *iu );
250void irc_send_who( irc_t *irc, GSList *l, const char *channel );
251void irc_send_msg( irc_user_t *iu, const char *type, const char *dst, const char *msg, const char *prefix );
252void irc_send_msg_raw( irc_user_t *iu, const char *type, const char *dst, const char *msg );
253void irc_send_msg_f( irc_user_t *iu, const char *type, const char *dst, const char *format, ... ) G_GNUC_PRINTF( 4, 5 );
254void irc_send_nick( irc_user_t *iu, const char *new );
255void irc_send_channel_user_mode_diff( irc_channel_t *ic, irc_user_t *iu,
256                                      irc_channel_user_flags_t old, irc_channel_user_flags_t new );
257
258/* irc_user.c */
259irc_user_t *irc_user_new( irc_t *irc, const char *nick );
260int irc_user_free( irc_t *irc, irc_user_t *iu );
261irc_user_t *irc_user_by_name( irc_t *irc, const char *nick );
262int irc_user_set_nick( irc_user_t *iu, const char *new );
263gint irc_user_cmp( gconstpointer a_, gconstpointer b_ );
264const char *irc_user_get_away( irc_user_t *iu );
265
266/* irc_util.c */
267char *set_eval_timezone( struct set *set, char *value );
268char *irc_format_timestamp( irc_t *irc, time_t msg_ts );
269
270/* irc_im.c */
271void bee_irc_channel_update( irc_t *irc, irc_channel_t *ic, irc_user_t *iu );
272
273#endif
Note: See TracBrowser for help on using the repository browser.