source: irc.h @ b201c68

Last change on this file since b201c68 was 0e788f5, checked in by Wilmer van der Gaast <wilmer@…>, at 2013-02-21T19:15:59Z

I'm still bored on a long flight. Wrote a script to automatically update
my copyright mentions since some were getting pretty stale. Left files not
touched since before 2012 alone so that this change doesn't touch almost
EVERY source file.
  • Property mode set to 100644
File size: 12.0 KB
Line 
1  /********************************************************************\
2  * BitlBee -- An IRC to other IM-networks gateway                     *
3  *                                                                    *
4  * Copyright 2002-2013 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 16
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 "ntC"       /* 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
53        /* Not really status stuff, but other kinds of flags: For slightly
54           better password security, since the only way to send passwords
55           to the IRC server securely (i.e. not echoing to screen or written
56           to logfiles) is the /OPER command, try to use that command for
57           stuff that matters. */
58        OPER_HACK_IDENTIFY = 0x100,
59        OPER_HACK_IDENTIFY_NOLOAD = 0x01100,
60        OPER_HACK_IDENTIFY_FORCE  = 0x02100,
61        OPER_HACK_REGISTER = 0x200,
62        OPER_HACK_ACCOUNT_ADD = 0x400,
63        OPER_HACK_ANY = 0x3700, /* To check for them all at once. */
64} irc_status_t;
65
66struct irc_user;
67
68typedef struct irc
69{
70        int fd;
71        irc_status_t status;
72        double last_pong;
73        int pinging;
74        char *sendbuffer;
75        char *readbuffer;
76        GIConv iconv, oconv;
77
78        struct irc_user *root;
79        struct irc_user *user;
80       
81        char *password; /* HACK: Used to save the user's password, but before
82                           logging in, this may contain a password we should
83                           send to identify after USER/NICK are received. */
84
85        char umode[8];
86       
87        struct query *queries;
88        GSList *file_transfers;
89       
90        GSList *users, *channels;
91        struct irc_channel *default_channel;
92        GHashTable *nick_user_hash;
93        GHashTable *watches; /* See irc_cmd_watch() */
94
95        gint r_watch_source_id;
96        gint w_watch_source_id;
97        gint ping_source_id;
98        gint login_source_id; /* To slightly delay some events at login time. */
99       
100        struct otr *otr; /* OTR state and book keeping, used by the OTR plugin.
101                            TODO: Some mechanism for plugindata. */
102       
103        struct bee *b;
104} irc_t;
105
106typedef enum
107{
108        /* Replaced with iu->last_channel IRC_USER_PRIVATE = 1, */
109        IRC_USER_AWAY = 2,
110       
111        IRC_USER_OTR_ENCRYPTED = 0x10000,
112        IRC_USER_OTR_TRUSTED   = 0x20000,
113} irc_user_flags_t;
114
115typedef struct irc_user
116{
117        irc_t *irc;
118       
119        char *nick;
120        char *user;
121        char *host;
122        char *fullname;
123       
124        /* Nickname in lowercase for case insensitive searches */
125        char *key;
126       
127        irc_user_flags_t flags;
128        struct irc_channel *last_channel;
129       
130        GString *pastebuf; /* Paste buffer (combine lines into a multiline msg). */
131        guint pastebuf_timer;
132        time_t away_reply_timeout; /* Only send a 301 if this time passed. */
133       
134        struct bee_user *bu;
135       
136        const struct irc_user_funcs *f;
137} irc_user_t;
138
139struct irc_user_funcs
140{
141        gboolean (*privmsg)( irc_user_t *iu, const char *msg );
142        gboolean (*ctcp)( irc_user_t *iu, char * const* ctcp );
143};
144
145extern const struct irc_user_funcs irc_user_root_funcs;
146extern const struct irc_user_funcs irc_user_self_funcs;
147
148typedef enum
149{
150        IRC_CHANNEL_JOINED = 1, /* The user is currently in the channel. */
151        IRC_CHANNEL_TEMP = 2,   /* Erase the channel when the user leaves,
152                                   and don't save it. */
153       
154        /* Hack: Set this flag right before jumping into IM when we expect
155           a call to imcb_chat_new(). */
156        IRC_CHANNEL_CHAT_PICKME = 0x10000,
157} irc_channel_flags_t;
158
159typedef struct irc_channel
160{
161        irc_t *irc;
162        char *name;
163        char mode[8];
164        int flags;
165       
166        char *topic;
167        char *topic_who;
168        time_t topic_time;
169       
170        GSList *users; /* struct irc_channel_user */
171        struct irc_user *last_target;
172        struct set *set;
173       
174        GString *pastebuf; /* Paste buffer (combine lines into a multiline msg). */
175        guint pastebuf_timer;
176       
177        const struct irc_channel_funcs *f;
178        void *data;
179} irc_channel_t;
180
181struct irc_channel_funcs
182{
183        gboolean (*privmsg)( irc_channel_t *ic, const char *msg );
184        gboolean (*join)( irc_channel_t *ic );
185        gboolean (*part)( irc_channel_t *ic, const char *msg );
186        gboolean (*topic)( irc_channel_t *ic, const char *new_topic );
187        gboolean (*invite)( irc_channel_t *ic, irc_user_t *iu );
188       
189        gboolean (*_init)( irc_channel_t *ic );
190        gboolean (*_free)( irc_channel_t *ic );
191};
192
193typedef enum
194{
195        IRC_CHANNEL_USER_OP = 1,
196        IRC_CHANNEL_USER_HALFOP = 2,
197        IRC_CHANNEL_USER_VOICE = 4,
198        IRC_CHANNEL_USER_NONE = 8,
199} irc_channel_user_flags_t;
200
201typedef struct irc_channel_user
202{
203        irc_user_t *iu;
204        int flags;
205} irc_channel_user_t;
206
207typedef enum
208{
209        IRC_CC_TYPE_DEFAULT  = 0x00001,
210        IRC_CC_TYPE_REST     = 0x00002, /* Still not implemented. */
211        IRC_CC_TYPE_GROUP    = 0x00004,
212        IRC_CC_TYPE_ACCOUNT  = 0x00008,
213        IRC_CC_TYPE_PROTOCOL = 0x00010,
214        IRC_CC_TYPE_MASK     = 0x000ff,
215        IRC_CC_TYPE_INVERT   = 0x00100,
216} irc_control_channel_type_t;
217
218struct irc_control_channel
219{
220        irc_control_channel_type_t type;
221        struct bee_group *group;
222        struct account *account;
223        struct prpl *protocol;
224        char modes[4];
225};
226
227extern const struct bee_ui_funcs irc_ui_funcs;
228
229typedef enum
230{
231        IRC_CDU_SILENT,
232        IRC_CDU_PART,
233        IRC_CDU_KICK,
234} irc_channel_del_user_type_t;
235
236/* These are a glued a little bit to the core/bee layer and a little bit to
237   IRC. The first user is OTR, and I guess at some point we'll get to shape
238   this a little bit more as other uses come up. */
239typedef struct irc_plugin
240{
241        /* Called at the end of irc_new(). Can be used to add settings, etc. */
242        gboolean (*irc_new)( irc_t *irc );
243        /* At the end of irc_free(). */
244        void (*irc_free)( irc_t *irc );
245       
246        /* Problem with the following two functions is ordering if multiple
247           plugins are handling them. Let's keep fixing that problem for
248           whenever it becomes important. */
249       
250        /* Called by bee_irc_user_privmsg_cb(). Return NULL if you want to
251           abort sending the msg. */
252        char* (*filter_msg_out)( irc_user_t *iu, char *msg, int flags );
253        /* Called by bee_irc_user_msg(). Return NULL if you swallowed the
254           message and don't want anything to go to the user. */
255        char* (*filter_msg_in)( irc_user_t *iu, char *msg, int flags );
256       
257        /* From storage.c functions. Ideally these should not be used
258           and instead data should be stored in settings which will get
259           saved automatically. Consider these deprecated! */
260        void (*storage_load)( irc_t *irc );
261        void (*storage_save)( irc_t *irc );
262        void (*storage_remove)( const char *nick );
263} irc_plugin_t;
264
265extern GSList *irc_plugins; /* struct irc_plugin */
266
267/* irc.c */
268extern GSList *irc_connection_list;
269
270irc_t *irc_new( int fd );
271void irc_abort( irc_t *irc, int immed, char *format, ... ) G_GNUC_PRINTF( 3, 4 );
272void irc_free( irc_t *irc );
273void irc_setpass (irc_t *irc, const char *pass);
274
275void irc_process( irc_t *irc );
276char **irc_parse_line( char *line );
277char *irc_build_line( char **cmd );
278
279void irc_write( irc_t *irc, char *format, ... ) G_GNUC_PRINTF( 2, 3 );
280void irc_write_all( int now, char *format, ... ) G_GNUC_PRINTF( 2, 3 );
281void irc_vawrite( irc_t *irc, char *format, va_list params );
282
283void irc_flush( irc_t *irc );
284void irc_switch_fd( irc_t *irc, int fd );
285void irc_sync( irc_t *irc );
286void irc_desync( irc_t *irc );
287
288int irc_check_login( irc_t *irc );
289
290void irc_umode_set( irc_t *irc, const char *s, gboolean allow_priv );
291
292void register_irc_plugin( const struct irc_plugin *p );
293
294/* irc_channel.c */
295irc_channel_t *irc_channel_new( irc_t *irc, const char *name );
296irc_channel_t *irc_channel_by_name( irc_t *irc, const char *name );
297irc_channel_t *irc_channel_get( irc_t *irc, char *id );
298int irc_channel_free( irc_channel_t *ic );
299void irc_channel_free_soon( irc_channel_t *ic );
300int irc_channel_add_user( irc_channel_t *ic, irc_user_t *iu );
301int irc_channel_del_user( irc_channel_t *ic, irc_user_t *iu, irc_channel_del_user_type_t type, const char *msg );
302irc_channel_user_t *irc_channel_has_user( irc_channel_t *ic, irc_user_t *iu );
303struct irc_channel *irc_channel_with_user( irc_t *irc, irc_user_t *iu );
304int irc_channel_set_topic( irc_channel_t *ic, const char *topic, const irc_user_t *who );
305void irc_channel_user_set_mode( irc_channel_t *ic, irc_user_t *iu, irc_channel_user_flags_t flags );
306void irc_channel_set_mode( irc_channel_t *ic, const char *s );
307void irc_channel_auto_joins( irc_t *irc, struct account *acc );
308void irc_channel_printf( irc_channel_t *ic, char *format, ... );
309gboolean irc_channel_name_ok( const char *name );
310void irc_channel_name_strip( char *name );
311int irc_channel_name_cmp( const char *a_, const char *b_ );
312void irc_channel_update_ops( irc_channel_t *ic, char *value );
313char *set_eval_irc_channel_ops( struct set *set, char *value );
314gboolean irc_channel_wants_user( irc_channel_t *ic, irc_user_t *iu );
315
316/* irc_commands.c */
317void irc_exec( irc_t *irc, char **cmd );
318
319/* irc_send.c */
320void irc_send_num( irc_t *irc, int code, char *format, ... ) G_GNUC_PRINTF( 3, 4 );
321void irc_send_login( irc_t *irc );
322void irc_send_motd( irc_t *irc );
323const char *irc_user_msgdest( irc_user_t *iu );
324void irc_rootmsg( irc_t *irc, char *format, ... );
325void irc_usermsg( irc_user_t *iu, char *format, ... );
326void irc_usernotice( irc_user_t *iu, char *format, ... );
327void irc_send_join( irc_channel_t *ic, irc_user_t *iu );
328void irc_send_part( irc_channel_t *ic, irc_user_t *iu, const char *reason );
329void irc_send_quit( irc_user_t *iu, const char *reason );
330void irc_send_kick( irc_channel_t *ic, irc_user_t *iu, irc_user_t *kicker, const char *reason );
331void irc_send_names( irc_channel_t *ic );
332void irc_send_topic( irc_channel_t *ic, gboolean topic_change );
333void irc_send_whois( irc_user_t *iu );
334void irc_send_who( irc_t *irc, GSList *l, const char *channel );
335void irc_send_msg( irc_user_t *iu, const char *type, const char *dst, const char *msg, const char *prefix );
336void irc_send_msg_raw( irc_user_t *iu, const char *type, const char *dst, const char *msg );
337void irc_send_msg_f( irc_user_t *iu, const char *type, const char *dst, const char *format, ... ) G_GNUC_PRINTF( 4, 5 );
338void irc_send_nick( irc_user_t *iu, const char *new_nick );
339void irc_send_channel_user_mode_diff( irc_channel_t *ic, irc_user_t *iu,
340                                      irc_channel_user_flags_t old_flags, irc_channel_user_flags_t new_flags );
341void irc_send_invite( irc_user_t *iu, irc_channel_t *ic );
342
343/* irc_user.c */
344irc_user_t *irc_user_new( irc_t *irc, const char *nick );
345int irc_user_free( irc_t *irc, irc_user_t *iu );
346irc_user_t *irc_user_by_name( irc_t *irc, const char *nick );
347int irc_user_set_nick( irc_user_t *iu, const char *new_nick );
348gint irc_user_cmp( gconstpointer a_, gconstpointer b_ );
349const char *irc_user_get_away( irc_user_t *iu );
350void irc_user_quit( irc_user_t *iu, const char *msg );
351
352/* irc_util.c */
353char *set_eval_timezone( struct set *set, char *value );
354char *irc_format_timestamp( irc_t *irc, time_t msg_ts );
355
356/* irc_im.c */
357void bee_irc_channel_update( irc_t *irc, irc_channel_t *ic, irc_user_t *iu );
358void bee_irc_user_nick_reset( irc_user_t *iu );
359
360#endif
Note: See TracBrowser for help on using the repository browser.