reader.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef BACKENDS_NETWORKING_SDL_NET_READER_H
#define BACKENDS_NETWORKING_SDL_NET_READER_H

#include "common/str.h"
#include "common/hashmap.h"
#include "common/hash-str.h"

namespace Common {
class MemoryReadWriteStream;
class WriteStream;
}

namespace Networking {

enum ReaderState {
    RS_NONE,
    RS_READING_HEADERS,
    RS_READING_CONTENT
};

enum ReaderMode {
    RM_HTTP_GENERIC,
    RM_POST_FORM_MULTIPART
};

class Reader {
    ReaderState _state;
    ReaderMode _mode;
    Common::MemoryReadWriteStream *_content;
    uint32 _bytesLeft;

    byte *_window;
    uint32 _windowUsed, _windowSize, _windowReadPosition, _windowWritePosition;
    uint32 _windowHash;

    Common::MemoryReadWriteStream *_headersStream;

    Common::String _headers;
    Common::String _method, _path, _query, _anchor;
    Common::HashMap<Common::String, Common::String> _queryParameters;
    uint32 _contentLength;
    Common::String _boundary;
    uint32 _availableBytes;
    bool _firstBlock;
    bool _isBadRequest;
    bool _allContentRead;

    void cleanup();

    bool readAndHandleFirstHeaders(); //true when ended reading
    bool readBlockHeadersIntoStream(Common::WriteStream *stream); //true when ended reading
    bool readContentIntoStream(Common::WriteStream *stream); //true when ended reading

    void handleFirstHeaders(Common::MemoryReadWriteStream *headers);
    void parseFirstLine(const Common::String &headers);
    void parsePathQueryAndAnchor(const Common::String &pathToParse);
    void parseQueryParameters();

    void makeWindow(uint32 size);
    void freeWindow();
    bool readOneByteInStream(Common::WriteStream *stream, const Common::String &boundary, const uint32 boundaryHash);

    byte readOne();
    uint32 bytesLeft() const;

public:
    static const int32 SUSPICIOUS_HEADERS_SIZE = 1024 * 1024; // 1 MB is really a lot

    Reader();
    ~Reader();

    Reader &operator=(Reader &r);

    bool readFirstHeaders(); //true when ended reading
    bool readContent(Common::WriteStream *stream); //true when ended reading
    bool readFirstContent(Common::WriteStream *stream); //true when ended reading
    bool readBlockHeaders(Common::WriteStream *stream); //true when ended reading
    bool readBlockContent(Common::WriteStream *stream); //true when ended reading

    void setMode(ReaderMode mode);
    void setContent(Common::MemoryReadWriteStream *stream);

    bool badRequest() const;
    bool noMoreContent() const;

    Common::String headers() const;
    Common::String method() const;
    Common::String path() const;
    Common::String query() const;
    Common::String queryParameter(const Common::String &name) const;
    Common::String anchor() const;

    static Common::String readEverythingFromMemoryStream(Common::MemoryReadWriteStream *stream);
};

} // End of namespace Networking

#endif