source: irc.h @ 0b5cc72

Last change on this file since 0b5cc72 was 0b5cc72, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-04-05T00:39:04Z

Send nickname change notifications when necessary.

  • Property mode set to 100644
File size: 5.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        GHashTable *nick_user_hash;
81        GHashTable *watches;
82
83        gint r_watch_source_id;
84        gint w_watch_source_id;
85        gint ping_source_id;
86       
87        struct bee *b;
88} irc_t;
89
90typedef enum
91{
92        IRC_USER_PRIVATE = 1,
93} irc_user_flags_t;
94
95typedef struct irc_user
96{
97        irc_t *irc;
98       
99        char *nick;
100        char *user;
101        char *host;
102        char *fullname;
103       
104        /* Nickname in lowercase for case sensitive searches */
105        char *key;
106       
107        irc_user_flags_t flags;
108       
109        char *sendbuf;
110        int sendbuf_len;
111        guint sendbuf_timer;
112        //int sendbuf_flags;
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};
123
124extern const struct irc_user_funcs irc_user_root_funcs;
125extern const struct irc_user_funcs irc_user_self_funcs;
126
127typedef enum
128{
129        IRC_CHANNEL_JOINED = 1,
130} irc_channel_flags_t;
131
132typedef struct irc_channel
133{
134        irc_t *irc;
135        char *name;
136        char mode[8];
137        int flags;
138       
139        char *topic;
140        char *topic_who;
141        time_t topic_time;
142       
143        GSList *users;
144        struct set *set;
145       
146        const struct irc_channel_funcs *f;
147} irc_channel_t;
148
149struct irc_channel_funcs
150{
151        gboolean (*privmsg)( irc_channel_t *iu, const char *msg );
152};
153
154extern const struct bee_ui_funcs irc_ui_funcs;
155
156/* irc.c */
157extern GSList *irc_connection_list;
158
159irc_t *irc_new( int fd );
160void irc_abort( irc_t *irc, int immed, char *format, ... ) G_GNUC_PRINTF( 3, 4 );
161void irc_free( irc_t *irc );
162
163void irc_process( irc_t *irc );
164char **irc_parse_line( char *line );
165char *irc_build_line( char **cmd );
166
167void irc_write( irc_t *irc, char *format, ... ) G_GNUC_PRINTF( 2, 3 );
168void irc_write_all( int now, char *format, ... ) G_GNUC_PRINTF( 2, 3 );
169void irc_vawrite( irc_t *irc, char *format, va_list params );
170
171int irc_check_login( irc_t *irc );
172
173void irc_umode_set( irc_t *irc, const char *s, gboolean allow_priv );
174
175/* irc_channel.c */
176irc_channel_t *irc_channel_new( irc_t *irc, const char *name );
177irc_channel_t *irc_channel_by_name( irc_t *irc, const char *name );
178int irc_channel_free( irc_channel_t *ic );
179int irc_channel_add_user( irc_channel_t *ic, irc_user_t *iu );
180int irc_channel_del_user( irc_channel_t *ic, irc_user_t *iu );
181gboolean irc_channel_has_user( irc_channel_t *ic, irc_user_t *iu );
182int irc_channel_set_topic( irc_channel_t *ic, const char *topic, const irc_user_t *who );
183gboolean irc_channel_name_ok( const char *name );
184
185/* irc_commands.c */
186void irc_exec( irc_t *irc, char **cmd );
187
188/* irc_send.c */
189void irc_send_num( irc_t *irc, int code, char *format, ... ) G_GNUC_PRINTF( 3, 4 );
190void irc_send_login( irc_t *irc );
191void irc_send_motd( irc_t *irc );
192void irc_usermsg( irc_t *irc, char *format, ... );
193void irc_send_join( irc_channel_t *ic, irc_user_t *iu );
194void irc_send_part( irc_channel_t *ic, irc_user_t *iu, const char *reason );
195void irc_send_names( irc_channel_t *ic );
196void irc_send_topic( irc_channel_t *ic, gboolean topic_change );
197void irc_send_whois( irc_user_t *iu );
198void irc_send_who( irc_t *irc, GSList *l, const char *channel );
199void irc_send_msg( irc_user_t *iu, const char *type, const char *dst, const char *msg, const char *prefix );
200void irc_send_msg_raw( irc_user_t *iu, const char *type, const char *dst, const char *msg );
201void irc_send_nick( irc_user_t *iu, const char *new );
202
203/* irc_user.c */
204irc_user_t *irc_user_new( irc_t *irc, const char *nick );
205int irc_user_free( irc_t *irc, const char *nick );
206irc_user_t *irc_user_by_name( irc_t *irc, const char *nick );
207int irc_user_set_nick( irc_t *irc, const char *old, const char *new );
208gint irc_user_cmp( gconstpointer a_, gconstpointer b_ );
209
210#endif
Note: See TracBrowser for help on using the repository browser.