]> git.ipfire.org Git - thirdparty/cups.git/blame - cups/ipp.c
Merge pull request #5913 from apple/bug-fix-rollup-1
[thirdparty/cups.git] / cups / ipp.c
CommitLineData
ef416fc2 1/*
7e86f2f6
MS
2 * Internet Printing Protocol functions for CUPS.
3 *
064e50fb 4 * Copyright © 2007-2021 by Apple Inc.
4cadd620 5 * Copyright © 1997-2007 by Easy Software Products, all rights reserved.
7e86f2f6 6 *
4cadd620
MS
7 * Licensed under Apache License v2.0. See the file "LICENSE" for more
8 * information.
ef416fc2 9 */
10
11/*
12 * Include necessary headers...
13 */
14
71e16022 15#include "cups-private.h"
fb863569 16#include "debug-internal.h"
c1420c87 17#include <regex.h>
19dc16f7 18#ifdef _WIN32
ef416fc2 19# include <io.h>
19dc16f7 20#endif /* _WIN32 */
ef416fc2 21
22
23/*
24 * Local functions...
25 */
26
82cc1f9a
MS
27static ipp_attribute_t *ipp_add_attr(ipp_t *ipp, const char *name,
28 ipp_tag_t group_tag, ipp_tag_t value_tag,
29 int num_values);
30static void ipp_free_values(ipp_attribute_t *attr, int element,
31 int count);
a32af27c
MS
32static char *ipp_get_code(const char *locale, char *buffer, size_t bufsize) _CUPS_NONNULL(1,2);
33static char *ipp_lang_code(const char *locale, char *buffer, size_t bufsize) _CUPS_NONNULL(1,2);
ef416fc2 34static size_t ipp_length(ipp_t *ipp, int collection);
a4d04587 35static ssize_t ipp_read_http(http_t *http, ipp_uchar_t *buffer,
36 size_t length);
37static ssize_t ipp_read_file(int *fd, ipp_uchar_t *buffer,
38 size_t length);
c1420c87
MS
39static void ipp_set_error(ipp_status_t status, const char *format,
40 ...);
82cc1f9a
MS
41static _ipp_value_t *ipp_set_value(ipp_t *ipp, ipp_attribute_t **attr,
42 int element);
a4d04587 43static ssize_t ipp_write_file(int *fd, ipp_uchar_t *buffer,
44 size_t length);
ef416fc2 45
46
dcb445bc
MS
47/*
48 * '_cupsBufferGet()' - Get a read/write buffer.
49 */
50
51char * /* O - Buffer */
52_cupsBufferGet(size_t size) /* I - Size required */
53{
54 _cups_buffer_t *buffer; /* Current buffer */
55 _cups_globals_t *cg = _cupsGlobals();
56 /* Global data */
57
58
59 for (buffer = cg->cups_buffers; buffer; buffer = buffer->next)
60 if (!buffer->used && buffer->size >= size)
61 break;
62
63 if (!buffer)
64 {
65 if ((buffer = malloc(sizeof(_cups_buffer_t) + size - 1)) == NULL)
66 return (NULL);
67
68 buffer->next = cg->cups_buffers;
69 buffer->size = size;
70 cg->cups_buffers = buffer;
71 }
72
73 buffer->used = 1;
74
75 return (buffer->d);
76}
77
78
79/*
80 * '_cupsBufferRelease()' - Release a read/write buffer.
81 */
82
83void
84_cupsBufferRelease(char *b) /* I - Buffer to release */
85{
86 _cups_buffer_t *buffer; /* Buffer */
87
88
89 /*
90 * Mark this buffer as unused...
91 */
92
93 buffer = (_cups_buffer_t *)(b - offsetof(_cups_buffer_t, d));
94 buffer->used = 0;
95}
96
97
ef416fc2 98/*
99 * 'ippAddBoolean()' - Add a boolean attribute to an IPP message.
a2326b5b 100 *
a469f8a5
MS
101 * The @code ipp@ parameter refers to an IPP message previously created using
102 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
103 *
104 * The @code group@ parameter specifies the IPP attribute group tag: none
105 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
106 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
107 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
108 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
ef416fc2 109 */
110
111ipp_attribute_t * /* O - New attribute */
112ippAddBoolean(ipp_t *ipp, /* I - IPP message */
113 ipp_tag_t group, /* I - IPP group */
114 const char *name, /* I - Name of attribute */
115 char value) /* I - Value of attribute */
116{
117 ipp_attribute_t *attr; /* New attribute */
118
119
807315e6 120 DEBUG_printf(("ippAddBoolean(ipp=%p, group=%02x(%s), name=\"%s\", value=%d)", (void *)ipp, group, ippTagString(group), name, value));
ef416fc2 121
a2326b5b
MS
122 /*
123 * Range check input...
124 */
125
126 if (!ipp || !name || group < IPP_TAG_ZERO ||
127 group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE)
ef416fc2 128 return (NULL);
129
a2326b5b
MS
130 /*
131 * Create the attribute...
132 */
133
134 if ((attr = ipp_add_attr(ipp, name, group, IPP_TAG_BOOLEAN, 1)) == NULL)
ef416fc2 135 return (NULL);
136
ef416fc2 137 attr->values[0].boolean = value;
138
139 return (attr);
140}
141
142
143/*
144 * 'ippAddBooleans()' - Add an array of boolean values.
a2326b5b 145 *
a469f8a5
MS
146 * The @code ipp@ parameter refers to an IPP message previously created using
147 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
148 *
149 * The @code group@ parameter specifies the IPP attribute group tag: none
150 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
151 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
152 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
153 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
ef416fc2 154 */
155
156ipp_attribute_t * /* O - New attribute */
157ippAddBooleans(ipp_t *ipp, /* I - IPP message */
158 ipp_tag_t group, /* I - IPP group */
159 const char *name, /* I - Name of attribute */
160 int num_values, /* I - Number of values */
161 const char *values) /* I - Values */
162{
163 int i; /* Looping var */
164 ipp_attribute_t *attr; /* New attribute */
a2326b5b 165 _ipp_value_t *value; /* Current value */
ef416fc2 166
167
807315e6 168 DEBUG_printf(("ippAddBooleans(ipp=%p, group=%02x(%s), name=\"%s\", num_values=%d, values=%p)", (void *)ipp, group, ippTagString(group), name, num_values, (void *)values));
ef416fc2 169
a2326b5b
MS
170 /*
171 * Range check input...
172 */
ef416fc2 173
a2326b5b
MS
174 if (!ipp || !name || group < IPP_TAG_ZERO ||
175 group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE ||
176 num_values < 1)
ef416fc2 177 return (NULL);
178
a2326b5b
MS
179 /*
180 * Create the attribute...
181 */
182
183 if ((attr = ipp_add_attr(ipp, name, group, IPP_TAG_BOOLEAN, num_values)) == NULL)
184 return (NULL);
ef416fc2 185
a2326b5b
MS
186 if (values)
187 {
188 for (i = num_values, value = attr->values;
189 i > 0;
190 i --, value ++)
191 value->boolean = *values++;
192 }
ef416fc2 193
194 return (attr);
195}
196
197
198/*
199 * 'ippAddCollection()' - Add a collection value.
200 *
a469f8a5
MS
201 * The @code ipp@ parameter refers to an IPP message previously created using
202 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
203 *
204 * The @code group@ parameter specifies the IPP attribute group tag: none
205 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
206 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
207 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
208 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
209 *
8072030b 210 * @since CUPS 1.1.19/macOS 10.3@
ef416fc2 211 */
212
213ipp_attribute_t * /* O - New attribute */
214ippAddCollection(ipp_t *ipp, /* I - IPP message */
215 ipp_tag_t group, /* I - IPP group */
216 const char *name, /* I - Name of attribute */
217 ipp_t *value) /* I - Value */
218{
219 ipp_attribute_t *attr; /* New attribute */
220
221
807315e6 222 DEBUG_printf(("ippAddCollection(ipp=%p, group=%02x(%s), name=\"%s\", value=%p)", (void *)ipp, group, ippTagString(group), name, (void *)value));
ef416fc2 223
a2326b5b
MS
224 /*
225 * Range check input...
226 */
227
228 if (!ipp || !name || group < IPP_TAG_ZERO ||
229 group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE)
ef416fc2 230 return (NULL);
231
a2326b5b
MS
232 /*
233 * Create the attribute...
234 */
235
236 if ((attr = ipp_add_attr(ipp, name, group, IPP_TAG_BEGIN_COLLECTION, 1)) == NULL)
ef416fc2 237 return (NULL);
238
ef416fc2 239 attr->values[0].collection = value;
240
9c80ffa2
MS
241 if (value)
242 value->use ++;
aaf19ab0 243
ef416fc2 244 return (attr);
245}
246
247
248/*
249 * 'ippAddCollections()' - Add an array of collection values.
250 *
a469f8a5
MS
251 * The @code ipp@ parameter refers to an IPP message previously created using
252 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
253 *
254 * The @code group@ parameter specifies the IPP attribute group tag: none
255 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
256 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
257 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
258 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
259 *
8072030b 260 * @since CUPS 1.1.19/macOS 10.3@
ef416fc2 261 */
262
263ipp_attribute_t * /* O - New attribute */
264ippAddCollections(
265 ipp_t *ipp, /* I - IPP message */
266 ipp_tag_t group, /* I - IPP group */
267 const char *name, /* I - Name of attribute */
268 int num_values, /* I - Number of values */
269 const ipp_t **values) /* I - Values */
270{
271 int i; /* Looping var */
272 ipp_attribute_t *attr; /* New attribute */
a2326b5b 273 _ipp_value_t *value; /* Current value */
ef416fc2 274
275
807315e6 276 DEBUG_printf(("ippAddCollections(ipp=%p, group=%02x(%s), name=\"%s\", num_values=%d, values=%p)", (void *)ipp, group, ippTagString(group), name, num_values, (void *)values));
ef416fc2 277
a2326b5b
MS
278 /*
279 * Range check input...
280 */
ef416fc2 281
a2326b5b
MS
282 if (!ipp || !name || group < IPP_TAG_ZERO ||
283 group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE ||
284 num_values < 1)
ef416fc2 285 return (NULL);
286
a2326b5b
MS
287 /*
288 * Create the attribute...
289 */
290
291 if ((attr = ipp_add_attr(ipp, name, group, IPP_TAG_BEGIN_COLLECTION,
292 num_values)) == NULL)
293 return (NULL);
ef416fc2 294
a2326b5b 295 if (values)
aaf19ab0 296 {
a2326b5b
MS
297 for (i = num_values, value = attr->values;
298 i > 0;
299 i --, value ++)
aaf19ab0 300 {
a2326b5b 301 value->collection = (ipp_t *)*values++;
aaf19ab0
MS
302 value->collection->use ++;
303 }
304 }
ef416fc2 305
306 return (attr);
307}
308
309
310/*
65bebeac 311 * 'ippAddDate()' - Add a dateTime attribute to an IPP message.
a2326b5b 312 *
a469f8a5
MS
313 * The @code ipp@ parameter refers to an IPP message previously created using
314 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
315 *
316 * The @code group@ parameter specifies the IPP attribute group tag: none
317 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
318 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
319 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
320 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
ef416fc2 321 */
322
323ipp_attribute_t * /* O - New attribute */
324ippAddDate(ipp_t *ipp, /* I - IPP message */
325 ipp_tag_t group, /* I - IPP group */
326 const char *name, /* I - Name of attribute */
327 const ipp_uchar_t *value) /* I - Value */
328{
329 ipp_attribute_t *attr; /* New attribute */
330
331
807315e6 332 DEBUG_printf(("ippAddDate(ipp=%p, group=%02x(%s), name=\"%s\", value=%p)", (void *)ipp, group, ippTagString(group), name, (void *)value));
ef416fc2 333
a2326b5b
MS
334 /*
335 * Range check input...
336 */
337
338 if (!ipp || !name || !value || group < IPP_TAG_ZERO ||
339 group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE)
ef416fc2 340 return (NULL);
341
a2326b5b
MS
342 /*
343 * Create the attribute...
344 */
345
346 if ((attr = ipp_add_attr(ipp, name, group, IPP_TAG_DATE, 1)) == NULL)
ef416fc2 347 return (NULL);
348
ef416fc2 349 memcpy(attr->values[0].date, value, 11);
350
351 return (attr);
352}
353
354
355/*
356 * 'ippAddInteger()' - Add a integer attribute to an IPP message.
a2326b5b 357 *
a469f8a5
MS
358 * The @code ipp@ parameter refers to an IPP message previously created using
359 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
360 *
361 * The @code group@ parameter specifies the IPP attribute group tag: none
362 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
363 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
364 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
365 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
366 *
367 * Supported values include enum (@code IPP_TAG_ENUM@) and integer
368 * (@code IPP_TAG_INTEGER@).
ef416fc2 369 */
370
371ipp_attribute_t * /* O - New attribute */
372ippAddInteger(ipp_t *ipp, /* I - IPP message */
373 ipp_tag_t group, /* I - IPP group */
a2326b5b 374 ipp_tag_t value_tag, /* I - Type of attribute */
ef416fc2 375 const char *name, /* I - Name of attribute */
376 int value) /* I - Value of attribute */
377{
378 ipp_attribute_t *attr; /* New attribute */
379
380
807315e6 381 DEBUG_printf(("ippAddInteger(ipp=%p, group=%02x(%s), type=%02x(%s), name=\"%s\", value=%d)", (void *)ipp, group, ippTagString(group), value_tag, ippTagString(value_tag), name, value));
ef416fc2 382
cb7f98ee 383 value_tag &= IPP_TAG_CUPS_MASK;
a2326b5b
MS
384
385 /*
386 * Special-case for legacy usage: map out-of-band attributes to new ippAddOutOfBand
387 * function...
388 */
389
390 if (value_tag >= IPP_TAG_UNSUPPORTED_VALUE && value_tag <= IPP_TAG_ADMINDEFINE)
391 return (ippAddOutOfBand(ipp, group, value_tag, name));
392
393 /*
394 * Range check input...
395 */
396
397#if 0
398 if (!ipp || !name || group < IPP_TAG_ZERO ||
399 group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE ||
400 (value_tag != IPP_TAG_INTEGER && value_tag != IPP_TAG_ENUM))
401 return (NULL);
402#else
403 if (!ipp || !name || group < IPP_TAG_ZERO ||
404 group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE)
ef416fc2 405 return (NULL);
a2326b5b 406#endif /* 0 */
ef416fc2 407
a2326b5b
MS
408 /*
409 * Create the attribute...
410 */
411
412 if ((attr = ipp_add_attr(ipp, name, group, value_tag, 1)) == NULL)
ef416fc2 413 return (NULL);
414
ef416fc2 415 attr->values[0].integer = value;
416
417 return (attr);
418}
419
420
421/*
422 * 'ippAddIntegers()' - Add an array of integer values.
a2326b5b 423 *
a469f8a5
MS
424 * The @code ipp@ parameter refers to an IPP message previously created using
425 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
426 *
427 * The @code group@ parameter specifies the IPP attribute group tag: none
428 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
429 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
430 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
431 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
432 *
433 * Supported values include enum (@code IPP_TAG_ENUM@) and integer
434 * (@code IPP_TAG_INTEGER@).
ef416fc2 435 */
436
437ipp_attribute_t * /* O - New attribute */
438ippAddIntegers(ipp_t *ipp, /* I - IPP message */
439 ipp_tag_t group, /* I - IPP group */
a2326b5b 440 ipp_tag_t value_tag, /* I - Type of attribute */
ef416fc2 441 const char *name, /* I - Name of attribute */
442 int num_values, /* I - Number of values */
443 const int *values) /* I - Values */
444{
445 int i; /* Looping var */
446 ipp_attribute_t *attr; /* New attribute */
a2326b5b 447 _ipp_value_t *value; /* Current value */
ef416fc2 448
449
807315e6 450 DEBUG_printf(("ippAddIntegers(ipp=%p, group=%02x(%s), type=%02x(%s), name=\"%s\", num_values=%d, values=%p)", (void *)ipp, group, ippTagString(group), value_tag, ippTagString(value_tag), name, num_values, (void *)values));
1ff0402e 451
cb7f98ee 452 value_tag &= IPP_TAG_CUPS_MASK;
a2326b5b
MS
453
454 /*
455 * Range check input...
456 */
ef416fc2 457
a2326b5b
MS
458#if 0
459 if (!ipp || !name || group < IPP_TAG_ZERO ||
460 group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE ||
461 (value_tag != IPP_TAG_INTEGER && value_tag != IPP_TAG_ENUM) ||
462 num_values < 1)
463 return (NULL);
464#else
465 if (!ipp || !name || group < IPP_TAG_ZERO ||
466 group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE ||
467 num_values < 1)
ef416fc2 468 return (NULL);
a2326b5b 469#endif /* 0 */
ef416fc2 470
a2326b5b
MS
471 /*
472 * Create the attribute...
473 */
474
475 if ((attr = ipp_add_attr(ipp, name, group, value_tag, num_values)) == NULL)
476 return (NULL);
ef416fc2 477
a2326b5b
MS
478 if (values)
479 {
480 for (i = num_values, value = attr->values;
481 i > 0;
482 i --, value ++)
483 value->integer = *values++;
484 }
ef416fc2 485
486 return (attr);
487}
488
489
490/*
491 * 'ippAddOctetString()' - Add an octetString value to an IPP message.
492 *
a469f8a5
MS
493 * The @code ipp@ parameter refers to an IPP message previously created using
494 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
495 *
496 * The @code group@ parameter specifies the IPP attribute group tag: none
497 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
498 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
499 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
500 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
501 *
8072030b 502 * @since CUPS 1.2/macOS 10.5@
ef416fc2 503 */
504
505ipp_attribute_t * /* O - New attribute */
506ippAddOctetString(ipp_t *ipp, /* I - IPP message */
507 ipp_tag_t group, /* I - IPP group */
508 const char *name, /* I - Name of attribute */
509 const void *data, /* I - octetString data */
510 int datalen) /* I - Length of data in bytes */
511{
512 ipp_attribute_t *attr; /* New attribute */
513
514
a2326b5b 515 if (!ipp || !name || group < IPP_TAG_ZERO ||
5a9febac 516 group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE ||
a469f8a5 517 datalen < 0 || datalen > IPP_MAX_LENGTH)
ef416fc2 518 return (NULL);
519
a2326b5b 520 if ((attr = ipp_add_attr(ipp, name, group, IPP_TAG_STRING, 1)) == NULL)
ef416fc2 521 return (NULL);
522
523 /*
524 * Initialize the attribute data...
525 */
526
ef416fc2 527 attr->values[0].unknown.length = datalen;
528
529 if (data)
530 {
7e86f2f6 531 if ((attr->values[0].unknown.data = malloc((size_t)datalen)) == NULL)
91c84a35
MS
532 {
533 ippDeleteAttribute(ipp, attr);
534 return (NULL);
535 }
536
07623986 537 memcpy(attr->values[0].unknown.data, data, (size_t)datalen);
ef416fc2 538 }
539
540 /*
541 * Return the new attribute...
542 */
543
544 return (attr);
545}
546
547
548/*
a2326b5b
MS
549 * 'ippAddOutOfBand()' - Add an out-of-band value to an IPP message.
550 *
a469f8a5
MS
551 * The @code ipp@ parameter refers to an IPP message previously created using
552 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
553 *
554 * The @code group@ parameter specifies the IPP attribute group tag: none
555 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
556 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
557 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
558 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
559 *
560 * Supported out-of-band values include unsupported-value
561 * (@code IPP_TAG_UNSUPPORTED_VALUE@), default (@code IPP_TAG_DEFAULT@), unknown
562 * (@code IPP_TAG_UNKNOWN@), no-value (@code IPP_TAG_NOVALUE@), not-settable
563 * (@code IPP_TAG_NOTSETTABLE@), delete-attribute (@code IPP_TAG_DELETEATTR@), and
564 * admin-define (@code IPP_TAG_ADMINDEFINE@).
565 *
8072030b 566 * @since CUPS 1.6/macOS 10.8@
ef416fc2 567 */
568
a2326b5b
MS
569ipp_attribute_t * /* O - New attribute */
570ippAddOutOfBand(ipp_t *ipp, /* I - IPP message */
571 ipp_tag_t group, /* I - IPP group */
572 ipp_tag_t value_tag, /* I - Type of attribute */
573 const char *name) /* I - Name of attribute */
ef416fc2 574{
807315e6 575 DEBUG_printf(("ippAddOutOfBand(ipp=%p, group=%02x(%s), value_tag=%02x(%s), name=\"%s\")", (void *)ipp, group, ippTagString(group), value_tag, ippTagString(value_tag), name));
ef416fc2 576
cb7f98ee 577 value_tag &= IPP_TAG_CUPS_MASK;
ef416fc2 578
4400e98d 579 /*
a2326b5b 580 * Range check input...
4400e98d 581 */
582
a2326b5b
MS
583 if (!ipp || !name || group < IPP_TAG_ZERO ||
584 group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE ||
585 (value_tag != IPP_TAG_UNSUPPORTED_VALUE &&
586 value_tag != IPP_TAG_DEFAULT &&
587 value_tag != IPP_TAG_UNKNOWN &&
588 value_tag != IPP_TAG_NOVALUE &&
589 value_tag != IPP_TAG_NOTSETTABLE &&
590 value_tag != IPP_TAG_DELETEATTR &&
591 value_tag != IPP_TAG_ADMINDEFINE))
ef416fc2 592 return (NULL);
593
594 /*
a2326b5b 595 * Create the attribute...
ef416fc2 596 */
597
a2326b5b 598 return (ipp_add_attr(ipp, name, group, value_tag, 1));
ef416fc2 599}
600
601
602/*
603 * 'ippAddRange()' - Add a range of values to an IPP message.
a2326b5b 604 *
a469f8a5
MS
605 * The @code ipp@ parameter refers to an IPP message previously created using
606 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
607 *
608 * The @code group@ parameter specifies the IPP attribute group tag: none
609 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
610 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
611 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
612 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
613 *
614 * The @code lower@ parameter must be less than or equal to the @code upper@ parameter.
ef416fc2 615 */
616
617ipp_attribute_t * /* O - New attribute */
618ippAddRange(ipp_t *ipp, /* I - IPP message */
619 ipp_tag_t group, /* I - IPP group */
620 const char *name, /* I - Name of attribute */
621 int lower, /* I - Lower value */
622 int upper) /* I - Upper value */
623{
624 ipp_attribute_t *attr; /* New attribute */
625
626
807315e6 627 DEBUG_printf(("ippAddRange(ipp=%p, group=%02x(%s), name=\"%s\", lower=%d, upper=%d)", (void *)ipp, group, ippTagString(group), name, lower, upper));
1ff0402e 628
a2326b5b
MS
629 /*
630 * Range check input...
631 */
632
633 if (!ipp || !name || group < IPP_TAG_ZERO ||
634 group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE)
ef416fc2 635 return (NULL);
636
a2326b5b
MS
637 /*
638 * Create the attribute...
639 */
640
641 if ((attr = ipp_add_attr(ipp, name, group, IPP_TAG_RANGE, 1)) == NULL)
ef416fc2 642 return (NULL);
643
ef416fc2 644 attr->values[0].range.lower = lower;
645 attr->values[0].range.upper = upper;
646
647 return (attr);
648}
649
650
651/*
652 * 'ippAddRanges()' - Add ranges of values to an IPP message.
a2326b5b 653 *
a469f8a5
MS
654 * The @code ipp@ parameter refers to an IPP message previously created using
655 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
656 *
657 * The @code group@ parameter specifies the IPP attribute group tag: none
658 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
659 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
660 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
661 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
ef416fc2 662 */
663
664ipp_attribute_t * /* O - New attribute */
665ippAddRanges(ipp_t *ipp, /* I - IPP message */
666 ipp_tag_t group, /* I - IPP group */
667 const char *name, /* I - Name of attribute */
668 int num_values, /* I - Number of values */
669 const int *lower, /* I - Lower values */
670 const int *upper) /* I - Upper values */
671{
672 int i; /* Looping var */
673 ipp_attribute_t *attr; /* New attribute */
a2326b5b 674 _ipp_value_t *value; /* Current value */
ef416fc2 675
676
807315e6 677 DEBUG_printf(("ippAddRanges(ipp=%p, group=%02x(%s), name=\"%s\", num_values=%d, lower=%p, upper=%p)", (void *)ipp, group, ippTagString(group), name, num_values, (void *)lower, (void *)upper));
1ff0402e 678
a2326b5b
MS
679 /*
680 * Range check input...
681 */
ef416fc2 682
a2326b5b
MS
683 if (!ipp || !name || group < IPP_TAG_ZERO ||
684 group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE ||
685 num_values < 1)
ef416fc2 686 return (NULL);
687
a2326b5b
MS
688 /*
689 * Create the attribute...
690 */
691
692 if ((attr = ipp_add_attr(ipp, name, group, IPP_TAG_RANGE, num_values)) == NULL)
693 return (NULL);
ef416fc2 694
a2326b5b
MS
695 if (lower && upper)
696 {
697 for (i = num_values, value = attr->values;
698 i > 0;
699 i --, value ++)
ef416fc2 700 {
a2326b5b
MS
701 value->range.lower = *lower++;
702 value->range.upper = *upper++;
ef416fc2 703 }
a2326b5b 704 }
ef416fc2 705
706 return (attr);
707}
708
709
710/*
711 * 'ippAddResolution()' - Add a resolution value to an IPP message.
a2326b5b 712 *
a469f8a5
MS
713 * The @code ipp@ parameter refers to an IPP message previously created using
714 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
715 *
716 * The @code group@ parameter specifies the IPP attribute group tag: none
717 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
718 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
719 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
720 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
ef416fc2 721 */
722
723ipp_attribute_t * /* O - New attribute */
724ippAddResolution(ipp_t *ipp, /* I - IPP message */
725 ipp_tag_t group, /* I - IPP group */
726 const char *name, /* I - Name of attribute */
727 ipp_res_t units, /* I - Units for resolution */
728 int xres, /* I - X resolution */
729 int yres) /* I - Y resolution */
730{
731 ipp_attribute_t *attr; /* New attribute */
732
733
807315e6 734 DEBUG_printf(("ippAddResolution(ipp=%p, group=%02x(%s), name=\"%s\", units=%d, xres=%d, yres=%d)", (void *)ipp, group,
1ff0402e
MS
735 ippTagString(group), name, units, xres, yres));
736
a2326b5b
MS
737 /*
738 * Range check input...
739 */
740
741 if (!ipp || !name || group < IPP_TAG_ZERO ||
742 group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE ||
743 units < IPP_RES_PER_INCH || units > IPP_RES_PER_CM ||
744 xres < 0 || yres < 0)
ef416fc2 745 return (NULL);
746
a2326b5b
MS
747 /*
748 * Create the attribute...
749 */
750
751 if ((attr = ipp_add_attr(ipp, name, group, IPP_TAG_RESOLUTION, 1)) == NULL)
ef416fc2 752 return (NULL);
753
ef416fc2 754 attr->values[0].resolution.xres = xres;
755 attr->values[0].resolution.yres = yres;
756 attr->values[0].resolution.units = units;
757
758 return (attr);
759}
760
761
762/*
763 * 'ippAddResolutions()' - Add resolution values to an IPP message.
a2326b5b 764 *
a469f8a5
MS
765 * The @code ipp@ parameter refers to an IPP message previously created using
766 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
767 *
768 * The @code group@ parameter specifies the IPP attribute group tag: none
769 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
770 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
771 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
772 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
ef416fc2 773 */
774
775ipp_attribute_t * /* O - New attribute */
776ippAddResolutions(ipp_t *ipp, /* I - IPP message */
777 ipp_tag_t group, /* I - IPP group */
778 const char *name, /* I - Name of attribute */
779 int num_values,/* I - Number of values */
780 ipp_res_t units, /* I - Units for resolution */
781 const int *xres, /* I - X resolutions */
782 const int *yres) /* I - Y resolutions */
783{
784 int i; /* Looping var */
785 ipp_attribute_t *attr; /* New attribute */
a2326b5b 786 _ipp_value_t *value; /* Current value */
ef416fc2 787
788
807315e6 789 DEBUG_printf(("ippAddResolutions(ipp=%p, group=%02x(%s), name=\"%s\", num_value=%d, units=%d, xres=%p, yres=%p)", (void *)ipp, group, ippTagString(group), name, num_values, units, (void *)xres, (void *)yres));
1ff0402e 790
a2326b5b
MS
791 /*
792 * Range check input...
793 */
ef416fc2 794
a2326b5b
MS
795 if (!ipp || !name || group < IPP_TAG_ZERO ||
796 group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE ||
797 num_values < 1 ||
798 units < IPP_RES_PER_INCH || units > IPP_RES_PER_CM)
ef416fc2 799 return (NULL);
800
a2326b5b
MS
801 /*
802 * Create the attribute...
803 */
804
805 if ((attr = ipp_add_attr(ipp, name, group, IPP_TAG_RESOLUTION, num_values)) == NULL)
806 return (NULL);
ef416fc2 807
a2326b5b
MS
808 if (xres && yres)
809 {
810 for (i = num_values, value = attr->values;
811 i > 0;
812 i --, value ++)
ef416fc2 813 {
a2326b5b
MS
814 value->resolution.xres = *xres++;
815 value->resolution.yres = *yres++;
ef416fc2 816 value->resolution.units = units;
817 }
a2326b5b 818 }
ef416fc2 819
820 return (attr);
821}
822
823
824/*
825 * 'ippAddSeparator()' - Add a group separator to an IPP message.
a2326b5b 826 *
a469f8a5
MS
827 * The @code ipp@ parameter refers to an IPP message previously created using
828 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
ef416fc2 829 */
830
831ipp_attribute_t * /* O - New attribute */
832ippAddSeparator(ipp_t *ipp) /* I - IPP message */
833{
807315e6 834 DEBUG_printf(("ippAddSeparator(ipp=%p)", (void *)ipp));
ef416fc2 835
a2326b5b
MS
836 /*
837 * Range check input...
838 */
ef416fc2 839
a2326b5b 840 if (!ipp)
ef416fc2 841 return (NULL);
842
a2326b5b
MS
843 /*
844 * Create the attribute...
845 */
ef416fc2 846
a2326b5b 847 return (ipp_add_attr(ipp, NULL, IPP_TAG_ZERO, IPP_TAG_ZERO, 0));
ef416fc2 848}
849
850
851/*
a2326b5b
MS
852 * 'ippAddString()' - Add a language-encoded string to an IPP message.
853 *
a469f8a5
MS
854 * The @code ipp@ parameter refers to an IPP message previously created using
855 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
856 *
857 * The @code group@ parameter specifies the IPP attribute group tag: none
858 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
859 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
860 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
861 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
862 *
863 * Supported string values include charset (@code IPP_TAG_CHARSET@), keyword
864 * (@code IPP_TAG_KEYWORD@), language (@code IPP_TAG_LANGUAGE@), mimeMediaType
865 * (@code IPP_TAG_MIMETYPE@), name (@code IPP_TAG_NAME@), nameWithLanguage
866 * (@code IPP_TAG_NAMELANG), text (@code IPP_TAG_TEXT@), textWithLanguage
867 * (@code IPP_TAG_TEXTLANG@), uri (@code IPP_TAG_URI@), and uriScheme
868 * (@code IPP_TAG_URISCHEME@).
869 *
870 * The @code language@ parameter must be non-@code NULL@ for nameWithLanguage and
871 * textWithLanguage string values and must be @code NULL@ for all other string values.
ef416fc2 872 */
873
a2326b5b
MS
874ipp_attribute_t * /* O - New attribute */
875ippAddString(ipp_t *ipp, /* I - IPP message */
876 ipp_tag_t group, /* I - IPP group */
877 ipp_tag_t value_tag, /* I - Type of attribute */
878 const char *name, /* I - Name of attribute */
879 const char *language, /* I - Language code */
880 const char *value) /* I - Value */
ef416fc2 881{
a2326b5b
MS
882 ipp_tag_t temp_tag; /* Temporary value tag (masked) */
883 ipp_attribute_t *attr; /* New attribute */
5a9febac
MS
884 char code[IPP_MAX_LANGUAGE];
885 /* Charset/language code buffer */
ef416fc2 886
1ff0402e 887
807315e6 888 DEBUG_printf(("ippAddString(ipp=%p, group=%02x(%s), value_tag=%02x(%s), name=\"%s\", language=\"%s\", value=\"%s\")", (void *)ipp, group, ippTagString(group), value_tag, ippTagString(value_tag), name, language, value));
ef416fc2 889
890 /*
a2326b5b 891 * Range check input...
ef416fc2 892 */
893
cb7f98ee 894 temp_tag = (ipp_tag_t)((int)value_tag & IPP_TAG_CUPS_MASK);
ef416fc2 895
a2326b5b
MS
896#if 0
897 if (!ipp || !name || group < IPP_TAG_ZERO ||
898 group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE ||
899 (temp_tag < IPP_TAG_TEXT && temp_tag != IPP_TAG_TEXTLANG &&
900 temp_tag != IPP_TAG_NAMELANG) || temp_tag > IPP_TAG_MIMETYPE)
901 return (NULL);
ef416fc2 902
a2326b5b
MS
903 if ((temp_tag == IPP_TAG_TEXTLANG || temp_tag == IPP_TAG_NAMELANG)
904 != (language != NULL))
905 return (NULL);
906#else
907 if (!ipp || !name || group < IPP_TAG_ZERO ||
908 group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE)
909 return (NULL);
910#endif /* 0 */
ef416fc2 911
a2326b5b
MS
912 /*
913 * See if we need to map charset, language, or locale values...
914 */
ef416fc2 915
cb7f98ee 916 if (language && ((int)value_tag & IPP_TAG_CUPS_CONST) &&
a2326b5b
MS
917 strcmp(language, ipp_lang_code(language, code, sizeof(code))))
918 value_tag = temp_tag; /* Don't do a fast copy */
cb7f98ee 919 else if (value && value_tag == (ipp_tag_t)(IPP_TAG_CHARSET | IPP_TAG_CUPS_CONST) &&
a2326b5b
MS
920 strcmp(value, ipp_get_code(value, code, sizeof(code))))
921 value_tag = temp_tag; /* Don't do a fast copy */
cb7f98ee 922 else if (value && value_tag == (ipp_tag_t)(IPP_TAG_LANGUAGE | IPP_TAG_CUPS_CONST) &&
a2326b5b
MS
923 strcmp(value, ipp_lang_code(value, code, sizeof(code))))
924 value_tag = temp_tag; /* Don't do a fast copy */
ef416fc2 925
a2326b5b
MS
926 /*
927 * Create the attribute...
928 */
ef416fc2 929
a2326b5b
MS
930 if ((attr = ipp_add_attr(ipp, name, group, value_tag, 1)) == NULL)
931 return (NULL);
ef416fc2 932
a2326b5b
MS
933 /*
934 * Initialize the attribute data...
935 */
aaf19ab0 936
cb7f98ee 937 if ((int)value_tag & IPP_TAG_CUPS_CONST)
ef416fc2 938 {
a2326b5b
MS
939 attr->values[0].string.language = (char *)language;
940 attr->values[0].string.text = (char *)value;
941 }
942 else
943 {
944 if (language)
945 attr->values[0].string.language = _cupsStrAlloc(ipp_lang_code(language, code,
946 sizeof(code)));
947
82cc1f9a
MS
948 if (value)
949 {
950 if (value_tag == IPP_TAG_CHARSET)
951 attr->values[0].string.text = _cupsStrAlloc(ipp_get_code(value, code,
952 sizeof(code)));
953 else if (value_tag == IPP_TAG_LANGUAGE)
954 attr->values[0].string.text = _cupsStrAlloc(ipp_lang_code(value, code,
955 sizeof(code)));
956 else
957 attr->values[0].string.text = _cupsStrAlloc(value);
958 }
ef416fc2 959 }
960
a2326b5b 961 return (attr);
ef416fc2 962}
963
964
a469f8a5
MS
965/*
966 * 'ippAddStringf()' - Add a formatted string to an IPP message.
967 *
968 * The @code ipp@ parameter refers to an IPP message previously created using
969 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
970 *
971 * The @code group@ parameter specifies the IPP attribute group tag: none
972 * (@code IPP_TAG_ZERO@, for member attributes), document
973 * (@code IPP_TAG_DOCUMENT@), event notification
974 * (@code IPP_TAG_EVENT_NOTIFICATION@), operation (@code IPP_TAG_OPERATION@),
975 * printer (@code IPP_TAG_PRINTER@), subscription (@code IPP_TAG_SUBSCRIPTION@),
976 * or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
977 *
978 * Supported string values include charset (@code IPP_TAG_CHARSET@), keyword
979 * (@code IPP_TAG_KEYWORD@), language (@code IPP_TAG_LANGUAGE@), mimeMediaType
980 * (@code IPP_TAG_MIMETYPE@), name (@code IPP_TAG_NAME@), nameWithLanguage
981 * (@code IPP_TAG_NAMELANG), text (@code IPP_TAG_TEXT@), textWithLanguage
982 * (@code IPP_TAG_TEXTLANG@), uri (@code IPP_TAG_URI@), and uriScheme
983 * (@code IPP_TAG_URISCHEME@).
984 *
985 * The @code language@ parameter must be non-@code NULL@ for nameWithLanguage
986 * and textWithLanguage string values and must be @code NULL@ for all other
987 * string values.
988 *
989 * The @code format@ parameter uses formatting characters compatible with the
990 * printf family of standard functions. Additional arguments follow it as
991 * needed. The formatted string is truncated as needed to the maximum length of
992 * the corresponding value type.
993 *
8072030b 994 * @since CUPS 1.7/macOS 10.9@
a469f8a5
MS
995 */
996
997ipp_attribute_t * /* O - New attribute */
998ippAddStringf(ipp_t *ipp, /* I - IPP message */
999 ipp_tag_t group, /* I - IPP group */
1000 ipp_tag_t value_tag, /* I - Type of attribute */
1001 const char *name, /* I - Name of attribute */
1002 const char *language, /* I - Language code (@code NULL@ for default) */
1003 const char *format, /* I - Printf-style format string */
1004 ...) /* I - Additional arguments as needed */
1005{
1006 ipp_attribute_t *attr; /* New attribute */
1007 va_list ap; /* Argument pointer */
1008
1009
1010 va_start(ap, format);
1011 attr = ippAddStringfv(ipp, group, value_tag, name, language, format, ap);
1012 va_end(ap);
1013
1014 return (attr);
1015}
1016
1017
1018/*
1019 * 'ippAddStringfv()' - Add a formatted string to an IPP message.
1020 *
1021 * The @code ipp@ parameter refers to an IPP message previously created using
1022 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
1023 *
1024 * The @code group@ parameter specifies the IPP attribute group tag: none
1025 * (@code IPP_TAG_ZERO@, for member attributes), document
1026 * (@code IPP_TAG_DOCUMENT@), event notification
1027 * (@code IPP_TAG_EVENT_NOTIFICATION@), operation (@code IPP_TAG_OPERATION@),
1028 * printer (@code IPP_TAG_PRINTER@), subscription (@code IPP_TAG_SUBSCRIPTION@),
1029 * or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
1030 *
1031 * Supported string values include charset (@code IPP_TAG_CHARSET@), keyword
1032 * (@code IPP_TAG_KEYWORD@), language (@code IPP_TAG_LANGUAGE@), mimeMediaType
1033 * (@code IPP_TAG_MIMETYPE@), name (@code IPP_TAG_NAME@), nameWithLanguage
1034 * (@code IPP_TAG_NAMELANG), text (@code IPP_TAG_TEXT@), textWithLanguage
1035 * (@code IPP_TAG_TEXTLANG@), uri (@code IPP_TAG_URI@), and uriScheme
1036 * (@code IPP_TAG_URISCHEME@).
1037 *
1038 * The @code language@ parameter must be non-@code NULL@ for nameWithLanguage
1039 * and textWithLanguage string values and must be @code NULL@ for all other
1040 * string values.
1041 *
1042 * The @code format@ parameter uses formatting characters compatible with the
1043 * printf family of standard functions. Additional arguments are passed in the
1044 * stdarg pointer @code ap@. The formatted string is truncated as needed to the
1045 * maximum length of the corresponding value type.
1046 *
8072030b 1047 * @since CUPS 1.7/macOS 10.9@
a469f8a5
MS
1048 */
1049
1050ipp_attribute_t * /* O - New attribute */
1051ippAddStringfv(ipp_t *ipp, /* I - IPP message */
1052 ipp_tag_t group, /* I - IPP group */
1053 ipp_tag_t value_tag, /* I - Type of attribute */
1054 const char *name, /* I - Name of attribute */
1055 const char *language, /* I - Language code (@code NULL@ for default) */
1056 const char *format, /* I - Printf-style format string */
1057 va_list ap) /* I - Additional arguments */
1058{
1059 char buffer[IPP_MAX_TEXT + 4];
1060 /* Formatted text string */
1061 ssize_t bytes, /* Length of formatted value */
1062 max_bytes; /* Maximum number of bytes for value */
1063
1064
1065 /*
1066 * Range check input...
1067 */
1068
1069 if (!ipp || !name || group < IPP_TAG_ZERO ||
1070 group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE ||
1071 (value_tag < IPP_TAG_TEXT && value_tag != IPP_TAG_TEXTLANG &&
1072 value_tag != IPP_TAG_NAMELANG) || value_tag > IPP_TAG_MIMETYPE ||
56cd8959 1073 !format)
a469f8a5
MS
1074 return (NULL);
1075
1076 if ((value_tag == IPP_TAG_TEXTLANG || value_tag == IPP_TAG_NAMELANG)
1077 != (language != NULL))
1078 return (NULL);
1079
1080 /*
1081 * Format the string...
1082 */
1083
1084 if (!strcmp(format, "%s"))
1085 {
1086 /*
1087 * Optimize the simple case...
1088 */
1089
1090 const char *s = va_arg(ap, char *);
1091
1092 if (!s)
1093 s = "(null)";
1094
7e86f2f6 1095 bytes = (ssize_t)strlen(s);
a469f8a5
MS
1096 strlcpy(buffer, s, sizeof(buffer));
1097 }
1098 else
1099 {
1100 /*
1101 * Do a full formatting of the message...
1102 */
1103
1104 if ((bytes = vsnprintf(buffer, sizeof(buffer), format, ap)) < 0)
1105 return (NULL);
1106 }
1107
1108 /*
1109 * Limit the length of the string...
1110 */
1111
1112 switch (value_tag)
1113 {
1114 default :
1115 case IPP_TAG_TEXT :
1116 case IPP_TAG_TEXTLANG :
1117 max_bytes = IPP_MAX_TEXT;
1118 break;
1119
1120 case IPP_TAG_NAME :
1121 case IPP_TAG_NAMELANG :
1122 max_bytes = IPP_MAX_NAME;
1123 break;
1124
1125 case IPP_TAG_CHARSET :
1126 max_bytes = IPP_MAX_CHARSET;
1127 break;
1128
1129 case IPP_TAG_KEYWORD :
1130 max_bytes = IPP_MAX_KEYWORD;
1131 break;
1132
1133 case IPP_TAG_LANGUAGE :
1134 max_bytes = IPP_MAX_LANGUAGE;
1135 break;
1136
1137 case IPP_TAG_MIMETYPE :
1138 max_bytes = IPP_MAX_MIMETYPE;
1139 break;
1140
1141 case IPP_TAG_URI :
1142 max_bytes = IPP_MAX_URI;
1143 break;
1144
1145 case IPP_TAG_URISCHEME :
1146 max_bytes = IPP_MAX_URISCHEME;
1147 break;
1148 }
1149
1150 if (bytes >= max_bytes)
1151 {
1152 char *bufmax, /* Buffer at max_bytes */
1153 *bufptr; /* Pointer into buffer */
1154
1155 bufptr = buffer + strlen(buffer) - 1;
1156 bufmax = buffer + max_bytes - 1;
1157
1158 while (bufptr > bufmax)
1159 {
1160 if (*bufptr & 0x80)
1161 {
1162 while ((*bufptr & 0xc0) == 0x80 && bufptr > buffer)
1163 bufptr --;
1164 }
1165
1166 bufptr --;
1167 }
1168
1169 *bufptr = '\0';
1170 }
1171
1172 /*
1173 * Add the formatted string and return...
1174 */
1175
1176 return (ippAddString(ipp, group, value_tag, name, language, buffer));
1177}
1178
1179
ef416fc2 1180/*
a2326b5b 1181 * 'ippAddStrings()' - Add language-encoded strings to an IPP message.
ef416fc2 1182 *
a469f8a5
MS
1183 * The @code ipp@ parameter refers to an IPP message previously created using
1184 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
1185 *
1186 * The @code group@ parameter specifies the IPP attribute group tag: none
1187 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
1188 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
1189 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
1190 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
1191 *
1192 * Supported string values include charset (@code IPP_TAG_CHARSET@), keyword
1193 * (@code IPP_TAG_KEYWORD@), language (@code IPP_TAG_LANGUAGE@), mimeMediaType
1194 * (@code IPP_TAG_MIMETYPE@), name (@code IPP_TAG_NAME@), nameWithLanguage
1195 * (@code IPP_TAG_NAMELANG), text (@code IPP_TAG_TEXT@), textWithLanguage
1196 * (@code IPP_TAG_TEXTLANG@), uri (@code IPP_TAG_URI@), and uriScheme
1197 * (@code IPP_TAG_URISCHEME@).
1198 *
1199 * The @code language@ parameter must be non-@code NULL@ for nameWithLanguage and
1200 * textWithLanguage string values and must be @code NULL@ for all other string values.
ef416fc2 1201 */
1202
a2326b5b
MS
1203ipp_attribute_t * /* O - New attribute */
1204ippAddStrings(
1205 ipp_t *ipp, /* I - IPP message */
1206 ipp_tag_t group, /* I - IPP group */
1207 ipp_tag_t value_tag, /* I - Type of attribute */
1208 const char *name, /* I - Name of attribute */
1209 int num_values, /* I - Number of values */
1210 const char *language, /* I - Language code (@code NULL@ for default) */
1211 const char * const *values) /* I - Values */
ef416fc2 1212{
a2326b5b
MS
1213 int i; /* Looping var */
1214 ipp_tag_t temp_tag; /* Temporary value tag (masked) */
1215 ipp_attribute_t *attr; /* New attribute */
1216 _ipp_value_t *value; /* Current value */
1217 char code[32]; /* Language/charset value buffer */
ef416fc2 1218
1219
807315e6 1220 DEBUG_printf(("ippAddStrings(ipp=%p, group=%02x(%s), value_tag=%02x(%s), name=\"%s\", num_values=%d, language=\"%s\", values=%p)", (void *)ipp, group, ippTagString(group), value_tag, ippTagString(value_tag), name, num_values, language, (void *)values));
1ff0402e 1221
ef416fc2 1222 /*
a2326b5b 1223 * Range check input...
ef416fc2 1224 */
1225
cb7f98ee 1226 temp_tag = (ipp_tag_t)((int)value_tag & IPP_TAG_CUPS_MASK);
ef416fc2 1227
a2326b5b
MS
1228#if 0
1229 if (!ipp || !name || group < IPP_TAG_ZERO ||
1230 group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE ||
1231 (temp_tag < IPP_TAG_TEXT && temp_tag != IPP_TAG_TEXTLANG &&
1232 temp_tag != IPP_TAG_NAMELANG) || temp_tag > IPP_TAG_MIMETYPE ||
1233 num_values < 1)
1234 return (NULL);
ef416fc2 1235
a2326b5b
MS
1236 if ((temp_tag == IPP_TAG_TEXTLANG || temp_tag == IPP_TAG_NAMELANG)
1237 != (language != NULL))
1238 return (NULL);
1239#else
1240 if (!ipp || !name || group < IPP_TAG_ZERO ||
1241 group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE ||
1242 num_values < 1)
1243 return (NULL);
1244#endif /* 0 */
ef416fc2 1245
a2326b5b
MS
1246 /*
1247 * See if we need to map charset, language, or locale values...
1248 */
ef416fc2 1249
cb7f98ee 1250 if (language && ((int)value_tag & IPP_TAG_CUPS_CONST) &&
a2326b5b
MS
1251 strcmp(language, ipp_lang_code(language, code, sizeof(code))))
1252 value_tag = temp_tag; /* Don't do a fast copy */
cb7f98ee 1253 else if (values && value_tag == (ipp_tag_t)(IPP_TAG_CHARSET | IPP_TAG_CUPS_CONST))
a2326b5b
MS
1254 {
1255 for (i = 0; i < num_values; i ++)
1256 if (strcmp(values[i], ipp_get_code(values[i], code, sizeof(code))))
1257 {
1258 value_tag = temp_tag; /* Don't do a fast copy */
1259 break;
1260 }
1261 }
cb7f98ee 1262 else if (values && value_tag == (ipp_tag_t)(IPP_TAG_LANGUAGE | IPP_TAG_CUPS_CONST))
a2326b5b
MS
1263 {
1264 for (i = 0; i < num_values; i ++)
1265 if (strcmp(values[i], ipp_lang_code(values[i], code, sizeof(code))))
1266 {
1267 value_tag = temp_tag; /* Don't do a fast copy */
1268 break;
1269 }
ef416fc2 1270 }
ef416fc2 1271
a2326b5b
MS
1272 /*
1273 * Create the attribute...
1274 */
ef416fc2 1275
a2326b5b 1276 if ((attr = ipp_add_attr(ipp, name, group, value_tag, num_values)) == NULL)
ef416fc2 1277 return (NULL);
1278
1279 /*
a2326b5b 1280 * Initialize the attribute data...
ef416fc2 1281 */
1282
a2326b5b
MS
1283 for (i = num_values, value = attr->values;
1284 i > 0;
1285 i --, value ++)
1286 {
1287 if (language)
1288 {
1289 if (value == attr->values)
1290 {
cb7f98ee 1291 if ((int)value_tag & IPP_TAG_CUPS_CONST)
a2326b5b
MS
1292 value->string.language = (char *)language;
1293 else
1294 value->string.language = _cupsStrAlloc(ipp_lang_code(language, code,
1295 sizeof(code)));
1296 }
1297 else
1298 value->string.language = attr->values[0].string.language;
1299 }
ef416fc2 1300
a2326b5b
MS
1301 if (values)
1302 {
cb7f98ee 1303 if ((int)value_tag & IPP_TAG_CUPS_CONST)
a2326b5b
MS
1304 value->string.text = (char *)*values++;
1305 else if (value_tag == IPP_TAG_CHARSET)
1306 value->string.text = _cupsStrAlloc(ipp_get_code(*values++, code, sizeof(code)));
1307 else if (value_tag == IPP_TAG_LANGUAGE)
1308 value->string.text = _cupsStrAlloc(ipp_lang_code(*values++, code, sizeof(code)));
1309 else
1310 value->string.text = _cupsStrAlloc(*values++);
1311 }
1312 }
ef416fc2 1313
a2326b5b 1314 return (attr);
ef416fc2 1315}
1316
1317
a469f8a5
MS
1318/*
1319 * 'ippContainsInteger()' - Determine whether an attribute contains the
1320 * specified value or is within the list of ranges.
1321 *
1322 * Returns non-zero when the attribute contains either a matching integer or
1323 * enum value, or the value falls within one of the rangeOfInteger values for
1324 * the attribute.
1325 *
8072030b 1326 * @since CUPS 1.7/macOS 10.9@
a469f8a5
MS
1327 */
1328
1329int /* O - 1 on a match, 0 on no match */
1330ippContainsInteger(
1331 ipp_attribute_t *attr, /* I - Attribute */
1332 int value) /* I - Integer/enum value */
1333{
1334 int i; /* Looping var */
1335 _ipp_value_t *avalue; /* Current attribute value */
1336
1337
1338 /*
1339 * Range check input...
1340 */
1341
1342 if (!attr)
1343 return (0);
1344
1345 if (attr->value_tag != IPP_TAG_INTEGER && attr->value_tag != IPP_TAG_ENUM &&
1346 attr->value_tag != IPP_TAG_RANGE)
1347 return (0);
1348
1349 /*
1350 * Compare...
1351 */
1352
1353 if (attr->value_tag == IPP_TAG_RANGE)
1354 {
1355 for (i = attr->num_values, avalue = attr->values; i > 0; i --, avalue ++)
1356 if (value >= avalue->range.lower && value <= avalue->range.upper)
1357 return (1);
1358 }
1359 else
1360 {
1361 for (i = attr->num_values, avalue = attr->values; i > 0; i --, avalue ++)
1362 if (value == avalue->integer)
1363 return (1);
1364 }
1365
1366 return (0);
1367}
1368
1369
1370/*
1371 * 'ippContainsString()' - Determine whether an attribute contains the
1372 * specified string value.
1373 *
1374 * Returns non-zero when the attribute contains a matching charset, keyword,
65bebeac 1375 * naturalLanguage, mimeMediaType, name, text, uri, or uriScheme value.
a469f8a5 1376 *
8072030b 1377 * @since CUPS 1.7/macOS 10.9@
a469f8a5
MS
1378 */
1379
1380int /* O - 1 on a match, 0 on no match */
1381ippContainsString(
1382 ipp_attribute_t *attr, /* I - Attribute */
1383 const char *value) /* I - String value */
1384{
1385 int i; /* Looping var */
1386 _ipp_value_t *avalue; /* Current attribute value */
1387
1388
807315e6 1389 DEBUG_printf(("ippContainsString(attr=%p, value=\"%s\")", (void *)attr, value));
a469f8a5
MS
1390
1391 /*
1392 * Range check input...
1393 */
1394
1395 if (!attr || !value)
1396 {
1397 DEBUG_puts("1ippContainsString: Returning 0 (bad input)");
1398 return (0);
1399 }
1400
1401 /*
1402 * Compare...
1403 */
1404
1405 DEBUG_printf(("1ippContainsString: attr %s, %s with %d values.",
1406 attr->name, ippTagString(attr->value_tag),
1407 attr->num_values));
1408
1409 switch (attr->value_tag & IPP_TAG_CUPS_MASK)
1410 {
1411 case IPP_TAG_CHARSET :
1412 case IPP_TAG_KEYWORD :
1413 case IPP_TAG_LANGUAGE :
a268a6c9
MS
1414 case IPP_TAG_URI :
1415 case IPP_TAG_URISCHEME :
1416 for (i = attr->num_values, avalue = attr->values;
1417 i > 0;
1418 i --, avalue ++)
1419 {
1420 DEBUG_printf(("1ippContainsString: value[%d]=\"%s\"",
1421 attr->num_values - i, avalue->string.text));
1422
1423 if (!strcmp(value, avalue->string.text))
1424 {
1425 DEBUG_puts("1ippContainsString: Returning 1 (match)");
1426 return (1);
1427 }
1428 }
1429
a469f8a5
MS
1430 case IPP_TAG_MIMETYPE :
1431 case IPP_TAG_NAME :
1432 case IPP_TAG_NAMELANG :
1433 case IPP_TAG_TEXT :
1434 case IPP_TAG_TEXTLANG :
a469f8a5
MS
1435 for (i = attr->num_values, avalue = attr->values;
1436 i > 0;
1437 i --, avalue ++)
1438 {
1439 DEBUG_printf(("1ippContainsString: value[%d]=\"%s\"",
1440 attr->num_values - i, avalue->string.text));
1441
a268a6c9 1442 if (!_cups_strcasecmp(value, avalue->string.text))
a469f8a5
MS
1443 {
1444 DEBUG_puts("1ippContainsString: Returning 1 (match)");
1445 return (1);
1446 }
1447 }
1448
1449 default :
1450 break;
1451 }
1452
1453 DEBUG_puts("1ippContainsString: Returning 0 (no match)");
1454
1455 return (0);
1456}
1457
1458
ef416fc2 1459/*
a2326b5b
MS
1460 * 'ippCopyAttribute()' - Copy an attribute.
1461 *
1462 * The specified attribute, @code attr@, is copied to the destination IPP message.
1463 * When @code quickcopy@ is non-zero, a "shallow" reference copy of the attribute is
1464 * created - this should only be done as long as the original source IPP message will
1465 * not be freed for the life of the destination.
1466 *
8072030b 1467 * @since CUPS 1.6/macOS 10.8@
ef416fc2 1468 */
1469
a2326b5b
MS
1470
1471ipp_attribute_t * /* O - New attribute */
1472ippCopyAttribute(
1473 ipp_t *dst, /* I - Destination IPP message */
1474 ipp_attribute_t *srcattr, /* I - Attribute to copy */
1475 int quickcopy) /* I - 1 for a referenced copy, 0 for normal */
ef416fc2 1476{
a2326b5b 1477 int i; /* Looping var */
ebcccc6a 1478 ipp_tag_t srctag; /* Source value tag */
a2326b5b
MS
1479 ipp_attribute_t *dstattr; /* Destination attribute */
1480 _ipp_value_t *srcval, /* Source value */
1481 *dstval; /* Destination value */
ef416fc2 1482
1483
807315e6 1484 DEBUG_printf(("ippCopyAttribute(dst=%p, srcattr=%p, quickcopy=%d)", (void *)dst, (void *)srcattr, quickcopy));
ef416fc2 1485
a2326b5b
MS
1486 /*
1487 * Range check input...
1488 */
1489
1490 if (!dst || !srcattr)
ef416fc2 1491 return (NULL);
1492
a2326b5b
MS
1493 /*
1494 * Copy it...
1495 */
ef416fc2 1496
ebcccc6a
MS
1497 quickcopy = (quickcopy && (srcattr->value_tag & IPP_TAG_CUPS_CONST)) ? IPP_TAG_CUPS_CONST : 0;
1498 srctag = srcattr->value_tag & IPP_TAG_CUPS_MASK;
a2326b5b 1499
ebcccc6a 1500 switch (srctag)
ef416fc2 1501 {
a2326b5b
MS
1502 case IPP_TAG_ZERO :
1503 dstattr = ippAddSeparator(dst);
1504 break;
ef416fc2 1505
10f9350b
MS
1506 case IPP_TAG_UNSUPPORTED_VALUE :
1507 case IPP_TAG_DEFAULT :
1508 case IPP_TAG_UNKNOWN :
1509 case IPP_TAG_NOVALUE :
1510 case IPP_TAG_NOTSETTABLE :
1511 case IPP_TAG_DELETEATTR :
1512 case IPP_TAG_ADMINDEFINE :
ebcccc6a 1513 dstattr = ippAddOutOfBand(dst, srcattr->group_tag, srctag, srcattr->name);
10f9350b
MS
1514 break;
1515
a2326b5b
MS
1516 case IPP_TAG_INTEGER :
1517 case IPP_TAG_ENUM :
a2326b5b 1518 case IPP_TAG_BOOLEAN :
69c0af2e
MS
1519 case IPP_TAG_DATE :
1520 case IPP_TAG_RESOLUTION :
1521 case IPP_TAG_RANGE :
1522 if ((dstattr = ipp_add_attr(dst, srcattr->name, srcattr->group_tag, srctag, srcattr->num_values)) != NULL)
ebcccc6a 1523 memcpy(dstattr->values, srcattr->values, (size_t)srcattr->num_values * sizeof(_ipp_value_t));
a2326b5b 1524 break;
ef416fc2 1525
a2326b5b
MS
1526 case IPP_TAG_TEXT :
1527 case IPP_TAG_NAME :
ebcccc6a 1528 case IPP_TAG_RESERVED_STRING :
a2326b5b
MS
1529 case IPP_TAG_KEYWORD :
1530 case IPP_TAG_URI :
1531 case IPP_TAG_URISCHEME :
1532 case IPP_TAG_CHARSET :
1533 case IPP_TAG_LANGUAGE :
1534 case IPP_TAG_MIMETYPE :
ebcccc6a 1535 if ((dstattr = ippAddStrings(dst, srcattr->group_tag, (ipp_tag_t)(srctag | quickcopy), srcattr->name, srcattr->num_values, NULL, NULL)) == NULL)
a2326b5b 1536 break;
ef416fc2 1537
a2326b5b
MS
1538 if (quickcopy)
1539 {
ebcccc6a
MS
1540 /*
1541 * Can safely quick-copy these string values...
1542 */
1543
1544 memcpy(dstattr->values, srcattr->values, (size_t)srcattr->num_values * sizeof(_ipp_value_t));
a2326b5b 1545 }
a2326b5b
MS
1546 else
1547 {
ebcccc6a
MS
1548 /*
1549 * Otherwise do a normal reference counted copy...
1550 */
1551
1552 for (i = srcattr->num_values, srcval = srcattr->values, dstval = dstattr->values; i > 0; i --, srcval ++, dstval ++)
1553 dstval->string.text = _cupsStrAlloc(srcval->string.text);
a2326b5b
MS
1554 }
1555 break;
ef416fc2 1556
a2326b5b
MS
1557 case IPP_TAG_TEXTLANG :
1558 case IPP_TAG_NAMELANG :
ebcccc6a 1559 if ((dstattr = ippAddStrings(dst, srcattr->group_tag, (ipp_tag_t)(srctag | quickcopy), srcattr->name, srcattr->num_values, NULL, NULL)) == NULL)
a2326b5b 1560 break;
ef416fc2 1561
a2326b5b
MS
1562 if (quickcopy)
1563 {
ebcccc6a
MS
1564 /*
1565 * Can safely quick-copy these string values...
1566 */
1567
1568 memcpy(dstattr->values, srcattr->values, (size_t)srcattr->num_values * sizeof(_ipp_value_t));
a2326b5b 1569 }
cb7f98ee 1570 else if (srcattr->value_tag & IPP_TAG_CUPS_CONST)
a2326b5b 1571 {
ebcccc6a
MS
1572 /*
1573 * Otherwise do a normal reference counted copy...
1574 */
1575
1576 for (i = srcattr->num_values, srcval = srcattr->values, dstval = dstattr->values; i > 0; i --, srcval ++, dstval ++)
a2326b5b
MS
1577 {
1578 if (srcval == srcattr->values)
1579 dstval->string.language = _cupsStrAlloc(srcval->string.language);
1580 else
1581 dstval->string.language = dstattr->values[0].string.language;
ef416fc2 1582
a2326b5b
MS
1583 dstval->string.text = _cupsStrAlloc(srcval->string.text);
1584 }
1585 }
a2326b5b 1586 break;
ef416fc2 1587
a2326b5b 1588 case IPP_TAG_BEGIN_COLLECTION :
ebcccc6a 1589 if ((dstattr = ippAddCollections(dst, srcattr->group_tag, srcattr->name, srcattr->num_values, NULL)) == NULL)
a2326b5b
MS
1590 break;
1591
ebcccc6a 1592 for (i = srcattr->num_values, srcval = srcattr->values, dstval = dstattr->values; i > 0; i --, srcval ++, dstval ++)
a2326b5b
MS
1593 {
1594 dstval->collection = srcval->collection;
1595 srcval->collection->use ++;
1596 }
1597 break;
ef416fc2 1598
a2326b5b
MS
1599 case IPP_TAG_STRING :
1600 default :
ebcccc6a 1601 if ((dstattr = ipp_add_attr(dst, srcattr->name, srcattr->group_tag, srctag, srcattr->num_values)) == NULL)
a2326b5b
MS
1602 break;
1603
ebcccc6a 1604 for (i = srcattr->num_values, srcval = srcattr->values, dstval = dstattr->values; i > 0; i --, srcval ++, dstval ++)
a2326b5b
MS
1605 {
1606 dstval->unknown.length = srcval->unknown.length;
ef416fc2 1607
a2326b5b
MS
1608 if (dstval->unknown.length > 0)
1609 {
7e86f2f6 1610 if ((dstval->unknown.data = malloc((size_t)dstval->unknown.length)) == NULL)
a2326b5b
MS
1611 dstval->unknown.length = 0;
1612 else
07623986 1613 memcpy(dstval->unknown.data, srcval->unknown.data, (size_t)dstval->unknown.length);
a2326b5b
MS
1614 }
1615 }
1616 break; /* anti-compiler-warning-code */
ef416fc2 1617 }
1618
a2326b5b 1619 return (dstattr);
ef416fc2 1620}
1621
1622
1623/*
a2326b5b 1624 * 'ippCopyAttributes()' - Copy attributes from one IPP message to another.
ef416fc2 1625 *
58fce51f 1626 * Zero or more attributes are copied from the source IPP message, @code src@, to the
a2326b5b
MS
1627 * destination IPP message, @code dst@. When @code quickcopy@ is non-zero, a "shallow"
1628 * reference copy of the attribute is created - this should only be done as long as the
1629 * original source IPP message will not be freed for the life of the destination.
ef416fc2 1630 *
a2326b5b
MS
1631 * The @code cb@ and @code context@ parameters provide a generic way to "filter" the
1632 * attributes that are copied - the function must return 1 to copy the attribute or
1633 * 0 to skip it. The function may also choose to do a partial copy of the source attribute
1634 * itself.
1635 *
8072030b 1636 * @since CUPS 1.6/macOS 10.8@
ef416fc2 1637 */
1638
a2326b5b
MS
1639int /* O - 1 on success, 0 on error */
1640ippCopyAttributes(
1641 ipp_t *dst, /* I - Destination IPP message */
1642 ipp_t *src, /* I - Source IPP message */
1643 int quickcopy, /* I - 1 for a referenced copy, 0 for normal */
1644 ipp_copycb_t cb, /* I - Copy callback or @code NULL@ for none */
1645 void *context) /* I - Context pointer */
ef416fc2 1646{
a2326b5b 1647 ipp_attribute_t *srcattr; /* Source attribute */
ef416fc2 1648
1649
807315e6 1650 DEBUG_printf(("ippCopyAttributes(dst=%p, src=%p, quickcopy=%d, cb=%p, context=%p)", (void *)dst, (void *)src, quickcopy, (void *)cb, context));
1ff0402e 1651
ef416fc2 1652 /*
a2326b5b 1653 * Range check input...
ef416fc2 1654 */
1655
a2326b5b
MS
1656 if (!dst || !src)
1657 return (0);
ef416fc2 1658
1659 /*
a2326b5b 1660 * Loop through source attributes and copy as needed...
ef416fc2 1661 */
1662
a2326b5b
MS
1663 for (srcattr = src->attrs; srcattr; srcattr = srcattr->next)
1664 if (!cb || (*cb)(context, dst, srcattr))
1665 if (!ippCopyAttribute(dst, srcattr, quickcopy))
1666 return (0);
ef416fc2 1667
a2326b5b
MS
1668 return (1);
1669}
ef416fc2 1670
ef416fc2 1671
a2326b5b 1672/*
65bebeac
MS
1673 * 'ippDateToTime()' - Convert from RFC 2579 Date/Time format to time in
1674 * seconds.
a2326b5b 1675 */
ef416fc2 1676
a2326b5b 1677time_t /* O - UNIX time value */
65bebeac 1678ippDateToTime(const ipp_uchar_t *date) /* I - RFC 2579 date info */
a2326b5b
MS
1679{
1680 struct tm unixdate; /* UNIX date/time info */
1681 time_t t; /* Computed time */
ef416fc2 1682
a2326b5b
MS
1683
1684 if (!date)
1685 return (0);
1686
1687 memset(&unixdate, 0, sizeof(unixdate));
ef416fc2 1688
1689 /*
65bebeac 1690 * RFC-2579 date/time format is:
a2326b5b
MS
1691 *
1692 * Byte(s) Description
1693 * ------- -----------
1694 * 0-1 Year (0 to 65535)
1695 * 2 Month (1 to 12)
1696 * 3 Day (1 to 31)
1697 * 4 Hours (0 to 23)
1698 * 5 Minutes (0 to 59)
1699 * 6 Seconds (0 to 60, 60 = "leap second")
1700 * 7 Deciseconds (0 to 9)
1701 * 8 +/- UTC
1702 * 9 UTC hours (0 to 11)
1703 * 10 UTC minutes (0 to 59)
ef416fc2 1704 */
1705
a2326b5b
MS
1706 unixdate.tm_year = ((date[0] << 8) | date[1]) - 1900;
1707 unixdate.tm_mon = date[2] - 1;
1708 unixdate.tm_mday = date[3];
1709 unixdate.tm_hour = date[4];
1710 unixdate.tm_min = date[5];
1711 unixdate.tm_sec = date[6];
1712
1713 t = mktime(&unixdate);
1714
1715 if (date[8] == '-')
1716 t += date[9] * 3600 + date[10] * 60;
1717 else
1718 t -= date[9] * 3600 + date[10] * 60;
1719
1720 return (t);
ef416fc2 1721}
1722
1723
1724/*
a2326b5b 1725 * 'ippDelete()' - Delete an IPP message.
ef416fc2 1726 */
1727
a2326b5b
MS
1728void
1729ippDelete(ipp_t *ipp) /* I - IPP message */
ef416fc2 1730{
a2326b5b
MS
1731 ipp_attribute_t *attr, /* Current attribute */
1732 *next; /* Next attribute */
ef416fc2 1733
ef416fc2 1734
807315e6 1735 DEBUG_printf(("ippDelete(ipp=%p)", (void *)ipp));
ef416fc2 1736
a2326b5b
MS
1737 if (!ipp)
1738 return;
1739
1740 ipp->use --;
1741 if (ipp->use > 0)
b908d72c
MS
1742 {
1743 DEBUG_printf(("4debug_retain: %p IPP message (use=%d)", (void *)ipp, ipp->use));
a2326b5b 1744 return;
b908d72c
MS
1745 }
1746
1747 DEBUG_printf(("4debug_free: %p IPP message", (void *)ipp));
ef416fc2 1748
a2326b5b
MS
1749 for (attr = ipp->attrs; attr != NULL; attr = next)
1750 {
1751 next = attr->next;
ef416fc2 1752
b908d72c
MS
1753 DEBUG_printf(("4debug_free: %p %s %s%s (%d values)", (void *)attr, attr->name, attr->num_values > 1 ? "1setOf " : "", ippTagString(attr->value_tag), attr->num_values));
1754
a2326b5b 1755 ipp_free_values(attr, 0, attr->num_values);
ef416fc2 1756
a2326b5b
MS
1757 if (attr->name)
1758 _cupsStrFree(attr->name);
ef416fc2 1759
a2326b5b
MS
1760 free(attr);
1761 }
1762
1763 free(ipp);
ef416fc2 1764}
1765
1766
1767/*
a2326b5b 1768 * 'ippDeleteAttribute()' - Delete a single attribute in an IPP message.
ef416fc2 1769 *
8072030b 1770 * @since CUPS 1.1.19/macOS 10.3@
ef416fc2 1771 */
1772
a2326b5b
MS
1773void
1774ippDeleteAttribute(
1775 ipp_t *ipp, /* I - IPP message */
1776 ipp_attribute_t *attr) /* I - Attribute to delete */
ef416fc2 1777{
a2326b5b
MS
1778 ipp_attribute_t *current, /* Current attribute */
1779 *prev; /* Previous attribute */
ef416fc2 1780
1781
807315e6 1782 DEBUG_printf(("ippDeleteAttribute(ipp=%p, attr=%p(%s))", (void *)ipp, (void *)attr, attr ? attr->name : "(null)"));
ef416fc2 1783
a2326b5b
MS
1784 /*
1785 * Range check input...
1786 */
ef416fc2 1787
a2326b5b
MS
1788 if (!attr)
1789 return;
1f6f3dbc 1790
b908d72c
MS
1791 DEBUG_printf(("4debug_free: %p %s %s%s (%d values)", (void *)attr, attr->name, attr->num_values > 1 ? "1setOf " : "", ippTagString(attr->value_tag), attr->num_values));
1792
a2326b5b
MS
1793 /*
1794 * Find the attribute in the list...
1795 */
1796
1797 if (ipp)
ef416fc2 1798 {
a2326b5b
MS
1799 for (current = ipp->attrs, prev = NULL;
1800 current;
1801 prev = current, current = current->next)
1802 if (current == attr)
1803 {
1804 /*
1805 * Found it, remove the attribute from the list...
1806 */
ef416fc2 1807
a2326b5b
MS
1808 if (prev)
1809 prev->next = current->next;
1810 else
1811 ipp->attrs = current->next;
ef416fc2 1812
a2326b5b
MS
1813 if (current == ipp->last)
1814 ipp->last = prev;
ef416fc2 1815
a2326b5b
MS
1816 break;
1817 }
ef416fc2 1818
a2326b5b
MS
1819 if (!current)
1820 return;
1821 }
ef416fc2 1822
a2326b5b
MS
1823 /*
1824 * Free memory used by the attribute...
1825 */
ef416fc2 1826
a2326b5b 1827 ipp_free_values(attr, 0, attr->num_values);
ef416fc2 1828
a2326b5b
MS
1829 if (attr->name)
1830 _cupsStrFree(attr->name);
ef416fc2 1831
a2326b5b
MS
1832 free(attr);
1833}
ef416fc2 1834
b86bc4cf 1835
a2326b5b
MS
1836/*
1837 * 'ippDeleteValues()' - Delete values in an attribute.
1838 *
9c80ffa2
MS
1839 * The @code element@ parameter specifies the first value to delete, starting at
1840 * 0. It must be less than the number of values returned by @link ippGetCount@.
1841 *
1842 * The @code attr@ parameter may be modified as a result of setting the value.
a2326b5b
MS
1843 *
1844 * Deleting all values in an attribute deletes the attribute.
1845 *
8072030b 1846 * @since CUPS 1.6/macOS 10.8@
a2326b5b 1847 */
ef416fc2 1848
9c80ffa2 1849int /* O - 1 on success, 0 on failure */
a2326b5b 1850ippDeleteValues(
9c80ffa2
MS
1851 ipp_t *ipp, /* I - IPP message */
1852 ipp_attribute_t **attr, /* IO - Attribute */
1853 int element, /* I - Index of first value to delete (0-based) */
1854 int count) /* I - Number of values to delete */
a2326b5b
MS
1855{
1856 /*
1857 * Range check input...
1858 */
ef416fc2 1859
9c80ffa2
MS
1860 if (!ipp || !attr || !*attr ||
1861 element < 0 || element >= (*attr)->num_values || count <= 0 ||
1862 (element + count) >= (*attr)->num_values)
a2326b5b 1863 return (0);
ef416fc2 1864
a2326b5b
MS
1865 /*
1866 * If we are deleting all values, just delete the attribute entirely.
1867 */
ef416fc2 1868
9c80ffa2 1869 if (count == (*attr)->num_values)
a2326b5b 1870 {
9c80ffa2
MS
1871 ippDeleteAttribute(ipp, *attr);
1872 *attr = NULL;
a2326b5b
MS
1873 return (1);
1874 }
ef416fc2 1875
a2326b5b
MS
1876 /*
1877 * Otherwise free the values in question and return.
1878 */
ef416fc2 1879
9c80ffa2 1880 ipp_free_values(*attr, element, count);
a2326b5b
MS
1881
1882 return (1);
1883}
1884
1885
1886/*
9c80ffa2 1887 * 'ippFindAttribute()' - Find a named attribute in a request.
f2a31e21
MS
1888 *
1889 * Starting with CUPS 2.0, the attribute name can contain a hierarchical list
1890 * of attribute and member names separated by slashes, for example
1891 * "media-col/media-size".
a2326b5b
MS
1892 */
1893
1894ipp_attribute_t * /* O - Matching attribute */
1895ippFindAttribute(ipp_t *ipp, /* I - IPP message */
1896 const char *name, /* I - Name of attribute */
1897 ipp_tag_t type) /* I - Type of attribute */
1898{
807315e6 1899 DEBUG_printf(("2ippFindAttribute(ipp=%p, name=\"%s\", type=%02x(%s))", (void *)ipp, name, type, ippTagString(type)));
a2326b5b
MS
1900
1901 if (!ipp || !name)
1902 return (NULL);
1903
1904 /*
1905 * Reset the current pointer...
1906 */
1907
1908 ipp->current = NULL;
f2a31e21 1909 ipp->atend = 0;
a2326b5b
MS
1910
1911 /*
1912 * Search for the attribute...
1913 */
1914
1915 return (ippFindNextAttribute(ipp, name, type));
1916}
1917
1918
1919/*
9c80ffa2 1920 * 'ippFindNextAttribute()' - Find the next named attribute in a request.
f2a31e21
MS
1921 *
1922 * Starting with CUPS 2.0, the attribute name can contain a hierarchical list
1923 * of attribute and member names separated by slashes, for example
1924 * "media-col/media-size".
a2326b5b
MS
1925 */
1926
1927ipp_attribute_t * /* O - Matching attribute */
1928ippFindNextAttribute(ipp_t *ipp, /* I - IPP message */
1929 const char *name, /* I - Name of attribute */
1930 ipp_tag_t type) /* I - Type of attribute */
1931{
f2a31e21
MS
1932 ipp_attribute_t *attr, /* Current atttribute */
1933 *childattr; /* Child attribute */
a2326b5b 1934 ipp_tag_t value_tag; /* Value tag */
f2a31e21 1935 char parent[1024], /* Parent attribute name */
770f94bc 1936 *child = NULL; /* Child attribute name */
a2326b5b
MS
1937
1938
807315e6 1939 DEBUG_printf(("2ippFindNextAttribute(ipp=%p, name=\"%s\", type=%02x(%s))", (void *)ipp, name, type, ippTagString(type)));
a2326b5b
MS
1940
1941 if (!ipp || !name)
1942 return (NULL);
1943
f2a31e21
MS
1944 DEBUG_printf(("3ippFindNextAttribute: atend=%d", ipp->atend));
1945
1946 if (ipp->atend)
1947 return (NULL);
1948
1949 if (strchr(name, '/'))
1950 {
1951 /*
1952 * Search for child attribute...
1953 */
1954
1955 strlcpy(parent, name, sizeof(parent));
1956 if ((child = strchr(parent, '/')) == NULL)
1957 {
1958 DEBUG_puts("3ippFindNextAttribute: Attribute name too long.");
1959 return (NULL);
1960 }
1961
1962 *child++ = '\0';
1963
1964 if (ipp->current && ipp->current->name && ipp->current->value_tag == IPP_TAG_BEGIN_COLLECTION && !strcmp(parent, ipp->current->name))
1965 {
1966 while (ipp->curindex < ipp->current->num_values)
1967 {
1968 if ((childattr = ippFindNextAttribute(ipp->current->values[ipp->curindex].collection, child, type)) != NULL)
1969 return (childattr);
1970
1971 ipp->curindex ++;
1972 if (ipp->curindex < ipp->current->num_values && ipp->current->values[ipp->curindex].collection)
1973 ipp->current->values[ipp->curindex].collection->current = NULL;
1974 }
1975
1976 ipp->prev = ipp->current;
1977 ipp->current = ipp->current->next;
1978 ipp->curindex = 0;
1979
1980 if (!ipp->current)
1981 {
1982 ipp->atend = 1;
1983 return (NULL);
1984 }
1985 }
1986
1987 if (!ipp->current)
1988 {
1989 ipp->prev = NULL;
1990 ipp->current = ipp->attrs;
1991 ipp->curindex = 0;
1992 }
1993
1994 name = parent;
1995 attr = ipp->current;
1996 }
1997 else if (ipp->current)
a2326b5b
MS
1998 {
1999 ipp->prev = ipp->current;
2000 attr = ipp->current->next;
2001 }
2002 else
2003 {
2004 ipp->prev = NULL;
2005 attr = ipp->attrs;
2006 }
2007
2008 for (; attr != NULL; ipp->prev = attr, attr = attr->next)
2009 {
807315e6 2010 DEBUG_printf(("4ippFindAttribute: attr=%p, name=\"%s\"", (void *)attr, attr->name));
a2326b5b 2011
cb7f98ee 2012 value_tag = (ipp_tag_t)(attr->value_tag & IPP_TAG_CUPS_MASK);
a2326b5b
MS
2013
2014 if (attr->name != NULL && _cups_strcasecmp(attr->name, name) == 0 &&
f2a31e21 2015 (value_tag == type || type == IPP_TAG_ZERO || name == parent ||
a2326b5b
MS
2016 (value_tag == IPP_TAG_TEXTLANG && type == IPP_TAG_TEXT) ||
2017 (value_tag == IPP_TAG_NAMELANG && type == IPP_TAG_NAME)))
2018 {
2019 ipp->current = attr;
2020
f2a31e21
MS
2021 if (name == parent && attr->value_tag == IPP_TAG_BEGIN_COLLECTION)
2022 {
2023 int i; /* Looping var */
2024
2025 for (i = 0; i < attr->num_values; i ++)
2026 {
2027 if ((childattr = ippFindAttribute(attr->values[i].collection, child, type)) != NULL)
2028 {
2029 attr->values[0].collection->curindex = i;
2030 return (childattr);
2031 }
2032 }
2033 }
2034 else
2035 return (attr);
a2326b5b
MS
2036 }
2037 }
2038
2039 ipp->current = NULL;
2040 ipp->prev = NULL;
f2a31e21 2041 ipp->atend = 1;
a2326b5b
MS
2042
2043 return (NULL);
2044}
2045
2046
2047/*
2048 * 'ippFirstAttribute()' - Return the first attribute in the message.
2049 *
8072030b 2050 * @since CUPS 1.6/macOS 10.8@
a2326b5b
MS
2051 */
2052
2053ipp_attribute_t * /* O - First attribute or @code NULL@ if none */
2054ippFirstAttribute(ipp_t *ipp) /* I - IPP message */
2055{
2056 /*
2057 * Range check input...
2058 */
2059
2060 if (!ipp)
2061 return (NULL);
2062
2063 /*
2064 * Return the first attribute...
2065 */
2066
2067 return (ipp->current = ipp->attrs);
2068}
2069
2070
2071/*
2072 * 'ippGetBoolean()' - Get a boolean value for an attribute.
2073 *
2074 * The @code element@ parameter specifies which value to get from 0 to
65bebeac 2075 * @code ippGetCount(attr)@ - 1.
a2326b5b 2076 *
8072030b 2077 * @since CUPS 1.6/macOS 10.8@
a2326b5b
MS
2078 */
2079
c52d341f 2080int /* O - Boolean value or 0 on error */
a2326b5b
MS
2081ippGetBoolean(ipp_attribute_t *attr, /* I - IPP attribute */
2082 int element) /* I - Value number (0-based) */
2083{
2084 /*
2085 * Range check input...
2086 */
2087
2088 if (!attr || attr->value_tag != IPP_TAG_BOOLEAN ||
2089 element < 0 || element >= attr->num_values)
c52d341f 2090 return (0);
a2326b5b
MS
2091
2092 /*
2093 * Return the value...
2094 */
2095
2096 return (attr->values[element].boolean);
2097}
2098
2099
2100/*
2101 * 'ippGetCollection()' - Get a collection value for an attribute.
2102 *
2103 * The @code element@ parameter specifies which value to get from 0 to
65bebeac 2104 * @code ippGetCount(attr)@ - 1.
a2326b5b 2105 *
8072030b 2106 * @since CUPS 1.6/macOS 10.8@
a2326b5b
MS
2107 */
2108
2109ipp_t * /* O - Collection value or @code NULL@ on error */
2110ippGetCollection(
2111 ipp_attribute_t *attr, /* I - IPP attribute */
2112 int element) /* I - Value number (0-based) */
2113{
2114 /*
2115 * Range check input...
2116 */
2117
2118 if (!attr || attr->value_tag != IPP_TAG_BEGIN_COLLECTION ||
2119 element < 0 || element >= attr->num_values)
2120 return (NULL);
2121
2122 /*
2123 * Return the value...
2124 */
2125
2126 return (attr->values[element].collection);
2127}
2128
2129
2130/*
2131 * 'ippGetCount()' - Get the number of values in an attribute.
2132 *
8072030b 2133 * @since CUPS 1.6/macOS 10.8@
a2326b5b
MS
2134 */
2135
c52d341f 2136int /* O - Number of values or 0 on error */
a2326b5b
MS
2137ippGetCount(ipp_attribute_t *attr) /* I - IPP attribute */
2138{
2139 /*
2140 * Range check input...
2141 */
2142
2143 if (!attr)
c52d341f 2144 return (0);
a2326b5b
MS
2145
2146 /*
2147 * Return the number of values...
2148 */
2149
2150 return (attr->num_values);
2151}
2152
2153
9c80ffa2 2154/*
65bebeac 2155 * 'ippGetDate()' - Get a dateTime value for an attribute.
9c80ffa2
MS
2156 *
2157 * The @code element@ parameter specifies which value to get from 0 to
65bebeac 2158 * @code ippGetCount(attr)@ - 1.
9c80ffa2 2159 *
8072030b 2160 * @since CUPS 1.6/macOS 10.8@
9c80ffa2
MS
2161 */
2162
65bebeac 2163const ipp_uchar_t * /* O - dateTime value or @code NULL@ */
9c80ffa2
MS
2164ippGetDate(ipp_attribute_t *attr, /* I - IPP attribute */
2165 int element) /* I - Value number (0-based) */
2166{
2167 /*
2168 * Range check input...
2169 */
2170
2171 if (!attr || attr->value_tag != IPP_TAG_DATE ||
2172 element < 0 || element >= attr->num_values)
2173 return (NULL);
2174
2175 /*
2176 * Return the value...
2177 */
2178
2179 return (attr->values[element].date);
2180}
2181
2182
a2326b5b
MS
2183/*
2184 * 'ippGetGroupTag()' - Get the group associated with an attribute.
2185 *
8072030b 2186 * @since CUPS 1.6/macOS 10.8@
a2326b5b
MS
2187 */
2188
2189ipp_tag_t /* O - Group tag or @code IPP_TAG_ZERO@ on error */
2190ippGetGroupTag(ipp_attribute_t *attr) /* I - IPP attribute */
2191{
2192 /*
2193 * Range check input...
2194 */
2195
2196 if (!attr)
2197 return (IPP_TAG_ZERO);
2198
2199 /*
2200 * Return the group...
2201 */
2202
2203 return (attr->group_tag);
2204}
2205
2206
2207/*
2208 * 'ippGetInteger()' - Get the integer/enum value for an attribute.
2209 *
2210 * The @code element@ parameter specifies which value to get from 0 to
65bebeac 2211 * @code ippGetCount(attr)@ - 1.
a2326b5b 2212 *
8072030b 2213 * @since CUPS 1.6/macOS 10.8@
a2326b5b
MS
2214 */
2215
c52d341f 2216int /* O - Value or 0 on error */
a2326b5b
MS
2217ippGetInteger(ipp_attribute_t *attr, /* I - IPP attribute */
2218 int element) /* I - Value number (0-based) */
2219{
2220 /*
2221 * Range check input...
2222 */
2223
2224 if (!attr || (attr->value_tag != IPP_TAG_INTEGER && attr->value_tag != IPP_TAG_ENUM) ||
2225 element < 0 || element >= attr->num_values)
c52d341f 2226 return (0);
a2326b5b
MS
2227
2228 /*
2229 * Return the value...
2230 */
2231
2232 return (attr->values[element].integer);
2233}
2234
2235
2236/*
2237 * 'ippGetName()' - Get the attribute name.
2238 *
8072030b 2239 * @since CUPS 1.6/macOS 10.8@
a2326b5b
MS
2240 */
2241
2242const char * /* O - Attribute name or @code NULL@ for separators */
2243ippGetName(ipp_attribute_t *attr) /* I - IPP attribute */
2244{
2245 /*
2246 * Range check input...
2247 */
2248
2249 if (!attr)
2250 return (NULL);
2251
2252 /*
2253 * Return the name...
2254 */
2255
2256 return (attr->name);
2257}
2258
2259
6961465f
MS
2260/*
2261 * 'ippGetOctetString()' - Get an octetString value from an IPP attribute.
2262 *
2263 * The @code element@ parameter specifies which value to get from 0 to
65bebeac 2264 * @code ippGetCount(attr)@ - 1.
6961465f 2265 *
8072030b 2266 * @since CUPS 1.7/macOS 10.9@
6961465f
MS
2267 */
2268
2269void * /* O - Pointer to octetString data */
2270ippGetOctetString(
2271 ipp_attribute_t *attr, /* I - IPP attribute */
2272 int element, /* I - Value number (0-based) */
2273 int *datalen) /* O - Length of octetString data */
2274{
2275 /*
2276 * Range check input...
2277 */
2278
2279 if (!attr || attr->value_tag != IPP_TAG_STRING ||
2280 element < 0 || element >= attr->num_values)
2281 {
2282 if (datalen)
2283 *datalen = 0;
2284
2285 return (NULL);
2286 }
2287
2288 /*
2289 * Return the values...
2290 */
2291
2292 if (datalen)
2293 *datalen = attr->values[element].unknown.length;
2294
2295 return (attr->values[element].unknown.data);
2296}
2297
2298
a2326b5b
MS
2299/*
2300 * 'ippGetOperation()' - Get the operation ID in an IPP message.
2301 *
8072030b 2302 * @since CUPS 1.6/macOS 10.8@
a2326b5b
MS
2303 */
2304
c52d341f 2305ipp_op_t /* O - Operation ID or 0 on error */
a2326b5b
MS
2306ippGetOperation(ipp_t *ipp) /* I - IPP request message */
2307{
2308 /*
2309 * Range check input...
2310 */
2311
2312 if (!ipp)
c52d341f 2313 return ((ipp_op_t)0);
a2326b5b
MS
2314
2315 /*
2316 * Return the value...
2317 */
2318
2319 return (ipp->request.op.operation_id);
2320}
2321
2322
9c80ffa2
MS
2323/*
2324 * 'ippGetRange()' - Get a rangeOfInteger value from an attribute.
2325 *
2326 * The @code element@ parameter specifies which value to get from 0 to
65bebeac 2327 * @code ippGetCount(attr)@ - 1.
9c80ffa2 2328 *
8072030b 2329 * @since CUPS 1.6/macOS 10.8@
9c80ffa2
MS
2330 */
2331
c52d341f 2332int /* O - Lower value of range or 0 */
9c80ffa2
MS
2333ippGetRange(ipp_attribute_t *attr, /* I - IPP attribute */
2334 int element, /* I - Value number (0-based) */
2335 int *uppervalue)/* O - Upper value of range */
2336{
2337 /*
2338 * Range check input...
2339 */
2340
2341 if (!attr || attr->value_tag != IPP_TAG_RANGE ||
2342 element < 0 || element >= attr->num_values)
2343 {
2344 if (uppervalue)
c52d341f 2345 *uppervalue = 0;
9c80ffa2 2346
c52d341f 2347 return (0);
9c80ffa2
MS
2348 }
2349
2350 /*
2351 * Return the values...
2352 */
2353
2354 if (uppervalue)
2355 *uppervalue = attr->values[element].range.upper;
2356
2357 return (attr->values[element].range.lower);
2358}
2359
2360
a2326b5b
MS
2361/*
2362 * 'ippGetRequestId()' - Get the request ID from an IPP message.
2363 *
8072030b 2364 * @since CUPS 1.6/macOS 10.8@
a2326b5b
MS
2365 */
2366
c52d341f 2367int /* O - Request ID or 0 on error */
a2326b5b
MS
2368ippGetRequestId(ipp_t *ipp) /* I - IPP message */
2369{
2370 /*
2371 * Range check input...
2372 */
2373
2374 if (!ipp)
c52d341f 2375 return (0);
a2326b5b
MS
2376
2377 /*
2378 * Return the request ID...
2379 */
2380
2381 return (ipp->request.any.request_id);
2382}
2383
2384
2385/*
2386 * 'ippGetResolution()' - Get a resolution value for an attribute.
2387 *
2388 * The @code element@ parameter specifies which value to get from 0 to
65bebeac 2389 * @code ippGetCount(attr)@ - 1.
a2326b5b 2390 *
8072030b 2391 * @since CUPS 1.6/macOS 10.8@
a2326b5b
MS
2392 */
2393
c52d341f 2394int /* O - Horizontal/cross feed resolution or 0 */
a2326b5b
MS
2395ippGetResolution(
2396 ipp_attribute_t *attr, /* I - IPP attribute */
2397 int element, /* I - Value number (0-based) */
2398 int *yres, /* O - Vertical/feed resolution */
2399 ipp_res_t *units) /* O - Units for resolution */
2400{
2401 /*
2402 * Range check input...
2403 */
2404
2405 if (!attr || attr->value_tag != IPP_TAG_RESOLUTION ||
2406 element < 0 || element >= attr->num_values)
c52d341f
MS
2407 {
2408 if (yres)
2409 *yres = 0;
2410
2411 if (units)
2412 *units = (ipp_res_t)0;
2413
2414 return (0);
2415 }
a2326b5b
MS
2416
2417 /*
2418 * Return the value...
2419 */
2420
2421 if (yres)
2422 *yres = attr->values[element].resolution.yres;
2423
2424 if (units)
2425 *units = attr->values[element].resolution.units;
2426
2427 return (attr->values[element].resolution.xres);
2428}
2429
2430
9c80ffa2
MS
2431/*
2432 * 'ippGetState()' - Get the IPP message state.
2433 *
8072030b 2434 * @since CUPS 1.6/macOS 10.8@
9c80ffa2
MS
2435 */
2436
2437ipp_state_t /* O - IPP message state value */
2438ippGetState(ipp_t *ipp) /* I - IPP message */
2439{
2440 /*
2441 * Range check input...
2442 */
2443
2444 if (!ipp)
cb7f98ee 2445 return (IPP_STATE_IDLE);
9c80ffa2
MS
2446
2447 /*
2448 * Return the value...
2449 */
2450
2451 return (ipp->state);
2452}
2453
2454
a2326b5b
MS
2455/*
2456 * 'ippGetStatusCode()' - Get the status code from an IPP response or event message.
2457 *
8072030b 2458 * @since CUPS 1.6/macOS 10.8@
a2326b5b
MS
2459 */
2460
2461ipp_status_t /* O - Status code in IPP message */
2462ippGetStatusCode(ipp_t *ipp) /* I - IPP response or event message */
2463{
2464 /*
2465 * Range check input...
2466 */
2467
2468 if (!ipp)
cb7f98ee 2469 return (IPP_STATUS_ERROR_INTERNAL);
a2326b5b
MS
2470
2471 /*
2472 * Return the value...
2473 */
2474
2475 return (ipp->request.status.status_code);
2476}
2477
2478
2479/*
2480 * 'ippGetString()' - Get the string and optionally the language code for an attribute.
2481 *
2482 * The @code element@ parameter specifies which value to get from 0 to
65bebeac 2483 * @code ippGetCount(attr)@ - 1.
a2326b5b 2484 *
8072030b 2485 * @since CUPS 1.6/macOS 10.8@
a2326b5b
MS
2486 */
2487
2488const char *
2489ippGetString(ipp_attribute_t *attr, /* I - IPP attribute */
2490 int element, /* I - Value number (0-based) */
2491 const char **language)/* O - Language code (@code NULL@ for don't care) */
2492{
45eb1e5e
MS
2493 ipp_tag_t tag; /* Value tag */
2494
2495
a2326b5b
MS
2496 /*
2497 * Range check input...
2498 */
2499
45eb1e5e
MS
2500 tag = ippGetValueTag(attr);
2501
2502 if (!attr || element < 0 || element >= attr->num_values || (tag != IPP_TAG_TEXTLANG && tag != IPP_TAG_NAMELANG && (tag < IPP_TAG_TEXT || tag > IPP_TAG_MIMETYPE)))
a2326b5b
MS
2503 return (NULL);
2504
2505 /*
2506 * Return the value...
2507 */
2508
2509 if (language)
2510 *language = attr->values[element].string.language;
2511
2512 return (attr->values[element].string.text);
2513}
2514
2515
2516/*
2517 * 'ippGetValueTag()' - Get the value tag for an attribute.
2518 *
8072030b 2519 * @since CUPS 1.6/macOS 10.8@
a2326b5b
MS
2520 */
2521
2522ipp_tag_t /* O - Value tag or @code IPP_TAG_ZERO@ on error */
2523ippGetValueTag(ipp_attribute_t *attr) /* I - IPP attribute */
2524{
2525 /*
2526 * Range check input...
2527 */
2528
2529 if (!attr)
2530 return (IPP_TAG_ZERO);
2531
2532 /*
2533 * Return the value...
2534 */
2535
cb7f98ee 2536 return (attr->value_tag & IPP_TAG_CUPS_MASK);
a2326b5b
MS
2537}
2538
2539
2540/*
2541 * 'ippGetVersion()' - Get the major and minor version number from an IPP message.
2542 *
8072030b 2543 * @since CUPS 1.6/macOS 10.8@
a2326b5b
MS
2544 */
2545
c52d341f 2546int /* O - Major version number or 0 on error */
a2326b5b 2547ippGetVersion(ipp_t *ipp, /* I - IPP message */
65bebeac 2548 int *minor) /* O - Minor version number or @code NULL@ for don't care */
a2326b5b
MS
2549{
2550 /*
2551 * Range check input...
2552 */
2553
2554 if (!ipp)
2555 {
2556 if (minor)
c52d341f 2557 *minor = 0;
a2326b5b 2558
c52d341f 2559 return (0);
a2326b5b
MS
2560 }
2561
2562 /*
2563 * Return the value...
2564 */
2565
2566 if (minor)
2567 *minor = ipp->request.any.version[1];
2568
2569 return (ipp->request.any.version[0]);
2570}
2571
2572
2573/*
2574 * 'ippLength()' - Compute the length of an IPP message.
2575 */
2576
2577size_t /* O - Size of IPP message */
2578ippLength(ipp_t *ipp) /* I - IPP message */
2579{
2580 return (ipp_length(ipp, 0));
2581}
2582
2583
2584/*
2585 * 'ippNextAttribute()' - Return the next attribute in the message.
2586 *
8072030b 2587 * @since CUPS 1.6/macOS 10.8@
a2326b5b
MS
2588 */
2589
2590ipp_attribute_t * /* O - Next attribute or @code NULL@ if none */
2591ippNextAttribute(ipp_t *ipp) /* I - IPP message */
2592{
2593 /*
2594 * Range check input...
2595 */
2596
2597 if (!ipp || !ipp->current)
2598 return (NULL);
2599
2600 /*
2601 * Return the next attribute...
2602 */
2603
2604 return (ipp->current = ipp->current->next);
2605}
2606
2607
2608/*
2609 * 'ippNew()' - Allocate a new IPP message.
2610 */
2611
2612ipp_t * /* O - New IPP message */
2613ippNew(void)
2614{
0cb67df3
MS
2615 ipp_t *temp; /* New IPP message */
2616 _cups_globals_t *cg = _cupsGlobals();
2617 /* Global data */
a2326b5b
MS
2618
2619
2620 DEBUG_puts("ippNew()");
2621
2622 if ((temp = (ipp_t *)calloc(1, sizeof(ipp_t))) != NULL)
2623 {
2624 /*
0cb67df3 2625 * Set default version - usually 2.0...
a2326b5b
MS
2626 */
2627
b908d72c
MS
2628 DEBUG_printf(("4debug_alloc: %p IPP message", (void *)temp));
2629
567f49cb
MS
2630 if (cg->server_version == 0)
2631 _cupsSetDefaults();
2632
7e86f2f6
MS
2633 temp->request.any.version[0] = (ipp_uchar_t)(cg->server_version / 10);
2634 temp->request.any.version[1] = (ipp_uchar_t)(cg->server_version % 10);
a2326b5b
MS
2635 temp->use = 1;
2636 }
2637
807315e6 2638 DEBUG_printf(("1ippNew: Returning %p", (void *)temp));
a2326b5b
MS
2639
2640 return (temp);
2641}
2642
2643
2644/*
2645 * 'ippNewRequest()' - Allocate a new IPP request message.
2646 *
65bebeac
MS
2647 * The new request message is initialized with the "attributes-charset" and
2648 * "attributes-natural-language" attributes added. The
2649 * "attributes-natural-language" value is derived from the current locale.
a2326b5b 2650 *
8072030b 2651 * @since CUPS 1.2/macOS 10.5@
a2326b5b
MS
2652 */
2653
2654ipp_t * /* O - IPP request message */
2655ippNewRequest(ipp_op_t op) /* I - Operation code */
2656{
2657 ipp_t *request; /* IPP request message */
2658 cups_lang_t *language; /* Current language localization */
2659 static int request_id = 0; /* Current request ID */
2660 static _cups_mutex_t request_mutex = _CUPS_MUTEX_INITIALIZER;
2661 /* Mutex for request ID */
2662
2663
2664 DEBUG_printf(("ippNewRequest(op=%02x(%s))", op, ippOpString(op)));
2665
2666 /*
2667 * Create a new IPP message...
2668 */
2669
2670 if ((request = ippNew()) == NULL)
2671 return (NULL);
2672
2673 /*
2674 * Set the operation and request ID...
2675 */
2676
2677 _cupsMutexLock(&request_mutex);
2678
2679 request->request.op.operation_id = op;
2680 request->request.op.request_id = ++request_id;
2681
2682 _cupsMutexUnlock(&request_mutex);
2683
2684 /*
2685 * Use UTF-8 as the character set...
2686 */
2687
2688 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_CHARSET,
2689 "attributes-charset", NULL, "utf-8");
2690
2691 /*
2692 * Get the language from the current locale...
2693 */
2694
2695 language = cupsLangDefault();
2696
2697 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_LANGUAGE,
2698 "attributes-natural-language", NULL, language->language);
2699
2700 /*
2701 * Return the new request...
2702 */
2703
2704 return (request);
2705}
2706
2707
a469f8a5
MS
2708/*
2709 * 'ippNewResponse()' - Allocate a new IPP response message.
2710 *
65bebeac
MS
2711 * The new response message is initialized with the same "version-number",
2712 * "request-id", "attributes-charset", and "attributes-natural-language" as the
2713 * provided request message. If the "attributes-charset" or
2714 * "attributes-natural-language" attributes are missing from the request,
2715 * 'utf-8' and a value derived from the current locale are substituted,
a469f8a5
MS
2716 * respectively.
2717 *
8072030b 2718 * @since CUPS 1.7/macOS 10.9@
a469f8a5
MS
2719 */
2720
2721ipp_t * /* O - IPP response message */
2722ippNewResponse(ipp_t *request) /* I - IPP request message */
2723{
2724 ipp_t *response; /* IPP response message */
2725 ipp_attribute_t *attr; /* Current attribute */
2726
2727
2728 /*
2729 * Range check input...
2730 */
2731
2732 if (!request)
2733 return (NULL);
2734
2735 /*
2736 * Create a new IPP message...
2737 */
2738
2739 if ((response = ippNew()) == NULL)
2740 return (NULL);
2741
2742 /*
2743 * Copy the request values over to the response...
2744 */
2745
2746 response->request.status.version[0] = request->request.op.version[0];
2747 response->request.status.version[1] = request->request.op.version[1];
2748 response->request.status.request_id = request->request.op.request_id;
2749
2750 /*
2751 * The first attribute MUST be attributes-charset...
2752 */
2753
2754 attr = request->attrs;
2755
2756 if (attr && attr->name && !strcmp(attr->name, "attributes-charset") &&
2757 attr->group_tag == IPP_TAG_OPERATION &&
2758 attr->value_tag == IPP_TAG_CHARSET &&
2759 attr->num_values == 1)
2760 {
2761 /*
2762 * Copy charset from request...
2763 */
2764
2765 ippAddString(response, IPP_TAG_OPERATION, IPP_TAG_CHARSET,
2766 "attributes-charset", NULL, attr->values[0].string.text);
2767 }
2768 else
2769 {
2770 /*
2771 * Use "utf-8" as the default...
2772 */
2773
2774 ippAddString(response, IPP_TAG_OPERATION, IPP_TAG_CHARSET,
2775 "attributes-charset", NULL, "utf-8");
2776 }
2777
2778 /*
2779 * Then attributes-natural-language...
2780 */
2781
2782 if (attr)
2783 attr = attr->next;
2784
2785 if (attr && attr->name &&
2786 !strcmp(attr->name, "attributes-natural-language") &&
2787 attr->group_tag == IPP_TAG_OPERATION &&
2788 attr->value_tag == IPP_TAG_LANGUAGE &&
2789 attr->num_values == 1)
2790 {
2791 /*
2792 * Copy language from request...
2793 */
2794
2795 ippAddString(response, IPP_TAG_OPERATION, IPP_TAG_LANGUAGE,
2796 "attributes-natural-language", NULL,
2797 attr->values[0].string.text);
2798 }
2799 else
2800 {
2801 /*
2802 * Use the language from the current locale...
2803 */
2804
2805 cups_lang_t *language = cupsLangDefault();
2806 /* Current locale */
2807
2808 ippAddString(response, IPP_TAG_OPERATION, IPP_TAG_LANGUAGE,
2809 "attributes-natural-language", NULL, language->language);
2810 }
2811
2812 return (response);
2813}
2814
2815
a2326b5b
MS
2816/*
2817 * 'ippRead()' - Read data for an IPP message from a HTTP connection.
2818 */
2819
2820ipp_state_t /* O - Current state */
2821ippRead(http_t *http, /* I - HTTP connection */
2822 ipp_t *ipp) /* I - IPP data */
2823{
807315e6 2824 DEBUG_printf(("ippRead(http=%p, ipp=%p), data_remaining=" CUPS_LLFMT, (void *)http, (void *)ipp, CUPS_LLCAST (http ? http->data_remaining : -1)));
a2326b5b
MS
2825
2826 if (!http)
cb7f98ee 2827 return (IPP_STATE_ERROR);
a2326b5b 2828
807315e6 2829 DEBUG_printf(("2ippRead: http->state=%d, http->used=%d", http->state, http->used));
a2326b5b
MS
2830
2831 return (ippReadIO(http, (ipp_iocb_t)ipp_read_http, http->blocking, NULL,
2832 ipp));
2833}
2834
2835
2836/*
2837 * 'ippReadFile()' - Read data for an IPP message from a file.
2838 *
8072030b 2839 * @since CUPS 1.1.19/macOS 10.3@
a2326b5b
MS
2840 */
2841
2842ipp_state_t /* O - Current state */
2843ippReadFile(int fd, /* I - HTTP data */
2844 ipp_t *ipp) /* I - IPP data */
2845{
807315e6 2846 DEBUG_printf(("ippReadFile(fd=%d, ipp=%p)", fd, (void *)ipp));
a2326b5b
MS
2847
2848 return (ippReadIO(&fd, (ipp_iocb_t)ipp_read_file, 1, NULL, ipp));
2849}
2850
2851
2852/*
2853 * 'ippReadIO()' - Read data for an IPP message.
2854 *
8072030b 2855 * @since CUPS 1.2/macOS 10.5@
a2326b5b
MS
2856 */
2857
2858ipp_state_t /* O - Current state */
2859ippReadIO(void *src, /* I - Data source */
2860 ipp_iocb_t cb, /* I - Read callback function */
2861 int blocking, /* I - Use blocking IO? */
2862 ipp_t *parent, /* I - Parent request, if any */
2863 ipp_t *ipp) /* I - IPP data */
2864{
2865 int n; /* Length of data */
2866 unsigned char *buffer, /* Data buffer */
5a9febac 2867 string[IPP_MAX_TEXT],
a2326b5b 2868 /* Small string buffer */
6918883f 2869 *bufptr, /* Pointer into buffer */
064e50fb 2870 *bufend; /* End of buffer */
a2326b5b
MS
2871 ipp_attribute_t *attr; /* Current attribute */
2872 ipp_tag_t tag; /* Current tag */
2873 ipp_tag_t value_tag; /* Current value tag */
2874 _ipp_value_t *value; /* Current value */
2875
2876
807315e6 2877 DEBUG_printf(("ippReadIO(src=%p, cb=%p, blocking=%d, parent=%p, ipp=%p)", (void *)src, (void *)cb, blocking, (void *)parent, (void *)ipp));
cb7f98ee 2878 DEBUG_printf(("2ippReadIO: ipp->state=%d", ipp ? ipp->state : IPP_STATE_ERROR));
a2326b5b
MS
2879
2880 if (!src || !ipp)
cb7f98ee 2881 return (IPP_STATE_ERROR);
a2326b5b 2882
dcb445bc 2883 if ((buffer = (unsigned char *)_cupsBufferGet(IPP_BUF_SIZE)) == NULL)
a2326b5b
MS
2884 {
2885 DEBUG_puts("1ippReadIO: Unable to get read buffer.");
cb7f98ee 2886 return (IPP_STATE_ERROR);
a2326b5b
MS
2887 }
2888
2889 switch (ipp->state)
2890 {
cb7f98ee 2891 case IPP_STATE_IDLE :
a2326b5b
MS
2892 ipp->state ++; /* Avoid common problem... */
2893
cb7f98ee 2894 case IPP_STATE_HEADER :
a2326b5b
MS
2895 if (parent == NULL)
2896 {
2897 /*
2898 * Get the request header...
2899 */
2900
2901 if ((*cb)(src, buffer, 8) < 8)
2902 {
2903 DEBUG_puts("1ippReadIO: Unable to read header.");
dcb445bc 2904 _cupsBufferRelease((char *)buffer);
cb7f98ee 2905 return (IPP_STATE_ERROR);
a2326b5b
MS
2906 }
2907
2908 /*
2909 * Then copy the request header over...
2910 */
2911
2912 ipp->request.any.version[0] = buffer[0];
2913 ipp->request.any.version[1] = buffer[1];
2914 ipp->request.any.op_status = (buffer[2] << 8) | buffer[3];
2915 ipp->request.any.request_id = (((((buffer[4] << 8) | buffer[5]) << 8) |
2916 buffer[6]) << 8) | buffer[7];
2917
2918 DEBUG_printf(("2ippReadIO: version=%d.%d", buffer[0], buffer[1]));
2919 DEBUG_printf(("2ippReadIO: op_status=%04x",
2920 ipp->request.any.op_status));
2921 DEBUG_printf(("2ippReadIO: request_id=%d",
2922 ipp->request.any.request_id));
2923 }
2924
cb7f98ee 2925 ipp->state = IPP_STATE_ATTRIBUTE;
a2326b5b
MS
2926 ipp->current = NULL;
2927 ipp->curtag = IPP_TAG_ZERO;
2928 ipp->prev = ipp->last;
2929
2930 /*
2931 * If blocking is disabled, stop here...
2932 */
2933
2934 if (!blocking)
2935 break;
2936
cb7f98ee 2937 case IPP_STATE_ATTRIBUTE :
a2326b5b
MS
2938 for (;;)
2939 {
2940 if ((*cb)(src, buffer, 1) < 1)
2941 {
2942 DEBUG_puts("1ippReadIO: Callback returned EOF/error");
dcb445bc 2943 _cupsBufferRelease((char *)buffer);
cb7f98ee 2944 return (IPP_STATE_ERROR);
a2326b5b
MS
2945 }
2946
807315e6 2947 DEBUG_printf(("2ippReadIO: ipp->current=%p, ipp->prev=%p", (void *)ipp->current, (void *)ipp->prev));
a2326b5b
MS
2948
2949 /*
2950 * Read this attribute...
2951 */
2952
2953 tag = (ipp_tag_t)buffer[0];
2954 if (tag == IPP_TAG_EXTENSION)
2955 {
2956 /*
2957 * Read 32-bit "extension" tag...
2958 */
2959
82e3ee0e 2960 if ((*cb)(src, buffer, 4) < 4)
a2326b5b
MS
2961 {
2962 DEBUG_puts("1ippReadIO: Callback returned EOF/error");
dcb445bc 2963 _cupsBufferRelease((char *)buffer);
cb7f98ee 2964 return (IPP_STATE_ERROR);
a2326b5b
MS
2965 }
2966
2967 tag = (ipp_tag_t)((((((buffer[0] << 8) | buffer[1]) << 8) |
2968 buffer[2]) << 8) | buffer[3]);
2969
cb7f98ee 2970 if (tag & IPP_TAG_CUPS_CONST)
a2326b5b
MS
2971 {
2972 /*
2973 * Fail if the high bit is set in the tag...
2974 */
2975
cb7f98ee 2976 _cupsSetError(IPP_STATUS_ERROR_INTERNAL, _("IPP extension tag larger than 0x7FFFFFFF."), 1);
a29fd7dd 2977 DEBUG_printf(("1ippReadIO: bad tag 0x%x.", tag));
dcb445bc 2978 _cupsBufferRelease((char *)buffer);
cb7f98ee 2979 return (IPP_STATE_ERROR);
a2326b5b
MS
2980 }
2981 }
2982
2983 if (tag == IPP_TAG_END)
2984 {
2985 /*
2986 * No more attributes left...
2987 */
2988
2989 DEBUG_puts("2ippReadIO: IPP_TAG_END.");
2990
cb7f98ee 2991 ipp->state = IPP_STATE_DATA;
a2326b5b
MS
2992 break;
2993 }
8eed4387
MS
2994 else if (tag == IPP_TAG_ZERO || (tag == IPP_TAG_OPERATION && ipp->curtag != IPP_TAG_ZERO))
2995 {
2996 _cupsSetError(IPP_STATUS_ERROR_INTERNAL, _("Invalid group tag."), 1);
2997 DEBUG_printf(("1ippReadIO: bad tag 0x%02x.", tag));
2998 _cupsBufferRelease((char *)buffer);
2999 return (IPP_STATE_ERROR);
3000 }
a2326b5b
MS
3001 else if (tag < IPP_TAG_UNSUPPORTED_VALUE)
3002 {
3003 /*
3004 * Group tag... Set the current group and continue...
3005 */
3006
3007 if (ipp->curtag == tag)
3008 ipp->prev = ippAddSeparator(ipp);
3009 else if (ipp->current)
3010 ipp->prev = ipp->current;
ef416fc2 3011
3012 ipp->curtag = tag;
3013 ipp->current = NULL;
807315e6 3014 DEBUG_printf(("2ippReadIO: group tag=%x(%s), ipp->prev=%p", tag, ippTagString(tag), (void *)ipp->prev));
ef416fc2 3015 continue;
3016 }
3017
a2326b5b
MS
3018 DEBUG_printf(("2ippReadIO: value tag=%x(%s)", tag,
3019 ippTagString(tag)));
3020
3021 /*
3022 * Get the name...
3023 */
3024
3025 if ((*cb)(src, buffer, 2) < 2)
3026 {
3027 DEBUG_puts("1ippReadIO: unable to read name length.");
dcb445bc 3028 _cupsBufferRelease((char *)buffer);
cb7f98ee 3029 return (IPP_STATE_ERROR);
a2326b5b
MS
3030 }
3031
3032 n = (buffer[0] << 8) | buffer[1];
3033
3034 if (n >= IPP_BUF_SIZE)
3035 {
cb7f98ee 3036 _cupsSetError(IPP_STATUS_ERROR_INTERNAL, _("IPP name larger than 32767 bytes."), 1);
a2326b5b 3037 DEBUG_printf(("1ippReadIO: bad name length %d.", n));
dcb445bc 3038 _cupsBufferRelease((char *)buffer);
cb7f98ee 3039 return (IPP_STATE_ERROR);
a2326b5b
MS
3040 }
3041
3042 DEBUG_printf(("2ippReadIO: name length=%d", n));
3043
5754bcce
MS
3044 if (n && parent)
3045 {
3046 _cupsSetError(IPP_STATUS_ERROR_INTERNAL, _("Invalid named IPP attribute in collection."), 1);
3047 DEBUG_puts("1ippReadIO: bad attribute name in collection.");
3048 return (IPP_STATE_ERROR);
3049 }
3050 else if (n == 0 && tag != IPP_TAG_MEMBERNAME && tag != IPP_TAG_END_COLLECTION)
a2326b5b
MS
3051 {
3052 /*
3053 * More values for current attribute...
3054 */
3055
3056 if (ipp->current == NULL)
3057 {
cb7f98ee 3058 _cupsSetError(IPP_STATUS_ERROR_INTERNAL, _("IPP attribute has no name."), 1);
a2326b5b 3059 DEBUG_puts("1ippReadIO: Attribute without name and no current.");
dcb445bc 3060 _cupsBufferRelease((char *)buffer);
cb7f98ee 3061 return (IPP_STATE_ERROR);
a2326b5b
MS
3062 }
3063
3064 attr = ipp->current;
cb7f98ee 3065 value_tag = (ipp_tag_t)(attr->value_tag & IPP_TAG_CUPS_MASK);
a2326b5b
MS
3066
3067 /*
3068 * Make sure we aren't adding a new value of a different
3069 * type...
3070 */
3071
3072 if (value_tag == IPP_TAG_ZERO)
3073 {
3074 /*
3075 * Setting the value of a collection member...
3076 */
3077
3078 attr->value_tag = tag;
3079 }
3080 else if (value_tag == IPP_TAG_TEXTLANG ||
3081 value_tag == IPP_TAG_NAMELANG ||
3082 (value_tag >= IPP_TAG_TEXT &&
3083 value_tag <= IPP_TAG_MIMETYPE))
3084 {
3085 /*
3086 * String values can sometimes come across in different
3087 * forms; accept sets of differing values...
3088 */
3089
3090 if (tag != IPP_TAG_TEXTLANG && tag != IPP_TAG_NAMELANG &&
3091 (tag < IPP_TAG_TEXT || tag > IPP_TAG_MIMETYPE) &&
3092 tag != IPP_TAG_NOVALUE)
3093 {
cb7f98ee 3094 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
a2326b5b
MS
3095 _("IPP 1setOf attribute with incompatible value "
3096 "tags."), 1);
3097 DEBUG_printf(("1ippReadIO: 1setOf value tag %x(%s) != %x(%s)",
3098 value_tag, ippTagString(value_tag), tag,
3099 ippTagString(tag)));
dcb445bc 3100 _cupsBufferRelease((char *)buffer);
cb7f98ee 3101 return (IPP_STATE_ERROR);
a2326b5b
MS
3102 }
3103
3104 if (value_tag != tag)
3105 {
3106 DEBUG_printf(("1ippReadIO: Converting %s attribute from %s to %s.",
3107 attr->name, ippTagString(value_tag), ippTagString(tag)));
3108 ippSetValueTag(ipp, &attr, tag);
3109 }
3110 }
3111 else if (value_tag == IPP_TAG_INTEGER ||
3112 value_tag == IPP_TAG_RANGE)
3113 {
3114 /*
3115 * Integer and rangeOfInteger values can sometimes be mixed; accept
3116 * sets of differing values...
3117 */
3118
3119 if (tag != IPP_TAG_INTEGER && tag != IPP_TAG_RANGE)
3120 {
cb7f98ee 3121 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
a2326b5b
MS
3122 _("IPP 1setOf attribute with incompatible value "
3123 "tags."), 1);
3124 DEBUG_printf(("1ippReadIO: 1setOf value tag %x(%s) != %x(%s)",
3125 value_tag, ippTagString(value_tag), tag,
3126 ippTagString(tag)));
dcb445bc 3127 _cupsBufferRelease((char *)buffer);
cb7f98ee 3128 return (IPP_STATE_ERROR);
a2326b5b
MS
3129 }
3130
3131 if (value_tag == IPP_TAG_INTEGER && tag == IPP_TAG_RANGE)
3132 {
3133 /*
3134 * Convert integer values to rangeOfInteger values...
3135 */
3136
3137 DEBUG_printf(("1ippReadIO: Converting %s attribute to "
3138 "rangeOfInteger.", attr->name));
3139 ippSetValueTag(ipp, &attr, IPP_TAG_RANGE);
3140 }
3141 }
3142 else if (value_tag != tag)
3143 {
cb7f98ee 3144 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
a2326b5b
MS
3145 _("IPP 1setOf attribute with incompatible value "
3146 "tags."), 1);
3147 DEBUG_printf(("1ippReadIO: value tag %x(%s) != %x(%s)",
3148 value_tag, ippTagString(value_tag), tag,
3149 ippTagString(tag)));
dcb445bc 3150 _cupsBufferRelease((char *)buffer);
cb7f98ee 3151 return (IPP_STATE_ERROR);
a2326b5b
MS
3152 }
3153
3154 /*
3155 * Finally, reallocate the attribute array as needed...
3156 */
3157
3158 if ((value = ipp_set_value(ipp, &attr, attr->num_values)) == NULL)
3159 {
dcb445bc 3160 _cupsBufferRelease((char *)buffer);
cb7f98ee 3161 return (IPP_STATE_ERROR);
a2326b5b
MS
3162 }
3163 }
3164 else if (tag == IPP_TAG_MEMBERNAME)
3165 {
3166 /*
3167 * Name must be length 0!
3168 */
3169
3170 if (n)
3171 {
cb7f98ee 3172 _cupsSetError(IPP_STATUS_ERROR_INTERNAL, _("IPP member name is not empty."), 1);
a2326b5b 3173 DEBUG_puts("1ippReadIO: member name not empty.");
dcb445bc 3174 _cupsBufferRelease((char *)buffer);
cb7f98ee 3175 return (IPP_STATE_ERROR);
a2326b5b
MS
3176 }
3177
3178 if (ipp->current)
3179 ipp->prev = ipp->current;
3180
3181 attr = ipp->current = ipp_add_attr(ipp, NULL, ipp->curtag, IPP_TAG_ZERO, 1);
0fa6c7fa
MS
3182 if (!attr)
3183 {
cb7f98ee 3184 _cupsSetHTTPError(HTTP_STATUS_ERROR);
0fa6c7fa
MS
3185 DEBUG_puts("1ippReadIO: unable to allocate attribute.");
3186 _cupsBufferRelease((char *)buffer);
cb7f98ee 3187 return (IPP_STATE_ERROR);
0fa6c7fa 3188 }
a2326b5b 3189
807315e6 3190 DEBUG_printf(("2ippReadIO: membername, ipp->current=%p, ipp->prev=%p", (void *)ipp->current, (void *)ipp->prev));
a2326b5b 3191
9c80ffa2 3192 value = attr->values;
a2326b5b
MS
3193 }
3194 else if (tag != IPP_TAG_END_COLLECTION)
3195 {
3196 /*
3197 * New attribute; read the name and add it...
3198 */
3199
7e86f2f6 3200 if ((*cb)(src, buffer, (size_t)n) < n)
a2326b5b
MS
3201 {
3202 DEBUG_puts("1ippReadIO: unable to read name.");
dcb445bc 3203 _cupsBufferRelease((char *)buffer);
cb7f98ee 3204 return (IPP_STATE_ERROR);
a2326b5b
MS
3205 }
3206
3207 buffer[n] = '\0';
3208
3209 if (ipp->current)
3210 ipp->prev = ipp->current;
3211
3212 if ((attr = ipp->current = ipp_add_attr(ipp, (char *)buffer, ipp->curtag, tag,
3213 1)) == NULL)
3214 {
cb7f98ee 3215 _cupsSetHTTPError(HTTP_STATUS_ERROR);
a2326b5b 3216 DEBUG_puts("1ippReadIO: unable to allocate attribute.");
dcb445bc 3217 _cupsBufferRelease((char *)buffer);
cb7f98ee 3218 return (IPP_STATE_ERROR);
a2326b5b
MS
3219 }
3220
807315e6 3221 DEBUG_printf(("2ippReadIO: name=\"%s\", ipp->current=%p, ipp->prev=%p", buffer, (void *)ipp->current, (void *)ipp->prev));
a2326b5b 3222
9c80ffa2 3223 value = attr->values;
a2326b5b
MS
3224 }
3225 else
3226 {
3227 attr = NULL;
3228 value = NULL;
3229 }
3230
3231 if ((*cb)(src, buffer, 2) < 2)
3232 {
3233 DEBUG_puts("1ippReadIO: unable to read value length.");
dcb445bc 3234 _cupsBufferRelease((char *)buffer);
cb7f98ee 3235 return (IPP_STATE_ERROR);
a2326b5b
MS
3236 }
3237
3238 n = (buffer[0] << 8) | buffer[1];
3239 DEBUG_printf(("2ippReadIO: value length=%d", n));
3240
3241 if (n >= IPP_BUF_SIZE)
3242 {
cb7f98ee 3243 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
a2326b5b
MS
3244 _("IPP value larger than 32767 bytes."), 1);
3245 DEBUG_printf(("1ippReadIO: bad value length %d.", n));
dcb445bc 3246 _cupsBufferRelease((char *)buffer);
cb7f98ee 3247 return (IPP_STATE_ERROR);
a2326b5b
MS
3248 }
3249
3250 switch (tag)
3251 {
3252 case IPP_TAG_INTEGER :
3253 case IPP_TAG_ENUM :
3254 if (n != 4)
3255 {
3256 if (tag == IPP_TAG_INTEGER)
cb7f98ee 3257 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
a2326b5b
MS
3258 _("IPP integer value not 4 bytes."), 1);
3259 else
cb7f98ee 3260 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
a2326b5b 3261 _("IPP enum value not 4 bytes."), 1);
a29fd7dd 3262 DEBUG_printf(("1ippReadIO: bad integer value length %d.", n));
dcb445bc 3263 _cupsBufferRelease((char *)buffer);
cb7f98ee 3264 return (IPP_STATE_ERROR);
a2326b5b
MS
3265 }
3266
3267 if ((*cb)(src, buffer, 4) < 4)
3268 {
3269 DEBUG_puts("1ippReadIO: Unable to read integer value.");
dcb445bc 3270 _cupsBufferRelease((char *)buffer);
cb7f98ee 3271 return (IPP_STATE_ERROR);
a2326b5b
MS
3272 }
3273
3274 n = (((((buffer[0] << 8) | buffer[1]) << 8) | buffer[2]) << 8) |
3275 buffer[3];
3276
3277 if (attr->value_tag == IPP_TAG_RANGE)
3278 value->range.lower = value->range.upper = n;
3279 else
3280 value->integer = n;
3281 break;
3282
3283 case IPP_TAG_BOOLEAN :
3284 if (n != 1)
3285 {
cb7f98ee 3286 _cupsSetError(IPP_STATUS_ERROR_INTERNAL, _("IPP boolean value not 1 byte."),
a2326b5b 3287 1);
a29fd7dd 3288 DEBUG_printf(("1ippReadIO: bad boolean value length %d.", n));
dcb445bc 3289 _cupsBufferRelease((char *)buffer);
cb7f98ee 3290 return (IPP_STATE_ERROR);
a2326b5b
MS
3291 }
3292
3293 if ((*cb)(src, buffer, 1) < 1)
3294 {
3295 DEBUG_puts("1ippReadIO: Unable to read boolean value.");
dcb445bc 3296 _cupsBufferRelease((char *)buffer);
cb7f98ee 3297 return (IPP_STATE_ERROR);
a2326b5b
MS
3298 }
3299
7e86f2f6 3300 value->boolean = (char)buffer[0];
a2326b5b
MS
3301 break;
3302
22a3eea9
MS
3303 case IPP_TAG_UNSUPPORTED_VALUE :
3304 case IPP_TAG_DEFAULT :
3305 case IPP_TAG_UNKNOWN :
3306 case IPP_TAG_NOVALUE :
a2326b5b
MS
3307 case IPP_TAG_NOTSETTABLE :
3308 case IPP_TAG_DELETEATTR :
3309 case IPP_TAG_ADMINDEFINE :
3310 /*
3311 * These value types are not supposed to have values, however
3312 * some vendors (Brother) do not implement IPP correctly and so
3313 * we need to map non-empty values to text...
3314 */
3315
3316 if (attr->value_tag == tag)
3317 {
3318 if (n == 0)
3319 break;
3320
3321 attr->value_tag = IPP_TAG_TEXT;
3322 }
3323
3324 case IPP_TAG_TEXT :
3325 case IPP_TAG_NAME :
22a3eea9 3326 case IPP_TAG_RESERVED_STRING :
a2326b5b
MS
3327 case IPP_TAG_KEYWORD :
3328 case IPP_TAG_URI :
3329 case IPP_TAG_URISCHEME :
3330 case IPP_TAG_CHARSET :
3331 case IPP_TAG_LANGUAGE :
3332 case IPP_TAG_MIMETYPE :
a29fd7dd
MS
3333 if (n > 0)
3334 {
7e86f2f6 3335 if ((*cb)(src, buffer, (size_t)n) < n)
a29fd7dd
MS
3336 {
3337 DEBUG_puts("1ippReadIO: unable to read string value.");
3338 _cupsBufferRelease((char *)buffer);
cb7f98ee 3339 return (IPP_STATE_ERROR);
a29fd7dd 3340 }
a2326b5b
MS
3341 }
3342
3343 buffer[n] = '\0';
3344 value->string.text = _cupsStrAlloc((char *)buffer);
3345 DEBUG_printf(("2ippReadIO: value=\"%s\"", value->string.text));
3346 break;
3347
3348 case IPP_TAG_DATE :
3349 if (n != 11)
3350 {
cb7f98ee 3351 _cupsSetError(IPP_STATUS_ERROR_INTERNAL, _("IPP date value not 11 bytes."), 1);
a29fd7dd 3352 DEBUG_printf(("1ippReadIO: bad date value length %d.", n));
dcb445bc 3353 _cupsBufferRelease((char *)buffer);
cb7f98ee 3354 return (IPP_STATE_ERROR);
a2326b5b
MS
3355 }
3356
3357 if ((*cb)(src, value->date, 11) < 11)
3358 {
3359 DEBUG_puts("1ippReadIO: Unable to read date value.");
dcb445bc 3360 _cupsBufferRelease((char *)buffer);
cb7f98ee 3361 return (IPP_STATE_ERROR);
a2326b5b
MS
3362 }
3363 break;
3364
3365 case IPP_TAG_RESOLUTION :
3366 if (n != 9)
3367 {
cb7f98ee 3368 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
a2326b5b 3369 _("IPP resolution value not 9 bytes."), 1);
a29fd7dd 3370 DEBUG_printf(("1ippReadIO: bad resolution value length %d.", n));
dcb445bc 3371 _cupsBufferRelease((char *)buffer);
cb7f98ee 3372 return (IPP_STATE_ERROR);
a2326b5b
MS
3373 }
3374
3375 if ((*cb)(src, buffer, 9) < 9)
3376 {
3377 DEBUG_puts("1ippReadIO: Unable to read resolution value.");
dcb445bc 3378 _cupsBufferRelease((char *)buffer);
cb7f98ee 3379 return (IPP_STATE_ERROR);
a2326b5b
MS
3380 }
3381
3382 value->resolution.xres =
3383 (((((buffer[0] << 8) | buffer[1]) << 8) | buffer[2]) << 8) |
3384 buffer[3];
3385 value->resolution.yres =
3386 (((((buffer[4] << 8) | buffer[5]) << 8) | buffer[6]) << 8) |
3387 buffer[7];
3388 value->resolution.units =
3389 (ipp_res_t)buffer[8];
3390 break;
3391
3392 case IPP_TAG_RANGE :
3393 if (n != 8)
3394 {
cb7f98ee 3395 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
a2326b5b 3396 _("IPP rangeOfInteger value not 8 bytes."), 1);
a29fd7dd
MS
3397 DEBUG_printf(("1ippReadIO: bad rangeOfInteger value length "
3398 "%d.", n));
dcb445bc 3399 _cupsBufferRelease((char *)buffer);
cb7f98ee 3400 return (IPP_STATE_ERROR);
a2326b5b
MS
3401 }
3402
3403 if ((*cb)(src, buffer, 8) < 8)
3404 {
3405 DEBUG_puts("1ippReadIO: Unable to read range value.");
dcb445bc 3406 _cupsBufferRelease((char *)buffer);
cb7f98ee 3407 return (IPP_STATE_ERROR);
a2326b5b
MS
3408 }
3409
3410 value->range.lower =
3411 (((((buffer[0] << 8) | buffer[1]) << 8) | buffer[2]) << 8) |
3412 buffer[3];
3413 value->range.upper =
3414 (((((buffer[4] << 8) | buffer[5]) << 8) | buffer[6]) << 8) |
3415 buffer[7];
3416 break;
3417
3418 case IPP_TAG_TEXTLANG :
3419 case IPP_TAG_NAMELANG :
3420 if (n < 4)
3421 {
3422 if (tag == IPP_TAG_TEXTLANG)
cb7f98ee 3423 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
a2326b5b
MS
3424 _("IPP textWithLanguage value less than "
3425 "minimum 4 bytes."), 1);
3426 else
cb7f98ee 3427 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
a2326b5b
MS
3428 _("IPP nameWithLanguage value less than "
3429 "minimum 4 bytes."), 1);
a29fd7dd
MS
3430 DEBUG_printf(("1ippReadIO: bad stringWithLanguage value "
3431 "length %d.", n));
dcb445bc 3432 _cupsBufferRelease((char *)buffer);
cb7f98ee 3433 return (IPP_STATE_ERROR);
a2326b5b
MS
3434 }
3435
7e86f2f6 3436 if ((*cb)(src, buffer, (size_t)n) < n)
a2326b5b
MS
3437 {
3438 DEBUG_puts("1ippReadIO: Unable to read string w/language "
3439 "value.");
dcb445bc 3440 _cupsBufferRelease((char *)buffer);
cb7f98ee 3441 return (IPP_STATE_ERROR);
a2326b5b
MS
3442 }
3443
3444 bufptr = buffer;
064e50fb 3445 bufend = buffer + n;
6918883f 3446
a2326b5b
MS
3447
3448 /*
3449 * text-with-language and name-with-language are composite
3450 * values:
3451 *
3452 * language-length
3453 * language
3454 * text-length
3455 * text
3456 */
3457
3458 n = (bufptr[0] << 8) | bufptr[1];
3459
064e50fb 3460 if ((bufptr + 2 + n) >= bufend || n >= (int)sizeof(string))
a2326b5b 3461 {
cb7f98ee 3462 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
a2326b5b 3463 _("IPP language length overflows value."), 1);
a29fd7dd
MS
3464 DEBUG_printf(("1ippReadIO: bad language value length %d.",
3465 n));
dcb445bc 3466 _cupsBufferRelease((char *)buffer);
cb7f98ee 3467 return (IPP_STATE_ERROR);
a2326b5b 3468 }
5a9febac
MS
3469 else if (n >= IPP_MAX_LANGUAGE)
3470 {
cb7f98ee 3471 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
5a9febac
MS
3472 _("IPP language length too large."), 1);
3473 DEBUG_printf(("1ippReadIO: bad language value length %d.",
3474 n));
3475 _cupsBufferRelease((char *)buffer);
cb7f98ee 3476 return (IPP_STATE_ERROR);
5a9febac 3477 }
a2326b5b 3478
07623986 3479 memcpy(string, bufptr + 2, (size_t)n);
a2326b5b
MS
3480 string[n] = '\0';
3481
3482 value->string.language = _cupsStrAlloc((char *)string);
3483
064e50fb 3484 bufptr += 2 + n;
a2326b5b
MS
3485 n = (bufptr[0] << 8) | bufptr[1];
3486
064e50fb 3487 if ((bufptr + 2 + n) > bufend)
a2326b5b 3488 {
cb7f98ee 3489 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
a2326b5b 3490 _("IPP string length overflows value."), 1);
a29fd7dd 3491 DEBUG_printf(("1ippReadIO: bad string value length %d.", n));
dcb445bc 3492 _cupsBufferRelease((char *)buffer);
cb7f98ee 3493 return (IPP_STATE_ERROR);
a2326b5b
MS
3494 }
3495
3496 bufptr[2 + n] = '\0';
3497 value->string.text = _cupsStrAlloc((char *)bufptr + 2);
3498 break;
3499
3500 case IPP_TAG_BEGIN_COLLECTION :
3501 /*
3502 * Oh, boy, here comes a collection value, so read it...
3503 */
3504
3505 value->collection = ippNew();
3506
3507 if (n > 0)
3508 {
cb7f98ee 3509 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
a2326b5b
MS
3510 _("IPP begCollection value not 0 bytes."), 1);
3511 DEBUG_puts("1ippReadIO: begCollection tag with value length "
3512 "> 0.");
dcb445bc 3513 _cupsBufferRelease((char *)buffer);
cb7f98ee 3514 return (IPP_STATE_ERROR);
a2326b5b
MS
3515 }
3516
cb7f98ee 3517 if (ippReadIO(src, cb, 1, ipp, value->collection) == IPP_STATE_ERROR)
a2326b5b
MS
3518 {
3519 DEBUG_puts("1ippReadIO: Unable to read collection value.");
dcb445bc 3520 _cupsBufferRelease((char *)buffer);
cb7f98ee 3521 return (IPP_STATE_ERROR);
a2326b5b
MS
3522 }
3523 break;
3524
3525 case IPP_TAG_END_COLLECTION :
dcb445bc 3526 _cupsBufferRelease((char *)buffer);
a2326b5b
MS
3527
3528 if (n > 0)
3529 {
cb7f98ee 3530 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
a2326b5b
MS
3531 _("IPP endCollection value not 0 bytes."), 1);
3532 DEBUG_puts("1ippReadIO: endCollection tag with value length "
3533 "> 0.");
cb7f98ee 3534 return (IPP_STATE_ERROR);
a2326b5b
MS
3535 }
3536
3537 DEBUG_puts("1ippReadIO: endCollection tag...");
cb7f98ee 3538 return (ipp->state = IPP_STATE_DATA);
a2326b5b
MS
3539
3540 case IPP_TAG_MEMBERNAME :
3541 /*
3542 * The value the name of the member in the collection, which
3543 * we need to carry over...
3544 */
3545
5a9febac
MS
3546 if (!attr)
3547 {
cb7f98ee 3548 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
5a9febac
MS
3549 _("IPP memberName with no attribute."), 1);
3550 DEBUG_puts("1ippReadIO: Member name without attribute.");
3551 _cupsBufferRelease((char *)buffer);
cb7f98ee 3552 return (IPP_STATE_ERROR);
5a9febac
MS
3553 }
3554 else if (n == 0)
a29fd7dd 3555 {
cb7f98ee 3556 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
a29fd7dd
MS
3557 _("IPP memberName value is empty."), 1);
3558 DEBUG_puts("1ippReadIO: Empty member name value.");
3559 _cupsBufferRelease((char *)buffer);
cb7f98ee 3560 return (IPP_STATE_ERROR);
a29fd7dd 3561 }
7e86f2f6 3562 else if ((*cb)(src, buffer, (size_t)n) < n)
a2326b5b
MS
3563 {
3564 DEBUG_puts("1ippReadIO: Unable to read member name value.");
dcb445bc 3565 _cupsBufferRelease((char *)buffer);
cb7f98ee 3566 return (IPP_STATE_ERROR);
a2326b5b
MS
3567 }
3568
3569 buffer[n] = '\0';
3570 attr->name = _cupsStrAlloc((char *)buffer);
3571
3572 /*
3573 * Since collection members are encoded differently than
3574 * regular attributes, make sure we don't start with an
3575 * empty value...
3576 */
3577
3578 attr->num_values --;
3579
3580 DEBUG_printf(("2ippReadIO: member name=\"%s\"", attr->name));
3581 break;
3582
672c8127 3583 case IPP_TAG_STRING :
a2326b5b 3584 default : /* Other unsupported values */
a469f8a5 3585 if (tag == IPP_TAG_STRING && n > IPP_MAX_LENGTH)
5a9febac 3586 {
cb7f98ee 3587 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
5a9febac
MS
3588 _("IPP octetString length too large."), 1);
3589 DEBUG_printf(("1ippReadIO: bad octetString value length %d.",
3590 n));
3591 _cupsBufferRelease((char *)buffer);
cb7f98ee 3592 return (IPP_STATE_ERROR);
5a9febac
MS
3593 }
3594
a2326b5b 3595 value->unknown.length = n;
5a9febac 3596
a2326b5b
MS
3597 if (n > 0)
3598 {
7e86f2f6 3599 if ((value->unknown.data = malloc((size_t)n)) == NULL)
a2326b5b 3600 {
cb7f98ee 3601 _cupsSetHTTPError(HTTP_STATUS_ERROR);
a2326b5b 3602 DEBUG_puts("1ippReadIO: Unable to allocate value");
dcb445bc 3603 _cupsBufferRelease((char *)buffer);
cb7f98ee 3604 return (IPP_STATE_ERROR);
a2326b5b
MS
3605 }
3606
7e86f2f6 3607 if ((*cb)(src, value->unknown.data, (size_t)n) < n)
a2326b5b
MS
3608 {
3609 DEBUG_puts("1ippReadIO: Unable to read unsupported value.");
dcb445bc 3610 _cupsBufferRelease((char *)buffer);
cb7f98ee 3611 return (IPP_STATE_ERROR);
a2326b5b
MS
3612 }
3613 }
3614 else
3615 value->unknown.data = NULL;
3616 break;
3617 }
3618
a2326b5b
MS
3619 /*
3620 * If blocking is disabled, stop here...
ef416fc2 3621 */
3622
a2326b5b
MS
3623 if (!blocking)
3624 break;
3625 }
3626 break;
ef416fc2 3627
cb7f98ee 3628 case IPP_STATE_DATA :
a2326b5b 3629 break;
ef416fc2 3630
a2326b5b
MS
3631 default :
3632 break; /* anti-compiler-warning-code */
3633 }
ef416fc2 3634
a2326b5b 3635 DEBUG_printf(("1ippReadIO: returning ipp->state=%d.", ipp->state));
dcb445bc 3636 _cupsBufferRelease((char *)buffer);
ef416fc2 3637
a2326b5b
MS
3638 return (ipp->state);
3639}
ef416fc2 3640
ef416fc2 3641
a2326b5b
MS
3642/*
3643 * 'ippSetBoolean()' - Set a boolean value in an attribute.
3644 *
a469f8a5
MS
3645 * The @code ipp@ parameter refers to an IPP message previously created using
3646 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
3647 *
3648 * The @code attr@ parameter may be modified as a result of setting the value.
3649 *
3650 * The @code element@ parameter specifies which value to set from 0 to
65bebeac 3651 * @code ippGetCount(attr)@.
a2326b5b 3652 *
8072030b 3653 * @since CUPS 1.6/macOS 10.8@
a2326b5b 3654 */
ef416fc2 3655
a2326b5b 3656int /* O - 1 on success, 0 on failure */
6961465f 3657ippSetBoolean(ipp_t *ipp, /* I - IPP message */
a2326b5b
MS
3658 ipp_attribute_t **attr, /* IO - IPP attribute */
3659 int element, /* I - Value number (0-based) */
3660 int boolvalue)/* I - Boolean value */
3661{
3662 _ipp_value_t *value; /* Current value */
ef416fc2 3663
ef416fc2 3664
a2326b5b
MS
3665 /*
3666 * Range check input...
3667 */
ef416fc2 3668
a2326b5b
MS
3669 if (!ipp || !attr || !*attr || (*attr)->value_tag != IPP_TAG_BOOLEAN ||
3670 element < 0 || element > (*attr)->num_values)
3671 return (0);
83e08001 3672
a2326b5b
MS
3673 /*
3674 * Set the value and return...
3675 */
83e08001 3676
a2326b5b 3677 if ((value = ipp_set_value(ipp, attr, element)) != NULL)
7e86f2f6 3678 value->boolean = (char)boolvalue;
83e08001 3679
a2326b5b
MS
3680 return (value != NULL);
3681}
83e08001 3682
83e08001 3683
a2326b5b
MS
3684/*
3685 * 'ippSetCollection()' - Set a collection value in an attribute.
3686 *
a469f8a5
MS
3687 * The @code ipp@ parameter refers to an IPP message previously created using
3688 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
3689 *
3690 * The @code attr@ parameter may be modified as a result of setting the value.
3691 *
3692 * The @code element@ parameter specifies which value to set from 0 to
65bebeac 3693 * @code ippGetCount(attr)@.
a2326b5b 3694 *
8072030b 3695 * @since CUPS 1.6/macOS 10.8@
a2326b5b 3696 */
83e08001 3697
a2326b5b
MS
3698int /* O - 1 on success, 0 on failure */
3699ippSetCollection(
6961465f 3700 ipp_t *ipp, /* I - IPP message */
a2326b5b
MS
3701 ipp_attribute_t **attr, /* IO - IPP attribute */
3702 int element, /* I - Value number (0-based) */
3703 ipp_t *colvalue) /* I - Collection value */
3704{
3705 _ipp_value_t *value; /* Current value */
3706
3707
3708 /*
3709 * Range check input...
3710 */
3711
3712 if (!ipp || !attr || !*attr || (*attr)->value_tag != IPP_TAG_BEGIN_COLLECTION ||
3713 element < 0 || element > (*attr)->num_values || !colvalue)
3714 return (0);
3715
3716 /*
3717 * Set the value and return...
3718 */
3719
3720 if ((value = ipp_set_value(ipp, attr, element)) != NULL)
3721 {
3722 if (value->collection)
3723 ippDelete(value->collection);
3724
3725 value->collection = colvalue;
3726 colvalue->use ++;
3727 }
3728
3729 return (value != NULL);
3730}
3731
3732
9c80ffa2 3733/*
65bebeac 3734 * 'ippSetDate()' - Set a dateTime value in an attribute.
9c80ffa2 3735 *
a469f8a5
MS
3736 * The @code ipp@ parameter refers to an IPP message previously created using
3737 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
9c80ffa2
MS
3738 *
3739 * The @code attr@ parameter may be modified as a result of setting the value.
3740 *
3741 * The @code element@ parameter specifies which value to set from 0 to
65bebeac 3742 * @code ippGetCount(attr)@.
9c80ffa2 3743 *
8072030b 3744 * @since CUPS 1.6/macOS 10.8@
9c80ffa2
MS
3745 */
3746
3747int /* O - 1 on success, 0 on failure */
6961465f 3748ippSetDate(ipp_t *ipp, /* I - IPP message */
9c80ffa2
MS
3749 ipp_attribute_t **attr, /* IO - IPP attribute */
3750 int element, /* I - Value number (0-based) */
65bebeac 3751 const ipp_uchar_t *datevalue)/* I - dateTime value */
9c80ffa2
MS
3752{
3753 _ipp_value_t *value; /* Current value */
3754
3755
3756 /*
3757 * Range check input...
3758 */
3759
d7cd12f0 3760 if (!ipp || !attr || !*attr || ((*attr)->value_tag != IPP_TAG_DATE && (*attr)->value_tag != IPP_TAG_NOVALUE && (*attr)->value_tag != IPP_TAG_UNKNOWN) || element < 0 || element > (*attr)->num_values || !datevalue)
9c80ffa2
MS
3761 return (0);
3762
3763 /*
3764 * Set the value and return...
3765 */
3766
3767 if ((value = ipp_set_value(ipp, attr, element)) != NULL)
3768 memcpy(value->date, datevalue, sizeof(value->date));
3769
3770 return (value != NULL);
3771}
3772
3773
a2326b5b
MS
3774/*
3775 * 'ippSetGroupTag()' - Set the group tag of an attribute.
3776 *
a469f8a5
MS
3777 * The @code ipp@ parameter refers to an IPP message previously created using
3778 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
3779 *
3780 * The @code attr@ parameter may be modified as a result of setting the value.
3781 *
3782 * The @code group@ parameter specifies the IPP attribute group tag: none
3783 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
3784 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
3785 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
3786 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
3787 *
8072030b 3788 * @since CUPS 1.6/macOS 10.8@
a2326b5b
MS
3789 */
3790
3791int /* O - 1 on success, 0 on failure */
3792ippSetGroupTag(
6961465f 3793 ipp_t *ipp, /* I - IPP message */
a2326b5b
MS
3794 ipp_attribute_t **attr, /* IO - Attribute */
3795 ipp_tag_t group_tag) /* I - Group tag */
3796{
3797 /*
65bebeac 3798 * Range check input - group tag must be 0x01 to 0x0F, per RFC 8011...
a2326b5b
MS
3799 */
3800
a469f8a5
MS
3801 if (!ipp || !attr || !*attr ||
3802 group_tag < IPP_TAG_ZERO || group_tag == IPP_TAG_END ||
a2326b5b
MS
3803 group_tag >= IPP_TAG_UNSUPPORTED_VALUE)
3804 return (0);
3805
3806 /*
3807 * Set the group tag and return...
3808 */
3809
3810 (*attr)->group_tag = group_tag;
3811
3812 return (1);
3813}
3814
3815
3816/*
3817 * 'ippSetInteger()' - Set an integer or enum value in an attribute.
3818 *
a469f8a5
MS
3819 * The @code ipp@ parameter refers to an IPP message previously created using
3820 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
3821 *
3822 * The @code attr@ parameter may be modified as a result of setting the value.
3823 *
3824 * The @code element@ parameter specifies which value to set from 0 to
65bebeac 3825 * @code ippGetCount(attr)@.
a2326b5b 3826 *
8072030b 3827 * @since CUPS 1.6/macOS 10.8@
a2326b5b
MS
3828 */
3829
3830int /* O - 1 on success, 0 on failure */
6961465f 3831ippSetInteger(ipp_t *ipp, /* I - IPP message */
a2326b5b
MS
3832 ipp_attribute_t **attr, /* IO - IPP attribute */
3833 int element, /* I - Value number (0-based) */
3834 int intvalue) /* I - Integer/enum value */
3835{
3836 _ipp_value_t *value; /* Current value */
3837
3838
3839 /*
3840 * Range check input...
3841 */
3842
d7cd12f0 3843 if (!ipp || !attr || !*attr || ((*attr)->value_tag != IPP_TAG_INTEGER && (*attr)->value_tag != IPP_TAG_ENUM && (*attr)->value_tag != IPP_TAG_NOVALUE && (*attr)->value_tag != IPP_TAG_UNKNOWN) || element < 0 || element > (*attr)->num_values)
a2326b5b
MS
3844 return (0);
3845
3846 /*
3847 * Set the value and return...
3848 */
3849
3850 if ((value = ipp_set_value(ipp, attr, element)) != NULL)
d7cd12f0
MS
3851 {
3852 if ((*attr)->value_tag != IPP_TAG_ENUM)
3853 (*attr)->value_tag = IPP_TAG_INTEGER;
3854
a2326b5b 3855 value->integer = intvalue;
d7cd12f0 3856 }
a2326b5b
MS
3857
3858 return (value != NULL);
3859}
3860
3861
3862/*
3863 * 'ippSetName()' - Set the name of an attribute.
3864 *
a469f8a5
MS
3865 * The @code ipp@ parameter refers to an IPP message previously created using
3866 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
3867 *
3868 * The @code attr@ parameter may be modified as a result of setting the value.
3869 *
8072030b 3870 * @since CUPS 1.6/macOS 10.8@
a2326b5b
MS
3871 */
3872
3873int /* O - 1 on success, 0 on failure */
6961465f 3874ippSetName(ipp_t *ipp, /* I - IPP message */
a2326b5b
MS
3875 ipp_attribute_t **attr, /* IO - IPP attribute */
3876 const char *name) /* I - Attribute name */
3877{
3878 char *temp; /* Temporary name value */
3879
3880
3881 /*
3882 * Range check input...
3883 */
3884
3885 if (!ipp || !attr || !*attr)
3886 return (0);
ef416fc2 3887
a2326b5b
MS
3888 /*
3889 * Set the value and return...
3890 */
ef416fc2 3891
a2326b5b
MS
3892 if ((temp = _cupsStrAlloc(name)) != NULL)
3893 {
3894 if ((*attr)->name)
3895 _cupsStrFree((*attr)->name);
ef416fc2 3896
a2326b5b
MS
3897 (*attr)->name = temp;
3898 }
ef416fc2 3899
a2326b5b
MS
3900 return (temp != NULL);
3901}
ef416fc2 3902
ef416fc2 3903
6961465f
MS
3904/*
3905 * 'ippSetOctetString()' - Set an octetString value in an IPP attribute.
3906 *
3907 * The @code ipp@ parameter refers to an IPP message previously created using
3908 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
3909 *
3910 * The @code attr@ parameter may be modified as a result of setting the value.
3911 *
3912 * The @code element@ parameter specifies which value to set from 0 to
65bebeac 3913 * @code ippGetCount(attr)@.
6961465f 3914 *
8072030b 3915 * @since CUPS 1.7/macOS 10.9@
6961465f
MS
3916 */
3917
3918int /* O - 1 on success, 0 on failure */
3919ippSetOctetString(
3920 ipp_t *ipp, /* I - IPP message */
3921 ipp_attribute_t **attr, /* IO - IPP attribute */
3922 int element, /* I - Value number (0-based) */
3923 const void *data, /* I - Pointer to octetString data */
3924 int datalen) /* I - Length of octetString data */
3925{
3926 _ipp_value_t *value; /* Current value */
3927
3928
3929 /*
3930 * Range check input...
3931 */
3932
d7cd12f0 3933 if (!ipp || !attr || !*attr || ((*attr)->value_tag != IPP_TAG_STRING && (*attr)->value_tag != IPP_TAG_NOVALUE && (*attr)->value_tag != IPP_TAG_UNKNOWN) || element < 0 || element > (*attr)->num_values || datalen < 0 || datalen > IPP_MAX_LENGTH)
6961465f
MS
3934 return (0);
3935
3936 /*
3937 * Set the value and return...
3938 */
3939
3940 if ((value = ipp_set_value(ipp, attr, element)) != NULL)
3941 {
3942 if ((int)((*attr)->value_tag) & IPP_TAG_CUPS_CONST)
3943 {
3944 /*
3945 * Just copy the pointer...
3946 */
3947
3948 value->unknown.data = (void *)data;
3949 value->unknown.length = datalen;
3950 }
3951 else
3952 {
3953 /*
3954 * Copy the data...
3955 */
3956
d7cd12f0
MS
3957 (*attr)->value_tag = IPP_TAG_STRING;
3958
6961465f
MS
3959 if (value->unknown.data)
3960 {
3961 /*
3962 * Free previous data...
3963 */
3964
3965 free(value->unknown.data);
3966
3967 value->unknown.data = NULL;
3968 value->unknown.length = 0;
3969 }
3970
3971 if (datalen > 0)
3972 {
3973 void *temp; /* Temporary data pointer */
3974
7e86f2f6 3975 if ((temp = malloc((size_t)datalen)) != NULL)
6961465f 3976 {
07623986 3977 memcpy(temp, data, (size_t)datalen);
6961465f
MS
3978
3979 value->unknown.data = temp;
3980 value->unknown.length = datalen;
3981 }
3982 else
3983 return (0);
3984 }
3985 }
3986 }
3987
3988 return (value != NULL);
3989}
3990
3991
a2326b5b
MS
3992/*
3993 * 'ippSetOperation()' - Set the operation ID in an IPP request message.
3994 *
a469f8a5
MS
3995 * The @code ipp@ parameter refers to an IPP message previously created using
3996 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b 3997 *
8072030b 3998 * @since CUPS 1.6/macOS 10.8@
a2326b5b 3999 */
ef416fc2 4000
a2326b5b
MS
4001int /* O - 1 on success, 0 on failure */
4002ippSetOperation(ipp_t *ipp, /* I - IPP request message */
4003 ipp_op_t op) /* I - Operation ID */
4004{
4005 /*
4006 * Range check input...
4007 */
ef416fc2 4008
a2326b5b
MS
4009 if (!ipp)
4010 return (0);
ef416fc2 4011
a2326b5b
MS
4012 /*
4013 * Set the operation and return...
4014 */
ef416fc2 4015
a2326b5b 4016 ipp->request.op.operation_id = op;
ef416fc2 4017
a2326b5b
MS
4018 return (1);
4019}
ef416fc2 4020
ef416fc2 4021
a2326b5b
MS
4022/*
4023 * 'ippSetRange()' - Set a rangeOfInteger value in an attribute.
4024 *
a469f8a5
MS
4025 * The @code ipp@ parameter refers to an IPP message previously created using
4026 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
4027 *
4028 * The @code attr@ parameter may be modified as a result of setting the value.
4029 *
4030 * The @code element@ parameter specifies which value to set from 0 to
65bebeac 4031 * @code ippGetCount(attr)@.
a2326b5b 4032 *
8072030b 4033 * @since CUPS 1.6/macOS 10.8@
a2326b5b 4034 */
ef416fc2 4035
a2326b5b 4036int /* O - 1 on success, 0 on failure */
6961465f 4037ippSetRange(ipp_t *ipp, /* I - IPP message */
a2326b5b
MS
4038 ipp_attribute_t **attr, /* IO - IPP attribute */
4039 int element, /* I - Value number (0-based) */
4040 int lowervalue, /* I - Lower bound for range */
4041 int uppervalue) /* I - Upper bound for range */
4042{
4043 _ipp_value_t *value; /* Current value */
ef416fc2 4044
ef416fc2 4045
a2326b5b
MS
4046 /*
4047 * Range check input...
4048 */
ef416fc2 4049
d7cd12f0 4050 if (!ipp || !attr || !*attr || ((*attr)->value_tag != IPP_TAG_RANGE && (*attr)->value_tag != IPP_TAG_NOVALUE && (*attr)->value_tag != IPP_TAG_UNKNOWN) || element < 0 || element > (*attr)->num_values || lowervalue > uppervalue)
a2326b5b 4051 return (0);
ef416fc2 4052
a2326b5b
MS
4053 /*
4054 * Set the value and return...
4055 */
ef416fc2 4056
a2326b5b
MS
4057 if ((value = ipp_set_value(ipp, attr, element)) != NULL)
4058 {
d7cd12f0 4059 (*attr)->value_tag = IPP_TAG_RANGE;
a2326b5b
MS
4060 value->range.lower = lowervalue;
4061 value->range.upper = uppervalue;
4062 }
ef416fc2 4063
a2326b5b
MS
4064 return (value != NULL);
4065}
ef416fc2 4066
ef416fc2 4067
a2326b5b
MS
4068/*
4069 * 'ippSetRequestId()' - Set the request ID in an IPP message.
4070 *
a469f8a5
MS
4071 * The @code ipp@ parameter refers to an IPP message previously created using
4072 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
4073 *
4074 * The @code request_id@ parameter must be greater than 0.
4075 *
8072030b 4076 * @since CUPS 1.6/macOS 10.8@
a2326b5b 4077 */
ef416fc2 4078
a2326b5b
MS
4079int /* O - 1 on success, 0 on failure */
4080ippSetRequestId(ipp_t *ipp, /* I - IPP message */
4081 int request_id) /* I - Request ID */
4082{
4083 /*
4084 * Range check input; not checking request_id values since ipptool wants to send
4085 * invalid values for conformance testing and a bad request_id does not affect the
4086 * encoding of a message...
4087 */
83e08001 4088
a2326b5b
MS
4089 if (!ipp)
4090 return (0);
a41f09e2 4091
a2326b5b
MS
4092 /*
4093 * Set the request ID and return...
4094 */
ef416fc2 4095
a2326b5b 4096 ipp->request.any.request_id = request_id;
ef416fc2 4097
a2326b5b
MS
4098 return (1);
4099}
5a738aea 4100
a41f09e2 4101
a2326b5b
MS
4102/*
4103 * 'ippSetResolution()' - Set a resolution value in an attribute.
4104 *
a469f8a5
MS
4105 * The @code ipp@ parameter refers to an IPP message previously created using
4106 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
4107 *
4108 * The @code attr@ parameter may be modified as a result of setting the value.
4109 *
4110 * The @code element@ parameter specifies which value to set from 0 to
65bebeac 4111 * @code ippGetCount(attr)@.
a2326b5b 4112 *
8072030b 4113 * @since CUPS 1.6/macOS 10.8@
a2326b5b 4114 */
ef416fc2 4115
a2326b5b
MS
4116int /* O - 1 on success, 0 on failure */
4117ippSetResolution(
6961465f 4118 ipp_t *ipp, /* I - IPP message */
a2326b5b
MS
4119 ipp_attribute_t **attr, /* IO - IPP attribute */
4120 int element, /* I - Value number (0-based) */
4121 ipp_res_t unitsvalue, /* I - Resolution units */
4122 int xresvalue, /* I - Horizontal/cross feed resolution */
4123 int yresvalue) /* I - Vertical/feed resolution */
4124{
4125 _ipp_value_t *value; /* Current value */
5a738aea 4126
536bc2c6 4127
a2326b5b
MS
4128 /*
4129 * Range check input...
4130 */
1ff0402e 4131
d7cd12f0 4132 if (!ipp || !attr || !*attr || ((*attr)->value_tag != IPP_TAG_RESOLUTION && (*attr)->value_tag != IPP_TAG_NOVALUE && (*attr)->value_tag != IPP_TAG_UNKNOWN) || element < 0 || element > (*attr)->num_values || xresvalue <= 0 || yresvalue <= 0 || unitsvalue < IPP_RES_PER_INCH || unitsvalue > IPP_RES_PER_CM)
a2326b5b 4133 return (0);
1ff0402e 4134
a2326b5b
MS
4135 /*
4136 * Set the value and return...
4137 */
ef416fc2 4138
a2326b5b
MS
4139 if ((value = ipp_set_value(ipp, attr, element)) != NULL)
4140 {
d7cd12f0 4141 (*attr)->value_tag = IPP_TAG_RESOLUTION;
a2326b5b
MS
4142 value->resolution.units = unitsvalue;
4143 value->resolution.xres = xresvalue;
4144 value->resolution.yres = yresvalue;
4145 }
5a738aea 4146
a2326b5b
MS
4147 return (value != NULL);
4148}
a41f09e2 4149
5a738aea 4150
9c80ffa2
MS
4151/*
4152 * 'ippSetState()' - Set the current state of the IPP message.
4153 *
8072030b 4154 * @since CUPS 1.6/macOS 10.8@
9c80ffa2
MS
4155 */
4156
4157int /* O - 1 on success, 0 on failure */
4158ippSetState(ipp_t *ipp, /* I - IPP message */
4159 ipp_state_t state) /* I - IPP state value */
4160{
4161 /*
4162 * Range check input...
4163 */
4164
4165 if (!ipp)
4166 return (0);
4167
4168 /*
4169 * Set the state and return...
4170 */
4171
4172 ipp->state = state;
4173 ipp->current = NULL;
4174
4175 return (1);
4176}
4177
4178
a2326b5b
MS
4179/*
4180 * 'ippSetStatusCode()' - Set the status code in an IPP response or event message.
4181 *
a469f8a5
MS
4182 * The @code ipp@ parameter refers to an IPP message previously created using
4183 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b 4184 *
8072030b 4185 * @since CUPS 1.6/macOS 10.8@
a2326b5b 4186 */
a41f09e2 4187
a2326b5b
MS
4188int /* O - 1 on success, 0 on failure */
4189ippSetStatusCode(ipp_t *ipp, /* I - IPP response or event message */
4190 ipp_status_t status) /* I - Status code */
4191{
4192 /*
4193 * Range check input...
4194 */
4195
4196 if (!ipp)
4197 return (0);
ef416fc2 4198
a2326b5b
MS
4199 /*
4200 * Set the status code and return...
4201 */
5a738aea 4202
a2326b5b 4203 ipp->request.status.status_code = status;
a41f09e2 4204
a2326b5b 4205 return (1);
a2326b5b 4206}
5a738aea 4207
ef416fc2 4208
a2326b5b
MS
4209/*
4210 * 'ippSetString()' - Set a string value in an attribute.
4211 *
a469f8a5
MS
4212 * The @code ipp@ parameter refers to an IPP message previously created using
4213 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
4214 *
4215 * The @code attr@ parameter may be modified as a result of setting the value.
4216 *
4217 * The @code element@ parameter specifies which value to set from 0 to
65bebeac 4218 * @code ippGetCount(attr)@.
a2326b5b 4219 *
8072030b 4220 * @since CUPS 1.6/macOS 10.8@
a2326b5b 4221 */
ef416fc2 4222
a2326b5b 4223int /* O - 1 on success, 0 on failure */
6961465f 4224ippSetString(ipp_t *ipp, /* I - IPP message */
a2326b5b
MS
4225 ipp_attribute_t **attr, /* IO - IPP attribute */
4226 int element, /* I - Value number (0-based) */
4227 const char *strvalue) /* I - String value */
4228{
4229 char *temp; /* Temporary string */
4230 _ipp_value_t *value; /* Current value */
e22f464e 4231 ipp_tag_t value_tag; /* Value tag */
ef416fc2 4232
ef416fc2 4233
a2326b5b
MS
4234 /*
4235 * Range check input...
4236 */
ef416fc2 4237
e22f464e
MS
4238 if (attr && *attr)
4239 value_tag = (*attr)->value_tag & IPP_TAG_CUPS_MASK;
4240 else
4241 value_tag = IPP_TAG_ZERO;
4242
d7cd12f0 4243 if (!ipp || !attr || !*attr || (value_tag < IPP_TAG_TEXT && value_tag != IPP_TAG_TEXTLANG && value_tag != IPP_TAG_NAMELANG && value_tag != IPP_TAG_NOVALUE && value_tag != IPP_TAG_UNKNOWN) || value_tag > IPP_TAG_MIMETYPE || element < 0 || element > (*attr)->num_values || !strvalue)
a2326b5b 4244 return (0);
a41f09e2 4245
a2326b5b
MS
4246 /*
4247 * Set the value and return...
4248 */
ef416fc2 4249
a2326b5b
MS
4250 if ((value = ipp_set_value(ipp, attr, element)) != NULL)
4251 {
d7cd12f0
MS
4252 if (value_tag == IPP_TAG_NOVALUE || value_tag == IPP_TAG_UNKNOWN)
4253 (*attr)->value_tag = IPP_TAG_KEYWORD;
4254
a2326b5b
MS
4255 if (element > 0)
4256 value->string.language = (*attr)->values[0].string.language;
ef416fc2 4257
cb7f98ee 4258 if ((int)((*attr)->value_tag) & IPP_TAG_CUPS_CONST)
a2326b5b
MS
4259 value->string.text = (char *)strvalue;
4260 else if ((temp = _cupsStrAlloc(strvalue)) != NULL)
4261 {
4262 if (value->string.text)
4263 _cupsStrFree(value->string.text);
ef416fc2 4264
a2326b5b
MS
4265 value->string.text = temp;
4266 }
4267 else
4268 return (0);
4269 }
a41f09e2 4270
a2326b5b
MS
4271 return (value != NULL);
4272}
ef416fc2 4273
ef416fc2 4274
a469f8a5
MS
4275/*
4276 * 'ippSetStringf()' - Set a formatted string value of an attribute.
4277 *
4278 * The @code ipp@ parameter refers to an IPP message previously created using
4279 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
4280 *
4281 * The @code attr@ parameter may be modified as a result of setting the value.
4282 *
4283 * The @code element@ parameter specifies which value to set from 0 to
65bebeac 4284 * @code ippGetCount(attr)@.
a469f8a5
MS
4285 *
4286 * The @code format@ parameter uses formatting characters compatible with the
4287 * printf family of standard functions. Additional arguments follow it as
4288 * needed. The formatted string is truncated as needed to the maximum length of
4289 * the corresponding value type.
4290 *
8072030b 4291 * @since CUPS 1.7/macOS 10.9@
a469f8a5
MS
4292 */
4293
4294int /* O - 1 on success, 0 on failure */
6961465f 4295ippSetStringf(ipp_t *ipp, /* I - IPP message */
a469f8a5
MS
4296 ipp_attribute_t **attr, /* IO - IPP attribute */
4297 int element, /* I - Value number (0-based) */
4298 const char *format, /* I - Printf-style format string */
4299 ...) /* I - Additional arguments as needed */
4300{
4301 int ret; /* Return value */
4302 va_list ap; /* Pointer to additional arguments */
4303
4304
4305 va_start(ap, format);
4306 ret = ippSetStringfv(ipp, attr, element, format, ap);
4307 va_end(ap);
4308
4309 return (ret);
4310}
4311
4312
4313/*
4314 * 'ippSetStringf()' - Set a formatted string value of an attribute.
4315 *
4316 * The @code ipp@ parameter refers to an IPP message previously created using
4317 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
4318 *
4319 * The @code attr@ parameter may be modified as a result of setting the value.
4320 *
4321 * The @code element@ parameter specifies which value to set from 0 to
65bebeac 4322 * @code ippGetCount(attr)@.
a469f8a5
MS
4323 *
4324 * The @code format@ parameter uses formatting characters compatible with the
4325 * printf family of standard functions. Additional arguments follow it as
4326 * needed. The formatted string is truncated as needed to the maximum length of
4327 * the corresponding value type.
4328 *
8072030b 4329 * @since CUPS 1.7/macOS 10.9@
a469f8a5
MS
4330 */
4331
4332int /* O - 1 on success, 0 on failure */
6961465f 4333ippSetStringfv(ipp_t *ipp, /* I - IPP message */
a469f8a5
MS
4334 ipp_attribute_t **attr, /* IO - IPP attribute */
4335 int element, /* I - Value number (0-based) */
4336 const char *format, /* I - Printf-style format string */
4337 va_list ap) /* I - Pointer to additional arguments */
4338{
4339 ipp_tag_t value_tag; /* Value tag */
4340 char buffer[IPP_MAX_TEXT + 4];
4341 /* Formatted text string */
4342 ssize_t bytes, /* Length of formatted value */
4343 max_bytes; /* Maximum number of bytes for value */
4344
4345
4346 /*
4347 * Range check input...
4348 */
4349
4350 if (attr && *attr)
4351 value_tag = (*attr)->value_tag & IPP_TAG_CUPS_MASK;
4352 else
4353 value_tag = IPP_TAG_ZERO;
4354
d7cd12f0 4355 if (!ipp || !attr || !*attr || (value_tag < IPP_TAG_TEXT && value_tag != IPP_TAG_TEXTLANG && value_tag != IPP_TAG_NAMELANG && value_tag != IPP_TAG_NOVALUE && value_tag != IPP_TAG_UNKNOWN) || value_tag > IPP_TAG_MIMETYPE || !format)
a469f8a5
MS
4356 return (0);
4357
4358 /*
4359 * Format the string...
4360 */
4361
4362 if (!strcmp(format, "%s"))
4363 {
4364 /*
4365 * Optimize the simple case...
4366 */
4367
4368 const char *s = va_arg(ap, char *);
4369
4370 if (!s)
4371 s = "(null)";
4372
7e86f2f6 4373 bytes = (ssize_t)strlen(s);
a469f8a5
MS
4374 strlcpy(buffer, s, sizeof(buffer));
4375 }
4376 else
4377 {
4378 /*
4379 * Do a full formatting of the message...
4380 */
4381
4382 if ((bytes = vsnprintf(buffer, sizeof(buffer), format, ap)) < 0)
4383 return (0);
4384 }
4385
4386 /*
4387 * Limit the length of the string...
4388 */
4389
4390 switch (value_tag)
4391 {
4392 default :
4393 case IPP_TAG_TEXT :
4394 case IPP_TAG_TEXTLANG :
4395 max_bytes = IPP_MAX_TEXT;
4396 break;
4397
4398 case IPP_TAG_NAME :
4399 case IPP_TAG_NAMELANG :
4400 max_bytes = IPP_MAX_NAME;
4401 break;
4402
4403 case IPP_TAG_CHARSET :
4404 max_bytes = IPP_MAX_CHARSET;
4405 break;
4406
d7cd12f0
MS
4407 case IPP_TAG_NOVALUE :
4408 case IPP_TAG_UNKNOWN :
a469f8a5
MS
4409 case IPP_TAG_KEYWORD :
4410 max_bytes = IPP_MAX_KEYWORD;
4411 break;
4412
4413 case IPP_TAG_LANGUAGE :
4414 max_bytes = IPP_MAX_LANGUAGE;
4415 break;
4416
4417 case IPP_TAG_MIMETYPE :
4418 max_bytes = IPP_MAX_MIMETYPE;
4419 break;
4420
4421 case IPP_TAG_URI :
4422 max_bytes = IPP_MAX_URI;
4423 break;
4424
4425 case IPP_TAG_URISCHEME :
4426 max_bytes = IPP_MAX_URISCHEME;
4427 break;
4428 }
4429
4430 if (bytes >= max_bytes)
4431 {
4432 char *bufmax, /* Buffer at max_bytes */
4433 *bufptr; /* Pointer into buffer */
4434
4435 bufptr = buffer + strlen(buffer) - 1;
4436 bufmax = buffer + max_bytes - 1;
4437
4438 while (bufptr > bufmax)
4439 {
4440 if (*bufptr & 0x80)
4441 {
4442 while ((*bufptr & 0xc0) == 0x80 && bufptr > buffer)
4443 bufptr --;
4444 }
4445
4446 bufptr --;
4447 }
4448
4449 *bufptr = '\0';
4450 }
4451
4452 /*
4453 * Set the formatted string and return...
4454 */
4455
4456 return (ippSetString(ipp, attr, element, buffer));
4457}
4458
4459
a2326b5b
MS
4460/*
4461 * 'ippSetValueTag()' - Set the value tag of an attribute.
4462 *
a469f8a5
MS
4463 * The @code ipp@ parameter refers to an IPP message previously created using
4464 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
4465 *
4466 * The @code attr@ parameter may be modified as a result of setting the value.
4467 *
4468 * Integer (@code IPP_TAG_INTEGER@) values can be promoted to rangeOfInteger
4469 * (@code IPP_TAG_RANGE@) values, the various string tags can be promoted to name
4470 * (@code IPP_TAG_NAME@) or nameWithLanguage (@code IPP_TAG_NAMELANG@) values, text
4471 * (@code IPP_TAG_TEXT@) values can be promoted to textWithLanguage
4472 * (@code IPP_TAG_TEXTLANG@) values, and all values can be demoted to the various
4473 * out-of-band value tags such as no-value (@code IPP_TAG_NOVALUE@). All other changes
4474 * will be rejected.
4475 *
4476 * Promoting a string attribute to nameWithLanguage or textWithLanguage adds the language
4477 * code in the "attributes-natural-language" attribute or, if not present, the language
4478 * code for the current locale.
4479 *
8072030b 4480 * @since CUPS 1.6/macOS 10.8@
a2326b5b 4481 */
ef416fc2 4482
a2326b5b
MS
4483int /* O - 1 on success, 0 on failure */
4484ippSetValueTag(
6961465f 4485 ipp_t *ipp, /* I - IPP message */
a2326b5b
MS
4486 ipp_attribute_t **attr, /* IO - IPP attribute */
4487 ipp_tag_t value_tag) /* I - Value tag */
4488{
4489 int i; /* Looping var */
4490 _ipp_value_t *value; /* Current value */
4491 int integer; /* Current integer value */
4492 cups_lang_t *language; /* Current language */
4493 char code[32]; /* Language code */
4494 ipp_tag_t temp_tag; /* Temporary value tag */
ef416fc2 4495
ef416fc2 4496
a2326b5b
MS
4497 /*
4498 * Range check input...
4499 */
1f6f3dbc 4500
a469f8a5 4501 if (!ipp || !attr || !*attr)
a2326b5b 4502 return (0);
ef416fc2 4503
a2326b5b
MS
4504 /*
4505 * If there is no change, return immediately...
4506 */
ef416fc2 4507
a2326b5b
MS
4508 if (value_tag == (*attr)->value_tag)
4509 return (1);
ef416fc2 4510
a2326b5b
MS
4511 /*
4512 * Otherwise implement changes as needed...
4513 */
ef416fc2 4514
cb7f98ee 4515 temp_tag = (ipp_tag_t)((int)((*attr)->value_tag) & IPP_TAG_CUPS_MASK);
4400e98d 4516
a2326b5b
MS
4517 switch (value_tag)
4518 {
4519 case IPP_TAG_UNSUPPORTED_VALUE :
4520 case IPP_TAG_DEFAULT :
4521 case IPP_TAG_UNKNOWN :
4522 case IPP_TAG_NOVALUE :
4523 case IPP_TAG_NOTSETTABLE :
4524 case IPP_TAG_DELETEATTR :
4525 case IPP_TAG_ADMINDEFINE :
4526 /*
4527 * Free any existing values...
4528 */
ef416fc2 4529
a2326b5b
MS
4530 if ((*attr)->num_values > 0)
4531 ipp_free_values(*attr, 0, (*attr)->num_values);
ef416fc2 4532
a2326b5b
MS
4533 /*
4534 * Set out-of-band value...
4535 */
ef416fc2 4536
a2326b5b
MS
4537 (*attr)->value_tag = value_tag;
4538 break;
91c84a35 4539
a2326b5b
MS
4540 case IPP_TAG_RANGE :
4541 if (temp_tag != IPP_TAG_INTEGER)
4542 return (0);
4543
4544 for (i = (*attr)->num_values, value = (*attr)->values;
4545 i > 0;
4546 i --, value ++)
4547 {
4548 integer = value->integer;
4549 value->range.lower = value->range.upper = integer;
4550 }
ef416fc2 4551
a2326b5b
MS
4552 (*attr)->value_tag = IPP_TAG_RANGE;
4553 break;
ef416fc2 4554
a2326b5b 4555 case IPP_TAG_NAME :
2c030c7a 4556 if (temp_tag != IPP_TAG_KEYWORD)
a2326b5b 4557 return (0);
ef416fc2 4558
cb7f98ee 4559 (*attr)->value_tag = (ipp_tag_t)(IPP_TAG_NAME | ((*attr)->value_tag & IPP_TAG_CUPS_CONST));
ef416fc2 4560 break;
4561
a2326b5b
MS
4562 case IPP_TAG_NAMELANG :
4563 case IPP_TAG_TEXTLANG :
2c030c7a 4564 if (value_tag == IPP_TAG_NAMELANG && (temp_tag != IPP_TAG_NAME && temp_tag != IPP_TAG_KEYWORD))
a2326b5b
MS
4565 return (0);
4566
4567 if (value_tag == IPP_TAG_TEXTLANG && temp_tag != IPP_TAG_TEXT)
4568 return (0);
4569
4570 if (ipp->attrs && ipp->attrs->next && ipp->attrs->next->name &&
b018978c 4571 !strcmp(ipp->attrs->next->name, "attributes-natural-language") && (ipp->attrs->next->value_tag & IPP_TAG_CUPS_MASK) == IPP_TAG_LANGUAGE)
a2326b5b
MS
4572 {
4573 /*
4574 * Use the language code from the IPP message...
4575 */
4576
4577 (*attr)->values[0].string.language =
4578 _cupsStrAlloc(ipp->attrs->next->values[0].string.text);
4579 }
4580 else
4581 {
4582 /*
4583 * Otherwise, use the language code corresponding to the locale...
4584 */
4585
4586 language = cupsLangDefault();
4587 (*attr)->values[0].string.language = _cupsStrAlloc(ipp_lang_code(language->language,
4588 code,
4589 sizeof(code)));
4590 }
4591
4592 for (i = (*attr)->num_values - 1, value = (*attr)->values + 1;
4593 i > 0;
4594 i --, value ++)
4595 value->string.language = (*attr)->values[0].string.language;
4596
cb7f98ee 4597 if ((int)(*attr)->value_tag & IPP_TAG_CUPS_CONST)
a2326b5b
MS
4598 {
4599 /*
4600 * Make copies of all values...
4601 */
4602
4603 for (i = (*attr)->num_values, value = (*attr)->values;
4604 i > 0;
4605 i --, value ++)
4606 value->string.text = _cupsStrAlloc(value->string.text);
4607 }
4608
4609 (*attr)->value_tag = IPP_TAG_NAMELANG;
ef416fc2 4610 break;
4611
a2326b5b
MS
4612 case IPP_TAG_KEYWORD :
4613 if (temp_tag == IPP_TAG_NAME || temp_tag == IPP_TAG_NAMELANG)
4614 break; /* Silently "allow" name -> keyword */
4615
ef416fc2 4616 default :
a2326b5b 4617 return (0);
ef416fc2 4618 }
4619
a2326b5b
MS
4620 return (1);
4621}
4622
4623
4624/*
4625 * 'ippSetVersion()' - Set the version number in an IPP message.
4626 *
a469f8a5
MS
4627 * The @code ipp@ parameter refers to an IPP message previously created using
4628 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
4629 *
4630 * The valid version numbers are currently 1.0, 1.1, 2.0, 2.1, and 2.2.
4631 *
8072030b 4632 * @since CUPS 1.6/macOS 10.8@
a2326b5b
MS
4633 */
4634
4635int /* O - 1 on success, 0 on failure */
4636ippSetVersion(ipp_t *ipp, /* I - IPP message */
4637 int major, /* I - Major version number (major.minor) */
4638 int minor) /* I - Minor version number (major.minor) */
4639{
4640 /*
4641 * Range check input...
4642 */
4643
4644 if (!ipp || major < 0 || minor < 0)
4645 return (0);
4646
4647 /*
4648 * Set the version number...
4649 */
4650
7e86f2f6
MS
4651 ipp->request.any.version[0] = (ipp_uchar_t)major;
4652 ipp->request.any.version[1] = (ipp_uchar_t)minor;
89d46774 4653
a2326b5b 4654 return (1);
ef416fc2 4655}
4656
4657
4658/*
65bebeac 4659 * 'ippTimeToDate()' - Convert from time in seconds to RFC 2579 format.
ef416fc2 4660 */
4661
65bebeac
MS
4662const ipp_uchar_t * /* O - RFC-2579 date/time data */
4663ippTimeToDate(time_t t) /* I - Time in seconds */
ef416fc2 4664{
f4a99aeb 4665 struct tm unixdate; /* UNIX unixdate/time info */
ef416fc2 4666 ipp_uchar_t *date = _cupsGlobals()->ipp_date;
65bebeac 4667 /* RFC-2579 date/time data */
ef416fc2 4668
4669
4670 /*
65bebeac 4671 * RFC-2579 date/time format is:
ef416fc2 4672 *
4673 * Byte(s) Description
4674 * ------- -----------
4675 * 0-1 Year (0 to 65535)
4676 * 2 Month (1 to 12)
4677 * 3 Day (1 to 31)
4678 * 4 Hours (0 to 23)
4679 * 5 Minutes (0 to 59)
4680 * 6 Seconds (0 to 60, 60 = "leap second")
4681 * 7 Deciseconds (0 to 9)
4682 * 8 +/- UTC
4683 * 9 UTC hours (0 to 11)
4684 * 10 UTC minutes (0 to 59)
4685 */
4686
f4a99aeb
MS
4687 gmtime_r(&t, &unixdate);
4688 unixdate.tm_year += 1900;
ef416fc2 4689
f4a99aeb
MS
4690 date[0] = (ipp_uchar_t)(unixdate.tm_year >> 8);
4691 date[1] = (ipp_uchar_t)(unixdate.tm_year);
4692 date[2] = (ipp_uchar_t)(unixdate.tm_mon + 1);
4693 date[3] = (ipp_uchar_t)unixdate.tm_mday;
4694 date[4] = (ipp_uchar_t)unixdate.tm_hour;
4695 date[5] = (ipp_uchar_t)unixdate.tm_min;
4696 date[6] = (ipp_uchar_t)unixdate.tm_sec;
ef416fc2 4697 date[7] = 0;
4698 date[8] = '+';
4699 date[9] = 0;
4700 date[10] = 0;
4701
4702 return (date);
4703}
4704
4705
c1420c87
MS
4706/*
4707 * 'ippValidateAttribute()' - Validate the contents of an attribute.
4708 *
4709 * This function validates the contents of an attribute based on the name and
4710 * value tag. 1 is returned if the attribute is valid, 0 otherwise. On
65bebeac 4711 * failure, @link cupsLastErrorString@ is set to a human-readable message.
c1420c87 4712 *
8072030b 4713 * @since CUPS 1.7/macOS 10.9@
c1420c87
MS
4714 */
4715
4716int /* O - 1 if valid, 0 otherwise */
4717ippValidateAttribute(
4718 ipp_attribute_t *attr) /* I - Attribute */
4719{
4720 int i; /* Looping var */
4721 char scheme[64], /* Scheme from URI */
4722 userpass[256], /* Username/password from URI */
4723 hostname[256], /* Hostname from URI */
4724 resource[1024]; /* Resource from URI */
4725 int port, /* Port number from URI */
4726 uri_status; /* URI separation status */
4727 const char *ptr; /* Pointer into string */
4728 ipp_attribute_t *colattr; /* Collection attribute */
4729 regex_t re; /* Regular expression */
4730 ipp_uchar_t *date; /* Current date value */
c1420c87
MS
4731
4732
4733 /*
4734 * Skip separators.
4735 */
4736
4737 if (!attr->name)
4738 return (1);
4739
4740 /*
4741 * Validate the attribute name.
4742 */
4743
4744 for (ptr = attr->name; *ptr; ptr ++)
4745 if (!isalnum(*ptr & 255) && *ptr != '-' && *ptr != '.' && *ptr != '_')
4746 break;
4747
4748 if (*ptr || ptr == attr->name)
4749 {
2da2477d 4750 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad attribute name - invalid character (RFC 8011 section 5.1.4)."), attr->name);
c1420c87
MS
4751 return (0);
4752 }
4753
4754 if ((ptr - attr->name) > 255)
4755 {
2da2477d 4756 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));
c1420c87
MS
4757 return (0);
4758 }
4759
4760 switch (attr->value_tag)
4761 {
4762 case IPP_TAG_INTEGER :
4763 break;
4764
4765 case IPP_TAG_BOOLEAN :
4766 for (i = 0; i < attr->num_values; i ++)
4767 {
4768 if (attr->values[i].boolean != 0 &&
4769 attr->values[i].boolean != 1)
4770 {
2da2477d 4771 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);
c1420c87
MS
4772 return (0);
4773 }
4774 }
4775 break;
4776
4777 case IPP_TAG_ENUM :
4778 for (i = 0; i < attr->num_values; i ++)
4779 {
4780 if (attr->values[i].integer < 1)
4781 {
2da2477d 4782 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);
c1420c87
MS
4783 return (0);
4784 }
4785 }
4786 break;
4787
4788 case IPP_TAG_STRING :
4789 for (i = 0; i < attr->num_values; i ++)
4790 {
4791 if (attr->values[i].unknown.length > IPP_MAX_OCTETSTRING)
4792 {
2da2477d 4793 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);
c1420c87
MS
4794 return (0);
4795 }
4796 }
4797 break;
4798
4799 case IPP_TAG_DATE :
4800 for (i = 0; i < attr->num_values; i ++)
4801 {
4802 date = attr->values[i].date;
4803
4804 if (date[2] < 1 || date[2] > 12)
4805 {
2da2477d 4806 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad dateTime month %u (RFC 8011 section 5.1.15)."), attr->name, date[2]);
c1420c87
MS
4807 return (0);
4808 }
4809
4810 if (date[3] < 1 || date[3] > 31)
4811 {
2da2477d 4812 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad dateTime day %u (RFC 8011 section 5.1.15)."), attr->name, date[3]);
c1420c87
MS
4813 return (0);
4814 }
4815
4816 if (date[4] > 23)
4817 {
2da2477d 4818 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad dateTime hours %u (RFC 8011 section 5.1.15)."), attr->name, date[4]);
c1420c87
MS
4819 return (0);
4820 }
4821
4822 if (date[5] > 59)
4823 {
2da2477d 4824 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad dateTime minutes %u (RFC 8011 section 5.1.15)."), attr->name, date[5]);
c1420c87
MS
4825 return (0);
4826 }
4827
4828 if (date[6] > 60)
4829 {
2da2477d 4830 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad dateTime seconds %u (RFC 8011 section 5.1.15)."), attr->name, date[6]);
c1420c87
MS
4831 return (0);
4832 }
4833
4834 if (date[7] > 9)
4835 {
2da2477d 4836 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad dateTime deciseconds %u (RFC 8011 section 5.1.15)."), attr->name, date[7]);
c1420c87
MS
4837 return (0);
4838 }
4839
4840 if (date[8] != '-' && date[8] != '+')
4841 {
2da2477d 4842 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad dateTime UTC sign '%c' (RFC 8011 section 5.1.15)."), attr->name, date[8]);
c1420c87
MS
4843 return (0);
4844 }
4845
4846 if (date[9] > 11)
4847 {
2da2477d 4848 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad dateTime UTC hours %u (RFC 8011 section 5.1.15)."), attr->name, date[9]);
c1420c87
MS
4849 return (0);
4850 }
4851
4852 if (date[10] > 59)
4853 {
2da2477d 4854 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad dateTime UTC minutes %u (RFC 8011 section 5.1.15)."), attr->name, date[10]);
c1420c87
MS
4855 return (0);
4856 }
4857 }
4858 break;
4859
4860 case IPP_TAG_RESOLUTION :
4861 for (i = 0; i < attr->num_values; i ++)
4862 {
4863 if (attr->values[i].resolution.xres <= 0)
4864 {
2da2477d 4865 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");
c1420c87
MS
4866 return (0);
4867 }
4868
4869 if (attr->values[i].resolution.yres <= 0)
4870 {
2da2477d 4871 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");
c1420c87
MS
4872 return (0);
4873 }
4874
2da2477d 4875 if (attr->values[i].resolution.units != IPP_RES_PER_INCH && attr->values[i].resolution.units != IPP_RES_PER_CM)
c1420c87 4876 {
2da2477d 4877 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");
c1420c87
MS
4878 return (0);
4879 }
4880 }
4881 break;
4882
4883 case IPP_TAG_RANGE :
4884 for (i = 0; i < attr->num_values; i ++)
4885 {
4886 if (attr->values[i].range.lower > attr->values[i].range.upper)
4887 {
2da2477d 4888 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);
c1420c87
MS
4889 return (0);
4890 }
4891 }
4892 break;
4893
4894 case IPP_TAG_BEGIN_COLLECTION :
4895 for (i = 0; i < attr->num_values; i ++)
4896 {
4897 for (colattr = attr->values[i].collection->attrs;
4898 colattr;
4899 colattr = colattr->next)
4900 {
4901 if (!ippValidateAttribute(colattr))
4902 return (0);
4903 }
4904 }
4905 break;
4906
4907 case IPP_TAG_TEXT :
4908 case IPP_TAG_TEXTLANG :
4909 for (i = 0; i < attr->num_values; i ++)
4910 {
4911 for (ptr = attr->values[i].string.text; *ptr; ptr ++)
4912 {
4913 if ((*ptr & 0xe0) == 0xc0)
4914 {
d9f301dd 4915 if ((ptr[1] & 0xc0) != 0x80)
c1420c87 4916 break;
d9f301dd
MS
4917
4918 ptr ++;
c1420c87
MS
4919 }
4920 else if ((*ptr & 0xf0) == 0xe0)
4921 {
d9f301dd 4922 if ((ptr[1] & 0xc0) != 0x80 || (ptr[2] & 0xc0) != 0x80)
c1420c87 4923 break;
d9f301dd
MS
4924
4925 ptr += 2;
c1420c87
MS
4926 }
4927 else if ((*ptr & 0xf8) == 0xf0)
4928 {
d9f301dd 4929 if ((ptr[1] & 0xc0) != 0x80 || (ptr[2] & 0xc0) != 0x80 || (ptr[3] & 0xc0) != 0x80)
c1420c87 4930 break;
d9f301dd
MS
4931
4932 ptr += 3;
c1420c87
MS
4933 }
4934 else if (*ptr & 0x80)
4935 break;
4cadd620
MS
4936 else if ((*ptr < ' ' && *ptr != '\n' && *ptr != '\r' && *ptr != '\t') || *ptr == 0x7f)
4937 break;
c1420c87
MS
4938 }
4939
1d677f11
MS
4940 if (*ptr)
4941 {
4942 if (*ptr < ' ' || *ptr == 0x7f)
4943 {
4944 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);
4945 return (0);
4946 }
4947 else
4948 {
4949 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);
4950 return (0);
4951 }
4952 }
c1420c87
MS
4953
4954 if ((ptr - attr->values[i].string.text) > (IPP_MAX_TEXT - 1))
4955 {
2da2477d 4956 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));
c1420c87
MS
4957 return (0);
4958 }
4959 }
4960 break;
4961
4962 case IPP_TAG_NAME :
4963 case IPP_TAG_NAMELANG :
4964 for (i = 0; i < attr->num_values; i ++)
4965 {
4966 for (ptr = attr->values[i].string.text; *ptr; ptr ++)
4967 {
4968 if ((*ptr & 0xe0) == 0xc0)
4969 {
d9f301dd 4970 if ((ptr[1] & 0xc0) != 0x80)
c1420c87 4971 break;
d9f301dd
MS
4972
4973 ptr ++;
c1420c87
MS
4974 }
4975 else if ((*ptr & 0xf0) == 0xe0)
4976 {
d9f301dd 4977 if ((ptr[1] & 0xc0) != 0x80 || (ptr[2] & 0xc0) != 0x80)
c1420c87 4978 break;
d9f301dd
MS
4979
4980 ptr += 2;
c1420c87
MS
4981 }
4982 else if ((*ptr & 0xf8) == 0xf0)
4983 {
d9f301dd 4984 if ((ptr[1] & 0xc0) != 0x80 || (ptr[2] & 0xc0) != 0x80 || (ptr[3] & 0xc0) != 0x80)
c1420c87 4985 break;
d9f301dd
MS
4986
4987 ptr += 3;
c1420c87
MS
4988 }
4989 else if (*ptr & 0x80)
4990 break;
4cadd620
MS
4991 else if (*ptr < ' ' || *ptr == 0x7f)
4992 break;
c1420c87
MS
4993 }
4994
1d677f11 4995 if (*ptr)
c1420c87 4996 {
1d677f11
MS
4997 if (*ptr < ' ' || *ptr == 0x7f)
4998 {
4999 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);
5000 return (0);
5001 }
5002 else
5003 {
5004 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);
5005 return (0);
5006 }
5007 }
c1420c87
MS
5008
5009 if ((ptr - attr->values[i].string.text) > (IPP_MAX_NAME - 1))
5010 {
2da2477d 5011 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));
c1420c87
MS
5012 return (0);
5013 }
5014 }
5015 break;
5016
5017 case IPP_TAG_KEYWORD :
5018 for (i = 0; i < attr->num_values; i ++)
5019 {
5020 for (ptr = attr->values[i].string.text; *ptr; ptr ++)
2da2477d 5021 {
c1420c87
MS
5022 if (!isalnum(*ptr & 255) && *ptr != '-' && *ptr != '.' &&
5023 *ptr != '_')
5024 break;
2da2477d 5025 }
c1420c87
MS
5026
5027 if (*ptr || ptr == attr->values[i].string.text)
5028 {
2da2477d 5029 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);
c1420c87
MS
5030 return (0);
5031 }
5032
5033 if ((ptr - attr->values[i].string.text) > (IPP_MAX_KEYWORD - 1))
5034 {
2da2477d 5035 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));
c1420c87
MS
5036 return (0);
5037 }
5038 }
5039 break;
5040
5041 case IPP_TAG_URI :
5042 for (i = 0; i < attr->num_values; i ++)
5043 {
2da2477d 5044 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));
c1420c87 5045
cb7f98ee 5046 if (uri_status < HTTP_URI_STATUS_OK)
c1420c87 5047 {
2da2477d 5048 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));
c1420c87
MS
5049 return (0);
5050 }
5051
5052 if (strlen(attr->values[i].string.text) > (IPP_MAX_URI - 1))
5053 {
2da2477d 5054 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));
c1420c87
MS
5055 }
5056 }
5057 break;
5058
5059 case IPP_TAG_URISCHEME :
5060 for (i = 0; i < attr->num_values; i ++)
5061 {
5062 ptr = attr->values[i].string.text;
5063 if (islower(*ptr & 255))
5064 {
5065 for (ptr ++; *ptr; ptr ++)
2da2477d 5066 {
c1420c87
MS
5067 if (!islower(*ptr & 255) && !isdigit(*ptr & 255) &&
5068 *ptr != '+' && *ptr != '-' && *ptr != '.')
5069 break;
2da2477d 5070 }
c1420c87
MS
5071 }
5072
5073 if (*ptr || ptr == attr->values[i].string.text)
5074 {
2da2477d 5075 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);
c1420c87
MS
5076 return (0);
5077 }
5078
5079 if ((ptr - attr->values[i].string.text) > (IPP_MAX_URISCHEME - 1))
5080 {
2da2477d 5081 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));
c1420c87
MS
5082 return (0);
5083 }
5084 }
5085 break;
5086
5087 case IPP_TAG_CHARSET :
5088 for (i = 0; i < attr->num_values; i ++)
5089 {
5090 for (ptr = attr->values[i].string.text; *ptr; ptr ++)
2da2477d 5091 {
c1420c87
MS
5092 if (!isprint(*ptr & 255) || isupper(*ptr & 255) ||
5093 isspace(*ptr & 255))
5094 break;
2da2477d 5095 }
c1420c87
MS
5096
5097 if (*ptr || ptr == attr->values[i].string.text)
5098 {
2da2477d 5099 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);
c1420c87
MS
5100 return (0);
5101 }
5102
5103 if ((ptr - attr->values[i].string.text) > (IPP_MAX_CHARSET - 1))
5104 {
2da2477d 5105 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));
c1420c87
MS
5106 return (0);
5107 }
5108 }
5109 break;
5110
5111 case IPP_TAG_LANGUAGE :
5112 /*
5113 * The following regular expression is derived from the ABNF for
5114 * language tags in RFC 4646. All I can say is that this is the
5115 * easiest way to check the values...
5116 */
5117
5118 if ((i = regcomp(&re,
5119 "^("
5120 "(([a-z]{2,3}(-[a-z][a-z][a-z]){0,3})|[a-z]{4,8})"
5121 /* language */
5122 "(-[a-z][a-z][a-z][a-z]){0,1}" /* script */
5123 "(-([a-z][a-z]|[0-9][0-9][0-9])){0,1}" /* region */
5124 "(-([a-z]{5,8}|[0-9][0-9][0-9]))*" /* variant */
5125 "(-[a-wy-z](-[a-z0-9]{2,8})+)*" /* extension */
5126 "(-x(-[a-z0-9]{1,8})+)*" /* privateuse */
5127 "|"
5128 "x(-[a-z0-9]{1,8})+" /* privateuse */
5129 "|"
5130 "[a-z]{1,3}(-[a-z][0-9]{2,8}){1,2}" /* grandfathered */
5131 ")$",
5132 REG_NOSUB | REG_EXTENDED)) != 0)
5133 {
5134 char temp[256]; /* Temporary error string */
5135
5136 regerror(i, &re, temp, sizeof(temp));
2da2477d 5137 ipp_set_error(IPP_STATUS_ERROR_INTERNAL, _("Unable to compile naturalLanguage regular expression: %s."), temp);
c1420c87
MS
5138 return (0);
5139 }
5140
5141 for (i = 0; i < attr->num_values; i ++)
5142 {
5143 if (regexec(&re, attr->values[i].string.text, 0, NULL, 0))
5144 {
2da2477d 5145 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);
c1420c87
MS
5146 regfree(&re);
5147 return (0);
5148 }
5149
5150 if (strlen(attr->values[i].string.text) > (IPP_MAX_LANGUAGE - 1))
5151 {
2da2477d 5152 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));
c1420c87
MS
5153 regfree(&re);
5154 return (0);
5155 }
5156 }
5157
5158 regfree(&re);
5159 break;
5160
5161 case IPP_TAG_MIMETYPE :
5162 /*
5163 * The following regular expression is derived from the ABNF for
5164 * MIME media types in RFC 2045 and 4288. All I can say is that this is
5165 * the easiest way to check the values...
5166 */
5167
5168 if ((i = regcomp(&re,
5169 "^"
5170 "[-a-zA-Z0-9!#$&.+^_]{1,127}" /* type-name */
5171 "/"
5172 "[-a-zA-Z0-9!#$&.+^_]{1,127}" /* subtype-name */
5173 "(;[-a-zA-Z0-9!#$&.+^_]{1,127}=" /* parameter= */
5174 "([-a-zA-Z0-9!#$&.+^_]{1,127}|\"[^\"]*\"))*"
5175 /* value */
5176 "$",
5177 REG_NOSUB | REG_EXTENDED)) != 0)
5178 {
5179 char temp[256]; /* Temporary error string */
5180
5181 regerror(i, &re, temp, sizeof(temp));
2da2477d 5182 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("Unable to compile mimeMediaType regular expression: %s."), temp);
c1420c87
MS
5183 return (0);
5184 }
5185
5186 for (i = 0; i < attr->num_values; i ++)
5187 {
5188 if (regexec(&re, attr->values[i].string.text, 0, NULL, 0))
5189 {
2da2477d 5190 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);
c1420c87
MS
5191 regfree(&re);
5192 return (0);
5193 }
5194
5195 if (strlen(attr->values[i].string.text) > (IPP_MAX_MIMETYPE - 1))
5196 {
2da2477d 5197 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));
c1420c87
MS
5198 regfree(&re);
5199 return (0);
5200 }
5201 }
5202
5203 regfree(&re);
5204 break;
5205
5206 default :
5207 break;
5208 }
5209
5210 return (1);
5211}
5212
5213
5214/*
5215 * 'ippValidateAttributes()' - Validate all attributes in an IPP message.
5216 *
5217 * This function validates the contents of the IPP message, including each
65bebeac
MS
5218 * attribute. Like @link ippValidateAttribute@, @link cupsLastErrorString@ is
5219 * set to a human-readable message on failure.
c1420c87 5220 *
8072030b 5221 * @since CUPS 1.7/macOS 10.9@
c1420c87
MS
5222 */
5223
5224int /* O - 1 if valid, 0 otherwise */
5225ippValidateAttributes(ipp_t *ipp) /* I - IPP message */
5226{
5227 ipp_attribute_t *attr; /* Current attribute */
5228
5229
5230 if (!ipp)
5231 return (1);
5232
5233 for (attr = ipp->attrs; attr; attr = attr->next)
5234 if (!ippValidateAttribute(attr))
5235 return (0);
5236
5237 return (1);
5238}
5239
5240
ef416fc2 5241/*
5242 * 'ippWrite()' - Write data for an IPP message to a HTTP connection.
5243 */
5244
5245ipp_state_t /* O - Current state */
5246ippWrite(http_t *http, /* I - HTTP connection */
5247 ipp_t *ipp) /* I - IPP data */
5248{
807315e6 5249 DEBUG_printf(("ippWrite(http=%p, ipp=%p)", (void *)http, (void *)ipp));
ef416fc2 5250
1ff0402e 5251 if (!http)
cb7f98ee 5252 return (IPP_STATE_ERROR);
ef416fc2 5253
e07d4801 5254 return (ippWriteIO(http, (ipp_iocb_t)httpWrite2, http->blocking, NULL, ipp));
ef416fc2 5255}
5256
5257
5258/*
5259 * 'ippWriteFile()' - Write data for an IPP message to a file.
5260 *
8072030b 5261 * @since CUPS 1.1.19/macOS 10.3@
ef416fc2 5262 */
5263
5264ipp_state_t /* O - Current state */
5265ippWriteFile(int fd, /* I - HTTP data */
5266 ipp_t *ipp) /* I - IPP data */
5267{
807315e6 5268 DEBUG_printf(("ippWriteFile(fd=%d, ipp=%p)", fd, (void *)ipp));
ef416fc2 5269
cb7f98ee 5270 ipp->state = IPP_STATE_IDLE;
ef416fc2 5271
5272 return (ippWriteIO(&fd, (ipp_iocb_t)ipp_write_file, 1, NULL, ipp));
5273}
5274
5275
5276/*
5277 * 'ippWriteIO()' - Write data for an IPP message.
5278 *
8072030b 5279 * @since CUPS 1.2/macOS 10.5@
ef416fc2 5280 */
5281
5282ipp_state_t /* O - Current state */
5283ippWriteIO(void *dst, /* I - Destination */
5284 ipp_iocb_t cb, /* I - Write callback function */
5285 int blocking, /* I - Use blocking IO? */
5286 ipp_t *parent, /* I - Parent IPP message */
5287 ipp_t *ipp) /* I - IPP data */
5288{
5289 int i; /* Looping var */
5290 int n; /* Length of data */
1f6f3dbc 5291 unsigned char *buffer, /* Data buffer */
ef416fc2 5292 *bufptr; /* Pointer into buffer */
5293 ipp_attribute_t *attr; /* Current attribute */
a2326b5b 5294 _ipp_value_t *value; /* Current value */
ef416fc2 5295
5296
807315e6 5297 DEBUG_printf(("ippWriteIO(dst=%p, cb=%p, blocking=%d, parent=%p, ipp=%p)", (void *)dst, (void *)cb, blocking, (void *)parent, (void *)ipp));
ef416fc2 5298
1ff0402e 5299 if (!dst || !ipp)
cb7f98ee 5300 return (IPP_STATE_ERROR);
ef416fc2 5301
dcb445bc 5302 if ((buffer = (unsigned char *)_cupsBufferGet(IPP_BUF_SIZE)) == NULL)
1f6f3dbc 5303 {
e07d4801 5304 DEBUG_puts("1ippWriteIO: Unable to get write buffer");
cb7f98ee 5305 return (IPP_STATE_ERROR);
1f6f3dbc
MS
5306 }
5307
ef416fc2 5308 switch (ipp->state)
5309 {
cb7f98ee 5310 case IPP_STATE_IDLE :
ef416fc2 5311 ipp->state ++; /* Avoid common problem... */
5312
cb7f98ee 5313 case IPP_STATE_HEADER :
ef416fc2 5314 if (parent == NULL)
5315 {
5316 /*
5317 * Send the request header:
5318 *
5319 * Version = 2 bytes
5320 * Operation/Status Code = 2 bytes
5321 * Request ID = 4 bytes
5322 * Total = 8 bytes
5323 */
5324
5325 bufptr = buffer;
5326
5327 *bufptr++ = ipp->request.any.version[0];
5328 *bufptr++ = ipp->request.any.version[1];
7e86f2f6
MS
5329 *bufptr++ = (ipp_uchar_t)(ipp->request.any.op_status >> 8);
5330 *bufptr++ = (ipp_uchar_t)ipp->request.any.op_status;
5331 *bufptr++ = (ipp_uchar_t)(ipp->request.any.request_id >> 24);
5332 *bufptr++ = (ipp_uchar_t)(ipp->request.any.request_id >> 16);
5333 *bufptr++ = (ipp_uchar_t)(ipp->request.any.request_id >> 8);
5334 *bufptr++ = (ipp_uchar_t)ipp->request.any.request_id;
ef416fc2 5335
ba55dc12
MS
5336 DEBUG_printf(("2ippWriteIO: version=%d.%d", buffer[0], buffer[1]));
5337 DEBUG_printf(("2ippWriteIO: op_status=%04x",
5338 ipp->request.any.op_status));
5339 DEBUG_printf(("2ippWriteIO: request_id=%d",
5340 ipp->request.any.request_id));
5341
7e86f2f6 5342 if ((*cb)(dst, buffer, (size_t)(bufptr - buffer)) < 0)
ef416fc2 5343 {
e07d4801 5344 DEBUG_puts("1ippWriteIO: Could not write IPP header...");
dcb445bc 5345 _cupsBufferRelease((char *)buffer);
cb7f98ee 5346 return (IPP_STATE_ERROR);
ef416fc2 5347 }
5348 }
5349
5350 /*
5351 * Reset the state engine to point to the first attribute
5352 * in the request/response, with no current group.
5353 */
5354
cb7f98ee 5355 ipp->state = IPP_STATE_ATTRIBUTE;
ef416fc2 5356 ipp->current = ipp->attrs;
5357 ipp->curtag = IPP_TAG_ZERO;
5358
807315e6 5359 DEBUG_printf(("1ippWriteIO: ipp->current=%p", (void *)ipp->current));
ef416fc2 5360
5361 /*
5362 * If blocking is disabled, stop here...
5363 */
5364
5365 if (!blocking)
5366 break;
5367
cb7f98ee 5368 case IPP_STATE_ATTRIBUTE :
ef416fc2 5369 while (ipp->current != NULL)
5370 {
5371 /*
5372 * Write this attribute...
5373 */
5374
5375 bufptr = buffer;
5376 attr = ipp->current;
5377
5378 ipp->current = ipp->current->next;
5379
ba55dc12 5380 if (!parent)
ef416fc2 5381 {
ba55dc12
MS
5382 if (ipp->curtag != attr->group_tag)
5383 {
5384 /*
5385 * Send a group tag byte...
5386 */
ef416fc2 5387
ba55dc12 5388 ipp->curtag = attr->group_tag;
ef416fc2 5389
ba55dc12
MS
5390 if (attr->group_tag == IPP_TAG_ZERO)
5391 continue;
ef416fc2 5392
ba55dc12
MS
5393 DEBUG_printf(("2ippWriteIO: wrote group tag=%x(%s)",
5394 attr->group_tag, ippTagString(attr->group_tag)));
7e86f2f6 5395 *bufptr++ = (ipp_uchar_t)attr->group_tag;
ba55dc12
MS
5396 }
5397 else if (attr->group_tag == IPP_TAG_ZERO)
5398 continue;
ef416fc2 5399 }
ba55dc12
MS
5400
5401 DEBUG_printf(("1ippWriteIO: %s (%s%s)", attr->name,
5402 attr->num_values > 1 ? "1setOf " : "",
5403 ippTagString(attr->value_tag)));
ef416fc2 5404
5405 /*
a2326b5b 5406 * Write the attribute tag and name.
ef416fc2 5407 *
5408 * The attribute name length does not include the trailing nul
5409 * character in the source string.
5410 *
5411 * Collection values (parent != NULL) are written differently...
5412 */
5413
5414 if (parent == NULL)
5415 {
5416 /*
5417 * Get the length of the attribute name, and make sure it won't
5418 * overflow the buffer...
5419 */
5420
a2326b5b 5421 if ((n = (int)strlen(attr->name)) > (IPP_BUF_SIZE - 8))
1f6f3dbc 5422 {
e07d4801 5423 DEBUG_printf(("1ippWriteIO: Attribute name too long (%d)", n));
dcb445bc 5424 _cupsBufferRelease((char *)buffer);
cb7f98ee 5425 return (IPP_STATE_ERROR);
1f6f3dbc 5426 }
ef416fc2 5427
5428 /*
5429 * Write the value tag, name length, and name string...
5430 */
5431
e07d4801 5432 DEBUG_printf(("2ippWriteIO: writing value tag=%x(%s)",
1ff0402e 5433 attr->value_tag, ippTagString(attr->value_tag)));
e07d4801 5434 DEBUG_printf(("2ippWriteIO: writing name=%d,\"%s\"", n,
1ff0402e 5435 attr->name));
ef416fc2 5436
a2326b5b
MS
5437 if (attr->value_tag > 0xff)
5438 {
5439 *bufptr++ = IPP_TAG_EXTENSION;
7e86f2f6
MS
5440 *bufptr++ = (ipp_uchar_t)(attr->value_tag >> 24);
5441 *bufptr++ = (ipp_uchar_t)(attr->value_tag >> 16);
5442 *bufptr++ = (ipp_uchar_t)(attr->value_tag >> 8);
5443 *bufptr++ = (ipp_uchar_t)attr->value_tag;
a2326b5b
MS
5444 }
5445 else
7e86f2f6 5446 *bufptr++ = (ipp_uchar_t)attr->value_tag;
a2326b5b 5447
7e86f2f6
MS
5448 *bufptr++ = (ipp_uchar_t)(n >> 8);
5449 *bufptr++ = (ipp_uchar_t)n;
07623986 5450 memcpy(bufptr, attr->name, (size_t)n);
ef416fc2 5451 bufptr += n;
5452 }
5453 else
5454 {
5455 /*
5456 * Get the length of the attribute name, and make sure it won't
5457 * overflow the buffer...
5458 */
5459
a2326b5b 5460 if ((n = (int)strlen(attr->name)) > (IPP_BUF_SIZE - 12))
1f6f3dbc 5461 {
e07d4801 5462 DEBUG_printf(("1ippWriteIO: Attribute name too long (%d)", n));
dcb445bc 5463 _cupsBufferRelease((char *)buffer);
cb7f98ee 5464 return (IPP_STATE_ERROR);
1f6f3dbc 5465 }
ef416fc2 5466
5467 /*
5468 * Write the member name tag, name length, name string, value tag,
5469 * and empty name for the collection member attribute...
5470 */
5471
e07d4801 5472 DEBUG_printf(("2ippWriteIO: writing value tag=%x(memberName)",
ef416fc2 5473 IPP_TAG_MEMBERNAME));
e07d4801 5474 DEBUG_printf(("2ippWriteIO: writing name=%d,\"%s\"", n,
1ff0402e 5475 attr->name));
e07d4801 5476 DEBUG_printf(("2ippWriteIO: writing value tag=%x(%s)",
1ff0402e 5477 attr->value_tag, ippTagString(attr->value_tag)));
e07d4801 5478 DEBUG_puts("2ippWriteIO: writing name=0,\"\"");
ef416fc2 5479
5480 *bufptr++ = IPP_TAG_MEMBERNAME;
5481 *bufptr++ = 0;
5482 *bufptr++ = 0;
7e86f2f6
MS
5483 *bufptr++ = (ipp_uchar_t)(n >> 8);
5484 *bufptr++ = (ipp_uchar_t)n;
07623986 5485 memcpy(bufptr, attr->name, (size_t)n);
ef416fc2 5486 bufptr += n;
5487
a2326b5b
MS
5488 if (attr->value_tag > 0xff)
5489 {
5490 *bufptr++ = IPP_TAG_EXTENSION;
7e86f2f6
MS
5491 *bufptr++ = (ipp_uchar_t)(attr->value_tag >> 24);
5492 *bufptr++ = (ipp_uchar_t)(attr->value_tag >> 16);
5493 *bufptr++ = (ipp_uchar_t)(attr->value_tag >> 8);
5494 *bufptr++ = (ipp_uchar_t)attr->value_tag;
a2326b5b
MS
5495 }
5496 else
7e86f2f6 5497 *bufptr++ = (ipp_uchar_t)attr->value_tag;
a2326b5b 5498
ef416fc2 5499 *bufptr++ = 0;
5500 *bufptr++ = 0;
5501 }
5502
5503 /*
5504 * Now write the attribute value(s)...
5505 */
5506
cb7f98ee 5507 switch (attr->value_tag & ~IPP_TAG_CUPS_CONST)
ef416fc2 5508 {
a2326b5b
MS
5509 case IPP_TAG_UNSUPPORTED_VALUE :
5510 case IPP_TAG_DEFAULT :
5511 case IPP_TAG_UNKNOWN :
5512 case IPP_TAG_NOVALUE :
5513 case IPP_TAG_NOTSETTABLE :
5514 case IPP_TAG_DELETEATTR :
5515 case IPP_TAG_ADMINDEFINE :
5516 *bufptr++ = 0;
5517 *bufptr++ = 0;
5518 break;
5519
ef416fc2 5520 case IPP_TAG_INTEGER :
5521 case IPP_TAG_ENUM :
5522 for (i = 0, value = attr->values;
5523 i < attr->num_values;
5524 i ++, value ++)
5525 {
1f6f3dbc 5526 if ((IPP_BUF_SIZE - (bufptr - buffer)) < 9)
ef416fc2 5527 {
7e86f2f6 5528 if ((*cb)(dst, buffer, (size_t)(bufptr - buffer)) < 0)
ef416fc2 5529 {
e07d4801 5530 DEBUG_puts("1ippWriteIO: Could not write IPP "
1ff0402e 5531 "attribute...");
dcb445bc 5532 _cupsBufferRelease((char *)buffer);
cb7f98ee 5533 return (IPP_STATE_ERROR);
ef416fc2 5534 }
5535
5536 bufptr = buffer;
5537 }
5538
5539 if (i)
5540 {
5541 /*
5542 * Arrays and sets are done by sending additional
5543 * values with a zero-length name...
5544 */
5545
7e86f2f6 5546 *bufptr++ = (ipp_uchar_t)attr->value_tag;
ef416fc2 5547 *bufptr++ = 0;
5548 *bufptr++ = 0;
5549 }
5550
5551 /*
5552 * Integers and enumerations are both 4-byte signed
5553 * (twos-complement) values.
5554 *
5555 * Put the 2-byte length and 4-byte value into the buffer...
5556 */
5557
5558 *bufptr++ = 0;
5559 *bufptr++ = 4;
7e86f2f6
MS
5560 *bufptr++ = (ipp_uchar_t)(value->integer >> 24);
5561 *bufptr++ = (ipp_uchar_t)(value->integer >> 16);
5562 *bufptr++ = (ipp_uchar_t)(value->integer >> 8);
5563 *bufptr++ = (ipp_uchar_t)value->integer;
ef416fc2 5564 }
5565 break;
5566
5567 case IPP_TAG_BOOLEAN :
5568 for (i = 0, value = attr->values;
5569 i < attr->num_values;
5570 i ++, value ++)
5571 {
1f6f3dbc 5572 if ((IPP_BUF_SIZE - (bufptr - buffer)) < 6)
ef416fc2 5573 {
7e86f2f6 5574 if ((*cb)(dst, buffer, (size_t)(bufptr - buffer)) < 0)
ef416fc2 5575 {
e07d4801 5576 DEBUG_puts("1ippWriteIO: Could not write IPP "
1ff0402e 5577 "attribute...");
dcb445bc 5578 _cupsBufferRelease((char *)buffer);
cb7f98ee 5579 return (IPP_STATE_ERROR);
ef416fc2 5580 }
5581
5582 bufptr = buffer;
5583 }
5584
5585 if (i)
5586 {
5587 /*
5588 * Arrays and sets are done by sending additional
5589 * values with a zero-length name...
5590 */
5591
7e86f2f6 5592 *bufptr++ = (ipp_uchar_t)attr->value_tag;
ef416fc2 5593 *bufptr++ = 0;
5594 *bufptr++ = 0;
5595 }
5596
5597 /*
5598 * Boolean values are 1-byte; 0 = false, 1 = true.
5599 *
5600 * Put the 2-byte length and 1-byte value into the buffer...
5601 */
5602
5603 *bufptr++ = 0;
5604 *bufptr++ = 1;
7e86f2f6 5605 *bufptr++ = (ipp_uchar_t)value->boolean;
ef416fc2 5606 }
5607 break;
5608
5609 case IPP_TAG_TEXT :
5610 case IPP_TAG_NAME :
5611 case IPP_TAG_KEYWORD :
ef416fc2 5612 case IPP_TAG_URI :
5613 case IPP_TAG_URISCHEME :
5614 case IPP_TAG_CHARSET :
5615 case IPP_TAG_LANGUAGE :
5616 case IPP_TAG_MIMETYPE :
5617 for (i = 0, value = attr->values;
5618 i < attr->num_values;
5619 i ++, value ++)
5620 {
5621 if (i)
5622 {
5623 /*
5624 * Arrays and sets are done by sending additional
5625 * values with a zero-length name...
5626 */
5627
e07d4801 5628 DEBUG_printf(("2ippWriteIO: writing value tag=%x(%s)",
1ff0402e
MS
5629 attr->value_tag,
5630 ippTagString(attr->value_tag)));
e07d4801 5631 DEBUG_printf(("2ippWriteIO: writing name=0,\"\""));
ef416fc2 5632
1f6f3dbc 5633 if ((IPP_BUF_SIZE - (bufptr - buffer)) < 3)
ef416fc2 5634 {
7e86f2f6 5635 if ((*cb)(dst, buffer, (size_t)(bufptr - buffer)) < 0)
ef416fc2 5636 {
e07d4801 5637 DEBUG_puts("1ippWriteIO: Could not write IPP "
1ff0402e 5638 "attribute...");
dcb445bc 5639 _cupsBufferRelease((char *)buffer);
cb7f98ee 5640 return (IPP_STATE_ERROR);
ef416fc2 5641 }
5642
5643 bufptr = buffer;
5644 }
5645
7e86f2f6 5646 *bufptr++ = (ipp_uchar_t)attr->value_tag;
ef416fc2 5647 *bufptr++ = 0;
5648 *bufptr++ = 0;
5649 }
5650
5651 if (value->string.text != NULL)
5652 n = (int)strlen(value->string.text);
5653 else
5654 n = 0;
5655
1f6f3dbc
MS
5656 if (n > (IPP_BUF_SIZE - 2))
5657 {
e07d4801 5658 DEBUG_printf(("1ippWriteIO: String too long (%d)", n));
dcb445bc 5659 _cupsBufferRelease((char *)buffer);
cb7f98ee 5660 return (IPP_STATE_ERROR);
1f6f3dbc 5661 }
ef416fc2 5662
e07d4801 5663 DEBUG_printf(("2ippWriteIO: writing string=%d,\"%s\"", n,
ef416fc2 5664 value->string.text));
5665
1f6f3dbc 5666 if ((int)(IPP_BUF_SIZE - (bufptr - buffer)) < (n + 2))
ef416fc2 5667 {
7e86f2f6 5668 if ((*cb)(dst, buffer, (size_t)(bufptr - buffer)) < 0)
ef416fc2 5669 {
e07d4801 5670 DEBUG_puts("1ippWriteIO: Could not write IPP "
1ff0402e 5671 "attribute...");
dcb445bc 5672 _cupsBufferRelease((char *)buffer);
cb7f98ee 5673 return (IPP_STATE_ERROR);
ef416fc2 5674 }
5675
5676 bufptr = buffer;
5677 }
5678
5679 /*
5680 * All simple strings consist of the 2-byte length and
5681 * character data without the trailing nul normally found
a41f09e2 5682 * in C strings. Also, strings cannot be longer than IPP_MAX_LENGTH
ef416fc2 5683 * bytes since the 2-byte length is a signed (twos-complement)
5684 * value.
5685 *
5686 * Put the 2-byte length and string characters in the buffer.
5687 */
5688
7e86f2f6
MS
5689 *bufptr++ = (ipp_uchar_t)(n >> 8);
5690 *bufptr++ = (ipp_uchar_t)n;
ef416fc2 5691
5692 if (n > 0)
5693 {
07623986 5694 memcpy(bufptr, value->string.text, (size_t)n);
ef416fc2 5695 bufptr += n;
5696 }
5697 }
5698 break;
5699
5700 case IPP_TAG_DATE :
5701 for (i = 0, value = attr->values;
5702 i < attr->num_values;
5703 i ++, value ++)
5704 {
1f6f3dbc 5705 if ((IPP_BUF_SIZE - (bufptr - buffer)) < 16)
ef416fc2 5706 {
7e86f2f6 5707 if ((*cb)(dst, buffer, (size_t)(bufptr - buffer)) < 0)
ef416fc2 5708 {
e07d4801 5709 DEBUG_puts("1ippWriteIO: Could not write IPP "
1ff0402e 5710 "attribute...");
dcb445bc 5711 _cupsBufferRelease((char *)buffer);
cb7f98ee 5712 return (IPP_STATE_ERROR);
ef416fc2 5713 }
5714
5715 bufptr = buffer;
5716 }
5717
5718 if (i)
5719 {
5720 /*
5721 * Arrays and sets are done by sending additional
5722 * values with a zero-length name...
5723 */
5724
7e86f2f6 5725 *bufptr++ = (ipp_uchar_t)attr->value_tag;
ef416fc2 5726 *bufptr++ = 0;
5727 *bufptr++ = 0;
5728 }
5729
5730 /*
5731 * Date values consist of a 2-byte length and an
5732 * 11-byte date/time structure defined by RFC 1903.
5733 *
5734 * Put the 2-byte length and 11-byte date/time
5735 * structure in the buffer.
5736 */
5737
5738 *bufptr++ = 0;
5739 *bufptr++ = 11;
5740 memcpy(bufptr, value->date, 11);
5741 bufptr += 11;
5742 }
5743 break;
5744
5745 case IPP_TAG_RESOLUTION :
5746 for (i = 0, value = attr->values;
5747 i < attr->num_values;
5748 i ++, value ++)
5749 {
1f6f3dbc 5750 if ((IPP_BUF_SIZE - (bufptr - buffer)) < 14)
ef416fc2 5751 {
7e86f2f6 5752 if ((*cb)(dst, buffer, (size_t)(bufptr - buffer)) < 0)
ef416fc2 5753 {
e07d4801 5754 DEBUG_puts("1ippWriteIO: Could not write IPP "
1ff0402e 5755 "attribute...");
dcb445bc 5756 _cupsBufferRelease((char *)buffer);
cb7f98ee 5757 return (IPP_STATE_ERROR);
ef416fc2 5758 }
5759
5760 bufptr = buffer;
5761 }
5762
5763 if (i)
5764 {
5765 /*
5766 * Arrays and sets are done by sending additional
5767 * values with a zero-length name...
5768 */
5769
7e86f2f6 5770 *bufptr++ = (ipp_uchar_t)attr->value_tag;
ef416fc2 5771 *bufptr++ = 0;
5772 *bufptr++ = 0;
5773 }
5774
5775 /*
5776 * Resolution values consist of a 2-byte length,
5777 * 4-byte horizontal resolution value, 4-byte vertical
5778 * resolution value, and a 1-byte units value.
5779 *
5780 * Put the 2-byte length and resolution value data
5781 * into the buffer.
5782 */
5783
5784 *bufptr++ = 0;
5785 *bufptr++ = 9;
7e86f2f6
MS
5786 *bufptr++ = (ipp_uchar_t)(value->resolution.xres >> 24);
5787 *bufptr++ = (ipp_uchar_t)(value->resolution.xres >> 16);
5788 *bufptr++ = (ipp_uchar_t)(value->resolution.xres >> 8);
5789 *bufptr++ = (ipp_uchar_t)value->resolution.xres;
5790 *bufptr++ = (ipp_uchar_t)(value->resolution.yres >> 24);
5791 *bufptr++ = (ipp_uchar_t)(value->resolution.yres >> 16);
5792 *bufptr++ = (ipp_uchar_t)(value->resolution.yres >> 8);
5793 *bufptr++ = (ipp_uchar_t)value->resolution.yres;
5794 *bufptr++ = (ipp_uchar_t)value->resolution.units;
ef416fc2 5795 }
5796 break;
5797
5798 case IPP_TAG_RANGE :
5799 for (i = 0, value = attr->values;
5800 i < attr->num_values;
5801 i ++, value ++)
5802 {
1f6f3dbc 5803 if ((IPP_BUF_SIZE - (bufptr - buffer)) < 13)
ef416fc2 5804 {
7e86f2f6 5805 if ((*cb)(dst, buffer, (size_t)(bufptr - buffer)) < 0)
ef416fc2 5806 {
e07d4801 5807 DEBUG_puts("1ippWriteIO: Could not write IPP "
1ff0402e 5808 "attribute...");
dcb445bc 5809 _cupsBufferRelease((char *)buffer);
cb7f98ee 5810 return (IPP_STATE_ERROR);
ef416fc2 5811 }
5812
5813 bufptr = buffer;
5814 }
5815
5816 if (i)
5817 {
5818 /*
5819 * Arrays and sets are done by sending additional
5820 * values with a zero-length name...
5821 */
5822
7e86f2f6 5823 *bufptr++ = (ipp_uchar_t)attr->value_tag;
ef416fc2 5824 *bufptr++ = 0;
5825 *bufptr++ = 0;
5826 }
5827
5828 /*
5829 * Range values consist of a 2-byte length,
5830 * 4-byte lower value, and 4-byte upper value.
5831 *
5832 * Put the 2-byte length and range value data
5833 * into the buffer.
5834 */
5835
5836 *bufptr++ = 0;
5837 *bufptr++ = 8;
7e86f2f6
MS
5838 *bufptr++ = (ipp_uchar_t)(value->range.lower >> 24);
5839 *bufptr++ = (ipp_uchar_t)(value->range.lower >> 16);
5840 *bufptr++ = (ipp_uchar_t)(value->range.lower >> 8);
5841 *bufptr++ = (ipp_uchar_t)value->range.lower;
5842 *bufptr++ = (ipp_uchar_t)(value->range.upper >> 24);
5843 *bufptr++ = (ipp_uchar_t)(value->range.upper >> 16);
5844 *bufptr++ = (ipp_uchar_t)(value->range.upper >> 8);
5845 *bufptr++ = (ipp_uchar_t)value->range.upper;
ef416fc2 5846 }
5847 break;
5848
5849 case IPP_TAG_TEXTLANG :
5850 case IPP_TAG_NAMELANG :
5851 for (i = 0, value = attr->values;
5852 i < attr->num_values;
5853 i ++, value ++)
5854 {
5855 if (i)
5856 {
5857 /*
5858 * Arrays and sets are done by sending additional
5859 * values with a zero-length name...
5860 */
5861
1f6f3dbc 5862 if ((IPP_BUF_SIZE - (bufptr - buffer)) < 3)
ef416fc2 5863 {
7e86f2f6 5864 if ((*cb)(dst, buffer, (size_t)(bufptr - buffer)) < 0)
ef416fc2 5865 {
e07d4801 5866 DEBUG_puts("1ippWriteIO: Could not write IPP "
1ff0402e 5867 "attribute...");
dcb445bc 5868 _cupsBufferRelease((char *)buffer);
cb7f98ee 5869 return (IPP_STATE_ERROR);
ef416fc2 5870 }
5871
5872 bufptr = buffer;
5873 }
5874
7e86f2f6 5875 *bufptr++ = (ipp_uchar_t)attr->value_tag;
ef416fc2 5876 *bufptr++ = 0;
5877 *bufptr++ = 0;
5878 }
5879
5880 /*
5881 * textWithLanguage and nameWithLanguage values consist
5882 * of a 2-byte length for both strings and their
5883 * individual lengths, a 2-byte length for the
5884 * character string, the character string without the
5885 * trailing nul, a 2-byte length for the character
5886 * set string, and the character set string without
5887 * the trailing nul.
5888 */
5889
5890 n = 4;
5891
a2326b5b
MS
5892 if (value->string.language != NULL)
5893 n += (int)strlen(value->string.language);
ef416fc2 5894
5895 if (value->string.text != NULL)
b86bc4cf 5896 n += (int)strlen(value->string.text);
ef416fc2 5897
1f6f3dbc
MS
5898 if (n > (IPP_BUF_SIZE - 2))
5899 {
e07d4801
MS
5900 DEBUG_printf(("1ippWriteIO: text/nameWithLanguage value "
5901 "too long (%d)", n));
dcb445bc 5902 _cupsBufferRelease((char *)buffer);
cb7f98ee 5903 return (IPP_STATE_ERROR);
1f6f3dbc 5904 }
ef416fc2 5905
1f6f3dbc 5906 if ((int)(IPP_BUF_SIZE - (bufptr - buffer)) < (n + 2))
ef416fc2 5907 {
7e86f2f6 5908 if ((*cb)(dst, buffer, (size_t)(bufptr - buffer)) < 0)
ef416fc2 5909 {
e07d4801 5910 DEBUG_puts("1ippWriteIO: Could not write IPP "
1ff0402e 5911 "attribute...");
dcb445bc 5912 _cupsBufferRelease((char *)buffer);
cb7f98ee 5913 return (IPP_STATE_ERROR);
ef416fc2 5914 }
5915
5916 bufptr = buffer;
5917 }
5918
5919 /* Length of entire value */
7e86f2f6
MS
5920 *bufptr++ = (ipp_uchar_t)(n >> 8);
5921 *bufptr++ = (ipp_uchar_t)n;
ef416fc2 5922
a2326b5b
MS
5923 /* Length of language */
5924 if (value->string.language != NULL)
5925 n = (int)strlen(value->string.language);
ef416fc2 5926 else
5927 n = 0;
5928
7e86f2f6
MS
5929 *bufptr++ = (ipp_uchar_t)(n >> 8);
5930 *bufptr++ = (ipp_uchar_t)n;
ef416fc2 5931
a2326b5b 5932 /* Language */
ef416fc2 5933 if (n > 0)
5934 {
07623986 5935 memcpy(bufptr, value->string.language, (size_t)n);
ef416fc2 5936 bufptr += n;
5937 }
5938
5939 /* Length of text */
5940 if (value->string.text != NULL)
5941 n = (int)strlen(value->string.text);
5942 else
5943 n = 0;
5944
7e86f2f6
MS
5945 *bufptr++ = (ipp_uchar_t)(n >> 8);
5946 *bufptr++ = (ipp_uchar_t)n;
ef416fc2 5947
5948 /* Text */
5949 if (n > 0)
5950 {
07623986 5951 memcpy(bufptr, value->string.text, (size_t)n);
ef416fc2 5952 bufptr += n;
5953 }
5954 }
5955 break;
5956
5957 case IPP_TAG_BEGIN_COLLECTION :
5958 for (i = 0, value = attr->values;
5959 i < attr->num_values;
5960 i ++, value ++)
5961 {
5962 /*
5963 * Collections are written with the begin-collection
5964 * tag first with a value of 0 length, followed by the
5965 * attributes in the collection, then the end-collection
5966 * value...
5967 */
5968
1f6f3dbc 5969 if ((IPP_BUF_SIZE - (bufptr - buffer)) < 5)
ef416fc2 5970 {
7e86f2f6 5971 if ((*cb)(dst, buffer, (size_t)(bufptr - buffer)) < 0)
ef416fc2 5972 {
e07d4801 5973 DEBUG_puts("1ippWriteIO: Could not write IPP "
1ff0402e 5974 "attribute...");
dcb445bc 5975 _cupsBufferRelease((char *)buffer);
cb7f98ee 5976 return (IPP_STATE_ERROR);
ef416fc2 5977 }
5978
5979 bufptr = buffer;
5980 }
5981
5982 if (i)
5983 {
5984 /*
5985 * Arrays and sets are done by sending additional
5986 * values with a zero-length name...
5987 */
5988
7e86f2f6 5989 *bufptr++ = (ipp_uchar_t)attr->value_tag;
ef416fc2 5990 *bufptr++ = 0;
5991 *bufptr++ = 0;
5992 }
5993
5994 /*
5995 * Write a data length of 0 and flush the buffer...
5996 */
5997
5998 *bufptr++ = 0;
5999 *bufptr++ = 0;
6000
7e86f2f6 6001 if ((*cb)(dst, buffer, (size_t)(bufptr - buffer)) < 0)
ef416fc2 6002 {
e07d4801 6003 DEBUG_puts("1ippWriteIO: Could not write IPP "
1ff0402e 6004 "attribute...");
dcb445bc 6005 _cupsBufferRelease((char *)buffer);
cb7f98ee 6006 return (IPP_STATE_ERROR);
ef416fc2 6007 }
6008
6009 bufptr = buffer;
6010
6011 /*
6012 * Then write the collection attribute...
6013 */
6014
cb7f98ee 6015 value->collection->state = IPP_STATE_IDLE;
ef416fc2 6016
1f6f3dbc 6017 if (ippWriteIO(dst, cb, 1, ipp,
cb7f98ee 6018 value->collection) == IPP_STATE_ERROR)
1f6f3dbc 6019 {
e07d4801 6020 DEBUG_puts("1ippWriteIO: Unable to write collection value");
dcb445bc 6021 _cupsBufferRelease((char *)buffer);
cb7f98ee 6022 return (IPP_STATE_ERROR);
1f6f3dbc 6023 }
ef416fc2 6024 }
6025 break;
6026
6027 default :
6028 for (i = 0, value = attr->values;
6029 i < attr->num_values;
6030 i ++, value ++)
6031 {
6032 if (i)
6033 {
6034 /*
6035 * Arrays and sets are done by sending additional
6036 * values with a zero-length name...
6037 */
6038
1f6f3dbc 6039 if ((IPP_BUF_SIZE - (bufptr - buffer)) < 3)
ef416fc2 6040 {
7e86f2f6 6041 if ((*cb)(dst, buffer, (size_t)(bufptr - buffer)) < 0)
ef416fc2 6042 {
e07d4801 6043 DEBUG_puts("1ippWriteIO: Could not write IPP "
1ff0402e 6044 "attribute...");
dcb445bc 6045 _cupsBufferRelease((char *)buffer);
cb7f98ee 6046 return (IPP_STATE_ERROR);
ef416fc2 6047 }
6048
6049 bufptr = buffer;
6050 }
6051
7e86f2f6 6052 *bufptr++ = (ipp_uchar_t)attr->value_tag;
ef416fc2 6053 *bufptr++ = 0;
6054 *bufptr++ = 0;
6055 }
6056
6057 /*
6058 * An unknown value might some new value that a
6059 * vendor has come up with. It consists of a
6060 * 2-byte length and the bytes in the unknown
6061 * value buffer.
6062 */
6063
6064 n = value->unknown.length;
6065
1f6f3dbc
MS
6066 if (n > (IPP_BUF_SIZE - 2))
6067 {
e07d4801 6068 DEBUG_printf(("1ippWriteIO: Data length too long (%d)",
1f6f3dbc 6069 n));
dcb445bc 6070 _cupsBufferRelease((char *)buffer);
cb7f98ee 6071 return (IPP_STATE_ERROR);
1f6f3dbc 6072 }
ef416fc2 6073
1f6f3dbc 6074 if ((int)(IPP_BUF_SIZE - (bufptr - buffer)) < (n + 2))
ef416fc2 6075 {
7e86f2f6 6076 if ((*cb)(dst, buffer, (size_t)(bufptr - buffer)) < 0)
ef416fc2 6077 {
e07d4801 6078 DEBUG_puts("1ippWriteIO: Could not write IPP "
1ff0402e 6079 "attribute...");
dcb445bc 6080 _cupsBufferRelease((char *)buffer);
cb7f98ee 6081 return (IPP_STATE_ERROR);
ef416fc2 6082 }
6083
6084 bufptr = buffer;
6085 }
6086
6087 /* Length of unknown value */
7e86f2f6
MS
6088 *bufptr++ = (ipp_uchar_t)(n >> 8);
6089 *bufptr++ = (ipp_uchar_t)n;
ef416fc2 6090
6091 /* Value */
6092 if (n > 0)
6093 {
07623986 6094 memcpy(bufptr, value->unknown.data, (size_t)n);
ef416fc2 6095 bufptr += n;
6096 }
6097 }
6098 break;
6099 }
6100
6101 /*
6102 * Write the data out...
6103 */
6104
ba55dc12 6105 if (bufptr > buffer)
ef416fc2 6106 {
7e86f2f6 6107 if ((*cb)(dst, buffer, (size_t)(bufptr - buffer)) < 0)
ba55dc12
MS
6108 {
6109 DEBUG_puts("1ippWriteIO: Could not write IPP attribute...");
dcb445bc 6110 _cupsBufferRelease((char *)buffer);
cb7f98ee 6111 return (IPP_STATE_ERROR);
ba55dc12 6112 }
ef416fc2 6113
ba55dc12
MS
6114 DEBUG_printf(("2ippWriteIO: wrote %d bytes",
6115 (int)(bufptr - buffer)));
6116 }
ef416fc2 6117
6118 /*
21f36711
MS
6119 * If blocking is disabled and we aren't at the end of the attribute
6120 * list, stop here...
ef416fc2 6121 */
6122
21f36711 6123 if (!blocking && ipp->current)
ef416fc2 6124 break;
6125 }
6126
6127 if (ipp->current == NULL)
6128 {
6129 /*
6130 * Done with all of the attributes; add the end-of-attributes
6131 * tag or end-collection attribute...
6132 */
6133
6134 if (parent == NULL)
6135 {
6136 buffer[0] = IPP_TAG_END;
6137 n = 1;
6138 }
6139 else
6140 {
6141 buffer[0] = IPP_TAG_END_COLLECTION;
6142 buffer[1] = 0; /* empty name */
6143 buffer[2] = 0;
6144 buffer[3] = 0; /* empty value */
6145 buffer[4] = 0;
6146 n = 5;
6147 }
6148
7e86f2f6 6149 if ((*cb)(dst, buffer, (size_t)n) < 0)
ef416fc2 6150 {
e07d4801 6151 DEBUG_puts("1ippWriteIO: Could not write IPP end-tag...");
dcb445bc 6152 _cupsBufferRelease((char *)buffer);
cb7f98ee 6153 return (IPP_STATE_ERROR);
ef416fc2 6154 }
6155
cb7f98ee 6156 ipp->state = IPP_STATE_DATA;
ef416fc2 6157 }
6158 break;
6159
cb7f98ee 6160 case IPP_STATE_DATA :
ef416fc2 6161 break;
6162
6163 default :
6164 break; /* anti-compiler-warning-code */
6165 }
6166
dcb445bc 6167 _cupsBufferRelease((char *)buffer);
1f6f3dbc 6168
ef416fc2 6169 return (ipp->state);
6170}
6171
6172
6173/*
a2326b5b 6174 * 'ipp_add_attr()' - Add a new attribute to the message.
ef416fc2 6175 */
6176
a2326b5b
MS
6177static ipp_attribute_t * /* O - New attribute */
6178ipp_add_attr(ipp_t *ipp, /* I - IPP message */
6179 const char *name, /* I - Attribute name or NULL */
6180 ipp_tag_t group_tag, /* I - Group tag or IPP_TAG_ZERO */
6181 ipp_tag_t value_tag, /* I - Value tag or IPP_TAG_ZERO */
6182 int num_values) /* I - Number of values */
ef416fc2 6183{
a2326b5b 6184 int alloc_values; /* Number of values to allocate */
ef416fc2 6185 ipp_attribute_t *attr; /* New attribute */
6186
6187
807315e6 6188 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));
a2326b5b
MS
6189
6190 /*
6191 * Range check input...
6192 */
ef416fc2 6193
1ff0402e 6194 if (!ipp || num_values < 0)
ef416fc2 6195 return (NULL);
6196
a2326b5b
MS
6197 /*
6198 * Allocate memory, rounding the allocation up as needed...
6199 */
ef416fc2 6200
a2326b5b 6201 if (num_values <= 1)
9c80ffa2 6202 alloc_values = 1;
a2326b5b
MS
6203 else
6204 alloc_values = (num_values + IPP_MAX_VALUES - 1) & ~(IPP_MAX_VALUES - 1);
ef416fc2 6205
a2326b5b 6206 attr = calloc(sizeof(ipp_attribute_t) +
7e86f2f6 6207 (size_t)(alloc_values - 1) * sizeof(_ipp_value_t), 1);
ef416fc2 6208
a2326b5b 6209 if (attr)
ef416fc2 6210 {
a2326b5b
MS
6211 /*
6212 * Initialize attribute...
6213 */
ef416fc2 6214
b908d72c
MS
6215 DEBUG_printf(("4debug_alloc: %p %s %s%s (%d values)", (void *)attr, name, num_values > 1 ? "1setOf " : "", ippTagString(value_tag), num_values));
6216
a2326b5b
MS
6217 if (name)
6218 attr->name = _cupsStrAlloc(name);
ef416fc2 6219
a2326b5b
MS
6220 attr->group_tag = group_tag;
6221 attr->value_tag = value_tag;
6222 attr->num_values = num_values;
4400e98d 6223
a2326b5b
MS
6224 /*
6225 * Add it to the end of the linked list...
6226 */
4400e98d 6227
a2326b5b
MS
6228 if (ipp->last)
6229 ipp->last->next = attr;
6230 else
6231 ipp->attrs = attr;
5a738aea 6232
a2326b5b
MS
6233 ipp->prev = ipp->last;
6234 ipp->last = ipp->current = attr;
ef416fc2 6235 }
6236
807315e6 6237 DEBUG_printf(("5ipp_add_attr: Returning %p", (void *)attr));
ef416fc2 6238
a2326b5b 6239 return (attr);
ef416fc2 6240}
6241
6242
a2326b5b
MS
6243/*
6244 * 'ipp_free_values()' - Free attribute values.
6245 */
6246
6247static void
6248ipp_free_values(ipp_attribute_t *attr, /* I - Attribute to free values from */
6249 int element,/* I - First value to free */
6250 int count) /* I - Number of values to free */
6251{
6252 int i; /* Looping var */
6253 _ipp_value_t *value; /* Current value */
6254
6255
807315e6 6256 DEBUG_printf(("4ipp_free_values(attr=%p, element=%d, count=%d)", (void *)attr, element, count));
a2326b5b 6257
cb7f98ee 6258 if (!(attr->value_tag & IPP_TAG_CUPS_CONST))
a2326b5b
MS
6259 {
6260 /*
6261 * Free values as needed...
6262 */
6263
6264 switch (attr->value_tag)
6265 {
6266 case IPP_TAG_TEXTLANG :
6267 case IPP_TAG_NAMELANG :
5a9febac
MS
6268 if (element == 0 && count == attr->num_values &&
6269 attr->values[0].string.language)
6270 {
a2326b5b 6271 _cupsStrFree(attr->values[0].string.language);
5a9febac
MS
6272 attr->values[0].string.language = NULL;
6273 }
0fa6c7fa 6274 /* Fall through to other string values */
a2326b5b
MS
6275
6276 case IPP_TAG_TEXT :
6277 case IPP_TAG_NAME :
6278 case IPP_TAG_RESERVED_STRING :
6279 case IPP_TAG_KEYWORD :
6280 case IPP_TAG_URI :
6281 case IPP_TAG_URISCHEME :
6282 case IPP_TAG_CHARSET :
6283 case IPP_TAG_LANGUAGE :
6284 case IPP_TAG_MIMETYPE :
6285 for (i = count, value = attr->values + element;
6286 i > 0;
6287 i --, value ++)
5a9febac 6288 {
a2326b5b 6289 _cupsStrFree(value->string.text);
5a9febac
MS
6290 value->string.text = NULL;
6291 }
a2326b5b
MS
6292 break;
6293
22a3eea9 6294 case IPP_TAG_UNSUPPORTED_VALUE :
a2326b5b
MS
6295 case IPP_TAG_DEFAULT :
6296 case IPP_TAG_UNKNOWN :
6297 case IPP_TAG_NOVALUE :
6298 case IPP_TAG_NOTSETTABLE :
6299 case IPP_TAG_DELETEATTR :
6300 case IPP_TAG_ADMINDEFINE :
6301 case IPP_TAG_INTEGER :
6302 case IPP_TAG_ENUM :
6303 case IPP_TAG_BOOLEAN :
6304 case IPP_TAG_DATE :
6305 case IPP_TAG_RESOLUTION :
6306 case IPP_TAG_RANGE :
6307 break;
6308
6309 case IPP_TAG_BEGIN_COLLECTION :
6310 for (i = count, value = attr->values + element;
6311 i > 0;
6312 i --, value ++)
5a9febac 6313 {
a2326b5b 6314 ippDelete(value->collection);
5a9febac
MS
6315 value->collection = NULL;
6316 }
a2326b5b
MS
6317 break;
6318
6319 case IPP_TAG_STRING :
6320 default :
6321 for (i = count, value = attr->values + element;
6322 i > 0;
6323 i --, value ++)
5a9febac 6324 {
a2326b5b 6325 if (value->unknown.data)
5a9febac 6326 {
a2326b5b 6327 free(value->unknown.data);
5a9febac
MS
6328 value->unknown.data = NULL;
6329 }
6330 }
a2326b5b
MS
6331 break;
6332 }
6333 }
6334
6335 /*
6336 * If we are not freeing values from the end, move the remaining values up...
6337 */
6338
6339 if ((element + count) < attr->num_values)
6340 memmove(attr->values + element, attr->values + element + count,
7e86f2f6 6341 (size_t)(attr->num_values - count - element) * sizeof(_ipp_value_t));
a2326b5b
MS
6342
6343 attr->num_values -= count;
6344}
6345
6346
6347/*
6348 * 'ipp_get_code()' - Convert a C locale/charset name into an IPP language/charset code.
6349 *
6350 * This typically converts strings of the form "ll_CC", "ll-REGION", and "CHARSET_NUMBER"
6351 * to "ll-cc", "ll-region", and "charset-number", respectively.
6352 */
6353
6354static char * /* O - Language code string */
6355ipp_get_code(const char *value, /* I - Locale/charset string */
6356 char *buffer, /* I - String buffer */
6357 size_t bufsize) /* I - Size of string buffer */
6358{
6359 char *bufptr, /* Pointer into buffer */
6360 *bufend; /* End of buffer */
6361
6362
6363 /*
6364 * Convert values to lowercase and change _ to - as needed...
6365 */
6366
6367 for (bufptr = buffer, bufend = buffer + bufsize - 1;
6368 *value && bufptr < bufend;
6369 value ++)
6370 if (*value == '_')
6371 *bufptr++ = '-';
6372 else
7e86f2f6 6373 *bufptr++ = (char)_cups_tolower(*value);
a2326b5b
MS
6374
6375 *bufptr = '\0';
6376
6377 /*
6378 * Return the converted string...
6379 */
6380
6381 return (buffer);
6382}
6383
6384
6385/*
6386 * 'ipp_lang_code()' - Convert a C locale name into an IPP language code.
6387 *
6388 * This typically converts strings of the form "ll_CC" and "ll-REGION" to "ll-cc" and
6389 * "ll-region", respectively. It also converts the "C" (POSIX) locale to "en".
6390 */
6391
6392static char * /* O - Language code string */
6393ipp_lang_code(const char *locale, /* I - Locale string */
6394 char *buffer, /* I - String buffer */
6395 size_t bufsize) /* I - Size of string buffer */
6396{
6397 /*
6398 * Map POSIX ("C") locale to generic English, otherwise convert the locale string as-is.
6399 */
6400
6401 if (!_cups_strcasecmp(locale, "c"))
6402 {
6403 strlcpy(buffer, "en", bufsize);
6404 return (buffer);
6405 }
6406 else
6407 return (ipp_get_code(locale, buffer, bufsize));
6408}
6409
6410
ef416fc2 6411/*
6412 * 'ipp_length()' - Compute the length of an IPP message or collection value.
6413 */
6414
6415static size_t /* O - Size of IPP message */
6416ipp_length(ipp_t *ipp, /* I - IPP message or collection */
6417 int collection) /* I - 1 if a collection, 0 otherwise */
6418{
6419 int i; /* Looping var */
a2326b5b 6420 size_t bytes; /* Number of bytes */
ef416fc2 6421 ipp_attribute_t *attr; /* Current attribute */
6422 ipp_tag_t group; /* Current group */
a2326b5b
MS
6423 _ipp_value_t *value; /* Current value */
6424
ef416fc2 6425
807315e6 6426 DEBUG_printf(("3ipp_length(ipp=%p, collection=%d)", (void *)ipp, collection));
ef416fc2 6427
a2326b5b
MS
6428 if (!ipp)
6429 {
6430 DEBUG_puts("4ipp_length: Returning 0 bytes");
ef416fc2 6431 return (0);
a2326b5b 6432 }
ef416fc2 6433
6434 /*
6435 * Start with 8 bytes for the IPP message header...
6436 */
6437
6438 bytes = collection ? 0 : 8;
6439
6440 /*
6441 * Then add the lengths of each attribute...
6442 */
6443
6444 group = IPP_TAG_ZERO;
6445
6446 for (attr = ipp->attrs; attr != NULL; attr = attr->next)
6447 {
6448 if (attr->group_tag != group && !collection)
6449 {
6450 group = attr->group_tag;
6451 if (group == IPP_TAG_ZERO)
6452 continue;
6453
6454 bytes ++; /* Group tag */
6455 }
6456
6457 if (!attr->name)
6458 continue;
6459
a2326b5b
MS
6460 DEBUG_printf(("5ipp_length: attr->name=\"%s\", attr->num_values=%d, "
6461 "bytes=" CUPS_LLFMT, attr->name, attr->num_values, CUPS_LLCAST bytes));
ef416fc2 6462
426184cb 6463 if ((attr->value_tag & ~IPP_TAG_CUPS_CONST) < IPP_TAG_EXTENSION)
7e86f2f6 6464 bytes += (size_t)attr->num_values;/* Value tag for each value */
a2326b5b 6465 else
7e86f2f6
MS
6466 bytes += (size_t)(5 * attr->num_values);
6467 /* Value tag for each value */
6468 bytes += (size_t)(2 * attr->num_values);
6469 /* Name lengths */
6470 bytes += strlen(attr->name); /* Name */
6471 bytes += (size_t)(2 * attr->num_values);
6472 /* Value lengths */
ef416fc2 6473
6474 if (collection)
6475 bytes += 5; /* Add membername overhead */
6476
cb7f98ee 6477 switch (attr->value_tag & ~IPP_TAG_CUPS_CONST)
ef416fc2 6478 {
a2326b5b
MS
6479 case IPP_TAG_UNSUPPORTED_VALUE :
6480 case IPP_TAG_DEFAULT :
6481 case IPP_TAG_UNKNOWN :
6482 case IPP_TAG_NOVALUE :
6483 case IPP_TAG_NOTSETTABLE :
6484 case IPP_TAG_DELETEATTR :
6485 case IPP_TAG_ADMINDEFINE :
6486 break;
6487
ef416fc2 6488 case IPP_TAG_INTEGER :
6489 case IPP_TAG_ENUM :
7e86f2f6 6490 bytes += (size_t)(4 * attr->num_values);
ef416fc2 6491 break;
6492
6493 case IPP_TAG_BOOLEAN :
7e86f2f6 6494 bytes += (size_t)attr->num_values;
ef416fc2 6495 break;
6496
6497 case IPP_TAG_TEXT :
6498 case IPP_TAG_NAME :
6499 case IPP_TAG_KEYWORD :
ef416fc2 6500 case IPP_TAG_URI :
6501 case IPP_TAG_URISCHEME :
6502 case IPP_TAG_CHARSET :
6503 case IPP_TAG_LANGUAGE :
6504 case IPP_TAG_MIMETYPE :
6505 for (i = 0, value = attr->values;
6506 i < attr->num_values;
6507 i ++, value ++)
a2326b5b
MS
6508 if (value->string.text)
6509 bytes += strlen(value->string.text);
ef416fc2 6510 break;
6511
6512 case IPP_TAG_DATE :
7e86f2f6 6513 bytes += (size_t)(11 * attr->num_values);
ef416fc2 6514 break;
6515
6516 case IPP_TAG_RESOLUTION :
7e86f2f6 6517 bytes += (size_t)(9 * attr->num_values);
ef416fc2 6518 break;
6519
6520 case IPP_TAG_RANGE :
7e86f2f6 6521 bytes += (size_t)(8 * attr->num_values);
ef416fc2 6522 break;
6523
6524 case IPP_TAG_TEXTLANG :
6525 case IPP_TAG_NAMELANG :
7e86f2f6
MS
6526 bytes += (size_t)(4 * attr->num_values);
6527 /* Charset + text length */
ef416fc2 6528
6529 for (i = 0, value = attr->values;
6530 i < attr->num_values;
6531 i ++, value ++)
6532 {
a2326b5b
MS
6533 if (value->string.language)
6534 bytes += strlen(value->string.language);
ef416fc2 6535
a2326b5b
MS
6536 if (value->string.text)
6537 bytes += strlen(value->string.text);
ef416fc2 6538 }
6539 break;
6540
6541 case IPP_TAG_BEGIN_COLLECTION :
6542 for (i = 0, value = attr->values;
6543 i < attr->num_values;
6544 i ++, value ++)
a2326b5b 6545 bytes += ipp_length(value->collection, 1);
ef416fc2 6546 break;
6547
6548 default :
6549 for (i = 0, value = attr->values;
6550 i < attr->num_values;
6551 i ++, value ++)
7e86f2f6 6552 bytes += (size_t)value->unknown.length;
ef416fc2 6553 break;
6554 }
6555 }
6556
6557 /*
6558 * Finally, add 1 byte for the "end of attributes" tag or 5 bytes
6559 * for the "end of collection" tag and return...
6560 */
6561
6562 if (collection)
6563 bytes += 5;
6564 else
6565 bytes ++;
6566
a2326b5b 6567 DEBUG_printf(("4ipp_length: Returning " CUPS_LLFMT " bytes", CUPS_LLCAST bytes));
ef416fc2 6568
6569 return (bytes);
6570}
6571
6572
6573/*
6574 * 'ipp_read_http()' - Semi-blocking read on a HTTP connection...
6575 */
6576
a4d04587 6577static ssize_t /* O - Number of bytes read */
ef416fc2 6578ipp_read_http(http_t *http, /* I - Client connection */
6579 ipp_uchar_t *buffer, /* O - Buffer for data */
a4d04587 6580 size_t length) /* I - Total length */
ef416fc2 6581{
7e86f2f6
MS
6582 ssize_t tbytes, /* Total bytes read */
6583 bytes; /* Bytes read this pass */
aaf19ab0 6584
ef416fc2 6585
807315e6 6586 DEBUG_printf(("7ipp_read_http(http=%p, buffer=%p, length=%d)", (void *)http, (void *)buffer, (int)length));
ef416fc2 6587
6588 /*
6589 * Loop until all bytes are read...
6590 */
6591
ae71f5de
MS
6592 for (tbytes = 0, bytes = 0;
6593 tbytes < (int)length;
6594 tbytes += bytes, buffer += bytes)
ef416fc2 6595 {
7e86f2f6 6596 DEBUG_printf(("9ipp_read_http: tbytes=" CUPS_LLFMT ", http->state=%d", CUPS_LLCAST tbytes, http->state));
ef416fc2 6597
cb7f98ee 6598 if (http->state == HTTP_STATE_WAITING)
ef416fc2 6599 break;
6600
a29fd7dd 6601 if (http->used == 0 && !http->blocking)
ef416fc2 6602 {
6603 /*
a29fd7dd 6604 * Wait up to 10 seconds for more data on non-blocking sockets...
ef416fc2 6605 */
6606
a29fd7dd 6607 if (!httpWait(http, 10000))
ef416fc2 6608 {
6609 /*
a29fd7dd 6610 * Signal no data...
ef416fc2 6611 */
6612
a29fd7dd
MS
6613 bytes = -1;
6614 break;
ef416fc2 6615 }
a29fd7dd 6616 }
ba7900a5
MS
6617 else if (http->used == 0 && http->timeout_value > 0)
6618 {
6619 /*
6620 * Wait up to timeout seconds for more data on blocking sockets...
6621 */
6622
6623 if (!httpWait(http, (int)(1000 * http->timeout_value)))
6624 {
6625 /*
6626 * Signal no data...
6627 */
6628
6629 bytes = -1;
6630 break;
6631 }
6632 }
ef416fc2 6633
7e86f2f6 6634 if ((bytes = httpRead2(http, (char *)buffer, length - (size_t)tbytes)) < 0)
a29fd7dd 6635 {
19dc16f7 6636#ifdef _WIN32
a29fd7dd 6637 break;
d1c13e16 6638#else
a29fd7dd
MS
6639 if (errno != EAGAIN && errno != EINTR)
6640 break;
d1c13e16 6641
a29fd7dd 6642 bytes = 0;
19dc16f7 6643#endif /* _WIN32 */
ef416fc2 6644 }
a29fd7dd
MS
6645 else if (bytes == 0)
6646 break;
ef416fc2 6647 }
6648
6649 /*
6650 * Return the number of bytes read...
6651 */
6652
6653 if (tbytes == 0 && bytes < 0)
6654 tbytes = -1;
6655
7e86f2f6 6656 DEBUG_printf(("8ipp_read_http: Returning " CUPS_LLFMT " bytes", CUPS_LLCAST tbytes));
ef416fc2 6657
6658 return (tbytes);
6659}
6660
6661
6662/*
6663 * 'ipp_read_file()' - Read IPP data from a file.
6664 */
6665
a4d04587 6666static ssize_t /* O - Number of bytes read */
ef416fc2 6667ipp_read_file(int *fd, /* I - File descriptor */
6668 ipp_uchar_t *buffer, /* O - Read buffer */
a4d04587 6669 size_t length) /* I - Number of bytes to read */
ef416fc2 6670{
19dc16f7 6671#ifdef _WIN32
b86bc4cf 6672 return ((ssize_t)read(*fd, buffer, (unsigned)length));
6673#else
ef416fc2 6674 return (read(*fd, buffer, length));
19dc16f7 6675#endif /* _WIN32 */
ef416fc2 6676}
6677
6678
c1420c87
MS
6679/*
6680 * 'ipp_set_error()' - Set a formatted, localized error string.
6681 */
6682
6683static void
6684ipp_set_error(ipp_status_t status, /* I - Status code */
6685 const char *format, /* I - Printf-style error string */
6686 ...) /* I - Additional arguments as needed */
6687{
6688 va_list ap; /* Pointer to additional args */
6689 char buffer[2048]; /* Message buffer */
6690 cups_lang_t *lang = cupsLangDefault();
6691 /* Current language */
6692
6693
6694 va_start(ap, format);
6695 vsnprintf(buffer, sizeof(buffer), _cupsLangString(lang, format), ap);
6696 va_end(ap);
6697
6698 _cupsSetError(status, buffer, 0);
6699}
6700
6701
a2326b5b 6702/*
9c80ffa2
MS
6703 * 'ipp_set_value()' - Get the value element from an attribute, expanding it as
6704 * needed.
a2326b5b
MS
6705 */
6706
6707static _ipp_value_t * /* O - IPP value element or NULL on error */
9c80ffa2 6708ipp_set_value(ipp_t *ipp, /* IO - IPP message */
a2326b5b
MS
6709 ipp_attribute_t **attr, /* IO - IPP attribute */
6710 int element) /* I - Value number (0-based) */
6711{
6712 ipp_attribute_t *temp, /* New attribute pointer */
6713 *current, /* Current attribute in list */
6714 *prev; /* Previous attribute in list */
6715 int alloc_values; /* Allocated values */
6716
6717
6718 /*
6719 * If we are setting an existing value element, return it...
6720 */
6721
6722 temp = *attr;
6723
6724 if (temp->num_values <= 1)
9c80ffa2 6725 alloc_values = 1;
a2326b5b 6726 else
9c80ffa2
MS
6727 alloc_values = (temp->num_values + IPP_MAX_VALUES - 1) &
6728 ~(IPP_MAX_VALUES - 1);
a2326b5b
MS
6729
6730 if (element < alloc_values)
9c80ffa2
MS
6731 {
6732 if (element >= temp->num_values)
6733 temp->num_values = element + 1;
6734
a2326b5b 6735 return (temp->values + element);
9c80ffa2 6736 }
a2326b5b
MS
6737
6738 /*
9c80ffa2
MS
6739 * Otherwise re-allocate the attribute - we allocate in groups of IPP_MAX_VALUE
6740 * values when num_values > 1.
a2326b5b
MS
6741 */
6742
6743 if (alloc_values < IPP_MAX_VALUES)
6744 alloc_values = IPP_MAX_VALUES;
6745 else
6746 alloc_values += IPP_MAX_VALUES;
6747
9c80ffa2
MS
6748 DEBUG_printf(("4ipp_set_value: Reallocating for up to %d values.",
6749 alloc_values));
a2326b5b
MS
6750
6751 /*
6752 * Reallocate memory...
6753 */
6754
7e86f2f6 6755 if ((temp = realloc(temp, sizeof(ipp_attribute_t) + (size_t)(alloc_values - 1) * sizeof(_ipp_value_t))) == NULL)
a2326b5b 6756 {
cb7f98ee 6757 _cupsSetHTTPError(HTTP_STATUS_ERROR);
a2326b5b
MS
6758 DEBUG_puts("4ipp_set_value: Unable to resize attribute.");
6759 return (NULL);
6760 }
6761
6762 /*
6763 * Zero the new memory...
6764 */
6765
7e86f2f6 6766 memset(temp->values + temp->num_values, 0, (size_t)(alloc_values - temp->num_values) * sizeof(_ipp_value_t));
a2326b5b
MS
6767
6768 if (temp != *attr)
6769 {
6770 /*
6771 * Reset pointers in the list...
6772 */
6773
29bda83e 6774#ifndef __clang_analyzer__
c0a47c11 6775 DEBUG_printf(("4debug_free: %p %s", (void *)*attr, temp->name));
29bda83e 6776#endif /* !__clang_analyzer__ */
b908d72c
MS
6777 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));
6778
a2326b5b
MS
6779 if (ipp->current == *attr && ipp->prev)
6780 {
6781 /*
6782 * Use current "previous" pointer...
6783 */
6784
6785 prev = ipp->prev;
6786 }
6787 else
6788 {
6789 /*
6790 * Find this attribute in the linked list...
6791 */
6792
6793 for (prev = NULL, current = ipp->attrs;
6794 current && current != *attr;
6795 prev = current, current = current->next);
6796
6797 if (!current)
6798 {
6799 /*
6800 * This is a serious error!
6801 */
6802
6803 *attr = temp;
cb7f98ee 6804 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
9c80ffa2 6805 _("IPP attribute is not a member of the message."), 1);
a2326b5b
MS
6806 DEBUG_puts("4ipp_set_value: Unable to find attribute in message.");
6807 return (NULL);
6808 }
6809 }
6810
6811 if (prev)
6812 prev->next = temp;
6813 else
6814 ipp->attrs = temp;
6815
6816 ipp->current = temp;
6817 ipp->prev = prev;
6818
6819 if (ipp->last == *attr)
6820 ipp->last = temp;
6821
6822 *attr = temp;
6823 }
6824
6825 /*
6826 * Return the value element...
6827 */
6828
9c80ffa2
MS
6829 if (element >= temp->num_values)
6830 temp->num_values = element + 1;
6831
a2326b5b
MS
6832 return (temp->values + element);
6833}
6834
6835
ef416fc2 6836/*
6837 * 'ipp_write_file()' - Write IPP data to a file.
6838 */
6839
a4d04587 6840static ssize_t /* O - Number of bytes written */
ef416fc2 6841ipp_write_file(int *fd, /* I - File descriptor */
6842 ipp_uchar_t *buffer, /* I - Data to write */
a4d04587 6843 size_t length) /* I - Number of bytes to write */
ef416fc2 6844{
19dc16f7 6845#ifdef _WIN32
b86bc4cf 6846 return ((ssize_t)write(*fd, buffer, (unsigned)length));
6847#else
ef416fc2 6848 return (write(*fd, buffer, length));
19dc16f7 6849#endif /* _WIN32 */
ef416fc2 6850}