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  *  $Id: channel.h 3580 2007-11-07 23:45:14Z jilles $
  25  */
  26
  27 #ifndef INCLUDED_channel_h
  28 #define INCLUDED_channel_h
  29
  30 #define MODEBUFLEN      200
  31
  32 /* Maximum mode changes allowed per client, per server is different */
  33 #define MAXMODEPARAMS   4
  34 #define MAXMODEPARAMSSERV 10
  35
  36 struct Client;
  37
  38 /* mode structure for channels */
  39 struct Mode
  40 {
  41         unsigned int mode;
  42         int limit;
  43         char key[KEYLEN];
  44         unsigned int join_num;
  45         unsigned int join_time;
  46         char forward[LOC_CHANNELLEN + 1];
  47 };
  48
  49 /* channel structure */
  50 struct Channel
  51 {
  52         rb_dlink_node node;
  53         struct Mode mode;
  54         char *topic;
  55         char *topic_info;
  56         time_t topic_time;
  57         time_t last_knock;      /* don't allow knock to flood */
  58
  59         rb_dlink_list members;  /* channel members */
  60         rb_dlink_list locmembers;       /* local channel members */
  61
  62         rb_dlink_list invites;
  63         rb_dlink_list banlist;
  64         rb_dlink_list exceptlist;
  65         rb_dlink_list invexlist;
  66         rb_dlink_list quietlist;
  67
  68         time_t first_received_message_time;     /* channel flood control */
  69         int received_number_of_privmsgs;
  70         int flood_noticed;
  71
  72         unsigned int join_count;  /* joins within delta */
  73         unsigned int join_delta;  /* last ts of join */
  74
  75         struct Dictionary *metadata;
  76
  77         unsigned long bants;
  78         time_t channelts;
  79         char *chname;
  80 };
  81
  82 struct membership
  83 {
  84         rb_dlink_node channode;
  85         rb_dlink_node locchannode;
  86         rb_dlink_node usernode;
  87
  88         struct Channel *chptr;
  89         struct Client *client_p;
  90         unsigned int flags;
  91
  92         unsigned long bants;
  93 };
  94
  95 #define BANLEN 195
  96 struct Ban
  97 {
  98         char *banstr;
  99         char *who;
 100         time_t when;
 101         rb_dlink_node node;
 102 };
 103
 104 struct mode_letter
 105 {
 106         int mode;
 107         char letter;
 108 };
 109
 110 struct ChModeChange
 111 {
 112         char letter;
 113         const char *arg;
 114         const char *id;
 115         int dir;
 116         int caps;
 117         int nocaps;
 118         int mems;
 119         int override;
 120         struct Client *client;
 121 };
 122
 123 struct ChCapCombo
 124 {
 125         int count;
 126         int cap_yes;
 127         int cap_no;
 128 };
 129
 130 typedef void (*ChannelModeFunc)(struct Client *source_p, struct Channel *chptr,
 131                 int alevel, int parc, int *parn,
 132                 const char **parv, int *errors, int dir, char c, long mode_type);
 133
 134 struct ChannelMode
 135 {
 136         ChannelModeFunc set_func;
 137         long mode_type;
 138 };
 139
 140 typedef int (*ExtbanFunc)(const char *data, struct Client *client_p,
 141                 struct Channel *chptr, long mode_type);
 142
 143 /* can_send results */
 144 #define CAN_SEND_NO     0
 145 #define CAN_SEND_NONOP  1
 146 #define CAN_SEND_OPV    2
 147
 148 /* channel status flags */
 149 #define CHFL_PEON               0x0000  /* normal member of channel */
 150 #define CHFL_CHANOP             0x0001  /* Channel operator */
 151 #define CHFL_VOICE              0x0002  /* the power to speak */
 152 #define CHFL_BANNED             0x0008  /* cached as banned */
 153 #define CHFL_QUIETED            0x0010  /* cached as being +q victim */
 154 #define ONLY_SERVERS            0x0020
 155 #define CHFL_HALFOP             0x0040
 156 #define CHFL_ADMIN              0x0080
 157 #define ONLY_OPERS              0x0100
 158 #define ALL_MEMBERS             CHFL_PEON
 159 #define ONLY_CHANOPS            (CHFL_ADMIN|CHFL_CHANOP|CHFL_HALFOP)
 160 #define ONLY_CHANOPSVOICED      (CHFL_ADMIN|CHFL_CHANOP|CHFL_HALFOP|CHFL_VOICE)
 161
 162 #define is_chmode_h(x)  ((x) && (x)->flags & CHFL_HALFOP) /* does not check if halfop is enabled, should typically not be used */
 163 #define is_chmode_a(x)  ((x) && (x)->flags & CHFL_ADMIN) /* does not check if admin is enabled, should typically not be used */
 164 #define is_chanop(x)    ((x) && (x)->flags & CHFL_CHANOP)
 165 #define is_voiced(x)    ((x) && (x)->flags & CHFL_VOICE)
 166 #define can_send_banned(x) ((x) && (x)->flags & (CHFL_BANNED|CHFL_QUIETED))
 167
 168 /* channel modes ONLY */
 169 #define MODE_PRIVATE    0x0001
 170 #define MODE_SECRET     0x0002
 171 #define MODE_MODERATED  0x0004
 172 #define MODE_TOPICLIMIT 0x0008
 173 #define MODE_INVITEONLY 0x0010
 174 #define MODE_NOPRIVMSGS 0x0020
 175 #define MODE_REGONLY    0x0040
 176 #define MODE_NOCOLOR    0x0080
 177 #define MODE_EXLIMIT    0x0100  /* exempt from list limits, +b/+e/+I/+q */
 178 #define MODE_PERMANENT  0x0200  /* permanant channel, +P */
 179 #define MODE_OPMODERATE 0x0400  /* send rejected messages to ops */
 180 #define MODE_FREEINVITE 0x0800  /* allow free use of /invite */
 181 #define MODE_FREETARGET 0x1000  /* can be forwarded to without authorization */
 182 #define MODE_DISFORWARD 0x2000  /* disable channel forwarding */
 183 #define MODE_NOCTCP     0x8000  /* Block CTCPs directed to this channel */
 184 #define MODE_NONOTICE   0x10000 /* Block notices directed to this channel */
 185 #define MODE_NOACTION   0x20000 /* Block CTCP ACTION directed to this channel */
 186 #define MODE_NOKICK     0x40000 /* Disable /kick on this channel */
 187 #define MODE_NONICK     0x80000 /* Disable /nick for anyone on this channel */
 188 #define MODE_NOCAPS     0x100000 /* Block messages in all capital letters */
 189 #define MODE_NOREPEAT   0x200000 /* Block repeat messages */
 190 #define MODE_NOOPERKICK 0x400000 /* disallow kicking opers */
 191
 192 #define CHFL_BAN        0x10000000      /* ban channel flag */
 193 #define CHFL_EXCEPTION  0x20000000      /* exception to ban channel flag */
 194 #define CHFL_INVEX      0x40000000
 195 #define CHFL_QUIET      0x80000000
 196
 197 /* mode flags for direction indication */
 198 #define MODE_QUERY     0
 199 #define MODE_ADD       1
 200 #define MODE_DEL       -1
 201
 202 #define SecretChannel(x)        ((x) && ((x)->mode.mode & MODE_SECRET))
 203 #define HiddenChannel(x)        ((x) && ((x)->mode.mode & MODE_PRIVATE))
 204 #define PubChannel(x)           ((!x) || ((x)->mode.mode &\
 205                                  (MODE_PRIVATE | MODE_SECRET)) == 0)
 206
 207 /* channel visible */
 208 #define ShowChannel(v,c)        (PubChannel(c) || IsMember((v),(c)))
 209
 210 #define IsMember(who, chan) ((who && who->user && \
 211                 find_channel_membership(chan, who)) ? 1 : 0)
 212
 213 #define IsChannelName(name) ((name) && (*(name) == '#' || *(name) == '&'))
 214
 215 /* extban function results */
 216 #define EXTBAN_INVALID -1  /* invalid mask, false even if negated */
 217 #define EXTBAN_NOMATCH  0  /* valid mask, no match */
 218 #define EXTBAN_MATCH    1  /* matches */
 219
 220 extern rb_dlink_list global_channel_list;
 221 void init_channels(void);
 222
 223 struct Channel *allocate_channel(const char *chname);
 224 void free_channel(struct Channel *chptr);
 225 struct Ban *allocate_ban(const char *, const char *);
 226 void free_ban(struct Ban *bptr);
 227
 228
 229 extern void destroy_channel(struct Channel *);
 230
 231 extern int can_send(struct Channel *chptr, struct Client *who,
 232                     struct membership *);
 233 extern int is_banned(struct Channel *chptr, struct Client *who,
 234                      struct membership *msptr, const char *, const char *);
 235 extern int is_quieted(struct Channel *chptr, struct Client *who,
 236                      struct membership *msptr, const char *, const char *);
 237 extern int can_join(struct Client *source_p, struct Channel *chptr, char *key);
 238
 239 extern struct membership *find_channel_membership(struct Channel *, struct Client *);
 240 extern const char *find_channel_status(struct membership *msptr, int combine);
 241 extern int is_halfop(struct membership *msptr);
 242 extern int is_admin(struct membership *msptr);
 243 extern int is_any_op(struct membership *msptr);
 244 extern int is_chanop_voiced(struct membership *msptr);
 245 extern int can_kick_deop(struct membership *source, struct membership *target);
 246 extern void add_user_to_channel(struct Channel *, struct Client *, int flags);
 247 extern void remove_user_from_channel(struct membership *);
 248 extern void remove_user_from_channels(struct Client *);
 249 extern void invalidate_bancache_user(struct Client *);
 250
 251 extern void free_channel_list(rb_dlink_list *);
 252
 253 extern int check_channel_name(const char *name);
 254
 255 extern void channel_member_names(struct Channel *chptr, struct Client *,
 256                                  int show_eon);
 257
 258 extern void del_invite(struct Channel *chptr, struct Client *who);
 259
 260 const char *channel_modes(struct Channel *chptr, struct Client *who);
 261
 262 extern int has_common_channel(struct Client *client1, struct Client *client2);
 263
 264 extern struct Channel *find_bannickchange_channel(struct Client *client_p);
 265
 266 extern struct Channel *find_nonickchange_channel(struct Client *client_p);
 267
 268 extern void check_spambot_warning(struct Client *source_p, const char *name);
 269
 270 extern void check_splitmode(void *);
 271
 272 void set_channel_topic(struct Channel *chptr, const char *topic,
 273                        const char *topic_info, time_t topicts);
 274
 275 extern void init_chcap_usage_counts(void);
 276 extern void set_chcap_usage_counts(struct Client *serv_p);
 277 extern void unset_chcap_usage_counts(struct Client *serv_p);
 278 extern void send_cap_mode_changes(struct Client *client_p, struct Client *source_p,
 279                                   struct Channel *chptr, struct ChModeChange foo[], int);
 280
 281 void resv_chan_forcepart(const char *name, const char *reason, int temp_time);
 282
 283 extern void set_channel_mode(struct Client *client_p, struct Client *source_p,
 284                 struct Channel *chptr, struct membership *msptr, int parc, const char *parv[]);
 285
 286 extern struct ChannelMode chmode_table[256];
 287
 288 extern int add_id(struct Client *source_p, struct Channel *chptr, const char *banid,
 289        rb_dlink_list * list, long mode_type);
 290
 291 extern int del_id(struct Channel *chptr, const char *banid, rb_dlink_list * list, long mode_type);
 292
 293 extern ExtbanFunc extban_table[256];
 294
 295 extern int match_extban(const char *banstr, struct Client *client_p, struct Channel *chptr, long mode_type);
 296 extern int valid_extban(const char *banstr, struct Client *client_p, struct Channel *chptr, long mode_type);
 297 const char * get_extban_string(void);
 298
 299 extern struct Channel * check_forward(struct Client *source_p, struct Channel *chptr, char *key);
 300 extern void user_join(struct Client * client_p, struct Client * source_p, const char * channels, const char * keys);
 301 extern void do_join_0(struct Client *client_p, struct Client *source_p);
 302 extern int check_channel_name_loc(struct Client *source_p, const char *name);
 303
 304 extern struct Metadata *channel_metadata_add(struct Channel *target, const char *name, const char *value, int propegate);
 305 extern struct Metadata *channel_metadata_time_add(struct Channel *target, const char *name, time_t timevalue, const char *value);
 306 extern void channel_metadata_delete(struct Channel *target, const char *name, int propegate);
 307 extern struct Metadata *channel_metadata_find(struct Channel *target, const char *name);
 308 extern void channel_metadata_clear(struct Channel *target);
 309
 310
 311 #endif /* INCLUDED_channel_h */