http_protocol.h revision bfb62a96023822c56c9120e4ee627d4091cc59c2
2d2eda71267231c2526be701fe655db125852c1ffielding/* ====================================================================
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * The Apache Software License, Version 1.1
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * Copyright (c) 2000 The Apache Software Foundation. All rights
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * reserved.
2d2eda71267231c2526be701fe655db125852c1ffielding * Redistribution and use in source and binary forms, with or without
2d2eda71267231c2526be701fe655db125852c1ffielding * modification, are permitted provided that the following conditions
2d2eda71267231c2526be701fe655db125852c1ffielding * 1. Redistributions of source code must retain the above copyright
2d2eda71267231c2526be701fe655db125852c1ffielding * notice, this list of conditions and the following disclaimer.
2d2eda71267231c2526be701fe655db125852c1ffielding * 2. Redistributions in binary form must reproduce the above copyright
2d2eda71267231c2526be701fe655db125852c1ffielding * notice, this list of conditions and the following disclaimer in
2d2eda71267231c2526be701fe655db125852c1ffielding * the documentation and/or other materials provided with the
2d2eda71267231c2526be701fe655db125852c1ffielding * distribution.
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * 3. The end-user documentation included with the redistribution,
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * if any, must include the following acknowledgment:
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * "This product includes software developed by the
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * Apache Software Foundation (http://www.apache.org/)."
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * Alternately, this acknowledgment may appear in the software itself,
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * if and wherever such third-party acknowledgments normally appear.
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * 4. The names "Apache" and "Apache Software Foundation" must
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * not be used to endorse or promote products derived from this
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * software without prior written permission. For written
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * permission, please contact apache@apache.org.
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * 5. Products derived from this software may not be called "Apache",
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * nor may "Apache" appear in their name, without prior written
64185f9824e42f21ca7b9ae6c004484215c031a7rbb * permission of the Apache Software Foundation.
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
2d2eda71267231c2526be701fe655db125852c1ffielding * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * SUCH DAMAGE.
2d2eda71267231c2526be701fe655db125852c1ffielding * ====================================================================
2d2eda71267231c2526be701fe655db125852c1ffielding * This software consists of voluntary contributions made by many
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * individuals on behalf of the Apache Software Foundation. For more
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * information on the Apache Software Foundation, please see
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * Portions of this software are based upon public domain software
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * originally written at the National Center for Supercomputing Applications,
f062ed7bd262a37a909dd77ce5fc23b446818823fielding * University of Illinois, Urbana-Champaign.
2d2eda71267231c2526be701fe655db125852c1ffieldingextern "C" {
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @package HTTP protocol handling
2d2eda71267231c2526be701fe655db125852c1ffielding * Prototypes for routines which either talk directly back to the user,
2d2eda71267231c2526be701fe655db125852c1ffielding * or control the ones that eventually do.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Read a request and fill in the fields.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param c The current connection
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return The new request_rec
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Send a single HTTP header field
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param fieldname The Header field to send
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param fieldval The value of the header
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc int ap_send_header_field(request_rec *r, const char *fieldname, const char *fieldval)
2d2eda71267231c2526be701fe655db125852c1ffieldingAPI_EXPORT_NONSTD(int) ap_send_header_field(request_rec *r, const char *fieldname,
2d2eda71267231c2526be701fe655db125852c1ffielding const char *fieldval);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Send the minimal part of an HTTP response header.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @warning Modules should be very careful about using this, and should
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * prefer ap_send_http_header(). Much of the HTTP/1.1 implementation
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * correctness depends on code in ap_send_http_header().
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc void ap_basic_http_header(request_rec *r)
2d2eda71267231c2526be701fe655db125852c1ffieldingAPI_EXPORT(void) ap_basic_http_header(request_rec *r);
bfb62a96023822c56c9120e4ee627d4091cc59c2rbb * Send the Status-Line and header fields for HTTP response
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param l The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc void ap_send_http_header(request_rec *l)
2d2eda71267231c2526be701fe655db125852c1ffieldingAPI_EXPORT(void) ap_send_http_header(request_rec *l);
2d2eda71267231c2526be701fe655db125852c1ffielding/* Send the response to special method requests */
bfb62a96023822c56c9120e4ee627d4091cc59c2rbb/* Finish up stuff after a request */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Called at completion of sending the response. It sends the terminating
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * protocol information.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc void ap_finalize_request_protocol(request_rec *r)
2d2eda71267231c2526be701fe655db125852c1ffieldingAPI_EXPORT(void) ap_finalize_request_protocol(request_rec *r);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Send error back to client.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param recursive_error last arg indicates error status in case we get
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * an error in the process of trying to deal with an ErrorDocument
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * to handle some other error. In that case, we print the default
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * report for the first thing that went wrong, and more briefly report
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * on the problem with the ErrorDocument.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc void ap_send_error_response(request_rec *r, int recursive_error)
4c3d3eaf42bd7757edb3721cb586f2ef2bcbf671stoddardAPI_EXPORT(void) ap_send_error_response(request_rec *r, int recursive_error);
2d2eda71267231c2526be701fe655db125852c1ffielding/* Set last modified header line from the lastmod date of the associated file.
2d2eda71267231c2526be701fe655db125852c1ffielding * Also, set content length.
000b67449410515eac43e76ef6667915bfd4d2abgstein * May return an error status, typically HTTP_NOT_MODIFIED (that when the
2d2eda71267231c2526be701fe655db125852c1ffielding * permit_cache argument is set to one).
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Set the content length for this request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param length The new content length
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return Always 0, can be safely ignored
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc int ap_set_content_length(request_rec *r, long length)
2d2eda71267231c2526be701fe655db125852c1ffieldingAPI_EXPORT(int) ap_set_content_length(request_rec *r, long length);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Set the keepalive status for this request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return 1 if keepalive can be set, 0 otherwise
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc int ap_set_keepalive(request_rec *r)
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Return the latest rational time from a request/mtime pair. Mtime is
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * returned unless it's in the future, in which case we return the current time.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param mtime The last modified time
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return the latest rational time.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc apr_time_t ap_rationalize_mtime(request_rec *r, apr_time_t mtime)
1ccd992d37d62c8cb2056126f2234f64ec189bfddougmAPI_EXPORT(apr_time_t) ap_rationalize_mtime(request_rec *r, apr_time_t mtime);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Construct an entity tag from the resource information. If it's a real
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * file, build in some of the file characteristics.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param force_weak Force the entity tag to be weak - it could be modified
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * again in as short an interval.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return The entity tag
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc char *ap_make_etag(request_rec *r, int force_weak)
2d2eda71267231c2526be701fe655db125852c1ffieldingAPI_EXPORT(char *) ap_make_etag(request_rec *r, int force_weak);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Set the E-tag outgoing header
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc void ap_set_etag(request_rec *r)
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Set the last modified time for the file being sent
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc void ap_set_last_modified(request_rec *r)
2d2eda71267231c2526be701fe655db125852c1ffieldingAPI_EXPORT(void) ap_set_last_modified(request_rec *r);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Implements condition GET rules for HTTP/1.1 specification. This function
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * inspects the client headers and determines if the response fulfills
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * the requirements specified.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return 1 if the response fulfills the condition GET rules, 0 otherwise
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc int ap_meets_conditions(request_rec *r)
2d2eda71267231c2526be701fe655db125852c1ffieldingAPI_EXPORT(int) ap_meets_conditions(request_rec *r);
2d2eda71267231c2526be701fe655db125852c1ffielding/* Other ways to send stuff at the client. All of these keep track
2d2eda71267231c2526be701fe655db125852c1ffielding * of bytes_sent automatically. This indirection is intended to make
2d2eda71267231c2526be701fe655db125852c1ffielding * it a little more painless to slide things like HTTP-NG packetization
2d2eda71267231c2526be701fe655db125852c1ffielding * underneath the main body of the code later. In the meantime, it lets
2d2eda71267231c2526be701fe655db125852c1ffielding * us centralize a bit of accounting (bytes_sent).
2d2eda71267231c2526be701fe655db125852c1ffielding * These also return the number of bytes written by the call.
2d2eda71267231c2526be701fe655db125852c1ffielding * They should only be called with a timeout registered, for obvious reaasons.
2d2eda71267231c2526be701fe655db125852c1ffielding * (Ditto the send_header stuff).
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Send an entire file to the client, using sendfile if supported by the
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * current platform
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param fd The file to send.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param offset Offset into the file to start sending.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param length Amount of data to send
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param nbytes Amount of data actually sent
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @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);
1ccd992d37d62c8cb2056126f2234f64ec189bfddougmAPI_EXPORT(apr_status_t) ap_send_fd(apr_file_t *fd, request_rec *r, apr_off_t offset,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Send the body of a response to the client
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param f The BUFF structure associated with a client
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return The number of bytes sent
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc long ap_send_fb(BUFF *f, request_rec *r)
2d2eda71267231c2526be701fe655db125852c1ffieldingAPI_EXPORT(long) ap_send_fb(BUFF *f, request_rec *r);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Send a specified number of bytes from the body of the response to the client
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param f the BUFF structure associated with a client
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param length The number of bytes to send
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return The number of bytes sent
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc long ap_send_fb_length(BUFF *f, request_rec *r, long length)
2d2eda71267231c2526be701fe655db125852c1ffieldingAPI_EXPORT(long) ap_send_fb_length(BUFF *f, request_rec *r, long length);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Send an MMAP'ed file to the client
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param mm The MMAP'ed file to send
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param offset The offset into the MMAP to start sending
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param length The amount of data to send
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return The number of bytes sent
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc size_t ap_send_mmap(apr_mmap_t *mm, request_rec *r, size_t offset, size_t length)
1ccd992d37d62c8cb2056126f2234f64ec189bfddougmAPI_EXPORT(size_t) ap_send_mmap(apr_mmap_t *mm, request_rec *r, size_t offset,
2d2eda71267231c2526be701fe655db125852c1ffielding/* Hmmm... could macrofy these for now, and maybe forever, though the
2d2eda71267231c2526be701fe655db125852c1ffielding * definitions of the macros would get a whole lot hairier.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Output one character for this request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param c the character to output
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r the current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return The number of bytes sent
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc int ap_rputc(int c, request_rec *r)
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Output a string for the current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param str The string to output
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return The number of bytes sent
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc int ap_rputs(const char *str, request_rec *r)
2d2eda71267231c2526be701fe655db125852c1ffieldingAPI_EXPORT(int) ap_rputs(const char *str, request_rec *r);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Write a buffer for the current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param buf The buffer to write
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param nbyte The number of bytes to send from the buffer
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return The number of bytes sent
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc int ap_rwrite(const void *buf, int nbyte, request_rec *r)
2d2eda71267231c2526be701fe655db125852c1ffieldingAPI_EXPORT(int) ap_rwrite(const void *buf, int nbyte, request_rec *r);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Write an unspecified number of strings to the request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param ... The strings to write
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return The number of bytes sent
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc int ap_rvputs(request_rec *r, ...)
2d2eda71267231c2526be701fe655db125852c1ffieldingAPI_EXPORT_NONSTD(int) ap_rvputs(request_rec *r,...);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Output data to the client in a printf format
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param fmt The format string
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param vlist The arguments to use to fill out the format string
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return The number of bytes sent
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc int ap_vrprintf(request_rec *r, const char *fmt, va_list vlist)
2d2eda71267231c2526be701fe655db125852c1ffieldingAPI_EXPORT(int) ap_vrprintf(request_rec *r, const char *fmt, va_list vlist);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Output data to the client in a printf format
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param fmt The format string
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param ... The arguments to use to fill out the format string
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return The number of bytes sent
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc int ap_rprintf(request_rec *r, const char *fmt, ...)
2d2eda71267231c2526be701fe655db125852c1ffieldingAPI_EXPORT_NONSTD(int) ap_rprintf(request_rec *r, const char *fmt,...)
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Flush all of the data for the current request to the client
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return The number of bytes sent
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc int ap_rflush(request_rec *r)
2d2eda71267231c2526be701fe655db125852c1ffielding * Index used in custom_responses array for a specific error code
2d2eda71267231c2526be701fe655db125852c1ffielding * (only use outside protocol.c is in getting them configured).
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param status HTTP status code
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return The index of the response
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc int ap_index_of_response(int status)
d839a9822ee53ce00da24c15f2d9fe054233d342gstein * Return the Status-Line for a given status code (excluding the
d839a9822ee53ce00da24c15f2d9fe054233d342gstein * HTTP-Version field). If an invalid or unknown status code is
d839a9822ee53ce00da24c15f2d9fe054233d342gstein * passed, "500 Internal Server Error" will be returned.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param status The HTTP status code
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return The Status-Line
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc const char *ap_get_status_line(int status)
d839a9822ee53ce00da24c15f2d9fe054233d342gsteinAPI_EXPORT(const char *) ap_get_status_line(int status);
2d2eda71267231c2526be701fe655db125852c1ffielding/* Reading a block of data from the client connection (e.g., POST arg) */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Setup the client to allow Apache to read the request body.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param read_policy How the server should interpret a chunked
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * transfer-encoding. One of: <PRE>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * REQUEST_NO_BODY Send 413 error if message has any body
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * REQUEST_CHUNKED_ERROR Send 411 error if body without Content-Length
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * REQUEST_CHUNKED_DECHUNK If chunked, remove the chunks for me.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * REQUEST_CHUNKED_PASS Pass the chunks to me without removal.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return either OK or an error code
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc int ap_setup_cleint_block(request_rec *r, int read_policy)
2d2eda71267231c2526be701fe655db125852c1ffieldingAPI_EXPORT(int) ap_setup_client_block(request_rec *r, int read_policy);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Determine if the client has sent any data. This also sends a
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * 100 Continue resposne to HTTP/1.1 clients, so modules should not be called
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * until the module is ready to read content.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @warning Never call this function more than once.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return 0 if there is no message to read, 1 otherwise
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc int ap_should_client_block(request_rec *r)
2d2eda71267231c2526be701fe655db125852c1ffieldingAPI_EXPORT(int) ap_should_client_block(request_rec *r);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Call this in a loop. It will put data into a buffer and return the length
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * of the input block
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param buffer The buffer in which to store the data
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param bufsiz The size of the buffer
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return Number of bytes inserted into the buffer. When done reading, 0
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * if EOF, or -1 if there was an error
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc long ap_get_client_block(request_rec *r, char *buffer, int bufsiz)
2d2eda71267231c2526be701fe655db125852c1ffieldingAPI_EXPORT(long) ap_get_client_block(request_rec *r, char *buffer, int bufsiz);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * In HTTP/1.1, any method can have a body. However, most GET handlers
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * wouldn't know what to do with a request body if they received one.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * This helper routine tests for and reads any message body in the request,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * simply discarding whatever it receives. We need to do this because
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * failing to read the request body would cause it to be interpreted
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * as the next request on a persistent connection.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return error status if request is malformed, OK otherwise
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc int ap_discard_request_body(request_rec *r)
2d2eda71267231c2526be701fe655db125852c1ffieldingAPI_EXPORT(int) ap_discard_request_body(request_rec *r);
2d2eda71267231c2526be701fe655db125852c1ffielding/* Sending a byterange */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Setup the request to send Byte Range requests
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r the current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return 1 if request was setup for byte range requests, 0 otherwise
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc int ap_set_byterange(request_rec *r)
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Send one byte range chunk for a byte range request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param offset Set to the position it should be after the chunk is sent
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param length Set to the length in should be after the chunk is sent
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc int ap_each_byterange(request_rec *r, apr_off_t *offset, apr_size_t *length)
1ccd992d37d62c8cb2056126f2234f64ec189bfddougmAPI_EXPORT(int) ap_each_byterange(request_rec *r, apr_off_t *offset,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Setup the output headers so that the client knows how to authenticate
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * itself the next time, if an authentication request failed. This function
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * works for both basic and digest authentication
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc void ap_note_auth_failure(request_rec *r)
2d2eda71267231c2526be701fe655db125852c1ffieldingAPI_EXPORT(void) ap_note_auth_failure(request_rec *r);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Setup the output headers so that the client knows how to authenticate
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * itself the next time, if an authentication request failed. This function
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * works only for basic authentication
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc void ap_note_basic_auth_failure(request_rec *r)
2d2eda71267231c2526be701fe655db125852c1ffieldingAPI_EXPORT(void) ap_note_basic_auth_failure(request_rec *r);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Setup the output headers so that the client knows how to authenticate
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * itself the next time, if an authentication request failed. This function
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * works only for digest authentication
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc void ap_note_digest_auth_failure(request_rec *r)
2d2eda71267231c2526be701fe655db125852c1ffieldingAPI_EXPORT(void) ap_note_digest_auth_failure(request_rec *r);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Get the password from the request headers
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param pw The password as set in the headers
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return 0 (OK) if it set the 'pw' argument (and assured
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * a correct value in r->connection->user); otherwise it returns
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * an error code, either HTTP_INTERNAL_SERVER_ERROR if things are
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * really confused, HTTP_UNAUTHORIZED if no authentication at all
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * seemed to be in use, or DECLINED if there was authentication but
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * it wasn't Basic (in which case, the caller should presumably
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * decline as well).
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc int ap_get_basic_auth_pw(request_rec *r, const char **pw)
2d2eda71267231c2526be701fe655db125852c1ffieldingAPI_EXPORT(int) ap_get_basic_auth_pw(request_rec *r, const char **pw);
2d2eda71267231c2526be701fe655db125852c1ffielding * Setting up the protocol fields for subsidiary requests...
2d2eda71267231c2526be701fe655db125852c1ffielding * Also, a wrapup function to keep the internal accounting straight.
2d2eda71267231c2526be701fe655db125852c1ffieldingvoid ap_set_sub_req_protocol(request_rec *rnew, const request_rec *r);
2d2eda71267231c2526be701fe655db125852c1ffieldingvoid ap_finalize_sub_req_protocol(request_rec *sub_r);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * parse_uri: break apart the uri
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @warning Side Effects: <PRE>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * - sets r->args to rest after '?' (or NULL if no '?')
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * - sets r->uri to request uri (without r->args part)
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * - sets r->hostname (if not set already) from request (scheme://host:port)
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param uri The uri to break apart
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc void ap_parse_uri(request_rec *r, const char *uri)
2d2eda71267231c2526be701fe655db125852c1ffieldingCORE_EXPORT(void) ap_parse_uri(request_rec *r, const char *uri);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Get the method number associated with the given string, assumed to
2d2eda71267231c2526be701fe655db125852c1ffielding * contain an HTTP method. Returns M_INVALID if not recognized.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param method A string containing a valid HTTP method
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return The method number
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc int ap_method_number_of(const char *method)
2d2eda71267231c2526be701fe655db125852c1ffieldingAPI_EXPORT(int) ap_method_number_of(const char *method);
344f3bc38dfccf6261d5bb8d689794cde113b3d6coar * Get the method name associated with the given internal method
344f3bc38dfccf6261d5bb8d689794cde113b3d6coar * number. Returns NULL if not recognized.
344f3bc38dfccf6261d5bb8d689794cde113b3d6coar * @param methnum An integer value corresponding to an internal method number
344f3bc38dfccf6261d5bb8d689794cde113b3d6coar * @return The name corresponding to the method number
344f3bc38dfccf6261d5bb8d689794cde113b3d6coar * @deffunc const char *ap_method_name_of(int methnum)
344f3bc38dfccf6261d5bb8d689794cde113b3d6coarAPI_EXPORT(const char *) ap_method_name_of(int methnum);
fd0edaa8e3d4dd67d0604ccef2e96b071db96643fielding /* Hooks */
fd0edaa8e3d4dd67d0604ccef2e96b071db96643fielding * post_read_request --- run right after read_request or internal_redirect,
fd0edaa8e3d4dd67d0604ccef2e96b071db96643fielding * and not run during any subrequests.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * This hook allows modules to affect the request immediately after the request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * has been read, and before any other phases have been processes. This allows
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * modules to make decisions based upon the input header fields
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return OK or DECLINED
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc ap_run_post_read_request(request_rec *r)
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * This hook allows modules to perform any module-specific logging activities
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * over and above the normal server things.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return OK, DECLINED, or HTTP_...
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc int ap_run_log_transaction(request_rec *r)
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * This hook allows modules to retrieve the http method from a request. This
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * allows Apache modules to easily extend the methods that Apache understands
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return The http method from the request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc const char *ap_run_http_method(const request_rec *r)
36bb027ff0af9d285d15e9fac4fc956db6c33e94wroweAP_DECLARE_HOOK(const char *,http_method,(const request_rec *))
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Return the default port from the current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return The current port
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @deffunc unsigned short ap_run_default_port(const request_rec *r)
36bb027ff0af9d285d15e9fac4fc956db6c33e94wroweAP_DECLARE_HOOK(unsigned short,default_port,(const request_rec *))
2d2eda71267231c2526be701fe655db125852c1ffielding#endif /* !APACHE_HTTP_PROTOCOL_H */