2 * User-defined destination (and option) support for CUPS.
4 * Copyright 2007-2017 by Apple Inc.
5 * Copyright 1997-2007 by Easy Software Products.
7 * These coded instructions, statements, and computer programs are the
8 * property of Apple Inc. and are protected by Federal copyright
9 * law. Distribution and use rights are outlined in the file "LICENSE.txt"
10 * which should have been included with this file. If this file is
11 * missing or damaged, see the license at "http://www.cups.org/".
13 * This file is subject to the Apple OS-Developed Software exception.
17 * Include necessary headers...
20 #include "cups-private.h"
25 #endif /* HAVE_NOTIFY_H */
29 #endif /* HAVE_POLL */
33 #endif /* HAVE_DNSSD */
36 # include <avahi-client/client.h>
37 # include <avahi-client/lookup.h>
38 # include <avahi-common/simple-watch.h>
39 # include <avahi-common/domain.h>
40 # include <avahi-common/error.h>
41 # include <avahi-common/malloc.h>
42 #define kDNSServiceMaxDomainName AVAHI_DOMAIN_NAME_MAX
43 #endif /* HAVE_AVAHI */
52 # include <SystemConfiguration/SystemConfiguration.h>
53 # define _CUPS_LOCATION_DEFAULTS 1
54 # endif /* !TARGET_OS_IOS */
55 # define kCUPSPrintingPrefs CFSTR("org.cups.PrintingPrefs")
56 # define kDefaultPaperIDKey CFSTR("DefaultPaperID")
57 # define kLastUsedPrintersKey CFSTR("LastUsedPrinters")
58 # define kLocationNetworkKey CFSTR("Network")
59 # define kLocationPrinterIDKey CFSTR("PrinterID")
60 # define kUseLastPrinter CFSTR("UseLastPrinter")
61 #endif /* __APPLE__ */
63 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
64 # define _CUPS_DNSSD_MAXTIME 500 /* Milliseconds for maximum quantum of time */
65 #endif /* HAVE_DNSSD || HAVE_AVAHI */
72 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
73 typedef enum _cups_dnssd_state_e
/* Enumerated device state */
80 _CUPS_DNSSD_INCOMPATIBLE
,
82 } _cups_dnssd_state_t
;
84 typedef struct _cups_dnssd_data_s
/* Enumeration data */
87 DNSServiceRef main_ref
; /* Main service reference */
88 # else /* HAVE_AVAHI */
89 AvahiSimplePoll
*simple_poll
; /* Polling interface */
90 AvahiClient
*client
; /* Client information */
91 int got_data
; /* Did we get data? */
92 int browsers
; /* How many browsers are running? */
93 # endif /* HAVE_DNSSD */
94 cups_dest_cb_t cb
; /* Callback */
95 void *user_data
; /* User data pointer */
96 cups_ptype_t type
, /* Printer type filter */
97 mask
; /* Printer type mask */
98 cups_array_t
*devices
; /* Devices found so far */
101 typedef struct _cups_dnssd_device_s
/* Enumerated device */
103 _cups_dnssd_state_t state
; /* State of device listing */
105 DNSServiceRef ref
; /* Service reference for query */
106 # else /* HAVE_AVAHI */
107 AvahiRecordBrowser
*ref
; /* Browser for query */
108 # endif /* HAVE_DNSSD */
109 char *fullName
, /* Full name */
110 *regtype
, /* Registration type */
111 *domain
; /* Domain name */
112 cups_ptype_t type
; /* Device registration type */
113 cups_dest_t dest
; /* Destination record */
114 } _cups_dnssd_device_t
;
116 typedef struct _cups_dnssd_resolve_s
/* Data for resolving URI */
118 int *cancel
; /* Pointer to "cancel" variable */
119 struct timeval end_time
; /* Ending time */
120 } _cups_dnssd_resolve_t
;
121 #endif /* HAVE_DNSSD */
123 typedef struct _cups_getdata_s
125 int num_dests
; /* Number of destinations */
126 cups_dest_t
*dests
; /* Destinations */
129 typedef struct _cups_namedata_s
131 const char *name
; /* Named destination */
132 cups_dest_t
*dest
; /* Destination */
140 #if _CUPS_LOCATION_DEFAULTS
141 static CFArrayRef
appleCopyLocations(void);
142 static CFStringRef
appleCopyNetwork(void);
143 #endif /* _CUPS_LOCATION_DEFAULTS */
145 static char *appleGetPaperSize(char *name
, size_t namesize
);
146 #endif /* __APPLE__ */
147 #if _CUPS_LOCATION_DEFAULTS
148 static CFStringRef
appleGetPrinter(CFArrayRef locations
,
149 CFStringRef network
, CFIndex
*locindex
);
150 #endif /* _CUPS_LOCATION_DEFAULTS */
151 static cups_dest_t
*cups_add_dest(const char *name
, const char *instance
,
152 int *num_dests
, cups_dest_t
**dests
);
154 static int cups_block_cb(cups_dest_block_t block
, unsigned flags
,
156 #endif /* __BLOCKS__ */
157 static int cups_compare_dests(cups_dest_t
*a
, cups_dest_t
*b
);
158 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
160 static void cups_dnssd_browse_cb(DNSServiceRef sdRef
,
161 DNSServiceFlags flags
,
162 uint32_t interfaceIndex
,
163 DNSServiceErrorType errorCode
,
164 const char *serviceName
,
166 const char *replyDomain
,
168 # else /* HAVE_AVAHI */
169 static void cups_dnssd_browse_cb(AvahiServiceBrowser
*browser
,
170 AvahiIfIndex interface
,
171 AvahiProtocol protocol
,
172 AvahiBrowserEvent event
,
173 const char *serviceName
,
175 const char *replyDomain
,
176 AvahiLookupResultFlags flags
,
178 static void cups_dnssd_client_cb(AvahiClient
*client
,
179 AvahiClientState state
,
181 # endif /* HAVE_DNSSD */
182 static int cups_dnssd_compare_devices(_cups_dnssd_device_t
*a
,
183 _cups_dnssd_device_t
*b
);
184 static void cups_dnssd_free_device(_cups_dnssd_device_t
*device
,
185 _cups_dnssd_data_t
*data
);
186 static _cups_dnssd_device_t
*
187 cups_dnssd_get_device(_cups_dnssd_data_t
*data
,
188 const char *serviceName
,
190 const char *replyDomain
);
192 static void cups_dnssd_local_cb(DNSServiceRef sdRef
,
193 DNSServiceFlags flags
,
194 uint32_t interfaceIndex
,
195 DNSServiceErrorType errorCode
,
196 const char *serviceName
,
198 const char *replyDomain
,
200 static void cups_dnssd_query_cb(DNSServiceRef sdRef
,
201 DNSServiceFlags flags
,
202 uint32_t interfaceIndex
,
203 DNSServiceErrorType errorCode
,
204 const char *fullName
,
205 uint16_t rrtype
, uint16_t rrclass
,
206 uint16_t rdlen
, const void *rdata
,
207 uint32_t ttl
, void *context
);
208 # else /* HAVE_AVAHI */
209 static int cups_dnssd_poll_cb(struct pollfd
*pollfds
,
210 unsigned int num_pollfds
,
211 int timeout
, void *context
);
212 static void cups_dnssd_query_cb(AvahiRecordBrowser
*browser
,
213 AvahiIfIndex interface
,
214 AvahiProtocol protocol
,
215 AvahiBrowserEvent event
,
216 const char *name
, uint16_t rrclass
,
217 uint16_t rrtype
, const void *rdata
,
219 AvahiLookupResultFlags flags
,
221 # endif /* HAVE_DNSSD */
222 static const char *cups_dnssd_resolve(cups_dest_t
*dest
, const char *uri
,
223 int msec
, int *cancel
,
224 cups_dest_cb_t cb
, void *user_data
);
225 static int cups_dnssd_resolve_cb(void *context
);
226 static void cups_dnssd_unquote(char *dst
, const char *src
,
228 #endif /* HAVE_DNSSD || HAVE_AVAHI */
229 static int cups_elapsed(struct timeval
*t
);
230 static int cups_find_dest(const char *name
, const char *instance
,
231 int num_dests
, cups_dest_t
*dests
, int prev
,
233 static int cups_get_cb(_cups_getdata_t
*data
, unsigned flags
, cups_dest_t
*dest
);
234 static char *cups_get_default(const char *filename
, char *namebuf
,
235 size_t namesize
, const char **instance
);
236 static int cups_get_dests(const char *filename
, const char *match_name
,
237 const char *match_inst
, int user_default_set
,
238 int num_dests
, cups_dest_t
**dests
);
239 static char *cups_make_string(ipp_attribute_t
*attr
, char *buffer
,
241 static int cups_name_cb(_cups_namedata_t
*data
, unsigned flags
, cups_dest_t
*dest
);
242 static void cups_queue_name(char *name
, const char *serviceName
, size_t namesize
);
246 * 'cupsAddDest()' - Add a destination to the list of destinations.
248 * This function cannot be used to add a new class or printer queue,
249 * it only adds a new container of saved options for the named
250 * destination or instance.
252 * If the named destination already exists, the destination list is
253 * returned unchanged. Adding a new instance of a destination creates
254 * a copy of that destination's options.
256 * Use the @link cupsSaveDests@ function to save the updated list of
257 * destinations to the user's lpoptions file.
260 int /* O - New number of destinations */
261 cupsAddDest(const char *name
, /* I - Destination name */
262 const char *instance
, /* I - Instance name or @code NULL@ for none/primary */
263 int num_dests
, /* I - Number of destinations */
264 cups_dest_t
**dests
) /* IO - Destinations */
266 int i
; /* Looping var */
267 cups_dest_t
*dest
; /* Destination pointer */
268 cups_dest_t
*parent
= NULL
; /* Parent destination */
269 cups_option_t
*doption
, /* Current destination option */
270 *poption
; /* Current parent option */
276 if (!cupsGetDest(name
, instance
, num_dests
, *dests
))
278 if (instance
&& !cupsGetDest(name
, NULL
, num_dests
, *dests
))
281 if ((dest
= cups_add_dest(name
, instance
, &num_dests
, dests
)) == NULL
)
285 * Find the base dest again now the array has been realloc'd.
288 parent
= cupsGetDest(name
, NULL
, num_dests
, *dests
);
290 if (instance
&& parent
&& parent
->num_options
> 0)
293 * Copy options from parent...
296 dest
->options
= calloc(sizeof(cups_option_t
), (size_t)parent
->num_options
);
300 dest
->num_options
= parent
->num_options
;
302 for (i
= dest
->num_options
, doption
= dest
->options
,
303 poption
= parent
->options
;
305 i
--, doption
++, poption
++)
307 doption
->name
= _cupsStrRetain(poption
->name
);
308 doption
->value
= _cupsStrRetain(poption
->value
);
320 * '_cupsAppleCopyDefaultPaperID()' - Get the default paper ID.
323 CFStringRef
/* O - Default paper ID */
324 _cupsAppleCopyDefaultPaperID(void)
326 return (CFPreferencesCopyAppValue(kDefaultPaperIDKey
,
327 kCUPSPrintingPrefs
));
332 * '_cupsAppleCopyDefaultPrinter()' - Get the default printer at this location.
335 CFStringRef
/* O - Default printer name */
336 _cupsAppleCopyDefaultPrinter(void)
338 # if _CUPS_LOCATION_DEFAULTS
339 CFStringRef network
; /* Network location */
340 CFArrayRef locations
; /* Location array */
341 CFStringRef locprinter
; /* Current printer */
345 * Use location-based defaults only if "use last printer" is selected in the
346 * system preferences...
349 if (!_cupsAppleGetUseLastPrinter())
351 DEBUG_puts("1_cupsAppleCopyDefaultPrinter: Not using last printer as "
357 * Get the current location...
360 if ((network
= appleCopyNetwork()) == NULL
)
362 DEBUG_puts("1_cupsAppleCopyDefaultPrinter: Unable to get current "
368 * Lookup the network in the preferences...
371 if ((locations
= appleCopyLocations()) == NULL
)
374 * Missing or bad location array, so no location-based default...
377 DEBUG_puts("1_cupsAppleCopyDefaultPrinter: Missing or bad last used "
385 DEBUG_printf(("1_cupsAppleCopyDefaultPrinter: Got locations, %d entries.",
386 (int)CFArrayGetCount(locations
)));
388 if ((locprinter
= appleGetPrinter(locations
, network
, NULL
)) != NULL
)
389 CFRetain(locprinter
);
392 CFRelease(locations
);
398 # endif /* _CUPS_LOCATION_DEFAULTS */
403 * '_cupsAppleGetUseLastPrinter()' - Get whether to use the last used printer.
406 int /* O - 1 to use last printer, 0 otherwise */
407 _cupsAppleGetUseLastPrinter(void)
409 Boolean uselast
, /* Use last printer preference value */
410 uselast_set
; /* Valid is set? */
413 if (getenv("CUPS_DISABLE_APPLE_DEFAULT"))
416 uselast
= CFPreferencesGetAppBooleanValue(kUseLastPrinter
,
427 * '_cupsAppleSetDefaultPaperID()' - Set the default paper id.
431 _cupsAppleSetDefaultPaperID(
432 CFStringRef name
) /* I - New paper ID */
434 CFPreferencesSetAppValue(kDefaultPaperIDKey
, name
, kCUPSPrintingPrefs
);
435 CFPreferencesAppSynchronize(kCUPSPrintingPrefs
);
437 # ifdef HAVE_NOTIFY_POST
438 notify_post("com.apple.printerPrefsChange");
439 # endif /* HAVE_NOTIFY_POST */
444 * '_cupsAppleSetDefaultPrinter()' - Set the default printer for this location.
448 _cupsAppleSetDefaultPrinter(
449 CFStringRef name
) /* I - Default printer/class name */
451 # if _CUPS_LOCATION_DEFAULTS
452 CFStringRef network
; /* Current network */
453 CFArrayRef locations
; /* Old locations array */
454 CFIndex locindex
; /* Index in locations array */
455 CFStringRef locprinter
; /* Current printer */
456 CFMutableArrayRef newlocations
; /* New locations array */
457 CFMutableDictionaryRef newlocation
; /* New location */
461 * Get the current location...
464 if ((network
= appleCopyNetwork()) == NULL
)
466 DEBUG_puts("1_cupsAppleSetDefaultPrinter: Unable to get current network...");
471 * Lookup the network in the preferences...
474 if ((locations
= appleCopyLocations()) != NULL
)
475 locprinter
= appleGetPrinter(locations
, network
, &locindex
);
482 if (!locprinter
|| CFStringCompare(locprinter
, name
, 0) != kCFCompareEqualTo
)
485 * Need to change the locations array...
490 newlocations
= CFArrayCreateMutableCopy(kCFAllocatorDefault
, 0,
494 CFArrayRemoveValueAtIndex(newlocations
, locindex
);
497 newlocations
= CFArrayCreateMutable(kCFAllocatorDefault
, 0,
498 &kCFTypeArrayCallBacks
);
500 newlocation
= CFDictionaryCreateMutable(kCFAllocatorDefault
, 0,
501 &kCFTypeDictionaryKeyCallBacks
,
502 &kCFTypeDictionaryValueCallBacks
);
504 if (newlocation
&& newlocations
)
507 * Put the new location at the front of the array...
510 CFDictionaryAddValue(newlocation
, kLocationNetworkKey
, network
);
511 CFDictionaryAddValue(newlocation
, kLocationPrinterIDKey
, name
);
512 CFArrayInsertValueAtIndex(newlocations
, 0, newlocation
);
515 * Limit the number of locations to 10...
518 while (CFArrayGetCount(newlocations
) > 10)
519 CFArrayRemoveValueAtIndex(newlocations
, 10);
522 * Push the changes out...
525 CFPreferencesSetAppValue(kLastUsedPrintersKey
, newlocations
,
527 CFPreferencesAppSynchronize(kCUPSPrintingPrefs
);
529 # ifdef HAVE_NOTIFY_POST
530 notify_post("com.apple.printerPrefsChange");
531 # endif /* HAVE_NOTIFY_POST */
535 CFRelease(newlocations
);
538 CFRelease(newlocation
);
542 CFRelease(locations
);
548 # endif /* _CUPS_LOCATION_DEFAULTS */
553 * '_cupsAppleSetUseLastPrinter()' - Set whether to use the last used printer.
557 _cupsAppleSetUseLastPrinter(
558 int uselast
) /* O - 1 to use last printer, 0 otherwise */
560 CFPreferencesSetAppValue(kUseLastPrinter
,
561 uselast
? kCFBooleanTrue
: kCFBooleanFalse
,
563 CFPreferencesAppSynchronize(kCUPSPrintingPrefs
);
565 # ifdef HAVE_NOTIFY_POST
566 notify_post("com.apple.printerPrefsChange");
567 # endif /* HAVE_NOTIFY_POST */
569 #endif /* __APPLE__ */
573 * 'cupsConnectDest()' - Open a conection to the destination.
575 * Connect to the destination, returning a new @code http_t@ connection object
576 * and optionally the resource path to use for the destination. These calls
577 * will block until a connection is made, the timeout expires, the integer
578 * pointed to by "cancel" is non-zero, or the callback function (or block)
579 * returns 0. The caller is responsible for calling @link httpClose@ on the
580 * returned connection.
582 * @since CUPS 1.6/macOS 10.8@
585 http_t
* /* O - Connection to destination or @code NULL@ */
587 cups_dest_t
*dest
, /* I - Destination */
588 unsigned flags
, /* I - Connection flags */
589 int msec
, /* I - Timeout in milliseconds */
590 int *cancel
, /* I - Pointer to "cancel" variable */
591 char *resource
, /* I - Resource buffer */
592 size_t resourcesize
, /* I - Size of resource buffer */
593 cups_dest_cb_t cb
, /* I - Callback function */
594 void *user_data
) /* I - User data pointer */
596 const char *uri
; /* Printer URI */
597 char scheme
[32], /* URI scheme */
598 userpass
[256], /* Username and password (unused) */
599 hostname
[256], /* Hostname */
600 tempresource
[1024]; /* Temporary resource buffer */
601 int port
; /* Port number */
602 char portstr
[16]; /* Port number string */
603 http_encryption_t encryption
; /* Encryption to use */
604 http_addrlist_t
*addrlist
; /* Address list for server */
605 http_t
*http
; /* Connection to server */
608 DEBUG_printf(("cupsConnectDest(dest=%p, flags=0x%x, msec=%d, cancel=%p(%d), resource=\"%s\", resourcesize=" CUPS_LLFMT
", cb=%p, user_data=%p)", (void *)dest
, flags
, msec
, (void *)cancel
, cancel
? *cancel
: -1, resource
, CUPS_LLCAST resourcesize
, (void *)cb
, user_data
));
611 * Range check input...
619 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, strerror(EINVAL
), 0);
623 if (!resource
|| resourcesize
< 1)
625 resource
= tempresource
;
626 resourcesize
= sizeof(tempresource
);
630 * Grab the printer URI...
633 if ((uri
= cupsGetOption("printer-uri-supported", dest
->num_options
, dest
->options
)) == NULL
)
635 if ((uri
= cupsGetOption("resolved-device-uri", dest
->num_options
, dest
->options
)) == NULL
)
637 if ((uri
= cupsGetOption("device-uri", dest
->num_options
, dest
->options
)) != NULL
)
639 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
640 if (strstr(uri
, "._tcp"))
641 uri
= cups_dnssd_resolve(dest
, uri
, msec
, cancel
, cb
, user_data
);
642 #endif /* HAVE_DNSSD || HAVE_AVAHI */
647 uri
= _cupsCreateDest(dest
->name
, cupsGetOption("printer-info", dest
->num_options
, dest
->options
), NULL
, uri
, tempresource
, sizeof(tempresource
));
651 dest
->num_options
= cupsAddOption("printer-uri-supported", uri
, dest
->num_options
, &dest
->options
);
653 uri
= cupsGetOption("printer-uri-supported", dest
->num_options
, dest
->options
);
659 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, strerror(ENOENT
), 0);
662 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_ERROR
, dest
);
667 if (httpSeparateURI(HTTP_URI_CODING_ALL
, uri
, scheme
, sizeof(scheme
),
668 userpass
, sizeof(userpass
), hostname
, sizeof(hostname
),
669 &port
, resource
, (int)resourcesize
) < HTTP_URI_STATUS_OK
)
671 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("Bad printer-uri."), 1);
674 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_ERROR
,
681 * Lookup the address for the server...
685 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_RESOLVING
, dest
);
687 snprintf(portstr
, sizeof(portstr
), "%d", port
);
689 if ((addrlist
= httpAddrGetList(hostname
, AF_UNSPEC
, portstr
)) == NULL
)
692 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_ERROR
, dest
);
697 if (cancel
&& *cancel
)
699 httpAddrFreeList(addrlist
);
702 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_CANCELED
, dest
);
708 * Create the HTTP object pointing to the server referenced by the URI...
711 if (!strcmp(scheme
, "ipps") || port
== 443)
712 encryption
= HTTP_ENCRYPTION_ALWAYS
;
714 encryption
= HTTP_ENCRYPTION_IF_REQUESTED
;
716 http
= httpConnect2(hostname
, port
, addrlist
, AF_UNSPEC
, encryption
, 1, 0, NULL
);
717 httpAddrFreeList(addrlist
);
720 * Connect if requested...
723 if (flags
& CUPS_DEST_FLAGS_UNCONNECTED
)
726 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
, dest
);
731 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_CONNECTING
, dest
);
733 if (!httpReconnect2(http
, msec
, cancel
) && cb
)
735 if (cancel
&& *cancel
)
736 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_CONNECTING
, dest
);
738 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_ERROR
, dest
);
741 (*cb
)(user_data
, CUPS_DEST_FLAGS_NONE
, dest
);
750 * 'cupsConnectDestBlock()' - Open a connection to the destination.
752 * Connect to the destination, returning a new @code http_t@ connection object
753 * and optionally the resource path to use for the destination. These calls
754 * will block until a connection is made, the timeout expires, the integer
755 * pointed to by "cancel" is non-zero, or the block returns 0. The caller is
756 * responsible for calling @link httpClose@ on the returned connection.
758 * @since CUPS 1.6/macOS 10.8@ @exclude all@
761 http_t
* /* O - Connection to destination or @code NULL@ */
762 cupsConnectDestBlock(
763 cups_dest_t
*dest
, /* I - Destination */
764 unsigned flags
, /* I - Connection flags */
765 int msec
, /* I - Timeout in milliseconds */
766 int *cancel
, /* I - Pointer to "cancel" variable */
767 char *resource
, /* I - Resource buffer */
768 size_t resourcesize
, /* I - Size of resource buffer */
769 cups_dest_block_t block
) /* I - Callback block */
771 return (cupsConnectDest(dest
, flags
, msec
, cancel
, resource
, resourcesize
,
772 (cups_dest_cb_t
)cups_block_cb
, (void *)block
));
774 #endif /* __BLOCKS__ */
778 * 'cupsCopyDest()' - Copy a destination.
780 * Make a copy of the destination to an array of destinations (or just a single
781 * copy) - for use with the cupsEnumDests* functions. The caller is responsible
782 * for calling cupsFreeDests() on the returned object(s).
784 * @since CUPS 1.6/macOS 10.8@
787 int /* O - New number of destinations */
788 cupsCopyDest(cups_dest_t
*dest
, /* I - Destination to copy */
789 int num_dests
, /* I - Number of destinations */
790 cups_dest_t
**dests
) /* IO - Destination array */
792 int i
; /* Looping var */
793 cups_dest_t
*new_dest
; /* New destination pointer */
794 cups_option_t
*new_option
, /* Current destination option */
795 *option
; /* Current parent option */
799 * Range check input...
802 if (!dest
|| num_dests
< 0 || !dests
)
806 * See if the destination already exists...
809 if ((new_dest
= cupsGetDest(dest
->name
, dest
->instance
, num_dests
,
813 * Protect against copying destination to itself...
816 if (new_dest
== dest
)
820 * Otherwise, free the options...
823 cupsFreeOptions(new_dest
->num_options
, new_dest
->options
);
825 new_dest
->num_options
= 0;
826 new_dest
->options
= NULL
;
829 new_dest
= cups_add_dest(dest
->name
, dest
->instance
, &num_dests
, dests
);
833 if ((new_dest
->options
= calloc(sizeof(cups_option_t
), (size_t)dest
->num_options
)) == NULL
)
834 return (cupsRemoveDest(dest
->name
, dest
->instance
, num_dests
, dests
));
836 new_dest
->num_options
= dest
->num_options
;
838 for (i
= dest
->num_options
, option
= dest
->options
,
839 new_option
= new_dest
->options
;
841 i
--, option
++, new_option
++)
843 new_option
->name
= _cupsStrRetain(option
->name
);
844 new_option
->value
= _cupsStrRetain(option
->value
);
853 * '_cupsCreateDest()' - Create a local (temporary) queue.
856 char * /* O - Printer URI or @code NULL@ on error */
857 _cupsCreateDest(const char *name
, /* I - Printer name */
858 const char *info
, /* I - Printer description of @code NULL@ */
859 const char *device_id
, /* I - 1284 Device ID or @code NULL@ */
860 const char *device_uri
, /* I - Device URI */
861 char *uri
, /* I - Printer URI buffer */
862 size_t urisize
) /* I - Size of URI buffer */
864 http_t
*http
; /* Connection to server */
865 ipp_t
*request
, /* CUPS-Create-Local-Printer request */
866 *response
; /* CUPS-Create-Local-Printer response */
867 ipp_attribute_t
*attr
; /* printer-uri-supported attribute */
868 ipp_pstate_t state
= IPP_PSTATE_STOPPED
;
869 /* printer-state value */
872 if (!name
|| !device_uri
|| !uri
|| urisize
< 32)
875 if ((http
= httpConnect2(cupsServer(), ippPort(), NULL
, AF_UNSPEC
, HTTP_ENCRYPTION_IF_REQUESTED
, 1, 30000, NULL
)) == NULL
)
878 request
= ippNewRequest(IPP_OP_CUPS_CREATE_LOCAL_PRINTER
);
880 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri", NULL
, "ipp://localhost/");
881 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
, "requesting-user-name", NULL
, cupsUser());
883 ippAddString(request
, IPP_TAG_PRINTER
, IPP_TAG_URI
, "device-uri", NULL
, device_uri
);
884 ippAddString(request
, IPP_TAG_PRINTER
, IPP_TAG_NAME
, "printer-name", NULL
, name
);
886 ippAddString(request
, IPP_TAG_PRINTER
, IPP_TAG_TEXT
, "printer-info", NULL
, info
);
888 ippAddString(request
, IPP_TAG_PRINTER
, IPP_TAG_TEXT
, "printer-device-id", NULL
, device_id
);
890 response
= cupsDoRequest(http
, request
, "/");
892 if ((attr
= ippFindAttribute(response
, "printer-uri-supported", IPP_TAG_URI
)) != NULL
)
893 strlcpy(uri
, ippGetString(attr
, 0, NULL
), urisize
);
901 if ((attr
= ippFindAttribute(response
, "printer-state", IPP_TAG_ENUM
)) != NULL
)
902 state
= (ipp_pstate_t
)ippGetInteger(attr
, 0);
904 while (state
== IPP_PSTATE_STOPPED
&& cupsLastError() == IPP_STATUS_OK
)
909 request
= ippNewRequest(IPP_OP_GET_PRINTER_ATTRIBUTES
);
911 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri", NULL
, uri
);
912 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
, "requesting-user-name", NULL
, cupsUser());
913 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
, "requested-attributes", NULL
, "printer-state");
915 response
= cupsDoRequest(http
, request
, "/");
917 if ((attr
= ippFindAttribute(response
, "printer-state", IPP_TAG_ENUM
)) != NULL
)
918 state
= (ipp_pstate_t
)ippGetInteger(attr
, 0);
930 * 'cupsEnumDests()' - Enumerate available destinations with a callback function.
932 * Destinations are enumerated from one or more sources. The callback function
933 * receives the @code user_data@ pointer and the destination pointer which can
934 * be used as input to the @link cupsCopyDest@ function. The function must
935 * return 1 to continue enumeration or 0 to stop.
937 * The @code type@ and @code mask@ arguments allow the caller to filter the
938 * destinations that are enumerated. Passing 0 for both will enumerate all
939 * printers. The constant @code CUPS_PRINTER_DISCOVERED@ is used to filter on
940 * destinations that are available but have not yet been added locally.
942 * Enumeration happens on the current thread and does not return until all
943 * destinations have been enumerated or the callback function returns 0.
945 * Note: The callback function will likely receive multiple updates for the same
946 * destinations - it is up to the caller to suppress any duplicate destinations.
948 * @since CUPS 1.6/macOS 10.8@
951 int /* O - 1 on success, 0 on failure */
953 unsigned flags
, /* I - Enumeration flags */
954 int msec
, /* I - Timeout in milliseconds, -1 for indefinite */
955 int *cancel
, /* I - Pointer to "cancel" variable */
956 cups_ptype_t type
, /* I - Printer type bits */
957 cups_ptype_t mask
, /* I - Mask for printer type bits */
958 cups_dest_cb_t cb
, /* I - Callback function */
959 void *user_data
) /* I - User data */
961 int i
, /* Looping var */
962 num_dests
; /* Number of destinations */
963 cups_dest_t
*dests
= NULL
, /* Destinations */
964 *dest
; /* Current destination */
965 const char *defprinter
; /* Default printer */
966 char name
[1024], /* Copy of printer name */
967 *instance
, /* Pointer to instance name */
968 *user_default
; /* User default printer */
969 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
970 int count
, /* Number of queries started */
971 completed
, /* Number of completed queries */
972 remaining
; /* Remainder of timeout */
973 struct timeval curtime
; /* Current time */
974 _cups_dnssd_data_t data
; /* Data for callback */
975 _cups_dnssd_device_t
*device
; /* Current device */
977 int nfds
, /* Number of files responded */
978 main_fd
; /* File descriptor for lookups */
979 DNSServiceRef ipp_ref
, /* IPP browser */
980 local_ipp_ref
; /* Local IPP browser */
982 DNSServiceRef ipps_ref
, /* IPPS browser */
983 local_ipps_ref
; /* Local IPPS browser */
984 # endif /* HAVE_SSL */
986 struct pollfd pfd
; /* Polling data */
988 fd_set input
; /* Input set for select() */
989 struct timeval timeout
; /* Timeout for select() */
990 # endif /* HAVE_POLL */
991 # else /* HAVE_AVAHI */
992 int error
; /* Error value */
993 AvahiServiceBrowser
*ipp_ref
; /* IPP browser */
995 AvahiServiceBrowser
*ipps_ref
; /* IPPS browser */
996 # endif /* HAVE_SSL */
997 # endif /* HAVE_DNSSD */
998 #endif /* HAVE_DNSSD || HAVE_AVAHI */
1001 * Range check input...
1010 * Get ready to enumerate...
1013 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
1017 data
.user_data
= user_data
;
1018 data
.devices
= cupsArrayNew3((cups_array_func_t
)cups_dnssd_compare_devices
, NULL
, NULL
, 0, NULL
, (cups_afree_func_t
)cups_dnssd_free_device
);
1019 #endif /* HAVE_DNSSD || HAVE_AVAHI */
1021 if (!(mask
& CUPS_PRINTER_DISCOVERED
) || !(type
& CUPS_PRINTER_DISCOVERED
))
1024 * Get the list of local printers and pass them to the callback function...
1027 num_dests
= _cupsGetDests(CUPS_HTTP_DEFAULT
, IPP_OP_CUPS_GET_PRINTERS
, NULL
,
1028 &dests
, type
, mask
);
1030 if ((user_default
= _cupsUserDefault(name
, sizeof(name
))) != NULL
)
1032 else if ((defprinter
= cupsGetDefault2(CUPS_HTTP_DEFAULT
)) != NULL
)
1034 strlcpy(name
, defprinter
, sizeof(name
));
1041 * Separate printer and instance name...
1044 if ((instance
= strchr(name
, '/')) != NULL
)
1048 * Lookup the printer and instance and make it the default...
1051 if ((dest
= cupsGetDest(name
, instance
, num_dests
, dests
)) != NULL
)
1052 dest
->is_default
= 1;
1055 for (i
= num_dests
, dest
= dests
;
1056 i
> 0 && (!cancel
|| !*cancel
);
1059 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
1060 const char *device_uri
; /* Device URI */
1061 #endif /* HAVE_DNSSD || HAVE_AVAHI */
1063 if (!(*cb
)(user_data
, i
> 1 ? CUPS_DEST_FLAGS_MORE
: CUPS_DEST_FLAGS_NONE
,
1067 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
1068 if (!dest
->instance
&& (device_uri
= cupsGetOption("device-uri", dest
->num_options
, dest
->options
)) != NULL
&& !strncmp(device_uri
, "dnssd://", 8))
1071 * Add existing queue using service name, etc. so we don't list it again...
1074 char scheme
[32], /* URI scheme */
1075 userpass
[32], /* Username:password */
1076 serviceName
[256], /* Service name (host field) */
1077 resource
[256], /* Resource (options) */
1078 *regtype
, /* Registration type */
1079 *replyDomain
; /* Registration domain */
1080 int port
; /* Port number (not used) */
1082 if (httpSeparateURI(HTTP_URI_CODING_ALL
, device_uri
, scheme
, sizeof(scheme
), userpass
, sizeof(userpass
), serviceName
, sizeof(serviceName
), &port
, resource
, sizeof(resource
)) >= HTTP_URI_STATUS_OK
)
1084 if ((regtype
= strstr(serviceName
, "._ipp")) != NULL
)
1088 if ((replyDomain
= strstr(regtype
, "._tcp.")) != NULL
)
1090 replyDomain
[5] = '\0';
1093 if ((device
= cups_dnssd_get_device(&data
, serviceName
, regtype
, replyDomain
)) != NULL
)
1094 device
->state
= _CUPS_DNSSD_ACTIVE
;
1099 #endif /* HAVE_DNSSD || HAVE_AVAHI */
1102 cupsFreeDests(num_dests
, dests
);
1104 if (i
> 0 || msec
== 0)
1109 * Return early if the caller doesn't want to do discovery...
1112 if ((mask
& CUPS_PRINTER_DISCOVERED
) && !(type
& CUPS_PRINTER_DISCOVERED
))
1115 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
1117 * Get Bonjour-shared printers...
1121 if (DNSServiceCreateConnection(&data
.main_ref
) != kDNSServiceErr_NoError
)
1124 main_fd
= DNSServiceRefSockFD(data
.main_ref
);
1126 ipp_ref
= data
.main_ref
;
1127 DNSServiceBrowse(&ipp_ref
, kDNSServiceFlagsShareConnection
, 0,
1129 (DNSServiceBrowseReply
)cups_dnssd_browse_cb
, &data
);
1131 local_ipp_ref
= data
.main_ref
;
1132 DNSServiceBrowse(&local_ipp_ref
, kDNSServiceFlagsShareConnection
,
1133 kDNSServiceInterfaceIndexLocalOnly
,
1135 (DNSServiceBrowseReply
)cups_dnssd_local_cb
, &data
);
1138 ipps_ref
= data
.main_ref
;
1139 DNSServiceBrowse(&ipps_ref
, kDNSServiceFlagsShareConnection
, 0,
1141 (DNSServiceBrowseReply
)cups_dnssd_browse_cb
, &data
);
1143 local_ipps_ref
= data
.main_ref
;
1144 DNSServiceBrowse(&local_ipps_ref
, kDNSServiceFlagsShareConnection
,
1145 kDNSServiceInterfaceIndexLocalOnly
,
1147 (DNSServiceBrowseReply
)cups_dnssd_local_cb
, &data
);
1148 # endif /* HAVE_SSL */
1150 # else /* HAVE_AVAHI */
1151 if ((data
.simple_poll
= avahi_simple_poll_new()) == NULL
)
1153 DEBUG_puts("cupsEnumDests: Unable to create Avahi simple poll object.");
1157 avahi_simple_poll_set_func(data
.simple_poll
, cups_dnssd_poll_cb
, &data
);
1159 data
.client
= avahi_client_new(avahi_simple_poll_get(data
.simple_poll
),
1160 0, cups_dnssd_client_cb
, &data
,
1164 DEBUG_puts("cupsEnumDests: Unable to create Avahi client.");
1165 avahi_simple_poll_free(data
.simple_poll
);
1170 ipp_ref
= avahi_service_browser_new(data
.client
, AVAHI_IF_UNSPEC
, AVAHI_PROTO_UNSPEC
, "_ipp._tcp", NULL
, 0, cups_dnssd_browse_cb
, &data
);
1174 ipps_ref
= avahi_service_browser_new(data
.client
, AVAHI_IF_UNSPEC
, AVAHI_PROTO_UNSPEC
, "_ipps._tcp", NULL
, 0, cups_dnssd_browse_cb
, &data
);
1175 # endif /* HAVE_SSL */
1176 # endif /* HAVE_DNSSD */
1179 remaining
= INT_MAX
;
1183 while (remaining
> 0 && (!cancel
|| !*cancel
))
1186 * Check for input...
1189 DEBUG_printf(("1cupsEnumDests: remaining=%d", remaining
));
1191 cups_elapsed(&curtime
);
1196 pfd
.events
= POLLIN
;
1198 nfds
= poll(&pfd
, 1, remaining
> _CUPS_DNSSD_MAXTIME
? _CUPS_DNSSD_MAXTIME
: remaining
);
1202 FD_SET(main_fd
, &input
);
1205 timeout
.tv_usec
= 1000 * (remaining
> _CUPS_DNSSD_MAXTIME
? _CUPS_DNSSD_MAXTIME
: remaining
);
1207 nfds
= select(main_fd
+ 1, &input
, NULL
, NULL
, &timeout
);
1208 # endif /* HAVE_POLL */
1211 DNSServiceProcessResult(data
.main_ref
);
1213 # else /* HAVE_AVAHI */
1216 if ((error
= avahi_simple_poll_iterate(data
.simple_poll
, _CUPS_DNSSD_MAXTIME
)) > 0)
1219 * We've been told to exit the loop. Perhaps the connection to
1226 DEBUG_printf(("1cupsEnumDests: got_data=%d", data
.got_data
));
1227 # endif /* HAVE_DNSSD */
1229 remaining
-= cups_elapsed(&curtime
);
1231 for (device
= (_cups_dnssd_device_t
*)cupsArrayFirst(data
.devices
),
1232 count
= 0, completed
= 0;
1234 device
= (_cups_dnssd_device_t
*)cupsArrayNext(data
.devices
))
1239 if (device
->state
== _CUPS_DNSSD_ACTIVE
)
1242 if (!device
->ref
&& device
->state
== _CUPS_DNSSD_NEW
)
1244 DEBUG_printf(("1cupsEnumDests: Querying '%s'.", device
->fullName
));
1247 device
->ref
= data
.main_ref
;
1249 if (DNSServiceQueryRecord(&(device
->ref
),
1250 kDNSServiceFlagsShareConnection
,
1251 0, device
->fullName
,
1252 kDNSServiceType_TXT
,
1253 kDNSServiceClass_IN
,
1254 (DNSServiceQueryRecordReply
)cups_dnssd_query_cb
,
1255 &data
) == kDNSServiceErr_NoError
)
1262 device
->state
= _CUPS_DNSSD_ERROR
;
1264 DEBUG_puts("1cupsEnumDests: Query failed.");
1267 # else /* HAVE_AVAHI */
1268 if ((device
->ref
= avahi_record_browser_new(data
.client
, AVAHI_IF_UNSPEC
, AVAHI_PROTO_UNSPEC
, device
->fullName
, AVAHI_DNS_CLASS_IN
, AVAHI_DNS_TYPE_TXT
, 0, cups_dnssd_query_cb
, &data
)) != NULL
)
1270 DEBUG_printf(("1cupsEnumDests: Query ref=%p", device
->ref
));
1275 device
->state
= _CUPS_DNSSD_ERROR
;
1277 DEBUG_printf(("1cupsEnumDests: Query failed: %s", avahi_strerror(avahi_client_errno(data
.client
))));
1279 # endif /* HAVE_DNSSD */
1281 else if (device
->ref
&& device
->state
== _CUPS_DNSSD_PENDING
)
1285 DEBUG_printf(("1cupsEnumDests: Query for \"%s\" is complete.", device
->fullName
));
1287 if ((device
->type
& mask
) == type
)
1289 DEBUG_printf(("1cupsEnumDests: Add callback for \"%s\".", device
->dest
.name
));
1290 if (!(*cb
)(user_data
, CUPS_DEST_FLAGS_NONE
, &device
->dest
))
1297 device
->state
= _CUPS_DNSSD_ACTIVE
;
1302 DEBUG_printf(("1cupsEnumDests: remaining=%d, browsers=%d, completed=%d, count=%d, devices count=%d", remaining
, data
.browsers
, completed
, count
, cupsArrayCount(data
.devices
)));
1304 if (data
.browsers
== 0 && completed
== cupsArrayCount(data
.devices
))
1307 DEBUG_printf(("1cupsEnumDests: remaining=%d, completed=%d, count=%d, devices count=%d", remaining
, completed
, count
, cupsArrayCount(data
.devices
)));
1309 if (completed
== cupsArrayCount(data
.devices
))
1311 # endif /* HAVE_AVAHI */
1315 DNSServiceRefDeallocate(ipp_ref
);
1316 DNSServiceRefDeallocate(local_ipp_ref
);
1319 DNSServiceRefDeallocate(ipp_ref
);
1320 DNSServiceRefDeallocate(local_ipp_ref
);
1321 # endif /* HAVE_SSL */
1323 DNSServiceRefDeallocate(data
.main_ref
);
1325 # else /* HAVE_AVAHI */
1326 avahi_service_browser_free(ipp_ref
);
1328 avahi_service_browser_free(ipps_ref
);
1329 # endif /* HAVE_SSL */
1331 avahi_client_free(data
.client
);
1332 avahi_simple_poll_free(data
.simple_poll
);
1333 # endif /* HAVE_DNSSD */
1334 #endif /* HAVE_DNSSD || HAVE_DNSSD */
1342 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
1343 cupsArrayDelete(data
.devices
);
1344 #endif /* HAVE_DNSSD || HAVE_AVAHI */
1352 * 'cupsEnumDestsBlock()' - Enumerate available destinations with a block.
1354 * Destinations are enumerated from one or more sources. The block receives the
1355 * @code user_data@ pointer and the destination pointer which can be used as
1356 * input to the @link cupsCopyDest@ function. The block must return 1 to
1357 * continue enumeration or 0 to stop.
1359 * The @code type@ and @code mask@ arguments allow the caller to filter the
1360 * destinations that are enumerated. Passing 0 for both will enumerate all
1361 * printers. The constant @code CUPS_PRINTER_DISCOVERED@ is used to filter on
1362 * destinations that are available but have not yet been added locally.
1364 * Enumeration happens on the current thread and does not return until all
1365 * destinations have been enumerated or the block returns 0.
1367 * Note: The block will likely receive multiple updates for the same
1368 * destinations - it is up to the caller to suppress any duplicate destinations.
1370 * @since CUPS 1.6/macOS 10.8@ @exclude all@
1373 int /* O - 1 on success, 0 on failure */
1375 unsigned flags
, /* I - Enumeration flags */
1376 int timeout
, /* I - Timeout in milliseconds, 0 for indefinite */
1377 int *cancel
, /* I - Pointer to "cancel" variable */
1378 cups_ptype_t type
, /* I - Printer type bits */
1379 cups_ptype_t mask
, /* I - Mask for printer type bits */
1380 cups_dest_block_t block
) /* I - Block */
1382 return (cupsEnumDests(flags
, timeout
, cancel
, type
, mask
,
1383 (cups_dest_cb_t
)cups_block_cb
, (void *)block
));
1385 # endif /* __BLOCKS__ */
1389 * 'cupsFreeDests()' - Free the memory used by the list of destinations.
1393 cupsFreeDests(int num_dests
, /* I - Number of destinations */
1394 cups_dest_t
*dests
) /* I - Destinations */
1396 int i
; /* Looping var */
1397 cups_dest_t
*dest
; /* Current destination */
1400 if (num_dests
== 0 || dests
== NULL
)
1403 for (i
= num_dests
, dest
= dests
; i
> 0; i
--, dest
++)
1405 _cupsStrFree(dest
->name
);
1406 _cupsStrFree(dest
->instance
);
1408 cupsFreeOptions(dest
->num_options
, dest
->options
);
1416 * 'cupsGetDest()' - Get the named destination from the list.
1418 * Use the @link cupsEnumDests@ or @link cupsGetDests2@ functions to get a
1419 * list of supported destinations for the current user.
1422 cups_dest_t
* /* O - Destination pointer or @code NULL@ */
1423 cupsGetDest(const char *name
, /* I - Destination name or @code NULL@ for the default destination */
1424 const char *instance
, /* I - Instance name or @code NULL@ */
1425 int num_dests
, /* I - Number of destinations */
1426 cups_dest_t
*dests
) /* I - Destinations */
1428 int diff
, /* Result of comparison */
1429 match
; /* Matching index */
1432 if (num_dests
<= 0 || !dests
)
1438 * NULL name for default printer.
1441 while (num_dests
> 0)
1443 if (dests
->is_default
)
1453 * Lookup name and optionally the instance...
1456 match
= cups_find_dest(name
, instance
, num_dests
, dests
, -1, &diff
);
1459 return (dests
+ match
);
1467 * '_cupsGetDestResource()' - Get the resource path and URI for a destination.
1470 const char * /* O - Printer URI */
1471 _cupsGetDestResource(
1472 cups_dest_t
*dest
, /* I - Destination */
1473 char *resource
, /* I - Resource buffer */
1474 size_t resourcesize
) /* I - Size of resource buffer */
1476 const char *uri
; /* Printer URI */
1477 char scheme
[32], /* URI scheme */
1478 userpass
[256], /* Username and password (unused) */
1479 hostname
[256]; /* Hostname */
1480 int port
; /* Port number */
1483 DEBUG_printf(("_cupsGetDestResource(dest=%p(%s), resource=%p, resourcesize=%d)", dest
, dest
->name
, resource
, (int)resourcesize
));
1486 * Range check input...
1489 if (!dest
|| !resource
|| resourcesize
< 1)
1494 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, strerror(EINVAL
), 0);
1499 * Grab the printer URI...
1502 if ((uri
= cupsGetOption("printer-uri-supported", dest
->num_options
, dest
->options
)) == NULL
)
1504 if ((uri
= cupsGetOption("resolved-device-uri", dest
->num_options
, dest
->options
)) == NULL
)
1506 if ((uri
= cupsGetOption("device-uri", dest
->num_options
, dest
->options
)) != NULL
)
1508 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
1509 if (strstr(uri
, "._tcp"))
1510 uri
= cups_dnssd_resolve(dest
, uri
, 5000, NULL
, NULL
, NULL
);
1511 #endif /* HAVE_DNSSD || HAVE_AVAHI */
1517 DEBUG_printf(("1_cupsGetDestResource: Resolved printer-uri-supported=\"%s\"", uri
));
1519 uri
= _cupsCreateDest(dest
->name
, cupsGetOption("printer-info", dest
->num_options
, dest
->options
), NULL
, uri
, resource
, resourcesize
);
1524 DEBUG_printf(("1_cupsGetDestResource: Local printer-uri-supported=\"%s\"", uri
));
1526 dest
->num_options
= cupsAddOption("printer-uri-supported", uri
, dest
->num_options
, &dest
->options
);
1528 uri
= cupsGetOption("printer-uri-supported", dest
->num_options
, dest
->options
);
1532 DEBUG_puts("1_cupsGetDestResource: No printer-uri-supported found.");
1537 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, strerror(ENOENT
), 0);
1544 DEBUG_printf(("1_cupsGetDestResource: printer-uri-supported=\"%s\"", uri
));
1546 if (httpSeparateURI(HTTP_URI_CODING_ALL
, uri
, scheme
, sizeof(scheme
),
1547 userpass
, sizeof(userpass
), hostname
, sizeof(hostname
),
1548 &port
, resource
, (int)resourcesize
) < HTTP_URI_STATUS_OK
)
1550 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("Bad printer-uri."), 1);
1556 DEBUG_printf(("1_cupsGetDestResource: resource=\"%s\"", resource
));
1563 * 'cupsGetDestWithURI()' - Get a destination associated with a URI.
1565 * "name" is the desired name for the printer. If @code NULL@, a name will be
1566 * created using the URI.
1568 * "uri" is the "ipp" or "ipps" URI for the printer.
1570 * @since CUPS 2.0/macOS 10.10@
1573 cups_dest_t
* /* O - Destination or @code NULL@ */
1574 cupsGetDestWithURI(const char *name
, /* I - Desired printer name or @code NULL@ */
1575 const char *uri
) /* I - URI for the printer */
1577 cups_dest_t
*dest
; /* New destination */
1578 char temp
[1024], /* Temporary string */
1579 scheme
[256], /* Scheme from URI */
1580 userpass
[256], /* Username:password from URI */
1581 hostname
[256], /* Hostname from URI */
1582 resource
[1024], /* Resource path from URI */
1583 *ptr
; /* Pointer into string */
1584 const char *info
; /* printer-info string */
1585 int port
; /* Port number from URI */
1589 * Range check input...
1594 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, strerror(EINVAL
), 0);
1598 if (httpSeparateURI(HTTP_URI_CODING_ALL
, uri
, scheme
, sizeof(scheme
), userpass
, sizeof(userpass
), hostname
, sizeof(hostname
), &port
, resource
, sizeof(resource
)) < HTTP_URI_STATUS_OK
||
1599 (strncmp(uri
, "ipp://", 6) && strncmp(uri
, "ipps://", 7)))
1601 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("Bad printer-uri."), 1);
1613 * Create the name from the URI...
1616 if (strstr(hostname
, "._tcp"))
1619 * Use the service instance name...
1622 if ((ptr
= strstr(hostname
, "._")) != NULL
)
1625 cups_queue_name(temp
, hostname
, sizeof(temp
));
1629 else if (!strncmp(resource
, "/classes/", 9))
1631 snprintf(temp
, sizeof(temp
), "%s @ %s", resource
+ 9, hostname
);
1632 name
= resource
+ 9;
1635 else if (!strncmp(resource
, "/printers/", 10))
1637 snprintf(temp
, sizeof(temp
), "%s @ %s", resource
+ 10, hostname
);
1638 name
= resource
+ 10;
1649 * Create the destination...
1652 if ((dest
= calloc(1, sizeof(cups_dest_t
))) == NULL
)
1654 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, strerror(errno
), 0);
1658 dest
->name
= _cupsStrAlloc(name
);
1659 dest
->num_options
= cupsAddOption("device-uri", uri
, dest
->num_options
, &(dest
->options
));
1660 dest
->num_options
= cupsAddOption("printer-info", info
, dest
->num_options
, &(dest
->options
));
1667 * '_cupsGetDests()' - Get destinations from a server.
1669 * "op" is IPP_OP_CUPS_GET_PRINTERS to get a full list, IPP_OP_CUPS_GET_DEFAULT
1670 * to get the system-wide default printer, or IPP_OP_GET_PRINTER_ATTRIBUTES for
1673 * "name" is the name of an existing printer and is only used when "op" is
1674 * IPP_OP_GET_PRINTER_ATTRIBUTES.
1676 * "dest" is initialized to point to the array of destinations.
1678 * 0 is returned if there are no printers, no default printer, or the named
1679 * printer does not exist, respectively.
1681 * Free the memory used by the destination array using the @link cupsFreeDests@
1684 * Note: On macOS this function also gets the default paper from the system
1685 * preferences (~/L/P/org.cups.PrintingPrefs.plist) and includes it in the
1686 * options array for each destination that supports it.
1689 int /* O - Number of destinations */
1690 _cupsGetDests(http_t
*http
, /* I - Connection to server or
1691 * @code CUPS_HTTP_DEFAULT@ */
1692 ipp_op_t op
, /* I - IPP operation */
1693 const char *name
, /* I - Name of destination */
1694 cups_dest_t
**dests
, /* IO - Destinations */
1695 cups_ptype_t type
, /* I - Printer type bits */
1696 cups_ptype_t mask
) /* I - Printer type mask */
1698 int num_dests
= 0; /* Number of destinations */
1699 cups_dest_t
*dest
; /* Current destination */
1700 ipp_t
*request
, /* IPP Request */
1701 *response
; /* IPP Response */
1702 ipp_attribute_t
*attr
; /* Current attribute */
1703 const char *printer_name
; /* printer-name attribute */
1704 char uri
[1024]; /* printer-uri value */
1705 int num_options
; /* Number of options */
1706 cups_option_t
*options
; /* Options */
1708 char media_default
[41]; /* Default paper size */
1709 #endif /* __APPLE__ */
1710 char optname
[1024], /* Option name */
1711 value
[2048], /* Option value */
1712 *ptr
; /* Pointer into name/value */
1713 static const char * const pattrs
[] = /* Attributes we're interested in */
1715 "auth-info-required",
1717 "job-sheets-default",
1718 "marker-change-time",
1720 "marker-high-levels",
1722 "marker-low-levels",
1728 #endif /* __APPLE__ */
1732 "printer-is-accepting-jobs",
1733 "printer-is-shared",
1735 "printer-make-and-model",
1736 "printer-mandatory-job-attributes",
1739 "printer-state-change-time",
1740 "printer-state-reasons",
1742 "printer-uri-supported"
1746 DEBUG_printf(("_cupsGetDests(http=%p, op=%x(%s), name=\"%s\", dests=%p, type=%x, mask=%x)", http
, op
, ippOpString(op
), name
, dests
, type
, mask
));
1750 * Get the default paper size...
1753 appleGetPaperSize(media_default
, sizeof(media_default
));
1754 #endif /* __APPLE__ */
1757 * Build a IPP_OP_CUPS_GET_PRINTERS or IPP_OP_GET_PRINTER_ATTRIBUTES request, which
1758 * require the following attributes:
1760 * attributes-charset
1761 * attributes-natural-language
1762 * requesting-user-name
1763 * printer-uri [for IPP_OP_GET_PRINTER_ATTRIBUTES]
1766 request
= ippNewRequest(op
);
1768 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
1769 "requested-attributes", sizeof(pattrs
) / sizeof(pattrs
[0]),
1772 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
1773 "requesting-user-name", NULL
, cupsUser());
1775 if (name
&& op
!= IPP_OP_CUPS_GET_DEFAULT
)
1777 httpAssembleURIf(HTTP_URI_CODING_ALL
, uri
, sizeof(uri
), "ipp", NULL
,
1778 "localhost", ippPort(), "/printers/%s", name
);
1779 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri", NULL
,
1784 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_ENUM
, "printer-type", (int)type
);
1785 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_ENUM
, "printer-type-mask", (int)mask
);
1789 * Do the request and get back a response...
1792 if ((response
= cupsDoRequest(http
, request
, "/")) != NULL
)
1794 for (attr
= response
->attrs
; attr
!= NULL
; attr
= attr
->next
)
1797 * Skip leading attributes until we hit a printer...
1800 while (attr
!= NULL
&& attr
->group_tag
!= IPP_TAG_PRINTER
)
1807 * Pull the needed attributes from this printer...
1810 printer_name
= NULL
;
1814 for (; attr
&& attr
->group_tag
== IPP_TAG_PRINTER
; attr
= attr
->next
)
1816 if (attr
->value_tag
!= IPP_TAG_INTEGER
&&
1817 attr
->value_tag
!= IPP_TAG_ENUM
&&
1818 attr
->value_tag
!= IPP_TAG_BOOLEAN
&&
1819 attr
->value_tag
!= IPP_TAG_TEXT
&&
1820 attr
->value_tag
!= IPP_TAG_TEXTLANG
&&
1821 attr
->value_tag
!= IPP_TAG_NAME
&&
1822 attr
->value_tag
!= IPP_TAG_NAMELANG
&&
1823 attr
->value_tag
!= IPP_TAG_KEYWORD
&&
1824 attr
->value_tag
!= IPP_TAG_RANGE
&&
1825 attr
->value_tag
!= IPP_TAG_URI
)
1828 if (!strcmp(attr
->name
, "auth-info-required") ||
1829 !strcmp(attr
->name
, "device-uri") ||
1830 !strcmp(attr
->name
, "marker-change-time") ||
1831 !strcmp(attr
->name
, "marker-colors") ||
1832 !strcmp(attr
->name
, "marker-high-levels") ||
1833 !strcmp(attr
->name
, "marker-levels") ||
1834 !strcmp(attr
->name
, "marker-low-levels") ||
1835 !strcmp(attr
->name
, "marker-message") ||
1836 !strcmp(attr
->name
, "marker-names") ||
1837 !strcmp(attr
->name
, "marker-types") ||
1838 !strcmp(attr
->name
, "printer-commands") ||
1839 !strcmp(attr
->name
, "printer-info") ||
1840 !strcmp(attr
->name
, "printer-is-shared") ||
1841 !strcmp(attr
->name
, "printer-make-and-model") ||
1842 !strcmp(attr
->name
, "printer-mandatory-job-attributes") ||
1843 !strcmp(attr
->name
, "printer-state") ||
1844 !strcmp(attr
->name
, "printer-state-change-time") ||
1845 !strcmp(attr
->name
, "printer-type") ||
1846 !strcmp(attr
->name
, "printer-is-accepting-jobs") ||
1847 !strcmp(attr
->name
, "printer-location") ||
1848 !strcmp(attr
->name
, "printer-state-reasons") ||
1849 !strcmp(attr
->name
, "printer-uri-supported"))
1852 * Add a printer description attribute...
1855 num_options
= cupsAddOption(attr
->name
,
1856 cups_make_string(attr
, value
,
1858 num_options
, &options
);
1861 else if (!strcmp(attr
->name
, "media-supported"))
1864 * See if we can set a default media size...
1867 int i
; /* Looping var */
1869 for (i
= 0; i
< attr
->num_values
; i
++)
1870 if (!_cups_strcasecmp(media_default
, attr
->values
[i
].string
.text
))
1872 num_options
= cupsAddOption("media", media_default
, num_options
,
1877 #endif /* __APPLE__ */
1878 else if (!strcmp(attr
->name
, "printer-name") &&
1879 attr
->value_tag
== IPP_TAG_NAME
)
1880 printer_name
= attr
->values
[0].string
.text
;
1881 else if (strncmp(attr
->name
, "notify-", 7) &&
1882 (attr
->value_tag
== IPP_TAG_BOOLEAN
||
1883 attr
->value_tag
== IPP_TAG_ENUM
||
1884 attr
->value_tag
== IPP_TAG_INTEGER
||
1885 attr
->value_tag
== IPP_TAG_KEYWORD
||
1886 attr
->value_tag
== IPP_TAG_NAME
||
1887 attr
->value_tag
== IPP_TAG_RANGE
) &&
1888 (ptr
= strstr(attr
->name
, "-default")) != NULL
)
1891 * Add a default option...
1894 strlcpy(optname
, attr
->name
, sizeof(optname
));
1895 optname
[ptr
- attr
->name
] = '\0';
1897 if (_cups_strcasecmp(optname
, "media") ||
1898 !cupsGetOption("media", num_options
, options
))
1899 num_options
= cupsAddOption(optname
,
1900 cups_make_string(attr
, value
,
1902 num_options
, &options
);
1907 * See if we have everything needed...
1912 cupsFreeOptions(num_options
, options
);
1920 if ((dest
= cups_add_dest(printer_name
, NULL
, &num_dests
, dests
)) != NULL
)
1922 dest
->num_options
= num_options
;
1923 dest
->options
= options
;
1926 cupsFreeOptions(num_options
, options
);
1932 ippDelete(response
);
1936 * Return the count...
1944 * 'cupsGetDests()' - Get the list of destinations from the default server.
1946 * Starting with CUPS 1.2, the returned list of destinations include the
1947 * "printer-info", "printer-is-accepting-jobs", "printer-is-shared",
1948 * "printer-make-and-model", "printer-state", "printer-state-change-time",
1949 * "printer-state-reasons", "printer-type", and "printer-uri-supported"
1950 * attributes as options.
1952 * CUPS 1.4 adds the "marker-change-time", "marker-colors",
1953 * "marker-high-levels", "marker-levels", "marker-low-levels", "marker-message",
1954 * "marker-names", "marker-types", and "printer-commands" attributes as options.
1956 * CUPS 2.2 adds accessible IPP printers to the list of destinations that can
1957 * be used. The "printer-uri-supported" option will be present for those IPP
1958 * printers that have been recently used.
1960 * Use the @link cupsFreeDests@ function to free the destination list and
1961 * the @link cupsGetDest@ function to find a particular destination.
1966 int /* O - Number of destinations */
1967 cupsGetDests(cups_dest_t
**dests
) /* O - Destinations */
1969 return (cupsGetDests2(CUPS_HTTP_DEFAULT
, dests
));
1974 * 'cupsGetDests2()' - Get the list of destinations from the specified server.
1976 * Starting with CUPS 1.2, the returned list of destinations include the
1977 * "printer-info", "printer-is-accepting-jobs", "printer-is-shared",
1978 * "printer-make-and-model", "printer-state", "printer-state-change-time",
1979 * "printer-state-reasons", "printer-type", and "printer-uri-supported"
1980 * attributes as options.
1982 * CUPS 1.4 adds the "marker-change-time", "marker-colors",
1983 * "marker-high-levels", "marker-levels", "marker-low-levels", "marker-message",
1984 * "marker-names", "marker-types", and "printer-commands" attributes as options.
1986 * CUPS 2.2 adds accessible IPP printers to the list of destinations that can
1987 * be used. The "printer-uri-supported" option will be present for those IPP
1988 * printers that have been recently used.
1990 * Use the @link cupsFreeDests@ function to free the destination list and
1991 * the @link cupsGetDest@ function to find a particular destination.
1993 * @since CUPS 1.1.21/macOS 10.4@
1996 int /* O - Number of destinations */
1997 cupsGetDests2(http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
1998 cups_dest_t
**dests
) /* O - Destinations */
2000 _cups_getdata_t data
; /* Enumeration data */
2001 cups_dest_t
*dest
; /* Current destination */
2002 const char *home
; /* HOME environment variable */
2003 char filename
[1024]; /* Local ~/.cups/lpoptions file */
2004 const char *defprinter
; /* Default printer */
2005 char name
[1024], /* Copy of printer name */
2006 *instance
, /* Pointer to instance name */
2007 *user_default
; /* User default printer */
2008 int num_reals
; /* Number of real queues */
2009 cups_dest_t
*reals
; /* Real queues */
2010 _cups_globals_t
*cg
= _cupsGlobals(); /* Pointer to library globals */
2014 * Range check the input...
2019 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("Bad NULL dests pointer"), 1);
2024 * Grab the printers and classes...
2030 cupsEnumDests(0, 1000, NULL
, 0, 0, (cups_dest_cb_t
)cups_get_cb
, &data
);
2032 if (cupsLastError() >= IPP_STATUS_REDIRECTION_OTHER_SITE
)
2034 cupsFreeDests(data
.num_dests
, data
.dests
);
2036 *dests
= (cups_dest_t
*)0;
2042 * Make a copy of the "real" queues for a later sanity check...
2045 if (data
.num_dests
> 0)
2047 num_reals
= data
.num_dests
;
2048 reals
= calloc((size_t)num_reals
, sizeof(cups_dest_t
));
2051 memcpy(reals
, data
.dests
, (size_t)num_reals
* sizeof(cups_dest_t
));
2062 * Grab the default destination...
2065 if ((user_default
= _cupsUserDefault(name
, sizeof(name
))) != NULL
)
2067 else if ((defprinter
= cupsGetDefault2(http
)) != NULL
)
2069 strlcpy(name
, defprinter
, sizeof(name
));
2076 * Separate printer and instance name...
2079 if ((instance
= strchr(name
, '/')) != NULL
)
2083 * Lookup the printer and instance and make it the default...
2086 if ((dest
= cupsGetDest(name
, instance
, data
.num_dests
, data
.dests
)) != NULL
)
2087 dest
->is_default
= 1;
2093 * Load the /etc/cups/lpoptions and ~/.cups/lpoptions files...
2096 snprintf(filename
, sizeof(filename
), "%s/lpoptions", cg
->cups_serverroot
);
2097 data
.num_dests
= cups_get_dests(filename
, NULL
, NULL
, user_default
!= NULL
, data
.num_dests
, &data
.dests
);
2099 if ((home
= getenv("HOME")) != NULL
)
2101 snprintf(filename
, sizeof(filename
), "%s/.cups/lpoptions", home
);
2103 data
.num_dests
= cups_get_dests(filename
, NULL
, NULL
, user_default
!= NULL
, data
.num_dests
, &data
.dests
);
2107 * Validate the current default destination - this prevents old
2108 * Default lines in /etc/cups/lpoptions and ~/.cups/lpoptions from
2109 * pointing to a non-existent printer or class...
2115 * See if we have a default printer...
2118 if ((dest
= cupsGetDest(NULL
, NULL
, data
.num_dests
, data
.dests
)) != NULL
)
2121 * Have a default; see if it is real...
2124 if (!cupsGetDest(dest
->name
, NULL
, num_reals
, reals
))
2127 * Remove the non-real printer from the list, since we don't want jobs
2128 * going to an unexpected printer... (<rdar://problem/14216472>)
2131 data
.num_dests
= cupsRemoveDest(dest
->name
, dest
->instance
, data
.num_dests
, &data
.dests
);
2143 * Return the number of destinations...
2146 *dests
= data
.dests
;
2148 if (data
.num_dests
> 0)
2149 _cupsSetError(IPP_STATUS_OK
, NULL
, 0);
2151 return (data
.num_dests
);
2156 * 'cupsGetNamedDest()' - Get options for the named destination.
2158 * This function is optimized for retrieving a single destination and should
2159 * be used instead of @link cupsGetDests2@ and @link cupsGetDest@ when you
2160 * either know the name of the destination or want to print to the default
2161 * destination. If @code NULL@ is returned, the destination does not exist or
2162 * there is no default destination.
2164 * If "http" is @code CUPS_HTTP_DEFAULT@, the connection to the default print
2165 * server will be used.
2167 * If "name" is @code NULL@, the default printer for the current user will be
2170 * The returned destination must be freed using @link cupsFreeDests@ with a
2171 * "num_dests" value of 1.
2173 * @since CUPS 1.4/macOS 10.6@
2176 cups_dest_t
* /* O - Destination or @code NULL@ */
2177 cupsGetNamedDest(http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
2178 const char *name
, /* I - Destination name or @code NULL@ for the default destination */
2179 const char *instance
) /* I - Instance name or @code NULL@ */
2181 cups_dest_t
*dest
; /* Destination */
2182 char filename
[1024], /* Path to lpoptions */
2183 defname
[256]; /* Default printer name */
2184 const char *home
= getenv("HOME"); /* Home directory */
2185 int set_as_default
= 0; /* Set returned destination as default */
2186 ipp_op_t op
= IPP_OP_GET_PRINTER_ATTRIBUTES
;
2187 /* IPP operation to get server ops */
2188 _cups_globals_t
*cg
= _cupsGlobals(); /* Pointer to library globals */
2191 DEBUG_printf(("cupsGetNamedDest(http=%p, name=\"%s\", instance=\"%s\")", http
, name
, instance
));
2194 * If "name" is NULL, find the default destination...
2200 name
= _cupsUserDefault(defname
, sizeof(defname
));
2204 char *ptr
; /* Temporary pointer... */
2206 if ((ptr
= strchr(defname
, '/')) != NULL
)
2217 * No default in the environment, try the user's lpoptions files...
2220 snprintf(filename
, sizeof(filename
), "%s/.cups/lpoptions", home
);
2222 name
= cups_get_default(filename
, defname
, sizeof(defname
), &instance
);
2228 * Still not there? Try the system lpoptions file...
2231 snprintf(filename
, sizeof(filename
), "%s/lpoptions",
2232 cg
->cups_serverroot
);
2233 name
= cups_get_default(filename
, defname
, sizeof(defname
), &instance
);
2239 * No locally-set default destination, ask the server...
2242 op
= IPP_OP_CUPS_GET_DEFAULT
;
2244 DEBUG_puts("1cupsGetNamedDest: Asking server for default printer...");
2247 DEBUG_printf(("1cupsGetNamedDest: Using name=\"%s\"...", name
));
2251 * Get the printer's attributes...
2254 if (!_cupsGetDests(http
, op
, name
, &dest
, 0, 0))
2258 _cups_namedata_t data
; /* Callback data */
2260 DEBUG_puts("1cupsGetNamedDest: No queue found for printer, looking on network...");
2265 cupsEnumDests(0, 1000, NULL
, 0, 0, (cups_dest_cb_t
)cups_name_cb
, &data
);
2276 DEBUG_printf(("1cupsGetNamedDest: Got dest=%p", dest
));
2279 dest
->instance
= _cupsStrAlloc(instance
);
2282 dest
->is_default
= 1;
2285 * Then add local options...
2288 snprintf(filename
, sizeof(filename
), "%s/lpoptions", cg
->cups_serverroot
);
2289 cups_get_dests(filename
, name
, instance
, 1, 1, &dest
);
2293 snprintf(filename
, sizeof(filename
), "%s/.cups/lpoptions", home
);
2295 cups_get_dests(filename
, name
, instance
, 1, 1, &dest
);
2299 * Return the result...
2307 * 'cupsRemoveDest()' - Remove a destination from the destination list.
2309 * Removing a destination/instance does not delete the class or printer
2310 * queue, merely the lpoptions for that destination/instance. Use the
2311 * @link cupsSetDests@ or @link cupsSetDests2@ functions to save the new
2312 * options for the user.
2314 * @since CUPS 1.3/macOS 10.5@
2317 int /* O - New number of destinations */
2318 cupsRemoveDest(const char *name
, /* I - Destination name */
2319 const char *instance
, /* I - Instance name or @code NULL@ */
2320 int num_dests
, /* I - Number of destinations */
2321 cups_dest_t
**dests
) /* IO - Destinations */
2323 int i
; /* Index into destinations */
2324 cups_dest_t
*dest
; /* Pointer to destination */
2328 * Find the destination...
2331 if ((dest
= cupsGetDest(name
, instance
, num_dests
, *dests
)) == NULL
)
2338 _cupsStrFree(dest
->name
);
2339 _cupsStrFree(dest
->instance
);
2340 cupsFreeOptions(dest
->num_options
, dest
->options
);
2343 * Remove the destination from the array...
2348 i
= (int)(dest
- *dests
);
2351 memmove(dest
, dest
+ 1, (size_t)(num_dests
- i
) * sizeof(cups_dest_t
));
2358 * 'cupsSetDefaultDest()' - Set the default destination.
2360 * @since CUPS 1.3/macOS 10.5@
2365 const char *name
, /* I - Destination name */
2366 const char *instance
, /* I - Instance name or @code NULL@ */
2367 int num_dests
, /* I - Number of destinations */
2368 cups_dest_t
*dests
) /* I - Destinations */
2370 int i
; /* Looping var */
2371 cups_dest_t
*dest
; /* Current destination */
2375 * Range check input...
2378 if (!name
|| num_dests
<= 0 || !dests
)
2382 * Loop through the array and set the "is_default" flag for the matching
2386 for (i
= num_dests
, dest
= dests
; i
> 0; i
--, dest
++)
2387 dest
->is_default
= !_cups_strcasecmp(name
, dest
->name
) &&
2388 ((!instance
&& !dest
->instance
) ||
2389 (instance
&& dest
->instance
&&
2390 !_cups_strcasecmp(instance
, dest
->instance
)));
2395 * 'cupsSetDests()' - Save the list of destinations for the default server.
2397 * This function saves the destinations to /etc/cups/lpoptions when run
2398 * as root and ~/.cups/lpoptions when run as a normal user.
2404 cupsSetDests(int num_dests
, /* I - Number of destinations */
2405 cups_dest_t
*dests
) /* I - Destinations */
2407 cupsSetDests2(CUPS_HTTP_DEFAULT
, num_dests
, dests
);
2412 * 'cupsSetDests2()' - Save the list of destinations for the specified server.
2414 * This function saves the destinations to /etc/cups/lpoptions when run
2415 * as root and ~/.cups/lpoptions when run as a normal user.
2417 * @since CUPS 1.1.21/macOS 10.4@
2420 int /* O - 0 on success, -1 on error */
2421 cupsSetDests2(http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
2422 int num_dests
, /* I - Number of destinations */
2423 cups_dest_t
*dests
) /* I - Destinations */
2425 int i
, j
; /* Looping vars */
2426 int wrote
; /* Wrote definition? */
2427 cups_dest_t
*dest
; /* Current destination */
2428 cups_option_t
*option
; /* Current option */
2429 _ipp_option_t
*match
; /* Matching attribute for option */
2430 FILE *fp
; /* File pointer */
2432 const char *home
; /* HOME environment variable */
2434 char filename
[1024]; /* lpoptions file */
2435 int num_temps
; /* Number of temporary destinations */
2436 cups_dest_t
*temps
= NULL
, /* Temporary destinations */
2437 *temp
; /* Current temporary dest */
2438 const char *val
; /* Value of temporary option */
2439 _cups_globals_t
*cg
= _cupsGlobals(); /* Pointer to library globals */
2443 * Range check the input...
2446 if (!num_dests
|| !dests
)
2450 * Get the server destinations...
2453 num_temps
= _cupsGetDests(http
, IPP_OP_CUPS_GET_PRINTERS
, NULL
, &temps
, 0, 0);
2455 if (cupsLastError() >= IPP_STATUS_REDIRECTION_OTHER_SITE
)
2457 cupsFreeDests(num_temps
, temps
);
2462 * Figure out which file to write to...
2465 snprintf(filename
, sizeof(filename
), "%s/lpoptions", cg
->cups_serverroot
);
2471 * Merge in server defaults...
2474 num_temps
= cups_get_dests(filename
, NULL
, NULL
, 0, num_temps
, &temps
);
2477 * Point to user defaults...
2480 if ((home
= getenv("HOME")) != NULL
)
2483 * Create ~/.cups subdirectory...
2486 snprintf(filename
, sizeof(filename
), "%s/.cups", home
);
2487 if (access(filename
, 0))
2488 mkdir(filename
, 0700);
2490 snprintf(filename
, sizeof(filename
), "%s/.cups/lpoptions", home
);
2496 * Try to open the file...
2499 if ((fp
= fopen(filename
, "w")) == NULL
)
2501 cupsFreeDests(num_temps
, temps
);
2507 * Set the permissions to 0644 when saving to the /etc/cups/lpoptions
2512 fchmod(fileno(fp
), 0644);
2516 * Write each printer; each line looks like:
2518 * Dest name[/instance] options
2519 * Default name[/instance] options
2522 for (i
= num_dests
, dest
= dests
; i
> 0; i
--, dest
++)
2523 if (dest
->instance
!= NULL
|| dest
->num_options
!= 0 || dest
->is_default
)
2525 if (dest
->is_default
)
2527 fprintf(fp
, "Default %s", dest
->name
);
2529 fprintf(fp
, "/%s", dest
->instance
);
2536 if ((temp
= cupsGetDest(dest
->name
, dest
->instance
, num_temps
, temps
)) == NULL
)
2537 temp
= cupsGetDest(dest
->name
, NULL
, num_temps
, temps
);
2539 for (j
= dest
->num_options
, option
= dest
->options
; j
> 0; j
--, option
++)
2542 * See if this option is a printer attribute; if so, skip it...
2545 if ((match
= _ippFindOption(option
->name
)) != NULL
&&
2546 match
->group_tag
== IPP_TAG_PRINTER
)
2550 * See if the server/global options match these; if so, don't
2555 (val
= cupsGetOption(option
->name
, temp
->num_options
,
2556 temp
->options
)) != NULL
&&
2557 !_cups_strcasecmp(val
, option
->value
))
2561 * Options don't match, write to the file...
2566 fprintf(fp
, "Dest %s", dest
->name
);
2568 fprintf(fp
, "/%s", dest
->instance
);
2572 if (option
->value
[0])
2574 if (strchr(option
->value
, ' ') ||
2575 strchr(option
->value
, '\\') ||
2576 strchr(option
->value
, '\"') ||
2577 strchr(option
->value
, '\''))
2580 * Quote the value...
2583 fprintf(fp
, " %s=\"", option
->name
);
2585 for (val
= option
->value
; *val
; val
++)
2587 if (strchr("\"\'\\", *val
))
2598 * Store the literal value...
2601 fprintf(fp
, " %s=%s", option
->name
, option
->value
);
2605 fprintf(fp
, " %s", option
->name
);
2613 * Free the temporary destinations and close the file...
2616 cupsFreeDests(num_temps
, temps
);
2622 * Set the default printer for this location - this allows command-line
2623 * and GUI applications to share the same default destination...
2626 if ((dest
= cupsGetDest(NULL
, NULL
, num_dests
, dests
)) != NULL
)
2628 CFStringRef name
= CFStringCreateWithCString(kCFAllocatorDefault
,
2630 kCFStringEncodingUTF8
);
2631 /* Default printer name */
2635 _cupsAppleSetDefaultPrinter(name
);
2639 #endif /* __APPLE__ */
2641 #ifdef HAVE_NOTIFY_POST
2643 * Send a notification so that macOS applications can know about the
2647 notify_post("com.apple.printerListChange");
2648 #endif /* HAVE_NOTIFY_POST */
2655 * '_cupsUserDefault()' - Get the user default printer from environment
2656 * variables and location information.
2659 char * /* O - Default printer or NULL */
2660 _cupsUserDefault(char *name
, /* I - Name buffer */
2661 size_t namesize
) /* I - Size of name buffer */
2663 const char *env
; /* LPDEST or PRINTER env variable */
2665 CFStringRef locprinter
; /* Last printer as this location */
2666 #endif /* __APPLE__ */
2669 if ((env
= getenv("LPDEST")) == NULL
)
2670 if ((env
= getenv("PRINTER")) != NULL
&& !strcmp(env
, "lp"))
2675 strlcpy(name
, env
, namesize
);
2681 * Use location-based defaults if "use last printer" is selected in the
2682 * system preferences...
2685 if ((locprinter
= _cupsAppleCopyDefaultPrinter()) != NULL
)
2687 CFStringGetCString(locprinter
, name
, (CFIndex
)namesize
, kCFStringEncodingUTF8
);
2688 CFRelease(locprinter
);
2693 DEBUG_printf(("1_cupsUserDefault: Returning \"%s\".", name
));
2695 return (*name
? name
: NULL
);
2699 * No location-based defaults on this platform...
2704 #endif /* __APPLE__ */
2708 #if _CUPS_LOCATION_DEFAULTS
2710 * 'appleCopyLocations()' - Copy the location history array.
2713 static CFArrayRef
/* O - Location array or NULL */
2714 appleCopyLocations(void)
2716 CFArrayRef locations
; /* Location array */
2720 * Look up the location array in the preferences...
2723 if ((locations
= CFPreferencesCopyAppValue(kLastUsedPrintersKey
,
2724 kCUPSPrintingPrefs
)) == NULL
)
2727 if (CFGetTypeID(locations
) != CFArrayGetTypeID())
2729 CFRelease(locations
);
2738 * 'appleCopyNetwork()' - Get the network ID for the current location.
2741 static CFStringRef
/* O - Network ID */
2742 appleCopyNetwork(void)
2744 SCDynamicStoreRef dynamicStore
; /* System configuration data */
2745 CFStringRef key
; /* Current network configuration key */
2746 CFDictionaryRef ip_dict
; /* Network configuration data */
2747 CFStringRef network
= NULL
; /* Current network ID */
2750 if ((dynamicStore
= SCDynamicStoreCreate(NULL
, CFSTR("libcups"), NULL
,
2754 * First use the IPv6 router address, if available, since that will generally
2755 * be a globally-unique link-local address.
2758 if ((key
= SCDynamicStoreKeyCreateNetworkGlobalEntity(
2759 NULL
, kSCDynamicStoreDomainState
, kSCEntNetIPv6
)) != NULL
)
2761 if ((ip_dict
= SCDynamicStoreCopyValue(dynamicStore
, key
)) != NULL
)
2763 if ((network
= CFDictionaryGetValue(ip_dict
,
2764 kSCPropNetIPv6Router
)) != NULL
)
2774 * If that doesn't work, try the IPv4 router address. This isn't as unique
2775 * and will likely be a 10.x.y.z or 192.168.y.z address...
2780 if ((key
= SCDynamicStoreKeyCreateNetworkGlobalEntity(
2781 NULL
, kSCDynamicStoreDomainState
, kSCEntNetIPv4
)) != NULL
)
2783 if ((ip_dict
= SCDynamicStoreCopyValue(dynamicStore
, key
)) != NULL
)
2785 if ((network
= CFDictionaryGetValue(ip_dict
,
2786 kSCPropNetIPv4Router
)) != NULL
)
2796 CFRelease(dynamicStore
);
2801 #endif /* _CUPS_LOCATION_DEFAULTS */
2806 * 'appleGetPaperSize()' - Get the default paper size.
2809 static char * /* O - Default paper size */
2810 appleGetPaperSize(char *name
, /* I - Paper size name buffer */
2811 size_t namesize
) /* I - Size of buffer */
2813 CFStringRef defaultPaperID
; /* Default paper ID */
2814 pwg_media_t
*pwgmedia
; /* PWG media size */
2817 defaultPaperID
= _cupsAppleCopyDefaultPaperID();
2818 if (!defaultPaperID
||
2819 CFGetTypeID(defaultPaperID
) != CFStringGetTypeID() ||
2820 !CFStringGetCString(defaultPaperID
, name
, (CFIndex
)namesize
, kCFStringEncodingUTF8
))
2822 else if ((pwgmedia
= pwgMediaForLegacy(name
)) != NULL
)
2823 strlcpy(name
, pwgmedia
->pwg
, namesize
);
2826 CFRelease(defaultPaperID
);
2830 #endif /* __APPLE__ */
2833 #if _CUPS_LOCATION_DEFAULTS
2835 * 'appleGetPrinter()' - Get a printer from the history array.
2838 static CFStringRef
/* O - Printer name or NULL */
2839 appleGetPrinter(CFArrayRef locations
, /* I - Location array */
2840 CFStringRef network
, /* I - Network name */
2841 CFIndex
*locindex
) /* O - Index in array */
2843 CFIndex i
, /* Looping var */
2844 count
; /* Number of locations */
2845 CFDictionaryRef location
; /* Current location */
2846 CFStringRef locnetwork
, /* Current network */
2847 locprinter
; /* Current printer */
2850 for (i
= 0, count
= CFArrayGetCount(locations
); i
< count
; i
++)
2851 if ((location
= CFArrayGetValueAtIndex(locations
, i
)) != NULL
&&
2852 CFGetTypeID(location
) == CFDictionaryGetTypeID())
2854 if ((locnetwork
= CFDictionaryGetValue(location
,
2855 kLocationNetworkKey
)) != NULL
&&
2856 CFGetTypeID(locnetwork
) == CFStringGetTypeID() &&
2857 CFStringCompare(network
, locnetwork
, 0) == kCFCompareEqualTo
&&
2858 (locprinter
= CFDictionaryGetValue(location
,
2859 kLocationPrinterIDKey
)) != NULL
&&
2860 CFGetTypeID(locprinter
) == CFStringGetTypeID())
2865 return (locprinter
);
2871 #endif /* _CUPS_LOCATION_DEFAULTS */
2875 * 'cups_add_dest()' - Add a destination to the array.
2877 * Unlike cupsAddDest(), this function does not check for duplicates.
2880 static cups_dest_t
* /* O - New destination */
2881 cups_add_dest(const char *name
, /* I - Name of destination */
2882 const char *instance
, /* I - Instance or NULL */
2883 int *num_dests
, /* IO - Number of destinations */
2884 cups_dest_t
**dests
) /* IO - Destinations */
2886 int insert
, /* Insertion point */
2887 diff
; /* Result of comparison */
2888 cups_dest_t
*dest
; /* Destination pointer */
2892 * Add new destination...
2895 if (*num_dests
== 0)
2896 dest
= malloc(sizeof(cups_dest_t
));
2898 dest
= realloc(*dests
, sizeof(cups_dest_t
) * (size_t)(*num_dests
+ 1));
2906 * Find where to insert the destination...
2909 if (*num_dests
== 0)
2913 insert
= cups_find_dest(name
, instance
, *num_dests
, *dests
, *num_dests
- 1,
2921 * Move the array elements as needed...
2924 if (insert
< *num_dests
)
2925 memmove(*dests
+ insert
+ 1, *dests
+ insert
, (size_t)(*num_dests
- insert
) * sizeof(cups_dest_t
));
2930 * Initialize the destination...
2933 dest
= *dests
+ insert
;
2934 dest
->name
= _cupsStrAlloc(name
);
2935 dest
->instance
= _cupsStrAlloc(instance
);
2936 dest
->is_default
= 0;
2937 dest
->num_options
= 0;
2938 dest
->options
= (cups_option_t
*)0;
2946 * 'cups_block_cb()' - Enumeration callback for block API.
2949 static int /* O - 1 to continue, 0 to stop */
2951 cups_dest_block_t block
, /* I - Block */
2952 unsigned flags
, /* I - Destination flags */
2953 cups_dest_t
*dest
) /* I - Destination */
2955 return ((block
)(flags
, dest
));
2957 # endif /* __BLOCKS__ */
2961 * 'cups_compare_dests()' - Compare two destinations.
2964 static int /* O - Result of comparison */
2965 cups_compare_dests(cups_dest_t
*a
, /* I - First destination */
2966 cups_dest_t
*b
) /* I - Second destination */
2968 int diff
; /* Difference */
2971 if ((diff
= _cups_strcasecmp(a
->name
, b
->name
)) != 0)
2973 else if (a
->instance
&& b
->instance
)
2974 return (_cups_strcasecmp(a
->instance
, b
->instance
));
2976 return ((a
->instance
&& !b
->instance
) - (!a
->instance
&& b
->instance
));
2980 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
2983 * 'cups_dnssd_browse_cb()' - Browse for printers.
2987 cups_dnssd_browse_cb(
2988 DNSServiceRef sdRef
, /* I - Service reference */
2989 DNSServiceFlags flags
, /* I - Option flags */
2990 uint32_t interfaceIndex
, /* I - Interface number */
2991 DNSServiceErrorType errorCode
, /* I - Error, if any */
2992 const char *serviceName
, /* I - Name of service/device */
2993 const char *regtype
, /* I - Type of service */
2994 const char *replyDomain
, /* I - Service domain */
2995 void *context
) /* I - Enumeration data */
2997 _cups_dnssd_data_t
*data
= (_cups_dnssd_data_t
*)context
;
2998 /* Enumeration data */
3001 DEBUG_printf(("5cups_dnssd_browse_cb(sdRef=%p, flags=%x, interfaceIndex=%d, errorCode=%d, serviceName=\"%s\", regtype=\"%s\", replyDomain=\"%s\", context=%p)", (void *)sdRef
, flags
, interfaceIndex
, errorCode
, serviceName
, regtype
, replyDomain
, context
));
3004 * Don't do anything on error...
3007 if (errorCode
!= kDNSServiceErr_NoError
)
3014 cups_dnssd_get_device(data
, serviceName
, regtype
, replyDomain
);
3018 # else /* HAVE_AVAHI */
3020 * 'cups_dnssd_browse_cb()' - Browse for printers.
3024 cups_dnssd_browse_cb(
3025 AvahiServiceBrowser
*browser
, /* I - Browser */
3026 AvahiIfIndex interface
, /* I - Interface index (unused) */
3027 AvahiProtocol protocol
, /* I - Network protocol (unused) */
3028 AvahiBrowserEvent event
, /* I - What happened */
3029 const char *name
, /* I - Service name */
3030 const char *type
, /* I - Registration type */
3031 const char *domain
, /* I - Domain */
3032 AvahiLookupResultFlags flags
, /* I - Flags */
3033 void *context
) /* I - Devices array */
3036 AvahiClient
*client
= avahi_service_browser_get_client(browser
);
3037 /* Client information */
3039 _cups_dnssd_data_t
*data
= (_cups_dnssd_data_t
*)context
;
3040 /* Enumeration data */
3047 DEBUG_printf(("cups_dnssd_browse_cb(..., name=\"%s\", type=\"%s\", domain=\"%s\", ...);", name
, type
, domain
));
3051 case AVAHI_BROWSER_FAILURE
:
3052 DEBUG_printf(("cups_dnssd_browse_cb: %s", avahi_strerror(avahi_client_errno(client
))));
3053 avahi_simple_poll_quit(data
->simple_poll
);
3056 case AVAHI_BROWSER_NEW
:
3058 * This object is new on the network.
3061 if (flags
& AVAHI_LOOKUP_RESULT_LOCAL
)
3064 * This comes from the local machine so ignore it.
3067 DEBUG_printf(("cups_dnssd_browse_cb: Ignoring local service \"%s\".", name
));
3072 * Create a device entry for it if it doesn't yet exist.
3075 cups_dnssd_get_device(data
, name
, type
, domain
);
3079 case AVAHI_BROWSER_REMOVE
:
3080 case AVAHI_BROWSER_CACHE_EXHAUSTED
:
3083 case AVAHI_BROWSER_ALL_FOR_NOW
:
3084 DEBUG_puts("cups_dnssd_browse_cb: ALL_FOR_NOW");
3092 * 'cups_dnssd_client_cb()' - Avahi client callback function.
3096 cups_dnssd_client_cb(
3097 AvahiClient
*client
, /* I - Client information (unused) */
3098 AvahiClientState state
, /* I - Current state */
3099 void *context
) /* I - User data (unused) */
3101 _cups_dnssd_data_t
*data
= (_cups_dnssd_data_t
*)context
;
3102 /* Enumeration data */
3107 DEBUG_printf(("cups_dnssd_client_cb(client=%p, state=%d, context=%p)", client
, state
, context
));
3110 * If the connection drops, quit.
3113 if (state
== AVAHI_CLIENT_FAILURE
)
3115 DEBUG_puts("cups_dnssd_client_cb: Avahi connection failed.");
3116 avahi_simple_poll_quit(data
->simple_poll
);
3119 # endif /* HAVE_DNSSD */
3123 * 'cups_dnssd_compare_device()' - Compare two devices.
3126 static int /* O - Result of comparison */
3127 cups_dnssd_compare_devices(
3128 _cups_dnssd_device_t
*a
, /* I - First device */
3129 _cups_dnssd_device_t
*b
) /* I - Second device */
3131 return (strcmp(a
->dest
.name
, b
->dest
.name
));
3136 * 'cups_dnssd_free_device()' - Free the memory used by a device.
3140 cups_dnssd_free_device(
3141 _cups_dnssd_device_t
*device
, /* I - Device */
3142 _cups_dnssd_data_t
*data
) /* I - Enumeration data */
3144 DEBUG_printf(("5cups_dnssd_free_device(device=%p(%s), data=%p)", (void *)device
, device
->dest
.name
, (void *)data
));
3148 DNSServiceRefDeallocate(device
->ref
);
3149 # else /* HAVE_AVAHI */
3151 avahi_record_browser_free(device
->ref
);
3152 # endif /* HAVE_DNSSD */
3154 _cupsStrFree(device
->domain
);
3155 _cupsStrFree(device
->fullName
);
3156 _cupsStrFree(device
->regtype
);
3157 _cupsStrFree(device
->dest
.name
);
3159 cupsFreeOptions(device
->dest
.num_options
, device
->dest
.options
);
3166 * 'cups_dnssd_get_device()' - Lookup a device and create it as needed.
3169 static _cups_dnssd_device_t
* /* O - Device */
3170 cups_dnssd_get_device(
3171 _cups_dnssd_data_t
*data
, /* I - Enumeration data */
3172 const char *serviceName
, /* I - Service name */
3173 const char *regtype
, /* I - Registration type */
3174 const char *replyDomain
) /* I - Domain name */
3176 _cups_dnssd_device_t key
, /* Search key */
3177 *device
; /* Device */
3178 char fullName
[kDNSServiceMaxDomainName
],
3179 /* Full name for query */
3180 name
[128]; /* Queue name */
3183 DEBUG_printf(("5cups_dnssd_get_device(data=%p, serviceName=\"%s\", regtype=\"%s\", replyDomain=\"%s\")", (void *)data
, serviceName
, regtype
, replyDomain
));
3186 * See if this is an existing device...
3189 cups_queue_name(name
, serviceName
, sizeof(name
));
3191 key
.dest
.name
= name
;
3193 if ((device
= cupsArrayFind(data
->devices
, &key
)) != NULL
)
3196 * Yes, see if we need to do anything with this...
3199 int update
= 0; /* Non-zero if we need to update */
3201 if (!_cups_strcasecmp(replyDomain
, "local.") &&
3202 _cups_strcasecmp(device
->domain
, replyDomain
))
3205 * Update the "global" listing to use the .local domain name instead.
3208 _cupsStrFree(device
->domain
);
3209 device
->domain
= _cupsStrAlloc(replyDomain
);
3211 DEBUG_printf(("6cups_dnssd_get_device: Updating '%s' to use local "
3212 "domain.", device
->dest
.name
));
3217 if (!_cups_strcasecmp(regtype
, "_ipps._tcp") &&
3218 _cups_strcasecmp(device
->regtype
, regtype
))
3221 * Prefer IPPS over IPP.
3224 _cupsStrFree(device
->regtype
);
3225 device
->regtype
= _cupsStrAlloc(regtype
);
3227 DEBUG_printf(("6cups_dnssd_get_device: Updating '%s' to use IPPS.",
3228 device
->dest
.name
));
3235 DEBUG_printf(("6cups_dnssd_get_device: No changes to '%s'.",
3236 device
->dest
.name
));
3243 * No, add the device...
3246 DEBUG_printf(("6cups_dnssd_get_device: Adding '%s' for %s with domain "
3247 "'%s'.", serviceName
,
3248 !strcmp(regtype
, "_ipps._tcp") ? "IPPS" : "IPP",
3251 device
= calloc(sizeof(_cups_dnssd_device_t
), 1);
3252 device
->dest
.name
= _cupsStrAlloc(name
);
3253 device
->domain
= _cupsStrAlloc(replyDomain
);
3254 device
->regtype
= _cupsStrAlloc(regtype
);
3256 device
->dest
.num_options
= cupsAddOption("printer-info", serviceName
, 0, &device
->dest
.options
);
3258 cupsArrayAdd(data
->devices
, device
);
3262 * Set the "full name" of this service, which is used for queries...
3266 DNSServiceConstructFullName(fullName
, serviceName
, regtype
, replyDomain
);
3267 # else /* HAVE_AVAHI */
3268 avahi_service_name_join(fullName
, kDNSServiceMaxDomainName
, serviceName
, regtype
, replyDomain
);
3269 # endif /* HAVE_DNSSD */
3271 _cupsStrFree(device
->fullName
);
3272 device
->fullName
= _cupsStrAlloc(fullName
);
3277 DNSServiceRefDeallocate(device
->ref
);
3278 # else /* HAVE_AVAHI */
3279 avahi_record_browser_free(device
->ref
);
3280 # endif /* HAVE_DNSSD */
3285 if (device
->state
== _CUPS_DNSSD_ACTIVE
)
3287 DEBUG_printf(("6cups_dnssd_get_device: Remove callback for \"%s\".", device
->dest
.name
));
3289 (*data
->cb
)(data
->user_data
, CUPS_DEST_FLAGS_REMOVED
, &device
->dest
);
3290 device
->state
= _CUPS_DNSSD_NEW
;
3299 * 'cups_dnssd_local_cb()' - Browse for local printers.
3303 cups_dnssd_local_cb(
3304 DNSServiceRef sdRef
, /* I - Service reference */
3305 DNSServiceFlags flags
, /* I - Option flags */
3306 uint32_t interfaceIndex
, /* I - Interface number */
3307 DNSServiceErrorType errorCode
, /* I - Error, if any */
3308 const char *serviceName
, /* I - Name of service/device */
3309 const char *regtype
, /* I - Type of service */
3310 const char *replyDomain
, /* I - Service domain */
3311 void *context
) /* I - Devices array */
3313 _cups_dnssd_data_t
*data
= (_cups_dnssd_data_t
*)context
;
3314 /* Enumeration data */
3315 _cups_dnssd_device_t
*device
; /* Device */
3318 DEBUG_printf(("5cups_dnssd_local_cb(sdRef=%p, flags=%x, interfaceIndex=%d, errorCode=%d, serviceName=\"%s\", regtype=\"%s\", replyDomain=\"%s\", context=%p)", (void *)sdRef
, flags
, interfaceIndex
, errorCode
, serviceName
, regtype
, replyDomain
, context
));
3321 * Only process "add" data...
3324 if (errorCode
!= kDNSServiceErr_NoError
|| !(flags
& kDNSServiceFlagsAdd
))
3331 device
= cups_dnssd_get_device(data
, serviceName
, regtype
, replyDomain
);
3334 * Hide locally-registered devices...
3337 DEBUG_printf(("6cups_dnssd_local_cb: Hiding local printer '%s'.",
3342 DNSServiceRefDeallocate(device
->ref
);
3346 if (device
->state
== _CUPS_DNSSD_ACTIVE
)
3348 DEBUG_printf(("6cups_dnssd_local_cb: Remove callback for \"%s\".", device
->dest
.name
));
3349 (*data
->cb
)(data
->user_data
, CUPS_DEST_FLAGS_REMOVED
, &device
->dest
);
3352 device
->state
= _CUPS_DNSSD_LOCAL
;
3354 # endif /* HAVE_DNSSD */
3359 * 'cups_dnssd_poll_cb()' - Wait for input on the specified file descriptors.
3361 * Note: This function is needed because avahi_simple_poll_iterate is broken
3362 * and always uses a timeout of 0 (!) milliseconds.
3363 * (https://github.com/lathiat/avahi/issues/127)
3368 static int /* O - Number of file descriptors matching */
3370 struct pollfd
*pollfds
, /* I - File descriptors */
3371 unsigned int num_pollfds
, /* I - Number of file descriptors */
3372 int timeout
, /* I - Timeout in milliseconds (unused) */
3373 void *context
) /* I - User data (unused) */
3375 _cups_dnssd_data_t
*data
= (_cups_dnssd_data_t
*)context
;
3376 /* Enumeration data */
3377 int val
; /* Return value */
3380 DEBUG_printf(("cups_dnssd_poll_cb(pollfds=%p, num_pollfds=%d, timeout=%d, context=%p)", pollfds
, num_pollfds
, timeout
, context
));
3384 val
= poll(pollfds
, num_pollfds
, _CUPS_DNSSD_MAXTIME
);
3386 DEBUG_printf(("cups_dnssd_poll_cb: poll() returned %d", val
));
3390 DEBUG_printf(("cups_dnssd_poll_cb: %s", strerror(errno
)));
3399 # endif /* HAVE_AVAHI */
3403 * 'cups_dnssd_query_cb()' - Process query data.
3408 cups_dnssd_query_cb(
3409 DNSServiceRef sdRef
, /* I - Service reference */
3410 DNSServiceFlags flags
, /* I - Data flags */
3411 uint32_t interfaceIndex
, /* I - Interface */
3412 DNSServiceErrorType errorCode
, /* I - Error, if any */
3413 const char *fullName
, /* I - Full service name */
3414 uint16_t rrtype
, /* I - Record type */
3415 uint16_t rrclass
, /* I - Record class */
3416 uint16_t rdlen
, /* I - Length of record data */
3417 const void *rdata
, /* I - Record data */
3418 uint32_t ttl
, /* I - Time-to-live */
3419 void *context
) /* I - Enumeration data */
3421 # else /* HAVE_AVAHI */
3423 cups_dnssd_query_cb(
3424 AvahiRecordBrowser
*browser
, /* I - Record browser */
3425 AvahiIfIndex interfaceIndex
,
3426 /* I - Interface index (unused) */
3427 AvahiProtocol protocol
, /* I - Network protocol (unused) */
3428 AvahiBrowserEvent event
, /* I - What happened? */
3429 const char *fullName
, /* I - Service name */
3430 uint16_t rrclass
, /* I - Record class */
3431 uint16_t rrtype
, /* I - Record type */
3432 const void *rdata
, /* I - TXT record */
3433 size_t rdlen
, /* I - Length of TXT record */
3434 AvahiLookupResultFlags flags
, /* I - Flags */
3435 void *context
) /* I - Enumeration data */
3438 AvahiClient
*client
= avahi_record_browser_get_client(browser
);
3439 /* Client information */
3441 # endif /* HAVE_DNSSD */
3442 _cups_dnssd_data_t
*data
= (_cups_dnssd_data_t
*)context
;
3443 /* Enumeration data */
3444 char serviceName
[256],/* Service name */
3445 name
[128], /* Queue name */
3446 *ptr
; /* Pointer into string */
3447 _cups_dnssd_device_t dkey
, /* Search key */
3448 *device
; /* Device */
3452 DEBUG_printf(("5cups_dnssd_query_cb(sdRef=%p, flags=%x, interfaceIndex=%d, errorCode=%d, fullName=\"%s\", rrtype=%u, rrclass=%u, rdlen=%u, rdata=%p, ttl=%u, context=%p)", (void *)sdRef
, flags
, interfaceIndex
, errorCode
, fullName
, rrtype
, rrclass
, rdlen
, rdata
, ttl
, context
));
3455 * Only process "add" data...
3458 if (errorCode
!= kDNSServiceErr_NoError
|| !(flags
& kDNSServiceFlagsAdd
))
3461 # else /* HAVE_AVAHI */
3462 DEBUG_printf(("cups_dnssd_query_cb(browser=%p, interfaceIndex=%d, protocol=%d, event=%d, fullName=\"%s\", rrclass=%u, rrtype=%u, rdata=%p, rdlen=%u, flags=%x, context=%p)", browser
, interfaceIndex
, protocol
, event
, fullName
, rrclass
, rrtype
, rdata
, (unsigned)rdlen
, flags
, context
));
3465 * Only process "add" data...
3468 if (event
!= AVAHI_BROWSER_NEW
)
3470 if (event
== AVAHI_BROWSER_FAILURE
)
3471 DEBUG_printf(("cups_dnssd_query_cb: %s", avahi_strerror(avahi_client_errno(client
))));
3475 # endif /* HAVE_DNSSD */
3478 * Lookup the service in the devices array.
3481 cups_dnssd_unquote(serviceName
, fullName
, sizeof(serviceName
));
3483 if ((ptr
= strstr(serviceName
, "._")) != NULL
)
3486 cups_queue_name(name
, serviceName
, sizeof(name
));
3488 dkey
.dest
.name
= name
;
3490 if ((device
= cupsArrayFind(data
->devices
, &dkey
)) != NULL
&& device
->state
== _CUPS_DNSSD_NEW
)
3493 * Found it, pull out the make and model from the TXT record and save it...
3496 const uint8_t *txt
, /* Pointer into data */
3497 *txtnext
, /* Next key/value pair */
3498 *txtend
; /* End of entire TXT record */
3499 uint8_t txtlen
; /* Length of current key/value pair */
3500 char key
[256], /* Key string */
3501 value
[256], /* Value string */
3502 make_and_model
[512],
3503 /* Manufacturer and model */
3504 model
[256], /* Model */
3505 uriname
[1024], /* Name for URI */
3506 uri
[1024]; /* Printer URI */
3507 cups_ptype_t type
= CUPS_PRINTER_DISCOVERED
| CUPS_PRINTER_BW
;
3509 int saw_printer_type
= 0;
3510 /* Did we see a printer-type key? */
3512 device
->state
= _CUPS_DNSSD_PENDING
;
3513 make_and_model
[0] = '\0';
3515 strlcpy(model
, "Unknown", sizeof(model
));
3517 for (txt
= rdata
, txtend
= txt
+ rdlen
;
3522 * Read a key/value pair starting with an 8-bit length. Since the
3523 * length is 8 bits and the size of the key/value buffers is 256, we
3524 * don't need to check for overflow...
3529 if (!txtlen
|| (txt
+ txtlen
) > txtend
)
3532 txtnext
= txt
+ txtlen
;
3534 for (ptr
= key
; txt
< txtnext
&& *txt
!= '='; txt
++)
3535 *ptr
++ = (char)*txt
;
3538 if (txt
< txtnext
&& *txt
== '=')
3543 memcpy(value
, txt
, (size_t)(txtnext
- txt
));
3544 value
[txtnext
- txt
] = '\0';
3546 DEBUG_printf(("6cups_dnssd_query_cb: %s=%s", key
, value
));
3550 DEBUG_printf(("6cups_dnssd_query_cb: '%s' with no value.", key
));
3554 if (!_cups_strcasecmp(key
, "usb_MFG") ||
3555 !_cups_strcasecmp(key
, "usb_MANU") ||
3556 !_cups_strcasecmp(key
, "usb_MANUFACTURER"))
3557 strlcpy(make_and_model
, value
, sizeof(make_and_model
));
3558 else if (!_cups_strcasecmp(key
, "usb_MDL") ||
3559 !_cups_strcasecmp(key
, "usb_MODEL"))
3560 strlcpy(model
, value
, sizeof(model
));
3561 else if (!_cups_strcasecmp(key
, "product") && !strstr(value
, "Ghostscript"))
3563 if (value
[0] == '(')
3566 * Strip parenthesis...
3569 if ((ptr
= value
+ strlen(value
) - 1) > value
&& *ptr
== ')')
3572 strlcpy(model
, value
+ 1, sizeof(model
));
3575 strlcpy(model
, value
, sizeof(model
));
3577 else if (!_cups_strcasecmp(key
, "ty"))
3579 strlcpy(model
, value
, sizeof(model
));
3581 if ((ptr
= strchr(model
, ',')) != NULL
)
3584 else if (!_cups_strcasecmp(key
, "note"))
3585 device
->dest
.num_options
= cupsAddOption("printer-location", value
,
3586 device
->dest
.num_options
,
3587 &device
->dest
.options
);
3588 else if (!_cups_strcasecmp(key
, "pdl"))
3591 * Look for PDF-capable printers; only PDF-capable printers are shown.
3594 const char *start
, *next
; /* Pointer into value */
3595 int have_pdf
= 0, /* Have PDF? */
3596 have_raster
= 0;/* Have raster format support? */
3598 for (start
= value
; start
&& *start
; start
= next
)
3600 if (!_cups_strncasecmp(start
, "application/pdf", 15) && (!start
[15] || start
[15] == ','))
3605 else if ((!_cups_strncasecmp(start
, "image/pwg-raster", 16) && (!start
[16] || start
[16] == ',')) ||
3606 (!_cups_strncasecmp(start
, "image/urf", 9) && (!start
[9] || start
[9] == ',')))
3612 if ((next
= strchr(start
, ',')) != NULL
)
3616 if (!have_pdf
&& !have_raster
)
3617 device
->state
= _CUPS_DNSSD_INCOMPATIBLE
;
3619 else if (!_cups_strcasecmp(key
, "printer-type"))
3622 * Value is either NNNN or 0xXXXX
3625 saw_printer_type
= 1;
3626 type
= (cups_ptype_t
)strtol(value
, NULL
, 0) | CUPS_PRINTER_DISCOVERED
;
3628 else if (!saw_printer_type
)
3630 if (!_cups_strcasecmp(key
, "air") &&
3631 !_cups_strcasecmp(value
, "t"))
3632 type
|= CUPS_PRINTER_AUTHENTICATED
;
3633 else if (!_cups_strcasecmp(key
, "bind") &&
3634 !_cups_strcasecmp(value
, "t"))
3635 type
|= CUPS_PRINTER_BIND
;
3636 else if (!_cups_strcasecmp(key
, "collate") &&
3637 !_cups_strcasecmp(value
, "t"))
3638 type
|= CUPS_PRINTER_COLLATE
;
3639 else if (!_cups_strcasecmp(key
, "color") &&
3640 !_cups_strcasecmp(value
, "t"))
3641 type
|= CUPS_PRINTER_COLOR
;
3642 else if (!_cups_strcasecmp(key
, "copies") &&
3643 !_cups_strcasecmp(value
, "t"))
3644 type
|= CUPS_PRINTER_COPIES
;
3645 else if (!_cups_strcasecmp(key
, "duplex") &&
3646 !_cups_strcasecmp(value
, "t"))
3647 type
|= CUPS_PRINTER_DUPLEX
;
3648 else if (!_cups_strcasecmp(key
, "fax") &&
3649 !_cups_strcasecmp(value
, "t"))
3650 type
|= CUPS_PRINTER_MFP
;
3651 else if (!_cups_strcasecmp(key
, "papercustom") &&
3652 !_cups_strcasecmp(value
, "t"))
3653 type
|= CUPS_PRINTER_VARIABLE
;
3654 else if (!_cups_strcasecmp(key
, "papermax"))
3656 if (!_cups_strcasecmp(value
, "legal-a4"))
3657 type
|= CUPS_PRINTER_SMALL
;
3658 else if (!_cups_strcasecmp(value
, "isoc-a2"))
3659 type
|= CUPS_PRINTER_MEDIUM
;
3660 else if (!_cups_strcasecmp(value
, ">isoc-a2"))
3661 type
|= CUPS_PRINTER_LARGE
;
3663 else if (!_cups_strcasecmp(key
, "punch") &&
3664 !_cups_strcasecmp(value
, "t"))
3665 type
|= CUPS_PRINTER_PUNCH
;
3666 else if (!_cups_strcasecmp(key
, "scan") &&
3667 !_cups_strcasecmp(value
, "t"))
3668 type
|= CUPS_PRINTER_MFP
;
3669 else if (!_cups_strcasecmp(key
, "sort") &&
3670 !_cups_strcasecmp(value
, "t"))
3671 type
|= CUPS_PRINTER_SORT
;
3672 else if (!_cups_strcasecmp(key
, "staple") &&
3673 !_cups_strcasecmp(value
, "t"))
3674 type
|= CUPS_PRINTER_STAPLE
;
3679 * Save the printer-xxx values...
3682 if (make_and_model
[0])
3684 strlcat(make_and_model
, " ", sizeof(make_and_model
));
3685 strlcat(make_and_model
, model
, sizeof(make_and_model
));
3687 device
->dest
.num_options
= cupsAddOption("printer-make-and-model", make_and_model
, device
->dest
.num_options
, &device
->dest
.options
);
3690 device
->dest
.num_options
= cupsAddOption("printer-make-and-model", model
, device
->dest
.num_options
, &device
->dest
.options
);
3692 device
->type
= type
;
3693 snprintf(value
, sizeof(value
), "%u", type
);
3694 device
->dest
.num_options
= cupsAddOption("printer-type", value
, device
->dest
.num_options
, &device
->dest
.options
);
3700 cups_dnssd_unquote(uriname
, device
->fullName
, sizeof(uriname
));
3701 httpAssembleURI(HTTP_URI_CODING_ALL
, uri
, sizeof(uri
),
3702 !strcmp(device
->regtype
, "_ipps._tcp") ? "ipps" : "ipp",
3703 NULL
, uriname
, 0, saw_printer_type
? "/cups" : "/");
3705 DEBUG_printf(("6cups_dnssd_query: device-uri=\"%s\"", uri
));
3707 device
->dest
.num_options
= cupsAddOption("device-uri", uri
, device
->dest
.num_options
, &device
->dest
.options
);
3710 DEBUG_printf(("6cups_dnssd_query: Ignoring TXT record for '%s'.",
3716 * 'cups_dnssd_resolve()' - Resolve a Bonjour printer URI.
3719 static const char * /* O - Resolved URI or NULL */
3721 cups_dest_t
*dest
, /* I - Destination */
3722 const char *uri
, /* I - Current printer URI */
3723 int msec
, /* I - Time in milliseconds */
3724 int *cancel
, /* I - Pointer to "cancel" variable */
3725 cups_dest_cb_t cb
, /* I - Callback */
3726 void *user_data
) /* I - User data for callback */
3728 char tempuri
[1024]; /* Temporary URI buffer */
3729 _cups_dnssd_resolve_t resolve
; /* Resolve data */
3733 * Resolve the URI...
3736 resolve
.cancel
= cancel
;
3737 gettimeofday(&resolve
.end_time
, NULL
);
3740 resolve
.end_time
.tv_sec
+= msec
/ 1000;
3741 resolve
.end_time
.tv_usec
+= (msec
% 1000) * 1000;
3743 while (resolve
.end_time
.tv_usec
>= 1000000)
3745 resolve
.end_time
.tv_sec
++;
3746 resolve
.end_time
.tv_usec
-= 1000000;
3750 resolve
.end_time
.tv_sec
+= 75;
3753 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_RESOLVING
, dest
);
3755 if ((uri
= _httpResolveURI(uri
, tempuri
, sizeof(tempuri
), _HTTP_RESOLVE_DEFAULT
, cups_dnssd_resolve_cb
, &resolve
)) == NULL
)
3757 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("Unable to resolve printer-uri."), 1);
3760 (*cb
)(user_data
, CUPS_DEST_FLAGS_UNCONNECTED
| CUPS_DEST_FLAGS_ERROR
, dest
);
3766 * Save the resolved URI...
3769 dest
->num_options
= cupsAddOption("resolved-device-uri", uri
, dest
->num_options
, &dest
->options
);
3771 return (cupsGetOption("resolved-device-uri", dest
->num_options
, dest
->options
));
3776 * 'cups_dnssd_resolve_cb()' - See if we should continue resolving.
3779 static int /* O - 1 to continue, 0 to stop */
3780 cups_dnssd_resolve_cb(void *context
) /* I - Resolve data */
3782 _cups_dnssd_resolve_t
*resolve
= (_cups_dnssd_resolve_t
*)context
;
3784 struct timeval curtime
; /* Current time */
3788 * If the cancel variable is set, return immediately.
3791 if (resolve
->cancel
&& *(resolve
->cancel
))
3793 DEBUG_puts("4cups_dnssd_resolve_cb: Canceled.");
3798 * Otherwise check the end time...
3801 gettimeofday(&curtime
, NULL
);
3803 DEBUG_printf(("4cups_dnssd_resolve_cb: curtime=%d.%06d, end_time=%d.%06d", (int)curtime
.tv_sec
, (int)curtime
.tv_usec
, (int)resolve
->end_time
.tv_sec
, (int)resolve
->end_time
.tv_usec
));
3805 return (curtime
.tv_sec
< resolve
->end_time
.tv_sec
||
3806 (curtime
.tv_sec
== resolve
->end_time
.tv_sec
&&
3807 curtime
.tv_usec
< resolve
->end_time
.tv_usec
));
3812 * 'cups_dnssd_unquote()' - Unquote a name string.
3816 cups_dnssd_unquote(char *dst
, /* I - Destination buffer */
3817 const char *src
, /* I - Source string */
3818 size_t dstsize
) /* I - Size of destination buffer */
3820 char *dstend
= dst
+ dstsize
- 1; /* End of destination buffer */
3823 while (*src
&& dst
< dstend
)
3828 if (isdigit(src
[0] & 255) && isdigit(src
[1] & 255) &&
3829 isdigit(src
[2] & 255))
3831 *dst
++ = ((((src
[0] - '0') * 10) + src
[1] - '0') * 10) + src
[2] - '0';
3843 #endif /* HAVE_DNSSD */
3847 * 'cups_elapsed()' - Return the elapsed time in milliseconds.
3850 static int /* O - Elapsed time in milliseconds */
3851 cups_elapsed(struct timeval
*t
) /* IO - Previous time */
3853 int msecs
; /* Milliseconds */
3854 struct timeval nt
; /* New time */
3857 gettimeofday(&nt
, NULL
);
3859 msecs
= 1000 * (nt
.tv_sec
- t
->tv_sec
) + (nt
.tv_usec
- t
->tv_usec
) / 1000;
3868 * 'cups_find_dest()' - Find a destination using a binary search.
3871 static int /* O - Index of match */
3872 cups_find_dest(const char *name
, /* I - Destination name */
3873 const char *instance
, /* I - Instance or NULL */
3874 int num_dests
, /* I - Number of destinations */
3875 cups_dest_t
*dests
, /* I - Destinations */
3876 int prev
, /* I - Previous index */
3877 int *rdiff
) /* O - Difference of match */
3879 int left
, /* Low mark for binary search */
3880 right
, /* High mark for binary search */
3881 current
, /* Current index */
3882 diff
; /* Result of comparison */
3883 cups_dest_t key
; /* Search key */
3886 key
.name
= (char *)name
;
3887 key
.instance
= (char *)instance
;
3892 * Start search on either side of previous...
3895 if ((diff
= cups_compare_dests(&key
, dests
+ prev
)) == 0 ||
3896 (diff
< 0 && prev
== 0) ||
3897 (diff
> 0 && prev
== (num_dests
- 1)))
3905 * Start with previous on right side...
3914 * Start wih previous on left side...
3918 right
= num_dests
- 1;
3924 * Start search in the middle...
3928 right
= num_dests
- 1;
3933 current
= (left
+ right
) / 2;
3934 diff
= cups_compare_dests(&key
, dests
+ current
);
3943 while ((right
- left
) > 1);
3948 * Check the last 1 or 2 elements...
3951 if ((diff
= cups_compare_dests(&key
, dests
+ left
)) <= 0)
3955 diff
= cups_compare_dests(&key
, dests
+ right
);
3961 * Return the closest destination and the difference...
3971 * 'cups_get_cb()' - Collect enumerated destinations.
3974 static int /* O - 1 to continue, 0 to stop */
3975 cups_get_cb(_cups_getdata_t
*data
, /* I - Data from cupsGetDests */
3976 unsigned flags
, /* I - Enumeration flags */
3977 cups_dest_t
*dest
) /* I - Destination */
3979 if (flags
& CUPS_DEST_FLAGS_REMOVED
)
3982 * Remove destination from array...
3985 data
->num_dests
= cupsRemoveDest(dest
->name
, dest
->instance
, data
->num_dests
, &data
->dests
);
3990 * Add destination to array...
3993 data
->num_dests
= cupsCopyDest(dest
, data
->num_dests
, &data
->dests
);
4001 * 'cups_get_default()' - Get the default destination from an lpoptions file.
4004 static char * /* O - Default destination or NULL */
4005 cups_get_default(const char *filename
, /* I - File to read */
4006 char *namebuf
, /* I - Name buffer */
4007 size_t namesize
, /* I - Size of name buffer */
4008 const char **instance
) /* I - Instance */
4010 cups_file_t
*fp
; /* lpoptions file */
4011 char line
[8192], /* Line from file */
4012 *value
, /* Value for line */
4013 *nameptr
; /* Pointer into name */
4014 int linenum
; /* Current line */
4019 if ((fp
= cupsFileOpen(filename
, "r")) != NULL
)
4023 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
4025 if (!_cups_strcasecmp(line
, "default") && value
)
4027 strlcpy(namebuf
, value
, namesize
);
4029 if ((nameptr
= strchr(namebuf
, ' ')) != NULL
)
4031 if ((nameptr
= strchr(namebuf
, '\t')) != NULL
)
4034 if ((nameptr
= strchr(namebuf
, '/')) != NULL
)
4037 *instance
= nameptr
;
4045 return (*namebuf
? namebuf
: NULL
);
4050 * 'cups_get_dests()' - Get destinations from a file.
4053 static int /* O - Number of destinations */
4055 const char *filename
, /* I - File to read from */
4056 const char *match_name
, /* I - Destination name we want */
4057 const char *match_inst
, /* I - Instance name we want */
4058 int user_default_set
, /* I - User default printer set? */
4059 int num_dests
, /* I - Number of destinations */
4060 cups_dest_t
**dests
) /* IO - Destinations */
4062 int i
; /* Looping var */
4063 cups_dest_t
*dest
; /* Current destination */
4064 cups_file_t
*fp
; /* File pointer */
4065 char line
[8192], /* Line from file */
4066 *lineptr
, /* Pointer into line */
4067 *name
, /* Name of destination/option */
4068 *instance
; /* Instance of destination */
4069 int linenum
; /* Current line number */
4072 DEBUG_printf(("7cups_get_dests(filename=\"%s\", match_name=\"%s\", match_inst=\"%s\", user_default_set=%d, num_dests=%d, dests=%p)", filename
, match_name
, match_inst
, user_default_set
, num_dests
, (void *)dests
));
4075 * Try to open the file...
4078 if ((fp
= cupsFileOpen(filename
, "r")) == NULL
)
4082 * Read each printer; each line looks like:
4084 * Dest name[/instance] options
4085 * Default name[/instance] options
4090 while (cupsFileGetConf(fp
, line
, sizeof(line
), &lineptr
, &linenum
))
4093 * See what type of line it is...
4096 DEBUG_printf(("9cups_get_dests: linenum=%d line=\"%s\" lineptr=\"%s\"",
4097 linenum
, line
, lineptr
));
4099 if ((_cups_strcasecmp(line
, "dest") && _cups_strcasecmp(line
, "default")) || !lineptr
)
4101 DEBUG_puts("9cups_get_dests: Not a dest or default line...");
4108 * Search for an instance...
4111 while (!isspace(*lineptr
& 255) && *lineptr
&& *lineptr
!= '/')
4114 if (*lineptr
== '/')
4117 * Found an instance...
4124 * Search for an instance...
4127 while (!isspace(*lineptr
& 255) && *lineptr
)
4136 DEBUG_printf(("9cups_get_dests: name=\"%s\", instance=\"%s\"", name
,
4140 * See if the primary instance of the destination exists; if not,
4141 * ignore this entry and move on...
4146 if (_cups_strcasecmp(name
, match_name
) ||
4147 (!instance
&& match_inst
) ||
4148 (instance
&& !match_inst
) ||
4149 (instance
&& _cups_strcasecmp(instance
, match_inst
)))
4154 else if (cupsGetDest(name
, NULL
, num_dests
, *dests
) == NULL
)
4156 DEBUG_puts("9cups_get_dests: Not found!");
4162 * Add the destination...
4165 num_dests
= cupsAddDest(name
, instance
, num_dests
, dests
);
4167 if ((dest
= cupsGetDest(name
, instance
, num_dests
, *dests
)) == NULL
)
4173 DEBUG_puts("9cups_get_dests: Out of memory!");
4179 * Add options until we hit the end of the line...
4182 dest
->num_options
= cupsParseOptions(lineptr
, dest
->num_options
,
4186 * If we found what we were looking for, stop now...
4193 * Set this as default if needed...
4196 if (!user_default_set
&& !_cups_strcasecmp(line
, "default"))
4198 DEBUG_puts("9cups_get_dests: Setting as default...");
4200 for (i
= 0; i
< num_dests
; i
++)
4201 (*dests
)[i
].is_default
= 0;
4203 dest
->is_default
= 1;
4208 * Close the file and return...
4218 * 'cups_make_string()' - Make a comma-separated string of values from an IPP
4222 static char * /* O - New string */
4224 ipp_attribute_t
*attr
, /* I - Attribute to convert */
4225 char *buffer
, /* I - Buffer */
4226 size_t bufsize
) /* I - Size of buffer */
4228 int i
; /* Looping var */
4229 char *ptr
, /* Pointer into buffer */
4230 *end
, /* Pointer to end of buffer */
4231 *valptr
; /* Pointer into string attribute */
4235 * Return quickly if we have a single string value...
4238 if (attr
->num_values
== 1 &&
4239 attr
->value_tag
!= IPP_TAG_INTEGER
&&
4240 attr
->value_tag
!= IPP_TAG_ENUM
&&
4241 attr
->value_tag
!= IPP_TAG_BOOLEAN
&&
4242 attr
->value_tag
!= IPP_TAG_RANGE
)
4243 return (attr
->values
[0].string
.text
);
4246 * Copy the values to the string, separating with commas and escaping strings
4250 end
= buffer
+ bufsize
- 1;
4252 for (i
= 0, ptr
= buffer
; i
< attr
->num_values
&& ptr
< end
; i
++)
4257 switch (attr
->value_tag
)
4259 case IPP_TAG_INTEGER
:
4261 snprintf(ptr
, (size_t)(end
- ptr
+ 1), "%d", attr
->values
[i
].integer
);
4264 case IPP_TAG_BOOLEAN
:
4265 if (attr
->values
[i
].boolean
)
4266 strlcpy(ptr
, "true", (size_t)(end
- ptr
+ 1));
4268 strlcpy(ptr
, "false", (size_t)(end
- ptr
+ 1));
4271 case IPP_TAG_RANGE
:
4272 if (attr
->values
[i
].range
.lower
== attr
->values
[i
].range
.upper
)
4273 snprintf(ptr
, (size_t)(end
- ptr
+ 1), "%d", attr
->values
[i
].range
.lower
);
4275 snprintf(ptr
, (size_t)(end
- ptr
+ 1), "%d-%d", attr
->values
[i
].range
.lower
, attr
->values
[i
].range
.upper
);
4279 for (valptr
= attr
->values
[i
].string
.text
;
4280 *valptr
&& ptr
< end
;)
4282 if (strchr(" \t\n\\\'\"", *valptr
))
4284 if (ptr
>= (end
- 1))
4307 * 'cups_name_cb()' - Find an enumerated destination.
4310 static int /* O - 1 to continue, 0 to stop */
4311 cups_name_cb(_cups_namedata_t
*data
, /* I - Data from cupsGetNamedDest */
4312 unsigned flags
, /* I - Enumeration flags */
4313 cups_dest_t
*dest
) /* I - Destination */
4315 DEBUG_printf(("2cups_name_cb(data=%p(%s), flags=%x, dest=%p(%s)", data
, data
->name
, flags
, dest
, dest
->name
));
4317 if (!(flags
& CUPS_DEST_FLAGS_REMOVED
) && !dest
->instance
&& !strcasecmp(data
->name
, dest
->name
))
4320 * Copy destination and stop enumeration...
4323 cupsCopyDest(dest
, 0, &data
->dest
);
4332 * 'cups_queue_name()' - Create a local queue name based on the service name.
4337 char *name
, /* I - Name buffer */
4338 const char *serviceName
, /* I - Service name */
4339 size_t namesize
) /* I - Size of name buffer */
4341 const char *ptr
; /* Pointer into serviceName */
4342 char *nameptr
; /* Pointer into name */
4345 for (nameptr
= name
, ptr
= serviceName
; *ptr
&& nameptr
< (name
+ namesize
- 1); ptr
++)
4348 * Sanitize the printer name...
4351 if (_cups_isalnum(*ptr
))
4353 else if (nameptr
== name
|| nameptr
[-1] != '_')