source: irc.h @ eb50495

Last change on this file since eb50495 was eb50495, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-05-04T08:45:10Z

Show offline/away status better in /WHO and /WHOIS.

  • Property mode set to 100644
File size: 6.8 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        GHashTable *nick_user_hash;
81        GHashTable *watches;
82
83        gint r_watch_source_id;
84        gint w_watch_source_id;
85        gint ping_source_id;
86       
87        struct bee *b;
88} irc_t;
89
90typedef enum
91{
92        IRC_USER_PRIVATE = 1,
93        IRC_USER_AWAY = 2,
94} irc_user_flags_t;
95
96typedef struct irc_user
97{
98        irc_t *irc;
99       
100        char *nick;
101        char *user;
102        char *host;
103        char *fullname;
104       
105        /* Nickname in lowercase for case sensitive searches */
106        char *key;
107       
108        irc_user_flags_t flags;
109       
110        char *sendbuf;
111        int sendbuf_len;
112        guint sendbuf_timer;
113        //int sendbuf_flags;
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} irc_channel_flags_t;
133
134typedef struct irc_channel
135{
136        irc_t *irc;
137        char *name;
138        char mode[8];
139        int flags;
140       
141        char *topic;
142        char *topic_who;
143        time_t topic_time;
144       
145        GSList *users;
146        struct set *set;
147       
148        const struct irc_channel_funcs *f;
149} irc_channel_t;
150
151struct irc_channel_funcs
152{
153        gboolean (*privmsg)( irc_channel_t *iu, const char *msg );
154};
155
156typedef enum
157{
158        IRC_CHANNEL_USER_OP = 1,
159        IRC_CHANNEL_USER_HALFOP = 2,
160        IRC_CHANNEL_USER_VOICE = 4,
161} irc_channel_user_flags_t;
162
163typedef struct irc_channel_user
164{
165        irc_user_t *iu;
166        int flags;
167} irc_channel_user_t;
168
169extern const struct bee_ui_funcs irc_ui_funcs;
170
171/* irc.c */
172extern GSList *irc_connection_list;
173
174irc_t *irc_new( int fd );
175void irc_abort( irc_t *irc, int immed, char *format, ... ) G_GNUC_PRINTF( 3, 4 );
176void irc_free( irc_t *irc );
177void irc_setpass (irc_t *irc, const char *pass);
178
179void irc_process( irc_t *irc );
180char **irc_parse_line( char *line );
181char *irc_build_line( char **cmd );
182
183void irc_write( irc_t *irc, char *format, ... ) G_GNUC_PRINTF( 2, 3 );
184void irc_write_all( int now, char *format, ... ) G_GNUC_PRINTF( 2, 3 );
185void irc_vawrite( irc_t *irc, char *format, va_list params );
186
187int irc_check_login( irc_t *irc );
188
189void irc_umode_set( irc_t *irc, const char *s, gboolean allow_priv );
190
191/* irc_channel.c */
192irc_channel_t *irc_channel_new( irc_t *irc, const char *name );
193irc_channel_t *irc_channel_by_name( irc_t *irc, const char *name );
194int irc_channel_free( irc_channel_t *ic );
195int irc_channel_add_user( irc_channel_t *ic, irc_user_t *iu );
196int irc_channel_del_user( irc_channel_t *ic, irc_user_t *iu );
197irc_channel_user_t *irc_channel_has_user( irc_channel_t *ic, irc_user_t *iu );
198int irc_channel_set_topic( irc_channel_t *ic, const char *topic, const irc_user_t *who );
199void irc_channel_user_set_mode( irc_channel_t *ic, irc_user_t *iu, irc_channel_user_flags_t flags );
200void irc_channel_printf( irc_channel_t *ic, char *format, ... );
201gboolean irc_channel_name_ok( const char *name );
202
203/* irc_commands.c */
204void irc_exec( irc_t *irc, char **cmd );
205
206/* irc_send.c */
207void irc_send_num( irc_t *irc, int code, char *format, ... ) G_GNUC_PRINTF( 3, 4 );
208void irc_send_login( irc_t *irc );
209void irc_send_motd( irc_t *irc );
210void irc_usermsg( irc_t *irc, char *format, ... );
211void irc_send_join( irc_channel_t *ic, irc_user_t *iu );
212void irc_send_part( irc_channel_t *ic, irc_user_t *iu, const char *reason );
213void irc_send_names( irc_channel_t *ic );
214void irc_send_topic( irc_channel_t *ic, gboolean topic_change );
215void irc_send_whois( irc_user_t *iu );
216void irc_send_who( irc_t *irc, GSList *l, const char *channel );
217void irc_send_msg( irc_user_t *iu, const char *type, const char *dst, const char *msg, const char *prefix );
218void irc_send_msg_raw( irc_user_t *iu, const char *type, const char *dst, const char *msg );
219void irc_send_msg_f( irc_user_t *iu, const char *type, const char *dst, const char *format, ... ) G_GNUC_PRINTF( 4, 5 );
220void irc_send_nick( irc_user_t *iu, const char *new );
221void irc_send_channel_user_mode_diff( irc_channel_t *ic, irc_user_t *iu,
222                                      irc_channel_user_flags_t old, irc_channel_user_flags_t new );
223
224/* irc_user.c */
225irc_user_t *irc_user_new( irc_t *irc, const char *nick );
226int irc_user_free( irc_t *irc, irc_user_t *iu );
227irc_user_t *irc_user_by_name( irc_t *irc, const char *nick );
228int irc_user_set_nick( irc_user_t *iu, const char *new );
229gint irc_user_cmp( gconstpointer a_, gconstpointer b_ );
230const char *irc_user_get_away( irc_user_t *iu );
231
232/* irc_util.c */
233char *set_eval_timezone( struct set *set, char *value );
234char *irc_format_timestamp( irc_t *irc, time_t msg_ts );
235
236#endif
Note: See TracBrowser for help on using the repository browser.