source: irc.h @ e01ff50

Last change on this file since e01ff50 was 35987a1, checked in by Wilmer van der Gaast <wilmer@…>, at 2014-02-28T23:17:28Z

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