2 * PPD utilities for CUPS.
4 * Copyright 2007-2015 by Apple Inc.
5 * Copyright 1997-2006 by Easy Software Products.
7 * These coded instructions, statements, and computer programs are the
8 * property of Apple Inc. and are protected by Federal copyright
9 * law. Distribution and use rights are outlined in the file "LICENSE.txt"
10 * which should have been included with this file. If this file is
11 * missing or damaged, see the license at "http://www.cups.org/".
13 * This file is subject to the Apple OS-Developed Software exception.
17 * Include necessary headers...
20 #include "cups-private.h"
21 #include "ppd-private.h"
24 #if defined(WIN32) || defined(__EMX__)
28 #endif /* WIN32 || __EMX__ */
35 static int cups_get_printer_uri(http_t
*http
, const char *name
,
36 char *host
, int hostsize
, int *port
,
37 char *resource
, int resourcesize
,
42 * 'cupsGetPPD()' - Get the PPD file for a printer on the default server.
44 * For classes, @code cupsGetPPD@ returns the PPD file for the first printer
47 * The returned filename is stored in a static buffer and is overwritten with
48 * each call to @code cupsGetPPD@ or @link cupsGetPPD2@. The caller "owns" the
49 * file that is created and must @code unlink@ the returned filename.
52 const char * /* O - Filename for PPD file */
53 cupsGetPPD(const char *name
) /* I - Destination name */
55 _ppd_globals_t
*pg
= _ppdGlobals(); /* Pointer to library globals */
56 time_t modtime
= 0; /* Modification time */
60 * Return the PPD file...
63 pg
->ppd_filename
[0] = '\0';
65 if (cupsGetPPD3(CUPS_HTTP_DEFAULT
, name
, &modtime
, pg
->ppd_filename
,
66 sizeof(pg
->ppd_filename
)) == HTTP_STATUS_OK
)
67 return (pg
->ppd_filename
);
74 * 'cupsGetPPD2()' - Get the PPD file for a printer from the specified server.
76 * For classes, @code cupsGetPPD2@ returns the PPD file for the first printer
79 * The returned filename is stored in a static buffer and is overwritten with
80 * each call to @link cupsGetPPD@ or @code cupsGetPPD2@. The caller "owns" the
81 * file that is created and must @code unlink@ the returned filename.
83 * @since CUPS 1.1.21/macOS 10.4@
86 const char * /* O - Filename for PPD file */
87 cupsGetPPD2(http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
88 const char *name
) /* I - Destination name */
90 _ppd_globals_t
*pg
= _ppdGlobals(); /* Pointer to library globals */
91 time_t modtime
= 0; /* Modification time */
94 pg
->ppd_filename
[0] = '\0';
96 if (cupsGetPPD3(http
, name
, &modtime
, pg
->ppd_filename
,
97 sizeof(pg
->ppd_filename
)) == HTTP_STATUS_OK
)
98 return (pg
->ppd_filename
);
105 * 'cupsGetPPD3()' - Get the PPD file for a printer on the specified
106 * server if it has changed.
108 * The "modtime" parameter contains the modification time of any
109 * locally-cached content and is updated with the time from the PPD file on
112 * The "buffer" parameter contains the local PPD filename. If it contains
113 * the empty string, a new temporary file is created, otherwise the existing
114 * file will be overwritten as needed. The caller "owns" the file that is
115 * created and must @code unlink@ the returned filename.
117 * On success, @code HTTP_STATUS_OK@ is returned for a new PPD file and
118 * @code HTTP_STATUS_NOT_MODIFIED@ if the existing PPD file is up-to-date. Any other
119 * status is an error.
121 * For classes, @code cupsGetPPD3@ returns the PPD file for the first printer
124 * @since CUPS 1.4/macOS 10.6@
127 http_status_t
/* O - HTTP status */
128 cupsGetPPD3(http_t
*http
, /* I - HTTP connection or @code CUPS_HTTP_DEFAULT@ */
129 const char *name
, /* I - Destination name */
130 time_t *modtime
, /* IO - Modification time */
131 char *buffer
, /* I - Filename buffer */
132 size_t bufsize
) /* I - Size of filename buffer */
134 int http_port
; /* Port number */
135 char http_hostname
[HTTP_MAX_HOST
];
136 /* Hostname associated with connection */
137 http_t
*http2
; /* Alternate HTTP connection */
138 int fd
; /* PPD file */
139 char localhost
[HTTP_MAX_URI
],/* Local hostname */
140 hostname
[HTTP_MAX_URI
], /* Hostname */
141 resource
[HTTP_MAX_URI
]; /* Resource name */
142 int port
; /* Port number */
143 http_status_t status
; /* HTTP status from server */
144 char tempfile
[1024] = ""; /* Temporary filename */
145 _cups_globals_t
*cg
= _cupsGlobals(); /* Pointer to library globals */
149 * Range check input...
152 DEBUG_printf(("cupsGetPPD3(http=%p, name=\"%s\", modtime=%p(%d), buffer=%p, "
153 "bufsize=%d)", http
, name
, modtime
,
154 modtime
? (int)*modtime
: 0, buffer
, (int)bufsize
));
158 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("No printer name"), 1);
159 return (HTTP_STATUS_NOT_ACCEPTABLE
);
164 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("No modification time"), 1);
165 return (HTTP_STATUS_NOT_ACCEPTABLE
);
168 if (!buffer
|| bufsize
<= 1)
170 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("Bad filename buffer"), 1);
171 return (HTTP_STATUS_NOT_ACCEPTABLE
);
176 * See if the PPD file is available locally...
180 httpGetHostname(http
, hostname
, sizeof(hostname
));
183 strlcpy(hostname
, cupsServer(), sizeof(hostname
));
184 if (hostname
[0] == '/')
185 strlcpy(hostname
, "localhost", sizeof(hostname
));
188 if (!_cups_strcasecmp(hostname
, "localhost"))
190 char ppdname
[1024]; /* PPD filename */
191 struct stat ppdinfo
; /* PPD file information */
194 snprintf(ppdname
, sizeof(ppdname
), "%s/ppd/%s.ppd", cg
->cups_serverroot
,
196 if (!stat(ppdname
, &ppdinfo
) && !access(ppdname
, R_OK
))
199 * OK, the file exists and is readable, use it!
206 if (symlink(ppdname
, buffer
) && errno
!= EEXIST
)
208 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, NULL
, 0);
210 return (HTTP_STATUS_SERVER_ERROR
);
215 int tries
; /* Number of tries */
216 const char *tmpdir
; /* TMPDIR environment variable */
217 struct timeval curtime
; /* Current time */
220 * Previously we put root temporary files in the default CUPS temporary
221 * directory under /var/spool/cups. However, since the scheduler cleans
222 * out temporary files there and runs independently of the user apps, we
223 * don't want to use it unless specifically told to by cupsd.
226 if ((tmpdir
= getenv("TMPDIR")) == NULL
)
228 tmpdir
= "/private/tmp"; /* /tmp is a symlink to /private/tmp */
231 # endif /* __APPLE__ */
234 * Make the temporary name using the specified directory...
242 * Get the current time of day...
245 gettimeofday(&curtime
, NULL
);
248 * Format a string using the hex time values...
251 snprintf(buffer
, bufsize
, "%s/%08lx%05lx", tmpdir
,
252 (unsigned long)curtime
.tv_sec
,
253 (unsigned long)curtime
.tv_usec
);
256 * Try to make a symlink...
259 if (!symlink(ppdname
, buffer
))
264 while (tries
< 1000);
268 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, NULL
, 0);
270 return (HTTP_STATUS_SERVER_ERROR
);
274 if (*modtime
>= ppdinfo
.st_mtime
)
275 return (HTTP_STATUS_NOT_MODIFIED
);
278 *modtime
= ppdinfo
.st_mtime
;
279 return (HTTP_STATUS_OK
);
286 * Try finding a printer URI for this printer...
290 if ((http
= _cupsConnect()) == NULL
)
291 return (HTTP_STATUS_SERVICE_UNAVAILABLE
);
293 if (!cups_get_printer_uri(http
, name
, hostname
, sizeof(hostname
), &port
,
294 resource
, sizeof(resource
), 0))
295 return (HTTP_STATUS_NOT_FOUND
);
297 DEBUG_printf(("2cupsGetPPD3: Printer hostname=\"%s\", port=%d", hostname
,
300 if (cupsServer()[0] == '/' && !_cups_strcasecmp(hostname
, "localhost") && port
== ippPort())
303 * Redirect localhost to domain socket...
306 strlcpy(hostname
, cupsServer(), sizeof(hostname
));
309 DEBUG_printf(("2cupsGetPPD3: Redirecting to \"%s\".", hostname
));
313 * Remap local hostname to localhost...
316 httpGetHostname(NULL
, localhost
, sizeof(localhost
));
318 DEBUG_printf(("2cupsGetPPD3: Local hostname=\"%s\"", localhost
));
320 if (!_cups_strcasecmp(localhost
, hostname
))
321 strlcpy(hostname
, "localhost", sizeof(hostname
));
324 * Get the hostname and port number we are connected to...
327 httpGetHostname(http
, http_hostname
, sizeof(http_hostname
));
328 http_port
= httpAddrPort(http
->hostaddr
);
330 DEBUG_printf(("2cupsGetPPD3: Connection hostname=\"%s\", port=%d",
331 http_hostname
, http_port
));
334 * Reconnect to the correct server as needed...
337 if (!_cups_strcasecmp(http_hostname
, hostname
) && port
== http_port
)
339 else if ((http2
= httpConnect2(hostname
, port
, NULL
, AF_UNSPEC
,
340 cupsEncryption(), 1, 30000, NULL
)) == NULL
)
342 DEBUG_puts("1cupsGetPPD3: Unable to connect to server");
344 return (HTTP_STATUS_SERVICE_UNAVAILABLE
);
352 fd
= open(buffer
, O_CREAT
| O_TRUNC
| O_WRONLY
, 0600);
354 fd
= cupsTempFd(tempfile
, sizeof(tempfile
));
359 * Can't open file; close the server connection and return NULL...
362 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, NULL
, 0);
367 return (HTTP_STATUS_SERVER_ERROR
);
371 * And send a request to the HTTP server...
374 strlcat(resource
, ".ppd", sizeof(resource
));
377 httpSetField(http2
, HTTP_FIELD_IF_MODIFIED_SINCE
,
378 httpGetDateString(*modtime
));
380 status
= cupsGetFd(http2
, resource
, fd
);
385 * See if we actually got the file or an error...
388 if (status
== HTTP_STATUS_OK
)
390 *modtime
= httpGetDateTime(httpGetField(http2
, HTTP_FIELD_DATE
));
393 strlcpy(buffer
, tempfile
, bufsize
);
395 else if (status
!= HTTP_STATUS_NOT_MODIFIED
)
397 _cupsSetHTTPError(status
);
401 else if (tempfile
[0])
404 else if (tempfile
[0])
411 * Return the PPD file...
414 DEBUG_printf(("1cupsGetPPD3: Returning status %d", status
));
421 * 'cupsGetServerPPD()' - Get an available PPD file from the server.
423 * This function returns the named PPD file from the server. The
424 * list of available PPDs is provided by the IPP @code CUPS_GET_PPDS@
427 * You must remove (unlink) the PPD file when you are finished with
428 * it. The PPD filename is stored in a static location that will be
429 * overwritten on the next call to @link cupsGetPPD@, @link cupsGetPPD2@,
430 * or @link cupsGetServerPPD@.
432 * @since CUPS 1.3/macOS 10.5@
435 char * /* O - Name of PPD file or @code NULL@ on error */
436 cupsGetServerPPD(http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
437 const char *name
) /* I - Name of PPD file ("ppd-name") */
439 int fd
; /* PPD file descriptor */
440 ipp_t
*request
; /* IPP request */
441 _ppd_globals_t
*pg
= _ppdGlobals();
442 /* Pointer to library globals */
446 * Range check input...
451 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("No PPD name"), 1);
457 if ((http
= _cupsConnect()) == NULL
)
464 if ((fd
= cupsTempFd(pg
->ppd_filename
, sizeof(pg
->ppd_filename
))) < 0)
467 * Can't open file; close the server connection and return NULL...
470 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, NULL
, 0);
476 * Get the PPD file...
479 request
= ippNewRequest(IPP_OP_CUPS_GET_PPD
);
480 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
, "ppd-name", NULL
,
483 ippDelete(cupsDoIORequest(http
, request
, "/", -1, fd
));
487 if (cupsLastError() != IPP_STATUS_OK
)
489 unlink(pg
->ppd_filename
);
493 return (pg
->ppd_filename
);
498 * 'cups_get_printer_uri()' - Get the printer-uri-supported attribute for the
499 * first printer in a class.
502 static int /* O - 1 on success, 0 on failure */
503 cups_get_printer_uri(
504 http_t
*http
, /* I - Connection to server */
505 const char *name
, /* I - Name of printer or class */
506 char *host
, /* I - Hostname buffer */
507 int hostsize
, /* I - Size of hostname buffer */
508 int *port
, /* O - Port number */
509 char *resource
, /* I - Resource buffer */
510 int resourcesize
, /* I - Size of resource buffer */
511 int depth
) /* I - Depth of query */
513 int i
; /* Looping var */
514 int http_port
; /* Port number */
515 http_t
*http2
; /* Alternate HTTP connection */
516 ipp_t
*request
, /* IPP request */
517 *response
; /* IPP response */
518 ipp_attribute_t
*attr
; /* Current attribute */
519 char uri
[HTTP_MAX_URI
], /* printer-uri attribute */
520 scheme
[HTTP_MAX_URI
], /* Scheme name */
521 username
[HTTP_MAX_URI
], /* Username:password */
522 classname
[255], /* Temporary class name */
523 http_hostname
[HTTP_MAX_HOST
];
524 /* Hostname associated with connection */
525 static const char * const requested_attrs
[] =
526 { /* Requested attributes */
529 "printer-uri-supported",
534 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
));
537 * Setup the printer URI...
540 if (httpAssembleURIf(HTTP_URI_CODING_ALL
, uri
, sizeof(uri
), "ipp", NULL
, "localhost", 0, "/printers/%s", name
) < HTTP_URI_STATUS_OK
)
542 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("Unable to create printer-uri"), 1);
550 DEBUG_printf(("5cups_get_printer_uri: printer-uri=\"%s\"", uri
));
553 * Get the hostname and port number we are connected to...
556 httpGetHostname(http
, http_hostname
, sizeof(http_hostname
));
557 http_port
= httpAddrPort(http
->hostaddr
);
559 DEBUG_printf(("5cups_get_printer_uri: http_hostname=\"%s\"", http_hostname
));
562 * Build an IPP_GET_PRINTER_ATTRIBUTES request, which requires the following
566 * attributes-natural-language
568 * requested-attributes
571 request
= ippNewRequest(IPP_OP_GET_PRINTER_ATTRIBUTES
);
573 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri", NULL
, uri
);
575 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
, "requested-attributes", sizeof(requested_attrs
) / sizeof(requested_attrs
[0]), NULL
, requested_attrs
);
578 * Do the request and get back a response...
581 snprintf(resource
, (size_t)resourcesize
, "/printers/%s", name
);
583 if ((response
= cupsDoRequest(http
, request
, resource
)) != NULL
)
585 const char *device_uri
= NULL
; /* device-uri value */
587 if ((attr
= ippFindAttribute(response
, "device-uri", IPP_TAG_URI
)) != NULL
)
589 device_uri
= attr
->values
[0].string
.text
;
590 DEBUG_printf(("5cups_get_printer_uri: device-uri=\"%s\"", device_uri
));
594 (((!strncmp(device_uri
, "ipp://", 6) || !strncmp(device_uri
, "ipps://", 7)) &&
595 (strstr(device_uri
, "/printers/") != NULL
|| strstr(device_uri
, "/classes/") != NULL
)) ||
596 ((strstr(device_uri
, "._ipp.") != NULL
|| strstr(device_uri
, "._ipps.") != NULL
) &&
597 !strcmp(device_uri
+ strlen(device_uri
) - 5, "/cups"))))
600 * Statically-configured shared printer.
603 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
);
606 DEBUG_printf(("5cups_get_printer_uri: Resolved to host=\"%s\", port=%d, resource=\"%s\"", host
, *port
, resource
));
609 else if ((attr
= ippFindAttribute(response
, "member-uris", IPP_TAG_URI
)) != NULL
)
612 * Get the first actual printer name in the class...
615 DEBUG_printf(("5cups_get_printer_uri: Got member-uris with %d values.", ippGetCount(attr
)));
617 for (i
= 0; i
< attr
->num_values
; i
++)
619 DEBUG_printf(("5cups_get_printer_uri: member-uris[%d]=\"%s\"", i
, ippGetString(attr
, i
, NULL
)));
621 httpSeparateURI(HTTP_URI_CODING_ALL
, attr
->values
[i
].string
.text
, scheme
, sizeof(scheme
), username
, sizeof(username
), host
, hostsize
, port
, resource
, resourcesize
);
622 if (!strncmp(resource
, "/printers/", 10))
630 DEBUG_printf(("5cups_get_printer_uri: Found printer member with host=\"%s\", port=%d, resource=\"%s\"", host
, *port
, resource
));
636 * No printers in this class - try recursively looking for a printer,
637 * but not more than 3 levels deep...
642 for (i
= 0; i
< attr
->num_values
; i
++)
644 httpSeparateURI(HTTP_URI_CODING_ALL
, attr
->values
[i
].string
.text
,
645 scheme
, sizeof(scheme
), username
, sizeof(username
),
646 host
, hostsize
, port
, resource
, resourcesize
);
647 if (!strncmp(resource
, "/classes/", 9))
650 * Found a class! Connect to the right server...
653 if (!_cups_strcasecmp(http_hostname
, host
) && *port
== http_port
)
655 else if ((http2
= httpConnect2(host
, *port
, NULL
, AF_UNSPEC
, cupsEncryption(), 1, 30000, NULL
)) == NULL
)
657 DEBUG_puts("8cups_get_printer_uri: Unable to connect to server");
663 * Look up printers on that server...
666 strlcpy(classname
, resource
+ 9, sizeof(classname
));
668 cups_get_printer_uri(http2
, classname
, host
, hostsize
, port
,
669 resource
, resourcesize
, depth
+ 1);
672 * Close the connection as needed...
684 else if ((attr
= ippFindAttribute(response
, "printer-uri-supported", IPP_TAG_URI
)) != NULL
)
686 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
);
689 DEBUG_printf(("5cups_get_printer_uri: Resolved to host=\"%s\", port=%d, resource=\"%s\"", host
, *port
, resource
));
691 if (!strncmp(resource
, "/classes/", 9))
693 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("No printer-uri found for class"), 1);
698 DEBUG_puts("5cups_get_printer_uri: Not returning class.");
708 if (cupsLastError() != IPP_STATUS_ERROR_NOT_FOUND
)
709 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("No printer-uri found"), 1);
714 DEBUG_puts("5cups_get_printer_uri: Printer URI not found.");