Add features (incomplete, highly experimental), fix DundiLookup app, debug improvemen...
[asterisk/asterisk.git] / utils.c
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * Utility functions
5  *
6  * Copyright (C) 2004, Digium
7  *
8  * This program is free software, distributed under the terms of
9  * the GNU General Public License
10  */
11
12 #ifdef Linux    /* For strcasestr */
13 #define __USE_GNU
14 #endif
15 #include <ctype.h>
16 #include <string.h>
17 #include <unistd.h>
18 #include <stdlib.h>
19 #include <errno.h>
20 #include <sys/types.h>
21 #include <sys/socket.h>
22 #include <netinet/in.h>
23 #include <arpa/inet.h>
24 #include <asterisk/lock.h>
25 #include <asterisk/utils.h>
26 #include <asterisk/logger.h>
27
28 static char base64[64];
29 static char b2a[256];
30
31 char *ast_strip(char *buf)
32 {
33         char *start;
34         /* Strip off trailing whitespace, returns, etc */
35         while (!ast_strlen_zero(buf) && (buf[strlen(buf)-1]<33))
36                 buf[strlen(buf)-1] = '\0';
37         start = buf;
38         /* Strip off leading whitespace, returns, etc */
39         while (*start && (*start < 33))
40                 *start++ = '\0';
41         return start;
42 }
43
44 #if defined(__FreeBSD__) || defined(__OpenBSD__) || defined( __NetBSD__ ) || defined(__APPLE__)
45
46 /* duh? ERANGE value copied from web... */
47 #define ERANGE 34
48 #undef gethostbyname
49
50 AST_MUTEX_DEFINE_STATIC(__mutex);
51
52 /* Recursive replacement for gethostbyname for BSD-based systems */
53 static int gethostbyname_r (const char *name, struct hostent *ret, char *buf,
54                                 size_t buflen, struct hostent **result, 
55                                 int *h_errnop) 
56 {
57         int hsave;
58         struct hostent *ph;
59         ast_mutex_lock(&__mutex); /* begin critical area */
60         hsave = h_errno;
61
62         ph = gethostbyname(name);
63         *h_errnop = h_errno; /* copy h_errno to *h_herrnop */
64         if (ph == NULL) {
65                 *result = NULL;
66         } else {
67                 char **p, **q;
68                 char *pbuf;
69                 int nbytes=0;
70                 int naddr=0, naliases=0;
71                 /* determine if we have enough space in buf */
72
73                 /* count how many addresses */
74                 for (p = ph->h_addr_list; *p != 0; p++) {
75                         nbytes += ph->h_length; /* addresses */
76                         nbytes += sizeof(*p); /* pointers */
77                         naddr++;
78                 }
79                 nbytes += sizeof(*p); /* one more for the terminating NULL */
80
81                 /* count how many aliases, and total length of strings */
82                 for (p = ph->h_aliases; *p != 0; p++) {
83                         nbytes += (strlen(*p)+1); /* aliases */
84                         nbytes += sizeof(*p);  /* pointers */
85                         naliases++;
86                 }
87                 nbytes += sizeof(*p); /* one more for the terminating NULL */
88
89                 /* here nbytes is the number of bytes required in buffer */
90                 /* as a terminator must be there, the minimum value is ph->h_length */
91                 if(nbytes > buflen) {
92                         *result = NULL;
93                         ast_mutex_unlock(&__mutex); /* end critical area */
94                         return ERANGE; /* not enough space in buf!! */
95                 }
96
97                 /* There is enough space. Now we need to do a deep copy! */
98                 /* Allocation in buffer:
99                         from [0] to [(naddr-1) * sizeof(*p)]:
100                         pointers to addresses
101                         at [naddr * sizeof(*p)]:
102                         NULL
103                         from [(naddr+1) * sizeof(*p)] to [(naddr+naliases) * sizeof(*p)] :
104                         pointers to aliases
105                         at [(naddr+naliases+1) * sizeof(*p)]:
106                         NULL
107                         then naddr addresses (fixed length), and naliases aliases (asciiz).
108                 */
109
110                 *ret = *ph;   /* copy whole structure (not its address!) */
111
112                 /* copy addresses */
113                 q = (char **)buf; /* pointer to pointers area (type: char **) */
114                 ret->h_addr_list = q; /* update pointer to address list */
115                 pbuf = buf + ((naddr+naliases+2)*sizeof(*p)); /* skip that area */
116                 for (p = ph->h_addr_list; *p != 0; p++) {
117                         memcpy(pbuf, *p, ph->h_length); /* copy address bytes */
118                         *q++ = pbuf; /* the pointer is the one inside buf... */
119                         pbuf += ph->h_length; /* advance pbuf */
120                 }
121                 *q++ = NULL; /* address list terminator */
122
123                 /* copy aliases */
124                 ret->h_aliases = q; /* update pointer to aliases list */
125                 for (p = ph->h_aliases; *p != 0; p++) {
126                         strcpy(pbuf, *p); /* copy alias strings */
127                         *q++ = pbuf; /* the pointer is the one inside buf... */
128                         pbuf += strlen(*p); /* advance pbuf */
129                         *pbuf++ = 0; /* string terminator */
130                 }
131                 *q++ = NULL; /* terminator */
132
133                 strcpy(pbuf, ph->h_name); /* copy alias strings */
134                 ret->h_name = pbuf;
135                 pbuf += strlen(ph->h_name); /* advance pbuf */
136                 *pbuf++ = 0; /* string terminator */
137
138                 *result = ret;  /* and let *result point to structure */
139
140         }
141         h_errno = hsave;  /* restore h_errno */
142         ast_mutex_unlock(&__mutex); /* end critical area */
143
144         return (*result == NULL); /* return 0 on success, non-zero on error */
145 }
146
147
148 #endif
149
150 /* Recursive thread safe version of gethostbyname that replaces the 
151    standard gethostbyname (which is not recursive)
152 */
153 struct hostent *ast_gethostbyname(const char *host, struct ast_hostent *hp)
154 {
155         int res;
156         int herrno;
157         const char *s;
158         struct hostent *result = NULL;
159         /* Although it is perfectly legitimate to lookup a pure integer, for
160            the sake of the sanity of people who like to name their peers as
161            integers, we break with tradition and refuse to look up a
162            pure integer */
163         s = host;
164         while(s && *s) {
165                 if (!isdigit(*s))
166                         break;
167                 s++;
168         }
169         if (!s || !*s)
170                 return NULL;
171         res = gethostbyname_r(host, &hp->hp, hp->buf, sizeof(hp->buf), &result, &herrno);
172
173         if (res || !result || !hp->hp.h_addr_list || !hp->hp.h_addr_list[0])
174                 return NULL;
175         return &hp->hp;
176 }
177
178
179 /* This is a regression test for recursive mutexes.
180    test_for_thread_safety() will return 0 if recursive mutex locks are
181    working properly, and non-zero if they are not working properly. */
182
183 AST_MUTEX_DEFINE_STATIC(test_lock);
184 AST_MUTEX_DEFINE_STATIC(test_lock2);
185 static pthread_t test_thread; 
186 static int lock_count = 0;
187 static int test_errors = 0;
188
189 static void *test_thread_body(void *data) 
190
191         ast_mutex_lock(&test_lock);
192         lock_count += 10;
193         if (lock_count != 10) 
194                 test_errors++;
195         ast_mutex_lock(&test_lock);
196         lock_count += 10;
197         if (lock_count != 20) 
198                 test_errors++;
199         ast_mutex_lock(&test_lock2);
200         ast_mutex_unlock(&test_lock);
201         lock_count -= 10;
202         if (lock_count != 10) 
203                 test_errors++;
204         ast_mutex_unlock(&test_lock);
205         lock_count -= 10;
206         ast_mutex_unlock(&test_lock2);
207         if (lock_count != 0) 
208                 test_errors++;
209         return NULL;
210
211
212 int test_for_thread_safety(void)
213
214         ast_mutex_lock(&test_lock2);
215         ast_mutex_lock(&test_lock);
216         lock_count += 1;
217         ast_mutex_lock(&test_lock);
218         lock_count += 1;
219         ast_pthread_create(&test_thread, NULL, test_thread_body, NULL); 
220         usleep(100);
221         if (lock_count != 2) 
222                 test_errors++;
223         ast_mutex_unlock(&test_lock);
224         lock_count -= 1;
225         usleep(100); 
226         if (lock_count != 1) 
227                 test_errors++;
228         ast_mutex_unlock(&test_lock);
229         lock_count -= 1;
230         if (lock_count != 0) 
231                 test_errors++;
232         ast_mutex_unlock(&test_lock2);
233         usleep(100);
234         if (lock_count != 0) 
235                 test_errors++;
236         pthread_join(test_thread, NULL);
237         return(test_errors);          /* return 0 on success. */
238 }
239
240 int ast_base64decode(unsigned char *dst, char *src, int max)
241 {
242         int cnt = 0;
243         unsigned int byte = 0;
244         unsigned int bits = 0;
245         int incnt = 0;
246 #if 0
247         unsigned char *odst = dst;
248 #endif
249         while(*src && (cnt < max)) {
250                 /* Shift in 6 bits of input */
251                 byte <<= 6;
252                 byte |= (b2a[(int)(*src)]) & 0x3f;
253                 bits += 6;
254 #if 0
255                 printf("Add: %c %s\n", *src, binary(b2a[(int)(*src)] & 0x3f, 6));
256 #endif
257                 src++;
258                 incnt++;
259                 /* If we have at least 8 bits left over, take that character 
260                    off the top */
261                 if (bits >= 8)  {
262                         bits -= 8;
263                         *dst = (byte >> bits) & 0xff;
264 #if 0
265                         printf("Remove: %02x %s\n", *dst, binary(*dst, 8));
266 #endif
267                         dst++;
268                         cnt++;
269                 }
270         }
271 #if 0
272         dump(odst, cnt);
273 #endif
274         /* Dont worry about left over bits, they're extra anyway */
275         return cnt;
276 }
277
278 int ast_base64encode(char *dst, unsigned char *src, int srclen, int max)
279 {
280         int cnt = 0;
281         unsigned int byte = 0;
282         int bits = 0;
283         int index;
284         int cntin = 0;
285 #if 0
286         char *odst = dst;
287         dump(src, srclen);
288 #endif
289         /* Reserve one bit for end */
290         max--;
291         while((cntin < srclen) && (cnt < max)) {
292                 byte <<= 8;
293 #if 0
294                 printf("Add: %02x %s\n", *src, binary(*src, 8));
295 #endif
296                 byte |= *(src++);
297                 bits += 8;
298                 cntin++;
299                 while((bits >= 6) && (cnt < max)) {
300                         bits -= 6;
301                         /* We want only the top */
302                         index = (byte >> bits) & 0x3f;
303                         *dst = base64[index];
304 #if 0
305                         printf("Remove: %c %s\n", *dst, binary(index, 6));
306 #endif
307                         dst++;
308                         cnt++;
309                 }
310         }
311         if (bits && (cnt < max)) {
312                 /* Add one last character for the remaining bits, 
313                    padding the rest with 0 */
314                 byte <<= (6 - bits);
315                 index = (byte) & 0x3f;
316                 *(dst++) = base64[index];
317                 cnt++;
318         }
319         *dst = '\0';
320         return cnt;
321 }
322
323 static void base64_init(void)
324 {
325         int x;
326         memset(b2a, -1, sizeof(b2a));
327         /* Initialize base-64 Conversion table */
328         for (x=0;x<26;x++) {
329                 /* A-Z */
330                 base64[x] = 'A' + x;
331                 b2a['A' + x] = x;
332                 /* a-z */
333                 base64[x + 26] = 'a' + x;
334                 b2a['a' + x] = x + 26;
335                 /* 0-9 */
336                 if (x < 10) {
337                         base64[x + 52] = '0' + x;
338                         b2a['0' + x] = x + 52;
339                 }
340         }
341         base64[62] = '+';
342         base64[63] = '/';
343         b2a[(int)'+'] = 62;
344         b2a[(int)'/'] = 63;
345 #if 0
346         for (x=0;x<64;x++) {
347                 if (b2a[(int)base64[x]] != x) {
348                         fprintf(stderr, "!!! %d failed\n", x);
349                 } else
350                         fprintf(stderr, "--- %d passed\n", x);
351         }
352 #endif
353 }
354
355 /* Recursive thread safe replacement of inet_ntoa */
356 const char *ast_inet_ntoa(char *buf, int bufsiz, struct in_addr ia)
357 {
358         return inet_ntop(AF_INET, &ia, buf, bufsiz);
359 }
360
361 int ast_utils_init(void)
362 {
363         base64_init();
364         return 0;
365 }
366
367
368 #ifndef __linux__
369 #undef pthread_create /* For ast_pthread_create function only */
370 int ast_pthread_create(pthread_t *thread, pthread_attr_t *attr, void *(*start_routine)(void *), void *data)
371 {
372         pthread_attr_t lattr;
373         if (!attr) {
374                 pthread_attr_init(&lattr);
375                 attr = &lattr;
376         }
377         errno = pthread_attr_setstacksize(attr, PTHREAD_ATTR_STACKSIZE);
378         if (errno)
379                 ast_log(LOG_WARNING, "pthread_attr_setstacksize returned non-zero: %s\n", strerror(errno));
380         return pthread_create(thread, attr, start_routine, data); /* We're in ast_pthread_create, so it's okay */
381 }
382 #endif /* ! LINUX */
383
384 /* Case-insensitive substring matching */
385 #ifndef LINUX
386 static char *upper(const char *orig, char *buf, int bufsize)
387 {
388         int i;
389         memset(buf, 0, bufsize);
390         for (i=0; i<bufsize - 1; i++) {
391                 buf[i] = toupper(orig[i]);
392                 if (orig[i] == '\0') {
393                         break;
394                 }
395         }
396         return buf;
397 }
398
399 char *ast_strcasestr(const char *haystack, const char *needle)
400 {
401         char *u1, *u2;
402         int u1len = strlen(haystack) + 1, u2len = strlen(needle) + 1;
403
404         u1 = alloca(u1len);
405         u2 = alloca(u2len);
406         if (u1 && u2) {
407                 char *offset;
408                 if (u2len > u1len) {
409                         /* Needle bigger than haystack */
410                         return NULL;
411                 }
412                 offset = strstr(upper(haystack, u1, u1len), upper(needle, u2, u2len));
413                 if (offset) {
414                         /* Return the offset into the original string */
415                         return ((char *)((unsigned int)haystack + (unsigned int)(offset - u1)));
416                 } else {
417                         return NULL;
418                 }
419         } else {
420                 ast_log(LOG_ERROR, "Out of memory\n");
421                 return NULL;
422         }
423 }
424 #endif
425