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 _cups_globals_t
*cg
= _cupsGlobals(); /* Thread global data */
1392 static const char * const pattrs
[] = /* Attributes we're interested in */
1394 "auth-info-required",
1396 "job-sheets-default",
1397 "marker-change-time",
1399 "marker-high-levels",
1401 "marker-low-levels",
1407 #endif /* __APPLE__ */
1411 "printer-is-accepting-jobs",
1412 "printer-is-shared",
1414 "printer-make-and-model",
1415 "printer-mandatory-job-attributes",
1418 "printer-state-change-time",
1419 "printer-state-reasons",
1421 "printer-uri-supported"
1427 * Get the default paper size...
1430 appleGetPaperSize(media_default
, sizeof(media_default
));
1431 #endif /* __APPLE__ */
1436 * Build a CUPS_GET_PRINTERS or IPP_GET_PRINTER_ATTRIBUTES request, which
1437 * require the following attributes:
1439 * attributes-charset
1440 * attributes-natural-language
1441 * requesting-user-name
1442 * printer-uri [for IPP_GET_PRINTER_ATTRIBUTES]
1445 request
= ippNewRequest(op
);
1447 ippSetVersion(request
, cg
->server_version
/ 10, cg
->server_version
% 10);
1449 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
1450 "requested-attributes", sizeof(pattrs
) / sizeof(pattrs
[0]),
1453 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
1454 "requesting-user-name", NULL
, cupsUser());
1456 if (name
&& op
!= CUPS_GET_DEFAULT
)
1458 httpAssembleURIf(HTTP_URI_CODING_ALL
, uri
, sizeof(uri
), "ipp", NULL
,
1459 "localhost", ippPort(), "/printers/%s", name
);
1460 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri", NULL
,
1465 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_ENUM
, "printer-type",
1467 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_ENUM
, "printer-type-mask",
1472 * Do the request and get back a response...
1475 response
= cupsDoRequest(http
, request
, "/");
1476 if (cg
->server_version
!= 20 || !response
||
1477 cupsLastError() != IPP_BAD_REQUEST
)
1481 * Retry as an IPP/1.1 request...
1484 cg
->server_version
= 11;
1485 ippDelete(response
);
1490 for (attr
= response
->attrs
; attr
!= NULL
; attr
= attr
->next
)
1493 * Skip leading attributes until we hit a printer...
1496 while (attr
!= NULL
&& attr
->group_tag
!= IPP_TAG_PRINTER
)
1503 * Pull the needed attributes from this printer...
1506 printer_name
= NULL
;
1510 for (; attr
&& attr
->group_tag
== IPP_TAG_PRINTER
; attr
= attr
->next
)
1512 if (attr
->value_tag
!= IPP_TAG_INTEGER
&&
1513 attr
->value_tag
!= IPP_TAG_ENUM
&&
1514 attr
->value_tag
!= IPP_TAG_BOOLEAN
&&
1515 attr
->value_tag
!= IPP_TAG_TEXT
&&
1516 attr
->value_tag
!= IPP_TAG_TEXTLANG
&&
1517 attr
->value_tag
!= IPP_TAG_NAME
&&
1518 attr
->value_tag
!= IPP_TAG_NAMELANG
&&
1519 attr
->value_tag
!= IPP_TAG_KEYWORD
&&
1520 attr
->value_tag
!= IPP_TAG_RANGE
&&
1521 attr
->value_tag
!= IPP_TAG_URI
)
1524 if (!strcmp(attr
->name
, "auth-info-required") ||
1525 !strcmp(attr
->name
, "device-uri") ||
1526 !strcmp(attr
->name
, "marker-change-time") ||
1527 !strcmp(attr
->name
, "marker-colors") ||
1528 !strcmp(attr
->name
, "marker-high-levels") ||
1529 !strcmp(attr
->name
, "marker-levels") ||
1530 !strcmp(attr
->name
, "marker-low-levels") ||
1531 !strcmp(attr
->name
, "marker-message") ||
1532 !strcmp(attr
->name
, "marker-names") ||
1533 !strcmp(attr
->name
, "marker-types") ||
1534 !strcmp(attr
->name
, "printer-commands") ||
1535 !strcmp(attr
->name
, "printer-info") ||
1536 !strcmp(attr
->name
, "printer-is-shared") ||
1537 !strcmp(attr
->name
, "printer-make-and-model") ||
1538 !strcmp(attr
->name
, "printer-mandatory-job-attributes") ||
1539 !strcmp(attr
->name
, "printer-state") ||
1540 !strcmp(attr
->name
, "printer-state-change-time") ||
1541 !strcmp(attr
->name
, "printer-type") ||
1542 !strcmp(attr
->name
, "printer-is-accepting-jobs") ||
1543 !strcmp(attr
->name
, "printer-location") ||
1544 !strcmp(attr
->name
, "printer-state-reasons") ||
1545 !strcmp(attr
->name
, "printer-uri-supported"))
1548 * Add a printer description attribute...
1551 num_options
= cupsAddOption(attr
->name
,
1552 cups_make_string(attr
, value
,
1554 num_options
, &options
);
1557 else if (!strcmp(attr
->name
, "media-supported"))
1560 * See if we can set a default media size...
1563 int i
; /* Looping var */
1565 for (i
= 0; i
< attr
->num_values
; i
++)
1566 if (!_cups_strcasecmp(media_default
, attr
->values
[i
].string
.text
))
1568 num_options
= cupsAddOption("media", media_default
, num_options
,
1573 #endif /* __APPLE__ */
1574 else if (!strcmp(attr
->name
, "printer-name") &&
1575 attr
->value_tag
== IPP_TAG_NAME
)
1576 printer_name
= attr
->values
[0].string
.text
;
1577 else if (strncmp(attr
->name
, "notify-", 7) &&
1578 (attr
->value_tag
== IPP_TAG_BOOLEAN
||
1579 attr
->value_tag
== IPP_TAG_ENUM
||
1580 attr
->value_tag
== IPP_TAG_INTEGER
||
1581 attr
->value_tag
== IPP_TAG_KEYWORD
||
1582 attr
->value_tag
== IPP_TAG_NAME
||
1583 attr
->value_tag
== IPP_TAG_RANGE
) &&
1584 (ptr
= strstr(attr
->name
, "-default")) != NULL
)
1587 * Add a default option...
1590 strlcpy(optname
, attr
->name
, sizeof(optname
));
1591 optname
[ptr
- attr
->name
] = '\0';
1593 if (_cups_strcasecmp(optname
, "media") ||
1594 !cupsGetOption("media", num_options
, options
))
1595 num_options
= cupsAddOption(optname
,
1596 cups_make_string(attr
, value
,
1598 num_options
, &options
);
1603 * See if we have everything needed...
1608 cupsFreeOptions(num_options
, options
);
1616 if ((dest
= cups_add_dest(printer_name
, NULL
, &num_dests
, dests
)) != NULL
)
1618 dest
->num_options
= num_options
;
1619 dest
->options
= options
;
1622 cupsFreeOptions(num_options
, options
);
1628 ippDelete(response
);
1632 * Return the count...
1640 * 'cupsGetDests()' - Get the list of destinations from the default 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.
1654 int /* O - Number of destinations */
1655 cupsGetDests(cups_dest_t
**dests
) /* O - Destinations */
1657 return (cupsGetDests2(CUPS_HTTP_DEFAULT
, dests
));
1662 * 'cupsGetDests2()' - Get the list of destinations from the specified server.
1664 * Starting with CUPS 1.2, the returned list of destinations include the
1665 * printer-info, printer-is-accepting-jobs, printer-is-shared,
1666 * printer-make-and-model, printer-state, printer-state-change-time,
1667 * printer-state-reasons, and printer-type attributes as options. CUPS 1.4
1668 * adds the marker-change-time, marker-colors, marker-high-levels,
1669 * marker-levels, marker-low-levels, marker-message, marker-names,
1670 * marker-types, and printer-commands attributes as well.
1672 * Use the @link cupsFreeDests@ function to free the destination list and
1673 * the @link cupsGetDest@ function to find a particular destination.
1675 * @since CUPS 1.1.21/OS X 10.4@
1678 int /* O - Number of destinations */
1679 cupsGetDests2(http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
1680 cups_dest_t
**dests
) /* O - Destinations */
1682 int i
; /* Looping var */
1683 int num_dests
; /* Number of destinations */
1684 cups_dest_t
*dest
; /* Destination pointer */
1685 const char *home
; /* HOME environment variable */
1686 char filename
[1024]; /* Local ~/.cups/lpoptions file */
1687 const char *defprinter
; /* Default printer */
1688 char name
[1024], /* Copy of printer name */
1689 *instance
, /* Pointer to instance name */
1690 *user_default
; /* User default printer */
1691 int num_reals
; /* Number of real queues */
1692 cups_dest_t
*reals
; /* Real queues */
1693 _cups_globals_t
*cg
= _cupsGlobals(); /* Pointer to library globals */
1697 * Range check the input...
1702 _cupsSetError(IPP_INTERNAL_ERROR
, _("Bad NULL dests pointer"), 1);
1707 * Grab the printers and classes...
1710 *dests
= (cups_dest_t
*)0;
1711 num_dests
= _cupsGetDests(http
, CUPS_GET_PRINTERS
, NULL
, dests
, 0, 0);
1713 if (cupsLastError() >= IPP_REDIRECTION_OTHER_SITE
)
1715 cupsFreeDests(num_dests
, *dests
);
1716 *dests
= (cups_dest_t
*)0;
1721 * Make a copy of the "real" queues for a later sanity check...
1726 num_reals
= num_dests
;
1727 reals
= calloc(num_reals
, sizeof(cups_dest_t
));
1730 memcpy(reals
, *dests
, num_reals
* sizeof(cups_dest_t
));
1741 * Grab the default destination...
1744 if ((user_default
= _cupsUserDefault(name
, sizeof(name
))) != NULL
)
1746 else if ((defprinter
= cupsGetDefault2(http
)) != NULL
)
1748 strlcpy(name
, defprinter
, sizeof(name
));
1755 * Separate printer and instance name...
1758 if ((instance
= strchr(name
, '/')) != NULL
)
1762 * Lookup the printer and instance and make it the default...
1765 if ((dest
= cupsGetDest(name
, instance
, num_dests
, *dests
)) != NULL
)
1766 dest
->is_default
= 1;
1772 * Load the /etc/cups/lpoptions and ~/.cups/lpoptions files...
1775 snprintf(filename
, sizeof(filename
), "%s/lpoptions", cg
->cups_serverroot
);
1776 num_dests
= cups_get_dests(filename
, NULL
, NULL
, user_default
!= NULL
,
1779 if ((home
= getenv("HOME")) != NULL
)
1781 snprintf(filename
, sizeof(filename
), "%s/.cups/lpoptions", home
);
1783 num_dests
= cups_get_dests(filename
, NULL
, NULL
, user_default
!= NULL
,
1788 * Validate the current default destination - this prevents old
1789 * Default lines in /etc/cups/lpoptions and ~/.cups/lpoptions from
1790 * pointing to a non-existent printer or class...
1796 * See if we have a default printer...
1799 if ((dest
= cupsGetDest(NULL
, NULL
, num_dests
, *dests
)) != NULL
)
1802 * Have a default; see if it is real...
1805 dest
= cupsGetDest(dest
->name
, NULL
, num_reals
, reals
);
1809 * If dest is NULL, then no default (that exists) is set, so we
1810 * need to set a default if one exists...
1813 if (!dest
&& *dests
&& defprinter
)
1815 for (i
= 0; i
< num_dests
; i
++)
1816 (*dests
)[i
].is_default
= 0;
1818 if ((dest
= cupsGetDest(name
, instance
, num_dests
, *dests
)) != NULL
)
1819 dest
->is_default
= 1;
1830 * Return the number of destinations...
1834 _cupsSetError(IPP_OK
, NULL
, 0);
1841 * 'cupsGetNamedDest()' - Get options for the named destination.
1843 * This function is optimized for retrieving a single destination and should
1844 * be used instead of @link cupsGetDests@ and @link cupsGetDest@ when you either
1845 * know the name of the destination or want to print to the default destination.
1846 * If @code NULL@ is returned, the destination does not exist or there is no
1847 * default destination.
1849 * If "http" is @code CUPS_HTTP_DEFAULT@, the connection to the default print
1850 * server will be used.
1852 * If "name" is @code NULL@, the default printer for the current user will be
1855 * The returned destination must be freed using @link cupsFreeDests@ with a
1856 * "num_dests" value of 1.
1858 * @since CUPS 1.4/OS X 10.6@
1861 cups_dest_t
* /* O - Destination or @code NULL@ */
1862 cupsGetNamedDest(http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
1863 const char *name
, /* I - Destination name or @code NULL@ for the default destination */
1864 const char *instance
) /* I - Instance name or @code NULL@ */
1866 cups_dest_t
*dest
; /* Destination */
1867 char filename
[1024], /* Path to lpoptions */
1868 defname
[256]; /* Default printer name */
1869 const char *home
= getenv("HOME"); /* Home directory */
1870 int set_as_default
= 0; /* Set returned destination as default */
1871 ipp_op_t op
= IPP_GET_PRINTER_ATTRIBUTES
;
1872 /* IPP operation to get server ops */
1873 _cups_globals_t
*cg
= _cupsGlobals(); /* Pointer to library globals */
1877 * If "name" is NULL, find the default destination...
1883 name
= _cupsUserDefault(defname
, sizeof(defname
));
1887 char *ptr
; /* Temporary pointer... */
1889 if ((ptr
= strchr(defname
, '/')) != NULL
)
1900 * No default in the environment, try the user's lpoptions files...
1903 snprintf(filename
, sizeof(filename
), "%s/.cups/lpoptions", home
);
1905 name
= cups_get_default(filename
, defname
, sizeof(defname
), &instance
);
1911 * Still not there? Try the system lpoptions file...
1914 snprintf(filename
, sizeof(filename
), "%s/lpoptions",
1915 cg
->cups_serverroot
);
1916 name
= cups_get_default(filename
, defname
, sizeof(defname
), &instance
);
1922 * No locally-set default destination, ask the server...
1925 op
= CUPS_GET_DEFAULT
;
1930 * Get the printer's attributes...
1933 if (!_cupsGetDests(http
, op
, name
, &dest
, 0, 0))
1935 if (op
== CUPS_GET_DEFAULT
|| (name
&& !set_as_default
))
1939 * The default printer from environment variables or from a
1940 * configuration file does not exist. Find out the real default.
1943 if (!_cupsGetDests(http
, CUPS_GET_DEFAULT
, NULL
, &dest
, 0, 0))
1948 dest
->instance
= _cupsStrAlloc(instance
);
1951 dest
->is_default
= 1;
1954 * Then add local options...
1957 snprintf(filename
, sizeof(filename
), "%s/lpoptions", cg
->cups_serverroot
);
1958 cups_get_dests(filename
, name
, instance
, 1, 1, &dest
);
1962 snprintf(filename
, sizeof(filename
), "%s/.cups/lpoptions", home
);
1964 cups_get_dests(filename
, name
, instance
, 1, 1, &dest
);
1968 * Return the result...
1976 * 'cupsRemoveDest()' - Remove a destination from the destination list.
1978 * Removing a destination/instance does not delete the class or printer
1979 * queue, merely the lpoptions for that destination/instance. Use the
1980 * @link cupsSetDests@ or @link cupsSetDests2@ functions to save the new
1981 * options for the user.
1983 * @since CUPS 1.3/OS X 10.5@
1986 int /* O - New number of destinations */
1987 cupsRemoveDest(const char *name
, /* I - Destination name */
1988 const char *instance
, /* I - Instance name or @code NULL@ */
1989 int num_dests
, /* I - Number of destinations */
1990 cups_dest_t
**dests
) /* IO - Destinations */
1992 int i
; /* Index into destinations */
1993 cups_dest_t
*dest
; /* Pointer to destination */
1997 * Find the destination...
2000 if ((dest
= cupsGetDest(name
, instance
, num_dests
, *dests
)) == NULL
)
2007 _cupsStrFree(dest
->name
);
2008 _cupsStrFree(dest
->instance
);
2009 cupsFreeOptions(dest
->num_options
, dest
->options
);
2012 * Remove the destination from the array...
2020 memmove(dest
, dest
+ 1, (num_dests
- i
) * sizeof(cups_dest_t
));
2027 * 'cupsSetDefaultDest()' - Set the default destination.
2029 * @since CUPS 1.3/OS X 10.5@
2034 const char *name
, /* I - Destination name */
2035 const char *instance
, /* I - Instance name or @code NULL@ */
2036 int num_dests
, /* I - Number of destinations */
2037 cups_dest_t
*dests
) /* I - Destinations */
2039 int i
; /* Looping var */
2040 cups_dest_t
*dest
; /* Current destination */
2044 * Range check input...
2047 if (!name
|| num_dests
<= 0 || !dests
)
2051 * Loop through the array and set the "is_default" flag for the matching
2055 for (i
= num_dests
, dest
= dests
; i
> 0; i
--, dest
++)
2056 dest
->is_default
= !_cups_strcasecmp(name
, dest
->name
) &&
2057 ((!instance
&& !dest
->instance
) ||
2058 (instance
&& dest
->instance
&&
2059 !_cups_strcasecmp(instance
, dest
->instance
)));
2064 * 'cupsSetDests()' - Save the list of destinations for the default server.
2066 * This function saves the destinations to /etc/cups/lpoptions when run
2067 * as root and ~/.cups/lpoptions when run as a normal user.
2071 cupsSetDests(int num_dests
, /* I - Number of destinations */
2072 cups_dest_t
*dests
) /* I - Destinations */
2074 cupsSetDests2(CUPS_HTTP_DEFAULT
, num_dests
, dests
);
2079 * 'cupsSetDests2()' - Save the list of destinations for the specified server.
2081 * This function saves the destinations to /etc/cups/lpoptions when run
2082 * as root and ~/.cups/lpoptions when run as a normal user.
2084 * @since CUPS 1.1.21/OS X 10.4@
2087 int /* O - 0 on success, -1 on error */
2088 cupsSetDests2(http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
2089 int num_dests
, /* I - Number of destinations */
2090 cups_dest_t
*dests
) /* I - Destinations */
2092 int i
, j
; /* Looping vars */
2093 int wrote
; /* Wrote definition? */
2094 cups_dest_t
*dest
; /* Current destination */
2095 cups_option_t
*option
; /* Current option */
2096 _ipp_option_t
*match
; /* Matching attribute for option */
2097 FILE *fp
; /* File pointer */
2099 const char *home
; /* HOME environment variable */
2101 char filename
[1024]; /* lpoptions file */
2102 int num_temps
; /* Number of temporary destinations */
2103 cups_dest_t
*temps
= NULL
, /* Temporary destinations */
2104 *temp
; /* Current temporary dest */
2105 const char *val
; /* Value of temporary option */
2106 _cups_globals_t
*cg
= _cupsGlobals(); /* Pointer to library globals */
2110 * Range check the input...
2113 if (!num_dests
|| !dests
)
2117 * Get the server destinations...
2120 num_temps
= _cupsGetDests(http
, CUPS_GET_PRINTERS
, NULL
, &temps
, 0, 0);
2122 if (cupsLastError() >= IPP_REDIRECTION_OTHER_SITE
)
2124 cupsFreeDests(num_temps
, temps
);
2129 * Figure out which file to write to...
2132 snprintf(filename
, sizeof(filename
), "%s/lpoptions", cg
->cups_serverroot
);
2138 * Merge in server defaults...
2141 num_temps
= cups_get_dests(filename
, NULL
, NULL
, 0, num_temps
, &temps
);
2144 * Point to user defaults...
2147 if ((home
= getenv("HOME")) != NULL
)
2150 * Create ~/.cups subdirectory...
2153 snprintf(filename
, sizeof(filename
), "%s/.cups", home
);
2154 if (access(filename
, 0))
2155 mkdir(filename
, 0700);
2157 snprintf(filename
, sizeof(filename
), "%s/.cups/lpoptions", home
);
2163 * Try to open the file...
2166 if ((fp
= fopen(filename
, "w")) == NULL
)
2168 cupsFreeDests(num_temps
, temps
);
2174 * Set the permissions to 0644 when saving to the /etc/cups/lpoptions
2179 fchmod(fileno(fp
), 0644);
2183 * Write each printer; each line looks like:
2185 * Dest name[/instance] options
2186 * Default name[/instance] options
2189 for (i
= num_dests
, dest
= dests
; i
> 0; i
--, dest
++)
2190 if (dest
->instance
!= NULL
|| dest
->num_options
!= 0 || dest
->is_default
)
2192 if (dest
->is_default
)
2194 fprintf(fp
, "Default %s", dest
->name
);
2196 fprintf(fp
, "/%s", dest
->instance
);
2203 if ((temp
= cupsGetDest(dest
->name
, dest
->instance
, num_temps
, temps
)) == NULL
)
2204 temp
= cupsGetDest(dest
->name
, NULL
, num_temps
, temps
);
2206 for (j
= dest
->num_options
, option
= dest
->options
; j
> 0; j
--, option
++)
2209 * See if this option is a printer attribute; if so, skip it...
2212 if ((match
= _ippFindOption(option
->name
)) != NULL
&&
2213 match
->group_tag
== IPP_TAG_PRINTER
)
2217 * See if the server/global options match these; if so, don't
2222 (val
= cupsGetOption(option
->name
, temp
->num_options
,
2223 temp
->options
)) != NULL
&&
2224 !_cups_strcasecmp(val
, option
->value
))
2228 * Options don't match, write to the file...
2233 fprintf(fp
, "Dest %s", dest
->name
);
2235 fprintf(fp
, "/%s", dest
->instance
);
2239 if (option
->value
[0])
2241 if (strchr(option
->value
, ' ') ||
2242 strchr(option
->value
, '\\') ||
2243 strchr(option
->value
, '\"') ||
2244 strchr(option
->value
, '\''))
2247 * Quote the value...
2250 fprintf(fp
, " %s=\"", option
->name
);
2252 for (val
= option
->value
; *val
; val
++)
2254 if (strchr("\"\'\\", *val
))
2265 * Store the literal value...
2268 fprintf(fp
, " %s=%s", option
->name
, option
->value
);
2272 fprintf(fp
, " %s", option
->name
);
2280 * Free the temporary destinations and close the file...
2283 cupsFreeDests(num_temps
, temps
);
2289 * Set the default printer for this location - this allows command-line
2290 * and GUI applications to share the same default destination...
2293 if ((dest
= cupsGetDest(NULL
, NULL
, num_dests
, dests
)) != NULL
)
2295 CFStringRef name
= CFStringCreateWithCString(kCFAllocatorDefault
,
2297 kCFStringEncodingUTF8
);
2298 /* Default printer name */
2302 _cupsAppleSetDefaultPrinter(name
);
2306 #endif /* __APPLE__ */
2308 #ifdef HAVE_NOTIFY_POST
2310 * Send a notification so that MacOS X applications can know about the
2314 notify_post("com.apple.printerListChange");
2315 #endif /* HAVE_NOTIFY_POST */
2322 * '_cupsUserDefault()' - Get the user default printer from environment
2323 * variables and location information.
2326 char * /* O - Default printer or NULL */
2327 _cupsUserDefault(char *name
, /* I - Name buffer */
2328 size_t namesize
) /* I - Size of name buffer */
2330 const char *env
; /* LPDEST or PRINTER env variable */
2332 CFStringRef locprinter
; /* Last printer as this location */
2333 #endif /* __APPLE__ */
2336 if ((env
= getenv("LPDEST")) == NULL
)
2337 if ((env
= getenv("PRINTER")) != NULL
&& !strcmp(env
, "lp"))
2342 strlcpy(name
, env
, namesize
);
2348 * Use location-based defaults if "use last printer" is selected in the
2349 * system preferences...
2352 if ((locprinter
= _cupsAppleCopyDefaultPrinter()) != NULL
)
2354 CFStringGetCString(locprinter
, name
, namesize
, kCFStringEncodingUTF8
);
2355 CFRelease(locprinter
);
2360 DEBUG_printf(("1_cupsUserDefault: Returning \"%s\".", name
));
2362 return (*name
? name
: NULL
);
2366 * No location-based defaults on this platform...
2371 #endif /* __APPLE__ */
2377 * 'appleCopyLocations()' - Copy the location history array.
2380 static CFArrayRef
/* O - Location array or NULL */
2381 appleCopyLocations(void)
2383 CFArrayRef locations
; /* Location array */
2387 * Look up the location array in the preferences...
2390 if ((locations
= CFPreferencesCopyAppValue(kLastUsedPrintersKey
,
2391 kCUPSPrintingPrefs
)) == NULL
)
2394 if (CFGetTypeID(locations
) != CFArrayGetTypeID())
2396 CFRelease(locations
);
2405 * 'appleCopyNetwork()' - Get the network ID for the current location.
2408 static CFStringRef
/* O - Network ID */
2409 appleCopyNetwork(void)
2411 SCDynamicStoreRef dynamicStore
; /* System configuration data */
2412 CFStringRef key
; /* Current network configuration key */
2413 CFDictionaryRef ip_dict
; /* Network configuration data */
2414 CFStringRef network
= NULL
; /* Current network ID */
2417 if ((dynamicStore
= SCDynamicStoreCreate(NULL
, CFSTR("libcups"), NULL
,
2421 * First use the IPv6 router address, if available, since that will generally
2422 * be a globally-unique link-local address.
2425 if ((key
= SCDynamicStoreKeyCreateNetworkGlobalEntity(
2426 NULL
, kSCDynamicStoreDomainState
, kSCEntNetIPv6
)) != NULL
)
2428 if ((ip_dict
= SCDynamicStoreCopyValue(dynamicStore
, key
)) != NULL
)
2430 if ((network
= CFDictionaryGetValue(ip_dict
,
2431 kSCPropNetIPv6Router
)) != NULL
)
2441 * If that doesn't work, try the IPv4 router address. This isn't as unique
2442 * and will likely be a 10.x.y.z or 192.168.y.z address...
2447 if ((key
= SCDynamicStoreKeyCreateNetworkGlobalEntity(
2448 NULL
, kSCDynamicStoreDomainState
, kSCEntNetIPv4
)) != NULL
)
2450 if ((ip_dict
= SCDynamicStoreCopyValue(dynamicStore
, key
)) != NULL
)
2452 if ((network
= CFDictionaryGetValue(ip_dict
,
2453 kSCPropNetIPv4Router
)) != NULL
)
2463 CFRelease(dynamicStore
);
2471 * 'appleGetPaperSize()' - Get the default paper size.
2474 static char * /* O - Default paper size */
2475 appleGetPaperSize(char *name
, /* I - Paper size name buffer */
2476 int namesize
) /* I - Size of buffer */
2478 CFStringRef defaultPaperID
; /* Default paper ID */
2479 _pwg_media_t
*pwgmedia
; /* PWG media size */
2482 defaultPaperID
= _cupsAppleCopyDefaultPaperID();
2483 if (!defaultPaperID
||
2484 CFGetTypeID(defaultPaperID
) != CFStringGetTypeID() ||
2485 !CFStringGetCString(defaultPaperID
, name
, namesize
,
2486 kCFStringEncodingUTF8
))
2488 else if ((pwgmedia
= _pwgMediaForLegacy(name
)) != NULL
)
2489 strlcpy(name
, pwgmedia
->pwg
, namesize
);
2492 CFRelease(defaultPaperID
);
2499 * 'appleGetPrinter()' - Get a printer from the history array.
2502 static CFStringRef
/* O - Printer name or NULL */
2503 appleGetPrinter(CFArrayRef locations
, /* I - Location array */
2504 CFStringRef network
, /* I - Network name */
2505 CFIndex
*locindex
) /* O - Index in array */
2507 CFIndex i
, /* Looping var */
2508 count
; /* Number of locations */
2509 CFDictionaryRef location
; /* Current location */
2510 CFStringRef locnetwork
, /* Current network */
2511 locprinter
; /* Current printer */
2514 for (i
= 0, count
= CFArrayGetCount(locations
); i
< count
; i
++)
2515 if ((location
= CFArrayGetValueAtIndex(locations
, i
)) != NULL
&&
2516 CFGetTypeID(location
) == CFDictionaryGetTypeID())
2518 if ((locnetwork
= CFDictionaryGetValue(location
,
2519 kLocationNetworkKey
)) != NULL
&&
2520 CFGetTypeID(locnetwork
) == CFStringGetTypeID() &&
2521 CFStringCompare(network
, locnetwork
, 0) == kCFCompareEqualTo
&&
2522 (locprinter
= CFDictionaryGetValue(location
,
2523 kLocationPrinterIDKey
)) != NULL
&&
2524 CFGetTypeID(locprinter
) == CFStringGetTypeID())
2529 return (locprinter
);
2535 #endif /* __APPLE__ */
2539 * 'cups_add_dest()' - Add a destination to the array.
2541 * Unlike cupsAddDest(), this function does not check for duplicates.
2544 static cups_dest_t
* /* O - New destination */
2545 cups_add_dest(const char *name
, /* I - Name of destination */
2546 const char *instance
, /* I - Instance or NULL */
2547 int *num_dests
, /* IO - Number of destinations */
2548 cups_dest_t
**dests
) /* IO - Destinations */
2550 int insert
, /* Insertion point */
2551 diff
; /* Result of comparison */
2552 cups_dest_t
*dest
; /* Destination pointer */
2556 * Add new destination...
2559 if (*num_dests
== 0)
2560 dest
= malloc(sizeof(cups_dest_t
));
2562 dest
= realloc(*dests
, sizeof(cups_dest_t
) * (*num_dests
+ 1));
2570 * Find where to insert the destination...
2573 if (*num_dests
== 0)
2577 insert
= cups_find_dest(name
, instance
, *num_dests
, *dests
, *num_dests
- 1,
2585 * Move the array elements as needed...
2588 if (insert
< *num_dests
)
2589 memmove(*dests
+ insert
+ 1, *dests
+ insert
,
2590 (*num_dests
- insert
) * sizeof(cups_dest_t
));
2595 * Initialize the destination...
2598 dest
= *dests
+ insert
;
2599 dest
->name
= _cupsStrAlloc(name
);
2600 dest
->instance
= _cupsStrAlloc(instance
);
2601 dest
->is_default
= 0;
2602 dest
->num_options
= 0;
2603 dest
->options
= (cups_option_t
*)0;
2611 * 'cups_block_cb()' - Enumeration callback for block API.
2614 static int /* O - 1 to continue, 0 to stop */
2616 cups_dest_block_t block
, /* I - Block */
2617 unsigned flags
, /* I - Destination flags */
2618 cups_dest_t
*dest
) /* I - Destination */
2620 return ((block
)(flags
, dest
));
2622 # endif /* __BLOCKS__ */
2626 * 'cups_compare_dests()' - Compare two destinations.
2629 static int /* O - Result of comparison */
2630 cups_compare_dests(cups_dest_t
*a
, /* I - First destination */
2631 cups_dest_t
*b
) /* I - Second destination */
2633 int diff
; /* Difference */
2636 if ((diff
= _cups_strcasecmp(a
->name
, b
->name
)) != 0)
2638 else if (a
->instance
&& b
->instance
)
2639 return (_cups_strcasecmp(a
->instance
, b
->instance
));
2641 return ((a
->instance
&& !b
->instance
) - (!a
->instance
&& b
->instance
));
2645 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
2648 * 'cups_dnssd_browse_cb()' - Browse for printers.
2652 cups_dnssd_browse_cb(
2653 DNSServiceRef sdRef
, /* I - Service reference */
2654 DNSServiceFlags flags
, /* I - Option flags */
2655 uint32_t interfaceIndex
, /* I - Interface number */
2656 DNSServiceErrorType errorCode
, /* I - Error, if any */
2657 const char *serviceName
, /* I - Name of service/device */
2658 const char *regtype
, /* I - Type of service */
2659 const char *replyDomain
, /* I - Service domain */
2660 void *context
) /* I - Enumeration data */
2662 _cups_dnssd_data_t
*data
= (_cups_dnssd_data_t
*)context
;
2663 /* Enumeration data */
2666 DEBUG_printf(("5cups_dnssd_browse_cb(sdRef=%p, flags=%x, "
2667 "interfaceIndex=%d, errorCode=%d, serviceName=\"%s\", "
2668 "regtype=\"%s\", replyDomain=\"%s\", context=%p)",
2669 sdRef
, flags
, interfaceIndex
, errorCode
, serviceName
, regtype
,
2670 replyDomain
, context
));
2673 * Don't do anything on error...
2676 if (errorCode
!= kDNSServiceErr_NoError
)
2683 cups_dnssd_get_device(data
, serviceName
, regtype
, replyDomain
);
2687 # else /* HAVE_AVAHI */
2689 * 'cups_dnssd_browse_cb()' - Browse for printers.
2693 cups_dnssd_browse_cb(
2694 AvahiServiceBrowser
*browser
, /* I - Browser */
2695 AvahiIfIndex interface
, /* I - Interface index (unused) */
2696 AvahiProtocol protocol
, /* I - Network protocol (unused) */
2697 AvahiBrowserEvent event
, /* I - What happened */
2698 const char *name
, /* I - Service name */
2699 const char *type
, /* I - Registration type */
2700 const char *domain
, /* I - Domain */
2701 AvahiLookupResultFlags flags
, /* I - Flags */
2702 void *context
) /* I - Devices array */
2705 AvahiClient
*client
= avahi_service_browser_get_client(browser
);
2706 /* Client information */
2708 _cups_dnssd_data_t
*data
= (_cups_dnssd_data_t
*)context
;
2709 /* Enumeration data */
2718 case AVAHI_BROWSER_FAILURE
:
2719 DEBUG_printf(("cups_dnssd_browse_cb: %s",
2720 avahi_strerror(avahi_client_errno(client
))));
2721 avahi_simple_poll_quit(data
->simple_poll
);
2724 case AVAHI_BROWSER_NEW
:
2726 * This object is new on the network.
2729 if (flags
& AVAHI_LOOKUP_RESULT_LOCAL
)
2732 * This comes from the local machine so ignore it.
2735 DEBUG_printf(("cups_dnssd_browse_cb: Ignoring local service \"%s\".",
2741 * Create a device entry for it if it doesn't yet exist.
2744 cups_dnssd_get_device(data
, name
, type
, domain
);
2748 case AVAHI_BROWSER_REMOVE
:
2749 case AVAHI_BROWSER_ALL_FOR_NOW
:
2750 case AVAHI_BROWSER_CACHE_EXHAUSTED
:
2757 * 'cups_dnssd_client_cb()' - Avahi client callback function.
2761 cups_dnssd_client_cb(
2762 AvahiClient
*client
, /* I - Client information (unused) */
2763 AvahiClientState state
, /* I - Current state */
2764 void *context
) /* I - User data (unused) */
2766 _cups_dnssd_data_t
*data
= (_cups_dnssd_data_t
*)context
;
2767 /* Enumeration data */
2773 * If the connection drops, quit.
2776 if (state
== AVAHI_CLIENT_FAILURE
)
2778 DEBUG_puts("cups_dnssd_client_cb: Avahi connection failed.");
2779 avahi_simple_poll_quit(data
->simple_poll
);
2782 # endif /* HAVE_DNSSD */
2786 * 'cups_dnssd_compare_device()' - Compare two devices.
2789 static int /* O - Result of comparison */
2790 cups_dnssd_compare_devices(
2791 _cups_dnssd_device_t
*a
, /* I - First device */
2792 _cups_dnssd_device_t
*b
) /* I - Second device */
2794 return (strcmp(a
->dest
.name
, b
->dest
.name
));
2799 * 'cups_dnssd_free_device()' - Free the memory used by a device.
2803 cups_dnssd_free_device(
2804 _cups_dnssd_device_t
*device
, /* I - Device */
2805 _cups_dnssd_data_t
*data
) /* I - Enumeration data */
2807 DEBUG_printf(("5cups_dnssd_free_device(device=%p(%s), data=%p)", device
,
2808 device
->dest
.name
, data
));
2812 DNSServiceRefDeallocate(device
->ref
);
2813 # else /* HAVE_AVAHI */
2815 avahi_record_browser_free(device
->ref
);
2816 # endif /* HAVE_DNSSD */
2818 _cupsStrFree(device
->domain
);
2819 _cupsStrFree(device
->fullName
);
2820 _cupsStrFree(device
->regtype
);
2821 _cupsStrFree(device
->dest
.name
);
2823 cupsFreeOptions(device
->dest
.num_options
, device
->dest
.options
);
2830 * 'cups_dnssd_get_device()' - Lookup a device and create it as needed.
2833 static _cups_dnssd_device_t
* /* O - Device */
2834 cups_dnssd_get_device(
2835 _cups_dnssd_data_t
*data
, /* I - Enumeration data */
2836 const char *serviceName
, /* I - Service name */
2837 const char *regtype
, /* I - Registration type */
2838 const char *replyDomain
) /* I - Domain name */
2840 _cups_dnssd_device_t key
, /* Search key */
2841 *device
; /* Device */
2842 char fullName
[kDNSServiceMaxDomainName
];
2843 /* Full name for query */
2846 DEBUG_printf(("5cups_dnssd_get_device(data=%p, serviceName=\"%s\", "
2847 "regtype=\"%s\", replyDomain=\"%s\")", data
, serviceName
,
2848 regtype
, replyDomain
));
2851 * See if this is an existing device...
2854 key
.dest
.name
= (char *)serviceName
;
2856 if ((device
= cupsArrayFind(data
->devices
, &key
)) != NULL
)
2859 * Yes, see if we need to do anything with this...
2862 int update
= 0; /* Non-zero if we need to update */
2864 if (!_cups_strcasecmp(replyDomain
, "local.") &&
2865 _cups_strcasecmp(device
->domain
, replyDomain
))
2868 * Update the "global" listing to use the .local domain name instead.
2871 _cupsStrFree(device
->domain
);
2872 device
->domain
= _cupsStrAlloc(replyDomain
);
2874 DEBUG_printf(("6cups_dnssd_get_device: Updating '%s' to use local "
2875 "domain.", device
->dest
.name
));
2880 if (!_cups_strcasecmp(regtype
, "_ipps._tcp") &&
2881 _cups_strcasecmp(device
->regtype
, regtype
))
2884 * Prefer IPPS over IPP.
2887 _cupsStrFree(device
->regtype
);
2888 device
->regtype
= _cupsStrAlloc(regtype
);
2890 DEBUG_printf(("6cups_dnssd_get_device: Updating '%s' to use IPPS.",
2891 device
->dest
.name
));
2898 DEBUG_printf(("6cups_dnssd_get_device: No changes to '%s'.",
2899 device
->dest
.name
));
2906 * No, add the device...
2909 DEBUG_printf(("6cups_dnssd_get_device: Adding '%s' for %s with domain "
2910 "'%s'.", serviceName
,
2911 !strcmp(regtype
, "_ipps._tcp") ? "IPPS" : "IPP",
2914 device
= calloc(sizeof(_cups_dnssd_device_t
), 1);
2915 device
->dest
.name
= _cupsStrAlloc(serviceName
);
2916 device
->domain
= _cupsStrAlloc(replyDomain
);
2917 device
->regtype
= _cupsStrAlloc(regtype
);
2919 cupsArrayAdd(data
->devices
, device
);
2923 * Set the "full name" of this service, which is used for queries...
2927 DNSServiceConstructFullName(fullName
, device
->dest
.name
, device
->regtype
,
2929 # else /* HAVE_AVAHI */
2930 avahi_service_name_join(fullName
, kDNSServiceMaxDomainName
, serviceName
,
2931 regtype
, replyDomain
);
2932 # endif /* HAVE_DNSSD */
2934 _cupsStrFree(device
->fullName
);
2935 device
->fullName
= _cupsStrAlloc(fullName
);
2940 DNSServiceRefDeallocate(device
->ref
);
2941 # else /* HAVE_AVAHI */
2942 avahi_record_browser_free(device
->ref
);
2943 # endif /* HAVE_DNSSD */
2948 if (device
->state
== _CUPS_DNSSD_ACTIVE
)
2950 (*data
->cb
)(data
->user_data
, CUPS_DEST_FLAGS_REMOVED
, &device
->dest
);
2951 device
->state
= _CUPS_DNSSD_NEW
;
2960 * 'cups_dnssd_local_cb()' - Browse for local printers.
2964 cups_dnssd_local_cb(
2965 DNSServiceRef sdRef
, /* I - Service reference */
2966 DNSServiceFlags flags
, /* I - Option flags */
2967 uint32_t interfaceIndex
, /* I - Interface number */
2968 DNSServiceErrorType errorCode
, /* I - Error, if any */
2969 const char *serviceName
, /* I - Name of service/device */
2970 const char *regtype
, /* I - Type of service */
2971 const char *replyDomain
, /* I - Service domain */
2972 void *context
) /* I - Devices array */
2974 _cups_dnssd_data_t
*data
= (_cups_dnssd_data_t
*)context
;
2975 /* Enumeration data */
2976 _cups_dnssd_device_t
*device
; /* Device */
2979 DEBUG_printf(("5cups_dnssd_local_cb(sdRef=%p, flags=%x, "
2980 "interfaceIndex=%d, errorCode=%d, serviceName=\"%s\", "
2981 "regtype=\"%s\", replyDomain=\"%s\", context=%p)",
2982 sdRef
, flags
, interfaceIndex
, errorCode
, serviceName
,
2983 regtype
, replyDomain
, context
));
2986 * Only process "add" data...
2989 if (errorCode
!= kDNSServiceErr_NoError
|| !(flags
& kDNSServiceFlagsAdd
))
2996 device
= cups_dnssd_get_device(data
, serviceName
, regtype
, replyDomain
);
2999 * Hide locally-registered devices...
3002 DEBUG_printf(("6cups_dnssd_local_cb: Hiding local printer '%s'.",
3007 DNSServiceRefDeallocate(device
->ref
);
3011 if (device
->state
== _CUPS_DNSSD_ACTIVE
)
3012 (*data
->cb
)(data
->user_data
, CUPS_DEST_FLAGS_REMOVED
, &device
->dest
);
3014 device
->state
= _CUPS_DNSSD_LOCAL
;
3016 # endif /* HAVE_DNSSD */
3021 * 'cups_dnssd_poll_cb()' - Wait for input on the specified file descriptors.
3023 * Note: This function is needed because avahi_simple_poll_iterate is broken
3024 * and always uses a timeout of 0 (!) milliseconds.
3025 * (Avahi Ticket #364)
3028 static int /* O - Number of file descriptors matching */
3030 struct pollfd
*pollfds
, /* I - File descriptors */
3031 unsigned int num_pollfds
, /* I - Number of file descriptors */
3032 int timeout
, /* I - Timeout in milliseconds (unused) */
3033 void *context
) /* I - User data (unused) */
3035 _cups_dnssd_data_t
*data
= (_cups_dnssd_data_t
*)context
;
3036 /* Enumeration data */
3037 int val
; /* Return value */
3042 val
= poll(pollfds
, num_pollfds
, 250);
3046 DEBUG_printf(("cups_dnssd_poll_cb: %s", strerror(errno
)));
3053 # endif /* HAVE_AVAHI */
3057 * 'cups_dnssd_query_cb()' - Process query data.
3062 cups_dnssd_query_cb(
3063 DNSServiceRef sdRef
, /* I - Service reference */
3064 DNSServiceFlags flags
, /* I - Data flags */
3065 uint32_t interfaceIndex
, /* I - Interface */
3066 DNSServiceErrorType errorCode
, /* I - Error, if any */
3067 const char *fullName
, /* I - Full service name */
3068 uint16_t rrtype
, /* I - Record type */
3069 uint16_t rrclass
, /* I - Record class */
3070 uint16_t rdlen
, /* I - Length of record data */
3071 const void *rdata
, /* I - Record data */
3072 uint32_t ttl
, /* I - Time-to-live */
3073 void *context
) /* I - Enumeration data */
3075 # else /* HAVE_AVAHI */
3077 cups_dnssd_query_cb(
3078 AvahiRecordBrowser
*browser
, /* I - Record browser */
3079 AvahiIfIndex interfaceIndex
,
3080 /* I - Interface index (unused) */
3081 AvahiProtocol protocol
, /* I - Network protocol (unused) */
3082 AvahiBrowserEvent event
, /* I - What happened? */
3083 const char *fullName
, /* I - Service name */
3084 uint16_t rrclass
, /* I - Record class */
3085 uint16_t rrtype
, /* I - Record type */
3086 const void *rdata
, /* I - TXT record */
3087 size_t rdlen
, /* I - Length of TXT record */
3088 AvahiLookupResultFlags flags
, /* I - Flags */
3089 void *context
) /* I - Enumeration data */
3092 AvahiClient
*client
= avahi_record_browser_get_client(browser
);
3093 /* Client information */
3095 # endif /* HAVE_DNSSD */
3096 _cups_dnssd_data_t
*data
= (_cups_dnssd_data_t
*)context
;
3097 /* Enumeration data */
3098 char name
[1024], /* Service name */
3099 *ptr
; /* Pointer into string */
3100 _cups_dnssd_device_t dkey
, /* Search key */
3101 *device
; /* Device */
3105 DEBUG_printf(("5cups_dnssd_query_cb(sdRef=%p, flags=%x, "
3106 "interfaceIndex=%d, errorCode=%d, fullName=\"%s\", "
3107 "rrtype=%u, rrclass=%u, rdlen=%u, rdata=%p, ttl=%u, "
3108 "context=%p)", sdRef
, flags
, interfaceIndex
, errorCode
,
3109 fullName
, rrtype
, rrclass
, rdlen
, rdata
, ttl
, context
));
3112 * Only process "add" data...
3115 if (errorCode
!= kDNSServiceErr_NoError
|| !(flags
& kDNSServiceFlagsAdd
))
3118 # else /* HAVE_AVAHI */
3119 DEBUG_printf(("5cups_dnssd_query_cb(browser=%p, interfaceIndex=%d, "
3120 "protocol=%d, event=%d, fullName=\"%s\", rrclass=%u, "
3121 "rrtype=%u, rdata=%p, rdlen=%u, flags=%x, context=%p)",
3122 browser
, interfaceIndex
, protocol
, event
, fullName
, rrclass
,
3123 rrtype
, rdata
, (unsigned)rdlen
, flags
, context
));
3126 * Only process "add" data...
3129 if (event
!= AVAHI_BROWSER_NEW
)
3131 if (event
== AVAHI_BROWSER_FAILURE
)
3132 DEBUG_printf(("cups_dnssd_query_cb: %s",
3133 avahi_strerror(avahi_client_errno(client
))));
3137 # endif /* HAVE_DNSSD */
3140 * Lookup the service in the devices array.
3143 dkey
.dest
.name
= name
;
3145 cups_dnssd_unquote(name
, fullName
, sizeof(name
));
3147 if ((ptr
= strstr(name
, "._")) != NULL
)
3150 if ((device
= cupsArrayFind(data
->devices
, &dkey
)) != NULL
)
3153 * Found it, pull out the make and model from the TXT record and save it...
3156 const uint8_t *txt
, /* Pointer into data */
3157 *txtnext
, /* Next key/value pair */
3158 *txtend
; /* End of entire TXT record */
3159 uint8_t txtlen
; /* Length of current key/value pair */
3160 char key
[256], /* Key string */
3161 value
[256], /* Value string */
3162 make_and_model
[512],
3163 /* Manufacturer and model */
3164 model
[256], /* Model */
3165 uriname
[1024], /* Name for URI */
3166 uri
[1024]; /* Printer URI */
3167 cups_ptype_t type
= CUPS_PRINTER_REMOTE
| CUPS_PRINTER_BW
;
3169 int saw_printer_type
= 0;
3170 /* Did we see a printer-type key? */
3172 device
->state
= _CUPS_DNSSD_PENDING
;
3173 make_and_model
[0] = '\0';
3175 strlcpy(model
, "Unknown", sizeof(model
));
3177 for (txt
= rdata
, txtend
= txt
+ rdlen
;
3182 * Read a key/value pair starting with an 8-bit length. Since the
3183 * length is 8 bits and the size of the key/value buffers is 256, we
3184 * don't need to check for overflow...
3189 if (!txtlen
|| (txt
+ txtlen
) > txtend
)
3192 txtnext
= txt
+ txtlen
;
3194 for (ptr
= key
; txt
< txtnext
&& *txt
!= '='; txt
++)
3198 if (txt
< txtnext
&& *txt
== '=')
3203 memcpy(value
, txt
, txtnext
- txt
);
3204 value
[txtnext
- txt
] = '\0';
3206 DEBUG_printf(("6cups_dnssd_query_cb: %s=%s", key
, value
));
3210 DEBUG_printf(("6cups_dnssd_query_cb: '%s' with no value.", key
));
3214 if (!_cups_strcasecmp(key
, "usb_MFG") ||
3215 !_cups_strcasecmp(key
, "usb_MANU") ||
3216 !_cups_strcasecmp(key
, "usb_MANUFACTURER"))
3217 strlcpy(make_and_model
, value
, sizeof(make_and_model
));
3218 else if (!_cups_strcasecmp(key
, "usb_MDL") ||
3219 !_cups_strcasecmp(key
, "usb_MODEL"))
3220 strlcpy(model
, value
, sizeof(model
));
3221 else if (!_cups_strcasecmp(key
, "product") && !strstr(value
, "Ghostscript"))
3223 if (value
[0] == '(')
3226 * Strip parenthesis...
3229 if ((ptr
= value
+ strlen(value
) - 1) > value
&& *ptr
== ')')
3232 strlcpy(model
, value
+ 1, sizeof(model
));
3235 strlcpy(model
, value
, sizeof(model
));
3237 else if (!_cups_strcasecmp(key
, "ty"))
3239 strlcpy(model
, value
, sizeof(model
));
3241 if ((ptr
= strchr(model
, ',')) != NULL
)
3244 else if (!_cups_strcasecmp(key
, "note"))
3245 device
->dest
.num_options
= cupsAddOption("printer-location", value
,
3246 device
->dest
.num_options
,
3247 &device
->dest
.options
);
3248 else if (!_cups_strcasecmp(key
, "pdl"))
3251 * Look for PDF-capable printers; only PDF-capable printers are shown.
3254 const char *start
, *next
; /* Pointer into value */
3255 int have_pdf
= 0; /* Have PDF? */
3257 for (start
= value
; start
&& *start
; start
= next
)
3259 if (!_cups_strncasecmp(start
, "application/pdf", 15) &&
3260 (!start
[15] || start
[15] == ','))
3266 if ((next
= strchr(start
, ',')) != NULL
)
3271 device
->state
= _CUPS_DNSSD_INCOMPATIBLE
;
3273 else if (!_cups_strcasecmp(key
, "printer-type"))
3276 * Value is either NNNN or 0xXXXX
3279 saw_printer_type
= 1;
3280 type
= strtol(value
, NULL
, 0);
3282 else if (!saw_printer_type
)
3284 if (!_cups_strcasecmp(key
, "air") &&
3285 !_cups_strcasecmp(value
, "t"))
3286 type
|= CUPS_PRINTER_AUTHENTICATED
;
3287 else if (!_cups_strcasecmp(key
, "bind") &&
3288 !_cups_strcasecmp(value
, "t"))
3289 type
|= CUPS_PRINTER_BIND
;
3290 else if (!_cups_strcasecmp(key
, "collate") &&
3291 !_cups_strcasecmp(value
, "t"))
3292 type
|= CUPS_PRINTER_COLLATE
;
3293 else if (!_cups_strcasecmp(key
, "color") &&
3294 !_cups_strcasecmp(value
, "t"))
3295 type
|= CUPS_PRINTER_COLOR
;
3296 else if (!_cups_strcasecmp(key
, "copies") &&
3297 !_cups_strcasecmp(value
, "t"))
3298 type
|= CUPS_PRINTER_COPIES
;
3299 else if (!_cups_strcasecmp(key
, "duplex") &&
3300 !_cups_strcasecmp(value
, "t"))
3301 type
|= CUPS_PRINTER_DUPLEX
;
3302 else if (!_cups_strcasecmp(key
, "fax") &&
3303 !_cups_strcasecmp(value
, "t"))
3304 type
|= CUPS_PRINTER_MFP
;
3305 else if (!_cups_strcasecmp(key
, "papercustom") &&
3306 !_cups_strcasecmp(value
, "t"))
3307 type
|= CUPS_PRINTER_VARIABLE
;
3308 else if (!_cups_strcasecmp(key
, "papermax"))
3310 if (!_cups_strcasecmp(value
, "legal-a4"))
3311 type
|= CUPS_PRINTER_SMALL
;
3312 else if (!_cups_strcasecmp(value
, "isoc-a2"))
3313 type
|= CUPS_PRINTER_MEDIUM
;
3314 else if (!_cups_strcasecmp(value
, ">isoc-a2"))
3315 type
|= CUPS_PRINTER_LARGE
;
3317 else if (!_cups_strcasecmp(key
, "punch") &&
3318 !_cups_strcasecmp(value
, "t"))
3319 type
|= CUPS_PRINTER_PUNCH
;
3320 else if (!_cups_strcasecmp(key
, "scan") &&
3321 !_cups_strcasecmp(value
, "t"))
3322 type
|= CUPS_PRINTER_MFP
;
3323 else if (!_cups_strcasecmp(key
, "sort") &&
3324 !_cups_strcasecmp(value
, "t"))
3325 type
|= CUPS_PRINTER_SORT
;
3326 else if (!_cups_strcasecmp(key
, "staple") &&
3327 !_cups_strcasecmp(value
, "t"))
3328 type
|= CUPS_PRINTER_STAPLE
;
3333 * Save the printer-xxx values...
3336 device
->dest
.num_options
= cupsAddOption("printer-info", name
,
3337 device
->dest
.num_options
,
3338 &device
->dest
.options
);
3340 if (make_and_model
[0])
3342 strlcat(make_and_model
, " ", sizeof(make_and_model
));
3343 strlcat(make_and_model
, model
, sizeof(make_and_model
));
3345 device
->dest
.num_options
= cupsAddOption("printer-make-and-model",
3347 device
->dest
.num_options
,
3348 &device
->dest
.options
);
3351 device
->dest
.num_options
= cupsAddOption("printer-make-and-model",
3353 device
->dest
.num_options
,
3354 &device
->dest
.options
);
3356 device
->type
= type
;
3357 snprintf(value
, sizeof(value
), "%u", type
);
3358 device
->dest
.num_options
= cupsAddOption("printer-type", value
,
3359 device
->dest
.num_options
,
3360 &device
->dest
.options
);
3366 cups_dnssd_unquote(uriname
, device
->fullName
, sizeof(uriname
));
3367 httpAssembleURI(HTTP_URI_CODING_ALL
, uri
, sizeof(uri
),
3368 !strcmp(device
->regtype
, "_ipps._tcp") ? "ipps" : "ipp",
3369 NULL
, uriname
, 0, saw_printer_type
? "/cups" : "/");
3371 DEBUG_printf(("6cups_dnssd_query: printer-uri-supported=\"%s\"", uri
));
3373 device
->dest
.num_options
= cupsAddOption("printer-uri-supported", uri
,
3374 device
->dest
.num_options
,
3375 &device
->dest
.options
);
3378 DEBUG_printf(("6cups_dnssd_query: Ignoring TXT record for '%s'.",
3384 * 'cups_dnssd_resolve()' - Resolve a Bonjour printer URI.
3387 static const char * /* O - Resolved URI or NULL */
3389 cups_dest_t
*dest
, /* I - Destination */
3390 const char *uri
, /* I - Current printer URI */
3391 int msec
, /* I - Time in milliseconds */
3392 int *cancel
, /* I - Pointer to "cancel" variable */
3393 cups_dest_cb_t cb
, /* I - Callback */
3394 void *user_data
) /* I - User data for callback */
3396 char tempuri
[1024]; /* Temporary URI buffer */
3397 _cups_dnssd_resolve_t resolve
; /* Resolve data */
3401 * Resolve the URI...
3404 resolve
.cancel
= cancel
;
3405 gettimeofday(&resolve
.end_time
, NULL
);
3408 resolve
.end_time
.tv_sec
+= msec
/ 1000;
3409 resolve
.end_time
.tv_usec
+= (msec
% 1000) * 1000;
3411 while (resolve
.end_time
.tv_usec
>= 1000000)
3413 resolve
.end_time
.tv_sec
++;
3414 resolve
.end_time
.tv_usec
-= 1000000;
3418 resolve
.end_time
.tv_sec
+= 75;
3421 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_RESOLVING
,
3424 if ((uri
= _httpResolveURI(uri
, tempuri
, sizeof(tempuri
),
3425 _HTTP_RESOLVE_FQDN
, cups_dnssd_resolve_cb
,
3428 _cupsSetError(IPP_INTERNAL_ERROR
, _("Unable to resolve printer URI."), 1);
3431 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_ERROR
,
3438 * Save the resolved URI...
3441 dest
->num_options
= cupsAddOption("printer-uri-supported", uri
,
3442 dest
->num_options
, &dest
->options
);
3444 return (cupsGetOption("printer-uri-supported", dest
->num_options
,
3450 * 'cups_dnssd_resolve_cb()' - See if we should continue resolving.
3453 static int /* O - 1 to continue, 0 to stop */
3454 cups_dnssd_resolve_cb(void *context
) /* I - Resolve data */
3456 _cups_dnssd_resolve_t
*resolve
= (_cups_dnssd_resolve_t
*)context
;
3458 struct timeval curtime
; /* Current time */
3462 * If the cancel variable is set, return immediately.
3465 if (*resolve
->cancel
)
3469 * Otherwise check the end time...
3472 gettimeofday(&curtime
, NULL
);
3474 return (curtime
.tv_sec
> resolve
->end_time
.tv_sec
||
3475 (curtime
.tv_sec
== resolve
->end_time
.tv_sec
&&
3476 curtime
.tv_usec
> resolve
->end_time
.tv_usec
));
3481 * 'cups_dnssd_unquote()' - Unquote a name string.
3485 cups_dnssd_unquote(char *dst
, /* I - Destination buffer */
3486 const char *src
, /* I - Source string */
3487 size_t dstsize
) /* I - Size of destination buffer */
3489 char *dstend
= dst
+ dstsize
- 1; /* End of destination buffer */
3492 while (*src
&& dst
< dstend
)
3497 if (isdigit(src
[0] & 255) && isdigit(src
[1] & 255) &&
3498 isdigit(src
[2] & 255))
3500 *dst
++ = ((((src
[0] - '0') * 10) + src
[1] - '0') * 10) + src
[2] - '0';
3512 #endif /* HAVE_DNSSD */
3516 * 'cups_find_dest()' - Find a destination using a binary search.
3519 static int /* O - Index of match */
3520 cups_find_dest(const char *name
, /* I - Destination name */
3521 const char *instance
, /* I - Instance or NULL */
3522 int num_dests
, /* I - Number of destinations */
3523 cups_dest_t
*dests
, /* I - Destinations */
3524 int prev
, /* I - Previous index */
3525 int *rdiff
) /* O - Difference of match */
3527 int left
, /* Low mark for binary search */
3528 right
, /* High mark for binary search */
3529 current
, /* Current index */
3530 diff
; /* Result of comparison */
3531 cups_dest_t key
; /* Search key */
3534 key
.name
= (char *)name
;
3535 key
.instance
= (char *)instance
;
3540 * Start search on either side of previous...
3543 if ((diff
= cups_compare_dests(&key
, dests
+ prev
)) == 0 ||
3544 (diff
< 0 && prev
== 0) ||
3545 (diff
> 0 && prev
== (num_dests
- 1)))
3553 * Start with previous on right side...
3562 * Start wih previous on left side...
3566 right
= num_dests
- 1;
3572 * Start search in the middle...
3576 right
= num_dests
- 1;
3581 current
= (left
+ right
) / 2;
3582 diff
= cups_compare_dests(&key
, dests
+ current
);
3591 while ((right
- left
) > 1);
3596 * Check the last 1 or 2 elements...
3599 if ((diff
= cups_compare_dests(&key
, dests
+ left
)) <= 0)
3603 diff
= cups_compare_dests(&key
, dests
+ right
);
3609 * Return the closest destination and the difference...
3619 * 'cups_get_default()' - Get the default destination from an lpoptions file.
3622 static char * /* O - Default destination or NULL */
3623 cups_get_default(const char *filename
, /* I - File to read */
3624 char *namebuf
, /* I - Name buffer */
3625 size_t namesize
, /* I - Size of name buffer */
3626 const char **instance
) /* I - Instance */
3628 cups_file_t
*fp
; /* lpoptions file */
3629 char line
[8192], /* Line from file */
3630 *value
, /* Value for line */
3631 *nameptr
; /* Pointer into name */
3632 int linenum
; /* Current line */
3637 if ((fp
= cupsFileOpen(filename
, "r")) != NULL
)
3641 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
3643 if (!_cups_strcasecmp(line
, "default") && value
)
3645 strlcpy(namebuf
, value
, namesize
);
3647 if ((nameptr
= strchr(namebuf
, ' ')) != NULL
)
3649 if ((nameptr
= strchr(namebuf
, '\t')) != NULL
)
3652 if ((nameptr
= strchr(namebuf
, '/')) != NULL
)
3655 *instance
= nameptr
;
3663 return (*namebuf
? namebuf
: NULL
);
3668 * 'cups_get_dests()' - Get destinations from a file.
3671 static int /* O - Number of destinations */
3673 const char *filename
, /* I - File to read from */
3674 const char *match_name
, /* I - Destination name we want */
3675 const char *match_inst
, /* I - Instance name we want */
3676 int user_default_set
, /* I - User default printer set? */
3677 int num_dests
, /* I - Number of destinations */
3678 cups_dest_t
**dests
) /* IO - Destinations */
3680 int i
; /* Looping var */
3681 cups_dest_t
*dest
; /* Current destination */
3682 cups_file_t
*fp
; /* File pointer */
3683 char line
[8192], /* Line from file */
3684 *lineptr
, /* Pointer into line */
3685 *name
, /* Name of destination/option */
3686 *instance
; /* Instance of destination */
3687 int linenum
; /* Current line number */
3690 DEBUG_printf(("7cups_get_dests(filename=\"%s\", match_name=\"%s\", "
3691 "match_inst=\"%s\", user_default_set=%d, num_dests=%d, "
3692 "dests=%p)", filename
, match_name
, match_inst
,
3693 user_default_set
, num_dests
, dests
));
3696 * Try to open the file...
3699 if ((fp
= cupsFileOpen(filename
, "r")) == NULL
)
3703 * Read each printer; each line looks like:
3705 * Dest name[/instance] options
3706 * Default name[/instance] options
3711 while (cupsFileGetConf(fp
, line
, sizeof(line
), &lineptr
, &linenum
))
3714 * See what type of line it is...
3717 DEBUG_printf(("9cups_get_dests: linenum=%d line=\"%s\" lineptr=\"%s\"",
3718 linenum
, line
, lineptr
));
3720 if ((_cups_strcasecmp(line
, "dest") && _cups_strcasecmp(line
, "default")) || !lineptr
)
3722 DEBUG_puts("9cups_get_dests: Not a dest or default line...");
3729 * Search for an instance...
3732 while (!isspace(*lineptr
& 255) && *lineptr
&& *lineptr
!= '/')
3735 if (*lineptr
== '/')
3738 * Found an instance...
3745 * Search for an instance...
3748 while (!isspace(*lineptr
& 255) && *lineptr
)
3757 DEBUG_printf(("9cups_get_dests: name=\"%s\", instance=\"%s\"", name
,
3761 * See if the primary instance of the destination exists; if not,
3762 * ignore this entry and move on...
3767 if (_cups_strcasecmp(name
, match_name
) ||
3768 (!instance
&& match_inst
) ||
3769 (instance
&& !match_inst
) ||
3770 (instance
&& _cups_strcasecmp(instance
, match_inst
)))
3775 else if (cupsGetDest(name
, NULL
, num_dests
, *dests
) == NULL
)
3777 DEBUG_puts("9cups_get_dests: Not found!");
3783 * Add the destination...
3786 num_dests
= cupsAddDest(name
, instance
, num_dests
, dests
);
3788 if ((dest
= cupsGetDest(name
, instance
, num_dests
, *dests
)) == NULL
)
3794 DEBUG_puts("9cups_get_dests: Out of memory!");
3800 * Add options until we hit the end of the line...
3803 dest
->num_options
= cupsParseOptions(lineptr
, dest
->num_options
,
3807 * If we found what we were looking for, stop now...
3814 * Set this as default if needed...
3817 if (!user_default_set
&& !_cups_strcasecmp(line
, "default"))
3819 DEBUG_puts("9cups_get_dests: Setting as default...");
3821 for (i
= 0; i
< num_dests
; i
++)
3822 (*dests
)[i
].is_default
= 0;
3824 dest
->is_default
= 1;
3829 * Close the file and return...
3839 * 'cups_make_string()' - Make a comma-separated string of values from an IPP
3843 static char * /* O - New string */
3845 ipp_attribute_t
*attr
, /* I - Attribute to convert */
3846 char *buffer
, /* I - Buffer */
3847 size_t bufsize
) /* I - Size of buffer */
3849 int i
; /* Looping var */
3850 char *ptr
, /* Pointer into buffer */
3851 *end
, /* Pointer to end of buffer */
3852 *valptr
; /* Pointer into string attribute */
3856 * Return quickly if we have a single string value...
3859 if (attr
->num_values
== 1 &&
3860 attr
->value_tag
!= IPP_TAG_INTEGER
&&
3861 attr
->value_tag
!= IPP_TAG_ENUM
&&
3862 attr
->value_tag
!= IPP_TAG_BOOLEAN
&&
3863 attr
->value_tag
!= IPP_TAG_RANGE
)
3864 return (attr
->values
[0].string
.text
);
3867 * Copy the values to the string, separating with commas and escaping strings
3871 end
= buffer
+ bufsize
- 1;
3873 for (i
= 0, ptr
= buffer
; i
< attr
->num_values
&& ptr
< end
; i
++)
3878 switch (attr
->value_tag
)
3880 case IPP_TAG_INTEGER
:
3882 snprintf(ptr
, end
- ptr
+ 1, "%d", attr
->values
[i
].integer
);
3885 case IPP_TAG_BOOLEAN
:
3886 if (attr
->values
[i
].boolean
)
3887 strlcpy(ptr
, "true", end
- ptr
+ 1);
3889 strlcpy(ptr
, "false", end
- ptr
+ 1);
3892 case IPP_TAG_RANGE
:
3893 if (attr
->values
[i
].range
.lower
== attr
->values
[i
].range
.upper
)
3894 snprintf(ptr
, end
- ptr
+ 1, "%d", attr
->values
[i
].range
.lower
);
3896 snprintf(ptr
, end
- ptr
+ 1, "%d-%d", attr
->values
[i
].range
.lower
,
3897 attr
->values
[i
].range
.upper
);
3901 for (valptr
= attr
->values
[i
].string
.text
;
3902 *valptr
&& ptr
< end
;)
3904 if (strchr(" \t\n\\\'\"", *valptr
))
3906 if (ptr
>= (end
- 1))
3929 * End of "$Id: dest.c 9568 2011-02-25 06:13:56Z mike $".