]> git.ipfire.org Git - thirdparty/cups.git/blame - cups/util.c
Merge changes from CUPS 1.4svn-r8628.
[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 *
178cb736 115 * @since CUPS 1.4/Mac OS X 10.6@
3d052e43
MS
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 202 *
178cb736 203 * @since CUPS 1.4/Mac OS X 10.6@
3d052e43
MS
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\", "
e07d4801 223 "num_options=%d, options=%p)",
3d052e43
MS
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 *
178cb736 283 * @since CUPS 1.4/Mac OS X 10.6@
3d052e43
MS
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 _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
462
463
464 /*
38e73f87 465 * See if we have a user default printer set...
ef416fc2 466 */
467
38e73f87
MS
468 if (_cupsUserDefault(cg->def_printer, sizeof(cg->def_printer)))
469 return (cg->def_printer);
ef416fc2 470
471 /*
3d052e43 472 * Connect to the server as needed...
ef416fc2 473 */
474
475 if (!http)
3d052e43
MS
476 if ((http = _cupsConnect()) == NULL)
477 return (NULL);
ef416fc2 478
479 /*
480 * Build a CUPS_GET_DEFAULT request, which requires the following
481 * attributes:
482 *
483 * attributes-charset
484 * attributes-natural-language
485 */
486
2e4ff8af 487 request = ippNewRequest(CUPS_GET_DEFAULT);
ef416fc2 488
489 /*
490 * Do the request and get back a response...
491 */
492
493 if ((response = cupsDoRequest(http, request, "/")) != NULL)
494 {
3d052e43
MS
495 if ((attr = ippFindAttribute(response, "printer-name",
496 IPP_TAG_NAME)) != NULL)
ef416fc2 497 {
3d052e43
MS
498 strlcpy(cg->def_printer, attr->values[0].string.text,
499 sizeof(cg->def_printer));
ef416fc2 500 ippDelete(response);
501 return (cg->def_printer);
502 }
503
504 ippDelete(response);
505 }
506
507 return (NULL);
508}
509
510
511/*
512 * 'cupsGetJobs()' - Get the jobs from the default server.
5a738aea
MS
513 *
514 * A "whichjobs" value of @code CUPS_WHICHJOBS_ALL@ returns all jobs regardless
515 * of state, while @code CUPS_WHICHJOBS_ACTIVE@ returns jobs that are
516 * pending, processing, or held and @code CUPS_WHICHJOBS_COMPLETED@ returns
517 * jobs that are stopped, canceled, aborted, or completed.
ef416fc2 518 */
519
520int /* O - Number of jobs */
521cupsGetJobs(cups_job_t **jobs, /* O - Job data */
568fa3fa 522 const char *name, /* I - @code NULL@ = all destinations, otherwise show jobs for named destination */
ecdc0628 523 int myjobs, /* I - 0 = all users, 1 = mine */
5a738aea 524 int whichjobs) /* I - @code CUPS_WHICHJOBS_ALL@, @code CUPS_WHICHJOBS_ACTIVE@, or @code CUPS_WHICHJOBS_COMPLETED@ */
ef416fc2 525{
ef416fc2 526 /*
527 * Return the jobs...
528 */
529
5a738aea 530 return (cupsGetJobs2(CUPS_HTTP_DEFAULT, jobs, name, myjobs, whichjobs));
ef416fc2 531}
532
533
534
535/*
536 * 'cupsGetJobs2()' - Get the jobs from the specified server.
537 *
5a738aea
MS
538 * A "whichjobs" value of @code CUPS_WHICHJOBS_ALL@ returns all jobs regardless
539 * of state, while @code CUPS_WHICHJOBS_ACTIVE@ returns jobs that are
540 * pending, processing, or held and @code CUPS_WHICHJOBS_COMPLETED@ returns
541 * jobs that are stopped, canceled, aborted, or completed.
542 *
426c6a59 543 * @since CUPS 1.1.21/Mac OS X 10.4@
ef416fc2 544 */
545
546int /* O - Number of jobs */
568fa3fa 547cupsGetJobs2(http_t *http, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
ef416fc2 548 cups_job_t **jobs, /* O - Job data */
568fa3fa 549 const char *name, /* I - @code NULL@ = all destinations, otherwise show jobs for named destination */
ecdc0628 550 int myjobs, /* I - 0 = all users, 1 = mine */
5a738aea 551 int whichjobs) /* I - @code CUPS_WHICHJOBS_ALL@, @code CUPS_WHICHJOBS_ACTIVE@, or @code CUPS_WHICHJOBS_COMPLETED@ */
ef416fc2 552{
553 int n; /* Number of jobs */
554 ipp_t *request, /* IPP Request */
555 *response; /* IPP Response */
556 ipp_attribute_t *attr; /* Current attribute */
ef416fc2 557 cups_job_t *temp; /* Temporary pointer */
558 int id, /* job-id */
559 priority, /* job-priority */
560 size; /* job-k-octets */
561 ipp_jstate_t state; /* job-state */
562 time_t completed_time, /* time-at-completed */
563 creation_time, /* time-at-creation */
564 processing_time; /* time-at-processing */
565 const char *dest, /* job-printer-uri */
566 *format, /* document-format */
567 *title, /* job-name */
568 *user; /* job-originating-user-name */
569 char uri[HTTP_MAX_URI]; /* URI for jobs */
570 _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
571 static const char * const attrs[] = /* Requested attributes */
572 {
573 "job-id",
574 "job-priority",
575 "job-k-octets",
576 "job-state",
577 "time-at-completed",
578 "time-at-creation",
579 "time-at-processing",
580 "job-printer-uri",
581 "document-format",
582 "job-name",
583 "job-originating-user-name"
584 };
585
586
587 /*
588 * Range check input...
589 */
590
3d052e43 591 if (!jobs)
ef416fc2 592 {
749b1e90 593 _cupsSetError(IPP_INTERNAL_ERROR, strerror(EINVAL), 0);
ef416fc2 594
595 return (-1);
596 }
597
598 /*
599 * Get the right URI...
600 */
601
5a738aea 602 if (name)
ef416fc2 603 {
a4d04587 604 if (httpAssembleURIf(HTTP_URI_CODING_ALL, uri, sizeof(uri), "ipp", NULL,
5a738aea 605 "localhost", 0, "/printers/%s", name) != HTTP_URI_OK)
ef416fc2 606 {
749b1e90 607 _cupsSetError(IPP_INTERNAL_ERROR, _("Unable to create printer-uri!"), 1);
ef416fc2 608
609 return (-1);
610 }
611 }
612 else
b9faaae1 613 strcpy(uri, "ipp://localhost/");
ef416fc2 614
3d052e43
MS
615 if (!http)
616 if ((http = _cupsConnect()) == NULL)
617 return (-1);
ef416fc2 618
619 /*
620 * Build an IPP_GET_JOBS request, which requires the following
621 * attributes:
622 *
623 * attributes-charset
624 * attributes-natural-language
625 * printer-uri
626 * requesting-user-name
627 * which-jobs
628 * my-jobs
629 * requested-attributes
630 */
631
2e4ff8af 632 request = ippNewRequest(IPP_GET_JOBS);
ef416fc2 633
634 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI,
635 "printer-uri", NULL, uri);
636
637 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME,
638 "requesting-user-name", NULL, cupsUser());
639
640 if (myjobs)
641 ippAddBoolean(request, IPP_TAG_OPERATION, "my-jobs", 1);
642
5a738aea 643 if (whichjobs == CUPS_WHICHJOBS_COMPLETED)
ef416fc2 644 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD,
645 "which-jobs", NULL, "completed");
5a738aea 646 else if (whichjobs == CUPS_WHICHJOBS_ALL)
ecdc0628 647 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD,
648 "which-jobs", NULL, "all");
ef416fc2 649
650 ippAddStrings(request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD,
651 "requested-attributes", sizeof(attrs) / sizeof(attrs[0]),
652 NULL, attrs);
653
654 /*
655 * Do the request and get back a response...
656 */
657
658 n = 0;
659 *jobs = NULL;
660
661 if ((response = cupsDoRequest(http, request, "/")) != NULL)
662 {
3d052e43 663 for (attr = response->attrs; attr; attr = attr->next)
ef416fc2 664 {
665 /*
666 * Skip leading attributes until we hit a job...
667 */
668
3d052e43 669 while (attr && attr->group_tag != IPP_TAG_JOB)
ef416fc2 670 attr = attr->next;
671
3d052e43 672 if (!attr)
ef416fc2 673 break;
674
675 /*
676 * Pull the needed attributes from this job...
677 */
678
679 id = 0;
680 size = 0;
681 priority = 50;
682 state = IPP_JOB_PENDING;
683 user = "unknown";
684 dest = NULL;
685 format = "application/octet-stream";
686 title = "untitled";
687 creation_time = 0;
688 completed_time = 0;
689 processing_time = 0;
690
3d052e43 691 while (attr && attr->group_tag == IPP_TAG_JOB)
ef416fc2 692 {
3d052e43 693 if (!strcmp(attr->name, "job-id") &&
ef416fc2 694 attr->value_tag == IPP_TAG_INTEGER)
695 id = attr->values[0].integer;
3d052e43 696 else if (!strcmp(attr->name, "job-state") &&
ef416fc2 697 attr->value_tag == IPP_TAG_ENUM)
698 state = (ipp_jstate_t)attr->values[0].integer;
3d052e43 699 else if (!strcmp(attr->name, "job-priority") &&
ef416fc2 700 attr->value_tag == IPP_TAG_INTEGER)
701 priority = attr->values[0].integer;
3d052e43 702 else if (!strcmp(attr->name, "job-k-octets") &&
ef416fc2 703 attr->value_tag == IPP_TAG_INTEGER)
704 size = attr->values[0].integer;
3d052e43 705 else if (!strcmp(attr->name, "time-at-completed") &&
ef416fc2 706 attr->value_tag == IPP_TAG_INTEGER)
707 completed_time = attr->values[0].integer;
3d052e43 708 else if (!strcmp(attr->name, "time-at-creation") &&
ef416fc2 709 attr->value_tag == IPP_TAG_INTEGER)
710 creation_time = attr->values[0].integer;
3d052e43 711 else if (!strcmp(attr->name, "time-at-processing") &&
ef416fc2 712 attr->value_tag == IPP_TAG_INTEGER)
713 processing_time = attr->values[0].integer;
3d052e43 714 else if (!strcmp(attr->name, "job-printer-uri") &&
ef416fc2 715 attr->value_tag == IPP_TAG_URI)
716 {
717 if ((dest = strrchr(attr->values[0].string.text, '/')) != NULL)
718 dest ++;
719 }
3d052e43 720 else if (!strcmp(attr->name, "job-originating-user-name") &&
ef416fc2 721 attr->value_tag == IPP_TAG_NAME)
722 user = attr->values[0].string.text;
3d052e43 723 else if (!strcmp(attr->name, "document-format") &&
ef416fc2 724 attr->value_tag == IPP_TAG_MIMETYPE)
725 format = attr->values[0].string.text;
3d052e43 726 else if (!strcmp(attr->name, "job-name") &&
ef416fc2 727 (attr->value_tag == IPP_TAG_TEXT ||
728 attr->value_tag == IPP_TAG_NAME))
729 title = attr->values[0].string.text;
730
731 attr = attr->next;
732 }
733
734 /*
735 * See if we have everything needed...
736 */
737
3d052e43 738 if (!dest || !id)
ef416fc2 739 {
3d052e43 740 if (!attr)
ef416fc2 741 break;
742 else
743 continue;
744 }
745
746 /*
747 * Allocate memory for the job...
748 */
749
750 if (n == 0)
751 temp = malloc(sizeof(cups_job_t));
752 else
753 temp = realloc(*jobs, sizeof(cups_job_t) * (n + 1));
754
3d052e43 755 if (!temp)
ef416fc2 756 {
757 /*
758 * Ran out of memory!
759 */
760
749b1e90 761 _cupsSetError(IPP_INTERNAL_ERROR, NULL, 0);
3d052e43 762
ef416fc2 763 cupsFreeJobs(n, *jobs);
764 *jobs = NULL;
765
766 ippDelete(response);
3d052e43
MS
767
768 return (-1);
ef416fc2 769 }
770
771 *jobs = temp;
772 temp += n;
773 n ++;
774
775 /*
776 * Copy the data over...
777 */
778
3d052e43
MS
779 temp->dest = _cupsStrAlloc(dest);
780 temp->user = _cupsStrAlloc(user);
781 temp->format = _cupsStrAlloc(format);
782 temp->title = _cupsStrAlloc(title);
ef416fc2 783 temp->id = id;
784 temp->priority = priority;
785 temp->state = state;
786 temp->size = size;
787 temp->completed_time = completed_time;
788 temp->creation_time = creation_time;
789 temp->processing_time = processing_time;
790
3d052e43 791 if (!attr)
ef416fc2 792 break;
793 }
794
795 ippDelete(response);
796 }
797
798 if (n == 0 && cg->last_error >= IPP_BAD_REQUEST)
799 return (-1);
800 else
801 return (n);
802}
803
804
805/*
806 * 'cupsGetPPD()' - Get the PPD file for a printer on the default server.
807 *
5a738aea 808 * For classes, @code cupsGetPPD@ returns the PPD file for the first printer
ef416fc2 809 * in the class.
568fa3fa
MS
810 *
811 * The returned filename is stored in a static buffer and is overwritten with
812 * each call to @code cupsGetPPD@ or @link cupsGetPPD2@.
ef416fc2 813 */
814
815const char * /* O - Filename for PPD file */
568fa3fa 816cupsGetPPD(const char *name) /* I - Destination name */
ef416fc2 817{
818 _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
2e4ff8af
MS
819 time_t modtime = 0; /* Modification time */
820
ef416fc2 821
ef416fc2 822 /*
823 * Return the PPD file...
824 */
825
2e4ff8af
MS
826 cg->ppd_filename[0] = '\0';
827
3d052e43 828 if (cupsGetPPD3(CUPS_HTTP_DEFAULT, name, &modtime, cg->ppd_filename,
2e4ff8af
MS
829 sizeof(cg->ppd_filename)) == HTTP_OK)
830 return (cg->ppd_filename);
831 else
832 return (NULL);
ef416fc2 833}
834
835
836/*
837 * 'cupsGetPPD2()' - Get the PPD file for a printer from the specified server.
838 *
5a738aea 839 * For classes, @code cupsGetPPD2@ returns the PPD file for the first printer
ef416fc2 840 * in the class.
841 *
568fa3fa
MS
842 * The returned filename is stored in a static buffer and is overwritten with
843 * each call to @link cupsGetPPD@ or @code cupsGetPPD2@.
844 *
426c6a59 845 * @since CUPS 1.1.21/Mac OS X 10.4@
ef416fc2 846 */
847
848const char * /* O - Filename for PPD file */
568fa3fa
MS
849cupsGetPPD2(http_t *http, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
850 const char *name) /* I - Destination name */
2e4ff8af
MS
851{
852 _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
853 time_t modtime = 0; /* Modification time */
854
855
856 cg->ppd_filename[0] = '\0';
857
858 if (cupsGetPPD3(http, name, &modtime, cg->ppd_filename,
859 sizeof(cg->ppd_filename)) == HTTP_OK)
860 return (cg->ppd_filename);
861 else
862 return (NULL);
863}
864
865
866/*
867 * 'cupsGetPPD3()' - Get the PPD file for a printer on the specified
868 * server if it has changed.
869 *
870 * The "modtime" parameter contains the modification time of any
871 * locally-cached content and is updated with the time from the PPD file on
872 * the server.
873 *
874 * The "buffer" parameter contains the local PPD filename. If it contains
875 * the empty string, a new temporary file is created, otherwise the existing
876 * file will be overwritten as needed.
877 *
5a738aea
MS
878 * On success, @code HTTP_OK@ is returned for a new PPD file and
879 * @code HTTP_NOT_MODIFIED@ if the existing PPD file is up-to-date. Any other
880 * status is an error.
881 *
882 * For classes, @code cupsGetPPD3@ returns the PPD file for the first printer
883 * in the class.
568fa3fa 884 *
178cb736 885 * @since CUPS 1.4/Mac OS X 10.6@
2e4ff8af
MS
886 */
887
888http_status_t /* O - HTTP status */
5a738aea 889cupsGetPPD3(http_t *http, /* I - HTTP connection or @code CUPS_HTTP_DEFAULT@ */
568fa3fa 890 const char *name, /* I - Destination name */
2e4ff8af
MS
891 time_t *modtime, /* IO - Modification time */
892 char *buffer, /* I - Filename buffer */
893 size_t bufsize) /* I - Size of filename buffer */
ef416fc2 894{
ef416fc2 895 int http_port; /* Port number */
ed486911 896 char http_hostname[HTTP_MAX_HOST];
897 /* Hostname associated with connection */
ef416fc2 898 http_t *http2; /* Alternate HTTP connection */
ef416fc2 899 int fd; /* PPD file */
fa73b229 900 char localhost[HTTP_MAX_URI],/* Local hostname */
ef416fc2 901 hostname[HTTP_MAX_URI], /* Hostname */
902 resource[HTTP_MAX_URI]; /* Resource name */
903 int port; /* Port number */
904 http_status_t status; /* HTTP status from server */
905 _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
ef416fc2 906
907
908 /*
909 * Range check input...
910 */
911
2e4ff8af 912 DEBUG_printf(("cupsGetPPD3(http=%p, name=\"%s\", modtime=%p(%d), buffer=%p, "
e07d4801 913 "bufsize=%d)", http, name, modtime,
ae71f5de 914 modtime ? (int)*modtime : 0, buffer, (int)bufsize));
ef416fc2 915
2e4ff8af
MS
916 if (!name)
917 {
749b1e90 918 _cupsSetError(IPP_INTERNAL_ERROR, _("No printer name!"), 1);
2e4ff8af
MS
919 return (HTTP_NOT_ACCEPTABLE);
920 }
921
922 if (!modtime)
923 {
749b1e90 924 _cupsSetError(IPP_INTERNAL_ERROR, _("No modification time!"), 1);
2e4ff8af
MS
925 return (HTTP_NOT_ACCEPTABLE);
926 }
927
928 if (!buffer || bufsize <= 1)
929 {
749b1e90 930 _cupsSetError(IPP_INTERNAL_ERROR, _("Bad filename buffer!"), 1);
2e4ff8af 931 return (HTTP_NOT_ACCEPTABLE);
ef416fc2 932 }
933
426c6a59
MS
934#ifndef WIN32
935 /*
936 * See if the PPD file is available locally...
937 */
938
939 if (!cg->servername[0])
940 cupsServer();
941
942 if (!strcasecmp(cg->servername, "localhost"))
943 {
944 char ppdname[1024]; /* PPD filename */
945 struct stat ppdinfo; /* PPD file information */
946
947
d1c13e16
MS
948 snprintf(ppdname, sizeof(ppdname), "%s/ppd/%s.ppd", cg->cups_serverroot,
949 name);
426c6a59
MS
950 if (!stat(ppdname, &ppdinfo))
951 {
952 /*
953 * OK, the file exists, use it!
954 */
955
956 if (buffer[0])
957 {
958 unlink(buffer);
959
960 if (symlink(ppdname, buffer) && errno != EEXIST)
961 {
962 _cupsSetError(IPP_INTERNAL_ERROR, NULL, 0);
963
964 return (HTTP_SERVER_ERROR);
965 }
966 }
967 else
968 {
969 int tries; /* Number of tries */
970 const char *tmpdir; /* TMPDIR environment variable */
971 struct timeval curtime; /* Current time */
972
973 /*
974 * Previously we put root temporary files in the default CUPS temporary
975 * directory under /var/spool/cups. However, since the scheduler cleans
976 * out temporary files there and runs independently of the user apps, we
977 * don't want to use it unless specifically told to by cupsd.
978 */
979
980 if ((tmpdir = getenv("TMPDIR")) == NULL)
981# ifdef __APPLE__
982 tmpdir = "/private/tmp"; /* /tmp is a symlink to /private/tmp */
983# else
984 tmpdir = "/tmp";
985# endif /* __APPLE__ */
986
987 /*
988 * Make the temporary name using the specified directory...
989 */
990
991 tries = 0;
992
993 do
994 {
995 /*
996 * Get the current time of day...
997 */
998
999 gettimeofday(&curtime, NULL);
1000
1001 /*
1002 * Format a string using the hex time values...
1003 */
1004
1005 snprintf(buffer, bufsize, "%s/%08lx%05lx", tmpdir,
1006 (unsigned long)curtime.tv_sec,
1007 (unsigned long)curtime.tv_usec);
1008
1009 /*
1010 * Try to make a symlink...
1011 */
1012
1013 if (!symlink(ppdname, buffer))
1014 break;
1015
1016 tries ++;
1017 }
1018 while (tries < 1000);
1019
1020 if (tries >= 1000)
1021 {
1022 _cupsSetError(IPP_INTERNAL_ERROR, NULL, 0);
1023
1024 return (HTTP_SERVER_ERROR);
1025 }
1026 }
1027
d1c13e16 1028 if (*modtime >= ppdinfo.st_mtime)
426c6a59
MS
1029 return (HTTP_NOT_MODIFIED);
1030 else
1031 {
1032 *modtime = ppdinfo.st_mtime;
1033 return (HTTP_OK);
1034 }
1035 }
1036 }
1037#endif /* !WIN32 */
1038
ef416fc2 1039 /*
fa73b229 1040 * Try finding a printer URI for this printer...
ef416fc2 1041 */
1042
3d052e43 1043 if (!http)
a603edef
MS
1044 if ((http = _cupsConnect()) == NULL)
1045 return (HTTP_SERVICE_UNAVAILABLE);
3d052e43 1046
fa73b229 1047 if (!cups_get_printer_uri(http, name, hostname, sizeof(hostname), &port,
1048 resource, sizeof(resource), 0))
2e4ff8af 1049 return (HTTP_NOT_FOUND);
ef416fc2 1050
e07d4801 1051 DEBUG_printf(("2cupsGetPPD3: Printer hostname=\"%s\", port=%d", hostname,
1ff0402e 1052 port));
8ca02f3c 1053
ef416fc2 1054 /*
fa73b229 1055 * Remap local hostname to localhost...
1056 */
1057
757d2cad 1058 httpGetHostname(NULL, localhost, sizeof(localhost));
fa73b229 1059
e07d4801 1060 DEBUG_printf(("2cupsGetPPD3: Local hostname=\"%s\"", localhost));
8ca02f3c 1061
fa73b229 1062 if (!strcasecmp(localhost, hostname))
1063 strcpy(hostname, "localhost");
1064
1065 /*
ed486911 1066 * Get the hostname and port number we are connected to...
ef416fc2 1067 */
1068
ed486911 1069 httpGetHostname(http, http_hostname, sizeof(http_hostname));
1ff0402e 1070 http_port = _httpAddrPort(http->hostaddr);
ed486911 1071
e07d4801 1072 DEBUG_printf(("2cupsGetPPD3: Connection hostname=\"%s\", port=%d",
1ff0402e 1073 http_hostname, http_port));
8ca02f3c 1074
ef416fc2 1075 /*
1076 * Reconnect to the correct server as needed...
1077 */
1078
ed486911 1079 if (!strcasecmp(http_hostname, hostname) && port == http_port)
ef416fc2 1080 http2 = http;
1081 else if ((http2 = httpConnectEncrypt(hostname, port,
1082 cupsEncryption())) == NULL)
1083 {
e07d4801 1084 DEBUG_puts("1cupsGetPPD3: Unable to connect to server!");
ef416fc2 1085
2e4ff8af 1086 return (HTTP_SERVICE_UNAVAILABLE);
ef416fc2 1087 }
1088
1089 /*
1090 * Get a temp file...
1091 */
1092
2e4ff8af
MS
1093 if (buffer[0])
1094 fd = open(buffer, O_CREAT | O_TRUNC | O_WRONLY, 0600);
1095 else
1096 fd = cupsTempFd(buffer, bufsize);
1097
1098 if (fd < 0)
ef416fc2 1099 {
1100 /*
1101 * Can't open file; close the server connection and return NULL...
1102 */
1103
749b1e90 1104 _cupsSetError(IPP_INTERNAL_ERROR, NULL, 0);
ef416fc2 1105
1106 if (http2 != http)
1107 httpClose(http2);
1108
2e4ff8af 1109 return (HTTP_SERVER_ERROR);
ef416fc2 1110 }
1111
1112 /*
1113 * And send a request to the HTTP server...
1114 */
1115
fa73b229 1116 strlcat(resource, ".ppd", sizeof(resource));
ef416fc2 1117
2e4ff8af
MS
1118 if (*modtime > 0)
1119 httpSetField(http2, HTTP_FIELD_IF_MODIFIED_SINCE,
1120 httpGetDateString(*modtime));
1121
ef416fc2 1122 status = cupsGetFd(http2, resource, fd);
1123
1124 close(fd);
1125
ef416fc2 1126 /*
1127 * See if we actually got the file or an error...
1128 */
1129
2e4ff8af
MS
1130 if (status == HTTP_OK)
1131 *modtime = httpGetDateTime(httpGetField(http2, HTTP_FIELD_DATE));
1132 else if (status != HTTP_NOT_MODIFIED)
ef416fc2 1133 {
e07d4801 1134 _cupsSetHTTPError(status);
ef416fc2 1135
1136 unlink(cg->ppd_filename);
ef416fc2 1137 }
1138
91c84a35
MS
1139 if (http2 != http)
1140 httpClose(http2);
1141
ef416fc2 1142 /*
1143 * Return the PPD file...
1144 */
1145
e07d4801
MS
1146 DEBUG_printf(("1cupsGetPPD3: Returning status %d", status));
1147
2e4ff8af 1148 return (status);
ef416fc2 1149}
1150
1151
1152/*
1153 * 'cupsGetPrinters()' - Get a list of printers from the default server.
1154 *
5a738aea 1155 * This function is deprecated - use @link cupsGetDests@ instead.
ef416fc2 1156 *
1157 * @deprecated@
1158 */
1159
1160int /* O - Number of printers */
1161cupsGetPrinters(char ***printers) /* O - Printers */
1162{
1163 int n; /* Number of printers */
1164 ipp_t *request, /* IPP Request */
1165 *response; /* IPP Response */
1166 ipp_attribute_t *attr; /* Current attribute */
ef416fc2 1167 char **temp; /* Temporary pointer */
3d052e43
MS
1168 http_t *http; /* Connection to server */
1169
ef416fc2 1170
3d052e43
MS
1171 /*
1172 * Range check input...
1173 */
ef416fc2 1174
3d052e43 1175 if (!printers)
ef416fc2 1176 {
749b1e90 1177 _cupsSetError(IPP_INTERNAL_ERROR, strerror(EINVAL), 0);
ef416fc2 1178
1179 return (0);
1180 }
1181
3d052e43
MS
1182 *printers = NULL;
1183
ef416fc2 1184 /*
1185 * Try to connect to the server...
1186 */
1187
3d052e43 1188 if ((http = _cupsConnect()) == NULL)
ef416fc2 1189 return (0);
ef416fc2 1190
1191 /*
1192 * Build a CUPS_GET_PRINTERS request, which requires the following
1193 * attributes:
1194 *
1195 * attributes-charset
1196 * attributes-natural-language
1197 * requested-attributes
1198 */
1199
2e4ff8af 1200 request = ippNewRequest(CUPS_GET_PRINTERS);
ef416fc2 1201
1202 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD,
1203 "requested-attributes", NULL, "printer-name");
1204
1205 ippAddInteger(request, IPP_TAG_OPERATION, IPP_TAG_ENUM,
1206 "printer-type", 0);
1207
1208 ippAddInteger(request, IPP_TAG_OPERATION, IPP_TAG_ENUM,
1209 "printer-type-mask", CUPS_PRINTER_CLASS);
1210
1211 /*
1212 * Do the request and get back a response...
1213 */
1214
3d052e43 1215 n = 0;
ef416fc2 1216
3d052e43 1217 if ((response = cupsDoRequest(http, request, "/")) != NULL)
ef416fc2 1218 {
1219 for (attr = response->attrs; attr != NULL; attr = attr->next)
1220 if (attr->name != NULL &&
1221 strcasecmp(attr->name, "printer-name") == 0 &&
1222 attr->value_tag == IPP_TAG_NAME)
1223 {
1224 if (n == 0)
1225 temp = malloc(sizeof(char *));
1226 else
1227 temp = realloc(*printers, sizeof(char *) * (n + 1));
1228
1229 if (temp == NULL)
1230 {
1231 /*
1232 * Ran out of memory!
1233 */
1234
1235 while (n > 0)
1236 {
1237 n --;
1238 free((*printers)[n]);
1239 }
1240
1241 free(*printers);
1242 ippDelete(response);
1243 return (0);
1244 }
1245
1246 *printers = temp;
1247 temp[n] = strdup(attr->values[0].string.text);
1248 n ++;
1249 }
1250
1251 ippDelete(response);
1252 }
1253
1254 return (n);
1255}
1256
1257
b94498cf 1258/*
1259 * 'cupsGetServerPPD()' - Get an available PPD file from the server.
1260 *
1261 * This function returns the named PPD file from the server. The
5a738aea 1262 * list of available PPDs is provided by the IPP @code CUPS_GET_PPDS@
b94498cf 1263 * operation.
1264 *
1265 * You must remove (unlink) the PPD file when you are finished with
1266 * it. The PPD filename is stored in a static location that will be
5a738aea
MS
1267 * overwritten on the next call to @link cupsGetPPD@, @link cupsGetPPD2@,
1268 * or @link cupsGetServerPPD@.
b94498cf 1269 *
426c6a59 1270 * @since CUPS 1.3/Mac OS X 10.5@
b94498cf 1271 */
1272
5a738aea 1273char * /* O - Name of PPD file or @code NULL@ on error */
568fa3fa 1274cupsGetServerPPD(http_t *http, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
b94498cf 1275 const char *name) /* I - Name of PPD file ("ppd-name") */
1276{
1277 int fd; /* PPD file descriptor */
1278 ipp_t *request; /* IPP request */
1279 _cups_globals_t *cg = _cupsGlobals();
1280 /* Pointer to library globals */
1281
1282
1283 /*
1284 * Range check input...
1285 */
1286
3d052e43 1287 if (!name)
b94498cf 1288 {
749b1e90 1289 _cupsSetError(IPP_INTERNAL_ERROR, _("No PPD name!"), 1);
b94498cf 1290
1291 return (NULL);
1292 }
1293
3d052e43
MS
1294 if (!http)
1295 if ((http = _cupsConnect()) == NULL)
1296 return (NULL);
1297
b94498cf 1298 /*
1299 * Get a temp file...
1300 */
1301
1302 if ((fd = cupsTempFd(cg->ppd_filename, sizeof(cg->ppd_filename))) < 0)
1303 {
1304 /*
1305 * Can't open file; close the server connection and return NULL...
1306 */
1307
749b1e90 1308 _cupsSetError(IPP_INTERNAL_ERROR, NULL, 0);
b94498cf 1309
1310 return (NULL);
1311 }
1312
1313 /*
1314 * Get the PPD file...
1315 */
1316
1317 request = ippNewRequest(CUPS_GET_PPD);
1318 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "ppd-name", NULL,
1319 name);
1320
1321 ippDelete(cupsDoIORequest(http, request, "/", -1, fd));
1322
1323 close(fd);
1324
1325 if (cupsLastError() != IPP_OK)
1326 {
1327 unlink(cg->ppd_filename);
1328 return (NULL);
1329 }
1330 else
1331 return (cg->ppd_filename);
1332}
1333
1334
ef416fc2 1335/*
1336 * 'cupsLastError()' - Return the last IPP status code.
1337 */
1338
1339ipp_status_t /* O - IPP status code from last request */
1340cupsLastError(void)
1341{
1342 return (_cupsGlobals()->last_error);
1343}
1344
1345
1346/*
1347 * 'cupsLastErrorString()' - Return the last IPP status-message.
1348 *
426c6a59 1349 * @since CUPS 1.2/Mac OS X 10.5@
ef416fc2 1350 */
1351
1352const char * /* O - status-message text from last request */
1353cupsLastErrorString(void)
1354{
1355 return (_cupsGlobals()->last_status_message);
1356}
1357
1358
1359/*
1360 * 'cupsPrintFile()' - Print a file to a printer or class on the default server.
1361 */
1362
5a738aea 1363int /* O - Job ID or 0 on error */
568fa3fa 1364cupsPrintFile(const char *name, /* I - Destination name */
ef416fc2 1365 const char *filename, /* I - File 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 */
1369{
1370 DEBUG_printf(("cupsPrintFile(name=\"%s\", filename=\"%s\", "
e07d4801 1371 "title=\"%s\", num_options=%d, options=%p)",
ef416fc2 1372 name, filename, title, num_options, options));
1373
3d052e43
MS
1374 return (cupsPrintFiles2(CUPS_HTTP_DEFAULT, name, 1, &filename, title,
1375 num_options, options));
ef416fc2 1376}
1377
1378
1379/*
5a738aea
MS
1380 * 'cupsPrintFile2()' - Print a file to a printer or class on the specified
1381 * server.
ef416fc2 1382 *
426c6a59 1383 * @since CUPS 1.1.21/Mac OS X 10.4@
ef416fc2 1384 */
1385
5a738aea 1386int /* O - Job ID or 0 on error */
3d052e43 1387cupsPrintFile2(
568fa3fa
MS
1388 http_t *http, /* I - Connection to server */
1389 const char *name, /* I - Destination name */
3d052e43
MS
1390 const char *filename, /* I - File to print */
1391 const char *title, /* I - Title of job */
1392 int num_options, /* I - Number of options */
1393 cups_option_t *options) /* I - Options */
ef416fc2 1394{
1395 DEBUG_printf(("cupsPrintFile2(http=%p, name=\"%s\", filename=\"%s\", "
e07d4801 1396 "title=\"%s\", num_options=%d, options=%p)",
ef416fc2 1397 http, name, filename, title, num_options, options));
1398
3d052e43
MS
1399 return (cupsPrintFiles2(http, name, 1, &filename, title, num_options,
1400 options));
ef416fc2 1401}
1402
1403
1404/*
fa73b229 1405 * 'cupsPrintFiles()' - Print one or more files to a printer or class on the
1406 * default server.
ef416fc2 1407 */
1408
5a738aea 1409int /* O - Job ID or 0 on error */
3d052e43 1410cupsPrintFiles(
568fa3fa 1411 const char *name, /* I - Destination name */
3d052e43
MS
1412 int num_files, /* I - Number of files */
1413 const char **files, /* I - File(s) to print */
1414 const char *title, /* I - Title of job */
1415 int num_options, /* I - Number of options */
1416 cups_option_t *options) /* I - Options */
ef416fc2 1417{
ef416fc2 1418 DEBUG_printf(("cupsPrintFiles(name=\"%s\", num_files=%d, "
e07d4801 1419 "files=%p, title=\"%s\", num_options=%d, options=%p)",
ef416fc2 1420 name, num_files, files, title, num_options, options));
1421
ef416fc2 1422 /*
1423 * Print the file(s)...
1424 */
1425
3d052e43 1426 return (cupsPrintFiles2(CUPS_HTTP_DEFAULT, name, num_files, files, title,
ef416fc2 1427 num_options, options));
1428}
1429
1430
ef416fc2 1431/*
fa73b229 1432 * 'cupsPrintFiles2()' - Print one or more files to a printer or class on the
1433 * specified server.
ef416fc2 1434 *
426c6a59 1435 * @since CUPS 1.1.21/Mac OS X 10.4@
ef416fc2 1436 */
1437
5a738aea 1438int /* O - Job ID or 0 on error */
3d052e43 1439cupsPrintFiles2(
568fa3fa
MS
1440 http_t *http, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
1441 const char *name, /* I - Destination name */
3d052e43
MS
1442 int num_files, /* I - Number of files */
1443 const char **files, /* I - File(s) to print */
1444 const char *title, /* I - Title of job */
1445 int num_options, /* I - Number of options */
1446 cups_option_t *options) /* I - Options */
ef416fc2 1447{
1448 int i; /* Looping var */
3d052e43
MS
1449 int job_id; /* New job ID */
1450 const char *docname; /* Basename of current filename */
1451 const char *format; /* Document format */
1452 cups_file_t *fp; /* Current file */
1453 char buffer[8192]; /* Copy buffer */
1454 ssize_t bytes; /* Bytes in buffer */
1455 http_status_t status; /* Status of write */
ef416fc2 1456
1457
3d052e43 1458 DEBUG_printf(("cupsPrintFiles2(http=%p, name=\"%s\", num_files=%d, "
e07d4801 1459 "files=%p, title=\"%s\", num_options=%d, options=%p)",
ef416fc2 1460 http, name, num_files, files, title, num_options, options));
1461
1462 /*
1463 * Range check input...
1464 */
1465
3d052e43 1466 if (!name || num_files < 1 || !files)
ef416fc2 1467 {
749b1e90 1468 _cupsSetError(IPP_INTERNAL_ERROR, strerror(EINVAL), 0);
ef416fc2 1469
1470 return (0);
1471 }
1472
1473 /*
3d052e43 1474 * Create the print job...
ef416fc2 1475 */
1476
3d052e43 1477 if ((job_id = cupsCreateJob(http, name, title, num_options, options)) == 0)
ef416fc2 1478 return (0);
ef416fc2 1479
1480 /*
3d052e43 1481 * Send each of the files...
ef416fc2 1482 */
1483
3d052e43
MS
1484 if (cupsGetOption("raw", num_options, options))
1485 format = CUPS_FORMAT_RAW;
1486 else if ((format = cupsGetOption("document-format", num_options,
1487 options)) == NULL)
1488 format = CUPS_FORMAT_AUTO;
ef416fc2 1489
3d052e43
MS
1490 for (i = 0; i < num_files; i ++)
1491 {
1492 /*
1493 * Start the next file...
1494 */
ef416fc2 1495
3d052e43
MS
1496 if ((docname = strrchr(files[i], '/')) != NULL)
1497 docname ++;
1498 else
1499 docname = files[i];
ef416fc2 1500
3d052e43
MS
1501 if ((fp = cupsFileOpen(files[i], "rb")) == NULL)
1502 {
1503 /*
1504 * Unable to open print file, cancel the job and return...
1505 */
ef416fc2 1506
5a738aea 1507 cupsCancelJob2(http, name, job_id, 0);
3d052e43
MS
1508 return (0);
1509 }
ef416fc2 1510
3d052e43
MS
1511 status = cupsStartDocument(http, name, job_id, docname, format,
1512 i == (num_files - 1));
ef416fc2 1513
3d052e43
MS
1514 while (status == HTTP_CONTINUE &&
1515 (bytes = cupsFileRead(fp, buffer, sizeof(buffer))) > 0)
1516 status = cupsWriteRequestData(http, buffer, bytes);
ef416fc2 1517
3d052e43 1518 cupsFileClose(fp);
ef416fc2 1519
3d052e43 1520 if (status != HTTP_CONTINUE || cupsFinishDocument(http, name) != IPP_OK)
ef416fc2 1521 {
1522 /*
3d052e43 1523 * Unable to queue, cancel the job and return...
ef416fc2 1524 */
1525
5a738aea 1526 cupsCancelJob2(http, name, job_id, 0);
3d052e43
MS
1527 return (0);
1528 }
1529 }
ef416fc2 1530
3d052e43
MS
1531 return (job_id);
1532}
ef416fc2 1533
ef416fc2 1534
3d052e43
MS
1535/*
1536 * 'cupsStartDocument()' - Add a document to a job created with cupsCreateJob().
1537 *
5a738aea
MS
1538 * Use @link cupsWriteRequestData@ to write data for the document and
1539 * @link cupsFinishDocument@ to finish the document and get the submission status.
3d052e43 1540 *
5a738aea
MS
1541 * The MIME type constants @code CUPS_FORMAT_AUTO@, @code CUPS_FORMAT_PDF@,
1542 * @code CUPS_FORMAT_POSTSCRIPT@, @code CUPS_FORMAT_RAW@, and
1543 * @code CUPS_FORMAT_TEXT@ are provided for the "format" argument, although
1544 * any supported MIME type string can be supplied.
3d052e43 1545 *
178cb736 1546 * @since CUPS 1.4/Mac OS X 10.6@
3d052e43 1547 */
ef416fc2 1548
3d052e43
MS
1549http_status_t /* O - HTTP status of request */
1550cupsStartDocument(
568fa3fa
MS
1551 http_t *http, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
1552 const char *name, /* I - Destination name */
5a738aea 1553 int job_id, /* I - Job ID from @link cupsCreateJob@ */
3d052e43 1554 const char *docname, /* I - Name of document */
5a738aea 1555 const char *format, /* I - MIME type or @code CUPS_FORMAT_foo@ */
3d052e43
MS
1556 int last_document) /* I - 1 for last document in job, 0 otherwise */
1557{
1558 char resource[1024], /* Resource for destinatio */
1559 printer_uri[1024]; /* Printer URI */
1560 ipp_t *request; /* Send-Document request */
1561 http_status_t status; /* HTTP status */
ef416fc2 1562
bd7854cb 1563
3d052e43
MS
1564 /*
1565 * Create a Send-Document request...
1566 */
bd7854cb 1567
3d052e43
MS
1568 if ((request = ippNewRequest(IPP_SEND_DOCUMENT)) == NULL)
1569 {
749b1e90 1570 _cupsSetError(IPP_INTERNAL_ERROR, strerror(ENOMEM), 0);
3d052e43
MS
1571 return (0);
1572 }
bd7854cb 1573
3d052e43
MS
1574 httpAssembleURIf(HTTP_URI_CODING_ALL, printer_uri, sizeof(printer_uri), "ipp",
1575 NULL, "localhost", ippPort(), "/printers/%s", name);
1576 snprintf(resource, sizeof(resource), "/printers/%s", name);
ef416fc2 1577
3d052e43
MS
1578 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri",
1579 NULL, printer_uri);
1580 ippAddInteger(request, IPP_TAG_OPERATION, IPP_TAG_INTEGER, "job-id", job_id);
1581 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "requesting-user-name",
1582 NULL, cupsUser());
1583 if (docname)
1584 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "document-name",
1585 NULL, docname);
1586 if (format)
1587 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_MIMETYPE,
1588 "document-format", NULL, format);
1589 ippAddBoolean(request, IPP_TAG_OPERATION, "last-document", last_document);
ef416fc2 1590
3d052e43
MS
1591 /*
1592 * Send and delete the request, then return the status...
1593 */
ef416fc2 1594
3d052e43 1595 status = cupsSendRequest(http, request, resource, CUPS_LENGTH_VARIABLE);
ef416fc2 1596
3d052e43 1597 ippDelete(request);
ef416fc2 1598
3d052e43 1599 return (status);
ef416fc2 1600}
1601
1602
1603/*
3d052e43 1604 * '_cupsConnect()' - Get the default server connection...
ef416fc2 1605 */
1606
3d052e43
MS
1607http_t * /* O - HTTP connection */
1608_cupsConnect(void)
ef416fc2 1609{
3d052e43 1610 _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
ef416fc2 1611
ef416fc2 1612
1613 /*
3d052e43 1614 * See if we are connected to the same server...
ef416fc2 1615 */
1616
3d052e43
MS
1617 if (cg->http)
1618 {
3d052e43
MS
1619 /*
1620 * Compare the connection hostname, port, and encryption settings to
1621 * the cached defaults; these were initialized the first time we
1622 * connected...
1623 */
1624
1ff0402e
MS
1625 if (strcmp(cg->http->hostname, cg->server) ||
1626 cg->ipp_port != _httpAddrPort(cg->http->hostaddr) ||
3d052e43
MS
1627 (cg->http->encryption != cg->encryption &&
1628 cg->http->encryption == HTTP_ENCRYPT_NEVER))
1629 {
1630 /*
1631 * Need to close the current connection because something has changed...
1632 */
ef416fc2 1633
3d052e43
MS
1634 httpClose(cg->http);
1635 cg->http = NULL;
1636 }
ef416fc2 1637 }
1638
3d052e43
MS
1639 /*
1640 * (Re)connect as needed...
1641 */
ef416fc2 1642
3d052e43 1643 if (!cg->http)
ef416fc2 1644 {
3d052e43
MS
1645 if ((cg->http = httpConnectEncrypt(cupsServer(), ippPort(),
1646 cupsEncryption())) == NULL)
749b1e90
MS
1647 {
1648 if (errno)
1649 _cupsSetError(IPP_SERVICE_UNAVAILABLE, NULL, 0);
1650 else
1651 _cupsSetError(IPP_SERVICE_UNAVAILABLE,
1652 _("Unable to connect to host."), 1);
1653 }
3d052e43 1654 }
ef416fc2 1655
3d052e43
MS
1656 /*
1657 * Return the cached connection...
1658 */
ef416fc2 1659
3d052e43 1660 return (cg->http);
ef416fc2 1661}
1662
1663
fa73b229 1664/*
58dc1933
MS
1665 * 'cups_get_printer_uri()' - Get the printer-uri-supported attribute for the
1666 * first printer in a class.
fa73b229 1667 */
1668
1669static int /* O - 1 on success, 0 on failure */
1670cups_get_printer_uri(
568fa3fa 1671 http_t *http, /* I - Connection to server */
fa73b229 1672 const char *name, /* I - Name of printer or class */
1673 char *host, /* I - Hostname buffer */
1674 int hostsize, /* I - Size of hostname buffer */
1675 int *port, /* O - Port number */
1676 char *resource, /* I - Resource buffer */
1677 int resourcesize, /* I - Size of resource buffer */
1678 int depth) /* I - Depth of query */
1679{
1680 int i; /* Looping var */
1681 int http_port; /* Port number */
1682 http_t *http2; /* Alternate HTTP connection */
1683 ipp_t *request, /* IPP request */
1684 *response; /* IPP response */
1685 ipp_attribute_t *attr; /* Current attribute */
1686 char uri[HTTP_MAX_URI], /* printer-uri attribute */
1687 scheme[HTTP_MAX_URI], /* Scheme name */
1688 username[HTTP_MAX_URI], /* Username:password */
ed486911 1689 classname[255], /* Temporary class name */
1690 http_hostname[HTTP_MAX_HOST];
1691 /* Hostname associated with connection */
fa73b229 1692 static const char * const requested_attrs[] =
1693 { /* Requested attributes */
58dc1933 1694 "member-uris",
fa73b229 1695 "printer-uri-supported",
58dc1933 1696 "printer-type"
fa73b229 1697 };
1698
1699
e07d4801
MS
1700 DEBUG_printf(("7cups_get_printer_uri(http=%p, name=\"%s\", host=%p, "
1701 "hostsize=%d, resource=%p, resourcesize=%d, depth=%d)",
1702 http, name, host, hostsize, resource, resourcesize, depth));
fa73b229 1703
1704 /*
1705 * Setup the printer URI...
1706 */
1707
a4d04587 1708 if (httpAssembleURIf(HTTP_URI_CODING_ALL, uri, sizeof(uri), "ipp", NULL,
1709 "localhost", 0, "/printers/%s", name) != HTTP_URI_OK)
fa73b229 1710 {
749b1e90 1711 _cupsSetError(IPP_INTERNAL_ERROR, _("Unable to create printer-uri!"), 1);
fa73b229 1712
1713 *host = '\0';
1714 *resource = '\0';
1715
1716 return (0);
1717 }
1718
e07d4801 1719 DEBUG_printf(("9cups_get_printer_uri: printer-uri=\"%s\"", uri));
fa73b229 1720
1721 /*
ed486911 1722 * Get the hostname and port number we are connected to...
fa73b229 1723 */
1724
ed486911 1725 httpGetHostname(http, http_hostname, sizeof(http_hostname));
1ff0402e 1726 http_port = _httpAddrPort(http->hostaddr);
fa73b229 1727
1728 /*
1729 * Build an IPP_GET_PRINTER_ATTRIBUTES request, which requires the following
1730 * attributes:
1731 *
1732 * attributes-charset
1733 * attributes-natural-language
1734 * printer-uri
1735 * requested-attributes
1736 */
1737
1738 request = ippNewRequest(IPP_GET_PRINTER_ATTRIBUTES);
1739
1740 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri",
1741 NULL, uri);
1742
1743 ippAddStrings(request, IPP_TAG_OPERATION, IPP_TAG_NAME,
1744 "requested-attributes",
1745 sizeof(requested_attrs) / sizeof(requested_attrs[0]),
1746 NULL, requested_attrs);
1747
1748 /*
1749 * Do the request and get back a response...
1750 */
1751
1752 if ((response = cupsDoRequest(http, request, "/")) != NULL)
1753 {
1754 if ((attr = ippFindAttribute(response, "member-uris", IPP_TAG_URI)) != NULL)
1755 {
1756 /*
1757 * Get the first actual printer name in the class...
1758 */
1759
1760 for (i = 0; i < attr->num_values; i ++)
1761 {
a4d04587 1762 httpSeparateURI(HTTP_URI_CODING_ALL, attr->values[i].string.text,
1763 scheme, sizeof(scheme), username, sizeof(username),
1764 host, hostsize, port, resource, resourcesize);
fa73b229 1765 if (!strncmp(resource, "/printers/", 10))
1766 {
1767 /*
1768 * Found a printer!
1769 */
1770
1771 ippDelete(response);
1772
1773 return (1);
1774 }
1775 }
1776
1777 /*
1778 * No printers in this class - try recursively looking for a printer,
1779 * but not more than 3 levels deep...
1780 */
1781
1782 if (depth < 3)
1783 {
1784 for (i = 0; i < attr->num_values; i ++)
1785 {
a4d04587 1786 httpSeparateURI(HTTP_URI_CODING_ALL, attr->values[i].string.text,
1787 scheme, sizeof(scheme), username, sizeof(username),
1788 host, hostsize, port, resource, resourcesize);
fa73b229 1789 if (!strncmp(resource, "/classes/", 9))
1790 {
1791 /*
1792 * Found a class! Connect to the right server...
1793 */
1794
ed486911 1795 if (!strcasecmp(http_hostname, host) && *port == http_port)
fa73b229 1796 http2 = http;
1797 else if ((http2 = httpConnectEncrypt(host, *port,
1798 cupsEncryption())) == NULL)
1799 {
e07d4801 1800 DEBUG_puts("8cups_get_printer_uri: Unable to connect to server!");
fa73b229 1801
1802 continue;
1803 }
1804
1805 /*
1806 * Look up printers on that server...
1807 */
1808
1809 strlcpy(classname, resource + 9, sizeof(classname));
1810
1811 cups_get_printer_uri(http2, classname, host, hostsize, port,
1812 resource, resourcesize, depth + 1);
1813
1814 /*
1815 * Close the connection as needed...
1816 */
1817
1818 if (http2 != http)
1819 httpClose(http2);
1820
1821 if (*host)
1822 return (1);
1823 }
1824 }
1825 }
1826 }
1827 else if ((attr = ippFindAttribute(response, "printer-uri-supported",
1828 IPP_TAG_URI)) != NULL)
1829 {
58dc1933
MS
1830 httpSeparateURI(HTTP_URI_CODING_ALL,
1831 _httpResolveURI(attr->values[0].string.text, uri,
1832 sizeof(uri), 0),
a4d04587 1833 scheme, sizeof(scheme), username, sizeof(username),
1834 host, hostsize, port, resource, resourcesize);
fa73b229 1835 ippDelete(response);
1836
dd1abb6b
MS
1837 if (!strncmp(resource, "/classes/", 9))
1838 {
749b1e90
MS
1839 _cupsSetError(IPP_INTERNAL_ERROR,
1840 _("No printer-uri found for class!"), 1);
dd1abb6b
MS
1841
1842 *host = '\0';
1843 *resource = '\0';
1844
1845 return (0);
1846 }
1847
fa73b229 1848 return (1);
1849 }
1850
1851 ippDelete(response);
1852 }
1853
b86bc4cf 1854 if (cupsLastError() != IPP_NOT_FOUND)
749b1e90 1855 _cupsSetError(IPP_INTERNAL_ERROR, _("No printer-uri found!"), 1);
b423cd4c 1856
fa73b229 1857 *host = '\0';
1858 *resource = '\0';
1859
1860 return (0);
1861}
1862
1863
ef416fc2 1864/*
b19ccc9e 1865 * End of "$Id: util.c 7850 2008-08-20 00:07:25Z mike $".
ef416fc2 1866 */