]> git.ipfire.org Git - thirdparty/cups.git/blob - cups/dest.c
projects / thirdparty / cups.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Fix crashes on Linux (Issue #5022)
[thirdparty/cups.git] / cups / dest.c
1 /*
2 * User-defined destination (and option) support for CUPS.
3 *
4 * Copyright 2007-2017 by Apple Inc.
5 * Copyright 1997-2007 by Easy Software Products.
6 *
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/".
12 *
13 * This file is subject to the Apple OS-Developed Software exception.
14 */
15
16 /*
17 * Include necessary headers...
18 */
19
20 #include "cups-private.h"
21 #include <sys/stat.h>
22
23 #ifdef HAVE_NOTIFY_H
24 # include <notify.h>
25 #endif /* HAVE_NOTIFY_H */
26
27 #ifdef HAVE_POLL
28 # include <poll.h>
29 #endif /* HAVE_POLL */
30
31 #ifdef HAVE_DNSSD
32 # include <dns_sd.h>
33 #endif /* HAVE_DNSSD */
34
35 #ifdef HAVE_AVAHI
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 */
44
45
46 /*
47 * Constants...
48 */
49
50 #ifdef __APPLE__
51 # if !TARGET_OS_IOS
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__ */
62
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 */
66
67
68 /*
69 * Types...
70 */
71
72 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
73 typedef enum _cups_dnssd_state_e /* Enumerated device state */
74 {
75 _CUPS_DNSSD_NEW,
76 _CUPS_DNSSD_QUERY,
77 _CUPS_DNSSD_PENDING,
78 _CUPS_DNSSD_ACTIVE,
79 _CUPS_DNSSD_LOCAL,
80 _CUPS_DNSSD_INCOMPATIBLE,
81 _CUPS_DNSSD_ERROR
82 } _cups_dnssd_state_t;
83
84 typedef struct _cups_dnssd_data_s /* Enumeration data */
85 {
86 # ifdef HAVE_DNSSD
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 */
99 } _cups_dnssd_data_t;
100
101 typedef struct _cups_dnssd_device_s /* Enumerated device */
102 {
103 _cups_dnssd_state_t state; /* State of device listing */
104 # ifdef HAVE_DNSSD
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;
115
116 typedef struct _cups_dnssd_resolve_s /* Data for resolving URI */
117 {
118 int *cancel; /* Pointer to "cancel" variable */
119 struct timeval end_time; /* Ending time */
120 } _cups_dnssd_resolve_t;
121 #endif /* HAVE_DNSSD */
122
123 typedef struct _cups_getdata_s
124 {
125 int num_dests; /* Number of destinations */
126 cups_dest_t *dests; /* Destinations */
127 } _cups_getdata_t;
128
129 typedef struct _cups_namedata_s
130 {
131 const char *name; /* Named destination */
132 cups_dest_t *dest; /* Destination */
133 } _cups_namedata_t;
134
135
136 /*
137 * Local functions...
138 */
139
140 #if _CUPS_LOCATION_DEFAULTS
141 static CFArrayRef appleCopyLocations(void);
142 static CFStringRef appleCopyNetwork(void);
143 #endif /* _CUPS_LOCATION_DEFAULTS */
144 #ifdef __APPLE__
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);
153 #ifdef __BLOCKS__
154 static int cups_block_cb(cups_dest_block_t block, unsigned flags,
155 cups_dest_t *dest);
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)
159 # ifdef HAVE_DNSSD
160 static void cups_dnssd_browse_cb(DNSServiceRef sdRef,
161 DNSServiceFlags flags,
162 uint32_t interfaceIndex,
163 DNSServiceErrorType errorCode,
164 const char *serviceName,
165 const char *regtype,
166 const char *replyDomain,
167 void *context);
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,
174 const char *regtype,
175 const char *replyDomain,
176 AvahiLookupResultFlags flags,
177 void *context);
178 static void cups_dnssd_client_cb(AvahiClient *client,
179 AvahiClientState state,
180 void *context);
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,
189 const char *regtype,
190 const char *replyDomain);
191 # ifdef HAVE_DNSSD
192 static void cups_dnssd_local_cb(DNSServiceRef sdRef,
193 DNSServiceFlags flags,
194 uint32_t interfaceIndex,
195 DNSServiceErrorType errorCode,
196 const char *serviceName,
197 const char *regtype,
198 const char *replyDomain,
199 void *context);
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,
218 size_t rdlen,
219 AvahiLookupResultFlags flags,
220 void *context);
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,
227 size_t dstsize);
228 static int cups_elapsed(struct timeval *t);
229 #endif /* HAVE_DNSSD || HAVE_AVAHI */
230 static int cups_find_dest(const char *name, const char *instance,
231 int num_dests, cups_dest_t *dests, int prev,
232 int *rdiff);
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,
240 size_t bufsize);
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);
243
244
245 /*
246 * 'cupsAddDest()' - Add a destination to the list of destinations.
247 *
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.
251 *
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.
255 *
256 * Use the @link cupsSaveDests@ function to save the updated list of
257 * destinations to the user's lpoptions file.
258 */
259
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 */
265 {
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 */
271
272
273 if (!name || !dests)
274 return (0);
275
276 if (!cupsGetDest(name, instance, num_dests, *dests))
277 {
278 if (instance && !cupsGetDest(name, NULL, num_dests, *dests))
279 return (num_dests);
280
281 if ((dest = cups_add_dest(name, instance, &num_dests, dests)) == NULL)
282 return (num_dests);
283
284 /*
285 * Find the base dest again now the array has been realloc'd.
286 */
287
288 parent = cupsGetDest(name, NULL, num_dests, *dests);
289
290 if (instance && parent && parent->num_options > 0)
291 {
292 /*
293 * Copy options from parent...
294 */
295
296 dest->options = calloc(sizeof(cups_option_t), (size_t)parent->num_options);
297
298 if (dest->options)
299 {
300 dest->num_options = parent->num_options;
301
302 for (i = dest->num_options, doption = dest->options,
303 poption = parent->options;
304 i > 0;
305 i --, doption ++, poption ++)
306 {
307 doption->name = _cupsStrRetain(poption->name);
308 doption->value = _cupsStrRetain(poption->value);
309 }
310 }
311 }
312 }
313
314 return (num_dests);
315 }
316
317
318 #ifdef __APPLE__
319 /*
320 * '_cupsAppleCopyDefaultPaperID()' - Get the default paper ID.
321 */
322
323 CFStringRef /* O - Default paper ID */
324 _cupsAppleCopyDefaultPaperID(void)
325 {
326 return (CFPreferencesCopyAppValue(kDefaultPaperIDKey,
327 kCUPSPrintingPrefs));
328 }
329
330
331 /*
332 * '_cupsAppleCopyDefaultPrinter()' - Get the default printer at this location.
333 */
334
335 CFStringRef /* O - Default printer name */
336 _cupsAppleCopyDefaultPrinter(void)
337 {
338 # if _CUPS_LOCATION_DEFAULTS
339 CFStringRef network; /* Network location */
340 CFArrayRef locations; /* Location array */
341 CFStringRef locprinter; /* Current printer */
342
343
344 /*
345 * Use location-based defaults only if "use last printer" is selected in the
346 * system preferences...
347 */
348
349 if (!_cupsAppleGetUseLastPrinter())
350 {
351 DEBUG_puts("1_cupsAppleCopyDefaultPrinter: Not using last printer as "
352 "default.");
353 return (NULL);
354 }
355
356 /*
357 * Get the current location...
358 */
359
360 if ((network = appleCopyNetwork()) == NULL)
361 {
362 DEBUG_puts("1_cupsAppleCopyDefaultPrinter: Unable to get current "
363 "network.");
364 return (NULL);
365 }
366
367 /*
368 * Lookup the network in the preferences...
369 */
370
371 if ((locations = appleCopyLocations()) == NULL)
372 {
373 /*
374 * Missing or bad location array, so no location-based default...
375 */
376
377 DEBUG_puts("1_cupsAppleCopyDefaultPrinter: Missing or bad last used "
378 "printer array.");
379
380 CFRelease(network);
381
382 return (NULL);
383 }
384
385 DEBUG_printf(("1_cupsAppleCopyDefaultPrinter: Got locations, %d entries.",
386 (int)CFArrayGetCount(locations)));
387
388 if ((locprinter = appleGetPrinter(locations, network, NULL)) != NULL)
389 CFRetain(locprinter);
390
391 CFRelease(network);
392 CFRelease(locations);
393
394 return (locprinter);
395
396 # else
397 return (NULL);
398 # endif /* _CUPS_LOCATION_DEFAULTS */
399 }
400
401
402 /*
403 * '_cupsAppleGetUseLastPrinter()' - Get whether to use the last used printer.
404 */
405
406 int /* O - 1 to use last printer, 0 otherwise */
407 _cupsAppleGetUseLastPrinter(void)
408 {
409 Boolean uselast, /* Use last printer preference value */
410 uselast_set; /* Valid is set? */
411
412
413 if (getenv("CUPS_DISABLE_APPLE_DEFAULT"))
414 return (0);
415
416 uselast = CFPreferencesGetAppBooleanValue(kUseLastPrinter,
417 kCUPSPrintingPrefs,
418 &uselast_set);
419 if (!uselast_set)
420 return (1);
421 else
422 return (uselast);
423 }
424
425
426 /*
427 * '_cupsAppleSetDefaultPaperID()' - Set the default paper id.
428 */
429
430 void
431 _cupsAppleSetDefaultPaperID(
432 CFStringRef name) /* I - New paper ID */
433 {
434 CFPreferencesSetAppValue(kDefaultPaperIDKey, name, kCUPSPrintingPrefs);
435 CFPreferencesAppSynchronize(kCUPSPrintingPrefs);
436
437 # ifdef HAVE_NOTIFY_POST
438 notify_post("com.apple.printerPrefsChange");
439 # endif /* HAVE_NOTIFY_POST */
440 }
441
442
443 /*
444 * '_cupsAppleSetDefaultPrinter()' - Set the default printer for this location.
445 */
446
447 void
448 _cupsAppleSetDefaultPrinter(
449 CFStringRef name) /* I - Default printer/class name */
450 {
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 */
458
459
460 /*
461 * Get the current location...
462 */
463
464 if ((network = appleCopyNetwork()) == NULL)
465 {
466 DEBUG_puts("1_cupsAppleSetDefaultPrinter: Unable to get current network...");
467 return;
468 }
469
470 /*
471 * Lookup the network in the preferences...
472 */
473
474 if ((locations = appleCopyLocations()) != NULL)
475 locprinter = appleGetPrinter(locations, network, &locindex);
476 else
477 {
478 locprinter = NULL;
479 locindex = -1;
480 }
481
482 if (!locprinter || CFStringCompare(locprinter, name, 0) != kCFCompareEqualTo)
483 {
484 /*
485 * Need to change the locations array...
486 */
487
488 if (locations)
489 {
490 newlocations = CFArrayCreateMutableCopy(kCFAllocatorDefault, 0,
491 locations);
492
493 if (locprinter)
494 CFArrayRemoveValueAtIndex(newlocations, locindex);
495 }
496 else
497 newlocations = CFArrayCreateMutable(kCFAllocatorDefault, 0,
498 &kCFTypeArrayCallBacks);
499
500 newlocation = CFDictionaryCreateMutable(kCFAllocatorDefault, 0,
501 &kCFTypeDictionaryKeyCallBacks,
502 &kCFTypeDictionaryValueCallBacks);
503
504 if (newlocation && newlocations)
505 {
506 /*
507 * Put the new location at the front of the array...
508 */
509
510 CFDictionaryAddValue(newlocation, kLocationNetworkKey, network);
511 CFDictionaryAddValue(newlocation, kLocationPrinterIDKey, name);
512 CFArrayInsertValueAtIndex(newlocations, 0, newlocation);
513
514 /*
515 * Limit the number of locations to 10...
516 */
517
518 while (CFArrayGetCount(newlocations) > 10)
519 CFArrayRemoveValueAtIndex(newlocations, 10);
520
521 /*
522 * Push the changes out...
523 */
524
525 CFPreferencesSetAppValue(kLastUsedPrintersKey, newlocations,
526 kCUPSPrintingPrefs);
527 CFPreferencesAppSynchronize(kCUPSPrintingPrefs);
528
529 # ifdef HAVE_NOTIFY_POST
530 notify_post("com.apple.printerPrefsChange");
531 # endif /* HAVE_NOTIFY_POST */
532 }
533
534 if (newlocations)
535 CFRelease(newlocations);
536
537 if (newlocation)
538 CFRelease(newlocation);
539 }
540
541 if (locations)
542 CFRelease(locations);
543
544 CFRelease(network);
545
546 # else
547 (void)name;
548 # endif /* _CUPS_LOCATION_DEFAULTS */
549 }
550
551
552 /*
553 * '_cupsAppleSetUseLastPrinter()' - Set whether to use the last used printer.
554 */
555
556 void
557 _cupsAppleSetUseLastPrinter(
558 int uselast) /* O - 1 to use last printer, 0 otherwise */
559 {
560 CFPreferencesSetAppValue(kUseLastPrinter,
561 uselast ? kCFBooleanTrue : kCFBooleanFalse,
562 kCUPSPrintingPrefs);
563 CFPreferencesAppSynchronize(kCUPSPrintingPrefs);
564
565 # ifdef HAVE_NOTIFY_POST
566 notify_post("com.apple.printerPrefsChange");
567 # endif /* HAVE_NOTIFY_POST */
568 }
569 #endif /* __APPLE__ */
570
571
572 /*
573 * 'cupsConnectDest()' - Open a conection to the destination.
574 *
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.
581 *
582 * @since CUPS 1.6/macOS 10.8@
583 */
584
585 http_t * /* O - Connection to destination or @code NULL@ */
586 cupsConnectDest(
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 */
595 {
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 */
606
607
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));
609
610 /*
611 * Range check input...
612 */
613
614 if (!dest)
615 {
616 if (resource)
617 *resource = '\0';
618
619 _cupsSetError(IPP_STATUS_ERROR_INTERNAL, strerror(EINVAL), 0);
620 return (NULL);
621 }
622
623 if (!resource || resourcesize < 1)
624 {
625 resource = tempresource;
626 resourcesize = sizeof(tempresource);
627 }
628
629 /*
630 * Grab the printer URI...
631 */
632
633 if ((uri = cupsGetOption("printer-uri-supported", dest->num_options, dest->options)) == NULL)
634 {
635 if ((uri = cupsGetOption("resolved-device-uri", dest->num_options, dest->options)) == NULL)
636 {
637 if ((uri = cupsGetOption("device-uri", dest->num_options, dest->options)) != NULL)
638 {
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 */
643 }
644 }
645
646 if (uri)
647 uri = _cupsCreateDest(dest->name, cupsGetOption("printer-info", dest->num_options, dest->options), NULL, uri, tempresource, sizeof(tempresource));
648
649 if (uri)
650 {
651 dest->num_options = cupsAddOption("printer-uri-supported", uri, dest->num_options, &dest->options);
652
653 uri = cupsGetOption("printer-uri-supported", dest->num_options, dest->options);
654 }
655 }
656
657 if (!uri)
658 {
659 _cupsSetError(IPP_STATUS_ERROR_INTERNAL, strerror(ENOENT), 0);
660
661 if (cb)
662 (*cb)(user_data, CUPS_DEST_FLAGS_UNCONNECTED | CUPS_DEST_FLAGS_ERROR, dest);
663
664 return (NULL);
665 }
666
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)
670 {
671 _cupsSetError(IPP_STATUS_ERROR_INTERNAL, _("Bad printer-uri."), 1);
672
673 if (cb)
674 (*cb)(user_data, CUPS_DEST_FLAGS_UNCONNECTED | CUPS_DEST_FLAGS_ERROR,
675 dest);
676
677 return (NULL);
678 }
679
680 /*
681 * Lookup the address for the server...
682 */
683
684 if (cb)
685 (*cb)(user_data, CUPS_DEST_FLAGS_UNCONNECTED | CUPS_DEST_FLAGS_RESOLVING, dest);
686
687 snprintf(portstr, sizeof(portstr), "%d", port);
688
689 if ((addrlist = httpAddrGetList(hostname, AF_UNSPEC, portstr)) == NULL)
690 {
691 if (cb)
692 (*cb)(user_data, CUPS_DEST_FLAGS_UNCONNECTED | CUPS_DEST_FLAGS_ERROR, dest);
693
694 return (NULL);
695 }
696
697 if (cancel && *cancel)
698 {
699 httpAddrFreeList(addrlist);
700
701 if (cb)
702 (*cb)(user_data, CUPS_DEST_FLAGS_UNCONNECTED | CUPS_DEST_FLAGS_CANCELED, dest);
703
704 return (NULL);
705 }
706
707 /*
708 * Create the HTTP object pointing to the server referenced by the URI...
709 */
710
711 if (!strcmp(scheme, "ipps") || port == 443)
712 encryption = HTTP_ENCRYPTION_ALWAYS;
713 else
714 encryption = HTTP_ENCRYPTION_IF_REQUESTED;
715
716 http = httpConnect2(hostname, port, addrlist, AF_UNSPEC, encryption, 1, 0, NULL);
717 httpAddrFreeList(addrlist);
718
719 /*
720 * Connect if requested...
721 */
722
723 if (flags & CUPS_DEST_FLAGS_UNCONNECTED)
724 {
725 if (cb)
726 (*cb)(user_data, CUPS_DEST_FLAGS_UNCONNECTED, dest);
727 }
728 else
729 {
730 if (cb)
731 (*cb)(user_data, CUPS_DEST_FLAGS_UNCONNECTED | CUPS_DEST_FLAGS_CONNECTING, dest);
732
733 if (!httpReconnect2(http, msec, cancel) && cb)
734 {
735 if (cancel && *cancel)
736 (*cb)(user_data, CUPS_DEST_FLAGS_UNCONNECTED | CUPS_DEST_FLAGS_CONNECTING, dest);
737 else
738 (*cb)(user_data, CUPS_DEST_FLAGS_UNCONNECTED | CUPS_DEST_FLAGS_ERROR, dest);
739 }
740 else if (cb)
741 (*cb)(user_data, CUPS_DEST_FLAGS_NONE, dest);
742 }
743
744 return (http);
745 }
746
747
748 #ifdef __BLOCKS__
749 /*
750 * 'cupsConnectDestBlock()' - Open a connection to the destination.
751 *
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.
757 *
758 * @since CUPS 1.6/macOS 10.8@ @exclude all@
759 */
760
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 */
770 {
771 return (cupsConnectDest(dest, flags, msec, cancel, resource, resourcesize,
772 (cups_dest_cb_t)cups_block_cb, (void *)block));
773 }
774 #endif /* __BLOCKS__ */
775
776
777 /*
778 * 'cupsCopyDest()' - Copy a destination.
779 *
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).
783 *
784 * @since CUPS 1.6/macOS 10.8@
785 */
786
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 */
791 {
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 */
796
797
798 /*
799 * Range check input...
800 */
801
802 if (!dest || num_dests < 0 || !dests)
803 return (num_dests);
804
805 /*
806 * See if the destination already exists...
807 */
808
809 if ((new_dest = cupsGetDest(dest->name, dest->instance, num_dests,
810 *dests)) != NULL)
811 {
812 /*
813 * Protect against copying destination to itself...
814 */
815
816 if (new_dest == dest)
817 return (num_dests);
818
819 /*
820 * Otherwise, free the options...
821 */
822
823 cupsFreeOptions(new_dest->num_options, new_dest->options);
824
825 new_dest->num_options = 0;
826 new_dest->options = NULL;
827 }
828 else
829 new_dest = cups_add_dest(dest->name, dest->instance, &num_dests, dests);
830
831 if (new_dest)
832 {
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));
835
836 new_dest->num_options = dest->num_options;
837
838 for (i = dest->num_options, option = dest->options,
839 new_option = new_dest->options;
840 i > 0;
841 i --, option ++, new_option ++)
842 {
843 new_option->name = _cupsStrRetain(option->name);
844 new_option->value = _cupsStrRetain(option->value);
845 }
846 }
847
848 return (num_dests);
849 }
850
851
852 /*
853 * '_cupsCreateDest()' - Create a local (temporary) queue.
854 */
855
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 */
863 {
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 */
870
871
872 if (!name || !device_uri || !uri || urisize < 32)
873 return (NULL);
874
875 if ((http = httpConnect2(cupsServer(), ippPort(), NULL, AF_UNSPEC, HTTP_ENCRYPTION_IF_REQUESTED, 1, 30000, NULL)) == NULL)
876 return (NULL);
877
878 request = ippNewRequest(IPP_OP_CUPS_CREATE_LOCAL_PRINTER);
879
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());
882
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);
885 if (info)
886 ippAddString(request, IPP_TAG_PRINTER, IPP_TAG_TEXT, "printer-info", NULL, info);
887 if (device_id)
888 ippAddString(request, IPP_TAG_PRINTER, IPP_TAG_TEXT, "printer-device-id", NULL, device_id);
889
890 response = cupsDoRequest(http, request, "/");
891
892 if ((attr = ippFindAttribute(response, "printer-uri-supported", IPP_TAG_URI)) != NULL)
893 strlcpy(uri, ippGetString(attr, 0, NULL), urisize);
894 else
895 {
896 ippDelete(response);
897 httpClose(http);
898 return (NULL);
899 }
900
901 if ((attr = ippFindAttribute(response, "printer-state", IPP_TAG_ENUM)) != NULL)
902 state = (ipp_pstate_t)ippGetInteger(attr, 0);
903
904 while (state == IPP_PSTATE_STOPPED && cupsLastError() == IPP_STATUS_OK)
905 {
906 sleep(1);
907 ippDelete(response);
908
909 request = ippNewRequest(IPP_OP_GET_PRINTER_ATTRIBUTES);
910
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");
914
915 response = cupsDoRequest(http, request, "/");
916
917 if ((attr = ippFindAttribute(response, "printer-state", IPP_TAG_ENUM)) != NULL)
918 state = (ipp_pstate_t)ippGetInteger(attr, 0);
919 }
920
921 ippDelete(response);
922
923 httpClose(http);
924
925 return (uri);
926 }
927
928
929 /*
930 * 'cupsEnumDests()' - Enumerate available destinations with a callback function.
931 *
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.
936 *
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.
941 *
942 * Enumeration happens on the current thread and does not return until all
943 * destinations have been enumerated or the callback function returns 0.
944 *
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.
947 *
948 * @since CUPS 1.6/macOS 10.8@
949 */
950
951 int /* O - 1 on success, 0 on failure */
952 cupsEnumDests(
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 */
960 {
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 */
976 # ifdef HAVE_DNSSD
977 int nfds, /* Number of files responded */
978 main_fd; /* File descriptor for lookups */
979 DNSServiceRef ipp_ref = NULL, /* IPP browser */
980 local_ipp_ref = NULL; /* Local IPP browser */
981 # ifdef HAVE_SSL
982 DNSServiceRef ipps_ref = NULL,/* IPPS browser */
983 local_ipps_ref = NULL; /* Local IPPS browser */
984 # endif /* HAVE_SSL */
985 # ifdef HAVE_POLL
986 struct pollfd pfd; /* Polling data */
987 # else
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 = NULL;/* IPP browser */
994 # ifdef HAVE_SSL
995 AvahiServiceBrowser *ipps_ref = NULL; /* IPPS browser */
996 # endif /* HAVE_SSL */
997 # endif /* HAVE_DNSSD */
998 #endif /* HAVE_DNSSD || HAVE_AVAHI */
999
1000
1001 /*
1002 * Range check input...
1003 */
1004
1005 (void)flags;
1006
1007 if (!cb)
1008 return (0);
1009
1010 /*
1011 * Get ready to enumerate...
1012 */
1013
1014 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
1015 memset(&data, 0, sizeof(data));
1016
1017 data.type = type;
1018 data.mask = mask;
1019 data.cb = cb;
1020 data.user_data = user_data;
1021 data.devices = cupsArrayNew3((cups_array_func_t)cups_dnssd_compare_devices, NULL, NULL, 0, NULL, (cups_afree_func_t)cups_dnssd_free_device);
1022 #endif /* HAVE_DNSSD || HAVE_AVAHI */
1023
1024 if (!(mask & CUPS_PRINTER_DISCOVERED) || !(type & CUPS_PRINTER_DISCOVERED))
1025 {
1026 /*
1027 * Get the list of local printers and pass them to the callback function...
1028 */
1029
1030 num_dests = _cupsGetDests(CUPS_HTTP_DEFAULT, IPP_OP_CUPS_GET_PRINTERS, NULL,
1031 &dests, type, mask);
1032
1033 if ((user_default = _cupsUserDefault(name, sizeof(name))) != NULL)
1034 defprinter = name;
1035 else if ((defprinter = cupsGetDefault2(CUPS_HTTP_DEFAULT)) != NULL)
1036 {
1037 strlcpy(name, defprinter, sizeof(name));
1038 defprinter = name;
1039 }
1040
1041 if (defprinter)
1042 {
1043 /*
1044 * Separate printer and instance name...
1045 */
1046
1047 if ((instance = strchr(name, '/')) != NULL)
1048 *instance++ = '\0';
1049
1050 /*
1051 * Lookup the printer and instance and make it the default...
1052 */
1053
1054 if ((dest = cupsGetDest(name, instance, num_dests, dests)) != NULL)
1055 dest->is_default = 1;
1056 }
1057
1058 for (i = num_dests, dest = dests;
1059 i > 0 && (!cancel || !*cancel);
1060 i --, dest ++)
1061 {
1062 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
1063 const char *device_uri; /* Device URI */
1064 #endif /* HAVE_DNSSD || HAVE_AVAHI */
1065
1066 if (!(*cb)(user_data, i > 1 ? CUPS_DEST_FLAGS_MORE : CUPS_DEST_FLAGS_NONE,
1067 dest))
1068 break;
1069
1070 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
1071 if (!dest->instance && (device_uri = cupsGetOption("device-uri", dest->num_options, dest->options)) != NULL && !strncmp(device_uri, "dnssd://", 8))
1072 {
1073 /*
1074 * Add existing queue using service name, etc. so we don't list it again...
1075 */
1076
1077 char scheme[32], /* URI scheme */
1078 userpass[32], /* Username:password */
1079 serviceName[256], /* Service name (host field) */
1080 resource[256], /* Resource (options) */
1081 *regtype, /* Registration type */
1082 *replyDomain; /* Registration domain */
1083 int port; /* Port number (not used) */
1084
1085 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)
1086 {
1087 if ((regtype = strstr(serviceName, "._ipp")) != NULL)
1088 {
1089 *regtype++ = '\0';
1090
1091 if ((replyDomain = strstr(regtype, "._tcp.")) != NULL)
1092 {
1093 replyDomain[5] = '\0';
1094 replyDomain += 6;
1095
1096 if ((device = cups_dnssd_get_device(&data, serviceName, regtype, replyDomain)) != NULL)
1097 device->state = _CUPS_DNSSD_ACTIVE;
1098 }
1099 }
1100 }
1101 }
1102 #endif /* HAVE_DNSSD || HAVE_AVAHI */
1103 }
1104
1105 cupsFreeDests(num_dests, dests);
1106
1107 if (i > 0 || msec == 0)
1108 goto enum_finished;
1109 }
1110
1111 /*
1112 * Return early if the caller doesn't want to do discovery...
1113 */
1114
1115 if ((mask & CUPS_PRINTER_DISCOVERED) && !(type & CUPS_PRINTER_DISCOVERED))
1116 goto enum_finished;
1117
1118 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
1119 /*
1120 * Get Bonjour-shared printers...
1121 */
1122
1123 gettimeofday(&curtime, NULL);
1124
1125 # ifdef HAVE_DNSSD
1126 if (DNSServiceCreateConnection(&data.main_ref) != kDNSServiceErr_NoError)
1127 return (0);
1128
1129 main_fd = DNSServiceRefSockFD(data.main_ref);
1130
1131 ipp_ref = data.main_ref;
1132 DNSServiceBrowse(&ipp_ref, kDNSServiceFlagsShareConnection, 0,
1133 "_ipp._tcp", NULL,
1134 (DNSServiceBrowseReply)cups_dnssd_browse_cb, &data);
1135
1136 local_ipp_ref = data.main_ref;
1137 DNSServiceBrowse(&local_ipp_ref, kDNSServiceFlagsShareConnection,
1138 kDNSServiceInterfaceIndexLocalOnly,
1139 "_ipp._tcp", NULL,
1140 (DNSServiceBrowseReply)cups_dnssd_local_cb, &data);
1141
1142 # ifdef HAVE_SSL
1143 ipps_ref = data.main_ref;
1144 DNSServiceBrowse(&ipps_ref, kDNSServiceFlagsShareConnection, 0,
1145 "_ipps._tcp", NULL,
1146 (DNSServiceBrowseReply)cups_dnssd_browse_cb, &data);
1147
1148 local_ipps_ref = data.main_ref;
1149 DNSServiceBrowse(&local_ipps_ref, kDNSServiceFlagsShareConnection,
1150 kDNSServiceInterfaceIndexLocalOnly,
1151 "_ipps._tcp", NULL,
1152 (DNSServiceBrowseReply)cups_dnssd_local_cb, &data);
1153 # endif /* HAVE_SSL */
1154
1155 # else /* HAVE_AVAHI */
1156 if ((data.simple_poll = avahi_simple_poll_new()) == NULL)
1157 {
1158 DEBUG_puts("cupsEnumDests: Unable to create Avahi simple poll object.");
1159 return (1);
1160 }
1161
1162 avahi_simple_poll_set_func(data.simple_poll, cups_dnssd_poll_cb, &data);
1163
1164 data.client = avahi_client_new(avahi_simple_poll_get(data.simple_poll),
1165 0, cups_dnssd_client_cb, &data,
1166 &error);
1167 if (!data.client)
1168 {
1169 DEBUG_puts("cupsEnumDests: Unable to create Avahi client.");
1170 avahi_simple_poll_free(data.simple_poll);
1171 return (1);
1172 }
1173
1174 data.browsers = 1;
1175 ipp_ref = avahi_service_browser_new(data.client, AVAHI_IF_UNSPEC, AVAHI_PROTO_UNSPEC, "_ipp._tcp", NULL, 0, cups_dnssd_browse_cb, &data);
1176
1177 # ifdef HAVE_SSL
1178 data.browsers ++;
1179 ipps_ref = avahi_service_browser_new(data.client, AVAHI_IF_UNSPEC, AVAHI_PROTO_UNSPEC, "_ipps._tcp", NULL, 0, cups_dnssd_browse_cb, &data);
1180 # endif /* HAVE_SSL */
1181 # endif /* HAVE_DNSSD */
1182
1183 if (msec < 0)
1184 remaining = INT_MAX;
1185 else
1186 remaining = msec;
1187
1188 while (remaining > 0 && (!cancel || !*cancel))
1189 {
1190 /*
1191 * Check for input...
1192 */
1193
1194 DEBUG_printf(("1cupsEnumDests: remaining=%d", remaining));
1195
1196 cups_elapsed(&curtime);
1197
1198 # ifdef HAVE_DNSSD
1199 # ifdef HAVE_POLL
1200 pfd.fd = main_fd;
1201 pfd.events = POLLIN;
1202
1203 nfds = poll(&pfd, 1, remaining > _CUPS_DNSSD_MAXTIME ? _CUPS_DNSSD_MAXTIME : remaining);
1204
1205 # else
1206 FD_ZERO(&input);
1207 FD_SET(main_fd, &input);
1208
1209 timeout.tv_sec = 0;
1210 timeout.tv_usec = 1000 * (remaining > _CUPS_DNSSD_MAXTIME ? _CUPS_DNSSD_MAXTIME : remaining);
1211
1212 nfds = select(main_fd + 1, &input, NULL, NULL, &timeout);
1213 # endif /* HAVE_POLL */
1214
1215 if (nfds > 0)
1216 DNSServiceProcessResult(data.main_ref);
1217
1218 # else /* HAVE_AVAHI */
1219 data.got_data = 0;
1220
1221 if ((error = avahi_simple_poll_iterate(data.simple_poll, _CUPS_DNSSD_MAXTIME)) > 0)
1222 {
1223 /*
1224 * We've been told to exit the loop. Perhaps the connection to
1225 * Avahi failed.
1226 */
1227
1228 break;
1229 }
1230
1231 DEBUG_printf(("1cupsEnumDests: got_data=%d", data.got_data));
1232 # endif /* HAVE_DNSSD */
1233
1234 remaining -= cups_elapsed(&curtime);
1235
1236 for (device = (_cups_dnssd_device_t *)cupsArrayFirst(data.devices),
1237 count = 0, completed = 0;
1238 device;
1239 device = (_cups_dnssd_device_t *)cupsArrayNext(data.devices))
1240 {
1241 if (device->ref)
1242 count ++;
1243
1244 if (device->state == _CUPS_DNSSD_ACTIVE)
1245 completed ++;
1246
1247 if (!device->ref && device->state == _CUPS_DNSSD_NEW)
1248 {
1249 DEBUG_printf(("1cupsEnumDests: Querying '%s'.", device->fullName));
1250
1251 # ifdef HAVE_DNSSD
1252 device->ref = data.main_ref;
1253
1254 if (DNSServiceQueryRecord(&(device->ref),
1255 kDNSServiceFlagsShareConnection,
1256 0, device->fullName,
1257 kDNSServiceType_TXT,
1258 kDNSServiceClass_IN,
1259 (DNSServiceQueryRecordReply)cups_dnssd_query_cb,
1260 &data) == kDNSServiceErr_NoError)
1261 {
1262 count ++;
1263 }
1264 else
1265 {
1266 device->ref = 0;
1267 device->state = _CUPS_DNSSD_ERROR;
1268
1269 DEBUG_puts("1cupsEnumDests: Query failed.");
1270 }
1271
1272 # else /* HAVE_AVAHI */
1273 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)
1274 {
1275 DEBUG_printf(("1cupsEnumDests: Query ref=%p", device->ref));
1276 count ++;
1277 }
1278 else
1279 {
1280 device->state = _CUPS_DNSSD_ERROR;
1281
1282 DEBUG_printf(("1cupsEnumDests: Query failed: %s", avahi_strerror(avahi_client_errno(data.client))));
1283 }
1284 # endif /* HAVE_DNSSD */
1285 }
1286 else if (device->ref && device->state == _CUPS_DNSSD_PENDING)
1287 {
1288 completed ++;
1289
1290 DEBUG_printf(("1cupsEnumDests: Query for \"%s\" is complete.", device->fullName));
1291
1292 if ((device->type & mask) == type)
1293 {
1294 DEBUG_printf(("1cupsEnumDests: Add callback for \"%s\".", device->dest.name));
1295 if (!(*cb)(user_data, CUPS_DEST_FLAGS_NONE, &device->dest))
1296 {
1297 remaining = -1;
1298 break;
1299 }
1300 }
1301
1302 device->state = _CUPS_DNSSD_ACTIVE;
1303 }
1304 }
1305
1306 # ifdef HAVE_AVAHI
1307 DEBUG_printf(("1cupsEnumDests: remaining=%d, browsers=%d, completed=%d, count=%d, devices count=%d", remaining, data.browsers, completed, count, cupsArrayCount(data.devices)));
1308
1309 if (data.browsers == 0 && completed == cupsArrayCount(data.devices))
1310 break;
1311 # else
1312 DEBUG_printf(("1cupsEnumDests: remaining=%d, completed=%d, count=%d, devices count=%d", remaining, completed, count, cupsArrayCount(data.devices)));
1313
1314 if (completed == cupsArrayCount(data.devices))
1315 break;
1316 # endif /* HAVE_AVAHI */
1317 }
1318 #endif /* HAVE_DNSSD || HAVE_AVAHI */
1319
1320 /*
1321 * Return...
1322 */
1323
1324 enum_finished:
1325
1326 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
1327 cupsArrayDelete(data.devices);
1328
1329 # ifdef HAVE_DNSSD
1330 if (ipp_ref)
1331 DNSServiceRefDeallocate(ipp_ref);
1332 if (local_ipp_ref)
1333 DNSServiceRefDeallocate(local_ipp_ref);
1334
1335 # ifdef HAVE_SSL
1336 if (ipps_ref)
1337 DNSServiceRefDeallocate(ipps_ref);
1338 if (local_ipps_ref)
1339 DNSServiceRefDeallocate(local_ipps_ref);
1340 # endif /* HAVE_SSL */
1341
1342 if (data.main_ref)
1343 DNSServiceRefDeallocate(data.main_ref);
1344
1345 # else /* HAVE_AVAHI */
1346 if (ipp_ref)
1347 avahi_service_browser_free(ipp_ref);
1348 # ifdef HAVE_SSL
1349 if (ipps_ref)
1350 avahi_service_browser_free(ipps_ref);
1351 # endif /* HAVE_SSL */
1352
1353 if (data.client)
1354 avahi_client_free(data.client);
1355 if (data.simple_poll)
1356 avahi_simple_poll_free(data.simple_poll);
1357 # endif /* HAVE_DNSSD */
1358 #endif /* HAVE_DNSSD || HAVE_AVAHI */
1359
1360 return (1);
1361 }
1362
1363
1364 # ifdef __BLOCKS__
1365 /*
1366 * 'cupsEnumDestsBlock()' - Enumerate available destinations with a block.
1367 *
1368 * Destinations are enumerated from one or more sources. The block receives the
1369 * @code user_data@ pointer and the destination pointer which can be used as
1370 * input to the @link cupsCopyDest@ function. The block must return 1 to
1371 * continue enumeration or 0 to stop.
1372 *
1373 * The @code type@ and @code mask@ arguments allow the caller to filter the
1374 * destinations that are enumerated. Passing 0 for both will enumerate all
1375 * printers. The constant @code CUPS_PRINTER_DISCOVERED@ is used to filter on
1376 * destinations that are available but have not yet been added locally.
1377 *
1378 * Enumeration happens on the current thread and does not return until all
1379 * destinations have been enumerated or the block returns 0.
1380 *
1381 * Note: The block will likely receive multiple updates for the same
1382 * destinations - it is up to the caller to suppress any duplicate destinations.
1383 *
1384 * @since CUPS 1.6/macOS 10.8@ @exclude all@
1385 */
1386
1387 int /* O - 1 on success, 0 on failure */
1388 cupsEnumDestsBlock(
1389 unsigned flags, /* I - Enumeration flags */
1390 int timeout, /* I - Timeout in milliseconds, 0 for indefinite */
1391 int *cancel, /* I - Pointer to "cancel" variable */
1392 cups_ptype_t type, /* I - Printer type bits */
1393 cups_ptype_t mask, /* I - Mask for printer type bits */
1394 cups_dest_block_t block) /* I - Block */
1395 {
1396 return (cupsEnumDests(flags, timeout, cancel, type, mask,
1397 (cups_dest_cb_t)cups_block_cb, (void *)block));
1398 }
1399 # endif /* __BLOCKS__ */
1400
1401
1402 /*
1403 * 'cupsFreeDests()' - Free the memory used by the list of destinations.
1404 */
1405
1406 void
1407 cupsFreeDests(int num_dests, /* I - Number of destinations */
1408 cups_dest_t *dests) /* I - Destinations */
1409 {
1410 int i; /* Looping var */
1411 cups_dest_t *dest; /* Current destination */
1412
1413
1414 if (num_dests == 0 || dests == NULL)
1415 return;
1416
1417 for (i = num_dests, dest = dests; i > 0; i --, dest ++)
1418 {
1419 _cupsStrFree(dest->name);
1420 _cupsStrFree(dest->instance);
1421
1422 cupsFreeOptions(dest->num_options, dest->options);
1423 }
1424
1425 free(dests);
1426 }
1427
1428
1429 /*
1430 * 'cupsGetDest()' - Get the named destination from the list.
1431 *
1432 * Use the @link cupsEnumDests@ or @link cupsGetDests2@ functions to get a
1433 * list of supported destinations for the current user.
1434 */
1435
1436 cups_dest_t * /* O - Destination pointer or @code NULL@ */
1437 cupsGetDest(const char *name, /* I - Destination name or @code NULL@ for the default destination */
1438 const char *instance, /* I - Instance name or @code NULL@ */
1439 int num_dests, /* I - Number of destinations */
1440 cups_dest_t *dests) /* I - Destinations */
1441 {
1442 int diff, /* Result of comparison */
1443 match; /* Matching index */
1444
1445
1446 if (num_dests <= 0 || !dests)
1447 return (NULL);
1448
1449 if (!name)
1450 {
1451 /*
1452 * NULL name for default printer.
1453 */
1454
1455 while (num_dests > 0)
1456 {
1457 if (dests->is_default)
1458 return (dests);
1459
1460 num_dests --;
1461 dests ++;
1462 }
1463 }
1464 else
1465 {
1466 /*
1467 * Lookup name and optionally the instance...
1468 */
1469
1470 match = cups_find_dest(name, instance, num_dests, dests, -1, &diff);
1471
1472 if (!diff)
1473 return (dests + match);
1474 }
1475
1476 return (NULL);
1477 }
1478
1479
1480 /*
1481 * '_cupsGetDestResource()' - Get the resource path and URI for a destination.
1482 */
1483
1484 const char * /* O - Printer URI */
1485 _cupsGetDestResource(
1486 cups_dest_t *dest, /* I - Destination */
1487 char *resource, /* I - Resource buffer */
1488 size_t resourcesize) /* I - Size of resource buffer */
1489 {
1490 const char *uri; /* Printer URI */
1491 char scheme[32], /* URI scheme */
1492 userpass[256], /* Username and password (unused) */
1493 hostname[256]; /* Hostname */
1494 int port; /* Port number */
1495
1496
1497 DEBUG_printf(("_cupsGetDestResource(dest=%p(%s), resource=%p, resourcesize=%d)", (void *)dest, dest->name, (void *)resource, (int)resourcesize));
1498
1499 /*
1500 * Range check input...
1501 */
1502
1503 if (!dest || !resource || resourcesize < 1)
1504 {
1505 if (resource)
1506 *resource = '\0';
1507
1508 _cupsSetError(IPP_STATUS_ERROR_INTERNAL, strerror(EINVAL), 0);
1509 return (NULL);
1510 }
1511
1512 /*
1513 * Grab the printer URI...
1514 */
1515
1516 if ((uri = cupsGetOption("printer-uri-supported", dest->num_options, dest->options)) == NULL)
1517 {
1518 if ((uri = cupsGetOption("resolved-device-uri", dest->num_options, dest->options)) == NULL)
1519 {
1520 if ((uri = cupsGetOption("device-uri", dest->num_options, dest->options)) != NULL)
1521 {
1522 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
1523 if (strstr(uri, "._tcp"))
1524 uri = cups_dnssd_resolve(dest, uri, 5000, NULL, NULL, NULL);
1525 #endif /* HAVE_DNSSD || HAVE_AVAHI */
1526 }
1527 }
1528
1529 if (uri)
1530 {
1531 DEBUG_printf(("1_cupsGetDestResource: Resolved printer-uri-supported=\"%s\"", uri));
1532
1533 uri = _cupsCreateDest(dest->name, cupsGetOption("printer-info", dest->num_options, dest->options), NULL, uri, resource, resourcesize);
1534 }
1535
1536 if (uri)
1537 {
1538 DEBUG_printf(("1_cupsGetDestResource: Local printer-uri-supported=\"%s\"", uri));
1539
1540 dest->num_options = cupsAddOption("printer-uri-supported", uri, dest->num_options, &dest->options);
1541
1542 uri = cupsGetOption("printer-uri-supported", dest->num_options, dest->options);
1543 }
1544 else
1545 {
1546 DEBUG_puts("1_cupsGetDestResource: No printer-uri-supported found.");
1547
1548 if (resource)
1549 *resource = '\0';
1550
1551 _cupsSetError(IPP_STATUS_ERROR_INTERNAL, strerror(ENOENT), 0);
1552
1553 return (NULL);
1554 }
1555 }
1556 else
1557 {
1558 DEBUG_printf(("1_cupsGetDestResource: printer-uri-supported=\"%s\"", uri));
1559
1560 if (httpSeparateURI(HTTP_URI_CODING_ALL, uri, scheme, sizeof(scheme),
1561 userpass, sizeof(userpass), hostname, sizeof(hostname),
1562 &port, resource, (int)resourcesize) < HTTP_URI_STATUS_OK)
1563 {
1564 _cupsSetError(IPP_STATUS_ERROR_INTERNAL, _("Bad printer-uri."), 1);
1565
1566 return (NULL);
1567 }
1568 }
1569
1570 DEBUG_printf(("1_cupsGetDestResource: resource=\"%s\"", resource));
1571
1572 return (uri);
1573 }
1574
1575
1576 /*
1577 * 'cupsGetDestWithURI()' - Get a destination associated with a URI.
1578 *
1579 * "name" is the desired name for the printer. If @code NULL@, a name will be
1580 * created using the URI.
1581 *
1582 * "uri" is the "ipp" or "ipps" URI for the printer.
1583 *
1584 * @since CUPS 2.0/macOS 10.10@
1585 */
1586
1587 cups_dest_t * /* O - Destination or @code NULL@ */
1588 cupsGetDestWithURI(const char *name, /* I - Desired printer name or @code NULL@ */
1589 const char *uri) /* I - URI for the printer */
1590 {
1591 cups_dest_t *dest; /* New destination */
1592 char temp[1024], /* Temporary string */
1593 scheme[256], /* Scheme from URI */
1594 userpass[256], /* Username:password from URI */
1595 hostname[256], /* Hostname from URI */
1596 resource[1024], /* Resource path from URI */
1597 *ptr; /* Pointer into string */
1598 const char *info; /* printer-info string */
1599 int port; /* Port number from URI */
1600
1601
1602 /*
1603 * Range check input...
1604 */
1605
1606 if (!uri)
1607 {
1608 _cupsSetError(IPP_STATUS_ERROR_INTERNAL, strerror(EINVAL), 0);
1609 return (NULL);
1610 }
1611
1612 if (httpSeparateURI(HTTP_URI_CODING_ALL, uri, scheme, sizeof(scheme), userpass, sizeof(userpass), hostname, sizeof(hostname), &port, resource, sizeof(resource)) < HTTP_URI_STATUS_OK ||
1613 (strncmp(uri, "ipp://", 6) && strncmp(uri, "ipps://", 7)))
1614 {
1615 _cupsSetError(IPP_STATUS_ERROR_INTERNAL, _("Bad printer-uri."), 1);
1616
1617 return (NULL);
1618 }
1619
1620 if (name)
1621 {
1622 info = name;
1623 }
1624 else
1625 {
1626 /*
1627 * Create the name from the URI...
1628 */
1629
1630 if (strstr(hostname, "._tcp"))
1631 {
1632 /*
1633 * Use the service instance name...
1634 */
1635
1636 if ((ptr = strstr(hostname, "._")) != NULL)
1637 *ptr = '\0';
1638
1639 cups_queue_name(temp, hostname, sizeof(temp));
1640 name = temp;
1641 info = hostname;
1642 }
1643 else if (!strncmp(resource, "/classes/", 9))
1644 {
1645 snprintf(temp, sizeof(temp), "%s @ %s", resource + 9, hostname);
1646 name = resource + 9;
1647 info = temp;
1648 }
1649 else if (!strncmp(resource, "/printers/", 10))
1650 {
1651 snprintf(temp, sizeof(temp), "%s @ %s", resource + 10, hostname);
1652 name = resource + 10;
1653 info = temp;
1654 }
1655 else
1656 {
1657 name = hostname;
1658 info = hostname;
1659 }
1660 }
1661
1662 /*
1663 * Create the destination...
1664 */
1665
1666 if ((dest = calloc(1, sizeof(cups_dest_t))) == NULL)
1667 {
1668 _cupsSetError(IPP_STATUS_ERROR_INTERNAL, strerror(errno), 0);
1669 return (NULL);
1670 }
1671
1672 dest->name = _cupsStrAlloc(name);
1673 dest->num_options = cupsAddOption("device-uri", uri, dest->num_options, &(dest->options));
1674 dest->num_options = cupsAddOption("printer-info", info, dest->num_options, &(dest->options));
1675
1676 return (dest);
1677 }
1678
1679
1680 /*
1681 * '_cupsGetDests()' - Get destinations from a server.
1682 *
1683 * "op" is IPP_OP_CUPS_GET_PRINTERS to get a full list, IPP_OP_CUPS_GET_DEFAULT
1684 * to get the system-wide default printer, or IPP_OP_GET_PRINTER_ATTRIBUTES for
1685 * a known printer.
1686 *
1687 * "name" is the name of an existing printer and is only used when "op" is
1688 * IPP_OP_GET_PRINTER_ATTRIBUTES.
1689 *
1690 * "dest" is initialized to point to the array of destinations.
1691 *
1692 * 0 is returned if there are no printers, no default printer, or the named
1693 * printer does not exist, respectively.
1694 *
1695 * Free the memory used by the destination array using the @link cupsFreeDests@
1696 * function.
1697 *
1698 * Note: On macOS this function also gets the default paper from the system
1699 * preferences (~/L/P/org.cups.PrintingPrefs.plist) and includes it in the
1700 * options array for each destination that supports it.
1701 */
1702
1703 int /* O - Number of destinations */
1704 _cupsGetDests(http_t *http, /* I - Connection to server or
1705 * @code CUPS_HTTP_DEFAULT@ */
1706 ipp_op_t op, /* I - IPP operation */
1707 const char *name, /* I - Name of destination */
1708 cups_dest_t **dests, /* IO - Destinations */
1709 cups_ptype_t type, /* I - Printer type bits */
1710 cups_ptype_t mask) /* I - Printer type mask */
1711 {
1712 int num_dests = 0; /* Number of destinations */
1713 cups_dest_t *dest; /* Current destination */
1714 ipp_t *request, /* IPP Request */
1715 *response; /* IPP Response */
1716 ipp_attribute_t *attr; /* Current attribute */
1717 const char *printer_name; /* printer-name attribute */
1718 char uri[1024]; /* printer-uri value */
1719 int num_options; /* Number of options */
1720 cups_option_t *options; /* Options */
1721 #ifdef __APPLE__
1722 char media_default[41]; /* Default paper size */
1723 #endif /* __APPLE__ */
1724 char optname[1024], /* Option name */
1725 value[2048], /* Option value */
1726 *ptr; /* Pointer into name/value */
1727 static const char * const pattrs[] = /* Attributes we're interested in */
1728 {
1729 "auth-info-required",
1730 "device-uri",
1731 "job-sheets-default",
1732 "marker-change-time",
1733 "marker-colors",
1734 "marker-high-levels",
1735 "marker-levels",
1736 "marker-low-levels",
1737 "marker-message",
1738 "marker-names",
1739 "marker-types",
1740 #ifdef __APPLE__
1741 "media-supported",
1742 #endif /* __APPLE__ */
1743 "printer-commands",
1744 "printer-defaults",
1745 "printer-info",
1746 "printer-is-accepting-jobs",
1747 "printer-is-shared",
1748 "printer-location",
1749 "printer-make-and-model",
1750 "printer-mandatory-job-attributes",
1751 "printer-name",
1752 "printer-state",
1753 "printer-state-change-time",
1754 "printer-state-reasons",
1755 "printer-type",
1756 "printer-uri-supported"
1757 };
1758
1759
1760 DEBUG_printf(("_cupsGetDests(http=%p, op=%x(%s), name=\"%s\", dests=%p, type=%x, mask=%x)", (void *)http, op, ippOpString(op), name, (void *)dests, type, mask));
1761
1762 #ifdef __APPLE__
1763 /*
1764 * Get the default paper size...
1765 */
1766
1767 appleGetPaperSize(media_default, sizeof(media_default));
1768 #endif /* __APPLE__ */
1769
1770 /*
1771 * Build a IPP_OP_CUPS_GET_PRINTERS or IPP_OP_GET_PRINTER_ATTRIBUTES request, which
1772 * require the following attributes:
1773 *
1774 * attributes-charset
1775 * attributes-natural-language
1776 * requesting-user-name
1777 * printer-uri [for IPP_OP_GET_PRINTER_ATTRIBUTES]
1778 */
1779
1780 request = ippNewRequest(op);
1781
1782 ippAddStrings(request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD,
1783 "requested-attributes", sizeof(pattrs) / sizeof(pattrs[0]),
1784 NULL, pattrs);
1785
1786 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME,
1787 "requesting-user-name", NULL, cupsUser());
1788
1789 if (name && op != IPP_OP_CUPS_GET_DEFAULT)
1790 {
1791 httpAssembleURIf(HTTP_URI_CODING_ALL, uri, sizeof(uri), "ipp", NULL,
1792 "localhost", ippPort(), "/printers/%s", name);
1793 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri", NULL,
1794 uri);
1795 }
1796 else if (mask)
1797 {
1798 ippAddInteger(request, IPP_TAG_OPERATION, IPP_TAG_ENUM, "printer-type", (int)type);
1799 ippAddInteger(request, IPP_TAG_OPERATION, IPP_TAG_ENUM, "printer-type-mask", (int)mask);
1800 }
1801
1802 /*
1803 * Do the request and get back a response...
1804 */
1805
1806 if ((response = cupsDoRequest(http, request, "/")) != NULL)
1807 {
1808 for (attr = response->attrs; attr != NULL; attr = attr->next)
1809 {
1810 /*
1811 * Skip leading attributes until we hit a printer...
1812 */
1813
1814 while (attr != NULL && attr->group_tag != IPP_TAG_PRINTER)
1815 attr = attr->next;
1816
1817 if (attr == NULL)
1818 break;
1819
1820 /*
1821 * Pull the needed attributes from this printer...
1822 */
1823
1824 printer_name = NULL;
1825 num_options = 0;
1826 options = NULL;
1827
1828 for (; attr && attr->group_tag == IPP_TAG_PRINTER; attr = attr->next)
1829 {
1830 if (attr->value_tag != IPP_TAG_INTEGER &&
1831 attr->value_tag != IPP_TAG_ENUM &&
1832 attr->value_tag != IPP_TAG_BOOLEAN &&
1833 attr->value_tag != IPP_TAG_TEXT &&
1834 attr->value_tag != IPP_TAG_TEXTLANG &&
1835 attr->value_tag != IPP_TAG_NAME &&
1836 attr->value_tag != IPP_TAG_NAMELANG &&
1837 attr->value_tag != IPP_TAG_KEYWORD &&
1838 attr->value_tag != IPP_TAG_RANGE &&
1839 attr->value_tag != IPP_TAG_URI)
1840 continue;
1841
1842 if (!strcmp(attr->name, "auth-info-required") ||
1843 !strcmp(attr->name, "device-uri") ||
1844 !strcmp(attr->name, "marker-change-time") ||
1845 !strcmp(attr->name, "marker-colors") ||
1846 !strcmp(attr->name, "marker-high-levels") ||
1847 !strcmp(attr->name, "marker-levels") ||
1848 !strcmp(attr->name, "marker-low-levels") ||
1849 !strcmp(attr->name, "marker-message") ||
1850 !strcmp(attr->name, "marker-names") ||
1851 !strcmp(attr->name, "marker-types") ||
1852 !strcmp(attr->name, "printer-commands") ||
1853 !strcmp(attr->name, "printer-info") ||
1854 !strcmp(attr->name, "printer-is-shared") ||
1855 !strcmp(attr->name, "printer-make-and-model") ||
1856 !strcmp(attr->name, "printer-mandatory-job-attributes") ||
1857 !strcmp(attr->name, "printer-state") ||
1858 !strcmp(attr->name, "printer-state-change-time") ||
1859 !strcmp(attr->name, "printer-type") ||
1860 !strcmp(attr->name, "printer-is-accepting-jobs") ||
1861 !strcmp(attr->name, "printer-location") ||
1862 !strcmp(attr->name, "printer-state-reasons") ||
1863 !strcmp(attr->name, "printer-uri-supported"))
1864 {
1865 /*
1866 * Add a printer description attribute...
1867 */
1868
1869 num_options = cupsAddOption(attr->name,
1870 cups_make_string(attr, value,
1871 sizeof(value)),
1872 num_options, &options);
1873 }
1874 #ifdef __APPLE__
1875 else if (!strcmp(attr->name, "media-supported"))
1876 {
1877 /*
1878 * See if we can set a default media size...
1879 */
1880
1881 int i; /* Looping var */
1882
1883 for (i = 0; i < attr->num_values; i ++)
1884 if (!_cups_strcasecmp(media_default, attr->values[i].string.text))
1885 {
1886 num_options = cupsAddOption("media", media_default, num_options,
1887 &options);
1888 break;
1889 }
1890 }
1891 #endif /* __APPLE__ */
1892 else if (!strcmp(attr->name, "printer-name") &&
1893 attr->value_tag == IPP_TAG_NAME)
1894 printer_name = attr->values[0].string.text;
1895 else if (strncmp(attr->name, "notify-", 7) &&
1896 (attr->value_tag == IPP_TAG_BOOLEAN ||
1897 attr->value_tag == IPP_TAG_ENUM ||
1898 attr->value_tag == IPP_TAG_INTEGER ||
1899 attr->value_tag == IPP_TAG_KEYWORD ||
1900 attr->value_tag == IPP_TAG_NAME ||
1901 attr->value_tag == IPP_TAG_RANGE) &&
1902 (ptr = strstr(attr->name, "-default")) != NULL)
1903 {
1904 /*
1905 * Add a default option...
1906 */
1907
1908 strlcpy(optname, attr->name, sizeof(optname));
1909 optname[ptr - attr->name] = '\0';
1910
1911 if (_cups_strcasecmp(optname, "media") ||
1912 !cupsGetOption("media", num_options, options))
1913 num_options = cupsAddOption(optname,
1914 cups_make_string(attr, value,
1915 sizeof(value)),
1916 num_options, &options);
1917 }
1918 }
1919
1920 /*
1921 * See if we have everything needed...
1922 */
1923
1924 if (!printer_name)
1925 {
1926 cupsFreeOptions(num_options, options);
1927
1928 if (attr == NULL)
1929 break;
1930 else
1931 continue;
1932 }
1933
1934 if ((dest = cups_add_dest(printer_name, NULL, &num_dests, dests)) != NULL)
1935 {
1936 dest->num_options = num_options;
1937 dest->options = options;
1938 }
1939 else
1940 cupsFreeOptions(num_options, options);
1941
1942 if (attr == NULL)
1943 break;
1944 }
1945
1946 ippDelete(response);
1947 }
1948
1949 /*
1950 * Return the count...
1951 */
1952
1953 return (num_dests);
1954 }
1955
1956
1957 /*
1958 * 'cupsGetDests()' - Get the list of destinations from the default server.
1959 *
1960 * Starting with CUPS 1.2, the returned list of destinations include the
1961 * "printer-info", "printer-is-accepting-jobs", "printer-is-shared",
1962 * "printer-make-and-model", "printer-state", "printer-state-change-time",
1963 * "printer-state-reasons", "printer-type", and "printer-uri-supported"
1964 * attributes as options.
1965 *
1966 * CUPS 1.4 adds the "marker-change-time", "marker-colors",
1967 * "marker-high-levels", "marker-levels", "marker-low-levels", "marker-message",
1968 * "marker-names", "marker-types", and "printer-commands" attributes as options.
1969 *
1970 * CUPS 2.2 adds accessible IPP printers to the list of destinations that can
1971 * be used. The "printer-uri-supported" option will be present for those IPP
1972 * printers that have been recently used.
1973 *
1974 * Use the @link cupsFreeDests@ function to free the destination list and
1975 * the @link cupsGetDest@ function to find a particular destination.
1976 *
1977 * @exclude all@
1978 */
1979
1980 int /* O - Number of destinations */
1981 cupsGetDests(cups_dest_t **dests) /* O - Destinations */
1982 {
1983 return (cupsGetDests2(CUPS_HTTP_DEFAULT, dests));
1984 }
1985
1986
1987 /*
1988 * 'cupsGetDests2()' - Get the list of destinations from the specified server.
1989 *
1990 * Starting with CUPS 1.2, the returned list of destinations include the
1991 * "printer-info", "printer-is-accepting-jobs", "printer-is-shared",
1992 * "printer-make-and-model", "printer-state", "printer-state-change-time",
1993 * "printer-state-reasons", "printer-type", and "printer-uri-supported"
1994 * attributes as options.
1995 *
1996 * CUPS 1.4 adds the "marker-change-time", "marker-colors",
1997 * "marker-high-levels", "marker-levels", "marker-low-levels", "marker-message",
1998 * "marker-names", "marker-types", and "printer-commands" attributes as options.
1999 *
2000 * CUPS 2.2 adds accessible IPP printers to the list of destinations that can
2001 * be used. The "printer-uri-supported" option will be present for those IPP
2002 * printers that have been recently used.
2003 *
2004 * Use the @link cupsFreeDests@ function to free the destination list and
2005 * the @link cupsGetDest@ function to find a particular destination.
2006 *
2007 * @since CUPS 1.1.21/macOS 10.4@
2008 */
2009
2010 int /* O - Number of destinations */
2011 cupsGetDests2(http_t *http, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
2012 cups_dest_t **dests) /* O - Destinations */
2013 {
2014 _cups_getdata_t data; /* Enumeration data */
2015 cups_dest_t *dest; /* Current destination */
2016 const char *home; /* HOME environment variable */
2017 char filename[1024]; /* Local ~/.cups/lpoptions file */
2018 const char *defprinter; /* Default printer */
2019 char name[1024], /* Copy of printer name */
2020 *instance, /* Pointer to instance name */
2021 *user_default; /* User default printer */
2022 int num_reals; /* Number of real queues */
2023 cups_dest_t *reals; /* Real queues */
2024 _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
2025
2026
2027 /*
2028 * Range check the input...
2029 */
2030
2031 if (!dests)
2032 {
2033 _cupsSetError(IPP_STATUS_ERROR_INTERNAL, _("Bad NULL dests pointer"), 1);
2034 return (0);
2035 }
2036
2037 /*
2038 * Grab the printers and classes...
2039 */
2040
2041 data.num_dests = 0;
2042 data.dests = NULL;
2043
2044 cupsEnumDests(0, 1000, NULL, 0, 0, (cups_dest_cb_t)cups_get_cb, &data);
2045
2046 if (cupsLastError() >= IPP_STATUS_REDIRECTION_OTHER_SITE)
2047 {
2048 cupsFreeDests(data.num_dests, data.dests);
2049
2050 *dests = (cups_dest_t *)0;
2051
2052 return (0);
2053 }
2054
2055 /*
2056 * Make a copy of the "real" queues for a later sanity check...
2057 */
2058
2059 if (data.num_dests > 0)
2060 {
2061 num_reals = data.num_dests;
2062 reals = calloc((size_t)num_reals, sizeof(cups_dest_t));
2063
2064 if (reals)
2065 memcpy(reals, data.dests, (size_t)num_reals * sizeof(cups_dest_t));
2066 else
2067 num_reals = 0;
2068 }
2069 else
2070 {
2071 num_reals = 0;
2072 reals = NULL;
2073 }
2074
2075 /*
2076 * Grab the default destination...
2077 */
2078
2079 if ((user_default = _cupsUserDefault(name, sizeof(name))) != NULL)
2080 defprinter = name;
2081 else if ((defprinter = cupsGetDefault2(http)) != NULL)
2082 {
2083 strlcpy(name, defprinter, sizeof(name));
2084 defprinter = name;
2085 }
2086
2087 if (defprinter)
2088 {
2089 /*
2090 * Separate printer and instance name...
2091 */
2092
2093 if ((instance = strchr(name, '/')) != NULL)
2094 *instance++ = '\0';
2095
2096 /*
2097 * Lookup the printer and instance and make it the default...
2098 */
2099
2100 if ((dest = cupsGetDest(name, instance, data.num_dests, data.dests)) != NULL)
2101 dest->is_default = 1;
2102 }
2103 else
2104 instance = NULL;
2105
2106 /*
2107 * Load the /etc/cups/lpoptions and ~/.cups/lpoptions files...
2108 */
2109
2110 snprintf(filename, sizeof(filename), "%s/lpoptions", cg->cups_serverroot);
2111 data.num_dests = cups_get_dests(filename, NULL, NULL, user_default != NULL, data.num_dests, &data.dests);
2112
2113 if ((home = getenv("HOME")) != NULL)
2114 {
2115 snprintf(filename, sizeof(filename), "%s/.cups/lpoptions", home);
2116
2117 data.num_dests = cups_get_dests(filename, NULL, NULL, user_default != NULL, data.num_dests, &data.dests);
2118 }
2119
2120 /*
2121 * Validate the current default destination - this prevents old
2122 * Default lines in /etc/cups/lpoptions and ~/.cups/lpoptions from
2123 * pointing to a non-existent printer or class...
2124 */
2125
2126 if (num_reals)
2127 {
2128 /*
2129 * See if we have a default printer...
2130 */
2131
2132 if ((dest = cupsGetDest(NULL, NULL, data.num_dests, data.dests)) != NULL)
2133 {
2134 /*
2135 * Have a default; see if it is real...
2136 */
2137
2138 if (!cupsGetDest(dest->name, NULL, num_reals, reals))
2139 {
2140 /*
2141 * Remove the non-real printer from the list, since we don't want jobs
2142 * going to an unexpected printer... (<rdar://problem/14216472>)
2143 */
2144
2145 data.num_dests = cupsRemoveDest(dest->name, dest->instance, data.num_dests, &data.dests);
2146 }
2147 }
2148
2149 /*
2150 * Free memory...
2151 */
2152
2153 free(reals);
2154 }
2155
2156 /*
2157 * Return the number of destinations...
2158 */
2159
2160 *dests = data.dests;
2161
2162 if (data.num_dests > 0)
2163 _cupsSetError(IPP_STATUS_OK, NULL, 0);
2164
2165 return (data.num_dests);
2166 }
2167
2168
2169 /*
2170 * 'cupsGetNamedDest()' - Get options for the named destination.
2171 *
2172 * This function is optimized for retrieving a single destination and should
2173 * be used instead of @link cupsGetDests2@ and @link cupsGetDest@ when you
2174 * either know the name of the destination or want to print to the default
2175 * destination. If @code NULL@ is returned, the destination does not exist or
2176 * there is no default destination.
2177 *
2178 * If "http" is @code CUPS_HTTP_DEFAULT@, the connection to the default print
2179 * server will be used.
2180 *
2181 * If "name" is @code NULL@, the default printer for the current user will be
2182 * returned.
2183 *
2184 * The returned destination must be freed using @link cupsFreeDests@ with a
2185 * "num_dests" value of 1.
2186 *
2187 * @since CUPS 1.4/macOS 10.6@
2188 */
2189
2190 cups_dest_t * /* O - Destination or @code NULL@ */
2191 cupsGetNamedDest(http_t *http, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
2192 const char *name, /* I - Destination name or @code NULL@ for the default destination */
2193 const char *instance) /* I - Instance name or @code NULL@ */
2194 {
2195 cups_dest_t *dest; /* Destination */
2196 char filename[1024], /* Path to lpoptions */
2197 defname[256]; /* Default printer name */
2198 const char *home = getenv("HOME"); /* Home directory */
2199 int set_as_default = 0; /* Set returned destination as default */
2200 ipp_op_t op = IPP_OP_GET_PRINTER_ATTRIBUTES;
2201 /* IPP operation to get server ops */
2202 _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
2203
2204
2205 DEBUG_printf(("cupsGetNamedDest(http=%p, name=\"%s\", instance=\"%s\")", (void *)http, name, instance));
2206
2207 /*
2208 * If "name" is NULL, find the default destination...
2209 */
2210
2211 if (!name)
2212 {
2213 set_as_default = 1;
2214 name = _cupsUserDefault(defname, sizeof(defname));
2215
2216 if (name)
2217 {
2218 char *ptr; /* Temporary pointer... */
2219
2220 if ((ptr = strchr(defname, '/')) != NULL)
2221 {
2222 *ptr++ = '\0';
2223 instance = ptr;
2224 }
2225 else
2226 instance = NULL;
2227 }
2228 else if (home)
2229 {
2230 /*
2231 * No default in the environment, try the user's lpoptions files...
2232 */
2233
2234 snprintf(filename, sizeof(filename), "%s/.cups/lpoptions", home);
2235
2236 name = cups_get_default(filename, defname, sizeof(defname), &instance);
2237 }
2238
2239 if (!name)
2240 {
2241 /*
2242 * Still not there? Try the system lpoptions file...
2243 */
2244
2245 snprintf(filename, sizeof(filename), "%s/lpoptions",
2246 cg->cups_serverroot);
2247 name = cups_get_default(filename, defname, sizeof(defname), &instance);
2248 }
2249
2250 if (!name)
2251 {
2252 /*
2253 * No locally-set default destination, ask the server...
2254 */
2255
2256 op = IPP_OP_CUPS_GET_DEFAULT;
2257
2258 DEBUG_puts("1cupsGetNamedDest: Asking server for default printer...");
2259 }
2260 else
2261 DEBUG_printf(("1cupsGetNamedDest: Using name=\"%s\"...", name));
2262 }
2263
2264 /*
2265 * Get the printer's attributes...
2266 */
2267
2268 if (!_cupsGetDests(http, op, name, &dest, 0, 0))
2269 {
2270 if (name)
2271 {
2272 _cups_namedata_t data; /* Callback data */
2273
2274 DEBUG_puts("1cupsGetNamedDest: No queue found for printer, looking on network...");
2275
2276 data.name = name;
2277 data.dest = NULL;
2278
2279 cupsEnumDests(0, 1000, NULL, 0, 0, (cups_dest_cb_t)cups_name_cb, &data);
2280
2281 if (!data.dest)
2282 return (NULL);
2283
2284 dest = data.dest;
2285 }
2286 else
2287 return (NULL);
2288 }
2289
2290 DEBUG_printf(("1cupsGetNamedDest: Got dest=%p", (void *)dest));
2291
2292 if (instance)
2293 dest->instance = _cupsStrAlloc(instance);
2294
2295 if (set_as_default)
2296 dest->is_default = 1;
2297
2298 /*
2299 * Then add local options...
2300 */
2301
2302 snprintf(filename, sizeof(filename), "%s/lpoptions", cg->cups_serverroot);
2303 cups_get_dests(filename, name, instance, 1, 1, &dest);
2304
2305 if (home)
2306 {
2307 snprintf(filename, sizeof(filename), "%s/.cups/lpoptions", home);
2308
2309 cups_get_dests(filename, name, instance, 1, 1, &dest);
2310 }
2311
2312 /*
2313 * Return the result...
2314 */
2315
2316 return (dest);
2317 }
2318
2319
2320 /*
2321 * 'cupsRemoveDest()' - Remove a destination from the destination list.
2322 *
2323 * Removing a destination/instance does not delete the class or printer
2324 * queue, merely the lpoptions for that destination/instance. Use the
2325 * @link cupsSetDests@ or @link cupsSetDests2@ functions to save the new
2326 * options for the user.
2327 *
2328 * @since CUPS 1.3/macOS 10.5@
2329 */
2330
2331 int /* O - New number of destinations */
2332 cupsRemoveDest(const char *name, /* I - Destination name */
2333 const char *instance, /* I - Instance name or @code NULL@ */
2334 int num_dests, /* I - Number of destinations */
2335 cups_dest_t **dests) /* IO - Destinations */
2336 {
2337 int i; /* Index into destinations */
2338 cups_dest_t *dest; /* Pointer to destination */
2339
2340
2341 /*
2342 * Find the destination...
2343 */
2344
2345 if ((dest = cupsGetDest(name, instance, num_dests, *dests)) == NULL)
2346 return (num_dests);
2347
2348 /*
2349 * Free memory...
2350 */
2351
2352 _cupsStrFree(dest->name);
2353 _cupsStrFree(dest->instance);
2354 cupsFreeOptions(dest->num_options, dest->options);
2355
2356 /*
2357 * Remove the destination from the array...
2358 */
2359
2360 num_dests --;
2361
2362 i = (int)(dest - *dests);
2363
2364 if (i < num_dests)
2365 memmove(dest, dest + 1, (size_t)(num_dests - i) * sizeof(cups_dest_t));
2366
2367 return (num_dests);
2368 }
2369
2370
2371 /*
2372 * 'cupsSetDefaultDest()' - Set the default destination.
2373 *
2374 * @since CUPS 1.3/macOS 10.5@
2375 */
2376
2377 void
2378 cupsSetDefaultDest(
2379 const char *name, /* I - Destination name */
2380 const char *instance, /* I - Instance name or @code NULL@ */
2381 int num_dests, /* I - Number of destinations */
2382 cups_dest_t *dests) /* I - Destinations */
2383 {
2384 int i; /* Looping var */
2385 cups_dest_t *dest; /* Current destination */
2386
2387
2388 /*
2389 * Range check input...
2390 */
2391
2392 if (!name || num_dests <= 0 || !dests)
2393 return;
2394
2395 /*
2396 * Loop through the array and set the "is_default" flag for the matching
2397 * destination...
2398 */
2399
2400 for (i = num_dests, dest = dests; i > 0; i --, dest ++)
2401 dest->is_default = !_cups_strcasecmp(name, dest->name) &&
2402 ((!instance && !dest->instance) ||
2403 (instance && dest->instance &&
2404 !_cups_strcasecmp(instance, dest->instance)));
2405 }
2406
2407
2408 /*
2409 * 'cupsSetDests()' - Save the list of destinations for the default server.
2410 *
2411 * This function saves the destinations to /etc/cups/lpoptions when run
2412 * as root and ~/.cups/lpoptions when run as a normal user.
2413 *
2414 * @exclude all@
2415 */
2416
2417 void
2418 cupsSetDests(int num_dests, /* I - Number of destinations */
2419 cups_dest_t *dests) /* I - Destinations */
2420 {
2421 cupsSetDests2(CUPS_HTTP_DEFAULT, num_dests, dests);
2422 }
2423
2424
2425 /*
2426 * 'cupsSetDests2()' - Save the list of destinations for the specified server.
2427 *
2428 * This function saves the destinations to /etc/cups/lpoptions when run
2429 * as root and ~/.cups/lpoptions when run as a normal user.
2430 *
2431 * @since CUPS 1.1.21/macOS 10.4@
2432 */
2433
2434 int /* O - 0 on success, -1 on error */
2435 cupsSetDests2(http_t *http, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
2436 int num_dests, /* I - Number of destinations */
2437 cups_dest_t *dests) /* I - Destinations */
2438 {
2439 int i, j; /* Looping vars */
2440 int wrote; /* Wrote definition? */
2441 cups_dest_t *dest; /* Current destination */
2442 cups_option_t *option; /* Current option */
2443 _ipp_option_t *match; /* Matching attribute for option */
2444 FILE *fp; /* File pointer */
2445 #ifndef WIN32
2446 const char *home; /* HOME environment variable */
2447 #endif /* WIN32 */
2448 char filename[1024]; /* lpoptions file */
2449 int num_temps; /* Number of temporary destinations */
2450 cups_dest_t *temps = NULL, /* Temporary destinations */
2451 *temp; /* Current temporary dest */
2452 const char *val; /* Value of temporary option */
2453 _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
2454
2455
2456 /*
2457 * Range check the input...
2458 */
2459
2460 if (!num_dests || !dests)
2461 return (-1);
2462
2463 /*
2464 * Get the server destinations...
2465 */
2466
2467 num_temps = _cupsGetDests(http, IPP_OP_CUPS_GET_PRINTERS, NULL, &temps, 0, 0);
2468
2469 if (cupsLastError() >= IPP_STATUS_REDIRECTION_OTHER_SITE)
2470 {
2471 cupsFreeDests(num_temps, temps);
2472 return (-1);
2473 }
2474
2475 /*
2476 * Figure out which file to write to...
2477 */
2478
2479 snprintf(filename, sizeof(filename), "%s/lpoptions", cg->cups_serverroot);
2480
2481 #ifndef WIN32
2482 if (getuid())
2483 {
2484 /*
2485 * Merge in server defaults...
2486 */
2487
2488 num_temps = cups_get_dests(filename, NULL, NULL, 0, num_temps, &temps);
2489
2490 /*
2491 * Point to user defaults...
2492 */
2493
2494 if ((home = getenv("HOME")) != NULL)
2495 {
2496 /*
2497 * Create ~/.cups subdirectory...
2498 */
2499
2500 snprintf(filename, sizeof(filename), "%s/.cups", home);
2501 if (access(filename, 0))
2502 mkdir(filename, 0700);
2503
2504 snprintf(filename, sizeof(filename), "%s/.cups/lpoptions", home);
2505 }
2506 }
2507 #endif /* !WIN32 */
2508
2509 /*
2510 * Try to open the file...
2511 */
2512
2513 if ((fp = fopen(filename, "w")) == NULL)
2514 {
2515 cupsFreeDests(num_temps, temps);
2516 return (-1);
2517 }
2518
2519 #ifndef WIN32
2520 /*
2521 * Set the permissions to 0644 when saving to the /etc/cups/lpoptions
2522 * file...
2523 */
2524
2525 if (!getuid())
2526 fchmod(fileno(fp), 0644);
2527 #endif /* !WIN32 */
2528
2529 /*
2530 * Write each printer; each line looks like:
2531 *
2532 * Dest name[/instance] options
2533 * Default name[/instance] options
2534 */
2535
2536 for (i = num_dests, dest = dests; i > 0; i --, dest ++)
2537 if (dest->instance != NULL || dest->num_options != 0 || dest->is_default)
2538 {
2539 if (dest->is_default)
2540 {
2541 fprintf(fp, "Default %s", dest->name);
2542 if (dest->instance)
2543 fprintf(fp, "/%s", dest->instance);
2544
2545 wrote = 1;
2546 }
2547 else
2548 wrote = 0;
2549
2550 if ((temp = cupsGetDest(dest->name, dest->instance, num_temps, temps)) == NULL)
2551 temp = cupsGetDest(dest->name, NULL, num_temps, temps);
2552
2553 for (j = dest->num_options, option = dest->options; j > 0; j --, option ++)
2554 {
2555 /*
2556 * See if this option is a printer attribute; if so, skip it...
2557 */
2558
2559 if ((match = _ippFindOption(option->name)) != NULL &&
2560 match->group_tag == IPP_TAG_PRINTER)
2561 continue;
2562
2563 /*
2564 * See if the server/global options match these; if so, don't
2565 * write 'em.
2566 */
2567
2568 if (temp &&
2569 (val = cupsGetOption(option->name, temp->num_options,
2570 temp->options)) != NULL &&
2571 !_cups_strcasecmp(val, option->value))
2572 continue;
2573
2574 /*
2575 * Options don't match, write to the file...
2576 */
2577
2578 if (!wrote)
2579 {
2580 fprintf(fp, "Dest %s", dest->name);
2581 if (dest->instance)
2582 fprintf(fp, "/%s", dest->instance);
2583 wrote = 1;
2584 }
2585
2586 if (option->value[0])
2587 {
2588 if (strchr(option->value, ' ') ||
2589 strchr(option->value, '\\') ||
2590 strchr(option->value, '\"') ||
2591 strchr(option->value, '\''))
2592 {
2593 /*
2594 * Quote the value...
2595 */
2596
2597 fprintf(fp, " %s=\"", option->name);
2598
2599 for (val = option->value; *val; val ++)
2600 {
2601 if (strchr("\"\'\\", *val))
2602 putc('\\', fp);
2603
2604 putc(*val, fp);
2605 }
2606
2607 putc('\"', fp);
2608 }
2609 else
2610 {
2611 /*
2612 * Store the literal value...
2613 */
2614
2615 fprintf(fp, " %s=%s", option->name, option->value);
2616 }
2617 }
2618 else
2619 fprintf(fp, " %s", option->name);
2620 }
2621
2622 if (wrote)
2623 fputs("\n", fp);
2624 }
2625
2626 /*
2627 * Free the temporary destinations and close the file...
2628 */
2629
2630 cupsFreeDests(num_temps, temps);
2631
2632 fclose(fp);
2633
2634 #ifdef __APPLE__
2635 /*
2636 * Set the default printer for this location - this allows command-line
2637 * and GUI applications to share the same default destination...
2638 */
2639
2640 if ((dest = cupsGetDest(NULL, NULL, num_dests, dests)) != NULL)
2641 {
2642 CFStringRef name = CFStringCreateWithCString(kCFAllocatorDefault,
2643 dest->name,
2644 kCFStringEncodingUTF8);
2645 /* Default printer name */
2646
2647 if (name)
2648 {
2649 _cupsAppleSetDefaultPrinter(name);
2650 CFRelease(name);
2651 }
2652 }
2653 #endif /* __APPLE__ */
2654
2655 #ifdef HAVE_NOTIFY_POST
2656 /*
2657 * Send a notification so that macOS applications can know about the
2658 * change, too.
2659 */
2660
2661 notify_post("com.apple.printerListChange");
2662 #endif /* HAVE_NOTIFY_POST */
2663
2664 return (0);
2665 }
2666
2667
2668 /*
2669 * '_cupsUserDefault()' - Get the user default printer from environment
2670 * variables and location information.
2671 */
2672
2673 char * /* O - Default printer or NULL */
2674 _cupsUserDefault(char *name, /* I - Name buffer */
2675 size_t namesize) /* I - Size of name buffer */
2676 {
2677 const char *env; /* LPDEST or PRINTER env variable */
2678 #ifdef __APPLE__
2679 CFStringRef locprinter; /* Last printer as this location */
2680 #endif /* __APPLE__ */
2681
2682
2683 if ((env = getenv("LPDEST")) == NULL)
2684 if ((env = getenv("PRINTER")) != NULL && !strcmp(env, "lp"))
2685 env = NULL;
2686
2687 if (env)
2688 {
2689 strlcpy(name, env, namesize);
2690 return (name);
2691 }
2692
2693 #ifdef __APPLE__
2694 /*
2695 * Use location-based defaults if "use last printer" is selected in the
2696 * system preferences...
2697 */
2698
2699 if ((locprinter = _cupsAppleCopyDefaultPrinter()) != NULL)
2700 {
2701 CFStringGetCString(locprinter, name, (CFIndex)namesize, kCFStringEncodingUTF8);
2702 CFRelease(locprinter);
2703 }
2704 else
2705 name[0] = '\0';
2706
2707 DEBUG_printf(("1_cupsUserDefault: Returning \"%s\".", name));
2708
2709 return (*name ? name : NULL);
2710
2711 #else
2712 /*
2713 * No location-based defaults on this platform...
2714 */
2715
2716 name[0] = '\0';
2717 return (NULL);
2718 #endif /* __APPLE__ */
2719 }
2720
2721
2722 #if _CUPS_LOCATION_DEFAULTS
2723 /*
2724 * 'appleCopyLocations()' - Copy the location history array.
2725 */
2726
2727 static CFArrayRef /* O - Location array or NULL */
2728 appleCopyLocations(void)
2729 {
2730 CFArrayRef locations; /* Location array */
2731
2732
2733 /*
2734 * Look up the location array in the preferences...
2735 */
2736
2737 if ((locations = CFPreferencesCopyAppValue(kLastUsedPrintersKey,
2738 kCUPSPrintingPrefs)) == NULL)
2739 return (NULL);
2740
2741 if (CFGetTypeID(locations) != CFArrayGetTypeID())
2742 {
2743 CFRelease(locations);
2744 return (NULL);
2745 }
2746
2747 return (locations);
2748 }
2749
2750
2751 /*
2752 * 'appleCopyNetwork()' - Get the network ID for the current location.
2753 */
2754
2755 static CFStringRef /* O - Network ID */
2756 appleCopyNetwork(void)
2757 {
2758 SCDynamicStoreRef dynamicStore; /* System configuration data */
2759 CFStringRef key; /* Current network configuration key */
2760 CFDictionaryRef ip_dict; /* Network configuration data */
2761 CFStringRef network = NULL; /* Current network ID */
2762
2763
2764 if ((dynamicStore = SCDynamicStoreCreate(NULL, CFSTR("libcups"), NULL,
2765 NULL)) != NULL)
2766 {
2767 /*
2768 * First use the IPv6 router address, if available, since that will generally
2769 * be a globally-unique link-local address.
2770 */
2771
2772 if ((key = SCDynamicStoreKeyCreateNetworkGlobalEntity(
2773 NULL, kSCDynamicStoreDomainState, kSCEntNetIPv6)) != NULL)
2774 {
2775 if ((ip_dict = SCDynamicStoreCopyValue(dynamicStore, key)) != NULL)
2776 {
2777 if ((network = CFDictionaryGetValue(ip_dict,
2778 kSCPropNetIPv6Router)) != NULL)
2779 CFRetain(network);
2780
2781 CFRelease(ip_dict);
2782 }
2783
2784 CFRelease(key);
2785 }
2786
2787 /*
2788 * If that doesn't work, try the IPv4 router address. This isn't as unique
2789 * and will likely be a 10.x.y.z or 192.168.y.z address...
2790 */
2791
2792 if (!network)
2793 {
2794 if ((key = SCDynamicStoreKeyCreateNetworkGlobalEntity(
2795 NULL, kSCDynamicStoreDomainState, kSCEntNetIPv4)) != NULL)
2796 {
2797 if ((ip_dict = SCDynamicStoreCopyValue(dynamicStore, key)) != NULL)
2798 {
2799 if ((network = CFDictionaryGetValue(ip_dict,
2800 kSCPropNetIPv4Router)) != NULL)
2801 CFRetain(network);
2802
2803 CFRelease(ip_dict);
2804 }
2805
2806 CFRelease(key);
2807 }
2808 }
2809
2810 CFRelease(dynamicStore);
2811 }
2812
2813 return (network);
2814 }
2815 #endif /* _CUPS_LOCATION_DEFAULTS */
2816
2817
2818 #ifdef __APPLE__
2819 /*
2820 * 'appleGetPaperSize()' - Get the default paper size.
2821 */
2822
2823 static char * /* O - Default paper size */
2824 appleGetPaperSize(char *name, /* I - Paper size name buffer */
2825 size_t namesize) /* I - Size of buffer */
2826 {
2827 CFStringRef defaultPaperID; /* Default paper ID */
2828 pwg_media_t *pwgmedia; /* PWG media size */
2829
2830
2831 defaultPaperID = _cupsAppleCopyDefaultPaperID();
2832 if (!defaultPaperID ||
2833 CFGetTypeID(defaultPaperID) != CFStringGetTypeID() ||
2834 !CFStringGetCString(defaultPaperID, name, (CFIndex)namesize, kCFStringEncodingUTF8))
2835 name[0] = '\0';
2836 else if ((pwgmedia = pwgMediaForLegacy(name)) != NULL)
2837 strlcpy(name, pwgmedia->pwg, namesize);
2838
2839 if (defaultPaperID)
2840 CFRelease(defaultPaperID);
2841
2842 return (name);
2843 }
2844 #endif /* __APPLE__ */
2845
2846
2847 #if _CUPS_LOCATION_DEFAULTS
2848 /*
2849 * 'appleGetPrinter()' - Get a printer from the history array.
2850 */
2851
2852 static CFStringRef /* O - Printer name or NULL */
2853 appleGetPrinter(CFArrayRef locations, /* I - Location array */
2854 CFStringRef network, /* I - Network name */
2855 CFIndex *locindex) /* O - Index in array */
2856 {
2857 CFIndex i, /* Looping var */
2858 count; /* Number of locations */
2859 CFDictionaryRef location; /* Current location */
2860 CFStringRef locnetwork, /* Current network */
2861 locprinter; /* Current printer */
2862
2863
2864 for (i = 0, count = CFArrayGetCount(locations); i < count; i ++)
2865 if ((location = CFArrayGetValueAtIndex(locations, i)) != NULL &&
2866 CFGetTypeID(location) == CFDictionaryGetTypeID())
2867 {
2868 if ((locnetwork = CFDictionaryGetValue(location,
2869 kLocationNetworkKey)) != NULL &&
2870 CFGetTypeID(locnetwork) == CFStringGetTypeID() &&
2871 CFStringCompare(network, locnetwork, 0) == kCFCompareEqualTo &&
2872 (locprinter = CFDictionaryGetValue(location,
2873 kLocationPrinterIDKey)) != NULL &&
2874 CFGetTypeID(locprinter) == CFStringGetTypeID())
2875 {
2876 if (locindex)
2877 *locindex = i;
2878
2879 return (locprinter);
2880 }
2881 }
2882
2883 return (NULL);
2884 }
2885 #endif /* _CUPS_LOCATION_DEFAULTS */
2886
2887
2888 /*
2889 * 'cups_add_dest()' - Add a destination to the array.
2890 *
2891 * Unlike cupsAddDest(), this function does not check for duplicates.
2892 */
2893
2894 static cups_dest_t * /* O - New destination */
2895 cups_add_dest(const char *name, /* I - Name of destination */
2896 const char *instance, /* I - Instance or NULL */
2897 int *num_dests, /* IO - Number of destinations */
2898 cups_dest_t **dests) /* IO - Destinations */
2899 {
2900 int insert, /* Insertion point */
2901 diff; /* Result of comparison */
2902 cups_dest_t *dest; /* Destination pointer */
2903
2904
2905 /*
2906 * Add new destination...
2907 */
2908
2909 if (*num_dests == 0)
2910 dest = malloc(sizeof(cups_dest_t));
2911 else
2912 dest = realloc(*dests, sizeof(cups_dest_t) * (size_t)(*num_dests + 1));
2913
2914 if (!dest)
2915 return (NULL);
2916
2917 *dests = dest;
2918
2919 /*
2920 * Find where to insert the destination...
2921 */
2922
2923 if (*num_dests == 0)
2924 insert = 0;
2925 else
2926 {
2927 insert = cups_find_dest(name, instance, *num_dests, *dests, *num_dests - 1,
2928 &diff);
2929
2930 if (diff > 0)
2931 insert ++;
2932 }
2933
2934 /*
2935 * Move the array elements as needed...
2936 */
2937
2938 if (insert < *num_dests)
2939 memmove(*dests + insert + 1, *dests + insert, (size_t)(*num_dests - insert) * sizeof(cups_dest_t));
2940
2941 (*num_dests) ++;
2942
2943 /*
2944 * Initialize the destination...
2945 */
2946
2947 dest = *dests + insert;
2948 dest->name = _cupsStrAlloc(name);
2949 dest->instance = _cupsStrAlloc(instance);
2950 dest->is_default = 0;
2951 dest->num_options = 0;
2952 dest->options = (cups_option_t *)0;
2953
2954 return (dest);
2955 }
2956
2957
2958 # ifdef __BLOCKS__
2959 /*
2960 * 'cups_block_cb()' - Enumeration callback for block API.
2961 */
2962
2963 static int /* O - 1 to continue, 0 to stop */
2964 cups_block_cb(
2965 cups_dest_block_t block, /* I - Block */
2966 unsigned flags, /* I - Destination flags */
2967 cups_dest_t *dest) /* I - Destination */
2968 {
2969 return ((block)(flags, dest));
2970 }
2971 # endif /* __BLOCKS__ */
2972
2973
2974 /*
2975 * 'cups_compare_dests()' - Compare two destinations.
2976 */
2977
2978 static int /* O - Result of comparison */
2979 cups_compare_dests(cups_dest_t *a, /* I - First destination */
2980 cups_dest_t *b) /* I - Second destination */
2981 {
2982 int diff; /* Difference */
2983
2984
2985 if ((diff = _cups_strcasecmp(a->name, b->name)) != 0)
2986 return (diff);
2987 else if (a->instance && b->instance)
2988 return (_cups_strcasecmp(a->instance, b->instance));
2989 else
2990 return ((a->instance && !b->instance) - (!a->instance && b->instance));
2991 }
2992
2993
2994 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
2995 # ifdef HAVE_DNSSD
2996 /*
2997 * 'cups_dnssd_browse_cb()' - Browse for printers.
2998 */
2999
3000 static void
3001 cups_dnssd_browse_cb(
3002 DNSServiceRef sdRef, /* I - Service reference */
3003 DNSServiceFlags flags, /* I - Option flags */
3004 uint32_t interfaceIndex, /* I - Interface number */
3005 DNSServiceErrorType errorCode, /* I - Error, if any */
3006 const char *serviceName, /* I - Name of service/device */
3007 const char *regtype, /* I - Type of service */
3008 const char *replyDomain, /* I - Service domain */
3009 void *context) /* I - Enumeration data */
3010 {
3011 _cups_dnssd_data_t *data = (_cups_dnssd_data_t *)context;
3012 /* Enumeration data */
3013
3014
3015 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));
3016
3017 /*
3018 * Don't do anything on error...
3019 */
3020
3021 if (errorCode != kDNSServiceErr_NoError)
3022 return;
3023
3024 /*
3025 * Get the device...
3026 */
3027
3028 cups_dnssd_get_device(data, serviceName, regtype, replyDomain);
3029 }
3030
3031
3032 # else /* HAVE_AVAHI */
3033 /*
3034 * 'cups_dnssd_browse_cb()' - Browse for printers.
3035 */
3036
3037 static void
3038 cups_dnssd_browse_cb(
3039 AvahiServiceBrowser *browser, /* I - Browser */
3040 AvahiIfIndex interface, /* I - Interface index (unused) */
3041 AvahiProtocol protocol, /* I - Network protocol (unused) */
3042 AvahiBrowserEvent event, /* I - What happened */
3043 const char *name, /* I - Service name */
3044 const char *type, /* I - Registration type */
3045 const char *domain, /* I - Domain */
3046 AvahiLookupResultFlags flags, /* I - Flags */
3047 void *context) /* I - Devices array */
3048 {
3049 #ifdef DEBUG
3050 AvahiClient *client = avahi_service_browser_get_client(browser);
3051 /* Client information */
3052 #endif /* DEBUG */
3053 _cups_dnssd_data_t *data = (_cups_dnssd_data_t *)context;
3054 /* Enumeration data */
3055
3056
3057 (void)interface;
3058 (void)protocol;
3059 (void)context;
3060
3061 DEBUG_printf(("cups_dnssd_browse_cb(..., name=\"%s\", type=\"%s\", domain=\"%s\", ...);", name, type, domain));
3062
3063 switch (event)
3064 {
3065 case AVAHI_BROWSER_FAILURE:
3066 DEBUG_printf(("cups_dnssd_browse_cb: %s", avahi_strerror(avahi_client_errno(client))));
3067 avahi_simple_poll_quit(data->simple_poll);
3068 break;
3069
3070 case AVAHI_BROWSER_NEW:
3071 /*
3072 * This object is new on the network.
3073 */
3074
3075 if (flags & AVAHI_LOOKUP_RESULT_LOCAL)
3076 {
3077 /*
3078 * This comes from the local machine so ignore it.
3079 */
3080
3081 DEBUG_printf(("cups_dnssd_browse_cb: Ignoring local service \"%s\".", name));
3082 }
3083 else
3084 {
3085 /*
3086 * Create a device entry for it if it doesn't yet exist.
3087 */
3088
3089 cups_dnssd_get_device(data, name, type, domain);
3090 }
3091 break;
3092
3093 case AVAHI_BROWSER_REMOVE :
3094 case AVAHI_BROWSER_CACHE_EXHAUSTED :
3095 break;
3096
3097 case AVAHI_BROWSER_ALL_FOR_NOW :
3098 DEBUG_puts("cups_dnssd_browse_cb: ALL_FOR_NOW");
3099 data->browsers --;
3100 break;
3101 }
3102 }
3103
3104
3105 /*
3106 * 'cups_dnssd_client_cb()' - Avahi client callback function.
3107 */
3108
3109 static void
3110 cups_dnssd_client_cb(
3111 AvahiClient *client, /* I - Client information (unused) */
3112 AvahiClientState state, /* I - Current state */
3113 void *context) /* I - User data (unused) */
3114 {
3115 _cups_dnssd_data_t *data = (_cups_dnssd_data_t *)context;
3116 /* Enumeration data */
3117
3118
3119 (void)client;
3120
3121 DEBUG_printf(("cups_dnssd_client_cb(client=%p, state=%d, context=%p)", client, state, context));
3122
3123 /*
3124 * If the connection drops, quit.
3125 */
3126
3127 if (state == AVAHI_CLIENT_FAILURE)
3128 {
3129 DEBUG_puts("cups_dnssd_client_cb: Avahi connection failed.");
3130 avahi_simple_poll_quit(data->simple_poll);
3131 }
3132 }
3133 # endif /* HAVE_DNSSD */
3134
3135
3136 /*
3137 * 'cups_dnssd_compare_device()' - Compare two devices.
3138 */
3139
3140 static int /* O - Result of comparison */
3141 cups_dnssd_compare_devices(
3142 _cups_dnssd_device_t *a, /* I - First device */
3143 _cups_dnssd_device_t *b) /* I - Second device */
3144 {
3145 return (strcmp(a->dest.name, b->dest.name));
3146 }
3147
3148
3149 /*
3150 * 'cups_dnssd_free_device()' - Free the memory used by a device.
3151 */
3152
3153 static void
3154 cups_dnssd_free_device(
3155 _cups_dnssd_device_t *device, /* I - Device */
3156 _cups_dnssd_data_t *data) /* I - Enumeration data */
3157 {
3158 DEBUG_printf(("5cups_dnssd_free_device(device=%p(%s), data=%p)", (void *)device, device->dest.name, (void *)data));
3159
3160 # ifdef HAVE_DNSSD
3161 if (device->ref)
3162 DNSServiceRefDeallocate(device->ref);
3163 # else /* HAVE_AVAHI */
3164 if (device->ref)
3165 avahi_record_browser_free(device->ref);
3166 # endif /* HAVE_DNSSD */
3167
3168 _cupsStrFree(device->domain);
3169 _cupsStrFree(device->fullName);
3170 _cupsStrFree(device->regtype);
3171 _cupsStrFree(device->dest.name);
3172
3173 cupsFreeOptions(device->dest.num_options, device->dest.options);
3174
3175 free(device);
3176 }
3177
3178
3179 /*
3180 * 'cups_dnssd_get_device()' - Lookup a device and create it as needed.
3181 */
3182
3183 static _cups_dnssd_device_t * /* O - Device */
3184 cups_dnssd_get_device(
3185 _cups_dnssd_data_t *data, /* I - Enumeration data */
3186 const char *serviceName, /* I - Service name */
3187 const char *regtype, /* I - Registration type */
3188 const char *replyDomain) /* I - Domain name */
3189 {
3190 _cups_dnssd_device_t key, /* Search key */
3191 *device; /* Device */
3192 char fullName[kDNSServiceMaxDomainName],
3193 /* Full name for query */
3194 name[128]; /* Queue name */
3195
3196
3197 DEBUG_printf(("5cups_dnssd_get_device(data=%p, serviceName=\"%s\", regtype=\"%s\", replyDomain=\"%s\")", (void *)data, serviceName, regtype, replyDomain));
3198
3199 /*
3200 * See if this is an existing device...
3201 */
3202
3203 cups_queue_name(name, serviceName, sizeof(name));
3204
3205 key.dest.name = name;
3206
3207 if ((device = cupsArrayFind(data->devices, &key)) != NULL)
3208 {
3209 /*
3210 * Yes, see if we need to do anything with this...
3211 */
3212
3213 int update = 0; /* Non-zero if we need to update */
3214
3215 if (!_cups_strcasecmp(replyDomain, "local.") &&
3216 _cups_strcasecmp(device->domain, replyDomain))
3217 {
3218 /*
3219 * Update the "global" listing to use the .local domain name instead.
3220 */
3221
3222 _cupsStrFree(device->domain);
3223 device->domain = _cupsStrAlloc(replyDomain);
3224
3225 DEBUG_printf(("6cups_dnssd_get_device: Updating '%s' to use local "
3226 "domain.", device->dest.name));
3227
3228 update = 1;
3229 }
3230
3231 if (!_cups_strcasecmp(regtype, "_ipps._tcp") &&
3232 _cups_strcasecmp(device->regtype, regtype))
3233 {
3234 /*
3235 * Prefer IPPS over IPP.
3236 */
3237
3238 _cupsStrFree(device->regtype);
3239 device->regtype = _cupsStrAlloc(regtype);
3240
3241 DEBUG_printf(("6cups_dnssd_get_device: Updating '%s' to use IPPS.",
3242 device->dest.name));
3243
3244 update = 1;
3245 }
3246
3247 if (!update)
3248 {
3249 DEBUG_printf(("6cups_dnssd_get_device: No changes to '%s'.",
3250 device->dest.name));
3251 return (device);
3252 }
3253 }
3254 else
3255 {
3256 /*
3257 * No, add the device...
3258 */
3259
3260 DEBUG_printf(("6cups_dnssd_get_device: Adding '%s' for %s with domain "
3261 "'%s'.", serviceName,
3262 !strcmp(regtype, "_ipps._tcp") ? "IPPS" : "IPP",
3263 replyDomain));
3264
3265 device = calloc(sizeof(_cups_dnssd_device_t), 1);
3266 device->dest.name = _cupsStrAlloc(name);
3267 device->domain = _cupsStrAlloc(replyDomain);
3268 device->regtype = _cupsStrAlloc(regtype);
3269
3270 device->dest.num_options = cupsAddOption("printer-info", serviceName, 0, &device->dest.options);
3271
3272 cupsArrayAdd(data->devices, device);
3273 }
3274
3275 /*
3276 * Set the "full name" of this service, which is used for queries...
3277 */
3278
3279 # ifdef HAVE_DNSSD
3280 DNSServiceConstructFullName(fullName, serviceName, regtype, replyDomain);
3281 # else /* HAVE_AVAHI */
3282 avahi_service_name_join(fullName, kDNSServiceMaxDomainName, serviceName, regtype, replyDomain);
3283 # endif /* HAVE_DNSSD */
3284
3285 _cupsStrFree(device->fullName);
3286 device->fullName = _cupsStrAlloc(fullName);
3287
3288 if (device->ref)
3289 {
3290 # ifdef HAVE_DNSSD
3291 DNSServiceRefDeallocate(device->ref);
3292 # else /* HAVE_AVAHI */
3293 avahi_record_browser_free(device->ref);
3294 # endif /* HAVE_DNSSD */
3295
3296 device->ref = 0;
3297 }
3298
3299 if (device->state == _CUPS_DNSSD_ACTIVE)
3300 {
3301 DEBUG_printf(("6cups_dnssd_get_device: Remove callback for \"%s\".", device->dest.name));
3302
3303 (*data->cb)(data->user_data, CUPS_DEST_FLAGS_REMOVED, &device->dest);
3304 device->state = _CUPS_DNSSD_NEW;
3305 }
3306
3307 return (device);
3308 }
3309
3310
3311 # ifdef HAVE_DNSSD
3312 /*
3313 * 'cups_dnssd_local_cb()' - Browse for local printers.
3314 */
3315
3316 static void
3317 cups_dnssd_local_cb(
3318 DNSServiceRef sdRef, /* I - Service reference */
3319 DNSServiceFlags flags, /* I - Option flags */
3320 uint32_t interfaceIndex, /* I - Interface number */
3321 DNSServiceErrorType errorCode, /* I - Error, if any */
3322 const char *serviceName, /* I - Name of service/device */
3323 const char *regtype, /* I - Type of service */
3324 const char *replyDomain, /* I - Service domain */
3325 void *context) /* I - Devices array */
3326 {
3327 _cups_dnssd_data_t *data = (_cups_dnssd_data_t *)context;
3328 /* Enumeration data */
3329 _cups_dnssd_device_t *device; /* Device */
3330
3331
3332 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));
3333
3334 /*
3335 * Only process "add" data...
3336 */
3337
3338 if (errorCode != kDNSServiceErr_NoError || !(flags & kDNSServiceFlagsAdd))
3339 return;
3340
3341 /*
3342 * Get the device...
3343 */
3344
3345 device = cups_dnssd_get_device(data, serviceName, regtype, replyDomain);
3346
3347 /*
3348 * Hide locally-registered devices...
3349 */
3350
3351 DEBUG_printf(("6cups_dnssd_local_cb: Hiding local printer '%s'.",
3352 serviceName));
3353
3354 if (device->ref)
3355 {
3356 DNSServiceRefDeallocate(device->ref);
3357 device->ref = 0;
3358 }
3359
3360 if (device->state == _CUPS_DNSSD_ACTIVE)
3361 {
3362 DEBUG_printf(("6cups_dnssd_local_cb: Remove callback for \"%s\".", device->dest.name));
3363 (*data->cb)(data->user_data, CUPS_DEST_FLAGS_REMOVED, &device->dest);
3364 }
3365
3366 device->state = _CUPS_DNSSD_LOCAL;
3367 }
3368 # endif /* HAVE_DNSSD */
3369
3370
3371 # ifdef HAVE_AVAHI
3372 /*
3373 * 'cups_dnssd_poll_cb()' - Wait for input on the specified file descriptors.
3374 *
3375 * Note: This function is needed because avahi_simple_poll_iterate is broken
3376 * and always uses a timeout of 0 (!) milliseconds.
3377 * (https://github.com/lathiat/avahi/issues/127)
3378 *
3379 * @private@
3380 */
3381
3382 static int /* O - Number of file descriptors matching */
3383 cups_dnssd_poll_cb(
3384 struct pollfd *pollfds, /* I - File descriptors */
3385 unsigned int num_pollfds, /* I - Number of file descriptors */
3386 int timeout, /* I - Timeout in milliseconds (unused) */
3387 void *context) /* I - User data (unused) */
3388 {
3389 _cups_dnssd_data_t *data = (_cups_dnssd_data_t *)context;
3390 /* Enumeration data */
3391 int val; /* Return value */
3392
3393
3394 DEBUG_printf(("cups_dnssd_poll_cb(pollfds=%p, num_pollfds=%d, timeout=%d, context=%p)", pollfds, num_pollfds, timeout, context));
3395
3396 (void)timeout;
3397
3398 val = poll(pollfds, num_pollfds, _CUPS_DNSSD_MAXTIME);
3399
3400 DEBUG_printf(("cups_dnssd_poll_cb: poll() returned %d", val));
3401
3402 if (val < 0)
3403 {
3404 DEBUG_printf(("cups_dnssd_poll_cb: %s", strerror(errno)));
3405 }
3406 else if (val > 0)
3407 {
3408 data->got_data = 1;
3409 }
3410
3411 return (val);
3412 }
3413 # endif /* HAVE_AVAHI */
3414
3415
3416 /*
3417 * 'cups_dnssd_query_cb()' - Process query data.
3418 */
3419
3420 # ifdef HAVE_DNSSD
3421 static void
3422 cups_dnssd_query_cb(
3423 DNSServiceRef sdRef, /* I - Service reference */
3424 DNSServiceFlags flags, /* I - Data flags */
3425 uint32_t interfaceIndex, /* I - Interface */
3426 DNSServiceErrorType errorCode, /* I - Error, if any */
3427 const char *fullName, /* I - Full service name */
3428 uint16_t rrtype, /* I - Record type */
3429 uint16_t rrclass, /* I - Record class */
3430 uint16_t rdlen, /* I - Length of record data */
3431 const void *rdata, /* I - Record data */
3432 uint32_t ttl, /* I - Time-to-live */
3433 void *context) /* I - Enumeration data */
3434 {
3435 # else /* HAVE_AVAHI */
3436 static void
3437 cups_dnssd_query_cb(
3438 AvahiRecordBrowser *browser, /* I - Record browser */
3439 AvahiIfIndex interfaceIndex,
3440 /* I - Interface index (unused) */
3441 AvahiProtocol protocol, /* I - Network protocol (unused) */
3442 AvahiBrowserEvent event, /* I - What happened? */
3443 const char *fullName, /* I - Service name */
3444 uint16_t rrclass, /* I - Record class */
3445 uint16_t rrtype, /* I - Record type */
3446 const void *rdata, /* I - TXT record */
3447 size_t rdlen, /* I - Length of TXT record */
3448 AvahiLookupResultFlags flags, /* I - Flags */
3449 void *context) /* I - Enumeration data */
3450 {
3451 # ifdef DEBUG
3452 AvahiClient *client = avahi_record_browser_get_client(browser);
3453 /* Client information */
3454 # endif /* DEBUG */
3455 # endif /* HAVE_DNSSD */
3456 _cups_dnssd_data_t *data = (_cups_dnssd_data_t *)context;
3457 /* Enumeration data */
3458 char serviceName[256],/* Service name */
3459 name[128], /* Queue name */
3460 *ptr; /* Pointer into string */
3461 _cups_dnssd_device_t dkey, /* Search key */
3462 *device; /* Device */
3463
3464
3465 # ifdef HAVE_DNSSD
3466 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));
3467
3468 /*
3469 * Only process "add" data...
3470 */
3471
3472 if (errorCode != kDNSServiceErr_NoError || !(flags & kDNSServiceFlagsAdd))
3473 return;
3474
3475 # else /* HAVE_AVAHI */
3476 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));
3477
3478 /*
3479 * Only process "add" data...
3480 */
3481
3482 if (event != AVAHI_BROWSER_NEW)
3483 {
3484 if (event == AVAHI_BROWSER_FAILURE)
3485 DEBUG_printf(("cups_dnssd_query_cb: %s", avahi_strerror(avahi_client_errno(client))));
3486
3487 return;
3488 }
3489 # endif /* HAVE_DNSSD */
3490
3491 /*
3492 * Lookup the service in the devices array.
3493 */
3494
3495 cups_dnssd_unquote(serviceName, fullName, sizeof(serviceName));
3496
3497 if ((ptr = strstr(serviceName, "._")) != NULL)
3498 *ptr = '\0';
3499
3500 cups_queue_name(name, serviceName, sizeof(name));
3501
3502 dkey.dest.name = name;
3503
3504 if ((device = cupsArrayFind(data->devices, &dkey)) != NULL && device->state == _CUPS_DNSSD_NEW)
3505 {
3506 /*
3507 * Found it, pull out the make and model from the TXT record and save it...
3508 */
3509
3510 const uint8_t *txt, /* Pointer into data */
3511 *txtnext, /* Next key/value pair */
3512 *txtend; /* End of entire TXT record */
3513 uint8_t txtlen; /* Length of current key/value pair */
3514 char key[256], /* Key string */
3515 value[256], /* Value string */
3516 make_and_model[512],
3517 /* Manufacturer and model */
3518 model[256], /* Model */
3519 uriname[1024], /* Name for URI */
3520 uri[1024]; /* Printer URI */
3521 cups_ptype_t type = CUPS_PRINTER_DISCOVERED | CUPS_PRINTER_BW;
3522 /* Printer type */
3523 int saw_printer_type = 0;
3524 /* Did we see a printer-type key? */
3525
3526 device->state = _CUPS_DNSSD_PENDING;
3527 make_and_model[0] = '\0';
3528
3529 strlcpy(model, "Unknown", sizeof(model));
3530
3531 for (txt = rdata, txtend = txt + rdlen;
3532 txt < txtend;
3533 txt = txtnext)
3534 {
3535 /*
3536 * Read a key/value pair starting with an 8-bit length. Since the
3537 * length is 8 bits and the size of the key/value buffers is 256, we
3538 * don't need to check for overflow...
3539 */
3540
3541 txtlen = *txt++;
3542
3543 if (!txtlen || (txt + txtlen) > txtend)
3544 break;
3545
3546 txtnext = txt + txtlen;
3547
3548 for (ptr = key; txt < txtnext && *txt != '='; txt ++)
3549 *ptr++ = (char)*txt;
3550 *ptr = '\0';
3551
3552 if (txt < txtnext && *txt == '=')
3553 {
3554 txt ++;
3555
3556 if (txt < txtnext)
3557 memcpy(value, txt, (size_t)(txtnext - txt));
3558 value[txtnext - txt] = '\0';
3559
3560 DEBUG_printf(("6cups_dnssd_query_cb: %s=%s", key, value));
3561 }
3562 else
3563 {
3564 DEBUG_printf(("6cups_dnssd_query_cb: '%s' with no value.", key));
3565 continue;
3566 }
3567
3568 if (!_cups_strcasecmp(key, "usb_MFG") ||
3569 !_cups_strcasecmp(key, "usb_MANU") ||
3570 !_cups_strcasecmp(key, "usb_MANUFACTURER"))
3571 strlcpy(make_and_model, value, sizeof(make_and_model));
3572 else if (!_cups_strcasecmp(key, "usb_MDL") ||
3573 !_cups_strcasecmp(key, "usb_MODEL"))
3574 strlcpy(model, value, sizeof(model));
3575 else if (!_cups_strcasecmp(key, "product") && !strstr(value, "Ghostscript"))
3576 {
3577 if (value[0] == '(')
3578 {
3579 /*
3580 * Strip parenthesis...
3581 */
3582
3583 if ((ptr = value + strlen(value) - 1) > value && *ptr == ')')
3584 *ptr = '\0';
3585
3586 strlcpy(model, value + 1, sizeof(model));
3587 }
3588 else
3589 strlcpy(model, value, sizeof(model));
3590 }
3591 else if (!_cups_strcasecmp(key, "ty"))
3592 {
3593 strlcpy(model, value, sizeof(model));
3594
3595 if ((ptr = strchr(model, ',')) != NULL)
3596 *ptr = '\0';
3597 }
3598 else if (!_cups_strcasecmp(key, "note"))
3599 device->dest.num_options = cupsAddOption("printer-location", value,
3600 device->dest.num_options,
3601 &device->dest.options);
3602 else if (!_cups_strcasecmp(key, "pdl"))
3603 {
3604 /*
3605 * Look for PDF-capable printers; only PDF-capable printers are shown.
3606 */
3607
3608 const char *start, *next; /* Pointer into value */
3609 int have_pdf = 0, /* Have PDF? */
3610 have_raster = 0;/* Have raster format support? */
3611
3612 for (start = value; start && *start; start = next)
3613 {
3614 if (!_cups_strncasecmp(start, "application/pdf", 15) && (!start[15] || start[15] == ','))
3615 {
3616 have_pdf = 1;
3617 break;
3618 }
3619 else if ((!_cups_strncasecmp(start, "image/pwg-raster", 16) && (!start[16] || start[16] == ',')) ||
3620 (!_cups_strncasecmp(start, "image/urf", 9) && (!start[9] || start[9] == ',')))
3621 {
3622 have_raster = 1;
3623 break;
3624 }
3625
3626 if ((next = strchr(start, ',')) != NULL)
3627 next ++;
3628 }
3629
3630 if (!have_pdf && !have_raster)
3631 device->state = _CUPS_DNSSD_INCOMPATIBLE;
3632 }
3633 else if (!_cups_strcasecmp(key, "printer-type"))
3634 {
3635 /*
3636 * Value is either NNNN or 0xXXXX
3637 */
3638
3639 saw_printer_type = 1;
3640 type = (cups_ptype_t)strtol(value, NULL, 0) | CUPS_PRINTER_DISCOVERED;
3641 }
3642 else if (!saw_printer_type)
3643 {
3644 if (!_cups_strcasecmp(key, "air") &&
3645 !_cups_strcasecmp(value, "t"))
3646 type |= CUPS_PRINTER_AUTHENTICATED;
3647 else if (!_cups_strcasecmp(key, "bind") &&
3648 !_cups_strcasecmp(value, "t"))
3649 type |= CUPS_PRINTER_BIND;
3650 else if (!_cups_strcasecmp(key, "collate") &&
3651 !_cups_strcasecmp(value, "t"))
3652 type |= CUPS_PRINTER_COLLATE;
3653 else if (!_cups_strcasecmp(key, "color") &&
3654 !_cups_strcasecmp(value, "t"))
3655 type |= CUPS_PRINTER_COLOR;
3656 else if (!_cups_strcasecmp(key, "copies") &&
3657 !_cups_strcasecmp(value, "t"))
3658 type |= CUPS_PRINTER_COPIES;
3659 else if (!_cups_strcasecmp(key, "duplex") &&
3660 !_cups_strcasecmp(value, "t"))
3661 type |= CUPS_PRINTER_DUPLEX;
3662 else if (!_cups_strcasecmp(key, "fax") &&
3663 !_cups_strcasecmp(value, "t"))
3664 type |= CUPS_PRINTER_MFP;
3665 else if (!_cups_strcasecmp(key, "papercustom") &&
3666 !_cups_strcasecmp(value, "t"))
3667 type |= CUPS_PRINTER_VARIABLE;
3668 else if (!_cups_strcasecmp(key, "papermax"))
3669 {
3670 if (!_cups_strcasecmp(value, "legal-a4"))
3671 type |= CUPS_PRINTER_SMALL;
3672 else if (!_cups_strcasecmp(value, "isoc-a2"))
3673 type |= CUPS_PRINTER_MEDIUM;
3674 else if (!_cups_strcasecmp(value, ">isoc-a2"))
3675 type |= CUPS_PRINTER_LARGE;
3676 }
3677 else if (!_cups_strcasecmp(key, "punch") &&
3678 !_cups_strcasecmp(value, "t"))
3679 type |= CUPS_PRINTER_PUNCH;
3680 else if (!_cups_strcasecmp(key, "scan") &&
3681 !_cups_strcasecmp(value, "t"))
3682 type |= CUPS_PRINTER_MFP;
3683 else if (!_cups_strcasecmp(key, "sort") &&
3684 !_cups_strcasecmp(value, "t"))
3685 type |= CUPS_PRINTER_SORT;
3686 else if (!_cups_strcasecmp(key, "staple") &&
3687 !_cups_strcasecmp(value, "t"))
3688 type |= CUPS_PRINTER_STAPLE;
3689 }
3690 }
3691
3692 /*
3693 * Save the printer-xxx values...
3694 */
3695
3696 if (make_and_model[0])
3697 {
3698 strlcat(make_and_model, " ", sizeof(make_and_model));
3699 strlcat(make_and_model, model, sizeof(make_and_model));
3700
3701 device->dest.num_options = cupsAddOption("printer-make-and-model", make_and_model, device->dest.num_options, &device->dest.options);
3702 }
3703 else
3704 device->dest.num_options = cupsAddOption("printer-make-and-model", model, device->dest.num_options, &device->dest.options);
3705
3706 device->type = type;
3707 snprintf(value, sizeof(value), "%u", type);
3708 device->dest.num_options = cupsAddOption("printer-type", value, device->dest.num_options, &device->dest.options);
3709
3710 /*
3711 * Save the URI...
3712 */
3713
3714 cups_dnssd_unquote(uriname, device->fullName, sizeof(uriname));
3715 httpAssembleURI(HTTP_URI_CODING_ALL, uri, sizeof(uri),
3716 !strcmp(device->regtype, "_ipps._tcp") ? "ipps" : "ipp",
3717 NULL, uriname, 0, saw_printer_type ? "/cups" : "/");
3718
3719 DEBUG_printf(("6cups_dnssd_query: device-uri=\"%s\"", uri));
3720
3721 device->dest.num_options = cupsAddOption("device-uri", uri, device->dest.num_options, &device->dest.options);
3722 }
3723 else
3724 DEBUG_printf(("6cups_dnssd_query: Ignoring TXT record for '%s'.",
3725 fullName));
3726 }
3727
3728
3729 /*
3730 * 'cups_dnssd_resolve()' - Resolve a Bonjour printer URI.
3731 */
3732
3733 static const char * /* O - Resolved URI or NULL */
3734 cups_dnssd_resolve(
3735 cups_dest_t *dest, /* I - Destination */
3736 const char *uri, /* I - Current printer URI */
3737 int msec, /* I - Time in milliseconds */
3738 int *cancel, /* I - Pointer to "cancel" variable */
3739 cups_dest_cb_t cb, /* I - Callback */
3740 void *user_data) /* I - User data for callback */
3741 {
3742 char tempuri[1024]; /* Temporary URI buffer */
3743 _cups_dnssd_resolve_t resolve; /* Resolve data */
3744
3745
3746 /*
3747 * Resolve the URI...
3748 */
3749
3750 resolve.cancel = cancel;
3751 gettimeofday(&resolve.end_time, NULL);
3752 if (msec > 0)
3753 {
3754 resolve.end_time.tv_sec += msec / 1000;
3755 resolve.end_time.tv_usec += (msec % 1000) * 1000;
3756
3757 while (resolve.end_time.tv_usec >= 1000000)
3758 {
3759 resolve.end_time.tv_sec ++;
3760 resolve.end_time.tv_usec -= 1000000;
3761 }
3762 }
3763 else
3764 resolve.end_time.tv_sec += 75;
3765
3766 if (cb)
3767 (*cb)(user_data, CUPS_DEST_FLAGS_UNCONNECTED | CUPS_DEST_FLAGS_RESOLVING, dest);
3768
3769 if ((uri = _httpResolveURI(uri, tempuri, sizeof(tempuri), _HTTP_RESOLVE_DEFAULT, cups_dnssd_resolve_cb, &resolve)) == NULL)
3770 {
3771 _cupsSetError(IPP_STATUS_ERROR_INTERNAL, _("Unable to resolve printer-uri."), 1);
3772
3773 if (cb)
3774 (*cb)(user_data, CUPS_DEST_FLAGS_UNCONNECTED | CUPS_DEST_FLAGS_ERROR, dest);
3775
3776 return (NULL);
3777 }
3778
3779 /*
3780 * Save the resolved URI...
3781 */
3782
3783 dest->num_options = cupsAddOption("resolved-device-uri", uri, dest->num_options, &dest->options);
3784
3785 return (cupsGetOption("resolved-device-uri", dest->num_options, dest->options));
3786 }
3787
3788
3789 /*
3790 * 'cups_dnssd_resolve_cb()' - See if we should continue resolving.
3791 */
3792
3793 static int /* O - 1 to continue, 0 to stop */
3794 cups_dnssd_resolve_cb(void *context) /* I - Resolve data */
3795 {
3796 _cups_dnssd_resolve_t *resolve = (_cups_dnssd_resolve_t *)context;
3797 /* Resolve data */
3798 struct timeval curtime; /* Current time */
3799
3800
3801 /*
3802 * If the cancel variable is set, return immediately.
3803 */
3804
3805 if (resolve->cancel && *(resolve->cancel))
3806 {
3807 DEBUG_puts("4cups_dnssd_resolve_cb: Canceled.");
3808 return (0);
3809 }
3810
3811 /*
3812 * Otherwise check the end time...
3813 */
3814
3815 gettimeofday(&curtime, NULL);
3816
3817 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));
3818
3819 return (curtime.tv_sec < resolve->end_time.tv_sec ||
3820 (curtime.tv_sec == resolve->end_time.tv_sec &&
3821 curtime.tv_usec < resolve->end_time.tv_usec));
3822 }
3823
3824
3825 /*
3826 * 'cups_dnssd_unquote()' - Unquote a name string.
3827 */
3828
3829 static void
3830 cups_dnssd_unquote(char *dst, /* I - Destination buffer */
3831 const char *src, /* I - Source string */
3832 size_t dstsize) /* I - Size of destination buffer */
3833 {
3834 char *dstend = dst + dstsize - 1; /* End of destination buffer */
3835
3836
3837 while (*src && dst < dstend)
3838 {
3839 if (*src == '\\')
3840 {
3841 src ++;
3842 if (isdigit(src[0] & 255) && isdigit(src[1] & 255) &&
3843 isdigit(src[2] & 255))
3844 {
3845 *dst++ = ((((src[0] - '0') * 10) + src[1] - '0') * 10) + src[2] - '0';
3846 src += 3;
3847 }
3848 else
3849 *dst++ = *src++;
3850 }
3851 else
3852 *dst++ = *src ++;
3853 }
3854
3855 *dst = '\0';
3856 }
3857 #endif /* HAVE_DNSSD */
3858
3859
3860 #if defined(HAVE_AVAHI) || defined(HAVE_DNSSD)
3861 /*
3862 * 'cups_elapsed()' - Return the elapsed time in milliseconds.
3863 */
3864
3865 static int /* O - Elapsed time in milliseconds */
3866 cups_elapsed(struct timeval *t) /* IO - Previous time */
3867 {
3868 int msecs; /* Milliseconds */
3869 struct timeval nt; /* New time */
3870
3871
3872 gettimeofday(&nt, NULL);
3873
3874 msecs = (int)(1000 * (nt.tv_sec - t->tv_sec) + (nt.tv_usec - t->tv_usec) / 1000);
3875
3876 *t = nt;
3877
3878 return (msecs);
3879 }
3880 #endif /* HAVE_AVAHI || HAVE_DNSSD */
3881
3882
3883 /*
3884 * 'cups_find_dest()' - Find a destination using a binary search.
3885 */
3886
3887 static int /* O - Index of match */
3888 cups_find_dest(const char *name, /* I - Destination name */
3889 const char *instance, /* I - Instance or NULL */
3890 int num_dests, /* I - Number of destinations */
3891 cups_dest_t *dests, /* I - Destinations */
3892 int prev, /* I - Previous index */
3893 int *rdiff) /* O - Difference of match */
3894 {
3895 int left, /* Low mark for binary search */
3896 right, /* High mark for binary search */
3897 current, /* Current index */
3898 diff; /* Result of comparison */
3899 cups_dest_t key; /* Search key */
3900
3901
3902 key.name = (char *)name;
3903 key.instance = (char *)instance;
3904
3905 if (prev >= 0)
3906 {
3907 /*
3908 * Start search on either side of previous...
3909 */
3910
3911 if ((diff = cups_compare_dests(&key, dests + prev)) == 0 ||
3912 (diff < 0 && prev == 0) ||
3913 (diff > 0 && prev == (num_dests - 1)))
3914 {
3915 *rdiff = diff;
3916 return (prev);
3917 }
3918 else if (diff < 0)
3919 {
3920 /*
3921 * Start with previous on right side...
3922 */
3923
3924 left = 0;
3925 right = prev;
3926 }
3927 else
3928 {
3929 /*
3930 * Start wih previous on left side...
3931 */
3932
3933 left = prev;
3934 right = num_dests - 1;
3935 }
3936 }
3937 else
3938 {
3939 /*
3940 * Start search in the middle...
3941 */
3942
3943 left = 0;
3944 right = num_dests - 1;
3945 }
3946
3947 do
3948 {
3949 current = (left + right) / 2;
3950 diff = cups_compare_dests(&key, dests + current);
3951
3952 if (diff == 0)
3953 break;
3954 else if (diff < 0)
3955 right = current;
3956 else
3957 left = current;
3958 }
3959 while ((right - left) > 1);
3960
3961 if (diff != 0)
3962 {
3963 /*
3964 * Check the last 1 or 2 elements...
3965 */
3966
3967 if ((diff = cups_compare_dests(&key, dests + left)) <= 0)
3968 current = left;
3969 else
3970 {
3971 diff = cups_compare_dests(&key, dests + right);
3972 current = right;
3973 }
3974 }
3975
3976 /*
3977 * Return the closest destination and the difference...
3978 */
3979
3980 *rdiff = diff;
3981
3982 return (current);
3983 }
3984
3985
3986 /*
3987 * 'cups_get_cb()' - Collect enumerated destinations.
3988 */
3989
3990 static int /* O - 1 to continue, 0 to stop */
3991 cups_get_cb(_cups_getdata_t *data, /* I - Data from cupsGetDests */
3992 unsigned flags, /* I - Enumeration flags */
3993 cups_dest_t *dest) /* I - Destination */
3994 {
3995 if (flags & CUPS_DEST_FLAGS_REMOVED)
3996 {
3997 /*
3998 * Remove destination from array...
3999 */
4000
4001 data->num_dests = cupsRemoveDest(dest->name, dest->instance, data->num_dests, &data->dests);
4002 }
4003 else
4004 {
4005 /*
4006 * Add destination to array...
4007 */
4008
4009 data->num_dests = cupsCopyDest(dest, data->num_dests, &data->dests);
4010 }
4011
4012 return (1);
4013 }
4014
4015
4016 /*
4017 * 'cups_get_default()' - Get the default destination from an lpoptions file.
4018 */
4019
4020 static char * /* O - Default destination or NULL */
4021 cups_get_default(const char *filename, /* I - File to read */
4022 char *namebuf, /* I - Name buffer */
4023 size_t namesize, /* I - Size of name buffer */
4024 const char **instance) /* I - Instance */
4025 {
4026 cups_file_t *fp; /* lpoptions file */
4027 char line[8192], /* Line from file */
4028 *value, /* Value for line */
4029 *nameptr; /* Pointer into name */
4030 int linenum; /* Current line */
4031
4032
4033 *namebuf = '\0';
4034
4035 if ((fp = cupsFileOpen(filename, "r")) != NULL)
4036 {
4037 linenum = 0;
4038
4039 while (cupsFileGetConf(fp, line, sizeof(line), &value, &linenum))
4040 {
4041 if (!_cups_strcasecmp(line, "default") && value)
4042 {
4043 strlcpy(namebuf, value, namesize);
4044
4045 if ((nameptr = strchr(namebuf, ' ')) != NULL)
4046 *nameptr = '\0';
4047 if ((nameptr = strchr(namebuf, '\t')) != NULL)
4048 *nameptr = '\0';
4049
4050 if ((nameptr = strchr(namebuf, '/')) != NULL)
4051 *nameptr++ = '\0';
4052
4053 *instance = nameptr;
4054 break;
4055 }
4056 }
4057
4058 cupsFileClose(fp);
4059 }
4060
4061 return (*namebuf ? namebuf : NULL);
4062 }
4063
4064
4065 /*
4066 * 'cups_get_dests()' - Get destinations from a file.
4067 */
4068
4069 static int /* O - Number of destinations */
4070 cups_get_dests(
4071 const char *filename, /* I - File to read from */
4072 const char *match_name, /* I - Destination name we want */
4073 const char *match_inst, /* I - Instance name we want */
4074 int user_default_set, /* I - User default printer set? */
4075 int num_dests, /* I - Number of destinations */
4076 cups_dest_t **dests) /* IO - Destinations */
4077 {
4078 int i; /* Looping var */
4079 cups_dest_t *dest; /* Current destination */
4080 cups_file_t *fp; /* File pointer */
4081 char line[8192], /* Line from file */
4082 *lineptr, /* Pointer into line */
4083 *name, /* Name of destination/option */
4084 *instance; /* Instance of destination */
4085 int linenum; /* Current line number */
4086
4087
4088 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));
4089
4090 /*
4091 * Try to open the file...
4092 */
4093
4094 if ((fp = cupsFileOpen(filename, "r")) == NULL)
4095 return (num_dests);
4096
4097 /*
4098 * Read each printer; each line looks like:
4099 *
4100 * Dest name[/instance] options
4101 * Default name[/instance] options
4102 */
4103
4104 linenum = 0;
4105
4106 while (cupsFileGetConf(fp, line, sizeof(line), &lineptr, &linenum))
4107 {
4108 /*
4109 * See what type of line it is...
4110 */
4111
4112 DEBUG_printf(("9cups_get_dests: linenum=%d line=\"%s\" lineptr=\"%s\"",
4113 linenum, line, lineptr));
4114
4115 if ((_cups_strcasecmp(line, "dest") && _cups_strcasecmp(line, "default")) || !lineptr)
4116 {
4117 DEBUG_puts("9cups_get_dests: Not a dest or default line...");
4118 continue;
4119 }
4120
4121 name = lineptr;
4122
4123 /*
4124 * Search for an instance...
4125 */
4126
4127 while (!isspace(*lineptr & 255) && *lineptr && *lineptr != '/')
4128 lineptr ++;
4129
4130 if (*lineptr == '/')
4131 {
4132 /*
4133 * Found an instance...
4134 */
4135
4136 *lineptr++ = '\0';
4137 instance = lineptr;
4138
4139 /*
4140 * Search for an instance...
4141 */
4142
4143 while (!isspace(*lineptr & 255) && *lineptr)
4144 lineptr ++;
4145 }
4146 else
4147 instance = NULL;
4148
4149 if (*lineptr)
4150 *lineptr++ = '\0';
4151
4152 DEBUG_printf(("9cups_get_dests: name=\"%s\", instance=\"%s\"", name,
4153 instance));
4154
4155 /*
4156 * See if the primary instance of the destination exists; if not,
4157 * ignore this entry and move on...
4158 */
4159
4160 if (match_name)
4161 {
4162 if (_cups_strcasecmp(name, match_name) ||
4163 (!instance && match_inst) ||
4164 (instance && !match_inst) ||
4165 (instance && _cups_strcasecmp(instance, match_inst)))
4166 continue;
4167
4168 dest = *dests;
4169 }
4170 else if (cupsGetDest(name, NULL, num_dests, *dests) == NULL)
4171 {
4172 DEBUG_puts("9cups_get_dests: Not found!");
4173 continue;
4174 }
4175 else
4176 {
4177 /*
4178 * Add the destination...
4179 */
4180
4181 num_dests = cupsAddDest(name, instance, num_dests, dests);
4182
4183 if ((dest = cupsGetDest(name, instance, num_dests, *dests)) == NULL)
4184 {
4185 /*
4186 * Out of memory!
4187 */
4188
4189 DEBUG_puts("9cups_get_dests: Out of memory!");
4190 break;
4191 }
4192 }
4193
4194 /*
4195 * Add options until we hit the end of the line...
4196 */
4197
4198 dest->num_options = cupsParseOptions(lineptr, dest->num_options,
4199 &(dest->options));
4200
4201 /*
4202 * If we found what we were looking for, stop now...
4203 */
4204
4205 if (match_name)
4206 break;
4207
4208 /*
4209 * Set this as default if needed...
4210 */
4211
4212 if (!user_default_set && !_cups_strcasecmp(line, "default"))
4213 {
4214 DEBUG_puts("9cups_get_dests: Setting as default...");
4215
4216 for (i = 0; i < num_dests; i ++)
4217 (*dests)[i].is_default = 0;
4218
4219 dest->is_default = 1;
4220 }
4221 }
4222
4223 /*
4224 * Close the file and return...
4225 */
4226
4227 cupsFileClose(fp);
4228
4229 return (num_dests);
4230 }
4231
4232
4233 /*
4234 * 'cups_make_string()' - Make a comma-separated string of values from an IPP
4235 * attribute.
4236 */
4237
4238 static char * /* O - New string */
4239 cups_make_string(
4240 ipp_attribute_t *attr, /* I - Attribute to convert */
4241 char *buffer, /* I - Buffer */
4242 size_t bufsize) /* I - Size of buffer */
4243 {
4244 int i; /* Looping var */
4245 char *ptr, /* Pointer into buffer */
4246 *end, /* Pointer to end of buffer */
4247 *valptr; /* Pointer into string attribute */
4248
4249
4250 /*
4251 * Return quickly if we have a single string value...
4252 */
4253
4254 if (attr->num_values == 1 &&
4255 attr->value_tag != IPP_TAG_INTEGER &&
4256 attr->value_tag != IPP_TAG_ENUM &&
4257 attr->value_tag != IPP_TAG_BOOLEAN &&
4258 attr->value_tag != IPP_TAG_RANGE)
4259 return (attr->values[0].string.text);
4260
4261 /*
4262 * Copy the values to the string, separating with commas and escaping strings
4263 * as needed...
4264 */
4265
4266 end = buffer + bufsize - 1;
4267
4268 for (i = 0, ptr = buffer; i < attr->num_values && ptr < end; i ++)
4269 {
4270 if (i)
4271 *ptr++ = ',';
4272
4273 switch (attr->value_tag)
4274 {
4275 case IPP_TAG_INTEGER :
4276 case IPP_TAG_ENUM :
4277 snprintf(ptr, (size_t)(end - ptr + 1), "%d", attr->values[i].integer);
4278 break;
4279
4280 case IPP_TAG_BOOLEAN :
4281 if (attr->values[i].boolean)
4282 strlcpy(ptr, "true", (size_t)(end - ptr + 1));
4283 else
4284 strlcpy(ptr, "false", (size_t)(end - ptr + 1));
4285 break;
4286
4287 case IPP_TAG_RANGE :
4288 if (attr->values[i].range.lower == attr->values[i].range.upper)
4289 snprintf(ptr, (size_t)(end - ptr + 1), "%d", attr->values[i].range.lower);
4290 else
4291 snprintf(ptr, (size_t)(end - ptr + 1), "%d-%d", attr->values[i].range.lower, attr->values[i].range.upper);
4292 break;
4293
4294 default :
4295 for (valptr = attr->values[i].string.text;
4296 *valptr && ptr < end;)
4297 {
4298 if (strchr(" \t\n\\\'\"", *valptr))
4299 {
4300 if (ptr >= (end - 1))
4301 break;
4302
4303 *ptr++ = '\\';
4304 }
4305
4306 *ptr++ = *valptr++;
4307 }
4308
4309 *ptr = '\0';
4310 break;
4311 }
4312
4313 ptr += strlen(ptr);
4314 }
4315
4316 *ptr = '\0';
4317
4318 return (buffer);
4319 }
4320
4321
4322 /*
4323 * 'cups_name_cb()' - Find an enumerated destination.
4324 */
4325
4326 static int /* O - 1 to continue, 0 to stop */
4327 cups_name_cb(_cups_namedata_t *data, /* I - Data from cupsGetNamedDest */
4328 unsigned flags, /* I - Enumeration flags */
4329 cups_dest_t *dest) /* I - Destination */
4330 {
4331 DEBUG_printf(("2cups_name_cb(data=%p(%s), flags=%x, dest=%p(%s)", (void *)data, data->name, flags, (void *)dest, dest->name));
4332
4333 if (!(flags & CUPS_DEST_FLAGS_REMOVED) && !dest->instance && !strcasecmp(data->name, dest->name))
4334 {
4335 /*
4336 * Copy destination and stop enumeration...
4337 */
4338
4339 cupsCopyDest(dest, 0, &data->dest);
4340 return (0);
4341 }
4342
4343 return (1);
4344 }
4345
4346
4347 /*
4348 * 'cups_queue_name()' - Create a local queue name based on the service name.
4349 */
4350
4351 static void
4352 cups_queue_name(
4353 char *name, /* I - Name buffer */
4354 const char *serviceName, /* I - Service name */
4355 size_t namesize) /* I - Size of name buffer */
4356 {
4357 const char *ptr; /* Pointer into serviceName */
4358 char *nameptr; /* Pointer into name */
4359
4360
4361 for (nameptr = name, ptr = serviceName; *ptr && nameptr < (name + namesize - 1); ptr ++)
4362 {
4363 /*
4364 * Sanitize the printer name...
4365 */
4366
4367 if (_cups_isalnum(*ptr))
4368 *nameptr++ = *ptr;
4369 else if (nameptr == name || nameptr[-1] != '_')
4370 *nameptr++ = '_';
4371 }
4372
4373 *nameptr = '\0';
4374 }
Unnamed repository; edit this file 'description' to name the repository.