webcit/tools.c

   1 /*
   2  * $Id$
   3  */
   4 /**
   5  * \defgroup MiscRout Miscellaneous routines
   6  * \ingroup tools
   7  */
   8
   9 /*@{*/
  10 #include "webcit.h"
  11 #include "webserver.h"
  12
  13
  14 typedef unsigned char byte; /**< byte data type */
  15
  16 #define FALSE 0 /**< no. */
  17 #define TRUE 1  /**< yes. */
  18
  19 static byte dtable[256];        /**< base64 encode / decode table */
  20
  21 /**
  22  * \brief sanitize strncopy.
  23  * \param dest destination string
  24  * \param src source string
  25  * \param n length of source to copy
  26  * \return result string
  27  */
  28 char *safestrncpy(char *dest, const char *src, size_t n)
  29 {
  30         if (dest == NULL || src == NULL) {
  31                 abort();
  32         }
  33         strncpy(dest, src, n);
  34         dest[n - 1] = 0;
  35         return dest;
  36 }
  37
  38
  39
  40 /**
  41  * \brief discover number of parameters/tokens in a string
  42  * \param source string to inspect
  43  * \param tok seperation token
  44  * \return number of tokenized parts found
  45  */
  46 int num_tokens(char *source, char tok)
  47 {
  48         int a = 0;
  49         int count = 1;
  50
  51         if (source == NULL)
  52                 return (0);
  53         for (a = 0; a < strlen(source); ++a) {
  54                 if (source[a] == tok)
  55                         ++count;
  56         }
  57         return (count);
  58 }
  59
  60 /**
  61  * brief a string tokenizer
  62  * \param dest destination string
  63  * \param source the string to grab tokens from
  64  * \param parmnum the n'th token to grab
  65  * \param separator the tokenizer string
  66  * \param maxlen the length of dest
  67  */
  68 void extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen)
  69 {
  70         char *d;                /* dest */
  71         const char *s;          /* source */
  72         int count = 0;
  73         int len = 0;
  74
  75         dest[0] = 0;
  76
  77         /* Locate desired parameter */
  78         s = source;
  79         while (count < parmnum) {
  80                 /* End of string, bail! */
  81                 if (!*s) {
  82                         s = NULL;
  83                         break;
  84                 }
  85                 if (*s == separator) {
  86                         count++;
  87                 }
  88                 s++;
  89         }
  90         if (!s) return;         /* Parameter not found */
  91
  92         for (d = dest; *s && *s != separator && ++len<maxlen; s++, d++) {
  93                 *d = *s;
  94         }
  95         *d = 0;
  96 }
  97
  98
  99
 100 /**
 101  * \brief a tokenizer that kills, maims, and destroys
 102  * \param source the string to process
 103  * \param parmnum which token to kill
 104  * \param separator the tokenizer string
 105  */
 106 void remove_token(char *source, int parmnum, char separator)
 107 {
 108         int i;
 109         int len, slen;
 110         int curr_parm;
 111         int start, end;
 112
 113         len = 0;
 114         curr_parm = 0;
 115         start = (-1);
 116         end = (-1);
 117
 118         slen = strlen(source);
 119         if (slen == 0) {
 120                 return;
 121         }
 122
 123         for (i = 0;
 124              ( (i < slen)  && (end == -1) );
 125              ++i) {
 126                 if ((start < 0) && (curr_parm == parmnum)) {
 127                         start = i;
 128                 }
 129
 130                 if ((end < 0) && (curr_parm == (parmnum + 1))) {
 131                         end = i;
 132                 }
 133
 134                 if (source[i] == separator) {
 135                         ++curr_parm;
 136                 }
 137         }
 138
 139         if (end < 0)
 140                 end = slen;
 141
 142         memmove(&source[start], &source[end], slen - end + 1);
 143 }
 144
 145
 146
 147
 148 /**
 149  * \brief extract an int parm w/o supplying a buffer
 150  * \param source the string to locate the int in
 151  * \param parmnum the n'th token to grab the int from
 152  * \return the integer
 153  */
 154 int extract_int(const char *source, int parmnum)
 155 {
 156         char buf[32];
 157
 158         extract_token(buf, source, parmnum, '|', sizeof buf);
 159         return(atoi(buf));
 160 }
 161
 162 /**
 163  * \brief extract an long parm w/o supplying a buffer
 164  * \param source string to examine
 165  * \param parmnum n'th token to search long in
 166  * \return the found long value
 167  */
 168 long extract_long(const char *source, int parmnum)
 169 {
 170         char buf[32];
 171
 172         extract_token(buf, source, parmnum, '|', sizeof buf);
 173         return(atol(buf));
 174 }
 175
 176
 177
 178
 179
 180
 181 /**
 182  * \brief check for the presence of a character within a string (returns count)
 183  * \param st the string to examine
 184  * \param ch the char to search
 185  * \return the position inside of st
 186  */
 187 int haschar(char *st,char ch)
 188 {
 189         int a, b;
 190         b = 0;
 191         for (a = 0; a < strlen(st); ++a)
 192                 if (st[a] == ch)
 193                         ++b;
 194         return (b);
 195 }
 196
 197
 198 /**
 199  * \brief Utility function to "readline" from memory
 200  * \param start Location in memory from which we are reading.
 201  * \param buf the buffer to place the string in.
 202  * \param maxlen Size of string buffer
 203  * \return Pointer to the source memory right after we stopped reading.
 204  */
 205 char *memreadline(char *start, char *buf, int maxlen)
 206 {
 207         char ch;
 208         char *ptr;
 209         int len = 0;            /**< tally our own length to avoid strlen() delays */
 210
 211         ptr = start;
 212         memset(buf, 0, maxlen);
 213
 214         while (1) {
 215                 ch = *ptr++;
 216                 if ((len < (maxlen - 1)) && (ch != 13) && (ch != 10)) {
 217                         buf[strlen(buf) + 1] = 0;
 218                         buf[strlen(buf)] = ch;
 219                         ++len;
 220                 }
 221                 if ((ch == 10) || (ch == 0)) {
 222                         return ptr;
 223                 }
 224         }
 225 }
 226
 227
 228
 229 /**
 230  * \brief searches for a  paternn within asearch string
 231  * \param search the string to search
 232  * \param patn the pattern to find in string
 233  * \returns position in string
 234  */
 235 int pattern2(char *search, char *patn)
 236 {
 237         int a;
 238         for (a = 0; a < strlen(search); ++a) {
 239                 if (!strncasecmp(&search[a], patn, strlen(patn)))
 240                         return (a);
 241         }
 242         return (-1);
 243 }
 244
 245
 246 /**
 247  * \brief Strip leading and trailing spaces from a string
 248  * \param buf the string to modify
 249  */
 250 void striplt(char *buf)
 251 {
 252         if (strlen(buf) == 0) return;
 253         while ((strlen(buf) > 0) && (isspace(buf[0])))
 254                 strcpy(buf, &buf[1]);
 255         if (strlen(buf) == 0) return;
 256         while (isspace(buf[strlen(buf) - 1]))
 257                 buf[strlen(buf) - 1] = 0;
 258 }
 259
 260
 261 /**
 262  * \brief Determine whether the specified message number is contained within the
 263  * specified set.
 264  *
 265  * \param mset Message set string
 266  * \param msgnum Message number we are looking for
 267  *
 268  * \return Nonzero if the specified message number is in the specified message set string.
 269  */
 270 int is_msg_in_mset(char *mset, long msgnum) {
 271         int num_sets;
 272         int s;
 273         char setstr[SIZ], lostr[SIZ], histr[SIZ];       /* was 1024 */
 274         long lo, hi;
 275
 276         /*
 277          * Now set it for all specified messages.
 278          */
 279         num_sets = num_tokens(mset, ',');
 280         for (s=0; s<num_sets; ++s) {
 281                 extract_token(setstr, mset, s, ',', sizeof setstr);
 282
 283                 extract_token(lostr, setstr, 0, ':', sizeof lostr);
 284                 if (num_tokens(setstr, ':') >= 2) {
 285                         extract_token(histr, setstr, 1, ':', sizeof histr);
 286                         if (!strcmp(histr, "*")) {
 287                                 snprintf(histr, sizeof histr, "%ld", LONG_MAX);
 288                         }
 289                 }
 290                 else {
 291                         strcpy(histr, lostr);
 292                 }
 293                 lo = atol(lostr);
 294                 hi = atol(histr);
 295
 296                 if ((msgnum >= lo) && (msgnum <= hi)) return(1);
 297         }
 298
 299         return(0);
 300 }
 301
 302
 303
 304 /**
 305  * \brief Strip a boundarized substring out of a string
 306  * (for example, remove
 307  * parentheses and anything inside them).
 308  *
 309  * This improved version can strip out *multiple* boundarized substrings.
 310  * \param str the string to process
 311  * \param leftboundary the boundary character on the left side of the target string
 312  * \param rightboundary the boundary character on the right side of the target string
 313  */
 314 void stripout(char *str, char leftboundary, char rightboundary)
 315 {
 316         int a;
 317         int lb = (-1);
 318         int rb = (-1);
 319
 320         do {
 321                 lb = (-1);
 322                 rb = (-1);
 323
 324                 for (a = 0; a < strlen(str); ++a) {
 325                         if (str[a] == leftboundary)
 326                                 lb = a;
 327                         if (str[a] == rightboundary)
 328                                 rb = a;
 329                 }
 330
 331                 if ((lb > 0) && (rb > lb)) {
 332                         strcpy(&str[lb - 1], &str[rb + 1]);
 333                 }
 334
 335         } while ((lb > 0) && (rb > lb));
 336
 337 }
 338
 339
 340
 341 /**
 342  * \brief Replacement for sleep() that uses select() in order to avoid SIGALRM
 343  * \param seconds how many seconds should we sleep?
 344  */
 345 void sleeeeeeeeeep(int seconds)
 346 {
 347         struct timeval tv;
 348
 349         tv.tv_sec = seconds;
 350         tv.tv_usec = 0;
 351         select(0, NULL, NULL, NULL, &tv);
 352 }
 353
 354
 355
 356 /**
 357  * \brief encode a string into base64 to for example tunnel it through mail transport
 358  * CtdlDecodeBase64() and CtdlEncodeBase64() are adaptations of code by
 359  * John Walker, copied over from the Citadel server.
 360  * \param dest encrypted string
 361  * \param source the string to encrypt
 362  * \param sourcelen the length of the source data (may contain string terminators)
 363  */
 364
 365 void CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks)
 366 {
 367         int i, hiteof = FALSE;
 368         int spos = 0;
 369         int dpos = 0;
 370         int thisline = 0;
 371
 372         /**  Fill dtable with character encodings.  */
 373
 374         for (i = 0; i < 26; i++) {
 375                 dtable[i] = 'A' + i;
 376                 dtable[26 + i] = 'a' + i;
 377         }
 378         for (i = 0; i < 10; i++) {
 379                 dtable[52 + i] = '0' + i;
 380         }
 381         dtable[62] = '+';
 382         dtable[63] = '/';
 383
 384         while (!hiteof) {
 385                 byte igroup[3], ogroup[4];
 386                 int c, n;
 387
 388                 igroup[0] = igroup[1] = igroup[2] = 0;
 389                 for (n = 0; n < 3; n++) {
 390                         if (spos >= sourcelen) {
 391                                 hiteof = TRUE;
 392                                 break;
 393                         }
 394                         c = source[spos++];
 395                         igroup[n] = (byte) c;
 396                 }
 397                 if (n > 0) {
 398                         ogroup[0] = dtable[igroup[0] >> 2];
 399                         ogroup[1] =
 400                             dtable[((igroup[0] & 3) << 4) |
 401                                    (igroup[1] >> 4)];
 402                         ogroup[2] =
 403                             dtable[((igroup[1] & 0xF) << 2) |
 404                                    (igroup[2] >> 6)];
 405                         ogroup[3] = dtable[igroup[2] & 0x3F];
 406
 407                         /**
 408                          * Replace characters in output stream with "=" pad
 409                          * characters if fewer than three characters were
 410                          * read from the end of the input stream.
 411                          */
 412
 413                         if (n < 3) {
 414                                 ogroup[3] = '=';
 415                                 if (n < 2) {
 416                                         ogroup[2] = '=';
 417                                 }
 418                         }
 419                         for (i = 0; i < 4; i++) {
 420                                 dest[dpos++] = ogroup[i];
 421                                 dest[dpos] = 0;
 422                         }
 423                         thisline += 4;
 424                         if ( (linebreaks) && (thisline > 70) ) {
 425                                 dest[dpos++] = '\r';
 426                                 dest[dpos++] = '\n';
 427                                 dest[dpos] = 0;
 428                                 thisline = 0;
 429                         }
 430                 }
 431         }
 432         if ( (linebreaks) && (thisline > 70) ) {
 433                 dest[dpos++] = '\r';
 434                 dest[dpos++] = '\n';
 435                 dest[dpos] = 0;
 436                 thisline = 0;
 437         }
 438 }
 439
 440
 441 /**
 442  * \brief Convert base64-encoded to binary.
 443  * It will stop after reading 'length' bytes.
 444  *
 445  * \param dest The destination buffer
 446  * \param source The base64 data to be decoded.
 447  * \param length The number of bytes to decode.
 448  * \return The actual length of the decoded data.
 449  */
 450 int CtdlDecodeBase64(char *dest, const char *source, size_t length)
 451 {
 452         int i, c;
 453         int dpos = 0;
 454         int spos = 0;
 455
 456         for (i = 0; i < 255; i++) {
 457                 dtable[i] = 0x80;
 458         }
 459         for (i = 'A'; i <= 'Z'; i++) {
 460                 dtable[i] = 0 + (i - 'A');
 461         }
 462         for (i = 'a'; i <= 'z'; i++) {
 463                 dtable[i] = 26 + (i - 'a');
 464         }
 465         for (i = '0'; i <= '9'; i++) {
 466                 dtable[i] = 52 + (i - '0');
 467         }
 468         dtable['+'] = 62;
 469         dtable['/'] = 63;
 470         dtable['='] = 0;
 471
 472         /**CONSTANTCONDITION*/ while (TRUE) {
 473                 byte a[4], b[4], o[3];
 474
 475                 for (i = 0; i < 4; i++) {
 476                         if (spos >= length) {
 477                                 return (dpos);
 478                         }
 479                         c = source[spos++];
 480
 481                         if (c == 0) {
 482                                 if (i > 0) {
 483                                         return (dpos);
 484                                 }
 485                                 return (dpos);
 486                         }
 487                         if (dtable[c] & 0x80) {
 488                                 /** Ignoring errors: discard invalid character */
 489                                 i--;
 490                                 continue;
 491                         }
 492                         a[i] = (byte) c;
 493                         b[i] = (byte) dtable[c];
 494                 }
 495                 o[0] = (b[0] << 2) | (b[1] >> 4);
 496                 o[1] = (b[1] << 4) | (b[2] >> 2);
 497                 o[2] = (b[2] << 6) | b[3];
 498                 i = a[2] == '=' ? 1 : (a[3] == '=' ? 2 : 3);
 499                 if (i >= 1)
 500                         dest[dpos++] = o[0];
 501                 if (i >= 2)
 502                         dest[dpos++] = o[1];
 503                 if (i >= 3)
 504                         dest[dpos++] = o[2];
 505                 dest[dpos] = 0;
 506                 if (i < 3) {
 507                         return (dpos);
 508                 }
 509         }
 510 }
 511
 512
 513
 514 /**
 515  * \brief Generate a new, globally unique UID parameter for a calendar etc. object
 516  *
 517  * \param buf String buffer into which our newly created UUID should be placed
 518  */
 519 void generate_uuid(char *buf) {
 520         static int seq = 0;
 521
 522         sprintf(buf, "%s-%lx-%lx-%x",
 523                 serv_info.serv_nodename,
 524                 (long)time(NULL),
 525                 (long)getpid(),
 526                 (seq++)
 527         );
 528 }
 529
 530
 531 /**
 532  * \brief Local replacement for controversial C library function that generates
 533  * names for temporary files.  Included to shut up compiler warnings.
 534  * \todo return a fd to the file instead of the name for security reasons
 535  * \param name the created filename
 536  * \param len the length of the filename
 537  */
 538 void CtdlMakeTempFileName(char *name, int len) {
 539         int i = 0;
 540
 541         while (i++, i < 100) {
 542                 snprintf(name, len, "/tmp/ctdl.%04x.%04x",
 543                         getpid(),
 544                         rand()
 545                 );
 546                 if (!access(name, F_OK)) {
 547                         return;
 548                 }
 549         }
 550 }
 551
 552
 553
 554 /*
 555  * \brief       case-insensitive substring search
 556  *
 557  *              This uses the Boyer-Moore search algorithm and is therefore quite fast.
 558  *              The code is roughly based on the strstr() replacement from 'tin' written
 559  *              by Urs Jannsen.
 560  *
 561  * \param       text    String to be searched
 562  * \param       pattern String to search for
 563  */
 564 char *bmstrcasestr(char *text, char *pattern) {
 565
 566         register unsigned char *p, *t;
 567         register int i, j, *delta;
 568         register size_t p1;
 569         int deltaspace[256];
 570         size_t textlen;
 571         size_t patlen;
 572
 573         textlen = strlen (text);
 574         patlen = strlen (pattern);
 575
 576         /* algorithm fails if pattern is empty */
 577         if ((p1 = patlen) == 0)
 578                 return (text);
 579
 580         /* code below fails (whenever i is unsigned) if pattern too long */
 581         if (p1 > textlen)
 582                 return (NULL);
 583
 584         /* set up deltas */
 585         delta = deltaspace;
 586         for (i = 0; i <= 255; i++)
 587                 delta[i] = p1;
 588         for (p = (unsigned char *) pattern, i = p1; --i > 0;)
 589                 delta[tolower(*p++)] = i;
 590
 591         /*
 592          * From now on, we want patlen - 1.
 593          * In the loop below, p points to the end of the pattern,
 594          * t points to the end of the text to be tested against the
 595          * pattern, and i counts the amount of text remaining, not
 596          * including the part to be tested.
 597          */
 598         p1--;
 599         p = (unsigned char *) pattern + p1;
 600         t = (unsigned char *) text + p1;
 601         i = textlen - patlen;
 602         while(1) {
 603                 if (tolower(p[0]) == tolower(t[0])) {
 604                         if (strncasecmp ((const char *)(p - p1), (const char *)(t - p1), p1) == 0) {
 605                                 return ((char *)t - p1);
 606                         }
 607                 }
 608                 j = delta[tolower(t[0])];
 609                 if (i < j)
 610                         break;
 611                 i -= j;
 612                 t += j;
 613         }
 614         return (NULL);
 615 }
 616
 617
 618
 619
 620
 621 /*@}*/