The administrative APIs provide convenience functions to perform certain administrative functions with the CUPS scheduler.
-Note:
+Note:
Administrative functions normally require administrative privileges to execute and must not be used in ordinary user applications!
diff --git a/cups/api-array.header b/cups/api-array.header
deleted file mode 100644
index 557833e..0000000
--- a/cups/api-array.header
+++ /dev/null
@@ -1,32 +0,0 @@
-
-
-Array API
-
-
diff --git a/cups/api-array.shtml b/cups/api-array.shtml
deleted file mode 100644
index 374ef5b..0000000
--- a/cups/api-array.shtml
+++ /dev/null
@@ -1,194 +0,0 @@
-
-
-
-
-The CUPS array API provides a high-performance generic array container.
-The contents of the array container can be sorted and the container itself is
-designed for optimal speed and memory usage under a wide variety of conditions.
-Sorted arrays use a binary search algorithm from the last found or inserted
-element to quickly find matching elements in the array. Arrays created with the
-optional hash function can often find elements with a single lookup. The
-cups_array_t type is used when
-referring to a CUPS array.
-
-The CUPS scheduler (cupsd) and many of the CUPS API
-functions use the array API to efficiently manage large lists of
-data.
-
-
-
-Arrays are created using either the
-cupsArrayNew,
-cupsArrayNew2, or
-cupsArrayNew3 functions. The
-first function creates a new array with the specified callback function
-and user data pointer:
-
-
-#include <cups/array.h>
-
-static int compare_func(void *first, void *second, void *user_data);
-
-void *user_data;
-cups_array_t *array = cupsArrayNew(compare_func, user_data);
-
-
-The comparison function (type
-cups_arrayfunc_t) is called
-whenever an element is added to the array and can be NULL to
-create an unsorted array. The function returns -1 if the first element should
-come before the second, 0 if the first and second elements should have the same
-ordering, and 1 if the first element should come after the second.
-
-The "user_data" pointer is passed to your comparison function. Pass
-NULL if you do not need to associate the elements in your array
-with additional information.
-
-The cupsArrayNew2 function adds
-two more arguments to support hashed lookups, which can potentially provide
-instantaneous ("O(1)") lookups in your array:
-
-
-#include <cups/array.h>
-
-#define HASH_SIZE 512 /* Size of hash table */
-
-static int compare_func(void *first, void *second, void *user_data);
-static int hash_func(void *element, void *user_data);
-
-void *user_data;
-cups_array_t *hash_array = cupsArrayNew2(compare_func, user_data, hash_func, HASH_SIZE);
-
-
-The hash function (type
-cups_ahash_func_t) should return a
-number from 0 to (hash_size-1) that (hopefully) uniquely identifies the
-element and is called whenever you look up an element in the array with
-cupsArrayFind. The hash size is
-only limited by available memory, but generally should not be larger than
-16384 to realize any performance improvement.
-
-The cupsArrayNew3 function adds
-copy and free callbacks to support basic memory management of elements:
-
-
-#include <cups/array.h>
-
-#define HASH_SIZE 512 /* Size of hash table */
-
-static int compare_func(void *first, void *second, void *user_data);
-static void *copy_func(void *element, void *user_data);
-static void free_func(void *element, void *user_data);
-static int hash_func(void *element, void *user_data);
-
-void *user_data;
-cups_array_t *array = cupsArrayNew3(compare_func, user_data, NULL, 0, copy_func, free_func);
-
-cups_array_t *hash_array = cupsArrayNew3(compare_func, user_data, hash_func, HASH_SIZE, copy_func, free_func);
-
-
-Once you have created the array, you add elements using the
-cupsArrayAdd
-cupsArrayInsert functions.
-The first function adds an element to the array, adding the new element
-after any elements that have the same order, while the second inserts the
-element before others with the same order. For unsorted arrays,
-cupsArrayAdd appends the element to
-the end of the array while
-cupsArrayInsert inserts the
-element at the beginning of the array. For example, the following code
-creates a sorted array of character strings:
-
-
-#include <cups/array.h>
-
-/* Use strcmp() to compare strings - it will ignore the user_data pointer */
-cups_array_t *array = cupsArrayNew((cups_array_func_t)strcmp, NULL);
-
-/* Add four strings to the array */
-cupsArrayAdd(array, "One Fish");
-cupsArrayAdd(array, "Two Fish");
-cupsArrayAdd(array, "Red Fish");
-cupsArrayAdd(array, "Blue Fish");
-
-
-Elements are removed using the
-cupsArrayRemove function, for
-example:
-
-
-#include <cups/array.h>
-
-/* Use strcmp() to compare strings - it will ignore the user_data pointer */
-cups_array_t *array = cupsArrayNew((cups_array_func_t)strcmp, NULL);
-
-/* Add four strings to the array */
-cupsArrayAdd(array, "One Fish");
-cupsArrayAdd(array, "Two Fish");
-cupsArrayAdd(array, "Red Fish");
-cupsArrayAdd(array, "Blue Fish");
-
-/* Remove "Red Fish" */
-cupsArrayRemove(array, "Red Fish");
-
-
-Finally, you free the memory used by the array using the
-cupsArrayDelete function. All
-of the memory for the array and hash table (if any) is freed, however CUPS
-does not free the elements unless you provide copy and free functions.
-
-
-
-CUPS provides several functions to find and enumerate elements in an
-array. Each one sets or updates a "current index" into the array, such that
-future lookups will start where the last one left off:
-
-
- cupsArrayFind- Returns the first matching element.
- cupsArrayFirst- Returns the first element in the array.
- cupsArrayIndex- Returns the Nth element in the array, starting at 0.
- cupsArrayLast- Returns the last element in the array.
- cupsArrayNext- Returns the next element in the array.
- cupsArrayPrev- Returns the previous element in the array.
-
-
-Each of these functions returns NULL when there is no
-corresponding element. For example, a simple for loop using the
-cupsArrayFirst and
-cupsArrayNext functions will
-enumerate all of the strings in our previous example:
-
-
-#include <cups/array.h>
-
-/* Use strcmp() to compare strings - it will ignore the user_data pointer */
-cups_array_t *array = cupsArrayNew((cups_array_func_t)strcmp, NULL);
-
-/* Add four strings to the array */
-cupsArrayAdd(array, "One Fish");
-cupsArrayAdd(array, "Two Fish");
-cupsArrayAdd(array, "Red Fish");
-cupsArrayAdd(array, "Blue Fish");
-
-/* Show all of the strings in the array */
-char *s;
-for (s = (char *)cupsArrayFirst(array); s != NULL; s = (char *)cupsArrayNext(array))
- puts(s);
-
diff --git a/cups/api-cups.header b/cups/api-cups.header
deleted file mode 100644
index 23b3794..0000000
--- a/cups/api-cups.header
+++ /dev/null
@@ -1,38 +0,0 @@
-
-
-CUPS API
-
-
diff --git a/cups/api-cups.shtml b/cups/api-cups.shtml
deleted file mode 100644
index 918efe7..0000000
--- a/cups/api-cups.shtml
+++ /dev/null
@@ -1,441 +0,0 @@
-
-
-
-
-The CUPS API provides the convenience functions needed to support
-applications, filters, printer drivers, and backends that need to interface
-with the CUPS scheduler.
-
-
-
-CUPS is based on the Internet Printing Protocol ("IPP"), which allows
-clients (applications) to communicate with a server (the scheduler) to get a
-list of printers, send print jobs, and so forth. You identify which server
-you want to communicate with using a pointer to the opaque structure
-http_t. All of the examples in this document use the
-CUPS_HTTP_DEFAULT constant, referring to the default connection
-to the scheduler. The HTTP and IPP
-APIs document provides more information on server connections.
-
-
-
-Printers and classes (collections of printers) are accessed through
-the cups_dest_t structure which
-includes the name (name), instance (instance -
-a way of selecting certain saved options/settings), and the options and
-attributes associated with that destination (num_options and
-options). Destinations are created using the
-cupsGetDests function and freed
-using the cupsFreeDests function.
-The cupsGetDest function finds a
-specific destination for printing:
-
-
-#include <cups/cups.h>
-
-cups_dest_t *dests;
-int num_dests = cupsGetDests(&dests);
-cups_dest_t *dest = cupsGetDest("name", NULL, num_dests, dests);
-
-/* do something with dest */
-
-cupsFreeDests(num_dests, dests);
-
-
-Passing NULL to
-cupsGetDest for the destination name
-will return the default destination. Similarly, passing a NULL
-instance will return the default instance for that destination.
-
-
-Table 1: Printer Attributes
-
-
- | Attribute Name |
- Description |
-
-
-
-
- | "auth-info-required" |
- The type of authentication required for printing to this
- destination: "none", "username,password", "domain,username,password",
- or "negotiate" (Kerberos) |
-
-
- | "printer-info" |
- The human-readable description of the destination such as "My
- Laser Printer". |
-
-
- | "printer-is-accepting-jobs" |
- "true" if the destination is accepting new jobs, "false" if
- not. |
-
-
- | "printer-is-shared" |
- "true" if the destination is being shared with other computers,
- "false" if not. |
-
-
- | "printer-location" |
- The human-readable location of the destination such as "Lab 4". |
-
-
- | "printer-make-and-model" |
- The human-readable make and model of the destination such as "HP
- LaserJet 4000 Series". |
-
-
- | "printer-state" |
- "3" if the destination is idle, "4" if the destination is printing
- a job, and "5" if the destination is stopped. |
-
-
- | "printer-state-change-time" |
- The UNIX time when the destination entered the current state. |
-
-
- | "printer-state-reasons" |
- Additional comma-delimited state keywords for the destination
- such as "media-tray-empty-error" and "toner-low-warning". |
-
-
- | "printer-type" |
- The cups_printer_t
- value associated with the destination. |
-
-
-
Options are stored in arrays of
-cups_option_t structures. Each
-option has a name (name) and value (value)
-associated with it. The cups_dest_t
-num_options and options members contain the
-default options for a particular destination, along with several informational
-attributes about the destination as shown in Table 1.
-The cupsGetOption function gets
-the value for the named option. For example, the following code lists the
-available destinations and their human-readable descriptions:
-
-
-#include <cups/cups.h>
-
-cups_dest_t *dests;
-int num_dests = cupsGetDests(&dests);
-cups_dest_t *dest;
-int i;
-const char *value;
-
-for (i = num_dests, dest = dests; i > 0; i --, dest ++)
- if (dest->instance == NULL)
- {
- value = cupsGetOption("printer-info", dest->num_options, dest->options);
- printf("%s (%s)\n", dest->name, value ? value : "no description");
- }
-
-cupsFreeDests(num_dests, dests);
-
-
-You can create your own option arrays using the
-cupsAddOption function, which
-adds a single named option to an array:
-
-
-#include <cups/cups.h>
-
-int num_options = 0;
-cups_option_t *options = NULL;
-
-/* The returned num_options value is updated as needed */
-num_options = cupsAddOption("first", "value", num_options, &options);
-
-/* This adds a second option value */
-num_options = cupsAddOption("second", "value", num_options, &options);
-
-/* This replaces the first option we added */
-num_options = cupsAddOption("first", "new value", num_options, &options);
-
-
-Use a for loop to copy the options from a destination:
-
-
-#include <cups/cups.h>
-
-int i;
-int num_options = 0;
-cups_option_t *options = NULL;
-cups_dest_t *dest;
-
-for (i = 0; i < dest->num_options; i ++)
- num_options = cupsAddOption(dest->options[i].name, dest->options[i].value,
- num_options, &options);
-
-
-Use the cupsFreeOptions
-function to free the options array when you are done using it:
-
-
-cupsFreeOptions(num_options, options);
-
-
-
-
-Print jobs are identified by a locally-unique job ID number from 1 to
-231-1 and have options and one or more files for printing to a
-single destination. The cupsPrintFile
-function creates a new job with one file. The following code prints the CUPS
-test page file:
-
-
-#include <cups/cups.h>
-
-cups_dest_t *dest;
-int num_options;
-cups_option_t *options;
-int job_id;
-
-/* Print a single file */
-job_id = cupsPrintFile(dest->name, "/usr/share/cups/data/testprint.ps",
- "Test Print", num_options, options);
-
-
-The cupsPrintFiles function
-creates a job with multiple files. The files are provided in a
-char * array:
-
-
-#include <cups/cups.h>
-
-cups_dest_t *dest;
-int num_options;
-cups_option_t *options;
-int job_id;
-char *files[3] = { "file1.pdf", "file2.pdf", "file3.pdf" };
-
-/* Print three files */
-job_id = cupsPrintFiles(dest->name, 3, files, "Test Print", num_options, options);
-
-
-Finally, the cupsCreateJob
-function creates a new job with no files in it. Files are added using the
-cupsStartDocument,
-cupsWriteRequestData,
-and cupsFinishDocument functions.
-The following example creates a job with 10 text files for printing:
-
-
-#include <cups/cups.h>
-
-cups_dest_t *dest;
-int num_options;
-cups_option_t *options;
-int job_id;
-int i;
-char buffer[1024];
-
-/* Create the job */
-job_id = cupsCreateJob(CUPS_HTTP_DEFAULT, dest->name, "10 Text Files",
- num_options, options);
-
-/* If the job is created, add 10 files */
-if (job_id > 0)
-{
- for (i = 1; i <= 10; i ++)
- {
- snprintf(buffer, sizeof(buffer), "file%d.txt", i);
-
- cupsStartDocument(CUPS_HTTP_DEFAULT, dest->name, job_id, buffer,
- CUPS_FORMAT_TEXT, i == 10);
-
- snprintf(buffer, sizeof(buffer),
- "File %d\n"
- "\n"
- "One fish,\n"
- "Two fish,\n
- "Red fish,\n
- "Blue fish\n", i);
-
- /* cupsWriteRequestData can be called as many times as needed */
- cupsWriteRequestData(CUPS_HTTP_DEFAULT, buffer, strlen(buffer));
-
- cupsFinishDocument(CUPS_HTTP_DEFAULT, dest->name);
- }
-}
-
-
-Once you have created a job, you can monitor its status using the
-cupsGetJobs function, which returns
-an array of cups_job_t structures.
-Each contains the job ID (id), destination name
-(dest), title (title), and other information
-associated with the job. The job array is freed using the
-cupsFreeJobs function. The following
-example monitors a specific job ID, showing the current job state once every
-5 seconds until the job is completed:
-
-
-#include <cups/cups.h>
-
-cups_dest_t *dest;
-int job_id;
-int num_jobs;
-cups_job_t *jobs;
-int i;
-ipp_jstate_t job_state = IPP_JOB_PENDING;
-
-while (job_state < IPP_JOB_STOPPED)
-{
- /* Get my jobs (1) with any state (-1) */
- num_jobs = cupsGetJobs(&jobs, dest->name, 1, -1);
-
- /* Loop to find my job */
- job_state = IPP_JOB_COMPLETED;
-
- for (i = 0; i < num_jobs; i ++)
- if (jobs[i].id == job_id)
- {
- job_state = jobs[i].state;
- break;
- }
-
- /* Free the job array */
- cupsFreeJobs(num_jobs, jobs);
-
- /* Show the current state */
- switch (job_state)
- {
- case IPP_JOB_PENDING :
- printf("Job %d is pending.\n", job_id);
- break;
- case IPP_JOB_HELD :
- printf("Job %d is held.\n", job_id);
- break;
- case IPP_JOB_PROCESSING :
- printf("Job %d is processing.\n", job_id);
- break;
- case IPP_JOB_STOPPED :
- printf("Job %d is stopped.\n", job_id);
- break;
- case IPP_JOB_CANCELED :
- printf("Job %d is canceled.\n", job_id);
- break;
- case IPP_JOB_ABORTED :
- printf("Job %d is aborted.\n", job_id);
- break;
- case IPP_JOB_COMPLETED :
- printf("Job %d is completed.\n", job_id);
- break;
- }
-
- /* Sleep if the job is not finished */
- if (job_state < IPP_JOB_STOPPED)
- sleep(5);
-}
-
-
-To cancel a job, use the
-cupsCancelJob function with the
-job ID:
-
-
-#include <cups/cups.h>
-
-cups_dest_t *dest;
-int job_id;
-
-cupsCancelJob(dest->name, job_id);
-
-
-
-
-If any of the CUPS API printing functions returns an error, the reason for
-that error can be found by calling the
-cupsLastError and
-cupsLastErrorString functions.
-cupsLastError returns the last IPP
-error code
-(ipp_status_t)
-that was encountered, while
-cupsLastErrorString returns
-a (localized) human-readable string that can be shown to the user. For example,
-if any of the job creation functions returns a job ID of 0, you can use
-cupsLastErrorString to show
-the reason why the job could not be created:
-
-
-#include <cups/cups.h>
-
-int job_id;
-
-if (job_id == 0)
- puts(cupsLastErrorString());
-
-
-
-
-CUPS supports authentication of any request, including submission of print
-jobs. The default mechanism for getting the username and password is to use the
-login user and a password from the console.
-
-To support other types of applications, in particular Graphical User
-Interfaces ("GUIs"), the CUPS API provides functions to set the default
-username and to register a callback function that returns a password string.
-
-The cupsSetPasswordCB
-function is used to set a password callback in your program. Only one
-function can be used at any time.
-
-The cupsSetUser function sets the
-current username for authentication. This function can be called by your
-password callback function to change the current username as needed.
-
-The following example shows a simple password callback that gets a
-username and password from the user:
-
-
-#include <cups/cups.h>
-
-const char *
-my_password_cb(const char *prompt)
-{
- char user[65];
-
-
- puts(prompt);
-
- /* Get a username from the user */
- printf("Username: ");
- if (fgets(user, sizeof(user), stdin) == NULL)
- return (NULL);
-
- /* Strip the newline from the string and set the user */
- user[strlen(user) - 1] = '\0';
-
- cupsSetUser(user);
-
- /* Use getpass() to ask for the password... */
- return (getpass("Password: "));
-}
-
-cupsSetPasswordCB(my_password_cb);
-
-
-Similarly, a GUI could display the prompt string in a window with input
-fields for the username and password. The username should default to the
-string returned by the cupsUser
-function.
diff --git a/cups/api-filedir.header b/cups/api-filedir.header
deleted file mode 100644
index 87744ee..0000000
--- a/cups/api-filedir.header
+++ /dev/null
@@ -1,34 +0,0 @@
-
-
-File and Directory APIs
-
-
diff --git a/cups/api-filedir.shtml b/cups/api-filedir.shtml
deleted file mode 100644
index 8fdbee6..0000000
--- a/cups/api-filedir.shtml
+++ /dev/null
@@ -1,29 +0,0 @@
-
-
-
-
-The CUPS file and directory APIs provide portable interfaces
-for manipulating files and listing files and directories. Unlike
-stdio FILE streams, the cupsFile functions
-allow you to open more than 256 files at any given time. They
-also manage the platform-specific details of locking, large file
-support, line endings (CR, LF, or CR LF), and reading and writing
-files using Flate ("gzip") compression. Finally, you can also
-connect, read from, and write to network connections using the
-cupsFile functions.
-
-The cupsDir functions manage the platform-specific
-details of directory access/listing and provide a convenient way
-to get both a list of files and the information (permissions,
-size, timestamp, etc.) for each of those files.
diff --git a/cups/api-filter.header b/cups/api-filter.header
index f08bc71..f64ef63 100644
--- a/cups/api-filter.header
+++ b/cups/api-filter.header
@@ -1,13 +1,10 @@
Filter and Backend Programming
diff --git a/cups/api-filter.shtml b/cups/api-filter.shtml
index bd90333..e7ab510 100644
--- a/cups/api-filter.shtml
+++ b/cups/api-filter.shtml
@@ -1,14 +1,11 @@
@@ -871,4 +868,7 @@ void *my_data;
-Note: The sandbox profile used in CUPS 2.0 still allows some actions that are not listed above - these privileges will be removed over time until the profile matches the list above.
+Note:
+
+The sandbox profile used in CUPS still allows some actions that are not listed above - these privileges will be removed over time until the profile matches the list above.
+
diff --git a/cups/api-httpipp.header b/cups/api-httpipp.header
deleted file mode 100644
index cbede8f..0000000
--- a/cups/api-httpipp.header
+++ /dev/null
@@ -1,37 +0,0 @@
-
-
-HTTP and IPP APIs
-
-
diff --git a/cups/api-httpipp.shtml b/cups/api-httpipp.shtml
deleted file mode 100644
index 33bf5ad..0000000
--- a/cups/api-httpipp.shtml
+++ /dev/null
@@ -1,315 +0,0 @@
-
-
-
-
-The CUPS HTTP and IPP APIs provide low-level access to the HTTP and IPP
-protocols and CUPS scheduler. They are typically used by monitoring and
-administration programs to perform specific functions not supported by the
-high-level CUPS API functions.
-
-The HTTP APIs use an opaque structure called
-http_t to manage connections to
-a particular HTTP or IPP server. The
-httpConnectEncrypt function is
-used to create an instance of this structure for a particular server.
-The constant CUPS_HTTP_DEFAULT can be used with all of the
-cups functions to refer to the default CUPS server - the functions
-create a per-thread http_t as needed.
-
-The IPP APIs use two opaque structures for requests (messages sent to the CUPS scheduler) and responses (messages sent back to your application from the scheduler). The ipp_t type holds a complete request or response and is allocated using the ippNew or ippNewRequest functions and freed using the ippDelete function.
-
-The second opaque structure is called ipp_attribute_t and holds a single IPP attribute which consists of a group tag (ippGetGroupTag), a value type tag (ippGetValueTag), the attribute name (ippGetName), and 1 or more values (ippGetCount, ippGetBoolean, ippGetCollection, ippGetDate, ippGetInteger, ippGetRange, ippGetResolution, and ippGetString). Attributes are added to an ipp_t pointer using one of the ippAdd functions. For example, use ippAddString to add the "printer-uri" and "requesting-user-name" string attributes to a request:
-
-
-ipp_t *request = ippNewRequest(IPP_GET_JOBS);
-
-ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri",
- NULL, "ipp://localhost/printers/");
-ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "requesting-user-name",
- NULL, cupsUser());
-
-
-Once you have created an IPP request, use the cups functions to send the request to and read the response from the server. For example, the cupsDoRequest function can be used for simple query operations that do not involve files:
-
-
-#include <cups/cups.h>
-
-
-ipp_t *get_jobs(void)
-{
- ipp_t *request = ippNewRequest(IPP_GET_JOBS);
-
- ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri",
- NULL, "ipp://localhost/printers/");
- ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "requesting-user-name",
- NULL, cupsUser());
-
- return (cupsDoRequest(CUPS_HTTP_DEFAULT, request, "/"));
-}
-
-
-The cupsDoRequest function frees the request and returns an IPP response or NULL pointer if the request could not be sent to the server. Once you have a response from the server, you can either use the ippFindAttribute and ippFindNextAttribute functions to find specific attributes, for example:
-
-
-ipp_t *response;
-ipp_attribute_t *attr;
-
-attr = ippFindAttribute(response, "printer-state", IPP_TAG_ENUM);
-
-
-You can also walk the list of attributes with a simple for loop like this:
-
-
-ipp_t *response;
-ipp_attribute_t *attr;
-
-for (attr = ippFirstAttribute(response); attr != NULL; attr = ippNextAttribute(response))
- if (ippGetName(attr) == NULL)
- puts("--SEPARATOR--");
- else
- puts(ippGetName(attr));
-
-
-The for loop approach is normally used when collecting attributes for multiple objects (jobs, printers, etc.) in a response. Attributes with NULL names indicate a separator between the attributes of each object. For example, the following code will list the jobs returned from our previous get_jobs example code:
-
-
-ipp_t *response = get_jobs();
-
-if (response != NULL)
-{
- ipp_attribute_t *attr;
- const char *attrname;
- int job_id = 0;
- const char *job_name = NULL;
- const char *job_originating_user_name = NULL;
-
- puts("Job ID Owner Title");
- puts("------ ---------------- ---------------------------------");
-
- for (attr = ippFirstAttribute(response); attr != NULL; attr = ippNextAttribute(response))
- {
- /* Attributes without names are separators between jobs */
- attrname = ippGetName(attr);
- if (attrname == NULL)
- {
- if (job_id > 0)
- {
- if (job_name == NULL)
- job_name = "(withheld)";
-
- if (job_originating_user_name == NULL)
- job_originating_user_name = "(withheld)";
-
- printf("%5d %-16s %s\n", job_id, job_originating_user_name, job_name);
- }
-
- job_id = 0;
- job_name = NULL;
- job_originating_user_name = NULL;
- continue;
- }
- else if (!strcmp(attrname, "job-id") && ippGetValueTag(attr) == IPP_TAG_INTEGER)
- job_id = ippGetInteger(attr, 0);
- else if (!strcmp(attrname, "job-name") && ippGetValueTag(attr) == IPP_TAG_NAME)
- job_name = ippGetString(attr, 0, NULL);
- else if (!strcmp(attrname, "job-originating-user-name") &&
- ippGetValueTag(attr) == IPP_TAG_NAME)
- job_originating_user_name = ippGetString(attr, 0, NULL);
- }
-
- if (job_id > 0)
- {
- if (job_name == NULL)
- job_name = "(withheld)";
-
- if (job_originating_user_name == NULL)
- job_originating_user_name = "(withheld)";
-
- printf("%5d %-16s %s\n", job_id, job_originating_user_name, job_name);
- }
-}
-
-
-
-
-To ensure proper encoding, the
-httpAssembleURIf function must be
-used to format a "printer-uri" string for all printer-based requests:
-
-
-const char *name = "Foo";
-char uri[1024];
-ipp_t *request;
-
-httpAssembleURIf(HTTP_URI_CODING_ALL, uri, sizeof(uri), "ipp", NULL, cupsServer(),
- ippPort(), "/printers/%s", name);
-ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri", NULL, uri);
-
-
-
-
-The cupsDoFileRequest and
-cupsDoIORequest functions are
-used for requests involving files. The
-cupsDoFileRequest function
-attaches the named file to a request and is typically used when sending a print
-file or changing a printer's PPD file:
-
-
-const char *filename = "/usr/share/cups/data/testprint.ps";
-const char *name = "Foo";
-char uri[1024];
-char resource[1024];
-ipp_t *request = ippNewRequest(IPP_PRINT_JOB);
-ipp_t *response;
-
-/* Use httpAssembleURIf for the printer-uri string */
-httpAssembleURIf(HTTP_URI_CODING_ALL, uri, sizeof(uri), "ipp", NULL, cupsServer(),
- ippPort(), "/printers/%s", name);
-ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri", NULL, uri);
-ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "requesting-user-name",
- NULL, cupsUser());
-ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "job-name",
- NULL, "testprint.ps");
-
-/* Use snprintf for the resource path */
-snprintf(resource, sizeof(resource), "/printers/%s", name);
-
-response = cupsDoFileRequest(CUPS_HTTP_DEFAULT, request, resource, filename);
-
-
-The cupsDoIORequest function
-optionally attaches a file to the request and optionally saves a file in the
-response from the server. It is used when using a pipe for the request
-attachment or when using a request that returns a file, currently only
-CUPS_GET_DOCUMENT and CUPS_GET_PPD. For example,
-the following code will download the PPD file for the sample HP LaserJet
-printer driver:
-
-
-char tempfile[1024];
-int tempfd;
-ipp_t *request = ippNewRequest(CUPS_GET_PPD);
-ipp_t *response;
-
-ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "ppd-name",
- NULL, "laserjet.ppd");
-
-tempfd = cupsTempFd(tempfile, sizeof(tempfile));
-
-response = cupsDoIORequest(CUPS_HTTP_DEFAULT, request, "/", -1, tempfd);
-
-
-The example passes -1 for the input file descriptor to specify
-that no file is to be attached to the request. The PPD file attached to the
-response is written to the temporary file descriptor we created using the
-cupsTempFd function.
-
-
-
-The cupsSendRequest and
-cupsGetResponse support
-asynchronous communications with the server. Unlike the other request
-functions, the IPP request is not automatically freed, so remember to
-free your request with the ippDelete
-function.
-
-File data is attached to the request using the
-cupsWriteRequestData
-function, while file data returned from the server is read using the
-cupsReadResponseData
-function. We can rewrite the previous CUPS_GET_PPD example
-to use the asynchronous functions quite easily:
-
-
-char tempfile[1024];
-int tempfd;
-ipp_t *request = ippNewRequest(CUPS_GET_PPD);
-ipp_t *response;
-
-ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "ppd-name",
- NULL, "laserjet.ppd");
-
-tempfd = cupsTempFd(tempfile, sizeof(tempfile));
-
-if (cupsSendRequest(CUPS_HTTP_DEFAULT, request, "/") == HTTP_CONTINUE)
-{
- response = cupsGetResponse(CUPS_HTTP_DEFAULT, "/");
-
- if (response != NULL)
- {
- ssize_t bytes;
- char buffer[8192];
-
- while ((bytes = cupsReadResponseData(CUPS_HTTP_DEFAULT, buffer, sizeof(buffer))) > 0)
- write(tempfd, buffer, bytes);
- }
-}
-
-/* Free the request! */
-ippDelete(request);
-
-
-The cupsSendRequest function
-returns the initial HTTP request status, typically either
-HTTP_CONTINUE or HTTP_UNAUTHORIZED. The latter status
-is returned when the request requires authentication of some sort. The
-cupsDoAuthentication function
-must be called when your see HTTP_UNAUTHORIZED and the request
-re-sent. We can add authentication support to our example code by using a
-do ... while loop:
-
-
-char tempfile[1024];
-int tempfd;
-ipp_t *request = ippNewRequest(CUPS_GET_PPD);
-ipp_t *response;
-http_status_t status;
-
-ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "ppd-name",
- NULL, "laserjet.ppd");
-
-tempfd = cupsTempFd(tempfile, sizeof(tempfile));
-
-/* Loop for authentication */
-do
-{
- status = cupsSendRequest(CUPS_HTTP_DEFAULT, request, "/");
-
- if (status == HTTP_UNAUTHORIZED)
- {
- /* Try to authenticate, break out of the loop if that fails */
- if (cupsDoAuthentication(CUPS_HTTP_DEFAULT, "POST", "/"))
- break;
- }
-}
-while (status != HTTP_CONTINUE && status != HTTP_UNAUTHORIZED);
-
-if (status == HTTP_CONTINUE)
-{
- response = cupsGetResponse(CUPS_HTTP_DEFAULT, "/");
-
- if (response != NULL)
- {
- ssize_t bytes;
- char buffer[8192];
-
- while ((bytes = cupsReadResponseData(CUPS_HTTP_DEFAULT, buffer, sizeof(buffer))) > 0)
- write(tempfd, buffer, bytes);
- }
-}
-
-/* Free the request! */
-ippDelete(request);
-
diff --git a/cups/api-overview.header b/cups/api-overview.header
deleted file mode 100644
index b96cd07..0000000
--- a/cups/api-overview.header
+++ /dev/null
@@ -1,54 +0,0 @@
-
-
-Introduction to CUPS Programming
-
-
diff --git a/cups/api-overview.shtml b/cups/api-overview.shtml
deleted file mode 100644
index 9903152..0000000
--- a/cups/api-overview.shtml
+++ /dev/null
@@ -1,92 +0,0 @@
-
-
-
-
-CUPS provides two libraries that interface with the different parts of the
-printing system. The "cups" library provides all of the common application and
-filter functions while the "cupsimage" library provides all of the imaging
-functions used in raster printer drivers. The "cups" library functions are
-accessed by including the <cups/cups.h> header, while
-"cupsimage" functions are found in the <cups/raster.h>
-header.
-
-
-
-The CUPS libraries can be used from any C, C++, or Objective C program.
-The method of compiling against the libraries varies depending on the
-operating system and installation of CUPS. The following sections show how
-to compile a simple program (shown below) in two common environments.
-
-The following simple program lists the available printers on the system:
-
-
-#include <stdio.h>
-#include <cups/cups.h>
-
-int main(void)
-{
- int i;
- cups_dest_t *dests, *dest;
- int num_dests = cupsGetDests(&dests);
-
- for (i = num_dests, dest = dests; i > 0; i --, dest ++)
- {
- if (dest->instance)
- printf("%s/%s\n", dest->name, dest->instance);
- else
- puts(dest->name);
- }
-
- return (0);
-}
-
-
-
-
-In Xcode, choose New Project... from the File menu,
-then select the Standard Tool project type under Command Line
-Utility. Click Next and choose a project directory. Click
-Next to create the project.
-
-In the project window, double-click on the Targets group and
-control-click on the simple target to show the context menu. Choose
-Existing Framework... from the Add submenu. When the file
-chooser sheet appears, press the / key and enter "/usr/lib". Scroll
-down the file list and select the libcups.dylib file. Click the
-Add button in the file chooser and attributes sheets.
-
-In the project window, double-click on the main.c source file.
-Replace the template source code with the listing above and save it. Click the
-Build and Go button to build the sample program and run it.
-
-
-
-From the command-line, create a file called sample.c using your
-favorite editor and then run the following command to compile it with GCC and
-run it:
-
-
-gcc -o simple `cups-config --cflags` simple.c `cups-config --libs`
-./simple
-
-
-The cups-config command provides the compiler flags
-("cups-config --cflags") and libraries ("cups-config --libs") needed for the
-local system.
-
-
-
-If you are developing a print filter, driver, or backend, see the
-Filter and Backend Programming
-guide. Raster printer driver developers should also read the
-Raster API reference.
diff --git a/cups/api-ppd.header b/cups/api-ppd.header
index 2f7a4cd..bc555e6 100644
--- a/cups/api-ppd.header
+++ b/cups/api-ppd.header
@@ -1,18 +1,18 @@
PPD API (DEPRECATED)
-The PPD API is deprecated starting in CUPS 1.6/macOS 10.8. Please use the new Job Ticket APIs in the CUPS API documentation. These functions will be removed in a future release of CUPS.
+Note:
+
+The PPD API was deprecated in CUPS 1.6/macOS 10.8. Please use the new Job Ticket APIs in the CUPS Programming Manual documentation. These functions will be removed in a future release of CUPS.
+
@@ -29,7 +29,7 @@
| See Also |
Programming: Introduction to CUPS Programming
- Programming: CUPS API
+ Programming: CUPS Programming Manual
Specifications: CUPS PPD Extensions |
diff --git a/cups/api-ppd.shtml b/cups/api-ppd.shtml
index 50c4850..d7a43f4 100644
--- a/cups/api-ppd.shtml
+++ b/cups/api-ppd.shtml
@@ -1,19 +1,19 @@
-The PPD API is deprecated starting in CUPS 1.6/macOS 10.8. Please use the new Job Ticket APIs in the CUPS API documentation. These functions will be removed in a future release of CUPS.
+Note:
+
+The PPD API was deprecated in CUPS 1.6/macOS 10.8. Please use the new Job Ticket APIs in the CUPS Programming Manual documentation. These functions will be removed in a future release of CUPS.
+
The CUPS PPD API provides read-only access the data in PostScript Printer
Description ("PPD") files which are used for all printers with a driver. With
@@ -31,6 +31,7 @@ values as case-insensitive strings, so option "InputSlot" and choice "Upper"
are equivalent to "inputslot" and "upper", respectively.
+
The ppdOpenFile function "opens" a
@@ -118,6 +119,7 @@ int num_options = cupsParseOptions(argv[5], 0, &options);
cupsFreeOptions(num_options, options);
+
PPD files support specification of conflict conditions, called
@@ -128,6 +130,7 @@ the options and choices that conflict with each other. The
how many of the selected options are incompatible. Since constraints are
normally specified in pairs, the returned value is typically an even number.
+
Page sizes are special options which have physical dimensions and margins
@@ -182,6 +185,7 @@ in points. Custom page size names can also be specified in inches
ppdPageSize function will return
NULL.
+
Every PPD file is composed of one or more attributes. Most of these
diff --git a/cups/api-raster.header b/cups/api-raster.header
new file mode 100644
index 0000000..f5122d8
--- /dev/null
+++ b/cups/api-raster.header
@@ -0,0 +1,31 @@
+
+
+
Raster API
+
+
diff --git a/filter/api-raster.shtml b/cups/api-raster.shtml
similarity index 90%
rename from filter/api-raster.shtml
rename to cups/api-raster.shtml
index 6d458a2..44a6037 100644
--- a/filter/api-raster.shtml
+++ b/cups/api-raster.shtml
@@ -1,14 +1,11 @@
@@ -150,7 +147,7 @@ the memory used to read the raster file:
- - cupsRasterInterpretPPD
+ - cupsRasterInitPWGHeader
- cupsRasterWriteHeader Deprecated in CUPS 1.2/macOS 10.5
- cupsRasterWriteHeader2
- cupsRasterWritePixels
diff --git a/cups/array-private.h b/cups/array-private.h
index ff083e4..e4d7b8a 100644
--- a/cups/array-private.h
+++ b/cups/array-private.h
@@ -3,13 +3,7 @@
*
* Copyright 2011-2012 by Apple Inc.
*
- * 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.
+ * Licensed under Apache License v2.0. See the file "LICENSE" for more information.
*/
#ifndef _CUPS_ARRAY_PRIVATE_H_
@@ -36,9 +30,9 @@ extern "C" {
*/
extern int _cupsArrayAddStrings(cups_array_t *a, const char *s,
- char delim) _CUPS_API_1_5;
+ char delim) _CUPS_PRIVATE;
extern cups_array_t *_cupsArrayNewStrings(const char *s, char delim)
- _CUPS_API_1_5;
+ _CUPS_PRIVATE;
# ifdef __cplusplus
}
diff --git a/cups/array.c b/cups/array.c
index dee4f5e..860cb46 100644
--- a/cups/array.c
+++ b/cups/array.c
@@ -4,13 +4,7 @@
* Copyright 2007-2014 by Apple Inc.
* Copyright 1997-2007 by Easy Software Products.
*
- * 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.
+ * Licensed under Apache License v2.0. See the file "LICENSE" for more information.
*/
/*
@@ -19,7 +13,7 @@
#include
#include "string-private.h"
-#include "debug-private.h"
+#include "debug-internal.h"
#include "array-private.h"
diff --git a/cups/array.h b/cups/array.h
index 189c6e1..e5468a3 100644
--- a/cups/array.h
+++ b/cups/array.h
@@ -4,13 +4,7 @@
* Copyright 2007-2010 by Apple Inc.
* Copyright 1997-2007 by Easy Software Products.
*
- * 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.
+ * Licensed under Apache License v2.0. See the file "LICENSE" for more information.
*/
#ifndef _CUPS_ARRAY_H_
diff --git a/cups/attr.c b/cups/attr.c
deleted file mode 100644
index da7a725..0000000
--- a/cups/attr.c
+++ /dev/null
@@ -1,335 +0,0 @@
-/*
- * "$Id: attr.c 7584 2008-05-16 22:55:53Z mike $"
- *
- * PPD model-specific attribute routines for CUPS.
- *
- * Copyright 2007-2012 by Apple Inc.
- * Copyright 1997-2006 by Easy Software Products.
- *
- * 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
- * file is missing or damaged, see the license at "http://www.cups.org/".
- *
- * Contents:
- *
- * ppdFindAttr() - Find the first matching attribute.
- * ppdFindNextAttr() - Find the next matching attribute.
- * _ppdNormalizeMakeAndModel() - Normalize a product/make-and-model string.
- */
-
-/*
- * Include necessary headers...
- */
-
-#include "cups-private.h"
-#include "ppd-private.h"
-
-
-/*
- * 'ppdFindAttr()' - Find the first matching attribute.
- *
- * @since CUPS 1.1.19/OS X 10.3@
- */
-
-ppd_attr_t * /* O - Attribute or @code NULL@ if not found */
-ppdFindAttr(ppd_file_t *ppd, /* I - PPD file data */
- const char *name, /* I - Attribute name */
- const char *spec) /* I - Specifier string or @code NULL@ */
-{
- ppd_attr_t key, /* Search key */
- *attr; /* Current attribute */
-
-
- DEBUG_printf(("2ppdFindAttr(ppd=%p, name=\"%s\", spec=\"%s\")", ppd, name,
- spec));
-
- /*
- * Range check input...
- */
-
- if (!ppd || !name || ppd->num_attrs == 0)
- return (NULL);
-
- /*
- * Search for a matching attribute...
- */
-
- memset(&key, 0, sizeof(key));
- strlcpy(key.name, name, sizeof(key.name));
-
- /*
- * Return the first matching attribute, if any...
- */
-
- if ((attr = (ppd_attr_t *)cupsArrayFind(ppd->sorted_attrs, &key)) != NULL)
- {
- if (spec)
- {
- /*
- * Loop until we find the first matching attribute for "spec"...
- */
-
- while (attr && _cups_strcasecmp(spec, attr->spec))
- {
- if ((attr = (ppd_attr_t *)cupsArrayNext(ppd->sorted_attrs)) != NULL &&
- _cups_strcasecmp(attr->name, name))
- attr = NULL;
- }
- }
- }
-
- return (attr);
-}
-
-
-/*
- * 'ppdFindNextAttr()' - Find the next matching attribute.
- *
- * @since CUPS 1.1.19/OS X 10.3@
- */
-
-ppd_attr_t * /* O - Attribute or @code NULL@ if not found */
-ppdFindNextAttr(ppd_file_t *ppd, /* I - PPD file data */
- const char *name, /* I - Attribute name */
- const char *spec) /* I - Specifier string or @code NULL@ */
-{
- ppd_attr_t *attr; /* Current attribute */
-
-
- /*
- * Range check input...
- */
-
- if (!ppd || !name || ppd->num_attrs == 0)
- return (NULL);
-
- /*
- * See if there are more attributes to return...
- */
-
- while ((attr = (ppd_attr_t *)cupsArrayNext(ppd->sorted_attrs)) != NULL)
- {
- /*
- * Check the next attribute to see if it is a match...
- */
-
- if (_cups_strcasecmp(attr->name, name))
- {
- /*
- * Nope, reset the current pointer to the end of the array...
- */
-
- cupsArrayIndex(ppd->sorted_attrs, cupsArrayCount(ppd->sorted_attrs));
-
- return (NULL);
- }
-
- if (!spec || !_cups_strcasecmp(attr->spec, spec))
- break;
- }
-
- /*
- * Return the next attribute's value...
- */
-
- return (attr);
-}
-
-
-/*
- * '_ppdNormalizeMakeAndModel()' - Normalize a product/make-and-model string.
- *
- * This function tries to undo the mistakes made by many printer manufacturers
- * to produce a clean make-and-model string we can use.
- */
-
-char * /* O - Normalized make-and-model string or NULL on error */
-_ppdNormalizeMakeAndModel(
- const char *make_and_model, /* I - Original make-and-model string */
- char *buffer, /* I - String buffer */
- size_t bufsize) /* I - Size of string buffer */
-{
- char *bufptr; /* Pointer into buffer */
-
-
- if (!make_and_model || !buffer || bufsize < 1)
- {
- if (buffer)
- *buffer = '\0';
-
- return (NULL);
- }
-
- /*
- * Skip leading whitespace...
- */
-
- while (_cups_isspace(*make_and_model))
- make_and_model ++;
-
- /*
- * Remove parenthesis and add manufacturers as needed...
- */
-
- if (make_and_model[0] == '(')
- {
- strlcpy(buffer, make_and_model + 1, bufsize);
-
- if ((bufptr = strrchr(buffer, ')')) != NULL)
- *bufptr = '\0';
- }
- else if (!_cups_strncasecmp(make_and_model, "XPrint", 6))
- {
- /*
- * Xerox XPrint...
- */
-
- snprintf(buffer, bufsize, "Xerox %s", make_and_model);
- }
- else if (!_cups_strncasecmp(make_and_model, "Eastman", 7))
- {
- /*
- * Kodak...
- */
-
- snprintf(buffer, bufsize, "Kodak %s", make_and_model + 7);
- }
- else if (!_cups_strncasecmp(make_and_model, "laserwriter", 11))
- {
- /*
- * Apple LaserWriter...
- */
-
- snprintf(buffer, bufsize, "Apple LaserWriter%s", make_and_model + 11);
- }
- else if (!_cups_strncasecmp(make_and_model, "colorpoint", 10))
- {
- /*
- * Seiko...
- */
-
- snprintf(buffer, bufsize, "Seiko %s", make_and_model);
- }
- else if (!_cups_strncasecmp(make_and_model, "fiery", 5))
- {
- /*
- * EFI...
- */
-
- snprintf(buffer, bufsize, "EFI %s", make_and_model);
- }
- else if (!_cups_strncasecmp(make_and_model, "ps ", 3) ||
- !_cups_strncasecmp(make_and_model, "colorpass", 9))
- {
- /*
- * Canon...
- */
-
- snprintf(buffer, bufsize, "Canon %s", make_and_model);
- }
- else if (!_cups_strncasecmp(make_and_model, "primera", 7))
- {
- /*
- * Fargo...
- */
-
- snprintf(buffer, bufsize, "Fargo %s", make_and_model);
- }
- else if (!_cups_strncasecmp(make_and_model, "designjet", 9) ||
- !_cups_strncasecmp(make_and_model, "deskjet", 7))
- {
- /*
- * HP...
- */
-
- snprintf(buffer, bufsize, "HP %s", make_and_model);
- }
- else
- strlcpy(buffer, make_and_model, bufsize);
-
- /*
- * Clean up the make...
- */
-
- if (!_cups_strncasecmp(buffer, "agfa", 4))
- {
- /*
- * Replace with AGFA (all uppercase)...
- */
-
- buffer[0] = 'A';
- buffer[1] = 'G';
- buffer[2] = 'F';
- buffer[3] = 'A';
- }
- else if (!_cups_strncasecmp(buffer, "Hewlett-Packard hp ", 19))
- {
- /*
- * Just put "HP" on the front...
- */
-
- buffer[0] = 'H';
- buffer[1] = 'P';
- _cups_strcpy(buffer + 2, buffer + 18);
- }
- else if (!_cups_strncasecmp(buffer, "Hewlett-Packard ", 16))
- {
- /*
- * Just put "HP" on the front...
- */
-
- buffer[0] = 'H';
- buffer[1] = 'P';
- _cups_strcpy(buffer + 2, buffer + 15);
- }
- else if (!_cups_strncasecmp(buffer, "Lexmark International", 21))
- {
- /*
- * Strip "International"...
- */
-
- _cups_strcpy(buffer + 8, buffer + 21);
- }
- else if (!_cups_strncasecmp(buffer, "herk", 4))
- {
- /*
- * Replace with LHAG...
- */
-
- buffer[0] = 'L';
- buffer[1] = 'H';
- buffer[2] = 'A';
- buffer[3] = 'G';
- }
- else if (!_cups_strncasecmp(buffer, "linotype", 8))
- {
- /*
- * Replace with LHAG...
- */
-
- buffer[0] = 'L';
- buffer[1] = 'H';
- buffer[2] = 'A';
- buffer[3] = 'G';
- _cups_strcpy(buffer + 4, buffer + 8);
- }
-
- /*
- * Remove trailing whitespace and return...
- */
-
- for (bufptr = buffer + strlen(buffer) - 1;
- bufptr >= buffer && _cups_isspace(*bufptr);
- bufptr --);
-
- bufptr[1] = '\0';
-
- return (buffer[0] ? buffer : NULL);
-}
-
-
-/*
- * End of "$Id: attr.c 7584 2008-05-16 22:55:53Z mike $".
- */
diff --git a/cups/auth.c b/cups/auth.c
index c051c86..634ed1f 100644
--- a/cups/auth.c
+++ b/cups/auth.c
@@ -1,19 +1,13 @@
/*
* Authentication functions for CUPS.
*
- * Copyright 2007-2016 by Apple Inc.
+ * Copyright 2007-2019 by Apple Inc.
* Copyright 1997-2007 by Easy Software Products.
*
* This file contains Kerberos support code, copyright 2006 by
* Jelmer Vernooij.
*
- * 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.
+ * Licensed under Apache License v2.0. See the file "LICENSE" for more information.
*/
/*
@@ -21,21 +15,17 @@
*/
#include "cups-private.h"
+#include "debug-internal.h"
#include
#include
-#if defined(WIN32) || defined(__EMX__)
+#if defined(_WIN32) || defined(__EMX__)
# include
#else
# include
-#endif /* WIN32 || __EMX__ */
+#endif /* _WIN32 || __EMX__ */
#if HAVE_AUTHORIZATION_H
# include
-# ifdef HAVE_SECBASEPRIV_H
-# include
-# else
-extern const char *cssmErrorString(int error);
-# endif /* HAVE_SECBASEPRIV_H */
#endif /* HAVE_AUTHORIZATION_H */
#if defined(SO_PEERCRED) && defined(AF_LOCAL)
@@ -47,7 +37,14 @@ extern const char *cssmErrorString(int error);
* Local functions...
*/
+static const char *cups_auth_find(const char *www_authenticate, const char *scheme);
+static const char *cups_auth_param(const char *scheme, const char *name, char *value, size_t valsize);
+static const char *cups_auth_scheme(const char *www_authenticate, char *scheme, size_t schemesize);
+
#ifdef HAVE_GSSAPI
+# define CUPS_GSS_OK 0 /* Successfully set credentials */
+# define CUPS_GSS_NONE -1 /* No credentials */
+# define CUPS_GSS_FAIL -2 /* Failed credentials/authentication */
# ifdef HAVE_GSS_ACQUIRE_CRED_EX_F
# ifdef HAVE_GSS_GSSAPI_SPI_H
# include
@@ -112,10 +109,10 @@ cupsDoAuthentication(
const char *resource) /* I - Resource path */
{
const char *password, /* Password string */
- *www_auth; /* WWW-Authenticate header */
- char prompt[1024], /* Prompt for user */
- realm[HTTP_MAX_VALUE], /* realm="xyz" string */
- nonce[HTTP_MAX_VALUE]; /* nonce="xyz" string */
+ *www_auth, /* WWW-Authenticate header */
+ *schemedata; /* Scheme-specific data */
+ char scheme[256], /* Scheme name */
+ prompt[1024]; /* Prompt for user */
int localauth; /* Local authentication result */
_cups_globals_t *cg; /* Global data */
@@ -163,122 +160,154 @@ cupsDoAuthentication(
}
/*
- * Nope, see if we should retry the current username:password...
+ * Nope, loop through the authentication schemes to find the first we support.
*/
- www_auth = http->fields[HTTP_FIELD_WWW_AUTHENTICATE];
+ www_auth = httpGetField(http, HTTP_FIELD_WWW_AUTHENTICATE);
- if ((http->digest_tries > 1 || !http->userpass[0]) &&
- (!_cups_strncasecmp(www_auth, "Basic", 5) ||
- !_cups_strncasecmp(www_auth, "Digest", 6)))
+ for (schemedata = cups_auth_scheme(www_auth, scheme, sizeof(scheme)); schemedata; schemedata = cups_auth_scheme(schemedata + strlen(scheme), scheme, sizeof(scheme)))
{
/*
- * Nope - get a new password from the user...
+ * Check the scheme name...
*/
- char default_username[HTTP_MAX_VALUE];
- /* Default username */
-
- cg = _cupsGlobals();
-
- if (!cg->lang_default)
- cg->lang_default = cupsLangDefault();
-
- if (httpGetSubField(http, HTTP_FIELD_WWW_AUTHENTICATE, "username",
- default_username))
- cupsSetUser(default_username);
-
- snprintf(prompt, sizeof(prompt),
- _cupsLangString(cg->lang_default, _("Password for %s on %s? ")),
- cupsUser(),
- http->hostname[0] == '/' ? "localhost" : http->hostname);
-
- http->digest_tries = _cups_strncasecmp(www_auth, "Digest", 6) != 0;
- http->userpass[0] = '\0';
-
- if ((password = cupsGetPassword2(prompt, http, method, resource)) == NULL)
- {
- http->status = HTTP_STATUS_CUPS_AUTHORIZATION_CANCELED;
- return (-1);
- }
-
- snprintf(http->userpass, sizeof(http->userpass), "%s:%s", cupsUser(),
- password);
- }
- else if (http->status == HTTP_STATUS_UNAUTHORIZED)
- http->digest_tries ++;
-
- if (http->status == HTTP_STATUS_UNAUTHORIZED && http->digest_tries >= 3)
- {
- DEBUG_printf(("1cupsDoAuthentication: Too many authentication tries (%d)",
- http->digest_tries));
-
- http->status = HTTP_STATUS_CUPS_AUTHORIZATION_CANCELED;
- return (-1);
- }
-
- /*
- * Got a password; encode it for the server...
- */
+ DEBUG_printf(("2cupsDoAuthentication: Trying scheme \"%s\"...", scheme));
#ifdef HAVE_GSSAPI
- if (!_cups_strncasecmp(www_auth, "Negotiate", 9))
- {
+ if (!_cups_strcasecmp(scheme, "Negotiate"))
+ {
+ /*
+ * Kerberos authentication...
+ */
+
+ int gss_status; /* Auth status */
+
+ if ((gss_status = _cupsSetNegotiateAuthString(http, method, resource)) == CUPS_GSS_FAIL)
+ {
+ DEBUG_puts("1cupsDoAuthentication: Negotiate failed.");
+ http->status = HTTP_STATUS_CUPS_AUTHORIZATION_CANCELED;
+ return (-1);
+ }
+ else if (gss_status == CUPS_GSS_NONE)
+ {
+ DEBUG_puts("2cupsDoAuthentication: No credentials for Negotiate.");
+ continue;
+ }
+ else
+ {
+ DEBUG_puts("2cupsDoAuthentication: Using Negotiate.");
+ break;
+ }
+ }
+ else
+#endif /* HAVE_GSSAPI */
+ if (_cups_strcasecmp(scheme, "Basic") && _cups_strcasecmp(scheme, "Digest"))
+ {
+ /*
+ * Other schemes not yet supported...
+ */
+
+ DEBUG_printf(("2cupsDoAuthentication: Scheme \"%s\" not yet supported.", scheme));
+ continue;
+ }
+
/*
- * Kerberos authentication...
+ * See if we should retry the current username:password...
*/
- if (_cupsSetNegotiateAuthString(http, method, resource))
+ if ((http->digest_tries > 1 || !http->userpass[0]) && (!_cups_strcasecmp(scheme, "Basic") || (!_cups_strcasecmp(scheme, "Digest"))))
{
+ /*
+ * Nope - get a new password from the user...
+ */
+
+ char default_username[HTTP_MAX_VALUE];
+ /* Default username */
+
+ cg = _cupsGlobals();
+
+ if (!cg->lang_default)
+ cg->lang_default = cupsLangDefault();
+
+ if (cups_auth_param(schemedata, "username", default_username, sizeof(default_username)))
+ cupsSetUser(default_username);
+
+ snprintf(prompt, sizeof(prompt), _cupsLangString(cg->lang_default, _("Password for %s on %s? ")), cupsUser(), http->hostname[0] == '/' ? "localhost" : http->hostname);
+
+ http->digest_tries = _cups_strncasecmp(scheme, "Digest", 6) != 0;
+ http->userpass[0] = '\0';
+
+ if ((password = cupsGetPassword2(prompt, http, method, resource)) == NULL)
+ {
+ DEBUG_puts("1cupsDoAuthentication: User canceled password request.");
+ http->status = HTTP_STATUS_CUPS_AUTHORIZATION_CANCELED;
+ return (-1);
+ }
+
+ snprintf(http->userpass, sizeof(http->userpass), "%s:%s", cupsUser(), password);
+ }
+ else if (http->status == HTTP_STATUS_UNAUTHORIZED)
+ http->digest_tries ++;
+
+ if (http->status == HTTP_STATUS_UNAUTHORIZED && http->digest_tries >= 3)
+ {
+ DEBUG_printf(("1cupsDoAuthentication: Too many authentication tries (%d)", http->digest_tries));
+
http->status = HTTP_STATUS_CUPS_AUTHORIZATION_CANCELED;
return (-1);
}
- }
- else
-#endif /* HAVE_GSSAPI */
- if (!_cups_strncasecmp(www_auth, "Basic", 5))
- {
+
/*
- * Basic authentication...
+ * Got a password; encode it for the server...
*/
- char encode[256]; /* Base64 buffer */
+ if (!_cups_strcasecmp(scheme, "Basic"))
+ {
+ /*
+ * Basic authentication...
+ */
+ char encode[256]; /* Base64 buffer */
- httpEncode64_2(encode, sizeof(encode), http->userpass,
- (int)strlen(http->userpass));
- httpSetAuthString(http, "Basic", encode);
+ DEBUG_puts("2cupsDoAuthentication: Using Basic.");
+ httpEncode64_2(encode, sizeof(encode), http->userpass, (int)strlen(http->userpass));
+ httpSetAuthString(http, "Basic", encode);
+ break;
+ }
+ else if (!_cups_strcasecmp(scheme, "Digest"))
+ {
+ /*
+ * Digest authentication...
+ */
+
+ char nonce[HTTP_MAX_VALUE]; /* nonce="xyz" string */
+
+ cups_auth_param(schemedata, "algorithm", http->algorithm, sizeof(http->algorithm));
+ cups_auth_param(schemedata, "opaque", http->opaque, sizeof(http->opaque));
+ cups_auth_param(schemedata, "nonce", nonce, sizeof(nonce));
+ cups_auth_param(schemedata, "realm", http->realm, sizeof(http->realm));
+
+ if (_httpSetDigestAuthString(http, nonce, method, resource))
+ {
+ DEBUG_puts("2cupsDoAuthentication: Using Basic.");
+ break;
+ }
+ }
}
- else if (!_cups_strncasecmp(www_auth, "Digest", 6))
+
+ if (http->authstring)
{
- /*
- * Digest authentication...
- */
+ DEBUG_printf(("1cupsDoAuthentication: authstring=\"%s\".", http->authstring));
- char encode[33], /* MD5 buffer */
- digest[1024]; /* Digest auth data */
-
- httpGetSubField(http, HTTP_FIELD_WWW_AUTHENTICATE, "realm", realm);
- httpGetSubField(http, HTTP_FIELD_WWW_AUTHENTICATE, "nonce", nonce);
-
- httpMD5(cupsUser(), realm, strchr(http->userpass, ':') + 1, encode);
- httpMD5Final(nonce, method, resource, encode);
- snprintf(digest, sizeof(digest),
- "username=\"%s\", realm=\"%s\", nonce=\"%s\", uri=\"%s\", "
- "response=\"%s\"", cupsUser(), realm, nonce, resource, encode);
- httpSetAuthString(http, "Digest", digest);
+ return (0);
}
else
{
- DEBUG_printf(("1cupsDoAuthentication: Unknown auth type: \"%s\"",
- www_auth));
+ DEBUG_puts("1cupsDoAuthentication: No supported schemes.");
http->status = HTTP_STATUS_CUPS_AUTHORIZATION_CANCELED;
+
return (-1);
}
-
- DEBUG_printf(("1cupsDoAuthentication: authstring=\"%s\"", http->authstring));
-
- return (0);
}
@@ -287,7 +316,7 @@ cupsDoAuthentication(
* '_cupsSetNegotiateAuthString()' - Set the Kerberos authentication string.
*/
-int /* O - 0 on success, -1 on error */
+int /* O - 0 on success, negative on error */
_cupsSetNegotiateAuthString(
http_t *http, /* I - Connection to server */
const char *method, /* I - Request method ("GET", "POST", "PUT") */
@@ -312,10 +341,16 @@ _cupsSetNegotiateAuthString(
{
DEBUG_puts("1_cupsSetNegotiateAuthString: Weak-linked GSSAPI/Kerberos "
"framework is not present");
- return (-1);
+ return (CUPS_GSS_NONE);
}
# endif /* __APPLE__ */
+ if (!strcmp(http->hostname, "localhost") || http->hostname[0] == '/' || isdigit(http->hostname[0] & 255) || !strchr(http->hostname, '.'))
+ {
+ DEBUG_printf(("1_cupsSetNegotiateAuthString: Kerberos not available for host \"%s\".", http->hostname));
+ return (CUPS_GSS_NONE);
+ }
+
if (http->gssname == GSS_C_NO_NAME)
{
http->gssname = cups_gss_getname(http, _cupsGSSServiceName());
@@ -336,7 +371,7 @@ _cupsSetNegotiateAuthString(
GSS_C_NO_BUFFER, &http->gssmech,
&output_token, NULL, NULL);
-#ifdef HAVE_GSS_ACQUIRE_CRED_EX_F
+# ifdef HAVE_GSS_ACQUIRE_CRED_EX_F
if (major_status == GSS_S_NO_CRED)
{
/*
@@ -360,7 +395,7 @@ _cupsSetNegotiateAuthString(
cupsUser(), http->gsshost);
if ((password = cupsGetPassword2(prompt, http, method, resource)) == NULL)
- return (-1);
+ return (CUPS_GSS_FAIL);
/*
* Try to acquire credentials...
@@ -412,21 +447,23 @@ _cupsSetNegotiateAuthString(
}
}
}
-#endif /* HAVE_GSS_ACQUIRED_CRED_EX_F */
+# endif /* HAVE_GSS_ACQUIRED_CRED_EX_F */
- if (GSS_ERROR(major_status))
+ if (major_status == GSS_S_NO_CRED)
{
- cups_gss_printf(major_status, minor_status,
- "_cupsSetNegotiateAuthString: Unable to initialize "
- "security context");
- return (-1);
+ cups_gss_printf(major_status, minor_status, "_cupsSetNegotiateAuthString: No credentials");
+ return (CUPS_GSS_NONE);
+ }
+ else if (GSS_ERROR(major_status))
+ {
+ cups_gss_printf(major_status, minor_status, "_cupsSetNegotiateAuthString: Unable to initialize security context");
+ return (CUPS_GSS_FAIL);
}
-#ifdef DEBUG
+# ifdef DEBUG
else if (major_status == GSS_S_CONTINUE_NEEDED)
- cups_gss_printf(major_status, minor_status,
- "_cupsSetNegotiateAuthString: Continuation needed!");
-#endif /* DEBUG */
+ cups_gss_printf(major_status, minor_status, "_cupsSetNegotiateAuthString: Continuation needed");
+# endif /* DEBUG */
if (output_token.length > 0 && output_token.length <= 65536)
{
@@ -436,7 +473,7 @@ _cupsSetNegotiateAuthString(
*/
int authsize = 10 + /* "Negotiate " */
- (int)output_token.length * 4 / 3 + 1 + 1;
+ (((int)output_token.length * 4 / 3 + 3) & ~3) + 1;
/* Base64 + nul */
httpSetAuthString(http, NULL, NULL);
@@ -459,13 +496,264 @@ _cupsSetNegotiateAuthString(
"large - %d bytes!", (int)output_token.length));
gss_release_buffer(&minor_status, &output_token);
- return (-1);
+ return (CUPS_GSS_FAIL);
}
- return (0);
+ return (CUPS_GSS_OK);
+}
+#endif /* HAVE_GSSAPI */
+
+
+/*
+ * 'cups_auth_find()' - Find the named WWW-Authenticate scheme.
+ *
+ * The "www_authenticate" parameter points to the current position in the header.
+ *
+ * Returns @code NULL@ if the auth scheme is not present.
+ */
+
+static const char * /* O - Start of matching scheme or @code NULL@ if not found */
+cups_auth_find(const char *www_authenticate, /* I - Pointer into WWW-Authenticate header */
+ const char *scheme) /* I - Authentication scheme */
+{
+ size_t schemelen = strlen(scheme); /* Length of scheme */
+
+
+ DEBUG_printf(("8cups_auth_find(www_authenticate=\"%s\", scheme=\"%s\"(%d))", www_authenticate, scheme, (int)schemelen));
+
+ while (*www_authenticate)
+ {
+ /*
+ * Skip leading whitespace and commas...
+ */
+
+ DEBUG_printf(("9cups_auth_find: Before whitespace: \"%s\"", www_authenticate));
+ while (isspace(*www_authenticate & 255) || *www_authenticate == ',')
+ www_authenticate ++;
+ DEBUG_printf(("9cups_auth_find: After whitespace: \"%s\"", www_authenticate));
+
+ /*
+ * See if this is "Scheme" followed by whitespace or the end of the string.
+ */
+
+ if (!strncmp(www_authenticate, scheme, schemelen) && (isspace(www_authenticate[schemelen] & 255) || www_authenticate[schemelen] == ',' || !www_authenticate[schemelen]))
+ {
+ /*
+ * Yes, this is the start of the scheme-specific information...
+ */
+
+ DEBUG_printf(("9cups_auth_find: Returning \"%s\".", www_authenticate));
+
+ return (www_authenticate);
+ }
+
+ /*
+ * Skip the scheme name or param="value" string...
+ */
+
+ while (!isspace(*www_authenticate & 255) && *www_authenticate)
+ {
+ if (*www_authenticate == '\"')
+ {
+ /*
+ * Skip quoted value...
+ */
+
+ www_authenticate ++;
+ while (*www_authenticate && *www_authenticate != '\"')
+ www_authenticate ++;
+
+ DEBUG_printf(("9cups_auth_find: After quoted: \"%s\"", www_authenticate));
+ }
+
+ www_authenticate ++;
+ }
+
+ DEBUG_printf(("9cups_auth_find: After skip: \"%s\"", www_authenticate));
+ }
+
+ DEBUG_puts("9cups_auth_find: Returning NULL.");
+
+ return (NULL);
}
+/*
+ * 'cups_auth_param()' - Copy the value for the named authentication parameter,
+ * if present.
+ */
+
+static const char * /* O - Parameter value or @code NULL@ if not present */
+cups_auth_param(const char *scheme, /* I - Pointer to auth data */
+ const char *name, /* I - Name of parameter */
+ char *value, /* I - Value buffer */
+ size_t valsize) /* I - Size of value buffer */
+{
+ char *valptr = value, /* Pointer into value buffer */
+ *valend = value + valsize - 1; /* Pointer to end of buffer */
+ size_t namelen = strlen(name); /* Name length */
+ int param; /* Is this a parameter? */
+
+
+ DEBUG_printf(("8cups_auth_param(scheme=\"%s\", name=\"%s\", value=%p, valsize=%d)", scheme, name, (void *)value, (int)valsize));
+
+ while (!isspace(*scheme & 255) && *scheme)
+ scheme ++;
+
+ while (*scheme)
+ {
+ while (isspace(*scheme & 255) || *scheme == ',')
+ scheme ++;
+
+ if (!strncmp(scheme, name, namelen) && scheme[namelen] == '=')
+ {
+ /*
+ * Found the parameter, copy the value...
+ */
+
+ scheme += namelen + 1;
+ if (*scheme == '\"')
+ {
+ scheme ++;
+
+ while (*scheme && *scheme != '\"')
+ {
+ if (valptr < valend)
+ *valptr++ = *scheme;
+
+ scheme ++;
+ }
+ }
+ else
+ {
+ while (*scheme && strchr("ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-._~+/=", *scheme))
+ {
+ if (valptr < valend)
+ *valptr++ = *scheme;
+
+ scheme ++;
+ }
+ }
+
+ *valptr = '\0';
+
+ DEBUG_printf(("9cups_auth_param: Returning \"%s\".", value));
+
+ return (value);
+ }
+
+ /*
+ * Skip the param=value string...
+ */
+
+ param = 0;
+
+ while (!isspace(*scheme & 255) && *scheme)
+ {
+ if (*scheme == '=')
+ param = 1;
+ else if (*scheme == '\"')
+ {
+ /*
+ * Skip quoted value...
+ */
+
+ scheme ++;
+ while (*scheme && *scheme != '\"')
+ scheme ++;
+ }
+
+ scheme ++;
+ }
+
+ /*
+ * If this wasn't a parameter, we are at the end of this scheme's
+ * parameters...
+ */
+
+ if (!param)
+ break;
+ }
+
+ *value = '\0';
+
+ DEBUG_puts("9cups_auth_param: Returning NULL.");
+
+ return (NULL);
+}
+
+
+/*
+ * 'cups_auth_scheme()' - Get the (next) WWW-Authenticate scheme.
+ *
+ * The "www_authenticate" parameter points to the current position in the header.
+ *
+ * Returns @code NULL@ if there are no (more) auth schemes present.
+ */
+
+static const char * /* O - Start of scheme or @code NULL@ if not found */
+cups_auth_scheme(const char *www_authenticate, /* I - Pointer into WWW-Authenticate header */
+ char *scheme, /* I - Scheme name buffer */
+ size_t schemesize) /* I - Size of buffer */
+{
+ const char *start; /* Start of scheme data */
+ char *sptr = scheme, /* Pointer into scheme buffer */
+ *send = scheme + schemesize - 1;/* End of scheme buffer */
+ int param; /* Is this a parameter? */
+
+
+ DEBUG_printf(("8cups_auth_scheme(www_authenticate=\"%s\", scheme=%p, schemesize=%d)", www_authenticate, (void *)scheme, (int)schemesize));
+
+ while (*www_authenticate)
+ {
+ /*
+ * Skip leading whitespace and commas...
+ */
+
+ while (isspace(*www_authenticate & 255) || *www_authenticate == ',')
+ www_authenticate ++;
+
+ /*
+ * Parse the scheme name or param="value" string...
+ */
+
+ for (sptr = scheme, start = www_authenticate, param = 0; *www_authenticate && *www_authenticate != ',' && !isspace(*www_authenticate & 255); www_authenticate ++)
+ {
+ if (*www_authenticate == '=')
+ param = 1;
+ else if (!param && sptr < send)
+ *sptr++ = *www_authenticate;
+ else if (*www_authenticate == '\"')
+ {
+ /*
+ * Skip quoted value...
+ */
+
+ www_authenticate ++;
+ while (*www_authenticate && *www_authenticate != '\"')
+ www_authenticate ++;
+ }
+ }
+
+ if (sptr > scheme && !param)
+ {
+ *sptr = '\0';
+
+ DEBUG_printf(("9cups_auth_scheme: Returning \"%s\".", start));
+
+ return (start);
+ }
+ }
+
+ *scheme = '\0';
+
+ DEBUG_puts("9cups_auth_scheme: Returning NULL.");
+
+ return (NULL);
+}
+
+
+#ifdef HAVE_GSSAPI
# ifdef HAVE_GSS_ACQUIRE_CRED_EX_F
/*
* 'cups_gss_acquire()' - Kerberos credentials callback.
@@ -639,9 +927,9 @@ static int /* O - 0 if available */
/* -1 error */
cups_local_auth(http_t *http) /* I - HTTP connection to server */
{
-#if defined(WIN32) || defined(__EMX__)
+#if defined(_WIN32) || defined(__EMX__)
/*
- * Currently WIN32 and OS-2 do not support the CUPS server...
+ * Currently _WIN32 and OS-2 do not support the CUPS server...
*/
return (1);
@@ -650,6 +938,8 @@ cups_local_auth(http_t *http) /* I - HTTP connection to server */
FILE *fp; /* Certificate file */
char trc[16], /* Try Root Certificate parameter */
filename[1024]; /* Certificate filename */
+ const char *www_auth, /* WWW-Authenticate header */
+ *schemedata; /* Data for the named auth scheme */
_cups_globals_t *cg = _cupsGlobals(); /* Global data */
# if defined(HAVE_AUTHORIZATION_H)
OSStatus status; /* Status */
@@ -668,13 +958,14 @@ cups_local_auth(http_t *http) /* I - HTTP connection to server */
* See if we are accessing localhost...
*/
- if (!httpAddrLocalhost(http->hostaddr) &&
- _cups_strcasecmp(http->hostname, "localhost") != 0)
+ if (!httpAddrLocalhost(http->hostaddr) && _cups_strcasecmp(http->hostname, "localhost") != 0)
{
DEBUG_puts("8cups_local_auth: Not a local connection!");
return (1);
}
+ www_auth = httpGetField(http, HTTP_FIELD_WWW_AUTHENTICATE);
+
# if defined(HAVE_AUTHORIZATION_H)
/*
* Delete any previous authorization reference...
@@ -686,16 +977,13 @@ cups_local_auth(http_t *http) /* I - HTTP connection to server */
http->auth_ref = NULL;
}
- if (!getenv("GATEWAY_INTERFACE") &&
- httpGetSubField2(http, HTTP_FIELD_WWW_AUTHENTICATE, "authkey",
- auth_key, sizeof(auth_key)))
+ if (!getenv("GATEWAY_INTERFACE") && (schemedata = cups_auth_find(www_auth, "AuthRef")) != NULL && cups_auth_param(schemedata, "key", auth_key, sizeof(auth_key)))
{
- status = AuthorizationCreate(NULL, kAuthorizationEmptyEnvironment,
- kAuthorizationFlagDefaults, &http->auth_ref);
+ status = AuthorizationCreate(NULL, kAuthorizationEmptyEnvironment, kAuthorizationFlagDefaults, &http->auth_ref);
if (status != errAuthorizationSuccess)
{
- DEBUG_printf(("8cups_local_auth: AuthorizationCreate() returned %d (%s)",
- (int)status, cssmErrorString(status)));
+ DEBUG_printf(("8cups_local_auth: AuthorizationCreate() returned %d",
+ (int)status));
return (-1);
}
@@ -736,8 +1024,7 @@ cups_local_auth(http_t *http) /* I - HTTP connection to server */
else if (status == errAuthorizationCanceled)
return (-1);
- DEBUG_printf(("9cups_local_auth: AuthorizationCopyRights() returned %d (%s)",
- (int)status, cssmErrorString(status)));
+ DEBUG_printf(("9cups_local_auth: AuthorizationCopyRights() returned %d", (int)status));
/*
* Fall through to try certificates...
@@ -745,6 +1032,11 @@ cups_local_auth(http_t *http) /* I - HTTP connection to server */
}
# endif /* HAVE_AUTHORIZATION_H */
+# ifdef HAVE_GSSAPI
+ if (cups_auth_find(www_auth, "Negotiate"))
+ return (1);
+# endif /* HAVE_GSSAPI */
+
# if defined(SO_PEERCRED) && defined(AF_LOCAL)
/*
* See if we can authenticate using the peer credentials provided over a
@@ -752,16 +1044,9 @@ cups_local_auth(http_t *http) /* I - HTTP connection to server */
* information...
*/
- if (
-# ifdef HAVE_GSSAPI
- _cups_strncasecmp(http->fields[HTTP_FIELD_WWW_AUTHENTICATE], "Negotiate", 9) &&
-# endif /* HAVE_GSSAPI */
-# ifdef HAVE_AUTHORIZATION_H
- !httpGetSubField2(http, HTTP_FIELD_WWW_AUTHENTICATE, "authkey",
- auth_key, sizeof(auth_key)) &&
-# endif /* HAVE_AUTHORIZATION_H */
- http->hostaddr->addr.sa_family == AF_LOCAL &&
- !getenv("GATEWAY_INTERFACE")) /* Not via CGI programs... */
+ if (http->hostaddr->addr.sa_family == AF_LOCAL &&
+ !getenv("GATEWAY_INTERFACE") && /* Not via CGI programs... */
+ cups_auth_find(www_auth, "PeerCred"))
{
/*
* Verify that the current cupsUser() matches the current UID...
@@ -784,6 +1069,9 @@ cups_local_auth(http_t *http) /* I - HTTP connection to server */
}
# endif /* SO_PEERCRED && AF_LOCAL */
+ if ((schemedata = cups_auth_find(www_auth, "Local")) == NULL)
+ return (1);
+
/*
* Try opening a certificate file for this PID. If that fails,
* try the root certificate...
@@ -797,33 +1085,9 @@ cups_local_auth(http_t *http) /* I - HTTP connection to server */
* No certificate for this PID; see if we can get the root certificate...
*/
- DEBUG_printf(("9cups_local_auth: Unable to open file %s: %s",
- filename, strerror(errno)));
+ DEBUG_printf(("9cups_local_auth: Unable to open file \"%s\": %s", filename, strerror(errno)));
-# ifdef HAVE_GSSAPI
- if (!_cups_strncasecmp(http->fields[HTTP_FIELD_WWW_AUTHENTICATE], "Negotiate", 9))
- {
- /*
- * Kerberos required, don't try the root certificate...
- */
-
- return (1);
- }
-# endif /* HAVE_GSSAPI */
-
-# ifdef HAVE_AUTHORIZATION_H
- if (httpGetSubField2(http, HTTP_FIELD_WWW_AUTHENTICATE, "authkey",
- auth_key, sizeof(auth_key)))
- {
- /*
- * Don't use the root certificate as a replacement for an authkey...
- */
-
- return (1);
- }
-# endif /* HAVE_AUTHORIZATION_H */
- if (!httpGetSubField2(http, HTTP_FIELD_WWW_AUTHENTICATE, "trc", trc,
- sizeof(trc)))
+ if (!cups_auth_param(schemedata, "trc", trc, sizeof(trc)))
{
/*
* Scheduler doesn't want us to use the root certificate...
@@ -833,7 +1097,8 @@ cups_local_auth(http_t *http) /* I - HTTP connection to server */
}
snprintf(filename, sizeof(filename), "%s/certs/0", cg->cups_statedir);
- fp = fopen(filename, "r");
+ if ((fp = fopen(filename, "r")) == NULL)
+ DEBUG_printf(("9cups_local_auth: Unable to open file \"%s\": %s", filename, strerror(errno)));
}
if (fp)
@@ -864,5 +1129,5 @@ cups_local_auth(http_t *http) /* I - HTTP connection to server */
}
return (1);
-#endif /* WIN32 || __EMX__ */
+#endif /* _WIN32 || __EMX__ */
}
diff --git a/cups/backchannel.c b/cups/backchannel.c
index e804d45..916c314 100644
--- a/cups/backchannel.c
+++ b/cups/backchannel.c
@@ -4,13 +4,7 @@
* Copyright 2007-2014 by Apple Inc.
* Copyright 1997-2007 by Easy Software Products.
*
- * 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.
+ * Licensed under Apache License v2.0. See the file "LICENSE" for more information.
*/
/*
@@ -18,13 +12,14 @@
*/
#include "cups.h"
+#include "sidechannel.h"
#include
-#ifdef WIN32
+#ifdef _WIN32
# include
# include
#else
# include
-#endif /* WIN32 */
+#endif /* _WIN32 */
/*
@@ -77,11 +72,11 @@ cupsBackChannelRead(char *buffer, /* I - Buffer to read into */
* Read bytes from the pipe...
*/
-#ifdef WIN32
+#ifdef _WIN32
return ((ssize_t)_read(3, buffer, (unsigned)bytes));
#else
return (read(3, buffer, bytes));
-#endif /* WIN32 */
+#endif /* _WIN32 */
}
@@ -139,11 +134,11 @@ cupsBackChannelWrite(
* Write bytes to the pipe...
*/
-#ifdef WIN32
+#ifdef _WIN32
count = (ssize_t)_write(3, buffer, (unsigned)(bytes - total));
#else
count = write(3, buffer, bytes - total);
-#endif /* WIN32 */
+#endif /* _WIN32 */
if (count < 0)
{
diff --git a/cups/backend.c b/cups/backend.c
index f164617..4f5099b 100644
--- a/cups/backend.c
+++ b/cups/backend.c
@@ -4,13 +4,7 @@
* Copyright 2007-2015 by Apple Inc.
* Copyright 2006 by Easy Software Products.
*
- * 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.
+ * Licensed under Apache License v2.0. See the file "LICENSE" for more information.
*/
/*
diff --git a/cups/backend.h b/cups/backend.h
index 274bcd4..a8c5ec1 100644
--- a/cups/backend.h
+++ b/cups/backend.h
@@ -4,13 +4,7 @@
* Copyright 2007-2011 by Apple Inc.
* Copyright 1997-2005 by Easy Software Products.
*
- * 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.
+ * Licensed under Apache License v2.0. See the file "LICENSE" for more information.
*/
#ifndef _CUPS_BACKEND_H_
diff --git a/cups/conflicts.c b/cups/conflicts.c
deleted file mode 100644
index f0d01b0..0000000
--- a/cups/conflicts.c
+++ /dev/null
@@ -1,1214 +0,0 @@
-/*
- * "$Id: conflicts.c 3794 2012-04-23 22:44:16Z msweet $"
- *
- * Option marking routines for CUPS.
- *
- * Copyright 2007-2012 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
- * file is missing or damaged, see the license at "http://www.cups.org/".
- *
- * PostScript is a trademark of Adobe Systems, Inc.
- *
- * This file is subject to the Apple OS-Developed Software exception.
- *
- * Contents:
- *
- * cupsGetConflicts() - Get a list of conflicting options in a marked
- * PPD.
- * cupsResolveConflicts() - Resolve conflicts in a marked PPD.
- * ppdConflicts() - Check to see if there are any conflicts among
- * the marked option choices.
- * ppdInstallableConflict() - Test whether an option choice conflicts with an
- * installable option.
- * ppd_is_installable() - Determine whether an option is in the
- * InstallableOptions group.
- * ppd_load_constraints() - Load constraints from a PPD file.
- * ppd_test_constraints() - See if any constraints are active.
- */
-
-/*
- * Include necessary headers...
- */
-
-#include "cups-private.h"
-#include "ppd-private.h"
-
-
-/*
- * Local constants...
- */
-
-enum
-{
- _PPD_NORMAL_CONSTRAINTS,
- _PPD_OPTION_CONSTRAINTS,
- _PPD_INSTALLABLE_CONSTRAINTS,
- _PPD_ALL_CONSTRAINTS
-};
-
-
-/*
- * Local functions...
- */
-
-static int ppd_is_installable(ppd_group_t *installable,
- const char *option);
-static void ppd_load_constraints(ppd_file_t *ppd);
-static cups_array_t *ppd_test_constraints(ppd_file_t *ppd,
- const char *option,
- const char *choice,
- int num_options,
- cups_option_t *options,
- int which);
-
-
-/*
- * 'cupsGetConflicts()' - Get a list of conflicting options in a marked PPD.
- *
- * This function gets a list of options that would conflict if "option" and
- * "choice" were marked in the PPD. You would typically call this function
- * after marking the currently selected options in the PPD in order to
- * determine whether a new option selection would cause a conflict.
- *
- * The number of conflicting options are returned with "options" pointing to
- * the conflicting options. The returned option array must be freed using
- * @link cupsFreeOptions@.
- *
- * @since CUPS 1.4/OS X 10.6@
- */
-
-int /* O - Number of conflicting options */
-cupsGetConflicts(
- ppd_file_t *ppd, /* I - PPD file */
- const char *option, /* I - Option to test */
- const char *choice, /* I - Choice to test */
- cups_option_t **options) /* O - Conflicting options */
-{
- int i, /* Looping var */
- num_options; /* Number of conflicting options */
- cups_array_t *active; /* Active conflicts */
- _ppd_cups_uiconsts_t *c; /* Current constraints */
- _ppd_cups_uiconst_t *cptr; /* Current constraint */
- ppd_choice_t *marked; /* Marked choice */
-
-
- /*
- * Range check input...
- */
-
- if (options)
- *options = NULL;
-
- if (!ppd || !option || !choice || !options)
- return (0);
-
- /*
- * Test for conflicts...
- */
-
- active = ppd_test_constraints(ppd, option, choice, 0, NULL,
- _PPD_ALL_CONSTRAINTS);
-
- /*
- * Loop through all of the UI constraints and add any options that conflict...
- */
-
- for (num_options = 0, c = (_ppd_cups_uiconsts_t *)cupsArrayFirst(active);
- c;
- c = (_ppd_cups_uiconsts_t *)cupsArrayNext(active))
- {
- for (i = c->num_constraints, cptr = c->constraints;
- i > 0;
- i --, cptr ++)
- if (_cups_strcasecmp(cptr->option->keyword, option))
- {
- if (cptr->choice)
- num_options = cupsAddOption(cptr->option->keyword,
- cptr->choice->choice, num_options,
- options);
- else if ((marked = ppdFindMarkedChoice(ppd,
- cptr->option->keyword)) != NULL)
- num_options = cupsAddOption(cptr->option->keyword, marked->choice,
- num_options, options);
- }
- }
-
- cupsArrayDelete(active);
-
- return (num_options);
-}
-
-
-/*
- * 'cupsResolveConflicts()' - Resolve conflicts in a marked PPD.
- *
- * This function attempts to resolve any conflicts in a marked PPD, returning
- * a list of option changes that are required to resolve them. On input,
- * "num_options" and "options" contain any pending option changes that have
- * not yet been marked, while "option" and "choice" contain the most recent
- * selection which may or may not be in "num_options" or "options".
- *
- * On successful return, "num_options" and "options" are updated to contain
- * "option" and "choice" along with any changes required to resolve conflicts
- * specified in the PPD file and 1 is returned.
- *
- * If option conflicts cannot be resolved, "num_options" and "options" are not
- * changed and 0 is returned.
- *
- * When resolving conflicts, @code cupsResolveConflicts@ does not consider
- * changes to the current page size (@code media@, @code PageSize@, and
- * @code PageRegion@) or to the most recent option specified in "option".
- * Thus, if the only way to resolve a conflict is to change the page size
- * or the option the user most recently changed, @code cupsResolveConflicts@
- * will return 0 to indicate it was unable to resolve the conflicts.
- *
- * The @code cupsResolveConflicts@ function uses one of two sources of option
- * constraint information. The preferred constraint information is defined by
- * @code cupsUIConstraints@ and @code cupsUIResolver@ attributes - in this
- * case, the PPD file provides constraint resolution actions.
- *
- * The backup constraint information is defined by the
- * @code UIConstraints@ and @code NonUIConstraints@ attributes. These
- * constraints are resolved algorithmically by first selecting the default
- * choice for the conflicting option, then iterating over all possible choices
- * until a non-conflicting option choice is found.
- *
- * @since CUPS 1.4/OS X 10.6@
- */
-
-int /* O - 1 on success, 0 on failure */
-cupsResolveConflicts(
- ppd_file_t *ppd, /* I - PPD file */
- const char *option, /* I - Newly selected option or @code NULL@ for none */
- const char *choice, /* I - Newly selected choice or @code NULL@ for none */
- int *num_options, /* IO - Number of additional selected options */
- cups_option_t **options) /* IO - Additional selected options */
-{
- int i, /* Looping var */
- tries, /* Number of tries */
- num_newopts; /* Number of new options */
- cups_option_t *newopts; /* New options */
- cups_array_t *active, /* Active constraints */
- *pass, /* Resolvers for this pass */
- *resolvers, /* Resolvers we have used */
- *test; /* Test array for conflicts */
- _ppd_cups_uiconsts_t *consts; /* Current constraints */
- _ppd_cups_uiconst_t *constptr; /* Current constraint */
- ppd_attr_t *resolver; /* Current resolver */
- const char *resval; /* Pointer into resolver value */
- char resoption[PPD_MAX_NAME],
- /* Current resolver option */
- reschoice[PPD_MAX_NAME],
- /* Current resolver choice */
- *resptr, /* Pointer into option/choice */
- firstpage[255]; /* AP_FIRSTPAGE_Keyword string */
- const char *value; /* Selected option value */
- int changed; /* Did we change anything? */
- ppd_choice_t *marked; /* Marked choice */
-
-
- /*
- * Range check input...
- */
-
- if (!ppd || !num_options || !options || (option == NULL) != (choice == NULL))
- return (0);
-
- /*
- * Build a shadow option array...
- */
-
- num_newopts = 0;
- newopts = NULL;
-
- for (i = 0; i < *num_options; i ++)
- num_newopts = cupsAddOption((*options)[i].name, (*options)[i].value,
- num_newopts, &newopts);
- if (option && _cups_strcasecmp(option, "Collate"))
- num_newopts = cupsAddOption(option, choice, num_newopts, &newopts);
-
- /*
- * Loop until we have no conflicts...
- */
-
- cupsArraySave(ppd->sorted_attrs);
-
- resolvers = NULL;
- pass = cupsArrayNew((cups_array_func_t)_cups_strcasecmp, NULL);
- tries = 0;
-
- while (tries < 100 &&
- (active = ppd_test_constraints(ppd, NULL, NULL, num_newopts, newopts,
- _PPD_ALL_CONSTRAINTS)) != NULL)
- {
- tries ++;
-
- if (!resolvers)
- resolvers = cupsArrayNew((cups_array_func_t)_cups_strcasecmp, NULL);
-
- for (consts = (_ppd_cups_uiconsts_t *)cupsArrayFirst(active), changed = 0;
- consts;
- consts = (_ppd_cups_uiconsts_t *)cupsArrayNext(active))
- {
- if (consts->resolver[0])
- {
- /*
- * Look up the resolver...
- */
-
- if (cupsArrayFind(pass, consts->resolver))
- continue; /* Already applied this resolver... */
-
- if (cupsArrayFind(resolvers, consts->resolver))
- {
- /*
- * Resolver loop!
- */
-
- DEBUG_printf(("1cupsResolveConflicts: Resolver loop with %s!",
- consts->resolver));
- goto error;
- }
-
- if ((resolver = ppdFindAttr(ppd, "cupsUIResolver",
- consts->resolver)) == NULL)
- {
- DEBUG_printf(("1cupsResolveConflicts: Resolver %s not found!",
- consts->resolver));
- goto error;
- }
-
- if (!resolver->value)
- {
- DEBUG_printf(("1cupsResolveConflicts: Resolver %s has no value!",
- consts->resolver));
- goto error;
- }
-
- /*
- * Add the options from the resolver...
- */
-
- cupsArrayAdd(pass, consts->resolver);
- cupsArrayAdd(resolvers, consts->resolver);
-
- for (resval = resolver->value; *resval && !changed;)
- {
- while (_cups_isspace(*resval))
- resval ++;
-
- if (*resval != '*')
- break;
-
- for (resval ++, resptr = resoption;
- *resval && !_cups_isspace(*resval);
- resval ++)
- if (resptr < (resoption + sizeof(resoption) - 1))
- *resptr++ = *resval;
-
- *resptr = '\0';
-
- while (_cups_isspace(*resval))
- resval ++;
-
- for (resptr = reschoice;
- *resval && !_cups_isspace(*resval);
- resval ++)
- if (resptr < (reschoice + sizeof(reschoice) - 1))
- *resptr++ = *resval;
-
- *resptr = '\0';
-
- if (!resoption[0] || !reschoice[0])
- break;
-
- /*
- * Is this the option we are changing?
- */
-
- snprintf(firstpage, sizeof(firstpage), "AP_FIRSTPAGE_%s", resoption);
-
- if (option &&
- (!_cups_strcasecmp(resoption, option) ||
- !_cups_strcasecmp(firstpage, option) ||
- (!_cups_strcasecmp(option, "PageSize") &&
- !_cups_strcasecmp(resoption, "PageRegion")) ||
- (!_cups_strcasecmp(option, "AP_FIRSTPAGE_PageSize") &&
- !_cups_strcasecmp(resoption, "PageSize")) ||
- (!_cups_strcasecmp(option, "AP_FIRSTPAGE_PageSize") &&
- !_cups_strcasecmp(resoption, "PageRegion")) ||
- (!_cups_strcasecmp(option, "PageRegion") &&
- !_cups_strcasecmp(resoption, "PageSize")) ||
- (!_cups_strcasecmp(option, "AP_FIRSTPAGE_PageRegion") &&
- !_cups_strcasecmp(resoption, "PageSize")) ||
- (!_cups_strcasecmp(option, "AP_FIRSTPAGE_PageRegion") &&
- !_cups_strcasecmp(resoption, "PageRegion"))))
- continue;
-
- /*
- * Try this choice...
- */
-
- if ((test = ppd_test_constraints(ppd, resoption, reschoice,
- num_newopts, newopts,
- _PPD_ALL_CONSTRAINTS)) == NULL)
- {
- /*
- * That worked...
- */
-
- changed = 1;
- }
- else
- cupsArrayDelete(test);
-
- /*
- * Add the option/choice from the resolver regardless of whether it
- * worked; this makes sure that we can cascade several changes to
- * make things resolve...
- */
-
- num_newopts = cupsAddOption(resoption, reschoice, num_newopts,
- &newopts);
- }
- }
- else
- {
- /*
- * Try resolving by choosing the default values for non-installable
- * options, then by iterating through the possible choices...
- */
-
- int j; /* Looping var */
- ppd_choice_t *cptr; /* Current choice */
- ppd_size_t *size; /* Current page size */
-
-
- for (i = consts->num_constraints, constptr = consts->constraints;
- i > 0 && !changed;
- i --, constptr ++)
- {
- /*
- * Can't resolve by changing an installable option...
- */
-
- if (constptr->installable)
- continue;
-
- /*
- * Is this the option we are changing?
- */
-
- if (option &&
- (!_cups_strcasecmp(constptr->option->keyword, option) ||
- (!_cups_strcasecmp(option, "PageSize") &&
- !_cups_strcasecmp(constptr->option->keyword, "PageRegion")) ||
- (!_cups_strcasecmp(option, "PageRegion") &&
- !_cups_strcasecmp(constptr->option->keyword, "PageSize"))))
- continue;
-
- /*
- * Get the current option choice...
- */
-
- if ((value = cupsGetOption(constptr->option->keyword, num_newopts,
- newopts)) == NULL)
- {
- if (!_cups_strcasecmp(constptr->option->keyword, "PageSize") ||
- !_cups_strcasecmp(constptr->option->keyword, "PageRegion"))
- {
- if ((value = cupsGetOption("PageSize", num_newopts,
- newopts)) == NULL)
- value = cupsGetOption("PageRegion", num_newopts, newopts);
-
- if (!value)
- {
- if ((size = ppdPageSize(ppd, NULL)) != NULL)
- value = size->name;
- else
- value = "";
- }
- }
- else
- {
- marked = ppdFindMarkedChoice(ppd, constptr->option->keyword);
- value = marked ? marked->choice : "";
- }
- }
-
- if (!_cups_strncasecmp(value, "Custom.", 7))
- value = "Custom";
-
- /*
- * Try the default choice...
- */
-
- test = NULL;
-
- if (_cups_strcasecmp(value, constptr->option->defchoice) &&
- (test = ppd_test_constraints(ppd, constptr->option->keyword,
- constptr->option->defchoice,
- num_newopts, newopts,
- _PPD_OPTION_CONSTRAINTS)) == NULL)
- {
- /*
- * That worked...
- */
-
- num_newopts = cupsAddOption(constptr->option->keyword,
- constptr->option->defchoice,
- num_newopts, &newopts);
- changed = 1;
- }
- else
- {
- /*
- * Try each choice instead...
- */
-
- for (j = constptr->option->num_choices,
- cptr = constptr->option->choices;
- j > 0;
- j --, cptr ++)
- {
- cupsArrayDelete(test);
- test = NULL;
-
- if (_cups_strcasecmp(value, cptr->choice) &&
- _cups_strcasecmp(constptr->option->defchoice, cptr->choice) &&
- _cups_strcasecmp("Custom", cptr->choice) &&
- (test = ppd_test_constraints(ppd, constptr->option->keyword,
- cptr->choice, num_newopts,
- newopts,
- _PPD_OPTION_CONSTRAINTS)) == NULL)
- {
- /*
- * This choice works...
- */
-
- num_newopts = cupsAddOption(constptr->option->keyword,
- cptr->choice, num_newopts,
- &newopts);
- changed = 1;
- break;
- }
- }
-
- cupsArrayDelete(test);
- }
- }
- }
- }
-
- if (!changed)
- {
- DEBUG_puts("1cupsResolveConflicts: Unable to automatically resolve "
- "constraint!");
- goto error;
- }
-
- cupsArrayClear(pass);
- cupsArrayDelete(active);
- active = NULL;
- }
-
- if (tries >= 100)
- goto error;
-
- /*
- * Free the caller's option array...
- */
-
- cupsFreeOptions(*num_options, *options);
-
- /*
- * If Collate is the option we are testing, add it here. Otherwise, remove
- * any Collate option from the resolve list since the filters automatically
- * handle manual collation...
- */
-
- if (option && !_cups_strcasecmp(option, "Collate"))
- num_newopts = cupsAddOption(option, choice, num_newopts, &newopts);
- else
- num_newopts = cupsRemoveOption("Collate", num_newopts, &newopts);
-
- /*
- * Return the new list of options to the caller...
- */
-
- *num_options = num_newopts;
- *options = newopts;
-
- cupsArrayDelete(pass);
- cupsArrayDelete(resolvers);
-
- cupsArrayRestore(ppd->sorted_attrs);
-
- DEBUG_printf(("1cupsResolveConflicts: Returning %d options:", num_newopts));
-#ifdef DEBUG
- for (i = 0; i < num_newopts; i ++)
- DEBUG_printf(("1cupsResolveConflicts: options[%d]: %s=%s", i,
- newopts[i].name, newopts[i].value));
-#endif /* DEBUG */
-
- return (1);
-
- /*
- * If we get here, we failed to resolve...
- */
-
- error:
-
- cupsFreeOptions(num_newopts, newopts);
-
- cupsArrayDelete(active);
- cupsArrayDelete(pass);
- cupsArrayDelete(resolvers);
-
- cupsArrayRestore(ppd->sorted_attrs);
-
- DEBUG_puts("1cupsResolveConflicts: Unable to resolve conflicts!");
-
- return (0);
-}
-
-
-/*
- * 'ppdConflicts()' - Check to see if there are any conflicts among the
- * marked option choices.
- *
- * The returned value is the same as returned by @link ppdMarkOption@.
- */
-
-int /* O - Number of conflicts found */
-ppdConflicts(ppd_file_t *ppd) /* I - PPD to check */
-{
- int i, /* Looping variable */
- conflicts; /* Number of conflicts */
- cups_array_t *active; /* Active conflicts */
- _ppd_cups_uiconsts_t *c; /* Current constraints */
- _ppd_cups_uiconst_t *cptr; /* Current constraint */
- ppd_option_t *o; /* Current option */
-
-
- if (!ppd)
- return (0);
-
- /*
- * Clear all conflicts...
- */
-
- cupsArraySave(ppd->options);
-
- for (o = ppdFirstOption(ppd); o; o = ppdNextOption(ppd))
- o->conflicted = 0;
-
- cupsArrayRestore(ppd->options);
-
- /*
- * Test for conflicts...
- */
-
- active = ppd_test_constraints(ppd, NULL, NULL, 0, NULL,
- _PPD_ALL_CONSTRAINTS);
- conflicts = cupsArrayCount(active);
-
- /*
- * Loop through all of the UI constraints and flag any options
- * that conflict...
- */
-
- for (c = (_ppd_cups_uiconsts_t *)cupsArrayFirst(active);
- c;
- c = (_ppd_cups_uiconsts_t *)cupsArrayNext(active))
- {
- for (i = c->num_constraints, cptr = c->constraints;
- i > 0;
- i --, cptr ++)
- cptr->option->conflicted = 1;
- }
-
- cupsArrayDelete(active);
-
- /*
- * Return the number of conflicts found...
- */
-
- return (conflicts);
-}
-
-
-/*
- * 'ppdInstallableConflict()' - Test whether an option choice conflicts with
- * an installable option.
- *
- * This function tests whether a particular option choice is available based
- * on constraints against options in the "InstallableOptions" group.
- *
- * @since CUPS 1.4/OS X 10.6@
- */
-
-int /* O - 1 if conflicting, 0 if not conflicting */
-ppdInstallableConflict(
- ppd_file_t *ppd, /* I - PPD file */
- const char *option, /* I - Option */
- const char *choice) /* I - Choice */
-{
- cups_array_t *active; /* Active conflicts */
-
-
- DEBUG_printf(("2ppdInstallableConflict(ppd=%p, option=\"%s\", choice=\"%s\")",
- ppd, option, choice));
-
- /*
- * Range check input...
- */
-
- if (!ppd || !option || !choice)
- return (0);
-
- /*
- * Test constraints using the new option...
- */
-
- active = ppd_test_constraints(ppd, option, choice, 0, NULL,
- _PPD_INSTALLABLE_CONSTRAINTS);
-
- cupsArrayDelete(active);
-
- return (active != NULL);
-}
-
-
-/*
- * 'ppd_is_installable()' - Determine whether an option is in the
- * InstallableOptions group.
- */
-
-static int /* O - 1 if installable, 0 if normal */
-ppd_is_installable(
- ppd_group_t *installable, /* I - InstallableOptions group */
- const char *name) /* I - Option name */
-{
- if (installable)
- {
- int i; /* Looping var */
- ppd_option_t *option; /* Current option */
-
-
- for (i = installable->num_options, option = installable->options;
- i > 0;
- i --, option ++)
- if (!_cups_strcasecmp(option->keyword, name))
- return (1);
- }
-
- return (0);
-}
-
-
-/*
- * 'ppd_load_constraints()' - Load constraints from a PPD file.
- */
-
-static void
-ppd_load_constraints(ppd_file_t *ppd) /* I - PPD file */
-{
- int i; /* Looping var */
- ppd_const_t *oldconst; /* Current UIConstraints data */
- ppd_attr_t *constattr; /* Current cupsUIConstraints attribute */
- _ppd_cups_uiconsts_t *consts; /* Current cupsUIConstraints data */
- _ppd_cups_uiconst_t *constptr; /* Current constraint */
- ppd_group_t *installable; /* Installable options group */
- const char *vptr; /* Pointer into constraint value */
- char option[PPD_MAX_NAME], /* Option name/MainKeyword */
- choice[PPD_MAX_NAME], /* Choice/OptionKeyword */
- *ptr; /* Pointer into option or choice */
-
-
- DEBUG_printf(("7ppd_load_constraints(ppd=%p)", ppd));
-
- /*
- * Create an array to hold the constraint data...
- */
-
- ppd->cups_uiconstraints = cupsArrayNew(NULL, NULL);
-
- /*
- * Find the installable options group if it exists...
- */
-
- for (i = ppd->num_groups, installable = ppd->groups;
- i > 0;
- i --, installable ++)
- if (!_cups_strcasecmp(installable->name, "InstallableOptions"))
- break;
-
- if (i <= 0)
- installable = NULL;
-
- /*
- * Load old-style [Non]UIConstraints data...
- */
-
- for (i = ppd->num_consts, oldconst = ppd->consts; i > 0; i --, oldconst ++)
- {
- /*
- * Weed out nearby duplicates, since the PPD spec requires that you
- * define both "*Foo foo *Bar bar" and "*Bar bar *Foo foo"...
- */
-
- if (i > 1 &&
- !_cups_strcasecmp(oldconst[0].option1, oldconst[1].option2) &&
- !_cups_strcasecmp(oldconst[0].choice1, oldconst[1].choice2) &&
- !_cups_strcasecmp(oldconst[0].option2, oldconst[1].option1) &&
- !_cups_strcasecmp(oldconst[0].choice2, oldconst[1].choice1))
- continue;
-
- /*
- * Allocate memory...
- */
-
- if ((consts = calloc(1, sizeof(_ppd_cups_uiconsts_t))) == NULL)
- {
- DEBUG_puts("8ppd_load_constraints: Unable to allocate memory for "
- "UIConstraints!");
- return;
- }
-
- if ((constptr = calloc(2, sizeof(_ppd_cups_uiconst_t))) == NULL)
- {
- free(consts);
- DEBUG_puts("8ppd_load_constraints: Unable to allocate memory for "
- "UIConstraints!");
- return;
- }
-
- /*
- * Fill in the information...
- */
-
- consts->num_constraints = 2;
- consts->constraints = constptr;
-
- if (!_cups_strncasecmp(oldconst->option1, "Custom", 6) &&
- !_cups_strcasecmp(oldconst->choice1, "True"))
- {
- constptr[0].option = ppdFindOption(ppd, oldconst->option1 + 6);
- constptr[0].choice = ppdFindChoice(constptr[0].option, "Custom");
- constptr[0].installable = 0;
- }
- else
- {
- constptr[0].option = ppdFindOption(ppd, oldconst->option1);
- constptr[0].choice = ppdFindChoice(constptr[0].option,
- oldconst->choice1);
- constptr[0].installable = ppd_is_installable(installable,
- oldconst->option1);
- }
-
- if (!constptr[0].option || (!constptr[0].choice && oldconst->choice1[0]))
- {
- DEBUG_printf(("8ppd_load_constraints: Unknown option *%s %s!",
- oldconst->option1, oldconst->choice1));
- free(consts->constraints);
- free(consts);
- continue;
- }
-
- if (!_cups_strncasecmp(oldconst->option2, "Custom", 6) &&
- !_cups_strcasecmp(oldconst->choice2, "True"))
- {
- constptr[1].option = ppdFindOption(ppd, oldconst->option2 + 6);
- constptr[1].choice = ppdFindChoice(constptr[1].option, "Custom");
- constptr[1].installable = 0;
- }
- else
- {
- constptr[1].option = ppdFindOption(ppd, oldconst->option2);
- constptr[1].choice = ppdFindChoice(constptr[1].option,
- oldconst->choice2);
- constptr[1].installable = ppd_is_installable(installable,
- oldconst->option2);
- }
-
- if (!constptr[1].option || (!constptr[1].choice && oldconst->choice2[0]))
- {
- DEBUG_printf(("8ppd_load_constraints: Unknown option *%s %s!",
- oldconst->option2, oldconst->choice2));
- free(consts->constraints);
- free(consts);
- continue;
- }
-
- consts->installable = constptr[0].installable || constptr[1].installable;
-
- /*
- * Add it to the constraints array...
- */
-
- cupsArrayAdd(ppd->cups_uiconstraints, consts);
- }
-
- /*
- * Then load new-style constraints...
- */
-
- for (constattr = ppdFindAttr(ppd, "cupsUIConstraints", NULL);
- constattr;
- constattr = ppdFindNextAttr(ppd, "cupsUIConstraints", NULL))
- {
- if (!constattr->value)
- {
- DEBUG_puts("8ppd_load_constraints: Bad cupsUIConstraints value!");
- continue;
- }
-
- for (i = 0, vptr = strchr(constattr->value, '*');
- vptr;
- i ++, vptr = strchr(vptr + 1, '*'));
-
- if (i == 0)
- {
- DEBUG_puts("8ppd_load_constraints: Bad cupsUIConstraints value!");
- continue;
- }
-
- if ((consts = calloc(1, sizeof(_ppd_cups_uiconsts_t))) == NULL)
- {
- DEBUG_puts("8ppd_load_constraints: Unable to allocate memory for "
- "cupsUIConstraints!");
- return;
- }
-
- if ((constptr = calloc(i, sizeof(_ppd_cups_uiconst_t))) == NULL)
- {
- free(consts);
- DEBUG_puts("8ppd_load_constraints: Unable to allocate memory for "
- "cupsUIConstraints!");
- return;
- }
-
- consts->num_constraints = i;
- consts->constraints = constptr;
-
- strlcpy(consts->resolver, constattr->spec, sizeof(consts->resolver));
-
- for (i = 0, vptr = strchr(constattr->value, '*');
- vptr;
- i ++, vptr = strchr(vptr, '*'), constptr ++)
- {
- /*
- * Extract "*Option Choice" or just "*Option"...
- */
-
- for (vptr ++, ptr = option; *vptr && !_cups_isspace(*vptr); vptr ++)
- if (ptr < (option + sizeof(option) - 1))
- *ptr++ = *vptr;
-
- *ptr = '\0';
-
- while (_cups_isspace(*vptr))
- vptr ++;
-
- if (*vptr == '*')
- choice[0] = '\0';
- else
- {
- for (ptr = choice; *vptr && !_cups_isspace(*vptr); vptr ++)
- if (ptr < (choice + sizeof(choice) - 1))
- *ptr++ = *vptr;
-
- *ptr = '\0';
- }
-
- if (!_cups_strncasecmp(option, "Custom", 6) && !_cups_strcasecmp(choice, "True"))
- {
- _cups_strcpy(option, option + 6);
- strcpy(choice, "Custom");
- }
-
- constptr->option = ppdFindOption(ppd, option);
- constptr->choice = ppdFindChoice(constptr->option, choice);
- constptr->installable = ppd_is_installable(installable, option);
- consts->installable |= constptr->installable;
-
- if (!constptr->option || (!constptr->choice && choice[0]))
- {
- DEBUG_printf(("8ppd_load_constraints: Unknown option *%s %s!",
- option, choice));
- break;
- }
- }
-
- if (!vptr)
- cupsArrayAdd(ppd->cups_uiconstraints, consts);
- else
- {
- free(consts->constraints);
- free(consts);
- }
- }
-}
-
-
-/*
- * 'ppd_test_constraints()' - See if any constraints are active.
- */
-
-static cups_array_t * /* O - Array of active constraints */
-ppd_test_constraints(
- ppd_file_t *ppd, /* I - PPD file */
- const char *option, /* I - Current option */
- const char *choice, /* I - Current choice */
- int num_options, /* I - Number of additional options */
- cups_option_t *options, /* I - Additional options */
- int which) /* I - Which constraints to test */
-{
- int i; /* Looping var */
- _ppd_cups_uiconsts_t *consts; /* Current constraints */
- _ppd_cups_uiconst_t *constptr; /* Current constraint */
- ppd_choice_t key, /* Search key */
- *marked; /* Marked choice */
- cups_array_t *active = NULL; /* Active constraints */
- const char *value, /* Current value */
- *firstvalue; /* AP_FIRSTPAGE_Keyword value */
- char firstpage[255]; /* AP_FIRSTPAGE_Keyword string */
-
-
- DEBUG_printf(("7ppd_test_constraints(ppd=%p, option=\"%s\", choice=\"%s\", "
- "num_options=%d, options=%p, which=%d)", ppd, option, choice,
- num_options, options, which));
-
- if (!ppd->cups_uiconstraints)
- ppd_load_constraints(ppd);
-
- DEBUG_printf(("9ppd_test_constraints: %d constraints!",
- cupsArrayCount(ppd->cups_uiconstraints)));
-
- cupsArraySave(ppd->marked);
-
- for (consts = (_ppd_cups_uiconsts_t *)cupsArrayFirst(ppd->cups_uiconstraints);
- consts;
- consts = (_ppd_cups_uiconsts_t *)cupsArrayNext(ppd->cups_uiconstraints))
- {
- DEBUG_printf(("9ppd_test_constraints: installable=%d, resolver=\"%s\", "
- "num_constraints=%d option1=\"%s\", choice1=\"%s\", "
- "option2=\"%s\", choice2=\"%s\", ...",
- consts->installable, consts->resolver, consts->num_constraints,
- consts->constraints[0].option->keyword,
- consts->constraints[0].choice ?
- consts->constraints[0].choice->choice : "",
- consts->constraints[1].option->keyword,
- consts->constraints[1].choice ?
- consts->constraints[1].choice->choice : ""));
-
- if (consts->installable && which < _PPD_INSTALLABLE_CONSTRAINTS)
- continue; /* Skip installable option constraint */
-
- if (!consts->installable && which == _PPD_INSTALLABLE_CONSTRAINTS)
- continue; /* Skip non-installable option constraint */
-
- if (which == _PPD_OPTION_CONSTRAINTS && option)
- {
- /*
- * Skip constraints that do not involve the current option...
- */
-
- for (i = consts->num_constraints, constptr = consts->constraints;
- i > 0;
- i --, constptr ++)
- {
- if (!_cups_strcasecmp(constptr->option->keyword, option))
- break;
-
- if (!_cups_strncasecmp(option, "AP_FIRSTPAGE_", 13) &&
- !_cups_strcasecmp(constptr->option->keyword, option + 13))
- break;
- }
-
- if (!i)
- continue;
- }
-
- DEBUG_puts("9ppd_test_constraints: Testing...");
-
- for (i = consts->num_constraints, constptr = consts->constraints;
- i > 0;
- i --, constptr ++)
- {
- DEBUG_printf(("9ppd_test_constraints: %s=%s?", constptr->option->keyword,
- constptr->choice ? constptr->choice->choice : ""));
-
- if (constptr->choice &&
- (!_cups_strcasecmp(constptr->option->keyword, "PageSize") ||
- !_cups_strcasecmp(constptr->option->keyword, "PageRegion")))
- {
- /*
- * PageSize and PageRegion are used depending on the selected input slot
- * and manual feed mode. Validate against the selected page size instead
- * of an individual option...
- */
-
- if (option && choice &&
- (!_cups_strcasecmp(option, "PageSize") ||
- !_cups_strcasecmp(option, "PageRegion")))
- {
- value = choice;
- }
- else if ((value = cupsGetOption("PageSize", num_options,
- options)) == NULL)
- if ((value = cupsGetOption("PageRegion", num_options,
- options)) == NULL)
- if ((value = cupsGetOption("media", num_options, options)) == NULL)
- {
- ppd_size_t *size = ppdPageSize(ppd, NULL);
-
- if (size)
- value = size->name;
- }
-
- if (value && !_cups_strncasecmp(value, "Custom.", 7))
- value = "Custom";
-
- if (option && choice &&
- (!_cups_strcasecmp(option, "AP_FIRSTPAGE_PageSize") ||
- !_cups_strcasecmp(option, "AP_FIRSTPAGE_PageRegion")))
- {
- firstvalue = choice;
- }
- else if ((firstvalue = cupsGetOption("AP_FIRSTPAGE_PageSize",
- num_options, options)) == NULL)
- firstvalue = cupsGetOption("AP_FIRSTPAGE_PageRegion", num_options,
- options);
-
- if (firstvalue && !_cups_strncasecmp(firstvalue, "Custom.", 7))
- firstvalue = "Custom";
-
- if ((!value || _cups_strcasecmp(value, constptr->choice->choice)) &&
- (!firstvalue || _cups_strcasecmp(firstvalue, constptr->choice->choice)))
- {
- DEBUG_puts("9ppd_test_constraints: NO");
- break;
- }
- }
- else if (constptr->choice)
- {
- /*
- * Compare against the constrained choice...
- */
-
- if (option && choice && !_cups_strcasecmp(option, constptr->option->keyword))
- {
- if (!_cups_strncasecmp(choice, "Custom.", 7))
- value = "Custom";
- else
- value = choice;
- }
- else if ((value = cupsGetOption(constptr->option->keyword, num_options,
- options)) != NULL)
- {
- if (!_cups_strncasecmp(value, "Custom.", 7))
- value = "Custom";
- }
- else if (constptr->choice->marked)
- value = constptr->choice->choice;
- else
- value = NULL;
-
- /*
- * Now check AP_FIRSTPAGE_option...
- */
-
- snprintf(firstpage, sizeof(firstpage), "AP_FIRSTPAGE_%s",
- constptr->option->keyword);
-
- if (option && choice && !_cups_strcasecmp(option, firstpage))
- {
- if (!_cups_strncasecmp(choice, "Custom.", 7))
- firstvalue = "Custom";
- else
- firstvalue = choice;
- }
- else if ((firstvalue = cupsGetOption(firstpage, num_options,
- options)) != NULL)
- {
- if (!_cups_strncasecmp(firstvalue, "Custom.", 7))
- firstvalue = "Custom";
- }
- else
- firstvalue = NULL;
-
- DEBUG_printf(("9ppd_test_constraints: value=%s, firstvalue=%s", value,
- firstvalue));
-
- if ((!value || _cups_strcasecmp(value, constptr->choice->choice)) &&
- (!firstvalue || _cups_strcasecmp(firstvalue, constptr->choice->choice)))
- {
- DEBUG_puts("9ppd_test_constraints: NO");
- break;
- }
- }
- else if (option && choice &&
- !_cups_strcasecmp(option, constptr->option->keyword))
- {
- if (!_cups_strcasecmp(choice, "None") || !_cups_strcasecmp(choice, "Off") ||
- !_cups_strcasecmp(choice, "False"))
- {
- DEBUG_puts("9ppd_test_constraints: NO");
- break;
- }
- }
- else if ((value = cupsGetOption(constptr->option->keyword, num_options,
- options)) != NULL)
- {
- if (!_cups_strcasecmp(value, "None") || !_cups_strcasecmp(value, "Off") ||
- !_cups_strcasecmp(value, "False"))
- {
- DEBUG_puts("9ppd_test_constraints: NO");
- break;
- }
- }
- else
- {
- key.option = constptr->option;
-
- if ((marked = (ppd_choice_t *)cupsArrayFind(ppd->marked, &key))
- == NULL ||
- (!_cups_strcasecmp(marked->choice, "None") ||
- !_cups_strcasecmp(marked->choice, "Off") ||
- !_cups_strcasecmp(marked->choice, "False")))
- {
- DEBUG_puts("9ppd_test_constraints: NO");
- break;
- }
- }
- }
-
- if (i <= 0)
- {
- if (!active)
- active = cupsArrayNew(NULL, NULL);
-
- cupsArrayAdd(active, consts);
- DEBUG_puts("9ppd_test_constraints: Added...");
- }
- }
-
- cupsArrayRestore(ppd->marked);
-
- DEBUG_printf(("8ppd_test_constraints: Found %d active constraints!",
- cupsArrayCount(active)));
-
- return (active);
-}
-
-
-/*
- * End of "$Id: conflicts.c 3794 2012-04-23 22:44:16Z msweet $".
- */
diff --git a/cups/cups-private.h b/cups/cups-private.h
index 6fd66a9..f1b052a 100644
--- a/cups/cups-private.h
+++ b/cups/cups-private.h
@@ -1,16 +1,11 @@
/*
* Private definitions for CUPS.
*
- * Copyright 2007-2017 by Apple Inc.
- * Copyright 1997-2007 by Easy Software Products, all rights reserved.
+ * Copyright © 2007-2019 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.
+ * Licensed under Apache License v2.0. See the file "LICENSE" for more
+ * information.
*/
#ifndef _CUPS_CUPS_PRIVATE_H_
@@ -21,7 +16,6 @@
*/
# include "string-private.h"
-# include "debug-private.h"
# include "array-private.h"
# include "ipp-private.h"
# include "http-private.h"
@@ -56,6 +50,24 @@ typedef struct _cups_buffer_s /**** Read/write buffer ****/
d[1]; /* Data buffer */
} _cups_buffer_t;
+typedef struct _cups_raster_error_s /**** Error buffer structure ****/
+{
+ char *start, /* Start of buffer */
+ *current, /* Current position in buffer */
+ *end; /* End of buffer */
+} _cups_raster_error_t;
+
+typedef enum _cups_uatokens_e /**** UserAgentTokens values */
+{
+ _CUPS_UATOKENS_NONE, /* Do not send User-Agent */
+ _CUPS_UATOKENS_PRODUCT_ONLY, /* CUPS IPP */
+ _CUPS_UATOKENS_MAJOR, /* CUPS/major IPP/2 */
+ _CUPS_UATOKENS_MINOR, /* CUPS/major.minor IPP/2.1 */
+ _CUPS_UATOKENS_MINIMAL, /* CUPS/major.minor.patch IPP/2.1 */
+ _CUPS_UATOKENS_OS, /* CUPS/major.minor.patch (osname osversion) IPP/2.1 */
+ _CUPS_UATOKENS_FULL /* CUPS/major.minor.patch (osname osversion; architecture) IPP/2.1 */
+} _cups_uatokens_t;
+
typedef struct _cups_globals_s /**** CUPS global state data ****/
{
/* Multiple places... */
@@ -127,6 +139,9 @@ typedef struct _cups_globals_s /**** CUPS global state data ****/
char pwg_name[65], /* PWG media name for custom size */
ppd_name[41]; /* PPD media name for custom size */
+ /* raster-error.c */
+ _cups_raster_error_t raster_error; /* Raster error information */
+
/* request.c */
http_t *http; /* Current server connection */
ipp_status_t last_error; /* Last IPP error */
@@ -142,6 +157,7 @@ typedef struct _cups_globals_s /**** CUPS global state data ****/
char tempfile[1024]; /* cupsTempFd/File buffer */
/* usersys.c */
+ _cups_uatokens_t uatokens; /* UserAgentTokens setting */
http_encryption_t encryption; /* Encryption setting */
char user[65], /* User name */
user_agent[256],/* User-Agent string */
@@ -224,44 +240,38 @@ struct _cups_dinfo_s /* Destination capability and status
*/
# ifdef __APPLE__
-extern CFStringRef _cupsAppleCopyDefaultPaperID(void);
-extern CFStringRef _cupsAppleCopyDefaultPrinter(void);
-extern int _cupsAppleGetUseLastPrinter(void);
-extern void _cupsAppleSetDefaultPaperID(CFStringRef name);
-extern void _cupsAppleSetDefaultPrinter(CFStringRef name);
-extern void _cupsAppleSetUseLastPrinter(int uselast);
+extern CFStringRef _cupsAppleCopyDefaultPaperID(void) _CUPS_PRIVATE;
+extern CFStringRef _cupsAppleCopyDefaultPrinter(void) _CUPS_PRIVATE;
+extern int _cupsAppleGetUseLastPrinter(void) _CUPS_PRIVATE;
+extern void _cupsAppleSetDefaultPaperID(CFStringRef name) _CUPS_PRIVATE;
+extern void _cupsAppleSetDefaultPrinter(CFStringRef name) _CUPS_PRIVATE;
+extern void _cupsAppleSetUseLastPrinter(int uselast) _CUPS_PRIVATE;
# endif /* __APPLE__ */
-extern char *_cupsBufferGet(size_t size);
-extern void _cupsBufferRelease(char *b);
+extern char *_cupsBufferGet(size_t size) _CUPS_PRIVATE;
+extern void _cupsBufferRelease(char *b) _CUPS_PRIVATE;
-extern http_t *_cupsConnect(void);
-extern char *_cupsCreateDest(const char *name, const char *info, const char *device_id, const char *device_uri, char *uri, size_t urisize);
-extern int _cupsGet1284Values(const char *device_id,
- cups_option_t **values);
-extern const char *_cupsGetDestResource(cups_dest_t *dest, char *resource,
- size_t resourcesize);
-extern int _cupsGetDests(http_t *http, ipp_op_t op,
- const char *name, cups_dest_t **dests,
- cups_ptype_t type, cups_ptype_t mask);
-extern const char *_cupsGetPassword(const char *prompt);
-extern void _cupsGlobalLock(void);
-extern _cups_globals_t *_cupsGlobals(void);
-extern void _cupsGlobalUnlock(void);
+extern http_t *_cupsConnect(void) _CUPS_PRIVATE;
+extern char *_cupsCreateDest(const char *name, const char *info, const char *device_id, const char *device_uri, char *uri, size_t urisize) _CUPS_PRIVATE;
+extern ipp_attribute_t *_cupsEncodeOption(ipp_t *ipp, ipp_tag_t group_tag, _ipp_option_t *map, const char *name, const char *value) _CUPS_PRIVATE;
+extern int _cupsGet1284Values(const char *device_id, cups_option_t **values) _CUPS_PRIVATE;
+extern const char *_cupsGetDestResource(cups_dest_t *dest, unsigned flags, char *resource, size_t resourcesize) _CUPS_PRIVATE;
+extern int _cupsGetDests(http_t *http, ipp_op_t op, const char *name, cups_dest_t **dests, cups_ptype_t type, cups_ptype_t mask) _CUPS_PRIVATE;
+extern const char *_cupsGetPassword(const char *prompt) _CUPS_PRIVATE;
+extern void _cupsGlobalLock(void) _CUPS_PRIVATE;
+extern _cups_globals_t *_cupsGlobals(void) _CUPS_PRIVATE;
+extern void _cupsGlobalUnlock(void) _CUPS_PRIVATE;
# ifdef HAVE_GSSAPI
-extern const char *_cupsGSSServiceName(void);
+extern const char *_cupsGSSServiceName(void) _CUPS_PRIVATE;
# endif /* HAVE_GSSAPI */
-extern int _cupsNextDelay(int current, int *previous);
-extern void _cupsSetDefaults(void);
-extern void _cupsSetError(ipp_status_t status, const char *message,
- int localize);
-extern void _cupsSetHTTPError(http_status_t status);
+extern int _cupsNextDelay(int current, int *previous) _CUPS_PRIVATE;
+extern void _cupsSetDefaults(void) _CUPS_INTERNAL;
+extern void _cupsSetError(ipp_status_t status, const char *message, int localize) _CUPS_PRIVATE;
+extern void _cupsSetHTTPError(http_status_t status) _CUPS_INTERNAL;
# ifdef HAVE_GSSAPI
-extern int _cupsSetNegotiateAuthString(http_t *http,
- const char *method,
- const char *resource);
+extern int _cupsSetNegotiateAuthString(http_t *http, const char *method, const char *resource) _CUPS_PRIVATE;
# endif /* HAVE_GSSAPI */
-extern char *_cupsUserDefault(char *name, size_t namesize);
+extern char *_cupsUserDefault(char *name, size_t namesize) _CUPS_INTERNAL;
/*
diff --git a/cups/cups.h b/cups/cups.h
index a73cf7a..e64fdcc 100644
--- a/cups/cups.h
+++ b/cups/cups.h
@@ -1,16 +1,11 @@
/*
* API definitions for CUPS.
*
- * Copyright 2007-2017 by Apple Inc.
- * Copyright 1997-2007 by Easy Software Products.
+ * Copyright © 2007-2019 by Apple Inc.
+ * Copyright © 1997-2007 by Easy Software Products.
*
- * 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.
+ * Licensed under Apache License v2.0. See the file "LICENSE" for more
+ * information.
*/
#ifndef _CUPS_CUPS_H_
@@ -21,12 +16,12 @@
*/
# include
-# if defined(WIN32) && !defined(__CUPS_SSIZE_T_DEFINED)
+# if defined(_WIN32) && !defined(__CUPS_SSIZE_T_DEFINED)
# define __CUPS_SSIZE_T_DEFINED
# include
/* Windows does not support the ssize_t type, so map it to long... */
typedef long ssize_t; /* @private@ */
-# endif /* WIN32 && !__CUPS_SSIZE_T_DEFINED */
+# endif /* _WIN32 && !__CUPS_SSIZE_T_DEFINED */
# include "file.h"
# include "ipp.h"
@@ -47,10 +42,10 @@ extern "C" {
* Constants...
*/
-# define CUPS_VERSION 2.0204
+# define CUPS_VERSION 2.0300
# define CUPS_VERSION_MAJOR 2
-# define CUPS_VERSION_MINOR 2
-# define CUPS_VERSION_PATCH 4
+# define CUPS_VERSION_MINOR 3
+# define CUPS_VERSION_PATCH 0
# define CUPS_BC_FD 3
/* Back-channel file descriptor for
@@ -334,55 +329,55 @@ typedef int (*cups_server_cert_cb_t)(http_t *http, void *tls,
* Functions...
*/
-extern int cupsCancelJob(const char *name, int job_id);
+extern int cupsCancelJob(const char *name, int job_id) _CUPS_PUBLIC;
extern ipp_t *cupsDoFileRequest(http_t *http, ipp_t *request,
const char *resource,
- const char *filename);
+ const char *filename) _CUPS_PUBLIC;
extern ipp_t *cupsDoRequest(http_t *http, ipp_t *request,
- const char *resource);
+ const char *resource) _CUPS_PUBLIC;
extern http_encryption_t cupsEncryption(void);
-extern void cupsFreeJobs(int num_jobs, cups_job_t *jobs);
+extern void cupsFreeJobs(int num_jobs, cups_job_t *jobs) _CUPS_PUBLIC;
extern int cupsGetClasses(char ***classes) _CUPS_DEPRECATED_MSG("Use cupsEnumDests instead.");
-extern const char *cupsGetDefault(void);
+extern const char *cupsGetDefault(void) _CUPS_PUBLIC;
extern int cupsGetJobs(cups_job_t **jobs, const char *name,
- int myjobs, int whichjobs);
+ int myjobs, int whichjobs) _CUPS_PUBLIC;
extern int cupsGetPrinters(char ***printers) _CUPS_DEPRECATED_MSG("Use cupsEnumDests instead.");
-extern ipp_status_t cupsLastError(void);
+extern ipp_status_t cupsLastError(void) _CUPS_PUBLIC;
extern int cupsPrintFile(const char *name, const char *filename,
const char *title, int num_options,
- cups_option_t *options);
+ cups_option_t *options) _CUPS_PUBLIC;
extern int cupsPrintFiles(const char *name, int num_files,
const char **files, const char *title,
- int num_options, cups_option_t *options);
+ int num_options, cups_option_t *options) _CUPS_PUBLIC;
extern char *cupsTempFile(char *filename, int len) _CUPS_DEPRECATED_MSG("Use cupsTempFd or cupsTempFile2 instead.");
-extern int cupsTempFd(char *filename, int len);
+extern int cupsTempFd(char *filename, int len) _CUPS_PUBLIC;
extern int cupsAddDest(const char *name, const char *instance,
- int num_dests, cups_dest_t **dests);
-extern void cupsFreeDests(int num_dests, cups_dest_t *dests);
+ int num_dests, cups_dest_t **dests) _CUPS_PUBLIC;
+extern void cupsFreeDests(int num_dests, cups_dest_t *dests) _CUPS_PUBLIC;
extern cups_dest_t *cupsGetDest(const char *name, const char *instance,
- int num_dests, cups_dest_t *dests);
-extern int cupsGetDests(cups_dest_t **dests);
-extern void cupsSetDests(int num_dests, cups_dest_t *dests);
+ int num_dests, cups_dest_t *dests) _CUPS_PUBLIC;
+extern int cupsGetDests(cups_dest_t **dests) _CUPS_PUBLIC;
+extern void cupsSetDests(int num_dests, cups_dest_t *dests) _CUPS_PUBLIC;
extern int cupsAddOption(const char *name, const char *value,
- int num_options, cups_option_t **options);
+ int num_options, cups_option_t **options) _CUPS_PUBLIC;
extern void cupsEncodeOptions(ipp_t *ipp, int num_options,
- cups_option_t *options);
+ cups_option_t *options) _CUPS_PUBLIC;
extern void cupsFreeOptions(int num_options,
- cups_option_t *options);
+ cups_option_t *options) _CUPS_PUBLIC;
extern const char *cupsGetOption(const char *name, int num_options,
- cups_option_t *options);
+ cups_option_t *options) _CUPS_PUBLIC;
extern int cupsParseOptions(const char *arg, int num_options,
- cups_option_t **options);
+ cups_option_t **options) _CUPS_PUBLIC;
-extern const char *cupsGetPassword(const char *prompt);
-extern const char *cupsServer(void);
-extern void cupsSetEncryption(http_encryption_t e);
-extern void cupsSetPasswordCB(cups_password_cb_t cb);
-extern void cupsSetServer(const char *server);
-extern void cupsSetUser(const char *user);
-extern const char *cupsUser(void);
+extern const char *cupsGetPassword(const char *prompt) _CUPS_PUBLIC;
+extern const char *cupsServer(void) _CUPS_PUBLIC;
+extern void cupsSetEncryption(http_encryption_t e) _CUPS_PUBLIC;
+extern void cupsSetPasswordCB(cups_password_cb_t cb) _CUPS_PUBLIC;
+extern void cupsSetServer(const char *server) _CUPS_PUBLIC;
+extern void cupsSetUser(const char *user) _CUPS_PUBLIC;
+extern const char *cupsUser(void) _CUPS_PUBLIC;
/**** New in CUPS 1.1.20 ****/
extern int cupsDoAuthentication(http_t *http, const char *method,
@@ -390,7 +385,7 @@ extern int cupsDoAuthentication(http_t *http, const char *method,
_CUPS_API_1_1_20;
extern http_status_t cupsGetFile(http_t *http, const char *resource,
const char *filename) _CUPS_API_1_1_20;
-extern http_status_t cupsGetFd(http_t *http, const char *resource, int fd);
+extern http_status_t cupsGetFd(http_t *http, const char *resource, int fd) _CUPS_API_1_1_20;
extern http_status_t cupsPutFile(http_t *http, const char *resource,
const char *filename) _CUPS_API_1_1_20;
extern http_status_t cupsPutFd(http_t *http, const char *resource, int fd)
@@ -416,10 +411,6 @@ extern int cupsSetDests2(http_t *http, int num_dests,
cups_dest_t *dests) _CUPS_API_1_1_21;
/**** New in CUPS 1.2/macOS 10.5 ****/
-extern ssize_t cupsBackChannelRead(char *buffer, size_t bytes,
- double timeout) _CUPS_API_1_2;
-extern ssize_t cupsBackChannelWrite(const char *buffer, size_t bytes,
- double timeout) _CUPS_API_1_2;
extern void cupsEncodeOptions2(ipp_t *ipp, int num_options,
cups_option_t *options,
ipp_tag_t group_tag) _CUPS_API_1_2;
@@ -606,6 +597,13 @@ extern ssize_t cupsHashData(const char *algorithm, const void *data, size_t dat
extern int cupsAddIntegerOption(const char *name, int value, int num_options, cups_option_t **options) _CUPS_API_2_2_4;
extern int cupsGetIntegerOption(const char *name, int num_options, cups_option_t *options) _CUPS_API_2_2_4;
+/* New in CUPS 2.2.7 */
+extern const char *cupsHashString(const unsigned char *hash, size_t hashsize, char *buffer, size_t bufsize) _CUPS_API_2_2_7;
+
+/* New in CUPS 2.3 */
+extern int cupsAddDestMediaOptions(http_t *http, cups_dest_t *dest, cups_dinfo_t *dinfo, unsigned flags, cups_size_t *size, int num_options, cups_option_t **options) _CUPS_API_2_3;
+extern ipp_attribute_t *cupsEncodeOption(ipp_t *ipp, ipp_tag_t group_tag, const char *name, const char *value) _CUPS_API_2_3;
+
# ifdef __cplusplus
}
# endif /* __cplusplus */
diff --git a/cups/cupspm-icon.png b/cups/cupspm-icon.png
new file mode 100644
index 0000000..8050934
Binary files /dev/null and b/cups/cupspm-icon.png differ
diff --git a/cups/cupspm.md b/cups/cupspm.md
new file mode 100644
index 0000000..260b261
--- /dev/null
+++ b/cups/cupspm.md
@@ -0,0 +1,1005 @@
+---
+title: CUPS Programming Manual
+author: Michael R Sweet
+copyright: Copyright © 2007-2019 by Apple Inc. All Rights Reserved.
+version: 2.3.0
+...
+
+> Please [file issues on Github](https://github.com/apple/cups/issues) to
+> provide feedback on this document.
+
+
+# Introduction
+
+CUPS provides the "cups" library to talk to the different parts of CUPS and with
+Internet Printing Protocol (IPP) printers. The "cups" library functions are
+accessed by including the `` header.
+
+CUPS is based on the Internet Printing Protocol ("IPP"), which allows clients
+(applications) to communicate with a server (the scheduler, printers, etc.) to
+get a list of destinations, send print jobs, and so forth. You identify which
+server you want to communicate with using a pointer to the opaque structure
+`http_t`. The `CUPS_HTTP_DEFAULT` constant can be used when you want to talk to
+the CUPS scheduler.
+
+
+## Guidelines
+
+When writing software (other than printer drivers) that uses the "cups" library:
+
+- Do not use undocumented or deprecated APIs,
+- Do not rely on pre-configured printers,
+- Do not assume that printers support specific features or formats, and
+- Do not rely on implementation details (PPDs, etc.)
+
+CUPS is designed to insulate users and developers from the implementation
+details of printers and file formats. The goal is to allow an application to
+supply a print file in a standard format with the user intent ("print four
+copies, two-sided on A4 media, and staple each copy") and have the printing
+system manage the printer communication and format conversion needed.
+
+Similarly, printer and job management applications can use standard query
+operations to obtain the status information in a common, generic form and use
+standard management operations to control the state of those printers and jobs.
+
+> **Note:**
+>
+> CUPS printer drivers necessarily depend on specific file formats and certain
+> implementation details of the CUPS software. Please consult the Postscript
+> and raster printer driver developer documentation on
+> [CUPS.org](https://www.cups.org/documentation.html) for more information.
+
+
+## Terms Used in This Document
+
+A *Destination* is a printer or print queue that accepts print jobs. A
+*Print Job* is a collection of one or more documents that are processed by a
+destination using options supplied when creating the job. A *Document* is a
+file (JPEG image, PDF file, etc.) suitable for printing. An *Option* controls
+some aspect of printing, such as the media used. *Media* is the sheets or roll
+that is printed on. An *Attribute* is an option encoded for an Internet
+Printing Protocol (IPP) request.
+
+
+## Compiling Programs That Use the CUPS API
+
+The CUPS libraries can be used from any C, C++, or Objective C program.
+The method of compiling against the libraries varies depending on the
+operating system and installation of CUPS. The following sections show how
+to compile a simple program (shown below) in two common environments.
+
+The following simple program lists the available destinations:
+
+ #include
+ #include
+
+ int print_dest(void *user_data, unsigned flags, cups_dest_t *dest)
+ {
+ if (dest->instance)
+ printf("%s/%s\n", dest->name, dest->instance);
+ else
+ puts(dest->name);
+
+ return (1);
+ }
+
+ int main(void)
+ {
+ cupsEnumDests(CUPS_DEST_FLAGS_NONE, 1000, NULL, 0, 0, print_dest, NULL);
+
+ return (0);
+ }
+
+
+### Compiling with Xcode
+
+In Xcode, choose *New Project...* from the *File* menu (or press SHIFT+CMD+N),
+then select the *Command Line Tool* under the macOS Application project type.
+Click *Next* and enter a name for the project, for example "firstcups". Click
+*Next* and choose a project directory. The click *Next* to create the project.
+
+In the project window, click on the *Build Phases* group and expand the
+*Link Binary with Libraries* section. Click *+*, type "libcups" to show the
+library, and then double-click on `libcups.tbd`.
+
+Finally, click on the `main.c` file in the sidebar and copy the example program
+to the file. Build and run (CMD+R) to see the list of destinations.
+
+
+### Compiling with GCC
+
+From the command-line, create a file called `sample.c` using your favorite
+editor, copy the example to this file, and save. Then run the following command
+to compile it with GCC and run it:
+
+ gcc -o simple `cups-config --cflags` simple.c `cups-config --libs`
+ ./simple
+
+The `cups-config` command provides the compiler flags (`cups-config --cflags`)
+and libraries (`cups-config --libs`) needed for the local system.
+
+
+# Working with Destinations
+
+Destinations, which in CUPS represent individual printers or classes
+(collections or pools) of printers, are represented by the `cups_dest_t`
+structure which includes the name \(`name`), instance \(`instance`, saved
+options/settings), whether the destination is the default for the user
+\(`is_default`), and the options and basic information associated with that
+destination \(`num_options` and `options`).
+
+Historically destinations have been manually maintained by the administrator of
+a system or network, but CUPS also supports dynamic discovery of destinations on
+the current network.
+
+
+## Finding Available Destinations
+
+The `cupsEnumDests` function finds all of the available destinations:
+
+ int
+ cupsEnumDests(unsigned flags, int msec, int *cancel,
+ cups_ptype_t type, cups_ptype_t mask,
+ cups_dest_cb_t cb, void *user_data)
+
+The `flags` argument specifies enumeration options, which at present must be
+`CUPS_DEST_FLAGS_NONE`.
+
+The `msec` argument specifies the maximum amount of time that should be used for
+enumeration in milliseconds - interactive applications should keep this value to
+5000 or less when run on the main thread.
+
+The `cancel` argument points to an integer variable that, when set to a non-zero
+value, will cause enumeration to stop as soon as possible. It can be `NULL` if
+not needed.
+
+The `type` and `mask` arguments are bitfields that allow the caller to filter
+the destinations based on categories and/or capabilities. The destination's
+"printer-type" value is masked by the `mask` value and compared to the `type`
+value when filtering. For example, to only enumerate destinations that are
+hosted on the local system, pass `CUPS_PRINTER_LOCAL` for the `type` argument
+and `CUPS_PRINTER_DISCOVERED` for the `mask` argument. The following constants
+can be used for filtering:
+
+- `CUPS_PRINTER_CLASS`: A collection of destinations.
+- `CUPS_PRINTER_FAX`: A facsimile device.
+- `CUPS_PRINTER_LOCAL`: A local printer or class. This constant has the value 0
+ (no bits set) and is only used for the `type` argument and is paired with the
+ `CUPS_PRINTER_REMOTE` or `CUPS_PRINTER_DISCOVERED` constant passed in the
+ `mask` argument.
+- `CUPS_PRINTER_REMOTE`: A remote (shared) printer or class.
+- `CUPS_PRINTER_DISCOVERED`: An available network printer or class.
+- `CUPS_PRINTER_BW`: Can do B&W printing.
+- `CUPS_PRINTER_COLOR`: Can do color printing.
+- `CUPS_PRINTER_DUPLEX`: Can do two-sided printing.
+- `CUPS_PRINTER_STAPLE`: Can staple output.
+- `CUPS_PRINTER_COLLATE`: Can quickly collate copies.
+- `CUPS_PRINTER_PUNCH`: Can punch output.
+- `CUPS_PRINTER_COVER`: Can cover output.
+- `CUPS_PRINTER_BIND`: Can bind output.
+- `CUPS_PRINTER_SORT`: Can sort output (mailboxes, etc.)
+- `CUPS_PRINTER_SMALL`: Can print on Letter/Legal/A4-size media.
+- `CUPS_PRINTER_MEDIUM`: Can print on Tabloid/B/C/A3/A2-size media.
+- `CUPS_PRINTER_LARGE`: Can print on D/E/A1/A0-size media.
+- `CUPS_PRINTER_VARIABLE`: Can print on rolls and custom-size media.
+
+The `cb` argument specifies a function to call for every destination that is
+found:
+
+ typedef int (*cups_dest_cb_t)(void *user_data,
+ unsigned flags,
+ cups_dest_t *dest);
+
+The callback function receives a copy of the `user_data` argument along with a
+bitfield \(`flags`) and the destination that was found. The `flags` argument
+can have any of the following constant (bit) values set:
+
+- `CUPS_DEST_FLAGS_MORE`: There are more destinations coming.
+- `CUPS_DEST_FLAGS_REMOVED`: The destination has gone away and should be removed
+ from the list of destinations a user can select.
+- `CUPS_DEST_FLAGS_ERROR`: An error occurred. The reason for the error can be
+ found by calling the `cupsLastError` and/or `cupsLastErrorString` functions.
+
+The callback function returns 0 to stop enumeration or 1 to continue.
+
+> **Note:**
+>
+> The callback function will likely be called multiple times for the
+> same destination, so it is up to the caller to suppress any duplicate
+> destinations.
+
+The following example shows how to use `cupsEnumDests` to get a filtered array
+of destinations:
+
+ typedef struct
+ {
+ int num_dests;
+ cups_dest_t *dests;
+ } my_user_data_t;
+
+ int
+ my_dest_cb(my_user_data_t *user_data, unsigned flags,
+ cups_dest_t *dest)
+ {
+ if (flags & CUPS_DEST_FLAGS_REMOVED)
+ {
+ /*
+ * Remove destination from array...
+ */
+
+ user_data->num_dests =
+ cupsRemoveDest(dest->name, dest->instance,
+ user_data->num_dests,
+ &(user_data->dests));
+ }
+ else
+ {
+ /*
+ * Add destination to array...
+ */
+
+ user_data->num_dests =
+ cupsCopyDest(dest, user_data->num_dests,
+ &(user_data->dests));
+ }
+
+ return (1);
+ }
+
+ int
+ my_get_dests(cups_ptype_t type, cups_ptype_t mask,
+ cups_dest_t **dests)
+ {
+ my_user_data_t user_data = { 0, NULL };
+
+ if (!cupsEnumDests(CUPS_DEST_FLAGS_NONE, 1000, NULL, type,
+ mask, (cups_dest_cb_t)my_dest_cb,
+ &user_data))
+ {
+ /*
+ * An error occurred, free all of the destinations and
+ * return...
+ */
+
+ cupsFreeDests(user_data.num_dests, user_dasta.dests);
+
+ *dests = NULL;
+
+ return (0);
+ }
+
+ /*
+ * Return the destination array...
+ */
+
+ *dests = user_data.dests;
+
+ return (user_data.num_dests);
+ }
+
+
+## Basic Destination Information
+
+The `num_options` and `options` members of the `cups_dest_t` structure provide
+basic attributes about the destination in addition to the user default options
+and values for that destination. The following names are predefined for various
+destination attributes:
+
+- "auth-info-required": The type of authentication required for printing to this
+ destination: "none", "username,password", "domain,username,password", or
+ "negotiate" (Kerberos).
+- "printer-info": The human-readable description of the destination such as "My
+ Laser Printer".
+- "printer-is-accepting-jobs": "true" if the destination is accepting new jobs,
+ "false" otherwise.
+- "printer-is-shared": "true" if the destination is being shared with other
+ computers, "false" otherwise.
+- "printer-location": The human-readable location of the destination such as
+ "Lab 4".
+- "printer-make-and-model": The human-readable make and model of the destination
+ such as "ExampleCorp LaserPrinter 4000 Series".
+- "printer-state": "3" if the destination is idle, "4" if the destination is
+ printing a job, and "5" if the destination is stopped.
+- "printer-state-change-time": The UNIX time when the destination entered the
+ current state.
+- "printer-state-reasons": Additional comma-delimited state keywords for the
+ destination such as "media-tray-empty-error" and "toner-low-warning".
+- "printer-type": The `cups_ptype_t` value associated with the destination.
+- "printer-uri-supported": The URI associated with the destination; if not set,
+ this destination was discovered but is not yet setup as a local printer.
+
+Use the `cupsGetOption` function to retrieve the value. For example, the
+following code gets the make and model of a destination:
+
+ const char *model = cupsGetOption("printer-make-and-model",
+ dest->num_options,
+ dest->options);
+
+
+## Detailed Destination Information
+
+Once a destination has been chosen, the `cupsCopyDestInfo` function can be used
+to gather detailed information about the destination:
+
+ cups_dinfo_t *
+ cupsCopyDestInfo(http_t *http, cups_dest_t *dest);
+
+The `http` argument specifies a connection to the CUPS scheduler and is
+typically the constant `CUPS_HTTP_DEFAULT`. The `dest` argument specifies the
+destination to query.
+
+The `cups_dinfo_t` structure that is returned contains a snapshot of the
+supported options and their supported, ready, and default values. It also can
+report constraints between different options and values, and recommend changes
+to resolve those constraints.
+
+
+### Getting Supported Options and Values
+
+The `cupsCheckDestSupported` function can be used to test whether a particular
+option or option and value is supported:
+
+ int
+ cupsCheckDestSupported(http_t *http, cups_dest_t *dest,
+ cups_dinfo_t *info,
+ const char *option,
+ const char *value);
+
+The `option` argument specifies the name of the option to check. The following
+constants can be used to check the various standard options:
+
+- `CUPS_COPIES`: Controls the number of copies that are produced.
+- `CUPS_FINISHINGS`: A comma-delimited list of integer constants that control
+ the finishing processes that are applied to the job, including stapling,
+ punching, and folding.
+- `CUPS_MEDIA`: Controls the media size that is used, typically one of the
+ following: `CUPS_MEDIA_3X5`, `CUPS_MEDIA_4X6`, `CUPS_MEDIA_5X7`,
+ `CUPS_MEDIA_8X10`, `CUPS_MEDIA_A3`, `CUPS_MEDIA_A4`, `CUPS_MEDIA_A5`,
+ `CUPS_MEDIA_A6`, `CUPS_MEDIA_ENV10`, `CUPS_MEDIA_ENVDL`, `CUPS_MEDIA_LEGAL`,
+ `CUPS_MEDIA_LETTER`, `CUPS_MEDIA_PHOTO_L`, `CUPS_MEDIA_SUPERBA3`, or
+ `CUPS_MEDIA_TABLOID`.
+- `CUPS_MEDIA_SOURCE`: Controls where the media is pulled from, typically either
+ `CUPS_MEDIA_SOURCE_AUTO` or `CUPS_MEDIA_SOURCE_MANUAL`.
+- `CUPS_MEDIA_TYPE`: Controls the type of media that is used, typically one of
+ the following: `CUPS_MEDIA_TYPE_AUTO`, `CUPS_MEDIA_TYPE_ENVELOPE`,
+ `CUPS_MEDIA_TYPE_LABELS`, `CUPS_MEDIA_TYPE_LETTERHEAD`,
+ `CUPS_MEDIA_TYPE_PHOTO`, `CUPS_MEDIA_TYPE_PHOTO_GLOSSY`,
+ `CUPS_MEDIA_TYPE_PHOTO_MATTE`, `CUPS_MEDIA_TYPE_PLAIN`, or
+ `CUPS_MEDIA_TYPE_TRANSPARENCY`.
+- `CUPS_NUMBER_UP`: Controls the number of document pages that are placed on
+ each media side.
+- `CUPS_ORIENTATION`: Controls the orientation of document pages placed on the
+ media: `CUPS_ORIENTATION_PORTRAIT` or `CUPS_ORIENTATION_LANDSCAPE`.
+- `CUPS_PRINT_COLOR_MODE`: Controls whether the output is in color
+ \(`CUPS_PRINT_COLOR_MODE_COLOR`), grayscale
+ \(`CUPS_PRINT_COLOR_MODE_MONOCHROME`), or either
+ \(`CUPS_PRINT_COLOR_MODE_AUTO`).
+- `CUPS_PRINT_QUALITY`: Controls the generate quality of the output:
+ `CUPS_PRINT_QUALITY_DRAFT`, `CUPS_PRINT_QUALITY_NORMAL`, or
+ `CUPS_PRINT_QUALITY_HIGH`.
+- `CUPS_SIDES`: Controls whether prints are placed on one or both sides of the
+ media: `CUPS_SIDES_ONE_SIDED`, `CUPS_SIDES_TWO_SIDED_PORTRAIT`, or
+ `CUPS_SIDES_TWO_SIDED_LANDSCAPE`.
+
+If the `value` argument is `NULL`, the `cupsCheckDestSupported` function returns
+whether the option is supported by the destination. Otherwise, the function
+returns whether the specified value of the option is supported.
+
+The `cupsFindDestSupported` function returns the IPP attribute containing the
+supported values for a given option:
+
+ ipp_attribute_t *
+ cupsFindDestSupported(http_t *http, cups_dest_t *dest,
+ cups_dinfo_t *dinfo,
+ const char *option);
+
+For example, the following code prints the supported finishing processes for a
+destination, if any, to the standard output:
+
+ cups_dinfo_t *info = cupsCopyDestInfo(CUPS_HTTP_DEFAULT,
+ dest);
+
+ if (cupsCheckDestSupported(CUPS_HTTP_DEFAULT, dest, info,
+ CUPS_FINISHINGS, NULL))
+ {
+ ipp_attribute_t *finishings =
+ cupsFindDestSupported(CUPS_HTTP_DEFAULT, dest, info,
+ CUPS_FINISHINGS);
+ int i, count = ippGetCount(finishings);
+
+ puts("finishings supported:");
+ for (i = 0; i < count; i ++)
+ printf(" %d\n", ippGetInteger(finishings, i));
+ }
+ else
+ puts("finishings not supported.");
+
+The "job-creation-attributes" option can be queried to get a list of supported
+options. For example, the following code prints the list of supported options
+to the standard output:
+
+ ipp_attribute_t *attrs =
+ cupsFindDestSupported(CUPS_HTTP_DEFAULT, dest, info,
+ "job-creation-attributes");
+ int i, count = ippGetCount(attrs);
+
+ for (i = 0; i < count; i ++)
+ puts(ippGetString(attrs, i, NULL));
+
+
+### Getting Default Values
+
+There are two sets of default values - user defaults that are available via the
+`num_options` and `options` members of the `cups_dest_t` structure, and
+destination defaults that available via the `cups_dinfo_t` structure and the
+`cupsFindDestDefault` function which returns the IPP attribute containing the
+default value(s) for a given option:
+
+ ipp_attribute_t *
+ cupsFindDestDefault(http_t *http, cups_dest_t *dest,
+ cups_dinfo_t *dinfo,
+ const char *option);
+
+The user defaults from `cupsGetOption` should always take preference over the
+destination defaults. For example, the following code prints the default
+finishings value(s) to the standard output:
+
+ const char *def_value =
+ cupsGetOption(CUPS_FINISHINGS, dest->num_options,
+ dest->options);
+ ipp_attribute_t *def_attr =
+ cupsFindDestDefault(CUPS_HTTP_DEFAULT, dest, info,
+ CUPS_FINISHINGS);
+
+ if (def_value != NULL)
+ {
+ printf("Default finishings: %s\n", def_value);
+ }
+ else
+ {
+ int i, count = ippGetCount(def_attr);
+
+ printf("Default finishings: %d",
+ ippGetInteger(def_attr, 0));
+ for (i = 1; i < count; i ++)
+ printf(",%d", ippGetInteger(def_attr, i));
+ putchar('\n');
+ }
+
+
+### Getting Ready (Loaded) Values
+
+The finishings and media options also support queries for the ready, or loaded,
+values. For example, a printer may have punch and staple finishers installed
+but be out of staples - the supported values will list both punch and staple
+finishing processes but the ready values will only list the punch processes.
+Similarly, a printer may support hundreds of different sizes of media but only
+have a single size loaded at any given time - the ready values are limited to
+the media that is actually in the printer.
+
+The `cupsFindDestReady` function finds the IPP attribute containing the ready
+values for a given option:
+
+ ipp_attribute_t *
+ cupsFindDestReady(http_t *http, cups_dest_t *dest,
+ cups_dinfo_t *dinfo, const char *option);
+
+For example, the following code lists the ready finishing processes:
+
+ ipp_attribute_t *ready_finishings =
+ cupsFindDestReady(CUPS_HTTP_DEFAULT, dest, info,
+ CUPS_FINISHINGS);
+
+ if (ready_finishings != NULL)
+ {
+ int i, count = ippGetCount(ready_finishings);
+
+ puts("finishings ready:");
+ for (i = 0; i < count; i ++)
+ printf(" %d\n", ippGetInteger(ready_finishings, i));
+ }
+ else
+ puts("no finishings are ready.");
+
+
+### Media Size Options
+
+CUPS provides functions for querying the dimensions and margins for each of the
+supported media size options. The `cups_size_t` structure is used to describe a
+media size:
+
+ typedef struct cups_size_s
+ {
+ char media[128];
+ int width, length;
+ int bottom, left, right, top;
+ } cups_size_t;
+
+The `width` and `length` members specify the dimensions of the media in
+hundredths of millimeters (1/2540th of an inch). The `bottom`, `left`, `right`,
+and `top` members specify the margins of the printable area, also in hundredths
+of millimeters.
+
+The `cupsGetDestMediaByName` and `cupsGetDestMediaBySize` functions lookup the
+media size information using a standard media size name or dimensions in
+hundredths of millimeters:
+
+ int
+ cupsGetDestMediaByName(http_t *http, cups_dest_t *dest,
+ cups_dinfo_t *dinfo,
+ const char *media,
+ unsigned flags, cups_size_t *size);
+
+ int
+ cupsGetDestMediaBySize(http_t *http, cups_dest_t *dest,
+ cups_dinfo_t *dinfo,
+ int width, int length,
+ unsigned flags, cups_size_t *size);
+
+The `media`, `width`, and `length` arguments specify the size to lookup. The
+`flags` argument specifies a bitfield controlling various lookup options:
+
+- `CUPS_MEDIA_FLAGS_DEFAULT`: Find the closest size supported by the printer.
+- `CUPS_MEDIA_FLAGS_BORDERLESS`: Find a borderless size.
+- `CUPS_MEDIA_FLAGS_DUPLEX`: Find a size compatible with two-sided printing.
+- `CUPS_MEDIA_FLAGS_EXACT`: Find an exact match for the size.
+- `CUPS_MEDIA_FLAGS_READY`: If the printer supports media sensing or
+ configuration of the media in each tray/source, find the size amongst the
+ "ready" media.
+
+If a matching size is found for the destination, the size information is stored
+in the structure pointed to by the `size` argument and 1 is returned. Otherwise
+0 is returned.
+
+For example, the following code prints the margins for two-sided printing on US
+Letter media:
+
+ cups_size_t size;
+
+ if (cupsGetDestMediaByName(CUPS_HTTP_DEFAULT, dest, info,
+ CUPS_MEDIA_LETTER,
+ CUPS_MEDIA_FLAGS_DUPLEX, &size))
+ {
+ puts("Margins for duplex US Letter:");
+ printf(" Bottom: %.2fin\n", size.bottom / 2540.0);
+ printf(" Left: %.2fin\n", size.left / 2540.0);
+ printf(" Right: %.2fin\n", size.right / 2540.0);
+ printf(" Top: %.2fin\n", size.top / 2540.0);
+ }
+ else
+ puts("Margins for duplex US Letter are not available.");
+
+You can also enumerate all of the sizes that match a given `flags` value using
+the `cupsGetDestMediaByIndex` and `cupsGetDestMediaCount` functions:
+
+ int
+ cupsGetDestMediaByIndex(http_t *http, cups_dest_t *dest,
+ cups_dinfo_t *dinfo, int n,
+ unsigned flags, cups_size_t *size);
+
+ int
+ cupsGetDestMediaCount(http_t *http, cups_dest_t *dest,
+ cups_dinfo_t *dinfo, unsigned flags);
+
+For example, the following code prints the list of ready media and corresponding
+margins:
+
+ cups_size_t size;
+ int i;
+ int count = cupsGetDestMediaCount(CUPS_HTTP_DEFAULT,
+ dest, info,
+ CUPS_MEDIA_FLAGS_READY);
+
+ for (i = 0; i < count; i ++)
+ {
+ if (cupsGetDestMediaByIndex(CUPS_HTTP_DEFAULT, dest, info,
+ i, CUPS_MEDIA_FLAGS_READY,
+ &size))
+ {
+ printf("%s:\n", size.name);
+ printf(" Width: %.2fin\n", size.width / 2540.0);
+ printf(" Length: %.2fin\n", size.length / 2540.0);
+ printf(" Bottom: %.2fin\n", size.bottom / 2540.0);
+ printf(" Left: %.2fin\n", size.left / 2540.0);
+ printf(" Right: %.2fin\n", size.right / 2540.0);
+ printf(" Top: %.2fin\n", size.top / 2540.0);
+ }
+ }
+
+Finally, the `cupsGetDestMediaDefault` function returns the default media size:
+
+ int
+ cupsGetDestMediaDefault(http_t *http, cups_dest_t *dest,
+ cups_dinfo_t *dinfo, unsigned flags,
+ cups_size_t *size);
+
+
+### Localizing Options and Values
+
+CUPS provides three functions to get localized, human-readable strings in the
+user's current locale for options and values: `cupsLocalizeDestMedia`,
+`cupsLocalizeDestOption`, and `cupsLocalizeDestValue`:
+
+ const char *
+ cupsLocalizeDestMedia(http_t *http, cups_dest_t *dest,
+ cups_dinfo_t *info, unsigned flags,
+ cups_size_t *size);
+
+ const char *
+ cupsLocalizeDestOption(http_t *http, cups_dest_t *dest,
+ cups_dinfo_t *info,
+ const char *option);
+
+ const char *
+ cupsLocalizeDestValue(http_t *http, cups_dest_t *dest,
+ cups_dinfo_t *info,
+ const char *option, const char *value);
+
+
+## Submitting a Print Job
+
+Once you are ready to submit a print job, you create a job using the
+`cupsCreateDestJob` function:
+
+ ipp_status_t
+ cupsCreateDestJob(http_t *http, cups_dest_t *dest,
+ cups_dinfo_t *info, int *job_id,
+ const char *title, int num_options,
+ cups_option_t *options);
+
+The `title` argument specifies a name for the print job such as "My Document".
+The `num_options` and `options` arguments specify the options for the print
+job which are allocated using the `cupsAddOption` function.
+
+When successful, the job's numeric identifier is stored in the integer pointed
+to by the `job_id` argument and `IPP_STATUS_OK` is returned. Otherwise, an IPP
+error status is returned.
+
+For example, the following code creates a new job that will print 42 copies of a
+two-sided US Letter document:
+
+ int job_id = 0;
+ int num_options = 0;
+ cups_option_t *options = NULL;
+
+ num_options = cupsAddOption(CUPS_COPIES, "42",
+ num_options, &options);
+ num_options = cupsAddOption(CUPS_MEDIA, CUPS_MEDIA_LETTER,
+ num_options, &options);
+ num_options = cupsAddOption(CUPS_SIDES,
+ CUPS_SIDES_TWO_SIDED_PORTRAIT,
+ num_options, &options);
+
+ if (cupsCreateDestJob(CUPS_HTTP_DEFAULT, dest, info,
+ &job_id, "My Document", num_options,
+ options) == IPP_STATUS_OK)
+ printf("Created job: %d\n", job_id);
+ else
+ printf("Unable to create job: %s\n",
+ cupsLastErrorString());
+
+Once the job is created, you submit documents for the job using the
+`cupsStartDestDocument`, `cupsWriteRequestData`, and `cupsFinishDestDocument`
+functions:
+
+ http_status_t
+ cupsStartDestDocument(http_t *http, cups_dest_t *dest,
+ cups_dinfo_t *info, int job_id,
+ const char *docname,
+ const char *format,
+ int num_options,
+ cups_option_t *options,
+ int last_document);
+
+ http_status_t
+ cupsWriteRequestData(http_t *http, const char *buffer,
+ size_t length);
+
+ ipp_status_t
+ cupsFinishDestDocument(http_t *http, cups_dest_t *dest,
+ cups_dinfo_t *info);
+
+The `docname` argument specifies the name of the document, typically the
+original filename. The `format` argument specifies the MIME media type of the
+document, including the following constants:
+
+- `CUPS_FORMAT_JPEG`: "image/jpeg"
+- `CUPS_FORMAT_PDF`: "application/pdf"
+- `CUPS_FORMAT_POSTSCRIPT`: "application/postscript"
+- `CUPS_FORMAT_TEXT`: "text/plain"
+
+The `num_options` and `options` arguments specify per-document print options,
+which at present must be 0 and `NULL`. The `last_document` argument specifies
+whether this is the last document in the job.
+
+For example, the following code submits a PDF file to the job that was just
+created:
+
+ FILE *fp = fopen("filename.pdf", "rb");
+ size_t bytes;
+ char buffer[65536];
+
+ if (cupsStartDestDocument(CUPS_HTTP_DEFAULT, dest, info,
+ job_id, "filename.pdf", 0, NULL,
+ 1) == HTTP_STATUS_CONTINUE)
+ {
+ while ((bytes = fread(buffer, 1, sizeof(buffer), fp)) > 0)
+ if (cupsWriteRequestData(CUPS_HTTP_DEFAULT, buffer,
+ bytes) != HTTP_STATUS_CONTINUE)
+ break;
+
+ if (cupsFinishDestDocument(CUPS_HTTP_DEFAULT, dest,
+ info) == IPP_STATUS_OK)
+ puts("Document send succeeded.");
+ else
+ printf("Document send failed: %s\n",
+ cupsLastErrorString());
+ }
+
+ fclose(fp);
+
+
+# Sending IPP Requests
+
+CUPS provides a rich API for sending IPP requests to the scheduler or printers,
+typically from management or utility applications whose primary purpose is not
+to send print jobs.
+
+
+## Connecting to the Scheduler or Printer
+
+The connection to the scheduler or printer is represented by the HTTP connection
+type `http_t`. The `cupsConnectDest` function connects to the scheduler or
+printer associated with the destination:
+
+ http_t *
+ cupsConnectDest(cups_dest_t *dest, unsigned flags, int msec,
+ int *cancel, char *resource,
+ size_t resourcesize, cups_dest_cb_t cb,
+ void *user_data);
+
+The `dest` argument specifies the destination to connect to.
+
+The `flags` argument specifies whether you want to connect to the scheduler
+(`CUPS_DEST_FLAGS_NONE`) or device/printer (`CUPS_DEST_FLAGS_DEVICE`) associated
+with the destination.
+
+The `msec` argument specifies how long you are willing to wait for the
+connection to be established in milliseconds. Specify a value of `-1` to wait
+indefinitely.
+
+The `cancel` argument specifies the address of an integer variable that can be
+set to a non-zero value to cancel the connection. Specify a value of `NULL`
+to not provide a cancel variable.
+
+The `resource` and `resourcesize` arguments specify the address and size of a
+character string array to hold the path to use when sending an IPP request.
+
+The `cb` and `user_data` arguments specify a destination callback function that
+returns 1 to continue connecting or 0 to stop. The destination callback work
+the same way as the one used for the `cupsEnumDests` function.
+
+On success, a HTTP connection is returned that can be used to send IPP requests
+and get IPP responses.
+
+For example, the following code connects to the printer associated with a
+destination with a 30 second timeout:
+
+ char resource[256];
+ http_t *http = cupsConnectDest(dest, CUPS_DEST_FLAGS_DEVICE,
+ 30000, NULL, resource,
+ sizeof(resource), NULL, NULL);
+
+
+## Creating an IPP Request
+
+IPP requests are represented by the IPP message type `ipp_t` and each IPP
+attribute in the request is representing using the type `ipp_attribute_t`. Each
+IPP request includes an operation code (`IPP_OP_CREATE_JOB`,
+`IPP_OP_GET_PRINTER_ATTRIBUTES`, etc.) and a 32-bit integer identifier.
+
+The `ippNewRequest` function creates a new IPP request:
+
+ ipp_t *
+ ippNewRequest(ipp_op_t op);
+
+The `op` argument specifies the IPP operation code for the request. For
+example, the following code creates an IPP Get-Printer-Attributes request:
+
+ ipp_t *request = ippNewRequest(IPP_OP_GET_PRINTER_ATTRIBUTES);
+
+The request identifier is automatically set to a unique value for the current
+process.
+
+Each IPP request starts with two IPP attributes, "attributes-charset" and
+"attributes-natural-language", followed by IPP attribute(s) that specify the
+target of the operation. The `ippNewRequest` automatically adds the correct
+"attributes-charset" and "attributes-natural-language" attributes, but you must
+add the target attribute(s). For example, the following code adds the
+"printer-uri" attribute to the IPP Get-Printer-Attributes request to specify
+which printer is being queried:
+
+ const char *printer_uri = cupsGetOption("device-uri",
+ dest->num_options,
+ dest->options);
+
+ ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI,
+ "printer-uri", NULL, printer_uri);
+
+> **Note:**
+>
+> If we wanted to query the scheduler instead of the device, we would look
+> up the "printer-uri-supported" option instead of the "device-uri" value.
+
+The `ippAddString` function adds the "printer-uri" attribute the the IPP
+request. The `IPP_TAG_OPERATION` argument specifies that the attribute is part
+of the operation. The `IPP_TAG_URI` argument specifies that the value is a
+Universal Resource Identifier (URI) string. The `NULL` argument specifies there
+is no language (English, French, Japanese, etc.) associated with the string, and
+the `printer_uri` argument specifies the string value.
+
+The IPP Get-Printer-Attributes request also supports an IPP attribute called
+"requested-attributes" that lists the attributes and values you are interested
+in. For example, the following code requests the printer state attributes:
+
+ static const char * const requested_attributes[] =
+ {
+ "printer-state",
+ "printer-state-message",
+ "printer-state-reasons"
+ };
+
+ ippAddStrings(request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD,
+ "requested-attributes", 3, NULL,
+ requested_attributes);
+
+The `ippAddStrings` function adds an attribute with one or more strings, in this
+case three. The `IPP_TAG_KEYWORD` argument specifies that the strings are
+keyword values, which are used for attribute names. All strings use the same
+language (`NULL`), and the attribute will contain the three strings in the
+array `requested_attributes`.
+
+CUPS provides many functions to adding attributes of different types:
+
+- `ippAddBoolean` adds a boolean (`IPP_TAG_BOOLEAN`) attribute with one value.
+- `ippAddInteger` adds an enum (`IPP_TAG_ENUM`) or integer (`IPP_TAG_INTEGER`)
+ attribute with one value.
+- `ippAddIntegers` adds an enum or integer attribute with one or more values.
+- `ippAddOctetString` adds an octetString attribute with one value.
+- `ippAddOutOfBand` adds a admin-defined (`IPP_TAG_ADMINDEFINE`), default
+ (`IPP_TAG_DEFAULT`), delete-attribute (`IPP_TAG_DELETEATTR`), no-value
+ (`IPP_TAG_NOVALUE`), not-settable (`IPP_TAG_NOTSETTABLE`), unknown
+ (`IPP_TAG_UNKNOWN`), or unsupported (`IPP_TAG_UNSUPPORTED_VALUE`) out-of-band
+ attribute.
+- `ippAddRange` adds a rangeOfInteger attribute with one range.
+- `ippAddRanges` adds a rangeOfInteger attribute with one or more ranges.
+- `ippAddResolution` adds a resolution attribute with one resolution.
+- `ippAddResolutions` adds a resolution attribute with one or more resolutions.
+- `ippAddString` adds a charset (`IPP_TAG_CHARSET`), keyword (`IPP_TAG_KEYWORD`),
+ mimeMediaType (`IPP_TAG_MIMETYPE`), name (`IPP_TAG_NAME` and
+ `IPP_TAG_NAMELANG`), naturalLanguage (`IPP_TAG_NATURAL_LANGUAGE`), text
+ (`IPP_TAG_TEXT` and `IPP_TAG_TEXTLANG`), uri (`IPP_TAG_URI`), or uriScheme
+ (`IPP_TAG_URISCHEME`) attribute with one value.
+- `ippAddStrings` adds a charset, keyword, mimeMediaType, name, naturalLanguage,
+ text, uri, or uriScheme attribute with one or more values.
+
+
+## Sending the IPP Request
+
+Once you have created the IPP request, you can send it using the
+`cupsDoRequest` function. For example, the following code sends the IPP
+Get-Printer-Attributes request to the destination and saves the response:
+
+ ipp_t *response = cupsDoRequest(http, request, resource);
+
+For requests like Send-Document that include a file, the `cupsDoFileRequest`
+function should be used:
+
+ ipp_t *response = cupsDoFileRequest(http, request, resource,
+ filename);
+
+Both `cupsDoRequest` and `cupsDoFileRequest` free the IPP request. If a valid
+IPP response is received, it is stored in a new IPP message (`ipp_t`) and
+returned to the caller. Otherwise `NULL` is returned.
+
+The status from the most recent request can be queried using the `cupsLastError`
+function, for example:
+
+ if (cupsLastError() >= IPP_STATUS_ERROR_BAD_REQUEST)
+ {
+ /* request failed */
+ }
+
+A human-readable error message is also available using the `cupsLastErrorString`
+function:
+
+ if (cupsLastError() >= IPP_STATUS_ERROR_BAD_REQUEST)
+ {
+ /* request failed */
+ printf("Request failed: %s\n", cupsLastErrorString());
+ }
+
+
+## Processing the IPP Response
+
+Each response to an IPP request is also an IPP message (`ipp_t`) with its own
+IPP attributes (`ipp_attribute_t`) that includes a status code (`IPP_STATUS_OK`,
+`IPP_STATUS_ERROR_BAD_REQUEST`, etc.) and the corresponding 32-bit integer
+identifier from the request.
+
+For example, the following code finds the printer state attributes and prints
+their values:
+
+ ipp_attribute_t *attr;
+
+ if ((attr = ippFindAttribute(response, "printer-state",
+ IPP_TAG_ENUM)) != NULL)
+ {
+ printf("printer-state=%s\n",
+ ippEnumString("printer-state", ippGetInteger(attr, 0)));
+ }
+ else
+ puts("printer-state=unknown");
+
+ if ((attr = ippFindAttribute(response, "printer-state-message",
+ IPP_TAG_TEXT)) != NULL)
+ {
+ printf("printer-state-message=\"%s\"\n",
+ ippGetString(attr, 0, NULL)));
+ }
+
+ if ((attr = ippFindAttribute(response, "printer-state-reasons",
+ IPP_TAG_KEYWORD)) != NULL)
+ {
+ int i, count = ippGetCount(attr);
+
+ puts("printer-state-reasons=");
+ for (i = 0; i < count; i ++)
+ printf(" %s\n", ippGetString(attr, i, NULL)));
+ }
+
+The `ippGetCount` function returns the number of values in an attribute.
+
+The `ippGetInteger` and `ippGetString` functions return a single integer or
+string value from an attribute.
+
+The `ippEnumString` function converts a enum value to its keyword (string)
+equivalent.
+
+Once you are done using the IPP response message, free it using the `ippDelete`
+function:
+
+ ippDelete(response);
+
+
+## Authentication
+
+CUPS normally handles authentication through the console. GUI applications
+should set a password callback using the `cupsSetPasswordCB2` function:
+
+ void
+ cupsSetPasswordCB2(cups_password_cb2_t cb, void *user_data);
+
+The password callback will be called when needed and is responsible for setting
+the current user name using `cupsSetUser` and returning a string:
+
+ const char *
+ cups_password_cb2(const char *prompt, http_t *http,
+ const char *method, const char *resource,
+ void *user_data);
+
+The `prompt` argument is a string from CUPS that should be displayed to the
+user.
+
+The `http` argument is the connection hosting the request that is being
+authenticated. The password callback can call the `httpGetField` and
+`httpGetSubField` functions to look for additional details concerning the
+authentication challenge.
+
+The `method` argument specifies the HTTP method used for the request and is
+typically "POST".
+
+The `resource` argument specifies the path used for the request.
+
+The `user_data` argument provides the user data pointer from the
+`cupsSetPasswordCB2` call.
diff --git a/cups/cupspm.opacity b/cups/cupspm.opacity
new file mode 100644
index 0000000..261626f
Binary files /dev/null and b/cups/cupspm.opacity differ
diff --git a/cups/cupspm.png b/cups/cupspm.png
new file mode 100644
index 0000000..d9ac067
Binary files /dev/null and b/cups/cupspm.png differ
diff --git a/cups/custom.c b/cups/custom.c
deleted file mode 100644
index 4c4cc8a..0000000
--- a/cups/custom.c
+++ /dev/null
@@ -1,122 +0,0 @@
-/*
- * "$Id: custom.c 6649 2007-07-11 21:46:42Z mike $"
- *
- * PPD custom option routines for CUPS.
- *
- * Copyright 2007-2012 by Apple Inc.
- * Copyright 1997-2006 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
- * file is missing or damaged, see the license at "http://www.cups.org/".
- *
- * PostScript is a trademark of Adobe Systems, Inc.
- *
- * This code and any derivative of it may be used and distributed
- * freely under the terms of the GNU General Public License when
- * used with GNU Ghostscript or its derivatives. Use of the code
- * (or any derivative of it) with software other than GNU
- * GhostScript (or its derivatives) is governed by the CUPS license
- * agreement.
- *
- * This file is subject to the Apple OS-Developed Software exception.
- *
- * Contents:
- *
- * ppdFindCustomOption() - Find a custom option.
- * ppdFindCustomParam() - Find a parameter for a custom option.
- * ppdFirstCustomParam() - Return the first parameter for a custom option.
- * ppdNextCustomParam() - Return the next parameter for a custom option.
- */
-
-/*
- * Include necessary headers.
- */
-
-#include "cups-private.h"
-
-
-/*
- * 'ppdFindCustomOption()' - Find a custom option.
- *
- * @since CUPS 1.2/OS X 10.5@
- */
-
-ppd_coption_t * /* O - Custom option or NULL */
-ppdFindCustomOption(ppd_file_t *ppd, /* I - PPD file */
- const char *keyword)/* I - Custom option name */
-{
- ppd_coption_t key; /* Custom option search key */
-
-
- if (!ppd)
- return (NULL);
-
- strlcpy(key.keyword, keyword, sizeof(key.keyword));
- return ((ppd_coption_t *)cupsArrayFind(ppd->coptions, &key));
-}
-
-
-/*
- * 'ppdFindCustomParam()' - Find a parameter for a custom option.
- *
- * @since CUPS 1.2/OS X 10.5@
- */
-
-ppd_cparam_t * /* O - Custom parameter or NULL */
-ppdFindCustomParam(ppd_coption_t *opt, /* I - Custom option */
- const char *name) /* I - Parameter name */
-{
- ppd_cparam_t *param; /* Current custom parameter */
-
-
- if (!opt)
- return (NULL);
-
- for (param = (ppd_cparam_t *)cupsArrayFirst(opt->params);
- param;
- param = (ppd_cparam_t *)cupsArrayNext(opt->params))
- if (!_cups_strcasecmp(param->name, name))
- break;
-
- return (param);
-}
-
-
-/*
- * 'ppdFirstCustomParam()' - Return the first parameter for a custom option.
- *
- * @since CUPS 1.2/OS X 10.5@
- */
-
-ppd_cparam_t * /* O - Custom parameter or NULL */
-ppdFirstCustomParam(ppd_coption_t *opt) /* I - Custom option */
-{
- if (!opt)
- return (NULL);
-
- return ((ppd_cparam_t *)cupsArrayFirst(opt->params));
-}
-
-
-/*
- * 'ppdNextCustomParam()' - Return the next parameter for a custom option.
- *
- * @since CUPS 1.2/OS X 10.5@
- */
-
-ppd_cparam_t * /* O - Custom parameter or NULL */
-ppdNextCustomParam(ppd_coption_t *opt) /* I - Custom option */
-{
- if (!opt)
- return (NULL);
-
- return ((ppd_cparam_t *)cupsArrayNext(opt->params));
-}
-
-
-/*
- * End of "$Id: custom.c 6649 2007-07-11 21:46:42Z mike $".
- */
diff --git a/cups/debug-internal.h b/cups/debug-internal.h
new file mode 100644
index 0000000..2b57854
--- /dev/null
+++ b/cups/debug-internal.h
@@ -0,0 +1,84 @@
+/*
+ * Internal debugging macros for CUPS.
+ *
+ * Copyright © 2007-2018 by Apple Inc.
+ * Copyright © 1997-2005 by Easy Software Products.
+ *
+ * Licensed under Apache License v2.0. See the file "LICENSE" for more
+ * information.
+ */
+
+#ifndef _CUPS_DEBUG_INTERNAL_H_
+# define _CUPS_DEBUG_INTERNAL_H_
+
+
+/*
+ * Include necessary headers...
+ */
+
+# include "debug-private.h"
+
+
+/*
+ * C++ magic...
+ */
+
+# ifdef __cplusplus
+extern "C" {
+# endif /* __cplusplus */
+
+
+/*
+ * The debug macros are used if you compile with DEBUG defined.
+ *
+ * Usage:
+ *
+ * DEBUG_puts("string")
+ * DEBUG_printf(("format string", arg, arg, ...));
+ *
+ * Note the extra parenthesis around the DEBUG_printf macro...
+ *
+ * Newlines are not required on the end of messages, as both add one when
+ * writing the output.
+ *
+ * If the first character is a digit, then it represents the "log level" of the
+ * message from 0 to 9. The default level is 1. The following defines the
+ * current levels we use:
+ *
+ * 0 = public APIs, other than value accessor functions
+ * 1 = return values for public APIs
+ * 2 = public value accessor APIs, progress for public APIs
+ * 3 = return values for value accessor APIs
+ * 4 = private APIs, progress for value accessor APIs
+ * 5 = return values for private APIs
+ * 6 = progress for private APIs
+ * 7 = static functions
+ * 8 = return values for static functions
+ * 9 = progress for static functions
+ */
+
+# ifdef DEBUG
+# define DEBUG_puts(x) _cups_debug_puts(x)
+# define DEBUG_printf(x) _cups_debug_printf x
+# else
+# define DEBUG_puts(x)
+# define DEBUG_printf(x)
+# endif /* DEBUG */
+
+
+/*
+ * Prototypes...
+ */
+
+# ifdef DEBUG
+extern int _cups_debug_fd _CUPS_INTERNAL;
+extern int _cups_debug_level _CUPS_INTERNAL;
+extern void _cups_debug_printf(const char *format, ...) _CUPS_FORMAT(1,2) _CUPS_INTERNAL;
+extern void _cups_debug_puts(const char *s) _CUPS_INTERNAL;
+# endif /* DEBUG */
+
+# ifdef __cplusplus
+}
+# endif /* __cplusplus */
+
+#endif /* !_CUPS_DEBUG_INTERNAL_H_ */
diff --git a/cups/debug-private.h b/cups/debug-private.h
index 23a0ae1..fb84a2f 100644
--- a/cups/debug-private.h
+++ b/cups/debug-private.h
@@ -1,16 +1,11 @@
/*
- * Private debugging macros for CUPS.
+ * Private debugging APIs for CUPS.
*
- * Copyright 2007-2012 by Apple Inc.
- * Copyright 1997-2005 by Easy Software Products.
+ * Copyright © 2007-2018 by Apple Inc.
+ * Copyright © 1997-2005 by Easy Software Products.
*
- * 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.
+ * Licensed under Apache License v2.0. See the file "LICENSE" for more
+ * information.
*/
#ifndef _CUPS_DEBUG_PRIVATE_H_
@@ -38,51 +33,17 @@ extern "C" {
*
* Usage:
*
- * DEBUG_puts("string")
- * DEBUG_printf(("format string", arg, arg, ...));
- *
- * Note the extra parenthesis around the DEBUG_printf macro...
- *
- * Newlines are not required on the end of messages, as both add one when
- * writing the output.
- *
- * If the first character is a digit, then it represents the "log level" of the
- * message from 0 to 9. The default level is 1. The following defines the
- * current levels we use:
- *
- * 0 = public APIs, other than value accessor functions
- * 1 = return values for public APIs
- * 2 = public value accessor APIs, progress for public APIs
- * 3 = return values for value accessor APIs
- * 4 = private APIs, progress for value accessor APIs
- * 5 = return values for private APIs
- * 6 = progress for private APIs
- * 7 = static functions
- * 8 = return values for static functions
- * 9 = progress for static functions
+ * DEBUG_set("logfile", "level", "filter", 1)
*
* The DEBUG_set macro allows an application to programmatically enable (or
* disable) debug logging. The arguments correspond to the CUPS_DEBUG_LOG,
- * CUPS_DEBUG_LEVEL, and CUPS_DEBUG_FILTER environment variables.
+ * CUPS_DEBUG_LEVEL, and CUPS_DEBUG_FILTER environment variables. The 1 on the
+ * end forces the values to override the environment.
*/
# ifdef DEBUG
-# ifdef WIN32
-# ifdef LIBCUPS2_EXPORTS
-# define DLLExport __declspec(dllexport)
-# else
-# define DLLExport
-# endif /* LIBCUPS2_EXPORTS */
-# else
-# define DLLExport
-# endif /* WIN32 */
-# define DEBUG_puts(x) _cups_debug_puts(x)
-# define DEBUG_printf(x) _cups_debug_printf x
# define DEBUG_set(logfile,level,filter) _cups_debug_set(logfile,level,filter,1)
# else
-# define DLLExport
-# define DEBUG_puts(x)
-# define DEBUG_printf(x)
# define DEBUG_set(logfile,level,filter)
# endif /* DEBUG */
@@ -91,18 +52,11 @@ extern "C" {
* Prototypes...
*/
-extern int _cups_debug_fd;
-extern int _cups_debug_level;
-extern void DLLExport _cups_debug_printf(const char *format, ...)
- __attribute__ ((__format__ (__printf__, 1, 2)));
-extern void DLLExport _cups_debug_puts(const char *s);
-extern void DLLExport _cups_debug_set(const char *logfile,
- const char *level, const char *filter,
- int force);
-# ifdef WIN32
-extern int _cups_gettimeofday(struct timeval *tv, void *tz);
+extern void _cups_debug_set(const char *logfile, const char *level, const char *filter, int force) _CUPS_PRIVATE;
+# ifdef _WIN32
+extern int _cups_gettimeofday(struct timeval *tv, void *tz) _CUPS_PRIVATE;
# define gettimeofday(a,b) _cups_gettimeofday(a, b)
-# endif /* WIN32 */
+# endif /* _WIN32 */
# ifdef __cplusplus
}
diff --git a/cups/debug.c b/cups/debug.c
index bd244fe..6b3914e 100644
--- a/cups/debug.c
+++ b/cups/debug.c
@@ -1,15 +1,10 @@
/*
* Debugging functions for CUPS.
*
- * Copyright 2008-2015 by Apple Inc.
+ * Copyright © 2008-2018 by Apple Inc.
*
- * 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.
+ * Licensed under Apache License v2.0. See the file "LICENSE" for more
+ * information.
*/
/*
@@ -17,8 +12,9 @@
*/
#include "cups-private.h"
+#include "debug-internal.h"
#include "thread-private.h"
-#ifdef WIN32
+#ifdef _WIN32
# include
# include
# include
@@ -36,11 +32,12 @@ _cups_gettimeofday(struct timeval *tv, /* I - Timeval struct */
#else
# include
# include
-#endif /* WIN32 */
+#endif /* _WIN32 */
#include
#include
+#ifdef DEBUG
/*
* Globals...
*/
@@ -51,7 +48,6 @@ int _cups_debug_level = 1;
/* Log level (0 to 9) */
-#ifdef DEBUG
/*
* Local globals...
*/
@@ -83,7 +79,7 @@ debug_thread_id(void)
* '_cups_debug_printf()' - Write a formatted line to the log.
*/
-void DLLExport
+void
_cups_debug_printf(const char *format, /* I - Printf-style format string */
...) /* I - Additional arguments as needed */
{
@@ -168,7 +164,7 @@ _cups_debug_printf(const char *format, /* I - Printf-style format string */
* '_cups_debug_puts()' - Write a single line to the log.
*/
-void DLLExport
+void
_cups_debug_puts(const char *s) /* I - String to output */
{
struct timeval curtime; /* Current time */
@@ -248,7 +244,7 @@ _cups_debug_puts(const char *s) /* I - String to output */
* '_cups_debug_set()' - Enable or disable debug logging.
*/
-void DLLExport
+void
_cups_debug_set(const char *logfile, /* I - Log file or NULL */
const char *level, /* I - Log level or NULL */
const char *filter, /* I - Filter string or NULL */
@@ -318,6 +314,24 @@ _cups_debug_set(const char *logfile, /* I - Log file or NULL */
_cupsMutexUnlock(&debug_init_mutex);
}
+
+
+#else
+/*
+ * '_cups_debug_set()' - Enable or disable debug logging.
+ */
+
+void
+_cups_debug_set(const char *logfile, /* I - Log file or NULL */
+ const char *level, /* I - Log level or NULL */
+ const char *filter, /* I - Filter string or NULL */
+ int force) /* I - Force initialization */
+{
+ (void)logfile;
+ (void)level;
+ (void)filter;
+ (void)force;
+}
#endif /* DEBUG */
diff --git a/cups/dest-job.c b/cups/dest-job.c
index f12b1dc..f4e5b33 100644
--- a/cups/dest-job.c
+++ b/cups/dest-job.c
@@ -3,13 +3,7 @@
*
* Copyright 2012-2017 by Apple Inc.
*
- * 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.
+ * Licensed under Apache License v2.0. See the file "LICENSE" for more information.
*/
/*
@@ -17,6 +11,7 @@
*/
#include "cups-private.h"
+#include "debug-internal.h"
/*
diff --git a/cups/dest-localization.c b/cups/dest-localization.c
index 6d75a97..67d01f4 100644
--- a/cups/dest-localization.c
+++ b/cups/dest-localization.c
@@ -1,15 +1,9 @@
/*
* Destination localization support for CUPS.
*
- * Copyright 2012-2014 by Apple Inc.
+ * Copyright 2012-2017 by Apple Inc.
*
- * 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.
+ * Licensed under Apache License v2.0. See the file "LICENSE" for more information.
*/
/*
@@ -17,6 +11,7 @@
*/
#include "cups-private.h"
+#include "debug-internal.h"
/*
@@ -24,9 +19,6 @@
*/
static void cups_create_localizations(http_t *http, cups_dinfo_t *dinfo);
-static int cups_read_strings(cups_file_t *fp, char *buffer, size_t bufsize,
- char **id, char **str);
-static char *cups_scan_strings(char *buffer);
/*
@@ -53,68 +45,30 @@ cupsLocalizeDestMedia(
pwg_media_t *pwg; /* PWG media information */
cups_array_t *db; /* Media database */
_cups_media_db_t *mdb; /* Media database entry */
- char name[1024], /* Size name */
+ char lstr[1024], /* Localized size name */
temp[256]; /* Temporary string */
const char *lsize, /* Localized media size */
*lsource, /* Localized media source */
*ltype; /* Localized media type */
+ DEBUG_printf(("cupsLocalizeDestMedia(http=%p, dest=%p, dinfo=%p, flags=%x, size=%p(\"%s\"))", (void *)http, (void *)dest, (void *)dinfo, flags, (void *)size, size ? size->media : "(null)"));
+
/*
* Range check input...
*/
if (!http || !dest || !dinfo || !size)
{
+ DEBUG_puts("1cupsLocalizeDestMedia: Returning NULL.");
_cupsSetError(IPP_STATUS_ERROR_INTERNAL, strerror(EINVAL), 0);
return (NULL);
}
/*
- * See if the localization is cached...
+ * Find the matching media database entry...
*/
- if (!dinfo->localizations)
- cups_create_localizations(http, dinfo);
-
- key.id = size->media;
- if ((match = (_cups_message_t *)cupsArrayFind(dinfo->localizations, &key)) != NULL)
- return (match->str);
-
- /*
- * If not, get the localized size, source, and type strings...
- */
-
- lang = cupsLangDefault();
- pwg = pwgMediaForSize(size->width, size->length);
-
- if (pwg->ppd)
- lsize = _cupsLangString(lang, pwg->ppd);
- else
- lsize = NULL;
-
- if (!lsize)
- {
- if ((size->width % 635) == 0 && (size->length % 635) == 0)
- {
- /*
- * Use inches since the size is a multiple of 1/4 inch.
- */
-
- snprintf(temp, sizeof(temp), _cupsLangString(lang, _("%g x %g")), size->width / 2540.0, size->length / 2540.0);
- }
- else
- {
- /*
- * Use millimeters since the size is not a multiple of 1/4 inch.
- */
-
- snprintf(temp, sizeof(temp), _cupsLangString(lang, _("%d x %d mm")), (size->width + 50) / 100, (size->length + 50) / 100);
- }
-
- lsize = temp;
- }
-
if (flags & CUPS_MEDIA_FLAGS_READY)
db = dinfo->ready_db;
else
@@ -139,12 +93,80 @@ cupsLocalizeDestMedia(
}
}
+ /*
+ * See if the localization is cached...
+ */
+
+ lang = cupsLangDefault();
+
+ if (!dinfo->localizations)
+ cups_create_localizations(http, dinfo);
+
+ snprintf(temp, sizeof(temp), "media.%s", size->media);
+ key.msg = temp;
+
+ if ((match = (_cups_message_t *)cupsArrayFind(dinfo->localizations, &key)) != NULL)
+ {
+ lsize = match->str;
+ }
+ else
+ {
+ /*
+ * Not a media name, try a media-key name...
+ */
+
+ snprintf(temp, sizeof(temp), "media-key.%s", size->media);
+ if ((match = (_cups_message_t *)cupsArrayFind(dinfo->localizations, &key)) != NULL)
+ lsize = match->str;
+ else
+ lsize = NULL;
+ }
+
+ if (!lsize && (pwg = pwgMediaForSize(size->width, size->length)) != NULL && pwg->ppd)
+ {
+ /*
+ * Get a standard localization...
+ */
+
+ snprintf(temp, sizeof(temp), "media.%s", pwg->pwg);
+ if ((lsize = _cupsLangString(lang, temp)) == temp)
+ lsize = NULL;
+ }
+
+ if (!lsize)
+ {
+ /*
+ * Make a dimensional localization...
+ */
+
+ if ((size->width % 635) == 0 && (size->length % 635) == 0)
+ {
+ /*
+ * Use inches since the size is a multiple of 1/4 inch.
+ */
+
+ snprintf(temp, sizeof(temp), _cupsLangString(lang, _("%g x %g \"")), size->width / 2540.0, size->length / 2540.0);
+ }
+ else
+ {
+ /*
+ * Use millimeters since the size is not a multiple of 1/4 inch.
+ */
+
+ snprintf(temp, sizeof(temp), _cupsLangString(lang, _("%d x %d mm")), (size->width + 50) / 100, (size->length + 50) / 100);
+ }
+
+ lsize = temp;
+ }
+
if (mdb)
{
DEBUG_printf(("1cupsLocalizeDestMedia: MATCH mdb%p [key=\"%s\" size_name=\"%s\" source=\"%s\" type=\"%s\" width=%d length=%d B%d L%d R%d T%d]", (void *)mdb, mdb->key, mdb->size_name, mdb->source, mdb->type, mdb->width, mdb->length, mdb->bottom, mdb->left, mdb->right, mdb->top));
- lsource = cupsLocalizeDestValue(http, dest, dinfo, "media-source", mdb->source);
- ltype = cupsLocalizeDestValue(http, dest, dinfo, "media-type", mdb->type);
+ if ((lsource = cupsLocalizeDestValue(http, dest, dinfo, "media-source", mdb->source)) == mdb->source && mdb->source)
+ lsource = _cupsLangString(lang, _("Other Tray"));
+ if ((ltype = cupsLocalizeDestValue(http, dest, dinfo, "media-type", mdb->type)) == mdb->type && mdb->type)
+ ltype = _cupsLangString(lang, _("Other Media"));
}
else
{
@@ -154,41 +176,43 @@ cupsLocalizeDestMedia(
if (!lsource && !ltype)
{
- if (size->bottom || size->left || size->right || size->top)
- snprintf(name, sizeof(name), _cupsLangString(lang, _("%s (Borderless)")), lsize);
+ if (!size->bottom && !size->left && !size->right && !size->top)
+ snprintf(lstr, sizeof(lstr), _cupsLangString(lang, _("%s (Borderless)")), lsize);
else
- strlcpy(name, lsize, sizeof(name));
+ strlcpy(lstr, lsize, sizeof(lstr));
}
else if (!lsource)
{
- if (size->bottom || size->left || size->right || size->top)
- snprintf(name, sizeof(name), _cupsLangString(lang, _("%s (Borderless, %s)")), lsize, ltype);
+ if (!size->bottom && !size->left && !size->right && !size->top)
+ snprintf(lstr, sizeof(lstr), _cupsLangString(lang, _("%s (Borderless, %s)")), lsize, ltype);
else
- snprintf(name, sizeof(name), _cupsLangString(lang, _("%s (%s)")), lsize, ltype);
+ snprintf(lstr, sizeof(lstr), _cupsLangString(lang, _("%s (%s)")), lsize, ltype);
}
else if (!ltype)
{
- if (size->bottom || size->left || size->right || size->top)
- snprintf(name, sizeof(name), _cupsLangString(lang, _("%s (Borderless, %s)")), lsize, lsource);
+ if (!size->bottom && !size->left && !size->right && !size->top)
+ snprintf(lstr, sizeof(lstr), _cupsLangString(lang, _("%s (Borderless, %s)")), lsize, lsource);
else
- snprintf(name, sizeof(name), _cupsLangString(lang, _("%s (%s)")), lsize, lsource);
+ snprintf(lstr, sizeof(lstr), _cupsLangString(lang, _("%s (%s)")), lsize, lsource);
}
else
{
- if (size->bottom || size->left || size->right || size->top)
- snprintf(name, sizeof(name), _cupsLangString(lang, _("%s (Borderless, %s, %s)")), lsize, ltype, lsource);
+ if (!size->bottom && !size->left && !size->right && !size->top)
+ snprintf(lstr, sizeof(lstr), _cupsLangString(lang, _("%s (Borderless, %s, %s)")), lsize, ltype, lsource);
else
- snprintf(name, sizeof(name), _cupsLangString(lang, _("%s (%s, %s)")), lsize, ltype, lsource);
+ snprintf(lstr, sizeof(lstr), _cupsLangString(lang, _("%s (%s, %s)")), lsize, ltype, lsource);
}
if ((match = (_cups_message_t *)calloc(1, sizeof(_cups_message_t))) == NULL)
return (NULL);
- match->id = strdup(size->media);
- match->str = strdup(name);
+ match->msg = strdup(size->media);
+ match->str = strdup(lstr);
cupsArrayAdd(dinfo->localizations, match);
+ DEBUG_printf(("1cupsLocalizeDestMedia: Returning \"%s\".", match->str));
+
return (match->str);
}
@@ -212,21 +236,22 @@ cupsLocalizeDestOption(
{
_cups_message_t key, /* Search key */
*match; /* Matching entry */
+ const char *localized; /* Localized string */
+ DEBUG_printf(("cupsLocalizeDestOption(http=%p, dest=%p, dinfo=%p, option=\"%s\")", (void *)http, (void *)dest, (void *)dinfo, option));
+
if (!http || !dest || !dinfo)
return (option);
if (!dinfo->localizations)
cups_create_localizations(http, dinfo);
- if (cupsArrayCount(dinfo->localizations) == 0)
- return (option);
-
- key.id = (char *)option;
- if ((match = (_cups_message_t *)cupsArrayFind(dinfo->localizations,
- &key)) != NULL)
+ key.msg = (char *)option;
+ if ((match = (_cups_message_t *)cupsArrayFind(dinfo->localizations, &key)) != NULL)
return (match->str);
+ else if ((localized = _cupsLangString(cupsLangDefault(), option)) != NULL)
+ return (localized);
else
return (option);
}
@@ -253,22 +278,39 @@ cupsLocalizeDestValue(
_cups_message_t key, /* Search key */
*match; /* Matching entry */
char pair[256]; /* option.value pair */
+ const char *localized; /* Localized string */
+ DEBUG_printf(("cupsLocalizeDestValue(http=%p, dest=%p, dinfo=%p, option=\"%s\", value=\"%s\")", (void *)http, (void *)dest, (void *)dinfo, option, value));
+
if (!http || !dest || !dinfo)
return (value);
+ if (!strcmp(option, "media"))
+ {
+ pwg_media_t *media = pwgMediaForPWG(value);
+ cups_size_t size;
+
+ strlcpy(size.media, value, sizeof(size.media));
+ size.width = media ? media->width : 0;
+ size.length = media ? media->length : 0;
+ size.left = 0;
+ size.right = 0;
+ size.bottom = 0;
+ size.top = 0;
+
+ return (cupsLocalizeDestMedia(http, dest, dinfo, CUPS_MEDIA_FLAGS_DEFAULT, &size));
+ }
+
if (!dinfo->localizations)
cups_create_localizations(http, dinfo);
- if (cupsArrayCount(dinfo->localizations) == 0)
- return (value);
-
snprintf(pair, sizeof(pair), "%s.%s", option, value);
- key.id = pair;
- if ((match = (_cups_message_t *)cupsArrayFind(dinfo->localizations,
- &key)) != NULL)
+ key.msg = pair;
+ if ((match = (_cups_message_t *)cupsArrayFind(dinfo->localizations, &key)) != NULL)
return (match->str);
+ else if ((localized = _cupsLangString(cupsLangDefault(), pair)) != NULL && strcmp(localized, pair))
+ return (localized);
else
return (value);
}
@@ -299,12 +341,6 @@ cups_create_localizations(
cups_file_t *temp; /* Temporary file */
- /*
- * Create an empty message catalog...
- */
-
- dinfo->localizations = _cupsMessageNew(NULL);
-
/*
* See if there are any localizations...
*/
@@ -313,12 +349,12 @@ cups_create_localizations(
IPP_TAG_URI)) == NULL)
{
/*
- * Nope...
+ * Nope, create an empty message catalog...
*/
- DEBUG_puts("4cups_create_localizations: No printer-strings-uri (uri) "
- "value.");
- return; /* Nope */
+ dinfo->localizations = _cupsMessageNew(NULL);
+ DEBUG_puts("4cups_create_localizations: No printer-strings-uri (uri) value.");
+ return;
}
/*
@@ -331,8 +367,8 @@ cups_create_localizations(
hostname, sizeof(hostname), &port, resource,
sizeof(resource)) < HTTP_URI_STATUS_OK)
{
- DEBUG_printf(("4cups_create_localizations: Bad printer-strings-uri value "
- "\"%s\".", attr->values[0].string.text));
+ dinfo->localizations = _cupsMessageNew(NULL);
+ DEBUG_printf(("4cups_create_localizations: Bad printer-strings-uri value \"%s\".", attr->values[0].string.text));
return;
}
@@ -381,9 +417,9 @@ cups_create_localizations(
}
status = cupsGetFd(http2, resource, cupsFileNumber(temp));
+ cupsFileClose(temp);
- DEBUG_printf(("4cups_create_localizations: GET %s = %s", resource,
- httpStatus(status)));
+ DEBUG_printf(("4cups_create_localizations: GET %s = %s", resource, httpStatus(status)));
if (status == HTTP_STATUS_OK)
{
@@ -391,35 +427,7 @@ cups_create_localizations(
* Got the file, read it...
*/
- char buffer[8192], /* Message buffer */
- *id, /* ID string */
- *str; /* Translated message */
- _cups_message_t *m; /* Current message */
-
- lseek(cupsFileNumber(temp), 0, SEEK_SET);
-
- while (cups_read_strings(temp, buffer, sizeof(buffer), &id, &str))
- {
- if ((m = malloc(sizeof(_cups_message_t))) == NULL)
- break;
-
- m->id = strdup(id);
- m->str = strdup(str);
-
- if (m->id && m->str)
- cupsArrayAdd(dinfo->localizations, m);
- else
- {
- if (m->id)
- free(m->id);
-
- if (m->str)
- free(m->str);
-
- free(m);
- break;
- }
- }
+ dinfo->localizations = _cupsMessageLoad(tempfile, _CUPS_MESSAGE_STRINGS);
}
DEBUG_printf(("4cups_create_localizations: %d messages loaded.",
@@ -430,102 +438,8 @@ cups_create_localizations(
*/
unlink(tempfile);
- cupsFileClose(temp);
if (http2 != http)
httpClose(http2);
}
-
-/*
- * 'cups_read_strings()' - Read a pair of strings from a .strings file.
- */
-
-static int /* O - 1 on success, 0 on failure */
-cups_read_strings(cups_file_t *strings, /* I - .strings file */
- char *buffer, /* I - Line buffer */
- size_t bufsize, /* I - Size of line buffer */
- char **id, /* O - Pointer to ID string */
- char **str) /* O - Pointer to translation string */
-{
- char *bufptr; /* Pointer into buffer */
-
-
- while (cupsFileGets(strings, buffer, bufsize))
- {
- if (buffer[0] != '\"')
- continue;
-
- *id = buffer + 1;
- bufptr = cups_scan_strings(buffer);
-
- if (*bufptr != '\"')
- continue;
-
- *bufptr++ = '\0';
-
- while (*bufptr && *bufptr != '\"')
- bufptr ++;
-
- if (!*bufptr)
- continue;
-
- *str = bufptr + 1;
- bufptr = cups_scan_strings(bufptr);
-
- if (*bufptr != '\"')
- continue;
-
- *bufptr = '\0';
-
- return (1);
- }
-
- return (0);
-}
-
-
-/*
- * 'cups_scan_strings()' - Scan a quoted string.
- */
-
-static char * /* O - End of string */
-cups_scan_strings(char *buffer) /* I - Start of string */
-{
- char *bufptr; /* Pointer into string */
-
-
- for (bufptr = buffer + 1; *bufptr && *bufptr != '\"'; bufptr ++)
- {
- if (*bufptr == '\\')
- {
- if (bufptr[1] >= '0' && bufptr[1] <= '3' &&
- bufptr[2] >= '0' && bufptr[2] <= '7' &&
- bufptr[3] >= '0' && bufptr[3] <= '7')
- {
- /*
- * Decode \nnn octal escape...
- */
-
- *bufptr = (char)(((((bufptr[1] - '0') << 3) | (bufptr[2] - '0')) << 3) | (bufptr[3] - '0'));
- _cups_strcpy(bufptr + 1, bufptr + 4);
- }
- else
- {
- /*
- * Decode \C escape...
- */
-
- _cups_strcpy(bufptr, bufptr + 1);
- if (*bufptr == 'n')
- *bufptr = '\n';
- else if (*bufptr == 'r')
- *bufptr = '\r';
- else if (*bufptr == 't')
- *bufptr = '\t';
- }
- }
- }
-
- return (bufptr);
-}
diff --git a/cups/dest-options.c b/cups/dest-options.c
index 51705a5..8c5fe66 100644
--- a/cups/dest-options.c
+++ b/cups/dest-options.c
@@ -1,15 +1,10 @@
/*
* Destination option/media support for CUPS.
*
- * Copyright 2012-2017 by Apple Inc.
+ * Copyright © 2012-2019 by Apple Inc.
*
- * 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.
+ * Licensed under Apache License v2.0. See the file "LICENSE" for more
+ * information.
*/
/*
@@ -17,6 +12,7 @@
*/
#include "cups-private.h"
+#include "debug-internal.h"
/*
@@ -31,6 +27,8 @@
*/
static void cups_add_dconstres(cups_array_t *a, ipp_t *collection);
+static int cups_collection_contains(ipp_t *test, ipp_t *match);
+static size_t cups_collection_string(ipp_attribute_t *attr, char *buffer, size_t bufsize) _CUPS_NONNULL((1,2));
static int cups_compare_dconstres(_cups_dconstres_t *a,
_cups_dconstres_t *b);
static int cups_compare_media_db(_cups_media_db_t *a,
@@ -58,6 +56,104 @@ static cups_array_t *cups_test_constraints(cups_dinfo_t *dinfo,
static void cups_update_ready(http_t *http, cups_dinfo_t *dinfo);
+/*
+ * 'cupsAddDestMediaOptions()' - Add the option corresponding to the specified media size.
+ *
+ * @since CUPS 2.3/macOS 10.14@
+ */
+
+int /* O - New number of options */
+cupsAddDestMediaOptions(
+ http_t *http, /* I - Connection to destination */
+ cups_dest_t *dest, /* I - Destination */
+ cups_dinfo_t *dinfo, /* I - Destination information */
+ unsigned flags, /* I - Media matching flags */
+ cups_size_t *size, /* I - Media size */
+ int num_options, /* I - Current number of options */
+ cups_option_t **options) /* IO - Options */
+{
+ cups_array_t *db; /* Media database */
+ _cups_media_db_t *mdb; /* Media database entry */
+ char value[2048]; /* Option value */
+
+
+ /*
+ * Range check input...
+ */
+
+ if (!http || !dest || !dinfo || !size || !options)
+ {
+ _cupsSetError(IPP_STATUS_ERROR_INTERNAL, strerror(EINVAL), 0);
+ return (num_options);
+ }
+
+ /*
+ * Find the matching media size...
+ */
+
+ if (flags & CUPS_MEDIA_FLAGS_READY)
+ db = dinfo->ready_db;
+ else
+ db = dinfo->media_db;
+
+ DEBUG_printf(("1cupsAddDestMediaOptions: size->media=\"%s\"", size->media));
+
+ for (mdb = (_cups_media_db_t *)cupsArrayFirst(db); mdb; mdb = (_cups_media_db_t *)cupsArrayNext(db))
+ {
+ if (mdb->key && !strcmp(mdb->key, size->media))
+ break;
+ else if (mdb->size_name && !strcmp(mdb->size_name, size->media))
+ break;
+ }
+
+ if (!mdb)
+ {
+ for (mdb = (_cups_media_db_t *)cupsArrayFirst(db); mdb; mdb = (_cups_media_db_t *)cupsArrayNext(db))
+ {
+ if (mdb->width == size->width && mdb->length == size->length && mdb->bottom == size->bottom && mdb->left == size->left && mdb->right == size->right && mdb->top == size->top)
+ break;
+ }
+ }
+
+ if (!mdb)
+ {
+ for (mdb = (_cups_media_db_t *)cupsArrayFirst(db); mdb; mdb = (_cups_media_db_t *)cupsArrayNext(db))
+ {
+ if (mdb->width == size->width && mdb->length == size->length)
+ break;
+ }
+ }
+
+ if (!mdb)
+ {
+ DEBUG_puts("1cupsAddDestMediaOptions: Unable to find matching size.");
+ return (num_options);
+ }
+
+ DEBUG_printf(("1cupsAddDestMediaOptions: MATCH mdb%p [key=\"%s\" size_name=\"%s\" source=\"%s\" type=\"%s\" width=%d length=%d B%d L%d R%d T%d]", (void *)mdb, mdb->key, mdb->size_name, mdb->source, mdb->type, mdb->width, mdb->length, mdb->bottom, mdb->left, mdb->right, mdb->top));
+
+ if (mdb->source)
+ {
+ if (mdb->type)
+ snprintf(value, sizeof(value), "{media-size={x-dimension=%d y-dimension=%d} media-bottom-margin=%d media-left-margin=%d media-right-margin=%d media-top-margin=%d media-source=\"%s\" media-type=\"%s\"}", mdb->width, mdb->length, mdb->bottom, mdb->left, mdb->right, mdb->top, mdb->source, mdb->type);
+ else
+ snprintf(value, sizeof(value), "{media-size={x-dimension=%d y-dimension=%d} media-bottom-margin=%d media-left-margin=%d media-right-margin=%d media-top-margin=%d media-source=\"%s\"}", mdb->width, mdb->length, mdb->bottom, mdb->left, mdb->right, mdb->top, mdb->source);
+ }
+ else if (mdb->type)
+ {
+ snprintf(value, sizeof(value), "{media-size={x-dimension=%d y-dimension=%d} media-bottom-margin=%d media-left-margin=%d media-right-margin=%d media-top-margin=%d media-type=\"%s\"}", mdb->width, mdb->length, mdb->bottom, mdb->left, mdb->right, mdb->top, mdb->type);
+ }
+ else
+ {
+ snprintf(value, sizeof(value), "{media-size={x-dimension=%d y-dimension=%d} media-bottom-margin=%d media-left-margin=%d media-right-margin=%d media-top-margin=%d}", mdb->width, mdb->length, mdb->bottom, mdb->left, mdb->right, mdb->top);
+ }
+
+ num_options = cupsAddOption("media-col", value, num_options, options);
+
+ return (num_options);
+}
+
+
/*
* 'cupsCheckDestSupported()' - Check that the option and value are supported
* by the destination.
@@ -83,6 +179,7 @@ cupsCheckDestSupported(
ipp_res_t units_value; /* Resolution units */
ipp_attribute_t *attr; /* Attribute */
_ipp_value_t *attrval; /* Current attribute value */
+ _ipp_option_t *map; /* Option mapping information */
/*
@@ -128,10 +225,10 @@ cupsCheckDestSupported(
*/
pwg_media_t *pwg; /* Current PWG media size info */
- int min_width, /* Minimum width */
- min_length, /* Minimum length */
- max_width, /* Maximum width */
- max_length; /* Maximum length */
+ int min_width, /* Minimum width */
+ min_length, /* Minimum length */
+ max_width, /* Maximum width */
+ max_length; /* Maximum length */
/*
* Get the minimum and maximum size...
@@ -174,9 +271,14 @@ cupsCheckDestSupported(
* Check literal values...
*/
+ map = _ippFindOption(option);
+
switch (attr->value_tag)
{
case IPP_TAG_INTEGER :
+ if (map && map->value_tag == IPP_TAG_STRING)
+ return (strlen(value) <= (size_t)attr->values[0].integer);
+
case IPP_TAG_ENUM :
int_value = atoi(value);
@@ -189,7 +291,10 @@ cupsCheckDestSupported(
return (attr->values[0].boolean);
case IPP_TAG_RANGE :
- int_value = atoi(value);
+ if (map && map->value_tag == IPP_TAG_STRING)
+ int_value = (int)strlen(value);
+ else
+ int_value = atoi(value);
for (i = 0; i < attr->num_values; i ++)
if (int_value >= attr->values[i].range.lower &&
@@ -572,6 +677,7 @@ cupsCopyDestInfo(
cups_dest_t *dest) /* I - Destination */
{
cups_dinfo_t *dinfo; /* Destination information */
+ unsigned dflags; /* Destination flags */
ipp_t *request, /* Get-Printer-Attributes request */
*response; /* Supported attributes */
int tries, /* Number of tries so far */
@@ -581,6 +687,7 @@ cupsCopyDestInfo(
char resource[1024]; /* Resource path */
int version; /* IPP version */
ipp_status_t status; /* Status of request */
+ _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
static const char * const requested_attrs[] =
{ /* Requested attributes */
"job-template",
@@ -589,14 +696,35 @@ cupsCopyDestInfo(
};
- DEBUG_printf(("cupsCopyDestSupported(http=%p, dest=%p(%s))", (void *)http, (void *)dest, dest ? dest->name : ""));
+ DEBUG_printf(("cupsCopyDestInfo(http=%p, dest=%p(%s))", (void *)http, (void *)dest, dest ? dest->name : ""));
/*
* Get the default connection as needed...
*/
if (!http)
- http = _cupsConnect();
+ {
+ DEBUG_puts("1cupsCopyDestInfo: Default server connection.");
+ http = _cupsConnect();
+ dflags = CUPS_DEST_FLAGS_NONE;
+ }
+#ifdef AF_LOCAL
+ else if (httpAddrFamily(http->hostaddr) == AF_LOCAL)
+ {
+ DEBUG_puts("1cupsCopyDestInfo: Connection to server (domain socket).");
+ dflags = CUPS_DEST_FLAGS_NONE;
+ }
+#endif /* AF_LOCAL */
+ else if ((strcmp(http->hostname, cg->server) && cg->server[0] != '/') || cg->ipp_port != httpAddrPort(http->hostaddr))
+ {
+ DEBUG_printf(("1cupsCopyDestInfo: Connection to device (%s).", http->hostname));
+ dflags = CUPS_DEST_FLAGS_DEVICE;
+ }
+ else
+ {
+ DEBUG_printf(("1cupsCopyDestInfo: Connection to server (%s).", http->hostname));
+ dflags = CUPS_DEST_FLAGS_NONE;
+ }
/*
* Range check input...
@@ -609,8 +737,11 @@ cupsCopyDestInfo(
* Get the printer URI and resource path...
*/
- if ((uri = _cupsGetDestResource(dest, resource, sizeof(resource))) == NULL)
+ if ((uri = _cupsGetDestResource(dest, dflags, resource, sizeof(resource))) == NULL)
+ {
+ DEBUG_puts("1cupsCopyDestInfo: Unable to get resource.");
return (NULL);
+ }
/*
* Get the supported attributes...
@@ -628,28 +759,25 @@ cupsCopyDestInfo(
*/
request = ippNewRequest(IPP_OP_GET_PRINTER_ATTRIBUTES);
- ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri", NULL,
- uri);
- ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME,
- "requesting-user-name", NULL, cupsUser());
- ippAddStrings(request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD,
- "requested-attributes",
- (int)(sizeof(requested_attrs) / sizeof(requested_attrs[0])),
- NULL, requested_attrs);
+
+ ippSetVersion(request, version / 10, version % 10);
+ ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri", NULL, uri);
+ ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "requesting-user-name", NULL, cupsUser());
+ ippAddStrings(request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD, "requested-attributes", (int)(sizeof(requested_attrs) / sizeof(requested_attrs[0])), NULL, requested_attrs);
response = cupsDoRequest(http, request, resource);
status = cupsLastError();
if (status > IPP_STATUS_OK_IGNORED_OR_SUBSTITUTED)
{
- DEBUG_printf(("cupsCopyDestSupported: Get-Printer-Attributes for '%s' "
- "returned %s (%s)", dest->name, ippErrorString(status),
- cupsLastErrorString()));
+ DEBUG_printf(("1cupsCopyDestInfo: Get-Printer-Attributes for '%s' returned %s (%s)", dest->name, ippErrorString(status), cupsLastErrorString()));
ippDelete(response);
response = NULL;
- if (status == IPP_STATUS_ERROR_VERSION_NOT_SUPPORTED && version > 11)
+ if ((status == IPP_STATUS_ERROR_BAD_REQUEST || status == IPP_STATUS_ERROR_VERSION_NOT_SUPPORTED) && version > 11)
+ {
version = 11;
+ }
else if (status == IPP_STATUS_ERROR_BUSY)
{
sleep((unsigned)delay);
@@ -665,7 +793,10 @@ cupsCopyDestInfo(
while (!response && tries < 10);
if (!response)
+ {
+ DEBUG_puts("1cupsCopyDestInfo: Unable to get printer attributes.");
return (NULL);
+ }
/*
* Allocate a cups_dinfo_t structure and return it...
@@ -678,6 +809,8 @@ cupsCopyDestInfo(
return (NULL);
}
+ DEBUG_printf(("1cupsCopyDestInfo: version=%d, uri=\"%s\", resource=\"%s\".", version, uri, resource));
+
dinfo->version = version;
dinfo->uri = uri;
dinfo->resource = _cupsStrAlloc(resource);
@@ -938,10 +1071,10 @@ cupsGetDestMediaByIndex(
return (0);
}
- if (nsize->size_name)
- strlcpy(size->media, nsize->size_name, sizeof(size->media));
- else if (nsize->key)
+ if (nsize->key)
strlcpy(size->media, nsize->key, sizeof(size->media));
+ else if (nsize->size_name)
+ strlcpy(size->media, nsize->size_name, sizeof(size->media));
else if ((pwg = pwgMediaForSize(nsize->width, nsize->length)) != NULL)
strlcpy(size->media, pwg->pwg, sizeof(size->media));
else
@@ -1202,25 +1335,19 @@ cupsGetDestMediaDefault(
* Get the default media size, if any...
*/
- if ((media = cupsGetOption("media", dest->num_options,
- dest->options)) == NULL)
+ if ((media = cupsGetOption("media", dest->num_options, dest->options)) == NULL)
media = "na_letter_8.5x11in";
if (cupsGetDestMediaByName(http, dest, dinfo, media, flags, size))
return (1);
- if (strcmp(media, "na_letter_8.5x11in") &&
- cupsGetDestMediaByName(http, dest, dinfo, "iso_a4_210x297mm", flags,
- size))
+ if (strcmp(media, "na_letter_8.5x11in") && cupsGetDestMediaByName(http, dest, dinfo, "iso_a4_210x297mm", flags, size))
return (1);
- if (strcmp(media, "iso_a4_210x297mm") &&
- cupsGetDestMediaByName(http, dest, dinfo, "na_letter_8.5x11in", flags,
- size))
+ if (strcmp(media, "iso_a4_210x297mm") && cupsGetDestMediaByName(http, dest, dinfo, "na_letter_8.5x11in", flags, size))
return (1);
- if ((flags & CUPS_MEDIA_FLAGS_BORDERLESS) &&
- cupsGetDestMediaByName(http, dest, dinfo, "na_index_4x6in", flags, size))
+ if ((flags & CUPS_MEDIA_FLAGS_BORDERLESS) && cupsGetDestMediaByName(http, dest, dinfo, "na_index_4x6in", flags, size))
return (1);
/*
@@ -1258,6 +1385,346 @@ cups_add_dconstres(
}
+/*
+ * 'cups_collection_contains()' - Check whether test collection is contained in the matching collection.
+ */
+
+static int /* O - 1 on a match, 0 on a non-match */
+cups_collection_contains(ipp_t *test, /* I - Collection to test */
+ ipp_t *match) /* I - Matching values */
+{
+ int i, j, /* Looping vars */
+ mcount, /* Number of match values */
+ tcount; /* Number of test values */
+ ipp_attribute_t *tattr, /* Testing attribute */
+ *mattr; /* Matching attribute */
+ const char *tval; /* Testing string value */
+
+
+ for (mattr = ippFirstAttribute(match); mattr; mattr = ippNextAttribute(match))
+ {
+ if ((tattr = ippFindAttribute(test, ippGetName(mattr), IPP_TAG_ZERO)) == NULL)
+ return (0);
+
+ tcount = ippGetCount(tattr);
+
+ switch (ippGetValueTag(mattr))
+ {
+ case IPP_TAG_INTEGER :
+ case IPP_TAG_ENUM :
+ if (ippGetValueTag(tattr) != ippGetValueTag(mattr))
+ return (0);
+
+ for (i = 0; i < tcount; i ++)
+ {
+ if (!ippContainsInteger(mattr, ippGetInteger(tattr, i)))
+ return (0);
+ }
+ break;
+
+ case IPP_TAG_RANGE :
+ if (ippGetValueTag(tattr) != IPP_TAG_INTEGER)
+ return (0);
+
+ for (i = 0; i < tcount; i ++)
+ {
+ if (!ippContainsInteger(mattr, ippGetInteger(tattr, i)))
+ return (0);
+ }
+ break;
+
+ case IPP_TAG_BOOLEAN :
+ if (ippGetValueTag(tattr) != IPP_TAG_BOOLEAN || ippGetBoolean(tattr, 0) != ippGetBoolean(mattr, 0))
+ return (0);
+ break;
+
+ case IPP_TAG_TEXTLANG :
+ case IPP_TAG_NAMELANG :
+ 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 :
+ for (i = 0; i < tcount; i ++)
+ {
+ if ((tval = ippGetString(tattr, i, NULL)) == NULL || !ippContainsString(mattr, tval))
+ return (0);
+ }
+ break;
+
+ case IPP_TAG_BEGIN_COLLECTION :
+ for (i = 0; i < tcount; i ++)
+ {
+ ipp_t *tcol = ippGetCollection(tattr, i);
+ /* Testing collection */
+
+ for (j = 0, mcount = ippGetCount(mattr); j < mcount; j ++)
+ if (!cups_collection_contains(tcol, ippGetCollection(mattr, j)))
+ return (0);
+ }
+ break;
+
+ default :
+ return (0);
+ }
+ }
+
+ return (1);
+}
+
+
+/*
+ * 'cups_collection_string()' - Convert an IPP collection to an option string.
+ */
+
+static size_t /* O - Number of bytes needed */
+cups_collection_string(
+ ipp_attribute_t *attr, /* I - Collection attribute */
+ char *buffer, /* I - String buffer */
+ size_t bufsize) /* I - Size of buffer */
+{
+ int i, j, /* Looping vars */
+ count, /* Number of collection values */
+ mcount; /* Number of member values */
+ ipp_t *col; /* Collection */
+ ipp_attribute_t *first, /* First member attribute */
+ *member; /* Member attribute */
+ char *bufptr, /* Pointer into buffer */
+ *bufend, /* End of buffer */
+ temp[100]; /* Temporary string */
+ const char *mptr; /* Pointer into member value */
+ int mlen; /* Length of octetString */
+
+
+ bufptr = buffer;
+ bufend = buffer + bufsize - 1;
+
+ for (i = 0, count = ippGetCount(attr); i < count; i ++)
+ {
+ col = ippGetCollection(attr, i);
+
+ if (i)
+ {
+ if (bufptr < bufend)
+ *bufptr++ = ',';
+ else
+ bufptr ++;
+ }
+
+ if (bufptr < bufend)
+ *bufptr++ = '{';
+ else
+ bufptr ++;
+
+ for (member = first = ippFirstAttribute(col); member; member = ippNextAttribute(col))
+ {
+ const char *mname = ippGetName(member);
+
+ if (member != first)
+ {
+ if (bufptr < bufend)
+ *bufptr++ = ' ';
+ else
+ bufptr ++;
+ }
+
+ if (ippGetValueTag(member) == IPP_TAG_BOOLEAN)
+ {
+ if (!ippGetBoolean(member, 0))
+ {
+ if (bufptr < bufend)
+ strlcpy(bufptr, "no", (size_t)(bufend - bufptr + 1));
+ bufptr += 2;
+ }
+
+ if (bufptr < bufend)
+ strlcpy(bufptr, mname, (size_t)(bufend - bufptr + 1));
+ bufptr += strlen(mname);
+ continue;
+ }
+
+ if (bufptr < bufend)
+ strlcpy(bufptr, mname, (size_t)(bufend - bufptr + 1));
+ bufptr += strlen(mname);
+
+ if (bufptr < bufend)
+ *bufptr++ = '=';
+ else
+ bufptr ++;
+
+ if (ippGetValueTag(member) == IPP_TAG_BEGIN_COLLECTION)
+ {
+ /*
+ * Convert sub-collection...
+ */
+
+ bufptr += cups_collection_string(member, bufptr, bufptr < bufend ? (size_t)(bufend - bufptr + 1) : 0);
+ }
+ else
+ {
+ /*
+ * Convert simple type...
+ */
+
+ for (j = 0, mcount = ippGetCount(member); j < mcount; j ++)
+ {
+ if (j)
+ {
+ if (bufptr < bufend)
+ *bufptr++ = ',';
+ else
+ bufptr ++;
+ }
+
+ switch (ippGetValueTag(member))
+ {
+ case IPP_TAG_INTEGER :
+ case IPP_TAG_ENUM :
+ bufptr += snprintf(bufptr, bufptr < bufend ? (size_t)(bufend - bufptr + 1) : 0, "%d", ippGetInteger(member, j));
+ break;
+
+ case IPP_TAG_STRING :
+ if (bufptr < bufend)
+ *bufptr++ = '\"';
+ else
+ bufptr ++;
+
+ for (mptr = (const char *)ippGetOctetString(member, j, &mlen); mlen > 0; mlen --, mptr ++)
+ {
+ if (*mptr == '\"' || *mptr == '\\')
+ {
+ if (bufptr < bufend)
+ *bufptr++ = '\\';
+ else
+ bufptr ++;
+ }
+
+ if (bufptr < bufend)
+ *bufptr++ = *mptr;
+ else
+ bufptr ++;
+ }
+
+ if (bufptr < bufend)
+ *bufptr++ = '\"';
+ else
+ bufptr ++;
+ break;
+
+ case IPP_TAG_DATE :
+ {
+ unsigned year; /* Year */
+ const ipp_uchar_t *date = ippGetDate(member, j);
+ /* Date value */
+
+ year = ((unsigned)date[0] << 8) + (unsigned)date[1];
+
+ if (date[9] == 0 && date[10] == 0)
+ snprintf(temp, sizeof(temp), "%04u-%02u-%02uT%02u:%02u:%02uZ", year, date[2], date[3], date[4], date[5], date[6]);
+ else
+ snprintf(temp, sizeof(temp), "%04u-%02u-%02uT%02u:%02u:%02u%c%02u%02u", year, date[2], date[3], date[4], date[5], date[6], date[8], date[9], date[10]);
+
+ if (bufptr < bufend)
+ strlcpy(bufptr, temp, (size_t)(bufend - bufptr + 1));
+
+ bufptr += strlen(temp);
+ }
+ break;
+
+ case IPP_TAG_RESOLUTION :
+ {
+ int xres, /* Horizontal resolution */
+ yres; /* Vertical resolution */
+ ipp_res_t units; /* Resolution units */
+
+ xres = ippGetResolution(member, j, &yres, &units);
+
+ if (xres == yres)
+ snprintf(temp, sizeof(temp), "%d%s", xres, units == IPP_RES_PER_INCH ? "dpi" : "dpcm");
+ else
+ snprintf(temp, sizeof(temp), "%dx%d%s", xres, yres, units == IPP_RES_PER_INCH ? "dpi" : "dpcm");
+
+ if (bufptr < bufend)
+ strlcpy(bufptr, temp, (size_t)(bufend - bufptr + 1));
+
+ bufptr += strlen(temp);
+ }
+ break;
+
+ case IPP_TAG_RANGE :
+ {
+ int lower, /* Lower bound */
+ upper; /* Upper bound */
+
+ lower = ippGetRange(member, j, &upper);
+
+ snprintf(temp, sizeof(temp), "%d-%d", lower, upper);
+
+ if (bufptr < bufend)
+ strlcpy(bufptr, temp, (size_t)(bufend - bufptr + 1));
+
+ bufptr += strlen(temp);
+ }
+ break;
+
+ case IPP_TAG_TEXTLANG :
+ case IPP_TAG_NAMELANG :
+ 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 :
+ if (bufptr < bufend)
+ *bufptr++ = '\"';
+ else
+ bufptr ++;
+
+ for (mptr = ippGetString(member, j, NULL); *mptr; mptr ++)
+ {
+ if (*mptr == '\"' || *mptr == '\\')
+ {
+ if (bufptr < bufend)
+ *bufptr++ = '\\';
+ else
+ bufptr ++;
+ }
+
+ if (bufptr < bufend)
+ *bufptr++ = *mptr;
+ else
+ bufptr ++;
+ }
+
+ if (bufptr < bufend)
+ *bufptr++ = '\"';
+ else
+ bufptr ++;
+ break;
+
+ default :
+ break;
+ }
+ }
+ }
+ }
+
+ if (bufptr < bufend)
+ *bufptr++ = '}';
+ else
+ bufptr ++;
+ }
+
+ *bufptr = '\0';
+ return ((size_t)(bufptr - buffer + 1));
+}
+
+
/*
* 'cups_compare_dconstres()' - Compare to resolver entries.
*/
@@ -1445,8 +1912,6 @@ cups_create_constraints(
/*
* 'cups_create_defaults()' - Create the -default option array.
- *
- * TODO: Need to support collection defaults...
*/
static void
@@ -1465,32 +1930,26 @@ cups_create_defaults(
* xxx=value to the defaults option array.
*/
- for (attr = ippFirstAttribute(dinfo->attrs);
- attr;
- attr = ippNextAttribute(dinfo->attrs))
+ for (attr = ippFirstAttribute(dinfo->attrs); attr; attr = ippNextAttribute(dinfo->attrs))
{
- if (!attr->name || attr->group_tag != IPP_TAG_PRINTER)
+ if (!ippGetName(attr) || ippGetGroupTag(attr) != IPP_TAG_PRINTER)
continue;
- if (attr->value_tag == IPP_TAG_BEGIN_COLLECTION)
- continue; /* TODO: STR #4096 */
-
- if ((nameptr = attr->name + strlen(attr->name) - 8) <= attr->name ||
- strcmp(nameptr, "-default"))
- continue;
-
- strlcpy(name, attr->name, sizeof(name));
- if ((nameptr = name + strlen(name) - 8) <= name ||
- strcmp(nameptr, "-default"))
+ strlcpy(name, ippGetName(attr), sizeof(name));
+ if ((nameptr = name + strlen(name) - 8) <= name || strcmp(nameptr, "-default"))
continue;
*nameptr = '\0';
- if (ippAttributeString(attr, value, sizeof(value)) >= sizeof(value))
+ if (ippGetValueTag(attr) == IPP_TAG_BEGIN_COLLECTION)
+ {
+ if (cups_collection_string(attr, value, sizeof(value)) >= sizeof(value))
+ continue;
+ }
+ else if (ippAttributeString(attr, value, sizeof(value)) >= sizeof(value))
continue;
- dinfo->num_defaults = cupsAddOption(name, value, dinfo->num_defaults,
- &dinfo->defaults);
+ dinfo->num_defaults = cupsAddOption(name, value, dinfo->num_defaults, &dinfo->defaults);
}
}
@@ -1513,6 +1972,7 @@ cups_create_media_db(
pwg_media_t *pwg; /* PWG media info */
cups_array_t *db; /* New media database array */
_cups_media_db_t mdb; /* Media entry */
+ char media_key[256]; /* Synthesized media-key value */
db = cupsArrayNew3((cups_array_func_t)cups_compare_media_db,
@@ -1613,61 +2073,92 @@ cups_create_media_db(
}
}
- if ((media_attr = ippFindAttribute(val->collection, "media-color",
- IPP_TAG_ZERO)) != NULL &&
- (media_attr->value_tag == IPP_TAG_NAME ||
- media_attr->value_tag == IPP_TAG_NAMELANG ||
- media_attr->value_tag == IPP_TAG_KEYWORD))
+ if ((media_attr = ippFindAttribute(val->collection, "media-color", IPP_TAG_ZERO)) != NULL && (media_attr->value_tag == IPP_TAG_NAME || media_attr->value_tag == IPP_TAG_NAMELANG || media_attr->value_tag == IPP_TAG_KEYWORD))
mdb.color = media_attr->values[0].string.text;
- if ((media_attr = ippFindAttribute(val->collection, "media-info",
- IPP_TAG_TEXT)) != NULL)
+ if ((media_attr = ippFindAttribute(val->collection, "media-info", IPP_TAG_TEXT)) != NULL)
mdb.info = media_attr->values[0].string.text;
- if ((media_attr = ippFindAttribute(val->collection, "media-key",
- IPP_TAG_ZERO)) != NULL &&
- (media_attr->value_tag == IPP_TAG_NAME ||
- media_attr->value_tag == IPP_TAG_NAMELANG ||
- media_attr->value_tag == IPP_TAG_KEYWORD))
+ if ((media_attr = ippFindAttribute(val->collection, "media-key", IPP_TAG_ZERO)) != NULL && (media_attr->value_tag == IPP_TAG_NAME || media_attr->value_tag == IPP_TAG_NAMELANG || media_attr->value_tag == IPP_TAG_KEYWORD))
mdb.key = media_attr->values[0].string.text;
- if ((media_attr = ippFindAttribute(val->collection, "media-size-name",
- IPP_TAG_ZERO)) != NULL &&
- (media_attr->value_tag == IPP_TAG_NAME ||
- media_attr->value_tag == IPP_TAG_NAMELANG ||
- media_attr->value_tag == IPP_TAG_KEYWORD))
+ if ((media_attr = ippFindAttribute(val->collection, "media-size-name", IPP_TAG_ZERO)) != NULL && (media_attr->value_tag == IPP_TAG_NAME || media_attr->value_tag == IPP_TAG_NAMELANG || media_attr->value_tag == IPP_TAG_KEYWORD))
mdb.size_name = media_attr->values[0].string.text;
- if ((media_attr = ippFindAttribute(val->collection, "media-source",
- IPP_TAG_ZERO)) != NULL &&
- (media_attr->value_tag == IPP_TAG_NAME ||
- media_attr->value_tag == IPP_TAG_NAMELANG ||
- media_attr->value_tag == IPP_TAG_KEYWORD))
+ if ((media_attr = ippFindAttribute(val->collection, "media-source", IPP_TAG_ZERO)) != NULL && (media_attr->value_tag == IPP_TAG_NAME || media_attr->value_tag == IPP_TAG_NAMELANG || media_attr->value_tag == IPP_TAG_KEYWORD))
mdb.source = media_attr->values[0].string.text;
- if ((media_attr = ippFindAttribute(val->collection, "media-type",
- IPP_TAG_ZERO)) != NULL &&
- (media_attr->value_tag == IPP_TAG_NAME ||
- media_attr->value_tag == IPP_TAG_NAMELANG ||
- media_attr->value_tag == IPP_TAG_KEYWORD))
+ if ((media_attr = ippFindAttribute(val->collection, "media-type", IPP_TAG_ZERO)) != NULL && (media_attr->value_tag == IPP_TAG_NAME || media_attr->value_tag == IPP_TAG_NAMELANG || media_attr->value_tag == IPP_TAG_KEYWORD))
mdb.type = media_attr->values[0].string.text;
- if ((media_attr = ippFindAttribute(val->collection, "media-bottom-margin",
- IPP_TAG_INTEGER)) != NULL)
+ if ((media_attr = ippFindAttribute(val->collection, "media-bottom-margin", IPP_TAG_INTEGER)) != NULL)
mdb.bottom = media_attr->values[0].integer;
- if ((media_attr = ippFindAttribute(val->collection, "media-left-margin",
- IPP_TAG_INTEGER)) != NULL)
+ if ((media_attr = ippFindAttribute(val->collection, "media-left-margin", IPP_TAG_INTEGER)) != NULL)
mdb.left = media_attr->values[0].integer;
- if ((media_attr = ippFindAttribute(val->collection, "media-right-margin",
- IPP_TAG_INTEGER)) != NULL)
+ if ((media_attr = ippFindAttribute(val->collection, "media-right-margin", IPP_TAG_INTEGER)) != NULL)
mdb.right = media_attr->values[0].integer;
- if ((media_attr = ippFindAttribute(val->collection, "media-top-margin",
- IPP_TAG_INTEGER)) != NULL)
+ if ((media_attr = ippFindAttribute(val->collection, "media-top-margin", IPP_TAG_INTEGER)) != NULL)
mdb.top = media_attr->values[0].integer;
+ if (!mdb.key)
+ {
+ if (!mdb.size_name && (pwg = pwgMediaForSize(mdb.width, mdb.length)) != NULL)
+ mdb.size_name = (char *)pwg->pwg;
+
+ if (!mdb.size_name)
+ {
+ /*
+ * Use a CUPS-specific identifier if we don't have a size name...
+ */
+
+ if (flags & CUPS_MEDIA_FLAGS_READY)
+ snprintf(media_key, sizeof(media_key), "cups-media-ready-%d", i + 1);
+ else
+ snprintf(media_key, sizeof(media_key), "cups-media-%d", i + 1);
+ }
+ else if (mdb.source)
+ {
+ /*
+ * Generate key using size name, source, and type (if set)...
+ */
+
+ if (mdb.type)
+ snprintf(media_key, sizeof(media_key), "%s_%s_%s", mdb.size_name, mdb.source, mdb.type);
+ else
+ snprintf(media_key, sizeof(media_key), "%s_%s", mdb.size_name, mdb.source);
+ }
+ else if (mdb.type)
+ {
+ /*
+ * Generate key using size name and type...
+ */
+
+ snprintf(media_key, sizeof(media_key), "%s_%s", mdb.size_name, mdb.type);
+ }
+ else
+ {
+ /*
+ * Key is just the size name...
+ */
+
+ strlcpy(media_key, mdb.size_name, sizeof(media_key));
+ }
+
+ /*
+ * Append "_borderless" for borderless media...
+ */
+
+ if (!mdb.bottom && !mdb.left && !mdb.right && !mdb.top)
+ strlcat(media_key, "_borderless", sizeof(media_key));
+
+ mdb.key = media_key;
+ }
+
+ DEBUG_printf(("1cups_create_media_db: Adding media: key=\"%s\", width=%d, length=%d, source=\"%s\", type=\"%s\".", mdb.key, mdb.width, mdb.length, mdb.source, mdb.type));
+
cupsArrayAdd(db, &mdb);
}
@@ -2027,12 +2518,14 @@ cups_get_media_db(http_t *http, /* I - Connection to destination */
* Return the matching size...
*/
- if (best->size_name)
- strlcpy(size->media, best->size_name, sizeof(size->media));
- else if (best->key)
+ if (best->key)
strlcpy(size->media, best->key, sizeof(size->media));
- else
+ else if (best->size_name)
+ strlcpy(size->media, best->size_name, sizeof(size->media));
+ else if (pwg && pwg->pwg)
strlcpy(size->media, pwg->pwg, sizeof(size->media));
+ else
+ strlcpy(size->media, "unknown", sizeof(size->media));
size->width = best->width;
size->length = best->length;
@@ -2074,8 +2567,6 @@ cups_is_close_media_db(
/*
* 'cups_test_constraints()' - Test constraints.
- *
- * TODO: STR #4096 - Need to properly support media-col contraints...
*/
static cups_array_t * /* O - Active constraints */
@@ -2089,11 +2580,13 @@ cups_test_constraints(
cups_option_t **conflicts) /* O - Conflicting options */
{
int i, /* Looping var */
+ count, /* Number of values */
match; /* Value matches? */
int num_matching; /* Number of matching options */
cups_option_t *matching; /* Matching options */
_cups_dconstres_t *c; /* Current constraint */
cups_array_t *active = NULL; /* Active constraints */
+ ipp_t *col; /* Collection value */
ipp_attribute_t *attr; /* Current attribute */
_ipp_value_t *attrval; /* Current attribute value */
const char *value; /* Current value */
@@ -2115,17 +2608,13 @@ cups_test_constraints(
attr;
attr = ippNextAttribute(c->collection))
{
- if (attr->value_tag == IPP_TAG_BEGIN_COLLECTION)
- break; /* TODO: STR #4096 */
-
/*
* Get the value for the current attribute in the constraint...
*/
if (new_option && new_value && !strcmp(attr->name, new_option))
value = new_value;
- else if ((value = cupsGetOption(attr->name, num_options,
- options)) == NULL)
+ else if ((value = cupsGetOption(attr->name, num_options, options)) == NULL)
value = cupsGetOption(attr->name, dinfo->num_defaults, dinfo->defaults);
if (!value)
@@ -2240,6 +2729,22 @@ cups_test_constraints(
}
break;
+ case IPP_TAG_BEGIN_COLLECTION :
+ col = ippNew();
+ _cupsEncodeOption(col, IPP_TAG_ZERO, NULL, ippGetName(attr), value);
+
+ for (i = 0, count = ippGetCount(attr); i < count; i ++)
+ {
+ if (cups_collection_contains(col, ippGetCollection(attr, i)))
+ {
+ match = 1;
+ break;
+ }
+ }
+
+ ippDelete(col);
+ break;
+
default :
break;
}
@@ -2262,8 +2767,7 @@ cups_test_constraints(
cups_option_t *moption; /* Matching option */
for (i = num_matching, moption = matching; i > 0; i --, moption ++)
- *num_conflicts = cupsAddOption(moption->name, moption->value,
- *num_conflicts, conflicts);
+ *num_conflicts = cupsAddOption(moption->name, moption->value, *num_conflicts, conflicts);
}
}
diff --git a/cups/dest.c b/cups/dest.c
index fc57ed3..17d96fe 100644
--- a/cups/dest.c
+++ b/cups/dest.c
@@ -1,16 +1,11 @@
/*
* User-defined destination (and option) support for CUPS.
*
- * Copyright 2007-2017 by Apple Inc.
- * Copyright 1997-2007 by Easy Software Products.
+ * Copyright © 2007-2019 by Apple Inc.
+ * Copyright © 1997-2007 by Easy Software Products.
*
- * 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.
+ * Licensed under Apache License v2.0. See the file "LICENSE" for more
+ * information.
*/
/*
@@ -18,6 +13,7 @@
*/
#include "cups-private.h"
+#include "debug-internal.h"
#include
#ifdef HAVE_NOTIFY_H
@@ -48,10 +44,10 @@
*/
#ifdef __APPLE__
-# if !TARGET_OS_IOS
+# if HAVE_SCDYNAMICSTORECOPYCOMPUTERNAME
# include
# define _CUPS_LOCATION_DEFAULTS 1
-# endif /* !TARGET_OS_IOS */
+# endif /* HAVE_SCDYNAMICSTORECOPYCOMPUTERNAME */
# define kCUPSPrintingPrefs CFSTR("org.cups.PrintingPrefs")
# define kDefaultPaperIDKey CFSTR("DefaultPaperID")
# define kLastUsedPrintersKey CFSTR("LastUsedPrinters")
@@ -61,7 +57,10 @@
#endif /* __APPLE__ */
#if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
-# define _CUPS_DNSSD_MAXTIME 500 /* Milliseconds for maximum quantum of time */
+# define _CUPS_DNSSD_GET_DESTS 250 /* Milliseconds for cupsGetDests */
+# define _CUPS_DNSSD_MAXTIME 50 /* Milliseconds for maximum quantum of time */
+#else
+# define _CUPS_DNSSD_GET_DESTS 0 /* Milliseconds for cupsGetDests */
#endif /* HAVE_DNSSD || HAVE_AVAHI */
@@ -76,7 +75,6 @@ typedef enum _cups_dnssd_state_e /* Enumerated device state */
_CUPS_DNSSD_QUERY,
_CUPS_DNSSD_PENDING,
_CUPS_DNSSD_ACTIVE,
- _CUPS_DNSSD_LOCAL,
_CUPS_DNSSD_INCOMPATIBLE,
_CUPS_DNSSD_ERROR
} _cups_dnssd_state_t;
@@ -96,6 +94,10 @@ typedef struct _cups_dnssd_data_s /* Enumeration data */
cups_ptype_t type, /* Printer type filter */
mask; /* Printer type mask */
cups_array_t *devices; /* Devices found so far */
+ int num_dests; /* Number of lpoptions destinations */
+ cups_dest_t *dests; /* lpoptions destinations */
+ char def_name[1024], /* Default printer name, if any */
+ *def_instance; /* Default printer instance, if any */
} _cups_dnssd_data_t;
typedef struct _cups_dnssd_device_s /* Enumerated device */
@@ -122,8 +124,10 @@ typedef struct _cups_dnssd_resolve_s /* Data for resolving URI */
typedef struct _cups_getdata_s
{
- int num_dests; /* Number of destinations */
- cups_dest_t *dests; /* Destinations */
+ int num_dests; /* Number of destinations */
+ cups_dest_t *dests; /* Destinations */
+ char def_name[1024], /* Default printer name, if any */
+ *def_instance; /* Default printer instance, if any */
} _cups_getdata_t;
typedef struct _cups_namedata_s
@@ -189,14 +193,6 @@ static _cups_dnssd_device_t *
const char *regtype,
const char *replyDomain);
# ifdef HAVE_DNSSD
-static void cups_dnssd_local_cb(DNSServiceRef sdRef,
- DNSServiceFlags flags,
- uint32_t interfaceIndex,
- DNSServiceErrorType errorCode,
- const char *serviceName,
- const char *regtype,
- const char *replyDomain,
- void *context);
static void cups_dnssd_query_cb(DNSServiceRef sdRef,
DNSServiceFlags flags,
uint32_t interfaceIndex,
@@ -227,15 +223,14 @@ static void cups_dnssd_unquote(char *dst, const char *src,
size_t dstsize);
static int cups_elapsed(struct timeval *t);
#endif /* HAVE_DNSSD || HAVE_AVAHI */
+static int cups_enum_dests(http_t *http, unsigned flags, int msec, int *cancel, cups_ptype_t type, cups_ptype_t mask, cups_dest_cb_t cb, void *user_data);
static int cups_find_dest(const char *name, const char *instance,
int num_dests, cups_dest_t *dests, int prev,
int *rdiff);
static int cups_get_cb(_cups_getdata_t *data, unsigned flags, cups_dest_t *dest);
static char *cups_get_default(const char *filename, char *namebuf,
size_t namesize, const char **instance);
-static int cups_get_dests(const char *filename, const char *match_name,
- const char *match_inst, int user_default_set,
- int num_dests, cups_dest_t **dests);
+static int cups_get_dests(const char *filename, const char *match_name, const char *match_inst, int load_all, int user_default_set, int num_dests, cups_dest_t **dests);
static char *cups_make_string(ipp_attribute_t *attr, char *buffer,
size_t bufsize);
static int cups_name_cb(_cups_namedata_t *data, unsigned flags, cups_dest_t *dest);
@@ -570,7 +565,7 @@ _cupsAppleSetUseLastPrinter(
/*
- * 'cupsConnectDest()' - Open a conection to the destination.
+ * 'cupsConnectDest()' - Open a connection to the destination.
*
* Connect to the destination, returning a new @code http_t@ connection object
* and optionally the resource path to use for the destination. These calls
@@ -579,7 +574,7 @@ _cupsAppleSetUseLastPrinter(
* returns 0. The caller is responsible for calling @link httpClose@ on the
* returned connection.
*
- * Starting with CUPS 2.2.4, the caller can pass @code CUPS_DEST_FLAGS_DEVICE@
+ * Starting with CUPS 2.2.4, the caller can pass @code CUPS_DEST_FLAGS_DEVICE@
* for the "flags" argument to connect directly to the device associated with
* the destination. Otherwise, the connection is made to the CUPS scheduler
* associated with the destination.
@@ -847,6 +842,8 @@ cupsCopyDest(cups_dest_t *dest, /* I - Destination to copy */
if (new_dest)
{
+ new_dest->is_default = dest->is_default;
+
if ((new_dest->options = calloc(sizeof(cups_option_t), (size_t)dest->num_options)) == NULL)
return (cupsRemoveDest(dest->name, dest->instance, num_dests, dests));
@@ -975,406 +972,7 @@ cupsEnumDests(
cups_dest_cb_t cb, /* I - Callback function */
void *user_data) /* I - User data */
{
- int i, /* Looping var */
- num_dests; /* Number of destinations */
- cups_dest_t *dests = NULL, /* Destinations */
- *dest; /* Current destination */
- const char *defprinter; /* Default printer */
- char name[1024], /* Copy of printer name */
- *instance, /* Pointer to instance name */
- *user_default; /* User default printer */
-#if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
- int count, /* Number of queries started */
- completed, /* Number of completed queries */
- remaining; /* Remainder of timeout */
- struct timeval curtime; /* Current time */
- _cups_dnssd_data_t data; /* Data for callback */
- _cups_dnssd_device_t *device; /* Current device */
-# ifdef HAVE_DNSSD
- int nfds, /* Number of files responded */
- main_fd; /* File descriptor for lookups */
- DNSServiceRef ipp_ref = NULL, /* IPP browser */
- local_ipp_ref = NULL; /* Local IPP browser */
-# ifdef HAVE_SSL
- DNSServiceRef ipps_ref = NULL,/* IPPS browser */
- local_ipps_ref = NULL; /* Local IPPS browser */
-# endif /* HAVE_SSL */
-# ifdef HAVE_POLL
- struct pollfd pfd; /* Polling data */
-# else
- fd_set input; /* Input set for select() */
- struct timeval timeout; /* Timeout for select() */
-# endif /* HAVE_POLL */
-# else /* HAVE_AVAHI */
- int error; /* Error value */
- AvahiServiceBrowser *ipp_ref = NULL;/* IPP browser */
-# ifdef HAVE_SSL
- AvahiServiceBrowser *ipps_ref = NULL; /* IPPS browser */
-# endif /* HAVE_SSL */
-# endif /* HAVE_DNSSD */
-#endif /* HAVE_DNSSD || HAVE_AVAHI */
-
-
- /*
- * Range check input...
- */
-
- (void)flags;
-
- if (!cb)
- return (0);
-
- /*
- * Get ready to enumerate...
- */
-
-#if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
- memset(&data, 0, sizeof(data));
-
- data.type = type;
- data.mask = mask;
- data.cb = cb;
- data.user_data = user_data;
- data.devices = cupsArrayNew3((cups_array_func_t)cups_dnssd_compare_devices, NULL, NULL, 0, NULL, (cups_afree_func_t)cups_dnssd_free_device);
-#endif /* HAVE_DNSSD || HAVE_AVAHI */
-
- if (!(mask & CUPS_PRINTER_DISCOVERED) || !(type & CUPS_PRINTER_DISCOVERED))
- {
- /*
- * Get the list of local printers and pass them to the callback function...
- */
-
- num_dests = _cupsGetDests(CUPS_HTTP_DEFAULT, IPP_OP_CUPS_GET_PRINTERS, NULL,
- &dests, type, mask);
-
- if ((user_default = _cupsUserDefault(name, sizeof(name))) != NULL)
- defprinter = name;
- else if ((defprinter = cupsGetDefault2(CUPS_HTTP_DEFAULT)) != NULL)
- {
- strlcpy(name, defprinter, sizeof(name));
- defprinter = name;
- }
-
- if (defprinter)
- {
- /*
- * Separate printer and instance name...
- */
-
- if ((instance = strchr(name, '/')) != NULL)
- *instance++ = '\0';
-
- /*
- * Lookup the printer and instance and make it the default...
- */
-
- if ((dest = cupsGetDest(name, instance, num_dests, dests)) != NULL)
- dest->is_default = 1;
- }
-
- for (i = num_dests, dest = dests;
- i > 0 && (!cancel || !*cancel);
- i --, dest ++)
- {
-#if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
- const char *device_uri; /* Device URI */
-#endif /* HAVE_DNSSD || HAVE_AVAHI */
-
- if (!(*cb)(user_data, i > 1 ? CUPS_DEST_FLAGS_MORE : CUPS_DEST_FLAGS_NONE,
- dest))
- break;
-
-#if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
- if (!dest->instance && (device_uri = cupsGetOption("device-uri", dest->num_options, dest->options)) != NULL && !strncmp(device_uri, "dnssd://", 8))
- {
- /*
- * Add existing queue using service name, etc. so we don't list it again...
- */
-
- char scheme[32], /* URI scheme */
- userpass[32], /* Username:password */
- serviceName[256], /* Service name (host field) */
- resource[256], /* Resource (options) */
- *regtype, /* Registration type */
- *replyDomain; /* Registration domain */
- int port; /* Port number (not used) */
-
- if (httpSeparateURI(HTTP_URI_CODING_ALL, device_uri, scheme, sizeof(scheme), userpass, sizeof(userpass), serviceName, sizeof(serviceName), &port, resource, sizeof(resource)) >= HTTP_URI_STATUS_OK)
- {
- if ((regtype = strstr(serviceName, "._ipp")) != NULL)
- {
- *regtype++ = '\0';
-
- if ((replyDomain = strstr(regtype, "._tcp.")) != NULL)
- {
- replyDomain[5] = '\0';
- replyDomain += 6;
-
- if ((device = cups_dnssd_get_device(&data, serviceName, regtype, replyDomain)) != NULL)
- device->state = _CUPS_DNSSD_ACTIVE;
- }
- }
- }
- }
-#endif /* HAVE_DNSSD || HAVE_AVAHI */
- }
-
- cupsFreeDests(num_dests, dests);
-
- if (i > 0 || msec == 0)
- goto enum_finished;
- }
-
- /*
- * Return early if the caller doesn't want to do discovery...
- */
-
- if ((mask & CUPS_PRINTER_DISCOVERED) && !(type & CUPS_PRINTER_DISCOVERED))
- goto enum_finished;
-
-#if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
- /*
- * Get Bonjour-shared printers...
- */
-
- gettimeofday(&curtime, NULL);
-
-# ifdef HAVE_DNSSD
- if (DNSServiceCreateConnection(&data.main_ref) != kDNSServiceErr_NoError)
- return (0);
-
- main_fd = DNSServiceRefSockFD(data.main_ref);
-
- ipp_ref = data.main_ref;
- DNSServiceBrowse(&ipp_ref, kDNSServiceFlagsShareConnection, 0,
- "_ipp._tcp", NULL,
- (DNSServiceBrowseReply)cups_dnssd_browse_cb, &data);
-
- local_ipp_ref = data.main_ref;
- DNSServiceBrowse(&local_ipp_ref, kDNSServiceFlagsShareConnection,
- kDNSServiceInterfaceIndexLocalOnly,
- "_ipp._tcp", NULL,
- (DNSServiceBrowseReply)cups_dnssd_local_cb, &data);
-
-# ifdef HAVE_SSL
- ipps_ref = data.main_ref;
- DNSServiceBrowse(&ipps_ref, kDNSServiceFlagsShareConnection, 0,
- "_ipps._tcp", NULL,
- (DNSServiceBrowseReply)cups_dnssd_browse_cb, &data);
-
- local_ipps_ref = data.main_ref;
- DNSServiceBrowse(&local_ipps_ref, kDNSServiceFlagsShareConnection,
- kDNSServiceInterfaceIndexLocalOnly,
- "_ipps._tcp", NULL,
- (DNSServiceBrowseReply)cups_dnssd_local_cb, &data);
-# endif /* HAVE_SSL */
-
-# else /* HAVE_AVAHI */
- if ((data.simple_poll = avahi_simple_poll_new()) == NULL)
- {
- DEBUG_puts("cupsEnumDests: Unable to create Avahi simple poll object.");
- return (1);
- }
-
- avahi_simple_poll_set_func(data.simple_poll, cups_dnssd_poll_cb, &data);
-
- data.client = avahi_client_new(avahi_simple_poll_get(data.simple_poll),
- 0, cups_dnssd_client_cb, &data,
- &error);
- if (!data.client)
- {
- DEBUG_puts("cupsEnumDests: Unable to create Avahi client.");
- avahi_simple_poll_free(data.simple_poll);
- return (1);
- }
-
- data.browsers = 1;
- ipp_ref = avahi_service_browser_new(data.client, AVAHI_IF_UNSPEC, AVAHI_PROTO_UNSPEC, "_ipp._tcp", NULL, 0, cups_dnssd_browse_cb, &data);
-
-# ifdef HAVE_SSL
- data.browsers ++;
- ipps_ref = avahi_service_browser_new(data.client, AVAHI_IF_UNSPEC, AVAHI_PROTO_UNSPEC, "_ipps._tcp", NULL, 0, cups_dnssd_browse_cb, &data);
-# endif /* HAVE_SSL */
-# endif /* HAVE_DNSSD */
-
- if (msec < 0)
- remaining = INT_MAX;
- else
- remaining = msec;
-
- while (remaining > 0 && (!cancel || !*cancel))
- {
- /*
- * Check for input...
- */
-
- DEBUG_printf(("1cupsEnumDests: remaining=%d", remaining));
-
- cups_elapsed(&curtime);
-
-# ifdef HAVE_DNSSD
-# ifdef HAVE_POLL
- pfd.fd = main_fd;
- pfd.events = POLLIN;
-
- nfds = poll(&pfd, 1, remaining > _CUPS_DNSSD_MAXTIME ? _CUPS_DNSSD_MAXTIME : remaining);
-
-# else
- FD_ZERO(&input);
- FD_SET(main_fd, &input);
-
- timeout.tv_sec = 0;
- timeout.tv_usec = 1000 * (remaining > _CUPS_DNSSD_MAXTIME ? _CUPS_DNSSD_MAXTIME : remaining);
-
- nfds = select(main_fd + 1, &input, NULL, NULL, &timeout);
-# endif /* HAVE_POLL */
-
- if (nfds > 0)
- DNSServiceProcessResult(data.main_ref);
-
-# else /* HAVE_AVAHI */
- data.got_data = 0;
-
- if ((error = avahi_simple_poll_iterate(data.simple_poll, _CUPS_DNSSD_MAXTIME)) > 0)
- {
- /*
- * We've been told to exit the loop. Perhaps the connection to
- * Avahi failed.
- */
-
- break;
- }
-
- DEBUG_printf(("1cupsEnumDests: got_data=%d", data.got_data));
-# endif /* HAVE_DNSSD */
-
- remaining -= cups_elapsed(&curtime);
-
- for (device = (_cups_dnssd_device_t *)cupsArrayFirst(data.devices),
- count = 0, completed = 0;
- device;
- device = (_cups_dnssd_device_t *)cupsArrayNext(data.devices))
- {
- if (device->ref)
- count ++;
-
- if (device->state == _CUPS_DNSSD_ACTIVE)
- completed ++;
-
- if (!device->ref && device->state == _CUPS_DNSSD_NEW)
- {
- DEBUG_printf(("1cupsEnumDests: Querying '%s'.", device->fullName));
-
-# ifdef HAVE_DNSSD
- device->ref = data.main_ref;
-
- if (DNSServiceQueryRecord(&(device->ref),
- kDNSServiceFlagsShareConnection,
- 0, device->fullName,
- kDNSServiceType_TXT,
- kDNSServiceClass_IN,
- (DNSServiceQueryRecordReply)cups_dnssd_query_cb,
- &data) == kDNSServiceErr_NoError)
- {
- count ++;
- }
- else
- {
- device->ref = 0;
- device->state = _CUPS_DNSSD_ERROR;
-
- DEBUG_puts("1cupsEnumDests: Query failed.");
- }
-
-# else /* HAVE_AVAHI */
- if ((device->ref = avahi_record_browser_new(data.client, AVAHI_IF_UNSPEC, AVAHI_PROTO_UNSPEC, device->fullName, AVAHI_DNS_CLASS_IN, AVAHI_DNS_TYPE_TXT, 0, cups_dnssd_query_cb, &data)) != NULL)
- {
- DEBUG_printf(("1cupsEnumDests: Query ref=%p", device->ref));
- count ++;
- }
- else
- {
- device->state = _CUPS_DNSSD_ERROR;
-
- DEBUG_printf(("1cupsEnumDests: Query failed: %s", avahi_strerror(avahi_client_errno(data.client))));
- }
-# endif /* HAVE_DNSSD */
- }
- else if (device->ref && device->state == _CUPS_DNSSD_PENDING)
- {
- completed ++;
-
- DEBUG_printf(("1cupsEnumDests: Query for \"%s\" is complete.", device->fullName));
-
- if ((device->type & mask) == type)
- {
- DEBUG_printf(("1cupsEnumDests: Add callback for \"%s\".", device->dest.name));
- if (!(*cb)(user_data, CUPS_DEST_FLAGS_NONE, &device->dest))
- {
- remaining = -1;
- break;
- }
- }
-
- device->state = _CUPS_DNSSD_ACTIVE;
- }
- }
-
-# ifdef HAVE_AVAHI
- DEBUG_printf(("1cupsEnumDests: remaining=%d, browsers=%d, completed=%d, count=%d, devices count=%d", remaining, data.browsers, completed, count, cupsArrayCount(data.devices)));
-
- if (data.browsers == 0 && completed == cupsArrayCount(data.devices))
- break;
-# else
- DEBUG_printf(("1cupsEnumDests: remaining=%d, completed=%d, count=%d, devices count=%d", remaining, completed, count, cupsArrayCount(data.devices)));
-
- if (completed == cupsArrayCount(data.devices))
- break;
-# endif /* HAVE_AVAHI */
- }
-#endif /* HAVE_DNSSD || HAVE_AVAHI */
-
- /*
- * Return...
- */
-
- enum_finished:
-
-#if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
- cupsArrayDelete(data.devices);
-
-# ifdef HAVE_DNSSD
- if (ipp_ref)
- DNSServiceRefDeallocate(ipp_ref);
- if (local_ipp_ref)
- DNSServiceRefDeallocate(local_ipp_ref);
-
-# ifdef HAVE_SSL
- if (ipps_ref)
- DNSServiceRefDeallocate(ipps_ref);
- if (local_ipps_ref)
- DNSServiceRefDeallocate(local_ipps_ref);
-# endif /* HAVE_SSL */
-
- if (data.main_ref)
- DNSServiceRefDeallocate(data.main_ref);
-
-# else /* HAVE_AVAHI */
- if (ipp_ref)
- avahi_service_browser_free(ipp_ref);
-# ifdef HAVE_SSL
- if (ipps_ref)
- avahi_service_browser_free(ipps_ref);
-# endif /* HAVE_SSL */
-
- if (data.client)
- avahi_client_free(data.client);
- if (data.simple_poll)
- avahi_simple_poll_free(data.simple_poll);
-# endif /* HAVE_DNSSD */
-#endif /* HAVE_DNSSD || HAVE_AVAHI */
-
- return (1);
+ return (cups_enum_dests(CUPS_HTTP_DEFAULT, flags, msec, cancel, type, mask, cb, user_data));
}
@@ -1498,20 +1096,23 @@ cupsGetDest(const char *name, /* I - Destination name or @code NULL@ for the d
* '_cupsGetDestResource()' - Get the resource path and URI for a destination.
*/
-const char * /* O - Printer URI */
+const char * /* O - URI */
_cupsGetDestResource(
cups_dest_t *dest, /* I - Destination */
+ unsigned flags, /* I - Destination flags */
char *resource, /* I - Resource buffer */
size_t resourcesize) /* I - Size of resource buffer */
{
- const char *uri; /* Printer URI */
+ const char *uri, /* URI */
+ *device_uri, /* Device URI */
+ *printer_uri; /* Printer URI */
char scheme[32], /* URI scheme */
userpass[256], /* Username and password (unused) */
hostname[256]; /* Hostname */
int port; /* Port number */
- DEBUG_printf(("_cupsGetDestResource(dest=%p(%s), resource=%p, resourcesize=%d)", (void *)dest, dest->name, (void *)resource, (int)resourcesize));
+ DEBUG_printf(("_cupsGetDestResource(dest=%p(%s), flags=%u, resource=%p, resourcesize=%d)", (void *)dest, dest->name, flags, (void *)resource, (int)resourcesize));
/*
* Range check input...
@@ -1527,25 +1128,46 @@ _cupsGetDestResource(
}
/*
- * Grab the printer URI...
+ * Grab the printer and device URIs...
*/
- if ((uri = cupsGetOption("printer-uri-supported", dest->num_options, dest->options)) == NULL)
- {
- if ((uri = cupsGetOption("device-uri", dest->num_options, dest->options)) != NULL)
- {
+ device_uri = cupsGetOption("device-uri", dest->num_options, dest->options);
+ printer_uri = cupsGetOption("printer-uri-supported", dest->num_options, dest->options);
+
+ DEBUG_printf(("1_cupsGetDestResource: device-uri=\"%s\", printer-uri-supported=\"%s\".", device_uri, printer_uri));
+
#if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
- if (strstr(uri, "._tcp"))
- uri = cups_dnssd_resolve(dest, uri, 5000, NULL, NULL, NULL);
-#endif /* HAVE_DNSSD || HAVE_AVAHI */
- }
-
- if (uri)
+ if (((flags & CUPS_DEST_FLAGS_DEVICE) || !printer_uri) && strstr(device_uri, "._tcp"))
+ {
+ if ((device_uri = cups_dnssd_resolve(dest, device_uri, 5000, NULL, NULL, NULL)) != NULL)
{
- DEBUG_printf(("1_cupsGetDestResource: Resolved printer-uri-supported=\"%s\"", uri));
-
- uri = _cupsCreateDest(dest->name, cupsGetOption("printer-info", dest->num_options, dest->options), NULL, uri, resource, resourcesize);
+ DEBUG_printf(("1_cupsGetDestResource: Resolved device-uri=\"%s\".", device_uri));
}
+ else
+ {
+ DEBUG_puts("1_cupsGetDestResource: Unable to resolve device.");
+
+ if (resource)
+ *resource = '\0';
+
+ _cupsSetError(IPP_STATUS_ERROR_INTERNAL, strerror(ENOENT), 0);
+
+ return (NULL);
+ }
+ }
+#endif /* HAVE_DNSSD || HAVE_AVAHI */
+
+ if (flags & CUPS_DEST_FLAGS_DEVICE)
+ {
+ uri = device_uri;
+ }
+ else if (printer_uri)
+ {
+ uri = printer_uri;
+ }
+ else
+ {
+ uri = _cupsCreateDest(dest->name, cupsGetOption("printer-info", dest->num_options, dest->options), NULL, device_uri, resource, resourcesize);
if (uri)
{
@@ -1555,30 +1177,24 @@ _cupsGetDestResource(
uri = cupsGetOption("printer-uri-supported", dest->num_options, dest->options);
}
- else
- {
- DEBUG_puts("1_cupsGetDestResource: No printer-uri-supported found.");
-
- if (resource)
- *resource = '\0';
-
- _cupsSetError(IPP_STATUS_ERROR_INTERNAL, strerror(ENOENT), 0);
-
- return (NULL);
- }
}
- else
+
+ if (!uri)
{
- DEBUG_printf(("1_cupsGetDestResource: printer-uri-supported=\"%s\"", uri));
+ DEBUG_puts("1_cupsGetDestResource: No printer-uri-supported or device-uri found.");
- if (httpSeparateURI(HTTP_URI_CODING_ALL, uri, scheme, sizeof(scheme),
- userpass, sizeof(userpass), hostname, sizeof(hostname),
- &port, resource, (int)resourcesize) < HTTP_URI_STATUS_OK)
- {
- _cupsSetError(IPP_STATUS_ERROR_INTERNAL, _("Bad printer-uri."), 1);
+ if (resource)
+ *resource = '\0';
- return (NULL);
- }
+ _cupsSetError(IPP_STATUS_ERROR_INTERNAL, strerror(ENOENT), 0);
+
+ return (NULL);
+ }
+ else if (httpSeparateURI(HTTP_URI_CODING_ALL, uri, scheme, sizeof(scheme), userpass, sizeof(userpass), hostname, sizeof(hostname), &port, resource, (int)resourcesize) < HTTP_URI_STATUS_OK)
+ {
+ _cupsSetError(IPP_STATUS_ERROR_INTERNAL, _("Bad URI."), 1);
+
+ return (NULL);
}
DEBUG_printf(("1_cupsGetDestResource: resource=\"%s\"", resource));
@@ -1666,6 +1282,12 @@ cupsGetDestWithURI(const char *name, /* I - Desired printer name or @code NULL@
name = resource + 10;
info = temp;
}
+ else if (!strncmp(resource, "/ipp/print/", 11))
+ {
+ snprintf(temp, sizeof(temp), "%s @ %s", resource + 11, hostname);
+ name = resource + 11;
+ info = temp;
+ }
else
{
name = hostname;
@@ -1780,6 +1402,7 @@ _cupsGetDests(http_t *http, /* I - Connection to server or
*/
appleGetPaperSize(media_default, sizeof(media_default));
+ DEBUG_printf(("1_cupsGetDests: Default media is '%s'.", media_default));
#endif /* __APPLE__ */
/*
@@ -1888,7 +1511,7 @@ _cupsGetDests(http_t *http, /* I - Connection to server or
num_options, &options);
}
#ifdef __APPLE__
- else if (!strcmp(attr->name, "media-supported"))
+ else if (!strcmp(attr->name, "media-supported") && media_default[0])
{
/*
* See if we can set a default media size...
@@ -1899,8 +1522,8 @@ _cupsGetDests(http_t *http, /* I - Connection to server or
for (i = 0; i < attr->num_values; i ++)
if (!_cups_strcasecmp(media_default, attr->values[i].string.text))
{
- num_options = cupsAddOption("media", media_default, num_options,
- &options);
+ DEBUG_printf(("1_cupsGetDests: Setting media to '%s'.", media_default));
+ num_options = cupsAddOption("media", media_default, num_options, &options);
break;
}
}
@@ -1909,7 +1532,8 @@ _cupsGetDests(http_t *http, /* I - Connection to server or
attr->value_tag == IPP_TAG_NAME)
printer_name = attr->values[0].string.text;
else if (strncmp(attr->name, "notify-", 7) &&
- (attr->value_tag == IPP_TAG_BOOLEAN ||
+ strncmp(attr->name, "print-quality-", 14) &&
+ (attr->value_tag == IPP_TAG_BOOLEAN ||
attr->value_tag == IPP_TAG_ENUM ||
attr->value_tag == IPP_TAG_INTEGER ||
attr->value_tag == IPP_TAG_KEYWORD ||
@@ -1924,12 +1548,8 @@ _cupsGetDests(http_t *http, /* I - Connection to server or
strlcpy(optname, attr->name, sizeof(optname));
optname[ptr - attr->name] = '\0';
- if (_cups_strcasecmp(optname, "media") ||
- !cupsGetOption("media", num_options, options))
- num_options = cupsAddOption(optname,
- cups_make_string(attr, value,
- sizeof(value)),
- num_options, &options);
+ if (_cups_strcasecmp(optname, "media") || !cupsGetOption("media", num_options, options))
+ num_options = cupsAddOption(optname, cups_make_string(attr, value, sizeof(value)), num_options, &options);
}
}
@@ -2028,28 +1648,35 @@ cupsGetDests2(http_t *http, /* I - Connection to server or @code CUPS_HTTP_
cups_dest_t **dests) /* O - Destinations */
{
_cups_getdata_t data; /* Enumeration data */
- cups_dest_t *dest; /* Current destination */
- const char *home; /* HOME environment variable */
- char filename[1024]; /* Local ~/.cups/lpoptions file */
- const char *defprinter; /* Default printer */
- char name[1024], /* Copy of printer name */
- *instance, /* Pointer to instance name */
- *user_default; /* User default printer */
- int num_reals; /* Number of real queues */
- cups_dest_t *reals; /* Real queues */
- _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
- /*
+ DEBUG_printf(("cupsGetDests2(http=%p, dests=%p)", (void *)http, (void *)dests));
+
+/*
* Range check the input...
*/
if (!dests)
{
_cupsSetError(IPP_STATUS_ERROR_INTERNAL, _("Bad NULL dests pointer"), 1);
+ DEBUG_puts("1cupsGetDests2: NULL dests pointer, returning 0.");
return (0);
}
+ /*
+ * Connect to the server as needed...
+ */
+
+ if (!http)
+ {
+ if ((http = _cupsConnect()) == NULL)
+ {
+ *dests = NULL;
+
+ return (0);
+ }
+ }
+
/*
* Grab the printers and classes...
*/
@@ -2057,116 +1684,23 @@ cupsGetDests2(http_t *http, /* I - Connection to server or @code CUPS_HTTP_
data.num_dests = 0;
data.dests = NULL;
- cupsEnumDests(0, 1000, NULL, 0, 0, (cups_dest_cb_t)cups_get_cb, &data);
-
- if (cupsLastError() >= IPP_STATUS_REDIRECTION_OTHER_SITE)
+ if (!httpAddrLocalhost(httpGetAddress(http)))
{
- cupsFreeDests(data.num_dests, data.dests);
+ /*
+ * When talking to a remote cupsd, just enumerate printers on the remote
+ * cupsd.
+ */
- *dests = (cups_dest_t *)0;
-
- return (0);
- }
-
- /*
- * Make a copy of the "real" queues for a later sanity check...
- */
-
- if (data.num_dests > 0)
- {
- num_reals = data.num_dests;
- reals = calloc((size_t)num_reals, sizeof(cups_dest_t));
-
- if (reals)
- memcpy(reals, data.dests, (size_t)num_reals * sizeof(cups_dest_t));
- else
- num_reals = 0;
+ cups_enum_dests(http, 0, _CUPS_DNSSD_GET_DESTS, NULL, 0, CUPS_PRINTER_DISCOVERED, (cups_dest_cb_t)cups_get_cb, &data);
}
else
- {
- num_reals = 0;
- reals = NULL;
- }
-
- /*
- * Grab the default destination...
- */
-
- if ((user_default = _cupsUserDefault(name, sizeof(name))) != NULL)
- defprinter = name;
- else if ((defprinter = cupsGetDefault2(http)) != NULL)
- {
- strlcpy(name, defprinter, sizeof(name));
- defprinter = name;
- }
-
- if (defprinter)
{
/*
- * Separate printer and instance name...
+ * When talking to a local cupsd, enumerate both local printers and ones we
+ * can find on the network...
*/
- if ((instance = strchr(name, '/')) != NULL)
- *instance++ = '\0';
-
- /*
- * Lookup the printer and instance and make it the default...
- */
-
- if ((dest = cupsGetDest(name, instance, data.num_dests, data.dests)) != NULL)
- dest->is_default = 1;
- }
- else
- instance = NULL;
-
- /*
- * Load the /etc/cups/lpoptions and ~/.cups/lpoptions files...
- */
-
- snprintf(filename, sizeof(filename), "%s/lpoptions", cg->cups_serverroot);
- data.num_dests = cups_get_dests(filename, NULL, NULL, user_default != NULL, data.num_dests, &data.dests);
-
- if ((home = getenv("HOME")) != NULL)
- {
- snprintf(filename, sizeof(filename), "%s/.cups/lpoptions", home);
-
- data.num_dests = cups_get_dests(filename, NULL, NULL, user_default != NULL, data.num_dests, &data.dests);
- }
-
- /*
- * Validate the current default destination - this prevents old
- * Default lines in /etc/cups/lpoptions and ~/.cups/lpoptions from
- * pointing to a non-existent printer or class...
- */
-
- if (num_reals)
- {
- /*
- * See if we have a default printer...
- */
-
- if ((dest = cupsGetDest(NULL, NULL, data.num_dests, data.dests)) != NULL)
- {
- /*
- * Have a default; see if it is real...
- */
-
- if (!cupsGetDest(dest->name, NULL, num_reals, reals))
- {
- /*
- * Remove the non-real printer from the list, since we don't want jobs
- * going to an unexpected printer... ()
- */
-
- data.num_dests = cupsRemoveDest(dest->name, dest->instance, data.num_dests, &data.dests);
- }
- }
-
- /*
- * Free memory...
- */
-
- free(reals);
+ cups_enum_dests(http, 0, _CUPS_DNSSD_GET_DESTS, NULL, 0, 0, (cups_dest_cb_t)cups_get_cb, &data);
}
/*
@@ -2178,6 +1712,8 @@ cupsGetDests2(http_t *http, /* I - Connection to server or @code CUPS_HTTP_
if (data.num_dests > 0)
_cupsSetError(IPP_STATUS_OK, NULL, 0);
+ DEBUG_printf(("1cupsGetDests2: Returning %d destinations.", data.num_dests));
+
return (data.num_dests);
}
@@ -2253,9 +1789,12 @@ cupsGetNamedDest(http_t *http, /* I - Connection to server or @code CUPS_HTT
snprintf(filename, sizeof(filename), "%s/.cups/lpoptions", home);
dest_name = cups_get_default(filename, defname, sizeof(defname), &instance);
+
+ if (dest_name)
+ set_as_default = 2;
}
- if (!name)
+ if (!dest_name)
{
/*
* Still not there? Try the system lpoptions file...
@@ -2263,6 +1802,9 @@ cupsGetNamedDest(http_t *http, /* I - Connection to server or @code CUPS_HTT
snprintf(filename, sizeof(filename), "%s/lpoptions", cg->cups_serverroot);
dest_name = cups_get_default(filename, defname, sizeof(defname), &instance);
+
+ if (dest_name)
+ set_as_default = 3;
}
if (!dest_name)
@@ -2271,7 +1813,8 @@ cupsGetNamedDest(http_t *http, /* I - Connection to server or @code CUPS_HTT
* No locally-set default destination, ask the server...
*/
- op = IPP_OP_CUPS_GET_DEFAULT;
+ op = IPP_OP_CUPS_GET_DEFAULT;
+ set_as_default = 4;
DEBUG_puts("1cupsGetNamedDest: Asking server for default printer...");
}
@@ -2302,7 +1845,36 @@ cupsGetNamedDest(http_t *http, /* I - Connection to server or @code CUPS_HTT
dest = data.dest;
}
else
+ {
+ switch (set_as_default)
+ {
+ default :
+ break;
+
+ case 1 : /* Set from env vars */
+ if (getenv("LPDEST"))
+ _cupsSetError(IPP_STATUS_ERROR_NOT_FOUND, _("LPDEST environment variable names default destination that does not exist."), 1);
+ else if (getenv("PRINTER"))
+ _cupsSetError(IPP_STATUS_ERROR_NOT_FOUND, _("PRINTER environment variable names default destination that does not exist."), 1);
+ else
+ _cupsSetError(IPP_STATUS_ERROR_NOT_FOUND, _("No default destination."), 1);
+ break;
+
+ case 2 : /* Set from ~/.cups/lpoptions */
+ _cupsSetError(IPP_STATUS_ERROR_NOT_FOUND, _("~/.cups/lpoptions file names default destination that does not exist."), 1);
+ break;
+
+ case 3 : /* Set from /etc/cups/lpoptions */
+ _cupsSetError(IPP_STATUS_ERROR_NOT_FOUND, _("/etc/cups/lpoptions file names default destination that does not exist."), 1);
+ break;
+
+ case 4 : /* Set from server */
+ _cupsSetError(IPP_STATUS_ERROR_NOT_FOUND, _("No default destination."), 1);
+ break;
+ }
+
return (NULL);
+ }
}
DEBUG_printf(("1cupsGetNamedDest: Got dest=%p", (void *)dest));
@@ -2318,13 +1890,13 @@ cupsGetNamedDest(http_t *http, /* I - Connection to server or @code CUPS_HTT
*/
snprintf(filename, sizeof(filename), "%s/lpoptions", cg->cups_serverroot);
- cups_get_dests(filename, dest_name, instance, 1, 1, &dest);
+ cups_get_dests(filename, dest_name, instance, 0, 1, 1, &dest);
if (home)
{
snprintf(filename, sizeof(filename), "%s/.cups/lpoptions", home);
- cups_get_dests(filename, dest_name, instance, 1, 1, &dest);
+ cups_get_dests(filename, dest_name, instance, 0, 1, 1, &dest);
}
/*
@@ -2460,9 +2032,9 @@ cupsSetDests2(http_t *http, /* I - Connection to server or @code CUPS_HTTP_
cups_option_t *option; /* Current option */
_ipp_option_t *match; /* Matching attribute for option */
FILE *fp; /* File pointer */
-#ifndef WIN32
+#ifndef _WIN32
const char *home; /* HOME environment variable */
-#endif /* WIN32 */
+#endif /* _WIN32 */
char filename[1024]; /* lpoptions file */
int num_temps; /* Number of temporary destinations */
cups_dest_t *temps = NULL, /* Temporary destinations */
@@ -2496,15 +2068,9 @@ cupsSetDests2(http_t *http, /* I - Connection to server or @code CUPS_HTTP_
snprintf(filename, sizeof(filename), "%s/lpoptions", cg->cups_serverroot);
-#ifndef WIN32
+#ifndef _WIN32
if (getuid())
{
- /*
- * Merge in server defaults...
- */
-
- num_temps = cups_get_dests(filename, NULL, NULL, 0, num_temps, &temps);
-
/*
* Point to user defaults...
*/
@@ -2522,7 +2088,7 @@ cupsSetDests2(http_t *http, /* I - Connection to server or @code CUPS_HTTP_
snprintf(filename, sizeof(filename), "%s/.cups/lpoptions", home);
}
}
-#endif /* !WIN32 */
+#endif /* !_WIN32 */
/*
* Try to open the file...
@@ -2534,7 +2100,7 @@ cupsSetDests2(http_t *http, /* I - Connection to server or @code CUPS_HTTP_
return (-1);
}
-#ifndef WIN32
+#ifndef _WIN32
/*
* Set the permissions to 0644 when saving to the /etc/cups/lpoptions
* file...
@@ -2542,7 +2108,7 @@ cupsSetDests2(http_t *http, /* I - Connection to server or @code CUPS_HTTP_
if (!getuid())
fchmod(fileno(fp), 0644);
-#endif /* !WIN32 */
+#endif /* !_WIN32 */
/*
* Write each printer; each line looks like:
@@ -2565,8 +2131,7 @@ cupsSetDests2(http_t *http, /* I - Connection to server or @code CUPS_HTTP_
else
wrote = 0;
- if ((temp = cupsGetDest(dest->name, dest->instance, num_temps, temps)) == NULL)
- temp = cupsGetDest(dest->name, NULL, num_temps, temps);
+ temp = cupsGetDest(dest->name, NULL, num_temps, temps);
for (j = dest->num_options, option = dest->options; j > 0; j --, option ++)
{
@@ -2574,19 +2139,14 @@ cupsSetDests2(http_t *http, /* I - Connection to server or @code CUPS_HTTP_
* See if this option is a printer attribute; if so, skip it...
*/
- if ((match = _ippFindOption(option->name)) != NULL &&
- match->group_tag == IPP_TAG_PRINTER)
+ if ((match = _ippFindOption(option->name)) != NULL && match->group_tag == IPP_TAG_PRINTER)
continue;
/*
- * See if the server/global options match these; if so, don't
- * write 'em.
+ * See if the server options match these; if so, don't write 'em.
*/
- if (temp &&
- (val = cupsGetOption(option->name, temp->num_options,
- temp->options)) != NULL &&
- !_cups_strcasecmp(val, option->value))
+ if (temp && (val = cupsGetOption(option->name, temp->num_options, temp->options)) != NULL && !_cups_strcasecmp(val, option->value))
continue;
/*
@@ -2603,10 +2163,7 @@ cupsSetDests2(http_t *http, /* I - Connection to server or @code CUPS_HTTP_
if (option->value[0])
{
- if (strchr(option->value, ' ') ||
- strchr(option->value, '\\') ||
- strchr(option->value, '\"') ||
- strchr(option->value, '\''))
+ if (strchr(option->value, ' ') || strchr(option->value, '\\') || strchr(option->value, '\"') || strchr(option->value, '\''))
{
/*
* Quote the value...
@@ -2657,9 +2214,7 @@ cupsSetDests2(http_t *http, /* I - Connection to server or @code CUPS_HTTP_
if ((dest = cupsGetDest(NULL, NULL, num_dests, dests)) != NULL)
{
- CFStringRef name = CFStringCreateWithCString(kCFAllocatorDefault,
- dest->name,
- kCFStringEncodingUTF8);
+ CFStringRef name = CFStringCreateWithCString(kCFAllocatorDefault, dest->name, kCFStringEncodingUTF8);
/* Default printer name */
if (name)
@@ -3090,22 +2645,7 @@ cups_dnssd_browse_cb(
* This object is new on the network.
*/
- if (flags & AVAHI_LOOKUP_RESULT_LOCAL)
- {
- /*
- * This comes from the local machine so ignore it.
- */
-
- DEBUG_printf(("cups_dnssd_browse_cb: Ignoring local service \"%s\".", name));
- }
- else
- {
- /*
- * Create a device entry for it if it doesn't yet exist.
- */
-
- cups_dnssd_get_device(data, name, type, domain);
- }
+ cups_dnssd_get_device(data, name, type, domain);
break;
case AVAHI_BROWSER_REMOVE :
@@ -3326,66 +2866,6 @@ cups_dnssd_get_device(
}
-# ifdef HAVE_DNSSD
-/*
- * 'cups_dnssd_local_cb()' - Browse for local printers.
- */
-
-static void
-cups_dnssd_local_cb(
- DNSServiceRef sdRef, /* I - Service reference */
- DNSServiceFlags flags, /* I - Option flags */
- uint32_t interfaceIndex, /* I - Interface number */
- DNSServiceErrorType errorCode, /* I - Error, if any */
- const char *serviceName, /* I - Name of service/device */
- const char *regtype, /* I - Type of service */
- const char *replyDomain, /* I - Service domain */
- void *context) /* I - Devices array */
-{
- _cups_dnssd_data_t *data = (_cups_dnssd_data_t *)context;
- /* Enumeration data */
- _cups_dnssd_device_t *device; /* Device */
-
-
- DEBUG_printf(("5cups_dnssd_local_cb(sdRef=%p, flags=%x, interfaceIndex=%d, errorCode=%d, serviceName=\"%s\", regtype=\"%s\", replyDomain=\"%s\", context=%p)", (void *)sdRef, flags, interfaceIndex, errorCode, serviceName, regtype, replyDomain, context));
-
- /*
- * Only process "add" data...
- */
-
- if (errorCode != kDNSServiceErr_NoError || !(flags & kDNSServiceFlagsAdd))
- return;
-
- /*
- * Get the device...
- */
-
- device = cups_dnssd_get_device(data, serviceName, regtype, replyDomain);
-
- /*
- * Hide locally-registered devices...
- */
-
- DEBUG_printf(("6cups_dnssd_local_cb: Hiding local printer '%s'.",
- serviceName));
-
- if (device->ref)
- {
- DNSServiceRefDeallocate(device->ref);
- device->ref = 0;
- }
-
- if (device->state == _CUPS_DNSSD_ACTIVE)
- {
- DEBUG_printf(("6cups_dnssd_local_cb: Remove callback for \"%s\".", device->dest.name));
- (*data->cb)(data->user_data, CUPS_DEST_FLAGS_REMOVED, &device->dest);
- }
-
- device->state = _CUPS_DNSSD_LOCAL;
-}
-# endif /* HAVE_DNSSD */
-
-
# ifdef HAVE_AVAHI
/*
* 'cups_dnssd_poll_cb()' - Wait for input on the specified file descriptors.
@@ -3435,9 +2915,9 @@ cups_dnssd_poll_cb(
* 'cups_dnssd_query_cb()' - Process query data.
*/
-# ifdef HAVE_DNSSD
static void
cups_dnssd_query_cb(
+# ifdef HAVE_DNSSD
DNSServiceRef sdRef, /* I - Service reference */
DNSServiceFlags flags, /* I - Data flags */
uint32_t interfaceIndex, /* I - Interface */
@@ -3448,11 +2928,7 @@ cups_dnssd_query_cb(
uint16_t rdlen, /* I - Length of record data */
const void *rdata, /* I - Record data */
uint32_t ttl, /* I - Time-to-live */
- void *context) /* I - Enumeration data */
-{
# else /* HAVE_AVAHI */
-static void
-cups_dnssd_query_cb(
AvahiRecordBrowser *browser, /* I - Record browser */
AvahiIfIndex interfaceIndex,
/* I - Interface index (unused) */
@@ -3464,13 +2940,13 @@ cups_dnssd_query_cb(
const void *rdata, /* I - TXT record */
size_t rdlen, /* I - Length of TXT record */
AvahiLookupResultFlags flags, /* I - Flags */
- void *context) /* I - Enumeration data */
+# endif /* HAVE_DNSSD */
+ void *context) /* I - Enumeration data */
{
-# ifdef DEBUG
+# if defined(DEBUG) && defined(HAVE_AVAHI)
AvahiClient *client = avahi_record_browser_get_client(browser);
/* Client information */
-# endif /* DEBUG */
-# endif /* HAVE_DNSSD */
+# endif /* DEBUG && HAVE_AVAHI */
_cups_dnssd_data_t *data = (_cups_dnssd_data_t *)context;
/* Enumeration data */
char serviceName[256],/* Service name */
@@ -3898,6 +3374,509 @@ cups_elapsed(struct timeval *t) /* IO - Previous time */
#endif /* HAVE_AVAHI || HAVE_DNSSD */
+/*
+ * 'cups_enum_dests()' - Enumerate destinations from a specific server.
+ */
+
+static int /* O - 1 on success, 0 on failure */
+cups_enum_dests(
+ http_t *http, /* I - Connection to scheduler */
+ unsigned flags, /* I - Enumeration flags */
+ int msec, /* I - Timeout in milliseconds, -1 for indefinite */
+ int *cancel, /* I - Pointer to "cancel" variable */
+ cups_ptype_t type, /* I - Printer type bits */
+ cups_ptype_t mask, /* I - Mask for printer type bits */
+ cups_dest_cb_t cb, /* I - Callback function */
+ void *user_data) /* I - User data */
+{
+ int i, j, /* Looping vars */
+ num_dests; /* Number of destinations */
+ cups_dest_t *dests = NULL, /* Destinations */
+ *dest, /* Current destination */
+ *user_dest; /* User destination */
+ cups_option_t *option; /* Current option */
+ char *user_default; /* User default printer */
+#if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
+ int count, /* Number of queries started */
+ completed, /* Number of completed queries */
+ remaining; /* Remainder of timeout */
+ struct timeval curtime; /* Current time */
+ _cups_dnssd_data_t data; /* Data for callback */
+ _cups_dnssd_device_t *device; /* Current device */
+# ifdef HAVE_DNSSD
+ int nfds, /* Number of files responded */
+ main_fd; /* File descriptor for lookups */
+ DNSServiceRef ipp_ref = NULL; /* IPP browser */
+# ifdef HAVE_SSL
+ DNSServiceRef ipps_ref = NULL; /* IPPS browser */
+# endif /* HAVE_SSL */
+# ifdef HAVE_POLL
+ struct pollfd pfd; /* Polling data */
+# else
+ fd_set input; /* Input set for select() */
+ struct timeval timeout; /* Timeout for select() */
+# endif /* HAVE_POLL */
+# else /* HAVE_AVAHI */
+ int error; /* Error value */
+ AvahiServiceBrowser *ipp_ref = NULL; /* IPP browser */
+# ifdef HAVE_SSL
+ AvahiServiceBrowser *ipps_ref = NULL; /* IPPS browser */
+# endif /* HAVE_SSL */
+# endif /* HAVE_DNSSD */
+#else
+ _cups_getdata_t data; /* Data for callback */
+#endif /* HAVE_DNSSD || HAVE_AVAHI */
+ const char *home; /* HOME environment variable */
+ char filename[1024]; /* Local lpoptions file */
+ _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
+
+
+ DEBUG_printf(("cups_enum_dests(flags=%x, msec=%d, cancel=%p, type=%x, mask=%x, cb=%p, user_data=%p)", flags, msec, (void *)cancel, type, mask, (void *)cb, (void *)user_data));
+
+ /*
+ * Range check input...
+ */
+
+ (void)flags;
+
+ if (!cb)
+ {
+ DEBUG_puts("1cups_enum_dests: No callback, returning 0.");
+ return (0);
+ }
+
+ /*
+ * Load the /etc/cups/lpoptions and ~/.cups/lpoptions files...
+ */
+
+ memset(&data, 0, sizeof(data));
+
+ if ((user_default = _cupsUserDefault(data.def_name, sizeof(data.def_name))) == NULL)
+ {
+ const char *defprinter = cupsGetDefault2(http);
+ /* Server default, if any */
+
+ if (defprinter)
+ strlcpy(data.def_name, defprinter, sizeof(data.def_name));
+ }
+
+ if (data.def_name[0])
+ {
+ /*
+ * Separate printer and instance name...
+ */
+
+ if ((data.def_instance = strchr(data.def_name, '/')) != NULL)
+ *data.def_instance++ = '\0';
+ }
+
+ DEBUG_printf(("1cups_enum_dests: def_name=\"%s\", def_instance=\"%s\"", data.def_name, data.def_instance));
+
+ snprintf(filename, sizeof(filename), "%s/lpoptions", cg->cups_serverroot);
+ data.num_dests = cups_get_dests(filename, NULL, NULL, 1, user_default != NULL, data.num_dests, &data.dests);
+
+ if ((home = getenv("HOME")) != NULL)
+ {
+ snprintf(filename, sizeof(filename), "%s/.cups/lpoptions", home);
+
+ data.num_dests = cups_get_dests(filename, NULL, NULL, 1, user_default != NULL, data.num_dests, &data.dests);
+ }
+
+ /*
+ * Get ready to enumerate...
+ */
+
+#if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
+ data.type = type;
+ data.mask = mask;
+ data.cb = cb;
+ data.user_data = user_data;
+ data.devices = cupsArrayNew3((cups_array_func_t)cups_dnssd_compare_devices, NULL, NULL, 0, NULL, (cups_afree_func_t)cups_dnssd_free_device);
+#endif /* HAVE_DNSSD || HAVE_AVAHI */
+
+ if (!(mask & CUPS_PRINTER_DISCOVERED) || !(type & CUPS_PRINTER_DISCOVERED))
+ {
+ /*
+ * Get the list of local printers and pass them to the callback function...
+ */
+
+ num_dests = _cupsGetDests(http, IPP_OP_CUPS_GET_PRINTERS, NULL, &dests, type, mask);
+
+ if (data.def_name[0])
+ {
+ /*
+ * Lookup the named default printer and instance and make it the default...
+ */
+
+ if ((dest = cupsGetDest(data.def_name, data.def_instance, num_dests, dests)) != NULL)
+ {
+ DEBUG_printf(("1cups_enum_dests: Setting is_default on \"%s/%s\".", dest->name, dest->instance));
+ dest->is_default = 1;
+ }
+ }
+
+ for (i = num_dests, dest = dests;
+ i > 0 && (!cancel || !*cancel);
+ i --, dest ++)
+ {
+#if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
+ const char *device_uri; /* Device URI */
+#endif /* HAVE_DNSSD || HAVE_AVAHI */
+
+ if ((user_dest = cupsGetDest(dest->name, dest->instance, data.num_dests, data.dests)) != NULL)
+ {
+ /*
+ * Apply user defaults to this destination...
+ */
+
+ for (j = user_dest->num_options, option = user_dest->options; j > 0; j --, option ++)
+ dest->num_options = cupsAddOption(option->name, option->value, dest->num_options, &dest->options);
+ }
+
+ if (!(*cb)(user_data, i > 1 ? CUPS_DEST_FLAGS_MORE : CUPS_DEST_FLAGS_NONE, dest))
+ break;
+
+#if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
+ if (!dest->instance && (device_uri = cupsGetOption("device-uri", dest->num_options, dest->options)) != NULL && !strncmp(device_uri, "dnssd://", 8))
+ {
+ /*
+ * Add existing queue using service name, etc. so we don't list it again...
+ */
+
+ char scheme[32], /* URI scheme */
+ userpass[32], /* Username:password */
+ serviceName[256], /* Service name (host field) */
+ resource[256], /* Resource (options) */
+ *regtype, /* Registration type */
+ *replyDomain; /* Registration domain */
+ int port; /* Port number (not used) */
+
+ if (httpSeparateURI(HTTP_URI_CODING_ALL, device_uri, scheme, sizeof(scheme), userpass, sizeof(userpass), serviceName, sizeof(serviceName), &port, resource, sizeof(resource)) >= HTTP_URI_STATUS_OK)
+ {
+ if ((regtype = strstr(serviceName, "._ipp")) != NULL)
+ {
+ *regtype++ = '\0';
+
+ if ((replyDomain = strstr(regtype, "._tcp.")) != NULL)
+ {
+ replyDomain[5] = '\0';
+ replyDomain += 6;
+
+ if ((device = cups_dnssd_get_device(&data, serviceName, regtype, replyDomain)) != NULL)
+ device->state = _CUPS_DNSSD_ACTIVE;
+ }
+ }
+ }
+ }
+#endif /* HAVE_DNSSD || HAVE_AVAHI */
+ }
+
+ cupsFreeDests(num_dests, dests);
+
+ if (i > 0 || msec == 0)
+ goto enum_finished;
+ }
+
+ /*
+ * Return early if the caller doesn't want to do discovery...
+ */
+
+ if ((mask & CUPS_PRINTER_DISCOVERED) && !(type & CUPS_PRINTER_DISCOVERED))
+ goto enum_finished;
+
+#if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
+ /*
+ * Get Bonjour-shared printers...
+ */
+
+ gettimeofday(&curtime, NULL);
+
+# ifdef HAVE_DNSSD
+ if (DNSServiceCreateConnection(&data.main_ref) != kDNSServiceErr_NoError)
+ {
+ DEBUG_puts("1cups_enum_dests: Unable to create service browser, returning 0.");
+
+ cupsFreeDests(data.num_dests, data.dests);
+
+ return (0);
+ }
+
+ main_fd = DNSServiceRefSockFD(data.main_ref);
+
+ ipp_ref = data.main_ref;
+ if (DNSServiceBrowse(&ipp_ref, kDNSServiceFlagsShareConnection, 0, "_ipp._tcp", NULL, (DNSServiceBrowseReply)cups_dnssd_browse_cb, &data) != kDNSServiceErr_NoError)
+ {
+ DEBUG_puts("1cups_enum_dests: Unable to create IPP browser, returning 0.");
+ DNSServiceRefDeallocate(data.main_ref);
+
+ cupsFreeDests(data.num_dests, data.dests);
+
+ return (0);
+ }
+
+# ifdef HAVE_SSL
+ ipps_ref = data.main_ref;
+ if (DNSServiceBrowse(&ipps_ref, kDNSServiceFlagsShareConnection, 0, "_ipps._tcp", NULL, (DNSServiceBrowseReply)cups_dnssd_browse_cb, &data) != kDNSServiceErr_NoError)
+ {
+ DEBUG_puts("1cups_enum_dests: Unable to create IPPS browser, returning 0.");
+ DNSServiceRefDeallocate(data.main_ref);
+
+ cupsFreeDests(data.num_dests, data.dests);
+
+ return (0);
+ }
+# endif /* HAVE_SSL */
+
+# else /* HAVE_AVAHI */
+ if ((data.simple_poll = avahi_simple_poll_new()) == NULL)
+ {
+ DEBUG_puts("1cups_enum_dests: Unable to create Avahi poll, returning 0.");
+
+ cupsFreeDests(data.num_dests, data.dests);
+
+ return (0);
+ }
+
+ avahi_simple_poll_set_func(data.simple_poll, cups_dnssd_poll_cb, &data);
+
+ data.client = avahi_client_new(avahi_simple_poll_get(data.simple_poll),
+ 0, cups_dnssd_client_cb, &data,
+ &error);
+ if (!data.client)
+ {
+ DEBUG_puts("1cups_enum_dests: Unable to create Avahi client, returning 0.");
+ avahi_simple_poll_free(data.simple_poll);
+
+ cupsFreeDests(data.num_dests, data.dests);
+
+ return (0);
+ }
+
+ data.browsers = 1;
+ if ((ipp_ref = avahi_service_browser_new(data.client, AVAHI_IF_UNSPEC, AVAHI_PROTO_UNSPEC, "_ipp._tcp", NULL, 0, cups_dnssd_browse_cb, &data)) == NULL)
+ {
+ DEBUG_puts("1cups_enum_dests: Unable to create Avahi IPP browser, returning 0.");
+
+ avahi_client_free(data.client);
+ avahi_simple_poll_free(data.simple_poll);
+
+ cupsFreeDests(data.num_dests, data.dests);
+
+ return (0);
+ }
+
+# ifdef HAVE_SSL
+ data.browsers ++;
+ if ((ipps_ref = avahi_service_browser_new(data.client, AVAHI_IF_UNSPEC, AVAHI_PROTO_UNSPEC, "_ipps._tcp", NULL, 0, cups_dnssd_browse_cb, &data)) == NULL)
+ {
+ DEBUG_puts("1cups_enum_dests: Unable to create Avahi IPPS browser, returning 0.");
+
+ avahi_service_browser_free(ipp_ref);
+ avahi_client_free(data.client);
+ avahi_simple_poll_free(data.simple_poll);
+
+ cupsFreeDests(data.num_dests, data.dests);
+
+ return (0);
+ }
+# endif /* HAVE_SSL */
+# endif /* HAVE_DNSSD */
+
+ if (msec < 0)
+ remaining = INT_MAX;
+ else
+ remaining = msec;
+
+ while (remaining > 0 && (!cancel || !*cancel))
+ {
+ /*
+ * Check for input...
+ */
+
+ DEBUG_printf(("1cups_enum_dests: remaining=%d", remaining));
+
+ cups_elapsed(&curtime);
+
+# ifdef HAVE_DNSSD
+# ifdef HAVE_POLL
+ pfd.fd = main_fd;
+ pfd.events = POLLIN;
+
+ nfds = poll(&pfd, 1, remaining > _CUPS_DNSSD_MAXTIME ? _CUPS_DNSSD_MAXTIME : remaining);
+
+# else
+ FD_ZERO(&input);
+ FD_SET(main_fd, &input);
+
+ timeout.tv_sec = 0;
+ timeout.tv_usec = 1000 * (remaining > _CUPS_DNSSD_MAXTIME ? _CUPS_DNSSD_MAXTIME : remaining);
+
+ nfds = select(main_fd + 1, &input, NULL, NULL, &timeout);
+# endif /* HAVE_POLL */
+
+ if (nfds > 0)
+ DNSServiceProcessResult(data.main_ref);
+ else if (nfds < 0 && errno != EINTR && errno != EAGAIN)
+ break;
+
+# else /* HAVE_AVAHI */
+ data.got_data = 0;
+
+ if ((error = avahi_simple_poll_iterate(data.simple_poll, _CUPS_DNSSD_MAXTIME)) > 0)
+ {
+ /*
+ * We've been told to exit the loop. Perhaps the connection to
+ * Avahi failed.
+ */
+
+ break;
+ }
+
+ DEBUG_printf(("1cups_enum_dests: got_data=%d", data.got_data));
+# endif /* HAVE_DNSSD */
+
+ remaining -= cups_elapsed(&curtime);
+
+ for (device = (_cups_dnssd_device_t *)cupsArrayFirst(data.devices),
+ count = 0, completed = 0;
+ device;
+ device = (_cups_dnssd_device_t *)cupsArrayNext(data.devices))
+ {
+ if (device->ref)
+ count ++;
+
+ if (device->state == _CUPS_DNSSD_ACTIVE)
+ completed ++;
+
+ if (!device->ref && device->state == _CUPS_DNSSD_NEW)
+ {
+ DEBUG_printf(("1cups_enum_dests: Querying '%s'.", device->fullName));
+
+# ifdef HAVE_DNSSD
+ device->ref = data.main_ref;
+
+ if (DNSServiceQueryRecord(&(device->ref), kDNSServiceFlagsShareConnection, 0, device->fullName, kDNSServiceType_TXT, kDNSServiceClass_IN, (DNSServiceQueryRecordReply)cups_dnssd_query_cb, &data) == kDNSServiceErr_NoError)
+ {
+ count ++;
+ }
+ else
+ {
+ device->ref = 0;
+ device->state = _CUPS_DNSSD_ERROR;
+
+ DEBUG_puts("1cups_enum_dests: Query failed.");
+ }
+
+# else /* HAVE_AVAHI */
+ if ((device->ref = avahi_record_browser_new(data.client, AVAHI_IF_UNSPEC, AVAHI_PROTO_UNSPEC, device->fullName, AVAHI_DNS_CLASS_IN, AVAHI_DNS_TYPE_TXT, 0, cups_dnssd_query_cb, &data)) != NULL)
+ {
+ DEBUG_printf(("1cups_enum_dests: Query ref=%p", device->ref));
+ count ++;
+ }
+ else
+ {
+ device->state = _CUPS_DNSSD_ERROR;
+
+ DEBUG_printf(("1cups_enum_dests: Query failed: %s", avahi_strerror(avahi_client_errno(data.client))));
+ }
+# endif /* HAVE_DNSSD */
+ }
+ else if (device->ref && device->state == _CUPS_DNSSD_PENDING)
+ {
+ completed ++;
+
+ DEBUG_printf(("1cups_enum_dests: Query for \"%s\" is complete.", device->fullName));
+
+ if ((device->type & mask) == type)
+ {
+ dest = &device->dest;
+
+ if ((user_dest = cupsGetDest(dest->name, dest->instance, data.num_dests, data.dests)) != NULL)
+ {
+ /*
+ * Apply user defaults to this destination...
+ */
+
+ for (j = user_dest->num_options, option = user_dest->options; j > 0; j --, option ++)
+ dest->num_options = cupsAddOption(option->name, option->value, dest->num_options, &dest->options);
+ }
+
+ if (!strcasecmp(dest->name, data.def_name) && !data.def_instance)
+ {
+ DEBUG_printf(("1cups_enum_dests: Setting is_default on discovered \"%s\".", dest->name));
+ dest->is_default = 1;
+ }
+
+ DEBUG_printf(("1cups_enum_dests: Add callback for \"%s\".", device->dest.name));
+ if (!(*cb)(user_data, CUPS_DEST_FLAGS_NONE, dest))
+ {
+ remaining = -1;
+ break;
+ }
+ }
+
+ device->state = _CUPS_DNSSD_ACTIVE;
+ }
+ }
+
+# ifdef HAVE_AVAHI
+ DEBUG_printf(("1cups_enum_dests: remaining=%d, browsers=%d, completed=%d, count=%d, devices count=%d", remaining, data.browsers, completed, count, cupsArrayCount(data.devices)));
+
+ if (data.browsers == 0 && completed == cupsArrayCount(data.devices))
+ break;
+# else
+ DEBUG_printf(("1cups_enum_dests: remaining=%d, completed=%d, count=%d, devices count=%d", remaining, completed, count, cupsArrayCount(data.devices)));
+
+ if (completed == cupsArrayCount(data.devices))
+ break;
+# endif /* HAVE_AVAHI */
+ }
+#endif /* HAVE_DNSSD || HAVE_AVAHI */
+
+ /*
+ * Return...
+ */
+
+ enum_finished:
+
+ cupsFreeDests(data.num_dests, data.dests);
+
+#if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
+ cupsArrayDelete(data.devices);
+
+# ifdef HAVE_DNSSD
+ if (ipp_ref)
+ DNSServiceRefDeallocate(ipp_ref);
+
+# ifdef HAVE_SSL
+ if (ipps_ref)
+ DNSServiceRefDeallocate(ipps_ref);
+# endif /* HAVE_SSL */
+
+ if (data.main_ref)
+ DNSServiceRefDeallocate(data.main_ref);
+
+# else /* HAVE_AVAHI */
+ if (ipp_ref)
+ avahi_service_browser_free(ipp_ref);
+# ifdef HAVE_SSL
+ if (ipps_ref)
+ avahi_service_browser_free(ipps_ref);
+# endif /* HAVE_SSL */
+
+ if (data.client)
+ avahi_client_free(data.client);
+ if (data.simple_poll)
+ avahi_simple_poll_free(data.simple_poll);
+# endif /* HAVE_DNSSD */
+#endif /* HAVE_DNSSD || HAVE_AVAHI */
+
+ DEBUG_puts("1cups_enum_dests: Returning 1.");
+
+ return (1);
+}
+
+
/*
* 'cups_find_dest()' - Find a destination using a binary search.
*/
@@ -4089,6 +4068,7 @@ cups_get_dests(
const char *filename, /* I - File to read from */
const char *match_name, /* I - Destination name we want */
const char *match_inst, /* I - Instance name we want */
+ int load_all, /* I - Load all saved destinations? */
int user_default_set, /* I - User default printer set? */
int num_dests, /* I - Number of destinations */
cups_dest_t **dests) /* IO - Destinations */
@@ -4103,7 +4083,7 @@ cups_get_dests(
int linenum; /* Current line number */
- DEBUG_printf(("7cups_get_dests(filename=\"%s\", match_name=\"%s\", match_inst=\"%s\", user_default_set=%d, num_dests=%d, dests=%p)", filename, match_name, match_inst, user_default_set, num_dests, (void *)dests));
+ DEBUG_printf(("7cups_get_dests(filename=\"%s\", match_name=\"%s\", match_inst=\"%s\", load_all=%d, user_default_set=%d, num_dests=%d, dests=%p)", filename, match_name, match_inst, load_all, user_default_set, num_dests, (void *)dests));
/*
* Try to open the file...
@@ -4171,8 +4151,7 @@ cups_get_dests(
instance));
/*
- * See if the primary instance of the destination exists; if not,
- * ignore this entry and move on...
+ * Match and/or ignore missing destinations...
*/
if (match_name)
@@ -4185,7 +4164,7 @@ cups_get_dests(
dest = *dests;
}
- else if (cupsGetDest(name, NULL, num_dests, *dests) == NULL)
+ else if (!load_all && cupsGetDest(name, NULL, num_dests, *dests) == NULL)
{
DEBUG_puts("9cups_get_dests: Not found!");
continue;
@@ -4213,8 +4192,7 @@ cups_get_dests(
* Add options until we hit the end of the line...
*/
- dest->num_options = cupsParseOptions(lineptr, dest->num_options,
- &(dest->options));
+ dest->num_options = cupsParseOptions(lineptr, dest->num_options, &(dest->options));
/*
* If we found what we were looking for, stop now...
diff --git a/cups/dir.c b/cups/dir.c
index b7cd400..184aa7c 100644
--- a/cups/dir.c
+++ b/cups/dir.c
@@ -6,11 +6,7 @@
* Copyright 2007-2017 by Apple Inc.
* Copyright 1997-2005 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/".
+ * Licensed under Apache License v2.0. See the file "LICENSE" for more information.
*/
/*
@@ -18,7 +14,7 @@
*/
#include "string-private.h"
-#include "debug-private.h"
+#include "debug-internal.h"
#include "dir.h"
@@ -26,7 +22,7 @@
* Windows implementation...
*/
-#ifdef WIN32
+#ifdef _WIN32
# include
/*
@@ -145,7 +141,7 @@ cupsDirOpen(const char *directory) /* I - Directory name */
cups_dentry_t * /* O - Directory entry or @code NULL@ if there are no more */
cupsDirRead(cups_dir_t *dp) /* I - Directory pointer */
{
- WIN32_FIND_DATA entry; /* Directory entry data */
+ WIN32_FIND_DATAA entry; /* Directory entry data */
/*
@@ -165,11 +161,11 @@ cupsDirRead(cups_dir_t *dp) /* I - Directory pointer */
* No, find the first file...
*/
- dp->dir = FindFirstFile(dp->directory, &entry);
+ dp->dir = FindFirstFileA(dp->directory, &entry);
if (dp->dir == INVALID_HANDLE_VALUE)
return (NULL);
}
- else if (!FindNextFile(dp->dir, &entry))
+ else if (!FindNextFileA(dp->dir, &entry))
return (NULL);
/*
@@ -422,4 +418,4 @@ cupsDirRewind(cups_dir_t *dp) /* I - Directory pointer */
rewinddir(dp->dir);
}
-#endif /* WIN32 */
+#endif /* _WIN32 */
diff --git a/cups/dir.h b/cups/dir.h
index d010544..f6878cb 100644
--- a/cups/dir.h
+++ b/cups/dir.h
@@ -6,11 +6,7 @@
* Copyright 2007-2011 by Apple Inc.
* Copyright 1997-2006 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/".
+ * Licensed under Apache License v2.0. See the file "LICENSE" for more information.
*/
#ifndef _CUPS_DIR_H_
diff --git a/cups/emit.c b/cups/emit.c
deleted file mode 100644
index 650e847..0000000
--- a/cups/emit.c
+++ /dev/null
@@ -1,1229 +0,0 @@
-/*
- * "$Id: emit.c 7863 2008-08-26 03:39:59Z mike $"
- *
- * PPD code emission routines for CUPS.
- *
- * Copyright 2007-2012 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
- * file is missing or damaged, see the license at "http://www.cups.org/".
- *
- * PostScript is a trademark of Adobe Systems, Inc.
- *
- * This file is subject to the Apple OS-Developed Software exception.
- *
- * Contents:
- *
- * ppdCollect() - Collect all marked options that reside in the
- * specified section.
- * ppdCollect2() - Collect all marked options that reside in the
- * specified section and minimum order.
- * ppdEmit() - Emit code for marked options to a file.
- * ppdEmitAfterOrder() - Emit a subset of the code for marked options to a
- * file.
- * ppdEmitFd() - Emit code for marked options to a file.
- * ppdEmitJCL() - Emit code for JCL options to a file.
- * ppdEmitJCLEnd() - Emit JCLEnd code to a file.
- * ppdEmitString() - Get a string containing the code for marked
- * options.
- * ppd_compare_cparams() - Compare the order of two custom parameters.
- * ppd_handle_media() - Handle media selection...
- */
-
-/*
- * Include necessary headers...
- */
-
-#include "cups-private.h"
-#if defined(WIN32) || defined(__EMX__)
-# include
-#else
-# include
-#endif /* WIN32 || __EMX__ */
-
-
-/*
- * Local functions...
- */
-
-static int ppd_compare_cparams(ppd_cparam_t *a, ppd_cparam_t *b);
-static void ppd_handle_media(ppd_file_t *ppd);
-
-
-/*
- * Local globals...
- */
-
-static const char ppd_custom_code[] =
- "pop pop pop\n"
- "<>setpagedevice\n";
-
-
-/*
- * 'ppdCollect()' - Collect all marked options that reside in the specified
- * section.
- *
- * The choices array should be freed using @code free@ when you are
- * finished with it.
- */
-
-int /* O - Number of options marked */
-ppdCollect(ppd_file_t *ppd, /* I - PPD file data */
- ppd_section_t section, /* I - Section to collect */
- ppd_choice_t ***choices) /* O - Pointers to choices */
-{
- return (ppdCollect2(ppd, section, 0.0, choices));
-}
-
-
-/*
- * 'ppdCollect2()' - Collect all marked options that reside in the
- * specified section and minimum order.
- *
- * The choices array should be freed using @code free@ when you are
- * finished with it.
- *
- * @since CUPS 1.2/OS X 10.5@
- */
-
-int /* O - Number of options marked */
-ppdCollect2(ppd_file_t *ppd, /* I - PPD file data */
- ppd_section_t section, /* I - Section to collect */
- float min_order, /* I - Minimum OrderDependency value */
- ppd_choice_t ***choices) /* O - Pointers to choices */
-{
- ppd_choice_t *c; /* Current choice */
- ppd_section_t csection; /* Current section */
- float corder; /* Current OrderDependency value */
- int count; /* Number of choices collected */
- ppd_choice_t **collect; /* Collected choices */
- float *orders; /* Collected order values */
-
-
- DEBUG_printf(("ppdCollect2(ppd=%p, section=%d, min_order=%f, choices=%p)",
- ppd, section, min_order, choices));
-
- if (!ppd || !choices)
- {
- if (choices)
- *choices = NULL;
-
- return (0);
- }
-
- /*
- * Allocate memory for up to N selected choices...
- */
-
- count = 0;
- if ((collect = calloc(sizeof(ppd_choice_t *),
- cupsArrayCount(ppd->marked))) == NULL)
- {
- *choices = NULL;
- return (0);
- }
-
- if ((orders = calloc(sizeof(float), cupsArrayCount(ppd->marked))) == NULL)
- {
- *choices = NULL;
- free(collect);
- return (0);
- }
-
- /*
- * Loop through all options and add choices as needed...
- */
-
- for (c = (ppd_choice_t *)cupsArrayFirst(ppd->marked);
- c;
- c = (ppd_choice_t *)cupsArrayNext(ppd->marked))
- {
- csection = c->option->section;
- corder = c->option->order;
-
- if (!strcmp(c->choice, "Custom"))
- {
- ppd_attr_t *attr; /* NonUIOrderDependency value */
- float aorder; /* Order value */
- char asection[17], /* Section name */
- amain[PPD_MAX_NAME + 1],
- aoption[PPD_MAX_NAME];
- /* *CustomFoo and True */
-
-
- for (attr = ppdFindAttr(ppd, "NonUIOrderDependency", NULL);
- attr;
- attr = ppdFindNextAttr(ppd, "NonUIOrderDependency", NULL))
- if (attr->value &&
- sscanf(attr->value, "%f%16s%41s%40s", &aorder, asection, amain,
- aoption) == 4 &&
- !strncmp(amain, "*Custom", 7) &&
- !strcmp(amain + 7, c->option->keyword) && !strcmp(aoption, "True"))
- {
- /*
- * Use this NonUIOrderDependency...
- */
-
- corder = aorder;
-
- if (!strcmp(asection, "DocumentSetup"))
- csection = PPD_ORDER_DOCUMENT;
- else if (!strcmp(asection, "ExitServer"))
- csection = PPD_ORDER_EXIT;
- else if (!strcmp(asection, "JCLSetup"))
- csection = PPD_ORDER_JCL;
- else if (!strcmp(asection, "PageSetup"))
- csection = PPD_ORDER_PAGE;
- else if (!strcmp(asection, "Prolog"))
- csection = PPD_ORDER_PROLOG;
- else
- csection = PPD_ORDER_ANY;
-
- break;
- }
- }
-
- if (csection == section && corder >= min_order)
- {
- collect[count] = c;
- orders[count] = corder;
- count ++;
- }
- }
-
- /*
- * If we have more than 1 marked choice, sort them...
- */
-
- if (count > 1)
- {
- int i, j; /* Looping vars */
-
- for (i = 0; i < (count - 1); i ++)
- for (j = i + 1; j < count; j ++)
- if (orders[i] > orders[j])
- {
- c = collect[i];
- corder = orders[i];
- collect[i] = collect[j];
- orders[i] = orders[j];
- collect[j] = c;
- orders[j] = corder;
- }
- }
-
- free(orders);
-
- DEBUG_printf(("2ppdCollect2: %d marked choices...", count));
-
- /*
- * Return the array and number of choices; if 0, free the array since
- * it isn't needed.
- */
-
- if (count > 0)
- {
- *choices = collect;
- return (count);
- }
- else
- {
- *choices = NULL;
- free(collect);
- return (0);
- }
-}
-
-
-/*
- * 'ppdEmit()' - Emit code for marked options to a file.
- */
-
-int /* O - 0 on success, -1 on failure */
-ppdEmit(ppd_file_t *ppd, /* I - PPD file record */
- FILE *fp, /* I - File to write to */
- ppd_section_t section) /* I - Section to write */
-{
- return (ppdEmitAfterOrder(ppd, fp, section, 0, 0.0));
-}
-
-
-/*
- * 'ppdEmitAfterOrder()' - Emit a subset of the code for marked options to a file.
- *
- * When "limit" is non-zero, this function only emits options whose
- * OrderDependency value is greater than or equal to "min_order".
- *
- * When "limit" is zero, this function is identical to ppdEmit().
- *
- * @since CUPS 1.2/OS X 10.5@
- */
-
-int /* O - 0 on success, -1 on failure */
-ppdEmitAfterOrder(
- ppd_file_t *ppd, /* I - PPD file record */
- FILE *fp, /* I - File to write to */
- ppd_section_t section, /* I - Section to write */
- int limit, /* I - Non-zero to use min_order */
- float min_order) /* I - Lowest OrderDependency */
-{
- char *buffer; /* Option code */
- int status; /* Return status */
-
-
- /*
- * Range check input...
- */
-
- if (!ppd || !fp)
- return (-1);
-
- /*
- * Get the string...
- */
-
- buffer = ppdEmitString(ppd, section, limit ? min_order : 0.0f);
-
- /*
- * Write it as needed and return...
- */
-
- if (buffer)
- {
- status = fputs(buffer, fp) < 0 ? -1 : 0;
-
- free(buffer);
- }
- else
- status = 0;
-
- return (status);
-}
-
-
-/*
- * 'ppdEmitFd()' - Emit code for marked options to a file.
- */
-
-int /* O - 0 on success, -1 on failure */
-ppdEmitFd(ppd_file_t *ppd, /* I - PPD file record */
- int fd, /* I - File to write to */
- ppd_section_t section) /* I - Section to write */
-{
- char *buffer, /* Option code */
- *bufptr; /* Pointer into code */
- size_t buflength; /* Length of option code */
- ssize_t bytes; /* Bytes written */
- int status; /* Return status */
-
-
- /*
- * Range check input...
- */
-
- if (!ppd || fd < 0)
- return (-1);
-
- /*
- * Get the string...
- */
-
- buffer = ppdEmitString(ppd, section, 0.0);
-
- /*
- * Write it as needed and return...
- */
-
- if (buffer)
- {
- buflength = strlen(buffer);
- bufptr = buffer;
- bytes = 0;
-
- while (buflength > 0)
- {
-#ifdef WIN32
- if ((bytes = (ssize_t)write(fd, bufptr, (unsigned)buflength)) < 0)
-#else
- if ((bytes = write(fd, bufptr, buflength)) < 0)
-#endif /* WIN32 */
- {
- if (errno == EAGAIN || errno == EINTR)
- continue;
-
- break;
- }
-
- buflength -= bytes;
- bufptr += bytes;
- }
-
- status = bytes < 0 ? -1 : 0;
-
- free(buffer);
- }
- else
- status = 0;
-
- return (status);
-}
-
-
-/*
- * 'ppdEmitJCL()' - Emit code for JCL options to a file.
- */
-
-int /* O - 0 on success, -1 on failure */
-ppdEmitJCL(ppd_file_t *ppd, /* I - PPD file record */
- FILE *fp, /* I - File to write to */
- int job_id, /* I - Job ID */
- const char *user, /* I - Username */
- const char *title) /* I - Title */
-{
- char *ptr; /* Pointer into JCL string */
- char temp[65], /* Local title string */
- displaymsg[33]; /* Local display string */
-
-
- /*
- * Range check the input...
- */
-
- if (!ppd || !ppd->jcl_begin || !ppd->jcl_ps)
- return (0);
-
- /*
- * See if the printer supports HP PJL...
- */
-
- if (!strncmp(ppd->jcl_begin, "\033%-12345X@", 10))
- {
- /*
- * This printer uses HP PJL commands for output; filter the output
- * so that we only have a single "@PJL JOB" command in the header...
- *
- * To avoid bugs in the PJL implementation of certain vendors' products
- * (Xerox in particular), we add a dummy "@PJL" command at the beginning
- * of the PJL commands to initialize PJL processing.
- */
-
- ppd_attr_t *charset; /* PJL charset */
- ppd_attr_t *display; /* PJL display command */
-
-
- if ((charset = ppdFindAttr(ppd, "cupsPJLCharset", NULL)) != NULL)
- {
- if (!charset->value || _cups_strcasecmp(charset->value, "UTF-8"))
- charset = NULL;
- }
-
- if ((display = ppdFindAttr(ppd, "cupsPJLDisplay", NULL)) != NULL)
- {
- if (!display->value)
- display = NULL;
- }
-
- fputs("\033%-12345X@PJL\n", fp);
- for (ptr = ppd->jcl_begin + 9; *ptr;)
- if (!strncmp(ptr, "@PJL JOB", 8))
- {
- /*
- * Skip job command...
- */
-
- for (;*ptr; ptr ++)
- if (*ptr == '\n')
- break;
-
- if (*ptr)
- ptr ++;
- }
- else
- {
- /*
- * Copy line...
- */
-
- for (;*ptr; ptr ++)
- {
- putc(*ptr, fp);
- if (*ptr == '\n')
- break;
- }
-
- if (*ptr)
- ptr ++;
- }
-
- /*
- * Clean up the job title...
- */
-
- if ((ptr = strrchr(title, '/')) != NULL)
- {
- /*
- * Only show basename of file path...
- */
-
- title = ptr + 1;
- }
-
- if (!strncmp(title, "smbprn.", 7))
- {
- /*
- * Skip leading smbprn.######## from Samba jobs...
- */
-
- for (title += 7; *title && isdigit(*title & 255); title ++);
- while (_cups_isspace(*title))
- title ++;
-
- if ((ptr = strstr(title, " - ")) != NULL)
- {
- /*
- * Skip application name in "Some Application - Title of job"...
- */
-
- title = ptr + 3;
- }
- }
-
- /*
- * Replace double quotes with single quotes and UTF-8 characters with
- * question marks so that the title does not cause a PJL syntax error.
- */
-
- strlcpy(temp, title, sizeof(temp));
-
- for (ptr = temp; *ptr; ptr ++)
- if (*ptr == '\"')
- *ptr = '\'';
- else if (!charset && (*ptr & 128))
- *ptr = '?';
-
- /*
- * CUPS STR #3125: Long PJL JOB NAME causes problems with some printers
- *
- * Generate the display message, truncating at 32 characters + nul to avoid
- * issues with some printer's PJL implementations...
- */
-
- snprintf(displaymsg, sizeof(displaymsg), "%d %s %s", job_id, user, temp);
-
- /*
- * Send PJL JOB and PJL RDYMSG commands before we enter PostScript mode...
- */
-
- if (display && strcmp(display->value, "job"))
- fprintf(fp, "@PJL JOB NAME = \"%s\"\n", temp);
- else if (display && !strcmp(display->value, "rdymsg"))
- fprintf(fp, "@PJL RDYMSG DISPLAY = \"%s\"\n", displaymsg);
- else
- fprintf(fp, "@PJL JOB NAME = \"%s\" DISPLAY = \"%s\"\n", temp,
- displaymsg);
-
- /*
- * Replace double quotes with single quotes and UTF-8 characters with
- * question marks so that the user does not cause a PJL syntax error.
- */
-
- strlcpy(temp, user, sizeof(temp));
-
- for (ptr = temp; *ptr; ptr ++)
- if (*ptr == '\"')
- *ptr = '\'';
- else if (!charset && (*ptr & 128))
- *ptr = '?';
-
- fprintf(fp, "@PJL SET USERNAME = \"%s\"\n", temp);
- }
- else
- fputs(ppd->jcl_begin, fp);
-
- ppdEmit(ppd, fp, PPD_ORDER_JCL);
- fputs(ppd->jcl_ps, fp);
-
- return (0);
-}
-
-
-/*
- * 'ppdEmitJCLEnd()' - Emit JCLEnd code to a file.
- *
- * @since CUPS 1.2/OS X 10.5@
- */
-
-int /* O - 0 on success, -1 on failure */
-ppdEmitJCLEnd(ppd_file_t *ppd, /* I - PPD file record */
- FILE *fp) /* I - File to write to */
-{
- /*
- * Range check the input...
- */
-
- if (!ppd)
- return (0);
-
- if (!ppd->jcl_end)
- {
- if (ppd->num_filters == 0)
- putc(0x04, fp);
-
- return (0);
- }
-
- /*
- * See if the printer supports HP PJL...
- */
-
- if (!strncmp(ppd->jcl_end, "\033%-12345X@", 10))
- {
- /*
- * This printer uses HP PJL commands for output; filter the output
- * so that we only have a single "@PJL JOB" command in the header...
- *
- * To avoid bugs in the PJL implementation of certain vendors' products
- * (Xerox in particular), we add a dummy "@PJL" command at the beginning
- * of the PJL commands to initialize PJL processing.
- */
-
- fputs("\033%-12345X@PJL\n", fp);
- fputs("@PJL RDYMSG DISPLAY = \"\"\n", fp);
- fputs(ppd->jcl_end + 9, fp);
- }
- else
- fputs(ppd->jcl_end, fp);
-
- return (0);
-}
-
-
-/*
- * 'ppdEmitString()' - Get a string containing the code for marked options.
- *
- * When "min_order" is greater than zero, this function only includes options
- * whose OrderDependency value is greater than or equal to "min_order".
- * Otherwise, all options in the specified section are included in the
- * returned string.
- *
- * The return string is allocated on the heap and should be freed using
- * @code free@ when you are done with it.
- *
- * @since CUPS 1.2/OS X 10.5@
- */
-
-char * /* O - String containing option code or @code NULL@ if there is no option code */
-ppdEmitString(ppd_file_t *ppd, /* I - PPD file record */
- ppd_section_t section, /* I - Section to write */
- float min_order) /* I - Lowest OrderDependency */
-{
- int i, j, /* Looping vars */
- count; /* Number of choices */
- ppd_choice_t **choices; /* Choices */
- ppd_size_t *size; /* Custom page size */
- ppd_coption_t *coption; /* Custom option */
- ppd_cparam_t *cparam; /* Custom parameter */
- size_t bufsize; /* Size of string buffer needed */
- char *buffer, /* String buffer */
- *bufptr, /* Pointer into buffer */
- *bufend; /* End of buffer */
- struct lconv *loc; /* Locale data */
-
-
- DEBUG_printf(("ppdEmitString(ppd=%p, section=%d, min_order=%f)",
- ppd, section, min_order));
-
- /*
- * Range check input...
- */
-
- if (!ppd)
- return (NULL);
-
- /*
- * Use PageSize or PageRegion as required...
- */
-
- ppd_handle_media(ppd);
-
- /*
- * Collect the options we need to emit...
- */
-
- if ((count = ppdCollect2(ppd, section, min_order, &choices)) == 0)
- return (NULL);
-
- /*
- * Count the number of bytes that are required to hold all of the
- * option code...
- */
-
- for (i = 0, bufsize = 1; i < count; i ++)
- {
- if (section == PPD_ORDER_JCL)
- {
- if (!_cups_strcasecmp(choices[i]->choice, "Custom") &&
- (coption = ppdFindCustomOption(ppd, choices[i]->option->keyword))
- != NULL)
- {
- /*
- * Add space to account for custom parameter substitution...
- */
-
- for (cparam = (ppd_cparam_t *)cupsArrayFirst(coption->params);
- cparam;
- cparam = (ppd_cparam_t *)cupsArrayNext(coption->params))
- {
- switch (cparam->type)
- {
- case PPD_CUSTOM_CURVE :
- case PPD_CUSTOM_INVCURVE :
- case PPD_CUSTOM_POINTS :
- case PPD_CUSTOM_REAL :
- case PPD_CUSTOM_INT :
- bufsize += 10;
- break;
-
- case PPD_CUSTOM_PASSCODE :
- case PPD_CUSTOM_PASSWORD :
- case PPD_CUSTOM_STRING :
- if (cparam->current.custom_string)
- bufsize += strlen(cparam->current.custom_string);
- break;
- }
- }
- }
- }
- else if (section != PPD_ORDER_EXIT)
- {
- bufsize += 3; /* [{\n */
-
- if ((!_cups_strcasecmp(choices[i]->option->keyword, "PageSize") ||
- !_cups_strcasecmp(choices[i]->option->keyword, "PageRegion")) &&
- !_cups_strcasecmp(choices[i]->choice, "Custom"))
- {
- DEBUG_puts("2ppdEmitString: Custom size set!");
-
- bufsize += 37; /* %%BeginFeature: *CustomPageSize True\n */
- bufsize += 50; /* Five 9-digit numbers + newline */
- }
- else if (!_cups_strcasecmp(choices[i]->choice, "Custom") &&
- (coption = ppdFindCustomOption(ppd,
- choices[i]->option->keyword))
- != NULL)
- {
- bufsize += 23 + strlen(choices[i]->option->keyword) + 6;
- /* %%BeginFeature: *Customkeyword True\n */
-
-
- for (cparam = (ppd_cparam_t *)cupsArrayFirst(coption->params);
- cparam;
- cparam = (ppd_cparam_t *)cupsArrayNext(coption->params))
- {
- switch (cparam->type)
- {
- case PPD_CUSTOM_CURVE :
- case PPD_CUSTOM_INVCURVE :
- case PPD_CUSTOM_POINTS :
- case PPD_CUSTOM_REAL :
- case PPD_CUSTOM_INT :
- bufsize += 10;
- break;
-
- case PPD_CUSTOM_PASSCODE :
- case PPD_CUSTOM_PASSWORD :
- case PPD_CUSTOM_STRING :
- bufsize += 3;
- if (cparam->current.custom_string)
- bufsize += 4 * strlen(cparam->current.custom_string);
- break;
- }
- }
- }
- else
- bufsize += 17 + strlen(choices[i]->option->keyword) + 1 +
- strlen(choices[i]->choice) + 1;
- /* %%BeginFeature: *keyword choice\n */
-
- bufsize += 13; /* %%EndFeature\n */
- bufsize += 22; /* } stopped cleartomark\n */
- }
-
- if (choices[i]->code)
- bufsize += strlen(choices[i]->code) + 1;
- else
- bufsize += strlen(ppd_custom_code);
- }
-
- /*
- * Allocate memory...
- */
-
- DEBUG_printf(("2ppdEmitString: Allocating %d bytes for string...",
- (int)bufsize));
-
- if ((buffer = calloc(1, bufsize)) == NULL)
- {
- free(choices);
- return (NULL);
- }
-
- bufend = buffer + bufsize - 1;
- loc = localeconv();
-
- /*
- * Copy the option code to the buffer...
- */
-
- for (i = 0, bufptr = buffer; i < count; i ++, bufptr += strlen(bufptr))
- if (section == PPD_ORDER_JCL)
- {
- if (!_cups_strcasecmp(choices[i]->choice, "Custom") &&
- choices[i]->code &&
- (coption = ppdFindCustomOption(ppd, choices[i]->option->keyword))
- != NULL)
- {
- /*
- * Handle substitutions in custom JCL options...
- */
-
- char *cptr; /* Pointer into code */
- int pnum; /* Parameter number */
-
-
- for (cptr = choices[i]->code; *cptr && bufptr < bufend;)
- {
- if (*cptr == '\\')
- {
- cptr ++;
-
- if (isdigit(*cptr & 255))
- {
- /*
- * Substitute parameter...
- */
-
- pnum = *cptr++ - '0';
- while (isdigit(*cptr & 255))
- pnum = pnum * 10 + *cptr++ - '0';
-
- for (cparam = (ppd_cparam_t *)cupsArrayFirst(coption->params);
- cparam;
- cparam = (ppd_cparam_t *)cupsArrayNext(coption->params))
- if (cparam->order == pnum)
- break;
-
- if (cparam)
- {
- switch (cparam->type)
- {
- case PPD_CUSTOM_CURVE :
- case PPD_CUSTOM_INVCURVE :
- case PPD_CUSTOM_POINTS :
- case PPD_CUSTOM_REAL :
- bufptr = _cupsStrFormatd(bufptr, bufend,
- cparam->current.custom_real,
- loc);
- break;
-
- case PPD_CUSTOM_INT :
- snprintf(bufptr, bufend - bufptr, "%d",
- cparam->current.custom_int);
- bufptr += strlen(bufptr);
- break;
-
- case PPD_CUSTOM_PASSCODE :
- case PPD_CUSTOM_PASSWORD :
- case PPD_CUSTOM_STRING :
- if (cparam->current.custom_string)
- {
- strlcpy(bufptr, cparam->current.custom_string,
- bufend - bufptr);
- bufptr += strlen(bufptr);
- }
- break;
- }
- }
- }
- else if (*cptr)
- *bufptr++ = *cptr++;
- }
- else
- *bufptr++ = *cptr++;
- }
- }
- else
- {
- /*
- * Otherwise just copy the option code directly...
- */
-
- strlcpy(bufptr, choices[i]->code, bufend - bufptr + 1);
- bufptr += strlen(bufptr);
- }
- }
- else if (section != PPD_ORDER_EXIT)
- {
- /*
- * Add wrapper commands to prevent printer errors for unsupported
- * options...
- */
-
- strlcpy(bufptr, "[{\n", bufend - bufptr + 1);
- bufptr += 3;
-
- /*
- * Send DSC comments with option...
- */
-
- DEBUG_printf(("2ppdEmitString: Adding code for %s=%s...",
- choices[i]->option->keyword, choices[i]->choice));
-
- if ((!_cups_strcasecmp(choices[i]->option->keyword, "PageSize") ||
- !_cups_strcasecmp(choices[i]->option->keyword, "PageRegion")) &&
- !_cups_strcasecmp(choices[i]->choice, "Custom"))
- {
- /*
- * Variable size; write out standard size options, using the
- * parameter positions defined in the PPD file...
- */
-
- ppd_attr_t *attr; /* PPD attribute */
- int pos, /* Position of custom value */
- orientation; /* Orientation to use */
- float values[5]; /* Values for custom command */
-
-
- strlcpy(bufptr, "%%BeginFeature: *CustomPageSize True\n",
- bufend - bufptr + 1);
- bufptr += 37;
-
- size = ppdPageSize(ppd, "Custom");
-
- memset(values, 0, sizeof(values));
-
- if ((attr = ppdFindAttr(ppd, "ParamCustomPageSize", "Width")) != NULL)
- {
- pos = atoi(attr->value) - 1;
-
- if (pos < 0 || pos > 4)
- pos = 0;
- }
- else
- pos = 0;
-
- values[pos] = size->width;
-
- if ((attr = ppdFindAttr(ppd, "ParamCustomPageSize", "Height")) != NULL)
- {
- pos = atoi(attr->value) - 1;
-
- if (pos < 0 || pos > 4)
- pos = 1;
- }
- else
- pos = 1;
-
- values[pos] = size->length;
-
- /*
- * According to the Adobe PPD specification, an orientation of 1
- * will produce a print that comes out upside-down with the X
- * axis perpendicular to the direction of feed, which is exactly
- * what we want to be consistent with non-PS printers.
- *
- * We could also use an orientation of 3 to produce output that
- * comes out rightside-up (this is the default for many large format
- * printer PPDs), however for consistency we will stick with the
- * value 1.
- *
- * If we wanted to get fancy, we could use orientations of 0 or
- * 2 and swap the width and length, however we don't want to get
- * fancy, we just want it to work consistently.
- *
- * The orientation value is range limited by the Orientation
- * parameter definition, so certain non-PS printer drivers that
- * only support an Orientation of 0 will get the value 0 as
- * expected.
- */
-
- orientation = 1;
-
- if ((attr = ppdFindAttr(ppd, "ParamCustomPageSize",
- "Orientation")) != NULL)
- {
- int min_orient, max_orient; /* Minimum and maximum orientations */
-
-
- if (sscanf(attr->value, "%d%*s%d%d", &pos, &min_orient,
- &max_orient) != 3)
- pos = 4;
- else
- {
- pos --;
-
- if (pos < 0 || pos > 4)
- pos = 4;
-
- if (orientation > max_orient)
- orientation = max_orient;
- else if (orientation < min_orient)
- orientation = min_orient;
- }
- }
- else
- pos = 4;
-
- values[pos] = (float)orientation;
-
- for (pos = 0; pos < 5; pos ++)
- {
- bufptr = _cupsStrFormatd(bufptr, bufend, values[pos], loc);
- *bufptr++ = '\n';
- }
-
- if (!choices[i]->code)
- {
- /*
- * This can happen with certain buggy PPD files that don't include
- * a CustomPageSize command sequence... We just use a generic
- * Level 2 command sequence...
- */
-
- strlcpy(bufptr, ppd_custom_code, bufend - bufptr + 1);
- bufptr += strlen(bufptr);
- }
- }
- else if (!_cups_strcasecmp(choices[i]->choice, "Custom") &&
- (coption = ppdFindCustomOption(ppd, choices[i]->option->keyword))
- != NULL)
- {
- /*
- * Custom option...
- */
-
- const char *s; /* Pointer into string value */
- cups_array_t *params; /* Parameters in the correct output order */
-
-
- params = cupsArrayNew((cups_array_func_t)ppd_compare_cparams, NULL);
-
- for (cparam = (ppd_cparam_t *)cupsArrayFirst(coption->params);
- cparam;
- cparam = (ppd_cparam_t *)cupsArrayNext(coption->params))
- cupsArrayAdd(params, cparam);
-
- snprintf(bufptr, bufend - bufptr + 1,
- "%%%%BeginFeature: *Custom%s True\n", coption->keyword);
- bufptr += strlen(bufptr);
-
- for (cparam = (ppd_cparam_t *)cupsArrayFirst(params);
- cparam;
- cparam = (ppd_cparam_t *)cupsArrayNext(params))
- {
- switch (cparam->type)
- {
- case PPD_CUSTOM_CURVE :
- case PPD_CUSTOM_INVCURVE :
- case PPD_CUSTOM_POINTS :
- case PPD_CUSTOM_REAL :
- bufptr = _cupsStrFormatd(bufptr, bufend,
- cparam->current.custom_real, loc);
- *bufptr++ = '\n';
- break;
-
- case PPD_CUSTOM_INT :
- snprintf(bufptr, bufend - bufptr + 1, "%d\n",
- cparam->current.custom_int);
- bufptr += strlen(bufptr);
- break;
-
- case PPD_CUSTOM_PASSCODE :
- case PPD_CUSTOM_PASSWORD :
- case PPD_CUSTOM_STRING :
- *bufptr++ = '(';
-
- if (cparam->current.custom_string)
- {
- for (s = cparam->current.custom_string; *s; s ++)
- {
- if (*s < ' ' || *s == '(' || *s == ')' || *s >= 127)
- {
- snprintf(bufptr, bufend - bufptr + 1, "\\%03o", *s & 255);
- bufptr += strlen(bufptr);
- }
- else
- *bufptr++ = *s;
- }
- }
-
- *bufptr++ = ')';
- *bufptr++ = '\n';
- break;
- }
- }
-
- cupsArrayDelete(params);
- }
- else
- {
- snprintf(bufptr, bufend - bufptr + 1, "%%%%BeginFeature: *%s %s\n",
- choices[i]->option->keyword, choices[i]->choice);
- bufptr += strlen(bufptr);
- }
-
- if (choices[i]->code && choices[i]->code[0])
- {
- j = (int)strlen(choices[i]->code);
- memcpy(bufptr, choices[i]->code, j);
- bufptr += j;
-
- if (choices[i]->code[j - 1] != '\n')
- *bufptr++ = '\n';
- }
-
- strlcpy(bufptr, "%%EndFeature\n"
- "} stopped cleartomark\n", bufend - bufptr + 1);
- bufptr += strlen(bufptr);
-
- DEBUG_printf(("2ppdEmitString: Offset in string is %d...",
- (int)(bufptr - buffer)));
- }
- else
- {
- strlcpy(bufptr, choices[i]->code, bufend - bufptr + 1);
- bufptr += strlen(bufptr);
- }
-
- /*
- * Nul-terminate, free, and return...
- */
-
- *bufptr = '\0';
-
- free(choices);
-
- return (buffer);
-}
-
-
-/*
- * 'ppd_compare_cparams()' - Compare the order of two custom parameters.
- */
-
-static int /* O - Result of comparison */
-ppd_compare_cparams(ppd_cparam_t *a, /* I - First parameter */
- ppd_cparam_t *b) /* I - Second parameter */
-{
- return (a->order - b->order);
-}
-
-
-/*
- * 'ppd_handle_media()' - Handle media selection...
- */
-
-static void
-ppd_handle_media(ppd_file_t *ppd) /* I - PPD file */
-{
- ppd_choice_t *manual_feed, /* ManualFeed choice, if any */
- *input_slot; /* InputSlot choice, if any */
- ppd_size_t *size; /* Current media size */
- ppd_attr_t *rpr; /* RequiresPageRegion value */
-
-
- /*
- * This function determines what page size code to use, if any, for the
- * current media size, InputSlot, and ManualFeed selections.
- *
- * We use the PageSize code if:
- *
- * 1. A custom media size is selected.
- * 2. ManualFeed and InputSlot are not selected (or do not exist).
- * 3. ManualFeed is selected but is False and InputSlot is not selected or
- * the selection has no code - the latter check done to support "auto" or
- * "printer default" InputSlot options.
- *
- * We use the PageRegion code if:
- *
- * 4. RequiresPageRegion does not exist and the PPD contains cupsFilter
- * keywords, indicating this is a CUPS-based driver.
- * 5. RequiresPageRegion exists for the selected InputSlot (or "All" for any
- * InputSlot or ManualFeed selection) and is True.
- *
- * If none of the 5 conditions are true, no page size code is used and we
- * unmark any existing PageSize or PageRegion choices.
- */
-
- if ((size = ppdPageSize(ppd, NULL)) == NULL)
- return;
-
- manual_feed = ppdFindMarkedChoice(ppd, "ManualFeed");
- input_slot = ppdFindMarkedChoice(ppd, "InputSlot");
-
- if (input_slot != NULL)
- rpr = ppdFindAttr(ppd, "RequiresPageRegion", input_slot->choice);
- else
- rpr = NULL;
-
- if (!rpr)
- rpr = ppdFindAttr(ppd, "RequiresPageRegion", "All");
-
- if (!_cups_strcasecmp(size->name, "Custom") ||
- (!manual_feed && !input_slot) ||
- (manual_feed && !_cups_strcasecmp(manual_feed->choice, "False") &&
- (!input_slot || (input_slot->code && !input_slot->code[0]))) ||
- (!rpr && ppd->num_filters > 0))
- {
- /*
- * Use PageSize code...
- */
-
- ppdMarkOption(ppd, "PageSize", size->name);
- }
- else if (rpr && rpr->value && !_cups_strcasecmp(rpr->value, "True"))
- {
- /*
- * Use PageRegion code...
- */
-
- ppdMarkOption(ppd, "PageRegion", size->name);
- }
- else
- {
- /*
- * Do not use PageSize or PageRegion code...
- */
-
- ppd_choice_t *page; /* PageSize/Region choice, if any */
-
- if ((page = ppdFindMarkedChoice(ppd, "PageSize")) != NULL)
- {
- /*
- * Unmark PageSize...
- */
-
- page->marked = 0;
- cupsArrayRemove(ppd->marked, page);
- }
-
- if ((page = ppdFindMarkedChoice(ppd, "PageRegion")) != NULL)
- {
- /*
- * Unmark PageRegion...
- */
-
- page->marked = 0;
- cupsArrayRemove(ppd->marked, page);
- }
- }
-}
-
-
-/*
- * End of "$Id: emit.c 7863 2008-08-26 03:39:59Z mike $".
- */
diff --git a/cups/encode.c b/cups/encode.c
index 94695d0..2469406 100644
--- a/cups/encode.c
+++ b/cups/encode.c
@@ -1,16 +1,11 @@
/*
* Option encoding routines for CUPS.
*
- * Copyright 2007-2017 by Apple Inc.
- * Copyright 1997-2007 by Easy Software Products.
+ * Copyright © 2007-2019 by Apple Inc.
+ * Copyright © 1997-2007 by Easy Software Products.
*
- * 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.
+ * Licensed under Apache License v2.0. See the file "LICENSE" for more
+ * information.
*/
/*
@@ -18,6 +13,7 @@
*/
#include "cups-private.h"
+#include "debug-internal.h"
/*
@@ -134,6 +130,9 @@ static const _ipp_option_t ipp_options[] =
cups_schemes },
{ 1, "finishings", IPP_TAG_ENUM, IPP_TAG_JOB,
IPP_TAG_DOCUMENT },
+ { 1, "finishings-col", IPP_TAG_BEGIN_COLLECTION, IPP_TAG_JOB,
+ IPP_TAG_DOCUMENT },
+ { 1, "finishings-col-default", IPP_TAG_BEGIN_COLLECTION, IPP_TAG_PRINTER },
{ 1, "finishings-default", IPP_TAG_ENUM, IPP_TAG_PRINTER },
{ 0, "fit-to-page", IPP_TAG_BOOLEAN, IPP_TAG_JOB,
IPP_TAG_DOCUMENT },
@@ -147,6 +146,7 @@ static const _ipp_option_t ipp_options[] =
{ 1, "include-schemes", IPP_TAG_NAME, IPP_TAG_OPERATION,
IPP_TAG_ZERO,
cups_schemes },
+ { 0, "ipp-attribute-fidelity", IPP_TAG_BOOLEAN, IPP_TAG_OPERATION },
{ 0, "job-account-id", IPP_TAG_NAME, IPP_TAG_JOB },
{ 0, "job-account-id-default",IPP_TAG_NAME, IPP_TAG_PRINTER },
{ 0, "job-accounting-user-id", IPP_TAG_NAME, IPP_TAG_JOB },
@@ -155,15 +155,20 @@ static const _ipp_option_t ipp_options[] =
{ 0, "job-cancel-after", IPP_TAG_INTEGER, IPP_TAG_JOB },
{ 0, "job-cancel-after-default", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
{ 0, "job-hold-until", IPP_TAG_KEYWORD, IPP_TAG_JOB },
+ { 0, "job-hold-until-default", IPP_TAG_KEYWORD, IPP_TAG_PRINTER },
{ 0, "job-id", IPP_TAG_INTEGER, IPP_TAG_ZERO }, /* never send as option */
- { 0, "job-impressions", IPP_TAG_INTEGER, IPP_TAG_ZERO }, /* never send as option */
+ { 0, "job-impressions", IPP_TAG_INTEGER, IPP_TAG_OPERATION },
{ 0, "job-impressions-completed", IPP_TAG_INTEGER, IPP_TAG_ZERO }, /* never send as option */
{ 0, "job-k-limit", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
- { 0, "job-k-octets", IPP_TAG_INTEGER, IPP_TAG_ZERO }, /* never send as option */
+ { 0, "job-k-octets", IPP_TAG_INTEGER, IPP_TAG_OPERATION },
{ 0, "job-k-octets-completed",IPP_TAG_INTEGER, IPP_TAG_ZERO }, /* never send as option */
- { 0, "job-media-sheets", IPP_TAG_INTEGER, IPP_TAG_ZERO }, /* never send as option */
+ { 0, "job-media-sheets", IPP_TAG_INTEGER, IPP_TAG_OPERATION },
{ 0, "job-media-sheets-completed", IPP_TAG_INTEGER, IPP_TAG_ZERO }, /* never send as option */
+ { 0, "job-name", IPP_TAG_NAME, IPP_TAG_OPERATION,
+ IPP_TAG_JOB },
{ 0, "job-page-limit", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
+ { 0, "job-pages", IPP_TAG_INTEGER, IPP_TAG_OPERATION },
+ { 0, "job-pages-completed", IPP_TAG_INTEGER, IPP_TAG_ZERO }, /* never send as option */
{ 0, "job-password", IPP_TAG_STRING, IPP_TAG_OPERATION,
IPP_TAG_ZERO,
ipp_job_creation },
@@ -171,6 +176,7 @@ static const _ipp_option_t ipp_options[] =
IPP_TAG_ZERO,
ipp_job_creation },
{ 0, "job-priority", IPP_TAG_INTEGER, IPP_TAG_JOB },
+ { 0, "job-priority-default", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
{ 0, "job-quota-period", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
{ 1, "job-sheets", IPP_TAG_NAME, IPP_TAG_JOB },
{ 1, "job-sheets-default", IPP_TAG_NAME, IPP_TAG_PRINTER },
@@ -189,6 +195,8 @@ static const _ipp_option_t ipp_options[] =
{ 1, "marker-types", IPP_TAG_KEYWORD, IPP_TAG_PRINTER },
{ 1, "media", IPP_TAG_KEYWORD, IPP_TAG_JOB,
IPP_TAG_DOCUMENT },
+ { 0, "media-bottom-margin", IPP_TAG_INTEGER, IPP_TAG_JOB,
+ IPP_TAG_DOCUMENT },
{ 0, "media-col", IPP_TAG_BEGIN_COLLECTION, IPP_TAG_JOB,
IPP_TAG_DOCUMENT },
{ 0, "media-col-default", IPP_TAG_BEGIN_COLLECTION, IPP_TAG_PRINTER },
@@ -197,12 +205,25 @@ static const _ipp_option_t ipp_options[] =
{ 1, "media-default", IPP_TAG_KEYWORD, IPP_TAG_PRINTER },
{ 0, "media-key", IPP_TAG_KEYWORD, IPP_TAG_JOB,
IPP_TAG_DOCUMENT },
+ { 0, "media-left-margin", IPP_TAG_INTEGER, IPP_TAG_JOB,
+ IPP_TAG_DOCUMENT },
+ { 0, "media-right-margin", IPP_TAG_INTEGER, IPP_TAG_JOB,
+ IPP_TAG_DOCUMENT },
{ 0, "media-size", IPP_TAG_BEGIN_COLLECTION, IPP_TAG_JOB,
IPP_TAG_DOCUMENT },
+ { 0, "media-size-name", IPP_TAG_KEYWORD, IPP_TAG_JOB,
+ IPP_TAG_DOCUMENT },
+ { 0, "media-source", IPP_TAG_KEYWORD, IPP_TAG_JOB,
+ IPP_TAG_DOCUMENT },
+ { 0, "media-top-margin", IPP_TAG_INTEGER, IPP_TAG_JOB,
+ IPP_TAG_DOCUMENT },
{ 0, "media-type", IPP_TAG_KEYWORD, IPP_TAG_JOB,
IPP_TAG_DOCUMENT },
{ 0, "mirror", IPP_TAG_BOOLEAN, IPP_TAG_JOB },
{ 0, "mirror-default", IPP_TAG_BOOLEAN, IPP_TAG_PRINTER },
+ { 0, "multiple-document-handling", IPP_TAG_KEYWORD, IPP_TAG_JOB,
+ IPP_TAG_DOCUMENT },
+ { 0, "multiple-document-handling-default", IPP_TAG_KEYWORD, IPP_TAG_PRINTER },
{ 0, "natural-scaling", IPP_TAG_INTEGER, IPP_TAG_JOB },
{ 0, "natural-scaling-default", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
{ 0, "notify-charset", IPP_TAG_CHARSET, IPP_TAG_SUBSCRIPTION },
@@ -218,18 +239,26 @@ static const _ipp_option_t ipp_options[] =
{ 0, "number-up", IPP_TAG_INTEGER, IPP_TAG_JOB,
IPP_TAG_DOCUMENT },
{ 0, "number-up-default", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
+ { 0, "number-up-layout", IPP_TAG_KEYWORD, IPP_TAG_JOB,
+ IPP_TAG_DOCUMENT },
+ { 0, "number-up-layout-default", IPP_TAG_KEYWORD, IPP_TAG_PRINTER },
{ 0, "orientation-requested", IPP_TAG_ENUM, IPP_TAG_JOB,
IPP_TAG_DOCUMENT },
{ 0, "orientation-requested-default", IPP_TAG_ENUM, IPP_TAG_PRINTER },
+ { 0, "output-bin", IPP_TAG_KEYWORD, IPP_TAG_JOB,
+ IPP_TAG_DOCUMENT },
+ { 0, "output-bin-default", IPP_TAG_KEYWORD, IPP_TAG_PRINTER },
{ 1, "overrides", IPP_TAG_BEGIN_COLLECTION, IPP_TAG_JOB,
IPP_TAG_DOCUMENT },
{ 0, "page-bottom", IPP_TAG_INTEGER, IPP_TAG_JOB },
{ 0, "page-bottom-default", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
+ { 0, "page-delivery", IPP_TAG_KEYWORD, IPP_TAG_JOB,
+ IPP_TAG_DOCUMENT },
+ { 0, "page-delivery-default", IPP_TAG_KEYWORD, IPP_TAG_PRINTER },
{ 0, "page-left", IPP_TAG_INTEGER, IPP_TAG_JOB },
{ 0, "page-left-default", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
{ 1, "page-ranges", IPP_TAG_RANGE, IPP_TAG_JOB,
IPP_TAG_DOCUMENT },
- { 1, "page-ranges-default", IPP_TAG_RANGE, IPP_TAG_PRINTER },
{ 0, "page-right", IPP_TAG_INTEGER, IPP_TAG_JOB },
{ 0, "page-right-default", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
{ 0, "page-top", IPP_TAG_INTEGER, IPP_TAG_JOB },
@@ -270,13 +299,32 @@ static const _ipp_option_t ipp_options[] =
{ 0, "ppi-default", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
{ 0, "prettyprint", IPP_TAG_BOOLEAN, IPP_TAG_JOB },
{ 0, "prettyprint-default", IPP_TAG_BOOLEAN, IPP_TAG_PRINTER },
+ { 0, "print-color-mode", IPP_TAG_KEYWORD, IPP_TAG_JOB,
+ IPP_TAG_DOCUMENT },
+ { 0, "print-color-mode-default", IPP_TAG_KEYWORD, IPP_TAG_PRINTER },
+ { 0, "print-content-optimize", IPP_TAG_KEYWORD, IPP_TAG_JOB,
+ IPP_TAG_DOCUMENT },
+ { 0, "print-content-optimize-default", IPP_TAG_KEYWORD, IPP_TAG_PRINTER },
{ 0, "print-quality", IPP_TAG_ENUM, IPP_TAG_JOB,
IPP_TAG_DOCUMENT },
{ 0, "print-quality-default", IPP_TAG_ENUM, IPP_TAG_PRINTER },
+ { 0, "print-rendering-intent", IPP_TAG_KEYWORD, IPP_TAG_JOB,
+ IPP_TAG_DOCUMENT },
+ { 0, "print-rendering-intent-default", IPP_TAG_KEYWORD, IPP_TAG_PRINTER },
+ { 0, "print-scaling", IPP_TAG_KEYWORD, IPP_TAG_JOB,
+ IPP_TAG_DOCUMENT },
+ { 0, "print-scaling-default", IPP_TAG_KEYWORD, IPP_TAG_PRINTER },
+ { 1, "printer-alert", IPP_TAG_STRING, IPP_TAG_PRINTER },
+ { 1, "printer-alert-description", IPP_TAG_TEXT, IPP_TAG_PRINTER },
{ 1, "printer-commands", IPP_TAG_KEYWORD, IPP_TAG_PRINTER },
{ 0, "printer-error-policy", IPP_TAG_NAME, IPP_TAG_PRINTER },
+ { 1, "printer-finisher", IPP_TAG_STRING, IPP_TAG_PRINTER },
+ { 1, "printer-finisher-description", IPP_TAG_TEXT, IPP_TAG_PRINTER },
+ { 1, "printer-finisher-supplies", IPP_TAG_STRING, IPP_TAG_PRINTER },
+ { 1, "printer-finisher-supplies-description", IPP_TAG_TEXT, IPP_TAG_PRINTER },
{ 0, "printer-geo-location", IPP_TAG_URI, IPP_TAG_PRINTER },
{ 0, "printer-info", IPP_TAG_TEXT, IPP_TAG_PRINTER },
+ { 1, "printer-input-tray", IPP_TAG_STRING, IPP_TAG_PRINTER },
{ 0, "printer-is-accepting-jobs", IPP_TAG_BOOLEAN, IPP_TAG_PRINTER },
{ 0, "printer-is-shared", IPP_TAG_BOOLEAN, IPP_TAG_PRINTER },
{ 0, "printer-is-temporary", IPP_TAG_BOOLEAN, IPP_TAG_PRINTER },
@@ -284,11 +332,15 @@ static const _ipp_option_t ipp_options[] =
{ 0, "printer-make-and-model", IPP_TAG_TEXT, IPP_TAG_PRINTER },
{ 0, "printer-more-info", IPP_TAG_URI, IPP_TAG_PRINTER },
{ 0, "printer-op-policy", IPP_TAG_NAME, IPP_TAG_PRINTER },
+ { 1, "printer-output-tray", IPP_TAG_STRING, IPP_TAG_PRINTER },
{ 0, "printer-resolution", IPP_TAG_RESOLUTION, IPP_TAG_JOB,
IPP_TAG_DOCUMENT },
+ { 0, "printer-resolution-default", IPP_TAG_RESOLUTION, IPP_TAG_PRINTER },
{ 0, "printer-state", IPP_TAG_ENUM, IPP_TAG_PRINTER },
{ 0, "printer-state-change-time", IPP_TAG_INTEGER, IPP_TAG_PRINTER },
{ 1, "printer-state-reasons", IPP_TAG_KEYWORD, IPP_TAG_PRINTER },
+ { 1, "printer-supply", IPP_TAG_STRING, IPP_TAG_PRINTER },
+ { 1, "printer-supply-description", IPP_TAG_TEXT, IPP_TAG_PRINTER },
{ 0, "printer-type", IPP_TAG_ENUM, IPP_TAG_PRINTER },
{ 0, "printer-uri", IPP_TAG_URI, IPP_TAG_OPERATION },
{ 1, "printer-uri-supported", IPP_TAG_URI, IPP_TAG_PRINTER },
@@ -325,6 +377,315 @@ static const _ipp_option_t ipp_options[] =
static int compare_ipp_options(_ipp_option_t *a, _ipp_option_t *b);
+/*
+ * '_cupsEncodeOption()' - Encode a single option as an IPP attribute.
+ */
+
+ipp_attribute_t * /* O - New attribute or @code NULL@ on error */
+_cupsEncodeOption(
+ ipp_t *ipp, /* I - IPP request/response/collection */
+ ipp_tag_t group_tag, /* I - Group tag */
+ _ipp_option_t *map, /* I - Option mapping, if any */
+ const char *name, /* I - Attribute name */
+ const char *value) /* I - Value */
+{
+ int i, /* Looping var */
+ count; /* Number of values */
+ char *s, /* Pointer into option value */
+ *val, /* Pointer to option value */
+ *copy, /* Copy of option value */
+ *sep, /* Option separator */
+ quote; /* Quote character */
+ ipp_attribute_t *attr; /* IPP attribute */
+ ipp_tag_t value_tag; /* IPP value tag */
+ ipp_t *collection; /* Collection value */
+ int num_cols; /* Number of collection values */
+ cups_option_t *cols; /* Collection values */
+
+
+ DEBUG_printf(("_cupsEncodeOption(ipp=%p(%s), group=%s, map=%p, name=\"%s\", value=\"%s\")", (void *)ipp, ipp ? ippOpString(ippGetOperation(ipp)) : "", ippTagString(group_tag), (void *)map, name, value));
+
+ /*
+ * Figure out the attribute syntax for encoding...
+ */
+
+ if (!map)
+ map = _ippFindOption(name);
+
+ if (map)
+ value_tag = map->value_tag;
+ else if (!_cups_strcasecmp(value, "true") || !_cups_strcasecmp(value, "false"))
+ value_tag = IPP_TAG_BOOLEAN;
+ else if (value[0] == '{')
+ value_tag = IPP_TAG_BEGIN_COLLECTION;
+ else
+ value_tag = IPP_TAG_NAME;
+
+ /*
+ * Count the number of values...
+ */
+
+ if (map && map->multivalue)
+ {
+ for (count = 1, sep = (char *)value, quote = 0; *sep; sep ++)
+ {
+ if (*sep == quote)
+ quote = 0;
+ else if (!quote && (*sep == '\'' || *sep == '\"'))
+ {
+ /*
+ * Skip quoted option value...
+ */
+
+ quote = *sep;
+ }
+ else if (*sep == ',' && !quote)
+ count ++;
+ else if (*sep == '\\' && sep[1])
+ sep ++;
+ }
+ }
+ else
+ count = 1;
+
+ DEBUG_printf(("2_cupsEncodeOption: value_tag=%s, count=%d", ippTagString(value_tag), count));
+
+ /*
+ * Allocate memory for the attribute values...
+ */
+
+ if ((attr = ippAddStrings(ipp, group_tag, value_tag, name, count, NULL, NULL)) == NULL)
+ {
+ /*
+ * Ran out of memory!
+ */
+
+ DEBUG_puts("1_cupsEncodeOption: Ran out of memory for attributes.");
+ return (NULL);
+ }
+
+ if (count > 1)
+ {
+ /*
+ * Make a copy of the value we can fiddle with...
+ */
+
+ if ((copy = strdup(value)) == NULL)
+ {
+ /*
+ * Ran out of memory!
+ */
+
+ DEBUG_puts("1_cupsEncodeOption: Ran out of memory for value copy.");
+ ippDeleteAttribute(ipp, attr);
+ return (NULL);
+ }
+
+ val = copy;
+ }
+ else
+ {
+ /*
+ * Since we have a single value, use the value directly...
+ */
+
+ val = (char *)value;
+ copy = NULL;
+ }
+
+ /*
+ * Scan the value string for values...
+ */
+
+ for (i = 0, sep = val; i < count; val = sep, i ++)
+ {
+ /*
+ * Find the end of this value and mark it if needed...
+ */
+
+ if (count > 1)
+ {
+ for (quote = 0; *sep; sep ++)
+ {
+ if (*sep == quote)
+ {
+ /*
+ * Finish quoted value...
+ */
+
+ quote = 0;
+ }
+ else if (!quote && (*sep == '\'' || *sep == '\"'))
+ {
+ /*
+ * Handle quoted option value...
+ */
+
+ quote = *sep;
+ }
+ else if (*sep == ',' && count > 1)
+ break;
+ else if (*sep == '\\' && sep[1])
+ {
+ /*
+ * Skip quoted character...
+ */
+
+ memmove(sep, sep + 1, strlen(sep));
+ }
+ }
+
+ if (*sep == ',')
+ *sep++ = '\0';
+ }
+
+ /*
+ * Copy the option value(s) over as needed by the type...
+ */
+
+ switch (attr->value_tag)
+ {
+ case IPP_TAG_INTEGER :
+ case IPP_TAG_ENUM :
+ /*
+ * Integer/enumeration value...
+ */
+
+ ippSetInteger(ipp, &attr, i, (int)strtol(val, &s, 10));
+ break;
+
+ case IPP_TAG_BOOLEAN :
+ if (!_cups_strcasecmp(val, "true") || !_cups_strcasecmp(val, "on") || !_cups_strcasecmp(val, "yes"))
+ {
+ /*
+ * Boolean value - true...
+ */
+
+ ippSetBoolean(ipp, &attr, i, 1);
+ }
+ else
+ {
+ /*
+ * Boolean value - false...
+ */
+
+ ippSetBoolean(ipp, &attr, i, 0);
+ }
+ break;
+
+ case IPP_TAG_RANGE :
+ {
+ /*
+ * Range...
+ */
+
+ int lower, upper; /* Lower and upper ranges... */
+
+ if (*val == '-')
+ {
+ lower = 1;
+ s = val;
+ }
+ else
+ lower = (int)strtol(val, &s, 10);
+
+ if (*s == '-')
+ {
+ if (s[1])
+ upper = (int)strtol(s + 1, NULL, 10);
+ else
+ upper = 2147483647;
+ }
+ else
+ upper = lower;
+
+ ippSetRange(ipp, &attr, i, lower, upper);
+ }
+ break;
+
+ case IPP_TAG_RESOLUTION :
+ {
+ /*
+ * Resolution...
+ */
+ int xres, yres; /* Resolution values */
+ ipp_res_t units; /* Resolution units */
+
+ xres = (int)strtol(val, &s, 10);
+
+ if (*s == 'x')
+ yres = (int)strtol(s + 1, &s, 10);
+ else
+ yres = xres;
+
+ if (!_cups_strcasecmp(s, "dpc") || !_cups_strcasecmp(s, "dpcm"))
+ units = IPP_RES_PER_CM;
+ else
+ units = IPP_RES_PER_INCH;
+
+ ippSetResolution(ipp, &attr, i, units, xres, yres);
+ }
+ break;
+
+ case IPP_TAG_STRING :
+ /*
+ * octetString
+ */
+
+ ippSetOctetString(ipp, &attr, i, val, (int)strlen(val));
+ break;
+
+ case IPP_TAG_BEGIN_COLLECTION :
+ /*
+ * Collection value
+ */
+
+ num_cols = cupsParseOptions(val, 0, &cols);
+ if ((collection = ippNew()) == NULL)
+ {
+ cupsFreeOptions(num_cols, cols);
+
+ if (copy)
+ free(copy);
+
+ ippDeleteAttribute(ipp, attr);
+ return (NULL);
+ }
+
+ ippSetCollection(ipp, &attr, i, collection);
+ cupsEncodeOptions2(collection, num_cols, cols, IPP_TAG_JOB);
+ cupsFreeOptions(num_cols, cols);
+ break;
+
+ default :
+ ippSetString(ipp, &attr, i, val);
+ break;
+ }
+ }
+
+ if (copy)
+ free(copy);
+
+ return (attr);
+}
+
+
+/*
+ * 'cupsEncodeOption()' - Encode a single option into an IPP attribute.
+ *
+ * @since CUPS 2.3/macOS 10.14@
+ */
+
+ipp_attribute_t * /* O - New attribute or @code NULL@ on error */
+cupsEncodeOption(ipp_t *ipp, /* I - IPP request/response */
+ ipp_tag_t group_tag, /* I - Attribute group */
+ const char *name, /* I - Option name */
+ const char *value) /* I - Option string value */
+{
+ return (_cupsEncodeOption(ipp, group_tag, _ippFindOption(name), name, value));
+}
+
+
/*
* 'cupsEncodeOptions()' - Encode printer options into IPP attributes.
*
@@ -334,7 +695,7 @@ static int compare_ipp_options(_ipp_option_t *a, _ipp_option_t *b);
*/
void
-cupsEncodeOptions(ipp_t *ipp, /* I - Request to add to */
+cupsEncodeOptions(ipp_t *ipp, /* I - IPP request/response */
int num_options, /* I - Number of options */
cups_option_t *options) /* I - Options */
{
@@ -362,24 +723,14 @@ cupsEncodeOptions(ipp_t *ipp, /* I - Request to add to */
void
cupsEncodeOptions2(
- ipp_t *ipp, /* I - Request to add to */
+ ipp_t *ipp, /* I - IPP request/response */
int num_options, /* I - Number of options */
cups_option_t *options, /* I - Options */
ipp_tag_t group_tag) /* I - Group to encode */
{
- int i, j; /* Looping vars */
- int count; /* Number of values */
- char *s, /* Pointer into option value */
- *val, /* Pointer to option value */
- *copy, /* Copy of option value */
- *sep, /* Option separator */
- quote; /* Quote character */
- ipp_attribute_t *attr; /* IPP attribute */
- ipp_tag_t value_tag; /* IPP value tag */
+ int i; /* Looping var */
+ char *val; /* Pointer to option value */
cups_option_t *option; /* Current option */
- ipp_t *collection; /* Collection value */
- int num_cols; /* Number of collection values */
- cups_option_t *cols; /* Collection values */
ipp_op_t op; /* Operation for this request */
const ipp_op_t *ops; /* List of allowed operations */
@@ -399,24 +750,18 @@ cupsEncodeOptions2(
op = ippGetOperation(ipp);
- if (group_tag == IPP_TAG_OPERATION &&
- (op == IPP_OP_PRINT_JOB || op == IPP_OP_PRINT_URI ||
- op == IPP_OP_SEND_DOCUMENT || op == IPP_OP_SEND_URI))
+ if (group_tag == IPP_TAG_OPERATION && (op == IPP_OP_PRINT_JOB || op == IPP_OP_PRINT_URI || op == IPP_OP_SEND_DOCUMENT || op == IPP_OP_SEND_URI))
{
/*
* Handle the document format stuff first...
*/
- if ((val = (char *)cupsGetOption("document-format", num_options,
- options)) != NULL)
- ippAddString(ipp, IPP_TAG_OPERATION, IPP_TAG_MIMETYPE, "document-format",
- NULL, val);
+ if ((val = (char *)cupsGetOption("document-format", num_options, options)) != NULL)
+ ippAddString(ipp, IPP_TAG_OPERATION, IPP_TAG_MIMETYPE, "document-format", NULL, val);
else if (cupsGetOption("raw", num_options, options))
- ippAddString(ipp, IPP_TAG_OPERATION, IPP_TAG_MIMETYPE, "document-format",
- NULL, "application/vnd.cups-raw");
+ ippAddString(ipp, IPP_TAG_OPERATION, IPP_TAG_MIMETYPE, "document-format", NULL, "application/vnd.cups-raw");
else
- ippAddString(ipp, IPP_TAG_OPERATION, IPP_TAG_MIMETYPE, "document-format",
- NULL, "application/octet-stream");
+ ippAddString(ipp, IPP_TAG_OPERATION, IPP_TAG_MIMETYPE, "document-format", NULL, "application/octet-stream");
}
/*
@@ -427,14 +772,11 @@ cupsEncodeOptions2(
{
_ipp_option_t *match; /* Matching attribute */
-
/*
* Skip document format options that are handled above...
*/
- if (!_cups_strcasecmp(option->name, "raw") ||
- !_cups_strcasecmp(option->name, "document-format") ||
- !option->name[0])
+ if (!_cups_strcasecmp(option->name, "raw") || !_cups_strcasecmp(option->name, "document-format") || !option->name[0])
continue;
/*
@@ -446,8 +788,6 @@ cupsEncodeOptions2(
if (match->group_tag != group_tag && match->alt_group_tag != group_tag)
continue;
- value_tag = match->value_tag;
-
if (match->operations)
ops = match->operations;
else if (group_tag == IPP_TAG_JOB)
@@ -468,12 +808,9 @@ cupsEncodeOptions2(
{
int namelen; /* Length of name */
-
namelen = (int)strlen(option->name);
- if (namelen < 10 ||
- (strcmp(option->name + namelen - 8, "-default") &&
- strcmp(option->name + namelen - 10, "-supported")))
+ if (namelen < 10 || (strcmp(option->name + namelen - 8, "-default") && strcmp(option->name + namelen - 10, "-supported")))
{
if (group_tag != IPP_TAG_JOB && group_tag != IPP_TAG_DOCUMENT)
{
@@ -493,12 +830,6 @@ cupsEncodeOptions2(
ops = ipp_doc_creation;
else
ops = ipp_set_printer;
-
- if (!_cups_strcasecmp(option->value, "true") ||
- !_cups_strcasecmp(option->value, "false"))
- value_tag = IPP_TAG_BOOLEAN;
- else
- value_tag = IPP_TAG_NAME;
}
/*
@@ -517,277 +848,7 @@ cupsEncodeOptions2(
continue;
}
- /*
- * Count the number of values...
- */
-
- if (match && match->multivalue)
- {
- for (count = 1, sep = option->value, quote = 0; *sep; sep ++)
- {
- if (*sep == quote)
- quote = 0;
- else if (!quote && (*sep == '\'' || *sep == '\"'))
- {
- /*
- * Skip quoted option value...
- */
-
- quote = *sep++;
- }
- else if (*sep == ',' && !quote)
- count ++;
- else if (*sep == '\\' && sep[1])
- sep += 2;
- }
- }
- else
- count = 1;
-
- DEBUG_printf(("2cupsEncodeOptions2: option=\"%s\", value=\"%s\", count=%d", option->name, option->value, count));
-
- /*
- * Allocate memory for the attribute values...
- */
-
- if ((attr = ippAddStrings(ipp, group_tag, value_tag, option->name, count,
- NULL, NULL)) == NULL)
- {
- /*
- * Ran out of memory!
- */
-
- DEBUG_puts("1cupsEncodeOptions2: Ran out of memory for attributes!");
- return;
- }
-
- if (count > 1)
- {
- /*
- * Make a copy of the value we can fiddle with...
- */
-
- if ((copy = strdup(option->value)) == NULL)
- {
- /*
- * Ran out of memory!
- */
-
- DEBUG_puts("1cupsEncodeOptions2: Ran out of memory for value copy!");
- ippDeleteAttribute(ipp, attr);
- return;
- }
-
- val = copy;
- }
- else
- {
- /*
- * Since we have a single value, use the value directly...
- */
-
- val = option->value;
- copy = NULL;
- }
-
- /*
- * Scan the value string for values...
- */
-
- for (j = 0, sep = val; j < count; val = sep, j ++)
- {
- /*
- * Find the end of this value and mark it if needed...
- */
-
- if (count > 1)
- {
- for (quote = 0; *sep; sep ++)
- {
- if (*sep == quote)
- {
- /*
- * Finish quoted value...
- */
-
- quote = 0;
- }
- else if (!quote && (*sep == '\'' || *sep == '\"'))
- {
- /*
- * Handle quoted option value...
- */
-
- quote = *sep;
- }
- else if (*sep == ',' && count > 1)
- break;
- else if (*sep == '\\' && sep[1])
- {
- /*
- * Skip quoted character...
- */
-
- memmove(sep, sep + 1, strlen(sep));
- sep ++;
- }
- }
-
- if (*sep == ',')
- *sep++ = '\0';
- }
-
- /*
- * Copy the option value(s) over as needed by the type...
- */
-
- switch (attr->value_tag)
- {
- case IPP_TAG_INTEGER :
- case IPP_TAG_ENUM :
- /*
- * Integer/enumeration value...
- */
-
- attr->values[j].integer = (int)strtol(val, &s, 10);
-
- DEBUG_printf(("2cupsEncodeOptions2: Added integer option value "
- "%d...", attr->values[j].integer));
- break;
-
- case IPP_TAG_BOOLEAN :
- if (!_cups_strcasecmp(val, "true") ||
- !_cups_strcasecmp(val, "on") ||
- !_cups_strcasecmp(val, "yes"))
- {
- /*
- * Boolean value - true...
- */
-
- attr->values[j].boolean = 1;
-
- DEBUG_puts("2cupsEncodeOptions2: Added boolean true value...");
- }
- else
- {
- /*
- * Boolean value - false...
- */
-
- attr->values[j].boolean = 0;
-
- DEBUG_puts("2cupsEncodeOptions2: Added boolean false value...");
- }
- break;
-
- case IPP_TAG_RANGE :
- /*
- * Range...
- */
-
- if (*val == '-')
- {
- attr->values[j].range.lower = 1;
- s = val;
- }
- else
- attr->values[j].range.lower = (int)strtol(val, &s, 10);
-
- if (*s == '-')
- {
- if (s[1])
- attr->values[j].range.upper = (int)strtol(s + 1, NULL, 10);
- else
- attr->values[j].range.upper = 2147483647;
- }
- else
- attr->values[j].range.upper = attr->values[j].range.lower;
-
- DEBUG_printf(("2cupsEncodeOptions2: Added range option value "
- "%d-%d...", attr->values[j].range.lower,
- attr->values[j].range.upper));
- break;
-
- case IPP_TAG_RESOLUTION :
- /*
- * Resolution...
- */
-
- attr->values[j].resolution.xres = (int)strtol(val, &s, 10);
-
- if (*s == 'x')
- attr->values[j].resolution.yres = (int)strtol(s + 1, &s, 10);
- else
- attr->values[j].resolution.yres = attr->values[j].resolution.xres;
-
- if (!_cups_strcasecmp(s, "dpc") ||
- !_cups_strcasecmp(s, "dpcm"))
- attr->values[j].resolution.units = IPP_RES_PER_CM;
- else
- attr->values[j].resolution.units = IPP_RES_PER_INCH;
-
- DEBUG_printf(("2cupsEncodeOptions2: Added resolution option value "
- "%s...", val));
- break;
-
- case IPP_TAG_STRING :
- /*
- * octet-string
- */
-
- attr->values[j].unknown.length = (int)strlen(val);
- attr->values[j].unknown.data = strdup(val);
-
- DEBUG_printf(("2cupsEncodeOptions2: Added octet-string value "
- "\"%s\"...", (char *)attr->values[j].unknown.data));
- break;
-
- case IPP_TAG_BEGIN_COLLECTION :
- /*
- * Collection value
- */
-
- num_cols = cupsParseOptions(val, 0, &cols);
- if ((collection = ippNew()) == NULL)
- {
- cupsFreeOptions(num_cols, cols);
-
- if (copy)
- free(copy);
-
- ippDeleteAttribute(ipp, attr);
- return;
- }
-
- attr->values[j].collection = collection;
- cupsEncodeOptions2(collection, num_cols, cols, IPP_TAG_JOB);
- cupsFreeOptions(num_cols, cols);
- break;
-
- default :
- if ((attr->values[j].string.text = _cupsStrAlloc(val)) == NULL)
- {
- /*
- * Ran out of memory!
- */
-
- DEBUG_puts("1cupsEncodeOptions2: Ran out of memory for string!");
-
- if (copy)
- free(copy);
-
- ippDeleteAttribute(ipp, attr);
- return;
- }
-
- DEBUG_printf(("2cupsEncodeOptions2: Added string value \"%s\"...",
- val));
- break;
- }
- }
-
- if (copy)
- free(copy);
+ _cupsEncodeOption(ipp, group_tag, match, option->name, option->value);
}
}
diff --git a/cups/file-private.h b/cups/file-private.h
index 1f4db79..bb6f213 100644
--- a/cups/file-private.h
+++ b/cups/file-private.h
@@ -6,16 +6,11 @@
* our own file functions allows us to provide transparent support of
* different line endings, gzip'd print files, PPD files, etc.
*
- * Copyright 2007-2017 by Apple Inc.
- * Copyright 1997-2007 by Easy Software Products, all rights reserved.
+ * Copyright © 2007-2018 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.
+ * Licensed under Apache License v2.0. See the file "LICENSE" for more
+ * information.
*/
#ifndef _CUPS_FILE_PRIVATE_H_
@@ -31,13 +26,10 @@
# include
# include
-# ifdef HAVE_LIBZ
-# include
-# endif /* HAVE_LIBZ */
-# ifdef WIN32
+# ifdef _WIN32
# include
# include
-# endif /* WIN32 */
+# endif /* _WIN32 */
/*
@@ -88,43 +80,13 @@ typedef enum /**** _cupsFileCheck file type values ****/
typedef void (*_cups_fc_func_t)(void *context, _cups_fc_result_t result,
const char *message);
-struct _cups_file_s /**** CUPS file structure... ****/
-
-{
- int fd; /* File descriptor */
- char mode, /* Mode ('r' or 'w') */
- compressed, /* Compression used? */
- is_stdio, /* stdin/out/err? */
- eof, /* End of file? */
- buf[4096], /* Buffer */
- *ptr, /* Pointer into buffer */
- *end; /* End of buffer data */
- off_t pos, /* Position in file */
- bufpos; /* File position for start of buffer */
-
-#ifdef HAVE_LIBZ
- z_stream stream; /* (De)compression stream */
- Bytef cbuf[4096]; /* (De)compression buffer */
- uLong crc; /* (De)compression CRC */
-#endif /* HAVE_LIBZ */
-
- char *printf_buffer; /* cupsFilePrintf buffer */
- size_t printf_size; /* Size of cupsFilePrintf buffer */
-};
-
-
/*
* Prototypes...
*/
-extern _cups_fc_result_t _cupsFileCheck(const char *filename,
- _cups_fc_filetype_t filetype,
- int dorootchecks,
- _cups_fc_func_t cb,
- void *context);
-extern void _cupsFileCheckFilter(void *context,
- _cups_fc_result_t result,
- const char *message);
+extern _cups_fc_result_t _cupsFileCheck(const char *filename, _cups_fc_filetype_t filetype, int dorootchecks, _cups_fc_func_t cb, void *context) _CUPS_PRIVATE;
+extern void _cupsFileCheckFilter(void *context, _cups_fc_result_t result, const char *message) _CUPS_PRIVATE;
+extern int _cupsFilePeekAhead(cups_file_t *fp, int ch);
# ifdef __cplusplus
}
diff --git a/cups/file.c b/cups/file.c
index 8cdf036..e6e1f5b 100644
--- a/cups/file.c
+++ b/cups/file.c
@@ -6,16 +6,11 @@
* our own file functions allows us to provide transparent support of
* different line endings, gzip'd print files, PPD files, etc.
*
- * Copyright 2007-2017 by Apple Inc.
- * Copyright 1997-2007 by Easy Software Products, all rights reserved.
+ * Copyright © 2007-2019 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.
+ * Licensed under Apache License v2.0. See the file "LICENSE" for more
+ * information.
*/
/*
@@ -23,9 +18,43 @@
*/
#include "file-private.h"
+#include "debug-internal.h"
#include
#include
+# ifdef HAVE_LIBZ
+# include
+# endif /* HAVE_LIBZ */
+
+
+/*
+ * Internal structures...
+ */
+
+struct _cups_file_s /**** CUPS file structure... ****/
+
+{
+ int fd; /* File descriptor */
+ char mode, /* Mode ('r' or 'w') */
+ compressed, /* Compression used? */
+ is_stdio, /* stdin/out/err? */
+ eof, /* End of file? */
+ buf[4096], /* Buffer */
+ *ptr, /* Pointer into buffer */
+ *end; /* End of buffer data */
+ off_t pos, /* Position in file */
+ bufpos; /* File position for start of buffer */
+
+#ifdef HAVE_LIBZ
+ z_stream stream; /* (De)compression stream */
+ Bytef cbuf[4096]; /* (De)compression buffer */
+ uLong crc; /* (De)compression CRC */
+#endif /* HAVE_LIBZ */
+
+ char *printf_buffer; /* cupsFilePrintf buffer */
+ size_t printf_size; /* Size of cupsFilePrintf buffer */
+};
+
/*
* Local functions...
@@ -40,7 +69,7 @@ static ssize_t cups_read(cups_file_t *fp, char *buf, size_t bytes);
static ssize_t cups_write(cups_file_t *fp, const char *buf, size_t bytes);
-#ifndef WIN32
+#ifndef _WIN32
/*
* '_cupsFileCheck()' - Check the permissions of the given filename.
*/
@@ -306,7 +335,7 @@ _cupsFileCheckFilter(
fprintf(stderr, "%s: %s\n", prefix, message);
}
-#endif /* !WIN32 */
+#endif /* !_WIN32 */
/*
@@ -526,22 +555,22 @@ cupsFileFind(const char *filename, /* I - File to find */
while (*path)
{
-#ifdef WIN32
+#ifdef _WIN32
if (*path == ';' || (*path == ':' && ((bufptr - buffer) > 1 || !isalpha(buffer[0] & 255))))
#else
if (*path == ';' || *path == ':')
-#endif /* WIN32 */
+#endif /* _WIN32 */
{
if (bufptr > buffer && bufptr[-1] != '/' && bufptr < bufend)
*bufptr++ = '/';
strlcpy(bufptr, filename, (size_t)(bufend - bufptr));
-#ifdef WIN32
+#ifdef _WIN32
if (!access(buffer, 0))
#else
if (!access(buffer, executable ? X_OK : 0))
-#endif /* WIN32 */
+#endif /* _WIN32 */
{
DEBUG_printf(("1cupsFileFind: Returning \"%s\"", buffer));
return (buffer);
@@ -646,6 +675,12 @@ cupsFileGetChar(cups_file_t *fp) /* I - CUPS file */
return (-1);
}
+ if (fp->eof)
+ {
+ DEBUG_puts("5cupsFileGetChar: End-of-file!");
+ return (-1);
+ }
+
/*
* If the input buffer is empty, try to read more data...
*/
@@ -992,11 +1027,11 @@ cupsFileLock(cups_file_t *fp, /* I - CUPS file */
* Try the lock...
*/
-#ifdef WIN32
+#ifdef _WIN32
return (_locking(fp->fd, block ? _LK_LOCK : _LK_NBLCK, 0));
#else
return (lockf(fp->fd, block ? F_LOCK : F_TLOCK, 0));
-#endif /* WIN32 */
+#endif /* _WIN32 */
}
@@ -1084,11 +1119,11 @@ cupsFileOpen(const char *filename, /* I - Name of file */
}
if (fd >= 0)
-#ifdef WIN32
+#ifdef _WIN32
_chsize(fd, 0);
#else
ftruncate(fd, 0);
-#endif /* WIN32 */
+#endif /* _WIN32 */
break;
case 's' : /* Read/write socket */
@@ -1255,14 +1290,26 @@ cupsFileOpenFd(int fd, /* I - File descriptor */
* Don't pass this file to child processes...
*/
-#ifndef WIN32
+#ifndef _WIN32
fcntl(fp->fd, F_SETFD, fcntl(fp->fd, F_GETFD) | FD_CLOEXEC);
-#endif /* !WIN32 */
+#endif /* !_WIN32 */
return (fp);
}
+/*
+ * '_cupsFilePeekAhead()' - See if the requested character is buffered up.
+ */
+
+int /* O - 1 if present, 0 otherwise */
+_cupsFilePeekAhead(cups_file_t *fp, /* I - CUPS file */
+ int ch) /* I - Character */
+{
+ return (fp && fp->ptr && memchr(fp->ptr, ch, (size_t)(fp->end - fp->ptr)));
+}
+
+
/*
* 'cupsFilePeekChar()' - Peek at the next character from a file.
*
@@ -1606,6 +1653,12 @@ cupsFileRead(cups_file_t *fp, /* I - CUPS file */
if (bytes == 0)
return (0);
+ if (fp->eof)
+ {
+ DEBUG_puts("5cupsFileRead: End-of-file!");
+ return (-1);
+ }
+
/*
* Loop until all bytes are read...
*/
@@ -2019,11 +2072,11 @@ cupsFileUnlock(cups_file_t *fp) /* I - CUPS file */
* Unlock...
*/
-#ifdef WIN32
+#ifdef _WIN32
return (_locking(fp->fd, _LK_UNLCK, 0));
#else
return (lockf(fp->fd, F_ULOCK, 0));
-#endif /* WIN32 */
+#endif /* _WIN32 */
}
@@ -2477,6 +2530,8 @@ cups_fill(cups_file_t *fp) /* I - CUPS file */
* file header...
*/
+ inflateEnd(&fp->stream);
+
fp->compressed = 0;
}
else if (status < Z_OK)
@@ -2551,9 +2606,9 @@ cups_open(const char *filename, /* I - Filename */
{
int fd; /* File descriptor */
struct stat fileinfo; /* File information */
-#ifndef WIN32
+#ifndef _WIN32
struct stat linkinfo; /* Link information */
-#endif /* !WIN32 */
+#endif /* !_WIN32 */
/*
@@ -2581,18 +2636,18 @@ cups_open(const char *filename, /* I - Filename */
return (-1);
}
-#ifdef WIN32
+#ifdef _WIN32
if (fileinfo.st_mode & _S_IFDIR)
#else
if (S_ISDIR(fileinfo.st_mode))
-#endif /* WIN32 */
+#endif /* _WIN32 */
{
close(fd);
errno = EISDIR;
return (-1);
}
-#ifndef WIN32
+#ifndef _WIN32
/*
* Then use lstat to determine whether the filename is a symlink...
*/
@@ -2620,7 +2675,7 @@ cups_open(const char *filename, /* I - Filename */
errno = EPERM;
return (-1);
}
-#endif /* !WIN32 */
+#endif /* !_WIN32 */
return (fd);
}
@@ -2646,7 +2701,7 @@ cups_read(cups_file_t *fp, /* I - CUPS file */
for (;;)
{
-#ifdef WIN32
+#ifdef _WIN32
if (fp->mode == 's')
total = (ssize_t)recv(fp->fd, buf, (unsigned)bytes, 0);
else
@@ -2656,7 +2711,7 @@ cups_read(cups_file_t *fp, /* I - CUPS file */
total = recv(fp->fd, buf, bytes, 0);
else
total = read(fp->fd, buf, bytes);
-#endif /* WIN32 */
+#endif /* _WIN32 */
DEBUG_printf(("9cups_read: total=" CUPS_LLFMT, CUPS_LLCAST total));
@@ -2703,7 +2758,7 @@ cups_write(cups_file_t *fp, /* I - CUPS file */
total = 0;
while (bytes > 0)
{
-#ifdef WIN32
+#ifdef _WIN32
if (fp->mode == 's')
count = (ssize_t)send(fp->fd, buf, (unsigned)bytes, 0);
else
@@ -2713,7 +2768,7 @@ cups_write(cups_file_t *fp, /* I - CUPS file */
count = send(fp->fd, buf, bytes, 0);
else
count = write(fp->fd, buf, bytes);
-#endif /* WIN32 */
+#endif /* _WIN32 */
DEBUG_printf(("9cups_write: count=" CUPS_LLFMT, CUPS_LLCAST count));
diff --git a/cups/file.h b/cups/file.h
index 42abe20..49ca58a 100644
--- a/cups/file.h
+++ b/cups/file.h
@@ -6,16 +6,11 @@
* our own file functions allows us to provide transparent support of
* different line endings, gzip'd print files, PPD files, etc.
*
- * Copyright 2007-2017 by Apple Inc.
- * Copyright 1997-2007 by Easy Software Products, all rights reserved.
+ * Copyright © 2007-2018 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.
+ * Licensed under Apache License v2.0. See the file "LICENSE" for more
+ * information.
*/
#ifndef _CUPS_FILE_H_
@@ -29,11 +24,11 @@
# include "versioning.h"
# include
# include
-# if defined(WIN32) && !defined(__CUPS_SSIZE_T_DEFINED)
+# if defined(_WIN32) && !defined(__CUPS_SSIZE_T_DEFINED)
# define __CUPS_SSIZE_T_DEFINED
/* Windows does not support the ssize_t type, so map it to off_t... */
typedef off_t ssize_t; /* @private@ */
-# endif /* WIN32 && !__CUPS_SSIZE_T_DEFINED */
+# endif /* _WIN32 && !__CUPS_SSIZE_T_DEFINED */
/*
@@ -67,34 +62,22 @@ typedef struct _cups_file_s cups_file_t;/**** CUPS file type ****/
extern int cupsFileClose(cups_file_t *fp) _CUPS_API_1_2;
extern int cupsFileCompression(cups_file_t *fp) _CUPS_API_1_2;
extern int cupsFileEOF(cups_file_t *fp) _CUPS_API_1_2;
-extern const char *cupsFileFind(const char *filename, const char *path,
- int executable, char *buffer,
- int bufsize) _CUPS_API_1_2;
+extern const char *cupsFileFind(const char *filename, const char *path, int executable, char *buffer, int bufsize) _CUPS_API_1_2;
extern int cupsFileFlush(cups_file_t *fp) _CUPS_API_1_2;
extern int cupsFileGetChar(cups_file_t *fp) _CUPS_API_1_2;
-extern char *cupsFileGetConf(cups_file_t *fp, char *buf,
- size_t buflen, char **value,
- int *linenum) _CUPS_API_1_2;
-extern size_t cupsFileGetLine(cups_file_t *fp, char *buf,
- size_t buflen) _CUPS_API_1_2;
-extern char *cupsFileGets(cups_file_t *fp, char *buf, size_t buflen)
- _CUPS_API_1_2;
+extern char *cupsFileGetConf(cups_file_t *fp, char *buf, size_t buflen, char **value, int *linenum) _CUPS_API_1_2;
+extern size_t cupsFileGetLine(cups_file_t *fp, char *buf, size_t buflen) _CUPS_API_1_2;
+extern char *cupsFileGets(cups_file_t *fp, char *buf, size_t buflen) _CUPS_API_1_2;
extern int cupsFileLock(cups_file_t *fp, int block) _CUPS_API_1_2;
extern int cupsFileNumber(cups_file_t *fp) _CUPS_API_1_2;
-extern cups_file_t *cupsFileOpen(const char *filename, const char *mode)
- _CUPS_API_1_2;
+extern cups_file_t *cupsFileOpen(const char *filename, const char *mode) _CUPS_API_1_2;
extern cups_file_t *cupsFileOpenFd(int fd, const char *mode) _CUPS_API_1_2;
extern int cupsFilePeekChar(cups_file_t *fp) _CUPS_API_1_2;
-extern int cupsFilePrintf(cups_file_t *fp, const char *format, ...)
- __attribute__((__format__ (__printf__, 2, 3)))
- _CUPS_API_1_2;
+extern int cupsFilePrintf(cups_file_t *fp, const char *format, ...) _CUPS_FORMAT(2, 3) _CUPS_API_1_2;
extern int cupsFilePutChar(cups_file_t *fp, int c) _CUPS_API_1_2;
-extern ssize_t cupsFilePutConf(cups_file_t *fp, const char *directive,
- const char *value) _CUPS_API_1_4;
-extern int cupsFilePuts(cups_file_t *fp, const char *s)
- _CUPS_API_1_2;
-extern ssize_t cupsFileRead(cups_file_t *fp, char *buf, size_t bytes)
- _CUPS_API_1_2;
+extern ssize_t cupsFilePutConf(cups_file_t *fp, const char *directive, const char *value) _CUPS_API_1_4;
+extern int cupsFilePuts(cups_file_t *fp, const char *s) _CUPS_API_1_2;
+extern ssize_t cupsFileRead(cups_file_t *fp, char *buf, size_t bytes) _CUPS_API_1_2;
extern off_t cupsFileRewind(cups_file_t *fp) _CUPS_API_1_2;
extern off_t cupsFileSeek(cups_file_t *fp, off_t pos) _CUPS_API_1_2;
extern cups_file_t *cupsFileStderr(void) _CUPS_API_1_2;
@@ -102,8 +85,7 @@ extern cups_file_t *cupsFileStdin(void) _CUPS_API_1_2;
extern cups_file_t *cupsFileStdout(void) _CUPS_API_1_2;
extern off_t cupsFileTell(cups_file_t *fp) _CUPS_API_1_2;
extern int cupsFileUnlock(cups_file_t *fp) _CUPS_API_1_2;
-extern ssize_t cupsFileWrite(cups_file_t *fp, const char *buf,
- size_t bytes) _CUPS_API_1_2;
+extern ssize_t cupsFileWrite(cups_file_t *fp, const char *buf, size_t bytes) _CUPS_API_1_2;
# ifdef __cplusplus
diff --git a/cups/getdevices.c b/cups/getdevices.c
index 0f303ba..de2186f 100644
--- a/cups/getdevices.c
+++ b/cups/getdevices.c
@@ -3,13 +3,7 @@
*
* Copyright 2008-2016 by Apple Inc.
*
- * 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.
+ * Licensed under Apache License v2.0. See the file "LICENSE" for more information.
*/
/*
@@ -17,6 +11,7 @@
*/
#include "cups-private.h"
+#include "debug-internal.h"
#include "adminutil.h"
@@ -29,7 +24,10 @@
* parameters provide comma-delimited lists of backends to include or omit from
* the request respectively.
*
- * @since CUPS 1.4/macOS 10.6@
+ * This function is deprecated with the IPP printer discovery functionality
+ * being provided by the @link cupsEnumDests@ and @cupsGetDests@ functions.
+ *
+ * @deprecated@
*/
ipp_status_t /* O - Request status - @code IPP_OK@ on success. */
diff --git a/cups/getifaddrs-internal.h b/cups/getifaddrs-internal.h
new file mode 100644
index 0000000..35e98be
--- /dev/null
+++ b/cups/getifaddrs-internal.h
@@ -0,0 +1,113 @@
+/*
+ * getifaddrs definitions for CUPS.
+ *
+ * Copyright 2007-2018 by Apple Inc.
+ * Copyright 1997-2007 by Easy Software Products, all rights reserved.
+ *
+ * Licensed under Apache License v2.0. See the file "LICENSE" for more
+ * information.
+ */
+
+#ifndef _CUPS_GETIFADDRS_INTERNAL_H_
+# define _CUPS_GETIFADDRS_INTERNAL_H_
+
+/*
+ * Include necessary headers...
+ */
+
+# include "config.h"
+# ifdef _WIN32
+# define _WINSOCK_DEPRECATED_NO_WARNINGS 1
+# include
+# include
+# define CUPS_SOCAST (const char *)
+# else
+# include
+# include
+# include
+# define CUPS_SOCAST
+# endif /* _WIN32 */
+
+# if defined(__APPLE__) && !defined(_SOCKLEN_T)
+/*
+ * macOS 10.2.x does not define socklen_t, and in fact uses an int instead of
+ * unsigned type for length values...
+ */
+
+typedef int socklen_t;
+# endif /* __APPLE__ && !_SOCKLEN_T */
+
+# ifndef _WIN32
+# include
+# include
+# ifdef HAVE_GETIFADDRS
+# include
+# else
+# include
+# ifdef HAVE_SYS_SOCKIO_H
+# include
+# endif /* HAVE_SYS_SOCKIO_H */
+# endif /* HAVE_GETIFADDRS */
+# endif /* !_WIN32 */
+
+
+/*
+ * C++ magic...
+ */
+
+# ifdef __cplusplus
+extern "C" {
+# endif /* __cplusplus */
+
+
+/*
+ * Some OS's don't have getifaddrs() and freeifaddrs()...
+ */
+
+# if !defined(_WIN32) && !defined(HAVE_GETIFADDRS)
+# ifdef ifa_dstaddr
+# undef ifa_dstaddr
+# endif /* ifa_dstaddr */
+# ifndef ifr_netmask
+# define ifr_netmask ifr_addr
+# endif /* !ifr_netmask */
+
+struct ifaddrs /**** Interface Structure ****/
+{
+ struct ifaddrs *ifa_next; /* Next interface in list */
+ char *ifa_name; /* Name of interface */
+ unsigned int ifa_flags; /* Flags (up, point-to-point, etc.) */
+ struct sockaddr *ifa_addr, /* Network address */
+ *ifa_netmask; /* Address mask */
+ union
+ {
+ struct sockaddr *ifu_broadaddr; /* Broadcast address of this interface. */
+ struct sockaddr *ifu_dstaddr; /* Point-to-point destination address. */
+ } ifa_ifu;
+
+ void *ifa_data; /* Interface statistics */
+};
+
+# ifndef ifa_broadaddr
+# define ifa_broadaddr ifa_ifu.ifu_broadaddr
+# endif /* !ifa_broadaddr */
+# ifndef ifa_dstaddr
+# define ifa_dstaddr ifa_ifu.ifu_dstaddr
+# endif /* !ifa_dstaddr */
+
+extern int _cups_getifaddrs(struct ifaddrs **addrs) _CUPS_PRIVATE;
+# define getifaddrs _cups_getifaddrs
+extern void _cups_freeifaddrs(struct ifaddrs *addrs) _CUPS_PRIVATE;
+# define freeifaddrs _cups_freeifaddrs
+# endif /* !_WIN32 && !HAVE_GETIFADDRS */
+
+
+/*
+ * C++ magic...
+ */
+
+# ifdef __cplusplus
+}
+# endif /* __cplusplus */
+
+#endif /* !_CUPS_GETIFADDRS_INTERNAL_H_ */
diff --git a/cups/getifaddrs.c b/cups/getifaddrs.c
index 82653a9..f751aa8 100644
--- a/cups/getifaddrs.c
+++ b/cups/getifaddrs.c
@@ -1,21 +1,18 @@
/*
* Network interface functions for CUPS.
*
- * Copyright 2007-2010 by Apple Inc.
- * Copyright 1997-2006 by Easy Software Products, all rights reserved.
+ * Copyright © 2007-2018 by Apple Inc.
+ * Copyright © 1997-2006 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"
- * "LICENSE" which should have been included with this file. If this
- * file is missing or damaged, see the license at "http://www.cups.org/".
+ * Licensed under Apache License v2.0. See the file "LICENSE" for more
+ * information.
*/
/*
* Include necessary headers.
*/
-#include "http-private.h"
+#include "getifaddrs-internal.h"
#ifndef HAVE_GETIFADDRS
diff --git a/cups/getputfile.c b/cups/getputfile.c
index ae33bc5..818d5e9 100644
--- a/cups/getputfile.c
+++ b/cups/getputfile.c
@@ -1,16 +1,11 @@
/*
* Get/put file functions for CUPS.
*
- * Copyright 2007-2014 by Apple Inc.
+ * Copyright 2007-2018 by Apple Inc.
* Copyright 1997-2006 by Easy Software Products.
*
- * 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.
+ * Licensed under Apache License v2.0. See the file "LICENSE" for more
+ * information.
*/
/*
@@ -18,13 +13,14 @@
*/
#include "cups-private.h"
+#include "debug-internal.h"
#include
#include
-#if defined(WIN32) || defined(__EMX__)
+#if defined(_WIN32) || defined(__EMX__)
# include
#else
# include
-#endif /* WIN32 || __EMX__ */
+#endif /* _WIN32 || __EMX__ */
/*
@@ -45,6 +41,8 @@ cupsGetFd(http_t *http, /* I - Connection to server or @code CUPS_HTTP_DEFA
http_status_t status; /* HTTP status from server */
char if_modified_since[HTTP_MAX_VALUE];
/* If-Modified-Since header */
+ int new_auth = 0; /* Using new auth information? */
+ int digest; /* Are we using Digest authentication? */
/*
@@ -85,9 +83,33 @@ cupsGetFd(http_t *http, /* I - Connection to server or @code CUPS_HTTP_DEFA
}
httpClearFields(http);
- httpSetField(http, HTTP_FIELD_AUTHORIZATION, http->authstring);
httpSetField(http, HTTP_FIELD_IF_MODIFIED_SINCE, if_modified_since);
+ digest = http->authstring && !strncmp(http->authstring, "Digest ", 7);
+
+ if (digest && !new_auth)
+ {
+ /*
+ * Update the Digest authentication string...
+ */
+
+ _httpSetDigestAuthString(http, http->nextnonce, "GET", resource);
+ }
+
+#ifdef HAVE_GSSAPI
+ if (http->authstring && !strncmp(http->authstring, "Negotiate", 9) && !new_auth)
+ {
+ /*
+ * Do not use cached Kerberos credentials since they will look like a
+ * "replay" attack...
+ */
+
+ _cupsSetNegotiateAuthString(http, "GET", resource);
+ }
+#endif /* HAVE_GSSAPI */
+
+ httpSetField(http, HTTP_FIELD_AUTHORIZATION, http->authstring);
+
if (httpGet(http, resource))
{
if (httpReconnect2(http, 30000, NULL))
@@ -102,6 +124,8 @@ cupsGetFd(http_t *http, /* I - Connection to server or @code CUPS_HTTP_DEFA
}
}
+ new_auth = 0;
+
while ((status = httpUpdate(http)) == HTTP_STATUS_CONTINUE);
if (status == HTTP_STATUS_UNAUTHORIZED)
@@ -116,6 +140,8 @@ cupsGetFd(http_t *http, /* I - Connection to server or @code CUPS_HTTP_DEFA
* See if we can do authentication...
*/
+ new_auth = 1;
+
if (cupsDoAuthentication(http, "GET", resource))
{
status = HTTP_STATUS_CUPS_AUTHORIZATION_CANCELED;
@@ -267,6 +293,8 @@ cupsPutFd(http_t *http, /* I - Connection to server or @code CUPS_HTTP_DEFA
int retries; /* Number of retries */
char buffer[8192]; /* Buffer for file */
http_status_t status; /* HTTP status from server */
+ int new_auth = 0; /* Using new auth information? */
+ int digest; /* Are we using Digest authentication? */
/*
@@ -309,10 +337,34 @@ cupsPutFd(http_t *http, /* I - Connection to server or @code CUPS_HTTP_DEFA
http->authstring));
httpClearFields(http);
- httpSetField(http, HTTP_FIELD_AUTHORIZATION, http->authstring);
httpSetField(http, HTTP_FIELD_TRANSFER_ENCODING, "chunked");
httpSetExpect(http, HTTP_STATUS_CONTINUE);
+ digest = http->authstring && !strncmp(http->authstring, "Digest ", 7);
+
+ if (digest && !new_auth)
+ {
+ /*
+ * Update the Digest authentication string...
+ */
+
+ _httpSetDigestAuthString(http, http->nextnonce, "PUT", resource);
+ }
+
+#ifdef HAVE_GSSAPI
+ if (http->authstring && !strncmp(http->authstring, "Negotiate", 9) && !new_auth)
+ {
+ /*
+ * Do not use cached Kerberos credentials since they will look like a
+ * "replay" attack...
+ */
+
+ _cupsSetNegotiateAuthString(http, "PUT", resource);
+ }
+#endif /* HAVE_GSSAPI */
+
+ httpSetField(http, HTTP_FIELD_AUTHORIZATION, http->authstring);
+
if (httpPut(http, resource))
{
if (httpReconnect2(http, 30000, NULL))
@@ -383,6 +435,8 @@ cupsPutFd(http_t *http, /* I - Connection to server or @code CUPS_HTTP_DEFA
DEBUG_printf(("2cupsPutFd: status=%d", status));
+ new_auth = 0;
+
if (status == HTTP_STATUS_UNAUTHORIZED)
{
/*
@@ -395,6 +449,8 @@ cupsPutFd(http_t *http, /* I - Connection to server or @code CUPS_HTTP_DEFA
* See if we can do authentication...
*/
+ new_auth = 1;
+
if (cupsDoAuthentication(http, "PUT", resource))
{
status = HTTP_STATUS_CUPS_AUTHORIZATION_CANCELED;
diff --git a/cups/globals.c b/cups/globals.c
index 8a05c3e..b75434f 100644
--- a/cups/globals.c
+++ b/cups/globals.c
@@ -4,13 +4,7 @@
* Copyright 2007-2015 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.
+ * Licensed under Apache License v2.0. See the file "LICENSE" for more information.
*/
/*
@@ -34,23 +28,23 @@ static _cups_threadkey_t cups_globals_key = _CUPS_THREADKEY_INITIALIZER;
static pthread_once_t cups_globals_key_once = PTHREAD_ONCE_INIT;
/* One-time initialization object */
#endif /* HAVE_PTHREAD_H */
-#if defined(HAVE_PTHREAD_H) || defined(WIN32)
+#if defined(HAVE_PTHREAD_H) || defined(_WIN32)
static _cups_mutex_t cups_global_mutex = _CUPS_MUTEX_INITIALIZER;
/* Global critical section */
-#endif /* HAVE_PTHREAD_H || WIN32 */
+#endif /* HAVE_PTHREAD_H || _WIN32 */
/*
* Local functions...
*/
-#ifdef WIN32
+#ifdef _WIN32
static void cups_fix_path(char *path);
-#endif /* WIN32 */
+#endif /* _WIN32 */
static _cups_globals_t *cups_globals_alloc(void);
-#if defined(HAVE_PTHREAD_H) || defined(WIN32)
+#if defined(HAVE_PTHREAD_H) || defined(_WIN32)
static void cups_globals_free(_cups_globals_t *g);
-#endif /* HAVE_PTHREAD_H || WIN32 */
+#endif /* HAVE_PTHREAD_H || _WIN32 */
#ifdef HAVE_PTHREAD_H
static void cups_globals_init(void);
#endif /* HAVE_PTHREAD_H */
@@ -65,7 +59,7 @@ _cupsGlobalLock(void)
{
#ifdef HAVE_PTHREAD_H
pthread_mutex_lock(&cups_global_mutex);
-#elif defined(WIN32)
+#elif defined(_WIN32)
EnterCriticalSection(&cups_global_mutex.m_criticalSection);
#endif /* HAVE_PTHREAD_H */
}
@@ -120,13 +114,13 @@ _cupsGlobalUnlock(void)
{
#ifdef HAVE_PTHREAD_H
pthread_mutex_unlock(&cups_global_mutex);
-#elif defined(WIN32)
+#elif defined(_WIN32)
LeaveCriticalSection(&cups_global_mutex.m_criticalSection);
#endif /* HAVE_PTHREAD_H */
}
-#ifdef WIN32
+#ifdef _WIN32
/*
* 'DllMain()' - Main entry for library.
*/
@@ -170,7 +164,7 @@ DllMain(HINSTANCE hinst, /* I - DLL module handle */
return (TRUE);
}
-#endif /* WIN32 */
+#endif /* _WIN32 */
/*
@@ -182,13 +176,13 @@ cups_globals_alloc(void)
{
_cups_globals_t *cg = malloc(sizeof(_cups_globals_t));
/* Pointer to global data */
-#ifdef WIN32
+#ifdef _WIN32
HKEY key; /* Registry key */
DWORD size; /* Size of string */
static char installdir[1024] = "", /* Install directory */
confdir[1024] = "", /* Server root directory */
localedir[1024] = ""; /* Locale directory */
-#endif /* WIN32 */
+#endif /* _WIN32 */
if (!cg)
@@ -219,7 +213,7 @@ cups_globals_alloc(void)
* Then set directories as appropriate...
*/
-#ifdef WIN32
+#ifdef _WIN32
if (!installdir[0])
{
/*
@@ -228,8 +222,7 @@ cups_globals_alloc(void)
strlcpy(installdir, "C:/Program Files/cups.org", sizeof(installdir));
- if (!RegOpenKeyEx(HKEY_LOCAL_MACHINE, "SOFTWARE\\cups.org", 0, KEY_READ,
- &key))
+ if (!RegOpenKeyExA(HKEY_LOCAL_MACHINE, "SOFTWARE\\cups.org", 0, KEY_READ, &key))
{
/*
* Grab the installation directory...
@@ -238,7 +231,7 @@ cups_globals_alloc(void)
char *ptr; /* Pointer into installdir */
size = sizeof(installdir);
- RegQueryValueEx(key, "installdir", NULL, NULL, installdir, &size);
+ RegQueryValueExA(key, "installdir", NULL, NULL, installdir, &size);
RegCloseKey(key);
for (ptr = installdir; *ptr;)
@@ -315,7 +308,7 @@ cups_globals_alloc(void)
if ((cg->localedir = getenv("LOCALEDIR")) == NULL)
cg->localedir = CUPS_LOCALEDIR;
}
-#endif /* WIN32 */
+#endif /* _WIN32 */
return (cg);
}
@@ -325,7 +318,7 @@ cups_globals_alloc(void)
* 'cups_globals_free()' - Free global data.
*/
-#if defined(HAVE_PTHREAD_H) || defined(WIN32)
+#if defined(HAVE_PTHREAD_H) || defined(_WIN32)
static void
cups_globals_free(_cups_globals_t *cg) /* I - Pointer to global data */
{
@@ -358,9 +351,12 @@ cups_globals_free(_cups_globals_t *cg) /* I - Pointer to global data */
cupsFreeOptions(cg->cupsd_num_settings, cg->cupsd_settings);
+ if (cg->raster_error.start)
+ free(cg->raster_error.start);
+
free(cg);
}
-#endif /* HAVE_PTHREAD_H || WIN32 */
+#endif /* HAVE_PTHREAD_H || _WIN32 */
#ifdef HAVE_PTHREAD_H
diff --git a/cups/hash.c b/cups/hash.c
index ede5461..7b3ea81 100644
--- a/cups/hash.c
+++ b/cups/hash.c
@@ -1,15 +1,10 @@
/*
* Hashing function for CUPS.
*
- * Copyright 2015-2016 by Apple Inc.
+ * Copyright © 2015-2019 by Apple Inc.
*
- * 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.
+ * Licensed under Apache License v2.0. See the file "LICENSE" for more
+ * information.
*/
/*
@@ -21,6 +16,8 @@
# include
#elif defined(HAVE_GNUTLS)
# include
+#else
+# include "md5-internal.h"
#endif /* __APPLE__ */
@@ -53,7 +50,24 @@ cupsHashData(const char *algorithm, /* I - Algorithm name */
}
#ifdef __APPLE__
- if (!strcmp(algorithm, "sha"))
+ if (!strcmp(algorithm, "md5"))
+ {
+ /*
+ * MD5 (deprecated but widely used...)
+ */
+
+ CC_MD5_CTX ctx; /* MD5 context */
+
+ if (hashsize < CC_MD5_DIGEST_LENGTH)
+ goto too_small;
+
+ CC_MD5_Init(&ctx);
+ CC_MD5_Update(&ctx, data, (CC_LONG)datalen);
+ CC_MD5_Final(hash, &ctx);
+
+ return (CC_MD5_DIGEST_LENGTH);
+ }
+ else if (!strcmp(algorithm, "sha"))
{
/*
* SHA-1...
@@ -171,7 +185,16 @@ cupsHashData(const char *algorithm, /* I - Algorithm name */
unsigned char temp[64]; /* Temporary hash buffer */
size_t tempsize = 0; /* Truncate to this size? */
- if (!strcmp(algorithm, "sha"))
+
+# ifdef HAVE_GNUTLS_FIPS140_SET_MODE
+ unsigned oldmode = gnutls_fips140_mode_enabled();
+
+ gnutls_fips140_set_mode(GNUTLS_FIPS140_LAX, GNUTLS_FIPS140_SET_MODE_THREAD);
+# endif /* HAVE_GNUTLS_FIPS140_SET_MODE */
+
+ if (!strcmp(algorithm, "md5"))
+ alg = GNUTLS_DIG_MD5;
+ else if (!strcmp(algorithm, "sha"))
alg = GNUTLS_DIG_SHA1;
else if (!strcmp(algorithm, "sha2-224"))
alg = GNUTLS_DIG_SHA224;
@@ -206,6 +229,10 @@ cupsHashData(const char *algorithm, /* I - Algorithm name */
gnutls_hash_fast(alg, data, datalen, temp);
memcpy(hash, temp, tempsize);
+# ifdef HAVE_GNUTLS_FIPS140_SET_MODE
+ gnutls_fips140_set_mode(oldmode, GNUTLS_FIPS140_SET_MODE_THREAD);
+# endif /* HAVE_GNUTLS_FIPS140_SET_MODE */
+
return ((ssize_t)tempsize);
}
@@ -214,15 +241,33 @@ cupsHashData(const char *algorithm, /* I - Algorithm name */
gnutls_hash_fast(alg, data, datalen, hash);
- return (gnutls_hash_get_len(alg));
+# ifdef HAVE_GNUTLS_FIPS140_SET_MODE
+ gnutls_fips140_set_mode(oldmode, GNUTLS_FIPS140_SET_MODE_THREAD);
+# endif /* HAVE_GNUTLS_FIPS140_SET_MODE */
+
+ return ((ssize_t)gnutls_hash_get_len(alg));
}
+# ifdef HAVE_GNUTLS_FIPS140_SET_MODE
+ gnutls_fips140_set_mode(oldmode, GNUTLS_FIPS140_SET_MODE_THREAD);
+# endif /* HAVE_GNUTLS_FIPS140_SET_MODE */
+
#else
/*
- * No hash support without CommonCrypto or GNU TLS...
+ * No hash support beyond MD5 without CommonCrypto or GNU TLS...
*/
- if (hashsize < 64)
+ if (!strcmp(algorithm, "md5"))
+ {
+ _cups_md5_state_t state; /* MD5 state info */
+
+ _cupsMD5Init(&state);
+ _cupsMD5Append(&state, data, datalen);
+ _cupsMD5Finish(&state, hash);
+
+ return (16);
+ }
+ else if (hashsize < 64)
goto too_small;
#endif /* __APPLE__ */
@@ -240,6 +285,60 @@ cupsHashData(const char *algorithm, /* I - Algorithm name */
too_small:
+#ifdef HAVE_GNUTLS_FIPS140_SET_MODE
+ gnutls_fips140_set_mode(oldmode, GNUTLS_FIPS140_SET_MODE_THREAD);
+#endif /* HAVE_GNUTLS_FIPS140_SET_MODE */
+
_cupsSetError(IPP_STATUS_ERROR_INTERNAL, _("Hash buffer too small."), 1);
return (-1);
}
+
+
+/*
+ * 'cupsHashString()' - Format a hash value as a hexadecimal string.
+ *
+ * The passed buffer must be at least 2 * hashsize + 1 characters in length.
+ *
+ * @since CUPS 2.2.7@
+ */
+
+const char * /* O - Formatted string */
+cupsHashString(
+ const unsigned char *hash, /* I - Hash */
+ size_t hashsize, /* I - Size of hash */
+ char *buffer, /* I - String buffer */
+ size_t bufsize) /* I - Size of string buffer */
+{
+ char *bufptr = buffer; /* Pointer into buffer */
+ static const char *hex = "0123456789abcdef";
+ /* Hex characters (lowercase!) */
+
+
+ /*
+ * Range check input...
+ */
+
+ if (!hash || hashsize < 1 || !buffer || bufsize < (2 * hashsize + 1))
+ {
+ if (buffer)
+ *buffer = '\0';
+ return (NULL);
+ }
+
+ /*
+ * Loop until we've converted the whole hash...
+ */
+
+ while (hashsize > 0)
+ {
+ *bufptr++ = hex[*hash >> 4];
+ *bufptr++ = hex[*hash & 15];
+
+ hash ++;
+ hashsize --;
+ }
+
+ *bufptr = '\0';
+
+ return (buffer);
+}
diff --git a/cups/http-addr.c b/cups/http-addr.c
index 61c8638..86749c8 100644
--- a/cups/http-addr.c
+++ b/cups/http-addr.c
@@ -1,16 +1,11 @@
/*
* HTTP address routines for CUPS.
*
- * Copyright 2007-2014 by Apple Inc.
+ * Copyright 2007-2019 by Apple Inc.
* Copyright 1997-2006 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.
+ * Licensed under Apache License v2.0. See the file "LICENSE" for more
+ * information.
*/
/*
@@ -18,13 +13,16 @@
*/
#include "cups-private.h"
+#include "debug-internal.h"
#include
#ifdef HAVE_RESOLV_H
# include
#endif /* HAVE_RESOLV_H */
#ifdef __APPLE__
# include
-# include
+# ifdef HAVE_SCDYNAMICSTORECOPYCOMPUTERNAME
+# include
+# endif /* HAVE_SCDYNAMICSTORECOPYCOMPUTERNAME */
#endif /* __APPLE__ */
@@ -69,11 +67,11 @@ int /* O - 0 on success, -1 on failure */
httpAddrClose(http_addr_t *addr, /* I - Listen address or @code NULL@ */
int fd) /* I - Socket file descriptor */
{
-#ifdef WIN32
+#ifdef _WIN32
if (closesocket(fd))
#else
if (close(fd))
-#endif /* WIN32 */
+#endif /* _WIN32 */
return (-1);
#ifdef AF_LOCAL
@@ -258,9 +256,9 @@ httpAddrListen(http_addr_t *addr, /* I - Address to bind to */
* Close on exec...
*/
-#ifndef WIN32
+#ifndef _WIN32
fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
-#endif /* !WIN32 */
+#endif /* !_WIN32 */
#ifdef SO_NOSIGPIPE
/*
diff --git a/cups/http-addrlist.c b/cups/http-addrlist.c
index 22bd5a7..485c6f4 100644
--- a/cups/http-addrlist.c
+++ b/cups/http-addrlist.c
@@ -1,16 +1,11 @@
/*
* HTTP address list routines for CUPS.
*
- * Copyright 2007-2017 by Apple Inc.
+ * Copyright 2007-2018 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.
+ * Licensed under Apache License v2.0. See the file "LICENSE" for more
+ * information.
*/
/*
@@ -18,15 +13,16 @@
*/
#include "cups-private.h"
+#include "debug-internal.h"
#ifdef HAVE_RESOLV_H
# include