src/ICAP/ChunkedCodingParser.h

   1
   2 /*
   3  * $Id: ChunkedCodingParser.h,v 1.3 2007/08/13 17:20:53 hno Exp $
   4  *
   5  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   6  * ----------------------------------------------------------
   7  *
   8  *  Squid is the result of efforts by numerous individuals from
   9  *  the Internet community; see the CONTRIBUTORS file for full
  10  *  details.   Many organizations have provided support for Squid's
  11  *  development; see the SPONSORS file for full details.  Squid is
  12  *  Copyrighted (C) 2001 by the Regents of the University of
  13  *  California; see the COPYRIGHT file for full details.  Squid
  14  *  incorporates software developed and/or copyrighted by other
  15  *  sources; see the CREDITS file for full details.
  16  *
  17  *  This program is free software; you can redistribute it and/or modify
  18  *  it under the terms of the GNU General Public License as published by
  19  *  the Free Software Foundation; either version 2 of the License, or
  20  *  (at your option) any later version.
  21  *
  22  *  This program is distributed in the hope that it will be useful,
  23  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  *  GNU General Public License for more details.
  26  *
  27  *  You should have received a copy of the GNU General Public License
  28  *  along with this program; if not, write to the Free Software
  29  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  30  *
  31  */
  32
  33 #ifndef SQUID_CHUNKEDCODINGPARSER_H
  34 #define SQUID_CHUNKEDCODINGPARSER_H
  35
  36 #include "RefCount.h"
  37
  38 // ChunkedCodingParser is an incremental parser for chunked transfer coding
  39 // used by HTTP and ICAP. The parser shovels content bytes from the raw
  40 // input buffer into the content output buffer, both caller-supplied.
  41 // Ignores chunk extensions except for ICAP's ieof.
  42 // Has a trailer-handling placeholder.
  43
  44 class ChunkedCodingParser
  45 {
  46
  47 public:
  48     ChunkedCodingParser();
  49
  50     void reset();
  51
  52     // true = complete success; false == needs more data
  53     bool parse(MemBuf *rawData, MemBuf *parsedContent); // throws on error
  54
  55     bool needsMoreData() const;
  56     bool needsMoreSpace() const;
  57     bool sawIeof; // saw ieof chunk extension after a 0-size chunk
  58
  59 private:
  60     typedef void (ChunkedCodingParser::*Step)();
  61
  62 private:
  63     bool mayContinue() const;
  64
  65     void parseChunkBeg();
  66     void parseChunkBody();
  67     void parseChunkEnd();
  68     void parseTrailer();
  69     void parseTrailerHeader();
  70     void parseMessageEnd();
  71
  72     bool findCrlf(size_t &crlfBeg, size_t &crlfEnd);
  73
  74 private:
  75     static Step psChunkBeg;
  76     static Step psChunkBody;
  77     static Step psChunkEnd;
  78     static Step psTrailer;
  79     static Step psMessageEnd;
  80
  81     MemBuf *theIn;
  82     MemBuf *theOut;
  83
  84     Step theStep;
  85     uint64_t theChunkSize;
  86     uint64_t theLeftBodySize;
  87     bool doNeedMoreData;
  88 };
  89
  90 #endif /* SQUID_CHUNKEDCODINGPARSER_H */