]>
Commit | Line | Data |
---|---|---|
ef416fc2 | 1 | /* |
503b54c9 | 2 | * Private definitions for CUPS. |
ef416fc2 | 3 | * |
59cd12c6 | 4 | * Copyright © 2007-2019 by Apple Inc. |
b969d5af | 5 | * Copyright © 1997-2007 by Easy Software Products, all rights reserved. |
ef416fc2 | 6 | * |
b969d5af MS |
7 | * Licensed under Apache License v2.0. See the file "LICENSE" for more |
8 | * information. | |
ef416fc2 | 9 | */ |
10 | ||
71e16022 MS |
11 | #ifndef _CUPS_CUPS_PRIVATE_H_ |
12 | # define _CUPS_CUPS_PRIVATE_H_ | |
ef416fc2 | 13 | |
14 | /* | |
15 | * Include necessary headers... | |
16 | */ | |
17 | ||
71e16022 | 18 | # include "string-private.h" |
5a9febac | 19 | # include "array-private.h" |
71e16022 | 20 | # include "ipp-private.h" |
82cc1f9a | 21 | # include "http-private.h" |
71e16022 | 22 | # include "language-private.h" |
54afec33 | 23 | # include "pwg-private.h" |
6d2f911b | 24 | # include "thread-private.h" |
82cc1f9a | 25 | # include <cups/cups.h> |
c8fef167 MS |
26 | # ifdef __APPLE__ |
27 | # include <sys/cdefs.h> | |
28 | # include <CoreFoundation/CoreFoundation.h> | |
29 | # endif /* __APPLE__ */ | |
ef416fc2 | 30 | |
31 | ||
32 | /* | |
33 | * C++ magic... | |
34 | */ | |
35 | ||
36 | # ifdef __cplusplus | |
37 | extern "C" { | |
38 | # endif /* __cplusplus */ | |
39 | ||
40 | ||
41 | /* | |
71e16022 | 42 | * Types... |
ef416fc2 | 43 | */ |
44 | ||
dcb445bc MS |
45 | typedef struct _cups_buffer_s /**** Read/write buffer ****/ |
46 | { | |
47 | struct _cups_buffer_s *next; /* Next buffer in list */ | |
48 | size_t size; /* Size of buffer */ | |
49 | char used, /* Is this buffer used? */ | |
50 | d[1]; /* Data buffer */ | |
51 | } _cups_buffer_t; | |
52 | ||
dd204f7a MS |
53 | typedef struct _cups_raster_error_s /**** Error buffer structure ****/ |
54 | { | |
55 | char *start, /* Start of buffer */ | |
56 | *current, /* Current position in buffer */ | |
57 | *end; /* End of buffer */ | |
58 | } _cups_raster_error_t; | |
59 | ||
59cd12c6 MS |
60 | typedef enum _cups_uatokens_e /**** UserAgentTokens values */ |
61 | { | |
62 | _CUPS_UATOKENS_NONE, /* Do not send User-Agent */ | |
63 | _CUPS_UATOKENS_PRODUCT_ONLY, /* CUPS IPP */ | |
64 | _CUPS_UATOKENS_MAJOR, /* CUPS/major IPP/2 */ | |
65 | _CUPS_UATOKENS_MINOR, /* CUPS/major.minor IPP/2.1 */ | |
66 | _CUPS_UATOKENS_MINIMAL, /* CUPS/major.minor.patch IPP/2.1 */ | |
67 | _CUPS_UATOKENS_OS, /* CUPS/major.minor.patch (osname osversion) IPP/2.1 */ | |
68 | _CUPS_UATOKENS_FULL /* CUPS/major.minor.patch (osname osversion; architecture) IPP/2.1 */ | |
69 | } _cups_uatokens_t; | |
70 | ||
ef416fc2 | 71 | typedef struct _cups_globals_s /**** CUPS global state data ****/ |
72 | { | |
73 | /* Multiple places... */ | |
74 | const char *cups_datadir, /* CUPS_DATADIR environment var */ | |
75 | *cups_serverbin,/* CUPS_SERVERBIN environment var */ | |
76 | *cups_serverroot, | |
77 | /* CUPS_SERVERROOT environment var */ | |
78 | *cups_statedir, /* CUPS_STATEDIR environment var */ | |
79 | *localedir; /* LOCALDIR environment var */ | |
80 | ||
757d2cad | 81 | /* adminutil.c */ |
82 | time_t cupsd_update; /* Last time we got or set cupsd.conf */ | |
83 | char cupsd_hostname[HTTP_MAX_HOST]; | |
84 | /* Hostname for connection */ | |
85 | int cupsd_num_settings; | |
86 | /* Number of server settings */ | |
87 | cups_option_t *cupsd_settings;/* Server settings */ | |
88 | ||
07ed0e9a MS |
89 | /* auth.c */ |
90 | # ifdef HAVE_GSSAPI | |
91 | char gss_service_name[32]; | |
92 | /* Kerberos service name */ | |
93 | # endif /* HAVE_GSSAPI */ | |
94 | ||
5eb9da71 MS |
95 | /* backend.c */ |
96 | char resolved_uri[1024]; | |
97 | /* Buffer for cupsBackendDeviceURI */ | |
98 | ||
a469f8a5 MS |
99 | /* debug.c */ |
100 | # ifdef DEBUG | |
101 | int thread_id; /* Friendly thread ID */ | |
102 | # endif /* DEBUG */ | |
103 | ||
80ca4592 | 104 | /* file.c */ |
105 | cups_file_t *stdio_files[3];/* stdin, stdout, stderr */ | |
106 | ||
ef416fc2 | 107 | /* http.c */ |
108 | char http_date[256]; /* Date+time buffer */ | |
109 | ||
110 | /* http-addr.c */ | |
111 | unsigned ip_addr; /* Packed IPv4 address */ | |
112 | char *ip_ptrs[2]; /* Pointer to packed address */ | |
113 | struct hostent hostent; /* Host entry for IP address */ | |
114 | # ifdef HAVE_GETADDRINFO | |
115 | char hostname[1024]; /* Hostname */ | |
116 | # endif /* HAVE_GETADDRINFO */ | |
49d87452 | 117 | int need_res_init; /* Need to reinitialize resolver? */ |
ef416fc2 | 118 | |
119 | /* ipp.c */ | |
65bebeac | 120 | ipp_uchar_t ipp_date[11]; /* RFC-2579 date/time data */ |
dcb445bc | 121 | _cups_buffer_t *cups_buffers; /* Buffer list */ |
ef416fc2 | 122 | |
123 | /* ipp-support.c */ | |
124 | int ipp_port; /* IPP port number */ | |
125 | char ipp_unknown[255]; | |
126 | /* Unknown error statuses */ | |
127 | ||
ef416fc2 | 128 | /* language.c */ |
fa73b229 | 129 | cups_lang_t *lang_default; /* Default language */ |
ef416fc2 | 130 | # ifdef __APPLE__ |
ef416fc2 | 131 | char language[32]; /* Cached language */ |
ef416fc2 | 132 | # endif /* __APPLE__ */ |
133 | ||
54afec33 MS |
134 | /* pwg-media.c */ |
135 | cups_array_t *leg_size_lut, /* Lookup table for legacy names */ | |
136 | *ppd_size_lut, /* Lookup table for PPD names */ | |
137 | *pwg_size_lut; /* Lookup table for PWG names */ | |
6961465f | 138 | pwg_media_t pwg_media; /* PWG media data for custom size */ |
23862bc6 MS |
139 | char pwg_name[65], /* PWG media name for custom size */ |
140 | ppd_name[41]; /* PPD media name for custom size */ | |
c168a833 | 141 | |
dd204f7a MS |
142 | /* raster-error.c */ |
143 | _cups_raster_error_t raster_error; /* Raster error information */ | |
144 | ||
5180a04c MS |
145 | /* request.c */ |
146 | http_t *http; /* Current server connection */ | |
147 | ipp_status_t last_error; /* Last IPP error */ | |
148 | char *last_status_message; | |
149 | /* Last IPP status-message */ | |
150 | ||
91c84a35 | 151 | /* snmp.c */ |
ac884b6a MS |
152 | char snmp_community[255]; |
153 | /* Default SNMP community name */ | |
91c84a35 MS |
154 | int snmp_debug; /* Log SNMP IO to stderr? */ |
155 | ||
ef416fc2 | 156 | /* tempfile.c */ |
157 | char tempfile[1024]; /* cupsTempFd/File buffer */ | |
158 | ||
ef416fc2 | 159 | /* usersys.c */ |
59cd12c6 | 160 | _cups_uatokens_t uatokens; /* UserAgentTokens setting */ |
ef416fc2 | 161 | http_encryption_t encryption; /* Encryption setting */ |
162 | char user[65], /* User name */ | |
db8b865d | 163 | user_agent[256],/* User-Agent string */ |
ef416fc2 | 164 | server[256], /* Server address */ |
dcb445bc MS |
165 | servername[256],/* Server hostname */ |
166 | password[128]; /* Password for default callback */ | |
f11a948a MS |
167 | cups_password_cb2_t password_cb; /* Password callback */ |
168 | void *password_data; /* Password user data */ | |
7cf5915e MS |
169 | http_tls_credentials_t tls_credentials; |
170 | /* Default client credentials */ | |
171 | cups_client_cert_cb_t client_cert_cb; /* Client certificate callback */ | |
172 | void *client_cert_data; | |
173 | /* Client certificate user data */ | |
174 | cups_server_cert_cb_t server_cert_cb; /* Server certificate callback */ | |
175 | void *server_cert_data; | |
176 | /* Server certificate user data */ | |
0cb67df3 | 177 | int server_version, /* Server IPP version */ |
08d56b1f | 178 | trust_first, /* Trust on first use? */ |
9653cfdf | 179 | any_root, /* Allow any (e.g., self-signed) root */ |
f51f3773 MS |
180 | expired_certs, /* Allow expired certs */ |
181 | validate_certs; /* Validate certificates */ | |
ef416fc2 | 182 | |
183 | /* util.c */ | |
ef416fc2 | 184 | char def_printer[256]; |
185 | /* Default printer */ | |
ef416fc2 | 186 | } _cups_globals_t; |
187 | ||
dcb445bc MS |
188 | typedef struct _cups_media_db_s /* Media database */ |
189 | { | |
190 | char *color, /* Media color, if any */ | |
191 | *key, /* Media key, if any */ | |
192 | *info, /* Media human-readable name, if any */ | |
193 | *size_name, /* Media PWG size name, if provided */ | |
194 | *source, /* Media source, if any */ | |
195 | *type; /* Media type, if any */ | |
196 | int width, /* Width in hundredths of millimeters */ | |
197 | length, /* Length in hundredths of | |
198 | * millimeters */ | |
199 | bottom, /* Bottom margin in hundredths of | |
200 | * millimeters */ | |
201 | left, /* Left margin in hundredths of | |
202 | * millimeters */ | |
203 | right, /* Right margin in hundredths of | |
204 | * millimeters */ | |
205 | top; /* Top margin in hundredths of | |
206 | * millimeters */ | |
207 | } _cups_media_db_t; | |
208 | ||
a29fd7dd MS |
209 | typedef struct _cups_dconstres_s /* Constraint/resolver */ |
210 | { | |
211 | char *name; /* Name of resolver */ | |
212 | ipp_t *collection; /* Collection containing attrs */ | |
213 | } _cups_dconstres_t; | |
214 | ||
dcb445bc MS |
215 | struct _cups_dinfo_s /* Destination capability and status |
216 | * information */ | |
217 | { | |
6961465f | 218 | int version; /* IPP version */ |
dcb445bc MS |
219 | const char *uri; /* Printer URI */ |
220 | char *resource; /* Resource path */ | |
221 | ipp_t *attrs; /* Printer attributes */ | |
a29fd7dd MS |
222 | int num_defaults; /* Number of default options */ |
223 | cups_option_t *defaults; /* Default options */ | |
dcb445bc | 224 | cups_array_t *constraints; /* Job constraints */ |
a29fd7dd | 225 | cups_array_t *resolvers; /* Job resolvers */ |
dcb445bc MS |
226 | cups_array_t *localizations; /* Localization information */ |
227 | cups_array_t *media_db; /* Media database */ | |
228 | _cups_media_db_t min_size, /* Minimum size */ | |
229 | max_size; /* Maximum size */ | |
6961465f MS |
230 | unsigned cached_flags; /* Flags used for cached media */ |
231 | cups_array_t *cached_db; /* Cache of media from last index/default */ | |
232 | time_t ready_time; /* When xxx-ready attributes were last queried */ | |
233 | ipp_t *ready_attrs; /* xxx-ready attributes */ | |
234 | cups_array_t *ready_db; /* media[-col]-ready media database */ | |
dcb445bc MS |
235 | }; |
236 | ||
ef416fc2 | 237 | |
238 | /* | |
239 | * Prototypes... | |
240 | */ | |
241 | ||
c8fef167 | 242 | # ifdef __APPLE__ |
e3586875 MS |
243 | extern CFStringRef _cupsAppleCopyDefaultPaperID(void) _CUPS_PRIVATE; |
244 | extern CFStringRef _cupsAppleCopyDefaultPrinter(void) _CUPS_PRIVATE; | |
245 | extern int _cupsAppleGetUseLastPrinter(void) _CUPS_PRIVATE; | |
246 | extern void _cupsAppleSetDefaultPaperID(CFStringRef name) _CUPS_PRIVATE; | |
247 | extern void _cupsAppleSetDefaultPrinter(CFStringRef name) _CUPS_PRIVATE; | |
248 | extern void _cupsAppleSetUseLastPrinter(int uselast) _CUPS_PRIVATE; | |
c8fef167 MS |
249 | # endif /* __APPLE__ */ |
250 | ||
e3586875 MS |
251 | extern char *_cupsBufferGet(size_t size) _CUPS_PRIVATE; |
252 | extern void _cupsBufferRelease(char *b) _CUPS_PRIVATE; | |
253 | ||
fb863569 | 254 | extern http_t *_cupsConnect(void) _CUPS_PRIVATE; |
e3586875 MS |
255 | extern char *_cupsCreateDest(const char *name, const char *info, const char *device_id, const char *device_uri, char *uri, size_t urisize) _CUPS_PRIVATE; |
256 | extern ipp_attribute_t *_cupsEncodeOption(ipp_t *ipp, ipp_tag_t group_tag, _ipp_option_t *map, const char *name, const char *value) _CUPS_PRIVATE; | |
257 | extern int _cupsGet1284Values(const char *device_id, cups_option_t **values) _CUPS_PRIVATE; | |
258 | extern const char *_cupsGetDestResource(cups_dest_t *dest, unsigned flags, char *resource, size_t resourcesize) _CUPS_PRIVATE; | |
259 | extern int _cupsGetDests(http_t *http, ipp_op_t op, const char *name, cups_dest_t **dests, cups_ptype_t type, cups_ptype_t mask) _CUPS_PRIVATE; | |
260 | extern const char *_cupsGetPassword(const char *prompt) _CUPS_PRIVATE; | |
261 | extern void _cupsGlobalLock(void) _CUPS_PRIVATE; | |
262 | extern _cups_globals_t *_cupsGlobals(void) _CUPS_PRIVATE; | |
263 | extern void _cupsGlobalUnlock(void) _CUPS_PRIVATE; | |
eac3a0a0 | 264 | # ifdef HAVE_GSSAPI |
e3586875 | 265 | extern const char *_cupsGSSServiceName(void) _CUPS_PRIVATE; |
eac3a0a0 | 266 | # endif /* HAVE_GSSAPI */ |
e3586875 | 267 | extern int _cupsNextDelay(int current, int *previous) _CUPS_PRIVATE; |
11ea1663 | 268 | extern void _cupsSetDefaults(void) _CUPS_INTERNAL; |
e3586875 | 269 | extern void _cupsSetError(ipp_status_t status, const char *message, int localize) _CUPS_PRIVATE; |
11ea1663 | 270 | extern void _cupsSetHTTPError(http_status_t status) _CUPS_INTERNAL; |
f14324a7 | 271 | # ifdef HAVE_GSSAPI |
e3586875 | 272 | extern int _cupsSetNegotiateAuthString(http_t *http, const char *method, const char *resource) _CUPS_PRIVATE; |
f14324a7 | 273 | # endif /* HAVE_GSSAPI */ |
11ea1663 | 274 | extern char *_cupsUserDefault(char *name, size_t namesize) _CUPS_INTERNAL; |
ef416fc2 | 275 | |
276 | ||
277 | /* | |
278 | * C++ magic... | |
279 | */ | |
280 | ||
281 | # ifdef __cplusplus | |
282 | } | |
283 | # endif /* __cplusplus */ | |
71e16022 | 284 | #endif /* !_CUPS_CUPS_PRIVATE_H_ */ |