source: irc.h @ a9b1e0e

Last change on this file since a9b1e0e was a9b1e0e, checked in by dequis <dx@…>, at 2015-04-06T17:01:55Z

irc_channel: use irc_t instead of bee_t

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