source: irc.h @ bfb99ee

Last change on this file since bfb99ee was bfb99ee, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-05-08T12:13:23Z

Allow leaving groupchat channels.

  • Property mode set to 100644
File size: 7.0 KB
RevLine 
[b7d3cc34]1  /********************************************************************\
2  * BitlBee -- An IRC to other IM-networks gateway                     *
3  *                                                                    *
4  * Copyright 2002-2004 Wilmer van der Gaast and others                *
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
30#define IRC_MAX_ARGS 8
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 */
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 */
[b7d3cc34]43
44typedef enum
45{
[bd9b00f]46        USTATUS_OFFLINE = 0,
[79e826a]47        USTATUS_AUTHORIZED = 1,
48        USTATUS_LOGGED_IN = 2,
49        USTATUS_IDENTIFIED = 4,
50        USTATUS_SHUTDOWN = 8
[b7d3cc34]51} irc_status_t;
52
[3ddb7477]53struct irc_user;
54
[b7d3cc34]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;
[f9756bd]63        GIConv iconv, oconv;
[b7d3cc34]64
[3ddb7477]65        struct irc_user *root;
66        struct irc_user *user;
[74f1cde]67       
68        char *last_root_cmd;
[b7d3cc34]69
[a199d33]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. */
[b7d3cc34]73
74        char umode[8];
75       
76        struct query *queries;
[2c2df7d]77        GSList *file_transfers;
[b7d3cc34]78       
[4be8239]79        GSList *users, *channels;
[3ddb7477]80        GHashTable *nick_user_hash;
[b7d3cc34]81        GHashTable *watches;
82
83        gint r_watch_source_id;
84        gint w_watch_source_id;
85        gint ping_source_id;
[3ddb7477]86       
87        struct bee *b;
[b7d3cc34]88} irc_t;
89
[74f1cde]90typedef enum
91{
92        IRC_USER_PRIVATE = 1,
[eb50495]93        IRC_USER_AWAY = 2,
[74f1cde]94} irc_user_flags_t;
95
[3ddb7477]96typedef struct irc_user
97{
[b95932e]98        irc_t *irc;
99       
[3ddb7477]100        char *nick;
101        char *user;
102        char *host;
103        char *fullname;
104       
105        /* Nickname in lowercase for case sensitive searches */
106        char *key;
107       
[74f1cde]108        irc_user_flags_t flags;
[3ddb7477]109       
110        char *sendbuf;
111        int sendbuf_len;
112        guint sendbuf_timer;
[74f1cde]113        //int sendbuf_flags;
[3ddb7477]114       
[d860a8d]115        struct bee_user *bu;
[280c56a]116       
117        const struct irc_user_funcs *f;
[3ddb7477]118} irc_user_t;
119
[280c56a]120struct irc_user_funcs
121{
122        gboolean (*privmsg)( irc_user_t *iu, const char *msg );
[24b8bbb]123        gboolean (*ctcp)( irc_user_t *iu, char * const* ctcp );
[280c56a]124};
125
126extern const struct irc_user_funcs irc_user_root_funcs;
127extern const struct irc_user_funcs irc_user_self_funcs;
128
[4be8239]129typedef enum
130{
131        IRC_CHANNEL_JOINED = 1,
132} irc_channel_flags_t;
133
134typedef struct irc_channel
135{
136        irc_t *irc;
137        char *name;
[280c56a]138        char mode[8];
139        int flags;
140       
[4be8239]141        char *topic;
[83e92bf]142        char *topic_who;
143        time_t topic_time;
[280c56a]144       
[4be8239]145        GSList *users;
146        struct set *set;
[280c56a]147       
148        const struct irc_channel_funcs *f;
[aea8b68]149        void *data;
[4be8239]150} irc_channel_t;
151
[280c56a]152struct irc_channel_funcs
153{
[a87754b]154        gboolean (*privmsg)( irc_channel_t *ic, const char *msg );
[bfb99ee]155        gboolean (*join)( irc_channel_t *ic );
156        gboolean (*part)( irc_channel_t *ic, const char *msg );
157        gboolean (*topic)( irc_channel_t *ic, const char *new );
[280c56a]158};
159
[e54112f]160typedef enum
161{
162        IRC_CHANNEL_USER_OP = 1,
163        IRC_CHANNEL_USER_HALFOP = 2,
164        IRC_CHANNEL_USER_VOICE = 4,
165} irc_channel_user_flags_t;
166
167typedef struct irc_channel_user
168{
169        irc_user_t *iu;
170        int flags;
171} irc_channel_user_t;
172
[d860a8d]173extern const struct bee_ui_funcs irc_ui_funcs;
174
[3ddb7477]175/* irc.c */
[b7d3cc34]176extern GSList *irc_connection_list;
177
178irc_t *irc_new( int fd );
[a9ca7dd]179void irc_abort( irc_t *irc, int immed, char *format, ... ) G_GNUC_PRINTF( 3, 4 );
[b7d3cc34]180void irc_free( irc_t *irc );
[1f92a58]181void irc_setpass (irc_t *irc, const char *pass);
[b7d3cc34]182
[f73b969]183void irc_process( irc_t *irc );
[0431ea1]184char **irc_parse_line( char *line );
[74c119d]185char *irc_build_line( char **cmd );
[b7d3cc34]186
[a9ca7dd]187void irc_write( irc_t *irc, char *format, ... ) G_GNUC_PRINTF( 2, 3 );
188void irc_write_all( int now, char *format, ... ) G_GNUC_PRINTF( 2, 3 );
[3ddb7477]189void irc_vawrite( irc_t *irc, char *format, va_list params );
[b7d3cc34]190
[edf9657]191int irc_check_login( irc_t *irc );
[3ddb7477]192
[b919363]193void irc_umode_set( irc_t *irc, const char *s, gboolean allow_priv );
194
[4be8239]195/* irc_channel.c */
196irc_channel_t *irc_channel_new( irc_t *irc, const char *name );
[b9e020a]197irc_channel_t *irc_channel_by_name( irc_t *irc, const char *name );
[83e92bf]198int irc_channel_free( irc_channel_t *ic );
[4be8239]199int irc_channel_add_user( irc_channel_t *ic, irc_user_t *iu );
200int irc_channel_del_user( irc_channel_t *ic, irc_user_t *iu );
[e54112f]201irc_channel_user_t *irc_channel_has_user( irc_channel_t *ic, irc_user_t *iu );
[83e92bf]202int irc_channel_set_topic( irc_channel_t *ic, const char *topic, const irc_user_t *who );
[6a9d068]203void irc_channel_user_set_mode( irc_channel_t *ic, irc_user_t *iu, irc_channel_user_flags_t flags );
[9893da3]204void irc_channel_printf( irc_channel_t *ic, char *format, ... );
[b919363]205gboolean irc_channel_name_ok( const char *name );
[4be8239]206
[3ddb7477]207/* irc_commands.c */
208void irc_exec( irc_t *irc, char **cmd );
209
210/* irc_send.c */
211void irc_send_num( irc_t *irc, int code, char *format, ... ) G_GNUC_PRINTF( 3, 4 );
212void irc_send_login( irc_t *irc );
213void irc_send_motd( irc_t *irc );
[4be8239]214void irc_usermsg( irc_t *irc, char *format, ... );
215void irc_send_join( irc_channel_t *ic, irc_user_t *iu );
216void irc_send_part( irc_channel_t *ic, irc_user_t *iu, const char *reason );
217void irc_send_names( irc_channel_t *ic );
[83e92bf]218void irc_send_topic( irc_channel_t *ic, gboolean topic_change );
[b95932e]219void irc_send_whois( irc_user_t *iu );
[2f53ada]220void irc_send_who( irc_t *irc, GSList *l, const char *channel );
[6761a40]221void irc_send_msg( irc_user_t *iu, const char *type, const char *dst, const char *msg, const char *prefix );
222void irc_send_msg_raw( irc_user_t *iu, const char *type, const char *dst, const char *msg );
[7b59872]223void irc_send_msg_f( irc_user_t *iu, const char *type, const char *dst, const char *format, ... ) G_GNUC_PRINTF( 4, 5 );
[0b5cc72]224void irc_send_nick( irc_user_t *iu, const char *new );
[6a9d068]225void irc_send_channel_user_mode_diff( irc_channel_t *ic, irc_user_t *iu,
226                                      irc_channel_user_flags_t old, irc_channel_user_flags_t new );
[3ddb7477]227
228/* irc_user.c */
229irc_user_t *irc_user_new( irc_t *irc, const char *nick );
[eabc9d2]230int irc_user_free( irc_t *irc, irc_user_t *iu );
[280c56a]231irc_user_t *irc_user_by_name( irc_t *irc, const char *nick );
[57c96f7]232int irc_user_set_nick( irc_user_t *iu, const char *new );
[ebaebfe]233gint irc_user_cmp( gconstpointer a_, gconstpointer b_ );
[003a12b]234const char *irc_user_get_away( irc_user_t *iu );
[b7d3cc34]235
[21c87a7]236/* irc_util.c */
237char *set_eval_timezone( struct set *set, char *value );
238char *irc_format_timestamp( irc_t *irc, time_t msg_ts );
[b7d3cc34]239
240#endif
Note: See TracBrowser for help on using the repository browser.