mod_proxy.h revision bb859fec493f440dde2259c20b002428fd0b8b55
/* Copyright 1999-2004 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef MOD_PROXY_H
#define MOD_PROXY_H
/*
* Main include file for the Apache proxy
*/
/*
Also note numerous FIXMEs and CHECKMEs which should be eliminated.
This code is once again experimental!
Things to do:
1. Make it completely work (for FTP too)
2. HTTP/1.1
Chuck Murcko <chuck@topsail.org> 02-06-01
*/
#define CORE_PRIVATE
#include "apr_hooks.h"
#include "apr.h"
#include "apr_lib.h"
#include "apr_strings.h"
#include "apr_buckets.h"
#include "apr_md5.h"
#include "apr_network_io.h"
#include "apr_pools.h"
#include "apr_strings.h"
#include "apr_uri.h"
#include "apr_date.h"
#include "apr_strmatch.h"
#include "apr_fnmatch.h"
#include "apr_reslist.h"
#define APR_WANT_STRFUNC
#include "apr_want.h"
#include "httpd.h"
#include "http_config.h"
#include "ap_config.h"
#include "http_core.h"
#include "http_protocol.h"
#include "http_request.h"
#include "http_vhost.h"
#include "http_main.h"
#include "http_log.h"
#include "http_connection.h"
#include "util_filter.h"
#include "util_ebcdic.h"
#endif
#endif
/* for proxy_canonenc() */
enum enctype {
};
#define CRLF "\r\n"
#else /*APR_CHARSET_EBCDIC*/
#define CRLF "\015\012"
#endif /*APR_CHARSET_EBCDIC*/
/* default Max-Forwards header setting */
#define DEFAULT_MAX_FORWARDS 10
/* static information about a remote proxy */
struct proxy_remote {
const char *scheme; /* the schemes handled by this proxy, or '*' */
const char *protocol; /* the scheme used to talk to this proxy */
const char *hostname; /* the hostname of this proxy */
int use_regex; /* simple boolean. True if we have a regex pattern */
};
struct proxy_alias {
const char *real;
const char *fake;
};
struct dirconn_entry {
char *name;
struct apr_sockaddr_t *hostaddr;
};
struct noproxy_entry {
const char *name;
struct apr_sockaddr_t *addr;
};
typedef struct {
const char *domain; /* domain name to use in absence of a domain name in the request */
int req; /* true if proxy requests are enabled */
char req_set;
enum {
} viaopt; /* how to deal with proxy Via: headers */
char viaopt_set;
char recv_buffer_size_set;
char io_buffer_size_set;
long maxfwd;
char maxfwd_set;
/**
* the following setting masks the error page
* returned from the 'proxied server' and just
* forwards the status code upwards.
* This allows the main server (us) to generate
* the error page, (so it will look like a error
* returned from the rest of the system
*/
int error_override;
int error_override_set;
int preserve_host;
int preserve_host_set;
char timeout_set;
enum {
} badopt; /* how to deal with bad headers */
char badopt_set;
/* putting new stuff on the end maximises binary back-compatibility.
* the strmatch_patterns are really a const just to have a
* case-independent strstr.
*/
const apr_strmatch_pattern* cookie_path_str;
typedef struct proxy_balancer proxy_balancer;
typedef struct proxy_worker proxy_worker;
typedef struct proxy_conn_pool proxy_conn_pool;
typedef struct {
const char *p; /* The path */
int p_is_fnmatch; /* Is this path an fnmatch candidate? */
regex_t *r; /* Is this a regex? */
typedef struct {
const char *hostname;
int is_ssl;
int close; /* Close 'this' connection */
void *data; /* per scheme connection data */
typedef struct {
float cache_completion; /* completion percentage */
int content_length; /* length of the content */
/* Connection pool */
struct proxy_conn_pool {
#if APR_HAS_THREADS
#endif
};
/* Worker configuration */
struct proxy_worker {
int status;
int retries; /* number of retries on this worker */
int lbfactor; /* initial load balancing factor */
const char *name;
const char *scheme; /* scheme to use ajp|http|https */
const char *hostname; /* remote backend address */
int min; /* Desired minimum number of available connections */
int smax; /* Soft maximum on the total number of connections */
int hmax; /* Hard maximum on the total number of connections */
* may be available while exceeding the soft limit */
char timeout_set;
apr_interval_time_t acquire; /* acquire timeout when the maximum number of connections is exceeded */
char acquire_set;
char recv_buffer_size_set;
char io_buffer_size_set;
char keepalive;
void *opaque; /* per scheme worker data */
};
/* Runtime worker status informations. Shared in scoreboard */
typedef struct {
proxy_balancer *b; /* balancer containing this worker */
proxy_worker *w;
double lbfactor; /* dynamic lbfactor */
double lbsatus; /* Current lbstatus */
struct proxy_balancer {
const char *name; /* name of the load balancer */
const char *sticky; /* sticky session identifier */
int sticky_force; /* Disable failover for sticky sessions */
#if APR_HAS_THREADS
#endif
};
/* hooks */
/* Create a set of PROXY_DECLARE(type), PROXY_DECLARE_NONSTD(type) and
* PROXY_DECLARE_DATA with appropriate export and import tags for the platform
*/
#if !defined(WIN32)
#define PROXY_DECLARE_DATA
#elif defined(PROXY_DECLARE_STATIC)
#define PROXY_DECLARE_DATA
#elif defined(PROXY_DECLARE_EXPORT)
#else
#endif
/**
* Hook an optional proxy hook. Unlike static hooks, this uses a macro
* instead of a function.
*/
char *url))
/**
* pre request hook.
* It will return the most suitable worker at the moment
* and coresponding balancer.
* and then the scheme_handler is called.
*
*/
struct proxy_balancer **balancer,
request_rec *r,
/**
* post request hook.
* It is called after request for updating runtime balancer status.
*/
/* proxy_util.c */
PROXY_DECLARE(int) ap_proxy_hex2c(const char *x);
int isenc);
PROXY_DECLARE(int) ap_proxy_hex2sec(const char *x);
PROXY_DECLARE(void) ap_proxy_sec2hex(int t, char *y);
PROXY_DECLARE(int) ap_proxy_checkproxyblock(request_rec *r, proxy_server_conf *conf, apr_sockaddr_t *uri_addr);
PROXY_DECLARE(apr_status_t) ap_proxy_string_read(conn_rec *c, apr_bucket_brigade *bb, char *buff, size_t bufflen, int *eos);
/* DEPRECATED (will be replaced with ap_proxy_connect_backend */
PROXY_DECLARE(int) ap_proxy_connect_to_backend(apr_socket_t **, const char *, apr_sockaddr_t *, const char *, proxy_server_conf *, server_rec *, apr_pool_t *);
/* Connection pool API */
PROXY_DECLARE(proxy_worker *) ap_proxy_get_worker(apr_pool_t *p, proxy_server_conf *conf, const char *url);
PROXY_DECLARE(const char *) ap_proxy_add_worker(proxy_worker **worker, apr_pool_t *p, proxy_server_conf *conf, const char *url);
PROXY_DECLARE(struct proxy_balancer *) ap_proxy_get_balancer(apr_pool_t *p, proxy_server_conf *conf, const char *url);
PROXY_DECLARE(const char *) ap_proxy_add_balancer(proxy_balancer **balancer, apr_pool_t *p, proxy_server_conf *conf, const char *url);
PROXY_DECLARE(void) ap_proxy_add_worker_to_balancer(proxy_balancer *balancer, proxy_worker *worker);
PROXY_DECLARE(int) ap_proxy_pre_request(proxy_worker **worker, proxy_balancer **balancer, request_rec *r, proxy_server_conf *conf, char **url);
PROXY_DECLARE(apr_status_t) ap_proxy_determine_connection(apr_pool_t *p, request_rec *r, proxy_server_conf *conf, proxy_worker *worker, proxy_conn_rec *conn,
char *server_portstr, int server_portstr_size);
PROXY_DECLARE(int) ap_proxy_connect_backend(const char *proxy_function, proxy_conn_rec *conn, proxy_worker *worker,
/* For proxy_util */
#endif /*MOD_PROXY_H*/