2 * "$Id: dest.c 9568 2011-02-25 06:13:56Z mike $"
4 * User-defined destination (and option) support for CUPS.
6 * Copyright 2007-2012 by Apple Inc.
7 * Copyright 1997-2007 by Easy Software Products.
9 * These coded instructions, statements, and computer programs are the
10 * property of Apple Inc. and are protected by Federal copyright
11 * law. Distribution and use rights are outlined in the file "LICENSE.txt"
12 * which should have been included with this file. If this file is
13 * file is missing or damaged, see the license at "http://www.cups.org/".
15 * This file is subject to the Apple OS-Developed Software exception.
19 * cupsAddDest() - Add a destination to the list of
21 * _cupsAppleCopyDefaultPaperID() - Get the default paper ID.
22 * _cupsAppleCopyDefaultPrinter() - Get the default printer at this location.
23 * _cupsAppleGetUseLastPrinter() - Get whether to use the last used printer.
24 * _cupsAppleSetDefaultPaperID() - Set the default paper id.
25 * _cupsAppleSetDefaultPrinter() - Set the default printer for this
27 * _cupsAppleSetUseLastPrinter() - Set whether to use the last used printer.
28 * cupsConnectDest() - Connect to the server for a destination.
29 * cupsConnectDestBlock() - Connect to the server for a destination.
30 * cupsCopyDest() - Copy a destination.
31 * cupsEnumDests() - Enumerate available destinations with a
33 * cupsEnumDestsBlock() - Enumerate available destinations with a
35 * cupsFreeDests() - Free the memory used by the list of
37 * cupsGetDest() - Get the named destination from the list.
38 * _cupsGetDestResource() - Get the resource path and URI for a
40 * _cupsGetDests() - Get destinations from a server.
41 * cupsGetDests() - Get the list of destinations from the
43 * cupsGetDests2() - Get the list of destinations from the
45 * cupsGetNamedDest() - Get options for the named destination.
46 * cupsRemoveDest() - Remove a destination from the destination
48 * cupsSetDefaultDest() - Set the default destination.
49 * cupsSetDests() - Save the list of destinations for the
51 * cupsSetDests2() - Save the list of destinations for the
53 * _cupsUserDefault() - Get the user default printer from
54 * environment variables and location
56 * appleCopyLocations() - Copy the location history array.
57 * appleCopyNetwork() - Get the network ID for the current
59 * appleGetPaperSize() - Get the default paper size.
60 * appleGetPrinter() - Get a printer from the history array.
61 * cups_add_dest() - Add a destination to the array.
62 * cups_block_cb() - Enumeration callback for block API.
63 * cups_compare_dests() - Compare two destinations.
64 * cups_dnssd_browse_cb() - Browse for printers.
65 * cups_dnssd_browse_cb() - Browse for printers.
66 * cups_dnssd_client_cb() - Avahi client callback function.
67 * cups_dnssd_compare_device() - Compare two devices.
68 * cups_dnssd_free_device() - Free the memory used by a device.
69 * cups_dnssd_get_device() - Lookup a device and create it as needed.
70 * cups_dnssd_local_cb() - Browse for local printers.
71 * cups_dnssd_poll_cb() - Wait for input on the specified file
73 * cups_dnssd_query_cb() - Process query data.
74 * cups_dnssd_resolve() - Resolve a Bonjour printer URI.
75 * cups_dnssd_resolve_cb() - See if we should continue resolving.
76 * cups_dnssd_unquote() - Unquote a name string.
77 * cups_find_dest() - Find a destination using a binary search.
78 * cups_get_default() - Get the default destination from an
80 * cups_get_dests() - Get destinations from a file.
81 * cups_make_string() - Make a comma-separated string of values
82 * from an IPP attribute.
86 * Include necessary headers...
89 #include "cups-private.h"
94 #endif /* HAVE_NOTIFY_H */
98 #endif /* HAVE_POLL */
102 #endif /* HAVE_DNSSD */
105 # include <avahi-client/client.h>
106 # include <avahi-client/lookup.h>
107 # include <avahi-common/simple-watch.h>
108 # include <avahi-common/domain.h>
109 # include <avahi-common/error.h>
110 # include <avahi-common/malloc.h>
111 #define kDNSServiceMaxDomainName AVAHI_DOMAIN_NAME_MAX
112 #endif /* HAVE_AVAHI */
120 # include <SystemConfiguration/SystemConfiguration.h>
121 # define kCUPSPrintingPrefs CFSTR("org.cups.PrintingPrefs")
122 # define kDefaultPaperIDKey CFSTR("DefaultPaperID")
123 # define kLastUsedPrintersKey CFSTR("LastUsedPrinters")
124 # define kLocationNetworkKey CFSTR("Network")
125 # define kLocationPrinterIDKey CFSTR("PrinterID")
126 # define kUseLastPrinter CFSTR("UseLastPrinter")
127 #endif /* __APPLE__ */
134 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
135 typedef enum _cups_dnssd_state_e
/* Enumerated device state */
142 _CUPS_DNSSD_INCOMPATIBLE
,
144 } _cups_dnssd_state_t
;
146 typedef struct _cups_dnssd_data_s
/* Enumeration data */
149 DNSServiceRef main_ref
; /* Main service reference */
150 # else /* HAVE_AVAHI */
151 AvahiSimplePoll
*simple_poll
; /* Polling interface */
152 AvahiClient
*client
; /* Client information */
153 int got_data
; /* Did we get data? */
154 # endif /* HAVE_DNSSD */
155 cups_dest_cb_t cb
; /* Callback */
156 void *user_data
; /* User data pointer */
157 cups_ptype_t type
, /* Printer type filter */
158 mask
; /* Printer type mask */
159 cups_array_t
*devices
; /* Devices found so far */
160 } _cups_dnssd_data_t
;
162 typedef struct _cups_dnssd_device_s
/* Enumerated device */
164 _cups_dnssd_state_t state
; /* State of device listing */
166 DNSServiceRef ref
; /* Service reference for query */
167 # else /* HAVE_AVAHI */
168 AvahiRecordBrowser
*ref
; /* Browser for query */
169 # endif /* HAVE_DNSSD */
170 char *domain
, /* Domain name */
171 *fullName
, /* Full name */
172 *regtype
; /* Registration type */
173 cups_ptype_t type
; /* Device registration type */
174 cups_dest_t dest
; /* Destination record */
175 } _cups_dnssd_device_t
;
177 typedef struct _cups_dnssd_resolve_s
/* Data for resolving URI */
179 int *cancel
; /* Pointer to "cancel" variable */
180 struct timeval end_time
; /* Ending time */
181 } _cups_dnssd_resolve_t
;
182 #endif /* HAVE_DNSSD */
190 static CFArrayRef
appleCopyLocations(void);
191 static CFStringRef
appleCopyNetwork(void);
192 static char *appleGetPaperSize(char *name
, int namesize
);
193 static CFStringRef
appleGetPrinter(CFArrayRef locations
,
194 CFStringRef network
, CFIndex
*locindex
);
195 #endif /* __APPLE__ */
196 static cups_dest_t
*cups_add_dest(const char *name
, const char *instance
,
197 int *num_dests
, cups_dest_t
**dests
);
199 static int cups_block_cb(cups_dest_block_t block
, unsigned flags
,
201 #endif /* __BLOCKS__ */
202 static int cups_compare_dests(cups_dest_t
*a
, cups_dest_t
*b
);
203 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
205 static void cups_dnssd_browse_cb(DNSServiceRef sdRef
,
206 DNSServiceFlags flags
,
207 uint32_t interfaceIndex
,
208 DNSServiceErrorType errorCode
,
209 const char *serviceName
,
211 const char *replyDomain
,
213 # else /* HAVE_AVAHI */
214 static void cups_dnssd_browse_cb(AvahiServiceBrowser
*browser
,
215 AvahiIfIndex interface
,
216 AvahiProtocol protocol
,
217 AvahiBrowserEvent event
,
218 const char *serviceName
,
220 const char *replyDomain
,
221 AvahiLookupResultFlags flags
,
223 static void cups_dnssd_client_cb(AvahiClient
*client
,
224 AvahiClientState state
,
226 # endif /* HAVE_DNSSD */
227 static int cups_dnssd_compare_devices(_cups_dnssd_device_t
*a
,
228 _cups_dnssd_device_t
*b
);
229 static void cups_dnssd_free_device(_cups_dnssd_device_t
*device
,
230 _cups_dnssd_data_t
*data
);
231 static _cups_dnssd_device_t
*
232 cups_dnssd_get_device(_cups_dnssd_data_t
*data
,
233 const char *serviceName
,
235 const char *replyDomain
);
237 static void cups_dnssd_local_cb(DNSServiceRef sdRef
,
238 DNSServiceFlags flags
,
239 uint32_t interfaceIndex
,
240 DNSServiceErrorType errorCode
,
241 const char *serviceName
,
243 const char *replyDomain
,
245 static void cups_dnssd_query_cb(DNSServiceRef sdRef
,
246 DNSServiceFlags flags
,
247 uint32_t interfaceIndex
,
248 DNSServiceErrorType errorCode
,
249 const char *fullName
,
250 uint16_t rrtype
, uint16_t rrclass
,
251 uint16_t rdlen
, const void *rdata
,
252 uint32_t ttl
, void *context
);
253 # else /* HAVE_AVAHI */
254 static int cups_dnssd_poll_cb(struct pollfd
*pollfds
,
255 unsigned int num_pollfds
,
256 int timeout
, void *context
);
257 static void cups_dnssd_query_cb(AvahiRecordBrowser
*browser
,
258 AvahiIfIndex interface
,
259 AvahiProtocol protocol
,
260 AvahiBrowserEvent event
,
261 const char *name
, uint16_t rrclass
,
262 uint16_t rrtype
, const void *rdata
,
264 AvahiLookupResultFlags flags
,
266 # endif /* HAVE_DNSSD */
267 static const char *cups_dnssd_resolve(cups_dest_t
*dest
, const char *uri
,
268 int msec
, int *cancel
,
269 cups_dest_cb_t cb
, void *user_data
);
270 static int cups_dnssd_resolve_cb(void *context
);
271 static void cups_dnssd_unquote(char *dst
, const char *src
,
273 #endif /* HAVE_DNSSD || HAVE_AVAHI */
274 static int cups_find_dest(const char *name
, const char *instance
,
275 int num_dests
, cups_dest_t
*dests
, int prev
,
277 static char *cups_get_default(const char *filename
, char *namebuf
,
278 size_t namesize
, const char **instance
);
279 static int cups_get_dests(const char *filename
, const char *match_name
,
280 const char *match_inst
, int user_default_set
,
281 int num_dests
, cups_dest_t
**dests
);
282 static char *cups_make_string(ipp_attribute_t
*attr
, char *buffer
,
287 * 'cupsAddDest()' - Add a destination to the list of destinations.
289 * This function cannot be used to add a new class or printer queue,
290 * it only adds a new container of saved options for the named
291 * destination or instance.
293 * If the named destination already exists, the destination list is
294 * returned unchanged. Adding a new instance of a destination creates
295 * a copy of that destination's options.
297 * Use the @link cupsSaveDests@ function to save the updated list of
298 * destinations to the user's lpoptions file.
301 int /* O - New number of destinations */
302 cupsAddDest(const char *name
, /* I - Destination name */
303 const char *instance
, /* I - Instance name or @code NULL@ for none/primary */
304 int num_dests
, /* I - Number of destinations */
305 cups_dest_t
**dests
) /* IO - Destinations */
307 int i
; /* Looping var */
308 cups_dest_t
*dest
; /* Destination pointer */
309 cups_dest_t
*parent
= NULL
; /* Parent destination */
310 cups_option_t
*doption
, /* Current destination option */
311 *poption
; /* Current parent option */
317 if (!cupsGetDest(name
, instance
, num_dests
, *dests
))
319 if (instance
&& !cupsGetDest(name
, NULL
, num_dests
, *dests
))
322 dest
= cups_add_dest(name
, instance
, &num_dests
, dests
);
325 * Find the base dest again now the array has been realloc'd.
328 parent
= cupsGetDest(name
, NULL
, num_dests
, *dests
);
330 if (instance
&& parent
&& parent
->num_options
> 0)
333 * Copy options from parent...
336 dest
->options
= calloc(sizeof(cups_option_t
), parent
->num_options
);
340 dest
->num_options
= parent
->num_options
;
342 for (i
= dest
->num_options
, doption
= dest
->options
,
343 poption
= parent
->options
;
345 i
--, doption
++, poption
++)
347 doption
->name
= _cupsStrRetain(poption
->name
);
348 doption
->value
= _cupsStrRetain(poption
->value
);
360 * '_cupsAppleCopyDefaultPaperID()' - Get the default paper ID.
363 CFStringRef
/* O - Default paper ID */
364 _cupsAppleCopyDefaultPaperID(void)
366 return (CFPreferencesCopyAppValue(kDefaultPaperIDKey
,
367 kCUPSPrintingPrefs
));
372 * '_cupsAppleCopyDefaultPrinter()' - Get the default printer at this location.
375 CFStringRef
/* O - Default printer name */
376 _cupsAppleCopyDefaultPrinter(void)
378 CFStringRef network
; /* Network location */
379 CFArrayRef locations
; /* Location array */
380 CFStringRef locprinter
; /* Current printer */
384 * Use location-based defaults only if "use last printer" is selected in the
385 * system preferences...
388 if (!_cupsAppleGetUseLastPrinter())
390 DEBUG_puts("1_cupsAppleCopyDefaultPrinter: Not using last printer as "
396 * Get the current location...
399 if ((network
= appleCopyNetwork()) == NULL
)
401 DEBUG_puts("1_cupsAppleCopyDefaultPrinter: Unable to get current "
407 * Lookup the network in the preferences...
410 if ((locations
= appleCopyLocations()) == NULL
)
413 * Missing or bad location array, so no location-based default...
416 DEBUG_puts("1_cupsAppleCopyDefaultPrinter: Missing or bad last used "
424 DEBUG_printf(("1_cupsAppleCopyDefaultPrinter: Got locations, %d entries.",
425 (int)CFArrayGetCount(locations
)));
427 if ((locprinter
= appleGetPrinter(locations
, network
, NULL
)) != NULL
)
428 CFRetain(locprinter
);
431 CFRelease(locations
);
438 * '_cupsAppleGetUseLastPrinter()' - Get whether to use the last used printer.
441 int /* O - 1 to use last printer, 0 otherwise */
442 _cupsAppleGetUseLastPrinter(void)
444 Boolean uselast
, /* Use last printer preference value */
445 uselast_set
; /* Valid is set? */
448 if (getenv("CUPS_DISABLE_APPLE_DEFAULT"))
451 uselast
= CFPreferencesGetAppBooleanValue(kUseLastPrinter
,
462 * '_cupsAppleSetDefaultPaperID()' - Set the default paper id.
466 _cupsAppleSetDefaultPaperID(
467 CFStringRef name
) /* I - New paper ID */
469 CFPreferencesSetAppValue(kDefaultPaperIDKey
, name
, kCUPSPrintingPrefs
);
470 CFPreferencesAppSynchronize(kCUPSPrintingPrefs
);
471 notify_post("com.apple.printerPrefsChange");
476 * '_cupsAppleSetDefaultPrinter()' - Set the default printer for this location.
480 _cupsAppleSetDefaultPrinter(
481 CFStringRef name
) /* I - Default printer/class name */
483 CFStringRef network
; /* Current network */
484 CFArrayRef locations
; /* Old locations array */
485 CFIndex locindex
; /* Index in locations array */
486 CFStringRef locprinter
; /* Current printer */
487 CFMutableArrayRef newlocations
; /* New locations array */
488 CFMutableDictionaryRef newlocation
; /* New location */
492 * Get the current location...
495 if ((network
= appleCopyNetwork()) == NULL
)
497 DEBUG_puts("1_cupsAppleSetDefaultPrinter: Unable to get current network...");
502 * Lookup the network in the preferences...
505 if ((locations
= appleCopyLocations()) != NULL
)
506 locprinter
= appleGetPrinter(locations
, network
, &locindex
);
513 if (!locprinter
|| CFStringCompare(locprinter
, name
, 0) != kCFCompareEqualTo
)
516 * Need to change the locations array...
521 newlocations
= CFArrayCreateMutableCopy(kCFAllocatorDefault
, 0,
525 CFArrayRemoveValueAtIndex(newlocations
, locindex
);
528 newlocations
= CFArrayCreateMutable(kCFAllocatorDefault
, 0,
529 &kCFTypeArrayCallBacks
);
531 newlocation
= CFDictionaryCreateMutable(kCFAllocatorDefault
, 0,
532 &kCFTypeDictionaryKeyCallBacks
,
533 &kCFTypeDictionaryValueCallBacks
);
535 if (newlocation
&& newlocations
)
538 * Put the new location at the front of the array...
541 CFDictionaryAddValue(newlocation
, kLocationNetworkKey
, network
);
542 CFDictionaryAddValue(newlocation
, kLocationPrinterIDKey
, name
);
543 CFArrayInsertValueAtIndex(newlocations
, 0, newlocation
);
546 * Limit the number of locations to 10...
549 while (CFArrayGetCount(newlocations
) > 10)
550 CFArrayRemoveValueAtIndex(newlocations
, 10);
553 * Push the changes out...
556 CFPreferencesSetAppValue(kLastUsedPrintersKey
, newlocations
,
558 CFPreferencesAppSynchronize(kCUPSPrintingPrefs
);
559 notify_post("com.apple.printerPrefsChange");
563 CFRelease(newlocations
);
566 CFRelease(newlocation
);
570 CFRelease(locations
);
577 * '_cupsAppleSetUseLastPrinter()' - Set whether to use the last used printer.
581 _cupsAppleSetUseLastPrinter(
582 int uselast
) /* O - 1 to use last printer, 0 otherwise */
584 CFPreferencesSetAppValue(kUseLastPrinter
,
585 uselast
? kCFBooleanTrue
: kCFBooleanFalse
,
587 CFPreferencesAppSynchronize(kCUPSPrintingPrefs
);
588 notify_post("com.apple.printerPrefsChange");
590 #endif /* __APPLE__ */
594 * 'cupsConnectDest()' - Connect to the server for a destination.
596 * Connect to the destination, returning a new http_t connection object and
597 * optionally the resource path to use for the destination. These calls will
598 * block until a connection is made, the timeout expires, the integer pointed
599 * to by "cancel" is non-zero, or the callback function (or block) returns 0,
600 * The caller is responsible for calling httpClose() on the returned object.
602 * @since CUPS 1.6/OS X 10.8@
605 http_t
* /* O - Connection to server or @code NULL@ */
607 cups_dest_t
*dest
, /* I - Destination */
608 unsigned flags
, /* I - Connection flags */
609 int msec
, /* I - Timeout in milliseconds */
610 int *cancel
, /* I - Pointer to "cancel" variable */
611 char *resource
, /* I - Resource buffer */
612 size_t resourcesize
, /* I - Size of resource buffer */
613 cups_dest_cb_t cb
, /* I - Callback function */
614 void *user_data
) /* I - User data pointer */
616 const char *uri
; /* Printer URI */
617 char scheme
[32], /* URI scheme */
618 userpass
[256], /* Username and password (unused) */
619 hostname
[256], /* Hostname */
620 tempresource
[1024]; /* Temporary resource buffer */
621 int port
; /* Port number */
622 char portstr
[16]; /* Port number string */
623 http_encryption_t encryption
; /* Encryption to use */
624 http_addrlist_t
*addrlist
; /* Address list for server */
625 http_t
*http
; /* Connection to server */
629 * Range check input...
637 _cupsSetError(IPP_INTERNAL_ERROR
, strerror(EINVAL
), 0);
641 if (!resource
|| resourcesize
< 1)
643 resource
= tempresource
;
644 resourcesize
= sizeof(tempresource
);
648 * Grab the printer URI...
651 if ((uri
= cupsGetOption("printer-uri-supported", dest
->num_options
,
652 dest
->options
)) == NULL
)
654 _cupsSetError(IPP_INTERNAL_ERROR
, strerror(ENOENT
), 0);
657 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_ERROR
,
663 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
664 if (strstr(uri
, "._tcp"))
666 if ((uri
= cups_dnssd_resolve(dest
, uri
, msec
, cancel
, cb
,
670 #endif /* HAVE_DNSSD || HAVE_AVAHI */
672 if (httpSeparateURI(HTTP_URI_CODING_ALL
, uri
, scheme
, sizeof(scheme
),
673 userpass
, sizeof(userpass
), hostname
, sizeof(hostname
),
674 &port
, resource
, resourcesize
) < HTTP_URI_OK
)
676 _cupsSetError(IPP_INTERNAL_ERROR
, _("Bad printer URI."), 1);
679 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_ERROR
,
686 * Lookup the address for the server...
690 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_RESOLVING
,
693 snprintf(portstr
, sizeof(portstr
), "%d", port
);
695 if ((addrlist
= httpAddrGetList(hostname
, AF_UNSPEC
, portstr
)) == NULL
)
698 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_ERROR
,
704 if (cancel
&& *cancel
)
706 httpAddrFreeList(addrlist
);
709 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_CANCELED
,
716 * Create the HTTP object pointing to the server referenced by the URI...
719 if (!strcmp(scheme
, "ipps") || port
== 443)
720 encryption
= HTTP_ENCRYPT_ALWAYS
;
722 encryption
= HTTP_ENCRYPT_IF_REQUESTED
;
724 http
= _httpCreate(hostname
, port
, addrlist
, encryption
, AF_UNSPEC
);
727 * Connect if requested...
730 if (flags
& CUPS_DEST_FLAGS_UNCONNECTED
)
733 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
, dest
);
738 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_CONNECTING
,
741 if (!httpReconnect2(http
, msec
, cancel
) && cb
)
743 if (cancel
&& *cancel
)
745 CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_CONNECTING
, dest
);
747 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_ERROR
,
751 (*cb
)(user_data
, CUPS_DEST_FLAGS_NONE
, dest
);
760 * 'cupsConnectDestBlock()' - Connect to the server for a destination.
762 * Connect to the destination, returning a new http_t connection object and
763 * optionally the resource path to use for the destination. These calls will
764 * block until a connection is made, the timeout expires, the integer pointed
765 * to by "cancel" is non-zero, or the callback function (or block) returns 0,
766 * The caller is responsible for calling httpClose() on the returned object.
768 * @since CUPS 1.6/OS X 10.8@
771 http_t
* /* O - Connection to server or @code NULL@ */
772 cupsConnectDestBlock(
773 cups_dest_t
*dest
, /* I - Destination */
774 unsigned flags
, /* I - Connection flags */
775 int msec
, /* I - Timeout in milliseconds */
776 int *cancel
, /* I - Pointer to "cancel" variable */
777 char *resource
, /* I - Resource buffer */
778 size_t resourcesize
, /* I - Size of resource buffer */
779 cups_dest_block_t block
) /* I - Callback block */
781 return (cupsConnectDest(dest
, flags
, msec
, cancel
, resource
, resourcesize
,
782 (cups_dest_cb_t
)cups_block_cb
, (void *)block
));
784 #endif /* __BLOCKS__ */
788 * 'cupsCopyDest()' - Copy a destination.
790 * Make a copy of the destination to an array of destinations (or just a single
791 * copy) - for use with the cupsEnumDests* functions. The caller is responsible
792 * for calling cupsFreeDests() on the returned object(s).
794 * @since CUPS 1.6/OS X 10.8@
798 cupsCopyDest(cups_dest_t
*dest
,
802 int i
; /* Looping var */
803 cups_dest_t
*new_dest
; /* New destination pointer */
804 cups_option_t
*new_option
, /* Current destination option */
805 *option
; /* Current parent option */
809 * Range check input...
812 if (!dest
|| num_dests
< 0 || !dests
)
816 * See if the destination already exists...
819 if ((new_dest
= cupsGetDest(dest
->name
, dest
->instance
, num_dests
,
823 * Protect against copying destination to itself...
826 if (new_dest
== dest
)
830 * Otherwise, free the options...
833 cupsFreeOptions(new_dest
->num_options
, new_dest
->options
);
835 new_dest
->num_options
= 0;
836 new_dest
->options
= NULL
;
839 new_dest
= cups_add_dest(dest
->name
, dest
->instance
, &num_dests
, dests
);
843 if ((new_dest
->options
= calloc(sizeof(cups_option_t
),
844 dest
->num_options
)) == NULL
)
845 return (cupsRemoveDest(dest
->name
, dest
->instance
, num_dests
, dests
));
847 new_dest
->num_options
= dest
->num_options
;
849 for (i
= dest
->num_options
, option
= dest
->options
,
850 new_option
= new_dest
->options
;
852 i
--, option
++, new_option
++)
854 new_option
->name
= _cupsStrRetain(option
->name
);
855 new_option
->value
= _cupsStrRetain(option
->value
);
864 * 'cupsEnumDests()' - Enumerate available destinations with a callback function.
866 * Destinations are enumerated from one or more sources. The callback function
867 * receives the @code user_data@ pointer, destination name, instance, number of
868 * options, and options which can be used as input to the @link cupsAddDest@
869 * function. The function must return 1 to continue enumeration or 0 to stop.
871 * Enumeration happens on the current thread and does not return until all
872 * destinations have been enumerated or the callback function returns 0.
874 * @since CUPS 1.6/OS X 10.8@
877 int /* O - 1 on success, 0 on failure */
879 unsigned flags
, /* I - Enumeration flags */
880 int msec
, /* I - Timeout in milliseconds,
881 * -1 for indefinite */
882 int *cancel
, /* I - Pointer to "cancel" variable */
883 cups_ptype_t type
, /* I - Printer type bits */
884 cups_ptype_t mask
, /* I - Mask for printer type bits */
885 cups_dest_cb_t cb
, /* I - Callback function */
886 void *user_data
) /* I - User data */
888 int i
, /* Looping var */
889 num_dests
; /* Number of destinations */
890 cups_dest_t
*dests
= NULL
, /* Destinations */
891 *dest
; /* Current destination */
892 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
893 int count
, /* Number of queries started */
894 remaining
; /* Remainder of timeout */
895 _cups_dnssd_data_t data
; /* Data for callback */
896 _cups_dnssd_device_t
*device
; /* Current device */
898 int nfds
, /* Number of files responded */
899 main_fd
; /* File descriptor for lookups */
900 DNSServiceRef ipp_ref
, /* IPP browser */
901 local_ipp_ref
; /* Local IPP browser */
903 DNSServiceRef ipps_ref
, /* IPPS browser */
904 local_ipps_ref
; /* Local IPPS browser */
905 # endif /* HAVE_SSL */
907 struct pollfd pfd
; /* Polling data */
909 fd_set input
; /* Input set for select() */
910 struct timeval timeout
; /* Timeout for select() */
911 # endif /* HAVE_POLL */
912 # else /* HAVE_AVAHI */
913 int error
; /* Error value */
914 AvahiServiceBrowser
*ipp_ref
; /* IPP browser */
916 AvahiServiceBrowser
*ipps_ref
; /* IPPS browser */
917 # endif /* HAVE_SSL */
918 # endif /* HAVE_DNSSD */
919 #endif /* HAVE_DNSSD || HAVE_AVAHI */
922 * Range check input...
931 * Get the list of local printers and pass them to the callback function...
934 num_dests
= _cupsGetDests(CUPS_HTTP_DEFAULT
, CUPS_GET_PRINTERS
, NULL
, &dests
,
937 for (i
= num_dests
, dest
= dests
;
938 i
> 0 && (!cancel
|| !*cancel
);
940 if (!(*cb
)(user_data
, i
> 1 ? CUPS_DEST_FLAGS_MORE
: CUPS_DEST_FLAGS_NONE
,
944 cupsFreeDests(num_dests
, dests
);
946 if (i
> 0 || msec
== 0)
949 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
951 * Get Bonjour-shared printers...
956 data
.devices
= cupsArrayNew3((cups_array_func_t
)cups_dnssd_compare_devices
,
958 (cups_afree_func_t
)cups_dnssd_free_device
);
961 if (DNSServiceCreateConnection(&data
.main_ref
) != kDNSServiceErr_NoError
)
964 main_fd
= DNSServiceRefSockFD(data
.main_ref
);
966 ipp_ref
= data
.main_ref
;
967 DNSServiceBrowse(&ipp_ref
, kDNSServiceFlagsShareConnection
, 0,
969 (DNSServiceBrowseReply
)cups_dnssd_browse_cb
, &data
);
971 local_ipp_ref
= data
.main_ref
;
972 DNSServiceBrowse(&local_ipp_ref
, kDNSServiceFlagsShareConnection
,
973 kDNSServiceInterfaceIndexLocalOnly
,
975 (DNSServiceBrowseReply
)cups_dnssd_local_cb
, &data
);
978 ipps_ref
= data
.main_ref
;
979 DNSServiceBrowse(&ipps_ref
, kDNSServiceFlagsShareConnection
, 0,
981 (DNSServiceBrowseReply
)cups_dnssd_browse_cb
, &data
);
983 local_ipps_ref
= data
.main_ref
;
984 DNSServiceBrowse(&local_ipps_ref
, kDNSServiceFlagsShareConnection
,
985 kDNSServiceInterfaceIndexLocalOnly
,
987 (DNSServiceBrowseReply
)cups_dnssd_local_cb
, &data
);
988 # endif /* HAVE_SSL */
990 # else /* HAVE_AVAHI */
991 if ((data
.simple_poll
= avahi_simple_poll_new()) == NULL
)
993 DEBUG_puts("cupsEnumDests: Unable to create Avahi simple poll object.");
997 avahi_simple_poll_set_func(data
.simple_poll
, cups_dnssd_poll_cb
, &data
);
999 data
.client
= avahi_client_new(avahi_simple_poll_get(data
.simple_poll
),
1000 0, cups_dnssd_client_cb
, &data
,
1004 DEBUG_puts("cupsEnumDests: Unable to create Avahi client.");
1005 avahi_simple_poll_free(data
.simple_poll
);
1009 ipp_ref
= avahi_service_browser_new(data
.client
, AVAHI_IF_UNSPEC
,
1010 AVAHI_PROTO_UNSPEC
, "_ipp._tcp", NULL
,
1011 0, cups_dnssd_browse_cb
, &data
);
1013 ipps_ref
= avahi_service_browser_new(data
.client
, AVAHI_IF_UNSPEC
,
1014 AVAHI_PROTO_UNSPEC
, "_ipps._tcp", NULL
,
1015 0, cups_dnssd_browse_cb
, &data
);
1016 # endif /* HAVE_SSL */
1017 # endif /* HAVE_DNSSD */
1020 remaining
= INT_MAX
;
1024 while (remaining
> 0 && (!cancel
|| !*cancel
))
1027 * Check for input...
1033 pfd
.events
= POLLIN
;
1035 nfds
= poll(&pfd
, 1, remaining
> 250 ? 250 : remaining
);
1039 FD_SET(main_fd
, &input
);
1042 timeout
.tv_usec
= remaining
> 250 ? 250000 : remaining
* 1000;
1044 nfds
= select(main_fd
+ 1, &input
, NULL
, NULL
, &timeout
);
1045 # endif /* HAVE_POLL */
1048 DNSServiceProcessResult(data
.main_ref
);
1052 # else /* HAVE_AVAHI */
1055 if ((error
= avahi_simple_poll_iterate(data
.simple_poll
, 250)) > 0)
1058 * We've been told to exit the loop. Perhaps the connection to
1067 # endif /* HAVE_DNSSD */
1069 for (device
= (_cups_dnssd_device_t
*)cupsArrayFirst(data
.devices
),
1072 device
= (_cups_dnssd_device_t
*)cupsArrayNext(data
.devices
))
1077 if (!device
->ref
&& device
->state
== _CUPS_DNSSD_NEW
)
1079 DEBUG_printf(("1cupsEnumDests: Querying '%s'.", device
->fullName
));
1082 device
->ref
= data
.main_ref
;
1084 if (DNSServiceQueryRecord(&(device
->ref
),
1085 kDNSServiceFlagsShareConnection
,
1086 0, device
->fullName
,
1087 kDNSServiceType_TXT
,
1088 kDNSServiceClass_IN
,
1089 (DNSServiceQueryRecordReply
)cups_dnssd_query_cb
,
1090 &data
) == kDNSServiceErr_NoError
)
1097 device
->state
= _CUPS_DNSSD_ERROR
;
1099 DEBUG_puts("1cupsEnumDests: Query failed.");
1102 # else /* HAVE_AVAHI */
1103 if ((device
->ref
= avahi_record_browser_new(data
.client
,
1110 cups_dnssd_query_cb
,
1117 device
->state
= _CUPS_DNSSD_ERROR
;
1119 DEBUG_printf(("1cupsEnumDests: Query failed: %s",
1120 avahi_strerror(avahi_client_errno(data
.client
))));
1122 # endif /* HAVE_DNSSD */
1124 else if (device
->ref
&& device
->state
== _CUPS_DNSSD_PENDING
)
1126 if ((device
->type
& mask
) == type
)
1128 if (!(*cb
)(user_data
, CUPS_DEST_FLAGS_NONE
, &device
->dest
))
1135 device
->state
= _CUPS_DNSSD_ACTIVE
;
1140 cupsArrayDelete(data
.devices
);
1143 DNSServiceRefDeallocate(ipp_ref
);
1144 DNSServiceRefDeallocate(local_ipp_ref
);
1147 DNSServiceRefDeallocate(ipp_ref
);
1148 DNSServiceRefDeallocate(local_ipp_ref
);
1149 # endif /* HAVE_SSL */
1151 DNSServiceRefDeallocate(data
.main_ref
);
1153 # else /* HAVE_AVAHI */
1154 avahi_service_browser_free(ipp_ref
);
1156 avahi_service_browser_free(ipps_ref
);
1157 # endif /* HAVE_SSL */
1159 avahi_client_free(data
.client
);
1160 avahi_simple_poll_free(data
.simple_poll
);
1161 # endif /* HAVE_DNSSD */
1162 #endif /* HAVE_DNSSD || HAVE_DNSSD */
1170 * 'cupsEnumDestsBlock()' - Enumerate available destinations with a block.
1172 * Destinations are enumerated from one or more sources. The block receives the
1173 * destination name, instance, number of options, and options which can be used
1174 * as input to the @link cupsAddDest@ function. The block must return 1 to
1175 * continue enumeration or 0 to stop.
1177 * Enumeration happens on the current thread and does not return until all
1178 * destinations have been enumerated or the block returns 0.
1180 * @since CUPS 1.6/OS X 10.8@
1183 int /* O - 1 on success, 0 on failure */
1185 unsigned flags
, /* I - Enumeration flags */
1186 int timeout
, /* I - Timeout in milliseconds, 0 for indefinite */
1187 int *cancel
, /* I - Pointer to "cancel" variable */
1188 cups_ptype_t type
, /* I - Printer type bits */
1189 cups_ptype_t mask
, /* I - Mask for printer type bits */
1190 cups_dest_block_t block
) /* I - Block */
1192 return (cupsEnumDests(flags
, timeout
, cancel
, type
, mask
,
1193 (cups_dest_cb_t
)cups_block_cb
, (void *)block
));
1195 # endif /* __BLOCKS__ */
1199 * 'cupsFreeDests()' - Free the memory used by the list of destinations.
1203 cupsFreeDests(int num_dests
, /* I - Number of destinations */
1204 cups_dest_t
*dests
) /* I - Destinations */
1206 int i
; /* Looping var */
1207 cups_dest_t
*dest
; /* Current destination */
1210 if (num_dests
== 0 || dests
== NULL
)
1213 for (i
= num_dests
, dest
= dests
; i
> 0; i
--, dest
++)
1215 _cupsStrFree(dest
->name
);
1216 _cupsStrFree(dest
->instance
);
1218 cupsFreeOptions(dest
->num_options
, dest
->options
);
1226 * 'cupsGetDest()' - Get the named destination from the list.
1228 * Use the @link cupsGetDests@ or @link cupsGetDests2@ functions to get a
1229 * list of supported destinations for the current user.
1232 cups_dest_t
* /* O - Destination pointer or @code NULL@ */
1233 cupsGetDest(const char *name
, /* I - Destination name or @code NULL@ for the default destination */
1234 const char *instance
, /* I - Instance name or @code NULL@ */
1235 int num_dests
, /* I - Number of destinations */
1236 cups_dest_t
*dests
) /* I - Destinations */
1238 int diff
, /* Result of comparison */
1239 match
; /* Matching index */
1242 if (num_dests
<= 0 || !dests
)
1248 * NULL name for default printer.
1251 while (num_dests
> 0)
1253 if (dests
->is_default
)
1263 * Lookup name and optionally the instance...
1266 match
= cups_find_dest(name
, instance
, num_dests
, dests
, -1, &diff
);
1269 return (dests
+ match
);
1277 * '_cupsGetDestResource()' - Get the resource path and URI for a destination.
1280 const char * /* O - Printer URI */
1281 _cupsGetDestResource(
1282 cups_dest_t
*dest
, /* I - Destination */
1283 char *resource
, /* I - Resource buffer */
1284 size_t resourcesize
) /* I - Size of resource buffer */
1286 const char *uri
; /* Printer URI */
1287 char scheme
[32], /* URI scheme */
1288 userpass
[256], /* Username and password (unused) */
1289 hostname
[256]; /* Hostname */
1290 int port
; /* Port number */
1294 * Range check input...
1297 if (!dest
|| !resource
|| resourcesize
< 1)
1302 _cupsSetError(IPP_INTERNAL_ERROR
, strerror(EINVAL
), 0);
1307 * Grab the printer URI...
1310 if ((uri
= cupsGetOption("printer-uri-supported", dest
->num_options
,
1311 dest
->options
)) == NULL
)
1316 _cupsSetError(IPP_INTERNAL_ERROR
, strerror(ENOENT
), 0);
1322 if (strstr(uri
, "._tcp"))
1324 if ((uri
= cups_dnssd_resolve(dest
, uri
, 5000, NULL
, NULL
, NULL
)) == NULL
)
1327 #endif /* HAVE_DNSSD */
1329 if (httpSeparateURI(HTTP_URI_CODING_ALL
, uri
, scheme
, sizeof(scheme
),
1330 userpass
, sizeof(userpass
), hostname
, sizeof(hostname
),
1331 &port
, resource
, resourcesize
) < HTTP_URI_OK
)
1333 _cupsSetError(IPP_INTERNAL_ERROR
, _("Bad printer URI."), 1);
1343 * '_cupsGetDests()' - Get destinations from a server.
1345 * "op" is CUPS_GET_PRINTERS to get a full list, CUPS_GET_DEFAULT to get the
1346 * system-wide default printer, or IPP_GET_PRINTER_ATTRIBUTES for a known
1349 * "name" is the name of an existing printer and is only used when "op" is
1350 * IPP_GET_PRINTER_ATTRIBUTES.
1352 * "dest" is initialized to point to the array of destinations.
1354 * 0 is returned if there are no printers, no default printer, or the named
1355 * printer does not exist, respectively.
1357 * Free the memory used by the destination array using the @link cupsFreeDests@
1360 * Note: On OS X this function also gets the default paper from the system
1361 * preferences (~/L/P/org.cups.PrintingPrefs.plist) and includes it in the
1362 * options array for each destination that supports it.
1365 int /* O - Number of destinations */
1366 _cupsGetDests(http_t
*http
, /* I - Connection to server or
1367 * @code CUPS_HTTP_DEFAULT@ */
1368 ipp_op_t op
, /* I - IPP operation */
1369 const char *name
, /* I - Name of destination */
1370 cups_dest_t
**dests
, /* IO - Destinations */
1371 cups_ptype_t type
, /* I - Printer type bits */
1372 cups_ptype_t mask
) /* I - Printer type mask */
1374 int num_dests
= 0; /* Number of destinations */
1375 cups_dest_t
*dest
; /* Current destination */
1376 ipp_t
*request
, /* IPP Request */
1377 *response
; /* IPP Response */
1378 ipp_attribute_t
*attr
; /* Current attribute */
1379 const char *printer_name
; /* printer-name attribute */
1380 char uri
[1024]; /* printer-uri value */
1381 int num_options
; /* Number of options */
1382 cups_option_t
*options
; /* Options */
1384 char media_default
[41]; /* Default paper size */
1385 #endif /* __APPLE__ */
1386 char optname
[1024], /* Option name */
1387 value
[2048], /* Option value */
1388 *ptr
; /* Pointer into name/value */
1389 static const char * const pattrs
[] = /* Attributes we're interested in */
1391 "auth-info-required",
1393 "job-sheets-default",
1394 "marker-change-time",
1396 "marker-high-levels",
1398 "marker-low-levels",
1404 #endif /* __APPLE__ */
1408 "printer-is-accepting-jobs",
1409 "printer-is-shared",
1411 "printer-make-and-model",
1414 "printer-state-change-time",
1415 "printer-state-reasons",
1417 "printer-uri-supported"
1423 * Get the default paper size...
1426 appleGetPaperSize(media_default
, sizeof(media_default
));
1427 #endif /* __APPLE__ */
1430 * Build a CUPS_GET_PRINTERS or IPP_GET_PRINTER_ATTRIBUTES request, which
1431 * require the following attributes:
1433 * attributes-charset
1434 * attributes-natural-language
1435 * requesting-user-name
1436 * printer-uri [for IPP_GET_PRINTER_ATTRIBUTES]
1439 request
= ippNewRequest(op
);
1441 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
1442 "requested-attributes", sizeof(pattrs
) / sizeof(pattrs
[0]),
1445 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
1446 "requesting-user-name", NULL
, cupsUser());
1448 if (name
&& op
!= CUPS_GET_DEFAULT
)
1450 httpAssembleURIf(HTTP_URI_CODING_ALL
, uri
, sizeof(uri
), "ipp", NULL
,
1451 "localhost", ippPort(), "/printers/%s", name
);
1452 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri", NULL
,
1457 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_ENUM
, "printer-type",
1459 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_ENUM
, "printer-type-mask",
1464 * Do the request and get back a response...
1467 if ((response
= cupsDoRequest(http
, request
, "/")) != NULL
)
1469 for (attr
= response
->attrs
; attr
!= NULL
; attr
= attr
->next
)
1472 * Skip leading attributes until we hit a printer...
1475 while (attr
!= NULL
&& attr
->group_tag
!= IPP_TAG_PRINTER
)
1482 * Pull the needed attributes from this printer...
1485 printer_name
= NULL
;
1489 for (; attr
&& attr
->group_tag
== IPP_TAG_PRINTER
; attr
= attr
->next
)
1491 if (attr
->value_tag
!= IPP_TAG_INTEGER
&&
1492 attr
->value_tag
!= IPP_TAG_ENUM
&&
1493 attr
->value_tag
!= IPP_TAG_BOOLEAN
&&
1494 attr
->value_tag
!= IPP_TAG_TEXT
&&
1495 attr
->value_tag
!= IPP_TAG_TEXTLANG
&&
1496 attr
->value_tag
!= IPP_TAG_NAME
&&
1497 attr
->value_tag
!= IPP_TAG_NAMELANG
&&
1498 attr
->value_tag
!= IPP_TAG_KEYWORD
&&
1499 attr
->value_tag
!= IPP_TAG_RANGE
&&
1500 attr
->value_tag
!= IPP_TAG_URI
)
1503 if (!strcmp(attr
->name
, "auth-info-required") ||
1504 !strcmp(attr
->name
, "device-uri") ||
1505 !strcmp(attr
->name
, "marker-change-time") ||
1506 !strcmp(attr
->name
, "marker-colors") ||
1507 !strcmp(attr
->name
, "marker-high-levels") ||
1508 !strcmp(attr
->name
, "marker-levels") ||
1509 !strcmp(attr
->name
, "marker-low-levels") ||
1510 !strcmp(attr
->name
, "marker-message") ||
1511 !strcmp(attr
->name
, "marker-names") ||
1512 !strcmp(attr
->name
, "marker-types") ||
1513 !strcmp(attr
->name
, "printer-commands") ||
1514 !strcmp(attr
->name
, "printer-info") ||
1515 !strcmp(attr
->name
, "printer-is-shared") ||
1516 !strcmp(attr
->name
, "printer-make-and-model") ||
1517 !strcmp(attr
->name
, "printer-state") ||
1518 !strcmp(attr
->name
, "printer-state-change-time") ||
1519 !strcmp(attr
->name
, "printer-type") ||
1520 !strcmp(attr
->name
, "printer-is-accepting-jobs") ||
1521 !strcmp(attr
->name
, "printer-location") ||
1522 !strcmp(attr
->name
, "printer-state-reasons") ||
1523 !strcmp(attr
->name
, "printer-uri-supported"))
1526 * Add a printer description attribute...
1529 num_options
= cupsAddOption(attr
->name
,
1530 cups_make_string(attr
, value
,
1532 num_options
, &options
);
1535 else if (!strcmp(attr
->name
, "media-supported"))
1538 * See if we can set a default media size...
1541 int i
; /* Looping var */
1543 for (i
= 0; i
< attr
->num_values
; i
++)
1544 if (!_cups_strcasecmp(media_default
, attr
->values
[i
].string
.text
))
1546 num_options
= cupsAddOption("media", media_default
, num_options
,
1551 #endif /* __APPLE__ */
1552 else if (!strcmp(attr
->name
, "printer-name") &&
1553 attr
->value_tag
== IPP_TAG_NAME
)
1554 printer_name
= attr
->values
[0].string
.text
;
1555 else if (strncmp(attr
->name
, "notify-", 7) &&
1556 (attr
->value_tag
== IPP_TAG_BOOLEAN
||
1557 attr
->value_tag
== IPP_TAG_ENUM
||
1558 attr
->value_tag
== IPP_TAG_INTEGER
||
1559 attr
->value_tag
== IPP_TAG_KEYWORD
||
1560 attr
->value_tag
== IPP_TAG_NAME
||
1561 attr
->value_tag
== IPP_TAG_RANGE
) &&
1562 (ptr
= strstr(attr
->name
, "-default")) != NULL
)
1565 * Add a default option...
1568 strlcpy(optname
, attr
->name
, sizeof(optname
));
1569 optname
[ptr
- attr
->name
] = '\0';
1571 if (_cups_strcasecmp(optname
, "media") ||
1572 !cupsGetOption("media", num_options
, options
))
1573 num_options
= cupsAddOption(optname
,
1574 cups_make_string(attr
, value
,
1576 num_options
, &options
);
1581 * See if we have everything needed...
1586 cupsFreeOptions(num_options
, options
);
1594 if ((dest
= cups_add_dest(printer_name
, NULL
, &num_dests
, dests
)) != NULL
)
1596 dest
->num_options
= num_options
;
1597 dest
->options
= options
;
1600 cupsFreeOptions(num_options
, options
);
1606 ippDelete(response
);
1610 * Return the count...
1618 * 'cupsGetDests()' - Get the list of destinations from the default server.
1620 * Starting with CUPS 1.2, the returned list of destinations include the
1621 * printer-info, printer-is-accepting-jobs, printer-is-shared,
1622 * printer-make-and-model, printer-state, printer-state-change-time,
1623 * printer-state-reasons, and printer-type attributes as options. CUPS 1.4
1624 * adds the marker-change-time, marker-colors, marker-high-levels,
1625 * marker-levels, marker-low-levels, marker-message, marker-names,
1626 * marker-types, and printer-commands attributes as well.
1628 * Use the @link cupsFreeDests@ function to free the destination list and
1629 * the @link cupsGetDest@ function to find a particular destination.
1632 int /* O - Number of destinations */
1633 cupsGetDests(cups_dest_t
**dests
) /* O - Destinations */
1635 return (cupsGetDests2(CUPS_HTTP_DEFAULT
, dests
));
1640 * 'cupsGetDests2()' - Get the list of destinations from the specified server.
1642 * Starting with CUPS 1.2, the returned list of destinations include the
1643 * printer-info, printer-is-accepting-jobs, printer-is-shared,
1644 * printer-make-and-model, printer-state, printer-state-change-time,
1645 * printer-state-reasons, and printer-type attributes as options. CUPS 1.4
1646 * adds the marker-change-time, marker-colors, marker-high-levels,
1647 * marker-levels, marker-low-levels, marker-message, marker-names,
1648 * marker-types, and printer-commands attributes as well.
1650 * Use the @link cupsFreeDests@ function to free the destination list and
1651 * the @link cupsGetDest@ function to find a particular destination.
1653 * @since CUPS 1.1.21/OS X 10.4@
1656 int /* O - Number of destinations */
1657 cupsGetDests2(http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
1658 cups_dest_t
**dests
) /* O - Destinations */
1660 int i
; /* Looping var */
1661 int num_dests
; /* Number of destinations */
1662 cups_dest_t
*dest
; /* Destination pointer */
1663 const char *home
; /* HOME environment variable */
1664 char filename
[1024]; /* Local ~/.cups/lpoptions file */
1665 const char *defprinter
; /* Default printer */
1666 char name
[1024], /* Copy of printer name */
1667 *instance
, /* Pointer to instance name */
1668 *user_default
; /* User default printer */
1669 int num_reals
; /* Number of real queues */
1670 cups_dest_t
*reals
; /* Real queues */
1671 _cups_globals_t
*cg
= _cupsGlobals(); /* Pointer to library globals */
1675 * Range check the input...
1680 _cupsSetError(IPP_INTERNAL_ERROR
, _("Bad NULL dests pointer"), 1);
1685 * Grab the printers and classes...
1688 *dests
= (cups_dest_t
*)0;
1689 num_dests
= _cupsGetDests(http
, CUPS_GET_PRINTERS
, NULL
, dests
, 0, 0);
1691 if (cupsLastError() >= IPP_REDIRECTION_OTHER_SITE
)
1693 cupsFreeDests(num_dests
, *dests
);
1694 *dests
= (cups_dest_t
*)0;
1699 * Make a copy of the "real" queues for a later sanity check...
1704 num_reals
= num_dests
;
1705 reals
= calloc(num_reals
, sizeof(cups_dest_t
));
1708 memcpy(reals
, *dests
, num_reals
* sizeof(cups_dest_t
));
1719 * Grab the default destination...
1722 if ((user_default
= _cupsUserDefault(name
, sizeof(name
))) != NULL
)
1724 else if ((defprinter
= cupsGetDefault2(http
)) != NULL
)
1726 strlcpy(name
, defprinter
, sizeof(name
));
1733 * Separate printer and instance name...
1736 if ((instance
= strchr(name
, '/')) != NULL
)
1740 * Lookup the printer and instance and make it the default...
1743 if ((dest
= cupsGetDest(name
, instance
, num_dests
, *dests
)) != NULL
)
1744 dest
->is_default
= 1;
1750 * Load the /etc/cups/lpoptions and ~/.cups/lpoptions files...
1753 snprintf(filename
, sizeof(filename
), "%s/lpoptions", cg
->cups_serverroot
);
1754 num_dests
= cups_get_dests(filename
, NULL
, NULL
, user_default
!= NULL
,
1757 if ((home
= getenv("HOME")) != NULL
)
1759 snprintf(filename
, sizeof(filename
), "%s/.cups/lpoptions", home
);
1761 num_dests
= cups_get_dests(filename
, NULL
, NULL
, user_default
!= NULL
,
1766 * Validate the current default destination - this prevents old
1767 * Default lines in /etc/cups/lpoptions and ~/.cups/lpoptions from
1768 * pointing to a non-existent printer or class...
1774 * See if we have a default printer...
1777 if ((dest
= cupsGetDest(NULL
, NULL
, num_dests
, *dests
)) != NULL
)
1780 * Have a default; see if it is real...
1783 dest
= cupsGetDest(dest
->name
, NULL
, num_reals
, reals
);
1787 * If dest is NULL, then no default (that exists) is set, so we
1788 * need to set a default if one exists...
1791 if (dest
== NULL
&& defprinter
!= NULL
)
1793 for (i
= 0; i
< num_dests
; i
++)
1794 (*dests
)[i
].is_default
= 0;
1796 if ((dest
= cupsGetDest(name
, instance
, num_dests
, *dests
)) != NULL
)
1797 dest
->is_default
= 1;
1808 * Return the number of destinations...
1812 _cupsSetError(IPP_OK
, NULL
, 0);
1819 * 'cupsGetNamedDest()' - Get options for the named destination.
1821 * This function is optimized for retrieving a single destination and should
1822 * be used instead of @link cupsGetDests@ and @link cupsGetDest@ when you either
1823 * know the name of the destination or want to print to the default destination.
1824 * If @code NULL@ is returned, the destination does not exist or there is no
1825 * default destination.
1827 * If "http" is @code CUPS_HTTP_DEFAULT@, the connection to the default print
1828 * server will be used.
1830 * If "name" is @code NULL@, the default printer for the current user will be
1833 * The returned destination must be freed using @link cupsFreeDests@ with a
1834 * "num_dests" value of 1.
1836 * @since CUPS 1.4/OS X 10.6@
1839 cups_dest_t
* /* O - Destination or @code NULL@ */
1840 cupsGetNamedDest(http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
1841 const char *name
, /* I - Destination name or @code NULL@ for the default destination */
1842 const char *instance
) /* I - Instance name or @code NULL@ */
1844 cups_dest_t
*dest
; /* Destination */
1845 char filename
[1024], /* Path to lpoptions */
1846 defname
[256]; /* Default printer name */
1847 const char *home
= getenv("HOME"); /* Home directory */
1848 int set_as_default
= 0; /* Set returned destination as default */
1849 ipp_op_t op
= IPP_GET_PRINTER_ATTRIBUTES
;
1850 /* IPP operation to get server ops */
1851 _cups_globals_t
*cg
= _cupsGlobals(); /* Pointer to library globals */
1855 * If "name" is NULL, find the default destination...
1861 name
= _cupsUserDefault(defname
, sizeof(defname
));
1865 char *ptr
; /* Temporary pointer... */
1867 if ((ptr
= strchr(defname
, '/')) != NULL
)
1878 * No default in the environment, try the user's lpoptions files...
1881 snprintf(filename
, sizeof(filename
), "%s/.cups/lpoptions", home
);
1883 name
= cups_get_default(filename
, defname
, sizeof(defname
), &instance
);
1889 * Still not there? Try the system lpoptions file...
1892 snprintf(filename
, sizeof(filename
), "%s/lpoptions",
1893 cg
->cups_serverroot
);
1894 name
= cups_get_default(filename
, defname
, sizeof(defname
), &instance
);
1900 * No locally-set default destination, ask the server...
1903 op
= CUPS_GET_DEFAULT
;
1908 * Get the printer's attributes...
1911 if (!_cupsGetDests(http
, op
, name
, &dest
, 0, 0))
1913 if (op
== CUPS_GET_DEFAULT
|| (name
&& !set_as_default
))
1917 * The default printer from environment variables or from a
1918 * configuration file does not exist. Find out the real default.
1921 if (!_cupsGetDests(http
, CUPS_GET_DEFAULT
, NULL
, &dest
, 0, 0))
1926 dest
->instance
= _cupsStrAlloc(instance
);
1929 dest
->is_default
= 1;
1932 * Then add local options...
1935 snprintf(filename
, sizeof(filename
), "%s/lpoptions", cg
->cups_serverroot
);
1936 cups_get_dests(filename
, name
, instance
, 1, 1, &dest
);
1940 snprintf(filename
, sizeof(filename
), "%s/.cups/lpoptions", home
);
1942 cups_get_dests(filename
, name
, instance
, 1, 1, &dest
);
1946 * Return the result...
1954 * 'cupsRemoveDest()' - Remove a destination from the destination list.
1956 * Removing a destination/instance does not delete the class or printer
1957 * queue, merely the lpoptions for that destination/instance. Use the
1958 * @link cupsSetDests@ or @link cupsSetDests2@ functions to save the new
1959 * options for the user.
1961 * @since CUPS 1.3/OS X 10.5@
1964 int /* O - New number of destinations */
1965 cupsRemoveDest(const char *name
, /* I - Destination name */
1966 const char *instance
, /* I - Instance name or @code NULL@ */
1967 int num_dests
, /* I - Number of destinations */
1968 cups_dest_t
**dests
) /* IO - Destinations */
1970 int i
; /* Index into destinations */
1971 cups_dest_t
*dest
; /* Pointer to destination */
1975 * Find the destination...
1978 if ((dest
= cupsGetDest(name
, instance
, num_dests
, *dests
)) == NULL
)
1985 _cupsStrFree(dest
->name
);
1986 _cupsStrFree(dest
->instance
);
1987 cupsFreeOptions(dest
->num_options
, dest
->options
);
1990 * Remove the destination from the array...
1998 memmove(dest
, dest
+ 1, (num_dests
- i
) * sizeof(cups_dest_t
));
2005 * 'cupsSetDefaultDest()' - Set the default destination.
2007 * @since CUPS 1.3/OS X 10.5@
2012 const char *name
, /* I - Destination name */
2013 const char *instance
, /* I - Instance name or @code NULL@ */
2014 int num_dests
, /* I - Number of destinations */
2015 cups_dest_t
*dests
) /* I - Destinations */
2017 int i
; /* Looping var */
2018 cups_dest_t
*dest
; /* Current destination */
2022 * Range check input...
2025 if (!name
|| num_dests
<= 0 || !dests
)
2029 * Loop through the array and set the "is_default" flag for the matching
2033 for (i
= num_dests
, dest
= dests
; i
> 0; i
--, dest
++)
2034 dest
->is_default
= !_cups_strcasecmp(name
, dest
->name
) &&
2035 ((!instance
&& !dest
->instance
) ||
2036 (instance
&& dest
->instance
&&
2037 !_cups_strcasecmp(instance
, dest
->instance
)));
2042 * 'cupsSetDests()' - Save the list of destinations for the default server.
2044 * This function saves the destinations to /etc/cups/lpoptions when run
2045 * as root and ~/.cups/lpoptions when run as a normal user.
2049 cupsSetDests(int num_dests
, /* I - Number of destinations */
2050 cups_dest_t
*dests
) /* I - Destinations */
2052 cupsSetDests2(CUPS_HTTP_DEFAULT
, num_dests
, dests
);
2057 * 'cupsSetDests2()' - Save the list of destinations for the specified server.
2059 * This function saves the destinations to /etc/cups/lpoptions when run
2060 * as root and ~/.cups/lpoptions when run as a normal user.
2062 * @since CUPS 1.1.21/OS X 10.4@
2065 int /* O - 0 on success, -1 on error */
2066 cupsSetDests2(http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
2067 int num_dests
, /* I - Number of destinations */
2068 cups_dest_t
*dests
) /* I - Destinations */
2070 int i
, j
; /* Looping vars */
2071 int wrote
; /* Wrote definition? */
2072 cups_dest_t
*dest
; /* Current destination */
2073 cups_option_t
*option
; /* Current option */
2074 _ipp_option_t
*match
; /* Matching attribute for option */
2075 FILE *fp
; /* File pointer */
2077 const char *home
; /* HOME environment variable */
2079 char filename
[1024]; /* lpoptions file */
2080 int num_temps
; /* Number of temporary destinations */
2081 cups_dest_t
*temps
= NULL
, /* Temporary destinations */
2082 *temp
; /* Current temporary dest */
2083 const char *val
; /* Value of temporary option */
2084 _cups_globals_t
*cg
= _cupsGlobals(); /* Pointer to library globals */
2088 * Range check the input...
2091 if (!num_dests
|| !dests
)
2095 * Get the server destinations...
2098 num_temps
= _cupsGetDests(http
, CUPS_GET_PRINTERS
, NULL
, &temps
, 0, 0);
2100 if (cupsLastError() >= IPP_REDIRECTION_OTHER_SITE
)
2102 cupsFreeDests(num_temps
, temps
);
2107 * Figure out which file to write to...
2110 snprintf(filename
, sizeof(filename
), "%s/lpoptions", cg
->cups_serverroot
);
2116 * Merge in server defaults...
2119 num_temps
= cups_get_dests(filename
, NULL
, NULL
, 0, num_temps
, &temps
);
2122 * Point to user defaults...
2125 if ((home
= getenv("HOME")) != NULL
)
2128 * Create ~/.cups subdirectory...
2131 snprintf(filename
, sizeof(filename
), "%s/.cups", home
);
2132 if (access(filename
, 0))
2133 mkdir(filename
, 0700);
2135 snprintf(filename
, sizeof(filename
), "%s/.cups/lpoptions", home
);
2141 * Try to open the file...
2144 if ((fp
= fopen(filename
, "w")) == NULL
)
2146 cupsFreeDests(num_temps
, temps
);
2152 * Set the permissions to 0644 when saving to the /etc/cups/lpoptions
2157 fchmod(fileno(fp
), 0644);
2161 * Write each printer; each line looks like:
2163 * Dest name[/instance] options
2164 * Default name[/instance] options
2167 for (i
= num_dests
, dest
= dests
; i
> 0; i
--, dest
++)
2168 if (dest
->instance
!= NULL
|| dest
->num_options
!= 0 || dest
->is_default
)
2170 if (dest
->is_default
)
2172 fprintf(fp
, "Default %s", dest
->name
);
2174 fprintf(fp
, "/%s", dest
->instance
);
2181 if ((temp
= cupsGetDest(dest
->name
, dest
->instance
, num_temps
, temps
)) == NULL
)
2182 temp
= cupsGetDest(dest
->name
, NULL
, num_temps
, temps
);
2184 for (j
= dest
->num_options
, option
= dest
->options
; j
> 0; j
--, option
++)
2187 * See if this option is a printer attribute; if so, skip it...
2190 if ((match
= _ippFindOption(option
->name
)) != NULL
&&
2191 match
->group_tag
== IPP_TAG_PRINTER
)
2195 * See if the server/global options match these; if so, don't
2200 (val
= cupsGetOption(option
->name
, temp
->num_options
,
2201 temp
->options
)) != NULL
&&
2202 !_cups_strcasecmp(val
, option
->value
))
2206 * Options don't match, write to the file...
2211 fprintf(fp
, "Dest %s", dest
->name
);
2213 fprintf(fp
, "/%s", dest
->instance
);
2217 if (option
->value
[0])
2219 if (strchr(option
->value
, ' ') ||
2220 strchr(option
->value
, '\\') ||
2221 strchr(option
->value
, '\"') ||
2222 strchr(option
->value
, '\''))
2225 * Quote the value...
2228 fprintf(fp
, " %s=\"", option
->name
);
2230 for (val
= option
->value
; *val
; val
++)
2232 if (strchr("\"\'\\", *val
))
2243 * Store the literal value...
2246 fprintf(fp
, " %s=%s", option
->name
, option
->value
);
2250 fprintf(fp
, " %s", option
->name
);
2258 * Free the temporary destinations and close the file...
2261 cupsFreeDests(num_temps
, temps
);
2267 * Set the default printer for this location - this allows command-line
2268 * and GUI applications to share the same default destination...
2271 if ((dest
= cupsGetDest(NULL
, NULL
, num_dests
, dests
)) != NULL
)
2273 CFStringRef name
= CFStringCreateWithCString(kCFAllocatorDefault
,
2275 kCFStringEncodingUTF8
);
2276 /* Default printer name */
2280 _cupsAppleSetDefaultPrinter(name
);
2284 #endif /* __APPLE__ */
2286 #ifdef HAVE_NOTIFY_POST
2288 * Send a notification so that MacOS X applications can know about the
2292 notify_post("com.apple.printerListChange");
2293 #endif /* HAVE_NOTIFY_POST */
2300 * '_cupsUserDefault()' - Get the user default printer from environment
2301 * variables and location information.
2304 char * /* O - Default printer or NULL */
2305 _cupsUserDefault(char *name
, /* I - Name buffer */
2306 size_t namesize
) /* I - Size of name buffer */
2308 const char *env
; /* LPDEST or PRINTER env variable */
2310 CFStringRef locprinter
; /* Last printer as this location */
2311 #endif /* __APPLE__ */
2314 if ((env
= getenv("LPDEST")) == NULL
)
2315 if ((env
= getenv("PRINTER")) != NULL
&& !strcmp(env
, "lp"))
2320 strlcpy(name
, env
, namesize
);
2326 * Use location-based defaults if "use last printer" is selected in the
2327 * system preferences...
2330 if ((locprinter
= _cupsAppleCopyDefaultPrinter()) != NULL
)
2332 CFStringGetCString(locprinter
, name
, namesize
, kCFStringEncodingUTF8
);
2333 CFRelease(locprinter
);
2338 DEBUG_printf(("1_cupsUserDefault: Returning \"%s\".", name
));
2340 return (*name
? name
: NULL
);
2344 * No location-based defaults on this platform...
2349 #endif /* __APPLE__ */
2355 * 'appleCopyLocations()' - Copy the location history array.
2358 static CFArrayRef
/* O - Location array or NULL */
2359 appleCopyLocations(void)
2361 CFArrayRef locations
; /* Location array */
2365 * Look up the location array in the preferences...
2368 if ((locations
= CFPreferencesCopyAppValue(kLastUsedPrintersKey
,
2369 kCUPSPrintingPrefs
)) == NULL
)
2372 if (CFGetTypeID(locations
) != CFArrayGetTypeID())
2374 CFRelease(locations
);
2383 * 'appleCopyNetwork()' - Get the network ID for the current location.
2386 static CFStringRef
/* O - Network ID */
2387 appleCopyNetwork(void)
2389 SCDynamicStoreRef dynamicStore
; /* System configuration data */
2390 CFStringRef key
; /* Current network configuration key */
2391 CFDictionaryRef ip_dict
; /* Network configuration data */
2392 CFStringRef network
= NULL
; /* Current network ID */
2395 if ((dynamicStore
= SCDynamicStoreCreate(NULL
, CFSTR("libcups"), NULL
,
2399 * First use the IPv6 router address, if available, since that will generally
2400 * be a globally-unique link-local address.
2403 if ((key
= SCDynamicStoreKeyCreateNetworkGlobalEntity(
2404 NULL
, kSCDynamicStoreDomainState
, kSCEntNetIPv6
)) != NULL
)
2406 if ((ip_dict
= SCDynamicStoreCopyValue(dynamicStore
, key
)) != NULL
)
2408 if ((network
= CFDictionaryGetValue(ip_dict
,
2409 kSCPropNetIPv6Router
)) != NULL
)
2419 * If that doesn't work, try the IPv4 router address. This isn't as unique
2420 * and will likely be a 10.x.y.z or 192.168.y.z address...
2425 if ((key
= SCDynamicStoreKeyCreateNetworkGlobalEntity(
2426 NULL
, kSCDynamicStoreDomainState
, kSCEntNetIPv4
)) != NULL
)
2428 if ((ip_dict
= SCDynamicStoreCopyValue(dynamicStore
, key
)) != NULL
)
2430 if ((network
= CFDictionaryGetValue(ip_dict
,
2431 kSCPropNetIPv4Router
)) != NULL
)
2441 CFRelease(dynamicStore
);
2449 * 'appleGetPaperSize()' - Get the default paper size.
2452 char * /* O - Default paper size */
2453 appleGetPaperSize(char *name
, /* I - Paper size name buffer */
2454 int namesize
) /* I - Size of buffer */
2456 CFStringRef defaultPaperID
; /* Default paper ID */
2457 _pwg_media_t
*pwgmedia
; /* PWG media size */
2460 defaultPaperID
= _cupsAppleCopyDefaultPaperID();
2461 if (!defaultPaperID
||
2462 CFGetTypeID(defaultPaperID
) != CFStringGetTypeID() ||
2463 !CFStringGetCString(defaultPaperID
, name
, namesize
,
2464 kCFStringEncodingUTF8
))
2466 else if ((pwgmedia
= _pwgMediaForLegacy(name
)) != NULL
)
2467 strlcpy(name
, pwgmedia
->pwg
, namesize
);
2470 CFRelease(defaultPaperID
);
2477 * 'appleGetPrinter()' - Get a printer from the history array.
2480 static CFStringRef
/* O - Printer name or NULL */
2481 appleGetPrinter(CFArrayRef locations
, /* I - Location array */
2482 CFStringRef network
, /* I - Network name */
2483 CFIndex
*locindex
) /* O - Index in array */
2485 CFIndex i
, /* Looping var */
2486 count
; /* Number of locations */
2487 CFDictionaryRef location
; /* Current location */
2488 CFStringRef locnetwork
, /* Current network */
2489 locprinter
; /* Current printer */
2492 for (i
= 0, count
= CFArrayGetCount(locations
); i
< count
; i
++)
2493 if ((location
= CFArrayGetValueAtIndex(locations
, i
)) != NULL
&&
2494 CFGetTypeID(location
) == CFDictionaryGetTypeID())
2496 if ((locnetwork
= CFDictionaryGetValue(location
,
2497 kLocationNetworkKey
)) != NULL
&&
2498 CFGetTypeID(locnetwork
) == CFStringGetTypeID() &&
2499 CFStringCompare(network
, locnetwork
, 0) == kCFCompareEqualTo
&&
2500 (locprinter
= CFDictionaryGetValue(location
,
2501 kLocationPrinterIDKey
)) != NULL
&&
2502 CFGetTypeID(locprinter
) == CFStringGetTypeID())
2507 return (locprinter
);
2513 #endif /* __APPLE__ */
2517 * 'cups_add_dest()' - Add a destination to the array.
2519 * Unlike cupsAddDest(), this function does not check for duplicates.
2522 static cups_dest_t
* /* O - New destination */
2523 cups_add_dest(const char *name
, /* I - Name of destination */
2524 const char *instance
, /* I - Instance or NULL */
2525 int *num_dests
, /* IO - Number of destinations */
2526 cups_dest_t
**dests
) /* IO - Destinations */
2528 int insert
, /* Insertion point */
2529 diff
; /* Result of comparison */
2530 cups_dest_t
*dest
; /* Destination pointer */
2534 * Add new destination...
2537 if (*num_dests
== 0)
2538 dest
= malloc(sizeof(cups_dest_t
));
2540 dest
= realloc(*dests
, sizeof(cups_dest_t
) * (*num_dests
+ 1));
2548 * Find where to insert the destination...
2551 if (*num_dests
== 0)
2555 insert
= cups_find_dest(name
, instance
, *num_dests
, *dests
, *num_dests
- 1,
2563 * Move the array elements as needed...
2566 if (insert
< *num_dests
)
2567 memmove(*dests
+ insert
+ 1, *dests
+ insert
,
2568 (*num_dests
- insert
) * sizeof(cups_dest_t
));
2573 * Initialize the destination...
2576 dest
= *dests
+ insert
;
2577 dest
->name
= _cupsStrAlloc(name
);
2578 dest
->instance
= _cupsStrAlloc(instance
);
2579 dest
->is_default
= 0;
2580 dest
->num_options
= 0;
2581 dest
->options
= (cups_option_t
*)0;
2589 * 'cups_block_cb()' - Enumeration callback for block API.
2592 static int /* O - 1 to continue, 0 to stop */
2594 cups_dest_block_t block
, /* I - Block */
2595 unsigned flags
, /* I - Destination flags */
2596 cups_dest_t
*dest
) /* I - Destination */
2598 return ((block
)(flags
, dest
));
2600 # endif /* __BLOCKS__ */
2604 * 'cups_compare_dests()' - Compare two destinations.
2607 static int /* O - Result of comparison */
2608 cups_compare_dests(cups_dest_t
*a
, /* I - First destination */
2609 cups_dest_t
*b
) /* I - Second destination */
2611 int diff
; /* Difference */
2614 if ((diff
= _cups_strcasecmp(a
->name
, b
->name
)) != 0)
2616 else if (a
->instance
&& b
->instance
)
2617 return (_cups_strcasecmp(a
->instance
, b
->instance
));
2619 return ((a
->instance
&& !b
->instance
) - (!a
->instance
&& b
->instance
));
2623 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
2626 * 'cups_dnssd_browse_cb()' - Browse for printers.
2630 cups_dnssd_browse_cb(
2631 DNSServiceRef sdRef
, /* I - Service reference */
2632 DNSServiceFlags flags
, /* I - Option flags */
2633 uint32_t interfaceIndex
, /* I - Interface number */
2634 DNSServiceErrorType errorCode
, /* I - Error, if any */
2635 const char *serviceName
, /* I - Name of service/device */
2636 const char *regtype
, /* I - Type of service */
2637 const char *replyDomain
, /* I - Service domain */
2638 void *context
) /* I - Enumeration data */
2640 _cups_dnssd_data_t
*data
= (_cups_dnssd_data_t
*)context
;
2641 /* Enumeration data */
2644 DEBUG_printf(("5cups_dnssd_browse_cb(sdRef=%p, flags=%x, "
2645 "interfaceIndex=%d, errorCode=%d, serviceName=\"%s\", "
2646 "regtype=\"%s\", replyDomain=\"%s\", context=%p)",
2647 sdRef
, flags
, interfaceIndex
, errorCode
, serviceName
, regtype
,
2648 replyDomain
, context
));
2651 * Don't do anything on error...
2654 if (errorCode
!= kDNSServiceErr_NoError
)
2661 cups_dnssd_get_device(data
, serviceName
, regtype
, replyDomain
);
2665 # else /* HAVE_AVAHI */
2667 * 'cups_dnssd_browse_cb()' - Browse for printers.
2671 cups_dnssd_browse_cb(
2672 AvahiServiceBrowser
*browser
, /* I - Browser */
2673 AvahiIfIndex interface
, /* I - Interface index (unused) */
2674 AvahiProtocol protocol
, /* I - Network protocol (unused) */
2675 AvahiBrowserEvent event
, /* I - What happened */
2676 const char *name
, /* I - Service name */
2677 const char *type
, /* I - Registration type */
2678 const char *domain
, /* I - Domain */
2679 AvahiLookupResultFlags flags
, /* I - Flags */
2680 void *context
) /* I - Devices array */
2682 AvahiClient
*client
= avahi_service_browser_get_client(browser
);
2683 /* Client information */
2684 _cups_dnssd_data_t
*data
= (_cups_dnssd_data_t
*)context
;
2685 /* Enumeration data */
2694 case AVAHI_BROWSER_FAILURE
:
2695 DEBUG_printf(("cups_dnssd_browse_cb: %s",
2696 avahi_strerror(avahi_client_errno(client
))));
2697 avahi_simple_poll_quit(data
->simple_poll
);
2700 case AVAHI_BROWSER_NEW
:
2702 * This object is new on the network.
2705 if (flags
& AVAHI_LOOKUP_RESULT_LOCAL
)
2708 * This comes from the local machine so ignore it.
2711 DEBUG_printf(("cups_dnssd_browse_cb: Ignoring local service \"%s\".",
2717 * Create a device entry for it if it doesn't yet exist.
2720 cups_dnssd_get_device(data
, name
, type
, domain
);
2724 case AVAHI_BROWSER_REMOVE
:
2725 case AVAHI_BROWSER_ALL_FOR_NOW
:
2726 case AVAHI_BROWSER_CACHE_EXHAUSTED
:
2733 * 'cups_dnssd_client_cb()' - Avahi client callback function.
2737 cups_dnssd_client_cb(
2738 AvahiClient
*client
, /* I - Client information (unused) */
2739 AvahiClientState state
, /* I - Current state */
2740 void *context
) /* I - User data (unused) */
2742 _cups_dnssd_data_t
*data
= (_cups_dnssd_data_t
*)context
;
2743 /* Enumeration data */
2749 * If the connection drops, quit.
2752 if (state
== AVAHI_CLIENT_FAILURE
)
2754 DEBUG_puts("cups_dnssd_client_cb: Avahi connection failed.");
2755 avahi_simple_poll_quit(data
->simple_poll
);
2758 # endif /* HAVE_DNSSD */
2762 * 'cups_dnssd_compare_device()' - Compare two devices.
2765 static int /* O - Result of comparison */
2766 cups_dnssd_compare_devices(
2767 _cups_dnssd_device_t
*a
, /* I - First device */
2768 _cups_dnssd_device_t
*b
) /* I - Second device */
2770 return (strcmp(a
->dest
.name
, b
->dest
.name
));
2775 * 'cups_dnssd_free_device()' - Free the memory used by a device.
2779 cups_dnssd_free_device(
2780 _cups_dnssd_device_t
*device
, /* I - Device */
2781 _cups_dnssd_data_t
*data
) /* I - Enumeration data */
2783 DEBUG_printf(("5cups_dnssd_free_device(device=%p(%s), data=%p)", device
,
2784 device
->dest
.name
, data
));
2788 DNSServiceRefDeallocate(device
->ref
);
2789 # else /* HAVE_AVAHI */
2791 avahi_record_browser_free(device
->ref
);
2792 # endif /* HAVE_DNSSD */
2794 _cupsStrFree(device
->domain
);
2795 _cupsStrFree(device
->fullName
);
2796 _cupsStrFree(device
->regtype
);
2797 _cupsStrFree(device
->dest
.name
);
2799 cupsFreeOptions(device
->dest
.num_options
, device
->dest
.options
);
2806 * 'cups_dnssd_get_device()' - Lookup a device and create it as needed.
2809 static _cups_dnssd_device_t
* /* O - Device */
2810 cups_dnssd_get_device(
2811 _cups_dnssd_data_t
*data
, /* I - Enumeration data */
2812 const char *serviceName
, /* I - Service name */
2813 const char *regtype
, /* I - Registration type */
2814 const char *replyDomain
) /* I - Domain name */
2816 _cups_dnssd_device_t key
, /* Search key */
2817 *device
; /* Device */
2818 char fullName
[kDNSServiceMaxDomainName
];
2819 /* Full name for query */
2822 DEBUG_printf(("5cups_dnssd_get_device(data=%p, serviceName=\"%s\", "
2823 "regtype=\"%s\", replyDomain=\"%s\")", data
, serviceName
,
2824 regtype
, replyDomain
));
2827 * See if this is an existing device...
2830 key
.dest
.name
= (char *)serviceName
;
2832 if ((device
= cupsArrayFind(data
->devices
, &key
)) != NULL
)
2835 * Yes, see if we need to do anything with this...
2838 int update
= 0; /* Non-zero if we need to update */
2840 if (!_cups_strcasecmp(replyDomain
, "local.") &&
2841 _cups_strcasecmp(device
->domain
, replyDomain
))
2844 * Update the "global" listing to use the .local domain name instead.
2847 _cupsStrFree(device
->domain
);
2848 device
->domain
= _cupsStrAlloc(replyDomain
);
2850 DEBUG_printf(("6cups_dnssd_get_device: Updating '%s' to use local "
2851 "domain.", device
->dest
.name
));
2856 if (!_cups_strcasecmp(regtype
, "_ipps._tcp") &&
2857 _cups_strcasecmp(device
->regtype
, regtype
))
2860 * Prefer IPPS over IPP.
2863 _cupsStrFree(device
->regtype
);
2864 device
->regtype
= _cupsStrAlloc(regtype
);
2866 DEBUG_printf(("6cups_dnssd_get_device: Updating '%s' to use IPPS.",
2867 device
->dest
.name
));
2874 DEBUG_printf(("6cups_dnssd_get_device: No changes to '%s'.",
2875 device
->dest
.name
));
2882 * No, add the device...
2885 DEBUG_printf(("6cups_dnssd_get_device: Adding '%s' for %s with domain "
2886 "'%s'.", serviceName
,
2887 !strcmp(regtype
, "_ipps._tcp") ? "IPPS" : "IPP",
2890 device
= calloc(sizeof(_cups_dnssd_device_t
), 1);
2891 device
->dest
.name
= _cupsStrAlloc(serviceName
);
2892 device
->domain
= _cupsStrAlloc(replyDomain
);
2893 device
->regtype
= _cupsStrAlloc(regtype
);
2895 cupsArrayAdd(data
->devices
, device
);
2899 * Set the "full name" of this service, which is used for queries...
2903 DNSServiceConstructFullName(fullName
, device
->dest
.name
, device
->regtype
,
2905 # else /* HAVE_AVAHI */
2906 avahi_service_name_join(fullName
, kDNSServiceMaxDomainName
, serviceName
,
2907 regtype
, replyDomain
);
2908 # endif /* HAVE_DNSSD */
2910 _cupsStrFree(device
->fullName
);
2911 device
->fullName
= _cupsStrAlloc(fullName
);
2916 DNSServiceRefDeallocate(device
->ref
);
2917 # else /* HAVE_AVAHI */
2918 avahi_record_browser_free(device
->ref
);
2919 # endif /* HAVE_DNSSD */
2924 if (device
->state
== _CUPS_DNSSD_ACTIVE
)
2926 (*data
->cb
)(data
->user_data
, CUPS_DEST_FLAGS_REMOVED
, &device
->dest
);
2927 device
->state
= _CUPS_DNSSD_NEW
;
2936 * 'cups_dnssd_local_cb()' - Browse for local printers.
2940 cups_dnssd_local_cb(
2941 DNSServiceRef sdRef
, /* I - Service reference */
2942 DNSServiceFlags flags
, /* I - Option flags */
2943 uint32_t interfaceIndex
, /* I - Interface number */
2944 DNSServiceErrorType errorCode
, /* I - Error, if any */
2945 const char *serviceName
, /* I - Name of service/device */
2946 const char *regtype
, /* I - Type of service */
2947 const char *replyDomain
, /* I - Service domain */
2948 void *context
) /* I - Devices array */
2950 _cups_dnssd_data_t
*data
= (_cups_dnssd_data_t
*)context
;
2951 /* Enumeration data */
2952 _cups_dnssd_device_t
*device
; /* Device */
2955 DEBUG_printf(("5cups_dnssd_local_cb(sdRef=%p, flags=%x, "
2956 "interfaceIndex=%d, errorCode=%d, serviceName=\"%s\", "
2957 "regtype=\"%s\", replyDomain=\"%s\", context=%p)",
2958 sdRef
, flags
, interfaceIndex
, errorCode
, serviceName
,
2959 regtype
, replyDomain
, context
));
2962 * Only process "add" data...
2965 if (errorCode
!= kDNSServiceErr_NoError
|| !(flags
& kDNSServiceFlagsAdd
))
2972 device
= cups_dnssd_get_device(data
, serviceName
, regtype
, replyDomain
);
2975 * Hide locally-registered devices...
2978 DEBUG_printf(("6cups_dnssd_local_cb: Hiding local printer '%s'.",
2983 DNSServiceRefDeallocate(device
->ref
);
2987 if (device
->state
== _CUPS_DNSSD_ACTIVE
)
2988 (*data
->cb
)(data
->user_data
, CUPS_DEST_FLAGS_REMOVED
, &device
->dest
);
2990 device
->state
= _CUPS_DNSSD_LOCAL
;
2992 # endif /* HAVE_DNSSD */
2997 * 'cups_dnssd_poll_cb()' - Wait for input on the specified file descriptors.
2999 * Note: This function is needed because avahi_simple_poll_iterate is broken
3000 * and always uses a timeout of 0 (!) milliseconds.
3001 * (Avahi Ticket #364)
3004 static int /* O - Number of file descriptors matching */
3006 struct pollfd
*pollfds
, /* I - File descriptors */
3007 unsigned int num_pollfds
, /* I - Number of file descriptors */
3008 int timeout
, /* I - Timeout in milliseconds (unused) */
3009 void *context
) /* I - User data (unused) */
3011 _cups_dnssd_data_t
*data
= (_cups_dnssd_data_t
*)context
;
3012 /* Enumeration data */
3013 int val
; /* Return value */
3018 val
= poll(pollfds
, num_pollfds
, 250);
3022 DEBUG_printf(("cups_dnssd_poll_cb: %s", strerror(errno
)));
3029 # endif /* HAVE_AVAHI */
3033 * 'cups_dnssd_query_cb()' - Process query data.
3038 cups_dnssd_query_cb(
3039 DNSServiceRef sdRef
, /* I - Service reference */
3040 DNSServiceFlags flags
, /* I - Data flags */
3041 uint32_t interfaceIndex
, /* I - Interface */
3042 DNSServiceErrorType errorCode
, /* I - Error, if any */
3043 const char *fullName
, /* I - Full service name */
3044 uint16_t rrtype
, /* I - Record type */
3045 uint16_t rrclass
, /* I - Record class */
3046 uint16_t rdlen
, /* I - Length of record data */
3047 const void *rdata
, /* I - Record data */
3048 uint32_t ttl
, /* I - Time-to-live */
3049 void *context
) /* I - Enumeration data */
3051 # else /* HAVE_AVAHI */
3053 cups_dnssd_query_cb(
3054 AvahiRecordBrowser
*browser
, /* I - Record browser */
3055 AvahiIfIndex interfaceIndex
,
3056 /* I - Interface index (unused) */
3057 AvahiProtocol protocol
, /* I - Network protocol (unused) */
3058 AvahiBrowserEvent event
, /* I - What happened? */
3059 const char *fullName
, /* I - Service name */
3060 uint16_t rrclass
, /* I - Record class */
3061 uint16_t rrtype
, /* I - Record type */
3062 const void *rdata
, /* I - TXT record */
3063 size_t rdlen
, /* I - Length of TXT record */
3064 AvahiLookupResultFlags flags
, /* I - Flags */
3065 void *context
) /* I - Enumeration data */
3067 AvahiClient
*client
= avahi_record_browser_get_client(browser
);
3068 /* Client information */
3069 # endif /* HAVE_DNSSD */
3070 _cups_dnssd_data_t
*data
= (_cups_dnssd_data_t
*)context
;
3071 /* Enumeration data */
3072 char name
[1024], /* Service name */
3073 *ptr
; /* Pointer into string */
3074 _cups_dnssd_device_t dkey
, /* Search key */
3075 *device
; /* Device */
3079 DEBUG_printf(("5cups_dnssd_query_cb(sdRef=%p, flags=%x, "
3080 "interfaceIndex=%d, errorCode=%d, fullName=\"%s\", "
3081 "rrtype=%u, rrclass=%u, rdlen=%u, rdata=%p, ttl=%u, "
3082 "context=%p)", sdRef
, flags
, interfaceIndex
, errorCode
,
3083 fullName
, rrtype
, rrclass
, rdlen
, rdata
, ttl
, context
));
3086 * Only process "add" data...
3089 if (errorCode
!= kDNSServiceErr_NoError
|| !(flags
& kDNSServiceFlagsAdd
))
3092 # else /* HAVE_AVAHI */
3093 DEBUG_printf(("5cups_dnssd_query_cb(browser=%p, interfaceIndex=%d, "
3094 "protocol=%d, event=%d, fullName=\"%s\", rrclass=%u, "
3095 "rrtype=%u, rdata=%p, rdlen=%u, flags=%x, context=%p)",
3096 browser
, interfaceIndex
, protocol
, event
, fullName
, rrclass
,
3097 rrtype
, rdata
, (unsigned)rdlen
, flags
, context
));
3100 * Only process "add" data...
3103 if (event
!= AVAHI_BROWSER_NEW
)
3105 if (event
== AVAHI_BROWSER_FAILURE
)
3106 DEBUG_printf(("cups_dnssd_query_cb: %s",
3107 avahi_strerror(avahi_client_errno(client
))));
3111 # endif /* HAVE_DNSSD */
3114 * Lookup the service in the devices array.
3117 dkey
.dest
.name
= name
;
3119 cups_dnssd_unquote(name
, fullName
, sizeof(name
));
3121 if ((ptr
= strstr(name
, "._")) != NULL
)
3124 if ((device
= cupsArrayFind(data
->devices
, &dkey
)) != NULL
)
3127 * Found it, pull out the make and model from the TXT record and save it...
3130 const uint8_t *txt
, /* Pointer into data */
3131 *txtnext
, /* Next key/value pair */
3132 *txtend
; /* End of entire TXT record */
3133 uint8_t txtlen
; /* Length of current key/value pair */
3134 char key
[256], /* Key string */
3135 value
[256], /* Value string */
3136 make_and_model
[512],
3137 /* Manufacturer and model */
3138 model
[256], /* Model */
3139 uriname
[1024], /* Name for URI */
3140 uri
[1024]; /* Printer URI */
3141 cups_ptype_t type
= CUPS_PRINTER_REMOTE
| CUPS_PRINTER_BW
;
3143 int saw_printer_type
= 0;
3144 /* Did we see a printer-type key? */
3146 device
->state
= _CUPS_DNSSD_PENDING
;
3147 make_and_model
[0] = '\0';
3149 strcpy(model
, "Unknown");
3151 for (txt
= rdata
, txtend
= txt
+ rdlen
;
3156 * Read a key/value pair starting with an 8-bit length. Since the
3157 * length is 8 bits and the size of the key/value buffers is 256, we
3158 * don't need to check for overflow...
3163 if (!txtlen
|| (txt
+ txtlen
) > txtend
)
3166 txtnext
= txt
+ txtlen
;
3168 for (ptr
= key
; txt
< txtnext
&& *txt
!= '='; txt
++)
3172 if (txt
< txtnext
&& *txt
== '=')
3177 memcpy(value
, txt
, txtnext
- txt
);
3178 value
[txtnext
- txt
] = '\0';
3180 DEBUG_printf(("6cups_dnssd_query_cb: %s=%s", key
, value
));
3184 DEBUG_printf(("6cups_dnssd_query_cb: '%s' with no value.", key
));
3188 if (!_cups_strcasecmp(key
, "usb_MFG") ||
3189 !_cups_strcasecmp(key
, "usb_MANU") ||
3190 !_cups_strcasecmp(key
, "usb_MANUFACTURER"))
3191 strcpy(make_and_model
, value
);
3192 else if (!_cups_strcasecmp(key
, "usb_MDL") ||
3193 !_cups_strcasecmp(key
, "usb_MODEL"))
3194 strcpy(model
, value
);
3195 else if (!_cups_strcasecmp(key
, "product") && !strstr(value
, "Ghostscript"))
3197 if (value
[0] == '(')
3200 * Strip parenthesis...
3203 if ((ptr
= value
+ strlen(value
) - 1) > value
&& *ptr
== ')')
3206 strcpy(model
, value
+ 1);
3209 strcpy(model
, value
);
3211 else if (!_cups_strcasecmp(key
, "ty"))
3213 strcpy(model
, value
);
3215 if ((ptr
= strchr(model
, ',')) != NULL
)
3218 else if (!_cups_strcasecmp(key
, "note"))
3219 device
->dest
.num_options
= cupsAddOption("printer-location", value
,
3220 device
->dest
.num_options
,
3221 &device
->dest
.options
);
3222 else if (!_cups_strcasecmp(key
, "pdl"))
3225 * Look for PDF-capable printers; only PDF-capable printers are shown.
3228 const char *start
, *next
; /* Pointer into value */
3229 int have_pdf
= 0; /* Have PDF? */
3231 for (start
= value
; start
&& *start
; start
= next
)
3233 if (!_cups_strncasecmp(start
, "application/pdf", 15) &&
3234 (!start
[15] || start
[15] == ','))
3240 if ((next
= strchr(start
, ',')) != NULL
)
3245 device
->state
= _CUPS_DNSSD_INCOMPATIBLE
;
3247 else if (!_cups_strcasecmp(key
, "printer-type"))
3250 * Value is either NNNN or 0xXXXX
3253 saw_printer_type
= 1;
3254 type
= strtol(value
, NULL
, 0);
3256 else if (!saw_printer_type
)
3258 if (!_cups_strcasecmp(key
, "air") &&
3259 !_cups_strcasecmp(value
, "t"))
3260 type
|= CUPS_PRINTER_AUTHENTICATED
;
3261 else if (!_cups_strcasecmp(key
, "bind") &&
3262 !_cups_strcasecmp(value
, "t"))
3263 type
|= CUPS_PRINTER_BIND
;
3264 else if (!_cups_strcasecmp(key
, "collate") &&
3265 !_cups_strcasecmp(value
, "t"))
3266 type
|= CUPS_PRINTER_COLLATE
;
3267 else if (!_cups_strcasecmp(key
, "color") &&
3268 !_cups_strcasecmp(value
, "t"))
3269 type
|= CUPS_PRINTER_COLOR
;
3270 else if (!_cups_strcasecmp(key
, "copies") &&
3271 !_cups_strcasecmp(value
, "t"))
3272 type
|= CUPS_PRINTER_COPIES
;
3273 else if (!_cups_strcasecmp(key
, "duplex") &&
3274 !_cups_strcasecmp(value
, "t"))
3275 type
|= CUPS_PRINTER_DUPLEX
;
3276 else if (!_cups_strcasecmp(key
, "fax") &&
3277 !_cups_strcasecmp(value
, "t"))
3278 type
|= CUPS_PRINTER_MFP
;
3279 else if (!_cups_strcasecmp(key
, "papercustom") &&
3280 !_cups_strcasecmp(value
, "t"))
3281 type
|= CUPS_PRINTER_VARIABLE
;
3282 else if (!_cups_strcasecmp(key
, "papermax"))
3284 if (!_cups_strcasecmp(value
, "legal-a4"))
3285 type
|= CUPS_PRINTER_SMALL
;
3286 else if (!_cups_strcasecmp(value
, "isoc-a2"))
3287 type
|= CUPS_PRINTER_MEDIUM
;
3288 else if (!_cups_strcasecmp(value
, ">isoc-a2"))
3289 type
|= CUPS_PRINTER_LARGE
;
3291 else if (!_cups_strcasecmp(key
, "punch") &&
3292 !_cups_strcasecmp(value
, "t"))
3293 type
|= CUPS_PRINTER_PUNCH
;
3294 else if (!_cups_strcasecmp(key
, "scan") &&
3295 !_cups_strcasecmp(value
, "t"))
3296 type
|= CUPS_PRINTER_MFP
;
3297 else if (!_cups_strcasecmp(key
, "sort") &&
3298 !_cups_strcasecmp(value
, "t"))
3299 type
|= CUPS_PRINTER_SORT
;
3300 else if (!_cups_strcasecmp(key
, "staple") &&
3301 !_cups_strcasecmp(value
, "t"))
3302 type
|= CUPS_PRINTER_STAPLE
;
3307 * Save the printer-xxx values...
3310 device
->dest
.num_options
= cupsAddOption("printer-info", name
,
3311 device
->dest
.num_options
,
3312 &device
->dest
.options
);
3314 if (make_and_model
[0])
3316 strlcat(make_and_model
, " ", sizeof(make_and_model
));
3317 strlcat(make_and_model
, model
, sizeof(make_and_model
));
3319 device
->dest
.num_options
= cupsAddOption("printer-make-and-model",
3321 device
->dest
.num_options
,
3322 &device
->dest
.options
);
3325 device
->dest
.num_options
= cupsAddOption("printer-make-and-model",
3327 device
->dest
.num_options
,
3328 &device
->dest
.options
);
3330 device
->type
= type
;
3331 snprintf(value
, sizeof(value
), "%u", type
);
3332 device
->dest
.num_options
= cupsAddOption("printer-type", value
,
3333 device
->dest
.num_options
,
3334 &device
->dest
.options
);
3340 cups_dnssd_unquote(uriname
, device
->fullName
, sizeof(uriname
));
3341 httpAssembleURI(HTTP_URI_CODING_ALL
, uri
, sizeof(uri
),
3342 !strcmp(device
->regtype
, "_ipps._tcp") ? "ipps" : "ipp",
3343 NULL
, uriname
, 0, saw_printer_type
? "/cups" : "/");
3345 DEBUG_printf(("6cups_dnssd_query: printer-uri-supported=\"%s\"", uri
));
3347 device
->dest
.num_options
= cupsAddOption("printer-uri-supported", uri
,
3348 device
->dest
.num_options
,
3349 &device
->dest
.options
);
3352 DEBUG_printf(("6cups_dnssd_query: Ignoring TXT record for '%s'.",
3358 * 'cups_dnssd_resolve()' - Resolve a Bonjour printer URI.
3361 static const char * /* O - Resolved URI or NULL */
3363 cups_dest_t
*dest
, /* I - Destination */
3364 const char *uri
, /* I - Current printer URI */
3365 int msec
, /* I - Time in milliseconds */
3366 int *cancel
, /* I - Pointer to "cancel" variable */
3367 cups_dest_cb_t cb
, /* I - Callback */
3368 void *user_data
) /* I - User data for callback */
3370 char tempuri
[1024]; /* Temporary URI buffer */
3371 _cups_dnssd_resolve_t resolve
; /* Resolve data */
3375 * Resolve the URI...
3378 resolve
.cancel
= cancel
;
3379 gettimeofday(&resolve
.end_time
, NULL
);
3382 resolve
.end_time
.tv_sec
+= msec
/ 1000;
3383 resolve
.end_time
.tv_usec
+= (msec
% 1000) * 1000;
3385 while (resolve
.end_time
.tv_usec
>= 1000000)
3387 resolve
.end_time
.tv_sec
++;
3388 resolve
.end_time
.tv_usec
-= 1000000;
3392 resolve
.end_time
.tv_sec
+= 75;
3395 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_RESOLVING
,
3398 if ((uri
= _httpResolveURI(uri
, tempuri
, sizeof(tempuri
),
3399 _HTTP_RESOLVE_FQDN
, cups_dnssd_resolve_cb
,
3402 _cupsSetError(IPP_INTERNAL_ERROR
, _("Unable to resolve printer URI."), 1);
3405 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_ERROR
,
3412 * Save the resolved URI...
3415 dest
->num_options
= cupsAddOption("printer-uri-supported", uri
,
3416 dest
->num_options
, &dest
->options
);
3418 return (cupsGetOption("printer-uri-supported", dest
->num_options
,
3424 * 'cups_dnssd_resolve_cb()' - See if we should continue resolving.
3427 static int /* O - 1 to continue, 0 to stop */
3428 cups_dnssd_resolve_cb(void *context
) /* I - Resolve data */
3430 _cups_dnssd_resolve_t
*resolve
= (_cups_dnssd_resolve_t
*)context
;
3432 struct timeval curtime
; /* Current time */
3436 * If the cancel variable is set, return immediately.
3439 if (*resolve
->cancel
)
3443 * Otherwise check the end time...
3446 gettimeofday(&curtime
, NULL
);
3448 return (curtime
.tv_sec
> resolve
->end_time
.tv_sec
||
3449 (curtime
.tv_sec
== resolve
->end_time
.tv_sec
&&
3450 curtime
.tv_usec
> resolve
->end_time
.tv_usec
));
3455 * 'cups_dnssd_unquote()' - Unquote a name string.
3459 cups_dnssd_unquote(char *dst
, /* I - Destination buffer */
3460 const char *src
, /* I - Source string */
3461 size_t dstsize
) /* I - Size of destination buffer */
3463 char *dstend
= dst
+ dstsize
- 1; /* End of destination buffer */
3466 while (*src
&& dst
< dstend
)
3471 if (isdigit(src
[0] & 255) && isdigit(src
[1] & 255) &&
3472 isdigit(src
[2] & 255))
3474 *dst
++ = ((((src
[0] - '0') * 10) + src
[1] - '0') * 10) + src
[2] - '0';
3486 #endif /* HAVE_DNSSD */
3490 * 'cups_find_dest()' - Find a destination using a binary search.
3493 static int /* O - Index of match */
3494 cups_find_dest(const char *name
, /* I - Destination name */
3495 const char *instance
, /* I - Instance or NULL */
3496 int num_dests
, /* I - Number of destinations */
3497 cups_dest_t
*dests
, /* I - Destinations */
3498 int prev
, /* I - Previous index */
3499 int *rdiff
) /* O - Difference of match */
3501 int left
, /* Low mark for binary search */
3502 right
, /* High mark for binary search */
3503 current
, /* Current index */
3504 diff
; /* Result of comparison */
3505 cups_dest_t key
; /* Search key */
3508 key
.name
= (char *)name
;
3509 key
.instance
= (char *)instance
;
3514 * Start search on either side of previous...
3517 if ((diff
= cups_compare_dests(&key
, dests
+ prev
)) == 0 ||
3518 (diff
< 0 && prev
== 0) ||
3519 (diff
> 0 && prev
== (num_dests
- 1)))
3527 * Start with previous on right side...
3536 * Start wih previous on left side...
3540 right
= num_dests
- 1;
3546 * Start search in the middle...
3550 right
= num_dests
- 1;
3555 current
= (left
+ right
) / 2;
3556 diff
= cups_compare_dests(&key
, dests
+ current
);
3565 while ((right
- left
) > 1);
3570 * Check the last 1 or 2 elements...
3573 if ((diff
= cups_compare_dests(&key
, dests
+ left
)) <= 0)
3577 diff
= cups_compare_dests(&key
, dests
+ right
);
3583 * Return the closest destination and the difference...
3593 * 'cups_get_default()' - Get the default destination from an lpoptions file.
3596 static char * /* O - Default destination or NULL */
3597 cups_get_default(const char *filename
, /* I - File to read */
3598 char *namebuf
, /* I - Name buffer */
3599 size_t namesize
, /* I - Size of name buffer */
3600 const char **instance
) /* I - Instance */
3602 cups_file_t
*fp
; /* lpoptions file */
3603 char line
[8192], /* Line from file */
3604 *value
, /* Value for line */
3605 *nameptr
; /* Pointer into name */
3606 int linenum
; /* Current line */
3611 if ((fp
= cupsFileOpen(filename
, "r")) != NULL
)
3615 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
3617 if (!_cups_strcasecmp(line
, "default") && value
)
3619 strlcpy(namebuf
, value
, namesize
);
3621 if ((nameptr
= strchr(namebuf
, ' ')) != NULL
)
3623 if ((nameptr
= strchr(namebuf
, '\t')) != NULL
)
3626 if ((nameptr
= strchr(namebuf
, '/')) != NULL
)
3629 *instance
= nameptr
;
3637 return (*namebuf
? namebuf
: NULL
);
3642 * 'cups_get_dests()' - Get destinations from a file.
3645 static int /* O - Number of destinations */
3647 const char *filename
, /* I - File to read from */
3648 const char *match_name
, /* I - Destination name we want */
3649 const char *match_inst
, /* I - Instance name we want */
3650 int user_default_set
, /* I - User default printer set? */
3651 int num_dests
, /* I - Number of destinations */
3652 cups_dest_t
**dests
) /* IO - Destinations */
3654 int i
; /* Looping var */
3655 cups_dest_t
*dest
; /* Current destination */
3656 cups_file_t
*fp
; /* File pointer */
3657 char line
[8192], /* Line from file */
3658 *lineptr
, /* Pointer into line */
3659 *name
, /* Name of destination/option */
3660 *instance
; /* Instance of destination */
3661 int linenum
; /* Current line number */
3664 DEBUG_printf(("7cups_get_dests(filename=\"%s\", match_name=\"%s\", "
3665 "match_inst=\"%s\", user_default_set=%d, num_dests=%d, "
3666 "dests=%p)", filename
, match_name
, match_inst
,
3667 user_default_set
, num_dests
, dests
));
3670 * Try to open the file...
3673 if ((fp
= cupsFileOpen(filename
, "r")) == NULL
)
3677 * Read each printer; each line looks like:
3679 * Dest name[/instance] options
3680 * Default name[/instance] options
3685 while (cupsFileGetConf(fp
, line
, sizeof(line
), &lineptr
, &linenum
))
3688 * See what type of line it is...
3691 DEBUG_printf(("9cups_get_dests: linenum=%d line=\"%s\" lineptr=\"%s\"",
3692 linenum
, line
, lineptr
));
3694 if ((_cups_strcasecmp(line
, "dest") && _cups_strcasecmp(line
, "default")) || !lineptr
)
3696 DEBUG_puts("9cups_get_dests: Not a dest or default line...");
3703 * Search for an instance...
3706 while (!isspace(*lineptr
& 255) && *lineptr
&& *lineptr
!= '/')
3709 if (*lineptr
== '/')
3712 * Found an instance...
3719 * Search for an instance...
3722 while (!isspace(*lineptr
& 255) && *lineptr
)
3731 DEBUG_printf(("9cups_get_dests: name=\"%s\", instance=\"%s\"", name
,
3735 * See if the primary instance of the destination exists; if not,
3736 * ignore this entry and move on...
3741 if (_cups_strcasecmp(name
, match_name
) ||
3742 (!instance
&& match_inst
) ||
3743 (instance
&& !match_inst
) ||
3744 (instance
&& _cups_strcasecmp(instance
, match_inst
)))
3749 else if (cupsGetDest(name
, NULL
, num_dests
, *dests
) == NULL
)
3751 DEBUG_puts("9cups_get_dests: Not found!");
3757 * Add the destination...
3760 num_dests
= cupsAddDest(name
, instance
, num_dests
, dests
);
3762 if ((dest
= cupsGetDest(name
, instance
, num_dests
, *dests
)) == NULL
)
3768 DEBUG_puts("9cups_get_dests: Out of memory!");
3774 * Add options until we hit the end of the line...
3777 dest
->num_options
= cupsParseOptions(lineptr
, dest
->num_options
,
3781 * If we found what we were looking for, stop now...
3788 * Set this as default if needed...
3791 if (!user_default_set
&& !_cups_strcasecmp(line
, "default"))
3793 DEBUG_puts("9cups_get_dests: Setting as default...");
3795 for (i
= 0; i
< num_dests
; i
++)
3796 (*dests
)[i
].is_default
= 0;
3798 dest
->is_default
= 1;
3803 * Close the file and return...
3813 * 'cups_make_string()' - Make a comma-separated string of values from an IPP
3817 static char * /* O - New string */
3819 ipp_attribute_t
*attr
, /* I - Attribute to convert */
3820 char *buffer
, /* I - Buffer */
3821 size_t bufsize
) /* I - Size of buffer */
3823 int i
; /* Looping var */
3824 char *ptr
, /* Pointer into buffer */
3825 *end
, /* Pointer to end of buffer */
3826 *valptr
; /* Pointer into string attribute */
3830 * Return quickly if we have a single string value...
3833 if (attr
->num_values
== 1 &&
3834 attr
->value_tag
!= IPP_TAG_INTEGER
&&
3835 attr
->value_tag
!= IPP_TAG_ENUM
&&
3836 attr
->value_tag
!= IPP_TAG_BOOLEAN
&&
3837 attr
->value_tag
!= IPP_TAG_RANGE
)
3838 return (attr
->values
[0].string
.text
);
3841 * Copy the values to the string, separating with commas and escaping strings
3845 end
= buffer
+ bufsize
- 1;
3847 for (i
= 0, ptr
= buffer
; i
< attr
->num_values
&& ptr
< end
; i
++)
3852 switch (attr
->value_tag
)
3854 case IPP_TAG_INTEGER
:
3856 snprintf(ptr
, end
- ptr
+ 1, "%d", attr
->values
[i
].integer
);
3859 case IPP_TAG_BOOLEAN
:
3860 if (attr
->values
[i
].boolean
)
3861 strlcpy(ptr
, "true", end
- ptr
+ 1);
3863 strlcpy(ptr
, "false", end
- ptr
+ 1);
3866 case IPP_TAG_RANGE
:
3867 if (attr
->values
[i
].range
.lower
== attr
->values
[i
].range
.upper
)
3868 snprintf(ptr
, end
- ptr
+ 1, "%d", attr
->values
[i
].range
.lower
);
3870 snprintf(ptr
, end
- ptr
+ 1, "%d-%d", attr
->values
[i
].range
.lower
,
3871 attr
->values
[i
].range
.upper
);
3875 for (valptr
= attr
->values
[i
].string
.text
;
3876 *valptr
&& ptr
< end
;)
3878 if (strchr(" \t\n\\\'\"", *valptr
))
3880 if (ptr
>= (end
- 1))
3903 * End of "$Id: dest.c 9568 2011-02-25 06:13:56Z mike $".