2 * PPD utilities for CUPS.
4 * Copyright 2007-2015 by Apple Inc.
5 * Copyright 1997-2006 by Easy Software Products.
7 * Licensed under Apache License v2.0. See the file "LICENSE" for more information.
11 * Include necessary headers...
14 #include "cups-private.h"
15 #include "ppd-private.h"
18 #if defined(WIN32) || defined(__EMX__)
22 #endif /* WIN32 || __EMX__ */
29 static int cups_get_printer_uri(http_t
*http
, const char *name
,
30 char *host
, int hostsize
, int *port
,
31 char *resource
, int resourcesize
,
36 * 'cupsGetPPD()' - Get the PPD file for a printer on the default server.
38 * For classes, @code cupsGetPPD@ returns the PPD file for the first printer
41 * The returned filename is stored in a static buffer and is overwritten with
42 * each call to @code cupsGetPPD@ or @link cupsGetPPD2@. The caller "owns" the
43 * file that is created and must @code unlink@ the returned filename.
46 const char * /* O - Filename for PPD file */
47 cupsGetPPD(const char *name
) /* I - Destination name */
49 _ppd_globals_t
*pg
= _ppdGlobals(); /* Pointer to library globals */
50 time_t modtime
= 0; /* Modification time */
54 * Return the PPD file...
57 pg
->ppd_filename
[0] = '\0';
59 if (cupsGetPPD3(CUPS_HTTP_DEFAULT
, name
, &modtime
, pg
->ppd_filename
,
60 sizeof(pg
->ppd_filename
)) == HTTP_STATUS_OK
)
61 return (pg
->ppd_filename
);
68 * 'cupsGetPPD2()' - Get the PPD file for a printer from the specified server.
70 * For classes, @code cupsGetPPD2@ returns the PPD file for the first printer
73 * The returned filename is stored in a static buffer and is overwritten with
74 * each call to @link cupsGetPPD@ or @code cupsGetPPD2@. The caller "owns" the
75 * file that is created and must @code unlink@ the returned filename.
77 * @since CUPS 1.1.21/macOS 10.4@
80 const char * /* O - Filename for PPD file */
81 cupsGetPPD2(http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
82 const char *name
) /* I - Destination name */
84 _ppd_globals_t
*pg
= _ppdGlobals(); /* Pointer to library globals */
85 time_t modtime
= 0; /* Modification time */
88 pg
->ppd_filename
[0] = '\0';
90 if (cupsGetPPD3(http
, name
, &modtime
, pg
->ppd_filename
,
91 sizeof(pg
->ppd_filename
)) == HTTP_STATUS_OK
)
92 return (pg
->ppd_filename
);
99 * 'cupsGetPPD3()' - Get the PPD file for a printer on the specified
100 * server if it has changed.
102 * The "modtime" parameter contains the modification time of any
103 * locally-cached content and is updated with the time from the PPD file on
106 * The "buffer" parameter contains the local PPD filename. If it contains
107 * the empty string, a new temporary file is created, otherwise the existing
108 * file will be overwritten as needed. The caller "owns" the file that is
109 * created and must @code unlink@ the returned filename.
111 * On success, @code HTTP_STATUS_OK@ is returned for a new PPD file and
112 * @code HTTP_STATUS_NOT_MODIFIED@ if the existing PPD file is up-to-date. Any other
113 * status is an error.
115 * For classes, @code cupsGetPPD3@ returns the PPD file for the first printer
118 * @since CUPS 1.4/macOS 10.6@
121 http_status_t
/* O - HTTP status */
122 cupsGetPPD3(http_t
*http
, /* I - HTTP connection or @code CUPS_HTTP_DEFAULT@ */
123 const char *name
, /* I - Destination name */
124 time_t *modtime
, /* IO - Modification time */
125 char *buffer
, /* I - Filename buffer */
126 size_t bufsize
) /* I - Size of filename buffer */
128 int http_port
; /* Port number */
129 char http_hostname
[HTTP_MAX_HOST
];
130 /* Hostname associated with connection */
131 http_t
*http2
; /* Alternate HTTP connection */
132 int fd
; /* PPD file */
133 char localhost
[HTTP_MAX_URI
],/* Local hostname */
134 hostname
[HTTP_MAX_URI
], /* Hostname */
135 resource
[HTTP_MAX_URI
]; /* Resource name */
136 int port
; /* Port number */
137 http_status_t status
; /* HTTP status from server */
138 char tempfile
[1024] = ""; /* Temporary filename */
139 _cups_globals_t
*cg
= _cupsGlobals(); /* Pointer to library globals */
143 * Range check input...
146 DEBUG_printf(("cupsGetPPD3(http=%p, name=\"%s\", modtime=%p(%d), buffer=%p, "
147 "bufsize=%d)", http
, name
, modtime
,
148 modtime
? (int)*modtime
: 0, buffer
, (int)bufsize
));
152 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("No printer name"), 1);
153 return (HTTP_STATUS_NOT_ACCEPTABLE
);
158 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("No modification time"), 1);
159 return (HTTP_STATUS_NOT_ACCEPTABLE
);
162 if (!buffer
|| bufsize
<= 1)
164 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("Bad filename buffer"), 1);
165 return (HTTP_STATUS_NOT_ACCEPTABLE
);
170 * See if the PPD file is available locally...
174 httpGetHostname(http
, hostname
, sizeof(hostname
));
177 strlcpy(hostname
, cupsServer(), sizeof(hostname
));
178 if (hostname
[0] == '/')
179 strlcpy(hostname
, "localhost", sizeof(hostname
));
182 if (!_cups_strcasecmp(hostname
, "localhost"))
184 char ppdname
[1024]; /* PPD filename */
185 struct stat ppdinfo
; /* PPD file information */
188 snprintf(ppdname
, sizeof(ppdname
), "%s/ppd/%s.ppd", cg
->cups_serverroot
,
190 if (!stat(ppdname
, &ppdinfo
) && !access(ppdname
, R_OK
))
193 * OK, the file exists and is readable, use it!
200 if (symlink(ppdname
, buffer
) && errno
!= EEXIST
)
202 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, NULL
, 0);
204 return (HTTP_STATUS_SERVER_ERROR
);
209 int tries
; /* Number of tries */
210 const char *tmpdir
; /* TMPDIR environment variable */
211 struct timeval curtime
; /* Current time */
214 * Previously we put root temporary files in the default CUPS temporary
215 * directory under /var/spool/cups. However, since the scheduler cleans
216 * out temporary files there and runs independently of the user apps, we
217 * don't want to use it unless specifically told to by cupsd.
220 if ((tmpdir
= getenv("TMPDIR")) == NULL
)
222 tmpdir
= "/private/tmp"; /* /tmp is a symlink to /private/tmp */
225 # endif /* __APPLE__ */
228 * Make the temporary name using the specified directory...
236 * Get the current time of day...
239 gettimeofday(&curtime
, NULL
);
242 * Format a string using the hex time values...
245 snprintf(buffer
, bufsize
, "%s/%08lx%05lx", tmpdir
,
246 (unsigned long)curtime
.tv_sec
,
247 (unsigned long)curtime
.tv_usec
);
250 * Try to make a symlink...
253 if (!symlink(ppdname
, buffer
))
258 while (tries
< 1000);
262 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, NULL
, 0);
264 return (HTTP_STATUS_SERVER_ERROR
);
268 if (*modtime
>= ppdinfo
.st_mtime
)
269 return (HTTP_STATUS_NOT_MODIFIED
);
272 *modtime
= ppdinfo
.st_mtime
;
273 return (HTTP_STATUS_OK
);
280 * Try finding a printer URI for this printer...
284 if ((http
= _cupsConnect()) == NULL
)
285 return (HTTP_STATUS_SERVICE_UNAVAILABLE
);
287 if (!cups_get_printer_uri(http
, name
, hostname
, sizeof(hostname
), &port
,
288 resource
, sizeof(resource
), 0))
289 return (HTTP_STATUS_NOT_FOUND
);
291 DEBUG_printf(("2cupsGetPPD3: Printer hostname=\"%s\", port=%d", hostname
,
294 if (cupsServer()[0] == '/' && !_cups_strcasecmp(hostname
, "localhost") && port
== ippPort())
297 * Redirect localhost to domain socket...
300 strlcpy(hostname
, cupsServer(), sizeof(hostname
));
303 DEBUG_printf(("2cupsGetPPD3: Redirecting to \"%s\".", hostname
));
307 * Remap local hostname to localhost...
310 httpGetHostname(NULL
, localhost
, sizeof(localhost
));
312 DEBUG_printf(("2cupsGetPPD3: Local hostname=\"%s\"", localhost
));
314 if (!_cups_strcasecmp(localhost
, hostname
))
315 strlcpy(hostname
, "localhost", sizeof(hostname
));
318 * Get the hostname and port number we are connected to...
321 httpGetHostname(http
, http_hostname
, sizeof(http_hostname
));
322 http_port
= httpAddrPort(http
->hostaddr
);
324 DEBUG_printf(("2cupsGetPPD3: Connection hostname=\"%s\", port=%d",
325 http_hostname
, http_port
));
328 * Reconnect to the correct server as needed...
331 if (!_cups_strcasecmp(http_hostname
, hostname
) && port
== http_port
)
333 else if ((http2
= httpConnect2(hostname
, port
, NULL
, AF_UNSPEC
,
334 cupsEncryption(), 1, 30000, NULL
)) == NULL
)
336 DEBUG_puts("1cupsGetPPD3: Unable to connect to server");
338 return (HTTP_STATUS_SERVICE_UNAVAILABLE
);
346 fd
= open(buffer
, O_CREAT
| O_TRUNC
| O_WRONLY
, 0600);
348 fd
= cupsTempFd(tempfile
, sizeof(tempfile
));
353 * Can't open file; close the server connection and return NULL...
356 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, NULL
, 0);
361 return (HTTP_STATUS_SERVER_ERROR
);
365 * And send a request to the HTTP server...
368 strlcat(resource
, ".ppd", sizeof(resource
));
371 httpSetField(http2
, HTTP_FIELD_IF_MODIFIED_SINCE
,
372 httpGetDateString(*modtime
));
374 status
= cupsGetFd(http2
, resource
, fd
);
379 * See if we actually got the file or an error...
382 if (status
== HTTP_STATUS_OK
)
384 *modtime
= httpGetDateTime(httpGetField(http2
, HTTP_FIELD_DATE
));
387 strlcpy(buffer
, tempfile
, bufsize
);
389 else if (status
!= HTTP_STATUS_NOT_MODIFIED
)
391 _cupsSetHTTPError(status
);
395 else if (tempfile
[0])
398 else if (tempfile
[0])
405 * Return the PPD file...
408 DEBUG_printf(("1cupsGetPPD3: Returning status %d", status
));
415 * 'cupsGetServerPPD()' - Get an available PPD file from the server.
417 * This function returns the named PPD file from the server. The
418 * list of available PPDs is provided by the IPP @code CUPS_GET_PPDS@
421 * You must remove (unlink) the PPD file when you are finished with
422 * it. The PPD filename is stored in a static location that will be
423 * overwritten on the next call to @link cupsGetPPD@, @link cupsGetPPD2@,
424 * or @link cupsGetServerPPD@.
426 * @since CUPS 1.3/macOS 10.5@
429 char * /* O - Name of PPD file or @code NULL@ on error */
430 cupsGetServerPPD(http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
431 const char *name
) /* I - Name of PPD file ("ppd-name") */
433 int fd
; /* PPD file descriptor */
434 ipp_t
*request
; /* IPP request */
435 _ppd_globals_t
*pg
= _ppdGlobals();
436 /* Pointer to library globals */
440 * Range check input...
445 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("No PPD name"), 1);
451 if ((http
= _cupsConnect()) == NULL
)
458 if ((fd
= cupsTempFd(pg
->ppd_filename
, sizeof(pg
->ppd_filename
))) < 0)
461 * Can't open file; close the server connection and return NULL...
464 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, NULL
, 0);
470 * Get the PPD file...
473 request
= ippNewRequest(IPP_OP_CUPS_GET_PPD
);
474 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
, "ppd-name", NULL
,
477 ippDelete(cupsDoIORequest(http
, request
, "/", -1, fd
));
481 if (cupsLastError() != IPP_STATUS_OK
)
483 unlink(pg
->ppd_filename
);
487 return (pg
->ppd_filename
);
492 * 'cups_get_printer_uri()' - Get the printer-uri-supported attribute for the
493 * first printer in a class.
496 static int /* O - 1 on success, 0 on failure */
497 cups_get_printer_uri(
498 http_t
*http
, /* I - Connection to server */
499 const char *name
, /* I - Name of printer or class */
500 char *host
, /* I - Hostname buffer */
501 int hostsize
, /* I - Size of hostname buffer */
502 int *port
, /* O - Port number */
503 char *resource
, /* I - Resource buffer */
504 int resourcesize
, /* I - Size of resource buffer */
505 int depth
) /* I - Depth of query */
507 int i
; /* Looping var */
508 int http_port
; /* Port number */
509 http_t
*http2
; /* Alternate HTTP connection */
510 ipp_t
*request
, /* IPP request */
511 *response
; /* IPP response */
512 ipp_attribute_t
*attr
; /* Current attribute */
513 char uri
[HTTP_MAX_URI
], /* printer-uri attribute */
514 scheme
[HTTP_MAX_URI
], /* Scheme name */
515 username
[HTTP_MAX_URI
], /* Username:password */
516 classname
[255], /* Temporary class name */
517 http_hostname
[HTTP_MAX_HOST
];
518 /* Hostname associated with connection */
519 static const char * const requested_attrs
[] =
520 { /* Requested attributes */
523 "printer-uri-supported",
528 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
));
531 * Setup the printer URI...
534 if (httpAssembleURIf(HTTP_URI_CODING_ALL
, uri
, sizeof(uri
), "ipp", NULL
, "localhost", 0, "/printers/%s", name
) < HTTP_URI_STATUS_OK
)
536 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("Unable to create printer-uri"), 1);
544 DEBUG_printf(("5cups_get_printer_uri: printer-uri=\"%s\"", uri
));
547 * Get the hostname and port number we are connected to...
550 httpGetHostname(http
, http_hostname
, sizeof(http_hostname
));
551 http_port
= httpAddrPort(http
->hostaddr
);
553 DEBUG_printf(("5cups_get_printer_uri: http_hostname=\"%s\"", http_hostname
));
556 * Build an IPP_GET_PRINTER_ATTRIBUTES request, which requires the following
560 * attributes-natural-language
562 * requested-attributes
565 request
= ippNewRequest(IPP_OP_GET_PRINTER_ATTRIBUTES
);
567 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri", NULL
, uri
);
569 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
, "requested-attributes", sizeof(requested_attrs
) / sizeof(requested_attrs
[0]), NULL
, requested_attrs
);
572 * Do the request and get back a response...
575 snprintf(resource
, (size_t)resourcesize
, "/printers/%s", name
);
577 if ((response
= cupsDoRequest(http
, request
, resource
)) != NULL
)
579 const char *device_uri
= NULL
; /* device-uri value */
581 if ((attr
= ippFindAttribute(response
, "device-uri", IPP_TAG_URI
)) != NULL
)
583 device_uri
= attr
->values
[0].string
.text
;
584 DEBUG_printf(("5cups_get_printer_uri: device-uri=\"%s\"", device_uri
));
588 (((!strncmp(device_uri
, "ipp://", 6) || !strncmp(device_uri
, "ipps://", 7)) &&
589 (strstr(device_uri
, "/printers/") != NULL
|| strstr(device_uri
, "/classes/") != NULL
)) ||
590 ((strstr(device_uri
, "._ipp.") != NULL
|| strstr(device_uri
, "._ipps.") != NULL
) &&
591 !strcmp(device_uri
+ strlen(device_uri
) - 5, "/cups"))))
594 * Statically-configured shared printer.
597 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
);
600 DEBUG_printf(("5cups_get_printer_uri: Resolved to host=\"%s\", port=%d, resource=\"%s\"", host
, *port
, resource
));
603 else if ((attr
= ippFindAttribute(response
, "member-uris", IPP_TAG_URI
)) != NULL
)
606 * Get the first actual printer name in the class...
609 DEBUG_printf(("5cups_get_printer_uri: Got member-uris with %d values.", ippGetCount(attr
)));
611 for (i
= 0; i
< attr
->num_values
; i
++)
613 DEBUG_printf(("5cups_get_printer_uri: member-uris[%d]=\"%s\"", i
, ippGetString(attr
, i
, NULL
)));
615 httpSeparateURI(HTTP_URI_CODING_ALL
, attr
->values
[i
].string
.text
, scheme
, sizeof(scheme
), username
, sizeof(username
), host
, hostsize
, port
, resource
, resourcesize
);
616 if (!strncmp(resource
, "/printers/", 10))
624 DEBUG_printf(("5cups_get_printer_uri: Found printer member with host=\"%s\", port=%d, resource=\"%s\"", host
, *port
, resource
));
630 * No printers in this class - try recursively looking for a printer,
631 * but not more than 3 levels deep...
636 for (i
= 0; i
< attr
->num_values
; i
++)
638 httpSeparateURI(HTTP_URI_CODING_ALL
, attr
->values
[i
].string
.text
,
639 scheme
, sizeof(scheme
), username
, sizeof(username
),
640 host
, hostsize
, port
, resource
, resourcesize
);
641 if (!strncmp(resource
, "/classes/", 9))
644 * Found a class! Connect to the right server...
647 if (!_cups_strcasecmp(http_hostname
, host
) && *port
== http_port
)
649 else if ((http2
= httpConnect2(host
, *port
, NULL
, AF_UNSPEC
, cupsEncryption(), 1, 30000, NULL
)) == NULL
)
651 DEBUG_puts("8cups_get_printer_uri: Unable to connect to server");
657 * Look up printers on that server...
660 strlcpy(classname
, resource
+ 9, sizeof(classname
));
662 cups_get_printer_uri(http2
, classname
, host
, hostsize
, port
,
663 resource
, resourcesize
, depth
+ 1);
666 * Close the connection as needed...
678 else if ((attr
= ippFindAttribute(response
, "printer-uri-supported", IPP_TAG_URI
)) != NULL
)
680 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
);
683 DEBUG_printf(("5cups_get_printer_uri: Resolved to host=\"%s\", port=%d, resource=\"%s\"", host
, *port
, resource
));
685 if (!strncmp(resource
, "/classes/", 9))
687 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("No printer-uri found for class"), 1);
692 DEBUG_puts("5cups_get_printer_uri: Not returning class.");
702 if (cupsLastError() != IPP_STATUS_ERROR_NOT_FOUND
)
703 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("No printer-uri found"), 1);
708 DEBUG_puts("5cups_get_printer_uri: Printer URI not found.");