[irc/evilnet/x3.git] / src / chanserv.h

/* chanserv.h - Channel service bot
 * Copyright 2000-2004 srvx Development Team
 *
 * This file is part of x3.
 *
 * x3 is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with srvx; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.
 */

#ifndef _chanserv_h
#define _chanserv_h

#include "nickserv.h"

enum UL_ALIASES {
    UL_PEON = 100,
    UL_HALFOP = 150,
    UL_OP = 200,
    UL_MANAGER = 300,
    UL_PRESENT = UL_MANAGER,
    UL_COOWNER = 400,
    UL_OWNER = 500,
    UL_HELPER = 600,
};

enum levelOption {
    lvlEnfOps,
    lvlEnfHalfOps,
    lvlEnfModes,
    lvlEnfTopic,
    lvlPubCmd,
    lvlSetters,
    lvlUserInfo,
    lvlInviteMe,
    lvlTopicSnarf,
    NUM_LEVEL_OPTIONS
};

enum charOption {
    chAutomode,
    chProtect,
    chToys,
    chTopicRefresh,
    chCTCPReaction,
    chBanTimeout,
    chResync,
    NUM_CHAR_OPTIONS
};

#define CHANNEL_NODELETE	0x00000001 /* (1 << 0) */
#define CHANNEL_SUSPENDED	0x00000002 /* (1 << 1) */
#define CHANNEL_INFO_LINES	0x00000004 /* (1 << 2) - DEPRECATED */
#define CHANNEL_VOICE_ALL    	0x00000008 /* (1 << 3) - DEPRECATED */

/* No longer used. */                      /* (1 << 4) */
#define CHANNEL_DYNAMIC_LIMIT	0x00000020 /* (1 << 5) */
#define CHANNEL_TOPIC_SNARF	0x00000040 /* (1 << 6) - DEPRECATED */
#define CHANNEL_PEON_INVITE     0x00000080 /* (1 << 7) - DEPRECATED */
#define CHANNEL_OFFCHANNEL      0x00000100 /* (1 << 8) */
#define CHANNEL_HOP_ALL         0x00000200 /* (1 << 9) */
/* Flags with values over 0x20000000 or (1 << 29) will not work
 * because chanData.flags is a 30-bit field.
 */

/* how many seconds a pending adduser will wait for a user
 * to get auth or register 
 */
#define ADDUSER_PENDING_EXPIRE 7200  /* 2 hours */

#define IsProtected(x)		((x)->flags & CHANNEL_NODELETE)
#define IsSuspended(x)		((x)->flags & CHANNEL_SUSPENDED)
#define IsOffChannel(x)         (((x)->flags & CHANNEL_OFFCHANNEL) && (off_channel > 1))

struct chanData
{
    struct chanNode	*channel;
    struct mod_chanmode modes;

    time_t		registered;
    time_t		visited;
    time_t 		limitAdjusted;
    time_t              ownerTransfer;

    char		*topic;
    char		*greeting;
    char		*user_greeting;
    char		*registrar;
    char                *topic_mask;

    unsigned int	flags : 30;
    unsigned int        may_opchan : 1;
    unsigned int        max;
    unsigned int        last_refresh;
    unsigned int        last_resync;
    unsigned short      banCount; /* Lamers, really */
    unsigned short      userCount;
    unsigned short      lvlOpts[NUM_LEVEL_OPTIONS];
    unsigned char       chOpts[NUM_CHAR_OPTIONS];

    struct userData	*users;
    struct banData	*bans; /* Lamers, really */
    struct dict         *notes;
    struct suspended	*suspended;
    struct giveownership *giveownership;
    struct chanData	*prev;
    struct chanData	*next;
};

#define USER_NOAUTO_OP          0x00000001 /* OLD; Not used at all.. */
#define USER_SUSPENDED          0x00000002
#define USER_AUTO_INVITE        0x00000004
#define USER_AUTO_OP            0x00000008
#define USER_FLAGS_SIZE         15
#define USER_FLAGS_DEFAULT      USER_AUTO_OP

#define IsUserAutoOp(USER)      ((USER)->flags & USER_AUTO_OP)
#define IsUserSuspended(USER)   ((USER)->flags & USER_SUSPENDED)
#define IsUserAutoInvite(USER)  ((USER)->flags & USER_AUTO_INVITE)

struct userData
{
    struct handle_info	*handle;
    struct chanData	*channel;

    char		*info;
    time_t 		seen;
    time_t              expires;
    unsigned short      access;
    unsigned int	present : 1;
    unsigned int        flags : USER_FLAGS_SIZE;

    /* linked list of userDatas for a chanData */
    struct userData	*prev;
    struct userData	*next;
    /* linked list of userDatas for a handle_info */
    struct userData     *u_prev;
    struct userData     *u_next;
};

struct adduserPending
{
    struct chanNode *channel;
    struct userNode *user;
    int level;
    time_t created;

    struct adduserPending *prev;
    struct adduserPending *next;
};

struct banData
{
    char		mask[NICKLEN + USERLEN + HOSTLEN + 3];
    char		owner[NICKLEN+1];
    struct chanData     *channel;

    time_t		set;
    time_t		triggered;
    time_t              expires;

    char		*reason;

    struct banData	*prev;
    struct banData	*next;
};

struct suspended
{
    struct chanData	*cData;
    char		*suspender;
    char                *reason;
    time_t              issued, expires, revoked;
    struct suspended    *previous;
};

struct giveownership
{
    char                 *staff_issuer;
    char                  *old_owner;
    char                  *target;
    unsigned short        target_access;
    time_t                issued;
    char                  *reason;
    struct giveownership  *previous;
};

struct do_not_register
{
    char   chan_name[CHANNELLEN+1];
    char   setter[NICKSERV_HANDLE_LEN+1];
    time_t set; 
    char   reason[1];
};

#define GetChannelUser(channel, handle) _GetChannelUser(channel, handle, 1, 0)
struct userData *_GetChannelUser(struct chanData *channel, struct handle_info *handle, int override, int allow_suspended);
struct banData *add_channel_ban(struct chanData *channel, const char *mask, char *owner, time_t set, time_t triggered, time_t expires, char *reason);

void init_chanserv(const char *nick);
void del_channel_user(struct userData *user, int do_gc);
struct channelList *chanserv_support_channels(void);
unsigned short user_level_from_name(const char *name, unsigned short clamp_level);
struct do_not_register *chanserv_is_dnr(const char *chan_name, struct handle_info *handle);
int check_user_level(struct chanNode *channel, struct userNode *user, enum levelOption opt, int allow_override, int exempt_owner);

void do_math(char *Buffer, char *Math);
char* user_level_name_from_level(int level);

void process_adduser_pending(struct userNode *user);
void wipe_adduser_pending(struct chanNode *channel, struct userNode *user);

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