NAME cgi_vredirect – send an HTTP 302 redirect response SYNOPSIS #include <cgi/cgi.h> void cgi_vredirect(CGI *cgi, int uri, const char *fmt, va_list ap); ARGUMENTS cgi – cgi struct uri – whether the URL is full (1) or path only (0) fmt – printf format string ap – stdarg va_list DESCRIPTION cgi_vredirect is mostly used internally, but…
NAME cgi_url_validate – validate that url is of an allowed format SYNOPSIS #include <cgi/cgi.h> NEOERR *cgi_url_validate(const char *buf, char **esc); ARGUMENTS buf – a 0 terminated string DESCRIPTION cgi_url_validate will check that a URL starts with one of the accepted safe schemes. If not, it returns "#" as a safe substitute. Currently accepted schemes are…
NAME cgi_url_unescape – unescape an url encoded string SYNOPSIS #include <cgi/cgi.h> char *cgi_url_unescape(char *buf); ARGUMENTS buf – a 0 terminated string DESCRIPTION cgi_url_unescape will do URL unescaping on the passed in string. This function modifies the string in place This function will decode any %XX character, and will decode + as space SEE ALSO cgi_debug_init(3),…
NAME cgi_url_escape_more – url escape a string SYNOPSIS #include <cgi/cgi.h> NEOERR *cgi_url_escape_more(const char *buf, char **esc, const char *other); ARGUMENTS buf – a 0 terminated string other – a 0 terminated string of characters to escape DESCRIPTION cgi_url_escape_more will do URL escaping on the passed in string, and return a newly allocated string that is…
NAME cgi_url_escape – url escape a string SYNOPSIS #include <cgi/cgi.h> NEOERR *cgi_url_escape(const char *buf, char **esc); ARGUMENTS buf – a 0 terminated string DESCRIPTION cgi_url_escape will do URL escaping on the passed in string, and return a newly allocated string that is escaped. Characters which are escaped include control characters, %, ?, +, space, =,…
NAME cgi_register_parse_cb – Register a parse callback SYNOPSIS #include <cgi/cgi.h> NEOERR *cgi_register_parse_cb(CGI *cgi, const char *method, const char *ctype, void *rock, CGI_PARSE_CB parse_cb); ARGUMENTS cgi – a CGI struct method – the HTTP method you want to handle, or * for all ctype – the HTTP Content-Type you want to handle, or * for all…
NAME cgi_redirect_uri – send an HTTP 302 redirect response SYNOPSIS #include <cgi/cgi.h> void cgi_redirect_uri(CGI *cgi, const char *fmt, …) ATTRIBUTE_PRINTF(2, 3); ARGUMENTS cgi – cgi struct fmt – printf style format with args DESCRIPTION cgi_redirect_uri will redirect the user to another page on your site. This version takes the full URL, including protocol/domain/port/path. As with…
NAME cgi_redirect – send an HTTP 302 redirect response SYNOPSIS #include <cgi/cgi.h> void cgi_redirect(CGI *cgi, const char *fmt, …) ATTRIBUTE_PRINTF(2, 3); ARGUMENTS cgi – cgi struct fmt – printf style format with args DESCRIPTION cgi_redirect will redirect the user to another page on your site. This version takes only the path portion of the URL….
NAME cgi_parse – Parse incoming CGI data SYNOPSIS #include <cgi/cgi.h> NEOERR *cgi_parse (CGI *cgi); ARGUMENTS cgi – a pointer to a CGI pointer DESCRIPTION We split cgi_init into two sections, one that parses just the basics, and the second is cgi_parse. cgi_parse is responsible for parsing the entity body of the HTTP request. This payload…
NAME cgi_output – display the CGI output to the user SYNOPSIS #include <cgi/cgi.h> NEOERR *cgi_output (CGI *cgi, STRING *output); ARGUMENTS cgi – a pointer a CGI struct allocated with cgi_init output – the data to send to output from the CGI DESCRIPTION Normally, this is called by cgi_display, but some people wanted it external so…
NAME cgi_neo_error – display a NEOERR call backtrace SYNOPSIS #include <cgi/cgi.h> void cgi_neo_error(CGI *cgi, NEOERR *err); ARGUMENTS cgi – a pointer to a CGI struct err – a NEOERR (see util/neo_err.h for details) DESCRIPTION cgi_neo_error will output a 500 error containing the NEOERR call backtrace. This function is likely to be removed from future versions…
NAME cgi_init – Initialize ClearSilver CGI environment SYNOPSIS #include <cgi/cgi.h> NEOERR *cgi_init (CGI **cgi, HDF *hdf); ARGUMENTS cgi – a pointer to a CGI pointer hdf_file – the path to an HDF data set file that will also be loaded into the dataset. This will likely have to a be a full path, as the…
NAME cgi_filehandle – return a file pointer to an uploaded file SYNOPSIS #include <cgi/cgi.h> FILE *cgi_filehandle(CGI *cgi, const char *form_name); ARGUMENTS cgi – a pointer to a CGI struct allocated with cgi_init form_name – the form name that the file was uploaded as (not the filename) (if NULL, we’re asking for the file handle for…
NAME cgi_error – display an error string to the user SYNOPSIS #include <cgi/cgi.h> void cgi_error(CGI *cgi, const char *fmt, …) ATTRIBUTE_PRINTF(2, 3); ARGUMENTS cgi – a pointer to a CGI struct fmt – printf style format string and arguments DESCRIPTION cgi_error will output a 500 error containing the specified error message. This function is likely…
NAME cgi_display – render and display the CGI output to the user SYNOPSIS #include <cgi/cgi.h> NEOERR *cgi_display(CGI *cgi, const char *cs_file); ARGUMENTS cgi – a pointer a CGI struct allocated with cgi_init cs_file – a ClearSilver template file DESCRIPTION cgi_display will render the CS template pointed to by cs_file using the CGI’s HDF data set,…
NAME cgi_destroy – deallocate the data associated with a CGI SYNOPSIS #include <cgi/cgi.h> void cgi_destroy(CGI **cgi); ARGUMENTS cgi – a pointer to a pointer to a CGI struct DESCRIPTION cgi_destroy will destroy all the data associated with a CGI, which mostly means the associated HDF and removal of any files that were uploaded via multipart/form-data….
NAME cgi_debug_init – initialize standalone debugging SYNOPSIS #include <cgi/cgi.h> void cgi_debug_init(int argc, char **argv); ARGUMENTS argc/argv – the arguments from main DESCRIPTION cgi_debug_init initializes a CGI program for standalone debugging. By running a ClearSilver CGI program with a filename on the command line as the first argument, the CGI program will load that file of…
NAME cgi_cs_init – initialize CS parser with the CGI defaults SYNOPSIS #include <cgi/cgi.h> NEOERR *cgi_cs_init(CGI *cgi, CSPARSE **cs); ARGUMENTS cgi – a pointer a CGI struct allocated with cgi_init cs – a pointer to a CS struct pointer DESCRIPTION cgi_cs_init initializes a CS parser with the CGI HDF context, and registers the standard CGI filters…
NAME cgi_cookie_set – Set a browser Cookie SYNOPSIS #include <cgi/cgi.h> NEOERR *cgi_cookie_set(CGI *cgi, const char *name, const char *value, const char *path, const char *domain, const char *time_str, int persistent, int secure); ARGUMENTS cgi – a CGI struct name – the name of the cookie value – the value to set the cookie to. path…
NAME cgi_cookie_clear – clear browser cookie SYNOPSIS #include <cgi/cgi.h> NEOERR *cgi_cookie_clear(CGI *cgi, const char *name, const char *domain, const char *path); ARGUMENTS cgi – a CGI struct name – the cookie name to clear domain – the domain to clear, NULL for none path – the cookie’s path DESCRIPTION cgi_cookie_clear will send back a Set-Cookie…