mirror of
https://git.haproxy.org/git/haproxy.git/
synced 2026-04-18 20:22:48 +02:00
fedaf054c4
In conf_errors struct, arbitrary integer values were used for both <type> field and <status> array. This renders the code difficult to follow. Replaces these values with proper enums type. Two new types are defined for each of these fields. The first one represents the directive type, derived from the keyword used (errorfile vs errorfiles). This directly represents which part of <info> union should be manipulated. The second enum is used for errorfiles directive with a reference on a http-errors section. It indicates whether or not if a status code should be imported from this section, and if this import is explicit or implicit.
115 lines
4.4 KiB
C
115 lines
4.4 KiB
C
/*
|
|
* include/haproxy/http_htx-t.h
|
|
* This file defines everything related to HTTP manipulation using the internal
|
|
* representation.
|
|
*
|
|
* Copyright (C) 2018 HAProxy Technologies, Christopher Faulet <cfaulet@haproxy.com>
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation, version 2.1
|
|
* exclusively.
|
|
*
|
|
* This library 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
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
*/
|
|
|
|
#ifndef _HAPROXY_HTTP_HTX_T_H
|
|
#define _HAPROXY_HTTP_HTX_T_H
|
|
|
|
#include <import/ebistree.h>
|
|
#include <import/ist.h>
|
|
|
|
#include <haproxy/buf-t.h>
|
|
#include <haproxy/http-t.h>
|
|
#include <haproxy/log-t.h>
|
|
#include <haproxy/htx-t.h>
|
|
|
|
/* Context used to find/remove an HTTP header. */
|
|
struct http_hdr_ctx {
|
|
struct htx_blk *blk;
|
|
struct ist value;
|
|
uint16_t lws_before;
|
|
uint16_t lws_after;
|
|
};
|
|
|
|
|
|
/* Structure used to build the header list of an HTTP reply */
|
|
struct http_reply_hdr {
|
|
struct ist name; /* the header name */
|
|
struct lf_expr value; /* the log-format string value */
|
|
struct list list; /* header linked list */
|
|
};
|
|
|
|
#define HTTP_REPLY_EMPTY 0x00 /* the reply has no payload */
|
|
#define HTTP_REPLY_ERRMSG 0x01 /* the reply is an error message (may be NULL) */
|
|
#define HTTP_REPLY_ERRFILES 0x02 /* the reply references an http-errors section */
|
|
#define HTTP_REPLY_RAW 0x03 /* the reply use a raw payload */
|
|
#define HTTP_REPLY_LOGFMT 0x04 /* the reply use a log-format payload */
|
|
#define HTTP_REPLY_INDIRECT 0x05 /* the reply references another http-reply (may be NULL) */
|
|
|
|
/* Uses by HAProxy to generate internal responses */
|
|
struct http_reply {
|
|
unsigned char type; /* HTTP_REPLY_* */
|
|
int status; /* The response status code */
|
|
char *ctype; /* The response content-type, may be NULL */
|
|
struct list hdrs; /* A list of http_reply_hdr */
|
|
union {
|
|
struct lf_expr fmt; /* A log-format string (type = HTTP_REPLY_LOGFMT) */
|
|
struct buffer obj; /* A raw string (type = HTTP_REPLY_RAW) */
|
|
struct buffer *errmsg; /* The error message to use as response (type = HTTP_REPLY_ERRMSG).
|
|
* may be NULL, if so rely on the proxy error messages */
|
|
struct http_reply *reply; /* The HTTP reply to use as response (type = HTTP_REPLY_INDIRECT) */
|
|
char *http_errors; /* The http-errors section to use (type = HTTP_REPLY_ERRFILES).
|
|
* Should be resolved during post-check */
|
|
} body;
|
|
struct list list; /* next http_reply in the global list.
|
|
* Only used for replies defined in a proxy section */
|
|
};
|
|
|
|
/* A custom HTTP error message load from a row file and converted in HTX. The
|
|
* node key is the file path.
|
|
*/
|
|
struct http_error_msg {
|
|
struct buffer msg;
|
|
struct ebpt_node node;
|
|
};
|
|
|
|
/* http-errors section and parameters. */
|
|
struct http_errors {
|
|
char *id; /* unique identifier */
|
|
struct {
|
|
char *file; /* file where the section appears */
|
|
int line; /* line where the section appears */
|
|
} conf; /* config information */
|
|
|
|
struct http_reply *replies[HTTP_ERR_SIZE]; /* HTTP replies for known errors */
|
|
struct list list; /* http-errors list */
|
|
};
|
|
|
|
/* Indicates the keyword origin of an http-error definition. This is used in
|
|
* <conf_errors> type to indicate which part of the internal union should be
|
|
* manipulated.
|
|
*/
|
|
enum http_err_directive {
|
|
HTTP_ERR_DIRECTIVE_SECTION = 0, /* "errorfiles" keyword referencing a http-errors section */
|
|
HTTP_ERR_DIRECTIVE_INLINE, /* "errorfile" keyword with inline error definition */
|
|
};
|
|
|
|
/* Used with "errorfiles" directives. It indicates for each known HTTP error
|
|
* status codes if they are defined in the target http-errors section.
|
|
*/
|
|
enum http_err_import {
|
|
HTTP_ERR_IMPORT_NO = 0,
|
|
HTTP_ERR_IMPORT_IMPLICIT, /* import every errcode defined in a section */
|
|
HTTP_ERR_IMPORT_EXPLICIT, /* import a specific errcode from a section */
|
|
};
|
|
|
|
#endif /* _HAPROXY_HTTP_HTX_T_H */
|