uhttpd.h

Go to the documentation of this file.

#ifndef _PRO_UHTTP_UHTTP_H_
#define _PRO_UHTTP_UHTTP_H_

/*
 * Copyright (C) 2012 by egnite GmbH
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the copyright holders nor the names of
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * For additional information see http://www.ethernut.de/
 */

#include <cfg/http.h>

#include <pro/uhttp/compiler.h>
#include <pro/uhttp/streamio.h>

#if !defined(HTTPD_EXCLUDE_DATE)
#include <time.h>
#endif


#if 0
/* Testing versions. */
#define HTTP_VERSION    0x09
#undef HTTP_MAJOR_VERSION
#define HTTP_MAJOR_VERSION  0
#undef HTTP_MINOR_VERSION
#define HTTP_MINOR_VERSION  9
#endif

#ifndef HTTP_MAJOR_VERSION
#define HTTP_MAJOR_VERSION  1
#endif

#ifndef HTTP_MINOR_VERSION
#define HTTP_MINOR_VERSION  1
#endif

#ifndef HTTP_VERSION
#if HTTP_MAJOR_VERSION == 0
#if HTTP_MINOR_VERSION == 9
#define HTTP_VERSION    0x09
#endif
#elif HTTP_MAJOR_VERSION == 1
#if HTTP_MINOR_VERSION == 0
#define HTTP_VERSION    0x10
#elif HTTP_MINOR_VERSION == 1
#define HTTP_VERSION    0x11
#endif
#endif
#endif

#ifndef HTTP_VERSION
#error Cannot determine HTTP version
#endif

#define HTTP_METHOD_GET         1

#define HTTP_METHOD_POST        2

#define HTTP_METHOD_HEAD        3

#define HTTP_CONN_CLOSE         1

#define HTTP_CONN_KEEP_ALIVE    2

typedef struct _HTTP_REQUEST HTTP_REQUEST;

struct _HTTP_REQUEST {
    int req_method;             
    char *req_url;              
    int req_version;            
    char *req_query;            
    char *req_argp;             
    char *req_argn;             
    char *req_argv;             
    int req_connection;         
#if HTTP_VERSION >= 0x10
    long req_length;            
    char *req_realm;            
    char *req_type;             
    char *req_cookie;           
    char *req_auth;             
    char *req_agent;            
#if !defined(HTTPD_EXCLUDE_DATE)
    time_t req_ims;             
#endif
    char *req_referer;          
    char *req_host;             
    char *req_encoding;         
    char *req_bnd_dispo;        
    char *req_bnd_type;         
#endif
};

typedef struct _HTTPD_SESSION HTTPD_SESSION;

struct _HTTPD_SESSION {
    HTTP_STREAM *s_stream;
    HTTP_REQUEST s_req;
};

extern const char ct_GET[];
extern const char ct_HEAD[];
extern const char ct_POST[];
extern const char ct_Content_Disposition[];
extern const char ct_Content_Type[];
extern const char ct_Accept_Encoding[];
extern const char ct_Authorization[];
extern const char ct_Connection[];
extern const char ct_close[];
extern const char ct_Keep_Alive[];
extern const char ct_Content_Length[];
extern const char ct_Cookie[];
extern const char ct_Host[];
extern const char ct_Referer[];
extern const char ct_User_Agent[];
extern const char ct_Content_Encoding[];
extern const char ct_Location[];

#if !defined(HTTPD_EXCLUDE_DATE)
extern const char ct_If_Modified_Since[];
extern const char ct_Last_Modified[];
extern const char ct_Expires[];
extern const char ct_Date[];
#endif

extern char *http_root;
#define HTTP_ROOT   (http_root ? http_root : HTTP_DEFAULT_ROOT)

typedef int (*HTTP_AUTH_VALIDATOR) (HTTPD_SESSION*);
extern HTTP_AUTH_VALIDATOR httpd_auth_validator;

typedef int (*HTTP_LOC_REDIRECTOR) (HTTPD_SESSION*);
extern HTTP_LOC_REDIRECTOR httpd_loc_redirector;


extern int HttpRegisterRootPath(char *path);

extern int HttpParseHeader(HTTPD_SESSION *hs);

extern int HttpParseMultipartHeader(HTTPD_SESSION *hs, const char *bnd, long *avail);

extern void HttpSendHeaderTop(HTTPD_SESSION *hs, int status);
#if !defined(HTTPD_EXCLUDE_DATE)

extern void HttpSendHeaderDate(HTTPD_SESSION *hs, time_t mtime);
#endif

extern void HttpSendHeaderBottom(HTTPD_SESSION *hs, char *type, char *subtype, long bytes);

extern void HttpSendError(HTTPD_SESSION *hs, int status);

extern int HttpSendRedirection(HTTPD_SESSION *hs, int code, ...);

extern char *HttpArgParseFirst(HTTP_REQUEST * req);

extern char *HttpArgParseNext(HTTP_REQUEST * req);

extern char *HttpArgReadNext(HTTPD_SESSION *hs, long *avail);

extern char *HttpArgValue(HTTP_REQUEST * req);

extern const char *HttpArgValueSub(const char *str, const char *name, int *len);

void HttpdClientHandler(HTTP_STREAM *sp);


#endif