include/channel.h

   1 /*
   2  *  ircd-ratbox: A slightly useful ircd.
   3  *  channel.h: The ircd channel header.
   4  *
   5  *  Copyright (C) 1990 Jarkko Oikarinen and University of Oulu, Co Center
   6  *  Copyright (C) 1996-2002 Hybrid Development Team
   7  *  Copyright (C) 2002-2004 ircd-ratbox development team
   8  *
   9  *  This program is free software; you can redistribute it and/or modify
  10  *  it under the terms of the GNU General Public License as published by
  11  *  the Free Software Foundation; either version 2 of the License, or
  12  *  (at your option) any later version.
  13  *
  14  *  This program is distributed in the hope that it will be useful,
  15  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  *  GNU General Public License for more details.
  18  *
  19  *  You should have received a copy of the GNU General Public License
  20  *  along with this program; if not, write to the Free Software
  21  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
  22  *  USA
  23  */
  24
  25 #ifndef INCLUDED_channel_h
  26 #define INCLUDED_channel_h
  27
  28 #define MODEBUFLEN      200
  29
  30 /* Maximum mode changes allowed per client, per server is different */
  31 #define MAXMODEPARAMS   4
  32 #define MAXMODEPARAMSSERV 10
  33
  34 struct Client;
  35
  36 /* mode structure for channels */
  37 struct Mode
  38 {
  39         unsigned int mode;
  40         int limit;
  41         char key[KEYLEN];
  42         unsigned int join_num;
  43         unsigned int join_time;
  44         char forward[LOC_CHANNELLEN + 1];
  45 };
  46
  47 /* channel structure */
  48 struct Channel
  49 {
  50         rb_dlink_node node;
  51         struct Mode mode;
  52         char *mode_lock;
  53         char *topic;
  54         char *topic_info;
  55         time_t topic_time;
  56         time_t last_knock;      /* don't allow knock to flood */
  57
  58         rb_dlink_list members;  /* channel members */
  59         rb_dlink_list locmembers;       /* local channel members */
  60
  61         rb_dlink_list invites;
  62         rb_dlink_list banlist;
  63         rb_dlink_list exceptlist;
  64         rb_dlink_list invexlist;
  65         rb_dlink_list quietlist;
  66
  67         time_t first_received_message_time;     /* channel flood control */
  68         int received_number_of_privmsgs;
  69         int flood_noticed;
  70
  71         unsigned int join_count;  /* joins within delta */
  72         unsigned int join_delta;  /* last ts of join */
  73
  74         unsigned long bants;
  75         time_t channelts;
  76         char *chname;
  77
  78         struct Client *last_checked_client;
  79         time_t last_checked_ts;
  80         unsigned int last_checked_type;
  81         int last_checked_result;
  82 };
  83
  84 struct membership
  85 {
  86         rb_dlink_node channode;
  87         rb_dlink_node locchannode;
  88         rb_dlink_node usernode;
  89
  90         struct Channel *chptr;
  91         struct Client *client_p;
  92         unsigned int flags;
  93
  94         unsigned long bants;
  95 };
  96
  97 #define BANLEN 195
  98 struct Ban
  99 {
 100         char *banstr;
 101         char *who;
 102         time_t when;
 103         char *forward;
 104         rb_dlink_node node;
 105 };
 106
 107 struct mode_letter
 108 {
 109         int mode;
 110         char letter;
 111 };
 112
 113 struct ChModeChange
 114 {
 115         char letter;
 116         const char *arg;
 117         const char *id;
 118         int dir;
 119         int mems;
 120 };
 121
 122 typedef void (*ChannelModeFunc)(struct Client *source_p, struct Channel *chptr,
 123                 int alevel, int parc, int *parn,
 124                 const char **parv, int *errors, int dir, char c, long mode_type);
 125
 126 struct ChannelMode
 127 {
 128         ChannelModeFunc set_func;
 129         long mode_type;
 130 };
 131
 132 typedef int (*ExtbanFunc)(const char *data, struct Client *client_p,
 133                 struct Channel *chptr, long mode_type);
 134
 135 /* can_send results */
 136 #define CAN_SEND_NO     0
 137 #define CAN_SEND_NONOP  1
 138 #define CAN_SEND_OPV    2
 139
 140 /* channel status flags */
 141 #define CHFL_PEON               0x0000  /* normal member of channel */
 142 #define CHFL_VOICE              0x0001  /* the power to speak */
 143 #define CHFL_CHANOP             0x0002  /* Channel operator */
 144
 145 #define CHFL_BANNED             0x0008  /* cached as banned */
 146 #define CHFL_QUIETED            0x0010  /* cached as being +q victim */
 147 #define ONLY_SERVERS            0x0020
 148 #define ONLY_OPERS              0x0040
 149 #define ALL_MEMBERS             CHFL_PEON
 150 #define ONLY_CHANOPS            CHFL_CHANOP
 151 #define ONLY_CHANOPSVOICED      (CHFL_CHANOP|CHFL_VOICE)
 152
 153 #define is_chanop(x)    ((x) && (x)->flags & CHFL_CHANOP)
 154 #define is_voiced(x)    ((x) && (x)->flags & CHFL_VOICE)
 155 #define is_chanop_voiced(x) ((x) && (x)->flags & (CHFL_CHANOP|CHFL_VOICE))
 156 #define can_send_banned(x) ((x) && (x)->flags & (CHFL_BANNED|CHFL_QUIETED))
 157
 158 /* channel modes ONLY */
 159 #define MODE_PRIVATE    0x0001
 160 #define MODE_SECRET     0x0002
 161 #define MODE_MODERATED  0x0004
 162 #define MODE_TOPICLIMIT 0x0008
 163 #define MODE_INVITEONLY 0x0010
 164 #define MODE_NOPRIVMSGS 0x0020
 165 #define MODE_REGONLY    0x0040
 166 #define MODE_EXLIMIT    0x0100  /* exempt from list limits, +b/+e/+I/+q */
 167 #define MODE_PERMANENT  0x0200  /* permanant channel, +P */
 168 #define MODE_OPMODERATE 0x0400  /* send rejected messages to ops */
 169 #define MODE_FREEINVITE 0x0800  /* allow free use of /invite */
 170 #define MODE_FREETARGET 0x1000  /* can be forwarded to without authorization */
 171 #define MODE_DISFORWARD 0x2000  /* disable channel forwarding */
 172
 173 #define CHFL_BAN        0x10000000      /* ban channel flag */
 174 #define CHFL_EXCEPTION  0x20000000      /* exception to ban channel flag */
 175 #define CHFL_INVEX      0x40000000
 176 #define CHFL_QUIET      0x80000000
 177
 178 /* mode flags for direction indication */
 179 #define MODE_QUERY     0
 180 #define MODE_ADD       1
 181 #define MODE_DEL       -1
 182
 183 #define SecretChannel(x)        ((x) && ((x)->mode.mode & MODE_SECRET))
 184 #define HiddenChannel(x)        ((x) && ((x)->mode.mode & MODE_PRIVATE))
 185 #define PubChannel(x)           ((!x) || ((x)->mode.mode &\
 186                                  (MODE_PRIVATE | MODE_SECRET)) == 0)
 187
 188 /* channel visible */
 189 #define ShowChannel(v,c)        (PubChannel(c) || IsMember((v),(c)))
 190
 191 #define IsMember(who, chan) ((who && who->user && \
 192                 find_channel_membership(chan, who)) ? 1 : 0)
 193
 194 #define IsChannelName(name) ((name) && (*(name) == '#' || *(name) == '&'))
 195
 196 /* extban function results */
 197 #define EXTBAN_INVALID -1  /* invalid mask, false even if negated */
 198 #define EXTBAN_NOMATCH  0  /* valid mask, no match */
 199 #define EXTBAN_MATCH    1  /* matches */
 200
 201 extern rb_dlink_list global_channel_list;
 202 void init_channels(void);
 203
 204 struct Channel *allocate_channel(const char *chname);
 205 void free_channel(struct Channel *chptr);
 206 struct Ban *allocate_ban(const char *, const char *, const char *);
 207 void free_ban(struct Ban *bptr);
 208
 209
 210 extern void destroy_channel(struct Channel *);
 211
 212 extern int can_send(struct Channel *chptr, struct Client *who,
 213                     struct membership *);
 214 extern int flood_attack_channel(int p_or_n, struct Client *source_p,
 215                                 struct Channel *chptr, char *chname);
 216 extern int is_banned(struct Channel *chptr, struct Client *who,
 217                     struct membership *msptr, const char *, const char *, const char **);
 218 extern int is_quieted(struct Channel *chptr, struct Client *who,
 219                      struct membership *msptr, const char *, const char *);
 220 extern int can_join(struct Client *source_p, struct Channel *chptr,
 221                     const char *key, const char **forward);
 222
 223 extern struct membership *find_channel_membership(struct Channel *, struct Client *);
 224 extern const char *find_channel_status(struct membership *msptr, int combine);
 225 extern void add_user_to_channel(struct Channel *, struct Client *, int flags);
 226 extern void remove_user_from_channel(struct membership *);
 227 extern void remove_user_from_channels(struct Client *);
 228 extern void invalidate_bancache_user(struct Client *);
 229
 230 extern void free_channel_list(rb_dlink_list *);
 231
 232 extern int check_channel_name(const char *name);
 233
 234 extern void channel_member_names(struct Channel *chptr, struct Client *,
 235                                  int show_eon);
 236
 237 extern void del_invite(struct Channel *chptr, struct Client *who);
 238
 239 const char *channel_modes(struct Channel *chptr, struct Client *who);
 240
 241 extern struct Channel *find_bannickchange_channel(struct Client *client_p);
 242
 243 extern void check_spambot_warning(struct Client *source_p, const char *name);
 244
 245 extern void check_splitmode(void *);
 246
 247 void set_channel_topic(struct Channel *chptr, const char *topic,
 248                        const char *topic_info, time_t topicts);
 249
 250 extern void init_chcap_usage_counts(void);
 251 extern void set_chcap_usage_counts(struct Client *serv_p);
 252 extern void unset_chcap_usage_counts(struct Client *serv_p);
 253 extern void send_cap_mode_changes(struct Client *client_p, struct Client *source_p,
 254                                   struct Channel *chptr, struct ChModeChange foo[], int);
 255
 256 void resv_chan_forcepart(const char *name, const char *reason, int temp_time);
 257
 258 extern void set_channel_mode(struct Client *client_p, struct Client *source_p,
 259                 struct Channel *chptr, struct membership *msptr, int parc, const char *parv[]);
 260 extern void set_channel_mlock(struct Client *client_p, struct Client *source_p,
 261                 struct Channel *chptr, const char *newmlock, int propagate);
 262
 263 extern struct ChannelMode chmode_table[256];
 264
 265 extern int add_id(struct Client *source_p, struct Channel *chptr, const char *banid,
 266         const char *forward, rb_dlink_list * list, long mode_type);
 267
 268 extern struct Ban * del_id(struct Channel *chptr, const char *banid, rb_dlink_list * list,
 269         long mode_type);
 270
 271 extern ExtbanFunc extban_table[256];
 272
 273 extern int match_extban(const char *banstr, struct Client *client_p, struct Channel *chptr, long mode_type);
 274 extern int valid_extban(const char *banstr, struct Client *client_p, struct Channel *chptr, long mode_type);
 275 const char * get_extban_string(void);
 276
 277 extern int get_channel_access(struct Client *source_p, struct Channel *chptr, struct membership *msptr, int dir, const char *modestr);
 278
 279 extern void send_channel_join(struct Channel *chptr, struct Client *client_p);
 280
 281 #endif /* INCLUDED_channel_h */