Google Git
Sign in
android / platform / external / libcups / b58481780c9e85fc71c990f90f0dcdbdcee8fc00 / . / cups / ipp.c
blob: 650d33d016b7fd23a530b4b81cb2bd3b1df9a480 [file] [log] [blame]
/*
* Internet Printing Protocol functions for CUPS.
*
* Copyright 2007-2017 by Apple Inc.
* Copyright 1997-2007 by Easy Software Products, all rights reserved.
*
* These coded instructions, statements, and computer programs are the
* property of Apple Inc. and are protected by Federal copyright
* law. Distribution and use rights are outlined in the file "LICENSE.txt"
* which should have been included with this file. If this file is
* missing or damaged, see the license at "http://www.cups.org/".
*
* This file is subject to the Apple OS-Developed Software exception.
*/
/*
* Include necessary headers...
*/
#include "cups-private.h"
#include <regex.h>
#ifdef WIN32
# include <io.h>
#endif /* WIN32 */
/*
* Local functions...
*/
static ipp_attribute_t *ipp_add_attr(ipp_t *ipp, const char *name,
ipp_tag_t group_tag, ipp_tag_t value_tag,
int num_values);
static void ipp_free_values(ipp_attribute_t *attr, int element,
int count);
static char *ipp_get_code(const char *locale, char *buffer,
size_t bufsize)
__attribute__((nonnull(1,2)));
static char *ipp_lang_code(const char *locale, char *buffer,
size_t bufsize)
__attribute__((nonnull(1,2)));
static size_t ipp_length(ipp_t *ipp, int collection);
static ssize_t ipp_read_http(http_t *http, ipp_uchar_t *buffer,
size_t length);
static ssize_t ipp_read_file(int *fd, ipp_uchar_t *buffer,
size_t length);
static void ipp_set_error(ipp_status_t status, const char *format,
...);
static _ipp_value_t *ipp_set_value(ipp_t *ipp, ipp_attribute_t **attr,
int element);
static ssize_t ipp_write_file(int *fd, ipp_uchar_t *buffer,
size_t length);
/*
* '_cupsBufferGet()' - Get a read/write buffer.
*/
char * /* O - Buffer */
_cupsBufferGet(size_t size) /* I - Size required */
{
_cups_buffer_t *buffer; /* Current buffer */
_cups_globals_t *cg = _cupsGlobals();
/* Global data */
for (buffer = cg->cups_buffers; buffer; buffer = buffer->next)
if (!buffer->used && buffer->size >= size)
break;
if (!buffer)
{
if ((buffer = malloc(sizeof(_cups_buffer_t) + size - 1)) == NULL)
return (NULL);
buffer->next = cg->cups_buffers;
buffer->size = size;
cg->cups_buffers = buffer;
}
buffer->used = 1;
return (buffer->d);
}
/*
* '_cupsBufferRelease()' - Release a read/write buffer.
*/
void
_cupsBufferRelease(char *b) /* I - Buffer to release */
{
_cups_buffer_t *buffer; /* Buffer */
/*
* Mark this buffer as unused...
*/
buffer = (_cups_buffer_t *)(b - offsetof(_cups_buffer_t, d));
buffer->used = 0;
}
/*
* 'ippAddBoolean()' - Add a boolean attribute to an IPP message.
*
* The @code ipp@ parameter refers to an IPP message previously created using
* the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
*
* The @code group@ parameter specifies the IPP attribute group tag: none
* (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
* event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
* (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
* (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
*/
ipp_attribute_t * /* O - New attribute */
ippAddBoolean(ipp_t *ipp, /* I - IPP message */
ipp_tag_t group, /* I - IPP group */
const char *name, /* I - Name of attribute */
char value) /* I - Value of attribute */
{
ipp_attribute_t *attr; /* New attribute */
DEBUG_printf(("ippAddBoolean(ipp=%p, group=%02x(%s), name=\"%s\", value=%d)", (void *)ipp, group, ippTagString(group), name, value));
/*
* Range check input...
*/
if (!ipp || !name || group < IPP_TAG_ZERO ||
group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE)
return (NULL);
/*
* Create the attribute...
*/
if ((attr = ipp_add_attr(ipp, name, group, IPP_TAG_BOOLEAN, 1)) == NULL)
return (NULL);
attr->values[0].boolean = value;
return (attr);
}
/*
* 'ippAddBooleans()' - Add an array of boolean values.
*
* The @code ipp@ parameter refers to an IPP message previously created using
* the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
*
* The @code group@ parameter specifies the IPP attribute group tag: none
* (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
* event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
* (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
* (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
*/
ipp_attribute_t * /* O - New attribute */
ippAddBooleans(ipp_t *ipp, /* I - IPP message */
ipp_tag_t group, /* I - IPP group */
const char *name, /* I - Name of attribute */
int num_values, /* I - Number of values */
const char *values) /* I - Values */
{
int i; /* Looping var */
ipp_attribute_t *attr; /* New attribute */
_ipp_value_t *value; /* Current value */
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));
/*
* Range check input...
*/
if (!ipp || !name || group < IPP_TAG_ZERO ||
group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE ||
num_values < 1)
return (NULL);
/*
* Create the attribute...
*/
if ((attr = ipp_add_attr(ipp, name, group, IPP_TAG_BOOLEAN, num_values)) == NULL)
return (NULL);
if (values)
{
for (i = num_values, value = attr->values;
i > 0;
i --, value ++)
value->boolean = *values++;
}
return (attr);
}
/*
* 'ippAddCollection()' - Add a collection value.
*
* The @code ipp@ parameter refers to an IPP message previously created using
* the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
*
* The @code group@ parameter specifies the IPP attribute group tag: none
* (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
* event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
* (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
* (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
*
* @since CUPS 1.1.19/macOS 10.3@
*/
ipp_attribute_t * /* O - New attribute */
ippAddCollection(ipp_t *ipp, /* I - IPP message */
ipp_tag_t group, /* I - IPP group */
const char *name, /* I - Name of attribute */
ipp_t *value) /* I - Value */
{
ipp_attribute_t *attr; /* New attribute */
DEBUG_printf(("ippAddCollection(ipp=%p, group=%02x(%s), name=\"%s\", value=%p)", (void *)ipp, group, ippTagString(group), name, (void *)value));
/*
* Range check input...
*/
if (!ipp || !name || group < IPP_TAG_ZERO ||
group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE)
return (NULL);
/*
* Create the attribute...
*/
if ((attr = ipp_add_attr(ipp, name, group, IPP_TAG_BEGIN_COLLECTION, 1)) == NULL)
return (NULL);
attr->values[0].collection = value;
if (value)
value->use ++;
return (attr);
}
/*
* 'ippAddCollections()' - Add an array of collection values.
*
* The @code ipp@ parameter refers to an IPP message previously created using
* the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
*
* The @code group@ parameter specifies the IPP attribute group tag: none
* (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
* event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
* (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
* (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
*
* @since CUPS 1.1.19/macOS 10.3@
*/
ipp_attribute_t * /* O - New attribute */
ippAddCollections(
ipp_t *ipp, /* I - IPP message */
ipp_tag_t group, /* I - IPP group */
const char *name, /* I - Name of attribute */
int num_values, /* I - Number of values */
const ipp_t **values) /* I - Values */
{
int i; /* Looping var */
ipp_attribute_t *attr; /* New attribute */
_ipp_value_t *value; /* Current value */
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));
/*
* Range check input...
*/
if (!ipp || !name || group < IPP_TAG_ZERO ||
group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE ||
num_values < 1)
return (NULL);
/*
* Create the attribute...
*/
if ((attr = ipp_add_attr(ipp, name, group, IPP_TAG_BEGIN_COLLECTION,
num_values)) == NULL)
return (NULL);
if (values)
{
for (i = num_values, value = attr->values;
i > 0;
i --, value ++)
{
value->collection = (ipp_t *)*values++;
value->collection->use ++;
}
}
return (attr);
}
/*
* 'ippAddDate()' - Add a date attribute to an IPP message.
*
* The @code ipp@ parameter refers to an IPP message previously created using
* the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
*
* The @code group@ parameter specifies the IPP attribute group tag: none
* (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
* event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
* (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
* (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
*/
ipp_attribute_t * /* O - New attribute */
ippAddDate(ipp_t *ipp, /* I - IPP message */
ipp_tag_t group, /* I - IPP group */
const char *name, /* I - Name of attribute */
const ipp_uchar_t *value) /* I - Value */
{
ipp_attribute_t *attr; /* New attribute */
DEBUG_printf(("ippAddDate(ipp=%p, group=%02x(%s), name=\"%s\", value=%p)", (void *)ipp, group, ippTagString(group), name, (void *)value));
/*
* Range check input...
*/
if (!ipp || !name || !value || group < IPP_TAG_ZERO ||
group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE)
return (NULL);
/*
* Create the attribute...
*/
if ((attr = ipp_add_attr(ipp, name, group, IPP_TAG_DATE, 1)) == NULL)
return (NULL);
memcpy(attr->values[0].date, value, 11);
return (attr);
}
/*
* 'ippAddInteger()' - Add a integer attribute to an IPP message.
*
* The @code ipp@ parameter refers to an IPP message previously created using
* the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
*
* The @code group@ parameter specifies the IPP attribute group tag: none
* (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
* event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
* (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
* (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
*
* Supported values include enum (@code IPP_TAG_ENUM@) and integer
* (@code IPP_TAG_INTEGER@).
*/
ipp_attribute_t * /* O - New attribute */
ippAddInteger(ipp_t *ipp, /* I - IPP message */
ipp_tag_t group, /* I - IPP group */
ipp_tag_t value_tag, /* I - Type of attribute */
const char *name, /* I - Name of attribute */
int value) /* I - Value of attribute */
{
ipp_attribute_t *attr; /* New attribute */
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));
value_tag &= IPP_TAG_CUPS_MASK;
/*
* Special-case for legacy usage: map out-of-band attributes to new ippAddOutOfBand
* function...
*/
if (value_tag >= IPP_TAG_UNSUPPORTED_VALUE && value_tag <= IPP_TAG_ADMINDEFINE)
return (ippAddOutOfBand(ipp, group, value_tag, name));
/*
* Range check input...
*/
#if 0
if (!ipp || !name || group < IPP_TAG_ZERO ||
group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE ||
(value_tag != IPP_TAG_INTEGER && value_tag != IPP_TAG_ENUM))
return (NULL);
#else
if (!ipp || !name || group < IPP_TAG_ZERO ||
group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE)
return (NULL);
#endif /* 0 */
/*
* Create the attribute...
*/
if ((attr = ipp_add_attr(ipp, name, group, value_tag, 1)) == NULL)
return (NULL);
attr->values[0].integer = value;
return (attr);
}
/*
* 'ippAddIntegers()' - Add an array of integer values.
*
* The @code ipp@ parameter refers to an IPP message previously created using
* the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
*
* The @code group@ parameter specifies the IPP attribute group tag: none
* (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
* event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
* (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
* (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
*
* Supported values include enum (@code IPP_TAG_ENUM@) and integer
* (@code IPP_TAG_INTEGER@).
*/
ipp_attribute_t * /* O - New attribute */
ippAddIntegers(ipp_t *ipp, /* I - IPP message */
ipp_tag_t group, /* I - IPP group */
ipp_tag_t value_tag, /* I - Type of attribute */
const char *name, /* I - Name of attribute */
int num_values, /* I - Number of values */
const int *values) /* I - Values */
{
int i; /* Looping var */
ipp_attribute_t *attr; /* New attribute */
_ipp_value_t *value; /* Current value */
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));
value_tag &= IPP_TAG_CUPS_MASK;
/*
* Range check input...
*/
#if 0
if (!ipp || !name || group < IPP_TAG_ZERO ||
group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE ||
(value_tag != IPP_TAG_INTEGER && value_tag != IPP_TAG_ENUM) ||
num_values < 1)
return (NULL);
#else
if (!ipp || !name || group < IPP_TAG_ZERO ||
group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE ||
num_values < 1)
return (NULL);
#endif /* 0 */
/*
* Create the attribute...
*/
if ((attr = ipp_add_attr(ipp, name, group, value_tag, num_values)) == NULL)
return (NULL);
if (values)
{
for (i = num_values, value = attr->values;
i > 0;
i --, value ++)
value->integer = *values++;
}
return (attr);
}
/*
* 'ippAddOctetString()' - Add an octetString value to an IPP message.
*
* The @code ipp@ parameter refers to an IPP message previously created using
* the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
*
* The @code group@ parameter specifies the IPP attribute group tag: none
* (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
* event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
* (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
* (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
*
* @since CUPS 1.2/macOS 10.5@
*/
ipp_attribute_t * /* O - New attribute */
ippAddOctetString(ipp_t *ipp, /* I - IPP message */
ipp_tag_t group, /* I - IPP group */
const char *name, /* I - Name of attribute */
const void *data, /* I - octetString data */
int datalen) /* I - Length of data in bytes */
{
ipp_attribute_t *attr; /* New attribute */
if (!ipp || !name || group < IPP_TAG_ZERO ||
group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE ||
datalen < 0 || datalen > IPP_MAX_LENGTH)
return (NULL);
if ((attr = ipp_add_attr(ipp, name, group, IPP_TAG_STRING, 1)) == NULL)
return (NULL);
/*
* Initialize the attribute data...
*/
attr->values[0].unknown.length = datalen;
if (data)
{
if ((attr->values[0].unknown.data = malloc((size_t)datalen)) == NULL)
{
ippDeleteAttribute(ipp, attr);
return (NULL);
}
memcpy(attr->values[0].unknown.data, data, (size_t)datalen);
}
/*
* Return the new attribute...
*/
return (attr);
}
/*
* 'ippAddOutOfBand()' - Add an out-of-band value to an IPP message.
*
* The @code ipp@ parameter refers to an IPP message previously created using
* the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
*
* The @code group@ parameter specifies the IPP attribute group tag: none
* (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
* event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
* (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
* (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
*
* Supported out-of-band values include unsupported-value
* (@code IPP_TAG_UNSUPPORTED_VALUE@), default (@code IPP_TAG_DEFAULT@), unknown
* (@code IPP_TAG_UNKNOWN@), no-value (@code IPP_TAG_NOVALUE@), not-settable
* (@code IPP_TAG_NOTSETTABLE@), delete-attribute (@code IPP_TAG_DELETEATTR@), and
* admin-define (@code IPP_TAG_ADMINDEFINE@).
*
* @since CUPS 1.6/macOS 10.8@
*/
ipp_attribute_t * /* O - New attribute */
ippAddOutOfBand(ipp_t *ipp, /* I - IPP message */
ipp_tag_t group, /* I - IPP group */
ipp_tag_t value_tag, /* I - Type of attribute */
const char *name) /* I - Name of attribute */
{
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));
value_tag &= IPP_TAG_CUPS_MASK;
/*
* Range check input...
*/
if (!ipp || !name || group < IPP_TAG_ZERO ||
group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE ||
(value_tag != IPP_TAG_UNSUPPORTED_VALUE &&
value_tag != IPP_TAG_DEFAULT &&
value_tag != IPP_TAG_UNKNOWN &&
value_tag != IPP_TAG_NOVALUE &&
value_tag != IPP_TAG_NOTSETTABLE &&
value_tag != IPP_TAG_DELETEATTR &&
value_tag != IPP_TAG_ADMINDEFINE))
return (NULL);
/*
* Create the attribute...
*/
return (ipp_add_attr(ipp, name, group, value_tag, 1));
}
/*
* 'ippAddRange()' - Add a range of values to an IPP message.
*
* The @code ipp@ parameter refers to an IPP message previously created using
* the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
*
* The @code group@ parameter specifies the IPP attribute group tag: none
* (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
* event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
* (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
* (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
*
* The @code lower@ parameter must be less than or equal to the @code upper@ parameter.
*/
ipp_attribute_t * /* O - New attribute */
ippAddRange(ipp_t *ipp, /* I - IPP message */
ipp_tag_t group, /* I - IPP group */
const char *name, /* I - Name of attribute */
int lower, /* I - Lower value */
int upper) /* I - Upper value */
{
ipp_attribute_t *attr; /* New attribute */
DEBUG_printf(("ippAddRange(ipp=%p, group=%02x(%s), name=\"%s\", lower=%d, upper=%d)", (void *)ipp, group, ippTagString(group), name, lower, upper));
/*
* Range check input...
*/
if (!ipp || !name || group < IPP_TAG_ZERO ||
group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE)
return (NULL);
/*
* Create the attribute...
*/
if ((attr = ipp_add_attr(ipp, name, group, IPP_TAG_RANGE, 1)) == NULL)
return (NULL);
attr->values[0].range.lower = lower;
attr->values[0].range.upper = upper;
return (attr);
}
/*
* 'ippAddRanges()' - Add ranges of values to an IPP message.
*
* The @code ipp@ parameter refers to an IPP message previously created using
* the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
*
* The @code group@ parameter specifies the IPP attribute group tag: none
* (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
* event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
* (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
* (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
*/
ipp_attribute_t * /* O - New attribute */
ippAddRanges(ipp_t *ipp, /* I - IPP message */
ipp_tag_t group, /* I - IPP group */
const char *name, /* I - Name of attribute */
int num_values, /* I - Number of values */
const int *lower, /* I - Lower values */
const int *upper) /* I - Upper values */
{
int i; /* Looping var */
ipp_attribute_t *attr; /* New attribute */
_ipp_value_t *value; /* Current value */
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));
/*
* Range check input...
*/
if (!ipp || !name || group < IPP_TAG_ZERO ||
group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE ||
num_values < 1)
return (NULL);
/*
* Create the attribute...
*/
if ((attr = ipp_add_attr(ipp, name, group, IPP_TAG_RANGE, num_values)) == NULL)
return (NULL);
if (lower && upper)
{
for (i = num_values, value = attr->values;
i > 0;
i --, value ++)
{
value->range.lower = *lower++;
value->range.upper = *upper++;
}
}
return (attr);
}
/*
* 'ippAddResolution()' - Add a resolution value to an IPP message.
*
* The @code ipp@ parameter refers to an IPP message previously created using
* the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
*
* The @code group@ parameter specifies the IPP attribute group tag: none
* (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
* event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
* (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
* (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
*/
ipp_attribute_t * /* O - New attribute */
ippAddResolution(ipp_t *ipp, /* I - IPP message */
ipp_tag_t group, /* I - IPP group */
const char *name, /* I - Name of attribute */
ipp_res_t units, /* I - Units for resolution */
int xres, /* I - X resolution */
int yres) /* I - Y resolution */
{
ipp_attribute_t *attr; /* New attribute */
DEBUG_printf(("ippAddResolution(ipp=%p, group=%02x(%s), name=\"%s\", units=%d, xres=%d, yres=%d)", (void *)ipp, group,
ippTagString(group), name, units, xres, yres));
/*
* Range check input...
*/
if (!ipp || !name || group < IPP_TAG_ZERO ||
group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE ||
units < IPP_RES_PER_INCH || units > IPP_RES_PER_CM ||
xres < 0 || yres < 0)
return (NULL);
/*
* Create the attribute...
*/
if ((attr = ipp_add_attr(ipp, name, group, IPP_TAG_RESOLUTION, 1)) == NULL)
return (NULL);
attr->values[0].resolution.xres = xres;
attr->values[0].resolution.yres = yres;
attr->values[0].resolution.units = units;
return (attr);
}
/*
* 'ippAddResolutions()' - Add resolution values to an IPP message.
*
* The @code ipp@ parameter refers to an IPP message previously created using
* the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
*
* The @code group@ parameter specifies the IPP attribute group tag: none
* (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
* event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
* (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
* (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
*/
ipp_attribute_t * /* O - New attribute */
ippAddResolutions(ipp_t *ipp, /* I - IPP message */
ipp_tag_t group, /* I - IPP group */
const char *name, /* I - Name of attribute */
int num_values,/* I - Number of values */
ipp_res_t units, /* I - Units for resolution */
const int *xres, /* I - X resolutions */
const int *yres) /* I - Y resolutions */
{
int i; /* Looping var */
ipp_attribute_t *attr; /* New attribute */
_ipp_value_t *value; /* Current value */
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));
/*
* Range check input...
*/
if (!ipp || !name || group < IPP_TAG_ZERO ||
group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE ||
num_values < 1 ||
units < IPP_RES_PER_INCH || units > IPP_RES_PER_CM)
return (NULL);
/*
* Create the attribute...
*/
if ((attr = ipp_add_attr(ipp, name, group, IPP_TAG_RESOLUTION, num_values)) == NULL)
return (NULL);
if (xres && yres)
{
for (i = num_values, value = attr->values;
i > 0;
i --, value ++)
{
value->resolution.xres = *xres++;
value->resolution.yres = *yres++;
value->resolution.units = units;
}
}
return (attr);
}
/*
* 'ippAddSeparator()' - Add a group separator to an IPP message.
*
* The @code ipp@ parameter refers to an IPP message previously created using
* the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
*/
ipp_attribute_t * /* O - New attribute */
ippAddSeparator(ipp_t *ipp) /* I - IPP message */
{
DEBUG_printf(("ippAddSeparator(ipp=%p)", (void *)ipp));
/*
* Range check input...
*/
if (!ipp)
return (NULL);
/*
* Create the attribute...
*/
return (ipp_add_attr(ipp, NULL, IPP_TAG_ZERO, IPP_TAG_ZERO, 0));
}
/*
* 'ippAddString()' - Add a language-encoded string to an IPP message.
*
* The @code ipp@ parameter refers to an IPP message previously created using
* the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
*
* The @code group@ parameter specifies the IPP attribute group tag: none
* (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
* event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
* (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
* (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
*
* Supported string values include charset (@code IPP_TAG_CHARSET@), keyword
* (@code IPP_TAG_KEYWORD@), language (@code IPP_TAG_LANGUAGE@), mimeMediaType
* (@code IPP_TAG_MIMETYPE@), name (@code IPP_TAG_NAME@), nameWithLanguage
* (@code IPP_TAG_NAMELANG), text (@code IPP_TAG_TEXT@), textWithLanguage
* (@code IPP_TAG_TEXTLANG@), uri (@code IPP_TAG_URI@), and uriScheme
* (@code IPP_TAG_URISCHEME@).
*
* The @code language@ parameter must be non-@code NULL@ for nameWithLanguage and
* textWithLanguage string values and must be @code NULL@ for all other string values.
*/
ipp_attribute_t * /* O - New attribute */
ippAddString(ipp_t *ipp, /* I - IPP message */
ipp_tag_t group, /* I - IPP group */
ipp_tag_t value_tag, /* I - Type of attribute */
const char *name, /* I - Name of attribute */
const char *language, /* I - Language code */
const char *value) /* I - Value */
{
ipp_tag_t temp_tag; /* Temporary value tag (masked) */
ipp_attribute_t *attr; /* New attribute */
char code[IPP_MAX_LANGUAGE];
/* Charset/language code buffer */
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));
/*
* Range check input...
*/
temp_tag = (ipp_tag_t)((int)value_tag & IPP_TAG_CUPS_MASK);
#if 0
if (!ipp || !name || group < IPP_TAG_ZERO ||
group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE ||
(temp_tag < IPP_TAG_TEXT && temp_tag != IPP_TAG_TEXTLANG &&
temp_tag != IPP_TAG_NAMELANG) || temp_tag > IPP_TAG_MIMETYPE)
return (NULL);
if ((temp_tag == IPP_TAG_TEXTLANG || temp_tag == IPP_TAG_NAMELANG)
!= (language != NULL))
return (NULL);
#else
if (!ipp || !name || group < IPP_TAG_ZERO ||
group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE)
return (NULL);
#endif /* 0 */
/*
* See if we need to map charset, language, or locale values...
*/
if (language && ((int)value_tag & IPP_TAG_CUPS_CONST) &&
strcmp(language, ipp_lang_code(language, code, sizeof(code))))
value_tag = temp_tag; /* Don't do a fast copy */
else if (value && value_tag == (ipp_tag_t)(IPP_TAG_CHARSET | IPP_TAG_CUPS_CONST) &&
strcmp(value, ipp_get_code(value, code, sizeof(code))))
value_tag = temp_tag; /* Don't do a fast copy */
else if (value && value_tag == (ipp_tag_t)(IPP_TAG_LANGUAGE | IPP_TAG_CUPS_CONST) &&
strcmp(value, ipp_lang_code(value, code, sizeof(code))))
value_tag = temp_tag; /* Don't do a fast copy */
/*
* Create the attribute...
*/
if ((attr = ipp_add_attr(ipp, name, group, value_tag, 1)) == NULL)
return (NULL);
/*
* Initialize the attribute data...
*/
if ((int)value_tag & IPP_TAG_CUPS_CONST)
{
attr->values[0].string.language = (char *)language;
attr->values[0].string.text = (char *)value;
}
else
{
if (language)
attr->values[0].string.language = _cupsStrAlloc(ipp_lang_code(language, code,
sizeof(code)));
if (value)
{
if (value_tag == IPP_TAG_CHARSET)
attr->values[0].string.text = _cupsStrAlloc(ipp_get_code(value, code,
sizeof(code)));
else if (value_tag == IPP_TAG_LANGUAGE)
attr->values[0].string.text = _cupsStrAlloc(ipp_lang_code(value, code,
sizeof(code)));
else
attr->values[0].string.text = _cupsStrAlloc(value);
}
}
return (attr);
}
/*
* 'ippAddStringf()' - Add a formatted string to an IPP message.
*
* The @code ipp@ parameter refers to an IPP message previously created using
* the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
*
* The @code group@ parameter specifies the IPP attribute group tag: none
* (@code IPP_TAG_ZERO@, for member attributes), document
* (@code IPP_TAG_DOCUMENT@), event notification
* (@code IPP_TAG_EVENT_NOTIFICATION@), operation (@code IPP_TAG_OPERATION@),
* printer (@code IPP_TAG_PRINTER@), subscription (@code IPP_TAG_SUBSCRIPTION@),
* or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
*
* Supported string values include charset (@code IPP_TAG_CHARSET@), keyword
* (@code IPP_TAG_KEYWORD@), language (@code IPP_TAG_LANGUAGE@), mimeMediaType
* (@code IPP_TAG_MIMETYPE@), name (@code IPP_TAG_NAME@), nameWithLanguage
* (@code IPP_TAG_NAMELANG), text (@code IPP_TAG_TEXT@), textWithLanguage
* (@code IPP_TAG_TEXTLANG@), uri (@code IPP_TAG_URI@), and uriScheme
* (@code IPP_TAG_URISCHEME@).
*
* The @code language@ parameter must be non-@code NULL@ for nameWithLanguage
* and textWithLanguage string values and must be @code NULL@ for all other
* string values.
*
* The @code format@ parameter uses formatting characters compatible with the
* printf family of standard functions. Additional arguments follow it as
* needed. The formatted string is truncated as needed to the maximum length of
* the corresponding value type.
*
* @since CUPS 1.7/macOS 10.9@
*/
ipp_attribute_t * /* O - New attribute */
ippAddStringf(ipp_t *ipp, /* I - IPP message */
ipp_tag_t group, /* I - IPP group */
ipp_tag_t value_tag, /* I - Type of attribute */
const char *name, /* I - Name of attribute */
const char *language, /* I - Language code (@code NULL@ for default) */
const char *format, /* I - Printf-style format string */
...) /* I - Additional arguments as needed */
{
ipp_attribute_t *attr; /* New attribute */
va_list ap; /* Argument pointer */
va_start(ap, format);
attr = ippAddStringfv(ipp, group, value_tag, name, language, format, ap);
va_end(ap);
return (attr);
}
/*
* 'ippAddStringfv()' - Add a formatted string to an IPP message.
*
* The @code ipp@ parameter refers to an IPP message previously created using
* the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
*
* The @code group@ parameter specifies the IPP attribute group tag: none
* (@code IPP_TAG_ZERO@, for member attributes), document
* (@code IPP_TAG_DOCUMENT@), event notification
* (@code IPP_TAG_EVENT_NOTIFICATION@), operation (@code IPP_TAG_OPERATION@),
* printer (@code IPP_TAG_PRINTER@), subscription (@code IPP_TAG_SUBSCRIPTION@),
* or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
*
* Supported string values include charset (@code IPP_TAG_CHARSET@), keyword
* (@code IPP_TAG_KEYWORD@), language (@code IPP_TAG_LANGUAGE@), mimeMediaType
* (@code IPP_TAG_MIMETYPE@), name (@code IPP_TAG_NAME@), nameWithLanguage
* (@code IPP_TAG_NAMELANG), text (@code IPP_TAG_TEXT@), textWithLanguage
* (@code IPP_TAG_TEXTLANG@), uri (@code IPP_TAG_URI@), and uriScheme
* (@code IPP_TAG_URISCHEME@).
*
* The @code language@ parameter must be non-@code NULL@ for nameWithLanguage
* and textWithLanguage string values and must be @code NULL@ for all other
* string values.
*
* The @code format@ parameter uses formatting characters compatible with the
* printf family of standard functions. Additional arguments are passed in the
* stdarg pointer @code ap@. The formatted string is truncated as needed to the
* maximum length of the corresponding value type.
*
* @since CUPS 1.7/macOS 10.9@
*/
ipp_attribute_t * /* O - New attribute */
ippAddStringfv(ipp_t *ipp, /* I - IPP message */
ipp_tag_t group, /* I - IPP group */
ipp_tag_t value_tag, /* I - Type of attribute */
const char *name, /* I - Name of attribute */
const char *language, /* I - Language code (@code NULL@ for default) */
const char *format, /* I - Printf-style format string */
va_list ap) /* I - Additional arguments */
{
char buffer[IPP_MAX_TEXT + 4];
/* Formatted text string */
ssize_t bytes, /* Length of formatted value */
max_bytes; /* Maximum number of bytes for value */
/*
* Range check input...
*/
if (!ipp || !name || group < IPP_TAG_ZERO ||
group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE ||
(value_tag < IPP_TAG_TEXT && value_tag != IPP_TAG_TEXTLANG &&
value_tag != IPP_TAG_NAMELANG) || value_tag > IPP_TAG_MIMETYPE ||
!format)
return (NULL);
if ((value_tag == IPP_TAG_TEXTLANG || value_tag == IPP_TAG_NAMELANG)
!= (language != NULL))
return (NULL);
/*
* Format the string...
*/
if (!strcmp(format, "%s"))
{
/*
* Optimize the simple case...
*/
const char *s = va_arg(ap, char *);
if (!s)
s = "(null)";
bytes = (ssize_t)strlen(s);
strlcpy(buffer, s, sizeof(buffer));
}
else
{
/*
* Do a full formatting of the message...
*/
if ((bytes = vsnprintf(buffer, sizeof(buffer), format, ap)) < 0)
return (NULL);
}
/*
* Limit the length of the string...
*/
switch (value_tag)
{
default :
case IPP_TAG_TEXT :
case IPP_TAG_TEXTLANG :
max_bytes = IPP_MAX_TEXT;
break;
case IPP_TAG_NAME :
case IPP_TAG_NAMELANG :
max_bytes = IPP_MAX_NAME;
break;
case IPP_TAG_CHARSET :
max_bytes = IPP_MAX_CHARSET;
break;
case IPP_TAG_KEYWORD :
max_bytes = IPP_MAX_KEYWORD;
break;
case IPP_TAG_LANGUAGE :
max_bytes = IPP_MAX_LANGUAGE;
break;
case IPP_TAG_MIMETYPE :
max_bytes = IPP_MAX_MIMETYPE;
break;
case IPP_TAG_URI :
max_bytes = IPP_MAX_URI;
break;
case IPP_TAG_URISCHEME :
max_bytes = IPP_MAX_URISCHEME;
break;
}
if (bytes >= max_bytes)
{
char *bufmax, /* Buffer at max_bytes */
*bufptr; /* Pointer into buffer */
bufptr = buffer + strlen(buffer) - 1;
bufmax = buffer + max_bytes - 1;
while (bufptr > bufmax)
{
if (*bufptr & 0x80)
{
while ((*bufptr & 0xc0) == 0x80 && bufptr > buffer)
bufptr --;
}
bufptr --;
}
*bufptr = '\0';
}
/*
* Add the formatted string and return...
*/
return (ippAddString(ipp, group, value_tag, name, language, buffer));
}
/*
* 'ippAddStrings()' - Add language-encoded strings to an IPP message.
*
* The @code ipp@ parameter refers to an IPP message previously created using
* the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions.
*
* The @code group@ parameter specifies the IPP attribute group tag: none
* (@code IPP_TAG_ZERO@, for member attributes), document (@code IPP_TAG_DOCUMENT@),
* event notification (@code IPP_TAG_EVENT_NOTIFICATION@), operation
* (@code IPP_TAG_OPERATION@), printer (@code IPP_TAG_PRINTER@), subscription
* (@code IPP_TAG_SUBSCRIPTION@), or unsupported (@code IPP_TAG_UNSUPPORTED_GROUP@).
*
* Supported string values include charset (@code IPP_TAG_CHARSET@), keyword
* (@code IPP_TAG_KEYWORD@), language (@code IPP_TAG_LANGUAGE@), mimeMediaType
* (@code IPP_TAG_MIMETYPE@), name (@code IPP_TAG_NAME@), nameWithLanguage
* (@code IPP_TAG_NAMELANG), text (@code IPP_TAG_TEXT@), textWithLanguage
* (@code IPP_TAG_TEXTLANG@), uri (@code IPP_TAG_URI@), and uriScheme
* (@code IPP_TAG_URISCHEME@).
*
* The @code language@ parameter must be non-@code NULL@ for nameWithLanguage and
* textWithLanguage string values and must be @code NULL@ for all other string values.
*/
ipp_attribute_t * /* O - New attribute */
ippAddStrings(
ipp_t *ipp, /* I - IPP message */
ipp_tag_t group, /* I - IPP group */
ipp_tag_t value_tag, /* I - Type of attribute */
const char *name, /* I - Name of attribute */
int num_values, /* I - Number of values */
const char *language, /* I - Language code (@code NULL@ for default) */
const char * const *values) /* I - Values */
{
int i; /* Looping var */
ipp_tag_t temp_tag; /* Temporary value tag (masked) */
ipp_attribute_t *attr; /* New attribute */
_ipp_value_t *value; /* Current value */
char code[32]; /* Language/charset value buffer */
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));
/*
* Range check input...
*/
temp_tag = (ipp_tag_t)((int)value_tag & IPP_TAG_CUPS_MASK);
#if 0
if (!ipp || !name || group < IPP_TAG_ZERO ||
group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE ||
(temp_tag < IPP_TAG_TEXT && temp_tag != IPP_TAG_TEXTLANG &&
temp_tag != IPP_TAG_NAMELANG) || temp_tag > IPP_TAG_MIMETYPE ||
num_values < 1)
return (NULL);
if ((temp_tag == IPP_TAG_TEXTLANG || temp_tag == IPP_TAG_NAMELANG)
!= (language != NULL))
return (NULL);
#else
if (!ipp || !name || group < IPP_TAG_ZERO ||
group == IPP_TAG_END || group >= IPP_TAG_UNSUPPORTED_VALUE ||
num_values < 1)
return (NULL);
#endif /* 0 */
/*
* See if we need to map charset, language, or locale values...
*/
if (language && ((int)value_tag & IPP_TAG_CUPS_CONST) &&
strcmp(language, ipp_lang_code(language, code, sizeof(code))))
value_tag = temp_tag; /* Don't do a fast copy */
else if (values && value_tag == (ipp_tag_t)(IPP_TAG_CHARSET | IPP_TAG_CUPS_CONST))
{
for (i = 0; i < num_values; i ++)
if (strcmp(values[i], ipp_get_code(values[i], code, sizeof(code))))
{
value_tag = temp_tag; /* Don't do a fast copy */
break;
}
}
else if (values && value_tag == (ipp_tag_t)(IPP_TAG_LANGUAGE | IPP_TAG_CUPS_CONST))
{
for (i = 0; i < num_values; i ++)
if (strcmp(values[i], ipp_lang_code(values[i], code, sizeof(code))))
{
value_tag = temp_tag; /* Don't do a fast copy */
break;
}
}
/*
* Create the attribute...
*/
if ((attr = ipp_add_attr(ipp, name, group, value_tag, num_values)) == NULL)
return (NULL);
/*
* Initialize the attribute data...
*/
for (i = num_values, value = attr->values;
i > 0;
i --, value ++)
{
if (language)
{
if (value == attr->values)
{
if ((int)value_tag & IPP_TAG_CUPS_CONST)
value->string.language = (char *)language;
else
value->string.language = _cupsStrAlloc(ipp_lang_code(language, code,
sizeof(code)));
}
else
value->string.language = attr->values[0].string.language;
}
if (values)
{
if ((int)value_tag & IPP_TAG_CUPS_CONST)
value->string.text = (char *)*values++;
else if (value_tag == IPP_TAG_CHARSET)
value->string.text = _cupsStrAlloc(ipp_get_code(*values++, code, sizeof(code)));
else if (value_tag == IPP_TAG_LANGUAGE)
value->string.text = _cupsStrAlloc(ipp_lang_code(*values++, code, sizeof(code)));
else
value->string.text = _cupsStrAlloc(*values++);
}
}
return (attr);
}
/*
* 'ippContainsInteger()' - Determine whether an attribute contains the
* specified value or is within the list of ranges.
*
* Returns non-zero when the attribute contains either a matching integer or
* enum value, or the value falls within one of the rangeOfInteger values for
* the attribute.
*
* @since CUPS 1.7/macOS 10.9@
*/
int /* O - 1 on a match, 0 on no match */
ippContainsInteger(
ipp_attribute_t *attr, /* I - Attribute */
int value) /* I - Integer/enum value */
{
int i; /* Looping var */
_ipp_value_t *avalue; /* Current attribute value */
/*
* Range check input...
*/
if (!attr)
return (0);
if (attr->value_tag != IPP_TAG_INTEGER && attr->value_tag != IPP_TAG_ENUM &&
attr->value_tag != IPP_TAG_RANGE)
return (0);
/*
* Compare...
*/
if (attr->value_tag == IPP_TAG_RANGE)
{
for (i = attr->num_values, avalue = attr->values; i > 0; i --, avalue ++)
if (value >= avalue->range.lower && value <= avalue->range.upper)
return (1);
}
else
{
for (i = attr->num_values, avalue = attr->values; i > 0; i --, avalue ++)
if (value == avalue->integer)
return (1);
}
return (0);
}
/*
* 'ippContainsString()' - Determine whether an attribute contains the
* specified string value.
*
* Returns non-zero when the attribute contains a matching charset, keyword,
* language, mimeMediaType, name, text, URI, or URI scheme value.
*
* @since CUPS 1.7/macOS 10.9@
*/
int /* O - 1 on a match, 0 on no match */
ippContainsString(
ipp_attribute_t *attr, /* I - Attribute */
const char *value) /* I - String value */
{
int i; /* Looping var */
_ipp_value_t *avalue; /* Current attribute value */
DEBUG_printf(("ippContainsString(attr=%p, value=\"%s\")", (void *)attr, value));
/*
* Range check input...
*/
if (!attr || !value)
{
DEBUG_puts("1ippContainsString: Returning 0 (bad input)");
return (0);
}
/*
* Compare...
*/
DEBUG_printf(("1ippContainsString: attr %s, %s with %d values.",
attr->name, ippTagString(attr->value_tag),
attr->num_values));
switch (attr->value_tag & IPP_TAG_CUPS_MASK)
{
case IPP_TAG_CHARSET :
case IPP_TAG_KEYWORD :
case IPP_TAG_LANGUAGE :
case IPP_TAG_URI :
case IPP_TAG_URISCHEME :
for (i = attr->num_values, avalue = attr->values;
i > 0;
i --, avalue ++)
{
DEBUG_printf(("1ippContainsString: value[%d]=\"%s\"",
attr->num_values - i, avalue->string.text));
if (!strcmp(value, avalue->string.text))
{
DEBUG_puts("1ippContainsString: Returning 1 (match)");
return (1);
}
}
case IPP_TAG_MIMETYPE :
case IPP_TAG_NAME :
case IPP_TAG_NAMELANG :
case IPP_TAG_TEXT :
case IPP_TAG_TEXTLANG :
for (i = attr->num_values, avalue = attr->values;
i > 0;
i --, avalue ++)
{
DEBUG_printf(("1ippContainsString: value[%d]=\"%s\"",
attr->num_values - i, avalue->string.text));
if (!_cups_strcasecmp(value, avalue->string.text))
{
DEBUG_puts("1ippContainsString: Returning 1 (match)");
return (1);
}
}
default :
break;
}
DEBUG_puts("1ippContainsString: Returning 0 (no match)");
return (0);
}
/*
* 'ippCopyAttribute()' - Copy an attribute.
*
* The specified attribute, @code attr@, is copied to the destination IPP message.
* When @code quickcopy@ is non-zero, a "shallow" reference copy of the attribute is
* created - this should only be done as long as the original source IPP message will
* not be freed for the life of the destination.
*
* @since CUPS 1.6/macOS 10.8@
*/
ipp_attribute_t * /* O - New attribute */
ippCopyAttribute(
ipp_t *dst, /* I - Destination IPP message */
ipp_attribute_t *srcattr, /* I - Attribute to copy */
int quickcopy) /* I - 1 for a referenced copy, 0 for normal */
{
int i; /* Looping var */
ipp_attribute_t *dstattr; /* Destination attribute */
_ipp_value_t *srcval, /* Source value */
*dstval; /* Destination value */
DEBUG_printf(("ippCopyAttribute(dst=%p, srcattr=%p, quickcopy=%d)", (void *)dst, (void *)srcattr, quickcopy));
/*
* Range check input...
*/
if (!dst || !srcattr)
return (NULL);
/*
* Copy it...
*/
quickcopy = quickcopy ? IPP_TAG_CUPS_CONST : 0;
switch (srcattr->value_tag & ~IPP_TAG_CUPS_CONST)
{
case IPP_TAG_ZERO :
dstattr = ippAddSeparator(dst);
break;
case IPP_TAG_INTEGER :
case IPP_TAG_ENUM :
dstattr = ippAddIntegers(dst, srcattr->group_tag, srcattr->value_tag,
srcattr->name, srcattr->num_values, NULL);
if (!dstattr)
break;
for (i = srcattr->num_values, srcval = srcattr->values, dstval = dstattr->values;
i > 0;
i --, srcval ++, dstval ++)
dstval->integer = srcval->integer;
break;
case IPP_TAG_BOOLEAN :
dstattr = ippAddBooleans(dst, srcattr->group_tag, srcattr->name,
srcattr->num_values, NULL);
if (!dstattr)
break;
for (i = srcattr->num_values, srcval = srcattr->values, dstval = dstattr->values;
i > 0;
i --, srcval ++, dstval ++)
dstval->boolean = srcval->boolean;
break;
case IPP_TAG_TEXT :
case IPP_TAG_NAME :
case IPP_TAG_KEYWORD :
case IPP_TAG_URI :
case IPP_TAG_URISCHEME :
case IPP_TAG_CHARSET :
case IPP_TAG_LANGUAGE :
case IPP_TAG_MIMETYPE :
dstattr = ippAddStrings(dst, srcattr->group_tag,
(ipp_tag_t)(srcattr->value_tag | quickcopy),
srcattr->name, srcattr->num_values, NULL, NULL);
if (!dstattr)
break;
if (quickcopy)
{
for (i = srcattr->num_values, srcval = srcattr->values,
dstval = dstattr->values;
i > 0;
i --, srcval ++, dstval ++)
dstval->string.text = srcval->string.text;
}
else if (srcattr->value_tag & IPP_TAG_CUPS_CONST)
{
for (i = srcattr->num_values, srcval = srcattr->values,
dstval = dstattr->values;
i > 0;
i --, srcval ++, dstval ++)
dstval->string.text = _cupsStrAlloc(srcval->string.text);
}
else
{
for (i = srcattr->num_values, srcval = srcattr->values,
dstval = dstattr->values;
i > 0;
i --, srcval ++, dstval ++)
dstval->string.text = _cupsStrRetain(srcval->string.text);
}
break;
case IPP_TAG_DATE :
if (srcattr->num_values != 1)
return (NULL);
dstattr = ippAddDate(dst, srcattr->group_tag, srcattr->name,
srcattr->values[0].date);
break;
case IPP_TAG_RESOLUTION :
dstattr = ippAddResolutions(dst, srcattr->group_tag, srcattr->name,
srcattr->num_values, IPP_RES_PER_INCH,
NULL, NULL);
if (!dstattr)
break;
for (i = srcattr->num_values, srcval = srcattr->values, dstval = dstattr->values;
i > 0;
i --, srcval ++, dstval ++)
{
dstval->resolution.xres = srcval->resolution.xres;
dstval->resolution.yres = srcval->resolution.yres;
dstval->resolution.units = srcval->resolution.units;
}
break;
case IPP_TAG_RANGE :
dstattr = ippAddRanges(dst, srcattr->group_tag, srcattr->name,
srcattr->num_values, NULL, NULL);
if (!dstattr)
break;
for (i = srcattr->num_values, srcval = srcattr->values, dstval = dstattr->values;
i > 0;
i --, srcval ++, dstval ++)
{
dstval->range.lower = srcval->range.lower;
dstval->range.upper = srcval->range.upper;
}
break;
case IPP_TAG_TEXTLANG :
case IPP_TAG_NAMELANG :
dstattr = ippAddStrings(dst, srcattr->group_tag,
(ipp_tag_t)(srcattr->value_tag | quickcopy),
srcattr->name, srcattr->num_values, NULL, NULL);
if (!dstattr)
break;
if (quickcopy)
{
for (i = srcattr->num_values, srcval = srcattr->values,
dstval = dstattr->values;
i > 0;
i --, srcval ++, dstval ++)
{
dstval->string.language = srcval->string.language;
dstval->string.text = srcval->string.text;
}
}
else if (srcattr->value_tag & IPP_TAG_CUPS_CONST)
{
for (i = srcattr->num_values, srcval = srcattr->values,
dstval = dstattr->values;
i > 0;
i --, srcval ++, dstval ++)
{
if (srcval == srcattr->values)
dstval->string.language = _cupsStrAlloc(srcval->string.language);
else
dstval->string.language = dstattr->values[0].string.language;
dstval->string.text = _cupsStrAlloc(srcval->string.text);
}
}
else
{
for (i = srcattr->num_values, srcval = srcattr->values,
dstval = dstattr->values;
i > 0;
i --, srcval ++, dstval ++)
{
if (srcval == srcattr->values)
dstval->string.language = _cupsStrRetain(srcval->string.language);
else
dstval->string.language = dstattr->values[0].string.language;
dstval->string.text = _cupsStrRetain(srcval->string.text);
}
}
break;
case IPP_TAG_BEGIN_COLLECTION :
dstattr = ippAddCollections(dst, srcattr->group_tag, srcattr->name,
srcattr->num_values, NULL);
if (!dstattr)
break;
for (i = srcattr->num_values, srcval = srcattr->values, dstval = dstattr->values;
i > 0;
i --, srcval ++, dstval ++)
{
dstval->collection = srcval->collection;
srcval->collection->use ++;
}
break;
case IPP_TAG_STRING :
default :
/* TODO: Implement quick copy for unknown/octetString values */
dstattr = ippAddIntegers(dst, srcattr->group_tag, srcattr->value_tag,
srcattr->name, srcattr->num_values, NULL);
if (!dstattr)
break;
for (i = srcattr->num_values, srcval = srcattr->values, dstval = dstattr->values;
i > 0;
i --, srcval ++, dstval ++)
{
dstval->unknown.length = srcval->unknown.length;
if (dstval->unknown.length > 0)
{
if ((dstval->unknown.data = malloc((size_t)dstval->unknown.length)) == NULL)
dstval->unknown.length = 0;
else
memcpy(dstval->unknown.data, srcval->unknown.data, (size_t)dstval->unknown.length);
}
}
break; /* anti-compiler-warning-code */
}
return (dstattr);
}
/*
* 'ippCopyAttributes()' - Copy attributes from one IPP message to another.
*
* Zero or more attributes are copied from the source IPP message, @code src@, to the
* destination IPP message, @code dst@. When @code quickcopy@ is non-zero, a "shallow"
* reference copy of the attribute is created - this should only be done as long as the
* original source IPP message will not be freed for the life of the destination.
*
* The @code cb@ and @code context@ parameters provide a generic way to "filter" the
* attributes that are copied - the function must return 1 to copy the attribute or
* 0 to skip it. The function may also choose to do a partial copy of the source attribute
* itself.
*
* @since CUPS 1.6/macOS 10.8@
*/
int /* O - 1 on success, 0 on error */
ippCopyAttributes(
ipp_t *dst, /* I - Destination IPP message */
ipp_t *src, /* I - Source IPP message */
int quickcopy, /* I - 1 for a referenced copy, 0 for normal */
ipp_copycb_t cb, /* I - Copy callback or @code NULL@ for none */
void *context) /* I - Context pointer */
{
ipp_attribute_t *srcattr; /* Source attribute */
DEBUG_printf(("ippCopyAttributes(dst=%p, src=%p, quickcopy=%d, cb=%p, context=%p)", (void *)dst, (void *)src, quickcopy, (void *)cb, context));
/*
* Range check input...
*/
if (!dst || !src)
return (0);
/*
* Loop through source attributes and copy as needed...
*/
for (srcattr = src->attrs; srcattr; srcattr = srcattr->next)
if (!cb || (*cb)(context, dst, srcattr))
if (!ippCopyAttribute(dst, srcattr, quickcopy))
return (0);
return (1);
}
/*
* 'ippDateToTime()' - Convert from RFC 1903 Date/Time format to UNIX time
* in seconds.
*/
time_t /* O - UNIX time value */
ippDateToTime(const ipp_uchar_t *date) /* I - RFC 1903 date info */
{
struct tm unixdate; /* UNIX date/time info */
time_t t; /* Computed time */
if (!date)
return (0);
memset(&unixdate, 0, sizeof(unixdate));
/*
* RFC-1903 date/time format is:
*
* Byte(s) Description
* ------- -----------
* 0-1 Year (0 to 65535)
* 2 Month (1 to 12)
* 3 Day (1 to 31)
* 4 Hours (0 to 23)
* 5 Minutes (0 to 59)
* 6 Seconds (0 to 60, 60 = "leap second")
* 7 Deciseconds (0 to 9)
* 8 +/- UTC
* 9 UTC hours (0 to 11)
* 10 UTC minutes (0 to 59)
*/
unixdate.tm_year = ((date[0] << 8) | date[1]) - 1900;
unixdate.tm_mon = date[2] - 1;
unixdate.tm_mday = date[3];
unixdate.tm_hour = date[4];
unixdate.tm_min = date[5];
unixdate.tm_sec = date[6];
t = mktime(&unixdate);
if (date[8] == '-')
t += date[9] * 3600 + date[10] * 60;
else
t -= date[9] * 3600 + date[10] * 60;
return (t);
}
/*
* 'ippDelete()' - Delete an IPP message.
*/
void
ippDelete(ipp_t *ipp) /* I - IPP message */
{
ipp_attribute_t *attr, /* Current attribute */
*next; /* Next attribute */
DEBUG_printf(("ippDelete(ipp=%p)", (void *)ipp));
if (!ipp)
return;
ipp->use --;
if (ipp->use > 0)
return;
for (attr = ipp->attrs; attr != NULL; attr = next)
{
next = attr->next;
ipp_free_values(attr, 0, attr->num_values);
if (attr->name)
_cupsStrFree(attr->name);
free(attr);
}
free(ipp);
}
/*
* 'ippDeleteAttribute()' - Delete a single attribute in an IPP message.
*
* @since CUPS 1.1.19/macOS 10.3@
*/
void
ippDeleteAttribute(
ipp_t *ipp, /* I - IPP message */
ipp_attribute_t *attr) /* I - Attribute to delete */
{
ipp_attribute_t *current, /* Current attribute */
*prev; /* Previous attribute */
DEBUG_printf(("ippDeleteAttribute(ipp=%p, attr=%p(%s))", (void *)ipp, (void *)attr, attr ? attr->name : "(null)"));
/*
* Range check input...
*/
if (!attr)
return;
/*
* Find the attribute in the list...
*/
if (ipp)
{
for (current = ipp->attrs, prev = NULL;
current;
prev = current, current = current->next)
if (current == attr)
{
/*
* Found it, remove the attribute from the list...
*/
if (prev)
prev->next = current->next;
else
ipp->attrs = current->next;
if (current == ipp->last)
ipp->last = prev;
break;
}
if (!current)
return;
}
/*
* Free memory used by the attribute...
*/
ipp_free_values(attr, 0, attr->num_values);
if (attr->name)
_cupsStrFree(attr->name);
free(attr);
}
/*
* 'ippDeleteValues()' - Delete values in an attribute.
*
* The @code element@ parameter specifies the first value to delete, starting at
* 0. It must be less than the number of values returned by @link ippGetCount@.
*
* The @code attr@ parameter may be modified as a result of setting the value.
*
* Deleting all values in an attribute deletes the attribute.
*
* @since CUPS 1.6/macOS 10.8@
*/
int /* O - 1 on success, 0 on failure */
ippDeleteValues(
ipp_t *ipp, /* I - IPP message */
ipp_attribute_t **attr, /* IO - Attribute */
int element, /* I - Index of first value to delete (0-based) */
int count) /* I - Number of values to delete */
{
/*
* Range check input...
*/
if (!ipp || !attr || !*attr ||
element < 0 || element >= (*attr)->num_values || count <= 0 ||
(element + count) >= (*attr)->num_values)
return (0);
/*
* If we are deleting all values, just delete the attribute entirely.
*/
if (count == (*attr)->num_values)
{
ippDeleteAttribute(ipp, *attr);
*attr = NULL;
return (1);
}
/*
* Otherwise free the values in question and return.
*/
ipp_free_values(*attr, element, count);
return (1);
}
/*
* 'ippFindAttribute()' - Find a named attribute in a request.
*
* Starting with CUPS 2.0, the attribute name can contain a hierarchical list
* of attribute and member names separated by slashes, for example
* "media-col/media-size".
*/
ipp_attribute_t * /* O - Matching attribute */
ippFindAttribute(ipp_t *ipp, /* I - IPP message */
const char *name, /* I - Name of attribute */
ipp_tag_t type) /* I - Type of attribute */
{
DEBUG_printf(("2ippFindAttribute(ipp=%p, name=\"%s\", type=%02x(%s))", (void *)ipp, name, type, ippTagString(type)));
if (!ipp || !name)
return (NULL);
/*
* Reset the current pointer...
*/
ipp->current = NULL;
ipp->atend = 0;
/*
* Search for the attribute...
*/
return (ippFindNextAttribute(ipp, name, type));
}
/*
* 'ippFindNextAttribute()' - Find the next named attribute in a request.
*
* Starting with CUPS 2.0, the attribute name can contain a hierarchical list
* of attribute and member names separated by slashes, for example
* "media-col/media-size".
*/
ipp_attribute_t * /* O - Matching attribute */
ippFindNextAttribute(ipp_t *ipp, /* I - IPP message */
const char *name, /* I - Name of attribute */
ipp_tag_t type) /* I - Type of attribute */
{
ipp_attribute_t *attr, /* Current atttribute */
*childattr; /* Child attribute */
ipp_tag_t value_tag; /* Value tag */
char parent[1024], /* Parent attribute name */
*child = NULL; /* Child attribute name */
DEBUG_printf(("2ippFindNextAttribute(ipp=%p, name=\"%s\", type=%02x(%s))", (void *)ipp, name, type, ippTagString(type)));
if (!ipp || !name)
return (NULL);
DEBUG_printf(("3ippFindNextAttribute: atend=%d", ipp->atend));
if (ipp->atend)
return (NULL);
if (strchr(name, '/'))
{
/*
* Search for child attribute...
*/
strlcpy(parent, name, sizeof(parent));
if ((child = strchr(parent, '/')) == NULL)
{
DEBUG_puts("3ippFindNextAttribute: Attribute name too long.");
return (NULL);
}
*child++ = '\0';
if (ipp->current && ipp->current->name && ipp->current->value_tag == IPP_TAG_BEGIN_COLLECTION && !strcmp(parent, ipp->current->name))
{
while (ipp->curindex < ipp->current->num_values)
{
if ((childattr = ippFindNextAttribute(ipp->current->values[ipp->curindex].collection, child, type)) != NULL)
return (childattr);
ipp->curindex ++;
if (ipp->curindex < ipp->current->num_values && ipp->current->values[ipp->curindex].collection)
ipp->current->values[ipp->curindex].collection->current = NULL;
}
ipp->prev = ipp->current;
ipp->current = ipp->current->next;
ipp->curindex = 0;
if (!ipp->current)
{
ipp->atend = 1;
return (NULL);
}
}
if (!ipp->current)
{
ipp->prev = NULL;
ipp->current = ipp->attrs;
ipp->curindex = 0;
}
name = parent;
attr = ipp->current;
}
else if (ipp->current)
{
ipp->prev = ipp->current;
attr = ipp->current->next;
}
else
{
ipp->prev = NULL;
attr = ipp->attrs;
}
for (; attr != NULL; ipp->prev = attr, attr = attr->next)
{
DEBUG_printf(("4ippFindAttribute: attr=%p, name=\"%s\"", (void *)attr, attr->name));
value_tag = (ipp_tag_t)(attr->value_tag & IPP_TAG_CUPS_MASK);
if (attr->name != NULL && _cups_strcasecmp(attr->name, name) == 0 &&
(value_tag == type || type == IPP_TAG_ZERO || name == parent ||
(value_tag == IPP_TAG_TEXTLANG && type == IPP_TAG_TEXT) ||
(value_tag == IPP_TAG_NAMELANG && type == IPP_TAG_NAME)))
{
ipp->current = attr;
if (name == parent && attr->value_tag == IPP_TAG_BEGIN_COLLECTION)
{
int i; /* Looping var */
for (i = 0; i < attr->num_values; i ++)
{
if ((childattr = ippFindAttribute(attr->values[i].collection, child, type)) != NULL)
{
attr->values[0].collection->curindex = i;
return (childattr);
}
}
}
else
return (attr);
}
}
ipp->current = NULL;
ipp->prev = NULL;
ipp->atend = 1;
return (NULL);
}
/*
* 'ippFirstAttribute()' - Return the first attribute in the message.
*
* @since CUPS 1.6/macOS 10.8@
*/
ipp_attribute_t * /* O - First attribute or @code NULL@ if none */
ippFirstAttribute(ipp_t *ipp) /* I - IPP message */
{
/*
* Range check input...
*/
if (!ipp)
return (NULL);
/*
* Return the first attribute...
*/
return (ipp->current = ipp->attrs);
}
/*
* 'ippGetBoolean()' - Get a boolean value for an attribute.
*
* The @code element@ parameter specifies which value to get from 0 to
* @link ippGetCount(attr)@ - 1.
*
* @since CUPS 1.6/macOS 10.8@
*/
int /* O - Boolean value or 0 on error */
ippGetBoolean(ipp_attribute_t *attr, /* I - IPP attribute */
int element) /* I - Value number (0-based) */
{
/*
* Range check input...
*/
if (!attr || attr->value_tag != IPP_TAG_BOOLEAN ||
element < 0 || element >= attr->num_values)
return (0);
/*
* Return the value...
*/
return (attr->values[element].boolean);
}
/*
* 'ippGetCollection()' - Get a collection value for an attribute.
*
* The @code element@ parameter specifies which value to get from 0 to
* @link ippGetCount(attr)@ - 1.
*
* @since CUPS 1.6/macOS 10.8@
*/
ipp_t * /* O - Collection value or @code NULL@ on error */
ippGetCollection(
ipp_attribute_t *attr, /* I - IPP attribute */
int element) /* I - Value number (0-based) */
{
/*
* Range check input...
*/
if (!attr || attr->value_tag != IPP_TAG_BEGIN_COLLECTION ||
element < 0 || element >= attr->num_values)
return (NULL);
/*
* Return the value...
*/
return (attr->values[element].collection);
}
/*
* 'ippGetCount()' - Get the number of values in an attribute.
*
* @since CUPS 1.6/macOS 10.8@
*/
int /* O - Number of values or 0 on error */
ippGetCount(ipp_attribute_t *attr) /* I - IPP attribute */
{
/*
* Range check input...
*/
if (!attr)
return (0);
/*
* Return the number of values...
*/
return (attr->num_values);
}
/*
* 'ippGetDate()' - Get a date value for an attribute.
*
* The @code element@ parameter specifies which value to get from 0 to
* @link ippGetCount(attr)@ - 1.
*
* @since CUPS 1.6/macOS 10.8@
*/
const ipp_uchar_t * /* O - Date value or @code NULL@ */
ippGetDate(ipp_attribute_t *attr, /* I - IPP attribute */
int element) /* I - Value number (0-based) */
{
/*
* Range check input...
*/
if (!attr || attr->value_tag != IPP_TAG_DATE ||
element < 0 || element >= attr->num_values)
return (NULL);
/*
* Return the value...
*/
return (attr->values[element].date);
}
/*
* 'ippGetGroupTag()' - Get the group associated with an attribute.
*
* @since CUPS 1.6/macOS 10.8@
*/
ipp_tag_t /* O - Group tag or @code IPP_TAG_ZERO@ on error */
ippGetGroupTag(ipp_attribute_t *attr) /* I - IPP attribute */
{
/*
* Range check input...
*/
if (!attr)
return (IPP_TAG_ZERO);
/*
* Return the group...
*/
return (attr->group_tag);
}
/*
* 'ippGetInteger()' - Get the integer/enum value for an attribute.
*
* The @code element@ parameter specifies which value to get from 0 to
* @link ippGetCount(attr)@ - 1.
*
* @since CUPS 1.6/macOS 10.8@
*/
int /* O - Value or 0 on error */
ippGetInteger(ipp_attribute_t *attr, /* I - IPP attribute */
int element) /* I - Value number (0-based) */
{
/*
* Range check input...
*/
if (!attr || (attr->value_tag != IPP_TAG_INTEGER && attr->value_tag != IPP_TAG_ENUM) ||
element < 0 || element >= attr->num_values)
return (0);
/*
* Return the value...
*/
return (attr->values[element].integer);
}
/*
* 'ippGetName()' - Get the attribute name.
*
* @since CUPS 1.6/macOS 10.8@
*/
const char * /* O - Attribute name or @code NULL@ for separators */
ippGetName(ipp_attribute_t *attr) /* I - IPP attribute */
{
/*
* Range check input...
*/
if (!attr)
return (NULL);
/*
* Return the name...
*/
return (attr->name);
}
/*
* 'ippGetOctetString()' - Get an octetString value from an IPP attribute.
*
* The @code element@ parameter specifies which value to get from 0 to
* @link ippGetCount(attr)@ - 1.
*
* @since CUPS 1.7/macOS 10.9@
*/
void * /* O - Pointer to octetString data */
ippGetOctetString(
ipp_attribute_t *attr, /* I - IPP attribute */
int element, /* I - Value number (0-based) */
int *datalen) /* O - Length of octetString data */
{
/*
* Range check input...
*/
if (!attr || attr->value_tag != IPP_TAG_STRING ||
element < 0 || element >= attr->num_values)
{
if (datalen)
*datalen = 0;
return (NULL);
}
/*
* Return the values...
*/
if (datalen)
*datalen = attr->values[element].unknown.length;
return (attr->values[element].unknown.data);
}
/*
* 'ippGetOperation()' - Get the operation ID in an IPP message.
*
* @since CUPS 1.6/macOS 10.8@
*/
ipp_op_t /* O - Operation ID or 0 on error */
ippGetOperation(ipp_t *ipp) /* I - IPP request message */
{
/*
* Range check input...
*/
if (!ipp)
return ((ipp_op_t)0);
/*
* Return the value...
*/
return (ipp->request.op.operation_id);
}
/*
* 'ippGetRange()' - Get a rangeOfInteger value from an attribute.
*
* The @code element@ parameter specifies which value to get from 0 to
* @link ippGetCount(attr)@ - 1.
*
* @since CUPS 1.6/macOS 10.8@
*/
int /* O - Lower value of range or 0 */
ippGetRange(ipp_attribute_t *attr, /* I - IPP attribute */
int element, /* I - Value number (0-based) */
int *uppervalue)/* O - Upper value of range */
{
/*
* Range check input...
*/
if (!attr || attr->value_tag != IPP_TAG_RANGE ||
element < 0 || element >= attr->num_values)
{
if (uppervalue)
*uppervalue = 0;
return (0);
}
/*
* Return the values...
*/
if (uppervalue)
*uppervalue = attr->values[element].range.upper;
return (attr->values[element].range.lower);
}
/*
* 'ippGetRequestId()' - Get the request ID from an IPP message.
*
* @since CUPS 1.6/macOS 10.8@
*/
int /* O - Request ID or 0 on error */
ippGetRequestId(ipp_t *ipp) /* I - IPP message */
{
/*
* Range check input...
*/
if (!ipp)
return (0);
/*
* Return the request ID...
*/
return (ipp->request.any.request_id);
}
/*
* 'ippGetResolution()' - Get a resolution value for an attribute.
*
* The @code element@ parameter specifies which value to get from 0 to
* @link ippGetCount(attr)@ - 1.
*
* @since CUPS 1.6/macOS 10.8@
*/
int /* O - Horizontal/cross feed resolution or 0 */
ippGetResolution(
ipp_attribute_t *attr, /* I - IPP attribute */
int element, /* I - Value number (0-based) */
int *yres, /* O - Vertical/feed resolution */
ipp_res_t *units) /* O - Units for resolution */
{
/*
* Range check input...
*/
if (!attr || attr->value_tag != IPP_TAG_RESOLUTION ||
element < 0 || element >= attr->num_values)
{
if (yres)
*yres = 0;
if (units)
*units = (ipp_res_t)0;
return (0);
}
/*
* Return the value...
*/
if (yres)
*yres = attr->values[element].resolution.yres;
if (units)
*units = attr->values[element].resolution.units;
return (attr->values[element].resolution.xres);
}
/*
* 'ippGetState()' - Get the IPP message state.
*
* @since CUPS 1.6/macOS 10.8@
*/
ipp_state_t /* O - IPP message state value */
ippGetState(ipp_t *ipp) /* I - IPP message */
{
/*
* Range check input...
*/
if (!ipp)
return (IPP_STATE_IDLE);
/*
* Return the value...
*/
return (ipp->state);
}
/*
* 'ippGetStatusCode()' - Get the status code from an IPP response or event message.
*
* @since CUPS 1.6/macOS 10.8@
*/
ipp_status_t /* O - Status code in IPP message */
ippGetStatusCode(ipp_t *ipp) /* I - IPP response or event message */
{
/*
* Range check input...
*/
if (!ipp)
return (IPP_STATUS_ERROR_INTERNAL);
/*
* Return the value...
*/
return (ipp->request.status.status_code);
}
/*
* 'ippGetString()' - Get the string and optionally the language code for an attribute.
*
* The @code element@ parameter specifies which value to get from 0 to
* @link ippGetCount(attr)@ - 1.
*
* @since CUPS 1.6/macOS 10.8@
*/
const char *
ippGetString(ipp_attribute_t *attr, /* I - IPP attribute */
int element, /* I - Value number (0-based) */
const char **language)/* O - Language code (@code NULL@ for don't care) */
{
ipp_tag_t tag; /* Value tag */
/*
* Range check input...
*/
tag = ippGetValueTag(attr);
if (!attr || element < 0 || element >= attr->num_values || (tag != IPP_TAG_TEXTLANG && tag != IPP_TAG_NAMELANG && (tag < IPP_TAG_TEXT || tag > IPP_TAG_MIMETYPE)))
return (NULL);
/*
* Return the value...
*/
if (language)
*language = attr->values[element].string.language;
return (attr->values[element].string.text);
}
/*
* 'ippGetValueTag()' - Get the value tag for an attribute.
*
* @since CUPS 1.6/macOS 10.8@
*/
ipp_tag_t /* O - Value tag or @code IPP_TAG_ZERO@ on error */
ippGetValueTag(ipp_attribute_t *attr) /* I - IPP attribute */
{
/*
* Range check input...
*/
if (!attr)
return (IPP_TAG_ZERO);
/*
* Return the value...
*/
return (attr->value_tag & IPP_TAG_CUPS_MASK);
}
/*
* 'ippGetVersion()' - Get the major and minor version number from an IPP message.
*
* @since CUPS 1.6/macOS 10.8@
*/
int /* O - Major version number or 0 on error */
ippGetVersion(ipp_t *ipp, /* I - IPP message */
int *minor) /* O - Minor version number or @code NULL@ */
{
/*
* Range check input...
*/
if (!ipp)
{
if (minor)
*minor = 0;
return (0);
}
/*
* Return the value...
*/
if (minor)
*minor = ipp->request.any.version[1];
return (ipp->request.any.version[0]);
}
/*
* 'ippLength()' - Compute the length of an IPP message.
*/
size_t /* O - Size of IPP message */
ippLength(ipp_t *ipp) /* I - IPP message */
{
return (ipp_length(ipp, 0));
}
/*
* 'ippNextAttribute()' - Return the next attribute in the message.
*
* @since CUPS 1.6/macOS 10.8@
*/
ipp_attribute_t * /* O - Next attribute or @code NULL@ if none */
ippNextAttribute(ipp_t *ipp) /* I - IPP message */
{
/*
* Range check input...
*/
if (!ipp || !ipp->current)
return (NULL);
/*
* Return the next attribute...
*/
return (ipp->current = ipp->current->next);
}
/*
* 'ippNew()' - Allocate a new IPP message.
*/
ipp_t * /* O - New IPP message */
ippNew(void)
{
ipp_t *temp; /* New IPP message */
_cups_globals_t *cg = _cupsGlobals();
/* Global data */
DEBUG_puts("ippNew()");
if ((temp = (ipp_t *)calloc(1, sizeof(ipp_t))) != NULL)
{
/*
* Set default version - usually 2.0...
*/
if (cg->server_version == 0)
_cupsSetDefaults();
temp->request.any.version[0] = (ipp_uchar_t)(cg->server_version / 10);
temp->request.any.version[1] = (ipp_uchar_t)(cg->server_version % 10);
temp->use = 1;
}
DEBUG_printf(("1ippNew: Returning %p", (void *)temp));
return (temp);
}
/*
* 'ippNewRequest()' - Allocate a new IPP request message.
*
* The new request message is initialized with the attributes-charset and
* attributes-natural-language attributes added. The
* attributes-natural-language value is derived from the current locale.
*
* @since CUPS 1.2/macOS 10.5@
*/
ipp_t * /* O - IPP request message */
ippNewRequest(ipp_op_t op) /* I - Operation code */
{
ipp_t *request; /* IPP request message */
cups_lang_t *language; /* Current language localization */
static int request_id = 0; /* Current request ID */
static _cups_mutex_t request_mutex = _CUPS_MUTEX_INITIALIZER;
/* Mutex for request ID */
DEBUG_printf(("ippNewRequest(op=%02x(%s))", op, ippOpString(op)));
/*
* Create a new IPP message...
*/
if ((request = ippNew()) == NULL)
return (NULL);
/*
* Set the operation and request ID...
*/
_cupsMutexLock(&request_mutex);
request->request.op.operation_id = op;
request->request.op.request_id = ++request_id;
_cupsMutexUnlock(&request_mutex);
/*
* Use UTF-8 as the character set...
*/
ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_CHARSET,
"attributes-charset", NULL, "utf-8");
/*
* Get the language from the current locale...
*/
language = cupsLangDefault();
ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_LANGUAGE,
"attributes-natural-language", NULL, language->language);
/*
* Return the new request...
*/
return (request);
}
/*
* 'ippNewResponse()' - Allocate a new IPP response message.
*
* The new response message is initialized with the same version-number,
* request-id, attributes-charset, and attributes-natural-language as the
* provided request message. If the attributes-charset or
* attributes-natural-language attributes are missing from the request,
* "utf-8" and a value derived from the current locale are substituted,
* respectively.
*
* @since CUPS 1.7/macOS 10.9@
*/
ipp_t * /* O - IPP response message */
ippNewResponse(ipp_t *request) /* I - IPP request message */
{
ipp_t *response; /* IPP response message */
ipp_attribute_t *attr; /* Current attribute */
/*
* Range check input...
*/
if (!request)
return (NULL);
/*
* Create a new IPP message...
*/
if ((response = ippNew()) == NULL)
return (NULL);
/*
* Copy the request values over to the response...
*/
response->request.status.version[0] = request->request.op.version[0];
response->request.status.version[1] = request->request.op.version[1];
response->request.status.request_id = request->request.op.request_id;
/*
* The first attribute MUST be attributes-charset...
*/
attr = request->attrs;
if (attr && attr->name && !strcmp(attr->name, "attributes-charset") &&
attr->group_tag == IPP_TAG_OPERATION &&
attr->value_tag == IPP_TAG_CHARSET &&
attr->num_values == 1)
{
/*
* Copy charset from request...
*/
ippAddString(response, IPP_TAG_OPERATION, IPP_TAG_CHARSET,
"attributes-charset", NULL, attr->values[0].string.text);
}
else
{
/*
* Use "utf-8" as the default...
*/
ippAddString(response, IPP_TAG_OPERATION, IPP_TAG_CHARSET,
"attributes-charset", NULL, "utf-8");
}
/*
* Then attributes-natural-language...
*/
if (attr)
attr = attr->next;
if (attr && attr->name &&
!strcmp(attr->name, "attributes-natural-language") &&
attr->group_tag == IPP_TAG_OPERATION &&
attr->value_tag == IPP_TAG_LANGUAGE &&
attr->num_values == 1)
{
/*
* Copy language from request...
*/
ippAddString(response, IPP_TAG_OPERATION, IPP_TAG_LANGUAGE,
"attributes-natural-language", NULL,
attr->values[0].string.text);
}
else
{
/*
* Use the language from the current locale...
*/
cups_lang_t *language = cupsLangDefault();
/* Current locale */
ippAddString(response, IPP_TAG_OPERATION, IPP_TAG_LANGUAGE,
"attributes-natural-language", NULL, language->language);
}
return (response);
}
/*
* 'ippRead()' - Read data for an IPP message from a HTTP connection.
*/
ipp_state_t /* O - Current state */
ippRead(http_t *http, /* I - HTTP connection */
ipp_t *ipp) /* I - IPP data */
{
DEBUG_printf(("ippRead(http=%p, ipp=%p), data_remaining=" CUPS_LLFMT, (void *)http, (void *)ipp, CUPS_LLCAST (http ? http->data_remaining : -1)));
if (!http)
return (IPP_STATE_ERROR);
DEBUG_printf(("2ippRead: http->state=%d, http->used=%d", http->state, http->used));
return (ippReadIO(http, (ipp_iocb_t)ipp_read_http, http->blocking, NULL,
ipp));
}
/*
* 'ippReadFile()' - Read data for an IPP message from a file.
*
* @since CUPS 1.1.19/macOS 10.3@
*/
ipp_state_t /* O - Current state */
ippReadFile(int fd, /* I - HTTP data */
ipp_t *ipp) /* I - IPP data */
{
DEBUG_printf(("ippReadFile(fd=%d, ipp=%p)", fd, (void *)ipp));
return (ippReadIO(&fd, (ipp_iocb_t)ipp_read_file, 1, NULL, ipp));
}
/*
* 'ippReadIO()' - Read data for an IPP message.
*
* @since CUPS 1.2/macOS 10.5@
*/
ipp_state_t /* O - Current state */
ippReadIO(void *src, /* I - Data source */
ipp_iocb_t cb, /* I - Read callback function */
int blocking, /* I - Use blocking IO? */
ipp_t *parent, /* I - Parent request, if any */
ipp_t *ipp) /* I - IPP data */
{
int n; /* Length of data */
unsigned char *buffer, /* Data buffer */
string[IPP_MAX_TEXT],
/* Small string buffer */
*bufptr; /* Pointer into buffer */
ipp_attribute_t *attr; /* Current attribute */
ipp_tag_t tag; /* Current tag */
ipp_tag_t value_tag; /* Current value tag */
_ipp_value_t *value; /* Current value */
DEBUG_printf(("ippReadIO(src=%p, cb=%p, blocking=%d, parent=%p, ipp=%p)", (void *)src, (void *)cb, blocking, (void *)parent, (void *)ipp));
DEBUG_printf(("2ippReadIO: ipp->state=%d", ipp ? ipp->state : IPP_STATE_ERROR));
if (!src || !ipp)
return (IPP_STATE_ERROR);
if ((buffer = (unsigned char *)_cupsBufferGet(IPP_BUF_SIZE)) == NULL)
{
DEBUG_puts("1ippReadIO: Unable to get read buffer.");
return (IPP_STATE_ERROR);
}
switch (ipp->state)
{
case IPP_STATE_IDLE :
ipp->state ++; /* Avoid common problem... */
case IPP_STATE_HEADER :
if (parent == NULL)
{
/*
* Get the request header...
*/
if ((*cb)(src, buffer, 8) < 8)
{
DEBUG_puts("1ippReadIO: Unable to read header.");
_cupsBufferRelease((char *)buffer);
return (IPP_STATE_ERROR);
}
/*
* Then copy the request header over...
*/
ipp->request.any.version[0] = buffer[0];
ipp->request.any.version[1] = buffer[1];
ipp->request.any.op_status = (buffer[2] << 8) | buffer[3];
ipp->request.any.request_id = (((((buffer[4] << 8) | buffer[5]) << 8) |
buffer[6]) << 8) | buffer[7];
DEBUG_printf(("2ippReadIO: version=%d.%d", buffer[0], buffer[1]));
DEBUG_printf(("2ippReadIO: op_status=%04x",
ipp->request.any.op_status));
DEBUG_printf(("2ippReadIO: request_id=%d",
ipp->request.any.request_id));
}
ipp->state = IPP_STATE_ATTRIBUTE;
ipp->current = NULL;
ipp->curtag = IPP_TAG_ZERO;
ipp->prev = ipp->last;
/*
* If blocking is disabled, stop here...
*/
if (!blocking)
break;
case IPP_STATE_ATTRIBUTE :
for (;;)
{
if ((*cb)(src, buffer, 1) < 1)
{
DEBUG_puts("1ippReadIO: Callback returned EOF/error");
_cupsBufferRelease((char *)buffer);
return (IPP_STATE_ERROR);
}
DEBUG_printf(("2ippReadIO: ipp->current=%p, ipp->prev=%p", (void *)ipp->current, (void *)ipp->prev));
/*
* Read this attribute...
*/
tag = (ipp_tag_t)buffer[0];
if (tag == IPP_TAG_EXTENSION)
{
/*
* Read 32-bit "extension" tag...
*/
if ((*cb)(src, buffer, 4) < 1)
{
DEBUG_puts("1ippReadIO: Callback returned EOF/error");
_cupsBufferRelease((char *)buffer);
return (IPP_STATE_ERROR);
}
tag = (ipp_tag_t)((((((buffer[0] << 8) | buffer[1]) << 8) |
buffer[2]) << 8) | buffer[3]);
if (tag & IPP_TAG_CUPS_CONST)
{
/*
* Fail if the high bit is set in the tag...
*/
_cupsSetError(IPP_STATUS_ERROR_INTERNAL, _("IPP extension tag larger than 0x7FFFFFFF."), 1);
DEBUG_printf(("1ippReadIO: bad tag 0x%x.", tag));
_cupsBufferRelease((char *)buffer);
return (IPP_STATE_ERROR);
}
}
if (tag == IPP_TAG_END)
{
/*
* No more attributes left...
*/
DEBUG_puts("2ippReadIO: IPP_TAG_END.");
ipp->state = IPP_STATE_DATA;
break;
}
else if (tag < IPP_TAG_UNSUPPORTED_VALUE)
{
/*
* Group tag... Set the current group and continue...
*/
if (ipp->curtag == tag)
ipp->prev = ippAddSeparator(ipp);
else if (ipp->current)
ipp->prev = ipp->current;
ipp->curtag = tag;
ipp->current = NULL;
DEBUG_printf(("2ippReadIO: group tag=%x(%s), ipp->prev=%p", tag, ippTagString(tag), (void *)ipp->prev));
continue;
}
DEBUG_printf(("2ippReadIO: value tag=%x(%s)", tag,
ippTagString(tag)));
/*
* Get the name...
*/
if ((*cb)(src, buffer, 2) < 2)
{
DEBUG_puts("1ippReadIO: unable to read name length.");
_cupsBufferRelease((char *)buffer);
return (IPP_STATE_ERROR);
}
n = (buffer[0] << 8) | buffer[1];
if (n >= IPP_BUF_SIZE)
{
_cupsSetError(IPP_STATUS_ERROR_INTERNAL, _("IPP name larger than 32767 bytes."), 1);
DEBUG_printf(("1ippReadIO: bad name length %d.", n));
_cupsBufferRelease((char *)buffer);
return (IPP_STATE_ERROR);
}
DEBUG_printf(("2ippReadIO: name length=%d", n));
if (n == 0 && tag != IPP_TAG_MEMBERNAME &&
tag != IPP_TAG_END_COLLECTION)
{
/*
* More values for current attribute...
*/
if (ipp->current == NULL)
{
_cupsSetError(IPP_STATUS_ERROR_INTERNAL, _("IPP attribute has no name."), 1);
DEBUG_puts("1ippReadIO: Attribute without name and no current.");
_cupsBufferRelease((char *)buffer);
return (IPP_STATE_ERROR);
}
attr = ipp->current;
value_tag = (ipp_tag_t)(attr->value_tag & IPP_TAG_CUPS_MASK);
/*
* Make sure we aren't adding a new value of a different
* type...
*/
if (value_tag == IPP_TAG_ZERO)
{
/*
* Setting the value of a collection member...
*/
attr->value_tag = tag;
}
else if (value_tag == IPP_TAG_TEXTLANG ||
value_tag == IPP_TAG_NAMELANG ||
(value_tag >= IPP_TAG_TEXT &&
value_tag <= IPP_TAG_MIMETYPE))
{
/*
* String values can sometimes come across in different
* forms; accept sets of differing values...
*/
if (tag != IPP_TAG_TEXTLANG && tag != IPP_TAG_NAMELANG &&
(tag < IPP_TAG_TEXT || tag > IPP_TAG_MIMETYPE) &&
tag != IPP_TAG_NOVALUE)
{
_cupsSetError(IPP_STATUS_ERROR_INTERNAL,
_("IPP 1setOf attribute with incompatible value "
"tags."), 1);
DEBUG_printf(("1ippReadIO: 1setOf value tag %x(%s) != %x(%s)",
value_tag, ippTagString(value_tag), tag,
ippTagString(tag)));
_cupsBufferRelease((char *)buffer);
return (IPP_STATE_ERROR);
}
if (value_tag != tag)
{
DEBUG_printf(("1ippReadIO: Converting %s attribute from %s to %s.",
attr->name, ippTagString(value_tag), ippTagString(tag)));
ippSetValueTag(ipp, &attr, tag);
}
}
else if (value_tag == IPP_TAG_INTEGER ||
value_tag == IPP_TAG_RANGE)
{
/*
* Integer and rangeOfInteger values can sometimes be mixed; accept
* sets of differing values...
*/
if (tag != IPP_TAG_INTEGER && tag != IPP_TAG_RANGE)
{
_cupsSetError(IPP_STATUS_ERROR_INTERNAL,
_("IPP 1setOf attribute with incompatible value "
"tags."), 1);
DEBUG_printf(("1ippReadIO: 1setOf value tag %x(%s) != %x(%s)",
value_tag, ippTagString(value_tag), tag,
ippTagString(tag)));
_cupsBufferRelease((char *)buffer);
return (IPP_STATE_ERROR);
}
if (value_tag == IPP_TAG_INTEGER && tag == IPP_TAG_RANGE)
{
/*
* Convert integer values to rangeOfInteger values...
*/
DEBUG_printf(("1ippReadIO: Converting %s attribute to "
"rangeOfInteger.", attr->name));
ippSetValueTag(ipp, &attr, IPP_TAG_RANGE);
}
}
else if (value_tag != tag)
{
_cupsSetError(IPP_STATUS_ERROR_INTERNAL,
_("IPP 1setOf attribute with incompatible value "
"tags."), 1);
DEBUG_printf(("1ippReadIO: value tag %x(%s) != %x(%s)",
value_tag, ippTagString(value_tag), tag,
ippTagString(tag)));
_cupsBufferRelease((char *)buffer);
return (IPP_STATE_ERROR);
}
/*
* Finally, reallocate the attribute array as needed...
*/
if ((value = ipp_set_value(ipp, &attr, attr->num_values)) == NULL)
{
_cupsBufferRelease((char *)buffer);
return (IPP_STATE_ERROR);
}
}
else if (tag == IPP_TAG_MEMBERNAME)
{
/*
* Name must be length 0!
*/
if (n)
{
_cupsSetError(IPP_STATUS_ERROR_INTERNAL, _("IPP member name is not empty."), 1);
DEBUG_puts("1ippReadIO: member name not empty.");
_cupsBufferRelease((char *)buffer);
return (IPP_STATE_ERROR);
}
if (ipp->current)
ipp->prev = ipp->current;
attr = ipp->current = ipp_add_attr(ipp, NULL, ipp->curtag, IPP_TAG_ZERO, 1);
if (!attr)
{
_cupsSetHTTPError(HTTP_STATUS_ERROR);
DEBUG_puts("1ippReadIO: unable to allocate attribute.");
_cupsBufferRelease((char *)buffer);
return (IPP_STATE_ERROR);
}
DEBUG_printf(("2ippReadIO: membername, ipp->current=%p, ipp->prev=%p", (void *)ipp->current, (void *)ipp->prev));
value = attr->values;
}
else if (tag != IPP_TAG_END_COLLECTION)
{
/*
* New attribute; read the name and add it...
*/
if ((*cb)(src, buffer, (size_t)n) < n)
{
DEBUG_puts("1ippReadIO: unable to read name.");
_cupsBufferRelease((char *)buffer);
return (IPP_STATE_ERROR);
}
buffer[n] = '\0';
if (ipp->current)
ipp->prev = ipp->current;
if ((attr = ipp->current = ipp_add_attr(ipp, (char *)buffer, ipp->curtag, tag,
1)) == NULL)
{
_cupsSetHTTPError(HTTP_STATUS_ERROR);
DEBUG_puts("1ippReadIO: unable to allocate attribute.");
_cupsBufferRelease((char *)buffer);
return (IPP_STATE_ERROR);
}
DEBUG_printf(("2ippReadIO: name=\"%s\", ipp->current=%p, ipp->prev=%p", buffer, (void *)ipp->current, (void *)ipp->prev));
value = attr->values;
}
else
{
attr = NULL;
value = NULL;
}
if ((*cb)(src, buffer, 2) < 2)
{
DEBUG_puts("1ippReadIO: unable to read value length.");
_cupsBufferRelease((char *)buffer);
return (IPP_STATE_ERROR);
}
n = (buffer[0] << 8) | buffer[1];
DEBUG_printf(("2ippReadIO: value length=%d", n