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 2727 2006-11-09 23:48:45Z jilles $
  25  */
  26
  27 #ifndef INCLUDED_channel_h
  28 #define INCLUDED_channel_h
  29 #include "config.h"             /* config settings */
  30 #include "ircd_defs.h"          /* buffer sizes */
  31
  32 #define MODEBUFLEN      200
  33
  34 /* Maximum mode changes allowed per client, per server is different */
  35 #define MAXMODEPARAMS   4
  36 #define MAXMODEPARAMSSERV 10
  37
  38 struct Client;
  39
  40 /* mode structure for channels */
  41 struct Mode
  42 {
  43         unsigned int mode;
  44         int limit;
  45         char key[KEYLEN];
  46         unsigned int join_num;
  47         unsigned int join_time;
  48         char forward[LOC_CHANNELLEN + 1];
  49 };
  50
  51 /* channel structure */
  52 struct Channel
  53 {
  54         dlink_node node;
  55         struct Mode mode;
  56         char *topic;
  57         char *topic_info;
  58         time_t topic_time;
  59         time_t users_last;      /* when last user was in channel */
  60         time_t last_knock;      /* don't allow knock to flood */
  61
  62         dlink_list members;     /* channel members */
  63         dlink_list locmembers;  /* local channel members */
  64
  65         dlink_list invites;
  66         dlink_list banlist;
  67         dlink_list exceptlist;
  68         dlink_list invexlist;
  69         dlink_list quietlist;
  70
  71         time_t first_received_message_time;     /* channel flood control */
  72         int received_number_of_privmsgs;
  73         int flood_noticed;
  74
  75         unsigned int join_count;  /* joins within delta */
  76         unsigned int join_delta;  /* last ts of join */
  77
  78         unsigned long bants;
  79         time_t channelts;
  80         char *chname;
  81 };
  82
  83 struct membership
  84 {
  85         dlink_node channode;
  86         dlink_node locchannode;
  87         dlink_node usernode;
  88
  89         struct Channel *chptr;
  90         struct Client *client_p;
  91         unsigned int flags;
  92
  93         unsigned long bants;
  94 };
  95
  96 #define BANLEN NICKLEN+USERLEN+HOSTLEN+6
  97 struct Ban
  98 {
  99         char *banstr;
 100         char *who;
 101         time_t when;
 102         dlink_node node;
 103 };
 104
 105 struct ChModeChange
 106 {
 107         char letter;
 108         const char *arg;
 109         const char *id;
 110         int dir;
 111         int caps;
 112         int nocaps;
 113         int mems;
 114         struct Client *client;
 115 };
 116
 117 struct ChCapCombo
 118 {
 119         int count;
 120         int cap_yes;
 121         int cap_no;
 122 };
 123
 124 struct ChannelMode
 125 {
 126         void (*set_func) (struct Client * source_p, struct Channel * chptr,
 127                       int alevel, int parc, int *parn,
 128                       const char **parv, int *errors, int dir, char c, long mode_type);
 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_CHANOP             0x0001  /* Channel operator */
 143 #define CHFL_VOICE              0x0002  /* the power to speak */
 144 #define CHFL_DEOPPED            0x0004  /* deopped on sjoin, bounce modes */
 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 ALL_MEMBERS             CHFL_PEON
 149 #define ONLY_CHANOPS            CHFL_CHANOP
 150 #define ONLY_CHANOPSVOICED      (CHFL_CHANOP|CHFL_VOICE)
 151
 152 #define is_chanop(x)    ((x) && (x)->flags & CHFL_CHANOP)
 153 #define is_voiced(x)    ((x) && (x)->flags & CHFL_VOICE)
 154 #define is_chanop_voiced(x) ((x) && (x)->flags & (CHFL_CHANOP|CHFL_VOICE))
 155 #define is_deop(x)      ((x) && (x)->flags & CHFL_DEOPPED)
 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_NOCOLOR    0x0080
 167 #define MODE_EXLIMIT    0x0100  /* exempt from list limits, +b/+e/+I/+q */
 168 #define MODE_PERMANENT  0x0200  /* permanant channel, +P */
 169 #define MODE_OPMODERATE 0x0400  /* send rejected messages to ops */
 170 #define MODE_FREEINVITE 0x0800  /* allow free use of /invite */
 171 #define MODE_FREETARGET 0x1000  /* can be forwarded to without authorization */
 172 #define MODE_DISFORWARD 0x2000  /* disable channel forwarding */
 173
 174 #define CHFL_BAN        0x10000000      /* ban channel flag */
 175 #define CHFL_EXCEPTION  0x20000000      /* exception to ban channel flag */
 176 #define CHFL_INVEX      0x40000000
 177 #define CHFL_QUIET      0x80000000
 178
 179 /* mode flags for direction indication */
 180 #define MODE_QUERY     0
 181 #define MODE_ADD       1
 182 #define MODE_DEL       -1
 183
 184 #define SecretChannel(x)        ((x) && ((x)->mode.mode & MODE_SECRET))
 185 #define HiddenChannel(x)        ((x) && ((x)->mode.mode & MODE_PRIVATE))
 186 #define PubChannel(x)           ((!x) || ((x)->mode.mode &\
 187                                  (MODE_PRIVATE | MODE_SECRET)) == 0)
 188
 189 /* channel visible */
 190 #define ShowChannel(v,c)        (PubChannel(c) || IsMember((v),(c)))
 191
 192 #define IsMember(who, chan) ((who && who->user && \
 193                 find_channel_membership(chan, who)) ? 1 : 0)
 194
 195 #define IsChannelName(name) ((name) && (*(name) == '#' || *(name) == '&'))
 196
 197 /* extban function results */
 198 #define EXTBAN_INVALID -1  /* invalid mask, false even if negated */
 199 #define EXTBAN_NOMATCH  0  /* valid mask, no match */
 200 #define EXTBAN_MATCH    1  /* matches */
 201
 202 extern dlink_list global_channel_list;
 203 void init_channels(void);
 204
 205 struct Channel *allocate_channel(const char *chname);
 206 void free_channel(struct Channel *chptr);
 207 struct Ban *allocate_ban(const char *, const char *);
 208 void free_ban(struct Ban *bptr);
 209
 210
 211 extern void destroy_channel(struct Channel *);
 212
 213 extern int can_send(struct Channel *chptr, struct Client *who,
 214                     struct membership *);
 215 extern int is_banned(struct Channel *chptr, struct Client *who,
 216                      struct membership *msptr, const char *, const char *);
 217 extern int is_quieted(struct Channel *chptr, struct Client *who,
 218                      struct membership *msptr, const char *, const char *);
 219 extern int can_join(struct Client *source_p, struct Channel *chptr, char *key);
 220
 221 extern struct membership *find_channel_membership(struct Channel *, struct Client *);
 222 extern const char *find_channel_status(struct membership *msptr, int combine);
 223 extern void add_user_to_channel(struct Channel *, struct Client *, int flags);
 224 extern void remove_user_from_channel(struct membership *);
 225 extern void remove_user_from_channels(struct Client *);
 226 extern void invalidate_bancache_user(struct Client *);
 227
 228 extern void free_channel_list(dlink_list *);
 229
 230 extern int check_channel_name(const char *name);
 231
 232 extern void channel_member_names(struct Channel *chptr, struct Client *,
 233                                  int show_eon);
 234
 235 extern void del_invite(struct Channel *chptr, struct Client *who);
 236
 237 const char *channel_modes(struct Channel *chptr, struct Client *who);
 238
 239 extern struct Channel *find_bannickchange_channel(struct Client *client_p);
 240
 241 extern void check_spambot_warning(struct Client *source_p, const char *name);
 242
 243 extern void check_splitmode(void *);
 244
 245 void set_channel_topic(struct Channel *chptr, const char *topic,
 246                        const char *topic_info, time_t topicts);
 247
 248 extern void init_chcap_usage_counts(void);
 249 extern void set_chcap_usage_counts(struct Client *serv_p);
 250 extern void unset_chcap_usage_counts(struct Client *serv_p);
 251 extern void send_cap_mode_changes(struct Client *client_p, struct Client *source_p,
 252                                   struct Channel *chptr, struct ChModeChange foo[], int);
 253
 254 extern void set_channel_mode(struct Client *client_p, struct Client *source_p,
 255                 struct Channel *chptr, struct membership *msptr, int parc, const char *parv[]);
 256
 257 extern struct ChannelMode chmode_table[256];
 258
 259 extern int add_id(struct Client *source_p, struct Channel *chptr, const char *banid,
 260        dlink_list * list, long mode_type);
 261
 262 extern int del_id(struct Channel *chptr, const char *banid, dlink_list * list, long mode_type);
 263
 264 extern ExtbanFunc extban_table[256];
 265
 266 extern int match_extban(const char *banstr, struct Client *client_p, struct Channel *chptr, long mode_type);
 267 extern int valid_extban(const char *banstr, struct Client *client_p, struct Channel *chptr, long mode_type);
 268 const char * get_extban_string(void);
 269
 270
 271 #endif /* INCLUDED_channel_h */