2 * User-defined destination (and option) support for CUPS.
4 * Copyright 2007-2017 by Apple Inc.
5 * Copyright 1997-2007 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"
25 #endif /* HAVE_NOTIFY_H */
29 #endif /* HAVE_POLL */
33 #endif /* HAVE_DNSSD */
36 # include <avahi-client/client.h>
37 # include <avahi-client/lookup.h>
38 # include <avahi-common/simple-watch.h>
39 # include <avahi-common/domain.h>
40 # include <avahi-common/error.h>
41 # include <avahi-common/malloc.h>
42 #define kDNSServiceMaxDomainName AVAHI_DOMAIN_NAME_MAX
43 #endif /* HAVE_AVAHI */
52 # include <SystemConfiguration/SystemConfiguration.h>
53 # define _CUPS_LOCATION_DEFAULTS 1
54 # endif /* !TARGET_OS_IOS */
55 # define kCUPSPrintingPrefs CFSTR("org.cups.PrintingPrefs")
56 # define kDefaultPaperIDKey CFSTR("DefaultPaperID")
57 # define kLastUsedPrintersKey CFSTR("LastUsedPrinters")
58 # define kLocationNetworkKey CFSTR("Network")
59 # define kLocationPrinterIDKey CFSTR("PrinterID")
60 # define kUseLastPrinter CFSTR("UseLastPrinter")
61 #endif /* __APPLE__ */
63 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
64 # define _CUPS_DNSSD_MAXTIME 500 /* Milliseconds for maximum quantum of time */
65 #endif /* HAVE_DNSSD || HAVE_AVAHI */
72 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
73 typedef enum _cups_dnssd_state_e
/* Enumerated device state */
80 _CUPS_DNSSD_INCOMPATIBLE
,
82 } _cups_dnssd_state_t
;
84 typedef struct _cups_dnssd_data_s
/* Enumeration data */
87 DNSServiceRef main_ref
; /* Main service reference */
88 # else /* HAVE_AVAHI */
89 AvahiSimplePoll
*simple_poll
; /* Polling interface */
90 AvahiClient
*client
; /* Client information */
91 int got_data
; /* Did we get data? */
92 int browsers
; /* How many browsers are running? */
93 # endif /* HAVE_DNSSD */
94 cups_dest_cb_t cb
; /* Callback */
95 void *user_data
; /* User data pointer */
96 cups_ptype_t type
, /* Printer type filter */
97 mask
; /* Printer type mask */
98 cups_array_t
*devices
; /* Devices found so far */
101 typedef struct _cups_dnssd_device_s
/* Enumerated device */
103 _cups_dnssd_state_t state
; /* State of device listing */
105 DNSServiceRef ref
; /* Service reference for query */
106 # else /* HAVE_AVAHI */
107 AvahiRecordBrowser
*ref
; /* Browser for query */
108 # endif /* HAVE_DNSSD */
109 char *fullName
, /* Full name */
110 *regtype
, /* Registration type */
111 *domain
; /* Domain name */
112 cups_ptype_t type
; /* Device registration type */
113 cups_dest_t dest
; /* Destination record */
114 } _cups_dnssd_device_t
;
116 typedef struct _cups_dnssd_resolve_s
/* Data for resolving URI */
118 int *cancel
; /* Pointer to "cancel" variable */
119 struct timeval end_time
; /* Ending time */
120 } _cups_dnssd_resolve_t
;
121 #endif /* HAVE_DNSSD */
123 typedef struct _cups_getdata_s
125 int num_dests
; /* Number of destinations */
126 cups_dest_t
*dests
; /* Destinations */
129 typedef struct _cups_namedata_s
131 const char *name
; /* Named destination */
132 cups_dest_t
*dest
; /* Destination */
140 #if _CUPS_LOCATION_DEFAULTS
141 static CFArrayRef
appleCopyLocations(void);
142 static CFStringRef
appleCopyNetwork(void);
143 #endif /* _CUPS_LOCATION_DEFAULTS */
145 static char *appleGetPaperSize(char *name
, size_t namesize
);
146 #endif /* __APPLE__ */
147 #if _CUPS_LOCATION_DEFAULTS
148 static CFStringRef
appleGetPrinter(CFArrayRef locations
,
149 CFStringRef network
, CFIndex
*locindex
);
150 #endif /* _CUPS_LOCATION_DEFAULTS */
151 static cups_dest_t
*cups_add_dest(const char *name
, const char *instance
,
152 int *num_dests
, cups_dest_t
**dests
);
154 static int cups_block_cb(cups_dest_block_t block
, unsigned flags
,
156 #endif /* __BLOCKS__ */
157 static int cups_compare_dests(cups_dest_t
*a
, cups_dest_t
*b
);
158 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
160 static void cups_dnssd_browse_cb(DNSServiceRef sdRef
,
161 DNSServiceFlags flags
,
162 uint32_t interfaceIndex
,
163 DNSServiceErrorType errorCode
,
164 const char *serviceName
,
166 const char *replyDomain
,
168 # else /* HAVE_AVAHI */
169 static void cups_dnssd_browse_cb(AvahiServiceBrowser
*browser
,
170 AvahiIfIndex interface
,
171 AvahiProtocol protocol
,
172 AvahiBrowserEvent event
,
173 const char *serviceName
,
175 const char *replyDomain
,
176 AvahiLookupResultFlags flags
,
178 static void cups_dnssd_client_cb(AvahiClient
*client
,
179 AvahiClientState state
,
181 # endif /* HAVE_DNSSD */
182 static int cups_dnssd_compare_devices(_cups_dnssd_device_t
*a
,
183 _cups_dnssd_device_t
*b
);
184 static void cups_dnssd_free_device(_cups_dnssd_device_t
*device
,
185 _cups_dnssd_data_t
*data
);
186 static _cups_dnssd_device_t
*
187 cups_dnssd_get_device(_cups_dnssd_data_t
*data
,
188 const char *serviceName
,
190 const char *replyDomain
);
192 static void cups_dnssd_local_cb(DNSServiceRef sdRef
,
193 DNSServiceFlags flags
,
194 uint32_t interfaceIndex
,
195 DNSServiceErrorType errorCode
,
196 const char *serviceName
,
198 const char *replyDomain
,
200 static void cups_dnssd_query_cb(DNSServiceRef sdRef
,
201 DNSServiceFlags flags
,
202 uint32_t interfaceIndex
,
203 DNSServiceErrorType errorCode
,
204 const char *fullName
,
205 uint16_t rrtype
, uint16_t rrclass
,
206 uint16_t rdlen
, const void *rdata
,
207 uint32_t ttl
, void *context
);
208 # else /* HAVE_AVAHI */
209 static int cups_dnssd_poll_cb(struct pollfd
*pollfds
,
210 unsigned int num_pollfds
,
211 int timeout
, void *context
);
212 static void cups_dnssd_query_cb(AvahiRecordBrowser
*browser
,
213 AvahiIfIndex interface
,
214 AvahiProtocol protocol
,
215 AvahiBrowserEvent event
,
216 const char *name
, uint16_t rrclass
,
217 uint16_t rrtype
, const void *rdata
,
219 AvahiLookupResultFlags flags
,
221 # endif /* HAVE_DNSSD */
222 static const char *cups_dnssd_resolve(cups_dest_t
*dest
, const char *uri
,
223 int msec
, int *cancel
,
224 cups_dest_cb_t cb
, void *user_data
);
225 static int cups_dnssd_resolve_cb(void *context
);
226 static void cups_dnssd_unquote(char *dst
, const char *src
,
228 static int cups_elapsed(struct timeval
*t
);
229 #endif /* HAVE_DNSSD || HAVE_AVAHI */
230 static int cups_find_dest(const char *name
, const char *instance
,
231 int num_dests
, cups_dest_t
*dests
, int prev
,
233 static int cups_get_cb(_cups_getdata_t
*data
, unsigned flags
, cups_dest_t
*dest
);
234 static char *cups_get_default(const char *filename
, char *namebuf
,
235 size_t namesize
, const char **instance
);
236 static int cups_get_dests(const char *filename
, const char *match_name
,
237 const char *match_inst
, int user_default_set
,
238 int num_dests
, cups_dest_t
**dests
);
239 static char *cups_make_string(ipp_attribute_t
*attr
, char *buffer
,
241 static int cups_name_cb(_cups_namedata_t
*data
, unsigned flags
, cups_dest_t
*dest
);
242 static void cups_queue_name(char *name
, const char *serviceName
, size_t namesize
);
246 * 'cupsAddDest()' - Add a destination to the list of destinations.
248 * This function cannot be used to add a new class or printer queue,
249 * it only adds a new container of saved options for the named
250 * destination or instance.
252 * If the named destination already exists, the destination list is
253 * returned unchanged. Adding a new instance of a destination creates
254 * a copy of that destination's options.
256 * Use the @link cupsSaveDests@ function to save the updated list of
257 * destinations to the user's lpoptions file.
260 int /* O - New number of destinations */
261 cupsAddDest(const char *name
, /* I - Destination name */
262 const char *instance
, /* I - Instance name or @code NULL@ for none/primary */
263 int num_dests
, /* I - Number of destinations */
264 cups_dest_t
**dests
) /* IO - Destinations */
266 int i
; /* Looping var */
267 cups_dest_t
*dest
; /* Destination pointer */
268 cups_dest_t
*parent
= NULL
; /* Parent destination */
269 cups_option_t
*doption
, /* Current destination option */
270 *poption
; /* Current parent option */
276 if (!cupsGetDest(name
, instance
, num_dests
, *dests
))
278 if (instance
&& !cupsGetDest(name
, NULL
, num_dests
, *dests
))
281 if ((dest
= cups_add_dest(name
, instance
, &num_dests
, dests
)) == NULL
)
285 * Find the base dest again now the array has been realloc'd.
288 parent
= cupsGetDest(name
, NULL
, num_dests
, *dests
);
290 if (instance
&& parent
&& parent
->num_options
> 0)
293 * Copy options from parent...
296 dest
->options
= calloc(sizeof(cups_option_t
), (size_t)parent
->num_options
);
300 dest
->num_options
= parent
->num_options
;
302 for (i
= dest
->num_options
, doption
= dest
->options
,
303 poption
= parent
->options
;
305 i
--, doption
++, poption
++)
307 doption
->name
= _cupsStrRetain(poption
->name
);
308 doption
->value
= _cupsStrRetain(poption
->value
);
320 * '_cupsAppleCopyDefaultPaperID()' - Get the default paper ID.
323 CFStringRef
/* O - Default paper ID */
324 _cupsAppleCopyDefaultPaperID(void)
326 return (CFPreferencesCopyAppValue(kDefaultPaperIDKey
,
327 kCUPSPrintingPrefs
));
332 * '_cupsAppleCopyDefaultPrinter()' - Get the default printer at this location.
335 CFStringRef
/* O - Default printer name */
336 _cupsAppleCopyDefaultPrinter(void)
338 # if _CUPS_LOCATION_DEFAULTS
339 CFStringRef network
; /* Network location */
340 CFArrayRef locations
; /* Location array */
341 CFStringRef locprinter
; /* Current printer */
345 * Use location-based defaults only if "use last printer" is selected in the
346 * system preferences...
349 if (!_cupsAppleGetUseLastPrinter())
351 DEBUG_puts("1_cupsAppleCopyDefaultPrinter: Not using last printer as "
357 * Get the current location...
360 if ((network
= appleCopyNetwork()) == NULL
)
362 DEBUG_puts("1_cupsAppleCopyDefaultPrinter: Unable to get current "
368 * Lookup the network in the preferences...
371 if ((locations
= appleCopyLocations()) == NULL
)
374 * Missing or bad location array, so no location-based default...
377 DEBUG_puts("1_cupsAppleCopyDefaultPrinter: Missing or bad last used "
385 DEBUG_printf(("1_cupsAppleCopyDefaultPrinter: Got locations, %d entries.",
386 (int)CFArrayGetCount(locations
)));
388 if ((locprinter
= appleGetPrinter(locations
, network
, NULL
)) != NULL
)
389 CFRetain(locprinter
);
392 CFRelease(locations
);
398 # endif /* _CUPS_LOCATION_DEFAULTS */
403 * '_cupsAppleGetUseLastPrinter()' - Get whether to use the last used printer.
406 int /* O - 1 to use last printer, 0 otherwise */
407 _cupsAppleGetUseLastPrinter(void)
409 Boolean uselast
, /* Use last printer preference value */
410 uselast_set
; /* Valid is set? */
413 if (getenv("CUPS_DISABLE_APPLE_DEFAULT"))
416 uselast
= CFPreferencesGetAppBooleanValue(kUseLastPrinter
,
427 * '_cupsAppleSetDefaultPaperID()' - Set the default paper id.
431 _cupsAppleSetDefaultPaperID(
432 CFStringRef name
) /* I - New paper ID */
434 CFPreferencesSetAppValue(kDefaultPaperIDKey
, name
, kCUPSPrintingPrefs
);
435 CFPreferencesAppSynchronize(kCUPSPrintingPrefs
);
437 # ifdef HAVE_NOTIFY_POST
438 notify_post("com.apple.printerPrefsChange");
439 # endif /* HAVE_NOTIFY_POST */
444 * '_cupsAppleSetDefaultPrinter()' - Set the default printer for this location.
448 _cupsAppleSetDefaultPrinter(
449 CFStringRef name
) /* I - Default printer/class name */
451 # if _CUPS_LOCATION_DEFAULTS
452 CFStringRef network
; /* Current network */
453 CFArrayRef locations
; /* Old locations array */
454 CFIndex locindex
; /* Index in locations array */
455 CFStringRef locprinter
; /* Current printer */
456 CFMutableArrayRef newlocations
; /* New locations array */
457 CFMutableDictionaryRef newlocation
; /* New location */
461 * Get the current location...
464 if ((network
= appleCopyNetwork()) == NULL
)
466 DEBUG_puts("1_cupsAppleSetDefaultPrinter: Unable to get current network...");
471 * Lookup the network in the preferences...
474 if ((locations
= appleCopyLocations()) != NULL
)
475 locprinter
= appleGetPrinter(locations
, network
, &locindex
);
482 if (!locprinter
|| CFStringCompare(locprinter
, name
, 0) != kCFCompareEqualTo
)
485 * Need to change the locations array...
490 newlocations
= CFArrayCreateMutableCopy(kCFAllocatorDefault
, 0,
494 CFArrayRemoveValueAtIndex(newlocations
, locindex
);
497 newlocations
= CFArrayCreateMutable(kCFAllocatorDefault
, 0,
498 &kCFTypeArrayCallBacks
);
500 newlocation
= CFDictionaryCreateMutable(kCFAllocatorDefault
, 0,
501 &kCFTypeDictionaryKeyCallBacks
,
502 &kCFTypeDictionaryValueCallBacks
);
504 if (newlocation
&& newlocations
)
507 * Put the new location at the front of the array...
510 CFDictionaryAddValue(newlocation
, kLocationNetworkKey
, network
);
511 CFDictionaryAddValue(newlocation
, kLocationPrinterIDKey
, name
);
512 CFArrayInsertValueAtIndex(newlocations
, 0, newlocation
);
515 * Limit the number of locations to 10...
518 while (CFArrayGetCount(newlocations
) > 10)
519 CFArrayRemoveValueAtIndex(newlocations
, 10);
522 * Push the changes out...
525 CFPreferencesSetAppValue(kLastUsedPrintersKey
, newlocations
,
527 CFPreferencesAppSynchronize(kCUPSPrintingPrefs
);
529 # ifdef HAVE_NOTIFY_POST
530 notify_post("com.apple.printerPrefsChange");
531 # endif /* HAVE_NOTIFY_POST */
535 CFRelease(newlocations
);
538 CFRelease(newlocation
);
542 CFRelease(locations
);
548 # endif /* _CUPS_LOCATION_DEFAULTS */
553 * '_cupsAppleSetUseLastPrinter()' - Set whether to use the last used printer.
557 _cupsAppleSetUseLastPrinter(
558 int uselast
) /* O - 1 to use last printer, 0 otherwise */
560 CFPreferencesSetAppValue(kUseLastPrinter
,
561 uselast
? kCFBooleanTrue
: kCFBooleanFalse
,
563 CFPreferencesAppSynchronize(kCUPSPrintingPrefs
);
565 # ifdef HAVE_NOTIFY_POST
566 notify_post("com.apple.printerPrefsChange");
567 # endif /* HAVE_NOTIFY_POST */
569 #endif /* __APPLE__ */
573 * 'cupsConnectDest()' - Open a conection to the destination.
575 * Connect to the destination, returning a new @code http_t@ connection object
576 * and optionally the resource path to use for the destination. These calls
577 * will block until a connection is made, the timeout expires, the integer
578 * pointed to by "cancel" is non-zero, or the callback function (or block)
579 * returns 0. The caller is responsible for calling @link httpClose@ on the
580 * returned connection.
582 * @since CUPS 1.6/macOS 10.8@
585 http_t
* /* O - Connection to destination or @code NULL@ */
587 cups_dest_t
*dest
, /* I - Destination */
588 unsigned flags
, /* I - Connection flags */
589 int msec
, /* I - Timeout in milliseconds */
590 int *cancel
, /* I - Pointer to "cancel" variable */
591 char *resource
, /* I - Resource buffer */
592 size_t resourcesize
, /* I - Size of resource buffer */
593 cups_dest_cb_t cb
, /* I - Callback function */
594 void *user_data
) /* I - User data pointer */
596 const char *uri
; /* Printer URI */
597 char scheme
[32], /* URI scheme */
598 userpass
[256], /* Username and password (unused) */
599 hostname
[256], /* Hostname */
600 tempresource
[1024]; /* Temporary resource buffer */
601 int port
; /* Port number */
602 char portstr
[16]; /* Port number string */
603 http_encryption_t encryption
; /* Encryption to use */
604 http_addrlist_t
*addrlist
; /* Address list for server */
605 http_t
*http
; /* Connection to server */
608 DEBUG_printf(("cupsConnectDest(dest=%p, flags=0x%x, msec=%d, cancel=%p(%d), resource=\"%s\", resourcesize=" CUPS_LLFMT
", cb=%p, user_data=%p)", (void *)dest
, flags
, msec
, (void *)cancel
, cancel
? *cancel
: -1, resource
, CUPS_LLCAST resourcesize
, (void *)cb
, user_data
));
611 * Range check input...
619 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, strerror(EINVAL
), 0);
623 if (!resource
|| resourcesize
< 1)
625 resource
= tempresource
;
626 resourcesize
= sizeof(tempresource
);
630 * Grab the printer URI...
633 if ((uri
= cupsGetOption("printer-uri-supported", dest
->num_options
, dest
->options
)) == NULL
)
635 if ((uri
= cupsGetOption("resolved-device-uri", dest
->num_options
, dest
->options
)) == NULL
)
637 if ((uri
= cupsGetOption("device-uri", dest
->num_options
, dest
->options
)) != NULL
)
639 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
640 if (strstr(uri
, "._tcp"))
641 uri
= cups_dnssd_resolve(dest
, uri
, msec
, cancel
, cb
, user_data
);
642 #endif /* HAVE_DNSSD || HAVE_AVAHI */
647 uri
= _cupsCreateDest(dest
->name
, cupsGetOption("printer-info", dest
->num_options
, dest
->options
), NULL
, uri
, tempresource
, sizeof(tempresource
));
651 dest
->num_options
= cupsAddOption("printer-uri-supported", uri
, dest
->num_options
, &dest
->options
);
653 uri
= cupsGetOption("printer-uri-supported", dest
->num_options
, dest
->options
);
659 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, strerror(ENOENT
), 0);
662 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_ERROR
, dest
);
667 if (httpSeparateURI(HTTP_URI_CODING_ALL
, uri
, scheme
, sizeof(scheme
),
668 userpass
, sizeof(userpass
), hostname
, sizeof(hostname
),
669 &port
, resource
, (int)resourcesize
) < HTTP_URI_STATUS_OK
)
671 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("Bad printer-uri."), 1);
674 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_ERROR
,
681 * Lookup the address for the server...
685 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_RESOLVING
, dest
);
687 snprintf(portstr
, sizeof(portstr
), "%d", port
);
689 if ((addrlist
= httpAddrGetList(hostname
, AF_UNSPEC
, portstr
)) == NULL
)
692 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_ERROR
, dest
);
697 if (cancel
&& *cancel
)
699 httpAddrFreeList(addrlist
);
702 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_CANCELED
, dest
);
708 * Create the HTTP object pointing to the server referenced by the URI...
711 if (!strcmp(scheme
, "ipps") || port
== 443)
712 encryption
= HTTP_ENCRYPTION_ALWAYS
;
714 encryption
= HTTP_ENCRYPTION_IF_REQUESTED
;
716 http
= httpConnect2(hostname
, port
, addrlist
, AF_UNSPEC
, encryption
, 1, 0, NULL
);
717 httpAddrFreeList(addrlist
);
720 * Connect if requested...
723 if (flags
& CUPS_DEST_FLAGS_UNCONNECTED
)
726 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
, dest
);
731 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_CONNECTING
, dest
);
733 if (!httpReconnect2(http
, msec
, cancel
) && cb
)
735 if (cancel
&& *cancel
)
736 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_CONNECTING
, dest
);
738 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_ERROR
, dest
);
741 (*cb
)(user_data
, CUPS_DEST_FLAGS_NONE
, dest
);
750 * 'cupsConnectDestBlock()' - Open a connection to the destination.
752 * Connect to the destination, returning a new @code http_t@ connection object
753 * and optionally the resource path to use for the destination. These calls
754 * will block until a connection is made, the timeout expires, the integer
755 * pointed to by "cancel" is non-zero, or the block returns 0. The caller is
756 * responsible for calling @link httpClose@ on the returned connection.
758 * @since CUPS 1.6/macOS 10.8@ @exclude all@
761 http_t
* /* O - Connection to destination or @code NULL@ */
762 cupsConnectDestBlock(
763 cups_dest_t
*dest
, /* I - Destination */
764 unsigned flags
, /* I - Connection flags */
765 int msec
, /* I - Timeout in milliseconds */
766 int *cancel
, /* I - Pointer to "cancel" variable */
767 char *resource
, /* I - Resource buffer */
768 size_t resourcesize
, /* I - Size of resource buffer */
769 cups_dest_block_t block
) /* I - Callback block */
771 return (cupsConnectDest(dest
, flags
, msec
, cancel
, resource
, resourcesize
,
772 (cups_dest_cb_t
)cups_block_cb
, (void *)block
));
774 #endif /* __BLOCKS__ */
778 * 'cupsCopyDest()' - Copy a destination.
780 * Make a copy of the destination to an array of destinations (or just a single
781 * copy) - for use with the cupsEnumDests* functions. The caller is responsible
782 * for calling cupsFreeDests() on the returned object(s).
784 * @since CUPS 1.6/macOS 10.8@
787 int /* O - New number of destinations */
788 cupsCopyDest(cups_dest_t
*dest
, /* I - Destination to copy */
789 int num_dests
, /* I - Number of destinations */
790 cups_dest_t
**dests
) /* IO - Destination array */
792 int i
; /* Looping var */
793 cups_dest_t
*new_dest
; /* New destination pointer */
794 cups_option_t
*new_option
, /* Current destination option */
795 *option
; /* Current parent option */
799 * Range check input...
802 if (!dest
|| num_dests
< 0 || !dests
)
806 * See if the destination already exists...
809 if ((new_dest
= cupsGetDest(dest
->name
, dest
->instance
, num_dests
,
813 * Protect against copying destination to itself...
816 if (new_dest
== dest
)
820 * Otherwise, free the options...
823 cupsFreeOptions(new_dest
->num_options
, new_dest
->options
);
825 new_dest
->num_options
= 0;
826 new_dest
->options
= NULL
;
829 new_dest
= cups_add_dest(dest
->name
, dest
->instance
, &num_dests
, dests
);
833 if ((new_dest
->options
= calloc(sizeof(cups_option_t
), (size_t)dest
->num_options
)) == NULL
)
834 return (cupsRemoveDest(dest
->name
, dest
->instance
, num_dests
, dests
));
836 new_dest
->num_options
= dest
->num_options
;
838 for (i
= dest
->num_options
, option
= dest
->options
,
839 new_option
= new_dest
->options
;
841 i
--, option
++, new_option
++)
843 new_option
->name
= _cupsStrRetain(option
->name
);
844 new_option
->value
= _cupsStrRetain(option
->value
);
853 * '_cupsCreateDest()' - Create a local (temporary) queue.
856 char * /* O - Printer URI or @code NULL@ on error */
857 _cupsCreateDest(const char *name
, /* I - Printer name */
858 const char *info
, /* I - Printer description of @code NULL@ */
859 const char *device_id
, /* I - 1284 Device ID or @code NULL@ */
860 const char *device_uri
, /* I - Device URI */
861 char *uri
, /* I - Printer URI buffer */
862 size_t urisize
) /* I - Size of URI buffer */
864 http_t
*http
; /* Connection to server */
865 ipp_t
*request
, /* CUPS-Create-Local-Printer request */
866 *response
; /* CUPS-Create-Local-Printer response */
867 ipp_attribute_t
*attr
; /* printer-uri-supported attribute */
868 ipp_pstate_t state
= IPP_PSTATE_STOPPED
;
869 /* printer-state value */
872 if (!name
|| !device_uri
|| !uri
|| urisize
< 32)
875 if ((http
= httpConnect2(cupsServer(), ippPort(), NULL
, AF_UNSPEC
, HTTP_ENCRYPTION_IF_REQUESTED
, 1, 30000, NULL
)) == NULL
)
878 request
= ippNewRequest(IPP_OP_CUPS_CREATE_LOCAL_PRINTER
);
880 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri", NULL
, "ipp://localhost/");
881 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
, "requesting-user-name", NULL
, cupsUser());
883 ippAddString(request
, IPP_TAG_PRINTER
, IPP_TAG_URI
, "device-uri", NULL
, device_uri
);
884 ippAddString(request
, IPP_TAG_PRINTER
, IPP_TAG_NAME
, "printer-name", NULL
, name
);
886 ippAddString(request
, IPP_TAG_PRINTER
, IPP_TAG_TEXT
, "printer-info", NULL
, info
);
888 ippAddString(request
, IPP_TAG_PRINTER
, IPP_TAG_TEXT
, "printer-device-id", NULL
, device_id
);
890 response
= cupsDoRequest(http
, request
, "/");
892 if ((attr
= ippFindAttribute(response
, "printer-uri-supported", IPP_TAG_URI
)) != NULL
)
893 strlcpy(uri
, ippGetString(attr
, 0, NULL
), urisize
);
901 if ((attr
= ippFindAttribute(response
, "printer-state", IPP_TAG_ENUM
)) != NULL
)
902 state
= (ipp_pstate_t
)ippGetInteger(attr
, 0);
904 while (state
== IPP_PSTATE_STOPPED
&& cupsLastError() == IPP_STATUS_OK
)
909 request
= ippNewRequest(IPP_OP_GET_PRINTER_ATTRIBUTES
);
911 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri", NULL
, uri
);
912 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
, "requesting-user-name", NULL
, cupsUser());
913 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
, "requested-attributes", NULL
, "printer-state");
915 response
= cupsDoRequest(http
, request
, "/");
917 if ((attr
= ippFindAttribute(response
, "printer-state", IPP_TAG_ENUM
)) != NULL
)
918 state
= (ipp_pstate_t
)ippGetInteger(attr
, 0);
930 * 'cupsEnumDests()' - Enumerate available destinations with a callback function.
932 * Destinations are enumerated from one or more sources. The callback function
933 * receives the @code user_data@ pointer and the destination pointer which can
934 * be used as input to the @link cupsCopyDest@ function. The function must
935 * return 1 to continue enumeration or 0 to stop.
937 * The @code type@ and @code mask@ arguments allow the caller to filter the
938 * destinations that are enumerated. Passing 0 for both will enumerate all
939 * printers. The constant @code CUPS_PRINTER_DISCOVERED@ is used to filter on
940 * destinations that are available but have not yet been added locally.
942 * Enumeration happens on the current thread and does not return until all
943 * destinations have been enumerated or the callback function returns 0.
945 * Note: The callback function will likely receive multiple updates for the same
946 * destinations - it is up to the caller to suppress any duplicate destinations.
948 * @since CUPS 1.6/macOS 10.8@
951 int /* O - 1 on success, 0 on failure */
953 unsigned flags
, /* I - Enumeration flags */
954 int msec
, /* I - Timeout in milliseconds, -1 for indefinite */
955 int *cancel
, /* I - Pointer to "cancel" variable */
956 cups_ptype_t type
, /* I - Printer type bits */
957 cups_ptype_t mask
, /* I - Mask for printer type bits */
958 cups_dest_cb_t cb
, /* I - Callback function */
959 void *user_data
) /* I - User data */
961 int i
, /* Looping var */
962 num_dests
; /* Number of destinations */
963 cups_dest_t
*dests
= NULL
, /* Destinations */
964 *dest
; /* Current destination */
965 const char *defprinter
; /* Default printer */
966 char name
[1024], /* Copy of printer name */
967 *instance
, /* Pointer to instance name */
968 *user_default
; /* User default printer */
969 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
970 int count
, /* Number of queries started */
971 completed
, /* Number of completed queries */
972 remaining
; /* Remainder of timeout */
973 struct timeval curtime
; /* Current time */
974 _cups_dnssd_data_t data
; /* Data for callback */
975 _cups_dnssd_device_t
*device
; /* Current device */
977 int nfds
, /* Number of files responded */
978 main_fd
; /* File descriptor for lookups */
979 DNSServiceRef ipp_ref
, /* IPP browser */
980 local_ipp_ref
; /* Local IPP browser */
982 DNSServiceRef ipps_ref
, /* IPPS browser */
983 local_ipps_ref
; /* Local IPPS browser */
984 # endif /* HAVE_SSL */
986 struct pollfd pfd
; /* Polling data */
988 fd_set input
; /* Input set for select() */
989 struct timeval timeout
; /* Timeout for select() */
990 # endif /* HAVE_POLL */
991 # else /* HAVE_AVAHI */
992 int error
; /* Error value */
993 AvahiServiceBrowser
*ipp_ref
; /* IPP browser */
995 AvahiServiceBrowser
*ipps_ref
; /* IPPS browser */
996 # endif /* HAVE_SSL */
997 # endif /* HAVE_DNSSD */
998 #endif /* HAVE_DNSSD || HAVE_AVAHI */
1001 * Range check input...
1010 * Get ready to enumerate...
1013 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
1017 data
.user_data
= user_data
;
1018 data
.devices
= cupsArrayNew3((cups_array_func_t
)cups_dnssd_compare_devices
, NULL
, NULL
, 0, NULL
, (cups_afree_func_t
)cups_dnssd_free_device
);
1019 #endif /* HAVE_DNSSD || HAVE_AVAHI */
1021 if (!(mask
& CUPS_PRINTER_DISCOVERED
) || !(type
& CUPS_PRINTER_DISCOVERED
))
1024 * Get the list of local printers and pass them to the callback function...
1027 num_dests
= _cupsGetDests(CUPS_HTTP_DEFAULT
, IPP_OP_CUPS_GET_PRINTERS
, NULL
,
1028 &dests
, type
, mask
);
1030 if ((user_default
= _cupsUserDefault(name
, sizeof(name
))) != NULL
)
1032 else if ((defprinter
= cupsGetDefault2(CUPS_HTTP_DEFAULT
)) != NULL
)
1034 strlcpy(name
, defprinter
, sizeof(name
));
1041 * Separate printer and instance name...
1044 if ((instance
= strchr(name
, '/')) != NULL
)
1048 * Lookup the printer and instance and make it the default...
1051 if ((dest
= cupsGetDest(name
, instance
, num_dests
, dests
)) != NULL
)
1052 dest
->is_default
= 1;
1055 for (i
= num_dests
, dest
= dests
;
1056 i
> 0 && (!cancel
|| !*cancel
);
1059 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
1060 const char *device_uri
; /* Device URI */
1061 #endif /* HAVE_DNSSD || HAVE_AVAHI */
1063 if (!(*cb
)(user_data
, i
> 1 ? CUPS_DEST_FLAGS_MORE
: CUPS_DEST_FLAGS_NONE
,
1067 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
1068 if (!dest
->instance
&& (device_uri
= cupsGetOption("device-uri", dest
->num_options
, dest
->options
)) != NULL
&& !strncmp(device_uri
, "dnssd://", 8))
1071 * Add existing queue using service name, etc. so we don't list it again...
1074 char scheme
[32], /* URI scheme */
1075 userpass
[32], /* Username:password */
1076 serviceName
[256], /* Service name (host field) */
1077 resource
[256], /* Resource (options) */
1078 *regtype
, /* Registration type */
1079 *replyDomain
; /* Registration domain */
1080 int port
; /* Port number (not used) */
1082 if (httpSeparateURI(HTTP_URI_CODING_ALL
, device_uri
, scheme
, sizeof(scheme
), userpass
, sizeof(userpass
), serviceName
, sizeof(serviceName
), &port
, resource
, sizeof(resource
)) >= HTTP_URI_STATUS_OK
)
1084 if ((regtype
= strstr(serviceName
, "._ipp")) != NULL
)
1088 if ((replyDomain
= strstr(regtype
, "._tcp.")) != NULL
)
1090 replyDomain
[5] = '\0';
1093 if ((device
= cups_dnssd_get_device(&data
, serviceName
, regtype
, replyDomain
)) != NULL
)
1094 device
->state
= _CUPS_DNSSD_ACTIVE
;
1099 #endif /* HAVE_DNSSD || HAVE_AVAHI */
1102 cupsFreeDests(num_dests
, dests
);
1104 if (i
> 0 || msec
== 0)
1109 * Return early if the caller doesn't want to do discovery...
1112 if ((mask
& CUPS_PRINTER_DISCOVERED
) && !(type
& CUPS_PRINTER_DISCOVERED
))
1115 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
1117 * Get Bonjour-shared printers...
1120 gettimeofday(&curtime
, NULL
);
1123 if (DNSServiceCreateConnection(&data
.main_ref
) != kDNSServiceErr_NoError
)
1126 main_fd
= DNSServiceRefSockFD(data
.main_ref
);
1128 ipp_ref
= data
.main_ref
;
1129 DNSServiceBrowse(&ipp_ref
, kDNSServiceFlagsShareConnection
, 0,
1131 (DNSServiceBrowseReply
)cups_dnssd_browse_cb
, &data
);
1133 local_ipp_ref
= data
.main_ref
;
1134 DNSServiceBrowse(&local_ipp_ref
, kDNSServiceFlagsShareConnection
,
1135 kDNSServiceInterfaceIndexLocalOnly
,
1137 (DNSServiceBrowseReply
)cups_dnssd_local_cb
, &data
);
1140 ipps_ref
= data
.main_ref
;
1141 DNSServiceBrowse(&ipps_ref
, kDNSServiceFlagsShareConnection
, 0,
1143 (DNSServiceBrowseReply
)cups_dnssd_browse_cb
, &data
);
1145 local_ipps_ref
= data
.main_ref
;
1146 DNSServiceBrowse(&local_ipps_ref
, kDNSServiceFlagsShareConnection
,
1147 kDNSServiceInterfaceIndexLocalOnly
,
1149 (DNSServiceBrowseReply
)cups_dnssd_local_cb
, &data
);
1150 # endif /* HAVE_SSL */
1152 # else /* HAVE_AVAHI */
1153 if ((data
.simple_poll
= avahi_simple_poll_new()) == NULL
)
1155 DEBUG_puts("cupsEnumDests: Unable to create Avahi simple poll object.");
1159 avahi_simple_poll_set_func(data
.simple_poll
, cups_dnssd_poll_cb
, &data
);
1161 data
.client
= avahi_client_new(avahi_simple_poll_get(data
.simple_poll
),
1162 0, cups_dnssd_client_cb
, &data
,
1166 DEBUG_puts("cupsEnumDests: Unable to create Avahi client.");
1167 avahi_simple_poll_free(data
.simple_poll
);
1172 ipp_ref
= avahi_service_browser_new(data
.client
, AVAHI_IF_UNSPEC
, AVAHI_PROTO_UNSPEC
, "_ipp._tcp", NULL
, 0, cups_dnssd_browse_cb
, &data
);
1176 ipps_ref
= avahi_service_browser_new(data
.client
, AVAHI_IF_UNSPEC
, AVAHI_PROTO_UNSPEC
, "_ipps._tcp", NULL
, 0, cups_dnssd_browse_cb
, &data
);
1177 # endif /* HAVE_SSL */
1178 # endif /* HAVE_DNSSD */
1181 remaining
= INT_MAX
;
1185 while (remaining
> 0 && (!cancel
|| !*cancel
))
1188 * Check for input...
1191 DEBUG_printf(("1cupsEnumDests: remaining=%d", remaining
));
1193 cups_elapsed(&curtime
);
1198 pfd
.events
= POLLIN
;
1200 nfds
= poll(&pfd
, 1, remaining
> _CUPS_DNSSD_MAXTIME
? _CUPS_DNSSD_MAXTIME
: remaining
);
1204 FD_SET(main_fd
, &input
);
1207 timeout
.tv_usec
= 1000 * (remaining
> _CUPS_DNSSD_MAXTIME
? _CUPS_DNSSD_MAXTIME
: remaining
);
1209 nfds
= select(main_fd
+ 1, &input
, NULL
, NULL
, &timeout
);
1210 # endif /* HAVE_POLL */
1213 DNSServiceProcessResult(data
.main_ref
);
1215 # else /* HAVE_AVAHI */
1218 if ((error
= avahi_simple_poll_iterate(data
.simple_poll
, _CUPS_DNSSD_MAXTIME
)) > 0)
1221 * We've been told to exit the loop. Perhaps the connection to
1228 DEBUG_printf(("1cupsEnumDests: got_data=%d", data
.got_data
));
1229 # endif /* HAVE_DNSSD */
1231 remaining
-= cups_elapsed(&curtime
);
1233 for (device
= (_cups_dnssd_device_t
*)cupsArrayFirst(data
.devices
),
1234 count
= 0, completed
= 0;
1236 device
= (_cups_dnssd_device_t
*)cupsArrayNext(data
.devices
))
1241 if (device
->state
== _CUPS_DNSSD_ACTIVE
)
1244 if (!device
->ref
&& device
->state
== _CUPS_DNSSD_NEW
)
1246 DEBUG_printf(("1cupsEnumDests: Querying '%s'.", device
->fullName
));
1249 device
->ref
= data
.main_ref
;
1251 if (DNSServiceQueryRecord(&(device
->ref
),
1252 kDNSServiceFlagsShareConnection
,
1253 0, device
->fullName
,
1254 kDNSServiceType_TXT
,
1255 kDNSServiceClass_IN
,
1256 (DNSServiceQueryRecordReply
)cups_dnssd_query_cb
,
1257 &data
) == kDNSServiceErr_NoError
)
1264 device
->state
= _CUPS_DNSSD_ERROR
;
1266 DEBUG_puts("1cupsEnumDests: Query failed.");
1269 # else /* HAVE_AVAHI */
1270 if ((device
->ref
= avahi_record_browser_new(data
.client
, AVAHI_IF_UNSPEC
, AVAHI_PROTO_UNSPEC
, device
->fullName
, AVAHI_DNS_CLASS_IN
, AVAHI_DNS_TYPE_TXT
, 0, cups_dnssd_query_cb
, &data
)) != NULL
)
1272 DEBUG_printf(("1cupsEnumDests: Query ref=%p", device
->ref
));
1277 device
->state
= _CUPS_DNSSD_ERROR
;
1279 DEBUG_printf(("1cupsEnumDests: Query failed: %s", avahi_strerror(avahi_client_errno(data
.client
))));
1281 # endif /* HAVE_DNSSD */
1283 else if (device
->ref
&& device
->state
== _CUPS_DNSSD_PENDING
)
1287 DEBUG_printf(("1cupsEnumDests: Query for \"%s\" is complete.", device
->fullName
));
1289 if ((device
->type
& mask
) == type
)
1291 DEBUG_printf(("1cupsEnumDests: Add callback for \"%s\".", device
->dest
.name
));
1292 if (!(*cb
)(user_data
, CUPS_DEST_FLAGS_NONE
, &device
->dest
))
1299 device
->state
= _CUPS_DNSSD_ACTIVE
;
1304 DEBUG_printf(("1cupsEnumDests: remaining=%d, browsers=%d, completed=%d, count=%d, devices count=%d", remaining
, data
.browsers
, completed
, count
, cupsArrayCount(data
.devices
)));
1306 if (data
.browsers
== 0 && completed
== cupsArrayCount(data
.devices
))
1309 DEBUG_printf(("1cupsEnumDests: remaining=%d, completed=%d, count=%d, devices count=%d", remaining
, completed
, count
, cupsArrayCount(data
.devices
)));
1311 if (completed
== cupsArrayCount(data
.devices
))
1313 # endif /* HAVE_AVAHI */
1317 DNSServiceRefDeallocate(ipp_ref
);
1318 DNSServiceRefDeallocate(local_ipp_ref
);
1321 DNSServiceRefDeallocate(ipp_ref
);
1322 DNSServiceRefDeallocate(local_ipp_ref
);
1323 # endif /* HAVE_SSL */
1325 DNSServiceRefDeallocate(data
.main_ref
);
1327 # else /* HAVE_AVAHI */
1328 avahi_service_browser_free(ipp_ref
);
1330 avahi_service_browser_free(ipps_ref
);
1331 # endif /* HAVE_SSL */
1333 avahi_client_free(data
.client
);
1334 avahi_simple_poll_free(data
.simple_poll
);
1335 # endif /* HAVE_DNSSD */
1336 #endif /* HAVE_DNSSD || HAVE_DNSSD */
1344 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
1345 cupsArrayDelete(data
.devices
);
1346 #endif /* HAVE_DNSSD || HAVE_AVAHI */
1354 * 'cupsEnumDestsBlock()' - Enumerate available destinations with a block.
1356 * Destinations are enumerated from one or more sources. The block receives the
1357 * @code user_data@ pointer and the destination pointer which can be used as
1358 * input to the @link cupsCopyDest@ function. The block must return 1 to
1359 * continue enumeration or 0 to stop.
1361 * The @code type@ and @code mask@ arguments allow the caller to filter the
1362 * destinations that are enumerated. Passing 0 for both will enumerate all
1363 * printers. The constant @code CUPS_PRINTER_DISCOVERED@ is used to filter on
1364 * destinations that are available but have not yet been added locally.
1366 * Enumeration happens on the current thread and does not return until all
1367 * destinations have been enumerated or the block returns 0.
1369 * Note: The block will likely receive multiple updates for the same
1370 * destinations - it is up to the caller to suppress any duplicate destinations.
1372 * @since CUPS 1.6/macOS 10.8@ @exclude all@
1375 int /* O - 1 on success, 0 on failure */
1377 unsigned flags
, /* I - Enumeration flags */
1378 int timeout
, /* I - Timeout in milliseconds, 0 for indefinite */
1379 int *cancel
, /* I - Pointer to "cancel" variable */
1380 cups_ptype_t type
, /* I - Printer type bits */
1381 cups_ptype_t mask
, /* I - Mask for printer type bits */
1382 cups_dest_block_t block
) /* I - Block */
1384 return (cupsEnumDests(flags
, timeout
, cancel
, type
, mask
,
1385 (cups_dest_cb_t
)cups_block_cb
, (void *)block
));
1387 # endif /* __BLOCKS__ */
1391 * 'cupsFreeDests()' - Free the memory used by the list of destinations.
1395 cupsFreeDests(int num_dests
, /* I - Number of destinations */
1396 cups_dest_t
*dests
) /* I - Destinations */
1398 int i
; /* Looping var */
1399 cups_dest_t
*dest
; /* Current destination */
1402 if (num_dests
== 0 || dests
== NULL
)
1405 for (i
= num_dests
, dest
= dests
; i
> 0; i
--, dest
++)
1407 _cupsStrFree(dest
->name
);
1408 _cupsStrFree(dest
->instance
);
1410 cupsFreeOptions(dest
->num_options
, dest
->options
);
1418 * 'cupsGetDest()' - Get the named destination from the list.
1420 * Use the @link cupsEnumDests@ or @link cupsGetDests2@ functions to get a
1421 * list of supported destinations for the current user.
1424 cups_dest_t
* /* O - Destination pointer or @code NULL@ */
1425 cupsGetDest(const char *name
, /* I - Destination name or @code NULL@ for the default destination */
1426 const char *instance
, /* I - Instance name or @code NULL@ */
1427 int num_dests
, /* I - Number of destinations */
1428 cups_dest_t
*dests
) /* I - Destinations */
1430 int diff
, /* Result of comparison */
1431 match
; /* Matching index */
1434 if (num_dests
<= 0 || !dests
)
1440 * NULL name for default printer.
1443 while (num_dests
> 0)
1445 if (dests
->is_default
)
1455 * Lookup name and optionally the instance...
1458 match
= cups_find_dest(name
, instance
, num_dests
, dests
, -1, &diff
);
1461 return (dests
+ match
);
1469 * '_cupsGetDestResource()' - Get the resource path and URI for a destination.
1472 const char * /* O - Printer URI */
1473 _cupsGetDestResource(
1474 cups_dest_t
*dest
, /* I - Destination */
1475 char *resource
, /* I - Resource buffer */
1476 size_t resourcesize
) /* I - Size of resource buffer */
1478 const char *uri
; /* Printer URI */
1479 char scheme
[32], /* URI scheme */
1480 userpass
[256], /* Username and password (unused) */
1481 hostname
[256]; /* Hostname */
1482 int port
; /* Port number */
1485 DEBUG_printf(("_cupsGetDestResource(dest=%p(%s), resource=%p, resourcesize=%d)", (void *)dest
, dest
->name
, (void *)resource
, (int)resourcesize
));
1488 * Range check input...
1491 if (!dest
|| !resource
|| resourcesize
< 1)
1496 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, strerror(EINVAL
), 0);
1501 * Grab the printer URI...
1504 if ((uri
= cupsGetOption("printer-uri-supported", dest
->num_options
, dest
->options
)) == NULL
)
1506 if ((uri
= cupsGetOption("resolved-device-uri", dest
->num_options
, dest
->options
)) == NULL
)
1508 if ((uri
= cupsGetOption("device-uri", dest
->num_options
, dest
->options
)) != NULL
)
1510 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
1511 if (strstr(uri
, "._tcp"))
1512 uri
= cups_dnssd_resolve(dest
, uri
, 5000, NULL
, NULL
, NULL
);
1513 #endif /* HAVE_DNSSD || HAVE_AVAHI */
1519 DEBUG_printf(("1_cupsGetDestResource: Resolved printer-uri-supported=\"%s\"", uri
));
1521 uri
= _cupsCreateDest(dest
->name
, cupsGetOption("printer-info", dest
->num_options
, dest
->options
), NULL
, uri
, resource
, resourcesize
);
1526 DEBUG_printf(("1_cupsGetDestResource: Local printer-uri-supported=\"%s\"", uri
));
1528 dest
->num_options
= cupsAddOption("printer-uri-supported", uri
, dest
->num_options
, &dest
->options
);
1530 uri
= cupsGetOption("printer-uri-supported", dest
->num_options
, dest
->options
);
1534 DEBUG_puts("1_cupsGetDestResource: No printer-uri-supported found.");
1539 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, strerror(ENOENT
), 0);
1546 DEBUG_printf(("1_cupsGetDestResource: printer-uri-supported=\"%s\"", uri
));
1548 if (httpSeparateURI(HTTP_URI_CODING_ALL
, uri
, scheme
, sizeof(scheme
),
1549 userpass
, sizeof(userpass
), hostname
, sizeof(hostname
),
1550 &port
, resource
, (int)resourcesize
) < HTTP_URI_STATUS_OK
)
1552 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("Bad printer-uri."), 1);
1558 DEBUG_printf(("1_cupsGetDestResource: resource=\"%s\"", resource
));
1565 * 'cupsGetDestWithURI()' - Get a destination associated with a URI.
1567 * "name" is the desired name for the printer. If @code NULL@, a name will be
1568 * created using the URI.
1570 * "uri" is the "ipp" or "ipps" URI for the printer.
1572 * @since CUPS 2.0/macOS 10.10@
1575 cups_dest_t
* /* O - Destination or @code NULL@ */
1576 cupsGetDestWithURI(const char *name
, /* I - Desired printer name or @code NULL@ */
1577 const char *uri
) /* I - URI for the printer */
1579 cups_dest_t
*dest
; /* New destination */
1580 char temp
[1024], /* Temporary string */
1581 scheme
[256], /* Scheme from URI */
1582 userpass
[256], /* Username:password from URI */
1583 hostname
[256], /* Hostname from URI */
1584 resource
[1024], /* Resource path from URI */
1585 *ptr
; /* Pointer into string */
1586 const char *info
; /* printer-info string */
1587 int port
; /* Port number from URI */
1591 * Range check input...
1596 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, strerror(EINVAL
), 0);
1600 if (httpSeparateURI(HTTP_URI_CODING_ALL
, uri
, scheme
, sizeof(scheme
), userpass
, sizeof(userpass
), hostname
, sizeof(hostname
), &port
, resource
, sizeof(resource
)) < HTTP_URI_STATUS_OK
||
1601 (strncmp(uri
, "ipp://", 6) && strncmp(uri
, "ipps://", 7)))
1603 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("Bad printer-uri."), 1);
1615 * Create the name from the URI...
1618 if (strstr(hostname
, "._tcp"))
1621 * Use the service instance name...
1624 if ((ptr
= strstr(hostname
, "._")) != NULL
)
1627 cups_queue_name(temp
, hostname
, sizeof(temp
));
1631 else if (!strncmp(resource
, "/classes/", 9))
1633 snprintf(temp
, sizeof(temp
), "%s @ %s", resource
+ 9, hostname
);
1634 name
= resource
+ 9;
1637 else if (!strncmp(resource
, "/printers/", 10))
1639 snprintf(temp
, sizeof(temp
), "%s @ %s", resource
+ 10, hostname
);
1640 name
= resource
+ 10;
1651 * Create the destination...
1654 if ((dest
= calloc(1, sizeof(cups_dest_t
))) == NULL
)
1656 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, strerror(errno
), 0);
1660 dest
->name
= _cupsStrAlloc(name
);
1661 dest
->num_options
= cupsAddOption("device-uri", uri
, dest
->num_options
, &(dest
->options
));
1662 dest
->num_options
= cupsAddOption("printer-info", info
, dest
->num_options
, &(dest
->options
));
1669 * '_cupsGetDests()' - Get destinations from a server.
1671 * "op" is IPP_OP_CUPS_GET_PRINTERS to get a full list, IPP_OP_CUPS_GET_DEFAULT
1672 * to get the system-wide default printer, or IPP_OP_GET_PRINTER_ATTRIBUTES for
1675 * "name" is the name of an existing printer and is only used when "op" is
1676 * IPP_OP_GET_PRINTER_ATTRIBUTES.
1678 * "dest" is initialized to point to the array of destinations.
1680 * 0 is returned if there are no printers, no default printer, or the named
1681 * printer does not exist, respectively.
1683 * Free the memory used by the destination array using the @link cupsFreeDests@
1686 * Note: On macOS this function also gets the default paper from the system
1687 * preferences (~/L/P/org.cups.PrintingPrefs.plist) and includes it in the
1688 * options array for each destination that supports it.
1691 int /* O - Number of destinations */
1692 _cupsGetDests(http_t
*http
, /* I - Connection to server or
1693 * @code CUPS_HTTP_DEFAULT@ */
1694 ipp_op_t op
, /* I - IPP operation */
1695 const char *name
, /* I - Name of destination */
1696 cups_dest_t
**dests
, /* IO - Destinations */
1697 cups_ptype_t type
, /* I - Printer type bits */
1698 cups_ptype_t mask
) /* I - Printer type mask */
1700 int num_dests
= 0; /* Number of destinations */
1701 cups_dest_t
*dest
; /* Current destination */
1702 ipp_t
*request
, /* IPP Request */
1703 *response
; /* IPP Response */
1704 ipp_attribute_t
*attr
; /* Current attribute */
1705 const char *printer_name
; /* printer-name attribute */
1706 char uri
[1024]; /* printer-uri value */
1707 int num_options
; /* Number of options */
1708 cups_option_t
*options
; /* Options */
1710 char media_default
[41]; /* Default paper size */
1711 #endif /* __APPLE__ */
1712 char optname
[1024], /* Option name */
1713 value
[2048], /* Option value */
1714 *ptr
; /* Pointer into name/value */
1715 static const char * const pattrs
[] = /* Attributes we're interested in */
1717 "auth-info-required",
1719 "job-sheets-default",
1720 "marker-change-time",
1722 "marker-high-levels",
1724 "marker-low-levels",
1730 #endif /* __APPLE__ */
1734 "printer-is-accepting-jobs",
1735 "printer-is-shared",
1737 "printer-make-and-model",
1738 "printer-mandatory-job-attributes",
1741 "printer-state-change-time",
1742 "printer-state-reasons",
1744 "printer-uri-supported"
1748 DEBUG_printf(("_cupsGetDests(http=%p, op=%x(%s), name=\"%s\", dests=%p, type=%x, mask=%x)", (void *)http
, op
, ippOpString(op
), name
, (void *)dests
, type
, mask
));
1752 * Get the default paper size...
1755 appleGetPaperSize(media_default
, sizeof(media_default
));
1756 #endif /* __APPLE__ */
1759 * Build a IPP_OP_CUPS_GET_PRINTERS or IPP_OP_GET_PRINTER_ATTRIBUTES request, which
1760 * require the following attributes:
1762 * attributes-charset
1763 * attributes-natural-language
1764 * requesting-user-name
1765 * printer-uri [for IPP_OP_GET_PRINTER_ATTRIBUTES]
1768 request
= ippNewRequest(op
);
1770 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
1771 "requested-attributes", sizeof(pattrs
) / sizeof(pattrs
[0]),
1774 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
1775 "requesting-user-name", NULL
, cupsUser());
1777 if (name
&& op
!= IPP_OP_CUPS_GET_DEFAULT
)
1779 httpAssembleURIf(HTTP_URI_CODING_ALL
, uri
, sizeof(uri
), "ipp", NULL
,
1780 "localhost", ippPort(), "/printers/%s", name
);
1781 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri", NULL
,
1786 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_ENUM
, "printer-type", (int)type
);
1787 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_ENUM
, "printer-type-mask", (int)mask
);
1791 * Do the request and get back a response...
1794 if ((response
= cupsDoRequest(http
, request
, "/")) != NULL
)
1796 for (attr
= response
->attrs
; attr
!= NULL
; attr
= attr
->next
)
1799 * Skip leading attributes until we hit a printer...
1802 while (attr
!= NULL
&& attr
->group_tag
!= IPP_TAG_PRINTER
)
1809 * Pull the needed attributes from this printer...
1812 printer_name
= NULL
;
1816 for (; attr
&& attr
->group_tag
== IPP_TAG_PRINTER
; attr
= attr
->next
)
1818 if (attr
->value_tag
!= IPP_TAG_INTEGER
&&
1819 attr
->value_tag
!= IPP_TAG_ENUM
&&
1820 attr
->value_tag
!= IPP_TAG_BOOLEAN
&&
1821 attr
->value_tag
!= IPP_TAG_TEXT
&&
1822 attr
->value_tag
!= IPP_TAG_TEXTLANG
&&
1823 attr
->value_tag
!= IPP_TAG_NAME
&&
1824 attr
->value_tag
!= IPP_TAG_NAMELANG
&&
1825 attr
->value_tag
!= IPP_TAG_KEYWORD
&&
1826 attr
->value_tag
!= IPP_TAG_RANGE
&&
1827 attr
->value_tag
!= IPP_TAG_URI
)
1830 if (!strcmp(attr
->name
, "auth-info-required") ||
1831 !strcmp(attr
->name
, "device-uri") ||
1832 !strcmp(attr
->name
, "marker-change-time") ||
1833 !strcmp(attr
->name
, "marker-colors") ||
1834 !strcmp(attr
->name
, "marker-high-levels") ||
1835 !strcmp(attr
->name
, "marker-levels") ||
1836 !strcmp(attr
->name
, "marker-low-levels") ||
1837 !strcmp(attr
->name
, "marker-message") ||
1838 !strcmp(attr
->name
, "marker-names") ||
1839 !strcmp(attr
->name
, "marker-types") ||
1840 !strcmp(attr
->name
, "printer-commands") ||
1841 !strcmp(attr
->name
, "printer-info") ||
1842 !strcmp(attr
->name
, "printer-is-shared") ||
1843 !strcmp(attr
->name
, "printer-make-and-model") ||
1844 !strcmp(attr
->name
, "printer-mandatory-job-attributes") ||
1845 !strcmp(attr
->name
, "printer-state") ||
1846 !strcmp(attr
->name
, "printer-state-change-time") ||
1847 !strcmp(attr
->name
, "printer-type") ||
1848 !strcmp(attr
->name
, "printer-is-accepting-jobs") ||
1849 !strcmp(attr
->name
, "printer-location") ||
1850 !strcmp(attr
->name
, "printer-state-reasons") ||
1851 !strcmp(attr
->name
, "printer-uri-supported"))
1854 * Add a printer description attribute...
1857 num_options
= cupsAddOption(attr
->name
,
1858 cups_make_string(attr
, value
,
1860 num_options
, &options
);
1863 else if (!strcmp(attr
->name
, "media-supported"))
1866 * See if we can set a default media size...
1869 int i
; /* Looping var */
1871 for (i
= 0; i
< attr
->num_values
; i
++)
1872 if (!_cups_strcasecmp(media_default
, attr
->values
[i
].string
.text
))
1874 num_options
= cupsAddOption("media", media_default
, num_options
,
1879 #endif /* __APPLE__ */
1880 else if (!strcmp(attr
->name
, "printer-name") &&
1881 attr
->value_tag
== IPP_TAG_NAME
)
1882 printer_name
= attr
->values
[0].string
.text
;
1883 else if (strncmp(attr
->name
, "notify-", 7) &&
1884 (attr
->value_tag
== IPP_TAG_BOOLEAN
||
1885 attr
->value_tag
== IPP_TAG_ENUM
||
1886 attr
->value_tag
== IPP_TAG_INTEGER
||
1887 attr
->value_tag
== IPP_TAG_KEYWORD
||
1888 attr
->value_tag
== IPP_TAG_NAME
||
1889 attr
->value_tag
== IPP_TAG_RANGE
) &&
1890 (ptr
= strstr(attr
->name
, "-default")) != NULL
)
1893 * Add a default option...
1896 strlcpy(optname
, attr
->name
, sizeof(optname
));
1897 optname
[ptr
- attr
->name
] = '\0';
1899 if (_cups_strcasecmp(optname
, "media") ||
1900 !cupsGetOption("media", num_options
, options
))
1901 num_options
= cupsAddOption(optname
,
1902 cups_make_string(attr
, value
,
1904 num_options
, &options
);
1909 * See if we have everything needed...
1914 cupsFreeOptions(num_options
, options
);
1922 if ((dest
= cups_add_dest(printer_name
, NULL
, &num_dests
, dests
)) != NULL
)
1924 dest
->num_options
= num_options
;
1925 dest
->options
= options
;
1928 cupsFreeOptions(num_options
, options
);
1934 ippDelete(response
);
1938 * Return the count...
1946 * 'cupsGetDests()' - Get the list of destinations from the default server.
1948 * Starting with CUPS 1.2, the returned list of destinations include the
1949 * "printer-info", "printer-is-accepting-jobs", "printer-is-shared",
1950 * "printer-make-and-model", "printer-state", "printer-state-change-time",
1951 * "printer-state-reasons", "printer-type", and "printer-uri-supported"
1952 * attributes as options.
1954 * CUPS 1.4 adds the "marker-change-time", "marker-colors",
1955 * "marker-high-levels", "marker-levels", "marker-low-levels", "marker-message",
1956 * "marker-names", "marker-types", and "printer-commands" attributes as options.
1958 * CUPS 2.2 adds accessible IPP printers to the list of destinations that can
1959 * be used. The "printer-uri-supported" option will be present for those IPP
1960 * printers that have been recently used.
1962 * Use the @link cupsFreeDests@ function to free the destination list and
1963 * the @link cupsGetDest@ function to find a particular destination.
1968 int /* O - Number of destinations */
1969 cupsGetDests(cups_dest_t
**dests
) /* O - Destinations */
1971 return (cupsGetDests2(CUPS_HTTP_DEFAULT
, dests
));
1976 * 'cupsGetDests2()' - Get the list of destinations from the specified server.
1978 * Starting with CUPS 1.2, the returned list of destinations include the
1979 * "printer-info", "printer-is-accepting-jobs", "printer-is-shared",
1980 * "printer-make-and-model", "printer-state", "printer-state-change-time",
1981 * "printer-state-reasons", "printer-type", and "printer-uri-supported"
1982 * attributes as options.
1984 * CUPS 1.4 adds the "marker-change-time", "marker-colors",
1985 * "marker-high-levels", "marker-levels", "marker-low-levels", "marker-message",
1986 * "marker-names", "marker-types", and "printer-commands" attributes as options.
1988 * CUPS 2.2 adds accessible IPP printers to the list of destinations that can
1989 * be used. The "printer-uri-supported" option will be present for those IPP
1990 * printers that have been recently used.
1992 * Use the @link cupsFreeDests@ function to free the destination list and
1993 * the @link cupsGetDest@ function to find a particular destination.
1995 * @since CUPS 1.1.21/macOS 10.4@
1998 int /* O - Number of destinations */
1999 cupsGetDests2(http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
2000 cups_dest_t
**dests
) /* O - Destinations */
2002 _cups_getdata_t data
; /* Enumeration data */
2003 cups_dest_t
*dest
; /* Current destination */
2004 const char *home
; /* HOME environment variable */
2005 char filename
[1024]; /* Local ~/.cups/lpoptions file */
2006 const char *defprinter
; /* Default printer */
2007 char name
[1024], /* Copy of printer name */
2008 *instance
, /* Pointer to instance name */
2009 *user_default
; /* User default printer */
2010 int num_reals
; /* Number of real queues */
2011 cups_dest_t
*reals
; /* Real queues */
2012 _cups_globals_t
*cg
= _cupsGlobals(); /* Pointer to library globals */
2016 * Range check the input...
2021 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("Bad NULL dests pointer"), 1);
2026 * Grab the printers and classes...
2032 cupsEnumDests(0, 1000, NULL
, 0, 0, (cups_dest_cb_t
)cups_get_cb
, &data
);
2034 if (cupsLastError() >= IPP_STATUS_REDIRECTION_OTHER_SITE
)
2036 cupsFreeDests(data
.num_dests
, data
.dests
);
2038 *dests
= (cups_dest_t
*)0;
2044 * Make a copy of the "real" queues for a later sanity check...
2047 if (data
.num_dests
> 0)
2049 num_reals
= data
.num_dests
;
2050 reals
= calloc((size_t)num_reals
, sizeof(cups_dest_t
));
2053 memcpy(reals
, data
.dests
, (size_t)num_reals
* sizeof(cups_dest_t
));
2064 * Grab the default destination...
2067 if ((user_default
= _cupsUserDefault(name
, sizeof(name
))) != NULL
)
2069 else if ((defprinter
= cupsGetDefault2(http
)) != NULL
)
2071 strlcpy(name
, defprinter
, sizeof(name
));
2078 * Separate printer and instance name...
2081 if ((instance
= strchr(name
, '/')) != NULL
)
2085 * Lookup the printer and instance and make it the default...
2088 if ((dest
= cupsGetDest(name
, instance
, data
.num_dests
, data
.dests
)) != NULL
)
2089 dest
->is_default
= 1;
2095 * Load the /etc/cups/lpoptions and ~/.cups/lpoptions files...
2098 snprintf(filename
, sizeof(filename
), "%s/lpoptions", cg
->cups_serverroot
);
2099 data
.num_dests
= cups_get_dests(filename
, NULL
, NULL
, user_default
!= NULL
, data
.num_dests
, &data
.dests
);
2101 if ((home
= getenv("HOME")) != NULL
)
2103 snprintf(filename
, sizeof(filename
), "%s/.cups/lpoptions", home
);
2105 data
.num_dests
= cups_get_dests(filename
, NULL
, NULL
, user_default
!= NULL
, data
.num_dests
, &data
.dests
);
2109 * Validate the current default destination - this prevents old
2110 * Default lines in /etc/cups/lpoptions and ~/.cups/lpoptions from
2111 * pointing to a non-existent printer or class...
2117 * See if we have a default printer...
2120 if ((dest
= cupsGetDest(NULL
, NULL
, data
.num_dests
, data
.dests
)) != NULL
)
2123 * Have a default; see if it is real...
2126 if (!cupsGetDest(dest
->name
, NULL
, num_reals
, reals
))
2129 * Remove the non-real printer from the list, since we don't want jobs
2130 * going to an unexpected printer... (<rdar://problem/14216472>)
2133 data
.num_dests
= cupsRemoveDest(dest
->name
, dest
->instance
, data
.num_dests
, &data
.dests
);
2145 * Return the number of destinations...
2148 *dests
= data
.dests
;
2150 if (data
.num_dests
> 0)
2151 _cupsSetError(IPP_STATUS_OK
, NULL
, 0);
2153 return (data
.num_dests
);
2158 * 'cupsGetNamedDest()' - Get options for the named destination.
2160 * This function is optimized for retrieving a single destination and should
2161 * be used instead of @link cupsGetDests2@ and @link cupsGetDest@ when you
2162 * either know the name of the destination or want to print to the default
2163 * destination. If @code NULL@ is returned, the destination does not exist or
2164 * there is no default destination.
2166 * If "http" is @code CUPS_HTTP_DEFAULT@, the connection to the default print
2167 * server will be used.
2169 * If "name" is @code NULL@, the default printer for the current user will be
2172 * The returned destination must be freed using @link cupsFreeDests@ with a
2173 * "num_dests" value of 1.
2175 * @since CUPS 1.4/macOS 10.6@
2178 cups_dest_t
* /* O - Destination or @code NULL@ */
2179 cupsGetNamedDest(http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
2180 const char *name
, /* I - Destination name or @code NULL@ for the default destination */
2181 const char *instance
) /* I - Instance name or @code NULL@ */
2183 cups_dest_t
*dest
; /* Destination */
2184 char filename
[1024], /* Path to lpoptions */
2185 defname
[256]; /* Default printer name */
2186 const char *home
= getenv("HOME"); /* Home directory */
2187 int set_as_default
= 0; /* Set returned destination as default */
2188 ipp_op_t op
= IPP_OP_GET_PRINTER_ATTRIBUTES
;
2189 /* IPP operation to get server ops */
2190 _cups_globals_t
*cg
= _cupsGlobals(); /* Pointer to library globals */
2193 DEBUG_printf(("cupsGetNamedDest(http=%p, name=\"%s\", instance=\"%s\")", (void *)http
, name
, instance
));
2196 * If "name" is NULL, find the default destination...
2202 name
= _cupsUserDefault(defname
, sizeof(defname
));
2206 char *ptr
; /* Temporary pointer... */
2208 if ((ptr
= strchr(defname
, '/')) != NULL
)
2219 * No default in the environment, try the user's lpoptions files...
2222 snprintf(filename
, sizeof(filename
), "%s/.cups/lpoptions", home
);
2224 name
= cups_get_default(filename
, defname
, sizeof(defname
), &instance
);
2230 * Still not there? Try the system lpoptions file...
2233 snprintf(filename
, sizeof(filename
), "%s/lpoptions",
2234 cg
->cups_serverroot
);
2235 name
= cups_get_default(filename
, defname
, sizeof(defname
), &instance
);
2241 * No locally-set default destination, ask the server...
2244 op
= IPP_OP_CUPS_GET_DEFAULT
;
2246 DEBUG_puts("1cupsGetNamedDest: Asking server for default printer...");
2249 DEBUG_printf(("1cupsGetNamedDest: Using name=\"%s\"...", name
));
2253 * Get the printer's attributes...
2256 if (!_cupsGetDests(http
, op
, name
, &dest
, 0, 0))
2260 _cups_namedata_t data
; /* Callback data */
2262 DEBUG_puts("1cupsGetNamedDest: No queue found for printer, looking on network...");
2267 cupsEnumDests(0, 1000, NULL
, 0, 0, (cups_dest_cb_t
)cups_name_cb
, &data
);
2278 DEBUG_printf(("1cupsGetNamedDest: Got dest=%p", (void *)dest
));
2281 dest
->instance
= _cupsStrAlloc(instance
);
2284 dest
->is_default
= 1;
2287 * Then add local options...
2290 snprintf(filename
, sizeof(filename
), "%s/lpoptions", cg
->cups_serverroot
);
2291 cups_get_dests(filename
, name
, instance
, 1, 1, &dest
);
2295 snprintf(filename
, sizeof(filename
), "%s/.cups/lpoptions", home
);
2297 cups_get_dests(filename
, name
, instance
, 1, 1, &dest
);
2301 * Return the result...
2309 * 'cupsRemoveDest()' - Remove a destination from the destination list.
2311 * Removing a destination/instance does not delete the class or printer
2312 * queue, merely the lpoptions for that destination/instance. Use the
2313 * @link cupsSetDests@ or @link cupsSetDests2@ functions to save the new
2314 * options for the user.
2316 * @since CUPS 1.3/macOS 10.5@
2319 int /* O - New number of destinations */
2320 cupsRemoveDest(const char *name
, /* I - Destination name */
2321 const char *instance
, /* I - Instance name or @code NULL@ */
2322 int num_dests
, /* I - Number of destinations */
2323 cups_dest_t
**dests
) /* IO - Destinations */
2325 int i
; /* Index into destinations */
2326 cups_dest_t
*dest
; /* Pointer to destination */
2330 * Find the destination...
2333 if ((dest
= cupsGetDest(name
, instance
, num_dests
, *dests
)) == NULL
)
2340 _cupsStrFree(dest
->name
);
2341 _cupsStrFree(dest
->instance
);
2342 cupsFreeOptions(dest
->num_options
, dest
->options
);
2345 * Remove the destination from the array...
2350 i
= (int)(dest
- *dests
);
2353 memmove(dest
, dest
+ 1, (size_t)(num_dests
- i
) * sizeof(cups_dest_t
));
2360 * 'cupsSetDefaultDest()' - Set the default destination.
2362 * @since CUPS 1.3/macOS 10.5@
2367 const char *name
, /* I - Destination name */
2368 const char *instance
, /* I - Instance name or @code NULL@ */
2369 int num_dests
, /* I - Number of destinations */
2370 cups_dest_t
*dests
) /* I - Destinations */
2372 int i
; /* Looping var */
2373 cups_dest_t
*dest
; /* Current destination */
2377 * Range check input...
2380 if (!name
|| num_dests
<= 0 || !dests
)
2384 * Loop through the array and set the "is_default" flag for the matching
2388 for (i
= num_dests
, dest
= dests
; i
> 0; i
--, dest
++)
2389 dest
->is_default
= !_cups_strcasecmp(name
, dest
->name
) &&
2390 ((!instance
&& !dest
->instance
) ||
2391 (instance
&& dest
->instance
&&
2392 !_cups_strcasecmp(instance
, dest
->instance
)));
2397 * 'cupsSetDests()' - Save the list of destinations for the default server.
2399 * This function saves the destinations to /etc/cups/lpoptions when run
2400 * as root and ~/.cups/lpoptions when run as a normal user.
2406 cupsSetDests(int num_dests
, /* I - Number of destinations */
2407 cups_dest_t
*dests
) /* I - Destinations */
2409 cupsSetDests2(CUPS_HTTP_DEFAULT
, num_dests
, dests
);
2414 * 'cupsSetDests2()' - Save the list of destinations for the specified server.
2416 * This function saves the destinations to /etc/cups/lpoptions when run
2417 * as root and ~/.cups/lpoptions when run as a normal user.
2419 * @since CUPS 1.1.21/macOS 10.4@
2422 int /* O - 0 on success, -1 on error */
2423 cupsSetDests2(http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
2424 int num_dests
, /* I - Number of destinations */
2425 cups_dest_t
*dests
) /* I - Destinations */
2427 int i
, j
; /* Looping vars */
2428 int wrote
; /* Wrote definition? */
2429 cups_dest_t
*dest
; /* Current destination */
2430 cups_option_t
*option
; /* Current option */
2431 _ipp_option_t
*match
; /* Matching attribute for option */
2432 FILE *fp
; /* File pointer */
2434 const char *home
; /* HOME environment variable */
2436 char filename
[1024]; /* lpoptions file */
2437 int num_temps
; /* Number of temporary destinations */
2438 cups_dest_t
*temps
= NULL
, /* Temporary destinations */
2439 *temp
; /* Current temporary dest */
2440 const char *val
; /* Value of temporary option */
2441 _cups_globals_t
*cg
= _cupsGlobals(); /* Pointer to library globals */
2445 * Range check the input...
2448 if (!num_dests
|| !dests
)
2452 * Get the server destinations...
2455 num_temps
= _cupsGetDests(http
, IPP_OP_CUPS_GET_PRINTERS
, NULL
, &temps
, 0, 0);
2457 if (cupsLastError() >= IPP_STATUS_REDIRECTION_OTHER_SITE
)
2459 cupsFreeDests(num_temps
, temps
);
2464 * Figure out which file to write to...
2467 snprintf(filename
, sizeof(filename
), "%s/lpoptions", cg
->cups_serverroot
);
2473 * Merge in server defaults...
2476 num_temps
= cups_get_dests(filename
, NULL
, NULL
, 0, num_temps
, &temps
);
2479 * Point to user defaults...
2482 if ((home
= getenv("HOME")) != NULL
)
2485 * Create ~/.cups subdirectory...
2488 snprintf(filename
, sizeof(filename
), "%s/.cups", home
);
2489 if (access(filename
, 0))
2490 mkdir(filename
, 0700);
2492 snprintf(filename
, sizeof(filename
), "%s/.cups/lpoptions", home
);
2498 * Try to open the file...
2501 if ((fp
= fopen(filename
, "w")) == NULL
)
2503 cupsFreeDests(num_temps
, temps
);
2509 * Set the permissions to 0644 when saving to the /etc/cups/lpoptions
2514 fchmod(fileno(fp
), 0644);
2518 * Write each printer; each line looks like:
2520 * Dest name[/instance] options
2521 * Default name[/instance] options
2524 for (i
= num_dests
, dest
= dests
; i
> 0; i
--, dest
++)
2525 if (dest
->instance
!= NULL
|| dest
->num_options
!= 0 || dest
->is_default
)
2527 if (dest
->is_default
)
2529 fprintf(fp
, "Default %s", dest
->name
);
2531 fprintf(fp
, "/%s", dest
->instance
);
2538 if ((temp
= cupsGetDest(dest
->name
, dest
->instance
, num_temps
, temps
)) == NULL
)
2539 temp
= cupsGetDest(dest
->name
, NULL
, num_temps
, temps
);
2541 for (j
= dest
->num_options
, option
= dest
->options
; j
> 0; j
--, option
++)
2544 * See if this option is a printer attribute; if so, skip it...
2547 if ((match
= _ippFindOption(option
->name
)) != NULL
&&
2548 match
->group_tag
== IPP_TAG_PRINTER
)
2552 * See if the server/global options match these; if so, don't
2557 (val
= cupsGetOption(option
->name
, temp
->num_options
,
2558 temp
->options
)) != NULL
&&
2559 !_cups_strcasecmp(val
, option
->value
))
2563 * Options don't match, write to the file...
2568 fprintf(fp
, "Dest %s", dest
->name
);
2570 fprintf(fp
, "/%s", dest
->instance
);
2574 if (option
->value
[0])
2576 if (strchr(option
->value
, ' ') ||
2577 strchr(option
->value
, '\\') ||
2578 strchr(option
->value
, '\"') ||
2579 strchr(option
->value
, '\''))
2582 * Quote the value...
2585 fprintf(fp
, " %s=\"", option
->name
);
2587 for (val
= option
->value
; *val
; val
++)
2589 if (strchr("\"\'\\", *val
))
2600 * Store the literal value...
2603 fprintf(fp
, " %s=%s", option
->name
, option
->value
);
2607 fprintf(fp
, " %s", option
->name
);
2615 * Free the temporary destinations and close the file...
2618 cupsFreeDests(num_temps
, temps
);
2624 * Set the default printer for this location - this allows command-line
2625 * and GUI applications to share the same default destination...
2628 if ((dest
= cupsGetDest(NULL
, NULL
, num_dests
, dests
)) != NULL
)
2630 CFStringRef name
= CFStringCreateWithCString(kCFAllocatorDefault
,
2632 kCFStringEncodingUTF8
);
2633 /* Default printer name */
2637 _cupsAppleSetDefaultPrinter(name
);
2641 #endif /* __APPLE__ */
2643 #ifdef HAVE_NOTIFY_POST
2645 * Send a notification so that macOS applications can know about the
2649 notify_post("com.apple.printerListChange");
2650 #endif /* HAVE_NOTIFY_POST */
2657 * '_cupsUserDefault()' - Get the user default printer from environment
2658 * variables and location information.
2661 char * /* O - Default printer or NULL */
2662 _cupsUserDefault(char *name
, /* I - Name buffer */
2663 size_t namesize
) /* I - Size of name buffer */
2665 const char *env
; /* LPDEST or PRINTER env variable */
2667 CFStringRef locprinter
; /* Last printer as this location */
2668 #endif /* __APPLE__ */
2671 if ((env
= getenv("LPDEST")) == NULL
)
2672 if ((env
= getenv("PRINTER")) != NULL
&& !strcmp(env
, "lp"))
2677 strlcpy(name
, env
, namesize
);
2683 * Use location-based defaults if "use last printer" is selected in the
2684 * system preferences...
2687 if ((locprinter
= _cupsAppleCopyDefaultPrinter()) != NULL
)
2689 CFStringGetCString(locprinter
, name
, (CFIndex
)namesize
, kCFStringEncodingUTF8
);
2690 CFRelease(locprinter
);
2695 DEBUG_printf(("1_cupsUserDefault: Returning \"%s\".", name
));
2697 return (*name
? name
: NULL
);
2701 * No location-based defaults on this platform...
2706 #endif /* __APPLE__ */
2710 #if _CUPS_LOCATION_DEFAULTS
2712 * 'appleCopyLocations()' - Copy the location history array.
2715 static CFArrayRef
/* O - Location array or NULL */
2716 appleCopyLocations(void)
2718 CFArrayRef locations
; /* Location array */
2722 * Look up the location array in the preferences...
2725 if ((locations
= CFPreferencesCopyAppValue(kLastUsedPrintersKey
,
2726 kCUPSPrintingPrefs
)) == NULL
)
2729 if (CFGetTypeID(locations
) != CFArrayGetTypeID())
2731 CFRelease(locations
);
2740 * 'appleCopyNetwork()' - Get the network ID for the current location.
2743 static CFStringRef
/* O - Network ID */
2744 appleCopyNetwork(void)
2746 SCDynamicStoreRef dynamicStore
; /* System configuration data */
2747 CFStringRef key
; /* Current network configuration key */
2748 CFDictionaryRef ip_dict
; /* Network configuration data */
2749 CFStringRef network
= NULL
; /* Current network ID */
2752 if ((dynamicStore
= SCDynamicStoreCreate(NULL
, CFSTR("libcups"), NULL
,
2756 * First use the IPv6 router address, if available, since that will generally
2757 * be a globally-unique link-local address.
2760 if ((key
= SCDynamicStoreKeyCreateNetworkGlobalEntity(
2761 NULL
, kSCDynamicStoreDomainState
, kSCEntNetIPv6
)) != NULL
)
2763 if ((ip_dict
= SCDynamicStoreCopyValue(dynamicStore
, key
)) != NULL
)
2765 if ((network
= CFDictionaryGetValue(ip_dict
,
2766 kSCPropNetIPv6Router
)) != NULL
)
2776 * If that doesn't work, try the IPv4 router address. This isn't as unique
2777 * and will likely be a 10.x.y.z or 192.168.y.z address...
2782 if ((key
= SCDynamicStoreKeyCreateNetworkGlobalEntity(
2783 NULL
, kSCDynamicStoreDomainState
, kSCEntNetIPv4
)) != NULL
)
2785 if ((ip_dict
= SCDynamicStoreCopyValue(dynamicStore
, key
)) != NULL
)
2787 if ((network
= CFDictionaryGetValue(ip_dict
,
2788 kSCPropNetIPv4Router
)) != NULL
)
2798 CFRelease(dynamicStore
);
2803 #endif /* _CUPS_LOCATION_DEFAULTS */
2808 * 'appleGetPaperSize()' - Get the default paper size.
2811 static char * /* O - Default paper size */
2812 appleGetPaperSize(char *name
, /* I - Paper size name buffer */
2813 size_t namesize
) /* I - Size of buffer */
2815 CFStringRef defaultPaperID
; /* Default paper ID */
2816 pwg_media_t
*pwgmedia
; /* PWG media size */
2819 defaultPaperID
= _cupsAppleCopyDefaultPaperID();
2820 if (!defaultPaperID
||
2821 CFGetTypeID(defaultPaperID
) != CFStringGetTypeID() ||
2822 !CFStringGetCString(defaultPaperID
, name
, (CFIndex
)namesize
, kCFStringEncodingUTF8
))
2824 else if ((pwgmedia
= pwgMediaForLegacy(name
)) != NULL
)
2825 strlcpy(name
, pwgmedia
->pwg
, namesize
);
2828 CFRelease(defaultPaperID
);
2832 #endif /* __APPLE__ */
2835 #if _CUPS_LOCATION_DEFAULTS
2837 * 'appleGetPrinter()' - Get a printer from the history array.
2840 static CFStringRef
/* O - Printer name or NULL */
2841 appleGetPrinter(CFArrayRef locations
, /* I - Location array */
2842 CFStringRef network
, /* I - Network name */
2843 CFIndex
*locindex
) /* O - Index in array */
2845 CFIndex i
, /* Looping var */
2846 count
; /* Number of locations */
2847 CFDictionaryRef location
; /* Current location */
2848 CFStringRef locnetwork
, /* Current network */
2849 locprinter
; /* Current printer */
2852 for (i
= 0, count
= CFArrayGetCount(locations
); i
< count
; i
++)
2853 if ((location
= CFArrayGetValueAtIndex(locations
, i
)) != NULL
&&
2854 CFGetTypeID(location
) == CFDictionaryGetTypeID())
2856 if ((locnetwork
= CFDictionaryGetValue(location
,
2857 kLocationNetworkKey
)) != NULL
&&
2858 CFGetTypeID(locnetwork
) == CFStringGetTypeID() &&
2859 CFStringCompare(network
, locnetwork
, 0) == kCFCompareEqualTo
&&
2860 (locprinter
= CFDictionaryGetValue(location
,
2861 kLocationPrinterIDKey
)) != NULL
&&
2862 CFGetTypeID(locprinter
) == CFStringGetTypeID())
2867 return (locprinter
);
2873 #endif /* _CUPS_LOCATION_DEFAULTS */
2877 * 'cups_add_dest()' - Add a destination to the array.
2879 * Unlike cupsAddDest(), this function does not check for duplicates.
2882 static cups_dest_t
* /* O - New destination */
2883 cups_add_dest(const char *name
, /* I - Name of destination */
2884 const char *instance
, /* I - Instance or NULL */
2885 int *num_dests
, /* IO - Number of destinations */
2886 cups_dest_t
**dests
) /* IO - Destinations */
2888 int insert
, /* Insertion point */
2889 diff
; /* Result of comparison */
2890 cups_dest_t
*dest
; /* Destination pointer */
2894 * Add new destination...
2897 if (*num_dests
== 0)
2898 dest
= malloc(sizeof(cups_dest_t
));
2900 dest
= realloc(*dests
, sizeof(cups_dest_t
) * (size_t)(*num_dests
+ 1));
2908 * Find where to insert the destination...
2911 if (*num_dests
== 0)
2915 insert
= cups_find_dest(name
, instance
, *num_dests
, *dests
, *num_dests
- 1,
2923 * Move the array elements as needed...
2926 if (insert
< *num_dests
)
2927 memmove(*dests
+ insert
+ 1, *dests
+ insert
, (size_t)(*num_dests
- insert
) * sizeof(cups_dest_t
));
2932 * Initialize the destination...
2935 dest
= *dests
+ insert
;
2936 dest
->name
= _cupsStrAlloc(name
);
2937 dest
->instance
= _cupsStrAlloc(instance
);
2938 dest
->is_default
= 0;
2939 dest
->num_options
= 0;
2940 dest
->options
= (cups_option_t
*)0;
2948 * 'cups_block_cb()' - Enumeration callback for block API.
2951 static int /* O - 1 to continue, 0 to stop */
2953 cups_dest_block_t block
, /* I - Block */
2954 unsigned flags
, /* I - Destination flags */
2955 cups_dest_t
*dest
) /* I - Destination */
2957 return ((block
)(flags
, dest
));
2959 # endif /* __BLOCKS__ */
2963 * 'cups_compare_dests()' - Compare two destinations.
2966 static int /* O - Result of comparison */
2967 cups_compare_dests(cups_dest_t
*a
, /* I - First destination */
2968 cups_dest_t
*b
) /* I - Second destination */
2970 int diff
; /* Difference */
2973 if ((diff
= _cups_strcasecmp(a
->name
, b
->name
)) != 0)
2975 else if (a
->instance
&& b
->instance
)
2976 return (_cups_strcasecmp(a
->instance
, b
->instance
));
2978 return ((a
->instance
&& !b
->instance
) - (!a
->instance
&& b
->instance
));
2982 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
2985 * 'cups_dnssd_browse_cb()' - Browse for printers.
2989 cups_dnssd_browse_cb(
2990 DNSServiceRef sdRef
, /* I - Service reference */
2991 DNSServiceFlags flags
, /* I - Option flags */
2992 uint32_t interfaceIndex
, /* I - Interface number */
2993 DNSServiceErrorType errorCode
, /* I - Error, if any */
2994 const char *serviceName
, /* I - Name of service/device */
2995 const char *regtype
, /* I - Type of service */
2996 const char *replyDomain
, /* I - Service domain */
2997 void *context
) /* I - Enumeration data */
2999 _cups_dnssd_data_t
*data
= (_cups_dnssd_data_t
*)context
;
3000 /* Enumeration data */
3003 DEBUG_printf(("5cups_dnssd_browse_cb(sdRef=%p, flags=%x, interfaceIndex=%d, errorCode=%d, serviceName=\"%s\", regtype=\"%s\", replyDomain=\"%s\", context=%p)", (void *)sdRef
, flags
, interfaceIndex
, errorCode
, serviceName
, regtype
, replyDomain
, context
));
3006 * Don't do anything on error...
3009 if (errorCode
!= kDNSServiceErr_NoError
)
3016 cups_dnssd_get_device(data
, serviceName
, regtype
, replyDomain
);
3020 # else /* HAVE_AVAHI */
3022 * 'cups_dnssd_browse_cb()' - Browse for printers.
3026 cups_dnssd_browse_cb(
3027 AvahiServiceBrowser
*browser
, /* I - Browser */
3028 AvahiIfIndex interface
, /* I - Interface index (unused) */
3029 AvahiProtocol protocol
, /* I - Network protocol (unused) */
3030 AvahiBrowserEvent event
, /* I - What happened */
3031 const char *name
, /* I - Service name */
3032 const char *type
, /* I - Registration type */
3033 const char *domain
, /* I - Domain */
3034 AvahiLookupResultFlags flags
, /* I - Flags */
3035 void *context
) /* I - Devices array */
3038 AvahiClient
*client
= avahi_service_browser_get_client(browser
);
3039 /* Client information */
3041 _cups_dnssd_data_t
*data
= (_cups_dnssd_data_t
*)context
;
3042 /* Enumeration data */
3049 DEBUG_printf(("cups_dnssd_browse_cb(..., name=\"%s\", type=\"%s\", domain=\"%s\", ...);", name
, type
, domain
));
3053 case AVAHI_BROWSER_FAILURE
:
3054 DEBUG_printf(("cups_dnssd_browse_cb: %s", avahi_strerror(avahi_client_errno(client
))));
3055 avahi_simple_poll_quit(data
->simple_poll
);
3058 case AVAHI_BROWSER_NEW
:
3060 * This object is new on the network.
3063 if (flags
& AVAHI_LOOKUP_RESULT_LOCAL
)
3066 * This comes from the local machine so ignore it.
3069 DEBUG_printf(("cups_dnssd_browse_cb: Ignoring local service \"%s\".", name
));
3074 * Create a device entry for it if it doesn't yet exist.
3077 cups_dnssd_get_device(data
, name
, type
, domain
);
3081 case AVAHI_BROWSER_REMOVE
:
3082 case AVAHI_BROWSER_CACHE_EXHAUSTED
:
3085 case AVAHI_BROWSER_ALL_FOR_NOW
:
3086 DEBUG_puts("cups_dnssd_browse_cb: ALL_FOR_NOW");
3094 * 'cups_dnssd_client_cb()' - Avahi client callback function.
3098 cups_dnssd_client_cb(
3099 AvahiClient
*client
, /* I - Client information (unused) */
3100 AvahiClientState state
, /* I - Current state */
3101 void *context
) /* I - User data (unused) */
3103 _cups_dnssd_data_t
*data
= (_cups_dnssd_data_t
*)context
;
3104 /* Enumeration data */
3109 DEBUG_printf(("cups_dnssd_client_cb(client=%p, state=%d, context=%p)", client
, state
, context
));
3112 * If the connection drops, quit.
3115 if (state
== AVAHI_CLIENT_FAILURE
)
3117 DEBUG_puts("cups_dnssd_client_cb: Avahi connection failed.");
3118 avahi_simple_poll_quit(data
->simple_poll
);
3121 # endif /* HAVE_DNSSD */
3125 * 'cups_dnssd_compare_device()' - Compare two devices.
3128 static int /* O - Result of comparison */
3129 cups_dnssd_compare_devices(
3130 _cups_dnssd_device_t
*a
, /* I - First device */
3131 _cups_dnssd_device_t
*b
) /* I - Second device */
3133 return (strcmp(a
->dest
.name
, b
->dest
.name
));
3138 * 'cups_dnssd_free_device()' - Free the memory used by a device.
3142 cups_dnssd_free_device(
3143 _cups_dnssd_device_t
*device
, /* I - Device */
3144 _cups_dnssd_data_t
*data
) /* I - Enumeration data */
3146 DEBUG_printf(("5cups_dnssd_free_device(device=%p(%s), data=%p)", (void *)device
, device
->dest
.name
, (void *)data
));
3150 DNSServiceRefDeallocate(device
->ref
);
3151 # else /* HAVE_AVAHI */
3153 avahi_record_browser_free(device
->ref
);
3154 # endif /* HAVE_DNSSD */
3156 _cupsStrFree(device
->domain
);
3157 _cupsStrFree(device
->fullName
);
3158 _cupsStrFree(device
->regtype
);
3159 _cupsStrFree(device
->dest
.name
);
3161 cupsFreeOptions(device
->dest
.num_options
, device
->dest
.options
);
3168 * 'cups_dnssd_get_device()' - Lookup a device and create it as needed.
3171 static _cups_dnssd_device_t
* /* O - Device */
3172 cups_dnssd_get_device(
3173 _cups_dnssd_data_t
*data
, /* I - Enumeration data */
3174 const char *serviceName
, /* I - Service name */
3175 const char *regtype
, /* I - Registration type */
3176 const char *replyDomain
) /* I - Domain name */
3178 _cups_dnssd_device_t key
, /* Search key */
3179 *device
; /* Device */
3180 char fullName
[kDNSServiceMaxDomainName
],
3181 /* Full name for query */
3182 name
[128]; /* Queue name */
3185 DEBUG_printf(("5cups_dnssd_get_device(data=%p, serviceName=\"%s\", regtype=\"%s\", replyDomain=\"%s\")", (void *)data
, serviceName
, regtype
, replyDomain
));
3188 * See if this is an existing device...
3191 cups_queue_name(name
, serviceName
, sizeof(name
));
3193 key
.dest
.name
= name
;
3195 if ((device
= cupsArrayFind(data
->devices
, &key
)) != NULL
)
3198 * Yes, see if we need to do anything with this...
3201 int update
= 0; /* Non-zero if we need to update */
3203 if (!_cups_strcasecmp(replyDomain
, "local.") &&
3204 _cups_strcasecmp(device
->domain
, replyDomain
))
3207 * Update the "global" listing to use the .local domain name instead.
3210 _cupsStrFree(device
->domain
);
3211 device
->domain
= _cupsStrAlloc(replyDomain
);
3213 DEBUG_printf(("6cups_dnssd_get_device: Updating '%s' to use local "
3214 "domain.", device
->dest
.name
));
3219 if (!_cups_strcasecmp(regtype
, "_ipps._tcp") &&
3220 _cups_strcasecmp(device
->regtype
, regtype
))
3223 * Prefer IPPS over IPP.
3226 _cupsStrFree(device
->regtype
);
3227 device
->regtype
= _cupsStrAlloc(regtype
);
3229 DEBUG_printf(("6cups_dnssd_get_device: Updating '%s' to use IPPS.",
3230 device
->dest
.name
));
3237 DEBUG_printf(("6cups_dnssd_get_device: No changes to '%s'.",
3238 device
->dest
.name
));
3245 * No, add the device...
3248 DEBUG_printf(("6cups_dnssd_get_device: Adding '%s' for %s with domain "
3249 "'%s'.", serviceName
,
3250 !strcmp(regtype
, "_ipps._tcp") ? "IPPS" : "IPP",
3253 device
= calloc(sizeof(_cups_dnssd_device_t
), 1);
3254 device
->dest
.name
= _cupsStrAlloc(name
);
3255 device
->domain
= _cupsStrAlloc(replyDomain
);
3256 device
->regtype
= _cupsStrAlloc(regtype
);
3258 device
->dest
.num_options
= cupsAddOption("printer-info", serviceName
, 0, &device
->dest
.options
);
3260 cupsArrayAdd(data
->devices
, device
);
3264 * Set the "full name" of this service, which is used for queries...
3268 DNSServiceConstructFullName(fullName
, serviceName
, regtype
, replyDomain
);
3269 # else /* HAVE_AVAHI */
3270 avahi_service_name_join(fullName
, kDNSServiceMaxDomainName
, serviceName
, regtype
, replyDomain
);
3271 # endif /* HAVE_DNSSD */
3273 _cupsStrFree(device
->fullName
);
3274 device
->fullName
= _cupsStrAlloc(fullName
);
3279 DNSServiceRefDeallocate(device
->ref
);
3280 # else /* HAVE_AVAHI */
3281 avahi_record_browser_free(device
->ref
);
3282 # endif /* HAVE_DNSSD */
3287 if (device
->state
== _CUPS_DNSSD_ACTIVE
)
3289 DEBUG_printf(("6cups_dnssd_get_device: Remove callback for \"%s\".", device
->dest
.name
));
3291 (*data
->cb
)(data
->user_data
, CUPS_DEST_FLAGS_REMOVED
, &device
->dest
);
3292 device
->state
= _CUPS_DNSSD_NEW
;
3301 * 'cups_dnssd_local_cb()' - Browse for local printers.
3305 cups_dnssd_local_cb(
3306 DNSServiceRef sdRef
, /* I - Service reference */
3307 DNSServiceFlags flags
, /* I - Option flags */
3308 uint32_t interfaceIndex
, /* I - Interface number */
3309 DNSServiceErrorType errorCode
, /* I - Error, if any */
3310 const char *serviceName
, /* I - Name of service/device */
3311 const char *regtype
, /* I - Type of service */
3312 const char *replyDomain
, /* I - Service domain */
3313 void *context
) /* I - Devices array */
3315 _cups_dnssd_data_t
*data
= (_cups_dnssd_data_t
*)context
;
3316 /* Enumeration data */
3317 _cups_dnssd_device_t
*device
; /* Device */
3320 DEBUG_printf(("5cups_dnssd_local_cb(sdRef=%p, flags=%x, interfaceIndex=%d, errorCode=%d, serviceName=\"%s\", regtype=\"%s\", replyDomain=\"%s\", context=%p)", (void *)sdRef
, flags
, interfaceIndex
, errorCode
, serviceName
, regtype
, replyDomain
, context
));
3323 * Only process "add" data...
3326 if (errorCode
!= kDNSServiceErr_NoError
|| !(flags
& kDNSServiceFlagsAdd
))
3333 device
= cups_dnssd_get_device(data
, serviceName
, regtype
, replyDomain
);
3336 * Hide locally-registered devices...
3339 DEBUG_printf(("6cups_dnssd_local_cb: Hiding local printer '%s'.",
3344 DNSServiceRefDeallocate(device
->ref
);
3348 if (device
->state
== _CUPS_DNSSD_ACTIVE
)
3350 DEBUG_printf(("6cups_dnssd_local_cb: Remove callback for \"%s\".", device
->dest
.name
));
3351 (*data
->cb
)(data
->user_data
, CUPS_DEST_FLAGS_REMOVED
, &device
->dest
);
3354 device
->state
= _CUPS_DNSSD_LOCAL
;
3356 # endif /* HAVE_DNSSD */
3361 * 'cups_dnssd_poll_cb()' - Wait for input on the specified file descriptors.
3363 * Note: This function is needed because avahi_simple_poll_iterate is broken
3364 * and always uses a timeout of 0 (!) milliseconds.
3365 * (https://github.com/lathiat/avahi/issues/127)
3370 static int /* O - Number of file descriptors matching */
3372 struct pollfd
*pollfds
, /* I - File descriptors */
3373 unsigned int num_pollfds
, /* I - Number of file descriptors */
3374 int timeout
, /* I - Timeout in milliseconds (unused) */
3375 void *context
) /* I - User data (unused) */
3377 _cups_dnssd_data_t
*data
= (_cups_dnssd_data_t
*)context
;
3378 /* Enumeration data */
3379 int val
; /* Return value */
3382 DEBUG_printf(("cups_dnssd_poll_cb(pollfds=%p, num_pollfds=%d, timeout=%d, context=%p)", pollfds
, num_pollfds
, timeout
, context
));
3386 val
= poll(pollfds
, num_pollfds
, _CUPS_DNSSD_MAXTIME
);
3388 DEBUG_printf(("cups_dnssd_poll_cb: poll() returned %d", val
));
3392 DEBUG_printf(("cups_dnssd_poll_cb: %s", strerror(errno
)));
3401 # endif /* HAVE_AVAHI */
3405 * 'cups_dnssd_query_cb()' - Process query data.
3410 cups_dnssd_query_cb(
3411 DNSServiceRef sdRef
, /* I - Service reference */
3412 DNSServiceFlags flags
, /* I - Data flags */
3413 uint32_t interfaceIndex
, /* I - Interface */
3414 DNSServiceErrorType errorCode
, /* I - Error, if any */
3415 const char *fullName
, /* I - Full service name */
3416 uint16_t rrtype
, /* I - Record type */
3417 uint16_t rrclass
, /* I - Record class */
3418 uint16_t rdlen
, /* I - Length of record data */
3419 const void *rdata
, /* I - Record data */
3420 uint32_t ttl
, /* I - Time-to-live */
3421 void *context
) /* I - Enumeration data */
3423 # else /* HAVE_AVAHI */
3425 cups_dnssd_query_cb(
3426 AvahiRecordBrowser
*browser
, /* I - Record browser */
3427 AvahiIfIndex interfaceIndex
,
3428 /* I - Interface index (unused) */
3429 AvahiProtocol protocol
, /* I - Network protocol (unused) */
3430 AvahiBrowserEvent event
, /* I - What happened? */
3431 const char *fullName
, /* I - Service name */
3432 uint16_t rrclass
, /* I - Record class */
3433 uint16_t rrtype
, /* I - Record type */
3434 const void *rdata
, /* I - TXT record */
3435 size_t rdlen
, /* I - Length of TXT record */
3436 AvahiLookupResultFlags flags
, /* I - Flags */
3437 void *context
) /* I - Enumeration data */
3440 AvahiClient
*client
= avahi_record_browser_get_client(browser
);
3441 /* Client information */
3443 # endif /* HAVE_DNSSD */
3444 _cups_dnssd_data_t
*data
= (_cups_dnssd_data_t
*)context
;
3445 /* Enumeration data */
3446 char serviceName
[256],/* Service name */
3447 name
[128], /* Queue name */
3448 *ptr
; /* Pointer into string */
3449 _cups_dnssd_device_t dkey
, /* Search key */
3450 *device
; /* Device */
3454 DEBUG_printf(("5cups_dnssd_query_cb(sdRef=%p, flags=%x, interfaceIndex=%d, errorCode=%d, fullName=\"%s\", rrtype=%u, rrclass=%u, rdlen=%u, rdata=%p, ttl=%u, context=%p)", (void *)sdRef
, flags
, interfaceIndex
, errorCode
, fullName
, rrtype
, rrclass
, rdlen
, rdata
, ttl
, context
));
3457 * Only process "add" data...
3460 if (errorCode
!= kDNSServiceErr_NoError
|| !(flags
& kDNSServiceFlagsAdd
))
3463 # else /* HAVE_AVAHI */
3464 DEBUG_printf(("cups_dnssd_query_cb(browser=%p, interfaceIndex=%d, protocol=%d, event=%d, fullName=\"%s\", rrclass=%u, rrtype=%u, rdata=%p, rdlen=%u, flags=%x, context=%p)", browser
, interfaceIndex
, protocol
, event
, fullName
, rrclass
, rrtype
, rdata
, (unsigned)rdlen
, flags
, context
));
3467 * Only process "add" data...
3470 if (event
!= AVAHI_BROWSER_NEW
)
3472 if (event
== AVAHI_BROWSER_FAILURE
)
3473 DEBUG_printf(("cups_dnssd_query_cb: %s", avahi_strerror(avahi_client_errno(client
))));
3477 # endif /* HAVE_DNSSD */
3480 * Lookup the service in the devices array.
3483 cups_dnssd_unquote(serviceName
, fullName
, sizeof(serviceName
));
3485 if ((ptr
= strstr(serviceName
, "._")) != NULL
)
3488 cups_queue_name(name
, serviceName
, sizeof(name
));
3490 dkey
.dest
.name
= name
;
3492 if ((device
= cupsArrayFind(data
->devices
, &dkey
)) != NULL
&& device
->state
== _CUPS_DNSSD_NEW
)
3495 * Found it, pull out the make and model from the TXT record and save it...
3498 const uint8_t *txt
, /* Pointer into data */
3499 *txtnext
, /* Next key/value pair */
3500 *txtend
; /* End of entire TXT record */
3501 uint8_t txtlen
; /* Length of current key/value pair */
3502 char key
[256], /* Key string */
3503 value
[256], /* Value string */
3504 make_and_model
[512],
3505 /* Manufacturer and model */
3506 model
[256], /* Model */
3507 uriname
[1024], /* Name for URI */
3508 uri
[1024]; /* Printer URI */
3509 cups_ptype_t type
= CUPS_PRINTER_DISCOVERED
| CUPS_PRINTER_BW
;
3511 int saw_printer_type
= 0;
3512 /* Did we see a printer-type key? */
3514 device
->state
= _CUPS_DNSSD_PENDING
;
3515 make_and_model
[0] = '\0';
3517 strlcpy(model
, "Unknown", sizeof(model
));
3519 for (txt
= rdata
, txtend
= txt
+ rdlen
;
3524 * Read a key/value pair starting with an 8-bit length. Since the
3525 * length is 8 bits and the size of the key/value buffers is 256, we
3526 * don't need to check for overflow...
3531 if (!txtlen
|| (txt
+ txtlen
) > txtend
)
3534 txtnext
= txt
+ txtlen
;
3536 for (ptr
= key
; txt
< txtnext
&& *txt
!= '='; txt
++)
3537 *ptr
++ = (char)*txt
;
3540 if (txt
< txtnext
&& *txt
== '=')
3545 memcpy(value
, txt
, (size_t)(txtnext
- txt
));
3546 value
[txtnext
- txt
] = '\0';
3548 DEBUG_printf(("6cups_dnssd_query_cb: %s=%s", key
, value
));
3552 DEBUG_printf(("6cups_dnssd_query_cb: '%s' with no value.", key
));
3556 if (!_cups_strcasecmp(key
, "usb_MFG") ||
3557 !_cups_strcasecmp(key
, "usb_MANU") ||
3558 !_cups_strcasecmp(key
, "usb_MANUFACTURER"))
3559 strlcpy(make_and_model
, value
, sizeof(make_and_model
));
3560 else if (!_cups_strcasecmp(key
, "usb_MDL") ||
3561 !_cups_strcasecmp(key
, "usb_MODEL"))
3562 strlcpy(model
, value
, sizeof(model
));
3563 else if (!_cups_strcasecmp(key
, "product") && !strstr(value
, "Ghostscript"))
3565 if (value
[0] == '(')
3568 * Strip parenthesis...
3571 if ((ptr
= value
+ strlen(value
) - 1) > value
&& *ptr
== ')')
3574 strlcpy(model
, value
+ 1, sizeof(model
));
3577 strlcpy(model
, value
, sizeof(model
));
3579 else if (!_cups_strcasecmp(key
, "ty"))
3581 strlcpy(model
, value
, sizeof(model
));
3583 if ((ptr
= strchr(model
, ',')) != NULL
)
3586 else if (!_cups_strcasecmp(key
, "note"))
3587 device
->dest
.num_options
= cupsAddOption("printer-location", value
,
3588 device
->dest
.num_options
,
3589 &device
->dest
.options
);
3590 else if (!_cups_strcasecmp(key
, "pdl"))
3593 * Look for PDF-capable printers; only PDF-capable printers are shown.
3596 const char *start
, *next
; /* Pointer into value */
3597 int have_pdf
= 0, /* Have PDF? */
3598 have_raster
= 0;/* Have raster format support? */
3600 for (start
= value
; start
&& *start
; start
= next
)
3602 if (!_cups_strncasecmp(start
, "application/pdf", 15) && (!start
[15] || start
[15] == ','))
3607 else if ((!_cups_strncasecmp(start
, "image/pwg-raster", 16) && (!start
[16] || start
[16] == ',')) ||
3608 (!_cups_strncasecmp(start
, "image/urf", 9) && (!start
[9] || start
[9] == ',')))
3614 if ((next
= strchr(start
, ',')) != NULL
)
3618 if (!have_pdf
&& !have_raster
)
3619 device
->state
= _CUPS_DNSSD_INCOMPATIBLE
;
3621 else if (!_cups_strcasecmp(key
, "printer-type"))
3624 * Value is either NNNN or 0xXXXX
3627 saw_printer_type
= 1;
3628 type
= (cups_ptype_t
)strtol(value
, NULL
, 0) | CUPS_PRINTER_DISCOVERED
;
3630 else if (!saw_printer_type
)
3632 if (!_cups_strcasecmp(key
, "air") &&
3633 !_cups_strcasecmp(value
, "t"))
3634 type
|= CUPS_PRINTER_AUTHENTICATED
;
3635 else if (!_cups_strcasecmp(key
, "bind") &&
3636 !_cups_strcasecmp(value
, "t"))
3637 type
|= CUPS_PRINTER_BIND
;
3638 else if (!_cups_strcasecmp(key
, "collate") &&
3639 !_cups_strcasecmp(value
, "t"))
3640 type
|= CUPS_PRINTER_COLLATE
;
3641 else if (!_cups_strcasecmp(key
, "color") &&
3642 !_cups_strcasecmp(value
, "t"))
3643 type
|= CUPS_PRINTER_COLOR
;
3644 else if (!_cups_strcasecmp(key
, "copies") &&
3645 !_cups_strcasecmp(value
, "t"))
3646 type
|= CUPS_PRINTER_COPIES
;
3647 else if (!_cups_strcasecmp(key
, "duplex") &&
3648 !_cups_strcasecmp(value
, "t"))
3649 type
|= CUPS_PRINTER_DUPLEX
;
3650 else if (!_cups_strcasecmp(key
, "fax") &&
3651 !_cups_strcasecmp(value
, "t"))
3652 type
|= CUPS_PRINTER_MFP
;
3653 else if (!_cups_strcasecmp(key
, "papercustom") &&
3654 !_cups_strcasecmp(value
, "t"))
3655 type
|= CUPS_PRINTER_VARIABLE
;
3656 else if (!_cups_strcasecmp(key
, "papermax"))
3658 if (!_cups_strcasecmp(value
, "legal-a4"))
3659 type
|= CUPS_PRINTER_SMALL
;
3660 else if (!_cups_strcasecmp(value
, "isoc-a2"))
3661 type
|= CUPS_PRINTER_MEDIUM
;
3662 else if (!_cups_strcasecmp(value
, ">isoc-a2"))
3663 type
|= CUPS_PRINTER_LARGE
;
3665 else if (!_cups_strcasecmp(key
, "punch") &&
3666 !_cups_strcasecmp(value
, "t"))
3667 type
|= CUPS_PRINTER_PUNCH
;
3668 else if (!_cups_strcasecmp(key
, "scan") &&
3669 !_cups_strcasecmp(value
, "t"))
3670 type
|= CUPS_PRINTER_MFP
;
3671 else if (!_cups_strcasecmp(key
, "sort") &&
3672 !_cups_strcasecmp(value
, "t"))
3673 type
|= CUPS_PRINTER_SORT
;
3674 else if (!_cups_strcasecmp(key
, "staple") &&
3675 !_cups_strcasecmp(value
, "t"))
3676 type
|= CUPS_PRINTER_STAPLE
;
3681 * Save the printer-xxx values...
3684 if (make_and_model
[0])
3686 strlcat(make_and_model
, " ", sizeof(make_and_model
));
3687 strlcat(make_and_model
, model
, sizeof(make_and_model
));
3689 device
->dest
.num_options
= cupsAddOption("printer-make-and-model", make_and_model
, device
->dest
.num_options
, &device
->dest
.options
);
3692 device
->dest
.num_options
= cupsAddOption("printer-make-and-model", model
, device
->dest
.num_options
, &device
->dest
.options
);
3694 device
->type
= type
;
3695 snprintf(value
, sizeof(value
), "%u", type
);
3696 device
->dest
.num_options
= cupsAddOption("printer-type", value
, device
->dest
.num_options
, &device
->dest
.options
);
3702 cups_dnssd_unquote(uriname
, device
->fullName
, sizeof(uriname
));
3703 httpAssembleURI(HTTP_URI_CODING_ALL
, uri
, sizeof(uri
),
3704 !strcmp(device
->regtype
, "_ipps._tcp") ? "ipps" : "ipp",
3705 NULL
, uriname
, 0, saw_printer_type
? "/cups" : "/");
3707 DEBUG_printf(("6cups_dnssd_query: device-uri=\"%s\"", uri
));
3709 device
->dest
.num_options
= cupsAddOption("device-uri", uri
, device
->dest
.num_options
, &device
->dest
.options
);
3712 DEBUG_printf(("6cups_dnssd_query: Ignoring TXT record for '%s'.",
3718 * 'cups_dnssd_resolve()' - Resolve a Bonjour printer URI.
3721 static const char * /* O - Resolved URI or NULL */
3723 cups_dest_t
*dest
, /* I - Destination */
3724 const char *uri
, /* I - Current printer URI */
3725 int msec
, /* I - Time in milliseconds */
3726 int *cancel
, /* I - Pointer to "cancel" variable */
3727 cups_dest_cb_t cb
, /* I - Callback */
3728 void *user_data
) /* I - User data for callback */
3730 char tempuri
[1024]; /* Temporary URI buffer */
3731 _cups_dnssd_resolve_t resolve
; /* Resolve data */
3735 * Resolve the URI...
3738 resolve
.cancel
= cancel
;
3739 gettimeofday(&resolve
.end_time
, NULL
);
3742 resolve
.end_time
.tv_sec
+= msec
/ 1000;
3743 resolve
.end_time
.tv_usec
+= (msec
% 1000) * 1000;
3745 while (resolve
.end_time
.tv_usec
>= 1000000)
3747 resolve
.end_time
.tv_sec
++;
3748 resolve
.end_time
.tv_usec
-= 1000000;
3752 resolve
.end_time
.tv_sec
+= 75;
3755 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_RESOLVING
, dest
);
3757 if ((uri
= _httpResolveURI(uri
, tempuri
, sizeof(tempuri
), _HTTP_RESOLVE_DEFAULT
, cups_dnssd_resolve_cb
, &resolve
)) == NULL
)
3759 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("Unable to resolve printer-uri."), 1);
3762 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_ERROR
, dest
);
3768 * Save the resolved URI...
3771 dest
->num_options
= cupsAddOption("resolved-device-uri", uri
, dest
->num_options
, &dest
->options
);
3773 return (cupsGetOption("resolved-device-uri", dest
->num_options
, dest
->options
));
3778 * 'cups_dnssd_resolve_cb()' - See if we should continue resolving.
3781 static int /* O - 1 to continue, 0 to stop */
3782 cups_dnssd_resolve_cb(void *context
) /* I - Resolve data */
3784 _cups_dnssd_resolve_t
*resolve
= (_cups_dnssd_resolve_t
*)context
;
3786 struct timeval curtime
; /* Current time */
3790 * If the cancel variable is set, return immediately.
3793 if (resolve
->cancel
&& *(resolve
->cancel
))
3795 DEBUG_puts("4cups_dnssd_resolve_cb: Canceled.");
3800 * Otherwise check the end time...
3803 gettimeofday(&curtime
, NULL
);
3805 DEBUG_printf(("4cups_dnssd_resolve_cb: curtime=%d.%06d, end_time=%d.%06d", (int)curtime
.tv_sec
, (int)curtime
.tv_usec
, (int)resolve
->end_time
.tv_sec
, (int)resolve
->end_time
.tv_usec
));
3807 return (curtime
.tv_sec
< resolve
->end_time
.tv_sec
||
3808 (curtime
.tv_sec
== resolve
->end_time
.tv_sec
&&
3809 curtime
.tv_usec
< resolve
->end_time
.tv_usec
));
3814 * 'cups_dnssd_unquote()' - Unquote a name string.
3818 cups_dnssd_unquote(char *dst
, /* I - Destination buffer */
3819 const char *src
, /* I - Source string */
3820 size_t dstsize
) /* I - Size of destination buffer */
3822 char *dstend
= dst
+ dstsize
- 1; /* End of destination buffer */
3825 while (*src
&& dst
< dstend
)
3830 if (isdigit(src
[0] & 255) && isdigit(src
[1] & 255) &&
3831 isdigit(src
[2] & 255))
3833 *dst
++ = ((((src
[0] - '0') * 10) + src
[1] - '0') * 10) + src
[2] - '0';
3845 #endif /* HAVE_DNSSD */
3848 #if defined(HAVE_AVAHI) || defined(HAVE_DNSSD)
3850 * 'cups_elapsed()' - Return the elapsed time in milliseconds.
3853 static int /* O - Elapsed time in milliseconds */
3854 cups_elapsed(struct timeval
*t
) /* IO - Previous time */
3856 int msecs
; /* Milliseconds */
3857 struct timeval nt
; /* New time */
3860 gettimeofday(&nt
, NULL
);
3862 msecs
= (int)(1000 * (nt
.tv_sec
- t
->tv_sec
) + (nt
.tv_usec
- t
->tv_usec
) / 1000);
3868 #endif /* HAVE_AVAHI || HAVE_DNSSD */
3872 * 'cups_find_dest()' - Find a destination using a binary search.
3875 static int /* O - Index of match */
3876 cups_find_dest(const char *name
, /* I - Destination name */
3877 const char *instance
, /* I - Instance or NULL */
3878 int num_dests
, /* I - Number of destinations */
3879 cups_dest_t
*dests
, /* I - Destinations */
3880 int prev
, /* I - Previous index */
3881 int *rdiff
) /* O - Difference of match */
3883 int left
, /* Low mark for binary search */
3884 right
, /* High mark for binary search */
3885 current
, /* Current index */
3886 diff
; /* Result of comparison */
3887 cups_dest_t key
; /* Search key */
3890 key
.name
= (char *)name
;
3891 key
.instance
= (char *)instance
;
3896 * Start search on either side of previous...
3899 if ((diff
= cups_compare_dests(&key
, dests
+ prev
)) == 0 ||
3900 (diff
< 0 && prev
== 0) ||
3901 (diff
> 0 && prev
== (num_dests
- 1)))
3909 * Start with previous on right side...
3918 * Start wih previous on left side...
3922 right
= num_dests
- 1;
3928 * Start search in the middle...
3932 right
= num_dests
- 1;
3937 current
= (left
+ right
) / 2;
3938 diff
= cups_compare_dests(&key
, dests
+ current
);
3947 while ((right
- left
) > 1);
3952 * Check the last 1 or 2 elements...
3955 if ((diff
= cups_compare_dests(&key
, dests
+ left
)) <= 0)
3959 diff
= cups_compare_dests(&key
, dests
+ right
);
3965 * Return the closest destination and the difference...
3975 * 'cups_get_cb()' - Collect enumerated destinations.
3978 static int /* O - 1 to continue, 0 to stop */
3979 cups_get_cb(_cups_getdata_t
*data
, /* I - Data from cupsGetDests */
3980 unsigned flags
, /* I - Enumeration flags */
3981 cups_dest_t
*dest
) /* I - Destination */
3983 if (flags
& CUPS_DEST_FLAGS_REMOVED
)
3986 * Remove destination from array...
3989 data
->num_dests
= cupsRemoveDest(dest
->name
, dest
->instance
, data
->num_dests
, &data
->dests
);
3994 * Add destination to array...
3997 data
->num_dests
= cupsCopyDest(dest
, data
->num_dests
, &data
->dests
);
4005 * 'cups_get_default()' - Get the default destination from an lpoptions file.
4008 static char * /* O - Default destination or NULL */
4009 cups_get_default(const char *filename
, /* I - File to read */
4010 char *namebuf
, /* I - Name buffer */
4011 size_t namesize
, /* I - Size of name buffer */
4012 const char **instance
) /* I - Instance */
4014 cups_file_t
*fp
; /* lpoptions file */
4015 char line
[8192], /* Line from file */
4016 *value
, /* Value for line */
4017 *nameptr
; /* Pointer into name */
4018 int linenum
; /* Current line */
4023 if ((fp
= cupsFileOpen(filename
, "r")) != NULL
)
4027 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
4029 if (!_cups_strcasecmp(line
, "default") && value
)
4031 strlcpy(namebuf
, value
, namesize
);
4033 if ((nameptr
= strchr(namebuf
, ' ')) != NULL
)
4035 if ((nameptr
= strchr(namebuf
, '\t')) != NULL
)
4038 if ((nameptr
= strchr(namebuf
, '/')) != NULL
)
4041 *instance
= nameptr
;
4049 return (*namebuf
? namebuf
: NULL
);
4054 * 'cups_get_dests()' - Get destinations from a file.
4057 static int /* O - Number of destinations */
4059 const char *filename
, /* I - File to read from */
4060 const char *match_name
, /* I - Destination name we want */
4061 const char *match_inst
, /* I - Instance name we want */
4062 int user_default_set
, /* I - User default printer set? */
4063 int num_dests
, /* I - Number of destinations */
4064 cups_dest_t
**dests
) /* IO - Destinations */
4066 int i
; /* Looping var */
4067 cups_dest_t
*dest
; /* Current destination */
4068 cups_file_t
*fp
; /* File pointer */
4069 char line
[8192], /* Line from file */
4070 *lineptr
, /* Pointer into line */
4071 *name
, /* Name of destination/option */
4072 *instance
; /* Instance of destination */
4073 int linenum
; /* Current line number */
4076 DEBUG_printf(("7cups_get_dests(filename=\"%s\", match_name=\"%s\", match_inst=\"%s\", user_default_set=%d, num_dests=%d, dests=%p)", filename
, match_name
, match_inst
, user_default_set
, num_dests
, (void *)dests
));
4079 * Try to open the file...
4082 if ((fp
= cupsFileOpen(filename
, "r")) == NULL
)
4086 * Read each printer; each line looks like:
4088 * Dest name[/instance] options
4089 * Default name[/instance] options
4094 while (cupsFileGetConf(fp
, line
, sizeof(line
), &lineptr
, &linenum
))
4097 * See what type of line it is...
4100 DEBUG_printf(("9cups_get_dests: linenum=%d line=\"%s\" lineptr=\"%s\"",
4101 linenum
, line
, lineptr
));
4103 if ((_cups_strcasecmp(line
, "dest") && _cups_strcasecmp(line
, "default")) || !lineptr
)
4105 DEBUG_puts("9cups_get_dests: Not a dest or default line...");
4112 * Search for an instance...
4115 while (!isspace(*lineptr
& 255) && *lineptr
&& *lineptr
!= '/')
4118 if (*lineptr
== '/')
4121 * Found an instance...
4128 * Search for an instance...
4131 while (!isspace(*lineptr
& 255) && *lineptr
)
4140 DEBUG_printf(("9cups_get_dests: name=\"%s\", instance=\"%s\"", name
,
4144 * See if the primary instance of the destination exists; if not,
4145 * ignore this entry and move on...
4150 if (_cups_strcasecmp(name
, match_name
) ||
4151 (!instance
&& match_inst
) ||
4152 (instance
&& !match_inst
) ||
4153 (instance
&& _cups_strcasecmp(instance
, match_inst
)))
4158 else if (cupsGetDest(name
, NULL
, num_dests
, *dests
) == NULL
)
4160 DEBUG_puts("9cups_get_dests: Not found!");
4166 * Add the destination...
4169 num_dests
= cupsAddDest(name
, instance
, num_dests
, dests
);
4171 if ((dest
= cupsGetDest(name
, instance
, num_dests
, *dests
)) == NULL
)
4177 DEBUG_puts("9cups_get_dests: Out of memory!");
4183 * Add options until we hit the end of the line...
4186 dest
->num_options
= cupsParseOptions(lineptr
, dest
->num_options
,
4190 * If we found what we were looking for, stop now...
4197 * Set this as default if needed...
4200 if (!user_default_set
&& !_cups_strcasecmp(line
, "default"))
4202 DEBUG_puts("9cups_get_dests: Setting as default...");
4204 for (i
= 0; i
< num_dests
; i
++)
4205 (*dests
)[i
].is_default
= 0;
4207 dest
->is_default
= 1;
4212 * Close the file and return...
4222 * 'cups_make_string()' - Make a comma-separated string of values from an IPP
4226 static char * /* O - New string */
4228 ipp_attribute_t
*attr
, /* I - Attribute to convert */
4229 char *buffer
, /* I - Buffer */
4230 size_t bufsize
) /* I - Size of buffer */
4232 int i
; /* Looping var */
4233 char *ptr
, /* Pointer into buffer */
4234 *end
, /* Pointer to end of buffer */
4235 *valptr
; /* Pointer into string attribute */
4239 * Return quickly if we have a single string value...
4242 if (attr
->num_values
== 1 &&
4243 attr
->value_tag
!= IPP_TAG_INTEGER
&&
4244 attr
->value_tag
!= IPP_TAG_ENUM
&&
4245 attr
->value_tag
!= IPP_TAG_BOOLEAN
&&
4246 attr
->value_tag
!= IPP_TAG_RANGE
)
4247 return (attr
->values
[0].string
.text
);
4250 * Copy the values to the string, separating with commas and escaping strings
4254 end
= buffer
+ bufsize
- 1;
4256 for (i
= 0, ptr
= buffer
; i
< attr
->num_values
&& ptr
< end
; i
++)
4261 switch (attr
->value_tag
)
4263 case IPP_TAG_INTEGER
:
4265 snprintf(ptr
, (size_t)(end
- ptr
+ 1), "%d", attr
->values
[i
].integer
);
4268 case IPP_TAG_BOOLEAN
:
4269 if (attr
->values
[i
].boolean
)
4270 strlcpy(ptr
, "true", (size_t)(end
- ptr
+ 1));
4272 strlcpy(ptr
, "false", (size_t)(end
- ptr
+ 1));
4275 case IPP_TAG_RANGE
:
4276 if (attr
->values
[i
].range
.lower
== attr
->values
[i
].range
.upper
)
4277 snprintf(ptr
, (size_t)(end
- ptr
+ 1), "%d", attr
->values
[i
].range
.lower
);
4279 snprintf(ptr
, (size_t)(end
- ptr
+ 1), "%d-%d", attr
->values
[i
].range
.lower
, attr
->values
[i
].range
.upper
);
4283 for (valptr
= attr
->values
[i
].string
.text
;
4284 *valptr
&& ptr
< end
;)
4286 if (strchr(" \t\n\\\'\"", *valptr
))
4288 if (ptr
>= (end
- 1))
4311 * 'cups_name_cb()' - Find an enumerated destination.
4314 static int /* O - 1 to continue, 0 to stop */
4315 cups_name_cb(_cups_namedata_t
*data
, /* I - Data from cupsGetNamedDest */
4316 unsigned flags
, /* I - Enumeration flags */
4317 cups_dest_t
*dest
) /* I - Destination */
4319 DEBUG_printf(("2cups_name_cb(data=%p(%s), flags=%x, dest=%p(%s)", (void *)data
, data
->name
, flags
, (void *)dest
, dest
->name
));
4321 if (!(flags
& CUPS_DEST_FLAGS_REMOVED
) && !dest
->instance
&& !strcasecmp(data
->name
, dest
->name
))
4324 * Copy destination and stop enumeration...
4327 cupsCopyDest(dest
, 0, &data
->dest
);
4336 * 'cups_queue_name()' - Create a local queue name based on the service name.
4341 char *name
, /* I - Name buffer */
4342 const char *serviceName
, /* I - Service name */
4343 size_t namesize
) /* I - Size of name buffer */
4345 const char *ptr
; /* Pointer into serviceName */
4346 char *nameptr
; /* Pointer into name */
4349 for (nameptr
= name
, ptr
= serviceName
; *ptr
&& nameptr
< (name
+ namesize
- 1); ptr
++)
4352 * Sanitize the printer name...
4355 if (_cups_isalnum(*ptr
))
4357 else if (nameptr
== name
|| nameptr
[-1] != '_')