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_tag_t srctag
; /* Source value tag */
1478 ipp_attribute_t
*dstattr
; /* Destination attribute */
1479 _ipp_value_t
*srcval
, /* Source value */
1480 *dstval
; /* Destination value */
1483 DEBUG_printf(("ippCopyAttribute(dst=%p, srcattr=%p, quickcopy=%d)", (void *)dst
, (void *)srcattr
, quickcopy
));
1486 * Range check input...
1489 if (!dst
|| !srcattr
)
1496 quickcopy
= (quickcopy
&& (srcattr
->value_tag
& IPP_TAG_CUPS_CONST
)) ? IPP_TAG_CUPS_CONST
: 0;
1497 srctag
= srcattr
->value_tag
& IPP_TAG_CUPS_MASK
;
1502 dstattr
= ippAddSeparator(dst
);
1505 case IPP_TAG_UNSUPPORTED_VALUE
:
1506 case IPP_TAG_DEFAULT
:
1507 case IPP_TAG_UNKNOWN
:
1508 case IPP_TAG_NOVALUE
:
1509 case IPP_TAG_NOTSETTABLE
:
1510 case IPP_TAG_DELETEATTR
:
1511 case IPP_TAG_ADMINDEFINE
:
1512 dstattr
= ippAddOutOfBand(dst
, srcattr
->group_tag
, srctag
, srcattr
->name
);
1515 case IPP_TAG_INTEGER
:
1517 case IPP_TAG_BOOLEAN
:
1519 case IPP_TAG_RESOLUTION
:
1520 case IPP_TAG_RANGE
:
1521 if ((dstattr
= ipp_add_attr(dst
, srcattr
->name
, srcattr
->group_tag
, srctag
, srcattr
->num_values
)) != NULL
)
1522 memcpy(dstattr
->values
, srcattr
->values
, (size_t)srcattr
->num_values
* sizeof(_ipp_value_t
));
1527 case IPP_TAG_RESERVED_STRING
:
1528 case IPP_TAG_KEYWORD
:
1530 case IPP_TAG_URISCHEME
:
1531 case IPP_TAG_CHARSET
:
1532 case IPP_TAG_LANGUAGE
:
1533 case IPP_TAG_MIMETYPE
:
1534 if ((dstattr
= ippAddStrings(dst
, srcattr
->group_tag
, (ipp_tag_t
)(srctag
| quickcopy
), srcattr
->name
, srcattr
->num_values
, NULL
, NULL
)) == NULL
)
1540 * Can safely quick-copy these string values...
1543 memcpy(dstattr
->values
, srcattr
->values
, (size_t)srcattr
->num_values
* sizeof(_ipp_value_t
));
1548 * Otherwise do a normal reference counted copy...
1551 for (i
= srcattr
->num_values
, srcval
= srcattr
->values
, dstval
= dstattr
->values
; i
> 0; i
--, srcval
++, dstval
++)
1552 dstval
->string
.text
= _cupsStrAlloc(srcval
->string
.text
);
1556 case IPP_TAG_TEXTLANG
:
1557 case IPP_TAG_NAMELANG
:
1558 if ((dstattr
= ippAddStrings(dst
, srcattr
->group_tag
, (ipp_tag_t
)(srctag
| quickcopy
), srcattr
->name
, srcattr
->num_values
, NULL
, NULL
)) == NULL
)
1564 * Can safely quick-copy these string values...
1567 memcpy(dstattr
->values
, srcattr
->values
, (size_t)srcattr
->num_values
* sizeof(_ipp_value_t
));
1569 else if (srcattr
->value_tag
& IPP_TAG_CUPS_CONST
)
1572 * Otherwise do a normal reference counted copy...
1575 for (i
= srcattr
->num_values
, srcval
= srcattr
->values
, dstval
= dstattr
->values
; i
> 0; i
--, srcval
++, dstval
++)
1577 if (srcval
== srcattr
->values
)
1578 dstval
->string
.language
= _cupsStrAlloc(srcval
->string
.language
);
1580 dstval
->string
.language
= dstattr
->values
[0].string
.language
;
1582 dstval
->string
.text
= _cupsStrAlloc(srcval
->string
.text
);
1587 case IPP_TAG_BEGIN_COLLECTION
:
1588 if ((dstattr
= ippAddCollections(dst
, srcattr
->group_tag
, srcattr
->name
, srcattr
->num_values
, NULL
)) == NULL
)
1591 for (i
= srcattr
->num_values
, srcval
= srcattr
->values
, dstval
= dstattr
->values
; i
> 0; i
--, srcval
++, dstval
++)
1593 dstval
->collection
= srcval
->collection
;
1594 srcval
->collection
->use
++;
1598 case IPP_TAG_STRING
:
1600 if ((dstattr
= ipp_add_attr(dst
, srcattr
->name
, srcattr
->group_tag
, srctag
, srcattr
->num_values
)) == NULL
)
1603 for (i
= srcattr
->num_values
, srcval
= srcattr
->values
, dstval
= dstattr
->values
; i
> 0; i
--, srcval
++, dstval
++)
1605 dstval
->unknown
.length
= srcval
->unknown
.length
;
1607 if (dstval
->unknown
.length
> 0)
1609 if ((dstval
->unknown
.data
= malloc((size_t)dstval
->unknown
.length
)) == NULL
)
1610 dstval
->unknown
.length
= 0;
1612 memcpy(dstval
->unknown
.data
, srcval
->unknown
.data
, (size_t)dstval
->unknown
.length
);
1615 break; /* anti-compiler-warning-code */
1623 * 'ippCopyAttributes()' - Copy attributes from one IPP message to another.
1625 * Zero or more attributes are copied from the source IPP message, @code src@, to the
1626 * destination IPP message, @code dst@. When @code quickcopy@ is non-zero, a "shallow"
1627 * reference copy of the attribute is created - this should only be done as long as the
1628 * original source IPP message will not be freed for the life of the destination.
1630 * The @code cb@ and @code context@ parameters provide a generic way to "filter" the
1631 * attributes that are copied - the function must return 1 to copy the attribute or
1632 * 0 to skip it. The function may also choose to do a partial copy of the source attribute
1635 * @since CUPS 1.6/macOS 10.8@
1638 int /* O - 1 on success, 0 on error */
1640 ipp_t
*dst
, /* I - Destination IPP message */
1641 ipp_t
*src
, /* I - Source IPP message */
1642 int quickcopy
, /* I - 1 for a referenced copy, 0 for normal */
1643 ipp_copycb_t cb
, /* I - Copy callback or @code NULL@ for none */
1644 void *context
) /* I - Context pointer */
1646 ipp_attribute_t
*srcattr
; /* Source attribute */
1649 DEBUG_printf(("ippCopyAttributes(dst=%p, src=%p, quickcopy=%d, cb=%p, context=%p)", (void *)dst
, (void *)src
, quickcopy
, (void *)cb
, context
));
1652 * Range check input...
1659 * Loop through source attributes and copy as needed...
1662 for (srcattr
= src
->attrs
; srcattr
; srcattr
= srcattr
->next
)
1663 if (!cb
|| (*cb
)(context
, dst
, srcattr
))
1664 if (!ippCopyAttribute(dst
, srcattr
, quickcopy
))
1672 * 'ippDateToTime()' - Convert from RFC 2579 Date/Time format to time in
1676 time_t /* O - UNIX time value */
1677 ippDateToTime(const ipp_uchar_t
*date
) /* I - RFC 2579 date info */
1679 struct tm unixdate
; /* UNIX date/time info */
1680 time_t t
; /* Computed time */
1686 memset(&unixdate
, 0, sizeof(unixdate
));
1689 * RFC-2579 date/time format is:
1691 * Byte(s) Description
1692 * ------- -----------
1693 * 0-1 Year (0 to 65535)
1697 * 5 Minutes (0 to 59)
1698 * 6 Seconds (0 to 60, 60 = "leap second")
1699 * 7 Deciseconds (0 to 9)
1701 * 9 UTC hours (0 to 11)
1702 * 10 UTC minutes (0 to 59)
1705 unixdate
.tm_year
= ((date
[0] << 8) | date
[1]) - 1900;
1706 unixdate
.tm_mon
= date
[2] - 1;
1707 unixdate
.tm_mday
= date
[3];
1708 unixdate
.tm_hour
= date
[4];
1709 unixdate
.tm_min
= date
[5];
1710 unixdate
.tm_sec
= date
[6];
1712 t
= mktime(&unixdate
);
1715 t
+= date
[9] * 3600 + date
[10] * 60;
1717 t
-= date
[9] * 3600 + date
[10] * 60;
1724 * 'ippDelete()' - Delete an IPP message.
1728 ippDelete(ipp_t
*ipp
) /* I - IPP message */
1730 ipp_attribute_t
*attr
, /* Current attribute */
1731 *next
; /* Next attribute */
1734 DEBUG_printf(("ippDelete(ipp=%p)", (void *)ipp
));
1742 DEBUG_printf(("4debug_retain: %p IPP message (use=%d)", (void *)ipp
, ipp
->use
));
1746 DEBUG_printf(("4debug_free: %p IPP message", (void *)ipp
));
1748 for (attr
= ipp
->attrs
; attr
!= NULL
; attr
= next
)
1752 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
));
1754 ipp_free_values(attr
, 0, attr
->num_values
);
1757 _cupsStrFree(attr
->name
);
1767 * 'ippDeleteAttribute()' - Delete a single attribute in an IPP message.
1769 * @since CUPS 1.1.19/macOS 10.3@
1774 ipp_t
*ipp
, /* I - IPP message */
1775 ipp_attribute_t
*attr
) /* I - Attribute to delete */
1777 ipp_attribute_t
*current
, /* Current attribute */
1778 *prev
; /* Previous attribute */
1781 DEBUG_printf(("ippDeleteAttribute(ipp=%p, attr=%p(%s))", (void *)ipp
, (void *)attr
, attr
? attr
->name
: "(null)"));
1784 * Range check input...
1790 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
));
1793 * Find the attribute in the list...
1798 for (current
= ipp
->attrs
, prev
= NULL
;
1800 prev
= current
, current
= current
->next
)
1801 if (current
== attr
)
1804 * Found it, remove the attribute from the list...
1808 prev
->next
= current
->next
;
1810 ipp
->attrs
= current
->next
;
1812 if (current
== ipp
->last
)
1823 * Free memory used by the attribute...
1826 ipp_free_values(attr
, 0, attr
->num_values
);
1829 _cupsStrFree(attr
->name
);
1836 * 'ippDeleteValues()' - Delete values in an attribute.
1838 * The @code element@ parameter specifies the first value to delete, starting at
1839 * 0. It must be less than the number of values returned by @link ippGetCount@.
1841 * The @code attr@ parameter may be modified as a result of setting the value.
1843 * Deleting all values in an attribute deletes the attribute.
1845 * @since CUPS 1.6/macOS 10.8@
1848 int /* O - 1 on success, 0 on failure */
1850 ipp_t
*ipp
, /* I - IPP message */
1851 ipp_attribute_t
**attr
, /* IO - Attribute */
1852 int element
, /* I - Index of first value to delete (0-based) */
1853 int count
) /* I - Number of values to delete */
1856 * Range check input...
1859 if (!ipp
|| !attr
|| !*attr
||
1860 element
< 0 || element
>= (*attr
)->num_values
|| count
<= 0 ||
1861 (element
+ count
) >= (*attr
)->num_values
)
1865 * If we are deleting all values, just delete the attribute entirely.
1868 if (count
== (*attr
)->num_values
)
1870 ippDeleteAttribute(ipp
, *attr
);
1876 * Otherwise free the values in question and return.
1879 ipp_free_values(*attr
, element
, count
);
1886 * 'ippFindAttribute()' - Find a named attribute in a request.
1888 * Starting with CUPS 2.0, the attribute name can contain a hierarchical list
1889 * of attribute and member names separated by slashes, for example
1890 * "media-col/media-size".
1893 ipp_attribute_t
* /* O - Matching attribute */
1894 ippFindAttribute(ipp_t
*ipp
, /* I - IPP message */
1895 const char *name
, /* I - Name of attribute */
1896 ipp_tag_t type
) /* I - Type of attribute */
1898 DEBUG_printf(("2ippFindAttribute(ipp=%p, name=\"%s\", type=%02x(%s))", (void *)ipp
, name
, type
, ippTagString(type
)));
1904 * Reset the current pointer...
1907 ipp
->current
= NULL
;
1911 * Search for the attribute...
1914 return (ippFindNextAttribute(ipp
, name
, type
));
1919 * 'ippFindNextAttribute()' - Find the next named attribute in a request.
1921 * Starting with CUPS 2.0, the attribute name can contain a hierarchical list
1922 * of attribute and member names separated by slashes, for example
1923 * "media-col/media-size".
1926 ipp_attribute_t
* /* O - Matching attribute */
1927 ippFindNextAttribute(ipp_t
*ipp
, /* I - IPP message */
1928 const char *name
, /* I - Name of attribute */
1929 ipp_tag_t type
) /* I - Type of attribute */
1931 ipp_attribute_t
*attr
, /* Current atttribute */
1932 *childattr
; /* Child attribute */
1933 ipp_tag_t value_tag
; /* Value tag */
1934 char parent
[1024], /* Parent attribute name */
1935 *child
= NULL
; /* Child attribute name */
1938 DEBUG_printf(("2ippFindNextAttribute(ipp=%p, name=\"%s\", type=%02x(%s))", (void *)ipp
, name
, type
, ippTagString(type
)));
1943 DEBUG_printf(("3ippFindNextAttribute: atend=%d", ipp
->atend
));
1948 if (strchr(name
, '/'))
1951 * Search for child attribute...
1954 strlcpy(parent
, name
, sizeof(parent
));
1955 if ((child
= strchr(parent
, '/')) == NULL
)
1957 DEBUG_puts("3ippFindNextAttribute: Attribute name too long.");
1963 if (ipp
->current
&& ipp
->current
->name
&& ipp
->current
->value_tag
== IPP_TAG_BEGIN_COLLECTION
&& !strcmp(parent
, ipp
->current
->name
))
1965 while (ipp
->curindex
< ipp
->current
->num_values
)
1967 if ((childattr
= ippFindNextAttribute(ipp
->current
->values
[ipp
->curindex
].collection
, child
, type
)) != NULL
)
1971 if (ipp
->curindex
< ipp
->current
->num_values
&& ipp
->current
->values
[ipp
->curindex
].collection
)
1972 ipp
->current
->values
[ipp
->curindex
].collection
->current
= NULL
;
1975 ipp
->prev
= ipp
->current
;
1976 ipp
->current
= ipp
->current
->next
;
1989 ipp
->current
= ipp
->attrs
;
1994 attr
= ipp
->current
;
1996 else if (ipp
->current
)
1998 ipp
->prev
= ipp
->current
;
1999 attr
= ipp
->current
->next
;
2007 for (; attr
!= NULL
; ipp
->prev
= attr
, attr
= attr
->next
)
2009 DEBUG_printf(("4ippFindAttribute: attr=%p, name=\"%s\"", (void *)attr
, attr
->name
));
2011 value_tag
= (ipp_tag_t
)(attr
->value_tag
& IPP_TAG_CUPS_MASK
);
2013 if (attr
->name
!= NULL
&& _cups_strcasecmp(attr
->name
, name
) == 0 &&
2014 (value_tag
== type
|| type
== IPP_TAG_ZERO
|| name
== parent
||
2015 (value_tag
== IPP_TAG_TEXTLANG
&& type
== IPP_TAG_TEXT
) ||
2016 (value_tag
== IPP_TAG_NAMELANG
&& type
== IPP_TAG_NAME
)))
2018 ipp
->current
= attr
;
2020 if (name
== parent
&& attr
->value_tag
== IPP_TAG_BEGIN_COLLECTION
)
2022 int i
; /* Looping var */
2024 for (i
= 0; i
< attr
->num_values
; i
++)
2026 if ((childattr
= ippFindAttribute(attr
->values
[i
].collection
, child
, type
)) != NULL
)
2028 attr
->values
[0].collection
->curindex
= i
;
2038 ipp
->current
= NULL
;
2047 * 'ippFirstAttribute()' - Return the first attribute in the message.
2049 * @since CUPS 1.6/macOS 10.8@
2052 ipp_attribute_t
* /* O - First attribute or @code NULL@ if none */
2053 ippFirstAttribute(ipp_t
*ipp
) /* I - IPP message */
2056 * Range check input...
2063 * Return the first attribute...
2066 return (ipp
->current
= ipp
->attrs
);
2071 * 'ippGetBoolean()' - Get a boolean value for an attribute.
2073 * The @code element@ parameter specifies which value to get from 0 to
2074 * @code ippGetCount(attr)@ - 1.
2076 * @since CUPS 1.6/macOS 10.8@
2079 int /* O - Boolean value or 0 on error */
2080 ippGetBoolean(ipp_attribute_t
*attr
, /* I - IPP attribute */
2081 int element
) /* I - Value number (0-based) */
2084 * Range check input...
2087 if (!attr
|| attr
->value_tag
!= IPP_TAG_BOOLEAN
||
2088 element
< 0 || element
>= attr
->num_values
)
2092 * Return the value...
2095 return (attr
->values
[element
].boolean
);
2100 * 'ippGetCollection()' - Get a collection value for an attribute.
2102 * The @code element@ parameter specifies which value to get from 0 to
2103 * @code ippGetCount(attr)@ - 1.
2105 * @since CUPS 1.6/macOS 10.8@
2108 ipp_t
* /* O - Collection value or @code NULL@ on error */
2110 ipp_attribute_t
*attr
, /* I - IPP attribute */
2111 int element
) /* I - Value number (0-based) */
2114 * Range check input...
2117 if (!attr
|| attr
->value_tag
!= IPP_TAG_BEGIN_COLLECTION
||
2118 element
< 0 || element
>= attr
->num_values
)
2122 * Return the value...
2125 return (attr
->values
[element
].collection
);
2130 * 'ippGetCount()' - Get the number of values in an attribute.
2132 * @since CUPS 1.6/macOS 10.8@
2135 int /* O - Number of values or 0 on error */
2136 ippGetCount(ipp_attribute_t
*attr
) /* I - IPP attribute */
2139 * Range check input...
2146 * Return the number of values...
2149 return (attr
->num_values
);
2154 * 'ippGetDate()' - Get a dateTime value for an attribute.
2156 * The @code element@ parameter specifies which value to get from 0 to
2157 * @code ippGetCount(attr)@ - 1.
2159 * @since CUPS 1.6/macOS 10.8@
2162 const ipp_uchar_t
* /* O - dateTime value or @code NULL@ */
2163 ippGetDate(ipp_attribute_t
*attr
, /* I - IPP attribute */
2164 int element
) /* I - Value number (0-based) */
2167 * Range check input...
2170 if (!attr
|| attr
->value_tag
!= IPP_TAG_DATE
||
2171 element
< 0 || element
>= attr
->num_values
)
2175 * Return the value...
2178 return (attr
->values
[element
].date
);
2183 * 'ippGetGroupTag()' - Get the group associated with an attribute.
2185 * @since CUPS 1.6/macOS 10.8@
2188 ipp_tag_t
/* O - Group tag or @code IPP_TAG_ZERO@ on error */
2189 ippGetGroupTag(ipp_attribute_t
*attr
) /* I - IPP attribute */
2192 * Range check input...
2196 return (IPP_TAG_ZERO
);
2199 * Return the group...
2202 return (attr
->group_tag
);
2207 * 'ippGetInteger()' - Get the integer/enum value for an attribute.
2209 * The @code element@ parameter specifies which value to get from 0 to
2210 * @code ippGetCount(attr)@ - 1.
2212 * @since CUPS 1.6/macOS 10.8@
2215 int /* O - Value or 0 on error */
2216 ippGetInteger(ipp_attribute_t
*attr
, /* I - IPP attribute */
2217 int element
) /* I - Value number (0-based) */
2220 * Range check input...
2223 if (!attr
|| (attr
->value_tag
!= IPP_TAG_INTEGER
&& attr
->value_tag
!= IPP_TAG_ENUM
) ||
2224 element
< 0 || element
>= attr
->num_values
)
2228 * Return the value...
2231 return (attr
->values
[element
].integer
);
2236 * 'ippGetName()' - Get the attribute name.
2238 * @since CUPS 1.6/macOS 10.8@
2241 const char * /* O - Attribute name or @code NULL@ for separators */
2242 ippGetName(ipp_attribute_t
*attr
) /* I - IPP attribute */
2245 * Range check input...
2252 * Return the name...
2255 return (attr
->name
);
2260 * 'ippGetOctetString()' - Get an octetString value from an IPP attribute.
2262 * The @code element@ parameter specifies which value to get from 0 to
2263 * @code ippGetCount(attr)@ - 1.
2265 * @since CUPS 1.7/macOS 10.9@
2268 void * /* O - Pointer to octetString data */
2270 ipp_attribute_t
*attr
, /* I - IPP attribute */
2271 int element
, /* I - Value number (0-based) */
2272 int *datalen
) /* O - Length of octetString data */
2275 * Range check input...
2278 if (!attr
|| attr
->value_tag
!= IPP_TAG_STRING
||
2279 element
< 0 || element
>= attr
->num_values
)
2288 * Return the values...
2292 *datalen
= attr
->values
[element
].unknown
.length
;
2294 return (attr
->values
[element
].unknown
.data
);
2299 * 'ippGetOperation()' - Get the operation ID in an IPP message.
2301 * @since CUPS 1.6/macOS 10.8@
2304 ipp_op_t
/* O - Operation ID or 0 on error */
2305 ippGetOperation(ipp_t
*ipp
) /* I - IPP request message */
2308 * Range check input...
2312 return ((ipp_op_t
)0);
2315 * Return the value...
2318 return (ipp
->request
.op
.operation_id
);
2323 * 'ippGetRange()' - Get a rangeOfInteger value from an attribute.
2325 * The @code element@ parameter specifies which value to get from 0 to
2326 * @code ippGetCount(attr)@ - 1.
2328 * @since CUPS 1.6/macOS 10.8@
2331 int /* O - Lower value of range or 0 */
2332 ippGetRange(ipp_attribute_t
*attr
, /* I - IPP attribute */
2333 int element
, /* I - Value number (0-based) */
2334 int *uppervalue
)/* O - Upper value of range */
2337 * Range check input...
2340 if (!attr
|| attr
->value_tag
!= IPP_TAG_RANGE
||
2341 element
< 0 || element
>= attr
->num_values
)
2350 * Return the values...
2354 *uppervalue
= attr
->values
[element
].range
.upper
;
2356 return (attr
->values
[element
].range
.lower
);
2361 * 'ippGetRequestId()' - Get the request ID from an IPP message.
2363 * @since CUPS 1.6/macOS 10.8@
2366 int /* O - Request ID or 0 on error */
2367 ippGetRequestId(ipp_t
*ipp
) /* I - IPP message */
2370 * Range check input...
2377 * Return the request ID...
2380 return (ipp
->request
.any
.request_id
);
2385 * 'ippGetResolution()' - Get a resolution value for an attribute.
2387 * The @code element@ parameter specifies which value to get from 0 to
2388 * @code ippGetCount(attr)@ - 1.
2390 * @since CUPS 1.6/macOS 10.8@
2393 int /* O - Horizontal/cross feed resolution or 0 */
2395 ipp_attribute_t
*attr
, /* I - IPP attribute */
2396 int element
, /* I - Value number (0-based) */
2397 int *yres
, /* O - Vertical/feed resolution */
2398 ipp_res_t
*units
) /* O - Units for resolution */
2401 * Range check input...
2404 if (!attr
|| attr
->value_tag
!= IPP_TAG_RESOLUTION
||
2405 element
< 0 || element
>= attr
->num_values
)
2411 *units
= (ipp_res_t
)0;
2417 * Return the value...
2421 *yres
= attr
->values
[element
].resolution
.yres
;
2424 *units
= attr
->values
[element
].resolution
.units
;
2426 return (attr
->values
[element
].resolution
.xres
);
2431 * 'ippGetState()' - Get the IPP message state.
2433 * @since CUPS 1.6/macOS 10.8@
2436 ipp_state_t
/* O - IPP message state value */
2437 ippGetState(ipp_t
*ipp
) /* I - IPP message */
2440 * Range check input...
2444 return (IPP_STATE_IDLE
);
2447 * Return the value...
2450 return (ipp
->state
);
2455 * 'ippGetStatusCode()' - Get the status code from an IPP response or event message.
2457 * @since CUPS 1.6/macOS 10.8@
2460 ipp_status_t
/* O - Status code in IPP message */
2461 ippGetStatusCode(ipp_t
*ipp
) /* I - IPP response or event message */
2464 * Range check input...
2468 return (IPP_STATUS_ERROR_INTERNAL
);
2471 * Return the value...
2474 return (ipp
->request
.status
.status_code
);
2479 * 'ippGetString()' - Get the string and optionally the language code for an attribute.
2481 * The @code element@ parameter specifies which value to get from 0 to
2482 * @code ippGetCount(attr)@ - 1.
2484 * @since CUPS 1.6/macOS 10.8@
2488 ippGetString(ipp_attribute_t
*attr
, /* I - IPP attribute */
2489 int element
, /* I - Value number (0-based) */
2490 const char **language
)/* O - Language code (@code NULL@ for don't care) */
2492 ipp_tag_t tag
; /* Value tag */
2496 * Range check input...
2499 tag
= ippGetValueTag(attr
);
2501 if (!attr
|| element
< 0 || element
>= attr
->num_values
|| (tag
!= IPP_TAG_TEXTLANG
&& tag
!= IPP_TAG_NAMELANG
&& (tag
< IPP_TAG_TEXT
|| tag
> IPP_TAG_MIMETYPE
)))
2505 * Return the value...
2509 *language
= attr
->values
[element
].string
.language
;
2511 return (attr
->values
[element
].string
.text
);
2516 * 'ippGetValueTag()' - Get the value tag for an attribute.
2518 * @since CUPS 1.6/macOS 10.8@
2521 ipp_tag_t
/* O - Value tag or @code IPP_TAG_ZERO@ on error */
2522 ippGetValueTag(ipp_attribute_t
*attr
) /* I - IPP attribute */
2525 * Range check input...
2529 return (IPP_TAG_ZERO
);
2532 * Return the value...
2535 return (attr
->value_tag
& IPP_TAG_CUPS_MASK
);
2540 * 'ippGetVersion()' - Get the major and minor version number from an IPP message.
2542 * @since CUPS 1.6/macOS 10.8@
2545 int /* O - Major version number or 0 on error */
2546 ippGetVersion(ipp_t
*ipp
, /* I - IPP message */
2547 int *minor
) /* O - Minor version number or @code NULL@ for don't care */
2550 * Range check input...
2562 * Return the value...
2566 *minor
= ipp
->request
.any
.version
[1];
2568 return (ipp
->request
.any
.version
[0]);
2573 * 'ippLength()' - Compute the length of an IPP message.
2576 size_t /* O - Size of IPP message */
2577 ippLength(ipp_t
*ipp
) /* I - IPP message */
2579 return (ipp_length(ipp
, 0));
2584 * 'ippNextAttribute()' - Return the next attribute in the message.
2586 * @since CUPS 1.6/macOS 10.8@
2589 ipp_attribute_t
* /* O - Next attribute or @code NULL@ if none */
2590 ippNextAttribute(ipp_t
*ipp
) /* I - IPP message */
2593 * Range check input...
2596 if (!ipp
|| !ipp
->current
)
2600 * Return the next attribute...
2603 return (ipp
->current
= ipp
->current
->next
);
2608 * 'ippNew()' - Allocate a new IPP message.
2611 ipp_t
* /* O - New IPP message */
2614 ipp_t
*temp
; /* New IPP message */
2615 _cups_globals_t
*cg
= _cupsGlobals();
2619 DEBUG_puts("ippNew()");
2621 if ((temp
= (ipp_t
*)calloc(1, sizeof(ipp_t
))) != NULL
)
2624 * Set default version - usually 2.0...
2627 DEBUG_printf(("4debug_alloc: %p IPP message", (void *)temp
));
2629 if (cg
->server_version
== 0)
2632 temp
->request
.any
.version
[0] = (ipp_uchar_t
)(cg
->server_version
/ 10);
2633 temp
->request
.any
.version
[1] = (ipp_uchar_t
)(cg
->server_version
% 10);
2637 DEBUG_printf(("1ippNew: Returning %p", (void *)temp
));
2644 * 'ippNewRequest()' - Allocate a new IPP request message.
2646 * The new request message is initialized with the "attributes-charset" and
2647 * "attributes-natural-language" attributes added. The
2648 * "attributes-natural-language" value is derived from the current locale.
2650 * @since CUPS 1.2/macOS 10.5@
2653 ipp_t
* /* O - IPP request message */
2654 ippNewRequest(ipp_op_t op
) /* I - Operation code */
2656 ipp_t
*request
; /* IPP request message */
2657 cups_lang_t
*language
; /* Current language localization */
2658 static int request_id
= 0; /* Current request ID */
2659 static _cups_mutex_t request_mutex
= _CUPS_MUTEX_INITIALIZER
;
2660 /* Mutex for request ID */
2663 DEBUG_printf(("ippNewRequest(op=%02x(%s))", op
, ippOpString(op
)));
2666 * Create a new IPP message...
2669 if ((request
= ippNew()) == NULL
)
2673 * Set the operation and request ID...
2676 _cupsMutexLock(&request_mutex
);
2678 request
->request
.op
.operation_id
= op
;
2679 request
->request
.op
.request_id
= ++request_id
;
2681 _cupsMutexUnlock(&request_mutex
);
2684 * Use UTF-8 as the character set...
2687 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_CHARSET
,
2688 "attributes-charset", NULL
, "utf-8");
2691 * Get the language from the current locale...
2694 language
= cupsLangDefault();
2696 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_LANGUAGE
,
2697 "attributes-natural-language", NULL
, language
->language
);
2700 * Return the new request...
2708 * 'ippNewResponse()' - Allocate a new IPP response message.
2710 * The new response message is initialized with the same "version-number",
2711 * "request-id", "attributes-charset", and "attributes-natural-language" as the
2712 * provided request message. If the "attributes-charset" or
2713 * "attributes-natural-language" attributes are missing from the request,
2714 * 'utf-8' and a value derived from the current locale are substituted,
2717 * @since CUPS 1.7/macOS 10.9@
2720 ipp_t
* /* O - IPP response message */
2721 ippNewResponse(ipp_t
*request
) /* I - IPP request message */
2723 ipp_t
*response
; /* IPP response message */
2724 ipp_attribute_t
*attr
; /* Current attribute */
2728 * Range check input...
2735 * Create a new IPP message...
2738 if ((response
= ippNew()) == NULL
)
2742 * Copy the request values over to the response...
2745 response
->request
.status
.version
[0] = request
->request
.op
.version
[0];
2746 response
->request
.status
.version
[1] = request
->request
.op
.version
[1];
2747 response
->request
.status
.request_id
= request
->request
.op
.request_id
;
2750 * The first attribute MUST be attributes-charset...
2753 attr
= request
->attrs
;
2755 if (attr
&& attr
->name
&& !strcmp(attr
->name
, "attributes-charset") &&
2756 attr
->group_tag
== IPP_TAG_OPERATION
&&
2757 attr
->value_tag
== IPP_TAG_CHARSET
&&
2758 attr
->num_values
== 1)
2761 * Copy charset from request...
2764 ippAddString(response
, IPP_TAG_OPERATION
, IPP_TAG_CHARSET
,
2765 "attributes-charset", NULL
, attr
->values
[0].string
.text
);
2770 * Use "utf-8" as the default...
2773 ippAddString(response
, IPP_TAG_OPERATION
, IPP_TAG_CHARSET
,
2774 "attributes-charset", NULL
, "utf-8");
2778 * Then attributes-natural-language...
2784 if (attr
&& attr
->name
&&
2785 !strcmp(attr
->name
, "attributes-natural-language") &&
2786 attr
->group_tag
== IPP_TAG_OPERATION
&&
2787 attr
->value_tag
== IPP_TAG_LANGUAGE
&&
2788 attr
->num_values
== 1)
2791 * Copy language from request...
2794 ippAddString(response
, IPP_TAG_OPERATION
, IPP_TAG_LANGUAGE
,
2795 "attributes-natural-language", NULL
,
2796 attr
->values
[0].string
.text
);
2801 * Use the language from the current locale...
2804 cups_lang_t
*language
= cupsLangDefault();
2805 /* Current locale */
2807 ippAddString(response
, IPP_TAG_OPERATION
, IPP_TAG_LANGUAGE
,
2808 "attributes-natural-language", NULL
, language
->language
);
2816 * 'ippRead()' - Read data for an IPP message from a HTTP connection.
2819 ipp_state_t
/* O - Current state */
2820 ippRead(http_t
*http
, /* I - HTTP connection */
2821 ipp_t
*ipp
) /* I - IPP data */
2823 DEBUG_printf(("ippRead(http=%p, ipp=%p), data_remaining=" CUPS_LLFMT
, (void *)http
, (void *)ipp
, CUPS_LLCAST (http
? http
->data_remaining
: -1)));
2826 return (IPP_STATE_ERROR
);
2828 DEBUG_printf(("2ippRead: http->state=%d, http->used=%d", http
->state
, http
->used
));
2830 return (ippReadIO(http
, (ipp_iocb_t
)ipp_read_http
, http
->blocking
, NULL
,
2836 * 'ippReadFile()' - Read data for an IPP message from a file.
2838 * @since CUPS 1.1.19/macOS 10.3@
2841 ipp_state_t
/* O - Current state */
2842 ippReadFile(int fd
, /* I - HTTP data */
2843 ipp_t
*ipp
) /* I - IPP data */
2845 DEBUG_printf(("ippReadFile(fd=%d, ipp=%p)", fd
, (void *)ipp
));
2847 return (ippReadIO(&fd
, (ipp_iocb_t
)ipp_read_file
, 1, NULL
, ipp
));
2852 * 'ippReadIO()' - Read data for an IPP message.
2854 * @since CUPS 1.2/macOS 10.5@
2857 ipp_state_t
/* O - Current state */
2858 ippReadIO(void *src
, /* I - Data source */
2859 ipp_iocb_t cb
, /* I - Read callback function */
2860 int blocking
, /* I - Use blocking IO? */
2861 ipp_t
*parent
, /* I - Parent request, if any */
2862 ipp_t
*ipp
) /* I - IPP data */
2864 int n
; /* Length of data */
2865 unsigned char *buffer
, /* Data buffer */
2866 string
[IPP_MAX_TEXT
],
2867 /* Small string buffer */
2868 *bufptr
; /* Pointer into buffer */
2869 ipp_attribute_t
*attr
; /* Current attribute */
2870 ipp_tag_t tag
; /* Current tag */
2871 ipp_tag_t value_tag
; /* Current value tag */
2872 _ipp_value_t
*value
; /* Current value */
2875 DEBUG_printf(("ippReadIO(src=%p, cb=%p, blocking=%d, parent=%p, ipp=%p)", (void *)src
, (void *)cb
, blocking
, (void *)parent
, (void *)ipp
));
2876 DEBUG_printf(("2ippReadIO: ipp->state=%d", ipp
? ipp
->state
: IPP_STATE_ERROR
));
2879 return (IPP_STATE_ERROR
);
2881 if ((buffer
= (unsigned char *)_cupsBufferGet(IPP_BUF_SIZE
)) == NULL
)
2883 DEBUG_puts("1ippReadIO: Unable to get read buffer.");
2884 return (IPP_STATE_ERROR
);
2889 case IPP_STATE_IDLE
:
2890 ipp
->state
++; /* Avoid common problem... */
2892 case IPP_STATE_HEADER
:
2896 * Get the request header...
2899 if ((*cb
)(src
, buffer
, 8) < 8)
2901 DEBUG_puts("1ippReadIO: Unable to read header.");
2902 _cupsBufferRelease((char *)buffer
);
2903 return (IPP_STATE_ERROR
);
2907 * Then copy the request header over...
2910 ipp
->request
.any
.version
[0] = buffer
[0];
2911 ipp
->request
.any
.version
[1] = buffer
[1];
2912 ipp
->request
.any
.op_status
= (buffer
[2] << 8) | buffer
[3];
2913 ipp
->request
.any
.request_id
= (((((buffer
[4] << 8) | buffer
[5]) << 8) |
2914 buffer
[6]) << 8) | buffer
[7];
2916 DEBUG_printf(("2ippReadIO: version=%d.%d", buffer
[0], buffer
[1]));
2917 DEBUG_printf(("2ippReadIO: op_status=%04x",
2918 ipp
->request
.any
.op_status
));
2919 DEBUG_printf(("2ippReadIO: request_id=%d",
2920 ipp
->request
.any
.request_id
));
2923 ipp
->state
= IPP_STATE_ATTRIBUTE
;
2924 ipp
->current
= NULL
;
2925 ipp
->curtag
= IPP_TAG_ZERO
;
2926 ipp
->prev
= ipp
->last
;
2929 * If blocking is disabled, stop here...
2935 case IPP_STATE_ATTRIBUTE
:
2938 if ((*cb
)(src
, buffer
, 1) < 1)
2940 DEBUG_puts("1ippReadIO: Callback returned EOF/error");
2941 _cupsBufferRelease((char *)buffer
);
2942 return (IPP_STATE_ERROR
);
2945 DEBUG_printf(("2ippReadIO: ipp->current=%p, ipp->prev=%p", (void *)ipp
->current
, (void *)ipp
->prev
));
2948 * Read this attribute...
2951 tag
= (ipp_tag_t
)buffer
[0];
2952 if (tag
== IPP_TAG_EXTENSION
)
2955 * Read 32-bit "extension" tag...
2958 if ((*cb
)(src
, buffer
, 4) < 1)
2960 DEBUG_puts("1ippReadIO: Callback returned EOF/error");
2961 _cupsBufferRelease((char *)buffer
);
2962 return (IPP_STATE_ERROR
);
2965 tag
= (ipp_tag_t
)((((((buffer
[0] << 8) | buffer
[1]) << 8) |
2966 buffer
[2]) << 8) | buffer
[3]);
2968 if (tag
& IPP_TAG_CUPS_CONST
)
2971 * Fail if the high bit is set in the tag...
2974 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("IPP extension tag larger than 0x7FFFFFFF."), 1);
2975 DEBUG_printf(("1ippReadIO: bad tag 0x%x.", tag
));
2976 _cupsBufferRelease((char *)buffer
);
2977 return (IPP_STATE_ERROR
);
2981 if (tag
== IPP_TAG_END
)
2984 * No more attributes left...
2987 DEBUG_puts("2ippReadIO: IPP_TAG_END.");
2989 ipp
->state
= IPP_STATE_DATA
;
2992 else if (tag
== IPP_TAG_ZERO
|| (tag
== IPP_TAG_OPERATION
&& ipp
->curtag
!= IPP_TAG_ZERO
))
2994 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("Invalid group tag."), 1);
2995 DEBUG_printf(("1ippReadIO: bad tag 0x%02x.", tag
));
2996 _cupsBufferRelease((char *)buffer
);
2997 return (IPP_STATE_ERROR
);
2999 else if (tag
< IPP_TAG_UNSUPPORTED_VALUE
)
3002 * Group tag... Set the current group and continue...
3005 if (ipp
->curtag
== tag
)
3006 ipp
->prev
= ippAddSeparator(ipp
);
3007 else if (ipp
->current
)
3008 ipp
->prev
= ipp
->current
;
3011 ipp
->current
= NULL
;
3012 DEBUG_printf(("2ippReadIO: group tag=%x(%s), ipp->prev=%p", tag
, ippTagString(tag
), (void *)ipp
->prev
));
3016 DEBUG_printf(("2ippReadIO: value tag=%x(%s)", tag
,
3017 ippTagString(tag
)));
3023 if ((*cb
)(src
, buffer
, 2) < 2)
3025 DEBUG_puts("1ippReadIO: unable to read name length.");
3026 _cupsBufferRelease((char *)buffer
);
3027 return (IPP_STATE_ERROR
);
3030 n
= (buffer
[0] << 8) | buffer
[1];
3032 if (n
>= IPP_BUF_SIZE
)
3034 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("IPP name larger than 32767 bytes."), 1);
3035 DEBUG_printf(("1ippReadIO: bad name length %d.", n
));
3036 _cupsBufferRelease((char *)buffer
);
3037 return (IPP_STATE_ERROR
);
3040 DEBUG_printf(("2ippReadIO: name length=%d", n
));
3042 if (n
== 0 && tag
!= IPP_TAG_MEMBERNAME
&&
3043 tag
!= IPP_TAG_END_COLLECTION
)
3046 * More values for current attribute...
3049 if (ipp
->current
== NULL
)
3051 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("IPP attribute has no name."), 1);
3052 DEBUG_puts("1ippReadIO: Attribute without name and no current.");
3053 _cupsBufferRelease((char *)buffer
);
3054 return (IPP_STATE_ERROR
);
3057 attr
= ipp
->current
;
3058 value_tag
= (ipp_tag_t
)(attr
->value_tag
& IPP_TAG_CUPS_MASK
);
3061 * Make sure we aren't adding a new value of a different
3065 if (value_tag
== IPP_TAG_ZERO
)
3068 * Setting the value of a collection member...
3071 attr
->value_tag
= tag
;
3073 else if (value_tag
== IPP_TAG_TEXTLANG
||
3074 value_tag
== IPP_TAG_NAMELANG
||
3075 (value_tag
>= IPP_TAG_TEXT
&&
3076 value_tag
<= IPP_TAG_MIMETYPE
))
3079 * String values can sometimes come across in different
3080 * forms; accept sets of differing values...
3083 if (tag
!= IPP_TAG_TEXTLANG
&& tag
!= IPP_TAG_NAMELANG
&&
3084 (tag
< IPP_TAG_TEXT
|| tag
> IPP_TAG_MIMETYPE
) &&
3085 tag
!= IPP_TAG_NOVALUE
)
3087 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3088 _("IPP 1setOf attribute with incompatible value "
3090 DEBUG_printf(("1ippReadIO: 1setOf value tag %x(%s) != %x(%s)",
3091 value_tag
, ippTagString(value_tag
), tag
,
3092 ippTagString(tag
)));
3093 _cupsBufferRelease((char *)buffer
);
3094 return (IPP_STATE_ERROR
);
3097 if (value_tag
!= tag
)
3099 DEBUG_printf(("1ippReadIO: Converting %s attribute from %s to %s.",
3100 attr
->name
, ippTagString(value_tag
), ippTagString(tag
)));
3101 ippSetValueTag(ipp
, &attr
, tag
);
3104 else if (value_tag
== IPP_TAG_INTEGER
||
3105 value_tag
== IPP_TAG_RANGE
)
3108 * Integer and rangeOfInteger values can sometimes be mixed; accept
3109 * sets of differing values...
3112 if (tag
!= IPP_TAG_INTEGER
&& tag
!= IPP_TAG_RANGE
)
3114 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3115 _("IPP 1setOf attribute with incompatible value "
3117 DEBUG_printf(("1ippReadIO: 1setOf value tag %x(%s) != %x(%s)",
3118 value_tag
, ippTagString(value_tag
), tag
,
3119 ippTagString(tag
)));
3120 _cupsBufferRelease((char *)buffer
);
3121 return (IPP_STATE_ERROR
);
3124 if (value_tag
== IPP_TAG_INTEGER
&& tag
== IPP_TAG_RANGE
)
3127 * Convert integer values to rangeOfInteger values...
3130 DEBUG_printf(("1ippReadIO: Converting %s attribute to "
3131 "rangeOfInteger.", attr
->name
));
3132 ippSetValueTag(ipp
, &attr
, IPP_TAG_RANGE
);
3135 else if (value_tag
!= tag
)
3137 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3138 _("IPP 1setOf attribute with incompatible value "
3140 DEBUG_printf(("1ippReadIO: value tag %x(%s) != %x(%s)",
3141 value_tag
, ippTagString(value_tag
), tag
,
3142 ippTagString(tag
)));
3143 _cupsBufferRelease((char *)buffer
);
3144 return (IPP_STATE_ERROR
);
3148 * Finally, reallocate the attribute array as needed...
3151 if ((value
= ipp_set_value(ipp
, &attr
, attr
->num_values
)) == NULL
)
3153 _cupsBufferRelease((char *)buffer
);
3154 return (IPP_STATE_ERROR
);
3157 else if (tag
== IPP_TAG_MEMBERNAME
)
3160 * Name must be length 0!
3165 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("IPP member name is not empty."), 1);
3166 DEBUG_puts("1ippReadIO: member name not empty.");
3167 _cupsBufferRelease((char *)buffer
);
3168 return (IPP_STATE_ERROR
);
3172 ipp
->prev
= ipp
->current
;
3174 attr
= ipp
->current
= ipp_add_attr(ipp
, NULL
, ipp
->curtag
, IPP_TAG_ZERO
, 1);
3177 _cupsSetHTTPError(HTTP_STATUS_ERROR
);
3178 DEBUG_puts("1ippReadIO: unable to allocate attribute.");
3179 _cupsBufferRelease((char *)buffer
);
3180 return (IPP_STATE_ERROR
);
3183 DEBUG_printf(("2ippReadIO: membername, ipp->current=%p, ipp->prev=%p", (void *)ipp
->current
, (void *)ipp
->prev
));
3185 value
= attr
->values
;
3187 else if (tag
!= IPP_TAG_END_COLLECTION
)
3190 * New attribute; read the name and add it...
3193 if ((*cb
)(src
, buffer
, (size_t)n
) < n
)
3195 DEBUG_puts("1ippReadIO: unable to read name.");
3196 _cupsBufferRelease((char *)buffer
);
3197 return (IPP_STATE_ERROR
);
3203 ipp
->prev
= ipp
->current
;
3205 if ((attr
= ipp
->current
= ipp_add_attr(ipp
, (char *)buffer
, ipp
->curtag
, tag
,
3208 _cupsSetHTTPError(HTTP_STATUS_ERROR
);
3209 DEBUG_puts("1ippReadIO: unable to allocate attribute.");
3210 _cupsBufferRelease((char *)buffer
);
3211 return (IPP_STATE_ERROR
);
3214 DEBUG_printf(("2ippReadIO: name=\"%s\", ipp->current=%p, ipp->prev=%p", buffer
, (void *)ipp
->current
, (void *)ipp
->prev
));
3216 value
= attr
->values
;
3224 if ((*cb
)(src
, buffer
, 2) < 2)
3226 DEBUG_puts("1ippReadIO: unable to read value length.");
3227 _cupsBufferRelease((char *)buffer
);
3228 return (IPP_STATE_ERROR
);
3231 n
= (buffer
[0] << 8) | buffer
[1];
3232 DEBUG_printf(("2ippReadIO: value length=%d", n
));
3234 if (n
>= IPP_BUF_SIZE
)
3236 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3237 _("IPP value larger than 32767 bytes."), 1);
3238 DEBUG_printf(("1ippReadIO: bad value length %d.", n
));
3239 _cupsBufferRelease((char *)buffer
);
3240 return (IPP_STATE_ERROR
);
3245 case IPP_TAG_INTEGER
:
3249 if (tag
== IPP_TAG_INTEGER
)
3250 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3251 _("IPP integer value not 4 bytes."), 1);
3253 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3254 _("IPP enum value not 4 bytes."), 1);
3255 DEBUG_printf(("1ippReadIO: bad integer value length %d.", n
));
3256 _cupsBufferRelease((char *)buffer
);
3257 return (IPP_STATE_ERROR
);
3260 if ((*cb
)(src
, buffer
, 4) < 4)
3262 DEBUG_puts("1ippReadIO: Unable to read integer value.");
3263 _cupsBufferRelease((char *)buffer
);
3264 return (IPP_STATE_ERROR
);
3267 n
= (((((buffer
[0] << 8) | buffer
[1]) << 8) | buffer
[2]) << 8) |
3270 if (attr
->value_tag
== IPP_TAG_RANGE
)
3271 value
->range
.lower
= value
->range
.upper
= n
;
3276 case IPP_TAG_BOOLEAN
:
3279 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("IPP boolean value not 1 byte."),
3281 DEBUG_printf(("1ippReadIO: bad boolean value length %d.", n
));
3282 _cupsBufferRelease((char *)buffer
);
3283 return (IPP_STATE_ERROR
);
3286 if ((*cb
)(src
, buffer
, 1) < 1)
3288 DEBUG_puts("1ippReadIO: Unable to read boolean value.");
3289 _cupsBufferRelease((char *)buffer
);
3290 return (IPP_STATE_ERROR
);
3293 value
->boolean
= (char)buffer
[0];
3296 case IPP_TAG_UNSUPPORTED_VALUE
:
3297 case IPP_TAG_DEFAULT
:
3298 case IPP_TAG_UNKNOWN
:
3299 case IPP_TAG_NOVALUE
:
3300 case IPP_TAG_NOTSETTABLE
:
3301 case IPP_TAG_DELETEATTR
:
3302 case IPP_TAG_ADMINDEFINE
:
3304 * These value types are not supposed to have values, however
3305 * some vendors (Brother) do not implement IPP correctly and so
3306 * we need to map non-empty values to text...
3309 if (attr
->value_tag
== tag
)
3314 attr
->value_tag
= IPP_TAG_TEXT
;
3319 case IPP_TAG_RESERVED_STRING
:
3320 case IPP_TAG_KEYWORD
:
3322 case IPP_TAG_URISCHEME
:
3323 case IPP_TAG_CHARSET
:
3324 case IPP_TAG_LANGUAGE
:
3325 case IPP_TAG_MIMETYPE
:
3328 if ((*cb
)(src
, buffer
, (size_t)n
) < n
)
3330 DEBUG_puts("1ippReadIO: unable to read string value.");
3331 _cupsBufferRelease((char *)buffer
);
3332 return (IPP_STATE_ERROR
);
3337 value
->string
.text
= _cupsStrAlloc((char *)buffer
);
3338 DEBUG_printf(("2ippReadIO: value=\"%s\"", value
->string
.text
));
3344 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("IPP date value not 11 bytes."), 1);
3345 DEBUG_printf(("1ippReadIO: bad date value length %d.", n
));
3346 _cupsBufferRelease((char *)buffer
);
3347 return (IPP_STATE_ERROR
);
3350 if ((*cb
)(src
, value
->date
, 11) < 11)
3352 DEBUG_puts("1ippReadIO: Unable to read date value.");
3353 _cupsBufferRelease((char *)buffer
);
3354 return (IPP_STATE_ERROR
);
3358 case IPP_TAG_RESOLUTION
:
3361 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3362 _("IPP resolution value not 9 bytes."), 1);
3363 DEBUG_printf(("1ippReadIO: bad resolution value length %d.", n
));
3364 _cupsBufferRelease((char *)buffer
);
3365 return (IPP_STATE_ERROR
);
3368 if ((*cb
)(src
, buffer
, 9) < 9)
3370 DEBUG_puts("1ippReadIO: Unable to read resolution value.");
3371 _cupsBufferRelease((char *)buffer
);
3372 return (IPP_STATE_ERROR
);
3375 value
->resolution
.xres
=
3376 (((((buffer
[0] << 8) | buffer
[1]) << 8) | buffer
[2]) << 8) |
3378 value
->resolution
.yres
=
3379 (((((buffer
[4] << 8) | buffer
[5]) << 8) | buffer
[6]) << 8) |
3381 value
->resolution
.units
=
3382 (ipp_res_t
)buffer
[8];
3385 case IPP_TAG_RANGE
:
3388 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3389 _("IPP rangeOfInteger value not 8 bytes."), 1);
3390 DEBUG_printf(("1ippReadIO: bad rangeOfInteger value length "
3392 _cupsBufferRelease((char *)buffer
);
3393 return (IPP_STATE_ERROR
);
3396 if ((*cb
)(src
, buffer
, 8) < 8)
3398 DEBUG_puts("1ippReadIO: Unable to read range value.");
3399 _cupsBufferRelease((char *)buffer
);
3400 return (IPP_STATE_ERROR
);
3403 value
->range
.lower
=
3404 (((((buffer
[0] << 8) | buffer
[1]) << 8) | buffer
[2]) << 8) |
3406 value
->range
.upper
=
3407 (((((buffer
[4] << 8) | buffer
[5]) << 8) | buffer
[6]) << 8) |
3411 case IPP_TAG_TEXTLANG
:
3412 case IPP_TAG_NAMELANG
:
3415 if (tag
== IPP_TAG_TEXTLANG
)
3416 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3417 _("IPP textWithLanguage value less than "
3418 "minimum 4 bytes."), 1);
3420 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3421 _("IPP nameWithLanguage value less than "
3422 "minimum 4 bytes."), 1);
3423 DEBUG_printf(("1ippReadIO: bad stringWithLanguage value "
3425 _cupsBufferRelease((char *)buffer
);
3426 return (IPP_STATE_ERROR
);
3429 if ((*cb
)(src
, buffer
, (size_t)n
) < n
)
3431 DEBUG_puts("1ippReadIO: Unable to read string w/language "
3433 _cupsBufferRelease((char *)buffer
);
3434 return (IPP_STATE_ERROR
);
3440 * text-with-language and name-with-language are composite
3449 n
= (bufptr
[0] << 8) | bufptr
[1];
3451 if ((bufptr
+ 2 + n
) >= (buffer
+ IPP_BUF_SIZE
) || n
>= (int)sizeof(string
))
3453 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3454 _("IPP language length overflows value."), 1);
3455 DEBUG_printf(("1ippReadIO: bad language value length %d.",
3457 _cupsBufferRelease((char *)buffer
);
3458 return (IPP_STATE_ERROR
);
3460 else if (n
>= IPP_MAX_LANGUAGE
)
3462 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3463 _("IPP language length too large."), 1);
3464 DEBUG_printf(("1ippReadIO: bad language value length %d.",
3466 _cupsBufferRelease((char *)buffer
);
3467 return (IPP_STATE_ERROR
);
3470 memcpy(string
, bufptr
+ 2, (size_t)n
);
3473 value
->string
.language
= _cupsStrAlloc((char *)string
);
3476 n
= (bufptr
[0] << 8) | bufptr
[1];
3478 if ((bufptr
+ 2 + n
) >= (buffer
+ IPP_BUF_SIZE
))
3480 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3481 _("IPP string length overflows value."), 1);
3482 DEBUG_printf(("1ippReadIO: bad string value length %d.", n
));
3483 _cupsBufferRelease((char *)buffer
);
3484 return (IPP_STATE_ERROR
);
3487 bufptr
[2 + n
] = '\0';
3488 value
->string
.text
= _cupsStrAlloc((char *)bufptr
+ 2);
3491 case IPP_TAG_BEGIN_COLLECTION
:
3493 * Oh, boy, here comes a collection value, so read it...
3496 value
->collection
= ippNew();
3500 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3501 _("IPP begCollection value not 0 bytes."), 1);
3502 DEBUG_puts("1ippReadIO: begCollection tag with value length "
3504 _cupsBufferRelease((char *)buffer
);
3505 return (IPP_STATE_ERROR
);
3508 if (ippReadIO(src
, cb
, 1, ipp
, value
->collection
) == IPP_STATE_ERROR
)
3510 DEBUG_puts("1ippReadIO: Unable to read collection value.");
3511 _cupsBufferRelease((char *)buffer
);
3512 return (IPP_STATE_ERROR
);
3516 case IPP_TAG_END_COLLECTION
:
3517 _cupsBufferRelease((char *)buffer
);
3521 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3522 _("IPP endCollection value not 0 bytes."), 1);
3523 DEBUG_puts("1ippReadIO: endCollection tag with value length "
3525 return (IPP_STATE_ERROR
);
3528 DEBUG_puts("1ippReadIO: endCollection tag...");
3529 return (ipp
->state
= IPP_STATE_DATA
);
3531 case IPP_TAG_MEMBERNAME
:
3533 * The value the name of the member in the collection, which
3534 * we need to carry over...
3539 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3540 _("IPP memberName with no attribute."), 1);
3541 DEBUG_puts("1ippReadIO: Member name without attribute.");
3542 _cupsBufferRelease((char *)buffer
);
3543 return (IPP_STATE_ERROR
);
3547 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3548 _("IPP memberName value is empty."), 1);
3549 DEBUG_puts("1ippReadIO: Empty member name value.");
3550 _cupsBufferRelease((char *)buffer
);
3551 return (IPP_STATE_ERROR
);
3553 else if ((*cb
)(src
, buffer
, (size_t)n
) < n
)
3555 DEBUG_puts("1ippReadIO: Unable to read member name value.");
3556 _cupsBufferRelease((char *)buffer
);
3557 return (IPP_STATE_ERROR
);
3561 attr
->name
= _cupsStrAlloc((char *)buffer
);
3564 * Since collection members are encoded differently than
3565 * regular attributes, make sure we don't start with an
3569 attr
->num_values
--;
3571 DEBUG_printf(("2ippReadIO: member name=\"%s\"", attr
->name
));
3574 case IPP_TAG_STRING
:
3575 default : /* Other unsupported values */
3576 if (tag
== IPP_TAG_STRING
&& n
> IPP_MAX_LENGTH
)
3578 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
3579 _("IPP octetString length too large."), 1);
3580 DEBUG_printf(("1ippReadIO: bad octetString value length %d.",
3582 _cupsBufferRelease((char *)buffer
);
3583 return (IPP_STATE_ERROR
);
3586 value
->unknown
.length
= n
;
3590 if ((value
->unknown
.data
= malloc((size_t)n
)) == NULL
)
3592 _cupsSetHTTPError(HTTP_STATUS_ERROR
);
3593 DEBUG_puts("1ippReadIO: Unable to allocate value");
3594 _cupsBufferRelease((char *)buffer
);
3595 return (IPP_STATE_ERROR
);
3598 if ((*cb
)(src
, value
->unknown
.data
, (size_t)n
) < n
)
3600 DEBUG_puts("1ippReadIO: Unable to read unsupported value.");
3601 _cupsBufferRelease((char *)buffer
);
3602 return (IPP_STATE_ERROR
);
3606 value
->unknown
.data
= NULL
;
3611 * If blocking is disabled, stop here...
3619 case IPP_STATE_DATA
:
3623 break; /* anti-compiler-warning-code */
3626 DEBUG_printf(("1ippReadIO: returning ipp->state=%d.", ipp
->state
));
3627 _cupsBufferRelease((char *)buffer
);
3629 return (ipp
->state
);
3634 * 'ippSetBoolean()' - Set a boolean value in an attribute.
3636 * The @code ipp@ parameter refers to an IPP message previously created using
3637 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
3639 * The @code attr@ parameter may be modified as a result of setting the value.
3641 * The @code element@ parameter specifies which value to set from 0 to
3642 * @code ippGetCount(attr)@.
3644 * @since CUPS 1.6/macOS 10.8@
3647 int /* O - 1 on success, 0 on failure */
3648 ippSetBoolean(ipp_t
*ipp
, /* I - IPP message */
3649 ipp_attribute_t
**attr
, /* IO - IPP attribute */
3650 int element
, /* I - Value number (0-based) */
3651 int boolvalue
)/* I - Boolean value */
3653 _ipp_value_t
*value
; /* Current value */
3657 * Range check input...
3660 if (!ipp
|| !attr
|| !*attr
|| (*attr
)->value_tag
!= IPP_TAG_BOOLEAN
||
3661 element
< 0 || element
> (*attr
)->num_values
)
3665 * Set the value and return...
3668 if ((value
= ipp_set_value(ipp
, attr
, element
)) != NULL
)
3669 value
->boolean
= (char)boolvalue
;
3671 return (value
!= NULL
);
3676 * 'ippSetCollection()' - Set a collection value in an attribute.
3678 * The @code ipp@ parameter refers to an IPP message previously created using
3679 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
3681 * The @code attr@ parameter may be modified as a result of setting the value.
3683 * The @code element@ parameter specifies which value to set from 0 to
3684 * @code ippGetCount(attr)@.
3686 * @since CUPS 1.6/macOS 10.8@
3689 int /* O - 1 on success, 0 on failure */
3691 ipp_t
*ipp
, /* I - IPP message */
3692 ipp_attribute_t
**attr
, /* IO - IPP attribute */
3693 int element
, /* I - Value number (0-based) */
3694 ipp_t
*colvalue
) /* I - Collection value */
3696 _ipp_value_t
*value
; /* Current value */
3700 * Range check input...
3703 if (!ipp
|| !attr
|| !*attr
|| (*attr
)->value_tag
!= IPP_TAG_BEGIN_COLLECTION
||
3704 element
< 0 || element
> (*attr
)->num_values
|| !colvalue
)
3708 * Set the value and return...
3711 if ((value
= ipp_set_value(ipp
, attr
, element
)) != NULL
)
3713 if (value
->collection
)
3714 ippDelete(value
->collection
);
3716 value
->collection
= colvalue
;
3720 return (value
!= NULL
);
3725 * 'ippSetDate()' - Set a dateTime value in an attribute.
3727 * The @code ipp@ parameter refers to an IPP message previously created using
3728 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
3730 * The @code attr@ parameter may be modified as a result of setting the value.
3732 * The @code element@ parameter specifies which value to set from 0 to
3733 * @code ippGetCount(attr)@.
3735 * @since CUPS 1.6/macOS 10.8@
3738 int /* O - 1 on success, 0 on failure */
3739 ippSetDate(ipp_t
*ipp
, /* I - IPP message */
3740 ipp_attribute_t
**attr
, /* IO - IPP attribute */
3741 int element
, /* I - Value number (0-based) */
3742 const ipp_uchar_t
*datevalue
)/* I - dateTime value */
3744 _ipp_value_t
*value
; /* Current value */
3748 * Range check input...
3751 if (!ipp
|| !attr
|| !*attr
|| (*attr
)->value_tag
!= IPP_TAG_DATE
||
3752 element
< 0 || element
> (*attr
)->num_values
|| !datevalue
)
3756 * Set the value and return...
3759 if ((value
= ipp_set_value(ipp
, attr
, element
)) != NULL
)
3760 memcpy(value
->date
, datevalue
, sizeof(value
->date
));
3762 return (value
!= NULL
);
3767 * 'ippSetGroupTag()' - Set the group tag of an attribute.
3769 * The @code ipp@ parameter refers to an IPP message previously created using
3770 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
3772 * The @code attr@ parameter may be modified as a result of setting the value.
3774 * The @code group@ parameter specifies the IPP attribute group tag: none
3775 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
3776 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
3777 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
3778 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
3780 * @since CUPS 1.6/macOS 10.8@
3783 int /* O - 1 on success, 0 on failure */
3785 ipp_t
*ipp
, /* I - IPP message */
3786 ipp_attribute_t
**attr
, /* IO - Attribute */
3787 ipp_tag_t group_tag
) /* I - Group tag */
3790 * Range check input - group tag must be 0x01 to 0x0F, per RFC 8011...
3793 if (!ipp
|| !attr
|| !*attr
||
3794 group_tag
< IPP_TAG_ZERO
|| group_tag
== IPP_TAG_END
||
3795 group_tag
>= IPP_TAG_UNSUPPORTED_VALUE
)
3799 * Set the group tag and return...
3802 (*attr
)->group_tag
= group_tag
;
3809 * 'ippSetInteger()' - Set an integer or enum value in an attribute.
3811 * The @code ipp@ parameter refers to an IPP message previously created using
3812 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
3814 * The @code attr@ parameter may be modified as a result of setting the value.
3816 * The @code element@ parameter specifies which value to set from 0 to
3817 * @code ippGetCount(attr)@.
3819 * @since CUPS 1.6/macOS 10.8@
3822 int /* O - 1 on success, 0 on failure */
3823 ippSetInteger(ipp_t
*ipp
, /* I - IPP message */
3824 ipp_attribute_t
**attr
, /* IO - IPP attribute */
3825 int element
, /* I - Value number (0-based) */
3826 int intvalue
) /* I - Integer/enum value */
3828 _ipp_value_t
*value
; /* Current value */
3832 * Range check input...
3835 if (!ipp
|| !attr
|| !*attr
||
3836 ((*attr
)->value_tag
!= IPP_TAG_INTEGER
&& (*attr
)->value_tag
!= IPP_TAG_ENUM
) ||
3837 element
< 0 || element
> (*attr
)->num_values
)
3841 * Set the value and return...
3844 if ((value
= ipp_set_value(ipp
, attr
, element
)) != NULL
)
3845 value
->integer
= intvalue
;
3847 return (value
!= NULL
);
3852 * 'ippSetName()' - Set the name of an attribute.
3854 * The @code ipp@ parameter refers to an IPP message previously created using
3855 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
3857 * The @code attr@ parameter may be modified as a result of setting the value.
3859 * @since CUPS 1.6/macOS 10.8@
3862 int /* O - 1 on success, 0 on failure */
3863 ippSetName(ipp_t
*ipp
, /* I - IPP message */
3864 ipp_attribute_t
**attr
, /* IO - IPP attribute */
3865 const char *name
) /* I - Attribute name */
3867 char *temp
; /* Temporary name value */
3871 * Range check input...
3874 if (!ipp
|| !attr
|| !*attr
)
3878 * Set the value and return...
3881 if ((temp
= _cupsStrAlloc(name
)) != NULL
)
3884 _cupsStrFree((*attr
)->name
);
3886 (*attr
)->name
= temp
;
3889 return (temp
!= NULL
);
3894 * 'ippSetOctetString()' - Set an octetString value in an IPP attribute.
3896 * The @code ipp@ parameter refers to an IPP message previously created using
3897 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
3899 * The @code attr@ parameter may be modified as a result of setting the value.
3901 * The @code element@ parameter specifies which value to set from 0 to
3902 * @code ippGetCount(attr)@.
3904 * @since CUPS 1.7/macOS 10.9@
3907 int /* O - 1 on success, 0 on failure */
3909 ipp_t
*ipp
, /* I - IPP message */
3910 ipp_attribute_t
**attr
, /* IO - IPP attribute */
3911 int element
, /* I - Value number (0-based) */
3912 const void *data
, /* I - Pointer to octetString data */
3913 int datalen
) /* I - Length of octetString data */
3915 _ipp_value_t
*value
; /* Current value */
3919 * Range check input...
3922 if (!ipp
|| !attr
|| !*attr
|| (*attr
)->value_tag
!= IPP_TAG_STRING
||
3923 element
< 0 || element
> (*attr
)->num_values
||
3924 datalen
< 0 || datalen
> IPP_MAX_LENGTH
)
3928 * Set the value and return...
3931 if ((value
= ipp_set_value(ipp
, attr
, element
)) != NULL
)
3933 if ((int)((*attr
)->value_tag
) & IPP_TAG_CUPS_CONST
)
3936 * Just copy the pointer...
3939 value
->unknown
.data
= (void *)data
;
3940 value
->unknown
.length
= datalen
;
3948 if (value
->unknown
.data
)
3951 * Free previous data...
3954 free(value
->unknown
.data
);
3956 value
->unknown
.data
= NULL
;
3957 value
->unknown
.length
= 0;
3962 void *temp
; /* Temporary data pointer */
3964 if ((temp
= malloc((size_t)datalen
)) != NULL
)
3966 memcpy(temp
, data
, (size_t)datalen
);
3968 value
->unknown
.data
= temp
;
3969 value
->unknown
.length
= datalen
;
3977 return (value
!= NULL
);
3982 * 'ippSetOperation()' - Set the operation ID in an IPP request message.
3984 * The @code ipp@ parameter refers to an IPP message previously created using
3985 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
3987 * @since CUPS 1.6/macOS 10.8@
3990 int /* O - 1 on success, 0 on failure */
3991 ippSetOperation(ipp_t
*ipp
, /* I - IPP request message */
3992 ipp_op_t op
) /* I - Operation ID */
3995 * Range check input...
4002 * Set the operation and return...
4005 ipp
->request
.op
.operation_id
= op
;
4012 * 'ippSetRange()' - Set a rangeOfInteger value in an attribute.
4014 * The @code ipp@ parameter refers to an IPP message previously created using
4015 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
4017 * The @code attr@ parameter may be modified as a result of setting the value.
4019 * The @code element@ parameter specifies which value to set from 0 to
4020 * @code ippGetCount(attr)@.
4022 * @since CUPS 1.6/macOS 10.8@
4025 int /* O - 1 on success, 0 on failure */
4026 ippSetRange(ipp_t
*ipp
, /* I - IPP message */
4027 ipp_attribute_t
**attr
, /* IO - IPP attribute */
4028 int element
, /* I - Value number (0-based) */
4029 int lowervalue
, /* I - Lower bound for range */
4030 int uppervalue
) /* I - Upper bound for range */
4032 _ipp_value_t
*value
; /* Current value */
4036 * Range check input...
4039 if (!ipp
|| !attr
|| !*attr
|| (*attr
)->value_tag
!= IPP_TAG_RANGE
||
4040 element
< 0 || element
> (*attr
)->num_values
|| lowervalue
> uppervalue
)
4044 * Set the value and return...
4047 if ((value
= ipp_set_value(ipp
, attr
, element
)) != NULL
)
4049 value
->range
.lower
= lowervalue
;
4050 value
->range
.upper
= uppervalue
;
4053 return (value
!= NULL
);
4058 * 'ippSetRequestId()' - Set the request ID in an IPP message.
4060 * The @code ipp@ parameter refers to an IPP message previously created using
4061 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
4063 * The @code request_id@ parameter must be greater than 0.
4065 * @since CUPS 1.6/macOS 10.8@
4068 int /* O - 1 on success, 0 on failure */
4069 ippSetRequestId(ipp_t
*ipp
, /* I - IPP message */
4070 int request_id
) /* I - Request ID */
4073 * Range check input; not checking request_id values since ipptool wants to send
4074 * invalid values for conformance testing and a bad request_id does not affect the
4075 * encoding of a message...
4082 * Set the request ID and return...
4085 ipp
->request
.any
.request_id
= request_id
;
4092 * 'ippSetResolution()' - Set a resolution value in an attribute.
4094 * The @code ipp@ parameter refers to an IPP message previously created using
4095 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
4097 * The @code attr@ parameter may be modified as a result of setting the value.
4099 * The @code element@ parameter specifies which value to set from 0 to
4100 * @code ippGetCount(attr)@.
4102 * @since CUPS 1.6/macOS 10.8@
4105 int /* O - 1 on success, 0 on failure */
4107 ipp_t
*ipp
, /* I - IPP message */
4108 ipp_attribute_t
**attr
, /* IO - IPP attribute */
4109 int element
, /* I - Value number (0-based) */
4110 ipp_res_t unitsvalue
, /* I - Resolution units */
4111 int xresvalue
, /* I - Horizontal/cross feed resolution */
4112 int yresvalue
) /* I - Vertical/feed resolution */
4114 _ipp_value_t
*value
; /* Current value */
4118 * Range check input...
4121 if (!ipp
|| !attr
|| !*attr
|| (*attr
)->value_tag
!= IPP_TAG_RESOLUTION
||
4122 element
< 0 || element
> (*attr
)->num_values
|| xresvalue
<= 0 || yresvalue
<= 0 ||
4123 unitsvalue
< IPP_RES_PER_INCH
|| unitsvalue
> IPP_RES_PER_CM
)
4127 * Set the value and return...
4130 if ((value
= ipp_set_value(ipp
, attr
, element
)) != NULL
)
4132 value
->resolution
.units
= unitsvalue
;
4133 value
->resolution
.xres
= xresvalue
;
4134 value
->resolution
.yres
= yresvalue
;
4137 return (value
!= NULL
);
4142 * 'ippSetState()' - Set the current state of the IPP message.
4144 * @since CUPS 1.6/macOS 10.8@
4147 int /* O - 1 on success, 0 on failure */
4148 ippSetState(ipp_t
*ipp
, /* I - IPP message */
4149 ipp_state_t state
) /* I - IPP state value */
4152 * Range check input...
4159 * Set the state and return...
4163 ipp
->current
= NULL
;
4170 * 'ippSetStatusCode()' - Set the status code in an IPP response or event message.
4172 * The @code ipp@ parameter refers to an IPP message previously created using
4173 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
4175 * @since CUPS 1.6/macOS 10.8@
4178 int /* O - 1 on success, 0 on failure */
4179 ippSetStatusCode(ipp_t
*ipp
, /* I - IPP response or event message */
4180 ipp_status_t status
) /* I - Status code */
4183 * Range check input...
4190 * Set the status code and return...
4193 ipp
->request
.status
.status_code
= status
;
4200 * 'ippSetString()' - Set a string value in an attribute.
4202 * The @code ipp@ parameter refers to an IPP message previously created using
4203 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
4205 * The @code attr@ parameter may be modified as a result of setting the value.
4207 * The @code element@ parameter specifies which value to set from 0 to
4208 * @code ippGetCount(attr)@.
4210 * @since CUPS 1.6/macOS 10.8@
4213 int /* O - 1 on success, 0 on failure */
4214 ippSetString(ipp_t
*ipp
, /* I - IPP message */
4215 ipp_attribute_t
**attr
, /* IO - IPP attribute */
4216 int element
, /* I - Value number (0-based) */
4217 const char *strvalue
) /* I - String value */
4219 char *temp
; /* Temporary string */
4220 _ipp_value_t
*value
; /* Current value */
4221 ipp_tag_t value_tag
; /* Value tag */
4225 * Range check input...
4229 value_tag
= (*attr
)->value_tag
& IPP_TAG_CUPS_MASK
;
4231 value_tag
= IPP_TAG_ZERO
;
4233 if (!ipp
|| !attr
|| !*attr
||
4234 (value_tag
< IPP_TAG_TEXT
&& value_tag
!= IPP_TAG_TEXTLANG
&&
4235 value_tag
!= IPP_TAG_NAMELANG
) || value_tag
> IPP_TAG_MIMETYPE
||
4236 element
< 0 || element
> (*attr
)->num_values
|| !strvalue
)
4240 * Set the value and return...
4243 if ((value
= ipp_set_value(ipp
, attr
, element
)) != NULL
)
4246 value
->string
.language
= (*attr
)->values
[0].string
.language
;
4248 if ((int)((*attr
)->value_tag
) & IPP_TAG_CUPS_CONST
)
4249 value
->string
.text
= (char *)strvalue
;
4250 else if ((temp
= _cupsStrAlloc(strvalue
)) != NULL
)
4252 if (value
->string
.text
)
4253 _cupsStrFree(value
->string
.text
);
4255 value
->string
.text
= temp
;
4261 return (value
!= NULL
);
4266 * 'ippSetStringf()' - Set a formatted string value of an attribute.
4268 * The @code ipp@ parameter refers to an IPP message previously created using
4269 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
4271 * The @code attr@ parameter may be modified as a result of setting the value.
4273 * The @code element@ parameter specifies which value to set from 0 to
4274 * @code ippGetCount(attr)@.
4276 * The @code format@ parameter uses formatting characters compatible with the
4277 * printf family of standard functions. Additional arguments follow it as
4278 * needed. The formatted string is truncated as needed to the maximum length of
4279 * the corresponding value type.
4281 * @since CUPS 1.7/macOS 10.9@
4284 int /* O - 1 on success, 0 on failure */
4285 ippSetStringf(ipp_t
*ipp
, /* I - IPP message */
4286 ipp_attribute_t
**attr
, /* IO - IPP attribute */
4287 int element
, /* I - Value number (0-based) */
4288 const char *format
, /* I - Printf-style format string */
4289 ...) /* I - Additional arguments as needed */
4291 int ret
; /* Return value */
4292 va_list ap
; /* Pointer to additional arguments */
4295 va_start(ap
, format
);
4296 ret
= ippSetStringfv(ipp
, attr
, element
, format
, ap
);
4304 * 'ippSetStringf()' - Set a formatted string value of an attribute.
4306 * The @code ipp@ parameter refers to an IPP message previously created using
4307 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
4309 * The @code attr@ parameter may be modified as a result of setting the value.
4311 * The @code element@ parameter specifies which value to set from 0 to
4312 * @code ippGetCount(attr)@.
4314 * The @code format@ parameter uses formatting characters compatible with the
4315 * printf family of standard functions. Additional arguments follow it as
4316 * needed. The formatted string is truncated as needed to the maximum length of
4317 * the corresponding value type.
4319 * @since CUPS 1.7/macOS 10.9@
4322 int /* O - 1 on success, 0 on failure */
4323 ippSetStringfv(ipp_t
*ipp
, /* I - IPP message */
4324 ipp_attribute_t
**attr
, /* IO - IPP attribute */
4325 int element
, /* I - Value number (0-based) */
4326 const char *format
, /* I - Printf-style format string */
4327 va_list ap
) /* I - Pointer to additional arguments */
4329 ipp_tag_t value_tag
; /* Value tag */
4330 char buffer
[IPP_MAX_TEXT
+ 4];
4331 /* Formatted text string */
4332 ssize_t bytes
, /* Length of formatted value */
4333 max_bytes
; /* Maximum number of bytes for value */
4337 * Range check input...
4341 value_tag
= (*attr
)->value_tag
& IPP_TAG_CUPS_MASK
;
4343 value_tag
= IPP_TAG_ZERO
;
4345 if (!ipp
|| !attr
|| !*attr
||
4346 (value_tag
< IPP_TAG_TEXT
&& value_tag
!= IPP_TAG_TEXTLANG
&&
4347 value_tag
!= IPP_TAG_NAMELANG
) || value_tag
> IPP_TAG_MIMETYPE
||
4352 * Format the string...
4355 if (!strcmp(format
, "%s"))
4358 * Optimize the simple case...
4361 const char *s
= va_arg(ap
, char *);
4366 bytes
= (ssize_t
)strlen(s
);
4367 strlcpy(buffer
, s
, sizeof(buffer
));
4372 * Do a full formatting of the message...
4375 if ((bytes
= vsnprintf(buffer
, sizeof(buffer
), format
, ap
)) < 0)
4380 * Limit the length of the string...
4387 case IPP_TAG_TEXTLANG
:
4388 max_bytes
= IPP_MAX_TEXT
;
4392 case IPP_TAG_NAMELANG
:
4393 max_bytes
= IPP_MAX_NAME
;
4396 case IPP_TAG_CHARSET
:
4397 max_bytes
= IPP_MAX_CHARSET
;
4400 case IPP_TAG_KEYWORD
:
4401 max_bytes
= IPP_MAX_KEYWORD
;
4404 case IPP_TAG_LANGUAGE
:
4405 max_bytes
= IPP_MAX_LANGUAGE
;
4408 case IPP_TAG_MIMETYPE
:
4409 max_bytes
= IPP_MAX_MIMETYPE
;
4413 max_bytes
= IPP_MAX_URI
;
4416 case IPP_TAG_URISCHEME
:
4417 max_bytes
= IPP_MAX_URISCHEME
;
4421 if (bytes
>= max_bytes
)
4423 char *bufmax
, /* Buffer at max_bytes */
4424 *bufptr
; /* Pointer into buffer */
4426 bufptr
= buffer
+ strlen(buffer
) - 1;
4427 bufmax
= buffer
+ max_bytes
- 1;
4429 while (bufptr
> bufmax
)
4433 while ((*bufptr
& 0xc0) == 0x80 && bufptr
> buffer
)
4444 * Set the formatted string and return...
4447 return (ippSetString(ipp
, attr
, element
, buffer
));
4452 * 'ippSetValueTag()' - Set the value tag of an attribute.
4454 * The @code ipp@ parameter refers to an IPP message previously created using
4455 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
4457 * The @code attr@ parameter may be modified as a result of setting the value.
4459 * Integer (@code IPP_TAG_INTEGER@) values can be promoted to rangeOfInteger
4460 * (@code IPP_TAG_RANGE@) values, the various string tags can be promoted to name
4461 * (@code IPP_TAG_NAME@) or nameWithLanguage (@code IPP_TAG_NAMELANG@) values, text
4462 * (@code IPP_TAG_TEXT@) values can be promoted to textWithLanguage
4463 * (@code IPP_TAG_TEXTLANG@) values, and all values can be demoted to the various
4464 * out-of-band value tags such as no-value (@code IPP_TAG_NOVALUE@). All other changes
4467 * Promoting a string attribute to nameWithLanguage or textWithLanguage adds the language
4468 * code in the "attributes-natural-language" attribute or, if not present, the language
4469 * code for the current locale.
4471 * @since CUPS 1.6/macOS 10.8@
4474 int /* O - 1 on success, 0 on failure */
4476 ipp_t
*ipp
, /* I - IPP message */
4477 ipp_attribute_t
**attr
, /* IO - IPP attribute */
4478 ipp_tag_t value_tag
) /* I - Value tag */
4480 int i
; /* Looping var */
4481 _ipp_value_t
*value
; /* Current value */
4482 int integer
; /* Current integer value */
4483 cups_lang_t
*language
; /* Current language */
4484 char code
[32]; /* Language code */
4485 ipp_tag_t temp_tag
; /* Temporary value tag */
4489 * Range check input...
4492 if (!ipp
|| !attr
|| !*attr
)
4496 * If there is no change, return immediately...
4499 if (value_tag
== (*attr
)->value_tag
)
4503 * Otherwise implement changes as needed...
4506 temp_tag
= (ipp_tag_t
)((int)((*attr
)->value_tag
) & IPP_TAG_CUPS_MASK
);
4510 case IPP_TAG_UNSUPPORTED_VALUE
:
4511 case IPP_TAG_DEFAULT
:
4512 case IPP_TAG_UNKNOWN
:
4513 case IPP_TAG_NOVALUE
:
4514 case IPP_TAG_NOTSETTABLE
:
4515 case IPP_TAG_DELETEATTR
:
4516 case IPP_TAG_ADMINDEFINE
:
4518 * Free any existing values...
4521 if ((*attr
)->num_values
> 0)
4522 ipp_free_values(*attr
, 0, (*attr
)->num_values
);
4525 * Set out-of-band value...
4528 (*attr
)->value_tag
= value_tag
;
4531 case IPP_TAG_RANGE
:
4532 if (temp_tag
!= IPP_TAG_INTEGER
)
4535 for (i
= (*attr
)->num_values
, value
= (*attr
)->values
;
4539 integer
= value
->integer
;
4540 value
->range
.lower
= value
->range
.upper
= integer
;
4543 (*attr
)->value_tag
= IPP_TAG_RANGE
;
4547 if (temp_tag
!= IPP_TAG_KEYWORD
&& temp_tag
!= IPP_TAG_URI
&&
4548 temp_tag
!= IPP_TAG_URISCHEME
&& temp_tag
!= IPP_TAG_LANGUAGE
&&
4549 temp_tag
!= IPP_TAG_MIMETYPE
)
4552 (*attr
)->value_tag
= (ipp_tag_t
)(IPP_TAG_NAME
| ((*attr
)->value_tag
& IPP_TAG_CUPS_CONST
));
4555 case IPP_TAG_NAMELANG
:
4556 case IPP_TAG_TEXTLANG
:
4557 if (value_tag
== IPP_TAG_NAMELANG
&&
4558 (temp_tag
!= IPP_TAG_NAME
&& temp_tag
!= IPP_TAG_KEYWORD
&&
4559 temp_tag
!= IPP_TAG_URI
&& temp_tag
!= IPP_TAG_URISCHEME
&&
4560 temp_tag
!= IPP_TAG_LANGUAGE
&& temp_tag
!= IPP_TAG_MIMETYPE
))
4563 if (value_tag
== IPP_TAG_TEXTLANG
&& temp_tag
!= IPP_TAG_TEXT
)
4566 if (ipp
->attrs
&& ipp
->attrs
->next
&& ipp
->attrs
->next
->name
&&
4567 !strcmp(ipp
->attrs
->next
->name
, "attributes-natural-language"))
4570 * Use the language code from the IPP message...
4573 (*attr
)->values
[0].string
.language
=
4574 _cupsStrAlloc(ipp
->attrs
->next
->values
[0].string
.text
);
4579 * Otherwise, use the language code corresponding to the locale...
4582 language
= cupsLangDefault();
4583 (*attr
)->values
[0].string
.language
= _cupsStrAlloc(ipp_lang_code(language
->language
,
4588 for (i
= (*attr
)->num_values
- 1, value
= (*attr
)->values
+ 1;
4591 value
->string
.language
= (*attr
)->values
[0].string
.language
;
4593 if ((int)(*attr
)->value_tag
& IPP_TAG_CUPS_CONST
)
4596 * Make copies of all values...
4599 for (i
= (*attr
)->num_values
, value
= (*attr
)->values
;
4602 value
->string
.text
= _cupsStrAlloc(value
->string
.text
);
4605 (*attr
)->value_tag
= IPP_TAG_NAMELANG
;
4608 case IPP_TAG_KEYWORD
:
4609 if (temp_tag
== IPP_TAG_NAME
|| temp_tag
== IPP_TAG_NAMELANG
)
4610 break; /* Silently "allow" name -> keyword */
4621 * 'ippSetVersion()' - Set the version number in an IPP message.
4623 * The @code ipp@ parameter refers to an IPP message previously created using
4624 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
4626 * The valid version numbers are currently 1.0, 1.1, 2.0, 2.1, and 2.2.
4628 * @since CUPS 1.6/macOS 10.8@
4631 int /* O - 1 on success, 0 on failure */
4632 ippSetVersion(ipp_t
*ipp
, /* I - IPP message */
4633 int major
, /* I - Major version number (major.minor) */
4634 int minor
) /* I - Minor version number (major.minor) */
4637 * Range check input...
4640 if (!ipp
|| major
< 0 || minor
< 0)
4644 * Set the version number...
4647 ipp
->request
.any
.version
[0] = (ipp_uchar_t
)major
;
4648 ipp
->request
.any
.version
[1] = (ipp_uchar_t
)minor
;
4655 * 'ippTimeToDate()' - Convert from time in seconds to RFC 2579 format.
4658 const ipp_uchar_t
* /* O - RFC-2579 date/time data */
4659 ippTimeToDate(time_t t
) /* I - Time in seconds */
4661 struct tm
*unixdate
; /* UNIX unixdate/time info */
4662 ipp_uchar_t
*date
= _cupsGlobals()->ipp_date
;
4663 /* RFC-2579 date/time data */
4667 * RFC-2579 date/time format is:
4669 * Byte(s) Description
4670 * ------- -----------
4671 * 0-1 Year (0 to 65535)
4675 * 5 Minutes (0 to 59)
4676 * 6 Seconds (0 to 60, 60 = "leap second")
4677 * 7 Deciseconds (0 to 9)
4679 * 9 UTC hours (0 to 11)
4680 * 10 UTC minutes (0 to 59)
4683 unixdate
= gmtime(&t
);
4684 unixdate
->tm_year
+= 1900;
4686 date
[0] = (ipp_uchar_t
)(unixdate
->tm_year
>> 8);
4687 date
[1] = (ipp_uchar_t
)(unixdate
->tm_year
);
4688 date
[2] = (ipp_uchar_t
)(unixdate
->tm_mon
+ 1);
4689 date
[3] = (ipp_uchar_t
)unixdate
->tm_mday
;
4690 date
[4] = (ipp_uchar_t
)unixdate
->tm_hour
;
4691 date
[5] = (ipp_uchar_t
)unixdate
->tm_min
;
4692 date
[6] = (ipp_uchar_t
)unixdate
->tm_sec
;
4703 * 'ippValidateAttribute()' - Validate the contents of an attribute.
4705 * This function validates the contents of an attribute based on the name and
4706 * value tag. 1 is returned if the attribute is valid, 0 otherwise. On
4707 * failure, @link cupsLastErrorString@ is set to a human-readable message.
4709 * @since CUPS 1.7/macOS 10.9@
4712 int /* O - 1 if valid, 0 otherwise */
4713 ippValidateAttribute(
4714 ipp_attribute_t
*attr
) /* I - Attribute */
4716 int i
; /* Looping var */
4717 char scheme
[64], /* Scheme from URI */
4718 userpass
[256], /* Username/password from URI */
4719 hostname
[256], /* Hostname from URI */
4720 resource
[1024]; /* Resource from URI */
4721 int port
, /* Port number from URI */
4722 uri_status
; /* URI separation status */
4723 const char *ptr
; /* Pointer into string */
4724 ipp_attribute_t
*colattr
; /* Collection attribute */
4725 regex_t re
; /* Regular expression */
4726 ipp_uchar_t
*date
; /* Current date value */
4737 * Validate the attribute name.
4740 for (ptr
= attr
->name
; *ptr
; ptr
++)
4741 if (!isalnum(*ptr
& 255) && *ptr
!= '-' && *ptr
!= '.' && *ptr
!= '_')
4744 if (*ptr
|| ptr
== attr
->name
)
4746 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad attribute name - invalid character (RFC 8011 section 5.1.4)."), attr
->name
);
4750 if ((ptr
- attr
->name
) > 255)
4752 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
));
4756 switch (attr
->value_tag
)
4758 case IPP_TAG_INTEGER
:
4761 case IPP_TAG_BOOLEAN
:
4762 for (i
= 0; i
< attr
->num_values
; i
++)
4764 if (attr
->values
[i
].boolean
!= 0 &&
4765 attr
->values
[i
].boolean
!= 1)
4767 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
);
4774 for (i
= 0; i
< attr
->num_values
; i
++)
4776 if (attr
->values
[i
].integer
< 1)
4778 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
);
4784 case IPP_TAG_STRING
:
4785 for (i
= 0; i
< attr
->num_values
; i
++)
4787 if (attr
->values
[i
].unknown
.length
> IPP_MAX_OCTETSTRING
)
4789 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
);
4796 for (i
= 0; i
< attr
->num_values
; i
++)
4798 date
= attr
->values
[i
].date
;
4800 if (date
[2] < 1 || date
[2] > 12)
4802 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad dateTime month %u (RFC 8011 section 5.1.15)."), attr
->name
, date
[2]);
4806 if (date
[3] < 1 || date
[3] > 31)
4808 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad dateTime day %u (RFC 8011 section 5.1.15)."), attr
->name
, date
[3]);
4814 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad dateTime hours %u (RFC 8011 section 5.1.15)."), attr
->name
, date
[4]);
4820 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad dateTime minutes %u (RFC 8011 section 5.1.15)."), attr
->name
, date
[5]);
4826 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad dateTime seconds %u (RFC 8011 section 5.1.15)."), attr
->name
, date
[6]);
4832 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad dateTime deciseconds %u (RFC 8011 section 5.1.15)."), attr
->name
, date
[7]);
4836 if (date
[8] != '-' && date
[8] != '+')
4838 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad dateTime UTC sign '%c' (RFC 8011 section 5.1.15)."), attr
->name
, date
[8]);
4844 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad dateTime UTC hours %u (RFC 8011 section 5.1.15)."), attr
->name
, date
[9]);
4850 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("\"%s\": Bad dateTime UTC minutes %u (RFC 8011 section 5.1.15)."), attr
->name
, date
[10]);
4856 case IPP_TAG_RESOLUTION
:
4857 for (i
= 0; i
< attr
->num_values
; i
++)
4859 if (attr
->values
[i
].resolution
.xres
<= 0)
4861 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");
4865 if (attr
->values
[i
].resolution
.yres
<= 0)
4867 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");
4871 if (attr
->values
[i
].resolution
.units
!= IPP_RES_PER_INCH
&& attr
->values
[i
].resolution
.units
!= IPP_RES_PER_CM
)
4873 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");
4879 case IPP_TAG_RANGE
:
4880 for (i
= 0; i
< attr
->num_values
; i
++)
4882 if (attr
->values
[i
].range
.lower
> attr
->values
[i
].range
.upper
)
4884 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
);
4890 case IPP_TAG_BEGIN_COLLECTION
:
4891 for (i
= 0; i
< attr
->num_values
; i
++)
4893 for (colattr
= attr
->values
[i
].collection
->attrs
;
4895 colattr
= colattr
->next
)
4897 if (!ippValidateAttribute(colattr
))
4904 case IPP_TAG_TEXTLANG
:
4905 for (i
= 0; i
< attr
->num_values
; i
++)
4907 for (ptr
= attr
->values
[i
].string
.text
; *ptr
; ptr
++)
4909 if ((*ptr
& 0xe0) == 0xc0)
4912 if ((*ptr
& 0xc0) != 0x80)
4915 else if ((*ptr
& 0xf0) == 0xe0)
4918 if ((*ptr
& 0xc0) != 0x80)
4921 if ((*ptr
& 0xc0) != 0x80)
4924 else if ((*ptr
& 0xf8) == 0xf0)
4927 if ((*ptr
& 0xc0) != 0x80)
4930 if ((*ptr
& 0xc0) != 0x80)
4933 if ((*ptr
& 0xc0) != 0x80)
4936 else if (*ptr
& 0x80)
4938 else if ((*ptr
< ' ' && *ptr
!= '\n' && *ptr
!= '\r' && *ptr
!= '\t') || *ptr
== 0x7f)
4944 if (*ptr
< ' ' || *ptr
== 0x7f)
4946 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
);
4951 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
);
4956 if ((ptr
- attr
->values
[i
].string
.text
) > (IPP_MAX_TEXT
- 1))
4958 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
));
4965 case IPP_TAG_NAMELANG
:
4966 for (i
= 0; i
< attr
->num_values
; i
++)
4968 for (ptr
= attr
->values
[i
].string
.text
; *ptr
; ptr
++)
4970 if ((*ptr
& 0xe0) == 0xc0)
4973 if ((*ptr
& 0xc0) != 0x80)
4976 else if ((*ptr
& 0xf0) == 0xe0)
4979 if ((*ptr
& 0xc0) != 0x80)
4982 if ((*ptr
& 0xc0) != 0x80)
4985 else if ((*ptr
& 0xf8) == 0xf0)
4988 if ((*ptr
& 0xc0) != 0x80)
4991 if ((*ptr
& 0xc0) != 0x80)
4994 if ((*ptr
& 0xc0) != 0x80)
4997 else if (*ptr
& 0x80)
4999 else if (*ptr
< ' ' || *ptr
== 0x7f)
5005 if (*ptr
< ' ' || *ptr
== 0x7f)
5007 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
);
5012 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
);
5017 if ((ptr
- attr
->values
[i
].string
.text
) > (IPP_MAX_NAME
- 1))
5019 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
));
5025 case IPP_TAG_KEYWORD
:
5026 for (i
= 0; i
< attr
->num_values
; i
++)
5028 for (ptr
= attr
->values
[i
].string
.text
; *ptr
; ptr
++)
5030 if (!isalnum(*ptr
& 255) && *ptr
!= '-' && *ptr
!= '.' &&
5035 if (*ptr
|| ptr
== attr
->values
[i
].string
.text
)
5037 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
);
5041 if ((ptr
- attr
->values
[i
].string
.text
) > (IPP_MAX_KEYWORD
- 1))
5043 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
));
5050 for (i
= 0; i
< attr
->num_values
; i
++)
5052 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
));
5054 if (uri_status
< HTTP_URI_STATUS_OK
)
5056 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
));
5060 if (strlen(attr
->values
[i
].string
.text
) > (IPP_MAX_URI
- 1))
5062 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
));
5067 case IPP_TAG_URISCHEME
:
5068 for (i
= 0; i
< attr
->num_values
; i
++)
5070 ptr
= attr
->values
[i
].string
.text
;
5071 if (islower(*ptr
& 255))
5073 for (ptr
++; *ptr
; ptr
++)
5075 if (!islower(*ptr
& 255) && !isdigit(*ptr
& 255) &&
5076 *ptr
!= '+' && *ptr
!= '-' && *ptr
!= '.')
5081 if (*ptr
|| ptr
== attr
->values
[i
].string
.text
)
5083 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
);
5087 if ((ptr
- attr
->values
[i
].string
.text
) > (IPP_MAX_URISCHEME
- 1))
5089 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
));
5095 case IPP_TAG_CHARSET
:
5096 for (i
= 0; i
< attr
->num_values
; i
++)
5098 for (ptr
= attr
->values
[i
].string
.text
; *ptr
; ptr
++)
5100 if (!isprint(*ptr
& 255) || isupper(*ptr
& 255) ||
5101 isspace(*ptr
& 255))
5105 if (*ptr
|| ptr
== attr
->values
[i
].string
.text
)
5107 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
);
5111 if ((ptr
- attr
->values
[i
].string
.text
) > (IPP_MAX_CHARSET
- 1))
5113 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
));
5119 case IPP_TAG_LANGUAGE
:
5121 * The following regular expression is derived from the ABNF for
5122 * language tags in RFC 4646. All I can say is that this is the
5123 * easiest way to check the values...
5126 if ((i
= regcomp(&re
,
5128 "(([a-z]{2,3}(-[a-z][a-z][a-z]){0,3})|[a-z]{4,8})"
5130 "(-[a-z][a-z][a-z][a-z]){0,1}" /* script */
5131 "(-([a-z][a-z]|[0-9][0-9][0-9])){0,1}" /* region */
5132 "(-([a-z]{5,8}|[0-9][0-9][0-9]))*" /* variant */
5133 "(-[a-wy-z](-[a-z0-9]{2,8})+)*" /* extension */
5134 "(-x(-[a-z0-9]{1,8})+)*" /* privateuse */
5136 "x(-[a-z0-9]{1,8})+" /* privateuse */
5138 "[a-z]{1,3}(-[a-z][0-9]{2,8}){1,2}" /* grandfathered */
5140 REG_NOSUB
| REG_EXTENDED
)) != 0)
5142 char temp
[256]; /* Temporary error string */
5144 regerror(i
, &re
, temp
, sizeof(temp
));
5145 ipp_set_error(IPP_STATUS_ERROR_INTERNAL
, _("Unable to compile naturalLanguage regular expression: %s."), temp
);
5149 for (i
= 0; i
< attr
->num_values
; i
++)
5151 if (regexec(&re
, attr
->values
[i
].string
.text
, 0, NULL
, 0))
5153 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
);
5158 if (strlen(attr
->values
[i
].string
.text
) > (IPP_MAX_LANGUAGE
- 1))
5160 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
));
5169 case IPP_TAG_MIMETYPE
:
5171 * The following regular expression is derived from the ABNF for
5172 * MIME media types in RFC 2045 and 4288. All I can say is that this is
5173 * the easiest way to check the values...
5176 if ((i
= regcomp(&re
,
5178 "[-a-zA-Z0-9!#$&.+^_]{1,127}" /* type-name */
5180 "[-a-zA-Z0-9!#$&.+^_]{1,127}" /* subtype-name */
5181 "(;[-a-zA-Z0-9!#$&.+^_]{1,127}=" /* parameter= */
5182 "([-a-zA-Z0-9!#$&.+^_]{1,127}|\"[^\"]*\"))*"
5185 REG_NOSUB
| REG_EXTENDED
)) != 0)
5187 char temp
[256]; /* Temporary error string */
5189 regerror(i
, &re
, temp
, sizeof(temp
));
5190 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST
, _("Unable to compile mimeMediaType regular expression: %s."), temp
);
5194 for (i
= 0; i
< attr
->num_values
; i
++)
5196 if (regexec(&re
, attr
->values
[i
].string
.text
, 0, NULL
, 0))
5198 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
);
5203 if (strlen(attr
->values
[i
].string
.text
) > (IPP_MAX_MIMETYPE
- 1))
5205 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
));
5223 * 'ippValidateAttributes()' - Validate all attributes in an IPP message.
5225 * This function validates the contents of the IPP message, including each
5226 * attribute. Like @link ippValidateAttribute@, @link cupsLastErrorString@ is
5227 * set to a human-readable message on failure.
5229 * @since CUPS 1.7/macOS 10.9@
5232 int /* O - 1 if valid, 0 otherwise */
5233 ippValidateAttributes(ipp_t
*ipp
) /* I - IPP message */
5235 ipp_attribute_t
*attr
; /* Current attribute */
5241 for (attr
= ipp
->attrs
; attr
; attr
= attr
->next
)
5242 if (!ippValidateAttribute(attr
))
5250 * 'ippWrite()' - Write data for an IPP message to a HTTP connection.
5253 ipp_state_t
/* O - Current state */
5254 ippWrite(http_t
*http
, /* I - HTTP connection */
5255 ipp_t
*ipp
) /* I - IPP data */
5257 DEBUG_printf(("ippWrite(http=%p, ipp=%p)", (void *)http
, (void *)ipp
));
5260 return (IPP_STATE_ERROR
);
5262 return (ippWriteIO(http
, (ipp_iocb_t
)httpWrite2
, http
->blocking
, NULL
, ipp
));
5267 * 'ippWriteFile()' - Write data for an IPP message to a file.
5269 * @since CUPS 1.1.19/macOS 10.3@
5272 ipp_state_t
/* O - Current state */
5273 ippWriteFile(int fd
, /* I - HTTP data */
5274 ipp_t
*ipp
) /* I - IPP data */
5276 DEBUG_printf(("ippWriteFile(fd=%d, ipp=%p)", fd
, (void *)ipp
));
5278 ipp
->state
= IPP_STATE_IDLE
;
5280 return (ippWriteIO(&fd
, (ipp_iocb_t
)ipp_write_file
, 1, NULL
, ipp
));
5285 * 'ippWriteIO()' - Write data for an IPP message.
5287 * @since CUPS 1.2/macOS 10.5@
5290 ipp_state_t
/* O - Current state */
5291 ippWriteIO(void *dst
, /* I - Destination */
5292 ipp_iocb_t cb
, /* I - Write callback function */
5293 int blocking
, /* I - Use blocking IO? */
5294 ipp_t
*parent
, /* I - Parent IPP message */
5295 ipp_t
*ipp
) /* I - IPP data */
5297 int i
; /* Looping var */
5298 int n
; /* Length of data */
5299 unsigned char *buffer
, /* Data buffer */
5300 *bufptr
; /* Pointer into buffer */
5301 ipp_attribute_t
*attr
; /* Current attribute */
5302 _ipp_value_t
*value
; /* Current value */
5305 DEBUG_printf(("ippWriteIO(dst=%p, cb=%p, blocking=%d, parent=%p, ipp=%p)", (void *)dst
, (void *)cb
, blocking
, (void *)parent
, (void *)ipp
));
5308 return (IPP_STATE_ERROR
);
5310 if ((buffer
= (unsigned char *)_cupsBufferGet(IPP_BUF_SIZE
)) == NULL
)
5312 DEBUG_puts("1ippWriteIO: Unable to get write buffer");
5313 return (IPP_STATE_ERROR
);
5318 case IPP_STATE_IDLE
:
5319 ipp
->state
++; /* Avoid common problem... */
5321 case IPP_STATE_HEADER
:
5325 * Send the request header:
5328 * Operation/Status Code = 2 bytes
5329 * Request ID = 4 bytes
5335 *bufptr
++ = ipp
->request
.any
.version
[0];
5336 *bufptr
++ = ipp
->request
.any
.version
[1];
5337 *bufptr
++ = (ipp_uchar_t
)(ipp
->request
.any
.op_status
>> 8);
5338 *bufptr
++ = (ipp_uchar_t
)ipp
->request
.any
.op_status
;
5339 *bufptr
++ = (ipp_uchar_t
)(ipp
->request
.any
.request_id
>> 24);
5340 *bufptr
++ = (ipp_uchar_t
)(ipp
->request
.any
.request_id
>> 16);
5341 *bufptr
++ = (ipp_uchar_t
)(ipp
->request
.any
.request_id
>> 8);
5342 *bufptr
++ = (ipp_uchar_t
)ipp
->request
.any
.request_id
;
5344 DEBUG_printf(("2ippWriteIO: version=%d.%d", buffer
[0], buffer
[1]));
5345 DEBUG_printf(("2ippWriteIO: op_status=%04x",
5346 ipp
->request
.any
.op_status
));
5347 DEBUG_printf(("2ippWriteIO: request_id=%d",
5348 ipp
->request
.any
.request_id
));
5350 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
5352 DEBUG_puts("1ippWriteIO: Could not write IPP header...");
5353 _cupsBufferRelease((char *)buffer
);
5354 return (IPP_STATE_ERROR
);
5359 * Reset the state engine to point to the first attribute
5360 * in the request/response, with no current group.
5363 ipp
->state
= IPP_STATE_ATTRIBUTE
;
5364 ipp
->current
= ipp
->attrs
;
5365 ipp
->curtag
= IPP_TAG_ZERO
;
5367 DEBUG_printf(("1ippWriteIO: ipp->current=%p", (void *)ipp
->current
));
5370 * If blocking is disabled, stop here...
5376 case IPP_STATE_ATTRIBUTE
:
5377 while (ipp
->current
!= NULL
)
5380 * Write this attribute...
5384 attr
= ipp
->current
;
5386 ipp
->current
= ipp
->current
->next
;
5390 if (ipp
->curtag
!= attr
->group_tag
)
5393 * Send a group tag byte...
5396 ipp
->curtag
= attr
->group_tag
;
5398 if (attr
->group_tag
== IPP_TAG_ZERO
)
5401 DEBUG_printf(("2ippWriteIO: wrote group tag=%x(%s)",
5402 attr
->group_tag
, ippTagString(attr
->group_tag
)));
5403 *bufptr
++ = (ipp_uchar_t
)attr
->group_tag
;
5405 else if (attr
->group_tag
== IPP_TAG_ZERO
)
5409 DEBUG_printf(("1ippWriteIO: %s (%s%s)", attr
->name
,
5410 attr
->num_values
> 1 ? "1setOf " : "",
5411 ippTagString(attr
->value_tag
)));
5414 * Write the attribute tag and name.
5416 * The attribute name length does not include the trailing nul
5417 * character in the source string.
5419 * Collection values (parent != NULL) are written differently...
5425 * Get the length of the attribute name, and make sure it won't
5426 * overflow the buffer...
5429 if ((n
= (int)strlen(attr
->name
)) > (IPP_BUF_SIZE
- 8))
5431 DEBUG_printf(("1ippWriteIO: Attribute name too long (%d)", n
));
5432 _cupsBufferRelease((char *)buffer
);
5433 return (IPP_STATE_ERROR
);
5437 * Write the value tag, name length, and name string...
5440 DEBUG_printf(("2ippWriteIO: writing value tag=%x(%s)",
5441 attr
->value_tag
, ippTagString(attr
->value_tag
)));
5442 DEBUG_printf(("2ippWriteIO: writing name=%d,\"%s\"", n
,
5445 if (attr
->value_tag
> 0xff)
5447 *bufptr
++ = IPP_TAG_EXTENSION
;
5448 *bufptr
++ = (ipp_uchar_t
)(attr
->value_tag
>> 24);
5449 *bufptr
++ = (ipp_uchar_t
)(attr
->value_tag
>> 16);
5450 *bufptr
++ = (ipp_uchar_t
)(attr
->value_tag
>> 8);
5451 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
5454 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
5456 *bufptr
++ = (ipp_uchar_t
)(n
>> 8);
5457 *bufptr
++ = (ipp_uchar_t
)n
;
5458 memcpy(bufptr
, attr
->name
, (size_t)n
);
5464 * Get the length of the attribute name, and make sure it won't
5465 * overflow the buffer...
5468 if ((n
= (int)strlen(attr
->name
)) > (IPP_BUF_SIZE
- 12))
5470 DEBUG_printf(("1ippWriteIO: Attribute name too long (%d)", n
));
5471 _cupsBufferRelease((char *)buffer
);
5472 return (IPP_STATE_ERROR
);
5476 * Write the member name tag, name length, name string, value tag,
5477 * and empty name for the collection member attribute...
5480 DEBUG_printf(("2ippWriteIO: writing value tag=%x(memberName)",
5481 IPP_TAG_MEMBERNAME
));
5482 DEBUG_printf(("2ippWriteIO: writing name=%d,\"%s\"", n
,
5484 DEBUG_printf(("2ippWriteIO: writing value tag=%x(%s)",
5485 attr
->value_tag
, ippTagString(attr
->value_tag
)));
5486 DEBUG_puts("2ippWriteIO: writing name=0,\"\"");
5488 *bufptr
++ = IPP_TAG_MEMBERNAME
;
5491 *bufptr
++ = (ipp_uchar_t
)(n
>> 8);
5492 *bufptr
++ = (ipp_uchar_t
)n
;
5493 memcpy(bufptr
, attr
->name
, (size_t)n
);
5496 if (attr
->value_tag
> 0xff)
5498 *bufptr
++ = IPP_TAG_EXTENSION
;
5499 *bufptr
++ = (ipp_uchar_t
)(attr
->value_tag
>> 24);
5500 *bufptr
++ = (ipp_uchar_t
)(attr
->value_tag
>> 16);
5501 *bufptr
++ = (ipp_uchar_t
)(attr
->value_tag
>> 8);
5502 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
5505 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
5512 * Now write the attribute value(s)...
5515 switch (attr
->value_tag
& ~IPP_TAG_CUPS_CONST
)
5517 case IPP_TAG_UNSUPPORTED_VALUE
:
5518 case IPP_TAG_DEFAULT
:
5519 case IPP_TAG_UNKNOWN
:
5520 case IPP_TAG_NOVALUE
:
5521 case IPP_TAG_NOTSETTABLE
:
5522 case IPP_TAG_DELETEATTR
:
5523 case IPP_TAG_ADMINDEFINE
:
5528 case IPP_TAG_INTEGER
:
5530 for (i
= 0, value
= attr
->values
;
5531 i
< attr
->num_values
;
5534 if ((IPP_BUF_SIZE
- (bufptr
- buffer
)) < 9)
5536 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
5538 DEBUG_puts("1ippWriteIO: Could not write IPP "
5540 _cupsBufferRelease((char *)buffer
);
5541 return (IPP_STATE_ERROR
);
5550 * Arrays and sets are done by sending additional
5551 * values with a zero-length name...
5554 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
5560 * Integers and enumerations are both 4-byte signed
5561 * (twos-complement) values.
5563 * Put the 2-byte length and 4-byte value into the buffer...
5568 *bufptr
++ = (ipp_uchar_t
)(value
->integer
>> 24);
5569 *bufptr
++ = (ipp_uchar_t
)(value
->integer
>> 16);
5570 *bufptr
++ = (ipp_uchar_t
)(value
->integer
>> 8);
5571 *bufptr
++ = (ipp_uchar_t
)value
->integer
;
5575 case IPP_TAG_BOOLEAN
:
5576 for (i
= 0, value
= attr
->values
;
5577 i
< attr
->num_values
;
5580 if ((IPP_BUF_SIZE
- (bufptr
- buffer
)) < 6)
5582 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
5584 DEBUG_puts("1ippWriteIO: Could not write IPP "
5586 _cupsBufferRelease((char *)buffer
);
5587 return (IPP_STATE_ERROR
);
5596 * Arrays and sets are done by sending additional
5597 * values with a zero-length name...
5600 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
5606 * Boolean values are 1-byte; 0 = false, 1 = true.
5608 * Put the 2-byte length and 1-byte value into the buffer...
5613 *bufptr
++ = (ipp_uchar_t
)value
->boolean
;
5619 case IPP_TAG_KEYWORD
:
5621 case IPP_TAG_URISCHEME
:
5622 case IPP_TAG_CHARSET
:
5623 case IPP_TAG_LANGUAGE
:
5624 case IPP_TAG_MIMETYPE
:
5625 for (i
= 0, value
= attr
->values
;
5626 i
< attr
->num_values
;
5632 * Arrays and sets are done by sending additional
5633 * values with a zero-length name...
5636 DEBUG_printf(("2ippWriteIO: writing value tag=%x(%s)",
5638 ippTagString(attr
->value_tag
)));
5639 DEBUG_printf(("2ippWriteIO: writing name=0,\"\""));
5641 if ((IPP_BUF_SIZE
- (bufptr
- buffer
)) < 3)
5643 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
5645 DEBUG_puts("1ippWriteIO: Could not write IPP "
5647 _cupsBufferRelease((char *)buffer
);
5648 return (IPP_STATE_ERROR
);
5654 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
5659 if (value
->string
.text
!= NULL
)
5660 n
= (int)strlen(value
->string
.text
);
5664 if (n
> (IPP_BUF_SIZE
- 2))
5666 DEBUG_printf(("1ippWriteIO: String too long (%d)", n
));
5667 _cupsBufferRelease((char *)buffer
);
5668 return (IPP_STATE_ERROR
);
5671 DEBUG_printf(("2ippWriteIO: writing string=%d,\"%s\"", n
,
5672 value
->string
.text
));
5674 if ((int)(IPP_BUF_SIZE
- (bufptr
- buffer
)) < (n
+ 2))
5676 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
5678 DEBUG_puts("1ippWriteIO: Could not write IPP "
5680 _cupsBufferRelease((char *)buffer
);
5681 return (IPP_STATE_ERROR
);
5688 * All simple strings consist of the 2-byte length and
5689 * character data without the trailing nul normally found
5690 * in C strings. Also, strings cannot be longer than IPP_MAX_LENGTH
5691 * bytes since the 2-byte length is a signed (twos-complement)
5694 * Put the 2-byte length and string characters in the buffer.
5697 *bufptr
++ = (ipp_uchar_t
)(n
>> 8);
5698 *bufptr
++ = (ipp_uchar_t
)n
;
5702 memcpy(bufptr
, value
->string
.text
, (size_t)n
);
5709 for (i
= 0, value
= attr
->values
;
5710 i
< attr
->num_values
;
5713 if ((IPP_BUF_SIZE
- (bufptr
- buffer
)) < 16)
5715 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
5717 DEBUG_puts("1ippWriteIO: Could not write IPP "
5719 _cupsBufferRelease((char *)buffer
);
5720 return (IPP_STATE_ERROR
);
5729 * Arrays and sets are done by sending additional
5730 * values with a zero-length name...
5733 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
5739 * Date values consist of a 2-byte length and an
5740 * 11-byte date/time structure defined by RFC 1903.
5742 * Put the 2-byte length and 11-byte date/time
5743 * structure in the buffer.
5748 memcpy(bufptr
, value
->date
, 11);
5753 case IPP_TAG_RESOLUTION
:
5754 for (i
= 0, value
= attr
->values
;
5755 i
< attr
->num_values
;
5758 if ((IPP_BUF_SIZE
- (bufptr
- buffer
)) < 14)
5760 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
5762 DEBUG_puts("1ippWriteIO: Could not write IPP "
5764 _cupsBufferRelease((char *)buffer
);
5765 return (IPP_STATE_ERROR
);
5774 * Arrays and sets are done by sending additional
5775 * values with a zero-length name...
5778 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
5784 * Resolution values consist of a 2-byte length,
5785 * 4-byte horizontal resolution value, 4-byte vertical
5786 * resolution value, and a 1-byte units value.
5788 * Put the 2-byte length and resolution value data
5794 *bufptr
++ = (ipp_uchar_t
)(value
->resolution
.xres
>> 24);
5795 *bufptr
++ = (ipp_uchar_t
)(value
->resolution
.xres
>> 16);
5796 *bufptr
++ = (ipp_uchar_t
)(value
->resolution
.xres
>> 8);
5797 *bufptr
++ = (ipp_uchar_t
)value
->resolution
.xres
;
5798 *bufptr
++ = (ipp_uchar_t
)(value
->resolution
.yres
>> 24);
5799 *bufptr
++ = (ipp_uchar_t
)(value
->resolution
.yres
>> 16);
5800 *bufptr
++ = (ipp_uchar_t
)(value
->resolution
.yres
>> 8);
5801 *bufptr
++ = (ipp_uchar_t
)value
->resolution
.yres
;
5802 *bufptr
++ = (ipp_uchar_t
)value
->resolution
.units
;
5806 case IPP_TAG_RANGE
:
5807 for (i
= 0, value
= attr
->values
;
5808 i
< attr
->num_values
;
5811 if ((IPP_BUF_SIZE
- (bufptr
- buffer
)) < 13)
5813 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
5815 DEBUG_puts("1ippWriteIO: Could not write IPP "
5817 _cupsBufferRelease((char *)buffer
);
5818 return (IPP_STATE_ERROR
);
5827 * Arrays and sets are done by sending additional
5828 * values with a zero-length name...
5831 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
5837 * Range values consist of a 2-byte length,
5838 * 4-byte lower value, and 4-byte upper value.
5840 * Put the 2-byte length and range value data
5846 *bufptr
++ = (ipp_uchar_t
)(value
->range
.lower
>> 24);
5847 *bufptr
++ = (ipp_uchar_t
)(value
->range
.lower
>> 16);
5848 *bufptr
++ = (ipp_uchar_t
)(value
->range
.lower
>> 8);
5849 *bufptr
++ = (ipp_uchar_t
)value
->range
.lower
;
5850 *bufptr
++ = (ipp_uchar_t
)(value
->range
.upper
>> 24);
5851 *bufptr
++ = (ipp_uchar_t
)(value
->range
.upper
>> 16);
5852 *bufptr
++ = (ipp_uchar_t
)(value
->range
.upper
>> 8);
5853 *bufptr
++ = (ipp_uchar_t
)value
->range
.upper
;
5857 case IPP_TAG_TEXTLANG
:
5858 case IPP_TAG_NAMELANG
:
5859 for (i
= 0, value
= attr
->values
;
5860 i
< attr
->num_values
;
5866 * Arrays and sets are done by sending additional
5867 * values with a zero-length name...
5870 if ((IPP_BUF_SIZE
- (bufptr
- buffer
)) < 3)
5872 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
5874 DEBUG_puts("1ippWriteIO: Could not write IPP "
5876 _cupsBufferRelease((char *)buffer
);
5877 return (IPP_STATE_ERROR
);
5883 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
5889 * textWithLanguage and nameWithLanguage values consist
5890 * of a 2-byte length for both strings and their
5891 * individual lengths, a 2-byte length for the
5892 * character string, the character string without the
5893 * trailing nul, a 2-byte length for the character
5894 * set string, and the character set string without
5900 if (value
->string
.language
!= NULL
)
5901 n
+= (int)strlen(value
->string
.language
);
5903 if (value
->string
.text
!= NULL
)
5904 n
+= (int)strlen(value
->string
.text
);
5906 if (n
> (IPP_BUF_SIZE
- 2))
5908 DEBUG_printf(("1ippWriteIO: text/nameWithLanguage value "
5909 "too long (%d)", n
));
5910 _cupsBufferRelease((char *)buffer
);
5911 return (IPP_STATE_ERROR
);
5914 if ((int)(IPP_BUF_SIZE
- (bufptr
- buffer
)) < (n
+ 2))
5916 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
5918 DEBUG_puts("1ippWriteIO: Could not write IPP "
5920 _cupsBufferRelease((char *)buffer
);
5921 return (IPP_STATE_ERROR
);
5927 /* Length of entire value */
5928 *bufptr
++ = (ipp_uchar_t
)(n
>> 8);
5929 *bufptr
++ = (ipp_uchar_t
)n
;
5931 /* Length of language */
5932 if (value
->string
.language
!= NULL
)
5933 n
= (int)strlen(value
->string
.language
);
5937 *bufptr
++ = (ipp_uchar_t
)(n
>> 8);
5938 *bufptr
++ = (ipp_uchar_t
)n
;
5943 memcpy(bufptr
, value
->string
.language
, (size_t)n
);
5947 /* Length of text */
5948 if (value
->string
.text
!= NULL
)
5949 n
= (int)strlen(value
->string
.text
);
5953 *bufptr
++ = (ipp_uchar_t
)(n
>> 8);
5954 *bufptr
++ = (ipp_uchar_t
)n
;
5959 memcpy(bufptr
, value
->string
.text
, (size_t)n
);
5965 case IPP_TAG_BEGIN_COLLECTION
:
5966 for (i
= 0, value
= attr
->values
;
5967 i
< attr
->num_values
;
5971 * Collections are written with the begin-collection
5972 * tag first with a value of 0 length, followed by the
5973 * attributes in the collection, then the end-collection
5977 if ((IPP_BUF_SIZE
- (bufptr
- buffer
)) < 5)
5979 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
5981 DEBUG_puts("1ippWriteIO: Could not write IPP "
5983 _cupsBufferRelease((char *)buffer
);
5984 return (IPP_STATE_ERROR
);
5993 * Arrays and sets are done by sending additional
5994 * values with a zero-length name...
5997 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
6003 * Write a data length of 0 and flush the buffer...
6009 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
6011 DEBUG_puts("1ippWriteIO: Could not write IPP "
6013 _cupsBufferRelease((char *)buffer
);
6014 return (IPP_STATE_ERROR
);
6020 * Then write the collection attribute...
6023 value
->collection
->state
= IPP_STATE_IDLE
;
6025 if (ippWriteIO(dst
, cb
, 1, ipp
,
6026 value
->collection
) == IPP_STATE_ERROR
)
6028 DEBUG_puts("1ippWriteIO: Unable to write collection value");
6029 _cupsBufferRelease((char *)buffer
);
6030 return (IPP_STATE_ERROR
);
6036 for (i
= 0, value
= attr
->values
;
6037 i
< attr
->num_values
;
6043 * Arrays and sets are done by sending additional
6044 * values with a zero-length name...
6047 if ((IPP_BUF_SIZE
- (bufptr
- buffer
)) < 3)
6049 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
6051 DEBUG_puts("1ippWriteIO: Could not write IPP "
6053 _cupsBufferRelease((char *)buffer
);
6054 return (IPP_STATE_ERROR
);
6060 *bufptr
++ = (ipp_uchar_t
)attr
->value_tag
;
6066 * An unknown value might some new value that a
6067 * vendor has come up with. It consists of a
6068 * 2-byte length and the bytes in the unknown
6072 n
= value
->unknown
.length
;
6074 if (n
> (IPP_BUF_SIZE
- 2))
6076 DEBUG_printf(("1ippWriteIO: Data length too long (%d)",
6078 _cupsBufferRelease((char *)buffer
);
6079 return (IPP_STATE_ERROR
);
6082 if ((int)(IPP_BUF_SIZE
- (bufptr
- buffer
)) < (n
+ 2))
6084 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
6086 DEBUG_puts("1ippWriteIO: Could not write IPP "
6088 _cupsBufferRelease((char *)buffer
);
6089 return (IPP_STATE_ERROR
);
6095 /* Length of unknown value */
6096 *bufptr
++ = (ipp_uchar_t
)(n
>> 8);
6097 *bufptr
++ = (ipp_uchar_t
)n
;
6102 memcpy(bufptr
, value
->unknown
.data
, (size_t)n
);
6110 * Write the data out...
6113 if (bufptr
> buffer
)
6115 if ((*cb
)(dst
, buffer
, (size_t)(bufptr
- buffer
)) < 0)
6117 DEBUG_puts("1ippWriteIO: Could not write IPP attribute...");
6118 _cupsBufferRelease((char *)buffer
);
6119 return (IPP_STATE_ERROR
);
6122 DEBUG_printf(("2ippWriteIO: wrote %d bytes",
6123 (int)(bufptr
- buffer
)));
6127 * If blocking is disabled and we aren't at the end of the attribute
6128 * list, stop here...
6131 if (!blocking
&& ipp
->current
)
6135 if (ipp
->current
== NULL
)
6138 * Done with all of the attributes; add the end-of-attributes
6139 * tag or end-collection attribute...
6144 buffer
[0] = IPP_TAG_END
;
6149 buffer
[0] = IPP_TAG_END_COLLECTION
;
6150 buffer
[1] = 0; /* empty name */
6152 buffer
[3] = 0; /* empty value */
6157 if ((*cb
)(dst
, buffer
, (size_t)n
) < 0)
6159 DEBUG_puts("1ippWriteIO: Could not write IPP end-tag...");
6160 _cupsBufferRelease((char *)buffer
);
6161 return (IPP_STATE_ERROR
);
6164 ipp
->state
= IPP_STATE_DATA
;
6168 case IPP_STATE_DATA
:
6172 break; /* anti-compiler-warning-code */
6175 _cupsBufferRelease((char *)buffer
);
6177 return (ipp
->state
);
6182 * 'ipp_add_attr()' - Add a new attribute to the message.
6185 static ipp_attribute_t
* /* O - New attribute */
6186 ipp_add_attr(ipp_t
*ipp
, /* I - IPP message */
6187 const char *name
, /* I - Attribute name or NULL */
6188 ipp_tag_t group_tag
, /* I - Group tag or IPP_TAG_ZERO */
6189 ipp_tag_t value_tag
, /* I - Value tag or IPP_TAG_ZERO */
6190 int num_values
) /* I - Number of values */
6192 int alloc_values
; /* Number of values to allocate */
6193 ipp_attribute_t
*attr
; /* New attribute */
6196 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
));
6199 * Range check input...
6202 if (!ipp
|| num_values
< 0)
6206 * Allocate memory, rounding the allocation up as needed...
6209 if (num_values
<= 1)
6212 alloc_values
= (num_values
+ IPP_MAX_VALUES
- 1) & ~(IPP_MAX_VALUES
- 1);
6214 attr
= calloc(sizeof(ipp_attribute_t
) +
6215 (size_t)(alloc_values
- 1) * sizeof(_ipp_value_t
), 1);
6220 * Initialize attribute...
6223 DEBUG_printf(("4debug_alloc: %p %s %s%s (%d values)", (void *)attr
, name
, num_values
> 1 ? "1setOf " : "", ippTagString(value_tag
), num_values
));
6226 attr
->name
= _cupsStrAlloc(name
);
6228 attr
->group_tag
= group_tag
;
6229 attr
->value_tag
= value_tag
;
6230 attr
->num_values
= num_values
;
6233 * Add it to the end of the linked list...
6237 ipp
->last
->next
= attr
;
6241 ipp
->prev
= ipp
->last
;
6242 ipp
->last
= ipp
->current
= attr
;
6245 DEBUG_printf(("5ipp_add_attr: Returning %p", (void *)attr
));
6252 * 'ipp_free_values()' - Free attribute values.
6256 ipp_free_values(ipp_attribute_t
*attr
, /* I - Attribute to free values from */
6257 int element
,/* I - First value to free */
6258 int count
) /* I - Number of values to free */
6260 int i
; /* Looping var */
6261 _ipp_value_t
*value
; /* Current value */
6264 DEBUG_printf(("4ipp_free_values(attr=%p, element=%d, count=%d)", (void *)attr
, element
, count
));
6266 if (!(attr
->value_tag
& IPP_TAG_CUPS_CONST
))
6269 * Free values as needed...
6272 switch (attr
->value_tag
)
6274 case IPP_TAG_TEXTLANG
:
6275 case IPP_TAG_NAMELANG
:
6276 if (element
== 0 && count
== attr
->num_values
&&
6277 attr
->values
[0].string
.language
)
6279 _cupsStrFree(attr
->values
[0].string
.language
);
6280 attr
->values
[0].string
.language
= NULL
;
6282 /* Fall through to other string values */
6286 case IPP_TAG_RESERVED_STRING
:
6287 case IPP_TAG_KEYWORD
:
6289 case IPP_TAG_URISCHEME
:
6290 case IPP_TAG_CHARSET
:
6291 case IPP_TAG_LANGUAGE
:
6292 case IPP_TAG_MIMETYPE
:
6293 for (i
= count
, value
= attr
->values
+ element
;
6297 _cupsStrFree(value
->string
.text
);
6298 value
->string
.text
= NULL
;
6302 case IPP_TAG_UNSUPPORTED_VALUE
:
6303 case IPP_TAG_DEFAULT
:
6304 case IPP_TAG_UNKNOWN
:
6305 case IPP_TAG_NOVALUE
:
6306 case IPP_TAG_NOTSETTABLE
:
6307 case IPP_TAG_DELETEATTR
:
6308 case IPP_TAG_ADMINDEFINE
:
6309 case IPP_TAG_INTEGER
:
6311 case IPP_TAG_BOOLEAN
:
6313 case IPP_TAG_RESOLUTION
:
6314 case IPP_TAG_RANGE
:
6317 case IPP_TAG_BEGIN_COLLECTION
:
6318 for (i
= count
, value
= attr
->values
+ element
;
6322 ippDelete(value
->collection
);
6323 value
->collection
= NULL
;
6327 case IPP_TAG_STRING
:
6329 for (i
= count
, value
= attr
->values
+ element
;
6333 if (value
->unknown
.data
)
6335 free(value
->unknown
.data
);
6336 value
->unknown
.data
= NULL
;
6344 * If we are not freeing values from the end, move the remaining values up...
6347 if ((element
+ count
) < attr
->num_values
)
6348 memmove(attr
->values
+ element
, attr
->values
+ element
+ count
,
6349 (size_t)(attr
->num_values
- count
- element
) * sizeof(_ipp_value_t
));
6351 attr
->num_values
-= count
;
6356 * 'ipp_get_code()' - Convert a C locale/charset name into an IPP language/charset code.
6358 * This typically converts strings of the form "ll_CC", "ll-REGION", and "CHARSET_NUMBER"
6359 * to "ll-cc", "ll-region", and "charset-number", respectively.
6362 static char * /* O - Language code string */
6363 ipp_get_code(const char *value
, /* I - Locale/charset string */
6364 char *buffer
, /* I - String buffer */
6365 size_t bufsize
) /* I - Size of string buffer */
6367 char *bufptr
, /* Pointer into buffer */
6368 *bufend
; /* End of buffer */
6372 * Convert values to lowercase and change _ to - as needed...
6375 for (bufptr
= buffer
, bufend
= buffer
+ bufsize
- 1;
6376 *value
&& bufptr
< bufend
;
6381 *bufptr
++ = (char)_cups_tolower(*value
);
6386 * Return the converted string...
6394 * 'ipp_lang_code()' - Convert a C locale name into an IPP language code.
6396 * This typically converts strings of the form "ll_CC" and "ll-REGION" to "ll-cc" and
6397 * "ll-region", respectively. It also converts the "C" (POSIX) locale to "en".
6400 static char * /* O - Language code string */
6401 ipp_lang_code(const char *locale
, /* I - Locale string */
6402 char *buffer
, /* I - String buffer */
6403 size_t bufsize
) /* I - Size of string buffer */
6406 * Map POSIX ("C") locale to generic English, otherwise convert the locale string as-is.
6409 if (!_cups_strcasecmp(locale
, "c"))
6411 strlcpy(buffer
, "en", bufsize
);
6415 return (ipp_get_code(locale
, buffer
, bufsize
));
6420 * 'ipp_length()' - Compute the length of an IPP message or collection value.
6423 static size_t /* O - Size of IPP message */
6424 ipp_length(ipp_t
*ipp
, /* I - IPP message or collection */
6425 int collection
) /* I - 1 if a collection, 0 otherwise */
6427 int i
; /* Looping var */
6428 size_t bytes
; /* Number of bytes */
6429 ipp_attribute_t
*attr
; /* Current attribute */
6430 ipp_tag_t group
; /* Current group */
6431 _ipp_value_t
*value
; /* Current value */
6434 DEBUG_printf(("3ipp_length(ipp=%p, collection=%d)", (void *)ipp
, collection
));
6438 DEBUG_puts("4ipp_length: Returning 0 bytes");
6443 * Start with 8 bytes for the IPP message header...
6446 bytes
= collection
? 0 : 8;
6449 * Then add the lengths of each attribute...
6452 group
= IPP_TAG_ZERO
;
6454 for (attr
= ipp
->attrs
; attr
!= NULL
; attr
= attr
->next
)
6456 if (attr
->group_tag
!= group
&& !collection
)
6458 group
= attr
->group_tag
;
6459 if (group
== IPP_TAG_ZERO
)
6462 bytes
++; /* Group tag */
6468 DEBUG_printf(("5ipp_length: attr->name=\"%s\", attr->num_values=%d, "
6469 "bytes=" CUPS_LLFMT
, attr
->name
, attr
->num_values
, CUPS_LLCAST bytes
));
6471 if ((attr
->value_tag
& ~IPP_TAG_CUPS_CONST
) < IPP_TAG_EXTENSION
)
6472 bytes
+= (size_t)attr
->num_values
;/* Value tag for each value */
6474 bytes
+= (size_t)(5 * attr
->num_values
);
6475 /* Value tag for each value */
6476 bytes
+= (size_t)(2 * attr
->num_values
);
6478 bytes
+= strlen(attr
->name
); /* Name */
6479 bytes
+= (size_t)(2 * attr
->num_values
);
6483 bytes
+= 5; /* Add membername overhead */
6485 switch (attr
->value_tag
& ~IPP_TAG_CUPS_CONST
)
6487 case IPP_TAG_UNSUPPORTED_VALUE
:
6488 case IPP_TAG_DEFAULT
:
6489 case IPP_TAG_UNKNOWN
:
6490 case IPP_TAG_NOVALUE
:
6491 case IPP_TAG_NOTSETTABLE
:
6492 case IPP_TAG_DELETEATTR
:
6493 case IPP_TAG_ADMINDEFINE
:
6496 case IPP_TAG_INTEGER
:
6498 bytes
+= (size_t)(4 * attr
->num_values
);
6501 case IPP_TAG_BOOLEAN
:
6502 bytes
+= (size_t)attr
->num_values
;
6507 case IPP_TAG_KEYWORD
:
6509 case IPP_TAG_URISCHEME
:
6510 case IPP_TAG_CHARSET
:
6511 case IPP_TAG_LANGUAGE
:
6512 case IPP_TAG_MIMETYPE
:
6513 for (i
= 0, value
= attr
->values
;
6514 i
< attr
->num_values
;
6516 if (value
->string
.text
)
6517 bytes
+= strlen(value
->string
.text
);
6521 bytes
+= (size_t)(11 * attr
->num_values
);
6524 case IPP_TAG_RESOLUTION
:
6525 bytes
+= (size_t)(9 * attr
->num_values
);
6528 case IPP_TAG_RANGE
:
6529 bytes
+= (size_t)(8 * attr
->num_values
);
6532 case IPP_TAG_TEXTLANG
:
6533 case IPP_TAG_NAMELANG
:
6534 bytes
+= (size_t)(4 * attr
->num_values
);
6535 /* Charset + text length */
6537 for (i
= 0, value
= attr
->values
;
6538 i
< attr
->num_values
;
6541 if (value
->string
.language
)
6542 bytes
+= strlen(value
->string
.language
);
6544 if (value
->string
.text
)
6545 bytes
+= strlen(value
->string
.text
);
6549 case IPP_TAG_BEGIN_COLLECTION
:
6550 for (i
= 0, value
= attr
->values
;
6551 i
< attr
->num_values
;
6553 bytes
+= ipp_length(value
->collection
, 1);
6557 for (i
= 0, value
= attr
->values
;
6558 i
< attr
->num_values
;
6560 bytes
+= (size_t)value
->unknown
.length
;
6566 * Finally, add 1 byte for the "end of attributes" tag or 5 bytes
6567 * for the "end of collection" tag and return...
6575 DEBUG_printf(("4ipp_length: Returning " CUPS_LLFMT
" bytes", CUPS_LLCAST bytes
));
6582 * 'ipp_read_http()' - Semi-blocking read on a HTTP connection...
6585 static ssize_t
/* O - Number of bytes read */
6586 ipp_read_http(http_t
*http
, /* I - Client connection */
6587 ipp_uchar_t
*buffer
, /* O - Buffer for data */
6588 size_t length
) /* I - Total length */
6590 ssize_t tbytes
, /* Total bytes read */
6591 bytes
; /* Bytes read this pass */
6594 DEBUG_printf(("7ipp_read_http(http=%p, buffer=%p, length=%d)", (void *)http
, (void *)buffer
, (int)length
));
6597 * Loop until all bytes are read...
6600 for (tbytes
= 0, bytes
= 0;
6601 tbytes
< (int)length
;
6602 tbytes
+= bytes
, buffer
+= bytes
)
6604 DEBUG_printf(("9ipp_read_http: tbytes=" CUPS_LLFMT
", http->state=%d", CUPS_LLCAST tbytes
, http
->state
));
6606 if (http
->state
== HTTP_STATE_WAITING
)
6609 if (http
->used
== 0 && !http
->blocking
)
6612 * Wait up to 10 seconds for more data on non-blocking sockets...
6615 if (!httpWait(http
, 10000))
6625 else if (http
->used
== 0 && http
->timeout_value
> 0)
6628 * Wait up to timeout seconds for more data on blocking sockets...
6631 if (!httpWait(http
, (int)(1000 * http
->timeout_value
)))
6642 if ((bytes
= httpRead2(http
, (char *)buffer
, length
- (size_t)tbytes
)) < 0)
6647 if (errno
!= EAGAIN
&& errno
!= EINTR
)
6653 else if (bytes
== 0)
6658 * Return the number of bytes read...
6661 if (tbytes
== 0 && bytes
< 0)
6664 DEBUG_printf(("8ipp_read_http: Returning " CUPS_LLFMT
" bytes", CUPS_LLCAST tbytes
));
6671 * 'ipp_read_file()' - Read IPP data from a file.
6674 static ssize_t
/* O - Number of bytes read */
6675 ipp_read_file(int *fd
, /* I - File descriptor */
6676 ipp_uchar_t
*buffer
, /* O - Read buffer */
6677 size_t length
) /* I - Number of bytes to read */
6680 return ((ssize_t
)read(*fd
, buffer
, (unsigned)length
));
6682 return (read(*fd
, buffer
, length
));
6688 * 'ipp_set_error()' - Set a formatted, localized error string.
6692 ipp_set_error(ipp_status_t status
, /* I - Status code */
6693 const char *format
, /* I - Printf-style error string */
6694 ...) /* I - Additional arguments as needed */
6696 va_list ap
; /* Pointer to additional args */
6697 char buffer
[2048]; /* Message buffer */
6698 cups_lang_t
*lang
= cupsLangDefault();
6699 /* Current language */
6702 va_start(ap
, format
);
6703 vsnprintf(buffer
, sizeof(buffer
), _cupsLangString(lang
, format
), ap
);
6706 _cupsSetError(status
, buffer
, 0);
6711 * 'ipp_set_value()' - Get the value element from an attribute, expanding it as
6715 static _ipp_value_t
* /* O - IPP value element or NULL on error */
6716 ipp_set_value(ipp_t
*ipp
, /* IO - IPP message */
6717 ipp_attribute_t
**attr
, /* IO - IPP attribute */
6718 int element
) /* I - Value number (0-based) */
6720 ipp_attribute_t
*temp
, /* New attribute pointer */
6721 *current
, /* Current attribute in list */
6722 *prev
; /* Previous attribute in list */
6723 int alloc_values
; /* Allocated values */
6727 * If we are setting an existing value element, return it...
6732 if (temp
->num_values
<= 1)
6735 alloc_values
= (temp
->num_values
+ IPP_MAX_VALUES
- 1) &
6736 ~(IPP_MAX_VALUES
- 1);
6738 if (element
< alloc_values
)
6740 if (element
>= temp
->num_values
)
6741 temp
->num_values
= element
+ 1;
6743 return (temp
->values
+ element
);
6747 * Otherwise re-allocate the attribute - we allocate in groups of IPP_MAX_VALUE
6748 * values when num_values > 1.
6751 if (alloc_values
< IPP_MAX_VALUES
)
6752 alloc_values
= IPP_MAX_VALUES
;
6754 alloc_values
+= IPP_MAX_VALUES
;
6756 DEBUG_printf(("4ipp_set_value: Reallocating for up to %d values.",
6760 * Reallocate memory...
6763 if ((temp
= realloc(temp
, sizeof(ipp_attribute_t
) + (size_t)(alloc_values
- 1) * sizeof(_ipp_value_t
))) == NULL
)
6765 _cupsSetHTTPError(HTTP_STATUS_ERROR
);
6766 DEBUG_puts("4ipp_set_value: Unable to resize attribute.");
6771 * Zero the new memory...
6774 memset(temp
->values
+ temp
->num_values
, 0, (size_t)(alloc_values
- temp
->num_values
) * sizeof(_ipp_value_t
));
6779 * Reset pointers in the list...
6782 #ifndef __clang_analyzer__
6783 DEBUG_printf(("4debug_free: %p %s", (void *)*attr
, temp
->name
));
6784 #endif /* !__clang_analyzer__ */
6785 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
));
6787 if (ipp
->current
== *attr
&& ipp
->prev
)
6790 * Use current "previous" pointer...
6798 * Find this attribute in the linked list...
6801 for (prev
= NULL
, current
= ipp
->attrs
;
6802 current
&& current
!= *attr
;
6803 prev
= current
, current
= current
->next
);
6808 * This is a serious error!
6812 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
6813 _("IPP attribute is not a member of the message."), 1);
6814 DEBUG_puts("4ipp_set_value: Unable to find attribute in message.");
6824 ipp
->current
= temp
;
6827 if (ipp
->last
== *attr
)
6834 * Return the value element...
6837 if (element
>= temp
->num_values
)
6838 temp
->num_values
= element
+ 1;
6840 return (temp
->values
+ element
);
6845 * 'ipp_write_file()' - Write IPP data to a file.
6848 static ssize_t
/* O - Number of bytes written */
6849 ipp_write_file(int *fd
, /* I - File descriptor */
6850 ipp_uchar_t
*buffer
, /* I - Data to write */
6851 size_t length
) /* I - Number of bytes to write */
6854 return ((ssize_t
)write(*fd
, buffer
, (unsigned)length
));
6856 return (write(*fd
, buffer
, length
));