[thirdparty/squid.git] / src / ChunkedCodingParser.h

/*
 * Copyright (C) 1996-2015 The Squid Software Foundation and contributors
 *
 * Squid software is distributed under GPLv2+ license and includes
 * contributions from numerous individuals and organizations.
 * Please see the COPYING and CONTRIBUTORS files for details.
 */

#ifndef SQUID_CHUNKEDCODINGPARSER_H
#define SQUID_CHUNKEDCODINGPARSER_H

class MemBuf;

/**
 \ingroup ChunkEncodingAPI Chunked Encoding API
 \par
 * ChunkedCodingParser is an incremental parser for chunked transfer coding
 * used by HTTP and ICAP. The parser shovels content bytes from the raw
 * input buffer into the content output buffer, both caller-supplied.
 * Ignores chunk extensions except for ICAP's ieof.
 * Has a trailer-handling placeholder.
 */
class ChunkedCodingParser
{

public:
    ChunkedCodingParser();

    void reset();

    /**
     \retval true    complete success
     \retval false   needs more data
     \throws ??      error.
     */
    bool parse(MemBuf *rawData, MemBuf *parsedContent);

    bool needsMoreData() const;
    bool needsMoreSpace() const;

private:
    typedef void (ChunkedCodingParser::*Step)();

private:
    bool mayContinue() const;

    void parseChunkSize();
    void parseUnusedChunkExtension();
    void parseLastChunkExtension();
    void parseChunkBeg();
    void parseChunkBody();
    void parseChunkEnd();
    void parseTrailer();
    void parseTrailerHeader();
    void parseMessageEnd();

    bool findCrlf(size_t &crlfBeg, size_t &crlfEnd);
    bool findCrlf(size_t &crlfBeg, size_t &crlfEnd, bool &quoted, bool &slashed);

private:
    static Step psChunkSize;
    static Step psUnusedChunkExtension;
    static Step psLastChunkExtension;
    static Step psChunkBody;
    static Step psChunkEnd;
    static Step psTrailer;
    static Step psMessageEnd;

    MemBuf *theIn;
    MemBuf *theOut;

    Step theStep;
    uint64_t theChunkSize;
    uint64_t theLeftBodySize;
    bool doNeedMoreData;
    bool inQuoted; ///< stores parsing state for incremental findCrlf
    bool inSlashed; ///< stores parsing state for incremental findCrlf

public:
    int64_t useOriginBody;
};

#endif /* SQUID_CHUNKEDCODINGPARSER_H */
Commit	Line	Data
774c051c	1	/*
bde978a6	2	* Copyright (C) 1996-2015 The Squid Software Foundation and contributors
774c051c	3	*
bbc27441 AJ	4	* Squid software is distributed under GPLv2+ license and includes
	5	* contributions from numerous individuals and organizations.
	6	* Please see the COPYING and CONTRIBUTORS files for details.
774c051c	7	*/
bbc27441	8
774c051c	9	#ifndef SQUID_CHUNKEDCODINGPARSER_H
	10	#define SQUID_CHUNKEDCODINGPARSER_H
	11
e1f7507e	12	class MemBuf;
774c051c	13
e1f7507e AJ	14	/**
	15	\ingroup ChunkEncodingAPI Chunked Encoding API
	16	\par
	17	* ChunkedCodingParser is an incremental parser for chunked transfer coding
	18	* used by HTTP and ICAP. The parser shovels content bytes from the raw
	19	* input buffer into the content output buffer, both caller-supplied.
	20	* Ignores chunk extensions except for ICAP's ieof.
	21	* Has a trailer-handling placeholder.
	22	*/
774c051c	23	class ChunkedCodingParser
	24	{
	25
	26	public:
	27	ChunkedCodingParser();
	28
	29	void reset();
	30
e1f7507e AJ	31	/**
	32	\retval true complete success
	33	\retval false needs more data
	34	\throws ?? error.
	35	*/
	36	bool parse(MemBuf rawData, MemBuf parsedContent);
774c051c	37
	38	bool needsMoreData() const;
	39	bool needsMoreSpace() const;
774c051c	40
	41	private:
	42	typedef void (ChunkedCodingParser::*Step)();
	43
	44	private:
	45	bool mayContinue() const;
	46
5c550f5f AR	47	void parseChunkSize();
	48	void parseUnusedChunkExtension();
	49	void parseLastChunkExtension();
774c051c	50	void parseChunkBeg();
	51	void parseChunkBody();
	52	void parseChunkEnd();
	53	void parseTrailer();
	54	void parseTrailerHeader();
	55	void parseMessageEnd();
	56
	57	bool findCrlf(size_t &crlfBeg, size_t &crlfEnd);
5c550f5f	58	bool findCrlf(size_t &crlfBeg, size_t &crlfEnd, bool &quoted, bool &slashed);
774c051c	59
774c051c	60	private:
5c550f5f AR	61	static Step psChunkSize;
	62	static Step psUnusedChunkExtension;
	63	static Step psLastChunkExtension;
774c051c	64	static Step psChunkBody;
	65	static Step psChunkEnd;
	66	static Step psTrailer;
	67	static Step psMessageEnd;
	68
	69	MemBuf *theIn;
	70	MemBuf *theOut;
	71
	72	Step theStep;
47f6e231	73	uint64_t theChunkSize;
47f6e231	74	uint64_t theLeftBodySize;
774c051c	75	bool doNeedMoreData;
5c550f5f AR	76	bool inQuoted; ///< stores parsing state for incremental findCrlf
5c550f5f AR	77	bool inSlashed; ///< stores parsing state for incremental findCrlf
83c51da9 CT	78
	79	public:
	80	int64_t useOriginBody;
774c051c	81	};
	82
	83	#endif /* SQUID_CHUNKEDCODINGPARSER_H */
f53969cc	84