Section 3: library functions
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);Argumentsbuf – a 0 terminated string Descriptioncgi_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 http, https, ftp and mailto….
cgi_url_unescape – unescape an url encoded string Synopsis#include <cgi/cgi.h>char *cgi_url_unescape (char *buf);Argumentsbuf – a 0 terminated string Descriptioncgi_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 Alsocgi_debug_init(3), cgi_parse(3), cgi_destroy(3), cgi_js_escape(3), cgi_html_escape_strfunc(3), cgi_register_strfuncs(3), cgi_output(3),…
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);Argumentsbuf – a 0 terminated string other – a 0 terminated string of characters to escape Descriptioncgi_url_escape_more will do URL escaping on the passed in string, and return a newly allocated string that is escaped. Characters which are escaped…
cgi_url_escape – url escape a string Synopsis#include <cgi/cgi.h>NEOERR *cgi_url_escape (const char *buf, char **esc);Argumentsbuf – a 0 terminated string Descriptioncgi_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, =, &, /, and " Return…
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);Argumentscgi – 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 rock – opaque data that…
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);Argumentscgi – cgi struct fmt – printf style format with args Descriptioncgi_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 all printf style commands, you should…
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);Argumentscgi – cgi struct fmt – printf style format with args Descriptioncgi_redirect will redirect the user to another page on your site. This version takes only the path portion of the URL. As with all printf style commands,…
cgi_parse – Parse incoming CGI data Synopsis#include <cgi/cgi.h>NEOERR *cgi_parse (CGI *cgi);Argumentscgi – a pointer to a CGI pointer DescriptionWe 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 is typically only sent (expected) on…
cgi_output – display the CGI output to the user Synopsis#include <cgi/cgi.h>NEOERR *cgi_output (CGI *cgi, STRING *output);Argumentscgi – a pointer a CGI struct allocated with cgi_init output – the data to send to output from the CGI DescriptionNormally, this is called by cgi_display, but some people wanted it external so they could call it directly. Return…
cgi_neo_error – display a NEOERR call backtrace Synopsis#include <cgi/cgi.h>void cgi_neo_error (CGI *cgi, NEOERR *err);Argumentscgi – a pointer to a CGI struct err – a NEOERR (see util/neo_err.h for details) Descriptioncgi_neo_error will output a 500 error containing the NEOERR call backtrace. This function is likely to be removed from future versions in favor of some sort…
cgi_init – Initialize ClearSilver CGI environment Synopsis#include <cgi/cgi.h>NEOERR *cgi_init (CGI **cgi, HDF *hdf);Argumentscgi – 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 HDF search paths are not…
cgi_filehandle – return a file pointer to an uploaded file Synopsis#include <cgi/cgi.h>FILE *cgi_filehandle (CGI *cgi, const char *form_name);Argumentscgi – 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 the PUT upload) Descriptioncgi_filehandle…
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);Argumentscgi – a pointer to a CGI struct fmt – printf style format string and arguments Descriptioncgi_error will output a 500 error containing the specified error message. This function is likely to be removed from future versions…
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);Argumentscgi – a pointer a CGI struct allocated with cgi_init cs_file – a ClearSilver template file Descriptioncgi_display will render the CS template pointed to by cs_file using the CGI’s HDF data set, and send the output to…
cgi_destroy – deallocate the data associated with a CGI Synopsis#include <cgi/cgi.h>void cgi_destroy (CGI **cgi);Argumentscgi – a pointer to a pointer to a CGI struct Descriptioncgi_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. (Note that even in the…
cgi_debug_init – initialize standalone debugging Synopsis#include <cgi/cgi.h>void cgi_debug_init (int argc, char **argv);Argumentsargc/argv – the arguments from main Descriptioncgi_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 the form K=V as a…
cgi_cs_init – initialize CS parser with the CGI defaults Synopsis#include <cgi/cgi.h>NEOERR *cgi_cs_init(CGI *cgi, CSPARSE **cs);Argumentscgi – a pointer a CGI struct allocated with cgi_init cs – a pointer to a CS struct pointer Descriptioncgi_cs_init initializes a CS parser with the CGI HDF context, and registers the standard CGI filters Return Valuecs – the allocated/initialized CS…
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);Argumentscgi – a CGI struct name – the name of the cookie value – the value to set the cookie to. path – optional path for…
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);Argumentscgi – a CGI struct name – the cookie name to clear domain – the domain to clear, NULL for none path – the cookie’s path Descriptioncgi_cookie_clear will send back a Set-Cookie string that will attempt to…
cgi_cookie_authority – determine the cookie authority for a domain Synopsis#include <cgi/cgi.h>char *cgi_cookie_authority (CGI *cgi, const char *host);Argumentscgi – a CGI struct host – optional host to match against. If NULL, the function will use the HTTP.Host HDF variable. Descriptioncgi_cookie_authority will walk the CookieAuthority portion of the CGI HDF data set, and return the matching domain…