chiark - git - mdw - mLib/blob - url.c

   1 /* -*-c-*-
   2  *
   3  * $Id: url.c,v 1.5 2004/04/08 01:36:13 mdw Exp $
   4  *
   5  * Parsing and construction of url-encoded name/value pairs
   6  *
   7  * (c) 1999 Straylight/Edgeware
   8  */
   9
  10 /*----- Licensing notice --------------------------------------------------*
  11  *
  12  * This file is part of the mLib utilities library.
  13  *
  14  * mLib is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU Library General Public License as
  16  * published by the Free Software Foundation; either version 2 of the
  17  * License, or (at your option) any later version.
  18  *
  19  * mLib is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU Library General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU Library General Public
  25  * License along with mLib; if not, write to the Free
  26  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  27  * MA 02111-1307, USA.
  28  */
  29
  30 /*----- Header files ------------------------------------------------------*/
  31
  32 #include <ctype.h>
  33 #include <stdio.h>
  34 #include <stdlib.h>
  35 #include <string.h>
  36
  37 #include "dstr.h"
  38 #include "url.h"
  39
  40 /*----- Main code ---------------------------------------------------------*/
  41
  42 /* --- @url_initenc@ --- *
  43  *
  44  * Arguments:   @url_ectx *ctx@ = pointer to context block
  45  *
  46  * Returns:     ---
  47  *
  48  * Use:         Initializes a URL encoding context.
  49  */
  50
  51 void url_initenc(url_ectx *ctx) { ctx->f = 0; }
  52
  53 /* --- @encode@ --- *
  54  *
  55  * Arguments:   @url_ectx *ctx@ = encoding context
  56  *              @dstr *d@ = pointer to output string
  57  *              @const char *p@ = pointer to thing to encode
  58  *
  59  * Returns:     ---
  60  *
  61  * Use:         Encodes the input string into the output string.
  62  */
  63
  64 static void encode(url_ectx *ctx, dstr *d, const char *p)
  65 {
  66   while (*p) {
  67     switch (*p) {
  68       case ' ':
  69         DPUTC(d, '+');
  70         break;
  71       default:
  72         if ((ctx->f & URLF_LAX) || isalnum((unsigned char)*p))
  73           goto safe;
  74         else
  75           goto unsafe;
  76       case '/':
  77       case '~':
  78         if (ctx->f & URLF_STRICT)
  79           goto unsafe;
  80       case '-':
  81       case '.':
  82       case '_':
  83       safe:
  84         DPUTC(d, *p);
  85         break;
  86       unsafe:
  87       case '+':
  88       case '%':
  89       case '=':
  90       case '&':
  91       case ';':
  92         dstr_putf(d, "%%%02x", *p);
  93         break;
  94     }
  95     p++;
  96   }
  97 }
  98
  99 /* --- @url_enc@ --- *
 100  *
 101  * Arguments:   @url_ectx *ctx@ = pointer to encoding context
 102  *              @dstr *d@ = pointer to output string
 103  *              @const char *name@ = pointer to name
 104  *              @const char *value@ = pointer to value
 105  *
 106  * Returns:     ---
 107  *
 108  * Use:         Writes an assignment between @name@ and @value@ to the
 109  *              output string, encoding the values properly.
 110  */
 111
 112 void url_enc(url_ectx *ctx, dstr *d, const char *name, const char *value)
 113 {
 114   if (ctx->f & URLF_SEP)
 115     DPUTC(d, '&');
 116   encode(ctx, d, name);
 117   DPUTC(d, '=');
 118   encode(ctx, d, value);
 119   DPUTZ(d);
 120   ctx->f |= URLF_SEP;
 121 }
 122
 123 /* --- @url_initdec@ --- *
 124  *
 125  * Arguments:   @url_dctx *ctx@ = pointer to context block
 126  *              @const char *p@ = string to read data from
 127  *
 128  * Returns:     ---
 129  *
 130  * Use:         Initializes a URL decoding context.
 131  */
 132
 133 void url_initdec(url_dctx *ctx, const char *p) { ctx->p = p; }
 134
 135 /* --- @decode@ --- *
 136  *
 137  * Arguments:   @dstr *d@ = pointer to output string
 138  *              @const char *p@ = pointer to input data
 139  *              @int eq@ = whether to stop at `=' characters
 140  *
 141  * Returns:     Pointer to next available character.
 142  *
 143  * Use:         Does a URL decode.
 144  */
 145
 146 static const char *decode(dstr *d, const char *p, int eq)
 147 {
 148   if (!*p)
 149     return (0);
 150   for (;;) {
 151     switch (*p) {
 152       case '=':
 153         if (eq)
 154           return (p);
 155         DPUTC(d, *p);
 156         break;
 157       case 0:
 158       case '&':
 159         return (p);
 160       case '+':
 161         DPUTC(d, ' ');
 162         break;
 163       case '%': {
 164         unsigned int ch;
 165         int n;
 166         int x = sscanf(p + 1, "%2x%n", &ch, &n);
 167         if (x == 1) {
 168           DPUTC(d, ch);
 169           p += n;
 170           break;
 171         }
 172       }
 173       default:
 174         DPUTC(d, *p);
 175         break;
 176     }
 177     p++;
 178   }
 179 }
 180
 181 /* --- @url_dec@ --- *
 182  *
 183  * Arguments:   @url_dctx *ctx@ = pointer to decode context
 184  *              @dstr *n@ = pointer to output string for name
 185  *              @dstr *v@ = pointer to output string for value
 186  *
 187  * Returns:     Nonzero if it read something, zero if there's nothing left
 188  *
 189  * Use:         Decodes the next name/value pair from a urlencoded string.
 190  */
 191
 192 int url_dec(url_dctx *ctx, dstr *n, dstr *v)
 193 {
 194   const char *p = ctx->p;
 195   size_t l = n->len;
 196
 197 again:
 198   if ((p = decode(n, p, 1)) == 0 || *p == 0)
 199     return (0);
 200   if (*p != '=') {
 201     p++;
 202     n->len = l;
 203     goto again;
 204   }
 205   p++;
 206   if ((p = decode(v, p, 0)) == 0)
 207     return (0);
 208   DPUTZ(n);
 209   DPUTZ(v);
 210   ctx->p = p;
 211   return (1);
 212 }
 213
 214 /*----- That's all, folks -------------------------------------------------*/