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