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                     /* TODO: Does removing values here mess up reading the db files? */
  39     lvlGiveVoice,   /* Depreciated */
  40     lvlGiveHalfOps, /* Depreciated */
  41     lvlGiveOps, /* Depreciated */
  42     lvlEnfOps,
  43     lvlEnfHalfOps,
  44     lvlEnfModes,
  45     lvlEnfTopic,
  46     lvlPubCmd,
  47     lvlSetters,
  48     lvlCTCPUsers,
  49     lvlUserInfo,
  50     lvlInviteMe,
  51     lvlTopicSnarf,
  52     NUM_LEVEL_OPTIONS
  53 };
  54
  55 enum charOption {
  56     chProtect,
  57     chToys,
  58     chTopicRefresh,
  59     chCTCPReaction,
  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
  75 /* Flags with values over 0x20000000 or (1 << 29) will not work
  76  * because chanData.flags is a 30-bit field.
  77  */
  78
  79 #define IsProtected(x)          ((x)->flags & CHANNEL_NODELETE)
  80 #define IsSuspended(x)          ((x)->flags & CHANNEL_SUSPENDED)
  81 #define IsOffChannel(x)         (((x)->flags & CHANNEL_OFFCHANNEL) && (off_channel > 1))
  82
  83 struct chanData
  84 {
  85     struct chanNode     *channel;
  86     struct mod_chanmode modes;
  87
  88     time_t              registered;
  89     time_t              visited;
  90     time_t              limitAdjusted;
  91     time_t              ownerTransfer;
  92
  93     char                *topic;
  94     char                *greeting;
  95     char                *user_greeting;
  96     char                *registrar;
  97     char                *topic_mask;
  98
  99     unsigned int        flags : 30;
 100     unsigned int        may_opchan : 1;
 101     unsigned int        max;
 102     unsigned int        last_refresh;
 103     unsigned short      banCount;
 104     unsigned short      userCount;
 105     unsigned short      lvlOpts[NUM_LEVEL_OPTIONS];
 106     unsigned char       chOpts[NUM_CHAR_OPTIONS];
 107
 108     struct userData     *users;
 109     struct banData      *bans;
 110     struct dict         *notes;
 111     struct suspended    *suspended;
 112     struct chanData     *prev;
 113     struct chanData     *next;
 114 };
 115
 116 #define USER_AUTO_OP            0x00000001
 117 #define USER_SUSPENDED          0x00000002
 118 #define USER_AUTO_INVITE        0x00000004
 119 #define USER_FLAGS_SIZE         7
 120
 121 #define IsUserAutoOp(USER)      (!((USER)->flags & USER_AUTO_OP))
 122 #define IsUserSuspended(USER)   ((USER)->flags & USER_SUSPENDED)
 123 #define IsUserAutoInvite(USER)  ((USER)->flags & USER_AUTO_INVITE)
 124
 125 struct userData
 126 {
 127     struct handle_info  *handle;
 128     struct chanData     *channel;
 129
 130     char                *info;
 131     time_t              seen;
 132     unsigned short      access;
 133     unsigned int        present : 1;
 134     unsigned int        flags : USER_FLAGS_SIZE;
 135
 136     /* linked list of userDatas for a chanData */
 137     struct userData     *prev;
 138     struct userData     *next;
 139     /* linked list of userDatas for a handle_info */
 140     struct userData     *u_prev;
 141     struct userData     *u_next;
 142 };
 143
 144 struct banData
 145 {
 146     char                mask[NICKLEN + USERLEN + HOSTLEN + 3];
 147     char                owner[NICKLEN+1];
 148     struct chanData     *channel;
 149
 150     time_t              set;
 151     time_t              triggered;
 152     time_t              expires;
 153
 154     char                *reason;
 155
 156     struct banData      *prev;
 157     struct banData      *next;
 158 };
 159
 160 struct suspended
 161 {
 162     struct chanData     *cData;
 163     char                *suspender;
 164     char                *reason;
 165     time_t              issued, expires, revoked;
 166     struct suspended    *previous;
 167 };
 168
 169 struct do_not_register
 170 {
 171     char   chan_name[CHANNELLEN+1];
 172     char   setter[NICKSERV_HANDLE_LEN+1];
 173     time_t set;
 174     char   reason[1];
 175 };
 176
 177 void init_chanserv(const char *nick);
 178 void del_channel_user(struct userData *user, int do_gc);
 179 struct channelList *chanserv_support_channels(void);
 180 unsigned short user_level_from_name(const char *name, unsigned short clamp_level);
 181 struct do_not_register *chanserv_is_dnr(const char *chan_name, struct handle_info *handle);
 182 int check_user_level(struct chanNode *channel, struct userNode *user, enum levelOption opt, int allow_override, int exempt_owner);
 183
 184 void do_math(char *Buffer, char *Math);
 185 char* user_level_name_from_level(int level);
 186
 187
 188 #endif