2 * Option encoding routines for CUPS.
4 * Copyright 2007-2017 by Apple Inc.
5 * Copyright 1997-2007 by Easy Software Products.
7 * Licensed under Apache License v2.0. See the file "LICENSE" for more information.
11 * Include necessary headers...
14 #include "cups-private.h"
18 * Local list of option names, the value tags they should use, and the list of
19 * supported operations...
21 * **** THIS LIST MUST BE SORTED BY ATTRIBUTE NAME ****
24 static const ipp_op_t ipp_job_creation
[] =
31 IPP_OP_SET_JOB_ATTRIBUTES
,
35 static const ipp_op_t ipp_doc_creation
[] =
41 IPP_OP_SET_JOB_ATTRIBUTES
,
42 IPP_OP_SET_DOCUMENT_ATTRIBUTES
,
46 static const ipp_op_t ipp_sub_creation
[] =
51 IPP_OP_CREATE_PRINTER_SUBSCRIPTIONS
,
52 IPP_OP_CREATE_JOB_SUBSCRIPTIONS
,
56 static const ipp_op_t ipp_all_print
[] =
67 static const ipp_op_t ipp_set_printer
[] =
69 IPP_OP_SET_PRINTER_ATTRIBUTES
,
70 IPP_OP_CUPS_ADD_MODIFY_PRINTER
,
71 IPP_OP_CUPS_ADD_MODIFY_CLASS
,
75 static const ipp_op_t cups_schemes
[] =
77 IPP_OP_CUPS_GET_DEVICES
,
82 static const ipp_op_t cups_get_ppds
[] =
88 static const ipp_op_t cups_ppd_name
[] =
90 IPP_OP_CUPS_ADD_MODIFY_PRINTER
,
95 static const _ipp_option_t ipp_options
[] =
97 { 1, "auth-info", IPP_TAG_TEXT
, IPP_TAG_JOB
},
98 { 1, "auth-info-default", IPP_TAG_TEXT
, IPP_TAG_PRINTER
},
99 { 1, "auth-info-required", IPP_TAG_KEYWORD
, IPP_TAG_PRINTER
},
100 { 0, "blackplot", IPP_TAG_BOOLEAN
, IPP_TAG_JOB
},
101 { 0, "blackplot-default", IPP_TAG_BOOLEAN
, IPP_TAG_PRINTER
},
102 { 0, "brightness", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
103 { 0, "brightness-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
104 { 0, "columns", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
105 { 0, "columns-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
106 { 0, "compression", IPP_TAG_KEYWORD
, IPP_TAG_OPERATION
,
109 { 0, "copies", IPP_TAG_INTEGER
, IPP_TAG_JOB
,
111 { 0, "copies-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
112 { 0, "date-time-at-completed",IPP_TAG_DATE
, IPP_TAG_ZERO
}, /* never send as option */
113 { 0, "date-time-at-creation", IPP_TAG_DATE
, IPP_TAG_ZERO
}, /* never send as option */
114 { 0, "date-time-at-processing",IPP_TAG_DATE
, IPP_TAG_ZERO
}, /* never send as option */
115 { 0, "device-uri", IPP_TAG_URI
, IPP_TAG_PRINTER
},
116 { 1, "document-copies", IPP_TAG_RANGE
, IPP_TAG_JOB
,
119 { 0, "document-format", IPP_TAG_MIMETYPE
, IPP_TAG_OPERATION
,
122 { 0, "document-format-default", IPP_TAG_MIMETYPE
, IPP_TAG_PRINTER
},
123 { 1, "document-numbers", IPP_TAG_RANGE
, IPP_TAG_JOB
,
126 { 1, "exclude-schemes", IPP_TAG_NAME
, IPP_TAG_OPERATION
,
129 { 1, "finishings", IPP_TAG_ENUM
, IPP_TAG_JOB
,
131 { 1, "finishings-default", IPP_TAG_ENUM
, IPP_TAG_PRINTER
},
132 { 0, "fit-to-page", IPP_TAG_BOOLEAN
, IPP_TAG_JOB
,
134 { 0, "fit-to-page-default", IPP_TAG_BOOLEAN
, IPP_TAG_PRINTER
},
135 { 0, "fitplot", IPP_TAG_BOOLEAN
, IPP_TAG_JOB
},
136 { 0, "fitplot-default", IPP_TAG_BOOLEAN
, IPP_TAG_PRINTER
},
137 { 0, "gamma", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
138 { 0, "gamma-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
139 { 0, "hue", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
140 { 0, "hue-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
141 { 1, "include-schemes", IPP_TAG_NAME
, IPP_TAG_OPERATION
,
144 { 0, "job-account-id", IPP_TAG_NAME
, IPP_TAG_JOB
},
145 { 0, "job-account-id-default",IPP_TAG_NAME
, IPP_TAG_PRINTER
},
146 { 0, "job-accounting-user-id", IPP_TAG_NAME
, IPP_TAG_JOB
},
147 { 0, "job-accounting-user-id-default", IPP_TAG_NAME
, IPP_TAG_PRINTER
},
148 { 0, "job-authorization-uri", IPP_TAG_URI
, IPP_TAG_OPERATION
},
149 { 0, "job-cancel-after", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
150 { 0, "job-cancel-after-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
151 { 0, "job-hold-until", IPP_TAG_KEYWORD
, IPP_TAG_JOB
},
152 { 0, "job-id", IPP_TAG_INTEGER
, IPP_TAG_ZERO
}, /* never send as option */
153 { 0, "job-impressions", IPP_TAG_INTEGER
, IPP_TAG_OPERATION
},
154 { 0, "job-impressions-completed", IPP_TAG_INTEGER
, IPP_TAG_ZERO
}, /* never send as option */
155 { 0, "job-k-limit", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
156 { 0, "job-k-octets", IPP_TAG_INTEGER
, IPP_TAG_OPERATION
},
157 { 0, "job-k-octets-completed",IPP_TAG_INTEGER
, IPP_TAG_ZERO
}, /* never send as option */
158 { 0, "job-media-sheets", IPP_TAG_INTEGER
, IPP_TAG_OPERATION
},
159 { 0, "job-media-sheets-completed", IPP_TAG_INTEGER
, IPP_TAG_ZERO
}, /* never send as option */
160 { 0, "job-page-limit", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
161 { 0, "job-pages", IPP_TAG_INTEGER
, IPP_TAG_OPERATION
},
162 { 0, "job-pages-completed", IPP_TAG_INTEGER
, IPP_TAG_ZERO
}, /* never send as option */
163 { 0, "job-password", IPP_TAG_STRING
, IPP_TAG_OPERATION
,
166 { 0, "job-password-encryption", IPP_TAG_KEYWORD
, IPP_TAG_OPERATION
,
169 { 0, "job-priority", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
170 { 0, "job-quota-period", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
171 { 1, "job-sheets", IPP_TAG_NAME
, IPP_TAG_JOB
},
172 { 1, "job-sheets-default", IPP_TAG_NAME
, IPP_TAG_PRINTER
},
173 { 0, "job-state", IPP_TAG_ENUM
, IPP_TAG_ZERO
}, /* never send as option */
174 { 0, "job-state-message", IPP_TAG_TEXT
, IPP_TAG_ZERO
}, /* never send as option */
175 { 0, "job-state-reasons", IPP_TAG_KEYWORD
, IPP_TAG_ZERO
}, /* never send as option */
176 { 0, "job-uuid", IPP_TAG_URI
, IPP_TAG_JOB
},
177 { 0, "landscape", IPP_TAG_BOOLEAN
, IPP_TAG_JOB
},
178 { 1, "marker-change-time", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
179 { 1, "marker-colors", IPP_TAG_NAME
, IPP_TAG_PRINTER
},
180 { 1, "marker-high-levels", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
181 { 1, "marker-levels", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
182 { 1, "marker-low-levels", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
183 { 0, "marker-message", IPP_TAG_TEXT
, IPP_TAG_PRINTER
},
184 { 1, "marker-names", IPP_TAG_NAME
, IPP_TAG_PRINTER
},
185 { 1, "marker-types", IPP_TAG_KEYWORD
, IPP_TAG_PRINTER
},
186 { 1, "media", IPP_TAG_KEYWORD
, IPP_TAG_JOB
,
188 { 0, "media-bottom-margin", IPP_TAG_INTEGER
, IPP_TAG_JOB
,
190 { 0, "media-col", IPP_TAG_BEGIN_COLLECTION
, IPP_TAG_JOB
,
192 { 0, "media-col-default", IPP_TAG_BEGIN_COLLECTION
, IPP_TAG_PRINTER
},
193 { 0, "media-color", IPP_TAG_KEYWORD
, IPP_TAG_JOB
,
195 { 1, "media-default", IPP_TAG_KEYWORD
, IPP_TAG_PRINTER
},
196 { 0, "media-key", IPP_TAG_KEYWORD
, IPP_TAG_JOB
,
198 { 0, "media-left-margin", IPP_TAG_INTEGER
, IPP_TAG_JOB
,
200 { 0, "media-right-margin", IPP_TAG_INTEGER
, IPP_TAG_JOB
,
202 { 0, "media-size", IPP_TAG_BEGIN_COLLECTION
, IPP_TAG_JOB
,
204 { 0, "media-size-name", IPP_TAG_KEYWORD
, IPP_TAG_JOB
,
206 { 0, "media-source", IPP_TAG_KEYWORD
, IPP_TAG_JOB
,
208 { 0, "media-top-margin", IPP_TAG_INTEGER
, IPP_TAG_JOB
,
210 { 0, "media-type", IPP_TAG_KEYWORD
, IPP_TAG_JOB
,
212 { 0, "mirror", IPP_TAG_BOOLEAN
, IPP_TAG_JOB
},
213 { 0, "mirror-default", IPP_TAG_BOOLEAN
, IPP_TAG_PRINTER
},
214 { 0, "natural-scaling", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
215 { 0, "natural-scaling-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
216 { 0, "notify-charset", IPP_TAG_CHARSET
, IPP_TAG_SUBSCRIPTION
},
217 { 1, "notify-events", IPP_TAG_KEYWORD
, IPP_TAG_SUBSCRIPTION
},
218 { 1, "notify-events-default", IPP_TAG_KEYWORD
, IPP_TAG_PRINTER
},
219 { 0, "notify-lease-duration", IPP_TAG_INTEGER
, IPP_TAG_SUBSCRIPTION
},
220 { 0, "notify-lease-duration-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
221 { 0, "notify-natural-language", IPP_TAG_LANGUAGE
, IPP_TAG_SUBSCRIPTION
},
222 { 0, "notify-pull-method", IPP_TAG_KEYWORD
, IPP_TAG_SUBSCRIPTION
},
223 { 0, "notify-recipient-uri", IPP_TAG_URI
, IPP_TAG_SUBSCRIPTION
},
224 { 0, "notify-time-interval", IPP_TAG_INTEGER
, IPP_TAG_SUBSCRIPTION
},
225 { 0, "notify-user-data", IPP_TAG_STRING
, IPP_TAG_SUBSCRIPTION
},
226 { 0, "number-up", IPP_TAG_INTEGER
, IPP_TAG_JOB
,
228 { 0, "number-up-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
229 { 0, "orientation-requested", IPP_TAG_ENUM
, IPP_TAG_JOB
,
231 { 0, "orientation-requested-default", IPP_TAG_ENUM
, IPP_TAG_PRINTER
},
232 { 1, "overrides", IPP_TAG_BEGIN_COLLECTION
, IPP_TAG_JOB
,
234 { 0, "page-bottom", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
235 { 0, "page-bottom-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
236 { 0, "page-left", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
237 { 0, "page-left-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
238 { 1, "page-ranges", IPP_TAG_RANGE
, IPP_TAG_JOB
,
240 { 1, "page-ranges-default", IPP_TAG_RANGE
, IPP_TAG_PRINTER
},
241 { 0, "page-right", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
242 { 0, "page-right-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
243 { 0, "page-top", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
244 { 0, "page-top-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
245 { 1, "pages", IPP_TAG_RANGE
, IPP_TAG_JOB
,
247 { 0, "penwidth", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
248 { 0, "penwidth-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
249 { 0, "port-monitor", IPP_TAG_NAME
, IPP_TAG_PRINTER
},
250 { 0, "ppd-device-id", IPP_TAG_TEXT
, IPP_TAG_OPERATION
,
253 { 0, "ppd-make", IPP_TAG_TEXT
, IPP_TAG_OPERATION
,
256 { 0, "ppd-make-and-model", IPP_TAG_TEXT
, IPP_TAG_OPERATION
,
259 { 0, "ppd-model-number", IPP_TAG_INTEGER
, IPP_TAG_OPERATION
,
262 { 0, "ppd-name", IPP_TAG_NAME
, IPP_TAG_OPERATION
,
265 { 0, "ppd-natural-language", IPP_TAG_LANGUAGE
, IPP_TAG_OPERATION
,
268 { 0, "ppd-product", IPP_TAG_TEXT
, IPP_TAG_OPERATION
,
271 { 0, "ppd-psversion", IPP_TAG_TEXT
, IPP_TAG_OPERATION
,
274 { 0, "ppd-type", IPP_TAG_KEYWORD
, IPP_TAG_OPERATION
,
277 { 0, "ppi", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
278 { 0, "ppi-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
279 { 0, "prettyprint", IPP_TAG_BOOLEAN
, IPP_TAG_JOB
},
280 { 0, "prettyprint-default", IPP_TAG_BOOLEAN
, IPP_TAG_PRINTER
},
281 { 0, "print-quality", IPP_TAG_ENUM
, IPP_TAG_JOB
,
283 { 0, "print-quality-default", IPP_TAG_ENUM
, IPP_TAG_PRINTER
},
284 { 1, "printer-commands", IPP_TAG_KEYWORD
, IPP_TAG_PRINTER
},
285 { 0, "printer-error-policy", IPP_TAG_NAME
, IPP_TAG_PRINTER
},
286 { 0, "printer-geo-location", IPP_TAG_URI
, IPP_TAG_PRINTER
},
287 { 0, "printer-info", IPP_TAG_TEXT
, IPP_TAG_PRINTER
},
288 { 0, "printer-is-accepting-jobs", IPP_TAG_BOOLEAN
, IPP_TAG_PRINTER
},
289 { 0, "printer-is-shared", IPP_TAG_BOOLEAN
, IPP_TAG_PRINTER
},
290 { 0, "printer-is-temporary", IPP_TAG_BOOLEAN
, IPP_TAG_PRINTER
},
291 { 0, "printer-location", IPP_TAG_TEXT
, IPP_TAG_PRINTER
},
292 { 0, "printer-make-and-model", IPP_TAG_TEXT
, IPP_TAG_PRINTER
},
293 { 0, "printer-more-info", IPP_TAG_URI
, IPP_TAG_PRINTER
},
294 { 0, "printer-op-policy", IPP_TAG_NAME
, IPP_TAG_PRINTER
},
295 { 0, "printer-resolution", IPP_TAG_RESOLUTION
, IPP_TAG_JOB
,
297 { 0, "printer-state", IPP_TAG_ENUM
, IPP_TAG_PRINTER
},
298 { 0, "printer-state-change-time", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
299 { 1, "printer-state-reasons", IPP_TAG_KEYWORD
, IPP_TAG_PRINTER
},
300 { 0, "printer-type", IPP_TAG_ENUM
, IPP_TAG_PRINTER
},
301 { 0, "printer-uri", IPP_TAG_URI
, IPP_TAG_OPERATION
},
302 { 1, "printer-uri-supported", IPP_TAG_URI
, IPP_TAG_PRINTER
},
303 { 0, "queued-job-count", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
304 { 0, "raw", IPP_TAG_MIMETYPE
, IPP_TAG_OPERATION
},
305 { 1, "requested-attributes", IPP_TAG_NAME
, IPP_TAG_OPERATION
},
306 { 1, "requesting-user-name-allowed", IPP_TAG_NAME
, IPP_TAG_PRINTER
},
307 { 1, "requesting-user-name-denied", IPP_TAG_NAME
, IPP_TAG_PRINTER
},
308 { 0, "resolution", IPP_TAG_RESOLUTION
, IPP_TAG_JOB
},
309 { 0, "resolution-default", IPP_TAG_RESOLUTION
, IPP_TAG_PRINTER
},
310 { 0, "saturation", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
311 { 0, "saturation-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
312 { 0, "scaling", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
313 { 0, "scaling-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
314 { 0, "sides", IPP_TAG_KEYWORD
, IPP_TAG_JOB
,
316 { 0, "sides-default", IPP_TAG_KEYWORD
, IPP_TAG_PRINTER
},
317 { 0, "time-at-completed", IPP_TAG_INTEGER
, IPP_TAG_ZERO
}, /* never send as option */
318 { 0, "time-at-creation", IPP_TAG_INTEGER
, IPP_TAG_ZERO
}, /* never send as option */
319 { 0, "time-at-processing", IPP_TAG_INTEGER
, IPP_TAG_ZERO
}, /* never send as option */
320 { 0, "wrap", IPP_TAG_BOOLEAN
, IPP_TAG_JOB
},
321 { 0, "wrap-default", IPP_TAG_BOOLEAN
, IPP_TAG_PRINTER
},
322 { 0, "x-dimension", IPP_TAG_INTEGER
, IPP_TAG_JOB
,
324 { 0, "y-dimension", IPP_TAG_INTEGER
, IPP_TAG_JOB
,
333 static int compare_ipp_options(_ipp_option_t
*a
, _ipp_option_t
*b
);
337 * '_cupsEncodeOption()' - Encode a single option as an IPP attribute.
342 ipp_t
*ipp
, /* I - IPP request/response/collection */
343 ipp_tag_t group_tag
, /* I - Group tag */
344 _ipp_option_t
*map
, /* I - Option mapping, if any */
345 const char *name
, /* I - Attribute name */
346 const char *value
) /* I - Value */
348 int i
, /* Looping var */
349 count
; /* Number of values */
350 char *s
, /* Pointer into option value */
351 *val
, /* Pointer to option value */
352 *copy
, /* Copy of option value */
353 *sep
, /* Option separator */
354 quote
; /* Quote character */
355 ipp_attribute_t
*attr
; /* IPP attribute */
356 ipp_tag_t value_tag
; /* IPP value tag */
357 ipp_t
*collection
; /* Collection value */
358 int num_cols
; /* Number of collection values */
359 cups_option_t
*cols
; /* Collection values */
362 DEBUG_printf(("_cupsEncodeOption(ipp=%p(%s), group=%s, map=%p, name=\"%s\", value=\"%s\")", (void *)ipp
, ipp
? ippOpString(ippGetOperation(ipp
)) : "", ippTagString(group_tag
), (void *)map
, name
, value
));
365 * Figure out the attribute syntax for encoding...
369 map
= _ippFindOption(name
);
372 value_tag
= map
->value_tag
;
373 else if (!_cups_strcasecmp(value
, "true") || !_cups_strcasecmp(value
, "false"))
374 value_tag
= IPP_TAG_BOOLEAN
;
375 else if (value
[0] == '{')
376 value_tag
= IPP_TAG_BEGIN_COLLECTION
;
378 value_tag
= IPP_TAG_NAME
;
381 * Count the number of values...
384 if (map
&& map
->multivalue
)
386 for (count
= 1, sep
= (char *)value
, quote
= 0; *sep
; sep
++)
390 else if (!quote
&& (*sep
== '\'' || *sep
== '\"'))
393 * Skip quoted option value...
398 else if (*sep
== ',' && !quote
)
400 else if (*sep
== '\\' && sep
[1])
407 DEBUG_printf(("2_cupsEncodeOption: value_tag=%s, count=%d", ippTagString(value_tag
), count
));
410 * Allocate memory for the attribute values...
413 if ((attr
= ippAddStrings(ipp
, group_tag
, value_tag
, name
, count
, NULL
, NULL
)) == NULL
)
419 DEBUG_puts("1_cupsEncodeOption: Ran out of memory for attributes.");
426 * Make a copy of the value we can fiddle with...
429 if ((copy
= strdup(value
)) == NULL
)
435 DEBUG_puts("1_cupsEncodeOption: Ran out of memory for value copy.");
436 ippDeleteAttribute(ipp
, attr
);
445 * Since we have a single value, use the value directly...
453 * Scan the value string for values...
456 for (i
= 0, sep
= val
; i
< count
; val
= sep
, i
++)
459 * Find the end of this value and mark it if needed...
464 for (quote
= 0; *sep
; sep
++)
469 * Finish quoted value...
474 else if (!quote
&& (*sep
== '\'' || *sep
== '\"'))
477 * Handle quoted option value...
482 else if (*sep
== ',' && count
> 1)
484 else if (*sep
== '\\' && sep
[1])
487 * Skip quoted character...
490 memmove(sep
, sep
+ 1, strlen(sep
));
499 * Copy the option value(s) over as needed by the type...
502 switch (attr
->value_tag
)
504 case IPP_TAG_INTEGER
:
507 * Integer/enumeration value...
510 ippSetInteger(ipp
, &attr
, i
, (int)strtol(val
, &s
, 10));
513 case IPP_TAG_BOOLEAN
:
514 if (!_cups_strcasecmp(val
, "true") || !_cups_strcasecmp(val
, "on") || !_cups_strcasecmp(val
, "yes"))
517 * Boolean value - true...
520 ippSetBoolean(ipp
, &attr
, i
, 1);
525 * Boolean value - false...
528 ippSetBoolean(ipp
, &attr
, i
, 0);
538 int lower
, upper
; /* Lower and upper ranges... */
546 lower
= (int)strtol(val
, &s
, 10);
551 upper
= (int)strtol(s
+ 1, NULL
, 10);
558 ippSetRange(ipp
, &attr
, i
, lower
, upper
);
562 case IPP_TAG_RESOLUTION
:
567 int xres
, yres
; /* Resolution values */
568 ipp_res_t units
; /* Resolution units */
570 xres
= (int)strtol(val
, &s
, 10);
573 yres
= (int)strtol(s
+ 1, &s
, 10);
577 if (!_cups_strcasecmp(s
, "dpc") || !_cups_strcasecmp(s
, "dpcm"))
578 units
= IPP_RES_PER_CM
;
580 units
= IPP_RES_PER_INCH
;
582 ippSetResolution(ipp
, &attr
, i
, units
, xres
, yres
);
586 case IPP_TAG_STRING
:
591 ippSetOctetString(ipp
, &attr
, i
, val
, (int)strlen(val
));
594 case IPP_TAG_BEGIN_COLLECTION
:
599 num_cols
= cupsParseOptions(val
, 0, &cols
);
600 if ((collection
= ippNew()) == NULL
)
602 cupsFreeOptions(num_cols
, cols
);
607 ippDeleteAttribute(ipp
, attr
);
611 ippSetCollection(ipp
, &attr
, i
, collection
);
612 cupsEncodeOptions2(collection
, num_cols
, cols
, IPP_TAG_JOB
);
613 cupsFreeOptions(num_cols
, cols
);
617 ippSetString(ipp
, &attr
, i
, val
);
628 * 'cupsEncodeOptions()' - Encode printer options into IPP attributes.
630 * This function adds operation, job, and then subscription attributes,
631 * in that order. Use the @link cupsEncodeOptions2@ function to add attributes
632 * for a single group.
636 cupsEncodeOptions(ipp_t
*ipp
, /* I - Request to add to */
637 int num_options
, /* I - Number of options */
638 cups_option_t
*options
) /* I - Options */
640 DEBUG_printf(("cupsEncodeOptions(%p, %d, %p)", (void *)ipp
, num_options
, (void *)options
));
643 * Add the options in the proper groups & order...
646 cupsEncodeOptions2(ipp
, num_options
, options
, IPP_TAG_OPERATION
);
647 cupsEncodeOptions2(ipp
, num_options
, options
, IPP_TAG_JOB
);
648 cupsEncodeOptions2(ipp
, num_options
, options
, IPP_TAG_SUBSCRIPTION
);
653 * 'cupsEncodeOptions2()' - Encode printer options into IPP attributes for a group.
655 * This function only adds attributes for a single group. Call this
656 * function multiple times for each group, or use @link cupsEncodeOptions@
657 * to add the standard groups.
659 * @since CUPS 1.2/macOS 10.5@
664 ipp_t
*ipp
, /* I - Request to add to */
665 int num_options
, /* I - Number of options */
666 cups_option_t
*options
, /* I - Options */
667 ipp_tag_t group_tag
) /* I - Group to encode */
669 int i
; /* Looping var */
670 char *val
; /* Pointer to option value */
671 cups_option_t
*option
; /* Current option */
672 ipp_op_t op
; /* Operation for this request */
673 const ipp_op_t
*ops
; /* List of allowed operations */
676 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
));
679 * Range check input...
682 if (!ipp
|| num_options
< 1 || !options
)
686 * Do special handling for the document-format/raw options...
689 op
= ippGetOperation(ipp
);
691 if (group_tag
== IPP_TAG_OPERATION
&& (op
== IPP_OP_PRINT_JOB
|| op
== IPP_OP_PRINT_URI
|| op
== IPP_OP_SEND_DOCUMENT
|| op
== IPP_OP_SEND_URI
))
694 * Handle the document format stuff first...
697 if ((val
= (char *)cupsGetOption("document-format", num_options
, options
)) != NULL
)
698 ippAddString(ipp
, IPP_TAG_OPERATION
, IPP_TAG_MIMETYPE
, "document-format", NULL
, val
);
699 else if (cupsGetOption("raw", num_options
, options
))
700 ippAddString(ipp
, IPP_TAG_OPERATION
, IPP_TAG_MIMETYPE
, "document-format", NULL
, "application/vnd.cups-raw");
702 ippAddString(ipp
, IPP_TAG_OPERATION
, IPP_TAG_MIMETYPE
, "document-format", NULL
, "application/octet-stream");
706 * Then loop through the options...
709 for (i
= num_options
, option
= options
; i
> 0; i
--, option
++)
711 _ipp_option_t
*match
; /* Matching attribute */
714 * Skip document format options that are handled above...
717 if (!_cups_strcasecmp(option
->name
, "raw") || !_cups_strcasecmp(option
->name
, "document-format") || !option
->name
[0])
721 * Figure out the proper value and group tags for this option...
724 if ((match
= _ippFindOption(option
->name
)) != NULL
)
726 if (match
->group_tag
!= group_tag
&& match
->alt_group_tag
!= group_tag
)
729 if (match
->operations
)
730 ops
= match
->operations
;
731 else if (group_tag
== IPP_TAG_JOB
)
732 ops
= ipp_job_creation
;
733 else if (group_tag
== IPP_TAG_DOCUMENT
)
734 ops
= ipp_doc_creation
;
735 else if (group_tag
== IPP_TAG_SUBSCRIPTION
)
736 ops
= ipp_sub_creation
;
737 else if (group_tag
== IPP_TAG_PRINTER
)
738 ops
= ipp_set_printer
;
741 DEBUG_printf(("2cupsEncodeOptions2: Skipping \"%s\".", option
->name
));
747 int namelen
; /* Length of name */
749 namelen
= (int)strlen(option
->name
);
751 if (namelen
< 10 || (strcmp(option
->name
+ namelen
- 8, "-default") && strcmp(option
->name
+ namelen
- 10, "-supported")))
753 if (group_tag
!= IPP_TAG_JOB
&& group_tag
!= IPP_TAG_DOCUMENT
)
755 DEBUG_printf(("2cupsEncodeOptions2: Skipping \"%s\".", option
->name
));
759 else if (group_tag
!= IPP_TAG_PRINTER
)
761 DEBUG_printf(("2cupsEncodeOptions2: Skipping \"%s\".", option
->name
));
765 if (group_tag
== IPP_TAG_JOB
)
766 ops
= ipp_job_creation
;
767 else if (group_tag
== IPP_TAG_DOCUMENT
)
768 ops
= ipp_doc_creation
;
770 ops
= ipp_set_printer
;
774 * Verify that we send this attribute for this operation...
777 while (*ops
!= IPP_OP_CUPS_NONE
)
783 if (*ops
== IPP_OP_CUPS_NONE
&& op
!= IPP_OP_CUPS_NONE
)
785 DEBUG_printf(("2cupsEncodeOptions2: Skipping \"%s\".", option
->name
));
789 _cupsEncodeOption(ipp
, group_tag
, match
, option
->name
, option
->value
);
796 * '_ippCheckOptions()' - Validate that the option array is sorted properly.
799 const char * /* O - First out-of-order option or NULL */
800 _ippCheckOptions(void)
802 int i
; /* Looping var */
805 for (i
= 0; i
< (int)(sizeof(ipp_options
) / sizeof(ipp_options
[0]) - 1); i
++)
806 if (strcmp(ipp_options
[i
].name
, ipp_options
[i
+ 1].name
) >= 0)
807 return (ipp_options
[i
+ 1].name
);
815 * '_ippFindOption()' - Find the attribute information for an option.
818 _ipp_option_t
* /* O - Attribute information */
819 _ippFindOption(const char *name
) /* I - Option/attribute name */
821 _ipp_option_t key
; /* Search key */
825 * Lookup the proper value and group tags for this option...
830 return ((_ipp_option_t
*)bsearch(&key
, ipp_options
,
831 sizeof(ipp_options
) / sizeof(ipp_options
[0]),
832 sizeof(ipp_options
[0]),
833 (int (*)(const void *, const void *))
834 compare_ipp_options
));
839 * 'compare_ipp_options()' - Compare two IPP options.
842 static int /* O - Result of comparison */
843 compare_ipp_options(_ipp_option_t
*a
, /* I - First option */
844 _ipp_option_t
*b
) /* I - Second option */
846 return (strcmp(a
->name
, b
->name
));