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 *mode_lock;
  55         char *topic;
  56         char *topic_info;
  57         time_t topic_time;
  58         time_t last_knock;      /* don't allow knock to flood */
  59
  60         rb_dlink_list members;  /* channel members */
  61         rb_dlink_list locmembers;       /* local channel members */
  62
  63         rb_dlink_list invites;
  64         rb_dlink_list banlist;
  65         rb_dlink_list exceptlist;
  66         rb_dlink_list invexlist;
  67         rb_dlink_list quietlist;
  68
  69         time_t first_received_message_time;     /* channel flood control */
  70         int received_number_of_privmsgs;
  71         int flood_noticed;
  72
  73         unsigned int join_count;  /* joins within delta */
  74         unsigned int join_delta;  /* last ts of join */
  75
  76         unsigned long bants;
  77         time_t channelts;
  78         char *chname;
  79 };
  80
  81 struct membership
  82 {
  83         rb_dlink_node channode;
  84         rb_dlink_node locchannode;
  85         rb_dlink_node usernode;
  86
  87         struct Channel *chptr;
  88         struct Client *client_p;
  89         unsigned int flags;
  90
  91         unsigned long bants;
  92 };
  93
  94 #define BANLEN 195
  95 struct Ban
  96 {
  97         char *banstr;
  98         char *who;
  99         time_t when;
 100         char *forward;
 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         struct Client *client;
 120 };
 121
 122 struct ChCapCombo
 123 {
 124         int count;
 125         int cap_yes;
 126         int cap_no;
 127 };
 128
 129 typedef void (*ChannelModeFunc)(struct Client *source_p, struct Channel *chptr,
 130                 int alevel, int parc, int *parn,
 131                 const char **parv, int *errors, int dir, char c, long mode_type);
 132
 133 struct ChannelMode
 134 {
 135         ChannelModeFunc set_func;
 136         long mode_type;
 137 };
 138
 139 typedef int (*ExtbanFunc)(const char *data, struct Client *client_p,
 140                 struct Channel *chptr, long mode_type);
 141
 142 /* can_send results */
 143 #define CAN_SEND_NO     0
 144 #define CAN_SEND_NONOP  1
 145 #define CAN_SEND_OPV    2
 146
 147 /* channel status flags */
 148 #define CHFL_PEON               0x0000  /* normal member of channel */
 149 #define CHFL_VOICE              0x0001  /* the power to speak */
 150 #define CHFL_CHANOP             0x0002  /* Channel operator */
 151
 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 ALL_MEMBERS             CHFL_PEON
 156 #define ONLY_CHANOPS            CHFL_CHANOP
 157 #define ONLY_CHANOPSVOICED      (CHFL_CHANOP|CHFL_VOICE)
 158
 159 #define is_chanop(x)    ((x) && (x)->flags & CHFL_CHANOP)
 160 #define is_voiced(x)    ((x) && (x)->flags & CHFL_VOICE)
 161 #define is_chanop_voiced(x) ((x) && (x)->flags & (CHFL_CHANOP|CHFL_VOICE))
 162 #define can_send_banned(x) ((x) && (x)->flags & (CHFL_BANNED|CHFL_QUIETED))
 163
 164 /* channel modes ONLY */
 165 #define MODE_PRIVATE    0x0001
 166 #define MODE_SECRET     0x0002
 167 #define MODE_MODERATED  0x0004
 168 #define MODE_TOPICLIMIT 0x0008
 169 #define MODE_INVITEONLY 0x0010
 170 #define MODE_NOPRIVMSGS 0x0020
 171 #define MODE_REGONLY    0x0040
 172 #define MODE_EXLIMIT    0x0100  /* exempt from list limits, +b/+e/+I/+q */
 173 #define MODE_PERMANENT  0x0200  /* permanant channel, +P */
 174 #define MODE_OPMODERATE 0x0400  /* send rejected messages to ops */
 175 #define MODE_FREEINVITE 0x0800  /* allow free use of /invite */
 176 #define MODE_FREETARGET 0x1000  /* can be forwarded to without authorization */
 177 #define MODE_DISFORWARD 0x2000  /* disable channel forwarding */
 178
 179 #define CHFL_BAN        0x10000000      /* ban channel flag */
 180 #define CHFL_EXCEPTION  0x20000000      /* exception to ban channel flag */
 181 #define CHFL_INVEX      0x40000000
 182 #define CHFL_QUIET      0x80000000
 183
 184 /* mode flags for direction indication */
 185 #define MODE_QUERY     0
 186 #define MODE_ADD       1
 187 #define MODE_DEL       -1
 188
 189 #define SecretChannel(x)        ((x) && ((x)->mode.mode & MODE_SECRET))
 190 #define HiddenChannel(x)        ((x) && ((x)->mode.mode & MODE_PRIVATE))
 191 #define PubChannel(x)           ((!x) || ((x)->mode.mode &\
 192                                  (MODE_PRIVATE | MODE_SECRET)) == 0)
 193
 194 /* channel visible */
 195 #define ShowChannel(v,c)        (PubChannel(c) || IsMember((v),(c)))
 196
 197 #define IsMember(who, chan) ((who && who->user && \
 198                 find_channel_membership(chan, who)) ? 1 : 0)
 199
 200 #define IsChannelName(name) ((name) && (*(name) == '#' || *(name) == '&'))
 201
 202 /* extban function results */
 203 #define EXTBAN_INVALID -1  /* invalid mask, false even if negated */
 204 #define EXTBAN_NOMATCH  0  /* valid mask, no match */
 205 #define EXTBAN_MATCH    1  /* matches */
 206
 207 extern rb_dlink_list global_channel_list;
 208 void init_channels(void);
 209
 210 struct Channel *allocate_channel(const char *chname);
 211 void free_channel(struct Channel *chptr);
 212 struct Ban *allocate_ban(const char *, const char *, const char *);
 213 void free_ban(struct Ban *bptr);
 214
 215
 216 extern void destroy_channel(struct Channel *);
 217
 218 extern int can_send(struct Channel *chptr, struct Client *who,
 219                     struct membership *);
 220 extern int flood_attack_channel(int p_or_n, struct Client *source_p,
 221                                 struct Channel *chptr, char *chname);
 222 extern int is_banned(struct Channel *chptr, struct Client *who,
 223                     struct membership *msptr, const char *, const char *, const char **);
 224 extern int is_quieted(struct Channel *chptr, struct Client *who,
 225                      struct membership *msptr, const char *, const char *);
 226 extern int can_join(struct Client *source_p, struct Channel *chptr,
 227                     const char *key, const char **forward);
 228
 229 extern struct membership *find_channel_membership(struct Channel *, struct Client *);
 230 extern const char *find_channel_status(struct membership *msptr, int combine);
 231 extern void add_user_to_channel(struct Channel *, struct Client *, int flags);
 232 extern void remove_user_from_channel(struct membership *);
 233 extern void remove_user_from_channels(struct Client *);
 234 extern void invalidate_bancache_user(struct Client *);
 235
 236 extern void free_channel_list(rb_dlink_list *);
 237
 238 extern int check_channel_name(const char *name);
 239
 240 extern void channel_member_names(struct Channel *chptr, struct Client *,
 241                                  int show_eon);
 242
 243 extern void del_invite(struct Channel *chptr, struct Client *who);
 244
 245 const char *channel_modes(struct Channel *chptr, struct Client *who);
 246
 247 extern struct Channel *find_bannickchange_channel(struct Client *client_p);
 248
 249 extern void check_spambot_warning(struct Client *source_p, const char *name);
 250
 251 extern void check_splitmode(void *);
 252
 253 void set_channel_topic(struct Channel *chptr, const char *topic,
 254                        const char *topic_info, time_t topicts);
 255
 256 extern void init_chcap_usage_counts(void);
 257 extern void set_chcap_usage_counts(struct Client *serv_p);
 258 extern void unset_chcap_usage_counts(struct Client *serv_p);
 259 extern void send_cap_mode_changes(struct Client *client_p, struct Client *source_p,
 260                                   struct Channel *chptr, struct ChModeChange foo[], int);
 261
 262 void resv_chan_forcepart(const char *name, const char *reason, int temp_time);
 263
 264 extern void set_channel_mode(struct Client *client_p, struct Client *source_p,
 265                 struct Channel *chptr, struct membership *msptr, int parc, const char *parv[]);
 266 extern void set_channel_mlock(struct Client *client_p, struct Client *source_p,
 267                 struct Channel *chptr, const char *newmlock, int propagate);
 268
 269 extern struct ChannelMode chmode_table[256];
 270
 271 extern int add_id(struct Client *source_p, struct Channel *chptr, const char *banid,
 272         const char *forward, rb_dlink_list * list, long mode_type);
 273
 274 extern struct Ban * del_id(struct Channel *chptr, const char *banid, rb_dlink_list * list,
 275         long mode_type);
 276
 277 extern ExtbanFunc extban_table[256];
 278
 279 extern int match_extban(const char *banstr, struct Client *client_p, struct Channel *chptr, long mode_type);
 280 extern int valid_extban(const char *banstr, struct Client *client_p, struct Channel *chptr, long mode_type);
 281 const char * get_extban_string(void);
 282
 283 extern int get_channel_access(struct Client *source_p, struct membership *msptr);
 284
 285 extern void send_channel_join(struct Channel *chptr, struct Client *client_p);
 286
 287 #endif /* INCLUDED_channel_h */