]> git.ipfire.org Git - thirdparty/cups.git/blame - cups/util.c
Merge changes from CUPS 1.4svn-r8469.
[thirdparty/cups.git] / cups / util.c
CommitLineData
ef416fc2 1/*
b19ccc9e 2 * "$Id: util.c 7850 2008-08-20 00:07:25Z mike $"
ef416fc2 3 *
4 * Printing utilities for the Common UNIX Printing System (CUPS).
5 *
d1c13e16 6 * Copyright 2007-2009 by Apple Inc.
ef416fc2 7 * Copyright 1997-2006 by Easy Software Products.
8 *
9 * These coded instructions, statements, and computer programs are the
bc44d920 10 * property of Apple Inc. and are protected by Federal copyright
11 * law. Distribution and use rights are outlined in the file "LICENSE.txt"
12 * which should have been included with this file. If this file is
13 * file is missing or damaged, see the license at "http://www.cups.org/".
ef416fc2 14 *
15 * This file is subject to the Apple OS-Developed Software exception.
16 *
17 * Contents:
18 *
fa73b229 19 * cupsCancelJob() - Cancel a print job on the default server.
3d052e43
MS
20 * cupsCancelJob2() - Cancel or purge a print job.
21 * cupsCreateJob() - Create an empty job.
22 * cupsFinishDocument() - Finish sending a document.
fa73b229 23 * cupsFreeJobs() - Free memory used by job data.
24 * cupsGetClasses() - Get a list of printer classes from the default
25 * server.
3d052e43
MS
26 * cupsGetDefault() - Get the default printer or class for the default
27 * server.
28 * cupsGetDefault2() - Get the default printer or class for the specified
fa73b229 29 * server.
fa73b229 30 * cupsGetJobs() - Get the jobs from the default server.
31 * cupsGetJobs2() - Get the jobs from the specified server.
32 * cupsGetPPD() - Get the PPD file for a printer on the default
33 * server.
3d052e43 34 * cupsGetPPD2() - Get the PPD file for a printer from the specified
fa73b229 35 * server.
2e4ff8af
MS
36 * cupsGetPPD3() - Get the PPD file for a printer on the specified
37 * server if it has changed.
fa73b229 38 * cupsGetPrinters() - Get a list of printers from the default server.
b94498cf 39 * cupsGetServerPPD() - Get an available PPD file from the server.
fa73b229 40 * cupsLastError() - Return the last IPP status code.
41 * cupsLastErrorString() - Return the last IPP status-message.
42 * cupsPrintFile() - Print a file to a printer or class on the default
43 * server.
44 * cupsPrintFile2() - Print a file to a printer or class on the
45 * specified server.
46 * cupsPrintFiles() - Print one or more files to a printer or class on
47 * the default server.
48 * cupsPrintFiles2() - Print one or more files to a printer or class on
49 * the specified server.
3d052e43
MS
50 * cupsStartDocument() - Add a document to a job created with
51 * cupsCreateJob().
52 * _cupsConnect() - Get the default server connection...
fa73b229 53 * cups_get_printer_uri() - Get the printer-uri-supported attribute for the
54 * first printer in a class.
ef416fc2 55 */
56
57/*
58 * Include necessary headers...
59 */
60
61#include "globals.h"
62#include "debug.h"
63#include <stdlib.h>
64#include <errno.h>
65#include <fcntl.h>
66#include <sys/stat.h>
67#if defined(WIN32) || defined(__EMX__)
68# include <io.h>
69#else
70# include <unistd.h>
71#endif /* WIN32 || __EMX__ */
72
73
74/*
75 * Local functions...
76 */
77
fa73b229 78static int cups_get_printer_uri(http_t *http, const char *name,
79 char *host, int hostsize, int *port,
80 char *resource, int resourcesize,
81 int depth);
ef416fc2 82
83
84/*
85 * 'cupsCancelJob()' - Cancel a print job on the default server.
86 *
5a738aea
MS
87 * Pass @code CUPS_JOBID_ALL@ to cancel all jobs or @code CUPS_JOBID_CURRENT@
88 * to cancel the current job on the named destination.
89 *
90 * Use the @link cupsLastError@ and @link cupsLastErrorString@ functions to get
ef416fc2 91 * the cause of any failure.
92 */
93
94int /* O - 1 on success, 0 on failure */
95cupsCancelJob(const char *name, /* I - Name of printer or class */
568fa3fa 96 int job_id) /* I - Job ID, @code CUPS_JOBID_CURRENT@ for the current job, or @code CUPS_JOBID_ALL@ for all jobs */
ef416fc2 97{
5a738aea 98 return (cupsCancelJob2(CUPS_HTTP_DEFAULT, name, job_id, 0)
3d052e43
MS
99 < IPP_REDIRECTION_OTHER_SITE);
100}
101
102
103/*
104 * 'cupsCancelJob2()' - Cancel or purge a print job.
105 *
106 * Canceled jobs remain in the job history while purged jobs are removed
107 * from the job history.
108 *
5a738aea
MS
109 * Pass @code CUPS_JOBID_ALL@ to cancel all jobs or @code CUPS_JOBID_CURRENT@
110 * to cancel the current job on the named destination.
111 *
112 * Use the @link cupsLastError@ and @link cupsLastErrorString@ functions to get
3d052e43
MS
113 * the cause of any failure.
114 *
115 * @since CUPS 1.4@
116 */
117
118ipp_status_t /* O - IPP status */
568fa3fa 119cupsCancelJob2(http_t *http, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
5a738aea 120 const char *name, /* I - Name of printer or class */
568fa3fa 121 int job_id, /* I - Job ID, @code CUPS_JOBID_CURRENT@ for the current job, or @code CUPS_JOBID_ALL@ for all jobs */
5a738aea 122 int purge) /* I - 1 to purge, 0 to cancel */
3d052e43 123{
5a738aea 124 char uri[HTTP_MAX_URI]; /* Job/printer URI */
3d052e43 125 ipp_t *request; /* IPP request */
ef416fc2 126
127
128 /*
3d052e43 129 * Range check input...
ef416fc2 130 */
131
5a738aea 132 if (job_id < -1 || (!name && job_id == 0))
ef416fc2 133 {
749b1e90 134 _cupsSetError(IPP_INTERNAL_ERROR, strerror(EINVAL), 0);
ef416fc2 135 return (0);
136 }
137
138 /*
3d052e43 139 * Connect to the default server as needed...
ef416fc2 140 */
141
3d052e43
MS
142 if (!http)
143 if ((http = _cupsConnect()) == NULL)
144 return (IPP_SERVICE_UNAVAILABLE);
ef416fc2 145
146 /*
5a738aea 147 * Build an IPP_CANCEL_JOB or IPP_PURGE_JOBS request, which requires the following
ef416fc2 148 * attributes:
149 *
150 * attributes-charset
151 * attributes-natural-language
5a738aea 152 * job-uri or printer-uri + job-id
3d052e43 153 * requesting-user-name
5a738aea 154 * [purge-job] or [purge-jobs]
ef416fc2 155 */
156
5a738aea 157 request = ippNewRequest(job_id < 0 ? IPP_PURGE_JOBS : IPP_CANCEL_JOB);
ef416fc2 158
5a738aea
MS
159 if (name)
160 {
161 httpAssembleURIf(HTTP_URI_CODING_ALL, uri, sizeof(uri), "ipp", NULL,
162 "localhost", ippPort(), "/printers/%s", name);
163
164 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri", NULL,
165 uri);
166 ippAddInteger(request, IPP_TAG_OPERATION, IPP_TAG_INTEGER, "job-id",
167 job_id);
168 }
169 else if (job_id > 0)
170 {
171 snprintf(uri, sizeof(uri), "ipp://localhost/jobs/%d", job_id);
172
173 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "job-uri", NULL, uri);
174 }
ef416fc2 175
176 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "requesting-user-name",
177 NULL, cupsUser());
5a738aea
MS
178
179 if (purge && job_id >= 0)
3d052e43 180 ippAddBoolean(request, IPP_TAG_OPERATION, "purge-job", 1);
5a738aea
MS
181 else if (!purge && job_id < 0)
182 ippAddBoolean(request, IPP_TAG_OPERATION, "purge-jobs", 0);
ef416fc2 183
184 /*
185 * Do the request...
186 */
187
3d052e43
MS
188 ippDelete(cupsDoRequest(http, request, "/jobs/"));
189
190 return (cupsLastError());
191}
192
193
194/*
568fa3fa 195 * 'cupsCreateJob()' - Create an empty job for streaming.
3d052e43 196 *
568fa3fa
MS
197 * Use this function when you want to stream print data using the
198 * @link cupsStartDocument@, @link cupsWriteRequestData@, and
199 * @link cupsFinishDocument@ functions. If you have one or more files to
200 * print, use the @link cupsPrintFile2@ or @link cupsPrintFiles2@ function
201 * instead.
3d052e43
MS
202 *
203 * @since CUPS 1.4@
204 */
205
206int /* O - Job ID or 0 on error */
207cupsCreateJob(
568fa3fa
MS
208 http_t *http, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
209 const char *name, /* I - Destination name */
3d052e43
MS
210 const char *title, /* I - Title of job */
211 int num_options, /* I - Number of options */
212 cups_option_t *options) /* I - Options */
213{
214 char printer_uri[1024], /* Printer URI */
215 resource[1024]; /* Printer resource */
216 ipp_t *request, /* Create-Job request */
217 *response; /* Create-Job response */
218 ipp_attribute_t *attr; /* job-id attribute */
219 int job_id = 0; /* job-id value */
220
221
222 DEBUG_printf(("cupsCreateJob(http=%p, name=\"%s\", title=\"%s\", "
223 "num_options=%d, options=%p)\n",
224 http, name, title, num_options, options));
225
226 /*
227 * Range check input...
228 */
229
230 if (!name)
231 {
749b1e90 232 _cupsSetError(IPP_INTERNAL_ERROR, strerror(EINVAL), 0);
3d052e43
MS
233 return (0);
234 }
235
236 /*
237 * Build a Create-Job request...
238 */
239
240 if ((request = ippNewRequest(IPP_CREATE_JOB)) == NULL)
241 {
749b1e90 242 _cupsSetError(IPP_INTERNAL_ERROR, strerror(ENOMEM), 0);
3d052e43
MS
243 return (0);
244 }
245
246 httpAssembleURIf(HTTP_URI_CODING_ALL, printer_uri, sizeof(printer_uri), "ipp",
247 NULL, "localhost", ippPort(), "/printers/%s", name);
248 snprintf(resource, sizeof(resource), "/printers/%s", name);
249
250 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri",
251 NULL, printer_uri);
252 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "requesting-user-name",
253 NULL, cupsUser());
254 if (title)
255 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "job-name", NULL,
256 title);
257 cupsEncodeOptions(request, num_options, options);
258
259 /*
260 * Send the request and get the job-id...
261 */
262
263 response = cupsDoRequest(http, request, resource);
264
265 if ((attr = ippFindAttribute(response, "job-id", IPP_TAG_INTEGER)) != NULL)
266 job_id = attr->values[0].integer;
267
268 ippDelete(response);
269
270 /*
271 * Return it...
272 */
273
274 return (job_id);
275}
276
277
278/*
279 * 'cupsFinishDocument()' - Finish sending a document.
280 *
5a738aea
MS
281 * The document must have been started using @link cupsStartDocument@.
282 *
3d052e43
MS
283 * @since CUPS 1.4@
284 */
285
286ipp_status_t /* O - Status of document submission */
568fa3fa
MS
287cupsFinishDocument(http_t *http, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
288 const char *name) /* I - Destination name */
3d052e43
MS
289{
290 char resource[1024]; /* Printer resource */
291
292
293 snprintf(resource, sizeof(resource), "/printers/%s", name);
ef416fc2 294
3d052e43
MS
295 ippDelete(cupsGetResponse(http, resource));
296
297 return (cupsLastError());
ef416fc2 298}
299
300
ef416fc2 301/*
302 * 'cupsFreeJobs()' - Free memory used by job data.
303 */
304
305void
306cupsFreeJobs(int num_jobs, /* I - Number of jobs */
307 cups_job_t *jobs) /* I - Jobs */
308{
3d052e43
MS
309 int i; /* Looping var */
310 cups_job_t *job; /* Current job */
ef416fc2 311
312
3d052e43 313 if (num_jobs <= 0 || !jobs)
ef416fc2 314 return;
315
3d052e43 316 for (i = num_jobs, job = jobs; i > 0; i --, job ++)
ef416fc2 317 {
3d052e43
MS
318 _cupsStrFree(job->dest);
319 _cupsStrFree(job->user);
320 _cupsStrFree(job->format);
321 _cupsStrFree(job->title);
ef416fc2 322 }
323
324 free(jobs);
325}
326
327
328/*
329 * 'cupsGetClasses()' - Get a list of printer classes from the default server.
330 *
5a738aea 331 * This function is deprecated - use @link cupsGetDests@ instead.
ef416fc2 332 *
333 * @deprecated@
334 */
335
336int /* O - Number of classes */
337cupsGetClasses(char ***classes) /* O - Classes */
338{
339 int n; /* Number of classes */
340 ipp_t *request, /* IPP Request */
341 *response; /* IPP Response */
342 ipp_attribute_t *attr; /* Current attribute */
ef416fc2 343 char **temp; /* Temporary pointer */
3d052e43 344 http_t *http; /* Connection to server */
ef416fc2 345
346
3d052e43 347 if (!classes)
ef416fc2 348 {
749b1e90 349 _cupsSetError(IPP_INTERNAL_ERROR, strerror(EINVAL), 0);
ef416fc2 350
351 return (0);
352 }
353
3d052e43 354 *classes = NULL;
ef416fc2 355
3d052e43 356 if ((http = _cupsConnect()) == NULL)
ef416fc2 357 return (0);
ef416fc2 358
359 /*
360 * Build a CUPS_GET_CLASSES request, which requires the following
361 * attributes:
362 *
363 * attributes-charset
364 * attributes-natural-language
365 * requested-attributes
366 */
367
2e4ff8af 368 request = ippNewRequest(CUPS_GET_CLASSES);
ef416fc2 369
370 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD,
371 "requested-attributes", NULL, "printer-name");
372
373 /*
374 * Do the request and get back a response...
375 */
376
3d052e43 377 n = 0;
ef416fc2 378
3d052e43 379 if ((response = cupsDoRequest(http, request, "/")) != NULL)
ef416fc2 380 {
381 for (attr = response->attrs; attr != NULL; attr = attr->next)
382 if (attr->name != NULL &&
383 strcasecmp(attr->name, "printer-name") == 0 &&
384 attr->value_tag == IPP_TAG_NAME)
385 {
386 if (n == 0)
387 temp = malloc(sizeof(char *));
388 else
389 temp = realloc(*classes, sizeof(char *) * (n + 1));
390
391 if (temp == NULL)
392 {
393 /*
394 * Ran out of memory!
395 */
396
397 while (n > 0)
398 {
399 n --;
400 free((*classes)[n]);
401 }
402
403 free(*classes);
404 ippDelete(response);
405 return (0);
406 }
407
408 *classes = temp;
409 temp[n] = strdup(attr->values[0].string.text);
410 n ++;
411 }
412
413 ippDelete(response);
414 }
415
416 return (n);
417}
418
419
420/*
421 * 'cupsGetDefault()' - Get the default printer or class for the default server.
422 *
423 * This function returns the default printer or class as defined by
424 * the LPDEST or PRINTER environment variables. If these environment
425 * variables are not set, the server default destination is returned.
5a738aea
MS
426 * Applications should use the @link cupsGetDests@ and @link cupsGetDest@
427 * functions to get the user-defined default printer, as this function does
428 * not support the lpoptions-defined default printer.
ef416fc2 429 */
430
5a738aea 431const char * /* O - Default printer or @code NULL@ */
ef416fc2 432cupsGetDefault(void)
433{
ef416fc2 434 /*
435 * Return the default printer...
436 */
437
3d052e43 438 return (cupsGetDefault2(CUPS_HTTP_DEFAULT));
ef416fc2 439}
440
441
442/*
443 * 'cupsGetDefault2()' - Get the default printer or class for the specified server.
444 *
445 * This function returns the default printer or class as defined by
446 * the LPDEST or PRINTER environment variables. If these environment
447 * variables are not set, the server default destination is returned.
5a738aea
MS
448 * Applications should use the @link cupsGetDests@ and @link cupsGetDest@
449 * functions to get the user-defined default printer, as this function does
450 * not support the lpoptions-defined default printer.
ef416fc2 451 *
426c6a59 452 * @since CUPS 1.1.21/Mac OS X 10.4@
ef416fc2 453 */
454
5a738aea 455const char * /* O - Default printer or @code NULL@ */
568fa3fa 456cupsGetDefault2(http_t *http) /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
ef416fc2 457{
458 ipp_t *request, /* IPP Request */
459 *response; /* IPP Response */
460 ipp_attribute_t *attr; /* Current attribute */
ef416fc2 461 const char *var; /* Environment variable */
462 _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
463
464
465 /*
466 * First see if the LPDEST or PRINTER environment variables are
467 * set... However, if PRINTER is set to "lp", ignore it to work
468 * around a "feature" in most Linux distributions - the default
469 * user login scripts set PRINTER to "lp"...
470 */
471
472 if ((var = getenv("LPDEST")) != NULL)
473 return (var);
474 else if ((var = getenv("PRINTER")) != NULL && strcmp(var, "lp") != 0)
475 return (var);
476
477 /*
3d052e43 478 * Connect to the server as needed...
ef416fc2 479 */
480
481 if (!http)
3d052e43
MS
482 if ((http = _cupsConnect()) == NULL)
483 return (NULL);
ef416fc2 484
485 /*
486 * Build a CUPS_GET_DEFAULT request, which requires the following
487 * attributes:
488 *
489 * attributes-charset
490 * attributes-natural-language
491 */
492
2e4ff8af 493 request = ippNewRequest(CUPS_GET_DEFAULT);
ef416fc2 494
495 /*
496 * Do the request and get back a response...
497 */
498
499 if ((response = cupsDoRequest(http, request, "/")) != NULL)
500 {
3d052e43
MS
501 if ((attr = ippFindAttribute(response, "printer-name",
502 IPP_TAG_NAME)) != NULL)
ef416fc2 503 {
3d052e43
MS
504 strlcpy(cg->def_printer, attr->values[0].string.text,
505 sizeof(cg->def_printer));
ef416fc2 506 ippDelete(response);
507 return (cg->def_printer);
508 }
509
510 ippDelete(response);
511 }
512
513 return (NULL);
514}
515
516
517/*
518 * 'cupsGetJobs()' - Get the jobs from the default server.
5a738aea
MS
519 *
520 * A "whichjobs" value of @code CUPS_WHICHJOBS_ALL@ returns all jobs regardless
521 * of state, while @code CUPS_WHICHJOBS_ACTIVE@ returns jobs that are
522 * pending, processing, or held and @code CUPS_WHICHJOBS_COMPLETED@ returns
523 * jobs that are stopped, canceled, aborted, or completed.
ef416fc2 524 */
525
526int /* O - Number of jobs */
527cupsGetJobs(cups_job_t **jobs, /* O - Job data */
568fa3fa 528 const char *name, /* I - @code NULL@ = all destinations, otherwise show jobs for named destination */
ecdc0628 529 int myjobs, /* I - 0 = all users, 1 = mine */
5a738aea 530 int whichjobs) /* I - @code CUPS_WHICHJOBS_ALL@, @code CUPS_WHICHJOBS_ACTIVE@, or @code CUPS_WHICHJOBS_COMPLETED@ */
ef416fc2 531{
ef416fc2 532 /*
533 * Return the jobs...
534 */
535
5a738aea 536 return (cupsGetJobs2(CUPS_HTTP_DEFAULT, jobs, name, myjobs, whichjobs));
ef416fc2 537}
538
539
540
541/*
542 * 'cupsGetJobs2()' - Get the jobs from the specified server.
543 *
5a738aea
MS
544 * A "whichjobs" value of @code CUPS_WHICHJOBS_ALL@ returns all jobs regardless
545 * of state, while @code CUPS_WHICHJOBS_ACTIVE@ returns jobs that are
546 * pending, processing, or held and @code CUPS_WHICHJOBS_COMPLETED@ returns
547 * jobs that are stopped, canceled, aborted, or completed.
548 *
426c6a59 549 * @since CUPS 1.1.21/Mac OS X 10.4@
ef416fc2 550 */
551
552int /* O - Number of jobs */
568fa3fa 553cupsGetJobs2(http_t *http, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
ef416fc2 554 cups_job_t **jobs, /* O - Job data */
568fa3fa 555 const char *name, /* I - @code NULL@ = all destinations, otherwise show jobs for named destination */
ecdc0628 556 int myjobs, /* I - 0 = all users, 1 = mine */
5a738aea 557 int whichjobs) /* I - @code CUPS_WHICHJOBS_ALL@, @code CUPS_WHICHJOBS_ACTIVE@, or @code CUPS_WHICHJOBS_COMPLETED@ */
ef416fc2 558{
559 int n; /* Number of jobs */
560 ipp_t *request, /* IPP Request */
561 *response; /* IPP Response */
562 ipp_attribute_t *attr; /* Current attribute */
ef416fc2 563 cups_job_t *temp; /* Temporary pointer */
564 int id, /* job-id */
565 priority, /* job-priority */
566 size; /* job-k-octets */
567 ipp_jstate_t state; /* job-state */
568 time_t completed_time, /* time-at-completed */
569 creation_time, /* time-at-creation */
570 processing_time; /* time-at-processing */
571 const char *dest, /* job-printer-uri */
572 *format, /* document-format */
573 *title, /* job-name */
574 *user; /* job-originating-user-name */
575 char uri[HTTP_MAX_URI]; /* URI for jobs */
576 _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
577 static const char * const attrs[] = /* Requested attributes */
578 {
579 "job-id",
580 "job-priority",
581 "job-k-octets",
582 "job-state",
583 "time-at-completed",
584 "time-at-creation",
585 "time-at-processing",
586 "job-printer-uri",
587 "document-format",
588 "job-name",
589 "job-originating-user-name"
590 };
591
592
593 /*
594 * Range check input...
595 */
596
3d052e43 597 if (!jobs)
ef416fc2 598 {
749b1e90 599 _cupsSetError(IPP_INTERNAL_ERROR, strerror(EINVAL), 0);
ef416fc2 600
601 return (-1);
602 }
603
604 /*
605 * Get the right URI...
606 */
607
5a738aea 608 if (name)
ef416fc2 609 {
a4d04587 610 if (httpAssembleURIf(HTTP_URI_CODING_ALL, uri, sizeof(uri), "ipp", NULL,
5a738aea 611 "localhost", 0, "/printers/%s", name) != HTTP_URI_OK)
ef416fc2 612 {
749b1e90 613 _cupsSetError(IPP_INTERNAL_ERROR, _("Unable to create printer-uri!"), 1);
ef416fc2 614
615 return (-1);
616 }
617 }
618 else
b9faaae1 619 strcpy(uri, "ipp://localhost/");
ef416fc2 620
3d052e43
MS
621 if (!http)
622 if ((http = _cupsConnect()) == NULL)
623 return (-1);
ef416fc2 624
625 /*
626 * Build an IPP_GET_JOBS request, which requires the following
627 * attributes:
628 *
629 * attributes-charset
630 * attributes-natural-language
631 * printer-uri
632 * requesting-user-name
633 * which-jobs
634 * my-jobs
635 * requested-attributes
636 */
637
2e4ff8af 638 request = ippNewRequest(IPP_GET_JOBS);
ef416fc2 639
640 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI,
641 "printer-uri", NULL, uri);
642
643 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME,
644 "requesting-user-name", NULL, cupsUser());
645
646 if (myjobs)
647 ippAddBoolean(request, IPP_TAG_OPERATION, "my-jobs", 1);
648
5a738aea 649 if (whichjobs == CUPS_WHICHJOBS_COMPLETED)
ef416fc2 650 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD,
651 "which-jobs", NULL, "completed");
5a738aea 652 else if (whichjobs == CUPS_WHICHJOBS_ALL)
ecdc0628 653 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD,
654 "which-jobs", NULL, "all");
ef416fc2 655
656 ippAddStrings(request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD,
657 "requested-attributes", sizeof(attrs) / sizeof(attrs[0]),
658 NULL, attrs);
659
660 /*
661 * Do the request and get back a response...
662 */
663
664 n = 0;
665 *jobs = NULL;
666
667 if ((response = cupsDoRequest(http, request, "/")) != NULL)
668 {
3d052e43 669 for (attr = response->attrs; attr; attr = attr->next)
ef416fc2 670 {
671 /*
672 * Skip leading attributes until we hit a job...
673 */
674
3d052e43 675 while (attr && attr->group_tag != IPP_TAG_JOB)
ef416fc2 676 attr = attr->next;
677
3d052e43 678 if (!attr)
ef416fc2 679 break;
680
681 /*
682 * Pull the needed attributes from this job...
683 */
684
685 id = 0;
686 size = 0;
687 priority = 50;
688 state = IPP_JOB_PENDING;
689 user = "unknown";
690 dest = NULL;
691 format = "application/octet-stream";
692 title = "untitled";
693 creation_time = 0;
694 completed_time = 0;
695 processing_time = 0;
696
3d052e43 697 while (attr && attr->group_tag == IPP_TAG_JOB)
ef416fc2 698 {
3d052e43 699 if (!strcmp(attr->name, "job-id") &&
ef416fc2 700 attr->value_tag == IPP_TAG_INTEGER)
701 id = attr->values[0].integer;
3d052e43 702 else if (!strcmp(attr->name, "job-state") &&
ef416fc2 703 attr->value_tag == IPP_TAG_ENUM)
704 state = (ipp_jstate_t)attr->values[0].integer;
3d052e43 705 else if (!strcmp(attr->name, "job-priority") &&
ef416fc2 706 attr->value_tag == IPP_TAG_INTEGER)
707 priority = attr->values[0].integer;
3d052e43 708 else if (!strcmp(attr->name, "job-k-octets") &&
ef416fc2 709 attr->value_tag == IPP_TAG_INTEGER)
710 size = attr->values[0].integer;
3d052e43 711 else if (!strcmp(attr->name, "time-at-completed") &&
ef416fc2 712 attr->value_tag == IPP_TAG_INTEGER)
713 completed_time = attr->values[0].integer;
3d052e43 714 else if (!strcmp(attr->name, "time-at-creation") &&
ef416fc2 715 attr->value_tag == IPP_TAG_INTEGER)
716 creation_time = attr->values[0].integer;
3d052e43 717 else if (!strcmp(attr->name, "time-at-processing") &&
ef416fc2 718 attr->value_tag == IPP_TAG_INTEGER)
719 processing_time = attr->values[0].integer;
3d052e43 720 else if (!strcmp(attr->name, "job-printer-uri") &&
ef416fc2 721 attr->value_tag == IPP_TAG_URI)
722 {
723 if ((dest = strrchr(attr->values[0].string.text, '/')) != NULL)
724 dest ++;
725 }
3d052e43 726 else if (!strcmp(attr->name, "job-originating-user-name") &&
ef416fc2 727 attr->value_tag == IPP_TAG_NAME)
728 user = attr->values[0].string.text;
3d052e43 729 else if (!strcmp(attr->name, "document-format") &&
ef416fc2 730 attr->value_tag == IPP_TAG_MIMETYPE)
731 format = attr->values[0].string.text;
3d052e43 732 else if (!strcmp(attr->name, "job-name") &&
ef416fc2 733 (attr->value_tag == IPP_TAG_TEXT ||
734 attr->value_tag == IPP_TAG_NAME))
735 title = attr->values[0].string.text;
736
737 attr = attr->next;
738 }
739
740 /*
741 * See if we have everything needed...
742 */
743
3d052e43 744 if (!dest || !id)
ef416fc2 745 {
3d052e43 746 if (!attr)
ef416fc2 747 break;
748 else
749 continue;
750 }
751
752 /*
753 * Allocate memory for the job...
754 */
755
756 if (n == 0)
757 temp = malloc(sizeof(cups_job_t));
758 else
759 temp = realloc(*jobs, sizeof(cups_job_t) * (n + 1));
760
3d052e43 761 if (!temp)
ef416fc2 762 {
763 /*
764 * Ran out of memory!
765 */
766
749b1e90 767 _cupsSetError(IPP_INTERNAL_ERROR, NULL, 0);
3d052e43 768
ef416fc2 769 cupsFreeJobs(n, *jobs);
770 *jobs = NULL;
771
772 ippDelete(response);
3d052e43
MS
773
774 return (-1);
ef416fc2 775 }
776
777 *jobs = temp;
778 temp += n;
779 n ++;
780
781 /*
782 * Copy the data over...
783 */
784
3d052e43
MS
785 temp->dest = _cupsStrAlloc(dest);
786 temp->user = _cupsStrAlloc(user);
787 temp->format = _cupsStrAlloc(format);
788 temp->title = _cupsStrAlloc(title);
ef416fc2 789 temp->id = id;
790 temp->priority = priority;
791 temp->state = state;
792 temp->size = size;
793 temp->completed_time = completed_time;
794 temp->creation_time = creation_time;
795 temp->processing_time = processing_time;
796
3d052e43 797 if (!attr)
ef416fc2 798 break;
799 }
800
801 ippDelete(response);
802 }
803
804 if (n == 0 && cg->last_error >= IPP_BAD_REQUEST)
805 return (-1);
806 else
807 return (n);
808}
809
810
811/*
812 * 'cupsGetPPD()' - Get the PPD file for a printer on the default server.
813 *
5a738aea 814 * For classes, @code cupsGetPPD@ returns the PPD file for the first printer
ef416fc2 815 * in the class.
568fa3fa
MS
816 *
817 * The returned filename is stored in a static buffer and is overwritten with
818 * each call to @code cupsGetPPD@ or @link cupsGetPPD2@.
ef416fc2 819 */
820
821const char * /* O - Filename for PPD file */
568fa3fa 822cupsGetPPD(const char *name) /* I - Destination name */
ef416fc2 823{
824 _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
2e4ff8af
MS
825 time_t modtime = 0; /* Modification time */
826
ef416fc2 827
ef416fc2 828 /*
829 * Return the PPD file...
830 */
831
2e4ff8af
MS
832 cg->ppd_filename[0] = '\0';
833
3d052e43 834 if (cupsGetPPD3(CUPS_HTTP_DEFAULT, name, &modtime, cg->ppd_filename,
2e4ff8af
MS
835 sizeof(cg->ppd_filename)) == HTTP_OK)
836 return (cg->ppd_filename);
837 else
838 return (NULL);
ef416fc2 839}
840
841
842/*
843 * 'cupsGetPPD2()' - Get the PPD file for a printer from the specified server.
844 *
5a738aea 845 * For classes, @code cupsGetPPD2@ returns the PPD file for the first printer
ef416fc2 846 * in the class.
847 *
568fa3fa
MS
848 * The returned filename is stored in a static buffer and is overwritten with
849 * each call to @link cupsGetPPD@ or @code cupsGetPPD2@.
850 *
426c6a59 851 * @since CUPS 1.1.21/Mac OS X 10.4@
ef416fc2 852 */
853
854const char * /* O - Filename for PPD file */
568fa3fa
MS
855cupsGetPPD2(http_t *http, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
856 const char *name) /* I - Destination name */
2e4ff8af
MS
857{
858 _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
859 time_t modtime = 0; /* Modification time */
860
861
862 cg->ppd_filename[0] = '\0';
863
864 if (cupsGetPPD3(http, name, &modtime, cg->ppd_filename,
865 sizeof(cg->ppd_filename)) == HTTP_OK)
866 return (cg->ppd_filename);
867 else
868 return (NULL);
869}
870
871
872/*
873 * 'cupsGetPPD3()' - Get the PPD file for a printer on the specified
874 * server if it has changed.
875 *
876 * The "modtime" parameter contains the modification time of any
877 * locally-cached content and is updated with the time from the PPD file on
878 * the server.
879 *
880 * The "buffer" parameter contains the local PPD filename. If it contains
881 * the empty string, a new temporary file is created, otherwise the existing
882 * file will be overwritten as needed.
883 *
5a738aea
MS
884 * On success, @code HTTP_OK@ is returned for a new PPD file and
885 * @code HTTP_NOT_MODIFIED@ if the existing PPD file is up-to-date. Any other
886 * status is an error.
887 *
888 * For classes, @code cupsGetPPD3@ returns the PPD file for the first printer
889 * in the class.
568fa3fa
MS
890 *
891 * @since CUPS 1.4@
2e4ff8af
MS
892 */
893
894http_status_t /* O - HTTP status */
5a738aea 895cupsGetPPD3(http_t *http, /* I - HTTP connection or @code CUPS_HTTP_DEFAULT@ */
568fa3fa 896 const char *name, /* I - Destination name */
2e4ff8af
MS
897 time_t *modtime, /* IO - Modification time */
898 char *buffer, /* I - Filename buffer */
899 size_t bufsize) /* I - Size of filename buffer */
ef416fc2 900{
ef416fc2 901 int http_port; /* Port number */
ed486911 902 char http_hostname[HTTP_MAX_HOST];
903 /* Hostname associated with connection */
ef416fc2 904 http_t *http2; /* Alternate HTTP connection */
ef416fc2 905 int fd; /* PPD file */
fa73b229 906 char localhost[HTTP_MAX_URI],/* Local hostname */
ef416fc2 907 hostname[HTTP_MAX_URI], /* Hostname */
908 resource[HTTP_MAX_URI]; /* Resource name */
909 int port; /* Port number */
910 http_status_t status; /* HTTP status from server */
911 _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
ef416fc2 912
913
914 /*
915 * Range check input...
916 */
917
2e4ff8af
MS
918 DEBUG_printf(("cupsGetPPD3(http=%p, name=\"%s\", modtime=%p(%d), buffer=%p, "
919 "bufsize=%d)\n", http, name ? name : "(null)", modtime,
ae71f5de 920 modtime ? (int)*modtime : 0, buffer, (int)bufsize));
ef416fc2 921
2e4ff8af
MS
922 if (!name)
923 {
749b1e90 924 _cupsSetError(IPP_INTERNAL_ERROR, _("No printer name!"), 1);
2e4ff8af
MS
925 return (HTTP_NOT_ACCEPTABLE);
926 }
927
928 if (!modtime)
929 {
749b1e90 930 _cupsSetError(IPP_INTERNAL_ERROR, _("No modification time!"), 1);
2e4ff8af
MS
931 return (HTTP_NOT_ACCEPTABLE);
932 }
933
934 if (!buffer || bufsize <= 1)
935 {
749b1e90 936 _cupsSetError(IPP_INTERNAL_ERROR, _("Bad filename buffer!"), 1);
2e4ff8af 937 return (HTTP_NOT_ACCEPTABLE);
ef416fc2 938 }
939
426c6a59
MS
940#ifndef WIN32
941 /*
942 * See if the PPD file is available locally...
943 */
944
945 if (!cg->servername[0])
946 cupsServer();
947
948 if (!strcasecmp(cg->servername, "localhost"))
949 {
950 char ppdname[1024]; /* PPD filename */
951 struct stat ppdinfo; /* PPD file information */
952
953
d1c13e16
MS
954 snprintf(ppdname, sizeof(ppdname), "%s/ppd/%s.ppd", cg->cups_serverroot,
955 name);
426c6a59
MS
956 if (!stat(ppdname, &ppdinfo))
957 {
958 /*
959 * OK, the file exists, use it!
960 */
961
962 if (buffer[0])
963 {
964 unlink(buffer);
965
966 if (symlink(ppdname, buffer) && errno != EEXIST)
967 {
968 _cupsSetError(IPP_INTERNAL_ERROR, NULL, 0);
969
970 return (HTTP_SERVER_ERROR);
971 }
972 }
973 else
974 {
975 int tries; /* Number of tries */
976 const char *tmpdir; /* TMPDIR environment variable */
977 struct timeval curtime; /* Current time */
978
979 /*
980 * Previously we put root temporary files in the default CUPS temporary
981 * directory under /var/spool/cups. However, since the scheduler cleans
982 * out temporary files there and runs independently of the user apps, we
983 * don't want to use it unless specifically told to by cupsd.
984 */
985
986 if ((tmpdir = getenv("TMPDIR")) == NULL)
987# ifdef __APPLE__
988 tmpdir = "/private/tmp"; /* /tmp is a symlink to /private/tmp */
989# else
990 tmpdir = "/tmp";
991# endif /* __APPLE__ */
992
993 /*
994 * Make the temporary name using the specified directory...
995 */
996
997 tries = 0;
998
999 do
1000 {
1001 /*
1002 * Get the current time of day...
1003 */
1004
1005 gettimeofday(&curtime, NULL);
1006
1007 /*
1008 * Format a string using the hex time values...
1009 */
1010
1011 snprintf(buffer, bufsize, "%s/%08lx%05lx", tmpdir,
1012 (unsigned long)curtime.tv_sec,
1013 (unsigned long)curtime.tv_usec);
1014
1015 /*
1016 * Try to make a symlink...
1017 */
1018
1019 if (!symlink(ppdname, buffer))
1020 break;
1021
1022 tries ++;
1023 }
1024 while (tries < 1000);
1025
1026 if (tries >= 1000)
1027 {
1028 _cupsSetError(IPP_INTERNAL_ERROR, NULL, 0);
1029
1030 return (HTTP_SERVER_ERROR);
1031 }
1032 }
1033
d1c13e16 1034 if (*modtime >= ppdinfo.st_mtime)
426c6a59
MS
1035 return (HTTP_NOT_MODIFIED);
1036 else
1037 {
1038 *modtime = ppdinfo.st_mtime;
1039 return (HTTP_OK);
1040 }
1041 }
1042 }
1043#endif /* !WIN32 */
1044
ef416fc2 1045 /*
fa73b229 1046 * Try finding a printer URI for this printer...
ef416fc2 1047 */
1048
3d052e43 1049 if (!http)
a603edef
MS
1050 if ((http = _cupsConnect()) == NULL)
1051 return (HTTP_SERVICE_UNAVAILABLE);
3d052e43 1052
fa73b229 1053 if (!cups_get_printer_uri(http, name, hostname, sizeof(hostname), &port,
1054 resource, sizeof(resource), 0))
2e4ff8af 1055 return (HTTP_NOT_FOUND);
ef416fc2 1056
1ff0402e
MS
1057 DEBUG_printf(("cupsGetPPD3: Printer hostname=\"%s\", port=%d\n", hostname,
1058 port));
8ca02f3c 1059
ef416fc2 1060 /*
fa73b229 1061 * Remap local hostname to localhost...
1062 */
1063
757d2cad 1064 httpGetHostname(NULL, localhost, sizeof(localhost));
fa73b229 1065
1ff0402e 1066 DEBUG_printf(("cupsGetPPD3: Local hostname=\"%s\"\n", localhost));
8ca02f3c 1067
fa73b229 1068 if (!strcasecmp(localhost, hostname))
1069 strcpy(hostname, "localhost");
1070
1071 /*
ed486911 1072 * Get the hostname and port number we are connected to...
ef416fc2 1073 */
1074
ed486911 1075 httpGetHostname(http, http_hostname, sizeof(http_hostname));
1ff0402e 1076 http_port = _httpAddrPort(http->hostaddr);
ed486911 1077
1ff0402e
MS
1078 DEBUG_printf(("cupsGetPPD3: Connection hostname=\"%s\", port=%d\n",
1079 http_hostname, http_port));
8ca02f3c 1080
ef416fc2 1081 /*
1082 * Reconnect to the correct server as needed...
1083 */
1084
ed486911 1085 if (!strcasecmp(http_hostname, hostname) && port == http_port)
ef416fc2 1086 http2 = http;
1087 else if ((http2 = httpConnectEncrypt(hostname, port,
1088 cupsEncryption())) == NULL)
1089 {
1ff0402e 1090 DEBUG_puts("cupsGetPPD3: Unable to connect to server!");
ef416fc2 1091
2e4ff8af 1092 return (HTTP_SERVICE_UNAVAILABLE);
ef416fc2 1093 }
1094
1095 /*
1096 * Get a temp file...
1097 */
1098
2e4ff8af
MS
1099 if (buffer[0])
1100 fd = open(buffer, O_CREAT | O_TRUNC | O_WRONLY, 0600);
1101 else
1102 fd = cupsTempFd(buffer, bufsize);
1103
1104 if (fd < 0)
ef416fc2 1105 {
1106 /*
1107 * Can't open file; close the server connection and return NULL...
1108 */
1109
749b1e90 1110 _cupsSetError(IPP_INTERNAL_ERROR, NULL, 0);
ef416fc2 1111
1112 if (http2 != http)
1113 httpClose(http2);
1114
2e4ff8af 1115 return (HTTP_SERVER_ERROR);
ef416fc2 1116 }
1117
1118 /*
1119 * And send a request to the HTTP server...
1120 */
1121
fa73b229 1122 strlcat(resource, ".ppd", sizeof(resource));
ef416fc2 1123
2e4ff8af
MS
1124 if (*modtime > 0)
1125 httpSetField(http2, HTTP_FIELD_IF_MODIFIED_SINCE,
1126 httpGetDateString(*modtime));
1127
ef416fc2 1128 status = cupsGetFd(http2, resource, fd);
1129
1130 close(fd);
1131
ef416fc2 1132 /*
1133 * See if we actually got the file or an error...
1134 */
1135
2e4ff8af
MS
1136 if (status == HTTP_OK)
1137 *modtime = httpGetDateTime(httpGetField(http2, HTTP_FIELD_DATE));
1138 else if (status != HTTP_NOT_MODIFIED)
ef416fc2 1139 {
1140 switch (status)
1141 {
1142 case HTTP_NOT_FOUND :
749b1e90 1143 _cupsSetError(IPP_NOT_FOUND, httpStatus(status), 0);
ef416fc2 1144 break;
1145
1146 case HTTP_UNAUTHORIZED :
749b1e90 1147 _cupsSetError(IPP_NOT_AUTHORIZED, httpStatus(status), 0);
ef416fc2 1148 break;
1149
1150 default :
1ff0402e
MS
1151 DEBUG_printf(("cupsGetPPD3: HTTP error %d mapped to "
1152 "IPP_SERVICE_UNAVAILABLE!\n", status));
749b1e90 1153 _cupsSetError(IPP_SERVICE_UNAVAILABLE, httpStatus(status), 0);
ef416fc2 1154 break;
1155 }
1156
1157 unlink(cg->ppd_filename);
ef416fc2 1158 }
1159
91c84a35
MS
1160 if (http2 != http)
1161 httpClose(http2);
1162
ef416fc2 1163 /*
1164 * Return the PPD file...
1165 */
1166
2e4ff8af 1167 return (status);
ef416fc2 1168}
1169
1170
1171/*
1172 * 'cupsGetPrinters()' - Get a list of printers from the default server.
1173 *
5a738aea 1174 * This function is deprecated - use @link cupsGetDests@ instead.
ef416fc2 1175 *
1176 * @deprecated@
1177 */
1178
1179int /* O - Number of printers */
1180cupsGetPrinters(char ***printers) /* O - Printers */
1181{
1182 int n; /* Number of printers */
1183 ipp_t *request, /* IPP Request */
1184 *response; /* IPP Response */
1185 ipp_attribute_t *attr; /* Current attribute */
ef416fc2 1186 char **temp; /* Temporary pointer */
3d052e43
MS
1187 http_t *http; /* Connection to server */
1188
ef416fc2 1189
3d052e43
MS
1190 /*
1191 * Range check input...
1192 */
ef416fc2 1193
3d052e43 1194 if (!printers)
ef416fc2 1195 {
749b1e90 1196 _cupsSetError(IPP_INTERNAL_ERROR, strerror(EINVAL), 0);
ef416fc2 1197
1198 return (0);
1199 }
1200
3d052e43
MS
1201 *printers = NULL;
1202
ef416fc2 1203 /*
1204 * Try to connect to the server...
1205 */
1206
3d052e43 1207 if ((http = _cupsConnect()) == NULL)
ef416fc2 1208 return (0);
ef416fc2 1209
1210 /*
1211 * Build a CUPS_GET_PRINTERS request, which requires the following
1212 * attributes:
1213 *
1214 * attributes-charset
1215 * attributes-natural-language
1216 * requested-attributes
1217 */
1218
2e4ff8af 1219 request = ippNewRequest(CUPS_GET_PRINTERS);
ef416fc2 1220
1221 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD,
1222 "requested-attributes", NULL, "printer-name");
1223
1224 ippAddInteger(request, IPP_TAG_OPERATION, IPP_TAG_ENUM,
1225 "printer-type", 0);
1226
1227 ippAddInteger(request, IPP_TAG_OPERATION, IPP_TAG_ENUM,
1228 "printer-type-mask", CUPS_PRINTER_CLASS);
1229
1230 /*
1231 * Do the request and get back a response...
1232 */
1233
3d052e43 1234 n = 0;
ef416fc2 1235
3d052e43 1236 if ((response = cupsDoRequest(http, request, "/")) != NULL)
ef416fc2 1237 {
1238 for (attr = response->attrs; attr != NULL; attr = attr->next)
1239 if (attr->name != NULL &&
1240 strcasecmp(attr->name, "printer-name") == 0 &&
1241 attr->value_tag == IPP_TAG_NAME)
1242 {
1243 if (n == 0)
1244 temp = malloc(sizeof(char *));
1245 else
1246 temp = realloc(*printers, sizeof(char *) * (n + 1));
1247
1248 if (temp == NULL)
1249 {
1250 /*
1251 * Ran out of memory!
1252 */
1253
1254 while (n > 0)
1255 {
1256 n --;
1257 free((*printers)[n]);
1258 }
1259
1260 free(*printers);
1261 ippDelete(response);
1262 return (0);
1263 }
1264
1265 *printers = temp;
1266 temp[n] = strdup(attr->values[0].string.text);
1267 n ++;
1268 }
1269
1270 ippDelete(response);
1271 }
1272
1273 return (n);
1274}
1275
1276
b94498cf 1277/*
1278 * 'cupsGetServerPPD()' - Get an available PPD file from the server.
1279 *
1280 * This function returns the named PPD file from the server. The
5a738aea 1281 * list of available PPDs is provided by the IPP @code CUPS_GET_PPDS@
b94498cf 1282 * operation.
1283 *
1284 * You must remove (unlink) the PPD file when you are finished with
1285 * it. The PPD filename is stored in a static location that will be
5a738aea
MS
1286 * overwritten on the next call to @link cupsGetPPD@, @link cupsGetPPD2@,
1287 * or @link cupsGetServerPPD@.
b94498cf 1288 *
426c6a59 1289 * @since CUPS 1.3/Mac OS X 10.5@
b94498cf 1290 */
1291
5a738aea 1292char * /* O - Name of PPD file or @code NULL@ on error */
568fa3fa 1293cupsGetServerPPD(http_t *http, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
b94498cf 1294 const char *name) /* I - Name of PPD file ("ppd-name") */
1295{
1296 int fd; /* PPD file descriptor */
1297 ipp_t *request; /* IPP request */
1298 _cups_globals_t *cg = _cupsGlobals();
1299 /* Pointer to library globals */
1300
1301
1302 /*
1303 * Range check input...
1304 */
1305
3d052e43 1306 if (!name)
b94498cf 1307 {
749b1e90 1308 _cupsSetError(IPP_INTERNAL_ERROR, _("No PPD name!"), 1);
b94498cf 1309
1310 return (NULL);
1311 }
1312
3d052e43
MS
1313 if (!http)
1314 if ((http = _cupsConnect()) == NULL)
1315 return (NULL);
1316
b94498cf 1317 /*
1318 * Get a temp file...
1319 */
1320
1321 if ((fd = cupsTempFd(cg->ppd_filename, sizeof(cg->ppd_filename))) < 0)
1322 {
1323 /*
1324 * Can't open file; close the server connection and return NULL...
1325 */
1326
749b1e90 1327 _cupsSetError(IPP_INTERNAL_ERROR, NULL, 0);
b94498cf 1328
1329 return (NULL);
1330 }
1331
1332 /*
1333 * Get the PPD file...
1334 */
1335
1336 request = ippNewRequest(CUPS_GET_PPD);
1337 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "ppd-name", NULL,
1338 name);
1339
1340 ippDelete(cupsDoIORequest(http, request, "/", -1, fd));
1341
1342 close(fd);
1343
1344 if (cupsLastError() != IPP_OK)
1345 {
1346 unlink(cg->ppd_filename);
1347 return (NULL);
1348 }
1349 else
1350 return (cg->ppd_filename);
1351}
1352
1353
ef416fc2 1354/*
1355 * 'cupsLastError()' - Return the last IPP status code.
1356 */
1357
1358ipp_status_t /* O - IPP status code from last request */
1359cupsLastError(void)
1360{
1361 return (_cupsGlobals()->last_error);
1362}
1363
1364
1365/*
1366 * 'cupsLastErrorString()' - Return the last IPP status-message.
1367 *
426c6a59 1368 * @since CUPS 1.2/Mac OS X 10.5@
ef416fc2 1369 */
1370
1371const char * /* O - status-message text from last request */
1372cupsLastErrorString(void)
1373{
1374 return (_cupsGlobals()->last_status_message);
1375}
1376
1377
1378/*
1379 * 'cupsPrintFile()' - Print a file to a printer or class on the default server.
1380 */
1381
5a738aea 1382int /* O - Job ID or 0 on error */
568fa3fa 1383cupsPrintFile(const char *name, /* I - Destination name */
ef416fc2 1384 const char *filename, /* I - File to print */
1385 const char *title, /* I - Title of job */
1386 int num_options,/* I - Number of options */
1387 cups_option_t *options) /* I - Options */
1388{
1389 DEBUG_printf(("cupsPrintFile(name=\"%s\", filename=\"%s\", "
1390 "title=\"%s\", num_options=%d, options=%p)\n",
1391 name, filename, title, num_options, options));
1392
3d052e43
MS
1393 return (cupsPrintFiles2(CUPS_HTTP_DEFAULT, name, 1, &filename, title,
1394 num_options, options));
ef416fc2 1395}
1396
1397
1398/*
5a738aea
MS
1399 * 'cupsPrintFile2()' - Print a file to a printer or class on the specified
1400 * server.
ef416fc2 1401 *
426c6a59 1402 * @since CUPS 1.1.21/Mac OS X 10.4@
ef416fc2 1403 */
1404
5a738aea 1405int /* O - Job ID or 0 on error */
3d052e43 1406cupsPrintFile2(
568fa3fa
MS
1407 http_t *http, /* I - Connection to server */
1408 const char *name, /* I - Destination name */
3d052e43
MS
1409 const char *filename, /* I - File to print */
1410 const char *title, /* I - Title of job */
1411 int num_options, /* I - Number of options */
1412 cups_option_t *options) /* I - Options */
ef416fc2 1413{
1414 DEBUG_printf(("cupsPrintFile2(http=%p, name=\"%s\", filename=\"%s\", "
1415 "title=\"%s\", num_options=%d, options=%p)\n",
1416 http, name, filename, title, num_options, options));
1417
3d052e43
MS
1418 return (cupsPrintFiles2(http, name, 1, &filename, title, num_options,
1419 options));
ef416fc2 1420}
1421
1422
1423/*
fa73b229 1424 * 'cupsPrintFiles()' - Print one or more files to a printer or class on the
1425 * default server.
ef416fc2 1426 */
1427
5a738aea 1428int /* O - Job ID or 0 on error */
3d052e43 1429cupsPrintFiles(
568fa3fa 1430 const char *name, /* I - Destination name */
3d052e43
MS
1431 int num_files, /* I - Number of files */
1432 const char **files, /* I - File(s) to print */
1433 const char *title, /* I - Title of job */
1434 int num_options, /* I - Number of options */
1435 cups_option_t *options) /* I - Options */
ef416fc2 1436{
ef416fc2 1437 DEBUG_printf(("cupsPrintFiles(name=\"%s\", num_files=%d, "
1438 "files=%p, title=\"%s\", num_options=%d, options=%p)\n",
1439 name, num_files, files, title, num_options, options));
1440
1441
ef416fc2 1442 /*
1443 * Print the file(s)...
1444 */
1445
3d052e43 1446 return (cupsPrintFiles2(CUPS_HTTP_DEFAULT, name, num_files, files, title,
ef416fc2 1447 num_options, options));
1448}
1449
1450
ef416fc2 1451/*
fa73b229 1452 * 'cupsPrintFiles2()' - Print one or more files to a printer or class on the
1453 * specified server.
ef416fc2 1454 *
426c6a59 1455 * @since CUPS 1.1.21/Mac OS X 10.4@
ef416fc2 1456 */
1457
5a738aea 1458int /* O - Job ID or 0 on error */
3d052e43 1459cupsPrintFiles2(
568fa3fa
MS
1460 http_t *http, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
1461 const char *name, /* I - Destination name */
3d052e43
MS
1462 int num_files, /* I - Number of files */
1463 const char **files, /* I - File(s) to print */
1464 const char *title, /* I - Title of job */
1465 int num_options, /* I - Number of options */
1466 cups_option_t *options) /* I - Options */
ef416fc2 1467{
1468 int i; /* Looping var */
3d052e43
MS
1469 int job_id; /* New job ID */
1470 const char *docname; /* Basename of current filename */
1471 const char *format; /* Document format */
1472 cups_file_t *fp; /* Current file */
1473 char buffer[8192]; /* Copy buffer */
1474 ssize_t bytes; /* Bytes in buffer */
1475 http_status_t status; /* Status of write */
ef416fc2 1476
1477
3d052e43 1478 DEBUG_printf(("cupsPrintFiles2(http=%p, name=\"%s\", num_files=%d, "
ef416fc2 1479 "files=%p, title=\"%s\", num_options=%d, options=%p)\n",
1480 http, name, num_files, files, title, num_options, options));
1481
1482 /*
1483 * Range check input...
1484 */
1485
3d052e43 1486 if (!name || num_files < 1 || !files)
ef416fc2 1487 {
749b1e90 1488 _cupsSetError(IPP_INTERNAL_ERROR, strerror(EINVAL), 0);
ef416fc2 1489
1490 return (0);
1491 }
1492
1493 /*
3d052e43 1494 * Create the print job...
ef416fc2 1495 */
1496
3d052e43 1497 if ((job_id = cupsCreateJob(http, name, title, num_options, options)) == 0)
ef416fc2 1498 return (0);
ef416fc2 1499
1500 /*
3d052e43 1501 * Send each of the files...
ef416fc2 1502 */
1503
3d052e43
MS
1504 if (cupsGetOption("raw", num_options, options))
1505 format = CUPS_FORMAT_RAW;
1506 else if ((format = cupsGetOption("document-format", num_options,
1507 options)) == NULL)
1508 format = CUPS_FORMAT_AUTO;
ef416fc2 1509
3d052e43
MS
1510 for (i = 0; i < num_files; i ++)
1511 {
1512 /*
1513 * Start the next file...
1514 */
ef416fc2 1515
3d052e43
MS
1516 if ((docname = strrchr(files[i], '/')) != NULL)
1517 docname ++;
1518 else
1519 docname = files[i];
ef416fc2 1520
3d052e43
MS
1521 if ((fp = cupsFileOpen(files[i], "rb")) == NULL)
1522 {
1523 /*
1524 * Unable to open print file, cancel the job and return...
1525 */
ef416fc2 1526
5a738aea 1527 cupsCancelJob2(http, name, job_id, 0);
3d052e43
MS
1528 return (0);
1529 }
ef416fc2 1530
3d052e43
MS
1531 status = cupsStartDocument(http, name, job_id, docname, format,
1532 i == (num_files - 1));
ef416fc2 1533
3d052e43
MS
1534 while (status == HTTP_CONTINUE &&
1535 (bytes = cupsFileRead(fp, buffer, sizeof(buffer))) > 0)
1536 status = cupsWriteRequestData(http, buffer, bytes);
ef416fc2 1537
3d052e43 1538 cupsFileClose(fp);
ef416fc2 1539
3d052e43 1540 if (status != HTTP_CONTINUE || cupsFinishDocument(http, name) != IPP_OK)
ef416fc2 1541 {
1542 /*
3d052e43 1543 * Unable to queue, cancel the job and return...
ef416fc2 1544 */
1545
5a738aea 1546 cupsCancelJob2(http, name, job_id, 0);
3d052e43
MS
1547 return (0);
1548 }
1549 }
ef416fc2 1550
3d052e43
MS
1551 return (job_id);
1552}
ef416fc2 1553
ef416fc2 1554
3d052e43
MS
1555/*
1556 * 'cupsStartDocument()' - Add a document to a job created with cupsCreateJob().
1557 *
5a738aea
MS
1558 * Use @link cupsWriteRequestData@ to write data for the document and
1559 * @link cupsFinishDocument@ to finish the document and get the submission status.
3d052e43 1560 *
5a738aea
MS
1561 * The MIME type constants @code CUPS_FORMAT_AUTO@, @code CUPS_FORMAT_PDF@,
1562 * @code CUPS_FORMAT_POSTSCRIPT@, @code CUPS_FORMAT_RAW@, and
1563 * @code CUPS_FORMAT_TEXT@ are provided for the "format" argument, although
1564 * any supported MIME type string can be supplied.
3d052e43
MS
1565 *
1566 * @since CUPS 1.4@
1567 */
ef416fc2 1568
3d052e43
MS
1569http_status_t /* O - HTTP status of request */
1570cupsStartDocument(
568fa3fa
MS
1571 http_t *http, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
1572 const char *name, /* I - Destination name */
5a738aea 1573 int job_id, /* I - Job ID from @link cupsCreateJob@ */
3d052e43 1574 const char *docname, /* I - Name of document */
5a738aea 1575 const char *format, /* I - MIME type or @code CUPS_FORMAT_foo@ */
3d052e43
MS
1576 int last_document) /* I - 1 for last document in job, 0 otherwise */
1577{
1578 char resource[1024], /* Resource for destinatio */
1579 printer_uri[1024]; /* Printer URI */
1580 ipp_t *request; /* Send-Document request */
1581 http_status_t status; /* HTTP status */
ef416fc2 1582
bd7854cb 1583
3d052e43
MS
1584 /*
1585 * Create a Send-Document request...
1586 */
bd7854cb 1587
3d052e43
MS
1588 if ((request = ippNewRequest(IPP_SEND_DOCUMENT)) == NULL)
1589 {
749b1e90 1590 _cupsSetError(IPP_INTERNAL_ERROR, strerror(ENOMEM), 0);
3d052e43
MS
1591 return (0);
1592 }
bd7854cb 1593
3d052e43
MS
1594 httpAssembleURIf(HTTP_URI_CODING_ALL, printer_uri, sizeof(printer_uri), "ipp",
1595 NULL, "localhost", ippPort(), "/printers/%s", name);
1596 snprintf(resource, sizeof(resource), "/printers/%s", name);
ef416fc2 1597
3d052e43
MS
1598 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri",
1599 NULL, printer_uri);
1600 ippAddInteger(request, IPP_TAG_OPERATION, IPP_TAG_INTEGER, "job-id", job_id);
1601 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "requesting-user-name",
1602 NULL, cupsUser());
1603 if (docname)
1604 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "document-name",
1605 NULL, docname);
1606 if (format)
1607 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_MIMETYPE,
1608 "document-format", NULL, format);
1609 ippAddBoolean(request, IPP_TAG_OPERATION, "last-document", last_document);
ef416fc2 1610
3d052e43
MS
1611 /*
1612 * Send and delete the request, then return the status...
1613 */
ef416fc2 1614
3d052e43 1615 status = cupsSendRequest(http, request, resource, CUPS_LENGTH_VARIABLE);
ef416fc2 1616
3d052e43 1617 ippDelete(request);
ef416fc2 1618
3d052e43 1619 return (status);
ef416fc2 1620}
1621
1622
1623/*
3d052e43 1624 * '_cupsConnect()' - Get the default server connection...
ef416fc2 1625 */
1626
3d052e43
MS
1627http_t * /* O - HTTP connection */
1628_cupsConnect(void)
ef416fc2 1629{
3d052e43 1630 _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
ef416fc2 1631
ef416fc2 1632
1633 /*
3d052e43 1634 * See if we are connected to the same server...
ef416fc2 1635 */
1636
3d052e43
MS
1637 if (cg->http)
1638 {
3d052e43
MS
1639 /*
1640 * Compare the connection hostname, port, and encryption settings to
1641 * the cached defaults; these were initialized the first time we
1642 * connected...
1643 */
1644
1ff0402e
MS
1645 if (strcmp(cg->http->hostname, cg->server) ||
1646 cg->ipp_port != _httpAddrPort(cg->http->hostaddr) ||
3d052e43
MS
1647 (cg->http->encryption != cg->encryption &&
1648 cg->http->encryption == HTTP_ENCRYPT_NEVER))
1649 {
1650 /*
1651 * Need to close the current connection because something has changed...
1652 */
ef416fc2 1653
3d052e43
MS
1654 httpClose(cg->http);
1655 cg->http = NULL;
1656 }
ef416fc2 1657 }
1658
3d052e43
MS
1659 /*
1660 * (Re)connect as needed...
1661 */
ef416fc2 1662
3d052e43 1663 if (!cg->http)
ef416fc2 1664 {
3d052e43
MS
1665 if ((cg->http = httpConnectEncrypt(cupsServer(), ippPort(),
1666 cupsEncryption())) == NULL)
749b1e90
MS
1667 {
1668 if (errno)
1669 _cupsSetError(IPP_SERVICE_UNAVAILABLE, NULL, 0);
1670 else
1671 _cupsSetError(IPP_SERVICE_UNAVAILABLE,
1672 _("Unable to connect to host."), 1);
1673 }
3d052e43 1674 }
ef416fc2 1675
3d052e43
MS
1676 /*
1677 * Return the cached connection...
1678 */
ef416fc2 1679
3d052e43 1680 return (cg->http);
ef416fc2 1681}
1682
1683
fa73b229 1684/*
58dc1933
MS
1685 * 'cups_get_printer_uri()' - Get the printer-uri-supported attribute for the
1686 * first printer in a class.
fa73b229 1687 */
1688
1689static int /* O - 1 on success, 0 on failure */
1690cups_get_printer_uri(
568fa3fa 1691 http_t *http, /* I - Connection to server */
fa73b229 1692 const char *name, /* I - Name of printer or class */
1693 char *host, /* I - Hostname buffer */
1694 int hostsize, /* I - Size of hostname buffer */
1695 int *port, /* O - Port number */
1696 char *resource, /* I - Resource buffer */
1697 int resourcesize, /* I - Size of resource buffer */
1698 int depth) /* I - Depth of query */
1699{
1700 int i; /* Looping var */
1701 int http_port; /* Port number */
1702 http_t *http2; /* Alternate HTTP connection */
1703 ipp_t *request, /* IPP request */
1704 *response; /* IPP response */
1705 ipp_attribute_t *attr; /* Current attribute */
1706 char uri[HTTP_MAX_URI], /* printer-uri attribute */
1707 scheme[HTTP_MAX_URI], /* Scheme name */
1708 username[HTTP_MAX_URI], /* Username:password */
ed486911 1709 classname[255], /* Temporary class name */
1710 http_hostname[HTTP_MAX_HOST];
1711 /* Hostname associated with connection */
fa73b229 1712 static const char * const requested_attrs[] =
1713 { /* Requested attributes */
58dc1933 1714 "member-uris",
fa73b229 1715 "printer-uri-supported",
58dc1933 1716 "printer-type"
fa73b229 1717 };
1718
1719
1720 DEBUG_printf(("cups_get_printer_uri(http=%p, name=\"%s\", host=%p, "
1721 "hostsize=%d, resource=%p, resourcesize=%d, depth=%d)\n",
1722 http, name ? name : "(null)", host, hostsize,
1723 resource, resourcesize, depth));
1724
1725 /*
1726 * Setup the printer URI...
1727 */
1728
a4d04587 1729 if (httpAssembleURIf(HTTP_URI_CODING_ALL, uri, sizeof(uri), "ipp", NULL,
1730 "localhost", 0, "/printers/%s", name) != HTTP_URI_OK)
fa73b229 1731 {
749b1e90 1732 _cupsSetError(IPP_INTERNAL_ERROR, _("Unable to create printer-uri!"), 1);
fa73b229 1733
1734 *host = '\0';
1735 *resource = '\0';
1736
1737 return (0);
1738 }
1739
1740 DEBUG_printf(("cups_get_printer_uri: printer-uri=\"%s\"\n", uri));
1741
1742 /*
ed486911 1743 * Get the hostname and port number we are connected to...
fa73b229 1744 */
1745
ed486911 1746 httpGetHostname(http, http_hostname, sizeof(http_hostname));
1ff0402e 1747 http_port = _httpAddrPort(http->hostaddr);
fa73b229 1748
1749 /*
1750 * Build an IPP_GET_PRINTER_ATTRIBUTES request, which requires the following
1751 * attributes:
1752 *
1753 * attributes-charset
1754 * attributes-natural-language
1755 * printer-uri
1756 * requested-attributes
1757 */
1758
1759 request = ippNewRequest(IPP_GET_PRINTER_ATTRIBUTES);
1760
1761 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri",
1762 NULL, uri);
1763
1764 ippAddStrings(request, IPP_TAG_OPERATION, IPP_TAG_NAME,
1765 "requested-attributes",
1766 sizeof(requested_attrs) / sizeof(requested_attrs[0]),
1767 NULL, requested_attrs);
1768
1769 /*
1770 * Do the request and get back a response...
1771 */
1772
1773 if ((response = cupsDoRequest(http, request, "/")) != NULL)
1774 {
1775 if ((attr = ippFindAttribute(response, "member-uris", IPP_TAG_URI)) != NULL)
1776 {
1777 /*
1778 * Get the first actual printer name in the class...
1779 */
1780
1781 for (i = 0; i < attr->num_values; i ++)
1782 {
a4d04587 1783 httpSeparateURI(HTTP_URI_CODING_ALL, attr->values[i].string.text,
1784 scheme, sizeof(scheme), username, sizeof(username),
1785 host, hostsize, port, resource, resourcesize);
fa73b229 1786 if (!strncmp(resource, "/printers/", 10))
1787 {
1788 /*
1789 * Found a printer!
1790 */
1791
1792 ippDelete(response);
1793
1794 return (1);
1795 }
1796 }
1797
1798 /*
1799 * No printers in this class - try recursively looking for a printer,
1800 * but not more than 3 levels deep...
1801 */
1802
1803 if (depth < 3)
1804 {
1805 for (i = 0; i < attr->num_values; i ++)
1806 {
a4d04587 1807 httpSeparateURI(HTTP_URI_CODING_ALL, attr->values[i].string.text,
1808 scheme, sizeof(scheme), username, sizeof(username),
1809 host, hostsize, port, resource, resourcesize);
fa73b229 1810 if (!strncmp(resource, "/classes/", 9))
1811 {
1812 /*
1813 * Found a class! Connect to the right server...
1814 */
1815
ed486911 1816 if (!strcasecmp(http_hostname, host) && *port == http_port)
fa73b229 1817 http2 = http;
1818 else if ((http2 = httpConnectEncrypt(host, *port,
1819 cupsEncryption())) == NULL)
1820 {
1821 DEBUG_puts("Unable to connect to server!");
1822
1823 continue;
1824 }
1825
1826 /*
1827 * Look up printers on that server...
1828 */
1829
1830 strlcpy(classname, resource + 9, sizeof(classname));
1831
1832 cups_get_printer_uri(http2, classname, host, hostsize, port,
1833 resource, resourcesize, depth + 1);
1834
1835 /*
1836 * Close the connection as needed...
1837 */
1838
1839 if (http2 != http)
1840 httpClose(http2);
1841
1842 if (*host)
1843 return (1);
1844 }
1845 }
1846 }
1847 }
1848 else if ((attr = ippFindAttribute(response, "printer-uri-supported",
1849 IPP_TAG_URI)) != NULL)
1850 {
58dc1933
MS
1851 httpSeparateURI(HTTP_URI_CODING_ALL,
1852 _httpResolveURI(attr->values[0].string.text, uri,
1853 sizeof(uri), 0),
a4d04587 1854 scheme, sizeof(scheme), username, sizeof(username),
1855 host, hostsize, port, resource, resourcesize);
fa73b229 1856 ippDelete(response);
1857
dd1abb6b
MS
1858 if (!strncmp(resource, "/classes/", 9))
1859 {
749b1e90
MS
1860 _cupsSetError(IPP_INTERNAL_ERROR,
1861 _("No printer-uri found for class!"), 1);
dd1abb6b
MS
1862
1863 *host = '\0';
1864 *resource = '\0';
1865
1866 return (0);
1867 }
1868
fa73b229 1869 return (1);
1870 }
1871
1872 ippDelete(response);
1873 }
1874
b86bc4cf 1875 if (cupsLastError() != IPP_NOT_FOUND)
749b1e90 1876 _cupsSetError(IPP_INTERNAL_ERROR, _("No printer-uri found!"), 1);
b423cd4c 1877
fa73b229 1878 *host = '\0';
1879 *resource = '\0';
1880
1881 return (0);
1882}
1883
1884
ef416fc2 1885/*
b19ccc9e 1886 * End of "$Id: util.c 7850 2008-08-20 00:07:25Z mike $".
ef416fc2 1887 */