1 | /* |
1 | /* |
2 | * Copyright © 2003-2004 E. Will et al. |
2 | * Copyright © 2003-2004 E. Will et al. |
3 | * Copyright © 2005-2006 Atheme Development Group |
3 | * Copyright © 2005-2006 Atheme Development Group |
4 | * Rights to this code are as documented in doc/pod/license.pod. |
4 | * Rights to this code are as documented in doc/pod/license.pod. |
5 | * |
5 | * |
6 | * Misc tools |
6 | * Misc tools |
7 | * |
7 | * |
8 | * $Id: tools.h,v 1.3 2007/07/25 00:03:21 pippijn Exp $ |
8 | * $Id: tools.h,v 1.4 2007/08/28 17:08:07 pippijn Exp $ |
9 | */ |
9 | */ |
10 | |
10 | |
11 | #ifndef _TOOLS_H |
11 | #ifndef _TOOLS_H |
12 | #define _TOOLS_H |
12 | #define _TOOLS_H |
13 | |
13 | |
… | |
… | |
77 | return; \ |
77 | return; \ |
78 | } |
78 | } |
79 | #endif |
79 | #endif |
80 | |
80 | |
81 | /* |
81 | /* |
82 | * Same as soft_assert, but returns a given value if an assertion fails. |
82 | * Same as return_if_fail, but returns a given value if an assertion fails. |
83 | */ |
83 | */ |
84 | #ifdef __GNUC__ |
84 | #ifdef __GNUC__ |
85 | #define return_val_if_fail(x, y) \ |
85 | #define return_val_if_fail(x, y) \ |
86 | if (!(x)) { \ |
86 | if (!(x)) { \ |
87 | slog(LG_INFO, "%s(%d) [%s]: critical: Assertion '%s' failed.", \ |
87 | slog(LG_INFO, "%s(%d) [%s]: critical: Assertion '%s' failed.", \ |
… | |
… | |
113 | |
113 | |
114 | void *miscellaneous; /* module defined data */ |
114 | void *miscellaneous; /* module defined data */ |
115 | void (*callback_sent) (email_t *); /* callback on email send */ |
115 | void (*callback_sent) (email_t *); /* callback on email send */ |
116 | }; |
116 | }; |
117 | |
117 | |
118 | E int sendemail (user_t *from, int type, myuser_t *mu, const char *param); |
118 | E int sendemail (user_t *from, int type, myuser_t *mu, char const * const param); |
119 | |
119 | |
120 | /* email types (meaning of param argument) */ |
120 | /* email types (meaning of param argument) */ |
121 | #define EMAIL_REGISTER 1 /* register an account/nick (verification code) */ |
121 | #define EMAIL_REGISTER 1 /* register an account/nick (verification code) */ |
122 | #define EMAIL_SENDPASS 2 /* send a password to a user (password) */ |
122 | #define EMAIL_SENDPASS 2 /* send a password to a user (password) */ |
123 | #define EMAIL_SETEMAIL 3 /* change email address (verification code) */ |
123 | #define EMAIL_SETEMAIL 3 /* change email address (verification code) */ |
124 | #define EMAIL_MEMO 4 /* emailed memos (memo text) */ |
124 | #define EMAIL_MEMO 4 /* emailed memos (memo text) */ |
125 | #define EMAIL_SETPASS 5 /* send a password change key (verification code) */ |
125 | #define EMAIL_SETPASS 5 /* send a password change key (verification code) */ |
126 | |
126 | |
127 | /* arc4random.c */ |
127 | /* logstreams API --nenolod */ |
128 | #ifndef HAVE_ARC4RANDOM |
|
|
129 | E void arc4random_stir (void); |
|
|
130 | E void arc4random_addrandom (unsigned char *dat, int datlen); |
|
|
131 | E unsigned int arc4random (void); |
|
|
132 | #endif /* !HAVE_ARC4RANDOM */ |
|
|
133 | |
|
|
134 | struct logfile_t; |
128 | struct logfile_t; |
135 | |
129 | |
136 | /* logstreams API --nenolod */ |
|
|
137 | typedef void (*log_write_func_t) (logfile_t *lf, const char *buf); |
130 | typedef void (*log_write_func_t) (logfile_t *lf, char const * const buf); |
138 | |
131 | |
139 | /* logger.c */ |
132 | /* logger.c */ |
140 | struct logfile_t |
133 | struct logfile_t : zero_initialised |
141 | { |
134 | { |
142 | object_t parent; |
135 | object_t parent; |
143 | node_t node; |
136 | node_t node; |
144 | |
137 | |
145 | void *log_file; /* opaque: can either be mychan_t or FILE --nenolod */ |
138 | void *log_file; /* opaque: can either be mychan_t or FILE --nenolod */ |
… | |
… | |
150 | }; |
143 | }; |
151 | |
144 | |
152 | E char *log_path; /* contains path to default log. */ |
145 | E char *log_path; /* contains path to default log. */ |
153 | E int log_force; |
146 | E int log_force; |
154 | |
147 | |
155 | E logfile_t *logfile_new (const char *log_path_, unsigned int log_mask); |
148 | E logfile_t *logfile_new (char const * const log_path_, unsigned int log_mask); |
156 | E void logfile_write (logfile_t *lf, const char *buf); |
149 | E void logfile_write (logfile_t *lf, char const * const buf); |
157 | E void logfile_register (logfile_t *lf); |
150 | E void logfile_register (logfile_t *lf); |
158 | E void logfile_unregister (logfile_t *lf); |
151 | E void logfile_unregister (logfile_t *lf); |
159 | |
152 | |
160 | /* general */ |
153 | /* general */ |
161 | #define LG_NONE 0x00000001 /* don't log */ |
154 | #define LG_NONE 0x00000001 /* don't log */ |
… | |
… | |
191 | |
184 | |
192 | E void log_open (void); |
185 | E void log_open (void); |
193 | E void log_shutdown (void); |
186 | E void log_shutdown (void); |
194 | E bool log_debug_enabled (void); |
187 | E bool log_debug_enabled (void); |
195 | E void log_master_set_mask (unsigned int mask); |
188 | E void log_master_set_mask (unsigned int mask); |
196 | E void slog (unsigned int level, const char *fmt, ...); |
189 | E void slog (unsigned int level, char const * const fmt, ...); |
197 | E void logcommand (sourceinfo_t *si, int level, const char *fmt, ...); |
190 | E void logcommand (sourceinfo_t *si, int level, char const * const fmt, ...); |
198 | E void logcommand_user (service_t *svs, user_t *source, int level, const char *fmt, ...); |
191 | E void logcommand_user (service_t *svs, user_t *source, int level, char const * const fmt, ...); |
199 | E void logcommand_external (service_t *svs, const char *type, connection_t *source, const char *sourcedesc, myuser_t *login, int level, const char *fmt, ...); |
192 | E void logcommand_external (service_t *svs, char const * const type, connection_t *source, char const * const sourcedesc, myuser_t *login, int level, char const * const fmt, ...); |
200 | |
193 | |
201 | /* function.c */ |
194 | /* function.c */ |
202 | /* misc string stuff */ |
195 | /* misc string stuff */ |
203 | E char *gen_pw (int sz); |
196 | E char *gen_pw (int sz); |
204 | E void tb2sp (char *line); |
197 | E void tb2sp (char *line); |
205 | E char *replace (char *s, int size, const char *oldstr, const char *newstr); |
198 | E char *replace (char *s, int size, char const * const oldstr, char const * const newstr); |
206 | E char *itoa (int num); |
199 | E char *itoa (int num); |
207 | E int validemail (char *email); |
200 | E int validemail (char *email); |
208 | E bool validhostmask (char *host); |
201 | E bool validhostmask (char *host); |
209 | E char *sbytes (float x); |
202 | E char const *sbytes (float x); |
210 | E float bytes (float x); |
203 | E float bytes (float x); |
211 | |
204 | |
212 | E unsigned long makekey (void); |
205 | E unsigned long makekey (void); |
213 | |
|
|
214 | /* the hash function */ |
|
|
215 | E unsigned int shash (const unsigned char *text); |
|
|
216 | |
206 | |
217 | /* time stuff */ |
207 | /* time stuff */ |
218 | #if HAVE_GETTIMEOFDAY |
208 | #if HAVE_GETTIMEOFDAY |
219 | E void s_time (struct timeval *sttime); |
209 | E void s_time (struct timeval *sttime); |
220 | E void e_time (struct timeval sttime, struct timeval *ttime); |
210 | E void e_time (struct timeval sttime, struct timeval *ttime); |
… | |
… | |
238 | /* tokenize.c */ |
228 | /* tokenize.c */ |
239 | E int sjtoken (char *message, char delimiter, char **parv, int limit = 256); |
229 | E int sjtoken (char *message, char delimiter, char **parv, int limit = 256); |
240 | E int tokenize (char *message, char **parv); |
230 | E int tokenize (char *message, char **parv); |
241 | |
231 | |
242 | /* ubase64.c */ |
232 | /* ubase64.c */ |
243 | E const char *uinttobase64 (char *buf, uint64_t v, int64_t count); |
233 | E char const * const uinttobase64 (char *buf, uint64_t v, int64_t count); |
244 | E unsigned int base64touint (char *buf); |
234 | E unsigned int base64touint (char *buf); |
245 | |
235 | |
246 | #endif |
236 | #endif |