2 * Internet Printing Protocol functions for CUPS.
4 * Copyright © 2007-2018 by Apple Inc.
5 * Copyright © 1997-2007 by Easy Software Products, all rights reserved.
7 * Licensed under Apache License v2.0. See the file "LICENSE" for more
12 * Include necessary headers...
15 #include "cups-private.h"
16 #include "debug-internal.h"
27 static ipp_attribute_t
*ipp_add_attr(ipp_t
*ipp
, const char *name
,
28 ipp_tag_t group_tag
, ipp_tag_t value_tag
,
30 static void ipp_free_values(ipp_attribute_t
*attr
, int element
,
32 static char *ipp_get_code(const char *locale
, char *buffer
, size_t bufsize
) _CUPS_NONNULL(1,2);
33 static char *ipp_lang_code(const char *locale
, char *buffer
, size_t bufsize
) _CUPS_NONNULL(1,2);
34 static size_t ipp_length(ipp_t
*ipp
, int collection
);
35 static ssize_t
ipp_read_http(http_t
*http
, ipp_uchar_t
*buffer
,
37 static ssize_t
ipp_read_file(int *fd
, ipp_uchar_t
*buffer
,
39 static void ipp_set_error(ipp_status_t status
, const char *format
,
41 static _ipp_value_t
*ipp_set_value(ipp_t
*ipp
, ipp_attribute_t
**attr
,
43 static ssize_t
ipp_write_file(int *fd
, ipp_uchar_t
*buffer
,
48 * '_cupsBufferGet()' - Get a read/write buffer.
51 char * /* O - Buffer */
52 _cupsBufferGet(size_t size
) /* I - Size required */
54 _cups_buffer_t
*buffer
; /* Current buffer */
55 _cups_globals_t
*cg
= _cupsGlobals();
59 for (buffer
= cg
->cups_buffers
; buffer
; buffer
= buffer
->next
)
60 if (!buffer
->used
&& buffer
->size
>= size
)
65 if ((buffer
= malloc(sizeof(_cups_buffer_t
) + size
- 1)) == NULL
)
68 buffer
->next
= cg
->cups_buffers
;
70 cg
->cups_buffers
= buffer
;
80 * '_cupsBufferRelease()' - Release a read/write buffer.
84 _cupsBufferRelease(char *b
) /* I - Buffer to release */
86 _cups_buffer_t
*buffer
; /* Buffer */
90 * Mark this buffer as unused...
93 buffer
= (_cups_buffer_t
*)(b
- offsetof(_cups_buffer_t
, d
));
99 * 'ippAddBoolean()' - Add a boolean attribute to an IPP message.
101 * The @code ipp@ parameter refers to an IPP message previously created using
102 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
104 * The @code group@ parameter specifies the IPP attribute group tag: none
105 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
106 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
107 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
108 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
111 ipp_attribute_t
* /* O - New attribute */
112 ippAddBoolean(ipp_t
*ipp
, /* I - IPP message */
113 ipp_tag_t group
, /* I - IPP group */
114 const char *name
, /* I - Name of attribute */
115 char value
) /* I - Value of attribute */
117 ipp_attribute_t
*attr
; /* New attribute */
120 DEBUG_printf(("ippAddBoolean(ipp=%p, group=%02x(%s), name=\"%s\", value=%d)", (void *)ipp
, group
, ippTagString(group
), name
, value
));
123 * Range check input...
126 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
127 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
)
131 * Create the attribute...
134 if ((attr
= ipp_add_attr(ipp
, name
, group
, IPP_TAG_BOOLEAN
, 1)) == NULL
)
137 attr
->values
[0].boolean
= value
;
144 * 'ippAddBooleans()' - Add an array of boolean values.
146 * The @code ipp@ parameter refers to an IPP message previously created using
147 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
149 * The @code group@ parameter specifies the IPP attribute group tag: none
150 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
151 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
152 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
153 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
156 ipp_attribute_t
* /* O - New attribute */
157 ippAddBooleans(ipp_t
*ipp
, /* I - IPP message */
158 ipp_tag_t group
, /* I - IPP group */
159 const char *name
, /* I - Name of attribute */
160 int num_values
, /* I - Number of values */
161 const char *values
) /* I - Values */
163 int i
; /* Looping var */
164 ipp_attribute_t
*attr
; /* New attribute */
165 _ipp_value_t
*value
; /* Current value */
168 DEBUG_printf(("ippAddBooleans(ipp=%p, group=%02x(%s), name=\"%s\", num_values=%d, values=%p)", (void *)ipp
, group
, ippTagString(group
), name
, num_values
, (void *)values
));
171 * Range check input...
174 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
175 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
||
180 * Create the attribute...
183 if ((attr
= ipp_add_attr(ipp
, name
, group
, IPP_TAG_BOOLEAN
, num_values
)) == NULL
)
188 for (i
= num_values
, value
= attr
->values
;
191 value
->boolean
= *values
++;
199 * 'ippAddCollection()' - Add a collection value.
201 * The @code ipp@ parameter refers to an IPP message previously created using
202 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
204 * The @code group@ parameter specifies the IPP attribute group tag: none
205 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
206 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
207 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
208 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
210 * @since CUPS 1.1.19/macOS 10.3@
213 ipp_attribute_t
* /* O - New attribute */
214 ippAddCollection(ipp_t
*ipp
, /* I - IPP message */
215 ipp_tag_t group
, /* I - IPP group */
216 const char *name
, /* I - Name of attribute */
217 ipp_t
*value
) /* I - Value */
219 ipp_attribute_t
*attr
; /* New attribute */
222 DEBUG_printf(("ippAddCollection(ipp=%p, group=%02x(%s), name=\"%s\", value=%p)", (void *)ipp
, group
, ippTagString(group
), name
, (void *)value
));
225 * Range check input...
228 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
229 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
)
233 * Create the attribute...
236 if ((attr
= ipp_add_attr(ipp
, name
, group
, IPP_TAG_BEGIN_COLLECTION
, 1)) == NULL
)
239 attr
->values
[0].collection
= value
;
249 * 'ippAddCollections()' - Add an array of collection values.
251 * The @code ipp@ parameter refers to an IPP message previously created using
252 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
254 * The @code group@ parameter specifies the IPP attribute group tag: none
255 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
256 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
257 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
258 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
260 * @since CUPS 1.1.19/macOS 10.3@
263 ipp_attribute_t
* /* O - New attribute */
265 ipp_t
*ipp
, /* I - IPP message */
266 ipp_tag_t group
, /* I - IPP group */
267 const char *name
, /* I - Name of attribute */
268 int num_values
, /* I - Number of values */
269 const ipp_t
**values
) /* I - Values */
271 int i
; /* Looping var */
272 ipp_attribute_t
*attr
; /* New attribute */
273 _ipp_value_t
*value
; /* Current value */
276 DEBUG_printf(("ippAddCollections(ipp=%p, group=%02x(%s), name=\"%s\", num_values=%d, values=%p)", (void *)ipp
, group
, ippTagString(group
), name
, num_values
, (void *)values
));
279 * Range check input...
282 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
283 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
||
288 * Create the attribute...
291 if ((attr
= ipp_add_attr(ipp
, name
, group
, IPP_TAG_BEGIN_COLLECTION
,
292 num_values
)) == NULL
)
297 for (i
= num_values
, value
= attr
->values
;
301 value
->collection
= (ipp_t
*)*values
++;
302 value
->collection
->use
++;
311 * 'ippAddDate()' - Add a dateTime attribute to an IPP message.
313 * The @code ipp@ parameter refers to an IPP message previously created using
314 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
316 * The @code group@ parameter specifies the IPP attribute group tag: none
317 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
318 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
319 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
320 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
323 ipp_attribute_t
* /* O - New attribute */
324 ippAddDate(ipp_t
*ipp
, /* I - IPP message */
325 ipp_tag_t group
, /* I - IPP group */
326 const char *name
, /* I - Name of attribute */
327 const ipp_uchar_t
*value
) /* I - Value */
329 ipp_attribute_t
*attr
; /* New attribute */
332 DEBUG_printf(("ippAddDate(ipp=%p, group=%02x(%s), name=\"%s\", value=%p)", (void *)ipp
, group
, ippTagString(group
), name
, (void *)value
));
335 * Range check input...
338 if (!ipp
|| !name
|| !value
|| group
< IPP_TAG_ZERO
||
339 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
)
343 * Create the attribute...
346 if ((attr
= ipp_add_attr(ipp
, name
, group
, IPP_TAG_DATE
, 1)) == NULL
)
349 memcpy(attr
->values
[0].date
, value
, 11);
356 * 'ippAddInteger()' - Add a integer attribute to an IPP message.
358 * The @code ipp@ parameter refers to an IPP message previously created using
359 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
361 * The @code group@ parameter specifies the IPP attribute group tag: none
362 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
363 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
364 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
365 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
367 * Supported values include enum (@code IPP_TAG_ENUM@) and integer
368 * (@code IPP_TAG_INTEGER@).
371 ipp_attribute_t
* /* O - New attribute */
372 ippAddInteger(ipp_t
*ipp
, /* I - IPP message */
373 ipp_tag_t group
, /* I - IPP group */
374 ipp_tag_t value_tag
, /* I - Type of attribute */
375 const char *name
, /* I - Name of attribute */
376 int value
) /* I - Value of attribute */
378 ipp_attribute_t
*attr
; /* New attribute */
381 DEBUG_printf(("ippAddInteger(ipp=%p, group=%02x(%s), type=%02x(%s), name=\"%s\", value=%d)", (void *)ipp
, group
, ippTagString(group
), value_tag
, ippTagString(value_tag
), name
, value
));
383 value_tag
&= IPP_TAG_CUPS_MASK
;
386 * Special-case for legacy usage: map out-of-band attributes to new ippAddOutOfBand
390 if (value_tag
>= IPP_TAG_UNSUPPORTED_VALUE
&& value_tag
<= IPP_TAG_ADMINDEFINE
)
391 return (ippAddOutOfBand(ipp
, group
, value_tag
, name
));
394 * Range check input...
398 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
399 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
||
400 (value_tag
!= IPP_TAG_INTEGER
&& value_tag
!= IPP_TAG_ENUM
))
403 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
404 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
)
409 * Create the attribute...
412 if ((attr
= ipp_add_attr(ipp
, name
, group
, value_tag
, 1)) == NULL
)
415 attr
->values
[0].integer
= value
;
422 * 'ippAddIntegers()' - Add an array of integer values.
424 * The @code ipp@ parameter refers to an IPP message previously created using
425 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
427 * The @code group@ parameter specifies the IPP attribute group tag: none
428 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
429 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
430 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
431 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
433 * Supported values include enum (@code IPP_TAG_ENUM@) and integer
434 * (@code IPP_TAG_INTEGER@).
437 ipp_attribute_t
* /* O - New attribute */
438 ippAddIntegers(ipp_t
*ipp
, /* I - IPP message */
439 ipp_tag_t group
, /* I - IPP group */
440 ipp_tag_t value_tag
, /* I - Type of attribute */
441 const char *name
, /* I - Name of attribute */
442 int num_values
, /* I - Number of values */
443 const int *values
) /* I - Values */
445 int i
; /* Looping var */
446 ipp_attribute_t
*attr
; /* New attribute */
447 _ipp_value_t
*value
; /* Current value */
450 DEBUG_printf(("ippAddIntegers(ipp=%p, group=%02x(%s), type=%02x(%s), name=\"%s\", num_values=%d, values=%p)", (void *)ipp
, group
, ippTagString(group
), value_tag
, ippTagString(value_tag
), name
, num_values
, (void *)values
));
452 value_tag
&= IPP_TAG_CUPS_MASK
;
455 * Range check input...
459 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
460 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
||
461 (value_tag
!= IPP_TAG_INTEGER
&& value_tag
!= IPP_TAG_ENUM
) ||
465 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
466 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
||
472 * Create the attribute...
475 if ((attr
= ipp_add_attr(ipp
, name
, group
, value_tag
, num_values
)) == NULL
)
480 for (i
= num_values
, value
= attr
->values
;
483 value
->integer
= *values
++;
491 * 'ippAddOctetString()' - Add an octetString value to an IPP message.
493 * The @code ipp@ parameter refers to an IPP message previously created using
494 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
496 * The @code group@ parameter specifies the IPP attribute group tag: none
497 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
498 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
499 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
500 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
502 * @since CUPS 1.2/macOS 10.5@
505 ipp_attribute_t
* /* O - New attribute */
506 ippAddOctetString(ipp_t
*ipp
, /* I - IPP message */
507 ipp_tag_t group
, /* I - IPP group */
508 const char *name
, /* I - Name of attribute */
509 const void *data
, /* I - octetString data */
510 int datalen
) /* I - Length of data in bytes */
512 ipp_attribute_t
*attr
; /* New attribute */
515 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
516 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
||
517 datalen
< 0 || datalen
> IPP_MAX_LENGTH
)
520 if ((attr
= ipp_add_attr(ipp
, name
, group
, IPP_TAG_STRING
, 1)) == NULL
)
524 * Initialize the attribute data...
527 attr
->values
[0].unknown
.length
= datalen
;
531 if ((attr
->values
[0].unknown
.data
= malloc((size_t)datalen
)) == NULL
)
533 ippDeleteAttribute(ipp
, attr
);
537 memcpy(attr
->values
[0].unknown
.data
, data
, (size_t)datalen
);
541 * Return the new attribute...
549 * 'ippAddOutOfBand()' - Add an out-of-band value to an IPP message.
551 * The @code ipp@ parameter refers to an IPP message previously created using
552 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
554 * The @code group@ parameter specifies the IPP attribute group tag: none
555 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
556 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
557 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
558 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
560 * Supported out-of-band values include unsupported-value
561 * (@code IPP_TAG_UNSUPPORTED_VALUE@), default (@code IPP_TAG_DEFAULT@), unknown
562 * (@code IPP_TAG_UNKNOWN@), no-value (@code IPP_TAG_NOVALUE@), not-settable
563 * (@code IPP_TAG_NOTSETTABLE@), delete-attribute (@code IPP_TAG_DELETEATTR@), and
564 * admin-define (@code IPP_TAG_ADMINDEFINE@).
566 * @since CUPS 1.6/macOS 10.8@
569 ipp_attribute_t
* /* O - New attribute */
570 ippAddOutOfBand(ipp_t
*ipp
, /* I - IPP message */
571 ipp_tag_t group
, /* I - IPP group */
572 ipp_tag_t value_tag
, /* I - Type of attribute */
573 const char *name
) /* I - Name of attribute */
575 DEBUG_printf(("ippAddOutOfBand(ipp=%p, group=%02x(%s), value_tag=%02x(%s), name=\"%s\")", (void *)ipp
, group
, ippTagString(group
), value_tag
, ippTagString(value_tag
), name
));
577 value_tag
&= IPP_TAG_CUPS_MASK
;
580 * Range check input...
583 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
584 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
||
585 (value_tag
!= IPP_TAG_UNSUPPORTED_VALUE
&&
586 value_tag
!= IPP_TAG_DEFAULT
&&
587 value_tag
!= IPP_TAG_UNKNOWN
&&
588 value_tag
!= IPP_TAG_NOVALUE
&&
589 value_tag
!= IPP_TAG_NOTSETTABLE
&&
590 value_tag
!= IPP_TAG_DELETEATTR
&&
591 value_tag
!= IPP_TAG_ADMINDEFINE
))
595 * Create the attribute...
598 return (ipp_add_attr(ipp
, name
, group
, value_tag
, 1));
603 * 'ippAddRange()' - Add a range of values to an IPP message.
605 * The @code ipp@ parameter refers to an IPP message previously created using
606 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
608 * The @code group@ parameter specifies the IPP attribute group tag: none
609 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
610 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
611 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
612 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
614 * The @code lower@ parameter must be less than or equal to the @code upper@ parameter.
617 ipp_attribute_t
* /* O - New attribute */
618 ippAddRange(ipp_t
*ipp
, /* I - IPP message */
619 ipp_tag_t group
, /* I - IPP group */
620 const char *name
, /* I - Name of attribute */
621 int lower
, /* I - Lower value */
622 int upper
) /* I - Upper value */
624 ipp_attribute_t
*attr
; /* New attribute */
627 DEBUG_printf(("ippAddRange(ipp=%p, group=%02x(%s), name=\"%s\", lower=%d, upper=%d)", (void *)ipp
, group
, ippTagString(group
), name
, lower
, upper
));
630 * Range check input...
633 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
634 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
)
638 * Create the attribute...
641 if ((attr
= ipp_add_attr(ipp
, name
, group
, IPP_TAG_RANGE
, 1)) == NULL
)
644 attr
->values
[0].range
.lower
= lower
;
645 attr
->values
[0].range
.upper
= upper
;
652 * 'ippAddRanges()' - Add ranges of values to an IPP message.
654 * The @code ipp@ parameter refers to an IPP message previously created using
655 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
657 * The @code group@ parameter specifies the IPP attribute group tag: none
658 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
659 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
660 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
661 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
664 ipp_attribute_t
* /* O - New attribute */
665 ippAddRanges(ipp_t
*ipp
, /* I - IPP message */
666 ipp_tag_t group
, /* I - IPP group */
667 const char *name
, /* I - Name of attribute */
668 int num_values
, /* I - Number of values */
669 const int *lower
, /* I - Lower values */
670 const int *upper
) /* I - Upper values */
672 int i
; /* Looping var */
673 ipp_attribute_t
*attr
; /* New attribute */
674 _ipp_value_t
*value
; /* Current value */
677 DEBUG_printf(("ippAddRanges(ipp=%p, group=%02x(%s), name=\"%s\", num_values=%d, lower=%p, upper=%p)", (void *)ipp
, group
, ippTagString(group
), name
, num_values
, (void *)lower
, (void *)upper
));
680 * Range check input...
683 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
684 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
||
689 * Create the attribute...
692 if ((attr
= ipp_add_attr(ipp
, name
, group
, IPP_TAG_RANGE
, num_values
)) == NULL
)
697 for (i
= num_values
, value
= attr
->values
;
701 value
->range
.lower
= *lower
++;
702 value
->range
.upper
= *upper
++;
711 * 'ippAddResolution()' - Add a resolution value to an IPP message.
713 * The @code ipp@ parameter refers to an IPP message previously created using
714 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
716 * The @code group@ parameter specifies the IPP attribute group tag: none
717 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
718 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
719 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
720 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
723 ipp_attribute_t
* /* O - New attribute */
724 ippAddResolution(ipp_t
*ipp
, /* I - IPP message */
725 ipp_tag_t group
, /* I - IPP group */
726 const char *name
, /* I - Name of attribute */
727 ipp_res_t units
, /* I - Units for resolution */
728 int xres
, /* I - X resolution */
729 int yres
) /* I - Y resolution */
731 ipp_attribute_t
*attr
; /* New attribute */
734 DEBUG_printf(("ippAddResolution(ipp=%p, group=%02x(%s), name=\"%s\", units=%d, xres=%d, yres=%d)", (void *)ipp
, group
,
735 ippTagString(group
), name
, units
, xres
, yres
));
738 * Range check input...
741 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
742 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
||
743 units
< IPP_RES_PER_INCH
|| units
> IPP_RES_PER_CM
||
744 xres
< 0 || yres
< 0)
748 * Create the attribute...
751 if ((attr
= ipp_add_attr(ipp
, name
, group
, IPP_TAG_RESOLUTION
, 1)) == NULL
)
754 attr
->values
[0].resolution
.xres
= xres
;
755 attr
->values
[0].resolution
.yres
= yres
;
756 attr
->values
[0].resolution
.units
= units
;
763 * 'ippAddResolutions()' - Add resolution values to an IPP message.
765 * The @code ipp@ parameter refers to an IPP message previously created using
766 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
768 * The @code group@ parameter specifies the IPP attribute group tag: none
769 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
770 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
771 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
772 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
775 ipp_attribute_t
* /* O - New attribute */
776 ippAddResolutions(ipp_t
*ipp
, /* I - IPP message */
777 ipp_tag_t group
, /* I - IPP group */
778 const char *name
, /* I - Name of attribute */
779 int num_values
,/* I - Number of values */
780 ipp_res_t units
, /* I - Units for resolution */
781 const int *xres
, /* I - X resolutions */
782 const int *yres
) /* I - Y resolutions */
784 int i
; /* Looping var */
785 ipp_attribute_t
*attr
; /* New attribute */
786 _ipp_value_t
*value
; /* Current value */
789 DEBUG_printf(("ippAddResolutions(ipp=%p, group=%02x(%s), name=\"%s\", num_value=%d, units=%d, xres=%p, yres=%p)", (void *)ipp
, group
, ippTagString(group
), name
, num_values
, units
, (void *)xres
, (void *)yres
));
792 * Range check input...
795 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
796 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
||
798 units
< IPP_RES_PER_INCH
|| units
> IPP_RES_PER_CM
)
802 * Create the attribute...
805 if ((attr
= ipp_add_attr(ipp
, name
, group
, IPP_TAG_RESOLUTION
, num_values
)) == NULL
)
810 for (i
= num_values
, value
= attr
->values
;
814 value
->resolution
.xres
= *xres
++;
815 value
->resolution
.yres
= *yres
++;
816 value
->resolution
.units
= units
;
825 * 'ippAddSeparator()' - Add a group separator to an IPP message.
827 * The @code ipp@ parameter refers to an IPP message previously created using
828 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
831 ipp_attribute_t
* /* O - New attribute */
832 ippAddSeparator(ipp_t
*ipp
) /* I - IPP message */
834 DEBUG_printf(("ippAddSeparator(ipp=%p)", (void *)ipp
));
837 * Range check input...
844 * Create the attribute...
847 return (ipp_add_attr(ipp
, NULL
, IPP_TAG_ZERO
, IPP_TAG_ZERO
, 0));
852 * 'ippAddString()' - Add a language-encoded string to an IPP message.
854 * The @code ipp@ parameter refers to an IPP message previously created using
855 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
857 * The @code group@ parameter specifies the IPP attribute group tag: none
858 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
859 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
860 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
861 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
863 * Supported string values include charset (@code IPP_TAG_CHARSET@), keyword
864 * (@code IPP_TAG_KEYWORD@), language (@code IPP_TAG_LANGUAGE@), mimeMediaType
865 * (@code IPP_TAG_MIMETYPE@), name (@code IPP_TAG_NAME@), nameWithLanguage
866 * (@code IPP_TAG_NAMELANG), text (@code IPP_TAG_TEXT@), textWithLanguage
867 * (@code IPP_TAG_TEXTLANG@), uri (@code IPP_TAG_URI@), and uriScheme
868 * (@code IPP_TAG_URISCHEME@).
870 * The @code language@ parameter must be non-@code NULL@ for nameWithLanguage and
871 * textWithLanguage string values and must be @code NULL@ for all other string values.
874 ipp_attribute_t
* /* O - New attribute */
875 ippAddString(ipp_t
*ipp
, /* I - IPP message */
876 ipp_tag_t group
, /* I - IPP group */
877 ipp_tag_t value_tag
, /* I - Type of attribute */
878 const char *name
, /* I - Name of attribute */
879 const char *language
, /* I - Language code */
880 const char *value
) /* I - Value */
882 ipp_tag_t temp_tag
; /* Temporary value tag (masked) */
883 ipp_attribute_t
*attr
; /* New attribute */
884 char code
[IPP_MAX_LANGUAGE
];
885 /* Charset/language code buffer */
888 DEBUG_printf(("ippAddString(ipp=%p, group=%02x(%s), value_tag=%02x(%s), name=\"%s\", language=\"%s\", value=\"%s\")", (void *)ipp
, group
, ippTagString(group
), value_tag
, ippTagString(value_tag
), name
, language
, value
));
891 * Range check input...
894 temp_tag
= (ipp_tag_t
)((int)value_tag
& IPP_TAG_CUPS_MASK
);
897 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
898 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
||
899 (temp_tag
< IPP_TAG_TEXT
&& temp_tag
!= IPP_TAG_TEXTLANG
&&
900 temp_tag
!= IPP_TAG_NAMELANG
) || temp_tag
> IPP_TAG_MIMETYPE
)
903 if ((temp_tag
== IPP_TAG_TEXTLANG
|| temp_tag
== IPP_TAG_NAMELANG
)
904 != (language
!= NULL
))
907 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
908 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
)
913 * See if we need to map charset, language, or locale values...
916 if (language
&& ((int)value_tag
& IPP_TAG_CUPS_CONST
) &&
917 strcmp(language
, ipp_lang_code(language
, code
, sizeof(code
))))
918 value_tag
= temp_tag
; /* Don't do a fast copy */
919 else if (value
&& value_tag
== (ipp_tag_t
)(IPP_TAG_CHARSET
| IPP_TAG_CUPS_CONST
) &&
920 strcmp(value
, ipp_get_code(value
, code
, sizeof(code
))))
921 value_tag
= temp_tag
; /* Don't do a fast copy */
922 else if (value
&& value_tag
== (ipp_tag_t
)(IPP_TAG_LANGUAGE
| IPP_TAG_CUPS_CONST
) &&
923 strcmp(value
, ipp_lang_code(value
, code
, sizeof(code
))))
924 value_tag
= temp_tag
; /* Don't do a fast copy */
927 * Create the attribute...
930 if ((attr
= ipp_add_attr(ipp
, name
, group
, value_tag
, 1)) == NULL
)
934 * Initialize the attribute data...
937 if ((int)value_tag
& IPP_TAG_CUPS_CONST
)
939 attr
->values
[0].string
.language
= (char *)language
;
940 attr
->values
[0].string
.text
= (char *)value
;
945 attr
->values
[0].string
.language
= _cupsStrAlloc(ipp_lang_code(language
, code
,
950 if (value_tag
== IPP_TAG_CHARSET
)
951 attr
->values
[0].string
.text
= _cupsStrAlloc(ipp_get_code(value
, code
,
953 else if (value_tag
== IPP_TAG_LANGUAGE
)
954 attr
->values
[0].string
.text
= _cupsStrAlloc(ipp_lang_code(value
, code
,
957 attr
->values
[0].string
.text
= _cupsStrAlloc(value
);
966 * 'ippAddStringf()' - Add a formatted string to an IPP message.
968 * The @code ipp@ parameter refers to an IPP message previously created using
969 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
971 * The @code group@ parameter specifies the IPP attribute group tag: none
972 * (@code IPP_TAG_ZERO@, for member attributes), document
973 * (@code IPP_TAG_DOCUMENT@), event notification
974 * (@code IPP_TAG_EVENT_NOTIFICATION@), operation (@code IPP_TAG_OPERATION@),
975 * printer (@code IPP_TAG_PRINTER@), subscription (@code IPP_TAG_SUBSCRIPTION@),
976 * or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
978 * Supported string values include charset (@code IPP_TAG_CHARSET@), keyword
979 * (@code IPP_TAG_KEYWORD@), language (@code IPP_TAG_LANGUAGE@), mimeMediaType
980 * (@code IPP_TAG_MIMETYPE@), name (@code IPP_TAG_NAME@), nameWithLanguage
981 * (@code IPP_TAG_NAMELANG), text (@code IPP_TAG_TEXT@), textWithLanguage
982 * (@code IPP_TAG_TEXTLANG@), uri (@code IPP_TAG_URI@), and uriScheme
983 * (@code IPP_TAG_URISCHEME@).
985 * The @code language@ parameter must be non-@code NULL@ for nameWithLanguage
986 * and textWithLanguage string values and must be @code NULL@ for all other
989 * The @code format@ parameter uses formatting characters compatible with the
990 * printf family of standard functions. Additional arguments follow it as
991 * needed. The formatted string is truncated as needed to the maximum length of
992 * the corresponding value type.
994 * @since CUPS 1.7/macOS 10.9@
997 ipp_attribute_t
* /* O - New attribute */
998 ippAddStringf(ipp_t
*ipp
, /* I - IPP message */
999 ipp_tag_t group
, /* I - IPP group */
1000 ipp_tag_t value_tag
, /* I - Type of attribute */
1001 const char *name
, /* I - Name of attribute */
1002 const char *language
, /* I - Language code (@code NULL@ for default) */
1003 const char *format
, /* I - Printf-style format string */
1004 ...) /* I - Additional arguments as needed */
1006 ipp_attribute_t
*attr
; /* New attribute */
1007 va_list ap
; /* Argument pointer */
1010 va_start(ap
, format
);
1011 attr
= ippAddStringfv(ipp
, group
, value_tag
, name
, language
, format
, ap
);
1019 * 'ippAddStringfv()' - Add a formatted string to an IPP message.
1021 * The @code ipp@ parameter refers to an IPP message previously created using
1022 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
1024 * The @code group@ parameter specifies the IPP attribute group tag: none
1025 * (@code IPP_TAG_ZERO@, for member attributes), document
1026 * (@code IPP_TAG_DOCUMENT@), event notification
1027 * (@code IPP_TAG_EVENT_NOTIFICATION@), operation (@code IPP_TAG_OPERATION@),
1028 * printer (@code IPP_TAG_PRINTER@), subscription (@code IPP_TAG_SUBSCRIPTION@),
1029 * or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
1031 * Supported string values include charset (@code IPP_TAG_CHARSET@), keyword
1032 * (@code IPP_TAG_KEYWORD@), language (@code IPP_TAG_LANGUAGE@), mimeMediaType
1033 * (@code IPP_TAG_MIMETYPE@), name (@code IPP_TAG_NAME@), nameWithLanguage
1034 * (@code IPP_TAG_NAMELANG), text (@code IPP_TAG_TEXT@), textWithLanguage
1035 * (@code IPP_TAG_TEXTLANG@), uri (@code IPP_TAG_URI@), and uriScheme
1036 * (@code IPP_TAG_URISCHEME@).
1038 * The @code language@ parameter must be non-@code NULL@ for nameWithLanguage
1039 * and textWithLanguage string values and must be @code NULL@ for all other
1042 * The @code format@ parameter uses formatting characters compatible with the
1043 * printf family of standard functions. Additional arguments are passed in the
1044 * stdarg pointer @code ap@. The formatted string is truncated as needed to the
1045 * maximum length of the corresponding value type.
1047 * @since CUPS 1.7/macOS 10.9@
1050 ipp_attribute_t
* /* O - New attribute */
1051 ippAddStringfv(ipp_t
*ipp
, /* I - IPP message */
1052 ipp_tag_t group
, /* I - IPP group */
1053 ipp_tag_t value_tag
, /* I - Type of attribute */
1054 const char *name
, /* I - Name of attribute */
1055 const char *language
, /* I - Language code (@code NULL@ for default) */
1056 const char *format
, /* I - Printf-style format string */
1057 va_list ap
) /* I - Additional arguments */
1059 char buffer
[IPP_MAX_TEXT
+ 4];
1060 /* Formatted text string */
1061 ssize_t bytes
, /* Length of formatted value */
1062 max_bytes
; /* Maximum number of bytes for value */
1066 * Range check input...
1069 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
1070 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
||
1071 (value_tag
< IPP_TAG_TEXT
&& value_tag
!= IPP_TAG_TEXTLANG
&&
1072 value_tag
!= IPP_TAG_NAMELANG
) || value_tag
> IPP_TAG_MIMETYPE
||
1076 if ((value_tag
== IPP_TAG_TEXTLANG
|| value_tag
== IPP_TAG_NAMELANG
)
1077 != (language
!= NULL
))
1081 * Format the string...
1084 if (!strcmp(format
, "%s"))
1087 * Optimize the simple case...
1090 const char *s
= va_arg(ap
, char *);
1095 bytes
= (ssize_t
)strlen(s
);
1096 strlcpy(buffer
, s
, sizeof(buffer
));
1101 * Do a full formatting of the message...
1104 if ((bytes
= vsnprintf(buffer
, sizeof(buffer
), format
, ap
)) < 0)
1109 * Limit the length of the string...
1116 case IPP_TAG_TEXTLANG
:
1117 max_bytes
= IPP_MAX_TEXT
;
1121 case IPP_TAG_NAMELANG
:
1122 max_bytes
= IPP_MAX_NAME
;
1125 case IPP_TAG_CHARSET
:
1126 max_bytes
= IPP_MAX_CHARSET
;
1129 case IPP_TAG_KEYWORD
:
1130 max_bytes
= IPP_MAX_KEYWORD
;
1133 case IPP_TAG_LANGUAGE
:
1134 max_bytes
= IPP_MAX_LANGUAGE
;
1137 case IPP_TAG_MIMETYPE
:
1138 max_bytes
= IPP_MAX_MIMETYPE
;
1142 max_bytes
= IPP_MAX_URI
;
1145 case IPP_TAG_URISCHEME
:
1146 max_bytes
= IPP_MAX_URISCHEME
;
1150 if (bytes
>= max_bytes
)
1152 char *bufmax
, /* Buffer at max_bytes */
1153 *bufptr
; /* Pointer into buffer */
1155 bufptr
= buffer
+ strlen(buffer
) - 1;
1156 bufmax
= buffer
+ max_bytes
- 1;
1158 while (bufptr
> bufmax
)
1162 while ((*bufptr
& 0xc0) == 0x80 && bufptr
> buffer
)
1173 * Add the formatted string and return...
1176 return (ippAddString(ipp
, group
, value_tag
, name
, language
, buffer
));
1181 * 'ippAddStrings()' - Add language-encoded strings to an IPP message.
1183 * The @code ipp@ parameter refers to an IPP message previously created using
1184 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
1186 * The @code group@ parameter specifies the IPP attribute group tag: none
1187 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
1188 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
1189 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
1190 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
1192 * Supported string values include charset (@code IPP_TAG_CHARSET@), keyword
1193 * (@code IPP_TAG_KEYWORD@), language (@code IPP_TAG_LANGUAGE@), mimeMediaType
1194 * (@code IPP_TAG_MIMETYPE@), name (@code IPP_TAG_NAME@), nameWithLanguage
1195 * (@code IPP_TAG_NAMELANG), text (@code IPP_TAG_TEXT@), textWithLanguage
1196 * (@code IPP_TAG_TEXTLANG@), uri (@code IPP_TAG_URI@), and uriScheme
1197 * (@code IPP_TAG_URISCHEME@).
1199 * The @code language@ parameter must be non-@code NULL@ for nameWithLanguage and
1200 * textWithLanguage string values and must be @code NULL@ for all other string values.
1203 ipp_attribute_t
* /* O - New attribute */
1205 ipp_t
*ipp
, /* I - IPP message */
1206 ipp_tag_t group
, /* I - IPP group */
1207 ipp_tag_t value_tag
, /* I - Type of attribute */
1208 const char *name
, /* I - Name of attribute */
1209 int num_values
, /* I - Number of values */
1210 const char *language
, /* I - Language code (@code NULL@ for default) */
1211 const char * const *values
) /* I - Values */
1213 int i
; /* Looping var */
1214 ipp_tag_t temp_tag
; /* Temporary value tag (masked) */
1215 ipp_attribute_t
*attr
; /* New attribute */
1216 _ipp_value_t
*value
; /* Current value */
1217 char code
[32]; /* Language/charset value buffer */
1220 DEBUG_printf(("ippAddStrings(ipp=%p, group=%02x(%s), value_tag=%02x(%s), name=\"%s\", num_values=%d, language=\"%s\", values=%p)", (void *)ipp
, group
, ippTagString(group
), value_tag
, ippTagString(value_tag
), name
, num_values
, language
, (void *)values
));
1223 * Range check input...
1226 temp_tag
= (ipp_tag_t
)((int)value_tag
& IPP_TAG_CUPS_MASK
);
1229 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
1230 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
||
1231 (temp_tag
< IPP_TAG_TEXT
&& temp_tag
!= IPP_TAG_TEXTLANG
&&
1232 temp_tag
!= IPP_TAG_NAMELANG
) || temp_tag
> IPP_TAG_MIMETYPE
||
1236 if ((temp_tag
== IPP_TAG_TEXTLANG
|| temp_tag
== IPP_TAG_NAMELANG
)
1237 != (language
!= NULL
))
1240 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
1241 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
||
1247 * See if we need to map charset, language, or locale values...
1250 if (language
&& ((int)value_tag
& IPP_TAG_CUPS_CONST
) &&
1251 strcmp(language
, ipp_lang_code(language
, code
, sizeof(code
))))
1252 value_tag
= temp_tag
; /* Don't do a fast copy */
1253 else if (values
&& value_tag
== (ipp_tag_t
)(IPP_TAG_CHARSET
| IPP_TAG_CUPS_CONST
))
1255 for (i
= 0; i
< num_values
; i
++)
1256 if (strcmp(values
[i
], ipp_get_code(values
[i
], code
, sizeof(code
))))
1258 value_tag
= temp_tag
; /* Don't do a fast copy */
1262 else if (values
&& value_tag
== (ipp_tag_t
)(IPP_TAG_LANGUAGE
| IPP_TAG_CUPS_CONST
))
1264 for (i
= 0; i
< num_values
; i
++)
1265 if (strcmp(values
[i
], ipp_lang_code(values
[i
], code
, sizeof(code
))))
1267 value_tag
= temp_tag
; /* Don't do a fast copy */
1273 * Create the attribute...
1276 if ((attr
= ipp_add_attr(ipp
, name
, group
, value_tag
, num_values
)) == NULL
)
1280 * Initialize the attribute data...
1283 for (i
= num_values
, value
= attr
->values
;
1289 if (value
== attr
->values
)
1291 if ((int)value_tag
& IPP_TAG_CUPS_CONST
)
1292 value
->string
.language
= (char *)language
;
1294 value
->string
.language
= _cupsStrAlloc(ipp_lang_code(language
, code
,
1298 value
->string
.language
= attr
->values
[0].string
.language
;
1303 if ((int)value_tag
& IPP_TAG_CUPS_CONST
)
1304 value
->string
.text
= (char *)*values
++;
1305 else if (value_tag
== IPP_TAG_CHARSET
)
1306 value
->string
.text
= _cupsStrAlloc(ipp_get_code(*values
++, code
, sizeof(code
)));
1307 else if (value_tag
== IPP_TAG_LANGUAGE
)
1308 value
->string
.text
= _cupsStrAlloc(ipp_lang_code(*values
++, code
, sizeof(code
)));
1310 value
->string
.text
= _cupsStrAlloc(*values
++);
1319 * 'ippContainsInteger()' - Determine whether an attribute contains the
1320 * specified value or is within the list of ranges.
1322 * Returns non-zero when the attribute contains either a matching integer or
1323 * enum value, or the value falls within one of the rangeOfInteger values for
1326 * @since CUPS 1.7/macOS 10.9@
1329 int /* O - 1 on a match, 0 on no match */
1331 ipp_attribute_t
*attr
, /* I - Attribute */
1332 int value
) /* I - Integer/enum value */
1334 int i
; /* Looping var */
1335 _ipp_value_t
*avalue
; /* Current attribute value */
1339 * Range check input...
1345 if (attr
->value_tag
!= IPP_TAG_INTEGER
&& attr
->value_tag
!= IPP_TAG_ENUM
&&
1346 attr
->value_tag
!= IPP_TAG_RANGE
)
1353 if (attr
->value_tag
== IPP_TAG_RANGE
)
1355 for (i
= attr
->num_values
, avalue
= attr
->values
; i
> 0; i
--, avalue
++)
1356 if (value
>= avalue
->range
.lower
&& value
<= avalue
->range
.upper
)
1361 for (i
= attr
->num_values
, avalue
= attr
->values
; i
> 0; i
--, avalue
++)
1362 if (value
== avalue
->integer
)
1371 * 'ippContainsString()' - Determine whether an attribute contains the
1372 * specified string value.
1374 * Returns non-zero when the attribute contains a matching charset, keyword,
1375 * naturalLanguage, mimeMediaType, name, text, uri, or uriScheme value.
1377 * @since CUPS 1.7/macOS 10.9@
1380 int /* O - 1 on a match, 0 on no match */
1382 ipp_attribute_t
*attr
, /* I - Attribute */
1383 const char *value
) /* I - String value */
1385 int i
; /* Looping var */
1386 _ipp_value_t
*avalue
; /* Current attribute value */
1389 DEBUG_printf(("ippContainsString(attr=%p, value=\"%s\")", (void *)attr
, value
));
1392 * Range check input...
1395 if (!attr
|| !value
)
1397 DEBUG_puts("1ippContainsString: Returning 0 (bad input)");
1405 DEBUG_printf(("1ippContainsString: attr %s, %s with %d values.",
1406 attr
->name
, ippTagString(attr
->value_tag
),
1409 switch (attr
->value_tag
& IPP_TAG_CUPS_MASK
)
1411 case IPP_TAG_CHARSET
:
1412 case IPP_TAG_KEYWORD
:
1413 case IPP_TAG_LANGUAGE
:
1415 case IPP_TAG_URISCHEME
:
1416 for (i
= attr
->num_values
, avalue
= attr
->values
;
1420 DEBUG_printf(("1ippContainsString: value[%d]=\"%s\"",
1421 attr
->num_values
- i
, avalue
->string
.text
));
1423 if (!strcmp(value
, avalue
->string
.text
))
1425 DEBUG_puts("1ippContainsString: Returning 1 (match)");
1430 case IPP_TAG_MIMETYPE
:
1432 case IPP_TAG_NAMELANG
:
1434 case IPP_TAG_TEXTLANG
:
1435 for (i
= attr
->num_values
, avalue
= attr
->values
;
1439 DEBUG_printf(("1ippContainsString: value[%d]=\"%s\"",
1440 attr
->num_values
- i
, avalue
->string
.text
));
1442 if (!_cups_strcasecmp(value
, avalue
->string
.text
))
1444 DEBUG_puts("1ippContainsString: Returning 1 (match)");
1453 DEBUG_puts("1ippContainsString: Returning 0 (no match)");
1460 * 'ippCopyAttribute()' - Copy an attribute.
1462 * The specified attribute, @code attr@, is copied to the destination IPP message.
1463 * When @code quickcopy@ is non-zero, a "shallow" reference copy of the attribute is
1464 * created - this should only be done as long as the original source IPP message will
1465 * not be freed for the life of the destination.
1467 * @since CUPS 1.6/macOS 10.8@
1471 ipp_attribute_t
* /* O - New attribute */
1473 ipp_t
*dst
, /* I - Destination IPP message */
1474 ipp_attribute_t
*srcattr
, /* I - Attribute to copy */
1475 int quickcopy
) /* I - 1 for a referenced copy, 0 for normal */
1477 int i
; /* Looping var */
1478 ipp_tag_t srctag
; /* Source value tag */
1479 ipp_attribute_t
*dstattr
; /* Destination attribute */
1480 _ipp_value_t
*srcval
, /* Source value */
1481 *dstval
; /* Destination value */
1484 DEBUG_printf(("ippCopyAttribute(dst=%p, srcattr=%p, quickcopy=%d)", (void *)dst
, (void *)srcattr
, quickcopy
));
1487 * Range check input...
1490 if (!dst
|| !srcattr
)
1497 quickcopy
= (quickcopy
&& (srcattr
->value_tag
& IPP_TAG_CUPS_CONST
)) ? IPP_TAG_CUPS_CONST
: 0;
1498 srctag
= srcattr
->value_tag
& IPP_TAG_CUPS_MASK
;
1503 dstattr
= ippAddSeparator(dst
);
1506 case IPP_TAG_UNSUPPORTED_VALUE
:
1507 case IPP_TAG_DEFAULT
:
1508 case IPP_TAG_UNKNOWN
:
1509 case IPP_TAG_NOVALUE
:
1510 case IPP_TAG_NOTSETTABLE
:
1511 case IPP_TAG_DELETEATTR
:
1512 case IPP_TAG_ADMINDEFINE
:
1513 dstattr
= ippAddOutOfBand(dst
, srcattr
->group_tag
, srctag
, srcattr
->name
);
1516 case IPP_TAG_INTEGER
:
1518 case IPP_TAG_BOOLEAN
:
1520 case IPP_TAG_RESOLUTION
:
1521 case IPP_TAG_RANGE
:
1522 if ((dstattr
= ipp_add_attr(dst
, srcattr
->name
, srcattr
->group_tag
, srctag
, srcattr
->num_values
)) != NULL
)
1523 memcpy(dstattr
->values
, srcattr
->values
, (size_t)srcattr
->num_values
* sizeof(_ipp_value_t
));
1528 case IPP_TAG_RESERVED_STRING
:
1529 case IPP_TAG_KEYWORD
:
1531 case IPP_TAG_URISCHEME
:
1532 case IPP_TAG_CHARSET
:
1533 case IPP_TAG_LANGUAGE
:
1534 case IPP_TAG_MIMETYPE
:
1535 if ((dstattr
= ippAddStrings(dst
, srcattr
->group_tag
, (ipp_tag_t
)(srctag
| quickcopy
), srcattr
->name
, srcattr
->num_values
, NULL
, NULL
)) == NULL
)
1541 * Can safely quick-copy these string values...
1544 memcpy(dstattr
->values
, srcattr
->values
, (size_t)srcattr
->num_values
* sizeof(_ipp_value_t
));
1549 * Otherwise do a normal reference counted copy...
1552 for (i
= srcattr
->num_values
, srcval
= srcattr
->values
, dstval
= dstattr
->values
; i
> 0; i
--, srcval
++, dstval
++)
1553 dstval
->string
.text
= _cupsStrAlloc(srcval
->string
.text
);
1557 case IPP_TAG_TEXTLANG
:
1558 case IPP_TAG_NAMELANG
:
1559 if ((dstattr
= ippAddStrings(dst
, srcattr
->group_tag
, (ipp_tag_t
)(srctag
| quickcopy
), srcattr
->name
, srcattr
->num_values
, NULL
, NULL
)) == NULL
)
1565 * Can safely quick-copy these string values...
1568 memcpy(dstattr
->values
, srcattr
->values
, (size_t)srcattr
->num_values
* sizeof(_ipp_value_t
));
1570 else if (srcattr
->value_tag
& IPP_TAG_CUPS_CONST
)
1573 * Otherwise do a normal reference counted copy...
1576 for (i
= srcattr
->num_values
, srcval
= srcattr
->values
, dstval
= dstattr
->values
; i
> 0; i
--, srcval
++, dstval
++)
1578 if (srcval
== srcattr
->values
)
1579 dstval
->string
.language
= _cupsStrAlloc(srcval
->string
.language
);
1581 dstval
->string
.language
= dstattr
->values
[0].string
.language
;
1583 dstval
->string
.text
= _cupsStrAlloc(srcval
->string
.text
);
1588 case IPP_TAG_BEGIN_COLLECTION
:
1589 if ((dstattr
= ippAddCollections(dst
, srcattr
->group_tag
, srcattr
->name
, srcattr
->num_values
, NULL
)) == NULL
)
1592 for (i
= srcattr
->num_values
, srcval
= srcattr
->values
, dstval
= dstattr
->values
; i
> 0; i
--, srcval
++, dstval
++)
1594 dstval
->collection
= srcval
->collection
;
1595 srcval
->collection
->use
++;
1599 case IPP_TAG_STRING
:
1601 if ((dstattr
= ipp_add_attr(dst
, srcattr
->name
, srcattr
->group_tag
, srctag
, srcattr
->num_values
)) == NULL
)
1604 for (i
= srcattr
->num_values
, srcval
= srcattr
->values
, dstval
= dstattr
->values
; i
> 0; i
--, srcval
++, dstval
++)
1606 dstval
->unknown
.length
= srcval
->unknown
.length
;
1608 if (dstval
->unknown
.length
> 0)
1610 if ((dstval
->unknown
.data
= malloc((size_t)dstval
->unknown
.length
)) == NULL
)
1611 dstval
->unknown
.length
= 0;
1613 memcpy(dstval
->unknown
.data
, srcval
->unknown
.data
, (size_t)dstval
->unknown
.length
);
1616 break; /* anti-compiler-warning-code */
1624 * 'ippCopyAttributes()' - Copy attributes from one IPP message to another.
1626 * Zero or more attributes are copied from the source IPP message, @code src@, to the
1627 * destination IPP message, @code dst@. When @code quickcopy@ is non-zero, a "shallow"
1628 * reference copy of the attribute is created - this should only be done as long as the
1629 * original source IPP message will not be freed for the life of the destination.
1631 * The @code cb@ and @code context@ parameters provide a generic way to "filter" the
1632 * attributes that are copied - the function must return 1 to copy the attribute or
1633 * 0 to skip it. The function may also choose to do a partial copy of the source attribute
1636 * @since CUPS 1.6/macOS 10.8@
1639 int /* O - 1 on success, 0 on error */
1641 ipp_t
*dst
, /* I - Destination IPP message */
1642 ipp_t
*src
, /* I - Source IPP message */
1643 int quickcopy
, /* I - 1 for a referenced copy, 0 for normal */
1644 ipp_copycb_t cb
, /* I - Copy callback or @code NULL@ for none */
1645 void *context
) /* I - Context pointer */
1647 ipp_attribute_t
*srcattr
; /* Source attribute */
1650 DEBUG_printf(("ippCopyAttributes(dst=%p, src=%p, quickcopy=%d, cb=%p, context=%p)", (void *)dst
, (void *)src
, quickcopy
, (void *)cb
, context
));
1653 * Range check input...
1660 * Loop through source attributes and copy as needed...
1663 for (srcattr
= src
->attrs
; srcattr
; srcattr
= srcattr
->next
)
1664 if (!cb
|| (*cb
)(context
, dst
, srcattr
))
1665 if (!ippCopyAttribute(dst
, srcattr
, quickcopy
))
1673 * 'ippDateToTime()' - Convert from RFC 2579 Date/Time format to time in
1677 time_t /* O - UNIX time value */
1678 ippDateToTime(const ipp_uchar_t
*date
) /* I - RFC 2579 date info */
1680 struct tm unixdate
; /* UNIX date/time info */
1681 time_t t
; /* Computed time */
1687 memset(&unixdate
, 0, sizeof(unixdate
));
1690 * RFC-2579 date/time format is:
1692 * Byte(s) Description
1693 * ------- -----------
1694 * 0-1 Year (0 to 65535)
1698 * 5 Minutes (0 to 59)
1699 * 6 Seconds (0 to 60, 60 = "leap second")
1700 * 7 Deciseconds (0 to 9)
1702 * 9 UTC hours (0 to 11)
1703 * 10 UTC minutes (0 to 59)
1706 unixdate
.tm_year
= ((date
[0] << 8) | date
[1]) - 1900;
1707 unixdate
.tm_mon
= date
[2] - 1;
1708 unixdate
.tm_mday
= date
[3];
1709 unixdate
.tm_hour
= date
[4];
1710 unixdate
.tm_min
= date
[5];
1711 unixdate
.tm_sec
= date
[6];
1713 t
= mktime(&unixdate
);
1716 t
+= date
[9] * 3600 + date
[10] * 60;
1718 t
-= date
[9] * 3600 + date
[10] * 60;
1725 * 'ippDelete()' - Delete an IPP message.
1729 ippDelete(ipp_t
*ipp
) /* I - IPP message */
1731 ipp_attribute_t
*attr
, /* Current attribute */
1732 *next
; /* Next attribute */
1735 DEBUG_printf(("ippDelete(ipp=%p)", (void *)ipp
));
1743 DEBUG_printf(("4debug_retain: %p IPP message (use=%d)", (void *)ipp
, ipp
->use
));
1747 DEBUG_printf(("4debug_free: %p IPP message", (void *)ipp
));
1749 for (attr
= ipp
->attrs
; attr
!= NULL
; attr
= next
)
1753 DEBUG_printf(("4debug_free: %p %s %s%s (%d values)", (void *)attr
, attr
->name
, attr
->num_values
> 1 ? "1setOf " : "", ippTagString(attr
->value_tag
), attr
->num_values
));
1755 ipp_free_values(attr
, 0, attr
->num_values
);
1758 _cupsStrFree(attr
->name
);
1768 * 'ippDeleteAttribute()' - Delete a single attribute in an IPP message.
1770 * @since CUPS 1.1.19/macOS 10.3@
1775 ipp_t
*ipp
, /* I - IPP message */
1776 ipp_attribute_t
*attr
) /* I - Attribute to delete */
1778 ipp_attribute_t
*current
, /* Current attribute */
1779 *prev
; /* Previous attribute */
1782 DEBUG_printf(("ippDeleteAttribute(ipp=%p, attr=%p(%s))", (void *)ipp
, (void *)attr
, attr
? attr
->name
: "(null)"));
1785 * Range check input...
1791 DEBUG_printf(("4debug_free: %p %s %s%s (%d values)", (void *)attr
, attr
->name
, attr
->num_values
> 1 ? "1setOf " : "", ippTagString(attr
->value_tag
), attr
->num_values
));
1794 * Find the attribute in the list...
1799 for (current
= ipp
->attrs
, prev
= NULL
;
1801 prev
= current
, current
= current
->next
)
1802 if (current
== attr
)
1805 * Found it, remove the attribute from the list...
1809 prev
->next
= current
->next
;
1811 ipp
->attrs
= current
->next
;
1813 if (current
== ipp
->last
)
1824 * Free memory used by the attribute...
1827 ipp_free_values(attr
, 0, attr
->num_values
);
1830 _cupsStrFree(attr
->name
);
1837 * 'ippDeleteValues()' - Delete values in an attribute.
1839 * The @code element@ parameter specifies the first value to delete, starting at
1840 * 0. It must be less than the number of values returned by @link ippGetCount@.
1842 * The @code attr@ parameter may be modified as a result of setting the value.
1844 * Deleting all values in an attribute deletes the attribute.
1846 * @since CUPS 1.6/macOS 10.8@
1849 int /* O - 1 on success, 0 on failure */
1851 ipp_t
*ipp
, /* I - IPP message */
1852 ipp_attribute_t
**attr
, /* IO - Attribute */
1853 int element
, /* I - Index of first value to delete (0-based) */
1854 int count
) /* I - Number of values to delete */
1857 * Range check input...
1860 if (!ipp
|| !attr
|| !*attr
||
1861 element
< 0 || element
>= (*attr
)->num_values
|| count
<= 0 ||
1862 (element
+ count
) >= (*attr
)->num_values
)
1866 * If we are deleting all values, just delete the attribute entirely.
1869 if (count
== (*attr
)->num_values
)
1871 ippDeleteAttribute(ipp
, *attr
);
1877 * Otherwise free the values in question and return.
1880 ipp_free_values(*attr
, element
, count
);
1887 * 'ippFindAttribute()' - Find a named attribute in a request.
1889 * Starting with CUPS 2.0, the attribute name can contain a hierarchical list
1890 * of attribute and member names separated by slashes, for example
1891 * "media-col/media-size".
1894 ipp_attribute_t
* /* O - Matching attribute */
1895 ippFindAttribute(ipp_t
*ipp
, /* I - IPP message */
1896 const char *name
, /* I - Name of attribute */
1897 ipp_tag_t type
) /* I - Type of attribute */
1899 DEBUG_printf(("2ippFindAttribute(ipp=%p, name=\"%s\", type=%02x(%s))", (void *)ipp
, name
, type
, ippTagString(type
)));
1905 * Reset the current pointer...
1908 ipp
->current
= NULL
;
1912 * Search for the attribute...
1915 return (ippFindNextAttribute(ipp
, name
, type
));
1920 * 'ippFindNextAttribute()' - Find the next named attribute in a request.
1922 * Starting with CUPS 2.0, the attribute name can contain a hierarchical list
1923 * of attribute and member names separated by slashes, for example
1924 * "media-col/media-size".
1927 ipp_attribute_t
* /* O - Matching attribute */
1928 ippFindNextAttribute(ipp_t
*ipp
, /* I - IPP message */
1929 const char *name
, /* I - Name of attribute */
1930 ipp_tag_t type
) /* I - Type of attribute */
1932 ipp_attribute_t
*attr
, /* Current atttribute */
1933 *childattr
; /* Child attribute */
1934 ipp_tag_t value_tag
; /* Value tag */
1935 char parent
[1024], /* Parent attribute name */
1936 *child
= NULL
; /* Child attribute name */
1939 DEBUG_printf(("2ippFindNextAttribute(ipp=%p, name=\"%s\", type=%02x(%s))", (void *)ipp
, name
, type
, ippTagString(type
)));
1944 DEBUG_printf(("3ippFindNextAttribute: atend=%d", ipp
->atend
));
1949 if (strchr(name
, '/'))
1952 * Search for child attribute...
1955 strlcpy(parent
, name
, sizeof(parent
));
1956 if ((child
= strchr(parent
, '/')) == NULL
)
1958 DEBUG_puts("3ippFindNextAttribute: Attribute name too long.");
1964 if (ipp
->current
&& ipp
->current
->name
&& ipp
->current
->value_tag
== IPP_TAG_BEGIN_COLLECTION
&& !strcmp(parent
, ipp
->current
->name
))
1966 while (ipp
->curindex
< ipp
->current
->num_values
)
1968 if ((childattr
= ippFindNextAttribute(ipp
->current
->values
[ipp
->curindex
].collection
, child
, type
)) != NULL
)
1972 if (ipp
->curindex
< ipp
->current
->num_values
&& ipp
->current
->values
[ipp
->curindex
].collection
)
1973 ipp
->current
->values
[ipp
->curindex
].collection
->current
= NULL
;
1976 ipp
->prev
= ipp
->current
;
1977 ipp
->current
= ipp
->current
->next
;
1990 ipp
->current
= ipp
->attrs
;
1995 attr
= ipp
->current
;
1997 else if (ipp
->current
)
1999 ipp
->prev
= ipp
->current
;
2000 attr
= ipp
->current
->next
;
2008 for (; attr
!= NULL
; ipp
->prev
= attr
, attr
= attr
->next
)
2010 DEBUG_printf(("4ippFindAttribute: attr=%p, name=\"%s\"", (void *)attr
, attr
->name
));
2012 value_tag
= (ipp_tag_t
)(attr
->value_tag
& IPP_TAG_CUPS_MASK
);
2014 if (attr
->name
!= NULL
&& _cups_strcasecmp(attr
->name
, name
) == 0 &&
2015 (value_tag
== type
|| type
== IPP_TAG_ZERO
|| name
== parent
||
2016 (value_tag
== IPP_TAG_TEXTLANG
&& type
== IPP_TAG_TEXT
) ||
2017 (value_tag
== IPP_TAG_NAMELANG
&& type
== IPP_TAG_NAME
)))
2019 ipp
->current
= attr
;
2021 if (name
== parent
&& attr
->value_tag
== IPP_TAG_BEGIN_COLLECTION
)
2023 int i
; /* Looping var */
2025 for (i
= 0; i
< attr
->num_values
; i
++)
2027 if ((childattr
= ippFindAttribute(attr
->values
[i
].collection
, child
, type
)) != NULL
)
2029 attr
->values
[0].collection
->curindex
= i
;
2039 ipp
->current
= NULL
;
2048 * 'ippFirstAttribute()' - Return the first attribute in the message.
2050 * @since CUPS 1.6/macOS 10.8@
2053 ipp_attribute_t
* /* O - First attribute or @code NULL@ if none */
2054 ippFirstAttribute(ipp_t
*ipp
) /* I - IPP message */
2057 * Range check input...
2064 * Return the first attribute...
2067 return (ipp
->current
= ipp
->attrs
);
2072 * 'ippGetBoolean()' - Get a boolean value for an attribute.
2074 * The @code element@ parameter specifies which value to get from 0 to
2075 * @code ippGetCount(attr)@ - 1.
2077 * @since CUPS 1.6/macOS 10.8@
2080 int /* O - Boolean value or 0 on error */
2081 ippGetBoolean(ipp_attribute_t
*attr
, /* I - IPP attribute */
2082 int element
) /* I - Value number (0-based) */
2085 * Range check input...
2088 if (!attr
|| attr
->value_tag
!= IPP_TAG_BOOLEAN
||
2089 element
< 0 || element
>= attr
->num_values
)
2093 * Return the value...
2096 return (attr
->values
[element
].boolean
);
2101 * 'ippGetCollection()' - Get a collection value for an attribute.
2103 * The @code element@ parameter specifies which value to get from 0 to
2104 * @code ippGetCount(attr)@ - 1.
2106 * @since CUPS 1.6/macOS 10.8@
2109 ipp_t
* /* O - Collection value or @code NULL@ on error */
2111 ipp_attribute_t
*attr
, /* I - IPP attribute */
2112 int element
) /* I - Value number (0-based) */
2115 * Range check input...
2118 if (!attr
|| attr
->value_tag
!= IPP_TAG_BEGIN_COLLECTION
||
2119 element
< 0 || element
>= attr
->num_values
)
2123 * Return the value...
2126 return (attr
->values
[element
].collection
);
2131 * 'ippGetCount()' - Get the number of values in an attribute.
2133 * @since CUPS 1.6/macOS 10.8@
2136 int /* O - Number of values or 0 on error */
2137 ippGetCount(ipp_attribute_t
*attr
) /* I - IPP attribute */
2140 * Range check input...
2147 * Return the number of values...
2150 return (attr
->num_values
);
2155 * 'ippGetDate()' - Get a dateTime value for an attribute.
2157 * The @code element@ parameter specifies which value to get from 0 to
2158 * @code ippGetCount(attr)@ - 1.
2160 * @since CUPS 1.6/macOS 10.8@
2163 const ipp_uchar_t
* /* O - dateTime value or @code NULL@ */
2164 ippGetDate(ipp_attribute_t
*attr
, /* I - IPP attribute */
2165 int element
) /* I - Value number (0-based) */
2168 * Range check input...
2171 if (!attr
|| attr
->value_tag
!= IPP_TAG_DATE
||
2172 element
< 0 || element
>= attr
->num_values
)
2176 * Return the value...
2179 return (attr
->values
[element
].date
);
2184 * 'ippGetGroupTag()' - Get the group associated with an attribute.
2186 * @since CUPS 1.6/macOS 10.8@
2189 ipp_tag_t
/* O - Group tag or @code IPP_TAG_ZERO@ on error */
2190 ippGetGroupTag(ipp_attribute_t
*attr
) /* I - IPP attribute */
2193 * Range check input...
2197 return (IPP_TAG_ZERO
);
2200 * Return the group...
2203 return (attr
->group_tag
);
2208 * 'ippGetInteger()' - Get the integer/enum value for an attribute.
2210 * The @code element@ parameter specifies which value to get from 0 to
2211 * @code ippGetCount(attr)@ - 1.
2213 * @since CUPS 1.6/macOS 10.8@
2216 int /* O - Value or 0 on error */
2217 ippGetInteger(ipp_attribute_t
*attr
, /* I - IPP attribute */
2218 int element
) /* I - Value number (0-based) */
2221 * Range check input...
2224 if (!attr
|| (attr
->value_tag
!= IPP_TAG_INTEGER
&& attr
->value_tag
!= IPP_TAG_ENUM
) ||
2225 element
< 0 || element
>= attr
->num_values
)
2229 * Return the value...
2232 return (attr
->values
[element
].integer
);
2237 * 'ippGetName()' - Get the attribute name.
2239 * @since CUPS 1.6/macOS 10.8@
2242 const char * /* O - Attribute name or @code NULL@ for separators */
2243 ippGetName(ipp_attribute_t
*attr
) /* I - IPP attribute */
2246 * Range check input...
2253 * Return the name...
2256 return (attr
->name
);
2261 * 'ippGetOctetString()' - Get an octetString value from an IPP attribute.
2263 * The @code element@ parameter specifies which value to get from 0 to
2264 * @code ippGetCount(attr)@ - 1.
2266 * @since CUPS 1.7/macOS 10.9@
2269 void * /* O - Pointer to octetString data */
2271 ipp_attribute_t
*attr
, /* I - IPP attribute */
2272 int element
, /* I - Value number (0-based) */
2273 int *datalen
) /* O - Length of octetString data */
2276 * Range check input...
2279 if (!attr
|| attr
->value_tag
!= IPP_TAG_STRING
||
2280 element
< 0 || element
>= attr
->num_values
)
2289 * Return the values...
2293 *datalen
= attr
->values
[element
].unknown
.length
;
2295 return (attr
->values
[element
].unknown
.data
);
2300 * 'ippGetOperation()' - Get the operation ID in an IPP message.
2302 * @since CUPS 1.6/macOS 10.8@
2305 ipp_op_t
/* O - Operation ID or 0 on error */
2306 ippGetOperation(ipp_t
*ipp
) /* I - IPP request message */
2309 * Range check input...
2313 return ((ipp_op_t
)0);
2316 * Return the value...
2319 return (ipp
->request
.op
.operation_id
);
2324 * 'ippGetRange()' - Get a rangeOfInteger value from an attribute.
2326 * The @code element@ parameter specifies which value to get from 0 to
2327 * @code ippGetCount(attr)@ - 1.
2329 * @since CUPS 1.6/macOS 10.8@
2332 int /* O - Lower value of range or 0 */
2333 ippGetRange(ipp_attribute_t
*attr
, /* I - IPP attribute */
2334 int element
, /* I - Value number (0-based) */
2335 int *uppervalue
)/* O - Upper value of range */
2338 * Range check input...
2341 if (!attr
|| attr
->value_tag
!= IPP_TAG_RANGE
||
2342 element
< 0 || element
>= attr
->num_values
)
2351 * Return the values...
2355 *uppervalue
= attr
->values
[element
].range
.upper
;
2357 return (attr
->values
[element
].range
.lower
);
2362 * 'ippGetRequestId()' - Get the request ID from an IPP message.
2364 * @since CUPS 1.6/macOS 10.8@
2367 int /* O - Request ID or 0 on error */
2368 ippGetRequestId(ipp_t
*ipp
) /* I - IPP message */
2371 * Range check input...
2378 * Return the request ID...
2381 return (ipp
->request
.any
.request_id
);
2386 * 'ippGetResolution()' - Get a resolution value for an attribute.
2388 * The @code element@ parameter specifies which value to get from 0 to
2389 * @code ippGetCount(attr)@ - 1.
2391 * @since CUPS 1.6/macOS 10.8@
2394 int /* O - Horizontal/cross feed resolution or 0 */
2396 ipp_attribute_t
*attr
, /* I - IPP attribute */
2397 int element
, /* I - Value number (0-based) */
2398 int *yres
, /* O - Vertical/feed resolution */
2399 ipp_res_t
*units
) /* O - Units for resolution */
2402 * Range check input...
2405 if (!attr
|| attr
->value_tag
!= IPP_TAG_RESOLUTION
||
2406 element
< 0 || element
>= attr
->num_values
)
2412 *units
= (ipp_res_t
)0;
2418 * Return the value...
2422 *yres
= attr
->values
[element
].resolution
.yres
;
2425 *units
= attr
->values
[element
].resolution
.units
;
2427 return (attr
->values
[element
].resolution
.xres
);
2432 * 'ippGetState()' - Get the IPP message state.
2434 * @since CUPS 1.6/macOS 10.8@
2437 ipp_state_t
/* O - IPP message state value */
2438 ippGetState(ipp_t
*ipp
) /* I - IPP message */
2441 * Range check input...
2445 return (IPP_STATE_IDLE
);
2448 * Return the value...
2451 return (ipp
->state
);
2456 * 'ippGetStatusCode()' - Get the status code from an IPP response or event message.
2458 * @since CUPS 1.6/macOS 10.8@
2461 ipp_status_t
/* O - Status code in IPP message */
2462 ippGetStatusCode(ipp_t
*ipp
) /* I - IPP response or event message */
2465 * Range check input...
2469 return (IPP_STATUS_ERROR_INTERNAL
);
2472 * Return the value...
2475 return (ipp
->request
.status
.status_code
);
2480 * 'ippGetString()' - Get the string and optionally the language code for an attribute.
2482 * The @code element@ parameter specifies which value to get from 0 to
2483 * @code ippGetCount(attr)@ - 1.
2485 * @since CUPS 1.6/macOS 10.8@
2489 ippGetString(ipp_attribute_t
*attr
, /* I - IPP attribute */
2490 int element
, /* I - Value number (0-based) */
2491 const char **language
)/* O - Language code (@code NULL@ for don't care) */
2493 ipp_tag_t tag
; /* Value tag */
2497 * Range check input...
2500 tag
= ippGetValueTag(attr
);
2502 if (!attr
|| element
< 0 || element
>= attr
->num_values
|| (tag
!= IPP_TAG_TEXTLANG
&& tag
!= IPP_TAG_NAMELANG
&& (tag
< IPP_TAG_TEXT
|| tag
> IPP_TAG_MIMETYPE
)))
2506 * Return the value...
2510 *language
= attr
->values
[element
].string
.language
;
2512 return (attr
->values
[element
].string
.text
);
2517 * 'ippGetValueTag()' - Get the value tag for an attribute.
2519 * @since CUPS 1.6/macOS 10.8@
2522 ipp_tag_t
/* O - Value tag or @code IPP_TAG_ZERO@ on error */
2523 ippGetValueTag(ipp_attribute_t
*attr
) /* I - IPP attribute */
2526 * Range check input...
2530 return (IPP_TAG_ZERO
);
2533 * Return the value...
2536 return (attr
->value_tag
& IPP_TAG_CUPS_MASK
);
2541 * 'ippGetVersion()' - Get the major and minor version number from an IPP message.
2543 * @since CUPS 1.6/macOS 10.8@
2546 int /* O - Major version number or 0 on error */
2547 ippGetVersion(ipp_t
*ipp
, /* I - IPP message */
2548 int *minor
) /* O - Minor version number or @code NULL@ for don't care */
2551 * Range check input...
2563 * Return the value...
2567 *minor
= ipp
->request
.any
.version
[1];
2569 return (ipp
->request
.any
.version
[0]);
2574 * 'ippLength()' - Compute the length of an IPP message.
2577 size_t /* O - Size of IPP message */
2578 ippLength(ipp_t
*ipp
) /* I - IPP message */
2580 return (ipp_length(ipp
, 0));
2585 * 'ippNextAttribute()' - Return the next attribute in the message.
2587 * @since CUPS 1.6/macOS 10.8@
2590 ipp_attribute_t
* /* O - Next attribute or @code NULL@ if none */
2591 ippNextAttribute(ipp_t
*ipp
) /* I - IPP message */
2594 * Range check input...
2597 if (!ipp
|| !ipp
->current
)
2601 * Return the next attribute...
2604 return (ipp
->current
= ipp
->current
->next
);
2609 * 'ippNew()' - Allocate a new IPP message.
2612 ipp_t
* /* O - New IPP message */
2615 ipp_t
*temp
; /* New IPP message */
2616 _cups_globals_t
*cg
= _cupsGlobals();
2620 DEBUG_puts("ippNew()");
2622 if ((temp
= (ipp_t
*)calloc(1, sizeof(ipp_t
))) != NULL
)
2625 * Set default version - usually 2.0...
2628 DEBUG_printf(("4debug_alloc: %p IPP message", (void *)temp
));
2630 if (cg
->server_version
== 0)
2633 temp
->request
.any
.version
[0] = (ipp_uchar_t
)(cg
->server_version
/ 10);
2634 temp
->request
.any
.version
[1] = (ipp_uchar_t
)(cg
->server_version
% 10);
2638 DEBUG_printf(("1ippNew: Returning %p", (void *)temp
));
2645 * 'ippNewRequest()' - Allocate a new IPP request message.
2647 * The new request message is initialized with the "attributes-charset" and
2648 * "attributes-natural-language" attributes added. The
2649 * "attributes-natural-language" value is derived from the current locale.
2651 * @since CUPS 1.2/macOS 10.5@
2654 ipp_t
* /* O - IPP request message */
2655 ippNewRequest(ipp_op_t op
) /* I - Operation code */
2657 ipp_t
*request
; /* IPP request message */
2658 cups_lang_t
*language
; /* Current language localization */
2659 static int request_id
= 0; /* Current request ID */
2660 static _cups_mutex_t request_mutex
= _CUPS_MUTEX_INITIALIZER
;
2661 /* Mutex for request ID */
2664 DEBUG_printf(("ippNewRequest(op=%02x(%s))", op
, ippOpString(op
)));
2667 * Create a new IPP message...
2670 if ((request
= ippNew()) == NULL
)
2674 * Set the operation and request ID...
2677 _cupsMutexLock(&request_mutex
);
2679 request
->request
.op
.operation_id
= op
;
2680 request
->request
.op
.request_id
= ++request_id
;
2682 _cupsMutexUnlock(&request_mutex
);
2685 * Use UTF-8 as the character set...
2688 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_CHARSET
,
2689 "attributes-charset", NULL
, "utf-8");
2692 * Get the language from the current locale...
2695 language
= cupsLangDefault();
2697 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_LANGUAGE
,
2698 "attributes-natural-language", NULL
, language
->language
);
2701 * Return the new request...
2709 * 'ippNewResponse()' - Allocate a new IPP response message.
2711 * The new response message is initialized with the same "version-number",
2712 * "request-id", "attributes-charset", and "attributes-natural-language" as the
2713 * provided request message. If the "attributes-charset" or
2714 * "attributes-natural-language" attributes are missing from the request,
2715 * 'utf-8' and a value derived from the current locale are substituted,
2718 * @since CUPS 1.7/macOS 10.9@
2721 ipp_t
* /* O - IPP response message */
2722 ippNewResponse(ipp_t
*request
) /* I - IPP request message */
2724 ipp_t
*response
; /* IPP response message */
2725 ipp_attribute_t
*attr
; /* Current attribute */
2729 * Range check input...
2736 * Create a new IPP message...
2739 if ((response
= ippNew()) == NULL
)
2743 * Copy the request values over to the response...
2746 response
->request
.status
.version
[0] = request
->request
.op
.version
[0];
2747 response
->request
.status
.version
[1] = request
->request
.op
.version
[1];
2748 response
->request
.status
.request_id
= request
->request
.op
.request_id
;
2751 * The first attribute MUST be attributes-charset...
2754 attr
= request
->attrs
;
2756 if (attr
&& attr
->name
&& !strcmp(attr
->name
, "attributes-charset") &&
2757 attr
->group_tag
== IPP_TAG_OPERATION
&&
2758 attr
->value_tag
== IPP_TAG_CHARSET
&&
2759 attr
->num_values
== 1)
2762 * Copy charset from request...
2765 ippAddString(response
, IPP_TAG_OPERATION
, IPP_TAG_CHARSET
,
2766 "attributes-charset", NULL
, attr
->values
[0].string
.text
);
2771 * Use "utf-8" as the default...
2774 ippAddString(response
, IPP_TAG_OPERATION
, IPP_TAG_CHARSET
,
2775 "attributes-charset", NULL
, "utf-8");
2779 * Then attributes-natural-language...
2785 if (attr
&& attr
->name
&&
2786 !strcmp(attr
->name
, "attributes-natural-language") &&
2787 attr
->group_tag
== IPP_TAG_OPERATION
&&
2788 attr
->value_tag
== IPP_TAG_LANGUAGE
&&
2789 attr
->num_values
== 1)
2792 * Copy language from request...
2795 ippAddString(response
, IPP_TAG_OPERATION
, IPP_TAG_LANGUAGE
,
2796 "attributes-natural-language", NULL
,
2797 attr
->values
[0].string
.text
);
2802 * Use the language from the current locale...
2805 cups_lang_t
*language
= cupsLangDefault();
2806 /* Current locale */
2808 ippAddString(response
, IPP_TAG_OPERATION
, IPP_TAG_LANGUAGE
,
2809 "attributes-natural-language", NULL
, language
->language
);
2817 * 'ippRead()' - Read data for an IPP message from a HTTP connection.
2820 ipp_state_t
/* O - Current state */
2821 ippRead(http_t
*http
, /* I - HTTP connection */
2822 ipp_t
*ipp
) /* I - IPP data */
2824 DEBUG_printf(("ippRead(http=%p, ipp=%p), data_remaining=" CUPS_LLFMT
, (void *)http
, (void *)ipp
, CUPS_LLCAST (http
? http
->data_remaining
: -1)));
2827 return (IPP_STATE_ERROR
);
2829 DEBUG_printf(("2ippRead: http->state=%d, http->used=%d", http
->state
, http
->used
));
2831 return (ippReadIO(http
, (ipp_iocb_t
)ipp_read_http
, http
->blocking
, NULL
,
2837 * 'ippReadFile()' - Read data for an IPP message from a file.
2839 * @since CUPS 1.1.19/macOS 10.3@
2842 ipp_state_t
/* O - Current state */
2843 ippReadFile(int fd
, /* I - HTTP data */
2844 ipp_t
*ipp
) /* I - IPP data */
2846 DEBUG_printf(("ippReadFile(fd=%d, ipp=%p)", fd
, (void *)ipp
));
2848 return (ippReadIO(&fd
, (ipp_iocb_t
)ipp_read_file
, 1, NULL
, ipp
));
2853 * 'ippReadIO()' - Read data for an IPP message.
2855 * @since CUPS 1.2/macOS 10.5@
2858 ipp_state_t
/* O - Current state */
2859 ippReadIO(void *src
, /* I - Data source */
2860 ipp_iocb_t cb
, /* I - Read callback function */
2861 int blocking
, /* I - Use blocking IO? */
2862 ipp_t
*parent
, /* I - Parent request, if any */
2863 ipp_t
*ipp
) /* I - IPP data */
2865 int n
; /* Length of data */
2866 unsigned char *buffer
, /* Data buffer */
2867 string
[IPP_MAX_TEXT
],
2868 /* Small string buffer */
2869 *bufptr
; /* Pointer into buffer */
2870 ipp_attribute_t
*attr
; /* Current attribute */
2871 ipp_tag_t tag
; /* Current tag */
2872 ipp_tag_t value_tag
; /* Current value tag */
2873 _ipp_value_t
*value
; /* Current value */
2876 DEBUG_printf(("ippReadIO(src=%p, cb=%p, blocking=%d, parent=%p, ipp=%p)", (void *)src
, (void *)cb
, blocking
, (void *)parent
, (void *)ipp
));
2877 DEBUG_printf(("2ippReadIO: ipp->state=%d", ipp
? ipp
->state
: IPP_STATE_ERROR
));
2880 return (IPP_STATE_ERROR
);
2882 if ((buffer
= (unsigned char *)_cupsBufferGet(IPP_BUF_SIZE
)) == NULL
)
2884 DEBUG_puts("1ippReadIO: Unable to get read buffer.");
2885 return (IPP_STATE_ERROR
);
2890 case IPP_STATE_IDLE
:
2891 ipp
->state
++; /* Avoid common problem... */
2893 case IPP_STATE_HEADER
:
2897 * Get the request header...
2900 if ((*cb
)(src
, buffer
, 8) < 8)
2902 DEBUG_puts("1ippReadIO: Unable to read header.");
2903 _cupsBufferRelease((char *)buffer
);
2904 return (IPP_STATE_ERROR
);
2908 * Then copy the request header over...
2911 ipp
->request
.any
.version
[0] = buffer
[0];
2912 ipp
->request
.any
.version
[1] = buffer
[1];
2913 ipp
->request
.any
.op_status
= (buffer
[2] << 8) | buffer
[3];
2914 ipp
->request
.any
.request_id
= (((((buffer
[4] << 8) | buffer
[5]) << 8) |
2915 buffer
[6]) << 8) | buffer
[7];
2917 DEBUG_printf(("2ippReadIO: version=%d.%d", buffer
[0], buffer
[1]));
2918 DEBUG_printf(("2ippReadIO: op_status=%04x",
2919 ipp
->request
.any
.op_status
));
2920 DEBUG_printf(("2ippReadIO: request_id=%d",
2921 ipp
->request
.any
.request_id
));
2924 ipp
->state
= IPP_STATE_ATTRIBUTE
;
2925 ipp
->current
= NULL
;
2926 ipp
->curtag
= IPP_TAG_ZERO
;
2927 ipp
->prev
= ipp
->last
;
2930 * If blocking is disabled, stop here...
2936 case IPP_STATE_ATTRIBUTE
:
2939 if ((*cb
)(src
, buffer
, 1) < 1)
2941 DEBUG_puts("1ippReadIO: Callback returned EOF/error");
2942 _cupsBufferRelease((char *)buffer
);
2943 return (IPP_STATE_ERROR
);
2946 DEBUG_printf(("2ippReadIO: ipp->current=%p, ipp->prev=%p", (void *)ipp
->current
, (void *)ipp
->prev
));
2949 * Read this attribute...
2952 tag
= (ipp_tag_t
)buffer
[0];
2953 if (tag
== IPP_TAG_EXTENSION
)
2956 * Read 32-bit "extension" tag...
2959 if ((*cb
)(src
, buffer
, 4) < 1)
2961 DEBUG_puts("1ippReadIO: Callback returned EOF/error");
2962 _cupsBufferRelease((char *)buffer
);
2963 return (IPP_STATE_ERROR
);
2966 tag
= (ipp_tag_t
)((((((buffer
[0] << 8) | buffer
[1]) << 8) |
2967 buffer
[2]) << 8) | buffer
[3]);
2969 if (tag
& IPP_TAG_CUPS_CONST
)
2972 * Fail if the high bit is set in the tag...
2975 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("IPP extension tag larger than 0x7FFFFFFF."), 1);
2976 DEBUG_printf(("1ippReadIO: bad tag 0x%x.", tag
));
2977 _cupsBufferRelease((char *)buffer
);
2978 return (IPP_STATE_ERROR
);
2982 if (tag
== IPP_TAG_END
)
2985 * No more attributes left...
2988 DEBUG_puts("2ippReadIO: IPP_TAG_END.");
2990 ipp
->state
= IPP_STATE_DATA
;
2993 else if (tag
== IPP_TAG_ZERO
|| (tag
== IPP_TAG_OPERATION
&& ipp
->curtag
!= IPP_TAG_ZERO
))
2995 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("Invalid group tag."), 1);
2996 DEBUG_printf(("1ippReadIO: bad tag 0x%02x.", tag
));
2997 _cupsBufferRelease((char *)buffer
);
2998 return (IPP_STATE_ERROR
);
3000 else if (tag
< IPP_TAG_UNSUPPORTED_VALUE
)
3003 * Group tag... Set the current group and continue...
3006 if (ipp
->curtag
== tag
)
3007 ipp
->prev
= ippAddSeparator(ipp
);
3008 else if (ipp
->current
)
3009 ipp
->prev
= ipp
->current
;
3012 ipp
->current
= NULL
;
3013 DEBUG_printf(("2ippReadIO: group tag=%x(%s), ipp->prev=%p", tag
, ippTagString(tag
), (void *)ipp
->prev
));
3017 DEBUG_printf(("2ippReadIO: value tag=%x(%s)", tag
,
3018 ippTagString(tag
)));
3024 if ((*cb
)(src
, buffer
, 2) < 2)
3026 DEBUG_puts("1ippReadIO: unable to read name length.");
3027 _cupsBufferRelease((char *)buffer
);
3028 return (IPP_STATE_ERROR
);
3031 n
= (buffer
[0] << 8) | buffer
[1];
3033 if (n
>= IPP_BUF_SIZE
)
3035 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("IPP name larger than 32767 bytes."), 1);
3036 DEBUG_printf(("1ippReadIO: bad name length %d.", n
));
3037 _cupsBufferRelease((char *)buffer
);
3038 return (IPP_STATE_ERROR
);
3041 DEBUG_printf(("2ippReadIO: name length=%d", n
));
3043 if (n
== 0 && tag
!= IPP_TAG_MEMBERNAME
&&
3044 tag
!= IPP_TAG_END_COLLECTION
)
3047 * More values for current attribute...
3050 if (ipp
->current
== NULL
)
3052 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("IPP attribute has no name."), 1);
3053 DEBUG_puts("1ippReadIO: Attribute without name and no current.");
3054 _cupsBufferRelease((char *)buffer
);
3055 return (IPP_STATE_ERROR
);
3058 attr
= ipp
->current
;
3059 value_tag
= (ipp_tag_t
)(attr
->value_tag
& IPP_TAG_CUPS_MASK
);
3062 * Make sure we aren't adding a new value of a different
3066 if (value_tag
== IPP_TAG_ZERO
)
3069 * Setting the value of a collection member...
3072 attr
->value_tag
= tag
;
3074 else if (value_tag
== IPP_TAG_TEXTLANG
||
3075 value_tag
== IPP_TAG_NAMELANG
||
3076 (value_tag
>= IPP_TAG_TEXT
&&
3077 value_tag
<= IPP_TAG_MIMETYPE
))
3080 * String values can sometimes come across in different
3081 * forms; accept sets of differing values...
3084 if (tag
!= IPP_TAG_TEXTLANG
&& tag
!= IPP_TAG_NAMELANG
&&
3085 (tag
< IPP_TAG_TEXT
|| tag
> IPP_TAG_MIMETYPE
) &&
3086 tag
!= IPP_TAG_NOVALUE
)
3088 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3089 _("IPP 1setOf attribute with incompatible value "
3091 DEBUG_printf(("1ippReadIO: 1setOf value tag %x(%s) != %x(%s)",
3092 value_tag
, ippTagString(value_tag
), tag
,
3093 ippTagString(tag
)));
3094 _cupsBufferRelease((char *)buffer
);
3095 return (IPP_STATE_ERROR
);
3098 if (value_tag
!= tag
)
3100 DEBUG_printf(("1ippReadIO: Converting %s attribute from %s to %s.",
3101 attr
->name
, ippTagString(value_tag
), ippTagString(tag
)));
3102 ippSetValueTag(ipp
, &attr
, tag
);
3105 else if (value_tag
== IPP_TAG_INTEGER
||
3106 value_tag
== IPP_TAG_RANGE
)
3109 * Integer and rangeOfInteger values can sometimes be mixed; accept
3110 * sets of differing values...
3113 if (tag
!= IPP_TAG_INTEGER
&& tag
!= IPP_TAG_RANGE
)
3115 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3116 _("IPP 1setOf attribute with incompatible value "
3118 DEBUG_printf(("1ippReadIO: 1setOf value tag %x(%s) != %x(%s)",
3119 value_tag
, ippTagString(value_tag
), tag
,
3120 ippTagString(tag
)));
3121 _cupsBufferRelease((char *)buffer
);
3122 return (IPP_STATE_ERROR
);
3125 if (value_tag
== IPP_TAG_INTEGER
&& tag
== IPP_TAG_RANGE
)
3128 * Convert integer values to rangeOfInteger values...
3131 DEBUG_printf(("1ippReadIO: Converting %s attribute to "
3132 "rangeOfInteger.", attr
->name
));
3133 ippSetValueTag(ipp
, &attr
, IPP_TAG_RANGE
);
3136 else if (value_tag
!= tag
)
3138 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3139 _("IPP 1setOf attribute with incompatible value "
3141 DEBUG_printf(("1ippReadIO: value tag %x(%s) != %x(%s)",
3142 value_tag
, ippTagString(value_tag
), tag
,
3143 ippTagString(tag
)));
3144 _cupsBufferRelease((char *)buffer
);
3145 return (IPP_STATE_ERROR
);
3149 * Finally, reallocate the attribute array as needed...
3152 if ((value
= ipp_set_value(ipp
, &attr
, attr
->num_values
)) == NULL
)
3154 _cupsBufferRelease((char *)buffer
);
3155 return (IPP_STATE_ERROR
);
3158 else if (tag
== IPP_TAG_MEMBERNAME
)
3161 * Name must be length 0!
3166 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("IPP member name is not empty."), 1);
3167 DEBUG_puts("1ippReadIO: member name not empty.");
3168 _cupsBufferRelease((char *)buffer
);
3169 return (IPP_STATE_ERROR
);
3173 ipp
->prev
= ipp
->current
;
3175 attr
= ipp
->current
= ipp_add_attr(ipp
, NULL
, ipp
->curtag
, IPP_TAG_ZERO
, 1);
3178 _cupsSetHTTPError(HTTP_STATUS_ERROR
);
3179 DEBUG_puts("1ippReadIO: unable to allocate attribute.");
3180 _cupsBufferRelease((char *)buffer
);
3181 return (IPP_STATE_ERROR
);
3184 DEBUG_printf(("2ippReadIO: membername, ipp->current=%p, ipp->prev=%p", (void *)ipp
->current
, (void *)ipp
->prev
));
3186 value
= attr
->values
;
3188 else if (tag
!= IPP_TAG_END_COLLECTION
)
3191 * New attribute; read the name and add it...
3194 if ((*cb
)(src
, buffer
, (size_t)n
) < n
)
3196 DEBUG_puts("1ippReadIO: unable to read name.");
3197 _cupsBufferRelease((char *)buffer
);
3198 return (IPP_STATE_ERROR
);
3204 ipp
->prev
= ipp
->current
;
3206 if ((attr
= ipp
->current
= ipp_add_attr(ipp
, (char *)buffer
, ipp
->curtag
, tag
,
3209 _cupsSetHTTPError(HTTP_STATUS_ERROR
);
3210 DEBUG_puts("1ippReadIO: unable to allocate attribute.");
3211 _cupsBufferRelease((char *)buffer
);
3212 return (IPP_STATE_ERROR
);
3215 DEBUG_printf(("2ippReadIO: name=\"%s\", ipp->current=%p, ipp->prev=%p", buffer
, (void *)ipp
->current
, (void *)ipp
->prev
));
3217 value
= attr
->values
;
3225 if ((*cb
)(src
, buffer
, 2) < 2)
3227 DEBUG_puts("1ippReadIO: unable to read value length.");
3228 _cupsBufferRelease((char *)buffer
);
3229 return (IPP_STATE_ERROR
);
3232 n
= (buffer
[0] << 8) | buffer
[1];
3233 DEBUG_printf(("2ippReadIO: value length=%d", n
));
3235 if (n
>= IPP_BUF_SIZE
)
3237 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3238 _("IPP value larger than 32767 bytes."), 1);
3239 DEBUG_printf(("1ippReadIO: bad value length %d.", n
));
3240 _cupsBufferRelease((char *)buffer
);
3241 return (IPP_STATE_ERROR
);
3246 case IPP_TAG_INTEGER
:
3250 if (tag
== IPP_TAG_INTEGER
)
3251 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3252 _("IPP integer value not 4 bytes."), 1);
3254 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3255 _("IPP enum value not 4 bytes."), 1);
3256 DEBUG_printf(("1ippReadIO: bad integer value length %d.", n
));
3257 _cupsBufferRelease((char *)buffer
);
3258 return (IPP_STATE_ERROR
);
3261 if ((*cb
)(src
, buffer
, 4) < 4)
3263 DEBUG_puts("1ippReadIO: Unable to read integer value.");
3264 _cupsBufferRelease((char *)buffer
);
3265 return (IPP_STATE_ERROR
);
3268 n
= (((((buffer
[0] << 8) | buffer
[1]) << 8) | buffer
[2]) << 8) |
3271 if (attr
->value_tag
== IPP_TAG_RANGE
)
3272 value
->range
.lower
= value
->range
.upper
= n
;
3277 case IPP_TAG_BOOLEAN
:
3280 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("IPP boolean value not 1 byte."),
3282 DEBUG_printf(("1ippReadIO: bad boolean value length %d.", n
));
3283 _cupsBufferRelease((char *)buffer
);
3284 return (IPP_STATE_ERROR
);
3287 if ((*cb
)(src
, buffer
, 1) < 1)
3289 DEBUG_puts("1ippReadIO: Unable to read boolean value.");
3290 _cupsBufferRelease((char *)buffer
);
3291 return (IPP_STATE_ERROR
);
3294 value
->boolean
= (char)buffer
[0];
3297 case IPP_TAG_UNSUPPORTED_VALUE
:
3298 case IPP_TAG_DEFAULT
:
3299 case IPP_TAG_UNKNOWN
:
3300 case IPP_TAG_NOVALUE
:
3301 case IPP_TAG_NOTSETTABLE
:
3302 case IPP_TAG_DELETEATTR
:
3303 case IPP_TAG_ADMINDEFINE
:
3305 * These value types are not supposed to have values, however
3306 * some vendors (Brother) do not implement IPP correctly and so
3307 * we need to map non-empty values to text...
3310 if (attr
->value_tag
== tag
)
3315 attr
->value_tag
= IPP_TAG_TEXT
;
3320 case IPP_TAG_RESERVED_STRING
:
3321 case IPP_TAG_KEYWORD
:
3323 case IPP_TAG_URISCHEME
:
3324 case IPP_TAG_CHARSET
:
3325 case IPP_TAG_LANGUAGE
:
3326 case IPP_TAG_MIMETYPE
:
3329 if ((*cb
)(src
, buffer
, (size_t)n
) < n
)
3331 DEBUG_puts("1ippReadIO: unable to read string value.");
3332 _cupsBufferRelease((char *)buffer
);
3333 return (IPP_STATE_ERROR
);
3338 value
->string
.text
= _cupsStrAlloc((char *)buffer
);
3339 DEBUG_printf(("2ippReadIO: value=\"%s\"", value
->string
.text
));
3345 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("IPP date value not 11 bytes."), 1);
3346 DEBUG_printf(("1ippReadIO: bad date value length %d.", n
));
3347 _cupsBufferRelease((char *)buffer
);
3348 return (IPP_STATE_ERROR
);
3351 if ((*cb
)(src
, value
->date
, 11) < 11)
3353 DEBUG_puts("1ippReadIO: Unable to read date value.");
3354 _cupsBufferRelease((char *)buffer
);
3355 return (IPP_STATE_ERROR
);
3359 case IPP_TAG_RESOLUTION
:
3362 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3363 _("IPP resolution value not 9 bytes."), 1);
3364 DEBUG_printf(("1ippReadIO: bad resolution value length %d.", n
));
3365 _cupsBufferRelease((char *)buffer
);
3366 return (IPP_STATE_ERROR
);
3369 if ((*cb
)(src
, buffer
, 9) < 9)
3371 DEBUG_puts("1ippReadIO: Unable to read resolution value.");
3372 _cupsBufferRelease((char *)buffer
);
3373 return (IPP_STATE_ERROR
);
3376 value
->resolution
.xres
=
3377 (((((buffer
[0] << 8) | buffer
[1]) << 8) | buffer
[2]) << 8) |
3379 value
->resolution
.yres
=
3380 (((((buffer
[4] << 8) | buffer
[5]) << 8) | buffer
[6]) << 8) |
3382 value
->resolution
.units
=
3383 (ipp_res_t
)buffer
[8];
3386 case IPP_TAG_RANGE
:
3389 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3390 _("IPP rangeOfInteger value not 8 bytes."), 1);
3391 DEBUG_printf(("1ippReadIO: bad rangeOfInteger value length "
3393 _cupsBufferRelease((char *)buffer
);
3394 return (IPP_STATE_ERROR
);
3397 if ((*cb
)(src
, buffer
, 8) < 8)
3399 DEBUG_puts("1ippReadIO: Unable to read range value.");
3400 _cupsBufferRelease((char *)buffer
);
3401 return (IPP_STATE_ERROR
);
3404 value
->range
.lower
=
3405 (((((buffer
[0] << 8) | buffer
[1]) << 8) | buffer
[2]) << 8) |
3407 value
->range
.upper
=
3408 (((((buffer
[4] << 8) | buffer
[5]) << 8) | buffer
[6]) << 8) |
3412 case IPP_TAG_TEXTLANG
:
3413 case IPP_TAG_NAMELANG
:
3416 if (tag
== IPP_TAG_TEXTLANG
)
3417 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3418 _("IPP textWithLanguage value less than "
3419 "minimum 4 bytes."), 1);
3421 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3422 _("IPP nameWithLanguage value less than "
3423 "minimum 4 bytes."), 1);
3424 DEBUG_printf(("1ippReadIO: bad stringWithLanguage value "
3426 _cupsBufferRelease((char *)buffer
);
3427 return (IPP_STATE_ERROR
);
3430 if ((*cb
)(src
, buffer
, (size_t)n
) < n
)
3432 DEBUG_puts("1ippReadIO: Unable to read string w/language "
3434 _cupsBufferRelease((char *)buffer
);
3435 return (IPP_STATE_ERROR
);
3441 * text-with-language and name-with-language are composite
3450 n
= (bufptr
[0] << 8) | bufptr
[1];
3452 if ((bufptr
+ 2 + n
) >= (buffer
+ IPP_BUF_SIZE
) || n
>= (int)sizeof(string
))
3454 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3455 _("IPP language length overflows value."), 1);
3456 DEBUG_printf(("1ippReadIO: bad language value length %d.",
3458 _cupsBufferRelease((char *)buffer
);
3459 return (IPP_STATE_ERROR
);
3461 else if (n
>= IPP_MAX_LANGUAGE
)
3463 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3464 _("IPP language length too large."), 1);
3465 DEBUG_printf(("1ippReadIO: bad language value length %d.",
3467 _cupsBufferRelease((char *)buffer
);
3468 return (IPP_STATE_ERROR
);
3471 memcpy(string
, bufptr
+ 2, (size_t)n
);
3474 value
->string
.language
= _cupsStrAlloc((char *)string
);
3477 n
= (bufptr
[0] << 8) | bufptr
[1];
3479 if ((bufptr
+ 2 + n
) >= (buffer
+ IPP_BUF_SIZE
))
3481 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3482 _("IPP string length overflows value."), 1);
3483 DEBUG_printf(("1ippReadIO: bad string value length %d.", n
));
3484 _cupsBufferRelease((char *)buffer
);
3485 return (IPP_STATE_ERROR
);
3488 bufptr
[2 + n
] = '\0';
3489 value
->string
.text
= _cupsStrAlloc((char *)bufptr
+ 2);
3492 case IPP_TAG_BEGIN_COLLECTION
:
3494 * Oh, boy, here comes a collection value, so read it...
3497 value
->collection
= ippNew();
3501 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3502 _("IPP begCollection value not 0 bytes."), 1);
3503 DEBUG_puts("1ippReadIO: begCollection tag with value length "
3505 _cupsBufferRelease((char *)buffer
);
3506 return (IPP_STATE_ERROR
);
3509 if (ippReadIO(src
, cb
, 1, ipp
, value
->collection
) == IPP_STATE_ERROR
)
3511 DEBUG_puts("1ippReadIO: Unable to read collection value.");
3512 _cupsBufferRelease((char *)buffer
);
3513 return (IPP_STATE_ERROR
);
3517 case IPP_TAG_END_COLLECTION
:
3518 _cupsBufferRelease((char *)buffer
);
3522 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3523 _("IPP endCollection value not 0 bytes."), 1);
3524 DEBUG_puts("1ippReadIO: endCollection tag with value length "
3526 return (IPP_STATE_ERROR
);
3529 DEBUG_puts("1ippReadIO: endCollection tag...");
3530 return (ipp
->state
= IPP_STATE_DATA
);
3532 case IPP_TAG_MEMBERNAME
:
3534 * The value the name of the member in the collection, which
3535 * we need to carry over...
3540 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3541 _("IPP memberName with no attribute."), 1);
3542 DEBUG_puts("1ippReadIO: Member name without attribute.");
3543 _cupsBufferRelease((char *)buffer
);
3544 return (IPP_STATE_ERROR
);
3548 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3549 _("IPP memberName value is empty."), 1);
3550 DEBUG_puts("1ippReadIO: Empty member name value.");
3551 _cupsBufferRelease((char *)buffer
);
3552 return (IPP_STATE_ERROR
);
3554 else if ((*cb
)(src
, buffer
, (size_t)n
) < n
)
3556 DEBUG_puts("1ippReadIO: Unable to read member name value.");
3557 _cupsBufferRelease((char *)buffer
);
3558 return (IPP_STATE_ERROR
);
3562 attr
->name
= _cupsStrAlloc((char *)buffer
);
3565 * Since collection members are encoded differently than
3566 * regular attributes, make sure we don't start with an
3570 attr
->num_values
--;
3572 DEBUG_printf(("2ippReadIO: member name=\"%s\"", attr
->name
));
3575 case IPP_TAG_STRING
:
3576 default : /* Other unsupported values */
3577 if (tag
== IPP_TAG_STRING
&& n
> IPP_MAX_LENGTH
)
3579 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3580 _("IPP octetString length too large."), 1);
3581 DEBUG_printf(("1ippReadIO: bad octetString value length %d.",
3583 _cupsBufferRelease((char *)buffer
);
3584 return (IPP_STATE_ERROR
);
3587 value
->unknown
.length
= n
;
3591 if ((value
->unknown
.data
= malloc((size_t)n
)) == NULL
)
3593 _cupsSetHTTPError(HTTP_STATUS_ERROR
);
3594 DEBUG_puts("1ippReadIO: Unable to allocate value");
3595 _cupsBufferRelease((char *)buffer
);
3596 return (IPP_STATE_ERROR
);
3599 if ((*cb
)(src
, value
->unknown
.data
, (size_t)n
) < n
)
3601 DEBUG_puts("1ippReadIO: Unable to read unsupported value.");
3602 _cupsBufferRelease((char *)buffer
);
3603 return (IPP_STATE_ERROR
);
3607 value
->unknown
.data
= NULL
;
3612 * If blocking is disabled, stop here...
3620 case IPP_STATE_DATA
:
3624 break; /* anti-compiler-warning-code */
3627 DEBUG_printf(("1ippReadIO: returning ipp->state=%d.", ipp
->state
));
3628 _cupsBufferRelease((char *)buffer
);
3630 return (ipp
->state
);
3635 * 'ippSetBoolean()' - Set a boolean value in an attribute.
3637 * The @code ipp@ parameter refers to an IPP message previously created using
3638 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
3640 * The @code attr@ parameter may be modified as a result of setting the value.
3642 * The @code element@ parameter specifies which value to set from 0 to
3643 * @code ippGetCount(attr)@.
3645 * @since CUPS 1.6/macOS 10.8@
3648 int /* O - 1 on success, 0 on failure */
3649 ippSetBoolean(ipp_t
*ipp
, /* I - IPP message */
3650 ipp_attribute_t
**attr
, /* IO - IPP attribute */
3651 int element
, /* I - Value number (0-based) */
3652 int boolvalue
)/* I - Boolean value */
3654 _ipp_value_t
*value
; /* Current value */
3658 * Range check input...
3661 if (!ipp
|| !attr
|| !*attr
|| (*attr
)->value_tag
!= IPP_TAG_BOOLEAN
||
3662 element
< 0 || element
> (*attr
)->num_values
)
3666 * Set the value and return...
3669 if ((value
= ipp_set_value(ipp
, attr
, element
)) != NULL
)
3670 value
->boolean
= (char)boolvalue
;
3672 return (value
!= NULL
);
3677 * 'ippSetCollection()' - Set a collection value in an attribute.
3679 * The @code ipp@ parameter refers to an IPP message previously created using
3680 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
3682 * The @code attr@ parameter may be modified as a result of setting the value.
3684 * The @code element@ parameter specifies which value to set from 0 to
3685 * @code ippGetCount(attr)@.
3687 * @since CUPS 1.6/macOS 10.8@
3690 int /* O - 1 on success, 0 on failure */
3692 ipp_t
*ipp
, /* I - IPP message */
3693 ipp_attribute_t
**attr
, /* IO - IPP attribute */
3694 int element
, /* I - Value number (0-based) */
3695 ipp_t
*colvalue
) /* I - Collection value */
3697 _ipp_value_t
*value
; /* Current value */
3701 * Range check input...
3704 if (!ipp
|| !attr
|| !*attr
|| (*attr
)->value_tag
!= IPP_TAG_BEGIN_COLLECTION
||
3705 element
< 0 || element
> (*attr
)->num_values
|| !colvalue
)
3709 * Set the value and return...
3712 if ((value
= ipp_set_value(ipp
, attr
, element
)) != NULL
)
3714 if (value
->collection
)
3715 ippDelete(value
->collection
);
3717 value
->collection
= colvalue
;
3721 return (value
!= NULL
);
3726 * 'ippSetDate()' - Set a dateTime value in an attribute.
3728 * The @code ipp@ parameter refers to an IPP message previously created using
3729 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
3731 * The @code attr@ parameter may be modified as a result of setting the value.
3733 * The @code element@ parameter specifies which value to set from 0 to
3734 * @code ippGetCount(attr)@.
3736 * @since CUPS 1.6/macOS 10.8@
3739 int /* O - 1 on success, 0 on failure */
3740 ippSetDate(ipp_t
*ipp
, /* I - IPP message */
3741 ipp_attribute_t
**attr
, /* IO - IPP attribute */
3742 int element
, /* I - Value number (0-based) */
3743 const ipp_uchar_t
*datevalue
)/* I - dateTime value */
3745 _ipp_value_t
*value
; /* Current value */
3749 * Range check input...
3752 if (!ipp
|| !attr
|| !*attr
|| (*attr
)->value_tag
!= IPP_TAG_DATE
||
3753 element
< 0 || element
> (*attr
)->num_values
|| !datevalue
)
3757 * Set the value and return...
3760 if ((value
= ipp_set_value(ipp
, attr
, element
)) != NULL
)
3761 memcpy(value
->date
, datevalue
, sizeof(value
->date
));
3763 return (value
!= NULL
);
3768 * 'ippSetGroupTag()' - Set the group tag of an attribute.
3770 * The @code ipp@ parameter refers to an IPP message previously created using
3771 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
3773 * The @code attr@ parameter may be modified as a result of setting the value.
3775 * The @code group@ parameter specifies the IPP attribute group tag: none
3776 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
3777 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
3778 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
3779 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
3781 * @since CUPS 1.6/macOS 10.8@
3784 int /* O - 1 on success, 0 on failure */
3786 ipp_t
*ipp
, /* I - IPP message */
3787 ipp_attribute_t
**attr
, /* IO - Attribute */
3788 ipp_tag_t group_tag
) /* I - Group tag */
3791 * Range check input - group tag must be 0x01 to 0x0F, per RFC 8011...
3794 if (!ipp
|| !attr
|| !*attr
||
3795 group_tag
< IPP_TAG_ZERO
|| group_tag
== IPP_TAG_END
||
3796 group_tag
>= IPP_TAG_UNSUPPORTED_VALUE
)
3800 * Set the group tag and return...
3803 (*attr
)->group_tag
= group_tag
;
3810 * 'ippSetInteger()' - Set an integer or enum value in an attribute.
3812 * The @code ipp@ parameter refers to an IPP message previously created using
3813 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
3815 * The @code attr@ parameter may be modified as a result of setting the value.
3817 * The @code element@ parameter specifies which value to set from 0 to
3818 * @code ippGetCount(attr)@.
3820 * @since CUPS 1.6/macOS 10.8@
3823 int /* O - 1 on success, 0 on failure */
3824 ippSetInteger(ipp_t
*ipp
, /* I - IPP message */
3825 ipp_attribute_t
**attr
, /* IO - IPP attribute */
3826 int element
, /* I - Value number (0-based) */
3827 int intvalue
) /* I - Integer/enum value */
3829 _ipp_value_t
*value
; /* Current value */
3833 * Range check input...
3836 if (!ipp
|| !attr
|| !*attr
||
3837 ((*attr
)->value_tag
!= IPP_TAG_INTEGER
&& (*attr
)->value_tag
!= IPP_TAG_ENUM
) ||
3838 element
< 0 || element
> (*attr
)->num_values
)
3842 * Set the value and return...
3845 if ((value
= ipp_set_value(ipp
, attr
, element
)) != NULL
)
3846 value
->integer
= intvalue
;
3848 return (value
!= NULL
);
3853 * 'ippSetName()' - Set the name of an attribute.
3855 * The @code ipp@ parameter refers to an IPP message previously created using
3856 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
3858 * The @code attr@ parameter may be modified as a result of setting the value.
3860 * @since CUPS 1.6/macOS 10.8@
3863 int /* O - 1 on success, 0 on failure */
3864 ippSetName(ipp_t
*ipp
, /* I - IPP message */
3865 ipp_attribute_t
**attr
, /* IO - IPP attribute */
3866 const char *name
) /* I - Attribute name */
3868 char *temp
; /* Temporary name value */
3872 * Range check input...
3875 if (!ipp
|| !attr
|| !*attr
)
3879 * Set the value and return...
3882 if ((temp
= _cupsStrAlloc(name
)) != NULL
)
3885 _cupsStrFree((*attr
)->name
);
3887 (*attr
)->name
= temp
;
3890 return (temp
!= NULL
);
3895 * 'ippSetOctetString()' - Set an octetString value in an IPP attribute.
3897 * The @code ipp@ parameter refers to an IPP message previously created using
3898 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
3900 * The @code attr@ parameter may be modified as a result of setting the value.
3902 * The @code element@ parameter specifies which value to set from 0 to
3903 * @code ippGetCount(attr)@.
3905 * @since CUPS 1.7/macOS 10.9@
3908 int /* O - 1 on success, 0 on failure */
3910 ipp_t
*ipp
, /* I - IPP message */
3911 ipp_attribute_t
**attr
, /* IO - IPP attribute */
3912 int element
, /* I - Value number (0-based) */
3913 const void *data
, /* I - Pointer to octetString data */
3914 int datalen
) /* I - Length of octetString data */
3916 _ipp_value_t
*value
; /* Current value */
3920 * Range check input...
3923 if (!ipp
|| !attr
|| !*attr
|| (*attr
)->value_tag
!= IPP_TAG_STRING
||
3924 element
< 0 || element
> (*attr
)->num_values
||
3925 datalen
< 0 || datalen
> IPP_MAX_LENGTH
)
3929 * Set the value and return...
3932 if ((value
= ipp_set_value(ipp
, attr
, element
)) != NULL
)
3934 if ((int)((*attr
)->value_tag
) & IPP_TAG_CUPS_CONST
)
3937 * Just copy the pointer...
3940 value
->unknown
.data
= (void *)data
;
3941 value
->unknown
.length
= datalen
;
3949 if (value
->unknown
.data
)
3952 * Free previous data...
3955 free(value
->unknown
.data
);
3957 value
->unknown
.data
= NULL
;
3958 value
->unknown
.length
= 0;
3963 void *temp
; /* Temporary data pointer */
3965 if ((temp
= malloc((size_t)datalen
)) != NULL
)
3967 memcpy(temp
, data
, (size_t)datalen
);
3969 value
->unknown
.data
= temp
;
3970 value
->unknown
.length
= datalen
;
3978 return (value
!= NULL
);
3983 * 'ippSetOperation()' - Set the operation ID in an IPP request message.
3985 * The @code ipp@ parameter refers to an IPP message previously created using
3986 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
3988 * @since CUPS 1.6/macOS 10.8@
3991 int /* O - 1 on success, 0 on failure */
3992 ippSetOperation(ipp_t
*ipp
, /* I - IPP request message */
3993 ipp_op_t op
) /* I - Operation ID */
3996 * Range check input...
4003 * Set the operation and return...
4006 ipp
->request
.op
.operation_id
= op
;
4013 * 'ippSetRange()' - Set a rangeOfInteger value in an attribute.
4015 * The @code ipp@ parameter refers to an IPP message previously created using
4016 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
4018 * The @code attr@ parameter may be modified as a result of setting the value.
4020 * The @code element@ parameter specifies which value to set from 0 to
4021 * @code ippGetCount(attr)@.
4023 * @since CUPS 1.6/macOS 10.8@
4026 int /* O - 1 on success, 0 on failure */
4027 ippSetRange(ipp_t
*ipp
, /* I - IPP message */
4028 ipp_attribute_t
**attr
, /* IO - IPP attribute */
4029 int element
, /* I - Value number (0-based) */
4030 int lowervalue
, /* I - Lower bound for range */
4031 int uppervalue
) /* I - Upper bound for range */
4033 _ipp_value_t
*value
; /* Current value */
4037 * Range check input...
4040 if (!ipp
|| !attr
|| !*attr
|| (*attr
)->value_tag
!= IPP_TAG_RANGE
||
4041 element
< 0 || element
> (*attr
)->num_values
|| lowervalue
> uppervalue
)
4045 * Set the value and return...
4048 if ((value
= ipp_set_value(ipp
, attr
, element
)) != NULL
)
4050 value
->range
.lower
= lowervalue
;
4051 value
->range
.upper
= uppervalue
;
4054 return (value
!= NULL
);
4059 * 'ippSetRequestId()' - Set the request ID in an IPP message.
4061 * The @code ipp@ parameter refers to an IPP message previously created using
4062 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
4064 * The @code request_id@ parameter must be greater than 0.
4066 * @since CUPS 1.6/macOS 10.8@
4069 int /* O - 1 on success, 0 on failure */
4070 ippSetRequestId(ipp_t
*ipp
, /* I - IPP message */
4071 int request_id
) /* I - Request ID */
4074 * Range check input; not checking request_id values since ipptool wants to send
4075 * invalid values for conformance testing and a bad request_id does not affect the
4076 * encoding of a message...
4083 * Set the request ID and return...
4086 ipp
->request
.any
.request_id
= request_id
;
4093 * 'ippSetResolution()' - Set a resolution value in an attribute.
4095 * The @code ipp@ parameter refers to an IPP message previously created using
4096 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
4098 * The @code attr@ parameter may be modified as a result of setting the value.
4100 * The @code element@ parameter specifies which value to set from 0 to
4101 * @code ippGetCount(attr)@.
4103 * @since CUPS 1.6/macOS 10.8@
4106 int /* O - 1 on success, 0 on failure */
4108 ipp_t
*ipp
, /* I - IPP message */
4109 ipp_attribute_t
**attr
, /* IO - IPP attribute */
4110 int element
, /* I - Value number (0-based) */
4111 ipp_res_t unitsvalue
, /* I - Resolution units */
4112 int xresvalue
, /* I - Horizontal/cross feed resolution */
4113 int yresvalue
) /* I - Vertical/feed resolution */
4115 _ipp_value_t
*value
; /* Current value */
4119 * Range check input...
4122 if (!ipp
|| !attr
|| !*attr
|| (*attr
)->value_tag
!= IPP_TAG_RESOLUTION
||
4123 element
< 0 || element
> (*attr
)->num_values
|| xresvalue
<= 0 || yresvalue
<= 0 ||
4124 unitsvalue
< IPP_RES_PER_INCH
|| unitsvalue
> IPP_RES_PER_CM
)
4128 * Set the value and return...
4131 if ((value
= ipp_set_value(ipp
, attr
, element
)) != NULL
)
4133 value
->resolution
.units
= unitsvalue
;
4134 value
->resolution
.xres
= xresvalue
;
4135 value
->resolution
.yres
= yresvalue
;
4138 return (value
!= NULL
);
4143 * 'ippSetState()' - Set the current state of the IPP message.
4145 * @since CUPS 1.6/macOS 10.8@
4148 int /* O - 1 on success, 0 on failure */
4149 ippSetState(ipp_t
*ipp
, /* I - IPP message */
4150 ipp_state_t state
) /* I - IPP state value */
4153 * Range check input...
4160 * Set the state and return...
4164 ipp
->current
= NULL
;
4171 * 'ippSetStatusCode()' - Set the status code in an IPP response or event message.
4173 * The @code ipp@ parameter refers to an IPP message previously created using
4174 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
4176 * @since CUPS 1.6/macOS 10.8@
4179 int /* O - 1 on success, 0 on failure */
4180 ippSetStatusCode(ipp_t
*ipp
, /* I - IPP response or event message */
4181 ipp_status_t status
) /* I - Status code */
4184 * Range check input...
4191 * Set the status code and return...
4194 ipp
->request
.status
.status_code
= status
;
4201 * 'ippSetString()' - Set a string value in an attribute.
4203 * The @code ipp@ parameter refers to an IPP message previously created using
4204 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
4206 * The @code attr@ parameter may be modified as a result of setting the value.
4208 * The @code element@ parameter specifies which value to set from 0 to
4209 * @code ippGetCount(attr)@.
4211 * @since CUPS 1.6/macOS 10.8@
4214 int /* O - 1 on success, 0 on failure */
4215 ippSetString(ipp_t
*ipp
, /* I - IPP message */
4216 ipp_attribute_t
**attr
, /* IO - IPP attribute */
4217 int element
, /* I - Value number (0-based) */
4218 const char *strvalue
) /* I - String value */
4220 char *temp
; /* Temporary string */
4221 _ipp_value_t
*value
; /* Current value */
4222 ipp_tag_t value_tag
; /* Value tag */
4226 * Range check input...
4230 value_tag
= (*attr
)->value_tag
& IPP_TAG_CUPS_MASK
;
4232 value_tag
= IPP_TAG_ZERO
;
4234 if (!ipp
|| !attr
|| !*attr
||
4235 (value_tag
< IPP_TAG_TEXT
&& value_tag
!= IPP_TAG_TEXTLANG
&&
4236 value_tag
!= IPP_TAG_NAMELANG
) || value_tag
> IPP_TAG_MIMETYPE
||
4237 element
< 0 || element
> (*attr
)->num_values
|| !strvalue
)
4241 * Set the value and return...
4244 if ((value
= ipp_set_value(ipp
, attr
, element
)) != NULL
)
4247 value
->string
.language
= (*attr
)->values
[0].string
.language
;
4249 if ((int)((*attr
)->value_tag
) & IPP_TAG_CUPS_CONST
)
4250 value
->string
.text
= (char *)strvalue
;
4251 else if ((temp
= _cupsStrAlloc(strvalue
)) != NULL
)
4253 if (value
->string
.text
)
4254 _cupsStrFree(value
->string
.text
);
4256 value
->string
.text
= temp
;
4262 return (value
!= NULL
);
4267 * 'ippSetStringf()' - Set a formatted string value of an attribute.
4269 * The @code ipp@ parameter refers to an IPP message previously created using
4270 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
4272 * The @code attr@ parameter may be modified as a result of setting the value.
4274 * The @code element@ parameter specifies which value to set from 0 to
4275 * @code ippGetCount(attr)@.
4277 * The @code format@ parameter uses formatting characters compatible with the
4278 * printf family of standard functions. Additional arguments follow it as
4279 * needed. The formatted string is truncated as needed to the maximum length of
4280 * the corresponding value type.
4282 * @since CUPS 1.7/macOS 10.9@
4285 int /* O - 1 on success, 0 on failure */
4286 ippSetStringf(ipp_t
*ipp
, /* I - IPP message */
4287 ipp_attribute_t
**attr
, /* IO - IPP attribute */
4288 int element
, /* I - Value number (0-based) */
4289 const char *format
, /* I - Printf-style format string */
4290 ...) /* I - Additional arguments as needed */
4292 int ret
; /* Return value */
4293 va_list ap
; /* Pointer to additional arguments */
4296 va_start(ap
, format
);
4297 ret
= ippSetStringfv(ipp
, attr
, element
, format
, ap
);
4305 * 'ippSetStringf()' - Set a formatted string value of an attribute.
4307 * The @code ipp@ parameter refers to an IPP message previously created using
4308 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
4310 * The @code attr@ parameter may be modified as a result of setting the value.
4312 * The @code element@ parameter specifies which value to set from 0 to
4313 * @code ippGetCount(attr)@.
4315 * The @code format@ parameter uses formatting characters compatible with the
4316 * printf family of standard functions. Additional arguments follow it as
4317 * needed. The formatted string is truncated as needed to the maximum length of
4318 * the corresponding value type.
4320 * @since CUPS 1.7/macOS 10.9@
4323 int /* O - 1 on success, 0 on failure */
4324 ippSetStringfv(ipp_t
*ipp
, /* I - IPP message */
4325 ipp_attribute_t
**attr
, /* IO - IPP attribute */
4326 int element
, /* I - Value number (0-based) */
4327 const char *format
, /* I - Printf-style format string */
4328 va_list ap
) /* I - Pointer to additional arguments */
4330 ipp_tag_t value_tag
; /* Value tag */
4331 char buffer
[IPP_MAX_TEXT
+ 4];
4332 /* Formatted text string */
4333 ssize_t bytes
, /* Length of formatted value */
4334 max_bytes
; /* Maximum number of bytes for value */
4338 * Range check input...
4342 value_tag
= (*attr
)->value_tag
& IPP_TAG_CUPS_MASK
;
4344 value_tag
= IPP_TAG_ZERO
;
4346 if (!ipp
|| !attr
|| !*attr
||
4347 (value_tag
< IPP_TAG_TEXT
&& value_tag
!= IPP_TAG_TEXTLANG
&&
4348 value_tag
!= IPP_TAG_NAMELANG
) || value_tag
> IPP_TAG_MIMETYPE
||
4353 * Format the string...
4356 if (!strcmp(format
, "%s"))
4359 * Optimize the simple case...
4362 const char *s
= va_arg(ap
, char *);
4367 bytes
= (ssize_t
)strlen(s
);
4368 strlcpy(buffer
, s
, sizeof(buffer
));
4373 * Do a full formatting of the message...
4376 if ((bytes
= vsnprintf(buffer
, sizeof(buffer
), format
, ap
)) < 0)
4381 * Limit the length of the string...
4388 case IPP_TAG_TEXTLANG
:
4389 max_bytes
= IPP_MAX_TEXT
;
4393 case IPP_TAG_NAMELANG
:
4394 max_bytes
= IPP_MAX_NAME
;
4397 case IPP_TAG_CHARSET
:
4398 max_bytes
= IPP_MAX_CHARSET
;
4401 case IPP_TAG_KEYWORD
:
4402 max_bytes
= IPP_MAX_KEYWORD
;
4405 case IPP_TAG_LANGUAGE
:
4406 max_bytes
= IPP_MAX_LANGUAGE
;
4409 case IPP_TAG_MIMETYPE
:
4410 max_bytes
= IPP_MAX_MIMETYPE
;
4414 max_bytes
= IPP_MAX_URI
;
4417 case IPP_TAG_URISCHEME
:
4418 max_bytes
= IPP_MAX_URISCHEME
;
4422 if (bytes
>= max_bytes
)
4424 char *bufmax
, /* Buffer at max_bytes */
4425 *bufptr
; /* Pointer into buffer */
4427 bufptr
= buffer
+ strlen(buffer
) - 1;
4428 bufmax
= buffer
+ max_bytes
- 1;
4430 while (bufptr
> bufmax
)
4434 while ((*bufptr
& 0xc0) == 0x80 && bufptr
> buffer
)
4445 * Set the formatted string and return...
4448 return (ippSetString(ipp
, attr
, element
, buffer
));
4453 * 'ippSetValueTag()' - Set the value tag of an attribute.
4455 * The @code ipp@ parameter refers to an IPP message previously created using
4456 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
4458 * The @code attr@ parameter may be modified as a result of setting the value.
4460 * Integer (@code IPP_TAG_INTEGER@) values can be promoted to rangeOfInteger
4461 * (@code IPP_TAG_RANGE@) values, the various string tags can be promoted to name
4462 * (@code IPP_TAG_NAME@) or nameWithLanguage (@code IPP_TAG_NAMELANG@) values, text
4463 * (@code IPP_TAG_TEXT@) values can be promoted to textWithLanguage
4464 * (@code IPP_TAG_TEXTLANG@) values, and all values can be demoted to the various
4465 * out-of-band value tags such as no-value (@code IPP_TAG_NOVALUE@). All other changes
4468 * Promoting a string attribute to nameWithLanguage or textWithLanguage adds the language
4469 * code in the "attributes-natural-language" attribute or, if not present, the language
4470 * code for the current locale.
4472 * @since CUPS 1.6/macOS 10.8@
4475 int /* O - 1 on success, 0 on failure */
4477 ipp_t
*ipp
, /* I - IPP message */
4478 ipp_attribute_t
**attr
, /* IO - IPP attribute */
4479 ipp_tag_t value_tag
) /* I - Value tag */
4481 int i
; /* Looping var */
4482 _ipp_value_t
*value
; /* Current value */
4483 int integer
; /* Current integer value */
4484 cups_lang_t
*language
; /* Current language */
4485 char code
[32]; /* Language code */
4486 ipp_tag_t temp_tag
; /* Temporary value tag */
4490 * Range check input...
4493 if (!ipp
|| !attr
|| !*attr
)
4497 * If there is no change, return immediately...
4500 if (value_tag
== (*attr
)->value_tag
)
4504 * Otherwise implement changes as needed...
4507 temp_tag
= (ipp_tag_t
)((int)((*attr
)->value_tag
) & IPP_TAG_CUPS_MASK
);
4511 case IPP_TAG_UNSUPPORTED_VALUE
:
4512 case IPP_TAG_DEFAULT
:
4513 case IPP_TAG_UNKNOWN
:
4514 case IPP_TAG_NOVALUE
:
4515 case IPP_TAG_NOTSETTABLE
:
4516 case IPP_TAG_DELETEATTR
:
4517 case IPP_TAG_ADMINDEFINE
:
4519 * Free any existing values...
4522 if ((*attr
)->num_values
> 0)
4523 ipp_free_values(*attr
, 0, (*attr
)->num_values
);
4526 * Set out-of-band value...
4529 (*attr
)->value_tag
= value_tag
;
4532 case IPP_TAG_RANGE
:
4533 if (temp_tag
!= IPP_TAG_INTEGER
)
4536 for (i
= (*attr
)->num_values
, value
= (*attr
)->values
;
4540 integer
= value
->integer
;
4541 value
->range
.lower
= value
->range
.upper
= integer
;
4544 (*attr
)->value_tag
= IPP_TAG_RANGE
;
4548 if (temp_tag
!= IPP_TAG_KEYWORD
&& temp_tag
!= IPP_TAG_URI
&&
4549 temp_tag
!= IPP_TAG_URISCHEME
&& temp_tag
!= IPP_TAG_LANGUAGE
&&
4550 temp_tag
!= IPP_TAG_MIMETYPE
)
4553 (*attr
)->value_tag
= (ipp_tag_t
)(IPP_TAG_NAME
| ((*attr
)->value_tag
& IPP_TAG_CUPS_CONST
));
4556 case IPP_TAG_NAMELANG
:
4557 case IPP_TAG_TEXTLANG
:
4558 if (value_tag
== IPP_TAG_NAMELANG
&&
4559 (temp_tag
!= IPP_TAG_NAME
&& temp_tag
!= IPP_TAG_KEYWORD
&&
4560 temp_tag
!= IPP_TAG_URI
&& temp_tag
!= IPP_TAG_URISCHEME
&&
4561 temp_tag
!= IPP_TAG_LANGUAGE
&& temp_tag
!= IPP_TAG_MIMETYPE
))
4564 if (value_tag
== IPP_TAG_TEXTLANG
&& temp_tag
!= IPP_TAG_TEXT
)
4567 if (ipp
->attrs
&& ipp
->attrs
->next
&& ipp
->attrs
->next
->name
&&
4568 !strcmp(ipp
->attrs
->next
->name
, "attributes-natural-language"))
4571 * Use the language code from the IPP message...
4574 (*attr
)->values
[0].string
.language
=
4575 _cupsStrAlloc(ipp
->attrs
->next
->values
[0].string
.text
);
4580 * Otherwise, use the language code corresponding to the locale...
4583 language
= cupsLangDefault();
4584 (*attr
)->values
[0].string
.language
= _cupsStrAlloc(ipp_lang_code(language
->language
,
4589 for (i
= (*attr
)->num_values
- 1, value
= (*attr
)->values
+ 1;
4592 value
->string
.language
= (*attr
)->values
[0].string
.language
;
4594 if ((int)(*attr
)->value_tag
& IPP_TAG_CUPS_CONST
)
4597 * Make copies of all values...
4600 for (i
= (*attr
)->num_values
, value
= (*attr
)->values
;
4603 value
->string
.text
= _cupsStrAlloc(value
->string
.text
);
4606 (*attr
)->value_tag
= IPP_TAG_NAMELANG
;
4609 case IPP_TAG_KEYWORD
:
4610 if (temp_tag
== IPP_TAG_NAME
|| temp_tag
== IPP_TAG_NAMELANG
)
4611 break; /* Silently "allow" name -> keyword */
4622 * 'ippSetVersion()' - Set the version number in an IPP message.
4624 * The @code ipp@ parameter refers to an IPP message previously created using
4625 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
4627 * The valid version numbers are currently 1.0, 1.1, 2.0, 2.1, and 2.2.
4629 * @since CUPS 1.6/macOS 10.8@
4632 int /* O - 1 on success, 0 on failure */
4633 ippSetVersion(ipp_t
*ipp
, /* I - IPP message */
4634 int major
, /* I - Major version number (major.minor) */
4635 int minor
) /* I - Minor version number (major.minor) */
4638 * Range check input...
4641 if (!ipp
|| major
< 0 || minor
< 0)
4645 * Set the version number...
4648 ipp
->request
.any
.version
[0] = (ipp_uchar_t
)major
;
4649 ipp
->request
.any
.version
[1] = (ipp_uchar_t
)minor
;
4656 * 'ippTimeToDate()' - Convert from time in seconds to RFC 2579 format.
4659 const ipp_uchar_t
* /* O - RFC-2579 date/time data */
4660 ippTimeToDate(time_t t
) /* I - Time in seconds */
4662 struct tm
*unixdate
; /* UNIX unixdate/time info */
4663 ipp_uchar_t
*date
= _cupsGlobals()->ipp_date
;
4664 /* RFC-2579 date/time data */
4668 * RFC-2579 date/time format is:
4670 * Byte(s) Description
4671 * ------- -----------
4672 * 0-1 Year (0 to 65535)
4676 * 5 Minutes (0 to 59)
4677 * 6 Seconds (0 to 60, 60 = "leap second")
4678 * 7 Deciseconds (0 to 9)
4680 * 9 UTC hours (0 to 11)
4681 * 10 UTC minutes (0 to 59)
4684 unixdate
= gmtime(&t
);
4685 unixdate
->tm_year
+= 1900;
4687 date
[0] = (ipp_uchar_t
)(unixdate
->tm_year
>> 8);
4688 date
[1] = (ipp_uchar_t
)(unixdate
->tm_year
);
4689 date
[2] = (ipp_uchar_t
)(unixdate
->tm_mon
+ 1);
4690 date
[3] = (ipp_uchar_t
)unixdate
->tm_mday
;
4691 date
[4] = (ipp_uchar_t
)unixdate
->tm_hour
;
4692 date
[5] = (ipp_uchar_t
)unixdate
->tm_min
;
4693 date
[6] = (ipp_uchar_t
)unixdate
->tm_sec
;
4704 * 'ippValidateAttribute()' - Validate the contents of an attribute.
4706 * This function validates the contents of an attribute based on the name and
4707 * value tag. 1 is returned if the attribute is valid, 0 otherwise. On
4708 * failure, @link cupsLastErrorString@ is set to a human-readable message.
4710 * @since CUPS 1.7/macOS 10.9@
4713 int /* O - 1 if valid, 0 otherwise */
4714 ippValidateAttribute(
4715 ipp_attribute_t
*attr
) /* I - Attribute */
4717 int i
; /* Looping var */
4718 char scheme
[64], /* Scheme from URI */
4719 userpass
[256], /* Username/password from URI */
4720 hostname
[256], /* Hostname from URI */
4721 resource
[1024]; /* Resource from URI */
4722 int port
, /* Port number from URI */
4723 uri_status
; /* URI separation status */
4724 const char *ptr
; /* Pointer into string */
4725 ipp_attribute_t
*colattr
; /* Collection attribute */
4726 regex_t re
; /* Regular expression */
4727 ipp_uchar_t
*date
; /* Current date value */
4738 * Validate the attribute name.
4741 for (ptr
= attr
->name
; *ptr
; ptr
++)
4742 if (!isalnum(*ptr
& 255) && *ptr
!= '-' && *ptr
!= '.' && *ptr
!= '_')
4745 if (*ptr
|| ptr
== attr
->name
)
4747 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad attribute name - invalid character (RFC 8011 section 5.1.4)."), attr
->name
);
4751 if ((ptr
- attr
->name
) > 255)
4753 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad attribute name - bad length %d (RFC 8011 section 5.1.4)."), attr
->name
, (int)(ptr
- attr
->name
));
4757 switch (attr
->value_tag
)
4759 case IPP_TAG_INTEGER
:
4762 case IPP_TAG_BOOLEAN
:
4763 for (i
= 0; i
< attr
->num_values
; i
++)
4765 if (attr
->values
[i
].boolean
!= 0 &&
4766 attr
->values
[i
].boolean
!= 1)
4768 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad boolean value %d (RFC 8011 section 5.1.21)."), attr
->name
, attr
->values
[i
].boolean
);
4775 for (i
= 0; i
< attr
->num_values
; i
++)
4777 if (attr
->values
[i
].integer
< 1)
4779 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad enum value %d - out of range (RFC 8011 section 5.1.5)."), attr
->name
, attr
->values
[i
].integer
);
4785 case IPP_TAG_STRING
:
4786 for (i
= 0; i
< attr
->num_values
; i
++)
4788 if (attr
->values
[i
].unknown
.length
> IPP_MAX_OCTETSTRING
)
4790 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad octetString value - bad length %d (RFC 8011 section 5.1.20)."), attr
->name
, attr
->values
[i
].unknown
.length
);
4797 for (i
= 0; i
< attr
->num_values
; i
++)
4799 date
= attr
->values
[i
].date
;
4801 if (date
[2] < 1 || date
[2] > 12)
4803 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad dateTime month %u (RFC 8011 section 5.1.15)."), attr
->name
, date
[2]);
4807 if (date
[3] < 1 || date
[3] > 31)
4809 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad dateTime day %u (RFC 8011 section 5.1.15)."), attr
->name
, date
[3]);
4815 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad dateTime hours %u (RFC 8011 section 5.1.15)."), attr
->name
, date
[4]);
4821 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad dateTime minutes %u (RFC 8011 section 5.1.15)."), attr
->name
, date
[5]);
4827 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad dateTime seconds %u (RFC 8011 section 5.1.15)."), attr
->name
, date
[6]);
4833 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad dateTime deciseconds %u (RFC 8011 section 5.1.15)."), attr
->name
, date
[7]);
4837 if (date
[8] != '-' && date
[8] != '+')
4839 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad dateTime UTC sign '%c' (RFC 8011 section 5.1.15)."), attr
->name
, date
[8]);
4845 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad dateTime UTC hours %u (RFC 8011 section 5.1.15)."), attr
->name
, date
[9]);
4851 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad dateTime UTC minutes %u (RFC 8011 section 5.1.15)."), attr
->name
, date
[10]);
4857 case IPP_TAG_RESOLUTION
:
4858 for (i
= 0; i
< attr
->num_values
; i
++)
4860 if (attr
->values
[i
].resolution
.xres
<= 0)
4862 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad resolution value %dx%d%s - cross feed resolution must be positive (RFC 8011 section 5.1.16)."), attr
->name
, attr
->values
[i
].resolution
.xres
, attr
->values
[i
].resolution
.yres
, attr
->values
[i
].resolution
.units
== IPP_RES_PER_INCH
? "dpi" : attr
->values
[i
].resolution
.units
== IPP_RES_PER_CM
? "dpcm" : "unknown");
4866 if (attr
->values
[i
].resolution
.yres
<= 0)
4868 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad resolution value %dx%d%s - feed resolution must be positive (RFC 8011 section 5.1.16)."), attr
->name
, attr
->values
[i
].resolution
.xres
, attr
->values
[i
].resolution
.yres
, attr
->values
[i
].resolution
.units
== IPP_RES_PER_INCH
? "dpi" : attr
->values
[i
].resolution
.units
== IPP_RES_PER_CM
? "dpcm" : "unknown");
4872 if (attr
->values
[i
].resolution
.units
!= IPP_RES_PER_INCH
&& attr
->values
[i
].resolution
.units
!= IPP_RES_PER_CM
)
4874 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad resolution value %dx%d%s - bad units value (RFC 8011 section 5.1.16)."), attr
->name
, attr
->values
[i
].resolution
.xres
, attr
->values
[i
].resolution
.yres
, attr
->values
[i
].resolution
.units
== IPP_RES_PER_INCH
? "dpi" : attr
->values
[i
].resolution
.units
== IPP_RES_PER_CM
? "dpcm" : "unknown");
4880 case IPP_TAG_RANGE
:
4881 for (i
= 0; i
< attr
->num_values
; i
++)
4883 if (attr
->values
[i
].range
.lower
> attr
->values
[i
].range
.upper
)
4885 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad rangeOfInteger value %d-%d - lower greater than upper (RFC 8011 section 5.1.14)."), attr
->name
, attr
->values
[i
].range
.lower
, attr
->values
[i
].range
.upper
);
4891 case IPP_TAG_BEGIN_COLLECTION
:
4892 for (i
= 0; i
< attr
->num_values
; i
++)
4894 for (colattr
= attr
->values
[i
].collection
->attrs
;
4896 colattr
= colattr
->next
)
4898 if (!ippValidateAttribute(colattr
))
4905 case IPP_TAG_TEXTLANG
:
4906 for (i
= 0; i
< attr
->num_values
; i
++)
4908 for (ptr
= attr
->values
[i
].string
.text
; *ptr
; ptr
++)
4910 if ((*ptr
& 0xe0) == 0xc0)
4913 if ((*ptr
& 0xc0) != 0x80)
4916 else if ((*ptr
& 0xf0) == 0xe0)
4919 if ((*ptr
& 0xc0) != 0x80)
4922 if ((*ptr
& 0xc0) != 0x80)
4925 else if ((*ptr
& 0xf8) == 0xf0)
4928 if ((*ptr
& 0xc0) != 0x80)
4931 if ((*ptr
& 0xc0) != 0x80)
4934 if ((*ptr
& 0xc0) != 0x80)
4937 else if (*ptr
& 0x80)
4939 else if ((*ptr
< ' ' && *ptr
!= '\n' && *ptr
!= '\r' && *ptr
!= '\t') || *ptr
== 0x7f)
4945 if (*ptr
< ' ' || *ptr
== 0x7f)
4947 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad text value \"%s\" - bad control character (PWG 5100.14 section 8.3)."), attr
->name
, attr
->values
[i
].string
.text
);
4952 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad text value \"%s\" - bad UTF-8 sequence (RFC 8011 section 5.1.2)."), attr
->name
, attr
->values
[i
].string
.text
);
4957 if ((ptr
- attr
->values
[i
].string
.text
) > (IPP_MAX_TEXT
- 1))
4959 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad text value \"%s\" - bad length %d (RFC 8011 section 5.1.2)."), attr
->name
, attr
->values
[i
].string
.text
, (int)(ptr
- attr
->values
[i
].string
.text
));
4966 case IPP_TAG_NAMELANG
:
4967 for (i
= 0; i
< attr
->num_values
; i
++)
4969 for (ptr
= attr
->values
[i
].string
.text
; *ptr
; ptr
++)
4971 if ((*ptr
& 0xe0) == 0xc0)
4974 if ((*ptr
& 0xc0) != 0x80)
4977 else if ((*ptr
& 0xf0) == 0xe0)
4980 if ((*ptr
& 0xc0) != 0x80)
4983 if ((*ptr
& 0xc0) != 0x80)
4986 else if ((*ptr
& 0xf8) == 0xf0)
4989 if ((*ptr
& 0xc0) != 0x80)
4992 if ((*ptr
& 0xc0) != 0x80)
4995 if ((*ptr
& 0xc0) != 0x80)
4998 else if (*ptr
& 0x80)
5000 else if (*ptr
< ' ' || *ptr
== 0x7f)
5006 if (*ptr
< ' ' || *ptr
== 0x7f)
5008 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad name value \"%s\" - bad control character (PWG 5100.14 section 8.1)."), attr
->name
, attr
->values
[i
].string
.text
);
5013 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad name value \"%s\" - bad UTF-8 sequence (RFC 8011 section 5.1.3)."), attr
->name
, attr
->values
[i
].string
.text
);
5018 if ((ptr
- attr
->values
[i
].string
.text
) > (IPP_MAX_NAME
- 1))
5020 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad name value \"%s\" - bad length %d (RFC 8011 section 5.1.3)."), attr
->name
, attr
->values
[i
].string
.text
, (int)(ptr
- attr
->values
[i
].string
.text
));
5026 case IPP_TAG_KEYWORD
:
5027 for (i
= 0; i
< attr
->num_values
; i
++)
5029 for (ptr
= attr
->values
[i
].string
.text
; *ptr
; ptr
++)
5031 if (!isalnum(*ptr
& 255) && *ptr
!= '-' && *ptr
!= '.' &&
5036 if (*ptr
|| ptr
== attr
->values
[i
].string
.text
)
5038 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad keyword value \"%s\" - invalid character (RFC 8011 section 5.1.4)."), attr
->name
, attr
->values
[i
].string
.text
);
5042 if ((ptr
- attr
->values
[i
].string
.text
) > (IPP_MAX_KEYWORD
- 1))
5044 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad keyword value \"%s\" - bad length %d (RFC 8011 section 5.1.4)."), attr
->name
, attr
->values
[i
].string
.text
, (int)(ptr
- attr
->values
[i
].string
.text
));
5051 for (i
= 0; i
< attr
->num_values
; i
++)
5053 uri_status
= httpSeparateURI(HTTP_URI_CODING_ALL
, attr
->values
[i
].string
.text
, scheme
, sizeof(scheme
), userpass
, sizeof(userpass
), hostname
, sizeof(hostname
), &port
, resource
, sizeof(resource
));
5055 if (uri_status
< HTTP_URI_STATUS_OK
)
5057 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad URI value \"%s\" - %s (RFC 8011 section 5.1.6)."), attr
->name
, attr
->values
[i
].string
.text
, httpURIStatusString(uri_status
));
5061 if (strlen(attr
->values
[i
].string
.text
) > (IPP_MAX_URI
- 1))
5063 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad URI value \"%s\" - bad length %d (RFC 8011 section 5.1.6)."), attr
->name
, attr
->values
[i
].string
.text
, (int)strlen(attr
->values
[i
].string
.text
));
5068 case IPP_TAG_URISCHEME
:
5069 for (i
= 0; i
< attr
->num_values
; i
++)
5071 ptr
= attr
->values
[i
].string
.text
;
5072 if (islower(*ptr
& 255))
5074 for (ptr
++; *ptr
; ptr
++)
5076 if (!islower(*ptr
& 255) && !isdigit(*ptr
& 255) &&
5077 *ptr
!= '+' && *ptr
!= '-' && *ptr
!= '.')
5082 if (*ptr
|| ptr
== attr
->values
[i
].string
.text
)
5084 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad uriScheme value \"%s\" - bad characters (RFC 8011 section 5.1.7)."), attr
->name
, attr
->values
[i
].string
.text
);
5088 if ((ptr
- attr
->values
[i
].string
.text
) > (IPP_MAX_URISCHEME
- 1))
5090 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad uriScheme value \"%s\" - bad length %d (RFC 8011 section 5.1.7)."), attr
->name
, attr
->values
[i
].string
.text
, (int)(ptr
- attr
->values
[i
].string
.text
));
5096 case IPP_TAG_CHARSET
:
5097 for (i
= 0; i
< attr
->num_values
; i
++)
5099 for (ptr
= attr
->values
[i
].string
.text
; *ptr
; ptr
++)
5101 if (!isprint(*ptr
& 255) || isupper(*ptr
& 255) ||
5102 isspace(*ptr
& 255))
5106 if (*ptr
|| ptr
== attr
->values
[i
].string
.text
)
5108 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad charset value \"%s\" - bad characters (RFC 8011 section 5.1.8)."), attr
->name
, attr
->values
[i
].string
.text
);
5112 if ((ptr
- attr
->values
[i
].string
.text
) > (IPP_MAX_CHARSET
- 1))
5114 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad charset value \"%s\" - bad length %d (RFC 8011 section 5.1.8)."), attr
->name
, attr
->values
[i
].string
.text
, (int)(ptr
- attr
->values
[i
].string
.text
));
5120 case IPP_TAG_LANGUAGE
:
5122 * The following regular expression is derived from the ABNF for
5123 * language tags in RFC 4646. All I can say is that this is the
5124 * easiest way to check the values...
5127 if ((i
= regcomp(&re
,
5129 "(([a-z]{2,3}(-[a-z][a-z][a-z]){0,3})|[a-z]{4,8})"
5131 "(-[a-z][a-z][a-z][a-z]){0,1}" /* script */
5132 "(-([a-z][a-z]|[0-9][0-9][0-9])){0,1}" /* region */
5133 "(-([a-z]{5,8}|[0-9][0-9][0-9]))*" /* variant */
5134 "(-[a-wy-z](-[a-z0-9]{2,8})+)*" /* extension */
5135 "(-x(-[a-z0-9]{1,8})+)*" /* privateuse */
5137 "x(-[a-z0-9]{1,8})+" /* privateuse */
5139 "[a-z]{1,3}(-[a-z][0-9]{2,8}){1,2}" /* grandfathered */
5141 REG_NOSUB
| REG_EXTENDED
)) != 0)
5143 char temp
[256]; /* Temporary error string */
5145 regerror(i
, &re
, temp
, sizeof(temp
));
5146 ipp_set_error(IPP_STATUS_ERROR_INTERNAL
, _("Unable to compile naturalLanguage regular expression: %s."), temp
);
5150 for (i
= 0; i
< attr
->num_values
; i
++)
5152 if (regexec(&re
, attr
->values
[i
].string
.text
, 0, NULL
, 0))
5154 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad naturalLanguage value \"%s\" - bad characters (RFC 8011 section 5.1.9)."), attr
->name
, attr
->values
[i
].string
.text
);
5159 if (strlen(attr
->values
[i
].string
.text
) > (IPP_MAX_LANGUAGE
- 1))
5161 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad naturalLanguage value \"%s\" - bad length %d (RFC 8011 section 5.1.9)."), attr
->name
, attr
->values
[i
].string
.text
, (int)strlen(attr
->values
[i
].string
.text
));
5170 case IPP_TAG_MIMETYPE
:
5172 * The following regular expression is derived from the ABNF for
5173 * MIME media types in RFC 2045 and 4288. All I can say is that this is
5174 * the easiest way to check the values...
5177 if ((i
= regcomp(&re
,
5179 "[-a-zA-Z0-9!#$&.+^_]{1,127}" /* type-name */
5181 "[-a-zA-Z0-9!#$&.+^_]{1,127}" /* subtype-name */
5182 "(;[-a-zA-Z0-9!#$&.+^_]{1,127}=" /* parameter= */
5183 "([-a-zA-Z0-9!#$&.+^_]{1,127}|\"[^\"]*\"))*"
5186 REG_NOSUB
| REG_EXTENDED
)) != 0)
5188 char temp
[256]; /* Temporary error string */
5190 regerror(i
, &re
, temp
, sizeof(temp
));
5191 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("Unable to compile mimeMediaType regular expression: %s."), temp
);
5195 for (i
= 0; i
< attr
->num_values
; i
++)
5197 if (regexec(&re
, attr
->values
[i
].string
.text
, 0, NULL
, 0))
5199 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad mimeMediaType value \"%s\" - bad characters (RFC 8011 section 5.1.10)."), attr
->name
, attr
->values
[i
].string
.text
);
5204 if (strlen(attr
->values
[i
].string
.text
) > (IPP_MAX_MIMETYPE
- 1))
5206 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad mimeMediaType value \"%s\" - bad length %d (RFC 8011 section 5.1.10)."), attr
->name
, attr
->values
[i
].string
.text
, (int)strlen(attr
->values
[i
].string
.text
));
5224 * 'ippValidateAttributes()' - Validate all attributes in an IPP message.
5226 * This function validates the contents of the IPP message, including each
5227 * attribute. Like @link ippValidateAttribute@, @link cupsLastErrorString@ is
5228 * set to a human-readable message on failure.
5230 * @since CUPS 1.7/macOS 10.9@
5233 int /* O - 1 if valid, 0 otherwise */
5234 ippValidateAttributes(ipp_t
*ipp
) /* I - IPP message */
5236 ipp_attribute_t
*attr
; /* Current attribute */
5242 for (attr
= ipp
->attrs
; attr
; attr
= attr
->next
)
5243 if (!ippValidateAttribute(attr
))
5251 * 'ippWrite()' - Write data for an IPP message to a HTTP connection.
5254 ipp_state_t
/* O - Current state */
5255 ippWrite(http_t
*http
, /* I - HTTP connection */
5256 ipp_t
*ipp
) /* I - IPP data */
5258 DEBUG_printf(("ippWrite(http=%p, ipp=%p)", (void *)http
, (void *)ipp
));
5261 return (IPP_STATE_ERROR
);
5263 return (ippWriteIO(http
, (ipp_iocb_t
)httpWrite2
, http
->blocking
, NULL
, ipp
));
5268 * 'ippWriteFile()' - Write data for an IPP message to a file.
5270 * @since CUPS 1.1.19/macOS 10.3@
5273 ipp_state_t
/* O - Current state */
5274 ippWriteFile(int fd
, /* I - HTTP data */
5275 ipp_t
*ipp
) /* I - IPP data */
5277 DEBUG_printf(("ippWriteFile(fd=%d, ipp=%p)", fd
, (void *)ipp
));
5279 ipp
->state
= IPP_STATE_IDLE
;
5281 return (ippWriteIO(&fd
, (ipp_iocb_t
)ipp_write_file
, 1, NULL
, ipp
));
5286 * 'ippWriteIO()' - Write data for an IPP message.
5288 * @since CUPS 1.2/macOS 10.5@
5291 ipp_state_t
/* O - Current state */
5292 ippWriteIO(void *dst
, /* I - Destination */
5293 ipp_iocb_t cb
, /* I - Write callback function */
5294 int blocking
, /* I - Use blocking IO? */
5295 ipp_t
*parent
, /* I - Parent IPP message */
5296 ipp_t
*ipp
) /* I - IPP data */
5298 int i
; /* Looping var */
5299 int n
; /* Length of data */
5300 unsigned char *buffer
, /* Data buffer */
5301 *bufptr
; /* Pointer into buffer */
5302 ipp_attribute_t
*attr
; /* Current attribute */
5303 _ipp_value_t
*value
; /* Current value */
5306 DEBUG_printf(("ippWriteIO(dst=%p, cb=%p, blocking=%d, parent=%p, ipp=%p)", (void *)dst
, (void *)cb
, blocking
, (void *)parent
, (void *)ipp
));
5309 return (IPP_STATE_ERROR
);
5311 if ((buffer
= (unsigned char *)_cupsBufferGet(IPP_BUF_SIZE
)) == NULL
)
5313 DEBUG_puts("1ippWriteIO: Unable to get write buffer");
5314 return (IPP_STATE_ERROR
);
5319 case IPP_STATE_IDLE
:
5320 ipp
->state
++; /* Avoid common problem... */
5322 case IPP_STATE_HEADER
:
5326 * Send the request header:
5329 * Operation/Status Code = 2 bytes
5330 * Request ID = 4 bytes
5336 *bufptr
++ = ipp
->request
.any
.version
[0];
5337 *bufptr
++ = ipp
->request
.any
.version
[1];
5338 *bufptr
++ = (ipp_uchar_t
)(ipp
->request
.any
.op_status
>> 8);
5339 *bufptr
++ = (ipp_uchar_t
)ipp
->request
.any
.op_status
;
5340 *bufptr
++ = (ipp_uchar_t
)(ipp
->request
.any
.request_id
>> 24);
5341 *bufptr
++ = (ipp_uchar_t
)(ipp
->request
.any
.request_id
>> 16);
5342 *bufptr
++ = (ipp_uchar_t
)(ipp
->request
.any
.request_id
>> 8);
5343 *bufptr
++ = (ipp_uchar_t
)ipp
->request
.any
.request_id
;
5345 DEBUG_printf(("2ippWriteIO: version=%d.%d", buffer
[0], buffer
[1]));
5346 DEBUG_printf(("2ippWriteIO: op_status=%04x",
5347 ipp
->request
.any
.op_status
));
5348 DEBUG_printf(("2ippWriteIO: request_id=%d",
5349 ipp
->request
.any
.request_id
));
5351 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
5353 DEBUG_puts("1ippWriteIO: Could not write IPP header...");
5354 _cupsBufferRelease((char *)buffer
);
5355 return (IPP_STATE_ERROR
);
5360 * Reset the state engine to point to the first attribute
5361 * in the request/response, with no current group.
5364 ipp
->state
= IPP_STATE_ATTRIBUTE
;
5365 ipp
->current
= ipp
->attrs
;
5366 ipp
->curtag
= IPP_TAG_ZERO
;
5368 DEBUG_printf(("1ippWriteIO: ipp->current=%p", (void *)ipp
->current
));
5371 * If blocking is disabled, stop here...
5377 case IPP_STATE_ATTRIBUTE
:
5378 while (ipp
->current
!= NULL
)
5381 * Write this attribute...
5385 attr
= ipp
->current
;
5387 ipp
->current
= ipp
->current
->next
;
5391 if (ipp
->curtag
!= attr
->group_tag
)
5394 * Send a group tag byte...
5397 ipp
->curtag
= attr
->group_tag
;
5399 if (attr
->group_tag
== IPP_TAG_ZERO
)
5402 DEBUG_printf(("2ippWriteIO: wrote group tag=%x(%s)",
5403 attr
->group_tag
, ippTagString(attr
->group_tag
)));
5404 *bufptr
++ = (ipp_uchar_t
)attr
->group_tag
;
5406 else if (attr
->group_tag
== IPP_TAG_ZERO
)
5410 DEBUG_printf(("1ippWriteIO: %s (%s%s)", attr
->name
,
5411 attr
->num_values
> 1 ? "1setOf " : "",
5412 ippTagString(attr
->value_tag
)));
5415 * Write the attribute tag and name.
5417 * The attribute name length does not include the trailing nul
5418 * character in the source string.
5420 * Collection values (parent != NULL) are written differently...
5426 * Get the length of the attribute name, and make sure it won't
5427 * overflow the buffer...
5430 if ((n
= (int)strlen(attr
->name
)) > (IPP_BUF_SIZE
- 8))
5432 DEBUG_printf(("1ippWriteIO: Attribute name too long (%d)", n
));
5433 _cupsBufferRelease((char *)buffer
);
5434 return (IPP_STATE_ERROR
);
5438 * Write the value tag, name length, and name string...
5441 DEBUG_printf(("2ippWriteIO: writing value tag=%x(%s)",
5442 attr
->value_tag
, ippTagString(attr
->value_tag
)));
5443 DEBUG_printf(("2ippWriteIO: writing name=%d,\"%s\"", n
,
5446 if (attr
->value_tag
> 0xff)
5448 *bufptr
++ = IPP_TAG_EXTENSION
;
5449 *bufptr
++ = (ipp_uchar_t
)(attr
->value_tag
>> 24);
5450 *bufptr
++ = (ipp_uchar_t
)(attr
->value_tag
>> 16);
5451 *bufptr
++ = (ipp_uchar_t
)(attr
->value_tag
>> 8);
5452 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
5455 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
5457 *bufptr
++ = (ipp_uchar_t
)(n
>> 8);
5458 *bufptr
++ = (ipp_uchar_t
)n
;
5459 memcpy(bufptr
, attr
->name
, (size_t)n
);
5465 * Get the length of the attribute name, and make sure it won't
5466 * overflow the buffer...
5469 if ((n
= (int)strlen(attr
->name
)) > (IPP_BUF_SIZE
- 12))
5471 DEBUG_printf(("1ippWriteIO: Attribute name too long (%d)", n
));
5472 _cupsBufferRelease((char *)buffer
);
5473 return (IPP_STATE_ERROR
);
5477 * Write the member name tag, name length, name string, value tag,
5478 * and empty name for the collection member attribute...
5481 DEBUG_printf(("2ippWriteIO: writing value tag=%x(memberName)",
5482 IPP_TAG_MEMBERNAME
));
5483 DEBUG_printf(("2ippWriteIO: writing name=%d,\"%s\"", n
,
5485 DEBUG_printf(("2ippWriteIO: writing value tag=%x(%s)",
5486 attr
->value_tag
, ippTagString(attr
->value_tag
)));
5487 DEBUG_puts("2ippWriteIO: writing name=0,\"\"");
5489 *bufptr
++ = IPP_TAG_MEMBERNAME
;
5492 *bufptr
++ = (ipp_uchar_t
)(n
>> 8);
5493 *bufptr
++ = (ipp_uchar_t
)n
;
5494 memcpy(bufptr
, attr
->name
, (size_t)n
);
5497 if (attr
->value_tag
> 0xff)
5499 *bufptr
++ = IPP_TAG_EXTENSION
;
5500 *bufptr
++ = (ipp_uchar_t
)(attr
->value_tag
>> 24);
5501 *bufptr
++ = (ipp_uchar_t
)(attr
->value_tag
>> 16);
5502 *bufptr
++ = (ipp_uchar_t
)(attr
->value_tag
>> 8);
5503 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
5506 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
5513 * Now write the attribute value(s)...
5516 switch (attr
->value_tag
& ~IPP_TAG_CUPS_CONST
)
5518 case IPP_TAG_UNSUPPORTED_VALUE
:
5519 case IPP_TAG_DEFAULT
:
5520 case IPP_TAG_UNKNOWN
:
5521 case IPP_TAG_NOVALUE
:
5522 case IPP_TAG_NOTSETTABLE
:
5523 case IPP_TAG_DELETEATTR
:
5524 case IPP_TAG_ADMINDEFINE
:
5529 case IPP_TAG_INTEGER
:
5531 for (i
= 0, value
= attr
->values
;
5532 i
< attr
->num_values
;
5535 if ((IPP_BUF_SIZE
- (bufptr
- buffer
)) < 9)
5537 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
5539 DEBUG_puts("1ippWriteIO: Could not write IPP "
5541 _cupsBufferRelease((char *)buffer
);
5542 return (IPP_STATE_ERROR
);
5551 * Arrays and sets are done by sending additional
5552 * values with a zero-length name...
5555 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
5561 * Integers and enumerations are both 4-byte signed
5562 * (twos-complement) values.
5564 * Put the 2-byte length and 4-byte value into the buffer...
5569 *bufptr
++ = (ipp_uchar_t
)(value
->integer
>> 24);
5570 *bufptr
++ = (ipp_uchar_t
)(value
->integer
>> 16);
5571 *bufptr
++ = (ipp_uchar_t
)(value
->integer
>> 8);
5572 *bufptr
++ = (ipp_uchar_t
)value
->integer
;
5576 case IPP_TAG_BOOLEAN
:
5577 for (i
= 0, value
= attr
->values
;
5578 i
< attr
->num_values
;
5581 if ((IPP_BUF_SIZE
- (bufptr
- buffer
)) < 6)
5583 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
5585 DEBUG_puts("1ippWriteIO: Could not write IPP "
5587 _cupsBufferRelease((char *)buffer
);
5588 return (IPP_STATE_ERROR
);
5597 * Arrays and sets are done by sending additional
5598 * values with a zero-length name...
5601 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
5607 * Boolean values are 1-byte; 0 = false, 1 = true.
5609 * Put the 2-byte length and 1-byte value into the buffer...
5614 *bufptr
++ = (ipp_uchar_t
)value
->boolean
;
5620 case IPP_TAG_KEYWORD
:
5622 case IPP_TAG_URISCHEME
:
5623 case IPP_TAG_CHARSET
:
5624 case IPP_TAG_LANGUAGE
:
5625 case IPP_TAG_MIMETYPE
:
5626 for (i
= 0, value
= attr
->values
;
5627 i
< attr
->num_values
;
5633 * Arrays and sets are done by sending additional
5634 * values with a zero-length name...
5637 DEBUG_printf(("2ippWriteIO: writing value tag=%x(%s)",
5639 ippTagString(attr
->value_tag
)));
5640 DEBUG_printf(("2ippWriteIO: writing name=0,\"\""));
5642 if ((IPP_BUF_SIZE
- (bufptr
- buffer
)) < 3)
5644 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
5646 DEBUG_puts("1ippWriteIO: Could not write IPP "
5648 _cupsBufferRelease((char *)buffer
);
5649 return (IPP_STATE_ERROR
);
5655 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
5660 if (value
->string
.text
!= NULL
)
5661 n
= (int)strlen(value
->string
.text
);
5665 if (n
> (IPP_BUF_SIZE
- 2))
5667 DEBUG_printf(("1ippWriteIO: String too long (%d)", n
));
5668 _cupsBufferRelease((char *)buffer
);
5669 return (IPP_STATE_ERROR
);
5672 DEBUG_printf(("2ippWriteIO: writing string=%d,\"%s\"", n
,
5673 value
->string
.text
));
5675 if ((int)(IPP_BUF_SIZE
- (bufptr
- buffer
)) < (n
+ 2))
5677 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
5679 DEBUG_puts("1ippWriteIO: Could not write IPP "
5681 _cupsBufferRelease((char *)buffer
);
5682 return (IPP_STATE_ERROR
);
5689 * All simple strings consist of the 2-byte length and
5690 * character data without the trailing nul normally found
5691 * in C strings. Also, strings cannot be longer than IPP_MAX_LENGTH
5692 * bytes since the 2-byte length is a signed (twos-complement)
5695 * Put the 2-byte length and string characters in the buffer.
5698 *bufptr
++ = (ipp_uchar_t
)(n
>> 8);
5699 *bufptr
++ = (ipp_uchar_t
)n
;
5703 memcpy(bufptr
, value
->string
.text
, (size_t)n
);
5710 for (i
= 0, value
= attr
->values
;
5711 i
< attr
->num_values
;
5714 if ((IPP_BUF_SIZE
- (bufptr
- buffer
)) < 16)
5716 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
5718 DEBUG_puts("1ippWriteIO: Could not write IPP "
5720 _cupsBufferRelease((char *)buffer
);
5721 return (IPP_STATE_ERROR
);
5730 * Arrays and sets are done by sending additional
5731 * values with a zero-length name...
5734 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
5740 * Date values consist of a 2-byte length and an
5741 * 11-byte date/time structure defined by RFC 1903.
5743 * Put the 2-byte length and 11-byte date/time
5744 * structure in the buffer.
5749 memcpy(bufptr
, value
->date
, 11);
5754 case IPP_TAG_RESOLUTION
:
5755 for (i
= 0, value
= attr
->values
;
5756 i
< attr
->num_values
;
5759 if ((IPP_BUF_SIZE
- (bufptr
- buffer
)) < 14)
5761 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
5763 DEBUG_puts("1ippWriteIO: Could not write IPP "
5765 _cupsBufferRelease((char *)buffer
);
5766 return (IPP_STATE_ERROR
);
5775 * Arrays and sets are done by sending additional
5776 * values with a zero-length name...
5779 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
5785 * Resolution values consist of a 2-byte length,
5786 * 4-byte horizontal resolution value, 4-byte vertical
5787 * resolution value, and a 1-byte units value.
5789 * Put the 2-byte length and resolution value data
5795 *bufptr
++ = (ipp_uchar_t
)(value
->resolution
.xres
>> 24);
5796 *bufptr
++ = (ipp_uchar_t
)(value
->resolution
.xres
>> 16);
5797 *bufptr
++ = (ipp_uchar_t
)(value
->resolution
.xres
>> 8);
5798 *bufptr
++ = (ipp_uchar_t
)value
->resolution
.xres
;
5799 *bufptr
++ = (ipp_uchar_t
)(value
->resolution
.yres
>> 24);
5800 *bufptr
++ = (ipp_uchar_t
)(value
->resolution
.yres
>> 16);
5801 *bufptr
++ = (ipp_uchar_t
)(value
->resolution
.yres
>> 8);
5802 *bufptr
++ = (ipp_uchar_t
)value
->resolution
.yres
;
5803 *bufptr
++ = (ipp_uchar_t
)value
->resolution
.units
;
5807 case IPP_TAG_RANGE
:
5808 for (i
= 0, value
= attr
->values
;
5809 i
< attr
->num_values
;
5812 if ((IPP_BUF_SIZE
- (bufptr
- buffer
)) < 13)
5814 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
5816 DEBUG_puts("1ippWriteIO: Could not write IPP "
5818 _cupsBufferRelease((char *)buffer
);
5819 return (IPP_STATE_ERROR
);
5828 * Arrays and sets are done by sending additional
5829 * values with a zero-length name...
5832 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
5838 * Range values consist of a 2-byte length,
5839 * 4-byte lower value, and 4-byte upper value.
5841 * Put the 2-byte length and range value data
5847 *bufptr
++ = (ipp_uchar_t
)(value
->range
.lower
>> 24);
5848 *bufptr
++ = (ipp_uchar_t
)(value
->range
.lower
>> 16);
5849 *bufptr
++ = (ipp_uchar_t
)(value
->range
.lower
>> 8);
5850 *bufptr
++ = (ipp_uchar_t
)value
->range
.lower
;
5851 *bufptr
++ = (ipp_uchar_t
)(value
->range
.upper
>> 24);
5852 *bufptr
++ = (ipp_uchar_t
)(value
->range
.upper
>> 16);
5853 *bufptr
++ = (ipp_uchar_t
)(value
->range
.upper
>> 8);
5854 *bufptr
++ = (ipp_uchar_t
)value
->range
.upper
;
5858 case IPP_TAG_TEXTLANG
:
5859 case IPP_TAG_NAMELANG
:
5860 for (i
= 0, value
= attr
->values
;
5861 i
< attr
->num_values
;
5867 * Arrays and sets are done by sending additional
5868 * values with a zero-length name...
5871 if ((IPP_BUF_SIZE
- (bufptr
- buffer
)) < 3)
5873 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
5875 DEBUG_puts("1ippWriteIO: Could not write IPP "
5877 _cupsBufferRelease((char *)buffer
);
5878 return (IPP_STATE_ERROR
);
5884 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
5890 * textWithLanguage and nameWithLanguage values consist
5891 * of a 2-byte length for both strings and their
5892 * individual lengths, a 2-byte length for the
5893 * character string, the character string without the
5894 * trailing nul, a 2-byte length for the character
5895 * set string, and the character set string without
5901 if (value
->string
.language
!= NULL
)
5902 n
+= (int)strlen(value
->string
.language
);
5904 if (value
->string
.text
!= NULL
)
5905 n
+= (int)strlen(value
->string
.text
);
5907 if (n
> (IPP_BUF_SIZE
- 2))
5909 DEBUG_printf(("1ippWriteIO: text/nameWithLanguage value "
5910 "too long (%d)", n
));
5911 _cupsBufferRelease((char *)buffer
);
5912 return (IPP_STATE_ERROR
);
5915 if ((int)(IPP_BUF_SIZE
- (bufptr
- buffer
)) < (n
+ 2))
5917 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
5919 DEBUG_puts("1ippWriteIO: Could not write IPP "
5921 _cupsBufferRelease((char *)buffer
);
5922 return (IPP_STATE_ERROR
);
5928 /* Length of entire value */
5929 *bufptr
++ = (ipp_uchar_t
)(n
>> 8);
5930 *bufptr
++ = (ipp_uchar_t
)n
;
5932 /* Length of language */
5933 if (value
->string
.language
!= NULL
)
5934 n
= (int)strlen(value
->string
.language
);
5938 *bufptr
++ = (ipp_uchar_t
)(n
>> 8);
5939 *bufptr
++ = (ipp_uchar_t
)n
;
5944 memcpy(bufptr
, value
->string
.language
, (size_t)n
);
5948 /* Length of text */
5949 if (value
->string
.text
!= NULL
)
5950 n
= (int)strlen(value
->string
.text
);
5954 *bufptr
++ = (ipp_uchar_t
)(n
>> 8);
5955 *bufptr
++ = (ipp_uchar_t
)n
;
5960 memcpy(bufptr
, value
->string
.text
, (size_t)n
);
5966 case IPP_TAG_BEGIN_COLLECTION
:
5967 for (i
= 0, value
= attr
->values
;
5968 i
< attr
->num_values
;
5972 * Collections are written with the begin-collection
5973 * tag first with a value of 0 length, followed by the
5974 * attributes in the collection, then the end-collection
5978 if ((IPP_BUF_SIZE
- (bufptr
- buffer
)) < 5)
5980 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
5982 DEBUG_puts("1ippWriteIO: Could not write IPP "
5984 _cupsBufferRelease((char *)buffer
);
5985 return (IPP_STATE_ERROR
);
5994 * Arrays and sets are done by sending additional
5995 * values with a zero-length name...
5998 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
6004 * Write a data length of 0 and flush the buffer...
6010 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
6012 DEBUG_puts("1ippWriteIO: Could not write IPP "
6014 _cupsBufferRelease((char *)buffer
);
6015 return (IPP_STATE_ERROR
);
6021 * Then write the collection attribute...
6024 value
->collection
->state
= IPP_STATE_IDLE
;
6026 if (ippWriteIO(dst
, cb
, 1, ipp
,
6027 value
->collection
) == IPP_STATE_ERROR
)
6029 DEBUG_puts("1ippWriteIO: Unable to write collection value");
6030 _cupsBufferRelease((char *)buffer
);
6031 return (IPP_STATE_ERROR
);
6037 for (i
= 0, value
= attr
->values
;
6038 i
< attr
->num_values
;
6044 * Arrays and sets are done by sending additional
6045 * values with a zero-length name...
6048 if ((IPP_BUF_SIZE
- (bufptr
- buffer
)) < 3)
6050 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
6052 DEBUG_puts("1ippWriteIO: Could not write IPP "
6054 _cupsBufferRelease((char *)buffer
);
6055 return (IPP_STATE_ERROR
);
6061 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
6067 * An unknown value might some new value that a
6068 * vendor has come up with. It consists of a
6069 * 2-byte length and the bytes in the unknown
6073 n
= value
->unknown
.length
;
6075 if (n
> (IPP_BUF_SIZE
- 2))
6077 DEBUG_printf(("1ippWriteIO: Data length too long (%d)",
6079 _cupsBufferRelease((char *)buffer
);
6080 return (IPP_STATE_ERROR
);
6083 if ((int)(IPP_BUF_SIZE
- (bufptr
- buffer
)) < (n
+ 2))
6085 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
6087 DEBUG_puts("1ippWriteIO: Could not write IPP "
6089 _cupsBufferRelease((char *)buffer
);
6090 return (IPP_STATE_ERROR
);
6096 /* Length of unknown value */
6097 *bufptr
++ = (ipp_uchar_t
)(n
>> 8);
6098 *bufptr
++ = (ipp_uchar_t
)n
;
6103 memcpy(bufptr
, value
->unknown
.data
, (size_t)n
);
6111 * Write the data out...
6114 if (bufptr
> buffer
)
6116 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
6118 DEBUG_puts("1ippWriteIO: Could not write IPP attribute...");
6119 _cupsBufferRelease((char *)buffer
);
6120 return (IPP_STATE_ERROR
);
6123 DEBUG_printf(("2ippWriteIO: wrote %d bytes",
6124 (int)(bufptr
- buffer
)));
6128 * If blocking is disabled and we aren't at the end of the attribute
6129 * list, stop here...
6132 if (!blocking
&& ipp
->current
)
6136 if (ipp
->current
== NULL
)
6139 * Done with all of the attributes; add the end-of-attributes
6140 * tag or end-collection attribute...
6145 buffer
[0] = IPP_TAG_END
;
6150 buffer
[0] = IPP_TAG_END_COLLECTION
;
6151 buffer
[1] = 0; /* empty name */
6153 buffer
[3] = 0; /* empty value */
6158 if ((*cb
)(dst
, buffer
, (size_t)n
) < 0)
6160 DEBUG_puts("1ippWriteIO: Could not write IPP end-tag...");
6161 _cupsBufferRelease((char *)buffer
);
6162 return (IPP_STATE_ERROR
);
6165 ipp
->state
= IPP_STATE_DATA
;
6169 case IPP_STATE_DATA
:
6173 break; /* anti-compiler-warning-code */
6176 _cupsBufferRelease((char *)buffer
);
6178 return (ipp
->state
);
6183 * 'ipp_add_attr()' - Add a new attribute to the message.
6186 static ipp_attribute_t
* /* O - New attribute */
6187 ipp_add_attr(ipp_t
*ipp
, /* I - IPP message */
6188 const char *name
, /* I - Attribute name or NULL */
6189 ipp_tag_t group_tag
, /* I - Group tag or IPP_TAG_ZERO */
6190 ipp_tag_t value_tag
, /* I - Value tag or IPP_TAG_ZERO */
6191 int num_values
) /* I - Number of values */
6193 int alloc_values
; /* Number of values to allocate */
6194 ipp_attribute_t
*attr
; /* New attribute */
6197 DEBUG_printf(("4ipp_add_attr(ipp=%p, name=\"%s\", group_tag=0x%x, value_tag=0x%x, num_values=%d)", (void *)ipp
, name
, group_tag
, value_tag
, num_values
));
6200 * Range check input...
6203 if (!ipp
|| num_values
< 0)
6207 * Allocate memory, rounding the allocation up as needed...
6210 if (num_values
<= 1)
6213 alloc_values
= (num_values
+ IPP_MAX_VALUES
- 1) & ~(IPP_MAX_VALUES
- 1);
6215 attr
= calloc(sizeof(ipp_attribute_t
) +
6216 (size_t)(alloc_values
- 1) * sizeof(_ipp_value_t
), 1);
6221 * Initialize attribute...
6224 DEBUG_printf(("4debug_alloc: %p %s %s%s (%d values)", (void *)attr
, name
, num_values
> 1 ? "1setOf " : "", ippTagString(value_tag
), num_values
));
6227 attr
->name
= _cupsStrAlloc(name
);
6229 attr
->group_tag
= group_tag
;
6230 attr
->value_tag
= value_tag
;
6231 attr
->num_values
= num_values
;
6234 * Add it to the end of the linked list...
6238 ipp
->last
->next
= attr
;
6242 ipp
->prev
= ipp
->last
;
6243 ipp
->last
= ipp
->current
= attr
;
6246 DEBUG_printf(("5ipp_add_attr: Returning %p", (void *)attr
));
6253 * 'ipp_free_values()' - Free attribute values.
6257 ipp_free_values(ipp_attribute_t
*attr
, /* I - Attribute to free values from */
6258 int element
,/* I - First value to free */
6259 int count
) /* I - Number of values to free */
6261 int i
; /* Looping var */
6262 _ipp_value_t
*value
; /* Current value */
6265 DEBUG_printf(("4ipp_free_values(attr=%p, element=%d, count=%d)", (void *)attr
, element
, count
));
6267 if (!(attr
->value_tag
& IPP_TAG_CUPS_CONST
))
6270 * Free values as needed...
6273 switch (attr
->value_tag
)
6275 case IPP_TAG_TEXTLANG
:
6276 case IPP_TAG_NAMELANG
:
6277 if (element
== 0 && count
== attr
->num_values
&&
6278 attr
->values
[0].string
.language
)
6280 _cupsStrFree(attr
->values
[0].string
.language
);
6281 attr
->values
[0].string
.language
= NULL
;
6283 /* Fall through to other string values */
6287 case IPP_TAG_RESERVED_STRING
:
6288 case IPP_TAG_KEYWORD
:
6290 case IPP_TAG_URISCHEME
:
6291 case IPP_TAG_CHARSET
:
6292 case IPP_TAG_LANGUAGE
:
6293 case IPP_TAG_MIMETYPE
:
6294 for (i
= count
, value
= attr
->values
+ element
;
6298 _cupsStrFree(value
->string
.text
);
6299 value
->string
.text
= NULL
;
6303 case IPP_TAG_UNSUPPORTED_VALUE
:
6304 case IPP_TAG_DEFAULT
:
6305 case IPP_TAG_UNKNOWN
:
6306 case IPP_TAG_NOVALUE
:
6307 case IPP_TAG_NOTSETTABLE
:
6308 case IPP_TAG_DELETEATTR
:
6309 case IPP_TAG_ADMINDEFINE
:
6310 case IPP_TAG_INTEGER
:
6312 case IPP_TAG_BOOLEAN
:
6314 case IPP_TAG_RESOLUTION
:
6315 case IPP_TAG_RANGE
:
6318 case IPP_TAG_BEGIN_COLLECTION
:
6319 for (i
= count
, value
= attr
->values
+ element
;
6323 ippDelete(value
->collection
);
6324 value
->collection
= NULL
;
6328 case IPP_TAG_STRING
:
6330 for (i
= count
, value
= attr
->values
+ element
;
6334 if (value
->unknown
.data
)
6336 free(value
->unknown
.data
);
6337 value
->unknown
.data
= NULL
;
6345 * If we are not freeing values from the end, move the remaining values up...
6348 if ((element
+ count
) < attr
->num_values
)
6349 memmove(attr
->values
+ element
, attr
->values
+ element
+ count
,
6350 (size_t)(attr
->num_values
- count
- element
) * sizeof(_ipp_value_t
));
6352 attr
->num_values
-= count
;
6357 * 'ipp_get_code()' - Convert a C locale/charset name into an IPP language/charset code.
6359 * This typically converts strings of the form "ll_CC", "ll-REGION", and "CHARSET_NUMBER"
6360 * to "ll-cc", "ll-region", and "charset-number", respectively.
6363 static char * /* O - Language code string */
6364 ipp_get_code(const char *value
, /* I - Locale/charset string */
6365 char *buffer
, /* I - String buffer */
6366 size_t bufsize
) /* I - Size of string buffer */
6368 char *bufptr
, /* Pointer into buffer */
6369 *bufend
; /* End of buffer */
6373 * Convert values to lowercase and change _ to - as needed...
6376 for (bufptr
= buffer
, bufend
= buffer
+ bufsize
- 1;
6377 *value
&& bufptr
< bufend
;
6382 *bufptr
++ = (char)_cups_tolower(*value
);
6387 * Return the converted string...
6395 * 'ipp_lang_code()' - Convert a C locale name into an IPP language code.
6397 * This typically converts strings of the form "ll_CC" and "ll-REGION" to "ll-cc" and
6398 * "ll-region", respectively. It also converts the "C" (POSIX) locale to "en".
6401 static char * /* O - Language code string */
6402 ipp_lang_code(const char *locale
, /* I - Locale string */
6403 char *buffer
, /* I - String buffer */
6404 size_t bufsize
) /* I - Size of string buffer */
6407 * Map POSIX ("C") locale to generic English, otherwise convert the locale string as-is.
6410 if (!_cups_strcasecmp(locale
, "c"))
6412 strlcpy(buffer
, "en", bufsize
);
6416 return (ipp_get_code(locale
, buffer
, bufsize
));
6421 * 'ipp_length()' - Compute the length of an IPP message or collection value.
6424 static size_t /* O - Size of IPP message */
6425 ipp_length(ipp_t
*ipp
, /* I - IPP message or collection */
6426 int collection
) /* I - 1 if a collection, 0 otherwise */
6428 int i
; /* Looping var */
6429 size_t bytes
; /* Number of bytes */
6430 ipp_attribute_t
*attr
; /* Current attribute */
6431 ipp_tag_t group
; /* Current group */
6432 _ipp_value_t
*value
; /* Current value */
6435 DEBUG_printf(("3ipp_length(ipp=%p, collection=%d)", (void *)ipp
, collection
));
6439 DEBUG_puts("4ipp_length: Returning 0 bytes");
6444 * Start with 8 bytes for the IPP message header...
6447 bytes
= collection
? 0 : 8;
6450 * Then add the lengths of each attribute...
6453 group
= IPP_TAG_ZERO
;
6455 for (attr
= ipp
->attrs
; attr
!= NULL
; attr
= attr
->next
)
6457 if (attr
->group_tag
!= group
&& !collection
)
6459 group
= attr
->group_tag
;
6460 if (group
== IPP_TAG_ZERO
)
6463 bytes
++; /* Group tag */
6469 DEBUG_printf(("5ipp_length: attr->name=\"%s\", attr->num_values=%d, "
6470 "bytes=" CUPS_LLFMT
, attr
->name
, attr
->num_values
, CUPS_LLCAST bytes
));
6472 if ((attr
->value_tag
& ~IPP_TAG_CUPS_CONST
) < IPP_TAG_EXTENSION
)
6473 bytes
+= (size_t)attr
->num_values
;/* Value tag for each value */
6475 bytes
+= (size_t)(5 * attr
->num_values
);
6476 /* Value tag for each value */
6477 bytes
+= (size_t)(2 * attr
->num_values
);
6479 bytes
+= strlen(attr
->name
); /* Name */
6480 bytes
+= (size_t)(2 * attr
->num_values
);
6484 bytes
+= 5; /* Add membername overhead */
6486 switch (attr
->value_tag
& ~IPP_TAG_CUPS_CONST
)
6488 case IPP_TAG_UNSUPPORTED_VALUE
:
6489 case IPP_TAG_DEFAULT
:
6490 case IPP_TAG_UNKNOWN
:
6491 case IPP_TAG_NOVALUE
:
6492 case IPP_TAG_NOTSETTABLE
:
6493 case IPP_TAG_DELETEATTR
:
6494 case IPP_TAG_ADMINDEFINE
:
6497 case IPP_TAG_INTEGER
:
6499 bytes
+= (size_t)(4 * attr
->num_values
);
6502 case IPP_TAG_BOOLEAN
:
6503 bytes
+= (size_t)attr
->num_values
;
6508 case IPP_TAG_KEYWORD
:
6510 case IPP_TAG_URISCHEME
:
6511 case IPP_TAG_CHARSET
:
6512 case IPP_TAG_LANGUAGE
:
6513 case IPP_TAG_MIMETYPE
:
6514 for (i
= 0, value
= attr
->values
;
6515 i
< attr
->num_values
;
6517 if (value
->string
.text
)
6518 bytes
+= strlen(value
->string
.text
);
6522 bytes
+= (size_t)(11 * attr
->num_values
);
6525 case IPP_TAG_RESOLUTION
:
6526 bytes
+= (size_t)(9 * attr
->num_values
);
6529 case IPP_TAG_RANGE
:
6530 bytes
+= (size_t)(8 * attr
->num_values
);
6533 case IPP_TAG_TEXTLANG
:
6534 case IPP_TAG_NAMELANG
:
6535 bytes
+= (size_t)(4 * attr
->num_values
);
6536 /* Charset + text length */
6538 for (i
= 0, value
= attr
->values
;
6539 i
< attr
->num_values
;
6542 if (value
->string
.language
)
6543 bytes
+= strlen(value
->string
.language
);
6545 if (value
->string
.text
)
6546 bytes
+= strlen(value
->string
.text
);
6550 case IPP_TAG_BEGIN_COLLECTION
:
6551 for (i
= 0, value
= attr
->values
;
6552 i
< attr
->num_values
;
6554 bytes
+= ipp_length(value
->collection
, 1);
6558 for (i
= 0, value
= attr
->values
;
6559 i
< attr
->num_values
;
6561 bytes
+= (size_t)value
->unknown
.length
;
6567 * Finally, add 1 byte for the "end of attributes" tag or 5 bytes
6568 * for the "end of collection" tag and return...
6576 DEBUG_printf(("4ipp_length: Returning " CUPS_LLFMT
" bytes", CUPS_LLCAST bytes
));
6583 * 'ipp_read_http()' - Semi-blocking read on a HTTP connection...
6586 static ssize_t
/* O - Number of bytes read */
6587 ipp_read_http(http_t
*http
, /* I - Client connection */
6588 ipp_uchar_t
*buffer
, /* O - Buffer for data */
6589 size_t length
) /* I - Total length */
6591 ssize_t tbytes
, /* Total bytes read */
6592 bytes
; /* Bytes read this pass */
6595 DEBUG_printf(("7ipp_read_http(http=%p, buffer=%p, length=%d)", (void *)http
, (void *)buffer
, (int)length
));
6598 * Loop until all bytes are read...
6601 for (tbytes
= 0, bytes
= 0;
6602 tbytes
< (int)length
;
6603 tbytes
+= bytes
, buffer
+= bytes
)
6605 DEBUG_printf(("9ipp_read_http: tbytes=" CUPS_LLFMT
", http->state=%d", CUPS_LLCAST tbytes
, http
->state
));
6607 if (http
->state
== HTTP_STATE_WAITING
)
6610 if (http
->used
== 0 && !http
->blocking
)
6613 * Wait up to 10 seconds for more data on non-blocking sockets...
6616 if (!httpWait(http
, 10000))
6626 else if (http
->used
== 0 && http
->timeout_value
> 0)
6629 * Wait up to timeout seconds for more data on blocking sockets...
6632 if (!httpWait(http
, (int)(1000 * http
->timeout_value
)))
6643 if ((bytes
= httpRead2(http
, (char *)buffer
, length
- (size_t)tbytes
)) < 0)
6648 if (errno
!= EAGAIN
&& errno
!= EINTR
)
6654 else if (bytes
== 0)
6659 * Return the number of bytes read...
6662 if (tbytes
== 0 && bytes
< 0)
6665 DEBUG_printf(("8ipp_read_http: Returning " CUPS_LLFMT
" bytes", CUPS_LLCAST tbytes
));
6672 * 'ipp_read_file()' - Read IPP data from a file.
6675 static ssize_t
/* O - Number of bytes read */
6676 ipp_read_file(int *fd
, /* I - File descriptor */
6677 ipp_uchar_t
*buffer
, /* O - Read buffer */
6678 size_t length
) /* I - Number of bytes to read */
6681 return ((ssize_t
)read(*fd
, buffer
, (unsigned)length
));
6683 return (read(*fd
, buffer
, length
));
6689 * 'ipp_set_error()' - Set a formatted, localized error string.
6693 ipp_set_error(ipp_status_t status
, /* I - Status code */
6694 const char *format
, /* I - Printf-style error string */
6695 ...) /* I - Additional arguments as needed */
6697 va_list ap
; /* Pointer to additional args */
6698 char buffer
[2048]; /* Message buffer */
6699 cups_lang_t
*lang
= cupsLangDefault();
6700 /* Current language */
6703 va_start(ap
, format
);
6704 vsnprintf(buffer
, sizeof(buffer
), _cupsLangString(lang
, format
), ap
);
6707 _cupsSetError(status
, buffer
, 0);
6712 * 'ipp_set_value()' - Get the value element from an attribute, expanding it as
6716 static _ipp_value_t
* /* O - IPP value element or NULL on error */
6717 ipp_set_value(ipp_t
*ipp
, /* IO - IPP message */
6718 ipp_attribute_t
**attr
, /* IO - IPP attribute */
6719 int element
) /* I - Value number (0-based) */
6721 ipp_attribute_t
*temp
, /* New attribute pointer */
6722 *current
, /* Current attribute in list */
6723 *prev
; /* Previous attribute in list */
6724 int alloc_values
; /* Allocated values */
6728 * If we are setting an existing value element, return it...
6733 if (temp
->num_values
<= 1)
6736 alloc_values
= (temp
->num_values
+ IPP_MAX_VALUES
- 1) &
6737 ~(IPP_MAX_VALUES
- 1);
6739 if (element
< alloc_values
)
6741 if (element
>= temp
->num_values
)
6742 temp
->num_values
= element
+ 1;
6744 return (temp
->values
+ element
);
6748 * Otherwise re-allocate the attribute - we allocate in groups of IPP_MAX_VALUE
6749 * values when num_values > 1.
6752 if (alloc_values
< IPP_MAX_VALUES
)
6753 alloc_values
= IPP_MAX_VALUES
;
6755 alloc_values
+= IPP_MAX_VALUES
;
6757 DEBUG_printf(("4ipp_set_value: Reallocating for up to %d values.",
6761 * Reallocate memory...
6764 if ((temp
= realloc(temp
, sizeof(ipp_attribute_t
) + (size_t)(alloc_values
- 1) * sizeof(_ipp_value_t
))) == NULL
)
6766 _cupsSetHTTPError(HTTP_STATUS_ERROR
);
6767 DEBUG_puts("4ipp_set_value: Unable to resize attribute.");
6772 * Zero the new memory...
6775 memset(temp
->values
+ temp
->num_values
, 0, (size_t)(alloc_values
- temp
->num_values
) * sizeof(_ipp_value_t
));
6780 * Reset pointers in the list...
6783 #ifndef __clang_analyzer__
6784 DEBUG_printf(("4debug_free: %p %s", (void *)*attr
, temp
->name
));
6785 #endif /* !__clang_analyzer__ */
6786 DEBUG_printf(("4debug_alloc: %p %s %s%s (%d)", (void *)temp
, temp
->name
, temp
->num_values
> 1 ? "1setOf " : "", ippTagString(temp
->value_tag
), temp
->num_values
));
6788 if (ipp
->current
== *attr
&& ipp
->prev
)
6791 * Use current "previous" pointer...
6799 * Find this attribute in the linked list...
6802 for (prev
= NULL
, current
= ipp
->attrs
;
6803 current
&& current
!= *attr
;
6804 prev
= current
, current
= current
->next
);
6809 * This is a serious error!
6813 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
6814 _("IPP attribute is not a member of the message."), 1);
6815 DEBUG_puts("4ipp_set_value: Unable to find attribute in message.");
6825 ipp
->current
= temp
;
6828 if (ipp
->last
== *attr
)
6835 * Return the value element...
6838 if (element
>= temp
->num_values
)
6839 temp
->num_values
= element
+ 1;
6841 return (temp
->values
+ element
);
6846 * 'ipp_write_file()' - Write IPP data to a file.
6849 static ssize_t
/* O - Number of bytes written */
6850 ipp_write_file(int *fd
, /* I - File descriptor */
6851 ipp_uchar_t
*buffer
, /* I - Data to write */
6852 size_t length
) /* I - Number of bytes to write */
6855 return ((ssize_t
)write(*fd
, buffer
, (unsigned)length
));
6857 return (write(*fd
, buffer
, length
));