2 * Option encoding routines for CUPS.
4 * Copyright © 2007-2018 by Apple Inc.
5 * Copyright © 1997-2007 by Easy Software Products.
7 * Licensed under Apache License v2.0. See the file "LICENSE" for more
12 * Include necessary headers...
15 #include "cups-private.h"
19 * Local list of option names, the value tags they should use, and the list of
20 * supported operations...
22 * **** THIS LIST MUST BE SORTED BY ATTRIBUTE NAME ****
25 static const ipp_op_t ipp_job_creation
[] =
32 IPP_OP_SET_JOB_ATTRIBUTES
,
36 static const ipp_op_t ipp_doc_creation
[] =
42 IPP_OP_SET_JOB_ATTRIBUTES
,
43 IPP_OP_SET_DOCUMENT_ATTRIBUTES
,
47 static const ipp_op_t ipp_sub_creation
[] =
52 IPP_OP_CREATE_PRINTER_SUBSCRIPTIONS
,
53 IPP_OP_CREATE_JOB_SUBSCRIPTIONS
,
57 static const ipp_op_t ipp_all_print
[] =
68 static const ipp_op_t ipp_set_printer
[] =
70 IPP_OP_SET_PRINTER_ATTRIBUTES
,
71 IPP_OP_CUPS_ADD_MODIFY_PRINTER
,
72 IPP_OP_CUPS_ADD_MODIFY_CLASS
,
76 static const ipp_op_t cups_schemes
[] =
78 IPP_OP_CUPS_GET_DEVICES
,
83 static const ipp_op_t cups_get_ppds
[] =
89 static const ipp_op_t cups_ppd_name
[] =
91 IPP_OP_CUPS_ADD_MODIFY_PRINTER
,
96 static const _ipp_option_t ipp_options
[] =
98 { 1, "auth-info", IPP_TAG_TEXT
, IPP_TAG_JOB
},
99 { 1, "auth-info-default", IPP_TAG_TEXT
, IPP_TAG_PRINTER
},
100 { 1, "auth-info-required", IPP_TAG_KEYWORD
, IPP_TAG_PRINTER
},
101 { 0, "blackplot", IPP_TAG_BOOLEAN
, IPP_TAG_JOB
},
102 { 0, "blackplot-default", IPP_TAG_BOOLEAN
, IPP_TAG_PRINTER
},
103 { 0, "brightness", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
104 { 0, "brightness-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
105 { 0, "columns", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
106 { 0, "columns-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
107 { 0, "compression", IPP_TAG_KEYWORD
, IPP_TAG_OPERATION
,
110 { 0, "copies", IPP_TAG_INTEGER
, IPP_TAG_JOB
,
112 { 0, "copies-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
113 { 0, "date-time-at-completed",IPP_TAG_DATE
, IPP_TAG_ZERO
}, /* never send as option */
114 { 0, "date-time-at-creation", IPP_TAG_DATE
, IPP_TAG_ZERO
}, /* never send as option */
115 { 0, "date-time-at-processing",IPP_TAG_DATE
, IPP_TAG_ZERO
}, /* never send as option */
116 { 0, "device-uri", IPP_TAG_URI
, IPP_TAG_PRINTER
},
117 { 1, "document-copies", IPP_TAG_RANGE
, IPP_TAG_JOB
,
120 { 0, "document-format", IPP_TAG_MIMETYPE
, IPP_TAG_OPERATION
,
123 { 0, "document-format-default", IPP_TAG_MIMETYPE
, IPP_TAG_PRINTER
},
124 { 1, "document-numbers", IPP_TAG_RANGE
, IPP_TAG_JOB
,
127 { 1, "exclude-schemes", IPP_TAG_NAME
, IPP_TAG_OPERATION
,
130 { 1, "finishings", IPP_TAG_ENUM
, IPP_TAG_JOB
,
132 { 1, "finishings-default", IPP_TAG_ENUM
, IPP_TAG_PRINTER
},
133 { 0, "fit-to-page", IPP_TAG_BOOLEAN
, IPP_TAG_JOB
,
135 { 0, "fit-to-page-default", IPP_TAG_BOOLEAN
, IPP_TAG_PRINTER
},
136 { 0, "fitplot", IPP_TAG_BOOLEAN
, IPP_TAG_JOB
},
137 { 0, "fitplot-default", IPP_TAG_BOOLEAN
, IPP_TAG_PRINTER
},
138 { 0, "gamma", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
139 { 0, "gamma-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
140 { 0, "hue", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
141 { 0, "hue-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
142 { 1, "include-schemes", IPP_TAG_NAME
, IPP_TAG_OPERATION
,
145 { 0, "job-account-id", IPP_TAG_NAME
, IPP_TAG_JOB
},
146 { 0, "job-account-id-default",IPP_TAG_NAME
, IPP_TAG_PRINTER
},
147 { 0, "job-accounting-user-id", IPP_TAG_NAME
, IPP_TAG_JOB
},
148 { 0, "job-accounting-user-id-default", IPP_TAG_NAME
, IPP_TAG_PRINTER
},
149 { 0, "job-authorization-uri", IPP_TAG_URI
, IPP_TAG_OPERATION
},
150 { 0, "job-cancel-after", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
151 { 0, "job-cancel-after-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
152 { 0, "job-hold-until", IPP_TAG_KEYWORD
, IPP_TAG_JOB
},
153 { 0, "job-id", IPP_TAG_INTEGER
, IPP_TAG_ZERO
}, /* never send as option */
154 { 0, "job-impressions", IPP_TAG_INTEGER
, IPP_TAG_OPERATION
},
155 { 0, "job-impressions-completed", IPP_TAG_INTEGER
, IPP_TAG_ZERO
}, /* never send as option */
156 { 0, "job-k-limit", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
157 { 0, "job-k-octets", IPP_TAG_INTEGER
, IPP_TAG_OPERATION
},
158 { 0, "job-k-octets-completed",IPP_TAG_INTEGER
, IPP_TAG_ZERO
}, /* never send as option */
159 { 0, "job-media-sheets", IPP_TAG_INTEGER
, IPP_TAG_OPERATION
},
160 { 0, "job-media-sheets-completed", IPP_TAG_INTEGER
, IPP_TAG_ZERO
}, /* never send as option */
161 { 0, "job-page-limit", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
162 { 0, "job-pages", IPP_TAG_INTEGER
, IPP_TAG_OPERATION
},
163 { 0, "job-pages-completed", IPP_TAG_INTEGER
, IPP_TAG_ZERO
}, /* never send as option */
164 { 0, "job-password", IPP_TAG_STRING
, IPP_TAG_OPERATION
,
167 { 0, "job-password-encryption", IPP_TAG_KEYWORD
, IPP_TAG_OPERATION
,
170 { 0, "job-priority", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
171 { 0, "job-quota-period", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
172 { 1, "job-sheets", IPP_TAG_NAME
, IPP_TAG_JOB
},
173 { 1, "job-sheets-default", IPP_TAG_NAME
, IPP_TAG_PRINTER
},
174 { 0, "job-state", IPP_TAG_ENUM
, IPP_TAG_ZERO
}, /* never send as option */
175 { 0, "job-state-message", IPP_TAG_TEXT
, IPP_TAG_ZERO
}, /* never send as option */
176 { 0, "job-state-reasons", IPP_TAG_KEYWORD
, IPP_TAG_ZERO
}, /* never send as option */
177 { 0, "job-uuid", IPP_TAG_URI
, IPP_TAG_JOB
},
178 { 0, "landscape", IPP_TAG_BOOLEAN
, IPP_TAG_JOB
},
179 { 1, "marker-change-time", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
180 { 1, "marker-colors", IPP_TAG_NAME
, IPP_TAG_PRINTER
},
181 { 1, "marker-high-levels", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
182 { 1, "marker-levels", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
183 { 1, "marker-low-levels", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
184 { 0, "marker-message", IPP_TAG_TEXT
, IPP_TAG_PRINTER
},
185 { 1, "marker-names", IPP_TAG_NAME
, IPP_TAG_PRINTER
},
186 { 1, "marker-types", IPP_TAG_KEYWORD
, IPP_TAG_PRINTER
},
187 { 1, "media", IPP_TAG_KEYWORD
, IPP_TAG_JOB
,
189 { 0, "media-bottom-margin", IPP_TAG_INTEGER
, IPP_TAG_JOB
,
191 { 0, "media-col", IPP_TAG_BEGIN_COLLECTION
, IPP_TAG_JOB
,
193 { 0, "media-col-default", IPP_TAG_BEGIN_COLLECTION
, IPP_TAG_PRINTER
},
194 { 0, "media-color", IPP_TAG_KEYWORD
, IPP_TAG_JOB
,
196 { 1, "media-default", IPP_TAG_KEYWORD
, IPP_TAG_PRINTER
},
197 { 0, "media-key", IPP_TAG_KEYWORD
, IPP_TAG_JOB
,
199 { 0, "media-left-margin", IPP_TAG_INTEGER
, IPP_TAG_JOB
,
201 { 0, "media-right-margin", IPP_TAG_INTEGER
, IPP_TAG_JOB
,
203 { 0, "media-size", IPP_TAG_BEGIN_COLLECTION
, IPP_TAG_JOB
,
205 { 0, "media-size-name", IPP_TAG_KEYWORD
, IPP_TAG_JOB
,
207 { 0, "media-source", IPP_TAG_KEYWORD
, IPP_TAG_JOB
,
209 { 0, "media-top-margin", IPP_TAG_INTEGER
, IPP_TAG_JOB
,
211 { 0, "media-type", IPP_TAG_KEYWORD
, IPP_TAG_JOB
,
213 { 0, "mirror", IPP_TAG_BOOLEAN
, IPP_TAG_JOB
},
214 { 0, "mirror-default", IPP_TAG_BOOLEAN
, IPP_TAG_PRINTER
},
215 { 0, "natural-scaling", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
216 { 0, "natural-scaling-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
217 { 0, "notify-charset", IPP_TAG_CHARSET
, IPP_TAG_SUBSCRIPTION
},
218 { 1, "notify-events", IPP_TAG_KEYWORD
, IPP_TAG_SUBSCRIPTION
},
219 { 1, "notify-events-default", IPP_TAG_KEYWORD
, IPP_TAG_PRINTER
},
220 { 0, "notify-lease-duration", IPP_TAG_INTEGER
, IPP_TAG_SUBSCRIPTION
},
221 { 0, "notify-lease-duration-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
222 { 0, "notify-natural-language", IPP_TAG_LANGUAGE
, IPP_TAG_SUBSCRIPTION
},
223 { 0, "notify-pull-method", IPP_TAG_KEYWORD
, IPP_TAG_SUBSCRIPTION
},
224 { 0, "notify-recipient-uri", IPP_TAG_URI
, IPP_TAG_SUBSCRIPTION
},
225 { 0, "notify-time-interval", IPP_TAG_INTEGER
, IPP_TAG_SUBSCRIPTION
},
226 { 0, "notify-user-data", IPP_TAG_STRING
, IPP_TAG_SUBSCRIPTION
},
227 { 0, "number-up", IPP_TAG_INTEGER
, IPP_TAG_JOB
,
229 { 0, "number-up-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
230 { 0, "orientation-requested", IPP_TAG_ENUM
, IPP_TAG_JOB
,
232 { 0, "orientation-requested-default", IPP_TAG_ENUM
, IPP_TAG_PRINTER
},
233 { 1, "overrides", IPP_TAG_BEGIN_COLLECTION
, IPP_TAG_JOB
,
235 { 0, "page-bottom", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
236 { 0, "page-bottom-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
237 { 0, "page-left", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
238 { 0, "page-left-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
239 { 1, "page-ranges", IPP_TAG_RANGE
, IPP_TAG_JOB
,
241 { 1, "page-ranges-default", IPP_TAG_RANGE
, IPP_TAG_PRINTER
},
242 { 0, "page-right", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
243 { 0, "page-right-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
244 { 0, "page-top", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
245 { 0, "page-top-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
246 { 1, "pages", IPP_TAG_RANGE
, IPP_TAG_JOB
,
248 { 0, "penwidth", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
249 { 0, "penwidth-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
250 { 0, "port-monitor", IPP_TAG_NAME
, IPP_TAG_PRINTER
},
251 { 0, "ppd-device-id", IPP_TAG_TEXT
, IPP_TAG_OPERATION
,
254 { 0, "ppd-make", IPP_TAG_TEXT
, IPP_TAG_OPERATION
,
257 { 0, "ppd-make-and-model", IPP_TAG_TEXT
, IPP_TAG_OPERATION
,
260 { 0, "ppd-model-number", IPP_TAG_INTEGER
, IPP_TAG_OPERATION
,
263 { 0, "ppd-name", IPP_TAG_NAME
, IPP_TAG_OPERATION
,
266 { 0, "ppd-natural-language", IPP_TAG_LANGUAGE
, IPP_TAG_OPERATION
,
269 { 0, "ppd-product", IPP_TAG_TEXT
, IPP_TAG_OPERATION
,
272 { 0, "ppd-psversion", IPP_TAG_TEXT
, IPP_TAG_OPERATION
,
275 { 0, "ppd-type", IPP_TAG_KEYWORD
, IPP_TAG_OPERATION
,
278 { 0, "ppi", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
279 { 0, "ppi-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
280 { 0, "prettyprint", IPP_TAG_BOOLEAN
, IPP_TAG_JOB
},
281 { 0, "prettyprint-default", IPP_TAG_BOOLEAN
, IPP_TAG_PRINTER
},
282 { 0, "print-quality", IPP_TAG_ENUM
, IPP_TAG_JOB
,
284 { 0, "print-quality-default", IPP_TAG_ENUM
, IPP_TAG_PRINTER
},
285 { 1, "printer-alert", IPP_TAG_STRING
, IPP_TAG_PRINTER
},
286 { 1, "printer-alert-description", IPP_TAG_TEXT
, IPP_TAG_PRINTER
},
287 { 1, "printer-commands", IPP_TAG_KEYWORD
, IPP_TAG_PRINTER
},
288 { 0, "printer-error-policy", IPP_TAG_NAME
, IPP_TAG_PRINTER
},
289 { 1, "printer-finisher", IPP_TAG_STRING
, IPP_TAG_PRINTER
},
290 { 1, "printer-finisher-description", IPP_TAG_TEXT
, IPP_TAG_PRINTER
},
291 { 1, "printer-finisher-supplies", IPP_TAG_STRING
, IPP_TAG_PRINTER
},
292 { 1, "printer-finisher-supplies-description", IPP_TAG_TEXT
, IPP_TAG_PRINTER
},
293 { 0, "printer-geo-location", IPP_TAG_URI
, IPP_TAG_PRINTER
},
294 { 0, "printer-info", IPP_TAG_TEXT
, IPP_TAG_PRINTER
},
295 { 1, "printer-input-tray", IPP_TAG_STRING
, IPP_TAG_PRINTER
},
296 { 0, "printer-is-accepting-jobs", IPP_TAG_BOOLEAN
, IPP_TAG_PRINTER
},
297 { 0, "printer-is-shared", IPP_TAG_BOOLEAN
, IPP_TAG_PRINTER
},
298 { 0, "printer-is-temporary", IPP_TAG_BOOLEAN
, IPP_TAG_PRINTER
},
299 { 0, "printer-location", IPP_TAG_TEXT
, IPP_TAG_PRINTER
},
300 { 0, "printer-make-and-model", IPP_TAG_TEXT
, IPP_TAG_PRINTER
},
301 { 0, "printer-more-info", IPP_TAG_URI
, IPP_TAG_PRINTER
},
302 { 0, "printer-op-policy", IPP_TAG_NAME
, IPP_TAG_PRINTER
},
303 { 1, "printer-output-tray", IPP_TAG_STRING
, IPP_TAG_PRINTER
},
304 { 0, "printer-resolution", IPP_TAG_RESOLUTION
, IPP_TAG_JOB
,
306 { 0, "printer-state", IPP_TAG_ENUM
, IPP_TAG_PRINTER
},
307 { 0, "printer-state-change-time", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
308 { 1, "printer-state-reasons", IPP_TAG_KEYWORD
, IPP_TAG_PRINTER
},
309 { 1, "printer-supply", IPP_TAG_STRING
, IPP_TAG_PRINTER
},
310 { 1, "printer-supply-description", IPP_TAG_TEXT
, IPP_TAG_PRINTER
},
311 { 0, "printer-type", IPP_TAG_ENUM
, IPP_TAG_PRINTER
},
312 { 0, "printer-uri", IPP_TAG_URI
, IPP_TAG_OPERATION
},
313 { 1, "printer-uri-supported", IPP_TAG_URI
, IPP_TAG_PRINTER
},
314 { 0, "queued-job-count", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
315 { 0, "raw", IPP_TAG_MIMETYPE
, IPP_TAG_OPERATION
},
316 { 1, "requested-attributes", IPP_TAG_NAME
, IPP_TAG_OPERATION
},
317 { 1, "requesting-user-name-allowed", IPP_TAG_NAME
, IPP_TAG_PRINTER
},
318 { 1, "requesting-user-name-denied", IPP_TAG_NAME
, IPP_TAG_PRINTER
},
319 { 0, "resolution", IPP_TAG_RESOLUTION
, IPP_TAG_JOB
},
320 { 0, "resolution-default", IPP_TAG_RESOLUTION
, IPP_TAG_PRINTER
},
321 { 0, "saturation", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
322 { 0, "saturation-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
323 { 0, "scaling", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
324 { 0, "scaling-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
325 { 0, "sides", IPP_TAG_KEYWORD
, IPP_TAG_JOB
,
327 { 0, "sides-default", IPP_TAG_KEYWORD
, IPP_TAG_PRINTER
},
328 { 0, "time-at-completed", IPP_TAG_INTEGER
, IPP_TAG_ZERO
}, /* never send as option */
329 { 0, "time-at-creation", IPP_TAG_INTEGER
, IPP_TAG_ZERO
}, /* never send as option */
330 { 0, "time-at-processing", IPP_TAG_INTEGER
, IPP_TAG_ZERO
}, /* never send as option */
331 { 0, "wrap", IPP_TAG_BOOLEAN
, IPP_TAG_JOB
},
332 { 0, "wrap-default", IPP_TAG_BOOLEAN
, IPP_TAG_PRINTER
},
333 { 0, "x-dimension", IPP_TAG_INTEGER
, IPP_TAG_JOB
,
335 { 0, "y-dimension", IPP_TAG_INTEGER
, IPP_TAG_JOB
,
344 static int compare_ipp_options(_ipp_option_t
*a
, _ipp_option_t
*b
);
348 * '_cupsEncodeOption()' - Encode a single option as an IPP attribute.
351 ipp_attribute_t
* /* O - New attribute or @code NULL@ on error */
353 ipp_t
*ipp
, /* I - IPP request/response/collection */
354 ipp_tag_t group_tag
, /* I - Group tag */
355 _ipp_option_t
*map
, /* I - Option mapping, if any */
356 const char *name
, /* I - Attribute name */
357 const char *value
) /* I - Value */
359 int i
, /* Looping var */
360 count
; /* Number of values */
361 char *s
, /* Pointer into option value */
362 *val
, /* Pointer to option value */
363 *copy
, /* Copy of option value */
364 *sep
, /* Option separator */
365 quote
; /* Quote character */
366 ipp_attribute_t
*attr
; /* IPP attribute */
367 ipp_tag_t value_tag
; /* IPP value tag */
368 ipp_t
*collection
; /* Collection value */
369 int num_cols
; /* Number of collection values */
370 cups_option_t
*cols
; /* Collection values */
373 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
));
376 * Figure out the attribute syntax for encoding...
380 map
= _ippFindOption(name
);
383 value_tag
= map
->value_tag
;
384 else if (!_cups_strcasecmp(value
, "true") || !_cups_strcasecmp(value
, "false"))
385 value_tag
= IPP_TAG_BOOLEAN
;
386 else if (value
[0] == '{')
387 value_tag
= IPP_TAG_BEGIN_COLLECTION
;
389 value_tag
= IPP_TAG_NAME
;
392 * Count the number of values...
395 if (map
&& map
->multivalue
)
397 for (count
= 1, sep
= (char *)value
, quote
= 0; *sep
; sep
++)
401 else if (!quote
&& (*sep
== '\'' || *sep
== '\"'))
404 * Skip quoted option value...
409 else if (*sep
== ',' && !quote
)
411 else if (*sep
== '\\' && sep
[1])
418 DEBUG_printf(("2_cupsEncodeOption: value_tag=%s, count=%d", ippTagString(value_tag
), count
));
421 * Allocate memory for the attribute values...
424 if ((attr
= ippAddStrings(ipp
, group_tag
, value_tag
, name
, count
, NULL
, NULL
)) == NULL
)
430 DEBUG_puts("1_cupsEncodeOption: Ran out of memory for attributes.");
437 * Make a copy of the value we can fiddle with...
440 if ((copy
= strdup(value
)) == NULL
)
446 DEBUG_puts("1_cupsEncodeOption: Ran out of memory for value copy.");
447 ippDeleteAttribute(ipp
, attr
);
456 * Since we have a single value, use the value directly...
464 * Scan the value string for values...
467 for (i
= 0, sep
= val
; i
< count
; val
= sep
, i
++)
470 * Find the end of this value and mark it if needed...
475 for (quote
= 0; *sep
; sep
++)
480 * Finish quoted value...
485 else if (!quote
&& (*sep
== '\'' || *sep
== '\"'))
488 * Handle quoted option value...
493 else if (*sep
== ',' && count
> 1)
495 else if (*sep
== '\\' && sep
[1])
498 * Skip quoted character...
501 memmove(sep
, sep
+ 1, strlen(sep
));
510 * Copy the option value(s) over as needed by the type...
513 switch (attr
->value_tag
)
515 case IPP_TAG_INTEGER
:
518 * Integer/enumeration value...
521 ippSetInteger(ipp
, &attr
, i
, (int)strtol(val
, &s
, 10));
524 case IPP_TAG_BOOLEAN
:
525 if (!_cups_strcasecmp(val
, "true") || !_cups_strcasecmp(val
, "on") || !_cups_strcasecmp(val
, "yes"))
528 * Boolean value - true...
531 ippSetBoolean(ipp
, &attr
, i
, 1);
536 * Boolean value - false...
539 ippSetBoolean(ipp
, &attr
, i
, 0);
549 int lower
, upper
; /* Lower and upper ranges... */
557 lower
= (int)strtol(val
, &s
, 10);
562 upper
= (int)strtol(s
+ 1, NULL
, 10);
569 ippSetRange(ipp
, &attr
, i
, lower
, upper
);
573 case IPP_TAG_RESOLUTION
:
578 int xres
, yres
; /* Resolution values */
579 ipp_res_t units
; /* Resolution units */
581 xres
= (int)strtol(val
, &s
, 10);
584 yres
= (int)strtol(s
+ 1, &s
, 10);
588 if (!_cups_strcasecmp(s
, "dpc") || !_cups_strcasecmp(s
, "dpcm"))
589 units
= IPP_RES_PER_CM
;
591 units
= IPP_RES_PER_INCH
;
593 ippSetResolution(ipp
, &attr
, i
, units
, xres
, yres
);
597 case IPP_TAG_STRING
:
602 ippSetOctetString(ipp
, &attr
, i
, val
, (int)strlen(val
));
605 case IPP_TAG_BEGIN_COLLECTION
:
610 num_cols
= cupsParseOptions(val
, 0, &cols
);
611 if ((collection
= ippNew()) == NULL
)
613 cupsFreeOptions(num_cols
, cols
);
618 ippDeleteAttribute(ipp
, attr
);
622 ippSetCollection(ipp
, &attr
, i
, collection
);
623 cupsEncodeOptions2(collection
, num_cols
, cols
, IPP_TAG_JOB
);
624 cupsFreeOptions(num_cols
, cols
);
628 ippSetString(ipp
, &attr
, i
, val
);
641 * 'cupsEncodeOption()' - Encode a single option into an IPP attribute.
646 ipp_attribute_t
* /* O - New attribute or @code NULL@ on error */
647 cupsEncodeOption(ipp_t
*ipp
, /* I - IPP request/response */
648 ipp_tag_t group_tag
, /* I - Attribute group */
649 const char *name
, /* I - Option name */
650 const char *value
) /* I - Option string value */
652 return (_cupsEncodeOption(ipp
, group_tag
, _ippFindOption(name
), name
, value
));
657 * 'cupsEncodeOptions()' - Encode printer options into IPP attributes.
659 * This function adds operation, job, and then subscription attributes,
660 * in that order. Use the @link cupsEncodeOptions2@ function to add attributes
661 * for a single group.
665 cupsEncodeOptions(ipp_t
*ipp
, /* I - IPP request/response */
666 int num_options
, /* I - Number of options */
667 cups_option_t
*options
) /* I - Options */
669 DEBUG_printf(("cupsEncodeOptions(%p, %d, %p)", (void *)ipp
, num_options
, (void *)options
));
672 * Add the options in the proper groups & order...
675 cupsEncodeOptions2(ipp
, num_options
, options
, IPP_TAG_OPERATION
);
676 cupsEncodeOptions2(ipp
, num_options
, options
, IPP_TAG_JOB
);
677 cupsEncodeOptions2(ipp
, num_options
, options
, IPP_TAG_SUBSCRIPTION
);
682 * 'cupsEncodeOptions2()' - Encode printer options into IPP attributes for a group.
684 * This function only adds attributes for a single group. Call this
685 * function multiple times for each group, or use @link cupsEncodeOptions@
686 * to add the standard groups.
688 * @since CUPS 1.2/macOS 10.5@
693 ipp_t
*ipp
, /* I - IPP request/response */
694 int num_options
, /* I - Number of options */
695 cups_option_t
*options
, /* I - Options */
696 ipp_tag_t group_tag
) /* I - Group to encode */
698 int i
; /* Looping var */
699 char *val
; /* Pointer to option value */
700 cups_option_t
*option
; /* Current option */
701 ipp_op_t op
; /* Operation for this request */
702 const ipp_op_t
*ops
; /* List of allowed operations */
705 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
));
708 * Range check input...
711 if (!ipp
|| num_options
< 1 || !options
)
715 * Do special handling for the document-format/raw options...
718 op
= ippGetOperation(ipp
);
720 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
))
723 * Handle the document format stuff first...
726 if ((val
= (char *)cupsGetOption("document-format", num_options
, options
)) != NULL
)
727 ippAddString(ipp
, IPP_TAG_OPERATION
, IPP_TAG_MIMETYPE
, "document-format", NULL
, val
);
728 else if (cupsGetOption("raw", num_options
, options
))
729 ippAddString(ipp
, IPP_TAG_OPERATION
, IPP_TAG_MIMETYPE
, "document-format", NULL
, "application/vnd.cups-raw");
731 ippAddString(ipp
, IPP_TAG_OPERATION
, IPP_TAG_MIMETYPE
, "document-format", NULL
, "application/octet-stream");
735 * Then loop through the options...
738 for (i
= num_options
, option
= options
; i
> 0; i
--, option
++)
740 _ipp_option_t
*match
; /* Matching attribute */
743 * Skip document format options that are handled above...
746 if (!_cups_strcasecmp(option
->name
, "raw") || !_cups_strcasecmp(option
->name
, "document-format") || !option
->name
[0])
750 * Figure out the proper value and group tags for this option...
753 if ((match
= _ippFindOption(option
->name
)) != NULL
)
755 if (match
->group_tag
!= group_tag
&& match
->alt_group_tag
!= group_tag
)
758 if (match
->operations
)
759 ops
= match
->operations
;
760 else if (group_tag
== IPP_TAG_JOB
)
761 ops
= ipp_job_creation
;
762 else if (group_tag
== IPP_TAG_DOCUMENT
)
763 ops
= ipp_doc_creation
;
764 else if (group_tag
== IPP_TAG_SUBSCRIPTION
)
765 ops
= ipp_sub_creation
;
766 else if (group_tag
== IPP_TAG_PRINTER
)
767 ops
= ipp_set_printer
;
770 DEBUG_printf(("2cupsEncodeOptions2: Skipping \"%s\".", option
->name
));
776 int namelen
; /* Length of name */
778 namelen
= (int)strlen(option
->name
);
780 if (namelen
< 10 || (strcmp(option
->name
+ namelen
- 8, "-default") && strcmp(option
->name
+ namelen
- 10, "-supported")))
782 if (group_tag
!= IPP_TAG_JOB
&& group_tag
!= IPP_TAG_DOCUMENT
)
784 DEBUG_printf(("2cupsEncodeOptions2: Skipping \"%s\".", option
->name
));
788 else if (group_tag
!= IPP_TAG_PRINTER
)
790 DEBUG_printf(("2cupsEncodeOptions2: Skipping \"%s\".", option
->name
));
794 if (group_tag
== IPP_TAG_JOB
)
795 ops
= ipp_job_creation
;
796 else if (group_tag
== IPP_TAG_DOCUMENT
)
797 ops
= ipp_doc_creation
;
799 ops
= ipp_set_printer
;
803 * Verify that we send this attribute for this operation...
806 while (*ops
!= IPP_OP_CUPS_NONE
)
812 if (*ops
== IPP_OP_CUPS_NONE
&& op
!= IPP_OP_CUPS_NONE
)
814 DEBUG_printf(("2cupsEncodeOptions2: Skipping \"%s\".", option
->name
));
818 _cupsEncodeOption(ipp
, group_tag
, match
, option
->name
, option
->value
);
825 * '_ippCheckOptions()' - Validate that the option array is sorted properly.
828 const char * /* O - First out-of-order option or NULL */
829 _ippCheckOptions(void)
831 int i
; /* Looping var */
834 for (i
= 0; i
< (int)(sizeof(ipp_options
) / sizeof(ipp_options
[0]) - 1); i
++)
835 if (strcmp(ipp_options
[i
].name
, ipp_options
[i
+ 1].name
) >= 0)
836 return (ipp_options
[i
+ 1].name
);
844 * '_ippFindOption()' - Find the attribute information for an option.
847 _ipp_option_t
* /* O - Attribute information */
848 _ippFindOption(const char *name
) /* I - Option/attribute name */
850 _ipp_option_t key
; /* Search key */
854 * Lookup the proper value and group tags for this option...
859 return ((_ipp_option_t
*)bsearch(&key
, ipp_options
,
860 sizeof(ipp_options
) / sizeof(ipp_options
[0]),
861 sizeof(ipp_options
[0]),
862 (int (*)(const void *, const void *))
863 compare_ipp_options
));
868 * 'compare_ipp_options()' - Compare two IPP options.
871 static int /* O - Result of comparison */
872 compare_ipp_options(_ipp_option_t
*a
, /* I - First option */
873 _ipp_option_t
*b
) /* I - Second option */
875 return (strcmp(a
->name
, b
->name
));