src/common.h

   1 /* common.h - Common functions/includes
   2  * Copyright 2000-2004 srvx Development Team
   3  *
   4  * This file is part of srvx.
   5  *
   6  * srvx 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.
  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__)
  28 extern 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
  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
  44 #if __GNUC__
  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
  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
  65 #if defined(WITH_MALLOC_DMALLOC)
  66 # define DMALLOC_FUNC_CHECK 1
  67 # include <string.h>
  68 # include <dmalloc.h>
  69 #elif defined(WITH_MALLOC_MPATROL)
  70 # include <string.h>
  71 # include <mpatrol.h>
  72 #elif defined(WITH_MALLOC_BOEHM_GC)
  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
  85 #elif defined(WITH_MALLOC_SRVX)
  86 # undef malloc
  87 # define malloc(n) srvx_malloc(__FILE__, __LINE__, (n))
  88 # undef calloc
  89 # define calloc(m,n) srvx_malloc(__FILE__, __LINE__, (m)*(n))
  90 # undef realloc
  91 # define realloc(p,n) srvx_realloc(__FILE__, __LINE__, (p), (n))
  92 # undef free
  93 # define free(p) srvx_free(__FILE__, __LINE__, (p))
  94 # undef strdup
  95 # define strdup(s) srvx_strdup(__FILE__, __LINE__, (s))
  96 extern void *srvx_malloc(const char *, unsigned int, size_t);
  97 extern void *srvx_realloc(const char *, unsigned int, void *, size_t);
  98 extern char *srvx_strdup(const char *, unsigned int, const char *);
  99 extern void srvx_free(const char *, unsigned int, void *);
 100 # if !defined(NDEBUG)
 101 extern void verify(const void *ptr);
 102 #  define verify(x) verify(x)
 103 # endif
 104 #elif defined(WITH_MALLOC_SLAB)
 105 # define malloc(n) slab_malloc(__FILE__, __LINE__, (n))
 106 # undef calloc
 107 # define calloc(m,n) slab_malloc(__FILE__, __LINE__, (m)*(n))
 108 # undef realloc
 109 # define realloc(p,n) slab_realloc(__FILE__, __LINE__, (p), (n))
 110 # undef free
 111 # define free(p) slab_free(__FILE__, __LINE__, (p))
 112 # undef strdup
 113 # define strdup(s) slab_strdup(__FILE__, __LINE__, (s))
 114 extern void *slab_malloc(const char *, unsigned int, size_t);
 115 extern void *slab_realloc(const char *, unsigned int, void *, size_t);
 116 extern char *slab_strdup(const char *, unsigned int, const char *);
 117 extern void slab_free(const char *, unsigned int, void *);
 118 # if !defined(NDEBUG)
 119 extern void verify(const void *ptr);
 120 #  define verify(x) verify(x)
 121 # endif
 122 #endif
 123
 124 #ifndef verify
 125 # define verify(ptr) (void)(ptr)
 126 #endif
 127
 128 extern unsigned long now;
 129 extern int quit_services;
 130 extern struct log_type *MAIN_LOG;
 131 extern const char git_version[];
 132
 133 typedef union irc_in_addr {
 134     uint32_t in6_32[4];
 135     uint16_t in6[8];
 136     uint8_t in6_8[16];
 137 } irc_in_addr_t;
 138
 139 #define irc_in_addr_is_valid(ADDR) (((ADDR).in6[0] && (ADDR).in6[0] != 65535) \
 140                                     || (ADDR).in6[1] != (ADDR).in6[0] \
 141                                     || (ADDR).in6[2] != (ADDR).in6[0] \
 142                                     || (ADDR).in6[3] != (ADDR).in6[0] \
 143                                     || (ADDR).in6[4] != (ADDR).in6[0] \
 144                                     || (ADDR).in6[5] != (ADDR).in6[0] \
 145                                     || (ADDR).in6[6] != (ADDR).in6[0] \
 146                                     || (ADDR).in6[7] != (ADDR).in6[0])
 147 #define irc_in_addr_is_ipv4(ADDR) (!(ADDR).in6[0] && !(ADDR).in6[1] \
 148                                    && !(ADDR).in6[2] && !(ADDR).in6[3] \
 149                                    && !(ADDR).in6[4] && (ADDR).in6[6] \
 150                                    && (!(ADDR).in6[5] || (ADDR).in6[5] == 65535))
 151 #define irc_in_addr_is_ipv6(ADDR) !irc_in_addr_is_ipv4(ADDR)
 152 #define irc_in_addr_is_loopback(ADDR) (irc_in_addr_is_ipv4(ADDR) ? (ADDR).in6_8[12] == 127 \
 153                                        : (ADDR).in6[0] == 0 && (ADDR).in6[1] == 0 \
 154                                        && (ADDR).in6[2] == 0 && (ADDR).in6[3] == 0 \
 155                                        && (ADDR).in6[4] == 0 && (ADDR).in6[5] == 0 \
 156                                        && (ADDR).in6[6] == 0 && (ADDR).in6[7] == 1)
 157 #define IRC_NTOP_MAX_SIZE 40
 158 unsigned int irc_ntop(char *output, unsigned int out_size, const irc_in_addr_t *addr);
 159 #define IRC_NTOP_MASK_MAX_SIZE (IRC_NTOP_MAX_SIZE + 4)
 160 unsigned int irc_ntop_mask(char *output, unsigned int out_size, const irc_in_addr_t *addr, unsigned char bits);
 161 unsigned int irc_pton(irc_in_addr_t *addr, unsigned char *bits, const char *input);
 162 unsigned int irc_check_mask(const irc_in_addr_t *check, const irc_in_addr_t *mask, unsigned char bits);
 163 const char *irc_ntoa(const irc_in_addr_t *addr);
 164
 165 int create_socket_client(struct uplinkNode *target);
 166 void close_socket(void);
 167
 168 typedef void (*exit_func_t)(void);
 169 void reg_exit_func(exit_func_t handler);
 170 void call_exit_funcs(void);
 171
 172 const char *inttobase64(char *buf, unsigned int v, unsigned int count);
 173 unsigned long base64toint(const char *s, int count);
 174 int split_line(char *line, int irc_colon, int argv_size, char *argv[]);
 175
 176 /* match_ircglobs(oldglob, newglob) returns non-zero if oldglob is a superset of newglob */
 177 #define match_ircglobs !mmatch
 178 int mmatch(const char *glob, const char *newglob);
 179 int match_ircglob(const char *text, const char *glob);
 180 #define MATCH_USENICK 1
 181 #define MATCH_VISIBLE 2
 182 int user_matches_glob(struct userNode *user, const char *glob, int flags);
 183
 184 int is_ircmask(const char *text);
 185 int is_gline(const char *text);
 186
 187 char *sanitize_ircmask(char *text);
 188
 189 unsigned long ParseInterval(const char *interval);
 190 unsigned long ParseVolume(const char *volume);
 191
 192 #define MD5_CRYPT_LENGTH 42
 193 /* buffer[] must be at least MD5_CRYPT_LENGTH bytes long */
 194 const char *cryptpass(const char *pass, char buffer[]);
 195 int checkpass(const char *pass, const char *crypt);
 196
 197 int split_ircmask(char *text, char **nick, char **ident, char **host);
 198 char *unsplit_string(char *set[], unsigned int max, char *dest);
 199
 200 #define DECLARE_LIST(STRUCTNAME,ITEMTYPE) struct STRUCTNAME {\
 201   unsigned int used, size;\
 202   ITEMTYPE *list;\
 203 };\
 204 void STRUCTNAME##_init(struct STRUCTNAME *list);\
 205 void STRUCTNAME##_append(struct STRUCTNAME *list, ITEMTYPE new_item);\
 206 int STRUCTNAME##_remove(struct STRUCTNAME *list, ITEMTYPE new_item);\
 207 void STRUCTNAME##_clean(struct STRUCTNAME *list)
 208
 209 #define DEFINE_LIST(STRUCTNAME,ITEMTYPE) \
 210 void STRUCTNAME##_init(struct STRUCTNAME *list) {\
 211   list->used = 0;\
 212   list->size = 8;\
 213   list->list = malloc(list->size*sizeof(list->list[0]));\
 214 }\
 215 void STRUCTNAME##_append(struct STRUCTNAME *list, ITEMTYPE new_item) {\
 216   verify(list->list);\
 217   if (list->used == list->size) {\
 218     list->size = list->size ? (list->size << 1) : 4;\
 219     list->list = realloc(list->list, list->size*sizeof(list->list[0]));\
 220   }\
 221   list->list[list->used++] = new_item;\
 222 }\
 223 int STRUCTNAME##_remove(struct STRUCTNAME *list, ITEMTYPE new_item) {\
 224     unsigned int n, found;\
 225     verify(list->list);\
 226     for (found=n=0; n<list->used; n++) {\
 227         if (list->list[n] == new_item) {\
 228             memmove(list->list+n, list->list+n+1, (list->used-n-1)*sizeof(list->list[n]));\
 229             found = 1;\
 230             list->used--;\
 231         }\
 232     }\
 233     return found;\
 234 }\
 235 void STRUCTNAME##_clean(struct STRUCTNAME *list) {\
 236   list->used = list->size = 0;\
 237   free(list->list);\
 238   list->list = NULL;\
 239 }
 240
 241 /* The longest string that is likely to be produced in English is "10
 242  * minutes, and 10 seconds" (27 characters).  Other languages will
 243  * vary, so there's plenty of leeway.
 244  */
 245 #define INTERVALLEN 50
 246
 247 struct handle_info;
 248 char *intervalString(char *output, unsigned long interval, struct handle_info *hi);
 249 int getipbyname(const char *name, unsigned long *ip);
 250 int set_policer_param(const char *param, void *data, void *extra);
 251 const char *strtab(unsigned int ii);
 252
 253 void tools_init(void);
 254 void tools_cleanup(void);
 255
 256 int irccasecmp(const char *stra, const char *strb);
 257 int ircncasecmp(const char *stra, const char *strb, unsigned int len);
 258 const char *irccasestr(const char *haystack, const char *needle);
 259
 260 DECLARE_LIST(string_buffer, char);
 261 void string_buffer_append_string(struct string_buffer *buf, const char *tail);
 262 void string_buffer_append_substring(struct string_buffer *buf, const char *tail, unsigned int len);
 263 void string_buffer_append_vprintf(struct string_buffer *buf, const char *fmt, va_list args);
 264 void string_buffer_append_printf(struct string_buffer *buf, const char *fmt, ...);
 265 void string_buffer_replace(struct string_buffer *buf, unsigned int from, unsigned int len, const char *repl);
 266
 267 #define enabled_string(string)  (!irccasecmp((string), "on") || !strcmp((string), "1") || !irccasecmp((string), "enabled"))
 268 #define disabled_string(string) (!irccasecmp((string), "off") || !strcmp((string), "0") || !irccasecmp((string), "disabled"))
 269 #define true_string(string)     (!irccasecmp((string), "true") || !strcmp((string), "1") || !irccasecmp((string), "yes"))
 270 #define false_string(string)    (!irccasecmp((string), "false") || !strcmp((string), "0") || !irccasecmp((string), "no"))
 271
 272 #endif /* ifdef COMMON_H */