]> jfr.im git - irc/evilnet/x3.git/blame - src/common.h
Minor typo in previous commit where returning 0 when it should have been 1 from opser...
[irc/evilnet/x3.git] / src / common.h
CommitLineData
d76ed9a9 1/* common.h - Common functions/includes
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 7 * it under the terms of the GNU General Public License as published by
348683aa 8 * the Free Software Foundation; either version 3 of the License, or
d76ed9a9 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 COMMON_H
22#define COMMON_H
23
24#include "compat.h"
25#include "proto.h"
26
27#if !defined(HAVE_LOCALTIME_R) && !defined(__CYGWIN__)
28extern struct tm *localtime_r(const time_t *clock, struct tm *res);
29#elif defined(__CYGWIN__)
30# define localtime_r(clock, res) memcpy(res, localtime(clock), sizeof(struct tm));
31#endif
32
33#ifndef true
34#define true 1
35#endif
36
37#ifndef false
38#define false 0
39#endif
40
d76ed9a9 41#define ArrayLength(x) (sizeof(x)/sizeof(x[0]))
42#define safestrncpy(dest, src, len) do { char *d = (dest); const char *s = (src); size_t l = strlen(s)+1; if ((len) < l) l = (len); memmove(d, s, l); d[l-1] = 0; } while (0)
43
1136f709 44#if __GNUC__
d76ed9a9 45#define PRINTF_LIKE(M,N) __attribute__((format (printf, M, N)))
46#else
47#define PRINTF_LIKE(M,N)
48#endif
49
50#if __GNUC__ >= 2
51#define UNUSED_ARG(ARG) ARG __attribute__((unused))
52#elif defined(S_SPLINT_S)
53#define UNUSED_ARG(ARG) /*@unused@*/ ARG
54#define const /*@observer@*/ /*@temp@*/
55#else
56#define UNUSED_ARG(ARG) ARG
57#endif
58
1136f709 59#if defined(__GNUC__) && (__GNUC__ < 3)
60# define GCC_VARMACROS 1
61#elif !defined(S_SPLINT_S)
62# define C99_VARMACROS 1
63#endif
64
d76ed9a9 65#if defined(WITH_MALLOC_DMALLOC)
ec1a68c8 66# define DMALLOC_FUNC_CHECK 1
67# include <string.h>
68# include <dmalloc.h>
d76ed9a9 69#elif defined(WITH_MALLOC_MPATROL)
ec1a68c8 70# include <string.h>
71# include <mpatrol.h>
d76ed9a9 72#elif defined(WITH_MALLOC_BOEHM_GC)
ec1a68c8 73# if !defined(NDEBUG)
74# define GC_DEBUG 1
75# endif
76# include <stdlib.h>
77# include <string.h>
78# include <gc/gc.h>
79# define malloc(n) GC_MALLOC(n)
80# define calloc(m,n) GC_MALLOC((m)*(n))
81# define realloc(p,n) GC_REALLOC((p),(n))
82# define free(p) GC_FREE(p)
83# undef HAVE_STRDUP
84# undef strdup
921592dd 85#elif defined(WITH_MALLOC_X3)
ec1a68c8 86# undef malloc
921592dd 87# define malloc(n) x3_malloc(__FILE__, __LINE__, (n))
ec1a68c8 88# undef calloc
921592dd 89# define calloc(m,n) x3_malloc(__FILE__, __LINE__, (m)*(n))
ec1a68c8 90# undef realloc
921592dd 91# define realloc(p,n) x3_realloc(__FILE__, __LINE__, (p), (n))
ec1a68c8 92# undef free
921592dd 93# define free(p) x3_free(__FILE__, __LINE__, (p))
ec1a68c8 94# undef strdup
921592dd 95# define strdup(s) x3_strdup(__FILE__, __LINE__, (s))
96extern void *x3_malloc(const char *, unsigned int, size_t);
97extern void *x3_realloc(const char *, unsigned int, void *, size_t);
98extern char *x3_strdup(const char *, unsigned int, const char *);
99extern void x3_free(const char *, unsigned int, void *);
ec1a68c8 100# if !defined(NDEBUG)
101extern void verify(const void *ptr);
102# define verify(x) verify(x)
103# endif
c9bf23fe 104
0d16e639 105#elif defined(WITH_MALLOC_SLAB)
106# define malloc(n) slab_malloc(__FILE__, __LINE__, (n))
107# undef calloc
108# define calloc(m,n) slab_malloc(__FILE__, __LINE__, (m)*(n))
109# undef realloc
110# define realloc(p,n) slab_realloc(__FILE__, __LINE__, (p), (n))
111# undef free
112# define free(p) slab_free(__FILE__, __LINE__, (p))
113# undef strdup
114# define strdup(s) slab_strdup(__FILE__, __LINE__, (s))
115extern void *slab_malloc(const char *, unsigned int, size_t);
116extern void *slab_realloc(const char *, unsigned int, void *, size_t);
117extern char *slab_strdup(const char *, unsigned int, const char *);
118extern void slab_free(const char *, unsigned int, void *);
119# if !defined(NDEBUG)
120extern void verify(const void *ptr);
121# define verify(x) verify(x)
122# endif
d76ed9a9 123#endif
ec1a68c8 124
125#ifndef verify
126# define verify(ptr) (void)(ptr)
d76ed9a9 127#endif
128
c9bf23fe 129extern char *x3_msnprintf(const int size, const char *format, ...);
130#define msnprintf x3_msnprintf
131
d76ed9a9 132extern time_t now;
133extern int quit_services;
134extern struct log_type *MAIN_LOG;
135
2f61d1d7 136typedef union irc_in_addr {
137 uint32_t in6_32[4];
138 uint16_t in6[8];
139 uint8_t in6_8[16];
140} irc_in_addr_t;
141
142#define irc_in_addr_is_valid(ADDR) (((ADDR).in6[0] && (ADDR).in6[0] != 65535) \
143 || (ADDR).in6[1] != (ADDR).in6[0] \
144 || (ADDR).in6[2] != (ADDR).in6[0] \
145 || (ADDR).in6[3] != (ADDR).in6[0] \
146 || (ADDR).in6[4] != (ADDR).in6[0] \
147 || (ADDR).in6[5] != (ADDR).in6[0] \
148 || (ADDR).in6[6] != (ADDR).in6[0] \
149 || (ADDR).in6[7] != (ADDR).in6[0])
150#define irc_in_addr_is_ipv4(ADDR) (!(ADDR).in6[0] && !(ADDR).in6[1] \
151 && !(ADDR).in6[2] && !(ADDR).in6[3] \
152 && !(ADDR).in6[4] && (ADDR).in6[6] \
153 && (!(ADDR).in6[5] || (ADDR).in6[5] == 65535))
154#define irc_in_addr_is_ipv6(ADDR) !irc_in_addr_is_ipv4(ADDR)
155#define irc_in_addr_is_loopback(ADDR) (irc_in_addr_is_ipv4(ADDR) ? (ADDR).in6_8[12] == 127 \
156 : (ADDR).in6[0] == 0 && (ADDR).in6[1] == 0 \
157 && (ADDR).in6[2] == 0 && (ADDR).in6[3] == 0 \
158 && (ADDR).in6[4] == 0 && (ADDR).in6[5] == 0 \
159 && (ADDR).in6[6] == 0 && (ADDR).in6[7] == 1)
160#define IRC_NTOP_MAX_SIZE 40
161unsigned int irc_ntop(char *output, unsigned int out_size, const irc_in_addr_t *addr);
162#define IRC_NTOP_MASK_MAX_SIZE (IRC_NTOP_MAX_SIZE + 4)
163unsigned int irc_ntop_mask(char *output, unsigned int out_size, const irc_in_addr_t *addr, unsigned char bits);
164unsigned int irc_pton(irc_in_addr_t *addr, unsigned char *bits, const char *input);
165unsigned int irc_check_mask(const irc_in_addr_t *check, const irc_in_addr_t *mask, unsigned char bits);
166const char *irc_ntoa(const irc_in_addr_t *addr);
167
d76ed9a9 168int create_socket_client(struct uplinkNode *target);
169void close_socket(void);
170
30874d66 171typedef void (*exit_func_t)(void *extra);
172void reg_exit_func(exit_func_t handler, void *extra);
d76ed9a9 173void call_exit_funcs(void);
174
2aef5f4b 175char *mysep(char **sepstr, char *delim);
d76ed9a9 176const char *inttobase64(char *buf, unsigned int v, unsigned int count);
177unsigned long base64toint(const char *s, int count);
178int split_line(char *line, int irc_colon, int argv_size, char *argv[]);
179
180/* match_ircglobs(oldglob, newglob) returns non-zero if oldglob is a superset of newglob */
181#define match_ircglobs !mmatch
182int mmatch(const char *glob, const char *newglob);
183int match_ircglob(const char *text, const char *glob);
2f61d1d7 184#define MATCH_USENICK 1
185#define MATCH_VISIBLE 2
277ad996 186int user_matches_glob(struct userNode *user, const char *glob, int flags, int shared);
d1a65675 187int is_overmask(char *mask);
188
d76ed9a9 189
190int is_ircmask(const char *text);
191int is_gline(const char *text);
d914d1cb 192int is_shun(const char *text);
d76ed9a9 193
194char *sanitize_ircmask(char *text);
195
196unsigned long ParseInterval(const char *interval);
197unsigned long ParseVolume(const char *volume);
d76ed9a9 198
199#define MD5_CRYPT_LENGTH 42
200/* buffer[] must be at least MD5_CRYPT_LENGTH bytes long */
201const char *cryptpass(const char *pass, char buffer[]);
202int checkpass(const char *pass, const char *crypt);
203
204int split_ircmask(char *text, char **nick, char **ident, char **host);
205char *unsplit_string(char *set[], unsigned int max, char *dest);
63665495 206extern char* x3_strtok(char** save, char* str, char* fs);
d76ed9a9 207
4c26ef3e 208int valid_email(const char *email);
209
d76ed9a9 210#define DECLARE_LIST(STRUCTNAME,ITEMTYPE) struct STRUCTNAME {\
211 unsigned int used, size;\
212 ITEMTYPE *list;\
213};\
214void STRUCTNAME##_init(struct STRUCTNAME *list);\
215void STRUCTNAME##_append(struct STRUCTNAME *list, ITEMTYPE new_item);\
216int STRUCTNAME##_remove(struct STRUCTNAME *list, ITEMTYPE new_item);\
217void STRUCTNAME##_clean(struct STRUCTNAME *list)
218
219#define DEFINE_LIST(STRUCTNAME,ITEMTYPE) \
220void STRUCTNAME##_init(struct STRUCTNAME *list) {\
221 list->used = 0;\
222 list->size = 8;\
223 list->list = malloc(list->size*sizeof(list->list[0]));\
224}\
225void STRUCTNAME##_append(struct STRUCTNAME *list, ITEMTYPE new_item) {\
ec1a68c8 226 verify(list->list);\
d76ed9a9 227 if (list->used == list->size) {\
228 list->size = list->size ? (list->size << 1) : 4;\
229 list->list = realloc(list->list, list->size*sizeof(list->list[0]));\
230 }\
231 list->list[list->used++] = new_item;\
232}\
233int STRUCTNAME##_remove(struct STRUCTNAME *list, ITEMTYPE new_item) {\
234 unsigned int n, found;\
ec1a68c8 235 verify(list->list);\
d76ed9a9 236 for (found=n=0; n<list->used; n++) {\
237 if (list->list[n] == new_item) {\
238 memmove(list->list+n, list->list+n+1, (list->used-n-1)*sizeof(list->list[n]));\
239 found = 1;\
240 list->used--;\
241 }\
242 }\
243 return found;\
244}\
245void STRUCTNAME##_clean(struct STRUCTNAME *list) {\
246 list->used = list->size = 0;\
247 free(list->list);\
ec1a68c8 248 list->list = NULL;\
d76ed9a9 249}
250
251/* The longest string that is likely to be produced in English is "10
252 * minutes, and 10 seconds" (27 characters). Other languages will
253 * vary, so there's plenty of leeway.
254 */
255#define INTERVALLEN 50
256
257struct handle_info;
258char *intervalString(char *output, time_t interval, struct handle_info *hi);
259int getipbyname(const char *name, unsigned long *ip);
260int set_policer_param(const char *param, void *data, void *extra);
261const char *strtab(unsigned int ii);
eb5d6b73 262char *time2str(time_t thetime);
668dc38e 263extern char *pretty_mask(char *mask);
d76ed9a9 264
265void tools_init(void);
266void tools_cleanup(void);
267
268int irccasecmp(const char *stra, const char *strb);
269int ircncasecmp(const char *stra, const char *strb, unsigned int len);
270const char *irccasestr(const char *haystack, const char *needle);
1136f709 271char *ircstrlower(char *str);
d76ed9a9 272
273DECLARE_LIST(string_buffer, char);
274void string_buffer_append_string(struct string_buffer *buf, const char *tail);
275void string_buffer_append_substring(struct string_buffer *buf, const char *tail, unsigned int len);
276void string_buffer_append_vprintf(struct string_buffer *buf, const char *fmt, va_list args);
277void string_buffer_append_printf(struct string_buffer *buf, const char *fmt, ...);
278void string_buffer_replace(struct string_buffer *buf, unsigned int from, unsigned int len, const char *repl);
d6b0769f 279void
280irc_strtolower(char *str);
d76ed9a9 281
7a278540 282int str_is_number(const char *str);
d76ed9a9 283#define enabled_string(string) (!irccasecmp((string), "on") || !strcmp((string), "1") || !irccasecmp((string), "enabled"))
284#define disabled_string(string) (!irccasecmp((string), "off") || !strcmp((string), "0") || !irccasecmp((string), "disabled"))
285#define true_string(string) (!irccasecmp((string), "true") || !strcmp((string), "1") || !irccasecmp((string), "yes"))
286#define false_string(string) (!irccasecmp((string), "false") || !strcmp((string), "0") || !irccasecmp((string), "no"))
287
288#endif /* ifdef COMMON_H */