]> git.ipfire.org Git - thirdparty/cups.git/blob - cups/dest.c
projects / thirdparty / cups.git / blob
? search:


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