2 cgi.h - Routines for CGI programming
3 Copyright (c) 1996-8,2007 Martin Schulze <joey@infodrom.org>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
23 typedef struct var_s {
28 typedef struct cookie_s {
36 typedef struct file_s {
43 typedef struct cgi_s {
51 * Sets additional HTTP header lines to be printed with cgiHeader
53 int cgiSetHeader (char *name, char *value);
57 * Sets result type for HTTP
59 int cgiSetType (char *type);
63 * Prints a valid CGI Header (Content-type...) etc.
69 * Set/unsets debugging
71 void cgiDebug (int level, int where);
75 * Reads in variables set via POST or stdin, reads HTTP Cookies.
81 * Returns the value of the specified variable or NULL if it's empty
84 char *cgiGetValue (s_cgi *parms, const char *name);
88 * Returns the names of all form variables.
90 char **cgiGetVariables (s_cgi *parms);
94 * Provides a valid redirect for web pages.
96 void cgiRedirect (const char *url);
100 * Returns the cookie referenced by the given name or NULL if it
101 * doesn't exist or is empty.
103 s_cookie *cgiGetCookie (s_cgi *parms, const char *name);
107 * Returns a list of names of all cookies.
109 char **cgiGetCookies (s_cgi *parms);
113 * Returns a list of names of all files.
115 char **cgiGetFiles (s_cgi *parms);
119 * Return data structure for CGI file variable
121 s_file *cgiGetFile (s_cgi *parms, const char *name);
125 * Frees a list as returned by cgiGetVariables() and cgiGetCookies()
127 void cgiFreeList (char **list);
131 * Frees the internal data structures
133 void cgiFree (s_cgi *parms);
137 * Escapes <&> in a string
139 char *cgiEscape (char *string);