2011-05-10 00:21:10 +02:00
|
|
|
/****************************************************************************
|
2012-07-17 05:58:11 +02:00
|
|
|
* apps/include/netutils/httpd.h
|
2011-05-10 00:21:10 +02:00
|
|
|
*
|
2014-06-29 17:30:09 +02:00
|
|
|
* Copyright (C) 2007, 2009, 2011-2012, 2014 Gregory Nutt. All rights reserved.
|
2012-07-17 05:58:11 +02:00
|
|
|
* Author: Gregory Nutt <gnutt@nuttx.org>
|
2011-05-10 00:21:10 +02:00
|
|
|
*
|
|
|
|
* Based on uIP which also has a BSD style license:
|
|
|
|
*
|
|
|
|
* Author: Adam Dunkels <adam@sics.se>
|
|
|
|
* Copyright (c) 2001-2005, Adam Dunkels.
|
|
|
|
* 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. The name of the author may not be used to endorse or promote
|
|
|
|
* products derived from this software without specific prior
|
|
|
|
* written permission.
|
|
|
|
*
|
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
|
|
|
|
*
|
|
|
|
****************************************************************************/
|
|
|
|
|
2012-07-17 05:58:11 +02:00
|
|
|
#ifndef __APPS_INCLUDE_NETUTILS_HTTPD_H
|
|
|
|
#define __APPS_INCLUDE_NETUTILS_HTTPD_H
|
2011-05-10 00:21:10 +02:00
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Included Files
|
|
|
|
****************************************************************************/
|
|
|
|
|
2014-06-29 17:30:09 +02:00
|
|
|
#include <nuttx/net/tcp.h>
|
2012-09-01 01:05:51 +02:00
|
|
|
|
2012-09-22 22:38:43 +02:00
|
|
|
#include <stdint.h>
|
|
|
|
#include <stdbool.h>
|
2014-06-29 17:30:09 +02:00
|
|
|
#include <limits.h>
|
2012-09-22 22:38:43 +02:00
|
|
|
|
2011-05-10 00:21:10 +02:00
|
|
|
/****************************************************************************
|
2012-09-01 01:05:51 +02:00
|
|
|
* Pre-processor Definitions
|
2011-05-10 00:21:10 +02:00
|
|
|
****************************************************************************/
|
|
|
|
|
2012-09-01 01:05:51 +02:00
|
|
|
/* As threads are created to handle each request, a stack must be allocated
|
|
|
|
* for the thread. Use a default if the user provided no stacksize.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef CONFIG_NETUTILS_HTTPDSTACKSIZE
|
|
|
|
# define CONFIG_NETUTILS_HTTPDSTACKSIZE 4096
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#ifndef CONFIG_NETUTILS_HTTPDFSSTATS
|
|
|
|
# define CONFIG_NETUTILS_HTTPDFSSTATS
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#ifndef CONFIG_NETUTILS_HTTPDFILESTATS
|
|
|
|
# define CONFIG_NETUTILS_HTTPDFILESTATS
|
2012-07-17 05:58:11 +02:00
|
|
|
#endif
|
2011-05-10 00:21:10 +02:00
|
|
|
|
2012-09-01 01:05:51 +02:00
|
|
|
#ifndef CONFIG_NET_STATISTICS
|
|
|
|
# undef CONFIG_NETUTILS_HTTPDNETSTATS
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/* For efficiency reasons, the size of the IO buffer should be a multiple
|
|
|
|
* of the TCP MSS value. Also, the current design requires that the IO
|
|
|
|
* buffer be sufficiently large to contain the entire GET request.
|
2014-11-15 20:13:23 +01:00
|
|
|
*
|
|
|
|
* In the case where there are multiple network devices with different
|
|
|
|
* link layer protocols (CONFIG_NET_MULTILINK), each network device
|
|
|
|
* may support a different TCP MSS value. Here we arbitrarily select
|
|
|
|
* the minimum MSS for that case.
|
2012-09-01 01:05:51 +02:00
|
|
|
*/
|
|
|
|
|
2014-11-15 20:13:23 +01:00
|
|
|
#define HTTPD_IOBUFFER_SIZE (3*MIN_TCP_MSS)
|
2012-09-01 01:05:51 +02:00
|
|
|
|
2012-09-17 20:18:44 +02:00
|
|
|
/* This is the maximum size of a file path */
|
2012-09-01 01:05:51 +02:00
|
|
|
|
2014-06-29 17:30:09 +02:00
|
|
|
#ifndef CONFIG_NETUTILS_HTTPD_MAXPATH
|
|
|
|
# define CONFIG_NETUTILS_HTTPD_MAXPATH PATH_MAX
|
2012-09-17 20:18:44 +02:00
|
|
|
#endif
|
2012-09-01 01:05:51 +02:00
|
|
|
|
2014-07-03 16:12:45 +02:00
|
|
|
#define HTTPD_MAX_FILENAME CONFIG_NETUTILS_HTTPD_MAXPATH
|
2014-06-29 17:30:09 +02:00
|
|
|
|
|
|
|
/* Other tunable values. If you need to change these values, please create
|
|
|
|
* new configurations in apps/netutils/webserver/Kconfig
|
|
|
|
*/
|
|
|
|
|
2014-07-03 16:12:45 +02:00
|
|
|
#define HTTPD_MAX_CONTENTLEN 32
|
|
|
|
#define HTTPD_MAX_HEADERLEN 180
|
2014-06-29 17:30:09 +02:00
|
|
|
|
2012-09-01 01:05:51 +02:00
|
|
|
/****************************************************************************
|
|
|
|
* Public types
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
struct httpd_fs_file
|
|
|
|
{
|
|
|
|
char *data;
|
|
|
|
int len;
|
2012-09-17 20:18:44 +02:00
|
|
|
#if defined(CONFIG_NETUTILS_HTTPD_MMAP) || defined(CONFIG_NETUTILS_HTTPD_SENDFILE)
|
2012-09-04 18:59:24 +02:00
|
|
|
int fd;
|
|
|
|
#endif
|
2012-09-01 01:05:51 +02:00
|
|
|
};
|
|
|
|
|
|
|
|
struct httpd_state
|
|
|
|
{
|
2012-09-18 14:34:43 +02:00
|
|
|
char ht_buffer[HTTPD_IOBUFFER_SIZE]; /* recv() buffer */
|
2012-09-01 01:05:51 +02:00
|
|
|
char ht_filename[HTTPD_MAX_FILENAME]; /* filename from GET command */
|
2012-09-22 22:36:36 +02:00
|
|
|
#ifndef CONFIG_NETUTILS_HTTPD_KEEPALIVE_DISABLE
|
|
|
|
bool ht_keepalive; /* Connection: keep-alive */
|
|
|
|
#endif
|
2012-09-01 01:05:51 +02:00
|
|
|
struct httpd_fs_file ht_file; /* Fake file data to send */
|
|
|
|
int ht_sockfd; /* The socket descriptor from accept() */
|
|
|
|
char *ht_scriptptr;
|
|
|
|
uint16_t ht_scriptlen;
|
|
|
|
uint16_t ht_sndlen;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct httpd_fsdata_file
|
|
|
|
{
|
|
|
|
const struct httpd_fsdata_file *next;
|
|
|
|
FAR const uint8_t *name;
|
|
|
|
FAR const uint8_t *data;
|
|
|
|
int len;
|
|
|
|
#ifdef CONFIG_NETUTILS_HTTPDFSSTATS
|
|
|
|
uint16_t count;
|
|
|
|
#endif
|
|
|
|
};
|
|
|
|
|
|
|
|
struct httpd_fsdata_file_noconst
|
|
|
|
{
|
|
|
|
FAR struct httpd_fsdata_file *next;
|
|
|
|
FAR char *name;
|
|
|
|
FAR char *data;
|
|
|
|
int len;
|
|
|
|
#ifdef CONFIG_NETUTILS_HTTPDFSSTATS
|
|
|
|
uint16_t count;
|
|
|
|
#endif
|
|
|
|
};
|
|
|
|
|
|
|
|
typedef void (*httpd_cgifunction)(struct httpd_state *, char *);
|
|
|
|
|
|
|
|
struct httpd_cgi_call
|
|
|
|
{
|
|
|
|
struct httpd_cgi_call *next;
|
|
|
|
const char *name;
|
|
|
|
httpd_cgifunction function;
|
|
|
|
};
|
|
|
|
|
|
|
|
/* HTTPD CGI function declaration
|
|
|
|
*
|
|
|
|
* Description:
|
|
|
|
* This macro is used for declaring a HTTPD CGI function. This function is
|
|
|
|
* then added to the list of HTTPD CGI functions with the httpd_cgi_register()
|
|
|
|
* function.
|
2014-04-14 00:24:28 +02:00
|
|
|
|
2014-06-29 17:30:09 +02:00
|
|
|
* Input Parameters:
|
2012-09-01 01:05:51 +02:00
|
|
|
*
|
|
|
|
* name The C variable name of the function
|
|
|
|
* str The string name of the function, used in the script file
|
|
|
|
* function A pointer to the function that implements it
|
|
|
|
*/
|
|
|
|
|
|
|
|
#define HTTPD_CGI_CALL(name, str, function) \
|
|
|
|
static void function(struct httpd_state *, char *); \
|
|
|
|
static struct httpd_cgi_call name = {NULL, str, function}
|
|
|
|
|
2014-06-29 17:30:09 +02:00
|
|
|
/****************************************************************************
|
|
|
|
* Public Data
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
#ifdef __cplusplus
|
|
|
|
# define EXTERN extern "C"
|
|
|
|
extern "C"
|
|
|
|
{
|
|
|
|
#else
|
|
|
|
# define EXTERN extern
|
|
|
|
#endif
|
|
|
|
|
2016-07-11 21:05:55 +02:00
|
|
|
EXTERN const struct httpd_fsdata_file g_httpdfs_root[];
|
|
|
|
EXTERN const int g_httpd_numfiles;
|
|
|
|
|
2012-09-01 01:05:51 +02:00
|
|
|
/****************************************************************************
|
|
|
|
* Public Function Prototypes
|
|
|
|
****************************************************************************/
|
|
|
|
|
2014-06-29 17:30:09 +02:00
|
|
|
void httpd_init(void);
|
|
|
|
int httpd_listen(void);
|
|
|
|
void httpd_cgi_register(struct httpd_cgi_call *cgi_call);
|
|
|
|
uint16_t httpd_fs_count(char *name);
|
2012-09-01 01:05:51 +02:00
|
|
|
|
2012-07-17 05:58:11 +02:00
|
|
|
#undef EXTERN
|
|
|
|
#ifdef __cplusplus
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#endif /* __APPS_INCLUDE_NETUTILS_HTTPD_H */
|