source: irc.h @ 593971d

Last change on this file since 593971d was 94d5da9c, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-07-18T22:12:19Z

One of the last few things I wanted to get done in this branch: combining
show_offline and away_devoice and possibly other ideas into one setting
called show_users. Documentation will come soon. :-P
  • Property mode set to 100644
File size: 9.3 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; /* Either the nickname from which the last root
69                                msg came, or the last channel root was talked
70                                to. */
71
72        char *password; /* HACK: Used to save the user's password, but before
73                           logging in, this may contain a password we should
74                           send to identify after USER/NICK are received. */
75
76        char umode[8];
77       
78        struct query *queries;
79        GSList *file_transfers;
80       
81        GSList *users, *channels;
82        struct irc_channel *default_channel;
83        GHashTable *nick_user_hash;
84        GHashTable *watches; /* See irc_cmd_watch() */
85
86        gint r_watch_source_id;
87        gint w_watch_source_id;
88        gint ping_source_id;
89        gint login_source_id; /* To slightly delay some events at login time. */
90       
91        struct bee *b;
92} irc_t;
93
94typedef enum
95{
96        /* Replaced with iu->last_channel IRC_USER_PRIVATE = 1, */
97        IRC_USER_AWAY = 2,
98} irc_user_flags_t;
99
100typedef struct irc_user
101{
102        irc_t *irc;
103       
104        char *nick;
105        char *user;
106        char *host;
107        char *fullname;
108       
109        /* Nickname in lowercase for case sensitive searches */
110        char *key;
111       
112        irc_user_flags_t flags;
113        struct irc_channel *last_channel;
114       
115        GString *pastebuf; /* Paste buffer (combine lines into a multiline msg). */
116        guint pastebuf_timer;
117        time_t away_reply_timeout; /* Only send a 301 if this time passed. */
118       
119        struct bee_user *bu;
120       
121        const struct irc_user_funcs *f;
122} irc_user_t;
123
124struct irc_user_funcs
125{
126        gboolean (*privmsg)( irc_user_t *iu, const char *msg );
127        gboolean (*ctcp)( irc_user_t *iu, char * const* ctcp );
128};
129
130extern const struct irc_user_funcs irc_user_root_funcs;
131extern const struct irc_user_funcs irc_user_self_funcs;
132
133typedef enum
134{
135        IRC_CHANNEL_JOINED = 1, /* The user is currently in the channel. */
136        IRC_CHANNEL_TEMP = 2,   /* Erase the channel when the user leaves,
137                                   and don't save it. */
138       
139        /* Hack: Set this flag right before jumping into IM when we expect
140           a call to imcb_chat_new(). */
141        IRC_CHANNEL_CHAT_PICKME = 0x10000,
142} irc_channel_flags_t;
143
144typedef struct irc_channel
145{
146        irc_t *irc;
147        char *name;
148        char mode[8];
149        int flags;
150       
151        char *topic;
152        char *topic_who;
153        time_t topic_time;
154       
155        GSList *users; /* struct irc_channel_user */
156        struct set *set;
157       
158        GString *pastebuf; /* Paste buffer (combine lines into a multiline msg). */
159        guint pastebuf_timer;
160       
161        const struct irc_channel_funcs *f;
162        void *data;
163} irc_channel_t;
164
165struct irc_channel_funcs
166{
167        gboolean (*privmsg)( irc_channel_t *ic, const char *msg );
168        gboolean (*join)( irc_channel_t *ic );
169        gboolean (*part)( irc_channel_t *ic, const char *msg );
170        gboolean (*topic)( irc_channel_t *ic, const char *new );
171        gboolean (*invite)( irc_channel_t *ic, irc_user_t *iu );
172       
173        gboolean (*_init)( irc_channel_t *ic );
174        gboolean (*_free)( irc_channel_t *ic );
175};
176
177typedef enum
178{
179        IRC_CHANNEL_USER_OP = 1,
180        IRC_CHANNEL_USER_HALFOP = 2,
181        IRC_CHANNEL_USER_VOICE = 4,
182        IRC_CHANNEL_USER_NONE = 8,
183} irc_channel_user_flags_t;
184
185typedef struct irc_channel_user
186{
187        irc_user_t *iu;
188        int flags;
189} irc_channel_user_t;
190
191typedef enum
192{
193        IRC_CC_TYPE_DEFAULT,
194        IRC_CC_TYPE_REST,
195        IRC_CC_TYPE_GROUP,
196        IRC_CC_TYPE_ACCOUNT,
197        IRC_CC_TYPE_PROTOCOL,
198} irc_control_channel_type_t;
199
200struct irc_control_channel
201{
202        irc_control_channel_type_t type;
203        struct bee_group *group;
204        struct account *account;
205        struct prpl *protocol;
206        char modes[4];
207};
208
209extern const struct bee_ui_funcs irc_ui_funcs;
210
211typedef enum
212{
213        IRC_CDU_SILENT,
214        IRC_CDU_PART,
215        IRC_CDU_KICK,
216} irc_channel_del_user_type_t;
217
218/* irc.c */
219extern GSList *irc_connection_list;
220
221irc_t *irc_new( int fd );
222void irc_abort( irc_t *irc, int immed, char *format, ... ) G_GNUC_PRINTF( 3, 4 );
223void irc_free( irc_t *irc );
224void irc_setpass (irc_t *irc, const char *pass);
225
226void irc_process( irc_t *irc );
227char **irc_parse_line( char *line );
228char *irc_build_line( char **cmd );
229
230void irc_write( irc_t *irc, char *format, ... ) G_GNUC_PRINTF( 2, 3 );
231void irc_write_all( int now, char *format, ... ) G_GNUC_PRINTF( 2, 3 );
232void irc_vawrite( irc_t *irc, char *format, va_list params );
233
234void irc_flush( irc_t *irc );
235void irc_switch_fd( irc_t *irc, int fd );
236void irc_sync( irc_t *irc );
237void irc_desync( irc_t *irc );
238
239int irc_check_login( irc_t *irc );
240
241void irc_umode_set( irc_t *irc, const char *s, gboolean allow_priv );
242
243/* irc_channel.c */
244irc_channel_t *irc_channel_new( irc_t *irc, const char *name );
245irc_channel_t *irc_channel_by_name( irc_t *irc, const char *name );
246irc_channel_t *irc_channel_get( irc_t *irc, char *id );
247int irc_channel_free( irc_channel_t *ic );
248void irc_channel_free_soon( irc_channel_t *ic );
249int irc_channel_add_user( irc_channel_t *ic, irc_user_t *iu );
250int irc_channel_del_user( irc_channel_t *ic, irc_user_t *iu, irc_channel_del_user_type_t type, const char *msg );
251irc_channel_user_t *irc_channel_has_user( irc_channel_t *ic, irc_user_t *iu );
252int irc_channel_set_topic( irc_channel_t *ic, const char *topic, const irc_user_t *who );
253void irc_channel_user_set_mode( irc_channel_t *ic, irc_user_t *iu, irc_channel_user_flags_t flags );
254void irc_channel_auto_joins( irc_t *irc, struct account *acc );
255void irc_channel_printf( irc_channel_t *ic, char *format, ... );
256gboolean irc_channel_name_ok( const char *name );
257void irc_channel_name_strip( char *name );
258int irc_channel_name_cmp( const char *a_, const char *b_ );
259void irc_channel_update_ops( irc_channel_t *ic, char *value );
260char *set_eval_irc_channel_ops( struct set *set, char *value );
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 );
284
285/* irc_user.c */
286irc_user_t *irc_user_new( irc_t *irc, const char *nick );
287int irc_user_free( irc_t *irc, irc_user_t *iu );
288irc_user_t *irc_user_by_name( irc_t *irc, const char *nick );
289int irc_user_set_nick( irc_user_t *iu, const char *new );
290gint irc_user_cmp( gconstpointer a_, gconstpointer b_ );
291const char *irc_user_get_away( irc_user_t *iu );
292void irc_user_quit( irc_user_t *iu, const char *msg );
293
294/* irc_util.c */
295char *set_eval_timezone( struct set *set, char *value );
296char *irc_format_timestamp( irc_t *irc, time_t msg_ts );
297
298/* irc_im.c */
299void bee_irc_channel_update( irc_t *irc, irc_channel_t *ic, irc_user_t *iu );
300
301#endif
Note: See TracBrowser for help on using the repository browser.