http_protocol.h revision 2864362ca8266097928e84f101010bdf814ffa08
e609c337f729875bc20e01096c7e610f45356f54nilgun/* ====================================================================
e609c337f729875bc20e01096c7e610f45356f54nilgun * The Apache Software License, Version 1.1
e609c337f729875bc20e01096c7e610f45356f54nilgun *
e609c337f729875bc20e01096c7e610f45356f54nilgun * Copyright (c) 2000-2002 The Apache Software Foundation. All rights
e609c337f729875bc20e01096c7e610f45356f54nilgun * reserved.
e609c337f729875bc20e01096c7e610f45356f54nilgun *
e609c337f729875bc20e01096c7e610f45356f54nilgun * Redistribution and use in source and binary forms, with or without
e609c337f729875bc20e01096c7e610f45356f54nilgun * modification, are permitted provided that the following conditions
e609c337f729875bc20e01096c7e610f45356f54nilgun * are met:
e609c337f729875bc20e01096c7e610f45356f54nilgun *
e609c337f729875bc20e01096c7e610f45356f54nilgun * 1. Redistributions of source code must retain the above copyright
e609c337f729875bc20e01096c7e610f45356f54nilgun * notice, this list of conditions and the following disclaimer.
e609c337f729875bc20e01096c7e610f45356f54nilgun *
e609c337f729875bc20e01096c7e610f45356f54nilgun * 2. Redistributions in binary form must reproduce the above copyright
e609c337f729875bc20e01096c7e610f45356f54nilgun * notice, this list of conditions and the following disclaimer in
e609c337f729875bc20e01096c7e610f45356f54nilgun * the documentation and/or other materials provided with the
e609c337f729875bc20e01096c7e610f45356f54nilgun * distribution.
e609c337f729875bc20e01096c7e610f45356f54nilgun *
e609c337f729875bc20e01096c7e610f45356f54nilgun * 3. The end-user documentation included with the redistribution,
e609c337f729875bc20e01096c7e610f45356f54nilgun * if any, must include the following acknowledgment:
e609c337f729875bc20e01096c7e610f45356f54nilgun * "This product includes software developed by the
e609c337f729875bc20e01096c7e610f45356f54nilgun * Apache Software Foundation (http://www.apache.org/)."
f086b4b402fa9a2fefc7dda85de2a3cc1cd0a654rjung * Alternately, this acknowledgment may appear in the software itself,
e609c337f729875bc20e01096c7e610f45356f54nilgun * if and wherever such third-party acknowledgments normally appear.
4b575a6b6704b516f22d65a3ad35696d7b9ba372rpluem *
e609c337f729875bc20e01096c7e610f45356f54nilgun * 4. The names "Apache" and "Apache Software Foundation" must
e609c337f729875bc20e01096c7e610f45356f54nilgun * not be used to endorse or promote products derived from this
e609c337f729875bc20e01096c7e610f45356f54nilgun * software without prior written permission. For written
e609c337f729875bc20e01096c7e610f45356f54nilgun * permission, please contact apache@apache.org.
e609c337f729875bc20e01096c7e610f45356f54nilgun *
e609c337f729875bc20e01096c7e610f45356f54nilgun * 5. Products derived from this software may not be called "Apache",
e609c337f729875bc20e01096c7e610f45356f54nilgun * nor may "Apache" appear in their name, without prior written
e609c337f729875bc20e01096c7e610f45356f54nilgun * permission of the Apache Software Foundation.
e609c337f729875bc20e01096c7e610f45356f54nilgun *
e609c337f729875bc20e01096c7e610f45356f54nilgun * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
e609c337f729875bc20e01096c7e610f45356f54nilgun * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
e609c337f729875bc20e01096c7e610f45356f54nilgun * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
e609c337f729875bc20e01096c7e610f45356f54nilgun * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
e609c337f729875bc20e01096c7e610f45356f54nilgun * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
e609c337f729875bc20e01096c7e610f45356f54nilgun * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
e609c337f729875bc20e01096c7e610f45356f54nilgun * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
e609c337f729875bc20e01096c7e610f45356f54nilgun * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
e609c337f729875bc20e01096c7e610f45356f54nilgun * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
e609c337f729875bc20e01096c7e610f45356f54nilgun * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
e609c337f729875bc20e01096c7e610f45356f54nilgun * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
e609c337f729875bc20e01096c7e610f45356f54nilgun * SUCH DAMAGE.
e609c337f729875bc20e01096c7e610f45356f54nilgun * ====================================================================
e609c337f729875bc20e01096c7e610f45356f54nilgun *
e609c337f729875bc20e01096c7e610f45356f54nilgun * This software consists of voluntary contributions made by many
e609c337f729875bc20e01096c7e610f45356f54nilgun * individuals on behalf of the Apache Software Foundation. For more
e609c337f729875bc20e01096c7e610f45356f54nilgun * information on the Apache Software Foundation, please see
e609c337f729875bc20e01096c7e610f45356f54nilgun * <http://www.apache.org/>.
e609c337f729875bc20e01096c7e610f45356f54nilgun *
e609c337f729875bc20e01096c7e610f45356f54nilgun * Portions of this software are based upon public domain software
e609c337f729875bc20e01096c7e610f45356f54nilgun * originally written at the National Center for Supercomputing Applications,
e609c337f729875bc20e01096c7e610f45356f54nilgun * University of Illinois, Urbana-Champaign.
e609c337f729875bc20e01096c7e610f45356f54nilgun */
e609c337f729875bc20e01096c7e610f45356f54nilgun
e609c337f729875bc20e01096c7e610f45356f54nilgun#ifndef APACHE_HTTP_PROTOCOL_H
e609c337f729875bc20e01096c7e610f45356f54nilgun#define APACHE_HTTP_PROTOCOL_H
e609c337f729875bc20e01096c7e610f45356f54nilgun
e609c337f729875bc20e01096c7e610f45356f54nilgun#include "httpd.h"
91f378b5a10f2d83820902ed10ba7967a3920c18nilgun#include "apr_hooks.h"
e609c337f729875bc20e01096c7e610f45356f54nilgun#include "apr_portable.h"
e609c337f729875bc20e01096c7e610f45356f54nilgun#include "apr_mmap.h"
e609c337f729875bc20e01096c7e610f45356f54nilgun#include "apr_buckets.h"
e609c337f729875bc20e01096c7e610f45356f54nilgun#include "util_filter.h"
e609c337f729875bc20e01096c7e610f45356f54nilgun
e609c337f729875bc20e01096c7e610f45356f54nilgun#ifdef __cplusplus
e609c337f729875bc20e01096c7e610f45356f54nilgunextern "C" {
e609c337f729875bc20e01096c7e610f45356f54nilgun#endif
e609c337f729875bc20e01096c7e610f45356f54nilgun
e609c337f729875bc20e01096c7e610f45356f54nilgun/**
e609c337f729875bc20e01096c7e610f45356f54nilgun * @package HTTP protocol handling
e609c337f729875bc20e01096c7e610f45356f54nilgun */
e609c337f729875bc20e01096c7e610f45356f54nilgun
e609c337f729875bc20e01096c7e610f45356f54nilgun/* This is an optimization. We keep a record of the filter_rec that
e609c337f729875bc20e01096c7e610f45356f54nilgun * stores the old_write filter, so that we can avoid strcmp's later.
e609c337f729875bc20e01096c7e610f45356f54nilgun */
e609c337f729875bc20e01096c7e610f45356f54nilgunAP_DECLARE_DATA extern ap_filter_rec_t *ap_old_write_func;
e609c337f729875bc20e01096c7e610f45356f54nilgun
e609c337f729875bc20e01096c7e610f45356f54nilgun/*
e609c337f729875bc20e01096c7e610f45356f54nilgun * Prototypes for routines which either talk directly back to the user,
e609c337f729875bc20e01096c7e610f45356f54nilgun * or control the ones that eventually do.
e609c337f729875bc20e01096c7e610f45356f54nilgun */
e609c337f729875bc20e01096c7e610f45356f54nilgun
e609c337f729875bc20e01096c7e610f45356f54nilgun/**
e609c337f729875bc20e01096c7e610f45356f54nilgun * Read a request and fill in the fields.
e609c337f729875bc20e01096c7e610f45356f54nilgun * @param c The current connection
e609c337f729875bc20e01096c7e610f45356f54nilgun * @return The new request_rec
e609c337f729875bc20e01096c7e610f45356f54nilgun */
e609c337f729875bc20e01096c7e610f45356f54nilgunrequest_rec *ap_read_request(conn_rec *c);
e609c337f729875bc20e01096c7e610f45356f54nilgun
e609c337f729875bc20e01096c7e610f45356f54nilgun/* Finish up stuff after a request */
e609c337f729875bc20e01096c7e610f45356f54nilgun
e609c337f729875bc20e01096c7e610f45356f54nilgun/**
e609c337f729875bc20e01096c7e610f45356f54nilgun * Called at completion of sending the response. It sends the terminating
e609c337f729875bc20e01096c7e610f45356f54nilgun * protocol information.
e609c337f729875bc20e01096c7e610f45356f54nilgun * @param r The current request
e609c337f729875bc20e01096c7e610f45356f54nilgun * @deffunc void ap_finalize_request_protocol(request_rec *r)
e609c337f729875bc20e01096c7e610f45356f54nilgun */
e609c337f729875bc20e01096c7e610f45356f54nilgunAP_DECLARE(void) ap_finalize_request_protocol(request_rec *r);
e609c337f729875bc20e01096c7e610f45356f54nilgun
e609c337f729875bc20e01096c7e610f45356f54nilgun/**
e609c337f729875bc20e01096c7e610f45356f54nilgun * Send error back to client.
e609c337f729875bc20e01096c7e610f45356f54nilgun * @param r The current request
e609c337f729875bc20e01096c7e610f45356f54nilgun * @param recursive_error last arg indicates error status in case we get
e609c337f729875bc20e01096c7e610f45356f54nilgun * an error in the process of trying to deal with an ErrorDocument
e609c337f729875bc20e01096c7e610f45356f54nilgun * to handle some other error. In that case, we print the default
e609c337f729875bc20e01096c7e610f45356f54nilgun * report for the first thing that went wrong, and more briefly report
e609c337f729875bc20e01096c7e610f45356f54nilgun * on the problem with the ErrorDocument.
e609c337f729875bc20e01096c7e610f45356f54nilgun * @deffunc void ap_send_error_response(request_rec *r, int recursive_error)
e609c337f729875bc20e01096c7e610f45356f54nilgun */
e609c337f729875bc20e01096c7e610f45356f54nilgunAP_DECLARE(void) ap_send_error_response(request_rec *r, int recursive_error);
e609c337f729875bc20e01096c7e610f45356f54nilgun
e609c337f729875bc20e01096c7e610f45356f54nilgun/* Set last modified header line from the lastmod date of the associated file.
e609c337f729875bc20e01096c7e610f45356f54nilgun * Also, set content length.
e609c337f729875bc20e01096c7e610f45356f54nilgun *
e609c337f729875bc20e01096c7e610f45356f54nilgun * May return an error status, typically HTTP_NOT_MODIFIED (that when the
e609c337f729875bc20e01096c7e610f45356f54nilgun * permit_cache argument is set to one).
e609c337f729875bc20e01096c7e610f45356f54nilgun */
e609c337f729875bc20e01096c7e610f45356f54nilgun
e609c337f729875bc20e01096c7e610f45356f54nilgun/**
e609c337f729875bc20e01096c7e610f45356f54nilgun * Set the content length for this request
e609c337f729875bc20e01096c7e610f45356f54nilgun * @param r The current request
e609c337f729875bc20e01096c7e610f45356f54nilgun * @param length The new content length
e609c337f729875bc20e01096c7e610f45356f54nilgun * @deffunc void ap_set_content_length(request_rec *r, apr_off_t length)
e609c337f729875bc20e01096c7e610f45356f54nilgun */
e609c337f729875bc20e01096c7e610f45356f54nilgunAP_DECLARE(void) ap_set_content_length(request_rec *r, apr_off_t length);
e609c337f729875bc20e01096c7e610f45356f54nilgun
e609c337f729875bc20e01096c7e610f45356f54nilgun/**
e609c337f729875bc20e01096c7e610f45356f54nilgun * Set the keepalive status for this request
e609c337f729875bc20e01096c7e610f45356f54nilgun * @param r The current request
e609c337f729875bc20e01096c7e610f45356f54nilgun * @return 1 if keepalive can be set, 0 otherwise
e609c337f729875bc20e01096c7e610f45356f54nilgun * @deffunc int ap_set_keepalive(request_rec *r)
e609c337f729875bc20e01096c7e610f45356f54nilgun */
e609c337f729875bc20e01096c7e610f45356f54nilgunAP_DECLARE(int) ap_set_keepalive(request_rec *r);
e609c337f729875bc20e01096c7e610f45356f54nilgun
e609c337f729875bc20e01096c7e610f45356f54nilgun/**
e609c337f729875bc20e01096c7e610f45356f54nilgun * Return the latest rational time from a request/mtime pair. Mtime is
e609c337f729875bc20e01096c7e610f45356f54nilgun * returned unless it's in the future, in which case we return the current time.
e609c337f729875bc20e01096c7e610f45356f54nilgun * @param r The current request
e609c337f729875bc20e01096c7e610f45356f54nilgun * @param mtime The last modified time
e609c337f729875bc20e01096c7e610f45356f54nilgun * @return the latest rational time.
e609c337f729875bc20e01096c7e610f45356f54nilgun * @deffunc apr_time_t ap_rationalize_mtime(request_rec *r, apr_time_t mtime)
e609c337f729875bc20e01096c7e610f45356f54nilgun */
e609c337f729875bc20e01096c7e610f45356f54nilgunAP_DECLARE(apr_time_t) ap_rationalize_mtime(request_rec *r, apr_time_t mtime);
e609c337f729875bc20e01096c7e610f45356f54nilgun
e609c337f729875bc20e01096c7e610f45356f54nilgun/**
e609c337f729875bc20e01096c7e610f45356f54nilgun * Build the content-type that should be sent to the client from the
e609c337f729875bc20e01096c7e610f45356f54nilgun * content-type specified. The following rules are followed:
e609c337f729875bc20e01096c7e610f45356f54nilgun * - if type is NULL, type is set to ap_default_type(r)
e609c337f729875bc20e01096c7e610f45356f54nilgun * - if charset adding is disabled, stop processing and return type.
e609c337f729875bc20e01096c7e610f45356f54nilgun * - then, if there are no parameters on type, add the default charset
e609c337f729875bc20e01096c7e610f45356f54nilgun * - return type
e609c337f729875bc20e01096c7e610f45356f54nilgun * @param r The current request
e609c337f729875bc20e01096c7e610f45356f54nilgun * @return The content-type
e609c337f729875bc20e01096c7e610f45356f54nilgun * @deffunc const char *ap_make_content_type(request_rec *r, const char *type);
e609c337f729875bc20e01096c7e610f45356f54nilgun */
e609c337f729875bc20e01096c7e610f45356f54nilgunAP_DECLARE(const char *) ap_make_content_type(request_rec *r, const char *type);
e609c337f729875bc20e01096c7e610f45356f54nilgun
e609c337f729875bc20e01096c7e610f45356f54nilgun/**
e609c337f729875bc20e01096c7e610f45356f54nilgun * Construct an entity tag from the resource information. If it's a real
e609c337f729875bc20e01096c7e610f45356f54nilgun * file, build in some of the file characteristics.
e609c337f729875bc20e01096c7e610f45356f54nilgun * @param r The current request
e609c337f729875bc20e01096c7e610f45356f54nilgun * @param force_weak Force the entity tag to be weak - it could be modified
e609c337f729875bc20e01096c7e610f45356f54nilgun * again in as short an interval.
e609c337f729875bc20e01096c7e610f45356f54nilgun * @return The entity tag
e609c337f729875bc20e01096c7e610f45356f54nilgun * @deffunc char *ap_make_etag(request_rec *r, int force_weak)
e609c337f729875bc20e01096c7e610f45356f54nilgun */
e609c337f729875bc20e01096c7e610f45356f54nilgunAP_DECLARE(char *) ap_make_etag(request_rec *r, int force_weak);
e609c337f729875bc20e01096c7e610f45356f54nilgun
e609c337f729875bc20e01096c7e610f45356f54nilgun/**
e609c337f729875bc20e01096c7e610f45356f54nilgun * Set the E-tag outgoing header
e609c337f729875bc20e01096c7e610f45356f54nilgun * @param The current request
e609c337f729875bc20e01096c7e610f45356f54nilgun * @deffunc void ap_set_etag(request_rec *r)
e609c337f729875bc20e01096c7e610f45356f54nilgun */
e609c337f729875bc20e01096c7e610f45356f54nilgunAP_DECLARE(void) ap_set_etag(request_rec *r);
e609c337f729875bc20e01096c7e610f45356f54nilgun
e609c337f729875bc20e01096c7e610f45356f54nilgun/**
e609c337f729875bc20e01096c7e610f45356f54nilgun * Set the last modified time for the file being sent
91f378b5a10f2d83820902ed10ba7967a3920c18nilgun * @param r The current request
e609c337f729875bc20e01096c7e610f45356f54nilgun * @deffunc void ap_set_last_modified(request_rec *r)
e609c337f729875bc20e01096c7e610f45356f54nilgun */
e609c337f729875bc20e01096c7e610f45356f54nilgunAP_DECLARE(void) ap_set_last_modified(request_rec *r);
e609c337f729875bc20e01096c7e610f45356f54nilgun
e609c337f729875bc20e01096c7e610f45356f54nilgun/**
e609c337f729875bc20e01096c7e610f45356f54nilgun * Implements condition GET rules for HTTP/1.1 specification. This function
e609c337f729875bc20e01096c7e610f45356f54nilgun * inspects the client headers and determines if the response fulfills
e609c337f729875bc20e01096c7e610f45356f54nilgun * the requirements specified.
e609c337f729875bc20e01096c7e610f45356f54nilgun * @param r The current request
91f378b5a10f2d83820902ed10ba7967a3920c18nilgun * @return 1 if the response fulfills the condition GET rules, 0 otherwise
91f378b5a10f2d83820902ed10ba7967a3920c18nilgun * @deffunc int ap_meets_conditions(request_rec *r)
91f378b5a10f2d83820902ed10ba7967a3920c18nilgun */
91f378b5a10f2d83820902ed10ba7967a3920c18nilgunAP_DECLARE(int) ap_meets_conditions(request_rec *r);
e609c337f729875bc20e01096c7e610f45356f54nilgun
e609c337f729875bc20e01096c7e610f45356f54nilgun/* Other ways to send stuff at the client. All of these keep track
e609c337f729875bc20e01096c7e610f45356f54nilgun * of bytes_sent automatically. This indirection is intended to make
e609c337f729875bc20e01096c7e610f45356f54nilgun * it a little more painless to slide things like HTTP-NG packetization
e609c337f729875bc20e01096c7e610f45356f54nilgun * underneath the main body of the code later. In the meantime, it lets
e609c337f729875bc20e01096c7e610f45356f54nilgun * us centralize a bit of accounting (bytes_sent).
e609c337f729875bc20e01096c7e610f45356f54nilgun *
e609c337f729875bc20e01096c7e610f45356f54nilgun * These also return the number of bytes written by the call.
e609c337f729875bc20e01096c7e610f45356f54nilgun * They should only be called with a timeout registered, for obvious reaasons.
e609c337f729875bc20e01096c7e610f45356f54nilgun * (Ditto the send_header stuff).
e609c337f729875bc20e01096c7e610f45356f54nilgun */
e609c337f729875bc20e01096c7e610f45356f54nilgun
e609c337f729875bc20e01096c7e610f45356f54nilgun/**
e609c337f729875bc20e01096c7e610f45356f54nilgun * Send an entire file to the client, using sendfile if supported by the
e609c337f729875bc20e01096c7e610f45356f54nilgun * current platform
e609c337f729875bc20e01096c7e610f45356f54nilgun * @param fd The file to send.
e609c337f729875bc20e01096c7e610f45356f54nilgun * @param r The current request
e609c337f729875bc20e01096c7e610f45356f54nilgun * @param offset Offset into the file to start sending.
e609c337f729875bc20e01096c7e610f45356f54nilgun * @param length Amount of data to send
e609c337f729875bc20e01096c7e610f45356f54nilgun * @param nbytes Amount of data actually sent
e609c337f729875bc20e01096c7e610f45356f54nilgun * @deffunc apr_status_t ap_send_fd(apr_file_t *fd, request_rec *r, apr_off_t offset, apr_size_t length, apr_size_t *nbytes);
e609c337f729875bc20e01096c7e610f45356f54nilgun */
e609c337f729875bc20e01096c7e610f45356f54nilgunAP_DECLARE(apr_status_t) ap_send_fd(apr_file_t *fd, request_rec *r, apr_off_t offset,
e609c337f729875bc20e01096c7e610f45356f54nilgun apr_size_t length, apr_size_t *nbytes);
e609c337f729875bc20e01096c7e610f45356f54nilgun
e609c337f729875bc20e01096c7e610f45356f54nilgun#if APR_HAS_MMAP
e609c337f729875bc20e01096c7e610f45356f54nilgun/**
e609c337f729875bc20e01096c7e610f45356f54nilgun * Send an MMAP'ed file to the client
e609c337f729875bc20e01096c7e610f45356f54nilgun * @param mm The MMAP'ed file to send
e609c337f729875bc20e01096c7e610f45356f54nilgun * @param r The current request
e609c337f729875bc20e01096c7e610f45356f54nilgun * @param offset The offset into the MMAP to start sending
e609c337f729875bc20e01096c7e610f45356f54nilgun * @param length The amount of data to send
e609c337f729875bc20e01096c7e610f45356f54nilgun * @return The number of bytes sent
e609c337f729875bc20e01096c7e610f45356f54nilgun * @deffunc size_t ap_send_mmap(apr_mmap_t *mm, request_rec *r, size_t offset, size_t length)
e609c337f729875bc20e01096c7e610f45356f54nilgun */
e609c337f729875bc20e01096c7e610f45356f54nilgunAP_DECLARE(size_t) ap_send_mmap(apr_mmap_t *mm, request_rec *r, size_t offset,
e609c337f729875bc20e01096c7e610f45356f54nilgun size_t length);
e609c337f729875bc20e01096c7e610f45356f54nilgun#endif
e609c337f729875bc20e01096c7e610f45356f54nilgun
e609c337f729875bc20e01096c7e610f45356f54nilgun
e609c337f729875bc20e01096c7e610f45356f54nilgun/**
e609c337f729875bc20e01096c7e610f45356f54nilgun * Register a new request method, and return the offset that will be
e609c337f729875bc20e01096c7e610f45356f54nilgun * associated with that method.
e609c337f729875bc20e01096c7e610f45356f54nilgun *
e609c337f729875bc20e01096c7e610f45356f54nilgun * @param p The pool to create registered method numbers from.
e609c337f729875bc20e01096c7e610f45356f54nilgun * @param methname The name of the new method to register.
e609c337f729875bc20e01096c7e610f45356f54nilgun * @return Ab int value representing an offset into a bitmask.
f086b4b402fa9a2fefc7dda85de2a3cc1cd0a654rjung */
e609c337f729875bc20e01096c7e610f45356f54nilgunAP_DECLARE(int) ap_method_register(apr_pool_t *p, const char *methname);
9c1260efa52c82c2a58e5b5f20cd6902563d95f5rbowen
e609c337f729875bc20e01096c7e610f45356f54nilgun/**
e609c337f729875bc20e01096c7e610f45356f54nilgun * Initialize the method_registry and allocate memory for it.
*
* @param p Pool to allocate memory for the registry from.
*/
AP_DECLARE(void) ap_method_registry_init(apr_pool_t *p);
/*
* This is a convenience macro to ease with checking a mask
* against a method name.
*/
#define AP_METHOD_CHECK_ALLOWED(mask, methname) \
((mask) & (AP_METHOD_BIT << ap_method_number_of((methname))))
/**
* Create a new method list with the specified number of preallocated
* slots for extension methods.
*
* @param p Pointer to a pool in which the structure should be
* allocated.
* @param nelts Number of preallocated extension slots
* @return Pointer to the newly created structure.
* @deffunc ap_method_list_t ap_make_method_list(apr_pool_t *p, int nelts)
*/
AP_DECLARE(ap_method_list_t *) ap_make_method_list(apr_pool_t *p, int nelts);
AP_DECLARE(void) ap_copy_method_list(ap_method_list_t *dest,
ap_method_list_t *src);
AP_DECLARE_NONSTD(void) ap_method_list_do(int (*comp) (void *urec, const char *mname,
int mnum),
void *rec,
const ap_method_list_t *ml, ...);
AP_DECLARE(void) ap_method_list_vdo(int (*comp) (void *urec, const char *mname,
int mnum),
void *rec, const ap_method_list_t *ml,
va_list vp);
/**
* Search for an HTTP method name in an ap_method_list_t structure, and
* return true if found.
*
* @param method String containing the name of the method to check.
* @param l Pointer to a method list, such as cmd->methods_limited.
* @return 1 if method is in the list, otherwise 0
* @deffunc int ap_method_in_list(const char *method, ap_method_list_t *l)
*/
AP_DECLARE(int) ap_method_in_list(ap_method_list_t *l, const char *method);
/**
* Add an HTTP method name to an ap_method_list_t structure if it isn't
* already listed.
*
* @param method String containing the name of the method to check.
* @param l Pointer to a method list, such as cmd->methods_limited.
* @return None.
* @deffunc void ap_method_in_list(ap_method_list_t *l, const char *method)
*/
AP_DECLARE(void) ap_method_list_add(ap_method_list_t *l, const char *method);
/**
* Remove an HTTP method name from an ap_method_list_t structure.
*
* @param l Pointer to a method list, such as cmd->methods_limited.
* @param method String containing the name of the method to remove.
* @return None.
* @deffunc void ap_method_list_remove(ap_method_list_t *l, const char *method)
*/
AP_DECLARE(void) ap_method_list_remove(ap_method_list_t *l,
const char *method);
/**
* Reset a method list to be completely empty.
*
* @param l Pointer to a method list, such as cmd->methods_limited.
* @return None.
* @deffunc void ap_clear_method_list(ap_method_list_t *l)
*/
AP_DECLARE(void) ap_clear_method_list(ap_method_list_t *l);
/**
*
*/
AP_DECLARE(void) ap_rset_content_type(char *str, request_rec *r);
/* Hmmm... could macrofy these for now, and maybe forever, though the
* definitions of the macros would get a whole lot hairier.
*/
/**
* Output one character for this request
* @param c the character to output
* @param r the current request
* @return The number of bytes sent
* @deffunc int ap_rputc(int c, request_rec *r)
*/
AP_DECLARE(int) ap_rputc(int c, request_rec *r);
/**
* Output a string for the current request
* @param str The string to output
* @param r The current request
* @return The number of bytes sent
* @deffunc int ap_rputs(const char *str, request_rec *r)
*/
AP_DECLARE(int) ap_rputs(const char *str, request_rec *r);
/**
* Write a buffer for the current request
* @param buf The buffer to write
* @param nbyte The number of bytes to send from the buffer
* @param r The current request
* @return The number of bytes sent
* @deffunc int ap_rwrite(const void *buf, int nbyte, request_rec *r)
*/
AP_DECLARE(int) ap_rwrite(const void *buf, int nbyte, request_rec *r);
/**
* Write an unspecified number of strings to the request
* @param r The current request
* @param ... The strings to write
* @return The number of bytes sent
* @deffunc int ap_rvputs(request_rec *r, ...)
*/
AP_DECLARE_NONSTD(int) ap_rvputs(request_rec *r,...);
/**
* Output data to the client in a printf format
* @param r The current request
* @param fmt The format string
* @param vlist The arguments to use to fill out the format string
* @return The number of bytes sent
* @deffunc int ap_vrprintf(request_rec *r, const char *fmt, va_list vlist)
*/
AP_DECLARE(int) ap_vrprintf(request_rec *r, const char *fmt, va_list vlist);
/**
* Output data to the client in a printf format
* @param r The current request
* @param fmt The format string
* @param ... The arguments to use to fill out the format string
* @return The number of bytes sent
* @deffunc int ap_rprintf(request_rec *r, const char *fmt, ...)
*/
AP_DECLARE_NONSTD(int) ap_rprintf(request_rec *r, const char *fmt,...)
__attribute__((format(printf,2,3)));
/**
* Flush all of the data for the current request to the client
* @param r The current request
* @return The number of bytes sent
* @deffunc int ap_rflush(request_rec *r)
*/
AP_DECLARE(int) ap_rflush(request_rec *r);
/**
* Index used in custom_responses array for a specific error code
* (only use outside protocol.c is in getting them configured).
* @param status HTTP status code
* @return The index of the response
* @deffunc int ap_index_of_response(int status)
*/
AP_DECLARE(int) ap_index_of_response(int status);
/**
* Return the Status-Line for a given status code (excluding the
* HTTP-Version field). If an invalid or unknown status code is
* passed, "500 Internal Server Error" will be returned.
* @param status The HTTP status code
* @return The Status-Line
* @deffunc const char *ap_get_status_line(int status)
*/
AP_DECLARE(const char *) ap_get_status_line(int status);
/* Reading a block of data from the client connection (e.g., POST arg) */
/**
* Setup the client to allow Apache to read the request body.
* @param r The current request
* @param read_policy How the server should interpret a chunked
* transfer-encoding. One of: <pre>
* REQUEST_NO_BODY Send 413 error if message has any body
* REQUEST_CHUNKED_ERROR Send 411 error if body without Content-Length
* REQUEST_CHUNKED_DECHUNK If chunked, remove the chunks for me.
* </pre>
* @return either OK or an error code
* @deffunc int ap_setup_cleint_block(request_rec *r, int read_policy)
*/
AP_DECLARE(int) ap_setup_client_block(request_rec *r, int read_policy);
/**
* Determine if the client has sent any data. This also sends a
* 100 Continue resposne to HTTP/1.1 clients, so modules should not be called
* until the module is ready to read content.
* @warning Never call this function more than once.
* @param r The current request
* @return 0 if there is no message to read, 1 otherwise
* @deffunc int ap_should_client_block(request_rec *r)
*/
AP_DECLARE(int) ap_should_client_block(request_rec *r);
/**
* Call this in a loop. It will put data into a buffer and return the length
* of the input block
* @param r The current request
* @param buffer The buffer in which to store the data
* @param bufsiz The size of the buffer
* @return Number of bytes inserted into the buffer. When done reading, 0
* if EOF, or -1 if there was an error
* @deffunc long ap_get_client_block(request_rec *r, char *buffer, apr_size_t bufsiz)
*/
AP_DECLARE(long) ap_get_client_block(request_rec *r, char *buffer, apr_size_t bufsiz);
/**
* In HTTP/1.1, any method can have a body. However, most GET handlers
* wouldn't know what to do with a request body if they received one.
* This helper routine tests for and reads any message body in the request,
* simply discarding whatever it receives. We need to do this because
* failing to read the request body would cause it to be interpreted
* as the next request on a persistent connection.
* @param r The current request
* @return error status if request is malformed, OK otherwise
* @deffunc int ap_discard_request_body(request_rec *r)
*/
AP_DECLARE(int) ap_discard_request_body(request_rec *r);
/**
* Setup the output headers so that the client knows how to authenticate
* itself the next time, if an authentication request failed. This function
* works for both basic and digest authentication
* @param r The current request
* @deffunc void ap_note_auth_failure(request_rec *r)
*/
AP_DECLARE(void) ap_note_auth_failure(request_rec *r);
/**
* Setup the output headers so that the client knows how to authenticate
* itself the next time, if an authentication request failed. This function
* works only for basic authentication
* @param r The current request
* @deffunc void ap_note_basic_auth_failure(request_rec *r)
*/
AP_DECLARE(void) ap_note_basic_auth_failure(request_rec *r);
/**
* Setup the output headers so that the client knows how to authenticate
* itself the next time, if an authentication request failed. This function
* works only for digest authentication
* @param r The current request
* @deffunc void ap_note_digest_auth_failure(request_rec *r)
*/
AP_DECLARE(void) ap_note_digest_auth_failure(request_rec *r);
/**
* Get the password from the request headers
* @param r The current request
* @param pw The password as set in the headers
* @return 0 (OK) if it set the 'pw' argument (and assured
* a correct value in r->connection->user); otherwise it returns
* an error code, either HTTP_INTERNAL_SERVER_ERROR if things are
* really confused, HTTP_UNAUTHORIZED if no authentication at all
* seemed to be in use, or DECLINED if there was authentication but
* it wasn't Basic (in which case, the caller should presumably
* decline as well).
* @deffunc int ap_get_basic_auth_pw(request_rec *r, const char **pw)
*/
AP_DECLARE(int) ap_get_basic_auth_pw(request_rec *r, const char **pw);
/**
* parse_uri: break apart the uri
* @warning Side Effects: <pre>
* - sets r->args to rest after '?' (or NULL if no '?')
* - sets r->uri to request uri (without r->args part)
* - sets r->hostname (if not set already) from request (scheme://host:port)
* </pre>
* @param r The current request
* @param uri The uri to break apart
* @deffunc void ap_parse_uri(request_rec *r, const char *uri)
*/
AP_CORE_DECLARE(void) ap_parse_uri(request_rec *r, const char *uri);
/**
* Get the next line of input for the request
* @param s The buffer into which to read the line
* @param n The size of the buffer
* @param r The request
* @param fold Whether to merge continuation lines
* @return The length of the line, if successful
* n, if the line is too big to fit in the buffer
* -1 for miscellaneous errors
* @deffunc int ap_method_number_of(const char *method)
*/
AP_DECLARE(int) ap_getline(char *s, int n, request_rec *r, int fold);
/**
* Get the next line of input for the request
*
* Note: on ASCII boxes, ap_rgetline is a macro which simply calls
* ap_rgetline_core to get the line of input.
*
* on EBCDIC boxes, ap_rgetline is a wrapper function which
* translates ASCII protocol lines to the local EBCDIC code page
* after getting the line of input.
*
* @param s Pointer to the pointer to the buffer into which the line
* should be read; if *s==NULL, a buffer of the necessary size
* to hold the data will be allocated from the request pool
* @param n The size of the buffer
* @param read The length of the line.
* @param r The request
* @param fold Whether to merge continuation lines
* @return APR_SUCCESS, if successful
* APR_ENOSPC, if the line is too big to fit in the buffer
* Other errors where appropriate
*/
#if APR_CHARSET_EBCDIC
AP_DECLARE(apr_status_t) ap_rgetline(char **s, apr_size_t n,
apr_size_t *read,
request_rec *r, int fold);
#else /* ASCII box */
#define ap_rgetline(s, n, read, r, fold) \
ap_rgetline_core((s), (n), (read), (r), (fold))
#endif
AP_DECLARE(apr_status_t) ap_rgetline_core(char **s, apr_size_t n,
apr_size_t *read,
request_rec *r, int fold);
/**
* Get the method number associated with the given string, assumed to
* contain an HTTP method. Returns M_INVALID if not recognized.
* @param method A string containing a valid HTTP method
* @return The method number
*/
AP_DECLARE(int) ap_method_number_of(const char *method);
/**
* Get the method name associated with the given internal method
* number. Returns NULL if not recognized.
* @param p A pool to use for temporary allocations.
* @param methnum An integer value corresponding to an internal method number
* @return The name corresponding to the method number
*/
AP_DECLARE(const char *) ap_method_name_of(apr_pool_t *p, int methnum);
/* Hooks */
/*
* post_read_request --- run right after read_request or internal_redirect,
* and not run during any subrequests.
*/
/**
* This hook allows modules to affect the request immediately after the request
* has been read, and before any other phases have been processes. This allows
* modules to make decisions based upon the input header fields
* @param r The current request
* @return OK or DECLINED
* @deffunc ap_run_post_read_request(request_rec *r)
*/
AP_DECLARE_HOOK(int,post_read_request,(request_rec *r))
/**
* This hook allows modules to perform any module-specific logging activities
* over and above the normal server things.
* @param r The current request
* @return OK, DECLINED, or HTTP_...
* @deffunc int ap_run_log_transaction(request_rec *r)
*/
AP_DECLARE_HOOK(int,log_transaction,(request_rec *r))
/**
* This hook allows modules to retrieve the http method from a request. This
* allows Apache modules to easily extend the methods that Apache understands
* @param r The current request
* @return The http method from the request
* @deffunc const char *ap_run_http_method(const request_rec *r)
*/
AP_DECLARE_HOOK(const char *,http_method,(const request_rec *r))
/**
* Return the default port from the current request
* @param r The current request
* @return The current port
* @deffunc apr_port_t ap_run_default_port(const request_rec *r)
*/
AP_DECLARE_HOOK(apr_port_t,default_port,(const request_rec *r))
typedef struct ap_bucket_error ap_bucket_error;
/**
* A bucket referring to an HTTP error
* This bucket can be passed down the filter stack to indicate that an
* HTTP error occurred while running a filter. In order for this bucket
* to be used successfully, it MUST be sent as the first bucket in the
* first brigade to be sent from a given filter.
*/
struct ap_bucket_error {
/** The error code */
int status;
/** The error string */
const char *data;
};
AP_DECLARE_DATA extern const apr_bucket_type_t ap_bucket_type_error;
/**
* Make the bucket passed in an error bucket
* @param b The bucket to make into an error bucket
* @param error The HTTP error code to put in the bucket.
* @param buf An optional error string to put in the bucket.
* @param p A pool to allocate out of.
* @return The new bucket, or NULL if allocation failed
* @deffunc apr_bucket *ap_bucket_error_make(apr_bucket *b, int error, const char *buf, apr_pool_t *p)
*/
AP_DECLARE(apr_bucket *) ap_bucket_error_make(apr_bucket *b, int error,
const char *buf, apr_pool_t *p);
/**
* Create a bucket referring to an HTTP error.
* @param error The HTTP error code to put in the bucket.
* @param buf An optional error string to put in the bucket.
* @param p A pool to allocate out of.
* @return The new bucket, or NULL if allocation failed
* @deffunc apr_bucket *ap_bucket_error_create(int error, const char *buf, apr_pool_t *p)
*/
AP_DECLARE(apr_bucket *) ap_bucket_error_create(int error,
const char *buf, apr_pool_t *p);
AP_DECLARE_NONSTD(apr_status_t) ap_byterange_filter(ap_filter_t *f, apr_bucket_brigade *b);
AP_DECLARE_NONSTD(apr_status_t) ap_http_header_filter(ap_filter_t *f, apr_bucket_brigade *b);
AP_DECLARE_NONSTD(apr_status_t) ap_content_length_filter(ap_filter_t *,
apr_bucket_brigade *);
AP_DECLARE_NONSTD(apr_status_t) ap_old_write_filter(ap_filter_t *f, apr_bucket_brigade *b);
/*
* Setting up the protocol fields for subsidiary requests...
* Also, a wrapup function to keep the internal accounting straight.
*/
void ap_set_sub_req_protocol(request_rec *rnew, const request_rec *r);
void ap_finalize_sub_req_protocol(request_rec *sub_r);
#ifdef __cplusplus
}
#endif
#endif /* !APACHE_HTTP_PROTOCOL_H */