]> git.ipfire.org Git - thirdparty/cups.git/blob - cups/encode.c
projects / thirdparty / cups.git / blob
? search:


cf9ea8e88a4e4f1dea9e0c8da450b94370260e35
[thirdparty/cups.git] / cups / encode.c
1 /*
2 * Option encoding routines for CUPS.
3 *
4 * Copyright 2007-2017 by Apple Inc.
5 * Copyright 1997-2007 by Easy Software Products.
6 *
7 * These coded instructions, statements, and computer programs are the
8 * property of Apple Inc. and are protected by Federal copyright
9 * law. Distribution and use rights are outlined in the file "LICENSE.txt"
10 * which should have been included with this file. If this file is
11 * missing or damaged, see the license at "http://www.cups.org/".
12 *
13 * This file is subject to the Apple OS-Developed Software exception.
14 */
15
16 /*
17 * Include necessary headers...
18 */
19
20 #include "cups-private.h"
21
22
23 /*
24 * Local list of option names, the value tags they should use, and the list of
25 * supported operations...
26 *
27 * **** THIS LIST MUST BE SORTED BY ATTRIBUTE NAME ****
28 */
29
30 static const ipp_op_t ipp_job_creation[] =
31 {
32 IPP_OP_PRINT_JOB,
33 IPP_OP_PRINT_URI,
34 IPP_OP_VALIDATE_JOB,
35 IPP_OP_CREATE_JOB,
36 IPP_OP_HOLD_JOB,
37 IPP_OP_SET_JOB_ATTRIBUTES,
38 IPP_OP_CUPS_NONE
39 };
40
41 static const ipp_op_t ipp_doc_creation[] =
42 {
43 IPP_OP_PRINT_JOB,
44 IPP_OP_PRINT_URI,
45 IPP_OP_SEND_DOCUMENT,
46 IPP_OP_SEND_URI,
47 IPP_OP_SET_JOB_ATTRIBUTES,
48 IPP_OP_SET_DOCUMENT_ATTRIBUTES,
49 IPP_OP_CUPS_NONE
50 };
51
52 static const ipp_op_t ipp_sub_creation[] =
53 {
54 IPP_OP_PRINT_JOB,
55 IPP_OP_PRINT_URI,
56 IPP_OP_CREATE_JOB,
57 IPP_OP_CREATE_PRINTER_SUBSCRIPTIONS,
58 IPP_OP_CREATE_JOB_SUBSCRIPTIONS,
59 IPP_OP_CUPS_NONE
60 };
61
62 static const ipp_op_t ipp_all_print[] =
63 {
64 IPP_OP_PRINT_JOB,
65 IPP_OP_PRINT_URI,
66 IPP_OP_VALIDATE_JOB,
67 IPP_OP_CREATE_JOB,
68 IPP_OP_SEND_DOCUMENT,
69 IPP_OP_SEND_URI,
70 IPP_OP_CUPS_NONE
71 };
72
73 static const ipp_op_t ipp_set_printer[] =
74 {
75 IPP_OP_SET_PRINTER_ATTRIBUTES,
76 IPP_OP_CUPS_ADD_MODIFY_PRINTER,
77 IPP_OP_CUPS_ADD_MODIFY_CLASS,
78 IPP_OP_CUPS_NONE
79 };
80
81 static const ipp_op_t cups_schemes[] =
82 {
83 IPP_OP_CUPS_GET_DEVICES,
84 IPP_OP_CUPS_GET_PPDS,
85 IPP_OP_CUPS_NONE
86 };
87
88 static const ipp_op_t cups_get_ppds[] =
89 {
90 IPP_OP_CUPS_GET_PPDS,
91 IPP_OP_CUPS_NONE
92 };
93
94 static const ipp_op_t cups_ppd_name[] =
95 {
96 IPP_OP_CUPS_ADD_MODIFY_PRINTER,
97 IPP_OP_CUPS_GET_PPD,
98 IPP_OP_CUPS_NONE
99 };
100
101 static const _ipp_option_t ipp_options[] =
102 {
103 { 1, "auth-info", IPP_TAG_TEXT, IPP_TAG_JOB },
104 { 1, "auth-info-default", IPP_TAG_TEXT, IPP_TAG_PRINTER },
105 { 1, "auth-info-required", IPP_TAG_KEYWORD, IPP_TAG_PRINTER },
106 { 0, "blackplot", IPP_TAG_BOOLEAN, IPP_TAG_JOB },
107 { 0, "blackplot-default", IPP_TAG_BOOLEAN, IPP_TAG_PRINTER },
108 { 0, "brightness", IPP_TAG_INTEGER, IPP_TAG_JOB },
109 { 0, "brightness-default", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
110 { 0, "columns", IPP_TAG_INTEGER, IPP_TAG_JOB },
111 { 0, "columns-default", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
112 { 0, "compression", IPP_TAG_KEYWORD, IPP_TAG_OPERATION,
113 IPP_TAG_ZERO,
114 ipp_doc_creation },
115 { 0, "copies", IPP_TAG_INTEGER, IPP_TAG_JOB,
116 IPP_TAG_DOCUMENT },
117 { 0, "copies-default", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
118 { 0, "date-time-at-completed",IPP_TAG_DATE, IPP_TAG_ZERO }, /* never send as option */
119 { 0, "date-time-at-creation", IPP_TAG_DATE, IPP_TAG_ZERO }, /* never send as option */
120 { 0, "date-time-at-processing",IPP_TAG_DATE, IPP_TAG_ZERO }, /* never send as option */
121 { 0, "device-uri", IPP_TAG_URI, IPP_TAG_PRINTER },
122 { 1, "document-copies", IPP_TAG_RANGE, IPP_TAG_JOB,
123 IPP_TAG_DOCUMENT,
124 ipp_doc_creation },
125 { 0, "document-format", IPP_TAG_MIMETYPE, IPP_TAG_OPERATION,
126 IPP_TAG_ZERO,
127 ipp_doc_creation },
128 { 0, "document-format-default", IPP_TAG_MIMETYPE, IPP_TAG_PRINTER },
129 { 1, "document-numbers", IPP_TAG_RANGE, IPP_TAG_JOB,
130 IPP_TAG_DOCUMENT,
131 ipp_all_print },
132 { 1, "exclude-schemes", IPP_TAG_NAME, IPP_TAG_OPERATION,
133 IPP_TAG_ZERO,
134 cups_schemes },
135 { 1, "finishings", IPP_TAG_ENUM, IPP_TAG_JOB,
136 IPP_TAG_DOCUMENT },
137 { 1, "finishings-default", IPP_TAG_ENUM, IPP_TAG_PRINTER },
138 { 0, "fit-to-page", IPP_TAG_BOOLEAN, IPP_TAG_JOB,
139 IPP_TAG_DOCUMENT },
140 { 0, "fit-to-page-default", IPP_TAG_BOOLEAN, IPP_TAG_PRINTER },
141 { 0, "fitplot", IPP_TAG_BOOLEAN, IPP_TAG_JOB },
142 { 0, "fitplot-default", IPP_TAG_BOOLEAN, IPP_TAG_PRINTER },
143 { 0, "gamma", IPP_TAG_INTEGER, IPP_TAG_JOB },
144 { 0, "gamma-default", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
145 { 0, "hue", IPP_TAG_INTEGER, IPP_TAG_JOB },
146 { 0, "hue-default", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
147 { 1, "include-schemes", IPP_TAG_NAME, IPP_TAG_OPERATION,
148 IPP_TAG_ZERO,
149 cups_schemes },
150 { 0, "job-account-id", IPP_TAG_NAME, IPP_TAG_JOB },
151 { 0, "job-account-id-default",IPP_TAG_NAME, IPP_TAG_PRINTER },
152 { 0, "job-accounting-user-id", IPP_TAG_NAME, IPP_TAG_JOB },
153 { 0, "job-accounting-user-id-default", IPP_TAG_NAME, IPP_TAG_PRINTER },
154 { 0, "job-authorization-uri", IPP_TAG_URI, IPP_TAG_OPERATION },
155 { 0, "job-cancel-after", IPP_TAG_INTEGER, IPP_TAG_JOB },
156 { 0, "job-cancel-after-default", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
157 { 0, "job-hold-until", IPP_TAG_KEYWORD, IPP_TAG_JOB },
158 { 0, "job-id", IPP_TAG_INTEGER, IPP_TAG_ZERO }, /* never send as option */
159 { 0, "job-impressions", IPP_TAG_INTEGER, IPP_TAG_ZERO }, /* never send as option */
160 { 0, "job-impressions-completed", IPP_TAG_INTEGER, IPP_TAG_ZERO }, /* never send as option */
161 { 0, "job-k-limit", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
162 { 0, "job-k-octets", IPP_TAG_INTEGER, IPP_TAG_ZERO }, /* never send as option */
163 { 0, "job-k-octets-completed",IPP_TAG_INTEGER, IPP_TAG_ZERO }, /* never send as option */
164 { 0, "job-media-sheets", IPP_TAG_INTEGER, IPP_TAG_ZERO }, /* never send as option */
165 { 0, "job-media-sheets-completed", IPP_TAG_INTEGER, IPP_TAG_ZERO }, /* never send as option */
166 { 0, "job-page-limit", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
167 { 0, "job-password", IPP_TAG_STRING, IPP_TAG_OPERATION,
168 IPP_TAG_ZERO,
169 ipp_job_creation },
170 { 0, "job-password-encryption", IPP_TAG_KEYWORD, IPP_TAG_OPERATION,
171 IPP_TAG_ZERO,
172 ipp_job_creation },
173 { 0, "job-priority", IPP_TAG_INTEGER, IPP_TAG_JOB },
174 { 0, "job-quota-period", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
175 { 1, "job-sheets", IPP_TAG_NAME, IPP_TAG_JOB },
176 { 1, "job-sheets-default", IPP_TAG_NAME, IPP_TAG_PRINTER },
177 { 0, "job-state", IPP_TAG_ENUM, IPP_TAG_ZERO }, /* never send as option */
178 { 0, "job-state-message", IPP_TAG_TEXT, IPP_TAG_ZERO }, /* never send as option */
179 { 0, "job-state-reasons", IPP_TAG_KEYWORD, IPP_TAG_ZERO }, /* never send as option */
180 { 0, "job-uuid", IPP_TAG_URI, IPP_TAG_JOB },
181 { 0, "landscape", IPP_TAG_BOOLEAN, IPP_TAG_JOB },
182 { 1, "marker-change-time", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
183 { 1, "marker-colors", IPP_TAG_NAME, IPP_TAG_PRINTER },
184 { 1, "marker-high-levels", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
185 { 1, "marker-levels", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
186 { 1, "marker-low-levels", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
187 { 0, "marker-message", IPP_TAG_TEXT, IPP_TAG_PRINTER },
188 { 1, "marker-names", IPP_TAG_NAME, IPP_TAG_PRINTER },
189 { 1, "marker-types", IPP_TAG_KEYWORD, IPP_TAG_PRINTER },
190 { 1, "media", IPP_TAG_KEYWORD, IPP_TAG_JOB,
191 IPP_TAG_DOCUMENT },
192 { 0, "media-col", IPP_TAG_BEGIN_COLLECTION, IPP_TAG_JOB,
193 IPP_TAG_DOCUMENT },
194 { 0, "media-col-default", IPP_TAG_BEGIN_COLLECTION, IPP_TAG_PRINTER },
195 { 0, "media-color", IPP_TAG_KEYWORD, IPP_TAG_JOB,
196 IPP_TAG_DOCUMENT },
197 { 1, "media-default", IPP_TAG_KEYWORD, IPP_TAG_PRINTER },
198 { 0, "media-key", IPP_TAG_KEYWORD, IPP_TAG_JOB,
199 IPP_TAG_DOCUMENT },
200 { 0, "media-size", IPP_TAG_BEGIN_COLLECTION, IPP_TAG_JOB,
201 IPP_TAG_DOCUMENT },
202 { 0, "media-type", IPP_TAG_KEYWORD, IPP_TAG_JOB,
203 IPP_TAG_DOCUMENT },
204 { 0, "mirror", IPP_TAG_BOOLEAN, IPP_TAG_JOB },
205 { 0, "mirror-default", IPP_TAG_BOOLEAN, IPP_TAG_PRINTER },
206 { 0, "natural-scaling", IPP_TAG_INTEGER, IPP_TAG_JOB },
207 { 0, "natural-scaling-default", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
208 { 0, "notify-charset", IPP_TAG_CHARSET, IPP_TAG_SUBSCRIPTION },
209 { 1, "notify-events", IPP_TAG_KEYWORD, IPP_TAG_SUBSCRIPTION },
210 { 1, "notify-events-default", IPP_TAG_KEYWORD, IPP_TAG_PRINTER },
211 { 0, "notify-lease-duration", IPP_TAG_INTEGER, IPP_TAG_SUBSCRIPTION },
212 { 0, "notify-lease-duration-default", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
213 { 0, "notify-natural-language", IPP_TAG_LANGUAGE, IPP_TAG_SUBSCRIPTION },
214 { 0, "notify-pull-method", IPP_TAG_KEYWORD, IPP_TAG_SUBSCRIPTION },
215 { 0, "notify-recipient-uri", IPP_TAG_URI, IPP_TAG_SUBSCRIPTION },
216 { 0, "notify-time-interval", IPP_TAG_INTEGER, IPP_TAG_SUBSCRIPTION },
217 { 0, "notify-user-data", IPP_TAG_STRING, IPP_TAG_SUBSCRIPTION },
218 { 0, "number-up", IPP_TAG_INTEGER, IPP_TAG_JOB,
219 IPP_TAG_DOCUMENT },
220 { 0, "number-up-default", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
221 { 0, "orientation-requested", IPP_TAG_ENUM, IPP_TAG_JOB,
222 IPP_TAG_DOCUMENT },
223 { 0, "orientation-requested-default", IPP_TAG_ENUM, IPP_TAG_PRINTER },
224 { 1, "overrides", IPP_TAG_BEGIN_COLLECTION, IPP_TAG_JOB,
225 IPP_TAG_DOCUMENT },
226 { 0, "page-bottom", IPP_TAG_INTEGER, IPP_TAG_JOB },
227 { 0, "page-bottom-default", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
228 { 0, "page-left", IPP_TAG_INTEGER, IPP_TAG_JOB },
229 { 0, "page-left-default", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
230 { 1, "page-ranges", IPP_TAG_RANGE, IPP_TAG_JOB,
231 IPP_TAG_DOCUMENT },
232 { 1, "page-ranges-default", IPP_TAG_RANGE, IPP_TAG_PRINTER },
233 { 0, "page-right", IPP_TAG_INTEGER, IPP_TAG_JOB },
234 { 0, "page-right-default", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
235 { 0, "page-top", IPP_TAG_INTEGER, IPP_TAG_JOB },
236 { 0, "page-top-default", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
237 { 1, "pages", IPP_TAG_RANGE, IPP_TAG_JOB,
238 IPP_TAG_DOCUMENT },
239 { 0, "penwidth", IPP_TAG_INTEGER, IPP_TAG_JOB },
240 { 0, "penwidth-default", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
241 { 0, "port-monitor", IPP_TAG_NAME, IPP_TAG_PRINTER },
242 { 0, "ppd-device-id", IPP_TAG_TEXT, IPP_TAG_OPERATION,
243 IPP_TAG_ZERO,
244 cups_get_ppds },
245 { 0, "ppd-make", IPP_TAG_TEXT, IPP_TAG_OPERATION,
246 IPP_TAG_ZERO,
247 cups_get_ppds },
248 { 0, "ppd-make-and-model", IPP_TAG_TEXT, IPP_TAG_OPERATION,
249 IPP_TAG_ZERO,
250 cups_get_ppds },
251 { 0, "ppd-model-number", IPP_TAG_INTEGER, IPP_TAG_OPERATION,
252 IPP_TAG_ZERO,
253 cups_get_ppds },
254 { 0, "ppd-name", IPP_TAG_NAME, IPP_TAG_OPERATION,
255 IPP_TAG_ZERO,
256 cups_ppd_name },
257 { 0, "ppd-natural-language", IPP_TAG_LANGUAGE, IPP_TAG_OPERATION,
258 IPP_TAG_ZERO,
259 cups_get_ppds },
260 { 0, "ppd-product", IPP_TAG_TEXT, IPP_TAG_OPERATION,
261 IPP_TAG_ZERO,
262 cups_get_ppds },
263 { 0, "ppd-psversion", IPP_TAG_TEXT, IPP_TAG_OPERATION,
264 IPP_TAG_ZERO,
265 cups_get_ppds },
266 { 0, "ppd-type", IPP_TAG_KEYWORD, IPP_TAG_OPERATION,
267 IPP_TAG_ZERO,
268 cups_get_ppds },
269 { 0, "ppi", IPP_TAG_INTEGER, IPP_TAG_JOB },
270 { 0, "ppi-default", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
271 { 0, "prettyprint", IPP_TAG_BOOLEAN, IPP_TAG_JOB },
272 { 0, "prettyprint-default", IPP_TAG_BOOLEAN, IPP_TAG_PRINTER },
273 { 0, "print-quality", IPP_TAG_ENUM, IPP_TAG_JOB,
274 IPP_TAG_DOCUMENT },
275 { 0, "print-quality-default", IPP_TAG_ENUM, IPP_TAG_PRINTER },
276 { 1, "printer-commands", IPP_TAG_KEYWORD, IPP_TAG_PRINTER },
277 { 0, "printer-error-policy", IPP_TAG_NAME, IPP_TAG_PRINTER },
278 { 0, "printer-geo-location", IPP_TAG_URI, IPP_TAG_PRINTER },
279 { 0, "printer-info", IPP_TAG_TEXT, IPP_TAG_PRINTER },
280 { 0, "printer-is-accepting-jobs", IPP_TAG_BOOLEAN, IPP_TAG_PRINTER },
281 { 0, "printer-is-shared", IPP_TAG_BOOLEAN, IPP_TAG_PRINTER },
282 { 0, "printer-is-temporary", IPP_TAG_BOOLEAN, IPP_TAG_PRINTER },
283 { 0, "printer-location", IPP_TAG_TEXT, IPP_TAG_PRINTER },
284 { 0, "printer-make-and-model", IPP_TAG_TEXT, IPP_TAG_PRINTER },
285 { 0, "printer-more-info", IPP_TAG_URI, IPP_TAG_PRINTER },
286 { 0, "printer-op-policy", IPP_TAG_NAME, IPP_TAG_PRINTER },
287 { 0, "printer-resolution", IPP_TAG_RESOLUTION, IPP_TAG_JOB,
288 IPP_TAG_DOCUMENT },
289 { 0, "printer-state", IPP_TAG_ENUM, IPP_TAG_PRINTER },
290 { 0, "printer-state-change-time", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
291 { 1, "printer-state-reasons", IPP_TAG_KEYWORD, IPP_TAG_PRINTER },
292 { 0, "printer-type", IPP_TAG_ENUM, IPP_TAG_PRINTER },
293 { 0, "printer-uri", IPP_TAG_URI, IPP_TAG_OPERATION },
294 { 1, "printer-uri-supported", IPP_TAG_URI, IPP_TAG_PRINTER },
295 { 0, "queued-job-count", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
296 { 0, "raw", IPP_TAG_MIMETYPE, IPP_TAG_OPERATION },
297 { 1, "requested-attributes", IPP_TAG_NAME, IPP_TAG_OPERATION },
298 { 1, "requesting-user-name-allowed", IPP_TAG_NAME, IPP_TAG_PRINTER },
299 { 1, "requesting-user-name-denied", IPP_TAG_NAME, IPP_TAG_PRINTER },
300 { 0, "resolution", IPP_TAG_RESOLUTION, IPP_TAG_JOB },
301 { 0, "resolution-default", IPP_TAG_RESOLUTION, IPP_TAG_PRINTER },
302 { 0, "saturation", IPP_TAG_INTEGER, IPP_TAG_JOB },
303 { 0, "saturation-default", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
304 { 0, "scaling", IPP_TAG_INTEGER, IPP_TAG_JOB },
305 { 0, "scaling-default", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
306 { 0, "sides", IPP_TAG_KEYWORD, IPP_TAG_JOB,
307 IPP_TAG_DOCUMENT },
308 { 0, "sides-default", IPP_TAG_KEYWORD, IPP_TAG_PRINTER },
309 { 0, "time-at-completed", IPP_TAG_INTEGER, IPP_TAG_ZERO }, /* never send as option */
310 { 0, "time-at-creation", IPP_TAG_INTEGER, IPP_TAG_ZERO }, /* never send as option */
311 { 0, "time-at-processing", IPP_TAG_INTEGER, IPP_TAG_ZERO }, /* never send as option */
312 { 0, "wrap", IPP_TAG_BOOLEAN, IPP_TAG_JOB },
313 { 0, "wrap-default", IPP_TAG_BOOLEAN, IPP_TAG_PRINTER },
314 { 0, "x-dimension", IPP_TAG_INTEGER, IPP_TAG_JOB,
315 IPP_TAG_DOCUMENT },
316 { 0, "y-dimension", IPP_TAG_INTEGER, IPP_TAG_JOB,
317 IPP_TAG_DOCUMENT }
318 };
319
320
321 /*
322 * Local functions...
323 */
324
325 static int compare_ipp_options(_ipp_option_t *a, _ipp_option_t *b);
326
327
328 /*
329 * 'cupsEncodeOptions()' - Encode printer options into IPP attributes.
330 *
331 * This function adds operation, job, and then subscription attributes,
332 * in that order. Use the cupsEncodeOptions2() function to add attributes
333 * for a single group.
334 *
335 * @exclude all@
336 */
337
338 void
339 cupsEncodeOptions(ipp_t *ipp, /* I - Request to add to */
340 int num_options, /* I - Number of options */
341 cups_option_t *options) /* I - Options */
342 {
343 DEBUG_printf(("cupsEncodeOptions(%p, %d, %p)", (void *)ipp, num_options, (void *)options));
344
345 /*
346 * Add the options in the proper groups & order...
347 */
348
349 cupsEncodeOptions2(ipp, num_options, options, IPP_TAG_OPERATION);
350 cupsEncodeOptions2(ipp, num_options, options, IPP_TAG_JOB);
351 cupsEncodeOptions2(ipp, num_options, options, IPP_TAG_SUBSCRIPTION);
352 }
353
354
355 /*
356 * 'cupsEncodeOptions2()' - Encode printer options into IPP attributes for a group.
357 *
358 * This function only adds attributes for a single group. Call this
359 * function multiple times for each group, or use cupsEncodeOptions()
360 * to add the standard groups.
361 *
362 * @since CUPS 1.2/macOS 10.5@
363 */
364
365 void
366 cupsEncodeOptions2(
367 ipp_t *ipp, /* I - Request to add to */
368 int num_options, /* I - Number of options */
369 cups_option_t *options, /* I - Options */
370 ipp_tag_t group_tag) /* I - Group to encode */
371 {
372 int i, j; /* Looping vars */
373 int count; /* Number of values */
374 char *s, /* Pointer into option value */
375 *val, /* Pointer to option value */
376 *copy, /* Copy of option value */
377 *sep, /* Option separator */
378 quote; /* Quote character */
379 ipp_attribute_t *attr; /* IPP attribute */
380 ipp_tag_t value_tag; /* IPP value tag */
381 cups_option_t *option; /* Current option */
382 ipp_t *collection; /* Collection value */
383 int num_cols; /* Number of collection values */
384 cups_option_t *cols; /* Collection values */
385 ipp_op_t op; /* Operation for this request */
386 const ipp_op_t *ops; /* List of allowed operations */
387
388
389 DEBUG_printf(("cupsEncodeOptions2(ipp=%p(%s), num_options=%d, options=%p, group_tag=%x)", (void *)ipp, ipp ? ippOpString(ippGetOperation(ipp)) : "", num_options, (void *)options, group_tag));
390
391 /*
392 * Range check input...
393 */
394
395 if (!ipp || num_options < 1 || !options)
396 return;
397
398 /*
399 * Do special handling for the document-format/raw options...
400 */
401
402 op = ippGetOperation(ipp);
403
404 if (group_tag == IPP_TAG_OPERATION &&
405 (op == IPP_OP_PRINT_JOB || op == IPP_OP_PRINT_URI ||
406 op == IPP_OP_SEND_DOCUMENT || op == IPP_OP_SEND_URI))
407 {
408 /*
409 * Handle the document format stuff first...
410 */
411
412 if ((val = (char *)cupsGetOption("document-format", num_options,
413 options)) != NULL)
414 ippAddString(ipp, IPP_TAG_OPERATION, IPP_TAG_MIMETYPE, "document-format",
415 NULL, val);
416 else if (cupsGetOption("raw", num_options, options))
417 ippAddString(ipp, IPP_TAG_OPERATION, IPP_TAG_MIMETYPE, "document-format",
418 NULL, "application/vnd.cups-raw");
419 else
420 ippAddString(ipp, IPP_TAG_OPERATION, IPP_TAG_MIMETYPE, "document-format",
421 NULL, "application/octet-stream");
422 }
423
424 /*
425 * Then loop through the options...
426 */
427
428 for (i = num_options, option = options; i > 0; i --, option ++)
429 {
430 _ipp_option_t *match; /* Matching attribute */
431
432
433 /*
434 * Skip document format options that are handled above...
435 */
436
437 if (!_cups_strcasecmp(option->name, "raw") ||
438 !_cups_strcasecmp(option->name, "document-format") ||
439 !option->name[0])
440 continue;
441
442 /*
443 * Figure out the proper value and group tags for this option...
444 */
445
446 if ((match = _ippFindOption(option->name)) != NULL)
447 {
448 if (match->group_tag != group_tag && match->alt_group_tag != group_tag)
449 continue;
450
451 value_tag = match->value_tag;
452
453 if (match->operations)
454 ops = match->operations;
455 else if (group_tag == IPP_TAG_JOB)
456 ops = ipp_job_creation;
457 else if (group_tag == IPP_TAG_DOCUMENT)
458 ops = ipp_doc_creation;
459 else if (group_tag == IPP_TAG_SUBSCRIPTION)
460 ops = ipp_sub_creation;
461 else if (group_tag == IPP_TAG_PRINTER)
462 ops = ipp_set_printer;
463 else
464 {
465 DEBUG_printf(("2cupsEncodeOptions2: Skipping \"%s\".", option->name));
466 continue;
467 }
468 }
469 else
470 {
471 int namelen; /* Length of name */
472
473
474 namelen = (int)strlen(option->name);
475
476 if (namelen < 10 ||
477 (strcmp(option->name + namelen - 8, "-default") &&
478 strcmp(option->name + namelen - 10, "-supported")))
479 {
480 if (group_tag != IPP_TAG_JOB && group_tag != IPP_TAG_DOCUMENT)
481 {
482 DEBUG_printf(("2cupsEncodeOptions2: Skipping \"%s\".", option->name));
483 continue;
484 }
485 }
486 else if (group_tag != IPP_TAG_PRINTER)
487 {
488 DEBUG_printf(("2cupsEncodeOptions2: Skipping \"%s\".", option->name));
489 continue;
490 }
491
492 if (group_tag == IPP_TAG_JOB)
493 ops = ipp_job_creation;
494 else if (group_tag == IPP_TAG_DOCUMENT)
495 ops = ipp_doc_creation;
496 else
497 ops = ipp_set_printer;
498
499 if (!_cups_strcasecmp(option->value, "true") ||
500 !_cups_strcasecmp(option->value, "false"))
501 value_tag = IPP_TAG_BOOLEAN;
502 else
503 value_tag = IPP_TAG_NAME;
504 }
505
506 /*
507 * Verify that we send this attribute for this operation...
508 */
509
510 while (*ops != IPP_OP_CUPS_NONE)
511 if (op == *ops)
512 break;
513 else
514 ops ++;
515
516 if (*ops == IPP_OP_CUPS_NONE && op != IPP_OP_CUPS_NONE)
517 {
518 DEBUG_printf(("2cupsEncodeOptions2: Skipping \"%s\".", option->name));
519 continue;
520 }
521
522 /*
523 * Count the number of values...
524 */
525
526 if (match && match->multivalue)
527 {
528 for (count = 1, sep = option->value, quote = 0; *sep; sep ++)
529 {
530 if (*sep == quote)
531 quote = 0;
532 else if (!quote && (*sep == '\'' || *sep == '\"'))
533 {
534 /*
535 * Skip quoted option value...
536 */
537
538 quote = *sep++;
539 }
540 else if (*sep == ',' && !quote)
541 count ++;
542 else if (*sep == '\\' && sep[1])
543 sep += 2;
544 }
545 }
546 else
547 count = 1;
548
549 DEBUG_printf(("2cupsEncodeOptions2: option=\"%s\", value=\"%s\", count=%d", option->name, option->value, count));
550
551 /*
552 * Allocate memory for the attribute values...
553 */
554
555 if ((attr = ippAddStrings(ipp, group_tag, value_tag, option->name, count,
556 NULL, NULL)) == NULL)
557 {
558 /*
559 * Ran out of memory!
560 */
561
562 DEBUG_puts("1cupsEncodeOptions2: Ran out of memory for attributes!");
563 return;
564 }
565
566 if (count > 1)
567 {
568 /*
569 * Make a copy of the value we can fiddle with...
570 */
571
572 if ((copy = strdup(option->value)) == NULL)
573 {
574 /*
575 * Ran out of memory!
576 */
577
578 DEBUG_puts("1cupsEncodeOptions2: Ran out of memory for value copy!");
579 ippDeleteAttribute(ipp, attr);
580 return;
581 }
582
583 val = copy;
584 }
585 else
586 {
587 /*
588 * Since we have a single value, use the value directly...
589 */
590
591 val = option->value;
592 copy = NULL;
593 }
594
595 /*
596 * Scan the value string for values...
597 */
598
599 for (j = 0, sep = val; j < count; val = sep, j ++)
600 {
601 /*
602 * Find the end of this value and mark it if needed...
603 */
604
605 if (count > 1)
606 {
607 for (quote = 0; *sep; sep ++)
608 {
609 if (*sep == quote)
610 {
611 /*
612 * Finish quoted value...
613 */
614
615 quote = 0;
616 }
617 else if (!quote && (*sep == '\'' || *sep == '\"'))
618 {
619 /*
620 * Handle quoted option value...
621 */
622
623 quote = *sep;
624 }
625 else if (*sep == ',' && count > 1)
626 break;
627 else if (*sep == '\\' && sep[1])
628 {
629 /*
630 * Skip quoted character...
631 */
632
633 memmove(sep, sep + 1, strlen(sep));
634 sep ++;
635 }
636 }
637
638 if (*sep == ',')
639 *sep++ = '\0';
640 }
641
642 /*
643 * Copy the option value(s) over as needed by the type...
644 */
645
646 switch (attr->value_tag)
647 {
648 case IPP_TAG_INTEGER :
649 case IPP_TAG_ENUM :
650 /*
651 * Integer/enumeration value...
652 */
653
654 attr->values[j].integer = (int)strtol(val, &s, 10);
655
656 DEBUG_printf(("2cupsEncodeOptions2: Added integer option value "
657 "%d...", attr->values[j].integer));
658 break;
659
660 case IPP_TAG_BOOLEAN :
661 if (!_cups_strcasecmp(val, "true") ||
662 !_cups_strcasecmp(val, "on") ||
663 !_cups_strcasecmp(val, "yes"))
664 {
665 /*
666 * Boolean value - true...
667 */
668
669 attr->values[j].boolean = 1;
670
671 DEBUG_puts("2cupsEncodeOptions2: Added boolean true value...");
672 }
673 else
674 {
675 /*
676 * Boolean value - false...
677 */
678
679 attr->values[j].boolean = 0;
680
681 DEBUG_puts("2cupsEncodeOptions2: Added boolean false value...");
682 }
683 break;
684
685 case IPP_TAG_RANGE :
686 /*
687 * Range...
688 */
689
690 if (*val == '-')
691 {
692 attr->values[j].range.lower = 1;
693 s = val;
694 }
695 else
696 attr->values[j].range.lower = (int)strtol(val, &s, 10);
697
698 if (*s == '-')
699 {
700 if (s[1])
701 attr->values[j].range.upper = (int)strtol(s + 1, NULL, 10);
702 else
703 attr->values[j].range.upper = 2147483647;
704 }
705 else
706 attr->values[j].range.upper = attr->values[j].range.lower;
707
708 DEBUG_printf(("2cupsEncodeOptions2: Added range option value "
709 "%d-%d...", attr->values[j].range.lower,
710 attr->values[j].range.upper));
711 break;
712
713 case IPP_TAG_RESOLUTION :
714 /*
715 * Resolution...
716 */
717
718 attr->values[j].resolution.xres = (int)strtol(val, &s, 10);
719
720 if (*s == 'x')
721 attr->values[j].resolution.yres = (int)strtol(s + 1, &s, 10);
722 else
723 attr->values[j].resolution.yres = attr->values[j].resolution.xres;
724
725 if (!_cups_strcasecmp(s, "dpc") ||
726 !_cups_strcasecmp(s, "dpcm"))
727 attr->values[j].resolution.units = IPP_RES_PER_CM;
728 else
729 attr->values[j].resolution.units = IPP_RES_PER_INCH;
730
731 DEBUG_printf(("2cupsEncodeOptions2: Added resolution option value "
732 "%s...", val));
733 break;
734
735 case IPP_TAG_STRING :
736 /*
737 * octet-string
738 */
739
740 attr->values[j].unknown.length = (int)strlen(val);
741 attr->values[j].unknown.data = strdup(val);
742
743 DEBUG_printf(("2cupsEncodeOptions2: Added octet-string value "
744 "\"%s\"...", (char *)attr->values[j].unknown.data));
745 break;
746
747 case IPP_TAG_BEGIN_COLLECTION :
748 /*
749 * Collection value
750 */
751
752 num_cols = cupsParseOptions(val, 0, &cols);
753 if ((collection = ippNew()) == NULL)
754 {
755 cupsFreeOptions(num_cols, cols);
756
757 if (copy)
758 free(copy);
759
760 ippDeleteAttribute(ipp, attr);
761 return;
762 }
763
764 attr->values[j].collection = collection;
765 cupsEncodeOptions2(collection, num_cols, cols, IPP_TAG_JOB);
766 cupsFreeOptions(num_cols, cols);
767 break;
768
769 default :
770 if ((attr->values[j].string.text = _cupsStrAlloc(val)) == NULL)
771 {
772 /*
773 * Ran out of memory!
774 */
775
776 DEBUG_puts("1cupsEncodeOptions2: Ran out of memory for string!");
777
778 if (copy)
779 free(copy);
780
781 ippDeleteAttribute(ipp, attr);
782 return;
783 }
784
785 DEBUG_printf(("2cupsEncodeOptions2: Added string value \"%s\"...",
786 val));
787 break;
788 }
789 }
790
791 if (copy)
792 free(copy);
793 }
794 }
795
796
797 #ifdef DEBUG
798 /*
799 * '_ippCheckOptions()' - Validate that the option array is sorted properly.
800 */
801
802 const char * /* O - First out-of-order option or NULL */
803 _ippCheckOptions(void)
804 {
805 int i; /* Looping var */
806
807
808 for (i = 0; i < (int)(sizeof(ipp_options) / sizeof(ipp_options[0]) - 1); i ++)
809 if (strcmp(ipp_options[i].name, ipp_options[i + 1].name) >= 0)
810 return (ipp_options[i + 1].name);
811
812 return (NULL);
813 }
814 #endif /* DEBUG */
815
816
817 /*
818 * '_ippFindOption()' - Find the attribute information for an option.
819 */
820
821 _ipp_option_t * /* O - Attribute information */
822 _ippFindOption(const char *name) /* I - Option/attribute name */
823 {
824 _ipp_option_t key; /* Search key */
825
826
827 /*
828 * Lookup the proper value and group tags for this option...
829 */
830
831 key.name = name;
832
833 return ((_ipp_option_t *)bsearch(&key, ipp_options,
834 sizeof(ipp_options) / sizeof(ipp_options[0]),
835 sizeof(ipp_options[0]),
836 (int (*)(const void *, const void *))
837 compare_ipp_options));
838 }
839
840
841 /*
842 * 'compare_ipp_options()' - Compare two IPP options.
843 */
844
845 static int /* O - Result of comparison */
846 compare_ipp_options(_ipp_option_t *a, /* I - First option */
847 _ipp_option_t *b) /* I - Second option */
848 {
849 return (strcmp(a->name, b->name));
850 }
Unnamed repository; edit this file 'description' to name the repository.