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 | |
---|
44 | typedef 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 | |
---|
67 | struct irc_user; |
---|
68 | |
---|
69 | typedef 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 | |
---|
106 | typedef 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 | |
---|
114 | typedef 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 | |
---|
137 | struct 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 | |
---|
142 | extern const struct irc_user_funcs irc_user_root_funcs; |
---|
143 | extern const struct irc_user_funcs irc_user_self_funcs; |
---|
144 | |
---|
145 | typedef 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 | /* Show a placeholder of the channel in listings, but don't save it */ |
---|
151 | IRC_CHANNEL_KEEP_PLACEHOLDER = 4, |
---|
152 | |
---|
153 | /* Hack: Set this flag right before jumping into IM when we expect |
---|
154 | a call to imcb_chat_new(). */ |
---|
155 | IRC_CHANNEL_CHAT_PICKME = 0x10000, |
---|
156 | } irc_channel_flags_t; |
---|
157 | |
---|
158 | typedef struct irc_channel { |
---|
159 | irc_t *irc; |
---|
160 | char *name; |
---|
161 | char mode[8]; |
---|
162 | int flags; |
---|
163 | |
---|
164 | char *topic; |
---|
165 | char *topic_who; |
---|
166 | time_t topic_time; |
---|
167 | |
---|
168 | GSList *users; /* struct irc_channel_user */ |
---|
169 | struct irc_user *last_target; |
---|
170 | struct set *set; |
---|
171 | |
---|
172 | GString *pastebuf; /* Paste buffer (combine lines into a multiline msg). */ |
---|
173 | guint pastebuf_timer; |
---|
174 | |
---|
175 | const struct irc_channel_funcs *f; |
---|
176 | void *data; |
---|
177 | } irc_channel_t; |
---|
178 | |
---|
179 | struct irc_channel_funcs { |
---|
180 | gboolean (*privmsg)(irc_channel_t *ic, const char *msg); |
---|
181 | gboolean (*join)(irc_channel_t *ic); |
---|
182 | gboolean (*part)(irc_channel_t *ic, const char *msg); |
---|
183 | gboolean (*topic)(irc_channel_t *ic, const char *new_topic); |
---|
184 | gboolean (*invite)(irc_channel_t *ic, irc_user_t *iu); |
---|
185 | void (*kick)(irc_channel_t *ic, irc_user_t *iu, const char *msg); |
---|
186 | |
---|
187 | gboolean (*_init)(irc_channel_t *ic); |
---|
188 | gboolean (*_free)(irc_channel_t *ic); |
---|
189 | }; |
---|
190 | |
---|
191 | typedef enum { |
---|
192 | IRC_CHANNEL_USER_OP = 1, |
---|
193 | IRC_CHANNEL_USER_HALFOP = 2, |
---|
194 | IRC_CHANNEL_USER_VOICE = 4, |
---|
195 | IRC_CHANNEL_USER_NONE = 8, |
---|
196 | } irc_channel_user_flags_t; |
---|
197 | |
---|
198 | typedef struct irc_channel_user { |
---|
199 | irc_user_t *iu; |
---|
200 | int flags; |
---|
201 | } irc_channel_user_t; |
---|
202 | |
---|
203 | typedef enum { |
---|
204 | IRC_CC_TYPE_DEFAULT = 0x00001, |
---|
205 | IRC_CC_TYPE_REST = 0x00002, /* Still not implemented. */ |
---|
206 | IRC_CC_TYPE_GROUP = 0x00004, |
---|
207 | IRC_CC_TYPE_ACCOUNT = 0x00008, |
---|
208 | IRC_CC_TYPE_PROTOCOL = 0x00010, |
---|
209 | IRC_CC_TYPE_MASK = 0x000ff, |
---|
210 | IRC_CC_TYPE_INVERT = 0x00100, |
---|
211 | } irc_control_channel_type_t; |
---|
212 | |
---|
213 | struct irc_control_channel { |
---|
214 | irc_control_channel_type_t type; |
---|
215 | struct bee_group *group; |
---|
216 | struct account *account; |
---|
217 | struct prpl *protocol; |
---|
218 | char modes[5]; |
---|
219 | }; |
---|
220 | |
---|
221 | extern const struct bee_ui_funcs irc_ui_funcs; |
---|
222 | |
---|
223 | typedef enum { |
---|
224 | IRC_CDU_SILENT, |
---|
225 | IRC_CDU_PART, |
---|
226 | IRC_CDU_KICK, |
---|
227 | } irc_channel_del_user_type_t; |
---|
228 | |
---|
229 | /* These are a glued a little bit to the core/bee layer and a little bit to |
---|
230 | IRC. The first user is OTR, and I guess at some point we'll get to shape |
---|
231 | this a little bit more as other uses come up. */ |
---|
232 | typedef struct irc_plugin { |
---|
233 | /* Called at the end of irc_new(). Can be used to add settings, etc. */ |
---|
234 | gboolean (*irc_new)(irc_t *irc); |
---|
235 | /* At the end of irc_free(). */ |
---|
236 | void (*irc_free)(irc_t *irc); |
---|
237 | |
---|
238 | /* Problem with the following two functions is ordering if multiple |
---|
239 | plugins are handling them. Let's keep fixing that problem for |
---|
240 | whenever it becomes important. */ |
---|
241 | |
---|
242 | /* Called by bee_irc_user_privmsg_cb(). Return NULL if you want to |
---|
243 | abort sending the msg. */ |
---|
244 | char* (*filter_msg_out)(irc_user_t * iu, char *msg, int flags); |
---|
245 | /* Called by bee_irc_user_msg(). Return NULL if you swallowed the |
---|
246 | message and don't want anything to go to the user. */ |
---|
247 | char* (*filter_msg_in)(irc_user_t * iu, char *msg, int flags); |
---|
248 | |
---|
249 | /* From storage.c functions. Ideally these should not be used |
---|
250 | and instead data should be stored in settings which will get |
---|
251 | saved automatically. Consider these deprecated! */ |
---|
252 | void (*storage_load)(irc_t *irc); |
---|
253 | void (*storage_save)(irc_t *irc); |
---|
254 | void (*storage_remove)(const char *nick); |
---|
255 | } irc_plugin_t; |
---|
256 | |
---|
257 | extern GSList *irc_plugins; /* struct irc_plugin */ |
---|
258 | |
---|
259 | /* irc.c */ |
---|
260 | extern GSList *irc_connection_list; |
---|
261 | |
---|
262 | irc_t *irc_new(int fd); |
---|
263 | void irc_abort(irc_t *irc, int immed, char *format, ...) G_GNUC_PRINTF(3, 4); |
---|
264 | void irc_free(irc_t *irc); |
---|
265 | void irc_setpass(irc_t *irc, const char *pass); |
---|
266 | |
---|
267 | void irc_process(irc_t *irc); |
---|
268 | char **irc_parse_line(char *line); |
---|
269 | char *irc_build_line(char **cmd); |
---|
270 | |
---|
271 | void irc_write(irc_t *irc, char *format, ...) G_GNUC_PRINTF(2, 3); |
---|
272 | void irc_write_all(int now, char *format, ...) G_GNUC_PRINTF(2, 3); |
---|
273 | void irc_vawrite(irc_t *irc, char *format, va_list params); |
---|
274 | |
---|
275 | void irc_flush(irc_t *irc); |
---|
276 | void irc_switch_fd(irc_t *irc, int fd); |
---|
277 | void irc_sync(irc_t *irc); |
---|
278 | void irc_desync(irc_t *irc); |
---|
279 | |
---|
280 | int irc_check_login(irc_t *irc); |
---|
281 | |
---|
282 | void irc_umode_set(irc_t *irc, const char *s, gboolean allow_priv); |
---|
283 | |
---|
284 | void register_irc_plugin(const struct irc_plugin *p); |
---|
285 | |
---|
286 | /* irc_channel.c */ |
---|
287 | irc_channel_t *irc_channel_new(irc_t *irc, const char *name); |
---|
288 | irc_channel_t *irc_channel_by_name(irc_t *irc, const char *name); |
---|
289 | irc_channel_t *irc_channel_get(irc_t *irc, char *id); |
---|
290 | int irc_channel_free(irc_channel_t *ic); |
---|
291 | void irc_channel_free_soon(irc_channel_t *ic); |
---|
292 | int irc_channel_add_user(irc_channel_t *ic, irc_user_t *iu); |
---|
293 | int irc_channel_del_user(irc_channel_t *ic, irc_user_t *iu, irc_channel_del_user_type_t type, const char *msg); |
---|
294 | irc_channel_user_t *irc_channel_has_user(irc_channel_t *ic, irc_user_t *iu); |
---|
295 | struct irc_channel *irc_channel_with_user(irc_t *irc, irc_user_t *iu); |
---|
296 | int irc_channel_set_topic(irc_channel_t *ic, const char *topic, const irc_user_t *who); |
---|
297 | void irc_channel_user_set_mode(irc_channel_t *ic, irc_user_t *iu, irc_channel_user_flags_t flags); |
---|
298 | void irc_channel_set_mode(irc_channel_t *ic, const char *s); |
---|
299 | void irc_channel_auto_joins(irc_t *irc, struct account *acc); |
---|
300 | void irc_channel_printf(irc_channel_t *ic, char *format, ...); |
---|
301 | gboolean irc_channel_name_ok(const char *name); |
---|
302 | void irc_channel_name_strip(char *name); |
---|
303 | int irc_channel_name_cmp(const char *a_, const char *b_); |
---|
304 | char *irc_channel_name_gen(bee_t *bee, const char *name); |
---|
305 | gboolean irc_channel_name_hint(irc_channel_t *ic, const char *name); |
---|
306 | void irc_channel_update_ops(irc_channel_t *ic, char *value); |
---|
307 | char *set_eval_irc_channel_ops(struct set *set, char *value); |
---|
308 | gboolean irc_channel_wants_user(irc_channel_t *ic, irc_user_t *iu); |
---|
309 | |
---|
310 | /* irc_commands.c */ |
---|
311 | void irc_exec(irc_t *irc, char **cmd); |
---|
312 | |
---|
313 | /* irc_send.c */ |
---|
314 | void irc_send_num(irc_t *irc, int code, char *format, ...) G_GNUC_PRINTF(3, 4); |
---|
315 | void irc_send_login(irc_t *irc); |
---|
316 | void irc_send_motd(irc_t *irc); |
---|
317 | const char *irc_user_msgdest(irc_user_t *iu); |
---|
318 | void irc_rootmsg(irc_t *irc, char *format, ...); |
---|
319 | void irc_usermsg(irc_user_t *iu, char *format, ...); |
---|
320 | void irc_usernotice(irc_user_t *iu, char *format, ...); |
---|
321 | void irc_send_join(irc_channel_t *ic, irc_user_t *iu); |
---|
322 | void irc_send_part(irc_channel_t *ic, irc_user_t *iu, const char *reason); |
---|
323 | void irc_send_quit(irc_user_t *iu, const char *reason); |
---|
324 | void irc_send_kick(irc_channel_t *ic, irc_user_t *iu, irc_user_t *kicker, const char *reason); |
---|
325 | void irc_send_names(irc_channel_t *ic); |
---|
326 | void irc_send_topic(irc_channel_t *ic, gboolean topic_change); |
---|
327 | void irc_send_whois(irc_user_t *iu); |
---|
328 | void irc_send_who(irc_t *irc, GSList *l, const char *channel); |
---|
329 | void irc_send_msg(irc_user_t *iu, const char *type, const char *dst, const char *msg, const char *prefix); |
---|
330 | void irc_send_msg_raw(irc_user_t *iu, const char *type, const char *dst, const char *msg); |
---|
331 | void irc_send_msg_f(irc_user_t *iu, const char *type, const char *dst, const char *format, ...) G_GNUC_PRINTF(4, 5); |
---|
332 | void irc_send_nick(irc_user_t *iu, const char *new_nick); |
---|
333 | void irc_send_channel_user_mode_diff(irc_channel_t *ic, irc_user_t *iu, |
---|
334 | irc_channel_user_flags_t old_flags, irc_channel_user_flags_t new_flags); |
---|
335 | void irc_send_invite(irc_user_t *iu, irc_channel_t *ic); |
---|
336 | |
---|
337 | /* irc_user.c */ |
---|
338 | irc_user_t *irc_user_new(irc_t *irc, const char *nick); |
---|
339 | int irc_user_free(irc_t *irc, irc_user_t *iu); |
---|
340 | irc_user_t *irc_user_by_name(irc_t *irc, const char *nick); |
---|
341 | int irc_user_set_nick(irc_user_t *iu, const char *new_nick); |
---|
342 | gint irc_user_cmp(gconstpointer a_, gconstpointer b_); |
---|
343 | const char *irc_user_get_away(irc_user_t *iu); |
---|
344 | void irc_user_quit(irc_user_t *iu, const char *msg); |
---|
345 | |
---|
346 | /* irc_util.c */ |
---|
347 | char *set_eval_timezone(struct set *set, char *value); |
---|
348 | char *irc_format_timestamp(irc_t *irc, time_t msg_ts); |
---|
349 | |
---|
350 | /* irc_im.c */ |
---|
351 | void bee_irc_channel_update(irc_t *irc, irc_channel_t *ic, irc_user_t *iu); |
---|
352 | void bee_irc_user_nick_reset(irc_user_t *iu); |
---|
353 | |
---|
354 | #endif |
---|