source: irc.h @ 355e2ad

Last change on this file since 355e2ad was 355e2ad, checked in by dequis <dx@…>, at 2015-10-01T01:01:48Z

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