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 #ifndef INADDR_NONE
  42 #define INADDR_NONE 0xffffffffL
  43 #endif
  44 #ifndef INADDR_LOOPBACK
  45 #define INADDR_LOOPBACK 0x7f000001L
  46 #endif
  47
  48 #define ArrayLength(x)          (sizeof(x)/sizeof(x[0]))
  49 #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)
  50
  51 #ifdef __GNUC__
  52 #define PRINTF_LIKE(M,N) __attribute__((format (printf, M, N)))
  53 #else
  54 #define PRINTF_LIKE(M,N)
  55 #endif
  56
  57 #if __GNUC__ >= 2
  58 #define UNUSED_ARG(ARG) ARG __attribute__((unused))
  59 #elif defined(S_SPLINT_S)
  60 #define UNUSED_ARG(ARG) /*@unused@*/ ARG
  61 #define const /*@observer@*/ /*@temp@*/
  62 #else
  63 #define UNUSED_ARG(ARG) ARG
  64 #endif
  65
  66 #if defined(WITH_MALLOC_DMALLOC)
  67 # define DMALLOC_FUNC_CHECK 1
  68 # include <string.h>
  69 # include <dmalloc.h>
  70 #elif defined(WITH_MALLOC_MPATROL)
  71 # include <string.h>
  72 # include <mpatrol.h>
  73 #elif defined(WITH_MALLOC_BOEHM_GC)
  74 # if !defined(NDEBUG)
  75 #  define GC_DEBUG 1
  76 # endif
  77 # include <stdlib.h>
  78 # include <string.h>
  79 # include <gc/gc.h>
  80 # define malloc(n) GC_MALLOC(n)
  81 # define calloc(m,n) GC_MALLOC((m)*(n))
  82 # define realloc(p,n) GC_REALLOC((p),(n))
  83 # define free(p) GC_FREE(p)
  84 # undef  HAVE_STRDUP
  85 # undef strdup
  86 #elif defined(WITH_MALLOC_SRVX)
  87 # undef malloc
  88 # define malloc(n) srvx_malloc(__FILE__, __LINE__, (n))
  89 # undef calloc
  90 # define calloc(m,n) srvx_malloc(__FILE__, __LINE__, (m)*(n))
  91 # undef realloc
  92 # define realloc(p,n) srvx_realloc(__FILE__, __LINE__, (p), (n))
  93 # undef free
  94 # define free(p) srvx_free(__FILE__, __LINE__, (p))
  95 # undef strdup
  96 # define strdup(s) srvx_strdup(__FILE__, __LINE__, (s))
  97 extern void *srvx_malloc(const char *, unsigned int, size_t);
  98 extern void *srvx_realloc(const char *, unsigned int, void *, size_t);
  99 extern char *srvx_strdup(const char *, unsigned int, const char *);
 100 extern void srvx_free(const char *, unsigned int, void *);
 101 #endif
 102
 103 extern time_t now;
 104 extern int quit_services;
 105 extern struct log_type *MAIN_LOG;
 106
 107 int create_socket_client(struct uplinkNode *target);
 108 void close_socket(void);
 109
 110 typedef void (*exit_func_t)(void);
 111 void reg_exit_func(exit_func_t handler);
 112 void call_exit_funcs(void);
 113
 114 const char *inttobase64(char *buf, unsigned int v, unsigned int count);
 115 unsigned long base64toint(const char *s, int count);
 116 int split_line(char *line, int irc_colon, int argv_size, char *argv[]);
 117
 118 /* match_ircglobs(oldglob, newglob) returns non-zero if oldglob is a superset of newglob */
 119 #define match_ircglobs !mmatch
 120 int mmatch(const char *glob, const char *newglob);
 121 int match_ircglob(const char *text, const char *glob);
 122 int user_matches_glob(struct userNode *user, const char *glob, int include_nick);
 123
 124 int is_ircmask(const char *text);
 125 int is_gline(const char *text);
 126
 127 char *sanitize_ircmask(char *text);
 128
 129 unsigned long ParseInterval(const char *interval);
 130 unsigned long ParseVolume(const char *volume);
 131 int parse_ipmask(const char *str, struct in_addr *addr, unsigned long *mask);
 132 #define MATCH_IPMASK(test, addr, mask) (((ntohl(test.s_addr) & mask) ^ (ntohl(addr.s_addr) & mask)) == 0)
 133
 134 #define MD5_CRYPT_LENGTH 42
 135 /* buffer[] must be at least MD5_CRYPT_LENGTH bytes long */
 136 const char *cryptpass(const char *pass, char buffer[]);
 137 int checkpass(const char *pass, const char *crypt);
 138
 139 int split_ircmask(char *text, char **nick, char **ident, char **host);
 140 char *unsplit_string(char *set[], unsigned int max, char *dest);
 141
 142 #define DECLARE_LIST(STRUCTNAME,ITEMTYPE) struct STRUCTNAME {\
 143   unsigned int used, size;\
 144   ITEMTYPE *list;\
 145 };\
 146 void STRUCTNAME##_init(struct STRUCTNAME *list);\
 147 void STRUCTNAME##_append(struct STRUCTNAME *list, ITEMTYPE new_item);\
 148 int STRUCTNAME##_remove(struct STRUCTNAME *list, ITEMTYPE new_item);\
 149 void STRUCTNAME##_clean(struct STRUCTNAME *list)
 150
 151 #define DEFINE_LIST(STRUCTNAME,ITEMTYPE) \
 152 void STRUCTNAME##_init(struct STRUCTNAME *list) {\
 153   list->used = 0;\
 154   list->size = 8;\
 155   list->list = malloc(list->size*sizeof(list->list[0]));\
 156 }\
 157 void STRUCTNAME##_append(struct STRUCTNAME *list, ITEMTYPE new_item) {\
 158   if (list->used == list->size) {\
 159     list->size = list->size ? (list->size << 1) : 4;\
 160     list->list = realloc(list->list, list->size*sizeof(list->list[0]));\
 161   }\
 162   list->list[list->used++] = new_item;\
 163 }\
 164 int STRUCTNAME##_remove(struct STRUCTNAME *list, ITEMTYPE new_item) {\
 165     unsigned int n, found;\
 166     for (found=n=0; n<list->used; n++) {\
 167         if (list->list[n] == new_item) {\
 168             memmove(list->list+n, list->list+n+1, (list->used-n-1)*sizeof(list->list[n]));\
 169             found = 1;\
 170             list->used--;\
 171         }\
 172     }\
 173     return found;\
 174 }\
 175 void STRUCTNAME##_clean(struct STRUCTNAME *list) {\
 176   list->used = list->size = 0;\
 177   free(list->list);\
 178 }
 179
 180 /* The longest string that is likely to be produced in English is "10
 181  * minutes, and 10 seconds" (27 characters).  Other languages will
 182  * vary, so there's plenty of leeway.
 183  */
 184 #define INTERVALLEN     50
 185
 186 struct handle_info;
 187 char *intervalString(char *output, time_t interval, struct handle_info *hi);
 188 int getipbyname(const char *name, unsigned long *ip);
 189 int set_policer_param(const char *param, void *data, void *extra);
 190 const char *strtab(unsigned int ii);
 191
 192 void tools_init(void);
 193 void tools_cleanup(void);
 194
 195 int irccasecmp(const char *stra, const char *strb);
 196 int ircncasecmp(const char *stra, const char *strb, unsigned int len);
 197 const char *irccasestr(const char *haystack, const char *needle);
 198
 199 DECLARE_LIST(string_buffer, char);
 200 void string_buffer_append_string(struct string_buffer *buf, const char *tail);
 201 void string_buffer_append_substring(struct string_buffer *buf, const char *tail, unsigned int len);
 202 void string_buffer_append_vprintf(struct string_buffer *buf, const char *fmt, va_list args);
 203 void string_buffer_append_printf(struct string_buffer *buf, const char *fmt, ...);
 204 void string_buffer_replace(struct string_buffer *buf, unsigned int from, unsigned int len, const char *repl);
 205
 206 #define enabled_string(string)  (!irccasecmp((string), "on") || !strcmp((string), "1") || !irccasecmp((string), "enabled"))
 207 #define disabled_string(string) (!irccasecmp((string), "off") || !strcmp((string), "0") || !irccasecmp((string), "disabled"))
 208 #define true_string(string)     (!irccasecmp((string), "true") || !strcmp((string), "1") || !irccasecmp((string), "yes"))
 209 #define false_string(string)    (!irccasecmp((string), "false") || !strcmp((string), "0") || !irccasecmp((string), "no"))
 210
 211 #endif /* ifdef COMMON_H */