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       /**< Maximum number of mode parameters */
  40 #define MODEBUFLEN      200     /**< Maximum length of a mode */
  41
  42 #define KEYLEN          23      /**< Maximum length of a key */
  43 #define PASSLEN         23      /**< Maximum length of a password */
  44 #define CHANNELLEN      200     /**< Maximum length of a channel */
  45
  46 #define MAXJOINARGS     15      /**< number of slots for join buffer */
  47 #define STARTJOINLEN    10      /**< fuzzy numbers */
  48 #define STARTCREATELEN  20
  49
  50 /*
  51  * Macro's
  52  */
  53
  54 #define ChannelExists(n)        (0 != FindChannel(n))
  55
  56 #define CHFL_CHANOP             0x0001  /**< Channel operator */
  57 #define CHFL_VOICE              0x0002  /**< the power to speak */
  58 #define CHFL_DEOPPED            0x0004  /**< Is de-opped by a server */
  59 #define CHFL_SERVOPOK           0x0008  /**< Server op allowed */
  60 #define CHFL_ZOMBIE             0x0010  /**< Kicked from channel */
  61 #define CHFL_BAN                0x0020  /**< ban channel flag */
  62 #define CHFL_BAN_IPMASK         0x0040  /**< ban mask is an IP-number mask */
  63 #define CHFL_BAN_OVERLAPPED     0x0080  /**< ban overlapped, need bounce */
  64 #define CHFL_BURST_JOINED       0x0100  /**< Just joined by net.junction */
  65 #define CHFL_BURST_BAN          0x0200  /**< Ban part of last BURST */
  66 #define CHFL_BURST_BAN_WIPEOUT  0x0400  /**< Ban will be wiped at EOB */
  67 #define CHFL_BANVALID           0x0800  /**< CHFL_BANNED bit is valid */
  68 #define CHFL_BANNED             0x1000  /**< Channel member is banned */
  69 #define CHFL_SILENCE_IPMASK     0x2000  /**< silence mask is a CIDR */
  70 #define CHFL_BURST_ALREADY_OPPED        0x04000
  71                                         /**< In oob BURST, but was already
  72                                          * joined and opped
  73                                          */
  74 #define CHFL_BURST_ALREADY_VOICED       0x08000
  75                                         /**, In oob BURST, but was already
  76                                          * joined and voiced
  77                                          */
  78 #define CHFL_CHANNEL_MANAGER    0x10000 /**< Set when creating channel or using
  79                                          * Apass
  80                                          */
  81 #define CHFL_USER_PARTING       0x20000 /**< User is already parting that
  82                                          * channel
  83                                          */
  84 #define CHFL_DELAYED            0x40000 /**< User's join message is delayed */
  85
  86 #define CHFL_OVERLAP         (CHFL_CHANOP | CHFL_VOICE)
  87 #define CHFL_BANVALIDMASK    (CHFL_BANVALID | CHFL_BANNED)
  88 #define CHFL_VOICED_OR_OPPED (CHFL_CHANOP | CHFL_VOICE)
  89
  90 /* Channel Visibility macros */
  91
  92 #define MODE_CHANOP     CHFL_CHANOP     /**< +o Chanop */
  93 #define MODE_VOICE      CHFL_VOICE      /**< +v Voice */
  94 #define MODE_PRIVATE    0x0004          /**< +p Private */
  95 #define MODE_SECRET     0x0008          /**< +s Secret */
  96 #define MODE_MODERATED  0x0010          /**< +m Moderated */
  97 #define MODE_TOPICLIMIT 0x0020          /**< +t Topic Limited */
  98 #define MODE_INVITEONLY 0x0040          /**< +i Invite only */
  99 #define MODE_NOPRIVMSGS 0x0080          /**< +n No Private Messages */
 100 #define MODE_KEY        0x0100          /**< +k Keyed */
 101 #define MODE_BAN        0x0200          /**< +b Ban */
 102 #define MODE_LIMIT      0x0400          /**< +l Limit */
 103 #define MODE_REGONLY    0x0800          /**< Only +r users may join */
 104 #define MODE_DELJOINS   0x1000          /**< New join messages are delayed */
 105 #define MODE_LISTED     0x10000
 106 #define MODE_SAVE       0x20000         /**< save this mode-with-arg 'til
 107                                          * later */
 108 #define MODE_FREE       0x40000         /**< string needs to be passed to
 109                                          * MyFree() */
 110 #define MODE_BURSTADDED 0x80000         /**< channel was created by a BURST */
 111 #define MODE_UPASS      0x100000
 112 #define MODE_APASS      0x200000
 113 #define MODE_WASDELJOINS 0x400000       /**< Not DELJOINS, but some joins
 114                                          * pending */
 115 /** mode flags which take another parameter (With PARAmeterS)
 116  */
 117 #define MODE_WPARAS     (MODE_CHANOP|MODE_VOICE|MODE_BAN|MODE_KEY|MODE_LIMIT|MODE_APASS|MODE_UPASS)
 118
 119 /** Available Channel modes */
 120 #define infochanmodes feature_bool(FEAT_OPLEVELS) ? "AbiklmnopstUvrD" : "biklmnopstvrD"
 121 /** Available Channel modes that take parameters */
 122 #define infochanmodeswithparams feature_bool(FEAT_OPLEVELS) ? "AbkloUv" : "bklov"
 123
 124 #define HoldChannel(x)          (!(x))
 125 /** name invisible */
 126 #define SecretChannel(x)        ((x) && ((x)->mode.mode & MODE_SECRET))
 127 /** channel not shown but names are */
 128 #define HiddenChannel(x)        ((x) && ((x)->mode.mode & MODE_PRIVATE))
 129 /** channel visible */
 130 #define ShowChannel(v,c)        (PubChannel(c) || find_channel_member((v),(c)) || \
 131                                  (IsAnOper(v) && HasPriv(v, PRIV_LIST_CHAN)))
 132 #define PubChannel(x)           ((!x) || ((x)->mode.mode & \
 133                                     (MODE_PRIVATE | MODE_SECRET)) == 0)
 134 #define is_listed(x)            ((x)->mode.mode & MODE_LISTED)
 135
 136 #define IsGlobalChannel(name)   (*(name) == '#')
 137 #define IsLocalChannel(name)    (*(name) == '&')
 138 #define IsChannelName(name)     (IsGlobalChannel(name) || IsLocalChannel(name))
 139
 140 typedef enum ChannelGetType {
 141   CGT_NO_CREATE,
 142   CGT_CREATE
 143 } ChannelGetType;
 144
 145 /* used in SetMode() in channel.c and m_umode() in s_msg.c */
 146
 147 #define MODE_NULL      0
 148 #define MODE_ADD       0x40000000
 149 #define MODE_DEL       0x20000000
 150
 151 /* used in ListingArgs.flags */
 152
 153 #define LISTARG_TOPICLIMITS     0x0001
 154 #define LISTARG_SHOWSECRET      0x0002
 155
 156 /**
 157  * Maximum acceptable lag time in seconds: A channel younger than
 158  * this is not protected against hacking admins.
 159  * Mainly here to check if the TS clocks really sync (otherwise this
 160  * will start causing HACK notices.
 161  * This value must be the same on all servers.
 162  *
 163  * This value has been increased to 1 day in order to distinguish this
 164  * "normal" type of HACK wallops / desyncs, from possiblity still
 165  * existing bugs.
 166  */
 167 #define TS_LAG_TIME 86400
 168
 169 /**
 170  * A Magic TS that is used for channels that are created by JOIN,
 171  * a channel with this TS accepts all TS without complaining that
 172  * it might receive later via MODE or CREATE.
 173  *
 174  * Part of the P9 compatibility, shouldn't occur on a P10 network.
 175  */
 176 #define MAGIC_REMOTE_JOIN_TS 1270080000
 177
 178 /**
 179  * used in can_join to determine if an oper forced a join on a channel
 180  */
 181 #define MAGIC_OPER_OVERRIDE 1000
 182
 183
 184 extern const char* const PartFmt1;
 185 extern const char* const PartFmt2;
 186 extern const char* const PartFmt1serv;
 187 extern const char* const PartFmt2serv;
 188
 189
 190 /*
 191  * Structures
 192  */
 193
 194 /** Information about a client on one channel
 195  *
 196  * This structure forms a sparse matrix with users down the side, and
 197  * channels across the top.  This matrix holds all the information about
 198  * which users are on what channels, and what modes that user has on that
 199  * channel (if they are op'd, voice'd and cached information if they are
 200  * banned or not)
 201  */
 202 struct Membership {
 203   struct Client*     user;              /**< The user */
 204   struct Channel*    channel;           /**< The channel */
 205   struct Membership* next_member;       /**< The next user on this channel */
 206   struct Membership* prev_member;       /**< The previous user on this channel*/
 207   struct Membership* next_channel;      /**< Next channel this user is on */
 208   struct Membership* prev_channel;      /**< Previous channel this user is on*/
 209   unsigned int       status;            /**< Flags for op'd, voice'd, etc */
 210   unsigned short     oplevel;           /**< Op level */
 211 };
 212
 213 #define MAXOPLEVELDIGITS    3
 214 #define MAXOPLEVEL          999
 215
 216 #define IsZombie(x)         ((x)->status & CHFL_ZOMBIE) /**< see \ref zombie */
 217 #define IsDeopped(x)        ((x)->status & CHFL_DEOPPED)
 218 #define IsBanned(x)         ((x)->status & CHFL_BANNED)
 219 #define IsBanValid(x)       ((x)->status & CHFL_BANVALID)
 220 #define IsChanOp(x)         ((x)->status & CHFL_CHANOP)
 221 #define OpLevel(x)          ((x)->oplevel)
 222 #define HasVoice(x)         ((x)->status & CHFL_VOICE)
 223 #define IsServOpOk(x)       ((x)->status & CHFL_SERVOPOK)
 224 #define IsBurstJoined(x)    ((x)->status & CHFL_BURST_JOINED)
 225 #define IsVoicedOrOpped(x)  ((x)->status & CHFL_VOICED_OR_OPPED)
 226 #define IsChannelManager(x) ((x)->status & CHFL_CHANNEL_MANAGER)
 227 #define IsUserParting(x)    ((x)->status & CHFL_USER_PARTING)
 228 #define IsDelayedJoin(x)    ((x)->status & CHFL_DELAYED)
 229
 230 #define SetBanned(x)        ((x)->status |= CHFL_BANNED)
 231 #define SetBanValid(x)      ((x)->status |= CHFL_BANVALID)
 232 #define SetDeopped(x)       ((x)->status |= CHFL_DEOPPED)
 233 #define SetServOpOk(x)      ((x)->status |= CHFL_SERVOPOK)
 234 #define SetBurstJoined(x)   ((x)->status |= CHFL_BURST_JOINED)
 235 #define SetZombie(x)        ((x)->status |= CHFL_ZOMBIE)
 236 #define SetChannelManager(x) ((x)->status |= CHFL_CHANNEL_MANAGER)
 237 #define SetOpLevel(x, v)    (void)((x)->oplevel = (v))
 238 #define SetUserParting(x)   ((x)->status |= CHFL_USER_PARTING)
 239 #define SetDelayedJoin(x)   ((x)->status |= CHFL_DELAYED)
 240
 241 #define ClearBanned(x)      ((x)->status &= ~CHFL_BANNED)
 242 #define ClearBanValid(x)    ((x)->status &= ~CHFL_BANVALID)
 243 #define ClearDeopped(x)     ((x)->status &= ~CHFL_DEOPPED)
 244 #define ClearServOpOk(x)    ((x)->status &= ~CHFL_SERVOPOK)
 245 #define ClearBurstJoined(x) ((x)->status &= ~CHFL_BURST_JOINED)
 246 #define ClearDelayedJoin(x) ((x)->status &= ~CHFL_DELAYED)
 247
 248 /** Mode information for a channel */
 249 struct Mode {
 250   unsigned int mode;
 251   unsigned int limit;
 252   char key[KEYLEN + 1];
 253   char upass[PASSLEN + 1];
 254   char apass[PASSLEN + 1];
 255 };
 256
 257 /** Information about a channel */
 258 struct Channel {
 259   struct Channel*    next;      /**< next channel in the global channel list */
 260   struct Channel*    prev;      /**< previous channel */
 261   struct Channel*    hnext;     /**< Next channel in the hash table */
 262   struct DestructEvent* destruct_event;
 263   time_t             creationtime; /**< Creation time of this channel */
 264   time_t             topic_time;   /**< Modification time of the topic */
 265   unsigned int       users;        /**< Number of clients on this channel */
 266   struct Membership* members;      /**< Pointer to the clients on this channel*/
 267   struct SLink*      invites;      /**< List of invites on this channel */
 268   struct SLink*      banlist;      /**< List of bans on this channel */
 269   struct Mode        mode;         /**< This channels mode */
 270   char               topic[TOPICLEN + 1]; /**< Channels topic */
 271   char               topic_nick[NICKLEN + 1]; /**< Nick of the person who set
 272                                                 *  The topic
 273                                                 */
 274   char               chname[1];    /**< Dynamically allocated string of the
 275                                      * channel name
 276                                      */
 277 };
 278
 279 /** Information about a /list in progress */
 280 struct ListingArgs {
 281   time_t max_time;
 282   time_t min_time;
 283   unsigned int max_users;
 284   unsigned int min_users;
 285   unsigned int flags;
 286   time_t max_topic_time;
 287   time_t min_topic_time;
 288   struct Channel *chptr;
 289 };
 290
 291 struct ModeBuf {
 292   unsigned int          mb_add;         /**< Modes to add */
 293   unsigned int          mb_rem;         /**< Modes to remove */
 294   struct Client        *mb_source;      /**< Source of MODE changes */
 295   struct Client        *mb_connect;     /**< Connection of MODE changes */
 296   struct Channel       *mb_channel;     /**< Channel they affect */
 297   unsigned int          mb_dest;        /**< Destination of MODE changes */
 298   unsigned int          mb_count;       /**< Number of modes w/args */
 299   struct {
 300     unsigned int        mbm_type;       /**< Type of argument */
 301     union {
 302       unsigned int      mbma_uint;      /**< A limit */
 303       char             *mbma_string;    /**< A string */
 304       struct Client    *mbma_client;    /**< A client */
 305     }                   mbm_arg;        /**< The mode argument */
 306   }                     mb_modeargs[MAXMODEPARAMS];
 307                                         /**< A mode w/args */
 308 };
 309
 310 #define MODEBUF_DEST_CHANNEL    0x00001 /**< Mode is flushed to channel */
 311 #define MODEBUF_DEST_SERVER     0x00002 /**< Mode is flushed to server */
 312
 313 #define MODEBUF_DEST_OPMODE     0x00100 /**< Send server mode as OPMODE */
 314 #define MODEBUF_DEST_DEOP       0x00200 /**< Deop the offender */
 315 #define MODEBUF_DEST_BOUNCE     0x00400 /**< Bounce the modes */
 316 #define MODEBUF_DEST_LOG        0x00800 /**< Log the mode changes to OPATH */
 317
 318 #define MODEBUF_DEST_HACK2      0x02000 /**< Send a HACK(2) notice, reverse */
 319 #define MODEBUF_DEST_HACK3      0x04000 /**< Send a HACK(3) notice, TS == 0 */
 320 #define MODEBUF_DEST_HACK4      0x08000 /**< Send a HACK(4) notice, TS == 0 */
 321
 322 #define MODEBUF_DEST_NOKEY      0x10000 /**< Don't send the real key */
 323
 324 #define MB_TYPE(mb, i)          ((mb)->mb_modeargs[(i)].mbm_type)
 325 #define MB_UINT(mb, i)          ((mb)->mb_modeargs[(i)].mbm_arg.mbma_uint)
 326 #define MB_STRING(mb, i)        ((mb)->mb_modeargs[(i)].mbm_arg.mbma_string)
 327 #define MB_CLIENT(mb, i)        ((mb)->mb_modeargs[(i)].mbm_arg.mbma_client)
 328
 329 /** A buffer represeting a list of joins to send */
 330 struct JoinBuf {
 331   struct Client        *jb_source;      /**< Source of joins (ie, joiner) */
 332   struct Client        *jb_connect;     /**< Connection of joiner */
 333   unsigned int          jb_type;        /**< Type of join (JOIN or CREATE) */
 334   char                 *jb_comment;     /**< part comment */
 335   time_t                jb_create;      /**< Creation timestamp */
 336   unsigned int          jb_count;       /**< Number of channels */
 337   unsigned int          jb_strlen;      /**< length so far */
 338   struct Channel       *jb_channels[MAXJOINARGS];
 339                                         /**< channels joined or whatever */
 340 };
 341
 342 #define JOINBUF_TYPE_JOIN       0       /**< send JOINs */
 343 #define JOINBUF_TYPE_CREATE     1       /**< send CREATEs */
 344 #define JOINBUF_TYPE_PART       2       /**< send PARTs */
 345 #define JOINBUF_TYPE_PARTALL    3       /**< send local PARTs, but not remote */
 346
 347 extern struct Channel* GlobalChannelList;
 348 extern int             LocalChanOperMode;
 349
 350 /*
 351  * Proto types
 352  */
 353 extern void clean_channelname(char* name);
 354 extern void channel_modes(struct Client *cptr, char *mbuf, char *pbuf,
 355                           int buflen, struct Channel *chptr,
 356                           struct Membership *member);
 357 extern int set_mode(struct Client* cptr, struct Client* sptr,
 358                     struct Channel* chptr, int parc, char* parv[],
 359                     char* mbuf, char* pbuf, char* npbuf, int* badop);
 360 extern void send_hack_notice(struct Client *cptr, struct Client *sptr,
 361                              int parc, char *parv[], int badop, int mtype);
 362 extern struct Channel *get_channel(struct Client *cptr,
 363                                    char *chname, ChannelGetType flag);
 364 extern struct Membership* find_member_link(struct Channel * chptr,
 365                                            const struct Client* cptr);
 366 extern int sub1_from_channel(struct Channel* chptr);
 367 extern int destruct_channel(struct Channel* chptr);
 368 extern int can_join(struct Client *sptr, struct Channel *chptr, char *key);
 369 extern void add_user_to_channel(struct Channel* chptr, struct Client* who,
 370                                 unsigned int flags, int oplevel);
 371 extern void cancel_mode(struct Client *sptr, struct Channel *chptr, char m,
 372                         const char *param, int *count);
 373 extern void add_token_to_sendbuf(char *token, size_t *sblenp, int *firstp,
 374                                  int *send_itp, char is_a_ban, int mode);
 375 extern int add_banid(struct Client *cptr, struct Channel *chptr, char *banid,
 376                      int change, int firsttime);
 377 extern struct SLink *next_removed_overlapped_ban(void);
 378 extern void cancel_mode(struct Client *sptr, struct Channel *chptr, char m,
 379                         const char *param, int *count);
 380 extern void make_zombie(struct Membership* member, struct Client* who,
 381                         struct Client* cptr, struct Client* sptr,
 382                         struct Channel* chptr);
 383 extern struct Client* find_chasing(struct Client* sptr, const char* user, int* chasing);
 384 void add_invite(struct Client *cptr, struct Channel *chptr);
 385 int number_of_zombies(struct Channel *chptr);
 386
 387 extern const char* find_no_nickchange_channel(struct Client* cptr);
 388 extern struct Membership* IsMember(struct Client *cptr, struct Channel *chptr);
 389 extern struct Membership* find_channel_member(struct Client* cptr, struct Channel* chptr);
 390 extern int member_can_send_to_channel(struct Membership* member, int reveal);
 391 extern int client_can_send_to_channel(struct Client *cptr, struct Channel *chptr, int reveal);
 392
 393 extern void remove_user_from_channel(struct Client *sptr, struct Channel *chptr);
 394 extern void remove_user_from_all_channels(struct Client* cptr);
 395
 396 extern int is_chan_op(struct Client *cptr, struct Channel *chptr);
 397 extern int is_zombie(struct Client *cptr, struct Channel *chptr);
 398 extern int has_voice(struct Client *cptr, struct Channel *chptr);
 399 /*
 400    NOTE: pointer is compared, and not dereferenced, called by
 401    add_target with a void*, since targets could be anything,
 402    this function can't make any assumptions that it has a channel
 403 */
 404 extern int IsInvited(struct Client* cptr, const void* chptr);
 405 extern void send_channel_modes(struct Client *cptr, struct Channel *chptr);
 406 extern char *pretty_mask(char *mask);
 407 extern void del_invite(struct Client *cptr, struct Channel *chptr);
 408 extern void list_next_channels(struct Client *cptr, int nr);
 409 extern void list_set_default(void); /* this belongs elsewhere! */
 410
 411 extern void RevealDelayedJoin(struct Membership *member);
 412 extern void CheckDelayedJoins(struct Channel *chan);
 413
 414 extern void modebuf_init(struct ModeBuf *mbuf, struct Client *source,
 415                          struct Client *connect, struct Channel *chan,
 416                          unsigned int dest);
 417 extern void modebuf_mode(struct ModeBuf *mbuf, unsigned int mode);
 418 extern void modebuf_mode_uint(struct ModeBuf *mbuf, unsigned int mode,
 419                               unsigned int uint);
 420 extern void modebuf_mode_string(struct ModeBuf *mbuf, unsigned int mode,
 421                                 char *string, int free);
 422 extern void modebuf_mode_client(struct ModeBuf *mbuf, unsigned int mode,
 423                                 struct Client *client);
 424 extern int modebuf_flush(struct ModeBuf *mbuf);
 425 extern void modebuf_extract(struct ModeBuf *mbuf, char *buf);
 426
 427 extern void mode_ban_invalidate(struct Channel *chan);
 428 extern void mode_invite_clear(struct Channel *chan);
 429
 430 extern int mode_parse(struct ModeBuf *mbuf, struct Client *cptr,
 431                       struct Client *sptr, struct Channel *chptr,
 432                       int parc, char *parv[], unsigned int flags,
 433                       struct Membership* member);
 434
 435 #define MODE_PARSE_SET          0x01    /**< actually set channel modes */
 436 #define MODE_PARSE_STRICT       0x02    /**< +m +n +t style not supported */
 437 #define MODE_PARSE_FORCE        0x04    /**< force the mode to be applied */
 438 #define MODE_PARSE_BOUNCE       0x08    /**< we will be bouncing the modes */
 439 #define MODE_PARSE_NOTOPER      0x10    /**< send "not chanop" to user */
 440 #define MODE_PARSE_NOTMEMBER    0x20    /**< send "not member" to user */
 441 #define MODE_PARSE_WIPEOUT      0x40    /**< wipe out +k and +l during burst */
 442 #define MODE_PARSE_BURST        0x80    /**< be even more strict w/extra args */
 443
 444 extern void joinbuf_init(struct JoinBuf *jbuf, struct Client *source,
 445                          struct Client *connect, unsigned int type,
 446                          char *comment, time_t create);
 447 extern void joinbuf_join(struct JoinBuf *jbuf, struct Channel *chan,
 448                          unsigned int flags);
 449 extern int joinbuf_flush(struct JoinBuf *jbuf);
 450
 451 #endif /* INCLUDED_channel_h */