web.h

Go to the documentation of this file.

#ifndef __WEB_H__
#define __WEB_H__

typedef struct espconn espconn_t;

// WEB CONNECTIONS
#ifndef MAX_CONNECTIONS
    #define MAX_CONNECTIONS 1
#endif

// =======================================================
// HTML HEADER information
typedef struct {
// GET /LEDCTL.CGI?led2=on&led3=on HTTP/1.1
// TOKEN_GET,TOKEN_POST,TOKEN_HEAD
    int type;
    char *filename;
    char *arg_ptr;
    char *args;
    uint16_t args_length;
    char *html_encoding;
    char *connection;
// POST msg_pointers
// Content-Type: application/x-www-form-urlencoded
// Content-Length: 165
    char *content_type;
    uint16_t content_length;
// Follows msg headers
    char *msg;
} hinfo_t;

// =======================================================
// Memory buffering for socket reads
typedef struct {
    char *ptr;  // Current line
    char *next; // Next line
    int size;   // memory size
} mem_t;

// =======================================================
// Memory buffering for socket writes
#define IO_MAX 512  // buffered IO

// HTTP headers from the client
enum {
    TOKEN_GET,
    TOKEN_PUT,
    TOKEN_POST,
    TOKEN_HEAD,
    TOKEN_HOST,
    TOKEN_USER_AGENT,
    TOKEN_HTTPS,
    TOKEN_DNT,
    TOKEN_ACCEPT,
    TOKEN_ACCEPT_LANGUAGE,
    TOKEN_ACCEPT_ENCODING,
    TOKEN_CONNECTION,
    TOKEN_REFERER,
    TOKEN_CONTENT_LENGTH,
    TOKEN_CONTENT_TYPE,
    TOKEN_CACHE_CONTROL,
};


typedef struct {
    char *pattern;
    int type;
} header_t;

//HTTP code descriptions from
//  HTTP Status Codes for Beginners
//  All valid HTTP 1.1 Status Codes simply explained.
//  This article is part of the For Beginners series.
//  http://www.addedbytes.com/for-beginners/"},
// Web Server Status Codes
enum {
    STATUS_OK=200,
    STATUS_CREATED=201,
    STATUS_ACCEPTED=202,
    STATUS_NO_CONTENT=204,
    STATUS_MV_PERM=301,
    STATUS_MV_TEMP=302,
    STATUS_NOT_MODIF=304,
    STATUS_BAD_REQ=400,
    STATUS_UNAUTH=401,
    STATUS_FORBIDDEN=403,
    STATUS_NOT_FOUND=404,
    STATUS_INT_SERR=500,
    STATUS_NOT_IMPL=501,
    STATUS_BAD_GATEWAY=502,
    STATUS_SERV_UNAVAIL=503
};

enum {
    PTYPE_TEXT,
    PTYPE_HTML,
    PTYPE_PDF,
    PTYPE_CSS,
    PTYPE_CGI,
    PTYPE_JS,
    PTYPE_XML,
    PTYPE_ICO,
    PTYPE_GIF,
    PTYPE_JPEG,
    PTYPE_MPEG,
    PTYPE_FLASH,
    PTYPE_ERR
};

typedef struct {
    uint8_t type;
    char *mime;
    char *ext1;
    char *ext2;
} mime_t;


// =======================================================
typedef struct {
    espconn_t *conn;

    char *rbuf;
    int received;   // bytes creived
    int rind;       // index into rbuf
    int rsize;      // bytes allocated

    char *wbuf;
    int send;       // bytes to send
    int wind;       // index into wbuf
    int wsize;      // bytes allocated

    uint8_t remote_ip[4];
    uint8_t local_ip[4];
    int remote_port;
    int local_port;

    int delete;     // close connection
} rwbuf_t;


// ============================================================
/* web.c */
MEMSPACE void web_sep ( void );
MEMSPACE int wait_send ( rwbuf_t *p );
MEMSPACE int write_buffer ( rwbuf_t *p );
MEMSPACE int write_flush ( rwbuf_t *p );
MEMSPACE int write_byte ( rwbuf_t *p , int c );
MEMSPACE void led_on ( int led );
MEMSPACE void led_off ( int led );
MEMSPACE void rwbuf_rinit ( rwbuf_t *p );
MEMSPACE void rwbuf_winit ( rwbuf_t *p );
MEMSPACE void display_ipv4 ( char *msg , uint8_t *ip , int port );
MEMSPACE void rwbuf_delete ( rwbuf_t *p );
MEMSPACE rwbuf_t *rwbuf_create ( void );
MEMSPACE rwbuf_t *find_connection ( espconn_t *conn , int *index , char *msg );
MEMSPACE rwbuf_t *create_connection ( espconn_t *conn );
MEMSPACE int delete_connection ( rwbuf_t *p );
MEMSPACE void write_len ( rwbuf_t *p , char *str , int len );
MEMSPACE void write_str ( rwbuf_t *p , char *str );
MEMSPACE int vsock_printf ( rwbuf_t *p , const char *fmt , va_list va );
MEMSPACE int sock_printf ( rwbuf_t *p , const char *fmt , ...);
MEMSPACE int html_msg ( rwbuf_t *p , int status , char type , char *fmt , ...);
MEMSPACE char *meminit ( mem_t *p , char *ptr , int size );
MEMSPACE char *memgets ( mem_t *p );
MEMSPACE char *mime_type ( int type );
MEMSPACE int file_type ( char *name );
MEMSPACE char *html_status ( int status );
MEMSPACE void init_hinfo ( hinfo_t *hi );
MEMSPACE int match_headers ( char *str , char **p );
MEMSPACE char *process_args ( hinfo_t *hi , char *ptr );
MEMSPACE char *first_arg ( hinfo_t *hi );
MEMSPACE char *next_arg ( hinfo_t *hi );
MEMSPACE char *arg_name ( hinfo_t *hi );
MEMSPACE char *arg_value ( hinfo_t *hi );
MEMSPACE char *http_value ( hinfo_t *hi , char *str );
MEMSPACE int is_header ( char *str , char **p );
MEMSPACE char *nextbreak ( char *ptr );
MEMSPACE void u5toa ( char *ptr , uint16_t num );
MEMSPACE void html_head ( rwbuf_t *p , int status , char type , int len );
MEMSPACE int parse_http_request ( rwbuf_t *p , hinfo_t *hi );
MEMSPACE int is_cgitoken_char ( int c );
MEMSPACE int find_cgitoken_start ( char *str );
MEMSPACE int is_cgitoken ( char *str );
MEMSPACE int rewrite_cgi_token ( rwbuf_t *p , char *src );
MEMSPACE void web_task ( void );
MEMSPACE void web_init_connections ( void );
MEMSPACE void web_init ( int port );


// ============================================================


#endif  /* end of __WEB_H__ */