[thirdparty/cups.git] / cgi-bin / cgi.h

/*
 * "$Id: cgi.h 4931 2006-01-14 20:37:40Z mike $"
 *
 *   CGI support library definitions.
 *
 *   Copyright 1997-2006 by Easy Software Products.
 *
 *   These coded instructions, statements, and computer programs are the
 *   property of Easy Software Products and are protected by Federal
 *   copyright law.  Distribution and use rights are outlined in the file
 *   "LICENSE.txt" which should have been included with this file.  If this
 *   file is missing or damaged please contact Easy Software Products
 *   at:
 *
 *       Attn: CUPS Licensing Information
 *       Easy Software Products
 *       44141 Airport View Drive, Suite 204
 *       Hollywood, Maryland 20636 USA
 *
 *       Voice: (301) 373-9600
 *       EMail: cups-info@cups.org
 *         WWW: http://www.cups.org
 */

#ifndef _CUPS_CGI_H_
#  define _CUPS_CGI_H_

#  include <stdio.h>
#  include <stdlib.h>
#  include <time.h>
#  include <sys/stat.h>

#  ifdef WIN32
#    include <direct.h>
#    include <io.h>
#  else
#    include <unistd.h>
#  endif /* WIN32 */

#  include <cups/cups.h>
#  include <cups/array.h>
#  include "help-index.h"


/*
 * Types...
 */

typedef struct cgi_file_s		/**** Uploaded file data ****/
{
  char		tempfile[1024],		/* Temporary file containing data */
		*name,			/* Variable name */
		*filename,		/* Original filename */
		*mimetype;		/* MIME media type */
  size_t	filesize;		/* Size of uploaded file */
} cgi_file_t;


/*
 * Prototypes...
 */

extern void		cgiAbort(const char *title, const char *stylesheet,
			         const char *format, ...);
extern int		cgiCheckVariables(const char *names);
extern void		*cgiCompileSearch(const char *query);
extern void		cgiCopyTemplateFile(FILE *out, const char *tmpl);
extern void		cgiCopyTemplateLang(const char *tmpl);
extern int		cgiDoSearch(void *search, const char *text);
extern void		cgiEndHTML(void);
extern char		*cgiFormEncode(char *dst, const char *src, size_t dstsize);
extern void		cgiFreeSearch(void *search);
extern const char	*cgiGetArray(const char *name, int element);
extern void		cgiGetAttributes(ipp_t *request, const char *tmpl);
extern char		*cgiGetCookie(const char *name, char *buf, int buflen);
extern const cgi_file_t	*cgiGetFile(void);
extern cups_array_t	*cgiGetIPPObjects(ipp_t *response, void *search);
extern int		cgiGetSize(const char *name);
extern char		*cgiGetTemplateDir(void);
extern const char	*cgiGetVariable(const char *name);
extern int		cgiInitialize(void);
extern int		cgiIsPOST(void);
extern void		cgiMoveJobs(http_t *http, const char *dest, int job_id);
extern void		cgiPrintTestPage(http_t *http, const char *dest);
extern char		*cgiRewriteURL(const char *uri, char *url, int urlsize,
			               const char *newresource);
extern void		cgiSetArray(const char *name, int element,
			            const char *value);
extern void		cgiSetCookie(const char *name, const char *value,
			             const char *path, const char *domain,
				     time_t expires, int secure);
extern ipp_attribute_t	*cgiSetIPPObjectVars(ipp_attribute_t *obj,
			                     const char *prefix, int element);
extern int		cgiSetIPPVars(ipp_t *response, const char *filter_name,
			              const char *filter_value,
			              const char *prefix, int parent_el);
extern void		cgiSetServerVersion(void);
extern void		cgiSetSize(const char *name, int size);
extern void		cgiSetVariable(const char *name, const char *value);
extern void		cgiShowIPPError(const char *message);
extern void		cgiShowJobs(http_t *http, const char *dest);
extern void		cgiStartHTML(const char *title);
extern const char	*cgiText(const char *message);

#endif /* !_CUPS_CGI_H_ */

/*
 * End of "$Id: cgi.h 4931 2006-01-14 20:37:40Z mike $".
 */
Commit	Line	Data
ef416fc2	1	/*
f7faf1f5	2	* "$Id: cgi.h 4931 2006-01-14 20:37:40Z mike $"
ef416fc2	3	*
	4	* CGI support library definitions.
	5	*
	6	* Copyright 1997-2006 by Easy Software Products.
	7	*
	8	* These coded instructions, statements, and computer programs are the
	9	* property of Easy Software Products and are protected by Federal
	10	* copyright law. Distribution and use rights are outlined in the file
	11	* "LICENSE.txt" which should have been included with this file. If this
	12	* file is missing or damaged please contact Easy Software Products
	13	* at:
	14	*
	15	* Attn: CUPS Licensing Information
	16	* Easy Software Products
	17	* 44141 Airport View Drive, Suite 204
	18	* Hollywood, Maryland 20636 USA
	19	*
	20	* Voice: (301) 373-9600
	21	* EMail: cups-info@cups.org
	22	* WWW: http://www.cups.org
	23	*/
	24
	25	#ifndef _CUPS_CGI_H_
	26	# define _CUPS_CGI_H_
	27
	28	# include <stdio.h>
	29	# include <stdlib.h>
	30	# include <time.h>
	31	# include <sys/stat.h>
	32
	33	# ifdef WIN32
	34	# include <direct.h>
	35	# include <io.h>
	36	# else
	37	# include <unistd.h>
	38	# endif /* WIN32 */
	39
	40	# include <cups/cups.h>
	41	# include <cups/array.h>
	42	# include "help-index.h"
	43
	44
	45	/*
	46	* Types...
	47	*/
	48
	49	typedef struct cgi_file_s /** Uploaded file data **/
	50	{
	51	char tempfile[1024], /* Temporary file containing data */
	52	name, / Variable name */
	53	filename, / Original filename */
	54	mimetype; / MIME media type */
	55	size_t filesize; /* Size of uploaded file */
	56	} cgi_file_t;
	57
	58
	59	/*
	60	* Prototypes...
	61	*/
	62
	63	extern void cgiAbort(const char title, const char stylesheet,
	64	const char *format, ...);
	65	extern int cgiCheckVariables(const char *names);
	66	extern void cgiCompileSearch(const char query);
67	extern void cgiCopyTemplateFile(FILE out, const char tmpl);
68	extern void cgiCopyTemplateLang(const char *tmpl);
69	extern int cgiDoSearch(void search, const char text);
70	extern void cgiEndHTML(void);
71	extern char cgiFormEncode(char dst, const char *src, size_t dstsize);
72	extern void cgiFreeSearch(void *search);
73	extern const char cgiGetArray(const char name, int element);
74	extern void cgiGetAttributes(ipp_t request, const char tmpl);
75	extern char cgiGetCookie(const char name, char *buf, int buflen);
76	extern const cgi_file_t *cgiGetFile(void);
77	extern cups_array_t cgiGetIPPObjects(ipp_t response, void *search);
78	extern int cgiGetSize(const char *name);
79	extern char *cgiGetTemplateDir(void);
80	extern const char cgiGetVariable(const char name);
81	extern int cgiInitialize(void);
82	extern int cgiIsPOST(void);
fa73b229	83	extern void cgiMoveJobs(http_t http, const char dest, int job_id);
fa73b229	84	extern void cgiPrintTestPage(http_t http, const char dest);
ef416fc2	85	extern char cgiRewriteURL(const char uri, char *url, int urlsize,
	86	const char *newresource);
	87	extern void cgiSetArray(const char *name, int element,
	88	const char *value);
	89	extern void cgiSetCookie(const char name, const char value,
	90	const char path, const char domain,
	91	time_t expires, int secure);
	92	extern ipp_attribute_t cgiSetIPPObjectVars(ipp_attribute_t obj,
	93	const char *prefix, int element);
	94	extern int cgiSetIPPVars(ipp_t response, const char filter_name,
	95	const char *filter_value,
	96	const char *prefix, int parent_el);
	97	extern void cgiSetServerVersion(void);
	98	extern void cgiSetSize(const char *name, int size);
	99	extern void cgiSetVariable(const char name, const char value);
fa73b229	100	extern void cgiShowIPPError(const char *message);
ef416fc2	101	extern void cgiShowJobs(http_t http, const char dest);
ef416fc2	102	extern void cgiStartHTML(const char *title);
fa73b229	103	extern const char cgiText(const char message);
ef416fc2	104
	105	#endif /* !_CUPS_CGI_H_ */
	106
	107	/*
f7faf1f5	108	* End of "$Id: cgi.h 4931 2006-01-14 20:37:40Z mike $".
ef416fc2	109	*/