]> git.ipfire.org Git - thirdparty/cups.git/blame - cups/ipp.c
Move debug printfs to internal usage only.
[thirdparty/cups.git] / cups / ipp.c
CommitLineData
ef416fc2 1/*
7e86f2f6
MS
2 * Internet Printing Protocol functions for CUPS.
3 *
4cadd620
MS
4 * Copyright © 2007-2018 by Apple Inc.
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
MS
2868 /* Small string buffer */
2869 *bufptr; /* Pointer into buffer */
2870 ipp_attribute_t *attr; /* Current attribute */
2871 ipp_tag_t tag; /* Current tag */
2872 ipp_tag_t value_tag; /* Current value tag */
2873 _ipp_value_t *value; /* Current value */
2874
2875
807315e6 2876 DEBUG_printf(("ippReadIO(src=%p, cb=%p, blocking=%d, parent=%p, ipp=%p)", (void *)src, (void *)cb, blocking, (void *)parent, (void *)ipp));
cb7f98ee 2877 DEBUG_printf(("2ippReadIO: ipp->state=%d", ipp ? ipp->state : IPP_STATE_ERROR));
a2326b5b
MS
2878
2879 if (!src || !ipp)
cb7f98ee 2880 return (IPP_STATE_ERROR);
a2326b5b 2881
dcb445bc 2882 if ((buffer = (unsigned char *)_cupsBufferGet(IPP_BUF_SIZE)) == NULL)
a2326b5b
MS
2883 {
2884 DEBUG_puts("1ippReadIO: Unable to get read buffer.");
cb7f98ee 2885 return (IPP_STATE_ERROR);
a2326b5b
MS
2886 }
2887
2888 switch (ipp->state)
2889 {
cb7f98ee 2890 case IPP_STATE_IDLE :
a2326b5b
MS
2891 ipp->state ++; /* Avoid common problem... */
2892
cb7f98ee 2893 case IPP_STATE_HEADER :
a2326b5b
MS
2894 if (parent == NULL)
2895 {
2896 /*
2897 * Get the request header...
2898 */
2899
2900 if ((*cb)(src, buffer, 8) < 8)
2901 {
2902 DEBUG_puts("1ippReadIO: Unable to read header.");
dcb445bc 2903 _cupsBufferRelease((char *)buffer);
cb7f98ee 2904 return (IPP_STATE_ERROR);
a2326b5b
MS
2905 }
2906
2907 /*
2908 * Then copy the request header over...
2909 */
2910
2911 ipp->request.any.version[0] = buffer[0];
2912 ipp->request.any.version[1] = buffer[1];
2913 ipp->request.any.op_status = (buffer[2] << 8) | buffer[3];
2914 ipp->request.any.request_id = (((((buffer[4] << 8) | buffer[5]) << 8) |
2915 buffer[6]) << 8) | buffer[7];
2916
2917 DEBUG_printf(("2ippReadIO: version=%d.%d", buffer[0], buffer[1]));
2918 DEBUG_printf(("2ippReadIO: op_status=%04x",
2919 ipp->request.any.op_status));
2920 DEBUG_printf(("2ippReadIO: request_id=%d",
2921 ipp->request.any.request_id));
2922 }
2923
cb7f98ee 2924 ipp->state = IPP_STATE_ATTRIBUTE;
a2326b5b
MS
2925 ipp->current = NULL;
2926 ipp->curtag = IPP_TAG_ZERO;
2927 ipp->prev = ipp->last;
2928
2929 /*
2930 * If blocking is disabled, stop here...
2931 */
2932
2933 if (!blocking)
2934 break;
2935
cb7f98ee 2936 case IPP_STATE_ATTRIBUTE :
a2326b5b
MS
2937 for (;;)
2938 {
2939 if ((*cb)(src, buffer, 1) < 1)
2940 {
2941 DEBUG_puts("1ippReadIO: Callback returned EOF/error");
dcb445bc 2942 _cupsBufferRelease((char *)buffer);
cb7f98ee 2943 return (IPP_STATE_ERROR);
a2326b5b
MS
2944 }
2945
807315e6 2946 DEBUG_printf(("2ippReadIO: ipp->current=%p, ipp->prev=%p", (void *)ipp->current, (void *)ipp->prev));
a2326b5b
MS
2947
2948 /*
2949 * Read this attribute...
2950 */
2951
2952 tag = (ipp_tag_t)buffer[0];
2953 if (tag == IPP_TAG_EXTENSION)
2954 {
2955 /*
2956 * Read 32-bit "extension" tag...
2957 */
2958
2959 if ((*cb)(src, buffer, 4) < 1)
2960 {
2961 DEBUG_puts("1ippReadIO: Callback returned EOF/error");
dcb445bc 2962 _cupsBufferRelease((char *)buffer);
cb7f98ee 2963 return (IPP_STATE_ERROR);
a2326b5b
MS
2964 }
2965
2966 tag = (ipp_tag_t)((((((buffer[0] << 8) | buffer[1]) << 8) |
2967 buffer[2]) << 8) | buffer[3]);
2968
cb7f98ee 2969 if (tag & IPP_TAG_CUPS_CONST)
a2326b5b
MS
2970 {
2971 /*
2972 * Fail if the high bit is set in the tag...
2973 */
2974
cb7f98ee 2975 _cupsSetError(IPP_STATUS_ERROR_INTERNAL, _("IPP extension tag larger than 0x7FFFFFFF."), 1);
a29fd7dd 2976 DEBUG_printf(("1ippReadIO: bad tag 0x%x.", tag));
dcb445bc 2977 _cupsBufferRelease((char *)buffer);
cb7f98ee 2978 return (IPP_STATE_ERROR);
a2326b5b
MS
2979 }
2980 }
2981
2982 if (tag == IPP_TAG_END)
2983 {
2984 /*
2985 * No more attributes left...
2986 */
2987
2988 DEBUG_puts("2ippReadIO: IPP_TAG_END.");
2989
cb7f98ee 2990 ipp->state = IPP_STATE_DATA;
a2326b5b
MS
2991 break;
2992 }
8eed4387
MS
2993 else if (tag == IPP_TAG_ZERO || (tag == IPP_TAG_OPERATION && ipp->curtag != IPP_TAG_ZERO))
2994 {
2995 _cupsSetError(IPP_STATUS_ERROR_INTERNAL, _("Invalid group tag."), 1);
2996 DEBUG_printf(("1ippReadIO: bad tag 0x%02x.", tag));
2997 _cupsBufferRelease((char *)buffer);
2998 return (IPP_STATE_ERROR);
2999 }
a2326b5b
MS
3000 else if (tag < IPP_TAG_UNSUPPORTED_VALUE)
3001 {
3002 /*
3003 * Group tag... Set the current group and continue...
3004 */
3005
3006 if (ipp->curtag == tag)
3007 ipp->prev = ippAddSeparator(ipp);
3008 else if (ipp->current)
3009 ipp->prev = ipp->current;
ef416fc2 3010
3011 ipp->curtag = tag;
3012 ipp->current = NULL;
807315e6 3013 DEBUG_printf(("2ippReadIO: group tag=%x(%s), ipp->prev=%p", tag, ippTagString(tag), (void *)ipp->prev));
ef416fc2 3014 continue;
3015 }
3016
a2326b5b
MS
3017 DEBUG_printf(("2ippReadIO: value tag=%x(%s)", tag,
3018 ippTagString(tag)));
3019
3020 /*
3021 * Get the name...
3022 */
3023
3024 if ((*cb)(src, buffer, 2) < 2)
3025 {
3026 DEBUG_puts("1ippReadIO: unable to read name length.");
dcb445bc 3027 _cupsBufferRelease((char *)buffer);
cb7f98ee 3028 return (IPP_STATE_ERROR);
a2326b5b
MS
3029 }
3030
3031 n = (buffer[0] << 8) | buffer[1];
3032
3033 if (n >= IPP_BUF_SIZE)
3034 {
cb7f98ee 3035 _cupsSetError(IPP_STATUS_ERROR_INTERNAL, _("IPP name larger than 32767 bytes."), 1);
a2326b5b 3036 DEBUG_printf(("1ippReadIO: bad name length %d.", n));
dcb445bc 3037 _cupsBufferRelease((char *)buffer);
cb7f98ee 3038 return (IPP_STATE_ERROR);
a2326b5b
MS
3039 }
3040
3041 DEBUG_printf(("2ippReadIO: name length=%d", n));
3042
3043 if (n == 0 && tag != IPP_TAG_MEMBERNAME &&
3044 tag != IPP_TAG_END_COLLECTION)
3045 {
3046 /*
3047 * More values for current attribute...
3048 */
3049
3050 if (ipp->current == NULL)
3051 {
cb7f98ee 3052 _cupsSetError(IPP_STATUS_ERROR_INTERNAL, _("IPP attribute has no name."), 1);
a2326b5b 3053 DEBUG_puts("1ippReadIO: Attribute without name and no current.");
dcb445bc 3054 _cupsBufferRelease((char *)buffer);
cb7f98ee 3055 return (IPP_STATE_ERROR);
a2326b5b
MS
3056 }
3057
3058 attr = ipp->current;
cb7f98ee 3059 value_tag = (ipp_tag_t)(attr->value_tag & IPP_TAG_CUPS_MASK);
a2326b5b
MS
3060
3061 /*
3062 * Make sure we aren't adding a new value of a different
3063 * type...
3064 */
3065
3066 if (value_tag == IPP_TAG_ZERO)
3067 {
3068 /*
3069 * Setting the value of a collection member...
3070 */
3071
3072 attr->value_tag = tag;
3073 }
3074 else if (value_tag == IPP_TAG_TEXTLANG ||
3075 value_tag == IPP_TAG_NAMELANG ||
3076 (value_tag >= IPP_TAG_TEXT &&
3077 value_tag <= IPP_TAG_MIMETYPE))
3078 {
3079 /*
3080 * String values can sometimes come across in different
3081 * forms; accept sets of differing values...
3082 */
3083
3084 if (tag != IPP_TAG_TEXTLANG && tag != IPP_TAG_NAMELANG &&
3085 (tag < IPP_TAG_TEXT || tag > IPP_TAG_MIMETYPE) &&
3086 tag != IPP_TAG_NOVALUE)
3087 {
cb7f98ee 3088 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
a2326b5b
MS
3089 _("IPP 1setOf attribute with incompatible value "
3090 "tags."), 1);
3091 DEBUG_printf(("1ippReadIO: 1setOf value tag %x(%s) != %x(%s)",
3092 value_tag, ippTagString(value_tag), tag,
3093 ippTagString(tag)));
dcb445bc 3094 _cupsBufferRelease((char *)buffer);
cb7f98ee 3095 return (IPP_STATE_ERROR);
a2326b5b
MS
3096 }
3097
3098 if (value_tag != tag)
3099 {
3100 DEBUG_printf(("1ippReadIO: Converting %s attribute from %s to %s.",
3101 attr->name, ippTagString(value_tag), ippTagString(tag)));
3102 ippSetValueTag(ipp, &attr, tag);
3103 }
3104 }
3105 else if (value_tag == IPP_TAG_INTEGER ||
3106 value_tag == IPP_TAG_RANGE)
3107 {
3108 /*
3109 * Integer and rangeOfInteger values can sometimes be mixed; accept
3110 * sets of differing values...
3111 */
3112
3113 if (tag != IPP_TAG_INTEGER && tag != IPP_TAG_RANGE)
3114 {
cb7f98ee 3115 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
a2326b5b
MS
3116 _("IPP 1setOf attribute with incompatible value "
3117 "tags."), 1);
3118 DEBUG_printf(("1ippReadIO: 1setOf value tag %x(%s) != %x(%s)",
3119 value_tag, ippTagString(value_tag), tag,
3120 ippTagString(tag)));
dcb445bc 3121 _cupsBufferRelease((char *)buffer);
cb7f98ee 3122 return (IPP_STATE_ERROR);
a2326b5b
MS
3123 }
3124
3125 if (value_tag == IPP_TAG_INTEGER && tag == IPP_TAG_RANGE)
3126 {
3127 /*
3128 * Convert integer values to rangeOfInteger values...
3129 */
3130
3131 DEBUG_printf(("1ippReadIO: Converting %s attribute to "
3132 "rangeOfInteger.", attr->name));
3133 ippSetValueTag(ipp, &attr, IPP_TAG_RANGE);
3134 }
3135 }
3136 else if (value_tag != tag)
3137 {
cb7f98ee 3138 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
a2326b5b
MS
3139 _("IPP 1setOf attribute with incompatible value "
3140 "tags."), 1);
3141 DEBUG_printf(("1ippReadIO: value tag %x(%s) != %x(%s)",
3142 value_tag, ippTagString(value_tag), tag,
3143 ippTagString(tag)));
dcb445bc 3144 _cupsBufferRelease((char *)buffer);
cb7f98ee 3145 return (IPP_STATE_ERROR);
a2326b5b
MS
3146 }
3147
3148 /*
3149 * Finally, reallocate the attribute array as needed...
3150 */
3151
3152 if ((value = ipp_set_value(ipp, &attr, attr->num_values)) == NULL)
3153 {
dcb445bc 3154 _cupsBufferRelease((char *)buffer);
cb7f98ee 3155 return (IPP_STATE_ERROR);
a2326b5b
MS
3156 }
3157 }
3158 else if (tag == IPP_TAG_MEMBERNAME)
3159 {
3160 /*
3161 * Name must be length 0!
3162 */
3163
3164 if (n)
3165 {
cb7f98ee 3166 _cupsSetError(IPP_STATUS_ERROR_INTERNAL, _("IPP member name is not empty."), 1);
a2326b5b 3167 DEBUG_puts("1ippReadIO: member name not empty.");
dcb445bc 3168 _cupsBufferRelease((char *)buffer);
cb7f98ee 3169 return (IPP_STATE_ERROR);
a2326b5b
MS
3170 }
3171
3172 if (ipp->current)
3173 ipp->prev = ipp->current;
3174
3175 attr = ipp->current = ipp_add_attr(ipp, NULL, ipp->curtag, IPP_TAG_ZERO, 1);
0fa6c7fa
MS
3176 if (!attr)
3177 {
cb7f98ee 3178 _cupsSetHTTPError(HTTP_STATUS_ERROR);
0fa6c7fa
MS
3179 DEBUG_puts("1ippReadIO: unable to allocate attribute.");
3180 _cupsBufferRelease((char *)buffer);
cb7f98ee 3181 return (IPP_STATE_ERROR);
0fa6c7fa 3182 }
a2326b5b 3183
807315e6 3184 DEBUG_printf(("2ippReadIO: membername, ipp->current=%p, ipp->prev=%p", (void *)ipp->current, (void *)ipp->prev));
a2326b5b 3185
9c80ffa2 3186 value = attr->values;
a2326b5b
MS
3187 }
3188 else if (tag != IPP_TAG_END_COLLECTION)
3189 {
3190 /*
3191 * New attribute; read the name and add it...
3192 */
3193
7e86f2f6 3194 if ((*cb)(src, buffer, (size_t)n) < n)
a2326b5b
MS
3195 {
3196 DEBUG_puts("1ippReadIO: unable to read name.");
dcb445bc 3197 _cupsBufferRelease((char *)buffer);
cb7f98ee 3198 return (IPP_STATE_ERROR);
a2326b5b
MS
3199 }
3200
3201 buffer[n] = '\0';
3202
3203 if (ipp->current)
3204 ipp->prev = ipp->current;
3205
3206 if ((attr = ipp->current = ipp_add_attr(ipp, (char *)buffer, ipp->curtag, tag,
3207 1)) == NULL)
3208 {
cb7f98ee 3209 _cupsSetHTTPError(HTTP_STATUS_ERROR);
a2326b5b 3210 DEBUG_puts("1ippReadIO: unable to allocate attribute.");
dcb445bc 3211 _cupsBufferRelease((char *)buffer);
cb7f98ee 3212 return (IPP_STATE_ERROR);
a2326b5b
MS
3213 }
3214
807315e6 3215 DEBUG_printf(("2ippReadIO: name=\"%s\", ipp->current=%p, ipp->prev=%p", buffer, (void *)ipp->current, (void *)ipp->prev));
a2326b5b 3216
9c80ffa2 3217 value = attr->values;
a2326b5b
MS
3218 }
3219 else
3220 {
3221 attr = NULL;
3222 value = NULL;
3223 }
3224
3225 if ((*cb)(src, buffer, 2) < 2)
3226 {
3227 DEBUG_puts("1ippReadIO: unable to read value length.");
dcb445bc 3228 _cupsBufferRelease((char *)buffer);
cb7f98ee 3229 return (IPP_STATE_ERROR);
a2326b5b
MS
3230 }
3231
3232 n = (buffer[0] << 8) | buffer[1];
3233 DEBUG_printf(("2ippReadIO: value length=%d", n));
3234
3235 if (n >= IPP_BUF_SIZE)
3236 {
cb7f98ee 3237 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
a2326b5b
MS
3238 _("IPP value larger than 32767 bytes."), 1);
3239 DEBUG_printf(("1ippReadIO: bad value length %d.", n));
dcb445bc 3240 _cupsBufferRelease((char *)buffer);
cb7f98ee 3241 return (IPP_STATE_ERROR);
a2326b5b
MS
3242 }
3243
3244 switch (tag)
3245 {
3246 case IPP_TAG_INTEGER :
3247 case IPP_TAG_ENUM :
3248 if (n != 4)
3249 {
3250 if (tag == IPP_TAG_INTEGER)
cb7f98ee 3251 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
a2326b5b
MS
3252 _("IPP integer value not 4 bytes."), 1);
3253 else
cb7f98ee 3254 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
a2326b5b 3255 _("IPP enum value not 4 bytes."), 1);
a29fd7dd 3256 DEBUG_printf(("1ippReadIO: bad integer value length %d.", n));
dcb445bc 3257 _cupsBufferRelease((char *)buffer);
cb7f98ee 3258 return (IPP_STATE_ERROR);
a2326b5b
MS
3259 }
3260
3261 if ((*cb)(src, buffer, 4) < 4)
3262 {
3263 DEBUG_puts("1ippReadIO: Unable to read integer value.");
dcb445bc 3264 _cupsBufferRelease((char *)buffer);
cb7f98ee 3265 return (IPP_STATE_ERROR);
a2326b5b
MS
3266 }
3267
3268 n = (((((buffer[0] << 8) | buffer[1]) << 8) | buffer[2]) << 8) |
3269 buffer[3];
3270
3271 if (attr->value_tag == IPP_TAG_RANGE)
3272 value->range.lower = value->range.upper = n;
3273 else
3274 value->integer = n;
3275 break;
3276
3277 case IPP_TAG_BOOLEAN :
3278 if (n != 1)
3279 {
cb7f98ee 3280 _cupsSetError(IPP_STATUS_ERROR_INTERNAL, _("IPP boolean value not 1 byte."),
a2326b5b 3281 1);
a29fd7dd 3282 DEBUG_printf(("1ippReadIO: bad boolean value length %d.", n));
dcb445bc 3283 _cupsBufferRelease((char *)buffer);
cb7f98ee 3284 return (IPP_STATE_ERROR);
a2326b5b
MS
3285 }
3286
3287 if ((*cb)(src, buffer, 1) < 1)
3288 {
3289 DEBUG_puts("1ippReadIO: Unable to read boolean value.");
dcb445bc 3290 _cupsBufferRelease((char *)buffer);
cb7f98ee 3291 return (IPP_STATE_ERROR);
a2326b5b
MS
3292 }
3293
7e86f2f6 3294 value->boolean = (char)buffer[0];
a2326b5b
MS
3295 break;
3296
22a3eea9
MS
3297 case IPP_TAG_UNSUPPORTED_VALUE :
3298 case IPP_TAG_DEFAULT :
3299 case IPP_TAG_UNKNOWN :
3300 case IPP_TAG_NOVALUE :
a2326b5b
MS
3301 case IPP_TAG_NOTSETTABLE :
3302 case IPP_TAG_DELETEATTR :
3303 case IPP_TAG_ADMINDEFINE :
3304 /*
3305 * These value types are not supposed to have values, however
3306 * some vendors (Brother) do not implement IPP correctly and so
3307 * we need to map non-empty values to text...
3308 */
3309
3310 if (attr->value_tag == tag)
3311 {
3312 if (n == 0)
3313 break;
3314
3315 attr->value_tag = IPP_TAG_TEXT;
3316 }
3317
3318 case IPP_TAG_TEXT :
3319 case IPP_TAG_NAME :
22a3eea9 3320 case IPP_TAG_RESERVED_STRING :
a2326b5b
MS
3321 case IPP_TAG_KEYWORD :
3322 case IPP_TAG_URI :
3323 case IPP_TAG_URISCHEME :
3324 case IPP_TAG_CHARSET :
3325 case IPP_TAG_LANGUAGE :
3326 case IPP_TAG_MIMETYPE :
a29fd7dd
MS
3327 if (n > 0)
3328 {
7e86f2f6 3329 if ((*cb)(src, buffer, (size_t)n) < n)
a29fd7dd
MS
3330 {
3331 DEBUG_puts("1ippReadIO: unable to read string value.");
3332 _cupsBufferRelease((char *)buffer);
cb7f98ee 3333 return (IPP_STATE_ERROR);
a29fd7dd 3334 }
a2326b5b
MS
3335 }
3336
3337 buffer[n] = '\0';
3338 value->string.text = _cupsStrAlloc((char *)buffer);
3339 DEBUG_printf(("2ippReadIO: value=\"%s\"", value->string.text));
3340 break;
3341
3342 case IPP_TAG_DATE :
3343 if (n != 11)
3344 {
cb7f98ee 3345 _cupsSetError(IPP_STATUS_ERROR_INTERNAL, _("IPP date value not 11 bytes."), 1);
a29fd7dd 3346 DEBUG_printf(("1ippReadIO: bad date value length %d.", n));
dcb445bc 3347 _cupsBufferRelease((char *)buffer);
cb7f98ee 3348 return (IPP_STATE_ERROR);
a2326b5b
MS
3349 }
3350
3351 if ((*cb)(src, value->date, 11) < 11)
3352 {
3353 DEBUG_puts("1ippReadIO: Unable to read date value.");
dcb445bc 3354 _cupsBufferRelease((char *)buffer);
cb7f98ee 3355 return (IPP_STATE_ERROR);
a2326b5b
MS
3356 }
3357 break;
3358
3359 case IPP_TAG_RESOLUTION :
3360 if (n != 9)
3361 {
cb7f98ee 3362 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
a2326b5b 3363 _("IPP resolution value not 9 bytes."), 1);
a29fd7dd 3364 DEBUG_printf(("1ippReadIO: bad resolution value length %d.", n));
dcb445bc 3365 _cupsBufferRelease((char *)buffer);
cb7f98ee 3366 return (IPP_STATE_ERROR);
a2326b5b
MS
3367 }
3368
3369 if ((*cb)(src, buffer, 9) < 9)
3370 {
3371 DEBUG_puts("1ippReadIO: Unable to read resolution value.");
dcb445bc 3372 _cupsBufferRelease((char *)buffer);
cb7f98ee 3373 return (IPP_STATE_ERROR);
a2326b5b
MS
3374 }
3375
3376 value->resolution.xres =
3377 (((((buffer[0] << 8) | buffer[1]) << 8) | buffer[2]) << 8) |
3378 buffer[3];
3379 value->resolution.yres =
3380 (((((buffer[4] << 8) | buffer[5]) << 8) | buffer[6]) << 8) |
3381 buffer[7];
3382 value->resolution.units =
3383 (ipp_res_t)buffer[8];
3384 break;
3385
3386 case IPP_TAG_RANGE :
3387 if (n != 8)
3388 {
cb7f98ee 3389 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
a2326b5b 3390 _("IPP rangeOfInteger value not 8 bytes."), 1);
a29fd7dd
MS
3391 DEBUG_printf(("1ippReadIO: bad rangeOfInteger value length "
3392 "%d.", n));
dcb445bc 3393 _cupsBufferRelease((char *)buffer);
cb7f98ee 3394 return (IPP_STATE_ERROR);
a2326b5b
MS
3395 }
3396
3397 if ((*cb)(src, buffer, 8) < 8)
3398 {
3399 DEBUG_puts("1ippReadIO: Unable to read range value.");
dcb445bc 3400 _cupsBufferRelease((char *)buffer);
cb7f98ee 3401 return (IPP_STATE_ERROR);
a2326b5b
MS
3402 }
3403
3404 value->range.lower =
3405 (((((buffer[0] << 8) | buffer[1]) << 8) | buffer[2]) << 8) |
3406 buffer[3];
3407 value->range.upper =
3408 (((((buffer[4] << 8) | buffer[5]) << 8) | buffer[6]) << 8) |
3409 buffer[7];
3410 break;
3411
3412 case IPP_TAG_TEXTLANG :
3413 case IPP_TAG_NAMELANG :
3414 if (n < 4)
3415 {
3416 if (tag == IPP_TAG_TEXTLANG)
cb7f98ee 3417 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
a2326b5b
MS
3418 _("IPP textWithLanguage value less than "
3419 "minimum 4 bytes."), 1);
3420 else
cb7f98ee 3421 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
a2326b5b
MS
3422 _("IPP nameWithLanguage value less than "
3423 "minimum 4 bytes."), 1);
a29fd7dd
MS
3424 DEBUG_printf(("1ippReadIO: bad stringWithLanguage value "
3425 "length %d.", n));
dcb445bc 3426 _cupsBufferRelease((char *)buffer);
cb7f98ee 3427 return (IPP_STATE_ERROR);
a2326b5b
MS
3428 }
3429
7e86f2f6 3430 if ((*cb)(src, buffer, (size_t)n) < n)
a2326b5b
MS
3431 {
3432 DEBUG_puts("1ippReadIO: Unable to read string w/language "
3433 "value.");
dcb445bc 3434 _cupsBufferRelease((char *)buffer);
cb7f98ee 3435 return (IPP_STATE_ERROR);
a2326b5b
MS
3436 }
3437
3438 bufptr = buffer;
3439
3440 /*
3441 * text-with-language and name-with-language are composite
3442 * values:
3443 *
3444 * language-length
3445 * language
3446 * text-length
3447 * text
3448 */
3449
3450 n = (bufptr[0] << 8) | bufptr[1];
3451
7e86f2f6 3452 if ((bufptr + 2 + n) >= (buffer + IPP_BUF_SIZE) || n >= (int)sizeof(string))
a2326b5b 3453 {
cb7f98ee 3454 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
a2326b5b 3455 _("IPP language length overflows value."), 1);
a29fd7dd
MS
3456 DEBUG_printf(("1ippReadIO: bad language value length %d.",
3457 n));
dcb445bc 3458 _cupsBufferRelease((char *)buffer);
cb7f98ee 3459 return (IPP_STATE_ERROR);
a2326b5b 3460 }
5a9febac
MS
3461 else if (n >= IPP_MAX_LANGUAGE)
3462 {
cb7f98ee 3463 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
5a9febac
MS
3464 _("IPP language length too large."), 1);
3465 DEBUG_printf(("1ippReadIO: bad language value length %d.",
3466 n));
3467 _cupsBufferRelease((char *)buffer);
cb7f98ee 3468 return (IPP_STATE_ERROR);
5a9febac 3469 }
a2326b5b 3470
07623986 3471 memcpy(string, bufptr + 2, (size_t)n);
a2326b5b
MS
3472 string[n] = '\0';
3473
3474 value->string.language = _cupsStrAlloc((char *)string);
3475
3476 bufptr += 2 + n;
3477 n = (bufptr[0] << 8) | bufptr[1];
3478
3479 if ((bufptr + 2 + n) >= (buffer + IPP_BUF_SIZE))
3480 {
cb7f98ee 3481 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
a2326b5b 3482 _("IPP string length overflows value."), 1);
a29fd7dd 3483 DEBUG_printf(("1ippReadIO: bad string value length %d.", n));
dcb445bc 3484 _cupsBufferRelease((char *)buffer);
cb7f98ee 3485 return (IPP_STATE_ERROR);
a2326b5b
MS
3486 }
3487
3488 bufptr[2 + n] = '\0';
3489 value->string.text = _cupsStrAlloc((char *)bufptr + 2);
3490 break;
3491
3492 case IPP_TAG_BEGIN_COLLECTION :
3493 /*
3494 * Oh, boy, here comes a collection value, so read it...
3495 */
3496
3497 value->collection = ippNew();
3498
3499 if (n > 0)
3500 {
cb7f98ee 3501 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
a2326b5b
MS
3502 _("IPP begCollection value not 0 bytes."), 1);
3503 DEBUG_puts("1ippReadIO: begCollection tag with value length "
3504 "> 0.");
dcb445bc 3505 _cupsBufferRelease((char *)buffer);
cb7f98ee 3506 return (IPP_STATE_ERROR);
a2326b5b
MS
3507 }
3508
cb7f98ee 3509 if (ippReadIO(src, cb, 1, ipp, value->collection) == IPP_STATE_ERROR)
a2326b5b
MS
3510 {
3511 DEBUG_puts("1ippReadIO: Unable to read collection value.");
dcb445bc 3512 _cupsBufferRelease((char *)buffer);
cb7f98ee 3513 return (IPP_STATE_ERROR);
a2326b5b
MS
3514 }
3515 break;
3516
3517 case IPP_TAG_END_COLLECTION :
dcb445bc 3518 _cupsBufferRelease((char *)buffer);
a2326b5b
MS
3519
3520 if (n > 0)
3521 {
cb7f98ee 3522 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
a2326b5b
MS
3523 _("IPP endCollection value not 0 bytes."), 1);
3524 DEBUG_puts("1ippReadIO: endCollection tag with value length "
3525 "> 0.");
cb7f98ee 3526 return (IPP_STATE_ERROR);
a2326b5b
MS
3527 }
3528
3529 DEBUG_puts("1ippReadIO: endCollection tag...");
cb7f98ee 3530 return (ipp->state = IPP_STATE_DATA);
a2326b5b
MS
3531
3532 case IPP_TAG_MEMBERNAME :
3533 /*
3534 * The value the name of the member in the collection, which
3535 * we need to carry over...
3536 */
3537
5a9febac
MS
3538 if (!attr)
3539 {
cb7f98ee 3540 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
5a9febac
MS
3541 _("IPP memberName with no attribute."), 1);
3542 DEBUG_puts("1ippReadIO: Member name without attribute.");
3543 _cupsBufferRelease((char *)buffer);
cb7f98ee 3544 return (IPP_STATE_ERROR);
5a9febac
MS
3545 }
3546 else if (n == 0)
a29fd7dd 3547 {
cb7f98ee 3548 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
a29fd7dd
MS
3549 _("IPP memberName value is empty."), 1);
3550 DEBUG_puts("1ippReadIO: Empty member name value.");
3551 _cupsBufferRelease((char *)buffer);
cb7f98ee 3552 return (IPP_STATE_ERROR);
a29fd7dd 3553 }
7e86f2f6 3554 else if ((*cb)(src, buffer, (size_t)n) < n)
a2326b5b
MS
3555 {
3556 DEBUG_puts("1ippReadIO: Unable to read member name value.");
dcb445bc 3557 _cupsBufferRelease((char *)buffer);
cb7f98ee 3558 return (IPP_STATE_ERROR);
a2326b5b
MS
3559 }
3560
3561 buffer[n] = '\0';
3562 attr->name = _cupsStrAlloc((char *)buffer);
3563
3564 /*
3565 * Since collection members are encoded differently than
3566 * regular attributes, make sure we don't start with an
3567 * empty value...
3568 */
3569
3570 attr->num_values --;
3571
3572 DEBUG_printf(("2ippReadIO: member name=\"%s\"", attr->name));
3573 break;
3574
672c8127 3575 case IPP_TAG_STRING :
a2326b5b 3576 default : /* Other unsupported values */
a469f8a5 3577 if (tag == IPP_TAG_STRING && n > IPP_MAX_LENGTH)
5a9febac 3578 {
cb7f98ee 3579 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
5a9febac
MS
3580 _("IPP octetString length too large."), 1);
3581 DEBUG_printf(("1ippReadIO: bad octetString value length %d.",
3582 n));
3583 _cupsBufferRelease((char *)buffer);
cb7f98ee 3584 return (IPP_STATE_ERROR);
5a9febac
MS
3585 }
3586
a2326b5b 3587 value->unknown.length = n;
5a9febac 3588
a2326b5b
MS
3589 if (n > 0)
3590 {
7e86f2f6 3591 if ((value->unknown.data = malloc((size_t)n)) == NULL)
a2326b5b 3592 {
cb7f98ee 3593 _cupsSetHTTPError(HTTP_STATUS_ERROR);
a2326b5b 3594 DEBUG_puts("1ippReadIO: Unable to allocate value");
dcb445bc 3595 _cupsBufferRelease((char *)buffer);
cb7f98ee 3596 return (IPP_STATE_ERROR);
a2326b5b
MS
3597 }
3598
7e86f2f6 3599 if ((*cb)(src, value->unknown.data, (size_t)n) < n)
a2326b5b
MS
3600 {
3601 DEBUG_puts("1ippReadIO: Unable to read unsupported value.");
dcb445bc 3602 _cupsBufferRelease((char *)buffer);
cb7f98ee 3603 return (IPP_STATE_ERROR);
a2326b5b
MS
3604 }
3605 }
3606 else
3607 value->unknown.data = NULL;
3608 break;
3609 }
3610
a2326b5b
MS
3611 /*
3612 * If blocking is disabled, stop here...
ef416fc2 3613 */
3614
a2326b5b
MS
3615 if (!blocking)
3616 break;
3617 }
3618 break;
ef416fc2 3619
cb7f98ee 3620 case IPP_STATE_DATA :
a2326b5b 3621 break;
ef416fc2 3622
a2326b5b
MS
3623 default :
3624 break; /* anti-compiler-warning-code */
3625 }
ef416fc2 3626
a2326b5b 3627 DEBUG_printf(("1ippReadIO: returning ipp->state=%d.", ipp->state));
dcb445bc 3628 _cupsBufferRelease((char *)buffer);
ef416fc2 3629
a2326b5b
MS
3630 return (ipp->state);
3631}
ef416fc2 3632
ef416fc2 3633
a2326b5b
MS
3634/*
3635 * 'ippSetBoolean()' - Set a boolean value in an attribute.
3636 *
a469f8a5
MS
3637 * The @code ipp@ parameter refers to an IPP message previously created using
3638 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
3639 *
3640 * The @code attr@ parameter may be modified as a result of setting the value.
3641 *
3642 * The @code element@ parameter specifies which value to set from 0 to
65bebeac 3643 * @code ippGetCount(attr)@.
a2326b5b 3644 *
8072030b 3645 * @since CUPS 1.6/macOS 10.8@
a2326b5b 3646 */
ef416fc2 3647
a2326b5b 3648int /* O - 1 on success, 0 on failure */
6961465f 3649ippSetBoolean(ipp_t *ipp, /* I - IPP message */
a2326b5b
MS
3650 ipp_attribute_t **attr, /* IO - IPP attribute */
3651 int element, /* I - Value number (0-based) */
3652 int boolvalue)/* I - Boolean value */
3653{
3654 _ipp_value_t *value; /* Current value */
ef416fc2 3655
ef416fc2 3656
a2326b5b
MS
3657 /*
3658 * Range check input...
3659 */
ef416fc2 3660
a2326b5b
MS
3661 if (!ipp || !attr || !*attr || (*attr)->value_tag != IPP_TAG_BOOLEAN ||
3662 element < 0 || element > (*attr)->num_values)
3663 return (0);
83e08001 3664
a2326b5b
MS
3665 /*
3666 * Set the value and return...
3667 */
83e08001 3668
a2326b5b 3669 if ((value = ipp_set_value(ipp, attr, element)) != NULL)
7e86f2f6 3670 value->boolean = (char)boolvalue;
83e08001 3671
a2326b5b
MS
3672 return (value != NULL);
3673}
83e08001 3674
83e08001 3675
a2326b5b
MS
3676/*
3677 * 'ippSetCollection()' - Set a collection value in an attribute.
3678 *
a469f8a5
MS
3679 * The @code ipp@ parameter refers to an IPP message previously created using
3680 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
3681 *
3682 * The @code attr@ parameter may be modified as a result of setting the value.
3683 *
3684 * The @code element@ parameter specifies which value to set from 0 to
65bebeac 3685 * @code ippGetCount(attr)@.
a2326b5b 3686 *
8072030b 3687 * @since CUPS 1.6/macOS 10.8@
a2326b5b 3688 */
83e08001 3689
a2326b5b
MS
3690int /* O - 1 on success, 0 on failure */
3691ippSetCollection(
6961465f 3692 ipp_t *ipp, /* I - IPP message */
a2326b5b
MS
3693 ipp_attribute_t **attr, /* IO - IPP attribute */
3694 int element, /* I - Value number (0-based) */
3695 ipp_t *colvalue) /* I - Collection value */
3696{
3697 _ipp_value_t *value; /* Current value */
3698
3699
3700 /*
3701 * Range check input...
3702 */
3703
3704 if (!ipp || !attr || !*attr || (*attr)->value_tag != IPP_TAG_BEGIN_COLLECTION ||
3705 element < 0 || element > (*attr)->num_values || !colvalue)
3706 return (0);
3707
3708 /*
3709 * Set the value and return...
3710 */
3711
3712 if ((value = ipp_set_value(ipp, attr, element)) != NULL)
3713 {
3714 if (value->collection)
3715 ippDelete(value->collection);
3716
3717 value->collection = colvalue;
3718 colvalue->use ++;
3719 }
3720
3721 return (value != NULL);
3722}
3723
3724
9c80ffa2 3725/*
65bebeac 3726 * 'ippSetDate()' - Set a dateTime value in an attribute.
9c80ffa2 3727 *
a469f8a5
MS
3728 * The @code ipp@ parameter refers to an IPP message previously created using
3729 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
9c80ffa2
MS
3730 *
3731 * The @code attr@ parameter may be modified as a result of setting the value.
3732 *
3733 * The @code element@ parameter specifies which value to set from 0 to
65bebeac 3734 * @code ippGetCount(attr)@.
9c80ffa2 3735 *
8072030b 3736 * @since CUPS 1.6/macOS 10.8@
9c80ffa2
MS
3737 */
3738
3739int /* O - 1 on success, 0 on failure */
6961465f 3740ippSetDate(ipp_t *ipp, /* I - IPP message */
9c80ffa2
MS
3741 ipp_attribute_t **attr, /* IO - IPP attribute */
3742 int element, /* I - Value number (0-based) */
65bebeac 3743 const ipp_uchar_t *datevalue)/* I - dateTime value */
9c80ffa2
MS
3744{
3745 _ipp_value_t *value; /* Current value */
3746
3747
3748 /*
3749 * Range check input...
3750 */
3751
3752 if (!ipp || !attr || !*attr || (*attr)->value_tag != IPP_TAG_DATE ||
3753 element < 0 || element > (*attr)->num_values || !datevalue)
3754 return (0);
3755
3756 /*
3757 * Set the value and return...
3758 */
3759
3760 if ((value = ipp_set_value(ipp, attr, element)) != NULL)
3761 memcpy(value->date, datevalue, sizeof(value->date));
3762
3763 return (value != NULL);
3764}
3765
3766
a2326b5b
MS
3767/*
3768 * 'ippSetGroupTag()' - Set the group tag of an attribute.
3769 *
a469f8a5
MS
3770 * The @code ipp@ parameter refers to an IPP message previously created using
3771 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
3772 *
3773 * The @code attr@ parameter may be modified as a result of setting the value.
3774 *
3775 * The @code group@ parameter specifies the IPP attribute group tag: none
3776 * (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
3777 * event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
3778 * (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
3779 * (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
3780 *
8072030b 3781 * @since CUPS 1.6/macOS 10.8@
a2326b5b
MS
3782 */
3783
3784int /* O - 1 on success, 0 on failure */
3785ippSetGroupTag(
6961465f 3786 ipp_t *ipp, /* I - IPP message */
a2326b5b
MS
3787 ipp_attribute_t **attr, /* IO - Attribute */
3788 ipp_tag_t group_tag) /* I - Group tag */
3789{
3790 /*
65bebeac 3791 * Range check input - group tag must be 0x01 to 0x0F, per RFC 8011...
a2326b5b
MS
3792 */
3793
a469f8a5
MS
3794 if (!ipp || !attr || !*attr ||
3795 group_tag < IPP_TAG_ZERO || group_tag == IPP_TAG_END ||
a2326b5b
MS
3796 group_tag >= IPP_TAG_UNSUPPORTED_VALUE)
3797 return (0);
3798
3799 /*
3800 * Set the group tag and return...
3801 */
3802
3803 (*attr)->group_tag = group_tag;
3804
3805 return (1);
3806}
3807
3808
3809/*
3810 * 'ippSetInteger()' - Set an integer or enum value in an attribute.
3811 *
a469f8a5
MS
3812 * The @code ipp@ parameter refers to an IPP message previously created using
3813 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
3814 *
3815 * The @code attr@ parameter may be modified as a result of setting the value.
3816 *
3817 * The @code element@ parameter specifies which value to set from 0 to
65bebeac 3818 * @code ippGetCount(attr)@.
a2326b5b 3819 *
8072030b 3820 * @since CUPS 1.6/macOS 10.8@
a2326b5b
MS
3821 */
3822
3823int /* O - 1 on success, 0 on failure */
6961465f 3824ippSetInteger(ipp_t *ipp, /* I - IPP message */
a2326b5b
MS
3825 ipp_attribute_t **attr, /* IO - IPP attribute */
3826 int element, /* I - Value number (0-based) */
3827 int intvalue) /* I - Integer/enum value */
3828{
3829 _ipp_value_t *value; /* Current value */
3830
3831
3832 /*
3833 * Range check input...
3834 */
3835
3836 if (!ipp || !attr || !*attr ||
3837 ((*attr)->value_tag != IPP_TAG_INTEGER && (*attr)->value_tag != IPP_TAG_ENUM) ||
3838 element < 0 || element > (*attr)->num_values)
3839 return (0);
3840
3841 /*
3842 * Set the value and return...
3843 */
3844
3845 if ((value = ipp_set_value(ipp, attr, element)) != NULL)
3846 value->integer = intvalue;
3847
3848 return (value != NULL);
3849}
3850
3851
3852/*
3853 * 'ippSetName()' - Set the name of an attribute.
3854 *
a469f8a5
MS
3855 * The @code ipp@ parameter refers to an IPP message previously created using
3856 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
3857 *
3858 * The @code attr@ parameter may be modified as a result of setting the value.
3859 *
8072030b 3860 * @since CUPS 1.6/macOS 10.8@
a2326b5b
MS
3861 */
3862
3863int /* O - 1 on success, 0 on failure */
6961465f 3864ippSetName(ipp_t *ipp, /* I - IPP message */
a2326b5b
MS
3865 ipp_attribute_t **attr, /* IO - IPP attribute */
3866 const char *name) /* I - Attribute name */
3867{
3868 char *temp; /* Temporary name value */
3869
3870
3871 /*
3872 * Range check input...
3873 */
3874
3875 if (!ipp || !attr || !*attr)
3876 return (0);
ef416fc2 3877
a2326b5b
MS
3878 /*
3879 * Set the value and return...
3880 */
ef416fc2 3881
a2326b5b
MS
3882 if ((temp = _cupsStrAlloc(name)) != NULL)
3883 {
3884 if ((*attr)->name)
3885 _cupsStrFree((*attr)->name);
ef416fc2 3886
a2326b5b
MS
3887 (*attr)->name = temp;
3888 }
ef416fc2 3889
a2326b5b
MS
3890 return (temp != NULL);
3891}
ef416fc2 3892
ef416fc2 3893
6961465f
MS
3894/*
3895 * 'ippSetOctetString()' - Set an octetString value in an IPP attribute.
3896 *
3897 * The @code ipp@ parameter refers to an IPP message previously created using
3898 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
3899 *
3900 * The @code attr@ parameter may be modified as a result of setting the value.
3901 *
3902 * The @code element@ parameter specifies which value to set from 0 to
65bebeac 3903 * @code ippGetCount(attr)@.
6961465f 3904 *
8072030b 3905 * @since CUPS 1.7/macOS 10.9@
6961465f
MS
3906 */
3907
3908int /* O - 1 on success, 0 on failure */
3909ippSetOctetString(
3910 ipp_t *ipp, /* I - IPP message */
3911 ipp_attribute_t **attr, /* IO - IPP attribute */
3912 int element, /* I - Value number (0-based) */
3913 const void *data, /* I - Pointer to octetString data */
3914 int datalen) /* I - Length of octetString data */
3915{
3916 _ipp_value_t *value; /* Current value */
3917
3918
3919 /*
3920 * Range check input...
3921 */
3922
3923 if (!ipp || !attr || !*attr || (*attr)->value_tag != IPP_TAG_STRING ||
3924 element < 0 || element > (*attr)->num_values ||
3925 datalen < 0 || datalen > IPP_MAX_LENGTH)
3926 return (0);
3927
3928 /*
3929 * Set the value and return...
3930 */
3931
3932 if ((value = ipp_set_value(ipp, attr, element)) != NULL)
3933 {
3934 if ((int)((*attr)->value_tag) & IPP_TAG_CUPS_CONST)
3935 {
3936 /*
3937 * Just copy the pointer...
3938 */
3939
3940 value->unknown.data = (void *)data;
3941 value->unknown.length = datalen;
3942 }
3943 else
3944 {
3945 /*
3946 * Copy the data...
3947 */
3948
3949 if (value->unknown.data)
3950 {
3951 /*
3952 * Free previous data...
3953 */
3954
3955 free(value->unknown.data);
3956
3957 value->unknown.data = NULL;
3958 value->unknown.length = 0;
3959 }
3960
3961 if (datalen > 0)
3962 {
3963 void *temp; /* Temporary data pointer */
3964
7e86f2f6 3965 if ((temp = malloc((size_t)datalen)) != NULL)
6961465f 3966 {
07623986 3967 memcpy(temp, data, (size_t)datalen);
6961465f
MS
3968
3969 value->unknown.data = temp;
3970 value->unknown.length = datalen;
3971 }
3972 else
3973 return (0);
3974 }
3975 }
3976 }
3977
3978 return (value != NULL);
3979}
3980
3981
a2326b5b
MS
3982/*
3983 * 'ippSetOperation()' - Set the operation ID in an IPP request message.
3984 *
a469f8a5
MS
3985 * The @code ipp@ parameter refers to an IPP message previously created using
3986 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b 3987 *
8072030b 3988 * @since CUPS 1.6/macOS 10.8@
a2326b5b 3989 */
ef416fc2 3990
a2326b5b
MS
3991int /* O - 1 on success, 0 on failure */
3992ippSetOperation(ipp_t *ipp, /* I - IPP request message */
3993 ipp_op_t op) /* I - Operation ID */
3994{
3995 /*
3996 * Range check input...
3997 */
ef416fc2 3998
a2326b5b
MS
3999 if (!ipp)
4000 return (0);
ef416fc2 4001
a2326b5b
MS
4002 /*
4003 * Set the operation and return...
4004 */
ef416fc2 4005
a2326b5b 4006 ipp->request.op.operation_id = op;
ef416fc2 4007
a2326b5b
MS
4008 return (1);
4009}
ef416fc2 4010
ef416fc2 4011
a2326b5b
MS
4012/*
4013 * 'ippSetRange()' - Set a rangeOfInteger value in an attribute.
4014 *
a469f8a5
MS
4015 * The @code ipp@ parameter refers to an IPP message previously created using
4016 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
4017 *
4018 * The @code attr@ parameter may be modified as a result of setting the value.
4019 *
4020 * The @code element@ parameter specifies which value to set from 0 to
65bebeac 4021 * @code ippGetCount(attr)@.
a2326b5b 4022 *
8072030b 4023 * @since CUPS 1.6/macOS 10.8@
a2326b5b 4024 */
ef416fc2 4025
a2326b5b 4026int /* O - 1 on success, 0 on failure */
6961465f 4027ippSetRange(ipp_t *ipp, /* I - IPP message */
a2326b5b
MS
4028 ipp_attribute_t **attr, /* IO - IPP attribute */
4029 int element, /* I - Value number (0-based) */
4030 int lowervalue, /* I - Lower bound for range */
4031 int uppervalue) /* I - Upper bound for range */
4032{
4033 _ipp_value_t *value; /* Current value */
ef416fc2 4034
ef416fc2 4035
a2326b5b
MS
4036 /*
4037 * Range check input...
4038 */
ef416fc2 4039
a2326b5b
MS
4040 if (!ipp || !attr || !*attr || (*attr)->value_tag != IPP_TAG_RANGE ||
4041 element < 0 || element > (*attr)->num_values || lowervalue > uppervalue)
4042 return (0);
ef416fc2 4043
a2326b5b
MS
4044 /*
4045 * Set the value and return...
4046 */
ef416fc2 4047
a2326b5b
MS
4048 if ((value = ipp_set_value(ipp, attr, element)) != NULL)
4049 {
4050 value->range.lower = lowervalue;
4051 value->range.upper = uppervalue;
4052 }
ef416fc2 4053
a2326b5b
MS
4054 return (value != NULL);
4055}
ef416fc2 4056
ef416fc2 4057
a2326b5b
MS
4058/*
4059 * 'ippSetRequestId()' - Set the request ID in an IPP message.
4060 *
a469f8a5
MS
4061 * The @code ipp@ parameter refers to an IPP message previously created using
4062 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
4063 *
4064 * The @code request_id@ parameter must be greater than 0.
4065 *
8072030b 4066 * @since CUPS 1.6/macOS 10.8@
a2326b5b 4067 */
ef416fc2 4068
a2326b5b
MS
4069int /* O - 1 on success, 0 on failure */
4070ippSetRequestId(ipp_t *ipp, /* I - IPP message */
4071 int request_id) /* I - Request ID */
4072{
4073 /*
4074 * Range check input; not checking request_id values since ipptool wants to send
4075 * invalid values for conformance testing and a bad request_id does not affect the
4076 * encoding of a message...
4077 */
83e08001 4078
a2326b5b
MS
4079 if (!ipp)
4080 return (0);
a41f09e2 4081
a2326b5b
MS
4082 /*
4083 * Set the request ID and return...
4084 */
ef416fc2 4085
a2326b5b 4086 ipp->request.any.request_id = request_id;
ef416fc2 4087
a2326b5b
MS
4088 return (1);
4089}
5a738aea 4090
a41f09e2 4091
a2326b5b
MS
4092/*
4093 * 'ippSetResolution()' - Set a resolution value in an attribute.
4094 *
a469f8a5
MS
4095 * The @code ipp@ parameter refers to an IPP message previously created using
4096 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
4097 *
4098 * The @code attr@ parameter may be modified as a result of setting the value.
4099 *
4100 * The @code element@ parameter specifies which value to set from 0 to
65bebeac 4101 * @code ippGetCount(attr)@.
a2326b5b 4102 *
8072030b 4103 * @since CUPS 1.6/macOS 10.8@
a2326b5b 4104 */
ef416fc2 4105
a2326b5b
MS
4106int /* O - 1 on success, 0 on failure */
4107ippSetResolution(
6961465f 4108 ipp_t *ipp, /* I - IPP message */
a2326b5b
MS
4109 ipp_attribute_t **attr, /* IO - IPP attribute */
4110 int element, /* I - Value number (0-based) */
4111 ipp_res_t unitsvalue, /* I - Resolution units */
4112 int xresvalue, /* I - Horizontal/cross feed resolution */
4113 int yresvalue) /* I - Vertical/feed resolution */
4114{
4115 _ipp_value_t *value; /* Current value */
5a738aea 4116
536bc2c6 4117
a2326b5b
MS
4118 /*
4119 * Range check input...
4120 */
1ff0402e 4121
a2326b5b
MS
4122 if (!ipp || !attr || !*attr || (*attr)->value_tag != IPP_TAG_RESOLUTION ||
4123 element < 0 || element > (*attr)->num_values || xresvalue <= 0 || yresvalue <= 0 ||
4124 unitsvalue < IPP_RES_PER_INCH || unitsvalue > IPP_RES_PER_CM)
4125 return (0);
1ff0402e 4126
a2326b5b
MS
4127 /*
4128 * Set the value and return...
4129 */
ef416fc2 4130
a2326b5b
MS
4131 if ((value = ipp_set_value(ipp, attr, element)) != NULL)
4132 {
4133 value->resolution.units = unitsvalue;
4134 value->resolution.xres = xresvalue;
4135 value->resolution.yres = yresvalue;
4136 }
5a738aea 4137
a2326b5b
MS
4138 return (value != NULL);
4139}
a41f09e2 4140
5a738aea 4141
9c80ffa2
MS
4142/*
4143 * 'ippSetState()' - Set the current state of the IPP message.
4144 *
8072030b 4145 * @since CUPS 1.6/macOS 10.8@
9c80ffa2
MS
4146 */
4147
4148int /* O - 1 on success, 0 on failure */
4149ippSetState(ipp_t *ipp, /* I - IPP message */
4150 ipp_state_t state) /* I - IPP state value */
4151{
4152 /*
4153 * Range check input...
4154 */
4155
4156 if (!ipp)
4157 return (0);
4158
4159 /*
4160 * Set the state and return...
4161 */
4162
4163 ipp->state = state;
4164 ipp->current = NULL;
4165
4166 return (1);
4167}
4168
4169
a2326b5b
MS
4170/*
4171 * 'ippSetStatusCode()' - Set the status code in an IPP response or event message.
4172 *
a469f8a5
MS
4173 * The @code ipp@ parameter refers to an IPP message previously created using
4174 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b 4175 *
8072030b 4176 * @since CUPS 1.6/macOS 10.8@
a2326b5b 4177 */
a41f09e2 4178
a2326b5b
MS
4179int /* O - 1 on success, 0 on failure */
4180ippSetStatusCode(ipp_t *ipp, /* I - IPP response or event message */
4181 ipp_status_t status) /* I - Status code */
4182{
4183 /*
4184 * Range check input...
4185 */
4186
4187 if (!ipp)
4188 return (0);
ef416fc2 4189
a2326b5b
MS
4190 /*
4191 * Set the status code and return...
4192 */
5a738aea 4193
a2326b5b 4194 ipp->request.status.status_code = status;
a41f09e2 4195
a2326b5b 4196 return (1);
a2326b5b 4197}
5a738aea 4198
ef416fc2 4199
a2326b5b
MS
4200/*
4201 * 'ippSetString()' - Set a string value in an attribute.
4202 *
a469f8a5
MS
4203 * The @code ipp@ parameter refers to an IPP message previously created using
4204 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
4205 *
4206 * The @code attr@ parameter may be modified as a result of setting the value.
4207 *
4208 * The @code element@ parameter specifies which value to set from 0 to
65bebeac 4209 * @code ippGetCount(attr)@.
a2326b5b 4210 *
8072030b 4211 * @since CUPS 1.6/macOS 10.8@
a2326b5b 4212 */
ef416fc2 4213
a2326b5b 4214int /* O - 1 on success, 0 on failure */
6961465f 4215ippSetString(ipp_t *ipp, /* I - IPP message */
a2326b5b
MS
4216 ipp_attribute_t **attr, /* IO - IPP attribute */
4217 int element, /* I - Value number (0-based) */
4218 const char *strvalue) /* I - String value */
4219{
4220 char *temp; /* Temporary string */
4221 _ipp_value_t *value; /* Current value */
e22f464e 4222 ipp_tag_t value_tag; /* Value tag */
ef416fc2 4223
ef416fc2 4224
a2326b5b
MS
4225 /*
4226 * Range check input...
4227 */
ef416fc2 4228
e22f464e
MS
4229 if (attr && *attr)
4230 value_tag = (*attr)->value_tag & IPP_TAG_CUPS_MASK;
4231 else
4232 value_tag = IPP_TAG_ZERO;
4233
3e7fe0ca 4234 if (!ipp || !attr || !*attr ||
e22f464e
MS
4235 (value_tag < IPP_TAG_TEXT && value_tag != IPP_TAG_TEXTLANG &&
4236 value_tag != IPP_TAG_NAMELANG) || value_tag > IPP_TAG_MIMETYPE ||
3aeb120e 4237 element < 0 || element > (*attr)->num_values || !strvalue)
a2326b5b 4238 return (0);
a41f09e2 4239
a2326b5b
MS
4240 /*
4241 * Set the value and return...
4242 */
ef416fc2 4243
a2326b5b
MS
4244 if ((value = ipp_set_value(ipp, attr, element)) != NULL)
4245 {
4246 if (element > 0)
4247 value->string.language = (*attr)->values[0].string.language;
ef416fc2 4248
cb7f98ee 4249 if ((int)((*attr)->value_tag) & IPP_TAG_CUPS_CONST)
a2326b5b
MS
4250 value->string.text = (char *)strvalue;
4251 else if ((temp = _cupsStrAlloc(strvalue)) != NULL)
4252 {
4253 if (value->string.text)
4254 _cupsStrFree(value->string.text);
ef416fc2 4255
a2326b5b
MS
4256 value->string.text = temp;
4257 }
4258 else
4259 return (0);
4260 }
a41f09e2 4261
a2326b5b
MS
4262 return (value != NULL);
4263}
ef416fc2 4264
ef416fc2 4265
a469f8a5
MS
4266/*
4267 * 'ippSetStringf()' - Set a formatted string value of an attribute.
4268 *
4269 * The @code ipp@ parameter refers to an IPP message previously created using
4270 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
4271 *
4272 * The @code attr@ parameter may be modified as a result of setting the value.
4273 *
4274 * The @code element@ parameter specifies which value to set from 0 to
65bebeac 4275 * @code ippGetCount(attr)@.
a469f8a5
MS
4276 *
4277 * The @code format@ parameter uses formatting characters compatible with the
4278 * printf family of standard functions. Additional arguments follow it as
4279 * needed. The formatted string is truncated as needed to the maximum length of
4280 * the corresponding value type.
4281 *
8072030b 4282 * @since CUPS 1.7/macOS 10.9@
a469f8a5
MS
4283 */
4284
4285int /* O - 1 on success, 0 on failure */
6961465f 4286ippSetStringf(ipp_t *ipp, /* I - IPP message */
a469f8a5
MS
4287 ipp_attribute_t **attr, /* IO - IPP attribute */
4288 int element, /* I - Value number (0-based) */
4289 const char *format, /* I - Printf-style format string */
4290 ...) /* I - Additional arguments as needed */
4291{
4292 int ret; /* Return value */
4293 va_list ap; /* Pointer to additional arguments */
4294
4295
4296 va_start(ap, format);
4297 ret = ippSetStringfv(ipp, attr, element, format, ap);
4298 va_end(ap);
4299
4300 return (ret);
4301}
4302
4303
4304/*
4305 * 'ippSetStringf()' - Set a formatted string value of an attribute.
4306 *
4307 * The @code ipp@ parameter refers to an IPP message previously created using
4308 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
4309 *
4310 * The @code attr@ parameter may be modified as a result of setting the value.
4311 *
4312 * The @code element@ parameter specifies which value to set from 0 to
65bebeac 4313 * @code ippGetCount(attr)@.
a469f8a5
MS
4314 *
4315 * The @code format@ parameter uses formatting characters compatible with the
4316 * printf family of standard functions. Additional arguments follow it as
4317 * needed. The formatted string is truncated as needed to the maximum length of
4318 * the corresponding value type.
4319 *
8072030b 4320 * @since CUPS 1.7/macOS 10.9@
a469f8a5
MS
4321 */
4322
4323int /* O - 1 on success, 0 on failure */
6961465f 4324ippSetStringfv(ipp_t *ipp, /* I - IPP message */
a469f8a5
MS
4325 ipp_attribute_t **attr, /* IO - IPP attribute */
4326 int element, /* I - Value number (0-based) */
4327 const char *format, /* I - Printf-style format string */
4328 va_list ap) /* I - Pointer to additional arguments */
4329{
4330 ipp_tag_t value_tag; /* Value tag */
4331 char buffer[IPP_MAX_TEXT + 4];
4332 /* Formatted text string */
4333 ssize_t bytes, /* Length of formatted value */
4334 max_bytes; /* Maximum number of bytes for value */
4335
4336
4337 /*
4338 * Range check input...
4339 */
4340
4341 if (attr && *attr)
4342 value_tag = (*attr)->value_tag & IPP_TAG_CUPS_MASK;
4343 else
4344 value_tag = IPP_TAG_ZERO;
4345
4346 if (!ipp || !attr || !*attr ||
4347 (value_tag < IPP_TAG_TEXT && value_tag != IPP_TAG_TEXTLANG &&
4348 value_tag != IPP_TAG_NAMELANG) || value_tag > IPP_TAG_MIMETYPE ||
56cd8959 4349 !format)
a469f8a5
MS
4350 return (0);
4351
4352 /*
4353 * Format the string...
4354 */
4355
4356 if (!strcmp(format, "%s"))
4357 {
4358 /*
4359 * Optimize the simple case...
4360 */
4361
4362 const char *s = va_arg(ap, char *);
4363
4364 if (!s)
4365 s = "(null)";
4366
7e86f2f6 4367 bytes = (ssize_t)strlen(s);
a469f8a5
MS
4368 strlcpy(buffer, s, sizeof(buffer));
4369 }
4370 else
4371 {
4372 /*
4373 * Do a full formatting of the message...
4374 */
4375
4376 if ((bytes = vsnprintf(buffer, sizeof(buffer), format, ap)) < 0)
4377 return (0);
4378 }
4379
4380 /*
4381 * Limit the length of the string...
4382 */
4383
4384 switch (value_tag)
4385 {
4386 default :
4387 case IPP_TAG_TEXT :
4388 case IPP_TAG_TEXTLANG :
4389 max_bytes = IPP_MAX_TEXT;
4390 break;
4391
4392 case IPP_TAG_NAME :
4393 case IPP_TAG_NAMELANG :
4394 max_bytes = IPP_MAX_NAME;
4395 break;
4396
4397 case IPP_TAG_CHARSET :
4398 max_bytes = IPP_MAX_CHARSET;
4399 break;
4400
4401 case IPP_TAG_KEYWORD :
4402 max_bytes = IPP_MAX_KEYWORD;
4403 break;
4404
4405 case IPP_TAG_LANGUAGE :
4406 max_bytes = IPP_MAX_LANGUAGE;
4407 break;
4408
4409 case IPP_TAG_MIMETYPE :
4410 max_bytes = IPP_MAX_MIMETYPE;
4411 break;
4412
4413 case IPP_TAG_URI :
4414 max_bytes = IPP_MAX_URI;
4415 break;
4416
4417 case IPP_TAG_URISCHEME :
4418 max_bytes = IPP_MAX_URISCHEME;
4419 break;
4420 }
4421
4422 if (bytes >= max_bytes)
4423 {
4424 char *bufmax, /* Buffer at max_bytes */
4425 *bufptr; /* Pointer into buffer */
4426
4427 bufptr = buffer + strlen(buffer) - 1;
4428 bufmax = buffer + max_bytes - 1;
4429
4430 while (bufptr > bufmax)
4431 {
4432 if (*bufptr & 0x80)
4433 {
4434 while ((*bufptr & 0xc0) == 0x80 && bufptr > buffer)
4435 bufptr --;
4436 }
4437
4438 bufptr --;
4439 }
4440
4441 *bufptr = '\0';
4442 }
4443
4444 /*
4445 * Set the formatted string and return...
4446 */
4447
4448 return (ippSetString(ipp, attr, element, buffer));
4449}
4450
4451
a2326b5b
MS
4452/*
4453 * 'ippSetValueTag()' - Set the value tag of an attribute.
4454 *
a469f8a5
MS
4455 * The @code ipp@ parameter refers to an IPP message previously created using
4456 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
4457 *
4458 * The @code attr@ parameter may be modified as a result of setting the value.
4459 *
4460 * Integer (@code IPP_TAG_INTEGER@) values can be promoted to rangeOfInteger
4461 * (@code IPP_TAG_RANGE@) values, the various string tags can be promoted to name
4462 * (@code IPP_TAG_NAME@) or nameWithLanguage (@code IPP_TAG_NAMELANG@) values, text
4463 * (@code IPP_TAG_TEXT@) values can be promoted to textWithLanguage
4464 * (@code IPP_TAG_TEXTLANG@) values, and all values can be demoted to the various
4465 * out-of-band value tags such as no-value (@code IPP_TAG_NOVALUE@). All other changes
4466 * will be rejected.
4467 *
4468 * Promoting a string attribute to nameWithLanguage or textWithLanguage adds the language
4469 * code in the "attributes-natural-language" attribute or, if not present, the language
4470 * code for the current locale.
4471 *
8072030b 4472 * @since CUPS 1.6/macOS 10.8@
a2326b5b 4473 */
ef416fc2 4474
a2326b5b
MS
4475int /* O - 1 on success, 0 on failure */
4476ippSetValueTag(
6961465f 4477 ipp_t *ipp, /* I - IPP message */
a2326b5b
MS
4478 ipp_attribute_t **attr, /* IO - IPP attribute */
4479 ipp_tag_t value_tag) /* I - Value tag */
4480{
4481 int i; /* Looping var */
4482 _ipp_value_t *value; /* Current value */
4483 int integer; /* Current integer value */
4484 cups_lang_t *language; /* Current language */
4485 char code[32]; /* Language code */
4486 ipp_tag_t temp_tag; /* Temporary value tag */
ef416fc2 4487
ef416fc2 4488
a2326b5b
MS
4489 /*
4490 * Range check input...
4491 */
1f6f3dbc 4492
a469f8a5 4493 if (!ipp || !attr || !*attr)
a2326b5b 4494 return (0);
ef416fc2 4495
a2326b5b
MS
4496 /*
4497 * If there is no change, return immediately...
4498 */
ef416fc2 4499
a2326b5b
MS
4500 if (value_tag == (*attr)->value_tag)
4501 return (1);
ef416fc2 4502
a2326b5b
MS
4503 /*
4504 * Otherwise implement changes as needed...
4505 */
ef416fc2 4506
cb7f98ee 4507 temp_tag = (ipp_tag_t)((int)((*attr)->value_tag) & IPP_TAG_CUPS_MASK);
4400e98d 4508
a2326b5b
MS
4509 switch (value_tag)
4510 {
4511 case IPP_TAG_UNSUPPORTED_VALUE :
4512 case IPP_TAG_DEFAULT :
4513 case IPP_TAG_UNKNOWN :
4514 case IPP_TAG_NOVALUE :
4515 case IPP_TAG_NOTSETTABLE :
4516 case IPP_TAG_DELETEATTR :
4517 case IPP_TAG_ADMINDEFINE :
4518 /*
4519 * Free any existing values...
4520 */
ef416fc2 4521
a2326b5b
MS
4522 if ((*attr)->num_values > 0)
4523 ipp_free_values(*attr, 0, (*attr)->num_values);
ef416fc2 4524
a2326b5b
MS
4525 /*
4526 * Set out-of-band value...
4527 */
ef416fc2 4528
a2326b5b
MS
4529 (*attr)->value_tag = value_tag;
4530 break;
91c84a35 4531
a2326b5b
MS
4532 case IPP_TAG_RANGE :
4533 if (temp_tag != IPP_TAG_INTEGER)
4534 return (0);
4535
4536 for (i = (*attr)->num_values, value = (*attr)->values;
4537 i > 0;
4538 i --, value ++)
4539 {
4540 integer = value->integer;
4541 value->range.lower = value->range.upper = integer;
4542 }
ef416fc2 4543
a2326b5b
MS
4544 (*attr)->value_tag = IPP_TAG_RANGE;
4545 break;
ef416fc2 4546
a2326b5b
MS
4547 case IPP_TAG_NAME :
4548 if (temp_tag != IPP_TAG_KEYWORD && temp_tag != IPP_TAG_URI &&
4549 temp_tag != IPP_TAG_URISCHEME && temp_tag != IPP_TAG_LANGUAGE &&
4550 temp_tag != IPP_TAG_MIMETYPE)
4551 return (0);
ef416fc2 4552
cb7f98ee 4553 (*attr)->value_tag = (ipp_tag_t)(IPP_TAG_NAME | ((*attr)->value_tag & IPP_TAG_CUPS_CONST));
ef416fc2 4554 break;
4555
a2326b5b
MS
4556 case IPP_TAG_NAMELANG :
4557 case IPP_TAG_TEXTLANG :
4558 if (value_tag == IPP_TAG_NAMELANG &&
4559 (temp_tag != IPP_TAG_NAME && temp_tag != IPP_TAG_KEYWORD &&
4560 temp_tag != IPP_TAG_URI && temp_tag != IPP_TAG_URISCHEME &&
4561 temp_tag != IPP_TAG_LANGUAGE && temp_tag != IPP_TAG_MIMETYPE))
4562 return (0);
4563
4564 if (value_tag == IPP_TAG_TEXTLANG && temp_tag != IPP_TAG_TEXT)
4565 return (0);
4566
4567 if (ipp->attrs && ipp->attrs->next && ipp->attrs->next->name &&
4568 !strcmp(ipp->attrs->next->name, "attributes-natural-language"))
4569 {
4570 /*
4571 * Use the language code from the IPP message...
4572 */
4573
4574 (*attr)->values[0].string.language =
4575 _cupsStrAlloc(ipp->attrs->next->values[0].string.text);
4576 }
4577 else
4578 {
4579 /*
4580 * Otherwise, use the language code corresponding to the locale...
4581 */
4582
4583 language = cupsLangDefault();
4584 (*attr)->values[0].string.language = _cupsStrAlloc(ipp_lang_code(language->language,
4585 code,
4586 sizeof(code)));
4587 }
4588
4589 for (i = (*attr)->num_values - 1, value = (*attr)->values + 1;
4590 i > 0;
4591 i --, value ++)
4592 value->string.language = (*attr)->values[0].string.language;
4593
cb7f98ee 4594 if ((int)(*attr)->value_tag & IPP_TAG_CUPS_CONST)
a2326b5b
MS
4595 {
4596 /*
4597 * Make copies of all values...
4598 */
4599
4600 for (i = (*attr)->num_values, value = (*attr)->values;
4601 i > 0;
4602 i --, value ++)
4603 value->string.text = _cupsStrAlloc(value->string.text);
4604 }
4605
4606 (*attr)->value_tag = IPP_TAG_NAMELANG;
ef416fc2 4607 break;
4608
a2326b5b
MS
4609 case IPP_TAG_KEYWORD :
4610 if (temp_tag == IPP_TAG_NAME || temp_tag == IPP_TAG_NAMELANG)
4611 break; /* Silently "allow" name -> keyword */
4612
ef416fc2 4613 default :
a2326b5b 4614 return (0);
ef416fc2 4615 }
4616
a2326b5b
MS
4617 return (1);
4618}
4619
4620
4621/*
4622 * 'ippSetVersion()' - Set the version number in an IPP message.
4623 *
a469f8a5
MS
4624 * The @code ipp@ parameter refers to an IPP message previously created using
4625 * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
a2326b5b
MS
4626 *
4627 * The valid version numbers are currently 1.0, 1.1, 2.0, 2.1, and 2.2.
4628 *
8072030b 4629 * @since CUPS 1.6/macOS 10.8@
a2326b5b
MS
4630 */
4631
4632int /* O - 1 on success, 0 on failure */
4633ippSetVersion(ipp_t *ipp, /* I - IPP message */
4634 int major, /* I - Major version number (major.minor) */
4635 int minor) /* I - Minor version number (major.minor) */
4636{
4637 /*
4638 * Range check input...
4639 */
4640
4641 if (!ipp || major < 0 || minor < 0)
4642 return (0);
4643
4644 /*
4645 * Set the version number...
4646 */
4647
7e86f2f6
MS
4648 ipp->request.any.version[0] = (ipp_uchar_t)major;
4649 ipp->request.any.version[1] = (ipp_uchar_t)minor;
89d46774 4650
a2326b5b 4651 return (1);
ef416fc2 4652}
4653
4654
4655/*
65bebeac 4656 * 'ippTimeToDate()' - Convert from time in seconds to RFC 2579 format.
ef416fc2 4657 */
4658
65bebeac
MS
4659const ipp_uchar_t * /* O - RFC-2579 date/time data */
4660ippTimeToDate(time_t t) /* I - Time in seconds */
ef416fc2 4661{
4662 struct tm *unixdate; /* UNIX unixdate/time info */
4663 ipp_uchar_t *date = _cupsGlobals()->ipp_date;
65bebeac 4664 /* RFC-2579 date/time data */
ef416fc2 4665
4666
4667 /*
65bebeac 4668 * RFC-2579 date/time format is:
ef416fc2 4669 *
4670 * Byte(s) Description
4671 * ------- -----------
4672 * 0-1 Year (0 to 65535)
4673 * 2 Month (1 to 12)
4674 * 3 Day (1 to 31)
4675 * 4 Hours (0 to 23)
4676 * 5 Minutes (0 to 59)
4677 * 6 Seconds (0 to 60, 60 = "leap second")
4678 * 7 Deciseconds (0 to 9)
4679 * 8 +/- UTC
4680 * 9 UTC hours (0 to 11)
4681 * 10 UTC minutes (0 to 59)
4682 */
4683
4684 unixdate = gmtime(&t);
4685 unixdate->tm_year += 1900;
4686
7e86f2f6
MS
4687 date[0] = (ipp_uchar_t)(unixdate->tm_year >> 8);
4688 date[1] = (ipp_uchar_t)(unixdate->tm_year);
4689 date[2] = (ipp_uchar_t)(unixdate->tm_mon + 1);
4690 date[3] = (ipp_uchar_t)unixdate->tm_mday;
4691 date[4] = (ipp_uchar_t)unixdate->tm_hour;
4692 date[5] = (ipp_uchar_t)unixdate->tm_min;
4693 date[6] = (ipp_uchar_t)unixdate->tm_sec;
ef416fc2 4694 date[7] = 0;
4695 date[8] = '+';
4696 date[9] = 0;
4697 date[10] = 0;
4698
4699 return (date);
4700}
4701
4702
c1420c87
MS
4703/*
4704 * 'ippValidateAttribute()' - Validate the contents of an attribute.
4705 *
4706 * This function validates the contents of an attribute based on the name and
4707 * value tag. 1 is returned if the attribute is valid, 0 otherwise. On
65bebeac 4708 * failure, @link cupsLastErrorString@ is set to a human-readable message.
c1420c87 4709 *
8072030b 4710 * @since CUPS 1.7/macOS 10.9@
c1420c87
MS
4711 */
4712
4713int /* O - 1 if valid, 0 otherwise */
4714ippValidateAttribute(
4715 ipp_attribute_t *attr) /* I - Attribute */
4716{
4717 int i; /* Looping var */
4718 char scheme[64], /* Scheme from URI */
4719 userpass[256], /* Username/password from URI */
4720 hostname[256], /* Hostname from URI */
4721 resource[1024]; /* Resource from URI */
4722 int port, /* Port number from URI */
4723 uri_status; /* URI separation status */
4724 const char *ptr; /* Pointer into string */
4725 ipp_attribute_t *colattr; /* Collection attribute */
4726 regex_t re; /* Regular expression */
4727 ipp_uchar_t *date; /* Current date value */
c1420c87
MS
4728
4729
4730 /*
4731 * Skip separators.
4732 */
4733
4734 if (!attr->name)
4735 return (1);
4736
4737 /*
4738 * Validate the attribute name.
4739 */
4740
4741 for (ptr = attr->name; *ptr; ptr ++)
4742 if (!isalnum(*ptr & 255) && *ptr != '-' && *ptr != '.' && *ptr != '_')
4743 break;
4744
4745 if (*ptr || ptr == attr->name)
4746 {
2da2477d 4747 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad attribute name - invalid character (RFC 8011 section 5.1.4)."), attr->name);
c1420c87
MS
4748 return (0);
4749 }
4750
4751 if ((ptr - attr->name) > 255)
4752 {
2da2477d 4753 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad attribute name - bad length %d (RFC 8011 section 5.1.4)."), attr->name, (int)(ptr - attr->name));
c1420c87
MS
4754 return (0);
4755 }
4756
4757 switch (attr->value_tag)
4758 {
4759 case IPP_TAG_INTEGER :
4760 break;
4761
4762 case IPP_TAG_BOOLEAN :
4763 for (i = 0; i < attr->num_values; i ++)
4764 {
4765 if (attr->values[i].boolean != 0 &&
4766 attr->values[i].boolean != 1)
4767 {
2da2477d 4768 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad boolean value %d (RFC 8011 section 5.1.21)."), attr->name, attr->values[i].boolean);
c1420c87
MS
4769 return (0);
4770 }
4771 }
4772 break;
4773
4774 case IPP_TAG_ENUM :
4775 for (i = 0; i < attr->num_values; i ++)
4776 {
4777 if (attr->values[i].integer < 1)
4778 {
2da2477d 4779 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad enum value %d - out of range (RFC 8011 section 5.1.5)."), attr->name, attr->values[i].integer);
c1420c87
MS
4780 return (0);
4781 }
4782 }
4783 break;
4784
4785 case IPP_TAG_STRING :
4786 for (i = 0; i < attr->num_values; i ++)
4787 {
4788 if (attr->values[i].unknown.length > IPP_MAX_OCTETSTRING)
4789 {
2da2477d 4790 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad octetString value - bad length %d (RFC 8011 section 5.1.20)."), attr->name, attr->values[i].unknown.length);
c1420c87
MS
4791 return (0);
4792 }
4793 }
4794 break;
4795
4796 case IPP_TAG_DATE :
4797 for (i = 0; i < attr->num_values; i ++)
4798 {
4799 date = attr->values[i].date;
4800
4801 if (date[2] < 1 || date[2] > 12)
4802 {
2da2477d 4803 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
4804 return (0);
4805 }
4806
4807 if (date[3] < 1 || date[3] > 31)
4808 {
2da2477d 4809 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
4810 return (0);
4811 }
4812
4813 if (date[4] > 23)
4814 {
2da2477d 4815 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
4816 return (0);
4817 }
4818
4819 if (date[5] > 59)
4820 {
2da2477d 4821 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
4822 return (0);
4823 }
4824
4825 if (date[6] > 60)
4826 {
2da2477d 4827 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
4828 return (0);
4829 }
4830
4831 if (date[7] > 9)
4832 {
2da2477d 4833 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
4834 return (0);
4835 }
4836
4837 if (date[8] != '-' && date[8] != '+')
4838 {
2da2477d 4839 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad dateTime UTC sign '%c' (RFC 8011 section 5.1.15)."), attr->name, date[8]);
c1420c87
MS
4840 return (0);
4841 }
4842
4843 if (date[9] > 11)
4844 {
2da2477d 4845 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad dateTime UTC hours %u (RFC 8011 section 5.1.15)."), attr->name, date[9]);
c1420c87
MS
4846 return (0);
4847 }
4848
4849 if (date[10] > 59)
4850 {
2da2477d 4851 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad dateTime UTC minutes %u (RFC 8011 section 5.1.15)."), attr->name, date[10]);
c1420c87
MS
4852 return (0);
4853 }
4854 }
4855 break;
4856
4857 case IPP_TAG_RESOLUTION :
4858 for (i = 0; i < attr->num_values; i ++)
4859 {
4860 if (attr->values[i].resolution.xres <= 0)
4861 {
2da2477d 4862 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad resolution value %dx%d%s - cross feed resolution must be positive (RFC 8011 section 5.1.16)."), attr->name, attr->values[i].resolution.xres, attr->values[i].resolution.yres, attr->values[i].resolution.units == IPP_RES_PER_INCH ? "dpi" : attr->values[i].resolution.units == IPP_RES_PER_CM ? "dpcm" : "unknown");
c1420c87
MS
4863 return (0);
4864 }
4865
4866 if (attr->values[i].resolution.yres <= 0)
4867 {
2da2477d 4868 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad resolution value %dx%d%s - feed resolution must be positive (RFC 8011 section 5.1.16)."), attr->name, attr->values[i].resolution.xres, attr->values[i].resolution.yres, attr->values[i].resolution.units == IPP_RES_PER_INCH ? "dpi" : attr->values[i].resolution.units == IPP_RES_PER_CM ? "dpcm" : "unknown");
c1420c87
MS
4869 return (0);
4870 }
4871
2da2477d 4872 if (attr->values[i].resolution.units != IPP_RES_PER_INCH && attr->values[i].resolution.units != IPP_RES_PER_CM)
c1420c87 4873 {
2da2477d 4874 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad resolution value %dx%d%s - bad units value (RFC 8011 section 5.1.16)."), attr->name, attr->values[i].resolution.xres, attr->values[i].resolution.yres, attr->values[i].resolution.units == IPP_RES_PER_INCH ? "dpi" : attr->values[i].resolution.units == IPP_RES_PER_CM ? "dpcm" : "unknown");
c1420c87
MS
4875 return (0);
4876 }
4877 }
4878 break;
4879
4880 case IPP_TAG_RANGE :
4881 for (i = 0; i < attr->num_values; i ++)
4882 {
4883 if (attr->values[i].range.lower > attr->values[i].range.upper)
4884 {
2da2477d 4885 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad rangeOfInteger value %d-%d - lower greater than upper (RFC 8011 section 5.1.14)."), attr->name, attr->values[i].range.lower, attr->values[i].range.upper);
c1420c87
MS
4886 return (0);
4887 }
4888 }
4889 break;
4890
4891 case IPP_TAG_BEGIN_COLLECTION :
4892 for (i = 0; i < attr->num_values; i ++)
4893 {
4894 for (colattr = attr->values[i].collection->attrs;
4895 colattr;
4896 colattr = colattr->next)
4897 {
4898 if (!ippValidateAttribute(colattr))
4899 return (0);
4900 }
4901 }
4902 break;
4903
4904 case IPP_TAG_TEXT :
4905 case IPP_TAG_TEXTLANG :
4906 for (i = 0; i < attr->num_values; i ++)
4907 {
4908 for (ptr = attr->values[i].string.text; *ptr; ptr ++)
4909 {
4910 if ((*ptr & 0xe0) == 0xc0)
4911 {
4912 ptr ++;
4913 if ((*ptr & 0xc0) != 0x80)
4914 break;
4915 }
4916 else if ((*ptr & 0xf0) == 0xe0)
4917 {
4918 ptr ++;
4919 if ((*ptr & 0xc0) != 0x80)
4920 break;
4921 ptr ++;
4922 if ((*ptr & 0xc0) != 0x80)
4923 break;
4924 }
4925 else if ((*ptr & 0xf8) == 0xf0)
4926 {
4927 ptr ++;
4928 if ((*ptr & 0xc0) != 0x80)
4929 break;
4930 ptr ++;
4931 if ((*ptr & 0xc0) != 0x80)
4932 break;
4933 ptr ++;
4934 if ((*ptr & 0xc0) != 0x80)
4935 break;
4936 }
4937 else if (*ptr & 0x80)
4938 break;
4cadd620
MS
4939 else if ((*ptr < ' ' && *ptr != '\n' && *ptr != '\r' && *ptr != '\t') || *ptr == 0x7f)
4940 break;
c1420c87
MS
4941 }
4942
1d677f11
MS
4943 if (*ptr)
4944 {
4945 if (*ptr < ' ' || *ptr == 0x7f)
4946 {
4947 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad text value \"%s\" - bad control character (PWG 5100.14 section 8.3)."), attr->name, attr->values[i].string.text);
4948 return (0);
4949 }
4950 else
4951 {
4952 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad text value \"%s\" - bad UTF-8 sequence (RFC 8011 section 5.1.2)."), attr->name, attr->values[i].string.text);
4953 return (0);
4954 }
4955 }
c1420c87
MS
4956
4957 if ((ptr - attr->values[i].string.text) > (IPP_MAX_TEXT - 1))
4958 {
2da2477d 4959 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad text value \"%s\" - bad length %d (RFC 8011 section 5.1.2)."), attr->name, attr->values[i].string.text, (int)(ptr - attr->values[i].string.text));
c1420c87
MS
4960 return (0);
4961 }
4962 }
4963 break;
4964
4965 case IPP_TAG_NAME :
4966 case IPP_TAG_NAMELANG :
4967 for (i = 0; i < attr->num_values; i ++)
4968 {
4969 for (ptr = attr->values[i].string.text; *ptr; ptr ++)
4970 {
4971 if ((*ptr & 0xe0) == 0xc0)
4972 {
4973 ptr ++;
4974 if ((*ptr & 0xc0) != 0x80)
4975 break;
4976 }
4977 else if ((*ptr & 0xf0) == 0xe0)
4978 {
4979 ptr ++;
4980 if ((*ptr & 0xc0) != 0x80)
4981 break;
4982 ptr ++;
4983 if ((*ptr & 0xc0) != 0x80)
4984 break;
4985 }
4986 else if ((*ptr & 0xf8) == 0xf0)
4987 {
4988 ptr ++;
4989 if ((*ptr & 0xc0) != 0x80)
4990 break;
4991 ptr ++;
4992 if ((*ptr & 0xc0) != 0x80)
4993 break;
4994 ptr ++;
4995 if ((*ptr & 0xc0) != 0x80)
4996 break;
4997 }
4998 else if (*ptr & 0x80)
4999 break;
4cadd620
MS
5000 else if (*ptr < ' ' || *ptr == 0x7f)
5001 break;
c1420c87
MS
5002 }
5003
1d677f11 5004 if (*ptr)
c1420c87 5005 {
1d677f11
MS
5006 if (*ptr < ' ' || *ptr == 0x7f)
5007 {
5008 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad name value \"%s\" - bad control character (PWG 5100.14 section 8.1)."), attr->name, attr->values[i].string.text);
5009 return (0);
5010 }
5011 else
5012 {
5013 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad name value \"%s\" - bad UTF-8 sequence (RFC 8011 section 5.1.3)."), attr->name, attr->values[i].string.text);
5014 return (0);
5015 }
5016 }
c1420c87
MS
5017
5018 if ((ptr - attr->values[i].string.text) > (IPP_MAX_NAME - 1))
5019 {
2da2477d 5020 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad name value \"%s\" - bad length %d (RFC 8011 section 5.1.3)."), attr->name, attr->values[i].string.text, (int)(ptr - attr->values[i].string.text));
c1420c87
MS
5021 return (0);
5022 }
5023 }
5024 break;
5025
5026 case IPP_TAG_KEYWORD :
5027 for (i = 0; i < attr->num_values; i ++)
5028 {
5029 for (ptr = attr->values[i].string.text; *ptr; ptr ++)
2da2477d 5030 {
c1420c87
MS
5031 if (!isalnum(*ptr & 255) && *ptr != '-' && *ptr != '.' &&
5032 *ptr != '_')
5033 break;
2da2477d 5034 }
c1420c87
MS
5035
5036 if (*ptr || ptr == attr->values[i].string.text)
5037 {
2da2477d 5038 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad keyword value \"%s\" - invalid character (RFC 8011 section 5.1.4)."), attr->name, attr->values[i].string.text);
c1420c87
MS
5039 return (0);
5040 }
5041
5042 if ((ptr - attr->values[i].string.text) > (IPP_MAX_KEYWORD - 1))
5043 {
2da2477d 5044 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad keyword value \"%s\" - bad length %d (RFC 8011 section 5.1.4)."), attr->name, attr->values[i].string.text, (int)(ptr - attr->values[i].string.text));
c1420c87
MS
5045 return (0);
5046 }
5047 }
5048 break;
5049
5050 case IPP_TAG_URI :
5051 for (i = 0; i < attr->num_values; i ++)
5052 {
2da2477d 5053 uri_status = httpSeparateURI(HTTP_URI_CODING_ALL, attr->values[i].string.text, scheme, sizeof(scheme), userpass, sizeof(userpass), hostname, sizeof(hostname), &port, resource, sizeof(resource));
c1420c87 5054
cb7f98ee 5055 if (uri_status < HTTP_URI_STATUS_OK)
c1420c87 5056 {
2da2477d 5057 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad URI value \"%s\" - %s (RFC 8011 section 5.1.6)."), attr->name, attr->values[i].string.text, httpURIStatusString(uri_status));
c1420c87
MS
5058 return (0);
5059 }
5060
5061 if (strlen(attr->values[i].string.text) > (IPP_MAX_URI - 1))
5062 {
2da2477d 5063 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad URI value \"%s\" - bad length %d (RFC 8011 section 5.1.6)."), attr->name, attr->values[i].string.text, (int)strlen(attr->values[i].string.text));
c1420c87
MS
5064 }
5065 }
5066 break;
5067
5068 case IPP_TAG_URISCHEME :
5069 for (i = 0; i < attr->num_values; i ++)
5070 {
5071 ptr = attr->values[i].string.text;
5072 if (islower(*ptr & 255))
5073 {
5074 for (ptr ++; *ptr; ptr ++)
2da2477d 5075 {
c1420c87
MS
5076 if (!islower(*ptr & 255) && !isdigit(*ptr & 255) &&
5077 *ptr != '+' && *ptr != '-' && *ptr != '.')
5078 break;
2da2477d 5079 }
c1420c87
MS
5080 }
5081
5082 if (*ptr || ptr == attr->values[i].string.text)
5083 {
2da2477d 5084 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad uriScheme value \"%s\" - bad characters (RFC 8011 section 5.1.7)."), attr->name, attr->values[i].string.text);
c1420c87
MS
5085 return (0);
5086 }
5087
5088 if ((ptr - attr->values[i].string.text) > (IPP_MAX_URISCHEME - 1))
5089 {
2da2477d 5090 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad uriScheme value \"%s\" - bad length %d (RFC 8011 section 5.1.7)."), attr->name, attr->values[i].string.text, (int)(ptr - attr->values[i].string.text));
c1420c87
MS
5091 return (0);
5092 }
5093 }
5094 break;
5095
5096 case IPP_TAG_CHARSET :
5097 for (i = 0; i < attr->num_values; i ++)
5098 {
5099 for (ptr = attr->values[i].string.text; *ptr; ptr ++)
2da2477d 5100 {
c1420c87
MS
5101 if (!isprint(*ptr & 255) || isupper(*ptr & 255) ||
5102 isspace(*ptr & 255))
5103 break;
2da2477d 5104 }
c1420c87
MS
5105
5106 if (*ptr || ptr == attr->values[i].string.text)
5107 {
2da2477d 5108 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad charset value \"%s\" - bad characters (RFC 8011 section 5.1.8)."), attr->name, attr->values[i].string.text);
c1420c87
MS
5109 return (0);
5110 }
5111
5112 if ((ptr - attr->values[i].string.text) > (IPP_MAX_CHARSET - 1))
5113 {
2da2477d 5114 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad charset value \"%s\" - bad length %d (RFC 8011 section 5.1.8)."), attr->name, attr->values[i].string.text, (int)(ptr - attr->values[i].string.text));
c1420c87
MS
5115 return (0);
5116 }
5117 }
5118 break;
5119
5120 case IPP_TAG_LANGUAGE :
5121 /*
5122 * The following regular expression is derived from the ABNF for
5123 * language tags in RFC 4646. All I can say is that this is the
5124 * easiest way to check the values...
5125 */
5126
5127 if ((i = regcomp(&re,
5128 "^("
5129 "(([a-z]{2,3}(-[a-z][a-z][a-z]){0,3})|[a-z]{4,8})"
5130 /* language */
5131 "(-[a-z][a-z][a-z][a-z]){0,1}" /* script */
5132 "(-([a-z][a-z]|[0-9][0-9][0-9])){0,1}" /* region */
5133 "(-([a-z]{5,8}|[0-9][0-9][0-9]))*" /* variant */
5134 "(-[a-wy-z](-[a-z0-9]{2,8})+)*" /* extension */
5135 "(-x(-[a-z0-9]{1,8})+)*" /* privateuse */
5136 "|"
5137 "x(-[a-z0-9]{1,8})+" /* privateuse */
5138 "|"
5139 "[a-z]{1,3}(-[a-z][0-9]{2,8}){1,2}" /* grandfathered */
5140 ")$",
5141 REG_NOSUB | REG_EXTENDED)) != 0)
5142 {
5143 char temp[256]; /* Temporary error string */
5144
5145 regerror(i, &re, temp, sizeof(temp));
2da2477d 5146 ipp_set_error(IPP_STATUS_ERROR_INTERNAL, _("Unable to compile naturalLanguage regular expression: %s."), temp);
c1420c87
MS
5147 return (0);
5148 }
5149
5150 for (i = 0; i < attr->num_values; i ++)
5151 {
5152 if (regexec(&re, attr->values[i].string.text, 0, NULL, 0))
5153 {
2da2477d 5154 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad naturalLanguage value \"%s\" - bad characters (RFC 8011 section 5.1.9)."), attr->name, attr->values[i].string.text);
c1420c87
MS
5155 regfree(&re);
5156 return (0);
5157 }
5158
5159 if (strlen(attr->values[i].string.text) > (IPP_MAX_LANGUAGE - 1))
5160 {
2da2477d 5161 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad naturalLanguage value \"%s\" - bad length %d (RFC 8011 section 5.1.9)."), attr->name, attr->values[i].string.text, (int)strlen(attr->values[i].string.text));
c1420c87
MS
5162 regfree(&re);
5163 return (0);
5164 }
5165 }
5166
5167 regfree(&re);
5168 break;
5169
5170 case IPP_TAG_MIMETYPE :
5171 /*
5172 * The following regular expression is derived from the ABNF for
5173 * MIME media types in RFC 2045 and 4288. All I can say is that this is
5174 * the easiest way to check the values...
5175 */
5176
5177 if ((i = regcomp(&re,
5178 "^"
5179 "[-a-zA-Z0-9!#$&.+^_]{1,127}" /* type-name */
5180 "/"
5181 "[-a-zA-Z0-9!#$&.+^_]{1,127}" /* subtype-name */
5182 "(;[-a-zA-Z0-9!#$&.+^_]{1,127}=" /* parameter= */
5183 "([-a-zA-Z0-9!#$&.+^_]{1,127}|\"[^\"]*\"))*"
5184 /* value */
5185 "$",
5186 REG_NOSUB | REG_EXTENDED)) != 0)
5187 {
5188 char temp[256]; /* Temporary error string */
5189
5190 regerror(i, &re, temp, sizeof(temp));
2da2477d 5191 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("Unable to compile mimeMediaType regular expression: %s."), temp);
c1420c87
MS
5192 return (0);
5193 }
5194
5195 for (i = 0; i < attr->num_values; i ++)
5196 {
5197 if (regexec(&re, attr->values[i].string.text, 0, NULL, 0))
5198 {
2da2477d 5199 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad mimeMediaType value \"%s\" - bad characters (RFC 8011 section 5.1.10)."), attr->name, attr->values[i].string.text);
c1420c87
MS
5200 regfree(&re);
5201 return (0);
5202 }
5203
5204 if (strlen(attr->values[i].string.text) > (IPP_MAX_MIMETYPE - 1))
5205 {
2da2477d 5206 ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad mimeMediaType value \"%s\" - bad length %d (RFC 8011 section 5.1.10)."), attr->name, attr->values[i].string.text, (int)strlen(attr->values[i].string.text));
c1420c87
MS
5207 regfree(&re);
5208 return (0);
5209 }
5210 }
5211
5212 regfree(&re);
5213 break;
5214
5215 default :
5216 break;
5217 }
5218
5219 return (1);
5220}
5221
5222
5223/*
5224 * 'ippValidateAttributes()' - Validate all attributes in an IPP message.
5225 *
5226 * This function validates the contents of the IPP message, including each
65bebeac
MS
5227 * attribute. Like @link ippValidateAttribute@, @link cupsLastErrorString@ is
5228 * set to a human-readable message on failure.
c1420c87 5229 *
8072030b 5230 * @since CUPS 1.7/macOS 10.9@
c1420c87
MS
5231 */
5232
5233int /* O - 1 if valid, 0 otherwise */
5234ippValidateAttributes(ipp_t *ipp) /* I - IPP message */
5235{
5236 ipp_attribute_t *attr; /* Current attribute */
5237
5238
5239 if (!ipp)
5240 return (1);
5241
5242 for (attr = ipp->attrs; attr; attr = attr->next)
5243 if (!ippValidateAttribute(attr))
5244 return (0);
5245
5246 return (1);
5247}
5248
5249
ef416fc2 5250/*
5251 * 'ippWrite()' - Write data for an IPP message to a HTTP connection.
5252 */
5253
5254ipp_state_t /* O - Current state */
5255ippWrite(http_t *http, /* I - HTTP connection */
5256 ipp_t *ipp) /* I - IPP data */
5257{
807315e6 5258 DEBUG_printf(("ippWrite(http=%p, ipp=%p)", (void *)http, (void *)ipp));
ef416fc2 5259
1ff0402e 5260 if (!http)
cb7f98ee 5261 return (IPP_STATE_ERROR);
ef416fc2 5262
e07d4801 5263 return (ippWriteIO(http, (ipp_iocb_t)httpWrite2, http->blocking, NULL, ipp));
ef416fc2 5264}
5265
5266
5267/*
5268 * 'ippWriteFile()' - Write data for an IPP message to a file.
5269 *
8072030b 5270 * @since CUPS 1.1.19/macOS 10.3@
ef416fc2 5271 */
5272
5273ipp_state_t /* O - Current state */
5274ippWriteFile(int fd, /* I - HTTP data */
5275 ipp_t *ipp) /* I - IPP data */
5276{
807315e6 5277 DEBUG_printf(("ippWriteFile(fd=%d, ipp=%p)", fd, (void *)ipp));
ef416fc2 5278
cb7f98ee 5279 ipp->state = IPP_STATE_IDLE;
ef416fc2 5280
5281 return (ippWriteIO(&fd, (ipp_iocb_t)ipp_write_file, 1, NULL, ipp));
5282}
5283
5284
5285/*
5286 * 'ippWriteIO()' - Write data for an IPP message.
5287 *
8072030b 5288 * @since CUPS 1.2/macOS 10.5@
ef416fc2 5289 */
5290
5291ipp_state_t /* O - Current state */
5292ippWriteIO(void *dst, /* I - Destination */
5293 ipp_iocb_t cb, /* I - Write callback function */
5294 int blocking, /* I - Use blocking IO? */
5295 ipp_t *parent, /* I - Parent IPP message */
5296 ipp_t *ipp) /* I - IPP data */
5297{
5298 int i; /* Looping var */
5299 int n; /* Length of data */
1f6f3dbc 5300 unsigned char *buffer, /* Data buffer */
ef416fc2 5301 *bufptr; /* Pointer into buffer */
5302 ipp_attribute_t *attr; /* Current attribute */
a2326b5b 5303 _ipp_value_t *value; /* Current value */
ef416fc2 5304
5305
807315e6 5306 DEBUG_printf(("ippWriteIO(dst=%p, cb=%p, blocking=%d, parent=%p, ipp=%p)", (void *)dst, (void *)cb, blocking, (void *)parent, (void *)ipp));
ef416fc2 5307
1ff0402e 5308 if (!dst || !ipp)
cb7f98ee 5309 return (IPP_STATE_ERROR);
ef416fc2 5310
dcb445bc 5311 if ((buffer = (unsigned char *)_cupsBufferGet(IPP_BUF_SIZE)) == NULL)
1f6f3dbc 5312 {
e07d4801 5313 DEBUG_puts("1ippWriteIO: Unable to get write buffer");
cb7f98ee 5314 return (IPP_STATE_ERROR);
1f6f3dbc
MS
5315 }
5316
ef416fc2 5317 switch (ipp->state)
5318 {
cb7f98ee 5319 case IPP_STATE_IDLE :
ef416fc2 5320 ipp->state ++; /* Avoid common problem... */
5321
cb7f98ee 5322 case IPP_STATE_HEADER :
ef416fc2 5323 if (parent == NULL)
5324 {
5325 /*
5326 * Send the request header:
5327 *
5328 * Version = 2 bytes
5329 * Operation/Status Code = 2 bytes
5330 * Request ID = 4 bytes
5331 * Total = 8 bytes
5332 */
5333
5334 bufptr = buffer;
5335
5336 *bufptr++ = ipp->request.any.version[0];
5337 *bufptr++ = ipp->request.any.version[1];
7e86f2f6
MS
5338 *bufptr++ = (ipp_uchar_t)(ipp->request.any.op_status >> 8);
5339 *bufptr++ = (ipp_uchar_t)ipp->request.any.op_status;
5340 *bufptr++ = (ipp_uchar_t)(ipp->request.any.request_id >> 24);
5341 *bufptr++ = (ipp_uchar_t)(ipp->request.any.request_id >> 16);
5342 *bufptr++ = (ipp_uchar_t)(ipp->request.any.request_id >> 8);
5343 *bufptr++ = (ipp_uchar_t)ipp->request.any.request_id;
ef416fc2 5344
ba55dc12
MS
5345 DEBUG_printf(("2ippWriteIO: version=%d.%d", buffer[0], buffer[1]));
5346 DEBUG_printf(("2ippWriteIO: op_status=%04x",
5347 ipp->request.any.op_status));
5348 DEBUG_printf(("2ippWriteIO: request_id=%d",
5349 ipp->request.any.request_id));
5350
7e86f2f6 5351 if ((*cb)(dst, buffer, (size_t)(bufptr - buffer)) < 0)
ef416fc2 5352 {
e07d4801 5353 DEBUG_puts("1ippWriteIO: Could not write IPP header...");
dcb445bc 5354 _cupsBufferRelease((char *)buffer);
cb7f98ee 5355 return (IPP_STATE_ERROR);
ef416fc2 5356 }
5357 }
5358
5359 /*
5360 * Reset the state engine to point to the first attribute
5361 * in the request/response, with no current group.
5362 */
5363
cb7f98ee 5364 ipp->state = IPP_STATE_ATTRIBUTE;
ef416fc2 5365 ipp->current = ipp->attrs;
5366 ipp->curtag = IPP_TAG_ZERO;
5367
807315e6 5368 DEBUG_printf(("1ippWriteIO: ipp->current=%p", (void *)ipp->current));
ef416fc2 5369
5370 /*
5371 * If blocking is disabled, stop here...
5372 */
5373
5374 if (!blocking)
5375 break;
5376
cb7f98ee 5377 case IPP_STATE_ATTRIBUTE :
ef416fc2 5378 while (ipp->current != NULL)
5379 {
5380 /*
5381 * Write this attribute...
5382 */
5383
5384 bufptr = buffer;
5385 attr = ipp->current;
5386
5387 ipp->current = ipp->current->next;
5388
ba55dc12 5389 if (!parent)
ef416fc2 5390 {
ba55dc12
MS
5391 if (ipp->curtag != attr->group_tag)
5392 {
5393 /*
5394 * Send a group tag byte...
5395 */
ef416fc2 5396
ba55dc12 5397 ipp->curtag = attr->group_tag;
ef416fc2 5398
ba55dc12
MS
5399 if (attr->group_tag == IPP_TAG_ZERO)
5400 continue;
ef416fc2 5401
ba55dc12
MS
5402 DEBUG_printf(("2ippWriteIO: wrote group tag=%x(%s)",
5403 attr->group_tag, ippTagString(attr->group_tag)));
7e86f2f6 5404 *bufptr++ = (ipp_uchar_t)attr->group_tag;
ba55dc12
MS
5405 }
5406 else if (attr->group_tag == IPP_TAG_ZERO)
5407 continue;
ef416fc2 5408 }
ba55dc12
MS
5409
5410 DEBUG_printf(("1ippWriteIO: %s (%s%s)", attr->name,
5411 attr->num_values > 1 ? "1setOf " : "",
5412 ippTagString(attr->value_tag)));
ef416fc2 5413
5414 /*
a2326b5b 5415 * Write the attribute tag and name.
ef416fc2 5416 *
5417 * The attribute name length does not include the trailing nul
5418 * character in the source string.
5419 *
5420 * Collection values (parent != NULL) are written differently...
5421 */
5422
5423 if (parent == NULL)
5424 {
5425 /*
5426 * Get the length of the attribute name, and make sure it won't
5427 * overflow the buffer...
5428 */
5429
a2326b5b 5430 if ((n = (int)strlen(attr->name)) > (IPP_BUF_SIZE - 8))
1f6f3dbc 5431 {
e07d4801 5432 DEBUG_printf(("1ippWriteIO: Attribute name too long (%d)", n));
dcb445bc 5433 _cupsBufferRelease((char *)buffer);
cb7f98ee 5434 return (IPP_STATE_ERROR);
1f6f3dbc 5435 }
ef416fc2 5436
5437 /*
5438 * Write the value tag, name length, and name string...
5439 */
5440
e07d4801 5441 DEBUG_printf(("2ippWriteIO: writing value tag=%x(%s)",
1ff0402e 5442 attr->value_tag, ippTagString(attr->value_tag)));
e07d4801 5443 DEBUG_printf(("2ippWriteIO: writing name=%d,\"%s\"", n,
1ff0402e 5444 attr->name));
ef416fc2 5445
a2326b5b
MS
5446 if (attr->value_tag > 0xff)
5447 {
5448 *bufptr++ = IPP_TAG_EXTENSION;
7e86f2f6
MS
5449 *bufptr++ = (ipp_uchar_t)(attr->value_tag >> 24);
5450 *bufptr++ = (ipp_uchar_t)(attr->value_tag >> 16);
5451 *bufptr++ = (ipp_uchar_t)(attr->value_tag >> 8);
5452 *bufptr++ = (ipp_uchar_t)attr->value_tag;
a2326b5b
MS
5453 }
5454 else
7e86f2f6 5455 *bufptr++ = (ipp_uchar_t)attr->value_tag;
a2326b5b 5456
7e86f2f6
MS
5457 *bufptr++ = (ipp_uchar_t)(n >> 8);
5458 *bufptr++ = (ipp_uchar_t)n;
07623986 5459 memcpy(bufptr, attr->name, (size_t)n);
ef416fc2 5460 bufptr += n;
5461 }
5462 else
5463 {
5464 /*
5465 * Get the length of the attribute name, and make sure it won't
5466 * overflow the buffer...
5467 */
5468
a2326b5b 5469 if ((n = (int)strlen(attr->name)) > (IPP_BUF_SIZE - 12))
1f6f3dbc 5470 {
e07d4801 5471 DEBUG_printf(("1ippWriteIO: Attribute name too long (%d)", n));
dcb445bc 5472 _cupsBufferRelease((char *)buffer);
cb7f98ee 5473 return (IPP_STATE_ERROR);
1f6f3dbc 5474 }
ef416fc2 5475
5476 /*
5477 * Write the member name tag, name length, name string, value tag,
5478 * and empty name for the collection member attribute...
5479 */
5480
e07d4801 5481 DEBUG_printf(("2ippWriteIO: writing value tag=%x(memberName)",
ef416fc2 5482 IPP_TAG_MEMBERNAME));
e07d4801 5483 DEBUG_printf(("2ippWriteIO: writing name=%d,\"%s\"", n,
1ff0402e 5484 attr->name));
e07d4801 5485 DEBUG_printf(("2ippWriteIO: writing value tag=%x(%s)",
1ff0402e 5486 attr->value_tag, ippTagString(attr->value_tag)));
e07d4801 5487 DEBUG_puts("2ippWriteIO: writing name=0,\"\"");
ef416fc2 5488
5489 *bufptr++ = IPP_TAG_MEMBERNAME;
5490 *bufptr++ = 0;
5491 *bufptr++ = 0;
7e86f2f6
MS
5492 *bufptr++ = (ipp_uchar_t)(n >> 8);
5493 *bufptr++ = (ipp_uchar_t)n;
07623986 5494 memcpy(bufptr, attr->name, (size_t)n);
ef416fc2 5495 bufptr += n;
5496
a2326b5b
MS
5497 if (attr->value_tag > 0xff)
5498 {
5499 *bufptr++ = IPP_TAG_EXTENSION;
7e86f2f6
MS
5500 *bufptr++ = (ipp_uchar_t)(attr->value_tag >> 24);
5501 *bufptr++ = (ipp_uchar_t)(attr->value_tag >> 16);
5502 *bufptr++ = (ipp_uchar_t)(attr->value_tag >> 8);
5503 *bufptr++ = (ipp_uchar_t)attr->value_tag;
a2326b5b
MS
5504 }
5505 else
7e86f2f6 5506 *bufptr++ = (ipp_uchar_t)attr->value_tag;
a2326b5b 5507
ef416fc2 5508 *bufptr++ = 0;
5509 *bufptr++ = 0;
5510 }
5511
5512 /*
5513 * Now write the attribute value(s)...
5514 */
5515
cb7f98ee 5516 switch (attr->value_tag & ~IPP_TAG_CUPS_CONST)
ef416fc2 5517 {
a2326b5b
MS
5518 case IPP_TAG_UNSUPPORTED_VALUE :
5519 case IPP_TAG_DEFAULT :
5520 case IPP_TAG_UNKNOWN :
5521 case IPP_TAG_NOVALUE :
5522 case IPP_TAG_NOTSETTABLE :
5523 case IPP_TAG_DELETEATTR :
5524 case IPP_TAG_ADMINDEFINE :
5525 *bufptr++ = 0;
5526 *bufptr++ = 0;
5527 break;
5528
ef416fc2 5529 case IPP_TAG_INTEGER :
5530 case IPP_TAG_ENUM :
5531 for (i = 0, value = attr->values;
5532 i < attr->num_values;
5533 i ++, value ++)
5534 {
1f6f3dbc 5535 if ((IPP_BUF_SIZE - (bufptr - buffer)) < 9)
ef416fc2 5536 {
7e86f2f6 5537 if ((*cb)(dst, buffer, (size_t)(bufptr - buffer)) < 0)
ef416fc2 5538 {
e07d4801 5539 DEBUG_puts("1ippWriteIO: Could not write IPP "
1ff0402e 5540 "attribute...");
dcb445bc 5541 _cupsBufferRelease((char *)buffer);
cb7f98ee 5542 return (IPP_STATE_ERROR);
ef416fc2 5543 }
5544
5545 bufptr = buffer;
5546 }
5547
5548 if (i)
5549 {
5550 /*
5551 * Arrays and sets are done by sending additional
5552 * values with a zero-length name...
5553 */
5554
7e86f2f6 5555 *bufptr++ = (ipp_uchar_t)attr->value_tag;
ef416fc2 5556 *bufptr++ = 0;
5557 *bufptr++ = 0;
5558 }
5559
5560 /*
5561 * Integers and enumerations are both 4-byte signed
5562 * (twos-complement) values.
5563 *
5564 * Put the 2-byte length and 4-byte value into the buffer...
5565 */
5566
5567 *bufptr++ = 0;
5568 *bufptr++ = 4;
7e86f2f6
MS
5569 *bufptr++ = (ipp_uchar_t)(value->integer >> 24);
5570 *bufptr++ = (ipp_uchar_t)(value->integer >> 16);
5571 *bufptr++ = (ipp_uchar_t)(value->integer >> 8);
5572 *bufptr++ = (ipp_uchar_t)value->integer;
ef416fc2 5573 }
5574 break;
5575
5576 case IPP_TAG_BOOLEAN :
5577 for (i = 0, value = attr->values;
5578 i < attr->num_values;
5579 i ++, value ++)
5580 {
1f6f3dbc 5581 if ((IPP_BUF_SIZE - (bufptr - buffer)) < 6)
ef416fc2 5582 {
7e86f2f6 5583 if ((*cb)(dst, buffer, (size_t)(bufptr - buffer)) < 0)
ef416fc2 5584 {
e07d4801 5585 DEBUG_puts("1ippWriteIO: Could not write IPP "
1ff0402e 5586 "attribute...");
dcb445bc 5587 _cupsBufferRelease((char *)buffer);
cb7f98ee 5588 return (IPP_STATE_ERROR);
ef416fc2 5589 }
5590
5591 bufptr = buffer;
5592 }
5593
5594 if (i)
5595 {
5596 /*
5597 * Arrays and sets are done by sending additional
5598 * values with a zero-length name...
5599 */
5600
7e86f2f6 5601 *bufptr++ = (ipp_uchar_t)attr->value_tag;
ef416fc2 5602 *bufptr++ = 0;
5603 *bufptr++ = 0;
5604 }
5605
5606 /*
5607 * Boolean values are 1-byte; 0 = false, 1 = true.
5608 *
5609 * Put the 2-byte length and 1-byte value into the buffer...
5610 */
5611
5612 *bufptr++ = 0;
5613 *bufptr++ = 1;
7e86f2f6 5614 *bufptr++ = (ipp_uchar_t)value->boolean;
ef416fc2 5615 }
5616 break;
5617
5618 case IPP_TAG_TEXT :
5619 case IPP_TAG_NAME :
5620 case IPP_TAG_KEYWORD :
ef416fc2 5621 case IPP_TAG_URI :
5622 case IPP_TAG_URISCHEME :
5623 case IPP_TAG_CHARSET :
5624 case IPP_TAG_LANGUAGE :
5625 case IPP_TAG_MIMETYPE :
5626 for (i = 0, value = attr->values;
5627 i < attr->num_values;
5628 i ++, value ++)
5629 {
5630 if (i)
5631 {
5632 /*
5633 * Arrays and sets are done by sending additional
5634 * values with a zero-length name...
5635 */
5636
e07d4801 5637 DEBUG_printf(("2ippWriteIO: writing value tag=%x(%s)",
1ff0402e
MS
5638 attr->value_tag,
5639 ippTagString(attr->value_tag)));
e07d4801 5640 DEBUG_printf(("2ippWriteIO: writing name=0,\"\""));
ef416fc2 5641
1f6f3dbc 5642 if ((IPP_BUF_SIZE - (bufptr - buffer)) < 3)
ef416fc2 5643 {
7e86f2f6 5644 if ((*cb)(dst, buffer, (size_t)(bufptr - buffer)) < 0)
ef416fc2 5645 {
e07d4801 5646 DEBUG_puts("1ippWriteIO: Could not write IPP "
1ff0402e 5647 "attribute...");
dcb445bc 5648 _cupsBufferRelease((char *)buffer);
cb7f98ee 5649 return (IPP_STATE_ERROR);
ef416fc2 5650 }
5651
5652 bufptr = buffer;
5653 }
5654
7e86f2f6 5655 *bufptr++ = (ipp_uchar_t)attr->value_tag;
ef416fc2 5656 *bufptr++ = 0;
5657 *bufptr++ = 0;
5658 }
5659
5660 if (value->string.text != NULL)
5661 n = (int)strlen(value->string.text);
5662 else
5663 n = 0;
5664
1f6f3dbc
MS
5665 if (n > (IPP_BUF_SIZE - 2))
5666 {
e07d4801 5667 DEBUG_printf(("1ippWriteIO: String too long (%d)", n));
dcb445bc 5668 _cupsBufferRelease((char *)buffer);
cb7f98ee 5669 return (IPP_STATE_ERROR);
1f6f3dbc 5670 }
ef416fc2 5671
e07d4801 5672 DEBUG_printf(("2ippWriteIO: writing string=%d,\"%s\"", n,
ef416fc2 5673 value->string.text));
5674
1f6f3dbc 5675 if ((int)(IPP_BUF_SIZE - (bufptr - buffer)) < (n + 2))
ef416fc2 5676 {
7e86f2f6 5677 if ((*cb)(dst, buffer, (size_t)(bufptr - buffer)) < 0)
ef416fc2 5678 {
e07d4801 5679 DEBUG_puts("1ippWriteIO: Could not write IPP "
1ff0402e 5680 "attribute...");
dcb445bc 5681 _cupsBufferRelease((char *)buffer);
cb7f98ee 5682 return (IPP_STATE_ERROR);
ef416fc2 5683 }
5684
5685 bufptr = buffer;
5686 }
5687
5688 /*
5689 * All simple strings consist of the 2-byte length and
5690 * character data without the trailing nul normally found
a41f09e2 5691 * in C strings. Also, strings cannot be longer than IPP_MAX_LENGTH
ef416fc2 5692 * bytes since the 2-byte length is a signed (twos-complement)
5693 * value.
5694 *
5695 * Put the 2-byte length and string characters in the buffer.
5696 */
5697
7e86f2f6
MS
5698 *bufptr++ = (ipp_uchar_t)(n >> 8);
5699 *bufptr++ = (ipp_uchar_t)n;
ef416fc2 5700
5701 if (n > 0)
5702 {
07623986 5703 memcpy(bufptr, value->string.text, (size_t)n);
ef416fc2 5704 bufptr += n;
5705 }
5706 }
5707 break;
5708
5709 case IPP_TAG_DATE :
5710 for (i = 0, value = attr->values;
5711 i < attr->num_values;
5712 i ++, value ++)
5713 {
1f6f3dbc 5714 if ((IPP_BUF_SIZE - (bufptr - buffer)) < 16)
ef416fc2 5715 {
7e86f2f6 5716 if ((*cb)(dst, buffer, (size_t)(bufptr - buffer)) < 0)
ef416fc2 5717 {
e07d4801 5718 DEBUG_puts("1ippWriteIO: Could not write IPP "
1ff0402e 5719 "attribute...");
dcb445bc 5720 _cupsBufferRelease((char *)buffer);
cb7f98ee 5721 return (IPP_STATE_ERROR);
ef416fc2 5722 }
5723
5724 bufptr = buffer;
5725 }
5726
5727 if (i)
5728 {
5729 /*
5730 * Arrays and sets are done by sending additional
5731 * values with a zero-length name...
5732 */
5733
7e86f2f6 5734 *bufptr++ = (ipp_uchar_t)attr->value_tag;
ef416fc2 5735 *bufptr++ = 0;
5736 *bufptr++ = 0;
5737 }
5738
5739 /*
5740 * Date values consist of a 2-byte length and an
5741 * 11-byte date/time structure defined by RFC 1903.
5742 *
5743 * Put the 2-byte length and 11-byte date/time
5744 * structure in the buffer.
5745 */
5746
5747 *bufptr++ = 0;
5748 *bufptr++ = 11;
5749 memcpy(bufptr, value->date, 11);
5750 bufptr += 11;
5751 }
5752 break;
5753
5754 case IPP_TAG_RESOLUTION :
5755 for (i = 0, value = attr->values;
5756 i < attr->num_values;
5757 i ++, value ++)
5758 {
1f6f3dbc 5759 if ((IPP_BUF_SIZE - (bufptr - buffer)) < 14)
ef416fc2 5760 {
7e86f2f6 5761 if ((*cb)(dst, buffer, (size_t)(bufptr - buffer)) < 0)
ef416fc2 5762 {
e07d4801 5763 DEBUG_puts("1ippWriteIO: Could not write IPP "
1ff0402e 5764 "attribute...");
dcb445bc 5765 _cupsBufferRelease((char *)buffer);
cb7f98ee 5766 return (IPP_STATE_ERROR);
ef416fc2 5767 }
5768
5769 bufptr = buffer;
5770 }
5771
5772 if (i)
5773 {
5774 /*
5775 * Arrays and sets are done by sending additional
5776 * values with a zero-length name...
5777 */
5778
7e86f2f6 5779 *bufptr++ = (ipp_uchar_t)attr->value_tag;
ef416fc2 5780 *bufptr++ = 0;
5781 *bufptr++ = 0;
5782 }
5783
5784 /*
5785 * Resolution values consist of a 2-byte length,
5786 * 4-byte horizontal resolution value, 4-byte vertical
5787 * resolution value, and a 1-byte units value.
5788 *
5789 * Put the 2-byte length and resolution value data
5790 * into the buffer.
5791 */
5792
5793 *bufptr++ = 0;
5794 *bufptr++ = 9;
7e86f2f6
MS
5795 *bufptr++ = (ipp_uchar_t)(value->resolution.xres >> 24);
5796 *bufptr++ = (ipp_uchar_t)(value->resolution.xres >> 16);
5797 *bufptr++ = (ipp_uchar_t)(value->resolution.xres >> 8);
5798 *bufptr++ = (ipp_uchar_t)value->resolution.xres;
5799 *bufptr++ = (ipp_uchar_t)(value->resolution.yres >> 24);
5800 *bufptr++ = (ipp_uchar_t)(value->resolution.yres >> 16);
5801 *bufptr++ = (ipp_uchar_t)(value->resolution.yres >> 8);
5802 *bufptr++ = (ipp_uchar_t)value->resolution.yres;
5803 *bufptr++ = (ipp_uchar_t)value->resolution.units;
ef416fc2 5804 }
5805 break;
5806
5807 case IPP_TAG_RANGE :
5808 for (i = 0, value = attr->values;
5809 i < attr->num_values;
5810 i ++, value ++)
5811 {
1f6f3dbc 5812 if ((IPP_BUF_SIZE - (bufptr - buffer)) < 13)
ef416fc2 5813 {
7e86f2f6 5814 if ((*cb)(dst, buffer, (size_t)(bufptr - buffer)) < 0)
ef416fc2 5815 {
e07d4801 5816 DEBUG_puts("1ippWriteIO: Could not write IPP "
1ff0402e 5817 "attribute...");
dcb445bc 5818 _cupsBufferRelease((char *)buffer);
cb7f98ee 5819 return (IPP_STATE_ERROR);
ef416fc2 5820 }
5821
5822 bufptr = buffer;
5823 }
5824
5825 if (i)
5826 {
5827 /*
5828 * Arrays and sets are done by sending additional
5829 * values with a zero-length name...
5830 */
5831
7e86f2f6 5832 *bufptr++ = (ipp_uchar_t)attr->value_tag;
ef416fc2 5833 *bufptr++ = 0;
5834 *bufptr++ = 0;
5835 }
5836
5837 /*
5838 * Range values consist of a 2-byte length,
5839 * 4-byte lower value, and 4-byte upper value.
5840 *
5841 * Put the 2-byte length and range value data
5842 * into the buffer.
5843 */
5844
5845 *bufptr++ = 0;
5846 *bufptr++ = 8;
7e86f2f6
MS
5847 *bufptr++ = (ipp_uchar_t)(value->range.lower >> 24);
5848 *bufptr++ = (ipp_uchar_t)(value->range.lower >> 16);
5849 *bufptr++ = (ipp_uchar_t)(value->range.lower >> 8);
5850 *bufptr++ = (ipp_uchar_t)value->range.lower;
5851 *bufptr++ = (ipp_uchar_t)(value->range.upper >> 24);
5852 *bufptr++ = (ipp_uchar_t)(value->range.upper >> 16);
5853 *bufptr++ = (ipp_uchar_t)(value->range.upper >> 8);
5854 *bufptr++ = (ipp_uchar_t)value->range.upper;
ef416fc2 5855 }
5856 break;
5857
5858 case IPP_TAG_TEXTLANG :
5859 case IPP_TAG_NAMELANG :
5860 for (i = 0, value = attr->values;
5861 i < attr->num_values;
5862 i ++, value ++)
5863 {
5864 if (i)
5865 {
5866 /*
5867 * Arrays and sets are done by sending additional
5868 * values with a zero-length name...
5869 */
5870
1f6f3dbc 5871 if ((IPP_BUF_SIZE - (bufptr - buffer)) < 3)
ef416fc2 5872 {
7e86f2f6 5873 if ((*cb)(dst, buffer, (size_t)(bufptr - buffer)) < 0)
ef416fc2 5874 {
e07d4801 5875 DEBUG_puts("1ippWriteIO: Could not write IPP "
1ff0402e 5876 "attribute...");
dcb445bc 5877 _cupsBufferRelease((char *)buffer);
cb7f98ee 5878 return (IPP_STATE_ERROR);
ef416fc2 5879 }
5880
5881 bufptr = buffer;
5882 }
5883
7e86f2f6 5884 *bufptr++ = (ipp_uchar_t)attr->value_tag;
ef416fc2 5885 *bufptr++ = 0;
5886 *bufptr++ = 0;
5887 }
5888
5889 /*
5890 * textWithLanguage and nameWithLanguage values consist
5891 * of a 2-byte length for both strings and their
5892 * individual lengths, a 2-byte length for the
5893 * character string, the character string without the
5894 * trailing nul, a 2-byte length for the character
5895 * set string, and the character set string without
5896 * the trailing nul.
5897 */
5898
5899 n = 4;
5900
a2326b5b
MS
5901 if (value->string.language != NULL)
5902 n += (int)strlen(value->string.language);
ef416fc2 5903
5904 if (value->string.text != NULL)
b86bc4cf 5905 n += (int)strlen(value->string.text);
ef416fc2 5906
1f6f3dbc
MS
5907 if (n > (IPP_BUF_SIZE - 2))
5908 {
e07d4801
MS
5909 DEBUG_printf(("1ippWriteIO: text/nameWithLanguage value "
5910 "too long (%d)", n));
dcb445bc 5911 _cupsBufferRelease((char *)buffer);
cb7f98ee 5912 return (IPP_STATE_ERROR);
1f6f3dbc 5913 }
ef416fc2 5914
1f6f3dbc 5915 if ((int)(IPP_BUF_SIZE - (bufptr - buffer)) < (n + 2))
ef416fc2 5916 {
7e86f2f6 5917 if ((*cb)(dst, buffer, (size_t)(bufptr - buffer)) < 0)
ef416fc2 5918 {
e07d4801 5919 DEBUG_puts("1ippWriteIO: Could not write IPP "
1ff0402e 5920 "attribute...");
dcb445bc 5921 _cupsBufferRelease((char *)buffer);
cb7f98ee 5922 return (IPP_STATE_ERROR);
ef416fc2 5923 }
5924
5925 bufptr = buffer;
5926 }
5927
5928 /* Length of entire value */
7e86f2f6
MS
5929 *bufptr++ = (ipp_uchar_t)(n >> 8);
5930 *bufptr++ = (ipp_uchar_t)n;
ef416fc2 5931
a2326b5b
MS
5932 /* Length of language */
5933 if (value->string.language != NULL)
5934 n = (int)strlen(value->string.language);
ef416fc2 5935 else
5936 n = 0;
5937
7e86f2f6
MS
5938 *bufptr++ = (ipp_uchar_t)(n >> 8);
5939 *bufptr++ = (ipp_uchar_t)n;
ef416fc2 5940
a2326b5b 5941 /* Language */
ef416fc2 5942 if (n > 0)
5943 {
07623986 5944 memcpy(bufptr, value->string.language, (size_t)n);
ef416fc2 5945 bufptr += n;
5946 }
5947
5948 /* Length of text */
5949 if (value->string.text != NULL)
5950 n = (int)strlen(value->string.text);
5951 else
5952 n = 0;
5953
7e86f2f6
MS
5954 *bufptr++ = (ipp_uchar_t)(n >> 8);
5955 *bufptr++ = (ipp_uchar_t)n;
ef416fc2 5956
5957 /* Text */
5958 if (n > 0)
5959 {
07623986 5960 memcpy(bufptr, value->string.text, (size_t)n);
ef416fc2 5961 bufptr += n;
5962 }
5963 }
5964 break;
5965
5966 case IPP_TAG_BEGIN_COLLECTION :
5967 for (i = 0, value = attr->values;
5968 i < attr->num_values;
5969 i ++, value ++)
5970 {
5971 /*
5972 * Collections are written with the begin-collection
5973 * tag first with a value of 0 length, followed by the
5974 * attributes in the collection, then the end-collection
5975 * value...
5976 */
5977
1f6f3dbc 5978 if ((IPP_BUF_SIZE - (bufptr - buffer)) < 5)
ef416fc2 5979 {
7e86f2f6 5980 if ((*cb)(dst, buffer, (size_t)(bufptr - buffer)) < 0)
ef416fc2 5981 {
e07d4801 5982 DEBUG_puts("1ippWriteIO: Could not write IPP "
1ff0402e 5983 "attribute...");
dcb445bc 5984 _cupsBufferRelease((char *)buffer);
cb7f98ee 5985 return (IPP_STATE_ERROR);
ef416fc2 5986 }
5987
5988 bufptr = buffer;
5989 }
5990
5991 if (i)
5992 {
5993 /*
5994 * Arrays and sets are done by sending additional
5995 * values with a zero-length name...
5996 */
5997
7e86f2f6 5998 *bufptr++ = (ipp_uchar_t)attr->value_tag;
ef416fc2 5999 *bufptr++ = 0;
6000 *bufptr++ = 0;
6001 }
6002
6003 /*
6004 * Write a data length of 0 and flush the buffer...
6005 */
6006
6007 *bufptr++ = 0;
6008 *bufptr++ = 0;
6009
7e86f2f6 6010 if ((*cb)(dst, buffer, (size_t)(bufptr - buffer)) < 0)
ef416fc2 6011 {
e07d4801 6012 DEBUG_puts("1ippWriteIO: Could not write IPP "
1ff0402e 6013 "attribute...");
dcb445bc 6014 _cupsBufferRelease((char *)buffer);
cb7f98ee 6015 return (IPP_STATE_ERROR);
ef416fc2 6016 }
6017
6018 bufptr = buffer;
6019
6020 /*
6021 * Then write the collection attribute...
6022 */
6023
cb7f98ee 6024 value->collection->state = IPP_STATE_IDLE;
ef416fc2 6025
1f6f3dbc 6026 if (ippWriteIO(dst, cb, 1, ipp,
cb7f98ee 6027 value->collection) == IPP_STATE_ERROR)
1f6f3dbc 6028 {
e07d4801 6029 DEBUG_puts("1ippWriteIO: Unable to write collection value");
dcb445bc 6030 _cupsBufferRelease((char *)buffer);
cb7f98ee 6031 return (IPP_STATE_ERROR);
1f6f3dbc 6032 }
ef416fc2 6033 }
6034 break;
6035
6036 default :
6037 for (i = 0, value = attr->values;
6038 i < attr->num_values;
6039 i ++, value ++)
6040 {
6041 if (i)
6042 {
6043 /*
6044 * Arrays and sets are done by sending additional
6045 * values with a zero-length name...
6046 */
6047
1f6f3dbc 6048 if ((IPP_BUF_SIZE - (bufptr - buffer)) < 3)
ef416fc2 6049 {
7e86f2f6 6050 if ((*cb)(dst, buffer, (size_t)(bufptr - buffer)) < 0)
ef416fc2 6051 {
e07d4801 6052 DEBUG_puts("1ippWriteIO: Could not write IPP "
1ff0402e 6053 "attribute...");
dcb445bc 6054 _cupsBufferRelease((char *)buffer);
cb7f98ee 6055 return (IPP_STATE_ERROR);
ef416fc2 6056 }
6057
6058 bufptr = buffer;
6059 }
6060
7e86f2f6 6061 *bufptr++ = (ipp_uchar_t)attr->value_tag;
ef416fc2 6062 *bufptr++ = 0;
6063 *bufptr++ = 0;
6064 }
6065
6066 /*
6067 * An unknown value might some new value that a
6068 * vendor has come up with. It consists of a
6069 * 2-byte length and the bytes in the unknown
6070 * value buffer.
6071 */
6072
6073 n = value->unknown.length;
6074
1f6f3dbc
MS
6075 if (n > (IPP_BUF_SIZE - 2))
6076 {
e07d4801 6077 DEBUG_printf(("1ippWriteIO: Data length too long (%d)",
1f6f3dbc 6078 n));
dcb445bc 6079 _cupsBufferRelease((char *)buffer);
cb7f98ee 6080 return (IPP_STATE_ERROR);
1f6f3dbc 6081 }
ef416fc2 6082
1f6f3dbc 6083 if ((int)(IPP_BUF_SIZE - (bufptr - buffer)) < (n + 2))
ef416fc2 6084 {
7e86f2f6 6085 if ((*cb)(dst, buffer, (size_t)(bufptr - buffer)) < 0)
ef416fc2 6086 {
e07d4801 6087 DEBUG_puts("1ippWriteIO: Could not write IPP "
1ff0402e 6088 "attribute...");
dcb445bc 6089 _cupsBufferRelease((char *)buffer);
cb7f98ee 6090 return (IPP_STATE_ERROR);
ef416fc2 6091 }
6092
6093 bufptr = buffer;
6094 }
6095
6096 /* Length of unknown value */
7e86f2f6
MS
6097 *bufptr++ = (ipp_uchar_t)(n >> 8);
6098 *bufptr++ = (ipp_uchar_t)n;
ef416fc2 6099
6100 /* Value */
6101 if (n > 0)
6102 {
07623986 6103 memcpy(bufptr, value->unknown.data, (size_t)n);
ef416fc2 6104 bufptr += n;
6105 }
6106 }
6107 break;
6108 }
6109
6110 /*
6111 * Write the data out...
6112 */
6113
ba55dc12 6114 if (bufptr > buffer)
ef416fc2 6115 {
7e86f2f6 6116 if ((*cb)(dst, buffer, (size_t)(bufptr - buffer)) < 0)
ba55dc12
MS
6117 {
6118 DEBUG_puts("1ippWriteIO: Could not write IPP attribute...");
dcb445bc 6119 _cupsBufferRelease((char *)buffer);
cb7f98ee 6120 return (IPP_STATE_ERROR);
ba55dc12 6121 }
ef416fc2 6122
ba55dc12
MS
6123 DEBUG_printf(("2ippWriteIO: wrote %d bytes",
6124 (int)(bufptr - buffer)));
6125 }
ef416fc2 6126
6127 /*
21f36711
MS
6128 * If blocking is disabled and we aren't at the end of the attribute
6129 * list, stop here...
ef416fc2 6130 */
6131
21f36711 6132 if (!blocking && ipp->current)
ef416fc2 6133 break;
6134 }
6135
6136 if (ipp->current == NULL)
6137 {
6138 /*
6139 * Done with all of the attributes; add the end-of-attributes
6140 * tag or end-collection attribute...
6141 */
6142
6143 if (parent == NULL)
6144 {
6145 buffer[0] = IPP_TAG_END;
6146 n = 1;
6147 }
6148 else
6149 {
6150 buffer[0] = IPP_TAG_END_COLLECTION;
6151 buffer[1] = 0; /* empty name */
6152 buffer[2] = 0;
6153 buffer[3] = 0; /* empty value */
6154 buffer[4] = 0;
6155 n = 5;
6156 }
6157
7e86f2f6 6158 if ((*cb)(dst, buffer, (size_t)n) < 0)
ef416fc2 6159 {
e07d4801 6160 DEBUG_puts("1ippWriteIO: Could not write IPP end-tag...");
dcb445bc 6161 _cupsBufferRelease((char *)buffer);
cb7f98ee 6162 return (IPP_STATE_ERROR);
ef416fc2 6163 }
6164
cb7f98ee 6165 ipp->state = IPP_STATE_DATA;
ef416fc2 6166 }
6167 break;
6168
cb7f98ee 6169 case IPP_STATE_DATA :
ef416fc2 6170 break;
6171
6172 default :
6173 break; /* anti-compiler-warning-code */
6174 }
6175
dcb445bc 6176 _cupsBufferRelease((char *)buffer);
1f6f3dbc 6177
ef416fc2 6178 return (ipp->state);
6179}
6180
6181
6182/*
a2326b5b 6183 * 'ipp_add_attr()' - Add a new attribute to the message.
ef416fc2 6184 */
6185
a2326b5b
MS
6186static ipp_attribute_t * /* O - New attribute */
6187ipp_add_attr(ipp_t *ipp, /* I - IPP message */
6188 const char *name, /* I - Attribute name or NULL */
6189 ipp_tag_t group_tag, /* I - Group tag or IPP_TAG_ZERO */
6190 ipp_tag_t value_tag, /* I - Value tag or IPP_TAG_ZERO */
6191 int num_values) /* I - Number of values */
ef416fc2 6192{
a2326b5b 6193 int alloc_values; /* Number of values to allocate */
ef416fc2 6194 ipp_attribute_t *attr; /* New attribute */
6195
6196
807315e6 6197 DEBUG_printf(("4ipp_add_attr(ipp=%p, name=\"%s\", group_tag=0x%x, value_tag=0x%x, num_values=%d)", (void *)ipp, name, group_tag, value_tag, num_values));
a2326b5b
MS
6198
6199 /*
6200 * Range check input...
6201 */
ef416fc2 6202
1ff0402e 6203 if (!ipp || num_values < 0)
ef416fc2 6204 return (NULL);
6205
a2326b5b
MS
6206 /*
6207 * Allocate memory, rounding the allocation up as needed...
6208 */
ef416fc2 6209
a2326b5b 6210 if (num_values <= 1)
9c80ffa2 6211 alloc_values = 1;
a2326b5b
MS
6212 else
6213 alloc_values = (num_values + IPP_MAX_VALUES - 1) & ~(IPP_MAX_VALUES - 1);
ef416fc2 6214
a2326b5b 6215 attr = calloc(sizeof(ipp_attribute_t) +
7e86f2f6 6216 (size_t)(alloc_values - 1) * sizeof(_ipp_value_t), 1);
ef416fc2 6217
a2326b5b 6218 if (attr)
ef416fc2 6219 {
a2326b5b
MS
6220 /*
6221 * Initialize attribute...
6222 */
ef416fc2 6223
b908d72c
MS
6224 DEBUG_printf(("4debug_alloc: %p %s %s%s (%d values)", (void *)attr, name, num_values > 1 ? "1setOf " : "", ippTagString(value_tag), num_values));
6225
a2326b5b
MS
6226 if (name)
6227 attr->name = _cupsStrAlloc(name);
ef416fc2 6228
a2326b5b
MS
6229 attr->group_tag = group_tag;
6230 attr->value_tag = value_tag;
6231 attr->num_values = num_values;
4400e98d 6232
a2326b5b
MS
6233 /*
6234 * Add it to the end of the linked list...
6235 */
4400e98d 6236
a2326b5b
MS
6237 if (ipp->last)
6238 ipp->last->next = attr;
6239 else
6240 ipp->attrs = attr;
5a738aea 6241
a2326b5b
MS
6242 ipp->prev = ipp->last;
6243 ipp->last = ipp->current = attr;
ef416fc2 6244 }
6245
807315e6 6246 DEBUG_printf(("5ipp_add_attr: Returning %p", (void *)attr));
ef416fc2 6247
a2326b5b 6248 return (attr);
ef416fc2 6249}
6250
6251
a2326b5b
MS
6252/*
6253 * 'ipp_free_values()' - Free attribute values.
6254 */
6255
6256static void
6257ipp_free_values(ipp_attribute_t *attr, /* I - Attribute to free values from */
6258 int element,/* I - First value to free */
6259 int count) /* I - Number of values to free */
6260{
6261 int i; /* Looping var */
6262 _ipp_value_t *value; /* Current value */
6263
6264
807315e6 6265 DEBUG_printf(("4ipp_free_values(attr=%p, element=%d, count=%d)", (void *)attr, element, count));
a2326b5b 6266
cb7f98ee 6267 if (!(attr->value_tag & IPP_TAG_CUPS_CONST))
a2326b5b
MS
6268 {
6269 /*
6270 * Free values as needed...
6271 */
6272
6273 switch (attr->value_tag)
6274 {
6275 case IPP_TAG_TEXTLANG :
6276 case IPP_TAG_NAMELANG :
5a9febac
MS
6277 if (element == 0 && count == attr->num_values &&
6278 attr->values[0].string.language)
6279 {
a2326b5b 6280 _cupsStrFree(attr->values[0].string.language);
5a9febac
MS
6281 attr->values[0].string.language = NULL;
6282 }
0fa6c7fa 6283 /* Fall through to other string values */
a2326b5b
MS
6284
6285 case IPP_TAG_TEXT :
6286 case IPP_TAG_NAME :
6287 case IPP_TAG_RESERVED_STRING :
6288 case IPP_TAG_KEYWORD :
6289 case IPP_TAG_URI :
6290 case IPP_TAG_URISCHEME :
6291 case IPP_TAG_CHARSET :
6292 case IPP_TAG_LANGUAGE :
6293 case IPP_TAG_MIMETYPE :
6294 for (i = count, value = attr->values + element;
6295 i > 0;
6296 i --, value ++)
5a9febac 6297 {
a2326b5b 6298 _cupsStrFree(value->string.text);
5a9febac
MS
6299 value->string.text = NULL;
6300 }
a2326b5b
MS
6301 break;
6302
22a3eea9 6303 case IPP_TAG_UNSUPPORTED_VALUE :
a2326b5b
MS
6304 case IPP_TAG_DEFAULT :
6305 case IPP_TAG_UNKNOWN :
6306 case IPP_TAG_NOVALUE :
6307 case IPP_TAG_NOTSETTABLE :
6308 case IPP_TAG_DELETEATTR :
6309 case IPP_TAG_ADMINDEFINE :
6310 case IPP_TAG_INTEGER :
6311 case IPP_TAG_ENUM :
6312 case IPP_TAG_BOOLEAN :
6313 case IPP_TAG_DATE :
6314 case IPP_TAG_RESOLUTION :
6315 case IPP_TAG_RANGE :
6316 break;
6317
6318 case IPP_TAG_BEGIN_COLLECTION :
6319 for (i = count, value = attr->values + element;
6320 i > 0;
6321 i --, value ++)
5a9febac 6322 {
a2326b5b 6323 ippDelete(value->collection);
5a9febac
MS
6324 value->collection = NULL;
6325 }
a2326b5b
MS
6326 break;
6327
6328 case IPP_TAG_STRING :
6329 default :
6330 for (i = count, value = attr->values + element;
6331 i > 0;
6332 i --, value ++)
5a9febac 6333 {
a2326b5b 6334 if (value->unknown.data)
5a9febac 6335 {
a2326b5b 6336 free(value->unknown.data);
5a9febac
MS
6337 value->unknown.data = NULL;
6338 }
6339 }
a2326b5b
MS
6340 break;
6341 }
6342 }
6343
6344 /*
6345 * If we are not freeing values from the end, move the remaining values up...
6346 */
6347
6348 if ((element + count) < attr->num_values)
6349 memmove(attr->values + element, attr->values + element + count,
7e86f2f6 6350 (size_t)(attr->num_values - count - element) * sizeof(_ipp_value_t));
a2326b5b
MS
6351
6352 attr->num_values -= count;
6353}
6354
6355
6356/*
6357 * 'ipp_get_code()' - Convert a C locale/charset name into an IPP language/charset code.
6358 *
6359 * This typically converts strings of the form "ll_CC", "ll-REGION", and "CHARSET_NUMBER"
6360 * to "ll-cc", "ll-region", and "charset-number", respectively.
6361 */
6362
6363static char * /* O - Language code string */
6364ipp_get_code(const char *value, /* I - Locale/charset string */
6365 char *buffer, /* I - String buffer */
6366 size_t bufsize) /* I - Size of string buffer */
6367{
6368 char *bufptr, /* Pointer into buffer */
6369 *bufend; /* End of buffer */
6370
6371
6372 /*
6373 * Convert values to lowercase and change _ to - as needed...
6374 */
6375
6376 for (bufptr = buffer, bufend = buffer + bufsize - 1;
6377 *value && bufptr < bufend;
6378 value ++)
6379 if (*value == '_')
6380 *bufptr++ = '-';
6381 else
7e86f2f6 6382 *bufptr++ = (char)_cups_tolower(*value);
a2326b5b
MS
6383
6384 *bufptr = '\0';
6385
6386 /*
6387 * Return the converted string...
6388 */
6389
6390 return (buffer);
6391}
6392
6393
6394/*
6395 * 'ipp_lang_code()' - Convert a C locale name into an IPP language code.
6396 *
6397 * This typically converts strings of the form "ll_CC" and "ll-REGION" to "ll-cc" and
6398 * "ll-region", respectively. It also converts the "C" (POSIX) locale to "en".
6399 */
6400
6401static char * /* O - Language code string */
6402ipp_lang_code(const char *locale, /* I - Locale string */
6403 char *buffer, /* I - String buffer */
6404 size_t bufsize) /* I - Size of string buffer */
6405{
6406 /*
6407 * Map POSIX ("C") locale to generic English, otherwise convert the locale string as-is.
6408 */
6409
6410 if (!_cups_strcasecmp(locale, "c"))
6411 {
6412 strlcpy(buffer, "en", bufsize);
6413 return (buffer);
6414 }
6415 else
6416 return (ipp_get_code(locale, buffer, bufsize));
6417}
6418
6419
ef416fc2 6420/*
6421 * 'ipp_length()' - Compute the length of an IPP message or collection value.
6422 */
6423
6424static size_t /* O - Size of IPP message */
6425ipp_length(ipp_t *ipp, /* I - IPP message or collection */
6426 int collection) /* I - 1 if a collection, 0 otherwise */
6427{
6428 int i; /* Looping var */
a2326b5b 6429 size_t bytes; /* Number of bytes */
ef416fc2 6430 ipp_attribute_t *attr; /* Current attribute */
6431 ipp_tag_t group; /* Current group */
a2326b5b
MS
6432 _ipp_value_t *value; /* Current value */
6433
ef416fc2 6434
807315e6 6435 DEBUG_printf(("3ipp_length(ipp=%p, collection=%d)", (void *)ipp, collection));
ef416fc2 6436
a2326b5b
MS
6437 if (!ipp)
6438 {
6439 DEBUG_puts("4ipp_length: Returning 0 bytes");
ef416fc2 6440 return (0);
a2326b5b 6441 }
ef416fc2 6442
6443 /*
6444 * Start with 8 bytes for the IPP message header...
6445 */
6446
6447 bytes = collection ? 0 : 8;
6448
6449 /*
6450 * Then add the lengths of each attribute...
6451 */
6452
6453 group = IPP_TAG_ZERO;
6454
6455 for (attr = ipp->attrs; attr != NULL; attr = attr->next)
6456 {
6457 if (attr->group_tag != group && !collection)
6458 {
6459 group = attr->group_tag;
6460 if (group == IPP_TAG_ZERO)
6461 continue;
6462
6463 bytes ++; /* Group tag */
6464 }
6465
6466 if (!attr->name)
6467 continue;
6468
a2326b5b
MS
6469 DEBUG_printf(("5ipp_length: attr->name=\"%s\", attr->num_values=%d, "
6470 "bytes=" CUPS_LLFMT, attr->name, attr->num_values, CUPS_LLCAST bytes));
ef416fc2 6471
426184cb 6472 if ((attr->value_tag & ~IPP_TAG_CUPS_CONST) < IPP_TAG_EXTENSION)
7e86f2f6 6473 bytes += (size_t)attr->num_values;/* Value tag for each value */
a2326b5b 6474 else
7e86f2f6
MS
6475 bytes += (size_t)(5 * attr->num_values);
6476 /* Value tag for each value */
6477 bytes += (size_t)(2 * attr->num_values);
6478 /* Name lengths */
6479 bytes += strlen(attr->name); /* Name */
6480 bytes += (size_t)(2 * attr->num_values);
6481 /* Value lengths */
ef416fc2 6482
6483 if (collection)
6484 bytes += 5; /* Add membername overhead */
6485
cb7f98ee 6486 switch (attr->value_tag & ~IPP_TAG_CUPS_CONST)
ef416fc2 6487 {
a2326b5b
MS
6488 case IPP_TAG_UNSUPPORTED_VALUE :
6489 case IPP_TAG_DEFAULT :
6490 case IPP_TAG_UNKNOWN :
6491 case IPP_TAG_NOVALUE :
6492 case IPP_TAG_NOTSETTABLE :
6493 case IPP_TAG_DELETEATTR :
6494 case IPP_TAG_ADMINDEFINE :
6495 break;
6496
ef416fc2 6497 case IPP_TAG_INTEGER :
6498 case IPP_TAG_ENUM :
7e86f2f6 6499 bytes += (size_t)(4 * attr->num_values);
ef416fc2 6500 break;
6501
6502 case IPP_TAG_BOOLEAN :
7e86f2f6 6503 bytes += (size_t)attr->num_values;
ef416fc2 6504 break;
6505
6506 case IPP_TAG_TEXT :
6507 case IPP_TAG_NAME :
6508 case IPP_TAG_KEYWORD :
ef416fc2 6509 case IPP_TAG_URI :
6510 case IPP_TAG_URISCHEME :
6511 case IPP_TAG_CHARSET :
6512 case IPP_TAG_LANGUAGE :
6513 case IPP_TAG_MIMETYPE :
6514 for (i = 0, value = attr->values;
6515 i < attr->num_values;
6516 i ++, value ++)
a2326b5b
MS
6517 if (value->string.text)
6518 bytes += strlen(value->string.text);
ef416fc2 6519 break;
6520
6521 case IPP_TAG_DATE :
7e86f2f6 6522 bytes += (size_t)(11 * attr->num_values);
ef416fc2 6523 break;
6524
6525 case IPP_TAG_RESOLUTION :
7e86f2f6 6526 bytes += (size_t)(9 * attr->num_values);
ef416fc2 6527 break;
6528
6529 case IPP_TAG_RANGE :
7e86f2f6 6530 bytes += (size_t)(8 * attr->num_values);
ef416fc2 6531 break;
6532
6533 case IPP_TAG_TEXTLANG :
6534 case IPP_TAG_NAMELANG :
7e86f2f6
MS
6535 bytes += (size_t)(4 * attr->num_values);
6536 /* Charset + text length */
ef416fc2 6537
6538 for (i = 0, value = attr->values;
6539 i < attr->num_values;
6540 i ++, value ++)
6541 {
a2326b5b
MS
6542 if (value->string.language)
6543 bytes += strlen(value->string.language);
ef416fc2 6544
a2326b5b
MS
6545 if (value->string.text)
6546 bytes += strlen(value->string.text);
ef416fc2 6547 }
6548 break;
6549
6550 case IPP_TAG_BEGIN_COLLECTION :
6551 for (i = 0, value = attr->values;
6552 i < attr->num_values;
6553 i ++, value ++)
a2326b5b 6554 bytes += ipp_length(value->collection, 1);
ef416fc2 6555 break;
6556
6557 default :
6558 for (i = 0, value = attr->values;
6559 i < attr->num_values;
6560 i ++, value ++)
7e86f2f6 6561 bytes += (size_t)value->unknown.length;
ef416fc2 6562 break;
6563 }
6564 }
6565
6566 /*
6567 * Finally, add 1 byte for the "end of attributes" tag or 5 bytes
6568 * for the "end of collection" tag and return...
6569 */
6570
6571 if (collection)
6572 bytes += 5;
6573 else
6574 bytes ++;
6575
a2326b5b 6576 DEBUG_printf(("4ipp_length: Returning " CUPS_LLFMT " bytes", CUPS_LLCAST bytes));
ef416fc2 6577
6578 return (bytes);
6579}
6580
6581
6582/*
6583 * 'ipp_read_http()' - Semi-blocking read on a HTTP connection...
6584 */
6585
a4d04587 6586static ssize_t /* O - Number of bytes read */
ef416fc2 6587ipp_read_http(http_t *http, /* I - Client connection */
6588 ipp_uchar_t *buffer, /* O - Buffer for data */
a4d04587 6589 size_t length) /* I - Total length */
ef416fc2 6590{
7e86f2f6
MS
6591 ssize_t tbytes, /* Total bytes read */
6592 bytes; /* Bytes read this pass */
aaf19ab0 6593
ef416fc2 6594
807315e6 6595 DEBUG_printf(("7ipp_read_http(http=%p, buffer=%p, length=%d)", (void *)http, (void *)buffer, (int)length));
ef416fc2 6596
6597 /*
6598 * Loop until all bytes are read...
6599 */
6600
ae71f5de
MS
6601 for (tbytes = 0, bytes = 0;
6602 tbytes < (int)length;
6603 tbytes += bytes, buffer += bytes)
ef416fc2 6604 {
7e86f2f6 6605 DEBUG_printf(("9ipp_read_http: tbytes=" CUPS_LLFMT ", http->state=%d", CUPS_LLCAST tbytes, http->state));
ef416fc2 6606
cb7f98ee 6607 if (http->state == HTTP_STATE_WAITING)
ef416fc2 6608 break;
6609
a29fd7dd 6610 if (http->used == 0 && !http->blocking)
ef416fc2 6611 {
6612 /*
a29fd7dd 6613 * Wait up to 10 seconds for more data on non-blocking sockets...
ef416fc2 6614 */
6615
a29fd7dd 6616 if (!httpWait(http, 10000))
ef416fc2 6617 {
6618 /*
a29fd7dd 6619 * Signal no data...
ef416fc2 6620 */
6621
a29fd7dd
MS
6622 bytes = -1;
6623 break;
ef416fc2 6624 }
a29fd7dd 6625 }
ba7900a5
MS
6626 else if (http->used == 0 && http->timeout_value > 0)
6627 {
6628 /*
6629 * Wait up to timeout seconds for more data on blocking sockets...
6630 */
6631
6632 if (!httpWait(http, (int)(1000 * http->timeout_value)))
6633 {
6634 /*
6635 * Signal no data...
6636 */
6637
6638 bytes = -1;
6639 break;
6640 }
6641 }
ef416fc2 6642
7e86f2f6 6643 if ((bytes = httpRead2(http, (char *)buffer, length - (size_t)tbytes)) < 0)
a29fd7dd 6644 {
19dc16f7 6645#ifdef _WIN32
a29fd7dd 6646 break;
d1c13e16 6647#else
a29fd7dd
MS
6648 if (errno != EAGAIN && errno != EINTR)
6649 break;
d1c13e16 6650
a29fd7dd 6651 bytes = 0;
19dc16f7 6652#endif /* _WIN32 */
ef416fc2 6653 }
a29fd7dd
MS
6654 else if (bytes == 0)
6655 break;
ef416fc2 6656 }
6657
6658 /*
6659 * Return the number of bytes read...
6660 */
6661
6662 if (tbytes == 0 && bytes < 0)
6663 tbytes = -1;
6664
7e86f2f6 6665 DEBUG_printf(("8ipp_read_http: Returning " CUPS_LLFMT " bytes", CUPS_LLCAST tbytes));
ef416fc2 6666
6667 return (tbytes);
6668}
6669
6670
6671/*
6672 * 'ipp_read_file()' - Read IPP data from a file.
6673 */
6674
a4d04587 6675static ssize_t /* O - Number of bytes read */
ef416fc2 6676ipp_read_file(int *fd, /* I - File descriptor */
6677 ipp_uchar_t *buffer, /* O - Read buffer */
a4d04587 6678 size_t length) /* I - Number of bytes to read */
ef416fc2 6679{
19dc16f7 6680#ifdef _WIN32
b86bc4cf 6681 return ((ssize_t)read(*fd, buffer, (unsigned)length));
6682#else
ef416fc2 6683 return (read(*fd, buffer, length));
19dc16f7 6684#endif /* _WIN32 */
ef416fc2 6685}
6686
6687
c1420c87
MS
6688/*
6689 * 'ipp_set_error()' - Set a formatted, localized error string.
6690 */
6691
6692static void
6693ipp_set_error(ipp_status_t status, /* I - Status code */
6694 const char *format, /* I - Printf-style error string */
6695 ...) /* I - Additional arguments as needed */
6696{
6697 va_list ap; /* Pointer to additional args */
6698 char buffer[2048]; /* Message buffer */
6699 cups_lang_t *lang = cupsLangDefault();
6700 /* Current language */
6701
6702
6703 va_start(ap, format);
6704 vsnprintf(buffer, sizeof(buffer), _cupsLangString(lang, format), ap);
6705 va_end(ap);
6706
6707 _cupsSetError(status, buffer, 0);
6708}
6709
6710
a2326b5b 6711/*
9c80ffa2
MS
6712 * 'ipp_set_value()' - Get the value element from an attribute, expanding it as
6713 * needed.
a2326b5b
MS
6714 */
6715
6716static _ipp_value_t * /* O - IPP value element or NULL on error */
9c80ffa2 6717ipp_set_value(ipp_t *ipp, /* IO - IPP message */
a2326b5b
MS
6718 ipp_attribute_t **attr, /* IO - IPP attribute */
6719 int element) /* I - Value number (0-based) */
6720{
6721 ipp_attribute_t *temp, /* New attribute pointer */
6722 *current, /* Current attribute in list */
6723 *prev; /* Previous attribute in list */
6724 int alloc_values; /* Allocated values */
6725
6726
6727 /*
6728 * If we are setting an existing value element, return it...
6729 */
6730
6731 temp = *attr;
6732
6733 if (temp->num_values <= 1)
9c80ffa2 6734 alloc_values = 1;
a2326b5b 6735 else
9c80ffa2
MS
6736 alloc_values = (temp->num_values + IPP_MAX_VALUES - 1) &
6737 ~(IPP_MAX_VALUES - 1);
a2326b5b
MS
6738
6739 if (element < alloc_values)
9c80ffa2
MS
6740 {
6741 if (element >= temp->num_values)
6742 temp->num_values = element + 1;
6743
a2326b5b 6744 return (temp->values + element);
9c80ffa2 6745 }
a2326b5b
MS
6746
6747 /*
9c80ffa2
MS
6748 * Otherwise re-allocate the attribute - we allocate in groups of IPP_MAX_VALUE
6749 * values when num_values > 1.
a2326b5b
MS
6750 */
6751
6752 if (alloc_values < IPP_MAX_VALUES)
6753 alloc_values = IPP_MAX_VALUES;
6754 else
6755 alloc_values += IPP_MAX_VALUES;
6756
9c80ffa2
MS
6757 DEBUG_printf(("4ipp_set_value: Reallocating for up to %d values.",
6758 alloc_values));
a2326b5b
MS
6759
6760 /*
6761 * Reallocate memory...
6762 */
6763
7e86f2f6 6764 if ((temp = realloc(temp, sizeof(ipp_attribute_t) + (size_t)(alloc_values - 1) * sizeof(_ipp_value_t))) == NULL)
a2326b5b 6765 {
cb7f98ee 6766 _cupsSetHTTPError(HTTP_STATUS_ERROR);
a2326b5b
MS
6767 DEBUG_puts("4ipp_set_value: Unable to resize attribute.");
6768 return (NULL);
6769 }
6770
6771 /*
6772 * Zero the new memory...
6773 */
6774
7e86f2f6 6775 memset(temp->values + temp->num_values, 0, (size_t)(alloc_values - temp->num_values) * sizeof(_ipp_value_t));
a2326b5b
MS
6776
6777 if (temp != *attr)
6778 {
6779 /*
6780 * Reset pointers in the list...
6781 */
6782
29bda83e 6783#ifndef __clang_analyzer__
c0a47c11 6784 DEBUG_printf(("4debug_free: %p %s", (void *)*attr, temp->name));
29bda83e 6785#endif /* !__clang_analyzer__ */
b908d72c
MS
6786 DEBUG_printf(("4debug_alloc: %p %s %s%s (%d)", (void *)temp, temp->name, temp->num_values > 1 ? "1setOf " : "", ippTagString(temp->value_tag), temp->num_values));
6787
a2326b5b
MS
6788 if (ipp->current == *attr && ipp->prev)
6789 {
6790 /*
6791 * Use current "previous" pointer...
6792 */
6793
6794 prev = ipp->prev;
6795 }
6796 else
6797 {
6798 /*
6799 * Find this attribute in the linked list...
6800 */
6801
6802 for (prev = NULL, current = ipp->attrs;
6803 current && current != *attr;
6804 prev = current, current = current->next);
6805
6806 if (!current)
6807 {
6808 /*
6809 * This is a serious error!
6810 */
6811
6812 *attr = temp;
cb7f98ee 6813 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
9c80ffa2 6814 _("IPP attribute is not a member of the message."), 1);
a2326b5b
MS
6815 DEBUG_puts("4ipp_set_value: Unable to find attribute in message.");
6816 return (NULL);
6817 }
6818 }
6819
6820 if (prev)
6821 prev->next = temp;
6822 else
6823 ipp->attrs = temp;
6824
6825 ipp->current = temp;
6826 ipp->prev = prev;
6827
6828 if (ipp->last == *attr)
6829 ipp->last = temp;
6830
6831 *attr = temp;
6832 }
6833
6834 /*
6835 * Return the value element...
6836 */
6837
9c80ffa2
MS
6838 if (element >= temp->num_values)
6839 temp->num_values = element + 1;
6840
a2326b5b
MS
6841 return (temp->values + element);
6842}
6843
6844
ef416fc2 6845/*
6846 * 'ipp_write_file()' - Write IPP data to a file.
6847 */
6848
a4d04587 6849static ssize_t /* O - Number of bytes written */
ef416fc2 6850ipp_write_file(int *fd, /* I - File descriptor */
6851 ipp_uchar_t *buffer, /* I - Data to write */
a4d04587 6852 size_t length) /* I - Number of bytes to write */
ef416fc2 6853{
19dc16f7 6854#ifdef _WIN32
b86bc4cf 6855 return ((ssize_t)write(*fd, buffer, (unsigned)length));
6856#else
ef416fc2 6857 return (write(*fd, buffer, length));
19dc16f7 6858#endif /* _WIN32 */
ef416fc2 6859}