[b7d3cc34] | 1 | /********************************************************************\ |
---|
| 2 | * BitlBee -- An IRC to other IM-networks gateway * |
---|
| 3 | * * |
---|
[2fe5eb9] | 4 | * Copyright 2002-2010 Wilmer van der Gaast and others * |
---|
[b7d3cc34] | 5 | \********************************************************************/ |
---|
| 6 | |
---|
[3ddb7477] | 7 | /* The IRC-based UI (for now the only one) */ |
---|
[b7d3cc34] | 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 |
---|
[5a71d9c] | 30 | #define IRC_MAX_ARGS 16 |
---|
[b7d3cc34] | 31 | |
---|
| 32 | #define IRC_LOGIN_TIMEOUT 60 |
---|
| 33 | #define IRC_PING_STRING "PinglBee" |
---|
| 34 | |
---|
[b919363] | 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 */ |
---|
[65016a6] | 38 | #define CMODES "ntC" /* Allowed modes */ |
---|
[b919363] | 39 | #define CMODE "t" /* Default mode */ |
---|
| 40 | #define UMODE "s" /* Default mode */ |
---|
| 41 | |
---|
| 42 | #define CTYPES "&#" /* Valid channel name prefixes */ |
---|
[b7d3cc34] | 43 | |
---|
| 44 | typedef enum |
---|
| 45 | { |
---|
[bd9b00f] | 46 | USTATUS_OFFLINE = 0, |
---|
[f6f5eee] | 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(). */ |
---|
[060d066] | 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_REGISTER = 0x200, |
---|
| 60 | OPER_HACK_ACCOUNT_ADD = 0x400, |
---|
| 61 | OPER_HACK_ANY = 0x700, /* To check for them all at once. */ |
---|
[b7d3cc34] | 62 | } irc_status_t; |
---|
| 63 | |
---|
[3ddb7477] | 64 | struct irc_user; |
---|
| 65 | |
---|
[b7d3cc34] | 66 | typedef struct irc |
---|
| 67 | { |
---|
| 68 | int fd; |
---|
| 69 | irc_status_t status; |
---|
| 70 | double last_pong; |
---|
| 71 | int pinging; |
---|
| 72 | char *sendbuffer; |
---|
| 73 | char *readbuffer; |
---|
[f9756bd] | 74 | GIConv iconv, oconv; |
---|
[b7d3cc34] | 75 | |
---|
[3ddb7477] | 76 | struct irc_user *root; |
---|
| 77 | struct irc_user *user; |
---|
[74f1cde] | 78 | |
---|
[a199d33] | 79 | char *password; /* HACK: Used to save the user's password, but before |
---|
| 80 | logging in, this may contain a password we should |
---|
| 81 | send to identify after USER/NICK are received. */ |
---|
[b7d3cc34] | 82 | |
---|
| 83 | char umode[8]; |
---|
| 84 | |
---|
| 85 | struct query *queries; |
---|
[2c2df7d] | 86 | GSList *file_transfers; |
---|
[b7d3cc34] | 87 | |
---|
[4be8239] | 88 | GSList *users, *channels; |
---|
[fd45e1d1] | 89 | struct irc_channel *default_channel; |
---|
[3ddb7477] | 90 | GHashTable *nick_user_hash; |
---|
[92c8d41] | 91 | GHashTable *watches; /* See irc_cmd_watch() */ |
---|
[b7d3cc34] | 92 | |
---|
| 93 | gint r_watch_source_id; |
---|
| 94 | gint w_watch_source_id; |
---|
| 95 | gint ping_source_id; |
---|
[6c2404e] | 96 | gint login_source_id; /* To slightly delay some events at login time. */ |
---|
[3ddb7477] | 97 | |
---|
[0c85c08] | 98 | struct otr *otr; /* OTR state and book keeping, used by the OTR plugin. |
---|
| 99 | TODO: Some mechanism for plugindata. */ |
---|
[be999a5] | 100 | |
---|
[3ddb7477] | 101 | struct bee *b; |
---|
[b7d3cc34] | 102 | } irc_t; |
---|
| 103 | |
---|
[74f1cde] | 104 | typedef enum |
---|
| 105 | { |
---|
[92c8d41] | 106 | /* Replaced with iu->last_channel IRC_USER_PRIVATE = 1, */ |
---|
[eb50495] | 107 | IRC_USER_AWAY = 2, |
---|
[ad2d8bc] | 108 | |
---|
| 109 | IRC_USER_OTR_ENCRYPTED = 0x10000, |
---|
| 110 | IRC_USER_OTR_TRUSTED = 0x20000, |
---|
[74f1cde] | 111 | } irc_user_flags_t; |
---|
| 112 | |
---|
[3ddb7477] | 113 | typedef struct irc_user |
---|
| 114 | { |
---|
[b95932e] | 115 | irc_t *irc; |
---|
| 116 | |
---|
[3ddb7477] | 117 | char *nick; |
---|
| 118 | char *user; |
---|
| 119 | char *host; |
---|
| 120 | char *fullname; |
---|
| 121 | |
---|
[2fe5eb9] | 122 | /* Nickname in lowercase for case insensitive searches */ |
---|
[3ddb7477] | 123 | char *key; |
---|
| 124 | |
---|
[74f1cde] | 125 | irc_user_flags_t flags; |
---|
[92c8d41] | 126 | struct irc_channel *last_channel; |
---|
[3ddb7477] | 127 | |
---|
[1c8e5f7] | 128 | GString *pastebuf; /* Paste buffer (combine lines into a multiline msg). */ |
---|
[619dd18] | 129 | guint pastebuf_timer; |
---|
[1c8e5f7] | 130 | time_t away_reply_timeout; /* Only send a 301 if this time passed. */ |
---|
[3ddb7477] | 131 | |
---|
[d860a8d] | 132 | struct bee_user *bu; |
---|
[280c56a] | 133 | |
---|
| 134 | const struct irc_user_funcs *f; |
---|
[3ddb7477] | 135 | } irc_user_t; |
---|
| 136 | |
---|
[280c56a] | 137 | struct irc_user_funcs |
---|
| 138 | { |
---|
| 139 | gboolean (*privmsg)( irc_user_t *iu, const char *msg ); |
---|
[24b8bbb] | 140 | gboolean (*ctcp)( irc_user_t *iu, char * const* ctcp ); |
---|
[280c56a] | 141 | }; |
---|
| 142 | |
---|
| 143 | extern const struct irc_user_funcs irc_user_root_funcs; |
---|
| 144 | extern const struct irc_user_funcs irc_user_self_funcs; |
---|
| 145 | |
---|
[4be8239] | 146 | typedef enum |
---|
| 147 | { |
---|
[1c40aa7] | 148 | IRC_CHANNEL_JOINED = 1, /* The user is currently in the channel. */ |
---|
| 149 | IRC_CHANNEL_TEMP = 2, /* Erase the channel when the user leaves, |
---|
| 150 | and don't save it. */ |
---|
[eb37735] | 151 | |
---|
| 152 | /* Hack: Set this flag right before jumping into IM when we expect |
---|
| 153 | a call to imcb_chat_new(). */ |
---|
| 154 | IRC_CHANNEL_CHAT_PICKME = 0x10000, |
---|
[4be8239] | 155 | } irc_channel_flags_t; |
---|
| 156 | |
---|
| 157 | typedef struct irc_channel |
---|
| 158 | { |
---|
| 159 | irc_t *irc; |
---|
| 160 | char *name; |
---|
[280c56a] | 161 | char mode[8]; |
---|
| 162 | int flags; |
---|
| 163 | |
---|
[4be8239] | 164 | char *topic; |
---|
[83e92bf] | 165 | char *topic_who; |
---|
| 166 | time_t topic_time; |
---|
[280c56a] | 167 | |
---|
[1c8e5f7] | 168 | GSList *users; /* struct irc_channel_user */ |
---|
[f7ca587] | 169 | struct irc_user *last_target; |
---|
[4be8239] | 170 | struct set *set; |
---|
[280c56a] | 171 | |
---|
[1c8e5f7] | 172 | GString *pastebuf; /* Paste buffer (combine lines into a multiline msg). */ |
---|
[619dd18] | 173 | guint pastebuf_timer; |
---|
| 174 | |
---|
[280c56a] | 175 | const struct irc_channel_funcs *f; |
---|
[aea8b68] | 176 | void *data; |
---|
[4be8239] | 177 | } irc_channel_t; |
---|
| 178 | |
---|
[280c56a] | 179 | struct irc_channel_funcs |
---|
| 180 | { |
---|
[a87754b] | 181 | gboolean (*privmsg)( irc_channel_t *ic, const char *msg ); |
---|
[bfb99ee] | 182 | gboolean (*join)( irc_channel_t *ic ); |
---|
| 183 | gboolean (*part)( irc_channel_t *ic, const char *msg ); |
---|
| 184 | gboolean (*topic)( irc_channel_t *ic, const char *new ); |
---|
[66b9e36a] | 185 | gboolean (*invite)( irc_channel_t *ic, irc_user_t *iu ); |
---|
[9ac3ed1] | 186 | |
---|
| 187 | gboolean (*_init)( irc_channel_t *ic ); |
---|
| 188 | gboolean (*_free)( irc_channel_t *ic ); |
---|
[280c56a] | 189 | }; |
---|
| 190 | |
---|
[e54112f] | 191 | typedef enum |
---|
| 192 | { |
---|
| 193 | IRC_CHANNEL_USER_OP = 1, |
---|
| 194 | IRC_CHANNEL_USER_HALFOP = 2, |
---|
| 195 | IRC_CHANNEL_USER_VOICE = 4, |
---|
[94d5da9c] | 196 | IRC_CHANNEL_USER_NONE = 8, |
---|
[e54112f] | 197 | } irc_channel_user_flags_t; |
---|
| 198 | |
---|
| 199 | typedef struct irc_channel_user |
---|
| 200 | { |
---|
| 201 | irc_user_t *iu; |
---|
| 202 | int flags; |
---|
| 203 | } irc_channel_user_t; |
---|
| 204 | |
---|
[9ac3ed1] | 205 | typedef enum |
---|
| 206 | { |
---|
| 207 | IRC_CC_TYPE_DEFAULT, |
---|
| 208 | IRC_CC_TYPE_REST, |
---|
| 209 | IRC_CC_TYPE_GROUP, |
---|
| 210 | IRC_CC_TYPE_ACCOUNT, |
---|
[7a6ba50] | 211 | IRC_CC_TYPE_PROTOCOL, |
---|
[9ac3ed1] | 212 | } irc_control_channel_type_t; |
---|
| 213 | |
---|
| 214 | struct irc_control_channel |
---|
| 215 | { |
---|
| 216 | irc_control_channel_type_t type; |
---|
| 217 | struct bee_group *group; |
---|
[a067771] | 218 | struct account *account; |
---|
[7a6ba50] | 219 | struct prpl *protocol; |
---|
[94d5da9c] | 220 | char modes[4]; |
---|
[9ac3ed1] | 221 | }; |
---|
| 222 | |
---|
[d860a8d] | 223 | extern const struct bee_ui_funcs irc_ui_funcs; |
---|
| 224 | |
---|
[006a84f] | 225 | typedef enum |
---|
| 226 | { |
---|
| 227 | IRC_CDU_SILENT, |
---|
| 228 | IRC_CDU_PART, |
---|
| 229 | IRC_CDU_KICK, |
---|
| 230 | } irc_channel_del_user_type_t; |
---|
| 231 | |
---|
[0c85c08] | 232 | /* These are a glued a little bit to the core/bee layer and a little bit to |
---|
| 233 | IRC. The first user is OTR, and I guess at some point we'll get to shape |
---|
| 234 | this a little bit more as other uses come up. */ |
---|
| 235 | typedef struct irc_plugin |
---|
| 236 | { |
---|
| 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 | |
---|
[934db064] | 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 | |
---|
[0c85c08] | 246 | /* Called by bee_irc_user_privmsg_cb(). Return NULL if you want to |
---|
| 247 | abort sending the msg. */ |
---|
[934db064] | 248 | char* (*filter_msg_out)( irc_user_t *iu, char *msg, int flags ); |
---|
[0c85c08] | 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. */ |
---|
[934db064] | 251 | char* (*filter_msg_in)( irc_user_t *iu, char *msg, int flags ); |
---|
[2dcaf9a] | 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 ); |
---|
[0c85c08] | 259 | } irc_plugin_t; |
---|
| 260 | |
---|
| 261 | extern GSList *irc_plugins; /* struct irc_plugin */ |
---|
| 262 | |
---|
[3ddb7477] | 263 | /* irc.c */ |
---|
[b7d3cc34] | 264 | extern GSList *irc_connection_list; |
---|
| 265 | |
---|
| 266 | irc_t *irc_new( int fd ); |
---|
[a9ca7dd] | 267 | void irc_abort( irc_t *irc, int immed, char *format, ... ) G_GNUC_PRINTF( 3, 4 ); |
---|
[b7d3cc34] | 268 | void irc_free( irc_t *irc ); |
---|
[1f92a58] | 269 | void irc_setpass (irc_t *irc, const char *pass); |
---|
[b7d3cc34] | 270 | |
---|
[f73b969] | 271 | void irc_process( irc_t *irc ); |
---|
[0431ea1] | 272 | char **irc_parse_line( char *line ); |
---|
[74c119d] | 273 | char *irc_build_line( char **cmd ); |
---|
[b7d3cc34] | 274 | |
---|
[a9ca7dd] | 275 | void irc_write( irc_t *irc, char *format, ... ) G_GNUC_PRINTF( 2, 3 ); |
---|
| 276 | void irc_write_all( int now, char *format, ... ) G_GNUC_PRINTF( 2, 3 ); |
---|
[3ddb7477] | 277 | void irc_vawrite( irc_t *irc, char *format, va_list params ); |
---|
[b7d3cc34] | 278 | |
---|
[f1c2b21] | 279 | void irc_flush( irc_t *irc ); |
---|
| 280 | void irc_switch_fd( irc_t *irc, int fd ); |
---|
| 281 | void irc_sync( irc_t *irc ); |
---|
| 282 | void irc_desync( irc_t *irc ); |
---|
| 283 | |
---|
[edf9657] | 284 | int irc_check_login( irc_t *irc ); |
---|
[3ddb7477] | 285 | |
---|
[b919363] | 286 | void irc_umode_set( irc_t *irc, const char *s, gboolean allow_priv ); |
---|
| 287 | |
---|
[0c85c08] | 288 | void register_irc_plugin( const struct irc_plugin *p ); |
---|
| 289 | |
---|
[4be8239] | 290 | /* irc_channel.c */ |
---|
| 291 | irc_channel_t *irc_channel_new( irc_t *irc, const char *name ); |
---|
[b9e020a] | 292 | irc_channel_t *irc_channel_by_name( irc_t *irc, const char *name ); |
---|
[36562b0] | 293 | irc_channel_t *irc_channel_get( irc_t *irc, char *id ); |
---|
[83e92bf] | 294 | int irc_channel_free( irc_channel_t *ic ); |
---|
[ab6006c] | 295 | void irc_channel_free_soon( irc_channel_t *ic ); |
---|
[4be8239] | 296 | int irc_channel_add_user( irc_channel_t *ic, irc_user_t *iu ); |
---|
[006a84f] | 297 | int irc_channel_del_user( irc_channel_t *ic, irc_user_t *iu, irc_channel_del_user_type_t type, const char *msg ); |
---|
[e54112f] | 298 | irc_channel_user_t *irc_channel_has_user( irc_channel_t *ic, irc_user_t *iu ); |
---|
[bb151f7] | 299 | struct irc_channel *irc_channel_with_user( irc_t *irc, irc_user_t *iu ); |
---|
[83e92bf] | 300 | int irc_channel_set_topic( irc_channel_t *ic, const char *topic, const irc_user_t *who ); |
---|
[6a9d068] | 301 | void irc_channel_user_set_mode( irc_channel_t *ic, irc_user_t *iu, irc_channel_user_flags_t flags ); |
---|
[65016a6] | 302 | void irc_channel_set_mode( irc_channel_t *ic, const char *s ); |
---|
[c8eeadd] | 303 | void irc_channel_auto_joins( irc_t *irc, struct account *acc ); |
---|
[9893da3] | 304 | void irc_channel_printf( irc_channel_t *ic, char *format, ... ); |
---|
[b919363] | 305 | gboolean irc_channel_name_ok( const char *name ); |
---|
[134a02c] | 306 | void irc_channel_name_strip( char *name ); |
---|
[6b90431] | 307 | int irc_channel_name_cmp( const char *a_, const char *b_ ); |
---|
[c5aefa4] | 308 | void irc_channel_update_ops( irc_channel_t *ic, char *value ); |
---|
| 309 | char *set_eval_irc_channel_ops( struct set *set, char *value ); |
---|
[ac2717b] | 310 | gboolean irc_channel_wants_user( irc_channel_t *ic, irc_user_t *iu ); |
---|
[4be8239] | 311 | |
---|
[3ddb7477] | 312 | /* irc_commands.c */ |
---|
| 313 | void irc_exec( irc_t *irc, char **cmd ); |
---|
| 314 | |
---|
| 315 | /* irc_send.c */ |
---|
| 316 | void irc_send_num( irc_t *irc, int code, char *format, ... ) G_GNUC_PRINTF( 3, 4 ); |
---|
| 317 | void irc_send_login( irc_t *irc ); |
---|
| 318 | void irc_send_motd( irc_t *irc ); |
---|
[4be8239] | 319 | void irc_usermsg( irc_t *irc, char *format, ... ); |
---|
| 320 | void irc_send_join( irc_channel_t *ic, irc_user_t *iu ); |
---|
| 321 | void irc_send_part( irc_channel_t *ic, irc_user_t *iu, const char *reason ); |
---|
[1f0224c] | 322 | void irc_send_quit( irc_user_t *iu, const char *reason ); |
---|
[006a84f] | 323 | void irc_send_kick( irc_channel_t *ic, irc_user_t *iu, irc_user_t *kicker, const char *reason ); |
---|
[4be8239] | 324 | void irc_send_names( irc_channel_t *ic ); |
---|
[83e92bf] | 325 | void irc_send_topic( irc_channel_t *ic, gboolean topic_change ); |
---|
[b95932e] | 326 | void irc_send_whois( irc_user_t *iu ); |
---|
[2f53ada] | 327 | void irc_send_who( irc_t *irc, GSList *l, const char *channel ); |
---|
[6761a40] | 328 | void irc_send_msg( irc_user_t *iu, const char *type, const char *dst, const char *msg, const char *prefix ); |
---|
| 329 | void irc_send_msg_raw( irc_user_t *iu, const char *type, const char *dst, const char *msg ); |
---|
[7b59872] | 330 | void irc_send_msg_f( irc_user_t *iu, const char *type, const char *dst, const char *format, ... ) G_GNUC_PRINTF( 4, 5 ); |
---|
[0b5cc72] | 331 | void irc_send_nick( irc_user_t *iu, const char *new ); |
---|
[6a9d068] | 332 | void irc_send_channel_user_mode_diff( irc_channel_t *ic, irc_user_t *iu, |
---|
| 333 | irc_channel_user_flags_t old, irc_channel_user_flags_t new ); |
---|
[1aa74f55] | 334 | void irc_send_invite( irc_user_t *iu, irc_channel_t *ic ); |
---|
[3ddb7477] | 335 | |
---|
| 336 | /* irc_user.c */ |
---|
| 337 | irc_user_t *irc_user_new( irc_t *irc, const char *nick ); |
---|
[eabc9d2] | 338 | int irc_user_free( irc_t *irc, irc_user_t *iu ); |
---|
[280c56a] | 339 | irc_user_t *irc_user_by_name( irc_t *irc, const char *nick ); |
---|
[57c96f7] | 340 | int irc_user_set_nick( irc_user_t *iu, const char *new ); |
---|
[ebaebfe] | 341 | gint irc_user_cmp( gconstpointer a_, gconstpointer b_ ); |
---|
[003a12b] | 342 | const char *irc_user_get_away( irc_user_t *iu ); |
---|
[0bd948e] | 343 | void irc_user_quit( irc_user_t *iu, const char *msg ); |
---|
[b7d3cc34] | 344 | |
---|
[21c87a7] | 345 | /* irc_util.c */ |
---|
| 346 | char *set_eval_timezone( struct set *set, char *value ); |
---|
| 347 | char *irc_format_timestamp( irc_t *irc, time_t msg_ts ); |
---|
[b7d3cc34] | 348 | |
---|
[13c1a9f] | 349 | /* irc_im.c */ |
---|
| 350 | void bee_irc_channel_update( irc_t *irc, irc_channel_t *ic, irc_user_t *iu ); |
---|
[a429907] | 351 | void bee_irc_user_nick_reset( irc_user_t *iu ); |
---|
[13c1a9f] | 352 | |
---|
[b7d3cc34] | 353 | #endif |
---|