src/chanserv.h

   1 /* chanserv.h - Channel service bot
   2  * Copyright 2000-2004 srvx Development Team
   3  *
   4  * This file is part of x3.
   5  *
   6  * srvx 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 of the License, or
   9  * (at your option) 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 srvx; if not, write to the Free Software Foundation,
  18  * Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.
  19  */
  20
  21 #ifndef _chanserv_h
  22 #define _chanserv_h
  23
  24 #include "nickserv.h"
  25
  26 enum UL_ALIASES {
  27     UL_PEON = 100,
  28     UL_HALFOP = 150,
  29     UL_OP = 200,
  30     UL_MANAGER = 300,
  31     UL_PRESENT = UL_MANAGER,
  32     UL_COOWNER = 400,
  33     UL_OWNER = 500,
  34     UL_HELPER = 600,
  35 };
  36
  37 enum levelOption {
  38     lvlEnfOps,
  39     lvlEnfHalfOps,
  40     lvlEnfModes,
  41     lvlEnfTopic,
  42     lvlPubCmd,
  43     lvlSetters,
  44     lvlUserInfo,
  45     lvlInviteMe,
  46     lvlTopicSnarf,
  47     NUM_LEVEL_OPTIONS
  48 };
  49
  50 enum charOption {
  51     chAutomode,
  52     chProtect,
  53     chToys,
  54     chTopicRefresh,
  55     chCTCPReaction,
  56     chBanTimeout,
  57     NUM_CHAR_OPTIONS
  58 };
  59
  60 #define CHANNEL_NODELETE        0x00000001 /* (1 << 0) */
  61 #define CHANNEL_SUSPENDED       0x00000002 /* (1 << 1) */
  62 #define CHANNEL_INFO_LINES      0x00000004 /* (1 << 2) - DEPRECATED */
  63 #define CHANNEL_VOICE_ALL       0x00000008 /* (1 << 3) - DEPRECATED */
  64
  65 /* No longer used. */                      /* (1 << 4) */
  66 #define CHANNEL_DYNAMIC_LIMIT   0x00000020 /* (1 << 5) */
  67 #define CHANNEL_TOPIC_SNARF     0x00000040 /* (1 << 6) - DEPRECATED */
  68 #define CHANNEL_PEON_INVITE     0x00000080 /* (1 << 7) - DEPRECATED */
  69 #define CHANNEL_OFFCHANNEL      0x00000100 /* (1 << 8) */
  70 #define CHANNEL_HOP_ALL         0x00000200 /* (1 << 9) */
  71 /* Flags with values over 0x20000000 or (1 << 29) will not work
  72  * because chanData.flags is a 30-bit field.
  73  */
  74
  75 /* how many seconds a pending adduser will wait for a user
  76  * to get auth or register
  77  */
  78 #define ADDUSER_PENDING_EXPIRE 7200  /* 2 hours */
  79
  80 #define IsProtected(x)          ((x)->flags & CHANNEL_NODELETE)
  81 #define IsSuspended(x)          ((x)->flags & CHANNEL_SUSPENDED)
  82 #define IsOffChannel(x)         (((x)->flags & CHANNEL_OFFCHANNEL) && (off_channel > 1))
  83
  84 struct chanData
  85 {
  86     struct chanNode     *channel;
  87     struct mod_chanmode modes;
  88
  89     time_t              registered;
  90     time_t              visited;
  91     time_t              limitAdjusted;
  92     time_t              ownerTransfer;
  93
  94     char                *topic;
  95     char                *greeting;
  96     char                *user_greeting;
  97     char                *registrar;
  98     char                *topic_mask;
  99
 100     unsigned int        flags : 30;
 101     unsigned int        may_opchan : 1;
 102     unsigned int        max;
 103     unsigned int        last_refresh;
 104     unsigned short      banCount; /* Lamers, really */
 105     unsigned short      userCount;
 106     unsigned short      lvlOpts[NUM_LEVEL_OPTIONS];
 107     unsigned char       chOpts[NUM_CHAR_OPTIONS];
 108
 109     struct userData     *users;
 110     struct banData      *bans; /* Lamers, really */
 111     struct dict         *notes;
 112     struct suspended    *suspended;
 113     struct giveownership *giveownership;
 114     struct chanData     *prev;
 115     struct chanData     *next;
 116 };
 117
 118 #define USER_NOAUTO_OP          0x00000001 /* OLD; Not used at all.. */
 119 #define USER_SUSPENDED          0x00000002
 120 #define USER_AUTO_INVITE        0x00000004
 121 #define USER_AUTO_OP            0x00000008
 122 #define USER_FLAGS_SIZE         15
 123 #define USER_FLAGS_DEFAULT      USER_AUTO_OP
 124
 125 #define IsUserAutoOp(USER)      ((USER)->flags & USER_AUTO_OP)
 126 #define IsUserSuspended(USER)   ((USER)->flags & USER_SUSPENDED)
 127 #define IsUserAutoInvite(USER)  ((USER)->flags & USER_AUTO_INVITE)
 128
 129 struct userData
 130 {
 131     struct handle_info  *handle;
 132     struct chanData     *channel;
 133
 134     char                *info;
 135     time_t              seen;
 136     time_t              expires;
 137     unsigned short      access;
 138     unsigned int        present : 1;
 139     unsigned int        flags : USER_FLAGS_SIZE;
 140
 141     /* linked list of userDatas for a chanData */
 142     struct userData     *prev;
 143     struct userData     *next;
 144     /* linked list of userDatas for a handle_info */
 145     struct userData     *u_prev;
 146     struct userData     *u_next;
 147 };
 148
 149 struct adduserPending
 150 {
 151     struct chanNode *channel;
 152     struct userNode *user;
 153     int level;
 154     time_t created;
 155
 156     struct adduserPending *prev;
 157     struct adduserPending *next;
 158 };
 159
 160 struct banData
 161 {
 162     char                mask[NICKLEN + USERLEN + HOSTLEN + 3];
 163     char                owner[NICKLEN+1];
 164     struct chanData     *channel;
 165
 166     time_t              set;
 167     time_t              triggered;
 168     time_t              expires;
 169
 170     char                *reason;
 171
 172     struct banData      *prev;
 173     struct banData      *next;
 174 };
 175
 176 struct suspended
 177 {
 178     struct chanData     *cData;
 179     char                *suspender;
 180     char                *reason;
 181     time_t              issued, expires, revoked;
 182     struct suspended    *previous;
 183 };
 184
 185 struct giveownership
 186 {
 187     char                 *staff_issuer;
 188     char                  *old_owner;
 189     char                  *target;
 190     unsigned short        target_access;
 191     time_t                issued;
 192     char                  *reason;
 193     struct giveownership  *previous;
 194 };
 195
 196 struct do_not_register
 197 {
 198     char   chan_name[CHANNELLEN+1];
 199     char   setter[NICKSERV_HANDLE_LEN+1];
 200     time_t set;
 201     char   reason[1];
 202 };
 203
 204 void init_chanserv(const char *nick);
 205 void del_channel_user(struct userData *user, int do_gc);
 206 struct channelList *chanserv_support_channels(void);
 207 unsigned short user_level_from_name(const char *name, unsigned short clamp_level);
 208 struct do_not_register *chanserv_is_dnr(const char *chan_name, struct handle_info *handle);
 209 int check_user_level(struct chanNode *channel, struct userNode *user, enum levelOption opt, int allow_override, int exempt_owner);
 210
 211 void do_math(char *Buffer, char *Math);
 212 char* user_level_name_from_level(int level);
 213
 214 void process_adduser_pending(struct userNode *user);
 215 void wipe_adduser_pending(struct chanNode *channel, struct userNode *user);
 216
 217 #endif