src/apps/poorman/libhttpd/libhttpd.h

   1 /* libhttpd.h - defines for libhttpd
   2 **
   3 ** Copyright © 1995,1998,1999,2000,2001 by Jef Poskanzer <jef@mail.acme.com>.
   4 ** All rights reserved.
   5 **
   6 ** Redistribution and use in source and binary forms, with or without
   7 ** modification, are permitted provided that the following conditions
   8 ** are met:
   9 ** 1. Redistributions of source code must retain the above copyright
  10 **    notice, this list of conditions and the following disclaimer.
  11 ** 2. Redistributions in binary form must reproduce the above copyright
  12 **    notice, this list of conditions and the following disclaimer in the
  13 **    documentation and/or other materials provided with the distribution.
  14 **
  15 ** THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 ** ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 ** IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 ** ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 ** FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 ** DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 ** OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 ** HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 ** LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 ** OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 ** SUCH DAMAGE.
  26 */
  27
  28 #ifndef _LIBHTTPD_H_
  29 #define _LIBHTTPD_H_
  30
  31 #include <sys/types.h>
  32 #include <sys/time.h>
  33 #include <sys/param.h>
  34 #include <sys/socket.h>
  35 #include <sys/stat.h>
  36 #include <netinet/in.h>
  37 #include <arpa/inet.h>
  38 #include <netdb.h>
  39
  40 #if defined(AF_INET6) && defined(IN6_IS_ADDR_V4MAPPED)
  41 #define USE_IPV6
  42 #endif
  43
  44
  45 /* A few convenient defines. */
  46
  47 #ifndef MAX
  48 #define MAX(a,b) ((a) > (b) ? (a) : (b))
  49 #endif
  50 #ifndef MIN
  51 #define MIN(a,b) ((a) < (b) ? (a) : (b))
  52 #endif
  53 #define NEW(t,n) ((t*) malloc( sizeof(t) * (n) ))
  54 #define RENEW(o,t,n) ((t*) realloc( (void*) o, sizeof(t) * (n) ))
  55
  56
  57 /* The httpd structs. */
  58
  59 /* A multi-family sockaddr. */
  60 typedef union {
  61     struct sockaddr sa;
  62     struct sockaddr_in sa_in;
  63 #ifdef USE_IPV6
  64     struct sockaddr_in6 sa_in6;
  65     struct sockaddr_storage sa_stor;
  66 #endif /* USE_IPV6 */
  67     } httpd_sockaddr;
  68
  69 /* A server. */
  70 typedef struct {
  71     char* binding_hostname;
  72     char* server_hostname;
  73     unsigned short port;
  74     char* cgi_pattern;
  75     int cgi_limit, cgi_count;
  76     char* charset;
  77     char* p3p;
  78     int max_age;
  79     char* cwd;
  80     int listen4_fd, listen6_fd;
  81     int no_log;
  82     FILE* logfp;
  83     int no_symlink_check;
  84     int vhost;
  85     int global_passwd;
  86     char* url_pattern;
  87     char* local_pattern;
  88     int no_empty_referers;
  89     //added for poorman
  90     int do_list_dir;
  91     char* index_name;
  92     } httpd_server;
  93
  94 /* A connection. */
  95 typedef struct {
  96     int initialized;
  97     httpd_server* hs;
  98     httpd_sockaddr client_addr;
  99     char* read_buf;
 100     size_t read_size, read_idx, checked_idx;
 101     int checked_state;
 102     int method;
 103     int status;
 104     off_t bytes_to_send;
 105     off_t bytes_sent;
 106     char* encodedurl;
 107     char* decodedurl;
 108     char* protocol;
 109     char* origfilename;
 110     char* expnfilename;
 111     char* encodings;
 112     char* pathinfo;
 113     char* query;
 114     char* referer;
 115     char* useragent;
 116     char* accept;
 117     char* accepte;
 118     char* acceptl;
 119     char* cookie;
 120     char* contenttype;
 121     char* reqhost;
 122     char* hdrhost;
 123     char* hostdir;
 124     char* authorization;
 125     char* remoteuser;
 126     char* response;
 127     size_t maxdecodedurl, maxorigfilename, maxexpnfilename, maxencodings,
 128         maxpathinfo, maxquery, maxaccept, maxaccepte, maxreqhost, maxhostdir,
 129         maxremoteuser, maxresponse;
 130 #ifdef TILDE_MAP_2
 131     char* altdir;
 132     size_t maxaltdir;
 133 #endif /* TILDE_MAP_2 */
 134     size_t responselen;
 135     time_t if_modified_since, range_if;
 136     size_t contentlength;
 137     char* type;         /* not malloc()ed */
 138     char* hostname;     /* not malloc()ed */
 139     int mime_flag;
 140     int one_one;        /* HTTP/1.1 or better */
 141     int got_range;
 142     int tildemapped;    /* this connection got tilde-mapped */
 143     off_t first_byte_index, last_byte_index;
 144     int keep_alive;
 145     int should_linger;
 146     struct stat sb;
 147     int conn_fd;
 148     int processed_directory_index;
 149     } httpd_conn;
 150
 151 /* Methods. */
 152 #define METHOD_UNKNOWN 0
 153 #define METHOD_GET 1
 154 #define METHOD_HEAD 2
 155 #define METHOD_POST 3
 156
 157 /* States for checked_state. */
 158 #define CHST_FIRSTWORD 0
 159 #define CHST_FIRSTWS 1
 160 #define CHST_SECONDWORD 2
 161 #define CHST_SECONDWS 3
 162 #define CHST_THIRDWORD 4
 163 #define CHST_THIRDWS 5
 164 #define CHST_LINE 6
 165 #define CHST_LF 7
 166 #define CHST_CR 8
 167 #define CHST_CRLF 9
 168 #define CHST_CRLFCR 10
 169 #define CHST_BOGUS 11
 170
 171 #ifdef __cplusplus
 172 extern "C" {
 173 #endif
 174
 175 /* Initializes.  Does the socket(), bind(), and listen().   Returns an
 176 ** httpd_server* which includes a socket fd that you can select() on.
 177 ** Return (httpd_server*) 0 on error.
 178 */
 179 extern httpd_server* httpd_initialize(
 180     char* hostname, httpd_sockaddr* sa4P, httpd_sockaddr* sa6P,
 181     unsigned short port, char* cgi_pattern, int cgi_limit, char* charset,
 182     char* p3p, int max_age, char* cwd, int no_log, FILE* logfp,
 183     int no_symlink_check, int vhost, int global_passwd, char* url_pattern,
 184     char* local_pattern, int no_empty_referers );
 185
 186 /* PoorMan: Initialize_listen_socket() is changed from static to extern.
 187 ** httpd_unlisten() needs an opposite operation that can be accessed from
 188 ** outside libhttpd. So this is it.
 189 */
 190 extern int httpd_initialize_listen_socket( httpd_sockaddr* saP );
 191
 192 /* Change the log file. */
 193 extern void httpd_set_logfp( httpd_server* hs, FILE* logfp );
 194
 195 /* Call to unlisten/close socket(s) listening for new connections. */
 196 extern void httpd_unlisten( httpd_server* hs );
 197
 198 /* Call to shut down. */
 199 extern void httpd_terminate( httpd_server* hs );
 200
 201
 202 /* When a listen fd is ready to read, call this.  It does the accept() and
 203 ** returns an httpd_conn* which includes the fd to read the request from and
 204 ** write the response to.  Returns an indication of whether the accept()
 205 ** failed, succeeded, or if there were no more connections to accept.
 206 **
 207 ** In order to minimize malloc()s, the caller passes in the httpd_conn.
 208 ** The caller is also responsible for setting initialized to zero before the
 209 ** first call using each different httpd_conn.
 210 */
 211 extern int httpd_get_conn( httpd_server* hs, int listen_fd, httpd_conn* hc );
 212 #define GC_FAIL 0
 213 #define GC_OK 1
 214 #define GC_NO_MORE 2
 215
 216 /* Checks whether the data in hc->read_buf constitutes a complete request
 217 ** yet.  The caller reads data into hc->read_buf[hc->read_idx] and advances
 218 ** hc->read_idx.  This routine checks what has been read so far, using
 219 ** hc->checked_idx and hc->checked_state to keep track, and returns an
 220 ** indication of whether there is no complete request yet, there is a
 221 ** complete request, or there won't be a valid request due to a syntax error.
 222 */
 223 extern int httpd_got_request( httpd_conn* hc );
 224 #define GR_NO_REQUEST 0
 225 #define GR_GOT_REQUEST 1
 226 #define GR_BAD_REQUEST 2
 227
 228 /* Parses the request in hc->read_buf.  Fills in lots of fields in hc,
 229 ** like the URL and the various headers.
 230 **
 231 ** Returns -1 on error.
 232 */
 233 extern int httpd_parse_request( httpd_conn* hc );
 234
 235 /* Starts sending data back to the client.  In some cases (directories,
 236 ** CGI programs), finishes sending by itself - in those cases, hc->file_fd
 237 ** is <0.  If there is more data to be sent, then hc->file_fd is a file
 238 ** descriptor for the file to send.  If you don't have a current timeval
 239 ** handy just pass in 0.
 240 **
 241 ** Returns -1 on error.
 242 */
 243 extern int httpd_start_request( httpd_conn* hc, struct timeval* nowP );
 244
 245 /* Actually sends any buffered response text. */
 246 extern void httpd_write_response( httpd_conn* hc );
 247
 248 /* Call this to close down a connection and free the data.  A fine point,
 249 ** if you fork() with a connection open you should still call this in the
 250 ** parent process - the connection will stay open in the child.
 251 ** If you don't have a current timeval handy just pass in 0.
 252 */
 253 extern void httpd_close_conn( httpd_conn* hc, struct timeval* nowP );
 254
 255 /* Call this to de-initialize a connection struct and *really* free the
 256 ** mallocced strings.
 257 */
 258 extern void httpd_destroy_conn( httpd_conn* hc );
 259
 260
 261 /* Send an error message back to the client. */
 262 extern void httpd_send_err(
 263     httpd_conn* hc, int status, char* title, char* extraheads, char* form, char* arg );
 264
 265 /* Some error messages. */
 266 extern char* httpd_err400title;
 267 extern char* httpd_err400form;
 268 extern char* httpd_err408title;
 269 extern char* httpd_err408form;
 270 extern char* httpd_err503title;
 271 extern char* httpd_err503form;
 272
 273 /* Generate a string representation of a method number. */
 274 extern char* httpd_method_str( int method );
 275
 276 /* Reallocate a string. */
 277 extern void httpd_realloc_str( char** strP, size_t* maxsizeP, size_t size );
 278
 279 /* Format a network socket to a string representation. */
 280 extern char* httpd_ntoa( httpd_sockaddr* saP );
 281
 282 /* Set NDELAY mode on a socket. */
 283 extern void httpd_set_ndelay( int fd );
 284
 285 /* Clear NDELAY mode on a socket. */
 286 extern void httpd_clear_ndelay( int fd );
 287
 288 /* Read the requested buffer completely, accounting for interruptions. */
 289 extern int httpd_read_fully( int fd, void* buf, size_t nbytes );
 290
 291 /* Write the requested buffer completely, accounting for interruptions. */
 292 extern int httpd_write_fully( int fd, const void* buf, size_t nbytes );
 293
 294 /* Generate debugging statistics syslog message. */
 295 extern void httpd_logstats( long secs );
 296
 297 #ifdef __cplusplus
 298 }
 299 #endif
 300
 301 #endif /* _LIBHTTPD_H_ */