2 * PPD utilities for CUPS.
4 * Copyright © 2007-2018 by Apple Inc.
5 * Copyright © 1997-2006 by Easy Software Products.
7 * Licensed under Apache License v2.0. See the file "LICENSE" for more
12 * Include necessary headers...
15 #include "cups-private.h"
16 #include "ppd-private.h"
17 #include "debug-internal.h"
20 #if defined(_WIN32) || defined(__EMX__)
24 #endif /* _WIN32 || __EMX__ */
31 static int cups_get_printer_uri(http_t
*http
, const char *name
,
32 char *host
, int hostsize
, int *port
,
33 char *resource
, int resourcesize
,
38 * 'cupsGetPPD()' - Get the PPD file for a printer on the default server.
40 * For classes, @code cupsGetPPD@ returns the PPD file for the first printer
43 * The returned filename is stored in a static buffer and is overwritten with
44 * each call to @code cupsGetPPD@ or @link cupsGetPPD2@. The caller "owns" the
45 * file that is created and must @code unlink@ the returned filename.
48 const char * /* O - Filename for PPD file */
49 cupsGetPPD(const char *name
) /* I - Destination name */
51 _ppd_globals_t
*pg
= _ppdGlobals(); /* Pointer to library globals */
52 time_t modtime
= 0; /* Modification time */
56 * Return the PPD file...
59 pg
->ppd_filename
[0] = '\0';
61 if (cupsGetPPD3(CUPS_HTTP_DEFAULT
, name
, &modtime
, pg
->ppd_filename
,
62 sizeof(pg
->ppd_filename
)) == HTTP_STATUS_OK
)
63 return (pg
->ppd_filename
);
70 * 'cupsGetPPD2()' - Get the PPD file for a printer from the specified server.
72 * For classes, @code cupsGetPPD2@ returns the PPD file for the first printer
75 * The returned filename is stored in a static buffer and is overwritten with
76 * each call to @link cupsGetPPD@ or @code cupsGetPPD2@. The caller "owns" the
77 * file that is created and must @code unlink@ the returned filename.
79 * @since CUPS 1.1.21/macOS 10.4@
82 const char * /* O - Filename for PPD file */
83 cupsGetPPD2(http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
84 const char *name
) /* I - Destination name */
86 _ppd_globals_t
*pg
= _ppdGlobals(); /* Pointer to library globals */
87 time_t modtime
= 0; /* Modification time */
90 pg
->ppd_filename
[0] = '\0';
92 if (cupsGetPPD3(http
, name
, &modtime
, pg
->ppd_filename
,
93 sizeof(pg
->ppd_filename
)) == HTTP_STATUS_OK
)
94 return (pg
->ppd_filename
);
101 * 'cupsGetPPD3()' - Get the PPD file for a printer on the specified
102 * server if it has changed.
104 * The "modtime" parameter contains the modification time of any
105 * locally-cached content and is updated with the time from the PPD file on
108 * The "buffer" parameter contains the local PPD filename. If it contains
109 * the empty string, a new temporary file is created, otherwise the existing
110 * file will be overwritten as needed. The caller "owns" the file that is
111 * created and must @code unlink@ the returned filename.
113 * On success, @code HTTP_STATUS_OK@ is returned for a new PPD file and
114 * @code HTTP_STATUS_NOT_MODIFIED@ if the existing PPD file is up-to-date. Any other
115 * status is an error.
117 * For classes, @code cupsGetPPD3@ returns the PPD file for the first printer
120 * @since CUPS 1.4/macOS 10.6@
123 http_status_t
/* O - HTTP status */
124 cupsGetPPD3(http_t
*http
, /* I - HTTP connection or @code CUPS_HTTP_DEFAULT@ */
125 const char *name
, /* I - Destination name */
126 time_t *modtime
, /* IO - Modification time */
127 char *buffer
, /* I - Filename buffer */
128 size_t bufsize
) /* I - Size of filename buffer */
130 int http_port
; /* Port number */
131 char http_hostname
[HTTP_MAX_HOST
];
132 /* Hostname associated with connection */
133 http_t
*http2
; /* Alternate HTTP connection */
134 int fd
; /* PPD file */
135 char localhost
[HTTP_MAX_URI
],/* Local hostname */
136 hostname
[HTTP_MAX_URI
], /* Hostname */
137 resource
[HTTP_MAX_URI
]; /* Resource name */
138 int port
; /* Port number */
139 http_status_t status
; /* HTTP status from server */
140 char tempfile
[1024] = ""; /* Temporary filename */
141 _cups_globals_t
*cg
= _cupsGlobals(); /* Pointer to library globals */
145 * Range check input...
148 DEBUG_printf(("cupsGetPPD3(http=%p, name=\"%s\", modtime=%p(%d), buffer=%p, "
149 "bufsize=%d)", http
, name
, modtime
,
150 modtime
? (int)*modtime
: 0, buffer
, (int)bufsize
));
154 DEBUG_puts("2cupsGetPPD3: No printer name, returning NULL.");
155 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("No printer name"), 1);
156 return (HTTP_STATUS_NOT_ACCEPTABLE
);
161 DEBUG_puts("2cupsGetPPD3: No modtime, returning NULL.");
162 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("No modification time"), 1);
163 return (HTTP_STATUS_NOT_ACCEPTABLE
);
166 if (!buffer
|| bufsize
<= 1)
168 DEBUG_puts("2cupsGetPPD3: No filename buffer, returning NULL.");
169 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("Bad filename buffer"), 1);
170 return (HTTP_STATUS_NOT_ACCEPTABLE
);
175 * See if the PPD file is available locally...
179 httpGetHostname(http
, hostname
, sizeof(hostname
));
182 strlcpy(hostname
, cupsServer(), sizeof(hostname
));
183 if (hostname
[0] == '/')
184 strlcpy(hostname
, "localhost", sizeof(hostname
));
187 if (!_cups_strcasecmp(hostname
, "localhost"))
189 char ppdname
[1024]; /* PPD filename */
190 struct stat ppdinfo
; /* PPD file information */
193 snprintf(ppdname
, sizeof(ppdname
), "%s/ppd/%s.ppd", cg
->cups_serverroot
,
195 if (!stat(ppdname
, &ppdinfo
) && !access(ppdname
, R_OK
))
198 * OK, the file exists and is readable, use it!
203 DEBUG_printf(("2cupsGetPPD3: Using filename \"%s\".", buffer
));
207 if (symlink(ppdname
, buffer
) && errno
!= EEXIST
)
209 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, NULL
, 0);
211 return (HTTP_STATUS_SERVER_ERROR
);
216 int tries
; /* Number of tries */
217 const char *tmpdir
; /* TMPDIR environment variable */
218 struct timeval curtime
; /* Current time */
223 * On macOS and iOS, the TMPDIR environment variable is not always the
224 * best location to place temporary files due to sandboxing. Instead,
225 * the confstr function should be called to get the proper per-user,
226 * per-process TMPDIR value.
229 char tmppath
[1024]; /* Temporary directory */
231 if ((tmpdir
= getenv("TMPDIR")) != NULL
&& access(tmpdir
, W_OK
))
236 if (confstr(_CS_DARWIN_USER_TEMP_DIR
, tmppath
, sizeof(tmppath
)))
239 tmpdir
= "/private/tmp"; /* This should never happen */
243 * Previously we put root temporary files in the default CUPS temporary
244 * directory under /var/spool/cups. However, since the scheduler cleans
245 * out temporary files there and runs independently of the user apps, we
246 * don't want to use it unless specifically told to by cupsd.
249 if ((tmpdir
= getenv("TMPDIR")) == NULL
)
251 #endif /* __APPLE__ */
253 DEBUG_printf(("2cupsGetPPD3: tmpdir=\"%s\".", tmpdir
));
256 * Make the temporary name using the specified directory...
264 * Get the current time of day...
267 gettimeofday(&curtime
, NULL
);
270 * Format a string using the hex time values...
273 snprintf(buffer
, bufsize
, "%s/%08lx%05lx", tmpdir
,
274 (unsigned long)curtime
.tv_sec
,
275 (unsigned long)curtime
.tv_usec
);
278 * Try to make a symlink...
281 if (!symlink(ppdname
, buffer
))
284 DEBUG_printf(("2cupsGetPPD3: Symlink \"%s\" to \"%s\" failed: %s", ppdname
, buffer
, strerror(errno
)));
288 while (tries
< 1000);
292 DEBUG_puts("2cupsGetPPD3: Unable to symlink after 1000 tries, returning error.");
294 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, NULL
, 0);
296 return (HTTP_STATUS_SERVER_ERROR
);
300 if (*modtime
>= ppdinfo
.st_mtime
)
302 DEBUG_printf(("2cupsGetPPD3: Returning not-modified, filename=\"%s\".", buffer
));
303 return (HTTP_STATUS_NOT_MODIFIED
);
307 DEBUG_printf(("2cupsGetPPD3: Returning ok, filename=\"%s\", modtime=%ld.", buffer
, (long)ppdinfo
.st_mtime
));
308 *modtime
= ppdinfo
.st_mtime
;
309 return (HTTP_STATUS_OK
);
316 * Try finding a printer URI for this printer...
319 DEBUG_puts("2cupsGetPPD3: Unable to access local file, copying...");
323 if ((http
= _cupsConnect()) == NULL
)
325 DEBUG_puts("2cupsGetPPD3: Unable to connect to scheduler.");
326 return (HTTP_STATUS_SERVICE_UNAVAILABLE
);
330 if (!cups_get_printer_uri(http
, name
, hostname
, sizeof(hostname
), &port
, resource
, sizeof(resource
), 0))
332 DEBUG_puts("2cupsGetPPD3: Unable to get printer URI.");
333 return (HTTP_STATUS_NOT_FOUND
);
336 DEBUG_printf(("2cupsGetPPD3: Printer hostname=\"%s\", port=%d", hostname
, port
));
338 if (cupsServer()[0] == '/' && !_cups_strcasecmp(hostname
, "localhost") && port
== ippPort())
341 * Redirect localhost to domain socket...
344 strlcpy(hostname
, cupsServer(), sizeof(hostname
));
347 DEBUG_printf(("2cupsGetPPD3: Redirecting to \"%s\".", hostname
));
351 * Remap local hostname to localhost...
354 httpGetHostname(NULL
, localhost
, sizeof(localhost
));
356 DEBUG_printf(("2cupsGetPPD3: Local hostname=\"%s\"", localhost
));
358 if (!_cups_strcasecmp(localhost
, hostname
))
359 strlcpy(hostname
, "localhost", sizeof(hostname
));
362 * Get the hostname and port number we are connected to...
365 httpGetHostname(http
, http_hostname
, sizeof(http_hostname
));
366 http_port
= httpAddrPort(http
->hostaddr
);
368 DEBUG_printf(("2cupsGetPPD3: Connection hostname=\"%s\", port=%d",
369 http_hostname
, http_port
));
372 * Reconnect to the correct server as needed...
375 if (!_cups_strcasecmp(http_hostname
, hostname
) && port
== http_port
)
377 else if ((http2
= httpConnect2(hostname
, port
, NULL
, AF_UNSPEC
,
378 cupsEncryption(), 1, 30000, NULL
)) == NULL
)
380 DEBUG_puts("2cupsGetPPD3: Unable to connect to server");
382 return (HTTP_STATUS_SERVICE_UNAVAILABLE
);
390 fd
= open(buffer
, O_CREAT
| O_TRUNC
| O_WRONLY
, 0600);
392 fd
= cupsTempFd(tempfile
, sizeof(tempfile
));
397 * Can't open file; close the server connection and return NULL...
400 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, NULL
, 0);
405 return (HTTP_STATUS_SERVER_ERROR
);
409 * And send a request to the HTTP server...
412 strlcat(resource
, ".ppd", sizeof(resource
));
415 httpSetField(http2
, HTTP_FIELD_IF_MODIFIED_SINCE
,
416 httpGetDateString(*modtime
));
418 status
= cupsGetFd(http2
, resource
, fd
);
423 * See if we actually got the file or an error...
426 if (status
== HTTP_STATUS_OK
)
428 *modtime
= httpGetDateTime(httpGetField(http2
, HTTP_FIELD_DATE
));
431 strlcpy(buffer
, tempfile
, bufsize
);
433 else if (status
!= HTTP_STATUS_NOT_MODIFIED
)
435 _cupsSetHTTPError(status
);
439 else if (tempfile
[0])
442 else if (tempfile
[0])
449 * Return the PPD file...
452 DEBUG_printf(("2cupsGetPPD3: Returning status %d", status
));
459 * 'cupsGetServerPPD()' - Get an available PPD file from the server.
461 * This function returns the named PPD file from the server. The
462 * list of available PPDs is provided by the IPP @code CUPS_GET_PPDS@
465 * You must remove (unlink) the PPD file when you are finished with
466 * it. The PPD filename is stored in a static location that will be
467 * overwritten on the next call to @link cupsGetPPD@, @link cupsGetPPD2@,
468 * or @link cupsGetServerPPD@.
470 * @since CUPS 1.3/macOS 10.5@
473 char * /* O - Name of PPD file or @code NULL@ on error */
474 cupsGetServerPPD(http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
475 const char *name
) /* I - Name of PPD file ("ppd-name") */
477 int fd
; /* PPD file descriptor */
478 ipp_t
*request
; /* IPP request */
479 _ppd_globals_t
*pg
= _ppdGlobals();
480 /* Pointer to library globals */
484 * Range check input...
489 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("No PPD name"), 1);
495 if ((http
= _cupsConnect()) == NULL
)
502 if ((fd
= cupsTempFd(pg
->ppd_filename
, sizeof(pg
->ppd_filename
))) < 0)
505 * Can't open file; close the server connection and return NULL...
508 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, NULL
, 0);
514 * Get the PPD file...
517 request
= ippNewRequest(IPP_OP_CUPS_GET_PPD
);
518 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
, "ppd-name", NULL
,
521 ippDelete(cupsDoIORequest(http
, request
, "/", -1, fd
));
525 if (cupsLastError() != IPP_STATUS_OK
)
527 unlink(pg
->ppd_filename
);
531 return (pg
->ppd_filename
);
536 * 'cups_get_printer_uri()' - Get the printer-uri-supported attribute for the
537 * first printer in a class.
540 static int /* O - 1 on success, 0 on failure */
541 cups_get_printer_uri(
542 http_t
*http
, /* I - Connection to server */
543 const char *name
, /* I - Name of printer or class */
544 char *host
, /* I - Hostname buffer */
545 int hostsize
, /* I - Size of hostname buffer */
546 int *port
, /* O - Port number */
547 char *resource
, /* I - Resource buffer */
548 int resourcesize
, /* I - Size of resource buffer */
549 int depth
) /* I - Depth of query */
551 int i
; /* Looping var */
552 ipp_t
*request
, /* IPP request */
553 *response
; /* IPP response */
554 ipp_attribute_t
*attr
; /* Current attribute */
555 char uri
[HTTP_MAX_URI
], /* printer-uri attribute */
556 scheme
[HTTP_MAX_URI
], /* Scheme name */
557 username
[HTTP_MAX_URI
]; /* Username:password */
558 static const char * const requested_attrs
[] =
559 { /* Requested attributes */
561 "printer-uri-supported"
565 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
));
568 * Setup the printer URI...
571 if (httpAssembleURIf(HTTP_URI_CODING_ALL
, uri
, sizeof(uri
), "ipp", NULL
, "localhost", 0, "/printers/%s", name
) < HTTP_URI_STATUS_OK
)
573 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("Unable to create printer-uri"), 1);
581 DEBUG_printf(("5cups_get_printer_uri: printer-uri=\"%s\"", uri
));
584 * Build an IPP_GET_PRINTER_ATTRIBUTES request, which requires the following
588 * attributes-natural-language
590 * requested-attributes
593 request
= ippNewRequest(IPP_OP_GET_PRINTER_ATTRIBUTES
);
595 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri", NULL
, uri
);
597 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
, "requested-attributes", sizeof(requested_attrs
) / sizeof(requested_attrs
[0]), NULL
, requested_attrs
);
600 * Do the request and get back a response...
603 snprintf(resource
, (size_t)resourcesize
, "/printers/%s", name
);
605 if ((response
= cupsDoRequest(http
, request
, resource
)) != NULL
)
607 if ((attr
= ippFindAttribute(response
, "member-uris", IPP_TAG_URI
)) != NULL
)
610 * Get the first actual printer name in the class...
613 DEBUG_printf(("5cups_get_printer_uri: Got member-uris with %d values.", ippGetCount(attr
)));
615 for (i
= 0; i
< attr
->num_values
; i
++)
617 DEBUG_printf(("5cups_get_printer_uri: member-uris[%d]=\"%s\"", i
, ippGetString(attr
, i
, NULL
)));
619 httpSeparateURI(HTTP_URI_CODING_ALL
, attr
->values
[i
].string
.text
, scheme
, sizeof(scheme
), username
, sizeof(username
), host
, hostsize
, port
, resource
, resourcesize
);
620 if (!strncmp(resource
, "/printers/", 10))
628 DEBUG_printf(("5cups_get_printer_uri: Found printer member with host=\"%s\", port=%d, resource=\"%s\"", host
, *port
, resource
));
633 else if ((attr
= ippFindAttribute(response
, "printer-uri-supported", IPP_TAG_URI
)) != NULL
)
635 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
);
638 DEBUG_printf(("5cups_get_printer_uri: Resolved to host=\"%s\", port=%d, resource=\"%s\"", host
, *port
, resource
));
640 if (!strncmp(resource
, "/classes/", 9))
642 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("No printer-uri found for class"), 1);
647 DEBUG_puts("5cups_get_printer_uri: Not returning class.");
657 if (cupsLastError() != IPP_STATUS_ERROR_NOT_FOUND
)
658 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("No printer-uri found"), 1);
663 DEBUG_puts("5cups_get_printer_uri: Printer URI not found.");