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