2 * "$Id: encode.c 7696 2008-06-26 00:54:42Z mike $"
4 * Option encoding routines for CUPS.
6 * Copyright 2007-2012 by Apple Inc.
7 * Copyright 1997-2007 by Easy Software Products.
9 * These coded instructions, statements, and computer programs are the
10 * property of Apple Inc. and are protected by Federal copyright
11 * law. Distribution and use rights are outlined in the file "LICENSE.txt"
12 * which should have been included with this file. If this file is
13 * file is missing or damaged, see the license at "http://www.cups.org/".
15 * This file is subject to the Apple OS-Developed Software exception.
19 * cupsEncodeOptions() - Encode printer options into IPP attributes.
20 * cupsEncodeOptions2() - Encode printer options into IPP attributes for
22 * _ippFindOption() - Find the attribute information for an option.
23 * compare_ipp_options() - Compare two IPP options.
27 * Include necessary headers...
30 #include "cups-private.h"
34 * Local list of option names and the value tags they should use...
36 * **** THIS LIST MUST BE SORTED ****
39 static const _ipp_option_t ipp_options
[] =
41 { 1, "auth-info", IPP_TAG_TEXT
, IPP_TAG_JOB
},
42 { 1, "auth-info-required", IPP_TAG_KEYWORD
, IPP_TAG_PRINTER
},
43 { 0, "blackplot", IPP_TAG_BOOLEAN
, IPP_TAG_JOB
},
44 { 0, "blackplot-default", IPP_TAG_BOOLEAN
, IPP_TAG_PRINTER
},
45 { 0, "brightness", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
46 { 0, "brightness-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
47 { 0, "columns", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
48 { 0, "columns-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
49 { 0, "compression", IPP_TAG_KEYWORD
, IPP_TAG_OPERATION
},
50 { 0, "copies", IPP_TAG_INTEGER
, IPP_TAG_JOB
,
52 { 0, "copies-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
53 { 0, "device-uri", IPP_TAG_URI
, IPP_TAG_PRINTER
},
54 { 1, "document-copies", IPP_TAG_RANGE
, IPP_TAG_JOB
,
56 { 0, "document-format", IPP_TAG_MIMETYPE
, IPP_TAG_OPERATION
},
57 { 0, "document-format-default", IPP_TAG_MIMETYPE
, IPP_TAG_PRINTER
},
58 { 1, "document-numbers", IPP_TAG_RANGE
, IPP_TAG_JOB
,
60 { 1, "exclude-schemes", IPP_TAG_NAME
, IPP_TAG_OPERATION
},
61 { 1, "finishings", IPP_TAG_ENUM
, IPP_TAG_JOB
,
63 { 1, "finishings-default", IPP_TAG_ENUM
, IPP_TAG_PRINTER
},
64 { 0, "fit-to-page", IPP_TAG_BOOLEAN
, IPP_TAG_JOB
,
66 { 0, "fit-to-page-default", IPP_TAG_BOOLEAN
, IPP_TAG_PRINTER
},
67 { 0, "fitplot", IPP_TAG_BOOLEAN
, IPP_TAG_JOB
},
68 { 0, "fitplot-default", IPP_TAG_BOOLEAN
, IPP_TAG_PRINTER
},
69 { 0, "gamma", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
70 { 0, "gamma-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
71 { 0, "hue", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
72 { 0, "hue-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
73 { 1, "include-schemes", IPP_TAG_NAME
, IPP_TAG_OPERATION
},
74 { 0, "job-impressions", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
75 { 0, "job-k-limit", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
76 { 0, "job-page-limit", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
77 { 0, "job-priority", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
78 { 0, "job-quota-period", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
79 { 1, "job-sheets", IPP_TAG_NAME
, IPP_TAG_JOB
},
80 { 1, "job-sheets-default", IPP_TAG_NAME
, IPP_TAG_PRINTER
},
81 { 0, "job-uuid", IPP_TAG_URI
, IPP_TAG_JOB
},
82 { 0, "landscape", IPP_TAG_BOOLEAN
, IPP_TAG_JOB
},
83 { 1, "marker-change-time", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
84 { 1, "marker-colors", IPP_TAG_NAME
, IPP_TAG_PRINTER
},
85 { 1, "marker-high-levels", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
86 { 1, "marker-levels", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
87 { 1, "marker-low-levels", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
88 { 0, "marker-message", IPP_TAG_TEXT
, IPP_TAG_PRINTER
},
89 { 1, "marker-names", IPP_TAG_NAME
, IPP_TAG_PRINTER
},
90 { 1, "marker-types", IPP_TAG_KEYWORD
, IPP_TAG_PRINTER
},
91 { 1, "media", IPP_TAG_KEYWORD
, IPP_TAG_JOB
,
93 { 0, "media-col", IPP_TAG_BEGIN_COLLECTION
, IPP_TAG_JOB
,
95 { 0, "media-col-default", IPP_TAG_BEGIN_COLLECTION
, IPP_TAG_PRINTER
},
96 { 0, "media-color", IPP_TAG_KEYWORD
, IPP_TAG_JOB
,
98 { 1, "media-default", IPP_TAG_KEYWORD
, IPP_TAG_PRINTER
},
99 { 0, "media-key", IPP_TAG_KEYWORD
, IPP_TAG_JOB
,
101 { 0, "media-size", IPP_TAG_BEGIN_COLLECTION
, IPP_TAG_JOB
,
103 { 0, "media-type", IPP_TAG_KEYWORD
, IPP_TAG_JOB
,
105 { 0, "mirror", IPP_TAG_BOOLEAN
, IPP_TAG_JOB
},
106 { 0, "mirror-default", IPP_TAG_BOOLEAN
, IPP_TAG_PRINTER
},
107 { 0, "natural-scaling", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
108 { 0, "natural-scaling-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
109 { 0, "notify-charset", IPP_TAG_CHARSET
, IPP_TAG_SUBSCRIPTION
},
110 { 1, "notify-events", IPP_TAG_KEYWORD
, IPP_TAG_SUBSCRIPTION
},
111 { 1, "notify-events-default", IPP_TAG_KEYWORD
, IPP_TAG_PRINTER
},
112 { 0, "notify-lease-duration", IPP_TAG_INTEGER
, IPP_TAG_SUBSCRIPTION
},
113 { 0, "notify-lease-duration-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
114 { 0, "notify-natural-language", IPP_TAG_LANGUAGE
, IPP_TAG_SUBSCRIPTION
},
115 { 0, "notify-pull-method", IPP_TAG_KEYWORD
, IPP_TAG_SUBSCRIPTION
},
116 { 0, "notify-recipient-uri", IPP_TAG_URI
, IPP_TAG_SUBSCRIPTION
},
117 { 0, "notify-time-interval", IPP_TAG_INTEGER
, IPP_TAG_SUBSCRIPTION
},
118 { 0, "notify-user-data", IPP_TAG_STRING
, IPP_TAG_SUBSCRIPTION
},
119 { 0, "number-up", IPP_TAG_INTEGER
, IPP_TAG_JOB
,
121 { 0, "number-up-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
122 { 0, "orientation-requested", IPP_TAG_ENUM
, IPP_TAG_JOB
,
124 { 0, "orientation-requested-default", IPP_TAG_ENUM
, IPP_TAG_PRINTER
},
125 { 1, "overrides", IPP_TAG_BEGIN_COLLECTION
, IPP_TAG_JOB
,
127 { 0, "page-bottom", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
128 { 0, "page-bottom-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
129 { 0, "page-left", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
130 { 0, "page-left-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
131 { 1, "page-ranges", IPP_TAG_RANGE
, IPP_TAG_JOB
,
133 { 1, "page-ranges-default", IPP_TAG_RANGE
, IPP_TAG_PRINTER
},
134 { 0, "page-right", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
135 { 0, "page-right-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
136 { 0, "page-top", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
137 { 0, "page-top-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
138 { 1, "pages", IPP_TAG_RANGE
, IPP_TAG_JOB
,
140 { 0, "penwidth", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
141 { 0, "penwidth-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
142 { 0, "port-monitor", IPP_TAG_NAME
, IPP_TAG_PRINTER
},
143 { 0, "ppd-name", IPP_TAG_NAME
, IPP_TAG_PRINTER
},
144 { 0, "ppi", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
145 { 0, "ppi-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
146 { 0, "prettyprint", IPP_TAG_BOOLEAN
, IPP_TAG_JOB
},
147 { 0, "prettyprint-default", IPP_TAG_BOOLEAN
, IPP_TAG_PRINTER
},
148 { 0, "print-quality", IPP_TAG_ENUM
, IPP_TAG_JOB
,
150 { 0, "print-quality-default", IPP_TAG_ENUM
, IPP_TAG_PRINTER
},
151 { 1, "printer-commands", IPP_TAG_KEYWORD
, IPP_TAG_PRINTER
},
152 { 0, "printer-error-policy", IPP_TAG_NAME
, IPP_TAG_PRINTER
},
153 { 0, "printer-info", IPP_TAG_TEXT
, IPP_TAG_PRINTER
},
154 { 0, "printer-is-accepting-jobs", IPP_TAG_BOOLEAN
, IPP_TAG_PRINTER
},
155 { 0, "printer-is-shared", IPP_TAG_BOOLEAN
, IPP_TAG_PRINTER
},
156 { 0, "printer-location", IPP_TAG_TEXT
, IPP_TAG_PRINTER
},
157 { 0, "printer-make-and-model", IPP_TAG_TEXT
, IPP_TAG_PRINTER
},
158 { 0, "printer-more-info", IPP_TAG_URI
, IPP_TAG_PRINTER
},
159 { 0, "printer-op-policy", IPP_TAG_NAME
, IPP_TAG_PRINTER
},
160 { 0, "printer-resolution", IPP_TAG_RESOLUTION
, IPP_TAG_JOB
,
162 { 0, "printer-state", IPP_TAG_ENUM
, IPP_TAG_PRINTER
},
163 { 0, "printer-state-change-time", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
164 { 1, "printer-state-reasons", IPP_TAG_KEYWORD
, IPP_TAG_PRINTER
},
165 { 0, "printer-type", IPP_TAG_ENUM
, IPP_TAG_PRINTER
},
166 { 0, "printer-uri", IPP_TAG_URI
, IPP_TAG_OPERATION
},
167 { 1, "printer-uri-supported", IPP_TAG_URI
, IPP_TAG_PRINTER
},
168 { 0, "queued-job-count", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
169 { 0, "raw", IPP_TAG_MIMETYPE
, IPP_TAG_OPERATION
},
170 { 1, "requested-attributes", IPP_TAG_NAME
, IPP_TAG_OPERATION
},
171 { 1, "requesting-user-name-allowed", IPP_TAG_NAME
, IPP_TAG_PRINTER
},
172 { 1, "requesting-user-name-denied", IPP_TAG_NAME
, IPP_TAG_PRINTER
},
173 { 0, "resolution", IPP_TAG_RESOLUTION
, IPP_TAG_JOB
},
174 { 0, "resolution-default", IPP_TAG_RESOLUTION
, IPP_TAG_PRINTER
},
175 { 0, "saturation", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
176 { 0, "saturation-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
177 { 0, "scaling", IPP_TAG_INTEGER
, IPP_TAG_JOB
},
178 { 0, "scaling-default", IPP_TAG_INTEGER
, IPP_TAG_PRINTER
},
179 { 0, "sides", IPP_TAG_KEYWORD
, IPP_TAG_JOB
,
181 { 0, "sides-default", IPP_TAG_KEYWORD
, IPP_TAG_PRINTER
},
182 { 0, "wrap", IPP_TAG_BOOLEAN
, IPP_TAG_JOB
},
183 { 0, "wrap-default", IPP_TAG_BOOLEAN
, IPP_TAG_PRINTER
},
184 { 0, "x-dimension", IPP_TAG_INTEGER
, IPP_TAG_JOB
,
186 { 0, "y-dimension", IPP_TAG_INTEGER
, IPP_TAG_JOB
,
195 static int compare_ipp_options(_ipp_option_t
*a
, _ipp_option_t
*b
);
199 * 'cupsEncodeOptions()' - Encode printer options into IPP attributes.
201 * This function adds operation, job, and then subscription attributes,
202 * in that order. Use the cupsEncodeOptions2() function to add attributes
203 * for a single group.
207 cupsEncodeOptions(ipp_t
*ipp
, /* I - Request to add to */
208 int num_options
, /* I - Number of options */
209 cups_option_t
*options
) /* I - Options */
211 DEBUG_printf(("cupsEncodeOptions(%p, %d, %p)", ipp
, num_options
, options
));
214 * Add the options in the proper groups & order...
217 cupsEncodeOptions2(ipp
, num_options
, options
, IPP_TAG_OPERATION
);
218 cupsEncodeOptions2(ipp
, num_options
, options
, IPP_TAG_JOB
);
219 cupsEncodeOptions2(ipp
, num_options
, options
, IPP_TAG_SUBSCRIPTION
);
224 * 'cupsEncodeOptions2()' - Encode printer options into IPP attributes for a group.
226 * This function only adds attributes for a single group. Call this
227 * function multiple times for each group, or use cupsEncodeOptions()
228 * to add the standard groups.
230 * @since CUPS 1.2/OS X 10.5@
235 ipp_t
*ipp
, /* I - Request to add to */
236 int num_options
, /* I - Number of options */
237 cups_option_t
*options
, /* I - Options */
238 ipp_tag_t group_tag
) /* I - Group to encode */
240 int i
, j
; /* Looping vars */
241 int count
; /* Number of values */
242 char *s
, /* Pointer into option value */
243 *val
, /* Pointer to option value */
244 *copy
, /* Copy of option value */
245 *sep
, /* Option separator */
246 quote
; /* Quote character */
247 ipp_attribute_t
*attr
; /* IPP attribute */
248 ipp_tag_t value_tag
; /* IPP value tag */
249 cups_option_t
*option
; /* Current option */
250 ipp_t
*collection
; /* Collection value */
251 int num_cols
; /* Number of collection values */
252 cups_option_t
*cols
; /* Collection values */
255 DEBUG_printf(("cupsEncodeOptions2(ipp=%p, num_options=%d, options=%p, "
256 "group_tag=%x)", ipp
, num_options
, options
, group_tag
));
259 * Range check input...
262 if (!ipp
|| num_options
< 1 || !options
)
266 * Do special handling for the document-format/raw options...
269 if (group_tag
== IPP_TAG_OPERATION
)
272 * Handle the document format stuff first...
275 if ((val
= (char *)cupsGetOption("document-format", num_options
, options
)) != NULL
)
276 ippAddString(ipp
, IPP_TAG_OPERATION
, IPP_TAG_MIMETYPE
, "document-format",
278 else if (cupsGetOption("raw", num_options
, options
))
279 ippAddString(ipp
, IPP_TAG_OPERATION
, IPP_TAG_MIMETYPE
, "document-format",
280 NULL
, "application/vnd.cups-raw");
282 ippAddString(ipp
, IPP_TAG_OPERATION
, IPP_TAG_MIMETYPE
, "document-format",
283 NULL
, "application/octet-stream");
287 * Then loop through the options...
290 for (i
= num_options
, option
= options
; i
> 0; i
--, option
++)
292 _ipp_option_t
*match
; /* Matching attribute */
296 * Skip document format options that are handled above...
299 if (!_cups_strcasecmp(option
->name
, "raw") ||
300 !_cups_strcasecmp(option
->name
, "document-format") ||
305 * Figure out the proper value and group tags for this option...
308 if ((match
= _ippFindOption(option
->name
)) != NULL
)
310 if (match
->group_tag
!= group_tag
&& match
->alt_group_tag
!= group_tag
)
313 value_tag
= match
->value_tag
;
317 int namelen
; /* Length of name */
320 namelen
= (int)strlen(option
->name
);
323 (strcmp(option
->name
+ namelen
- 8, "-default") &&
324 strcmp(option
->name
+ namelen
- 10, "-supported")))
326 if (group_tag
!= IPP_TAG_JOB
&& group_tag
!= IPP_TAG_DOCUMENT
)
329 else if (group_tag
!= IPP_TAG_PRINTER
)
332 if (!_cups_strcasecmp(option
->value
, "true") ||
333 !_cups_strcasecmp(option
->value
, "false"))
334 value_tag
= IPP_TAG_BOOLEAN
;
336 value_tag
= IPP_TAG_NAME
;
340 * Count the number of values...
343 if (match
&& match
->multivalue
)
345 for (count
= 1, sep
= option
->value
, quote
= 0; *sep
; sep
++)
349 else if (!quote
&& (*sep
== '\'' || *sep
== '\"'))
352 * Skip quoted option value...
357 else if (*sep
== ',' && !quote
)
359 else if (*sep
== '\\' && sep
[1])
366 DEBUG_printf(("2cupsEncodeOptions2: option=\"%s\", count=%d",
367 option
->name
, count
));
370 * Allocate memory for the attribute values...
373 if ((attr
= ippAddStrings(ipp
, group_tag
, value_tag
, option
->name
, count
,
374 NULL
, NULL
)) == NULL
)
380 DEBUG_puts("1cupsEncodeOptions2: Ran out of memory for attributes!");
387 * Make a copy of the value we can fiddle with...
390 if ((copy
= strdup(option
->value
)) == NULL
)
396 DEBUG_puts("1cupsEncodeOptions2: Ran out of memory for value copy!");
397 ippDeleteAttribute(ipp
, attr
);
406 * Since we have a single value, use the value directly...
414 * Scan the value string for values...
417 for (j
= 0, sep
= val
; j
< count
; val
= sep
, j
++)
420 * Find the end of this value and mark it if needed...
425 for (quote
= 0; *sep
; sep
++)
430 * Finish quoted value...
435 else if (!quote
&& (*sep
== '\'' || *sep
== '\"'))
438 * Handle quoted option value...
443 else if (*sep
== ',' && count
> 1)
445 else if (*sep
== '\\' && sep
[1])
448 * Skip quoted character...
460 * Copy the option value(s) over as needed by the type...
463 switch (attr
->value_tag
)
465 case IPP_TAG_INTEGER
:
468 * Integer/enumeration value...
471 attr
->values
[j
].integer
= strtol(val
, &s
, 10);
473 DEBUG_printf(("2cupsEncodeOptions2: Added integer option value "
474 "%d...", attr
->values
[j
].integer
));
477 case IPP_TAG_BOOLEAN
:
478 if (!_cups_strcasecmp(val
, "true") ||
479 !_cups_strcasecmp(val
, "on") ||
480 !_cups_strcasecmp(val
, "yes"))
483 * Boolean value - true...
486 attr
->values
[j
].boolean
= 1;
488 DEBUG_puts("2cupsEncodeOptions2: Added boolean true value...");
493 * Boolean value - false...
496 attr
->values
[j
].boolean
= 0;
498 DEBUG_puts("2cupsEncodeOptions2: Added boolean false value...");
509 attr
->values
[j
].range
.lower
= 1;
513 attr
->values
[j
].range
.lower
= strtol(val
, &s
, 10);
518 attr
->values
[j
].range
.upper
= strtol(s
+ 1, NULL
, 10);
520 attr
->values
[j
].range
.upper
= 2147483647;
523 attr
->values
[j
].range
.upper
= attr
->values
[j
].range
.lower
;
525 DEBUG_printf(("2cupsEncodeOptions2: Added range option value "
526 "%d-%d...", attr
->values
[j
].range
.lower
,
527 attr
->values
[j
].range
.upper
));
530 case IPP_TAG_RESOLUTION
:
535 attr
->values
[j
].resolution
.xres
= strtol(val
, &s
, 10);
538 attr
->values
[j
].resolution
.yres
= strtol(s
+ 1, &s
, 10);
540 attr
->values
[j
].resolution
.yres
= attr
->values
[j
].resolution
.xres
;
542 if (!_cups_strcasecmp(s
, "dpc") ||
543 !_cups_strcasecmp(s
, "dpcm"))
544 attr
->values
[j
].resolution
.units
= IPP_RES_PER_CM
;
546 attr
->values
[j
].resolution
.units
= IPP_RES_PER_INCH
;
548 DEBUG_printf(("2cupsEncodeOptions2: Added resolution option value "
552 case IPP_TAG_STRING
:
557 attr
->values
[j
].unknown
.length
= (int)strlen(val
);
558 attr
->values
[j
].unknown
.data
= strdup(val
);
560 DEBUG_printf(("2cupsEncodeOptions2: Added octet-string value "
561 "\"%s\"...", (char *)attr
->values
[j
].unknown
.data
));
564 case IPP_TAG_BEGIN_COLLECTION
:
569 num_cols
= cupsParseOptions(val
, 0, &cols
);
570 if ((collection
= ippNew()) == NULL
)
572 cupsFreeOptions(num_cols
, cols
);
577 ippDeleteAttribute(ipp
, attr
);
581 attr
->values
[j
].collection
= collection
;
582 cupsEncodeOptions2(collection
, num_cols
, cols
, IPP_TAG_JOB
);
583 cupsFreeOptions(num_cols
, cols
);
587 if ((attr
->values
[j
].string
.text
= _cupsStrAlloc(val
)) == NULL
)
593 DEBUG_puts("1cupsEncodeOptions2: Ran out of memory for string!");
598 ippDeleteAttribute(ipp
, attr
);
602 DEBUG_printf(("2cupsEncodeOptions2: Added string value \"%s\"...",
615 * '_ippFindOption()' - Find the attribute information for an option.
618 _ipp_option_t
* /* O - Attribute information */
619 _ippFindOption(const char *name
) /* I - Option/attribute name */
621 _ipp_option_t key
; /* Search key */
625 * Lookup the proper value and group tags for this option...
630 return ((_ipp_option_t
*)bsearch(&key
, ipp_options
,
631 sizeof(ipp_options
) / sizeof(ipp_options
[0]),
632 sizeof(ipp_options
[0]),
633 (int (*)(const void *, const void *))
634 compare_ipp_options
));
639 * 'compare_ipp_options()' - Compare two IPP options.
642 static int /* O - Result of comparison */
643 compare_ipp_options(_ipp_option_t
*a
, /* I - First option */
644 _ipp_option_t
*b
) /* I - Second option */
646 return (strcmp(a
->name
, b
->name
));
651 * End of "$Id: encode.c 7696 2008-06-26 00:54:42Z mike $".