include/channel.h

   1 /*
   2  * IRC - Internet Relay Chat, ircd/channel.h
   3  * Copyright (C) 1990 Jarkko Oikarinen
   4  * Copyright (C) 1996 - 1997 Carlo Wood
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2, or (at your option)
   9  * any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19  *
  20  * $Id$
  21  */
  22 #ifndef INCLUDED_channel_h
  23 #define INCLUDED_channel_h
  24 #ifndef INCLUDED_ircd_defs_h
  25 #include "ircd_defs.h"        /* NICKLEN */
  26 #endif
  27 #ifndef INCLUDED_sys_types_h
  28 #include <sys/types.h>
  29 #define INCLUDED_sys_types_h
  30 #endif
  31
  32 struct SLink;
  33 struct Client;
  34
  35 /*
  36  * General defines
  37  */
  38
  39 #define MAXMODEPARAMS   6
  40 #define MODEBUFLEN      200
  41
  42 #define KEYLEN          23
  43 #define CHANNELLEN      200
  44
  45 #define MAXJOINARGS     15 /* number of slots for join buffer */
  46 #define STARTJOINLEN    10 /* fuzzy numbers */
  47 #define STARTCREATELEN  20
  48
  49 /*
  50  * Macro's
  51  */
  52
  53 #define ChannelExists(n)        (0 != FindChannel(n))
  54
  55 #define CHFL_CHANOP             0x0001  /* Channel operator */
  56 #define CHFL_VOICE              0x0002  /* the power to speak */
  57 #define CHFL_DEOPPED            0x0004  /* Is de-opped by a server */
  58 #define CHFL_SERVOPOK           0x0008  /* Server op allowed */
  59 #define CHFL_ZOMBIE             0x0010  /* Kicked from channel */
  60 #define CHFL_BAN                0x0020  /* ban channel flag */
  61 #define CHFL_BAN_IPMASK         0x0040  /* ban mask is an IP-number mask */
  62 #define CHFL_BAN_OVERLAPPED     0x0080  /* ban overlapped, need bounce */
  63 #define CHFL_BURST_JOINED       0x0100  /* Just joined by net.junction */
  64 #define CHFL_BURST_BAN          0x0200  /* Ban part of last BURST */
  65 #define CHFL_BURST_BAN_WIPEOUT  0x0400  /* Ban will be wiped at end of BURST */
  66 #define CHFL_BANVALID           0x0800  /* CHFL_BANNED bit is valid */
  67 #define CHFL_BANNED             0x1000  /* Channel member is banned */
  68 #define CHFL_SILENCE_IPMASK     0x2000  /* silence mask is an IP-number mask */
  69
  70 #define CHFL_OVERLAP         (CHFL_CHANOP | CHFL_VOICE)
  71 #define CHFL_BANVALIDMASK    (CHFL_BANVALID | CHFL_BANNED)
  72 #define CHFL_VOICED_OR_OPPED (CHFL_CHANOP | CHFL_VOICE)
  73
  74 /* Channel Visibility macros */
  75
  76 #define MODE_CHANOP     CHFL_CHANOP
  77 #define MODE_VOICE      CHFL_VOICE
  78 #define MODE_PRIVATE    0x0004
  79 #define MODE_SECRET     0x0008
  80 #define MODE_MODERATED  0x0010
  81 #define MODE_TOPICLIMIT 0x0020
  82 #define MODE_INVITEONLY 0x0040
  83 #define MODE_NOPRIVMSGS 0x0080
  84 #define MODE_KEY        0x0100
  85 #define MODE_BAN        0x0200
  86 #define MODE_LIMIT      0x0400
  87 #define MODE_SENDTS     0x0800  /* TS was 0 during a local user /join; send
  88                                  * temporary TS; can be removed when all 2.10 */
  89 #define MODE_LISTED     0x10000
  90 #define MODE_SAVE       0x20000 /* save this mode-with-arg 'til later */
  91 #define MODE_FREE       0x40000 /* string needs to be passed to MyFree() */
  92 #define MODE_BURSTADDED 0x80000 /* channel was created by a BURST */
  93 /*
  94  * mode flags which take another parameter (With PARAmeterS)
  95  */
  96 #define MODE_WPARAS     (MODE_CHANOP|MODE_VOICE|MODE_BAN|MODE_KEY|MODE_LIMIT)
  97
  98 #define HoldChannel(x)          (!(x))
  99 /* name invisible */
 100 #define SecretChannel(x)        ((x) && ((x)->mode.mode & MODE_SECRET))
 101 /* channel not shown but names are */
 102 #define HiddenChannel(x)        ((x) && ((x)->mode.mode & MODE_PRIVATE))
 103 /* channel visible */
 104 #define ShowChannel(v,c)        (PubChannel(c) || find_channel_member((v),(c)))
 105 #define PubChannel(x)           ((!x) || ((x)->mode.mode & \
 106                                     (MODE_PRIVATE | MODE_SECRET)) == 0)
 107 #define is_listed(x)            ((x)->mode.mode & MODE_LISTED)
 108
 109 #define IsLocalChannel(name)    (*(name) == '&')
 110 #define IsModelessChannel(name) (*(name) == '+')
 111 #define IsChannelName(name)     (*(name) == '#' || \
 112                                 IsModelessChannel(name) || IsLocalChannel(name))
 113
 114 typedef enum ChannelGetType {
 115   CGT_NO_CREATE,
 116   CGT_CREATE
 117 } ChannelGetType;
 118
 119 /* used in SetMode() in channel.c and m_umode() in s_msg.c */
 120
 121 #define MODE_NULL      0
 122 #define MODE_ADD       0x40000000
 123 #define MODE_DEL       0x20000000
 124
 125 /*
 126  * Maximum acceptable lag time in seconds: A channel younger than
 127  * this is not protected against hacking admins.
 128  * Mainly here to check if the TS clocks really sync (otherwise this
 129  * will start causing HACK notices.
 130  * This value must be the same on all servers.
 131  *
 132  * This value has been increased to 1 day in order to distinguish this
 133  * "normal" type of HACK wallops / desyncs, from possiblity still
 134  * existing bugs.
 135  */
 136 #define TS_LAG_TIME 86400
 137
 138 /*
 139  * A Magic TS that is used for channels that are created by JOIN,
 140  * a channel with this TS accepts all TS without complaining that
 141  * it might receive later via MODE or CREATE.
 142  */
 143 #define MAGIC_REMOTE_JOIN_TS 1270080000
 144
 145 /*
 146  * used in can_join to determine if an oper forced a join on a channel
 147  */
 148 #define MAGIC_OPER_OVERRIDE 1000
 149
 150
 151 extern const char* const PartFmt1;
 152 extern const char* const PartFmt2;
 153 extern const char* const PartFmt1serv;
 154 extern const char* const PartFmt2serv;
 155
 156
 157 /*
 158  * Structures
 159  */
 160
 161 struct Membership {
 162   struct Client*     user;
 163   struct Channel*    channel;
 164   struct Membership* next_member;
 165   struct Membership* prev_member;
 166   struct Membership* next_channel;
 167   struct Membership* prev_channel;
 168   unsigned int       status;
 169 };
 170
 171 #define IsZombie(x)         ((x)->status & CHFL_ZOMBIE)
 172 #define IsDeopped(x)        ((x)->status & CHFL_DEOPPED)
 173 #define IsBanned(x)         ((x)->status & CHFL_BANNED)
 174 #define IsBanValid(x)       ((x)->status & CHFL_BANVALID)
 175 #define IsChanOp(x)         ((x)->status & CHFL_CHANOP)
 176 #define HasVoice(x)         ((x)->status & CHFL_VOICE)
 177 #define IsServOpOk(x)       ((x)->status & CHFL_SERVOPOK)
 178 #define IsBurstJoined(x)    ((x)->status & CHFL_BURST_JOINED)
 179 #define IsVoicedOrOpped(x)  ((x)->status & CHFL_VOICED_OR_OPPED)
 180
 181 #define SetBanned(x)        ((x)->status |= CHFL_BANNED)
 182 #define SetBanValid(x)      ((x)->status |= CHFL_BANVALID)
 183 #define SetDeopped(x)       ((x)->status |= CHFL_DEOPPED)
 184 #define SetServOpOk(x)      ((x)->status |= CHFL_SERVOPOK)
 185 #define SetBurstJoined(x)   ((x)->status |= CHFL_BURST_JOINED)
 186 #define SetZombie(x)        ((x)->status |= CHFL_ZOMBIE)
 187
 188 #define ClearBanned(x)      ((x)->status &= ~CHFL_BANNED)
 189 #define ClearBanValid(x)    ((x)->status &= ~CHFL_BANVALID)
 190 #define ClearDeopped(x)     ((x)->status &= ~CHFL_DEOPPED)
 191 #define ClearServOpOk(x)    ((x)->status &= ~CHFL_SERVOPOK)
 192 #define ClearBurstJoined(x) ((x)->status &= ~CHFL_BURST_JOINED)
 193
 194
 195 struct Mode {
 196   unsigned int mode;
 197   unsigned int limit;
 198   char key[KEYLEN + 1];
 199 };
 200
 201 struct Channel {
 202   struct Channel*    next;
 203   struct Channel*    prev;
 204   struct Channel*    hnext;
 205   time_t             creationtime;
 206   time_t             topic_time;
 207   unsigned int       users;
 208   struct Membership* members;
 209   struct SLink*      invites;
 210   struct SLink*      banlist;
 211   struct Mode        mode;
 212   char               topic[TOPICLEN + 1];
 213   char               topic_nick[NICKLEN + 1];
 214   char               chname[1];
 215 };
 216
 217 struct ListingArgs {
 218   time_t max_time;
 219   time_t min_time;
 220   unsigned int max_users;
 221   unsigned int min_users;
 222   unsigned int topic_limits;
 223   time_t max_topic_time;
 224   time_t min_topic_time;
 225   struct Channel *chptr;
 226 };
 227
 228 struct ModeBuf {
 229   unsigned int          mb_add;         /* Modes to add */
 230   unsigned int          mb_rem;         /* Modes to remove */
 231   struct Client        *mb_source;      /* Source of MODE changes */
 232   struct Client        *mb_connect;     /* Connection of MODE changes */
 233   struct Channel       *mb_channel;     /* Channel they affect */
 234   unsigned int          mb_dest;        /* Destination of MODE changes */
 235   unsigned int          mb_count;       /* Number of modes w/args */
 236   struct {
 237     unsigned int        mbm_type;       /* Type of argument */
 238     union {
 239       unsigned int      mbma_uint;      /* A limit */
 240       char             *mbma_string;    /* A string */
 241       struct Client    *mbma_client;    /* A client */
 242     }                   mbm_arg;        /* The mode argument */
 243   }                     mb_modeargs[MAXMODEPARAMS];
 244                                         /* A mode w/args */
 245 };
 246
 247 #define MODEBUF_DEST_CHANNEL    0x0001  /* Mode is flushed to channel */
 248 #define MODEBUF_DEST_SERVER     0x0002  /* Mode is flushed to server */
 249
 250 #define MODEBUF_DEST_OPMODE     0x0100  /* Send server mode as OPMODE */
 251 #define MODEBUF_DEST_DEOP       0x0200  /* Deop the offender */
 252 #define MODEBUF_DEST_BOUNCE     0x0400  /* Bounce the modes */
 253 #define MODEBUF_DEST_LOG        0x0800  /* Log the mode changes to OPATH */
 254
 255 #define MODEBUF_DEST_HACK2      0x2000  /* Send a HACK(2) notice, reverse */
 256 #define MODEBUF_DEST_HACK3      0x4000  /* Send a HACK(3) notice, TS == 0 */
 257 #define MODEBUF_DEST_HACK4      0x8000  /* Send a HACK(4) notice, TS == 0 */
 258
 259 #define MB_TYPE(mb, i)          ((mb)->mb_modeargs[(i)].mbm_type)
 260 #define MB_UINT(mb, i)          ((mb)->mb_modeargs[(i)].mbm_arg.mbma_uint)
 261 #define MB_STRING(mb, i)        ((mb)->mb_modeargs[(i)].mbm_arg.mbma_string)
 262 #define MB_CLIENT(mb, i)        ((mb)->mb_modeargs[(i)].mbm_arg.mbma_client)
 263
 264 struct JoinBuf {
 265   struct Client        *jb_source;      /* Source of joins (ie, joiner) */
 266   struct Client        *jb_connect;     /* Connection of joiner */
 267   unsigned int          jb_type;        /* Type of join (JOIN or CREATE) */
 268   char                 *jb_comment;     /* part comment */
 269   time_t                jb_create;      /* Creation timestamp */
 270   unsigned int          jb_count;       /* Number of channels */
 271   unsigned int          jb_strlen;      /* length so far */
 272   struct Channel       *jb_channels[MAXJOINARGS];
 273                                         /* channels joined or whatever */
 274 };
 275
 276 #define JOINBUF_TYPE_JOIN       0       /* send JOINs */
 277 #define JOINBUF_TYPE_CREATE     1       /* send CREATEs */
 278 #define JOINBUF_TYPE_PART       2       /* send PARTs */
 279 #define JOINBUF_TYPE_PARTALL    3       /* send local PARTs, but not remote */
 280
 281 extern struct Channel* GlobalChannelList;
 282 extern int             LocalChanOperMode;
 283
 284 /*
 285  * Proto types
 286  */
 287 extern void clean_channelname(char* name);
 288 extern void channel_modes(struct Client *cptr, char *mbuf, char *pbuf,
 289                           struct Channel *chptr);
 290 extern int set_mode(struct Client* cptr, struct Client* sptr,
 291                     struct Channel* chptr, int parc, char* parv[],
 292                     char* mbuf, char* pbuf, char* npbuf, int* badop);
 293 extern void send_hack_notice(struct Client *cptr, struct Client *sptr,
 294                              int parc, char *parv[], int badop, int mtype);
 295 extern struct Channel *get_channel(struct Client *cptr,
 296                                    char *chname, ChannelGetType flag);
 297 extern struct Membership* find_member_link(struct Channel * chptr,
 298                                            const struct Client* cptr);
 299 extern int sub1_from_channel(struct Channel* chptr);
 300 extern int can_join(struct Client *sptr, struct Channel *chptr, char *key);
 301 extern void add_user_to_channel(struct Channel* chptr, struct Client* who,
 302                                 unsigned int flags);
 303 extern void cancel_mode(struct Client *sptr, struct Channel *chptr, char m,
 304                         const char *param, int *count);
 305 extern void add_token_to_sendbuf(char *token, size_t *sblenp, int *firstp,
 306                                  int *send_itp, char is_a_ban, int mode);
 307 extern int add_banid(struct Client *cptr, struct Channel *chptr, char *banid,
 308                      int change, int firsttime);
 309 extern struct SLink *next_removed_overlapped_ban(void);
 310 extern void cancel_mode(struct Client *sptr, struct Channel *chptr, char m,
 311                         const char *param, int *count);
 312 extern void make_zombie(struct Membership* member, struct Client* who,
 313                         struct Client* cptr, struct Client* sptr,
 314                         struct Channel* chptr);
 315 extern struct Client* find_chasing(struct Client* sptr, const char* user, int* chasing);
 316 void add_invite(struct Client *cptr, struct Channel *chptr);
 317 int number_of_zombies(struct Channel *chptr);
 318
 319 extern const char* find_no_nickchange_channel(struct Client* cptr);
 320 extern struct Membership* IsMember(struct Client *cptr, struct Channel *chptr);
 321 extern struct Membership* find_channel_member(struct Client* cptr, struct Channel* chptr);
 322 extern int member_can_send_to_channel(struct Membership* member);
 323 extern int client_can_send_to_channel(struct Client *cptr, struct Channel *chptr);
 324
 325 extern void remove_user_from_channel(struct Client *sptr, struct Channel *chptr);
 326 extern void remove_user_from_all_channels(struct Client* cptr);
 327
 328 extern int is_chan_op(struct Client *cptr, struct Channel *chptr);
 329 extern int is_zombie(struct Client *cptr, struct Channel *chptr);
 330 extern int has_voice(struct Client *cptr, struct Channel *chptr);
 331 extern void send_channel_modes(struct Client *cptr, struct Channel *chptr);
 332 extern char *pretty_mask(char *mask);
 333 extern void del_invite(struct Client *cptr, struct Channel *chptr);
 334 extern void list_next_channels(struct Client *cptr, int nr);
 335 extern void list_set_default(void); /* this belongs elsewhere! */
 336
 337 extern void modebuf_init(struct ModeBuf *mbuf, struct Client *source,
 338                          struct Client *connect, struct Channel *chan,
 339                          unsigned int dest);
 340 extern void modebuf_mode(struct ModeBuf *mbuf, unsigned int mode);
 341 extern void modebuf_mode_uint(struct ModeBuf *mbuf, unsigned int mode,
 342                               unsigned int uint);
 343 extern void modebuf_mode_string(struct ModeBuf *mbuf, unsigned int mode,
 344                                 char *string, int free);
 345 extern void modebuf_mode_client(struct ModeBuf *mbuf, unsigned int mode,
 346                                 struct Client *client);
 347 extern int modebuf_flush(struct ModeBuf *mbuf);
 348 extern void modebuf_extract(struct ModeBuf *mbuf, char *buf);
 349
 350 extern void mode_ban_invalidate(struct Channel *chan);
 351 extern void mode_invite_clear(struct Channel *chan);
 352
 353 extern int mode_parse(struct ModeBuf *mbuf, struct Client *cptr,
 354                       struct Client *sptr, struct Channel *chptr,
 355                       int parc, char *parv[], unsigned int flags);
 356
 357 #define MODE_PARSE_SET          0x01    /* actually set channel modes */
 358 #define MODE_PARSE_STRICT       0x02    /* +m +n +t style not supported */
 359 #define MODE_PARSE_FORCE        0x04    /* force the mode to be applied */
 360 #define MODE_PARSE_BOUNCE       0x08    /* we will be bouncing the modes */
 361 #define MODE_PARSE_NOTOPER      0x10    /* send "not chanop" to user */
 362 #define MODE_PARSE_NOTMEMBER    0x20    /* send "not member" to user */
 363 #define MODE_PARSE_WIPEOUT      0x40    /* wipe out +k and +l during burst */
 364 #define MODE_PARSE_BURST        0x80    /* be even more strict w/extra args */
 365
 366 extern void joinbuf_init(struct JoinBuf *jbuf, struct Client *source,
 367                          struct Client *connect, unsigned int type,
 368                          char *comment, time_t create);
 369 extern void joinbuf_join(struct JoinBuf *jbuf, struct Channel *chan,
 370                          unsigned int flags);
 371 extern int joinbuf_flush(struct JoinBuf *jbuf);
 372
 373 #endif /* INCLUDED_channel_h */