Debian Codegraph @

include/services.h

raw
1 /*
2 * Copyright (C) 2005 William Pitcock, et al.
3 * Rights to this code are as documented in doc/LICENSE.
4 *
5 * Data structures related to services psuedo-clients.
6 *
7 */
8
9 #ifndef SERVICES_H
10 #define SERVICES_H
11
12 typedef struct chansvs_ chansvs_t;
13 typedef struct nicksvs_ nicksvs_t;
14
15 /* The nick/user/host/real strings in these structs simply point
16 * to their counterparts in the service_t, and will probably be removed
17 * at some point.
18 */
19 /* core services */
20 struct chansvs_
21 {
22 char *nick; /* the IRC client's nickname */
23 char *user; /* the IRC client's username */
24 char *host; /* the IRC client's hostname */
25 char *real; /* the IRC client's realname */
26
27 bool fantasy; /* enable fantasy commands */
28
29 char *trigger; /* trigger, e.g. !, ` or . */
30
31 bool changets; /* use TS to better deop people */
32
33 service_t *me; /* our user_t struct */
34
35 unsigned int expiry; /* expiry time */
36
37 unsigned int akick_time; /* default akick duration */
38
39 unsigned int maxchans; /* max channels one can register */
40 unsigned int maxchanacs; /* max entries in chanacs list */
41 unsigned int maxfounders; /* max founders per channel */
42
43 char *founder_flags; /* default founder flags for new channels */
44
45 char *deftemplates; /* default templates */
46
47 bool hide_xop; /* hide XOP templates */
48 };
49
50 /* authentication services */
51 struct nicksvs_
52 {
53 bool spam;
54 bool no_nick_ownership;
55
56 char *nick;
57 char *user;
58 char *host;
59 char *real;
60
61 service_t *me;
62
63 unsigned int maxnicks; /* max nicknames one can group */
64 unsigned int expiry; /* expiry time */
65 unsigned int enforce_expiry; /* expiry time */
66 unsigned int enforce_delay; /* delay for nickname enforce */
67 char *enforce_prefix; /* prefix for enforcement */
68 char *cracklib_dict; /* cracklib dictionary path */
69 mowgli_list_t emailexempts; /* emails exempt from maxusers checks */
70 };
71
72 /* help us keep consistent messages */
73 #define STR_INSUFFICIENT_PARAMS _("Insufficient parameters for \2%s\2.")
74 #define STR_INVALID_PARAMS _("Invalid parameters for \2%s\2.")
75 #define STR_NO_PRIVILEGE _("You do not have the %s privilege.")
76
77 /* for command_add_flood(),
78 * note that floodcheck() already does one FLOOD_MSGS_FACTOR
79 */
80 #define FLOOD_HEAVY (3 * FLOOD_MSGS_FACTOR)
81 #define FLOOD_MODERATE FLOOD_MSGS_FACTOR
82 #define FLOOD_LIGHT 0
83
84 /* atheme.c */
85 E chansvs_t chansvs;
86 E nicksvs_t nicksvs;
87
88 /* services.c */
89 E int authservice_loaded;
90 E int use_myuser_access;
91 E int use_svsignore;
92 E int use_privmsg;
93 E int use_account_private;
94 E int use_channel_private;
95 E int use_limitflags;
96
97 E int ban(user_t *source, channel_t *chan, user_t *target);
98 E int remove_banlike(user_t *source, channel_t *chan, int type, user_t *target);
99 E int remove_ban_exceptions(user_t *source, channel_t *chan, user_t *target);
100
101 E void try_kick_real(user_t *source, channel_t *chan, user_t *target, const char *reason);
102 E void (*try_kick)(user_t *source, channel_t *chan, user_t *target, const char *reason);
103
104 E void kill_user(user_t *source, user_t *victim, const char *fmt, ...) PRINTFLIKE(3, 4);
105 E void introduce_enforcer(const char *nick);
106 E void join(const char *chan, const char *nick);
107 E void joinall(const char *name);
108 E void part(const char *chan, const char *nick);
109 E void partall(const char *name);
110 E void myuser_login(service_t *svs, user_t *u, myuser_t *mu, bool sendaccount);
111 E void verbose(mychan_t *mychan, const char *fmt, ...) PRINTFLIKE(2, 3);
112 E void (*notice)(const char *from, const char *target, const char *fmt, ...) PRINTFLIKE(3, 4);
113 E void change_notify(const char *from, user_t *to, const char *message, ...) PRINTFLIKE(3, 4);
114 E bool bad_password(sourceinfo_t *si, myuser_t *mu);
115
116 E sourceinfo_t *sourceinfo_create(void);
117 E void command_fail(sourceinfo_t *si, cmd_faultcode_t code, const char *fmt, ...) PRINTFLIKE(3, 4);
118 E void command_success_nodata(sourceinfo_t *si, const char *fmt, ...) PRINTFLIKE(2, 3);
119 E void command_success_string(sourceinfo_t *si, const char *result, const char *fmt, ...) PRINTFLIKE(3, 4);
120 E void command_success_table(sourceinfo_t *si, table_t *table);
121 E const char *get_source_name(sourceinfo_t *si);
122 E const char *get_source_mask(sourceinfo_t *si);
123 E const char *get_oper_name(sourceinfo_t *si);
124 E const char *get_storage_oper_name(sourceinfo_t *si);
125 E const char *get_source_security_label(sourceinfo_t *si);
126
127 E void wallops(const char *, ...) PRINTFLIKE(1, 2);
128 E void verbose_wallops(const char *, ...) PRINTFLIKE(1, 2);
129 E bool check_vhost_validity(sourceinfo_t *si, const char *host);
130
131 /* ptasks.c */
132 E void handle_topic(channel_t *, const char *, time_t, const char *);
133 E int floodcheck(user_t *, user_t *);
134 E void command_add_flood(sourceinfo_t *si, unsigned int amount);
135
136 /* ctcp-common.c */
137 E void common_ctcp_init(void);
138 E unsigned int handle_ctcp_common(sourceinfo_t *si, char *, char *);
139
140 /* qrcode.c */
141 E void command_success_qrcode(sourceinfo_t *si, const char *data);
142
143 #endif
144
145 /* vim:cinoptions=>s,e0,n0,f0,{0,}0,^0,=s,ps,t0,c3,+s,(2s,us,)20,*30,gs,hs
146 * vim:ts=8
147 * vim:sw=8
148 * vim:noexpandtab
149 */