src/common.h

   1 /* common.h - Common functions/includes
   2  * Copyright 2000-2004 srvx Development Team
   3  *
   4  * This file is part of x3.
   5  *
   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.
  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 #ifdef __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(WITH_MALLOC_DMALLOC)
  60 # define DMALLOC_FUNC_CHECK 1
  61 # include <string.h>
  62 # include <dmalloc.h>
  63 #elif defined(WITH_MALLOC_MPATROL)
  64 # include <string.h>
  65 # include <mpatrol.h>
  66 #elif defined(WITH_MALLOC_BOEHM_GC)
  67 # if !defined(NDEBUG)
  68 #  define GC_DEBUG 1
  69 # endif
  70 # include <stdlib.h>
  71 # include <string.h>
  72 # include <gc/gc.h>
  73 # define malloc(n) GC_MALLOC(n)
  74 # define calloc(m,n) GC_MALLOC((m)*(n))
  75 # define realloc(p,n) GC_REALLOC((p),(n))
  76 # define free(p) GC_FREE(p)
  77 # undef  HAVE_STRDUP
  78 # undef strdup
  79 #elif defined(WITH_MALLOC_X3)
  80 # undef malloc
  81 # define malloc(n) x3_malloc(__FILE__, __LINE__, (n))
  82 # undef calloc
  83 # define calloc(m,n) x3_malloc(__FILE__, __LINE__, (m)*(n))
  84 # undef realloc
  85 # define realloc(p,n) x3_realloc(__FILE__, __LINE__, (p), (n))
  86 # undef free
  87 # define free(p) x3_free(__FILE__, __LINE__, (p))
  88 # undef strdup
  89 # define strdup(s) x3_strdup(__FILE__, __LINE__, (s))
  90 extern void *x3_malloc(const char *, unsigned int, size_t);
  91 extern void *x3_realloc(const char *, unsigned int, void *, size_t);
  92 extern char *x3_strdup(const char *, unsigned int, const char *);
  93 extern void x3_free(const char *, unsigned int, void *);
  94 # if !defined(NDEBUG)
  95 extern void verify(const void *ptr);
  96 #  define verify(x) verify(x)
  97 # endif
  98 #elif defined(WITH_MALLOC_SLAB)
  99 # define malloc(n) slab_malloc(__FILE__, __LINE__, (n))
 100 # undef calloc
 101 # define calloc(m,n) slab_malloc(__FILE__, __LINE__, (m)*(n))
 102 # undef realloc
 103 # define realloc(p,n) slab_realloc(__FILE__, __LINE__, (p), (n))
 104 # undef free
 105 # define free(p) slab_free(__FILE__, __LINE__, (p))
 106 # undef strdup
 107 # define strdup(s) slab_strdup(__FILE__, __LINE__, (s))
 108 extern void *slab_malloc(const char *, unsigned int, size_t);
 109 extern void *slab_realloc(const char *, unsigned int, void *, size_t);
 110 extern char *slab_strdup(const char *, unsigned int, const char *);
 111 extern void slab_free(const char *, unsigned int, void *);
 112 # if !defined(NDEBUG)
 113 extern void verify(const void *ptr);
 114 #  define verify(x) verify(x)
 115 # endif
 116 #endif
 117
 118 #ifndef verify
 119 # define verify(ptr) (void)(ptr)
 120 #endif
 121
 122 extern time_t now;
 123 extern int quit_services;
 124 extern struct log_type *MAIN_LOG;
 125
 126 typedef union irc_in_addr {
 127     uint32_t in6_32[4];
 128     uint16_t in6[8];
 129     uint8_t in6_8[16];
 130 } irc_in_addr_t;
 131
 132 #define irc_in_addr_is_valid(ADDR) (((ADDR).in6[0] && (ADDR).in6[0] != 65535) \
 133                                     || (ADDR).in6[1] != (ADDR).in6[0] \
 134                                     || (ADDR).in6[2] != (ADDR).in6[0] \
 135                                     || (ADDR).in6[3] != (ADDR).in6[0] \
 136                                     || (ADDR).in6[4] != (ADDR).in6[0] \
 137                                     || (ADDR).in6[5] != (ADDR).in6[0] \
 138                                     || (ADDR).in6[6] != (ADDR).in6[0] \
 139                                     || (ADDR).in6[7] != (ADDR).in6[0])
 140 #define irc_in_addr_is_ipv4(ADDR) (!(ADDR).in6[0] && !(ADDR).in6[1] \
 141                                    && !(ADDR).in6[2] && !(ADDR).in6[3] \
 142                                    && !(ADDR).in6[4] && (ADDR).in6[6] \
 143                                    && (!(ADDR).in6[5] || (ADDR).in6[5] == 65535))
 144 #define irc_in_addr_is_ipv6(ADDR) !irc_in_addr_is_ipv4(ADDR)
 145 #define irc_in_addr_is_loopback(ADDR) (irc_in_addr_is_ipv4(ADDR) ? (ADDR).in6_8[12] == 127 \
 146                                        : (ADDR).in6[0] == 0 && (ADDR).in6[1] == 0 \
 147                                        && (ADDR).in6[2] == 0 && (ADDR).in6[3] == 0 \
 148                                        && (ADDR).in6[4] == 0 && (ADDR).in6[5] == 0 \
 149                                        && (ADDR).in6[6] == 0 && (ADDR).in6[7] == 1)
 150 #define IRC_NTOP_MAX_SIZE 40
 151 unsigned int irc_ntop(char *output, unsigned int out_size, const irc_in_addr_t *addr);
 152 #define IRC_NTOP_MASK_MAX_SIZE (IRC_NTOP_MAX_SIZE + 4)
 153 unsigned int irc_ntop_mask(char *output, unsigned int out_size, const irc_in_addr_t *addr, unsigned char bits);
 154 unsigned int irc_pton(irc_in_addr_t *addr, unsigned char *bits, const char *input);
 155 unsigned int irc_check_mask(const irc_in_addr_t *check, const irc_in_addr_t *mask, unsigned char bits);
 156 const char *irc_ntoa(const irc_in_addr_t *addr);
 157
 158 int create_socket_client(struct uplinkNode *target);
 159 void close_socket(void);
 160
 161 typedef void (*exit_func_t)(void);
 162 void reg_exit_func(exit_func_t handler);
 163 void call_exit_funcs(void);
 164
 165 char *mysep(char **sepstr, char *delim);
 166 const char *inttobase64(char *buf, unsigned int v, unsigned int count);
 167 unsigned long base64toint(const char *s, int count);
 168 int split_line(char *line, int irc_colon, int argv_size, char *argv[]);
 169
 170 /* match_ircglobs(oldglob, newglob) returns non-zero if oldglob is a superset of newglob */
 171 #define match_ircglobs !mmatch
 172 int mmatch(const char *glob, const char *newglob);
 173 int match_ircglob(const char *text, const char *glob);
 174 #define MATCH_USENICK 1
 175 #define MATCH_VISIBLE 2
 176 int user_matches_glob(struct userNode *user, const char *glob, int flags);
 177 int is_overmask(char *mask);
 178
 179
 180 int is_ircmask(const char *text);
 181 int is_gline(const char *text);
 182 int is_shun(const char *text);
 183
 184 char *sanitize_ircmask(char *text);
 185
 186 unsigned long ParseInterval(const char *interval);
 187 unsigned long ParseVolume(const char *volume);
 188
 189 #define MD5_CRYPT_LENGTH 42
 190 /* buffer[] must be at least MD5_CRYPT_LENGTH bytes long */
 191 const char *cryptpass(const char *pass, char buffer[]);
 192 int checkpass(const char *pass, const char *crypt);
 193
 194 int split_ircmask(char *text, char **nick, char **ident, char **host);
 195 char *unsplit_string(char *set[], unsigned int max, char *dest);
 196 extern char* x3_strtok(char** save, char* str, char* fs);
 197
 198 int valid_email(const char *email);
 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, time_t 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 char *time2str(time_t thetime);
 253 extern char *pretty_mask(char *mask);
 254
 255 void tools_init(void);
 256 void tools_cleanup(void);
 257
 258 int irccasecmp(const char *stra, const char *strb);
 259 int ircncasecmp(const char *stra, const char *strb, unsigned int len);
 260 const char *irccasestr(const char *haystack, const char *needle);
 261
 262 DECLARE_LIST(string_buffer, char);
 263 void string_buffer_append_string(struct string_buffer *buf, const char *tail);
 264 void string_buffer_append_substring(struct string_buffer *buf, const char *tail, unsigned int len);
 265 void string_buffer_append_vprintf(struct string_buffer *buf, const char *fmt, va_list args);
 266 void string_buffer_append_printf(struct string_buffer *buf, const char *fmt, ...);
 267 void string_buffer_replace(struct string_buffer *buf, unsigned int from, unsigned int len, const char *repl);
 268
 269 #define enabled_string(string)  (!irccasecmp((string), "on") || !strcmp((string), "1") || !irccasecmp((string), "enabled"))
 270 #define disabled_string(string) (!irccasecmp((string), "off") || !strcmp((string), "0") || !irccasecmp((string), "disabled"))
 271 #define true_string(string)     (!irccasecmp((string), "true") || !strcmp((string), "1") || !irccasecmp((string), "yes"))
 272 #define false_string(string)    (!irccasecmp((string), "false") || !strcmp((string), "0") || !irccasecmp((string), "no"))
 273
 274 #endif /* ifdef COMMON_H */