HttpHeaderTools.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2023 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_HTTPHEADERTOOLS_H
#define SQUID_HTTPHEADERTOOLS_H
 
#include "acl/forward.h"
#include "format/Format.h"
#include "HttpHeader.h"
#include "sbuf/forward.h"
 
#include <functional>
#include <list>
#include <map>
#include <string>
#if HAVE_STRINGS_H
#include <strings.h>
#endif
 
class HeaderWithAcl;
class HttpHeader;
class HttpRequest;
class StoreEntry;
 
typedef std::list<HeaderWithAcl> HeaderWithAclList;
 
/* Distinguish between Request and Reply (for header mangling) */
typedef enum {
    ROR_REQUEST,
    ROR_REPLY
} req_or_rep_t;
 
// Currently a POD
class headerMangler
{
public:
    acl_access *access_list;
    char *replacement;
};
 
class HeaderManglers
{
public:
    HeaderManglers();
    ~HeaderManglers();
 
    const headerMangler *find(const HttpHeaderEntry &e) const;
 
    headerMangler *track(const char *name);
 
    void setReplacement(const char *name, const char *replacementValue);
 
    void dumpAccess(StoreEntry *entry, const char *optionName) const;
    void dumpReplacement(StoreEntry *entry, const char *optionName) const;
 
private:
    class NoCaseLessThan
    {
    public:
        bool operator()(const std::string &lhs, const std::string &rhs) const {
            return strcasecmp(lhs.c_str(), rhs.c_str()) < 0;
        }
    };
 
    typedef std::map<std::string, headerMangler, NoCaseLessThan> ManglersByName;
 
    headerMangler known[static_cast<int>(Http::HdrType::enumEnd_)];
 
    ManglersByName custom;
 
    headerMangler all;
 
private:
    /* not implemented */
    HeaderManglers(const HeaderManglers &);
    HeaderManglers &operator =(const HeaderManglers &);
};
 
class HeaderWithAcl
{
public:
    HeaderWithAcl() : aclList(nullptr), valueFormat(nullptr), fieldId(Http::HdrType::BAD_HDR), quoted(false) {}
 
    std::string fieldName;
 
    std::string fieldValue;
 
    ACLList *aclList;
 
    Format::Format *valueFormat;
 
    Http::HdrType fieldId;
 
    bool quoted;
};
 
bool httpHeaderParseOffset(const char *start, int64_t *offPtr, char **endPtr = nullptr);
 
bool httpHeaderHasConnDir(const HttpHeader * hdr, const SBuf &directive);
int httpHeaderParseInt(const char *start, int *val);
void httpHeaderPutStrf(HttpHeader * hdr, Http::HdrType id, const char *fmt,...) PRINTF_FORMAT_ARG3;
 
const char *getStringPrefix(const char *str, size_t len);
 
void httpHdrMangleList(HttpHeader *, HttpRequest *, const AccessLogEntryPointer &al, req_or_rep_t req_or_rep);
 
#endif