4 * PPD utilities for CUPS.
6 * Copyright 2007-2015 by Apple Inc.
7 * Copyright 1997-2006 by Easy Software Products.
9 * These coded instructions, statements, and computer programs are the
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/".
15 * This file is subject to the Apple OS-Developed Software exception.
19 * Include necessary headers...
22 #include "cups-private.h"
23 #include "ppd-private.h"
26 #if defined(WIN32) || defined(__EMX__)
30 #endif /* WIN32 || __EMX__ */
37 static int cups_get_printer_uri(http_t
*http
, const char *name
,
38 char *host
, int hostsize
, int *port
,
39 char *resource
, int resourcesize
,
44 * 'cupsGetPPD()' - Get the PPD file for a printer on the default server.
46 * For classes, @code cupsGetPPD@ returns the PPD file for the first printer
49 * The returned filename is stored in a static buffer and is overwritten with
50 * each call to @code cupsGetPPD@ or @link cupsGetPPD2@. The caller "owns" the
51 * file that is created and must @code unlink@ the returned filename.
54 const char * /* O - Filename for PPD file */
55 cupsGetPPD(const char *name
) /* I - Destination name */
57 _ppd_globals_t
*pg
= _ppdGlobals(); /* Pointer to library globals */
58 time_t modtime
= 0; /* Modification time */
62 * Return the PPD file...
65 pg
->ppd_filename
[0] = '\0';
67 if (cupsGetPPD3(CUPS_HTTP_DEFAULT
, name
, &modtime
, pg
->ppd_filename
,
68 sizeof(pg
->ppd_filename
)) == HTTP_STATUS_OK
)
69 return (pg
->ppd_filename
);
76 * 'cupsGetPPD2()' - Get the PPD file for a printer from the specified server.
78 * For classes, @code cupsGetPPD2@ returns the PPD file for the first printer
81 * The returned filename is stored in a static buffer and is overwritten with
82 * each call to @link cupsGetPPD@ or @code cupsGetPPD2@. The caller "owns" the
83 * file that is created and must @code unlink@ the returned filename.
85 * @since CUPS 1.1.21/OS X 10.4@
88 const char * /* O - Filename for PPD file */
89 cupsGetPPD2(http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
90 const char *name
) /* I - Destination name */
92 _ppd_globals_t
*pg
= _ppdGlobals(); /* Pointer to library globals */
93 time_t modtime
= 0; /* Modification time */
96 pg
->ppd_filename
[0] = '\0';
98 if (cupsGetPPD3(http
, name
, &modtime
, pg
->ppd_filename
,
99 sizeof(pg
->ppd_filename
)) == HTTP_STATUS_OK
)
100 return (pg
->ppd_filename
);
107 * 'cupsGetPPD3()' - Get the PPD file for a printer on the specified
108 * server if it has changed.
110 * The "modtime" parameter contains the modification time of any
111 * locally-cached content and is updated with the time from the PPD file on
114 * The "buffer" parameter contains the local PPD filename. If it contains
115 * the empty string, a new temporary file is created, otherwise the existing
116 * file will be overwritten as needed. The caller "owns" the file that is
117 * created and must @code unlink@ the returned filename.
119 * On success, @code HTTP_STATUS_OK@ is returned for a new PPD file and
120 * @code HTTP_STATUS_NOT_MODIFIED@ if the existing PPD file is up-to-date. Any other
121 * status is an error.
123 * For classes, @code cupsGetPPD3@ returns the PPD file for the first printer
126 * @since CUPS 1.4/OS X 10.6@
129 http_status_t
/* O - HTTP status */
130 cupsGetPPD3(http_t
*http
, /* I - HTTP connection or @code CUPS_HTTP_DEFAULT@ */
131 const char *name
, /* I - Destination name */
132 time_t *modtime
, /* IO - Modification time */
133 char *buffer
, /* I - Filename buffer */
134 size_t bufsize
) /* I - Size of filename buffer */
136 int http_port
; /* Port number */
137 char http_hostname
[HTTP_MAX_HOST
];
138 /* Hostname associated with connection */
139 http_t
*http2
; /* Alternate HTTP connection */
140 int fd
; /* PPD file */
141 char localhost
[HTTP_MAX_URI
],/* Local hostname */
142 hostname
[HTTP_MAX_URI
], /* Hostname */
143 resource
[HTTP_MAX_URI
]; /* Resource name */
144 int port
; /* Port number */
145 http_status_t status
; /* HTTP status from server */
146 char tempfile
[1024] = ""; /* Temporary filename */
147 _cups_globals_t
*cg
= _cupsGlobals(); /* Pointer to library globals */
151 * Range check input...
154 DEBUG_printf(("cupsGetPPD3(http=%p, name=\"%s\", modtime=%p(%d), buffer=%p, "
155 "bufsize=%d)", http
, name
, modtime
,
156 modtime
? (int)*modtime
: 0, buffer
, (int)bufsize
));
160 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("No printer name"), 1);
161 return (HTTP_STATUS_NOT_ACCEPTABLE
);
166 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("No modification time"), 1);
167 return (HTTP_STATUS_NOT_ACCEPTABLE
);
170 if (!buffer
|| bufsize
<= 1)
172 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("Bad filename buffer"), 1);
173 return (HTTP_STATUS_NOT_ACCEPTABLE
);
178 * See if the PPD file is available locally...
182 httpGetHostname(http
, hostname
, sizeof(hostname
));
185 strlcpy(hostname
, cupsServer(), sizeof(hostname
));
186 if (hostname
[0] == '/')
187 strlcpy(hostname
, "localhost", sizeof(hostname
));
190 if (!_cups_strcasecmp(hostname
, "localhost"))
192 char ppdname
[1024]; /* PPD filename */
193 struct stat ppdinfo
; /* PPD file information */
196 snprintf(ppdname
, sizeof(ppdname
), "%s/ppd/%s.ppd", cg
->cups_serverroot
,
198 if (!stat(ppdname
, &ppdinfo
) && !access(ppdname
, R_OK
))
201 * OK, the file exists and is readable, use it!
208 if (symlink(ppdname
, buffer
) && errno
!= EEXIST
)
210 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, NULL
, 0);
212 return (HTTP_STATUS_SERVER_ERROR
);
217 int tries
; /* Number of tries */
218 const char *tmpdir
; /* TMPDIR environment variable */
219 struct timeval curtime
; /* Current time */
222 * Previously we put root temporary files in the default CUPS temporary
223 * directory under /var/spool/cups. However, since the scheduler cleans
224 * out temporary files there and runs independently of the user apps, we
225 * don't want to use it unless specifically told to by cupsd.
228 if ((tmpdir
= getenv("TMPDIR")) == NULL
)
230 tmpdir
= "/private/tmp"; /* /tmp is a symlink to /private/tmp */
233 # endif /* __APPLE__ */
236 * Make the temporary name using the specified directory...
244 * Get the current time of day...
247 gettimeofday(&curtime
, NULL
);
250 * Format a string using the hex time values...
253 snprintf(buffer
, bufsize
, "%s/%08lx%05lx", tmpdir
,
254 (unsigned long)curtime
.tv_sec
,
255 (unsigned long)curtime
.tv_usec
);
258 * Try to make a symlink...
261 if (!symlink(ppdname
, buffer
))
266 while (tries
< 1000);
270 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, NULL
, 0);
272 return (HTTP_STATUS_SERVER_ERROR
);
276 if (*modtime
>= ppdinfo
.st_mtime
)
277 return (HTTP_STATUS_NOT_MODIFIED
);
280 *modtime
= ppdinfo
.st_mtime
;
281 return (HTTP_STATUS_OK
);
288 * Try finding a printer URI for this printer...
292 if ((http
= _cupsConnect()) == NULL
)
293 return (HTTP_STATUS_SERVICE_UNAVAILABLE
);
295 if (!cups_get_printer_uri(http
, name
, hostname
, sizeof(hostname
), &port
,
296 resource
, sizeof(resource
), 0))
297 return (HTTP_STATUS_NOT_FOUND
);
299 DEBUG_printf(("2cupsGetPPD3: Printer hostname=\"%s\", port=%d", hostname
,
302 if (cupsServer()[0] == '/' && !_cups_strcasecmp(hostname
, "localhost") && port
== ippPort())
305 * Redirect localhost to domain socket...
308 strlcpy(hostname
, cupsServer(), sizeof(hostname
));
311 DEBUG_printf(("2cupsGetPPD3: Redirecting to \"%s\".", hostname
));
315 * Remap local hostname to localhost...
318 httpGetHostname(NULL
, localhost
, sizeof(localhost
));
320 DEBUG_printf(("2cupsGetPPD3: Local hostname=\"%s\"", localhost
));
322 if (!_cups_strcasecmp(localhost
, hostname
))
323 strlcpy(hostname
, "localhost", sizeof(hostname
));
326 * Get the hostname and port number we are connected to...
329 httpGetHostname(http
, http_hostname
, sizeof(http_hostname
));
330 http_port
= httpAddrPort(http
->hostaddr
);
332 DEBUG_printf(("2cupsGetPPD3: Connection hostname=\"%s\", port=%d",
333 http_hostname
, http_port
));
336 * Reconnect to the correct server as needed...
339 if (!_cups_strcasecmp(http_hostname
, hostname
) && port
== http_port
)
341 else if ((http2
= httpConnect2(hostname
, port
, NULL
, AF_UNSPEC
,
342 cupsEncryption(), 1, 30000, NULL
)) == NULL
)
344 DEBUG_puts("1cupsGetPPD3: Unable to connect to server");
346 return (HTTP_STATUS_SERVICE_UNAVAILABLE
);
354 fd
= open(buffer
, O_CREAT
| O_TRUNC
| O_WRONLY
, 0600);
356 fd
= cupsTempFd(tempfile
, sizeof(tempfile
));
361 * Can't open file; close the server connection and return NULL...
364 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, NULL
, 0);
369 return (HTTP_STATUS_SERVER_ERROR
);
373 * And send a request to the HTTP server...
376 strlcat(resource
, ".ppd", sizeof(resource
));
379 httpSetField(http2
, HTTP_FIELD_IF_MODIFIED_SINCE
,
380 httpGetDateString(*modtime
));
382 status
= cupsGetFd(http2
, resource
, fd
);
387 * See if we actually got the file or an error...
390 if (status
== HTTP_STATUS_OK
)
392 *modtime
= httpGetDateTime(httpGetField(http2
, HTTP_FIELD_DATE
));
395 strlcpy(buffer
, tempfile
, bufsize
);
397 else if (status
!= HTTP_STATUS_NOT_MODIFIED
)
399 _cupsSetHTTPError(status
);
403 else if (tempfile
[0])
406 else if (tempfile
[0])
413 * Return the PPD file...
416 DEBUG_printf(("1cupsGetPPD3: Returning status %d", status
));
423 * 'cupsGetServerPPD()' - Get an available PPD file from the server.
425 * This function returns the named PPD file from the server. The
426 * list of available PPDs is provided by the IPP @code CUPS_GET_PPDS@
429 * You must remove (unlink) the PPD file when you are finished with
430 * it. The PPD filename is stored in a static location that will be
431 * overwritten on the next call to @link cupsGetPPD@, @link cupsGetPPD2@,
432 * or @link cupsGetServerPPD@.
434 * @since CUPS 1.3/OS X 10.5@
437 char * /* O - Name of PPD file or @code NULL@ on error */
438 cupsGetServerPPD(http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
439 const char *name
) /* I - Name of PPD file ("ppd-name") */
441 int fd
; /* PPD file descriptor */
442 ipp_t
*request
; /* IPP request */
443 _ppd_globals_t
*pg
= _ppdGlobals();
444 /* Pointer to library globals */
448 * Range check input...
453 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("No PPD name"), 1);
459 if ((http
= _cupsConnect()) == NULL
)
466 if ((fd
= cupsTempFd(pg
->ppd_filename
, sizeof(pg
->ppd_filename
))) < 0)
469 * Can't open file; close the server connection and return NULL...
472 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, NULL
, 0);
478 * Get the PPD file...
481 request
= ippNewRequest(IPP_OP_CUPS_GET_PPD
);
482 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
, "ppd-name", NULL
,
485 ippDelete(cupsDoIORequest(http
, request
, "/", -1, fd
));
489 if (cupsLastError() != IPP_STATUS_OK
)
491 unlink(pg
->ppd_filename
);
495 return (pg
->ppd_filename
);
500 * 'cups_get_printer_uri()' - Get the printer-uri-supported attribute for the
501 * first printer in a class.
504 static int /* O - 1 on success, 0 on failure */
505 cups_get_printer_uri(
506 http_t
*http
, /* I - Connection to server */
507 const char *name
, /* I - Name of printer or class */
508 char *host
, /* I - Hostname buffer */
509 int hostsize
, /* I - Size of hostname buffer */
510 int *port
, /* O - Port number */
511 char *resource
, /* I - Resource buffer */
512 int resourcesize
, /* I - Size of resource buffer */
513 int depth
) /* I - Depth of query */
515 int i
; /* Looping var */
516 int http_port
; /* Port number */
517 http_t
*http2
; /* Alternate HTTP connection */
518 ipp_t
*request
, /* IPP request */
519 *response
; /* IPP response */
520 ipp_attribute_t
*attr
; /* Current attribute */
521 char uri
[HTTP_MAX_URI
], /* printer-uri attribute */
522 scheme
[HTTP_MAX_URI
], /* Scheme name */
523 username
[HTTP_MAX_URI
], /* Username:password */
524 classname
[255], /* Temporary class name */
525 http_hostname
[HTTP_MAX_HOST
];
526 /* Hostname associated with connection */
527 static const char * const requested_attrs
[] =
528 { /* Requested attributes */
531 "printer-uri-supported",
536 DEBUG_printf(("4cups_get_printer_uri(http=%p, name=\"%s\", host=%p, hostsize=%d, resource=%p, resourcesize=%d, depth=%d)", http
, name
, host
, hostsize
, resource
, resourcesize
, depth
));
539 * Setup the printer URI...
542 if (httpAssembleURIf(HTTP_URI_CODING_ALL
, uri
, sizeof(uri
), "ipp", NULL
, "localhost", 0, "/printers/%s", name
) < HTTP_URI_STATUS_OK
)
544 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("Unable to create printer-uri"), 1);
552 DEBUG_printf(("5cups_get_printer_uri: printer-uri=\"%s\"", uri
));
555 * Get the hostname and port number we are connected to...
558 httpGetHostname(http
, http_hostname
, sizeof(http_hostname
));
559 http_port
= httpAddrPort(http
->hostaddr
);
561 DEBUG_printf(("5cups_get_printer_uri: http_hostname=\"%s\"", http_hostname
));
564 * Build an IPP_GET_PRINTER_ATTRIBUTES request, which requires the following
568 * attributes-natural-language
570 * requested-attributes
573 request
= ippNewRequest(IPP_OP_GET_PRINTER_ATTRIBUTES
);
575 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri", NULL
, uri
);
577 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
, "requested-attributes", sizeof(requested_attrs
) / sizeof(requested_attrs
[0]), NULL
, requested_attrs
);
580 * Do the request and get back a response...
583 snprintf(resource
, (size_t)resourcesize
, "/printers/%s", name
);
585 if ((response
= cupsDoRequest(http
, request
, resource
)) != NULL
)
587 const char *device_uri
= NULL
; /* device-uri value */
589 if ((attr
= ippFindAttribute(response
, "device-uri", IPP_TAG_URI
)) != NULL
)
591 device_uri
= attr
->values
[0].string
.text
;
592 DEBUG_printf(("5cups_get_printer_uri: device-uri=\"%s\"", device_uri
));
596 (((!strncmp(device_uri
, "ipp://", 6) || !strncmp(device_uri
, "ipps://", 7)) &&
597 (strstr(device_uri
, "/printers/") != NULL
|| strstr(device_uri
, "/classes/") != NULL
)) ||
598 ((strstr(device_uri
, "._ipp.") != NULL
|| strstr(device_uri
, "._ipps.") != NULL
) &&
599 !strcmp(device_uri
+ strlen(device_uri
) - 5, "/cups"))))
602 * Statically-configured shared printer.
605 httpSeparateURI(HTTP_URI_CODING_ALL
, _httpResolveURI(device_uri
, uri
, sizeof(uri
), _HTTP_RESOLVE_DEFAULT
, NULL
, NULL
), scheme
, sizeof(scheme
), username
, sizeof(username
), host
, hostsize
, port
, resource
, resourcesize
);
608 DEBUG_printf(("5cups_get_printer_uri: Resolved to host=\"%s\", port=%d, resource=\"%s\"", host
, *port
, resource
));
611 else if ((attr
= ippFindAttribute(response
, "member-uris", IPP_TAG_URI
)) != NULL
)
614 * Get the first actual printer name in the class...
617 DEBUG_printf(("5cups_get_printer_uri: Got member-uris with %d values.", ippGetCount(attr
)));
619 for (i
= 0; i
< attr
->num_values
; i
++)
621 DEBUG_printf(("5cups_get_printer_uri: member-uris[%d]=\"%s\"", i
, ippGetString(attr
, i
, NULL
)));
623 httpSeparateURI(HTTP_URI_CODING_ALL
, attr
->values
[i
].string
.text
, scheme
, sizeof(scheme
), username
, sizeof(username
), host
, hostsize
, port
, resource
, resourcesize
);
624 if (!strncmp(resource
, "/printers/", 10))
632 DEBUG_printf(("5cups_get_printer_uri: Found printer member with host=\"%s\", port=%d, resource=\"%s\"", host
, *port
, resource
));
638 * No printers in this class - try recursively looking for a printer,
639 * but not more than 3 levels deep...
644 for (i
= 0; i
< attr
->num_values
; i
++)
646 httpSeparateURI(HTTP_URI_CODING_ALL
, attr
->values
[i
].string
.text
,
647 scheme
, sizeof(scheme
), username
, sizeof(username
),
648 host
, hostsize
, port
, resource
, resourcesize
);
649 if (!strncmp(resource
, "/classes/", 9))
652 * Found a class! Connect to the right server...
655 if (!_cups_strcasecmp(http_hostname
, host
) && *port
== http_port
)
657 else if ((http2
= httpConnect2(host
, *port
, NULL
, AF_UNSPEC
, cupsEncryption(), 1, 30000, NULL
)) == NULL
)
659 DEBUG_puts("8cups_get_printer_uri: Unable to connect to server");
665 * Look up printers on that server...
668 strlcpy(classname
, resource
+ 9, sizeof(classname
));
670 cups_get_printer_uri(http2
, classname
, host
, hostsize
, port
,
671 resource
, resourcesize
, depth
+ 1);
674 * Close the connection as needed...
686 else if ((attr
= ippFindAttribute(response
, "printer-uri-supported", IPP_TAG_URI
)) != NULL
)
688 httpSeparateURI(HTTP_URI_CODING_ALL
, _httpResolveURI(attr
->values
[0].string
.text
, uri
, sizeof(uri
), _HTTP_RESOLVE_DEFAULT
, NULL
, NULL
), scheme
, sizeof(scheme
), username
, sizeof(username
), host
, hostsize
, port
, resource
, resourcesize
);
691 DEBUG_printf(("5cups_get_printer_uri: Resolved to host=\"%s\", port=%d, resource=\"%s\"", host
, *port
, resource
));
693 if (!strncmp(resource
, "/classes/", 9))
695 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("No printer-uri found for class"), 1);
700 DEBUG_puts("5cups_get_printer_uri: Not returning class.");
710 if (cupsLastError() != IPP_STATUS_ERROR_NOT_FOUND
)
711 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("No printer-uri found"), 1);
716 DEBUG_puts("5cups_get_printer_uri: Printer URI not found.");