1 /* nickserv.h - Nick/authentiction service
2 * Copyright 2000-2004 srvx Development Team
4 * This file is part of x3.
6 * x3 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.
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.
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.
24 #include "hash.h" /* for NICKLEN, etc., and common.h */
27 #define NICKSERV_HANDLE_LEN ACCOUNTLEN
30 /* HI_FLAG_* go into handle_info.flags */
31 #define HI_FLAG_OPER_SUSPENDED 0x00000001
32 #define HI_FLAG_USE_PRIVMSG 0x00000002
33 #define HI_FLAG_SUPPORT_HELPER 0x00000004
34 #define HI_FLAG_HELPING 0x00000008
35 #define HI_FLAG_SUSPENDED 0x00000010
36 #define HI_FLAG_MIRC_COLOR 0x00000020
37 #define HI_FLAG_FROZEN 0x00000040
38 #define HI_FLAG_NODELETE 0x00000080
39 #define HI_FLAG_NETWORK_HELPER 0x00000100
40 #define HI_FLAG_BOT 0x00000200
41 #define HI_FLAG_AUTOHIDE 0x00000400
42 #define HI_FLAG_ADVANCED 0x00000800
43 /* Flag characters for the above. First char is LSB, etc. */
44 #define HANDLE_FLAGS "SphgscfnHbx"
46 /* HI_STYLE_* go into handle_info.userlist_style */
47 #define HI_STYLE_NORMAL 'n'
48 #define HI_STYLE_CLEAN 'c'
49 #define HI_STYLE_ADVANCED 'a'
50 #define HI_STYLE_CLASSIC 'k'
52 #define HI_DEFAULT_FLAGS (HI_FLAG_MIRC_COLOR)
54 /* This is overridden by conf file */
55 #define HI_DEFAULT_STYLE HI_STYLE_NORMAL
57 #define HANDLE_FLAGGED(hi, tok) ((hi)->flags & HI_FLAG_##tok)
58 #define HANDLE_SET_FLAG(hi, tok) ((hi)->flags |= HI_FLAG_##tok)
59 #define HANDLE_TOGGLE_FLAG(hi, tok) ((hi)->flags ^= HI_FLAG_##tok)
60 #define HANDLE_CLEAR_FLAG(hi, tok) ((hi)->flags &= ~HI_FLAG_##tok)
62 #define IsSupportHelper(user) (user->handle_info && HANDLE_FLAGGED(user->handle_info, SUPPORT_HELPER))
63 #define IsNetworkHelper(user) (user->handle_info && HANDLE_FLAGGED(user->handle_info, NETWORK_HELPER))
64 #define IsHelper(user) (IsSupportHelper(user) || IsNetworkHelper(user))
65 #define IsHelping(user) (user->handle_info && HANDLE_FLAGGED(user->handle_info, HELPING))
66 #define IsStaff(user) (IsOper(user) || IsSupportHelper(user) || IsNetworkHelper(user))
67 #define IsBot(user) (user->handle_info && HANDLE_FLAGGED(user->handle_info, BOT))
76 struct handle_cookie
{
77 struct handle_info
*hi
;
79 enum cookie_type type
;
81 char cookie
[COOKIELEN
+1];
85 char setter
[NICKSERV_HANDLE_LEN
+1];
91 struct nick_info
*nicks
;
92 struct string_list
*masks
;
93 struct string_list
*ignores
;
94 struct userNode
*users
;
95 struct userData
*channels
;
96 struct handle_cookie
*cookie
;
97 struct handle_note
*note
;
98 struct language
*language
;
106 unsigned short flags
;
107 unsigned short opserv_level
;
108 unsigned short screen_width
;
109 unsigned short table_width
;
110 unsigned char userlist_style
;
111 unsigned char announcements
;
112 unsigned char maxlogins
;
113 char passwd
[MD5_CRYPT_LENGTH
+1];
114 char last_quit_host
[USERLEN
+HOSTLEN
+2];
118 struct handle_info
*owner
;
119 struct nick_info
*next
; /* next nick owned by same handle */
120 char nick
[NICKLEN
+1];
123 struct handle_info_list
{
124 unsigned int used
, size
;
125 struct handle_info
**list
;
126 char *tag
; /* e.g. email address */
129 extern const char *handle_flags
;
131 void init_nickserv(const char *nick
);
132 struct handle_info
*get_handle_info(const char *handle
);
133 struct handle_info
*smart_get_handle_info(struct userNode
*service
, struct userNode
*user
, const char *name
);
134 int oper_try_set_access(struct userNode
*user
, struct userNode
*bot
, struct handle_info
*target
, unsigned int new_level
);
135 int oper_outranks(struct svccmd
*cmd
, struct userNode
*user
, struct handle_info
*hi
);
136 struct nick_info
*get_nick_info(const char *nick
);
137 struct modeNode
*find_handle_in_channel(struct chanNode
*channel
, struct handle_info
*handle
, struct userNode
*except
);
138 int nickserv_modify_handle_flags(struct userNode
*user
, struct userNode
*bot
, const char *str
, unsigned long *add
, unsigned long *remove
);
139 int oper_has_access(struct userNode
*user
, struct userNode
*bot
, unsigned int min_level
, unsigned int quiet
);
140 void nickserv_show_oper_accounts(struct userNode
*user
, struct svccmd
*cmd
);
142 struct handle_info
*get_victim_oper(struct svccmd
*cmd
, struct userNode
*user
, const char *target
);
143 struct handle_info
*loc_auth(char *handle
, char *password
);
145 typedef void (*user_mode_func_t
)(struct userNode
*user
, const char *mode_change
);
146 void reg_user_mode_func(user_mode_func_t func
);
147 typedef void (*channel_mode_func_t
)(struct userNode
*who
, struct chanNode
*channel
, char **mode
, unsigned int argc
);
148 void reg_channel_mode_func(channel_mode_func_t func
);
150 /* auth_funcs are called when a user gets a new handle_info. They are
151 * called *after* user->handle_info has been updated. */
152 typedef void (*auth_func_t
)(struct userNode
*user
, struct handle_info
*old_handle
);
153 void reg_auth_func(auth_func_t func
);
155 /* Called just after a handle is renamed. */
156 typedef void (*handle_rename_func_t
)(struct handle_info
*handle
, const char *old_handle
);
157 void reg_handle_rename_func(handle_rename_func_t func
);
159 /* unreg_funcs are called right before a handle is unregistered.
160 * `user' is the person who caused the handle to be unregistered (either a
161 * client authed to the handle, or an oper). */
162 typedef void (*unreg_func_t
)(struct userNode
*user
, struct handle_info
*handle
);
163 void reg_unreg_func(unreg_func_t func
);
165 /* Called just before a handle is merged */
166 typedef void (*handle_merge_func_t
)(struct userNode
*user
, struct handle_info
*handle_to
, struct handle_info
*handle_from
);
167 void reg_handle_merge_func(handle_merge_func_t
);
169 /* Called after an allowauth. handle is null if allowauth authorization was
171 typedef void (*allowauth_func_t
)(struct userNode
*user
, struct userNode
*target
, struct handle_info
*handle
);
172 void reg_allowauth_func(allowauth_func_t func
);
174 /* Called when an auth attempt fails because of a bad password */
175 typedef void (*failpw_func_t
)(struct userNode
*user
, struct handle_info
*handle
);
176 void reg_failpw_func(failpw_func_t func
);
178 void send_func_list(struct userNode
*user
);