source: irc.h @ 4255320

Last change on this file since 4255320 was f6f5eee, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-07-27T22:04:19Z

Source documentation update, including a short HACKING file.
  • 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-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, /* 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 *last_root_cmd; /* Either the nickname from which the last root
70                                msg came, or the last channel root was talked
71                                to. */
72
73        char *password; /* HACK: Used to save the user's password, but before
74                           logging in, this may contain a password we should
75                           send to identify after USER/NICK are received. */
76
77        char umode[8];
78       
79        struct query *queries;
80        GSList *file_transfers;
81       
82        GSList *users, *channels;
83        struct irc_channel *default_channel;
84        GHashTable *nick_user_hash;
85        GHashTable *watches; /* See irc_cmd_watch() */
86
87        gint r_watch_source_id;
88        gint w_watch_source_id;
89        gint ping_source_id;
90        gint login_source_id; /* To slightly delay some events at login time. */
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} irc_user_flags_t;
100
101typedef struct irc_user
102{
103        irc_t *irc;
104       
105        char *nick;
106        char *user;
107        char *host;
108        char *fullname;
109       
110        /* Nickname in lowercase for case sensitive searches */
111        char *key;
112       
113        irc_user_flags_t flags;
114        struct irc_channel *last_channel;
115       
116        GString *pastebuf; /* Paste buffer (combine lines into a multiline msg). */
117        guint pastebuf_timer;
118        time_t away_reply_timeout; /* Only send a 301 if this time passed. */
119       
120        struct bee_user *bu;
121       
122        const struct irc_user_funcs *f;
123} irc_user_t;
124
125struct irc_user_funcs
126{
127        gboolean (*privmsg)( irc_user_t *iu, const char *msg );
128        gboolean (*ctcp)( irc_user_t *iu, char * const* ctcp );
129};
130
131extern const struct irc_user_funcs irc_user_root_funcs;
132extern const struct irc_user_funcs irc_user_self_funcs;
133
134typedef enum
135{
136        IRC_CHANNEL_JOINED = 1, /* The user is currently in the channel. */
137        IRC_CHANNEL_TEMP = 2,   /* Erase the channel when the user leaves,
138                                   and don't save it. */
139       
140        /* Hack: Set this flag right before jumping into IM when we expect
141           a call to imcb_chat_new(). */
142        IRC_CHANNEL_CHAT_PICKME = 0x10000,
143} irc_channel_flags_t;
144
145typedef struct irc_channel
146{
147        irc_t *irc;
148        char *name;
149        char mode[8];
150        int flags;
151       
152        char *topic;
153        char *topic_who;
154        time_t topic_time;
155       
156        GSList *users; /* struct irc_channel_user */
157        struct set *set;
158       
159        GString *pastebuf; /* Paste buffer (combine lines into a multiline msg). */
160        guint pastebuf_timer;
161       
162        const struct irc_channel_funcs *f;
163        void *data;
164} irc_channel_t;
165
166struct irc_channel_funcs
167{
168        gboolean (*privmsg)( irc_channel_t *ic, const char *msg );
169        gboolean (*join)( irc_channel_t *ic );
170        gboolean (*part)( irc_channel_t *ic, const char *msg );
171        gboolean (*topic)( irc_channel_t *ic, const char *new );
172        gboolean (*invite)( irc_channel_t *ic, irc_user_t *iu );
173       
174        gboolean (*_init)( irc_channel_t *ic );
175        gboolean (*_free)( irc_channel_t *ic );
176};
177
178typedef enum
179{
180        IRC_CHANNEL_USER_OP = 1,
181        IRC_CHANNEL_USER_HALFOP = 2,
182        IRC_CHANNEL_USER_VOICE = 4,
183        IRC_CHANNEL_USER_NONE = 8,
184} irc_channel_user_flags_t;
185
186typedef struct irc_channel_user
187{
188        irc_user_t *iu;
189        int flags;
190} irc_channel_user_t;
191
192typedef enum
193{
194        IRC_CC_TYPE_DEFAULT,
195        IRC_CC_TYPE_REST,
196        IRC_CC_TYPE_GROUP,
197        IRC_CC_TYPE_ACCOUNT,
198        IRC_CC_TYPE_PROTOCOL,
199} irc_control_channel_type_t;
200
201struct irc_control_channel
202{
203        irc_control_channel_type_t type;
204        struct bee_group *group;
205        struct account *account;
206        struct prpl *protocol;
207        char modes[4];
208};
209
210extern const struct bee_ui_funcs irc_ui_funcs;
211
212typedef enum
213{
214        IRC_CDU_SILENT,
215        IRC_CDU_PART,
216        IRC_CDU_KICK,
217} irc_channel_del_user_type_t;
218
219/* irc.c */
220extern GSList *irc_connection_list;
221
222irc_t *irc_new( int fd );
223void irc_abort( irc_t *irc, int immed, char *format, ... ) G_GNUC_PRINTF( 3, 4 );
224void irc_free( irc_t *irc );
225void irc_setpass (irc_t *irc, const char *pass);
226
227void irc_process( irc_t *irc );
228char **irc_parse_line( char *line );
229char *irc_build_line( char **cmd );
230
231void irc_write( irc_t *irc, char *format, ... ) G_GNUC_PRINTF( 2, 3 );
232void irc_write_all( int now, char *format, ... ) G_GNUC_PRINTF( 2, 3 );
233void irc_vawrite( irc_t *irc, char *format, va_list params );
234
235void irc_flush( irc_t *irc );
236void irc_switch_fd( irc_t *irc, int fd );
237void irc_sync( irc_t *irc );
238void irc_desync( irc_t *irc );
239
240int irc_check_login( irc_t *irc );
241
242void irc_umode_set( irc_t *irc, const char *s, gboolean allow_priv );
243
244/* irc_channel.c */
245irc_channel_t *irc_channel_new( irc_t *irc, const char *name );
246irc_channel_t *irc_channel_by_name( irc_t *irc, const char *name );
247irc_channel_t *irc_channel_get( irc_t *irc, char *id );
248int irc_channel_free( irc_channel_t *ic );
249void irc_channel_free_soon( irc_channel_t *ic );
250int irc_channel_add_user( irc_channel_t *ic, irc_user_t *iu );
251int irc_channel_del_user( irc_channel_t *ic, irc_user_t *iu, irc_channel_del_user_type_t type, const char *msg );
252irc_channel_user_t *irc_channel_has_user( irc_channel_t *ic, irc_user_t *iu );
253int irc_channel_set_topic( irc_channel_t *ic, const char *topic, const irc_user_t *who );
254void irc_channel_user_set_mode( irc_channel_t *ic, irc_user_t *iu, irc_channel_user_flags_t flags );
255void irc_channel_auto_joins( irc_t *irc, struct account *acc );
256void irc_channel_printf( irc_channel_t *ic, char *format, ... );
257gboolean irc_channel_name_ok( const char *name );
258void irc_channel_name_strip( char *name );
259int irc_channel_name_cmp( const char *a_, const char *b_ );
260void irc_channel_update_ops( irc_channel_t *ic, char *value );
261char *set_eval_irc_channel_ops( struct set *set, char *value );
262
263/* irc_commands.c */
264void irc_exec( irc_t *irc, char **cmd );
265
266/* irc_send.c */
267void irc_send_num( irc_t *irc, int code, char *format, ... ) G_GNUC_PRINTF( 3, 4 );
268void irc_send_login( irc_t *irc );
269void irc_send_motd( irc_t *irc );
270void irc_usermsg( irc_t *irc, char *format, ... );
271void irc_send_join( irc_channel_t *ic, irc_user_t *iu );
272void irc_send_part( irc_channel_t *ic, irc_user_t *iu, const char *reason );
273void irc_send_quit( irc_user_t *iu, const char *reason );
274void irc_send_kick( irc_channel_t *ic, irc_user_t *iu, irc_user_t *kicker, const char *reason );
275void irc_send_names( irc_channel_t *ic );
276void irc_send_topic( irc_channel_t *ic, gboolean topic_change );
277void irc_send_whois( irc_user_t *iu );
278void irc_send_who( irc_t *irc, GSList *l, const char *channel );
279void irc_send_msg( irc_user_t *iu, const char *type, const char *dst, const char *msg, const char *prefix );
280void irc_send_msg_raw( irc_user_t *iu, const char *type, const char *dst, const char *msg );
281void irc_send_msg_f( irc_user_t *iu, const char *type, const char *dst, const char *format, ... ) G_GNUC_PRINTF( 4, 5 );
282void irc_send_nick( irc_user_t *iu, const char *new );
283void irc_send_channel_user_mode_diff( irc_channel_t *ic, irc_user_t *iu,
284                                      irc_channel_user_flags_t old, irc_channel_user_flags_t new );
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.