citadel/tools.c

   1 /*
   2  * $Id$
   3  *
   4  * Utility functions that are used by both the client and server.
   5  *
   6  */
   7
   8 #ifdef DLL_EXPORT
   9 #define IN_LIBCIT
  10 #endif
  11
  12 #include "sysdep.h"
  13 #include <stdio.h>
  14 #include <stdlib.h>
  15 #include <ctype.h>
  16 #include <string.h>
  17
  18 #if TIME_WITH_SYS_TIME
  19 # include <sys/time.h>
  20 # include <time.h>
  21 #else
  22 # if HAVE_SYS_TIME_H
  23 #  include <sys/time.h>
  24 # else
  25 #  include <time.h>
  26 # endif
  27 #endif
  28
  29 #include "tools.h"
  30 #include "citadel.h"
  31
  32 #define TRUE  1
  33 #define FALSE 0
  34
  35 typedef unsigned char byte;           /* Byte type */
  36 static byte dtable[256];              /* base64 encode / decode table */
  37
  38
  39 char *safestrncpy(char *dest, const char *src, size_t n)
  40 {
  41         if (dest == NULL || src == NULL) {
  42                 fprintf(stderr, "safestrncpy: NULL argument\n");
  43                 abort();
  44         }
  45         strncpy(dest, src, n);
  46         dest[n - 1] = 0;
  47         return dest;
  48 }
  49
  50
  51
  52 #ifndef HAVE_STRNCASECMP
  53 int strncasecmp(char *lstr, char *rstr, int len)
  54 {
  55         int pos = 0;
  56         char lc,rc;
  57         while (pos<len) {
  58                 lc=tolower(lstr[pos]);
  59                 rc=tolower(rstr[pos]);
  60                 if ((lc==0)&&(rc==0)) return(0);
  61                 if (lc<rc) return(-1);
  62                 if (lc>rc) return(1);
  63                 pos=pos+1;
  64         }
  65         return(0);
  66 }
  67 #endif
  68
  69
  70
  71 /*
  72  * num_tokens()  -  discover number of parameters/tokens in a string
  73  */
  74 int num_tokens(char *source, char tok) {
  75         int a;
  76         int count = 1;
  77
  78         if (source == NULL) return(0);
  79         for (a=0; a<strlen(source); ++a) {
  80                 if (source[a]==tok) ++count;
  81         }
  82         return(count);
  83 }
  84
  85 /*
  86  * extract_token()  -  a smarter string tokenizer
  87  */
  88 void extract_token(char *dest, char *source, int parmnum, char separator)
  89 {
  90         int i;
  91         int len;
  92         int curr_parm;
  93
  94         strcpy(dest,"");
  95         len = 0;
  96         curr_parm = 0;
  97
  98         if (strlen(source)==0) {
  99                 return;
 100                 }
 101
 102         for (i=0; i<strlen(source); ++i) {
 103                 if (source[i]==separator) {
 104                         ++curr_parm;
 105                 }
 106                 else if (curr_parm == parmnum) {
 107                         dest[len+1] = 0;
 108                         dest[len++] = source[i];
 109                 }
 110         }
 111 }
 112
 113
 114
 115 /*
 116  * remove_token()  -  a tokenizer that kills, maims, and destroys
 117  */
 118 void remove_token(char *source, int parmnum, char separator)
 119 {
 120         int i;
 121         int len;
 122         int curr_parm;
 123         int start, end;
 124
 125         len = 0;
 126         curr_parm = 0;
 127         start = (-1);
 128         end = (-1);
 129
 130         if (strlen(source)==0) {
 131                 return;
 132                 }
 133
 134         for (i=0; i<strlen(source); ++i) {
 135                 if ( (start < 0) && (curr_parm == parmnum) ) {
 136                         start = i;
 137                 }
 138
 139                 if ( (end < 0) && (curr_parm == (parmnum+1)) ) {
 140                         end = i;
 141                 }
 142
 143                 if (source[i]==separator) {
 144                         ++curr_parm;
 145                 }
 146         }
 147
 148         if (end < 0) end = strlen(source);
 149
 150         printf("%d .. %d\n", start, end);
 151
 152         strcpy(&source[start], &source[end]);
 153 }
 154
 155
 156
 157
 158 /*
 159  * extract_int()  -  extract an int parm w/o supplying a buffer
 160  */
 161 int extract_int(char *source, int parmnum)
 162 {
 163         char buf[SIZ];
 164
 165         extract_token(buf, source, parmnum, '|');
 166         return(atoi(buf));
 167 }
 168
 169 /*
 170  * extract_long()  -  extract an long parm w/o supplying a buffer
 171  */
 172 long extract_long(char *source, long int parmnum)
 173 {
 174         char buf[SIZ];
 175
 176         extract_token(buf, source, parmnum, '|');
 177         return(atol(buf));
 178 }
 179
 180
 181
 182 /*
 183  * decode_base64() and encode_base64() are adaptations of code by
 184  * John Walker, found in full in the file "base64.c" included with this
 185  * distribution.  The difference between those functions and these is that
 186  * these are intended to encode/decode small string buffers, and those are
 187  * intended to encode/decode entire MIME parts.
 188  */
 189
 190 void encode_base64(char *dest, char *source)
 191 {
 192     int i, hiteof = FALSE;
 193     int spos = 0;
 194     int dpos = 0;
 195
 196     /*  Fill dtable with character encodings.  */
 197
 198     for (i = 0; i < 26; i++) {
 199         dtable[i] = 'A' + i;
 200         dtable[26 + i] = 'a' + i;
 201     }
 202     for (i = 0; i < 10; i++) {
 203         dtable[52 + i] = '0' + i;
 204     }
 205     dtable[62] = '+';
 206     dtable[63] = '/';
 207
 208     while (!hiteof) {
 209         byte igroup[3], ogroup[4];
 210         int c, n;
 211
 212         igroup[0] = igroup[1] = igroup[2] = 0;
 213         for (n = 0; n < 3; n++) {
 214             c = source[spos++];
 215             if (c == 0) {
 216                 hiteof = TRUE;
 217                 break;
 218             }
 219             igroup[n] = (byte) c;
 220         }
 221         if (n > 0) {
 222             ogroup[0] = dtable[igroup[0] >> 2];
 223             ogroup[1] = dtable[((igroup[0] & 3) << 4) | (igroup[1] >> 4)];
 224             ogroup[2] = dtable[((igroup[1] & 0xF) << 2) | (igroup[2] >> 6)];
 225             ogroup[3] = dtable[igroup[2] & 0x3F];
 226
 227             /* Replace characters in output stream with "=" pad
 228                characters if fewer than three characters were
 229                read from the end of the input stream. */
 230
 231             if (n < 3) {
 232                 ogroup[3] = '=';
 233                 if (n < 2) {
 234                     ogroup[2] = '=';
 235                 }
 236             }
 237             for (i = 0; i < 4; i++) {
 238                 dest[dpos++] = ogroup[i];
 239                 dest[dpos] = 0;
 240             }
 241         }
 242     }
 243 }
 244
 245
 246 /*
 247  * Convert base64-encoded to binary.  Returns the length of the decoded data.
 248  * It will stop after reading 'length' bytes.
 249  */
 250 int decode_base64(char *dest, char *source, size_t length)
 251 {
 252     int i, c;
 253     int dpos = 0;
 254     int spos = 0;
 255
 256     for (i = 0; i < 255; i++) {
 257         dtable[i] = 0x80;
 258     }
 259     for (i = 'A'; i <= 'Z'; i++) {
 260         dtable[i] = 0 + (i - 'A');
 261     }
 262     for (i = 'a'; i <= 'z'; i++) {
 263         dtable[i] = 26 + (i - 'a');
 264     }
 265     for (i = '0'; i <= '9'; i++) {
 266         dtable[i] = 52 + (i - '0');
 267     }
 268     dtable['+'] = 62;
 269     dtable['/'] = 63;
 270     dtable['='] = 0;
 271
 272     /*CONSTANTCONDITION*/
 273     while (TRUE) {
 274         byte a[4], b[4], o[3];
 275
 276         for (i = 0; i < 4; i++) {
 277             if (spos >= length) {
 278                 return(dpos);
 279             }
 280             c = source[spos++];
 281
 282             if (c == 0) {
 283                 if (i > 0) {
 284                     return(dpos);
 285                 }
 286                 return(dpos);
 287             }
 288             if (dtable[c] & 0x80) {
 289                 /* Ignoring errors: discard invalid character. */
 290                 i--;
 291                 continue;
 292             }
 293             a[i] = (byte) c;
 294             b[i] = (byte) dtable[c];
 295         }
 296         o[0] = (b[0] << 2) | (b[1] >> 4);
 297         o[1] = (b[1] << 4) | (b[2] >> 2);
 298         o[2] = (b[2] << 6) | b[3];
 299         i = a[2] == '=' ? 1 : (a[3] == '=' ? 2 : 3);
 300         if (i>=1) dest[dpos++] = o[0];
 301         if (i>=2) dest[dpos++] = o[1];
 302         if (i>=3) dest[dpos++] = o[2];
 303         dest[dpos] = 0;
 304         if (i < 3) {
 305             return(dpos);
 306         }
 307     }
 308 }
 309
 310
 311
 312 /*
 313  * Strip leading and trailing spaces from a string
 314  */
 315 void striplt(char *buf)
 316 {
 317         while ((strlen(buf) > 0) && (isspace(buf[0])))
 318                 strcpy(buf, &buf[1]);
 319         while (isspace(buf[strlen(buf) - 1]))
 320                 buf[strlen(buf) - 1] = 0;
 321 }
 322
 323
 324
 325
 326
 327 /*
 328  * Return the number of occurances of character ch in string st
 329  */
 330 int haschar(char *st, int ch)
 331 {
 332         int a, b;
 333         b = 0;
 334         for (a = 0; a < strlen(st); ++a)
 335                 if (st[a] == ch)
 336                         ++b;
 337         return (b);
 338 }
 339
 340
 341
 342
 343 /*
 344  * Compare two strings, insensitive to case, punctuation, and non-alnum chars
 345  */
 346 int collapsed_strcmp(char *s1, char *s2) {
 347         char *c1, *c2;
 348         int i, ret, pos;
 349
 350         c1 = malloc(strlen(s1)+1);
 351         c2 = malloc(strlen(s2)+1);
 352         c1[0] = 0;
 353         c2[0] = 0;
 354
 355         pos = 0;
 356         for (i=0; i<strlen(s1); ++i) {
 357                 if (isalnum(s1[i])) {
 358                         c1[pos] = tolower(s1[i]);
 359                         c1[++pos] = 0;
 360                 }
 361         }
 362
 363         pos = 0;
 364         for (i=0; i<strlen(s2); ++i) {
 365                 if (isalnum(s2[i])) {
 366                         c2[pos] = tolower(s2[i]);
 367                         c2[++pos] = 0;
 368                 }
 369         }
 370
 371         ret = strcmp(c1, c2);
 372         free(c1);
 373         free(c2);
 374         return(ret);
 375 }
 376
 377
 378
 379 /*
 380  * Format a date/time stamp for output
 381  */
 382 void fmt_date(char *buf, time_t thetime) {
 383         struct tm *tm;
 384         int hour;
 385
 386         char *ascmonths[] = {
 387                 "Jan", "Feb", "Mar", "Apr", "May", "Jun",
 388                 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
 389         };
 390
 391         strcpy(buf, "");
 392         tm = localtime(&thetime);
 393
 394         hour = tm->tm_hour;
 395         if (hour == 0)  hour = 12;
 396         else if (hour > 12) hour = hour - 12;
 397
 398         sprintf(buf, "%s %d %4d %d:%02d%s",
 399                 ascmonths[tm->tm_mon],
 400                 tm->tm_mday,
 401                 tm->tm_year + 1900,
 402                 hour,
 403                 tm->tm_min,
 404                 ( (tm->tm_hour >= 12) ? "pm" : "am" )
 405         );
 406 }
 407
 408
 409
 410 /*
 411  * Determine whether the specified message number is contained within the
 412  * specified set.
 413  */
 414 int is_msg_in_mset(char *mset, long msgnum) {
 415         int num_sets;
 416         int s;
 417         char setstr[SIZ], lostr[SIZ], histr[SIZ];       /* was 1024 */
 418         long lo, hi;
 419
 420         /*
 421          * Now set it for all specified messages.
 422          */
 423         num_sets = num_tokens(mset, ',');
 424         for (s=0; s<num_sets; ++s) {
 425                 extract_token(setstr, mset, s, ',');
 426
 427                 extract_token(lostr, setstr, 0, ':');
 428                 if (num_tokens(setstr, ':') >= 2) {
 429                         extract_token(histr, setstr, 1, ':');
 430                         if (!strcmp(histr, "*")) {
 431                                 sprintf(histr, "%ld", LONG_MAX);
 432                         }
 433                 }
 434                 else {
 435                         strcpy(histr, lostr);
 436                 }
 437                 lo = atol(lostr);
 438                 hi = atol(histr);
 439
 440                 if ((msgnum >= lo) && (msgnum <= hi)) return(1);
 441         }
 442
 443         return(0);
 444 }
 445
 446
 447 /*
 448  * Utility function to "readline" from memory
 449  * (returns new pointer)
 450  */
 451 char *memreadline(char *start, char *buf, int maxlen)
 452 {
 453         char ch;
 454         char *ptr;
 455         int len = 0;    /* tally our own length to avoid strlen() delays */
 456
 457         ptr = start;
 458         memset(buf, 0, maxlen);
 459
 460         while (1) {
 461                 ch = *ptr++;
 462                 if ( (len < (maxlen - 1)) && (ch != 13) && (ch != 10) ) {
 463                         buf[strlen(buf) + 1] = 0;
 464                         buf[strlen(buf)] = ch;
 465                         ++len;
 466                 }
 467                 if ((ch == 10) || (ch == 0)) {
 468                         return ptr;
 469                 }
 470         }
 471 }
 472
 473
 474 /*
 475  * Strip a boundarized substring out of a string (for example, remove
 476  * parentheses and anything inside them).
 477  */
 478 void stripout(char *str, char leftboundary, char rightboundary) {
 479         int a;
 480         int lb = (-1);
 481         int rb = (-1);
 482
 483         for (a = 0; a < strlen(str); ++a) {
 484                 if (str[a] == leftboundary) lb = a;
 485                 if (str[a] == rightboundary) rb = a;
 486         }
 487
 488         if ( (lb > 0) && (rb > lb) ) {
 489                 strcpy(&str[lb - 1], &str[rb + 1]);
 490         }
 491
 492 }
 493
 494
 495 /*
 496  * Reduce a string down to a boundarized substring (for example, remove
 497  * parentheses and anything outside them).
 498  */
 499 void stripallbut(char *str, char leftboundary, char rightboundary) {
 500         int a;
 501
 502         for (a = 0; a < strlen(str); ++ a) {
 503                 if (str[a] == leftboundary) strcpy(str, &str[a+1]);
 504         }
 505
 506         for (a = 0; a < strlen(str); ++ a) {
 507                 if (str[a] == rightboundary) str[a] = 0;
 508         }
 509
 510 }