]> git.ipfire.org Git - thirdparty/cups.git/blame - cups/util.c
Import CUPS 1.4svn-r7356.
[thirdparty/cups.git] / cups / util.c
CommitLineData
ef416fc2 1/*
2e4ff8af 2 * "$Id: util.c 7014 2007-10-10 21:57:43Z mike $"
ef416fc2 3 *
4 * Printing utilities for the Common UNIX Printing System (CUPS).
5 *
3d052e43 6 * Copyright 2007-2008 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 {
3d052e43 134 _cupsSetError(IPP_INTERNAL_ERROR, strerror(EINVAL));
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 {
232 _cupsSetError(IPP_INTERNAL_ERROR, NULL);
233 return (0);
234 }
235
236 /*
237 * Build a Create-Job request...
238 */
239
240 if ((request = ippNewRequest(IPP_CREATE_JOB)) == NULL)
241 {
242 _cupsSetError(IPP_INTERNAL_ERROR, NULL);
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 {
ecdc0628 349 _cupsSetError(IPP_INTERNAL_ERROR, NULL);
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 *
452 * @since CUPS 1.1.21@
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 *
ef416fc2 549 * @since CUPS 1.1.21@
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 {
ecdc0628 599 _cupsSetError(IPP_INTERNAL_ERROR, NULL);
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 {
ecdc0628 613 _cupsSetError(IPP_INTERNAL_ERROR, NULL);
ef416fc2 614
615 return (-1);
616 }
617 }
618 else
619 strcpy(uri, "ipp://localhost/jobs");
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
3d052e43
MS
767 _cupsSetError(IPP_INTERNAL_ERROR, strerror(errno));
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 *
ef416fc2 851 * @since CUPS 1.1.21@
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,
920 modtime ? *modtime : 0, buffer, (int)bufsize));
ef416fc2 921
2e4ff8af
MS
922 if (!name)
923 {
924 _cupsSetError(IPP_INTERNAL_ERROR, "No printer name!");
925 return (HTTP_NOT_ACCEPTABLE);
926 }
927
928 if (!modtime)
929 {
930 _cupsSetError(IPP_INTERNAL_ERROR, "No modification time!");
931 return (HTTP_NOT_ACCEPTABLE);
932 }
933
934 if (!buffer || bufsize <= 1)
935 {
936 _cupsSetError(IPP_INTERNAL_ERROR, "Bad filename buffer!");
937 return (HTTP_NOT_ACCEPTABLE);
ef416fc2 938 }
939
940 /*
fa73b229 941 * Try finding a printer URI for this printer...
ef416fc2 942 */
943
3d052e43
MS
944 if (!http)
945 http = _cupsConnect();
946
fa73b229 947 if (!cups_get_printer_uri(http, name, hostname, sizeof(hostname), &port,
948 resource, sizeof(resource), 0))
2e4ff8af 949 return (HTTP_NOT_FOUND);
ef416fc2 950
8ca02f3c 951 DEBUG_printf(("Printer hostname=\"%s\", port=%d\n", hostname, port));
952
ef416fc2 953 /*
fa73b229 954 * Remap local hostname to localhost...
955 */
956
757d2cad 957 httpGetHostname(NULL, localhost, sizeof(localhost));
fa73b229 958
8ca02f3c 959 DEBUG_printf(("Local hostname=\"%s\"\n", localhost));
960
fa73b229 961 if (!strcasecmp(localhost, hostname))
962 strcpy(hostname, "localhost");
963
964 /*
ed486911 965 * Get the hostname and port number we are connected to...
ef416fc2 966 */
967
ed486911 968 httpGetHostname(http, http_hostname, sizeof(http_hostname));
969
ef416fc2 970#ifdef AF_INET6
971 if (http->hostaddr->addr.sa_family == AF_INET6)
972 http_port = ntohs(http->hostaddr->ipv6.sin6_port);
973 else
974#endif /* AF_INET6 */
975 if (http->hostaddr->addr.sa_family == AF_INET)
976 http_port = ntohs(http->hostaddr->ipv4.sin_port);
977 else
978 http_port = ippPort();
979
8ca02f3c 980 DEBUG_printf(("Connection hostname=\"%s\", port=%d\n", http_hostname,
981 http_port));
982
ef416fc2 983 /*
984 * Reconnect to the correct server as needed...
985 */
986
ed486911 987 if (!strcasecmp(http_hostname, hostname) && port == http_port)
ef416fc2 988 http2 = http;
989 else if ((http2 = httpConnectEncrypt(hostname, port,
990 cupsEncryption())) == NULL)
991 {
992 DEBUG_puts("Unable to connect to server!");
993
2e4ff8af 994 return (HTTP_SERVICE_UNAVAILABLE);
ef416fc2 995 }
996
997 /*
998 * Get a temp file...
999 */
1000
2e4ff8af
MS
1001 if (buffer[0])
1002 fd = open(buffer, O_CREAT | O_TRUNC | O_WRONLY, 0600);
1003 else
1004 fd = cupsTempFd(buffer, bufsize);
1005
1006 if (fd < 0)
ef416fc2 1007 {
1008 /*
1009 * Can't open file; close the server connection and return NULL...
1010 */
1011
ecdc0628 1012 _cupsSetError(IPP_INTERNAL_ERROR, strerror(errno));
ef416fc2 1013
1014 if (http2 != http)
1015 httpClose(http2);
1016
2e4ff8af 1017 return (HTTP_SERVER_ERROR);
ef416fc2 1018 }
1019
1020 /*
1021 * And send a request to the HTTP server...
1022 */
1023
fa73b229 1024 strlcat(resource, ".ppd", sizeof(resource));
ef416fc2 1025
2e4ff8af
MS
1026 if (*modtime > 0)
1027 httpSetField(http2, HTTP_FIELD_IF_MODIFIED_SINCE,
1028 httpGetDateString(*modtime));
1029
ef416fc2 1030 status = cupsGetFd(http2, resource, fd);
1031
1032 close(fd);
1033
ef416fc2 1034 /*
1035 * See if we actually got the file or an error...
1036 */
1037
2e4ff8af
MS
1038 if (status == HTTP_OK)
1039 *modtime = httpGetDateTime(httpGetField(http2, HTTP_FIELD_DATE));
1040 else if (status != HTTP_NOT_MODIFIED)
ef416fc2 1041 {
1042 switch (status)
1043 {
1044 case HTTP_NOT_FOUND :
ecdc0628 1045 _cupsSetError(IPP_NOT_FOUND, httpStatus(status));
ef416fc2 1046 break;
1047
1048 case HTTP_UNAUTHORIZED :
ecdc0628 1049 _cupsSetError(IPP_NOT_AUTHORIZED, httpStatus(status));
ef416fc2 1050 break;
1051
1052 default :
1053 DEBUG_printf(("HTTP error %d mapped to IPP_SERVICE_UNAVAILABLE!\n",
1054 status));
ecdc0628 1055 _cupsSetError(IPP_SERVICE_UNAVAILABLE, httpStatus(status));
ef416fc2 1056 break;
1057 }
1058
1059 unlink(cg->ppd_filename);
ef416fc2 1060 }
1061
91c84a35
MS
1062 if (http2 != http)
1063 httpClose(http2);
1064
ef416fc2 1065 /*
1066 * Return the PPD file...
1067 */
1068
2e4ff8af 1069 return (status);
ef416fc2 1070}
1071
1072
1073/*
1074 * 'cupsGetPrinters()' - Get a list of printers from the default server.
1075 *
5a738aea 1076 * This function is deprecated - use @link cupsGetDests@ instead.
ef416fc2 1077 *
1078 * @deprecated@
1079 */
1080
1081int /* O - Number of printers */
1082cupsGetPrinters(char ***printers) /* O - Printers */
1083{
1084 int n; /* Number of printers */
1085 ipp_t *request, /* IPP Request */
1086 *response; /* IPP Response */
1087 ipp_attribute_t *attr; /* Current attribute */
ef416fc2 1088 char **temp; /* Temporary pointer */
3d052e43
MS
1089 http_t *http; /* Connection to server */
1090
ef416fc2 1091
3d052e43
MS
1092 /*
1093 * Range check input...
1094 */
ef416fc2 1095
3d052e43 1096 if (!printers)
ef416fc2 1097 {
ecdc0628 1098 _cupsSetError(IPP_INTERNAL_ERROR, NULL);
ef416fc2 1099
1100 return (0);
1101 }
1102
3d052e43
MS
1103 *printers = NULL;
1104
ef416fc2 1105 /*
1106 * Try to connect to the server...
1107 */
1108
3d052e43 1109 if ((http = _cupsConnect()) == NULL)
ef416fc2 1110 return (0);
ef416fc2 1111
1112 /*
1113 * Build a CUPS_GET_PRINTERS request, which requires the following
1114 * attributes:
1115 *
1116 * attributes-charset
1117 * attributes-natural-language
1118 * requested-attributes
1119 */
1120
2e4ff8af 1121 request = ippNewRequest(CUPS_GET_PRINTERS);
ef416fc2 1122
1123 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD,
1124 "requested-attributes", NULL, "printer-name");
1125
1126 ippAddInteger(request, IPP_TAG_OPERATION, IPP_TAG_ENUM,
1127 "printer-type", 0);
1128
1129 ippAddInteger(request, IPP_TAG_OPERATION, IPP_TAG_ENUM,
1130 "printer-type-mask", CUPS_PRINTER_CLASS);
1131
1132 /*
1133 * Do the request and get back a response...
1134 */
1135
3d052e43 1136 n = 0;
ef416fc2 1137
3d052e43 1138 if ((response = cupsDoRequest(http, request, "/")) != NULL)
ef416fc2 1139 {
1140 for (attr = response->attrs; attr != NULL; attr = attr->next)
1141 if (attr->name != NULL &&
1142 strcasecmp(attr->name, "printer-name") == 0 &&
1143 attr->value_tag == IPP_TAG_NAME)
1144 {
1145 if (n == 0)
1146 temp = malloc(sizeof(char *));
1147 else
1148 temp = realloc(*printers, sizeof(char *) * (n + 1));
1149
1150 if (temp == NULL)
1151 {
1152 /*
1153 * Ran out of memory!
1154 */
1155
1156 while (n > 0)
1157 {
1158 n --;
1159 free((*printers)[n]);
1160 }
1161
1162 free(*printers);
1163 ippDelete(response);
1164 return (0);
1165 }
1166
1167 *printers = temp;
1168 temp[n] = strdup(attr->values[0].string.text);
1169 n ++;
1170 }
1171
1172 ippDelete(response);
1173 }
1174
1175 return (n);
1176}
1177
1178
b94498cf 1179/*
1180 * 'cupsGetServerPPD()' - Get an available PPD file from the server.
1181 *
1182 * This function returns the named PPD file from the server. The
5a738aea 1183 * list of available PPDs is provided by the IPP @code CUPS_GET_PPDS@
b94498cf 1184 * operation.
1185 *
1186 * You must remove (unlink) the PPD file when you are finished with
1187 * it. The PPD filename is stored in a static location that will be
5a738aea
MS
1188 * overwritten on the next call to @link cupsGetPPD@, @link cupsGetPPD2@,
1189 * or @link cupsGetServerPPD@.
b94498cf 1190 *
1191 * @since CUPS 1.3@
1192 */
1193
5a738aea 1194char * /* O - Name of PPD file or @code NULL@ on error */
568fa3fa 1195cupsGetServerPPD(http_t *http, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
b94498cf 1196 const char *name) /* I - Name of PPD file ("ppd-name") */
1197{
1198 int fd; /* PPD file descriptor */
1199 ipp_t *request; /* IPP request */
1200 _cups_globals_t *cg = _cupsGlobals();
1201 /* Pointer to library globals */
1202
1203
1204 /*
1205 * Range check input...
1206 */
1207
3d052e43 1208 if (!name)
b94498cf 1209 {
3d052e43 1210 _cupsSetError(IPP_INTERNAL_ERROR, "No PPD name!");
b94498cf 1211
1212 return (NULL);
1213 }
1214
3d052e43
MS
1215 if (!http)
1216 if ((http = _cupsConnect()) == NULL)
1217 return (NULL);
1218
b94498cf 1219 /*
1220 * Get a temp file...
1221 */
1222
1223 if ((fd = cupsTempFd(cg->ppd_filename, sizeof(cg->ppd_filename))) < 0)
1224 {
1225 /*
1226 * Can't open file; close the server connection and return NULL...
1227 */
1228
1229 _cupsSetError(IPP_INTERNAL_ERROR, strerror(errno));
1230
1231 return (NULL);
1232 }
1233
1234 /*
1235 * Get the PPD file...
1236 */
1237
1238 request = ippNewRequest(CUPS_GET_PPD);
1239 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "ppd-name", NULL,
1240 name);
1241
1242 ippDelete(cupsDoIORequest(http, request, "/", -1, fd));
1243
1244 close(fd);
1245
1246 if (cupsLastError() != IPP_OK)
1247 {
1248 unlink(cg->ppd_filename);
1249 return (NULL);
1250 }
1251 else
1252 return (cg->ppd_filename);
1253}
1254
1255
ef416fc2 1256/*
1257 * 'cupsLastError()' - Return the last IPP status code.
1258 */
1259
1260ipp_status_t /* O - IPP status code from last request */
1261cupsLastError(void)
1262{
1263 return (_cupsGlobals()->last_error);
1264}
1265
1266
1267/*
1268 * 'cupsLastErrorString()' - Return the last IPP status-message.
1269 *
1270 * @since CUPS 1.2@
1271 */
1272
1273const char * /* O - status-message text from last request */
1274cupsLastErrorString(void)
1275{
1276 return (_cupsGlobals()->last_status_message);
1277}
1278
1279
1280/*
1281 * 'cupsPrintFile()' - Print a file to a printer or class on the default server.
1282 */
1283
5a738aea 1284int /* O - Job ID or 0 on error */
568fa3fa 1285cupsPrintFile(const char *name, /* I - Destination name */
ef416fc2 1286 const char *filename, /* I - File to print */
1287 const char *title, /* I - Title of job */
1288 int num_options,/* I - Number of options */
1289 cups_option_t *options) /* I - Options */
1290{
1291 DEBUG_printf(("cupsPrintFile(name=\"%s\", filename=\"%s\", "
1292 "title=\"%s\", num_options=%d, options=%p)\n",
1293 name, filename, title, num_options, options));
1294
3d052e43
MS
1295 return (cupsPrintFiles2(CUPS_HTTP_DEFAULT, name, 1, &filename, title,
1296 num_options, options));
ef416fc2 1297}
1298
1299
1300/*
5a738aea
MS
1301 * 'cupsPrintFile2()' - Print a file to a printer or class on the specified
1302 * server.
ef416fc2 1303 *
1304 * @since CUPS 1.1.21@
1305 */
1306
5a738aea 1307int /* O - Job ID or 0 on error */
3d052e43 1308cupsPrintFile2(
568fa3fa
MS
1309 http_t *http, /* I - Connection to server */
1310 const char *name, /* I - Destination name */
3d052e43
MS
1311 const char *filename, /* I - File to print */
1312 const char *title, /* I - Title of job */
1313 int num_options, /* I - Number of options */
1314 cups_option_t *options) /* I - Options */
ef416fc2 1315{
1316 DEBUG_printf(("cupsPrintFile2(http=%p, name=\"%s\", filename=\"%s\", "
1317 "title=\"%s\", num_options=%d, options=%p)\n",
1318 http, name, filename, title, num_options, options));
1319
3d052e43
MS
1320 return (cupsPrintFiles2(http, name, 1, &filename, title, num_options,
1321 options));
ef416fc2 1322}
1323
1324
1325/*
fa73b229 1326 * 'cupsPrintFiles()' - Print one or more files to a printer or class on the
1327 * default server.
ef416fc2 1328 */
1329
5a738aea 1330int /* O - Job ID or 0 on error */
3d052e43 1331cupsPrintFiles(
568fa3fa 1332 const char *name, /* I - Destination name */
3d052e43
MS
1333 int num_files, /* I - Number of files */
1334 const char **files, /* I - File(s) to print */
1335 const char *title, /* I - Title of job */
1336 int num_options, /* I - Number of options */
1337 cups_option_t *options) /* I - Options */
ef416fc2 1338{
ef416fc2 1339 DEBUG_printf(("cupsPrintFiles(name=\"%s\", num_files=%d, "
1340 "files=%p, title=\"%s\", num_options=%d, options=%p)\n",
1341 name, num_files, files, title, num_options, options));
1342
1343
ef416fc2 1344 /*
1345 * Print the file(s)...
1346 */
1347
3d052e43 1348 return (cupsPrintFiles2(CUPS_HTTP_DEFAULT, name, num_files, files, title,
ef416fc2 1349 num_options, options));
1350}
1351
1352
ef416fc2 1353/*
fa73b229 1354 * 'cupsPrintFiles2()' - Print one or more files to a printer or class on the
1355 * specified server.
ef416fc2 1356 *
1357 * @since CUPS 1.1.21@
1358 */
1359
5a738aea 1360int /* O - Job ID or 0 on error */
3d052e43 1361cupsPrintFiles2(
568fa3fa
MS
1362 http_t *http, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
1363 const char *name, /* I - Destination name */
3d052e43
MS
1364 int num_files, /* I - Number of files */
1365 const char **files, /* I - File(s) to print */
1366 const char *title, /* I - Title of job */
1367 int num_options, /* I - Number of options */
1368 cups_option_t *options) /* I - Options */
ef416fc2 1369{
1370 int i; /* Looping var */
3d052e43
MS
1371 int job_id; /* New job ID */
1372 const char *docname; /* Basename of current filename */
1373 const char *format; /* Document format */
1374 cups_file_t *fp; /* Current file */
1375 char buffer[8192]; /* Copy buffer */
1376 ssize_t bytes; /* Bytes in buffer */
1377 http_status_t status; /* Status of write */
ef416fc2 1378
1379
3d052e43 1380 DEBUG_printf(("cupsPrintFiles2(http=%p, name=\"%s\", num_files=%d, "
ef416fc2 1381 "files=%p, title=\"%s\", num_options=%d, options=%p)\n",
1382 http, name, num_files, files, title, num_options, options));
1383
1384 /*
1385 * Range check input...
1386 */
1387
3d052e43 1388 if (!name || num_files < 1 || !files)
ef416fc2 1389 {
ecdc0628 1390 _cupsSetError(IPP_INTERNAL_ERROR, NULL);
ef416fc2 1391
1392 return (0);
1393 }
1394
1395 /*
3d052e43 1396 * Create the print job...
ef416fc2 1397 */
1398
3d052e43 1399 if ((job_id = cupsCreateJob(http, name, title, num_options, options)) == 0)
ef416fc2 1400 return (0);
ef416fc2 1401
1402 /*
3d052e43 1403 * Send each of the files...
ef416fc2 1404 */
1405
3d052e43
MS
1406 if (cupsGetOption("raw", num_options, options))
1407 format = CUPS_FORMAT_RAW;
1408 else if ((format = cupsGetOption("document-format", num_options,
1409 options)) == NULL)
1410 format = CUPS_FORMAT_AUTO;
ef416fc2 1411
3d052e43
MS
1412 for (i = 0; i < num_files; i ++)
1413 {
1414 /*
1415 * Start the next file...
1416 */
ef416fc2 1417
3d052e43
MS
1418 if ((docname = strrchr(files[i], '/')) != NULL)
1419 docname ++;
1420 else
1421 docname = files[i];
ef416fc2 1422
3d052e43
MS
1423 if ((fp = cupsFileOpen(files[i], "rb")) == NULL)
1424 {
1425 /*
1426 * Unable to open print file, cancel the job and return...
1427 */
ef416fc2 1428
5a738aea 1429 cupsCancelJob2(http, name, job_id, 0);
3d052e43
MS
1430 return (0);
1431 }
ef416fc2 1432
3d052e43
MS
1433 status = cupsStartDocument(http, name, job_id, docname, format,
1434 i == (num_files - 1));
ef416fc2 1435
3d052e43
MS
1436 while (status == HTTP_CONTINUE &&
1437 (bytes = cupsFileRead(fp, buffer, sizeof(buffer))) > 0)
1438 status = cupsWriteRequestData(http, buffer, bytes);
ef416fc2 1439
3d052e43 1440 cupsFileClose(fp);
ef416fc2 1441
3d052e43 1442 if (status != HTTP_CONTINUE || cupsFinishDocument(http, name) != IPP_OK)
ef416fc2 1443 {
1444 /*
3d052e43 1445 * Unable to queue, cancel the job and return...
ef416fc2 1446 */
1447
5a738aea 1448 cupsCancelJob2(http, name, job_id, 0);
3d052e43
MS
1449 return (0);
1450 }
1451 }
ef416fc2 1452
3d052e43
MS
1453 return (job_id);
1454}
ef416fc2 1455
ef416fc2 1456
3d052e43
MS
1457/*
1458 * 'cupsStartDocument()' - Add a document to a job created with cupsCreateJob().
1459 *
5a738aea
MS
1460 * Use @link cupsWriteRequestData@ to write data for the document and
1461 * @link cupsFinishDocument@ to finish the document and get the submission status.
3d052e43 1462 *
5a738aea
MS
1463 * The MIME type constants @code CUPS_FORMAT_AUTO@, @code CUPS_FORMAT_PDF@,
1464 * @code CUPS_FORMAT_POSTSCRIPT@, @code CUPS_FORMAT_RAW@, and
1465 * @code CUPS_FORMAT_TEXT@ are provided for the "format" argument, although
1466 * any supported MIME type string can be supplied.
3d052e43
MS
1467 *
1468 * @since CUPS 1.4@
1469 */
ef416fc2 1470
3d052e43
MS
1471http_status_t /* O - HTTP status of request */
1472cupsStartDocument(
568fa3fa
MS
1473 http_t *http, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
1474 const char *name, /* I - Destination name */
5a738aea 1475 int job_id, /* I - Job ID from @link cupsCreateJob@ */
3d052e43 1476 const char *docname, /* I - Name of document */
5a738aea 1477 const char *format, /* I - MIME type or @code CUPS_FORMAT_foo@ */
3d052e43
MS
1478 int last_document) /* I - 1 for last document in job, 0 otherwise */
1479{
1480 char resource[1024], /* Resource for destinatio */
1481 printer_uri[1024]; /* Printer URI */
1482 ipp_t *request; /* Send-Document request */
1483 http_status_t status; /* HTTP status */
ef416fc2 1484
bd7854cb 1485
3d052e43
MS
1486 /*
1487 * Create a Send-Document request...
1488 */
bd7854cb 1489
3d052e43
MS
1490 if ((request = ippNewRequest(IPP_SEND_DOCUMENT)) == NULL)
1491 {
1492 _cupsSetError(IPP_INTERNAL_ERROR, NULL);
1493 return (0);
1494 }
bd7854cb 1495
3d052e43
MS
1496 httpAssembleURIf(HTTP_URI_CODING_ALL, printer_uri, sizeof(printer_uri), "ipp",
1497 NULL, "localhost", ippPort(), "/printers/%s", name);
1498 snprintf(resource, sizeof(resource), "/printers/%s", name);
ef416fc2 1499
3d052e43
MS
1500 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri",
1501 NULL, printer_uri);
1502 ippAddInteger(request, IPP_TAG_OPERATION, IPP_TAG_INTEGER, "job-id", job_id);
1503 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "requesting-user-name",
1504 NULL, cupsUser());
1505 if (docname)
1506 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "document-name",
1507 NULL, docname);
1508 if (format)
1509 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_MIMETYPE,
1510 "document-format", NULL, format);
1511 ippAddBoolean(request, IPP_TAG_OPERATION, "last-document", last_document);
ef416fc2 1512
3d052e43
MS
1513 /*
1514 * Send and delete the request, then return the status...
1515 */
ef416fc2 1516
3d052e43 1517 status = cupsSendRequest(http, request, resource, CUPS_LENGTH_VARIABLE);
ef416fc2 1518
3d052e43 1519 ippDelete(request);
ef416fc2 1520
3d052e43 1521 return (status);
ef416fc2 1522}
1523
1524
1525/*
3d052e43 1526 * '_cupsConnect()' - Get the default server connection...
ef416fc2 1527 */
1528
3d052e43
MS
1529http_t * /* O - HTTP connection */
1530_cupsConnect(void)
ef416fc2 1531{
3d052e43 1532 _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
ef416fc2 1533
ef416fc2 1534
1535 /*
3d052e43 1536 * See if we are connected to the same server...
ef416fc2 1537 */
1538
3d052e43
MS
1539 if (cg->http)
1540 {
1541 int port; /* Port for connection */
ef416fc2 1542
ed486911 1543
3d052e43
MS
1544 /*
1545 * Get the port associated with the current connection...
1546 */
ef416fc2 1547
3d052e43
MS
1548#ifdef AF_INET6
1549 if (cg->http->hostaddr->addr.sa_family == AF_INET6)
1550 port = ntohs(cg->http->hostaddr->ipv6.sin6_port);
1551 else
1552#endif /* AF_INET6 */
1553 if (cg->http->hostaddr->addr.sa_family == AF_INET)
1554 port = ntohs(cg->http->hostaddr->ipv4.sin_port);
1555 else
1556 port = cg->ipp_port;
ef416fc2 1557
3d052e43
MS
1558 /*
1559 * Compare the connection hostname, port, and encryption settings to
1560 * the cached defaults; these were initialized the first time we
1561 * connected...
1562 */
1563
1564 if (strcmp(cg->http->hostname, cg->server) || cg->ipp_port != port ||
1565 (cg->http->encryption != cg->encryption &&
1566 cg->http->encryption == HTTP_ENCRYPT_NEVER))
1567 {
1568 /*
1569 * Need to close the current connection because something has changed...
1570 */
ef416fc2 1571
3d052e43
MS
1572 httpClose(cg->http);
1573 cg->http = NULL;
1574 }
ef416fc2 1575 }
1576
3d052e43
MS
1577 /*
1578 * (Re)connect as needed...
1579 */
ef416fc2 1580
3d052e43 1581 if (!cg->http)
ef416fc2 1582 {
3d052e43
MS
1583 if ((cg->http = httpConnectEncrypt(cupsServer(), ippPort(),
1584 cupsEncryption())) == NULL)
1585 _cupsSetError(IPP_SERVICE_UNAVAILABLE,
1586 errno ? strerror(errno) : "Unable to connect to host.");
1587 }
ef416fc2 1588
3d052e43
MS
1589 /*
1590 * Return the cached connection...
1591 */
ef416fc2 1592
3d052e43 1593 return (cg->http);
ef416fc2 1594}
1595
1596
fa73b229 1597/*
1598 * 'cups_get_printer_uri()' - Get the printer-uri-supported attribute for the first printer in a class.
1599 */
1600
1601static int /* O - 1 on success, 0 on failure */
1602cups_get_printer_uri(
568fa3fa 1603 http_t *http, /* I - Connection to server */
fa73b229 1604 const char *name, /* I - Name of printer or class */
1605 char *host, /* I - Hostname buffer */
1606 int hostsize, /* I - Size of hostname buffer */
1607 int *port, /* O - Port number */
1608 char *resource, /* I - Resource buffer */
1609 int resourcesize, /* I - Size of resource buffer */
1610 int depth) /* I - Depth of query */
1611{
1612 int i; /* Looping var */
1613 int http_port; /* Port number */
1614 http_t *http2; /* Alternate HTTP connection */
1615 ipp_t *request, /* IPP request */
1616 *response; /* IPP response */
1617 ipp_attribute_t *attr; /* Current attribute */
1618 char uri[HTTP_MAX_URI], /* printer-uri attribute */
1619 scheme[HTTP_MAX_URI], /* Scheme name */
1620 username[HTTP_MAX_URI], /* Username:password */
ed486911 1621 classname[255], /* Temporary class name */
1622 http_hostname[HTTP_MAX_HOST];
1623 /* Hostname associated with connection */
fa73b229 1624 static const char * const requested_attrs[] =
1625 { /* Requested attributes */
1626 "printer-uri-supported",
1627 "printer-type",
1628 "member-uris"
1629 };
1630
1631
1632 DEBUG_printf(("cups_get_printer_uri(http=%p, name=\"%s\", host=%p, "
1633 "hostsize=%d, resource=%p, resourcesize=%d, depth=%d)\n",
1634 http, name ? name : "(null)", host, hostsize,
1635 resource, resourcesize, depth));
1636
1637 /*
1638 * Setup the printer URI...
1639 */
1640
a4d04587 1641 if (httpAssembleURIf(HTTP_URI_CODING_ALL, uri, sizeof(uri), "ipp", NULL,
1642 "localhost", 0, "/printers/%s", name) != HTTP_URI_OK)
fa73b229 1643 {
b423cd4c 1644 _cupsSetError(IPP_INTERNAL_ERROR, "Unable to create printer-uri!");
fa73b229 1645
1646 *host = '\0';
1647 *resource = '\0';
1648
1649 return (0);
1650 }
1651
1652 DEBUG_printf(("cups_get_printer_uri: printer-uri=\"%s\"\n", uri));
1653
1654 /*
ed486911 1655 * Get the hostname and port number we are connected to...
fa73b229 1656 */
1657
ed486911 1658 httpGetHostname(http, http_hostname, sizeof(http_hostname));
1659
fa73b229 1660#ifdef AF_INET6
1661 if (http->hostaddr->addr.sa_family == AF_INET6)
1662 http_port = ntohs(http->hostaddr->ipv6.sin6_port);
1663 else
1664#endif /* AF_INET6 */
1665 if (http->hostaddr->addr.sa_family == AF_INET)
1666 http_port = ntohs(http->hostaddr->ipv4.sin_port);
1667 else
1668 http_port = ippPort();
1669
1670 /*
1671 * Build an IPP_GET_PRINTER_ATTRIBUTES request, which requires the following
1672 * attributes:
1673 *
1674 * attributes-charset
1675 * attributes-natural-language
1676 * printer-uri
1677 * requested-attributes
1678 */
1679
1680 request = ippNewRequest(IPP_GET_PRINTER_ATTRIBUTES);
1681
1682 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri",
1683 NULL, uri);
1684
1685 ippAddStrings(request, IPP_TAG_OPERATION, IPP_TAG_NAME,
1686 "requested-attributes",
1687 sizeof(requested_attrs) / sizeof(requested_attrs[0]),
1688 NULL, requested_attrs);
1689
1690 /*
1691 * Do the request and get back a response...
1692 */
1693
1694 if ((response = cupsDoRequest(http, request, "/")) != NULL)
1695 {
1696 if ((attr = ippFindAttribute(response, "member-uris", IPP_TAG_URI)) != NULL)
1697 {
1698 /*
1699 * Get the first actual printer name in the class...
1700 */
1701
1702 for (i = 0; i < attr->num_values; i ++)
1703 {
a4d04587 1704 httpSeparateURI(HTTP_URI_CODING_ALL, attr->values[i].string.text,
1705 scheme, sizeof(scheme), username, sizeof(username),
1706 host, hostsize, port, resource, resourcesize);
fa73b229 1707 if (!strncmp(resource, "/printers/", 10))
1708 {
1709 /*
1710 * Found a printer!
1711 */
1712
1713 ippDelete(response);
1714
1715 return (1);
1716 }
1717 }
1718
1719 /*
1720 * No printers in this class - try recursively looking for a printer,
1721 * but not more than 3 levels deep...
1722 */
1723
1724 if (depth < 3)
1725 {
1726 for (i = 0; i < attr->num_values; i ++)
1727 {
a4d04587 1728 httpSeparateURI(HTTP_URI_CODING_ALL, attr->values[i].string.text,
1729 scheme, sizeof(scheme), username, sizeof(username),
1730 host, hostsize, port, resource, resourcesize);
fa73b229 1731 if (!strncmp(resource, "/classes/", 9))
1732 {
1733 /*
1734 * Found a class! Connect to the right server...
1735 */
1736
ed486911 1737 if (!strcasecmp(http_hostname, host) && *port == http_port)
fa73b229 1738 http2 = http;
1739 else if ((http2 = httpConnectEncrypt(host, *port,
1740 cupsEncryption())) == NULL)
1741 {
1742 DEBUG_puts("Unable to connect to server!");
1743
1744 continue;
1745 }
1746
1747 /*
1748 * Look up printers on that server...
1749 */
1750
1751 strlcpy(classname, resource + 9, sizeof(classname));
1752
1753 cups_get_printer_uri(http2, classname, host, hostsize, port,
1754 resource, resourcesize, depth + 1);
1755
1756 /*
1757 * Close the connection as needed...
1758 */
1759
1760 if (http2 != http)
1761 httpClose(http2);
1762
1763 if (*host)
1764 return (1);
1765 }
1766 }
1767 }
1768 }
1769 else if ((attr = ippFindAttribute(response, "printer-uri-supported",
1770 IPP_TAG_URI)) != NULL)
1771 {
a4d04587 1772 httpSeparateURI(HTTP_URI_CODING_ALL, attr->values[0].string.text,
1773 scheme, sizeof(scheme), username, sizeof(username),
1774 host, hostsize, port, resource, resourcesize);
fa73b229 1775 ippDelete(response);
1776
1777 return (1);
1778 }
1779
1780 ippDelete(response);
1781 }
1782
b86bc4cf 1783 if (cupsLastError() != IPP_NOT_FOUND)
1784 _cupsSetError(IPP_INTERNAL_ERROR, "No printer-uri found!");
b423cd4c 1785
fa73b229 1786 *host = '\0';
1787 *resource = '\0';
1788
1789 return (0);
1790}
1791
1792
ef416fc2 1793/*
2e4ff8af 1794 * End of "$Id: util.c 7014 2007-10-10 21:57:43Z mike $".
ef416fc2 1795 */