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

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