/*
- * "$Id: util.c 6649 2007-07-11 21:46:42Z mike $"
+ * Printing utilities for CUPS.
*
- * Printing utilities for the Common UNIX Printing System (CUPS).
+ * Copyright 2007-2015 by Apple Inc.
+ * Copyright 1997-2006 by Easy Software Products.
*
- * Copyright 2007 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/".
*
- * 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/".
- *
- * This file is subject to the Apple OS-Developed Software exception.
- *
- * Contents:
- *
- * cupsCancelJob() - Cancel a print job on the default server.
- * cupsFreeJobs() - Free memory used by job data.
- * cupsGetClasses() - Get a list of printer classes from the default
- * server.
- * cupsGetDefault() - Get the default printer or class from the default
- * server.
- * cupsGetDefault2() - Get the default printer or class from the
- * specified server.
- * cupsGetJobs() - Get the jobs from the default server.
- * cupsGetJobs2() - Get the jobs from the specified server.
- * cupsGetPPD() - Get the PPD file for a printer on the default
- * server.
- * cupsGetPPD2() - Get the PPD file for a printer on the specified
- * server.
- * cupsGetPrinters() - Get a list of printers from the default server.
- * cupsGetServerPPD() - Get an available PPD file from the server.
- * cupsLastError() - Return the last IPP status code.
- * cupsLastErrorString() - Return the last IPP status-message.
- * cupsPrintFile() - Print a file to a printer or class on the default
- * server.
- * cupsPrintFile2() - Print a file to a printer or class on the
- * specified server.
- * cupsPrintFiles() - Print one or more files to a printer or class on
- * the default server.
- * cupsPrintFiles2() - Print one or more files to a printer or class on
- * the specified server.
- * cups_connect() - Connect to the specified host...
- * cups_get_printer_uri() - Get the printer-uri-supported attribute for the
- * first printer in a class.
+ * This file is subject to the Apple OS-Developed Software exception.
*/
/*
* Include necessary headers...
*/
-#include "globals.h"
-#include "debug.h"
-#include <stdlib.h>
-#include <errno.h>
+#include "cups-private.h"
#include <fcntl.h>
#include <sys/stat.h>
#if defined(WIN32) || defined(__EMX__)
/*
- * Local functions...
+ * 'cupsCancelJob()' - Cancel a print job on the default server.
+ *
+ * Pass @code CUPS_JOBID_ALL@ to cancel all jobs or @code CUPS_JOBID_CURRENT@
+ * to cancel the current job on the named destination.
+ *
+ * Use the @link cupsLastError@ and @link cupsLastErrorString@ functions to get
+ * the cause of any failure.
*/
-static char *cups_connect(const char *name, char *printer, char *hostname);
-static int cups_get_printer_uri(http_t *http, const char *name,
- char *host, int hostsize, int *port,
- char *resource, int resourcesize,
- int depth);
+int /* O - 1 on success, 0 on failure */
+cupsCancelJob(const char *name, /* I - Name of printer or class */
+ int job_id) /* I - Job ID, @code CUPS_JOBID_CURRENT@ for the current job, or @code CUPS_JOBID_ALL@ for all jobs */
+{
+ return (cupsCancelJob2(CUPS_HTTP_DEFAULT, name, job_id, 0)
+ < IPP_STATUS_REDIRECTION_OTHER_SITE);
+}
/*
- * 'cupsCancelJob()' - Cancel a print job on the default server.
+ * 'cupsCancelJob2()' - Cancel or purge a print job.
*
- * Use the cupsLastError() and cupsLastErrorString() functions to get
+ * Canceled jobs remain in the job history while purged jobs are removed
+ * from the job history.
+ *
+ * Pass @code CUPS_JOBID_ALL@ to cancel all jobs or @code CUPS_JOBID_CURRENT@
+ * to cancel the current job on the named destination.
+ *
+ * Use the @link cupsLastError@ and @link cupsLastErrorString@ functions to get
* the cause of any failure.
+ *
+ * @since CUPS 1.4/OS X 10.6@
*/
-int /* O - 1 on success, 0 on failure */
-cupsCancelJob(const char *name, /* I - Name of printer or class */
- int job) /* I - Job ID */
+ipp_status_t /* O - IPP status */
+cupsCancelJob2(http_t *http, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
+ const char *name, /* I - Name of printer or class */
+ int job_id, /* I - Job ID, @code CUPS_JOBID_CURRENT@ for the current job, or @code CUPS_JOBID_ALL@ for all jobs */
+ int purge) /* I - 1 to purge, 0 to cancel */
{
- char printer[HTTP_MAX_URI], /* Printer name */
- hostname[HTTP_MAX_URI], /* Hostname */
- uri[HTTP_MAX_URI]; /* Printer URI */
- ipp_t *request, /* IPP request */
- *response; /* IPP response */
- cups_lang_t *language; /* Language info */
- _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
+ char uri[HTTP_MAX_URI]; /* Job/printer URI */
+ ipp_t *request; /* IPP request */
/*
- * See if we can connect to the server...
+ * Range check input...
*/
- if (!cups_connect(name, printer, hostname))
+ if (job_id < -1 || (!name && job_id == 0))
{
- DEBUG_puts("Unable to connect to server!");
-
+ _cupsSetError(IPP_STATUS_ERROR_INTERNAL, strerror(EINVAL), 0);
return (0);
}
/*
- * Create a printer URI...
+ * Connect to the default server as needed...
*/
- if (httpAssembleURIf(HTTP_URI_CODING_ALL, uri, sizeof(uri), "ipp", NULL,
- "localhost", 0, "/printers/%s", printer) != HTTP_URI_OK)
- {
- _cupsSetError(IPP_INTERNAL_ERROR, NULL);
-
- return (0);
- }
+ if (!http)
+ if ((http = _cupsConnect()) == NULL)
+ return (IPP_STATUS_ERROR_SERVICE_UNAVAILABLE);
/*
- * Build an IPP_CANCEL_JOB request, which requires the following
+ * Build an IPP_CANCEL_JOB or IPP_PURGE_JOBS request, which requires the following
* attributes:
*
* attributes-charset
* attributes-natural-language
- * printer-uri
- * job-id
- * [requesting-user-name]
+ * job-uri or printer-uri + job-id
+ * requesting-user-name
+ * [purge-job] or [purge-jobs]
*/
- request = ippNew();
-
- request->request.op.operation_id = IPP_CANCEL_JOB;
- request->request.op.request_id = 1;
-
- language = cupsLangDefault();
-
- ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_CHARSET,
- "attributes-charset", NULL, cupsLangEncoding(language));
-
- ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_LANGUAGE,
- "attributes-natural-language", NULL,
- language != NULL ? language->language : "C");
+ request = ippNewRequest(job_id < 0 ? IPP_OP_PURGE_JOBS : IPP_OP_CANCEL_JOB);
- cupsLangFree(language);
+ if (name)
+ {
+ httpAssembleURIf(HTTP_URI_CODING_ALL, uri, sizeof(uri), "ipp", NULL,
+ "localhost", ippPort(), "/printers/%s", name);
- ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri",
- NULL, uri);
+ ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri", NULL,
+ uri);
+ ippAddInteger(request, IPP_TAG_OPERATION, IPP_TAG_INTEGER, "job-id",
+ job_id);
+ }
+ else if (job_id > 0)
+ {
+ snprintf(uri, sizeof(uri), "ipp://localhost/jobs/%d", job_id);
- ippAddInteger(request, IPP_TAG_OPERATION, IPP_TAG_INTEGER, "job-id", job);
+ ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "job-uri", NULL, uri);
+ }
ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "requesting-user-name",
NULL, cupsUser());
+ if (purge && job_id >= 0)
+ ippAddBoolean(request, IPP_TAG_OPERATION, "purge-job", 1);
+ else if (!purge && job_id < 0)
+ ippAddBoolean(request, IPP_TAG_OPERATION, "purge-jobs", 0);
+
/*
* Do the request...
*/
- if ((response = cupsDoRequest(cg->http, request, "/jobs/")) != NULL)
- ippDelete(response);
+ ippDelete(cupsDoRequest(http, request, "/jobs/"));
- return (cg->last_error < IPP_REDIRECTION_OTHER_SITE);
+ return (cupsLastError());
}
/*
- * 'cupsFreeJobs()' - Free memory used by job data.
+ * 'cupsCreateJob()' - Create an empty job for streaming.
+ *
+ * Use this function when you want to stream print data using the
+ * @link cupsStartDocument@, @link cupsWriteRequestData@, and
+ * @link cupsFinishDocument@ functions. If you have one or more files to
+ * print, use the @link cupsPrintFile2@ or @link cupsPrintFiles2@ function
+ * instead.
+ *
+ * @since CUPS 1.4/OS X 10.6@
*/
-void
-cupsFreeJobs(int num_jobs, /* I - Number of jobs */
- cups_job_t *jobs) /* I - Jobs */
+int /* O - Job ID or 0 on error */
+cupsCreateJob(
+ http_t *http, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
+ const char *name, /* I - Destination name */
+ const char *title, /* I - Title of job */
+ int num_options, /* I - Number of options */
+ cups_option_t *options) /* I - Options */
{
- int i; /* Looping var */
+ char printer_uri[1024], /* Printer URI */
+ resource[1024]; /* Printer resource */
+ ipp_t *request, /* Create-Job request */
+ *response; /* Create-Job response */
+ ipp_attribute_t *attr; /* job-id attribute */
+ int job_id = 0; /* job-id value */
- if (num_jobs <= 0 || jobs == NULL)
- return;
+ DEBUG_printf(("cupsCreateJob(http=%p, name=\"%s\", title=\"%s\", num_options=%d, options=%p)", (void *)http, name, title, num_options, (void *)options));
+
+ /*
+ * Range check input...
+ */
- for (i = 0; i < num_jobs; i ++)
+ if (!name)
{
- free(jobs[i].dest);
- free(jobs[i].user);
- free(jobs[i].format);
- free(jobs[i].title);
+ _cupsSetError(IPP_STATUS_ERROR_INTERNAL, strerror(EINVAL), 0);
+ return (0);
}
- free(jobs);
-}
-
-
-/*
- * 'cupsGetClasses()' - Get a list of printer classes from the default server.
- *
- * This function is deprecated - use cupsGetDests() instead.
- *
- * @deprecated@
- */
-
-int /* O - Number of classes */
-cupsGetClasses(char ***classes) /* O - Classes */
-{
- int n; /* Number of classes */
- ipp_t *request, /* IPP Request */
- *response; /* IPP Response */
- ipp_attribute_t *attr; /* Current attribute */
- cups_lang_t *language; /* Default language */
- char **temp; /* Temporary pointer */
- _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
-
+ /*
+ * Build a Create-Job request...
+ */
- if (classes == NULL)
+ if ((request = ippNewRequest(IPP_OP_CREATE_JOB)) == NULL)
{
- _cupsSetError(IPP_INTERNAL_ERROR, NULL);
-
+ _cupsSetError(IPP_STATUS_ERROR_INTERNAL, strerror(ENOMEM), 0);
return (0);
}
+ httpAssembleURIf(HTTP_URI_CODING_ALL, printer_uri, sizeof(printer_uri), "ipp",
+ NULL, "localhost", ippPort(), "/printers/%s", name);
+ snprintf(resource, sizeof(resource), "/printers/%s", name);
+
+ ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri",
+ NULL, printer_uri);
+ ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "requesting-user-name",
+ NULL, cupsUser());
+ if (title)
+ ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "job-name", NULL,
+ title);
+ cupsEncodeOptions2(request, num_options, options, IPP_TAG_OPERATION);
+ cupsEncodeOptions2(request, num_options, options, IPP_TAG_JOB);
+ cupsEncodeOptions2(request, num_options, options, IPP_TAG_SUBSCRIPTION);
+
/*
- * Try to connect to the server...
+ * Send the request and get the job-id...
*/
- if (!cups_connect("default", NULL, NULL))
- {
- DEBUG_puts("Unable to connect to server!");
+ response = cupsDoRequest(http, request, resource);
- return (0);
- }
+ if ((attr = ippFindAttribute(response, "job-id", IPP_TAG_INTEGER)) != NULL)
+ job_id = attr->values[0].integer;
+
+ ippDelete(response);
/*
- * Build a CUPS_GET_CLASSES request, which requires the following
- * attributes:
- *
- * attributes-charset
- * attributes-natural-language
- * requested-attributes
+ * Return it...
*/
- request = ippNew();
+ return (job_id);
+}
+
+
+/*
+ * 'cupsFinishDocument()' - Finish sending a document.
+ *
+ * The document must have been started using @link cupsStartDocument@.
+ *
+ * @since CUPS 1.4/OS X 10.6@
+ */
+
+ipp_status_t /* O - Status of document submission */
+cupsFinishDocument(http_t *http, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
+ const char *name) /* I - Destination name */
+{
+ char resource[1024]; /* Printer resource */
- request->request.op.operation_id = CUPS_GET_CLASSES;
- request->request.op.request_id = 1;
- language = cupsLangDefault();
+ snprintf(resource, sizeof(resource), "/printers/%s", name);
- ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_CHARSET,
- "attributes-charset", NULL, cupsLangEncoding(language));
+ ippDelete(cupsGetResponse(http, resource));
- ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_LANGUAGE,
- "attributes-natural-language", NULL, language->language);
+ return (cupsLastError());
+}
- cupsLangFree(language);
- ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD,
- "requested-attributes", NULL, "printer-name");
+/*
+ * 'cupsFreeJobs()' - Free memory used by job data.
+ */
+
+void
+cupsFreeJobs(int num_jobs, /* I - Number of jobs */
+ cups_job_t *jobs) /* I - Jobs */
+{
+ int i; /* Looping var */
+ cups_job_t *job; /* Current job */
- /*
- * Do the request and get back a response...
- */
- n = 0;
- *classes = NULL;
+ if (num_jobs <= 0 || !jobs)
+ return;
- if ((response = cupsDoRequest(cg->http, request, "/")) != NULL)
+ for (i = num_jobs, job = jobs; i > 0; i --, job ++)
{
- for (attr = response->attrs; attr != NULL; attr = attr->next)
- if (attr->name != NULL &&
- strcasecmp(attr->name, "printer-name") == 0 &&
- attr->value_tag == IPP_TAG_NAME)
- {
- if (n == 0)
- temp = malloc(sizeof(char *));
- else
- temp = realloc(*classes, sizeof(char *) * (n + 1));
+ _cupsStrFree(job->dest);
+ _cupsStrFree(job->user);
+ _cupsStrFree(job->format);
+ _cupsStrFree(job->title);
+ }
- if (temp == NULL)
- {
- /*
- * Ran out of memory!
- */
-
- while (n > 0)
- {
- n --;
- free((*classes)[n]);
- }
-
- free(*classes);
- ippDelete(response);
- return (0);
- }
-
- *classes = temp;
- temp[n] = strdup(attr->values[0].string.text);
- n ++;
- }
+ free(jobs);
+}
- ippDelete(response);
- }
- return (n);
+/*
+ * 'cupsGetClasses()' - Get a list of printer classes from the default server.
+ *
+ * This function is deprecated and no longer returns a list of printer
+ * classes - use @link cupsGetDests@ instead.
+ *
+ * @deprecated@
+ */
+
+int /* O - Number of classes */
+cupsGetClasses(char ***classes) /* O - Classes */
+{
+ if (classes)
+ *classes = NULL;
+
+ return (0);
}
* This function returns the default printer or class as defined by
* the LPDEST or PRINTER environment variables. If these environment
* variables are not set, the server default destination is returned.
- * Applications should use the cupsGetDests() and cupsGetDest() functions
- * to get the user-defined default printer, as this function does not
- * support the lpoptions-defined default printer.
+ * Applications should use the @link cupsGetDests@ and @link cupsGetDest@
+ * functions to get the user-defined default printer, as this function does
+ * not support the lpoptions-defined default printer.
*/
-const char * /* O - Default printer or NULL */
+const char * /* O - Default printer or @code NULL@ */
cupsGetDefault(void)
{
- const char *var; /* Environment variable */
- _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
-
-
- /*
- * First see if the LPDEST or PRINTER environment variables are
- * set... However, if PRINTER is set to "lp", ignore it to work
- * around a "feature" in most Linux distributions - the default
- * user login scripts set PRINTER to "lp"...
- */
-
- if ((var = getenv("LPDEST")) != NULL)
- return (var);
- else if ((var = getenv("PRINTER")) != NULL && strcmp(var, "lp") != 0)
- return (var);
-
- /*
- * Try to connect to the server...
- */
-
- if (!cups_connect("default", NULL, NULL))
- {
- DEBUG_puts("Unable to connect to server!");
-
- return (NULL);
- }
-
/*
* Return the default printer...
*/
- return (cupsGetDefault2(cg->http));
+ return (cupsGetDefault2(CUPS_HTTP_DEFAULT));
}
* This function returns the default printer or class as defined by
* the LPDEST or PRINTER environment variables. If these environment
* variables are not set, the server default destination is returned.
- * Applications should use the cupsGetDests() and cupsGetDest() functions
- * to get the user-defined default printer, as this function does not
- * support the lpoptions-defined default printer.
+ * Applications should use the @link cupsGetDests@ and @link cupsGetDest@
+ * functions to get the user-defined default printer, as this function does
+ * not support the lpoptions-defined default printer.
*
- * @since CUPS 1.1.21@
+ * @since CUPS 1.1.21/OS X 10.4@
*/
-const char * /* O - Default printer or NULL */
-cupsGetDefault2(http_t *http) /* I - HTTP connection */
+const char * /* O - Default printer or @code NULL@ */
+cupsGetDefault2(http_t *http) /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
{
ipp_t *request, /* IPP Request */
*response; /* IPP Response */
ipp_attribute_t *attr; /* Current attribute */
- cups_lang_t *language; /* Default language */
- const char *var; /* Environment variable */
_cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
/*
- * First see if the LPDEST or PRINTER environment variables are
- * set... However, if PRINTER is set to "lp", ignore it to work
- * around a "feature" in most Linux distributions - the default
- * user login scripts set PRINTER to "lp"...
+ * See if we have a user default printer set...
*/
- if ((var = getenv("LPDEST")) != NULL)
- return (var);
- else if ((var = getenv("PRINTER")) != NULL && strcmp(var, "lp") != 0)
- return (var);
+ if (_cupsUserDefault(cg->def_printer, sizeof(cg->def_printer)))
+ return (cg->def_printer);
/*
- * Range check input...
+ * Connect to the server as needed...
*/
if (!http)
- return (NULL);
+ if ((http = _cupsConnect()) == NULL)
+ return (NULL);
/*
* Build a CUPS_GET_DEFAULT request, which requires the following
* attributes-natural-language
*/
- request = ippNew();
-
- request->request.op.operation_id = CUPS_GET_DEFAULT;
- request->request.op.request_id = 1;
-
- language = cupsLangDefault();
-
- ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_CHARSET,
- "attributes-charset", NULL, cupsLangEncoding(language));
-
- ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_LANGUAGE,
- "attributes-natural-language", NULL, language->language);
-
- cupsLangFree(language);
+ request = ippNewRequest(IPP_OP_CUPS_GET_DEFAULT);
/*
* Do the request and get back a response...
if ((response = cupsDoRequest(http, request, "/")) != NULL)
{
- if ((attr = ippFindAttribute(response, "printer-name", IPP_TAG_NAME)) != NULL)
+ if ((attr = ippFindAttribute(response, "printer-name",
+ IPP_TAG_NAME)) != NULL)
{
- strlcpy(cg->def_printer, attr->values[0].string.text, sizeof(cg->def_printer));
+ strlcpy(cg->def_printer, attr->values[0].string.text,
+ sizeof(cg->def_printer));
ippDelete(response);
return (cg->def_printer);
}
/*
* 'cupsGetJobs()' - Get the jobs from the default server.
+ *
+ * A "whichjobs" value of @code CUPS_WHICHJOBS_ALL@ returns all jobs regardless
+ * of state, while @code CUPS_WHICHJOBS_ACTIVE@ returns jobs that are
+ * pending, processing, or held and @code CUPS_WHICHJOBS_COMPLETED@ returns
+ * jobs that are stopped, canceled, aborted, or completed.
*/
int /* O - Number of jobs */
cupsGetJobs(cups_job_t **jobs, /* O - Job data */
- const char *mydest, /* I - NULL = all destinations, *
- * otherwise show jobs for mydest */
+ const char *name, /* I - @code NULL@ = all destinations, otherwise show jobs for named destination */
int myjobs, /* I - 0 = all users, 1 = mine */
- int completed) /* I - -1 = show all, 0 = active, *
- * 1 = completed jobs */
+ int whichjobs) /* I - @code CUPS_WHICHJOBS_ALL@, @code CUPS_WHICHJOBS_ACTIVE@, or @code CUPS_WHICHJOBS_COMPLETED@ */
{
- _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
-
- /*
- * Try to connect to the server...
- */
-
- if (!cups_connect("default", NULL, NULL))
- {
- DEBUG_puts("Unable to connect to server!");
-
- return (-1);
- }
-
/*
* Return the jobs...
*/
- return (cupsGetJobs2(cg->http, jobs, mydest, myjobs, completed));
+ return (cupsGetJobs2(CUPS_HTTP_DEFAULT, jobs, name, myjobs, whichjobs));
}
/*
* 'cupsGetJobs2()' - Get the jobs from the specified server.
*
- * @since CUPS 1.1.21@
+ * A "whichjobs" value of @code CUPS_WHICHJOBS_ALL@ returns all jobs regardless
+ * of state, while @code CUPS_WHICHJOBS_ACTIVE@ returns jobs that are
+ * pending, processing, or held and @code CUPS_WHICHJOBS_COMPLETED@ returns
+ * jobs that are stopped, canceled, aborted, or completed.
+ *
+ * @since CUPS 1.1.21/OS X 10.4@
*/
int /* O - Number of jobs */
-cupsGetJobs2(http_t *http, /* I - HTTP connection */
+cupsGetJobs2(http_t *http, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
cups_job_t **jobs, /* O - Job data */
- const char *mydest, /* I - NULL = all destinations, *
- * otherwise show jobs for mydest */
+ const char *name, /* I - @code NULL@ = all destinations, otherwise show jobs for named destination */
int myjobs, /* I - 0 = all users, 1 = mine */
- int completed) /* I - -1 = show all, 0 = active, *
- * 1 = completed jobs */
+ int whichjobs) /* I - @code CUPS_WHICHJOBS_ALL@, @code CUPS_WHICHJOBS_ACTIVE@, or @code CUPS_WHICHJOBS_COMPLETED@ */
{
int n; /* Number of jobs */
ipp_t *request, /* IPP Request */
*response; /* IPP Response */
ipp_attribute_t *attr; /* Current attribute */
- cups_lang_t *language; /* Default language */
cups_job_t *temp; /* Temporary pointer */
int id, /* job-id */
priority, /* job-priority */
_cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
static const char * const attrs[] = /* Requested attributes */
{
+ "document-format",
"job-id",
- "job-priority",
"job-k-octets",
+ "job-name",
+ "job-originating-user-name",
+ "job-printer-uri",
+ "job-priority",
"job-state",
"time-at-completed",
"time-at-creation",
- "time-at-processing",
- "job-printer-uri",
- "document-format",
- "job-name",
- "job-originating-user-name"
+ "time-at-processing"
};
* Range check input...
*/
- if (!http || !jobs)
+ if (!jobs)
{
- _cupsSetError(IPP_INTERNAL_ERROR, NULL);
+ _cupsSetError(IPP_STATUS_ERROR_INTERNAL, strerror(EINVAL), 0);
return (-1);
}
* Get the right URI...
*/
- if (mydest)
+ if (name)
{
if (httpAssembleURIf(HTTP_URI_CODING_ALL, uri, sizeof(uri), "ipp", NULL,
- "localhost", 0, "/printers/%s", mydest) != HTTP_URI_OK)
+ "localhost", 0, "/printers/%s",
+ name) < HTTP_URI_STATUS_OK)
{
- _cupsSetError(IPP_INTERNAL_ERROR, NULL);
+ _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
+ _("Unable to create printer-uri"), 1);
return (-1);
}
}
else
- strcpy(uri, "ipp://localhost/jobs");
+ strlcpy(uri, "ipp://localhost/", sizeof(uri));
+ if (!http)
+ if ((http = _cupsConnect()) == NULL)
+ return (-1);
/*
* Build an IPP_GET_JOBS request, which requires the following
* requested-attributes
*/
- request = ippNew();
-
- request->request.op.operation_id = IPP_GET_JOBS;
- request->request.op.request_id = 1;
-
- language = cupsLangDefault();
-
- ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_CHARSET,
- "attributes-charset", NULL, cupsLangEncoding(language));
-
- ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_LANGUAGE,
- "attributes-natural-language", NULL, language->language);
-
- cupsLangFree(language);
+ request = ippNewRequest(IPP_OP_GET_JOBS);
ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI,
"printer-uri", NULL, uri);
if (myjobs)
ippAddBoolean(request, IPP_TAG_OPERATION, "my-jobs", 1);
- if (completed > 0)
+ if (whichjobs == CUPS_WHICHJOBS_COMPLETED)
ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD,
"which-jobs", NULL, "completed");
- else if (completed < 0)
+ else if (whichjobs == CUPS_WHICHJOBS_ALL)
ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD,
"which-jobs", NULL, "all");
if ((response = cupsDoRequest(http, request, "/")) != NULL)
{
- for (attr = response->attrs; attr != NULL; attr = attr->next)
+ for (attr = response->attrs; attr; attr = attr->next)
{
/*
* Skip leading attributes until we hit a job...
*/
- while (attr != NULL && attr->group_tag != IPP_TAG_JOB)
+ while (attr && attr->group_tag != IPP_TAG_JOB)
attr = attr->next;
- if (attr == NULL)
+ if (!attr)
break;
/*
id = 0;
size = 0;
priority = 50;
- state = IPP_JOB_PENDING;
+ state = IPP_JSTATE_PENDING;
user = "unknown";
dest = NULL;
format = "application/octet-stream";
completed_time = 0;
processing_time = 0;
- while (attr != NULL && attr->group_tag == IPP_TAG_JOB)
+ while (attr && attr->group_tag == IPP_TAG_JOB)
{
- if (strcmp(attr->name, "job-id") == 0 &&
+ if (!strcmp(attr->name, "job-id") &&
attr->value_tag == IPP_TAG_INTEGER)
id = attr->values[0].integer;
- else if (strcmp(attr->name, "job-state") == 0 &&
+ else if (!strcmp(attr->name, "job-state") &&
attr->value_tag == IPP_TAG_ENUM)
state = (ipp_jstate_t)attr->values[0].integer;
- else if (strcmp(attr->name, "job-priority") == 0 &&
+ else if (!strcmp(attr->name, "job-priority") &&
attr->value_tag == IPP_TAG_INTEGER)
priority = attr->values[0].integer;
- else if (strcmp(attr->name, "job-k-octets") == 0 &&
+ else if (!strcmp(attr->name, "job-k-octets") &&
attr->value_tag == IPP_TAG_INTEGER)
size = attr->values[0].integer;
- else if (strcmp(attr->name, "time-at-completed") == 0 &&
+ else if (!strcmp(attr->name, "time-at-completed") &&
attr->value_tag == IPP_TAG_INTEGER)
completed_time = attr->values[0].integer;
- else if (strcmp(attr->name, "time-at-creation") == 0 &&
+ else if (!strcmp(attr->name, "time-at-creation") &&
attr->value_tag == IPP_TAG_INTEGER)
creation_time = attr->values[0].integer;
- else if (strcmp(attr->name, "time-at-processing") == 0 &&
+ else if (!strcmp(attr->name, "time-at-processing") &&
attr->value_tag == IPP_TAG_INTEGER)
processing_time = attr->values[0].integer;
- else if (strcmp(attr->name, "job-printer-uri") == 0 &&
+ else if (!strcmp(attr->name, "job-printer-uri") &&
attr->value_tag == IPP_TAG_URI)
{
if ((dest = strrchr(attr->values[0].string.text, '/')) != NULL)
dest ++;
}
- else if (strcmp(attr->name, "job-originating-user-name") == 0 &&
+ else if (!strcmp(attr->name, "job-originating-user-name") &&
attr->value_tag == IPP_TAG_NAME)
user = attr->values[0].string.text;
- else if (strcmp(attr->name, "document-format") == 0 &&
+ else if (!strcmp(attr->name, "document-format") &&
attr->value_tag == IPP_TAG_MIMETYPE)
format = attr->values[0].string.text;
- else if (strcmp(attr->name, "job-name") == 0 &&
+ else if (!strcmp(attr->name, "job-name") &&
(attr->value_tag == IPP_TAG_TEXT ||
attr->value_tag == IPP_TAG_NAME))
title = attr->values[0].string.text;
* See if we have everything needed...
*/
- if (dest == NULL || id == 0)
+ if (!dest || !id)
{
- if (attr == NULL)
+ if (!attr)
break;
else
continue;
if (n == 0)
temp = malloc(sizeof(cups_job_t));
else
- temp = realloc(*jobs, sizeof(cups_job_t) * (n + 1));
+ temp = realloc(*jobs, sizeof(cups_job_t) * (size_t)(n + 1));
- if (temp == NULL)
+ if (!temp)
{
/*
* Ran out of memory!
*/
+ _cupsSetError(IPP_STATUS_ERROR_INTERNAL, NULL, 0);
+
cupsFreeJobs(n, *jobs);
*jobs = NULL;
ippDelete(response);
- return (0);
+
+ return (-1);
}
*jobs = temp;
* Copy the data over...
*/
- temp->dest = strdup(dest);
- temp->user = strdup(user);
- temp->format = strdup(format);
- temp->title = strdup(title);
+ temp->dest = _cupsStrAlloc(dest);
+ temp->user = _cupsStrAlloc(user);
+ temp->format = _cupsStrAlloc(format);
+ temp->title = _cupsStrAlloc(title);
temp->id = id;
temp->priority = priority;
temp->state = state;
temp->creation_time = creation_time;
temp->processing_time = processing_time;
- if (attr == NULL)
+ if (!attr)
break;
}
ippDelete(response);
}
- if (n == 0 && cg->last_error >= IPP_BAD_REQUEST)
+ if (n == 0 && cg->last_error >= IPP_STATUS_ERROR_BAD_REQUEST)
return (-1);
else
return (n);
/*
- * 'cupsGetPPD()' - Get the PPD file for a printer on the default server.
+ * 'cupsGetPrinters()' - Get a list of printers from the default server.
*
- * For classes, cupsGetPPD() returns the PPD file for the first printer
- * in the class.
+ * This function is deprecated and no longer returns a list of printers - use
+ * @link cupsGetDests@ instead.
+ *
+ * @deprecated@
*/
-const char * /* O - Filename for PPD file */
-cupsGetPPD(const char *name) /* I - Printer name */
+int /* O - Number of printers */
+cupsGetPrinters(char ***printers) /* O - Printers */
{
- _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
+ if (printers)
+ *printers = NULL;
- /*
- * See if we can connect to the server...
- */
+ return (0);
+}
- if (!cups_connect(name, NULL, NULL))
- {
- DEBUG_puts("Unable to connect to server!");
- return (NULL);
- }
+/*
+ * 'cupsPrintFile()' - Print a file to a printer or class on the default server.
+ */
- /*
- * Return the PPD file...
- */
+int /* O - Job ID or 0 on error */
+cupsPrintFile(const char *name, /* I - Destination name */
+ const char *filename, /* I - File to print */
+ const char *title, /* I - Title of job */
+ int num_options,/* I - Number of options */
+ cups_option_t *options) /* I - Options */
+{
+ DEBUG_printf(("cupsPrintFile(name=\"%s\", filename=\"%s\", title=\"%s\", num_options=%d, options=%p)", name, filename, title, num_options, (void *)options));
- return (cupsGetPPD2(cg->http, name));
+ return (cupsPrintFiles2(CUPS_HTTP_DEFAULT, name, 1, &filename, title,
+ num_options, options));
}
/*
- * 'cupsGetPPD2()' - Get the PPD file for a printer from the specified server.
+ * 'cupsPrintFile2()' - Print a file to a printer or class on the specified
+ * server.
*
- * For classes, cupsGetPPD2() returns the PPD file for the first printer
- * in the class.
- *
- * @since CUPS 1.1.21@
+ * @since CUPS 1.1.21/OS X 10.4@
*/
-const char * /* O - Filename for PPD file */
-cupsGetPPD2(http_t *http, /* I - HTTP connection */
- const char *name) /* I - Printer name */
+int /* O - Job ID or 0 on error */
+cupsPrintFile2(
+ http_t *http, /* I - Connection to server */
+ const char *name, /* I - Destination name */
+ const char *filename, /* I - File to print */
+ const char *title, /* I - Title of job */
+ int num_options, /* I - Number of options */
+ cups_option_t *options) /* I - Options */
{
- int http_port; /* Port number */
- char http_hostname[HTTP_MAX_HOST];
- /* Hostname associated with connection */
- http_t *http2; /* Alternate HTTP connection */
- int fd; /* PPD file */
- char localhost[HTTP_MAX_URI],/* Local hostname */
- hostname[HTTP_MAX_URI], /* Hostname */
- resource[HTTP_MAX_URI]; /* Resource name */
- int port; /* Port number */
- http_status_t status; /* HTTP status from server */
- _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
+ DEBUG_printf(("cupsPrintFile2(http=%p, name=\"%s\", filename=\"%s\", title=\"%s\", num_options=%d, options=%p)", (void *)http, name, filename, title, num_options, (void *)options));
+ return (cupsPrintFiles2(http, name, 1, &filename, title, num_options,
+ options));
+}
- /*
- * Range check input...
- */
-
- DEBUG_printf(("cupsGetPPD2(http=%p, name=\"%s\")\n", http,
- name ? name : "(null)"));
- if (!http || !name)
- {
- if (!http)
- _cupsSetError(IPP_INTERNAL_ERROR, "No HTTP connection!");
- else
- _cupsSetError(IPP_INTERNAL_ERROR, "No printer name!");
+/*
+ * 'cupsPrintFiles()' - Print one or more files to a printer or class on the
+ * default server.
+ */
- return (NULL);
- }
+int /* O - Job ID or 0 on error */
+cupsPrintFiles(
+ const char *name, /* I - Destination name */
+ int num_files, /* I - Number of files */
+ const char **files, /* I - File(s) to print */
+ const char *title, /* I - Title of job */
+ int num_options, /* I - Number of options */
+ cups_option_t *options) /* I - Options */
+{
+ DEBUG_printf(("cupsPrintFiles(name=\"%s\", num_files=%d, files=%p, title=\"%s\", num_options=%d, options=%p)", name, num_files, (void *)files, title, num_options, (void *)options));
/*
- * Try finding a printer URI for this printer...
+ * Print the file(s)...
*/
- if (!cups_get_printer_uri(http, name, hostname, sizeof(hostname), &port,
- resource, sizeof(resource), 0))
- return (NULL);
+ return (cupsPrintFiles2(CUPS_HTTP_DEFAULT, name, num_files, files, title,
+ num_options, options));
+}
- DEBUG_printf(("Printer hostname=\"%s\", port=%d\n", hostname, port));
- /*
- * Remap local hostname to localhost...
- */
+/*
+ * 'cupsPrintFiles2()' - Print one or more files to a printer or class on the
+ * specified server.
+ *
+ * @since CUPS 1.1.21/OS X 10.4@
+ */
- httpGetHostname(NULL, localhost, sizeof(localhost));
+int /* O - Job ID or 0 on error */
+cupsPrintFiles2(
+ http_t *http, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
+ const char *name, /* I - Destination name */
+ int num_files, /* I - Number of files */
+ const char **files, /* I - File(s) to print */
+ const char *title, /* I - Title of job */
+ int num_options, /* I - Number of options */
+ cups_option_t *options) /* I - Options */
+{
+ int i; /* Looping var */
+ int job_id; /* New job ID */
+ const char *docname; /* Basename of current filename */
+ const char *format; /* Document format */
+ cups_file_t *fp; /* Current file */
+ char buffer[8192]; /* Copy buffer */
+ ssize_t bytes; /* Bytes in buffer */
+ http_status_t status; /* Status of write */
+ _cups_globals_t *cg = _cupsGlobals(); /* Global data */
+ ipp_status_t cancel_status; /* Status code to preserve */
+ char *cancel_message; /* Error message to preserve */
- DEBUG_printf(("Local hostname=\"%s\"\n", localhost));
- if (!strcasecmp(localhost, hostname))
- strcpy(hostname, "localhost");
+ DEBUG_printf(("cupsPrintFiles2(http=%p, name=\"%s\", num_files=%d, files=%p, title=\"%s\", num_options=%d, options=%p)", (void *)http, name, num_files, (void *)files, title, num_options, (void *)options));
/*
- * Get the hostname and port number we are connected to...
+ * Range check input...
*/
- httpGetHostname(http, http_hostname, sizeof(http_hostname));
-
-#ifdef AF_INET6
- if (http->hostaddr->addr.sa_family == AF_INET6)
- http_port = ntohs(http->hostaddr->ipv6.sin6_port);
- else
-#endif /* AF_INET6 */
- if (http->hostaddr->addr.sa_family == AF_INET)
- http_port = ntohs(http->hostaddr->ipv4.sin_port);
- else
- http_port = ippPort();
+ if (!name || num_files < 1 || !files)
+ {
+ _cupsSetError(IPP_STATUS_ERROR_INTERNAL, strerror(EINVAL), 0);
- DEBUG_printf(("Connection hostname=\"%s\", port=%d\n", http_hostname,
- http_port));
+ return (0);
+ }
/*
- * Reconnect to the correct server as needed...
+ * Create the print job...
*/
- if (!strcasecmp(http_hostname, hostname) && port == http_port)
- http2 = http;
- else if ((http2 = httpConnectEncrypt(hostname, port,
- cupsEncryption())) == NULL)
- {
- DEBUG_puts("Unable to connect to server!");
-
- return (NULL);
- }
+ if ((job_id = cupsCreateJob(http, name, title, num_options, options)) == 0)
+ return (0);
/*
- * Get a temp file...
+ * Send each of the files...
*/
- if ((fd = cupsTempFd(cg->ppd_filename, sizeof(cg->ppd_filename))) < 0)
+ if (cupsGetOption("raw", num_options, options))
+ format = CUPS_FORMAT_RAW;
+ else if ((format = cupsGetOption("document-format", num_options,
+ options)) == NULL)
+ format = CUPS_FORMAT_AUTO;
+
+ for (i = 0; i < num_files; i ++)
{
/*
- * Can't open file; close the server connection and return NULL...
+ * Start the next file...
*/
- _cupsSetError(IPP_INTERNAL_ERROR, strerror(errno));
+ if ((docname = strrchr(files[i], '/')) != NULL)
+ docname ++;
+ else
+ docname = files[i];
- if (http2 != http)
- httpClose(http2);
+ if ((fp = cupsFileOpen(files[i], "rb")) == NULL)
+ {
+ /*
+ * Unable to open print file, cancel the job and return...
+ */
- return (NULL);
- }
+ _cupsSetError(IPP_STATUS_ERROR_DOCUMENT_ACCESS, NULL, 0);
+ goto cancel_job;
+ }
- /*
- * And send a request to the HTTP server...
- */
+ status = cupsStartDocument(http, name, job_id, docname, format,
+ i == (num_files - 1));
- strlcat(resource, ".ppd", sizeof(resource));
+ while (status == HTTP_STATUS_CONTINUE &&
+ (bytes = cupsFileRead(fp, buffer, sizeof(buffer))) > 0)
+ status = cupsWriteRequestData(http, buffer, (size_t)bytes);
- status = cupsGetFd(http2, resource, fd);
+ cupsFileClose(fp);
- close(fd);
+ if (status != HTTP_STATUS_CONTINUE || cupsFinishDocument(http, name) != IPP_STATUS_OK)
+ {
+ /*
+ * Unable to queue, cancel the job and return...
+ */
- if (http2 != http)
- httpClose(http2);
-
- /*
- * See if we actually got the file or an error...
- */
-
- if (status != HTTP_OK)
- {
- switch (status)
- {
- case HTTP_NOT_FOUND :
- _cupsSetError(IPP_NOT_FOUND, httpStatus(status));
- break;
-
- case HTTP_UNAUTHORIZED :
- _cupsSetError(IPP_NOT_AUTHORIZED, httpStatus(status));
- break;
-
- default :
- DEBUG_printf(("HTTP error %d mapped to IPP_SERVICE_UNAVAILABLE!\n",
- status));
- _cupsSetError(IPP_SERVICE_UNAVAILABLE, httpStatus(status));
- break;
+ goto cancel_job;
}
-
- unlink(cg->ppd_filename);
-
- return (NULL);
- }
-
- /*
- * Return the PPD file...
- */
-
- return (cg->ppd_filename);
-}
-
-
-/*
- * 'cupsGetPrinters()' - Get a list of printers from the default server.
- *
- * This function is deprecated - use cupsGetDests() instead.
- *
- * @deprecated@
- */
-
-int /* O - Number of printers */
-cupsGetPrinters(char ***printers) /* O - Printers */
-{
- int n; /* Number of printers */
- ipp_t *request, /* IPP Request */
- *response; /* IPP Response */
- ipp_attribute_t *attr; /* Current attribute */
- cups_lang_t *language; /* Default language */
- char **temp; /* Temporary pointer */
- _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
-
-
- if (printers == NULL)
- {
- _cupsSetError(IPP_INTERNAL_ERROR, NULL);
-
- return (0);
- }
-
- /*
- * Try to connect to the server...
- */
-
- if (!cups_connect("default", NULL, NULL))
- {
- DEBUG_puts("Unable to connect to server!");
-
- return (0);
- }
-
- /*
- * Build a CUPS_GET_PRINTERS request, which requires the following
- * attributes:
- *
- * attributes-charset
- * attributes-natural-language
- * requested-attributes
- */
-
- request = ippNew();
-
- request->request.op.operation_id = CUPS_GET_PRINTERS;
- request->request.op.request_id = 1;
-
- language = cupsLangDefault();
-
- ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_CHARSET,
- "attributes-charset", NULL, cupsLangEncoding(language));
-
- ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_LANGUAGE,
- "attributes-natural-language", NULL, language->language);
-
- cupsLangFree(language);
-
- ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD,
- "requested-attributes", NULL, "printer-name");
-
- ippAddInteger(request, IPP_TAG_OPERATION, IPP_TAG_ENUM,
- "printer-type", 0);
-
- ippAddInteger(request, IPP_TAG_OPERATION, IPP_TAG_ENUM,
- "printer-type-mask", CUPS_PRINTER_CLASS);
-
- /*
- * Do the request and get back a response...
- */
-
- n = 0;
- *printers = NULL;
-
- if ((response = cupsDoRequest(cg->http, request, "/")) != NULL)
- {
- for (attr = response->attrs; attr != NULL; attr = attr->next)
- if (attr->name != NULL &&
- strcasecmp(attr->name, "printer-name") == 0 &&
- attr->value_tag == IPP_TAG_NAME)
- {
- if (n == 0)
- temp = malloc(sizeof(char *));
- else
- temp = realloc(*printers, sizeof(char *) * (n + 1));
-
- if (temp == NULL)
- {
- /*
- * Ran out of memory!
- */
-
- while (n > 0)
- {
- n --;
- free((*printers)[n]);
- }
-
- free(*printers);
- ippDelete(response);
- return (0);
- }
-
- *printers = temp;
- temp[n] = strdup(attr->values[0].string.text);
- n ++;
- }
-
- ippDelete(response);
- }
-
- return (n);
-}
-
-
-/*
- * 'cupsGetServerPPD()' - Get an available PPD file from the server.
- *
- * This function returns the named PPD file from the server. The
- * list of available PPDs is provided by the IPP CUPS_GET_PPDS
- * operation.
- *
- * You must remove (unlink) the PPD file when you are finished with
- * it. The PPD filename is stored in a static location that will be
- * overwritten on the next call to cupsGetPPD(), cupsGetPPD2(), or
- * cupsGetServerPPD().
- *
- * @since CUPS 1.3@
- */
-
-char * /* O - Name of PPD file or NULL on error */
-cupsGetServerPPD(http_t *http, /* I - HTTP connection */
- const char *name) /* I - Name of PPD file ("ppd-name") */
-{
- int fd; /* PPD file descriptor */
- ipp_t *request; /* IPP request */
- _cups_globals_t *cg = _cupsGlobals();
- /* Pointer to library globals */
-
-
- /*
- * Range check input...
- */
-
- if (!http || !name)
- {
- if (!http)
- _cupsSetError(IPP_INTERNAL_ERROR, "No HTTP connection!");
- else
- _cupsSetError(IPP_INTERNAL_ERROR, "No PPD name!");
-
- return (NULL);
}
- /*
- * Get a temp file...
- */
-
- if ((fd = cupsTempFd(cg->ppd_filename, sizeof(cg->ppd_filename))) < 0)
- {
- /*
- * Can't open file; close the server connection and return NULL...
- */
-
- _cupsSetError(IPP_INTERNAL_ERROR, strerror(errno));
-
- return (NULL);
- }
+ return (job_id);
/*
- * Get the PPD file...
+ * If we get here, something happened while sending the print job so we need
+ * to cancel the job without setting the last error (since we need to preserve
+ * the current error...
*/
- request = ippNewRequest(CUPS_GET_PPD);
- ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "ppd-name", NULL,
- name);
-
- ippDelete(cupsDoIORequest(http, request, "/", -1, fd));
-
- close(fd);
+ cancel_job:
- if (cupsLastError() != IPP_OK)
- {
- unlink(cg->ppd_filename);
- return (NULL);
- }
- else
- return (cg->ppd_filename);
-}
+ cancel_status = cg->last_error;
+ cancel_message = cg->last_status_message ?
+ _cupsStrRetain(cg->last_status_message) : NULL;
+ cupsCancelJob2(http, name, job_id, 0);
-/*
- * 'cupsLastError()' - Return the last IPP status code.
- */
+ cg->last_error = cancel_status;
+ cg->last_status_message = cancel_message;
-ipp_status_t /* O - IPP status code from last request */
-cupsLastError(void)
-{
- return (_cupsGlobals()->last_error);
+ return (0);
}
/*
- * 'cupsLastErrorString()' - Return the last IPP status-message.
+ * 'cupsStartDocument()' - Add a document to a job created with cupsCreateJob().
*
- * @since CUPS 1.2@
- */
-
-const char * /* O - status-message text from last request */
-cupsLastErrorString(void)
-{
- return (_cupsGlobals()->last_status_message);
-}
-
-
-/*
- * 'cupsPrintFile()' - Print a file to a printer or class on the default server.
- */
-
-int /* O - Job ID */
-cupsPrintFile(const char *name, /* I - Printer or class name */
- const char *filename, /* I - File to print */
- const char *title, /* I - Title of job */
- int num_options,/* I - Number of options */
- cups_option_t *options) /* I - Options */
-{
- DEBUG_printf(("cupsPrintFile(name=\"%s\", filename=\"%s\", "
- "title=\"%s\", num_options=%d, options=%p)\n",
- name, filename, title, num_options, options));
-
- return (cupsPrintFiles(name, 1, &filename, title, num_options, options));
-}
-
-
-/*
- * 'cupsPrintFile2()' - Print a file to a printer or class on the specified server.
+ * Use @link cupsWriteRequestData@ to write data for the document and
+ * @link cupsFinishDocument@ to finish the document and get the submission status.
*
- * @since CUPS 1.1.21@
- */
-
-int /* O - Job ID */
-cupsPrintFile2(http_t *http, /* I - HTTP connection */
- const char *name, /* I - Printer or class name */
- const char *filename, /* I - File to print */
- const char *title, /* I - Title of job */
- int num_options,
- /* I - Number of options */
- cups_option_t *options) /* I - Options */
-{
- DEBUG_printf(("cupsPrintFile2(http=%p, name=\"%s\", filename=\"%s\", "
- "title=\"%s\", num_options=%d, options=%p)\n",
- http, name, filename, title, num_options, options));
-
- return (cupsPrintFiles2(http, name, 1, &filename, title, num_options, options));
-}
-
-
-/*
- * 'cupsPrintFiles()' - Print one or more files to a printer or class on the
- * default server.
- */
-
-int /* O - Job ID */
-cupsPrintFiles(const char *name, /* I - Printer or class name */
- int num_files, /* I - Number of files */
- const char **files, /* I - File(s) to print */
- const char *title, /* I - Title of job */
- int num_options,
- /* I - Number of options */
- cups_option_t *options) /* I - Options */
-{
- _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
-
- DEBUG_printf(("cupsPrintFiles(name=\"%s\", num_files=%d, "
- "files=%p, title=\"%s\", num_options=%d, options=%p)\n",
- name, num_files, files, title, num_options, options));
-
-
- /*
- * Setup a connection and request data...
- */
-
- if (!cups_connect(name, NULL, NULL))
- {
- DEBUG_printf(("cupsPrintFiles: Unable to open connection - %s.\n",
- strerror(errno)));
- DEBUG_puts("Unable to connect to server!");
-
- return (0);
- }
-
- /*
- * Print the file(s)...
- */
-
- return (cupsPrintFiles2(cg->http, name, num_files, files, title,
- num_options, options));
-}
-
-
-
-/*
- * 'cupsPrintFiles2()' - Print one or more files to a printer or class on the
- * specified server.
+ * The MIME type constants @code CUPS_FORMAT_AUTO@, @code CUPS_FORMAT_PDF@,
+ * @code CUPS_FORMAT_POSTSCRIPT@, @code CUPS_FORMAT_RAW@, and
+ * @code CUPS_FORMAT_TEXT@ are provided for the "format" argument, although
+ * any supported MIME type string can be supplied.
*
- * @since CUPS 1.1.21@
+ * @since CUPS 1.4/OS X 10.6@
*/
-int /* O - Job ID */
-cupsPrintFiles2(http_t *http, /* I - HTTP connection */
- const char *name, /* I - Printer or class name */
- int num_files,/* I - Number of files */
- const char **files, /* I - File(s) to print */
- const char *title, /* I - Title of job */
- int num_options,
- /* I - Number of options */
- cups_option_t *options) /* I - Options */
+http_status_t /* O - HTTP status of request */
+cupsStartDocument(
+ http_t *http, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
+ const char *name, /* I - Destination name */
+ int job_id, /* I - Job ID from @link cupsCreateJob@ */
+ const char *docname, /* I - Name of document */
+ const char *format, /* I - MIME type or @code CUPS_FORMAT_foo@ */
+ int last_document) /* I - 1 for last document in job, 0 otherwise */
{
- int i; /* Looping var */
- const char *val; /* Pointer to option value */
- ipp_t *request; /* IPP request */
- ipp_t *response; /* IPP response */
- ipp_attribute_t *attr; /* IPP job-id attribute */
- char uri[HTTP_MAX_URI]; /* Printer URI */
- cups_lang_t *language; /* Language to use */
- int jobid; /* New job ID */
- const char *base; /* Basename of current filename */
-
-
- DEBUG_printf(("cupsPrintFiles(http=%p, name=\"%s\", num_files=%d, "
- "files=%p, title=\"%s\", num_options=%d, options=%p)\n",
- http, name, num_files, files, title, num_options, options));
-
- /*
- * Range check input...
- */
-
- if (!http || !name || num_files < 1 || files == NULL)
- {
- _cupsSetError(IPP_INTERNAL_ERROR, NULL);
-
- return (0);
- }
-
- /*
- * Setup the printer URI...
- */
-
- if (httpAssembleURIf(HTTP_URI_CODING_ALL, uri, sizeof(uri), "ipp", NULL,
- "localhost", 0, "/printers/%s", name) != HTTP_URI_OK)
- {
- _cupsSetError(IPP_INTERNAL_ERROR, NULL);
-
- return (0);
- }
-
- /*
- * Setup the request data...
- */
+ char resource[1024], /* Resource for destinatio */
+ printer_uri[1024]; /* Printer URI */
+ ipp_t *request; /* Send-Document request */
+ http_status_t status; /* HTTP status */
- language = cupsLangDefault();
/*
- * Build a standard CUPS URI for the printer and fill the standard IPP
- * attributes...
+ * Create a Send-Document request...
*/
- if ((request = ippNew()) == NULL)
+ if ((request = ippNewRequest(IPP_OP_SEND_DOCUMENT)) == NULL)
{
- _cupsSetError(IPP_INTERNAL_ERROR, NULL);
-
- return (0);
+ _cupsSetError(IPP_STATUS_ERROR_INTERNAL, strerror(ENOMEM), 0);
+ return (HTTP_STATUS_ERROR);
}
- request->request.op.operation_id = num_files == 1 ? IPP_PRINT_JOB :
- IPP_CREATE_JOB;
- request->request.op.request_id = 1;
-
- ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_CHARSET,
- "attributes-charset", NULL, cupsLangEncoding(language));
-
- ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_LANGUAGE,
- "attributes-natural-language", NULL,
- language != NULL ? language->language : "C");
+ httpAssembleURIf(HTTP_URI_CODING_ALL, printer_uri, sizeof(printer_uri), "ipp",
+ NULL, "localhost", ippPort(), "/printers/%s", name);
+ snprintf(resource, sizeof(resource), "/printers/%s", name);
ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri",
- NULL, uri);
-
+ NULL, printer_uri);
+ ippAddInteger(request, IPP_TAG_OPERATION, IPP_TAG_INTEGER, "job-id", job_id);
ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "requesting-user-name",
NULL, cupsUser());
-
- if (title)
- ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "job-name", NULL,
- title);
-
- /*
- * Then add all options...
- */
-
- cupsEncodeOptions(request, num_options, options);
-
- /*
- * Do the request...
- */
-
- snprintf(uri, sizeof(uri), "/printers/%s", name);
-
- if (num_files == 1)
- response = cupsDoFileRequest(http, request, uri, *files);
- else
- response = cupsDoRequest(http, request, uri);
-
- if (response == NULL)
- jobid = 0;
- else if (response->request.status.status_code > IPP_OK_CONFLICT)
- {
- DEBUG_printf(("IPP response code was 0x%x!\n",
- response->request.status.status_code));
- jobid = 0;
- }
- else if ((attr = ippFindAttribute(response, "job-id", IPP_TAG_INTEGER)) == NULL)
- {
- DEBUG_puts("No job ID!");
-
- _cupsSetError(IPP_INTERNAL_ERROR, NULL);
-
- jobid = 0;
- }
- else
- jobid = attr->values[0].integer;
-
- if (response != NULL)
- ippDelete(response);
-
- /*
- * Handle multiple file jobs if the create-job operation worked...
- */
-
- if (jobid > 0 && num_files > 1)
- for (i = 0; i < num_files; i ++)
- {
- /*
- * Build a standard CUPS URI for the job and fill the standard IPP
- * attributes...
- */
-
- if ((request = ippNew()) == NULL)
- return (0);
-
- request->request.op.operation_id = IPP_SEND_DOCUMENT;
- request->request.op.request_id = 1;
-
- snprintf(uri, sizeof(uri), "ipp://localhost/jobs/%d", jobid);
-
- ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_CHARSET,
- "attributes-charset", NULL, cupsLangEncoding(language));
-
- ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_LANGUAGE,
- "attributes-natural-language", NULL,
- language != NULL ? language->language : "C");
-
- ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "job-uri",
- NULL, uri);
-
- /*
- * Handle raw print files...
- */
-
- if (cupsGetOption("raw", num_options, options))
- ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_MIMETYPE,
- "document-format", NULL, "application/vnd.cups-raw");
- else if ((val = cupsGetOption("document-format", num_options,
- options)) != NULL)
- ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_MIMETYPE,
- "document-format", NULL, val);
- else
- ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_MIMETYPE,
- "document-format", NULL, "application/octet-stream");
-
- ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME,
- "requesting-user-name", NULL, cupsUser());
-
- /*
- * Add the original document filename...
- */
-
- if ((base = strrchr(files[i], '/')) != NULL)
- base ++;
- else
- base = files[i];
-
- ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "document-name",
- NULL, base);
-
- /*
- * Is this the last document?
- */
-
- if (i == (num_files - 1))
- ippAddBoolean(request, IPP_TAG_OPERATION, "last-document", 1);
-
- /*
- * Send the file...
- */
-
- snprintf(uri, sizeof(uri), "/printers/%s", name);
-
- if ((response = cupsDoFileRequest(http, request, uri,
- files[i])) != NULL)
- ippDelete(response);
- }
-
- cupsLangFree(language);
-
- return (jobid);
-}
-
-
-/*
- * 'cups_connect()' - Connect to the specified host...
- */
-
-static char * /* I - Printer name or NULL */
-cups_connect(const char *name, /* I - Destination (printer[@host]) */
- char *printer, /* O - Printer name [HTTP_MAX_URI] */
- char *hostname) /* O - Hostname [HTTP_MAX_URI] */
-{
- char hostbuf[HTTP_MAX_URI], /* Name of host */
- http_hostname[HTTP_MAX_HOST]; /* Hostname associated with connection */
- _cups_globals_t *cg = _cupsGlobals();/* Pointer to library globals */
-
-
- DEBUG_printf(("cups_connect(\"%s\", %p, %p)\n", name, printer, hostname));
-
- if (name == NULL)
- {
- _cupsSetError(IPP_BAD_REQUEST, NULL);
-
- return (NULL);
- }
-
- /*
- * All jobs are now queued to cupsServer() to avoid hostname
- * resolution problems and to ensure that the user sees all
- * locally queued jobs locally.
- */
-
- strlcpy(hostbuf, cupsServer(), sizeof(hostbuf));
-
- httpGetHostname(cg->http, http_hostname, sizeof(http_hostname));
-
- if (hostname != NULL)
- strlcpy(hostname, hostbuf, HTTP_MAX_URI);
- else
- hostname = hostbuf;
-
- if (printer != NULL)
- strlcpy(printer, name, HTTP_MAX_URI);
- else
- printer = (char *)name;
-
- if (cg->http != NULL)
- {
- if (!strcasecmp(http_hostname, hostname))
- return (printer);
-
- httpClose(cg->http);
- }
-
- DEBUG_printf(("connecting to %s on port %d...\n", hostname, ippPort()));
-
- if ((cg->http = httpConnectEncrypt(hostname, ippPort(),
- cupsEncryption())) == NULL)
- {
- DEBUG_puts("Unable to connect to server!");
-
- _cupsSetError(IPP_SERVICE_UNAVAILABLE, strerror(errno));
-
- return (NULL);
- }
- else
- return (printer);
-}
-
-
-/*
- * 'cups_get_printer_uri()' - Get the printer-uri-supported attribute for the first printer in a class.
- */
-
-static int /* O - 1 on success, 0 on failure */
-cups_get_printer_uri(
- http_t *http, /* I - HTTP connection */
- const char *name, /* I - Name of printer or class */
- char *host, /* I - Hostname buffer */
- int hostsize, /* I - Size of hostname buffer */
- int *port, /* O - Port number */
- char *resource, /* I - Resource buffer */
- int resourcesize, /* I - Size of resource buffer */
- int depth) /* I - Depth of query */
-{
- int i; /* Looping var */
- int http_port; /* Port number */
- http_t *http2; /* Alternate HTTP connection */
- ipp_t *request, /* IPP request */
- *response; /* IPP response */
- ipp_attribute_t *attr; /* Current attribute */
- char uri[HTTP_MAX_URI], /* printer-uri attribute */
- scheme[HTTP_MAX_URI], /* Scheme name */
- username[HTTP_MAX_URI], /* Username:password */
- classname[255], /* Temporary class name */
- http_hostname[HTTP_MAX_HOST];
- /* Hostname associated with connection */
- static const char * const requested_attrs[] =
- { /* Requested attributes */
- "printer-uri-supported",
- "printer-type",
- "member-uris"
- };
-
-
- DEBUG_printf(("cups_get_printer_uri(http=%p, name=\"%s\", host=%p, "
- "hostsize=%d, resource=%p, resourcesize=%d, depth=%d)\n",
- http, name ? name : "(null)", host, hostsize,
- resource, resourcesize, depth));
-
- /*
- * Setup the printer URI...
- */
-
- if (httpAssembleURIf(HTTP_URI_CODING_ALL, uri, sizeof(uri), "ipp", NULL,
- "localhost", 0, "/printers/%s", name) != HTTP_URI_OK)
- {
- _cupsSetError(IPP_INTERNAL_ERROR, "Unable to create printer-uri!");
-
- *host = '\0';
- *resource = '\0';
-
- return (0);
- }
-
- DEBUG_printf(("cups_get_printer_uri: printer-uri=\"%s\"\n", uri));
-
- /*
- * Get the hostname and port number we are connected to...
- */
-
- httpGetHostname(http, http_hostname, sizeof(http_hostname));
-
-#ifdef AF_INET6
- if (http->hostaddr->addr.sa_family == AF_INET6)
- http_port = ntohs(http->hostaddr->ipv6.sin6_port);
- else
-#endif /* AF_INET6 */
- if (http->hostaddr->addr.sa_family == AF_INET)
- http_port = ntohs(http->hostaddr->ipv4.sin_port);
- else
- http_port = ippPort();
-
- /*
- * Build an IPP_GET_PRINTER_ATTRIBUTES request, which requires the following
- * attributes:
- *
- * attributes-charset
- * attributes-natural-language
- * printer-uri
- * requested-attributes
- */
-
- request = ippNewRequest(IPP_GET_PRINTER_ATTRIBUTES);
-
- ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri",
- NULL, uri);
-
- ippAddStrings(request, IPP_TAG_OPERATION, IPP_TAG_NAME,
- "requested-attributes",
- sizeof(requested_attrs) / sizeof(requested_attrs[0]),
- NULL, requested_attrs);
+ if (docname)
+ ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "document-name",
+ NULL, docname);
+ if (format)
+ ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_MIMETYPE,
+ "document-format", NULL, format);
+ ippAddBoolean(request, IPP_TAG_OPERATION, "last-document", (char)last_document);
/*
- * Do the request and get back a response...
+ * Send and delete the request, then return the status...
*/
- if ((response = cupsDoRequest(http, request, "/")) != NULL)
- {
- if ((attr = ippFindAttribute(response, "member-uris", IPP_TAG_URI)) != NULL)
- {
- /*
- * Get the first actual printer name in the class...
- */
-
- for (i = 0; i < attr->num_values; i ++)
- {
- httpSeparateURI(HTTP_URI_CODING_ALL, attr->values[i].string.text,
- scheme, sizeof(scheme), username, sizeof(username),
- host, hostsize, port, resource, resourcesize);
- if (!strncmp(resource, "/printers/", 10))
- {
- /*
- * Found a printer!
- */
+ status = cupsSendRequest(http, request, resource, CUPS_LENGTH_VARIABLE);
- ippDelete(response);
+ ippDelete(request);
- return (1);
- }
- }
-
- /*
- * No printers in this class - try recursively looking for a printer,
- * but not more than 3 levels deep...
- */
-
- if (depth < 3)
- {
- for (i = 0; i < attr->num_values; i ++)
- {
- httpSeparateURI(HTTP_URI_CODING_ALL, attr->values[i].string.text,
- scheme, sizeof(scheme), username, sizeof(username),
- host, hostsize, port, resource, resourcesize);
- if (!strncmp(resource, "/classes/", 9))
- {
- /*
- * Found a class! Connect to the right server...
- */
-
- if (!strcasecmp(http_hostname, host) && *port == http_port)
- http2 = http;
- else if ((http2 = httpConnectEncrypt(host, *port,
- cupsEncryption())) == NULL)
- {
- DEBUG_puts("Unable to connect to server!");
-
- continue;
- }
-
- /*
- * Look up printers on that server...
- */
-
- strlcpy(classname, resource + 9, sizeof(classname));
-
- cups_get_printer_uri(http2, classname, host, hostsize, port,
- resource, resourcesize, depth + 1);
-
- /*
- * Close the connection as needed...
- */
-
- if (http2 != http)
- httpClose(http2);
-
- if (*host)
- return (1);
- }
- }
- }
- }
- else if ((attr = ippFindAttribute(response, "printer-uri-supported",
- IPP_TAG_URI)) != NULL)
- {
- httpSeparateURI(HTTP_URI_CODING_ALL, attr->values[0].string.text,
- scheme, sizeof(scheme), username, sizeof(username),
- host, hostsize, port, resource, resourcesize);
- ippDelete(response);
-
- return (1);
- }
-
- ippDelete(response);
- }
-
- if (cupsLastError() != IPP_NOT_FOUND)
- _cupsSetError(IPP_INTERNAL_ERROR, "No printer-uri found!");
-
- *host = '\0';
- *resource = '\0';
-
- return (0);
+ return (status);
}
-
-
-/*
- * End of "$Id: util.c 6649 2007-07-11 21:46:42Z mike $".
- */
projects / thirdparty / cups.git / blobdiff