Removed httpHeaderStoreReport from the global namespace.

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

#ifndef SQUID_HTTPHEADERTOOLS_H
#define SQUID_HTTPHEADERTOOLS_H

#include "format/Format.h"
#include "HttpHeader.h"
#include "typedefs.h"

#if HAVE_LIST
#include <list>
#endif
#if HAVE_MAP
#include <map>
#endif
#if HAVE_STRING
#include <string>
#endif

class HeaderWithAcl;
typedef std::list<HeaderWithAcl> HeaderWithAclList;

class acl_access;
struct _header_mangler {
    acl_access *access_list;
    char *replacement;
};
typedef struct _header_mangler header_mangler;

class StoreEntry;

/// A collection of header_mangler objects for a given message kind.
class HeaderManglers
{
public:
    HeaderManglers();
    ~HeaderManglers();

    /// returns a header mangler for field e or nil if none was specified
    const header_mangler *find(const HttpHeaderEntry &e) const;

    /// returns a mangler for the named header (known or custom)
    header_mangler *track(const char *name);

    /// updates mangler for the named header with a replacement value
    void setReplacement(const char *name, const char *replacementValue);

    /// report the *_header_access part of the configuration
    void dumpAccess(StoreEntry *entry, const char *optionName) const;
    /// report the *_header_replace part of the configuration
    void dumpReplacement(StoreEntry *entry, const char *optionName) const;

private:
    /// a name:mangler map; optimize: use unordered map or some such
    typedef std::map<std::string, header_mangler> ManglersByName;

    /// one mangler for each known header
    header_mangler known[HDR_ENUM_END];

    /// one mangler for each custom header
    ManglersByName custom;

    /// configured if some mangling ACL applies to all header names
    header_mangler all;

private:
    /* not implemented */
    HeaderManglers(const HeaderManglers &);
    HeaderManglers &operator =(const HeaderManglers &);
};

class ACLList;
class HeaderWithAcl
{
public:
    HeaderWithAcl() :  aclList(NULL), fieldId (HDR_BAD_HDR), quoted(false) {}

    /// HTTP header field name
    std::string fieldName;

    /// HTTP header field value, possibly with macros
    std::string fieldValue;

    /// when the header field should be added (always if nil)
    ACLList *aclList;

    /// compiled HTTP header field value (no macros)
    Format::Format *valueFormat;

    /// internal ID for "known" headers or HDR_OTHER
    http_hdr_type fieldId;

    /// whether fieldValue may contain macros
    bool quoted;
};

extern int httpHeaderParseOffset(const char *start, int64_t * off);

class HttpHeaderFieldInfo;
class String;

extern HttpHeaderFieldInfo *httpHeaderBuildFieldsInfo(const HttpHeaderFieldAttrs * attrs, int count);
extern void httpHeaderDestroyFieldsInfo(HttpHeaderFieldInfo * info, int count);
extern http_hdr_type httpHeaderIdByName(const char *name, size_t name_len, const HttpHeaderFieldInfo * attrs, int end);
extern http_hdr_type httpHeaderIdByNameDef(const char *name, int name_len);
extern const char *httpHeaderNameById(int id);
extern int httpHeaderHasConnDir(const HttpHeader * hdr, const char *directive);
extern int httpHeaderParseInt(const char *start, int *val);
extern void httpHeaderPutStrf(HttpHeader * hdr, http_hdr_type id, const char *fmt,...) PRINTF_FORMAT_ARG3;

extern const char *getStringPrefix(const char *str, const char *end);

#endif