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 if ((dest
= cups_add_dest(name
, instance
, &num_dests
, dests
)) == NULL
)
326 * Find the base dest again now the array has been realloc'd.
329 parent
= cupsGetDest(name
, NULL
, num_dests
, *dests
);
331 if (instance
&& parent
&& parent
->num_options
> 0)
334 * Copy options from parent...
337 dest
->options
= calloc(sizeof(cups_option_t
), parent
->num_options
);
341 dest
->num_options
= parent
->num_options
;
343 for (i
= dest
->num_options
, doption
= dest
->options
,
344 poption
= parent
->options
;
346 i
--, doption
++, poption
++)
348 doption
->name
= _cupsStrRetain(poption
->name
);
349 doption
->value
= _cupsStrRetain(poption
->value
);
361 * '_cupsAppleCopyDefaultPaperID()' - Get the default paper ID.
364 CFStringRef
/* O - Default paper ID */
365 _cupsAppleCopyDefaultPaperID(void)
367 return (CFPreferencesCopyAppValue(kDefaultPaperIDKey
,
368 kCUPSPrintingPrefs
));
373 * '_cupsAppleCopyDefaultPrinter()' - Get the default printer at this location.
376 CFStringRef
/* O - Default printer name */
377 _cupsAppleCopyDefaultPrinter(void)
379 CFStringRef network
; /* Network location */
380 CFArrayRef locations
; /* Location array */
381 CFStringRef locprinter
; /* Current printer */
385 * Use location-based defaults only if "use last printer" is selected in the
386 * system preferences...
389 if (!_cupsAppleGetUseLastPrinter())
391 DEBUG_puts("1_cupsAppleCopyDefaultPrinter: Not using last printer as "
397 * Get the current location...
400 if ((network
= appleCopyNetwork()) == NULL
)
402 DEBUG_puts("1_cupsAppleCopyDefaultPrinter: Unable to get current "
408 * Lookup the network in the preferences...
411 if ((locations
= appleCopyLocations()) == NULL
)
414 * Missing or bad location array, so no location-based default...
417 DEBUG_puts("1_cupsAppleCopyDefaultPrinter: Missing or bad last used "
425 DEBUG_printf(("1_cupsAppleCopyDefaultPrinter: Got locations, %d entries.",
426 (int)CFArrayGetCount(locations
)));
428 if ((locprinter
= appleGetPrinter(locations
, network
, NULL
)) != NULL
)
429 CFRetain(locprinter
);
432 CFRelease(locations
);
439 * '_cupsAppleGetUseLastPrinter()' - Get whether to use the last used printer.
442 int /* O - 1 to use last printer, 0 otherwise */
443 _cupsAppleGetUseLastPrinter(void)
445 Boolean uselast
, /* Use last printer preference value */
446 uselast_set
; /* Valid is set? */
449 if (getenv("CUPS_DISABLE_APPLE_DEFAULT"))
452 uselast
= CFPreferencesGetAppBooleanValue(kUseLastPrinter
,
463 * '_cupsAppleSetDefaultPaperID()' - Set the default paper id.
467 _cupsAppleSetDefaultPaperID(
468 CFStringRef name
) /* I - New paper ID */
470 CFPreferencesSetAppValue(kDefaultPaperIDKey
, name
, kCUPSPrintingPrefs
);
471 CFPreferencesAppSynchronize(kCUPSPrintingPrefs
);
472 notify_post("com.apple.printerPrefsChange");
477 * '_cupsAppleSetDefaultPrinter()' - Set the default printer for this location.
481 _cupsAppleSetDefaultPrinter(
482 CFStringRef name
) /* I - Default printer/class name */
484 CFStringRef network
; /* Current network */
485 CFArrayRef locations
; /* Old locations array */
486 CFIndex locindex
; /* Index in locations array */
487 CFStringRef locprinter
; /* Current printer */
488 CFMutableArrayRef newlocations
; /* New locations array */
489 CFMutableDictionaryRef newlocation
; /* New location */
493 * Get the current location...
496 if ((network
= appleCopyNetwork()) == NULL
)
498 DEBUG_puts("1_cupsAppleSetDefaultPrinter: Unable to get current network...");
503 * Lookup the network in the preferences...
506 if ((locations
= appleCopyLocations()) != NULL
)
507 locprinter
= appleGetPrinter(locations
, network
, &locindex
);
514 if (!locprinter
|| CFStringCompare(locprinter
, name
, 0) != kCFCompareEqualTo
)
517 * Need to change the locations array...
522 newlocations
= CFArrayCreateMutableCopy(kCFAllocatorDefault
, 0,
526 CFArrayRemoveValueAtIndex(newlocations
, locindex
);
529 newlocations
= CFArrayCreateMutable(kCFAllocatorDefault
, 0,
530 &kCFTypeArrayCallBacks
);
532 newlocation
= CFDictionaryCreateMutable(kCFAllocatorDefault
, 0,
533 &kCFTypeDictionaryKeyCallBacks
,
534 &kCFTypeDictionaryValueCallBacks
);
536 if (newlocation
&& newlocations
)
539 * Put the new location at the front of the array...
542 CFDictionaryAddValue(newlocation
, kLocationNetworkKey
, network
);
543 CFDictionaryAddValue(newlocation
, kLocationPrinterIDKey
, name
);
544 CFArrayInsertValueAtIndex(newlocations
, 0, newlocation
);
547 * Limit the number of locations to 10...
550 while (CFArrayGetCount(newlocations
) > 10)
551 CFArrayRemoveValueAtIndex(newlocations
, 10);
554 * Push the changes out...
557 CFPreferencesSetAppValue(kLastUsedPrintersKey
, newlocations
,
559 CFPreferencesAppSynchronize(kCUPSPrintingPrefs
);
560 notify_post("com.apple.printerPrefsChange");
564 CFRelease(newlocations
);
567 CFRelease(newlocation
);
571 CFRelease(locations
);
578 * '_cupsAppleSetUseLastPrinter()' - Set whether to use the last used printer.
582 _cupsAppleSetUseLastPrinter(
583 int uselast
) /* O - 1 to use last printer, 0 otherwise */
585 CFPreferencesSetAppValue(kUseLastPrinter
,
586 uselast
? kCFBooleanTrue
: kCFBooleanFalse
,
588 CFPreferencesAppSynchronize(kCUPSPrintingPrefs
);
589 notify_post("com.apple.printerPrefsChange");
591 #endif /* __APPLE__ */
595 * 'cupsConnectDest()' - Connect to the server for a destination.
597 * Connect to the destination, returning a new http_t connection object and
598 * optionally the resource path to use for the destination. These calls will
599 * block until a connection is made, the timeout expires, the integer pointed
600 * to by "cancel" is non-zero, or the callback function (or block) returns 0,
601 * The caller is responsible for calling httpClose() on the returned object.
603 * @since CUPS 1.6/OS X 10.8@
606 http_t
* /* O - Connection to server or @code NULL@ */
608 cups_dest_t
*dest
, /* I - Destination */
609 unsigned flags
, /* I - Connection flags */
610 int msec
, /* I - Timeout in milliseconds */
611 int *cancel
, /* I - Pointer to "cancel" variable */
612 char *resource
, /* I - Resource buffer */
613 size_t resourcesize
, /* I - Size of resource buffer */
614 cups_dest_cb_t cb
, /* I - Callback function */
615 void *user_data
) /* I - User data pointer */
617 const char *uri
; /* Printer URI */
618 char scheme
[32], /* URI scheme */
619 userpass
[256], /* Username and password (unused) */
620 hostname
[256], /* Hostname */
621 tempresource
[1024]; /* Temporary resource buffer */
622 int port
; /* Port number */
623 char portstr
[16]; /* Port number string */
624 http_encryption_t encryption
; /* Encryption to use */
625 http_addrlist_t
*addrlist
; /* Address list for server */
626 http_t
*http
; /* Connection to server */
630 * Range check input...
638 _cupsSetError(IPP_INTERNAL_ERROR
, strerror(EINVAL
), 0);
642 if (!resource
|| resourcesize
< 1)
644 resource
= tempresource
;
645 resourcesize
= sizeof(tempresource
);
649 * Grab the printer URI...
652 if ((uri
= cupsGetOption("printer-uri-supported", dest
->num_options
,
653 dest
->options
)) == NULL
)
655 _cupsSetError(IPP_INTERNAL_ERROR
, strerror(ENOENT
), 0);
658 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_ERROR
,
664 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
665 if (strstr(uri
, "._tcp"))
667 if ((uri
= cups_dnssd_resolve(dest
, uri
, msec
, cancel
, cb
,
671 #endif /* HAVE_DNSSD || HAVE_AVAHI */
673 if (httpSeparateURI(HTTP_URI_CODING_ALL
, uri
, scheme
, sizeof(scheme
),
674 userpass
, sizeof(userpass
), hostname
, sizeof(hostname
),
675 &port
, resource
, resourcesize
) < HTTP_URI_OK
)
677 _cupsSetError(IPP_INTERNAL_ERROR
, _("Bad printer URI."), 1);
680 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_ERROR
,
687 * Lookup the address for the server...
691 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_RESOLVING
,
694 snprintf(portstr
, sizeof(portstr
), "%d", port
);
696 if ((addrlist
= httpAddrGetList(hostname
, AF_UNSPEC
, portstr
)) == NULL
)
699 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_ERROR
,
705 if (cancel
&& *cancel
)
707 httpAddrFreeList(addrlist
);
710 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_CANCELED
,
717 * Create the HTTP object pointing to the server referenced by the URI...
720 if (!strcmp(scheme
, "ipps") || port
== 443)
721 encryption
= HTTP_ENCRYPT_ALWAYS
;
723 encryption
= HTTP_ENCRYPT_IF_REQUESTED
;
725 http
= _httpCreate(hostname
, port
, addrlist
, AF_UNSPEC
, encryption
, 1,
729 * Connect if requested...
732 if (flags
& CUPS_DEST_FLAGS_UNCONNECTED
)
735 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
, dest
);
740 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_CONNECTING
,
743 if (!httpReconnect2(http
, msec
, cancel
) && cb
)
745 if (cancel
&& *cancel
)
747 CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_CONNECTING
, dest
);
749 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_ERROR
,
753 (*cb
)(user_data
, CUPS_DEST_FLAGS_NONE
, dest
);
762 * 'cupsConnectDestBlock()' - Connect to the server for a destination.
764 * Connect to the destination, returning a new http_t connection object and
765 * optionally the resource path to use for the destination. These calls will
766 * block until a connection is made, the timeout expires, the integer pointed
767 * to by "cancel" is non-zero, or the callback function (or block) returns 0,
768 * The caller is responsible for calling httpClose() on the returned object.
770 * @since CUPS 1.6/OS X 10.8@
773 http_t
* /* O - Connection to server or @code NULL@ */
774 cupsConnectDestBlock(
775 cups_dest_t
*dest
, /* I - Destination */
776 unsigned flags
, /* I - Connection flags */
777 int msec
, /* I - Timeout in milliseconds */
778 int *cancel
, /* I - Pointer to "cancel" variable */
779 char *resource
, /* I - Resource buffer */
780 size_t resourcesize
, /* I - Size of resource buffer */
781 cups_dest_block_t block
) /* I - Callback block */
783 return (cupsConnectDest(dest
, flags
, msec
, cancel
, resource
, resourcesize
,
784 (cups_dest_cb_t
)cups_block_cb
, (void *)block
));
786 #endif /* __BLOCKS__ */
790 * 'cupsCopyDest()' - Copy a destination.
792 * Make a copy of the destination to an array of destinations (or just a single
793 * copy) - for use with the cupsEnumDests* functions. The caller is responsible
794 * for calling cupsFreeDests() on the returned object(s).
796 * @since CUPS 1.6/OS X 10.8@
800 cupsCopyDest(cups_dest_t
*dest
,
804 int i
; /* Looping var */
805 cups_dest_t
*new_dest
; /* New destination pointer */
806 cups_option_t
*new_option
, /* Current destination option */
807 *option
; /* Current parent option */
811 * Range check input...
814 if (!dest
|| num_dests
< 0 || !dests
)
818 * See if the destination already exists...
821 if ((new_dest
= cupsGetDest(dest
->name
, dest
->instance
, num_dests
,
825 * Protect against copying destination to itself...
828 if (new_dest
== dest
)
832 * Otherwise, free the options...
835 cupsFreeOptions(new_dest
->num_options
, new_dest
->options
);
837 new_dest
->num_options
= 0;
838 new_dest
->options
= NULL
;
841 new_dest
= cups_add_dest(dest
->name
, dest
->instance
, &num_dests
, dests
);
845 if ((new_dest
->options
= calloc(sizeof(cups_option_t
),
846 dest
->num_options
)) == NULL
)
847 return (cupsRemoveDest(dest
->name
, dest
->instance
, num_dests
, dests
));
849 new_dest
->num_options
= dest
->num_options
;
851 for (i
= dest
->num_options
, option
= dest
->options
,
852 new_option
= new_dest
->options
;
854 i
--, option
++, new_option
++)
856 new_option
->name
= _cupsStrRetain(option
->name
);
857 new_option
->value
= _cupsStrRetain(option
->value
);
866 * 'cupsEnumDests()' - Enumerate available destinations with a callback function.
868 * Destinations are enumerated from one or more sources. The callback function
869 * receives the @code user_data@ pointer, destination name, instance, number of
870 * options, and options which can be used as input to the @link cupsAddDest@
871 * function. The function must return 1 to continue enumeration or 0 to stop.
873 * Enumeration happens on the current thread and does not return until all
874 * destinations have been enumerated or the callback function returns 0.
876 * @since CUPS 1.6/OS X 10.8@
879 int /* O - 1 on success, 0 on failure */
881 unsigned flags
, /* I - Enumeration flags */
882 int msec
, /* I - Timeout in milliseconds,
883 * -1 for indefinite */
884 int *cancel
, /* I - Pointer to "cancel" variable */
885 cups_ptype_t type
, /* I - Printer type bits */
886 cups_ptype_t mask
, /* I - Mask for printer type bits */
887 cups_dest_cb_t cb
, /* I - Callback function */
888 void *user_data
) /* I - User data */
890 int i
, /* Looping var */
891 num_dests
; /* Number of destinations */
892 cups_dest_t
*dests
= NULL
, /* Destinations */
893 *dest
; /* Current destination */
894 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
895 int count
, /* Number of queries started */
896 remaining
; /* Remainder of timeout */
897 _cups_dnssd_data_t data
; /* Data for callback */
898 _cups_dnssd_device_t
*device
; /* Current device */
900 int nfds
, /* Number of files responded */
901 main_fd
; /* File descriptor for lookups */
902 DNSServiceRef ipp_ref
, /* IPP browser */
903 local_ipp_ref
; /* Local IPP browser */
905 DNSServiceRef ipps_ref
, /* IPPS browser */
906 local_ipps_ref
; /* Local IPPS browser */
907 # endif /* HAVE_SSL */
909 struct pollfd pfd
; /* Polling data */
911 fd_set input
; /* Input set for select() */
912 struct timeval timeout
; /* Timeout for select() */
913 # endif /* HAVE_POLL */
914 # else /* HAVE_AVAHI */
915 int error
; /* Error value */
916 AvahiServiceBrowser
*ipp_ref
; /* IPP browser */
918 AvahiServiceBrowser
*ipps_ref
; /* IPPS browser */
919 # endif /* HAVE_SSL */
920 # endif /* HAVE_DNSSD */
921 #endif /* HAVE_DNSSD || HAVE_AVAHI */
924 * Range check input...
933 * Get the list of local printers and pass them to the callback function...
936 num_dests
= _cupsGetDests(CUPS_HTTP_DEFAULT
, CUPS_GET_PRINTERS
, NULL
, &dests
,
939 for (i
= num_dests
, dest
= dests
;
940 i
> 0 && (!cancel
|| !*cancel
);
942 if (!(*cb
)(user_data
, i
> 1 ? CUPS_DEST_FLAGS_MORE
: CUPS_DEST_FLAGS_NONE
,
946 cupsFreeDests(num_dests
, dests
);
948 if (i
> 0 || msec
== 0)
951 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
953 * Get Bonjour-shared printers...
958 data
.devices
= cupsArrayNew3((cups_array_func_t
)cups_dnssd_compare_devices
,
960 (cups_afree_func_t
)cups_dnssd_free_device
);
963 if (DNSServiceCreateConnection(&data
.main_ref
) != kDNSServiceErr_NoError
)
966 main_fd
= DNSServiceRefSockFD(data
.main_ref
);
968 ipp_ref
= data
.main_ref
;
969 DNSServiceBrowse(&ipp_ref
, kDNSServiceFlagsShareConnection
, 0,
971 (DNSServiceBrowseReply
)cups_dnssd_browse_cb
, &data
);
973 local_ipp_ref
= data
.main_ref
;
974 DNSServiceBrowse(&local_ipp_ref
, kDNSServiceFlagsShareConnection
,
975 kDNSServiceInterfaceIndexLocalOnly
,
977 (DNSServiceBrowseReply
)cups_dnssd_local_cb
, &data
);
980 ipps_ref
= data
.main_ref
;
981 DNSServiceBrowse(&ipps_ref
, kDNSServiceFlagsShareConnection
, 0,
983 (DNSServiceBrowseReply
)cups_dnssd_browse_cb
, &data
);
985 local_ipps_ref
= data
.main_ref
;
986 DNSServiceBrowse(&local_ipps_ref
, kDNSServiceFlagsShareConnection
,
987 kDNSServiceInterfaceIndexLocalOnly
,
989 (DNSServiceBrowseReply
)cups_dnssd_local_cb
, &data
);
990 # endif /* HAVE_SSL */
992 # else /* HAVE_AVAHI */
993 if ((data
.simple_poll
= avahi_simple_poll_new()) == NULL
)
995 DEBUG_puts("cupsEnumDests: Unable to create Avahi simple poll object.");
999 avahi_simple_poll_set_func(data
.simple_poll
, cups_dnssd_poll_cb
, &data
);
1001 data
.client
= avahi_client_new(avahi_simple_poll_get(data
.simple_poll
),
1002 0, cups_dnssd_client_cb
, &data
,
1006 DEBUG_puts("cupsEnumDests: Unable to create Avahi client.");
1007 avahi_simple_poll_free(data
.simple_poll
);
1011 ipp_ref
= avahi_service_browser_new(data
.client
, AVAHI_IF_UNSPEC
,
1012 AVAHI_PROTO_UNSPEC
, "_ipp._tcp", NULL
,
1013 0, cups_dnssd_browse_cb
, &data
);
1015 ipps_ref
= avahi_service_browser_new(data
.client
, AVAHI_IF_UNSPEC
,
1016 AVAHI_PROTO_UNSPEC
, "_ipps._tcp", NULL
,
1017 0, cups_dnssd_browse_cb
, &data
);
1018 # endif /* HAVE_SSL */
1019 # endif /* HAVE_DNSSD */
1022 remaining
= INT_MAX
;
1026 while (remaining
> 0 && (!cancel
|| !*cancel
))
1029 * Check for input...
1035 pfd
.events
= POLLIN
;
1037 nfds
= poll(&pfd
, 1, remaining
> 250 ? 250 : remaining
);
1041 FD_SET(main_fd
, &input
);
1044 timeout
.tv_usec
= remaining
> 250 ? 250000 : remaining
* 1000;
1046 nfds
= select(main_fd
+ 1, &input
, NULL
, NULL
, &timeout
);
1047 # endif /* HAVE_POLL */
1050 DNSServiceProcessResult(data
.main_ref
);
1054 # else /* HAVE_AVAHI */
1057 if ((error
= avahi_simple_poll_iterate(data
.simple_poll
, 250)) > 0)
1060 * We've been told to exit the loop. Perhaps the connection to
1069 # endif /* HAVE_DNSSD */
1071 for (device
= (_cups_dnssd_device_t
*)cupsArrayFirst(data
.devices
),
1074 device
= (_cups_dnssd_device_t
*)cupsArrayNext(data
.devices
))
1079 if (!device
->ref
&& device
->state
== _CUPS_DNSSD_NEW
)
1081 DEBUG_printf(("1cupsEnumDests: Querying '%s'.", device
->fullName
));
1084 device
->ref
= data
.main_ref
;
1086 if (DNSServiceQueryRecord(&(device
->ref
),
1087 kDNSServiceFlagsShareConnection
,
1088 0, device
->fullName
,
1089 kDNSServiceType_TXT
,
1090 kDNSServiceClass_IN
,
1091 (DNSServiceQueryRecordReply
)cups_dnssd_query_cb
,
1092 &data
) == kDNSServiceErr_NoError
)
1099 device
->state
= _CUPS_DNSSD_ERROR
;
1101 DEBUG_puts("1cupsEnumDests: Query failed.");
1104 # else /* HAVE_AVAHI */
1105 if ((device
->ref
= avahi_record_browser_new(data
.client
,
1112 cups_dnssd_query_cb
,
1119 device
->state
= _CUPS_DNSSD_ERROR
;
1121 DEBUG_printf(("1cupsEnumDests: Query failed: %s",
1122 avahi_strerror(avahi_client_errno(data
.client
))));
1124 # endif /* HAVE_DNSSD */
1126 else if (device
->ref
&& device
->state
== _CUPS_DNSSD_PENDING
)
1128 if ((device
->type
& mask
) == type
)
1130 if (!(*cb
)(user_data
, CUPS_DEST_FLAGS_NONE
, &device
->dest
))
1137 device
->state
= _CUPS_DNSSD_ACTIVE
;
1142 cupsArrayDelete(data
.devices
);
1145 DNSServiceRefDeallocate(ipp_ref
);
1146 DNSServiceRefDeallocate(local_ipp_ref
);
1149 DNSServiceRefDeallocate(ipp_ref
);
1150 DNSServiceRefDeallocate(local_ipp_ref
);
1151 # endif /* HAVE_SSL */
1153 DNSServiceRefDeallocate(data
.main_ref
);
1155 # else /* HAVE_AVAHI */
1156 avahi_service_browser_free(ipp_ref
);
1158 avahi_service_browser_free(ipps_ref
);
1159 # endif /* HAVE_SSL */
1161 avahi_client_free(data
.client
);
1162 avahi_simple_poll_free(data
.simple_poll
);
1163 # endif /* HAVE_DNSSD */
1164 #endif /* HAVE_DNSSD || HAVE_DNSSD */
1172 * 'cupsEnumDestsBlock()' - Enumerate available destinations with a block.
1174 * Destinations are enumerated from one or more sources. The block receives the
1175 * destination name, instance, number of options, and options which can be used
1176 * as input to the @link cupsAddDest@ function. The block must return 1 to
1177 * continue enumeration or 0 to stop.
1179 * Enumeration happens on the current thread and does not return until all
1180 * destinations have been enumerated or the block returns 0.
1182 * @since CUPS 1.6/OS X 10.8@
1185 int /* O - 1 on success, 0 on failure */
1187 unsigned flags
, /* I - Enumeration flags */
1188 int timeout
, /* I - Timeout in milliseconds, 0 for indefinite */
1189 int *cancel
, /* I - Pointer to "cancel" variable */
1190 cups_ptype_t type
, /* I - Printer type bits */
1191 cups_ptype_t mask
, /* I - Mask for printer type bits */
1192 cups_dest_block_t block
) /* I - Block */
1194 return (cupsEnumDests(flags
, timeout
, cancel
, type
, mask
,
1195 (cups_dest_cb_t
)cups_block_cb
, (void *)block
));
1197 # endif /* __BLOCKS__ */
1201 * 'cupsFreeDests()' - Free the memory used by the list of destinations.
1205 cupsFreeDests(int num_dests
, /* I - Number of destinations */
1206 cups_dest_t
*dests
) /* I - Destinations */
1208 int i
; /* Looping var */
1209 cups_dest_t
*dest
; /* Current destination */
1212 if (num_dests
== 0 || dests
== NULL
)
1215 for (i
= num_dests
, dest
= dests
; i
> 0; i
--, dest
++)
1217 _cupsStrFree(dest
->name
);
1218 _cupsStrFree(dest
->instance
);
1220 cupsFreeOptions(dest
->num_options
, dest
->options
);
1228 * 'cupsGetDest()' - Get the named destination from the list.
1230 * Use the @link cupsGetDests@ or @link cupsGetDests2@ functions to get a
1231 * list of supported destinations for the current user.
1234 cups_dest_t
* /* O - Destination pointer or @code NULL@ */
1235 cupsGetDest(const char *name
, /* I - Destination name or @code NULL@ for the default destination */
1236 const char *instance
, /* I - Instance name or @code NULL@ */
1237 int num_dests
, /* I - Number of destinations */
1238 cups_dest_t
*dests
) /* I - Destinations */
1240 int diff
, /* Result of comparison */
1241 match
; /* Matching index */
1244 if (num_dests
<= 0 || !dests
)
1250 * NULL name for default printer.
1253 while (num_dests
> 0)
1255 if (dests
->is_default
)
1265 * Lookup name and optionally the instance...
1268 match
= cups_find_dest(name
, instance
, num_dests
, dests
, -1, &diff
);
1271 return (dests
+ match
);
1279 * '_cupsGetDestResource()' - Get the resource path and URI for a destination.
1282 const char * /* O - Printer URI */
1283 _cupsGetDestResource(
1284 cups_dest_t
*dest
, /* I - Destination */
1285 char *resource
, /* I - Resource buffer */
1286 size_t resourcesize
) /* I - Size of resource buffer */
1288 const char *uri
; /* Printer URI */
1289 char scheme
[32], /* URI scheme */
1290 userpass
[256], /* Username and password (unused) */
1291 hostname
[256]; /* Hostname */
1292 int port
; /* Port number */
1296 * Range check input...
1299 if (!dest
|| !resource
|| resourcesize
< 1)
1304 _cupsSetError(IPP_INTERNAL_ERROR
, strerror(EINVAL
), 0);
1309 * Grab the printer URI...
1312 if ((uri
= cupsGetOption("printer-uri-supported", dest
->num_options
,
1313 dest
->options
)) == NULL
)
1318 _cupsSetError(IPP_INTERNAL_ERROR
, strerror(ENOENT
), 0);
1324 if (strstr(uri
, "._tcp"))
1326 if ((uri
= cups_dnssd_resolve(dest
, uri
, 5000, NULL
, NULL
, NULL
)) == NULL
)
1329 #endif /* HAVE_DNSSD */
1331 if (httpSeparateURI(HTTP_URI_CODING_ALL
, uri
, scheme
, sizeof(scheme
),
1332 userpass
, sizeof(userpass
), hostname
, sizeof(hostname
),
1333 &port
, resource
, resourcesize
) < HTTP_URI_OK
)
1335 _cupsSetError(IPP_INTERNAL_ERROR
, _("Bad printer URI."), 1);
1345 * '_cupsGetDests()' - Get destinations from a server.
1347 * "op" is CUPS_GET_PRINTERS to get a full list, CUPS_GET_DEFAULT to get the
1348 * system-wide default printer, or IPP_GET_PRINTER_ATTRIBUTES for a known
1351 * "name" is the name of an existing printer and is only used when "op" is
1352 * IPP_GET_PRINTER_ATTRIBUTES.
1354 * "dest" is initialized to point to the array of destinations.
1356 * 0 is returned if there are no printers, no default printer, or the named
1357 * printer does not exist, respectively.
1359 * Free the memory used by the destination array using the @link cupsFreeDests@
1362 * Note: On OS X this function also gets the default paper from the system
1363 * preferences (~/L/P/org.cups.PrintingPrefs.plist) and includes it in the
1364 * options array for each destination that supports it.
1367 int /* O - Number of destinations */
1368 _cupsGetDests(http_t
*http
, /* I - Connection to server or
1369 * @code CUPS_HTTP_DEFAULT@ */
1370 ipp_op_t op
, /* I - IPP operation */
1371 const char *name
, /* I - Name of destination */
1372 cups_dest_t
**dests
, /* IO - Destinations */
1373 cups_ptype_t type
, /* I - Printer type bits */
1374 cups_ptype_t mask
) /* I - Printer type mask */
1376 int num_dests
= 0; /* Number of destinations */
1377 cups_dest_t
*dest
; /* Current destination */
1378 ipp_t
*request
, /* IPP Request */
1379 *response
; /* IPP Response */
1380 ipp_attribute_t
*attr
; /* Current attribute */
1381 const char *printer_name
; /* printer-name attribute */
1382 char uri
[1024]; /* printer-uri value */
1383 int num_options
; /* Number of options */
1384 cups_option_t
*options
; /* Options */
1386 char media_default
[41]; /* Default paper size */
1387 #endif /* __APPLE__ */
1388 char optname
[1024], /* Option name */
1389 value
[2048], /* Option value */
1390 *ptr
; /* Pointer into name/value */
1391 static const char * const pattrs
[] = /* Attributes we're interested in */
1393 "auth-info-required",
1395 "job-sheets-default",
1396 "marker-change-time",
1398 "marker-high-levels",
1400 "marker-low-levels",
1406 #endif /* __APPLE__ */
1410 "printer-is-accepting-jobs",
1411 "printer-is-shared",
1413 "printer-make-and-model",
1414 "printer-mandatory-job-attributes",
1417 "printer-state-change-time",
1418 "printer-state-reasons",
1420 "printer-uri-supported"
1426 * Get the default paper size...
1429 appleGetPaperSize(media_default
, sizeof(media_default
));
1430 #endif /* __APPLE__ */
1433 * Build a CUPS_GET_PRINTERS or IPP_GET_PRINTER_ATTRIBUTES request, which
1434 * require the following attributes:
1436 * attributes-charset
1437 * attributes-natural-language
1438 * requesting-user-name
1439 * printer-uri [for IPP_GET_PRINTER_ATTRIBUTES]
1442 request
= ippNewRequest(op
);
1444 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
1445 "requested-attributes", sizeof(pattrs
) / sizeof(pattrs
[0]),
1448 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
1449 "requesting-user-name", NULL
, cupsUser());
1451 if (name
&& op
!= CUPS_GET_DEFAULT
)
1453 httpAssembleURIf(HTTP_URI_CODING_ALL
, uri
, sizeof(uri
), "ipp", NULL
,
1454 "localhost", ippPort(), "/printers/%s", name
);
1455 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri", NULL
,
1460 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_ENUM
, "printer-type",
1462 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_ENUM
, "printer-type-mask",
1467 * Do the request and get back a response...
1470 if ((response
= cupsDoRequest(http
, request
, "/")) != NULL
)
1472 for (attr
= response
->attrs
; attr
!= NULL
; attr
= attr
->next
)
1475 * Skip leading attributes until we hit a printer...
1478 while (attr
!= NULL
&& attr
->group_tag
!= IPP_TAG_PRINTER
)
1485 * Pull the needed attributes from this printer...
1488 printer_name
= NULL
;
1492 for (; attr
&& attr
->group_tag
== IPP_TAG_PRINTER
; attr
= attr
->next
)
1494 if (attr
->value_tag
!= IPP_TAG_INTEGER
&&
1495 attr
->value_tag
!= IPP_TAG_ENUM
&&
1496 attr
->value_tag
!= IPP_TAG_BOOLEAN
&&
1497 attr
->value_tag
!= IPP_TAG_TEXT
&&
1498 attr
->value_tag
!= IPP_TAG_TEXTLANG
&&
1499 attr
->value_tag
!= IPP_TAG_NAME
&&
1500 attr
->value_tag
!= IPP_TAG_NAMELANG
&&
1501 attr
->value_tag
!= IPP_TAG_KEYWORD
&&
1502 attr
->value_tag
!= IPP_TAG_RANGE
&&
1503 attr
->value_tag
!= IPP_TAG_URI
)
1506 if (!strcmp(attr
->name
, "auth-info-required") ||
1507 !strcmp(attr
->name
, "device-uri") ||
1508 !strcmp(attr
->name
, "marker-change-time") ||
1509 !strcmp(attr
->name
, "marker-colors") ||
1510 !strcmp(attr
->name
, "marker-high-levels") ||
1511 !strcmp(attr
->name
, "marker-levels") ||
1512 !strcmp(attr
->name
, "marker-low-levels") ||
1513 !strcmp(attr
->name
, "marker-message") ||
1514 !strcmp(attr
->name
, "marker-names") ||
1515 !strcmp(attr
->name
, "marker-types") ||
1516 !strcmp(attr
->name
, "printer-commands") ||
1517 !strcmp(attr
->name
, "printer-info") ||
1518 !strcmp(attr
->name
, "printer-is-shared") ||
1519 !strcmp(attr
->name
, "printer-make-and-model") ||
1520 !strcmp(attr
->name
, "printer-mandatory-job-attributes") ||
1521 !strcmp(attr
->name
, "printer-state") ||
1522 !strcmp(attr
->name
, "printer-state-change-time") ||
1523 !strcmp(attr
->name
, "printer-type") ||
1524 !strcmp(attr
->name
, "printer-is-accepting-jobs") ||
1525 !strcmp(attr
->name
, "printer-location") ||
1526 !strcmp(attr
->name
, "printer-state-reasons") ||
1527 !strcmp(attr
->name
, "printer-uri-supported"))
1530 * Add a printer description attribute...
1533 num_options
= cupsAddOption(attr
->name
,
1534 cups_make_string(attr
, value
,
1536 num_options
, &options
);
1539 else if (!strcmp(attr
->name
, "media-supported"))
1542 * See if we can set a default media size...
1545 int i
; /* Looping var */
1547 for (i
= 0; i
< attr
->num_values
; i
++)
1548 if (!_cups_strcasecmp(media_default
, attr
->values
[i
].string
.text
))
1550 num_options
= cupsAddOption("media", media_default
, num_options
,
1555 #endif /* __APPLE__ */
1556 else if (!strcmp(attr
->name
, "printer-name") &&
1557 attr
->value_tag
== IPP_TAG_NAME
)
1558 printer_name
= attr
->values
[0].string
.text
;
1559 else if (strncmp(attr
->name
, "notify-", 7) &&
1560 (attr
->value_tag
== IPP_TAG_BOOLEAN
||
1561 attr
->value_tag
== IPP_TAG_ENUM
||
1562 attr
->value_tag
== IPP_TAG_INTEGER
||
1563 attr
->value_tag
== IPP_TAG_KEYWORD
||
1564 attr
->value_tag
== IPP_TAG_NAME
||
1565 attr
->value_tag
== IPP_TAG_RANGE
) &&
1566 (ptr
= strstr(attr
->name
, "-default")) != NULL
)
1569 * Add a default option...
1572 strlcpy(optname
, attr
->name
, sizeof(optname
));
1573 optname
[ptr
- attr
->name
] = '\0';
1575 if (_cups_strcasecmp(optname
, "media") ||
1576 !cupsGetOption("media", num_options
, options
))
1577 num_options
= cupsAddOption(optname
,
1578 cups_make_string(attr
, value
,
1580 num_options
, &options
);
1585 * See if we have everything needed...
1590 cupsFreeOptions(num_options
, options
);
1598 if ((dest
= cups_add_dest(printer_name
, NULL
, &num_dests
, dests
)) != NULL
)
1600 dest
->num_options
= num_options
;
1601 dest
->options
= options
;
1604 cupsFreeOptions(num_options
, options
);
1610 ippDelete(response
);
1614 * Return the count...
1622 * 'cupsGetDests()' - Get the list of destinations from the default server.
1624 * Starting with CUPS 1.2, the returned list of destinations include the
1625 * printer-info, printer-is-accepting-jobs, printer-is-shared,
1626 * printer-make-and-model, printer-state, printer-state-change-time,
1627 * printer-state-reasons, and printer-type attributes as options. CUPS 1.4
1628 * adds the marker-change-time, marker-colors, marker-high-levels,
1629 * marker-levels, marker-low-levels, marker-message, marker-names,
1630 * marker-types, and printer-commands attributes as well.
1632 * Use the @link cupsFreeDests@ function to free the destination list and
1633 * the @link cupsGetDest@ function to find a particular destination.
1636 int /* O - Number of destinations */
1637 cupsGetDests(cups_dest_t
**dests
) /* O - Destinations */
1639 return (cupsGetDests2(CUPS_HTTP_DEFAULT
, dests
));
1644 * 'cupsGetDests2()' - Get the list of destinations from the specified server.
1646 * Starting with CUPS 1.2, the returned list of destinations include the
1647 * printer-info, printer-is-accepting-jobs, printer-is-shared,
1648 * printer-make-and-model, printer-state, printer-state-change-time,
1649 * printer-state-reasons, and printer-type attributes as options. CUPS 1.4
1650 * adds the marker-change-time, marker-colors, marker-high-levels,
1651 * marker-levels, marker-low-levels, marker-message, marker-names,
1652 * marker-types, and printer-commands attributes as well.
1654 * Use the @link cupsFreeDests@ function to free the destination list and
1655 * the @link cupsGetDest@ function to find a particular destination.
1657 * @since CUPS 1.1.21/OS X 10.4@
1660 int /* O - Number of destinations */
1661 cupsGetDests2(http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
1662 cups_dest_t
**dests
) /* O - Destinations */
1664 int i
; /* Looping var */
1665 int num_dests
; /* Number of destinations */
1666 cups_dest_t
*dest
; /* Destination pointer */
1667 const char *home
; /* HOME environment variable */
1668 char filename
[1024]; /* Local ~/.cups/lpoptions file */
1669 const char *defprinter
; /* Default printer */
1670 char name
[1024], /* Copy of printer name */
1671 *instance
, /* Pointer to instance name */
1672 *user_default
; /* User default printer */
1673 int num_reals
; /* Number of real queues */
1674 cups_dest_t
*reals
; /* Real queues */
1675 _cups_globals_t
*cg
= _cupsGlobals(); /* Pointer to library globals */
1679 * Range check the input...
1684 _cupsSetError(IPP_INTERNAL_ERROR
, _("Bad NULL dests pointer"), 1);
1689 * Grab the printers and classes...
1692 *dests
= (cups_dest_t
*)0;
1693 num_dests
= _cupsGetDests(http
, CUPS_GET_PRINTERS
, NULL
, dests
, 0, 0);
1695 if (cupsLastError() >= IPP_REDIRECTION_OTHER_SITE
)
1697 cupsFreeDests(num_dests
, *dests
);
1698 *dests
= (cups_dest_t
*)0;
1703 * Make a copy of the "real" queues for a later sanity check...
1708 num_reals
= num_dests
;
1709 reals
= calloc(num_reals
, sizeof(cups_dest_t
));
1712 memcpy(reals
, *dests
, num_reals
* sizeof(cups_dest_t
));
1723 * Grab the default destination...
1726 if ((user_default
= _cupsUserDefault(name
, sizeof(name
))) != NULL
)
1728 else if ((defprinter
= cupsGetDefault2(http
)) != NULL
)
1730 strlcpy(name
, defprinter
, sizeof(name
));
1737 * Separate printer and instance name...
1740 if ((instance
= strchr(name
, '/')) != NULL
)
1744 * Lookup the printer and instance and make it the default...
1747 if ((dest
= cupsGetDest(name
, instance
, num_dests
, *dests
)) != NULL
)
1748 dest
->is_default
= 1;
1754 * Load the /etc/cups/lpoptions and ~/.cups/lpoptions files...
1757 snprintf(filename
, sizeof(filename
), "%s/lpoptions", cg
->cups_serverroot
);
1758 num_dests
= cups_get_dests(filename
, NULL
, NULL
, user_default
!= NULL
,
1761 if ((home
= getenv("HOME")) != NULL
)
1763 snprintf(filename
, sizeof(filename
), "%s/.cups/lpoptions", home
);
1765 num_dests
= cups_get_dests(filename
, NULL
, NULL
, user_default
!= NULL
,
1770 * Validate the current default destination - this prevents old
1771 * Default lines in /etc/cups/lpoptions and ~/.cups/lpoptions from
1772 * pointing to a non-existent printer or class...
1778 * See if we have a default printer...
1781 if ((dest
= cupsGetDest(NULL
, NULL
, num_dests
, *dests
)) != NULL
)
1784 * Have a default; see if it is real...
1787 dest
= cupsGetDest(dest
->name
, NULL
, num_reals
, reals
);
1791 * If dest is NULL, then no default (that exists) is set, so we
1792 * need to set a default if one exists...
1795 if (!dest
&& *dests
&& defprinter
)
1797 for (i
= 0; i
< num_dests
; i
++)
1798 (*dests
)[i
].is_default
= 0;
1800 if ((dest
= cupsGetDest(name
, instance
, num_dests
, *dests
)) != NULL
)
1801 dest
->is_default
= 1;
1812 * Return the number of destinations...
1816 _cupsSetError(IPP_OK
, NULL
, 0);
1823 * 'cupsGetNamedDest()' - Get options for the named destination.
1825 * This function is optimized for retrieving a single destination and should
1826 * be used instead of @link cupsGetDests@ and @link cupsGetDest@ when you either
1827 * know the name of the destination or want to print to the default destination.
1828 * If @code NULL@ is returned, the destination does not exist or there is no
1829 * default destination.
1831 * If "http" is @code CUPS_HTTP_DEFAULT@, the connection to the default print
1832 * server will be used.
1834 * If "name" is @code NULL@, the default printer for the current user will be
1837 * The returned destination must be freed using @link cupsFreeDests@ with a
1838 * "num_dests" value of 1.
1840 * @since CUPS 1.4/OS X 10.6@
1843 cups_dest_t
* /* O - Destination or @code NULL@ */
1844 cupsGetNamedDest(http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
1845 const char *name
, /* I - Destination name or @code NULL@ for the default destination */
1846 const char *instance
) /* I - Instance name or @code NULL@ */
1848 cups_dest_t
*dest
; /* Destination */
1849 char filename
[1024], /* Path to lpoptions */
1850 defname
[256]; /* Default printer name */
1851 const char *home
= getenv("HOME"); /* Home directory */
1852 int set_as_default
= 0; /* Set returned destination as default */
1853 ipp_op_t op
= IPP_GET_PRINTER_ATTRIBUTES
;
1854 /* IPP operation to get server ops */
1855 _cups_globals_t
*cg
= _cupsGlobals(); /* Pointer to library globals */
1859 * If "name" is NULL, find the default destination...
1865 name
= _cupsUserDefault(defname
, sizeof(defname
));
1869 char *ptr
; /* Temporary pointer... */
1871 if ((ptr
= strchr(defname
, '/')) != NULL
)
1882 * No default in the environment, try the user's lpoptions files...
1885 snprintf(filename
, sizeof(filename
), "%s/.cups/lpoptions", home
);
1887 name
= cups_get_default(filename
, defname
, sizeof(defname
), &instance
);
1893 * Still not there? Try the system lpoptions file...
1896 snprintf(filename
, sizeof(filename
), "%s/lpoptions",
1897 cg
->cups_serverroot
);
1898 name
= cups_get_default(filename
, defname
, sizeof(defname
), &instance
);
1904 * No locally-set default destination, ask the server...
1907 op
= CUPS_GET_DEFAULT
;
1912 * Get the printer's attributes...
1915 if (!_cupsGetDests(http
, op
, name
, &dest
, 0, 0))
1917 if (op
== CUPS_GET_DEFAULT
|| (name
&& !set_as_default
))
1921 * The default printer from environment variables or from a
1922 * configuration file does not exist. Find out the real default.
1925 if (!_cupsGetDests(http
, CUPS_GET_DEFAULT
, NULL
, &dest
, 0, 0))
1930 dest
->instance
= _cupsStrAlloc(instance
);
1933 dest
->is_default
= 1;
1936 * Then add local options...
1939 snprintf(filename
, sizeof(filename
), "%s/lpoptions", cg
->cups_serverroot
);
1940 cups_get_dests(filename
, name
, instance
, 1, 1, &dest
);
1944 snprintf(filename
, sizeof(filename
), "%s/.cups/lpoptions", home
);
1946 cups_get_dests(filename
, name
, instance
, 1, 1, &dest
);
1950 * Return the result...
1958 * 'cupsRemoveDest()' - Remove a destination from the destination list.
1960 * Removing a destination/instance does not delete the class or printer
1961 * queue, merely the lpoptions for that destination/instance. Use the
1962 * @link cupsSetDests@ or @link cupsSetDests2@ functions to save the new
1963 * options for the user.
1965 * @since CUPS 1.3/OS X 10.5@
1968 int /* O - New number of destinations */
1969 cupsRemoveDest(const char *name
, /* I - Destination name */
1970 const char *instance
, /* I - Instance name or @code NULL@ */
1971 int num_dests
, /* I - Number of destinations */
1972 cups_dest_t
**dests
) /* IO - Destinations */
1974 int i
; /* Index into destinations */
1975 cups_dest_t
*dest
; /* Pointer to destination */
1979 * Find the destination...
1982 if ((dest
= cupsGetDest(name
, instance
, num_dests
, *dests
)) == NULL
)
1989 _cupsStrFree(dest
->name
);
1990 _cupsStrFree(dest
->instance
);
1991 cupsFreeOptions(dest
->num_options
, dest
->options
);
1994 * Remove the destination from the array...
2002 memmove(dest
, dest
+ 1, (num_dests
- i
) * sizeof(cups_dest_t
));
2009 * 'cupsSetDefaultDest()' - Set the default destination.
2011 * @since CUPS 1.3/OS X 10.5@
2016 const char *name
, /* I - Destination name */
2017 const char *instance
, /* I - Instance name or @code NULL@ */
2018 int num_dests
, /* I - Number of destinations */
2019 cups_dest_t
*dests
) /* I - Destinations */
2021 int i
; /* Looping var */
2022 cups_dest_t
*dest
; /* Current destination */
2026 * Range check input...
2029 if (!name
|| num_dests
<= 0 || !dests
)
2033 * Loop through the array and set the "is_default" flag for the matching
2037 for (i
= num_dests
, dest
= dests
; i
> 0; i
--, dest
++)
2038 dest
->is_default
= !_cups_strcasecmp(name
, dest
->name
) &&
2039 ((!instance
&& !dest
->instance
) ||
2040 (instance
&& dest
->instance
&&
2041 !_cups_strcasecmp(instance
, dest
->instance
)));
2046 * 'cupsSetDests()' - Save the list of destinations for the default server.
2048 * This function saves the destinations to /etc/cups/lpoptions when run
2049 * as root and ~/.cups/lpoptions when run as a normal user.
2053 cupsSetDests(int num_dests
, /* I - Number of destinations */
2054 cups_dest_t
*dests
) /* I - Destinations */
2056 cupsSetDests2(CUPS_HTTP_DEFAULT
, num_dests
, dests
);
2061 * 'cupsSetDests2()' - Save the list of destinations for the specified server.
2063 * This function saves the destinations to /etc/cups/lpoptions when run
2064 * as root and ~/.cups/lpoptions when run as a normal user.
2066 * @since CUPS 1.1.21/OS X 10.4@
2069 int /* O - 0 on success, -1 on error */
2070 cupsSetDests2(http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
2071 int num_dests
, /* I - Number of destinations */
2072 cups_dest_t
*dests
) /* I - Destinations */
2074 int i
, j
; /* Looping vars */
2075 int wrote
; /* Wrote definition? */
2076 cups_dest_t
*dest
; /* Current destination */
2077 cups_option_t
*option
; /* Current option */
2078 _ipp_option_t
*match
; /* Matching attribute for option */
2079 FILE *fp
; /* File pointer */
2081 const char *home
; /* HOME environment variable */
2083 char filename
[1024]; /* lpoptions file */
2084 int num_temps
; /* Number of temporary destinations */
2085 cups_dest_t
*temps
= NULL
, /* Temporary destinations */
2086 *temp
; /* Current temporary dest */
2087 const char *val
; /* Value of temporary option */
2088 _cups_globals_t
*cg
= _cupsGlobals(); /* Pointer to library globals */
2092 * Range check the input...
2095 if (!num_dests
|| !dests
)
2099 * Get the server destinations...
2102 num_temps
= _cupsGetDests(http
, CUPS_GET_PRINTERS
, NULL
, &temps
, 0, 0);
2104 if (cupsLastError() >= IPP_REDIRECTION_OTHER_SITE
)
2106 cupsFreeDests(num_temps
, temps
);
2111 * Figure out which file to write to...
2114 snprintf(filename
, sizeof(filename
), "%s/lpoptions", cg
->cups_serverroot
);
2120 * Merge in server defaults...
2123 num_temps
= cups_get_dests(filename
, NULL
, NULL
, 0, num_temps
, &temps
);
2126 * Point to user defaults...
2129 if ((home
= getenv("HOME")) != NULL
)
2132 * Create ~/.cups subdirectory...
2135 snprintf(filename
, sizeof(filename
), "%s/.cups", home
);
2136 if (access(filename
, 0))
2137 mkdir(filename
, 0700);
2139 snprintf(filename
, sizeof(filename
), "%s/.cups/lpoptions", home
);
2145 * Try to open the file...
2148 if ((fp
= fopen(filename
, "w")) == NULL
)
2150 cupsFreeDests(num_temps
, temps
);
2156 * Set the permissions to 0644 when saving to the /etc/cups/lpoptions
2161 fchmod(fileno(fp
), 0644);
2165 * Write each printer; each line looks like:
2167 * Dest name[/instance] options
2168 * Default name[/instance] options
2171 for (i
= num_dests
, dest
= dests
; i
> 0; i
--, dest
++)
2172 if (dest
->instance
!= NULL
|| dest
->num_options
!= 0 || dest
->is_default
)
2174 if (dest
->is_default
)
2176 fprintf(fp
, "Default %s", dest
->name
);
2178 fprintf(fp
, "/%s", dest
->instance
);
2185 if ((temp
= cupsGetDest(dest
->name
, dest
->instance
, num_temps
, temps
)) == NULL
)
2186 temp
= cupsGetDest(dest
->name
, NULL
, num_temps
, temps
);
2188 for (j
= dest
->num_options
, option
= dest
->options
; j
> 0; j
--, option
++)
2191 * See if this option is a printer attribute; if so, skip it...
2194 if ((match
= _ippFindOption(option
->name
)) != NULL
&&
2195 match
->group_tag
== IPP_TAG_PRINTER
)
2199 * See if the server/global options match these; if so, don't
2204 (val
= cupsGetOption(option
->name
, temp
->num_options
,
2205 temp
->options
)) != NULL
&&
2206 !_cups_strcasecmp(val
, option
->value
))
2210 * Options don't match, write to the file...
2215 fprintf(fp
, "Dest %s", dest
->name
);
2217 fprintf(fp
, "/%s", dest
->instance
);
2221 if (option
->value
[0])
2223 if (strchr(option
->value
, ' ') ||
2224 strchr(option
->value
, '\\') ||
2225 strchr(option
->value
, '\"') ||
2226 strchr(option
->value
, '\''))
2229 * Quote the value...
2232 fprintf(fp
, " %s=\"", option
->name
);
2234 for (val
= option
->value
; *val
; val
++)
2236 if (strchr("\"\'\\", *val
))
2247 * Store the literal value...
2250 fprintf(fp
, " %s=%s", option
->name
, option
->value
);
2254 fprintf(fp
, " %s", option
->name
);
2262 * Free the temporary destinations and close the file...
2265 cupsFreeDests(num_temps
, temps
);
2271 * Set the default printer for this location - this allows command-line
2272 * and GUI applications to share the same default destination...
2275 if ((dest
= cupsGetDest(NULL
, NULL
, num_dests
, dests
)) != NULL
)
2277 CFStringRef name
= CFStringCreateWithCString(kCFAllocatorDefault
,
2279 kCFStringEncodingUTF8
);
2280 /* Default printer name */
2284 _cupsAppleSetDefaultPrinter(name
);
2288 #endif /* __APPLE__ */
2290 #ifdef HAVE_NOTIFY_POST
2292 * Send a notification so that MacOS X applications can know about the
2296 notify_post("com.apple.printerListChange");
2297 #endif /* HAVE_NOTIFY_POST */
2304 * '_cupsUserDefault()' - Get the user default printer from environment
2305 * variables and location information.
2308 char * /* O - Default printer or NULL */
2309 _cupsUserDefault(char *name
, /* I - Name buffer */
2310 size_t namesize
) /* I - Size of name buffer */
2312 const char *env
; /* LPDEST or PRINTER env variable */
2314 CFStringRef locprinter
; /* Last printer as this location */
2315 #endif /* __APPLE__ */
2318 if ((env
= getenv("LPDEST")) == NULL
)
2319 if ((env
= getenv("PRINTER")) != NULL
&& !strcmp(env
, "lp"))
2324 strlcpy(name
, env
, namesize
);
2330 * Use location-based defaults if "use last printer" is selected in the
2331 * system preferences...
2334 if ((locprinter
= _cupsAppleCopyDefaultPrinter()) != NULL
)
2336 CFStringGetCString(locprinter
, name
, namesize
, kCFStringEncodingUTF8
);
2337 CFRelease(locprinter
);
2342 DEBUG_printf(("1_cupsUserDefault: Returning \"%s\".", name
));
2344 return (*name
? name
: NULL
);
2348 * No location-based defaults on this platform...
2353 #endif /* __APPLE__ */
2359 * 'appleCopyLocations()' - Copy the location history array.
2362 static CFArrayRef
/* O - Location array or NULL */
2363 appleCopyLocations(void)
2365 CFArrayRef locations
; /* Location array */
2369 * Look up the location array in the preferences...
2372 if ((locations
= CFPreferencesCopyAppValue(kLastUsedPrintersKey
,
2373 kCUPSPrintingPrefs
)) == NULL
)
2376 if (CFGetTypeID(locations
) != CFArrayGetTypeID())
2378 CFRelease(locations
);
2387 * 'appleCopyNetwork()' - Get the network ID for the current location.
2390 static CFStringRef
/* O - Network ID */
2391 appleCopyNetwork(void)
2393 SCDynamicStoreRef dynamicStore
; /* System configuration data */
2394 CFStringRef key
; /* Current network configuration key */
2395 CFDictionaryRef ip_dict
; /* Network configuration data */
2396 CFStringRef network
= NULL
; /* Current network ID */
2399 if ((dynamicStore
= SCDynamicStoreCreate(NULL
, CFSTR("libcups"), NULL
,
2403 * First use the IPv6 router address, if available, since that will generally
2404 * be a globally-unique link-local address.
2407 if ((key
= SCDynamicStoreKeyCreateNetworkGlobalEntity(
2408 NULL
, kSCDynamicStoreDomainState
, kSCEntNetIPv6
)) != NULL
)
2410 if ((ip_dict
= SCDynamicStoreCopyValue(dynamicStore
, key
)) != NULL
)
2412 if ((network
= CFDictionaryGetValue(ip_dict
,
2413 kSCPropNetIPv6Router
)) != NULL
)
2423 * If that doesn't work, try the IPv4 router address. This isn't as unique
2424 * and will likely be a 10.x.y.z or 192.168.y.z address...
2429 if ((key
= SCDynamicStoreKeyCreateNetworkGlobalEntity(
2430 NULL
, kSCDynamicStoreDomainState
, kSCEntNetIPv4
)) != NULL
)
2432 if ((ip_dict
= SCDynamicStoreCopyValue(dynamicStore
, key
)) != NULL
)
2434 if ((network
= CFDictionaryGetValue(ip_dict
,
2435 kSCPropNetIPv4Router
)) != NULL
)
2445 CFRelease(dynamicStore
);
2453 * 'appleGetPaperSize()' - Get the default paper size.
2456 static char * /* O - Default paper size */
2457 appleGetPaperSize(char *name
, /* I - Paper size name buffer */
2458 int namesize
) /* I - Size of buffer */
2460 CFStringRef defaultPaperID
; /* Default paper ID */
2461 _pwg_media_t
*pwgmedia
; /* PWG media size */
2464 defaultPaperID
= _cupsAppleCopyDefaultPaperID();
2465 if (!defaultPaperID
||
2466 CFGetTypeID(defaultPaperID
) != CFStringGetTypeID() ||
2467 !CFStringGetCString(defaultPaperID
, name
, namesize
,
2468 kCFStringEncodingUTF8
))
2470 else if ((pwgmedia
= _pwgMediaForLegacy(name
)) != NULL
)
2471 strlcpy(name
, pwgmedia
->pwg
, namesize
);
2474 CFRelease(defaultPaperID
);
2481 * 'appleGetPrinter()' - Get a printer from the history array.
2484 static CFStringRef
/* O - Printer name or NULL */
2485 appleGetPrinter(CFArrayRef locations
, /* I - Location array */
2486 CFStringRef network
, /* I - Network name */
2487 CFIndex
*locindex
) /* O - Index in array */
2489 CFIndex i
, /* Looping var */
2490 count
; /* Number of locations */
2491 CFDictionaryRef location
; /* Current location */
2492 CFStringRef locnetwork
, /* Current network */
2493 locprinter
; /* Current printer */
2496 for (i
= 0, count
= CFArrayGetCount(locations
); i
< count
; i
++)
2497 if ((location
= CFArrayGetValueAtIndex(locations
, i
)) != NULL
&&
2498 CFGetTypeID(location
) == CFDictionaryGetTypeID())
2500 if ((locnetwork
= CFDictionaryGetValue(location
,
2501 kLocationNetworkKey
)) != NULL
&&
2502 CFGetTypeID(locnetwork
) == CFStringGetTypeID() &&
2503 CFStringCompare(network
, locnetwork
, 0) == kCFCompareEqualTo
&&
2504 (locprinter
= CFDictionaryGetValue(location
,
2505 kLocationPrinterIDKey
)) != NULL
&&
2506 CFGetTypeID(locprinter
) == CFStringGetTypeID())
2511 return (locprinter
);
2517 #endif /* __APPLE__ */
2521 * 'cups_add_dest()' - Add a destination to the array.
2523 * Unlike cupsAddDest(), this function does not check for duplicates.
2526 static cups_dest_t
* /* O - New destination */
2527 cups_add_dest(const char *name
, /* I - Name of destination */
2528 const char *instance
, /* I - Instance or NULL */
2529 int *num_dests
, /* IO - Number of destinations */
2530 cups_dest_t
**dests
) /* IO - Destinations */
2532 int insert
, /* Insertion point */
2533 diff
; /* Result of comparison */
2534 cups_dest_t
*dest
; /* Destination pointer */
2538 * Add new destination...
2541 if (*num_dests
== 0)
2542 dest
= malloc(sizeof(cups_dest_t
));
2544 dest
= realloc(*dests
, sizeof(cups_dest_t
) * (*num_dests
+ 1));
2552 * Find where to insert the destination...
2555 if (*num_dests
== 0)
2559 insert
= cups_find_dest(name
, instance
, *num_dests
, *dests
, *num_dests
- 1,
2567 * Move the array elements as needed...
2570 if (insert
< *num_dests
)
2571 memmove(*dests
+ insert
+ 1, *dests
+ insert
,
2572 (*num_dests
- insert
) * sizeof(cups_dest_t
));
2577 * Initialize the destination...
2580 dest
= *dests
+ insert
;
2581 dest
->name
= _cupsStrAlloc(name
);
2582 dest
->instance
= _cupsStrAlloc(instance
);
2583 dest
->is_default
= 0;
2584 dest
->num_options
= 0;
2585 dest
->options
= (cups_option_t
*)0;
2593 * 'cups_block_cb()' - Enumeration callback for block API.
2596 static int /* O - 1 to continue, 0 to stop */
2598 cups_dest_block_t block
, /* I - Block */
2599 unsigned flags
, /* I - Destination flags */
2600 cups_dest_t
*dest
) /* I - Destination */
2602 return ((block
)(flags
, dest
));
2604 # endif /* __BLOCKS__ */
2608 * 'cups_compare_dests()' - Compare two destinations.
2611 static int /* O - Result of comparison */
2612 cups_compare_dests(cups_dest_t
*a
, /* I - First destination */
2613 cups_dest_t
*b
) /* I - Second destination */
2615 int diff
; /* Difference */
2618 if ((diff
= _cups_strcasecmp(a
->name
, b
->name
)) != 0)
2620 else if (a
->instance
&& b
->instance
)
2621 return (_cups_strcasecmp(a
->instance
, b
->instance
));
2623 return ((a
->instance
&& !b
->instance
) - (!a
->instance
&& b
->instance
));
2627 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
2630 * 'cups_dnssd_browse_cb()' - Browse for printers.
2634 cups_dnssd_browse_cb(
2635 DNSServiceRef sdRef
, /* I - Service reference */
2636 DNSServiceFlags flags
, /* I - Option flags */
2637 uint32_t interfaceIndex
, /* I - Interface number */
2638 DNSServiceErrorType errorCode
, /* I - Error, if any */
2639 const char *serviceName
, /* I - Name of service/device */
2640 const char *regtype
, /* I - Type of service */
2641 const char *replyDomain
, /* I - Service domain */
2642 void *context
) /* I - Enumeration data */
2644 _cups_dnssd_data_t
*data
= (_cups_dnssd_data_t
*)context
;
2645 /* Enumeration data */
2648 DEBUG_printf(("5cups_dnssd_browse_cb(sdRef=%p, flags=%x, "
2649 "interfaceIndex=%d, errorCode=%d, serviceName=\"%s\", "
2650 "regtype=\"%s\", replyDomain=\"%s\", context=%p)",
2651 sdRef
, flags
, interfaceIndex
, errorCode
, serviceName
, regtype
,
2652 replyDomain
, context
));
2655 * Don't do anything on error...
2658 if (errorCode
!= kDNSServiceErr_NoError
)
2665 cups_dnssd_get_device(data
, serviceName
, regtype
, replyDomain
);
2669 # else /* HAVE_AVAHI */
2671 * 'cups_dnssd_browse_cb()' - Browse for printers.
2675 cups_dnssd_browse_cb(
2676 AvahiServiceBrowser
*browser
, /* I - Browser */
2677 AvahiIfIndex interface
, /* I - Interface index (unused) */
2678 AvahiProtocol protocol
, /* I - Network protocol (unused) */
2679 AvahiBrowserEvent event
, /* I - What happened */
2680 const char *name
, /* I - Service name */
2681 const char *type
, /* I - Registration type */
2682 const char *domain
, /* I - Domain */
2683 AvahiLookupResultFlags flags
, /* I - Flags */
2684 void *context
) /* I - Devices array */
2687 AvahiClient
*client
= avahi_service_browser_get_client(browser
);
2688 /* Client information */
2690 _cups_dnssd_data_t
*data
= (_cups_dnssd_data_t
*)context
;
2691 /* Enumeration data */
2700 case AVAHI_BROWSER_FAILURE
:
2701 DEBUG_printf(("cups_dnssd_browse_cb: %s",
2702 avahi_strerror(avahi_client_errno(client
))));
2703 avahi_simple_poll_quit(data
->simple_poll
);
2706 case AVAHI_BROWSER_NEW
:
2708 * This object is new on the network.
2711 if (flags
& AVAHI_LOOKUP_RESULT_LOCAL
)
2714 * This comes from the local machine so ignore it.
2717 DEBUG_printf(("cups_dnssd_browse_cb: Ignoring local service \"%s\".",
2723 * Create a device entry for it if it doesn't yet exist.
2726 cups_dnssd_get_device(data
, name
, type
, domain
);
2730 case AVAHI_BROWSER_REMOVE
:
2731 case AVAHI_BROWSER_ALL_FOR_NOW
:
2732 case AVAHI_BROWSER_CACHE_EXHAUSTED
:
2739 * 'cups_dnssd_client_cb()' - Avahi client callback function.
2743 cups_dnssd_client_cb(
2744 AvahiClient
*client
, /* I - Client information (unused) */
2745 AvahiClientState state
, /* I - Current state */
2746 void *context
) /* I - User data (unused) */
2748 _cups_dnssd_data_t
*data
= (_cups_dnssd_data_t
*)context
;
2749 /* Enumeration data */
2755 * If the connection drops, quit.
2758 if (state
== AVAHI_CLIENT_FAILURE
)
2760 DEBUG_puts("cups_dnssd_client_cb: Avahi connection failed.");
2761 avahi_simple_poll_quit(data
->simple_poll
);
2764 # endif /* HAVE_DNSSD */
2768 * 'cups_dnssd_compare_device()' - Compare two devices.
2771 static int /* O - Result of comparison */
2772 cups_dnssd_compare_devices(
2773 _cups_dnssd_device_t
*a
, /* I - First device */
2774 _cups_dnssd_device_t
*b
) /* I - Second device */
2776 return (strcmp(a
->dest
.name
, b
->dest
.name
));
2781 * 'cups_dnssd_free_device()' - Free the memory used by a device.
2785 cups_dnssd_free_device(
2786 _cups_dnssd_device_t
*device
, /* I - Device */
2787 _cups_dnssd_data_t
*data
) /* I - Enumeration data */
2789 DEBUG_printf(("5cups_dnssd_free_device(device=%p(%s), data=%p)", device
,
2790 device
->dest
.name
, data
));
2794 DNSServiceRefDeallocate(device
->ref
);
2795 # else /* HAVE_AVAHI */
2797 avahi_record_browser_free(device
->ref
);
2798 # endif /* HAVE_DNSSD */
2800 _cupsStrFree(device
->domain
);
2801 _cupsStrFree(device
->fullName
);
2802 _cupsStrFree(device
->regtype
);
2803 _cupsStrFree(device
->dest
.name
);
2805 cupsFreeOptions(device
->dest
.num_options
, device
->dest
.options
);
2812 * 'cups_dnssd_get_device()' - Lookup a device and create it as needed.
2815 static _cups_dnssd_device_t
* /* O - Device */
2816 cups_dnssd_get_device(
2817 _cups_dnssd_data_t
*data
, /* I - Enumeration data */
2818 const char *serviceName
, /* I - Service name */
2819 const char *regtype
, /* I - Registration type */
2820 const char *replyDomain
) /* I - Domain name */
2822 _cups_dnssd_device_t key
, /* Search key */
2823 *device
; /* Device */
2824 char fullName
[kDNSServiceMaxDomainName
];
2825 /* Full name for query */
2828 DEBUG_printf(("5cups_dnssd_get_device(data=%p, serviceName=\"%s\", "
2829 "regtype=\"%s\", replyDomain=\"%s\")", data
, serviceName
,
2830 regtype
, replyDomain
));
2833 * See if this is an existing device...
2836 key
.dest
.name
= (char *)serviceName
;
2838 if ((device
= cupsArrayFind(data
->devices
, &key
)) != NULL
)
2841 * Yes, see if we need to do anything with this...
2844 int update
= 0; /* Non-zero if we need to update */
2846 if (!_cups_strcasecmp(replyDomain
, "local.") &&
2847 _cups_strcasecmp(device
->domain
, replyDomain
))
2850 * Update the "global" listing to use the .local domain name instead.
2853 _cupsStrFree(device
->domain
);
2854 device
->domain
= _cupsStrAlloc(replyDomain
);
2856 DEBUG_printf(("6cups_dnssd_get_device: Updating '%s' to use local "
2857 "domain.", device
->dest
.name
));
2862 if (!_cups_strcasecmp(regtype
, "_ipps._tcp") &&
2863 _cups_strcasecmp(device
->regtype
, regtype
))
2866 * Prefer IPPS over IPP.
2869 _cupsStrFree(device
->regtype
);
2870 device
->regtype
= _cupsStrAlloc(regtype
);
2872 DEBUG_printf(("6cups_dnssd_get_device: Updating '%s' to use IPPS.",
2873 device
->dest
.name
));
2880 DEBUG_printf(("6cups_dnssd_get_device: No changes to '%s'.",
2881 device
->dest
.name
));
2888 * No, add the device...
2891 DEBUG_printf(("6cups_dnssd_get_device: Adding '%s' for %s with domain "
2892 "'%s'.", serviceName
,
2893 !strcmp(regtype
, "_ipps._tcp") ? "IPPS" : "IPP",
2896 device
= calloc(sizeof(_cups_dnssd_device_t
), 1);
2897 device
->dest
.name
= _cupsStrAlloc(serviceName
);
2898 device
->domain
= _cupsStrAlloc(replyDomain
);
2899 device
->regtype
= _cupsStrAlloc(regtype
);
2901 cupsArrayAdd(data
->devices
, device
);
2905 * Set the "full name" of this service, which is used for queries...
2909 DNSServiceConstructFullName(fullName
, device
->dest
.name
, device
->regtype
,
2911 # else /* HAVE_AVAHI */
2912 avahi_service_name_join(fullName
, kDNSServiceMaxDomainName
, serviceName
,
2913 regtype
, replyDomain
);
2914 # endif /* HAVE_DNSSD */
2916 _cupsStrFree(device
->fullName
);
2917 device
->fullName
= _cupsStrAlloc(fullName
);
2922 DNSServiceRefDeallocate(device
->ref
);
2923 # else /* HAVE_AVAHI */
2924 avahi_record_browser_free(device
->ref
);
2925 # endif /* HAVE_DNSSD */
2930 if (device
->state
== _CUPS_DNSSD_ACTIVE
)
2932 (*data
->cb
)(data
->user_data
, CUPS_DEST_FLAGS_REMOVED
, &device
->dest
);
2933 device
->state
= _CUPS_DNSSD_NEW
;
2942 * 'cups_dnssd_local_cb()' - Browse for local printers.
2946 cups_dnssd_local_cb(
2947 DNSServiceRef sdRef
, /* I - Service reference */
2948 DNSServiceFlags flags
, /* I - Option flags */
2949 uint32_t interfaceIndex
, /* I - Interface number */
2950 DNSServiceErrorType errorCode
, /* I - Error, if any */
2951 const char *serviceName
, /* I - Name of service/device */
2952 const char *regtype
, /* I - Type of service */
2953 const char *replyDomain
, /* I - Service domain */
2954 void *context
) /* I - Devices array */
2956 _cups_dnssd_data_t
*data
= (_cups_dnssd_data_t
*)context
;
2957 /* Enumeration data */
2958 _cups_dnssd_device_t
*device
; /* Device */
2961 DEBUG_printf(("5cups_dnssd_local_cb(sdRef=%p, flags=%x, "
2962 "interfaceIndex=%d, errorCode=%d, serviceName=\"%s\", "
2963 "regtype=\"%s\", replyDomain=\"%s\", context=%p)",
2964 sdRef
, flags
, interfaceIndex
, errorCode
, serviceName
,
2965 regtype
, replyDomain
, context
));
2968 * Only process "add" data...
2971 if (errorCode
!= kDNSServiceErr_NoError
|| !(flags
& kDNSServiceFlagsAdd
))
2978 device
= cups_dnssd_get_device(data
, serviceName
, regtype
, replyDomain
);
2981 * Hide locally-registered devices...
2984 DEBUG_printf(("6cups_dnssd_local_cb: Hiding local printer '%s'.",
2989 DNSServiceRefDeallocate(device
->ref
);
2993 if (device
->state
== _CUPS_DNSSD_ACTIVE
)
2994 (*data
->cb
)(data
->user_data
, CUPS_DEST_FLAGS_REMOVED
, &device
->dest
);
2996 device
->state
= _CUPS_DNSSD_LOCAL
;
2998 # endif /* HAVE_DNSSD */
3003 * 'cups_dnssd_poll_cb()' - Wait for input on the specified file descriptors.
3005 * Note: This function is needed because avahi_simple_poll_iterate is broken
3006 * and always uses a timeout of 0 (!) milliseconds.
3007 * (Avahi Ticket #364)
3010 static int /* O - Number of file descriptors matching */
3012 struct pollfd
*pollfds
, /* I - File descriptors */
3013 unsigned int num_pollfds
, /* I - Number of file descriptors */
3014 int timeout
, /* I - Timeout in milliseconds (unused) */
3015 void *context
) /* I - User data (unused) */
3017 _cups_dnssd_data_t
*data
= (_cups_dnssd_data_t
*)context
;
3018 /* Enumeration data */
3019 int val
; /* Return value */
3024 val
= poll(pollfds
, num_pollfds
, 250);
3028 DEBUG_printf(("cups_dnssd_poll_cb: %s", strerror(errno
)));
3035 # endif /* HAVE_AVAHI */
3039 * 'cups_dnssd_query_cb()' - Process query data.
3044 cups_dnssd_query_cb(
3045 DNSServiceRef sdRef
, /* I - Service reference */
3046 DNSServiceFlags flags
, /* I - Data flags */
3047 uint32_t interfaceIndex
, /* I - Interface */
3048 DNSServiceErrorType errorCode
, /* I - Error, if any */
3049 const char *fullName
, /* I - Full service name */
3050 uint16_t rrtype
, /* I - Record type */
3051 uint16_t rrclass
, /* I - Record class */
3052 uint16_t rdlen
, /* I - Length of record data */
3053 const void *rdata
, /* I - Record data */
3054 uint32_t ttl
, /* I - Time-to-live */
3055 void *context
) /* I - Enumeration data */
3057 # else /* HAVE_AVAHI */
3059 cups_dnssd_query_cb(
3060 AvahiRecordBrowser
*browser
, /* I - Record browser */
3061 AvahiIfIndex interfaceIndex
,
3062 /* I - Interface index (unused) */
3063 AvahiProtocol protocol
, /* I - Network protocol (unused) */
3064 AvahiBrowserEvent event
, /* I - What happened? */
3065 const char *fullName
, /* I - Service name */
3066 uint16_t rrclass
, /* I - Record class */
3067 uint16_t rrtype
, /* I - Record type */
3068 const void *rdata
, /* I - TXT record */
3069 size_t rdlen
, /* I - Length of TXT record */
3070 AvahiLookupResultFlags flags
, /* I - Flags */
3071 void *context
) /* I - Enumeration data */
3074 AvahiClient
*client
= avahi_record_browser_get_client(browser
);
3075 /* Client information */
3077 # endif /* HAVE_DNSSD */
3078 _cups_dnssd_data_t
*data
= (_cups_dnssd_data_t
*)context
;
3079 /* Enumeration data */
3080 char name
[1024], /* Service name */
3081 *ptr
; /* Pointer into string */
3082 _cups_dnssd_device_t dkey
, /* Search key */
3083 *device
; /* Device */
3087 DEBUG_printf(("5cups_dnssd_query_cb(sdRef=%p, flags=%x, "
3088 "interfaceIndex=%d, errorCode=%d, fullName=\"%s\", "
3089 "rrtype=%u, rrclass=%u, rdlen=%u, rdata=%p, ttl=%u, "
3090 "context=%p)", sdRef
, flags
, interfaceIndex
, errorCode
,
3091 fullName
, rrtype
, rrclass
, rdlen
, rdata
, ttl
, context
));
3094 * Only process "add" data...
3097 if (errorCode
!= kDNSServiceErr_NoError
|| !(flags
& kDNSServiceFlagsAdd
))
3100 # else /* HAVE_AVAHI */
3101 DEBUG_printf(("5cups_dnssd_query_cb(browser=%p, interfaceIndex=%d, "
3102 "protocol=%d, event=%d, fullName=\"%s\", rrclass=%u, "
3103 "rrtype=%u, rdata=%p, rdlen=%u, flags=%x, context=%p)",
3104 browser
, interfaceIndex
, protocol
, event
, fullName
, rrclass
,
3105 rrtype
, rdata
, (unsigned)rdlen
, flags
, context
));
3108 * Only process "add" data...
3111 if (event
!= AVAHI_BROWSER_NEW
)
3113 if (event
== AVAHI_BROWSER_FAILURE
)
3114 DEBUG_printf(("cups_dnssd_query_cb: %s",
3115 avahi_strerror(avahi_client_errno(client
))));
3119 # endif /* HAVE_DNSSD */
3122 * Lookup the service in the devices array.
3125 dkey
.dest
.name
= name
;
3127 cups_dnssd_unquote(name
, fullName
, sizeof(name
));
3129 if ((ptr
= strstr(name
, "._")) != NULL
)
3132 if ((device
= cupsArrayFind(data
->devices
, &dkey
)) != NULL
)
3135 * Found it, pull out the make and model from the TXT record and save it...
3138 const uint8_t *txt
, /* Pointer into data */
3139 *txtnext
, /* Next key/value pair */
3140 *txtend
; /* End of entire TXT record */
3141 uint8_t txtlen
; /* Length of current key/value pair */
3142 char key
[256], /* Key string */
3143 value
[256], /* Value string */
3144 make_and_model
[512],
3145 /* Manufacturer and model */
3146 model
[256], /* Model */
3147 uriname
[1024], /* Name for URI */
3148 uri
[1024]; /* Printer URI */
3149 cups_ptype_t type
= CUPS_PRINTER_REMOTE
| CUPS_PRINTER_BW
;
3151 int saw_printer_type
= 0;
3152 /* Did we see a printer-type key? */
3154 device
->state
= _CUPS_DNSSD_PENDING
;
3155 make_and_model
[0] = '\0';
3157 strlcpy(model
, "Unknown", sizeof(model
));
3159 for (txt
= rdata
, txtend
= txt
+ rdlen
;
3164 * Read a key/value pair starting with an 8-bit length. Since the
3165 * length is 8 bits and the size of the key/value buffers is 256, we
3166 * don't need to check for overflow...
3171 if (!txtlen
|| (txt
+ txtlen
) > txtend
)
3174 txtnext
= txt
+ txtlen
;
3176 for (ptr
= key
; txt
< txtnext
&& *txt
!= '='; txt
++)
3180 if (txt
< txtnext
&& *txt
== '=')
3185 memcpy(value
, txt
, txtnext
- txt
);
3186 value
[txtnext
- txt
] = '\0';
3188 DEBUG_printf(("6cups_dnssd_query_cb: %s=%s", key
, value
));
3192 DEBUG_printf(("6cups_dnssd_query_cb: '%s' with no value.", key
));
3196 if (!_cups_strcasecmp(key
, "usb_MFG") ||
3197 !_cups_strcasecmp(key
, "usb_MANU") ||
3198 !_cups_strcasecmp(key
, "usb_MANUFACTURER"))
3199 strlcpy(make_and_model
, value
, sizeof(make_and_model
));
3200 else if (!_cups_strcasecmp(key
, "usb_MDL") ||
3201 !_cups_strcasecmp(key
, "usb_MODEL"))
3202 strlcpy(model
, value
, sizeof(model
));
3203 else if (!_cups_strcasecmp(key
, "product") && !strstr(value
, "Ghostscript"))
3205 if (value
[0] == '(')
3208 * Strip parenthesis...
3211 if ((ptr
= value
+ strlen(value
) - 1) > value
&& *ptr
== ')')
3214 strlcpy(model
, value
+ 1, sizeof(model
));
3217 strlcpy(model
, value
, sizeof(model
));
3219 else if (!_cups_strcasecmp(key
, "ty"))
3221 strlcpy(model
, value
, sizeof(model
));
3223 if ((ptr
= strchr(model
, ',')) != NULL
)
3226 else if (!_cups_strcasecmp(key
, "note"))
3227 device
->dest
.num_options
= cupsAddOption("printer-location", value
,
3228 device
->dest
.num_options
,
3229 &device
->dest
.options
);
3230 else if (!_cups_strcasecmp(key
, "pdl"))
3233 * Look for PDF-capable printers; only PDF-capable printers are shown.
3236 const char *start
, *next
; /* Pointer into value */
3237 int have_pdf
= 0; /* Have PDF? */
3239 for (start
= value
; start
&& *start
; start
= next
)
3241 if (!_cups_strncasecmp(start
, "application/pdf", 15) &&
3242 (!start
[15] || start
[15] == ','))
3248 if ((next
= strchr(start
, ',')) != NULL
)
3253 device
->state
= _CUPS_DNSSD_INCOMPATIBLE
;
3255 else if (!_cups_strcasecmp(key
, "printer-type"))
3258 * Value is either NNNN or 0xXXXX
3261 saw_printer_type
= 1;
3262 type
= strtol(value
, NULL
, 0);
3264 else if (!saw_printer_type
)
3266 if (!_cups_strcasecmp(key
, "air") &&
3267 !_cups_strcasecmp(value
, "t"))
3268 type
|= CUPS_PRINTER_AUTHENTICATED
;
3269 else if (!_cups_strcasecmp(key
, "bind") &&
3270 !_cups_strcasecmp(value
, "t"))
3271 type
|= CUPS_PRINTER_BIND
;
3272 else if (!_cups_strcasecmp(key
, "collate") &&
3273 !_cups_strcasecmp(value
, "t"))
3274 type
|= CUPS_PRINTER_COLLATE
;
3275 else if (!_cups_strcasecmp(key
, "color") &&
3276 !_cups_strcasecmp(value
, "t"))
3277 type
|= CUPS_PRINTER_COLOR
;
3278 else if (!_cups_strcasecmp(key
, "copies") &&
3279 !_cups_strcasecmp(value
, "t"))
3280 type
|= CUPS_PRINTER_COPIES
;
3281 else if (!_cups_strcasecmp(key
, "duplex") &&
3282 !_cups_strcasecmp(value
, "t"))
3283 type
|= CUPS_PRINTER_DUPLEX
;
3284 else if (!_cups_strcasecmp(key
, "fax") &&
3285 !_cups_strcasecmp(value
, "t"))
3286 type
|= CUPS_PRINTER_MFP
;
3287 else if (!_cups_strcasecmp(key
, "papercustom") &&
3288 !_cups_strcasecmp(value
, "t"))
3289 type
|= CUPS_PRINTER_VARIABLE
;
3290 else if (!_cups_strcasecmp(key
, "papermax"))
3292 if (!_cups_strcasecmp(value
, "legal-a4"))
3293 type
|= CUPS_PRINTER_SMALL
;
3294 else if (!_cups_strcasecmp(value
, "isoc-a2"))
3295 type
|= CUPS_PRINTER_MEDIUM
;
3296 else if (!_cups_strcasecmp(value
, ">isoc-a2"))
3297 type
|= CUPS_PRINTER_LARGE
;
3299 else if (!_cups_strcasecmp(key
, "punch") &&
3300 !_cups_strcasecmp(value
, "t"))
3301 type
|= CUPS_PRINTER_PUNCH
;
3302 else if (!_cups_strcasecmp(key
, "scan") &&
3303 !_cups_strcasecmp(value
, "t"))
3304 type
|= CUPS_PRINTER_MFP
;
3305 else if (!_cups_strcasecmp(key
, "sort") &&
3306 !_cups_strcasecmp(value
, "t"))
3307 type
|= CUPS_PRINTER_SORT
;
3308 else if (!_cups_strcasecmp(key
, "staple") &&
3309 !_cups_strcasecmp(value
, "t"))
3310 type
|= CUPS_PRINTER_STAPLE
;
3315 * Save the printer-xxx values...
3318 device
->dest
.num_options
= cupsAddOption("printer-info", name
,
3319 device
->dest
.num_options
,
3320 &device
->dest
.options
);
3322 if (make_and_model
[0])
3324 strlcat(make_and_model
, " ", sizeof(make_and_model
));
3325 strlcat(make_and_model
, model
, sizeof(make_and_model
));
3327 device
->dest
.num_options
= cupsAddOption("printer-make-and-model",
3329 device
->dest
.num_options
,
3330 &device
->dest
.options
);
3333 device
->dest
.num_options
= cupsAddOption("printer-make-and-model",
3335 device
->dest
.num_options
,
3336 &device
->dest
.options
);
3338 device
->type
= type
;
3339 snprintf(value
, sizeof(value
), "%u", type
);
3340 device
->dest
.num_options
= cupsAddOption("printer-type", value
,
3341 device
->dest
.num_options
,
3342 &device
->dest
.options
);
3348 cups_dnssd_unquote(uriname
, device
->fullName
, sizeof(uriname
));
3349 httpAssembleURI(HTTP_URI_CODING_ALL
, uri
, sizeof(uri
),
3350 !strcmp(device
->regtype
, "_ipps._tcp") ? "ipps" : "ipp",
3351 NULL
, uriname
, 0, saw_printer_type
? "/cups" : "/");
3353 DEBUG_printf(("6cups_dnssd_query: printer-uri-supported=\"%s\"", uri
));
3355 device
->dest
.num_options
= cupsAddOption("printer-uri-supported", uri
,
3356 device
->dest
.num_options
,
3357 &device
->dest
.options
);
3360 DEBUG_printf(("6cups_dnssd_query: Ignoring TXT record for '%s'.",
3366 * 'cups_dnssd_resolve()' - Resolve a Bonjour printer URI.
3369 static const char * /* O - Resolved URI or NULL */
3371 cups_dest_t
*dest
, /* I - Destination */
3372 const char *uri
, /* I - Current printer URI */
3373 int msec
, /* I - Time in milliseconds */
3374 int *cancel
, /* I - Pointer to "cancel" variable */
3375 cups_dest_cb_t cb
, /* I - Callback */
3376 void *user_data
) /* I - User data for callback */
3378 char tempuri
[1024]; /* Temporary URI buffer */
3379 _cups_dnssd_resolve_t resolve
; /* Resolve data */
3383 * Resolve the URI...
3386 resolve
.cancel
= cancel
;
3387 gettimeofday(&resolve
.end_time
, NULL
);
3390 resolve
.end_time
.tv_sec
+= msec
/ 1000;
3391 resolve
.end_time
.tv_usec
+= (msec
% 1000) * 1000;
3393 while (resolve
.end_time
.tv_usec
>= 1000000)
3395 resolve
.end_time
.tv_sec
++;
3396 resolve
.end_time
.tv_usec
-= 1000000;
3400 resolve
.end_time
.tv_sec
+= 75;
3403 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_RESOLVING
,
3406 if ((uri
= _httpResolveURI(uri
, tempuri
, sizeof(tempuri
),
3407 _HTTP_RESOLVE_FQDN
, cups_dnssd_resolve_cb
,
3410 _cupsSetError(IPP_INTERNAL_ERROR
, _("Unable to resolve printer URI."), 1);
3413 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_ERROR
,
3420 * Save the resolved URI...
3423 dest
->num_options
= cupsAddOption("printer-uri-supported", uri
,
3424 dest
->num_options
, &dest
->options
);
3426 return (cupsGetOption("printer-uri-supported", dest
->num_options
,
3432 * 'cups_dnssd_resolve_cb()' - See if we should continue resolving.
3435 static int /* O - 1 to continue, 0 to stop */
3436 cups_dnssd_resolve_cb(void *context
) /* I - Resolve data */
3438 _cups_dnssd_resolve_t
*resolve
= (_cups_dnssd_resolve_t
*)context
;
3440 struct timeval curtime
; /* Current time */
3444 * If the cancel variable is set, return immediately.
3447 if (*resolve
->cancel
)
3451 * Otherwise check the end time...
3454 gettimeofday(&curtime
, NULL
);
3456 return (curtime
.tv_sec
> resolve
->end_time
.tv_sec
||
3457 (curtime
.tv_sec
== resolve
->end_time
.tv_sec
&&
3458 curtime
.tv_usec
> resolve
->end_time
.tv_usec
));
3463 * 'cups_dnssd_unquote()' - Unquote a name string.
3467 cups_dnssd_unquote(char *dst
, /* I - Destination buffer */
3468 const char *src
, /* I - Source string */
3469 size_t dstsize
) /* I - Size of destination buffer */
3471 char *dstend
= dst
+ dstsize
- 1; /* End of destination buffer */
3474 while (*src
&& dst
< dstend
)
3479 if (isdigit(src
[0] & 255) && isdigit(src
[1] & 255) &&
3480 isdigit(src
[2] & 255))
3482 *dst
++ = ((((src
[0] - '0') * 10) + src
[1] - '0') * 10) + src
[2] - '0';
3494 #endif /* HAVE_DNSSD */
3498 * 'cups_find_dest()' - Find a destination using a binary search.
3501 static int /* O - Index of match */
3502 cups_find_dest(const char *name
, /* I - Destination name */
3503 const char *instance
, /* I - Instance or NULL */
3504 int num_dests
, /* I - Number of destinations */
3505 cups_dest_t
*dests
, /* I - Destinations */
3506 int prev
, /* I - Previous index */
3507 int *rdiff
) /* O - Difference of match */
3509 int left
, /* Low mark for binary search */
3510 right
, /* High mark for binary search */
3511 current
, /* Current index */
3512 diff
; /* Result of comparison */
3513 cups_dest_t key
; /* Search key */
3516 key
.name
= (char *)name
;
3517 key
.instance
= (char *)instance
;
3522 * Start search on either side of previous...
3525 if ((diff
= cups_compare_dests(&key
, dests
+ prev
)) == 0 ||
3526 (diff
< 0 && prev
== 0) ||
3527 (diff
> 0 && prev
== (num_dests
- 1)))
3535 * Start with previous on right side...
3544 * Start wih previous on left side...
3548 right
= num_dests
- 1;
3554 * Start search in the middle...
3558 right
= num_dests
- 1;
3563 current
= (left
+ right
) / 2;
3564 diff
= cups_compare_dests(&key
, dests
+ current
);
3573 while ((right
- left
) > 1);
3578 * Check the last 1 or 2 elements...
3581 if ((diff
= cups_compare_dests(&key
, dests
+ left
)) <= 0)
3585 diff
= cups_compare_dests(&key
, dests
+ right
);
3591 * Return the closest destination and the difference...
3601 * 'cups_get_default()' - Get the default destination from an lpoptions file.
3604 static char * /* O - Default destination or NULL */
3605 cups_get_default(const char *filename
, /* I - File to read */
3606 char *namebuf
, /* I - Name buffer */
3607 size_t namesize
, /* I - Size of name buffer */
3608 const char **instance
) /* I - Instance */
3610 cups_file_t
*fp
; /* lpoptions file */
3611 char line
[8192], /* Line from file */
3612 *value
, /* Value for line */
3613 *nameptr
; /* Pointer into name */
3614 int linenum
; /* Current line */
3619 if ((fp
= cupsFileOpen(filename
, "r")) != NULL
)
3623 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
3625 if (!_cups_strcasecmp(line
, "default") && value
)
3627 strlcpy(namebuf
, value
, namesize
);
3629 if ((nameptr
= strchr(namebuf
, ' ')) != NULL
)
3631 if ((nameptr
= strchr(namebuf
, '\t')) != NULL
)
3634 if ((nameptr
= strchr(namebuf
, '/')) != NULL
)
3637 *instance
= nameptr
;
3645 return (*namebuf
? namebuf
: NULL
);
3650 * 'cups_get_dests()' - Get destinations from a file.
3653 static int /* O - Number of destinations */
3655 const char *filename
, /* I - File to read from */
3656 const char *match_name
, /* I - Destination name we want */
3657 const char *match_inst
, /* I - Instance name we want */
3658 int user_default_set
, /* I - User default printer set? */
3659 int num_dests
, /* I - Number of destinations */
3660 cups_dest_t
**dests
) /* IO - Destinations */
3662 int i
; /* Looping var */
3663 cups_dest_t
*dest
; /* Current destination */
3664 cups_file_t
*fp
; /* File pointer */
3665 char line
[8192], /* Line from file */
3666 *lineptr
, /* Pointer into line */
3667 *name
, /* Name of destination/option */
3668 *instance
; /* Instance of destination */
3669 int linenum
; /* Current line number */
3672 DEBUG_printf(("7cups_get_dests(filename=\"%s\", match_name=\"%s\", "
3673 "match_inst=\"%s\", user_default_set=%d, num_dests=%d, "
3674 "dests=%p)", filename
, match_name
, match_inst
,
3675 user_default_set
, num_dests
, dests
));
3678 * Try to open the file...
3681 if ((fp
= cupsFileOpen(filename
, "r")) == NULL
)
3685 * Read each printer; each line looks like:
3687 * Dest name[/instance] options
3688 * Default name[/instance] options
3693 while (cupsFileGetConf(fp
, line
, sizeof(line
), &lineptr
, &linenum
))
3696 * See what type of line it is...
3699 DEBUG_printf(("9cups_get_dests: linenum=%d line=\"%s\" lineptr=\"%s\"",
3700 linenum
, line
, lineptr
));
3702 if ((_cups_strcasecmp(line
, "dest") && _cups_strcasecmp(line
, "default")) || !lineptr
)
3704 DEBUG_puts("9cups_get_dests: Not a dest or default line...");
3711 * Search for an instance...
3714 while (!isspace(*lineptr
& 255) && *lineptr
&& *lineptr
!= '/')
3717 if (*lineptr
== '/')
3720 * Found an instance...
3727 * Search for an instance...
3730 while (!isspace(*lineptr
& 255) && *lineptr
)
3739 DEBUG_printf(("9cups_get_dests: name=\"%s\", instance=\"%s\"", name
,
3743 * See if the primary instance of the destination exists; if not,
3744 * ignore this entry and move on...
3749 if (_cups_strcasecmp(name
, match_name
) ||
3750 (!instance
&& match_inst
) ||
3751 (instance
&& !match_inst
) ||
3752 (instance
&& _cups_strcasecmp(instance
, match_inst
)))
3757 else if (cupsGetDest(name
, NULL
, num_dests
, *dests
) == NULL
)
3759 DEBUG_puts("9cups_get_dests: Not found!");
3765 * Add the destination...
3768 num_dests
= cupsAddDest(name
, instance
, num_dests
, dests
);
3770 if ((dest
= cupsGetDest(name
, instance
, num_dests
, *dests
)) == NULL
)
3776 DEBUG_puts("9cups_get_dests: Out of memory!");
3782 * Add options until we hit the end of the line...
3785 dest
->num_options
= cupsParseOptions(lineptr
, dest
->num_options
,
3789 * If we found what we were looking for, stop now...
3796 * Set this as default if needed...
3799 if (!user_default_set
&& !_cups_strcasecmp(line
, "default"))
3801 DEBUG_puts("9cups_get_dests: Setting as default...");
3803 for (i
= 0; i
< num_dests
; i
++)
3804 (*dests
)[i
].is_default
= 0;
3806 dest
->is_default
= 1;
3811 * Close the file and return...
3821 * 'cups_make_string()' - Make a comma-separated string of values from an IPP
3825 static char * /* O - New string */
3827 ipp_attribute_t
*attr
, /* I - Attribute to convert */
3828 char *buffer
, /* I - Buffer */
3829 size_t bufsize
) /* I - Size of buffer */
3831 int i
; /* Looping var */
3832 char *ptr
, /* Pointer into buffer */
3833 *end
, /* Pointer to end of buffer */
3834 *valptr
; /* Pointer into string attribute */
3838 * Return quickly if we have a single string value...
3841 if (attr
->num_values
== 1 &&
3842 attr
->value_tag
!= IPP_TAG_INTEGER
&&
3843 attr
->value_tag
!= IPP_TAG_ENUM
&&
3844 attr
->value_tag
!= IPP_TAG_BOOLEAN
&&
3845 attr
->value_tag
!= IPP_TAG_RANGE
)
3846 return (attr
->values
[0].string
.text
);
3849 * Copy the values to the string, separating with commas and escaping strings
3853 end
= buffer
+ bufsize
- 1;
3855 for (i
= 0, ptr
= buffer
; i
< attr
->num_values
&& ptr
< end
; i
++)
3860 switch (attr
->value_tag
)
3862 case IPP_TAG_INTEGER
:
3864 snprintf(ptr
, end
- ptr
+ 1, "%d", attr
->values
[i
].integer
);
3867 case IPP_TAG_BOOLEAN
:
3868 if (attr
->values
[i
].boolean
)
3869 strlcpy(ptr
, "true", end
- ptr
+ 1);
3871 strlcpy(ptr
, "false", end
- ptr
+ 1);
3874 case IPP_TAG_RANGE
:
3875 if (attr
->values
[i
].range
.lower
== attr
->values
[i
].range
.upper
)
3876 snprintf(ptr
, end
- ptr
+ 1, "%d", attr
->values
[i
].range
.lower
);
3878 snprintf(ptr
, end
- ptr
+ 1, "%d-%d", attr
->values
[i
].range
.lower
,
3879 attr
->values
[i
].range
.upper
);
3883 for (valptr
= attr
->values
[i
].string
.text
;
3884 *valptr
&& ptr
< end
;)
3886 if (strchr(" \t\n\\\'\"", *valptr
))
3888 if (ptr
>= (end
- 1))
3911 * End of "$Id: dest.c 9568 2011-02-25 06:13:56Z mike $".