HTTPsimple.c

HTTPsimple.c example details
HTTP Server description

/***************************************************************************//**
@file HTTPsimple.c
@brief simple HTTP server example
@verbatim
_ _ _
__| | ___(_) ____ _ __ | |_
/ _` | / __| |/ _` | '_ \| __|
| (_| | _ \__ \ | (_| | | | | |_
\__,_|(_) ___/_|\__, |_| |_|\__|
Signalprocessing |___/ Technology
@endverbatim
@author D.SignT GmbH & Co. KG, Claus Hermbusche
@date 2019-06-03
@anchor HTTPSIMPLE
@details
This program installs a HTTP server (port 80) with either fix IP 192.168.168.200
(configurable in netconfig.c) or DHCP assigned address (e.g. 192.168.168.143,
host name mydemo).
To verify this program, first 'ping' the DSP:
>ping 192.168.168.200
or, if configured for DHCP
>ping mydemo
If the settings and network connections are correct, the pings will be
replied.
To see the web page type in your browser:
>http://192.168.168.200/index.htm
or, if configured for DHCP
>http://mydemo/index.htm
All pages and messages are hard-coded via c-variables into the code, but
can also be loaded from internal flash.
@cond Software License Agreement
Copyright (C) 2001-2019 D.SignT GmbH & Co. KG - http://www.dsignt.de
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
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.
Neither the name of D.SignT GmbH & Co. KG nor the names of its
contributors may be used to endorse or promote products derived
from this software without specific prior written permission.
Disclaimer
THIS SOFTWARE IS PROVIDED BY D.SIGNT GMBH & CO. KG "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 D.SIGNT GMBH & CO. KG 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.
@endcond
*******************************************************************************/
/*******************************************************************************
include stdtypes.h to avoid data type mismatch
*******************************************************************************/
#include <BoardSupport/inc/stdtypes.h>
/*******************************************************************************
include Runtime Source
*******************************************************************************/
#include <stdlib.h>
#include <stdio.h>
#include <stddef.h>
#include <inttypes.h>
#include <time.h>
#include <string.h>
/*******************************************************************************
network support functions
*******************************************************************************/
#include <Libs/NETlib/net.h> /* D.Module network support */
#include <Libs/NETlib/httplib.h> /* HTTP support */
/*******************************************************************************
board specific functions
*******************************************************************************/
#include <BoardSupport/inc/BoardSpecific.h> /* board support functions */
/*******************************************************************************
common support functions
*******************************************************************************/
#include <Common/Common.h> /* on exit function */
#include <Common/uartio.h> /* UART support */
#include <Common/timer.h> /* timer setting */
#include <Common/CPrintf.h> /* CPrintf defines */
/*******************************************************************************
network configuration
*******************************************************************************/
#include <BoardSupport/config/netconfig.c> /* network configuration */
#include ".\webpage\webpage.c" /* generated webpage */
#ifdef __cplusplus
extern "C" {
#endif /* !__cplusplus */
/*******************************************************************************
local prototypes
*******************************************************************************/
#pragma CODE_SECTION(http_interpreter , ".commontext");
int32_t http_interpreter (httpserv_type *http_server);
#ifdef __cplusplus
} // extern "C"
#endif
/*******************************************************************************
* *
* DEFINES *
* *
*******************************************************************************/
/*******************************************************************************
* *
* GLOBALS *
* *
*******************************************************************************/
/*******************************************************************************
program name
*******************************************************************************/
char *program_name = "HTTP-server";
/*******************************************************************************
authentication key for secure webpage is Username:Password (case sensitive)
*******************************************************************************/
char *authentication_key = "Albert:Einstein";
/*******************************************************************************
direntry_type: used for creating a directory entry:
direntry_type dir1 = { dir, file, length, access, type, flash/ram address };
The maximum dir and file length is 60 characters. Blanks are not allowed.
*******************************************************************************/
#include ".\webpage\webpage.gen" /* generated page list */
/*******************************************************************************
* *
* FUNCTIONS *
* *
*******************************************************************************/
/*******************************************************************************
@brief user defined callback function; called each time a web page is
requested or data is received.
@param http_server - current http server connection
@return _HTTP_CLOSE_CONNECTION - close connection
@return _HTTP_KEEP_ALIVE - keep alive
@sa http_send_user_page() - http.lib
*******************************************************************************/
int32_t http_interpreter (httpserv_type *http_server)
{
/***************************************************************************
locals
***************************************************************************/
int32_t ret = _HTTP_CLOSE_CONNECTION;
/***************************************************************************
Execute specific method
***************************************************************************/
switch (http_server-> method)
{
case _HTTP_GET:
/*******************************************************************
the value of uri corresponds to the sequence of specified
directories
uri =
0 - INDEX_PAGE dir1
1 - SYNTAX_ERROR_MSG dir2
2 - NOT_FOUND_MSG dir3
3 - NOT_IMPLEMENTED_MSG dir4
4 - TEST_PAGE dir5
-1 - page not found
*******************************************************************/
if ( http_server-> uri == INT32_C(-1) )
{
/***************************************************************
uri not found: send user defined not-found-message
***************************************************************/
http_send_uri (http_server, &e404);
}
else
{
/***************************************************************
send the requested page
***************************************************************/
if ( http_send_user_page (http_server,
user,
http_server-> uri ) <= INT32_C(0))
{
/***********************************************************
page could not be sent immediately, keep connection alive
and try again later
***********************************************************/
ret = _HTTP_KEEP_ALIVE;
}
}
break;
case _HTTP_UNKNOWN : /* unknown method */
/*******************************************************************
method not implemented or syntax error
*******************************************************************/
http_send_uri (http_server, &e501);
break;
}
/***************************************************************************
back to http server
***************************************************************************/
return (ret);
}
/*******************************************************************************
@brief Main application
@param -
@return never
*******************************************************************************/
#pragma CODE_SECTION(main , ".commontext");
int main ( void )
{
/***************************************************************************
locals
***************************************************************************/
int main_loop = 1; /* main loop switch, set to 0 to exit */
volatile int32_t http_serv;
timeval stamp1, stamp2, delta; /* used to determine startup time */
/***************************************************************************
initialize application (e.g. timer clocks, PLL settings, EMIF etc.)
(ref. \Common\Common.c)
***************************************************************************/
AppInit (GET_CLOCK);
/***************************************************************************
select output device for CPrintf (ref. \Common\cprintf.c)
possible settings:
CPRINTF_UART_OUTPUT -> output to UART
CPRINTF_CCS_OUTPUT -> output to CCS
CPRINTF_UART_OUTPUT | CPRINTF_CCS_OUTPUT -> output to UART and CCS
***************************************************************************/
CPrintf_select_output (CPRINTF_DEFAULT_OUTPUT); /* default outputs */
/***************************************************************************
print a start up message
***************************************************************************/
START_UP_MESSAGE (BLANK_REV NETLIB_REV);
/**************************************************************************/
// CPrintfProgress (" Heap check ");
// at least 0x10000 bytes required for this app
/**************************************************************************/
ASSERT_HEAP (initial_heap_size, 0x10000);
// CPrintfProgressSuccess();
/**************************************************************************/
CPrintfProgress (" Setup system time ");
// 1 milli seconds resolution
/**************************************************************************/
SetupSystemTime ( SYSTEM_TIMER_INT, SYSTEM_TIMER, RES_MSECONDS);
CPrintfProgressSuccess();
CPrintf (" *** timer %d mapped to CPU int %d ***\r\n",
SystemTimerDev, SYSTEM_TIMER_INT);
/**************************************************************************/
CPrintfProgress (" Enable interrupts ");
/**************************************************************************/
BoardEnableInterrupts();
CPrintfProgressSuccess();
/**************************************************************************/
CPrintfProgress (" Start system timer ");
/**************************************************************************/
StartSystemTimer ();
CPrintfProgressSuccess();
CPrintf (" *** timer %d running at %"PRId32" Hz ***\r\n", SystemTimerDev, RES_SECONDS/GetSystemTimerRes());
/***************************************************************************
measure network initialization time
***************************************************************************/
stamp1 = GetTimeStamp();
/**************************************************************************/
CPrintfProgress (" Initialize network ");
/**************************************************************************/
InitializeNetwork ( 64); // 64 bytes for ping
/***************************************************************************
initialize http server; parameter is the specified user list
***************************************************************************/
http_serv = http_server_init ( user, /* specified user list */
NULL, /* mmc not supported */
HTTP_NO_LIMIT); /* max parallel connections */
/* 0 == no limit (heap limit only) */
if ( http_serv == FALSE )
{
prg_exit ("http_server_init() failed"); /* possibly insufficient heap */
}
/***************************************************************************
define user callback function
***************************************************************************/
http_define_callback ( http_interpreter);
/***************************************************************************
set the authentication for the secure page
authentication key is Username:Password (case sensitive)
***************************************************************************/
http_set_authentication ("Secure Webpage", authentication_key,
&e401, &secure, EFS_TERMINATION, EFS_TERMINATION);
CPrintfProgressSuccess();
stamp2 = GetTimeStamp();
tv_interval (&delta, &stamp1, &stamp2);
CPuts (" network startup time [sec]: ");
CPrintf (VT100_RED
"%"PRId32".%03"PRId32"\r\n"
VT100_DEFAULT,
delta.tv_sec,
delta.tv_usec/1000);
CPrintf (" secure webpage account is\r\n %s (Username:Password, case sensitive)\r\n ", authentication_key);
/***************************************************************************
main program loop: set main_loop to 0 to exit loop
***************************************************************************/
CPuts ("\r\n Entering main loop ...");
while ( main_loop )
{
/***********************************************************************
process net_isq()
***********************************************************************/
net_isq (); // process ISQ
/***********************************************************************
monitor link status
***********************************************************************/
monitor_link_status (CPrintf);
/***********************************************************************
try to detect IP assignment
if DHCP is used, the assigned IP address may change
***********************************************************************/
monitor_ip_address (CPrintf);
/***********************************************************************
call http_server()
***********************************************************************/
http_server ();
/***********************************************************************
show that the program is running, perform symbol animation
***********************************************************************/
CPrintAnimatedSymbol ( sym_animate, 200000, ANIMATE_SYMBOLS_COUNT);
}
/***************************************************************************
exit program, shut down peripherals
***************************************************************************/
return (0);
}