cups/encode.c

   1 /*
   2  * "$Id$"
   3  *
   4  * Option encoding routines for CUPS.
   5  *
   6  * Copyright 2007-2014 by Apple Inc.
   7  * Copyright 1997-2007 by Easy Software Products.
   8  *
   9  * These coded instructions, statements, and computer programs are the
  10  * property of Apple Inc. and are protected by Federal copyright
  11  * law.  Distribution and use rights are outlined in the file "LICENSE.txt"
  12  * which should have been included with this file.  If this file is
  13  * file is missing or damaged, see the license at "http://www.cups.org/".
  14  *
  15  * This file is subject to the Apple OS-Developed Software exception.
  16  */
  17
  18 /*
  19  * Include necessary headers...
  20  */
  21
  22 #include "cups-private.h"
  23
  24
  25 /*
  26  * Local list of option names, the value tags they should use, and the list of
  27  * supported operations...
  28  *
  29  * **** THIS LIST MUST BE SORTED BY ATTRIBUTE NAME ****
  30  */
  31
  32 static const ipp_op_t ipp_job_creation[] =
  33 {
  34   IPP_OP_PRINT_JOB,
  35   IPP_OP_PRINT_URI,
  36   IPP_OP_CREATE_JOB,
  37   IPP_OP_CUPS_NONE
  38 };
  39
  40 static const ipp_op_t ipp_doc_creation[] =
  41 {
  42   IPP_OP_PRINT_JOB,
  43   IPP_OP_PRINT_URI,
  44   IPP_OP_SEND_DOCUMENT,
  45   IPP_OP_SEND_URI,
  46   IPP_OP_CUPS_NONE
  47 };
  48
  49 static const ipp_op_t ipp_sub_creation[] =
  50 {
  51   IPP_OP_PRINT_JOB,
  52   IPP_OP_PRINT_URI,
  53   IPP_OP_CREATE_JOB,
  54   IPP_OP_CREATE_PRINTER_SUBSCRIPTION,
  55   IPP_OP_CREATE_JOB_SUBSCRIPTION,
  56   IPP_OP_CUPS_NONE
  57 };
  58
  59 static const ipp_op_t ipp_all_print[] =
  60 {
  61   IPP_OP_PRINT_JOB,
  62   IPP_OP_PRINT_URI,
  63   IPP_OP_CREATE_JOB,
  64   IPP_OP_SEND_DOCUMENT,
  65   IPP_OP_SEND_URI,
  66   IPP_OP_CUPS_NONE
  67 };
  68
  69 static const ipp_op_t ipp_all_limit[] =
  70 {
  71   IPP_OP_GET_JOBS,
  72   IPP_OP_GET_PRINTER_ATTRIBUTES,
  73   IPP_OP_CUPS_GET_PRINTERS,
  74   IPP_OP_CUPS_GET_CLASSES,
  75   IPP_OP_CUPS_GET_DEVICES,
  76   IPP_OP_CUPS_GET_PPDS,
  77   IPP_OP_CUPS_NONE
  78 };
  79
  80 static const ipp_op_t ipp_set_printer[] =
  81 {
  82   IPP_OP_SET_PRINTER_ATTRIBUTES,
  83   IPP_OP_CUPS_ADD_MODIFY_PRINTER,
  84   IPP_OP_CUPS_ADD_MODIFY_CLASS,
  85   IPP_OP_CUPS_NONE
  86 };
  87
  88 static const ipp_op_t cups_am_class[] =
  89 {
  90   IPP_OP_CUPS_ADD_MODIFY_CLASS,
  91   IPP_OP_CUPS_NONE
  92 };
  93
  94 static const ipp_op_t cups_am_printer[] =
  95 {
  96   IPP_OP_CUPS_ADD_MODIFY_PRINTER,
  97   IPP_OP_CUPS_NONE
  98 };
  99
 100 static const ipp_op_t cups_schemes[] =
 101 {
 102   IPP_OP_CUPS_GET_DEVICES,
 103   IPP_OP_CUPS_GET_PPDS,
 104   IPP_OP_CUPS_NONE
 105 };
 106
 107 static const ipp_op_t cups_get_ppds[] =
 108 {
 109   IPP_OP_CUPS_GET_PPDS,
 110   IPP_OP_CUPS_NONE
 111 };
 112
 113 static const ipp_op_t cups_ppd_name[] =
 114 {
 115   IPP_OP_CUPS_ADD_MODIFY_PRINTER,
 116   IPP_OP_CUPS_GET_PPD,
 117   IPP_OP_CUPS_NONE
 118 };
 119
 120 static const _ipp_option_t ipp_options[] =
 121 {
 122   { 1, "auth-info",             IPP_TAG_TEXT,           IPP_TAG_JOB },
 123   { 1, "auth-info-default",     IPP_TAG_TEXT,           IPP_TAG_PRINTER },
 124   { 1, "auth-info-required",    IPP_TAG_KEYWORD,        IPP_TAG_PRINTER },
 125   { 0, "blackplot",             IPP_TAG_BOOLEAN,        IPP_TAG_JOB },
 126   { 0, "blackplot-default",     IPP_TAG_BOOLEAN,        IPP_TAG_PRINTER },
 127   { 0, "brightness",            IPP_TAG_INTEGER,        IPP_TAG_JOB },
 128   { 0, "brightness-default",    IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
 129   { 0, "columns",               IPP_TAG_INTEGER,        IPP_TAG_JOB },
 130   { 0, "columns-default",       IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
 131   { 0, "compression",           IPP_TAG_KEYWORD,        IPP_TAG_OPERATION,
 132                                                         IPP_TAG_ZERO,
 133                                                         ipp_doc_creation },
 134   { 0, "copies",                IPP_TAG_INTEGER,        IPP_TAG_JOB,
 135                                                         IPP_TAG_DOCUMENT },
 136   { 0, "copies-default",        IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
 137   { 0, "device-uri",            IPP_TAG_URI,            IPP_TAG_PRINTER },
 138   { 1, "document-copies",       IPP_TAG_RANGE,          IPP_TAG_JOB,
 139                                                         IPP_TAG_DOCUMENT,
 140                                                         ipp_doc_creation },
 141   { 0, "document-format",       IPP_TAG_MIMETYPE,       IPP_TAG_OPERATION,
 142                                                         IPP_TAG_ZERO,
 143                                                         ipp_doc_creation },
 144   { 0, "document-format-default", IPP_TAG_MIMETYPE,     IPP_TAG_PRINTER },
 145   { 1, "document-numbers",      IPP_TAG_RANGE,          IPP_TAG_JOB,
 146                                                         IPP_TAG_DOCUMENT,
 147                                                         ipp_all_print },
 148   { 1, "exclude-schemes",       IPP_TAG_NAME,           IPP_TAG_OPERATION,
 149                                                         IPP_TAG_ZERO,
 150                                                         cups_schemes },
 151   { 1, "finishings",            IPP_TAG_ENUM,           IPP_TAG_JOB,
 152                                                         IPP_TAG_DOCUMENT },
 153   { 1, "finishings-default",    IPP_TAG_ENUM,           IPP_TAG_PRINTER },
 154   { 0, "fit-to-page",           IPP_TAG_BOOLEAN,        IPP_TAG_JOB,
 155                                                         IPP_TAG_DOCUMENT },
 156   { 0, "fit-to-page-default",   IPP_TAG_BOOLEAN,        IPP_TAG_PRINTER },
 157   { 0, "fitplot",               IPP_TAG_BOOLEAN,        IPP_TAG_JOB },
 158   { 0, "fitplot-default",       IPP_TAG_BOOLEAN,        IPP_TAG_PRINTER },
 159   { 0, "gamma",                 IPP_TAG_INTEGER,        IPP_TAG_JOB },
 160   { 0, "gamma-default",         IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
 161   { 0, "hue",                   IPP_TAG_INTEGER,        IPP_TAG_JOB },
 162   { 0, "hue-default",           IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
 163   { 1, "include-schemes",       IPP_TAG_NAME,           IPP_TAG_OPERATION,
 164                                                         IPP_TAG_ZERO,
 165                                                         cups_schemes },
 166   { 0, "job-account-id",        IPP_TAG_NAME,           IPP_TAG_JOB },
 167   { 0, "job-account-id-default",IPP_TAG_NAME,           IPP_TAG_PRINTER },
 168   { 0, "job-accounting-user-id", IPP_TAG_NAME,          IPP_TAG_JOB },
 169   { 0, "job-accounting-user-id-default", IPP_TAG_NAME,  IPP_TAG_PRINTER },
 170   { 0, "job-authorization-uri", IPP_TAG_URI,            IPP_TAG_OPERATION },
 171   { 0, "job-cancel-after",      IPP_TAG_INTEGER,        IPP_TAG_JOB },
 172   { 0, "job-cancel-after-default", IPP_TAG_INTEGER,     IPP_TAG_PRINTER },
 173   { 0, "job-hold-until",        IPP_TAG_KEYWORD,        IPP_TAG_JOB },
 174   { 0, "job-id",                IPP_TAG_INTEGER,        IPP_TAG_ZERO }, /* never send as option */
 175   { 0, "job-impressions",       IPP_TAG_INTEGER,        IPP_TAG_ZERO }, /* never send as option */
 176   { 0, "job-impressions-completed", IPP_TAG_INTEGER,    IPP_TAG_ZERO }, /* never send as option */
 177   { 0, "job-k-limit",           IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
 178   { 0, "job-k-octets",          IPP_TAG_INTEGER,        IPP_TAG_ZERO }, /* never send as option */
 179   { 0, "job-k-octets-completed",IPP_TAG_INTEGER,        IPP_TAG_ZERO }, /* never send as option */
 180   { 0, "job-media-sheets",      IPP_TAG_INTEGER,        IPP_TAG_ZERO }, /* never send as option */
 181   { 0, "job-media-sheets-completed", IPP_TAG_INTEGER,   IPP_TAG_ZERO }, /* never send as option */
 182   { 0, "job-page-limit",        IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
 183   { 0, "job-password",          IPP_TAG_STRING,         IPP_TAG_OPERATION,
 184                                                         IPP_TAG_ZERO,
 185                                                         ipp_job_creation },
 186   { 0, "job-password-encryption", IPP_TAG_KEYWORD,      IPP_TAG_OPERATION,
 187                                                         IPP_TAG_ZERO,
 188                                                         ipp_job_creation },
 189   { 0, "job-priority",          IPP_TAG_INTEGER,        IPP_TAG_JOB },
 190   { 0, "job-quota-period",      IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
 191   { 1, "job-sheets",            IPP_TAG_NAME,           IPP_TAG_JOB },
 192   { 1, "job-sheets-default",    IPP_TAG_NAME,           IPP_TAG_PRINTER },
 193   { 0, "job-state",             IPP_TAG_ENUM,           IPP_TAG_ZERO }, /* never send as option */
 194   { 0, "job-state-message",     IPP_TAG_TEXT,           IPP_TAG_ZERO }, /* never send as option */
 195   { 0, "job-state-reasons",     IPP_TAG_KEYWORD,        IPP_TAG_ZERO }, /* never send as option */
 196   { 0, "job-uuid",              IPP_TAG_URI,            IPP_TAG_JOB },
 197   { 0, "landscape",             IPP_TAG_BOOLEAN,        IPP_TAG_JOB },
 198   { 1, "marker-change-time",    IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
 199   { 1, "marker-colors",         IPP_TAG_NAME,           IPP_TAG_PRINTER },
 200   { 1, "marker-high-levels",    IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
 201   { 1, "marker-levels",         IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
 202   { 1, "marker-low-levels",     IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
 203   { 0, "marker-message",        IPP_TAG_TEXT,           IPP_TAG_PRINTER },
 204   { 1, "marker-names",          IPP_TAG_NAME,           IPP_TAG_PRINTER },
 205   { 1, "marker-types",          IPP_TAG_KEYWORD,        IPP_TAG_PRINTER },
 206   { 1, "media",                 IPP_TAG_KEYWORD,        IPP_TAG_JOB,
 207                                                         IPP_TAG_DOCUMENT },
 208   { 0, "media-col",             IPP_TAG_BEGIN_COLLECTION, IPP_TAG_JOB,
 209                                                         IPP_TAG_DOCUMENT },
 210   { 0, "media-col-default",     IPP_TAG_BEGIN_COLLECTION, IPP_TAG_PRINTER },
 211   { 0, "media-color",           IPP_TAG_KEYWORD,        IPP_TAG_JOB,
 212                                                         IPP_TAG_DOCUMENT },
 213   { 1, "media-default",         IPP_TAG_KEYWORD,        IPP_TAG_PRINTER },
 214   { 0, "media-key",             IPP_TAG_KEYWORD,        IPP_TAG_JOB,
 215                                                         IPP_TAG_DOCUMENT },
 216   { 0, "media-size",            IPP_TAG_BEGIN_COLLECTION, IPP_TAG_JOB,
 217                                                         IPP_TAG_DOCUMENT },
 218   { 0, "media-type",            IPP_TAG_KEYWORD,        IPP_TAG_JOB,
 219                                                         IPP_TAG_DOCUMENT },
 220   { 0, "mirror",                IPP_TAG_BOOLEAN,        IPP_TAG_JOB },
 221   { 0, "mirror-default",        IPP_TAG_BOOLEAN,        IPP_TAG_PRINTER },
 222   { 0, "natural-scaling",       IPP_TAG_INTEGER,        IPP_TAG_JOB },
 223   { 0, "natural-scaling-default", IPP_TAG_INTEGER,      IPP_TAG_PRINTER },
 224   { 0, "notify-charset",        IPP_TAG_CHARSET,        IPP_TAG_SUBSCRIPTION },
 225   { 1, "notify-events",         IPP_TAG_KEYWORD,        IPP_TAG_SUBSCRIPTION },
 226   { 1, "notify-events-default", IPP_TAG_KEYWORD,        IPP_TAG_PRINTER },
 227   { 0, "notify-lease-duration", IPP_TAG_INTEGER,        IPP_TAG_SUBSCRIPTION },
 228   { 0, "notify-lease-duration-default", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
 229   { 0, "notify-natural-language", IPP_TAG_LANGUAGE,     IPP_TAG_SUBSCRIPTION },
 230   { 0, "notify-pull-method",    IPP_TAG_KEYWORD,        IPP_TAG_SUBSCRIPTION },
 231   { 0, "notify-recipient-uri",  IPP_TAG_URI,            IPP_TAG_SUBSCRIPTION },
 232   { 0, "notify-time-interval",  IPP_TAG_INTEGER,        IPP_TAG_SUBSCRIPTION },
 233   { 0, "notify-user-data",      IPP_TAG_STRING,         IPP_TAG_SUBSCRIPTION },
 234   { 0, "number-up",             IPP_TAG_INTEGER,        IPP_TAG_JOB,
 235                                                         IPP_TAG_DOCUMENT },
 236   { 0, "number-up-default",     IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
 237   { 0, "orientation-requested", IPP_TAG_ENUM,           IPP_TAG_JOB,
 238                                                         IPP_TAG_DOCUMENT },
 239   { 0, "orientation-requested-default", IPP_TAG_ENUM,   IPP_TAG_PRINTER },
 240   { 1, "overrides",             IPP_TAG_BEGIN_COLLECTION, IPP_TAG_JOB,
 241                                                         IPP_TAG_DOCUMENT },
 242   { 0, "page-bottom",           IPP_TAG_INTEGER,        IPP_TAG_JOB },
 243   { 0, "page-bottom-default",   IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
 244   { 0, "page-left",             IPP_TAG_INTEGER,        IPP_TAG_JOB },
 245   { 0, "page-left-default",     IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
 246   { 1, "page-ranges",           IPP_TAG_RANGE,          IPP_TAG_JOB,
 247                                                         IPP_TAG_DOCUMENT },
 248   { 1, "page-ranges-default",   IPP_TAG_RANGE,          IPP_TAG_PRINTER },
 249   { 0, "page-right",            IPP_TAG_INTEGER,        IPP_TAG_JOB },
 250   { 0, "page-right-default",    IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
 251   { 0, "page-top",              IPP_TAG_INTEGER,        IPP_TAG_JOB },
 252   { 0, "page-top-default",      IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
 253   { 1, "pages",                 IPP_TAG_RANGE,          IPP_TAG_JOB,
 254                                                         IPP_TAG_DOCUMENT },
 255   { 0, "penwidth",              IPP_TAG_INTEGER,        IPP_TAG_JOB },
 256   { 0, "penwidth-default",      IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
 257   { 0, "port-monitor",          IPP_TAG_NAME,           IPP_TAG_PRINTER },
 258   { 0, "ppd-device-id",         IPP_TAG_TEXT,           IPP_TAG_OPERATION,
 259                                                         IPP_TAG_ZERO,
 260                                                         cups_get_ppds },
 261   { 0, "ppd-make",              IPP_TAG_TEXT,           IPP_TAG_OPERATION,
 262                                                         IPP_TAG_ZERO,
 263                                                         cups_get_ppds },
 264   { 0, "ppd-make-and-model",    IPP_TAG_TEXT,           IPP_TAG_OPERATION,
 265                                                         IPP_TAG_ZERO,
 266                                                         cups_get_ppds },
 267   { 0, "ppd-model-number",      IPP_TAG_INTEGER,        IPP_TAG_OPERATION,
 268                                                         IPP_TAG_ZERO,
 269                                                         cups_get_ppds },
 270   { 0, "ppd-name",              IPP_TAG_NAME,           IPP_TAG_OPERATION,
 271                                                         IPP_TAG_ZERO,
 272                                                         cups_ppd_name },
 273   { 0, "ppd-natural-language",  IPP_TAG_LANGUAGE,       IPP_TAG_OPERATION,
 274                                                         IPP_TAG_ZERO,
 275                                                         cups_get_ppds },
 276   { 0, "ppd-product",           IPP_TAG_TEXT,           IPP_TAG_OPERATION,
 277                                                         IPP_TAG_ZERO,
 278                                                         cups_get_ppds },
 279   { 0, "ppd-psversion",         IPP_TAG_TEXT,           IPP_TAG_OPERATION,
 280                                                         IPP_TAG_ZERO,
 281                                                         cups_get_ppds },
 282   { 0, "ppd-type",              IPP_TAG_KEYWORD,        IPP_TAG_OPERATION,
 283                                                         IPP_TAG_ZERO,
 284                                                         cups_get_ppds },
 285   { 0, "ppi",                   IPP_TAG_INTEGER,        IPP_TAG_JOB },
 286   { 0, "ppi-default",           IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
 287   { 0, "prettyprint",           IPP_TAG_BOOLEAN,        IPP_TAG_JOB },
 288   { 0, "prettyprint-default",   IPP_TAG_BOOLEAN,        IPP_TAG_PRINTER },
 289   { 0, "print-quality",         IPP_TAG_ENUM,           IPP_TAG_JOB,
 290                                                         IPP_TAG_DOCUMENT },
 291   { 0, "print-quality-default", IPP_TAG_ENUM,           IPP_TAG_PRINTER },
 292   { 1, "printer-commands",      IPP_TAG_KEYWORD,        IPP_TAG_PRINTER },
 293   { 0, "printer-error-policy",  IPP_TAG_NAME,           IPP_TAG_PRINTER },
 294   { 0, "printer-info",          IPP_TAG_TEXT,           IPP_TAG_PRINTER },
 295   { 0, "printer-is-accepting-jobs", IPP_TAG_BOOLEAN,    IPP_TAG_PRINTER },
 296   { 0, "printer-is-shared",     IPP_TAG_BOOLEAN,        IPP_TAG_PRINTER },
 297   { 0, "printer-location",      IPP_TAG_TEXT,           IPP_TAG_PRINTER },
 298   { 0, "printer-make-and-model", IPP_TAG_TEXT,          IPP_TAG_PRINTER },
 299   { 0, "printer-more-info",     IPP_TAG_URI,            IPP_TAG_PRINTER },
 300   { 0, "printer-op-policy",     IPP_TAG_NAME,           IPP_TAG_PRINTER },
 301   { 0, "printer-resolution",    IPP_TAG_RESOLUTION,     IPP_TAG_JOB,
 302                                                         IPP_TAG_DOCUMENT },
 303   { 0, "printer-state",         IPP_TAG_ENUM,           IPP_TAG_PRINTER },
 304   { 0, "printer-state-change-time", IPP_TAG_INTEGER,    IPP_TAG_PRINTER },
 305   { 1, "printer-state-reasons", IPP_TAG_KEYWORD,        IPP_TAG_PRINTER },
 306   { 0, "printer-type",          IPP_TAG_ENUM,           IPP_TAG_PRINTER },
 307   { 0, "printer-uri",           IPP_TAG_URI,            IPP_TAG_OPERATION },
 308   { 1, "printer-uri-supported", IPP_TAG_URI,            IPP_TAG_PRINTER },
 309   { 0, "queued-job-count",      IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
 310   { 0, "raw",                   IPP_TAG_MIMETYPE,       IPP_TAG_OPERATION },
 311   { 1, "requested-attributes",  IPP_TAG_NAME,           IPP_TAG_OPERATION },
 312   { 1, "requesting-user-name-allowed", IPP_TAG_NAME,    IPP_TAG_PRINTER },
 313   { 1, "requesting-user-name-denied", IPP_TAG_NAME,     IPP_TAG_PRINTER },
 314   { 0, "resolution",            IPP_TAG_RESOLUTION,     IPP_TAG_JOB },
 315   { 0, "resolution-default",    IPP_TAG_RESOLUTION,     IPP_TAG_PRINTER },
 316   { 0, "saturation",            IPP_TAG_INTEGER,        IPP_TAG_JOB },
 317   { 0, "saturation-default",    IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
 318   { 0, "scaling",               IPP_TAG_INTEGER,        IPP_TAG_JOB },
 319   { 0, "scaling-default",       IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
 320   { 0, "sides",                 IPP_TAG_KEYWORD,        IPP_TAG_JOB,
 321                                                         IPP_TAG_DOCUMENT },
 322   { 0, "sides-default",         IPP_TAG_KEYWORD,        IPP_TAG_PRINTER },
 323   { 0, "time-at-completed",     IPP_TAG_INTEGER,        IPP_TAG_ZERO }, /* never send as option */
 324   { 0, "time-at-creation",      IPP_TAG_INTEGER,        IPP_TAG_ZERO }, /* never send as option */
 325   { 0, "time-at-processing",    IPP_TAG_INTEGER,        IPP_TAG_ZERO }, /* never send as option */
 326   { 0, "wrap",                  IPP_TAG_BOOLEAN,        IPP_TAG_JOB },
 327   { 0, "wrap-default",          IPP_TAG_BOOLEAN,        IPP_TAG_PRINTER },
 328   { 0, "x-dimension",           IPP_TAG_INTEGER,        IPP_TAG_JOB,
 329                                                         IPP_TAG_DOCUMENT },
 330   { 0, "y-dimension",           IPP_TAG_INTEGER,        IPP_TAG_JOB,
 331                                                         IPP_TAG_DOCUMENT }
 332 };
 333
 334
 335 /*
 336  * Local functions...
 337  */
 338
 339 static int      compare_ipp_options(_ipp_option_t *a, _ipp_option_t *b);
 340
 341
 342 /*
 343  * 'cupsEncodeOptions()' - Encode printer options into IPP attributes.
 344  *
 345  * This function adds operation, job, and then subscription attributes,
 346  * in that order. Use the cupsEncodeOptions2() function to add attributes
 347  * for a single group.
 348  */
 349
 350 void
 351 cupsEncodeOptions(ipp_t         *ipp,           /* I - Request to add to */
 352                   int           num_options,    /* I - Number of options */
 353                   cups_option_t *options)       /* I - Options */
 354 {
 355   DEBUG_printf(("cupsEncodeOptions(%p, %d, %p)", ipp, num_options, options));
 356
 357  /*
 358   * Add the options in the proper groups & order...
 359   */
 360
 361   cupsEncodeOptions2(ipp, num_options, options, IPP_TAG_OPERATION);
 362   cupsEncodeOptions2(ipp, num_options, options, IPP_TAG_JOB);
 363   cupsEncodeOptions2(ipp, num_options, options, IPP_TAG_SUBSCRIPTION);
 364 }
 365
 366
 367 /*
 368  * 'cupsEncodeOptions2()' - Encode printer options into IPP attributes for a group.
 369  *
 370  * This function only adds attributes for a single group. Call this
 371  * function multiple times for each group, or use cupsEncodeOptions()
 372  * to add the standard groups.
 373  *
 374  * @since CUPS 1.2/OS X 10.5@
 375  */
 376
 377 void
 378 cupsEncodeOptions2(
 379     ipp_t         *ipp,                 /* I - Request to add to */
 380     int           num_options,          /* I - Number of options */
 381     cups_option_t *options,             /* I - Options */
 382     ipp_tag_t     group_tag)            /* I - Group to encode */
 383 {
 384   int                   i, j;           /* Looping vars */
 385   int                   count;          /* Number of values */
 386   char                  *s,             /* Pointer into option value */
 387                         *val,           /* Pointer to option value */
 388                         *copy,          /* Copy of option value */
 389                         *sep,           /* Option separator */
 390                         quote;          /* Quote character */
 391   ipp_attribute_t       *attr;          /* IPP attribute */
 392   ipp_tag_t             value_tag;      /* IPP value tag */
 393   cups_option_t         *option;        /* Current option */
 394   ipp_t                 *collection;    /* Collection value */
 395   int                   num_cols;       /* Number of collection values */
 396   cups_option_t         *cols;          /* Collection values */
 397   ipp_op_t              op;             /* Operation for this request */
 398   const ipp_op_t        *ops;           /* List of allowed operations */
 399
 400
 401   DEBUG_printf(("cupsEncodeOptions2(ipp=%p(%s), num_options=%d, options=%p, "
 402                 "group_tag=%x)", ipp,
 403                 ipp ? ippOpString(ippGetOperation(ipp)) : "", num_options,
 404                 options, group_tag));
 405
 406  /*
 407   * Range check input...
 408   */
 409
 410   if (!ipp || num_options < 1 || !options)
 411     return;
 412
 413  /*
 414   * Do special handling for the document-format/raw options...
 415   */
 416
 417   op = ippGetOperation(ipp);
 418
 419   if (group_tag == IPP_TAG_OPERATION &&
 420       (op == IPP_OP_PRINT_JOB || op == IPP_OP_PRINT_URI ||
 421        op == IPP_OP_SEND_DOCUMENT || op == IPP_OP_SEND_URI))
 422   {
 423    /*
 424     * Handle the document format stuff first...
 425     */
 426
 427     if ((val = (char *)cupsGetOption("document-format", num_options,
 428                                      options)) != NULL)
 429       ippAddString(ipp, IPP_TAG_OPERATION, IPP_TAG_MIMETYPE, "document-format",
 430                    NULL, val);
 431     else if (cupsGetOption("raw", num_options, options))
 432       ippAddString(ipp, IPP_TAG_OPERATION, IPP_TAG_MIMETYPE, "document-format",
 433                    NULL, "application/vnd.cups-raw");
 434     else
 435       ippAddString(ipp, IPP_TAG_OPERATION, IPP_TAG_MIMETYPE, "document-format",
 436                    NULL, "application/octet-stream");
 437   }
 438
 439  /*
 440   * Then loop through the options...
 441   */
 442
 443   for (i = num_options, option = options; i > 0; i --, option ++)
 444   {
 445     _ipp_option_t       *match;         /* Matching attribute */
 446
 447
 448    /*
 449     * Skip document format options that are handled above...
 450     */
 451
 452     if (!_cups_strcasecmp(option->name, "raw") ||
 453         !_cups_strcasecmp(option->name, "document-format") ||
 454         !option->name[0])
 455       continue;
 456
 457    /*
 458     * Figure out the proper value and group tags for this option...
 459     */
 460
 461     if ((match = _ippFindOption(option->name)) != NULL)
 462     {
 463       if (match->group_tag != group_tag && match->alt_group_tag != group_tag)
 464         continue;
 465
 466       value_tag = match->value_tag;
 467
 468       if (match->operations)
 469         ops = match->operations;
 470       else if (group_tag == IPP_TAG_JOB)
 471         ops = ipp_job_creation;
 472       else if (group_tag == IPP_TAG_DOCUMENT)
 473         ops = ipp_doc_creation;
 474       else if (group_tag == IPP_TAG_SUBSCRIPTION)
 475         ops = ipp_sub_creation;
 476       else if (group_tag == IPP_TAG_PRINTER)
 477         ops = ipp_set_printer;
 478       else
 479       {
 480         DEBUG_printf(("2cupsEncodeOptions2: Skipping \"%s\".", option->name));
 481         continue;
 482       }
 483     }
 484     else
 485     {
 486       int       namelen;                /* Length of name */
 487
 488
 489       namelen = (int)strlen(option->name);
 490
 491       if (namelen < 10 ||
 492           (strcmp(option->name + namelen - 8, "-default") &&
 493            strcmp(option->name + namelen - 10, "-supported")))
 494       {
 495         if (group_tag != IPP_TAG_JOB && group_tag != IPP_TAG_DOCUMENT)
 496         {
 497           DEBUG_printf(("2cupsEncodeOptions2: Skipping \"%s\".", option->name));
 498           continue;
 499         }
 500       }
 501       else if (group_tag != IPP_TAG_PRINTER)
 502       {
 503         DEBUG_printf(("2cupsEncodeOptions2: Skipping \"%s\".", option->name));
 504         continue;
 505       }
 506
 507       if (group_tag == IPP_TAG_JOB)
 508         ops = ipp_job_creation;
 509       else if (group_tag == IPP_TAG_DOCUMENT)
 510         ops = ipp_doc_creation;
 511       else
 512         ops = ipp_set_printer;
 513
 514       if (!_cups_strcasecmp(option->value, "true") ||
 515           !_cups_strcasecmp(option->value, "false"))
 516         value_tag = IPP_TAG_BOOLEAN;
 517       else
 518         value_tag = IPP_TAG_NAME;
 519     }
 520
 521    /*
 522     * Verify that we send this attribute for this operation...
 523     */
 524
 525     while (*ops != IPP_OP_CUPS_NONE)
 526       if (op == *ops)
 527         break;
 528       else
 529         ops ++;
 530
 531     if (*ops == IPP_OP_CUPS_NONE && op != IPP_OP_CUPS_NONE)
 532     {
 533       DEBUG_printf(("2cupsEncodeOptions2: Skipping \"%s\".", option->name));
 534       continue;
 535     }
 536
 537    /*
 538     * Count the number of values...
 539     */
 540
 541     if (match && match->multivalue)
 542     {
 543       for (count = 1, sep = option->value, quote = 0; *sep; sep ++)
 544       {
 545         if (*sep == quote)
 546           quote = 0;
 547         else if (!quote && (*sep == '\'' || *sep == '\"'))
 548         {
 549          /*
 550           * Skip quoted option value...
 551           */
 552
 553           quote = *sep++;
 554         }
 555         else if (*sep == ',' && !quote)
 556           count ++;
 557         else if (*sep == '\\' && sep[1])
 558           sep ++;
 559       }
 560     }
 561     else
 562       count = 1;
 563
 564     DEBUG_printf(("2cupsEncodeOptions2: option=\"%s\", count=%d",
 565                   option->name, count));
 566
 567    /*
 568     * Allocate memory for the attribute values...
 569     */
 570
 571     if ((attr = ippAddStrings(ipp, group_tag, value_tag, option->name, count,
 572                               NULL, NULL)) == NULL)
 573     {
 574      /*
 575       * Ran out of memory!
 576       */
 577
 578       DEBUG_puts("1cupsEncodeOptions2: Ran out of memory for attributes!");
 579       return;
 580     }
 581
 582     if (count > 1)
 583     {
 584      /*
 585       * Make a copy of the value we can fiddle with...
 586       */
 587
 588       if ((copy = strdup(option->value)) == NULL)
 589       {
 590        /*
 591         * Ran out of memory!
 592         */
 593
 594         DEBUG_puts("1cupsEncodeOptions2: Ran out of memory for value copy!");
 595         ippDeleteAttribute(ipp, attr);
 596         return;
 597       }
 598
 599       val = copy;
 600     }
 601     else
 602     {
 603      /*
 604       * Since we have a single value, use the value directly...
 605       */
 606
 607       val  = option->value;
 608       copy = NULL;
 609     }
 610
 611    /*
 612     * Scan the value string for values...
 613     */
 614
 615     for (j = 0, sep = val; j < count; val = sep, j ++)
 616     {
 617      /*
 618       * Find the end of this value and mark it if needed...
 619       */
 620
 621       if (count > 1)
 622       {
 623         for (quote = 0; *sep; sep ++)
 624         {
 625           if (*sep == quote)
 626           {
 627            /*
 628             * Finish quoted value...
 629             */
 630
 631             quote = 0;
 632           }
 633           else if (!quote && (*sep == '\'' || *sep == '\"'))
 634           {
 635            /*
 636             * Handle quoted option value...
 637             */
 638
 639             quote = *sep;
 640           }
 641           else if (*sep == ',' && count > 1)
 642             break;
 643           else if (*sep == '\\' && sep[1])
 644           {
 645            /*
 646             * Skip quoted character...
 647             */
 648
 649             sep ++;
 650           }
 651         }
 652
 653         if (*sep == ',')
 654           *sep++ = '\0';
 655       }
 656
 657      /*
 658       * Copy the option value(s) over as needed by the type...
 659       */
 660
 661       switch (attr->value_tag)
 662       {
 663         case IPP_TAG_INTEGER :
 664         case IPP_TAG_ENUM :
 665            /*
 666             * Integer/enumeration value...
 667             */
 668
 669             attr->values[j].integer = (int)strtol(val, &s, 10);
 670
 671             DEBUG_printf(("2cupsEncodeOptions2: Added integer option value "
 672                           "%d...", attr->values[j].integer));
 673             break;
 674
 675         case IPP_TAG_BOOLEAN :
 676             if (!_cups_strcasecmp(val, "true") ||
 677                 !_cups_strcasecmp(val, "on") ||
 678                 !_cups_strcasecmp(val, "yes"))
 679             {
 680              /*
 681               * Boolean value - true...
 682               */
 683
 684               attr->values[j].boolean = 1;
 685
 686               DEBUG_puts("2cupsEncodeOptions2: Added boolean true value...");
 687             }
 688             else
 689             {
 690              /*
 691               * Boolean value - false...
 692               */
 693
 694               attr->values[j].boolean = 0;
 695
 696               DEBUG_puts("2cupsEncodeOptions2: Added boolean false value...");
 697             }
 698             break;
 699
 700         case IPP_TAG_RANGE :
 701            /*
 702             * Range...
 703             */
 704
 705             if (*val == '-')
 706             {
 707               attr->values[j].range.lower = 1;
 708               s = val;
 709             }
 710             else
 711               attr->values[j].range.lower = (int)strtol(val, &s, 10);
 712
 713             if (*s == '-')
 714             {
 715               if (s[1])
 716                 attr->values[j].range.upper = (int)strtol(s + 1, NULL, 10);
 717               else
 718                 attr->values[j].range.upper = 2147483647;
 719             }
 720             else
 721               attr->values[j].range.upper = attr->values[j].range.lower;
 722
 723             DEBUG_printf(("2cupsEncodeOptions2: Added range option value "
 724                           "%d-%d...", attr->values[j].range.lower,
 725                           attr->values[j].range.upper));
 726             break;
 727
 728         case IPP_TAG_RESOLUTION :
 729            /*
 730             * Resolution...
 731             */
 732
 733             attr->values[j].resolution.xres = (int)strtol(val, &s, 10);
 734
 735             if (*s == 'x')
 736               attr->values[j].resolution.yres = (int)strtol(s + 1, &s, 10);
 737             else
 738               attr->values[j].resolution.yres = attr->values[j].resolution.xres;
 739
 740             if (!_cups_strcasecmp(s, "dpc") ||
 741                 !_cups_strcasecmp(s, "dpcm"))
 742               attr->values[j].resolution.units = IPP_RES_PER_CM;
 743             else
 744               attr->values[j].resolution.units = IPP_RES_PER_INCH;
 745
 746             DEBUG_printf(("2cupsEncodeOptions2: Added resolution option value "
 747                           "%s...", val));
 748             break;
 749
 750         case IPP_TAG_STRING :
 751            /*
 752             * octet-string
 753             */
 754
 755             attr->values[j].unknown.length = (int)strlen(val);
 756             attr->values[j].unknown.data   = strdup(val);
 757
 758             DEBUG_printf(("2cupsEncodeOptions2: Added octet-string value "
 759                           "\"%s\"...", (char *)attr->values[j].unknown.data));
 760             break;
 761
 762         case IPP_TAG_BEGIN_COLLECTION :
 763            /*
 764             * Collection value
 765             */
 766
 767             num_cols   = cupsParseOptions(val, 0, &cols);
 768             if ((collection = ippNew()) == NULL)
 769             {
 770               cupsFreeOptions(num_cols, cols);
 771
 772               if (copy)
 773                 free(copy);
 774
 775               ippDeleteAttribute(ipp, attr);
 776               return;
 777             }
 778
 779             attr->values[j].collection = collection;
 780             cupsEncodeOptions2(collection, num_cols, cols, IPP_TAG_JOB);
 781             cupsFreeOptions(num_cols, cols);
 782             break;
 783
 784         default :
 785             if ((attr->values[j].string.text = _cupsStrAlloc(val)) == NULL)
 786             {
 787              /*
 788               * Ran out of memory!
 789               */
 790
 791               DEBUG_puts("1cupsEncodeOptions2: Ran out of memory for string!");
 792
 793               if (copy)
 794                 free(copy);
 795
 796               ippDeleteAttribute(ipp, attr);
 797               return;
 798             }
 799
 800             DEBUG_printf(("2cupsEncodeOptions2: Added string value \"%s\"...",
 801                           val));
 802             break;
 803       }
 804     }
 805
 806     if (copy)
 807       free(copy);
 808   }
 809 }
 810
 811
 812 #ifdef DEBUG
 813 /*
 814  * '_ippCheckOptions()' - Validate that the option array is sorted properly.
 815  */
 816
 817 const char *                            /* O - First out-of-order option or NULL */
 818 _ippCheckOptions(void)
 819 {
 820   int   i;                              /* Looping var */
 821
 822
 823   for (i = 0; i < (int)(sizeof(ipp_options) / sizeof(ipp_options[0]) - 1); i ++)
 824     if (strcmp(ipp_options[i].name, ipp_options[i + 1].name) >= 0)
 825       return (ipp_options[i + 1].name);
 826
 827   return (NULL);
 828 }
 829 #endif /* DEBUG */
 830
 831
 832 /*
 833  * '_ippFindOption()' - Find the attribute information for an option.
 834  */
 835
 836 _ipp_option_t *                         /* O - Attribute information */
 837 _ippFindOption(const char *name)        /* I - Option/attribute name */
 838 {
 839   _ipp_option_t key;                    /* Search key */
 840
 841
 842  /*
 843   * Lookup the proper value and group tags for this option...
 844   */
 845
 846   key.name = name;
 847
 848   return ((_ipp_option_t *)bsearch(&key, ipp_options,
 849                                    sizeof(ipp_options) / sizeof(ipp_options[0]),
 850                                    sizeof(ipp_options[0]),
 851                                    (int (*)(const void *, const void *))
 852                                        compare_ipp_options));
 853 }
 854
 855
 856 /*
 857  * 'compare_ipp_options()' - Compare two IPP options.
 858  */
 859
 860 static int                              /* O - Result of comparison */
 861 compare_ipp_options(_ipp_option_t *a,   /* I - First option */
 862                     _ipp_option_t *b)   /* I - Second option */
 863 {
 864   return (strcmp(a->name, b->name));
 865 }
 866
 867
 868 /*
 869  * End of "$Id$".
 870  */