[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 | |
---|
[764c7d1] | 29 | #include "otr.h" |
---|
| 30 | |
---|
[b7d3cc34] | 31 | #define IRC_MAX_LINE 512 |
---|
[5a71d9c] | 32 | #define IRC_MAX_ARGS 16 |
---|
[b7d3cc34] | 33 | |
---|
| 34 | #define IRC_LOGIN_TIMEOUT 60 |
---|
| 35 | #define IRC_PING_STRING "PinglBee" |
---|
| 36 | |
---|
[b919363] | 37 | #define UMODES "abisw" /* Allowed umodes (although they mostly do nothing) */ |
---|
| 38 | #define UMODES_PRIV "Ro" /* Allowed, but not by user directly */ |
---|
| 39 | #define UMODES_KEEP "R" /* Don't allow unsetting using /MODE */ |
---|
[65016a6] | 40 | #define CMODES "ntC" /* Allowed modes */ |
---|
[b919363] | 41 | #define CMODE "t" /* Default mode */ |
---|
| 42 | #define UMODE "s" /* Default mode */ |
---|
| 43 | |
---|
| 44 | #define CTYPES "&#" /* Valid channel name prefixes */ |
---|
[b7d3cc34] | 45 | |
---|
| 46 | typedef enum |
---|
| 47 | { |
---|
[bd9b00f] | 48 | USTATUS_OFFLINE = 0, |
---|
[f6f5eee] | 49 | USTATUS_AUTHORIZED = 1, /* Gave the correct server password (PASS). */ |
---|
| 50 | USTATUS_LOGGED_IN = 2, /* USER+NICK(+PASS) finished. */ |
---|
| 51 | USTATUS_IDENTIFIED = 4, /* To NickServ (root). */ |
---|
| 52 | USTATUS_SHUTDOWN = 8, /* Now used to indicate we're shutting down. |
---|
| 53 | Currently just blocks irc_vawrite(). */ |
---|
[b7d3cc34] | 54 | } irc_status_t; |
---|
| 55 | |
---|
[3ddb7477] | 56 | struct irc_user; |
---|
| 57 | |
---|
[b7d3cc34] | 58 | typedef struct irc |
---|
| 59 | { |
---|
| 60 | int fd; |
---|
| 61 | irc_status_t status; |
---|
| 62 | double last_pong; |
---|
| 63 | int pinging; |
---|
| 64 | char *sendbuffer; |
---|
| 65 | char *readbuffer; |
---|
[f9756bd] | 66 | GIConv iconv, oconv; |
---|
[b7d3cc34] | 67 | |
---|
[3ddb7477] | 68 | struct irc_user *root; |
---|
| 69 | struct irc_user *user; |
---|
[74f1cde] | 70 | |
---|
[a199d33] | 71 | char *password; /* HACK: Used to save the user's password, but before |
---|
| 72 | logging in, this may contain a password we should |
---|
| 73 | send to identify after USER/NICK are received. */ |
---|
[b7d3cc34] | 74 | |
---|
| 75 | char umode[8]; |
---|
| 76 | |
---|
| 77 | struct query *queries; |
---|
[2c2df7d] | 78 | GSList *file_transfers; |
---|
[b7d3cc34] | 79 | |
---|
[4be8239] | 80 | GSList *users, *channels; |
---|
[fd45e1d1] | 81 | struct irc_channel *default_channel; |
---|
[3ddb7477] | 82 | GHashTable *nick_user_hash; |
---|
[92c8d41] | 83 | GHashTable *watches; /* See irc_cmd_watch() */ |
---|
[b7d3cc34] | 84 | |
---|
| 85 | gint r_watch_source_id; |
---|
| 86 | gint w_watch_source_id; |
---|
| 87 | gint ping_source_id; |
---|
[6c2404e] | 88 | gint login_source_id; /* To slightly delay some events at login time. */ |
---|
[3ddb7477] | 89 | |
---|
[dc9797f] | 90 | otr_t *otr; /* OTR state and book keeping */ |
---|
[be999a5] | 91 | |
---|
[3ddb7477] | 92 | struct bee *b; |
---|
[b7d3cc34] | 93 | } irc_t; |
---|
| 94 | |
---|
[74f1cde] | 95 | typedef enum |
---|
| 96 | { |
---|
[92c8d41] | 97 | /* Replaced with iu->last_channel IRC_USER_PRIVATE = 1, */ |
---|
[eb50495] | 98 | IRC_USER_AWAY = 2, |
---|
[ad2d8bc] | 99 | |
---|
| 100 | IRC_USER_OTR_ENCRYPTED = 0x10000, |
---|
| 101 | IRC_USER_OTR_TRUSTED = 0x20000, |
---|
[74f1cde] | 102 | } irc_user_flags_t; |
---|
| 103 | |
---|
[3ddb7477] | 104 | typedef struct irc_user |
---|
| 105 | { |
---|
[b95932e] | 106 | irc_t *irc; |
---|
| 107 | |
---|
[3ddb7477] | 108 | char *nick; |
---|
| 109 | char *user; |
---|
| 110 | char *host; |
---|
| 111 | char *fullname; |
---|
| 112 | |
---|
[2fe5eb9] | 113 | /* Nickname in lowercase for case insensitive searches */ |
---|
[3ddb7477] | 114 | char *key; |
---|
| 115 | |
---|
[74f1cde] | 116 | irc_user_flags_t flags; |
---|
[92c8d41] | 117 | struct irc_channel *last_channel; |
---|
[3ddb7477] | 118 | |
---|
[1c8e5f7] | 119 | GString *pastebuf; /* Paste buffer (combine lines into a multiline msg). */ |
---|
[619dd18] | 120 | guint pastebuf_timer; |
---|
[1c8e5f7] | 121 | time_t away_reply_timeout; /* Only send a 301 if this time passed. */ |
---|
[3ddb7477] | 122 | |
---|
[d860a8d] | 123 | struct bee_user *bu; |
---|
[280c56a] | 124 | |
---|
| 125 | const struct irc_user_funcs *f; |
---|
[3ddb7477] | 126 | } irc_user_t; |
---|
| 127 | |
---|
[280c56a] | 128 | struct irc_user_funcs |
---|
| 129 | { |
---|
| 130 | gboolean (*privmsg)( irc_user_t *iu, const char *msg ); |
---|
[24b8bbb] | 131 | gboolean (*ctcp)( irc_user_t *iu, char * const* ctcp ); |
---|
[280c56a] | 132 | }; |
---|
| 133 | |
---|
| 134 | extern const struct irc_user_funcs irc_user_root_funcs; |
---|
| 135 | extern const struct irc_user_funcs irc_user_self_funcs; |
---|
| 136 | |
---|
[4be8239] | 137 | typedef enum |
---|
| 138 | { |
---|
[1c40aa7] | 139 | IRC_CHANNEL_JOINED = 1, /* The user is currently in the channel. */ |
---|
| 140 | IRC_CHANNEL_TEMP = 2, /* Erase the channel when the user leaves, |
---|
| 141 | and don't save it. */ |
---|
[eb37735] | 142 | |
---|
| 143 | /* Hack: Set this flag right before jumping into IM when we expect |
---|
| 144 | a call to imcb_chat_new(). */ |
---|
| 145 | IRC_CHANNEL_CHAT_PICKME = 0x10000, |
---|
[4be8239] | 146 | } irc_channel_flags_t; |
---|
| 147 | |
---|
| 148 | typedef struct irc_channel |
---|
| 149 | { |
---|
| 150 | irc_t *irc; |
---|
| 151 | char *name; |
---|
[280c56a] | 152 | char mode[8]; |
---|
| 153 | int flags; |
---|
| 154 | |
---|
[4be8239] | 155 | char *topic; |
---|
[83e92bf] | 156 | char *topic_who; |
---|
| 157 | time_t topic_time; |
---|
[280c56a] | 158 | |
---|
[1c8e5f7] | 159 | GSList *users; /* struct irc_channel_user */ |
---|
[f7ca587] | 160 | struct irc_user *last_target; |
---|
[4be8239] | 161 | struct set *set; |
---|
[280c56a] | 162 | |
---|
[1c8e5f7] | 163 | GString *pastebuf; /* Paste buffer (combine lines into a multiline msg). */ |
---|
[619dd18] | 164 | guint pastebuf_timer; |
---|
| 165 | |
---|
[280c56a] | 166 | const struct irc_channel_funcs *f; |
---|
[aea8b68] | 167 | void *data; |
---|
[4be8239] | 168 | } irc_channel_t; |
---|
| 169 | |
---|
[280c56a] | 170 | struct irc_channel_funcs |
---|
| 171 | { |
---|
[a87754b] | 172 | gboolean (*privmsg)( irc_channel_t *ic, const char *msg ); |
---|
[bfb99ee] | 173 | gboolean (*join)( irc_channel_t *ic ); |
---|
| 174 | gboolean (*part)( irc_channel_t *ic, const char *msg ); |
---|
| 175 | gboolean (*topic)( irc_channel_t *ic, const char *new ); |
---|
[66b9e36a] | 176 | gboolean (*invite)( irc_channel_t *ic, irc_user_t *iu ); |
---|
[9ac3ed1] | 177 | |
---|
| 178 | gboolean (*_init)( irc_channel_t *ic ); |
---|
| 179 | gboolean (*_free)( irc_channel_t *ic ); |
---|
[280c56a] | 180 | }; |
---|
| 181 | |
---|
[e54112f] | 182 | typedef enum |
---|
| 183 | { |
---|
| 184 | IRC_CHANNEL_USER_OP = 1, |
---|
| 185 | IRC_CHANNEL_USER_HALFOP = 2, |
---|
| 186 | IRC_CHANNEL_USER_VOICE = 4, |
---|
[94d5da9c] | 187 | IRC_CHANNEL_USER_NONE = 8, |
---|
[e54112f] | 188 | } irc_channel_user_flags_t; |
---|
| 189 | |
---|
| 190 | typedef struct irc_channel_user |
---|
| 191 | { |
---|
| 192 | irc_user_t *iu; |
---|
| 193 | int flags; |
---|
| 194 | } irc_channel_user_t; |
---|
| 195 | |
---|
[9ac3ed1] | 196 | typedef enum |
---|
| 197 | { |
---|
| 198 | IRC_CC_TYPE_DEFAULT, |
---|
| 199 | IRC_CC_TYPE_REST, |
---|
| 200 | IRC_CC_TYPE_GROUP, |
---|
| 201 | IRC_CC_TYPE_ACCOUNT, |
---|
[7a6ba50] | 202 | IRC_CC_TYPE_PROTOCOL, |
---|
[9ac3ed1] | 203 | } irc_control_channel_type_t; |
---|
| 204 | |
---|
| 205 | struct irc_control_channel |
---|
| 206 | { |
---|
| 207 | irc_control_channel_type_t type; |
---|
| 208 | struct bee_group *group; |
---|
[a067771] | 209 | struct account *account; |
---|
[7a6ba50] | 210 | struct prpl *protocol; |
---|
[94d5da9c] | 211 | char modes[4]; |
---|
[9ac3ed1] | 212 | }; |
---|
| 213 | |
---|
[d860a8d] | 214 | extern const struct bee_ui_funcs irc_ui_funcs; |
---|
| 215 | |
---|
[006a84f] | 216 | typedef enum |
---|
| 217 | { |
---|
| 218 | IRC_CDU_SILENT, |
---|
| 219 | IRC_CDU_PART, |
---|
| 220 | IRC_CDU_KICK, |
---|
| 221 | } irc_channel_del_user_type_t; |
---|
| 222 | |
---|
[3ddb7477] | 223 | /* irc.c */ |
---|
[b7d3cc34] | 224 | extern GSList *irc_connection_list; |
---|
| 225 | |
---|
| 226 | irc_t *irc_new( int fd ); |
---|
[a9ca7dd] | 227 | void irc_abort( irc_t *irc, int immed, char *format, ... ) G_GNUC_PRINTF( 3, 4 ); |
---|
[b7d3cc34] | 228 | void irc_free( irc_t *irc ); |
---|
[1f92a58] | 229 | void irc_setpass (irc_t *irc, const char *pass); |
---|
[b7d3cc34] | 230 | |
---|
[f73b969] | 231 | void irc_process( irc_t *irc ); |
---|
[0431ea1] | 232 | char **irc_parse_line( char *line ); |
---|
[74c119d] | 233 | char *irc_build_line( char **cmd ); |
---|
[b7d3cc34] | 234 | |
---|
[a9ca7dd] | 235 | void irc_write( irc_t *irc, char *format, ... ) G_GNUC_PRINTF( 2, 3 ); |
---|
| 236 | void irc_write_all( int now, char *format, ... ) G_GNUC_PRINTF( 2, 3 ); |
---|
[3ddb7477] | 237 | void irc_vawrite( irc_t *irc, char *format, va_list params ); |
---|
[b7d3cc34] | 238 | |
---|
[f1c2b21] | 239 | void irc_flush( irc_t *irc ); |
---|
| 240 | void irc_switch_fd( irc_t *irc, int fd ); |
---|
| 241 | void irc_sync( irc_t *irc ); |
---|
| 242 | void irc_desync( irc_t *irc ); |
---|
| 243 | |
---|
[edf9657] | 244 | int irc_check_login( irc_t *irc ); |
---|
[3ddb7477] | 245 | |
---|
[b919363] | 246 | void irc_umode_set( irc_t *irc, const char *s, gboolean allow_priv ); |
---|
| 247 | |
---|
[4be8239] | 248 | /* irc_channel.c */ |
---|
| 249 | irc_channel_t *irc_channel_new( irc_t *irc, const char *name ); |
---|
[b9e020a] | 250 | irc_channel_t *irc_channel_by_name( irc_t *irc, const char *name ); |
---|
[36562b0] | 251 | irc_channel_t *irc_channel_get( irc_t *irc, char *id ); |
---|
[83e92bf] | 252 | int irc_channel_free( irc_channel_t *ic ); |
---|
[ab6006c] | 253 | void irc_channel_free_soon( irc_channel_t *ic ); |
---|
[4be8239] | 254 | int irc_channel_add_user( irc_channel_t *ic, irc_user_t *iu ); |
---|
[006a84f] | 255 | int irc_channel_del_user( irc_channel_t *ic, irc_user_t *iu, irc_channel_del_user_type_t type, const char *msg ); |
---|
[e54112f] | 256 | irc_channel_user_t *irc_channel_has_user( irc_channel_t *ic, irc_user_t *iu ); |
---|
[83e92bf] | 257 | int irc_channel_set_topic( irc_channel_t *ic, const char *topic, const irc_user_t *who ); |
---|
[6a9d068] | 258 | void irc_channel_user_set_mode( irc_channel_t *ic, irc_user_t *iu, irc_channel_user_flags_t flags ); |
---|
[65016a6] | 259 | void irc_channel_set_mode( irc_channel_t *ic, const char *s ); |
---|
[c8eeadd] | 260 | void irc_channel_auto_joins( irc_t *irc, struct account *acc ); |
---|
[9893da3] | 261 | void irc_channel_printf( irc_channel_t *ic, char *format, ... ); |
---|
[b919363] | 262 | gboolean irc_channel_name_ok( const char *name ); |
---|
[134a02c] | 263 | void irc_channel_name_strip( char *name ); |
---|
[6b90431] | 264 | int irc_channel_name_cmp( const char *a_, const char *b_ ); |
---|
[c5aefa4] | 265 | void irc_channel_update_ops( irc_channel_t *ic, char *value ); |
---|
| 266 | char *set_eval_irc_channel_ops( struct set *set, char *value ); |
---|
[ac2717b] | 267 | gboolean irc_channel_wants_user( irc_channel_t *ic, irc_user_t *iu ); |
---|
[4be8239] | 268 | |
---|
[3ddb7477] | 269 | /* irc_commands.c */ |
---|
| 270 | void irc_exec( irc_t *irc, char **cmd ); |
---|
| 271 | |
---|
| 272 | /* irc_send.c */ |
---|
| 273 | void irc_send_num( irc_t *irc, int code, char *format, ... ) G_GNUC_PRINTF( 3, 4 ); |
---|
| 274 | void irc_send_login( irc_t *irc ); |
---|
| 275 | void irc_send_motd( irc_t *irc ); |
---|
[4be8239] | 276 | void irc_usermsg( irc_t *irc, char *format, ... ); |
---|
| 277 | void irc_send_join( irc_channel_t *ic, irc_user_t *iu ); |
---|
| 278 | void irc_send_part( irc_channel_t *ic, irc_user_t *iu, const char *reason ); |
---|
[1f0224c] | 279 | void irc_send_quit( irc_user_t *iu, const char *reason ); |
---|
[006a84f] | 280 | void irc_send_kick( irc_channel_t *ic, irc_user_t *iu, irc_user_t *kicker, const char *reason ); |
---|
[4be8239] | 281 | void irc_send_names( irc_channel_t *ic ); |
---|
[83e92bf] | 282 | void irc_send_topic( irc_channel_t *ic, gboolean topic_change ); |
---|
[b95932e] | 283 | void irc_send_whois( irc_user_t *iu ); |
---|
[2f53ada] | 284 | void irc_send_who( irc_t *irc, GSList *l, const char *channel ); |
---|
[6761a40] | 285 | void irc_send_msg( irc_user_t *iu, const char *type, const char *dst, const char *msg, const char *prefix ); |
---|
| 286 | void irc_send_msg_raw( irc_user_t *iu, const char *type, const char *dst, const char *msg ); |
---|
[7b59872] | 287 | void irc_send_msg_f( irc_user_t *iu, const char *type, const char *dst, const char *format, ... ) G_GNUC_PRINTF( 4, 5 ); |
---|
[0b5cc72] | 288 | void irc_send_nick( irc_user_t *iu, const char *new ); |
---|
[6a9d068] | 289 | void irc_send_channel_user_mode_diff( irc_channel_t *ic, irc_user_t *iu, |
---|
| 290 | irc_channel_user_flags_t old, irc_channel_user_flags_t new ); |
---|
[1aa74f55] | 291 | void irc_send_invite( irc_user_t *iu, irc_channel_t *ic ); |
---|
[3ddb7477] | 292 | |
---|
| 293 | /* irc_user.c */ |
---|
| 294 | irc_user_t *irc_user_new( irc_t *irc, const char *nick ); |
---|
[eabc9d2] | 295 | int irc_user_free( irc_t *irc, irc_user_t *iu ); |
---|
[280c56a] | 296 | irc_user_t *irc_user_by_name( irc_t *irc, const char *nick ); |
---|
[57c96f7] | 297 | int irc_user_set_nick( irc_user_t *iu, const char *new ); |
---|
[ebaebfe] | 298 | gint irc_user_cmp( gconstpointer a_, gconstpointer b_ ); |
---|
[003a12b] | 299 | const char *irc_user_get_away( irc_user_t *iu ); |
---|
[0bd948e] | 300 | void irc_user_quit( irc_user_t *iu, const char *msg ); |
---|
[b7d3cc34] | 301 | |
---|
[21c87a7] | 302 | /* irc_util.c */ |
---|
| 303 | char *set_eval_timezone( struct set *set, char *value ); |
---|
| 304 | char *irc_format_timestamp( irc_t *irc, time_t msg_ts ); |
---|
[b7d3cc34] | 305 | |
---|
[13c1a9f] | 306 | /* irc_im.c */ |
---|
| 307 | void bee_irc_channel_update( irc_t *irc, irc_channel_t *ic, irc_user_t *iu ); |
---|
| 308 | |
---|
[b7d3cc34] | 309 | #endif |
---|