]> git.ipfire.org Git - thirdparty/cups.git/blob - cgi-bin/cgi.h
Merge pull request #5297 from FedericoYundt/patch-1
[thirdparty/cups.git] / cgi-bin / cgi.h
1 /*
2 * CGI support library definitions for CUPS.
3 *
4 * Copyright 2007-2010 by Apple Inc.
5 * Copyright 1997-2006 by Easy Software Products.
6 *
7 * Licensed under Apache License v2.0. See the file "LICENSE" for more information.
8 */
9
10 #ifndef _CUPS_CGI_H_
11 # define _CUPS_CGI_H_
12
13 # include <stdio.h>
14 # include <stdlib.h>
15 # include <time.h>
16 # include <sys/stat.h>
17
18 # ifdef WIN32
19 # include <direct.h>
20 # include <io.h>
21 # else
22 # include <unistd.h>
23 # endif /* WIN32 */
24
25 # include <cups/cups.h>
26 # include <cups/array.h>
27 # include "help-index.h"
28
29
30 /*
31 * C++ magic...
32 */
33
34 # ifdef __cplusplus
35 extern "C" {
36 # endif /* __cplusplus */
37
38 /*
39 * Types...
40 */
41
42 typedef struct cgi_file_s /**** Uploaded file data ****/
43 {
44 char tempfile[1024], /* Temporary file containing data */
45 *name, /* Variable name */
46 *filename, /* Original filename */
47 *mimetype; /* MIME media type */
48 size_t filesize; /* Size of uploaded file */
49 } cgi_file_t;
50
51
52 /*
53 * Prototypes...
54 */
55
56 extern void cgiAbort(const char *title, const char *stylesheet,
57 const char *format, ...);
58 extern int cgiCheckVariables(const char *names);
59 extern void cgiClearVariables(void);
60 extern void *cgiCompileSearch(const char *query);
61 extern void cgiCopyTemplateFile(FILE *out, const char *tmpl);
62 extern void cgiCopyTemplateLang(const char *tmpl);
63 extern int cgiDoSearch(void *search, const char *text);
64 extern void cgiEndHTML(void);
65 extern void cgiEndMultipart(void);
66 extern char *cgiFormEncode(char *dst, const char *src,
67 size_t dstsize);
68 extern void cgiFreeSearch(void *search);
69 extern const char *cgiGetArray(const char *name, int element);
70 extern void cgiGetAttributes(ipp_t *request, const char *tmpl);
71 extern const char *cgiGetCookie(const char *name);
72 extern const cgi_file_t *cgiGetFile(void);
73 extern cups_array_t *cgiGetIPPObjects(ipp_t *response, void *search);
74 extern int cgiGetSize(const char *name);
75 extern char *cgiGetTemplateDir(void);
76 extern const char *cgiGetVariable(const char *name);
77 extern int cgiInitialize(void);
78 extern int cgiIsPOST(void);
79 extern void cgiMoveJobs(http_t *http, const char *dest, int job_id);
80 extern void cgiPrintCommand(http_t *http, const char *dest,
81 const char *command, const char *title);
82 extern void cgiPrintTestPage(http_t *http, const char *dest);
83 extern char *cgiRewriteURL(const char *uri, char *url, int urlsize,
84 const char *newresource);
85 extern void cgiSetArray(const char *name, int element,
86 const char *value);
87 extern void cgiSetCookie(const char *name, const char *value,
88 const char *path, const char *domain,
89 time_t expires, int secure);
90 extern ipp_attribute_t *cgiSetIPPObjectVars(ipp_attribute_t *obj,
91 const char *prefix, int element);
92 extern int cgiSetIPPVars(ipp_t *response, const char *filter_name,
93 const char *filter_value,
94 const char *prefix, int parent_el);
95 extern void cgiSetServerVersion(void);
96 extern void cgiSetSize(const char *name, int size);
97 extern void cgiSetVariable(const char *name, const char *value);
98 extern void cgiShowIPPError(const char *message);
99 extern void cgiShowJobs(http_t *http, const char *dest);
100 extern void cgiStartHTML(const char *title);
101 extern void cgiStartMultipart(void);
102 extern int cgiSupportsMultipart(void);
103 extern const char *cgiText(const char *message);
104
105 # ifdef __cplusplus
106 }
107 # endif /* __cplusplus */
108
109 #endif /* !_CUPS_CGI_H_ */