source: irc.h @ 46d215d

Last change on this file since 46d215d was 619dd18, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-06-07T18:40:08Z

Paste buffer functionality is back, now for users *and* rooms.

  • Property mode set to 100644
File size: 7.9 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;
69
70        char *password; /* HACK: Used to save the user's password, but before
71                           logging in, this may contain a password we should
72                           send to identify after USER/NICK are received. */
73
74        char umode[8];
75       
76        struct query *queries;
77        GSList *file_transfers;
78       
79        GSList *users, *channels;
80        struct irc_channel *default_channel;
81        GHashTable *nick_user_hash;
82        GHashTable *watches;
83
84        gint r_watch_source_id;
85        gint w_watch_source_id;
86        gint ping_source_id;
87       
88        struct bee *b;
89} irc_t;
90
91typedef enum
92{
93        IRC_USER_PRIVATE = 1,
94        IRC_USER_AWAY = 2,
95} irc_user_flags_t;
96
97typedef struct irc_user
98{
99        irc_t *irc;
100       
101        char *nick;
102        char *user;
103        char *host;
104        char *fullname;
105       
106        /* Nickname in lowercase for case sensitive searches */
107        char *key;
108       
109        irc_user_flags_t flags;
110       
111        GString *pastebuf;
112        guint pastebuf_timer;
113       
114        struct bee_user *bu;
115       
116        const struct irc_user_funcs *f;
117} irc_user_t;
118
119struct irc_user_funcs
120{
121        gboolean (*privmsg)( irc_user_t *iu, const char *msg );
122        gboolean (*ctcp)( irc_user_t *iu, char * const* ctcp );
123};
124
125extern const struct irc_user_funcs irc_user_root_funcs;
126extern const struct irc_user_funcs irc_user_self_funcs;
127
128typedef enum
129{
130        IRC_CHANNEL_JOINED = 1,
131       
132        /* Hack: Set this flag right before jumping into IM when we expect
133           a call to imcb_chat_new(). */
134        IRC_CHANNEL_CHAT_PICKME = 0x10000,
135} irc_channel_flags_t;
136
137typedef struct irc_channel
138{
139        irc_t *irc;
140        char *name;
141        char mode[8];
142        int flags;
143       
144        char *topic;
145        char *topic_who;
146        time_t topic_time;
147       
148        GSList *users;
149        struct set *set;
150       
151        GString *pastebuf;
152        guint pastebuf_timer;
153       
154        const struct irc_channel_funcs *f;
155        void *data;
156} irc_channel_t;
157
158struct irc_channel_funcs
159{
160        gboolean (*privmsg)( irc_channel_t *ic, const char *msg );
161        gboolean (*join)( irc_channel_t *ic );
162        gboolean (*part)( irc_channel_t *ic, const char *msg );
163        gboolean (*topic)( irc_channel_t *ic, const char *new );
164        gboolean (*invite)( irc_channel_t *ic, irc_user_t *iu );
165       
166        gboolean (*_init)( irc_channel_t *ic );
167        gboolean (*_free)( irc_channel_t *ic );
168};
169
170typedef enum
171{
172        IRC_CHANNEL_USER_OP = 1,
173        IRC_CHANNEL_USER_HALFOP = 2,
174        IRC_CHANNEL_USER_VOICE = 4,
175} irc_channel_user_flags_t;
176
177typedef struct irc_channel_user
178{
179        irc_user_t *iu;
180        int flags;
181} irc_channel_user_t;
182
183typedef enum
184{
185        IRC_CC_TYPE_DEFAULT,
186        IRC_CC_TYPE_REST,
187        IRC_CC_TYPE_GROUP,
188        IRC_CC_TYPE_ACCOUNT,
189} irc_control_channel_type_t;
190
191struct irc_control_channel
192{
193        irc_control_channel_type_t type;
194        struct bee_group *group;
195        struct account *account;
196};
197
198extern const struct bee_ui_funcs irc_ui_funcs;
199
200/* irc.c */
201extern GSList *irc_connection_list;
202
203irc_t *irc_new( int fd );
204void irc_abort( irc_t *irc, int immed, char *format, ... ) G_GNUC_PRINTF( 3, 4 );
205void irc_free( irc_t *irc );
206void irc_setpass (irc_t *irc, const char *pass);
207
208void irc_process( irc_t *irc );
209char **irc_parse_line( char *line );
210char *irc_build_line( char **cmd );
211
212void irc_write( irc_t *irc, char *format, ... ) G_GNUC_PRINTF( 2, 3 );
213void irc_write_all( int now, char *format, ... ) G_GNUC_PRINTF( 2, 3 );
214void irc_vawrite( irc_t *irc, char *format, va_list params );
215
216int irc_check_login( irc_t *irc );
217
218void irc_umode_set( irc_t *irc, const char *s, gboolean allow_priv );
219
220/* irc_channel.c */
221irc_channel_t *irc_channel_new( irc_t *irc, const char *name );
222irc_channel_t *irc_channel_by_name( irc_t *irc, const char *name );
223irc_channel_t *irc_channel_get( irc_t *irc, char *id );
224int irc_channel_free( irc_channel_t *ic );
225int irc_channel_add_user( irc_channel_t *ic, irc_user_t *iu );
226int irc_channel_del_user( irc_channel_t *ic, irc_user_t *iu, gboolean silent, const char *msg );
227irc_channel_user_t *irc_channel_has_user( irc_channel_t *ic, irc_user_t *iu );
228int irc_channel_set_topic( irc_channel_t *ic, const char *topic, const irc_user_t *who );
229void irc_channel_user_set_mode( irc_channel_t *ic, irc_user_t *iu, irc_channel_user_flags_t flags );
230void irc_channel_printf( irc_channel_t *ic, char *format, ... );
231gboolean irc_channel_name_ok( const char *name );
232void irc_channel_update_ops( irc_channel_t *ic, char *value );
233char *set_eval_irc_channel_ops( struct set *set, char *value );
234
235/* irc_commands.c */
236void irc_exec( irc_t *irc, char **cmd );
237
238/* irc_send.c */
239void irc_send_num( irc_t *irc, int code, char *format, ... ) G_GNUC_PRINTF( 3, 4 );
240void irc_send_login( irc_t *irc );
241void irc_send_motd( irc_t *irc );
242void irc_usermsg( irc_t *irc, char *format, ... );
243void irc_send_join( irc_channel_t *ic, irc_user_t *iu );
244void irc_send_part( irc_channel_t *ic, irc_user_t *iu, const char *reason );
245void irc_send_quit( irc_user_t *iu, const char *reason );
246void irc_send_names( irc_channel_t *ic );
247void irc_send_topic( irc_channel_t *ic, gboolean topic_change );
248void irc_send_whois( irc_user_t *iu );
249void irc_send_who( irc_t *irc, GSList *l, const char *channel );
250void irc_send_msg( irc_user_t *iu, const char *type, const char *dst, const char *msg, const char *prefix );
251void irc_send_msg_raw( irc_user_t *iu, const char *type, const char *dst, const char *msg );
252void irc_send_msg_f( irc_user_t *iu, const char *type, const char *dst, const char *format, ... ) G_GNUC_PRINTF( 4, 5 );
253void irc_send_nick( irc_user_t *iu, const char *new );
254void irc_send_channel_user_mode_diff( irc_channel_t *ic, irc_user_t *iu,
255                                      irc_channel_user_flags_t old, irc_channel_user_flags_t new );
256
257/* irc_user.c */
258irc_user_t *irc_user_new( irc_t *irc, const char *nick );
259int irc_user_free( irc_t *irc, irc_user_t *iu );
260irc_user_t *irc_user_by_name( irc_t *irc, const char *nick );
261int irc_user_set_nick( irc_user_t *iu, const char *new );
262gint irc_user_cmp( gconstpointer a_, gconstpointer b_ );
263const char *irc_user_get_away( irc_user_t *iu );
264
265/* irc_util.c */
266char *set_eval_timezone( struct set *set, char *value );
267char *irc_format_timestamp( irc_t *irc, time_t msg_ts );
268
269/* irc_im.c */
270void bee_irc_channel_update( irc_t *irc, irc_channel_t *ic, irc_user_t *iu );
271
272#endif
Note: See TracBrowser for help on using the repository browser.