]> git.ipfire.org Git - thirdparty/cups.git/blobdiff - cups/encode.c
Load cups into easysw/current.
[thirdparty/cups.git] / cups / encode.c
index be1aab28dee097992ab2f31150d9e27c8f746bfb..c1835980109cee7b1c7fcd3d6bb31484211d15a1 100644 (file)
@@ -1,33 +1,26 @@
 /*
- * "$Id: encode.c 4918 2006-01-12 05:14:40Z mike $"
+ * "$Id: encode.c 6649 2007-07-11 21:46:42Z mike $"
  *
  *   Option encoding routines for the Common UNIX Printing System (CUPS).
  *
- *   Copyright 1997-2005 by Easy Software Products.
+ *   Copyright 2007 by Apple Inc.
+ *   Copyright 1997-2007 by Easy Software Products.
  *
  *   These coded instructions, statements, and computer programs are the
- *   property of Easy Software Products 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 please contact Easy Software Products
- *   at:
- *
- *       Attn: CUPS Licensing Information
- *       Easy Software Products
- *       44141 Airport View Drive, Suite 204
- *       Hollywood, Maryland 20636 USA
- *
- *       Voice: (301) 373-9600
- *       EMail: cups-info@cups.org
- *         WWW: http://www.cups.org
+ *   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
+ *   file is missing or damaged, see the license at "http://www.cups.org/".
  *
  *   This file is subject to the Apple OS-Developed Software exception.
  *
  * Contents:
  *
- *   cupsEncodeOptions()  - Encode printer options into IPP attributes.
- *   cupsEncodeOptions2() - Encode printer options into IPP attributes for
- *                          a group.
+ *   cupsEncodeOptions()   - Encode printer options into IPP attributes.
+ *   cupsEncodeOptions2()  - Encode printer options into IPP attributes for
+ *                           a group.
+ *   _ippFindOption()      - Find the attribute information for an option.
+ *   compare_ipp_options() - Compare two IPP options.
  */
 
 /*
@@ -35,6 +28,7 @@
  */
 
 #include "cups.h"
+#include "ipp-private.h"
 #include <stdlib.h>
 #include <ctype.h>
 #include "string.h"
 
 /*
  * Local list of option names and the value tags they should use...
+ *
+ * **** THIS LIST MUST BE SORTED ****
  */
 
-typedef struct
-{
-  const char   *name;
-  ipp_tag_t    value_tag;
-  ipp_tag_t    group_tag;
-} _ipp_option_t;
-
 static const _ipp_option_t ipp_options[] =
 {
+  { "auth-info",               IPP_TAG_TEXT,           IPP_TAG_JOB },
+  { "auth-info-required",      IPP_TAG_KEYWORD,        IPP_TAG_PRINTER },
   { "blackplot",               IPP_TAG_BOOLEAN,        IPP_TAG_JOB },
+  { "blackplot-default",       IPP_TAG_BOOLEAN,        IPP_TAG_PRINTER },
   { "brightness",              IPP_TAG_INTEGER,        IPP_TAG_JOB },
+  { "brightness-default",      IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
   { "columns",                 IPP_TAG_INTEGER,        IPP_TAG_JOB },
+  { "columns-default",         IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
   { "copies",                  IPP_TAG_INTEGER,        IPP_TAG_JOB },
+  { "copies-default",          IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
   { "document-format",         IPP_TAG_MIMETYPE,       IPP_TAG_OPERATION },
+  { "document-format-default", IPP_TAG_MIMETYPE,       IPP_TAG_PRINTER },
   { "finishings",              IPP_TAG_ENUM,           IPP_TAG_JOB },
+  { "finishings-default",      IPP_TAG_ENUM,           IPP_TAG_PRINTER },
   { "fitplot",                 IPP_TAG_BOOLEAN,        IPP_TAG_JOB },
+  { "fitplot-default",         IPP_TAG_BOOLEAN,        IPP_TAG_PRINTER },
   { "gamma",                   IPP_TAG_INTEGER,        IPP_TAG_JOB },
+  { "gamma-default",           IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
   { "hue",                     IPP_TAG_INTEGER,        IPP_TAG_JOB },
+  { "hue-default",             IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
   { "job-k-limit",             IPP_TAG_INTEGER,        IPP_TAG_JOB },
   { "job-page-limit",          IPP_TAG_INTEGER,        IPP_TAG_JOB },
   { "job-priority",            IPP_TAG_INTEGER,        IPP_TAG_JOB },
   { "job-quota-period",                IPP_TAG_INTEGER,        IPP_TAG_JOB },
+  { "job-uuid",                        IPP_TAG_URI,            IPP_TAG_JOB },
   { "landscape",               IPP_TAG_BOOLEAN,        IPP_TAG_JOB },
   { "media",                   IPP_TAG_KEYWORD,        IPP_TAG_JOB },
   { "mirror",                  IPP_TAG_BOOLEAN,        IPP_TAG_JOB },
+  { "mirror-default",          IPP_TAG_BOOLEAN,        IPP_TAG_PRINTER },
   { "natural-scaling",         IPP_TAG_INTEGER,        IPP_TAG_JOB },
+  { "natural-scaling-default", IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
   { "notify-charset",          IPP_TAG_CHARSET,        IPP_TAG_SUBSCRIPTION },
   { "notify-events",           IPP_TAG_KEYWORD,        IPP_TAG_SUBSCRIPTION },
-  { "notify-lease-time",       IPP_TAG_INTEGER,        IPP_TAG_SUBSCRIPTION },
+  { "notify-events-default",   IPP_TAG_KEYWORD,        IPP_TAG_PRINTER },
+  { "notify-lease-duration",   IPP_TAG_INTEGER,        IPP_TAG_SUBSCRIPTION },
+  { "notify-lease-duration-default", IPP_TAG_INTEGER,  IPP_TAG_PRINTER },
   { "notify-natural-language", IPP_TAG_LANGUAGE,       IPP_TAG_SUBSCRIPTION },
   { "notify-pull-method",      IPP_TAG_KEYWORD,        IPP_TAG_SUBSCRIPTION },
-  { "notify-recipient",                IPP_TAG_URI,            IPP_TAG_SUBSCRIPTION },
+  { "notify-recipient-uri",    IPP_TAG_URI,            IPP_TAG_SUBSCRIPTION },
   { "notify-time-interval",    IPP_TAG_INTEGER,        IPP_TAG_SUBSCRIPTION },
   { "notify-user-data",                IPP_TAG_STRING,         IPP_TAG_SUBSCRIPTION },
   { "number-up",               IPP_TAG_INTEGER,        IPP_TAG_JOB },
+  { "number-up-default",       IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
   { "orientation-requested",   IPP_TAG_ENUM,           IPP_TAG_JOB },
+  { "orientation-requested-default", IPP_TAG_ENUM,     IPP_TAG_PRINTER },
   { "page-bottom",             IPP_TAG_INTEGER,        IPP_TAG_JOB },
+  { "page-bottom-default",     IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
   { "page-left",               IPP_TAG_INTEGER,        IPP_TAG_JOB },
+  { "page-left-default",       IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
   { "page-ranges",             IPP_TAG_RANGE,          IPP_TAG_JOB },
+  { "page-ranges-default",     IPP_TAG_RANGE,          IPP_TAG_PRINTER },
   { "page-right",              IPP_TAG_INTEGER,        IPP_TAG_JOB },
+  { "page-right-default",      IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
   { "page-top",                        IPP_TAG_INTEGER,        IPP_TAG_JOB },
+  { "page-top-default",                IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
   { "penwidth",                        IPP_TAG_INTEGER,        IPP_TAG_JOB },
+  { "penwidth-default",                IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
   { "ppi",                     IPP_TAG_INTEGER,        IPP_TAG_JOB },
+  { "ppi-default",             IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
   { "prettyprint",             IPP_TAG_BOOLEAN,        IPP_TAG_JOB },
+  { "prettyprint-default",     IPP_TAG_BOOLEAN,        IPP_TAG_PRINTER },
+  { "print-quality",           IPP_TAG_ENUM,           IPP_TAG_JOB },
+  { "print-quality-default",   IPP_TAG_ENUM,           IPP_TAG_PRINTER },
+  { "printer-error-policy",    IPP_TAG_NAME,           IPP_TAG_PRINTER },
+  { "printer-info",            IPP_TAG_TEXT,           IPP_TAG_PRINTER },
+  { "printer-is-accepting-jobs",IPP_TAG_BOOLEAN,       IPP_TAG_PRINTER },
+  { "printer-is-shared",       IPP_TAG_BOOLEAN,        IPP_TAG_PRINTER },
+  { "printer-location",                IPP_TAG_TEXT,           IPP_TAG_PRINTER },
+  { "printer-make-and-model",  IPP_TAG_TEXT,           IPP_TAG_PRINTER },
+  { "printer-more-info",       IPP_TAG_URI,            IPP_TAG_PRINTER },
+  { "printer-op-policy",       IPP_TAG_NAME,           IPP_TAG_PRINTER },
   { "printer-resolution",      IPP_TAG_RESOLUTION,     IPP_TAG_JOB },
+  { "printer-state",           IPP_TAG_ENUM,           IPP_TAG_PRINTER },
+  { "printer-state-change-time",IPP_TAG_INTEGER,       IPP_TAG_PRINTER },
+  { "printer-state-reasons",   IPP_TAG_KEYWORD,        IPP_TAG_PRINTER },
+  { "printer-type",            IPP_TAG_ENUM,           IPP_TAG_PRINTER },
   { "printer-uri",             IPP_TAG_URI,            IPP_TAG_OPERATION },
-  { "print-quality",           IPP_TAG_ENUM,           IPP_TAG_JOB },
+  { "queued-job-count",                IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
   { "raw",                     IPP_TAG_MIMETYPE,       IPP_TAG_OPERATION },
+  { "requesting-user-name-allowed",    IPP_TAG_NAME,   IPP_TAG_PRINTER },
+  { "requesting-user-name-denied",     IPP_TAG_NAME,   IPP_TAG_PRINTER },
+  { "resolution",              IPP_TAG_RESOLUTION,     IPP_TAG_JOB },
+  { "resolution-default",      IPP_TAG_RESOLUTION,     IPP_TAG_PRINTER },
   { "saturation",              IPP_TAG_INTEGER,        IPP_TAG_JOB },
+  { "saturation-default",      IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
   { "scaling",                 IPP_TAG_INTEGER,        IPP_TAG_JOB },
+  { "scaling-default",         IPP_TAG_INTEGER,        IPP_TAG_PRINTER },
   { "sides",                   IPP_TAG_KEYWORD,        IPP_TAG_JOB },
-  { "wrap",                    IPP_TAG_BOOLEAN,        IPP_TAG_JOB }
+  { "sides-default",           IPP_TAG_KEYWORD,        IPP_TAG_PRINTER },
+  { "wrap",                    IPP_TAG_BOOLEAN,        IPP_TAG_JOB },
+  { "wrap-default",            IPP_TAG_BOOLEAN,        IPP_TAG_PRINTER }
 };
 
 
+/*
+ * Local functions...
+ */
+
+static int     compare_ipp_options(_ipp_option_t *a, _ipp_option_t *b);
+
+
 /*
  * 'cupsEncodeOptions()' - Encode printer options into IPP attributes.
  *
@@ -150,16 +194,17 @@ cupsEncodeOptions2(
                *sep;                   /* Option separator */
   ipp_attribute_t *attr;               /* IPP attribute */
   ipp_tag_t    value_tag;              /* IPP value tag */
+  cups_option_t        *option;                /* Current option */
 
 
-  DEBUG_printf(("cupsEncodeOptions2(ipp=%p, num_options=%d, options=%p, group_tag=%x)\n",
-                ipp, num_options, options, group_tag));
+  DEBUG_printf(("cupsEncodeOptions2(ipp=%p, num_options=%d, options=%p, "
+                "group_tag=%x)\n", ipp, num_options, options, group_tag));
 
  /*
   * Range check input...
   */
 
-  if (ipp == NULL || num_options < 1 || options == NULL)
+  if (!ipp || num_options < 1 || !options)
     return;
 
  /*
@@ -187,45 +232,58 @@ cupsEncodeOptions2(
   * Then loop through the options...
   */
 
-  for (i = 0; i < num_options; i ++)
+  for (i = num_options, option = options; i > 0; i --, option ++)
   {
+    _ipp_option_t      *match;         /* Matching attribute */
+
+
    /*
     * Skip document format options that are handled above...
     */
 
-    if (!strcasecmp(options[i].name, "raw") ||
-        !strcasecmp(options[i].name, "document-format") ||
-       !options[i].name[0])
+    if (!strcasecmp(option->name, "raw") ||
+        !strcasecmp(option->name, "document-format") ||
+       !option->name[0])
       continue;
 
    /*
     * Figure out the proper value and group tags for this option...
     */
 
-    for (j = 0; j < (int)(sizeof(ipp_options) / sizeof(ipp_options[0])); j ++)
-      if (!strcasecmp(options[i].name, ipp_options[j].name))
-        break;
-
-    if (j < (int)(sizeof(ipp_options) / sizeof(ipp_options[0])))
+    if ((match = _ippFindOption(option->name)) != NULL)
     {
-      if (ipp_options[j].group_tag != group_tag)
+      if (match->group_tag != group_tag)
         continue;
 
-      value_tag = ipp_options[j].value_tag;
+      value_tag = match->value_tag;
     }
-    else if (group_tag != IPP_TAG_JOB)
-      continue;
-    else if (!strcasecmp(options[i].value, "true") ||
-             !strcasecmp(options[i].value, "false"))
-      value_tag = IPP_TAG_BOOLEAN;
     else
-      value_tag = IPP_TAG_NAME;
+    {
+      int      namelen;                /* Length of name */
+
+
+      namelen = (int)strlen(option->name);
+
+      if (namelen < 9 || strcmp(option->name + namelen - 8, "-default"))
+      {
+       if (group_tag != IPP_TAG_JOB)
+          continue;
+      }
+      else if (group_tag != IPP_TAG_PRINTER)
+        continue;
+
+      if (!strcasecmp(option->value, "true") ||
+          !strcasecmp(option->value, "false"))
+       value_tag = IPP_TAG_BOOLEAN;
+      else
+       value_tag = IPP_TAG_NAME;
+    }
 
    /*
     * Count the number of values...
     */
 
-    for (count = 1, sep = options[i].value; *sep; sep ++)
+    for (count = 1, sep = option->value; *sep; sep ++)
     {
       if (*sep == '\'')
       {
@@ -262,13 +320,13 @@ cupsEncodeOptions2(
     }
 
     DEBUG_printf(("cupsEncodeOptions2: option = \'%s\', count = %d\n",
-                  options[i].name, count));
+                  option->name, count));
 
    /*
     * Allocate memory for the attribute values...
     */
 
-    if ((attr = _ipp_add_attr(ipp, count)) == NULL)
+    if ((attr = _ippAddAttr(ipp, count)) == NULL)
     {
      /*
       * Ran out of memory!
@@ -289,7 +347,7 @@ cupsEncodeOptions2(
     * Copy the name over...
     */
 
-    if ((attr->name = strdup(options[i].name)) == NULL)
+    if ((attr->name = _cupsStrAlloc(option->name)) == NULL)
     {
      /*
       * Ran out of memory!
@@ -305,7 +363,7 @@ cupsEncodeOptions2(
       * Make a copy of the value we can fiddle with...
       */
 
-      if ((copy = strdup(options[i].value)) == NULL)
+      if ((copy = strdup(option->value)) == NULL)
       {
        /*
        * Ran out of memory!
@@ -323,7 +381,7 @@ cupsEncodeOptions2(
       * Since we have a single value, use the value directly...
       */
 
-      val  = options[i].value;
+      val  = option->value;
       copy = NULL;
     }
 
@@ -425,7 +483,7 @@ cupsEncodeOptions2(
            else
              attr->values[j].resolution.yres = attr->values[j].resolution.xres;
 
-           if (strcasecmp(s, "dpc") == 0)
+           if (!strcasecmp(s, "dpc"))
               attr->values[j].resolution.units = IPP_RES_PER_CM;
             else
               attr->values[j].resolution.units = IPP_RES_PER_INCH;
@@ -439,15 +497,15 @@ cupsEncodeOptions2(
            * octet-string
            */
 
-            attr->values[j].unknown.length = strlen(val);
-           attr->values[j].unknown.data   = strdup(val);
+            attr->values[j].unknown.length = (int)strlen(val);
+           attr->values[j].unknown.data   = _cupsStrAlloc(val);
 
             DEBUG_printf(("cupsEncodeOptions2: Added octet-string value \"%s\"...\n",
                          attr->values[j].unknown.data));
             break;
 
        default :
-            if ((attr->values[j].string.text = strdup(val)) == NULL)
+            if ((attr->values[j].string.text = _cupsStrAlloc(val)) == NULL)
            {
             /*
              * Ran out of memory!
@@ -462,10 +520,49 @@ cupsEncodeOptions2(
             break;
       }
     }
+
+    if (copy)
+      free(copy);
   }
 }
 
 
 /*
- * End of "$Id: encode.c 4918 2006-01-12 05:14:40Z mike $".
+ * '_ippFindOption()' - Find the attribute information for an option.
+ */
+
+_ipp_option_t *                                /* O - Attribute information */
+_ippFindOption(const char *name)       /* I - Option/attribute name */
+{
+  _ipp_option_t        key;                    /* Search key */
+
+
+ /*
+  * Lookup the proper value and group tags for this option...
+  */
+
+  key.name = name;
+
+  return ((_ipp_option_t *)bsearch(&key, ipp_options,
+                                   sizeof(ipp_options) / sizeof(ipp_options[0]),
+                                  sizeof(ipp_options[0]),
+                                  (int (*)(const void *, const void *))
+                                      compare_ipp_options));
+}
+
+
+/*
+ * 'compare_ipp_options()' - Compare two IPP options.
+ */
+
+static int                             /* O - Result of comparison */
+compare_ipp_options(_ipp_option_t *a,  /* I - First option */
+                    _ipp_option_t *b)  /* I - Second option */
+{
+  return (strcmp(a->name, b->name));
+}
+
+
+/*
+ * End of "$Id: encode.c 6649 2007-07-11 21:46:42Z mike $".
  */