source: irc.h @ c8eeadd

Last change on this file since c8eeadd was c8eeadd, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-07-04T10:16:07Z

Added automatic joining of channels. Auto-rejoin functionality for
groupchats not reimplemented yet but that's the next step.
  • Property mode set to 100644
File size: 8.8 KB
Line 
1  /********************************************************************\
2  * BitlBee -- An IRC to other IM-networks gateway                     *
3  *                                                                    *
4  * Copyright 2002-2004 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., 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
30#define IRC_MAX_ARGS 8
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 "nt"        /* 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{
46        USTATUS_OFFLINE = 0,
47        USTATUS_AUTHORIZED = 1,
48        USTATUS_LOGGED_IN = 2,
49        USTATUS_IDENTIFIED = 4,
50        USTATUS_SHUTDOWN = 8
51} irc_status_t;
52
53struct irc_user;
54
55typedef struct irc
56{
57        int fd;
58        irc_status_t status;
59        double last_pong;
60        int pinging;
61        char *sendbuffer;
62        char *readbuffer;
63        GIConv iconv, oconv;
64
65        struct irc_user *root;
66        struct irc_user *user;
67       
68        char *last_root_cmd; /* Either the nickname from which the last root
69                                msg came, or the last channel root was talked
70                                to. */
71
72        char *password; /* HACK: Used to save the user's password, but before
73                           logging in, this may contain a password we should
74                           send to identify after USER/NICK are received. */
75
76        char umode[8];
77       
78        struct query *queries;
79        GSList *file_transfers;
80       
81        GSList *users, *channels;
82        struct irc_channel *default_channel;
83        GHashTable *nick_user_hash;
84        GHashTable *watches; /* See irc_cmd_watch() */
85
86        gint r_watch_source_id;
87        gint w_watch_source_id;
88        gint ping_source_id;
89       
90        struct bee *b;
91} irc_t;
92
93typedef enum
94{
95        /* Replaced with iu->last_channel IRC_USER_PRIVATE = 1, */
96        IRC_USER_AWAY = 2,
97} irc_user_flags_t;
98
99typedef struct irc_user
100{
101        irc_t *irc;
102       
103        char *nick;
104        char *user;
105        char *host;
106        char *fullname;
107       
108        /* Nickname in lowercase for case sensitive searches */
109        char *key;
110       
111        irc_user_flags_t flags;
112        struct irc_channel *last_channel;
113       
114        GString *pastebuf; /* Paste buffer (combine lines into a multiline msg). */
115        guint pastebuf_timer;
116        time_t away_reply_timeout; /* Only send a 301 if this time passed. */
117       
118        struct bee_user *bu;
119       
120        const struct irc_user_funcs *f;
121} irc_user_t;
122
123struct irc_user_funcs
124{
125        gboolean (*privmsg)( irc_user_t *iu, const char *msg );
126        gboolean (*ctcp)( irc_user_t *iu, char * const* ctcp );
127};
128
129extern const struct irc_user_funcs irc_user_root_funcs;
130extern const struct irc_user_funcs irc_user_self_funcs;
131
132typedef enum
133{
134        IRC_CHANNEL_JOINED = 1, /* The user is currently in the channel. */
135        IRC_CHANNEL_TEMP = 2,   /* Erase the channel when the user leaves,
136                                   and don't save it. */
137       
138        /* Hack: Set this flag right before jumping into IM when we expect
139           a call to imcb_chat_new(). */
140        IRC_CHANNEL_CHAT_PICKME = 0x10000,
141} irc_channel_flags_t;
142
143typedef struct irc_channel
144{
145        irc_t *irc;
146        char *name;
147        char mode[8];
148        int flags;
149       
150        char *topic;
151        char *topic_who;
152        time_t topic_time;
153       
154        GSList *users; /* struct irc_channel_user */
155        struct set *set;
156       
157        GString *pastebuf; /* Paste buffer (combine lines into a multiline msg). */
158        guint pastebuf_timer;
159       
160        const struct irc_channel_funcs *f;
161        void *data;
162} irc_channel_t;
163
164struct irc_channel_funcs
165{
166        gboolean (*privmsg)( irc_channel_t *ic, const char *msg );
167        gboolean (*join)( irc_channel_t *ic );
168        gboolean (*part)( irc_channel_t *ic, const char *msg );
169        gboolean (*topic)( irc_channel_t *ic, const char *new );
170        gboolean (*invite)( irc_channel_t *ic, irc_user_t *iu );
171       
172        gboolean (*_init)( irc_channel_t *ic );
173        gboolean (*_free)( irc_channel_t *ic );
174};
175
176typedef enum
177{
178        IRC_CHANNEL_USER_OP = 1,
179        IRC_CHANNEL_USER_HALFOP = 2,
180        IRC_CHANNEL_USER_VOICE = 4,
181} irc_channel_user_flags_t;
182
183typedef struct irc_channel_user
184{
185        irc_user_t *iu;
186        int flags;
187} irc_channel_user_t;
188
189typedef enum
190{
191        IRC_CC_TYPE_DEFAULT,
192        IRC_CC_TYPE_REST,
193        IRC_CC_TYPE_GROUP,
194        IRC_CC_TYPE_ACCOUNT,
195        IRC_CC_TYPE_PROTOCOL,
196} irc_control_channel_type_t;
197
198struct irc_control_channel
199{
200        irc_control_channel_type_t type;
201        struct bee_group *group;
202        struct account *account;
203        struct prpl *protocol;
204};
205
206extern const struct bee_ui_funcs irc_ui_funcs;
207
208/* irc.c */
209extern GSList *irc_connection_list;
210
211irc_t *irc_new( int fd );
212void irc_abort( irc_t *irc, int immed, char *format, ... ) G_GNUC_PRINTF( 3, 4 );
213void irc_free( irc_t *irc );
214void irc_setpass (irc_t *irc, const char *pass);
215
216void irc_process( irc_t *irc );
217char **irc_parse_line( char *line );
218char *irc_build_line( char **cmd );
219
220void irc_write( irc_t *irc, char *format, ... ) G_GNUC_PRINTF( 2, 3 );
221void irc_write_all( int now, char *format, ... ) G_GNUC_PRINTF( 2, 3 );
222void irc_vawrite( irc_t *irc, char *format, va_list params );
223
224int irc_check_login( irc_t *irc );
225
226void irc_umode_set( irc_t *irc, const char *s, gboolean allow_priv );
227
228/* irc_channel.c */
229irc_channel_t *irc_channel_new( irc_t *irc, const char *name );
230irc_channel_t *irc_channel_by_name( irc_t *irc, const char *name );
231irc_channel_t *irc_channel_get( irc_t *irc, char *id );
232int irc_channel_free( irc_channel_t *ic );
233void irc_channel_free_soon( irc_channel_t *ic );
234int irc_channel_add_user( irc_channel_t *ic, irc_user_t *iu );
235int irc_channel_del_user( irc_channel_t *ic, irc_user_t *iu, gboolean silent, const char *msg );
236irc_channel_user_t *irc_channel_has_user( irc_channel_t *ic, irc_user_t *iu );
237int irc_channel_set_topic( irc_channel_t *ic, const char *topic, const irc_user_t *who );
238void irc_channel_user_set_mode( irc_channel_t *ic, irc_user_t *iu, irc_channel_user_flags_t flags );
239void irc_channel_auto_joins( irc_t *irc, struct account *acc );
240void irc_channel_printf( irc_channel_t *ic, char *format, ... );
241gboolean irc_channel_name_ok( const char *name );
242void irc_channel_name_strip( char *name );
243int irc_channel_name_cmp( const char *a_, const char *b_ );
244void irc_channel_update_ops( irc_channel_t *ic, char *value );
245char *set_eval_irc_channel_ops( struct set *set, char *value );
246
247/* irc_commands.c */
248void irc_exec( irc_t *irc, char **cmd );
249
250/* irc_send.c */
251void irc_send_num( irc_t *irc, int code, char *format, ... ) G_GNUC_PRINTF( 3, 4 );
252void irc_send_login( irc_t *irc );
253void irc_send_motd( irc_t *irc );
254void irc_usermsg( irc_t *irc, char *format, ... );
255void irc_send_join( irc_channel_t *ic, irc_user_t *iu );
256void irc_send_part( irc_channel_t *ic, irc_user_t *iu, const char *reason );
257void irc_send_quit( irc_user_t *iu, const char *reason );
258void irc_send_names( irc_channel_t *ic );
259void irc_send_topic( irc_channel_t *ic, gboolean topic_change );
260void irc_send_whois( irc_user_t *iu );
261void irc_send_who( irc_t *irc, GSList *l, const char *channel );
262void irc_send_msg( irc_user_t *iu, const char *type, const char *dst, const char *msg, const char *prefix );
263void irc_send_msg_raw( irc_user_t *iu, const char *type, const char *dst, const char *msg );
264void irc_send_msg_f( irc_user_t *iu, const char *type, const char *dst, const char *format, ... ) G_GNUC_PRINTF( 4, 5 );
265void irc_send_nick( irc_user_t *iu, const char *new );
266void irc_send_channel_user_mode_diff( irc_channel_t *ic, irc_user_t *iu,
267                                      irc_channel_user_flags_t old, irc_channel_user_flags_t new );
268
269/* irc_user.c */
270irc_user_t *irc_user_new( irc_t *irc, const char *nick );
271int irc_user_free( irc_t *irc, irc_user_t *iu );
272irc_user_t *irc_user_by_name( irc_t *irc, const char *nick );
273int irc_user_set_nick( irc_user_t *iu, const char *new );
274gint irc_user_cmp( gconstpointer a_, gconstpointer b_ );
275const char *irc_user_get_away( irc_user_t *iu );
276void irc_user_quit( irc_user_t *iu, const char *msg );
277
278/* irc_util.c */
279char *set_eval_timezone( struct set *set, char *value );
280char *irc_format_timestamp( irc_t *irc, time_t msg_ts );
281
282/* irc_im.c */
283void bee_irc_channel_update( irc_t *irc, irc_channel_t *ic, irc_user_t *iu );
284
285#endif
Note: See TracBrowser for help on using the repository browser.