fnet_http_srv.h

/**************************************************************************
*
* Copyright 2008-2018 by Andrey Butok. FNET Community.
*
***************************************************************************
*
*  Licensed under the Apache License, Version 2.0 (the "License"); you may
*  not use this file except in compliance with the License.
*  You may obtain a copy of the License at
*
*  http://www.apache.org/licenses/LICENSE-2.0
*
*  Unless required by applicable law or agreed to in writing, software
*  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
*  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*  See the License for the specific language governing permissions and
*  limitations under the License.
*
***************************************************************************
*
*  FNET HTTP Server API.
*
***************************************************************************/

#ifndef _FNET_HTTP_SRV_H_

#define _FNET_HTTP_SRV_H_

#if FNET_CFG_HTTP_SRV || defined(__DOXYGEN__)

#include "fnet_http_srv_auth.h"

/**************************************************************************/ 
#if FNET_CFG_HTTP_SRV_VERSION_MAJOR /*HTTP/1.x*/
    #define FNET_HTTP_SRV_VERSION_MAJOR     (1u)
#else   /*HTTP/0.9*/
    #define FNET_HTTP_SRV_VERSION_MAJOR     (0u)
#endif

/**************************************************************************/ 
#if FNET_CFG_HTTP_SRV_VERSION_MAJOR /* HTTP/1.x*/
    #define FNET_HTTP_SRV_VERSION_MINOR     (0u)
#else   /*HTTP/0.9*/
    #define FNET_HTTP_SRV_VERSION_MINOR     (9u)
#endif


#if FNET_CFG_HTTP_SRV_VERSION_MAJOR /* HTTP/1.x*/ || defined(__DOXYGEN__)

/********************************************************************/ 
typedef enum
{
    FNET_HTTP_SRV_STATUS_CODE_NONE                  = 0,    
    FNET_HTTP_SRV_STATUS_CODE_OK                    = 200,  
    FNET_HTTP_SRV_STATUS_CODE_CREATED               = 201,  
    FNET_HTTP_SRV_STATUS_CODE_ACCEPTED              = 202,  
    FNET_HTTP_SRV_STATUS_CODE_NO_CONTENT            = 204,  
    FNET_HTTP_SRV_STATUS_CODE_MOVED_PERMANENTLY     = 301,  
    FNET_HTTP_SRV_STATUS_CODE_MOVED_TEMPORARILY     = 302,  
    FNET_HTTP_SRV_STATUS_CODE_NOT_MODIFIED          = 304,  
    FNET_HTTP_SRV_STATUS_CODE_BAD_REQUEST           = 400,  
    FNET_HTTP_SRV_STATUS_CODE_UNAUTHORIZED          = 401,  
    FNET_HTTP_SRV_STATUS_CODE_FORBIDDEN             = 403,  
    FNET_HTTP_SRV_STATUS_CODE_NOT_FOUND             = 404,  
    FNET_HTTP_SRV_STATUS_CODE_INTERNAL_SERVER_ERROR = 500,  
    FNET_HTTP_SRV_STATUS_CODE_NOT_IMPLEMENTED       = 501,  
    FNET_HTTP_SRV_STATUS_CODE_BAD_GATEWAY           = 502,  
    FNET_HTTP_SRV_STATUS_CODE_SERVICE_UNAVAILABLE   = 503   
} fnet_http_srv_status_code_t;
#endif

#if (FNET_CFG_HTTP_SRV_TLS && FNET_CFG_TLS) || defined(__DOXYGEN__)
/**************************************************************************/ 
typedef struct
{
    const fnet_uint8_t  *certificate_buffer;        
    fnet_size_t         certificate_buffer_size;    
    const fnet_uint8_t  *private_key_buffer;        
    fnet_size_t         private_key_buffer_size;    
} fnet_http_srv_tls_params_t;
#endif

/**************************************************************************/ 
typedef fnet_int32_t fnet_http_srv_desc_t;

/**************************************************************************/ 
typedef fnet_int32_t fnet_http_srv_session_t;

#include "fnet_http_srv_ssi.h"
#include "fnet_http_srv_cgi.h"
#include "fnet_http_srv_post.h"

/**************************************************************************/ 
typedef struct
{
    fnet_char_t *root_path;                     
    fnet_char_t *index_path;                    
    struct fnet_sockaddr address;               
#if FNET_CFG_HTTP_SRV_SSI || defined(__DOXYGEN__)
    const fnet_http_srv_ssi_t *ssi_table;      
#endif
#if FNET_CFG_HTTP_SRV_CGI || defined(__DOXYGEN__)
    const fnet_http_srv_cgi_t *cgi_table;      
#endif
#if (FNET_CFG_HTTP_SRV_AUTHENTICATION_BASIC && FNET_CFG_HTTP_SRV_VERSION_MAJOR) || defined(__DOXYGEN__)
    const fnet_http_srv_auth_t      *auth_table;   
#endif
#if (FNET_CFG_HTTP_SRV_POST && FNET_CFG_HTTP_SRV_VERSION_MAJOR) || defined(__DOXYGEN__)
    const fnet_http_srv_post_t *post_table;    
#endif
#if (FNET_CFG_HTTP_SRV_TLS && FNET_CFG_TLS) || defined(__DOXYGEN__)
    fnet_http_srv_tls_params_t *tls_params;    
#endif
} fnet_http_srv_params_t;

#if defined(__cplusplus)
extern "C" {
#endif

/***************************************************************************/ 
fnet_http_srv_desc_t fnet_http_srv_init( fnet_http_srv_params_t *params);

/***************************************************************************/ 
void fnet_http_srv_release(fnet_http_srv_desc_t desc);

/***************************************************************************/ 
fnet_bool_t fnet_http_srv_is_enabled(fnet_http_srv_desc_t desc);

/***************************************************************************/ 
void fnet_http_srv_query_unencode(fnet_uint8_t *dest, fnet_uint8_t *src);

#if FNET_CFG_HTTP_SRV_VERSION_MAJOR /* HTTP/1.x*/ || defined(__DOXYGEN__)

/**************************************************************************/ 
void fnet_http_srv_set_response_status_code (fnet_http_srv_session_t session, fnet_http_srv_status_code_t status_code);

/**************************************************************************/ 
void fnet_http_srv_set_response_content_length (fnet_http_srv_session_t session, fnet_size_t content_length);

/**************************************************************************/ 
void fnet_http_srv_set_response_no_header (fnet_http_srv_session_t session);

#endif

#if defined(__cplusplus)
}
#endif

#endif /* FNET_CFG_HTTP_SRV */

#endif