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"
26 static ipp_attribute_t
*ipp_add_attr(ipp_t
*ipp
, const char *name
,
27 ipp_tag_t group_tag
, ipp_tag_t value_tag
,
29 static void ipp_free_values(ipp_attribute_t
*attr
, int element
,
31 static char *ipp_get_code(const char *locale
, char *buffer
, size_t bufsize
) _CUPS_NONNULL(1,2);
32 static char *ipp_lang_code(const char *locale
, char *buffer
, size_t bufsize
) _CUPS_NONNULL(1,2);
33 static size_t ipp_length(ipp_t
*ipp
, int collection
);
34 static ssize_t
ipp_read_http(http_t
*http
, ipp_uchar_t
*buffer
,
36 static ssize_t
ipp_read_file(int *fd
, ipp_uchar_t
*buffer
,
38 static void ipp_set_error(ipp_status_t status
, const char *format
,
40 static _ipp_value_t
*ipp_set_value(ipp_t
*ipp
, ipp_attribute_t
**attr
,
42 static ssize_t
ipp_write_file(int *fd
, ipp_uchar_t
*buffer
,
47 * '_cupsBufferGet()' - Get a read/write buffer.
50 char * /* O - Buffer */
51 _cupsBufferGet(size_t size
) /* I - Size required */
53 _cups_buffer_t
*buffer
; /* Current buffer */
54 _cups_globals_t
*cg
= _cupsGlobals();
58 for (buffer
= cg
->cups_buffers
; buffer
; buffer
= buffer
->next
)
59 if (!buffer
->used
&& buffer
->size
>= size
)
64 if ((buffer
= malloc(sizeof(_cups_buffer_t
) + size
- 1)) == NULL
)
67 buffer
->next
= cg
->cups_buffers
;
69 cg
->cups_buffers
= buffer
;
79 * '_cupsBufferRelease()' - Release a read/write buffer.
83 _cupsBufferRelease(char *b
) /* I - Buffer to release */
85 _cups_buffer_t
*buffer
; /* Buffer */
89 * Mark this buffer as unused...
92 buffer
= (_cups_buffer_t
*)(b
- offsetof(_cups_buffer_t
, d
));
98 * 'ippAddBoolean()' - Add a boolean attribute to an IPP message.
100 * The @code ipp@ parameter refers to an IPP message previously created using
101 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
103 * The @code group@ parameter specifies the IPP attribute group tag: none
104 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
105 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
106 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
107 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
110 ipp_attribute_t
* /* O - New attribute */
111 ippAddBoolean(ipp_t
*ipp
, /* I - IPP message */
112 ipp_tag_t group
, /* I - IPP group */
113 const char *name
, /* I - Name of attribute */
114 char value
) /* I - Value of attribute */
116 ipp_attribute_t
*attr
; /* New attribute */
119 DEBUG_printf(("ippAddBoolean(ipp=%p, group=%02x(%s), name=\"%s\", value=%d)", (void *)ipp
, group
, ippTagString(group
), name
, value
));
122 * Range check input...
125 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
126 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
)
130 * Create the attribute...
133 if ((attr
= ipp_add_attr(ipp
, name
, group
, IPP_TAG_BOOLEAN
, 1)) == NULL
)
136 attr
->values
[0].boolean
= value
;
143 * 'ippAddBooleans()' - Add an array of boolean values.
145 * The @code ipp@ parameter refers to an IPP message previously created using
146 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
148 * The @code group@ parameter specifies the IPP attribute group tag: none
149 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
150 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
151 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
152 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
155 ipp_attribute_t
* /* O - New attribute */
156 ippAddBooleans(ipp_t
*ipp
, /* I - IPP message */
157 ipp_tag_t group
, /* I - IPP group */
158 const char *name
, /* I - Name of attribute */
159 int num_values
, /* I - Number of values */
160 const char *values
) /* I - Values */
162 int i
; /* Looping var */
163 ipp_attribute_t
*attr
; /* New attribute */
164 _ipp_value_t
*value
; /* Current value */
167 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
));
170 * Range check input...
173 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
174 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
||
179 * Create the attribute...
182 if ((attr
= ipp_add_attr(ipp
, name
, group
, IPP_TAG_BOOLEAN
, num_values
)) == NULL
)
187 for (i
= num_values
, value
= attr
->values
;
190 value
->boolean
= *values
++;
198 * 'ippAddCollection()' - Add a collection value.
200 * The @code ipp@ parameter refers to an IPP message previously created using
201 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
203 * The @code group@ parameter specifies the IPP attribute group tag: none
204 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
205 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
206 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
207 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
209 * @since CUPS 1.1.19/macOS 10.3@
212 ipp_attribute_t
* /* O - New attribute */
213 ippAddCollection(ipp_t
*ipp
, /* I - IPP message */
214 ipp_tag_t group
, /* I - IPP group */
215 const char *name
, /* I - Name of attribute */
216 ipp_t
*value
) /* I - Value */
218 ipp_attribute_t
*attr
; /* New attribute */
221 DEBUG_printf(("ippAddCollection(ipp=%p, group=%02x(%s), name=\"%s\", value=%p)", (void *)ipp
, group
, ippTagString(group
), name
, (void *)value
));
224 * Range check input...
227 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
228 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
)
232 * Create the attribute...
235 if ((attr
= ipp_add_attr(ipp
, name
, group
, IPP_TAG_BEGIN_COLLECTION
, 1)) == NULL
)
238 attr
->values
[0].collection
= value
;
248 * 'ippAddCollections()' - Add an array of collection values.
250 * The @code ipp@ parameter refers to an IPP message previously created using
251 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
253 * The @code group@ parameter specifies the IPP attribute group tag: none
254 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
255 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
256 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
257 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
259 * @since CUPS 1.1.19/macOS 10.3@
262 ipp_attribute_t
* /* O - New attribute */
264 ipp_t
*ipp
, /* I - IPP message */
265 ipp_tag_t group
, /* I - IPP group */
266 const char *name
, /* I - Name of attribute */
267 int num_values
, /* I - Number of values */
268 const ipp_t
**values
) /* I - Values */
270 int i
; /* Looping var */
271 ipp_attribute_t
*attr
; /* New attribute */
272 _ipp_value_t
*value
; /* Current value */
275 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
));
278 * Range check input...
281 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
282 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
||
287 * Create the attribute...
290 if ((attr
= ipp_add_attr(ipp
, name
, group
, IPP_TAG_BEGIN_COLLECTION
,
291 num_values
)) == NULL
)
296 for (i
= num_values
, value
= attr
->values
;
300 value
->collection
= (ipp_t
*)*values
++;
301 value
->collection
->use
++;
310 * 'ippAddDate()' - Add a dateTime attribute to an IPP message.
312 * The @code ipp@ parameter refers to an IPP message previously created using
313 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
315 * The @code group@ parameter specifies the IPP attribute group tag: none
316 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
317 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
318 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
319 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
322 ipp_attribute_t
* /* O - New attribute */
323 ippAddDate(ipp_t
*ipp
, /* I - IPP message */
324 ipp_tag_t group
, /* I - IPP group */
325 const char *name
, /* I - Name of attribute */
326 const ipp_uchar_t
*value
) /* I - Value */
328 ipp_attribute_t
*attr
; /* New attribute */
331 DEBUG_printf(("ippAddDate(ipp=%p, group=%02x(%s), name=\"%s\", value=%p)", (void *)ipp
, group
, ippTagString(group
), name
, (void *)value
));
334 * Range check input...
337 if (!ipp
|| !name
|| !value
|| group
< IPP_TAG_ZERO
||
338 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
)
342 * Create the attribute...
345 if ((attr
= ipp_add_attr(ipp
, name
, group
, IPP_TAG_DATE
, 1)) == NULL
)
348 memcpy(attr
->values
[0].date
, value
, 11);
355 * 'ippAddInteger()' - Add a integer attribute to an IPP message.
357 * The @code ipp@ parameter refers to an IPP message previously created using
358 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
360 * The @code group@ parameter specifies the IPP attribute group tag: none
361 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
362 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
363 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
364 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
366 * Supported values include enum (@code IPP_TAG_ENUM@) and integer
367 * (@code IPP_TAG_INTEGER@).
370 ipp_attribute_t
* /* O - New attribute */
371 ippAddInteger(ipp_t
*ipp
, /* I - IPP message */
372 ipp_tag_t group
, /* I - IPP group */
373 ipp_tag_t value_tag
, /* I - Type of attribute */
374 const char *name
, /* I - Name of attribute */
375 int value
) /* I - Value of attribute */
377 ipp_attribute_t
*attr
; /* New attribute */
380 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
));
382 value_tag
&= IPP_TAG_CUPS_MASK
;
385 * Special-case for legacy usage: map out-of-band attributes to new ippAddOutOfBand
389 if (value_tag
>= IPP_TAG_UNSUPPORTED_VALUE
&& value_tag
<= IPP_TAG_ADMINDEFINE
)
390 return (ippAddOutOfBand(ipp
, group
, value_tag
, name
));
393 * Range check input...
397 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
398 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
||
399 (value_tag
!= IPP_TAG_INTEGER
&& value_tag
!= IPP_TAG_ENUM
))
402 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
403 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
)
408 * Create the attribute...
411 if ((attr
= ipp_add_attr(ipp
, name
, group
, value_tag
, 1)) == NULL
)
414 attr
->values
[0].integer
= value
;
421 * 'ippAddIntegers()' - Add an array of integer values.
423 * The @code ipp@ parameter refers to an IPP message previously created using
424 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
426 * The @code group@ parameter specifies the IPP attribute group tag: none
427 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
428 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
429 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
430 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
432 * Supported values include enum (@code IPP_TAG_ENUM@) and integer
433 * (@code IPP_TAG_INTEGER@).
436 ipp_attribute_t
* /* O - New attribute */
437 ippAddIntegers(ipp_t
*ipp
, /* I - IPP message */
438 ipp_tag_t group
, /* I - IPP group */
439 ipp_tag_t value_tag
, /* I - Type of attribute */
440 const char *name
, /* I - Name of attribute */
441 int num_values
, /* I - Number of values */
442 const int *values
) /* I - Values */
444 int i
; /* Looping var */
445 ipp_attribute_t
*attr
; /* New attribute */
446 _ipp_value_t
*value
; /* Current value */
449 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
));
451 value_tag
&= IPP_TAG_CUPS_MASK
;
454 * Range check input...
458 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
459 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
||
460 (value_tag
!= IPP_TAG_INTEGER
&& value_tag
!= IPP_TAG_ENUM
) ||
464 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
465 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
||
471 * Create the attribute...
474 if ((attr
= ipp_add_attr(ipp
, name
, group
, value_tag
, num_values
)) == NULL
)
479 for (i
= num_values
, value
= attr
->values
;
482 value
->integer
= *values
++;
490 * 'ippAddOctetString()' - Add an octetString value to an IPP message.
492 * The @code ipp@ parameter refers to an IPP message previously created using
493 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
495 * The @code group@ parameter specifies the IPP attribute group tag: none
496 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
497 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
498 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
499 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
501 * @since CUPS 1.2/macOS 10.5@
504 ipp_attribute_t
* /* O - New attribute */
505 ippAddOctetString(ipp_t
*ipp
, /* I - IPP message */
506 ipp_tag_t group
, /* I - IPP group */
507 const char *name
, /* I - Name of attribute */
508 const void *data
, /* I - octetString data */
509 int datalen
) /* I - Length of data in bytes */
511 ipp_attribute_t
*attr
; /* New attribute */
514 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
515 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
||
516 datalen
< 0 || datalen
> IPP_MAX_LENGTH
)
519 if ((attr
= ipp_add_attr(ipp
, name
, group
, IPP_TAG_STRING
, 1)) == NULL
)
523 * Initialize the attribute data...
526 attr
->values
[0].unknown
.length
= datalen
;
530 if ((attr
->values
[0].unknown
.data
= malloc((size_t)datalen
)) == NULL
)
532 ippDeleteAttribute(ipp
, attr
);
536 memcpy(attr
->values
[0].unknown
.data
, data
, (size_t)datalen
);
540 * Return the new attribute...
548 * 'ippAddOutOfBand()' - Add an out-of-band value to an IPP message.
550 * The @code ipp@ parameter refers to an IPP message previously created using
551 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
553 * The @code group@ parameter specifies the IPP attribute group tag: none
554 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
555 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
556 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
557 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
559 * Supported out-of-band values include unsupported-value
560 * (@code IPP_TAG_UNSUPPORTED_VALUE@), default (@code IPP_TAG_DEFAULT@), unknown
561 * (@code IPP_TAG_UNKNOWN@), no-value (@code IPP_TAG_NOVALUE@), not-settable
562 * (@code IPP_TAG_NOTSETTABLE@), delete-attribute (@code IPP_TAG_DELETEATTR@), and
563 * admin-define (@code IPP_TAG_ADMINDEFINE@).
565 * @since CUPS 1.6/macOS 10.8@
568 ipp_attribute_t
* /* O - New attribute */
569 ippAddOutOfBand(ipp_t
*ipp
, /* I - IPP message */
570 ipp_tag_t group
, /* I - IPP group */
571 ipp_tag_t value_tag
, /* I - Type of attribute */
572 const char *name
) /* I - Name of attribute */
574 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
));
576 value_tag
&= IPP_TAG_CUPS_MASK
;
579 * Range check input...
582 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
583 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
||
584 (value_tag
!= IPP_TAG_UNSUPPORTED_VALUE
&&
585 value_tag
!= IPP_TAG_DEFAULT
&&
586 value_tag
!= IPP_TAG_UNKNOWN
&&
587 value_tag
!= IPP_TAG_NOVALUE
&&
588 value_tag
!= IPP_TAG_NOTSETTABLE
&&
589 value_tag
!= IPP_TAG_DELETEATTR
&&
590 value_tag
!= IPP_TAG_ADMINDEFINE
))
594 * Create the attribute...
597 return (ipp_add_attr(ipp
, name
, group
, value_tag
, 1));
602 * 'ippAddRange()' - Add a range of values to an IPP message.
604 * The @code ipp@ parameter refers to an IPP message previously created using
605 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
607 * The @code group@ parameter specifies the IPP attribute group tag: none
608 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
609 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
610 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
611 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
613 * The @code lower@ parameter must be less than or equal to the @code upper@ parameter.
616 ipp_attribute_t
* /* O - New attribute */
617 ippAddRange(ipp_t
*ipp
, /* I - IPP message */
618 ipp_tag_t group
, /* I - IPP group */
619 const char *name
, /* I - Name of attribute */
620 int lower
, /* I - Lower value */
621 int upper
) /* I - Upper value */
623 ipp_attribute_t
*attr
; /* New attribute */
626 DEBUG_printf(("ippAddRange(ipp=%p, group=%02x(%s), name=\"%s\", lower=%d, upper=%d)", (void *)ipp
, group
, ippTagString(group
), name
, lower
, upper
));
629 * Range check input...
632 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
633 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
)
637 * Create the attribute...
640 if ((attr
= ipp_add_attr(ipp
, name
, group
, IPP_TAG_RANGE
, 1)) == NULL
)
643 attr
->values
[0].range
.lower
= lower
;
644 attr
->values
[0].range
.upper
= upper
;
651 * 'ippAddRanges()' - Add ranges of values to an IPP message.
653 * The @code ipp@ parameter refers to an IPP message previously created using
654 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
656 * The @code group@ parameter specifies the IPP attribute group tag: none
657 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
658 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
659 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
660 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
663 ipp_attribute_t
* /* O - New attribute */
664 ippAddRanges(ipp_t
*ipp
, /* I - IPP message */
665 ipp_tag_t group
, /* I - IPP group */
666 const char *name
, /* I - Name of attribute */
667 int num_values
, /* I - Number of values */
668 const int *lower
, /* I - Lower values */
669 const int *upper
) /* I - Upper values */
671 int i
; /* Looping var */
672 ipp_attribute_t
*attr
; /* New attribute */
673 _ipp_value_t
*value
; /* Current value */
676 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
));
679 * Range check input...
682 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
683 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
||
688 * Create the attribute...
691 if ((attr
= ipp_add_attr(ipp
, name
, group
, IPP_TAG_RANGE
, num_values
)) == NULL
)
696 for (i
= num_values
, value
= attr
->values
;
700 value
->range
.lower
= *lower
++;
701 value
->range
.upper
= *upper
++;
710 * 'ippAddResolution()' - Add a resolution value to an IPP message.
712 * The @code ipp@ parameter refers to an IPP message previously created using
713 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
715 * The @code group@ parameter specifies the IPP attribute group tag: none
716 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
717 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
718 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
719 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
722 ipp_attribute_t
* /* O - New attribute */
723 ippAddResolution(ipp_t
*ipp
, /* I - IPP message */
724 ipp_tag_t group
, /* I - IPP group */
725 const char *name
, /* I - Name of attribute */
726 ipp_res_t units
, /* I - Units for resolution */
727 int xres
, /* I - X resolution */
728 int yres
) /* I - Y resolution */
730 ipp_attribute_t
*attr
; /* New attribute */
733 DEBUG_printf(("ippAddResolution(ipp=%p, group=%02x(%s), name=\"%s\", units=%d, xres=%d, yres=%d)", (void *)ipp
, group
,
734 ippTagString(group
), name
, units
, xres
, yres
));
737 * Range check input...
740 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
741 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
||
742 units
< IPP_RES_PER_INCH
|| units
> IPP_RES_PER_CM
||
743 xres
< 0 || yres
< 0)
747 * Create the attribute...
750 if ((attr
= ipp_add_attr(ipp
, name
, group
, IPP_TAG_RESOLUTION
, 1)) == NULL
)
753 attr
->values
[0].resolution
.xres
= xres
;
754 attr
->values
[0].resolution
.yres
= yres
;
755 attr
->values
[0].resolution
.units
= units
;
762 * 'ippAddResolutions()' - Add resolution values to an IPP message.
764 * The @code ipp@ parameter refers to an IPP message previously created using
765 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
767 * The @code group@ parameter specifies the IPP attribute group tag: none
768 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
769 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
770 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
771 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
774 ipp_attribute_t
* /* O - New attribute */
775 ippAddResolutions(ipp_t
*ipp
, /* I - IPP message */
776 ipp_tag_t group
, /* I - IPP group */
777 const char *name
, /* I - Name of attribute */
778 int num_values
,/* I - Number of values */
779 ipp_res_t units
, /* I - Units for resolution */
780 const int *xres
, /* I - X resolutions */
781 const int *yres
) /* I - Y resolutions */
783 int i
; /* Looping var */
784 ipp_attribute_t
*attr
; /* New attribute */
785 _ipp_value_t
*value
; /* Current value */
788 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
));
791 * Range check input...
794 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
795 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
||
797 units
< IPP_RES_PER_INCH
|| units
> IPP_RES_PER_CM
)
801 * Create the attribute...
804 if ((attr
= ipp_add_attr(ipp
, name
, group
, IPP_TAG_RESOLUTION
, num_values
)) == NULL
)
809 for (i
= num_values
, value
= attr
->values
;
813 value
->resolution
.xres
= *xres
++;
814 value
->resolution
.yres
= *yres
++;
815 value
->resolution
.units
= units
;
824 * 'ippAddSeparator()' - Add a group separator to an IPP message.
826 * The @code ipp@ parameter refers to an IPP message previously created using
827 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
830 ipp_attribute_t
* /* O - New attribute */
831 ippAddSeparator(ipp_t
*ipp
) /* I - IPP message */
833 DEBUG_printf(("ippAddSeparator(ipp=%p)", (void *)ipp
));
836 * Range check input...
843 * Create the attribute...
846 return (ipp_add_attr(ipp
, NULL
, IPP_TAG_ZERO
, IPP_TAG_ZERO
, 0));
851 * 'ippAddString()' - Add a language-encoded string to an IPP message.
853 * The @code ipp@ parameter refers to an IPP message previously created using
854 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
856 * The @code group@ parameter specifies the IPP attribute group tag: none
857 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
858 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
859 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
860 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
862 * Supported string values include charset (@code IPP_TAG_CHARSET@), keyword
863 * (@code IPP_TAG_KEYWORD@), language (@code IPP_TAG_LANGUAGE@), mimeMediaType
864 * (@code IPP_TAG_MIMETYPE@), name (@code IPP_TAG_NAME@), nameWithLanguage
865 * (@code IPP_TAG_NAMELANG), text (@code IPP_TAG_TEXT@), textWithLanguage
866 * (@code IPP_TAG_TEXTLANG@), uri (@code IPP_TAG_URI@), and uriScheme
867 * (@code IPP_TAG_URISCHEME@).
869 * The @code language@ parameter must be non-@code NULL@ for nameWithLanguage and
870 * textWithLanguage string values and must be @code NULL@ for all other string values.
873 ipp_attribute_t
* /* O - New attribute */
874 ippAddString(ipp_t
*ipp
, /* I - IPP message */
875 ipp_tag_t group
, /* I - IPP group */
876 ipp_tag_t value_tag
, /* I - Type of attribute */
877 const char *name
, /* I - Name of attribute */
878 const char *language
, /* I - Language code */
879 const char *value
) /* I - Value */
881 ipp_tag_t temp_tag
; /* Temporary value tag (masked) */
882 ipp_attribute_t
*attr
; /* New attribute */
883 char code
[IPP_MAX_LANGUAGE
];
884 /* Charset/language code buffer */
887 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
));
890 * Range check input...
893 temp_tag
= (ipp_tag_t
)((int)value_tag
& IPP_TAG_CUPS_MASK
);
896 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
897 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
||
898 (temp_tag
< IPP_TAG_TEXT
&& temp_tag
!= IPP_TAG_TEXTLANG
&&
899 temp_tag
!= IPP_TAG_NAMELANG
) || temp_tag
> IPP_TAG_MIMETYPE
)
902 if ((temp_tag
== IPP_TAG_TEXTLANG
|| temp_tag
== IPP_TAG_NAMELANG
)
903 != (language
!= NULL
))
906 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
907 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
)
912 * See if we need to map charset, language, or locale values...
915 if (language
&& ((int)value_tag
& IPP_TAG_CUPS_CONST
) &&
916 strcmp(language
, ipp_lang_code(language
, code
, sizeof(code
))))
917 value_tag
= temp_tag
; /* Don't do a fast copy */
918 else if (value
&& value_tag
== (ipp_tag_t
)(IPP_TAG_CHARSET
| IPP_TAG_CUPS_CONST
) &&
919 strcmp(value
, ipp_get_code(value
, code
, sizeof(code
))))
920 value_tag
= temp_tag
; /* Don't do a fast copy */
921 else if (value
&& value_tag
== (ipp_tag_t
)(IPP_TAG_LANGUAGE
| IPP_TAG_CUPS_CONST
) &&
922 strcmp(value
, ipp_lang_code(value
, code
, sizeof(code
))))
923 value_tag
= temp_tag
; /* Don't do a fast copy */
926 * Create the attribute...
929 if ((attr
= ipp_add_attr(ipp
, name
, group
, value_tag
, 1)) == NULL
)
933 * Initialize the attribute data...
936 if ((int)value_tag
& IPP_TAG_CUPS_CONST
)
938 attr
->values
[0].string
.language
= (char *)language
;
939 attr
->values
[0].string
.text
= (char *)value
;
944 attr
->values
[0].string
.language
= _cupsStrAlloc(ipp_lang_code(language
, code
,
949 if (value_tag
== IPP_TAG_CHARSET
)
950 attr
->values
[0].string
.text
= _cupsStrAlloc(ipp_get_code(value
, code
,
952 else if (value_tag
== IPP_TAG_LANGUAGE
)
953 attr
->values
[0].string
.text
= _cupsStrAlloc(ipp_lang_code(value
, code
,
956 attr
->values
[0].string
.text
= _cupsStrAlloc(value
);
965 * 'ippAddStringf()' - Add a formatted string to an IPP message.
967 * The @code ipp@ parameter refers to an IPP message previously created using
968 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
970 * The @code group@ parameter specifies the IPP attribute group tag: none
971 * (@code IPP_TAG_ZERO@, for member attributes), document
972 * (@code IPP_TAG_DOCUMENT@), event notification
973 * (@code IPP_TAG_EVENT_NOTIFICATION@), operation (@code IPP_TAG_OPERATION@),
974 * printer (@code IPP_TAG_PRINTER@), subscription (@code IPP_TAG_SUBSCRIPTION@),
975 * or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
977 * Supported string values include charset (@code IPP_TAG_CHARSET@), keyword
978 * (@code IPP_TAG_KEYWORD@), language (@code IPP_TAG_LANGUAGE@), mimeMediaType
979 * (@code IPP_TAG_MIMETYPE@), name (@code IPP_TAG_NAME@), nameWithLanguage
980 * (@code IPP_TAG_NAMELANG), text (@code IPP_TAG_TEXT@), textWithLanguage
981 * (@code IPP_TAG_TEXTLANG@), uri (@code IPP_TAG_URI@), and uriScheme
982 * (@code IPP_TAG_URISCHEME@).
984 * The @code language@ parameter must be non-@code NULL@ for nameWithLanguage
985 * and textWithLanguage string values and must be @code NULL@ for all other
988 * The @code format@ parameter uses formatting characters compatible with the
989 * printf family of standard functions. Additional arguments follow it as
990 * needed. The formatted string is truncated as needed to the maximum length of
991 * the corresponding value type.
993 * @since CUPS 1.7/macOS 10.9@
996 ipp_attribute_t
* /* O - New attribute */
997 ippAddStringf(ipp_t
*ipp
, /* I - IPP message */
998 ipp_tag_t group
, /* I - IPP group */
999 ipp_tag_t value_tag
, /* I - Type of attribute */
1000 const char *name
, /* I - Name of attribute */
1001 const char *language
, /* I - Language code (@code NULL@ for default) */
1002 const char *format
, /* I - Printf-style format string */
1003 ...) /* I - Additional arguments as needed */
1005 ipp_attribute_t
*attr
; /* New attribute */
1006 va_list ap
; /* Argument pointer */
1009 va_start(ap
, format
);
1010 attr
= ippAddStringfv(ipp
, group
, value_tag
, name
, language
, format
, ap
);
1018 * 'ippAddStringfv()' - Add a formatted string to an IPP message.
1020 * The @code ipp@ parameter refers to an IPP message previously created using
1021 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
1023 * The @code group@ parameter specifies the IPP attribute group tag: none
1024 * (@code IPP_TAG_ZERO@, for member attributes), document
1025 * (@code IPP_TAG_DOCUMENT@), event notification
1026 * (@code IPP_TAG_EVENT_NOTIFICATION@), operation (@code IPP_TAG_OPERATION@),
1027 * printer (@code IPP_TAG_PRINTER@), subscription (@code IPP_TAG_SUBSCRIPTION@),
1028 * or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
1030 * Supported string values include charset (@code IPP_TAG_CHARSET@), keyword
1031 * (@code IPP_TAG_KEYWORD@), language (@code IPP_TAG_LANGUAGE@), mimeMediaType
1032 * (@code IPP_TAG_MIMETYPE@), name (@code IPP_TAG_NAME@), nameWithLanguage
1033 * (@code IPP_TAG_NAMELANG), text (@code IPP_TAG_TEXT@), textWithLanguage
1034 * (@code IPP_TAG_TEXTLANG@), uri (@code IPP_TAG_URI@), and uriScheme
1035 * (@code IPP_TAG_URISCHEME@).
1037 * The @code language@ parameter must be non-@code NULL@ for nameWithLanguage
1038 * and textWithLanguage string values and must be @code NULL@ for all other
1041 * The @code format@ parameter uses formatting characters compatible with the
1042 * printf family of standard functions. Additional arguments are passed in the
1043 * stdarg pointer @code ap@. The formatted string is truncated as needed to the
1044 * maximum length of the corresponding value type.
1046 * @since CUPS 1.7/macOS 10.9@
1049 ipp_attribute_t
* /* O - New attribute */
1050 ippAddStringfv(ipp_t
*ipp
, /* I - IPP message */
1051 ipp_tag_t group
, /* I - IPP group */
1052 ipp_tag_t value_tag
, /* I - Type of attribute */
1053 const char *name
, /* I - Name of attribute */
1054 const char *language
, /* I - Language code (@code NULL@ for default) */
1055 const char *format
, /* I - Printf-style format string */
1056 va_list ap
) /* I - Additional arguments */
1058 char buffer
[IPP_MAX_TEXT
+ 4];
1059 /* Formatted text string */
1060 ssize_t bytes
, /* Length of formatted value */
1061 max_bytes
; /* Maximum number of bytes for value */
1065 * Range check input...
1068 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
1069 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
||
1070 (value_tag
< IPP_TAG_TEXT
&& value_tag
!= IPP_TAG_TEXTLANG
&&
1071 value_tag
!= IPP_TAG_NAMELANG
) || value_tag
> IPP_TAG_MIMETYPE
||
1075 if ((value_tag
== IPP_TAG_TEXTLANG
|| value_tag
== IPP_TAG_NAMELANG
)
1076 != (language
!= NULL
))
1080 * Format the string...
1083 if (!strcmp(format
, "%s"))
1086 * Optimize the simple case...
1089 const char *s
= va_arg(ap
, char *);
1094 bytes
= (ssize_t
)strlen(s
);
1095 strlcpy(buffer
, s
, sizeof(buffer
));
1100 * Do a full formatting of the message...
1103 if ((bytes
= vsnprintf(buffer
, sizeof(buffer
), format
, ap
)) < 0)
1108 * Limit the length of the string...
1115 case IPP_TAG_TEXTLANG
:
1116 max_bytes
= IPP_MAX_TEXT
;
1120 case IPP_TAG_NAMELANG
:
1121 max_bytes
= IPP_MAX_NAME
;
1124 case IPP_TAG_CHARSET
:
1125 max_bytes
= IPP_MAX_CHARSET
;
1128 case IPP_TAG_KEYWORD
:
1129 max_bytes
= IPP_MAX_KEYWORD
;
1132 case IPP_TAG_LANGUAGE
:
1133 max_bytes
= IPP_MAX_LANGUAGE
;
1136 case IPP_TAG_MIMETYPE
:
1137 max_bytes
= IPP_MAX_MIMETYPE
;
1141 max_bytes
= IPP_MAX_URI
;
1144 case IPP_TAG_URISCHEME
:
1145 max_bytes
= IPP_MAX_URISCHEME
;
1149 if (bytes
>= max_bytes
)
1151 char *bufmax
, /* Buffer at max_bytes */
1152 *bufptr
; /* Pointer into buffer */
1154 bufptr
= buffer
+ strlen(buffer
) - 1;
1155 bufmax
= buffer
+ max_bytes
- 1;
1157 while (bufptr
> bufmax
)
1161 while ((*bufptr
& 0xc0) == 0x80 && bufptr
> buffer
)
1172 * Add the formatted string and return...
1175 return (ippAddString(ipp
, group
, value_tag
, name
, language
, buffer
));
1180 * 'ippAddStrings()' - Add language-encoded strings to an IPP message.
1182 * The @code ipp@ parameter refers to an IPP message previously created using
1183 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
1185 * The @code group@ parameter specifies the IPP attribute group tag: none
1186 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
1187 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
1188 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
1189 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
1191 * Supported string values include charset (@code IPP_TAG_CHARSET@), keyword
1192 * (@code IPP_TAG_KEYWORD@), language (@code IPP_TAG_LANGUAGE@), mimeMediaType
1193 * (@code IPP_TAG_MIMETYPE@), name (@code IPP_TAG_NAME@), nameWithLanguage
1194 * (@code IPP_TAG_NAMELANG), text (@code IPP_TAG_TEXT@), textWithLanguage
1195 * (@code IPP_TAG_TEXTLANG@), uri (@code IPP_TAG_URI@), and uriScheme
1196 * (@code IPP_TAG_URISCHEME@).
1198 * The @code language@ parameter must be non-@code NULL@ for nameWithLanguage and
1199 * textWithLanguage string values and must be @code NULL@ for all other string values.
1202 ipp_attribute_t
* /* O - New attribute */
1204 ipp_t
*ipp
, /* I - IPP message */
1205 ipp_tag_t group
, /* I - IPP group */
1206 ipp_tag_t value_tag
, /* I - Type of attribute */
1207 const char *name
, /* I - Name of attribute */
1208 int num_values
, /* I - Number of values */
1209 const char *language
, /* I - Language code (@code NULL@ for default) */
1210 const char * const *values
) /* I - Values */
1212 int i
; /* Looping var */
1213 ipp_tag_t temp_tag
; /* Temporary value tag (masked) */
1214 ipp_attribute_t
*attr
; /* New attribute */
1215 _ipp_value_t
*value
; /* Current value */
1216 char code
[32]; /* Language/charset value buffer */
1219 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
));
1222 * Range check input...
1225 temp_tag
= (ipp_tag_t
)((int)value_tag
& IPP_TAG_CUPS_MASK
);
1228 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
1229 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
||
1230 (temp_tag
< IPP_TAG_TEXT
&& temp_tag
!= IPP_TAG_TEXTLANG
&&
1231 temp_tag
!= IPP_TAG_NAMELANG
) || temp_tag
> IPP_TAG_MIMETYPE
||
1235 if ((temp_tag
== IPP_TAG_TEXTLANG
|| temp_tag
== IPP_TAG_NAMELANG
)
1236 != (language
!= NULL
))
1239 if (!ipp
|| !name
|| group
< IPP_TAG_ZERO
||
1240 group
== IPP_TAG_END
|| group
>= IPP_TAG_UNSUPPORTED_VALUE
||
1246 * See if we need to map charset, language, or locale values...
1249 if (language
&& ((int)value_tag
& IPP_TAG_CUPS_CONST
) &&
1250 strcmp(language
, ipp_lang_code(language
, code
, sizeof(code
))))
1251 value_tag
= temp_tag
; /* Don't do a fast copy */
1252 else if (values
&& value_tag
== (ipp_tag_t
)(IPP_TAG_CHARSET
| IPP_TAG_CUPS_CONST
))
1254 for (i
= 0; i
< num_values
; i
++)
1255 if (strcmp(values
[i
], ipp_get_code(values
[i
], code
, sizeof(code
))))
1257 value_tag
= temp_tag
; /* Don't do a fast copy */
1261 else if (values
&& value_tag
== (ipp_tag_t
)(IPP_TAG_LANGUAGE
| IPP_TAG_CUPS_CONST
))
1263 for (i
= 0; i
< num_values
; i
++)
1264 if (strcmp(values
[i
], ipp_lang_code(values
[i
], code
, sizeof(code
))))
1266 value_tag
= temp_tag
; /* Don't do a fast copy */
1272 * Create the attribute...
1275 if ((attr
= ipp_add_attr(ipp
, name
, group
, value_tag
, num_values
)) == NULL
)
1279 * Initialize the attribute data...
1282 for (i
= num_values
, value
= attr
->values
;
1288 if (value
== attr
->values
)
1290 if ((int)value_tag
& IPP_TAG_CUPS_CONST
)
1291 value
->string
.language
= (char *)language
;
1293 value
->string
.language
= _cupsStrAlloc(ipp_lang_code(language
, code
,
1297 value
->string
.language
= attr
->values
[0].string
.language
;
1302 if ((int)value_tag
& IPP_TAG_CUPS_CONST
)
1303 value
->string
.text
= (char *)*values
++;
1304 else if (value_tag
== IPP_TAG_CHARSET
)
1305 value
->string
.text
= _cupsStrAlloc(ipp_get_code(*values
++, code
, sizeof(code
)));
1306 else if (value_tag
== IPP_TAG_LANGUAGE
)
1307 value
->string
.text
= _cupsStrAlloc(ipp_lang_code(*values
++, code
, sizeof(code
)));
1309 value
->string
.text
= _cupsStrAlloc(*values
++);
1318 * 'ippContainsInteger()' - Determine whether an attribute contains the
1319 * specified value or is within the list of ranges.
1321 * Returns non-zero when the attribute contains either a matching integer or
1322 * enum value, or the value falls within one of the rangeOfInteger values for
1325 * @since CUPS 1.7/macOS 10.9@
1328 int /* O - 1 on a match, 0 on no match */
1330 ipp_attribute_t
*attr
, /* I - Attribute */
1331 int value
) /* I - Integer/enum value */
1333 int i
; /* Looping var */
1334 _ipp_value_t
*avalue
; /* Current attribute value */
1338 * Range check input...
1344 if (attr
->value_tag
!= IPP_TAG_INTEGER
&& attr
->value_tag
!= IPP_TAG_ENUM
&&
1345 attr
->value_tag
!= IPP_TAG_RANGE
)
1352 if (attr
->value_tag
== IPP_TAG_RANGE
)
1354 for (i
= attr
->num_values
, avalue
= attr
->values
; i
> 0; i
--, avalue
++)
1355 if (value
>= avalue
->range
.lower
&& value
<= avalue
->range
.upper
)
1360 for (i
= attr
->num_values
, avalue
= attr
->values
; i
> 0; i
--, avalue
++)
1361 if (value
== avalue
->integer
)
1370 * 'ippContainsString()' - Determine whether an attribute contains the
1371 * specified string value.
1373 * Returns non-zero when the attribute contains a matching charset, keyword,
1374 * naturalLanguage, mimeMediaType, name, text, uri, or uriScheme value.
1376 * @since CUPS 1.7/macOS 10.9@
1379 int /* O - 1 on a match, 0 on no match */
1381 ipp_attribute_t
*attr
, /* I - Attribute */
1382 const char *value
) /* I - String value */
1384 int i
; /* Looping var */
1385 _ipp_value_t
*avalue
; /* Current attribute value */
1388 DEBUG_printf(("ippContainsString(attr=%p, value=\"%s\")", (void *)attr
, value
));
1391 * Range check input...
1394 if (!attr
|| !value
)
1396 DEBUG_puts("1ippContainsString: Returning 0 (bad input)");
1404 DEBUG_printf(("1ippContainsString: attr %s, %s with %d values.",
1405 attr
->name
, ippTagString(attr
->value_tag
),
1408 switch (attr
->value_tag
& IPP_TAG_CUPS_MASK
)
1410 case IPP_TAG_CHARSET
:
1411 case IPP_TAG_KEYWORD
:
1412 case IPP_TAG_LANGUAGE
:
1414 case IPP_TAG_URISCHEME
:
1415 for (i
= attr
->num_values
, avalue
= attr
->values
;
1419 DEBUG_printf(("1ippContainsString: value[%d]=\"%s\"",
1420 attr
->num_values
- i
, avalue
->string
.text
));
1422 if (!strcmp(value
, avalue
->string
.text
))
1424 DEBUG_puts("1ippContainsString: Returning 1 (match)");
1429 case IPP_TAG_MIMETYPE
:
1431 case IPP_TAG_NAMELANG
:
1433 case IPP_TAG_TEXTLANG
:
1434 for (i
= attr
->num_values
, avalue
= attr
->values
;
1438 DEBUG_printf(("1ippContainsString: value[%d]=\"%s\"",
1439 attr
->num_values
- i
, avalue
->string
.text
));
1441 if (!_cups_strcasecmp(value
, avalue
->string
.text
))
1443 DEBUG_puts("1ippContainsString: Returning 1 (match)");
1452 DEBUG_puts("1ippContainsString: Returning 0 (no match)");
1459 * 'ippCopyAttribute()' - Copy an attribute.
1461 * The specified attribute, @code attr@, is copied to the destination IPP message.
1462 * When @code quickcopy@ is non-zero, a "shallow" reference copy of the attribute is
1463 * created - this should only be done as long as the original source IPP message will
1464 * not be freed for the life of the destination.
1466 * @since CUPS 1.6/macOS 10.8@
1470 ipp_attribute_t
* /* O - New attribute */
1472 ipp_t
*dst
, /* I - Destination IPP message */
1473 ipp_attribute_t
*srcattr
, /* I - Attribute to copy */
1474 int quickcopy
) /* I - 1 for a referenced copy, 0 for normal */
1476 int i
; /* Looping var */
1477 ipp_attribute_t
*dstattr
; /* Destination attribute */
1478 _ipp_value_t
*srcval
, /* Source value */
1479 *dstval
; /* Destination value */
1482 DEBUG_printf(("ippCopyAttribute(dst=%p, srcattr=%p, quickcopy=%d)", (void *)dst
, (void *)srcattr
, quickcopy
));
1485 * Range check input...
1488 if (!dst
|| !srcattr
)
1495 quickcopy
= quickcopy
? IPP_TAG_CUPS_CONST
: 0;
1497 switch (srcattr
->value_tag
& ~IPP_TAG_CUPS_CONST
)
1500 dstattr
= ippAddSeparator(dst
);
1503 case IPP_TAG_UNSUPPORTED_VALUE
:
1504 case IPP_TAG_DEFAULT
:
1505 case IPP_TAG_UNKNOWN
:
1506 case IPP_TAG_NOVALUE
:
1507 case IPP_TAG_NOTSETTABLE
:
1508 case IPP_TAG_DELETEATTR
:
1509 case IPP_TAG_ADMINDEFINE
:
1510 dstattr
= ippAddOutOfBand(dst
, srcattr
->group_tag
, srcattr
->value_tag
& ~IPP_TAG_CUPS_CONST
, srcattr
->name
);
1513 case IPP_TAG_INTEGER
:
1515 dstattr
= ippAddIntegers(dst
, srcattr
->group_tag
, srcattr
->value_tag
,
1516 srcattr
->name
, srcattr
->num_values
, NULL
);
1520 for (i
= srcattr
->num_values
, srcval
= srcattr
->values
, dstval
= dstattr
->values
;
1522 i
--, srcval
++, dstval
++)
1523 dstval
->integer
= srcval
->integer
;
1526 case IPP_TAG_BOOLEAN
:
1527 dstattr
= ippAddBooleans(dst
, srcattr
->group_tag
, srcattr
->name
,
1528 srcattr
->num_values
, NULL
);
1532 for (i
= srcattr
->num_values
, srcval
= srcattr
->values
, dstval
= dstattr
->values
;
1534 i
--, srcval
++, dstval
++)
1535 dstval
->boolean
= srcval
->boolean
;
1540 case IPP_TAG_KEYWORD
:
1542 case IPP_TAG_URISCHEME
:
1543 case IPP_TAG_CHARSET
:
1544 case IPP_TAG_LANGUAGE
:
1545 case IPP_TAG_MIMETYPE
:
1546 dstattr
= ippAddStrings(dst
, srcattr
->group_tag
,
1547 (ipp_tag_t
)(srcattr
->value_tag
| quickcopy
),
1548 srcattr
->name
, srcattr
->num_values
, NULL
, NULL
);
1554 for (i
= srcattr
->num_values
, srcval
= srcattr
->values
,
1555 dstval
= dstattr
->values
;
1557 i
--, srcval
++, dstval
++)
1558 dstval
->string
.text
= srcval
->string
.text
;
1560 else if (srcattr
->value_tag
& IPP_TAG_CUPS_CONST
)
1562 for (i
= srcattr
->num_values
, srcval
= srcattr
->values
,
1563 dstval
= dstattr
->values
;
1565 i
--, srcval
++, dstval
++)
1566 dstval
->string
.text
= _cupsStrAlloc(srcval
->string
.text
);
1570 for (i
= srcattr
->num_values
, srcval
= srcattr
->values
,
1571 dstval
= dstattr
->values
;
1573 i
--, srcval
++, dstval
++)
1574 dstval
->string
.text
= _cupsStrRetain(srcval
->string
.text
);
1579 if (srcattr
->num_values
!= 1)
1582 dstattr
= ippAddDate(dst
, srcattr
->group_tag
, srcattr
->name
,
1583 srcattr
->values
[0].date
);
1586 case IPP_TAG_RESOLUTION
:
1587 dstattr
= ippAddResolutions(dst
, srcattr
->group_tag
, srcattr
->name
,
1588 srcattr
->num_values
, IPP_RES_PER_INCH
,
1593 for (i
= srcattr
->num_values
, srcval
= srcattr
->values
, dstval
= dstattr
->values
;
1595 i
--, srcval
++, dstval
++)
1597 dstval
->resolution
.xres
= srcval
->resolution
.xres
;
1598 dstval
->resolution
.yres
= srcval
->resolution
.yres
;
1599 dstval
->resolution
.units
= srcval
->resolution
.units
;
1603 case IPP_TAG_RANGE
:
1604 dstattr
= ippAddRanges(dst
, srcattr
->group_tag
, srcattr
->name
,
1605 srcattr
->num_values
, NULL
, NULL
);
1609 for (i
= srcattr
->num_values
, srcval
= srcattr
->values
, dstval
= dstattr
->values
;
1611 i
--, srcval
++, dstval
++)
1613 dstval
->range
.lower
= srcval
->range
.lower
;
1614 dstval
->range
.upper
= srcval
->range
.upper
;
1618 case IPP_TAG_TEXTLANG
:
1619 case IPP_TAG_NAMELANG
:
1620 dstattr
= ippAddStrings(dst
, srcattr
->group_tag
,
1621 (ipp_tag_t
)(srcattr
->value_tag
| quickcopy
),
1622 srcattr
->name
, srcattr
->num_values
, NULL
, NULL
);
1628 for (i
= srcattr
->num_values
, srcval
= srcattr
->values
,
1629 dstval
= dstattr
->values
;
1631 i
--, srcval
++, dstval
++)
1633 dstval
->string
.language
= srcval
->string
.language
;
1634 dstval
->string
.text
= srcval
->string
.text
;
1637 else if (srcattr
->value_tag
& IPP_TAG_CUPS_CONST
)
1639 for (i
= srcattr
->num_values
, srcval
= srcattr
->values
,
1640 dstval
= dstattr
->values
;
1642 i
--, srcval
++, dstval
++)
1644 if (srcval
== srcattr
->values
)
1645 dstval
->string
.language
= _cupsStrAlloc(srcval
->string
.language
);
1647 dstval
->string
.language
= dstattr
->values
[0].string
.language
;
1649 dstval
->string
.text
= _cupsStrAlloc(srcval
->string
.text
);
1654 for (i
= srcattr
->num_values
, srcval
= srcattr
->values
,
1655 dstval
= dstattr
->values
;
1657 i
--, srcval
++, dstval
++)
1659 if (srcval
== srcattr
->values
)
1660 dstval
->string
.language
= _cupsStrRetain(srcval
->string
.language
);
1662 dstval
->string
.language
= dstattr
->values
[0].string
.language
;
1664 dstval
->string
.text
= _cupsStrRetain(srcval
->string
.text
);
1669 case IPP_TAG_BEGIN_COLLECTION
:
1670 dstattr
= ippAddCollections(dst
, srcattr
->group_tag
, srcattr
->name
,
1671 srcattr
->num_values
, NULL
);
1675 for (i
= srcattr
->num_values
, srcval
= srcattr
->values
, dstval
= dstattr
->values
;
1677 i
--, srcval
++, dstval
++)
1679 dstval
->collection
= srcval
->collection
;
1680 srcval
->collection
->use
++;
1684 case IPP_TAG_STRING
:
1686 /* TODO: Implement quick copy for unknown/octetString values */
1687 dstattr
= ippAddIntegers(dst
, srcattr
->group_tag
, srcattr
->value_tag
,
1688 srcattr
->name
, srcattr
->num_values
, NULL
);
1692 for (i
= srcattr
->num_values
, srcval
= srcattr
->values
, dstval
= dstattr
->values
;
1694 i
--, srcval
++, dstval
++)
1696 dstval
->unknown
.length
= srcval
->unknown
.length
;
1698 if (dstval
->unknown
.length
> 0)
1700 if ((dstval
->unknown
.data
= malloc((size_t)dstval
->unknown
.length
)) == NULL
)
1701 dstval
->unknown
.length
= 0;
1703 memcpy(dstval
->unknown
.data
, srcval
->unknown
.data
, (size_t)dstval
->unknown
.length
);
1706 break; /* anti-compiler-warning-code */
1714 * 'ippCopyAttributes()' - Copy attributes from one IPP message to another.
1716 * Zero or more attributes are copied from the source IPP message, @code src@, to the
1717 * destination IPP message, @code dst@. When @code quickcopy@ is non-zero, a "shallow"
1718 * reference copy of the attribute is created - this should only be done as long as the
1719 * original source IPP message will not be freed for the life of the destination.
1721 * The @code cb@ and @code context@ parameters provide a generic way to "filter" the
1722 * attributes that are copied - the function must return 1 to copy the attribute or
1723 * 0 to skip it. The function may also choose to do a partial copy of the source attribute
1726 * @since CUPS 1.6/macOS 10.8@
1729 int /* O - 1 on success, 0 on error */
1731 ipp_t
*dst
, /* I - Destination IPP message */
1732 ipp_t
*src
, /* I - Source IPP message */
1733 int quickcopy
, /* I - 1 for a referenced copy, 0 for normal */
1734 ipp_copycb_t cb
, /* I - Copy callback or @code NULL@ for none */
1735 void *context
) /* I - Context pointer */
1737 ipp_attribute_t
*srcattr
; /* Source attribute */
1740 DEBUG_printf(("ippCopyAttributes(dst=%p, src=%p, quickcopy=%d, cb=%p, context=%p)", (void *)dst
, (void *)src
, quickcopy
, (void *)cb
, context
));
1743 * Range check input...
1750 * Loop through source attributes and copy as needed...
1753 for (srcattr
= src
->attrs
; srcattr
; srcattr
= srcattr
->next
)
1754 if (!cb
|| (*cb
)(context
, dst
, srcattr
))
1755 if (!ippCopyAttribute(dst
, srcattr
, quickcopy
))
1763 * 'ippDateToTime()' - Convert from RFC 2579 Date/Time format to time in
1767 time_t /* O - UNIX time value */
1768 ippDateToTime(const ipp_uchar_t
*date
) /* I - RFC 2579 date info */
1770 struct tm unixdate
; /* UNIX date/time info */
1771 time_t t
; /* Computed time */
1777 memset(&unixdate
, 0, sizeof(unixdate
));
1780 * RFC-2579 date/time format is:
1782 * Byte(s) Description
1783 * ------- -----------
1784 * 0-1 Year (0 to 65535)
1788 * 5 Minutes (0 to 59)
1789 * 6 Seconds (0 to 60, 60 = "leap second")
1790 * 7 Deciseconds (0 to 9)
1792 * 9 UTC hours (0 to 11)
1793 * 10 UTC minutes (0 to 59)
1796 unixdate
.tm_year
= ((date
[0] << 8) | date
[1]) - 1900;
1797 unixdate
.tm_mon
= date
[2] - 1;
1798 unixdate
.tm_mday
= date
[3];
1799 unixdate
.tm_hour
= date
[4];
1800 unixdate
.tm_min
= date
[5];
1801 unixdate
.tm_sec
= date
[6];
1803 t
= mktime(&unixdate
);
1806 t
+= date
[9] * 3600 + date
[10] * 60;
1808 t
-= date
[9] * 3600 + date
[10] * 60;
1815 * 'ippDelete()' - Delete an IPP message.
1819 ippDelete(ipp_t
*ipp
) /* I - IPP message */
1821 ipp_attribute_t
*attr
, /* Current attribute */
1822 *next
; /* Next attribute */
1825 DEBUG_printf(("ippDelete(ipp=%p)", (void *)ipp
));
1833 DEBUG_printf(("4debug_retain: %p IPP message (use=%d)", (void *)ipp
, ipp
->use
));
1837 DEBUG_printf(("4debug_free: %p IPP message", (void *)ipp
));
1839 for (attr
= ipp
->attrs
; attr
!= NULL
; attr
= next
)
1843 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
));
1845 ipp_free_values(attr
, 0, attr
->num_values
);
1848 _cupsStrFree(attr
->name
);
1858 * 'ippDeleteAttribute()' - Delete a single attribute in an IPP message.
1860 * @since CUPS 1.1.19/macOS 10.3@
1865 ipp_t
*ipp
, /* I - IPP message */
1866 ipp_attribute_t
*attr
) /* I - Attribute to delete */
1868 ipp_attribute_t
*current
, /* Current attribute */
1869 *prev
; /* Previous attribute */
1872 DEBUG_printf(("ippDeleteAttribute(ipp=%p, attr=%p(%s))", (void *)ipp
, (void *)attr
, attr
? attr
->name
: "(null)"));
1875 * Range check input...
1881 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
));
1884 * Find the attribute in the list...
1889 for (current
= ipp
->attrs
, prev
= NULL
;
1891 prev
= current
, current
= current
->next
)
1892 if (current
== attr
)
1895 * Found it, remove the attribute from the list...
1899 prev
->next
= current
->next
;
1901 ipp
->attrs
= current
->next
;
1903 if (current
== ipp
->last
)
1914 * Free memory used by the attribute...
1917 ipp_free_values(attr
, 0, attr
->num_values
);
1920 _cupsStrFree(attr
->name
);
1927 * 'ippDeleteValues()' - Delete values in an attribute.
1929 * The @code element@ parameter specifies the first value to delete, starting at
1930 * 0. It must be less than the number of values returned by @link ippGetCount@.
1932 * The @code attr@ parameter may be modified as a result of setting the value.
1934 * Deleting all values in an attribute deletes the attribute.
1936 * @since CUPS 1.6/macOS 10.8@
1939 int /* O - 1 on success, 0 on failure */
1941 ipp_t
*ipp
, /* I - IPP message */
1942 ipp_attribute_t
**attr
, /* IO - Attribute */
1943 int element
, /* I - Index of first value to delete (0-based) */
1944 int count
) /* I - Number of values to delete */
1947 * Range check input...
1950 if (!ipp
|| !attr
|| !*attr
||
1951 element
< 0 || element
>= (*attr
)->num_values
|| count
<= 0 ||
1952 (element
+ count
) >= (*attr
)->num_values
)
1956 * If we are deleting all values, just delete the attribute entirely.
1959 if (count
== (*attr
)->num_values
)
1961 ippDeleteAttribute(ipp
, *attr
);
1967 * Otherwise free the values in question and return.
1970 ipp_free_values(*attr
, element
, count
);
1977 * 'ippFindAttribute()' - Find a named attribute in a request.
1979 * Starting with CUPS 2.0, the attribute name can contain a hierarchical list
1980 * of attribute and member names separated by slashes, for example
1981 * "media-col/media-size".
1984 ipp_attribute_t
* /* O - Matching attribute */
1985 ippFindAttribute(ipp_t
*ipp
, /* I - IPP message */
1986 const char *name
, /* I - Name of attribute */
1987 ipp_tag_t type
) /* I - Type of attribute */
1989 DEBUG_printf(("2ippFindAttribute(ipp=%p, name=\"%s\", type=%02x(%s))", (void *)ipp
, name
, type
, ippTagString(type
)));
1995 * Reset the current pointer...
1998 ipp
->current
= NULL
;
2002 * Search for the attribute...
2005 return (ippFindNextAttribute(ipp
, name
, type
));
2010 * 'ippFindNextAttribute()' - Find the next named attribute in a request.
2012 * Starting with CUPS 2.0, the attribute name can contain a hierarchical list
2013 * of attribute and member names separated by slashes, for example
2014 * "media-col/media-size".
2017 ipp_attribute_t
* /* O - Matching attribute */
2018 ippFindNextAttribute(ipp_t
*ipp
, /* I - IPP message */
2019 const char *name
, /* I - Name of attribute */
2020 ipp_tag_t type
) /* I - Type of attribute */
2022 ipp_attribute_t
*attr
, /* Current atttribute */
2023 *childattr
; /* Child attribute */
2024 ipp_tag_t value_tag
; /* Value tag */
2025 char parent
[1024], /* Parent attribute name */
2026 *child
= NULL
; /* Child attribute name */
2029 DEBUG_printf(("2ippFindNextAttribute(ipp=%p, name=\"%s\", type=%02x(%s))", (void *)ipp
, name
, type
, ippTagString(type
)));
2034 DEBUG_printf(("3ippFindNextAttribute: atend=%d", ipp
->atend
));
2039 if (strchr(name
, '/'))
2042 * Search for child attribute...
2045 strlcpy(parent
, name
, sizeof(parent
));
2046 if ((child
= strchr(parent
, '/')) == NULL
)
2048 DEBUG_puts("3ippFindNextAttribute: Attribute name too long.");
2054 if (ipp
->current
&& ipp
->current
->name
&& ipp
->current
->value_tag
== IPP_TAG_BEGIN_COLLECTION
&& !strcmp(parent
, ipp
->current
->name
))
2056 while (ipp
->curindex
< ipp
->current
->num_values
)
2058 if ((childattr
= ippFindNextAttribute(ipp
->current
->values
[ipp
->curindex
].collection
, child
, type
)) != NULL
)
2062 if (ipp
->curindex
< ipp
->current
->num_values
&& ipp
->current
->values
[ipp
->curindex
].collection
)
2063 ipp
->current
->values
[ipp
->curindex
].collection
->current
= NULL
;
2066 ipp
->prev
= ipp
->current
;
2067 ipp
->current
= ipp
->current
->next
;
2080 ipp
->current
= ipp
->attrs
;
2085 attr
= ipp
->current
;
2087 else if (ipp
->current
)
2089 ipp
->prev
= ipp
->current
;
2090 attr
= ipp
->current
->next
;
2098 for (; attr
!= NULL
; ipp
->prev
= attr
, attr
= attr
->next
)
2100 DEBUG_printf(("4ippFindAttribute: attr=%p, name=\"%s\"", (void *)attr
, attr
->name
));
2102 value_tag
= (ipp_tag_t
)(attr
->value_tag
& IPP_TAG_CUPS_MASK
);
2104 if (attr
->name
!= NULL
&& _cups_strcasecmp(attr
->name
, name
) == 0 &&
2105 (value_tag
== type
|| type
== IPP_TAG_ZERO
|| name
== parent
||
2106 (value_tag
== IPP_TAG_TEXTLANG
&& type
== IPP_TAG_TEXT
) ||
2107 (value_tag
== IPP_TAG_NAMELANG
&& type
== IPP_TAG_NAME
)))
2109 ipp
->current
= attr
;
2111 if (name
== parent
&& attr
->value_tag
== IPP_TAG_BEGIN_COLLECTION
)
2113 int i
; /* Looping var */
2115 for (i
= 0; i
< attr
->num_values
; i
++)
2117 if ((childattr
= ippFindAttribute(attr
->values
[i
].collection
, child
, type
)) != NULL
)
2119 attr
->values
[0].collection
->curindex
= i
;
2129 ipp
->current
= NULL
;
2138 * 'ippFirstAttribute()' - Return the first attribute in the message.
2140 * @since CUPS 1.6/macOS 10.8@
2143 ipp_attribute_t
* /* O - First attribute or @code NULL@ if none */
2144 ippFirstAttribute(ipp_t
*ipp
) /* I - IPP message */
2147 * Range check input...
2154 * Return the first attribute...
2157 return (ipp
->current
= ipp
->attrs
);
2162 * 'ippGetBoolean()' - Get a boolean value for an attribute.
2164 * The @code element@ parameter specifies which value to get from 0 to
2165 * @code ippGetCount(attr)@ - 1.
2167 * @since CUPS 1.6/macOS 10.8@
2170 int /* O - Boolean value or 0 on error */
2171 ippGetBoolean(ipp_attribute_t
*attr
, /* I - IPP attribute */
2172 int element
) /* I - Value number (0-based) */
2175 * Range check input...
2178 if (!attr
|| attr
->value_tag
!= IPP_TAG_BOOLEAN
||
2179 element
< 0 || element
>= attr
->num_values
)
2183 * Return the value...
2186 return (attr
->values
[element
].boolean
);
2191 * 'ippGetCollection()' - Get a collection value for an attribute.
2193 * The @code element@ parameter specifies which value to get from 0 to
2194 * @code ippGetCount(attr)@ - 1.
2196 * @since CUPS 1.6/macOS 10.8@
2199 ipp_t
* /* O - Collection value or @code NULL@ on error */
2201 ipp_attribute_t
*attr
, /* I - IPP attribute */
2202 int element
) /* I - Value number (0-based) */
2205 * Range check input...
2208 if (!attr
|| attr
->value_tag
!= IPP_TAG_BEGIN_COLLECTION
||
2209 element
< 0 || element
>= attr
->num_values
)
2213 * Return the value...
2216 return (attr
->values
[element
].collection
);
2221 * 'ippGetCount()' - Get the number of values in an attribute.
2223 * @since CUPS 1.6/macOS 10.8@
2226 int /* O - Number of values or 0 on error */
2227 ippGetCount(ipp_attribute_t
*attr
) /* I - IPP attribute */
2230 * Range check input...
2237 * Return the number of values...
2240 return (attr
->num_values
);
2245 * 'ippGetDate()' - Get a dateTime value for an attribute.
2247 * The @code element@ parameter specifies which value to get from 0 to
2248 * @code ippGetCount(attr)@ - 1.
2250 * @since CUPS 1.6/macOS 10.8@
2253 const ipp_uchar_t
* /* O - dateTime value or @code NULL@ */
2254 ippGetDate(ipp_attribute_t
*attr
, /* I - IPP attribute */
2255 int element
) /* I - Value number (0-based) */
2258 * Range check input...
2261 if (!attr
|| attr
->value_tag
!= IPP_TAG_DATE
||
2262 element
< 0 || element
>= attr
->num_values
)
2266 * Return the value...
2269 return (attr
->values
[element
].date
);
2274 * 'ippGetGroupTag()' - Get the group associated with an attribute.
2276 * @since CUPS 1.6/macOS 10.8@
2279 ipp_tag_t
/* O - Group tag or @code IPP_TAG_ZERO@ on error */
2280 ippGetGroupTag(ipp_attribute_t
*attr
) /* I - IPP attribute */
2283 * Range check input...
2287 return (IPP_TAG_ZERO
);
2290 * Return the group...
2293 return (attr
->group_tag
);
2298 * 'ippGetInteger()' - Get the integer/enum value for an attribute.
2300 * The @code element@ parameter specifies which value to get from 0 to
2301 * @code ippGetCount(attr)@ - 1.
2303 * @since CUPS 1.6/macOS 10.8@
2306 int /* O - Value or 0 on error */
2307 ippGetInteger(ipp_attribute_t
*attr
, /* I - IPP attribute */
2308 int element
) /* I - Value number (0-based) */
2311 * Range check input...
2314 if (!attr
|| (attr
->value_tag
!= IPP_TAG_INTEGER
&& attr
->value_tag
!= IPP_TAG_ENUM
) ||
2315 element
< 0 || element
>= attr
->num_values
)
2319 * Return the value...
2322 return (attr
->values
[element
].integer
);
2327 * 'ippGetName()' - Get the attribute name.
2329 * @since CUPS 1.6/macOS 10.8@
2332 const char * /* O - Attribute name or @code NULL@ for separators */
2333 ippGetName(ipp_attribute_t
*attr
) /* I - IPP attribute */
2336 * Range check input...
2343 * Return the name...
2346 return (attr
->name
);
2351 * 'ippGetOctetString()' - Get an octetString value from an IPP attribute.
2353 * The @code element@ parameter specifies which value to get from 0 to
2354 * @code ippGetCount(attr)@ - 1.
2356 * @since CUPS 1.7/macOS 10.9@
2359 void * /* O - Pointer to octetString data */
2361 ipp_attribute_t
*attr
, /* I - IPP attribute */
2362 int element
, /* I - Value number (0-based) */
2363 int *datalen
) /* O - Length of octetString data */
2366 * Range check input...
2369 if (!attr
|| attr
->value_tag
!= IPP_TAG_STRING
||
2370 element
< 0 || element
>= attr
->num_values
)
2379 * Return the values...
2383 *datalen
= attr
->values
[element
].unknown
.length
;
2385 return (attr
->values
[element
].unknown
.data
);
2390 * 'ippGetOperation()' - Get the operation ID in an IPP message.
2392 * @since CUPS 1.6/macOS 10.8@
2395 ipp_op_t
/* O - Operation ID or 0 on error */
2396 ippGetOperation(ipp_t
*ipp
) /* I - IPP request message */
2399 * Range check input...
2403 return ((ipp_op_t
)0);
2406 * Return the value...
2409 return (ipp
->request
.op
.operation_id
);
2414 * 'ippGetRange()' - Get a rangeOfInteger value from an attribute.
2416 * The @code element@ parameter specifies which value to get from 0 to
2417 * @code ippGetCount(attr)@ - 1.
2419 * @since CUPS 1.6/macOS 10.8@
2422 int /* O - Lower value of range or 0 */
2423 ippGetRange(ipp_attribute_t
*attr
, /* I - IPP attribute */
2424 int element
, /* I - Value number (0-based) */
2425 int *uppervalue
)/* O - Upper value of range */
2428 * Range check input...
2431 if (!attr
|| attr
->value_tag
!= IPP_TAG_RANGE
||
2432 element
< 0 || element
>= attr
->num_values
)
2441 * Return the values...
2445 *uppervalue
= attr
->values
[element
].range
.upper
;
2447 return (attr
->values
[element
].range
.lower
);
2452 * 'ippGetRequestId()' - Get the request ID from an IPP message.
2454 * @since CUPS 1.6/macOS 10.8@
2457 int /* O - Request ID or 0 on error */
2458 ippGetRequestId(ipp_t
*ipp
) /* I - IPP message */
2461 * Range check input...
2468 * Return the request ID...
2471 return (ipp
->request
.any
.request_id
);
2476 * 'ippGetResolution()' - Get a resolution value for an attribute.
2478 * The @code element@ parameter specifies which value to get from 0 to
2479 * @code ippGetCount(attr)@ - 1.
2481 * @since CUPS 1.6/macOS 10.8@
2484 int /* O - Horizontal/cross feed resolution or 0 */
2486 ipp_attribute_t
*attr
, /* I - IPP attribute */
2487 int element
, /* I - Value number (0-based) */
2488 int *yres
, /* O - Vertical/feed resolution */
2489 ipp_res_t
*units
) /* O - Units for resolution */
2492 * Range check input...
2495 if (!attr
|| attr
->value_tag
!= IPP_TAG_RESOLUTION
||
2496 element
< 0 || element
>= attr
->num_values
)
2502 *units
= (ipp_res_t
)0;
2508 * Return the value...
2512 *yres
= attr
->values
[element
].resolution
.yres
;
2515 *units
= attr
->values
[element
].resolution
.units
;
2517 return (attr
->values
[element
].resolution
.xres
);
2522 * 'ippGetState()' - Get the IPP message state.
2524 * @since CUPS 1.6/macOS 10.8@
2527 ipp_state_t
/* O - IPP message state value */
2528 ippGetState(ipp_t
*ipp
) /* I - IPP message */
2531 * Range check input...
2535 return (IPP_STATE_IDLE
);
2538 * Return the value...
2541 return (ipp
->state
);
2546 * 'ippGetStatusCode()' - Get the status code from an IPP response or event message.
2548 * @since CUPS 1.6/macOS 10.8@
2551 ipp_status_t
/* O - Status code in IPP message */
2552 ippGetStatusCode(ipp_t
*ipp
) /* I - IPP response or event message */
2555 * Range check input...
2559 return (IPP_STATUS_ERROR_INTERNAL
);
2562 * Return the value...
2565 return (ipp
->request
.status
.status_code
);
2570 * 'ippGetString()' - Get the string and optionally the language code for an attribute.
2572 * The @code element@ parameter specifies which value to get from 0 to
2573 * @code ippGetCount(attr)@ - 1.
2575 * @since CUPS 1.6/macOS 10.8@
2579 ippGetString(ipp_attribute_t
*attr
, /* I - IPP attribute */
2580 int element
, /* I - Value number (0-based) */
2581 const char **language
)/* O - Language code (@code NULL@ for don't care) */
2583 ipp_tag_t tag
; /* Value tag */
2587 * Range check input...
2590 tag
= ippGetValueTag(attr
);
2592 if (!attr
|| element
< 0 || element
>= attr
->num_values
|| (tag
!= IPP_TAG_TEXTLANG
&& tag
!= IPP_TAG_NAMELANG
&& (tag
< IPP_TAG_TEXT
|| tag
> IPP_TAG_MIMETYPE
)))
2596 * Return the value...
2600 *language
= attr
->values
[element
].string
.language
;
2602 return (attr
->values
[element
].string
.text
);
2607 * 'ippGetValueTag()' - Get the value tag for an attribute.
2609 * @since CUPS 1.6/macOS 10.8@
2612 ipp_tag_t
/* O - Value tag or @code IPP_TAG_ZERO@ on error */
2613 ippGetValueTag(ipp_attribute_t
*attr
) /* I - IPP attribute */
2616 * Range check input...
2620 return (IPP_TAG_ZERO
);
2623 * Return the value...
2626 return (attr
->value_tag
& IPP_TAG_CUPS_MASK
);
2631 * 'ippGetVersion()' - Get the major and minor version number from an IPP message.
2633 * @since CUPS 1.6/macOS 10.8@
2636 int /* O - Major version number or 0 on error */
2637 ippGetVersion(ipp_t
*ipp
, /* I - IPP message */
2638 int *minor
) /* O - Minor version number or @code NULL@ for don't care */
2641 * Range check input...
2653 * Return the value...
2657 *minor
= ipp
->request
.any
.version
[1];
2659 return (ipp
->request
.any
.version
[0]);
2664 * 'ippLength()' - Compute the length of an IPP message.
2667 size_t /* O - Size of IPP message */
2668 ippLength(ipp_t
*ipp
) /* I - IPP message */
2670 return (ipp_length(ipp
, 0));
2675 * 'ippNextAttribute()' - Return the next attribute in the message.
2677 * @since CUPS 1.6/macOS 10.8@
2680 ipp_attribute_t
* /* O - Next attribute or @code NULL@ if none */
2681 ippNextAttribute(ipp_t
*ipp
) /* I - IPP message */
2684 * Range check input...
2687 if (!ipp
|| !ipp
->current
)
2691 * Return the next attribute...
2694 return (ipp
->current
= ipp
->current
->next
);
2699 * 'ippNew()' - Allocate a new IPP message.
2702 ipp_t
* /* O - New IPP message */
2705 ipp_t
*temp
; /* New IPP message */
2706 _cups_globals_t
*cg
= _cupsGlobals();
2710 DEBUG_puts("ippNew()");
2712 if ((temp
= (ipp_t
*)calloc(1, sizeof(ipp_t
))) != NULL
)
2715 * Set default version - usually 2.0...
2718 DEBUG_printf(("4debug_alloc: %p IPP message", (void *)temp
));
2720 if (cg
->server_version
== 0)
2723 temp
->request
.any
.version
[0] = (ipp_uchar_t
)(cg
->server_version
/ 10);
2724 temp
->request
.any
.version
[1] = (ipp_uchar_t
)(cg
->server_version
% 10);
2728 DEBUG_printf(("1ippNew: Returning %p", (void *)temp
));
2735 * 'ippNewRequest()' - Allocate a new IPP request message.
2737 * The new request message is initialized with the "attributes-charset" and
2738 * "attributes-natural-language" attributes added. The
2739 * "attributes-natural-language" value is derived from the current locale.
2741 * @since CUPS 1.2/macOS 10.5@
2744 ipp_t
* /* O - IPP request message */
2745 ippNewRequest(ipp_op_t op
) /* I - Operation code */
2747 ipp_t
*request
; /* IPP request message */
2748 cups_lang_t
*language
; /* Current language localization */
2749 static int request_id
= 0; /* Current request ID */
2750 static _cups_mutex_t request_mutex
= _CUPS_MUTEX_INITIALIZER
;
2751 /* Mutex for request ID */
2754 DEBUG_printf(("ippNewRequest(op=%02x(%s))", op
, ippOpString(op
)));
2757 * Create a new IPP message...
2760 if ((request
= ippNew()) == NULL
)
2764 * Set the operation and request ID...
2767 _cupsMutexLock(&request_mutex
);
2769 request
->request
.op
.operation_id
= op
;
2770 request
->request
.op
.request_id
= ++request_id
;
2772 _cupsMutexUnlock(&request_mutex
);
2775 * Use UTF-8 as the character set...
2778 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_CHARSET
,
2779 "attributes-charset", NULL
, "utf-8");
2782 * Get the language from the current locale...
2785 language
= cupsLangDefault();
2787 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_LANGUAGE
,
2788 "attributes-natural-language", NULL
, language
->language
);
2791 * Return the new request...
2799 * 'ippNewResponse()' - Allocate a new IPP response message.
2801 * The new response message is initialized with the same "version-number",
2802 * "request-id", "attributes-charset", and "attributes-natural-language" as the
2803 * provided request message. If the "attributes-charset" or
2804 * "attributes-natural-language" attributes are missing from the request,
2805 * 'utf-8' and a value derived from the current locale are substituted,
2808 * @since CUPS 1.7/macOS 10.9@
2811 ipp_t
* /* O - IPP response message */
2812 ippNewResponse(ipp_t
*request
) /* I - IPP request message */
2814 ipp_t
*response
; /* IPP response message */
2815 ipp_attribute_t
*attr
; /* Current attribute */
2819 * Range check input...
2826 * Create a new IPP message...
2829 if ((response
= ippNew()) == NULL
)
2833 * Copy the request values over to the response...
2836 response
->request
.status
.version
[0] = request
->request
.op
.version
[0];
2837 response
->request
.status
.version
[1] = request
->request
.op
.version
[1];
2838 response
->request
.status
.request_id
= request
->request
.op
.request_id
;
2841 * The first attribute MUST be attributes-charset...
2844 attr
= request
->attrs
;
2846 if (attr
&& attr
->name
&& !strcmp(attr
->name
, "attributes-charset") &&
2847 attr
->group_tag
== IPP_TAG_OPERATION
&&
2848 attr
->value_tag
== IPP_TAG_CHARSET
&&
2849 attr
->num_values
== 1)
2852 * Copy charset from request...
2855 ippAddString(response
, IPP_TAG_OPERATION
, IPP_TAG_CHARSET
,
2856 "attributes-charset", NULL
, attr
->values
[0].string
.text
);
2861 * Use "utf-8" as the default...
2864 ippAddString(response
, IPP_TAG_OPERATION
, IPP_TAG_CHARSET
,
2865 "attributes-charset", NULL
, "utf-8");
2869 * Then attributes-natural-language...
2875 if (attr
&& attr
->name
&&
2876 !strcmp(attr
->name
, "attributes-natural-language") &&
2877 attr
->group_tag
== IPP_TAG_OPERATION
&&
2878 attr
->value_tag
== IPP_TAG_LANGUAGE
&&
2879 attr
->num_values
== 1)
2882 * Copy language from request...
2885 ippAddString(response
, IPP_TAG_OPERATION
, IPP_TAG_LANGUAGE
,
2886 "attributes-natural-language", NULL
,
2887 attr
->values
[0].string
.text
);
2892 * Use the language from the current locale...
2895 cups_lang_t
*language
= cupsLangDefault();
2896 /* Current locale */
2898 ippAddString(response
, IPP_TAG_OPERATION
, IPP_TAG_LANGUAGE
,
2899 "attributes-natural-language", NULL
, language
->language
);
2907 * 'ippRead()' - Read data for an IPP message from a HTTP connection.
2910 ipp_state_t
/* O - Current state */
2911 ippRead(http_t
*http
, /* I - HTTP connection */
2912 ipp_t
*ipp
) /* I - IPP data */
2914 DEBUG_printf(("ippRead(http=%p, ipp=%p), data_remaining=" CUPS_LLFMT
, (void *)http
, (void *)ipp
, CUPS_LLCAST (http
? http
->data_remaining
: -1)));
2917 return (IPP_STATE_ERROR
);
2919 DEBUG_printf(("2ippRead: http->state=%d, http->used=%d", http
->state
, http
->used
));
2921 return (ippReadIO(http
, (ipp_iocb_t
)ipp_read_http
, http
->blocking
, NULL
,
2927 * 'ippReadFile()' - Read data for an IPP message from a file.
2929 * @since CUPS 1.1.19/macOS 10.3@
2932 ipp_state_t
/* O - Current state */
2933 ippReadFile(int fd
, /* I - HTTP data */
2934 ipp_t
*ipp
) /* I - IPP data */
2936 DEBUG_printf(("ippReadFile(fd=%d, ipp=%p)", fd
, (void *)ipp
));
2938 return (ippReadIO(&fd
, (ipp_iocb_t
)ipp_read_file
, 1, NULL
, ipp
));
2943 * 'ippReadIO()' - Read data for an IPP message.
2945 * @since CUPS 1.2/macOS 10.5@
2948 ipp_state_t
/* O - Current state */
2949 ippReadIO(void *src
, /* I - Data source */
2950 ipp_iocb_t cb
, /* I - Read callback function */
2951 int blocking
, /* I - Use blocking IO? */
2952 ipp_t
*parent
, /* I - Parent request, if any */
2953 ipp_t
*ipp
) /* I - IPP data */
2955 int n
; /* Length of data */
2956 unsigned char *buffer
, /* Data buffer */
2957 string
[IPP_MAX_TEXT
],
2958 /* Small string buffer */
2959 *bufptr
; /* Pointer into buffer */
2960 ipp_attribute_t
*attr
; /* Current attribute */
2961 ipp_tag_t tag
; /* Current tag */
2962 ipp_tag_t value_tag
; /* Current value tag */
2963 _ipp_value_t
*value
; /* Current value */
2966 DEBUG_printf(("ippReadIO(src=%p, cb=%p, blocking=%d, parent=%p, ipp=%p)", (void *)src
, (void *)cb
, blocking
, (void *)parent
, (void *)ipp
));
2967 DEBUG_printf(("2ippReadIO: ipp->state=%d", ipp
? ipp
->state
: IPP_STATE_ERROR
));
2970 return (IPP_STATE_ERROR
);
2972 if ((buffer
= (unsigned char *)_cupsBufferGet(IPP_BUF_SIZE
)) == NULL
)
2974 DEBUG_puts("1ippReadIO: Unable to get read buffer.");
2975 return (IPP_STATE_ERROR
);
2980 case IPP_STATE_IDLE
:
2981 ipp
->state
++; /* Avoid common problem... */
2983 case IPP_STATE_HEADER
:
2987 * Get the request header...
2990 if ((*cb
)(src
, buffer
, 8) < 8)
2992 DEBUG_puts("1ippReadIO: Unable to read header.");
2993 _cupsBufferRelease((char *)buffer
);
2994 return (IPP_STATE_ERROR
);
2998 * Then copy the request header over...
3001 ipp
->request
.any
.version
[0] = buffer
[0];
3002 ipp
->request
.any
.version
[1] = buffer
[1];
3003 ipp
->request
.any
.op_status
= (buffer
[2] << 8) | buffer
[3];
3004 ipp
->request
.any
.request_id
= (((((buffer
[4] << 8) | buffer
[5]) << 8) |
3005 buffer
[6]) << 8) | buffer
[7];
3007 DEBUG_printf(("2ippReadIO: version=%d.%d", buffer
[0], buffer
[1]));
3008 DEBUG_printf(("2ippReadIO: op_status=%04x",
3009 ipp
->request
.any
.op_status
));
3010 DEBUG_printf(("2ippReadIO: request_id=%d",
3011 ipp
->request
.any
.request_id
));
3014 ipp
->state
= IPP_STATE_ATTRIBUTE
;
3015 ipp
->current
= NULL
;
3016 ipp
->curtag
= IPP_TAG_ZERO
;
3017 ipp
->prev
= ipp
->last
;
3020 * If blocking is disabled, stop here...
3026 case IPP_STATE_ATTRIBUTE
:
3029 if ((*cb
)(src
, buffer
, 1) < 1)
3031 DEBUG_puts("1ippReadIO: Callback returned EOF/error");
3032 _cupsBufferRelease((char *)buffer
);
3033 return (IPP_STATE_ERROR
);
3036 DEBUG_printf(("2ippReadIO: ipp->current=%p, ipp->prev=%p", (void *)ipp
->current
, (void *)ipp
->prev
));
3039 * Read this attribute...
3042 tag
= (ipp_tag_t
)buffer
[0];
3043 if (tag
== IPP_TAG_EXTENSION
)
3046 * Read 32-bit "extension" tag...
3049 if ((*cb
)(src
, buffer
, 4) < 1)
3051 DEBUG_puts("1ippReadIO: Callback returned EOF/error");
3052 _cupsBufferRelease((char *)buffer
);
3053 return (IPP_STATE_ERROR
);
3056 tag
= (ipp_tag_t
)((((((buffer
[0] << 8) | buffer
[1]) << 8) |
3057 buffer
[2]) << 8) | buffer
[3]);
3059 if (tag
& IPP_TAG_CUPS_CONST
)
3062 * Fail if the high bit is set in the tag...
3065 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("IPP extension tag larger than 0x7FFFFFFF."), 1);
3066 DEBUG_printf(("1ippReadIO: bad tag 0x%x.", tag
));
3067 _cupsBufferRelease((char *)buffer
);
3068 return (IPP_STATE_ERROR
);
3072 if (tag
== IPP_TAG_END
)
3075 * No more attributes left...
3078 DEBUG_puts("2ippReadIO: IPP_TAG_END.");
3080 ipp
->state
= IPP_STATE_DATA
;
3083 else if (tag
== IPP_TAG_ZERO
|| (tag
== IPP_TAG_OPERATION
&& ipp
->curtag
!= IPP_TAG_ZERO
))
3085 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("Invalid group tag."), 1);
3086 DEBUG_printf(("1ippReadIO: bad tag 0x%02x.", tag
));
3087 _cupsBufferRelease((char *)buffer
);
3088 return (IPP_STATE_ERROR
);
3090 else if (tag
< IPP_TAG_UNSUPPORTED_VALUE
)
3093 * Group tag... Set the current group and continue...
3096 if (ipp
->curtag
== tag
)
3097 ipp
->prev
= ippAddSeparator(ipp
);
3098 else if (ipp
->current
)
3099 ipp
->prev
= ipp
->current
;
3102 ipp
->current
= NULL
;
3103 DEBUG_printf(("2ippReadIO: group tag=%x(%s), ipp->prev=%p", tag
, ippTagString(tag
), (void *)ipp
->prev
));
3107 DEBUG_printf(("2ippReadIO: value tag=%x(%s)", tag
,
3108 ippTagString(tag
)));
3114 if ((*cb
)(src
, buffer
, 2) < 2)
3116 DEBUG_puts("1ippReadIO: unable to read name length.");
3117 _cupsBufferRelease((char *)buffer
);
3118 return (IPP_STATE_ERROR
);
3121 n
= (buffer
[0] << 8) | buffer
[1];
3123 if (n
>= IPP_BUF_SIZE
)
3125 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("IPP name larger than 32767 bytes."), 1);
3126 DEBUG_printf(("1ippReadIO: bad name length %d.", n
));
3127 _cupsBufferRelease((char *)buffer
);
3128 return (IPP_STATE_ERROR
);
3131 DEBUG_printf(("2ippReadIO: name length=%d", n
));
3133 if (n
== 0 && tag
!= IPP_TAG_MEMBERNAME
&&
3134 tag
!= IPP_TAG_END_COLLECTION
)
3137 * More values for current attribute...
3140 if (ipp
->current
== NULL
)
3142 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("IPP attribute has no name."), 1);
3143 DEBUG_puts("1ippReadIO: Attribute without name and no current.");
3144 _cupsBufferRelease((char *)buffer
);
3145 return (IPP_STATE_ERROR
);
3148 attr
= ipp
->current
;
3149 value_tag
= (ipp_tag_t
)(attr
->value_tag
& IPP_TAG_CUPS_MASK
);
3152 * Make sure we aren't adding a new value of a different
3156 if (value_tag
== IPP_TAG_ZERO
)
3159 * Setting the value of a collection member...
3162 attr
->value_tag
= tag
;
3164 else if (value_tag
== IPP_TAG_TEXTLANG
||
3165 value_tag
== IPP_TAG_NAMELANG
||
3166 (value_tag
>= IPP_TAG_TEXT
&&
3167 value_tag
<= IPP_TAG_MIMETYPE
))
3170 * String values can sometimes come across in different
3171 * forms; accept sets of differing values...
3174 if (tag
!= IPP_TAG_TEXTLANG
&& tag
!= IPP_TAG_NAMELANG
&&
3175 (tag
< IPP_TAG_TEXT
|| tag
> IPP_TAG_MIMETYPE
) &&
3176 tag
!= IPP_TAG_NOVALUE
)
3178 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3179 _("IPP 1setOf attribute with incompatible value "
3181 DEBUG_printf(("1ippReadIO: 1setOf value tag %x(%s) != %x(%s)",
3182 value_tag
, ippTagString(value_tag
), tag
,
3183 ippTagString(tag
)));
3184 _cupsBufferRelease((char *)buffer
);
3185 return (IPP_STATE_ERROR
);
3188 if (value_tag
!= tag
)
3190 DEBUG_printf(("1ippReadIO: Converting %s attribute from %s to %s.",
3191 attr
->name
, ippTagString(value_tag
), ippTagString(tag
)));
3192 ippSetValueTag(ipp
, &attr
, tag
);
3195 else if (value_tag
== IPP_TAG_INTEGER
||
3196 value_tag
== IPP_TAG_RANGE
)
3199 * Integer and rangeOfInteger values can sometimes be mixed; accept
3200 * sets of differing values...
3203 if (tag
!= IPP_TAG_INTEGER
&& tag
!= IPP_TAG_RANGE
)
3205 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3206 _("IPP 1setOf attribute with incompatible value "
3208 DEBUG_printf(("1ippReadIO: 1setOf value tag %x(%s) != %x(%s)",
3209 value_tag
, ippTagString(value_tag
), tag
,
3210 ippTagString(tag
)));
3211 _cupsBufferRelease((char *)buffer
);
3212 return (IPP_STATE_ERROR
);
3215 if (value_tag
== IPP_TAG_INTEGER
&& tag
== IPP_TAG_RANGE
)
3218 * Convert integer values to rangeOfInteger values...
3221 DEBUG_printf(("1ippReadIO: Converting %s attribute to "
3222 "rangeOfInteger.", attr
->name
));
3223 ippSetValueTag(ipp
, &attr
, IPP_TAG_RANGE
);
3226 else if (value_tag
!= tag
)
3228 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3229 _("IPP 1setOf attribute with incompatible value "
3231 DEBUG_printf(("1ippReadIO: value tag %x(%s) != %x(%s)",
3232 value_tag
, ippTagString(value_tag
), tag
,
3233 ippTagString(tag
)));
3234 _cupsBufferRelease((char *)buffer
);
3235 return (IPP_STATE_ERROR
);
3239 * Finally, reallocate the attribute array as needed...
3242 if ((value
= ipp_set_value(ipp
, &attr
, attr
->num_values
)) == NULL
)
3244 _cupsBufferRelease((char *)buffer
);
3245 return (IPP_STATE_ERROR
);
3248 else if (tag
== IPP_TAG_MEMBERNAME
)
3251 * Name must be length 0!
3256 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("IPP member name is not empty."), 1);
3257 DEBUG_puts("1ippReadIO: member name not empty.");
3258 _cupsBufferRelease((char *)buffer
);
3259 return (IPP_STATE_ERROR
);
3263 ipp
->prev
= ipp
->current
;
3265 attr
= ipp
->current
= ipp_add_attr(ipp
, NULL
, ipp
->curtag
, IPP_TAG_ZERO
, 1);
3268 _cupsSetHTTPError(HTTP_STATUS_ERROR
);
3269 DEBUG_puts("1ippReadIO: unable to allocate attribute.");
3270 _cupsBufferRelease((char *)buffer
);
3271 return (IPP_STATE_ERROR
);
3274 DEBUG_printf(("2ippReadIO: membername, ipp->current=%p, ipp->prev=%p", (void *)ipp
->current
, (void *)ipp
->prev
));
3276 value
= attr
->values
;
3278 else if (tag
!= IPP_TAG_END_COLLECTION
)
3281 * New attribute; read the name and add it...
3284 if ((*cb
)(src
, buffer
, (size_t)n
) < n
)
3286 DEBUG_puts("1ippReadIO: unable to read name.");
3287 _cupsBufferRelease((char *)buffer
);
3288 return (IPP_STATE_ERROR
);
3294 ipp
->prev
= ipp
->current
;
3296 if ((attr
= ipp
->current
= ipp_add_attr(ipp
, (char *)buffer
, ipp
->curtag
, tag
,
3299 _cupsSetHTTPError(HTTP_STATUS_ERROR
);
3300 DEBUG_puts("1ippReadIO: unable to allocate attribute.");
3301 _cupsBufferRelease((char *)buffer
);
3302 return (IPP_STATE_ERROR
);
3305 DEBUG_printf(("2ippReadIO: name=\"%s\", ipp->current=%p, ipp->prev=%p", buffer
, (void *)ipp
->current
, (void *)ipp
->prev
));
3307 value
= attr
->values
;
3315 if ((*cb
)(src
, buffer
, 2) < 2)
3317 DEBUG_puts("1ippReadIO: unable to read value length.");
3318 _cupsBufferRelease((char *)buffer
);
3319 return (IPP_STATE_ERROR
);
3322 n
= (buffer
[0] << 8) | buffer
[1];
3323 DEBUG_printf(("2ippReadIO: value length=%d", n
));
3325 if (n
>= IPP_BUF_SIZE
)
3327 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3328 _("IPP value larger than 32767 bytes."), 1);
3329 DEBUG_printf(("1ippReadIO: bad value length %d.", n
));
3330 _cupsBufferRelease((char *)buffer
);
3331 return (IPP_STATE_ERROR
);
3336 case IPP_TAG_INTEGER
:
3340 if (tag
== IPP_TAG_INTEGER
)
3341 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3342 _("IPP integer value not 4 bytes."), 1);
3344 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3345 _("IPP enum value not 4 bytes."), 1);
3346 DEBUG_printf(("1ippReadIO: bad integer value length %d.", n
));
3347 _cupsBufferRelease((char *)buffer
);
3348 return (IPP_STATE_ERROR
);
3351 if ((*cb
)(src
, buffer
, 4) < 4)
3353 DEBUG_puts("1ippReadIO: Unable to read integer value.");
3354 _cupsBufferRelease((char *)buffer
);
3355 return (IPP_STATE_ERROR
);
3358 n
= (((((buffer
[0] << 8) | buffer
[1]) << 8) | buffer
[2]) << 8) |
3361 if (attr
->value_tag
== IPP_TAG_RANGE
)
3362 value
->range
.lower
= value
->range
.upper
= n
;
3367 case IPP_TAG_BOOLEAN
:
3370 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("IPP boolean value not 1 byte."),
3372 DEBUG_printf(("1ippReadIO: bad boolean value length %d.", n
));
3373 _cupsBufferRelease((char *)buffer
);
3374 return (IPP_STATE_ERROR
);
3377 if ((*cb
)(src
, buffer
, 1) < 1)
3379 DEBUG_puts("1ippReadIO: Unable to read boolean value.");
3380 _cupsBufferRelease((char *)buffer
);
3381 return (IPP_STATE_ERROR
);
3384 value
->boolean
= (char)buffer
[0];
3387 case IPP_TAG_UNSUPPORTED_VALUE
:
3388 case IPP_TAG_DEFAULT
:
3389 case IPP_TAG_UNKNOWN
:
3390 case IPP_TAG_NOVALUE
:
3391 case IPP_TAG_NOTSETTABLE
:
3392 case IPP_TAG_DELETEATTR
:
3393 case IPP_TAG_ADMINDEFINE
:
3395 * These value types are not supposed to have values, however
3396 * some vendors (Brother) do not implement IPP correctly and so
3397 * we need to map non-empty values to text...
3400 if (attr
->value_tag
== tag
)
3405 attr
->value_tag
= IPP_TAG_TEXT
;
3410 case IPP_TAG_RESERVED_STRING
:
3411 case IPP_TAG_KEYWORD
:
3413 case IPP_TAG_URISCHEME
:
3414 case IPP_TAG_CHARSET
:
3415 case IPP_TAG_LANGUAGE
:
3416 case IPP_TAG_MIMETYPE
:
3419 if ((*cb
)(src
, buffer
, (size_t)n
) < n
)
3421 DEBUG_puts("1ippReadIO: unable to read string value.");
3422 _cupsBufferRelease((char *)buffer
);
3423 return (IPP_STATE_ERROR
);
3428 value
->string
.text
= _cupsStrAlloc((char *)buffer
);
3429 DEBUG_printf(("2ippReadIO: value=\"%s\"", value
->string
.text
));
3435 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("IPP date value not 11 bytes."), 1);
3436 DEBUG_printf(("1ippReadIO: bad date value length %d.", n
));
3437 _cupsBufferRelease((char *)buffer
);
3438 return (IPP_STATE_ERROR
);
3441 if ((*cb
)(src
, value
->date
, 11) < 11)
3443 DEBUG_puts("1ippReadIO: Unable to read date value.");
3444 _cupsBufferRelease((char *)buffer
);
3445 return (IPP_STATE_ERROR
);
3449 case IPP_TAG_RESOLUTION
:
3452 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3453 _("IPP resolution value not 9 bytes."), 1);
3454 DEBUG_printf(("1ippReadIO: bad resolution value length %d.", n
));
3455 _cupsBufferRelease((char *)buffer
);
3456 return (IPP_STATE_ERROR
);
3459 if ((*cb
)(src
, buffer
, 9) < 9)
3461 DEBUG_puts("1ippReadIO: Unable to read resolution value.");
3462 _cupsBufferRelease((char *)buffer
);
3463 return (IPP_STATE_ERROR
);
3466 value
->resolution
.xres
=
3467 (((((buffer
[0] << 8) | buffer
[1]) << 8) | buffer
[2]) << 8) |
3469 value
->resolution
.yres
=
3470 (((((buffer
[4] << 8) | buffer
[5]) << 8) | buffer
[6]) << 8) |
3472 value
->resolution
.units
=
3473 (ipp_res_t
)buffer
[8];
3476 case IPP_TAG_RANGE
:
3479 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3480 _("IPP rangeOfInteger value not 8 bytes."), 1);
3481 DEBUG_printf(("1ippReadIO: bad rangeOfInteger value length "
3483 _cupsBufferRelease((char *)buffer
);
3484 return (IPP_STATE_ERROR
);
3487 if ((*cb
)(src
, buffer
, 8) < 8)
3489 DEBUG_puts("1ippReadIO: Unable to read range value.");
3490 _cupsBufferRelease((char *)buffer
);
3491 return (IPP_STATE_ERROR
);
3494 value
->range
.lower
=
3495 (((((buffer
[0] << 8) | buffer
[1]) << 8) | buffer
[2]) << 8) |
3497 value
->range
.upper
=
3498 (((((buffer
[4] << 8) | buffer
[5]) << 8) | buffer
[6]) << 8) |
3502 case IPP_TAG_TEXTLANG
:
3503 case IPP_TAG_NAMELANG
:
3506 if (tag
== IPP_TAG_TEXTLANG
)
3507 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3508 _("IPP textWithLanguage value less than "
3509 "minimum 4 bytes."), 1);
3511 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3512 _("IPP nameWithLanguage value less than "
3513 "minimum 4 bytes."), 1);
3514 DEBUG_printf(("1ippReadIO: bad stringWithLanguage value "
3516 _cupsBufferRelease((char *)buffer
);
3517 return (IPP_STATE_ERROR
);
3520 if ((*cb
)(src
, buffer
, (size_t)n
) < n
)
3522 DEBUG_puts("1ippReadIO: Unable to read string w/language "
3524 _cupsBufferRelease((char *)buffer
);
3525 return (IPP_STATE_ERROR
);
3531 * text-with-language and name-with-language are composite
3540 n
= (bufptr
[0] << 8) | bufptr
[1];
3542 if ((bufptr
+ 2 + n
) >= (buffer
+ IPP_BUF_SIZE
) || n
>= (int)sizeof(string
))
3544 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3545 _("IPP language length overflows value."), 1);
3546 DEBUG_printf(("1ippReadIO: bad language value length %d.",
3548 _cupsBufferRelease((char *)buffer
);
3549 return (IPP_STATE_ERROR
);
3551 else if (n
>= IPP_MAX_LANGUAGE
)
3553 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3554 _("IPP language length too large."), 1);
3555 DEBUG_printf(("1ippReadIO: bad language value length %d.",
3557 _cupsBufferRelease((char *)buffer
);
3558 return (IPP_STATE_ERROR
);
3561 memcpy(string
, bufptr
+ 2, (size_t)n
);
3564 value
->string
.language
= _cupsStrAlloc((char *)string
);
3567 n
= (bufptr
[0] << 8) | bufptr
[1];
3569 if ((bufptr
+ 2 + n
) >= (buffer
+ IPP_BUF_SIZE
))
3571 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3572 _("IPP string length overflows value."), 1);
3573 DEBUG_printf(("1ippReadIO: bad string value length %d.", n
));
3574 _cupsBufferRelease((char *)buffer
);
3575 return (IPP_STATE_ERROR
);
3578 bufptr
[2 + n
] = '\0';
3579 value
->string
.text
= _cupsStrAlloc((char *)bufptr
+ 2);
3582 case IPP_TAG_BEGIN_COLLECTION
:
3584 * Oh, boy, here comes a collection value, so read it...
3587 value
->collection
= ippNew();
3591 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3592 _("IPP begCollection value not 0 bytes."), 1);
3593 DEBUG_puts("1ippReadIO: begCollection tag with value length "
3595 _cupsBufferRelease((char *)buffer
);
3596 return (IPP_STATE_ERROR
);
3599 if (ippReadIO(src
, cb
, 1, ipp
, value
->collection
) == IPP_STATE_ERROR
)
3601 DEBUG_puts("1ippReadIO: Unable to read collection value.");
3602 _cupsBufferRelease((char *)buffer
);
3603 return (IPP_STATE_ERROR
);
3607 case IPP_TAG_END_COLLECTION
:
3608 _cupsBufferRelease((char *)buffer
);
3612 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3613 _("IPP endCollection value not 0 bytes."), 1);
3614 DEBUG_puts("1ippReadIO: endCollection tag with value length "
3616 return (IPP_STATE_ERROR
);
3619 DEBUG_puts("1ippReadIO: endCollection tag...");
3620 return (ipp
->state
= IPP_STATE_DATA
);
3622 case IPP_TAG_MEMBERNAME
:
3624 * The value the name of the member in the collection, which
3625 * we need to carry over...
3630 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3631 _("IPP memberName with no attribute."), 1);
3632 DEBUG_puts("1ippReadIO: Member name without attribute.");
3633 _cupsBufferRelease((char *)buffer
);
3634 return (IPP_STATE_ERROR
);
3638 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3639 _("IPP memberName value is empty."), 1);
3640 DEBUG_puts("1ippReadIO: Empty member name value.");
3641 _cupsBufferRelease((char *)buffer
);
3642 return (IPP_STATE_ERROR
);
3644 else if ((*cb
)(src
, buffer
, (size_t)n
) < n
)
3646 DEBUG_puts("1ippReadIO: Unable to read member name value.");
3647 _cupsBufferRelease((char *)buffer
);
3648 return (IPP_STATE_ERROR
);
3652 attr
->name
= _cupsStrAlloc((char *)buffer
);
3655 * Since collection members are encoded differently than
3656 * regular attributes, make sure we don't start with an
3660 attr
->num_values
--;
3662 DEBUG_printf(("2ippReadIO: member name=\"%s\"", attr
->name
));
3665 default : /* Other unsupported values */
3666 if (tag
== IPP_TAG_STRING
&& n
> IPP_MAX_LENGTH
)
3668 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3669 _("IPP octetString length too large."), 1);
3670 DEBUG_printf(("1ippReadIO: bad octetString value length %d.",
3672 _cupsBufferRelease((char *)buffer
);
3673 return (IPP_STATE_ERROR
);
3676 value
->unknown
.length
= n
;
3680 if ((value
->unknown
.data
= malloc((size_t)n
)) == NULL
)
3682 _cupsSetHTTPError(HTTP_STATUS_ERROR
);
3683 DEBUG_puts("1ippReadIO: Unable to allocate value");
3684 _cupsBufferRelease((char *)buffer
);
3685 return (IPP_STATE_ERROR
);
3688 if ((*cb
)(src
, value
->unknown
.data
, (size_t)n
) < n
)
3690 DEBUG_puts("1ippReadIO: Unable to read unsupported value.");
3691 _cupsBufferRelease((char *)buffer
);
3692 return (IPP_STATE_ERROR
);
3696 value
->unknown
.data
= NULL
;
3701 * If blocking is disabled, stop here...
3709 case IPP_STATE_DATA
:
3713 break; /* anti-compiler-warning-code */
3716 DEBUG_printf(("1ippReadIO: returning ipp->state=%d.", ipp
->state
));
3717 _cupsBufferRelease((char *)buffer
);
3719 return (ipp
->state
);
3724 * 'ippSetBoolean()' - Set a boolean value in an attribute.
3726 * The @code ipp@ parameter refers to an IPP message previously created using
3727 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
3729 * The @code attr@ parameter may be modified as a result of setting the value.
3731 * The @code element@ parameter specifies which value to set from 0 to
3732 * @code ippGetCount(attr)@.
3734 * @since CUPS 1.6/macOS 10.8@
3737 int /* O - 1 on success, 0 on failure */
3738 ippSetBoolean(ipp_t
*ipp
, /* I - IPP message */
3739 ipp_attribute_t
**attr
, /* IO - IPP attribute */
3740 int element
, /* I - Value number (0-based) */
3741 int boolvalue
)/* I - Boolean value */
3743 _ipp_value_t
*value
; /* Current value */
3747 * Range check input...
3750 if (!ipp
|| !attr
|| !*attr
|| (*attr
)->value_tag
!= IPP_TAG_BOOLEAN
||
3751 element
< 0 || element
> (*attr
)->num_values
)
3755 * Set the value and return...
3758 if ((value
= ipp_set_value(ipp
, attr
, element
)) != NULL
)
3759 value
->boolean
= (char)boolvalue
;
3761 return (value
!= NULL
);
3766 * 'ippSetCollection()' - Set a collection value in an attribute.
3768 * The @code ipp@ parameter refers to an IPP message previously created using
3769 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
3771 * The @code attr@ parameter may be modified as a result of setting the value.
3773 * The @code element@ parameter specifies which value to set from 0 to
3774 * @code ippGetCount(attr)@.
3776 * @since CUPS 1.6/macOS 10.8@
3779 int /* O - 1 on success, 0 on failure */
3781 ipp_t
*ipp
, /* I - IPP message */
3782 ipp_attribute_t
**attr
, /* IO - IPP attribute */
3783 int element
, /* I - Value number (0-based) */
3784 ipp_t
*colvalue
) /* I - Collection value */
3786 _ipp_value_t
*value
; /* Current value */
3790 * Range check input...
3793 if (!ipp
|| !attr
|| !*attr
|| (*attr
)->value_tag
!= IPP_TAG_BEGIN_COLLECTION
||
3794 element
< 0 || element
> (*attr
)->num_values
|| !colvalue
)
3798 * Set the value and return...
3801 if ((value
= ipp_set_value(ipp
, attr
, element
)) != NULL
)
3803 if (value
->collection
)
3804 ippDelete(value
->collection
);
3806 value
->collection
= colvalue
;
3810 return (value
!= NULL
);
3815 * 'ippSetDate()' - Set a dateTime value in an attribute.
3817 * The @code ipp@ parameter refers to an IPP message previously created using
3818 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
3820 * The @code attr@ parameter may be modified as a result of setting the value.
3822 * The @code element@ parameter specifies which value to set from 0 to
3823 * @code ippGetCount(attr)@.
3825 * @since CUPS 1.6/macOS 10.8@
3828 int /* O - 1 on success, 0 on failure */
3829 ippSetDate(ipp_t
*ipp
, /* I - IPP message */
3830 ipp_attribute_t
**attr
, /* IO - IPP attribute */
3831 int element
, /* I - Value number (0-based) */
3832 const ipp_uchar_t
*datevalue
)/* I - dateTime value */
3834 _ipp_value_t
*value
; /* Current value */
3838 * Range check input...
3841 if (!ipp
|| !attr
|| !*attr
|| (*attr
)->value_tag
!= IPP_TAG_DATE
||
3842 element
< 0 || element
> (*attr
)->num_values
|| !datevalue
)
3846 * Set the value and return...
3849 if ((value
= ipp_set_value(ipp
, attr
, element
)) != NULL
)
3850 memcpy(value
->date
, datevalue
, sizeof(value
->date
));
3852 return (value
!= NULL
);
3857 * 'ippSetGroupTag()' - Set the group tag of an attribute.
3859 * The @code ipp@ parameter refers to an IPP message previously created using
3860 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
3862 * The @code attr@ parameter may be modified as a result of setting the value.
3864 * The @code group@ parameter specifies the IPP attribute group tag: none
3865 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
3866 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
3867 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
3868 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
3870 * @since CUPS 1.6/macOS 10.8@
3873 int /* O - 1 on success, 0 on failure */
3875 ipp_t
*ipp
, /* I - IPP message */
3876 ipp_attribute_t
**attr
, /* IO - Attribute */
3877 ipp_tag_t group_tag
) /* I - Group tag */
3880 * Range check input - group tag must be 0x01 to 0x0F, per RFC 8011...
3883 if (!ipp
|| !attr
|| !*attr
||
3884 group_tag
< IPP_TAG_ZERO
|| group_tag
== IPP_TAG_END
||
3885 group_tag
>= IPP_TAG_UNSUPPORTED_VALUE
)
3889 * Set the group tag and return...
3892 (*attr
)->group_tag
= group_tag
;
3899 * 'ippSetInteger()' - Set an integer or enum value in an attribute.
3901 * The @code ipp@ parameter refers to an IPP message previously created using
3902 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
3904 * The @code attr@ parameter may be modified as a result of setting the value.
3906 * The @code element@ parameter specifies which value to set from 0 to
3907 * @code ippGetCount(attr)@.
3909 * @since CUPS 1.6/macOS 10.8@
3912 int /* O - 1 on success, 0 on failure */
3913 ippSetInteger(ipp_t
*ipp
, /* I - IPP message */
3914 ipp_attribute_t
**attr
, /* IO - IPP attribute */
3915 int element
, /* I - Value number (0-based) */
3916 int intvalue
) /* I - Integer/enum value */
3918 _ipp_value_t
*value
; /* Current value */
3922 * Range check input...
3925 if (!ipp
|| !attr
|| !*attr
||
3926 ((*attr
)->value_tag
!= IPP_TAG_INTEGER
&& (*attr
)->value_tag
!= IPP_TAG_ENUM
) ||
3927 element
< 0 || element
> (*attr
)->num_values
)
3931 * Set the value and return...
3934 if ((value
= ipp_set_value(ipp
, attr
, element
)) != NULL
)
3935 value
->integer
= intvalue
;
3937 return (value
!= NULL
);
3942 * 'ippSetName()' - Set the name of an attribute.
3944 * The @code ipp@ parameter refers to an IPP message previously created using
3945 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
3947 * The @code attr@ parameter may be modified as a result of setting the value.
3949 * @since CUPS 1.6/macOS 10.8@
3952 int /* O - 1 on success, 0 on failure */
3953 ippSetName(ipp_t
*ipp
, /* I - IPP message */
3954 ipp_attribute_t
**attr
, /* IO - IPP attribute */
3955 const char *name
) /* I - Attribute name */
3957 char *temp
; /* Temporary name value */
3961 * Range check input...
3964 if (!ipp
|| !attr
|| !*attr
)
3968 * Set the value and return...
3971 if ((temp
= _cupsStrAlloc(name
)) != NULL
)
3974 _cupsStrFree((*attr
)->name
);
3976 (*attr
)->name
= temp
;
3979 return (temp
!= NULL
);
3984 * 'ippSetOctetString()' - Set an octetString value in an IPP attribute.
3986 * The @code ipp@ parameter refers to an IPP message previously created using
3987 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
3989 * The @code attr@ parameter may be modified as a result of setting the value.
3991 * The @code element@ parameter specifies which value to set from 0 to
3992 * @code ippGetCount(attr)@.
3994 * @since CUPS 1.7/macOS 10.9@
3997 int /* O - 1 on success, 0 on failure */
3999 ipp_t
*ipp
, /* I - IPP message */
4000 ipp_attribute_t
**attr
, /* IO - IPP attribute */
4001 int element
, /* I - Value number (0-based) */
4002 const void *data
, /* I - Pointer to octetString data */
4003 int datalen
) /* I - Length of octetString data */
4005 _ipp_value_t
*value
; /* Current value */
4009 * Range check input...
4012 if (!ipp
|| !attr
|| !*attr
|| (*attr
)->value_tag
!= IPP_TAG_STRING
||
4013 element
< 0 || element
> (*attr
)->num_values
||
4014 datalen
< 0 || datalen
> IPP_MAX_LENGTH
)
4018 * Set the value and return...
4021 if ((value
= ipp_set_value(ipp
, attr
, element
)) != NULL
)
4023 if ((int)((*attr
)->value_tag
) & IPP_TAG_CUPS_CONST
)
4026 * Just copy the pointer...
4029 value
->unknown
.data
= (void *)data
;
4030 value
->unknown
.length
= datalen
;
4038 if (value
->unknown
.data
)
4041 * Free previous data...
4044 free(value
->unknown
.data
);
4046 value
->unknown
.data
= NULL
;
4047 value
->unknown
.length
= 0;
4052 void *temp
; /* Temporary data pointer */
4054 if ((temp
= malloc((size_t)datalen
)) != NULL
)
4056 memcpy(temp
, data
, (size_t)datalen
);
4058 value
->unknown
.data
= temp
;
4059 value
->unknown
.length
= datalen
;
4067 return (value
!= NULL
);
4072 * 'ippSetOperation()' - Set the operation ID in an IPP request message.
4074 * The @code ipp@ parameter refers to an IPP message previously created using
4075 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
4077 * @since CUPS 1.6/macOS 10.8@
4080 int /* O - 1 on success, 0 on failure */
4081 ippSetOperation(ipp_t
*ipp
, /* I - IPP request message */
4082 ipp_op_t op
) /* I - Operation ID */
4085 * Range check input...
4092 * Set the operation and return...
4095 ipp
->request
.op
.operation_id
= op
;
4102 * 'ippSetRange()' - Set a rangeOfInteger value in an attribute.
4104 * The @code ipp@ parameter refers to an IPP message previously created using
4105 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
4107 * The @code attr@ parameter may be modified as a result of setting the value.
4109 * The @code element@ parameter specifies which value to set from 0 to
4110 * @code ippGetCount(attr)@.
4112 * @since CUPS 1.6/macOS 10.8@
4115 int /* O - 1 on success, 0 on failure */
4116 ippSetRange(ipp_t
*ipp
, /* I - IPP message */
4117 ipp_attribute_t
**attr
, /* IO - IPP attribute */
4118 int element
, /* I - Value number (0-based) */
4119 int lowervalue
, /* I - Lower bound for range */
4120 int uppervalue
) /* I - Upper bound for range */
4122 _ipp_value_t
*value
; /* Current value */
4126 * Range check input...
4129 if (!ipp
|| !attr
|| !*attr
|| (*attr
)->value_tag
!= IPP_TAG_RANGE
||
4130 element
< 0 || element
> (*attr
)->num_values
|| lowervalue
> uppervalue
)
4134 * Set the value and return...
4137 if ((value
= ipp_set_value(ipp
, attr
, element
)) != NULL
)
4139 value
->range
.lower
= lowervalue
;
4140 value
->range
.upper
= uppervalue
;
4143 return (value
!= NULL
);
4148 * 'ippSetRequestId()' - Set the request ID in an IPP message.
4150 * The @code ipp@ parameter refers to an IPP message previously created using
4151 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
4153 * The @code request_id@ parameter must be greater than 0.
4155 * @since CUPS 1.6/macOS 10.8@
4158 int /* O - 1 on success, 0 on failure */
4159 ippSetRequestId(ipp_t
*ipp
, /* I - IPP message */
4160 int request_id
) /* I - Request ID */
4163 * Range check input; not checking request_id values since ipptool wants to send
4164 * invalid values for conformance testing and a bad request_id does not affect the
4165 * encoding of a message...
4172 * Set the request ID and return...
4175 ipp
->request
.any
.request_id
= request_id
;
4182 * 'ippSetResolution()' - Set a resolution value in an attribute.
4184 * The @code ipp@ parameter refers to an IPP message previously created using
4185 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
4187 * The @code attr@ parameter may be modified as a result of setting the value.
4189 * The @code element@ parameter specifies which value to set from 0 to
4190 * @code ippGetCount(attr)@.
4192 * @since CUPS 1.6/macOS 10.8@
4195 int /* O - 1 on success, 0 on failure */
4197 ipp_t
*ipp
, /* I - IPP message */
4198 ipp_attribute_t
**attr
, /* IO - IPP attribute */
4199 int element
, /* I - Value number (0-based) */
4200 ipp_res_t unitsvalue
, /* I - Resolution units */
4201 int xresvalue
, /* I - Horizontal/cross feed resolution */
4202 int yresvalue
) /* I - Vertical/feed resolution */
4204 _ipp_value_t
*value
; /* Current value */
4208 * Range check input...
4211 if (!ipp
|| !attr
|| !*attr
|| (*attr
)->value_tag
!= IPP_TAG_RESOLUTION
||
4212 element
< 0 || element
> (*attr
)->num_values
|| xresvalue
<= 0 || yresvalue
<= 0 ||
4213 unitsvalue
< IPP_RES_PER_INCH
|| unitsvalue
> IPP_RES_PER_CM
)
4217 * Set the value and return...
4220 if ((value
= ipp_set_value(ipp
, attr
, element
)) != NULL
)
4222 value
->resolution
.units
= unitsvalue
;
4223 value
->resolution
.xres
= xresvalue
;
4224 value
->resolution
.yres
= yresvalue
;
4227 return (value
!= NULL
);
4232 * 'ippSetState()' - Set the current state of the IPP message.
4234 * @since CUPS 1.6/macOS 10.8@
4237 int /* O - 1 on success, 0 on failure */
4238 ippSetState(ipp_t
*ipp
, /* I - IPP message */
4239 ipp_state_t state
) /* I - IPP state value */
4242 * Range check input...
4249 * Set the state and return...
4253 ipp
->current
= NULL
;
4260 * 'ippSetStatusCode()' - Set the status code in an IPP response or event message.
4262 * The @code ipp@ parameter refers to an IPP message previously created using
4263 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
4265 * @since CUPS 1.6/macOS 10.8@
4268 int /* O - 1 on success, 0 on failure */
4269 ippSetStatusCode(ipp_t
*ipp
, /* I - IPP response or event message */
4270 ipp_status_t status
) /* I - Status code */
4273 * Range check input...
4280 * Set the status code and return...
4283 ipp
->request
.status
.status_code
= status
;
4290 * 'ippSetString()' - Set a string value in an attribute.
4292 * The @code ipp@ parameter refers to an IPP message previously created using
4293 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
4295 * The @code attr@ parameter may be modified as a result of setting the value.
4297 * The @code element@ parameter specifies which value to set from 0 to
4298 * @code ippGetCount(attr)@.
4300 * @since CUPS 1.6/macOS 10.8@
4303 int /* O - 1 on success, 0 on failure */
4304 ippSetString(ipp_t
*ipp
, /* I - IPP message */
4305 ipp_attribute_t
**attr
, /* IO - IPP attribute */
4306 int element
, /* I - Value number (0-based) */
4307 const char *strvalue
) /* I - String value */
4309 char *temp
; /* Temporary string */
4310 _ipp_value_t
*value
; /* Current value */
4311 ipp_tag_t value_tag
; /* Value tag */
4315 * Range check input...
4319 value_tag
= (*attr
)->value_tag
& IPP_TAG_CUPS_MASK
;
4321 value_tag
= IPP_TAG_ZERO
;
4323 if (!ipp
|| !attr
|| !*attr
||
4324 (value_tag
< IPP_TAG_TEXT
&& value_tag
!= IPP_TAG_TEXTLANG
&&
4325 value_tag
!= IPP_TAG_NAMELANG
) || value_tag
> IPP_TAG_MIMETYPE
||
4330 * Set the value and return...
4333 if ((value
= ipp_set_value(ipp
, attr
, element
)) != NULL
)
4336 value
->string
.language
= (*attr
)->values
[0].string
.language
;
4338 if ((int)((*attr
)->value_tag
) & IPP_TAG_CUPS_CONST
)
4339 value
->string
.text
= (char *)strvalue
;
4340 else if ((temp
= _cupsStrAlloc(strvalue
)) != NULL
)
4342 if (value
->string
.text
)
4343 _cupsStrFree(value
->string
.text
);
4345 value
->string
.text
= temp
;
4351 return (value
!= NULL
);
4356 * 'ippSetStringf()' - Set a formatted string value of an attribute.
4358 * The @code ipp@ parameter refers to an IPP message previously created using
4359 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
4361 * The @code attr@ parameter may be modified as a result of setting the value.
4363 * The @code element@ parameter specifies which value to set from 0 to
4364 * @code ippGetCount(attr)@.
4366 * The @code format@ parameter uses formatting characters compatible with the
4367 * printf family of standard functions. Additional arguments follow it as
4368 * needed. The formatted string is truncated as needed to the maximum length of
4369 * the corresponding value type.
4371 * @since CUPS 1.7/macOS 10.9@
4374 int /* O - 1 on success, 0 on failure */
4375 ippSetStringf(ipp_t
*ipp
, /* I - IPP message */
4376 ipp_attribute_t
**attr
, /* IO - IPP attribute */
4377 int element
, /* I - Value number (0-based) */
4378 const char *format
, /* I - Printf-style format string */
4379 ...) /* I - Additional arguments as needed */
4381 int ret
; /* Return value */
4382 va_list ap
; /* Pointer to additional arguments */
4385 va_start(ap
, format
);
4386 ret
= ippSetStringfv(ipp
, attr
, element
, format
, ap
);
4394 * 'ippSetStringf()' - Set a formatted string value of an attribute.
4396 * The @code ipp@ parameter refers to an IPP message previously created using
4397 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
4399 * The @code attr@ parameter may be modified as a result of setting the value.
4401 * The @code element@ parameter specifies which value to set from 0 to
4402 * @code ippGetCount(attr)@.
4404 * The @code format@ parameter uses formatting characters compatible with the
4405 * printf family of standard functions. Additional arguments follow it as
4406 * needed. The formatted string is truncated as needed to the maximum length of
4407 * the corresponding value type.
4409 * @since CUPS 1.7/macOS 10.9@
4412 int /* O - 1 on success, 0 on failure */
4413 ippSetStringfv(ipp_t
*ipp
, /* I - IPP message */
4414 ipp_attribute_t
**attr
, /* IO - IPP attribute */
4415 int element
, /* I - Value number (0-based) */
4416 const char *format
, /* I - Printf-style format string */
4417 va_list ap
) /* I - Pointer to additional arguments */
4419 ipp_tag_t value_tag
; /* Value tag */
4420 char buffer
[IPP_MAX_TEXT
+ 4];
4421 /* Formatted text string */
4422 ssize_t bytes
, /* Length of formatted value */
4423 max_bytes
; /* Maximum number of bytes for value */
4427 * Range check input...
4431 value_tag
= (*attr
)->value_tag
& IPP_TAG_CUPS_MASK
;
4433 value_tag
= IPP_TAG_ZERO
;
4435 if (!ipp
|| !attr
|| !*attr
||
4436 (value_tag
< IPP_TAG_TEXT
&& value_tag
!= IPP_TAG_TEXTLANG
&&
4437 value_tag
!= IPP_TAG_NAMELANG
) || value_tag
> IPP_TAG_MIMETYPE
||
4442 * Format the string...
4445 if (!strcmp(format
, "%s"))
4448 * Optimize the simple case...
4451 const char *s
= va_arg(ap
, char *);
4456 bytes
= (ssize_t
)strlen(s
);
4457 strlcpy(buffer
, s
, sizeof(buffer
));
4462 * Do a full formatting of the message...
4465 if ((bytes
= vsnprintf(buffer
, sizeof(buffer
), format
, ap
)) < 0)
4470 * Limit the length of the string...
4477 case IPP_TAG_TEXTLANG
:
4478 max_bytes
= IPP_MAX_TEXT
;
4482 case IPP_TAG_NAMELANG
:
4483 max_bytes
= IPP_MAX_NAME
;
4486 case IPP_TAG_CHARSET
:
4487 max_bytes
= IPP_MAX_CHARSET
;
4490 case IPP_TAG_KEYWORD
:
4491 max_bytes
= IPP_MAX_KEYWORD
;
4494 case IPP_TAG_LANGUAGE
:
4495 max_bytes
= IPP_MAX_LANGUAGE
;
4498 case IPP_TAG_MIMETYPE
:
4499 max_bytes
= IPP_MAX_MIMETYPE
;
4503 max_bytes
= IPP_MAX_URI
;
4506 case IPP_TAG_URISCHEME
:
4507 max_bytes
= IPP_MAX_URISCHEME
;
4511 if (bytes
>= max_bytes
)
4513 char *bufmax
, /* Buffer at max_bytes */
4514 *bufptr
; /* Pointer into buffer */
4516 bufptr
= buffer
+ strlen(buffer
) - 1;
4517 bufmax
= buffer
+ max_bytes
- 1;
4519 while (bufptr
> bufmax
)
4523 while ((*bufptr
& 0xc0) == 0x80 && bufptr
> buffer
)
4534 * Set the formatted string and return...
4537 return (ippSetString(ipp
, attr
, element
, buffer
));
4542 * 'ippSetValueTag()' - Set the value tag of an attribute.
4544 * The @code ipp@ parameter refers to an IPP message previously created using
4545 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
4547 * The @code attr@ parameter may be modified as a result of setting the value.
4549 * Integer (@code IPP_TAG_INTEGER@) values can be promoted to rangeOfInteger
4550 * (@code IPP_TAG_RANGE@) values, the various string tags can be promoted to name
4551 * (@code IPP_TAG_NAME@) or nameWithLanguage (@code IPP_TAG_NAMELANG@) values, text
4552 * (@code IPP_TAG_TEXT@) values can be promoted to textWithLanguage
4553 * (@code IPP_TAG_TEXTLANG@) values, and all values can be demoted to the various
4554 * out-of-band value tags such as no-value (@code IPP_TAG_NOVALUE@). All other changes
4557 * Promoting a string attribute to nameWithLanguage or textWithLanguage adds the language
4558 * code in the "attributes-natural-language" attribute or, if not present, the language
4559 * code for the current locale.
4561 * @since CUPS 1.6/macOS 10.8@
4564 int /* O - 1 on success, 0 on failure */
4566 ipp_t
*ipp
, /* I - IPP message */
4567 ipp_attribute_t
**attr
, /* IO - IPP attribute */
4568 ipp_tag_t value_tag
) /* I - Value tag */
4570 int i
; /* Looping var */
4571 _ipp_value_t
*value
; /* Current value */
4572 int integer
; /* Current integer value */
4573 cups_lang_t
*language
; /* Current language */
4574 char code
[32]; /* Language code */
4575 ipp_tag_t temp_tag
; /* Temporary value tag */
4579 * Range check input...
4582 if (!ipp
|| !attr
|| !*attr
)
4586 * If there is no change, return immediately...
4589 if (value_tag
== (*attr
)->value_tag
)
4593 * Otherwise implement changes as needed...
4596 temp_tag
= (ipp_tag_t
)((int)((*attr
)->value_tag
) & IPP_TAG_CUPS_MASK
);
4600 case IPP_TAG_UNSUPPORTED_VALUE
:
4601 case IPP_TAG_DEFAULT
:
4602 case IPP_TAG_UNKNOWN
:
4603 case IPP_TAG_NOVALUE
:
4604 case IPP_TAG_NOTSETTABLE
:
4605 case IPP_TAG_DELETEATTR
:
4606 case IPP_TAG_ADMINDEFINE
:
4608 * Free any existing values...
4611 if ((*attr
)->num_values
> 0)
4612 ipp_free_values(*attr
, 0, (*attr
)->num_values
);
4615 * Set out-of-band value...
4618 (*attr
)->value_tag
= value_tag
;
4621 case IPP_TAG_RANGE
:
4622 if (temp_tag
!= IPP_TAG_INTEGER
)
4625 for (i
= (*attr
)->num_values
, value
= (*attr
)->values
;
4629 integer
= value
->integer
;
4630 value
->range
.lower
= value
->range
.upper
= integer
;
4633 (*attr
)->value_tag
= IPP_TAG_RANGE
;
4637 if (temp_tag
!= IPP_TAG_KEYWORD
&& temp_tag
!= IPP_TAG_URI
&&
4638 temp_tag
!= IPP_TAG_URISCHEME
&& temp_tag
!= IPP_TAG_LANGUAGE
&&
4639 temp_tag
!= IPP_TAG_MIMETYPE
)
4642 (*attr
)->value_tag
= (ipp_tag_t
)(IPP_TAG_NAME
| ((*attr
)->value_tag
& IPP_TAG_CUPS_CONST
));
4645 case IPP_TAG_NAMELANG
:
4646 case IPP_TAG_TEXTLANG
:
4647 if (value_tag
== IPP_TAG_NAMELANG
&&
4648 (temp_tag
!= IPP_TAG_NAME
&& temp_tag
!= IPP_TAG_KEYWORD
&&
4649 temp_tag
!= IPP_TAG_URI
&& temp_tag
!= IPP_TAG_URISCHEME
&&
4650 temp_tag
!= IPP_TAG_LANGUAGE
&& temp_tag
!= IPP_TAG_MIMETYPE
))
4653 if (value_tag
== IPP_TAG_TEXTLANG
&& temp_tag
!= IPP_TAG_TEXT
)
4656 if (ipp
->attrs
&& ipp
->attrs
->next
&& ipp
->attrs
->next
->name
&&
4657 !strcmp(ipp
->attrs
->next
->name
, "attributes-natural-language"))
4660 * Use the language code from the IPP message...
4663 (*attr
)->values
[0].string
.language
=
4664 _cupsStrAlloc(ipp
->attrs
->next
->values
[0].string
.text
);
4669 * Otherwise, use the language code corresponding to the locale...
4672 language
= cupsLangDefault();
4673 (*attr
)->values
[0].string
.language
= _cupsStrAlloc(ipp_lang_code(language
->language
,
4678 for (i
= (*attr
)->num_values
- 1, value
= (*attr
)->values
+ 1;
4681 value
->string
.language
= (*attr
)->values
[0].string
.language
;
4683 if ((int)(*attr
)->value_tag
& IPP_TAG_CUPS_CONST
)
4686 * Make copies of all values...
4689 for (i
= (*attr
)->num_values
, value
= (*attr
)->values
;
4692 value
->string
.text
= _cupsStrAlloc(value
->string
.text
);
4695 (*attr
)->value_tag
= IPP_TAG_NAMELANG
;
4698 case IPP_TAG_KEYWORD
:
4699 if (temp_tag
== IPP_TAG_NAME
|| temp_tag
== IPP_TAG_NAMELANG
)
4700 break; /* Silently "allow" name -> keyword */
4711 * 'ippSetVersion()' - Set the version number in an IPP message.
4713 * The @code ipp@ parameter refers to an IPP message previously created using
4714 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
4716 * The valid version numbers are currently 1.0, 1.1, 2.0, 2.1, and 2.2.
4718 * @since CUPS 1.6/macOS 10.8@
4721 int /* O - 1 on success, 0 on failure */
4722 ippSetVersion(ipp_t
*ipp
, /* I - IPP message */
4723 int major
, /* I - Major version number (major.minor) */
4724 int minor
) /* I - Minor version number (major.minor) */
4727 * Range check input...
4730 if (!ipp
|| major
< 0 || minor
< 0)
4734 * Set the version number...
4737 ipp
->request
.any
.version
[0] = (ipp_uchar_t
)major
;
4738 ipp
->request
.any
.version
[1] = (ipp_uchar_t
)minor
;
4745 * 'ippTimeToDate()' - Convert from time in seconds to RFC 2579 format.
4748 const ipp_uchar_t
* /* O - RFC-2579 date/time data */
4749 ippTimeToDate(time_t t
) /* I - Time in seconds */
4751 struct tm
*unixdate
; /* UNIX unixdate/time info */
4752 ipp_uchar_t
*date
= _cupsGlobals()->ipp_date
;
4753 /* RFC-2579 date/time data */
4757 * RFC-2579 date/time format is:
4759 * Byte(s) Description
4760 * ------- -----------
4761 * 0-1 Year (0 to 65535)
4765 * 5 Minutes (0 to 59)
4766 * 6 Seconds (0 to 60, 60 = "leap second")
4767 * 7 Deciseconds (0 to 9)
4769 * 9 UTC hours (0 to 11)
4770 * 10 UTC minutes (0 to 59)
4773 unixdate
= gmtime(&t
);
4774 unixdate
->tm_year
+= 1900;
4776 date
[0] = (ipp_uchar_t
)(unixdate
->tm_year
>> 8);
4777 date
[1] = (ipp_uchar_t
)(unixdate
->tm_year
);
4778 date
[2] = (ipp_uchar_t
)(unixdate
->tm_mon
+ 1);
4779 date
[3] = (ipp_uchar_t
)unixdate
->tm_mday
;
4780 date
[4] = (ipp_uchar_t
)unixdate
->tm_hour
;
4781 date
[5] = (ipp_uchar_t
)unixdate
->tm_min
;
4782 date
[6] = (ipp_uchar_t
)unixdate
->tm_sec
;
4793 * 'ippValidateAttribute()' - Validate the contents of an attribute.
4795 * This function validates the contents of an attribute based on the name and
4796 * value tag. 1 is returned if the attribute is valid, 0 otherwise. On
4797 * failure, @link cupsLastErrorString@ is set to a human-readable message.
4799 * @since CUPS 1.7/macOS 10.9@
4802 int /* O - 1 if valid, 0 otherwise */
4803 ippValidateAttribute(
4804 ipp_attribute_t
*attr
) /* I - Attribute */
4806 int i
; /* Looping var */
4807 char scheme
[64], /* Scheme from URI */
4808 userpass
[256], /* Username/password from URI */
4809 hostname
[256], /* Hostname from URI */
4810 resource
[1024]; /* Resource from URI */
4811 int port
, /* Port number from URI */
4812 uri_status
; /* URI separation status */
4813 const char *ptr
; /* Pointer into string */
4814 ipp_attribute_t
*colattr
; /* Collection attribute */
4815 regex_t re
; /* Regular expression */
4816 ipp_uchar_t
*date
; /* Current date value */
4827 * Validate the attribute name.
4830 for (ptr
= attr
->name
; *ptr
; ptr
++)
4831 if (!isalnum(*ptr
& 255) && *ptr
!= '-' && *ptr
!= '.' && *ptr
!= '_')
4834 if (*ptr
|| ptr
== attr
->name
)
4836 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad attribute name - invalid character (RFC 8011 section 5.1.4)."), attr
->name
);
4840 if ((ptr
- attr
->name
) > 255)
4842 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
));
4846 switch (attr
->value_tag
)
4848 case IPP_TAG_INTEGER
:
4851 case IPP_TAG_BOOLEAN
:
4852 for (i
= 0; i
< attr
->num_values
; i
++)
4854 if (attr
->values
[i
].boolean
!= 0 &&
4855 attr
->values
[i
].boolean
!= 1)
4857 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
);
4864 for (i
= 0; i
< attr
->num_values
; i
++)
4866 if (attr
->values
[i
].integer
< 1)
4868 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
);
4874 case IPP_TAG_STRING
:
4875 for (i
= 0; i
< attr
->num_values
; i
++)
4877 if (attr
->values
[i
].unknown
.length
> IPP_MAX_OCTETSTRING
)
4879 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
);
4886 for (i
= 0; i
< attr
->num_values
; i
++)
4888 date
= attr
->values
[i
].date
;
4890 if (date
[2] < 1 || date
[2] > 12)
4892 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad dateTime month %u (RFC 8011 section 5.1.15)."), attr
->name
, date
[2]);
4896 if (date
[3] < 1 || date
[3] > 31)
4898 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad dateTime day %u (RFC 8011 section 5.1.15)."), attr
->name
, date
[3]);
4904 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad dateTime hours %u (RFC 8011 section 5.1.15)."), attr
->name
, date
[4]);
4910 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad dateTime minutes %u (RFC 8011 section 5.1.15)."), attr
->name
, date
[5]);
4916 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad dateTime seconds %u (RFC 8011 section 5.1.15)."), attr
->name
, date
[6]);
4922 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad dateTime deciseconds %u (RFC 8011 section 5.1.15)."), attr
->name
, date
[7]);
4926 if (date
[8] != '-' && date
[8] != '+')
4928 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad dateTime UTC sign '%c' (RFC 8011 section 5.1.15)."), attr
->name
, date
[8]);
4934 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad dateTime UTC hours %u (RFC 8011 section 5.1.15)."), attr
->name
, date
[9]);
4940 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad dateTime UTC minutes %u (RFC 8011 section 5.1.15)."), attr
->name
, date
[10]);
4946 case IPP_TAG_RESOLUTION
:
4947 for (i
= 0; i
< attr
->num_values
; i
++)
4949 if (attr
->values
[i
].resolution
.xres
<= 0)
4951 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");
4955 if (attr
->values
[i
].resolution
.yres
<= 0)
4957 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");
4961 if (attr
->values
[i
].resolution
.units
!= IPP_RES_PER_INCH
&& attr
->values
[i
].resolution
.units
!= IPP_RES_PER_CM
)
4963 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");
4969 case IPP_TAG_RANGE
:
4970 for (i
= 0; i
< attr
->num_values
; i
++)
4972 if (attr
->values
[i
].range
.lower
> attr
->values
[i
].range
.upper
)
4974 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
);
4980 case IPP_TAG_BEGIN_COLLECTION
:
4981 for (i
= 0; i
< attr
->num_values
; i
++)
4983 for (colattr
= attr
->values
[i
].collection
->attrs
;
4985 colattr
= colattr
->next
)
4987 if (!ippValidateAttribute(colattr
))
4994 case IPP_TAG_TEXTLANG
:
4995 for (i
= 0; i
< attr
->num_values
; i
++)
4997 for (ptr
= attr
->values
[i
].string
.text
; *ptr
; ptr
++)
4999 if ((*ptr
& 0xe0) == 0xc0)
5002 if ((*ptr
& 0xc0) != 0x80)
5005 else if ((*ptr
& 0xf0) == 0xe0)
5008 if ((*ptr
& 0xc0) != 0x80)
5011 if ((*ptr
& 0xc0) != 0x80)
5014 else if ((*ptr
& 0xf8) == 0xf0)
5017 if ((*ptr
& 0xc0) != 0x80)
5020 if ((*ptr
& 0xc0) != 0x80)
5023 if ((*ptr
& 0xc0) != 0x80)
5026 else if (*ptr
& 0x80)
5028 else if ((*ptr
< ' ' && *ptr
!= '\n' && *ptr
!= '\r' && *ptr
!= '\t') || *ptr
== 0x7f)
5034 if (*ptr
< ' ' || *ptr
== 0x7f)
5036 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
);
5041 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
);
5046 if ((ptr
- attr
->values
[i
].string
.text
) > (IPP_MAX_TEXT
- 1))
5048 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
));
5055 case IPP_TAG_NAMELANG
:
5056 for (i
= 0; i
< attr
->num_values
; i
++)
5058 for (ptr
= attr
->values
[i
].string
.text
; *ptr
; ptr
++)
5060 if ((*ptr
& 0xe0) == 0xc0)
5063 if ((*ptr
& 0xc0) != 0x80)
5066 else if ((*ptr
& 0xf0) == 0xe0)
5069 if ((*ptr
& 0xc0) != 0x80)
5072 if ((*ptr
& 0xc0) != 0x80)
5075 else if ((*ptr
& 0xf8) == 0xf0)
5078 if ((*ptr
& 0xc0) != 0x80)
5081 if ((*ptr
& 0xc0) != 0x80)
5084 if ((*ptr
& 0xc0) != 0x80)
5087 else if (*ptr
& 0x80)
5089 else if (*ptr
< ' ' || *ptr
== 0x7f)
5095 if (*ptr
< ' ' || *ptr
== 0x7f)
5097 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
);
5102 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
);
5107 if ((ptr
- attr
->values
[i
].string
.text
) > (IPP_MAX_NAME
- 1))
5109 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
));
5115 case IPP_TAG_KEYWORD
:
5116 for (i
= 0; i
< attr
->num_values
; i
++)
5118 for (ptr
= attr
->values
[i
].string
.text
; *ptr
; ptr
++)
5120 if (!isalnum(*ptr
& 255) && *ptr
!= '-' && *ptr
!= '.' &&
5125 if (*ptr
|| ptr
== attr
->values
[i
].string
.text
)
5127 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
);
5131 if ((ptr
- attr
->values
[i
].string
.text
) > (IPP_MAX_KEYWORD
- 1))
5133 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
));
5140 for (i
= 0; i
< attr
->num_values
; i
++)
5142 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
));
5144 if (uri_status
< HTTP_URI_STATUS_OK
)
5146 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
));
5150 if (strlen(attr
->values
[i
].string
.text
) > (IPP_MAX_URI
- 1))
5152 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
));
5157 case IPP_TAG_URISCHEME
:
5158 for (i
= 0; i
< attr
->num_values
; i
++)
5160 ptr
= attr
->values
[i
].string
.text
;
5161 if (islower(*ptr
& 255))
5163 for (ptr
++; *ptr
; ptr
++)
5165 if (!islower(*ptr
& 255) && !isdigit(*ptr
& 255) &&
5166 *ptr
!= '+' && *ptr
!= '-' && *ptr
!= '.')
5171 if (*ptr
|| ptr
== attr
->values
[i
].string
.text
)
5173 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
);
5177 if ((ptr
- attr
->values
[i
].string
.text
) > (IPP_MAX_URISCHEME
- 1))
5179 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
));
5185 case IPP_TAG_CHARSET
:
5186 for (i
= 0; i
< attr
->num_values
; i
++)
5188 for (ptr
= attr
->values
[i
].string
.text
; *ptr
; ptr
++)
5190 if (!isprint(*ptr
& 255) || isupper(*ptr
& 255) ||
5191 isspace(*ptr
& 255))
5195 if (*ptr
|| ptr
== attr
->values
[i
].string
.text
)
5197 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
);
5201 if ((ptr
- attr
->values
[i
].string
.text
) > (IPP_MAX_CHARSET
- 1))
5203 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
));
5209 case IPP_TAG_LANGUAGE
:
5211 * The following regular expression is derived from the ABNF for
5212 * language tags in RFC 4646. All I can say is that this is the
5213 * easiest way to check the values...
5216 if ((i
= regcomp(&re
,
5218 "(([a-z]{2,3}(-[a-z][a-z][a-z]){0,3})|[a-z]{4,8})"
5220 "(-[a-z][a-z][a-z][a-z]){0,1}" /* script */
5221 "(-([a-z][a-z]|[0-9][0-9][0-9])){0,1}" /* region */
5222 "(-([a-z]{5,8}|[0-9][0-9][0-9]))*" /* variant */
5223 "(-[a-wy-z](-[a-z0-9]{2,8})+)*" /* extension */
5224 "(-x(-[a-z0-9]{1,8})+)*" /* privateuse */
5226 "x(-[a-z0-9]{1,8})+" /* privateuse */
5228 "[a-z]{1,3}(-[a-z][0-9]{2,8}){1,2}" /* grandfathered */
5230 REG_NOSUB
| REG_EXTENDED
)) != 0)
5232 char temp
[256]; /* Temporary error string */
5234 regerror(i
, &re
, temp
, sizeof(temp
));
5235 ipp_set_error(IPP_STATUS_ERROR_INTERNAL
, _("Unable to compile naturalLanguage regular expression: %s."), temp
);
5239 for (i
= 0; i
< attr
->num_values
; i
++)
5241 if (regexec(&re
, attr
->values
[i
].string
.text
, 0, NULL
, 0))
5243 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
);
5248 if (strlen(attr
->values
[i
].string
.text
) > (IPP_MAX_LANGUAGE
- 1))
5250 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
));
5259 case IPP_TAG_MIMETYPE
:
5261 * The following regular expression is derived from the ABNF for
5262 * MIME media types in RFC 2045 and 4288. All I can say is that this is
5263 * the easiest way to check the values...
5266 if ((i
= regcomp(&re
,
5268 "[-a-zA-Z0-9!#$&.+^_]{1,127}" /* type-name */
5270 "[-a-zA-Z0-9!#$&.+^_]{1,127}" /* subtype-name */
5271 "(;[-a-zA-Z0-9!#$&.+^_]{1,127}=" /* parameter= */
5272 "([-a-zA-Z0-9!#$&.+^_]{1,127}|\"[^\"]*\"))*"
5275 REG_NOSUB
| REG_EXTENDED
)) != 0)
5277 char temp
[256]; /* Temporary error string */
5279 regerror(i
, &re
, temp
, sizeof(temp
));
5280 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("Unable to compile mimeMediaType regular expression: %s."), temp
);
5284 for (i
= 0; i
< attr
->num_values
; i
++)
5286 if (regexec(&re
, attr
->values
[i
].string
.text
, 0, NULL
, 0))
5288 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
);
5293 if (strlen(attr
->values
[i
].string
.text
) > (IPP_MAX_MIMETYPE
- 1))
5295 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
));
5313 * 'ippValidateAttributes()' - Validate all attributes in an IPP message.
5315 * This function validates the contents of the IPP message, including each
5316 * attribute. Like @link ippValidateAttribute@, @link cupsLastErrorString@ is
5317 * set to a human-readable message on failure.
5319 * @since CUPS 1.7/macOS 10.9@
5322 int /* O - 1 if valid, 0 otherwise */
5323 ippValidateAttributes(ipp_t
*ipp
) /* I - IPP message */
5325 ipp_attribute_t
*attr
; /* Current attribute */
5331 for (attr
= ipp
->attrs
; attr
; attr
= attr
->next
)
5332 if (!ippValidateAttribute(attr
))
5340 * 'ippWrite()' - Write data for an IPP message to a HTTP connection.
5343 ipp_state_t
/* O - Current state */
5344 ippWrite(http_t
*http
, /* I - HTTP connection */
5345 ipp_t
*ipp
) /* I - IPP data */
5347 DEBUG_printf(("ippWrite(http=%p, ipp=%p)", (void *)http
, (void *)ipp
));
5350 return (IPP_STATE_ERROR
);
5352 return (ippWriteIO(http
, (ipp_iocb_t
)httpWrite2
, http
->blocking
, NULL
, ipp
));
5357 * 'ippWriteFile()' - Write data for an IPP message to a file.
5359 * @since CUPS 1.1.19/macOS 10.3@
5362 ipp_state_t
/* O - Current state */
5363 ippWriteFile(int fd
, /* I - HTTP data */
5364 ipp_t
*ipp
) /* I - IPP data */
5366 DEBUG_printf(("ippWriteFile(fd=%d, ipp=%p)", fd
, (void *)ipp
));
5368 ipp
->state
= IPP_STATE_IDLE
;
5370 return (ippWriteIO(&fd
, (ipp_iocb_t
)ipp_write_file
, 1, NULL
, ipp
));
5375 * 'ippWriteIO()' - Write data for an IPP message.
5377 * @since CUPS 1.2/macOS 10.5@
5380 ipp_state_t
/* O - Current state */
5381 ippWriteIO(void *dst
, /* I - Destination */
5382 ipp_iocb_t cb
, /* I - Write callback function */
5383 int blocking
, /* I - Use blocking IO? */
5384 ipp_t
*parent
, /* I - Parent IPP message */
5385 ipp_t
*ipp
) /* I - IPP data */
5387 int i
; /* Looping var */
5388 int n
; /* Length of data */
5389 unsigned char *buffer
, /* Data buffer */
5390 *bufptr
; /* Pointer into buffer */
5391 ipp_attribute_t
*attr
; /* Current attribute */
5392 _ipp_value_t
*value
; /* Current value */
5395 DEBUG_printf(("ippWriteIO(dst=%p, cb=%p, blocking=%d, parent=%p, ipp=%p)", (void *)dst
, (void *)cb
, blocking
, (void *)parent
, (void *)ipp
));
5398 return (IPP_STATE_ERROR
);
5400 if ((buffer
= (unsigned char *)_cupsBufferGet(IPP_BUF_SIZE
)) == NULL
)
5402 DEBUG_puts("1ippWriteIO: Unable to get write buffer");
5403 return (IPP_STATE_ERROR
);
5408 case IPP_STATE_IDLE
:
5409 ipp
->state
++; /* Avoid common problem... */
5411 case IPP_STATE_HEADER
:
5415 * Send the request header:
5418 * Operation/Status Code = 2 bytes
5419 * Request ID = 4 bytes
5425 *bufptr
++ = ipp
->request
.any
.version
[0];
5426 *bufptr
++ = ipp
->request
.any
.version
[1];
5427 *bufptr
++ = (ipp_uchar_t
)(ipp
->request
.any
.op_status
>> 8);
5428 *bufptr
++ = (ipp_uchar_t
)ipp
->request
.any
.op_status
;
5429 *bufptr
++ = (ipp_uchar_t
)(ipp
->request
.any
.request_id
>> 24);
5430 *bufptr
++ = (ipp_uchar_t
)(ipp
->request
.any
.request_id
>> 16);
5431 *bufptr
++ = (ipp_uchar_t
)(ipp
->request
.any
.request_id
>> 8);
5432 *bufptr
++ = (ipp_uchar_t
)ipp
->request
.any
.request_id
;
5434 DEBUG_printf(("2ippWriteIO: version=%d.%d", buffer
[0], buffer
[1]));
5435 DEBUG_printf(("2ippWriteIO: op_status=%04x",
5436 ipp
->request
.any
.op_status
));
5437 DEBUG_printf(("2ippWriteIO: request_id=%d",
5438 ipp
->request
.any
.request_id
));
5440 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
5442 DEBUG_puts("1ippWriteIO: Could not write IPP header...");
5443 _cupsBufferRelease((char *)buffer
);
5444 return (IPP_STATE_ERROR
);
5449 * Reset the state engine to point to the first attribute
5450 * in the request/response, with no current group.
5453 ipp
->state
= IPP_STATE_ATTRIBUTE
;
5454 ipp
->current
= ipp
->attrs
;
5455 ipp
->curtag
= IPP_TAG_ZERO
;
5457 DEBUG_printf(("1ippWriteIO: ipp->current=%p", (void *)ipp
->current
));
5460 * If blocking is disabled, stop here...
5466 case IPP_STATE_ATTRIBUTE
:
5467 while (ipp
->current
!= NULL
)
5470 * Write this attribute...
5474 attr
= ipp
->current
;
5476 ipp
->current
= ipp
->current
->next
;
5480 if (ipp
->curtag
!= attr
->group_tag
)
5483 * Send a group tag byte...
5486 ipp
->curtag
= attr
->group_tag
;
5488 if (attr
->group_tag
== IPP_TAG_ZERO
)
5491 DEBUG_printf(("2ippWriteIO: wrote group tag=%x(%s)",
5492 attr
->group_tag
, ippTagString(attr
->group_tag
)));
5493 *bufptr
++ = (ipp_uchar_t
)attr
->group_tag
;
5495 else if (attr
->group_tag
== IPP_TAG_ZERO
)
5499 DEBUG_printf(("1ippWriteIO: %s (%s%s)", attr
->name
,
5500 attr
->num_values
> 1 ? "1setOf " : "",
5501 ippTagString(attr
->value_tag
)));
5504 * Write the attribute tag and name.
5506 * The attribute name length does not include the trailing nul
5507 * character in the source string.
5509 * Collection values (parent != NULL) are written differently...
5515 * Get the length of the attribute name, and make sure it won't
5516 * overflow the buffer...
5519 if ((n
= (int)strlen(attr
->name
)) > (IPP_BUF_SIZE
- 8))
5521 DEBUG_printf(("1ippWriteIO: Attribute name too long (%d)", n
));
5522 _cupsBufferRelease((char *)buffer
);
5523 return (IPP_STATE_ERROR
);
5527 * Write the value tag, name length, and name string...
5530 DEBUG_printf(("2ippWriteIO: writing value tag=%x(%s)",
5531 attr
->value_tag
, ippTagString(attr
->value_tag
)));
5532 DEBUG_printf(("2ippWriteIO: writing name=%d,\"%s\"", n
,
5535 if (attr
->value_tag
> 0xff)
5537 *bufptr
++ = IPP_TAG_EXTENSION
;
5538 *bufptr
++ = (ipp_uchar_t
)(attr
->value_tag
>> 24);
5539 *bufptr
++ = (ipp_uchar_t
)(attr
->value_tag
>> 16);
5540 *bufptr
++ = (ipp_uchar_t
)(attr
->value_tag
>> 8);
5541 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
5544 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
5546 *bufptr
++ = (ipp_uchar_t
)(n
>> 8);
5547 *bufptr
++ = (ipp_uchar_t
)n
;
5548 memcpy(bufptr
, attr
->name
, (size_t)n
);
5554 * Get the length of the attribute name, and make sure it won't
5555 * overflow the buffer...
5558 if ((n
= (int)strlen(attr
->name
)) > (IPP_BUF_SIZE
- 12))
5560 DEBUG_printf(("1ippWriteIO: Attribute name too long (%d)", n
));
5561 _cupsBufferRelease((char *)buffer
);
5562 return (IPP_STATE_ERROR
);
5566 * Write the member name tag, name length, name string, value tag,
5567 * and empty name for the collection member attribute...
5570 DEBUG_printf(("2ippWriteIO: writing value tag=%x(memberName)",
5571 IPP_TAG_MEMBERNAME
));
5572 DEBUG_printf(("2ippWriteIO: writing name=%d,\"%s\"", n
,
5574 DEBUG_printf(("2ippWriteIO: writing value tag=%x(%s)",
5575 attr
->value_tag
, ippTagString(attr
->value_tag
)));
5576 DEBUG_puts("2ippWriteIO: writing name=0,\"\"");
5578 *bufptr
++ = IPP_TAG_MEMBERNAME
;
5581 *bufptr
++ = (ipp_uchar_t
)(n
>> 8);
5582 *bufptr
++ = (ipp_uchar_t
)n
;
5583 memcpy(bufptr
, attr
->name
, (size_t)n
);
5586 if (attr
->value_tag
> 0xff)
5588 *bufptr
++ = IPP_TAG_EXTENSION
;
5589 *bufptr
++ = (ipp_uchar_t
)(attr
->value_tag
>> 24);
5590 *bufptr
++ = (ipp_uchar_t
)(attr
->value_tag
>> 16);
5591 *bufptr
++ = (ipp_uchar_t
)(attr
->value_tag
>> 8);
5592 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
5595 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
5602 * Now write the attribute value(s)...
5605 switch (attr
->value_tag
& ~IPP_TAG_CUPS_CONST
)
5607 case IPP_TAG_UNSUPPORTED_VALUE
:
5608 case IPP_TAG_DEFAULT
:
5609 case IPP_TAG_UNKNOWN
:
5610 case IPP_TAG_NOVALUE
:
5611 case IPP_TAG_NOTSETTABLE
:
5612 case IPP_TAG_DELETEATTR
:
5613 case IPP_TAG_ADMINDEFINE
:
5618 case IPP_TAG_INTEGER
:
5620 for (i
= 0, value
= attr
->values
;
5621 i
< attr
->num_values
;
5624 if ((IPP_BUF_SIZE
- (bufptr
- buffer
)) < 9)
5626 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
5628 DEBUG_puts("1ippWriteIO: Could not write IPP "
5630 _cupsBufferRelease((char *)buffer
);
5631 return (IPP_STATE_ERROR
);
5640 * Arrays and sets are done by sending additional
5641 * values with a zero-length name...
5644 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
5650 * Integers and enumerations are both 4-byte signed
5651 * (twos-complement) values.
5653 * Put the 2-byte length and 4-byte value into the buffer...
5658 *bufptr
++ = (ipp_uchar_t
)(value
->integer
>> 24);
5659 *bufptr
++ = (ipp_uchar_t
)(value
->integer
>> 16);
5660 *bufptr
++ = (ipp_uchar_t
)(value
->integer
>> 8);
5661 *bufptr
++ = (ipp_uchar_t
)value
->integer
;
5665 case IPP_TAG_BOOLEAN
:
5666 for (i
= 0, value
= attr
->values
;
5667 i
< attr
->num_values
;
5670 if ((IPP_BUF_SIZE
- (bufptr
- buffer
)) < 6)
5672 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
5674 DEBUG_puts("1ippWriteIO: Could not write IPP "
5676 _cupsBufferRelease((char *)buffer
);
5677 return (IPP_STATE_ERROR
);
5686 * Arrays and sets are done by sending additional
5687 * values with a zero-length name...
5690 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
5696 * Boolean values are 1-byte; 0 = false, 1 = true.
5698 * Put the 2-byte length and 1-byte value into the buffer...
5703 *bufptr
++ = (ipp_uchar_t
)value
->boolean
;
5709 case IPP_TAG_KEYWORD
:
5711 case IPP_TAG_URISCHEME
:
5712 case IPP_TAG_CHARSET
:
5713 case IPP_TAG_LANGUAGE
:
5714 case IPP_TAG_MIMETYPE
:
5715 for (i
= 0, value
= attr
->values
;
5716 i
< attr
->num_values
;
5722 * Arrays and sets are done by sending additional
5723 * values with a zero-length name...
5726 DEBUG_printf(("2ippWriteIO: writing value tag=%x(%s)",
5728 ippTagString(attr
->value_tag
)));
5729 DEBUG_printf(("2ippWriteIO: writing name=0,\"\""));
5731 if ((IPP_BUF_SIZE
- (bufptr
- buffer
)) < 3)
5733 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
5735 DEBUG_puts("1ippWriteIO: Could not write IPP "
5737 _cupsBufferRelease((char *)buffer
);
5738 return (IPP_STATE_ERROR
);
5744 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
5749 if (value
->string
.text
!= NULL
)
5750 n
= (int)strlen(value
->string
.text
);
5754 if (n
> (IPP_BUF_SIZE
- 2))
5756 DEBUG_printf(("1ippWriteIO: String too long (%d)", n
));
5757 _cupsBufferRelease((char *)buffer
);
5758 return (IPP_STATE_ERROR
);
5761 DEBUG_printf(("2ippWriteIO: writing string=%d,\"%s\"", n
,
5762 value
->string
.text
));
5764 if ((int)(IPP_BUF_SIZE
- (bufptr
- buffer
)) < (n
+ 2))
5766 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
5768 DEBUG_puts("1ippWriteIO: Could not write IPP "
5770 _cupsBufferRelease((char *)buffer
);
5771 return (IPP_STATE_ERROR
);
5778 * All simple strings consist of the 2-byte length and
5779 * character data without the trailing nul normally found
5780 * in C strings. Also, strings cannot be longer than IPP_MAX_LENGTH
5781 * bytes since the 2-byte length is a signed (twos-complement)
5784 * Put the 2-byte length and string characters in the buffer.
5787 *bufptr
++ = (ipp_uchar_t
)(n
>> 8);
5788 *bufptr
++ = (ipp_uchar_t
)n
;
5792 memcpy(bufptr
, value
->string
.text
, (size_t)n
);
5799 for (i
= 0, value
= attr
->values
;
5800 i
< attr
->num_values
;
5803 if ((IPP_BUF_SIZE
- (bufptr
- buffer
)) < 16)
5805 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
5807 DEBUG_puts("1ippWriteIO: Could not write IPP "
5809 _cupsBufferRelease((char *)buffer
);
5810 return (IPP_STATE_ERROR
);
5819 * Arrays and sets are done by sending additional
5820 * values with a zero-length name...
5823 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
5829 * Date values consist of a 2-byte length and an
5830 * 11-byte date/time structure defined by RFC 1903.
5832 * Put the 2-byte length and 11-byte date/time
5833 * structure in the buffer.
5838 memcpy(bufptr
, value
->date
, 11);
5843 case IPP_TAG_RESOLUTION
:
5844 for (i
= 0, value
= attr
->values
;
5845 i
< attr
->num_values
;
5848 if ((IPP_BUF_SIZE
- (bufptr
- buffer
)) < 14)
5850 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
5852 DEBUG_puts("1ippWriteIO: Could not write IPP "
5854 _cupsBufferRelease((char *)buffer
);
5855 return (IPP_STATE_ERROR
);
5864 * Arrays and sets are done by sending additional
5865 * values with a zero-length name...
5868 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
5874 * Resolution values consist of a 2-byte length,
5875 * 4-byte horizontal resolution value, 4-byte vertical
5876 * resolution value, and a 1-byte units value.
5878 * Put the 2-byte length and resolution value data
5884 *bufptr
++ = (ipp_uchar_t
)(value
->resolution
.xres
>> 24);
5885 *bufptr
++ = (ipp_uchar_t
)(value
->resolution
.xres
>> 16);
5886 *bufptr
++ = (ipp_uchar_t
)(value
->resolution
.xres
>> 8);
5887 *bufptr
++ = (ipp_uchar_t
)value
->resolution
.xres
;
5888 *bufptr
++ = (ipp_uchar_t
)(value
->resolution
.yres
>> 24);
5889 *bufptr
++ = (ipp_uchar_t
)(value
->resolution
.yres
>> 16);
5890 *bufptr
++ = (ipp_uchar_t
)(value
->resolution
.yres
>> 8);
5891 *bufptr
++ = (ipp_uchar_t
)value
->resolution
.yres
;
5892 *bufptr
++ = (ipp_uchar_t
)value
->resolution
.units
;
5896 case IPP_TAG_RANGE
:
5897 for (i
= 0, value
= attr
->values
;
5898 i
< attr
->num_values
;
5901 if ((IPP_BUF_SIZE
- (bufptr
- buffer
)) < 13)
5903 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
5905 DEBUG_puts("1ippWriteIO: Could not write IPP "
5907 _cupsBufferRelease((char *)buffer
);
5908 return (IPP_STATE_ERROR
);
5917 * Arrays and sets are done by sending additional
5918 * values with a zero-length name...
5921 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
5927 * Range values consist of a 2-byte length,
5928 * 4-byte lower value, and 4-byte upper value.
5930 * Put the 2-byte length and range value data
5936 *bufptr
++ = (ipp_uchar_t
)(value
->range
.lower
>> 24);
5937 *bufptr
++ = (ipp_uchar_t
)(value
->range
.lower
>> 16);
5938 *bufptr
++ = (ipp_uchar_t
)(value
->range
.lower
>> 8);
5939 *bufptr
++ = (ipp_uchar_t
)value
->range
.lower
;
5940 *bufptr
++ = (ipp_uchar_t
)(value
->range
.upper
>> 24);
5941 *bufptr
++ = (ipp_uchar_t
)(value
->range
.upper
>> 16);
5942 *bufptr
++ = (ipp_uchar_t
)(value
->range
.upper
>> 8);
5943 *bufptr
++ = (ipp_uchar_t
)value
->range
.upper
;
5947 case IPP_TAG_TEXTLANG
:
5948 case IPP_TAG_NAMELANG
:
5949 for (i
= 0, value
= attr
->values
;
5950 i
< attr
->num_values
;
5956 * Arrays and sets are done by sending additional
5957 * values with a zero-length name...
5960 if ((IPP_BUF_SIZE
- (bufptr
- buffer
)) < 3)
5962 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
5964 DEBUG_puts("1ippWriteIO: Could not write IPP "
5966 _cupsBufferRelease((char *)buffer
);
5967 return (IPP_STATE_ERROR
);
5973 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
5979 * textWithLanguage and nameWithLanguage values consist
5980 * of a 2-byte length for both strings and their
5981 * individual lengths, a 2-byte length for the
5982 * character string, the character string without the
5983 * trailing nul, a 2-byte length for the character
5984 * set string, and the character set string without
5990 if (value
->string
.language
!= NULL
)
5991 n
+= (int)strlen(value
->string
.language
);
5993 if (value
->string
.text
!= NULL
)
5994 n
+= (int)strlen(value
->string
.text
);
5996 if (n
> (IPP_BUF_SIZE
- 2))
5998 DEBUG_printf(("1ippWriteIO: text/nameWithLanguage value "
5999 "too long (%d)", n
));
6000 _cupsBufferRelease((char *)buffer
);
6001 return (IPP_STATE_ERROR
);
6004 if ((int)(IPP_BUF_SIZE
- (bufptr
- buffer
)) < (n
+ 2))
6006 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
6008 DEBUG_puts("1ippWriteIO: Could not write IPP "
6010 _cupsBufferRelease((char *)buffer
);
6011 return (IPP_STATE_ERROR
);
6017 /* Length of entire value */
6018 *bufptr
++ = (ipp_uchar_t
)(n
>> 8);
6019 *bufptr
++ = (ipp_uchar_t
)n
;
6021 /* Length of language */
6022 if (value
->string
.language
!= NULL
)
6023 n
= (int)strlen(value
->string
.language
);
6027 *bufptr
++ = (ipp_uchar_t
)(n
>> 8);
6028 *bufptr
++ = (ipp_uchar_t
)n
;
6033 memcpy(bufptr
, value
->string
.language
, (size_t)n
);
6037 /* Length of text */
6038 if (value
->string
.text
!= NULL
)
6039 n
= (int)strlen(value
->string
.text
);
6043 *bufptr
++ = (ipp_uchar_t
)(n
>> 8);
6044 *bufptr
++ = (ipp_uchar_t
)n
;
6049 memcpy(bufptr
, value
->string
.text
, (size_t)n
);
6055 case IPP_TAG_BEGIN_COLLECTION
:
6056 for (i
= 0, value
= attr
->values
;
6057 i
< attr
->num_values
;
6061 * Collections are written with the begin-collection
6062 * tag first with a value of 0 length, followed by the
6063 * attributes in the collection, then the end-collection
6067 if ((IPP_BUF_SIZE
- (bufptr
- buffer
)) < 5)
6069 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
6071 DEBUG_puts("1ippWriteIO: Could not write IPP "
6073 _cupsBufferRelease((char *)buffer
);
6074 return (IPP_STATE_ERROR
);
6083 * Arrays and sets are done by sending additional
6084 * values with a zero-length name...
6087 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
6093 * Write a data length of 0 and flush the buffer...
6099 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
6101 DEBUG_puts("1ippWriteIO: Could not write IPP "
6103 _cupsBufferRelease((char *)buffer
);
6104 return (IPP_STATE_ERROR
);
6110 * Then write the collection attribute...
6113 value
->collection
->state
= IPP_STATE_IDLE
;
6115 if (ippWriteIO(dst
, cb
, 1, ipp
,
6116 value
->collection
) == IPP_STATE_ERROR
)
6118 DEBUG_puts("1ippWriteIO: Unable to write collection value");
6119 _cupsBufferRelease((char *)buffer
);
6120 return (IPP_STATE_ERROR
);
6126 for (i
= 0, value
= attr
->values
;
6127 i
< attr
->num_values
;
6133 * Arrays and sets are done by sending additional
6134 * values with a zero-length name...
6137 if ((IPP_BUF_SIZE
- (bufptr
- buffer
)) < 3)
6139 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
6141 DEBUG_puts("1ippWriteIO: Could not write IPP "
6143 _cupsBufferRelease((char *)buffer
);
6144 return (IPP_STATE_ERROR
);
6150 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
6156 * An unknown value might some new value that a
6157 * vendor has come up with. It consists of a
6158 * 2-byte length and the bytes in the unknown
6162 n
= value
->unknown
.length
;
6164 if (n
> (IPP_BUF_SIZE
- 2))
6166 DEBUG_printf(("1ippWriteIO: Data length too long (%d)",
6168 _cupsBufferRelease((char *)buffer
);
6169 return (IPP_STATE_ERROR
);
6172 if ((int)(IPP_BUF_SIZE
- (bufptr
- buffer
)) < (n
+ 2))
6174 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
6176 DEBUG_puts("1ippWriteIO: Could not write IPP "
6178 _cupsBufferRelease((char *)buffer
);
6179 return (IPP_STATE_ERROR
);
6185 /* Length of unknown value */
6186 *bufptr
++ = (ipp_uchar_t
)(n
>> 8);
6187 *bufptr
++ = (ipp_uchar_t
)n
;
6192 memcpy(bufptr
, value
->unknown
.data
, (size_t)n
);
6200 * Write the data out...
6203 if (bufptr
> buffer
)
6205 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
6207 DEBUG_puts("1ippWriteIO: Could not write IPP attribute...");
6208 _cupsBufferRelease((char *)buffer
);
6209 return (IPP_STATE_ERROR
);
6212 DEBUG_printf(("2ippWriteIO: wrote %d bytes",
6213 (int)(bufptr
- buffer
)));
6217 * If blocking is disabled and we aren't at the end of the attribute
6218 * list, stop here...
6221 if (!blocking
&& ipp
->current
)
6225 if (ipp
->current
== NULL
)
6228 * Done with all of the attributes; add the end-of-attributes
6229 * tag or end-collection attribute...
6234 buffer
[0] = IPP_TAG_END
;
6239 buffer
[0] = IPP_TAG_END_COLLECTION
;
6240 buffer
[1] = 0; /* empty name */
6242 buffer
[3] = 0; /* empty value */
6247 if ((*cb
)(dst
, buffer
, (size_t)n
) < 0)
6249 DEBUG_puts("1ippWriteIO: Could not write IPP end-tag...");
6250 _cupsBufferRelease((char *)buffer
);
6251 return (IPP_STATE_ERROR
);
6254 ipp
->state
= IPP_STATE_DATA
;
6258 case IPP_STATE_DATA
:
6262 break; /* anti-compiler-warning-code */
6265 _cupsBufferRelease((char *)buffer
);
6267 return (ipp
->state
);
6272 * 'ipp_add_attr()' - Add a new attribute to the message.
6275 static ipp_attribute_t
* /* O - New attribute */
6276 ipp_add_attr(ipp_t
*ipp
, /* I - IPP message */
6277 const char *name
, /* I - Attribute name or NULL */
6278 ipp_tag_t group_tag
, /* I - Group tag or IPP_TAG_ZERO */
6279 ipp_tag_t value_tag
, /* I - Value tag or IPP_TAG_ZERO */
6280 int num_values
) /* I - Number of values */
6282 int alloc_values
; /* Number of values to allocate */
6283 ipp_attribute_t
*attr
; /* New attribute */
6286 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
));
6289 * Range check input...
6292 if (!ipp
|| num_values
< 0)
6296 * Allocate memory, rounding the allocation up as needed...
6299 if (num_values
<= 1)
6302 alloc_values
= (num_values
+ IPP_MAX_VALUES
- 1) & ~(IPP_MAX_VALUES
- 1);
6304 attr
= calloc(sizeof(ipp_attribute_t
) +
6305 (size_t)(alloc_values
- 1) * sizeof(_ipp_value_t
), 1);
6310 * Initialize attribute...
6313 DEBUG_printf(("4debug_alloc: %p %s %s%s (%d values)", (void *)attr
, name
, num_values
> 1 ? "1setOf " : "", ippTagString(value_tag
), num_values
));
6316 attr
->name
= _cupsStrAlloc(name
);
6318 attr
->group_tag
= group_tag
;
6319 attr
->value_tag
= value_tag
;
6320 attr
->num_values
= num_values
;
6323 * Add it to the end of the linked list...
6327 ipp
->last
->next
= attr
;
6331 ipp
->prev
= ipp
->last
;
6332 ipp
->last
= ipp
->current
= attr
;
6335 DEBUG_printf(("5ipp_add_attr: Returning %p", (void *)attr
));
6342 * 'ipp_free_values()' - Free attribute values.
6346 ipp_free_values(ipp_attribute_t
*attr
, /* I - Attribute to free values from */
6347 int element
,/* I - First value to free */
6348 int count
) /* I - Number of values to free */
6350 int i
; /* Looping var */
6351 _ipp_value_t
*value
; /* Current value */
6354 DEBUG_printf(("4ipp_free_values(attr=%p, element=%d, count=%d)", (void *)attr
, element
, count
));
6356 if (!(attr
->value_tag
& IPP_TAG_CUPS_CONST
))
6359 * Free values as needed...
6362 switch (attr
->value_tag
)
6364 case IPP_TAG_TEXTLANG
:
6365 case IPP_TAG_NAMELANG
:
6366 if (element
== 0 && count
== attr
->num_values
&&
6367 attr
->values
[0].string
.language
)
6369 _cupsStrFree(attr
->values
[0].string
.language
);
6370 attr
->values
[0].string
.language
= NULL
;
6372 /* Fall through to other string values */
6376 case IPP_TAG_RESERVED_STRING
:
6377 case IPP_TAG_KEYWORD
:
6379 case IPP_TAG_URISCHEME
:
6380 case IPP_TAG_CHARSET
:
6381 case IPP_TAG_LANGUAGE
:
6382 case IPP_TAG_MIMETYPE
:
6383 for (i
= count
, value
= attr
->values
+ element
;
6387 _cupsStrFree(value
->string
.text
);
6388 value
->string
.text
= NULL
;
6392 case IPP_TAG_UNSUPPORTED_VALUE
:
6393 case IPP_TAG_DEFAULT
:
6394 case IPP_TAG_UNKNOWN
:
6395 case IPP_TAG_NOVALUE
:
6396 case IPP_TAG_NOTSETTABLE
:
6397 case IPP_TAG_DELETEATTR
:
6398 case IPP_TAG_ADMINDEFINE
:
6399 case IPP_TAG_INTEGER
:
6401 case IPP_TAG_BOOLEAN
:
6403 case IPP_TAG_RESOLUTION
:
6404 case IPP_TAG_RANGE
:
6407 case IPP_TAG_BEGIN_COLLECTION
:
6408 for (i
= count
, value
= attr
->values
+ element
;
6412 ippDelete(value
->collection
);
6413 value
->collection
= NULL
;
6417 case IPP_TAG_STRING
:
6419 for (i
= count
, value
= attr
->values
+ element
;
6423 if (value
->unknown
.data
)
6425 free(value
->unknown
.data
);
6426 value
->unknown
.data
= NULL
;
6434 * If we are not freeing values from the end, move the remaining values up...
6437 if ((element
+ count
) < attr
->num_values
)
6438 memmove(attr
->values
+ element
, attr
->values
+ element
+ count
,
6439 (size_t)(attr
->num_values
- count
- element
) * sizeof(_ipp_value_t
));
6441 attr
->num_values
-= count
;
6446 * 'ipp_get_code()' - Convert a C locale/charset name into an IPP language/charset code.
6448 * This typically converts strings of the form "ll_CC", "ll-REGION", and "CHARSET_NUMBER"
6449 * to "ll-cc", "ll-region", and "charset-number", respectively.
6452 static char * /* O - Language code string */
6453 ipp_get_code(const char *value
, /* I - Locale/charset string */
6454 char *buffer
, /* I - String buffer */
6455 size_t bufsize
) /* I - Size of string buffer */
6457 char *bufptr
, /* Pointer into buffer */
6458 *bufend
; /* End of buffer */
6462 * Convert values to lowercase and change _ to - as needed...
6465 for (bufptr
= buffer
, bufend
= buffer
+ bufsize
- 1;
6466 *value
&& bufptr
< bufend
;
6471 *bufptr
++ = (char)_cups_tolower(*value
);
6476 * Return the converted string...
6484 * 'ipp_lang_code()' - Convert a C locale name into an IPP language code.
6486 * This typically converts strings of the form "ll_CC" and "ll-REGION" to "ll-cc" and
6487 * "ll-region", respectively. It also converts the "C" (POSIX) locale to "en".
6490 static char * /* O - Language code string */
6491 ipp_lang_code(const char *locale
, /* I - Locale string */
6492 char *buffer
, /* I - String buffer */
6493 size_t bufsize
) /* I - Size of string buffer */
6496 * Map POSIX ("C") locale to generic English, otherwise convert the locale string as-is.
6499 if (!_cups_strcasecmp(locale
, "c"))
6501 strlcpy(buffer
, "en", bufsize
);
6505 return (ipp_get_code(locale
, buffer
, bufsize
));
6510 * 'ipp_length()' - Compute the length of an IPP message or collection value.
6513 static size_t /* O - Size of IPP message */
6514 ipp_length(ipp_t
*ipp
, /* I - IPP message or collection */
6515 int collection
) /* I - 1 if a collection, 0 otherwise */
6517 int i
; /* Looping var */
6518 size_t bytes
; /* Number of bytes */
6519 ipp_attribute_t
*attr
; /* Current attribute */
6520 ipp_tag_t group
; /* Current group */
6521 _ipp_value_t
*value
; /* Current value */
6524 DEBUG_printf(("3ipp_length(ipp=%p, collection=%d)", (void *)ipp
, collection
));
6528 DEBUG_puts("4ipp_length: Returning 0 bytes");
6533 * Start with 8 bytes for the IPP message header...
6536 bytes
= collection
? 0 : 8;
6539 * Then add the lengths of each attribute...
6542 group
= IPP_TAG_ZERO
;
6544 for (attr
= ipp
->attrs
; attr
!= NULL
; attr
= attr
->next
)
6546 if (attr
->group_tag
!= group
&& !collection
)
6548 group
= attr
->group_tag
;
6549 if (group
== IPP_TAG_ZERO
)
6552 bytes
++; /* Group tag */
6558 DEBUG_printf(("5ipp_length: attr->name=\"%s\", attr->num_values=%d, "
6559 "bytes=" CUPS_LLFMT
, attr
->name
, attr
->num_values
, CUPS_LLCAST bytes
));
6561 if ((attr
->value_tag
& ~IPP_TAG_CUPS_CONST
) < IPP_TAG_EXTENSION
)
6562 bytes
+= (size_t)attr
->num_values
;/* Value tag for each value */
6564 bytes
+= (size_t)(5 * attr
->num_values
);
6565 /* Value tag for each value */
6566 bytes
+= (size_t)(2 * attr
->num_values
);
6568 bytes
+= strlen(attr
->name
); /* Name */
6569 bytes
+= (size_t)(2 * attr
->num_values
);
6573 bytes
+= 5; /* Add membername overhead */
6575 switch (attr
->value_tag
& ~IPP_TAG_CUPS_CONST
)
6577 case IPP_TAG_UNSUPPORTED_VALUE
:
6578 case IPP_TAG_DEFAULT
:
6579 case IPP_TAG_UNKNOWN
:
6580 case IPP_TAG_NOVALUE
:
6581 case IPP_TAG_NOTSETTABLE
:
6582 case IPP_TAG_DELETEATTR
:
6583 case IPP_TAG_ADMINDEFINE
:
6586 case IPP_TAG_INTEGER
:
6588 bytes
+= (size_t)(4 * attr
->num_values
);
6591 case IPP_TAG_BOOLEAN
:
6592 bytes
+= (size_t)attr
->num_values
;
6597 case IPP_TAG_KEYWORD
:
6599 case IPP_TAG_URISCHEME
:
6600 case IPP_TAG_CHARSET
:
6601 case IPP_TAG_LANGUAGE
:
6602 case IPP_TAG_MIMETYPE
:
6603 for (i
= 0, value
= attr
->values
;
6604 i
< attr
->num_values
;
6606 if (value
->string
.text
)
6607 bytes
+= strlen(value
->string
.text
);
6611 bytes
+= (size_t)(11 * attr
->num_values
);
6614 case IPP_TAG_RESOLUTION
:
6615 bytes
+= (size_t)(9 * attr
->num_values
);
6618 case IPP_TAG_RANGE
:
6619 bytes
+= (size_t)(8 * attr
->num_values
);
6622 case IPP_TAG_TEXTLANG
:
6623 case IPP_TAG_NAMELANG
:
6624 bytes
+= (size_t)(4 * attr
->num_values
);
6625 /* Charset + text length */
6627 for (i
= 0, value
= attr
->values
;
6628 i
< attr
->num_values
;
6631 if (value
->string
.language
)
6632 bytes
+= strlen(value
->string
.language
);
6634 if (value
->string
.text
)
6635 bytes
+= strlen(value
->string
.text
);
6639 case IPP_TAG_BEGIN_COLLECTION
:
6640 for (i
= 0, value
= attr
->values
;
6641 i
< attr
->num_values
;
6643 bytes
+= ipp_length(value
->collection
, 1);
6647 for (i
= 0, value
= attr
->values
;
6648 i
< attr
->num_values
;
6650 bytes
+= (size_t)value
->unknown
.length
;
6656 * Finally, add 1 byte for the "end of attributes" tag or 5 bytes
6657 * for the "end of collection" tag and return...
6665 DEBUG_printf(("4ipp_length: Returning " CUPS_LLFMT
" bytes", CUPS_LLCAST bytes
));
6672 * 'ipp_read_http()' - Semi-blocking read on a HTTP connection...
6675 static ssize_t
/* O - Number of bytes read */
6676 ipp_read_http(http_t
*http
, /* I - Client connection */
6677 ipp_uchar_t
*buffer
, /* O - Buffer for data */
6678 size_t length
) /* I - Total length */
6680 ssize_t tbytes
, /* Total bytes read */
6681 bytes
; /* Bytes read this pass */
6684 DEBUG_printf(("7ipp_read_http(http=%p, buffer=%p, length=%d)", (void *)http
, (void *)buffer
, (int)length
));
6687 * Loop until all bytes are read...
6690 for (tbytes
= 0, bytes
= 0;
6691 tbytes
< (int)length
;
6692 tbytes
+= bytes
, buffer
+= bytes
)
6694 DEBUG_printf(("9ipp_read_http: tbytes=" CUPS_LLFMT
", http->state=%d", CUPS_LLCAST tbytes
, http
->state
));
6696 if (http
->state
== HTTP_STATE_WAITING
)
6699 if (http
->used
== 0 && !http
->blocking
)
6702 * Wait up to 10 seconds for more data on non-blocking sockets...
6705 if (!httpWait(http
, 10000))
6715 else if (http
->used
== 0 && http
->timeout_value
> 0)
6718 * Wait up to timeout seconds for more data on blocking sockets...
6721 if (!httpWait(http
, (int)(1000 * http
->timeout_value
)))
6732 if ((bytes
= httpRead2(http
, (char *)buffer
, length
- (size_t)tbytes
)) < 0)
6737 if (errno
!= EAGAIN
&& errno
!= EINTR
)
6743 else if (bytes
== 0)
6748 * Return the number of bytes read...
6751 if (tbytes
== 0 && bytes
< 0)
6754 DEBUG_printf(("8ipp_read_http: Returning " CUPS_LLFMT
" bytes", CUPS_LLCAST tbytes
));
6761 * 'ipp_read_file()' - Read IPP data from a file.
6764 static ssize_t
/* O - Number of bytes read */
6765 ipp_read_file(int *fd
, /* I - File descriptor */
6766 ipp_uchar_t
*buffer
, /* O - Read buffer */
6767 size_t length
) /* I - Number of bytes to read */
6770 return ((ssize_t
)read(*fd
, buffer
, (unsigned)length
));
6772 return (read(*fd
, buffer
, length
));
6778 * 'ipp_set_error()' - Set a formatted, localized error string.
6782 ipp_set_error(ipp_status_t status
, /* I - Status code */
6783 const char *format
, /* I - Printf-style error string */
6784 ...) /* I - Additional arguments as needed */
6786 va_list ap
; /* Pointer to additional args */
6787 char buffer
[2048]; /* Message buffer */
6788 cups_lang_t
*lang
= cupsLangDefault();
6789 /* Current language */
6792 va_start(ap
, format
);
6793 vsnprintf(buffer
, sizeof(buffer
), _cupsLangString(lang
, format
), ap
);
6796 _cupsSetError(status
, buffer
, 0);
6801 * 'ipp_set_value()' - Get the value element from an attribute, expanding it as
6805 static _ipp_value_t
* /* O - IPP value element or NULL on error */
6806 ipp_set_value(ipp_t
*ipp
, /* IO - IPP message */
6807 ipp_attribute_t
**attr
, /* IO - IPP attribute */
6808 int element
) /* I - Value number (0-based) */
6810 ipp_attribute_t
*temp
, /* New attribute pointer */
6811 *current
, /* Current attribute in list */
6812 *prev
; /* Previous attribute in list */
6813 int alloc_values
; /* Allocated values */
6817 * If we are setting an existing value element, return it...
6822 if (temp
->num_values
<= 1)
6825 alloc_values
= (temp
->num_values
+ IPP_MAX_VALUES
- 1) &
6826 ~(IPP_MAX_VALUES
- 1);
6828 if (element
< alloc_values
)
6830 if (element
>= temp
->num_values
)
6831 temp
->num_values
= element
+ 1;
6833 return (temp
->values
+ element
);
6837 * Otherwise re-allocate the attribute - we allocate in groups of IPP_MAX_VALUE
6838 * values when num_values > 1.
6841 if (alloc_values
< IPP_MAX_VALUES
)
6842 alloc_values
= IPP_MAX_VALUES
;
6844 alloc_values
+= IPP_MAX_VALUES
;
6846 DEBUG_printf(("4ipp_set_value: Reallocating for up to %d values.",
6850 * Reallocate memory...
6853 if ((temp
= realloc(temp
, sizeof(ipp_attribute_t
) + (size_t)(alloc_values
- 1) * sizeof(_ipp_value_t
))) == NULL
)
6855 _cupsSetHTTPError(HTTP_STATUS_ERROR
);
6856 DEBUG_puts("4ipp_set_value: Unable to resize attribute.");
6861 * Zero the new memory...
6864 memset(temp
->values
+ temp
->num_values
, 0, (size_t)(alloc_values
- temp
->num_values
) * sizeof(_ipp_value_t
));
6869 * Reset pointers in the list...
6872 DEBUG_printf(("4debug_free: %p %s", (void *)*attr
, temp
->name
));
6873 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
));
6875 if (ipp
->current
== *attr
&& ipp
->prev
)
6878 * Use current "previous" pointer...
6886 * Find this attribute in the linked list...
6889 for (prev
= NULL
, current
= ipp
->attrs
;
6890 current
&& current
!= *attr
;
6891 prev
= current
, current
= current
->next
);
6896 * This is a serious error!
6900 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
6901 _("IPP attribute is not a member of the message."), 1);
6902 DEBUG_puts("4ipp_set_value: Unable to find attribute in message.");
6912 ipp
->current
= temp
;
6915 if (ipp
->last
== *attr
)
6922 * Return the value element...
6925 if (element
>= temp
->num_values
)
6926 temp
->num_values
= element
+ 1;
6928 return (temp
->values
+ element
);
6933 * 'ipp_write_file()' - Write IPP data to a file.
6936 static ssize_t
/* O - Number of bytes written */
6937 ipp_write_file(int *fd
, /* I - File descriptor */
6938 ipp_uchar_t
*buffer
, /* I - Data to write */
6939 size_t length
) /* I - Number of bytes to write */
6942 return ((ssize_t
)write(*fd
, buffer
, (unsigned)length
));
6944 return (write(*fd
, buffer
, length
));