lib/http_chunks.h

   1 #ifndef __HTTP_CHUNKS_H
   2 #define __HTTP_CHUNKS_H
   3 /***************************************************************************
   4  *                                  _   _ ____  _
   5  *  Project                     ___| | | |  _ \| |
   6  *                             / __| | | | |_) | |
   7  *                            | (__| |_| |  _ <| |___
   8  *                             \___|\___/|_| \_\_____|
   9  *
  10  * Copyright (C) 1998 - 2007, Daniel Stenberg, <daniel@haxx.se>, et al.
  11  *
  12  * This software is licensed as described in the file COPYING, which
  13  * you should have received as part of this distribution. The terms
  14  * are also available at http://curl.haxx.se/docs/copyright.html.
  15  *
  16  * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  17  * copies of the Software, and permit persons to whom the Software is
  18  * furnished to do so, under the terms of the COPYING file.
  19  *
  20  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  21  * KIND, either express or implied.
  22  *
  23  ***************************************************************************/
  24 /*
  25  * The longest possible hexadecimal number we support in a chunked transfer.
  26  * Weird enough, RFC2616 doesn't set a maximum size! Since we use strtoul()
  27  * to convert it, we "only" support 2^32 bytes chunk data.
  28  */
  29 #define MAXNUM_SIZE 16
  30
  31 typedef enum {
  32   CHUNK_FIRST, /* never use */
  33
  34   /* In this we await and buffer all hexadecimal digits until we get one
  35      that isn't a hexadecimal digit. When done, we go POSTHEX */
  36   CHUNK_HEX,
  37
  38   /* We have received the hexadecimal digit and we eat all characters until
  39      we get a CRLF pair. When we see a CR we go to the CR state. */
  40   CHUNK_POSTHEX,
  41
  42   /* A single CR has been found and we should get a LF right away in this
  43      state or we go back to POSTHEX. When LF is received, we go to DATA.
  44      If the size given was zero, we set state to STOP and return. */
  45   CHUNK_CR,
  46
  47   /* We eat the amount of data specified. When done, we move on to the
  48      POST_CR state. */
  49   CHUNK_DATA,
  50
  51   /* POSTCR should get a CR and nothing else, then move to POSTLF */
  52   CHUNK_POSTCR,
  53
  54   /* POSTLF should get a LF and nothing else, then move back to HEX as the
  55      CRLF combination marks the end of a chunk */
  56   CHUNK_POSTLF,
  57
  58   /* Each Chunk body should end with a CRLF.  Read a CR and nothing else,
  59      then move to CHUNK_STOP */
  60   CHUNK_STOPCR,
  61
  62   /* This is mainly used to really mark that we're out of the game.
  63      NOTE: that there's a 'dataleft' field in the struct that will tell how
  64      many bytes that were not passed to the client in the end of the last
  65      buffer! */
  66   CHUNK_STOP,
  67
  68   /* At this point optional trailer headers can be found, unless the next line
  69      is CRLF */
  70   CHUNK_TRAILER,
  71
  72   /* A trailer CR has been found - next state is CHUNK_TRAILER_POSTCR.
  73      Next char must be a LF */
  74   CHUNK_TRAILER_CR,
  75
  76   /* A trailer LF must be found now, otherwise CHUNKE_BAD_CHUNK will be
  77      signalled If this is an empty trailer CHUNKE_STOP will be signalled.
  78      Otherwise the trailer will be broadcasted via Curl_client_write() and the
  79      next state will be CHUNK_TRAILER */
  80   CHUNK_TRAILER_POSTCR,
  81
  82   CHUNK_LAST /* never use */
  83
  84 } ChunkyState;
  85
  86 typedef enum {
  87   CHUNKE_STOP = -1,
  88   CHUNKE_OK = 0,
  89   CHUNKE_TOO_LONG_HEX = 1,
  90   CHUNKE_ILLEGAL_HEX,
  91   CHUNKE_BAD_CHUNK,
  92   CHUNKE_WRITE_ERROR,
  93   CHUNKE_STATE_ERROR,
  94   CHUNKE_BAD_ENCODING,
  95   CHUNKE_OUT_OF_MEMORY,
  96   CHUNKE_LAST
  97 } CHUNKcode;
  98
  99 struct Curl_chunker {
 100   char hexbuffer[ MAXNUM_SIZE + 1];
 101   int hexindex;
 102   ChunkyState state;
 103   size_t datasize;
 104   size_t dataleft; /* untouched data amount at the end of the last buffer */
 105 };
 106
 107 #endif