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