httpd.h

Go to the documentation of this file.

#ifndef _PRO_HTTPD_H_
#define _PRO_HTTPD_H_

/*
 * Copyright (C) 2001-2007 by egnite Software 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 <stdint.h>

#include <stdio.h>
#include <time.h>

#include <compiler.h> // For NUT_DEPRECATED


#define METHOD_GET  1
#define METHOD_POST 2
#define METHOD_HEAD 3

#define HTTP_CONN_CLOSE         1
#define HTTP_CONN_KEEP_ALIVE    2

#define HTTP_OF_USE_HOST_TIME   0x00000001UL
#define HTTP_OF_USE_FILE_TIME   0x00000002UL

typedef struct _REQUEST REQUEST;
struct _REQUEST {
    int req_method;             
    int req_version;            
    long req_length;            
    char *req_url;              
    char *req_query;            
    char *req_type;             
    char *req_cookie;           
    char *req_auth;             
    char *req_agent;            
    char **req_qptrs;           
    int req_numqptrs;           
    time_t req_ims;             
    char *req_referer;          
    char *req_host;             
    int req_connection;         
    char *req_encoding;         
};

typedef struct _MIMETYPES MIMETYPES;

struct _MIMETYPES {
    char *mtyp_ext;
    char *mtyp_type;
    void (*mtyp_handler)(FILE *stream, int fd, int file_len, char *http_root, REQUEST *req);
};

extern void NutHttpProcessRequest(FILE * stream);
extern void NutHttpProcessQueryString(REQUEST * req);
extern void NutHttpSendHeaderTop(FILE * stream, REQUEST * req, int status, char *title);
extern void NutHttpSendHeaderBottom(FILE * stream, REQUEST * req, char *mime_type, long bytes);
extern void NutHttpSendHeaderBot(FILE * stream, char *mime_type, long bytes) NUT_DEPRECATED;
extern void NutHttpSendError(FILE * stream, REQUEST * req, int status);
extern char *NutGetMimeType(char *name);
extern void *NutGetMimeHandler(char *name);
extern uint8_t NutSetMimeHandler(char *extension, void (*handler)(FILE *stream, int fd, int file_len, char *http_root, REQUEST *req));

/*
 * Authorization
 */
typedef struct _AUTHINFO AUTHINFO;

struct _AUTHINFO {
    AUTHINFO *auth_next;    
    char *auth_dirname;     
    char *auth_login;       
};

extern int NutHttpAuthValidate(REQUEST * req);
extern int NutRegisterAuth(const char *dirname, const char *login);
extern void NutClearAuth(void);

/*
 * CGI
 */
typedef struct _CGIFUNCTION CGIFUNCTION;

struct _CGIFUNCTION {
    CGIFUNCTION *cgi_next;      
    char *cgi_name;             
    int (*cgi_func) (FILE *, REQUEST *);        
};

/* Function prototypes. */
extern void NutHttpSetOptionFlags(uint32_t flags);
extern uint32_t NutHttpGetOptionFlags(void);
extern int NutRegisterHttpRoot(char *path);
extern void NutRegisterCgiBinPath(char *path);
extern int NutRegisterCgi(char *name, int (*func) (FILE *, REQUEST *));
extern int NutCgiCheckRequest(FILE * stream, REQUEST * req);
extern void NutCgiProcessRequest(FILE * stream, REQUEST * req, int name_pos);
extern void NutHttpProcessPostQuery(FILE *stream, REQUEST * req);
extern char *NutHttpURLEncode(char *str);
extern void NutHttpURLDecode(char *str);
extern char *NutHttpGetParameter(REQUEST * req, char *name);
extern int NutHttpGetParameterCount(REQUEST * req);
extern char *NutHttpGetParameterName(REQUEST * req, int index);
extern char *NutHttpGetParameterValue(REQUEST * req, int index);

#endif